API Search Engine
Search
Me.
| Title | Source | Visit | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
google-partners{"google-partners-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Partners", "x-complete"=>1, "info"=>{"title"=>"Google Partners", "description"=>"searches-certified-companies-and-creates-contact-leads-with-them-and-also-audits-the-usage-of-clients-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v2"}, "host"=>"partners.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v2/analytics"=>{"get"=>{"summary"=>"Get Analytics", "description"=>"Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in user.", "operationId"=>"partners.analytics.list", "x-api-path-slug"=>"v2analytics-get", "parameters"=>[{"in"=>"query", "name"=>"pageSize", "description"=>"Requested page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A token identifying a page of results that the server returns"}, {"in"=>"query", "name"=>"requestMetadata.experimentIds", "description"=>"Experiment IDs the current request belongs to"}, {"in"=>"query", "name"=>"requestMetadata.locale", "description"=>"Locale to use for the current request"}, {"in"=>"query", "name"=>"requestMetadata.partnersSessionId", "description"=>"Google Partners session ID"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSourceId", "description"=>"Identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSubId", "description"=>"Second level identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.ipAddress", "description"=>"IP address to use instead of the users geo-located IP address"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.userId", "description"=>"Logged-in user ID to impersonate instead of the users ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics"]}}, "/v2/clientMessages:log"=>{"post"=>{"summary"=>"Get Generic Message Log", "description"=>"Logs a generic message from the client, such as\n`Failed to render component`, `Profile page is running slow`,\n`More than 500 users have accessed this result.`, etc.", "operationId"=>"partners.clientMessages.log", "x-api-path-slug"=>"v2clientmessageslog-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}}, "/v2/companies"=>{"get"=>{"summary"=>"Get Companies", "description"=>"Lists companies.", "operationId"=>"partners.companies.list", "x-api-path-slug"=>"v2companies-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"The address to use when searching for companies"}, {"in"=>"query", "name"=>"companyName", "description"=>"Company name to search for"}, {"in"=>"query", "name"=>"gpsMotivations", "description"=>"List of reasons for using Google Partner Search to get companies"}, {"in"=>"query", "name"=>"industries", "description"=>"List of industries the company can help with"}, {"in"=>"query", "name"=>"languageCodes", "description"=>"List of language codes that company can support"}, {"in"=>"query", "name"=>"maxMonthlyBudget.currencyCode", "description"=>"The 3-letter currency code defined in ISO 4217"}, {"in"=>"query", "name"=>"maxMonthlyBudget.nanos", "description"=>"Number of nano (10^-9) units of the amount"}, {"in"=>"query", "name"=>"maxMonthlyBudget.units", "description"=>"The whole units of the amount"}, {"in"=>"query", "name"=>"minMonthlyBudget.currencyCode", "description"=>"The 3-letter currency code defined in ISO 4217"}, {"in"=>"query", "name"=>"minMonthlyBudget.nanos", "description"=>"Number of nano (10^-9) units of the amount"}, {"in"=>"query", "name"=>"minMonthlyBudget.units", "description"=>"The whole units of the amount"}, {"in"=>"query", "name"=>"orderBy", "description"=>"How to order addresses within the returned companies"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Requested page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A token identifying a page of results that the server returns"}, {"in"=>"query", "name"=>"requestMetadata.experimentIds", "description"=>"Experiment IDs the current request belongs to"}, {"in"=>"query", "name"=>"requestMetadata.locale", "description"=>"Locale to use for the current request"}, {"in"=>"query", "name"=>"requestMetadata.partnersSessionId", "description"=>"Google Partners session ID"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSourceId", "description"=>"Identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSubId", "description"=>"Second level identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.ipAddress", "description"=>"IP address to use instead of the users geo-located IP address"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.userId", "description"=>"Logged-in user ID to impersonate instead of the users ID"}, {"in"=>"query", "name"=>"services", "description"=>"List of services that the returned agencies should provide"}, {"in"=>"query", "name"=>"specializations", "description"=>"List of specializations that the returned agencies should provide"}, {"in"=>"query", "name"=>"view", "description"=>"The view of the `Company` resource to be returned"}, {"in"=>"query", "name"=>"websiteUrl", "description"=>"Website URL that will help to find a better matched company"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company"]}, "patch"=>{"summary"=>"Update Company", "description"=>"Update company.\nShould only be called within the context of an authorized logged in user.", "operationId"=>"partners.updateCompanies", "x-api-path-slug"=>"v2companies-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"requestMetadata.experimentIds", "description"=>"Experiment IDs the current request belongs to"}, {"in"=>"query", "name"=>"requestMetadata.locale", "description"=>"Locale to use for the current request"}, {"in"=>"query", "name"=>"requestMetadata.partnersSessionId", "description"=>"Google Partners session ID"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSourceId", "description"=>"Identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSubId", "description"=>"Second level identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.ipAddress", "description"=>"IP address to use instead of the users geo-located IP address"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.userId", "description"=>"Logged-in user ID to impersonate instead of the users ID"}, {"in"=>"query", "name"=>"updateMask", "description"=>"Standard field mask for the set of fields to be updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company"]}}, "/v2/companies/{companyId}"=>{"get"=>{"summary"=>"Get Company", "description"=>"Gets a company.", "operationId"=>"partners.companies.get", "x-api-path-slug"=>"v2companiescompanyid-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"The address to use for sorting the companys addresses by proximity"}, {"in"=>"path", "name"=>"companyId", "description"=>"The ID of the company to retrieve"}, {"in"=>"query", "name"=>"currencyCode", "description"=>"If the companys budget is in a different currency code than this one, thenthe converted budget is converted to this currency code"}, {"in"=>"query", "name"=>"orderBy", "description"=>"How to order addresses within the returned company"}, {"in"=>"query", "name"=>"requestMetadata.experimentIds", "description"=>"Experiment IDs the current request belongs to"}, {"in"=>"query", "name"=>"requestMetadata.locale", "description"=>"Locale to use for the current request"}, {"in"=>"query", "name"=>"requestMetadata.partnersSessionId", "description"=>"Google Partners session ID"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSourceId", "description"=>"Identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSubId", "description"=>"Second level identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.ipAddress", "description"=>"IP address to use instead of the users geo-located IP address"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.userId", "description"=>"Logged-in user ID to impersonate instead of the users ID"}, {"in"=>"query", "name"=>"view", "description"=>"The view of `Company` resource to be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company"]}}, "/v2/companies/{companyId}/leads"=>{"post"=>{"summary"=>"Get Company Leads", "description"=>"Creates an advertiser lead for the given company ID.", "operationId"=>"partners.companies.leads.create", "x-api-path-slug"=>"v2companiescompanyidleads-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"companyId", "description"=>"The ID of the company to contact"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lead"]}}, "/v2/exams/{examType}/token"=>{"get"=>{"summary"=>"Get Exam Token", "description"=>"Gets an Exam Token for a Partner's user to take an exam in the Exams System", "operationId"=>"partners.exams.getToken", "x-api-path-slug"=>"v2examsexamtypetoken-get", "parameters"=>[{"in"=>"path", "name"=>"examType", "description"=>"The exam type we are requesting a token for"}, {"in"=>"query", "name"=>"requestMetadata.experimentIds", "description"=>"Experiment IDs the current request belongs to"}, {"in"=>"query", "name"=>"requestMetadata.locale", "description"=>"Locale to use for the current request"}, {"in"=>"query", "name"=>"requestMetadata.partnersSessionId", "description"=>"Google Partners session ID"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSourceId", "description"=>"Identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSubId", "description"=>"Second level identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.ipAddress", "description"=>"IP address to use instead of the users geo-located IP address"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.userId", "description"=>"Logged-in user ID to impersonate instead of the users ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token"]}}, "/v2/leads"=>{"get"=>{"summary"=>"Get Leads", "description"=>"Lists advertiser leads for a user's associated company.\nShould only be called within the context of an authorized logged in user.", "operationId"=>"partners.leads.list", "x-api-path-slug"=>"v2leads-get", "parameters"=>[{"in"=>"query", "name"=>"orderBy", "description"=>"How to order Leads"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Requested page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A token identifying a page of results that the server returns"}, {"in"=>"query", "name"=>"requestMetadata.experimentIds", "description"=>"Experiment IDs the current request belongs to"}, {"in"=>"query", "name"=>"requestMetadata.locale", "description"=>"Locale to use for the current request"}, {"in"=>"query", "name"=>"requestMetadata.partnersSessionId", "description"=>"Google Partners session ID"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSourceId", "description"=>"Identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSubId", "description"=>"Second level identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.ipAddress", "description"=>"IP address to use instead of the users geo-located IP address"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.userId", "description"=>"Logged-in user ID to impersonate instead of the users ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lead"]}, "patch"=>{"summary"=>"Update Lead", "description"=>"Updates the specified lead.", "operationId"=>"partners.updateLeads", "x-api-path-slug"=>"v2leads-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"requestMetadata.experimentIds", "description"=>"Experiment IDs the current request belongs to"}, {"in"=>"query", "name"=>"requestMetadata.locale", "description"=>"Locale to use for the current request"}, {"in"=>"query", "name"=>"requestMetadata.partnersSessionId", "description"=>"Google Partners session ID"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSourceId", "description"=>"Identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSubId", "description"=>"Second level identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.ipAddress", "description"=>"IP address to use instead of the users geo-located IP address"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.userId", "description"=>"Logged-in user ID to impersonate instead of the users ID"}, {"in"=>"query", "name"=>"updateMask", "description"=>"Standard field mask for the set of fields to be updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lead"]}}, "/v2/offers"=>{"get"=>{"summary"=>"Get Offers", "description"=>"Lists the Offers available for the current user", "operationId"=>"partners.offers.list", "x-api-path-slug"=>"v2offers-get", "parameters"=>[{"in"=>"query", "name"=>"requestMetadata.experimentIds", "description"=>"Experiment IDs the current request belongs to"}, {"in"=>"query", "name"=>"requestMetadata.locale", "description"=>"Locale to use for the current request"}, {"in"=>"query", "name"=>"requestMetadata.partnersSessionId", "description"=>"Google Partners session ID"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSourceId", "description"=>"Identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSubId", "description"=>"Second level identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.ipAddress", "description"=>"IP address to use instead of the users geo-located IP address"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.userId", "description"=>"Logged-in user ID to impersonate instead of the users ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offer"]}}, "/v2/offers/history"=>{"get"=>{"summary"=>"Get Historical Offers", "description"=>"Lists the Historical Offers for the current user (or user's entire company)", "operationId"=>"partners.offers.history.list", "x-api-path-slug"=>"v2offershistory-get", "parameters"=>[{"in"=>"query", "name"=>"entireCompany", "description"=>"if true, show history for the entire company"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Comma-separated list of fields to order by, e"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Maximum number of rows to return per page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token to retrieve a specific page"}, {"in"=>"query", "name"=>"requestMetadata.experimentIds", "description"=>"Experiment IDs the current request belongs to"}, {"in"=>"query", "name"=>"requestMetadata.locale", "description"=>"Locale to use for the current request"}, {"in"=>"query", "name"=>"requestMetadata.partnersSessionId", "description"=>"Google Partners session ID"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSourceId", "description"=>"Identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSubId", "description"=>"Second level identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.ipAddress", "description"=>"IP address to use instead of the users geo-located IP address"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.userId", "description"=>"Logged-in user ID to impersonate instead of the users ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lead"]}}, "/v2/partnersstatus"=>{"get"=>{"summary"=>"Get Partner Status", "description"=>"Gets Partners Status of the logged in user's agency.\nShould only be called if the logged in user is the admin of the agency.", "operationId"=>"partners.getPartnersstatus", "x-api-path-slug"=>"v2partnersstatus-get", "parameters"=>[{"in"=>"query", "name"=>"requestMetadata.experimentIds", "description"=>"Experiment IDs the current request belongs to"}, {"in"=>"query", "name"=>"requestMetadata.locale", "description"=>"Locale to use for the current request"}, {"in"=>"query", "name"=>"requestMetadata.partnersSessionId", "description"=>"Google Partners session ID"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSourceId", "description"=>"Identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSubId", "description"=>"Second level identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.ipAddress", "description"=>"IP address to use instead of the users geo-located IP address"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.userId", "description"=>"Logged-in user ID to impersonate instead of the users ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Status"]}}, "/v2/userEvents:log"=>{"post"=>{"summary"=>"Log User Event", "description"=>"Logs a user event.", "operationId"=>"partners.userEvents.log", "x-api-path-slug"=>"v2usereventslog-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Log"]}}, "/v2/userStates"=>{"get"=>{"summary"=>"Get States For User", "description"=>"Lists states for current user.", "operationId"=>"partners.userStates.list", "x-api-path-slug"=>"v2userstates-get", "parameters"=>[{"in"=>"query", "name"=>"requestMetadata.experimentIds", "description"=>"Experiment IDs the current request belongs to"}, {"in"=>"query", "name"=>"requestMetadata.locale", "description"=>"Locale to use for the current request"}, {"in"=>"query", "name"=>"requestMetadata.partnersSessionId", "description"=>"Google Partners session ID"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSourceId", "description"=>"Identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSubId", "description"=>"Second level identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.ipAddress", "description"=>"IP address to use instead of the users geo-located IP address"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.userId", "description"=>"Logged-in user ID to impersonate instead of the users ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/v2/users/profile"=>{"patch"=>{"summary"=>"Update User Profile", "description"=>"Updates a user's profile. A user can only update their own profile and\nshould only be called within the context of a logged in user.", "operationId"=>"partners.users.updateProfile", "x-api-path-slug"=>"v2usersprofile-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"requestMetadata.experimentIds", "description"=>"Experiment IDs the current request belongs to"}, {"in"=>"query", "name"=>"requestMetadata.locale", "description"=>"Locale to use for the current request"}, {"in"=>"query", "name"=>"requestMetadata.partnersSessionId", "description"=>"Google Partners session ID"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSourceId", "description"=>"Identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSubId", "description"=>"Second level identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.ipAddress", "description"=>"IP address to use instead of the users geo-located IP address"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.userId", "description"=>"Logged-in user ID to impersonate instead of the users ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile"]}}, "/v2/users/{userId}"=>{"get"=>{"summary"=>"Get User", "description"=>"Gets a user.", "operationId"=>"partners.users.get", "x-api-path-slug"=>"v2usersuserid-get", "parameters"=>[{"in"=>"query", "name"=>"requestMetadata.experimentIds", "description"=>"Experiment IDs the current request belongs to"}, {"in"=>"query", "name"=>"requestMetadata.locale", "description"=>"Locale to use for the current request"}, {"in"=>"query", "name"=>"requestMetadata.partnersSessionId", "description"=>"Google Partners session ID"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSourceId", "description"=>"Identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSubId", "description"=>"Second level identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.ipAddress", "description"=>"IP address to use instead of the users geo-located IP address"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.userId", "description"=>"Logged-in user ID to impersonate instead of the users ID"}, {"in"=>"path", "name"=>"userId", "description"=>"Identifier of the user"}, {"in"=>"query", "name"=>"userView", "description"=>"Specifies what parts of the user information to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/v2/users/{userId}/companyRelation"=>{"delete"=>{"summary"=>"Delete user Company Relation", "description"=>"Deletes a user's company relation. Unaffiliaites the user from a company.", "operationId"=>"partners.users.deleteCompanyRelation", "x-api-path-slug"=>"v2usersuseridcompanyrelation-delete", "parameters"=>[{"in"=>"query", "name"=>"requestMetadata.experimentIds", "description"=>"Experiment IDs the current request belongs to"}, {"in"=>"query", "name"=>"requestMetadata.locale", "description"=>"Locale to use for the current request"}, {"in"=>"query", "name"=>"requestMetadata.partnersSessionId", "description"=>"Google Partners session ID"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSourceId", "description"=>"Identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSubId", "description"=>"Second level identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.ipAddress", "description"=>"IP address to use instead of the users geo-located IP address"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.userId", "description"=>"Logged-in user ID to impersonate instead of the users ID"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Relation"]}, "put"=>{"summary"=>"Create user Company Relation", "description"=>"Creates a user's company relation. Affiliates the user to a company.", "operationId"=>"partners.users.createCompanyRelation", "x-api-path-slug"=>"v2usersuseridcompanyrelation-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"requestMetadata.experimentIds", "description"=>"Experiment IDs the current request belongs to"}, {"in"=>"query", "name"=>"requestMetadata.locale", "description"=>"Locale to use for the current request"}, {"in"=>"query", "name"=>"requestMetadata.partnersSessionId", "description"=>"Google Partners session ID"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSourceId", "description"=>"Identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.trafficSource.trafficSubId", "description"=>"Second level identifier to indicate where the traffic comes from"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.ipAddress", "description"=>"IP address to use instead of the users geo-located IP address"}, {"in"=>"query", "name"=>"requestMetadata.userOverrides.userId", "description"=>"Logged-in user ID to impersonate instead of the users ID"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Relation"]}}}}, "apis"=>{"name"=>"Google Partners", "x-slug"=>"google-partners", "description"=>"Google Partners is Googles program for advertising agencies, digital marketing professionals, and other online consultants who manage AdWords accounts. The Google Partners API lets advertisers search certified companies and create contact leads with them, and also audits the usage of clients.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Google-Partner.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-partners/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Partners API", "x-api-slug"=>"google-partners-api", "description"=>"Google Partners is Googles program for advertising agencies, digital marketing professionals, and other online consultants who manage AdWords accounts. The Google Partners API lets advertisers search certified companies and create contact leads with them, and also audits the usage of clients.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Google-Partner.jpg", "humanURL"=>"https://developers.google.com/partners/", "baseURL"=>"://partners.googleapis.com//", "tags"=>"API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-partners/google-partners-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://developers.google.com/partners/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
import-io{"apis"=>{"name"=>"Import.io", "x-slug"=>"import-io", "description"=>"Home Page - Import.io - Web Scraping, Data Extraction and Web Harvesting", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1728-import-io.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"87026", "tags"=>"API Provider,API Service Provider,API United Kingdom,Profiles,Relative Data,SaaS,Scraping,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"import-io/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"import.io", "x-api-slug"=>"import-io", "description"=>"import.io is a service that allows users to find data sources on the web for extraction, use, connect to, and remix the data for websites and applications.The import.io API allows developers to access and integrate the functionality of import.io with other applications. Some example API methods include retrieving data, importing data, extracting data, and managing account information.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1728-import-io.jpg", "humanURL"=>"https://www.import.io/", "baseURL"=>"https://schedule.import.io//", "tags"=>"API Provider,API Service Provider,API United Kingdom,Profiles,Relative Data,SaaS,Scraping,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/import-io/import-io-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://blog.import.io/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/importio"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/importio"}, {"type"=>"x-email", "url"=>"legal@import.io"}, {"type"=>"x-email", "url"=>"support@import.io"}, {"type"=>"x-email", "url"=>"copyright@import.io"}, {"type"=>"x-email", "url"=>"hello@import.io"}, {"type"=>"x-github", "url"=>"https://github.com/import-io"}, {"type"=>"x-pricing", "url"=>"https://www.import.io/standard-plans/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/importio"}, {"type"=>"x-website", "url"=>"https://www.import.io/"}, {"type"=>"x-website", "url"=>"http://import.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "import-io-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Import.io", "x-complete"=>1, "info"=>{"title"=>"import.io", "version"=>"1.0"}, "host"=>"schedule.import.io", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/extractor/{extractorId}/csv/latest"=>{"get"=>{"summary"=>"Get Extractor Extractorid Csv Latest", "description"=>"Get the latest crawl run results as a csv.", "operationId"=>"getExtractorExtractorCsvLatest", "x-api-path-slug"=>"extractorextractoridcsvlatest-get", "parameters"=>[{"in"=>"path", "name"=>"extractorId", "description"=>"the id of the extractor to start get the latest crawl run data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extractor", "ExtractorId", "Csv", "Latest"]}}, "/extractor/{extractorId}/json/latest"=>{"get"=>{"summary"=>"Get Extractor Extractorid Json Latest", "description"=>"Get the latest crawl run results as json.", "operationId"=>"getExtractorExtractorJsonLatest", "x-api-path-slug"=>"extractorextractoridjsonlatest-get", "parameters"=>[{"in"=>"path", "name"=>"extractorId", "description"=>"The id of the extractor to start get the latest crawl run data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extractor", "ExtractorId", "Json", "Latest"]}}, "/extractor/{extractorId}"=>{"get"=>{"summary"=>"Get Extractor Extractorid", "description"=>"Query by extractor endpoint, adhoc runs only..", "operationId"=>"getExtractorExtractor", "x-api-path-slug"=>"extractorextractorid-get", "parameters"=>[{"in"=>"path", "name"=>"extractorId", "description"=>"extractorId"}, {"in"=>"query", "name"=>"url", "description"=>"url"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extractor", "ExtractorId"]}}, "/extractor/{extractorId}/runs"=>{"get"=>{"summary"=>"Get Extractor Extractorid Runs", "description"=>"Get a feed of the runs performed on an extractor.", "operationId"=>"getExtractorExtractorRuns", "x-api-path-slug"=>"extractorextractoridruns-get", "parameters"=>[{"in"=>"path", "name"=>"extractorId", "description"=>"The id of the extractor to start get the crawl run data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extractor", "ExtractorId", "Runs"]}}, "/extractor/{extractorId}/cancel"=>{"post"=>{"summary"=>"Post Extractor Extractorid Cancel", "description"=>"Cancel an existing crawl..", "operationId"=>"postExtractorExtractorCancel", "x-api-path-slug"=>"extractorextractoridcancel-post", "parameters"=>[{"in"=>"path", "name"=>"extractorId", "description"=>"extractorId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extractor", "ExtractorId", "Cancel"]}}, "/extractor/{extractorId}/start"=>{"post"=>{"summary"=>"Post Extractor Extractorid Start", "description"=>"Launch a crawl from an extractor that a user owns..", "operationId"=>"postExtractorExtractorStart", "x-api-path-slug"=>"extractorextractoridstart-post", "parameters"=>[{"in"=>"path", "name"=>"extractorId", "description"=>"the id of the extractor to start crawling with"}, {"in"=>"query", "name"=>"loginSessionId", "description"=>"The loginSessionId required for authenticated extractors"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extractor", "ExtractorId", "Start"]}}, "/extractor"=>{"get"=>{"summary"=>"Get Extractor", "description"=>"Get the list of schedules for all your extractors.", "operationId"=>"getExtractor", "x-api-path-slug"=>"extractor-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extractor"]}, "post"=>{"summary"=>"Post Extractor", "description"=>"Schedule and extractor to run at a specific time.", "operationId"=>"postExtractor", "x-api-path-slug"=>"extractor-post", "parameters"=>[{"in"=>"body", "name"=>"Schedule Request Body", "description"=>"Request body with the schema defined on the left", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extractor"]}}, "/extractor/{extractorId}/"=>{"delete"=>{"summary"=>"Delete Extractor Extractorid", "description"=>"Delete an existing schedule.", "operationId"=>"deleteExtractorExtractor", "x-api-path-slug"=>"extractorextractorid-delete", "parameters"=>[{"in"=>"path", "name"=>"extractorId", "description"=>"the id of the extractor with a schedule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extractor", "ExtractorId"]}, "get"=>{"summary"=>"Get Extractor Extractorid", "description"=>"Get the schedule of a particular extractor.", "operationId"=>"getExtractorExtractor", "x-api-path-slug"=>"extractorextractorid-get", "parameters"=>[{"in"=>"path", "name"=>"extractorId", "description"=>"the id of the extractor with a schedule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extractor", "ExtractorId"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-machine-learning{"aws-machine-learning-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Machine Learning", "x-complete"=>1, "info"=>{"title"=>"AWS Machine Learning API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddTags"=>{"get"=>{"summary"=>"Add Tags", "description"=>"Adds one or more tags to an object, up to a limit of 10.", "operationId"=>"addTags", "x-api-path-slug"=>"actionaddtags-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceId", "description"=>"The ID of the ML object to tag", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceType", "description"=>"The type of the ML object to tag", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"The key-value pairs to use to create tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Tags"]}}, "/?Action=CreateBatchPrediction"=>{"get"=>{"summary"=>"Create Batch Prediction", "description"=>"Generates predictions for a group of observations.", "operationId"=>"createBatchPrediction", "x-api-path-slug"=>"actioncreatebatchprediction-get", "parameters"=>[{"in"=>"query", "name"=>"BatchPredictionDataSourceId", "description"=>"The ID of the DataSource that points to the group of observations to predict", "type"=>"string"}, {"in"=>"query", "name"=>"BatchPredictionId", "description"=>"A user-supplied ID that uniquely identifies the BatchPrediction", "type"=>"string"}, {"in"=>"query", "name"=>"BatchPredictionName", "description"=>"A user-supplied name or description of the BatchPrediction", "type"=>"string"}, {"in"=>"query", "name"=>"MLModelId", "description"=>"The ID of the MLModel that will generate predictions for the group of observations", "type"=>"string"}, {"in"=>"query", "name"=>"OutputUri", "description"=>"The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Batches"]}}, "/?Action=CreateDataSourceFromRDS"=>{"get"=>{"summary"=>"Create Data Source From R D S", "description"=>"Creates a DataSource object from an.", "operationId"=>"createDataSourceFromRDS", "x-api-path-slug"=>"actioncreatedatasourcefromrds-get", "parameters"=>[{"in"=>"query", "name"=>"ComputeStatistics", "description"=>"The compute statistics for a DataSource", "type"=>"string"}, {"in"=>"query", "name"=>"DataSourceId", "description"=>"A user-supplied ID that uniquely identifies the DataSource", "type"=>"string"}, {"in"=>"query", "name"=>"DataSourceName", "description"=>"A user-supplied name or description of the DataSource", "type"=>"string"}, {"in"=>"query", "name"=>"RDSData", "description"=>"The data specification of an Amazon RDS DataSource:", "type"=>"string"}, {"in"=>"query", "name"=>"RoleARN", "description"=>"The role that Amazon ML assumes on behalf of the user to create and activate a data pipeline in the users account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Data Sources"]}}, "/?Action=CreateDataSourceFromRedshift"=>{"get"=>{"summary"=>"Create Data Source From Redshift", "description"=>"Creates a DataSource from a database hosted on an Amazon Redshift cluster.", "operationId"=>"createDataSourceFromRedshift", "x-api-path-slug"=>"actioncreatedatasourcefromredshift-get", "parameters"=>[{"in"=>"query", "name"=>"ComputeStatistics", "description"=>"The compute statistics for a DataSource", "type"=>"string"}, {"in"=>"query", "name"=>"DataSourceId", "description"=>"A user-supplied ID that uniquely identifies the DataSource", "type"=>"string"}, {"in"=>"query", "name"=>"DataSourceName", "description"=>"A user-supplied name or description of the DataSource", "type"=>"string"}, {"in"=>"query", "name"=>"DataSpec", "description"=>"The data specification of an Amazon Redshift DataSource:", "type"=>"string"}, {"in"=>"query", "name"=>"RoleARN", "description"=>"A fully specified role Amazon Resource Name (ARN)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Data Sources"]}}, "/?Action=CreateDataSourceFromS3"=>{"get"=>{"summary"=>"Create Data Source From S3", "description"=>"Creates a DataSource object.", "operationId"=>"createDataSourceFromS3", "x-api-path-slug"=>"actioncreatedatasourcefroms3-get", "parameters"=>[{"in"=>"query", "name"=>"ComputeStatistics", "description"=>"The compute statistics for a DataSource", "type"=>"string"}, {"in"=>"query", "name"=>"DataSourceId", "description"=>"A user-supplied identifier that uniquely identifies the DataSource", "type"=>"string"}, {"in"=>"query", "name"=>"DataSourceName", "description"=>"A user-supplied name or description of the DataSource", "type"=>"string"}, {"in"=>"query", "name"=>"DataSpec", "description"=>"The data specification of a DataSource:", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Data Sources"]}}, "/?Action=CreateEvaluation"=>{"get"=>{"summary"=>"Create Evaluation", "description"=>"Creates a new Evaluation of an MLModel.", "operationId"=>"createEvaluation", "x-api-path-slug"=>"actioncreateevaluation-get", "parameters"=>[{"in"=>"query", "name"=>"EvaluationDataSourceId", "description"=>"The ID of the DataSource for the evaluation", "type"=>"string"}, {"in"=>"query", "name"=>"EvaluationId", "description"=>"A user-supplied ID that uniquely identifies the Evaluation", "type"=>"string"}, {"in"=>"query", "name"=>"EvaluationName", "description"=>"A user-supplied name or description of the Evaluation", "type"=>"string"}, {"in"=>"query", "name"=>"MLModelId", "description"=>"The ID of the MLModel to evaluate", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Evaluations"]}}, "/?Action=CreateMLModel"=>{"get"=>{"summary"=>"Create M L Model", "description"=>"Creates a new MLModel using the DataSource and the recipe as\n information sources.", "operationId"=>"createMLModel", "x-api-path-slug"=>"actioncreatemlmodel-get", "parameters"=>[{"in"=>"query", "name"=>"MLModelId", "description"=>"A user-supplied ID that uniquely identifies the MLModel", "type"=>"string"}, {"in"=>"query", "name"=>"MLModelName", "description"=>"A user-supplied name or description of the MLModel", "type"=>"string"}, {"in"=>"query", "name"=>"MLModelType", "description"=>"The category of supervised learning that this MLModel will address", "type"=>"string"}, {"in"=>"query", "name"=>"Parameters", "description"=>"A list of the training parameters in the MLModel", "type"=>"string"}, {"in"=>"query", "name"=>"Recipe", "description"=>"The data recipe for creating the MLModel", "type"=>"string"}, {"in"=>"query", "name"=>"RecipeUri", "description"=>"The Amazon Simple Storage Service (Amazon S3) location and file name that contains the MLModel recipe", "type"=>"string"}, {"in"=>"query", "name"=>"TrainingDataSourceId", "description"=>"The DataSource that points to the training data", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Models"]}}, "/?Action=CreateRealtimeEndpoint"=>{"get"=>{"summary"=>"Create Realtime Endpoint", "description"=>"Creates a real-time endpoint for the MLModel.", "operationId"=>"createRealtimeEndpoint", "x-api-path-slug"=>"actioncreaterealtimeendpoint-get", "parameters"=>[{"in"=>"query", "name"=>"MLModelId", "description"=>"The ID assigned to the MLModel during creation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Real Time"]}}, "/?Action=DeleteBatchPrediction"=>{"get"=>{"summary"=>"Delete Batch Prediction", "description"=>"Assigns the DELETED status to a BatchPrediction, rendering it unusable.", "operationId"=>"deleteBatchPrediction", "x-api-path-slug"=>"actiondeletebatchprediction-get", "parameters"=>[{"in"=>"query", "name"=>"BatchPredictionId", "description"=>"A user-supplied ID that uniquely identifies the BatchPrediction", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Batches"]}}, "/?Action=DeleteDataSource"=>{"get"=>{"summary"=>"Delete Data Source", "description"=>"Assigns the DELETED status to a DataSource, rendering it unusable.", "operationId"=>"deleteDataSource", "x-api-path-slug"=>"actiondeletedatasource-get", "parameters"=>[{"in"=>"query", "name"=>"DataSourceId", "description"=>"A user-supplied ID that uniquely identifies the DataSource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Data Sources"]}}, "/?Action=DeleteEvaluation"=>{"get"=>{"summary"=>"Delete Evaluation", "description"=>"Assigns the DELETED status to an Evaluation, rendering it unusable.", "operationId"=>"deleteEvaluation", "x-api-path-slug"=>"actiondeleteevaluation-get", "parameters"=>[{"in"=>"query", "name"=>"EvaluationId", "description"=>"A user-supplied ID that uniquely identifies the Evaluation to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Evaluations"]}}, "/?Action=DeleteMLModel"=>{"get"=>{"summary"=>"Delete M L Model", "description"=>"Assigns the DELETED status to an MLModel, rendering it unusable.", "operationId"=>"deleteMLModel", "x-api-path-slug"=>"actiondeletemlmodel-get", "parameters"=>[{"in"=>"query", "name"=>"MLModelId", "description"=>"A user-supplied ID that uniquely identifies the MLModel", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Models"]}}, "/?Action=DeleteRealtimeEndpoint"=>{"get"=>{"summary"=>"Delete Realtime Endpoint", "description"=>"Deletes a real time endpoint of an MLModel.", "operationId"=>"deleteRealtimeEndpoint", "x-api-path-slug"=>"actiondeleterealtimeendpoint-get", "parameters"=>[{"in"=>"query", "name"=>"MLModelId", "description"=>"The ID assigned to the MLModel during creation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Real Time"]}}, "/?Action=DeleteTags"=>{"get"=>{"summary"=>"Delete Tags", "description"=>"Deletes the specified tags associated with an ML object.", "operationId"=>"deleteTags", "x-api-path-slug"=>"actiondeletetags-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceId", "description"=>"The ID of the tagged ML object", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceType", "description"=>"The type of the tagged ML object", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys", "description"=>"One or more tags to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Tags"]}}, "/?Action=DescribeBatchPredictions"=>{"get"=>{"summary"=>"Describe Batch Predictions", "description"=>"Returns a list of BatchPrediction operations that match the search criteria in the request.", "operationId"=>"describeBatchPredictions", "x-api-path-slug"=>"actiondescribebatchpredictions-get", "parameters"=>[{"in"=>"query", "name"=>"EQ", "description"=>"The equal to operator", "type"=>"string"}, {"in"=>"query", "name"=>"FilterVariable", "description"=>"Use one of the following variables to filter a list of BatchPrediction:", "type"=>"string"}, {"in"=>"query", "name"=>"GE", "description"=>"The greater than or equal to operator", "type"=>"string"}, {"in"=>"query", "name"=>"GT", "description"=>"The greater than operator", "type"=>"string"}, {"in"=>"query", "name"=>"LE", "description"=>"The less than or equal to operator", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The number of pages of information to include in the result", "type"=>"string"}, {"in"=>"query", "name"=>"LT", "description"=>"The less than operator", "type"=>"string"}, {"in"=>"query", "name"=>"NE", "description"=>"The not equal to operator", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"An ID of the page in the paginated results", "type"=>"string"}, {"in"=>"query", "name"=>"Prefix", "description"=>"A string that is found at the beginning of a variable, such as Name or Id", "type"=>"string"}, {"in"=>"query", "name"=>"SortOrder", "description"=>"A two-value parameter that determines the sequence of the resulting list of MLModels", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Batches"]}}, "/?Action=DescribeDataSources"=>{"get"=>{"summary"=>"Describe Data Sources", "description"=>"Returns a list of DataSource that match the search criteria in the request.", "operationId"=>"describeDataSources", "x-api-path-slug"=>"actiondescribedatasources-get", "parameters"=>[{"in"=>"query", "name"=>"EQ", "description"=>"The equal to operator", "type"=>"string"}, {"in"=>"query", "name"=>"FilterVariable", "description"=>"Use one of the following variables to filter a list of DataSource:", "type"=>"string"}, {"in"=>"query", "name"=>"GE", "description"=>"The greater than or equal to operator", "type"=>"string"}, {"in"=>"query", "name"=>"GT", "description"=>"The greater than operator", "type"=>"string"}, {"in"=>"query", "name"=>"LE", "description"=>"The less than or equal to operator", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of DataSource to include in the result", "type"=>"string"}, {"in"=>"query", "name"=>"LT", "description"=>"The less than operator", "type"=>"string"}, {"in"=>"query", "name"=>"NE", "description"=>"The not equal to operator", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The ID of the page in the paginated results", "type"=>"string"}, {"in"=>"query", "name"=>"Prefix", "description"=>"A string that is found at the beginning of a variable, such as Name or Id", "type"=>"string"}, {"in"=>"query", "name"=>"SortOrder", "description"=>"A two-value parameter that determines the sequence of the resulting list of DataSource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Data Sources"]}}, "/?Action=DescribeEvaluations"=>{"get"=>{"summary"=>"Describe Evaluations", "description"=>"Returns a list of DescribeEvaluations that match the search criteria in the request.", "operationId"=>"describeEvaluations", "x-api-path-slug"=>"actiondescribeevaluations-get", "parameters"=>[{"in"=>"query", "name"=>"EQ", "description"=>"The equal to operator", "type"=>"string"}, {"in"=>"query", "name"=>"FilterVariable", "description"=>"Use one of the following variable to filter a list of Evaluation objects:", "type"=>"string"}, {"in"=>"query", "name"=>"GE", "description"=>"The greater than or equal to operator", "type"=>"string"}, {"in"=>"query", "name"=>"GT", "description"=>"The greater than operator", "type"=>"string"}, {"in"=>"query", "name"=>"LE", "description"=>"The less than or equal to operator", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of Evaluation to include in the result", "type"=>"string"}, {"in"=>"query", "name"=>"LT", "description"=>"The less than operator", "type"=>"string"}, {"in"=>"query", "name"=>"NE", "description"=>"The not equal to operator", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The ID of the page in the paginated results", "type"=>"string"}, {"in"=>"query", "name"=>"Prefix", "description"=>"A string that is found at the beginning of a variable, such as Name or Id", "type"=>"string"}, {"in"=>"query", "name"=>"SortOrder", "description"=>"A two-value parameter that determines the sequence of the resulting list of Evaluation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Evaluations"]}}, "/?Action=DescribeMLModels"=>{"get"=>{"summary"=>"Describe M L Models", "description"=>"Returns a list of MLModel that match the search criteria in the request.", "operationId"=>"describeMLModels", "x-api-path-slug"=>"actiondescribemlmodels-get", "parameters"=>[{"in"=>"query", "name"=>"EQ", "description"=>"The equal to operator", "type"=>"string"}, {"in"=>"query", "name"=>"FilterVariable", "description"=>"Use one of the following variables to filter a list of MLModel:", "type"=>"string"}, {"in"=>"query", "name"=>"GE", "description"=>"The greater than or equal to operator", "type"=>"string"}, {"in"=>"query", "name"=>"GT", "description"=>"The greater than operator", "type"=>"string"}, {"in"=>"query", "name"=>"LE", "description"=>"The less than or equal to operator", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The number of pages of information to include in the result", "type"=>"string"}, {"in"=>"query", "name"=>"LT", "description"=>"The less than operator", "type"=>"string"}, {"in"=>"query", "name"=>"NE", "description"=>"The not equal to operator", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The ID of the page in the paginated results", "type"=>"string"}, {"in"=>"query", "name"=>"Prefix", "description"=>"A string that is found at the beginning of a variable, such as Name or Id", "type"=>"string"}, {"in"=>"query", "name"=>"SortOrder", "description"=>"A two-value parameter that determines the sequence of the resulting list of MLModel", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Models"]}}, "/?Action=DescribeTags"=>{"get"=>{"summary"=>"Describe Tags", "description"=>"Describes one or more of the tags for your Amazon ML object.", "operationId"=>"describeTags", "x-api-path-slug"=>"actiondescribetags-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceId", "description"=>"The ID of the ML object", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceType", "description"=>"The type of the ML object", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Real Time"]}}, "/?Action=GetBatchPrediction"=>{"get"=>{"summary"=>"Get Batch Prediction", "description"=>"Returns a BatchPrediction that includes detailed metadata, status, and data file information for a\n Batch Prediction request.", "operationId"=>"getBatchPrediction", "x-api-path-slug"=>"actiongetbatchprediction-get", "parameters"=>[{"in"=>"query", "name"=>"BatchPredictionId", "description"=>"An ID assigned to the BatchPrediction at creation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Batches"]}}, "/?Action=GetDataSource"=>{"get"=>{"summary"=>"Get Data Source", "description"=>"Returns a DataSource that includes metadata and data file information, as well as the current status of the DataSource.", "operationId"=>"getDataSource", "x-api-path-slug"=>"actiongetdatasource-get", "parameters"=>[{"in"=>"query", "name"=>"DataSourceId", "description"=>"The ID assigned to the DataSource at creation", "type"=>"string"}, {"in"=>"query", "name"=>"Verbose", "description"=>"Specifies whether the GetDataSource operation should return DataSourceSchema", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Data Sources"]}}, "/?Action=GetEvaluation"=>{"get"=>{"summary"=>"Get Evaluation", "description"=>"Returns an Evaluation that includes metadata as well as the current status of the Evaluation.", "operationId"=>"getEvaluation", "x-api-path-slug"=>"actiongetevaluation-get", "parameters"=>[{"in"=>"query", "name"=>"EvaluationId", "description"=>"The ID of the Evaluation to retrieve", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Evaluations"]}}, "/?Action=GetMLModel"=>{"get"=>{"summary"=>"Get M L Model", "description"=>"Returns an MLModel that includes detailed metadata, data source information, and the current status of the MLModel.", "operationId"=>"getMLModel", "x-api-path-slug"=>"actiongetmlmodel-get", "parameters"=>[{"in"=>"query", "name"=>"MLModelId", "description"=>"The ID assigned to the MLModel at creation", "type"=>"string"}, {"in"=>"query", "name"=>"Verbose", "description"=>"Specifies whether the GetMLModel operation should return Recipe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Models"]}}, "/?Action=Predict"=>{"get"=>{"summary"=>"Predict", "description"=>"Generates a prediction for the observation using the specified ML Model.", "operationId"=>"predict", "x-api-path-slug"=>"actionpredict-get", "parameters"=>[{"in"=>"query", "name"=>"MLModelId", "description"=>"A unique identifier of the MLModel", "type"=>"string"}, {"in"=>"query", "name"=>"PredictEndpoint", "description"=>"Type: String", "type"=>"string"}, {"in"=>"query", "name"=>"Record", "description"=>"A map of variable name-value pairs that represent an observation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Predict"]}}, "/?Action=UpdateBatchPrediction"=>{"get"=>{"summary"=>"Update Batch Prediction", "description"=>"Updates the BatchPredictionName of a BatchPrediction.", "operationId"=>"updateBatchPrediction", "x-api-path-slug"=>"actionupdatebatchprediction-get", "parameters"=>[{"in"=>"query", "name"=>"BatchPredictionId", "description"=>"The ID assigned to the BatchPrediction during creation", "type"=>"string"}, {"in"=>"query", "name"=>"BatchPredictionName", "description"=>"A new user-supplied name or description of the BatchPrediction", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Batches"]}}, "/?Action=UpdateDataSource"=>{"get"=>{"summary"=>"Update Data Source", "description"=>"Updates the DataSourceName of a DataSource.", "operationId"=>"updateDataSource", "x-api-path-slug"=>"actionupdatedatasource-get", "parameters"=>[{"in"=>"query", "name"=>"DataSourceId", "description"=>"The ID assigned to the DataSource during creation", "type"=>"string"}, {"in"=>"query", "name"=>"DataSourceName", "description"=>"A new user-supplied name or description of the DataSource that will replace the current description", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Data Sources"]}}, "/?Action=UpdateEvaluation"=>{"get"=>{"summary"=>"Update Evaluation", "description"=>"Updates the EvaluationName of an Evaluation.", "operationId"=>"updateEvaluation", "x-api-path-slug"=>"actionupdateevaluation-get", "parameters"=>[{"in"=>"query", "name"=>"EvaluationId", "description"=>"The ID assigned to the Evaluation during creation", "type"=>"string"}, {"in"=>"query", "name"=>"EvaluationName", "description"=>"A new user-supplied name or description of the Evaluation that will replace the current content", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Evaluations"]}}, "/?Action=UpdateMLModel"=>{"get"=>{"summary"=>"Update M L Model", "description"=>"Updates the MLModelName and the ScoreThreshold of an MLModel.", "operationId"=>"updateMLModel", "x-api-path-slug"=>"actionupdatemlmodel-get", "parameters"=>[{"in"=>"query", "name"=>"MLModelId", "description"=>"The ID assigned to the MLModel during creation", "type"=>"string"}, {"in"=>"query", "name"=>"MLModelName", "description"=>"A user-supplied name or description of the MLModel", "type"=>"string"}, {"in"=>"query", "name"=>"ScoreThreshold", "description"=>"The ScoreThreshold used in binary classification MLModel that marks the boundary between a positive prediction and a negative prediction", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Models"]}}}}, "apis"=>{"name"=>"AWS Machine Learning", "x-slug"=>"aws-machine-learning", "description"=>"Amazon Machine Learning is a service that makes it easy for developers of all skill levels to use machine learning technology. Amazon Machine Learning provides visualization tools and wizards that guide you through the process of creating machine learning (ML) models without having to learn complex ML algorithms and technology. Once your models are ready, Amazon Machine Learning makes it easy to obtain predictions for your application using simple APIs, without having to implement custom prediction generation code, or manage any infrastructure.Amazon Machine Learning is based on the same proven, highly scalable, ML technology used for years by Amazon’s internal data scientist community. The service uses powerful algorithms to create ML models by finding patterns in your existing data. Then, Amazon Machine Learning uses these models to process new data and generate predictions for your application.Amazon Machine Learning is highly scalable and can generate billions of predictions daily, and serve those predictions in real-time and at high throughput. With Amazon Machine Learning, there is no upfront hardware or software investment, and you pay as you go, so you can start small and scale as your application grows.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Analytics_AmazonMachineLearning.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Machine Learning,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-machine-learning/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Machine Learning API", "x-api-slug"=>"aws-machine-learning-api", "description"=>"Amazon Machine Learning is a service that makes it easy for developers of all skill levels to use machine learning technology. Amazon Machine Learning provides visualization tools and wizards that guide you through the process of creating machine learning (ML) models without having to learn complex ML algorithms and technology. Once your models are ready, Amazon Machine Learning makes it easy to obtain predictions for your application using simple APIs, without having to implement custom prediction generation code, or manage any infrastructure.Amazon Machine Learning is based on the same proven, highly scalable, ML technology used for years by Amazon’s internal data scientist community. The service uses powerful algorithms to create ML models by finding patterns in your existing data. Then, Amazon Machine Learning uses these models to process new data and generate predictions for your application.Amazon Machine Learning is highly scalable and can generate billions of predictions daily, and serve those predictions in real-time and at high throughput. With Amazon Machine Learning, there is no upfront hardware or software investment, and you pay as you go, so you can start small and scale as your application grows.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Analytics_AmazonMachineLearning.png", "humanURL"=>"https://aws.amazon.com/machine-learning/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Machine Learning,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-machine-learning/aws-machine-learning-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-command-line-interface", "url"=>"http://aws.amazon.com/cli/"}, {"type"=>"x-console", "url"=>"https://console.aws.amazon.com/machinelearning"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/machine-learning/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/machine-learning/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/machine-learning/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/machine-learning/pricing/"}, {"type"=>"x-tools", "url"=>"http://aws.amazon.com/developertools/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/machine-learning/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
xibo{"xibo-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xibo", "x-complete"=>1, "info"=>{"title"=>"Xibo API", "description"=>"xibo-cms-api", "termsOfService"=>"http://xibo.org.uk/legal", "version"=>"1.0.0"}, "basePath"=>"/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/campaign"=>{"get"=>{"summary"=>"Search Campaigns", "description"=>"Search all Campaigns this user has access to", "operationId"=>"campaignSearch", "x-api-path-slug"=>"campaign-get", "parameters"=>[{"in"=>"formData", "name"=>"campaignId", "description"=>"Filter by Campaign Id"}, {"in"=>"formData", "name"=>"hasLayouts", "description"=>"Filter by has layouts"}, {"in"=>"formData", "name"=>"isLayoutSpecific", "description"=>"Filter by whether this Campaign is specific to a Layout or User added"}, {"in"=>"formData", "name"=>"name", "description"=>"Filter by Name"}, {"in"=>"formData", "name"=>"retired", "description"=>"Filter by retired"}, {"in"=>"formData", "name"=>"tags", "description"=>"Filter by Tags"}, {"in"=>"formData", "name"=>"totalDuration", "description"=>"Should we total the duration?"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Campaigns"]}, "post"=>{"summary"=>"Add Campaign", "description"=>"Add a Campaign", "operationId"=>"campaignAdd", "x-api-path-slug"=>"campaign-post", "parameters"=>[{"in"=>"formData", "name"=>"name", "description"=>"Name for this Campaign"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaign"]}}, "/campaign/{campaignId}"=>{"put"=>{"summary"=>"Edit Campaign", "description"=>"Edit an existing Campaign", "operationId"=>"campaignEdit", "x-api-path-slug"=>"campaigncampaignid-put", "parameters"=>[{"in"=>"path", "name"=>"campaignId", "description"=>"The Campaign ID to Edit"}, {"in"=>"formData", "name"=>"name", "description"=>"Name for this Campaign"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Campaign"]}, "delete"=>{"summary"=>"Delete Campaign", "description"=>"Delete an existing Campaign", "operationId"=>"campaignDelete", "x-api-path-slug"=>"campaigncampaignid-delete", "parameters"=>[{"in"=>"path", "name"=>"campaignId", "description"=>"The Campaign ID to Delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaign"]}}, "/campaign/layout/assign/{campaignId}"=>{"post"=>{"summary"=>"Assign Layouts", "description"=>"Assign Layouts to a Campaign", "operationId"=>"campaignAssignLayout", "x-api-path-slug"=>"campaignlayoutassigncampaignid-post", "parameters"=>[{"in"=>"path", "name"=>"campaignId", "description"=>"The Campaign ID"}, {"in"=>"formData", "name"=>"layoutId", "description"=>"Array of Layout ID/Display Orders to Assign"}, {"in"=>"formData", "name"=>"unassignLayoutId", "description"=>"Array of Layout ID/Display Orders to unassign"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assign", "Layouts"]}}, "/clock"=>{"get"=>{"summary"=>"The current CMS time", "description"=>"The Time", "operationId"=>"clock", "x-api-path-slug"=>"clock-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["The", "Current", "CMS", "Time"]}}, "/command"=>{"get"=>{"summary"=>"Command Search", "description"=>"Search this users Commands", "operationId"=>"commandSearch", "x-api-path-slug"=>"command-get", "parameters"=>[{"in"=>"formData", "name"=>"code", "description"=>"Filter by Command Code"}, {"in"=>"formData", "name"=>"command", "description"=>"Filter by Command Name"}, {"in"=>"formData", "name"=>"commandId", "description"=>"Filter by Command Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Command", "Search"]}, "post"=>{"summary"=>"Command Add", "description"=>"Add a Command", "operationId"=>"commandAdd", "x-api-path-slug"=>"command-post", "parameters"=>[{"in"=>"formData", "name"=>"code", "description"=>"A unique code for this command"}, {"in"=>"formData", "name"=>"command", "description"=>"The Command Name"}, {"in"=>"formData", "name"=>"description", "description"=>"A description for the command"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Command"]}}, "/command/{commandId}"=>{"put"=>{"summary"=>"Edit Command", "description"=>"Edit the provided command", "operationId"=>"commandEdit", "x-api-path-slug"=>"commandcommandid-put", "parameters"=>[{"in"=>"formData", "name"=>"command", "description"=>"The Command Name"}, {"in"=>"path", "name"=>"commandId", "description"=>"The Command Id to Edit"}, {"in"=>"formData", "name"=>"description", "description"=>"A description for the command"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Command"]}, "delete"=>{"summary"=>"Delete Command", "description"=>"Delete the provided command", "operationId"=>"commandDelete", "x-api-path-slug"=>"commandcommandid-delete", "parameters"=>[{"in"=>"path", "name"=>"commandId", "description"=>"The Command Id to Delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Command"]}}, "/dataset"=>{"get"=>{"summary"=>"DataSet Search", "description"=>"Search this users DataSets", "operationId"=>"dataSetSearch", "x-api-path-slug"=>"dataset-get", "parameters"=>[{"in"=>"formData", "name"=>"code", "description"=>"Filter by DataSet Code"}, {"in"=>"formData", "name"=>"dataSet", "description"=>"Filter by DataSet Name"}, {"in"=>"formData", "name"=>"dataSetId", "description"=>"Filter by DataSet Id"}, {"in"=>"formData", "name"=>"embed", "description"=>"Embed related data such as columns"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DataSet", "Search"]}, "post"=>{"summary"=>"Add DataSet", "description"=>"Add a DataSet", "operationId"=>"dataSetAdd", "x-api-path-slug"=>"dataset-post", "parameters"=>[{"in"=>"formData", "name"=>"authentication", "description"=>"HTTP Authentication method None|Basic|Digest"}, {"in"=>"formData", "name"=>"clearRate", "description"=>"How often in seconds should this remote DataSet be truncated"}, {"in"=>"formData", "name"=>"code", "description"=>"A code for this DataSet"}, {"in"=>"formData", "name"=>"dataRoot", "description"=>"The root of the data in the Remote source which is used as the base for all remote columns"}, {"in"=>"formData", "name"=>"dataSet", "description"=>"The DataSet Name"}, {"in"=>"formData", "name"=>"description", "description"=>"A description of this DataSet"}, {"in"=>"formData", "name"=>"isRemote", "description"=>"Is this a remote DataSet?"}, {"in"=>"formData", "name"=>"method", "description"=>"The Request Method GET or POST"}, {"in"=>"formData", "name"=>"password", "description"=>"HTTP Authentication Password"}, {"in"=>"formData", "name"=>"postData", "description"=>"query parameter encoded data to add to the request"}, {"in"=>"formData", "name"=>"refreshRate", "description"=>"How often in seconds should this remote DataSet be refreshed"}, {"in"=>"formData", "name"=>"runsAfter", "description"=>"An optional dataSetId which should be run before this Remote DataSet"}, {"in"=>"formData", "name"=>"summarize", "description"=>"Should the data be aggregated? None|Summarize|Count"}, {"in"=>"formData", "name"=>"summarizeField", "description"=>"Which field should be used to summarize"}, {"in"=>"formData", "name"=>"uri", "description"=>"The URI, without query parameters"}, {"in"=>"formData", "name"=>"username", "description"=>"HTTP Authentication User Name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DataSet"]}}, "/dataset/{dataSetId}"=>{"put"=>{"summary"=>"Edit DataSet", "description"=>"Edit a DataSet", "operationId"=>"dataSetEdit", "x-api-path-slug"=>"datasetdatasetid-put", "parameters"=>[{"in"=>"formData", "name"=>"authentication", "description"=>"HTTP Authentication method None|Basic|Digest"}, {"in"=>"formData", "name"=>"clearRate", "description"=>"How often in seconds should this remote DataSet be truncated"}, {"in"=>"formData", "name"=>"code", "description"=>"A code for this DataSet"}, {"in"=>"formData", "name"=>"dataRoot", "description"=>"The root of the data in the Remote source which is used as the base for all remote columns"}, {"in"=>"formData", "name"=>"dataSet", "description"=>"The DataSet Name"}, {"in"=>"path", "name"=>"dataSetId", "description"=>"The DataSet ID"}, {"in"=>"formData", "name"=>"description", "description"=>"A description of this DataSet"}, {"in"=>"formData", "name"=>"isRemote", "description"=>"Is this a remote DataSet?"}, {"in"=>"formData", "name"=>"method", "description"=>"The Request Method GET or POST"}, {"in"=>"formData", "name"=>"password", "description"=>"HTTP Authentication Password"}, {"in"=>"formData", "name"=>"postData", "description"=>"query parameter encoded data to add to the request"}, {"in"=>"formData", "name"=>"refreshRate", "description"=>"How often in seconds should this remote DataSet be refreshed"}, {"in"=>"formData", "name"=>"runsAfter", "description"=>"An optional dataSetId which should be run before this Remote DataSet"}, {"in"=>"formData", "name"=>"summarize", "description"=>"Should the data be aggregated? None|Summarize|Count"}, {"in"=>"formData", "name"=>"summarizeField", "description"=>"Which field should be used to summarize"}, {"in"=>"formData", "name"=>"uri", "description"=>"The URI, without query parameters"}, {"in"=>"formData", "name"=>"username", "description"=>"HTTP Authentication User Name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "DataSet"]}, "delete"=>{"summary"=>"Delete DataSet", "description"=>"Delete a DataSet", "operationId"=>"dataSetDelete", "x-api-path-slug"=>"datasetdatasetid-delete", "parameters"=>[{"in"=>"path", "name"=>"dataSetId", "description"=>"The DataSet ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DataSet"]}}, "/dataset/copy/{dataSetId}"=>{"post"=>{"summary"=>"Copy DataSet", "description"=>"Copy a DataSet", "operationId"=>"dataSetCopy", "x-api-path-slug"=>"datasetcopydatasetid-post", "parameters"=>[{"in"=>"formData", "name"=>"code", "description"=>"A code for this DataSet"}, {"in"=>"formData", "name"=>"dataSet", "description"=>"The DataSet Name"}, {"in"=>"path", "name"=>"dataSetId", "description"=>"The DataSet ID"}, {"in"=>"formData", "name"=>"description", "description"=>"A description of this DataSet"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Copy", "DataSet"]}}, "/dataset/import/{dataSetId}"=>{"post"=>{"summary"=>"Import CSV", "description"=>"Import a CSV into a DataSet", "operationId"=>"dataSetImport", "x-api-path-slug"=>"datasetimportdatasetid-post", "parameters"=>[{"in"=>"formData", "name"=>"csvImport_{dataSetColumnId}", "description"=>"You need to provide dataSetColumnId after csvImport_, to know your dataSet columns Ids, you will need to use the GET /dataset/{dataSetId}/column call first"}, {"in"=>"path", "name"=>"dataSetId", "description"=>"The DataSet ID to import into"}, {"in"=>"formData", "name"=>"files", "description"=>"The file"}, {"in"=>"formData", "name"=>"ignorefirstrow", "description"=>"flag (0,1), Set to 1 to Ignore first row, useful if the CSV file has headings"}, {"in"=>"formData", "name"=>"overwrite", "description"=>"flag (0,1) Set to 1 to erase all content in the dataSet and overwrite it with new content in this import"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import", "CSV"]}}, "/dataset/importjson/{dataSetId}"=>{"post"=>{"summary"=>"Import JSON", "description"=>"Import JSON into a DataSet", "operationId"=>"dataSetImportJson", "x-api-path-slug"=>"datasetimportjsondatasetid-post", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"The row data, field name vs field data format", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"dataSetId", "description"=>"The DataSet ID to import into"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import", "JSON"]}}, "/dataset/{dataSetId}/column"=>{"get"=>{"summary"=>"Search Columns", "description"=>"Search Columns for DataSet", "operationId"=>"dataSetColumnSearch", "x-api-path-slug"=>"datasetdatasetidcolumn-get", "parameters"=>[{"in"=>"formData", "name"=>"dataSetColumnId", "description"=>"Filter by DataSet ColumnID"}, {"in"=>"path", "name"=>"dataSetId", "description"=>"The DataSet ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Columns"]}, "post"=>{"summary"=>"Add Column", "description"=>"Add a Column to a DataSet", "operationId"=>"dataSetColumnAdd", "x-api-path-slug"=>"datasetdatasetidcolumn-post", "parameters"=>[{"in"=>"formData", "name"=>"columnOrder", "description"=>"The display order for this column"}, {"in"=>"formData", "name"=>"dataSetColumnTypeId", "description"=>"The column type for this column"}, {"in"=>"path", "name"=>"dataSetId", "description"=>"The DataSet ID"}, {"in"=>"formData", "name"=>"dataTypeId", "description"=>"The data type ID for this column"}, {"in"=>"formData", "name"=>"formula", "description"=>"MySQL SELECT syntax formula for this Column if the column type is formula"}, {"in"=>"formData", "name"=>"heading", "description"=>"The heading for the Column"}, {"in"=>"formData", "name"=>"listContent", "description"=>"A comma separated list of content for drop downs"}, {"in"=>"formData", "name"=>"remoteField", "description"=>"JSON-String to select Data from the Remote DataSet"}, {"in"=>"formData", "name"=>"showFilter", "description"=>"Flag indicating whether this column should present a filter on DataEntry"}, {"in"=>"formData", "name"=>"showSort", "description"=>"Flag indicating whether this column should allow sorting on DataEntry"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Column"]}}, "/dataset/{dataSetId}/column/{dataSetColumnId}"=>{"put"=>{"summary"=>"Edit Column", "description"=>"Edit a Column to a DataSet", "operationId"=>"dataSetColumnEdit", "x-api-path-slug"=>"datasetdatasetidcolumndatasetcolumnid-put", "parameters"=>[{"in"=>"formData", "name"=>"columnOrder", "description"=>"The display order for this column"}, {"in"=>"path", "name"=>"dataSetColumnId", "description"=>"The Column ID"}, {"in"=>"formData", "name"=>"dataSetColumnTypeId", "description"=>"The column type for this column"}, {"in"=>"path", "name"=>"dataSetId", "description"=>"The DataSet ID"}, {"in"=>"formData", "name"=>"dataTypeId", "description"=>"The data type ID for this column"}, {"in"=>"formData", "name"=>"formula", "description"=>"MySQL SELECT syntax formula for this Column if the column type is formula"}, {"in"=>"formData", "name"=>"heading", "description"=>"The heading for the Column"}, {"in"=>"formData", "name"=>"listContent", "description"=>"A comma separated list of content for drop downs"}, {"in"=>"formData", "name"=>"remoteField", "description"=>"JSON-String to select Data from the Remote DataSet"}, {"in"=>"formData", "name"=>"showFilter", "description"=>"Flag indicating whether this column should present a filter on DataEntry"}, {"in"=>"formData", "name"=>"showSort", "description"=>"Flag indicating whether this column should allow sorting on DataEntry"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Column"]}, "delete"=>{"summary"=>"Delete Column", "description"=>"Delete DataSet Column", "operationId"=>"dataSetColumnDelete", "x-api-path-slug"=>"datasetdatasetidcolumndatasetcolumnid-delete", "parameters"=>[{"in"=>"path", "name"=>"dataSetColumnId", "description"=>"The Column ID"}, {"in"=>"path", "name"=>"dataSetId", "description"=>"The DataSet ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Column"]}}, "/dataset/data/{dataSetId}"=>{"get"=>{"summary"=>"DataSet Data", "description"=>"Get Data for DataSet", "operationId"=>"dataSetData", "x-api-path-slug"=>"datasetdatadatasetid-get", "parameters"=>[{"in"=>"path", "name"=>"dataSetId", "description"=>"The DataSet ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DataSet", "Data"]}, "post"=>{"summary"=>"Add Row", "description"=>"Add a row of Data to a DataSet", "operationId"=>"dataSetDataAdd", "x-api-path-slug"=>"datasetdatadatasetid-post", "parameters"=>[{"in"=>"formData", "name"=>"dataSetColumnId_ID", "description"=>"Parameter for each dataSetColumnId in the DataSet"}, {"in"=>"path", "name"=>"dataSetId", "description"=>"The DataSet ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Row"]}}, "/dataset/data/{dataSetId}/{rowId}"=>{"put"=>{"summary"=>"Edit Row", "description"=>"Edit a row of Data to a DataSet", "operationId"=>"dataSetDataEdit", "x-api-path-slug"=>"datasetdatadatasetidrowid-put", "parameters"=>[{"in"=>"formData", "name"=>"dataSetColumnId_ID", "description"=>"Parameter for each dataSetColumnId in the DataSet"}, {"in"=>"path", "name"=>"dataSetId", "description"=>"The DataSet ID"}, {"in"=>"path", "name"=>"rowId", "description"=>"The Row ID of the Data to Edit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Row"]}, "delete"=>{"summary"=>"Delete Row", "description"=>"Delete a row of Data to a DataSet", "operationId"=>"dataSetDataDelete", "x-api-path-slug"=>"datasetdatadatasetidrowid-delete", "parameters"=>[{"in"=>"path", "name"=>"dataSetId", "description"=>"The DataSet ID"}, {"in"=>"path", "name"=>"rowId", "description"=>"The Row ID of the Data to Delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Row"]}}, "/daypart"=>{"get"=>{"summary"=>"Daypart Search", "description"=>"Search dayparts", "operationId"=>"dayPartSearch", "x-api-path-slug"=>"daypart-get", "parameters"=>[{"in"=>"formData", "name"=>"dayPartId", "description"=>"The dayPart ID to Search"}, {"in"=>"formData", "name"=>"embed", "description"=>"Embed related data such as exceptions"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the dayPart to Search"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Daypart", "Search"]}, "post"=>{"summary"=>"Daypart Add", "description"=>"Add a Daypart", "operationId"=>"dayPartAdd", "x-api-path-slug"=>"daypart-post", "parameters"=>[{"in"=>"formData", "name"=>"description", "description"=>"A description for the dayPart"}, {"in"=>"formData", "name"=>"endTime", "description"=>"The end time for this day part"}, {"in"=>"formData", "name"=>"exceptionDays", "description"=>"String array of exception days"}, {"in"=>"formData", "name"=>"exceptionEndTimes", "description"=>"String array of exception end times to match the exception days"}, {"in"=>"formData", "name"=>"exceptionStartTimes", "description"=>"String array of exception start times to match the exception days"}, {"in"=>"formData", "name"=>"name", "description"=>"The Daypart Name"}, {"in"=>"formData", "name"=>"startTime", "description"=>"The start time for this day part"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Daypart"]}}, "/daypart/{dayPartId}"=>{"put"=>{"summary"=>"Daypart Add", "description"=>"Add a Daypart", "operationId"=>"dayPartAdd", "x-api-path-slug"=>"daypartdaypartid-put", "parameters"=>[{"in"=>"path", "name"=>"dayPartId", "description"=>"The Daypart Id"}, {"in"=>"formData", "name"=>"description", "description"=>"A description for the dayPart"}, {"in"=>"formData", "name"=>"endTime", "description"=>"The end time for this day part"}, {"in"=>"formData", "name"=>"exceptionDays", "description"=>"String array of exception days"}, {"in"=>"formData", "name"=>"exceptionEndTimes", "description"=>"String array of exception end times to match the exception days"}, {"in"=>"formData", "name"=>"exceptionStartTimes", "description"=>"String array of exception start times to match the exception days"}, {"in"=>"formData", "name"=>"name", "description"=>"The Daypart Name"}, {"in"=>"formData", "name"=>"startTime", "description"=>"The start time for this day part"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Daypart"]}, "delete"=>{"summary"=>"Delete DayPart", "description"=>"Delete the provided dayPart", "operationId"=>"dayPartDelete", "x-api-path-slug"=>"daypartdaypartid-delete", "parameters"=>[{"in"=>"path", "name"=>"dayPartId", "description"=>"The Daypart Id to Delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DayPart"]}}, "/display"=>{"get"=>{"summary"=>"Display Search", "description"=>"Search Displays for this User", "operationId"=>"displaySearch", "x-api-path-slug"=>"display-get", "parameters"=>[{"in"=>"formData", "name"=>"authorised", "description"=>"Filter by authorised flag"}, {"in"=>"formData", "name"=>"clientVersion", "description"=>"Filter by Client Version"}, {"in"=>"formData", "name"=>"display", "description"=>"Filter by Display Name"}, {"in"=>"formData", "name"=>"displayGroupId", "description"=>"Filter by DisplayGroup Id"}, {"in"=>"formData", "name"=>"displayId", "description"=>"Filter by Display Id"}, {"in"=>"formData", "name"=>"displayProfileId", "description"=>"Filter by Display Profile"}, {"in"=>"formData", "name"=>"embed", "description"=>"Embed related data, namely displaygroups"}, {"in"=>"formData", "name"=>"hardwareKey", "description"=>"Filter by Hardware Key"}, {"in"=>"formData", "name"=>"macAddress", "description"=>"Filter by Mac Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Display", "Search"]}}, "/display/{displayId}"=>{"put"=>{"summary"=>"Display Edit", "description"=>"Edit a Display", "operationId"=>"displayEdit", "x-api-path-slug"=>"displaydisplayid-put", "parameters"=>[{"in"=>"formData", "name"=>"alertTimeout", "description"=>"How long in seconds should this display wait before alerting when it hasnt connected"}, {"in"=>"formData", "name"=>"auditingUntil", "description"=>"A date this Display records auditing information until"}, {"in"=>"formData", "name"=>"broadCastAddress", "description"=>"The BroadCast Address for this Display - used by Wake On LAN"}, {"in"=>"formData", "name"=>"cidr", "description"=>"The CIDR configuration for this Display"}, {"in"=>"formData", "name"=>"clearCachedData", "description"=>"Clear all Cached data for this display"}, {"in"=>"formData", "name"=>"defaultLayoutId", "description"=>"A Layout ID representing the Default Layout for this Display"}, {"in"=>"formData", "name"=>"description", "description"=>"A description of the Display"}, {"in"=>"formData", "name"=>"display", "description"=>"The Display Name"}, {"in"=>"path", "name"=>"displayId", "description"=>"The Display ID"}, {"in"=>"formData", "name"=>"displayProfileId", "description"=>"The Display Settings Profile ID"}, {"in"=>"formData", "name"=>"emailAlert", "description"=>"Flag indicating whether the Display generates up/down email alerts"}, {"in"=>"formData", "name"=>"incSchedule", "description"=>"Flag indicating whether the Default Layout should be included in the Schedule"}, {"in"=>"formData", "name"=>"latitude", "description"=>"The Latitude of this Display"}, {"in"=>"formData", "name"=>"license", "description"=>"The hardwareKey to use as the licence key for this Display"}, {"in"=>"formData", "name"=>"licensed", "description"=>"Flag indicating whether this display is licensed"}, {"in"=>"formData", "name"=>"longitude", "description"=>"The Longitude of this Display"}, {"in"=>"formData", "name"=>"rekeyXmr", "description"=>"Clear the cached XMR configuration and send a rekey"}, {"in"=>"formData", "name"=>"secureOn", "description"=>"The secure on configuration for this Display"}, {"in"=>"formData", "name"=>"tags", "description"=>"A comma separated list of tags for this item"}, {"in"=>"formData", "name"=>"timeZone", "description"=>"The timezone for this display, or empty to use the CMS timezone"}, {"in"=>"formData", "name"=>"wakeOnLanEnabled", "description"=>"Flag indicating if Wake On LAN is enabled for this Display"}, {"in"=>"formData", "name"=>"wakeOnLanTime", "description"=>"A h:i string representing the time that the Display should receive its Wake on LAN command"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Display", "Edit"]}, "delete"=>{"summary"=>"Display Delete", "description"=>"Delete a Display", "operationId"=>"displayDelete", "x-api-path-slug"=>"displaydisplayid-delete", "parameters"=>[{"in"=>"path", "name"=>"displayId", "description"=>"The Display ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Display"]}}, "/display/requestscreenshot/{displayId}"=>{"put"=>{"summary"=>"Request Screen Shot", "description"=>"Notify the display that the CMS would like a screen shot to be sent.", "operationId"=>"displayRequestScreenshot", "x-api-path-slug"=>"displayrequestscreenshotdisplayid-put", "parameters"=>[{"in"=>"path", "name"=>"displayId", "description"=>"The Display ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Screen", "Shot"]}}, "/display/wol/{displayId}"=>{"post"=>{"summary"=>"Issue WOL", "description"=>"Send a Wake On LAN packet to this Display", "operationId"=>"displayWakeOnLan", "x-api-path-slug"=>"displaywoldisplayid-post", "parameters"=>[{"in"=>"path", "name"=>"displayId", "description"=>"The Display ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Issue", "WOL"]}}, "/display/authorise/{displayId}"=>{"post"=>{"summary"=>"Toggle authorised", "description"=>"Toggle authorised for the Display.", "operationId"=>"displayToggleAuthorise", "x-api-path-slug"=>"displayauthorisedisplayid-post", "parameters"=>[{"in"=>"path", "name"=>"displayId", "description"=>"The Display ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Toggle", "Authorised"]}}, "/display/defaultlayout/{displayId}"=>{"post"=>{"summary"=>"Set Default Layout", "description"=>"Sent the default Layout on this Display", "operationId"=>"displayDefaultLayout", "x-api-path-slug"=>"displaydefaultlayoutdisplayid-post", "parameters"=>[{"in"=>"path", "name"=>"displayId", "description"=>"The Display ID"}, {"in"=>"formData", "name"=>"layoutId", "description"=>"The Layout ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Default", "Layout"]}}, "/displaygroup"=>{"get"=>{"summary"=>"Get Display Groups", "description"=>"", "operationId"=>"displayGroupSearch", "x-api-path-slug"=>"displaygroup-get", "parameters"=>[{"in"=>"formData", "name"=>"displayGroup", "description"=>"Filter by DisplayGroup Name"}, {"in"=>"formData", "name"=>"displayGroupId", "description"=>"Filter by DisplayGroup Id"}, {"in"=>"formData", "name"=>"displayId", "description"=>"Filter by DisplayGroups containing a specific display"}, {"in"=>"formData", "name"=>"dynamicCriteria", "description"=>"Filter by DisplayGroups containing a specific dynamic criteria"}, {"in"=>"formData", "name"=>"forSchedule", "description"=>"Should the list be refined for only those groups the User can Schedule against?"}, {"in"=>"formData", "name"=>"isDisplaySpecific", "description"=>"Filter by whether the Display Group belongs to a Display or is user created"}, {"in"=>"formData", "name"=>"nestedDisplayId", "description"=>"Filter by DisplayGroups containing a specific display in there nesting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Display", "Groups"]}, "post"=>{"summary"=>"Add a Display Group", "description"=>"Add a new Display Group to the CMS", "operationId"=>"displayGroupAdd", "x-api-path-slug"=>"displaygroup-post", "parameters"=>[{"in"=>"formData", "name"=>"description", "description"=>"The Display Group Description"}, {"in"=>"formData", "name"=>"displayGroup", "description"=>"The Display Group Name"}, {"in"=>"formData", "name"=>"dynamicContent", "description"=>"The filter criteria for this dynamic group"}, {"in"=>"formData", "name"=>"isDynamic", "description"=>"Flag indicating whether this DisplayGroup is Dynamic"}, {"in"=>"formData", "name"=>"tags", "description"=>"A comma separated list of tags for this item"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Display", "Group"]}}, "/displaygroup/{displayGroupId}"=>{"put"=>{"summary"=>"Edit a Display Group", "description"=>"Edit an existing Display Group identified by its Id", "operationId"=>"displayGroupEdit", "x-api-path-slug"=>"displaygroupdisplaygroupid-put", "parameters"=>[{"in"=>"formData", "name"=>"description", "description"=>"The Display Group Description"}, {"in"=>"formData", "name"=>"displayGroup", "description"=>"The Display Group Name"}, {"in"=>"path", "name"=>"displayGroupId", "description"=>"The displayGroupId to edit"}, {"in"=>"formData", "name"=>"dynamicCriteria", "description"=>"The filter criteria for this dynamic group"}, {"in"=>"formData", "name"=>"isDynamic", "description"=>"Flag indicating whether this DisplayGroup is Dynamic"}, {"in"=>"formData", "name"=>"tags", "description"=>"A comma separated list of tags for this item"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Display", "Group"]}, "delete"=>{"summary"=>"Delete a Display Group", "description"=>"Delete an existing Display Group identified by its Id", "operationId"=>"displayGroupDelete", "x-api-path-slug"=>"displaygroupdisplaygroupid-delete", "parameters"=>[{"in"=>"path", "name"=>"displayGroupId", "description"=>"The displayGroupId to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Display", "Group"]}}, "/displaygroup/{displayGroupId}/display/assign"=>{"post"=>{"summary"=>"Assign one or more Displays to a Display Group", "description"=>"Adds the provided Displays to the Display Group", "operationId"=>"displayGroupDisplayAssign", "x-api-path-slug"=>"displaygroupdisplaygroupiddisplayassign-post", "parameters"=>[{"in"=>"path", "name"=>"displayGroupId", "description"=>"The Display Group to assign to"}, {"in"=>"formData", "name"=>"displayId", "description"=>"The Display Ids to assign"}, {"in"=>"formData", "name"=>"unassignDisplayId", "description"=>"An optional array of Display IDs to unassign"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assign", "More", "Displays", "To", "Display", "Group"]}}, "/displaygroup/{displayGroupId}/display/unassign"=>{"post"=>{"summary"=>"Unassigns one or more Displays to a Display Group", "description"=>"Removes the provided Displays from the Display Group", "operationId"=>"displayGroupDisplayUnassign", "x-api-path-slug"=>"displaygroupdisplaygroupiddisplayunassign-post", "parameters"=>[{"in"=>"path", "name"=>"displayGroupId", "description"=>"The Display Group to unassign from"}, {"in"=>"formData", "name"=>"displayId", "description"=>"The Display Ids to unassign"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unassigns", "More", "Displays", "To", "Display", "Group"]}}, "/displaygroup/{displayGroupId}/displayGroup/assign"=>{"post"=>{"summary"=>"Assign one or more DisplayGroups to a Display Group", "description"=>"Adds the provided DisplayGroups to the Display Group", "operationId"=>"displayGroupDisplayGroupAssign", "x-api-path-slug"=>"displaygroupdisplaygroupiddisplaygroupassign-post", "parameters"=>[{"in"=>"path", "name"=>"displayGroupId", "description"=>"The Display Group to assign to"}, {"in"=>"formData", "name"=>"displayGroupId", "description"=>"The displayGroup Ids to assign"}, {"in"=>"formData", "name"=>"unassignDisplayGroupId", "description"=>"An optional array of displayGroup IDs to unassign"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assign", "More", "DisplayGroups", "To", "Display", "Group"]}}, "/displaygroup/{displayGroupId}/displayGroup/unassign"=>{"post"=>{"summary"=>"Unassigns one or more DisplayGroups to a Display Group", "description"=>"Removes the provided DisplayGroups from the Display Group", "operationId"=>"displayGroupDisplayGroupUnassign", "x-api-path-slug"=>"displaygroupdisplaygroupiddisplaygroupunassign-post", "parameters"=>[{"in"=>"path", "name"=>"displayGroupId", "description"=>"The Display Group to unassign from"}, {"in"=>"formData", "name"=>"displayGroupId", "description"=>"The DisplayGroup Ids to unassign"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unassigns", "More", "DisplayGroups", "To", "Display", "Group"]}}, "/displaygroup/{displayGroupId}/media/assign"=>{"post"=>{"summary"=>"Assign one or more Media items to a Display Group", "description"=>"Adds the provided Media to the Display Group", "operationId"=>"displayGroupMediaAssign", "x-api-path-slug"=>"displaygroupdisplaygroupidmediaassign-post", "parameters"=>[{"in"=>"path", "name"=>"displayGroupId", "description"=>"The Display Group to assign to"}, {"in"=>"formData", "name"=>"mediaId", "description"=>"The Media Ids to assign"}, {"in"=>"formData", "name"=>"unassignMediaId", "description"=>"Optional array of Media Id to unassign"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assign", "More", "Media", "Items", "To", "Display", "Group"]}}, "/displaygroup/{displayGroupId}/media/unassign"=>{"post"=>{"summary"=>"Unassign one or more Media items from a Display Group", "description"=>"Removes the provided from the Display Group", "operationId"=>"displayGroupMediaUnassign", "x-api-path-slug"=>"displaygroupdisplaygroupidmediaunassign-post", "parameters"=>[{"in"=>"path", "name"=>"displayGroupId", "description"=>"The Display Group to unassign from"}, {"in"=>"formData", "name"=>"mediaId", "description"=>"The Media Ids to unassign"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unassign", "More", "Media", "Items", "From", "Display", "Group"]}}, "/displaygroup/{displayGroupId}/layout/assign"=>{"post"=>{"summary"=>"Assign one or more Layouts items to a Display Group", "description"=>"Adds the provided Layouts to the Display Group", "operationId"=>"displayGroupLayoutsAssign", "x-api-path-slug"=>"displaygroupdisplaygroupidlayoutassign-post", "parameters"=>[{"in"=>"path", "name"=>"displayGroupId", "description"=>"The Display Group to assign to"}, {"in"=>"formData", "name"=>"layoutId", "description"=>"The Layouts Ids to assign"}, {"in"=>"formData", "name"=>"unassignLayoutId", "description"=>"Optional array of Layouts Id to unassign"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assign", "More", "Layouts", "Items", "To", "Display", "Group"]}}, "/displaygroup/{displayGroupId}/layout/unassign"=>{"post"=>{"summary"=>"Unassign one or more Layout items from a Display Group", "description"=>"Removes the provided from the Display Group", "operationId"=>"displayGroupLayoutUnassign", "x-api-path-slug"=>"displaygroupdisplaygroupidlayoutunassign-post", "parameters"=>[{"in"=>"path", "name"=>"displayGroupId", "description"=>"The Display Group to unassign from"}, {"in"=>"formData", "name"=>"layoutId", "description"=>"The Layout Ids to unassign"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unassign", "More", "Layout", "Items", "From", "Display", "Group"]}}, "/displaygroup/{displayGroupId}/version"=>{"post"=>{"summary"=>"Set the Version for this Display", "description"=>"Sets the version instructions on all Displays in the Group", "operationId"=>"displayGroupDisplayVersion", "x-api-path-slug"=>"displaygroupdisplaygroupidversion-post", "parameters"=>[{"in"=>"path", "name"=>"displayGroupId", "description"=>"The Display Group ID"}, {"in"=>"formData", "name"=>"mediaId", "description"=>"The Media Id of the Installer File"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Versionthis", "Display"]}}, "/displaygroup/{displayGroupId}/action/collectNow"=>{"post"=>{"summary"=>"Action: Collect Now", "description"=>"Send the collect now action to this DisplayGroup", "operationId"=>"displayGroupActionCollectNow", "x-api-path-slug"=>"displaygroupdisplaygroupidactioncollectnow-post", "parameters"=>[{"in"=>"path", "name"=>"displayGroupId", "description"=>"The display group id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Action:", "Collect", "Now"]}}, "/displaygroup/{displayGroupId}/action/clearStatsAndLogs"=>{"post"=>{"summary"=>"Action: Clear Stats and Logs", "description"=>"Clear all stats and logs on this Group", "operationId"=>"displayGroupActionClearStatsAndLogs", "x-api-path-slug"=>"displaygroupdisplaygroupidactionclearstatsandlogs-post", "parameters"=>[{"in"=>"path", "name"=>"displayGroupId", "description"=>"The display group id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Action:", "Clear", "Stats", "Logs"]}}, "/displaygroup/{displayGroupId}/action/changeLayout"=>{"post"=>{"summary"=>"Action: Change Layout", "description"=>"Send the change layout action to this DisplayGroup", "operationId"=>"displayGroupActionChangeLayout", "x-api-path-slug"=>"displaygroupdisplaygroupidactionchangelayout-post", "parameters"=>[{"in"=>"formData", "name"=>"changeMode", "description"=>"Whether to queue or replace with this action"}, {"in"=>"path", "name"=>"displayGroupId", "description"=>"The Display Group Id"}, {"in"=>"formData", "name"=>"downloadRequired", "description"=>"Flag indicating whether the player should perform a collect before playing the Layout"}, {"in"=>"formData", "name"=>"duration", "description"=>"The duration in seconds for this Layout change to remain in effect"}, {"in"=>"formData", "name"=>"layoutId", "description"=>"The Layout Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Action:", "Change", "Layout"]}}, "/displaygroup/{displayGroupId}/action/revertToSchedule"=>{"post"=>{"summary"=>"Action: Revert to Schedule", "description"=>"Send the revert to schedule action to this DisplayGroup", "operationId"=>"displayGroupActionRevertToSchedule", "x-api-path-slug"=>"displaygroupdisplaygroupidactionreverttoschedule-post", "parameters"=>[{"in"=>"path", "name"=>"displayGroupId", "description"=>"The display group id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Action:", "Revert", "To", "Schedule"]}}, "/displaygroup/{displayGroupId}/action/overlayLayout"=>{"post"=>{"summary"=>"Action: Overlay Layout", "description"=>"Send the overlay layout action to this DisplayGroup", "operationId"=>"displayGroupActionOverlayLayout", "x-api-path-slug"=>"displaygroupdisplaygroupidactionoverlaylayout-post", "parameters"=>[{"in"=>"path", "name"=>"displayGroupId", "description"=>"The Display Group Id"}, {"in"=>"formData", "name"=>"downloadRequired", "description"=>"Flag indicating whether the player should perform a collect before adding the Overlay"}, {"in"=>"formData", "name"=>"duration", "description"=>"The duration in seconds for this Overlay to remain in effect"}, {"in"=>"formData", "name"=>"layoutId", "description"=>"The Layout Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Action:", "Overlay", "Layout"]}}, "/displaygroup/{displayGroupId}/action/command"=>{"post"=>{"summary"=>"Send Command", "description"=>"Send a predefined command to this Group of Displays", "operationId"=>"displayGroupActionCommand", "x-api-path-slug"=>"displaygroupdisplaygroupidactioncommand-post", "parameters"=>[{"in"=>"formData", "name"=>"commandId", "description"=>"The Command Id"}, {"in"=>"path", "name"=>"displayGroupId", "description"=>"The display group id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Command"]}}, "/displayprofile"=>{"get"=>{"summary"=>"Display Profile Search", "description"=>"Search this users Display Profiles", "operationId"=>"displayProfileSearch", "x-api-path-slug"=>"displayprofile-get", "parameters"=>[{"in"=>"formData", "name"=>"displayProfile", "description"=>"Filter by DisplayProfile Name"}, {"in"=>"formData", "name"=>"displayProfileId", "description"=>"Filter by DisplayProfile Id"}, {"in"=>"formData", "name"=>"type", "description"=>"Filter by DisplayProfile Type (windows|android)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Display", "Profile", "Search"]}, "post"=>{"summary"=>"Add Display Profile", "description"=>"Add a Display Profile", "operationId"=>"displayProfileAdd", "x-api-path-slug"=>"displayprofile-post", "parameters"=>[{"in"=>"formData", "name"=>"isDefault", "description"=>"Flag indicating if this is the default profile for the client type"}, {"in"=>"formData", "name"=>"name", "description"=>"The Name of the Display Profile"}, {"in"=>"formData", "name"=>"type", "description"=>"The Client Type this Profile will apply to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Display", "Profile"]}}, "/displayprofile/{displayProfileId}"=>{"put"=>{"summary"=>"Edit Display Profile", "description"=>"Edit a Display Profile", "operationId"=>"displayProfileEdit", "x-api-path-slug"=>"displayprofiledisplayprofileid-put", "parameters"=>[{"in"=>"path", "name"=>"displayProfileId", "description"=>"The Display Profile ID"}, {"in"=>"formData", "name"=>"isDefault", "description"=>"Flag indicating if this is the default profile for the client type"}, {"in"=>"formData", "name"=>"name", "description"=>"The Name of the Display Profile"}, {"in"=>"formData", "name"=>"type", "description"=>"The Client Type this Profile will apply to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Display", "Profile"]}, "delete"=>{"summary"=>"Delete Display Profile", "description"=>"Delete an existing Display Profile", "operationId"=>"displayProfileDelete", "x-api-path-slug"=>"displayprofiledisplayprofileid-delete", "parameters"=>[{"in"=>"path", "name"=>"displayProfileId", "description"=>"The Display Profile ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Display", "Profile"]}}, "/layout"=>{"get"=>{"summary"=>"Search Layouts", "description"=>"Search for Layouts viewable by this user", "operationId"=>"layoutSearch", "x-api-path-slug"=>"layout-get", "parameters"=>[{"in"=>"formData", "name"=>"embed", "description"=>"Embed related data such as regions, playlists, tags, etc"}, {"in"=>"formData", "name"=>"exactTags", "description"=>"A flag indicating whether to treat the tags filter as an exact match"}, {"in"=>"formData", "name"=>"layout", "description"=>"Filter by partial Layout name"}, {"in"=>"formData", "name"=>"layoutId", "description"=>"Filter by Layout Id"}, {"in"=>"formData", "name"=>"ownerUserGroupId", "description"=>"Filter by users in this UserGroupId"}, {"in"=>"formData", "name"=>"retired", "description"=>"Filter by retired flag"}, {"in"=>"formData", "name"=>"tags", "description"=>"Filter by Tags"}, {"in"=>"formData", "name"=>"userId", "description"=>"Filter by user Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Layouts"]}, "post"=>{"summary"=>"Add a Layout", "description"=>"Add a new Layout to the CMS", "operationId"=>"layoutAdd", "x-api-path-slug"=>"layout-post", "parameters"=>[{"in"=>"formData", "name"=>"description", "description"=>"The layout description"}, {"in"=>"formData", "name"=>"layoutId", "description"=>"If the Layout should be created with a Template, provide the ID, otherwise dont provide"}, {"in"=>"formData", "name"=>"name", "description"=>"The layout name"}, {"in"=>"formData", "name"=>"resolutionId", "description"=>"If a Template is not provided, provide the resolutionId for this Layout"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layout"]}}, "/layout/{layoutId}"=>{"put"=>{"summary"=>"Edit Layout", "description"=>"Edit a Layout", "operationId"=>"layoutEdit", "x-api-path-slug"=>"layoutlayoutid-put", "parameters"=>[{"in"=>"formData", "name"=>"backgroundColor", "description"=>"A HEX color to use as the background color of this Layout"}, {"in"=>"formData", "name"=>"backgroundImageId", "description"=>"A media ID to use as the background image for this Layout"}, {"in"=>"formData", "name"=>"backgroundzIndex", "description"=>"The Layer Number to use for the background"}, {"in"=>"formData", "name"=>"description", "description"=>"The Layout Description"}, {"in"=>"path", "name"=>"layoutId"}, {"in"=>"formData", "name"=>"name", "description"=>"The Layout Name"}, {"in"=>"formData", "name"=>"resolutionId", "description"=>"The Resolution ID to use on this Layout"}, {"in"=>"formData", "name"=>"retired", "description"=>"A flag indicating whether this Layout is retired"}, {"in"=>"formData", "name"=>"tags", "description"=>"A comma separated list of Tags"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Layout"]}, "delete"=>{"summary"=>"Delete Layout", "description"=>"Delete a Layout", "operationId"=>"layoutDelete", "x-api-path-slug"=>"layoutlayoutid-delete", "parameters"=>[{"in"=>"path", "name"=>"layoutId", "description"=>"The Layout ID to Delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layout"]}}, "/layout/retire/{layoutId}"=>{"put"=>{"summary"=>"Retire Layout", "description"=>"Retire a Layout so that it isn't available to Schedule. Existing Layouts will still be played", "operationId"=>"layoutRetire", "x-api-path-slug"=>"layoutretirelayoutid-put", "parameters"=>[{"in"=>"path", "name"=>"layoutId", "description"=>"The Layout ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retire", "Layout"]}}, "/layout/copy/{layoutId}"=>{"post"=>{"summary"=>"Copy Layout", "description"=>"Copy a Layout, providing a new name if applicable", "operationId"=>"layoutCopy", "x-api-path-slug"=>"layoutcopylayoutid-post", "parameters"=>[{"in"=>"formData", "name"=>"copyMediaFiles", "description"=>"Flag indicating whether to make new Copies of all Media Files assigned to the Layout being Copied"}, {"in"=>"formData", "name"=>"description", "description"=>"The Description for the new Layout"}, {"in"=>"path", "name"=>"layoutId", "description"=>"The Layout ID to Copy"}, {"in"=>"formData", "name"=>"name", "description"=>"The name for the new Layout"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Copy", "Layout"]}}, "/layout/{layoutId}/tag"=>{"post"=>{"summary"=>"Tag Layout", "description"=>"Tag a Layout with one or more tags", "operationId"=>"layoutTag", "x-api-path-slug"=>"layoutlayoutidtag-post", "parameters"=>[{"in"=>"path", "name"=>"layoutId", "description"=>"The Layout Id to Tag"}, {"in"=>"formData", "name"=>"tag", "description"=>"An array of tags"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tag", "Layout"]}}, "/layout/{layoutId}/untag"=>{"post"=>{"summary"=>"Untag Layout", "description"=>"Untag a Layout with one or more tags", "operationId"=>"layoutUntag", "x-api-path-slug"=>"layoutlayoutiduntag-post", "parameters"=>[{"in"=>"path", "name"=>"layoutId", "description"=>"The Layout Id to Untag"}, {"in"=>"formData", "name"=>"tag", "description"=>"An array of tags"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Untag", "Layout"]}}, "/layout/status/{layoutId}"=>{"get"=>{"summary"=>"Layout Status", "description"=>"Calculate the Layout status and return a Layout", "operationId"=>"layoutStatus", "x-api-path-slug"=>"layoutstatuslayoutid-get", "parameters"=>[{"in"=>"path", "name"=>"layoutId", "description"=>"The Layout Id to get the status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layout", "Status"]}}, "/library"=>{"get"=>{"summary"=>"Library Search", "description"=>"Search the Library for this user", "operationId"=>"librarySearch", "x-api-path-slug"=>"library-get", "parameters"=>[{"in"=>"formData", "name"=>"duration", "description"=>"Filter by Duration - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number"}, {"in"=>"formData", "name"=>"exactTags", "description"=>"A flag indicating whether to treat the tags filter as an exact match"}, {"in"=>"formData", "name"=>"fileSize", "description"=>"Filter by File Size - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number"}, {"in"=>"formData", "name"=>"media", "description"=>"Filter by Media Name"}, {"in"=>"formData", "name"=>"mediaId", "description"=>"Filter by Media Id"}, {"in"=>"formData", "name"=>"ownerId", "description"=>"Filter by Owner Id"}, {"in"=>"formData", "name"=>"ownerUserGroupId", "description"=>"Filter by users in this UserGroupId"}, {"in"=>"formData", "name"=>"retired", "description"=>"Filter by Retired"}, {"in"=>"formData", "name"=>"tags", "description"=>"Filter by Tags - comma seperated"}, {"in"=>"formData", "name"=>"type", "description"=>"Filter by Media Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Library", "Search"]}, "post"=>{"summary"=>"Add Media", "description"=>"Add Media to the Library", "operationId"=>"libraryAdd", "x-api-path-slug"=>"library-post", "parameters"=>[{"in"=>"formData", "name"=>"deleteOldRevisions", "description"=>"Flag (0 , 1), to either remove or leave the old file revisions (use with oldMediaId)"}, {"in"=>"formData", "name"=>"files", "description"=>"The Uploaded File"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Media Name"}, {"in"=>"formData", "name"=>"oldMediaId", "description"=>"Id of an existing media file which should be replaced with the new upload"}, {"in"=>"formData", "name"=>"updateInLayouts", "description"=>"Flag (0, 1), set to 1 to update this media in all layouts (use with oldMediaId)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media"]}}, "/library/{mediaId}"=>{"put"=>{"summary"=>"Edit Media", "description"=>"Edit a Media Item in the Library", "operationId"=>"libraryEdit", "x-api-path-slug"=>"librarymediaid-put", "parameters"=>[{"in"=>"formData", "name"=>"duration", "description"=>"The duration in seconds for this Media Item"}, {"in"=>"path", "name"=>"mediaId", "description"=>"The Media ID to Edit"}, {"in"=>"formData", "name"=>"name", "description"=>"Media Item Name"}, {"in"=>"formData", "name"=>"retired", "description"=>"Flag indicating if this media is retired"}, {"in"=>"formData", "name"=>"tags", "description"=>"Comma separated list of Tags"}, {"in"=>"formData", "name"=>"updateInLayouts", "description"=>"Flag indicating whether to update the duration in all Layouts the Media is assigned to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Media"]}, "delete"=>{"summary"=>"Delete Media", "description"=>"Delete Media from the Library", "operationId"=>"libraryDelete", "x-api-path-slug"=>"librarymediaid-delete", "parameters"=>[{"in"=>"formData", "name"=>"forceDelete", "description"=>"If the media item has been used should it be force removed from items that uses it?"}, {"in"=>"path", "name"=>"mediaId", "description"=>"The Media ID to Delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media"]}}, "/library/tidy"=>{"delete"=>{"summary"=>"Tidy Library", "description"=>"Routine tidy of the library, removing unused files.", "operationId"=>"libraryTidy", "x-api-path-slug"=>"librarytidy-delete", "parameters"=>[{"in"=>"formData", "name"=>"tidyGenericFiles", "description"=>"Also delete generic files?"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tidy", "Library"]}}, "/library/download/{mediaId}/{type}"=>{"get"=>{"summary"=>"Download Media", "description"=>"Download a Media file from the Library", "operationId"=>"libraryDownload", "x-api-path-slug"=>"librarydownloadmediaidtype-get", "parameters"=>[{"in"=>"path", "name"=>"mediaId", "description"=>"The Media ID to Download"}, {"in"=>"path", "name"=>"type", "description"=>"The Module Type of the Download"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Download", "Media"]}}, "/library/{mediaId}/tag"=>{"post"=>{"summary"=>"Tag Media", "description"=>"Tag a Media with one or more tags", "operationId"=>"mediaTag", "x-api-path-slug"=>"librarymediaidtag-post", "parameters"=>[{"in"=>"path", "name"=>"mediaId", "description"=>"The Media Id to Tag"}, {"in"=>"formData", "name"=>"tag", "description"=>"An array of tags"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tag", "Media"]}}, "/library/{mediaId}/untag"=>{"post"=>{"summary"=>"Untag Media", "description"=>"Untag a Media with one or more tags", "operationId"=>"mediaUntag", "x-api-path-slug"=>"librarymediaiduntag-post", "parameters"=>[{"in"=>"path", "name"=>"mediaId", "description"=>"The Media Id to Untag"}, {"in"=>"formData", "name"=>"tag", "description"=>"An array of tags"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Untag", "Media"]}}, "/library/usage/{mediaId}"=>{"get"=>{"summary"=>"Get Library Item Usage Report", "description"=>"Get the records for the library item usage report", "operationId"=>"libraryUsageReport", "x-api-path-slug"=>"libraryusagemediaid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Library", "Item", "Usage", "Report"]}}, "/library/usage/layouts/{mediaId}"=>{"get"=>{"summary"=>"Get Library Item Usage Report for Layouts", "description"=>"Get the records for the library item usage report for Layouts", "operationId"=>"libraryUsageLayoutsReport", "x-api-path-slug"=>"libraryusagelayoutsmediaid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Library", "Item", "Usage", "ReportLayouts"]}}, "/about"=>{"get"=>{"summary"=>"About", "description"=>"Information about this API, such as Version code, etc", "operationId"=>"about", "x-api-path-slug"=>"about-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["About"]}}, "/playlist/widget/{widgetId}"=>{"put"=>{"summary"=>"Edit a Widget", "description"=>"Edit a Widget, please refer to individual widget Add documentation for module specific parameters", "operationId"=>"WidgetEdit", "x-api-path-slug"=>"playlistwidgetwidgetid-put", "parameters"=>[{"in"=>"path", "name"=>"widgetId", "description"=>"The widget ID to edit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Widget"]}, "delete"=>{"summary"=>"Delete a Widget", "description"=>"Deleted a specified widget", "operationId"=>"WidgetDelete", "x-api-path-slug"=>"playlistwidgetwidgetid-delete", "parameters"=>[{"in"=>"path", "name"=>"widgetId", "description"=>"The widget ID to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Widget"]}}, "/playlist/widget/transition/{type}/{widgetId}"=>{"put"=>{"summary"=>"Adds In/Out transition", "description"=>"Adds In/Out transition to a specified widget", "operationId"=>"WidgetEditTransition", "x-api-path-slug"=>"playlistwidgettransitiontypewidgetid-put", "parameters"=>[{"in"=>"formData", "name"=>"transitionDirection", "description"=>"The direction for this transition, only appropriate for transitions that move, such as fly"}, {"in"=>"formData", "name"=>"transitionDuration", "description"=>"Duration of this transition in milliseconds"}, {"in"=>"formData", "name"=>"transitionType", "description"=>"Type of a transition, available Options: fly, fadeIn, fadeOut"}, {"in"=>"path", "name"=>"type", "description"=>"Transition type, available options: in, out"}, {"in"=>"path", "name"=>"widgetId", "description"=>"The widget ID to add the transition to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "In", "Out", "Transition"]}}, "/playlist/widget/{widgetId}/audio"=>{"put"=>{"summary"=>"Parameters for edting/adding audio file to a specific widget", "description"=>"Parameters for edting/adding audio file to a specific widget", "operationId"=>"WidgetAssignedAudioEdit", "x-api-path-slug"=>"playlistwidgetwidgetidaudio-put", "parameters"=>[{"in"=>"formData", "name"=>"loop", "description"=>"Flag (0, 1) Should the audio loop if it finishes before the widget has finished?"}, {"in"=>"formData", "name"=>"mediaId", "description"=>"Id of a audio file in CMS library you wish to add to a widget"}, {"in"=>"formData", "name"=>"volume", "description"=>"Volume percentage(0-100) for this audio to play at"}, {"in"=>"path", "name"=>"widgetId", "description"=>"Id of a widget to which you want to add audio or edit existing audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parametersedting", "Adding", "Audio", "File", "To", "Specific", "Widget"]}, "delete"=>{"summary"=>"Delete assigned audio widget", "description"=>"Delete assigned audio widget from specified widget ID", "operationId"=>"WidgetAudioDelete", "x-api-path-slug"=>"playlistwidgetwidgetidaudio-delete", "parameters"=>[{"in"=>"path", "name"=>"widgetId", "description"=>"Id of a widget from which you want to delete the audio from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assigned", "Audio", "Widget"]}}, "/notification"=>{"get"=>{"summary"=>"Notification Search", "description"=>"Search this users Notifications", "operationId"=>"notificationSearch", "x-api-path-slug"=>"notification-get", "parameters"=>[{"in"=>"formData", "name"=>"notificationId", "description"=>"Filter by Notification Id"}, {"in"=>"formData", "name"=>"subject", "description"=>"Filter by Subject"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification", "Search"]}, "post"=>{"summary"=>"Notification Add", "description"=>"Add a Notification", "operationId"=>"notificationAdd", "x-api-path-slug"=>"notification-post", "parameters"=>[{"in"=>"formData", "name"=>"body", "description"=>"The Body"}, {"in"=>"formData", "name"=>"displayGroupIds", "description"=>"The display group ids to assign this notification to"}, {"in"=>"formData", "name"=>"isEmail", "description"=>"Flag indicating whether this notification should be emailed"}, {"in"=>"formData", "name"=>"isInterrupt", "description"=>"Flag indication whether this notification should interrupt the web portal nativation/login"}, {"in"=>"formData", "name"=>"releaseDt", "description"=>"ISO date representing the release date for this notification"}, {"in"=>"formData", "name"=>"subject", "description"=>"The Subject"}, {"in"=>"formData", "name"=>"userGroupIds", "description"=>"The user group ids to assign to this notification"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification"]}}, "/notification/{notificationId}"=>{"put"=>{"summary"=>"Notification Edit", "description"=>"Edit a Notification", "operationId"=>"notificationEdit", "x-api-path-slug"=>"notificationnotificationid-put", "parameters"=>[{"in"=>"formData", "name"=>"body", "description"=>"The Body"}, {"in"=>"formData", "name"=>"displayGroupIds", "description"=>"The display group ids to assign this notification to"}, {"in"=>"formData", "name"=>"isEmail", "description"=>"Flag indicating whether this notification should be emailed"}, {"in"=>"formData", "name"=>"isInterrupt", "description"=>"Flag indication whether this notification should interrupt the web portal nativation/login"}, {"in"=>"path", "name"=>"notificationId", "description"=>"The NotificationId"}, {"in"=>"formData", "name"=>"releaseDt", "description"=>"ISO date representing the release date for this notification"}, {"in"=>"formData", "name"=>"subject", "description"=>"The Subject"}, {"in"=>"formData", "name"=>"userGroupIds", "description"=>"The user group ids to assign to this notification"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification", "Edit"]}, "delete"=>{"summary"=>"Delete Notification", "description"=>"Delete the provided notification", "operationId"=>"notificationDelete", "x-api-path-slug"=>"notificationnotificationid-delete", "parameters"=>[{"in"=>"path", "name"=>"notificationId", "description"=>"The Notification Id to Delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification"]}}, "/playlist/widget"=>{"get"=>{"summary"=>"Playlist Widget Search", "description"=>"Search widgets on a Playlist", "operationId"=>"playlistSearch", "x-api-path-slug"=>"playlistwidget-get", "parameters"=>[{"in"=>"formData", "name"=>"playlistId", "description"=>"The Playlist ID to Search"}, {"in"=>"formData", "name"=>"widgetId", "description"=>"The widget ID to Search"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlist", "Widget", "Search"]}}, "/playlist/library/assign/{playlistId}"=>{"post"=>{"summary"=>"Assign Library Items", "description"=>"Assign Media from the Library to this Playlist", "operationId"=>"playlistLibraryAssign", "x-api-path-slug"=>"playlistlibraryassignplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"duration", "description"=>"Optional duration for all Media in this assignment to use on the Widget"}, {"in"=>"formData", "name"=>"media", "description"=>"Array of Media IDs to assign"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The Playlist ID to assign to"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"Optional flag indicating whether to enable the useDuration field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assign", "Library", "Items"]}}, "/playlist/order/{playlistId}"=>{"post"=>{"summary"=>"Order Widgets", "description"=>"Set the order of widgets in the Playlist", "operationId"=>"playlistOrder", "x-api-path-slug"=>"playlistorderplaylistid-post", "parameters"=>[{"in"=>"path", "name"=>"playlistId", "description"=>"The Playlist ID to Order"}, {"in"=>"formData", "name"=>"widgets", "description"=>"Array of widgetIds and positions - all widgetIds present in the playlist need to be passed in the call with their positions"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order", "Widgets"]}}, "/region/{id}"=>{"put"=>{"summary"=>"Edit Region", "description"=>"Edit Region", "operationId"=>"regionEdit", "x-api-path-slug"=>"regionid-put", "parameters"=>[{"in"=>"formData", "name"=>"height", "description"=>"The Height"}, {"in"=>"path", "name"=>"id", "description"=>"The Region ID to Edit"}, {"in"=>"formData", "name"=>"left", "description"=>"The Left Coordinate"}, {"in"=>"formData", "name"=>"loop", "description"=>"Flag indicating whether this region should loop if there is only 1 media item in the timeline"}, {"in"=>"formData", "name"=>"top", "description"=>"The Top Coordinate"}, {"in"=>"formData", "name"=>"transitionDirection", "description"=>"The transition direction if required by the transition type"}, {"in"=>"formData", "name"=>"transitionDuration", "description"=>"The transition duration in milliseconds if required by the transition type"}, {"in"=>"formData", "name"=>"transitionType", "description"=>"The Transition Type"}, {"in"=>"formData", "name"=>"width", "description"=>"The Width, default 250"}, {"in"=>"formData", "name"=>"zIndex", "description"=>"The Layer for this Region"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Region"]}, "post"=>{"summary"=>"Add Region", "description"=>"Add a Region to a Layout", "operationId"=>"regionAdd", "x-api-path-slug"=>"regionid-post", "parameters"=>[{"in"=>"formData", "name"=>"height", "description"=>"The Height"}, {"in"=>"path", "name"=>"id", "description"=>"The Layout ID to add the Region to"}, {"in"=>"formData", "name"=>"left", "description"=>"The Left Coordinate"}, {"in"=>"formData", "name"=>"top", "description"=>"The Top Coordinate"}, {"in"=>"formData", "name"=>"width", "description"=>"The Width, default 250"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Region"]}}, "/region/{regionId}"=>{"delete"=>{"summary"=>"Region Delete", "description"=>"Delete an existing region", "operationId"=>"regionDelete", "x-api-path-slug"=>"regionregionid-delete", "parameters"=>[{"in"=>"path", "name"=>"regionId", "description"=>"The Region ID to Delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Region"]}}, "/region/position/all/{layoutId}"=>{"put"=>{"summary"=>"Position Regions", "description"=>"Position all regions for a Layout", "operationId"=>"regionPositionAll", "x-api-path-slug"=>"regionpositionalllayoutid-put", "parameters"=>[{"in"=>"path", "name"=>"layoutId", "description"=>"The Layout ID"}, {"in"=>"formData", "name"=>"regions", "description"=>"Array of regions and their new positions"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Position", "Regions"]}}, "/resolution"=>{"get"=>{"summary"=>"Resolution Search", "description"=>"Search Resolutions this user has access to", "operationId"=>"resolutionSearch", "x-api-path-slug"=>"resolution-get", "parameters"=>[{"in"=>"formData", "name"=>"enabled", "description"=>"Filter by Enabled"}, {"in"=>"formData", "name"=>"resolution", "description"=>"Filter by Resolution Name"}, {"in"=>"formData", "name"=>"resolutionId", "description"=>"Filter by Resolution Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resolution", "Search"]}, "post"=>{"summary"=>"Add Resolution", "description"=>"Add new Resolution", "operationId"=>"resolutionAdd", "x-api-path-slug"=>"resolution-post", "parameters"=>[{"in"=>"formData", "name"=>"height", "description"=>"The Display Height of the Resolution"}, {"in"=>"formData", "name"=>"resolution", "description"=>"A name for the Resolution"}, {"in"=>"formData", "name"=>"width", "description"=>"The Display Width of the Resolution"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resolution"]}}, "/resolution/{resolutionId}"=>{"put"=>{"summary"=>"Edit Resolution", "description"=>"Edit new Resolution", "operationId"=>"resolutionEdit", "x-api-path-slug"=>"resolutionresolutionid-put", "parameters"=>[{"in"=>"formData", "name"=>"height", "description"=>"The Display Height of the Resolution"}, {"in"=>"formData", "name"=>"resolution", "description"=>"A name for the Resolution"}, {"in"=>"path", "name"=>"resolutionId", "description"=>"The Resolution ID to Edit"}, {"in"=>"formData", "name"=>"width", "description"=>"The Display Width of the Resolution"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Resolution"]}, "delete"=>{"summary"=>"Delete Resolution", "description"=>"Delete Resolution", "operationId"=>"resolutionDelete", "x-api-path-slug"=>"resolutionresolutionid-delete", "parameters"=>[{"in"=>"path", "name"=>"resolutionId", "description"=>"The Resolution ID to Delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resolution"]}}, "/schedule/data/events"=>{"get"=>{"summary"=>"Generates the calendar that we draw events on", "description"=>"", "operationId"=>"scheduleCalendarData", "x-api-path-slug"=>"scheduledataevents-get", "parameters"=>[{"in"=>"formData", "name"=>"displayGroupIds", "description"=>"The DisplayGroupIds to return the schedule for"}, {"in"=>"formData", "name"=>"from", "description"=>"From Date Timestamp in Microseconds"}, {"in"=>"formData", "name"=>"to", "description"=>"To Date Timestamp in Microseconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generates", "Calendar", "That", "We", "Draw", "Events", "On"]}}, "/schedule/{displayGroupId}/events"=>{"get"=>{"summary"=>"Event List", "description"=>"", "operationId"=>"scheduleCalendarData", "x-api-path-slug"=>"scheduledisplaygroupidevents-get", "parameters"=>[{"in"=>"formData", "name"=>"date", "description"=>"Date in Y-m-d H:i:s"}, {"in"=>"path", "name"=>"displayGroupId", "description"=>"The DisplayGroupId to return the event list for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "List"]}}, "/schedule"=>{"post"=>{"summary"=>"Add Schedule Event", "description"=>"Add a new scheduled event for a Campaign/Layout to be shown on a Display Group/Display.", "operationId"=>"scheduleAdd", "x-api-path-slug"=>"schedule-post", "parameters"=>[{"in"=>"formData", "name"=>"campaignId", "description"=>"The Campaign ID to use for this Event"}, {"in"=>"formData", "name"=>"commandId", "description"=>"The Command ID to use for this Event"}, {"in"=>"formData", "name"=>"dayPartId", "description"=>"The Day Part for this event"}, {"in"=>"formData", "name"=>"displayGroupIds", "description"=>"The Display Group IDs for this event"}, {"in"=>"formData", "name"=>"displayOrder", "description"=>"The display order for this event"}, {"in"=>"formData", "name"=>"eventTypeId", "description"=>"The Event Type Id to use for this Event"}, {"in"=>"formData", "name"=>"fromDt", "description"=>"The from date for this event"}, {"in"=>"formData", "name"=>"isPriority", "description"=>"An integer indicating the priority of this event"}, {"in"=>"formData", "name"=>"recurrenceDetail", "description"=>"The interval for the recurrence"}, {"in"=>"formData", "name"=>"recurrenceRange", "description"=>"The end date for this events recurrence"}, {"in"=>"formData", "name"=>"recurrenceRepeatsOn", "description"=>"The days of the week that this event repeats - weekly only"}, {"in"=>"formData", "name"=>"recurrenceType", "description"=>"The type of recurrence to apply to this event"}, {"in"=>"formData", "name"=>"syncTimezone", "description"=>"Should this schedule be synced to the resulting Display timezone?"}, {"in"=>"formData", "name"=>"toDt", "description"=>"The to date for this event"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedule", "Event"]}}, "/schedule/{eventId}"=>{"put"=>{"summary"=>"Edit Schedule Event", "description"=>"Edit a scheduled event for a Campaign/Layout to be shown on a Display Group/Display.", "operationId"=>"scheduleEdit", "x-api-path-slug"=>"scheduleeventid-put", "parameters"=>[{"in"=>"formData", "name"=>"campaignId", "description"=>"The Campaign ID to use for this Event"}, {"in"=>"formData", "name"=>"commandId", "description"=>"The Command ID to use for this Event"}, {"in"=>"formData", "name"=>"dayPartId", "description"=>"The Day Part for this event"}, {"in"=>"formData", "name"=>"displayGroupIds", "description"=>"The Display Group IDs for this event"}, {"in"=>"formData", "name"=>"displayOrder", "description"=>"The display order for this event"}, {"in"=>"path", "name"=>"eventId", "description"=>"The Scheduled Event ID"}, {"in"=>"formData", "name"=>"eventTypeId", "description"=>"The Event Type Id to use for this Event"}, {"in"=>"formData", "name"=>"fromDt", "description"=>"The from date for this event"}, {"in"=>"formData", "name"=>"isPriority", "description"=>"An integer indicating the priority of this event"}, {"in"=>"formData", "name"=>"recurrenceDetail", "description"=>"The interval for the recurrence"}, {"in"=>"formData", "name"=>"recurrenceRange", "description"=>"The end date for this events recurrence"}, {"in"=>"formData", "name"=>"recurrenceRepeatsOn", "description"=>"The days of the week that this event repeats - weekly only"}, {"in"=>"formData", "name"=>"recurrenceType", "description"=>"The type of recurrence to apply to this event"}, {"in"=>"formData", "name"=>"syncTimezone", "description"=>"Should this schedule be synced to the resulting Display timezone?"}, {"in"=>"formData", "name"=>"toDt", "description"=>"The to date for this event"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Schedule", "Event"]}, "delete"=>{"summary"=>"Delete Event", "description"=>"Delete a Scheduled Event", "operationId"=>"scheduleDelete", "x-api-path-slug"=>"scheduleeventid-delete", "parameters"=>[{"in"=>"path", "name"=>"eventId", "description"=>"The Scheduled Event ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/stats"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"statsSearch", "x-api-path-slug"=>"stats-get", "parameters"=>[{"in"=>"formData", "name"=>"displayId", "description"=>"An optional display Id to filter"}, {"in"=>"formData", "name"=>"fromDt", "description"=>"The start date for the filter"}, {"in"=>"formData", "name"=>"layoutId", "description"=>"An optional array of layout Id to filter"}, {"in"=>"formData", "name"=>"mediaId", "description"=>"An optional array of media Id to filter"}, {"in"=>"formData", "name"=>"toDt", "description"=>"The end date for the filter"}, {"in"=>"formData", "name"=>"type", "description"=>"The type of stat to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/template"=>{"get"=>{"summary"=>"Template Search", "description"=>"Search templates this user has access to", "operationId"=>"templateSearch", "x-api-path-slug"=>"template-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Template", "Search"]}}, "/template/{layoutId}"=>{"post"=>{"summary"=>"Add a template from a Layout", "description"=>"Use the provided layout as a base for a new template", "operationId"=>"template.add.from.layout", "x-api-path-slug"=>"templatelayoutid-post", "parameters"=>[{"in"=>"formData", "name"=>"description", "description"=>"A description of the Template"}, {"in"=>"formData", "name"=>"includeWidgets", "description"=>"Flag indicating whether to include the widgets in the Template"}, {"in"=>"path", "name"=>"layoutId", "description"=>"The Layout ID"}, {"in"=>"formData", "name"=>"name", "description"=>"The Template Name"}, {"in"=>"formData", "name"=>"tags", "description"=>"Comma separated list of Tags for the template"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Template", "From", "Layout"]}}, "/user/me"=>{"get"=>{"summary"=>"Get Me", "description"=>"Get my details", "operationId"=>"userMe", "x-api-path-slug"=>"userme-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me"]}}, "/user"=>{"get"=>{"summary"=>"User Search", "description"=>"Search users", "operationId"=>"userSearch", "x-api-path-slug"=>"user-get", "parameters"=>[{"in"=>"formData", "name"=>"retired", "description"=>"Filter by Retired"}, {"in"=>"formData", "name"=>"userId", "description"=>"Filter by User Id"}, {"in"=>"formData", "name"=>"userName", "description"=>"Filter by User Name"}, {"in"=>"formData", "name"=>"userTypeId", "description"=>"Filter by UserType Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Search"]}, "post"=>{"summary"=>"Add User", "description"=>"Add a new User", "operationId"=>"userAdd", "x-api-path-slug"=>"user-post", "parameters"=>[{"in"=>"formData", "name"=>"email", "description"=>"The user email address"}, {"in"=>"formData", "name"=>"firstName", "description"=>"The users first name"}, {"in"=>"formData", "name"=>"groupId", "description"=>"The inital user group for this User"}, {"in"=>"formData", "name"=>"homePageId", "description"=>"The homepage to use for this User"}, {"in"=>"formData", "name"=>"lastName", "description"=>"The users last name"}, {"in"=>"formData", "name"=>"libraryQuota", "description"=>"The users library quota in kilobytes"}, {"in"=>"formData", "name"=>"password", "description"=>"The users password"}, {"in"=>"formData", "name"=>"phone", "description"=>"The users phone number"}, {"in"=>"formData", "name"=>"ref1", "description"=>"Reference 1"}, {"in"=>"formData", "name"=>"ref2", "description"=>"Reference 2"}, {"in"=>"formData", "name"=>"ref3", "description"=>"Reference 3"}, {"in"=>"formData", "name"=>"ref4", "description"=>"Reference 4"}, {"in"=>"formData", "name"=>"ref5", "description"=>"Reference 5"}, {"in"=>"formData", "name"=>"userName", "description"=>"The User Name"}, {"in"=>"formData", "name"=>"userTypeId", "description"=>"The user type ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/user/permissions/{entity}/{objectId}"=>{"get"=>{"summary"=>"Permission Data", "description"=>"Permission data for the Entity and Object Provided.", "operationId"=>"userPermissionsSearch", "x-api-path-slug"=>"userpermissionsentityobjectid-get", "parameters"=>[{"in"=>"path", "name"=>"entity", "description"=>"The Entity"}, {"in"=>"path", "name"=>"objectId", "description"=>"The ID of the Object to return permissions for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission", "Data"]}, "post"=>{"summary"=>"Permission Set", "description"=>"Set Permissions to users/groups for the provided entity.", "operationId"=>"userPermissionsSet", "x-api-path-slug"=>"userpermissionsentityobjectid-post", "parameters"=>[{"in"=>"path", "name"=>"entity", "description"=>"The Entity"}, {"in"=>"formData", "name"=>"groupIds", "description"=>"Array of permissions with groupId as the key"}, {"in"=>"path", "name"=>"objectId", "description"=>"The ID of the Object to set permissions on"}, {"in"=>"formData", "name"=>"ownerId", "description"=>"Change the owner of this item"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission", "Set"]}}, "/user/pref"=>{"get"=>{"summary"=>"Retrieve User Preferences", "description"=>"User preferences for non-state information, such as Layout designer zoom levels", "operationId"=>"userPrefGet", "x-api-path-slug"=>"userpref-get", "parameters"=>[{"in"=>"formData", "name"=>"preference", "description"=>"An optional preference"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "User", "Preferences"]}, "post"=>{"summary"=>"Save User Preferences", "description"=>"Save User preferences for non-state information, such as Layout designer zoom levels", "operationId"=>"userPrefEdit", "x-api-path-slug"=>"userpref-post", "parameters"=>[{"in"=>"body", "name"=>"preference", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Save", "User", "Preferences"]}}, "/usergroup"=>{"get"=>{"summary"=>"UserGroup Search", "description"=>"Search User Groups", "operationId"=>"userGroupSearch", "x-api-path-slug"=>"usergroup-get", "parameters"=>[{"in"=>"formData", "name"=>"userGroup", "description"=>"Filter by UserGroup Name"}, {"in"=>"formData", "name"=>"userGroupId", "description"=>"Filter by UserGroup Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["UserGroup", "Search"]}}, "/group/{userGroupId}/copy"=>{"post"=>{"summary"=>"Copy User Group", "description"=>"Copy an user group, optionally copying the group members", "operationId"=>"userGroupCopy", "x-api-path-slug"=>"groupusergroupidcopy-post", "parameters"=>[{"in"=>"formData", "name"=>"copyMembers", "description"=>"Flag indicating whether to copy group members"}, {"in"=>"formData", "name"=>"group", "description"=>"The Group Name"}, {"in"=>"path", "name"=>"userGroupId", "description"=>"The User Group ID to Copy"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Copy", "User", "Group"]}}, "/playlist/widget/audio/{playlistId}"=>{"post"=>{"summary"=>"Parameters for editing existing audio widget on a layout", "description"=>"Parameters for editing existing audio widget on a layout, for adding new audio, please refer to POST /library documentation", "operationId"=>"WidgetAudioEdit", "x-api-path-slug"=>"playlistwidgetaudioplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"duration", "description"=>"Edit Only - The Widget Duration"}, {"in"=>"formData", "name"=>"loop", "description"=>"Edit only - Flag (0, 1) Should the audio loop (only for duration > 0 )?"}, {"in"=>"formData", "name"=>"mute", "description"=>"Edit only - Flag (0, 1) Should the audio be muted?"}, {"in"=>"formData", "name"=>"name", "description"=>"Edit Only - The Widget name"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"Edit Only - (0, 1) Select 1 only if you will provide duration parameter as well"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parametersediting", "Existing", "Audio", "Widget", "On", "Layout"]}}, "/playlist/widget/chart/{playlistId}"=>{"post"=>{"summary"=>"Add a Chart Widget", "description"=>"Add a new Chart Widget to the specified playlist", "operationId"=>"WidgetChartAdd", "x-api-path-slug"=>"playlistwidgetchartplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"backgroundColor", "description"=>"EDIT Only - Background Color"}, {"in"=>"formData", "name"=>"columnType", "description"=>"EDIT only - Array of Column Types (x-axis, y-axis, series-identifier) to assign"}, {"in"=>"formData", "name"=>"dataSetColumnId", "description"=>"EDIT only - Array of dataSetColumn IDs to assign"}, {"in"=>"formData", "name"=>"dataSetId", "description"=>"Create Chart Widget using provided dataSetId of an existing dataSet"}, {"in"=>"formData", "name"=>"duration", "description"=>"EDIT Only - The Chart Duration"}, {"in"=>"formData", "name"=>"filter", "description"=>"EDIT Only - SQL clause for filter this dataSet"}, {"in"=>"formData", "name"=>"fontColor", "description"=>"EDIT Only - Font Color"}, {"in"=>"formData", "name"=>"fontSize", "description"=>"EDIT Only - Font Size"}, {"in"=>"formData", "name"=>"graphType", "description"=>"EDIT only - Chart Type"}, {"in"=>"formData", "name"=>"legendPosition", "description"=>"EDIT Only - Where should the Legend be Shown (top, left, right, bottom)"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"formData", "name"=>"ordering", "description"=>"EDIT Only - SQL clause for how this dataSet should be ordered"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Widget to"}, {"in"=>"formData", "name"=>"showLegend", "description"=>"EDIT Only - Should the Legend be Shown"}, {"in"=>"formData", "name"=>"startYAtZero", "description"=>"EDIT Only - Start the Y-Axis at 0"}, {"in"=>"formData", "name"=>"title", "description"=>"EDIT Only - Chart title"}, {"in"=>"formData", "name"=>"updateInterval", "description"=>"EDIT Only - Update interval in minutes"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"Edit Only - (0, 1) Select 1 only if you will provide duration parameter as well"}, {"in"=>"formData", "name"=>"useFilteringClause", "description"=>"EDIT Only - flag (0,1) Use advanced filter clause - set to 1 if filter is provided"}, {"in"=>"formData", "name"=>"useOrderingClause", "description"=>"EDIT Only - flag (0,1) Use advanced order clause - set to 1 if ordering is provided"}, {"in"=>"formData", "name"=>"x-axis-label", "description"=>"EDIT Only - Chart x-axis label"}, {"in"=>"formData", "name"=>"y-axis-label", "description"=>"EDIT Only - Chart y-axis label"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chart", "Widget"]}}, "/playlist/widget/clock/{playlistId}"=>{"post"=>{"summary"=>"Add a Clock Widget", "description"=>"Add a new Clock Widget to the specified playlist", "operationId"=>"WidgetClockAdd", "x-api-path-slug"=>"playlistwidgetclockplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"ClockFace", "description"=>"For Flip Clock, supported options: TwelveHourClock TwentyFourHourClock HourlyCounter MinuteCounter DailyCounter"}, {"in"=>"formData", "name"=>"clockTypeId", "description"=>"Type of a clock widget 1-Analogue, 2-Digital, 3-Flip clock"}, {"in"=>"formData", "name"=>"duration", "description"=>"The Widget Duration"}, {"in"=>"formData", "name"=>"format", "description"=>"For digital clock, format in which the time should be displayed example [HH:mm]"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"formData", "name"=>"offset", "description"=>"The offset in minutes that should be applied to the current time, if a counter is selected then date/time to run from in the format Y-m-d H:i:s"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Clock widget to"}, {"in"=>"formData", "name"=>"showSeconds", "description"=>"For Flip Clock, should the clock show seconds or not"}, {"in"=>"formData", "name"=>"themeId", "description"=>"Flag (0 , 1) for Analogue clock the light and dark theme"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"(0, 1) Select 1 only if you will provide duration parameter as well"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clock", "Widget"]}}, "/playlist/widget/currencies/{playlistId}"=>{"post"=>{"summary"=>"Add a Currencies Widget", "description"=>"Add a new Currencies Widget to the specified playlist", "operationId"=>"WidgetCurrenciesAdd", "x-api-path-slug"=>"playlistwidgetcurrenciesplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"backgroundColor", "description"=>"A HEX color to use as the background color of this widget"}, {"in"=>"formData", "name"=>"base", "description"=>"The base currency"}, {"in"=>"formData", "name"=>"dateFormat", "description"=>"The format to apply to all dates returned by he widget"}, {"in"=>"formData", "name"=>"duration", "description"=>"Widget Duration"}, {"in"=>"formData", "name"=>"durationIsPerPage", "description"=>"A flag (0, 1), The duration specified is per page/item, otherwise the widget duration is divided between the number of pages/items"}, {"in"=>"formData", "name"=>"effect", "description"=>"Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind"}, {"in"=>"formData", "name"=>"items", "description"=>"Items wanted"}, {"in"=>"formData", "name"=>"itemtemplate", "description"=>"Template for each item, replaces [itemsTemplate] in main template, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"javaScript", "description"=>"Optional JavaScript, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"mainTemplate", "description"=>"Main template, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"maxItemsPerPage", "description"=>"This is the intended number of items on each page"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"formData", "name"=>"noRecordsMessage", "description"=>"A message to display when there are no records returned by the search query"}, {"in"=>"formData", "name"=>"overrideTemplate", "description"=>"flag (0, 1) set to 0 and use templateId or set to 1 and provide whole template in the next parameters"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Currencies widget"}, {"in"=>"formData", "name"=>"reverseConversion", "description"=>"(0, 1) Select 1 if youd like your base currency to be used as the comparison currency youve entered"}, {"in"=>"formData", "name"=>"speed", "description"=>"The transition speed of the selected effect in milliseconds (1000 = normal)"}, {"in"=>"formData", "name"=>"styleSheet", "description"=>"Optional StyleSheet Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"templateId", "description"=>"Use pre-configured templates, available options: currencies1, currencies2"}, {"in"=>"formData", "name"=>"updateInterval", "description"=>"Update interval in minutes, should be kept as high as possible, if data change once per hour, this should be set to 60"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"(0, 1) Select 1 only if you will provide duration parameter as well"}, {"in"=>"formData", "name"=>"widgetOriginalHeight", "description"=>"This is the intended Height of the template and is used to scale the Widget within its region when the template is applied, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"widgetOriginalWidth", "description"=>"This is the intended Width of the template and is used to scale the Widget within its region when the template is applied, Pass only with overrideTemplate set to 1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Currencies", "Widget"]}}, "/playlist/widget/dataSetView/{playlistId}"=>{"post"=>{"summary"=>"Add a dataSetView Widget", "description"=>"Add a new dataSetView Widget to the specified playlist", "operationId"=>"WidgetdataSetViewAdd", "x-api-path-slug"=>"playlistwidgetdatasetviewplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"dataSetColumnId", "description"=>"EDIT only - Array of dataSetColumn IDs to assign"}, {"in"=>"formData", "name"=>"dataSetId", "description"=>"Create dataSetView Widget using provided dataSetId of an existing dataSet"}, {"in"=>"formData", "name"=>"duration", "description"=>"EDIT Only - The dataSetView Duration"}, {"in"=>"formData", "name"=>"filter", "description"=>"EDIT Only - SQL clause for filter this dataSet"}, {"in"=>"formData", "name"=>"lowerLimit", "description"=>"EDIT Only - Lower low limit for this dataSet, 0 for nor limit"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"formData", "name"=>"noDataMessage", "description"=>"EDIT Only - A message to display when no data is returned from the source"}, {"in"=>"formData", "name"=>"ordering", "description"=>"EDIT Only - SQL clause for how this dataSet should be ordered"}, {"in"=>"formData", "name"=>"overrideTemplate", "description"=>"EDIT Only - flag (0, 1) override template checkbox"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Widget to"}, {"in"=>"formData", "name"=>"rowsPerPage", "description"=>"EDIT Only - Number of rows per page, 0 for no pages"}, {"in"=>"formData", "name"=>"showHeadings", "description"=>"EDIT Only - Should the table show Heading? (0,1)"}, {"in"=>"formData", "name"=>"templateId", "description"=>"EDIT Only - Template youd like to apply, options available: empty, light-green"}, {"in"=>"formData", "name"=>"updateInterval", "description"=>"EDIT Only - Update interval in minutes"}, {"in"=>"formData", "name"=>"upperLimit", "description"=>"EDIT Only - Upper low limit for this dataSet, 0 for nor limit"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"Edit Only - (0, 1) Select 1 only if you will provide duration parameter as well"}, {"in"=>"formData", "name"=>"useFilteringClause", "description"=>"EDIT Only - flag (0,1) Use advanced filter clause - set to 1 if filter is provided"}, {"in"=>"formData", "name"=>"useOrderingClause", "description"=>"EDIT Only - flag (0,1) Use advanced order clause - set to 1 if ordering is provided"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DataSetView", "Widget"]}}, "/playlist/widget/embedded/{playlistId}"=>{"post"=>{"summary"=>"Add a Embedded Widget", "description"=>"Add a new Embedded Widget to the specified playlist", "operationId"=>"WidgetEmbeddedAdd", "x-api-path-slug"=>"playlistwidgetembeddedplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"duration", "description"=>"The Widget Duration"}, {"in"=>"formData", "name"=>"embedHtml", "description"=>"HTML to embed"}, {"in"=>"formData", "name"=>"embedScript", "description"=>"HEAD content to Embed (including script tags)"}, {"in"=>"formData", "name"=>"embedStyle", "description"=>"Custom Style Sheets (CSS)"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add an Embedded Widget"}, {"in"=>"formData", "name"=>"scaleContent", "description"=>"Flag (0,1) - Should the embedded content be scaled along with the layout?"}, {"in"=>"formData", "name"=>"transparency", "description"=>"Flag (0,1) - Should the HTML be shown with transparent background? - not available on Windows Clients"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"(0, 1) Select 1 only if you will provide duration parameter as well"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Embedded", "Widget"]}}, "/playlist/widget/finance/{playlistId}"=>{"post"=>{"summary"=>"Add a Finance Widget", "description"=>"Add a new Finance Widget to the specified playlist", "operationId"=>"WidgetFinanceAdd", "x-api-path-slug"=>"playlistwidgetfinanceplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"backgroundColor", "description"=>"A HEX color to use as the background color of this widget"}, {"in"=>"formData", "name"=>"dateFormat", "description"=>"The format to apply to all dates returned by he widget"}, {"in"=>"formData", "name"=>"duration", "description"=>"Widget Duration"}, {"in"=>"formData", "name"=>"durationIsPerItem", "description"=>"A flag (0, 1), The duration specified is per item, otherwise the widget duration is divided between the number of items"}, {"in"=>"formData", "name"=>"effect", "description"=>"Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind, marqueeUp, marqueeDown, marqueeRight, marqueeLeft"}, {"in"=>"formData", "name"=>"item", "description"=>"Items wanted, can be comma separated (example EURUSD, GBPUSD), pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"javaScript", "description"=>"Optional JavaScript, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"formData", "name"=>"noRecordsMessage", "description"=>"A message to display when there are no records returned by the search query"}, {"in"=>"formData", "name"=>"overrideTemplate", "description"=>"flag (0, 1) set to 0 and use templateId or set to 1 and provide whole template in the next parameters"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Finance widget"}, {"in"=>"formData", "name"=>"resultIdentifier", "description"=>"The name of the result identifier returned by the YQL, pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"speed", "description"=>"The transition speed of the selected effect in milliseconds (1000 = normal) or the Marquee speed in a low to high scale (normal = 1)"}, {"in"=>"formData", "name"=>"styleSheet", "description"=>"Optional StyleSheet Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"template", "description"=>"Main template, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"templateId", "description"=>"Use pre-configured templates, available options: currency-simple, stock-simple"}, {"in"=>"formData", "name"=>"updateInterval", "description"=>"Update interval in minutes, should be kept as high as possible, if data change once per hour, this should be set to 60"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"(0, 1) Select 1 only if you will provide duration parameter as well"}, {"in"=>"formData", "name"=>"yql", "description"=>"The YQL query to use for data, pass only with overrideTemplate set to 1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Finance", "Widget"]}}, "/playlist/widget/forecastIo/{playlistId}"=>{"post"=>{"summary"=>"Add a Weather Widget", "description"=>"Add a new Weather Widget to the specified playlist", "operationId"=>"WidgetWeatherAdd", "x-api-path-slug"=>"playlistwidgetforecastioplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"currentTemplate", "description"=>"Current template, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"dailyTemplate", "description"=>"Replaces [dailyForecast] in main template, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"dayConditionsOnly", "description"=>"Flag (0, 1) Would you like to only show the Daytime weather conditions"}, {"in"=>"formData", "name"=>"duration", "description"=>"Widget Duration"}, {"in"=>"formData", "name"=>"lang", "description"=>"Language youd like to use, supported languages ar, az, be, bs, cs, de, en, el, es, fr, hr, hu, id, it, is, kw, nb, nl, pl, pt, ru, sk, sr, sv, tet, tr, uk, x-pig-latin, zh, zh-tw"}, {"in"=>"formData", "name"=>"latitude", "description"=>"The latitude for this weather widget, only pass if useDisplayLocation set to 0"}, {"in"=>"formData", "name"=>"longitude", "description"=>"The longitude for this weather widget, only pass if useDisplayLocation set to 0"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"formData", "name"=>"overrideTemplate", "description"=>"flag (0, 1) set to 0 and use templateId or set to 1 and provide whole template in the next parameters"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Weather widget"}, {"in"=>"formData", "name"=>"styleSheet", "description"=>"Optional StyleSheet, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"templateId", "description"=>"Use pre-configured templates, available options: weather-module0-5day, weather-module0-singleday, weather-module0-singleday2, weather-module1l, weather-module1p, weather-module2l, weather-module2p, weather-module3l, weather-module3p, weather-module4l, weather-module4p, weather-module5l, weather-module6v, weather-module6h"}, {"in"=>"formData", "name"=>"units", "description"=>"Units you would like to use, available options: auto, ca, si, uk2, us"}, {"in"=>"formData", "name"=>"updateInterval", "description"=>"Update interval in minutes, should be kept as high as possible, if data change once per hour, this should be set to 60"}, {"in"=>"formData", "name"=>"useDisplayLocation", "description"=>"Flag (0, 1) Use the location configured on display"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"(0, 1) Select 1 only if you will provide duration parameter as well"}, {"in"=>"formData", "name"=>"widgetOriginalHeight", "description"=>"This is the intended Height of the template and is used to scale the Widget within its region when the template is applied, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"widgetOriginalWidth", "description"=>"This is the intended Width of the template and is used to scale the Widget within its region when the template is applied, Pass only with overrideTemplate set to 1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Widget"]}}, "/playlist/widget/googleTraffic/{playlistId}"=>{"post"=>{"summary"=>"Add a Google Traffic Widget", "description"=>"Add a new Google traffic Widget to the specified playlist", "operationId"=>"WidgetGoogleTrafficAdd", "x-api-path-slug"=>"playlistwidgetgoogletrafficplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"duration", "description"=>"The Widget Duration"}, {"in"=>"formData", "name"=>"latitude", "description"=>"The latitude for this weather widget, only pass if useDisplayLocation set to 0"}, {"in"=>"formData", "name"=>"longitude", "description"=>"The longitude for this weather widget, only pass if useDisplayLocation set to 0"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Widget"}, {"in"=>"formData", "name"=>"useDisplayLocation", "description"=>"Flag (0, 1) Use the location configured on display"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"(0, 1) Select 1 only if you will provide duration parameter as well"}, {"in"=>"formData", "name"=>"zoom", "description"=>"How far should the map be zoomed in? The higher the number the closer the zoom, 1 represents entire globe"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Google", "Traffic", "Widget"]}}, "/playlist/widget/hls/{playlistId}"=>{"post"=>{"summary"=>"Add a HLS Widget", "description"=>"Add a new HLS Widget to the specified playlist", "operationId"=>"WidgetHlsAdd", "x-api-path-slug"=>"playlistwidgethlsplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"duration", "description"=>"The Widget Duration"}, {"in"=>"formData", "name"=>"mute", "description"=>"Flag (0, 1) Should the video be muted?"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Widget to"}, {"in"=>"formData", "name"=>"transparency", "description"=>"Flag (0, 1), This causes some android devices to switch to a hardware accelerated web view"}, {"in"=>"formData", "name"=>"uri", "description"=>"URL to HLS video stream"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"Edit Only - (0, 1) Select only if you will provide duration parameter as well"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["HLS", "Widget"]}}, "/playlist/widget/image/{playlistId}"=>{"post"=>{"summary"=>"Parameters for editing existing image on a layout", "description"=>"Parameters for editing existing image on a layout, for adding new images, please refer to POST /library documentation", "operationId"=>"WidgetImageEdit", "x-api-path-slug"=>"playlistwidgetimageplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"alignId", "description"=>"Edit only - Horizontal alignment - left, center, bottom"}, {"in"=>"formData", "name"=>"duration", "description"=>"Edit Only - The Widget Duration"}, {"in"=>"formData", "name"=>"name", "description"=>"Edit only - Optional Widget Name"}, {"in"=>"formData", "name"=>"scaleTypeId", "description"=>"Edit only - Select scale type available options: center, stretch"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"Edit only (0, 1) Select 1 only if you will provide duration parameter as well"}, {"in"=>"formData", "name"=>"valignId", "description"=>"Edit only - Vertical alignment - top, middle, bottom"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parametersediting", "Existing", "Image", "On", "Layout"]}}, "/playlist/widget/localVideo/{playlistId}"=>{"post"=>{"summary"=>"Add a Local Video Widget", "description"=>"Add a new Local Video Widget to the specified playlist", "operationId"=>"WidgetLocalVideoAdd", "x-api-path-slug"=>"playlistwidgetlocalvideoplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"duration", "description"=>"The Widget Duration"}, {"in"=>"formData", "name"=>"mute", "description"=>"Flag (0, 1) Should the video be muted?"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Widget to"}, {"in"=>"formData", "name"=>"scaleTypeId", "description"=>"How should the video be scaled, available options: aspect, stretch"}, {"in"=>"formData", "name"=>"uri", "description"=>"A local file path or URL to the video"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"(0, 1) Select 1 only if you will provide duration parameter as well"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Local", "Video", "Widget"]}}, "/playlist/widget/notificationview/{playlistId}"=>{"post"=>{"summary"=>"Add a Notification Widget", "description"=>"Add a new Notification Widget to the specified playlist", "operationId"=>"WidgetNotificationAdd", "x-api-path-slug"=>"playlistwidgetnotificationviewplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"age", "description"=>"The maximum notification age in minutes - 0 for all"}, {"in"=>"formData", "name"=>"duration", "description"=>"The Widget Duration"}, {"in"=>"formData", "name"=>"durationIsPerItem", "description"=>"A flag (0, 1), The duration specified is per page/item, otherwise the widget duration is divided between the number of pages/items"}, {"in"=>"formData", "name"=>"effect", "description"=>"Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind"}, {"in"=>"formData", "name"=>"embedStyle", "description"=>"Custom Style Sheets (CSS)"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"formData", "name"=>"noDataMessage", "description"=>"Message to show when no notifications are available"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add an Notification Widget"}, {"in"=>"formData", "name"=>"speed", "description"=>"The transition speed of the selected effect in milliseconds (1000 = normal)"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"(0, 1) Select 1 only if you will provide duration parameter as well"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification", "Widget"]}}, "/playlist/widget/pdf/{playlistId}"=>{"post"=>{"summary"=>"Parameters for editing existing pdf on a layout", "description"=>"Parameters for editing existing pdf on a layout, for adding new files, please refer to POST /library documentation", "operationId"=>"WidgetPdfEdit", "x-api-path-slug"=>"playlistwidgetpdfplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"duration", "description"=>"Edit Only - The Widget Duration"}, {"in"=>"formData", "name"=>"name", "description"=>"Edit only - Optional Widget Name"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"(0, 1) Select 1 only if you will provide duration parameter as well"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parametersediting", "Existing", "Pdf", "On", "Layout"]}}, "/playlist/widget/shellCommand/{playlistId}"=>{"post"=>{"summary"=>"Add a Shell Command Widget", "description"=>"Add a new Shell Command Widget to the specified playlist", "operationId"=>"WidgetShellCommandAdd", "x-api-path-slug"=>"playlistwidgetshellcommandplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"commandCode", "description"=>"Enter a reference code for exiting command in CMS"}, {"in"=>"formData", "name"=>"duration", "description"=>"The Widget Duration"}, {"in"=>"formData", "name"=>"launchThroughCmd", "description"=>"flag (0,1) Windows only, Should the player launch this command through the windows command line (cmd"}, {"in"=>"formData", "name"=>"linuxCommand", "description"=>"Enter a Android / Linux command line compatible command"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Widget to"}, {"in"=>"formData", "name"=>"terminateCommand", "description"=>"flag (0,1) Should the player forcefully terminate the command after the duration specified, 0 to let the command terminate naturally"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"(0, 1) Select 1 only if you will provide duration parameter as well"}, {"in"=>"formData", "name"=>"useTaskkill", "description"=>"flag (0,1) Windows only, should the player use taskkill to terminate commands"}, {"in"=>"formData", "name"=>"windowsCommand", "description"=>"Enter a Windows command line compatible command"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shell", "Command", "Widget"]}}, "/playlist/widget/stocks/{playlistId}"=>{"post"=>{"summary"=>"Add a Stocks Widget", "description"=>"Add a new Stocks Widget to the specified playlist", "operationId"=>"WidgetStocksAdd", "x-api-path-slug"=>"playlistwidgetstocksplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"backgroundColor", "description"=>"A HEX color to use as the background color of this widget"}, {"in"=>"formData", "name"=>"dateFormat", "description"=>"The format to apply to all dates returned by he widget"}, {"in"=>"formData", "name"=>"duration", "description"=>"Widget Duration"}, {"in"=>"formData", "name"=>"durationIsPerPage", "description"=>"A flag (0, 1), The duration specified is per page, otherwise the widget duration is divided between the number of pages/items"}, {"in"=>"formData", "name"=>"effect", "description"=>"Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind"}, {"in"=>"formData", "name"=>"items", "description"=>"Items wanted, can be comma separated"}, {"in"=>"formData", "name"=>"itemtemplate", "description"=>"Template for each item, replaces [itemsTemplate] in main template, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"javaScript", "description"=>"Optional JavaScript, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"mainTemplate", "description"=>"Main template, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"maxItemsPerPage", "description"=>"This is the intended number of items on each page"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"formData", "name"=>"noRecordsMessage", "description"=>"A message to display when there are no records returned by the search query"}, {"in"=>"formData", "name"=>"overrideTemplate", "description"=>"flag (0, 1) set to 0 and use templateId or set to 1 and provide whole template in the next parameters"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Stocks widget"}, {"in"=>"formData", "name"=>"speed", "description"=>"The transition speed of the selected effect in milliseconds (1000 = normal)"}, {"in"=>"formData", "name"=>"styleSheet", "description"=>"Optional StyleSheet Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"templateId", "description"=>"Use pre-configured templates, available options: stocks1, stocks2"}, {"in"=>"formData", "name"=>"updateInterval", "description"=>"Update interval in minutes, should be kept as high as possible, if data change once per hour, this should be set to 60"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"(0, 1) Select 1 only if you will provide duration parameter as well"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stocks", "Widget"]}}, "/playlist/widget/text/{playlistId}"=>{"post"=>{"summary"=>"Add a Text Widget", "description"=>"Add a new Text Widget to the specified playlist", "operationId"=>"WidgetTextAdd", "x-api-path-slug"=>"playlistwidgettextplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"backgroundcolor", "description"=>"A HEX color to use as the background color of this widget"}, {"in"=>"formData", "name"=>"duration", "description"=>"The Widget Duration"}, {"in"=>"formData", "name"=>"effect", "description"=>"Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind, marqueeUp, marqueeDown, marqueeRight, marqueeLeft"}, {"in"=>"formData", "name"=>"javaScript", "description"=>"Optional JavaScript"}, {"in"=>"formData", "name"=>"marqueeInlineSelector", "description"=>"The selector to use for stacking marquee items in a line when scrolling left/right"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Widget to"}, {"in"=>"formData", "name"=>"speed", "description"=>"The transition speed of the selected effect in milliseconds (1000 = normal) or the Marquee speed in a low to high scale (normal = 1)"}, {"in"=>"formData", "name"=>"text", "description"=>"Enter the text to display"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"(0, 1) Select 1 only if you will provide duration parameter as well"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Text", "Widget"]}}, "/playlist/widget/ticker/{playlistId}"=>{"post"=>{"summary"=>"Add a ticker Widget", "description"=>"Add a new ticker Widget to the specified playlist", "operationId"=>"WidgetTickerAdd", "x-api-path-slug"=>"playlistwidgettickerplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"allowedAttributes", "description"=>"EDIT Only and SourceId=1 - A comma separated list of attributes that should not be stripped from the feed"}, {"in"=>"formData", "name"=>"backgroundColor", "description"=>"Edit only - A HEX color to use as the background color of this widget"}, {"in"=>"formData", "name"=>"copyright", "description"=>"EDIT Only and SourceId=1 - Copyright information to display as the last item in this feed"}, {"in"=>"formData", "name"=>"css", "description"=>"Optional StyleSheet Pass only with overrideTemplate set to 1 or with sourceId=2"}, {"in"=>"formData", "name"=>"dataSetId", "description"=>"For sourceId=2, Create ticker Widget using provided dataSetId of an existing dataSet"}, {"in"=>"formData", "name"=>"dateFormat", "description"=>"EDIT Only - The date format to apply to all dates returned by the ticker"}, {"in"=>"formData", "name"=>"disableDateSort", "description"=>"EDIT Only, SourceId=1 - Should the date sort applied to the feed be disabled?"}, {"in"=>"formData", "name"=>"duration", "description"=>"The Widget Duration"}, {"in"=>"formData", "name"=>"durationIsPerItem", "description"=>"A flag (0, 1), The duration specified is per item, otherwise it is per feed"}, {"in"=>"formData", "name"=>"effect", "description"=>"Edit only - Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind, marqueeUp, marqueeDown, marqueeRight, marqueeLeft"}, {"in"=>"formData", "name"=>"filter", "description"=>"EDIT Only, SourceId=2 - SQL clause for filter this dataSet"}, {"in"=>"formData", "name"=>"itemsPerPage", "description"=>"EDIT Only - When in single mode, how many items per page should be shown"}, {"in"=>"formData", "name"=>"itemsSideBySide", "description"=>"A flag (0, 1), Should items be shown side by side"}, {"in"=>"formData", "name"=>"javaScript", "description"=>"Optional JavaScript, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"lowerLimit", "description"=>"EDIT Only, SourceId=2 - Lower low limit for this dataSet, 0 for nor limit"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"formData", "name"=>"noDataMessage", "description"=>"EDIT Only - A message to display when no data is returned from the source"}, {"in"=>"formData", "name"=>"numItems", "description"=>"EDIT Only and SourceId=1 - The number of RSS items you want to display"}, {"in"=>"formData", "name"=>"ordering", "description"=>"EDIT Only, SourceId=2- SQL clause for how this dataSet should be ordered"}, {"in"=>"formData", "name"=>"overrideTemplate", "description"=>"EDIT Only, SourceId=1 - flag (0, 1) override template checkbox"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Widget to"}, {"in"=>"formData", "name"=>"randomiseItems", "description"=>"A flag (0, 1), whether to randomise the feed"}, {"in"=>"formData", "name"=>"sourceId", "description"=>"Add only - 1 for rss feed, 2 for dataset"}, {"in"=>"formData", "name"=>"speed", "description"=>"Edit only - The transition speed of the selected effect in milliseconds (1000 = normal) or the Marquee speed in a low to high scale (normal = 1)"}, {"in"=>"formData", "name"=>"stripTags", "description"=>"EDIT Only and SourceId=1 - A comma separated list of attributes that should be stripped from the feed"}, {"in"=>"formData", "name"=>"takeItemsFrom", "description"=>"EDIT Only and SourceId=1 - Take the items form the beginning or the end of the list, available options: start, end"}, {"in"=>"formData", "name"=>"template", "description"=>"Template for each item, replaces [itemsTemplate] in main template, Pass only with overrideTemplate set to 1 or with sourceId=2"}, {"in"=>"formData", "name"=>"templateId", "description"=>"EDIT Only, SourceId=1 - Template youd like to apply, options available: title-only, prominent-title-with-desc-and-name-separator, media-rss-with-title, media-rss-wth-left-hand-text, media-rss-image-only"}, {"in"=>"formData", "name"=>"textDirection", "description"=>"EDIT Only, SourceId=1 - Which direction does the text in the feed use? Available options: ltr, rtl"}, {"in"=>"formData", "name"=>"updateInterval", "description"=>"EDIT Only - Update interval in minutes"}, {"in"=>"formData", "name"=>"upperLimit", "description"=>"EDIT Only, SourceId=2 - Upper low limit for this dataSet, 0 for nor limit"}, {"in"=>"formData", "name"=>"uri", "description"=>"For sourceId=1, the link for the rss feed"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"(0, 1) Select 1 only if you will provide duration parameter as well"}, {"in"=>"formData", "name"=>"useFilteringClause", "description"=>"EDIT Only, SourceId=2 - flag (0,1) Use advanced filter clause - set to 1 if filter is provided"}, {"in"=>"formData", "name"=>"useOrderingClause", "description"=>"EDIT Only, SourceId=2 - flag (0,1) Use advanced order clause - set to 1 if ordering is provided"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticker", "Widget"]}}, "/playlist/widget/twitter/{playlistId}"=>{"post"=>{"summary"=>"Add a Twitter Widget", "description"=>"Add a new Twitter Widget to the specified playlist", "operationId"=>"WidgetTwitterAdd", "x-api-path-slug"=>"playlistwidgettwitterplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"backgroundColor", "description"=>"A HEX color to use as the background color of this widget"}, {"in"=>"formData", "name"=>"dateFormat", "description"=>"The format to apply to all dates returned by he widget"}, {"in"=>"formData", "name"=>"duration", "description"=>"Widget Duration"}, {"in"=>"formData", "name"=>"durationIsPerItem", "description"=>"A flag (0, 1), The duration specified is per page/item, otherwise the widget duration is divided between the number of pages/items"}, {"in"=>"formData", "name"=>"effect", "description"=>"Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind"}, {"in"=>"formData", "name"=>"itemsPerPage", "description"=>"EDIT Only - When in single mode, how many items per page should be shown"}, {"in"=>"formData", "name"=>"javaScript", "description"=>"Optional JavaScript, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"language", "description"=>"Language in which tweets should be returned"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"formData", "name"=>"noTweetsMessage", "description"=>"A message to display when there are no tweets returned by the search query"}, {"in"=>"formData", "name"=>"overrideTemplate", "description"=>"flag (0, 1) set to 0 and use templateId or set to 1 and provide whole template in the next parameters"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Twitter widget"}, {"in"=>"formData", "name"=>"removeHashtags", "description"=>"Flag (0, 1) Should the hashtags (#something) be removed from the tweet text"}, {"in"=>"formData", "name"=>"removeMentions", "description"=>"Flag (0, 1) Should mentions (@someone) be removed from the tweet text?"}, {"in"=>"formData", "name"=>"removeUrls", "description"=>"Flag (0, 1) Should the URLs be removed from the tweet text?"}, {"in"=>"formData", "name"=>"resultContent", "description"=>"Intended content Type, available Options: 0 - All Tweets 1 - Tweets with the text only content 2 - Tweets with the text and image content"}, {"in"=>"formData", "name"=>"resultType", "description"=>"1 - Mixed, 2 -Recent 3 - Popular, Recent shows only recent tweets, Popular the most popular tweets and Mixed included both popular and recent"}, {"in"=>"formData", "name"=>"searchTerm", "description"=>"Twitter search term, you can test your search term in twitter"}, {"in"=>"formData", "name"=>"speed", "description"=>"The transition speed of the selected effect in milliseconds (1000 = normal)"}, {"in"=>"formData", "name"=>"styleSheet", "description"=>"Optional StyleSheet Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"template", "description"=>"Main template, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"templateId", "description"=>"Use pre-configured templates, available options: full-timeline-np, full-timeline, tweet-only, tweet-with-profileimage-left, tweet-with-profileimage-right, tweet-1, tweet-2, tweet-4"}, {"in"=>"formData", "name"=>"tweetCount", "description"=>"The number of tweets to return"}, {"in"=>"formData", "name"=>"tweetDistance", "description"=>"Distance in miles that the tweets should be returned from"}, {"in"=>"formData", "name"=>"updateInterval", "description"=>"Update interval in minutes, should be kept as high as possible, if data change once per hour, this should be set to 60"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"(0, 1) Select 1 only if you will provide duration parameter as well"}, {"in"=>"formData", "name"=>"widgetOriginalHeight", "description"=>"This is the intended Height of the template and is used to scale the Widget within its region when the template is applied, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"widgetOriginalPadding", "description"=>"This is the intended Padding of the template and is used to scale the Widget within its region when the template is applied, Pass only with overrideTemplate set to 1"}, {"in"=>"formData", "name"=>"widgetOriginalWidth", "description"=>"This is the intended Width of the template and is used to scale the Widget within its region when the template is applied, Pass only with overrideTemplate set to 1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Twitter", "Widget"]}}, "/playlist/widget/twittermetro/{playlistId}"=>{"post"=>{"summary"=>"Add a Twitter Metro Widget", "description"=>"Add a new Twitter Metro Widget to the specified playlist", "operationId"=>"WidgetTwitterMetroAdd", "x-api-path-slug"=>"playlistwidgettwittermetroplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"backgroundColor", "description"=>"A HEX color to use as the background color of this widget"}, {"in"=>"formData", "name"=>"colorTemplateId", "description"=>"Use pre-configured templates, available options: default, full, gray, light, soft, vivid"}, {"in"=>"formData", "name"=>"dateFormat", "description"=>"The format to apply to all dates returned by he widget"}, {"in"=>"formData", "name"=>"duration", "description"=>"Widget Duration"}, {"in"=>"formData", "name"=>"effect", "description"=>"Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind"}, {"in"=>"formData", "name"=>"language", "description"=>"Language in which tweets should be returned"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"formData", "name"=>"noTweetsMessage", "description"=>"A message to display when there are no tweets returned by the search query"}, {"in"=>"formData", "name"=>"overrideColorTemplate", "description"=>"flag (0, 1) set to 0 and use colorTemplateId or set to 1 and provide colours to use in templateColours parameter"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Twitter Metro widget"}, {"in"=>"formData", "name"=>"removeHashtags", "description"=>"Flag (0, 1) Should the hashtags (#something) be removed from the tweet text"}, {"in"=>"formData", "name"=>"removeMentions", "description"=>"Flag (0, 1) Should mentions (@someone) be removed from the tweet text?"}, {"in"=>"formData", "name"=>"removeRetweets", "description"=>"Flag (0, 1) Should retweets be filtered?"}, {"in"=>"formData", "name"=>"removeUrls", "description"=>"Flag (0, 1) Should the URLs be removed from the tweet text?"}, {"in"=>"formData", "name"=>"resultContent", "description"=>"Intended content Type, available Options: 0 - All Tweets 1 - Tweets with the text only content 2 - Tweets with the text and image content"}, {"in"=>"formData", "name"=>"resultType", "description"=>"1 - Mixed, 2 -Recent 3 - Popular, Recent shows only recent tweets, Popular the most popular tweets and Mixed included both popular and recent"}, {"in"=>"formData", "name"=>"searchTerm", "description"=>"Twitter search term, you can test your search term in twitter"}, {"in"=>"formData", "name"=>"speed", "description"=>"The transition speed of the selected effect in milliseconds (1000 = normal)"}, {"in"=>"formData", "name"=>"templateColours", "description"=>"Provide a string of new HEX colour codes to use, separated by |, for example: #e0d2c8|#5e411d|#fccf12|#82ff00|#64bae8"}, {"in"=>"formData", "name"=>"tweetCount", "description"=>"The number of tweets to return"}, {"in"=>"formData", "name"=>"tweetDistance", "description"=>"Distance in miles that the tweets should be returned from"}, {"in"=>"formData", "name"=>"updateInterval", "description"=>"Update interval in minutes, should be kept as high as possible, if data change once per hour, this should be set to 60"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"(0, 1) Select 1 only if you will provide duration parameter as well"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Twitter", "Metro", "Widget"]}}, "/playlist/widget/video/{playlistId}"=>{"post"=>{"summary"=>"Parameters for editing existing video on a layout", "description"=>"Parameters for editing existing video on a layout, for adding new videos, please refer to POST /library documentation", "operationId"=>"WidgetVideoEdit", "x-api-path-slug"=>"playlistwidgetvideoplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"duration", "description"=>"Edit Only - The Widget Duration"}, {"in"=>"formData", "name"=>"loop", "description"=>"Edit only - Flag (0, 1) Should the video loop (only for duration > 0 )?"}, {"in"=>"formData", "name"=>"mute", "description"=>"Edit only - Flag (0, 1) Should the video be muted?"}, {"in"=>"formData", "name"=>"name", "description"=>"Edit only - Optional Widget Name"}, {"in"=>"formData", "name"=>"scaleTypeId", "description"=>"How should the video be scaled, available options: aspect, stretch"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"Edit Only - (0, 1) Select 1 only if you will provide duration parameter as well"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parametersediting", "Existing", "Video", "On", "Layout"]}}, "/playlist/widget/videoin/{playlistId}"=>{"post"=>{"summary"=>"Add a Video In Widget", "description"=>"Add a new Video In Widget to the specified playlist", "operationId"=>"WidgetVideoInAdd", "x-api-path-slug"=>"playlistwidgetvideoinplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"duration", "description"=>"The Widget Duration"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Widget to"}, {"in"=>"formData", "name"=>"sourceId", "description"=>"Which device input should be shown? available options: HDMI, RGB, DVI, DP, OPS"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"Flag (0, 1) Select only if you will provide duration parameter as well"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video", "In", "Widget"]}}, "/playlist/widget/webpage/{playlistId}"=>{"post"=>{"summary"=>"Add a Web page Widget", "description"=>"Add a new Web page Widget to the specified playlist", "operationId"=>"WidgetWebpageAdd", "x-api-path-slug"=>"playlistwidgetwebpageplaylistid-post", "parameters"=>[{"in"=>"formData", "name"=>"duration", "description"=>"The Web page Duration"}, {"in"=>"formData", "name"=>"modeId", "description"=>"The mode option for Web page, 1- Open Natively, 2- Manual Position, 3- Best Ft"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional Widget Name"}, {"in"=>"formData", "name"=>"offsetLeft", "description"=>"For Manual position, the starting point from the left in pixels"}, {"in"=>"formData", "name"=>"offsetTop", "description"=>"For Manual position, the starting point from the Top in pixels"}, {"in"=>"formData", "name"=>"pageHeight", "description"=>"For Manual Position and Best Fit, The height of the page - if empty it will use region height"}, {"in"=>"formData", "name"=>"pageWidth", "description"=>"For Manual Position and Best Fit, The width of the page - if empty it will use region width"}, {"in"=>"path", "name"=>"playlistId", "description"=>"The playlist ID to add a Web page to"}, {"in"=>"formData", "name"=>"scaling", "description"=>"For Manual position the percentage to scale the Web page (0-100)"}, {"in"=>"formData", "name"=>"transparency", "description"=>"flag (0,1) should the HTML be shown with a transparent background?"}, {"in"=>"formData", "name"=>"uri", "description"=>"string containing the location (URL) of the web page"}, {"in"=>"formData", "name"=>"useDuration", "description"=>"(0, 1) Select 1 only if you will provide duration parameter as well"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web", "Page", "Widget"]}}}}, "apis"=>{"name"=>"Xibo", "x-slug"=>"xibo", "description"=>"Xibo Digital Signage is a low-cost, high performance solution to launch your business, workplace or organisation into the future. Xibo doesn’t just replicate print media, but actively increases engagement allowing you to deliver your message more effectively than ever before.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xibo-digital-signage-logo.jpeg", "x-kinRank"=>"7", "x-alexaRank"=>"", "tags"=>"Display,Relative Data,Service API,Signage,Signs", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"xibo/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Xibo API", "x-api-slug"=>"xibo-api", "description"=>"Xibo Digital Signage is a low-cost, high performance solution to launch your business, workplace or organisation into the future. Xibo doesn’t just replicate print media, but actively increases engagement allowing you to deliver your message more effectively than ever before.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xibo-digital-signage-logo.jpeg", "humanURL"=>"http://www.xibo.org.uk", "baseURL"=>"https:////api", "tags"=>"Display,Relative Data,Service API,Signage,Signs", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/xibo/playlistwidgetwebpageplaylistid-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/xibo/xibo-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog-rss", "url"=>"https://blog.xibo.org.uk/rss/"}, {"type"=>"x-github", "url"=>"https://github.com/xibosignage"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/xibosignage"}, {"type"=>"x-website", "url"=>"http://www.xibo.org.uk"}, {"type"=>"x-blog", "url"=>"https://blog.xibo.org.uk/"}, {"type"=>"x-website", "url"=>"https://xibo.org.uk"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-api-gateway{"aws-api-gateway-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS API Gateway", "x-complete"=>1, "info"=>{"title"=>"AWS API Gateway API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/"=>{"get"=>{"summary"=>"Root Service", "description"=>"Represents the root of the Amazon API Gateway control service.", "operationId"=>"apiGateway", "x-api-path-slug"=>"get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"query", "name"=>"UnauthorizedException", "description"=>"TooManyRequestsException", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Root", "Service"]}}, "/apikeys"=>{"get"=>{"summary"=>"Get API Keys", "description"=>"Gets the ApiKeys resource representing the set of ApiKey resources to identify clients for all of your APIs.", "operationId"=>"apigatewayApi-keys", "x-api-path-slug"=>"apikeys-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"query", "name"=>"REST API Reference", "description"=>"Link Relations", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}, "post"=>{"summary"=>"Create Key", "description"=>"Creates a new ApiKey resource to represent an API key.", "operationId"=>"apikeyCreate", "x-api-path-slug"=>"apikeys-post", "parameters"=>[{"in"=>"header", "name"=>""description"", "type"=>"string"}, {"in"=>"header", "name"=>""enabled"", "type"=>"string"}, {"in"=>"header", "name"=>""name"", "type"=>"string"}, {"in"=>"header", "name"=>""restApiId"", "type"=>"string"}, {"in"=>"header", "name"=>""stageKeys"", "type"=>"string"}, {"in"=>"header", "name"=>""stageName"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"query", "name"=>"REST API Reference", "description"=>"Link Relations", "type"=>"string"}, {"in"=>"body", "name"=>"restApiId", "description"=>"A list of Stage resources that are associated with the ApiKey resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"stageName", "description"=>"The stage name in the RestApi that the stage key references", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/restapis"=>{"post"=>{"summary"=>"Restapi Create", "description"=>"Creates a new API represented by a RestApi instance in API Gateway.", "operationId"=>"restapiCreate", "x-api-path-slug"=>"restapis-post", "parameters"=>[{"in"=>"header", "name"=>""description"", "type"=>"string"}, {"in"=>"header", "name"=>""name"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"query", "name"=>"REST API Reference", "description"=>"Link Relations", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Restapi", ""]}}, "/restapis?mode=import&failonwarning=true"=>{"post"=>{"summary"=>"Restapi Import", "description"=>"Creates an API from an external API definition.", "operationId"=>"restapiImport", "x-api-path-slug"=>"restapismodeimportampfailonwarningtrue-post", "parameters"=>[{"in"=>"header", "name"=>""$ref"", "type"=>"string"}, {"in"=>"header", "name"=>""/"", "type"=>"string"}, {"in"=>"header", "name"=>""200"", "type"=>"string"}, {"in"=>"header", "name"=>""application/json"", "type"=>"string"}, {"in"=>"header", "name"=>""basePath"", "type"=>"string"}, {"in"=>"header", "name"=>""consumes"", "type"=>"string"}, {"in"=>"header", "name"=>""Content-Type"", "type"=>"string"}, {"in"=>"header", "name"=>""default"", "type"=>"string"}, {"in"=>"header", "name"=>""definitions"", "type"=>"string"}, {"in"=>"header", "name"=>""description"", "type"=>"string"}, {"in"=>"header", "name"=>""Empty"", "type"=>"string"}, {"in"=>"header", "name"=>""get"", "type"=>"string"}, {"in"=>"header", "name"=>""headers"", "type"=>"string"}, {"in"=>"header", "name"=>""host"", "type"=>"string"}, {"in"=>"header", "name"=>""httpMethod"", "type"=>"string"}, {"in"=>"header", "name"=>""info"", "type"=>"string"}, {"in"=>"header", "name"=>""integration.request.header.Content-Type"", "type"=>"string"}, {"in"=>"header", "name"=>""method.response.header.Content-Type"", "type"=>"string"}, {"in"=>"header", "name"=>""passthroughBehavior"", "type"=>"string"}, {"in"=>"header", "name"=>""paths"", "type"=>"string"}, {"in"=>"header", "name"=>""produces"", "type"=>"string"}, {"in"=>"header", "name"=>""requestParameters"", "type"=>"string"}, {"in"=>"header", "name"=>""requestTemplates"", "type"=>"string"}, {"in"=>"header", "name"=>""responseParameters"", "type"=>"string"}, {"in"=>"header", "name"=>""responses"", "type"=>"string"}, {"in"=>"header", "name"=>""responseTemplates"", "type"=>"string"}, {"in"=>"header", "name"=>""schema"", "type"=>"string"}, {"in"=>"header", "name"=>""schemes"", "type"=>"string"}, {"in"=>"header", "name"=>""statusCode"", "type"=>"string"}, {"in"=>"header", "name"=>""swagger"", "type"=>"string"}, {"in"=>"header", "name"=>""title"", "type"=>"string"}, {"in"=>"header", "name"=>""type"", "type"=>"string"}, {"in"=>"header", "name"=>""x-amazon-apigateway-integration"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"query", "name"=>"REST API Reference", "description"=>"Link Relations", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import"]}}, "/apikeys/hzYAVO9Sg98nsNh65VfX81M84O2kyXVy6K1xwHD7"=>{"get"=>{"summary"=>"Get API Key", "description"=>"Gets the ApiKey resource with the specified key identifier.", "operationId"=>"apikeyBy-key", "x-api-path-slug"=>"apikeyshzyavo9sg98nsnh65vfx81m84o2kyxvy6k1xwhd7-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"query", "name"=>"REST API Reference", "description"=>"Link Relations", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}, "patch"=>{"summary"=>"Apikey Update", "description"=>"Changes an API key properties, including the description, enabled, and name properties.", "operationId"=>"apikeyUpdate", "x-api-path-slug"=>"apikeyshzyavo9sg98nsnh65vfx81m84o2kyxvy6k1xwhd7-patch", "parameters"=>[{"in"=>"header", "name"=>""op"", "type"=>"string"}, {"in"=>"header", "name"=>""patchOperations"", "type"=>"string"}, {"in"=>"header", "name"=>""path"", "type"=>"string"}, {"in"=>"header", "name"=>""value"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"body", "name"=>"from", "description"=>"Not supported", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"body", "name"=>"op", "description"=>"An update operation to be performed with this PATCH request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"path", "description"=>"The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"REST API Reference", "description"=>"Link Relations", "type"=>"string"}, {"in"=>"body", "name"=>"value", "description"=>"The new target value of the update operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/apikeys?mode=import&format=csv&failonwarnings=false"=>{"post"=>{"summary"=>"Imports One Or More API Keys", "description"=>"Imports one or more API keys.", "operationId"=>"apikeyImport", "x-api-path-slug"=>"apikeysmodeimportampformatcsvampfailonwarningsfalse-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"query", "name"=>"REST API Reference", "description"=>"Link Relations", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys", "Imports"]}}, "/account"=>{"patch"=>{"summary"=>"Account Update", "description"=>"Changes information about the associated Account resource.", "operationId"=>"accountUpdate", "x-api-path-slug"=>"account-patch", "parameters"=>[{"in"=>"header", "name"=>""op"", "type"=>"string"}, {"in"=>"header", "name"=>""patchOperations"", "type"=>"string"}, {"in"=>"header", "name"=>""path"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"body", "name"=>"from", "description"=>"Not supported", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"body", "name"=>"op", "description"=>"An update operation to be performed with this PATCH request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"path", "description"=>"The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"REST API Reference", "description"=>"Link Relations", "type"=>"string"}, {"in"=>"body", "name"=>"value", "description"=>"The new target value of the update operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/apikeys/a2TprUZuzf2EKbbmMUotDaHYGg8kgxFypcarGved"=>{"delete"=>{"summary"=>"Deletes An Api Key Resource", "description"=>"Deletes an ApiKey resource.", "operationId"=>"apikeyDelete", "x-api-path-slug"=>"apikeysa2tpruzuzf2ekbbmmuotdahygg8kgxfypcargved-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"query", "name"=>"REST API Reference", "description"=>"Link Relations", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key", "Resource"]}}, "/restapis/mxsmn867vb/authorizers/4unj71"=>{"delete"=>{"summary"=>"Authorizer Delete", "description"=>"Deletes an authorizer.", "operationId"=>"authorizerDelete", "x-api-path-slug"=>"restapismxsmn867vbauthorizers4unj71-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"query", "name"=>"REST API Reference", "description"=>"Link Relations", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorizer"]}}, "/restapis/mxsmn867vb/authorizers/40j2n8"=>{"get"=>{"summary"=>"Authorizer Byid", "description"=>"Gets the Authorizer resource representing a custom authorizer of a specified identifier.", "operationId"=>"authorizerBy-id", "x-api-path-slug"=>"restapismxsmn867vbauthorizers40j2n8-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorizer"]}}, "/restapis/mxsmn867vb/authorizers"=>{"post"=>{"summary"=>"Authorizer Create", "description"=>"Creates an Authorizer resource.", "operationId"=>"authorizerCreate", "x-api-path-slug"=>"restapismxsmn867vbauthorizers-post", "parameters"=>[{"in"=>"header", "name"=>""authorizerResultTtlInSeconds"", "type"=>"string"}, {"in"=>"header", "name"=>""authType"", "type"=>"string"}, {"in"=>"header", "name"=>""identitySource"", "type"=>"string"}, {"in"=>"header", "name"=>""name"", "type"=>"string"}, {"in"=>"header", "name"=>""type"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorizer"]}}, "/clientcertificates/9ao60f"=>{"get"=>{"summary"=>"Clientcertificate Byid", "description"=>"Gets the ClientCertificate resource with the specified identifier.", "operationId"=>"clientcertificateBy-id", "x-api-path-slug"=>"clientcertificates9ao60f-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates", "Byid"]}}, "/clientcertificates"=>{"post"=>{"summary"=>"Clientcertificate Generate", "description"=>"Generates a new ClientCertificate resource.", "operationId"=>"clientcertificateGenerate", "x-api-path-slug"=>"clientcertificates-post", "parameters"=>[{"in"=>"header", "name"=>""description"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates", "Generate"]}}, "/restapis/fugvjdxtri/deployments/dzacq7"=>{"patch"=>{"summary"=>"Deployment Update", "description"=>"Changes information about the deployment resource.", "operationId"=>"deploymentUpdate", "x-api-path-slug"=>"restapisfugvjdxtrideploymentsdzacq7-patch", "parameters"=>[{"in"=>"header", "name"=>""op"", "type"=>"string"}, {"in"=>"header", "name"=>""patchOperations"", "type"=>"string"}, {"in"=>"header", "name"=>""path"", "type"=>"string"}, {"in"=>"header", "name"=>""value"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"body", "name"=>"from", "description"=>"Not supported", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"body", "name"=>"op", "description"=>"An update operation to be performed with this PATCH request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"path", "description"=>"The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"value", "description"=>"The new target value of the update operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment"]}, "delete"=>{"summary"=>"Deployment Delete", "description"=>"Deletes the deployment resource.", "operationId"=>"deploymentDelete", "x-api-path-slug"=>"restapisfugvjdxtrideploymentsdzacq7-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment"]}}, "/domainnames/mon-api.com"=>{"delete"=>{"summary"=>"Domainname Delete", "description"=>"Deletes the domain name resource.", "operationId"=>"domainnameDelete", "x-api-path-slug"=>"domainnamesmonapi-com-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domainname"]}}, "/domainnames/a.b.c.com/basepathmappings"=>{"get"=>{"summary"=>"Get Domain Base Path", "description"=>"Gets the BasePathMappings resource representing the collection of base path mappings for the specified custom domain name.", "operationId"=>"domainnameBasepathmappings", "x-api-path-slug"=>"domainnamesa-b-c-combasepathmappings-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domain", "Base", "Path"]}}, "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"=>{"patch"=>{"summary"=>"Integrationresponse Update", "description"=>"Changes information about an integration response.", "operationId"=>"integrationresponseUpdate", "x-api-path-slug"=>"restapisfugvjdxtriresources3kzxbg5sa2methodsgetintegrationresponses200-patch", "parameters"=>[{"in"=>"header", "name"=>""op"", "type"=>"string"}, {"in"=>"header", "name"=>""patchOperations"", "type"=>"string"}, {"in"=>"header", "name"=>""path"", "type"=>"string"}, {"in"=>"header", "name"=>""value"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"body", "name"=>"from", "description"=>"Not supported", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"body", "name"=>"op", "description"=>"An update operation to be performed with this PATCH request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"path", "description"=>"The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"value", "description"=>"The new target value of the update operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integrations"]}, "delete"=>{"summary"=>"Integration Delete", "description"=>"Deletes an integration response.", "operationId"=>"integrationresponseDelete", "x-api-path-slug"=>"restapisfugvjdxtriresources3kzxbg5sa2methodsgetintegrationresponses200-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integrations"]}, "put"=>{"summary"=>"Integrationresponse Put", "description"=>"Set up an IntegrationResponse for the integration.", "operationId"=>"integrationresponsePut", "x-api-path-slug"=>"restapisfugvjdxtriresources3kzxbg5sa2methodsgetintegrationresponses200-put", "parameters"=>[{"in"=>"header", "name"=>""method.response.header.Content-Type"", "type"=>"string"}, {"in"=>"header", "name"=>""responseParameters"", "type"=>"string"}, {"in"=>"header", "name"=>""selectionPattern"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"body", "name"=>"CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.", "description"=>"CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integrations"]}, "get"=>{"summary"=>"Integration Responses", "description"=>"Specifies the integration's responses.", "operationId"=>"integrationResponses", "x-api-path-slug"=>"restapisfugvjdxtriresources3kzxbg5sa2methodsgetintegrationresponses200-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integrations", "Responses"]}}, "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"=>{"patch"=>{"summary"=>"Integration Update", "description"=>"Changes information about an integration.", "operationId"=>"integrationUpdate", "x-api-path-slug"=>"restapisfugvjdxtriresources3kzxbg5sa2methodsgetintegration-patch", "parameters"=>[{"in"=>"header", "name"=>""op"", "type"=>"string"}, {"in"=>"header", "name"=>""patchOperations"", "type"=>"string"}, {"in"=>"header", "name"=>""path"", "type"=>"string"}, {"in"=>"header", "name"=>""value"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"body", "name"=>"from", "description"=>"Not supported", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"body", "name"=>"op", "description"=>"An update operation to be performed with this PATCH request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"path", "description"=>"The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"value", "description"=>"The new target value of the update operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integration"]}, "delete"=>{"summary"=>"Integration Delete", "description"=>"Deletes an integration.", "operationId"=>"integrationDelete", "x-api-path-slug"=>"restapisfugvjdxtriresources3kzxbg5sa2methodsgetintegration-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integration"]}, "put"=>{"summary"=>"Integration Put", "description"=>"Set up the method's integration request.", "operationId"=>"integrationPut", "x-api-path-slug"=>"restapisfugvjdxtriresources3kzxbg5sa2methodsgetintegration-put", "parameters"=>[{"in"=>"header", "name"=>""application/json"", "type"=>"string"}, {"in"=>"header", "name"=>""httpMethod"", "type"=>"string"}, {"in"=>"header", "name"=>""integration.request.header.Content-Type"", "type"=>"string"}, {"in"=>"header", "name"=>""passthroughBehavior"", "type"=>"string"}, {"in"=>"header", "name"=>""requestParameters"", "type"=>"string"}, {"in"=>"header", "name"=>""requestTemplates"", "type"=>"string"}, {"in"=>"header", "name"=>""type"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"body", "name"=>"WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.", "description"=>"NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integration", "Put"]}}, "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200"=>{"get"=>{"summary"=>"Get Response", "description"=>"Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.", "operationId"=>"methodResponse", "x-api-path-slug"=>"restapisfugvjdxtriresources3kzxbg5sa2methodsgetresponses200-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"query", "name"=>"responseModels", "description"=>"Specifies the Model resources used for the response's content-type", "type"=>"string"}, {"in"=>"query", "name"=>"responseParameters", "description"=>"A key-value map specifying required or optional response parameters that Amazon API Gateway can send back to the caller", "type"=>"string"}, {"in"=>"query", "name"=>"statusCode", "description"=>"The method response's status code", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Response"]}, "put"=>{"summary"=>"Methodresponse Put", "description"=>"Set up the method response.", "operationId"=>"methodresponsePut", "x-api-path-slug"=>"restapisfugvjdxtriresources3kzxbg5sa2methodsgetresponses200-put", "parameters"=>[{"in"=>"header", "name"=>""application/json"", "type"=>"string"}, {"in"=>"header", "name"=>""method.response.header.Content-Type"", "type"=>"string"}, {"in"=>"header", "name"=>""responseModels"", "type"=>"string"}, {"in"=>"header", "name"=>""responseParameters"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Methods"]}}, "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200"=>{"patch"=>{"summary"=>"Methodresponse Update", "description"=>"Update MethodResponse resource's properties.", "operationId"=>"methodresponseUpdate", "x-api-path-slug"=>"restapisuojnr9hd57resources0cjtchmethodsgetresponses200-patch", "parameters"=>[{"in"=>"header", "name"=>""op"", "type"=>"string"}, {"in"=>"header", "name"=>""patchOperations"", "type"=>"string"}, {"in"=>"header", "name"=>""path"", "type"=>"string"}, {"in"=>"header", "name"=>""value"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"body", "name"=>"from", "description"=>"Not supported", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"body", "name"=>"op", "description"=>"An update operation to be performed with this PATCH request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"path", "description"=>"The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"value", "description"=>"The new target value of the update operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Methods"]}, "delete"=>{"summary"=>"Methodresponse Delete", "description"=>"Deletes method response settings.", "operationId"=>"methodresponseDelete", "x-api-path-slug"=>"restapisuojnr9hd57resources0cjtchmethodsgetresponses200-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Length", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Method", "Responses"]}, "get"=>{"summary"=>"Method Responses", "description"=>"Gets a method response associated with a given HTTP status code.", "operationId"=>"methodResponses", "x-api-path-slug"=>"restapisuojnr9hd57resources0cjtchmethodsgetresponses200-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Length", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Method", "Responses"]}}, "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET"=>{"patch"=>{"summary"=>"Method Update", "description"=>"Update the method settings.", "operationId"=>"methodUpdate", "x-api-path-slug"=>"restapisfugvjdxtriresources3kzxbg5sa2methodsget-patch", "parameters"=>[{"in"=>"header", "name"=>""op"", "type"=>"string"}, {"in"=>"header", "name"=>""patchOperations"", "type"=>"string"}, {"in"=>"header", "name"=>""path"", "type"=>"string"}, {"in"=>"header", "name"=>""value"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Cache-Control", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"body", "name"=>"from", "description"=>"Not supported", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"body", "name"=>"op", "description"=>"An update operation to be performed with this PATCH request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"path", "description"=>"The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"value", "description"=>"The new target value of the update operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Method"]}, "get"=>{"summary"=>"Resource Methods", "description"=>"Gets an API resource's method of a given HTTP verb.", "operationId"=>"resourceMethods", "x-api-path-slug"=>"restapisfugvjdxtriresources3kzxbg5sa2methodsget-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource", "Methods"]}}, "/restapis/8ekh4oszgl/resources/4oa3abz7jc/methods/GET"=>{"delete"=>{"summary"=>"Method Delete", "description"=>"Delete the method resource.", "operationId"=>"methodDelete", "x-api-path-slug"=>"restapis8ekh4oszglresources4oa3abz7jcmethodsget-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Method"]}}, "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration"=>{"get"=>{"summary"=>"Method Integration", "description"=>"Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.", "operationId"=>"methodIntegration", "x-api-path-slug"=>"restapisuojnr9hd57resources0cjtchmethodsgetintegration-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Length", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Method", "Integration"]}}, "/restapis/uojnr9hd57/models"=>{"post"=>{"summary"=>"Model Create", "description"=>"Creates a new Model for this API.", "operationId"=>"modelCreate", "x-api-path-slug"=>"restapisuojnr9hd57models-post", "parameters"=>[{"in"=>"header", "name"=>""contentType"", "type"=>"string"}, {"in"=>"header", "name"=>""description"", "type"=>"string"}, {"in"=>"header", "name"=>""name"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Models"]}}, "/restapis/uojnr9hd57/models/CalcOutput"=>{"delete"=>{"summary"=>"Model Delete", "description"=>"Deletes a model.", "operationId"=>"modelDelete", "x-api-path-slug"=>"restapisuojnr9hd57modelscalcoutput-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Model"]}}, "/restapis/uojnr9hd57/models/output/default_template"=>{"get"=>{"summary"=>"Model Generatetemplate", "description"=>"Generates a sample mapping template that can be used to transform a payload into the structure of a model.", "operationId"=>"modelGenerate-template", "x-api-path-slug"=>"restapisuojnr9hd57modelsoutputdefault-template-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Model", "Templates"]}}, "/restapis/uojnr9hd57/models/output"=>{"get"=>{"summary"=>"Model Byname", "description"=>"Gets information about the Model of a specified name.", "operationId"=>"modelBy-name", "x-api-path-slug"=>"restapisuojnr9hd57modelsoutput-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Model", "Byname"]}}, "/restapis/fugvjdxtri/resources/47rxl6"=>{"post"=>{"summary"=>"Resource Createchild", "description"=>"Creates a child API resource of a given API resource.", "operationId"=>"resourceCreate-child", "x-api-path-slug"=>"restapisfugvjdxtriresources47rxl6-post", "parameters"=>[{"in"=>"header", "name"=>""pathPart"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource"]}}, "/restapis/uojnr9hd57/resources/0cjtch/methods/GET"=>{"get"=>{"summary"=>"Method Byhttpmethod", "description"=>"Gets the method (as a Method resource) on a specified API resource (as Resource resource) of the given HTTP method type.", "operationId"=>"methodBy-http-method", "x-api-path-slug"=>"restapisuojnr9hd57resources0cjtchmethodsget-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Length", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Method", "Methods"]}}, "/restapis/fugvjdxtri/resources/3kzxbg5sa2"=>{"get"=>{"summary"=>"Resource Byid", "description"=>"Gets an API resource of the Resource type for a given resource identifier.", "operationId"=>"resourceBy-id", "x-api-path-slug"=>"restapisfugvjdxtriresources3kzxbg5sa2-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource", "Byid"]}, "post"=>{"summary"=>"Resource Create", "description"=>"Creates an API resource.", "operationId"=>"resourceCreate", "x-api-path-slug"=>"restapisfugvjdxtriresources3kzxbg5sa2-post", "parameters"=>[{"in"=>"header", "name"=>""pathPart"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource", ""]}}, "/restapis/fugvjdxtri/"=>{"patch"=>{"summary"=>"Restapi Update", "description"=>"Changes properties of a RestApi resource.", "operationId"=>"restapiUpdate", "x-api-path-slug"=>"restapisfugvjdxtri-patch", "parameters"=>[{"in"=>"header", "name"=>""op"", "type"=>"string"}, {"in"=>"header", "name"=>""patchOperations"", "type"=>"string"}, {"in"=>"header", "name"=>""path"", "type"=>"string"}, {"in"=>"header", "name"=>""value"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"body", "name"=>"from", "description"=>"Not supported", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"body", "name"=>"op", "description"=>"An update operation to be performed with this PATCH request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"path", "description"=>"The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"value", "description"=>"The new target value of the update operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Restapi"]}}, "/restapis/fugvjdxtri/resources"=>{"get"=>{"summary"=>"Restapi Resources", "description"=>"Gets an API's resource collection as represented by a Resources instance.", "operationId"=>"restapiResources", "x-api-path-slug"=>"restapisfugvjdxtriresources-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Restapi", "Resources"]}}, "/restapis/fugvjdxtri/deployments?limit=2"=>{"get"=>{"summary"=>"Restapi Deployments", "description"=>"Gets an API's Deployments resource.", "operationId"=>"restapiDeployments", "x-api-path-slug"=>"restapisfugvjdxtrideploymentslimit2-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Restapi", "Deployments"]}}, "/restapis/l9kujxkzq2/models"=>{"get"=>{"summary"=>"Restapi Models", "description"=>"Gets an API's model collection represented by a Models instance.", "operationId"=>"restapiModels", "x-api-path-slug"=>"restapisl9kujxkzq2models-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Length", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Models"]}}, "/restapis/86l3267lf6/authorizers"=>{"get"=>{"summary"=>"Restapi Authorizers", "description"=>"Gets an API's collection of custom authorizers that is represented as an Authorizers instance.", "operationId"=>"restapiAuthorizers", "x-api-path-slug"=>"restapis86l3267lf6authorizers-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Length", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Restapi", "Authorizers"]}}, "/restapis/wn611yeyp3?mode=merge"=>{"put"=>{"summary"=>"Restapi Put", "description"=>"Update the definition of a REST API, including the resources, methods, templates, and models.", "operationId"=>"restapiPut", "x-api-path-slug"=>"restapiswn611yeyp3modemerge-put", "parameters"=>[{"in"=>"header", "name"=>""$ref"", "type"=>"string"}, {"in"=>"header", "name"=>""/gello"", "type"=>"string"}, {"in"=>"header", "name"=>""/hello"", "type"=>"string"}, {"in"=>"header", "name"=>""200"", "type"=>"string"}, {"in"=>"header", "name"=>""Access-Control-Allow-Headers"", "type"=>"string"}, {"in"=>"header", "name"=>""Access-Control-Allow-Methods"", "type"=>"string"}, {"in"=>"header", "name"=>""Access-Control-Allow-Origin"", "type"=>"string"}, {"in"=>"header", "name"=>""application/json"", "type"=>"string"}, {"in"=>"header", "name"=>""basePath"", "type"=>"string"}, {"in"=>"header", "name"=>""consumes"", "type"=>"string"}, {"in"=>"header", "name"=>""default"", "type"=>"string"}, {"in"=>"header", "name"=>""definitions"", "type"=>"string"}, {"in"=>"header", "name"=>""description"", "type"=>"string"}, {"in"=>"header", "name"=>""Empty"", "type"=>"string"}, {"in"=>"header", "name"=>""get"", "type"=>"string"}, {"in"=>"header", "name"=>""headers"", "type"=>"string"}, {"in"=>"header", "name"=>""host"", "type"=>"string"}, {"in"=>"header", "name"=>""httpMethod"", "type"=>"string"}, {"in"=>"header", "name"=>""info"", "type"=>"string"}, {"in"=>"header", "name"=>""method.response.header.Access-Control-Allow-Headers"", "type"=>"string"}, {"in"=>"header", "name"=>""method.response.header.Access-Control-Allow-Methods"", "type"=>"string"}, {"in"=>"header", "name"=>""method.response.header.Access-Control-Allow-Origin"", "type"=>"string"}, {"in"=>"header", "name"=>""options"", "type"=>"string"}, {"in"=>"header", "name"=>""passthroughBehavior"", "type"=>"string"}, {"in"=>"header", "name"=>""paths"", "type"=>"string"}, {"in"=>"header", "name"=>""post"", "type"=>"string"}, {"in"=>"header", "name"=>""produces"", "type"=>"string"}, {"in"=>"header", "name"=>""requestTemplates"", "type"=>"string"}, {"in"=>"header", "name"=>""responseParameters"", "type"=>"string"}, {"in"=>"header", "name"=>""responses"", "type"=>"string"}, {"in"=>"header", "name"=>""schema"", "type"=>"string"}, {"in"=>"header", "name"=>""schemes"", "type"=>"string"}, {"in"=>"header", "name"=>""statusCode"", "type"=>"string"}, {"in"=>"header", "name"=>""swagger"", "type"=>"string"}, {"in"=>"header", "name"=>""title"", "type"=>"string"}, {"in"=>"header", "name"=>""type"", "type"=>"string"}, {"in"=>"header", "name"=>""x-amazon-apigateway-integration"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Restapi"]}}, "/restapis/fugvjdxtri/stages/stage1"=>{"patch"=>{"summary"=>"Stage Update", "description"=>"Changes information about the stage.", "operationId"=>"stageUpdate", "x-api-path-slug"=>"restapisfugvjdxtristagesstage1-patch", "parameters"=>[{"in"=>"header", "name"=>""op"", "type"=>"string"}, {"in"=>"header", "name"=>""patchOperations"", "type"=>"string"}, {"in"=>"header", "name"=>""path"", "type"=>"string"}, {"in"=>"header", "name"=>""value"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"body", "name"=>"from", "description"=>"Not supported", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"body", "name"=>"op", "description"=>"An update operation to be performed with this PATCH request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"path", "description"=>"The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"value", "description"=>"The new target value of the update operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stage"]}}, "/restapis/uycll6xg9a/stages/alpha"=>{"delete"=>{"summary"=>"Stage Delete", "description"=>"Deletes a named stage of a given API.", "operationId"=>"stageDelete", "x-api-path-slug"=>"restapisuycll6xg9astagesalpha-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stage"]}}, "/restapis/uycll6xg9a/stages/alpha/cache/data"=>{"delete"=>{"summary"=>"Stage Flush", "description"=>"Flushes the cached data of a named stage.", "operationId"=>"stageFlush-cache", "x-api-path-slug"=>"restapisuycll6xg9astagesalphacachedata-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stage", "Flush"]}}, "/restapis/uycll6xg9a/stages/alpha/cache/authorizers"=>{"delete"=>{"summary"=>"Stage Flush", "description"=>"Flushes all cached Authorizer entries on a named stage.", "operationId"=>"stageFlush-authorizer-cache", "x-api-path-slug"=>"restapisuycll6xg9astagesalphacacheauthorizers-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stage", "Flush"]}}, "/usageplans/{usageplanId}/keys/{keyId}"=>{"delete"=>{"summary"=>"Clientcertificate Delete", "description"=>"Deletes the ClientCertificate resource.", "operationId"=>"clientcertificateDelete", "x-api-path-slug"=>"usageplansusageplanidkeyskeyid-delete", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The AMI attribute", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"query", "name"=>"ImageId", "description"=>"The ID of the AMI", "type"=>"string"}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certifications"]}}, "/clientcertificates/{clientcertificate_id}"=>{"patch"=>{"summary"=>"Clientcertificate Update", "description"=>"Changes information about the ClientCertificate resource.", "operationId"=>"clientcertificateUpdate", "x-api-path-slug"=>"clientcertificatesclientcertificate-id-patch", "parameters"=>[{"in"=>"header", "name"=>""op"", "type"=>"string"}, {"in"=>"header", "name"=>""patchOperations"", "type"=>"string"}, {"in"=>"header", "name"=>""path"", "type"=>"string"}, {"in"=>"header", "name"=>""value"", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"ExecutableBy.N", "description"=>"Scopes the images by users with explicit launch permissions", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"body", "name"=>"from", "description"=>"Not supported", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Host", "type"=>"string"}, {"in"=>"query", "name"=>"ImageId.N", "description"=>"One or more image IDs", "type"=>"string"}, {"in"=>"body", "name"=>"op", "description"=>"An update operation to be performed with this PATCH request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"Owner.N", "description"=>"Filters the images by the owner", "type"=>"string"}, {"in"=>"body", "name"=>"path", "description"=>"The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"value", "description"=>"The new target value of the update operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Amz-Date", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}}}, "apis"=>{"name"=>"AWS API Gateway", "x-slug"=>"aws-api-gateway", "description"=>"Amazon API Gateway is a fully managed service that makes it easy for developers to create, publish, maintain, monitor, and secure APIs at any scale. With a few clicks in the AWS Management Console, you can create an API that acts as a front door for applications to access data, business logic, or functionality from your back-end services, such as workloads running on Amazon Elastic Compute Cloud, code running on AWS Lambda, or any Web application. Amazon API Gateway handles all the tasks involved in accepting and processing up to hundreds of thousands of concurrent API calls, including traffic management, authorization and access control, monitoring, and API version management. Amazon API Gateway has no minimum fees or startup costs. You pay only for the API calls you receive and the amount of data transferred out.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-api-gateway-icon.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Deployments,Gateway,Profiles,Relative Data,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-api-gateway/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS API Gateway API", "x-api-slug"=>"aws-api-gateway-api", "description"=>"Amazon API Gateway is a fully managed service that makes it easy for developers to create, publish, maintain, monitor, and secure APIs at any scale. With a few clicks in the AWS Management Console, you can create an API that acts as a front door for applications to access data, business logic, or functionality from your back-end services, such as workloads running on Amazon Elastic Compute Cloud, code running on AWS Lambda, or any Web application. Amazon API Gateway handles all the tasks involved in accepting and processing up to hundreds of thousands of concurrent API calls, including traffic management, authorization and access control, monitoring, and API version management. Amazon API Gateway has no minimum fees or startup costs. You pay only for the API calls you receive and the amount of data transferred out.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-api-gateway-icon.png", "humanURL"=>"https://aws.amazon.com/api-gateway/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Deployments,Gateway,Profiles,Relative Data,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-api-gateway/aws-api-gateway-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.aws.amazon.com/apigateway/api-reference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/api-gateway/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/api-gateway/getting-started/"}, {"type"=>"x-partners", "url"=>"https://aws.amazon.com/api-gateway/partners/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/api-gateway/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/api-gateway/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
paretonetwork{"pareto-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"ParetoNetwork", "x-complete"=>1, "info"=>{"title"=>"PARETO NETWORK API", "description"=>"the-pareto-network-api-is-used-by-sentinels-to-catalogue-and-relay-information-between-nodes--interacting-with-a-pareto-sentinel-uses-this-standardized-restful-api--authentication-is-done-using-a-json-web-token-jwt-stored-as-a-secure-browser-cookie--any-restful-client-will-need-to-set-the-cookie--here-is-a-tutorial-for-getting-the-initial-cookie-httpsblog-pareto-networkhowtousetheparetosentinelapi434afb75aace", "version"=>"1.0.0"}, "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/sign"=>{"post"=>{"summary"=>"Cookie authentication", "description"=>"Test the hash between a message and public key. If the test is passed, a cookie is stored. The parameters of this request are gotten from MetaMask", "operationId"=>"postSign", "x-api-path-slug"=>"sign-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sign"]}}, "/rank"=>{"get"=>{"summary"=>"Get the list of all addresses sorted by rank", "description"=>"Get all the addresses sorted by rank. The ranking is gotten from the Ethereum score", "operationId"=>"getRank", "x-api-path-slug"=>"rank-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rank"]}}, "/auth"=>{"get"=>{"summary"=>"Test if user is properly authenticated", "description"=>"Simple authenticated method to determine if user is properly authenticated.", "operationId"=>"getAuth", "x-api-path-slug"=>"auth-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auth"]}}, "/unsign"=>{"post"=>{"summary"=>"Unsign http client for the current user", "description"=>"Manage unsign proccess. Delete cookie with header set-cookie", "operationId"=>"postUnsign", "x-api-path-slug"=>"unsign-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsign"]}}, "/address"=>{"get"=>{"summary"=>"Get the information of the current user", "description"=>"Get the information of the current user. The current user is fetched using the auth cookie.", "operationId"=>"getAddress", "x-api-path-slug"=>"address-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address"]}}, "/address/{address}"=>{"get"=>{"summary"=>"Get the information of a specific user", "description"=>"Get the information of a specific user.", "operationId"=>"getAddressAddress", "x-api-path-slug"=>"addressaddress-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"address to use"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "Address"]}}, "/content"=>{"get"=>{"summary"=>"Get the content about the actionable investing intels", "description"=>"Get all available content about the actionable investing intels.", "operationId"=>"getContent", "x-api-path-slug"=>"content-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content"]}}, "/content/me"=>{"get"=>{"summary"=>"Get the content available for current user", "description"=>"Get the content available for current user", "operationId"=>"getContentMe", "x-api-path-slug"=>"contentme-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content", "Me"]}}, "/userinfo"=>{"get"=>{"summary"=>"Get the information of the profile user", "description"=>"Get the information of the current user. The current user is fetched using the auth cookie.", "operationId"=>"getUserinfo", "x-api-path-slug"=>"userinfo-get", "parameters"=>[{"in"=>"query", "name"=>"latest", "description"=>"if true force update ranking"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Userinfo"]}}, "/userinfo/{address}"=>{"get"=>{"summary"=>"Get the profile of a specific user", "description"=>"Get the profile of a specific user.", "operationId"=>"getUserinfoAddress", "x-api-path-slug"=>"userinfoaddress-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"address to use"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Userinfo", "Address"]}}, "/updateuser"=>{"post"=>{"summary"=>"Update the profile of the current user", "description"=>"Update the profile of the current user", "operationId"=>"postUpdateuser", "x-api-path-slug"=>"updateuser-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Updateuser"]}}, "/profile-image"=>{"get"=>{"summary"=>"Get the image profile", "description"=>"Get the image profile", "operationId"=>"getProfileImage", "x-api-path-slug"=>"profileimage-get", "parameters"=>[{"in"=>"query", "name"=>"image", "description"=>"resource to be gotten"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile", "Image"]}}, "/upload-profile"=>{"post"=>{"summary"=>"Upload image", "description"=>"Upload Image", "operationId"=>"postUploadProfile", "x-api-path-slug"=>"uploadprofile-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Profile"]}}}}, "apis"=>{"name"=>"ParetoNetwork", "x-slug"=>"paretonetwork", "description"=>"A peer-to-peer financial content market place using the Ethereum distributed ledger technology. Current, reputable & actionable intel for digital currency traders and investors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28734-www-pareto-network.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"884775", "tags"=>"Blockchain,Data,Financial,General Data,Relative Data,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"paretonetwork/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Pareto", "x-api-slug"=>"pareto", "description"=>"A peer-to-peer financial content market place using the Ethereum distributed ledger technology. Current, reputable & actionable intel for digital currency traders and investors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28734-www-pareto-network.jpg", "humanURL"=>"https://www.pareto.network", "baseURL"=>"https:////", "tags"=>"Blockchain,Data,Financial,General Data,Relative Data,Service API,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/paretonetwork/uploadprofile-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/paretonetwork/pareto-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://www.pareto.network/api-docs/#section/Authentication"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/pareto-networks"}, {"type"=>"x-developer", "url"=>"https://www.pareto.network/api-docs/"}, {"type"=>"x-openapi", "url"=>"https://www.pareto.network/api-docs/swagger.json"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/ParetoNetwork"}, {"type"=>"x-website", "url"=>"https://www.pareto.network"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-url-shortener{"google-url-shortener-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google URL Shortener", "x-complete"=>1, "info"=>{"title"=>"URL Shortener", "description"=>"lets-you-create-inspect-and-manage-goo-gl-short-urls", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"www.googleapis.com", "basePath"=>"/urlshortener/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/url"=>{"get"=>{"summary"=>"Get Short URLs", "description"=>"Expands a short URL or gets creation time and analytics.", "operationId"=>"urlshortener.url.get", "x-api-path-slug"=>"url-get", "parameters"=>[{"in"=>"query", "name"=>"projection", "description"=>"Additional information to return"}, {"in"=>"query", "name"=>"shortUrl", "description"=>"The short URL, including the protocol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Short URL"]}, "post"=>{"summary"=>"Create Short URL", "description"=>"Creates a new short URL.", "operationId"=>"urlshortener.url.insert", "x-api-path-slug"=>"url-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Short URL"]}}, "/url/history"=>{"get"=>{"summary"=>"Get URL History", "description"=>"Retrieves a list of URLs shortened by a user.", "operationId"=>"urlshortener.url.list", "x-api-path-slug"=>"urlhistory-get", "parameters"=>[{"in"=>"query", "name"=>"projection", "description"=>"Additional information to return"}, {"in"=>"query", "name"=>"start-token", "description"=>"Token for requesting successive pages of results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Short URL"]}}}}, "apis"=>{"name"=>"Google URL Shortener", "x-slug"=>"google-url-shortener", "description"=>"The Google URL Shortener at goo.gl is a service that takes long URLs and squeezes them into fewer characters to make a link that is easier to share, tweet, or email to friends. Users can create these short links through the web interface at goo.gl, or they can programatically create them through the URL Shortener API. With the URL Shortener API you can write applications that use simple HTTP methods to create, inspect, and manage goo.gl short links from desktop, mobile, or web.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-shortener.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,DNS,Google APIs,Links,Profiles,Relative Data,Service API,Stack Network,URL Shorteners", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-url-shortener/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google URL Shortener API", "x-api-slug"=>"google-url-shortener-api", "description"=>"The Google URL Shortener at goo.gl is a service that takes long URLs and squeezes them into fewer characters to make a link that is easier to share, tweet, or email to friends. Users can create these short links through the web interface at goo.gl, or they can programatically create them through the URL Shortener API. With the URL Shortener API you can write applications that use simple HTTP methods to create, inspect, and manage goo.gl short links from desktop, mobile, or web.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-shortener.png", "humanURL"=>"https://goo.gl/", "baseURL"=>"://www.googleapis.com//urlshortener/v1", "tags"=>"API Provider,API Service Provider,DNS,Google APIs,Links,Profiles,Relative Data,Service API,Stack Network,URL Shorteners", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/google-url-shortener/urlhistory-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/google-url-shortener/google-url-shortener-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"https://developers.google.com/url-shortener/"}, {"type"=>"x-documentation", "url"=>"https://developers.google.com/url-shortener/v1/"}, {"type"=>"x-getting-started", "url"=>"https://developers.google.com/url-shortener/v1/getting_started"}, {"type"=>"x-performance", "url"=>"https://developers.google.com/url-shortener/v1/performance"}, {"type"=>"x-website", "url"=>"https://goo.gl/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-dynamodb{"amazon-dynamodb-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS DynamoDB", "x-complete"=>1, "info"=>{"title"=>"AWS DynamoDB API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=BatchGetItem"=>{"get"=>{"summary"=>"Batch Get Item", "description"=>"The BatchGetItem operation returns the attributes of one or more items from one or\n more tables.", "operationId"=>"batchGetItem", "x-api-path-slug"=>"actionbatchgetitem-get", "parameters"=>[{"in"=>"query", "name"=>"RequestItems", "description"=>"A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnConsumedCapacity", "description"=>"Determines the level of detail about provisioned throughput consumption that is returned in the response:", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch Items"]}}, "/?Action=BatchWriteItem"=>{"get"=>{"summary"=>"Batch Write Item", "description"=>"The BatchWriteItem operation puts or deletes multiple items in one or more tables.", "operationId"=>"batchWriteItem", "x-api-path-slug"=>"actionbatchwriteitem-get", "parameters"=>[{"in"=>"query", "name"=>"RequestItems", "description"=>"A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest)", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnConsumedCapacity", "description"=>"Determines the level of detail about provisioned throughput consumption that is returned in the response:", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnItemCollectionMetrics", "description"=>"Determines whether item collection metrics are returned", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch Items"]}}, "/?Action=CreateTable"=>{"get"=>{"summary"=>"Create Table", "description"=>"The CreateTable operation adds a new table to your account.", "operationId"=>"createTable", "x-api-path-slug"=>"actioncreatetable-get", "parameters"=>[{"in"=>"query", "name"=>"AttributeDefinitions", "description"=>"An array of attributes that describe the key schema for the table and indexes", "type"=>"string"}, {"in"=>"query", "name"=>"GlobalSecondaryIndexes", "description"=>"One or more global secondary indexes (the maximum is five) to be created on the table", "type"=>"string"}, {"in"=>"query", "name"=>"KeySchema", "description"=>"Specifies the attributes that make up the primary key for a table or an index", "type"=>"string"}, {"in"=>"query", "name"=>"LocalSecondaryIndexes", "description"=>"One or more local secondary indexes (the maximum is five) to be created on the table", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisionedThroughput", "description"=>"Represents the provisioned throughput settings for a specified table or index", "type"=>"string"}, {"in"=>"query", "name"=>"StreamSpecification", "description"=>"The settings for DynamoDB Streams on the table", "type"=>"string"}, {"in"=>"query", "name"=>"TableName", "description"=>"The name of the table to create", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tables"]}}, "/?Action=DeleteItem"=>{"get"=>{"summary"=>"Delete Item", "description"=>"Deletes a single item in a table by primary key.", "operationId"=>"deleteItem", "x-api-path-slug"=>"actiondeleteitem-get", "parameters"=>[{"in"=>"query", "name"=>"ConditionalOperator", "description"=>"This is a legacy parameter", "type"=>"string"}, {"in"=>"query", "name"=>"ConditionExpression", "description"=>"A condition that must be satisfied in order for a conditional DeleteItem to succeed", "type"=>"string"}, {"in"=>"query", "name"=>"Expected", "description"=>"This is a legacy parameter", "type"=>"string"}, {"in"=>"query", "name"=>"ExpressionAttributeNames", "description"=>"One or more substitution tokens for attribute names in an expression", "type"=>"string"}, {"in"=>"query", "name"=>"ExpressionAttributeValues", "description"=>"One or more values that can be substituted in an expression", "type"=>"string"}, {"in"=>"query", "name"=>"Key", "description"=>"A map of attribute names to AttributeValue objects, representing the primary key of the item to delete", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnConsumedCapacity", "description"=>"Determines the level of detail about provisioned throughput consumption that is returned in the response:", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnItemCollectionMetrics", "description"=>"Determines whether item collection metrics are returned", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnValues", "description"=>"Use ReturnValues if you want to get the item attributes as they appeared before they were deleted", "type"=>"string"}, {"in"=>"query", "name"=>"TableName", "description"=>"The name of the table from which to delete the item", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Items"]}}, "/?Action=DeleteTable"=>{"get"=>{"summary"=>"Delete Table", "description"=>"The DeleteTable operation deletes a table and all of its items.", "operationId"=>"deleteTable", "x-api-path-slug"=>"actiondeletetable-get", "parameters"=>[{"in"=>"query", "name"=>"TableName", "description"=>"The name of the table to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tables"]}}, "/?Action=DescribeLimits"=>{"get"=>{"summary"=>"Describe Limits", "description"=>"Returns the current provisioned-capacity limits for your AWS account in a region, both for the region as a whole and for any one DynamoDB table that you create there.", "operationId"=>"describeLimits", "x-api-path-slug"=>"actiondescribelimits-get", "parameters"=>[{"in"=>"query", "name"=>"AccountMaxReadCapacityUnits", "description"=>"The maximum total read capacity units that your account allows you to provision across all of your tables in this region", "type"=>"string"}, {"in"=>"query", "name"=>"AccountMaxWriteCapacityUnits", "description"=>"The maximum total write capacity units that your account allows you to provision across all of your tables in this region", "type"=>"string"}, {"in"=>"query", "name"=>"TableMaxReadCapacityUnits", "description"=>"The maximum read capacity units that your account allows you to provision for a new table that you are creating in this region, including the read capacity units provisioned for its global secondary indexes (GSIs)", "type"=>"string"}, {"in"=>"query", "name"=>"TableMaxWriteCapacityUnits", "description"=>"The maximum write capacity units that your account allows you to provision for a new table that you are creating in this region, including the write capacity units provisioned for its global secondary indexes (GSIs)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Limits"]}}, "/?Action=DescribeTable"=>{"get"=>{"summary"=>"Describe Table", "description"=>"Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.", "operationId"=>"describeTable", "x-api-path-slug"=>"actiondescribetable-get", "parameters"=>[{"in"=>"query", "name"=>"TableName", "description"=>"The name of the table to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tables"]}}, "/?Action=GetItem"=>{"get"=>{"summary"=>"Get Item", "description"=>"The GetItem operation returns a set of attributes for the item with the given primary\n key.", "operationId"=>"getItem", "x-api-path-slug"=>"actiongetitem-get", "parameters"=>[{"in"=>"query", "name"=>"AttributesToGet", "description"=>"This is a legacy parameter", "type"=>"string"}, {"in"=>"query", "name"=>"ConsistentRead", "description"=>"Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads", "type"=>"string"}, {"in"=>"query", "name"=>"ExpressionAttributeNames", "description"=>"One or more substitution tokens for attribute names in an expression", "type"=>"string"}, {"in"=>"query", "name"=>"Key", "description"=>"A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve", "type"=>"string"}, {"in"=>"query", "name"=>"ProjectionExpression", "description"=>"A string that identifies one or more attributes to retrieve from the table", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnConsumedCapacity", "description"=>"Determines the level of detail about provisioned throughput consumption that is returned in the response:", "type"=>"string"}, {"in"=>"query", "name"=>"TableName", "description"=>"The name of the table containing the requested item", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Items"]}}, "/?Action=ListTables"=>{"get"=>{"summary"=>"List Tables", "description"=>"Returns an array of table names associated with the current account and endpoint.", "operationId"=>"listTables", "x-api-path-slug"=>"actionlisttables-get", "parameters"=>[{"in"=>"query", "name"=>"ExclusiveStartTableName", "description"=>"The first table name that this operation will evaluate", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"A maximum number of table names to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tables"]}}, "/?Action=PutItem"=>{"get"=>{"summary"=>"Put Item", "description"=>"Creates a new item, or replaces an old item with a new item.", "operationId"=>"putItem", "x-api-path-slug"=>"actionputitem-get", "parameters"=>[{"in"=>"query", "name"=>"ConditionalOperator", "description"=>"This is a legacy parameter", "type"=>"string"}, {"in"=>"query", "name"=>"ConditionExpression", "description"=>"A condition that must be satisfied in order for a conditional PutItem operation to succeed", "type"=>"string"}, {"in"=>"query", "name"=>"Expected", "description"=>"This is a legacy parameter", "type"=>"string"}, {"in"=>"query", "name"=>"ExpressionAttributeNames", "description"=>"One or more substitution tokens for attribute names in an expression", "type"=>"string"}, {"in"=>"query", "name"=>"ExpressionAttributeValues", "description"=>"One or more values that can be substituted in an expression", "type"=>"string"}, {"in"=>"query", "name"=>"Item", "description"=>"A map of attribute name/value pairs, one for each attribute", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnConsumedCapacity", "description"=>"Determines the level of detail about provisioned throughput consumption that is returned in the response:", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnItemCollectionMetrics", "description"=>"Determines whether item collection metrics are returned", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnValues", "description"=>"Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request", "type"=>"string"}, {"in"=>"query", "name"=>"TableName", "description"=>"The name of the table to contain the item", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Items"]}}, "/?Action=Query"=>{"get"=>{"summary"=>"Query", "description"=>"A Query operation uses the primary key of a table or a secondary index\n to directly access items from that table or index.", "operationId"=>"query", "x-api-path-slug"=>"actionquery-get", "parameters"=>[{"in"=>"query", "name"=>"AttributesToGet", "description"=>"This is a legacy parameter", "type"=>"string"}, {"in"=>"query", "name"=>"ConditionalOperator", "description"=>"This is a legacy parameter", "type"=>"string"}, {"in"=>"query", "name"=>"ConsistentRead", "description"=>"Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads", "type"=>"string"}, {"in"=>"query", "name"=>"ExclusiveStartKey", "description"=>"The primary key of the first item that this operation will evaluate", "type"=>"string"}, {"in"=>"query", "name"=>"ExpressionAttributeNames", "description"=>"One or more substitution tokens for attribute names in an expression", "type"=>"string"}, {"in"=>"query", "name"=>"ExpressionAttributeValues", "description"=>"One or more values that can be substituted in an expression", "type"=>"string"}, {"in"=>"query", "name"=>"FilterExpression", "description"=>"A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you", "type"=>"string"}, {"in"=>"query", "name"=>"IndexName", "description"=>"The name of an index to query", "type"=>"string"}, {"in"=>"query", "name"=>"KeyConditionExpression", "description"=>"The condition that specifies the key value(s) for items to be retrieved by the Query action", "type"=>"string"}, {"in"=>"query", "name"=>"KeyConditions", "description"=>"This is a legacy parameter", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of items to evaluate (not necessarily the number of matching items)", "type"=>"string"}, {"in"=>"query", "name"=>"ProjectionExpression", "description"=>"A string that identifies one or more attributes to retrieve from the table", "type"=>"string"}, {"in"=>"query", "name"=>"QueryFilter", "description"=>"This is a legacy parameter", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnConsumedCapacity", "description"=>"Determines the level of detail about provisioned throughput consumption that is returned in the response:", "type"=>"string"}, {"in"=>"query", "name"=>"ScanIndexForward", "description"=>"Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order", "type"=>"string"}, {"in"=>"query", "name"=>"Select", "description"=>"The attributes to be returned in the result", "type"=>"string"}, {"in"=>"query", "name"=>"TableName", "description"=>"The name of the table containing the requested items", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Query"]}}, "/?Action=Scan"=>{"get"=>{"summary"=>"Scan", "description"=>"The Scan operation returns one or more items and item attributes by accessing every\n item in a table or a secondary index.", "operationId"=>"scan", "x-api-path-slug"=>"actionscan-get", "parameters"=>[{"in"=>"query", "name"=>"AttributesToGet", "description"=>"This is a legacy parameter", "type"=>"string"}, {"in"=>"query", "name"=>"ConditionalOperator", "description"=>"This is a legacy parameter", "type"=>"string"}, {"in"=>"query", "name"=>"ConsistentRead", "description"=>"A Boolean value that determines the read consistency model during the scan:", "type"=>"string"}, {"in"=>"query", "name"=>"ExclusiveStartKey", "description"=>"The primary key of the first item that this operation will evaluate", "type"=>"string"}, {"in"=>"query", "name"=>"ExpressionAttributeNames", "description"=>"One or more substitution tokens for attribute names in an expression", "type"=>"string"}, {"in"=>"query", "name"=>"ExpressionAttributeValues", "description"=>"One or more values that can be substituted in an expression", "type"=>"string"}, {"in"=>"query", "name"=>"FilterExpression", "description"=>"A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you", "type"=>"string"}, {"in"=>"query", "name"=>"IndexName", "description"=>"The name of a secondary index to scan", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of items to evaluate (not necessarily the number of matching items)", "type"=>"string"}, {"in"=>"query", "name"=>"ProjectionExpression", "description"=>"A string that identifies one or more attributes to retrieve from the specified table or index", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnConsumedCapacity", "description"=>"Determines the level of detail about provisioned throughput consumption that is returned in the response:", "type"=>"string"}, {"in"=>"query", "name"=>"ScanFilter", "description"=>"This is a legacy parameter", "type"=>"string"}, {"in"=>"query", "name"=>"Segment", "description"=>"For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker", "type"=>"string"}, {"in"=>"query", "name"=>"Select", "description"=>"The attributes to be returned in the result", "type"=>"string"}, {"in"=>"query", "name"=>"TableName", "description"=>"The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs", "type"=>"string"}, {"in"=>"query", "name"=>"TotalSegments", "description"=>"For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scan"]}}, "/?Action=UpdateItem"=>{"get"=>{"summary"=>"Update Item", "description"=>"Edits an existing item's attributes, or adds a new item to the table if it does not already exist.", "operationId"=>"updateItem", "x-api-path-slug"=>"actionupdateitem-get", "parameters"=>[{"in"=>"query", "name"=>"AttributeUpdates", "description"=>"This is a legacy parameter", "type"=>"string"}, {"in"=>"query", "name"=>"ConditionalOperator", "description"=>"This is a legacy parameter", "type"=>"string"}, {"in"=>"query", "name"=>"ConditionExpression", "description"=>"A condition that must be satisfied in order for a conditional update to succeed", "type"=>"string"}, {"in"=>"query", "name"=>"Expected", "description"=>"This is a legacy parameter", "type"=>"string"}, {"in"=>"query", "name"=>"ExpressionAttributeNames", "description"=>"One or more substitution tokens for attribute names in an expression", "type"=>"string"}, {"in"=>"query", "name"=>"ExpressionAttributeValues", "description"=>"One or more values that can be substituted in an expression", "type"=>"string"}, {"in"=>"query", "name"=>"Key", "description"=>"The primary key of the item to be updated", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnConsumedCapacity", "description"=>"Determines the level of detail about provisioned throughput consumption that is returned in the response:", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnItemCollectionMetrics", "description"=>"Determines whether item collection metrics are returned", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnValues", "description"=>"Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated", "type"=>"string"}, {"in"=>"query", "name"=>"TableName", "description"=>"The name of the table containing the item to update", "type"=>"string"}, {"in"=>"query", "name"=>"UpdateExpression", "description"=>"An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Items"]}}, "/?Action=UpdateTable"=>{"get"=>{"summary"=>"Update Table", "description"=>"Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.", "operationId"=>"updateTable", "x-api-path-slug"=>"actionupdatetable-get", "parameters"=>[{"in"=>"query", "name"=>"AttributeDefinitions", "description"=>"An array of attributes that describe the key schema for the table and indexes", "type"=>"string"}, {"in"=>"query", "name"=>"GlobalSecondaryIndexUpdates", "description"=>"An array of one or more global secondary indexes for the table", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisionedThroughput", "description"=>"The new provisioned throughput settings for the specified table or index", "type"=>"string"}, {"in"=>"query", "name"=>"StreamSpecification", "description"=>"Represents the DynamoDB Streams configuration for the table", "type"=>"string"}, {"in"=>"query", "name"=>"TableName", "description"=>"The name of the table to be updated", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tables"]}}}}, "apis"=>{"name"=>"AWS DynamoDB", "x-slug"=>"aws-dynamodb", "description"=>"Amazon DynamoDB is a fast and flexible NoSQL database service for all applications that need consistent, single-digit millisecond latency at any scale. It is a fully managed cloud database and supports both document and key-value store models. Its flexible data model and reliable performance make it a great fit for mobile, web, gaming, ad tech, IoT, and many other applications. Start today by downloading the local version of DynamoDB, then read our Getting Started Guide.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Database_AmazonDynamoDB.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Databases,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-dynamodb/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Amazon DynamoDB API", "x-api-slug"=>"amazon-dynamodb-api", "description"=>"Amazon DynamoDB is a fast and flexible NoSQL database service for all applications that need consistent, single-digit millisecond latency at any scale. It is a fully managed cloud database and supports both document and key-value store models. Its flexible data model and reliable performance make it a great fit for mobile, web, gaming, ad tech, IoT, and many other applications. Start today by downloading the local version of DynamoDB, then read our Getting Started Guide.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Database_AmazonDynamoDB.png", "humanURL"=>"https://aws.amazon.com/dynamodb/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Databases,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-dynamodb/amazon-dynamodb-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-best-practices", "url"=>"https://aws.amazon.com/dynamodb/developer-resources/#BestPractices"}, {"type"=>"x-blog", "url"=>"https://aws.amazon.com/dynamodb/developer-resources/#BlogPosts"}, {"type"=>"x-community", "url"=>"https://aws.amazon.com/dynamodb/community/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/Welcome.html"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/dynamodbstreams/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/dynamodb/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/dynamodb/getting-started/"}, {"type"=>"x-labs", "url"=>"https://aws.amazon.com/dynamodb/developer-resources/#SelfPacedLabs"}, {"type"=>"x-partners", "url"=>"https://aws.amazon.com/dynamodb/partners/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/dynamodb/pricing/"}, {"type"=>"x-sdk", "url"=>"https://aws.amazon.com/dynamodb/developer-resources/#SDK"}, {"type"=>"x-slides", "url"=>"https://aws.amazon.com/dynamodb/developer-resources/#Slides"}, {"type"=>"x-videos", "url"=>"https://aws.amazon.com/dynamodb/developer-resources/#Videos"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/dynamodb/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-data-lake-store{"azure-data-lake-store-api-openapi"=>false, "apis"=>{"name"=>"Azure Data Lake Store", "x-slug"=>"azure-data-lake-store", "description"=>"The Data Lake store provides a single repository where you can capture data of any size type and speed simply without forcing changes to your application as the data scales. In the store, data can be shared for collaboration with enterprise-grade security. It is also designed for high-performance processing and analytics from HDFS applications (ie. Azure HDInsight, Data Lake analytics service, Hortonworks, Cloudera, MapR) and tools, including support for low latency workloads. For example, data can be ingested in real-time from sensors and devices for IoT solutions, or from online shopping websites into the store without the restriction of fixed limits on account or file size unlike current offerings in the market.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-data-lake-store-01-petabyte.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Data,Databases,Microsoft,Profiles,Relative Data,Service API,Stack Network,Storage", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-data-lake-store/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Data Lake Store API", "x-api-slug"=>"azure-data-lake-store-api", "description"=>"The Data Lake store provides a single repository where you can capture data of any size type and speed simply without forcing changes to your application as the data scales. In the store, data can be shared for collaboration with enterprise-grade security. It is also designed for high-performance processing and analytics from HDFS applications (ie. Azure HDInsight, Data Lake analytics service, Hortonworks, Cloudera, MapR) and tools, including support for low latency workloads. For example, data can be ingested in real-time from sensors and devices for IoT solutions, or from online shopping websites into the store without the restriction of fixed limits on account or file size unlike current offerings in the market.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-data-lake-store-01-petabyte.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/data-lake-store/", "baseURL"=>":////", "tags"=>"API Provider,API Service Provider,Data,Databases,Microsoft,Profiles,Relative Data,Service API,Stack Network,Storage", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/azure-data-lake-store/azure-data-lake-store-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/data-lake-store/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/data-lake-store/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/data-lake-store/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/data-lake-store/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-user-accounts{"apis"=>{"name"=>"Google Cloud User Accounts", "x-slug"=>"google-cloud-user-accounts", "description"=>"Service for managing the global Google Cloud user accounts. This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-cloud-icon.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Authentication,Google APIs,Management,Profiles,Relative Data,Service API,Stack Network,Users", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-user-accounts/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud User Accounts API", "x-api-slug"=>"google-cloud-user-accounts-api", "description"=>"Service for managing the global Google Cloud user accounts. This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-cloud-icon.png", "humanURL"=>"https://cloud.google.com/compute/docs/access/user-accounts/api/latest/", "baseURL"=>"://www.googleapis.com//clouduseraccounts/vm_alpha/projects", "tags"=>"API Provider,API Service Provider,Authentication,Google APIs,Management,Profiles,Relative Data,Service API,Stack Network,Users", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-user-accounts/google-cloud-user-accounts-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-code", "url"=>"https://cloud.google.com/compute/docs/access/user-accounts/api/libraries"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/compute/docs/access/user-accounts/api/how-tos/how-tos"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/compute/docs/access/user-accounts/api/latest/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "google-cloud-user-accounts-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud User Accounts", "x-complete"=>1, "info"=>{"title"=>"Cloud User Accounts", "description"=>"creates-and-manages-users-and-groups-for-accessing-google-compute-engine-virtual-machines-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"vm_alpha"}, "host"=>"www.googleapis.com", "basePath"=>"/clouduseraccounts/vm_alpha/projects", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{project}/global/groups"=>{"get"=>{"summary"=>"Get Groups", "description"=>"Retrieves the list of groups contained within the specified project.", "operationId"=>"clouduseraccounts.groups.list", "x-api-path-slug"=>"projectglobalgroups-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}, "post"=>{"summary"=>"Create Group", "description"=>"Creates a Group resource in the specified project using the data included in the request.", "operationId"=>"clouduseraccounts.groups.insert", "x-api-path-slug"=>"projectglobalgroups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}}, "/{project}/global/groups/{groupName}"=>{"delete"=>{"summary"=>"Delete Group", "description"=>"Deletes the specified Group resource.", "operationId"=>"clouduseraccounts.groups.delete", "x-api-path-slug"=>"projectglobalgroupsgroupname-delete", "parameters"=>[{"in"=>"path", "name"=>"groupName", "description"=>"Name of the Group resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}, "get"=>{"summary"=>"Get Group", "description"=>"Returns the specified Group resource.", "operationId"=>"clouduseraccounts.groups.get", "x-api-path-slug"=>"projectglobalgroupsgroupname-get", "parameters"=>[{"in"=>"path", "name"=>"groupName", "description"=>"Name of the Group resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}}, "/{project}/global/groups/{groupName}/addMember"=>{"post"=>{"summary"=>"Add User To Group", "description"=>"Adds users to the specified group.", "operationId"=>"clouduseraccounts.groups.addMember", "x-api-path-slug"=>"projectglobalgroupsgroupnameaddmember-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"groupName", "description"=>"Name of the group for this request"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/{project}/global/groups/{groupName}/removeMember"=>{"post"=>{"summary"=>"Remove Use From Group", "description"=>"Removes users from the specified group.", "operationId"=>"clouduseraccounts.groups.removeMember", "x-api-path-slug"=>"projectglobalgroupsgroupnameremovemember-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"groupName", "description"=>"Name of the group for this request"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/{project}/global/groups/{resource}/getIamPolicy"=>{"get"=>{"summary"=>"Get IAM Policy", "description"=>"Gets the access control policy for a resource. May be empty if no such policy or resource exists.", "operationId"=>"clouduseraccounts.groups.getIamPolicy", "x-api-path-slug"=>"projectglobalgroupsresourcegetiampolicy-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"resource", "description"=>"Name of the resource for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}, "/{project}/global/groups/{resource}/setIamPolicy"=>{"post"=>{"summary"=>"Set IAM Policy", "description"=>"Sets the access control policy on the specified resource. Replaces any existing policy.", "operationId"=>"clouduseraccounts.groups.setIamPolicy", "x-api-path-slug"=>"projectglobalgroupsresourcesetiampolicy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"resource", "description"=>"Name of the resource for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}, "/{project}/global/groups/{resource}/testIamPermissions"=>{"post"=>{"summary"=>"Test IAM Permissions", "description"=>"Returns permissions that a caller has on the specified resource.", "operationId"=>"clouduseraccounts.groups.testIamPermissions", "x-api-path-slug"=>"projectglobalgroupsresourcetestiampermissions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"resource", "description"=>"Name of the resource for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}, "/{project}/global/operations"=>{"get"=>{"summary"=>"Get Operations", "description"=>"Retrieves the list of operation resources contained within the specified project.", "operationId"=>"clouduseraccounts.globalAccountsOperations.list", "x-api-path-slug"=>"projectglobaloperations-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/{project}/global/operations/{operation}"=>{"delete"=>{"summary"=>"Delete Operation", "description"=>"Deletes the specified operation resource.", "operationId"=>"clouduseraccounts.globalAccountsOperations.delete", "x-api-path-slug"=>"projectglobaloperationsoperation-delete", "parameters"=>[{"in"=>"path", "name"=>"operation", "description"=>"Name of the Operations resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}, "get"=>{"summary"=>"Get Operation", "description"=>"Retrieves the specified operation resource.", "operationId"=>"clouduseraccounts.globalAccountsOperations.get", "x-api-path-slug"=>"projectglobaloperationsoperation-get", "parameters"=>[{"in"=>"path", "name"=>"operation", "description"=>"Name of the Operations resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/{project}/global/users"=>{"get"=>{"summary"=>"Get Users", "description"=>"Retrieves a list of users contained within the specified project.", "operationId"=>"clouduseraccounts.users.list", "x-api-path-slug"=>"projectglobalusers-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "post"=>{"summary"=>"Create User", "description"=>"Creates a User resource in the specified project using the data included in the request.", "operationId"=>"clouduseraccounts.users.insert", "x-api-path-slug"=>"projectglobalusers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/{project}/global/users/{resource}/getIamPolicy"=>{"get"=>{"summary"=>"Get User IAM Policy", "description"=>"Gets the access control policy for a resource. May be empty if no such policy or resource exists.", "operationId"=>"clouduseraccounts.users.getIamPolicy", "x-api-path-slug"=>"projectglobalusersresourcegetiampolicy-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"resource", "description"=>"Name of the resource for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User IAM"]}}, "/{project}/global/users/{resource}/setIamPolicy"=>{"post"=>{"summary"=>"Set User IAM Policy", "description"=>"Sets the access control policy on the specified resource. Replaces any existing policy.", "operationId"=>"clouduseraccounts.users.setIamPolicy", "x-api-path-slug"=>"projectglobalusersresourcesetiampolicy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"resource", "description"=>"Name of the resource for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User IAM"]}}, "/{project}/global/users/{resource}/testIamPermissions"=>{"post"=>{"summary"=>"Test User IAM Permissions", "description"=>"Returns permissions that a caller has on the specified resource.", "operationId"=>"clouduseraccounts.users.testIamPermissions", "x-api-path-slug"=>"projectglobalusersresourcetestiampermissions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"resource", "description"=>"Name of the resource for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User IAM"]}}, "/{project}/global/users/{user}"=>{"delete"=>{"summary"=>"Delete User", "description"=>"Deletes the specified User resource.", "operationId"=>"clouduseraccounts.users.delete", "x-api-path-slug"=>"projectglobalusersuser-delete", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"user", "description"=>"Name of the user resource to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "get"=>{"summary"=>"Get User", "description"=>"Returns the specified User resource.", "operationId"=>"clouduseraccounts.users.get", "x-api-path-slug"=>"projectglobalusersuser-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"user", "description"=>"Name of the user resource to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/{project}/global/users/{user}/addPublicKey"=>{"post"=>{"summary"=>"Add Public Key", "description"=>"Adds a public key to the specified User resource with the data included in the request.", "operationId"=>"clouduseraccounts.users.addPublicKey", "x-api-path-slug"=>"projectglobalusersuseraddpublickey-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"user", "description"=>"Name of the user for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Public Key"]}}, "/{project}/global/users/{user}/removePublicKey"=>{"post"=>{"summary"=>"Remove Public Key", "description"=>"Removes the specified public key from the user.", "operationId"=>"clouduseraccounts.users.removePublicKey", "x-api-path-slug"=>"projectglobalusersuserremovepublickey-post", "parameters"=>[{"in"=>"query", "name"=>"fingerprint", "description"=>"The fingerprint of the public key to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"user", "description"=>"Name of the user for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Public Key"]}}, "/{project}/zones/{zone}/authorizedKeysView/{user}"=>{"post"=>{"summary"=>"Get Public Keys", "description"=>"Returns a list of authorized public keys for a specific user account.", "operationId"=>"clouduseraccounts.linux.getAuthorizedKeysView", "x-api-path-slug"=>"projectzoneszoneauthorizedkeysviewuser-post", "parameters"=>[{"in"=>"query", "name"=>"instance", "description"=>"The fully-qualified URL of the virtual machine requesting the view"}, {"in"=>"query", "name"=>"login", "description"=>"Whether the view was requested as part of a user-initiated login"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"user", "description"=>"The user account for which you want to get a list of authorized public keys"}, {"in"=>"path", "name"=>"zone", "description"=>"Name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Public Key"]}}, "/{project}/zones/{zone}/linuxAccountViews"=>{"post"=>{"summary"=>"Get Linux Account Views", "description"=>"Retrieves a list of user accounts for an instance within a specific project.", "operationId"=>"clouduseraccounts.linux.getLinuxAccountViews", "x-api-path-slug"=>"projectzoneszonelinuxaccountviews-post", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"instance", "description"=>"The fully-qualified URL of the virtual machine requesting the views"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"Name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Public Key"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
postmark{"postmark-account-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Postmark", "x-complete"=>1, "info"=>{"title"=>"Postmark Account-level", "description"=>"postmark-makes-sending-and-receiving-email-incredibly-easy--the-accountlevel-api-allows-users-toconfigure-all-servers-domains-and-sender-signatures-associated-with-an-account-", "version"=>"0.9.0"}, "host"=>"api.postmarkapp.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/domains"=>{"get"=>{"summary"=>"List Domains", "description"=>"List domains.", "operationId"=>"listDomains", "x-api-path-slug"=>"domains-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Number of records to return per request"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of records to skip"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}, "post"=>{"summary"=>"Create a Domain", "description"=>"Create a domain.", "operationId"=>"createDomain", "x-api-path-slug"=>"domains-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/domains/{domainid}"=>{"delete"=>{"summary"=>"Delete a Domain", "description"=>"Delete a domain.", "operationId"=>"deleteDomain", "x-api-path-slug"=>"domainsdomainid-delete", "parameters"=>[{"in"=>"path", "name"=>"domainid", "description"=>"The ID for the Domain that should be deleted by the request"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains", "Domainid"]}, "get"=>{"summary"=>"Get a Domain", "description"=>"Get a domain.", "operationId"=>"getDomain", "x-api-path-slug"=>"domainsdomainid-get", "parameters"=>[{"in"=>"path", "name"=>"domainid", "description"=>"The ID for the Domain that should be retrieved"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains", "Domainid"]}, "put"=>{"summary"=>"Update a Domain", "description"=>"Update a domain.", "operationId"=>"editDomain", "x-api-path-slug"=>"domainsdomainid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"domainid", "description"=>"The ID for the Domain that should be modified by the request"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains", "Domainid"]}}, "/domains/{domainid}/rotatedkim"=>{"post"=>{"summary"=>"Rotate DKIM Key", "description"=>"Creates a new DKIM key to replace your current key. Until the DNS entries are confirmed, \nthe new values will be in the `DKIMPendingHost` and `DKIMPendingTextValue` fields. \nAfter the new DKIM value is verified in DNS, the pending values will migrate to \n`DKIMTextValue` and `DKIMPendingTextValue` and Postmark will begin to sign emails \nwith the new DKIM key.", "operationId"=>"rotateDKIMKeyForDomain", "x-api-path-slug"=>"domainsdomainidrotatedkim-post", "parameters"=>[{"in"=>"path", "name"=>"domainid", "description"=>"The ID for the Sender Signature for which a new DKIM Key should be generated"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains", "Domainid", "Rotatedkim"]}}, "/domains/{domainid}/verifyspf"=>{"post"=>{"summary"=>"Request DNS Verification for SPF", "description"=>"Request dns verification for spf.", "operationId"=>"requestSPFVerificationForDomain", "x-api-path-slug"=>"domainsdomainidverifyspf-post", "parameters"=>[{"in"=>"path", "name"=>"domainid", "description"=>"The ID for the Domain for which SPF DNS records should be verified"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains", "Domainid", "Verifyspf"]}}, "/senders"=>{"get"=>{"summary"=>"List Sender Signatures", "description"=>"List sender signatures.", "operationId"=>"listSenderSignatures", "x-api-path-slug"=>"senders-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Number of records to return per request"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of records to skip"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Senders"]}, "post"=>{"summary"=>"Create a Sender Signature", "description"=>"Create a sender signature.", "operationId"=>"createSenderSignature", "x-api-path-slug"=>"senders-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Senders"]}}, "/senders/{signatureid}"=>{"delete"=>{"summary"=>"Delete a Sender Signature", "description"=>"Delete a sender signature.", "operationId"=>"deleteSenderSignature", "x-api-path-slug"=>"senderssignatureid-delete", "parameters"=>[{"in"=>"path", "name"=>"signatureid", "description"=>"The ID for the Sender Signature that should be deleted by the request"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Senders", "Signatureid"]}, "get"=>{"summary"=>"Get a Sender Signature", "description"=>"Get a sender signature.", "operationId"=>"getSenderSignature", "x-api-path-slug"=>"senderssignatureid-get", "parameters"=>[{"in"=>"path", "name"=>"signatureid", "description"=>"The ID for the Sender Signature that should be retrieved"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Senders", "Signatureid"]}, "put"=>{"summary"=>"Update a Sender Signature", "description"=>"Update a sender signature.", "operationId"=>"editSenderSignature", "x-api-path-slug"=>"senderssignatureid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"signatureid", "description"=>"The ID for the Sender Signature that should be modified by the request"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Senders", "Signatureid"]}}, "/senders/{signatureid}/requestnewdkim"=>{"post"=>{"summary"=>"Request a new DKIM Key", "description"=>"Requests a new DKIM key to be created. Until the DNS entries are confirmed, \nthe new values will be in the `DKIMPendingHost` and `DKIMPendingTextValue` fields. \nAfter the new DKIM value is verified in DNS, the pending values will migrate to \n`DKIMTextValue` and `DKIMPendingTextValue` and Postmark will begin to sign emails \nwith the new DKIM key.", "operationId"=>"requestNewDKIMKeyForSenderSignature", "x-api-path-slug"=>"senderssignatureidrequestnewdkim-post", "parameters"=>[{"in"=>"path", "name"=>"signatureid", "description"=>"The ID for the Sender Signature for which a new DKIM Key should be generated"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Senders", "Signatureid", "Requestnewdkim"]}}, "/senders/{signatureid}/resend"=>{"post"=>{"summary"=>"Resend Signature Confirmation Email", "description"=>"Resend signature confirmation email.", "operationId"=>"resendSenderSignatureConfirmationEmail", "x-api-path-slug"=>"senderssignatureidresend-post", "parameters"=>[{"in"=>"path", "name"=>"signatureid", "description"=>"The ID for the Sender Signature that should have its confirmation email resent"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Senders", "Signatureid", "Resend"]}}, "/senders/{signatureid}/verifyspf"=>{"post"=>{"summary"=>"Request DNS Verification for SPF", "description"=>"Request dns verification for spf.", "operationId"=>"requestSPFVerificationForSenderSignature", "x-api-path-slug"=>"senderssignatureidverifyspf-post", "parameters"=>[{"in"=>"path", "name"=>"signatureid", "description"=>"The ID for the Sender Signature for which SPF DNS records should be verified"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Senders", "Signatureid", "Verifyspf"]}}, "/servers"=>{"get"=>{"summary"=>"List servers", "description"=>"List servers.", "operationId"=>"listServers", "x-api-path-slug"=>"servers-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Number of servers to return per request"}, {"in"=>"query", "name"=>"name", "description"=>"Filter by a specific server name"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of servers to skip"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}, "post"=>{"summary"=>"Create a Server", "description"=>"Create a server.", "operationId"=>"createServer", "x-api-path-slug"=>"servers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}}, "/servers/{serverid}"=>{"delete"=>{"summary"=>"Delete a Server", "description"=>"Delete a server.", "operationId"=>"deleteServer", "x-api-path-slug"=>"serversserverid-delete", "parameters"=>[{"in"=>"path", "name"=>"serverid", "description"=>"The ID of the Server that should be deleted"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers", "Serverid"]}, "get"=>{"summary"=>"Get a Server", "description"=>"Get a server.", "operationId"=>"getServerInformation", "x-api-path-slug"=>"serversserverid-get", "parameters"=>[{"in"=>"path", "name"=>"serverid", "description"=>"The ID of the Server to get"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers", "Serverid"]}, "put"=>{"summary"=>"Edit a Server", "description"=>"Edit a server.", "operationId"=>"editServerInformation", "x-api-path-slug"=>"serversserverid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"serverid", "description"=>"The ID of the Server to update"}, {"in"=>"header", "name"=>"X-Postmark-Account-Token", "description"=>"The token associated with the Account on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers", "Serverid"]}}}}, "postmark-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Postmark", "x-complete"=>1, "info"=>{"title"=>"Postmark", "description"=>"send-emails-retrieve-bounces-and-start-accepting-inbound-emails-all-via-an-easytouse-http-api-", "version"=>"1.0.0"}, "host"=>"spamcheck.postmarkapp.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/email"=>{"parameters"=>{"summary"=>"Parameters Email", "description"=>"Parameters email.", "operationId"=>"parametersEmail", "x-api-path-slug"=>"email-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}, "post"=>{"summary"=>"Post Email", "description"=>"Sends e-mails. Currently Postmark supports JSON message format. The mail message format is:\n\n{\n \"From\" : \"sender@example.com\",\n \"To\" : \"receiver@example.com\",\n \"Cc\" : \"copied@example.com\",\n \"Bcc\": \"blank-copied@example.com\",\n \"Subject\" : \"Test\",\n \"Tag\" : \"Invitation\",\n \"HtmlBody\" : \"Hello\",\n \"TextBody\" : \"Hello\",\n \"ReplyTo\" : \"reply@example.com\",\n \"Headers\" : [{ \"Name\" : \"CUSTOM-HEADER\", \"Value\" : \"value\" }],\n \"Attachments\": [\n {\n \"Name\": \"readme.txt\",\n \"Content\": \"dGVzdCBjb250ZW50\",\n \"ContentType\": \"text/plain\"\n },\n {\n \"Name\": \"report.pdf\",\n \"Content\": \"dGVzdCBjb250ZW50\",\n \"ContentType\": \"application/octet-stream\"\n }\n ]\n}\n\nYou should pass the json encoded message in the body of the request. Both from and to accept name, in the format of John Doe . You can provide HtmlBody for html formatted messages, TextBody for plain text, or both for multipart. Multipart sends html with a text version for clients that don???t support html. Passing headers is optional.\n\n1. You should have a registered and confirmed sender signature with the sender email. Otherwise you will receive HTTP Response 422 (Unprocessable Entity).\n2. It is possible to override the Name in the sender signature through the API. This is useful if you want to use member???s information in the email while keeping your from email address. just pass the name in the From parameter, From: \"John Smith \".\n3. You can pass multiple recipient addresses in the ???To??? field and the optional ???Cc??? and ???Bcc??? fields. Separate multiple addresses with a comma. Note that Postmark has a limit of twenty recipients per message in total. You need to take care not to exceed that limit. Otherwise you will get an error.\n4. You can categorize outgoing email using the optional Tag property. If you use different tags for the different types of emails your application generates, you will be able to get detailed statistics for them through the Postmark user interface.\n\nAttachments\nAttachments are specified in the Attachments array property. An attachment is an object that has to provide the file name (via the Name property), the content type (ContentType property) and the actual binary data (Content property) that has to be sent with the message.\n\nThe name is the actual file name that will be displayed to the message recipient. Note that the file extension is important. To eliminate the possibility of spreading viruses or spyware we allow only a number of file types. That is, instead of using a list of forbidden files and risking an unanticipated file type spreading infections, we have taken the opposite approach ??? we whitelist document file types that we are certain are safe. Here is the list of allowed files:\n\n- Media files: gif, jpg, jpeg, png, swf, flv, avi, mpg, mp3, mp4, ogv, wav, rm, mov, psd, ai, tif, tiff\n- Documents: txt, rtf, htm, html, pdf, epub, mobi, doc, docx, ppt, pptx, xls, xlsx, ps, eps, iif\n- Miscellaneous: log, csv, ics, xml, zip\n\nContact us if you feel we need to whitelist a file that your application needs.\n\nThe content type is the MIME content type that email clients use to interpret various attachments such as: text/plain, text/html, image/jpeg, etc. Your code can either detect it by the file extension, use a third party library to infer it, ask the user to provide it or just default to application/octet-stream.\n\nThe binary data has to be transmitted as a base64-encoded string. Most programming languages and libraries have this built in e.g. Java, .NET, PHP, Ruby.\n\nYou can use SSL encryption by issuing requests to https://api.postmarkapp.com/email.\n\nSuccess\nIf all goes well, you will get back a JSON message looking a lot like:\n\n{\n \"ErrorCode\" : 0,\n \"Message\" : \"OK\",\n \"MessageID\" : \"b7bc2f4a-e38e-4336-af7d-e6c392c2f817\",\n \"SubmittedAt\" : \"2010-11-26T12:01:05.1794748-05:00\",\n \"To\" : \"receiver@example.com\"\n}\n\nNote the MessageID property. You can log it in your system and use it to associate the message you just sent to a possible bounce that you obtained from a bounce web hook or the bounce API.", "operationId"=>"postEmail", "x-api-path-slug"=>"email-post", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"The accepted type for the response"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"Content-Type", "description"=>"The content type of the request"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}}, "/email/batch"=>{"parameters"=>{"summary"=>"Parameters Email Batch", "description"=>"Parameters email batch.", "operationId"=>"parametersEmailBatch", "x-api-path-slug"=>"emailbatch-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Batch"]}, "post"=>{"summary"=>"Post Email Batch", "description"=>"While Postmark is focused on transactional email, we understand that developers with higher volumes or processing time constraints need to send their messages in batches. To facilitate this we provide a batching endpoint that permits you to send up to 500 well-formed Postmark messages in a single API call.\n \nThe format of the batched message is a JSON array containing multiple message requests like the following example:\n[\n {From: 'sender@example.com', To: 'receiver1@example.com', Subject: 'Postmark test #1', HtmlBody: 'Hello dear Postmark user.'},\n {From: 'sender@example.com', To: 'receiver2@example.com', Subject: 'Postmark test #2', HtmlBody: 'Hello dear Postmark user.'}\n]\n\nYou can use SSL encryption by issuing requests to https://api.postmarkapp.com/email/batch.\n\nSimilarly, you will receive a matching JSON array containing each response for the messages you sent in your batched call:\n\n[\n {\n \"ErrorCode\" : 0,\n \"Message\" : \"OK\",\n \"MessageID\" : \"b7bc2f4a-e38e-4336-af7d-e6c392c2f817\",\n \"SubmittedAt\" : \"2010-11-26T12:01:05.1794748-05:00\",\n \"To\" : \"receiver1@example.com\"\n },\n {\n \"ErrorCode\" : 0,\n \"Message\" : \"OK\",\n \"MessageID\" : \"e2ecbbfc-fe12-463d-b933-9fe22915106d\",\n \"SubmittedAt\" : \"2010-11-26T12:01:05.1794748-05:00\",\n \"To\" : \"receiver2@example.com\"\n },\n]", "operationId"=>"postEmailBatch", "x-api-path-slug"=>"emailbatch-post", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"The accepted type for the response"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"Content-Type", "description"=>"The content type of the request"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Batch"]}}, "/deliverystats"=>{"parameters"=>{"summary"=>"Parameters Deliverystats", "description"=>"Parameters deliverystats.", "operationId"=>"parametersDeliverystats", "x-api-path-slug"=>"deliverystats-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deliverystats"]}, "get"=>{"summary"=>"Get Deliverystats", "description"=>"Returns a summary of inactive emails and bounces by type.", "operationId"=>"getDeliverystats", "x-api-path-slug"=>"deliverystats-get", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"The accepted type for the response"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"The content type of the request"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deliverystats"]}}, "/bounces"=>{"parameters"=>{"summary"=>"Parameters Bounces", "description"=>"Parameters bounces.", "operationId"=>"parametersBounces", "x-api-path-slug"=>"bounces-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bounces"]}, "get"=>{"summary"=>"Get Bounces", "description"=>"Fetches a portion of bounces according to the specified input criteria. Supported filters: type, inactive, email like, tag. Paging: page_size (count), page_start (offset). Bounces are sorted by BouncedAt in a descending order.", "operationId"=>"getBounces", "x-api-path-slug"=>"bounces-get", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"The accepted type for the response"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"The content type of the request"}, {"in"=>"query", "name"=>"count", "description"=>"Number of bounces to return per request"}, {"in"=>"query", "name"=>"emailFilter", "description"=>"Filter by email address"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Filter messages starting from the date specified"}, {"in"=>"query", "name"=>"inactive", "description"=>"Filter by emails that were deactivated by Postmark due to the bounce"}, {"in"=>"query", "name"=>"messageID", "description"=>"Filter by messageID"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of bounces to skip"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"query", "name"=>"todate", "description"=>"Filter messages up to the date specified"}, {"in"=>"query", "name"=>"type", "description"=>"Filter by type of bounce"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bounces"]}}, "/bounces/{bounceID}"=>{"parameters"=>{"summary"=>"Parameters Bounces Bounce", "description"=>"Parameters bounces bounce.", "operationId"=>"parametersBouncesBounce", "x-api-path-slug"=>"bouncesbounceid-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bounces", "BounceID"]}, "get"=>{"summary"=>"Get Bounces Bounce", "description"=>"Gets details about a single bounce. Note that the bounce ID is a numeric value that you typically obtain after a getting a list of bounces.", "operationId"=>"getBouncesBounce", "x-api-path-slug"=>"bouncesbounceid-get", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"The accepted type for the response"}, {"in"=>"path", "name"=>"bounceid", "description"=>"The ID of the bounce to retrieve"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"The content type of the request"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bounces", "BounceID"]}}, "/bounces/{bounceID}/dump"=>{"parameters"=>{"summary"=>"Parameters Bounces Bounce Dump", "description"=>"Parameters bounces bounce dump.", "operationId"=>"parametersBouncesBounceDump", "x-api-path-slug"=>"bouncesbounceiddump-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bounces", "BounceID", "Dump"]}, "get"=>{"summary"=>"Get Bounces Bounce Dump", "description"=>"Returns the raw source of the bounce we accepted. If Postmark does not have a dump for that bounce, it will return an empty string.", "operationId"=>"getBouncesBounceDump", "x-api-path-slug"=>"bouncesbounceiddump-get", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"The accepted type for the response"}, {"in"=>"path", "name"=>"bounceid", "description"=>"The ID for the bounce dump to retrieve"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"The content type of the request"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bounces", "BounceID", "Dump"]}}, "/bounces/tags"=>{"parameters"=>{"summary"=>"Parameters Bounces Tags", "description"=>"Parameters bounces tags.", "operationId"=>"parametersBouncesTags", "x-api-path-slug"=>"bouncestags-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bounces", "Tags"]}, "get"=>{"summary"=>"Get Bounces Tags", "description"=>"Returns a list of tags used for the current server.", "operationId"=>"getBouncesTags", "x-api-path-slug"=>"bouncestags-get", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"The accepted type for the response"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"The content type of the request"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bounces", "Tags"]}}, "/bounces/{bounceID}/activate"=>{"parameters"=>{"summary"=>"Parameters Bounces Bounce Activate", "description"=>"Parameters bounces bounce activate.", "operationId"=>"parametersBouncesBounceActivate", "x-api-path-slug"=>"bouncesbounceidactivate-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bounces", "BounceID", "Activate"]}, "put"=>{"summary"=>"Put Bounces Bounce Activate", "description"=>"Activates a deactivated bounce. Note that you do not need to send anything in the request body.", "operationId"=>"putBouncesBounceActivate", "x-api-path-slug"=>"bouncesbounceidactivate-put", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"The accepted type for the response"}, {"in"=>"path", "name"=>"bounceid", "description"=>"The ID of the Bounce to activate"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"The content type of the request"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bounces", "BounceID", "Activate"]}}, "/server"=>{"parameters"=>{"summary"=>"Parameters Server", "description"=>"Parameters server.", "operationId"=>"parametersServer", "x-api-path-slug"=>"server-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server"]}, "get"=>{"summary"=>"Get Server", "description"=>"Gets the server details and figures out your unique InboundHash where you can forward your email. This can be found in the web app in your server's Credentials tab or via the API.", "operationId"=>"getServer", "x-api-path-slug"=>"server-get", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"The accepted type for the response"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"The content type of the request"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server"]}, "post"=>{"summary"=>"Post Server", "description"=>"Sets the URL where we should send JSON data. In order for your application receive the emails that we parse, you will need to tell Postmark where to send the JSON data for each inbound email it processes, which is done via an HTTP POST to a URL of your choice. You can set this URL in the Settings page for your Postmark server in the web app, or using the InboundHookUrl field in the API. It also lets you choose a domain that you would like to listen on for incoming email to be processed by Postmark. We recommend a separate subdomain, like inbound.yourdomain.com. Each server can listen to one unique domain, so make sure to set the X-Postmark-Server-Token to the correct server token in the API call below.", "operationId"=>"postServer", "x-api-path-slug"=>"server-post", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"The accepted type for the response"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"The content type of the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server"]}, "put"=>{"summary"=>"Put Server", "description"=>"Put server.", "operationId"=>"putServer", "x-api-path-slug"=>"server-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The settings that should be modified for the current server", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server"]}}, "/email/withTemplate"=>{"post"=>{"summary"=>"Post Email Withtemplate", "description"=>"Post email withtemplate.", "operationId"=>"postEmailWithtemplate", "x-api-path-slug"=>"emailwithtemplate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "WithTemplate"]}}, "/messages/inbound"=>{"get"=>{"summary"=>"Get Messages Inbound", "description"=>"Get messages inbound.", "operationId"=>"getMessagesInbound", "x-api-path-slug"=>"messagesinbound-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Number of messages to return per request"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Filter messages starting from the date specified"}, {"in"=>"query", "name"=>"fromemail", "description"=>"Filter by the sender email address"}, {"in"=>"query", "name"=>"mailboxhash", "description"=>"Filter by mailboxhash"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of messages to skip"}, {"in"=>"query", "name"=>"recipient", "description"=>"Filter by the user who was receiving the email"}, {"in"=>"query", "name"=>"status", "description"=>"Filter by status (`blocked`, `processed`, `queued`, `failed`, `scheduled`)"}, {"in"=>"query", "name"=>"subject", "description"=>"Filter by email subject"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"query", "name"=>"todate", "description"=>"Filter messages up to the date specified"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Inbound"]}}, "/messages/inbound/{messageid}/bypass"=>{"put"=>{"summary"=>"Put Messages Inbound Message Bypass", "description"=>"Put messages inbound message bypass.", "operationId"=>"putMessagesInboundMessageBypass", "x-api-path-slug"=>"messagesinboundmessageidbypass-put", "parameters"=>[{"in"=>"path", "name"=>"messageid", "description"=>"The ID of the message which should bypass inbound rules"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Inbound", "Messageid", "Bypass"]}}, "/messages/inbound/{messageid}/details"=>{"get"=>{"summary"=>"Get Messages Inbound Message Details", "description"=>"Get messages inbound message details.", "operationId"=>"getMessagesInboundMessageDetails", "x-api-path-slug"=>"messagesinboundmessageiddetails-get", "parameters"=>[{"in"=>"path", "name"=>"messageid", "description"=>"The ID of the message for which to details will be retrieved"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Inbound", "Messageid", "Details"]}}, "/messages/inbound/{messageid}/retry"=>{"put"=>{"summary"=>"Put Messages Inbound Message Retry", "description"=>"Put messages inbound message retry.", "operationId"=>"putMessagesInboundMessageRetry", "x-api-path-slug"=>"messagesinboundmessageidretry-put", "parameters"=>[{"in"=>"path", "name"=>"messageid", "description"=>"The ID of the inbound message on which we should retry processing"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Inbound", "Messageid", "Retry"]}}, "/messages/outbound"=>{"get"=>{"summary"=>"Get Messages Outbound", "description"=>"Get messages outbound.", "operationId"=>"getMessagesOutbound", "x-api-path-slug"=>"messagesoutbound-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Number of messages to return per request"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Filter messages starting from the date specified"}, {"in"=>"query", "name"=>"fromemail", "description"=>"Filter by the sender email address"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of messages to skip"}, {"in"=>"query", "name"=>"recipient", "description"=>"Filter by the user who was receiving the email"}, {"in"=>"query", "name"=>"status", "description"=>"Filter by status (`queued` or `sent`)"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"query", "name"=>"todate", "description"=>"Filter messages up to the date specified"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Outbound"]}}, "/messages/outbound/clicks"=>{"get"=>{"summary"=>"Get Messages Outbound Clicks", "description"=>"Get messages outbound clicks.", "operationId"=>"getMessagesOutboundClicks", "x-api-path-slug"=>"messagesoutboundclicks-get", "parameters"=>[{"in"=>"query", "name"=>"city", "description"=>"Filter by full name of region messages were opened in, i"}, {"in"=>"query", "name"=>"client_company", "description"=>"Filter by company, i"}, {"in"=>"query", "name"=>"client_family", "description"=>"Filter by client family, i"}, {"in"=>"query", "name"=>"client_name", "description"=>"Filter by client name, i"}, {"in"=>"query", "name"=>"count", "description"=>"Number of message clicks to return per request"}, {"in"=>"query", "name"=>"country", "description"=>"Filter by country messages were opened in, i"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of messages to skip"}, {"in"=>"query", "name"=>"os_company", "description"=>"Filter by company which produced the OS, i"}, {"in"=>"query", "name"=>"os_family", "description"=>"Filter by kind of OS used without specific version, i"}, {"in"=>"query", "name"=>"os_name", "description"=>"Filter by full OS name and specific version, i"}, {"in"=>"query", "name"=>"platform", "description"=>"Filter by platform, i"}, {"in"=>"query", "name"=>"recipient", "description"=>"Filter by To, Cc, Bcc"}, {"in"=>"query", "name"=>"region", "description"=>"Filter by full name of region messages were opened in, i"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Outbound", "Clicks"]}}, "/messages/outbound/clicks/{messageid}"=>{"get"=>{"summary"=>"Get Messages Outbound Clicks Message", "description"=>"Get messages outbound clicks message.", "operationId"=>"getMessagesOutboundClicksMessage", "x-api-path-slug"=>"messagesoutboundclicksmessageid-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Number of message clicks to return per request"}, {"in"=>"path", "name"=>"messageid", "description"=>"The ID of the Outbound Message for which click statistics should be retrieved"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of messages to skip"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Outbound", "Clicks", "Messageid"]}}, "/messages/outbound/opens"=>{"get"=>{"summary"=>"Get Messages Outbound Opens", "description"=>"Get messages outbound opens.", "operationId"=>"getMessagesOutboundOpens", "x-api-path-slug"=>"messagesoutboundopens-get", "parameters"=>[{"in"=>"query", "name"=>"city", "description"=>"Filter by full name of region messages were opened in, i"}, {"in"=>"query", "name"=>"client_company", "description"=>"Filter by company, i"}, {"in"=>"query", "name"=>"client_family", "description"=>"Filter by client family, i"}, {"in"=>"query", "name"=>"client_name", "description"=>"Filter by client name, i"}, {"in"=>"query", "name"=>"count", "description"=>"Number of message opens to return per request"}, {"in"=>"query", "name"=>"country", "description"=>"Filter by country messages were opened in, i"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of messages to skip"}, {"in"=>"query", "name"=>"os_company", "description"=>"Filter by company which produced the OS, i"}, {"in"=>"query", "name"=>"os_family", "description"=>"Filter by kind of OS used without specific version, i"}, {"in"=>"query", "name"=>"os_name", "description"=>"Filter by full OS name and specific version, i"}, {"in"=>"query", "name"=>"platform", "description"=>"Filter by platform, i"}, {"in"=>"query", "name"=>"recipient", "description"=>"Filter by To, Cc, Bcc"}, {"in"=>"query", "name"=>"region", "description"=>"Filter by full name of region messages were opened in, i"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Outbound", "Opens"]}}, "/messages/outbound/opens/{messageid}"=>{"get"=>{"summary"=>"Get Messages Outbound Opens Message", "description"=>"Get messages outbound opens message.", "operationId"=>"getMessagesOutboundOpensMessage", "x-api-path-slug"=>"messagesoutboundopensmessageid-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Number of message opens to return per request"}, {"in"=>"path", "name"=>"messageid", "description"=>"The ID of the Outbound Message for which open statistics should be retrieved"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of messages to skip"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Outbound", "Opens", "Messageid"]}}, "/messages/outbound/{messageid}/details"=>{"get"=>{"summary"=>"Get Messages Outbound Message Details", "description"=>"Get messages outbound message details.", "operationId"=>"getMessagesOutboundMessageDetails", "x-api-path-slug"=>"messagesoutboundmessageiddetails-get", "parameters"=>[{"in"=>"path", "name"=>"messageid", "description"=>"The ID of the message for which to retrieve details"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Outbound", "Messageid", "Details"]}}, "/messages/outbound/{messageid}/dump"=>{"get"=>{"summary"=>"Get Messages Outbound Message Dump", "description"=>"Get messages outbound message dump.", "operationId"=>"getMessagesOutboundMessageDump", "x-api-path-slug"=>"messagesoutboundmessageiddump-get", "parameters"=>[{"in"=>"path", "name"=>"messageid", "description"=>"The ID of the message for which to retrieve a dump"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Outbound", "Messageid", "Dump"]}}, "/stats/outbound"=>{"get"=>{"summary"=>"Get Stats Outbound", "description"=>"Get stats outbound.", "operationId"=>"getStatsOutbound", "x-api-path-slug"=>"statsoutbound-get", "parameters"=>[{"in"=>"query", "name"=>"fromdate", "description"=>"Filter stats starting from the date specified"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"query", "name"=>"todate", "description"=>"Filter stats up to the date specified"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Outbound"]}}, "/stats/outbound/bounces"=>{"get"=>{"summary"=>"Get Stats Outbound Bounces", "description"=>"Get stats outbound bounces.", "operationId"=>"getStatsOutboundBounces", "x-api-path-slug"=>"statsoutboundbounces-get", "parameters"=>[{"in"=>"query", "name"=>"fromdate", "description"=>"Filter stats starting from the date specified"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"query", "name"=>"todate", "description"=>"Filter stats up to the date specified"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Outbound", "Bounces"]}}, "/stats/outbound/clicks"=>{"get"=>{"summary"=>"Get Stats Outbound Clicks", "description"=>"Get stats outbound clicks.", "operationId"=>"getStatsOutboundClicks", "x-api-path-slug"=>"statsoutboundclicks-get", "parameters"=>[{"in"=>"query", "name"=>"fromdate", "description"=>"Filter stats starting from the date specified"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"query", "name"=>"todate", "description"=>"Filter stats up to the date specified"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Outbound", "Clicks"]}}, "/stats/outbound/clicks/browserfamilies"=>{"get"=>{"summary"=>"Get Stats Outbound Clicks Browserfamilies", "description"=>"Get stats outbound clicks browserfamilies.", "operationId"=>"getStatsOutboundClicksBrowserfamilies", "x-api-path-slug"=>"statsoutboundclicksbrowserfamilies-get", "parameters"=>[{"in"=>"query", "name"=>"fromdate", "description"=>"Filter stats starting from the date specified"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"query", "name"=>"todate", "description"=>"Filter stats up to the date specified"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Outbound", "Clicks", "Browserfamilies"]}}, "/stats/outbound/clicks/location"=>{"get"=>{"summary"=>"Get Stats Outbound Clicks Location", "description"=>"Get stats outbound clicks location.", "operationId"=>"getStatsOutboundClicksLocation", "x-api-path-slug"=>"statsoutboundclickslocation-get", "parameters"=>[{"in"=>"query", "name"=>"fromdate", "description"=>"Filter stats starting from the date specified"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"query", "name"=>"todate", "description"=>"Filter stats up to the date specified"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Outbound", "Clicks", "Location"]}}, "/stats/outbound/clicks/platforms"=>{"get"=>{"summary"=>"Get Stats Outbound Clicks Platforms", "description"=>"Get stats outbound clicks platforms.", "operationId"=>"getStatsOutboundClicksPlatforms", "x-api-path-slug"=>"statsoutboundclicksplatforms-get", "parameters"=>[{"in"=>"query", "name"=>"fromdate", "description"=>"Filter stats starting from the date specified"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"query", "name"=>"todate", "description"=>"Filter stats up to the date specified"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Outbound", "Clicks", "Platforms"]}}, "/stats/outbound/opens"=>{"get"=>{"summary"=>"Get Stats Outbound Opens", "description"=>"Get stats outbound opens.", "operationId"=>"getStatsOutboundOpens", "x-api-path-slug"=>"statsoutboundopens-get", "parameters"=>[{"in"=>"query", "name"=>"fromdate", "description"=>"Filter stats starting from the date specified"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"query", "name"=>"todate", "description"=>"Filter stats up to the date specified"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Outbound", "Opens"]}}, "/stats/outbound/opens/emailclients"=>{"get"=>{"summary"=>"Get Stats Outbound Opens Emailclients", "description"=>"Get stats outbound opens emailclients.", "operationId"=>"getStatsOutboundOpensEmailclients", "x-api-path-slug"=>"statsoutboundopensemailclients-get", "parameters"=>[{"in"=>"query", "name"=>"fromdate", "description"=>"Filter stats starting from the date specified"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"query", "name"=>"todate", "description"=>"Filter stats up to the date specified"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Outbound", "Opens", "Emailclients"]}}, "/stats/outbound/opens/platforms"=>{"get"=>{"summary"=>"Get Stats Outbound Opens Platforms", "description"=>"Get stats outbound opens platforms.", "operationId"=>"getStatsOutboundOpensPlatforms", "x-api-path-slug"=>"statsoutboundopensplatforms-get", "parameters"=>[{"in"=>"query", "name"=>"fromdate", "description"=>"Filter stats starting from the date specified"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"query", "name"=>"todate", "description"=>"Filter stats up to the date specified"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Outbound", "Opens", "Platforms"]}}, "/stats/outbound/opens/readtimes"=>{"get"=>{"summary"=>"Get Stats Outbound Opens Readtimes", "description"=>"Get stats outbound opens readtimes.", "operationId"=>"getStatsOutboundOpensReadtimes", "x-api-path-slug"=>"statsoutboundopensreadtimes-get", "parameters"=>[{"in"=>"query", "name"=>"fromdate", "description"=>"Filter stats starting from the date specified"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"query", "name"=>"todate", "description"=>"Filter stats up to the date specified"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Outbound", "Opens", "Readtimes"]}}, "/stats/outbound/sends"=>{"get"=>{"summary"=>"Get Stats Outbound Sends", "description"=>"Get stats outbound sends.", "operationId"=>"getStatsOutboundSends", "x-api-path-slug"=>"statsoutboundsends-get", "parameters"=>[{"in"=>"query", "name"=>"fromdate", "description"=>"Filter stats starting from the date specified"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"query", "name"=>"todate", "description"=>"Filter stats up to the date specified"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Outbound", "Sends"]}}, "/stats/outbound/spam"=>{"get"=>{"summary"=>"Get Stats Outbound Spam", "description"=>"Get stats outbound spam.", "operationId"=>"getStatsOutboundSpam", "x-api-path-slug"=>"statsoutboundspam-get", "parameters"=>[{"in"=>"query", "name"=>"fromdate", "description"=>"Filter stats starting from the date specified"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"query", "name"=>"todate", "description"=>"Filter stats up to the date specified"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Outbound", "Spam"]}}, "/stats/outbound/tracked"=>{"get"=>{"summary"=>"Get Stats Outbound Tracked", "description"=>"Get stats outbound tracked.", "operationId"=>"getStatsOutboundTracked", "x-api-path-slug"=>"statsoutboundtracked-get", "parameters"=>[{"in"=>"query", "name"=>"fromdate", "description"=>"Filter stats starting from the date specified"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by tag"}, {"in"=>"query", "name"=>"todate", "description"=>"Filter stats starting from the date specified"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Outbound", "Tracked"]}}, "/templates"=>{"get"=>{"summary"=>"Get Templates", "description"=>"Get templates.", "operationId"=>"getTemplates", "x-api-path-slug"=>"templates-get", "parameters"=>[{"in"=>"query", "name"=>"Count", "description"=>"The number of Templates to return"}, {"in"=>"query", "name"=>"Offset", "description"=>"The number of Templates to skip before returning results"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates"]}, "post"=>{"summary"=>"Post Templates", "description"=>"Post templates.", "operationId"=>"postTemplates", "x-api-path-slug"=>"templates-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates"]}}, "/templates/validate"=>{"post"=>{"summary"=>"Post Templates Valate", "description"=>"Post templates valate.", "operationId"=>"postTemplatesValate", "x-api-path-slug"=>"templatesvalidate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates", "Validate"]}}, "/templates/{templateid}"=>{"delete"=>{"summary"=>"Delete Templates Template", "description"=>"Delete templates template.", "operationId"=>"deleteTemplatesTemplate", "x-api-path-slug"=>"templatestemplateid-delete", "parameters"=>[{"in"=>"path", "name"=>"templateid", "description"=>"The ID for the Template you wish to delete"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates", "Templateid"]}, "get"=>{"summary"=>"Get Templates Template", "description"=>"Get templates template.", "operationId"=>"getTemplatesTemplate", "x-api-path-slug"=>"templatestemplateid-get", "parameters"=>[{"in"=>"path", "name"=>"templateid", "description"=>"The ID for the Template you wish to retrieve"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates", "Templateid"]}, "put"=>{"summary"=>"Put Templates Template", "description"=>"Put templates template.", "operationId"=>"putTemplatesTemplate", "x-api-path-slug"=>"templatestemplateid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"templateid", "description"=>"The ID for the Template you wish to update"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates", "Templateid"]}}, "/triggers/inboundrules"=>{"get"=>{"summary"=>"Get Triggers Inboundrules", "description"=>"Get triggers inboundrules.", "operationId"=>"getTriggersInboundrules", "x-api-path-slug"=>"triggersinboundrules-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Number of records to return per request"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of records to skip"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Triggers", "Inboundrules"]}, "post"=>{"summary"=>"Post Triggers Inboundrules", "description"=>"Post triggers inboundrules.", "operationId"=>"postTriggersInboundrules", "x-api-path-slug"=>"triggersinboundrules-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Triggers", "Inboundrules"]}}, "/triggers/inboundrules/{triggerid}"=>{"delete"=>{"summary"=>"Delete Triggers Inboundrules Trigger", "description"=>"Delete triggers inboundrules trigger.", "operationId"=>"deleteTriggersInboundrulesTrigger", "x-api-path-slug"=>"triggersinboundrulestriggerid-delete", "parameters"=>[{"in"=>"path", "name"=>"triggerid", "description"=>"The ID of the Inbound Rule that should be deleted"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Triggers", "Inboundrules", "Triggerid"]}}, "/triggers/tags"=>{"get"=>{"summary"=>"Get Triggers Tags", "description"=>"Get triggers tags.", "operationId"=>"getTriggersTags", "x-api-path-slug"=>"triggerstags-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Number of records to return per request"}, {"in"=>"query", "name"=>"match_name", "description"=>"Filter by delivery tag"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of records to skip"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Triggers", "Tags"]}, "post"=>{"summary"=>"Post Triggers Tags", "description"=>"Post triggers tags.", "operationId"=>"postTriggersTags", "x-api-path-slug"=>"triggerstags-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Triggers", "Tags"]}}, "/triggers/tags/{triggerid}"=>{"delete"=>{"summary"=>"Delete Triggers Tags Trigger", "description"=>"Delete triggers tags trigger.", "operationId"=>"deleteTriggersTagsTrigger", "x-api-path-slug"=>"triggerstagstriggerid-delete", "parameters"=>[{"in"=>"path", "name"=>"triggerid", "description"=>"The ID for the Tag Trigger that should be deleted"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Triggers", "Tags", "Triggerid"]}, "get"=>{"summary"=>"Get Triggers Tags Trigger", "description"=>"Get triggers tags trigger.", "operationId"=>"getTriggersTagsTrigger", "x-api-path-slug"=>"triggerstagstriggerid-get", "parameters"=>[{"in"=>"path", "name"=>"triggerid", "description"=>"The ID for the Tag Trigger for which data should be retrieved"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Triggers", "Tags", "Triggerid"]}, "put"=>{"summary"=>"Put Triggers Tags Trigger", "description"=>"Put triggers tags trigger.", "operationId"=>"putTriggersTagsTrigger", "x-api-path-slug"=>"triggerstagstriggerid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"triggerid", "description"=>"The ID of the Tag Trigger that should be modified by this request"}, {"in"=>"header", "name"=>"X-Postmark-Server-Token", "description"=>"The token associated with the Server on which this request will operate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Triggers", "Tags", "Triggerid"]}}, "/filter"=>{"post"=>{"summary"=>"Post Filter", "description"=>"Postmark???s spam API is a RESTfull interface to the Spam filter tool SpamAssassin (http://spamassassin.apache.org/). This can be used to pre or post process email content when it is used in your application. For instance, if you process incoming emails from your users you can first run it through the API to filter out junk and avoid clutter in your database and application. Keep in mind: This is free to use and may be updated, removed or changed at any time. For a detailed explanation of the report generated, as well as the test definitions, please visit the SpamAssassin test repository (http://spamassassin.apache.org/tests_3_3_x.html). The POST body must have an element \"email\" which is the raw dump of the email to be filtered, including all headers. And an element \"options\" which must either be \"long\" for a full report of processing rules, or \"short\" for a score request.", "operationId"=>"postFilter", "x-api-path-slug"=>"filter-post", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"The accepted type for the response"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"The content type of the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filter"]}}}}, "apis"=>{"name"=>"Postmark", "x-slug"=>"postmark", "description"=>"Trusted by thousands of developers, Postmark is a fast and reliable transactional email service. Send with Postmark to ensure your transactional emails get to the inbox on time, every time.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/638-postmark.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"87545", "tags"=>"Emails,Imports,Messages,Relative Data,Relative StreamRank,SaaS,Service API,Stack Network,Streams,Streams,Streams,Target,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"postmark/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Postmark", "x-api-slug"=>"postmark", "description"=>"Postmark helps deliver and track transactional emails for web applications. In a nutshell, the service replaces SMTP (or Sendmail) with a far more reliable, scalable and care-free environment. In addition, you can track statistics for number of emails sent, bounces and spam complaints.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/638-postmark.jpg", "humanURL"=>"http://postmarkapp.com", "baseURL"=>"https://spamcheck.postmarkapp.com//", "tags"=>"Emails,Imports,Messages,Relative Data,Relative StreamRank,SaaS,Service API,Stack Network,Streams,Streams,Streams,Target,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/postmark/postmark-openapi.yaml"}]}, {"name"=>"Postmark Account", "x-api-slug"=>"postmark-account", "description"=>"Trusted by thousands of developers, Postmark is a fast and reliable transactional email service. Send with Postmark to ensure your transactional emails get to the inbox on time, every time.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/638-postmark.jpg", "humanURL"=>"http://postmarkapp.com", "baseURL"=>"https://api.postmarkapp.com//", "tags"=>"Filter", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/postmark/postmark-account-openapi.yaml"}]}], "x-common"=>[{"type"=>"x--net-library", "url"=>"http://developer.postmarkapp.com/developer-official-libs.html#dot-net"}, {"type"=>"x-base", "url"=>"https://api.postmarkapp.com"}, {"type"=>"x-blog", "url"=>"http://blog.postmarkapp.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.postmarkapp.com/rss"}, {"type"=>"x-contact-form", "url"=>"http://support.postmarkapp.com/customer/portal/emails/new"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/postmark"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/postmark"}, {"type"=>"x-developer", "url"=>"http://developer.postmarkapp.com/"}, {"type"=>"x-email", "url"=>"support@postmarkapp.com"}, {"type"=>"x-email", "url"=>"451d9b70cf9364d23ff6f9d51d870251569e+ahoy@inbound.postmarkapp.com"}, {"type"=>"x-faq", "url"=>"http://support.postmarkapp.com/"}, {"type"=>"x-pricing", "url"=>"http://developer.postmarkapp.com/developer-api-messages.html"}, {"type"=>"x-privacy", "url"=>"https://postmarkapp.com/privacy-policy"}, {"type"=>"x-ruby-library", "url"=>"http://developer.postmarkapp.com/developer-official-libs.html#rails"}, {"type"=>"x-ruby-library", "url"=>"http://developer.postmarkapp.com/developer-official-libs.html#ruby"}, {"type"=>"x-selfservice-registration", "url"=>"https://postmarkapp.com/sign_up"}, {"type"=>"x-status", "url"=>"http://status.postmarkapp.com/"}, {"type"=>"x-terms-of-service", "url"=>"https://postmarkapp.com/terms-of-service"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/postmarkapp"}, {"type"=>"x-webhook", "url"=>"https://postmarkapp.com/developer/webhooks/webhooks-overview"}, {"type"=>"x-website", "url"=>"http://postmarkapp.com"}, {"type"=>"x-website", "url"=>"http://postmarkapp.com/"}, {"type"=>"x-website", "url"=>"https://postmarkapp.com"}, {"type"=>"x-wordpress-pdk", "url"=>"http://developer.postmarkapp.com/developer-official-libs.html#wordpress"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-dns{"google-cloud-dns-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud DNS", "x-complete"=>1, "info"=>{"title"=>"Google Cloud DNS", "description"=>"configures-and-serves-authoritative-dns-records-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"www.googleapis.com", "basePath"=>"/dns/v1/projects", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{project}"=>{"get"=>{"summary"=>"Get Project", "description"=>"Fetch the representation of an existing Project.", "operationId"=>"dns.projects.get", "x-api-path-slug"=>"project-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Identifies the project addressed by this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project"]}}, "/{project}/managedZones"=>{"get"=>{"summary"=>"Get Managed Zones", "description"=>"Enumerate ManagedZones that have been created but not yet deleted.", "operationId"=>"dns.managedZones.list", "x-api-path-slug"=>"projectmanagedzones-get", "parameters"=>[{"in"=>"query", "name"=>"dnsName", "description"=>"Restricts the list to return only zones with this domain name"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Optional"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Optional"}, {"in"=>"path", "name"=>"project", "description"=>"Identifies the project addressed by this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managed Zone"]}, "post"=>{"summary"=>"Create Managed Zone", "description"=>"Create a new ManagedZone.", "operationId"=>"dns.managedZones.create", "x-api-path-slug"=>"projectmanagedzones-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Identifies the project addressed by this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managed Zone"]}}, "/{project}/managedZones/{managedZone}"=>{"delete"=>{"summary"=>"Delete Managed Zone", "description"=>"Delete a previously created ManagedZone.", "operationId"=>"dns.managedZones.delete", "x-api-path-slug"=>"projectmanagedzonesmanagedzone-delete", "parameters"=>[{"in"=>"path", "name"=>"managedZone", "description"=>"Identifies the managed zone addressed by this request"}, {"in"=>"path", "name"=>"project", "description"=>"Identifies the project addressed by this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managed Zone"]}, "get"=>{"summary"=>"Get Managed Zone", "description"=>"Fetch the representation of an existing ManagedZone.", "operationId"=>"dns.managedZones.get", "x-api-path-slug"=>"projectmanagedzonesmanagedzone-get", "parameters"=>[{"in"=>"path", "name"=>"managedZone", "description"=>"Identifies the managed zone addressed by this request"}, {"in"=>"path", "name"=>"project", "description"=>"Identifies the project addressed by this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managed Zone"]}}, "/{project}/managedZones/{managedZone}/changes"=>{"get"=>{"summary"=>"List Managed Zone Changes", "description"=>"Enumerate Changes to a ResourceRecordSet collection.", "operationId"=>"dns.changes.list", "x-api-path-slug"=>"projectmanagedzonesmanagedzonechanges-get", "parameters"=>[{"in"=>"path", "name"=>"managedZone", "description"=>"Identifies the managed zone addressed by this request"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Optional"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Optional"}, {"in"=>"path", "name"=>"project", "description"=>"Identifies the project addressed by this request"}, {"in"=>"query", "name"=>"sortBy", "description"=>"Sorting criterion"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Sorting order direction: ascending or descending"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managed Zone"]}, "post"=>{"summary"=>"Create Managed Zone Change", "description"=>"Atomically update the ResourceRecordSet collection.", "operationId"=>"dns.changes.create", "x-api-path-slug"=>"projectmanagedzonesmanagedzonechanges-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"managedZone", "description"=>"Identifies the managed zone addressed by this request"}, {"in"=>"path", "name"=>"project", "description"=>"Identifies the project addressed by this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managed Zone"]}}, "/{project}/managedZones/{managedZone}/changes/{changeId}"=>{"get"=>{"summary"=>"Get Managed Zone Change", "description"=>"Fetch the representation of an existing Change.", "operationId"=>"dns.changes.get", "x-api-path-slug"=>"projectmanagedzonesmanagedzonechangeschangeid-get", "parameters"=>[{"in"=>"path", "name"=>"changeId", "description"=>"The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse"}, {"in"=>"path", "name"=>"managedZone", "description"=>"Identifies the managed zone addressed by this request"}, {"in"=>"path", "name"=>"project", "description"=>"Identifies the project addressed by this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managed Zone"]}}, "/{project}/managedZones/{managedZone}/rrsets"=>{"get"=>{"summary"=>"Get Managed Zone Resources", "description"=>"Enumerate ResourceRecordSets that have been created but not yet deleted.", "operationId"=>"dns.resourceRecordSets.list", "x-api-path-slug"=>"projectmanagedzonesmanagedzonerrsets-get", "parameters"=>[{"in"=>"path", "name"=>"managedZone", "description"=>"Identifies the managed zone addressed by this request"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Optional"}, {"in"=>"query", "name"=>"name", "description"=>"Restricts the list to return only records with this fully qualified domain name"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Optional"}, {"in"=>"path", "name"=>"project", "description"=>"Identifies the project addressed by this request"}, {"in"=>"query", "name"=>"type", "description"=>"Restricts the list to return only records of this type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managed Zone"]}}}}, "apis"=>{"name"=>"Google Cloud DNS", "x-slug"=>"google-cloud-dns", "description"=>"Google Cloud DNS is a scalable, reliable and managed authoritative Domain Name System (DNS) service running on the same infrastructure as Google. It has low latency, high availability and is a cost-effective way to make your applications and services available to your users. Cloud DNS translates requests for domain names like www.google.com into IP addresses like 74.125.29.101. Cloud DNS is programmable. You can easily publish and manage millions of DNS zones and records using our simple user interface, command-line interface or API.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/global-dns-network.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,DNS,Google APIs,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-dns/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud DNS API", "x-api-slug"=>"google-cloud-dns-api", "description"=>"Google Cloud DNS is a scalable, reliable and managed authoritative Domain Name System (DNS) service running on the same infrastructure as Google. It has low latency, high availability and is a cost-effective way to make your applications and services available to your users. Cloud DNS translates requests for domain names like www.google.com into IP addresses like 74.125.29.101. Cloud DNS is programmable. You can easily publish and manage millions of DNS zones and records using our simple user interface, command-line interface or API.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/global-dns-network.png", "humanURL"=>"https://cloud.google.com/dns/", "baseURL"=>"://www.googleapis.com//dns/v1/projects", "tags"=>"API Provider,API Service Provider,DNS,Google APIs,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-dns/google-cloud-dns-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://cloud.google.com/dns/docs/"}, {"type"=>"x-forum", "url"=>"https://groups.google.com/forum/#!forum/cloud-dns-discuss"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/dns/quickstart"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/dns/docs/how-to"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/dns/pricing"}, {"type"=>"x-rate-limits", "url"=>"https://cloud.google.com/dns/quota"}, {"type"=>"x-service-level-agreements", "url"=>"https://cloud.google.com/dns/sla"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/dns/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bloomington-indiana-311{"bloomington-indiana-311-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bloomington Indiana 311", "x-complete"=>1, "info"=>{"title"=>"\tBloomington Indiana Open311 GeoReport API", "description"=>"open311-allows-you-to-getpost-civic-information-of-cities-via-a-unified-interface--the-georeport-part-allows-you-to-submit-and-view-issues-at-the-public-local-space", "contact"=>{"name"=>"Open311 community", "url"=>"http://wiki.open311.org/GeoReport_v2/", "email"=>"discuss@lists.open311.org"}, "version"=>"1.0.0"}, "host"=>"bloomington.in.gov", "basePath"=>"/crm/open311/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/requests.{response_format}"=>{"get"=>{"summary"=>"Requests", "description"=>"Query the current status of multiple requests.", "operationId"=>"query-the-current-status-of-multiple-requests", "x-api-path-slug"=>"requests-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"Latest datetime to include in search"}, {"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON format", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"service_code", "description"=>"Specify the service type by calling the unique ID of the service_code"}, {"in"=>"query", "name"=>"service_request_id", "description"=>"To call multiple Service Requests at once, multiple service_request_id can be declared; comma delimited"}, {"in"=>"query", "name"=>"start_date", "description"=>"Earliest datetime to include in search"}, {"in"=>"query", "name"=>"status", "description"=>"Allows one to search for requests which have a specific status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Requests"]}, "post"=>{"summary"=>"Create Service Request", "description"=>"Submit a new request for with specific details of a single service. Must provide a location via lat/long or address_string or address_id", "operationId"=>"submit-a-new-request-for-with-specific-details-of-a-single-service-must-provide-a-location-via-latlo", "x-api-path-slug"=>"requests-response-format-post", "parameters"=>[{"in"=>"query", "name"=>"address_id"}, {"in"=>"query", "name"=>"address_string"}, {"in"=>"query", "name"=>"attribute", "description"=>"array of key/value responses based on Service Definitions"}, {"in"=>"query", "name"=>"lat", "description"=>"WGS-84 latitude"}, {"in"=>"query", "name"=>"long", "description"=>"WGS-84 longitude"}, {"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON format", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"service_code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Service", "Request"]}}, "/request/{service_request_id}.{response_format}"=>{"get"=>{"summary"=>"Current Status", "description"=>"Query the current status of an individual request", "operationId"=>"query-the-current-status-of-an-individual-request", "x-api-path-slug"=>"requestservice-request-id-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"service_request_id", "description"=>"Is specified in the main URL path rather than an added query string parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Current", "Status"]}}, "/services.{response_format}"=>{"get"=>{"summary"=>"Service Types", "description"=>"List acceptable service request types and their associated service codes. These request types can be unique to the city/jurisdiction.", "operationId"=>"list-acceptable-service-request-types-and-their-associated-service-codes-these-request-types-can-be-", "x-api-path-slug"=>"services-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON format", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Service", "Types"]}}, "/services/{service_code}.{response_format}"=>{"get"=>{"summary"=>"Definition Of A Service Type", "description"=>"Define attributes associated with a service code. These attributes can be unique to the city/jurisdiction.", "operationId"=>"define-attributes-associated-with-a-service-code-these-attributes-can-be-unique-to-the-cityjurisdict", "x-api-path-slug"=>"servicesservice-code-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON format", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"service_code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Definition", "Service", "Type"]}}, "/tokens/{token_id}.{response_format}"=>{"get"=>{"summary"=>"Id Of Service_request Via Token", "description"=>"Get the service_request_id from a temporary token. This is unnecessary if the response from creating a service request does not contain a token.", "operationId"=>"get-the-service-request-id-from-a-temporary-token-this-is-unnecessary-if-the-response-from-creating-", "x-api-path-slug"=>"tokenstoken-id-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"token_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Id", "Service", "Request", "Via", "Token"]}}}}, "apis"=>{"name"=>"Bloomington Indiana 311", "x-slug"=>"bloomington-indiana-311", "description"=>"The City of Bloomington ITS Department has developed and deployed a suite of lightweight tools for Open311.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2017-12-26 at 9.45.58 PM.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"311,API Provider,Profiles,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bloomington-indiana-311/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Bloomington Indiana 311", "x-api-slug"=>"bloomington-indiana-311", "description"=>"The City of Bloomington ITS Department has developed and deployed a suite of lightweight tools for Open311.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2017-12-26 at 9.45.58 PM.png", "humanURL"=>"https://bloomington.in.gov/open311", "baseURL"=>"https://bloomington.in.gov//crm/open311/v2/", "tags"=>"311,API Provider,Profiles,Streams,Streams", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/bloomington-indiana-311/bloomington-indiana-311-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-open-311-feed", "url"=>"https://bloomington.in.gov/crm/open311/v2/services.xml?jurisdiction_id=bloomington.in.gov"}, {"type"=>"x-twitter", "url"=>"http://twitter.com/bloomington_its"}, {"type"=>"x-website", "url"=>"https://bloomington.in.gov/open311"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-ec2-container-registry-service{"aws-ec2-container-registry-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS EC2 Container Registry Service", "x-complete"=>1, "info"=>{"title"=>"AWS EC2 Container Registry API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=BatchCheckLayerAvailability"=>{"get"=>{"summary"=>"Batch Check Layer Availability", "description"=>"Check the availability of multiple image layers in a specified registry and repository.", "operationId"=>"batchCheckLayerAvailability", "x-api-path-slug"=>"actionbatchchecklayeravailability-get", "parameters"=>[{"in"=>"query", "name"=>"layerDigests", "description"=>"The digests of the image layers to check", "type"=>"string"}, {"in"=>"query", "name"=>"registryId", "description"=>"The AWS account ID associated with the registry that contains the image layers to check", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository that is associated with the image layers to check", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layer Availability"]}}, "/?Action=BatchDeleteImage"=>{"get"=>{"summary"=>"Batch Delete Image", "description"=>"Deletes a list of specified images within a specified repository.", "operationId"=>"batchDeleteImage", "x-api-path-slug"=>"actionbatchdeleteimage-get", "parameters"=>[{"in"=>"query", "name"=>"imageIds", "description"=>"A list of image ID references that correspond to images to delete", "type"=>"string"}, {"in"=>"query", "name"=>"registryId", "description"=>"The AWS account ID associated with the registry that contains the image to delete", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"The repository that contains the image to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image"]}}, "/?Action=BatchGetImage"=>{"get"=>{"summary"=>"Batch Get Image", "description"=>"Gets detailed information for specified images within a specified repository.", "operationId"=>"batchGetImage", "x-api-path-slug"=>"actionbatchgetimage-get", "parameters"=>[{"in"=>"query", "name"=>"acceptedMediaTypes", "description"=>"The accepted media types for the request", "type"=>"string"}, {"in"=>"query", "name"=>"imageIds", "description"=>"A list of image ID references that correspond to images to describe", "type"=>"string"}, {"in"=>"query", "name"=>"registryId", "description"=>"The AWS account ID associated with the registry that contains the images to describe", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"The repository that contains the images to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image"]}}, "/?Action=CompleteLayerUpload"=>{"get"=>{"summary"=>"Complete Layer Upload", "description"=>"Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has completed.", "operationId"=>"completeLayerUpload", "x-api-path-slug"=>"actioncompletelayerupload-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layer Upload"]}}, "/?Action=CreateRepository"=>{"get"=>{"summary"=>"Create Repository", "description"=>"Creates an image repository.", "operationId"=>"createRepository", "x-api-path-slug"=>"actioncreaterepository-get", "parameters"=>[{"in"=>"query", "name"=>"repositoryName", "description"=>"The name to use for the repository", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories"]}}, "/?Action=DeleteRepository"=>{"get"=>{"summary"=>"Delete Repository", "description"=>"Deletes an existing image repository.", "operationId"=>"deleteRepository", "x-api-path-slug"=>"actiondeleterepository-get", "parameters"=>[{"in"=>"query", "name"=>"force", "description"=>"Force the deletion of the repository if it contains images", "type"=>"string"}, {"in"=>"query", "name"=>"registryId", "description"=>"The AWS account ID associated with the registry that contains the repository to delete", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories"]}}, "/?Action=DeleteRepositoryPolicy"=>{"get"=>{"summary"=>"Delete Repository Policy", "description"=>"Deletes the repository policy from a specified repository.", "operationId"=>"deleteRepositoryPolicy", "x-api-path-slug"=>"actiondeleterepositorypolicy-get", "parameters"=>[{"in"=>"query", "name"=>"registryId", "description"=>"The AWS account ID associated with the registry that contains the repository policy to delete", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository that is associated with the repository policy to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repository Policies"]}}, "/?Action=DescribeImages"=>{"get"=>{"summary"=>"Describe Images", "description"=>"Returns metadata about the images in a repository, including image size, image\n tags, and creation date.", "operationId"=>"describeImages", "x-api-path-slug"=>"actiondescribeimages-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"The filter key and value with which to filter your DescribeImages results", "type"=>"string"}, {"in"=>"query", "name"=>"imageIds", "description"=>"The list of image IDs for the requested repository", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of repository results returned by DescribeImages in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The nextToken value returned from a previous paginated DescribeImages request where maxResults was used and the results exceeded the value of that parameter", "type"=>"string"}, {"in"=>"query", "name"=>"registryId", "description"=>"The AWS account ID associated with the registry that contains the repository in which to describe images", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"A list of repositories to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images"]}}, "/?Action=DescribeRepositories"=>{"get"=>{"summary"=>"Describe Repositories", "description"=>"Describes image repositories in a registry.", "operationId"=>"describeRepositories", "x-api-path-slug"=>"actiondescriberepositories-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of repository results returned by DescribeRepositories in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The nextToken value returned from a previous paginated DescribeRepositories request where maxResults was used and the results exceeded the value of that parameter", "type"=>"string"}, {"in"=>"query", "name"=>"registryId", "description"=>"The AWS account ID associated with the registry that contains the repositories to be described", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryNames", "description"=>"A list of repositories to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories"]}}, "/?Action=GetAuthorizationToken"=>{"get"=>{"summary"=>"Get Authorization Token", "description"=>"Retrieves a token that is valid for a specified registry for 12 hours.", "operationId"=>"getAuthorizationToken", "x-api-path-slug"=>"actiongetauthorizationtoken-get", "parameters"=>[{"in"=>"query", "name"=>"registryIds", "description"=>"A list of AWS account IDs that are associated with the registries for which to get authorization tokens", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorization Tokens"]}}, "/?Action=GetDownloadUrlForLayer"=>{"get"=>{"summary"=>"Get Download Url For Layer", "description"=>".Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.", "operationId"=>"getDownloadUrlForLayer", "x-api-path-slug"=>"actiongetdownloadurlforlayer-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layers"]}}, "/?Action=GetRepositoryPolicy"=>{"get"=>{"summary"=>"Get Repository Policy", "description"=>"Retrieves the repository policy for a specified repository.", "operationId"=>"getRepositoryPolicy", "x-api-path-slug"=>"actiongetrepositorypolicy-get", "parameters"=>[{"in"=>"query", "name"=>"registryId", "description"=>"The AWS account ID associated with the registry that contains the repository", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository whose policy you want to retrieve", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repository Policies"]}}, "/?Action=InitiateLayerUpload"=>{"get"=>{"summary"=>"Initiate Layer Upload", "description"=>"Notify Amazon ECR that you intend to upload an image layer.", "operationId"=>"initiateLayerUpload", "x-api-path-slug"=>"actioninitiatelayerupload-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layer Upload"]}}, "/?Action=ListImages"=>{"get"=>{"summary"=>"List Images", "description"=>"Lists all the image IDs for a given repository.", "operationId"=>"listImages", "x-api-path-slug"=>"actionlistimages-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"The filter key and value with which to filter your ListImages results", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of image results returned by ListImages in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The nextToken value returned from a previous paginated ListImages request where maxResults was used and the results exceeded the value of that parameter", "type"=>"string"}, {"in"=>"query", "name"=>"registryId", "description"=>"The AWS account ID associated with the registry that contains the repository to list images in", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"The repository whose image IDs are to be listed", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images"]}}, "/?Action=PutImage"=>{"get"=>{"summary"=>"Put Image", "description"=>"Creates or updates the image manifest and tags associated with an image.", "operationId"=>"putImage", "x-api-path-slug"=>"actionputimage-get", "parameters"=>[{"in"=>"query", "name"=>"imageManifest", "description"=>"The image manifest corresponding to the image to be uploaded", "type"=>"string"}, {"in"=>"query", "name"=>"imageTag", "description"=>"The tag to associate with the image", "type"=>"string"}, {"in"=>"query", "name"=>"registryId", "description"=>"The AWS account ID associated with the registry that contains the repository in which to put the image", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository in which to put the image", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images"]}}, "/?Action=SetRepositoryPolicy"=>{"get"=>{"summary"=>"Set Repository Policy", "description"=>"Applies a repository policy on a specified repository to control access permissions.", "operationId"=>"setRepositoryPolicy", "x-api-path-slug"=>"actionsetrepositorypolicy-get", "parameters"=>[{"in"=>"query", "name"=>"force", "description"=>"If the policy you are attempting to set on a repository policy would prevent you from setting another policy in the future, you must force the SetRepositoryPolicy operation", "type"=>"string"}, {"in"=>"query", "name"=>"policyText", "description"=>"The JSON repository policy text to apply to the repository", "type"=>"string"}, {"in"=>"query", "name"=>"registryId", "description"=>"The AWS account ID associated with the registry that contains the repository", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository to receive the policy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repository Policies"]}}, "/?Action=UploadLayerPart"=>{"get"=>{"summary"=>"Upload Layer Part", "description"=>"Uploads an image layer part to Amazon ECR.", "operationId"=>"uploadLayerPart", "x-api-path-slug"=>"actionuploadlayerpart-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layer Parts"]}}}}, "apis"=>{"name"=>"AWS EC2 Container Registry Service", "x-slug"=>"aws-ec2-container-registry-service", "description"=>"Amazon EC2 Container Registry (ECR) is a fully-managedDockercontainer registry that makes it easy for developers to store, manage, and deploy Docker container images. Amazon ECR is integrated withAmazon EC2 Container Service (ECS), simplifying your development to production workflow. Amazon ECR eliminates the need to operate your own container repositories or worry about scaling the underlying infrastructure. Amazon ECR hosts your images in a highly available and scalable architecture, allowing you to reliably deploy containers for your applications. Integration with AWS Identity and Access Management (IAM) provides resource-level control of each repository. With Amazon ECR, there are no upfront fees or commitments. You pay only for the amount of data you store in your repositories and data transferred to the Internet.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_AmazonECR.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Containers,Discovery,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-ec2-container-registry-service/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS EC2 Container Registry API", "x-api-slug"=>"aws-ec2-container-registry-api", "description"=>"Amazon EC2 Container Registry (ECR) is a fully-managedDockercontainer registry that makes it easy for developers to store, manage, and deploy Docker container images. Amazon ECR is integrated withAmazon EC2 Container Service (ECS), simplifying your development to production workflow. Amazon ECR eliminates the need to operate your own container repositories or worry about scaling the underlying infrastructure. Amazon ECR hosts your images in a highly available and scalable architecture, allowing you to reliably deploy containers for your applications. Integration with AWS Identity and Access Management (IAM) provides resource-level control of each repository. With Amazon ECR, there are no upfront fees or commitments. You pay only for the amount of data you store in your repositories and data transferred to the Internet.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_AmazonECR.png", "humanURL"=>"https://aws.amazon.com/ecr/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Containers,Discovery,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-ec2-container-registry-service/actionuploadlayerpart-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-ec2-container-registry-service/aws-ec2-container-registry-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/AmazonECR/latest/APIReference/Welcome.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/ecr/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/ecr/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/ecr/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/ecr/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
netlicensing{"netlicensing-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"NetLicensing", "x-complete"=>1, "info"=>{"title"=>"NetLicensing", "description"=>"the-labs64-netlicensing-restful-api-gives-you-access-to-netlicensings-core-features--you-authenticate-to-the-netlicensing-api-by-providing-your-account-credentials-or-simply-use-our-demo-account--find-out-more-about-labs64-netlicensing-at-netlicensing-io-", "termsOfService"=>"https://www.labs64.com/legal/terms-of-service/netlicensing", "version"=>"2.x"}, "host"=>"go.netlicensing.io", "basePath"=>"/core/v2/rest", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/license"=>{"get"=>{"summary"=>"Licenses list", "description"=>"Return a list of all licenses for the current vendor", "operationId"=>"listLicenses", "x-api-path-slug"=>"license-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License"]}, "post"=>{"summary"=>"Create license", "description"=>"Creates a new license", "operationId"=>"createLicense", "x-api-path-slug"=>"license-post", "parameters"=>[{"in"=>"formData", "name"=>"active"}, {"in"=>"formData", "name"=>"currency", "description"=>"Specifies currency for the license price"}, {"in"=>"formData", "name"=>"hidden", "description"=>"If set to true, this license is not shown in NetLicensing Shop as purchased license"}, {"in"=>"formData", "name"=>"licenseeNumber"}, {"in"=>"formData", "name"=>"licenseTemplateNumber"}, {"in"=>"formData", "name"=>"name", "description"=>"Name for the licensed item"}, {"in"=>"formData", "name"=>"number"}, {"in"=>"formData", "name"=>"parentfeature", "description"=>"Mandatory for TIMEVOLUME license type and RENTAL licensing model"}, {"in"=>"formData", "name"=>"price", "description"=>"Price for the license"}, {"in"=>"formData", "name"=>"startDate", "description"=>"Mandatory for TIMEVOLUME license type"}, {"in"=>"formData", "name"=>"timeVolume", "description"=>"Mandatory for TIMEVOLUME license type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License"]}}, "/license/{licenseNumber}"=>{"delete"=>{"summary"=>"Delete license", "description"=>"Delete license by a licenseNumber", "operationId"=>"deleteLicense", "x-api-path-slug"=>"licenselicensenumber-delete", "parameters"=>[{"in"=>"path", "name"=>"licenseNumber", "description"=>"Unique number (across all products/licensees of a vendor) that identifies the license"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License", "LicenseNumber"]}, "get"=>{"summary"=>"Get license", "description"=>"Get license by a licenseNumber", "operationId"=>"getLicense", "x-api-path-slug"=>"licenselicensenumber-get", "parameters"=>[{"in"=>"path", "name"=>"licenseNumber", "description"=>"Unique number (across all products/licensees of a vendor) that identifies the license"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License", "LicenseNumber"]}, "post"=>{"summary"=>"Update license", "description"=>"Update license by a licenseNumber", "operationId"=>"updateLicense", "x-api-path-slug"=>"licenselicensenumber-post", "parameters"=>[{"in"=>"formData", "name"=>"active"}, {"in"=>"formData", "name"=>"currency", "description"=>"Specifies currency for the license price"}, {"in"=>"formData", "name"=>"hidden", "description"=>"If set to true, this license is not shown in NetLicensing Shop as purchased license"}, {"in"=>"path", "name"=>"licenseNumber", "description"=>"Unique number (across all products/licensees of a vendor) that identifies the license"}, {"in"=>"formData", "name"=>"name", "description"=>"Name for the licensed item"}, {"in"=>"formData", "name"=>"number", "description"=>"Unique number (across all products/licensees of a vendor) that identifies the license"}, {"in"=>"formData", "name"=>"parentfeature"}, {"in"=>"formData", "name"=>"price", "description"=>"Price for the license"}, {"in"=>"formData", "name"=>"startDate", "description"=>"for TIMEVOLUME licenseType"}, {"in"=>"formData", "name"=>"timeVolume"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License", "LicenseNumber"]}}, "/licensee"=>{"get"=>{"summary"=>"Licensees list", "description"=>"Return a list of all licensees for the current vendor", "operationId"=>"listLicensees", "x-api-path-slug"=>"licensee-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licensee"]}, "post"=>{"summary"=>"Create licensee", "description"=>"Creates a new licensee", "operationId"=>"createLicensee", "x-api-path-slug"=>"licensee-post", "parameters"=>[{"in"=>"formData", "name"=>"active", "description"=>"If set to false, the licensee is disabled"}, {"in"=>"formData", "name"=>"licenseeSecret", "description"=>"Licensee Secret for licensee"}, {"in"=>"formData", "name"=>"markedForTransfer", "description"=>"Mark licensee for transfer"}, {"in"=>"formData", "name"=>"name"}, {"in"=>"formData", "name"=>"number", "description"=>"Unique number (across all products of a vendor) that identifies the licensee"}, {"in"=>"formData", "name"=>"productNumber", "description"=>"productNumber to assign new licensee object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licensee"]}}, "/licensee/{licenseeNumber}"=>{"delete"=>{"summary"=>"Delete licensee", "description"=>"Delete a licensee by number", "operationId"=>"deleteLicensee", "x-api-path-slug"=>"licenseelicenseenumber-delete", "parameters"=>[{"in"=>"query", "name"=>"forceCascade", "description"=>"Force object deletion and all descendants"}, {"in"=>"path", "name"=>"licenseeNumber", "description"=>"Unique number (across all products of a vendor) that identifies the licensee"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licensee", "LicenseeNumber"]}, "get"=>{"summary"=>"Get licensee", "description"=>"Return a licensee by licenseeNumber", "operationId"=>"getLicensee", "x-api-path-slug"=>"licenseelicenseenumber-get", "parameters"=>[{"in"=>"path", "name"=>"licenseeNumber", "description"=>"Unique number (across all products of a vendor) that identifies the licensee"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licensee", "LicenseeNumber"]}, "post"=>{"summary"=>"Update licensee", "description"=>"Sets the provided properties to a licensee. Return an updated licensee", "operationId"=>"updateLicensee", "x-api-path-slug"=>"licenseelicenseenumber-post", "parameters"=>[{"in"=>"formData", "name"=>"active", "description"=>"If set to false, the licensee is disabled"}, {"in"=>"path", "name"=>"licenseeNumber", "description"=>"Unique number (across all products of a vendor) that identifies the licensee"}, {"in"=>"formData", "name"=>"licenseeSecret", "description"=>"Licensee Secret for licensee"}, {"in"=>"formData", "name"=>"markedForTransfer", "description"=>"Mark licensee for transfer"}, {"in"=>"formData", "name"=>"name"}, {"in"=>"formData", "name"=>"number", "description"=>"New licensee number (update)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licensee", "LicenseeNumber"]}}, "/licensee/{licenseeNumber}/transfer"=>{"post"=>{"summary"=>"Transfer licenses", "description"=>"Licenses transfer between licensees", "operationId"=>"transferLicenses", "x-api-path-slug"=>"licenseelicenseenumbertransfer-post", "parameters"=>[{"in"=>"path", "name"=>"licenseeNumber", "description"=>"Licensee number with a maximum length of 1000 characters"}, {"in"=>"formData", "name"=>"sourceLicenseeNumber", "description"=>"Licensee number which licenses to be transferred"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licensee", "LicenseeNumber", "Transfer"]}}, "/licensee/{licenseeNumber}/validate"=>{"post"=>{"summary"=>"Validate licensee", "description"=>"Validates active licenses of the licensee", "operationId"=>"validateLicensee", "x-api-path-slug"=>"licenseelicenseenumbervalidate-post", "parameters"=>[{"in"=>"formData", "name"=>"licenseeName", "description"=>"Human-readable name for the auto-created licensee (will be set as custom Licensee property)"}, {"in"=>"path", "name"=>"licenseeNumber", "description"=>"Licensee number with a maximum length of 1000 characters"}, {"in"=>"formData", "name"=>"licenseeSecret", "description"=>"Licensee Secret key for licensee"}, {"in"=>"formData", "name"=>"productNumber", "description"=>"Product number, must be provided when licensee auto-create is enabled (see also Product JavaDoc)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licensee", "LicenseeNumber", "Validate"]}, "get"=>{"summary"=>"Validate licensee", "description"=>"Validates active licenses of the licensee", "operationId"=>"validateLicensee", "x-api-path-slug"=>"licenseelicenseenumbervalidate-get", "parameters"=>[{"in"=>"query", "name"=>"licenseeName", "description"=>"Human-readable name for the auto-created licensee (will be set as custom Licensee property)"}, {"in"=>"path", "name"=>"licenseeNumber", "description"=>"Licensee number with a maximum length of 1000 characters"}, {"in"=>"query", "name"=>"productNumber", "description"=>"Product number, must be provided when licensee auto-create is enabled (see also Product JavaDoc)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licensee", "LicenseeNumber", "Validate"]}}, "/licensetemplate"=>{"get"=>{"summary"=>"License Templates list", "description"=>"Return a list of all license templates for the current vendor", "operationId"=>"listLicenseTemplates", "x-api-path-slug"=>"licensetemplate-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licensetemplate"]}, "post"=>{"summary"=>"Create license template", "description"=>"Creates a new license template", "operationId"=>"createLicenseTemplate", "x-api-path-slug"=>"licensetemplate-post", "parameters"=>[{"in"=>"formData", "name"=>"active", "description"=>"If set to false, the license template is disabled"}, {"in"=>"formData", "name"=>"automatic", "description"=>"If set to true, every new licensee automatically gets one license out of this license template on creation"}, {"in"=>"formData", "name"=>"currency", "description"=>"specifies currency for the license price"}, {"in"=>"formData", "name"=>"hidden", "description"=>"If set to true, this license template is not shown in NetLicensing Shop as offered for purchase"}, {"in"=>"formData", "name"=>"hideLicenses", "description"=>"If set to true, licenses from this license template are not visible to the end customer, but participate in validation"}, {"in"=>"formData", "name"=>"licenseType", "description"=>"type of licenses created from this license template"}, {"in"=>"formData", "name"=>"maxSessions", "description"=>"Mandatory for FLOATING license type"}, {"in"=>"formData", "name"=>"name", "description"=>"license template name to ?reate license template object"}, {"in"=>"formData", "name"=>"number", "description"=>"lUnique number (across all products of a vendor) that identifies the license template"}, {"in"=>"formData", "name"=>"price", "description"=>"price for the license"}, {"in"=>"formData", "name"=>"productModuleNumber", "description"=>"Number of product module to ?reate license template object"}, {"in"=>"formData", "name"=>"timeVolume", "description"=>"Mandatory for TIMEVOLUME license type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licensetemplate"]}}, "/licensetemplate/{licenseTemplateNumber}"=>{"delete"=>{"summary"=>"Delete license template", "description"=>"Delete a license template by number.", "operationId"=>"deleteLicenseTemplate", "x-api-path-slug"=>"licensetemplatelicensetemplatenumber-delete", "parameters"=>[{"in"=>"query", "name"=>"forceCascade", "description"=>"Force object deletion and all descendants"}, {"in"=>"path", "name"=>"licenseTemplateNumber", "description"=>"Unique number (across all products of a vendor) that identifies the license template"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licensetemplate", "LicenseTemplateNumber"]}, "get"=>{"summary"=>"Get license template", "description"=>"Return a license template by licenseTemplateNumber", "operationId"=>"getLicenseTemplate", "x-api-path-slug"=>"licensetemplatelicensetemplatenumber-get", "parameters"=>[{"in"=>"path", "name"=>"licenseTemplateNumber", "description"=>"Unique number (across all products of a vendor) that identifies the license template"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licensetemplate", "LicenseTemplateNumber"]}, "post"=>{"summary"=>"Update license template", "description"=>"Sets the provided properties to a license template. Return an updated license template", "operationId"=>"updateLicenseTemplate", "x-api-path-slug"=>"licensetemplatelicensetemplatenumber-post", "parameters"=>[{"in"=>"formData", "name"=>"active", "description"=>"If set to false, the license template is disabled"}, {"in"=>"formData", "name"=>"automatic", "description"=>"If set to true, every new licensee automatically gets one license out of this license template on creation"}, {"in"=>"formData", "name"=>"currency", "description"=>"Specifies currency for the license price"}, {"in"=>"formData", "name"=>"hidden", "description"=>"If set to true, this license template is not shown in NetLicensing Shop as offered for purchase"}, {"in"=>"formData", "name"=>"hideLicenses", "description"=>"If set to true, licenses from this license template are not visible to the end customer, but participate in validation"}, {"in"=>"path", "name"=>"licenseTemplateNumber", "description"=>"Unique number (across all products of a vendor) that identifies the license template"}, {"in"=>"formData", "name"=>"licenseType", "description"=>"type of licenses created from this license template"}, {"in"=>"formData", "name"=>"maxSessions", "description"=>"Mandatory for FLOATING license type"}, {"in"=>"formData", "name"=>"name", "description"=>"Name for the licensed item"}, {"in"=>"formData", "name"=>"number", "description"=>"New license template number (update)"}, {"in"=>"formData", "name"=>"price", "description"=>"Price for the license"}, {"in"=>"formData", "name"=>"timeVolume", "description"=>"Mandatory for TIMEVOLUME license type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licensetemplate", "LicenseTemplateNumber"]}}, "/paymentmethod"=>{"get"=>{"summary"=>"Payment Methods list", "description"=>"Return a list of all payment methods for the current vendor", "operationId"=>"listPaymentMethods", "x-api-path-slug"=>"paymentmethod-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Paymentmethod"]}}, "/paymentmethod/{paymentMethodNumber}"=>{"get"=>{"summary"=>"Get payment method", "description"=>"Return a payment method info by paymentMethodNumber", "operationId"=>"getPaymentMethod", "x-api-path-slug"=>"paymentmethodpaymentmethodnumber-get", "parameters"=>[{"in"=>"path", "name"=>"paymentMethodNumber", "description"=>"Payment method number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Paymentmethod", "PaymentMethodNumber"]}, "post"=>{"summary"=>"Update payment method", "description"=>"Sets the provided properties to a payment method. Return an updated payment method", "operationId"=>"updatePaymentMethod", "x-api-path-slug"=>"paymentmethodpaymentmethodnumber-post", "parameters"=>[{"in"=>"formData", "name"=>"active", "description"=>"If set to false, the payment method is disabled"}, {"in"=>"path", "name"=>"paymentMethodNumber", "description"=>"Payment method number"}, {"in"=>"formData", "name"=>"paypal.subject", "description"=>"The e-mail address of the PayPal account for which you are making the API calls"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Paymentmethod", "PaymentMethodNumber"]}}, "/product"=>{"get"=>{"summary"=>"Products list", "description"=>"Return a list of all configured products for the current vendor", "operationId"=>"listProducts", "x-api-path-slug"=>"product-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}, "post"=>{"summary"=>"Create product", "description"=>"Creates a new product", "operationId"=>"createProduct", "x-api-path-slug"=>"product-post", "parameters"=>[{"in"=>"formData", "name"=>"active", "description"=>"If set to false, the product is disabled"}, {"in"=>"formData", "name"=>"description", "description"=>"Product description"}, {"in"=>"formData", "name"=>"licenseeAutoCreate", "description"=>"If set to true, non-existing licensees will be created at first validation attempt"}, {"in"=>"formData", "name"=>"licenseeSecretMode", "description"=>"Licensee secret mode for product"}, {"in"=>"formData", "name"=>"licensingInfo", "description"=>"Licensing information"}, {"in"=>"formData", "name"=>"name", "description"=>"Product name"}, {"in"=>"formData", "name"=>"number", "description"=>"Unique number that identifies the product"}, {"in"=>"formData", "name"=>"vatMode", "description"=>"Vat mode for product"}, {"in"=>"formData", "name"=>"version", "description"=>"Product version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}}, "/product/{productNumber}"=>{"delete"=>{"summary"=>"Delete product", "description"=>"Delete a product by number", "operationId"=>"deleteProduct", "x-api-path-slug"=>"productproductnumber-delete", "parameters"=>[{"in"=>"query", "name"=>"forceCascade", "description"=>"Force object deletion and all descendants"}, {"in"=>"path", "name"=>"productNumber", "description"=>"Unique number that identifies the product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "ProductNumber"]}, "get"=>{"summary"=>"Get product", "description"=>"Return a product by productNumber", "operationId"=>"productNumber", "x-api-path-slug"=>"productproductnumber-get", "parameters"=>[{"in"=>"path", "name"=>"productNumber", "description"=>"Unique number that identifies the product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "ProductNumber"]}, "post"=>{"summary"=>"Update product", "description"=>"Sets the provided properties to a product. Return an updated product", "operationId"=>"updateProduct", "x-api-path-slug"=>"productproductnumber-post", "parameters"=>[{"in"=>"formData", "name"=>"active", "description"=>"If set to false, the product is disabled"}, {"in"=>"formData", "name"=>"description", "description"=>"Product description"}, {"in"=>"formData", "name"=>"licenseeAutoCreate", "description"=>"If set to true, non-existing licensees will be created at first validation attempt"}, {"in"=>"formData", "name"=>"licenseeSecretMode", "description"=>"Licensee secret mode for product"}, {"in"=>"formData", "name"=>"licensingInfo", "description"=>"Licensing information"}, {"in"=>"formData", "name"=>"name", "description"=>"Product name"}, {"in"=>"formData", "name"=>"number", "description"=>"New product number (update)"}, {"in"=>"path", "name"=>"productNumber", "description"=>"Unique number that identifies the product"}, {"in"=>"formData", "name"=>"vatMode", "description"=>"Vat mode for product"}, {"in"=>"formData", "name"=>"version", "description"=>"Product version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "ProductNumber"]}}, "/productmodule"=>{"get"=>{"summary"=>"Product Modules list", "description"=>"Return a list of all product modules for the current vendor", "operationId"=>"listProductModules", "x-api-path-slug"=>"productmodule-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Productmodule"]}, "post"=>{"summary"=>"Create product module", "description"=>"Creates a new product module", "operationId"=>"createProductModule", "x-api-path-slug"=>"productmodule-post", "parameters"=>[{"in"=>"formData", "name"=>"active", "description"=>"If set to false, the product module is disabled"}, {"in"=>"formData", "name"=>"licenseTemplate", "description"=>"License template"}, {"in"=>"formData", "name"=>"licensingModel", "description"=>"Licensing model applied to this product module"}, {"in"=>"formData", "name"=>"maxCheckoutValidity", "description"=>"Maximum checkout validity (days)"}, {"in"=>"formData", "name"=>"name", "description"=>"Product module name that is visible to the end customers in NetLicensing Shop"}, {"in"=>"formData", "name"=>"number", "description"=>"Unique number (across all products of a vendor) that identifies the product module"}, {"in"=>"formData", "name"=>"productNumber", "description"=>"Unique number (across all products of a vendor) that identifies the product module"}, {"in"=>"formData", "name"=>"redThreshold", "description"=>"Remaining time volume for red level"}, {"in"=>"formData", "name"=>"yellowThreshold", "description"=>"Remaining time volume for yellow level"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Productmodule"]}}, "/productmodule/{productModuleNumber}"=>{"delete"=>{"summary"=>"Delete product module", "description"=>"Delete a product module by number", "operationId"=>"deleteProductModule", "x-api-path-slug"=>"productmoduleproductmodulenumber-delete", "parameters"=>[{"in"=>"query", "name"=>"forceCascade", "description"=>"Force object deletion and all descendants"}, {"in"=>"path", "name"=>"productModuleNumber", "description"=>"Unique number (across all products of a vendor) that identifies the product module"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Productmodule", "ProductModuleNumber"]}, "get"=>{"summary"=>"Get product module", "description"=>"Return a product module by productModuleNumber", "operationId"=>"getProductModule", "x-api-path-slug"=>"productmoduleproductmodulenumber-get", "parameters"=>[{"in"=>"path", "name"=>"productModuleNumber", "description"=>"Unique number (across all products of a vendor) that identifies the product module"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Productmodule", "ProductModuleNumber"]}, "post"=>{"summary"=>"Update product module", "description"=>"Sets the provided properties to a product module. Return an updated product module", "operationId"=>"updateProductModule", "x-api-path-slug"=>"productmoduleproductmodulenumber-post", "parameters"=>[{"in"=>"formData", "name"=>"active", "description"=>"If set to false, the product module is disabled"}, {"in"=>"formData", "name"=>"licenseTemplate", "description"=>"License template"}, {"in"=>"formData", "name"=>"licensingModel", "description"=>"Licensing model applied to this product module"}, {"in"=>"formData", "name"=>"maxCheckoutValidity", "description"=>"Maximum checkout validity (days)"}, {"in"=>"formData", "name"=>"name", "description"=>"Product module name that is visible to the end customers in NetLicensing Shop"}, {"in"=>"formData", "name"=>"number", "description"=>"New product module number (update)"}, {"in"=>"path", "name"=>"productModuleNumber", "description"=>"Unique number (across all products of a vendor) that identifies the product module"}, {"in"=>"formData", "name"=>"redThreshold", "description"=>"Remaining time volume for red level"}, {"in"=>"formData", "name"=>"yellowThreshold", "description"=>"Remaining time volume for yellow level"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Productmodule", "ProductModuleNumber"]}}, "/token"=>{"get"=>{"summary"=>"Tokens list", "description"=>"Return a list of all tokens for the current vendor", "operationId"=>"listTokens", "x-api-path-slug"=>"token-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token"]}, "post"=>{"summary"=>"Create token", "description"=>"Create token by tokenType and additional token parameters", "operationId"=>"createToken", "x-api-path-slug"=>"token-post", "parameters"=>[{"in"=>"formData", "name"=>"cancelURL", "description"=>"for tokenType=SHOP only; take customers to this URL when they cancel their checkout"}, {"in"=>"formData", "name"=>"cancelURLTitle", "description"=>"for tokenType=SHOP only; shop link title for cancel checkout process"}, {"in"=>"formData", "name"=>"licenseeNumber", "description"=>"for tokenType=SHOP only (mandatory); identifies licensee that will be assigned to the shop token"}, {"in"=>"formData", "name"=>"successURL", "description"=>"for tokenType=SHOP only; take customers to this URL when they finish checkout"}, {"in"=>"formData", "name"=>"successURLTitle", "description"=>"for tokenType=SHOP only; shop link title for successful checkout process"}, {"in"=>"formData", "name"=>"tokenType", "description"=>"Token type to be generated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token"]}}, "/token/{tokenNumber}"=>{"delete"=>{"summary"=>"Delete token", "description"=>"Delete a token by number", "operationId"=>"deleteToken", "x-api-path-slug"=>"tokentokennumber-delete", "parameters"=>[{"in"=>"path", "name"=>"tokenNumber", "description"=>"Token number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token", "TokenNumber"]}, "get"=>{"summary"=>"Get token", "description"=>"Return a token by tokenNumber", "operationId"=>"getToken", "x-api-path-slug"=>"tokentokennumber-get", "parameters"=>[{"in"=>"path", "name"=>"tokenNumber", "description"=>"Token number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token", "TokenNumber"]}}, "/transaction"=>{"get"=>{"summary"=>"Transactions list", "description"=>"Return a list of all transactions for the current vendor", "operationId"=>"listTransactions", "x-api-path-slug"=>"transaction-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transaction"]}, "post"=>{"summary"=>"Create transaction", "description"=>"Creates a new transaction", "operationId"=>"createTransaction", "x-api-path-slug"=>"transaction-post", "parameters"=>[{"in"=>"formData", "name"=>"active", "description"=>"always true for transactions"}, {"in"=>"formData", "name"=>"dateClosed"}, {"in"=>"formData", "name"=>"dateCreated"}, {"in"=>"formData", "name"=>"licenseeNumber"}, {"in"=>"formData", "name"=>"number", "description"=>"Unique number (across all products of a vendor) that identifies the transaction"}, {"in"=>"formData", "name"=>"paymentMethod"}, {"in"=>"formData", "name"=>"source", "description"=>"AUTO transaction for internal use only"}, {"in"=>"formData", "name"=>"status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transaction"]}}, "/transaction/{transactionNumber}"=>{"get"=>{"summary"=>"Get transaction", "description"=>"Return a transaction by transactionNumber", "operationId"=>"getTransaction", "x-api-path-slug"=>"transactiontransactionnumber-get", "parameters"=>[{"in"=>"path", "name"=>"transactionNumber", "description"=>"Unique number (across all products of a vendor) that identifies the transaction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transaction", "TransactionNumber"]}, "post"=>{"summary"=>"Update transaction", "description"=>"Sets the provided properties to a transaction. Return an updated transaction", "operationId"=>"updateTransaction", "x-api-path-slug"=>"transactiontransactionnumber-post", "parameters"=>[{"in"=>"formData", "name"=>"active", "description"=>"always true for transactions"}, {"in"=>"formData", "name"=>"dateClosed"}, {"in"=>"formData", "name"=>"dateCreated"}, {"in"=>"formData", "name"=>"number", "description"=>"Unique number (across all products of a vendor) that identifies the transaction"}, {"in"=>"formData", "name"=>"paymentMethod"}, {"in"=>"formData", "name"=>"source", "description"=>"AUTO transaction for internal use only"}, {"in"=>"formData", "name"=>"status"}, {"in"=>"path", "name"=>"transactionNumber", "description"=>"Unique number (across all products of a vendor) that identifies the transaction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transaction", "TransactionNumber"]}}, "/utility/licenseTypes"=>{"get"=>{"summary"=>"License Types list", "description"=>"Return a list of all license types supported by the service", "operationId"=>"licenseTypes", "x-api-path-slug"=>"utilitylicensetypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Utility", "LicenseTypes"]}}, "/utility/licensingModels"=>{"get"=>{"summary"=>"Licensing Models list", "description"=>"Return a list of all licensing models supported by the service", "operationId"=>"licensingModels", "x-api-path-slug"=>"utilitylicensingmodels-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Utility", "LicensingModels"]}}}}, "apis"=>{"name"=>"NetLicensing", "x-slug"=>"netlicensing", "description"=>"Labs64 NetLicensing is a first-class solution in the Licensing-as-a-Service (LaaS) sector. Based on open standards, it provides a cost effective, integrated and scalable platform for software vendors and developers who want to concentrate on their product’s core functionality instead of spending resources on developing an own license management software.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28466-labs64-net-licensing-restful-api-test-center.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"1080577", "tags"=>"API Provider,API Service Provider,Enterprise,Licensing,Monetization,Profiles,Relative Data,SaaS,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"netlicensing/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"NetLicensing", "x-api-slug"=>"netlicensing", "description"=>"Labs64 NetLicensing is a first-class solution in the Licensing-as-a-Service (LaaS) sector. Based on open standards, it provides a cost effective, integrated and scalable platform for software vendors and developers who want to concentrate on their product’s core functionality instead of spending resources on developing an own license management software.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28466-labs64-net-licensing-restful-api-test-center.jpg", "humanURL"=>"http://netlicensing.io", "baseURL"=>"https://go.netlicensing.io//core/v2/rest", "tags"=>"API Provider,API Service Provider,Enterprise,Licensing,Monetization,Profiles,Relative Data,SaaS,Service API,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/netlicensing/licenseelicenseenumbervalidate-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/netlicensing/netlicensing-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-getting-started", "url"=>"https://netlicensing.io/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://netlicensing.io/pricing/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/netlicensing"}, {"type"=>"x-website", "url"=>"http://netlicensing.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
usajobs-api{"usajobs-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"USAJobs API", "x-complete"=>1, "info"=>{"title"=>"USAJobs API", "description"=>"federal-state-and-local-government-agencies-are-hiring-and-have-thousands-of-job-openings-across-the-country-posted-on-usajobs-gov-and-local-government-jobs-sites-", "termsOfService"=>"https://www.usa.gov/About/developer-resources/terms-of-service.shtml", "version"=>"1.0.0"}, "host"=>"api.usa.gov", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/jobs/search.json"=>{"get"=>{"summary"=>"Search Jobs", "description"=>"his Jobs API allows you to tap into a list of current jobs openings with the government.", "operationId"=>"searchJobs", "x-api-path-slug"=>"jobssearch-json-get", "parameters"=>[{"in"=>"query", "name"=>"from", "description"=>"Specifies the starting record", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"hi", "description"=>"No highlighting is included by default", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"Lat_lon", "description"=>"Comma-separated pair denoting the position of the searcher looking for a job", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"organization_ids", "description"=>"A comma-separated string specifying which federal, state, or local agencies to use as a filter", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"Attempts to extract as much signal as possible from the input text", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"size", "description"=>"Specifies how many results are returned (up to 100 at a time)", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"tags", "description"=>"A comma-separated string specifying the level of government", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}}}, "apis"=>{"name"=>"USAJobs API", "x-slug"=>"usajobs-api", "description"=>"Federal, state, and local government agencies are hiring and have thousands of job openings across the country, posted on USAJobs.gov and local government jobs sites. This Jobs API allows you to tap into a list of current jobs openings with the government. Jobs are searchable by keyword, location, agency, schedule, or any combination of these.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/usajobs.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"Federal Government GSA,General Data,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"usajobs-api/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"USAJobs API", "x-api-slug"=>"usajobs-api", "description"=>"Federal, state, and local government agencies are hiring and have thousands of job openings across the country, posted on USAJobs.gov and local government jobs sites. This Jobs API allows you to tap into a list of current jobs openings with the government. Jobs are searchable by keyword, location, agency, schedule, or any combination of these.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/usajobs.png", "humanURL"=>"https://search.digitalgov.gov/developer/jobs.html", "baseURL"=>"https://api.usa.gov//", "tags"=>"Federal Government GSA,General Data,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/usajobs-api/jobssearch-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/usajobs-api/usajobs-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://search.digitalgov.gov/developer/jobs.html"}, {"type"=>"x-terms-of-service", "url"=>"https://www.usa.gov/About/developer-resources/terms-of-service.shtml"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-books{"google-books-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Books", "x-complete"=>1, "info"=>{"title"=>"Books", "description"=>"searches-for-books-and-manages-your-google-books-library-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"www.googleapis.com", "basePath"=>"/books/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/cloudloading/addBook"=>{"post"=>{"summary"=>"Add Book", "description"=>"Adds a book and its contents", "operationId"=>"books.cloudloading.addBook", "x-api-path-slug"=>"cloudloadingaddbook-post", "parameters"=>[{"in"=>"query", "name"=>"drive_document_id", "description"=>"A drive document id"}, {"in"=>"query", "name"=>"mime_type", "description"=>"The document MIME type"}, {"in"=>"query", "name"=>"name", "description"=>"The document name"}, {"in"=>"query", "name"=>"upload_client_token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Book"]}}, "/cloudloading/deleteBook"=>{"post"=>{"summary"=>"Remove Book", "description"=>"Remove the book and its contents", "operationId"=>"books.cloudloading.deleteBook", "x-api-path-slug"=>"cloudloadingdeletebook-post", "parameters"=>[{"in"=>"query", "name"=>"volumeId", "description"=>"The id of the book to be removed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Book"]}}, "/cloudloading/updateBook"=>{"post"=>{"summary"=>"Update Book", "description"=>"Updates a book and its contents", "operationId"=>"books.cloudloading.updateBook", "x-api-path-slug"=>"cloudloadingupdatebook-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Book"]}}, "/dictionary/listOfflineMetadata"=>{"get"=>{"summary"=>"Get Dictionary", "description"=>"Returns a list of offline dictionary metadata available", "operationId"=>"books.dictionary.listOfflineMetadata", "x-api-path-slug"=>"dictionarylistofflinemetadata-get", "parameters"=>[{"in"=>"query", "name"=>"cpksver", "description"=>"The device/version ID from which to request the data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dictionary"]}}, "/myconfig/getUserSettings"=>{"get"=>{"summary"=>"Get User Settings", "description"=>"Gets the current settings for the user.", "operationId"=>"books.myconfig.getUserSettings", "x-api-path-slug"=>"myconfiggetusersettings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/myconfig/releaseDownloadAccess"=>{"post"=>{"summary"=>"Release Access Restrictions", "description"=>"Release downloaded content access restriction.", "operationId"=>"books.myconfig.releaseDownloadAccess", "x-api-path-slug"=>"myconfigreleasedownloadaccess-post", "parameters"=>[{"in"=>"query", "name"=>"cpksver", "description"=>"The device/version ID from which to release the restriction"}, {"in"=>"query", "name"=>"locale", "description"=>"ISO-639-1, ISO-3166-1 codes for message localization, i"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"volumeIds", "description"=>"The volume(s) to release restrictions for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Access"]}}, "/myconfig/requestAccess"=>{"post"=>{"summary"=>"Request Access", "description"=>"Request concurrent and download access restrictions.", "operationId"=>"books.myconfig.requestAccess", "x-api-path-slug"=>"myconfigrequestaccess-post", "parameters"=>[{"in"=>"query", "name"=>"cpksver", "description"=>"The device/version ID from which to request the restrictions"}, {"in"=>"query", "name"=>"licenseTypes", "description"=>"The type of access license to request"}, {"in"=>"query", "name"=>"locale", "description"=>"ISO-639-1, ISO-3166-1 codes for message localization, i"}, {"in"=>"query", "name"=>"nonce", "description"=>"The client nonce value"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"volumeId", "description"=>"The volume to request concurrent/download restrictions for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Access"]}}, "/myconfig/syncVolumeLicenses"=>{"post"=>{"summary"=>"Sync Volume Licenses", "description"=>"Request downloaded content access for specified volumes on the My eBooks shelf.", "operationId"=>"books.myconfig.syncVolumeLicenses", "x-api-path-slug"=>"myconfigsyncvolumelicenses-post", "parameters"=>[{"in"=>"query", "name"=>"cpksver", "description"=>"The device/version ID from which to release the restriction"}, {"in"=>"query", "name"=>"features", "description"=>"List of features supported by the client, i"}, {"in"=>"query", "name"=>"includeNonComicsSeries", "description"=>"Set to true to include non-comics series"}, {"in"=>"query", "name"=>"locale", "description"=>"ISO-639-1, ISO-3166-1 codes for message localization, i"}, {"in"=>"query", "name"=>"nonce", "description"=>"The client nonce value"}, {"in"=>"query", "name"=>"showPreorders", "description"=>"Set to true to show pre-ordered books"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"volumeIds", "description"=>"The volume(s) to request download restrictions for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume License"]}}, "/myconfig/updateUserSettings"=>{"post"=>{"summary"=>"Update User Settings", "description"=>"Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value.", "operationId"=>"books.myconfig.updateUserSettings", "x-api-path-slug"=>"myconfigupdateusersettings-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/mylibrary/annotations"=>{"get"=>{"summary"=>"Get Annotations", "description"=>"Retrieves a list of annotations, possibly filtered.", "operationId"=>"books.mylibrary.annotations.list", "x-api-path-slug"=>"mylibraryannotations-get", "parameters"=>[{"in"=>"query", "name"=>"contentVersion", "description"=>"The content version for the requested volume"}, {"in"=>"query", "name"=>"layerId", "description"=>"The layer ID to limit annotation by"}, {"in"=>"query", "name"=>"layerIds", "description"=>"The layer ID(s) to limit annotation by"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The value of the nextToken from the previous page"}, {"in"=>"query", "name"=>"showDeleted", "description"=>"Set to true to return deleted annotations"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"updatedMax", "description"=>"RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive)"}, {"in"=>"query", "name"=>"updatedMin", "description"=>"RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive)"}, {"in"=>"query", "name"=>"volumeId", "description"=>"The volume to restrict annotations to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation"]}, "post"=>{"summary"=>"insert Annotation", "description"=>"Inserts a new annotation.", "operationId"=>"books.mylibrary.annotations.insert", "x-api-path-slug"=>"mylibraryannotations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"country", "description"=>"ISO-3166-1 code to override the IP-based location"}, {"in"=>"query", "name"=>"showOnlySummaryInResponse", "description"=>"Requests that only the summary of the specified layer be provided in the response"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation"]}}, "/mylibrary/annotations/summary"=>{"post"=>{"summary"=>"Get Annotation", "description"=>"Gets the summary of specified layers.", "operationId"=>"books.mylibrary.annotations.summary", "x-api-path-slug"=>"mylibraryannotationssummary-post", "parameters"=>[{"in"=>"query", "name"=>"layerIds", "description"=>"Array of layer IDs to get the summary for"}, {"in"=>"query", "name"=>"volumeId", "description"=>"Volume id to get the summary for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation"]}}, "/mylibrary/annotations/{annotationId}"=>{"delete"=>{"summary"=>"Delete Annotation", "description"=>"Deletes an annotation.", "operationId"=>"books.mylibrary.annotations.delete", "x-api-path-slug"=>"mylibraryannotationsannotationid-delete", "parameters"=>[{"in"=>"path", "name"=>"annotationId", "description"=>"The ID for the annotation to delete"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation"]}, "put"=>{"summary"=>"Update Annotation", "description"=>"Updates an existing annotation.", "operationId"=>"books.mylibrary.annotations.update", "x-api-path-slug"=>"mylibraryannotationsannotationid-put", "parameters"=>[{"in"=>"path", "name"=>"annotationId", "description"=>"The ID for the annotation to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation"]}}, "/mylibrary/bookshelves"=>{"get"=>{"summary"=>"Get Bookshelves", "description"=>"Retrieves a list of bookshelves belonging to the authenticated user.", "operationId"=>"books.mylibrary.bookshelves.list", "x-api-path-slug"=>"mylibrarybookshelves-get", "parameters"=>[{"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bookshelf"]}}, "/mylibrary/bookshelves/{shelf}"=>{"get"=>{"summary"=>"Get Bookshelf", "description"=>"Retrieves metadata for a specific bookshelf belonging to the authenticated user.", "operationId"=>"books.mylibrary.bookshelves.get", "x-api-path-slug"=>"mylibrarybookshelvesshelf-get", "parameters"=>[{"in"=>"path", "name"=>"shelf", "description"=>"ID of bookshelf to retrieve"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bookshelf"]}}, "/mylibrary/bookshelves/{shelf}/addVolume"=>{"post"=>{"summary"=>"Add Volume", "description"=>"Adds a volume to a bookshelf.", "operationId"=>"books.mylibrary.bookshelves.addVolume", "x-api-path-slug"=>"mylibrarybookshelvesshelfaddvolume-post", "parameters"=>[{"in"=>"query", "name"=>"reason", "description"=>"The reason for which the book is added to the library"}, {"in"=>"path", "name"=>"shelf", "description"=>"ID of bookshelf to which to add a volume"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"volumeId", "description"=>"ID of volume to add"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume"]}}, "/mylibrary/bookshelves/{shelf}/clearVolumes"=>{"post"=>{"summary"=>"Clear Volumes", "description"=>"Clears all volumes from a bookshelf.", "operationId"=>"books.mylibrary.bookshelves.clearVolumes", "x-api-path-slug"=>"mylibrarybookshelvesshelfclearvolumes-post", "parameters"=>[{"in"=>"path", "name"=>"shelf", "description"=>"ID of bookshelf from which to remove a volume"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume"]}}, "/mylibrary/bookshelves/{shelf}/moveVolume"=>{"post"=>{"summary"=>"Move Voume", "description"=>"Moves a volume within a bookshelf.", "operationId"=>"books.mylibrary.bookshelves.moveVolume", "x-api-path-slug"=>"mylibrarybookshelvesshelfmovevolume-post", "parameters"=>[{"in"=>"path", "name"=>"shelf", "description"=>"ID of bookshelf with the volume"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"volumeId", "description"=>"ID of volume to move"}, {"in"=>"query", "name"=>"volumePosition", "description"=>"Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume"]}}, "/mylibrary/bookshelves/{shelf}/removeVolume"=>{"post"=>{"summary"=>"Remove Volume", "description"=>"Removes a volume from a bookshelf.", "operationId"=>"books.mylibrary.bookshelves.removeVolume", "x-api-path-slug"=>"mylibrarybookshelvesshelfremovevolume-post", "parameters"=>[{"in"=>"query", "name"=>"reason", "description"=>"The reason for which the book is removed from the library"}, {"in"=>"path", "name"=>"shelf", "description"=>"ID of bookshelf from which to remove a volume"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"volumeId", "description"=>"ID of volume to remove"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume"]}}, "/mylibrary/bookshelves/{shelf}/volumes"=>{"get"=>{"summary"=>"Get Volume", "description"=>"Gets volume information for volumes on a bookshelf.", "operationId"=>"books.mylibrary.bookshelves.volumes.list", "x-api-path-slug"=>"mylibrarybookshelvesshelfvolumes-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"ISO-3166-1 code to override the IP-based location"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"projection", "description"=>"Restrict information returned to a set of selected fields"}, {"in"=>"query", "name"=>"q", "description"=>"Full-text search query string in this bookshelf"}, {"in"=>"path", "name"=>"shelf", "description"=>"The bookshelf ID or name retrieve volumes for"}, {"in"=>"query", "name"=>"showPreorders", "description"=>"Set to true to show pre-ordered books"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Index of the first element to return (starts at 0)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume"]}}, "/mylibrary/readingpositions/{volumeId}"=>{"get"=>{"summary"=>"Get Reading Position", "description"=>"Retrieves my reading position information for a volume.", "operationId"=>"books.mylibrary.readingpositions.get", "x-api-path-slug"=>"mylibraryreadingpositionsvolumeid-get", "parameters"=>[{"in"=>"query", "name"=>"contentVersion", "description"=>"Volume content version for which this reading position is requested"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"path", "name"=>"volumeId", "description"=>"ID of volume for which to retrieve a reading position"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reading Position"]}}, "/mylibrary/readingpositions/{volumeId}/setPosition"=>{"post"=>{"summary"=>"Set Reading Position", "description"=>"Sets my reading position information for a volume.", "operationId"=>"books.mylibrary.readingpositions.setPosition", "x-api-path-slug"=>"mylibraryreadingpositionsvolumeidsetposition-post", "parameters"=>[{"in"=>"query", "name"=>"action", "description"=>"Action that caused this reading position to be set"}, {"in"=>"query", "name"=>"contentVersion", "description"=>"Volume content version for which this reading position applies"}, {"in"=>"query", "name"=>"deviceCookie", "description"=>"Random persistent device cookie optional on set position"}, {"in"=>"query", "name"=>"position", "description"=>"Position string for the new volume reading position"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"timestamp", "description"=>"RFC 3339 UTC format timestamp associated with this reading position"}, {"in"=>"path", "name"=>"volumeId", "description"=>"ID of volume for which to update the reading position"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reading Position"]}}, "/notification/get"=>{"get"=>{"summary"=>"Get Notification", "description"=>"Returns notification details for a given notification id.", "operationId"=>"books.notification.get", "x-api-path-slug"=>"notificationget-get", "parameters"=>[{"in"=>"query", "name"=>"locale", "description"=>"ISO-639-1 language and ISO-3166-1 country code"}, {"in"=>"query", "name"=>"notification_id", "description"=>"String to identify the notification"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification"]}}, "/onboarding/listCategories"=>{"get"=>{"summary"=>"List Categoies", "description"=>"List categories for onboarding experience.", "operationId"=>"books.onboarding.listCategories", "x-api-path-slug"=>"onboardinglistcategories-get", "parameters"=>[{"in"=>"query", "name"=>"locale", "description"=>"ISO-639-1 language and ISO-3166-1 country code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Category"]}}, "/onboarding/listCategoryVolumes"=>{"get"=>{"summary"=>"List Volumes", "description"=>"List available volumes under categories for onboarding experience.", "operationId"=>"books.onboarding.listCategoryVolumes", "x-api-path-slug"=>"onboardinglistcategoryvolumes-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId", "description"=>"List of category ids requested"}, {"in"=>"query", "name"=>"locale", "description"=>"ISO-639-1 language and ISO-3166-1 country code"}, {"in"=>"query", "name"=>"maxAllowedMaturityRating", "description"=>"The maximum allowed maturity rating of returned volumes"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of maximum results per page to be included in the response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The value of the nextToken from the previous page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volue"]}}, "/personalizedstream/get"=>{"get"=>{"summary"=>"Get Stream", "description"=>"Returns a stream of personalized book clusters", "operationId"=>"books.personalizedstream.get", "x-api-path-slug"=>"personalizedstreamget-get", "parameters"=>[{"in"=>"query", "name"=>"locale", "description"=>"ISO-639-1 language and ISO-3166-1 country code"}, {"in"=>"query", "name"=>"maxAllowedMaturityRating", "description"=>"The maximum allowed maturity rating of returned recommendations"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stream"]}}, "/promooffer/accept"=>{"post"=>{"summary"=>"Accept Promotion Offer", "description"=>"Accept promotion offer", "operationId"=>"books.promooffer.accept", "x-api-path-slug"=>"promoofferaccept-post", "parameters"=>[{"in"=>"query", "name"=>"androidId", "description"=>"device android_id"}, {"in"=>"query", "name"=>"device", "description"=>"device device"}, {"in"=>"query", "name"=>"manufacturer", "description"=>"device manufacturer"}, {"in"=>"query", "name"=>"model", "description"=>"device model"}, {"in"=>"query", "name"=>"offerId"}, {"in"=>"query", "name"=>"product", "description"=>"device product"}, {"in"=>"query", "name"=>"serial", "description"=>"device serial"}, {"in"=>"query", "name"=>"volumeId", "description"=>"Volume id to exercise the offer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Promotion"]}}, "/promooffer/dismiss"=>{"post"=>{"summary"=>"Dismiss Promotion Offer", "description"=>"Dismiss promotion offer", "operationId"=>"books.promooffer.dismiss", "x-api-path-slug"=>"promoofferdismiss-post", "parameters"=>[{"in"=>"query", "name"=>"androidId", "description"=>"device android_id"}, {"in"=>"query", "name"=>"device", "description"=>"device device"}, {"in"=>"query", "name"=>"manufacturer", "description"=>"device manufacturer"}, {"in"=>"query", "name"=>"model", "description"=>"device model"}, {"in"=>"query", "name"=>"offerId", "description"=>"Offer to dimiss"}, {"in"=>"query", "name"=>"product", "description"=>"device product"}, {"in"=>"query", "name"=>"serial", "description"=>"device serial"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Promotion"]}}, "/promooffer/get"=>{"get"=>{"summary"=>"Get Promotion Offer", "description"=>"Returns a list of promo offers available to the user", "operationId"=>"books.promooffer.get", "x-api-path-slug"=>"promoofferget-get", "parameters"=>[{"in"=>"query", "name"=>"androidId", "description"=>"device android_id"}, {"in"=>"query", "name"=>"device", "description"=>"device device"}, {"in"=>"query", "name"=>"manufacturer", "description"=>"device manufacturer"}, {"in"=>"query", "name"=>"model", "description"=>"device model"}, {"in"=>"query", "name"=>"product", "description"=>"device product"}, {"in"=>"query", "name"=>"serial", "description"=>"device serial"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Promotion"]}}, "/series/get"=>{"get"=>{"summary"=>"Get Series", "description"=>"Returns Series metadata for the given series ids.", "operationId"=>"books.series.get", "x-api-path-slug"=>"seriesget-get", "parameters"=>[{"in"=>"query", "name"=>"series_id", "description"=>"String that identifies the series"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Series"]}}, "/series/membership/get"=>{"get"=>{"summary"=>"Get Series Membership", "description"=>"Returns Series membership data given the series id.", "operationId"=>"books.series.membership.get", "x-api-path-slug"=>"seriesmembershipget-get", "parameters"=>[{"in"=>"query", "name"=>"page_size", "description"=>"Number of maximum results per page to be included in the response"}, {"in"=>"query", "name"=>"page_token", "description"=>"The value of the nextToken from the previous page"}, {"in"=>"query", "name"=>"series_id", "description"=>"String that identifies the series"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Series"]}}, "/users/{userId}/bookshelves"=>{"get"=>{"summary"=>"Get Public Bookkshelves", "description"=>"Retrieves a list of public bookshelves for the specified user.", "operationId"=>"books.bookshelves.list", "x-api-path-slug"=>"usersuseridbookshelves-get", "parameters"=>[{"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"path", "name"=>"userId", "description"=>"ID of user for whom to retrieve bookshelves"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bookshelf"]}}, "/users/{userId}/bookshelves/{shelf}"=>{"get"=>{"summary"=>"Get Public Bookshelf", "description"=>"Retrieves metadata for a specific bookshelf for the specified user.", "operationId"=>"books.bookshelves.get", "x-api-path-slug"=>"usersuseridbookshelvesshelf-get", "parameters"=>[{"in"=>"path", "name"=>"shelf", "description"=>"ID of bookshelf to retrieve"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"path", "name"=>"userId", "description"=>"ID of user for whom to retrieve bookshelves"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bookshelf"]}}, "/users/{userId}/bookshelves/{shelf}/volumes"=>{"get"=>{"summary"=>"Get Public Volumes", "description"=>"Retrieves volumes in a specific bookshelf for the specified user.", "operationId"=>"books.bookshelves.volumes.list", "x-api-path-slug"=>"usersuseridbookshelvesshelfvolumes-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"path", "name"=>"shelf", "description"=>"ID of bookshelf to retrieve volumes"}, {"in"=>"query", "name"=>"showPreorders", "description"=>"Set to true to show pre-ordered books"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Index of the first element to return (starts at 0)"}, {"in"=>"path", "name"=>"userId", "description"=>"ID of user for whom to retrieve bookshelf volumes"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume"]}}, "/volumes"=>{"get"=>{"summary"=>"Book Search", "description"=>"Performs a book search.", "operationId"=>"books.volumes.list", "x-api-path-slug"=>"volumes-get", "parameters"=>[{"in"=>"query", "name"=>"download", "description"=>"Restrict to volumes by download availability"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter search results"}, {"in"=>"query", "name"=>"langRestrict", "description"=>"Restrict results to books with this language code"}, {"in"=>"query", "name"=>"libraryRestrict", "description"=>"Restrict search to this users library"}, {"in"=>"query", "name"=>"maxAllowedMaturityRating", "description"=>"The maximum allowed maturity rating of returned recommendations"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sort search results"}, {"in"=>"query", "name"=>"partner", "description"=>"Restrict and brand results for partner ID"}, {"in"=>"query", "name"=>"printType", "description"=>"Restrict to books or magazines"}, {"in"=>"query", "name"=>"projection", "description"=>"Restrict information returned to a set of selected fields"}, {"in"=>"query", "name"=>"q", "description"=>"Full-text search query string"}, {"in"=>"query", "name"=>"showPreorders", "description"=>"Set to true to show books available for preorder"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Index of the first result to return (starts at 0)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}, "/volumes/mybooks"=>{"get"=>{"summary"=>"Get My Books", "description"=>"Return a list of books in My Library.", "operationId"=>"books.volumes.mybooks.list", "x-api-path-slug"=>"volumesmybooks-get", "parameters"=>[{"in"=>"query", "name"=>"acquireMethod", "description"=>"How the book was acquired"}, {"in"=>"query", "name"=>"country", "description"=>"ISO-3166-1 code to override the IP-based location"}, {"in"=>"query", "name"=>"locale", "description"=>"ISO-639-1 language and ISO-3166-1 country code"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"processingState", "description"=>"The processing state of the user uploaded volumes to be returned"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Index of the first result to return (starts at 0)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Book"]}}, "/volumes/recommended"=>{"get"=>{"summary"=>"Get Recommend", "description"=>"Return a list of recommended books for the current user.", "operationId"=>"books.volumes.recommended.list", "x-api-path-slug"=>"volumesrecommended-get", "parameters"=>[{"in"=>"query", "name"=>"locale", "description"=>"ISO-639-1 language and ISO-3166-1 country code"}, {"in"=>"query", "name"=>"maxAllowedMaturityRating", "description"=>"The maximum allowed maturity rating of returned recommendations"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recommended"]}}, "/volumes/recommended/rate"=>{"post"=>{"summary"=>"Rate Recommend", "description"=>"Rate a recommended book for the current user.", "operationId"=>"books.volumes.recommended.rate", "x-api-path-slug"=>"volumesrecommendedrate-post", "parameters"=>[{"in"=>"query", "name"=>"locale", "description"=>"ISO-639-1 language and ISO-3166-1 country code"}, {"in"=>"query", "name"=>"rating", "description"=>"Rating to be given to the volume"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"volumeId", "description"=>"ID of the source volume"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recommended"]}}, "/volumes/useruploaded"=>{"get"=>{"summary"=>"Get Uploaded", "description"=>"Return a list of books uploaded by the current user.", "operationId"=>"books.volumes.useruploaded.list", "x-api-path-slug"=>"volumesuseruploaded-get", "parameters"=>[{"in"=>"query", "name"=>"locale", "description"=>"ISO-639-1 language and ISO-3166-1 country code"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"processingState", "description"=>"The processing state of the user uploaded volumes to be returned"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Index of the first result to return (starts at 0)"}, {"in"=>"query", "name"=>"volumeId", "description"=>"The ids of the volumes to be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload"]}}, "/volumes/{volumeId}"=>{"get"=>{"summary"=>"Get Volume", "description"=>"Gets volume information for a single volume.", "operationId"=>"books.volumes.get", "x-api-path-slug"=>"volumesvolumeid-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"ISO-3166-1 code to override the IP-based location"}, {"in"=>"query", "name"=>"includeNonComicsSeries", "description"=>"Set to true to include non-comics series"}, {"in"=>"query", "name"=>"partner", "description"=>"Brand results for partner ID"}, {"in"=>"query", "name"=>"projection", "description"=>"Restrict information returned to a set of selected fields"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"user_library_consistent_read"}, {"in"=>"path", "name"=>"volumeId", "description"=>"ID of volume to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume"]}}, "/volumes/{volumeId}/associated"=>{"get"=>{"summary"=>"Get Associated", "description"=>"Return a list of associated books.", "operationId"=>"books.volumes.associated.list", "x-api-path-slug"=>"volumesvolumeidassociated-get", "parameters"=>[{"in"=>"query", "name"=>"association", "description"=>"Association type"}, {"in"=>"query", "name"=>"locale", "description"=>"ISO-639-1 language and ISO-3166-1 country code"}, {"in"=>"query", "name"=>"maxAllowedMaturityRating", "description"=>"The maximum allowed maturity rating of returned recommendations"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"path", "name"=>"volumeId", "description"=>"ID of the source volume"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Associated"]}}, "/volumes/{volumeId}/layers/{layerId}"=>{"get"=>{"summary"=>"Get Volume Annotations", "description"=>"Gets the volume annotations for a volume and layer.", "operationId"=>"books.layers.volumeAnnotations.list", "x-api-path-slug"=>"volumesvolumeidlayerslayerid-get", "parameters"=>[{"in"=>"query", "name"=>"contentVersion", "description"=>"The content version for the requested volume"}, {"in"=>"query", "name"=>"endOffset", "description"=>"The end offset to end retrieving data from"}, {"in"=>"query", "name"=>"endPosition", "description"=>"The end position to end retrieving data from"}, {"in"=>"path", "name"=>"layerId", "description"=>"The ID for the layer to get the annotations"}, {"in"=>"query", "name"=>"locale", "description"=>"The locale information for the data"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The value of the nextToken from the previous page"}, {"in"=>"query", "name"=>"showDeleted", "description"=>"Set to true to return deleted annotations"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"startOffset", "description"=>"The start offset to start retrieving data from"}, {"in"=>"query", "name"=>"startPosition", "description"=>"The start position to start retrieving data from"}, {"in"=>"query", "name"=>"updatedMax", "description"=>"RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive)"}, {"in"=>"query", "name"=>"updatedMin", "description"=>"RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive)"}, {"in"=>"query", "name"=>"volumeAnnotationsVersion", "description"=>"The version of the volume annotations that you are requesting"}, {"in"=>"path", "name"=>"volumeId", "description"=>"The volume to retrieve annotations for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation"]}}, "/volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}"=>{"get"=>{"summary"=>"Get Volume Annotion", "description"=>"Gets the volume annotation.", "operationId"=>"books.layers.volumeAnnotations.get", "x-api-path-slug"=>"volumesvolumeidlayerslayeridannotationsannotationid-get", "parameters"=>[{"in"=>"path", "name"=>"annotationId", "description"=>"The ID of the volume annotation to retrieve"}, {"in"=>"path", "name"=>"layerId", "description"=>"The ID for the layer to get the annotations"}, {"in"=>"query", "name"=>"locale", "description"=>"The locale information for the data"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"path", "name"=>"volumeId", "description"=>"The volume to retrieve annotations for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation"]}}, "/volumes/{volumeId}/layers/{layerId}/data"=>{"get"=>{"summary"=>"Get Annotations", "description"=>"Gets the annotation data for a volume and layer.", "operationId"=>"books.layers.annotationData.list", "x-api-path-slug"=>"volumesvolumeidlayerslayeriddata-get", "parameters"=>[{"in"=>"query", "name"=>"annotationDataId", "description"=>"The list of Annotation Data Ids to retrieve"}, {"in"=>"query", "name"=>"contentVersion", "description"=>"The content version for the requested volume"}, {"in"=>"query", "name"=>"h", "description"=>"The requested pixel height for any images"}, {"in"=>"path", "name"=>"layerId", "description"=>"The ID for the layer to get the annotation data"}, {"in"=>"query", "name"=>"locale", "description"=>"The locale information for the data"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The value of the nextToken from the previous page"}, {"in"=>"query", "name"=>"scale", "description"=>"The requested scale for the image"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"query", "name"=>"updatedMax", "description"=>"RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive)"}, {"in"=>"query", "name"=>"updatedMin", "description"=>"RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive)"}, {"in"=>"path", "name"=>"volumeId", "description"=>"The volume to retrieve annotation data for"}, {"in"=>"query", "name"=>"w", "description"=>"The requested pixel width for any images"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation"]}}, "/volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}"=>{"get"=>{"summary"=>"Get Annotation", "description"=>"Gets the annotation data.", "operationId"=>"books.layers.annotationData.get", "x-api-path-slug"=>"volumesvolumeidlayerslayeriddataannotationdataid-get", "parameters"=>[{"in"=>"query", "name"=>"allowWebDefinitions", "description"=>"For the dictionary layer"}, {"in"=>"path", "name"=>"annotationDataId", "description"=>"The ID of the annotation data to retrieve"}, {"in"=>"query", "name"=>"contentVersion", "description"=>"The content version for the volume you are trying to retrieve"}, {"in"=>"query", "name"=>"h", "description"=>"The requested pixel height for any images"}, {"in"=>"path", "name"=>"layerId", "description"=>"The ID for the layer to get the annotations"}, {"in"=>"query", "name"=>"locale", "description"=>"The locale information for the data"}, {"in"=>"query", "name"=>"scale", "description"=>"The requested scale for the image"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"path", "name"=>"volumeId", "description"=>"The volume to retrieve annotations for"}, {"in"=>"query", "name"=>"w", "description"=>"The requested pixel width for any images"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation"]}}, "/volumes/{volumeId}/layersummary"=>{"get"=>{"summary"=>"Get Layers", "description"=>"List the layer summaries for a volume.", "operationId"=>"books.layers.list", "x-api-path-slug"=>"volumesvolumeidlayersummary-get", "parameters"=>[{"in"=>"query", "name"=>"contentVersion", "description"=>"The content version for the requested volume"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The value of the nextToken from the previous page"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"path", "name"=>"volumeId", "description"=>"The volume to retrieve layers for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layer"]}}, "/volumes/{volumeId}/layersummary/{summaryId}"=>{"get"=>{"summary"=>"Get Layer", "description"=>"Gets the layer summary for a volume.", "operationId"=>"books.layers.get", "x-api-path-slug"=>"volumesvolumeidlayersummarysummaryid-get", "parameters"=>[{"in"=>"query", "name"=>"contentVersion", "description"=>"The content version for the requested volume"}, {"in"=>"query", "name"=>"source", "description"=>"String to identify the originator of this request"}, {"in"=>"path", "name"=>"summaryId", "description"=>"The ID for the layer to get the summary for"}, {"in"=>"path", "name"=>"volumeId", "description"=>"The volume to retrieve layers for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layer"]}}}}, "apis"=>{"name"=>"Google Books", "x-slug"=>"google-books", "description"=>"Google Books is our effort to make book content more discoverable on the Web. Using the Google Books API, your application can perform full-text searches and retrieve book information, viewability and eBook availability. You can also manage your personal bookshelves.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2017-03-16 at 4.28.26 PM.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Books,Google APIs,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-books/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Books API", "x-api-slug"=>"google-books-api", "description"=>"The APIs in the Google Books API Family let you bringGoogle Booksfeatures to your site or application. The newGoogle Books APIlets you perform programmatically most of the operations that you can do interactively on the Google Books website. TheEmbedded Viewer APIlets you embed the content directly into your site.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2017-03-16 at 4.28.26 PM.png", "humanURL"=>"https://developers.google.com/books/", "baseURL"=>"://www.googleapis.com//books/v1", "tags"=>"API Provider,API Service Provider,Books,Google APIs,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-books/google-books-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://booksearch.blogspot.com"}, {"type"=>"x-blog-rss", "url"=>"http://booksearch.blogspot.com/feeds/posts/default?alt=rss"}, {"type"=>"x-branding-guidelines", "url"=>"https://developers.google.com/books/branding"}, {"type"=>"x-code", "url"=>"https://developers.google.com/books/docs/v1/libraries"}, {"type"=>"x-documentation", "url"=>"https://developers.google.com/books/docs/overview"}, {"type"=>"x-embeddable", "url"=>"https://developers.google.com/books/docs/viewer/developers_guide"}, {"type"=>"x-partners", "url"=>"https://books.google.com/intl/en/googlebooks/partners/"}, {"type"=>"x-privacy-policy", "url"=>"https://books.google.com/intl/en/policies/privacy/"}, {"type"=>"x-terms-of-service", "url"=>"https://developers.google.com/books/terms.html"}, {"type"=>"x-website", "url"=>"https://developers.google.com/books/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-container-service{"azure-container-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Container Service", "x-complete"=>1, "info"=>{"title"=>"ContainerServiceClient", "description"=>"the-container-service-client-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/containerServices"=>{"get"=>{"summary"=>"Container Services List", "description"=>"Gets a list of container services in the specified subscription. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.", "operationId"=>"ContainerServices_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-containerservicecontainerservices-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Services"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices/{containerServiceName}"=>{"put"=>{"summary"=>"Container Services Create Or Update", "description"=>"Creates or updates a container service with the specified configuration of orchestrator, masters, and agents.", "operationId"=>"ContainerServices_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-containerservicecontainerservicescontainerservicename-put", "parameters"=>[{"in"=>"path", "name"=>"containerServiceName", "description"=>"The name of the container service in the specified subscription and resource group"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the Create or Update a Container Service operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Services"]}, "get"=>{"summary"=>"Container Services Get", "description"=>"Gets the properties of the specified container service in the specified subscription and resource group. The operation returns the properties including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.", "operationId"=>"ContainerServices_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-containerservicecontainerservicescontainerservicename-get", "parameters"=>[{"in"=>"path", "name"=>"containerServiceName", "description"=>"The name of the container service in the specified subscription and resource group"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Services"]}, "delete"=>{"summary"=>"Container Services Delete", "description"=>"Deletes the specified container service in the specified subscription and resource group. The operation does not delete other resources created as part of creating a container service, including storage accounts, VMs, and availability sets. All the other resources created with the container service are part of the same resource group and can be deleted individually.", "operationId"=>"ContainerServices_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-containerservicecontainerservicescontainerservicename-delete", "parameters"=>[{"in"=>"path", "name"=>"containerServiceName", "description"=>"The name of the container service in the specified subscription and resource group"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Services"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices"=>{"get"=>{"summary"=>"Container Services List By Resource Group", "description"=>"Gets a list of container services in the specified subscription and resource group. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.", "operationId"=>"ContainerServices_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-containerservicecontainerservices-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Services"]}}}}, "apis"=>{"name"=>"Azure Container Service", "x-slug"=>"azure-container-service", "description"=>"Azure Container Service optimizes the configuration of popular open-source tools and technologies specifically for Azure. You get an open solution that offers portability for both your containers and your application configuration. You select the size, number of hosts, and choice of orchestrator tools—Container Service handles everything else.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-container-service.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Containers,Deployments,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-container-service/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Container Service API", "x-api-slug"=>"azure-container-service-api", "description"=>"Azure Container Service optimizes the configuration of popular open-source tools and technologies specifically for Azure. You get an open solution that offers portability for both your containers and your application configuration. You select the size, number of hosts, and choice of orchestrator tools—Container Service handles everything else.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-container-service.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/container-service/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Containers,Deployments,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-container-service/subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-containerservicecontainerservices-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-container-service/azure-container-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/container-service/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/container-service/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/container-service/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/container-service/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
apimetrics{"apimetrics-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"APImetrics", "x-complete"=>1, "info"=>{"title"=>"APImetrics Merged API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/auth/"=>{"get"=>{"summary"=>"List Authentication Settings", "description"=>"List Authentication Settings", "operationId"=>"listAuthenticationSettings", "x-api-path-slug"=>"auth-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Auth"]}}, "/auth/{id}/"=>{"delete"=>{"summary"=>"Delete an Authentication Setting", "description"=>"Delete an Authentication Setting", "operationId"=>"deleteAnAuthenticationSetting", "x-api-path-slug"=>"authid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID string of authentication string youre upda"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Auth"]}, "get"=>{"summary"=>"Get an existing Authentication Setting", "description"=>"Get an existing Authentication Setting", "operationId"=>"getAnExistingAuthenticationSetting", "x-api-path-slug"=>"authid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID string of authentication string youre upda"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Auth"]}, "put"=>{"summary"=>"Update an existing Authentication Setting", "description"=>"Update an existing Authentication Setting", "operationId"=>"updateAnExistingAuthenticationSetting", "x-api-path-slug"=>"authid-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID string of authentication string youre upda"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Auth"]}}, "/calls/"=>{"get"=>{"summary"=>"List API Calls", "description"=>"List API Calls", "operationId"=>"listAPICalls", "x-api-path-slug"=>"calls-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Calls"]}, "post"=>{"summary"=>"Create new API Call", "description"=>"Create new API Call", "operationId"=>"createNewAPICall", "x-api-path-slug"=>"calls-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "description"=>"{ meta: { name: Minimal API test name }, request: { method: get, url: http://httpbin", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Calls"]}}, "/calls/auth/{auth_id}/"=>{"get"=>{"summary"=>"List API Calls by Authentication", "description"=>"List API Calls by Authentication", "operationId"=>"listAPICallsbyAuthentication", "x-api-path-slug"=>"callsauthauth-id-get", "parameters"=>[{"in"=>"path", "name"=>"auth_id", "description"=>"The ID of the authentication setting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Calls", "Auth", "Auth"]}}, "/calls/{id}/"=>{"delete"=>{"summary"=>"Delete an API Call", "description"=>"Delete an API Call", "operationId"=>"deleteAnAPICall", "x-api-path-slug"=>"callsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID string of API Call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Calls"]}, "get"=>{"summary"=>"Get an existing API Call", "description"=>"Get an existing API Call", "operationId"=>"getAnExistingAPICall", "x-api-path-slug"=>"callsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID string of API Call"}, {"in"=>"query", "name"=>"kind", "description"=>"Granularity of data required, one of DAY, WEEK, MONTH, tYEAR"}, {"in"=>"query", "name"=>"location_id", "description"=>"Location where the API Call was made"}, {"in"=>"query", "name"=>"time", "description"=>"ISO formatted date string for the period you wish to view"}, {"in"=>"query", "name"=>"type", "description"=>"Return stats for all calls in the time period specified which had this result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Calls"]}, "put"=>{"summary"=>"Update an existing API Call", "description"=>"Update an existing API Call", "operationId"=>"updateAnExistingAPICall", "x-api-path-slug"=>"callsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"{ request: { parameters: [ { key: testing, value: bar }, { key: raspberry, value: 2 } ] } }", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID string of API Call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Calls"]}}, "/calls/{id}/run"=>{"post"=>{"summary"=>"Trigger an API Call to run", "description"=>"Trigger an API Call to run", "operationId"=>"triggerAnAPICallToRun", "x-api-path-slug"=>"callsidrun-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"{ location_id: , context: { foo: 1234, bar: %%RESULT_ID%%, datum: %%DATETIME%% } }", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"formData", "name"=>"context", "description"=>"Dictionary of variable names and their values"}, {"in"=>"path", "name"=>"id", "description"=>"ID string of API Call"}, {"in"=>"formData", "name"=>"location_id", "description"=>"Location ID of test agent that will make the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Calls", "", "Run"]}}, "/calls/{id}/stats/before"=>{"get"=>{"summary"=>"List Stats from before a date for an API Call", "description"=>"List Stats from before a date for an API Call", "operationId"=>"listStatsFromBeforeDateAPICall", "x-api-path-slug"=>"callsidstatsbefore-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID string of API Call"}, {"in"=>"query", "name"=>"kind", "description"=>"Granularity of data required, one of DAY, WEEK, MONTH, YEAR"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"location_id", "description"=>"Location where the API Call was made"}, {"in"=>"query", "name"=>"time", "description"=>"ISO formatted date string for the end of the period you wish to view"}, {"in"=>"query", "name"=>"type", "description"=>"Return stats for all calls in the time period specified which had this result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Calls", "", "Stats", "Before"]}}, "/calls/{id}/stats/since"=>{"get"=>{"summary"=>"List Stats since a date for an API Call", "description"=>"List Stats since a date for an API Call", "operationId"=>"listStatsSinceDateAPICall", "x-api-path-slug"=>"callsidstatssince-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID string of API Call"}, {"in"=>"query", "name"=>"kind", "description"=>"Granularity of data required, one of DAY, WEEK, MONTH, YEAR"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"location_id", "description"=>"Location where the API Call was made"}, {"in"=>"query", "name"=>"time", "description"=>"ISO formatted date string for the start of the period you wish to view"}, {"in"=>"query", "name"=>"type", "description"=>"Return stats for all calls in the time period specified which had this result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Calls", "", "Stats", "Since"]}}, "/deployments/"=>{"get"=>{"summary"=>"List all Deployment", "description"=>"List all Deployment", "operationId"=>"listAllDeployments", "x-api-path-slug"=>"deployments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Deployments"]}, "post"=>{"summary"=>"Create a new Deployment", "description"=>"Create a new Deployment", "operationId"=>"createANewDeployment", "x-api-path-slug"=>"deployments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"{ deployment: { target_id: agxkZXZ-dmlhdGVzdHNyFwsSClRlc3RTZXR1cDIYgICAgKDL6gsM, frequency: 12, location_id: } }", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Deployments"]}}, "/deployments/call/{call_id}/"=>{"get"=>{"summary"=>"Get all Deployments for an API Call", "description"=>"Get all Deployments for an API Call", "operationId"=>"getAllDeploymentForAPICall", "x-api-path-slug"=>"deploymentscallcall-id-get", "parameters"=>[{"in"=>"path", "name"=>"call_id", "description"=>"ID of the API Call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Deployments", "Call", "Call"]}}, "/deployments/workflow/{workflow_id}"=>{"get"=>{"summary"=>"Get all Deployments for a Workflow", "description"=>"Get all Deployments for a Workflow", "operationId"=>"getAllDeploymentForAWorkflow", "x-api-path-slug"=>"deploymentsworkflowworkflow-id-get", "parameters"=>[{"in"=>"path", "name"=>"workflow_id", "description"=>"ID of the Workflow"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Deployments", "Workflow", "Workflow"]}}, "/deployments/{id}/"=>{"delete"=>{"summary"=>"Delete a Deployment", "description"=>"Delete a Deployment", "operationId"=>"deleteADeployment", "x-api-path-slug"=>"deploymentsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID string of deployment you are updating"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Deployments"]}, "get"=>{"summary"=>"Get an existing Deployment", "description"=>"Get an existing Deployment", "operationId"=>"getAnExistingDeployment", "x-api-path-slug"=>"deploymentsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID string of deployment you are updating"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Deployments"]}, "put"=>{"summary"=>"Update an existing Deployment", "description"=>"Update an existing Deployment", "operationId"=>"updateAnExistingDeployment", "x-api-path-slug"=>"deploymentsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"{ deployment: { target_id: __PARENT_ID__, frequency: 15, location_id: } }", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID string of deployment you are updating"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Deployments"]}}, "/reports/"=>{"get"=>{"summary"=>"List all Reports", "description"=>"List all Reports", "operationId"=>"listAllReports", "x-api-path-slug"=>"reports-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Reports"]}, "post"=>{"summary"=>"Create a new Report", "description"=>"Create a new Report", "operationId"=>"createANewReport", "x-api-path-slug"=>"reports-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"{ meta: { name: Minimal Report name } }", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Reports"]}}, "/reports/{id}/"=>{"delete"=>{"summary"=>"Delete a Report", "description"=>"Delete a Report", "operationId"=>"deleteAReport", "x-api-path-slug"=>"reportsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID string of Report you are updating"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Reports"]}, "get"=>{"summary"=>"Get an existing Report", "description"=>"Get an existing Report", "operationId"=>"getAnExistingReport", "x-api-path-slug"=>"reportsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID string of Report you are updating"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Reports"]}, "put"=>{"summary"=>"Update an existing Report", "description"=>"Update an existing Report", "operationId"=>"updateAnExistingReport", "x-api-path-slug"=>"reportsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"{ meta: { name: Minimal Report name bad create }, groups: [ { name: Group Name, rows: [ { call_id: __PARENT_ID__, location_id: }, { call_id: __PARENT_ID__, location_id: } ] }, { name: Group Name 2, rows: [", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID string of Report you are updating"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Reports"]}}, "/tokens/"=>{"get"=>{"summary"=>"List Auth Tokens", "description"=>"List Auth Tokens", "operationId"=>"listAuthTokens", "x-api-path-slug"=>"tokens-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Tokens"]}, "post"=>{"summary"=>"Create a new Auth Token", "description"=>"Create a new Auth Token", "operationId"=>"createANewAuthToken", "x-api-path-slug"=>"tokens-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"{ meta: { auth_id: agxkZXZ-dmlhdGVzdHNyGgsSDVNlcnZpY2VDb25maWcYgICAgKDLmgsM, name: Minimal token name } }", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Tokens"]}}, "/tokens/auth/{auth_id}/"=>{"get"=>{"summary"=>"Get all tokens for an Authentication Setting", "description"=>"Get all tokens for an Authentication Setting", "operationId"=>"getAllTokensForAnAuthenticationSetting", "x-api-path-slug"=>"tokensauthauth-id-get", "parameters"=>[{"in"=>"path", "name"=>"auth_id", "description"=>"ID of the Authentication Settings"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Tokens", "Auth", "Auth"]}}, "/tokens/{id}/"=>{"delete"=>{"summary"=>"Delete an Auth Token", "description"=>"Delete an Auth Token", "operationId"=>"deleteAnAuthToken", "x-api-path-slug"=>"tokensid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID string of Token you are updating"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Tokens"]}, "get"=>{"summary"=>"Get an existing Auth Token", "description"=>"Get an existing Auth Token", "operationId"=>"getAnExistingAuthToken", "x-api-path-slug"=>"tokensid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID string of Token you are updating"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Tokens"]}, "put"=>{"summary"=>"Update an Auth Token", "description"=>"Update an Auth Token", "operationId"=>"updateAnAuthToken", "x-api-path-slug"=>"tokensid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID string of Token you are updating"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Tokens"]}}, "/workflows/"=>{"get"=>{"summary"=>"List all Workflows", "description"=>"List all Workflows", "operationId"=>"listAllWorkflows", "x-api-path-slug"=>"workflows-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Workflows"]}, "post"=>{"summary"=>"Create new Authentication Settings", "description"=>"Create new Authentication Settings", "operationId"=>"createNewAuthenticationSettings", "x-api-path-slug"=>"workflows-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"{ meta: { name: Minimal Auth Settings name, domain: httpbin", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Workflows"]}}, "/workflows/{id}/"=>{"delete"=>{"summary"=>"Delete a Workflow", "description"=>"Delete a Workflow", "operationId"=>"deleteAWorkflow", "x-api-path-slug"=>"workflowsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID string of Workflow you are updating"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Workflows"]}, "get"=>{"summary"=>"Get an existing Workflow", "description"=>"Get an existing Workflow", "operationId"=>"getAnExistingWorkflow", "x-api-path-slug"=>"workflowsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID string of Workflow you are updating"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Workflows"]}, "post"=>{"summary"=>"Trigger a Workflow to run now", "description"=>"Trigger a Workflow to run now", "operationId"=>"triggerAWorkflowToRunNow", "x-api-path-slug"=>"workflowsid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"{ location_id: , context: { foo: 1234, bar: %%RESULT_ID%%, datum: %%DATETIME%% } }", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID string of Workflow you are updating"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Workflows"]}, "put"=>{"summary"=>"Create a new Workflow", "description"=>"Create a new Workflow", "operationId"=>"createANewWorkflow", "x-api-path-slug"=>"workflowsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"{ workflow: { call_ids: [ agxkZXZ-dmlhdGVzdHNyFwsSClRlc3RTZXR1cDIYgICAgKDL6gsM, agxkZXZ-dmlhdGVzdHNyFwsSClRlc3RTZXR1cDIYgICAgKDL6gsM ], handle_cookies: true } }", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID string of Workflow you are updating"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Workflows"]}}}}, "apis"=>{"name"=>"APImetrics", "x-slug"=>"apimetrics", "description"=>"API performance monitoring, Cloud Service, SLA monitoring and analysis that gives you answers, not excuses. Find out how today.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1916-apimetrics.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"2264063", "tags"=>"API Service Provider,Monitoring,My API Stack,Profiles,SaaS,SDIO Partner,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"apimetrics/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"APIMetrics", "x-api-slug"=>"apimetrics", "description"=>"API performance monitoring, Cloud Service, SLA monitoring and analysis that gives you answers, not excuses. Find out how today.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1916-apimetrics.jpg", "humanURL"=>"http://apimetrics.io", "baseURL"=>"https:///", "tags"=>"API Service Provider,Monitoring,My API Stack,Profiles,SaaS,SDIO Partner,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/apimetrics/apimetrics-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base-url", "url"=>"https://client.apimetrics.io"}, {"type"=>"x-blog", "url"=>"http://apimetrics.io/blog/"}, {"type"=>"x-blog-rss", "url"=>"http://apimetrics.io/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/apimetrics"}, {"type"=>"x-developer", "url"=>"https://apimetrics.readme.io/"}, {"type"=>"x-github", "url"=>"https://github.com/APImetrics"}, {"type"=>"x-pricing", "url"=>"http://apimetrics.io/"}, {"type"=>"x-privacy", "url"=>"http://apimetrics.io/privacy"}, {"type"=>"x-terms-of-service", "url"=>"http://apimetrics.io/tos"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/apimetricstats"}, {"type"=>"x-website", "url"=>"http://apimetrics.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
flat{"flat-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Flat", "x-complete"=>1, "info"=>{"title"=>"Flat", "description"=>"the-flat-api-allows-you-to-easily-extend-the-abilities-of-the-flat-platformhttpsflat-io-with-a-wide-range-of-use-cases-including-the-following-creating-and-importing-new-music-scores-using-musicxml-or-midi-files--browsing-updating-copying-exporting-the-users-scores-for-example-in-mp3-wav-or-midi--managing-educational-resources-with-flat-for-education-creating-updating-the-organization-accounts-the-classes-rosters-and-assignments--the-flat-api-is-built-on-http--our-api-is-restful-it-has-predictable-resource-urls--it-returns-http-response-codes-to-indicate-errors--it-also-accepts-and-returns-json-in-the-http-body--", "termsOfService"=>"https://flat.io/legal", "contact"=>{"name"=>"Flat", "url"=>"https://flat.io/support", "email"=>"developers@flat.io"}, "version"=>"2.1.0"}, "host"=>"api.flat.io", "basePath"=>"/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/groups/{group}/scores"=>{"get"=>{"summary"=>"List group's scores", "description"=>"Get the list of scores shared with a group.", "operationId"=>"getGroupScores", "x-api-path-slug"=>"groupsgroupscores-get", "parameters"=>[{"in"=>"path", "name"=>"group", "description"=>"Unique identifier of the group"}, {"in"=>"query", "name"=>"parent", "description"=>"Filter the score forked from the score id `parent`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Groups", "Scores"]}}, "/me"=>{"get"=>{"summary"=>"Get current user profile", "description"=>"Get details about the current authenticated User.", "operationId"=>"getAuthenticatedUser", "x-api-path-slug"=>"me-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "User", "Profile"]}}, "/scores"=>{"post"=>{"summary"=>"Create a new score", "description"=>"Use this API method to **create a new music score in the current User account**. You will need a MusicXML 3 (`vnd.recordare.musicxml` or `vnd.recordare.musicxml+xml`) or a MIDI (`audio/midi`) file to create the new Flat document.\n\nThis API call will automatically create the first revision of the document, the score can be modified by the using our web application or by uploading a new revision of this file (`POST /v2/scores/{score}/revisions/{revision}`).\n\nThe currently authenticated user will be granted owner of the file and will be able to add other collaborators (users and groups).", "operationId"=>"createScore", "x-api-path-slug"=>"scores-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Score"]}}, "/scores/{score}"=>{"delete"=>{"summary"=>"Delete a score", "description"=>"This API call will schedule the deletion of the score, its revisions, and whole history.\nThe user calling this API method must have the `aclAdmin` rights on this document to process this action.\nThe score won't be accessible anymore after calling this method and the user's quota will directly be updated.", "operationId"=>"deleteScore", "x-api-path-slug"=>"scoresscore-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Score"]}, "get"=>{"summary"=>"Get a score's metadata", "description"=>"Get the details of a score identified by the `score` parameter in the URL.\nThe currently authenticated user must have at least a read access to the document to use this API call.", "operationId"=>"getScore", "x-api-path-slug"=>"scoresscore-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scores", "Metadata"]}, "put"=>{"summary"=>"Edit a score's metadata", "description"=>"This API method allows you to change the metadata of a score document (e.g. its `title` or `privacy`), all the properties are optional.\n\nTo edit the file itself, create a new revision using the appropriate method (`POST /v2/scores/{score}/revisions/{revision}`).", "operationId"=>"editScore", "x-api-path-slug"=>"scoresscore-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Scores", "Metadata"]}}, "/scores/{score}/collaborators"=>{"get"=>{"summary"=>"List the collaborators", "description"=>"This API call will list the different collaborators of a score and their rights on the document. The returned list will at least contain the owner of the document.\n\nCollaborators can be a single user (the object `user` will be populated) or a group (the object `group` will be populated).", "operationId"=>"getScoreCollaborators", "x-api-path-slug"=>"scoresscorecollaborators-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Collaborators"]}, "post"=>{"summary"=>"Add a new collaborator", "description"=>"Share a score with a single user or a group. This API call allows to add, invite and update the collaborators of a document.\n- To add an existing Flat user to the document, specify its unique identifier in the `user` property.\n- To invite an external user to the document, specify its email in the `userEmail` property.\n- To add a Flat group to the document, specify its unique identifier in the `group` property.\n- To update an existing collaborator, process the same request with different rights.", "operationId"=>"addScoreCollaborator", "x-api-path-slug"=>"scoresscorecollaborators-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Collaborator"]}}, "/scores/{score}/collaborators/{collaborator}"=>{"delete"=>{"summary"=>"Delete a collaborator", "description"=>"Remove the specified collaborator from the score", "operationId"=>"removeScoreCollaborator", "x-api-path-slug"=>"scoresscorecollaboratorscollaborator-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collaborator"]}, "get"=>{"summary"=>"Get a collaborator", "description"=>"Get the information about a collaborator (User or Group).", "operationId"=>"getScoreCollaborator", "x-api-path-slug"=>"scoresscorecollaboratorscollaborator-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collaborator"]}}, "/scores/{score}/comments"=>{"get"=>{"summary"=>"List comments", "description"=>"This method lists the different comments added on a music score (documents and inline) sorted by their post dates.", "operationId"=>"getScoreComments", "x-api-path-slug"=>"scoresscorecomments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Comments"]}, "post"=>{"summary"=>"Post a new comment", "description"=>"Post a document or a contextualized comment on a document.\n\nPlease note that this method includes an anti-spam system for public scores. We don't guarantee that your comments will be accepted and displayed to end-user. Comments are be blocked by returning a `403` HTTP error and hidden from other users when the `spam` property is `true`.", "operationId"=>"postScoreComment", "x-api-path-slug"=>"scoresscorecomments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Comment"]}}, "/scores/{score}/comments/{comment}"=>{"delete"=>{"summary"=>"Delete a comment", "description"=>"", "operationId"=>"deleteScoreComment", "x-api-path-slug"=>"scoresscorecommentscomment-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment"]}, "put"=>{"summary"=>"Update an existing comment", "description"=>"", "operationId"=>"updateScoreComment", "x-api-path-slug"=>"scoresscorecommentscomment-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Existing", "Comment"]}}, "/scores/{score}/comments/{comment}/resolved"=>{"delete"=>{"summary"=>"Mark the comment as unresolved", "description"=>"", "operationId"=>"markScoreCommentUnresolved", "x-api-path-slug"=>"scoresscorecommentscommentresolved-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mark", "Comment", "As", "Unresolved"]}, "put"=>{"summary"=>"Mark the comment as resolved", "description"=>"", "operationId"=>"markScoreCommentResolved", "x-api-path-slug"=>"scoresscorecommentscommentresolved-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mark", "Comment", "As", "Resolved"]}}, "/scores/{score}/fork"=>{"post"=>{"summary"=>"Fork a score", "description"=>"This API call will make a copy of the last revision of the specified score and create a new score. The copy of the score will have a privacy set to `private`.\n\nWhen using a [Flat for Education](https://flat.io/edu) account, the inline and contextualized comments will be accessible in the child document.", "operationId"=>"forkScore", "x-api-path-slug"=>"scoresscorefork-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fork", "Score"]}}, "/scores/{score}/revisions"=>{"get"=>{"summary"=>"List the revisions", "description"=>"When creating a score or saving a new version of a score, a revision is created in our storage. This method allows you to list all of them, sorted by last modification.\n\nDepending the plan of the account, this list can be trunked to the few last revisions.", "operationId"=>"getScoreRevisions", "x-api-path-slug"=>"scoresscorerevisions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Revisions"]}, "post"=>{"summary"=>"Create a new revision", "description"=>"Update a score by uploading a new revision for this one.", "operationId"=>"createScoreRevision", "x-api-path-slug"=>"scoresscorerevisions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Revision"]}}, "/scores/{score}/revisions/{revision}"=>{"get"=>{"summary"=>"Get a score revision", "description"=>"When creating a score or saving a new version of a score, a revision is created in our storage. This method allows you to get a specific\nrevision metadata.", "operationId"=>"getScoreRevision", "x-api-path-slug"=>"scoresscorerevisionsrevision-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Score", "Revision"]}}, "/scores/{score}/revisions/{revision}/{format}"=>{"get"=>{"summary"=>"Get a score revision data", "description"=>"Retrieve the file corresponding to a score revision (the following formats are available: Flat JSON/Adagio JSON `json`, MusicXML\n`mxl`/`xml`, MP3 `mp3`, WAV `wav`, MIDI `midi`, or a tumbnail of the first page `thumbnail.png`).", "operationId"=>"getScoreRevisionData", "x-api-path-slug"=>"scoresscorerevisionsrevisionformat-get", "parameters"=>[{"in"=>"path", "name"=>"format", "description"=>"The format of the file you will retrieve"}, {"in"=>"query", "name"=>"onlyCached", "description"=>"Only return files already generated and cached in Flats productioncache"}, {"in"=>"query", "name"=>"parts", "description"=>"An optional a set of parts to be exported"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Score", "Revision", "Data"]}}, "/users/{user}"=>{"get"=>{"summary"=>"Get a public user profile", "description"=>"Get a public profile of a Flat User.", "operationId"=>"getUser", "x-api-path-slug"=>"usersuser-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"This route parameter is the unique identifier of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Public", "User", "Profile"]}}, "/users/{user}/likes"=>{"get"=>{"summary"=>"List liked scores", "description"=>"", "operationId"=>"gerUserLikes", "x-api-path-slug"=>"usersuserlikes-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"Return only the identifiers of the scores"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Liked", "Scores"]}}, "/users/{user}/scores"=>{"get"=>{"summary"=>"List user's scores", "description"=>"Get the list of scores owned by the User", "operationId"=>"getUserScores", "x-api-path-slug"=>"usersuserscores-get", "parameters"=>[{"in"=>"query", "name"=>"parent", "description"=>"Filter the score forked from the score id `parent`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Users", "Scores"]}}}}, "apis"=>{"name"=>"Flat", "x-slug"=>"flat", "description"=>"Whether youre a beginner or a professional composer, our user-friendly music composition software gives you all the tools that you need to make your own sheet music. You can write, listen, share and discover music scores right in your web browser on any device", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/flat-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,General Data,Music,Profiles,Relative Data", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"flat/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Flat", "x-api-slug"=>"flat", "description"=>"The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: Creating and importing new music scores using MusicXML or MIDI files. Browsing, updating, copying, exporting the users scores (for example in MP3, WAV or MIDI). Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/flat-logo.png", "humanURL"=>"http://flat.io", "baseURL"=>"https://api.flat.io//v2", "tags"=>"API Provider,General Data,Music,Profiles,Relative Data", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/flat/usersuserscores-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/flat/flat-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"https://flat.io/developers"}, {"type"=>"x-embeddable", "url"=>"https://flat.io/developers/embed"}, {"type"=>"x-github", "url"=>"https://github.com/FlatIO"}, {"type"=>"x-pricing", "url"=>"https://flat.io/pricing"}, {"type"=>"x-privacy-policy", "url"=>"https://flat.io/help/en/policies/#coppa-and-ferpa-compliance"}, {"type"=>"x-support", "url"=>"https://flat.io/help"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/flat_io"}, {"type"=>"x-website", "url"=>"http://flat.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
rebilly{"rebilly-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Rebilly", "x-complete"=>1, "info"=>{"title"=>"Rebilly", "description"=>"-introductionthe-rebilly-api-is-built-on-http---our-api-is-restful---it-has-predictableresource-urls---it-returns-http-response-codes-to-indicate-errors---it-alsoaccepts-and-returns-json-in-the-http-body---you-can-use-your-favoritehttprest-library-for-your-programming-language-to-use-rebillys-api-oryou-can-use-one-of-our-sdks-currently-available-in-phphttpsgithub-comrebillyrebillyphpand-chttpsgithub-comrebillyrebillydotnetclient--authenticationwhen-you-sign-up-for-an-account-you-are-given-your-first-api-key-you-can-generate-additional-api-keys-and-delete-api-keys-as-you-mayneed-to-rotate-your-keys-in-the-future--you-authenticate-to-therebilly-api-by-providing-your-secret-key-in-the-request-header-rebilly-offers-three-forms-of-authentication--private-key-json-web-tokens-andpublic-key--private-key-authenticates-each-request-by-searching-for-the-presenceof-an-http-header-rebapikey--jwt-authenticates-each-request-by-the-http-header-authorization--public-key-authenticates-by-the-http-header-rebauth-read-more-on-this-below-rebilly-also-offers-json-web-tokens-jwt-authentication-where-you-can-controlthe-specific-granular-permissions-and-expiration-for-that-jwt---we-call-our-resourcefor-generating-jwt-sessionstagsessions-rebilly-also-has-a-clientside-authentication-scheme-that-uses-anapiuser-and-hmacsha1-signature-only-for-the-tokens-resource-sothat-you-may-safely-create-tokens-from-the-clientside-without-compromisingyour-secret-keys-never-share-your-secret-keys--keep-them-guarded-and-secure-the-clientside-authentication-scheme-uses-one-http-header-named-rebauth--redocinject-securitydefinitions--php-sdkfor-all-php-sdk-examples-provided-in-this-spec-you-will-need-to-configure-client-you-may-do-it-like-thisphpclient--new-rebillyclient----apikey--yourapikeyhere----baseurl--httpsapi-rebilly-com", "termsOfService"=>"https://www.rebilly.com/terms/", "contact"=>{"name"=>"Rebilly API Support", "url"=>"https://www.rebilly.com/contact/", "email"=>"integrations@rebilly.com"}, "version"=>"2.1"}, "host"=>"api.rebilly.com", "basePath"=>"/v2.1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/3dsecure"=>{"get"=>{"summary"=>"Retrieve a list of ThreeDSecure entries", "description"=>"Retrieve a list of ThreeDSecure entries", "operationId"=>"3dsecure.get", "x-api-path-slug"=>"3dsecure-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "ThreeDSecure", "Entries"]}, "post"=>{"summary"=>"Create a ThreeDSecure entry", "description"=>"Create a ThreeDSecure entry", "operationId"=>"3dsecure.post", "x-api-path-slug"=>"3dsecure-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"ThreeDSecure resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ThreeDSecure", "Entry"]}}, "/3dsecure/{id}"=>{"get"=>{"summary"=>"Retrieve a ThreeDSecure entry", "description"=>"Retrieve a ThreeDSecure entry with specified identifier string", "operationId"=>"3dsecure.id.get", "x-api-path-slug"=>"3dsecureid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "ThreeDSecure", "Entry"]}}, "/attachments"=>{"get"=>{"summary"=>"Retrieve a list of Attachments", "description"=>"Retrieve a list of Attachments", "operationId"=>"attachments.get", "x-api-path-slug"=>"attachments-get", "parameters"=>[{"in"=>"query", "name"=>"sort", "description"=>"The collection items sort field and order (prefix with - for descending sort)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Attachments"]}, "post"=>{"summary"=>"Create an Attachment", "description"=>"Create an Attachment", "operationId"=>"attachments.post", "x-api-path-slug"=>"attachments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attachment resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/attachments/{id}"=>{"delete"=>{"summary"=>"Delete an Attachment", "description"=>"Delete the Attachment with predefined identifier string", "operationId"=>"attachments.id.delete", "x-api-path-slug"=>"attachmentsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}, "get"=>{"summary"=>"Retrieve an Attachment", "description"=>"Retrieve a Attachment with specified identifier string", "operationId"=>"attachments.id.get", "x-api-path-slug"=>"attachmentsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Attachment"]}, "put"=>{"summary"=>"Update the Attachment with predefined ID", "description"=>"Update the Attachment with predefined ID", "operationId"=>"attachments.id.put", "x-api-path-slug"=>"attachmentsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attachment resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment", "Predefined", "ID"]}}, "/authentication-options"=>{"get"=>{"summary"=>"Read current authentication options", "description"=>"Read current authentication options", "operationId"=>"authentication_options.get", "x-api-path-slug"=>"authenticationoptions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Read", "Current", "Authentication", "Options"]}, "put"=>{"summary"=>"Change authentication options", "description"=>"Change options", "operationId"=>"authentication_options.put", "x-api-path-slug"=>"authenticationoptions-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Authentication Options resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change", "Authentication", "Options"]}}, "/authentication-tokens"=>{"get"=>{"summary"=>"Retrieve a list of auth tokens", "description"=>"Retrieve a list of auth tokens", "operationId"=>"authentication_tokens.get", "x-api-path-slug"=>"authenticationtokens-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Auth", "Tokens"]}, "post"=>{"summary"=>"Login", "description"=>"Login a user (customer)", "operationId"=>"authentication_tokens.post", "x-api-path-slug"=>"authenticationtokens-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"AuthenticationToken resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Login"]}}, "/authentication-tokens/{token}"=>{"delete"=>{"summary"=>"Logout a user", "description"=>"Logout a user", "operationId"=>"authentication_tokens.token.delete", "x-api-path-slug"=>"authenticationtokenstoken-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logout", "User"]}, "get"=>{"summary"=>"Verify", "description"=>"Verify an authentication token", "operationId"=>"authentication_tokens.token.get", "x-api-path-slug"=>"authenticationtokenstoken-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Verify"]}}, "/bank-accounts"=>{"get"=>{"summary"=>"Retrieve a list of bank accounts", "description"=>"Retrieve a list of Bank Accounts", "operationId"=>"bank_accounts.get", "x-api-path-slug"=>"bankaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Bank", "Accounts"]}, "post"=>{"summary"=>"Create a Bank Account", "description"=>"Create a Bank Account", "operationId"=>"bank_accounts.post", "x-api-path-slug"=>"bankaccounts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"BankAccount resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bank", "Account"]}}, "/bank-accounts/{id}"=>{"get"=>{"summary"=>"Retrieve a Bank Account", "description"=>"Retrieve a Bank Account with specified identifier string", "operationId"=>"bank_accounts.id.get", "x-api-path-slug"=>"bankaccountsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Bank", "Account"]}, "put"=>{"summary"=>"Create a BankAccount with predefined ID", "description"=>"Create or update a BankAccount with predefined identifier string", "operationId"=>"bank_accounts.id.put", "x-api-path-slug"=>"bankaccountsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"BankAccount resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankAccount", "Predefined", "ID"]}}, "/bank-accounts/{id}/deactivation"=>{"post"=>{"summary"=>"Deactivate a Bank Account", "description"=>"Deactivate a Bank Account", "operationId"=>"bank_accounts.id.deactivation.post", "x-api-path-slug"=>"bankaccountsiddeactivation-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deactivate", "Bank", "Account"]}}, "/blacklists"=>{"get"=>{"summary"=>"Retrieve a list of blacklists", "description"=>"Retrieve a list of blacklists", "operationId"=>"blacklists.get", "x-api-path-slug"=>"blacklists-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Blacklists"]}, "post"=>{"summary"=>"Create a blacklist", "description"=>"Create a blacklist", "operationId"=>"blacklists.post", "x-api-path-slug"=>"blacklists-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Blacklist resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blacklist"]}}, "/blacklists/{id}"=>{"delete"=>{"summary"=>"Delete a blacklist", "description"=>"Delete a blacklist with predefined identifier string", "operationId"=>"blacklists.id.delete", "x-api-path-slug"=>"blacklistsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blacklist"]}, "get"=>{"summary"=>"Retrieve a blacklist", "description"=>"Retrieve a blacklist with specified identifier string", "operationId"=>"blacklists.id.get", "x-api-path-slug"=>"blacklistsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Blacklist"]}, "put"=>{"summary"=>"Create a blacklist with predefined ID", "description"=>"Create a blacklist with predefined identifier string", "operationId"=>"blacklists.id.put", "x-api-path-slug"=>"blacklistsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Blacklist resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blacklist", "Predefined", "ID"]}}, "/contacts"=>{"get"=>{"summary"=>"Retrieve a list of contacts", "description"=>"Retrieve a list of contacts", "operationId"=>"contacts.get", "x-api-path-slug"=>"contacts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Contacts"]}, "post"=>{"summary"=>"Create a contact", "description"=>"Create a contact", "operationId"=>"contacts.post", "x-api-path-slug"=>"contacts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Contact resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/contacts/{id}"=>{"delete"=>{"summary"=>"Delete a contact", "description"=>"Delete a contact with predefined identifier string", "operationId"=>"contacts.id.delete", "x-api-path-slug"=>"contactsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}, "get"=>{"summary"=>"Retrieve a contact", "description"=>"Retrieve a contact with specified identifier string", "operationId"=>"contacts.id.get", "x-api-path-slug"=>"contactsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Contact"]}, "put"=>{"summary"=>"Create or update a contact with predefined ID", "description"=>"Create or update a contact with predefined identifier string", "operationId"=>"contacts.id.put", "x-api-path-slug"=>"contactsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Contact resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Contact", "Predefined", "ID"]}}, "/coupons"=>{"get"=>{"summary"=>"Retrieve a list of coupons", "description"=>"Retrieve a list of coupons", "operationId"=>"coupons.get", "x-api-path-slug"=>"coupons-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Coupons"]}, "post"=>{"summary"=>"Create a coupon", "description"=>"Create a coupon", "operationId"=>"coupons.post", "x-api-path-slug"=>"coupons-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Coupon resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Coupon"]}}, "/coupons-redemptions"=>{"get"=>{"summary"=>"Retrieve a list of coupon redemptions", "description"=>"", "operationId"=>"coupons_redemptions.get", "x-api-path-slug"=>"couponsredemptions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Coupon", "Redemptions"]}, "post"=>{"summary"=>"Redeem a coupon", "description"=>"Redeem a coupon", "operationId"=>"coupons_redemptions.post", "x-api-path-slug"=>"couponsredemptions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Redeem a coupon", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redeem", "Coupon"]}}, "/coupons-redemptions/{id}"=>{"get"=>{"summary"=>"Retrieve a coupon redemption with specified identifier string", "description"=>"", "operationId"=>"coupons_redemptions.id.get", "x-api-path-slug"=>"couponsredemptionsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Coupon", "Redemption", "Specified", "Identifier", "String"]}}, "/coupons-redemptions/{id}/cancel"=>{"post"=>{"summary"=>"Cancel a coupon redemption", "description"=>"", "operationId"=>"coupons_redemptions.id.cancel.post", "x-api-path-slug"=>"couponsredemptionsidcancel-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Coupon", "Redemption"]}}, "/coupons/{redemptionCode}"=>{"get"=>{"summary"=>"Retrieve a coupon", "description"=>"Retrieve a coupon with specified redemption code string", "operationId"=>"coupons.redemptionCode.get", "x-api-path-slug"=>"couponsredemptioncode-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Coupon"]}, "put"=>{"summary"=>"Create or update a coupon with predefined redemption code", "description"=>"Create or update a coupon with predefined redemption code", "operationId"=>"coupons.redemptionCode.put", "x-api-path-slug"=>"couponsredemptioncode-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Coupon resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Coupon", "Predefined", "Redemption", "Code"]}}, "/coupons/{redemptionCode}/expiration"=>{"post"=>{"summary"=>"Set a coupon's expiration time.", "description"=>"Set a coupon's expiry time with the specified redemption code.\nThe expiredTime of a coupon must be greater than its issuedTime.\nThis cannot be performed on expired coupons.", "operationId"=>"coupons.redemptionCode.expiration.post", "x-api-path-slug"=>"couponsredemptioncodeexpiration-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Coupon resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Coupons", "Expiration", "Time"]}}, "/credentials"=>{"get"=>{"summary"=>"Retrieve a list of credentials", "description"=>"Retrieve a list of credentials", "operationId"=>"credentials.get", "x-api-path-slug"=>"credentials-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Credentials"]}, "post"=>{"summary"=>"Create a credential", "description"=>"Create a credential", "operationId"=>"credentials.post", "x-api-path-slug"=>"credentials-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Credential resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Credential"]}}, "/credentials/{id}"=>{"delete"=>{"summary"=>"Delete a credential", "description"=>"Delete a credential with predefined identifier string", "operationId"=>"credentials.id.delete", "x-api-path-slug"=>"credentialsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Credential"]}, "get"=>{"summary"=>"Retrieve a credential", "description"=>"Retrieve a credential with specified identifier string", "operationId"=>"credentials.id.get", "x-api-path-slug"=>"credentialsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Credential"]}, "put"=>{"summary"=>"Create or update a credential with predefined ID", "description"=>"Create or update a credential with predefined identifier string", "operationId"=>"credentials.id.put", "x-api-path-slug"=>"credentialsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Credential resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Credential", "Predefined", "ID"]}}, "/custom-fields/{resource}"=>{"get"=>{"summary"=>"Retrieve Custom Fields", "description"=>"Retrieve a schema of Custom Fields for the given resource type", "operationId"=>"custom_fields.resource.get", "x-api-path-slug"=>"customfieldsresource-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Custom", "Fields"]}}, "/custom-fields/{resource}/{name}"=>{"delete"=>{"summary"=>"Delete a custom field", "description"=>"Delete a custom field by its name", "operationId"=>"custom_fields.resource.name.delete", "x-api-path-slug"=>"customfieldsresourcename-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Field"]}, "get"=>{"summary"=>"Retrieve a Custom Field", "description"=>"Retrieve a schema of the given Custom Field for the given resource type", "operationId"=>"custom_fields.resource.name.get", "x-api-path-slug"=>"customfieldsresourcename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Custom", "Field"]}, "put"=>{"summary"=>"Create or alter a Custom Field", "description"=>"Create or alter a schema of the given Custom Field for the given resource type.", "operationId"=>"custom_fields.resource.name.put", "x-api-path-slug"=>"customfieldsresourcename-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Custom Fields schema of the given resource type", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alter", "Custom", "Field"]}}, "/customers"=>{"get"=>{"summary"=>"Retrieve a list of customers", "description"=>"Retrieve a list of customers", "operationId"=>"customers.get", "x-api-path-slug"=>"customers-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"The response media type"}, {"in"=>"query", "name"=>"sort", "description"=>"The collection items sort field and order (prefix with - for descending sort)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Customers"]}, "post"=>{"summary"=>"Create a customer", "description"=>"Create a customer", "operationId"=>"customers.post", "x-api-path-slug"=>"customers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Customer resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer"]}}, "/customers/{id}"=>{"get"=>{"summary"=>"Retrieve a customer", "description"=>"Retrieve a customer with specified identifier string", "operationId"=>"customers.id.get", "x-api-path-slug"=>"customersid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Customer"]}, "put"=>{"summary"=>"Create a customer with predefined ID", "description"=>"Create a customer with predefined identifier string", "operationId"=>"customers.id.put", "x-api-path-slug"=>"customersid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Customer resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Predefined", "ID"]}}, "/customers/{id}/lead-source"=>{"delete"=>{"summary"=>"Delete a Lead Source for a customer", "description"=>"Delete a Lead Source that belongs to a certain customer", "operationId"=>"customers.id.lead_source.delete", "x-api-path-slug"=>"customersidleadsource-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lead", "Sourcea", "Customer"]}, "get"=>{"summary"=>"Retrieve a customer's Lead Source", "description"=>"Retrieve a Lead Source of given customer", "operationId"=>"customers.id.lead_source.get", "x-api-path-slug"=>"customersidleadsource-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Customers", "Lead", "Source"]}, "put"=>{"summary"=>"Create a Lead Source for a customer", "description"=>"Create a Lead Source for a customer", "operationId"=>"customers.id.lead_source.put", "x-api-path-slug"=>"customersidleadsource-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Lead Source resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lead", "Sourcea", "Customer"]}}, "/disputes"=>{"get"=>{"summary"=>"Retrieve a list of disputes", "description"=>"Retrieve a list of disputes", "operationId"=>"disputes.get", "x-api-path-slug"=>"disputes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Disputes"]}, "post"=>{"summary"=>"Create a dispute", "description"=>"Create a dispute", "operationId"=>"disputes.post", "x-api-path-slug"=>"disputes-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Dispute resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dispute"]}}, "/disputes/{id}"=>{"get"=>{"summary"=>"Retrieve a dispute", "description"=>"Retrieve a dispute with specified identifier string", "operationId"=>"disputes.id.get", "x-api-path-slug"=>"disputesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Dispute"]}, "put"=>{"summary"=>"Create or update a Dispute with predefined ID", "description"=>"Create or update a Dispute with predefined identifier string", "operationId"=>"disputes.id.put", "x-api-path-slug"=>"disputesid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Dispute resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Dispute", "Predefined", "ID"]}}, "/disputes/{id}/matched-rules"=>{"get"=>{"summary"=>"Get matched rules for the dispute", "description"=>"Get matched rules for the dispute", "operationId"=>"disputes.id.matched_rules.get", "x-api-path-slug"=>"disputesidmatchedrules-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Matched", "Rulesthe", "Dispute"]}}, "/files"=>{"get"=>{"summary"=>"Retrieve a list of files", "description"=>"Retrieve a list of files", "operationId"=>"files.get", "x-api-path-slug"=>"files-get", "parameters"=>[{"in"=>"query", "name"=>"sort", "description"=>"The collection items sort field and order (prefix with - for descending sort)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Files"]}, "post"=>{"summary"=>"Create a file", "description"=>"Create a file", "operationId"=>"files.post", "x-api-path-slug"=>"files-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Additionally, a file can be sent with a multipart/form-data POST request or the files raw body can be sent as a request body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}}, "/files/{id}"=>{"delete"=>{"summary"=>"Delete a File", "description"=>"Delete the File with predefined identifier string", "operationId"=>"files.id.delete", "x-api-path-slug"=>"filesid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}, "get"=>{"summary"=>"Retrieve a File Record", "description"=>"Retrieve a File with specified identifier string", "operationId"=>"files.id.get", "x-api-path-slug"=>"filesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "File", "Record"]}, "put"=>{"summary"=>"Update the File with predefined ID. Note that file can be uploaded with POST only.", "description"=>"Update the File with predefined ID", "operationId"=>"files.id.put", "x-api-path-slug"=>"filesid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"File resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File", "Predefined", "ID", "", "Note", "That", "File", "Can", "Be", "Uploaded", "POST", "Only"]}}, "/files/{id}/download"=>{"get"=>{"summary"=>"Download a file", "description"=>"Download a file", "operationId"=>"files.id.download.get", "x-api-path-slug"=>"filesiddownload-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Download", "File"]}}, "/files/{id}/download{extension}"=>{"get"=>{"summary"=>"Download image in specific format", "description"=>"Download image in specific format. Images are converted server-side", "operationId"=>"files.id.downloadextension.get", "x-api-path-slug"=>"filesiddownloadextension-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Download", "Image", "In", "Specific", "Format"]}}, "/invoices"=>{"get"=>{"summary"=>"Retrieve a list of invoices", "description"=>"Retrieve a list of invoices", "operationId"=>"invoices.get", "x-api-path-slug"=>"invoices-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"The response media type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Invoices"]}, "post"=>{"summary"=>"Create an invoice", "description"=>"Create an invoice", "operationId"=>"invoices.post", "x-api-path-slug"=>"invoices-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Invoice resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice"]}}, "/invoices/{id}"=>{"get"=>{"summary"=>"Retrieve an invoice", "description"=>"Retrieve an invoice with specified identifier string", "operationId"=>"invoices.id.get", "x-api-path-slug"=>"invoicesid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"The response media type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Invoice"]}, "put"=>{"summary"=>"Create or update an invoice with predefined ID", "description"=>"Create or update an invoice with predefined identifier string", "operationId"=>"invoices.id.put", "x-api-path-slug"=>"invoicesid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Invoice resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Invoice", "Predefined", "ID"]}}, "/invoices/{id}/abandon"=>{"post"=>{"summary"=>"Abandon an invoice", "description"=>"Abandon an invoice with specified identifier string", "operationId"=>"invoices.id.abandon.post", "x-api-path-slug"=>"invoicesidabandon-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Abandon", "Invoice"]}}, "/invoices/{id}/issue"=>{"post"=>{"summary"=>"Issue an invoice", "description"=>"Issue an invoice with specified identifier string", "operationId"=>"invoices.id.issue.post", "x-api-path-slug"=>"invoicesidissue-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"InvoiceIssue resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Issue", "Invoice"]}}, "/invoices/{id}/items"=>{"get"=>{"summary"=>"Retrieve invoice items", "description"=>"Retrieve an invoice items with specified invoice identifier string", "operationId"=>"invoices.id.items.get", "x-api-path-slug"=>"invoicesiditems-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Invoice", "Items"]}, "post"=>{"summary"=>"Create an invoice item", "description"=>"Create an invoice item", "operationId"=>"invoices.id.items.post", "x-api-path-slug"=>"invoicesiditems-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"InvoiceItem resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice", "Item"]}}, "/invoices/{id}/lead-source"=>{"delete"=>{"summary"=>"Delete a Lead Source for an invoice", "description"=>"Delete a Lead Source that belongs to a certain invoice", "operationId"=>"invoices.id.lead_source.delete", "x-api-path-slug"=>"invoicesidleadsource-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lead", "Sourcean", "Invoice"]}, "get"=>{"summary"=>"Retrieve an invoice's Lead Source", "description"=>"Retrieve a Lead Source of given invoice", "operationId"=>"invoices.id.lead_source.get", "x-api-path-slug"=>"invoicesidleadsource-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Invoices", "Lead", "Source"]}, "put"=>{"summary"=>"Create a Lead Source for an invoice", "description"=>"Create a Lead Source for an invoice", "operationId"=>"invoices.id.lead_source.put", "x-api-path-slug"=>"invoicesidleadsource-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Lead Source resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lead", "Sourcean", "Invoice"]}}, "/invoices/{id}/matched-rules"=>{"get"=>{"summary"=>"Get matched rules for the invoice", "description"=>"Get matched rules for the invoice", "operationId"=>"invoices.id.matched_rules.get", "x-api-path-slug"=>"invoicesidmatchedrules-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Matched", "Rulesthe", "Invoice"]}}, "/invoices/{id}/void"=>{"post"=>{"summary"=>"Void an invoice", "description"=>"Void an invoice with specified identifier string", "operationId"=>"invoices.id.void.post", "x-api-path-slug"=>"invoicesidvoid-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Void", "Invoice"]}}, "/password-tokens"=>{"get"=>{"summary"=>"Retrieve a list of tokens", "description"=>"Retrieve a list of tokens", "operationId"=>"password_tokens.get", "x-api-path-slug"=>"passwordtokens-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Tokens"]}, "post"=>{"summary"=>"Create a Reset Password Token", "description"=>"Create a Reset Password Token", "operationId"=>"password_tokens.post", "x-api-path-slug"=>"passwordtokens-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"ResetPasswordToken resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reset", "Password", "Token"]}}, "/password-tokens/{id}"=>{"delete"=>{"summary"=>"Delete a Reset Password Token", "description"=>"Delete a Reset Password Token with predefined identifier string", "operationId"=>"password_tokens.id.delete", "x-api-path-slug"=>"passwordtokensid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reset", "Password", "Token"]}, "get"=>{"summary"=>"Retrieve a Reset Password Token", "description"=>"Retrieve a Reset Password Token with specified identifier string", "operationId"=>"password_tokens.id.get", "x-api-path-slug"=>"passwordtokensid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Reset", "Password", "Token"]}}, "/payment-cards"=>{"get"=>{"summary"=>"Retrieve a list of Payment Cards", "description"=>"Retrieve a list of Payments Cards", "operationId"=>"payment_cards.get", "x-api-path-slug"=>"paymentcards-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Payment", "Cards"]}, "post"=>{"summary"=>"Create a Payment Card", "description"=>"Create a Payment Card", "operationId"=>"payment_cards.post", "x-api-path-slug"=>"paymentcards-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"PaymentCard resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment", "Card"]}}, "/payment-cards/{id}"=>{"get"=>{"summary"=>"Retrieve a Payment Card", "description"=>"Retrieve a Payment Card with specified identifier string", "operationId"=>"payment_cards.id.get", "x-api-path-slug"=>"paymentcardsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Payment", "Card"]}, "patch"=>{"summary"=>"Update a payment card's cvv value with predefined ID", "description"=>"Update a payment card's cvv value with predefined identifier string", "operationId"=>"payment_cards.id.patch", "x-api-path-slug"=>"paymentcardsid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment card", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment", "Cards", "Cvv", "Value", "Predefined", "ID"]}, "put"=>{"summary"=>"Create a payment card with predefined ID", "description"=>"", "operationId"=>"payment_cards.id.put", "x-api-path-slug"=>"paymentcardsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment card", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment", "Card", "Predefined", "ID"]}}, "/payment-cards/{id}/authorization"=>{"post"=>{"summary"=>"Authorize a Payment Card", "description"=>"Authorize a Payment Card", "operationId"=>"payment_cards.id.authorization.post", "x-api-path-slug"=>"paymentcardsidauthorization-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment Card resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorize", "Payment", "Card"]}}, "/payment-cards/{id}/deactivation"=>{"post"=>{"summary"=>"Deactivate a Payment Card", "description"=>"Deactivate a Payment Card", "operationId"=>"payment_cards.id.deactivation.post", "x-api-path-slug"=>"paymentcardsiddeactivation-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deactivate", "Payment", "Card"]}}, "/payment-cards/{id}/matched-rules"=>{"get"=>{"summary"=>"Get matched rules for the payment card", "description"=>"Get matched rules for the payment card", "operationId"=>"payment_cards.id.matched_rules.get", "x-api-path-slug"=>"paymentcardsidmatchedrules-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Matched", "Rulesthe", "Payment", "Card"]}}, "/payments"=>{"get"=>{"summary"=>"Retrieve a payment list", "description"=>"Retrieve a payment list", "operationId"=>"payments.get", "x-api-path-slug"=>"payments-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"The response media type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Payment", "List"]}, "post"=>{"summary"=>"Create a payment", "description"=>"Create a payment", "operationId"=>"payments.post", "x-api-path-slug"=>"payments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment"]}}, "/payments/{id}"=>{"get"=>{"summary"=>"Retrieve a payment", "description"=>"Retrieve a payment with specified identifier string", "operationId"=>"payments.id.get", "x-api-path-slug"=>"paymentsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Payment"]}, "put"=>{"summary"=>"Create a payment with predefined ID", "description"=>"Make a payment with predefined identifier string", "operationId"=>"payments.id.put", "x-api-path-slug"=>"paymentsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment", "Predefined", "ID"]}}, "/paypal-accounts"=>{"get"=>{"summary"=>"Retrieve a list of PayPal accounts", "description"=>"Retrieve a list of PayPal Accounts", "operationId"=>"paypal_accounts.get", "x-api-path-slug"=>"paypalaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "PayPal", "Accounts"]}, "post"=>{"summary"=>"Create a PayPal Account", "description"=>"Create a PayPal Account", "operationId"=>"paypal_accounts.post", "x-api-path-slug"=>"paypalaccounts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"PayPalAccount resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PayPal", "Account"]}}, "/paypal-accounts/{id}"=>{"get"=>{"summary"=>"Retrieve a PayPal Account", "description"=>"Retrieve a PayPal Account with specified identifier string", "operationId"=>"paypal_accounts.id.get", "x-api-path-slug"=>"paypalaccountsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "PayPal", "Account"]}, "put"=>{"summary"=>"Create a PayPal account with predefined ID", "description"=>"", "operationId"=>"paypal_accounts.id.put", "x-api-path-slug"=>"paypalaccountsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"PayPal Account", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PayPal", "Account", "Predefined", "ID"]}}, "/paypal-accounts/{id}/activation"=>{"post"=>{"summary"=>"Activate a PayPal Account", "description"=>"Activate a PayPal Account", "operationId"=>"paypal_accounts.id.activation.post", "x-api-path-slug"=>"paypalaccountsidactivation-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"PayPal Account resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activate", "PayPal", "Account"]}}, "/paypal-accounts/{id}/deactivation"=>{"post"=>{"summary"=>"Deactivate a PayPal Account", "description"=>"Deactivate a PayPal Account", "operationId"=>"paypal_accounts.id.deactivation.post", "x-api-path-slug"=>"paypalaccountsiddeactivation-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deactivate", "PayPal", "Account"]}}, "/plans"=>{"get"=>{"summary"=>"Retrieve a list of plans", "description"=>"Retrieve a list of plans", "operationId"=>"plans.get", "x-api-path-slug"=>"plans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Plans"]}, "post"=>{"summary"=>"Create a plan", "description"=>"Create a plan", "operationId"=>"plans.post", "x-api-path-slug"=>"plans-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Plan resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Plan"]}}, "/plans/{id}"=>{"delete"=>{"summary"=>"Delete a Plan", "description"=>"Delete a Plan with predefined identifier string", "operationId"=>"plans.id.delete", "x-api-path-slug"=>"plansid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Plan"]}, "get"=>{"summary"=>"Retrieve a plan", "description"=>"Retrieve a plan with specified identifier string", "operationId"=>"plans.id.get", "x-api-path-slug"=>"plansid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Plan"]}, "put"=>{"summary"=>"Create or update a Plan with predefined ID", "description"=>"Create or update a Plan with predefined identifier string", "operationId"=>"plans.id.put", "x-api-path-slug"=>"plansid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Plan resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Plan", "Predefined", "ID"]}}, "/products"=>{"get"=>{"summary"=>"Retrieve a list of products", "description"=>"Retrieve a list of products", "operationId"=>"products.get", "x-api-path-slug"=>"products-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Products"]}, "post"=>{"summary"=>"Create a Product", "description"=>"Create a Product", "operationId"=>"products.post", "x-api-path-slug"=>"products-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Product resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}}, "/products/{id}"=>{"delete"=>{"summary"=>"Delete a product", "description"=>"Delete a product with predefined identifier string", "operationId"=>"products.id.delete", "x-api-path-slug"=>"productsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}, "get"=>{"summary"=>"Retrieve a product", "description"=>"Retrieve a product with specified identifier string", "operationId"=>"products.id.get", "x-api-path-slug"=>"productsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Product"]}, "put"=>{"summary"=>"Create a product with predefined ID", "description"=>"Create a product with predefined identifier string", "operationId"=>"products.id.put", "x-api-path-slug"=>"productsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Product resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "Predefined", "ID"]}}, "/queue/payments"=>{"get"=>{"summary"=>"Retrieve a scheduled payment list", "description"=>"Retrieve a scheduled payment list", "operationId"=>"queue.payments.get", "x-api-path-slug"=>"queuepayments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Scheduled", "Payment", "List"]}}, "/queue/payments/{id}"=>{"get"=>{"summary"=>"Retrieve a scheduled payment", "description"=>"Retrieve a payment with specified identifier string", "operationId"=>"queue.payments.id.get", "x-api-path-slug"=>"queuepaymentsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Scheduled", "Payment"]}, "put"=>{"summary"=>"Update pending payment", "description"=>"", "operationId"=>"queue.payments.id.put", "x-api-path-slug"=>"queuepaymentsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pending", "Payment"]}}, "/shipping-zones"=>{"get"=>{"summary"=>"Retrieve a list of shipping zones", "description"=>"Retrieve a list of shipping zones", "operationId"=>"shipping_zones.get", "x-api-path-slug"=>"shippingzones-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Shipping", "Zones"]}, "post"=>{"summary"=>"Create a Shipping Zone", "description"=>"Create a Shipping Zone", "operationId"=>"shipping_zones.post", "x-api-path-slug"=>"shippingzones-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Shipping Zone resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Zone"]}}, "/shipping-zones/{id}"=>{"delete"=>{"summary"=>"Delete a shipping zone", "description"=>"Delete a shipping zone with predefined identifier string", "operationId"=>"shipping_zones.id.delete", "x-api-path-slug"=>"shippingzonesid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Zone"]}, "get"=>{"summary"=>"Retrieve a shipping zone", "description"=>"Retrieve a shipping zone with specified identifier string", "operationId"=>"shipping_zones.id.get", "x-api-path-slug"=>"shippingzonesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Shipping", "Zone"]}, "put"=>{"summary"=>"Create a shipping zone with predefined ID", "description"=>"Create a shipping zone with predefined identifier string", "operationId"=>"shipping_zones.id.put", "x-api-path-slug"=>"shippingzonesid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Shipping zone resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Zone", "Predefined", "ID"]}}, "/subscriptions"=>{"get"=>{"summary"=>"Retrieve a list of subscriptions", "description"=>"Retrieve a list of subscriptions", "operationId"=>"subscriptions.get", "x-api-path-slug"=>"subscriptions-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"The response media type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Subscriptions"]}, "post"=>{"summary"=>"Create a subscription", "description"=>"Create a subscription", "operationId"=>"subscriptions.post", "x-api-path-slug"=>"subscriptions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Subscription resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/subscriptions/{id}"=>{"get"=>{"summary"=>"Retrieve a subscription", "description"=>"Retrieve a subscription with specified identifier string", "operationId"=>"subscriptions.id.get", "x-api-path-slug"=>"subscriptionsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Subscription"]}, "put"=>{"summary"=>"Create or update a subscription with predefined ID", "description"=>"Create or update a subscription with predefined identifier string", "operationId"=>"subscriptions.id.put", "x-api-path-slug"=>"subscriptionsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Subscription resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Subscription", "Predefined", "ID"]}}, "/subscriptions/{id}/cancel"=>{"post"=>{"summary"=>"Cancel a subscription", "description"=>"Cancel a subscription", "operationId"=>"subscriptions.id.cancel.post", "x-api-path-slug"=>"subscriptionsidcancel-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Only policy", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Subscription"]}}, "/subscriptions/{id}/lead-source"=>{"delete"=>{"summary"=>"Delete a Lead Source for a Subscription", "description"=>"Delete a Lead Source that belongs to a certain Subscription", "operationId"=>"subscriptions.id.lead_source.delete", "x-api-path-slug"=>"subscriptionsidleadsource-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lead", "Sourcea", "Subscription"]}, "get"=>{"summary"=>"Retrieve a subscription's Lead Source", "description"=>"Retrieve a Lead Source of given subscription", "operationId"=>"subscriptions.id.lead_source.get", "x-api-path-slug"=>"subscriptionsidleadsource-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Subscriptions", "Lead", "Source"]}, "put"=>{"summary"=>"Create a Lead Source for a Subscription", "description"=>"Create a Lead Source for a Subscription", "operationId"=>"subscriptions.id.lead_source.put", "x-api-path-slug"=>"subscriptionsidleadsource-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Lead Source resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lead", "Sourcea", "Subscription"]}}, "/subscriptions/{id}/matched-rules"=>{"get"=>{"summary"=>"Get matched rules for the subscription", "description"=>"Get matched rules for the subscription", "operationId"=>"subscriptions.id.matched_rules.get", "x-api-path-slug"=>"subscriptionsidmatchedrules-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Matched", "Rulesthe", "Subscription"]}}, "/subscriptions/{id}/switch"=>{"post"=>{"summary"=>"Switch a subscription", "description"=>"Switch a subscription", "operationId"=>"subscriptions.id.switch.post", "x-api-path-slug"=>"subscriptionsidswitch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"SubscriptionSwitch resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Switch", "Subscription"]}}, "/tax-categories"=>{"get"=>{"summary"=>"Retrieve a list of tax categories", "description"=>"Retrieve a list of tax categories", "operationId"=>"tax_categories.get", "x-api-path-slug"=>"taxcategories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Tax", "Categories"]}}, "/tokens"=>{"get"=>{"summary"=>"Retrieve a list of tokens", "description"=>"Retrieve a list of tokens", "operationId"=>"tokens.get", "x-api-path-slug"=>"tokens-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Tokens"]}, "post"=>{"summary"=>"Create a payment token", "description"=>"Create a token", "operationId"=>"tokens.post", "x-api-path-slug"=>"tokens-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"PaymentToken resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment", "Token"]}}, "/tokens/{token}"=>{"get"=>{"summary"=>"Retrieve a token", "description"=>"Retrieve a token with specified identifier string", "operationId"=>"tokens.token.get", "x-api-path-slug"=>"tokenstoken-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Token"]}}, "/tokens/{token}/expiration"=>{"post"=>{"summary"=>"Expire a token", "description"=>"Expire a token", "operationId"=>"tokens.token.expiration.post", "x-api-path-slug"=>"tokenstokenexpiration-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"PaymentToken resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Expire", "Token"]}}, "/transactions"=>{"get"=>{"summary"=>"Retrieve a list of transactions", "description"=>"Retrieve a list of transactions", "operationId"=>"transactions.get", "x-api-path-slug"=>"transactions-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"The response media type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Transactions"]}}, "/transactions/{id}"=>{"get"=>{"summary"=>"Retrieve a Transaction", "description"=>"Retrieve a Transaction with specified identifier string", "operationId"=>"transactions.id.get", "x-api-path-slug"=>"transactionsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Transaction"]}}, "/transactions/{id}/cancel"=>{"post"=>{"summary"=>"Cancel a pending or suspended transaction", "description"=>"Cancel a scheduled transaction. Once handled a transaction cannot be canceled", "operationId"=>"transactions.id.cancel.post", "x-api-path-slug"=>"transactionsidcancel-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Pending", "Suspended", "Transaction"]}}, "/transactions/{id}/gateway-logs"=>{"get"=>{"summary"=>"Retrieve a Transaction Gateway Logs", "description"=>"Retrieve Gateway communication Logs for Transaction with specified identifier string", "operationId"=>"transactions.id.gateway_logs.get", "x-api-path-slug"=>"transactionsidgatewaylogs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Transaction", "Gateway", "Logs"]}}, "/transactions/{id}/lead-source"=>{"delete"=>{"summary"=>"Delete a Lead Source for a transaction", "description"=>"Delete a Lead Source that belongs to a certain transaction", "operationId"=>"transactions.id.lead_source.delete", "x-api-path-slug"=>"transactionsidleadsource-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lead", "Sourcea", "Transaction"]}, "get"=>{"summary"=>"Retrieve a transaction's Lead Source", "description"=>"Retrieve a Lead Source of given transaction", "operationId"=>"transactions.id.lead_source.get", "x-api-path-slug"=>"transactionsidleadsource-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Transactions", "Lead", "Source"]}, "put"=>{"summary"=>"Create a Lead Source for a transaction", "description"=>"Create a Lead Source for a transaction", "operationId"=>"transactions.id.lead_source.put", "x-api-path-slug"=>"transactionsidleadsource-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Lead Source resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lead", "Sourcea", "Transaction"]}}, "/transactions/{id}/matched-rules"=>{"get"=>{"summary"=>"Get matched rules for the transaction", "description"=>"Get matched rules for the transaction", "operationId"=>"transactions.id.matched_rules.get", "x-api-path-slug"=>"transactionsidmatchedrules-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Matched", "Rulesthe", "Transaction"]}}, "/transactions/{id}/refund"=>{"post"=>{"summary"=>"Refund a Transaction", "description"=>"Refund a Transaction with specified identifier string.\nNote that the refund will be in the same currency as the original transaction.", "operationId"=>"transactions.id.refund.post", "x-api-path-slug"=>"transactionsidrefund-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Transaction resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Refund", "Transaction"]}}, "/activation/{token}"=>{"post"=>{"summary"=>"Sends a token to activate user account", "description"=>"Sends a token to activate user account", "operationId"=>"sends-a-token-to-activate-user-account", "x-api-path-slug"=>"activationtoken-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sends", "Token", "To", "Activate", "User", "Account"]}}, "/api-keys"=>{"get"=>{"summary"=>"Retrieve a list of api keys", "description"=>"Retrieve a list of api keys", "operationId"=>"retrieve-a-list-of-api-keys", "x-api-path-slug"=>"apikeys-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Api", "Keys"]}, "post"=>{"summary"=>"Create an api key", "description"=>"Create an api key", "operationId"=>"create-an-api-key", "x-api-path-slug"=>"apikeys-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"ApiKey resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api", "Key"]}}, "/api-keys/{id}"=>{"delete"=>{"summary"=>"Delete api key", "description"=>"Delete api key with predefined identifier string", "operationId"=>"delete-api-key-with-predefined-identifier-string", "x-api-path-slug"=>"apikeysid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api", "Key"]}, "get"=>{"summary"=>"Retrieve api key", "description"=>"Retrieve api key with specified identifier string", "operationId"=>"retrieve-api-key-with-specified-identifier-string", "x-api-path-slug"=>"apikeysid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Api", "Key"]}, "put"=>{"summary"=>"Create or update api key with predefined ID", "description"=>"Create or update api key with predefined identifier string", "operationId"=>"create-or-update-api-key-with-predefined-identifier-string", "x-api-path-slug"=>"apikeysid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"ApiKey resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Api", "Key", "Predefined", "ID"]}}, "/checkout-pages"=>{"get"=>{"summary"=>"Retrieve a list of checkout pages", "description"=>"Retrieve a list of checkout pages", "operationId"=>"retrieve-a-list-of-checkout-pages", "x-api-path-slug"=>"checkoutpages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Checkout", "Pages"]}, "post"=>{"summary"=>"Create a Checkout Page", "description"=>"Create a Checkout Page", "operationId"=>"create-a-checkout-page", "x-api-path-slug"=>"checkoutpages-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Checkout Page resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkout", "Page"]}}, "/checkout-pages/{id}"=>{"delete"=>{"summary"=>"Delete a Checkout Page", "description"=>"Delete a Checkout Page with predefined identifier string", "operationId"=>"delete-a-checkout-page-with-predefined-identifier-string", "x-api-path-slug"=>"checkoutpagesid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkout", "Page"]}, "get"=>{"summary"=>"Retrieve a Checkout Page", "description"=>"Retrieve a Checkout Page with specified identifier string", "operationId"=>"retrieve-a-checkout-page-with-specified-identifier-string", "x-api-path-slug"=>"checkoutpagesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Checkout", "Page"]}, "put"=>{"summary"=>"Create or update a Checkout Page with predefined ID", "description"=>"Create or update a Checkout Page with predefined identifier string", "operationId"=>"create-or-update-a-checkout-page-with-predefined-identifier-string", "x-api-path-slug"=>"checkoutpagesid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Checkout Page resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Checkout", "Page", "Predefined", "ID"]}}, "/credential-hashes/emails"=>{"post"=>{"summary"=>"Create an email credential", "description"=>"Create an email credential", "operationId"=>"create-an-email-credential", "x-api-path-slug"=>"credentialhashesemails-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Email credential resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Credential"]}}, "/credential-hashes/emails/{hash}"=>{"get"=>{"summary"=>"Retrieve an email credential", "description"=>"Retrieve an email credential with specified token identifier string", "operationId"=>"retrieve-an-email-credential-with-specified-token-identifier-string", "x-api-path-slug"=>"credentialhashesemailshash-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Email", "Credential"]}}, "/credential-hashes/webhooks"=>{"post"=>{"summary"=>"Create a webhook credential", "description"=>"Create a webhook credential", "operationId"=>"create-a-webhook-credential", "x-api-path-slug"=>"credentialhasheswebhooks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Credential resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook", "Credential"]}}, "/credential-hashes/webhooks/{hash}"=>{"get"=>{"summary"=>"Retrieve a webhook credential", "description"=>"Retrieve a webhook credential with specified token identifier string", "operationId"=>"retrieve-a-webhook-credential-with-specified-token-identifier-string", "x-api-path-slug"=>"credentialhasheswebhookshash-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Webhook", "Credential"]}}, "/custom-events"=>{"get"=>{"summary"=>"Retrieve a list of custom events", "description"=>"Retrieve a list of custom events", "operationId"=>"retrieve-a-list-of-custom-events", "x-api-path-slug"=>"customevents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Custom", "Events"]}, "post"=>{"summary"=>"Create a custom event", "description"=>"Create a custom event", "operationId"=>"create-a-custom-event", "x-api-path-slug"=>"customevents-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Custom event resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Event"]}}, "/custom-events/{id}"=>{"delete"=>{"summary"=>"Delete a custom event", "description"=>"Delete a custom event with predefined identifier string", "operationId"=>"delete-a-custom-event-with-predefined-identifier-string", "x-api-path-slug"=>"customeventsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Event"]}, "get"=>{"summary"=>"Retrieve a custom event", "description"=>"Retrieve a custom event with predefined identifier string", "operationId"=>"retrieve-a-custom-event-with-predefined-identifier-string", "x-api-path-slug"=>"customeventsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Custom", "Event"]}, "put"=>{"summary"=>"Create a custom event with predefined ID", "description"=>"Create a custom event with predefined identifier string", "operationId"=>"create-a-custom-event-with-predefined-identifier-string", "x-api-path-slug"=>"customeventsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Custom event resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Event", "Predefined", "ID"]}}, "/custom-events/{id}/rules"=>{"get"=>{"summary"=>"Retrieve a list of rules for custom event", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"customeventsidrules-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Rulescustom", "Event"]}, "put"=>{"summary"=>"Update the rules for custom event", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"customeventsidrules-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Set of rules resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rulescustom", "Event"]}}, "/custom-events/{id}/rules/history"=>{"get"=>{"summary"=>"Retrieve the change history of the set of rules for a custom event", "description"=>"Retrieve the change history of the set of rules for the selected custom event.\nThe history is updated each time you change the rules.", "operationId"=>"retrieve-the-change-history-of-the-set-of-rules-for-the-selected-custom-event-the-history-is-updated", "x-api-path-slug"=>"customeventsidruleshistory-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Change", "History", "Of", "Set", "Of", "Rulesa", "Custom", "Event"]}}, "/custom-events/{id}/rules/history/{version}"=>{"get"=>{"summary"=>"Retrieve the record from the change history of the set of rules for a custom event", "description"=>"Retrieve the record from the change history of the set of rules for the selected custom event.\nA history record is created each time you change the rules.", "operationId"=>"retrieve-the-record-from-the-change-history-of-the-set-of-rules-for-the-selected-custom-event-a-hist", "x-api-path-slug"=>"customeventsidruleshistoryversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Record", "From", "Change", "History", "Of", "Set", "Of", "Rulesa", "Custom", "Event"]}}, "/custom-events/{id}/rules/versions/{version}"=>{"get"=>{"summary"=>"Retrieve the version of the set of rules for a custom event", "description"=>"Retrieve the version of the selected set of rules for the selected custom event.\nThe versions are created each time you change the rules.", "operationId"=>"retrieve-the-version-of-the-selected-set-of-rules-for-the-selected-custom-event-the-versions-are-cre", "x-api-path-slug"=>"customeventsidrulesversionsversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Version", "Of", "Set", "Of", "Rulesa", "Custom", "Event"]}}, "/events"=>{"get"=>{"summary"=>"Retrieve a list of existing events", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"events-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Existing", "Events"]}}, "/events/{eventType}"=>{"get"=>{"summary"=>"Retrieve the event information", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"eventseventtype-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Event", "Information"]}}, "/events/{eventType}/rules"=>{"get"=>{"summary"=>"Retrieve a list of rules for event", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"eventseventtyperules-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Rulesevent"]}, "put"=>{"summary"=>"Update the rules for event", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"eventseventtyperules-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Set of rules resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rulesevent"]}}, "/events/{eventType}/rules/history"=>{"get"=>{"summary"=>"Retrieve the change history of the set of rules", "description"=>"Retrieve the change history of the selected set of rules.\nThe history is updated each time you change the rules.", "operationId"=>"retrieve-the-change-history-of-the-selected-set-of-rules-the-history-is-updated-each-time-you-change", "x-api-path-slug"=>"eventseventtyperuleshistory-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Change", "History", "Of", "Set", "Of", "Rules"]}}, "/events/{eventType}/rules/history/{version}"=>{"get"=>{"summary"=>"Retrieve the record from the change history of the set of rules", "description"=>"Retrieve the record from the change history of the selected set of rules.\nA history record is created each time you change the rules.", "operationId"=>"retrieve-the-record-from-the-change-history-of-the-selected-set-of-rules-a-history-record-is-created", "x-api-path-slug"=>"eventseventtyperuleshistoryversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Record", "From", "Change", "History", "Of", "Set", "Of", "Rules"]}}, "/events/{eventType}/rules/versions/{version}"=>{"get"=>{"summary"=>"Retrieve the version of the set of rules", "description"=>"Retrieve the version of the selected set of rules.\nThe versions are created each time you change the rules.", "operationId"=>"retrieve-the-version-of-the-selected-set-of-rules-the-versions-are-created-each-time-you-change-the-", "x-api-path-slug"=>"eventseventtyperulesversionsversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Version", "Of", "Set", "Of", "Rules"]}}, "/forgot-password"=>{"post"=>{"summary"=>"Sends an email with a link containing a token to reset user password", "description"=>"Sends an email with a link containing a token to reset user password", "operationId"=>"sends-an-email-with-a-link-containing-a-token-to-reset-user-password", "x-api-path-slug"=>"forgotpassword-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Email resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sends", "Email", "Link", "Containing", "Token", "To", "Reset", "User", "Password"]}}, "/gateway-accounts"=>{"get"=>{"summary"=>"Retrieve a list of gateway accounts", "description"=>"Retrieve a list of gateway accounts", "operationId"=>"retrieve-a-list-of-gateway-accounts", "x-api-path-slug"=>"gatewayaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Gateway", "Accounts"]}, "post"=>{"summary"=>"Create a Gateway Account", "description"=>"Create a Gateway Account", "operationId"=>"create-a-gateway-account", "x-api-path-slug"=>"gatewayaccounts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Gateway Account resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gateway", "Account"]}}, "/gateway-accounts/{id}"=>{"delete"=>{"summary"=>"Delete a Gateway Account", "description"=>"Delete a Gateway Account with predefined identifier string", "operationId"=>"delete-a-gateway-account-with-predefined-identifier-string", "x-api-path-slug"=>"gatewayaccountsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gateway", "Account"]}, "get"=>{"summary"=>"Retrieve a Gateway Account", "description"=>"Retrieve a Gateway Account with specified identifier string", "operationId"=>"retrieve-a-gateway-account-with-specified-identifier-string", "x-api-path-slug"=>"gatewayaccountsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Gateway", "Account"]}, "patch"=>{"summary"=>"Update a Gateway Account with predefined ID", "description"=>"Update a GatewayAccount with predefined identifier string", "operationId"=>"update-a-gatewayaccount-with-predefined-identifier-string", "x-api-path-slug"=>"gatewayaccountsid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Gateway Account resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gateway", "Account", "Predefined", "ID"]}, "put"=>{"summary"=>"Create or update a Gateway Account with predefined ID", "description"=>"Create or update a GatewayAccount with predefined identifier string", "operationId"=>"create-or-update-a-gatewayaccount-with-predefined-identifier-string", "x-api-path-slug"=>"gatewayaccountsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Gateway Account resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Gateway", "Account", "Predefined", "ID"]}}, "/layouts"=>{"get"=>{"summary"=>"Retrieve a layout list", "description"=>"Retrieve a layout list", "operationId"=>"retrieve-a-layout-list", "x-api-path-slug"=>"layouts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Layout", "List"]}, "post"=>{"summary"=>"Create a layout", "description"=>"Create a layout", "operationId"=>"create-a-layout", "x-api-path-slug"=>"layouts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Layout resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layout"]}}, "/layouts/{id}"=>{"delete"=>{"summary"=>"Delete a layout", "description"=>"Delete a layout with predefined identifier string", "operationId"=>"delete-a-layout-with-predefined-identifier-string", "x-api-path-slug"=>"layoutsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layout"]}, "get"=>{"summary"=>"Retrieve a layout", "description"=>"Retrieve a layout with specified identifier string", "operationId"=>"retrieve-a-layout-with-specified-identifier-string", "x-api-path-slug"=>"layoutsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Layout"]}, "put"=>{"summary"=>"Create or update a layout with predefined ID", "description"=>"Create or update a layout with predefined identifier string", "operationId"=>"create-or-update-a-layout-with-predefined-identifier-string", "x-api-path-slug"=>"layoutsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Layout resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Layout", "Predefined", "ID"]}}, "/lists"=>{"get"=>{"summary"=>"Retrieve a collection of Lists (latest version of each List)", "description"=>"Retrieve a collection of Lists", "operationId"=>"retrieve-a-collection-of-lists", "x-api-path-slug"=>"lists-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Collection", "Of", "Lists", "(latest", "Version", "Of", "Each", "List)"]}, "post"=>{"summary"=>"Create a List", "description"=>"Create a List", "operationId"=>"create-a-list", "x-api-path-slug"=>"lists-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"List resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List"]}}, "/lists/{id}"=>{"delete"=>{"summary"=>"Delete a list", "description"=>"Delete a list with predefined identifier string", "operationId"=>"delete-a-list-with-predefined-identifier-string", "x-api-path-slug"=>"listsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List"]}, "get"=>{"summary"=>"Retrieve list's latest version", "description"=>"Retrieve latest version of List with specified identifier string", "operationId"=>"retrieve-latest-version-of-list-with-specified-identifier-string", "x-api-path-slug"=>"listsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Lists", "Latest", "Version"]}, "put"=>{"summary"=>"Create or update a list with predefined ID", "description"=>"Create or update a list with predefined identifier string", "operationId"=>"create-or-update-a-list-with-predefined-identifier-string", "x-api-path-slug"=>"listsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"List resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "List", "Predefined", "ID"]}}, "/lists/{id}/{version}"=>{"get"=>{"summary"=>"Retrieve List's exact version", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"listsidversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Lists", "Exact", "Version"]}}, "/notes"=>{"get"=>{"summary"=>"Retrieve a list of notes", "description"=>"Retrieve a list of notes", "operationId"=>"retrieve-a-list-of-notes", "x-api-path-slug"=>"notes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Notes"]}, "post"=>{"summary"=>"Create a note", "description"=>"Create a note", "operationId"=>"create-a-note", "x-api-path-slug"=>"notes-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Note resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Note"]}}, "/notes/{id}"=>{"get"=>{"summary"=>"Retrieve a note", "description"=>"Retrieve a note with specified identifier string", "operationId"=>"retrieve-a-note-with-specified-identifier-string", "x-api-path-slug"=>"notesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Note"]}, "put"=>{"summary"=>"Create or update a note with predefined ID", "description"=>"Create or update a note with predefined identifier string", "operationId"=>"create-or-update-a-note-with-predefined-identifier-string", "x-api-path-slug"=>"notesid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Note resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Note", "Predefined", "ID"]}}, "/organizations"=>{"get"=>{"summary"=>"Retrieve a list of organizations", "description"=>"Retrieve a list of organizations", "operationId"=>"retrieve-a-list-of-organizations", "x-api-path-slug"=>"organizations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Organizations"]}, "post"=>{"summary"=>"Create a organization", "description"=>"Create a organization", "operationId"=>"create-a-organization", "x-api-path-slug"=>"organizations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Organization resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization"]}}, "/organizations/{id}"=>{"delete"=>{"summary"=>"Delete a organization", "description"=>"Delete a organization with predefined identifier string", "operationId"=>"delete-a-organization-with-predefined-identifier-string", "x-api-path-slug"=>"organizationsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization"]}, "get"=>{"summary"=>"Retrieve a organization", "description"=>"Retrieve a organization with specified identifier string", "operationId"=>"retrieve-a-organization-with-specified-identifier-string", "x-api-path-slug"=>"organizationsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Organization"]}, "put"=>{"summary"=>"Create or update a organization with predefined ID", "description"=>"Create or update a organization with predefined identifier string", "operationId"=>"create-or-update-a-organization-with-predefined-identifier-string", "x-api-path-slug"=>"organizationsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Organization resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Organization", "Predefined", "ID"]}}, "/payment-cards-migrations"=>{"get"=>{"summary"=>"Retrieve a list of payment cards ready for migration", "description"=>"Retrieve a list of payment cards ready for migration", "operationId"=>"retrieve-a-list-of-payment-cards-ready-for-migration", "x-api-path-slug"=>"paymentcardsmigrations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Payment", "Cards", "Readymigration"]}}, "/payment-cards-migrations/migrate"=>{"post"=>{"summary"=>"Migrate payment cards to another gateway account", "description"=>"Migrate payment cards to another gateway account", "operationId"=>"migrate-payment-cards-to-another-gateway-account", "x-api-path-slug"=>"paymentcardsmigrationsmigrate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment card migration attributes", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Migrate", "Payment", "Cards", "To", "Another", "Gateway", "Account"]}}, "/previews/rule-actions/send-email"=>{"post"=>{"summary"=>"Send a test email", "description"=>"Send a test email", "operationId"=>"send-a-test-email", "x-api-path-slug"=>"previewsruleactionssendemail-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Test email resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Test", "Email"]}}, "/previews/rule-actions/trigger-webhook"=>{"post"=>{"summary"=>"Trigger a test webhook", "description"=>"Trigger a test webhook", "operationId"=>"trigger-a-test-webhook", "x-api-path-slug"=>"previewsruleactionstriggerwebhook-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Test webhook resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trigger", "Test", "Webhook"]}}, "/previews/webhooks"=>{"post"=>{"summary"=>"Trigger a test webhook", "description"=>"Trigger a test webhook", "operationId"=>"trigger-a-test-webhook", "x-api-path-slug"=>"previewswebhooks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Webhook resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trigger", "Test", "Webhook"]}}, "/profile"=>{"get"=>{"summary"=>"Retrieve user's profile", "description"=>"Retrieve user's profile", "operationId"=>"retrieve-users-profile", "x-api-path-slug"=>"profile-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Users", "Profile"]}, "put"=>{"summary"=>"Update user's profile", "description"=>"Update user's profile", "operationId"=>"update-users-profile", "x-api-path-slug"=>"profile-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Profile resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Profile"]}}, "/queue/custom-events"=>{"get"=>{"summary"=>"Retrieve a list of scheduled custom events", "description"=>"Retrieve a list of scheduled custom events", "operationId"=>"retrieve-a-list-of-scheduled-custom-events", "x-api-path-slug"=>"queuecustomevents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Scheduled", "Custom", "Events"]}}, "/queue/custom-events/{id}"=>{"delete"=>{"summary"=>"Delete a scheduled custom event", "description"=>"Delete a scheduled custom event with predefined identifier string", "operationId"=>"delete-a-scheduled-custom-event-with-predefined-identifier-string", "x-api-path-slug"=>"queuecustomeventsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scheduled", "Custom", "Event"]}, "get"=>{"summary"=>"Retrieve a scheduled custom event", "description"=>"Retrieve a scheduled custom event with predefined identifier string", "operationId"=>"retrieve-a-scheduled-custom-event-with-predefined-identifier-string", "x-api-path-slug"=>"queuecustomeventsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Scheduled", "Custom", "Event"]}}, "/queue/payments/{id}/cancel"=>{"post"=>{"summary"=>"Cancel a scheduled payment", "description"=>"Cancel a scheduled payment with specified identifier string", "operationId"=>"cancel-a-scheduled-payment-with-specified-identifier-string", "x-api-path-slug"=>"queuepaymentsidcancel-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Scheduled", "Payment"]}}, "/sessions"=>{"get"=>{"summary"=>"Retrieve a list of sessions", "description"=>"Retrieve a list of sessions", "operationId"=>"retrieve-a-list-of-sessions", "x-api-path-slug"=>"sessions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Sessions"]}, "post"=>{"summary"=>"Create a session", "description"=>"Create a session", "operationId"=>"create-a-session", "x-api-path-slug"=>"sessions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Sessions resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session"]}}, "/sessions/{id}"=>{"delete"=>{"summary"=>"Delete a Session", "description"=>"Delete a Session with predefined identifier string", "operationId"=>"delete-a-session-with-predefined-identifier-string", "x-api-path-slug"=>"sessionsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session"]}, "get"=>{"summary"=>"Retrieve a Session", "description"=>"Retrieve a Session with specified identifier string", "operationId"=>"retrieve-a-session-with-specified-identifier-string", "x-api-path-slug"=>"sessionsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Session"]}, "put"=>{"summary"=>"Create or update a Session with predefined ID", "description"=>"Create or update a Session with predefined identifier string", "operationId"=>"create-or-update-a-session-with-predefined-identifier-string", "x-api-path-slug"=>"sessionsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Session resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Session", "Predefined", "ID"]}}, "/signin"=>{"post"=>{"summary"=>"Create a session with email and password", "description"=>"Create a session with email and password", "operationId"=>"create-a-session-with-email-and-password", "x-api-path-slug"=>"signin-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Signin resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session", "Email", "Password"]}}, "/signup"=>{"post"=>{"summary"=>"Creates a new user and sends an email confirmation", "description"=>"Creates a new user and sends an email confirmation", "operationId"=>"creates-a-new-user-and-sends-an-email-confirmation", "x-api-path-slug"=>"signup-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Signup resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "New", "User", "Sends", "Email", "Confirmation"]}}, "/status"=>{"get"=>{"summary"=>"Retrieve API current status", "description"=>"Retrieve API current status", "operationId"=>"retrieve-api-current-status", "x-api-path-slug"=>"status-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Current", "Status"]}}, "/tracking/api"=>{"get"=>{"summary"=>"Retrieve a list of tracking API logs", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"trackingapi-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"The response media type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Tracking", "Logs"]}}, "/tracking/api/{id}"=>{"get"=>{"summary"=>"Retrieve a tracking API log with specified identifier string", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"trackingapiid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Tracking", "Log", "Specified", "Identifier", "String"]}}, "/tracking/lists"=>{"get"=>{"summary"=>"Retrieve Lists changes history", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"trackinglists-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Lists", "Changes", "History"]}}, "/tracking/subscriptions"=>{"get"=>{"summary"=>"Retrieve a list of tracking subscription logs", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"trackingsubscriptions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Tracking", "Subscription", "Logs"]}}, "/tracking/subscriptions/{id}"=>{"get"=>{"summary"=>"Retrieve a tracking subscription log with specified identifier string", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"trackingsubscriptionsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Tracking", "Subscription", "Log", "Specified", "Identifier", "String"]}}, "/tracking/website-webhooks"=>{"get"=>{"summary"=>"Retrieve a list of tracking webhook notifications", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"trackingwebsitewebhooks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Tracking", "Webhook", "Notifications"]}}, "/tracking/website-webhooks/{id}"=>{"get"=>{"summary"=>"Retrieve a tracking webhook notification with specified identifier string", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"trackingwebsitewebhooksid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Tracking", "Webhook", "Notification", "Specified", "Identifier", "String"]}}, "/users"=>{"get"=>{"summary"=>"Retrieve a list of users", "description"=>"Retrieve a list of users", "operationId"=>"retrieve-a-list-of-users", "x-api-path-slug"=>"users-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Users"]}, "post"=>{"summary"=>"Create an user", "description"=>"Create an user", "operationId"=>"create-an-user", "x-api-path-slug"=>"users-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"User resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/users/reset-password/{token}"=>{"post"=>{"summary"=>"Reset user password", "description"=>"Reset user password", "operationId"=>"reset-user-password", "x-api-path-slug"=>"usersresetpasswordtoken-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"ResetPassword resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reset", "User", "Password"]}}, "/users/{id}"=>{"delete"=>{"summary"=>"Delete user", "description"=>"Delete user with predefined identifier string", "operationId"=>"delete-user-with-predefined-identifier-string", "x-api-path-slug"=>"usersid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "get"=>{"summary"=>"Retrieve user", "description"=>"Retrieve user with specified identifier string", "operationId"=>"retrieve-user-with-specified-identifier-string", "x-api-path-slug"=>"usersid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "User"]}, "put"=>{"summary"=>"Create or update user with predefined ID", "description"=>"Create or update user with predefined identifier string", "operationId"=>"create-or-update-user-with-predefined-identifier-string", "x-api-path-slug"=>"usersid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"User resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "User", "Predefined", "ID"]}}, "/users/{id}/password"=>{"post"=>{"summary"=>"Updates user's password with the specified newPassword", "description"=>"Updates user's password with the specified newPassword. And checks if currentPassword matches the actual one.", "operationId"=>"updates-users-password-with-the-specified-newpassword--and-checks-if-currentpassword-matches-the-act", "x-api-path-slug"=>"usersidpassword-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"currentPassword and newPassword", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Users", "Password", "Specified", "NewPassword"]}}, "/users/{id}/totp-reset"=>{"post"=>{"summary"=>"Reset (renew) totpSecret", "description"=>"Reset (renew) totpSecret", "operationId"=>"reset-renew-totpsecret", "x-api-path-slug"=>"usersidtotpreset-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reset", "(renew)", "TotpSecret"]}}, "/webhooks"=>{"get"=>{"summary"=>"Retrieve a list of webhooks", "description"=>"Retrieve a list of webhooks", "operationId"=>"retrieve-a-list-of-webhooks", "x-api-path-slug"=>"webhooks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Webhooks"]}, "post"=>{"summary"=>"Create a webhook", "description"=>"Create a webhook", "operationId"=>"create-a-webhook", "x-api-path-slug"=>"webhooks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Webhook resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook"]}}, "/webhooks/{id}"=>{"get"=>{"summary"=>"Retrieve a webhook", "description"=>"Retrieve a webhook with specified identifier string", "operationId"=>"retrieve-a-webhook-with-specified-identifier-string", "x-api-path-slug"=>"webhooksid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Webhook"]}, "put"=>{"summary"=>"Create or update a webhook with predefined ID", "description"=>"Create or update a webhook with predefined identifier string", "operationId"=>"create-or-update-a-webhook-with-predefined-identifier-string", "x-api-path-slug"=>"webhooksid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Webhook resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Webhook", "Predefined", "ID"]}}, "/websites"=>{"get"=>{"summary"=>"Retrieve a list of websites", "description"=>"Retrieve a list of websites", "operationId"=>"retrieve-a-list-of-websites", "x-api-path-slug"=>"websites-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"The response media type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Websites"]}, "post"=>{"summary"=>"Create a website", "description"=>"Create a website", "operationId"=>"create-a-website", "x-api-path-slug"=>"websites-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Website resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Website"]}}, "/websites/{id}"=>{"delete"=>{"summary"=>"Delete a website", "description"=>"Delete a website with predefined identifier string", "operationId"=>"delete-a-website-with-predefined-identifier-string", "x-api-path-slug"=>"websitesid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Website"]}, "get"=>{"summary"=>"Retrieve a website", "description"=>"Retrieve a website with specified identifier string", "operationId"=>"retrieve-a-website-with-specified-identifier-string", "x-api-path-slug"=>"websitesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Website"]}, "put"=>{"summary"=>"Create or update a website with predefined ID", "description"=>"Create or update a website with predefined identifier string", "operationId"=>"create-or-update-a-website-with-predefined-identifier-string", "x-api-path-slug"=>"websitesid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Website resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Website", "Predefined", "ID"]}}, "/websites/{id}/webhook"=>{"delete"=>{"summary"=>"Delete a webhook", "description"=>"Delete a webhook that belongs to a website with predefined ID", "operationId"=>"delete-a-webhook-that-belongs-to-a-website-with-predefined-id", "x-api-path-slug"=>"websitesidwebhook-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook"]}, "get"=>{"summary"=>"Retrieve a webhook for website", "description"=>"Retrieve a webhook for website with specified identifier string", "operationId"=>"retrieve-a-webhook-for-website-with-specified-identifier-string", "x-api-path-slug"=>"websitesidwebhook-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Webhookwebsite"]}, "put"=>{"summary"=>"Create or update a webhook for website with predefined ID", "description"=>"Create or update a webhook for website with predefined identifier string", "operationId"=>"create-or-update-a-webhook-for-website-with-predefined-identifier-string", "x-api-path-slug"=>"websitesidwebhook-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Webhook resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Webhookwebsite", "Predefined", "ID"]}}}}, "apis"=>{"name"=>"Rebilly", "x-slug"=>"rebilly", "description"=>"", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/rebilly.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Billing,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"rebilly/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Rebilly", "x-api-slug"=>"rebilly", "description"=>"", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/rebilly.png", "humanURL"=>"https://www.rebilly.com", "baseURL"=>"https://api.rebilly.com//v2.1", "tags"=>"Billing,Relative Data,Service API", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/rebilly/rebilly-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://www.rebilly.com"}, {"type"=>"x-documentation", "url"=>"https://rebilly.github.io/RebillyAPI/#"}, {"type"=>"x-github", "url"=>"https://github.com/Rebilly"}, {"type"=>"x-license-agreement", "url"=>"https://www.rebilly.com/api-license/"}, {"type"=>"x-openapi", "url"=>"https://rebilly.github.io/RebillyAPI/swagger.json"}, {"type"=>"x-pricing", "url"=>"https://www.rebilly.com/pricing/"}, {"type"=>"x-privacy-policy", "url"=>"https://www.rebilly.com/privacy-policy/"}, {"type"=>"x-support", "url"=>"https://help.rebilly.com/"}, {"type"=>"x-terms-of-service", "url"=>"https://www.rebilly.com/terms-of-use/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/RebillyInc"}, {"type"=>"x-website", "url"=>"http://rebilly.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
apigee{"apis"=>{"name"=>"Apigee", "x-slug"=>"apigee", "description"=>"Apigee Edge is a platform for developing and managing API proxies. Think of a proxy as an abstraction layer that fronts for your backend service APIs and provides value-added features like security, rate limiting, quotas, analytics, and more. The primary consumers of Edge API proxies are app developers who want to use your backend services.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/apigee-edge.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Service Provider,Deployments,Management,Profiles,Proxies,Relative Data", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"apigee/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Apigee Edge", "x-api-slug"=>"apigee-edge", "description"=>"Apigee Edge is a platform for developing and managing API proxies. Think of a proxy as an abstraction layer that fronts for your backend service APIs and provides value-added features like security, rate limiting, quotas, analytics, and more. The primary consumers of Edge API proxies are app developers who want to use your backend services.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/apigee-edge.png", "humanURL"=>"https://docs.apigee.com/api-platform/get-started/what-apigee-edge", "baseURL"=>"https://api.enterprise.apigee.com//v1/", "tags"=>"API Service Provider,Deployments,Management,Profiles,Proxies,Relative Data", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/apigee/usersuser-emailpermissionsget-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/apigee/apigee-edge-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://docs.apigee.com/api-platform/get-started/what-apigee-edge"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "apigee-edge-openapi"=>false} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
stocklytics{"stocklytics-historical-stock-prices-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Stocklytics", "x-complete"=>1, "info"=>{"title"=>"Stocklytics Historical Stock Prices API", "description"=>"the-historical-prices-api-can-be-used-to-look-up-the-open-close-high-and-low-price-as-well-as-the-volume-of-stock-traded-for-a-stock-code-within-a-particular-date-range--the-api-supports-the-downloading-the-entire-historical-data-set-we-have-on-file-for-a-stock-we-index-data-for-a-stock-with-a-start-date-of-january-1st-1980-", "version"=>"v1"}, "host"=>"api.stocklytics.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"historicalPrices/{API_VERSION}/"=>{"get"=>{"summary"=>"Historical Prices", "description"=>"The Historical Prices API can be used to look up the Open, Close, High and Low price, as well as the volume of stock traded for a stock code within a particular date range. The API supports the downloading the entire historical data set we have on file for a stock, we index data for a stock with a start date of January 1st 1980.", "operationId"=>"getHistoricalpricesApiVersion", "x-api-path-slug"=>"historicalpricesapi-version-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Allows us to identify the request initiator"}, {"in"=>"path", "name"=>"API_VERSION", "description"=>"Version of the API"}, {"in"=>"query", "name"=>"end", "description"=>"The start and end dates to return data for"}, {"in"=>"query", "name"=>"format", "description"=>"Format of returned data"}, {"in"=>"query", "name"=>"order", "description"=>"Order of returned data sorted by date"}, {"in"=>"query", "name"=>"start", "description"=>"The start and end dates to return data for"}, {"in"=>"query", "name"=>"stock", "description"=>"The stock code/ticker for the stock to look up"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Prices"]}}}}, "stocklytics-company-data-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Stocklytics", "x-complete"=>1, "info"=>{"title"=>"Stocklytics Company Data API", "description"=>"the-company-data-api-allows-you-to-retrieve-company-information-about-a-particular-stockticker-code-", "version"=>"v1"}, "host"=>"api.stocklytics.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"companyData/{API_VERSION}/"=>{"get"=>{"summary"=>"Company Data", "description"=>"The Company Data API allows you to retrieve company information about a particular stock/ticker code.", "operationId"=>"getCompanyData", "x-api-path-slug"=>"companydataapi-version-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Allows us to identify the request initiator"}, {"in"=>"path", "name"=>"API_VERSION", "description"=>"Version of the API"}, {"in"=>"query", "name"=>"stock", "description"=>"The stock code/ticker for the stock to look up"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies"]}}}}, "apis"=>{"name"=>"Stocklytics", "x-slug"=>"stocklytics", "description"=>"Build feature rich, fast applications and websites based around accurate stock market data. Launch in hours rather than days using the Stocklytics API. The Stocklytics API is a powerful, low-cost RESTful API allowing you to create stock/ financial based apps and websites with data from our service. Such as historical stock price data that can be used for creating stock charts and determining trends. We also offer a company financial data API which allows your to get company information for a particular Stock Code.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/stocklytics-logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"Finance,Financial News API,General Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"stocklytics/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Stocklytics Company Data API", "x-api-slug"=>"stocklytics-company-data-api", "description"=>"Build feature rich, fast applications and websites based around accurate stock market data. Launch in hours rather than days using the Stocklytics API. The Stocklytics API is a powerful, low-cost RESTful API allowing you to create stock/ financial based apps and websites with data from our service. Such as historical stock price data that can be used for creating stock charts and determining trends. We also offer a company financial data API which allows your to get company information for a particular Stock Code.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/stocklytics-logo.png", "humanURL"=>"http://stocklytics.com", "baseURL"=>"https://api.stocklytics.com//", "tags"=>"Finance,Financial News API,General Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/stocklytics/companydataapi-version-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/stocklytics/stocklytics-company-data-api-openapi.yaml"}]}, {"name"=>"Stocklytics Historical Stock Prices API", "x-api-slug"=>"stocklytics-historical-stock-prices-api", "description"=>"Build feature rich, fast applications and websites based around accurate stock market data. Launch in hours rather than days using the Stocklytics API. The Stocklytics API is a powerful, low-cost RESTful API allowing you to create stock/ financial based apps and websites with data from our service. Such as historical stock price data that can be used for creating stock charts and determining trends. We also offer a company financial data API which allows your to get company information for a particular Stock Code.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/stocklytics-logo.png", "humanURL"=>"http://stocklytics.com", "baseURL"=>"https://api.stocklytics.com//", "tags"=>"Companies", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/stocklytics/historicalpricesapi-version-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/stocklytics/stocklytics-historical-stock-prices-api-openapi.yaml"}]}, {"name"=>"Stocklytics Intraday Historical Stock Prices API", "x-api-slug"=>"stocklytics-intraday-historical-stock-prices-api", "description"=>"Build feature rich, fast applications and websites based around accurate stock market data. Launch in hours rather than days using the Stocklytics API. The Stocklytics API is a powerful, low-cost RESTful API allowing you to create stock/ financial based apps and websites with data from our service. Such as historical stock price data that can be used for creating stock charts and determining trends. We also offer a company financial data API which allows your to get company information for a particular Stock Code.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/stocklytics-logo.png", "humanURL"=>"http://stocklytics.com", "baseURL"=>"https://api.stocklytics.com//services/pressroom/", "tags"=>"Historical,Prices", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/stocklytics/intradayhistoricalpricesapi-version-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/stocklytics/stocklytics-intraday-historical-stock-prices-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api.stocklytics.com"}, {"type"=>"x-buttons", "url"=>"http://developer.stocklytics.com/stocklytics-button/"}, {"type"=>"x-developer", "url"=>"http://developer.stocklytics.com/"}, {"type"=>"x-key-manager", "url"=>"http://developer.stocklytics.com/keys/"}, {"type"=>"x-selfservice-registration", "url"=>"http://developer.stocklytics.com/signup/"}, {"type"=>"x-website", "url"=>"http://stocklytics.com"}, {"type"=>"x-widgets", "url"=>"http://developer.stocklytics.com/stock-price/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "stocklytics-intraday-historical-stock-prices-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Stocklytics", "x-complete"=>1, "info"=>{"title"=>"Stocklytics Intraday Historical Stock Prices API", "description"=>"the-intraday-historical-prices-api-allows-you-to-get-a-list-of-the-price-for-a-particular-stock-for-the-current-day-or-the-latest-day-of-trading-if-markets-are-closed-in-5-minute-intervals--this-data-is-perfect-for-generating-intraday-stock-graphs-or-performing-stock-analysis-in-near-realtime--data-for-this-api-is-updated-every-5-minutes-", "version"=>"v1"}, "host"=>"api.stocklytics.com", "basePath"=>"/services/pressroom/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"intradayHistoricalPrices/{API_VERSION}/"=>{"get"=>{"summary"=>"Intraday Historical Prices", "description"=>"The Intraday Historical Prices API allows you to get a list of the price for a particular stock for the current day (or the latest day of trading if markets are closed) in 5 minute intervals. This data is perfect for generating intraday stock graphs, or performing stock analysis in near real-time. Data for this API is updated every 5 minutes.", "operationId"=>"getIntradayhistoricalpricesApiVersion", "x-api-path-slug"=>"intradayhistoricalpricesapi-version-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Allows us to identify the request initiator"}, {"in"=>"path", "name"=>"API_VERSION", "description"=>"Version of the API"}, {"in"=>"query", "name"=>"format", "description"=>"Format of returned data"}, {"in"=>"query", "name"=>"include_date", "description"=>"Include the corresponding date and time of the data"}, {"in"=>"query", "name"=>"order", "description"=>"Order of returned data sorted by date/time"}, {"in"=>"query", "name"=>"stock", "description"=>"The stock code/ticker for the stock to look up"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Intraday", "Historical", "Prices"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-service-bus{"azure-service-bus-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Service Bus", "x-complete"=>1, "info"=>{"title"=>"ServiceBusManagementClient", "description"=>"azure-service-bus-client", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/providers/Microsoft.ServiceBus/operations"=>{"get"=>{"summary"=>"Operations List", "description"=>"Lists all of the available ServiceBus REST API operations.", "operationId"=>"Operations_List", "x-api-path-slug"=>"providersmicrosoft-servicebusoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/CheckNameAvailability"=>{"post"=>{"summary"=>"Namespaces Check Name Availability", "description"=>"Check the give namespace name availability.", "operationId"=>"Namespaces_CheckNameAvailability", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-servicebuschecknameavailability-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters to check availability of the given namespace name", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Name Availability"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces"=>{"get"=>{"summary"=>"Namespaces List By Subscription", "description"=>"Gets all the available namespaces within the subscription, irrespective of the resource groups.", "operationId"=>"Namespaces_ListBySubscription", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-servicebusnamespaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Subscription"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces"=>{"get"=>{"summary"=>"Namespaces List By Resource Group", "description"=>"Gets the available namespaces within a resource group.", "operationId"=>"Namespaces_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Resource Group"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}"=>{"put"=>{"summary"=>"Namespaces Create Or Update", "description"=>"Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "operationId"=>"Namespaces_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacename-put", "parameters"=>[{"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to create a namespace resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces"]}, "delete"=>{"summary"=>"Namespaces Delete", "description"=>"Deletes an existing namespace. This operation also removes all associated resources under the namespace.", "operationId"=>"Namespaces_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacename-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces"]}, "get"=>{"summary"=>"Namespaces Get", "description"=>"Gets a description for the specified namespace.", "operationId"=>"Namespaces_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces"]}, "patch"=>{"summary"=>"Namespaces Update", "description"=>"Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "operationId"=>"Namespaces_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacename-patch", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to update a namespace resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules"=>{"get"=>{"summary"=>"Namespaces List Authorization Rules", "description"=>"Gets the authorization rules for a namespace.", "operationId"=>"Namespaces_ListAuthorizationRules", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenameauthorizationrules-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Authorization Rules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}"=>{"put"=>{"summary"=>"Namespaces Create Or Update Authorization Rule", "description"=>"Creates or updates an authorization rule for a namespace.", "operationId"=>"Namespaces_CreateOrUpdateAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenameauthorizationrulesauthorizationrulename-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The shared access authorization rule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Authorization Rule"]}, "delete"=>{"summary"=>"Namespaces Delete Authorization Rule", "description"=>"Deletes a namespace authorization rule.", "operationId"=>"Namespaces_DeleteAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenameauthorizationrulesauthorizationrulename-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Authorization Rule"]}, "get"=>{"summary"=>"Namespaces Get Authorization Rule", "description"=>"Gets an authorization rule for a namespace by rule name.", "operationId"=>"Namespaces_GetAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenameauthorizationrulesauthorizationrulename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Authorization Rule"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys"=>{"post"=>{"summary"=>"Namespaces List Keys", "description"=>"Gets the primary and secondary connection strings for the namespace.", "operationId"=>"Namespaces_ListKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenameauthorizationrulesauthorizationrulenamelistkeys-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys"=>{"post"=>{"summary"=>"Namespaces Regenerate Keys", "description"=>"Regenerates the primary or secondary connection strings for the namespace.", "operationId"=>"Namespaces_RegenerateKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenameauthorizationrulesauthorizationrulenameregeneratekeys-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to regenerate the authorization rule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Regenerate Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues"=>{"get"=>{"summary"=>"Queues List All", "description"=>"Gets the queues within a namespace.", "operationId"=>"Queues_ListAll", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenamequeues-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}"=>{"put"=>{"summary"=>"Queues Create Or Update", "description"=>"Creates or updates a Service Bus queue. This operation is idempotent.", "operationId"=>"Queues_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenamequeuesqueuename-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to create or update a queue resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues"]}, "delete"=>{"summary"=>"Queues Delete", "description"=>"Deletes a queue from the specified namespace in a resource group.", "operationId"=>"Queues_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenamequeuesqueuename-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues"]}, "get"=>{"summary"=>"Queues Get", "description"=>"Returns a description for the specified queue.", "operationId"=>"Queues_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenamequeuesqueuename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules"=>{"get"=>{"summary"=>"Queues List Authorization Rules", "description"=>"Gets all authorization rules for a queue.", "operationId"=>"Queues_ListAuthorizationRules", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenamequeuesqueuenameauthorizationrules-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues Authorization Rules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}"=>{"put"=>{"summary"=>"Queues Create Or Update Authorization Rule", "description"=>"Creates an authorization rule for a queue.", "operationId"=>"Queues_CreateOrUpdateAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenamequeuesqueuenameauthorizationrulesauthorizationrulename-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The shared access authorization rule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues Authorization Rule"]}, "delete"=>{"summary"=>"Queues Delete Authorization Rule", "description"=>"Deletes a queue authorization rule.", "operationId"=>"Queues_DeleteAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenamequeuesqueuenameauthorizationrulesauthorizationrulename-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues Authorization Rule"]}, "get"=>{"summary"=>"Queues Get Authorization Rule", "description"=>"Gets an authorization rule for a queue by rule name.", "operationId"=>"Queues_GetAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenamequeuesqueuenameauthorizationrulesauthorizationrulename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues Authorization Rule"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/ListKeys"=>{"post"=>{"summary"=>"Queues List Keys", "description"=>"Primary and secondary connection strings to the queue.", "operationId"=>"Queues_ListKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenamequeuesqueuenameauthorizationrulesauthorizationrulenamelistkeys-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/regenerateKeys"=>{"post"=>{"summary"=>"Queues Regenerate Keys", "description"=>"Regenerates the primary or secondary connection strings to the queue.", "operationId"=>"Queues_RegenerateKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenamequeuesqueuenameauthorizationrulesauthorizationrulenameregeneratekeys-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to regenerate the authorization rule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics"=>{"get"=>{"summary"=>"Topics List All", "description"=>"Gets all the topics in a namespace.", "operationId"=>"Topics_ListAll", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenametopics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}"=>{"put"=>{"summary"=>"Topics Create Or Update", "description"=>"Creates a topic in the specified namespace.", "operationId"=>"Topics_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenametopicstopicname-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to create a topic resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics"]}, "delete"=>{"summary"=>"Topics Delete", "description"=>"Deletes a topic from the specified namespace and resource group.", "operationId"=>"Topics_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenametopicstopicname-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics"]}, "get"=>{"summary"=>"Topics Get", "description"=>"Returns a description for the specified topic.", "operationId"=>"Topics_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenametopicstopicname-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules"=>{"get"=>{"summary"=>"Topics List Authorization Rules", "description"=>"Gets authorization rules for a topic.", "operationId"=>"Topics_ListAuthorizationRules", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenametopicstopicnameauthorizationrules-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics Authorization Rules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}"=>{"put"=>{"summary"=>"Topics Create Or Update Authorization Rule", "description"=>"Creates an authorizatio rule for the specified topic.", "operationId"=>"Topics_CreateOrUpdateAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenametopicstopicnameauthorizationrulesauthorizationrulename-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The shared access authorization rule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics Authorization Rule"]}, "get"=>{"summary"=>"Topics Get Authorization Rule", "description"=>"Returns the specified authorization rule.", "operationId"=>"Topics_GetAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenametopicstopicnameauthorizationrulesauthorizationrulename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics Authorization Rule"]}, "delete"=>{"summary"=>"Topics Delete Authorization Rule", "description"=>"Deletes a topic authorization rule.", "operationId"=>"Topics_DeleteAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenametopicstopicnameauthorizationrulesauthorizationrulename-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics Authorization Rule"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/ListKeys"=>{"post"=>{"summary"=>"Topics List Keys", "description"=>"Gets the primary and secondary connection strings for the topic.", "operationId"=>"Topics_ListKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenametopicstopicnameauthorizationrulesauthorizationrulenamelistkeys-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/regenerateKeys"=>{"post"=>{"summary"=>"Topics Regenerate Keys", "description"=>"Regenerates primary or secondary connection strings for the topic.", "operationId"=>"Topics_RegenerateKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenametopicstopicnameauthorizationrulesauthorizationrulenameregeneratekeys-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to regenerate the authorization rule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions"=>{"get"=>{"summary"=>"Subscriptions List All", "description"=>"List all the subscriptions under a specified topic.", "operationId"=>"Subscriptions_ListAll", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenametopicstopicnamesubscriptions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}"=>{"put"=>{"summary"=>"Subscriptions Create Or Update", "description"=>"Creates a topic subscription.", "operationId"=>"Subscriptions_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenametopicstopicnamesubscriptionssubscriptionname-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to create a subscription resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}, "delete"=>{"summary"=>"Subscriptions Delete", "description"=>"Deletes a subscription from the specified topic.", "operationId"=>"Subscriptions_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenametopicstopicnamesubscriptionssubscriptionname-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}, "get"=>{"summary"=>"Subscriptions Get", "description"=>"Returns a subscription description for the specified topic.", "operationId"=>"Subscriptions_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicebusnamespacesnamespacenametopicstopicnamesubscriptionssubscriptionname-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}}}, "apis"=>{"name"=>"Azure Service Bus", "x-slug"=>"azure-service-bus", "description"=>"Depend on Azure Service Bus when you need highly-reliable cloud messaging service between applications and services, even when one or more is offline. Available in every Azure region, this fully-managed service eliminates the burdens of server management and licensing. Asynchronous operations give you flexible, brokered messaging between client and server, along with structured first-in, first-out (FIFO) messaging, and publish/subscribe capabilities—excellent for tasks like order processing.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-service-bus-anything.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Messages,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-service-bus/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Service Bus API", "x-api-slug"=>"azure-service-bus-api", "description"=>"Depend on Azure Service Bus when you need highly-reliable cloud messaging service between applications and services, even when one or more is offline. Available in every Azure region, this fully-managed service eliminates the burdens of server management and licensing. Asynchronous operations give you flexible, brokered messaging between client and server, along with structured first-in, first-out (FIFO) messaging, and publish/subscribe capabilities—excellent for tasks like order processing.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-service-bus-anything.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/service-bus/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Messages,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/azure-service-bus/azure-service-bus-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/service-bus/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/service-bus/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/service-bus/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/service-bus/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
attom{"attom-data-solutions-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"ATTOM", "x-complete"=>1, "info"=>{"title"=>"Attom Data Solutions API", "description"=>"attom-empowers-customers-with-better-property-data--we-warehouse-property-data-nationwide-with-myriad-data-points-on-each-parcel-including-ownership-information-latlong-square-footage-loan-types-sales-history-sales-comps-crime-schools-and-more-", "version"=>"1.0.0"}, "host"=>"search.onboard-apis.com", "basePath"=>"/communityapi/v2.0.0", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/property/id"=>{"get"=>{"summary"=>"Returns a list of properties that fit a criteria.", "description"=>"Get a list of property IDs within a specific geography that have a specific number of beds. Use orderby to choose how you want your results sorted.", "operationId"=>"getPropertyIdList", "x-api-path-slug"=>"propertyid-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"geoid", "description"=>"A list of geographies that this property belongs to"}, {"in"=>"query", "name"=>"maxBeds", "description"=>"The max Bed size to search from"}, {"in"=>"query", "name"=>"minBeds", "description"=>"The min Bed size to search from"}, {"in"=>"query", "name"=>"orderby", "description"=>"Sort Options"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "List", "Of", "Properties", "That", "Fit", "Criteria"]}}, "/property/detail"=>{"get"=>{"summary"=>"Returns property details based on an ID.", "description"=>"Get property details based on its Onboard property ID.", "operationId"=>"propertyDetails", "x-api-path-slug"=>"propertydetail-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"query", "name"=>"address", "description"=>"The mailing address"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"id", "description"=>"property id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Property", "Details", "Based", "On", "ID"]}}, "/property/address"=>{"get"=>{"summary"=>"Returns properties within a zip code.", "description"=>"Get a list of properties within a zip code. Use propertytype and order by to narrow down your results.", "operationId"=>"adressList", "x-api-path-slug"=>"propertyaddress-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"query", "name"=>"address1", "description"=>"The first line of the mailing address"}, {"in"=>"query", "name"=>"address2", "description"=>"The second line of the mailing address"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"orderby", "description"=>"Sorting Options"}, {"in"=>"query", "name"=>"page", "description"=>"The current view index based on the pagesize and the total number of records available"}, {"in"=>"query", "name"=>"pagesize", "description"=>"The number of records to be returned with the request"}, {"in"=>"query", "name"=>"postalcode", "description"=>"The zip code or postal code to search"}, {"in"=>"query", "name"=>"propertytype", "description"=>"A specific property classification such as Detached Single Family"}, {"in"=>"query", "name"=>"radius"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Properties", "Within", "Zip", "Code"]}}, "/property/snapshot"=>{"get"=>{"summary"=>"Returns properties and their characteristics that fit a criteria.", "description"=>"Get a list of property snapshots within a specific city that are within a desired size range and a specific property type.", "operationId"=>"propertySnapshot", "x-api-path-slug"=>"propertysnapshot-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"cityname", "description"=>"The name of the city to search from"}, {"in"=>"query", "name"=>"latitude", "description"=>"The property latitude coordinate"}, {"in"=>"query", "name"=>"longitude", "description"=>"The property longitude coordinate"}, {"in"=>"query", "name"=>"maxavmvalue", "description"=>"The maximum AVM Valuey"}, {"in"=>"query", "name"=>"maxLotSize1", "description"=>"The max Lot size 1 to search from"}, {"in"=>"query", "name"=>"maxtaxamt", "description"=>"The total amount of taxes paid to the local taxing authority"}, {"in"=>"query", "name"=>"minavmvalue", "description"=>"The minimum AVM Value"}, {"in"=>"query", "name"=>"minLotSize1", "description"=>"The min Lot size 1 to search from"}, {"in"=>"query", "name"=>"mintaxamt", "description"=>"The total amount of taxes paid to the local taxing authority"}, {"in"=>"query", "name"=>"orderby", "description"=>"Sorting Options"}, {"in"=>"query", "name"=>"postalcode"}, {"in"=>"query", "name"=>"propertytype", "description"=>"A specific property classification such as Detached Single Family"}, {"in"=>"query", "name"=>"radius"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Properties", "Their", "Characteristics", "That", "Fit", "Criteria"]}}, "/property/basicprofile"=>{"get"=>{"summary"=>"Returns basic property information and most recent transaction and taxes.", "description"=>"Get basic property information and most recent transaction and taxes for a specific attom id.", "operationId"=>"propertyBasicProfile", "x-api-path-slug"=>"propertybasicprofile-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"attomid", "description"=>"attom id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Basic", "Property", "Information", "Most", "Recent", "Transaction", "Taxes"]}}, "/property/expandedprofile"=>{"get"=>{"summary"=>"Returns detailed property information and most recent transaction and taxes.", "description"=>"Get a detailed property information and most recent transaction and taxes for a specific address.", "operationId"=>"propertyExpandedProfile", "x-api-path-slug"=>"propertyexpandedprofile-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"query", "name"=>"address1", "description"=>"The first line of the mailing address"}, {"in"=>"query", "name"=>"address2", "description"=>"The second line of the mailing address"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Detailed", "Property", "Information", "Most", "Recent", "Transaction", "Taxes"]}}, "/property/detailwithschools"=>{"get"=>{"summary"=>"Return schools within the attendance boundary of a property.", "description"=>"Search for a property to have the property details returned, along with the schools in the associated attendance zones.", "operationId"=>"propertyDetailsWithSchools", "x-api-path-slug"=>"propertydetailwithschools-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"id", "description"=>"property id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "Schools", "Within", "Attendance", "Boundary", "Of", "Property"]}}, "/school/snapshot"=>{"get"=>{"summary"=>"Return all schools within a defined radius from a point.", "description"=>"Search for all schools that are located within a given radius around a given latitude and longitude.", "operationId"=>"propertySchoolSnapshot", "x-api-path-slug"=>"schoolsnapshot-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"filetypetext", "description"=>"The type of school (public, private, or catholic can be selected)"}, {"in"=>"query", "name"=>"latitude", "description"=>"The property latitude coordinate"}, {"in"=>"query", "name"=>"longitude", "description"=>"The property longitude coordinate"}, {"in"=>"query", "name"=>"radius"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "", "Schools", "Within", "Defined", "Radius", "From", "Point"]}}, "/school/detail"=>{"get"=>{"summary"=>"Return details about a particular school.", "description"=>"Search by school ID to return all of the available details about a school", "operationId"=>"propertyDetails", "x-api-path-slug"=>"schooldetail-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"id", "description"=>"school id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "Details", "About", "Particular", "School"]}}, "/school/districtdetail"=>{"get"=>{"summary"=>"Return details about a particular school district.", "description"=>"Search by district number to return all of the available details about a school district", "operationId"=>"propertySchoolDistrictDetail", "x-api-path-slug"=>"schooldistrictdetail-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"id", "description"=>"district number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "Details", "About", "Particular", "School", "District"]}}, "/allevents/detail"=>{"get"=>{"summary"=>"Returns all the events that have occurred on a specific address.", "description"=>"Get a detail of all the events on a specific property based on its address.", "operationId"=>"getAllEventsDetailAddress", "x-api-path-slug"=>"alleventsdetail-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"query", "name"=>"address1", "description"=>"The first line of the mailing address"}, {"in"=>"query", "name"=>"address2", "description"=>"The second line of the mailing address"}, {"in"=>"header", "name"=>"apikey", "description"=>"API Security Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "", "Events", "That", "Have", "Occurred", "On", "Specific", "Address"]}}, "/property/detailmortgage"=>{"get"=>{"summary"=>"Returns property details mortgage based on ID.", "description"=>"Get property details mortgage based on its Onboard property ID.", "operationId"=>"propertyDetailsMortage", "x-api-path-slug"=>"propertydetailmortgage-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"query", "name"=>"address1", "description"=>"The first line of the mailing address"}, {"in"=>"query", "name"=>"address2", "description"=>"The second line of the mailing address"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"id", "description"=>"property id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Property", "Details", "Mortgage", "Based", "On", "ID"]}}, "/property/detailowner"=>{"get"=>{"summary"=>"Returns property details owner based on an ID.", "description"=>"Get property details owner based on its Onboard property ID.", "operationId"=>"propertyDetailsOwner", "x-api-path-slug"=>"propertydetailowner-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"query", "name"=>"address1", "description"=>"The first line of the mailing address"}, {"in"=>"query", "name"=>"address2", "description"=>"The second line of the mailing address"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"id", "description"=>"property id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Property", "Details", "Owner", "Based", "On", "ID"]}}, "/property/detailmortgageowner"=>{"get"=>{"summary"=>"Returns property details mortgageowner based on an ID.", "description"=>"Get property details mortgageowner based on its Onboard property ID.", "operationId"=>"propertyDetailsMortgageOwner", "x-api-path-slug"=>"propertydetailmortgageowner-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"query", "name"=>"address1", "description"=>"The first line of the mailing address"}, {"in"=>"query", "name"=>"address2", "description"=>"The second line of the mailing address"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"id", "description"=>"property id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Property", "Details", "Mortgageowner", "Based", "On", "ID"]}}, "/assessment/snapshot"=>{"get"=>{"summary"=>"Returns assessment details for properties within a radius.", "description"=>"Get snapshots of the properties within a radius of a property that have a total market value within a specified range.", "operationId"=>"getAssessmentSnapshotTotal", "x-api-path-slug"=>"assessmentsnapshot-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"query", "name"=>"address1", "description"=>"The first line of the mailing address"}, {"in"=>"query", "name"=>"address2", "description"=>"The second line of the mailing address"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"maxmktttlvalue", "description"=>"The estimated total market value from the local taxing authority"}, {"in"=>"query", "name"=>"minmktttlvalue", "description"=>"The estimated total market value from the local taxing authority"}, {"in"=>"query", "name"=>"radius"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Assessment", "Detailsproperties", "Within", "Radius"]}}, "/assessment/detail"=>{"get"=>{"summary"=>"Returns assessment details for properties within a zip code.", "description"=>"Get assessment details for properties within a zip code. Use propertytpe to select a specific property type for your search.", "operationId"=>"assessmenDetailPropertyId", "x-api-path-slug"=>"assessmentdetail-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"postalcode", "description"=>"The postal code or zip code"}, {"in"=>"query", "name"=>"propertytype", "description"=>"A specific property classification such as Detached Single Family"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Assessment", "Detailsproperties", "Within", "Zip", "Code"]}}, "/assessmenthistory/detail"=>{"get"=>{"summary"=>"Returns assessment history and property details.", "description"=>"Get a full detail of property characteristics and assessment history information for a specific property.", "operationId"=>"assessmentHistoryDetailID", "x-api-path-slug"=>"assessmenthistorydetail-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"id", "description"=>"property id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Assessment", "History", "Property", "Details"]}}, "/avm/snapshot"=>{"get"=>{"summary"=>"Returns AVM details within a geography.", "description"=>"Get a list of AVM snapshot records that fall within an Onboard GeoID with a specific value range. Use propertytpe to select a specific property type for your search.", "operationId"=>"avmSnapshotGeoID", "x-api-path-slug"=>"avmsnapshot-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"geoid", "description"=>"A list of geographies that this property belongs to"}, {"in"=>"query", "name"=>"maxavmvalue", "description"=>"This represents the estimated max value for the property"}, {"in"=>"query", "name"=>"minavmvalue", "description"=>"This represents the estimated low value for the property"}, {"in"=>"query", "name"=>"propertytype", "description"=>"A specific property classification such as Detached Single Family"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "AVM", "Details", "Within", "Geography"]}}, "/avm/detail"=>{"get"=>{"summary"=>"Returns AVM details for a property.", "description"=>"Get AVM details for a specific address.", "operationId"=>"avmDetailPostal", "x-api-path-slug"=>"avmdetail-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"query", "name"=>"address1", "description"=>"The first line of the mailing address"}, {"in"=>"query", "name"=>"address2", "description"=>"The second line of the mailing address"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "AVM", "Detailsa", "Property"]}}, "/attomavm/detail"=>{"get"=>{"summary"=>"Returns the Attomized AVM and other property details .", "description"=>"Get Attomized AVM and other property details for a specific address.", "operationId"=>"attomAvmDetail", "x-api-path-slug"=>"attomavmdetail-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"attomid", "description"=>"attom id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Attomized", "AVM", "Other", "Property", "Details"]}}, "/sale/snapshot"=>{"get"=>{"summary"=>"Returns home sale information for properties within a geography.", "description"=>"Get a list of home sale snapshots within a Onboard GeoID that sold within a date range and specified sale amount.", "operationId"=>"getHomeSaleSnapshotsGeoId", "x-api-path-slug"=>"salesnapshot-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"query", "name"=>"address1", "description"=>"The first line of the mailing address"}, {"in"=>"query", "name"=>"address2", "description"=>"The second line of the mailing address"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"endsalesearchdate", "description"=>"The standardized date for search purposes"}, {"in"=>"query", "name"=>"geoid", "description"=>"A list of geographies that this property belongs to"}, {"in"=>"query", "name"=>"maxsaleamt", "description"=>"The recorded amount of the sale transaction"}, {"in"=>"query", "name"=>"minsaleamt", "description"=>"The recorded amount of the sale transaction"}, {"in"=>"query", "name"=>"propertytype", "description"=>"A specific property classification such as Detached Single Family"}, {"in"=>"query", "name"=>"radius"}, {"in"=>"query", "name"=>"startsalesearchdate", "description"=>"The standardized date for search purposes"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Home", "Sale", "Informationproperties", "Within", "Geography"]}}, "/sale/detail"=>{"get"=>{"summary"=>"Returns sale information for a property.", "description"=>"Get sales information for a specific address.", "operationId"=>"getSaleDetailPostal", "x-api-path-slug"=>"saledetail-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"query", "name"=>"address1", "description"=>"The first line of the mailing address"}, {"in"=>"query", "name"=>"address2", "description"=>"The second line of the mailing address"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Sale", "Informationa", "Property"]}}, "/saleshistory/snapshot"=>{"get"=>{"summary"=>"Returns sales history for a property.", "description"=>"Get a sales history snapshot of a property based on an Onboard property ID.", "operationId"=>"getSaleHistorySnapshotPropertyId", "x-api-path-slug"=>"saleshistorysnapshot-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"id", "description"=>"Onboard-assigned unique property identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Sales", "Historya", "Property"]}}, "/saleshistory/basichistory"=>{"get"=>{"summary"=>"Returns basic transaction and loan history on a property.", "description"=>"Get the basic transaction and loan history on a property for a specific address.", "operationId"=>"saleHistoryBasicHistory", "x-api-path-slug"=>"saleshistorybasichistory-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"query", "name"=>"address1", "description"=>"The first line of the mailing address"}, {"in"=>"query", "name"=>"address2", "description"=>"The second line of the mailing address"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Basic", "Transaction", "Loan", "History", "On", "Property"]}}, "/saleshistory/expandedhistory"=>{"get"=>{"summary"=>"Returns detailed transaction, pre-foreclosure and loan history on a property.", "description"=>"Get the detailed transaction, pre-foreclosure and loan history on a property for a specific address.", "operationId"=>"saleHistoryExpandedHistory", "x-api-path-slug"=>"saleshistoryexpandedhistory-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"query", "name"=>"address1", "description"=>"The first line of the mailing address"}, {"in"=>"query", "name"=>"address2", "description"=>"The second line of the mailing address"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Detailed", "Transaction", "", "Pre-foreclosure", "Loan", "History", "On", "Property"]}}, "/saleshistory/detail"=>{"get"=>{"summary"=>"Returns sales history for a property.", "description"=>"Get a sales history snapshot of a property based on an address.", "operationId"=>"getSaleHistoryDetailAddress", "x-api-path-slug"=>"saleshistorydetail-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"query", "name"=>"address1", "description"=>"The first line of the mailing address"}, {"in"=>"query", "name"=>"address2", "description"=>"The second line of the mailing address"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Sales", "Historya", "Property"]}}, "/salestrend/snapshot"=>{"get"=>{"summary"=>"Returns sales trends for a given zip code in yearly intervals", "description"=>"Get the average sale price, median sale price, and count of sales for the past 2 years in yearly intervals.", "operationId"=>"getSalesTrendByYear", "x-api-path-slug"=>"salestrendsnapshot-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"endmonth", "description"=>"The end month to search from"}, {"in"=>"query", "name"=>"endyear", "description"=>"The end year to search from"}, {"in"=>"query", "name"=>"geoid", "description"=>"A list of geographies that this property belongs to"}, {"in"=>"query", "name"=>"interval", "description"=>"The interval to search from"}, {"in"=>"query", "name"=>"startmonth", "description"=>"The start month to search from"}, {"in"=>"query", "name"=>"startyear", "description"=>"The start year to search from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Sales", "Trendsa", "Given", "Zip", "Code", "In", "Yearly", "Intervals"]}}, "/hierarchy/lookup"=>{"get"=>{"summary"=>"Returns all boundaries a point falls within.", "description"=>"This method allows you to pass a latitude and longitude point and geo type to retrieve a list of geographies that point falls within. Required input is a valid WKT (Well Known Text) point.", "operationId"=>"getAreaHierarchyLookup", "x-api-path-slug"=>"hierarchylookup-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"geoType", "description"=>"known Geo Type"}, {"in"=>"query", "name"=>"latitude", "description"=>"The property latitude coordinate"}, {"in"=>"query", "name"=>"longitude", "description"=>"The property longitude coordinate"}, {"in"=>"query", "name"=>"WKTString", "description"=>"WKTString parameters"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "", "Boundaries", "Point", "Falls", "Within"]}}, "/poi/geography"=>{"get"=>{"summary"=>"Returns POIs based on zip code.", "description"=>"This search returns a list of Points of Interest in proximity to the centroid of a zip code.", "operationId"=>"getPOISearchGeography", "x-api-path-slug"=>"poigeography-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"ApiKey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"PostalCodeKey", "description"=>"This is the Postal Code"}, {"in"=>"query", "name"=>"RecordLimit", "description"=>"This is RecordLimit"}, {"in"=>"query", "name"=>"SearchDistance", "description"=>"This is SearchDistance"}, {"in"=>"query", "name"=>"Sort", "description"=>"This is for Sortable Columns"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "POIs", "Based", "On", "Zip", "Code"]}}, "/poi/point"=>{"get"=>{"summary"=>"Returns POIs based on point.", "description"=>"This search returns a list of POI in proximity to a latitude/longitude.", "operationId"=>"getPOISearchPoint", "x-api-path-slug"=>"poipoint-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"BusinessCategory", "description"=>"This is Business Category as per Lookup separated by pipe |"}, {"in"=>"query", "name"=>"Point", "description"=>"This is the Point value"}, {"in"=>"query", "name"=>"RecordLimit", "description"=>"This is RecordLimit"}, {"in"=>"query", "name"=>"SearchDistance", "description"=>"This is SearchDistance"}, {"in"=>"query", "name"=>"Sort", "description"=>"This is for Sortable Columns"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "POIs", "Based", "On", "Point"]}}, "/poi/street+address"=>{"get"=>{"summary"=>"Returns POIs based on an address.", "description"=>"This search returns a list of POI in proximity to an address.", "operationId"=>"getPOISearchPoint", "x-api-path-slug"=>"poistreetaddress-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"RecordLimit", "description"=>"This is RecordLimit"}, {"in"=>"query", "name"=>"SearchDistance", "description"=>"This is SearchDistance"}, {"in"=>"query", "name"=>"Sort", "description"=>"This is for Sortable Columns"}, {"in"=>"query", "name"=>"StreetAddress", "description"=>"This is the Point value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "POIs", "Based", "On", "Address"]}}, "/business+category/lookup"=>{"get"=>{"summary"=>"Returns business categories.", "description"=>"This lookup is used to obtain a full list of Business Categories.", "operationId"=>"getPOIBusinessCategoryLookup", "x-api-path-slug"=>"businesscategorylookup-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Business", "Categories"]}}, "/lob/lookup"=>{"get"=>{"summary"=>"Returns lines of business categories.", "description"=>"This lookup can be used to show the full list of Lines of Businesses (LOB), and which categories they belong to.", "operationId"=>"getPOIlob", "x-api-path-slug"=>"loblookup-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Lines", "Of", "Business", "Categories"]}}, "/area/full"=>{"get"=>{"summary"=>"Returns community information.", "description"=>"This search returns community information for a specific geography.", "operationId"=>"getCommunityAPIAreaFull", "x-api-path-slug"=>"areafull-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"ApiKey", "description"=>"Application Key"}, {"in"=>"query", "name"=>"AreaId", "description"=>"This is the Area ID to search"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Community", "Information"]}}, "/attribute/lookup"=>{"get"=>{"summary"=>"Returns available data fields.", "description"=>"This lookup returns the full list of over 375 data fields that are available in the Community API.", "operationId"=>"getCommunityAPIAttributeLookup", "x-api-path-slug"=>"attributelookup-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"application/xml or application/json (default)"}, {"in"=>"header", "name"=>"apikey", "description"=>"Application Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Available", "Data", "Fields"]}}}}, "apis"=>{"name"=>"ATTOM", "x-slug"=>"attom", "description"=>"Search public property records including real estate data: sale, ownership, tax, and more - for more than 150 million U.S. properties. ATTOM Data Solutions is the curator of ATTOM, a multi-sourced national property data warehouse that contains tax, deed, mortgage, foreclosure, environmental risk, natural hazard, health hazard, neighborhood characteristic and property characteristic data for over 155 million U.S. properties, delivering actionable data to clients and powering consumer websites owned by ATTOM Data Solutions: RealtyTrac.com, Homefacts.com, and HomeDisclosure.com.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28881-api-developer-attomdata-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"359677", "tags"=>"Enterprise,General Data,Historical Data API,Places,Properties,Real Estate,SaaS,Schools,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"attom/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Attom Data Solutions API", "x-api-slug"=>"attom-data-solutions-api", "description"=>"ATTOM empowers customers with better property data. We warehouse property data nationwide with myriad data points on each parcel including ownership information, lat/long, square footage, loan types, sales history, sales comps, crime, schools and more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28881-api-developer-attomdata-com.jpg", "humanURL"=>"https://api.developer.attomdata.com", "baseURL"=>"https://search.onboard-apis.com//communityapi/v2.0.0", "tags"=>"Enterprise,General Data,Historical Data API,Places,Properties,Real Estate,SaaS,Schools,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/attom/attributelookup-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/attom/attom-data-solutions-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-openapi", "url"=>"https://api.developer.attomdata.com/swagger/spec/propertyapi_property.json"}, {"type"=>"x-email", "url"=>"privacy@attomdata.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Attomdata"}, {"type"=>"x-website", "url"=>"https://api.developer.attomdata.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
framesocket{"framesocket-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Framesocket", "x-complete"=>1, "info"=>{"title"=>"Framesocket", "description"=>"framesocket-is-the-best-way-for-developers-and-content-owners-to-tackle-video-projects-of-any-size-", "version"=>"1.0.0"}, "host"=>"www.framesocket.com", "basePath"=>"/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/media/activate.php"=>{"get"=>{"summary"=>"Activate Media", "description"=>"Activate Media", "operationId"=>"getMediaActivate.php", "x-api-path-slug"=>"mediaactivate-php-get", "parameters"=>[{"in"=>"query", "name"=>"customid", "description"=>"Custom ID"}, {"in"=>"query", "name"=>"hash", "description"=>"Video Hash"}, {"in"=>"query", "name"=>"key", "description"=>"Your account username"}, {"in"=>"query", "name"=>"secret", "description"=>"Your account API secret"}, {"in"=>"query", "name"=>"sig", "description"=>"This is an md5 hash of your gatekeeper concatenated with your request action"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media", "Activate"]}}, "/media/deactivate.php"=>{"get"=>{"summary"=>"Deactive Media", "description"=>"Deactive Media", "operationId"=>"getMediaDeactivate.php", "x-api-path-slug"=>"mediadeactivate-php-get", "parameters"=>[{"in"=>"query", "name"=>"customid", "description"=>"Custom ID"}, {"in"=>"query", "name"=>"hash", "description"=>"Video Hash"}, {"in"=>"query", "name"=>"key", "description"=>"Your account username"}, {"in"=>"query", "name"=>"secret", "description"=>"Your account API secret"}, {"in"=>"query", "name"=>"sig", "description"=>"This is an md5 hash of your gatekeeper concatenated with your request action"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media", "Deactivate"]}}, "/media/images.php"=>{"get"=>{"summary"=>"Query Images", "description"=>"Query Images", "operationId"=>"getMediaImages.php", "x-api-path-slug"=>"mediaimages-php-get", "parameters"=>[{"in"=>"query", "name"=>"customid", "description"=>"Custom ID"}, {"in"=>"query", "name"=>"hash", "description"=>"Video Hash"}, {"in"=>"query", "name"=>"key", "description"=>"Your account username"}, {"in"=>"query", "name"=>"secret", "description"=>"Your account API secret"}, {"in"=>"query", "name"=>"sig", "description"=>"This is an md5 hash of your gatekeeper concatenated with your request action"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media", "Images"]}}, "/media/query.php"=>{"get"=>{"summary"=>"Query Media", "description"=>"Query Media", "operationId"=>"getMediaQuery.php", "x-api-path-slug"=>"mediaquery-php-get", "parameters"=>[{"in"=>"query", "name"=>"andkeywords", "description"=>"Comma separated list of title words"}, {"in"=>"query", "name"=>"andtitlewords", "description"=>"Comma separated list of title words"}, {"in"=>"query", "name"=>"customid", "description"=>"Custom ID"}, {"in"=>"query", "name"=>"hash", "description"=>"Media Hash Code"}, {"in"=>"query", "name"=>"key", "description"=>"Your account username"}, {"in"=>"query", "name"=>"limit", "description"=>"Must be a valid integer"}, {"in"=>"query", "name"=>"orkeywords", "description"=>"Comma separated list of title words"}, {"in"=>"query", "name"=>"ortitlewords", "description"=>"Comma separated list of title words"}, {"in"=>"query", "name"=>"secret", "description"=>"Your account API secret"}, {"in"=>"query", "name"=>"sig", "description"=>"This is an md5 hash of your gatekeeper concatenated with your request action"}, {"in"=>"query", "name"=>"sort", "description"=>"Must be a valid sorting option, either newest or oldest firs"}, {"in"=>"query", "name"=>"status", "description"=>"Must be a valid status code"}, {"in"=>"query", "name"=>"type", "description"=>"Must be a valid type, either image or video"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media", "Query"]}}, "/media/update.php"=>{"get"=>{"summary"=>"Update Media", "description"=>"Update Media", "operationId"=>"getMediaUpdate.php", "x-api-path-slug"=>"mediaupdate-php-get", "parameters"=>[{"in"=>"query", "name"=>"customid", "description"=>"Custom ID"}, {"in"=>"query", "name"=>"description", "description"=>"Text String - Limit 1000 characters"}, {"in"=>"query", "name"=>"hash", "description"=>"Video Hash"}, {"in"=>"query", "name"=>"imagehash", "description"=>"This needs to refer to an image already assigned to this media"}, {"in"=>"query", "name"=>"key", "description"=>"Your account username"}, {"in"=>"query", "name"=>"keywords", "description"=>"Text String - Comma separated by keyword or phrase"}, {"in"=>"query", "name"=>"secret", "description"=>"Your account API secret"}, {"in"=>"query", "name"=>"sig", "description"=>"This is an md5 hash of your gatekeeper concatenated with your request action"}, {"in"=>"query", "name"=>"title", "description"=>"Text String - Limit 100 characters"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media", "Update"]}}, "/media/upload.php"=>{"post"=>{"summary"=>"Upload Media", "description"=>"Upload Media", "operationId"=>"postMediaUpload.php", "x-api-path-slug"=>"mediaupload-php-post", "parameters"=>[{"in"=>"query", "name"=>"callback"}, {"in"=>"query", "name"=>"customid", "description"=>"Text String - Max Length 32 Characters"}, {"in"=>"query", "name"=>"description", "description"=>"Text String - Limit 1000 Characters"}, {"in"=>"query", "name"=>"key", "description"=>"Your account username"}, {"in"=>"query", "name"=>"keywords", "description"=>"Text String - Comma separated by keyword or phrase"}, {"in"=>"query", "name"=>"media", "description"=>"Must be properly formatted POST data - either an image or a video"}, {"in"=>"query", "name"=>"secret", "description"=>"Your account API secret"}, {"in"=>"query", "name"=>"sig", "description"=>"This is an md5 hash of your gatekeeper concatenated with your request action"}, {"in"=>"query", "name"=>"title", "description"=>"Text String - Limit 100 Characters"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media", "Upload"]}}}}, "apis"=>{"name"=>"Framesocket", "x-slug"=>"framesocket", "description"=>"Easily integrate video into your website or mobile applications. Build traffic via Google Facebook YouTube Twitter. No limits on users storage or bandwidth.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/795-framesocket.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"5719311", "tags"=>"API Provider,Hosting,internet,Mobile,Profiles,SaaS,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"framesocket/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Framesocket", "x-api-slug"=>"framesocket", "description"=>"framesocket is the best way for developers and content owners to tackle video projects of any size.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/795-framesocket.jpg", "humanURL"=>"http://framesocket.com", "baseURL"=>"://www.framesocket.com//api", "tags"=>"API Provider,Hosting,internet,Mobile,Profiles,SaaS,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/framesocket/mediaupload-php-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/framesocket/framesocket-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://www.framesocket.com/api/"}, {"type"=>"x-blog", "url"=>"http://blog.framesocket.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.framesocket.com/rss"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/framesocket"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/framesocket"}, {"type"=>"x-developer", "url"=>"http://www.framesocket.com/for-developers/"}, {"type"=>"x-email", "url"=>"api-support@framesocket.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/framesocket"}, {"type"=>"x-website", "url"=>"http://framesocket.com"}, {"type"=>"x-website", "url"=>"http://www.framesocket.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ripaex{"ripaex-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"RipaEx", "x-complete"=>1, "info"=>{"title"=>"RIPA Node Documentation", "description"=>"this-is-a-documentation-for-ripanodehttpsgithub-comripaexripanode-built-with-swagger-ui-to-make-testing-a-breeze--if-you-find-any-issues-come-over-to-ripaexripanodetestapihttpsgithub-comripaexripanodetestapi-to-open-an-issue-or-even-better-send-a-pr-that-fixes-the-issue-the-community-ssl-public-api-used-as-test-host-is-provided-from-ripaex-iohttpswww-ripaex-io-", "version"=>"1.0.0"}, "host"=>"api.ripaex.io", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/accounts/getBalance"=>{"get"=>{"summary"=>"Accounts Get Balance", "description"=>"Get the balance of an account.", "operationId"=>"accounts.getBalance", "x-api-path-slug"=>"apiaccountsgetbalance-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"A valid RIPA Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Accounts", "", "Balance"]}}, "/api/accounts/getPublickey"=>{"get"=>{"summary"=>"Accounts Get Publickey", "description"=>"Get the public key of an account.", "operationId"=>"accounts.getPublickey", "x-api-path-slug"=>"apiaccountsgetpublickey-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"A valid RIPA Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Accounts", "", "Publickey"]}}, "/api/accounts/delegates/fee"=>{"get"=>{"summary"=>"Accounts Delegates Fee", "description"=>"Get the delegate fee of an account.", "operationId"=>"accounts.getDelegatesFee", "x-api-path-slug"=>"apiaccountsdelegatesfee-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Accounts", "Delegates", "Fee"]}}, "/api/accounts/delegates"=>{"get"=>{"summary"=>"Accounts Delegates", "description"=>"Get the delegates of an account.", "operationId"=>"accounts.getDelegates", "x-api-path-slug"=>"apiaccountsdelegates-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"A valid RIPA Address"}, {"in"=>"query", "name"=>"limit", "description"=>"An unsigned integer that specifies the maximum number of records"}, {"in"=>"query", "name"=>"offset", "description"=>"An unsigned integer that specified the number of records to skip"}, {"in"=>"query", "name"=>"orderBy", "description"=>"A string that specifies the column by which to sort the records"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Accounts", "Delegates"]}, "put"=>{"summary"=>"Accounts Delegates", "description"=>"Vote for a delegate by public key.", "operationId"=>"accounts.addDelegates", "x-api-path-slug"=>"apiaccountsdelegates-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Accounts", "Delegates"]}}, "/api/accounts"=>{"get"=>{"summary"=>"Accounts", "description"=>"Returns account information of an address.", "operationId"=>"accounts.getAccount", "x-api-path-slug"=>"apiaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"A valid RIPA Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Accounts"]}}, "/api/accounts/getAllAccounts"=>{"get"=>{"summary"=>"Accounts Get All Accounts", "description"=>"Get a list of accounts.", "operationId"=>"accounts.getAllAccounts", "x-api-path-slug"=>"apiaccountsgetallaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Accounts", "", "", "Accounts"]}}, "/api/accounts/top"=>{"get"=>{"summary"=>"Accounts Top", "description"=>"Get a list of top accounts.", "operationId"=>"accounts.top", "x-api-path-slug"=>"apiaccountstop-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"An unsigned integer that specifies the maximum number of records"}, {"in"=>"query", "name"=>"offset", "description"=>"An unsigned integer that specified the number of records to skip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Accounts", "Top"]}}, "/api/accounts/count"=>{"get"=>{"summary"=>"Accounts Count", "description"=>"Get the count of accounts.", "operationId"=>"accounts.count", "x-api-path-slug"=>"apiaccountscount-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Accounts", "Count"]}}, "/api/blocks/get"=>{"get"=>{"summary"=>"Blocks Get", "description"=>"Get block by id.", "operationId"=>"blocks.getBlock", "x-api-path-slug"=>"apiblocksget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Blocks"]}}, "/api/blocks"=>{"get"=>{"summary"=>"Blocks", "description"=>"Get all blocks.", "operationId"=>"blocks.getBlocks", "x-api-path-slug"=>"apiblocks-get", "parameters"=>[{"in"=>"query", "name"=>"generatorPublicKey", "description"=>"A valid RIPA Public Key"}, {"in"=>"query", "name"=>"height"}, {"in"=>"query", "name"=>"limit", "description"=>"An unsigned integer that specifies the maximum number of records"}, {"in"=>"query", "name"=>"offset", "description"=>"An unsigned integer that specified the number of records to skip"}, {"in"=>"query", "name"=>"orderBy", "description"=>"A string that specifies the column by which to sort the records"}, {"in"=>"query", "name"=>"previousBlock"}, {"in"=>"query", "name"=>"reward"}, {"in"=>"query", "name"=>"totalAmount"}, {"in"=>"query", "name"=>"totalFee"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Blocks"]}}, "/api/blocks/getEpoch"=>{"get"=>{"summary"=>"Blocks Get Epoch", "description"=>"Get the blockchain epoch.", "operationId"=>"blocks.getEpoch", "x-api-path-slug"=>"apiblocksgetepoch-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Blocks", "", "Epoch"]}}, "/api/blocks/getHeight"=>{"get"=>{"summary"=>"Blocks Get Height", "description"=>"Get the blockchain height.", "operationId"=>"blocks.getHeight", "x-api-path-slug"=>"apiblocksgetheight-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Blocks", "", "Height"]}}, "/api/blocks/getNethash"=>{"get"=>{"summary"=>"Blocks Get Nethash", "description"=>"Get the blockchain nethash.", "operationId"=>"blocks.getNethash", "x-api-path-slug"=>"apiblocksgetnethash-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Blocks", "", "Nethash"]}}, "/api/blocks/getFee"=>{"get"=>{"summary"=>"Blocks Get Fee", "description"=>"Get the transaction fee for sending \"normal\" transactions.", "operationId"=>"blocks.getFee", "x-api-path-slug"=>"apiblocksgetfee-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Blocks", "", "Fee"]}}, "/api/blocks/getFees"=>{"get"=>{"summary"=>"Blocks Get Fees", "description"=>"Get the network fees.", "operationId"=>"blocks.getFees", "x-api-path-slug"=>"apiblocksgetfees-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Blocks", "", "Fees"]}}, "/api/blocks/getMilestone"=>{"get"=>{"summary"=>"Blocks Get Milestone", "description"=>"Get the blockchain milestone.", "operationId"=>"blocks.getMilestone", "x-api-path-slug"=>"apiblocksgetmilestone-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Blocks", "", "Milestone"]}}, "/api/blocks/getReward"=>{"get"=>{"summary"=>"Blocks Get Reward", "description"=>"Get the blockchain reward.", "operationId"=>"blocks.getReward", "x-api-path-slug"=>"apiblocksgetreward-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Blocks", "", "Reward"]}}, "/api/blocks/getSupply"=>{"get"=>{"summary"=>"Blocks Get Supply", "description"=>"Get the blockchain supply.", "operationId"=>"blocks.getSupply", "x-api-path-slug"=>"apiblocksgetsupply-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Blocks", "", "Supply"]}}, "/api/blocks/getStatus"=>{"get"=>{"summary"=>"Blocks Get Status", "description"=>"Get the blockchain status.", "operationId"=>"blocks.getStatus", "x-api-path-slug"=>"apiblocksgetstatus-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Blocks", "", "Status"]}}, "/api/delegates/count"=>{"get"=>{"summary"=>"Delegates Count", "description"=>"Get the count of delegates.", "operationId"=>"delegates.count", "x-api-path-slug"=>"apidelegatescount-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"A valid RIPA Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Delegates", "Count"]}}, "/api/delegates/search"=>{"get"=>{"summary"=>"Delegates Search", "description"=>"Search for specific delegates.", "operationId"=>"delegates.search", "x-api-path-slug"=>"apidelegatessearch-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"An unsigned integer that specifies the maximum number of records"}, {"in"=>"query", "name"=>"q", "description"=>"A search query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Delegates", "Search"]}}, "/api/delegates/voters"=>{"get"=>{"summary"=>"Delegates Voters", "description"=>"Get a list of voters for a delegate.", "operationId"=>"delegates.getVoters", "x-api-path-slug"=>"apidelegatesvoters-get", "parameters"=>[{"in"=>"query", "name"=>"publicKey", "description"=>"A valid RIPA Public Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Delegates", "Voters"]}}, "/api/delegates/get"=>{"get"=>{"summary"=>"Delegates Get", "description"=>"Get a single delegate.", "operationId"=>"delegates.getDelegate", "x-api-path-slug"=>"apidelegatesget-get", "parameters"=>[{"in"=>"query", "name"=>"publicKey", "description"=>"A valid RIPA Public Key"}, {"in"=>"query", "name"=>"username", "description"=>"A valid RIPA Delegate username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Delegates"]}}, "/api/delegates"=>{"get"=>{"summary"=>"Delegates", "description"=>"Get all delegates.", "operationId"=>"delegates.getDelegates", "x-api-path-slug"=>"apidelegates-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"An unsigned integer that specifies the maximum number of records"}, {"in"=>"query", "name"=>"offset", "description"=>"An unsigned integer that specified the number of records to skip"}, {"in"=>"query", "name"=>"orderBy", "description"=>"A string that specifies the column by which to sort the records"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Delegates"]}, "put"=>{"summary"=>"Delegates", "description"=>"Create a new delegate.", "operationId"=>"delegates.addDelegate", "x-api-path-slug"=>"apidelegates-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A valid RIPA delegate object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Delegates"]}}, "/api/delegates/fee"=>{"get"=>{"summary"=>"Delegates Fee", "description"=>"Get the delegate fee.", "operationId"=>"delegates.getFee", "x-api-path-slug"=>"apidelegatesfee-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"A valid RIPA Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Delegates", "Fee"]}}, "/api/delegates/forging/getForgedByAccount"=>{"get"=>{"summary"=>"Delegates Forging Get Forged By Account", "description"=>"Get the amount of ripas forged by an account.", "operationId"=>"delegates.getForgedByAccount", "x-api-path-slug"=>"apidelegatesforginggetforgedbyaccount-get", "parameters"=>[{"in"=>"query", "name"=>"generatorPublicKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Delegates", "Forging", "", "Forged", "Account"]}}, "/api/delegates/getNextForgers"=>{"get"=>{"summary"=>"Delegates Get Next Forgers", "description"=>"Get the next forger.", "operationId"=>"delegates.getNextForgers", "x-api-path-slug"=>"apidelegatesgetnextforgers-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"A valid RIPA Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Delegates", "", "Next", "Forgers"]}}, "/api/delegates/forging/enable"=>{"post"=>{"summary"=>"Delegates Forging Enable", "description"=>"Enable forging for a delegate.", "operationId"=>"delegates.enableForging", "x-api-path-slug"=>"apidelegatesforgingenable-post", "parameters"=>[{"in"=>"query", "name"=>"publicKey", "description"=>"A valid RIPA Public Key"}, {"in"=>"query", "name"=>"secret", "description"=>"A valid RIPA Passphrase"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Delegates", "Forging", "Enable"]}}, "/api/delegates/forging/disable"=>{"post"=>{"summary"=>"Delegates Forging Disable", "description"=>"Disable forging for a delegate.", "operationId"=>"delegates.disableForging", "x-api-path-slug"=>"apidelegatesforgingdisable-post", "parameters"=>[{"in"=>"query", "name"=>"publicKey", "description"=>"A valid RIPA Public Key"}, {"in"=>"query", "name"=>"secret", "description"=>"A valid RIPA Passphrase"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Delegates", "Forging", "Disable"]}}, "/api/loader/status"=>{"get"=>{"summary"=>"Loader Status", "description"=>"Get the blockchain status.", "operationId"=>"loader.status", "x-api-path-slug"=>"apiloaderstatus-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Loader", "Status"]}}, "/api/loader/status/sync"=>{"get"=>{"summary"=>"Loader Status Sync", "description"=>"Get the synchronisation status of the client.", "operationId"=>"loader.sync", "x-api-path-slug"=>"apiloaderstatussync-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Loader", "Status", "Sync"]}}, "/api/loader/autoconfigure"=>{"get"=>{"summary"=>"Loader Autoconfigure", "description"=>"Auto-configure the client loader.", "operationId"=>"loader.autoconfigure", "x-api-path-slug"=>"apiloaderautoconfigure-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Loader", "Autoconfigure"]}}, "/api/multisignatures/pending"=>{"get"=>{"summary"=>"Multisignatures Pending", "description"=>"Get pending multi signature transactions.", "operationId"=>"multisignatures.pending", "x-api-path-slug"=>"apimultisignaturespending-get", "parameters"=>[{"in"=>"query", "name"=>"publicKey", "description"=>"A valid RIPA Public Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Multisignatures", "Pending"]}}, "/api/multisignatures/sign"=>{"post"=>{"summary"=>"Multisignatures Sign", "description"=>"Sign a new multi signature.", "operationId"=>"multisignatures.sign", "x-api-path-slug"=>"apimultisignaturessign-post", "parameters"=>[{"in"=>"query", "name"=>"publicKey", "description"=>"A valid RIPA Public Key"}, {"in"=>"query", "name"=>"secondSecret", "description"=>"A valid secondary RIPA Passphrase"}, {"in"=>"query", "name"=>"secret", "description"=>"A valid RIPA Passphrase"}, {"in"=>"query", "name"=>"transactionId", "description"=>"A valid transaction ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Multisignatures", "Sign"]}}, "/api/multisignatures"=>{"put"=>{"summary"=>"Multisignatures", "description"=>"Create a new multi signature.", "operationId"=>"multisignatures.addMultisignature", "x-api-path-slug"=>"apimultisignatures-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A valid multi signature object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Multisignatures"]}}, "/api/multisignatures/accounts"=>{"get"=>{"summary"=>"Multisignatures Accounts", "description"=>"Get a list of accounts.", "operationId"=>"multisignature.getAccounts", "x-api-path-slug"=>"apimultisignaturesaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"publicKey", "description"=>"A valid RIPA Public Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Multisignatures", "Accounts"]}}, "/api/peers/get"=>{"get"=>{"summary"=>"Peers Get", "description"=>"Get a single peer.", "operationId"=>"peers.getPeer", "x-api-path-slug"=>"apipeersget-get", "parameters"=>[{"in"=>"query", "name"=>"ip", "description"=>"A valid server IP"}, {"in"=>"query", "name"=>"port", "description"=>"A valid server Port"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Peers"]}}, "/api/peers"=>{"get"=>{"summary"=>"Peers", "description"=>"Get all peers.", "operationId"=>"peers.getPeers", "x-api-path-slug"=>"apipeers-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"An unsigned integer that specifies the maximum number of records"}, {"in"=>"query", "name"=>"offset", "description"=>"An unsigned integer that specified the number of records to skip"}, {"in"=>"query", "name"=>"orderBy", "description"=>"A string that specifies the column by which to sort the records"}, {"in"=>"query", "name"=>"os", "description"=>"A valid operating system"}, {"in"=>"query", "name"=>"port", "description"=>"A valid server port"}, {"in"=>"query", "name"=>"state", "description"=>"An unsigned integer that specifies the peer state"}, {"in"=>"query", "name"=>"version", "description"=>"A valid ripa-node version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Peers"]}}, "/api/peers/version"=>{"get"=>{"summary"=>"Peers Version", "description"=>"Get the peer version.", "operationId"=>"peers.version", "x-api-path-slug"=>"apipeersversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Peers", "Version"]}}, "/api/signatures/fee"=>{"get"=>{"summary"=>"Signatures Fee", "description"=>"Get the fee for a signature.", "operationId"=>"signatures.fee", "x-api-path-slug"=>"apisignaturesfee-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"A valid RIPA Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Signatures", "Fee"]}}, "/api/signatures"=>{"put"=>{"summary"=>"Signatures", "description"=>"Create a new signature.", "operationId"=>"signatures.addSignature", "x-api-path-slug"=>"apisignatures-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A valid signature object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Signatures"]}}, "/api/transactions/get"=>{"get"=>{"summary"=>"Transactions Get", "description"=>"Get a single transaction.", "operationId"=>"transactions.getTransaction", "x-api-path-slug"=>"apitransactionsget-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"A valid transaction ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Transactions"]}}, "/api/transactions"=>{"get"=>{"summary"=>"Transactions", "description"=>"Get all transactions.", "operationId"=>"transactions.getTransactions", "x-api-path-slug"=>"apitransactions-get", "parameters"=>[{"in"=>"query", "name"=>"amount", "description"=>"An unsigned integer that specifies the transaction amount"}, {"in"=>"query", "name"=>"blockId", "description"=>"An unsigned integer that specifies the block ID"}, {"in"=>"query", "name"=>"fee", "description"=>"An unsigned integer that specifies the transaction fee"}, {"in"=>"query", "name"=>"limit", "description"=>"An unsigned integer that specifies the maximum number of records"}, {"in"=>"query", "name"=>"offset", "description"=>"An unsigned integer that specified the number of records to skip"}, {"in"=>"query", "name"=>"orderBy", "description"=>"A string that specifies the column by which to sort the records"}, {"in"=>"query", "name"=>"ownerAddress", "description"=>"A valid RIPA Address"}, {"in"=>"query", "name"=>"ownerPublicKey", "description"=>"A valid RIPA Address"}, {"in"=>"query", "name"=>"recipientId", "description"=>"A valid RIPA Address"}, {"in"=>"query", "name"=>"senderId", "description"=>"A valid RIPA Address"}, {"in"=>"query", "name"=>"senderPublicKey", "description"=>"A valid RIPA Public Key"}, {"in"=>"query", "name"=>"type", "description"=>"An unsigned integer that specifies the transaction type"}, {"in"=>"query", "name"=>"vendorField", "description"=>"A string that specifies the SmartBridge used"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Transactions"]}, "put"=>{"summary"=>"Transactions", "description"=>"Create a new transaction.", "operationId"=>"transactions.addTransactions", "x-api-path-slug"=>"apitransactions-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A valid transaction object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Transactions"]}}, "/api/transactions/unconfirmed/get"=>{"get"=>{"summary"=>"Transactions Unconfirmed Get", "description"=>"Get a single unconfirmed transaction.", "operationId"=>"transactions.getUnconfirmedTransaction", "x-api-path-slug"=>"apitransactionsunconfirmedget-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"A valid unconfirmed transaction ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Transactions", "Unconfirmed"]}}, "/api/transactions/unconfirmed"=>{"get"=>{"summary"=>"Transactions Unconfirmed", "description"=>"Get all unconfirmed transactions.", "operationId"=>"transactions.getUnconfirmedTransactions", "x-api-path-slug"=>"apitransactionsunconfirmed-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"A valid RIPA Address"}, {"in"=>"query", "name"=>"senderPublicKey", "description"=>"A valid RIPA Public Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Transactions", "Unconfirmed"]}}, "/peer/list"=>{"get"=>{"summary"=>"Peer List", "description"=>"Get a list of peers.", "operationId"=>"transport.listBroadcastPeers", "x-api-path-slug"=>"peerlist-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Peer", "List"]}}, "/peer/blocks/common"=>{"get"=>{"summary"=>"Peer Blocks Common", "description"=>"Get a list of blocks by ids.", "operationId"=>"transport.commonBlock", "x-api-path-slug"=>"peerblockscommon-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"A list of block IDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Peer", "Blocks", "Common"]}}, "/peer/block"=>{"get"=>{"summary"=>"Peer Block", "description"=>"Get a single block.", "operationId"=>"transport.getBlock", "x-api-path-slug"=>"peerblock-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"A valid RIPA Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Peer", "Block"]}}, "/peer/blocks"=>{"get"=>{"summary"=>"Peer Blocks", "description"=>"Get all blocks.", "operationId"=>"transport.getBlocks", "x-api-path-slug"=>"peerblocks-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"A valid RIPA Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Peer", "Blocks"]}}, "/peer/transactions"=>{"get"=>{"summary"=>"Peer Transactions", "description"=>".", "operationId"=>"transport.getTransactions", "x-api-path-slug"=>"peertransactions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Peer", "Transactions"]}, "post"=>{"summary"=>"Peer Transactions", "description"=>"Create a new transaction.", "operationId"=>"transport.addTransactions", "x-api-path-slug"=>"peertransactions-post", "parameters"=>[{"in"=>"body", "name"=>"transactions", "description"=>"A valid transaction object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Peer", "Transactions"]}}, "/peer/transactionsFromIds"=>{"get"=>{"summary"=>"Peer Transactions From Ids", "description"=>"Get a list of transactions by ids.", "operationId"=>"transport.transactionsFromIds", "x-api-path-slug"=>"peertransactionsfromids-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"A list of transaction IDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Peer", "Transactions", "From", "Ids"]}}, "/peer/height"=>{"get"=>{"summary"=>"Peer Height", "description"=>"Get the blockchain height.", "operationId"=>"transport.height", "x-api-path-slug"=>"peerheight-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Peer", "Height"]}}, "/peer/status"=>{"get"=>{"summary"=>"Peer Status", "description"=>"Get the blockchain status.", "operationId"=>"transport.status", "x-api-path-slug"=>"peerstatus-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Peer", "Status"]}}}}, "apis"=>{"name"=>"RipaEx", "x-slug"=>"ripaex", "description"=>"Ripa Exchange is an hybrid-decentralized exchange with a strong focus on lowering the entry level for opening new exchanges and giving crypto traders safe and secure trading partners to operate on a daily basis.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28880-ripaex-io.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"1669824", "tags"=>"Blockchain,General Data", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"ripaex/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"RipaEx", "x-api-slug"=>"ripaex", "description"=>"Ripa Exchange is an hybrid-decentralized exchange with a strong focus on lowering the entry level for opening new exchanges and giving crypto traders safe and secure trading partners to operate on a daily basis.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28880-ripaex-io.jpg", "humanURL"=>"http://www.ripaex.io", "baseURL"=>"https://api.ripaex.io//", "tags"=>"Blockchain,General Data", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/ripaex/ripaex-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://test.ripaex.io/"}, {"type"=>"x-github", "url"=>"https://github.com/RipaEx"}, {"type"=>"x-website", "url"=>"http://www.ripaex.io"}, {"type"=>"x-email", "url"=>"info@ripaex.io"}, {"type"=>"x-road-map", "url"=>"https://ripaex.io/#roadmap"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/ripaex"}, {"type"=>"x-website", "url"=>"https://ripaex.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
apimatic{"apimatic-api-transformer-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"APIMATIC", "x-complete"=>1, "info"=>{"title"=>"APIMATIC API Transformer", "description"=>"transform-api-descriptions-fromto-various-formats", "termsOfService"=>"https://apimatic.io/transformer", "contact"=>{"name"=>"API Transformer", "url"=>"https://apimatic.io/transformer", "email"=>"transform@apimatic.io"}, "version"=>"1.0"}, "host"=>"apimatic.io", "basePath"=>"/api/transform", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/transform"=>{"post"=>{"summary"=>"Transform API Descriptions from/to various formats", "description"=>"Transform API Descriptions from/to various formats e.g., Swagger, API Blueprint, RAML, WADL, Google Discovery, I/O Docs.\n\n### INPUTS\n* API Blueprint\n* Swagger 1.0 - 1.2\n* Swagger 2.0 JSON\n* Swagger 2.0 YAML\n* WADL - W3C 2009\n* Google Discovery\n* RAML 0.8\n* I/O Docs - Mashery\n* HAR 1.2\n* Postman Collection 1.0 - 2.0\n* APIMATIC Format\n* Mashape\n\n### OUTPUTS\n* API Blueprint\n* Swagger 1.2\n* Swagger 2.0 JSON\n* Swagger 2.0 YAML\n* WADL - W3C 2009\n* RAML 0.8 - 1.0\n* APIMATIC Format", "operationId"=>"ConvertAPI", "x-api-path-slug"=>"transform-post", "parameters"=>[{"in"=>"query", "name"=>"format"}, {"in"=>"formData", "name"=>"url"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Definition", "Conversion", "Tranform"]}}}}, "apis"=>{"name"=>"APIMATIC", "x-slug"=>"apimatic", "description"=>"A Developer Experience Platform for APIs. Services include: Developer Portal Generation, SDK Generation, Documentation Generation, Code Sample Generation, API Specification Conversion, CI/CD Integrations, Package Publishing", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2939-apimatic.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"972589", "tags"=>"API Service Provider,Design,interesting,My API Stack,Profiles,SaaS,SDK,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"apimatic/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"APIMATIC API Transformer", "x-api-slug"=>"apimatic-api-transformer", "description"=>"A Developer Experience Platform for APIs. Services include: Developer Portal Generation, SDK Generation, Documentation Generation, Code Sample Generation, API Specification Conversion, CI/CD Integrations, Package Publishing", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2939-apimatic.jpg", "humanURL"=>"http://apimatic.io", "baseURL"=>"https://apimatic.io//api/transform", "tags"=>"API Service Provider,Design,interesting,My API Stack,Profiles,SaaS,SDK,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/apimatic/transform-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/apimatic/apimatic-api-transformer-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://apimatic.io/blog"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/apimatic"}, {"type"=>"x-github", "url"=>"https://github.com/apimatic"}, {"type"=>"x-pricing", "url"=>"https://apimatic.io/pricing"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/apimatic"}, {"type"=>"x-website", "url"=>"http://apimatic.io"}, {"type"=>"x-website", "url"=>"https://www.apimatic.io/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
emuseum-api-docs{"apis"=>{"name"=>"eMuseum API docs", "x-slug"=>"emuseum-api-docs", "description"=>"Developed in partnership with museums, The Museum System makes capturing, managing and accessing collection information quick and easy. eMuseum is a web-based software program that integrates seamlessly with TMS and other collection management systems to dynamically publish information to your website, Intranet, and kiosks. This API delivers search information and images from TMS & eMuseum to GSA.gov.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/eMuseum5_Blog.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Provider,Federal Government GSA,General Data,Profiles", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"emuseum-api-docs/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"eMuseum API", "x-api-slug"=>"emuseum-api", "description"=>"Developed in partnership with museums, The Museum System makes capturing, managing and accessing collection information quick and easy. eMuseum is a web-based software program that integrates seamlessly with TMS and other collection management systems to dynamically publish information to your website, Intranet, and kiosks. This API delivers search information and images from TMS & eMuseum to GSA.gov.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/eMuseum5_Blog.jpg", "humanURL"=>"http://gsa.github.io/eMuseum-API/", "baseURL"=>"https://gsafinearts.pbs.gsa.gov//emuseum/api", "tags"=>"API Provider,Federal Government GSA,General Data,Profiles", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/emuseum-api-docs/searchobjects-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/emuseum-api-docs/emuseum-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-issues-page", "url"=>"https://github.com/GSA/eMuseum-API/issues"}, {"type"=>"x-website", "url"=>"http://gsa.github.io/eMuseum-API/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "emuseum-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"eMuseum API docs", "x-complete"=>1, "info"=>{"title"=>"eMuseum API", "description"=>"developed-in-partnership-with-museums-the-museum-system-makes-capturing-managing-and-accessing-collection-information-quick-and-easy--emuseum-is-a-webbased-software-program-that-integrates-seamlessly-with-tms-and-other-collection-management-systems-to-dynamically-publish-information-to-your-website-intranet-and-kiosks--this-api-delivers-search-information-and-images-from-tms-emuseum-to-gsa-gov-", "version"=>"1.0.0"}, "host"=>"gsafinearts.pbs.gsa.gov", "basePath"=>"/emuseum/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/search/people"=>{"get"=>{"summary"=>"Artists", "description"=>"Search for an artist", "operationId"=>"searchArtists", "x-api-path-slug"=>"searchpeople-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Artists"]}}, "/id/people/{id}"=>{"get"=>{"summary"=>"Artist", "description"=>"Request an artist", "operationId"=>"getArtist", "x-api-path-slug"=>"idpeopleid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Artists"]}}, "/id/objects/{id}"=>{"get"=>{"summary"=>"Art", "description"=>"Get Art", "operationId"=>"getArt", "x-api-path-slug"=>"idobjectsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art"]}}, "/collections/all"=>{"get"=>{"summary"=>"Collections", "description"=>"Get Collections", "operationId"=>"getCollections", "x-api-path-slug"=>"collectionsall-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collections"]}}, "/collections/{id}"=>{"get"=>{"summary"=>"Collections", "description"=>"Get Collection", "operationId"=>"getCollection", "x-api-path-slug"=>"collectionsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collections"]}}, "/search/buildings"=>{"get"=>{"summary"=>"Buildings", "description"=>"Search for art by building", "operationId"=>"searchBuildings", "x-api-path-slug"=>"searchbuildings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buildings"]}}, "/id/buildings/{id}"=>{"get"=>{"summary"=>"Building", "description"=>"Get Art By Building", "operationId"=>"getBuilding", "x-api-path-slug"=>"idbuildingsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buildings"]}}, "/search/objects"=>{"get"=>{"summary"=>"Art", "description"=>"Seart for art by object", "operationId"=>"searchARt", "x-api-path-slug"=>"searchobjects-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-dataproc{"google-cloud-dataproc-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Dataproc", "x-complete"=>1, "info"=>{"title"=>"Google Cloud Dataproc", "description"=>"manages-hadoopbased-clusters-and-jobs-on-google-cloud-platform-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"dataproc.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/projects/{projectId}/regions/{region}/clusters"=>{"get"=>{"summary"=>"Get Region Clusters", "description"=>"Lists all regions/{region}/clusters in a project.", "operationId"=>"dataproc.projects.regions.clusters.list", "x-api-path-slug"=>"v1projectsprojectidregionsregionclusters-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Optional A filter constraining the clusters to list"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Optional The standard List page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Optional The standard List page token"}, {"in"=>"path", "name"=>"projectId", "description"=>"Required The ID of the Google Cloud Platform project that the cluster belongs to"}, {"in"=>"path", "name"=>"region", "description"=>"Required The Cloud Dataproc region in which to handle the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster"]}, "post"=>{"summary"=>"Create Cluster", "description"=>"Creates a cluster in a project.", "operationId"=>"dataproc.projects.regions.clusters.create", "x-api-path-slug"=>"v1projectsprojectidregionsregionclusters-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"Required The ID of the Google Cloud Platform project that the cluster belongs to"}, {"in"=>"path", "name"=>"region", "description"=>"Required The Cloud Dataproc region in which to handle the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster"]}}, "/v1/projects/{projectId}/regions/{region}/clusters/{clusterName}"=>{"delete"=>{"summary"=>"Delete Cluster", "description"=>"Deletes a cluster in a project.", "operationId"=>"dataproc.projects.regions.clusters.delete", "x-api-path-slug"=>"v1projectsprojectidregionsregionclustersclustername-delete", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"Required The cluster name"}, {"in"=>"path", "name"=>"projectId", "description"=>"Required The ID of the Google Cloud Platform project that the cluster belongs to"}, {"in"=>"path", "name"=>"region", "description"=>"Required The Cloud Dataproc region in which to handle the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster"]}, "get"=>{"summary"=>"Get Cluster", "description"=>"Gets the resource representation for a cluster in a project.", "operationId"=>"dataproc.projects.regions.clusters.get", "x-api-path-slug"=>"v1projectsprojectidregionsregionclustersclustername-get", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"Required The cluster name"}, {"in"=>"path", "name"=>"projectId", "description"=>"Required The ID of the Google Cloud Platform project that the cluster belongs to"}, {"in"=>"path", "name"=>"region", "description"=>"Required The Cloud Dataproc region in which to handle the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster"]}, "patch"=>{"summary"=>"Update Cluster", "description"=>"Updates a cluster in a project.", "operationId"=>"dataproc.projects.regions.clusters.patch", "x-api-path-slug"=>"v1projectsprojectidregionsregionclustersclustername-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"clusterName", "description"=>"Required The cluster name"}, {"in"=>"path", "name"=>"projectId", "description"=>"Required The ID of the Google Cloud Platform project the cluster belongs to"}, {"in"=>"path", "name"=>"region", "description"=>"Required The Cloud Dataproc region in which to handle the request"}, {"in"=>"query", "name"=>"updateMask", "description"=>"Required Specifies the path, relative to Cluster, of the field to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster"]}}, "/v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose"=>{"post"=>{"summary"=>"Get Cluster Diagnostic", "description"=>"Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.", "operationId"=>"dataproc.projects.regions.clusters.diagnose", "x-api-path-slug"=>"v1projectsprojectidregionsregionclustersclusternamediagnose-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"clusterName", "description"=>"Required The cluster name"}, {"in"=>"path", "name"=>"projectId", "description"=>"Required The ID of the Google Cloud Platform project that the cluster belongs to"}, {"in"=>"path", "name"=>"region", "description"=>"Required The Cloud Dataproc region in which to handle the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster"]}}, "/v1/projects/{projectId}/regions/{region}/jobs"=>{"get"=>{"summary"=>"Get Region Jobs", "description"=>"Lists regions/{region}/jobs in a project.", "operationId"=>"dataproc.projects.regions.jobs.list", "x-api-path-slug"=>"v1projectsprojectidregionsregionjobs-get", "parameters"=>[{"in"=>"query", "name"=>"clusterName", "description"=>"Optional If set, the returned jobs list includes only jobs that were submitted to the named cluster"}, {"in"=>"query", "name"=>"filter", "description"=>"Optional A filter constraining the jobs to list"}, {"in"=>"query", "name"=>"jobStateMatcher", "description"=>"Optional Specifies enumerated categories of jobs to list (default = match ALL jobs)"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Optional The number of results to return in each response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Optional The page token, returned by a previous call, to request the next page of results"}, {"in"=>"path", "name"=>"projectId", "description"=>"Required The ID of the Google Cloud Platform project that the job belongs to"}, {"in"=>"path", "name"=>"region", "description"=>"Required The Cloud Dataproc region in which to handle the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/v1/projects/{projectId}/regions/{region}/jobs/{jobId}"=>{"delete"=>{"summary"=>"Delete Job", "description"=>"Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.", "operationId"=>"dataproc.projects.regions.jobs.delete", "x-api-path-slug"=>"v1projectsprojectidregionsregionjobsjobid-delete", "parameters"=>[{"in"=>"path", "name"=>"jobId", "description"=>"Required The job ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"Required The ID of the Google Cloud Platform project that the job belongs to"}, {"in"=>"path", "name"=>"region", "description"=>"Required The Cloud Dataproc region in which to handle the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}, "get"=>{"summary"=>"Get Job", "description"=>"Gets the resource representation for a job in a project.", "operationId"=>"dataproc.projects.regions.jobs.get", "x-api-path-slug"=>"v1projectsprojectidregionsregionjobsjobid-get", "parameters"=>[{"in"=>"path", "name"=>"jobId", "description"=>"Required The job ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"Required The ID of the Google Cloud Platform project that the job belongs to"}, {"in"=>"path", "name"=>"region", "description"=>"Required The Cloud Dataproc region in which to handle the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}, "patch"=>{"summary"=>"Update Job", "description"=>"Updates a job in a project.", "operationId"=>"dataproc.projects.regions.jobs.patch", "x-api-path-slug"=>"v1projectsprojectidregionsregionjobsjobid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"jobId", "description"=>"Required The job ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"Required The ID of the Google Cloud Platform project that the job belongs to"}, {"in"=>"path", "name"=>"region", "description"=>"Required The Cloud Dataproc region in which to handle the request"}, {"in"=>"query", "name"=>"updateMask", "description"=>"Required Specifies the path, relative to Job, of the field to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel"=>{"post"=>{"summary"=>"Cancel Job", "description"=>"Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.", "operationId"=>"dataproc.projects.regions.jobs.cancel", "x-api-path-slug"=>"v1projectsprojectidregionsregionjobsjobidcancel-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"jobId", "description"=>"Required The job ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"Required The ID of the Google Cloud Platform project that the job belongs to"}, {"in"=>"path", "name"=>"region", "description"=>"Required The Cloud Dataproc region in which to handle the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/v1/projects/{projectId}/regions/{region}/jobs:submit"=>{"post"=>{"summary"=>"Submit Job", "description"=>"Submits a job to a cluster.", "operationId"=>"dataproc.projects.regions.jobs.submit", "x-api-path-slug"=>"v1projectsprojectidregionsregionjobssubmit-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"Required The ID of the Google Cloud Platform project that the job belongs to"}, {"in"=>"path", "name"=>"region", "description"=>"Required The Cloud Dataproc region in which to handle the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/v1/{name}"=>{"delete"=>{"summary"=>"Delete Operation", "description"=>"Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.", "operationId"=>"dataproc.projects.regions.operations.delete", "x-api-path-slug"=>"v1name-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the operation resource to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}, "get"=>{"summary"=>"Get Operation State", "description"=>"Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "operationId"=>"dataproc.projects.regions.operations.get", "x-api-path-slug"=>"v1name-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the operation resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1/{name}:cancel"=>{"post"=>{"summary"=>"Start Cancellation", "description"=>"Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.", "operationId"=>"dataproc.projects.regions.operations.cancel", "x-api-path-slug"=>"v1namecancel-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the operation resource to be cancelled"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}}}, "apis"=>{"name"=>"Google Cloud Dataproc", "x-slug"=>"google-cloud-dataproc", "description"=>"Use Google Cloud Dataproc, an Apache Hadoop, Apache Spark, Apache Pig, and Apache Hive service, to easily process big datasets at low cost. Control your costs by quickly creating managed clusters of any size and turning them off when youre done. Cloud Dataproc integrates across Google Cloud Platform products, giving you a powerful and complete data processing platform.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/dataproc.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Data,Databases,Deployments,Google APIs,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-dataproc/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Dataproc API", "x-api-slug"=>"google-cloud-dataproc-api", "description"=>"Use Google Cloud Dataproc, an Apache Hadoop, Apache Spark, Apache Pig, and Apache Hive service, to easily process big datasets at low cost. Control your costs by quickly creating managed clusters of any size and turning them off when youre done. Cloud Dataproc integrates across Google Cloud Platform products, giving you a powerful and complete data processing platform.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/dataproc.png", "humanURL"=>"https://cloud.google.com/dataproc/", "baseURL"=>"://dataproc.googleapis.com//", "tags"=>"API Provider,API Service Provider,Data,Databases,Deployments,Google APIs,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-dataproc/google-cloud-dataproc-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-logs", "url"=>"https://cloud.google.com/dataproc/docs/release-notes/service"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/dataproc/docs/"}, {"type"=>"x-faq", "url"=>"https://cloud.google.com/dataproc/docs/resources/faq"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/dataproc/docs/quickstarts"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/dataproc/docs/how-to"}, {"type"=>"x-partners", "url"=>"https://cloud.google.com/dataproc/docs/resources/partners"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/dataproc/docs/resources/pricing"}, {"type"=>"x-rate-limits", "url"=>"https://cloud.google.com/dataproc/quotas"}, {"type"=>"x-sdk", "url"=>"https://cloud.google.com/dataproc/docs/gcloud-installation"}, {"type"=>"x-service-level-agreements", "url"=>"https://cloud.google.com/dataproc/docs/resources/sla"}, {"type"=>"x-support", "url"=>"https://cloud.google.com/dataproc/docs/support/get-support"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/dataproc/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
uber{"uber-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Uber", "x-complete"=>1, "info"=>{"title"=>"Uber", "description"=>"using-the-uber-api-developers-can-integrate-the-power-of-uber-into-3rd-party-applications--calls-to-the-api-can-be-made-to-request-information-on-available-car-types-driver-location-expressed-in-geocoordinates-time-estimates-estimated-prices-including-currency-conversion-when-applicable-as-well-as-user-account-history-and-activity--the-uber-api-documentation-describes-deep-linking-techniques-to-programmatically-launch-the-native-app-from-ios-or-android-or-the-uber-mobile-site-from-mobile-web--the-api-comes-with-a-detailed-style-guide-and-asset-package-for-implementing-licensed-brandings--the-uber-api-affiliate-program-grants-cash-and-issues-uber-credits-for-new-user-onboarding-through-a-3rd-party-app-", "version"=>"1.0.0"}, "host"=>"api.uber.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/products"=>{"get"=>{"summary"=>"Product Types", "description"=>"The Products endpoint returns information about the Uber products offered at a given location. The response includes the display name and other details about each product, and lists the products in the proper display order.", "operationId"=>"the-products-endpoint-returns-information-about-the-uber-products-offered-at-a-given-location-the-re", "x-api-path-slug"=>"products-get", "parameters"=>[{"in"=>"query", "name"=>"latitude", "description"=>"Latitude component of location"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude component of location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transportation"]}}, "/estimates/price"=>{"get"=>{"summary"=>"Price Estimates", "description"=>"The Price Estimates endpoint returns an estimated price range for each product offered at a given location. The price estimate is provided as a formatted string with the full price range and the localized currency symbol. The response also includes low and high estimates, and the [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code for situations requiring currency conversion. When surge is active for a particular product, its surge_multiplier will be greater than 1, but the price estimate already factors in this multiplier.", "operationId"=>"the-price-estimates-endpoint-returns-an-estimated-price-range-for-each-product-offered-at-a-given-lo", "x-api-path-slug"=>"estimatesprice-get", "parameters"=>[{"in"=>"query", "name"=>"end_latitude", "description"=>"Latitude component of end location"}, {"in"=>"query", "name"=>"end_longitude", "description"=>"Longitude component of end location"}, {"in"=>"query", "name"=>"start_latitude", "description"=>"Latitude component of start location"}, {"in"=>"query", "name"=>"start_longitude", "description"=>"Longitude component of start location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transportation"]}}, "/estimates/time"=>{"get"=>{"summary"=>"Time Estimates", "description"=>"The Time Estimates endpoint returns ETAs for all products offered at a given location, with the responses expressed as integers in seconds. We recommend that this endpoint be called every minute to provide the most accurate, up-to-date ETAs.", "operationId"=>"the-time-estimates-endpoint-returns-etas-for-all-products-offered-at-a-given-location-with-the-respo", "x-api-path-slug"=>"estimatestime-get", "parameters"=>[{"in"=>"query", "name"=>"customer_uuid", "description"=>"Unique customer identifier to be used for experience customization"}, {"in"=>"query", "name"=>"product_id", "description"=>"Unique identifier representing a specific product for a given latitude & longitude"}, {"in"=>"query", "name"=>"start_latitude", "description"=>"Latitude component of start location"}, {"in"=>"query", "name"=>"start_longitude", "description"=>"Longitude component of start location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transportation"]}}, "/me"=>{"get"=>{"summary"=>"User Profile", "description"=>"The User Profile endpoint returns information about the Uber user that has authorized with the application.", "operationId"=>"the-user-profile-endpoint-returns-information-about-the-uber-user-that-has-authorized-with-the-appli", "x-api-path-slug"=>"me-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transportation"]}}, "/history"=>{"get"=>{"summary"=>"User Activity", "description"=>"The User Activity endpoint returns data about a user's lifetime activity with Uber. The response will include pickup locations and times, dropoff locations and times, the distance of past requests, and information about which products were requested. The history array in the response will have a maximum length based on the limit parameter. The response value count may exceed limit, therefore subsequent API requests may be necessary.", "operationId"=>"the-user-activity-endpoint-returns-data-about-a-users-lifetime-activity-with-uber-the-response-will-", "x-api-path-slug"=>"history-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Number of items to retrieve"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset the list of returned results by this amount"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transportation"]}}}}, "apis"=>{"name"=>"Uber", "x-slug"=>"uber", "description"=>"The Uber API exposes a set of RESTful endpoints that enable your application to GET information such as time and price estimates about the products offered in a given location, request rides on behalf of authenticated users, and create ride reminders for users to take a ride at a specific time in the future.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11277-uber.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"1255", "tags"=>"API LIfeyclessss,Automobile,Autos,Cars,internet,Marketplace,Mobile,Profiles,Relative Data,Relative StreamRank,Service API,Stack,Stack Network,Streams,Streams,Streams,Taxis,Technology,Transportation,Transportation,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"uber/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Uber", "x-api-slug"=>"uber", "description"=>"The Uber API exposes a set of RESTful endpoints that enable your application to GET information such as time and price estimates about the products offered in a given location, request rides on behalf of authenticated users, and create ride reminders for users to take a ride at a specific time in the future.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11277-uber.jpg", "humanURL"=>"https://uber.com", "baseURL"=>"https://api.uber.com//v1", "tags"=>"API LIfeyclessss,Automobile,Autos,Cars,internet,Marketplace,Mobile,Profiles,Relative Data,Relative StreamRank,Service API,Stack,Stack Network,Streams,Streams,Streams,Taxis,Technology,Transportation,Transportation,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/uber/history-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/uber/uber-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-api-json--authoritative", "url"=>"https://raw.githubusercontent.com/picsoung/apis.json/master/uber.json"}, {"type"=>"x-blog", "url"=>"https://medium.com/streamrblog"}, {"type"=>"x-blog", "url"=>"https://medium.com/@UberPubPolicy"}, {"type"=>"x-blog", "url"=>"https://devblog.uber.com/"}, {"type"=>"x-blog-rss", "url"=>"https://medium.com/feed/@UberPubPolicy"}, {"type"=>"x-blog-rss", "url"=>"https://devblog.uber.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/uber"}, {"type"=>"x-developer", "url"=>"https://developer.uber.com/"}, {"type"=>"x-email", "url"=>"change-dr@uber.com"}, {"type"=>"x-github", "url"=>"https://github.com/uber"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/uber-com/"}, {"type"=>"x-transparency-report", "url"=>"https://transparencyreport.uber.com/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/uber_api"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/UberPubPolicy"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Uber"}, {"type"=>"x-webhook", "url"=>"https://developer.uber.com/docs/riders/guides/webhooks"}, {"type"=>"x-website", "url"=>"https://uber.com"}, {"type"=>"x-website", "url"=>"http://medium.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
openstreetmap{"openstreetmap-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"OpenStreetMap", "x-complete"=>1, "info"=>{"title"=>"Open Street Map (OSM)", "description"=>"todo-add-description", "version"=>"1.0.0"}, "host"=>" http:", "basePath"=>"//nominatim.openstreetmap.org", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/lookup"=>{"get"=>{"summary"=>"OSM - Address lookup", "description"=>"[Full description of the service:](http://wiki.openstreetmap.org/wiki/Nominatim#Address_lookup)", "operationId"=>"LookupGet", "x-api-path-slug"=>"lookup-get", "parameters"=>[{"in"=>"query", "name"=>"format"}, {"in"=>"query", "name"=>"osm_ids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maps", "OSM", "Address", "Lookup"]}}, "/reverse"=>{"get"=>{"summary"=>"OSM - Reverse", "description"=>"[Full description of the service:](http://wiki.openstreetmap.org/wiki/Nominatim#Reverse_Geocoding)", "operationId"=>"ReverseGet", "x-api-path-slug"=>"reverse-get", "parameters"=>[{"in"=>"query", "name"=>"format"}, {"in"=>"query", "name"=>"lat"}, {"in"=>"query", "name"=>"lon"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maps", "OSM", "Reverse"]}}, "/search"=>{"get"=>{"summary"=>"OSM - Search", "description"=>"[Full documentation](http://wiki.openstreetmap.org/wiki/Nominatim#Search)", "operationId"=>"SearchGet", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"format"}, {"in"=>"query", "name"=>"q"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maps", "OSM", "Search"]}}}}, "apis"=>{"name"=>"OpenStreetMap", "x-slug"=>"openstreetmap", "description"=>"OpenStreetMap is the free wiki world map.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2017-openstreetmap.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"6266", "tags"=>"Geo,Maps,Maps,Meta,SaaS,Stack Network,Tags,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"openstreetmap/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"OpenStreetMap", "x-api-slug"=>"openstreetmap", "description"=>"OpenStreetMap is the free wiki world map.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2017-openstreetmap.jpg", "humanURL"=>"http://www.openstreetmap.org/", "baseURL"=>"https:// http:///nominatim.openstreetmap.org", "tags"=>"Geo,Maps,Maps,Meta,SaaS,Stack Network,Tags,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/openstreetmap/search-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/openstreetmap/openstreetmap-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api.openstreetmap.org/"}, {"type"=>"x-blog", "url"=>"http://blog.osmfoundation.org/"}, {"type"=>"x-blog-rss", "url"=>"https://blog.openstreetmap.org/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/openstreetmap-3"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/openstreetmap"}, {"type"=>"x-developer", "url"=>"http://wiki.openstreetmap.org/wiki/API"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/openstreetmap"}, {"type"=>"x-website", "url"=>"http://www.openstreetmap.org/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-event-hubs{"azure-event-hubs-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Event Hubs", "x-complete"=>1, "info"=>{"title"=>"EventHubManagementClient", "description"=>"azure-event-hubs-client", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/providers/Microsoft.EventHub/operations"=>{"get"=>{"summary"=>"Operations List", "description"=>"Lists all of the available Event Hub REST API operations.", "operationId"=>"Operations_List", "x-api-path-slug"=>"providersmicrosoft-eventhuboperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/CheckNameAvailability"=>{"post"=>{"summary"=>"Namespaces Check Name Availability", "description"=>"Check the give Namespace name availability.", "operationId"=>"Namespaces_CheckNameAvailability", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-eventhubchecknameavailability-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters to check availability of the given Namespace name", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Name Availability"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/namespaces"=>{"get"=>{"summary"=>"Namespaces List By Subscription", "description"=>"Lists all the available Namespaces within a subscription, irrespective of the resource groups.", "operationId"=>"Namespaces_ListBySubscription", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-eventhubnamespaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Subscription"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces"=>{"get"=>{"summary"=>"Namespaces List By Resource Group", "description"=>"Lists the available Namespaces within a resource group.", "operationId"=>"Namespaces_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Resource Group"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}"=>{"put"=>{"summary"=>"Namespaces Create Or Update", "description"=>"Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "operationId"=>"Namespaces_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacename-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters for creating a namespace resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces"]}, "delete"=>{"summary"=>"Namespaces Delete", "description"=>"Deletes an existing namespace. This operation also removes all associated resources under the namespace.", "operationId"=>"Namespaces_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacename-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces"]}, "get"=>{"summary"=>"Namespaces Get", "description"=>"Gets the description of the specified namespace.", "operationId"=>"Namespaces_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces"]}, "patch"=>{"summary"=>"Namespaces Update", "description"=>"Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "operationId"=>"Namespaces_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacename-patch", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters for updating a namespace resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/AuthorizationRules"=>{"get"=>{"summary"=>"Namespaces List Authorization Rules", "description"=>"Gets a list of authorization rules for a Namespace.", "operationId"=>"Namespaces_ListAuthorizationRules", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameauthorizationrules-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Authorization Rules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}"=>{"put"=>{"summary"=>"Namespaces Create Or Update Authorization Rule", "description"=>"Creates or updates an AuthorizationRule for a Namespace.", "operationId"=>"Namespaces_CreateOrUpdateAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameauthorizationrulesauthorizationrulename-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The shared access AuthorizationRule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Authorization Rule"]}, "delete"=>{"summary"=>"Namespaces Delete Authorization Rule", "description"=>"Deletes an AuthorizationRule for a Namespace.", "operationId"=>"Namespaces_DeleteAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameauthorizationrulesauthorizationrulename-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Authorization Rule"]}, "get"=>{"summary"=>"Namespaces Get Authorization Rule", "description"=>"Gets an AuthorizationRule for a Namespace by rule name.", "operationId"=>"Namespaces_GetAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameauthorizationrulesauthorizationrulename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Authorization Rule"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys"=>{"post"=>{"summary"=>"Namespaces List Keys", "description"=>"Gets the primary and secondary connection strings for the Namespace.", "operationId"=>"Namespaces_ListKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameauthorizationrulesauthorizationrulenamelistkeys-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys"=>{"post"=>{"summary"=>"Namespaces Regenerate Keys", "description"=>"Regenerates the primary or secondary connection strings for the specified Namespace.", "operationId"=>"Namespaces_RegenerateKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameauthorizationrulesauthorizationrulenameregeneratekeys-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters required to regenerate the connection string", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Regenerate Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs"=>{"get"=>{"summary"=>"Event Hubs List All", "description"=>"Gets all the Event Hubs in a Namespace.", "operationId"=>"EventHubs_ListAll", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameeventhubs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Hubs All"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}"=>{"put"=>{"summary"=>"Event Hubs Create Or Update", "description"=>"Creates or updates a new Event Hub as a nested resource within a Namespace.", "operationId"=>"EventHubs_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameeventhubseventhubname-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to create an Event Hub resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Hubs"]}, "delete"=>{"summary"=>"Event Hubs Delete", "description"=>"Deletes an Event Hub from the specified Namespace and resource group.", "operationId"=>"EventHubs_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameeventhubseventhubname-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Hubs"]}, "get"=>{"summary"=>"Event Hubs Get", "description"=>"Gets an Event Hubs description for the specified Event Hub.", "operationId"=>"EventHubs_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameeventhubseventhubname-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Hubs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules"=>{"get"=>{"summary"=>"Event Hubs List Authorization Rules", "description"=>"Gets the authorization rules for an Event Hub.", "operationId"=>"EventHubs_ListAuthorizationRules", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameeventhubseventhubnameauthorizationrules-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Hubs Authorization Rules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}"=>{"put"=>{"summary"=>"Event Hubs Create Or Update Authorization Rule", "description"=>"Creates or updates an AuthorizationRule for the specified Event Hub.", "operationId"=>"EventHubs_CreateOrUpdateAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameeventhubseventhubnameauthorizationrulesauthorizationrulename-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The shared access AuthorizationRule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Hubs Authorization Rule"]}, "get"=>{"summary"=>"Event Hubs Get Authorization Rule", "description"=>"Gets an AuthorizationRule for an Event Hub by rule name.", "operationId"=>"EventHubs_GetAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameeventhubseventhubnameauthorizationrulesauthorizationrulename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Hubs Authorization Rule"]}, "delete"=>{"summary"=>"Event Hubs Delete Authorization Rule", "description"=>"Deletes an Event Hub AuthorizationRule.", "operationId"=>"EventHubs_DeleteAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameeventhubseventhubnameauthorizationrulesauthorizationrulename-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Hubs Authorization Rule"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}/ListKeys"=>{"post"=>{"summary"=>"Event Hubs List Keys", "description"=>"Gets the ACS and SAS connection strings for the Event Hub.", "operationId"=>"EventHubs_ListKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameeventhubseventhubnameauthorizationrulesauthorizationrulenamelistkeys-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Hubs Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}/regenerateKeys"=>{"post"=>{"summary"=>"Event Hubs Regenerate Keys", "description"=>"Regenerates the ACS and SAS connection strings for the Event Hub.", "operationId"=>"EventHubs_RegenerateKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameeventhubseventhubnameauthorizationrulesauthorizationrulenameregeneratekeys-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to regenerate the AuthorizationRule Keys (PrimaryKey/SecondaryKey)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Hubs Regenerate Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}"=>{"put"=>{"summary"=>"Consumer Groups Create Or Update", "description"=>"Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.", "operationId"=>"ConsumerGroups_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameeventhubseventhubnameconsumergroupsconsumergroupname-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to create or update a consumer group resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Consumer Groups"]}, "delete"=>{"summary"=>"Consumer Groups Delete", "description"=>"Deletes a consumer group from the specified Event Hub and resource group.", "operationId"=>"ConsumerGroups_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameeventhubseventhubnameconsumergroupsconsumergroupname-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Consumer Groups"]}, "get"=>{"summary"=>"Consumer Groups Get", "description"=>"Gets a description for the specified consumer group.", "operationId"=>"ConsumerGroups_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameeventhubseventhubnameconsumergroupsconsumergroupname-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Consumer Groups"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups"=>{"get"=>{"summary"=>"Consumer Groups List All", "description"=>"Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.", "operationId"=>"ConsumerGroups_ListAll", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameeventhubseventhubnameconsumergroups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Consumer Groups All"]}}}}, "apis"=>{"name"=>"Azure Event Hubs", "x-slug"=>"azure-event-hubs", "description"=>"Azure Event Hubs is a hyper-scale telemetry ingestion service that collects, transforms, and stores millions of events. As a distributed streaming platform, it gives you low latency and configurable time retention, which enables you to ingress massive amounts of telemetry into the cloud and read the data from multiple applications using publish-subscribe semantics.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-event-hubs-stream.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Jobs,Microsoft,Orchestration,Profiles,Relative Data,SDIO Competition,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-event-hubs/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Event Hubs API", "x-api-slug"=>"azure-event-hubs-api", "description"=>"Azure Event Hubs is a hyper-scale telemetry ingestion service that collects, transforms, and stores millions of events. As a distributed streaming platform, it gives you low latency and configurable time retention, which enables you to ingress massive amounts of telemetry into the cloud and read the data from multiple applications using publish-subscribe semantics.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-event-hubs-stream.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/event-hubs/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Jobs,Microsoft,Orchestration,Profiles,Relative Data,SDIO Competition,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-event-hubs/subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-eventhubnamespacesnamespacenameeventhubseventhubnameconsumergroups-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-event-hubs/azure-event-hubs-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-hacker-news-search", "url"=>"Azure Event Hubs"}, {"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/event-hubs/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/event-hubs/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/event-hubs/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/event-hubs/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
epa-envirofacts{"epa-biennial-report-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"EPA Biennial Report API", "description"=>"the-biennial-report-is-a-national-system-that-collects-data-on-the-generation-management-and-minimization-of-hazardous-waste-", "contact"=>{"name"=>"EP Envirofacts", "url"=>"http://www.epa.gov/enviro/index.html"}, "version"=>"v1"}, "host"=>"iaspub.epa.gov", "basePath"=>"/enviro/efservice/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/BGM_OFFSITE_SHIPMENT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_BGM_Offsite_Shipment", "x-api-path-slug"=>"bgm-offsite-shipmentrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/BGM_ONSITE_TREATMENT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_BGM_Onsite_Shipment", "x-api-path-slug"=>"bgm-onsite-treatmentrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/BGM_WASTE_CODE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_BGM_WASTE_CODE", "x-api-path-slug"=>"bgm-waste-coderowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/BREPORT_CYCLE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_BREPORT_CYCLE", "x-api-path-slug"=>"breport-cyclerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/BWR_BASIC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_BWR_BASIC", "x-api-path-slug"=>"bwr-basicrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_BGM_BASIC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_BGM_BASIC", "x-api-path-slug"=>"rcr-bgm-basicrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_BWR_WASTE_CODE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_BWR_WASTE_CODE", "x-api-path-slug"=>"rcr-bwr-waste-coderowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_HHANDLER/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_HHANDLER", "x-api-path-slug"=>"rcr-hhandlerrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_LU_FORM_CODE2/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_LU_FORM_CODE2", "x-api-path-slug"=>"rcr-lu-form-code2rowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_LU_MANAGEMENT_METHOD/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_LU_MANAGEMENT_METHOD", "x-api-path-slug"=>"rcr-lu-management-methodrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_LU_SOURCE_CODE2/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_LU_SOURCE_CODE2", "x-api-path-slug"=>"rcr-lu-source-code2rowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_LU_WASTE_CODE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_LU_WASTE_CODE", "x-api-path-slug"=>"rcr-lu-waste-coderowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "epa-integrated-grants-management-system-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"EPA Integrated Grants Management System API", "description"=>"integrated-grants-management-system-provides-information-used-to-track-award-administer-and-monitor-grants-", "contact"=>{"name"=>"EP Envirofacts", "url"=>"http://www.epa.gov/enviro/index.html"}, "version"=>"v1"}, "host"=>"iaspub.epa.gov", "basePath"=>"/enviro/efservice/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/OGD_CFDA/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_OGD_CFDA", "x-api-path-slug"=>"ogd-cfdarowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/OGD_EF_GRANT_DRPT_CFDA/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_OGD_EF_GRANT_DRPT_CFDA", "x-api-path-slug"=>"ogd-ef-grant-drpt-cfdarowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/OGD_EF_GRANT_DRPT_SA/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_OGD_EF_GRANT_DRPT_SA", "x-api-path-slug"=>"ogd-ef-grant-drpt-sarowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/OGD_EF_GRANT_DTL_RPT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_OGD_EF_GRANT_DTL_RPT", "x-api-path-slug"=>"ogd-ef-grant-dtl-rptrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/OGD_EF_GRANT_SUM_RPT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_OGD_EF_GRANT_SUM_RPT", "x-api-path-slug"=>"ogd-ef-grant-sum-rptrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/OGD_STAT_AUTHORITY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_OGD_STAT_AUTHORITY", "x-api-path-slug"=>"ogd-stat-authorityrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "epa-facility-registry-system-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"EPA Facility Registry System API", "description"=>"the-facility-registry-system-provides-facility-identification-information-via-facility-linkages-across-several-program-systems-", "contact"=>{"name"=>"EP Envirofacts", "url"=>"http://www.epa.gov/enviro/index.html"}, "version"=>"v1"}, "host"=>"iaspub.epa.gov", "basePath"=>"/enviro/efservice/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/AA_CEMS_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_AA_CEMS_DETAILS", "x-api-path-slug"=>"aa-cems-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_AFFILIATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_AFFILIATION", "x-api-path-slug"=>"frs-affiliationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_AGENCY_REF/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_AGENCY_REF", "x-api-path-slug"=>"frs-agency-refrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_ALTERNATIVE_ID/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_ALTERNATIVE_ID", "x-api-path-slug"=>"frs-alternative-idrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_ALT_NAME/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_ALT_NAME", "x-api-path-slug"=>"frs-alt-namerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_CODE_DESCRIPTION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_CODE_DESCRIPTION", "x-api-path-slug"=>"frs-code-descriptionrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_CONTACT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_CONTACT", "x-api-path-slug"=>"frs-contactrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_FACILITY_SITE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_FACILITY_SITE", "x-api-path-slug"=>"frs-facility-siterowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_INTEREST/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_INTEREST", "x-api-path-slug"=>"frs-interestrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_INTEREST_REF/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_INTEREST_REF", "x-api-path-slug"=>"frs-interest-refrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_MAILING_ADDRESS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_MAILING_ADDRESS", "x-api-path-slug"=>"frs-mailing-addressrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_NAICS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_NAICS", "x-api-path-slug"=>"frs-naicsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_ORGANIZATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_ORGANIZATION", "x-api-path-slug"=>"frs-organizationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_PROGRAM_FACILITY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_PROGRAM_FACILITY", "x-api-path-slug"=>"frs-program-facilityrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_SIC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_SIC", "x-api-path-slug"=>"frs-sicrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_SUPPLEMENTAL_INTEREST/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_SUPPLEMENTAL_INTEREST", "x-api-path-slug"=>"frs-supplemental-interestrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_SYSTEM_REF/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_SYSTEM_REF", "x-api-path-slug"=>"frs-system-refrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_TRIBAL_ENTITY_REF/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_TRIBAL_ENTITY_REF", "x-api-path-slug"=>"frs-tribal-entity-refrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_TRIBAL_LAND_REF/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_TRIBAL_LAND_REF", "x-api-path-slug"=>"frs-tribal-land-refrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/G_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_G_INFO", "x-api-path-slug"=>"g-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "epa-locational-information-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"EPA Locational information API", "description"=>"locational-information-for-eparegulated-facilities-in-envirofacts-is-cultivated-from-many-sources-including-epa-federal-program-systems-epa-regional-offices-and-the-states-", "contact"=>{"name"=>"EP Envirofacts", "url"=>"http://www.epa.gov/enviro/index.html"}, "version"=>"v1"}, "host"=>"iaspub.epa.gov", "basePath"=>"/enviro/efservice/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/FRS_FACILITY_SITE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_FACILITY_SITE", "x-api-path-slug"=>"frs-facility-siterowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FRS_PROGRAM_FACILITY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FRS_PROGRAM_FACILITY", "x-api-path-slug"=>"frs-program-facilityrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GEO_ASSIGN_ACC_LK/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GEO_ASSIGN_ACC_LK", "x-api-path-slug"=>"geo-assign-acc-lkrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GEO_COLLECT_MTH_LK/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GEO_COLLECT_MTH_LK", "x-api-path-slug"=>"geo-collect-mth-lkrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GEO_CONVEYOR/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GEO_CONVEYOR", "x-api-path-slug"=>"geo-conveyorrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GEO_FACILITY_POINT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GEO_FACILITY_POINT", "x-api-path-slug"=>"geo-facility-pointrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GEO_GEOMETRIC_TYPE_LK/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GEO_GEOMETRIC_TYPE_LK", "x-api-path-slug"=>"geo-geometric-type-lkrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GEO_HORIZ_DATUM_LK/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GEO_HORIZ_DATUM_LK", "x-api-path-slug"=>"geo-horiz-datum-lkrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GEO_PHP_FACILITY_COORDINATE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GEO_PHP_FACILITY_COORDINATE", "x-api-path-slug"=>"geo-php-facility-coordinaterowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GEO_REF_POINT_LK/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GEO_REF_POINT_LK", "x-api-path-slug"=>"geo-ref-point-lkrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GEO_SOURCE_LK/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GEO_SOURCE_LK", "x-api-path-slug"=>"geo-source-lkrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GEO_SUB_ID_REF/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GEO_SUB_ID_REF", "x-api-path-slug"=>"geo-sub-id-refrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GEO_SUB_TYPE_LK/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GEO_SUB_TYPE_LK", "x-api-path-slug"=>"geo-sub-type-lkrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GEO_VERIFY_LK/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GEO_VERIFY_LK", "x-api-path-slug"=>"geo-verify-lkrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GEO_VERT_DATUM_LK/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GEO_VERT_DATUM_LK", "x-api-path-slug"=>"geo-vert-datum-lkrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GEO_VERT_METHOD_LK/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GEO_VERT_METHOD_LK", "x-api-path-slug"=>"geo-vert-method-lkrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/MV_GEO_FACILITY_POINT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_MV_GEO_FACILITY_POINT", "x-api-path-slug"=>"mv-geo-facility-pointrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/V_GEO_PGM_COORDINATE_ALL/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_V_GEO_PGM_COORDINATE_ALL", "x-api-path-slug"=>"v-geo-pgm-coordinate-allrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "epa-safe-drinking-water-information-system-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"EPA Safe Drinking Water Information System API", "description"=>"safe-drinking-water-information-system-provides-information-on-water-system-violations-of-epas-drinking-water-regulations-", "contact"=>{"name"=>"EP Envirofacts", "url"=>"http://www.epa.gov/enviro/index.html"}, "version"=>"v1"}, "host"=>"iaspub.epa.gov", "basePath"=>"/enviro/efservice/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/ENFORCEMENT_ACTION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_ENFORCEMENT_ACTION", "x-api-path-slug"=>"enforcement-actionrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GEOGRAPHIC_AREA/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GEOGRAPHIC_AREA", "x-api-path-slug"=>"geographic-arearowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/SERVICE_AREA/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_SERVICE_AREA", "x-api-path-slug"=>"service-arearowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/VIOLATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_VIOLATION", "x-api-path-slug"=>"violationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/VIOLATION_ENF_ASSOC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_VIOLATION_ENF_ASSOC", "x-api-path-slug"=>"violation-enf-assocrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/WATER_SYSTEM/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_WATER_SYSTEM", "x-api-path-slug"=>"water-systemrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/WATER_SYSTEM_FACILITY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_WATER_SYSTEM_FACILITY", "x-api-path-slug"=>"water-system-facilityrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "u-s--epa-enforcement-and-compliance-history-online-echo--resource-conservation-and-recovery-act--openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"U.S. EPA Enforcement and Compliance History Online (ECHO) - Resource Conservation and Recovery Act ", "description"=>"enforcement-and-compliance-history-online-echo-is-a-tool-developed-and-maintained-by-epas-office-of-enforcement-and-compliance-assurance-for-public-use--echo-provides-integrated-compliance-and-enforcement-information-for-about-800000-regulated-facilities-nationwide-brbrrcra-rest-services-provides-multiple-service-endpoints-each-with-specific-capabilities-to-search-and-retrieve-data-on-hazardous-waste-handlersfacilities-regulated-under-the-resource-conservation-and-recovery-act-rcra----the-returned-results-reflect-data-drawn-from-epas-rcrainfo-database-brbrthe-get-facilities-get-map-get-qid-and-get-download-end-points-are-meant-to-be-used-together-while-the-enhanced-get-facility-info-end-point-is-self-contained---the-get-facility-info-end-point-returns-either-an-array-of-state-county-or-zip-clusters-with-summary-statistics-per-cluster-or-an-array-of-facilities-brbrthe-recommended-use-scenario-for-get-facilities-get-qid-get-map-and-get-downoad-isbrbrb1bnbsp-use-get-facilities-to-validate-passed-query-parameters-obtain-summary-statistics-and-to-obtain-a-query-id-qid---qids-are-time-sensitive-and-will-be-valid-for-approximately-30-minutes-brb2bnbsp-use-get-qid-with-the-returned-qid-to-paginate-through-arrays-of-facility-results-brb3bnbsp-use-get-map-with-the-returned-qid-to-zoom-inout-and-pan-on-the-clustered-and-individual-facility-coordinates-that-meet-the-qid-query-criteria-brb4bnbsp-use-get-download-with-the-returned-qid-to-generate-a-comma-separated-value-csv-file-of-facility-information-that-meets-the-qid-query-criteria-brbruse-the-qcolumns-parameter-to-customize-your-search-results---use-the-metdata-service-endpoint-for-a-list-of-available-output-objects-their-column-ids-and-their-definitions-to-help-you-build-your-customized-output--brbradditional-echo-resourcesnbspnbsp-a-hrefhttpsecho-epa-govtoolswebservicesweb-servicesa-a-hrefhttpsecho-epa-govresourcesechodataaboutthedataabout-echos-dataa-a-hrefhttpsecho-epa-govtoolsdatadownloadsdata-downloadsabr", "contact"=>{"name"=>"US EPA, OECA Integration, Targeting and Access Branch"}, "version"=>"0.0.0"}, "host"=>"ofmpub.epa.gov", "basePath"=>"/echo", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/rcra_rest_services.get_download"=>{"get"=>{"summary"=>"Resource Conservation and Recovery Act (RCRA) Download Data Service", "description"=>"Based on the QID obtained from a get_facilities or get_facility_info query, return a comma sepated vaule (CSV) file of the facilities found.", "operationId"=>"based-on-the-qid-obtained-from-a-get-facilities-or-get-facility-info-query-return-a-comma-sepated-va", "x-api-path-slug"=>"rcra-rest-services-get-download-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Resource", "Conservation", "Recovery", "Act", "(RCRA)", "Download", "Data", "Service"]}}, "/rcra_rest_services.get_facilities"=>{"get"=>{"summary"=>"Resource Conservation and Recovery Act (RCRA) Facility Search Service", "description"=>"Validates query search parameters and returns query identifier. Use the responseset parameter to set the page size", "operationId"=>"validates-query-search-parameters-and-returns-query-identifier---use-the-responseset-parameter-to-se", "x-api-path-slug"=>"rcra-rest-services-get-facilities-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Resource", "Conservation", "Recovery", "Act", "(RCRA)", "Facility", "Search", "Service"]}}, "/rcra_rest_services.get_facility_info"=>{"get"=>{"summary"=>"Resource Conservation and Recovery Act (RCRA) Facility Enhanced Search Service", "description"=>"Returns either an array of Facilities or an array of Clusters that meet the specified search criteria.", "operationId"=>"returns-either-an-array-of-facilities-or-an-array-of-clusters-that-meet-the-specified-search-criteri", "x-api-path-slug"=>"rcra-rest-services-get-facility-info-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Resource", "Conservation", "Recovery", "Act", "(RCRA)", "Facility", "Enhanced", "Search", "Service"]}}, "/rcra_rest_services.get_geojson"=>{"get"=>{"summary"=>"Resource Conservation and Recovery Act (RCRA) GeoJSON Service", "description"=>"Based on the QID obtained from a get_facilities or get_facility_info query, return GeoJSON of the facilities found.", "operationId"=>"based-on-the-qid-obtained-from-a-get-facilities-or-get-facility-info-query-return-geojson-of-the-fac", "x-api-path-slug"=>"rcra-rest-services-get-geojson-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Resource", "Conservation", "Recovery", "Act", "(RCRA)", "GeoJSON", "Service"]}}, "/rcra_rest_services.get_info_clusters"=>{"get"=>{"summary"=>"Resource Conservation and Recovery Act (RCRA) Info Clusters Service", "description"=>"Based on the QID obtained from a clustered get_facility_info query, download cluster facility information as either a CSV or GEOJSON file.", "operationId"=>"based-on-the-qid-obtained-from-a-clustered-get-facility-info-query-download-cluster-facility-informa", "x-api-path-slug"=>"rcra-rest-services-get-info-clusters-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Resource", "Conservation", "Recovery", "Act", "(RCRA)", "Info", "Clusters", "Service"]}}, "/rcra_rest_services.get_map"=>{"get"=>{"summary"=>"Resource Conservation and Recovery Act (RCRA) Map Service", "description"=>"The purpose of the GET_MAP service is to display facility coordinates and facility clusters related to a get_facilities facility query. Currently, the maximum number of coordinates returned is 500. GET_MAP performs automatic clustering at the state, county, and zip code levels to maximize the number of coordinates returned.", "operationId"=>"the-purpose-of-the-get-map-service-is-to-display-facility-coordinates-and-facility-clusters-related-", "x-api-path-slug"=>"rcra-rest-services-get-map-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Resource", "Conservation", "Recovery", "Act", "(RCRA)", "Map", "Service"]}}, "/rcra_rest_services.get_qid"=>{"get"=>{"summary"=>"Resource Conservation and Recovery Act (RCRA) Paginated Results Service", "description"=>"GET_QID is passed with a query ID corresponding to a previously run get_facilities query. It then returns a Facility object containing all matching facilities. The main purpose of GET_QID is for large querysets that contain multiple pages (responsesets) of output. GET_QID allows for pagination and for the selection and sorting of columns.", "operationId"=>"get-qid-is-passed-with-a-query-id-corresponding-to-a-previously-run-get-facilities-query--it-then-re", "x-api-path-slug"=>"rcra-rest-services-get-qid-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Resource", "Conservation", "Recovery", "Act", "(RCRA)", "Paginated", "Results", "Service"]}}, "/rcra_rest_services.metadata"=>{"get"=>{"summary"=>"Resource Conservation and Recovery Act (RCRA) Metadata Service", "description"=>"Returns the JSON Object Name and ColumnId for usage with the qcolumns parameter for get_qid, get_facility_info and other service endpoints.", "operationId"=>"returns-the-json-object-name-and-columnid-for-usage-with-the-qcolumns-parameter-for-get-qid-get-faci", "x-api-path-slug"=>"rcra-rest-services-metadata-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Resource", "Conservation", "Recovery", "Act", "(RCRA)", "Metadata", "Service"]}}}}, "u-s--epa-enforcement-and-compliance-history-online-echo--safe-drinking-water-act-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"U.S. EPA Enforcement and Compliance History Online (ECHO) - Safe Drinking Water Act", "description"=>"enforcement-and-compliance-history-online-echo-is-a-tool-developed-and-maintained-by-epas-office-of-enforcement-and-compliance-assurance-for-public-use--echo-provides-integrated-compliance-and-enforcement-information-for-about-800000-regulated-facilities-nationwide-brbrsdw-rest-services-provides-multiple-service-endpoints-each-with-specific-capabilities-to-search-and-retrieve-data-on-public-water-systems-regulated-under-the-safe-drinking-water-act-sdwa--the-returned-results-reflect-data-drawn-from-epas-federal-safe-drinking-water-information-system-sdwis-database-brbrthe-get-systems-get-qid-and-get-download-end-points-are-meant-to-be-used-together-brbrthe-recommended-use-scenario-for-get-systems-get-qid-and-get-downoad-isbrbrb1bnbsp-use-get-systems-to-validate-passed-query-parameters-obtain-summary-statistics-and-to-obtain-a-query-id-qid---qids-are-time-sensitive-and-will-be-valid-for-approximately-30-minutes-brb2bnbsp-use-get-qid-with-the-returned-qid-to-paginate-through-arrays-of-water-system-results-brb3bnbsp-use-get-download-with-the-returned-qid-to-generate-a-comma-separated-value-csv-file-of-water-system-information-that-meets-the-qid-query-criteria-brbruse-the-qcolumns-parameter-to-customize-your-search-results---use-the-metdata-service-endpoint-for-a-list-of-available-output-objects-their-column-ids-and-their-definitions-to-help-you-build-your-customized-output--brbradditional-echo-resourcesnbspnbsp-a-hrefhttpsecho-epa-govtoolswebservicesweb-servicesa-a-hrefhttpsecho-epa-govresourcesechodataaboutthedataabout-echos-dataa-a-hrefhttpsecho-epa-govtoolsdatadownloadsdata-downloadsabr", "contact"=>{"name"=>"US EPA, OECA Integration, Targeting and Access Branch"}, "version"=>"0.0.0"}, "host"=>"ofmpub.epa.gov", "basePath"=>"/echo", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/sdw_rest_services.get_download"=>{"get"=>{"summary"=>"Safe Drinking Water Act (SDWA) Download Data Service", "description"=>"Based on the QID obtained from a get_systems query, return a comma sepated vaule (CSV) file of the water systems found.", "operationId"=>"based-on-the-qid-obtained-from-a-get-systems-query-return-a-comma-sepated-vaule-csv-file-of-the-wate", "x-api-path-slug"=>"sdw-rest-services-get-download-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Safe", "Drinking", "Water", "Act", "(SDWA)", "Download", "Data", "Service"]}}, "/sdw_rest_services.get_qid"=>{"get"=>{"summary"=>"Safe Drinking Water Act (SDWA) Paginated Results Service", "description"=>"GET_QID is passed with a query ID corresponding to a previously run get_systems query. It then returns a Systems object containing all matching water systems. The main purpose of GET_QID is for large querysets that contain multiple pages (responsesets) of output. GET_QID allows for pagination and for the selection and sorting of columns.", "operationId"=>"get-qid-is-passed-with-a-query-id-corresponding-to-a-previously-run-get-systems-query--it-then-retur", "x-api-path-slug"=>"sdw-rest-services-get-qid-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Safe", "Drinking", "Water", "Act", "(SDWA)", "Paginated", "Results", "Service"]}}, "/sdw_rest_services.get_systems"=>{"get"=>{"summary"=>"Safe Drinking Water Act (SDWA) Systems Search Service", "description"=>"Returns an array of public water systems that meet the specified search criteria.", "operationId"=>"returns-an-array-of-public-water-systems-that-meet-the-specified-search-criteria-", "x-api-path-slug"=>"sdw-rest-services-get-systems-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Safe", "Drinking", "Water", "Act", "(SDWA)", "Systems", "Search", "Service"]}}, "/sdw_rest_services.metadata"=>{"get"=>{"summary"=>"Safe Drinking Water Act (SDWA) Metadata Service", "description"=>"Returns the JSON Object Name and ColumnId for usage with the qcolumns parameter for get_systems endpoint.", "operationId"=>"returns-the-json-object-name-and-columnid-for-usage-with-the-qcolumns-parameter-for-get-systems-endp", "x-api-path-slug"=>"sdw-rest-services-metadata-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Safe", "Drinking", "Water", "Act", "(SDWA)", "Metadata", "Service"]}}}}, "epa-comprehensive-environmental-response-compensation-and-liability-information-system-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"EPA Comprehensive Environmental Response, Compensation, and Liability Information System API", "description"=>"the-comprehensive-environmental-response-compensation-and-liability-information-system-provides-information-about-superfund-cleaningremoval-of-hazardous-waste-sites-from-discovery-to-their-listing-on-the-national-priorities-list-", "contact"=>{"name"=>"EP Envirofacts", "url"=>"http://www.epa.gov/enviro/index.html"}, "version"=>"v1"}, "host"=>"iaspub.epa.gov", "basePath"=>"/enviro/efservice/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/CER_ACTION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_ACTION", "x-api-path-slug"=>"cer-actionrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_CMT_SITE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_CMT_SITE", "x-api-path-slug"=>"cer-cmt-siterowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_CMT_SITE_ALIAS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_CMT_SITE_ALIAS", "x-api-path-slug"=>"cer-cmt-site-aliasrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_CONTACT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_CONTACT", "x-api-path-slug"=>"cer-contactrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_FEDERAL_REGISTER/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_FEDERAL_REGISTER", "x-api-path-slug"=>"cer-federal-registerrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_FINANCIAL_TRANSACTION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_FINANCIAL_TRANSACTION", "x-api-path-slug"=>"cer-financial-transactionrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_LOCATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_LOCATION", "x-api-path-slug"=>"cer-locationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_OPERABLE_UNIT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_OPERABLE_UNIT", "x-api-path-slug"=>"cer-operable-unitrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_ACTION_ANOMALY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_ACTION_ANOMALY", "x-api-path-slug"=>"cer-ref-action-anomalyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_ACTION_CRITICAL_FLAG/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_ACTION_CRITICAL_FLAG", "x-api-path-slug"=>"cer-ref-action-critical-flagrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_ACTION_LEAD_TYPE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_ACTION_LEAD_TYPE", "x-api-path-slug"=>"cer-ref-action-lead-typerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_ACTION_QUALIFIER/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_ACTION_QUALIFIER", "x-api-path-slug"=>"cer-ref-action-qualifierrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_ACTION_TYPE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_ACTION_TYPE", "x-api-path-slug"=>"cer-ref-action-typerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_CMT_SITE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_CMT_SITE", "x-api-path-slug"=>"cer-ref-cmt-siterowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_FDRL_RGSTR_ACTN/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_FDRL_RGSTR_ACTN", "x-api-path-slug"=>"cer-ref-fdrl-rgstr-actnrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_FEDERAL_FACILITY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_FEDERAL_FACILITY", "x-api-path-slug"=>"cer-ref-federal-facilityrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_FINAN_TRANSACTION_TYPE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_FINAN_TRANSACTION_TYPE", "x-api-path-slug"=>"cer-ref-finan-transaction-typerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_NON_NPL_STATUS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_NON_NPL_STATUS", "x-api-path-slug"=>"cer-ref-non-npl-statusrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_NPL_STATUS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_NPL_STATUS", "x-api-path-slug"=>"cer-ref-npl-statusrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_OWNERSHIP_TYPE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_OWNERSHIP_TYPE", "x-api-path-slug"=>"cer-ref-ownership-typerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_PLANNING_STATUS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_PLANNING_STATUS", "x-api-path-slug"=>"cer-ref-planning-statusrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_REGION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_REGION", "x-api-path-slug"=>"cer-ref-regionrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_SIC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_SIC", "x-api-path-slug"=>"cer-ref-sicrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_SITE_INCIDENT_CATEGORY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_SITE_INCIDENT_CATEGORY", "x-api-path-slug"=>"cer-ref-site-incident-categoryrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_SITE_INCIDENT_TYPE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_SITE_INCIDENT_TYPE", "x-api-path-slug"=>"cer-ref-site-incident-typerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_REF_STATE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_REF_STATE", "x-api-path-slug"=>"cer-ref-staterowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_SITE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_SITE", "x-api-path-slug"=>"cer-siterowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_SITE_ALIAS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_SITE_ALIAS", "x-api-path-slug"=>"cer-site-aliasrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_SITE_ROT_REF/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_SITE_ROT_REF", "x-api-path-slug"=>"cer-site-rot-refrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_WSMC_CROSS_LINK/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_WSMC_CROSS_LINK", "x-api-path-slug"=>"cer-wsmc-cross-linkrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CER_WST_SRC_MEDIA_CONTAMINATED/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_CER_WST_SRC_MEDIA_CONTAMINATED", "x-api-path-slug"=>"cer-wst-src-media-contaminatedrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "u-s--epa-enforcement-and-compliance-history-online-echo--clean-water-act-cwa-rest-services-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"U.S. EPA Enforcement and Compliance History Online (ECHO) - Clean Water Act (CWA) Rest Services", "description"=>"enforcement-and-compliance-history-online-echo-is-a-tool-developed-and-maintained-by-epas-office-of-enforcement-and-compliance-assurance-for-public-use--echo-provides-integrated-compliance-and-enforcement-information-for-about-800000-regulated-facilities-nationwide-brbrcwa-rest-services-provides-multiple-service-endpoints-each-with-specific-capabilities-to-search-and-retrieve-data-on-facilities-regulated-under-the-clean-water-act-cwa-and-managed-under-the-national-pollutant-discharge-elimination-system-npdes-program--the-returned-results-reflect-data-drawn-from-epas-icisnpdes-database-brbrthe-get-facilities-get-map-get-qid-and-get-download-end-points-are-meant-to-be-used-together-while-the-enhanced-get-facility-info-end-point-is-self-contained---the-get-facility-info-end-point-returns-either-an-array-of-state-county-or-zip-clusters-with-summary-statistics-per-cluster-or-an-array-of-facilities-brbrthe-recommended-use-scenario-for-get-facilities-get-qid-get-map-and-get-downoad-isbrbrb1bnbsp-use-get-facilities-to-validate-passed-query-parameters-obtain-summary-statistics-and-to-obtain-a-query-id-qid---qids-are-time-sensitive-and-will-be-valid-for-approximately-30-minutes-brb2bnbsp-use-get-qid-with-the-returned-qid-to-paginate-through-arrays-of-facility-results-brb3bnbsp-use-get-map-with-the-returned-qid-to-zoom-inout-and-pan-on-the-clustered-and-individual-facility-coordinates-that-meet-the-qid-query-criteria-brb4bnbsp-use-get-download-with-the-returned-qid-to-generate-a-comma-separated-value-csv-file-of-facility-information-that-meets-the-qid-query-criteria-brbruse-the-qcolumns-parameter-to-customize-your-search-results---use-the-metdata-service-endpoint-for-a-list-of-available-output-objects-their-column-ids-and-their-definitions-to-help-you-build-your-customized-output--brbradditional-echo-resourcesnbspnbsp-a-hrefhttpsecho-epa-govtoolswebservicesweb-servicesa-a-hrefhttpsecho-epa-govresourcesechodataaboutthedataabout-echos-dataa-a-hrefhttpsecho-epa-govtoolsdatadownloadsdata-downloadsabr", "contact"=>{"name"=>"US EPA, OECA Integration, Targeting and Access Branch"}, "version"=>"0.0.0"}, "host"=>"ofmpub.epa.gov", "basePath"=>"/echo", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/cwa_rest_services.get_download"=>{"get"=>{"summary"=>"Clean Water Act (CWA) GeoJSON Service", "description"=>"Based on the QID obtained from a get_facilities or get_facility_info query, return GeoJSON of the facilities found.", "operationId"=>"based-on-the-qid-obtained-from-a-get-facilities-or-get-facility-info-query-return-geojson-of-the-fac", "x-api-path-slug"=>"cwa-rest-services-get-download-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}, {"in"=>"query", "name"=>"qcolumns", "description"=>"Used to cutomize service output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Clean", "Water", "Act", "(CWA)", "GeoJSON", "Service"]}}, "/cwa_rest_services.get_facilities"=>{"get"=>{"summary"=>"Clean Water Act (CWA) Facility Search Service", "description"=>"Validates query search parameters and returns query identifier. Use the responseset parameter to set the page size", "operationId"=>"validates-query-search-parameters-and-returns-query-identifier---use-the-responseset-parameter-to-se", "x-api-path-slug"=>"cwa-rest-services-get-facilities-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}, {"in"=>"query", "name"=>"qcolumns", "description"=>"Used to cutomize service output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Clean", "Water", "Act", "(CWA)", "Facility", "Search", "Service"]}}, "/cwa_rest_services.get_facility_info"=>{"get"=>{"summary"=>"Clean Water Act (CWA) Facility Enhanced Search Service", "description"=>"Returns either an array of Facilities or an array of Clusters that meet the specified search criteria.", "operationId"=>"returns-either-an-array-of-facilities-or-an-array-of-clusters-that-meet-the-specified-search-criteri", "x-api-path-slug"=>"cwa-rest-services-get-facility-info-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}, {"in"=>"query", "name"=>"qcolumns", "description"=>"Used to cutomize service output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Clean", "Water", "Act", "(CWA)", "Facility", "Enhanced", "Search", "Service"]}}, "/cwa_rest_services.get_geojson"=>{"get"=>{"summary"=>"Clean Water Act (CWA) Download Data Service", "description"=>"Based on the QID obtained from a get_facilities or get_facility_info query, return a comma sepated vaule (CSV) file of the facilities found.", "operationId"=>"based-on-the-qid-obtained-from-a-get-facilities-or-get-facility-info-query-return-a-comma-sepated-va", "x-api-path-slug"=>"cwa-rest-services-get-geojson-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}, {"in"=>"query", "name"=>"qcolumns", "description"=>"Used to cutomize service output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Clean", "Water", "Act", "(CWA)", "Download", "Data", "Service"]}}, "/cwa_rest_services.get_info_clusters"=>{"get"=>{"summary"=>"Clean Water Act (CWA) Info Clusters Service", "description"=>"Based on the QID obtained from a clustered get_facility_info query, download cluster facility information as either a CSV or GEOJSON file.", "operationId"=>"based-on-the-qid-obtained-from-a-clustered-get-facility-info-query-download-cluster-facility-informa", "x-api-path-slug"=>"cwa-rest-services-get-info-clusters-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Clean", "Water", "Act", "(CWA)", "Info", "Clusters", "Service"]}}, "/cwa_rest_services.get_map"=>{"get"=>{"summary"=>"Clean Water Act (CWA) Map Service", "description"=>"The purpose of the GET_MAP service is to display facility coordinates and facility clusters related to a get_facilities facility query. Currently, the maximum number of coordinates returned is 500. GET_MAP performs automatic clustering at the state, county, and zip code levels to maximize the number of coordinates returned.", "operationId"=>"the-purpose-of-the-get-map-service-is-to-display-facility-coordinates-and-facility-clusters-related-", "x-api-path-slug"=>"cwa-rest-services-get-map-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Clean", "Water", "Act", "(CWA)", "Map", "Service"]}}, "/cwa_rest_services.get_qid"=>{"get"=>{"summary"=>"Clean Water Act (CWA) Paginated Results Service", "description"=>"GET_QID is passed with a query ID corresponding to a previously run get_facilities query. It then returns a Facility object containing all matching facilities. The main purpose of GET_QID is for large querysets that contain multiple pages (responsesets) of output. GET_QID allows for pagination and for the selection and sorting of columns.", "operationId"=>"get-qid-is-passed-with-a-query-id-corresponding-to-a-previously-run-get-facilities-query--it-then-re", "x-api-path-slug"=>"cwa-rest-services-get-qid-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}, {"in"=>"query", "name"=>"qcolumns", "description"=>"Used to cutomize service output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Clean", "Water", "Act", "(CWA)", "Paginated", "Results", "Service"]}}, "/cwa_rest_services.metadata"=>{"get"=>{"summary"=>"Clean Water Act (CWA) Metadata Service", "description"=>"Returns the JSON Object Name and ColumnId for usage with the qcolumns parameter for get_qid, get_facility_info and other service endpoints.", "operationId"=>"returns-the-json-object-name-and-columnid-for-usage-with-the-qcolumns-parameter-for-get-qid-get-faci", "x-api-path-slug"=>"cwa-rest-services-metadata-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Clean", "Water", "Act", "(CWA)", "Metadata", "Service"]}}, "/rest_lookups.bp_tribes"=>{"get"=>{"summary"=>"ECHO BP Tribes Lookup Service", "description"=>"Returns the EPA Standard Indian Tribes and Native Alaskan Villages tribal_id and tribe_name.", "operationId"=>"returns-the-epa-standard-indian-tribes-and-native-alaskan-villages-tribal-id-and-tribe-name-", "x-api-path-slug"=>"rest-lookups-bp-tribes-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "ECHO", "BP", "Tribes", "Lookup", "Service"]}}, "/rest_lookups.cwa_parameters"=>{"get"=>{"summary"=>"ECHO CWA Parameter Lookup Service", "description"=>"Look up Clean Water Act parameter codes and descriptions in the Integrated Compliance Information System - National Pollutant Discharge Elimination System (ICIS-NPDES) by code or term.", "operationId"=>"look-up-clean-water-act-parameter-codes-and-descriptions-in-the-integrated-compliance-information-sy", "x-api-path-slug"=>"rest-lookups-cwa-parameters-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "ECHO", "CWA", "Parameter", "Lookup", "Service"]}}, "/rest_lookups.cwa_pollutants"=>{"get"=>{"summary"=>"ECHO CWA Pollutants Lookup Service", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"rest-lookups-cwa-pollutants-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "ECHO", "CWA", "Pollutants", "Lookup", "Service"]}}, "/rest_lookups.federal_agencies"=>{"get"=>{"summary"=>"ECHO Federal Agency Lookup Service", "description"=>"Look up Federal Agency Code", "operationId"=>"look-up-federal-agency-code", "x-api-path-slug"=>"rest-lookups-federal-agencies-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "ECHO", "Federal", "Agency", "Lookup", "Service"]}}, "/rest_lookups.icis_inspection_types"=>{"get"=>{"summary"=>"ECHO ICIS NPDES Inspection Types Lookup Service", "description"=>"Returns the ICIS NPDES Compliance Monitoring Type Code and Description.", "operationId"=>"returns-the-icis-npdes-compliance-monitoring-type-code-and-description-", "x-api-path-slug"=>"rest-lookups-icis-inspection-types-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "ECHO", "ICIS", "NPDES", "Inspection", "Types", "Lookup", "Service"]}}, "/rest_lookups.icis_law_sections"=>{"get"=>{"summary"=>"ECHO ICIS Law Sections Lookup Service", "description"=>"Returns the ICIS Law Section Descriptions.", "operationId"=>"returns-the-icis-law-section-descriptions-", "x-api-path-slug"=>"rest-lookups-icis-law-sections-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "ECHO", "ICIS", "Law", "Sections", "Lookup", "Service"]}}, "/rest_lookups.naics_codes"=>{"get"=>{"summary"=>"ECHO NAICS Codes Lookup Service", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"rest-lookups-naics-codes-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "ECHO", "NAICS", "Codes", "Lookup", "Service"]}}, "/rest_lookups.npdes_parameters"=>{"get"=>{"summary"=>"ECHO NPDES Parameters Lookup Service", "description"=>"ICIS Limit Parameter Code and Name lookup based on the supply of a partial parameter name. (NPDES = National Pollutant Discharge Elimination System)", "operationId"=>"icis-limit-parameter-code-and-name-lookup-based-on-the-supply-of-a-partial-parameter-name--npdes--na", "x-api-path-slug"=>"rest-lookups-npdes-parameters-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "ECHO", "NPDES", "Parameters", "Lookup", "Service"]}}, "/rest_lookups.wbd_code_lu"=>{"get"=>{"summary"=>"ECHO WBD Code Lookup Service", "description"=>"USGS Watershed Boundary Dataset (WBD) Name lookup based on a supplied WBD Code and Watershed Level", "operationId"=>"usgs-watershed-boundary-dataset-wbd-name-lookup-based-on-a-supplied-wbd-code-and-watershed-level", "x-api-path-slug"=>"rest-lookups-wbd-code-lu-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "ECHO", "WBD", "Code", "Lookup", "Service"]}}, "/rest_lookups.wbd_name_lu"=>{"get"=>{"summary"=>"ECHO WBD Name Lookup Service", "description"=>"USGS Watershed Boundary Dataset (WBD) Code lookup based on a supplied WBD Name and Watershed Level", "operationId"=>"usgs-watershed-boundary-dataset-wbd-code-lookup-based-on-a-supplied-wbd-name-and-watershed-level", "x-api-path-slug"=>"rest-lookups-wbd-name-lu-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "ECHO", "WBD", "Name", "Lookup", "Service"]}}}}, "u-s--epa-enforcement-and-compliance-history-online-echo--enforcement-case-search-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"U.S. EPA Enforcement and Compliance History Online (ECHO) - Enforcement Case Search", "description"=>"enforcement-and-compliance-history-online-echo-is-a-tool-developed-and-maintained-by-epas-office-of-enforcement-and-compliance-assurance-for-public-use--echo-provides-integrated-compliance-and-enforcement-information-for-about-800000-regulated-facilities-nationwide-brbrcase-rest-services-provide-multiple-service-endpoints-each-with-specific-capabilities-to-search-and-retrieve-data-on-civil-cases-entered-into-the-integrated-compliance-information-system-icis-and-criminal-cases-entered-into-the-summary-of-criminal-prosecutions-database---see-enforcement-case-search-help-httpsecho-epa-govhelpenforcementcasesearchhelp-for-additional-information-on-searching-civil-and-criminal-cases--brbrthe-get-cases-get-map-get-qid-and-get-download-end-points-are-meant-to-be-used-together-br--the-recommended-use-scenario-for-get-cases-get-qid-get-map-and-get-downoad-isbrbrb1bnbsp-use-get-cases-to-validate-passed-query-parameters-obtain-summary-statistics-and-to-obtain-a-query-id-qid---qids-are-time-sensitive-and-will-be-valid-for-approximately-30-minutes-brb2bnbsp-use-get-qid-with-the-returned-qid-to-paginate-through-arrays-of-case-results-brb3bnbsp-use-get-map-with-the-returned-qid-to-zoom-inout-and-pan-on-the-clustered-and-individual-facility-coordinates-related-to-the-returned-cases-that-meet-the-qid-query-criteria-brb4bnbsp-use-get-download-with-the-returned-qid-to-generate-a-comma-separated-value-csv-file-of-facility-information-that-meets-the-qid-query-criteria-brbrin-addition-to-the-service-endpoints-listed-above-there-are-two-detailed-case-report-services-one-for-civil-cases-get-case-report-and-one-for-criminal-cases-get-crcase-report--see-the-civil-enforcement-case-report-help-httpsecho-epa-govhelpreportsenforcementcasereporthelp-and-the-criminal-case-report-help-httpsecho-epa-govhelpreportscriminalcasereporthelp-for-additional-information-on-then-data-returned-from-these-two-services----bradditional-echo-resourcesnbspnbsp-a-hrefhttpsecho-epa-govtoolswebservicesweb-servicesa-a-hrefhttpsecho-epa-govresourcesechodataaboutthedataabout-echos-dataa-a-hrefhttpsecho-epa-govtoolsdatadownloadsdata-downloadsabr", "contact"=>{"name"=>"US EPA, OECA Integration, Targeting and Access Branch"}, "version"=>"1.0.0"}, "host"=>"ofmpub.epa.gov", "basePath"=>"/echo", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/case_rest_services.get_case_report"=>{"get"=>{"summary"=>"Enforcement Case Summary Report Search", "description"=>"The get_case_report service endpoint returns a complex object of civil enforcement case details based on the provided case id.", "operationId"=>"the-get-case-report-service-endpoint-returns-a-complex-object-of-civil-enforcement-case-details-base", "x-api-path-slug"=>"case-rest-services-get-case-report-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}, {"in"=>"query", "name"=>"p_id", "description"=>"Case Number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Enforcement", "Case", "Summary", "Report", "Search"]}}, "/case_rest_services.get_cases"=>{"get"=>{"summary"=>"Enforcement Case Search", "description"=>"The get_cases service end point searches for civil enforcement and criminal cases based on the provided selection criteria.", "operationId"=>"the-get-cases-service-end-point-searches-for-civil-enforcement-and-criminal-cases-based-on-the-provi", "x-api-path-slug"=>"case-rest-services-get-cases-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Enforcement", "Case", "Search"]}}, "/case_rest_services.get_crcase_report"=>{"get"=>{"summary"=>"Enforcement Criminal Case Summary Report Search", "description"=>"The get_crcase_report service end point returns a complex object of criminal case detials based on the provided criminal case id.", "operationId"=>"the-get-crcase-report-service-end-point-returns-a-complex-object-of-criminal-case-detials-based-on-t", "x-api-path-slug"=>"case-rest-services-get-crcase-report-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}, {"in"=>"query", "name"=>"p_id", "description"=>"Prosecution Summary Identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Enforcement", "Criminal", "Case", "Summary", "Report", "Search"]}}, "/case_rest_services.get_download"=>{"get"=>{"summary"=>"Enforcement Case Download Data Service", "description"=>"Based on the QID obtained from a get_cases query, return a comma sepated vaule (CSV) file of the cases found.", "operationId"=>"based-on-the-qid-obtained-from-a-get-cases-query-return-a-comma-sepated-vaule-csv-file-of-the-cases-", "x-api-path-slug"=>"case-rest-services-get-download-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Enforcement", "Case", "Download", "Data", "Service"]}}, "/case_rest_services.get_map"=>{"get"=>{"summary"=>"Enforcement Case Map Service", "description"=>"The purpose of the GET_MAP service is to display facility coordinates and facility clusters related to a get_cases query. Currently, the maximum number of coordinates returned is 500. GET_MAP performs automatic clustering at the state, county, and zip code levels to maximize the number of coordinates returned.", "operationId"=>"the-purpose-of-the-get-map-service-is-to-display-facility-coordinates-and-facility-clusters-related-", "x-api-path-slug"=>"case-rest-services-get-map-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Enforcement", "Case", "Map", "Service"]}}, "/case_rest_services.get_qid"=>{"get"=>{"summary"=>"Enforcement Case Paginated Results Service", "description"=>"GET_QID is passed with a query ID corresponding to a previously run get_cases query. It then returns a CASES object containing all matching cases. The main purpose of GET_QID is for large querysets that contain multiple pages (responsesets) of output. GET_QID allows for pagination and for the selection and sorting of columns.", "operationId"=>"get-qid-is-passed-with-a-query-id-corresponding-to-a-previously-run-get-cases-query--it-then-returns", "x-api-path-slug"=>"case-rest-services-get-qid-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Enforcement", "Case", "Paginated", "Results", "Service"]}}, "/case_rest_services.metadata"=>{"get"=>{"summary"=>"Enforcement Case Metadata Service", "description"=>"Returns the JSON Object Name and ColumnId for usage with the qcolumns parameter for get_cases endpoint.", "operationId"=>"returns-the-json-object-name-and-columnid-for-usage-with-the-qcolumns-parameter-for-get-cases-endpoi", "x-api-path-slug"=>"case-rest-services-metadata-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Enforcement", "Case", "Metadata", "Service"]}}, "/rest_lookups.icis_law_sections"=>{"get"=>{"summary"=>"ECHO ICIS Law Sections Lookup Service", "description"=>"Returns the ICIS Law Section Descriptions.", "operationId"=>"returns-the-icis-law-section-descriptions-", "x-api-path-slug"=>"rest-lookups-icis-law-sections-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "ECHO", "ICIS", "Law", "Sections", "Lookup", "Service"]}}}}, "u-s--epa-enforcement-and-compliance-history-online-echo--all-data-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"U.S. EPA Enforcement and Compliance History Online (ECHO) - All Data", "description"=>"enforcement-and-compliance-history-online-echo-is-a-tool-developed-and-maintained-by-epas-office-of-enforcement-and-compliance-assurance-for-public-use--echo-provides-integrated-compliance-and-enforcement-information-for-about-800000-regulated-facilities-nationwide-brbrecho-rest-services-provide-multiple-service-endpoints-each-with-specific-capabilities-to-search-and-retrieve-data-on-facilities-regulated-as-clean-air-act-caa-stationary-sources-clean-water-act-cwa-dischargers-resource-conservation-and-recovery-act-rcra-hazardous-waste-generatorshandlers-and-safe-drinking-water-act-sdwa-public-water-systems--data-of-interest-from-other-epa-sources-such-as-the-toxics-release-inventory-is-also-supplied-for-context-brbrthe-get-facilities-get-map-get-qid-and-get-download-end-points-are-meant-to-be-used-together-while-the-enhanced-get-facility-info-end-point-is-self-contained---the-get-facility-info-end-point-returns-either-an-array-of-state-county-or-zip-clusters-with-summary-statistics-per-cluster-or-an-array-of-facilities-brbrthe-recommended-use-scenario-for-get-facilities-get-qid-get-map-and-get-downoad-isbrbrb1bnbsp-use-get-facilities-to-validate-passed-query-parameters-obtain-summary-statistics-and-to-obtain-a-query-id-qid---qids-are-time-sensitive-and-will-be-valid-for-approximately-30-minutes-brb2bnbsp-use-get-qid-with-the-returned-qid-to-paginate-through-arrays-of-facility-results-brb3bnbsp-use-get-map-with-the-returned-qid-to-zoom-inout-and-pan-on-the-clustered-and-individual-facility-coordinates-that-meet-the-qid-query-criteria-brb4bnbsp-use-get-download-with-the-returned-qid-to-generate-a-comma-separated-value-csv-file-of-facility-information-that-meets-the-qid-query-criteria-brbruse-the-qcolumns-parameter-to-customize-your-search-results---use-the-metdata-service-endpoint-for-a-list-of-available-output-objects-their-column-ids-and-their-definitions-to-help-you-build-your-customized-output--brbradditional-echo-resourcesnbspnbsp-a-hrefhttpsecho-epa-govtoolswebservicesweb-servicesa-a-hrefhttpsecho-epa-govresourcesechodataaboutthedataabout-echos-dataa-a-hrefhttpsecho-epa-govtoolsdatadownloadsdata-downloadsabr", "contact"=>{"name"=>"US EPA, OECA Integration, Targeting and Access Branch"}, "version"=>"1.0.0"}, "host"=>"ofmpub.epa.gov", "basePath"=>"/echo", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/echo_rest_services.get_download"=>{"get"=>{"summary"=>"Combined ECHO Download Data Service", "description"=>"Based on the QID obtained from a get_facilities or get_facility_info query, return a comma sepated vaule (CSV) file of the facilities found.", "operationId"=>"based-on-the-qid-obtained-from-a-get-facilities-or-get-facility-info-query-return-a-comma-sepated-va", "x-api-path-slug"=>"echo-rest-services-get-download-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}, {"in"=>"query", "name"=>"qcolumns", "description"=>"Used to cutomize service output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Combined", "ECHO", "Download", "Data", "Service"]}}, "/echo_rest_services.get_facilities"=>{"get"=>{"summary"=>"Combined ECHO Facility Search Service", "description"=>"Validates query search parameters and returns query identifier. Use the responseset parameter to set the page size", "operationId"=>"validates-query-search-parameters-and-returns-query-identifier---use-the-responseset-parameter-to-se", "x-api-path-slug"=>"echo-rest-services-get-facilities-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}, {"in"=>"query", "name"=>"qcolumns", "description"=>"Used to cutomize service output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Combined", "ECHO", "Facility", "Search", "Service"]}}, "/echo_rest_services.get_facility_info"=>{"get"=>{"summary"=>"Combined ECHO Facility Enhanced Search Service", "description"=>"Returns either an array of Facilities or an array of Clusters that meet the specified search criteria.", "operationId"=>"returns-either-an-array-of-facilities-or-an-array-of-clusters-that-meet-the-specified-search-criteri", "x-api-path-slug"=>"echo-rest-services-get-facility-info-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}, {"in"=>"query", "name"=>"qcolumns", "description"=>"Used to cutomize service output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Combined", "ECHO", "Facility", "Enhanced", "Search", "Service"]}}, "/echo_rest_services.get_geojson"=>{"get"=>{"summary"=>"Combined ECHO GeoJSON Service", "description"=>"Based on the QID obtained from a get_facilities or get_facility_info query, return GeoJSON of the facilities found.", "operationId"=>"based-on-the-qid-obtained-from-a-get-facilities-or-get-facility-info-query-return-geojson-of-the-fac", "x-api-path-slug"=>"echo-rest-services-get-geojson-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}, {"in"=>"query", "name"=>"qcolumns", "description"=>"Used to cutomize service output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Combined", "ECHO", "GeoJSON", "Service"]}}, "/echo_rest_services.get_info_clusters"=>{"get"=>{"summary"=>"Combined ECHO Info Clusters Service", "description"=>"Based on the QID obtained from a clustered get_facility_info query, download cluster facility information as either a CSV or GEOJSON file.", "operationId"=>"based-on-the-qid-obtained-from-a-clustered-get-facility-info-query-download-cluster-facility-informa", "x-api-path-slug"=>"echo-rest-services-get-info-clusters-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Combined", "ECHO", "Info", "Clusters", "Service"]}}, "/echo_rest_services.get_map"=>{"get"=>{"summary"=>"Combined ECHO Map Service", "description"=>"The purpose of the GET_MAP service is to display facility coordinates and facility clusters related to a get_facilities facility query. Currently, the maximum number of coordinates returned is 500. GET_MAP performs automatic clustering at the state, county, and zip code levels to maximize the number of coordinates returned.", "operationId"=>"the-purpose-of-the-get-map-service-is-to-display-facility-coordinates-and-facility-clusters-related-", "x-api-path-slug"=>"echo-rest-services-get-map-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Combined", "ECHO", "Map", "Service"]}}, "/echo_rest_services.get_qid"=>{"get"=>{"summary"=>"Combined ECHO Paginated Results Service", "description"=>"GET_QID is passed with a query ID corresponding to a previously run get_facilities query. It then returns a Facility object containing all matching facilities. The main purpose of GET_QID is for large querysets that contain multiple pages (responsesets) of output. GET_QID allows for pagination and for the selection and sorting of columns.", "operationId"=>"get-qid-is-passed-with-a-query-id-corresponding-to-a-previously-run-get-facilities-query--it-then-re", "x-api-path-slug"=>"echo-rest-services-get-qid-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}, {"in"=>"query", "name"=>"qcolumns", "description"=>"Used to cutomize service output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Combined", "ECHO", "Paginated", "Results", "Service"]}}, "/echo_rest_services.metadata"=>{"get"=>{"summary"=>"Combined ECHO Metadata Service", "description"=>"Returns the JSON Object Name and ColumnId for usage with the qcolumns parameter for get_qid, get_facility_info and other service endpoints.", "operationId"=>"returns-the-json-object-name-and-columnid-for-usage-with-the-qcolumns-parameter-for-get-qid-get-faci", "x-api-path-slug"=>"echo-rest-services-metadata-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Combined", "ECHO", "Metadata", "Service"]}}}}, "epa-resource-conservation-and-recovery-act-information-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"EPA Resource Conservation and Recovery Act Information API", "description"=>"resource-conservation-and-recovery-act-information-provides-information-about-nationwide-hazardous-waste-handlers-", "contact"=>{"name"=>"EP Envirofacts", "url"=>"http://www.epa.gov/enviro/index.html"}, "version"=>"v1"}, "host"=>"iaspub.epa.gov", "basePath"=>"/enviro/efservice/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/RCRC_CA_EVENTCODES/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCRC_CA_EVENTCODES", "x-api-path-slug"=>"rcrc-ca-eventcodesrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_AREA_EVENT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_AREA_EVENT", "x-api-path-slug"=>"rcr-area-eventrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_AUTHCODES/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_AUTHCODES", "x-api-path-slug"=>"rcr-authcodesrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_CA_AREA/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_CA_AREA", "x-api-path-slug"=>"rcr-ca-arearowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_CA_AUTHORITY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_CA_AUTHORITY", "x-api-path-slug"=>"rcr-ca-authorityrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_CA_EVENT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_CA_EVENT", "x-api-path-slug"=>"rcr-ca-eventrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_EVENT_AUTHORITY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_EVENT_AUTHORITY", "x-api-path-slug"=>"rcr-event-authorityrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_EVENT_UNIT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_EVENT_UNIT", "x-api-path-slug"=>"rcr-event-unitrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_HANDLER/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_HANDLER", "x-api-path-slug"=>"rcr-handlerrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_HBASIC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_HBASIC", "x-api-path-slug"=>"rcr-hbasicrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_HCERTIFICATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_HCERTIFICATION", "x-api-path-slug"=>"rcr-hcertificationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_HNAICS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_HNAICS", "x-api-path-slug"=>"rcr-hnaicsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_HOTHER_PERMIT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_HOTHER_PERMIT", "x-api-path-slug"=>"rcr-hother-permitrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_HOWNER_OPERATOR/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_HOWNER_OPERATOR", "x-api-path-slug"=>"rcr-howner-operatorrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_HREPORT_UNIV/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_HREPORT_UNIV", "x-api-path-slug"=>"rcr-hreport-univrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_HSTATE_ACTIVITY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_HSTATE_ACTIVITY", "x-api-path-slug"=>"rcr-hstate-activityrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_HUNIVERSAL_WASTE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_HUNIVERSAL_WASTE", "x-api-path-slug"=>"rcr-huniversal-wasterowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_HWASTE_CODE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_HWASTE_CODE", "x-api-path-slug"=>"rcr-hwaste-coderowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_LU_COUNTY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_LU_COUNTY", "x-api-path-slug"=>"rcr-lu-countyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_LU_GENERATOR_STATUS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_LU_GENERATOR_STATUS", "x-api-path-slug"=>"rcr-lu-generator-statusrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_LU_LEGAL_OPERATING_STATUS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_LU_LEGAL_OPERATING_STATUS", "x-api-path-slug"=>"rcr-lu-legal-operating-statusrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_LU_NAICS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_LU_NAICS", "x-api-path-slug"=>"rcr-lu-naicsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_LU_STATE_ACTIVITY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_LU_STATE_ACTIVITY", "x-api-path-slug"=>"rcr-lu-state-activityrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_LU_UNIVERSAL_WASTE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_LU_UNIVERSAL_WASTE", "x-api-path-slug"=>"rcr-lu-universal-wasterowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_LU_WASTE_CODE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_LU_WASTE_CODE", "x-api-path-slug"=>"rcr-lu-waste-coderowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_PERMIT_EVENT_CODES/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_PERMIT_EVENT_CODES", "x-api-path-slug"=>"rcr-permit-event-codesrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_PEVENT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_PEVENT", "x-api-path-slug"=>"rcr-peventrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_PROCESS_CODES/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_PROCESS_CODES", "x-api-path-slug"=>"rcr-process-codesrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_PSERIES/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_PSERIES", "x-api-path-slug"=>"rcr-pseriesrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_PUNIT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_PUNIT", "x-api-path-slug"=>"rcr-punitrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_PUNIT_DETAIL/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_PUNIT_DETAIL", "x-api-path-slug"=>"rcr-punit-detailrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RCR_UNIVERSE_DETAIL/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RCR_UNIVERSE_DETAIL", "x-api-path-slug"=>"rcr-universe-detailrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RC_UNIT_OF_MEASURE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RC_UNIT_OF_MEASURE", "x-api-path-slug"=>"rc-unit-of-measurerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "epa-radiation-information-database-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"EPA Radiation Information Database API", "description"=>"the-radiation-information-database-provides-information-aobut-certain-facilities-that-epa-regulates-for-radiation-and-radioactivity-", "contact"=>{"name"=>"EP Envirofacts", "url"=>"http://www.epa.gov/enviro/index.html"}, "version"=>"v1"}, "host"=>"iaspub.epa.gov", "basePath"=>"/enviro/efservice/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/RAD_FACILITY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RAD_FACILITY", "x-api-path-slug"=>"rad-facilityrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RAD_FACILITY_TYPE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RAD_FACILITY_TYPE", "x-api-path-slug"=>"rad-facility-typerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RAD_GEO_LOCATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RAD_GEO_LOCATION", "x-api-path-slug"=>"rad-geo-locationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RAD_REGULATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RAD_REGULATION", "x-api-path-slug"=>"rad-regulationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/RAD_REGULATORY_PROG/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_RAD_REGULATORY_PROG", "x-api-path-slug"=>"rad-regulatory-progrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "u-s--epa-enforcement-and-compliance-history-online-echo--effluent-charting-and-reporting-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"U.S. EPA Enforcement and Compliance History Online (ECHO) - Effluent Charting and Reporting", "description"=>"enforcement-and-compliance-history-online-echo-is-a-tool-developed-and-maintained-by-epas-office-of-enforcement-and-compliance-assurance-for-public-use-echo-provides-integrated-compliance-and-enforcement-information-for-about-800000-regulated-facilities-nationwide-brbreff-rest-services-provides-the-data-for-echos-effluent-charts-a-set-of-dynamic-charts-and-tables-of-permitted-effluent-limits-releases-and-violations-over-time-for-clean-water-act-cwa-wastewater-discharge-permits-issued-under-the-national-pollutant-discharge-elimination-system-npdes---see-effluent-charts-help-httpsecho-epa-govhelpreportseffluentchartshelp-for-additional-information-brbrthe-are-3-service-end-points-for-efffluent-charts--get-summary-chart-get-effluent-chart-and-download-effluent-chart-brbrb1bnbsp-use-get-summary-chart-to-retrieve-a-summary-matrix-of-effluent-parameters-by-effluent-outfall-and-an-overall-violation-status-for-a-provided-npdes-permit-and-date-range-brb2bnbsp-use-get-effluent-chart-to-retrieve-detailed-discharge-limit-dmr-and-npdes-violation-information-for-a-provided-npdes-permit-date-range-effluent-paramater-or-outfall-brb3bnbsp-use-download-effluent-chart-to-generate-a-comma-separated-value-csv-file-of-the-detailed-data-provided-with-get-effluent-chart-for-a-provided-npdes-permit-date-range-effluent-paramater-or-outfall-brbradditional-echo-resourcesnbspnbsp-a-hrefhttpsecho-epa-govtoolswebservicesweb-servicesa-a-hrefhttpsecho-epa-govresourcesechodataaboutthedataabout-echos-dataa-a-hrefhttpsecho-epa-govtoolsdatadownloadsdata-downloadsabr", "contact"=>{"name"=>"US EPA, OECA Integration, Targeting and Access Branch"}, "version"=>"1.0.0"}, "host"=>"ofmpub.epa.gov", "basePath"=>"/echo", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/eff_rest_services.download_effluent_chart"=>{"get"=>{"summary"=>"Effluent Charts Download Service", "description"=>"Downloads tabular Discharge Monitoring Report (DMR) and compliance data for one NPDES permit as a CSV.", "operationId"=>"downloads-tabular-discharge-monitoring-report-dmr-and-compliance-data-for-one-npdes-permit-as-a-csv-", "x-api-path-slug"=>"eff-rest-services-download-effluent-chart-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Effluent", "Charts", "Download", "Service"]}}, "/eff_rest_services.get_effluent_chart"=>{"get"=>{"summary"=>"Detailed Effluent Chart Service", "description"=>"Discharge Monitoring Report (DMR) data supporting each effluent chart for one NPDES permit. Includes Discharge Monitoring Reports and NPDES Violations.", "operationId"=>"discharge-monitoring-report-dmr-data-supporting-each-effluent-chart-for-one-npdes-permit--includes-d", "x-api-path-slug"=>"eff-rest-services-get-effluent-chart-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Effluent", "Chart", "Service"]}}, "/eff_rest_services.get_summary_chart"=>{"get"=>{"summary"=>"Summary Effluent Chart Service", "description"=>"Summary of compliance status each outfall and parameter for one NPDES permit. Provides the current compliance status and overall compliance status for the date range of interest. This service supports the Summary Matrix on the Effluent Charts.", "operationId"=>"summary-of-compliance-status-each-outfall-and-parameter-for-one-npdes-permit--provides-the-current-c", "x-api-path-slug"=>"eff-rest-services-get-summary-chart-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Summary", "Effluent", "Chart", "Service"]}}, "/rest_lookups.cwa_parameters"=>{"get"=>{"summary"=>"ECHO CWA Parameter Lookup Service", "description"=>"Look up Clean Water Act parameter codes and descriptions in the Integrated Compliance Information System - National Pollutant Discharge Elimination System (ICIS-NPDES) by code or term.", "operationId"=>"look-up-clean-water-act-parameter-codes-and-descriptions-in-the-integrated-compliance-information-sy", "x-api-path-slug"=>"rest-lookups-cwa-parameters-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "ECHO", "CWA", "Parameter", "Lookup", "Service"]}}}}, "epa-toxics-release-inventory-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"EPA Toxics Release Inventory API", "description"=>"toxics-release-inventory-contains-information-about-the-annual-release-of-toxic-chemicals-to-the-air-land-and-water-", "contact"=>{"name"=>"EP Envirofacts", "url"=>"http://www.epa.gov/enviro/index.html"}, "version"=>"v1"}, "host"=>"iaspub.epa.gov", "basePath"=>"/enviro/efservice/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/TRI_CHEM_ACTIVITY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_CHEM_ACTIVITY", "x-api-path-slug"=>"tri-chem-activityrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_CHEM_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_CHEM_INFO", "x-api-path-slug"=>"tri-chem-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_CODE_DESC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_CODE_DESC", "x-api-path-slug"=>"tri-code-descrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_COUNTY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_COUNTY", "x-api-path-slug"=>"tri-countyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_ENERGY_RECOVERY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_ENERGY_RECOVERY", "x-api-path-slug"=>"tri-energy-recoveryrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_FACILITY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_FACILITY", "x-api-path-slug"=>"tri-facilityrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_FACILITY_DB/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_FACILITY_DB", "x-api-path-slug"=>"tri-facility-dbrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_FACILITY_DB_HISTORY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_FACILITY_DB_HISTORY", "x-api-path-slug"=>"tri-facility-db-historyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_FACILITY_HISTORY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_FACILITY_HISTORY", "x-api-path-slug"=>"tri-facility-historyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_FACILITY_NPDES/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_FACILITY_NPDES", "x-api-path-slug"=>"tri-facility-npdesrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_FACILITY_NPDES_HISTORY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_FACILITY_NPDES_HISTORY", "x-api-path-slug"=>"tri-facility-npdes-historyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_FACILITY_RCRA/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_FACILITY_RCRA", "x-api-path-slug"=>"tri-facility-rcrarowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_FACILITY_SIC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_FACILITY_SIC", "x-api-path-slug"=>"tri-facility-sicrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_FACILITY_SIC_HISTORY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_FACILITY_SIC_HISTORY", "x-api-path-slug"=>"tri-facility-sic-historyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_FACILITY_UIC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_FACILITY_UIC", "x-api-path-slug"=>"tri-facility-uicrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_FACILITY_UIC_HISTORY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_FACILITY_UIC_HISTORY", "x-api-path-slug"=>"tri-facility-uic-historyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_FORM_R_SCHEDULE_ONE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_FORM_R_SCHEDULE_ONE", "x-api-path-slug"=>"tri-form-r-schedule-onerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_OFF_SITE_TRANSFER_LOCATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_OFF_SITE_TRANSFER_LOCATION", "x-api-path-slug"=>"tri-off-site-transfer-locationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_ONSITE_WASTESTREAM/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_ONSITE_WASTESTREAM", "x-api-path-slug"=>"tri-onsite-wastestreamrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_ONSITE_WASTE_TREATMENT_MET/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_ONSITE_WASTE_TREATMENT_MET", "x-api-path-slug"=>"tri-onsite-waste-treatment-metrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_POTW_LOCATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_POTW_LOCATION", "x-api-path-slug"=>"tri-potw-locationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_RECYCLING_PROCESS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_RECYCLING_PROCESS", "x-api-path-slug"=>"tri-recycling-processrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_RELEASE_QTY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_RELEASE_QTY", "x-api-path-slug"=>"tri-release-qtyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_REPORTING_FORM/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_REPORTING_FORM", "x-api-path-slug"=>"tri-reporting-formrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_SOURCE_REDUCTION_METHOD/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_SOURCE_REDUCTION_METHOD", "x-api-path-slug"=>"tri-source-reduction-methodrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_SOURCE_REDUCT_QTY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_SOURCE_REDUCT_QTY", "x-api-path-slug"=>"tri-source-reduct-qtyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_SUBMISSION_NAICS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_SUBMISSION_NAICS", "x-api-path-slug"=>"tri-submission-naicsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_SUBMISSION_SIC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_SUBMISSION_SIC", "x-api-path-slug"=>"tri-submission-sicrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_TABLE_ID_NAME/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_TABLE_ID_NAME", "x-api-path-slug"=>"tri-table-id-namerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_TRANSFER_QTY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_TRANSFER_QTY", "x-api-path-slug"=>"tri-transfer-qtyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_TRIBE_DESC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_TRIBE_DESC", "x-api-path-slug"=>"tri-tribe-descrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_WATER_STREAM/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_WATER_STREAM", "x-api-path-slug"=>"tri-water-streamrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TRI_ZIP_CODE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TRI_ZIP_CODE", "x-api-path-slug"=>"tri-zip-coderowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TR_FACILITY_RCRA_HISTORY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TR_FACILITY_RCRA_HISTORY", "x-api-path-slug"=>"tr-facility-rcra-historyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "epa-air-facility-system-afs-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"EPA Air Facility System (AFS) API", "description"=>"air-facility-system-afs-provides-permit-emissions-and-compliance-data-on-air-pollution-point-sources-", "contact"=>{"name"=>"EP Envirofacts", "url"=>"http://www.epa.gov/enviro/index.html"}, "version"=>"v1"}, "host"=>"iaspub.epa.gov", "basePath"=>"/enviro/efservice/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/EFFRS_AFSACT1/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_EFFRS_AFSACT1", "x-api-path-slug"=>"effrs-afsact1rowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/EFFRS_AFSACT2/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_EFFRS_AFSACT2", "x-api-path-slug"=>"effrs-afsact2rowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/EFFRS_AFSAP/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_EFFRS_AFSAP", "x-api-path-slug"=>"effrs-afsaprowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/EFFRS_AFSAPP/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_EFFRS_AFSAPP", "x-api-path-slug"=>"effrs-afsapprowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/EFFRS_AFSCMS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_EFFRS_AFSCMS", "x-api-path-slug"=>"effrs-afscmsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/EFFRS_AFSPLT1/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_EFFRS_AFSPLT1", "x-api-path-slug"=>"effrs-afsplt1rowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/EFFRS_AFSPLT2/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_EFFRS_AFSPLT2", "x-api-path-slug"=>"effrs-afsplt2rowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/EFFRS_AFSSUBP/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_EFFRS_AFSSUBP", "x-api-path-slug"=>"effrs-afssubprowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "epa-greenhouse-gas-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"EPA Greenhouse Gas API", "description"=>"the-program-requires-annual-reporting-of-greenhouse-gas-ghg-data-and-other-relevant-information-from-large-direct-emissions-sources-and-suppliers-of-certain-fossil-fuels-and-industrial-gases-in-the-united-states-", "contact"=>{"name"=>"EP Envirofacts", "url"=>"http://www.epa.gov/enviro/index.html"}, "version"=>"v1"}, "host"=>"iaspub.epa.gov", "basePath"=>"/enviro/efservice/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/AA_FOSSIL_FUEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_AA_FOSSIL_FUEL_INFORMATION", "x-api-path-slug"=>"aa-fossil-fuel-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/AA_FOSSIL_FUEL_TIER_2_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_AA_FOSSIL_FUEL_TIER_2_INFO", "x-api-path-slug"=>"aa-fossil-fuel-tier-2-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/AA_MAKEUP_CHEMICAL_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_AA_MAKEUP_CHEMICAL_INFO", "x-api-path-slug"=>"aa-makeup-chemical-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/AA_SPENT_LIQUOR_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_AA_SPENT_LIQUOR_INFORMATION", "x-api-path-slug"=>"aa-spent-liquor-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/AA_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_AA_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"aa-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/AA_TIER_4_CEMS_QUARTERLY_CO2/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_AA_TIER_4_CEMS_QUARTERLY_CO2", "x-api-path-slug"=>"aa-tier-4-cems-quarterly-co2rowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/C_BIOGENIC_CO2_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_C_BIOGENIC_CO2_DETAILS", "x-api-path-slug"=>"c-biogenic-co2-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/C_CEMS_QUARTERLY_CO2/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_C_CEMS_QUARTERLY_CO2", "x-api-path-slug"=>"c-cems-quarterly-co2rowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/C_CONFIGURATION_LEVEL_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_C_CONFIGURATION_LEVEL_INFO", "x-api-path-slug"=>"c-configuration-level-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/C_FUEL_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_C_FUEL_LEVEL_INFORMATION", "x-api-path-slug"=>"c-fuel-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/C_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_C_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"c-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/C_TIER2_MONTHLY_HHV/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_C_TIER2_MONTHLY_HHV", "x-api-path-slug"=>"c-tier2-monthly-hhvrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/DD_FACILITY_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_DD_FACILITY_INFO", "x-api-path-slug"=>"dd-facility-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/DD_INCREASE_NAMEPLATE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_DD_INCREASE_NAMEPLATE", "x-api-path-slug"=>"dd-increase-nameplaterowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/DD_SF6PFC_ACQUISITIONS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_DD_SF6PFC_ACQUISITIONS", "x-api-path-slug"=>"dd-sf6pfc-acquisitionsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/DD_SF6PFC_DECREASES/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_DD_SF6PFC_DECREASES", "x-api-path-slug"=>"dd-sf6pfc-decreasesrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/DD_SF6PFC_DISBURSEMENT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_DD_SF6PFC_DISBURSEMENT", "x-api-path-slug"=>"dd-sf6pfc-disbursementrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/DD_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_DD_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"dd-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/DD_TRANSMISSION_LINE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_DD_TRANSMISSION_LINE", "x-api-path-slug"=>"dd-transmission-linerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/DD_USER_EMISSIONS_CALC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_DD_USER_EMISSIONS_CALC", "x-api-path-slug"=>"dd-user-emissions-calcrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/D_FUEL_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_D_FUEL_LEVEL_INFORMATION", "x-api-path-slug"=>"d-fuel-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/EE_CEMS_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_EE_CEMS_DETAILS", "x-api-path-slug"=>"ee-cems-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/EE_CEMS_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_EE_CEMS_INFO", "x-api-path-slug"=>"ee-cems-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/EE_FACILITY_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_EE_FACILITY_INFO", "x-api-path-slug"=>"ee-facility-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/EE_NOCEMSTIO2DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_EE_NOCEMSTIO2DETAILS", "x-api-path-slug"=>"ee-nocemstio2detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/EE_NOCEMS_MONTHLYDETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_EE_NOCEMS_MONTHLYDETAILS", "x-api-path-slug"=>"ee-nocems-monthlydetailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/EE_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_EE_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"ee-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/EE_TIER4CEMS_QTRDTLS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_EE_TIER4CEMS_QTRDTLS", "x-api-path-slug"=>"ee-tier4cems-qtrdtlsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FF_DEGASIFICATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FF_DEGASIFICATION", "x-api-path-slug"=>"ff-degasificationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FF_DEGAS_QTRLY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FF_DEGAS_QTRLY", "x-api-path-slug"=>"ff-degas-qtrlyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FF_DEGAS_WEEKLY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FF_DEGAS_WEEKLY", "x-api-path-slug"=>"ff-degas-weeklyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FF_DESTROFFSITE_BACKUP/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FF_DESTROFFSITE_BACKUP", "x-api-path-slug"=>"ff-destroffsite-backuprowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FF_DESTROFFSITE_QTRLY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FF_DESTROFFSITE_QTRLY", "x-api-path-slug"=>"ff-destroffsite-qtrlyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FF_DESTROFFSITE_WEEKLY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FF_DESTROFFSITE_WEEKLY", "x-api-path-slug"=>"ff-destroffsite-weeklyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FF_METHOD_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FF_METHOD_DETAILS", "x-api-path-slug"=>"ff-method-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FF_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FF_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"ff-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FF_SUMMARY_SOURCE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FF_SUMMARY_SOURCE", "x-api-path-slug"=>"ff-summary-sourcerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FF_VENTILATION_QTRL/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FF_VENTILATION_QTRL", "x-api-path-slug"=>"ff-ventilation-qtrlrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/FF_WELL_AND_SHAFT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_FF_WELL_AND_SHAFT", "x-api-path-slug"=>"ff-well-and-shaftrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/F_SMELTER_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_F_SMELTER_DETAILS", "x-api-path-slug"=>"f-smelter-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GG_FACILITY_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GG_FACILITY_INFO", "x-api-path-slug"=>"gg-facility-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GG_NOCEMS_ZIN_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GG_NOCEMS_ZIN_DETAILS", "x-api-path-slug"=>"gg-nocems-zin-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/GG_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_GG_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"gg-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/G_CEMS_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_G_CEMS_DETAILS", "x-api-path-slug"=>"g-cems-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/G_FEEDSTOCK_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_G_FEEDSTOCK_DETAILS", "x-api-path-slug"=>"g-feedstock-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/G_NON_CEMS_SOURCE_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_G_NON_CEMS_SOURCE_INFO", "x-api-path-slug"=>"g-non-cems-source-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/HH_ACTIVE_AERATION_SYS_DETLS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_HH_ACTIVE_AERATION_SYS_DETLS", "x-api-path-slug"=>"hh-active-aeration-sys-detlsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/HH_ANN_WASTE_DISPOSAL_QTY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_HH_ANN_WASTE_DISPOSAL_QTY", "x-api-path-slug"=>"hh-ann-waste-disposal-qtyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/HH_COVER_TYPE_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_HH_COVER_TYPE_DETAILS", "x-api-path-slug"=>"hh-cover-type-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/HH_GAS_COLLECTION_MNTHLY_DETLS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_HH_GAS_COLLECTION_MNTHLY_DETLS", "x-api-path-slug"=>"hh-gas-collection-mnthly-detlsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/HH_GAS_COLLECTION_SYSTEM_DETLS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_HH_GAS_COLLECTION_SYSTEM_DETLS", "x-api-path-slug"=>"hh-gas-collection-system-detlsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/HH_HIST_WASTE_QTY_METHOD/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_HH_HIST_WASTE_QTY_METHOD", "x-api-path-slug"=>"hh-hist-waste-qty-methodrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/HH_HIST_YR_WASTE_QTY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_HH_HIST_YR_WASTE_QTY", "x-api-path-slug"=>"hh-hist-yr-waste-qtyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/HH_HIST_YR_WASTE_QTY_DETL/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_HH_HIST_YR_WASTE_QTY_DETL", "x-api-path-slug"=>"hh-hist-yr-waste-qty-detlrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/HH_LANDFILL_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_HH_LANDFILL_INFO", "x-api-path-slug"=>"hh-landfill-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/HH_LNDFIL_WITHOUT_GAS_CLCT_EMIS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_HH_LNDFIL_WITHOUT_GAS_CLCT_EMIS", "x-api-path-slug"=>"hh-lndfil-without-gas-clct-emisrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/HH_LNDFIL_WITH_GAS_CLCT_WST_DEP/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_HH_LNDFIL_WITH_GAS_CLCT_WST_DEP", "x-api-path-slug"=>"hh-lndfil-with-gas-clct-wst-deprowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/HH_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_HH_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"hh-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/HH_WASTE_QTY_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_HH_WASTE_QTY_DETAILS", "x-api-path-slug"=>"hh-waste-qty-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/H_CEMS_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_H_CEMS_DETAILS", "x-api-path-slug"=>"h-cems-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/H_CEMS_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_H_CEMS_INFO", "x-api-path-slug"=>"h-cems-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/H_NO_CEMS_MONTH_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_H_NO_CEMS_MONTH_DETAILS", "x-api-path-slug"=>"h-no-cems-month-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/H_NO_CEMS_QRTR_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_H_NO_CEMS_QRTR_DETAILS", "x-api-path-slug"=>"h-no-cems-qrtr-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/H_NO_CEMS_RAW_MATERIAL_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_H_NO_CEMS_RAW_MATERIAL_DETAILS", "x-api-path-slug"=>"h-no-cems-raw-material-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/I-SEMICONDUCTOR_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_I-SEMICONDUCTOR_INFO", "x-api-path-slug"=>"isemiconductor-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/II_BIOGAS_REC_PROC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_II_BIOGAS_REC_PROC", "x-api-path-slug"=>"ii-biogas-rec-procrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/II_CH4_GEN_PROCESS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_II_CH4_GEN_PROCESS", "x-api-path-slug"=>"ii-ch4-gen-processrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/II_EQUATION_II3/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_II_EQUATION_II3", "x-api-path-slug"=>"ii-equation-ii3rowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/II_EQUATION_II6/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_II_EQUATION_II6", "x-api-path-slug"=>"ii-equation-ii6rowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/II_EQUATION_II7/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_II_EQUATION_II7", "x-api-path-slug"=>"ii-equation-ii7rowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/II_EQU_II1_OR_II2/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_II_EQU_II1_OR_II2", "x-api-path-slug"=>"ii-equ-ii1-or-ii2rowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/II_EQU_II4_INPUT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_II_EQU_II4_INPUT", "x-api-path-slug"=>"ii-equ-ii4-inputrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/II_PROCESS_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_II_PROCESS_DETAILS", "x-api-path-slug"=>"ii-process-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/II_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_II_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"ii-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/I_ABATEMENT_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_I_ABATEMENT_INFO", "x-api-path-slug"=>"i-abatement-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/I_FACILITY_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_I_FACILITY_DETAILS", "x-api-path-slug"=>"i-facility-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/I_FHTF_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_I_FHTF_INFO", "x-api-path-slug"=>"i-fhtf-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/I_N20_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_I_N20_INFO", "x-api-path-slug"=>"i-n20-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/I_PV_MEMS_LCD_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_I_PV_MEMS_LCD_INFO", "x-api-path-slug"=>"i-pv-mems-lcd-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/K_CEMS_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_K_CEMS_DETAILS", "x-api-path-slug"=>"k-cems-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/K_CEMS_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_K_CEMS_INFO", "x-api-path-slug"=>"k-cems-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/K_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_K_INFO", "x-api-path-slug"=>"k-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/K_NON_CEMS_SOURCE_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_K_NON_CEMS_SOURCE_INFO", "x-api-path-slug"=>"k-non-cems-source-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/K_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_K_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"k-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/MM_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_MM_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"mm-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/NN_LDC_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_NN_LDC_DETAILS", "x-api-path-slug"=>"nn-ldc-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/NN_LDC_NAT_GAS_DELIVERIES/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_NN_LDC_NAT_GAS_DELIVERIES", "x-api-path-slug"=>"nn-ldc-nat-gas-deliveriesrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/NN_NGL-FRACTIONATOR_METHODS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_NN_NGL-FRACTIONATOR_METHODS", "x-api-path-slug"=>"nn-nglfractionator-methodsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/NN_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_NN_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"nn-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/N_CEMS_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_N_CEMS_DETAILS", "x-api-path-slug"=>"n-cems-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/N_CEMS_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_N_CEMS_INFO", "x-api-path-slug"=>"n-cems-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/N_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_N_INFO", "x-api-path-slug"=>"n-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/N_NON_CEMS_SOURCE_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_N_NON_CEMS_SOURCE_INFO", "x-api-path-slug"=>"n-non-cems-source-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PP_CALC_METHOD_DATA_QUALITY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PP_CALC_METHOD_DATA_QUALITY", "x-api-path-slug"=>"pp-calc-method-data-qualityrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PP_CO2_END_USE_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PP_CO2_END_USE_DETAILS", "x-api-path-slug"=>"pp-co2-end-use-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PP_CO2_FLOW_MEASURE_EQUIPMENT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PP_CO2_FLOW_MEASURE_EQUIPMENT", "x-api-path-slug"=>"pp-co2-flow-measure-equipmentrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PP_MASS_FLOW_MEASURE_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PP_MASS_FLOW_MEASURE_DETAILS", "x-api-path-slug"=>"pp-mass-flow-measure-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PP_METER_AND_EQUIPMENT_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PP_METER_AND_EQUIPMENT_DETAILS", "x-api-path-slug"=>"pp-meter-and-equipment-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PP_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PP_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"pp-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PP_VOLUME_FLOW_MEASURE_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PP_VOLUME_FLOW_MEASURE_DETAILS", "x-api-path-slug"=>"pp-volume-flow-measure-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PUB_DIM_FACILITY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PUB_DIM_FACILITY", "x-api-path-slug"=>"pub-dim-facilityrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/P_CEMS_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_P_CEMS_DETAILS", "x-api-path-slug"=>"p-cems-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/P_UNIT_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_P_UNIT_INFO", "x-api-path-slug"=>"p-unit-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/P_UNIT_INFO_CEMS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_P_UNIT_INFO_CEMS", "x-api-path-slug"=>"p-unit-info-cemsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Q_CEMS_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Q_CEMS_DETAILS", "x-api-path-slug"=>"q-cems-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Q_CEMS_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Q_CEMS_INFO", "x-api-path-slug"=>"q-cems-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Q_FLARE_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Q_FLARE_INFORMATION", "x-api-path-slug"=>"q-flare-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Q_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Q_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"q-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Q_UNIT_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Q_UNIT_DETAILS", "x-api-path-slug"=>"q-unit-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/R_FACILITY_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_R_FACILITY_INFO", "x-api-path-slug"=>"r-facility-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/R_FEEDSTOCK_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_R_FEEDSTOCK_INFO", "x-api-path-slug"=>"r-feedstock-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/R_SMELTING_FURNACE_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_R_SMELTING_FURNACE_INFO", "x-api-path-slug"=>"r-smelting-furnace-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/R_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_R_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"r-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/SS_CHG_INVENTORY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_SS_CHG_INVENTORY", "x-api-path-slug"=>"ss-chg-inventoryrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/SS_EQ_SS5/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_SS_EQ_SS5", "x-api-path-slug"=>"ss-eq-ss5rowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/SS_GHG_ACQUISITION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_SS_GHG_ACQUISITION", "x-api-path-slug"=>"ss-ghg-acquisitionrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/SS_GHG_DISBURSEMENT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_SS_GHG_DISBURSEMENT", "x-api-path-slug"=>"ss-ghg-disbursementrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/SS_GHG_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_SS_GHG_INFORMATION", "x-api-path-slug"=>"ss-ghg-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/SS_HOSE_VALVE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_SS_HOSE_VALVE", "x-api-path-slug"=>"ss-hose-valverowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/SS_INSTALL_EMISSIONS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_SS_INSTALL_EMISSIONS", "x-api-path-slug"=>"ss-install-emissionsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/SS_MASS_DELIV_NEW_EQ/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_SS_MASS_DELIV_NEW_EQ", "x-api-path-slug"=>"ss-mass-deliv-new-eqrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/SS_MSNG_DTA_EMISSION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_SS_MSNG_DTA_EMISSION", "x-api-path-slug"=>"ss-msng-dta-emissionrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/SS_MSNG_DTA_HOSE_VLV/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_SS_MSNG_DTA_HOSE_VLV", "x-api-path-slug"=>"ss-msng-dta-hose-vlvrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/SS_MSNG_DTA_MAK_MODL/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_SS_MSNG_DTA_MAK_MODL", "x-api-path-slug"=>"ss-msng-dta-mak-modlrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/SS_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_SS_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"ss-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/SS_SUMMARY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_SS_SUMMARY", "x-api-path-slug"=>"ss-summaryrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/SS_SUM_HOSE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_SS_SUM_HOSE", "x-api-path-slug"=>"ss-sum-hoserowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/SS_USER_EMISSIONS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_SS_USER_EMISSIONS", "x-api-path-slug"=>"ss-user-emissionsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/S_CEMS_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_S_CEMS_DETAILS", "x-api-path-slug"=>"s-cems-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/S_LIME_BYPRODUCT_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_S_LIME_BYPRODUCT_DETAILS", "x-api-path-slug"=>"s-lime-byproduct-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/S_LIME_PRODUCT_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_S_LIME_PRODUCT_DETAILS", "x-api-path-slug"=>"s-lime-product-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TT_HIST_WASTE_METHOD/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TT_HIST_WASTE_METHOD", "x-api-path-slug"=>"tt-hist-waste-methodrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TT_LANDFILL_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TT_LANDFILL_DETAILS", "x-api-path-slug"=>"tt-landfill-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TT_LF_GAS_COLL_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TT_LF_GAS_COLL_DETAILS", "x-api-path-slug"=>"tt-lf-gas-coll-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TT_SUBPART_CHG_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TT_SUBPART_CHG_INFO", "x-api-path-slug"=>"tt-subpart-chg-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TT_WASTESTREAM_DETLS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TT_WASTESTREAM_DETLS", "x-api-path-slug"=>"tt-wastestream-detlsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/TT_WASTE_DEPTH_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_TT_WASTE_DEPTH_DETAILS", "x-api-path-slug"=>"tt-waste-depth-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/T_COVER_OR_CARRIER_GAS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_T_COVER_OR_CARRIER_GAS", "x-api-path-slug"=>"t-cover-or-carrier-gasrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/T_PRODUCTION_PROCESS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_T_PRODUCTION_PROCESS", "x-api-path-slug"=>"t-production-processrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/T_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_T_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"t-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/UU_INJ_CO2_FACILITY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_UU_INJ_CO2_FACILITY", "x-api-path-slug"=>"uu-inj-co2-facilityrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/UU_INJ_CO2_UNIT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_UU_INJ_CO2_UNIT", "x-api-path-slug"=>"uu-inj-co2-unitrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/U_CALCINATION_FRAC_METHODS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_U_CALCINATION_FRAC_METHODS", "x-api-path-slug"=>"u-calcination-frac-methodsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/U_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_U_INFO", "x-api-path-slug"=>"u-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/U_MASS_METHODS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_U_MASS_METHODS", "x-api-path-slug"=>"u-mass-methodsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/U_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_U_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"u-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/V_FACILITY_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_V_FACILITY_INFO", "x-api-path-slug"=>"v-facility-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/V_NITRIC_ACID_TRAIN/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_V_NITRIC_ACID_TRAIN", "x-api-path-slug"=>"v-nitric-acid-trainrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/V_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_V_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"v-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_ACID_GAS_REMOVAL_UNIT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_ACID_GAS_REMOVAL_UNIT", "x-api-path-slug"=>"w-acid-gas-removal-unitrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_ASS_VENTING_FLARING/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_ASS_VENTING_FLARING", "x-api-path-slug"=>"w-ass-venting-flaringrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_ATMOSPHERIC_TANKS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_ATMOSPHERIC_TANKS", "x-api-path-slug"=>"w-atmospheric-tanksrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_BLOWDOWN_VENT_STACKS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_BLOWDOWN_VENT_STACKS", "x-api-path-slug"=>"w-blowdown-vent-stacksrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_CENTRIFUGAL_CMPS_ONSHORE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_CENTRIFUGAL_CMPS_ONSHORE", "x-api-path-slug"=>"w-centrifugal-cmps-onshorerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_COMBUSTION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_COMBUSTION", "x-api-path-slug"=>"w-combustionrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_DEHYDRATORS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_DEHYDRATORS", "x-api-path-slug"=>"w-dehydratorsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_ENH_OIL_REC_INJ_PUMP_BD/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_ENH_OIL_REC_INJ_PUMP_BD", "x-api-path-slug"=>"w-enh-oil-rec-inj-pump-bdrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_EOR_HYDROCARBON_LIQ/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_EOR_HYDROCARBON_LIQ", "x-api-path-slug"=>"w-eor-hydrocarbon-liqrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_FLARE_STACKS_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_FLARE_STACKS_DETAILS", "x-api-path-slug"=>"w-flare-stacks-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_LIQUIDS_UNLOADING/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_LIQUIDS_UNLOADING", "x-api-path-slug"=>"w-liquids-unloadingrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_LOCAL_DIST_COMPANIES_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_LOCAL_DIST_COMPANIES_DETAILS", "x-api-path-slug"=>"w-local-dist-companies-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_OFFSHORE_RESOURCES/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_OFFSHORE_RESOURCES", "x-api-path-slug"=>"w-offshore-resourcesrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_ONSHORE_PRODUCTION_REQUIREMENTS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_ONSHORE_PRODUCTION_REQUIREMENTS", "x-api-path-slug"=>"w-onshore-production-requirementsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_OTHER_EMISSIONS_EQUIP_LEAKS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_OTHER_EMISSIONS_EQUIP_LEAKS", "x-api-path-slug"=>"w-other-emissions-equip-leaksrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_PNEUMATIC_DEVICES/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_PNEUMATIC_DEVICES", "x-api-path-slug"=>"w-pneumatic-devicesrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_PNEUMATIC_PUMPS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_PNEUMATIC_PUMPS", "x-api-path-slug"=>"w-pneumatic-pumpsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_RECEIPRICATING_CMPRS_ONSHORE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_RECEIPRICATING_CMPRS_ONSHORE", "x-api-path-slug"=>"w-receipricating-cmprs-onshorerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"w-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_SUB_BASIN/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_SUB_BASIN", "x-api-path-slug"=>"w-sub-basinrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_TRANSMISSION_TANKS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_TRANSMISSION_TANKS", "x-api-path-slug"=>"w-transmission-tanksrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_WELLCOMPL_WITHOUT_HYDRAULIC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_WELLCOMPL_WITHOUT_HYDRAULIC", "x-api-path-slug"=>"w-wellcompl-without-hydraulicrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_WELL_COMPLETION_HYDRAULIC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_WELL_COMPLETION_HYDRAULIC", "x-api-path-slug"=>"w-well-completion-hydraulicrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/W_WELL_TESTING/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_W_WELL_TESTING", "x-api-path-slug"=>"w-well-testingrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/X_CEMS_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_X_CEMS_DETAILS", "x-api-path-slug"=>"x-cems-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/X_CEMS_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_X_CEMS_INFO", "x-api-path-slug"=>"x-cems-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/X_COMBUSTION_ETHYLENE_UNIT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_X_COMBUSTION_ETHYLENE_UNIT", "x-api-path-slug"=>"x-combustion-ethylene-unitrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/X_FLARE_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_X_FLARE_INFORMATION", "x-api-path-slug"=>"x-flare-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/X_MASS_BLANACE_UNIT_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_X_MASS_BLANACE_UNIT_DETAILS", "x-api-path-slug"=>"x-mass-blanace-unit-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/X_PROCESS_UNIT_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_X_PROCESS_UNIT_DETAILS", "x-api-path-slug"=>"x-process-unit-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/X_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_X_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"x-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/X_T4CEMSDETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_X_T4CEMSDETAILS", "x-api-path-slug"=>"x-t4cemsdetailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Y_ASPHALTBLOWING_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Y_ASPHALTBLOWING_INFO", "x-api-path-slug"=>"y-asphaltblowing-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Y_CEMS_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Y_CEMS_DETAILS", "x-api-path-slug"=>"y-cems-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Y_COKECALCINER_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Y_COKECALCINER_INFO", "x-api-path-slug"=>"y-cokecalciner-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Y_CRACKINGCOKINGREFORMING_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Y_CRACKINGCOKINGREFORMING_INFO", "x-api-path-slug"=>"y-crackingcokingreforming-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Y_DELAYEDCOKING_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Y_DELAYEDCOKING_INFO", "x-api-path-slug"=>"y-delayedcoking-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Y_EMISSIONS_BY_SOURCE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Y_EMISSIONS_BY_SOURCE", "x-api-path-slug"=>"y-emissions-by-sourcerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Y_EQUIPMENTLEAK_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Y_EQUIPMENTLEAK_INFO", "x-api-path-slug"=>"y-equipmentleak-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Y_FLARE_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Y_FLARE_INFORMATION", "x-api-path-slug"=>"y-flare-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Y_LOADINGOPERATIONS_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Y_LOADINGOPERATIONS_INFO", "x-api-path-slug"=>"y-loadingoperations-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Y_PROCESSVENT_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Y_PROCESSVENT_INFO", "x-api-path-slug"=>"y-processvent-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Y_STORAGETANK_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Y_STORAGETANK_INFO", "x-api-path-slug"=>"y-storagetank-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Y_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Y_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"y-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Y_SULFURRECOVERY_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Y_SULFURRECOVERY_INFO", "x-api-path-slug"=>"y-sulfurrecovery-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Y_UNCRONTROLLEDBLOWDOWN_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Y_UNCRONTROLLEDBLOWDOWN_INFO", "x-api-path-slug"=>"y-uncrontrolledblowdown-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Z_CEMS_DETAILS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Z_CEMS_DETAILS", "x-api-path-slug"=>"z-cems-detailsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Z_CO2_CONTENT_METHOD/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Z_CO2_CONTENT_METHOD", "x-api-path-slug"=>"z-co2-content-methodrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Z_FACILITY_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Z_FACILITY_INFO", "x-api-path-slug"=>"z-facility-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Z_INFORGANIC_CARBON_CONTENT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Z_INFORGANIC_CARBON_CONTENT", "x-api-path-slug"=>"z-inforganic-carbon-contentrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Z_PHOSPH_AC_PROC_LINE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Z_PHOSPH_AC_PROC_LINE", "x-api-path-slug"=>"z-phosph-ac-proc-linerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Z_SUBPART_LEVEL_INFORMATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Z_SUBPART_LEVEL_INFORMATION", "x-api-path-slug"=>"z-subpart-level-informationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/Z_TIER4CEMS_QTRDTLS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_Z_TIER4CEMS_QTRDTLS", "x-api-path-slug"=>"z-tier4cems-qtrdtlsrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "u-s--epa-enforcement-and-compliance-history-online-echo--detailed-facility-report-dfr-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"U.S. EPA Enforcement and Compliance History Online (ECHO) - Detailed Facility Report (DFR)", "description"=>"enforcement-and-compliance-history-online-echo-is-a-tool-developed-and-maintained-by-epas-office-of-enforcement-and-compliance-assurance-for-public-use--echo-provides-integrated-compliance-and-enforcement-information-for-about-800000-regulated-facilities-nationwide-brbrdfr-rest-services-provide-multiple-service-endpoints-to-retrieve-detailed-facility-location-enforcement-compliance-monitoring-and-pollutant-information-for-any-single-facility---see-the-detailed-facility-report-dfr-help-page-httpsecho-epa-govhelpreportsdetailedfacilityreporthelp-for-additional-information-on-the-dfr---additionally-a-data-dictionary-httpsecho-epa-govhelpreportsdfrdatadictionary-is-also-available-brbrthere-is-one-primary-service-end-point-get-dfr-that-provides-all-available-dfr-data---all-other-service-end-points-that-are-exposed-will-return-data-on-a-single-section-of-the-dfr--br--bradditional-echo-resourcesnbspnbsp-a-hrefhttpsecho-epa-govtoolswebservicesweb-servicesa-a-hrefhttpsecho-epa-govresourcesechodataaboutthedataabout-echos-dataa-a-hrefhttpsecho-epa-govtoolsdatadownloadsdata-downloadsabr", "contact"=>{"name"=>"US EPA, OECA Integration, Targeting and Access Branch"}, "version"=>"0.0.0"}, "host"=>"ofmpub.epa.gov", "basePath"=>"/echo", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/dfr_rest_services.get_air_compliance"=>{"get"=>{"summary"=>"Detailed Facility Report Air Compliance Report Service", "description"=>"This procedure obtains data for Air Compliance in the Environmental Conditions Section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-air-compliance-in-the-environmental-conditions-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-air-compliance-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "Air", "Compliance", "Report", "Service"]}}, "/dfr_rest_services.get_air_quality"=>{"get"=>{"summary"=>"Detailed Facility Report Air Quality Report Service", "description"=>"This procedure obtains data for Air Quality in the Environmental Conditions Section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-air-quality-in-the-environmental-conditions-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-air-quality-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "Air", "Quality", "Report", "Service"]}}, "/dfr_rest_services.get_compliance_history"=>{"get"=>{"summary"=>"Detailed Facility Report 5 Year Compliance Monitoring History Service", "description"=>"This procedure obtains data for the Compliance Monitoring History (5 years) in the Enforcement and Compliance Section of the Detailed Facility report.", "operationId"=>"this-procedure-obtains-data-for-the-compliance-monitoring-history-5-years-in-the-enforcement-and-com", "x-api-path-slug"=>"dfr-rest-services-get-compliance-history-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "5", "Year", "Compliance", "Monitoring", "History", "Service"]}}, "/dfr_rest_services.get_compliance_summary"=>{"get"=>{"summary"=>"Detailed Facility Report Compliance Summary Service", "description"=>"This procedure obtains data for Compliance Summary Data in the Enforcement and Compliance Section of the Detailed Facility report.", "operationId"=>"this-procedure-obtains-data-for-compliance-summary-data-in-the-enforcement-and-compliance-section-of", "x-api-path-slug"=>"dfr-rest-services-get-compliance-summary-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "Compliance", "Summary", "Service"]}}, "/dfr_rest_services.get_cwa_3yr_compliance"=>{"get"=>{"summary"=>"Detailed Facility Report 3 Year CWA Facility-Level Status Service", "description"=>"This procedure obtains data for the CWA Facility-Level Status section located in the Three Year Compliance Status by Quarter portion of the DFR. Valid Compliance Statuses are as follows:\n> \"In Viol\" = Facility is in violation\n> \"No Viol\" = No violation found\n> \"Unk\" = Unknown status\n> \"SNC/Cat 1\" = SNC/Category I violation found", "operationId"=>"this-procedure-obtains-data-for-the-cwa-facilitylevel-status-section-located-in-the-three-year-compl", "x-api-path-slug"=>"dfr-rest-services-get-cwa-3yr-compliance-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "3", "Year", "CWA", "Facility-Level", "Status", "Service"]}}, "/dfr_rest_services.get_cwa_cs_compliance"=>{"get"=>{"summary"=>"Detailed Facility Report CWA CSV Compliance Service", "description"=>"This procedure obtains data for the CWA Compliance Schedule Violations section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-cwa-compliance-schedule-violations-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-cwa-cs-compliance-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "CWA", "CSV", "Compliance", "Service"]}}, "/dfr_rest_services.get_cwa_eff_alr"=>{"get"=>{"summary"=>"Detailed Facility Report CWA Effluent ALR Service", "description"=>"This procedure obtains data for the CWA Pollutant Discharge section located in the Three Year Compliance Status by Quarter portion of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-cwa-pollutant-discharge-section-located-in-the-three-year-compli", "x-api-path-slug"=>"dfr-rest-services-get-cwa-eff-alr-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "CWA", "Effluent", "ALR", "Service"]}}, "/dfr_rest_services.get_cwa_eff_compliance"=>{"get"=>{"summary"=>"Detailed Facility Report CWA Effluent Compliance Service", "description"=>"This procedure obtains data for the CWA Effluent Compliance section on the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-cwa-effluent-compliance-section-on-the-dfr---", "x-api-path-slug"=>"dfr-rest-services-get-cwa-eff-compliance-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "CWA", "Effluent", "Compliance", "Service"]}}, "/dfr_rest_services.get_cwa_ps_compliance"=>{"get"=>{"summary"=>"Detailed Facility Report CWA PSV Compliance Service", "description"=>"This procedure obtains data for the CWA Permit Schedule Violations section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-cwa-permit-schedule-violations-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-cwa-ps-compliance-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "CWA", "PSV", "Compliance", "Service"]}}, "/dfr_rest_services.get_cwa_rnc_compliance"=>{"get"=>{"summary"=>"Detailed Facility Report CWA RNC Compliance Service", "description"=>"This procedure obtains data for the CWA SNC/RNC History section located in the Three Year ompliance Status by Quarter portion of the DFR. Valid Compliance Statuses are as follows.\n> S = SNC/Category I - an enforcement action has been issued, and the facility is not meeting its compliance schedule\n> E = SNC/Category I - effluent violations of monthly average limits (Technical Review Criteria and chronic)\n> X = SNC/Category I - effluent violations of non-monthly average limits (Technical Review Criteria and chronic)\n> T = SNC/Category I - compliance schedule reporting violation\n> D = SNC/Category I - reporting violation - nonreceipt of DMR\n> N = RNC/Category II - reportable non-compliance\n> P = Resolved Pending - an enforcement action has been issued, and facility compliance with the action is pending final completion\n> R = Resolved - the facility has returned to compliance with its permit conditions, either with or without issuance of an enforcement action\n> C = Not considered in RNC/SNC based on manual review of data by state or EPA region. This manual override status is also indicated by a superscripted \"m\".\n> Blank = Not considered in RNC/SNC\n> N/A = EPA's data system is not able to determine the facility-level compliance status based upon the information available. This information may be available from a state database.", "operationId"=>"this-procedure-obtains-data-for-the-cwa-sncrnc-history-section-located-in-the-three-year-ompliance-s", "x-api-path-slug"=>"dfr-rest-services-get-cwa-rnc-compliance-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "CWA", "RNC", "Compliance", "Service"]}}, "/dfr_rest_services.get_cwa_se_compliance"=>{"get"=>{"summary"=>"Detailed Facility Report CWA SEV Compliance Service", "description"=>"This procedure obtains data for the CWA Single Event Violations section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-cwa-single-event-violations-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-cwa-se-compliance-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "CWA", "SEV", "Compliance", "Service"]}}, "/dfr_rest_services.get_demographics"=>{"get"=>{"summary"=>"Detailed Facility Report Demographics Report Service", "description"=>"Returns a complex object with Demographics from the 2010 Census and 2010 American Community Survey based on a 3 mile radius around the facility spatial coordinates.", "operationId"=>"returns-a-complex-object-with-demographics-from-the-2010-census-and-2010-american-community-survey-b", "x-api-path-slug"=>"dfr-rest-services-get-demographics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "Demographics", "Report", "Service"]}}, "/dfr_rest_services.get_dfr"=>{"get"=>{"summary"=>"Detailed Facility Report Service", "description"=>"This procedure is the overall service for the Detailed Facility Report. It returns all of the data displayed in the DFR web report by invoking individual procedures that each return a targeted portion of the DFR.", "operationId"=>"this-procedure-is-the-overall-service-for-the-detailed-facility-report--it-returns-all-of-the-data-d", "x-api-path-slug"=>"dfr-rest-services-get-dfr-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "Service"]}}, "/dfr_rest_services.get_enforcement_summary"=>{"get"=>{"summary"=>"Detailed Facility Report Enforcement Summary Service", "description"=>"This procedure obtains data for the Enforcement and Compliance Summary in the Facility Summary section of the Detailed Facility Report.", "operationId"=>"this-procedure-obtains-data-for-the-enforcement-and-compliance-summary-in-the-facility-summary-secti", "x-api-path-slug"=>"dfr-rest-services-get-enforcement-summary-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "Enforcement", "Summary", "Service"]}}, "/dfr_rest_services.get_formal_actions"=>{"get"=>{"summary"=>"Detailed Facility Report Formal Actions Service", "description"=>"This procedure obtains data for the Formal Enforcement Actions section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-formal-enforcement-actions-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-formal-actions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "Formal", "Actions", "Service"]}}, "/dfr_rest_services.get_icis_formal_actions"=>{"get"=>{"summary"=>"Detailed Facility Report ICIS Formal Actions Service", "description"=>"This procedure obtains data for the Integrated Compliance Information System, Formal Enforcement Actions section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-integrated-compliance-information-system-formal-enforcement-acti", "x-api-path-slug"=>"dfr-rest-services-get-icis-formal-actions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "ICIS", "Formal", "Actions", "Service"]}}, "/dfr_rest_services.get_inspections"=>{"get"=>{"summary"=>"Detailed Facility Report Inspections Summary Service", "description"=>"This procedure obtains data for Enforcement and Compliance Summary Section of the Detailed Facility report.", "operationId"=>"this-procedure-obtains-data-for-enforcement-and-compliance-summary-section-of-the-detailed-facility-", "x-api-path-slug"=>"dfr-rest-services-get-inspections-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "Inspections", "Summary", "Service"]}}, "/dfr_rest_services.get_map"=>{"get"=>{"summary"=>"Detailed Facility Report Map Service", "description"=>"Returns an object with the facility's latitude and longitude coordinates.", "operationId"=>"returns-an-object-with-the-facilitys-latitude-and-longitude-coordinates-", "x-api-path-slug"=>"dfr-rest-services-get-map-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "Map", "Service"]}}, "/dfr_rest_services.get_naics"=>{"get"=>{"summary"=>"Detailed Facility Report NAICS Code Service", "description"=>"This procedure obtains data for the Facility NAICS Codes section in Facility/System Characteristics of the Detailed Facility Report.", "operationId"=>"this-procedure-obtains-data-for-the-facility-naics-codes-section-in-facilitysystem-characteristics-o", "x-api-path-slug"=>"dfr-rest-services-get-naics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "NAICS", "Code", "Service"]}}, "/dfr_rest_services.get_nnnPermits"=>{"get"=>{"summary"=>"Detailed Facility Report Permits by Statute Service", "description"=>"This procedure obtains data for the Permits by Statute section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-permits-by-statute-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-nnnpermits-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "Permits", "By", "Statute", "Service"]}}, "/dfr_rest_services.get_notices"=>{"get"=>{"summary"=>"Detailed Facility Report Notices Service", "description"=>"This procedure obtains data for the Notices/Informal Actions section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-noticesinformal-actions-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-notices-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "Notices", "Service"]}}, "/dfr_rest_services.get_permits"=>{"get"=>{"summary"=>"Detailed Facility Report Permits Service", "description"=>"This procedure obtains data for the following sections of the Detailed Facility Report.\n> Facility Information (FRS) in the Facility Summary.\n> Regulatory Interests in the Facility Summary.\n> Also Reports in the Facility Summary.\n> Facility/System Characteristics in Facility/System Characteristics.\n> Facility Contact Information in Facility/System Characteristics.\n> Facility SIC Codes in Facility/System Characteristics section.\n> Facility NAICS Codes in Facility/System Characteristics section.", "operationId"=>"this-procedure-obtains-data-for-the-following-sections-of-the-detailed-facility-report--facility-inf", "x-api-path-slug"=>"dfr-rest-services-get-permits-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "Permits", "Service"]}}, "/dfr_rest_services.get_rcra_compliance"=>{"get"=>{"summary"=>"Detailed Facility Report RCRA Compliance Service", "description"=>"This procedure obtains data for the RCRA Compliance section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-rcra-compliance-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-rcra-compliance-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "RCRA", "Compliance", "Service"]}}, "/dfr_rest_services.get_sdwa_lead_and_copper"=>{"get"=>{"summary"=>"Detailed Facility Report SDWA Lead and Copper Service", "description"=>"This procedure obtains data for the SDWA, Lead and Copper Rule section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-sdwa-lead-and-copper-rule-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-sdwa-lead-and-copper-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "SDWA", "Lead", "Copper", "Service"]}}, "/dfr_rest_services.get_sdwa_sanitary_surveys"=>{"get"=>{"summary"=>"Detailed Facility Report SDWA Sanitary Surveys Service", "description"=>"This procedure obtains data for the SDWA, Sanitary Surveys section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-sdwa-sanitary-surveys-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-sdwa-sanitary-surveys-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "SDWA", "Sanitary", "Surveys", "Service"]}}, "/dfr_rest_services.get_sdwa_site_visits"=>{"get"=>{"summary"=>"Detailed Facility Report SDWA Sanitary Site Visits Service", "description"=>"This procedure obtains data for the SDWA, Sanitary Site Visits section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-sdwa-sanitary-site-visits-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-sdwa-site-visits-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "SDWA", "Sanitary", "Site", "Visits", "Service"]}}, "/dfr_rest_services.get_sdwa_violations"=>{"get"=>{"summary"=>"Detailed Facility Report SDWA Violations Service", "description"=>"This procedure obtains data for the SDWA Violations section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-sdwa-violations-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-sdwa-violations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "SDWA", "Violations", "Service"]}}, "/dfr_rest_services.get_sdwis_compliance"=>{"get"=>{"summary"=>"Detailed Facility Report SDWIS Compliance Service", "description"=>"This procedure obtains data for the SDWA Compliance section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-sdwa-compliance-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-sdwis-compliance-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "SDWIS", "Compliance", "Service"]}}, "/dfr_rest_services.get_sic_codes"=>{"get"=>{"summary"=>"Detailed Facility Report SIC Code Service", "description"=>"This procedure obtains data for the Facility SIC Codes section in Facility/System Characteristics of the Detailed Facility Report.", "operationId"=>"this-procedure-obtains-data-for-the-facility-sic-codes-section-in-facilitysystem-characteristics-of-", "x-api-path-slug"=>"dfr-rest-services-get-sic-codes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "SIC", "Code", "Service"]}}, "/dfr_rest_services.get_spatial_metadata"=>{"get"=>{"summary"=>"Detailed Facility Report Spatial Metadata Service", "description"=>"Returns an object with the facility coordinate spatial metadata.", "operationId"=>"returns-an-object-with-the-facility-coordinate-spatial-metadata-", "x-api-path-slug"=>"dfr-rest-services-get-spatial-metadata-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "Spatial", "Metadata", "Service"]}}, "/dfr_rest_services.get_tri_history"=>{"get"=>{"summary"=>"Detailed Facility Report TRI History Service", "description"=>"This procedure obtains data for the TRI History section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-tri-history-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-tri-history-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "TRI", "History", "Service"]}}, "/dfr_rest_services.get_tri_releases"=>{"get"=>{"summary"=>"Detailed Facility Report TRI Releases Service", "description"=>"This procedrue obtains data for the TRI Releases section of the DFR.", "operationId"=>"this-procedrue-obtains-data-for-the-tri-releases-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-tri-releases-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "TRI", "Releases", "Service"]}}, "/dfr_rest_services.get_tribes"=>{"get"=>{"summary"=>"Detailed Facility Report Tribes Service", "description"=>"This procedure obtains data for the Tribes and Reservations section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-tribes-and-reservations-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-tribes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "Tribes", "Service"]}}, "/dfr_rest_services.get_water_quality"=>{"get"=>{"summary"=>"Detailed Facility Report Water Quality Service", "description"=>"This procedure obtains data for the Water Quality section of the DFR.", "operationId"=>"this-procedure-obtains-data-for-the-water-quality-section-of-the-dfr-", "x-api-path-slug"=>"dfr-rest-services-get-water-quality-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Detailed", "Facility", "Report", "Water", "Quality", "Service"]}}}}, "epa-radiation-ambient-monitoring-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"EPA Radiation Ambient Monitoring API", "description"=>"formerly-environmental-radiation-ambient-monitoring-system-erams-provides-data-from-a-national-network-of-monitoring-stations-that-collect-air-precipitation-drinking-water-and-milk-samples-for-analysis-of-radioactivity-", "contact"=>{"name"=>"EP Envirofacts", "url"=>"http://www.epa.gov/enviro/index.html"}, "version"=>"v1"}, "host"=>"iaspub.epa.gov", "basePath"=>"/enviro/efservice/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/BGM_ONSITE_TREATMENT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_BGM_ONSITE_TREATMENT", "x-api-path-slug"=>"bgm-onsite-treatmentrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/ERM_ANALYSIS/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_ERM_ANALYSIS", "x-api-path-slug"=>"erm-analysisrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/ERM_ANALYTE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_ERM_ANALYTE", "x-api-path-slug"=>"erm-analyterowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/ERM_ANA_PROC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_ERM_ANA_PROC", "x-api-path-slug"=>"erm-ana-procrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/ERM_COUNT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_ERM_COUNT", "x-api-path-slug"=>"erm-countrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/ERM_DET_TYPE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_ERM_DET_TYPE", "x-api-path-slug"=>"erm-det-typerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/ERM_LOCATION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_ERM_LOCATION", "x-api-path-slug"=>"erm-locationrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/ERM_MATRIX/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_ERM_MATRIX", "x-api-path-slug"=>"erm-matrixrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/ERM_PROJECT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_ERM_PROJECT", "x-api-path-slug"=>"erm-projectrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/ERM_RESULT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_ERM_RESULT", "x-api-path-slug"=>"erm-resultrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/ERM_SAMPLE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_ERM_SAMPLE", "x-api-path-slug"=>"erm-samplerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/ERM_STUDY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_ERM_STUDY", "x-api-path-slug"=>"erm-studyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/LCR_SAMPLE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_LCR_SAMPLE", "x-api-path-slug"=>"lcr-samplerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/LCR_SAMPLE_RESULT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_LCR_SAMPLE_RESULT", "x-api-path-slug"=>"lcr-sample-resultrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "epa-permit-compliance-system-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"EPA Permit Compliance System API", "description"=>"the-permit-compliance-system-provides-information-about-facilities-that-discharge-pollutants-into-the-waterway", "contact"=>{"name"=>"EP Envirofacts", "url"=>"http://www.epa.gov/enviro/index.html"}, "version"=>"v1"}, "host"=>"iaspub.epa.gov", "basePath"=>"/enviro/efservice/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/PCS_ADMIN_PENALTY_ORDER/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_ADMIN_PENALTY_ORDER", "x-api-path-slug"=>"pcs-admin-penalty-orderrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_CMPL_SCHD/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_CMPL_SCHD", "x-api-path-slug"=>"pcs-cmpl-schdrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_CMPL_SCHD_VIOL/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_CMPL_SCHD_VIOL", "x-api-path-slug"=>"pcs-cmpl-schd-violrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_CODE_DESC/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_CODE_DESC", "x-api-path-slug"=>"pcs-code-descrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_DMR_MEASUREMENT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_DMR_MEASUREMENT", "x-api-path-slug"=>"pcs-dmr-measurementrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_EFFL_LIM/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_EFFL_LIM", "x-api-path-slug"=>"pcs-effl-limrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_EFFL_LIM_CONCENTR/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_EFFL_LIM_CONCENTR", "x-api-path-slug"=>"pcs-effl-lim-concentrrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_EFFL_LIM_QTY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_EFFL_LIM_QTY", "x-api-path-slug"=>"pcs-effl-lim-qtyrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_ENFOR_ACTION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_ENFOR_ACTION", "x-api-path-slug"=>"pcs-enfor-actionrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_EVIDENTIARY_HEARING_EVENT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_EVIDENTIARY_HEARING_EVENT", "x-api-path-slug"=>"pcs-evidentiary-hearing-eventrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_INDUSTRIAL_USER_INFO/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_INDUSTRIAL_USER_INFO", "x-api-path-slug"=>"pcs-industrial-user-inforowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_INSPECTION/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_INSPECTION", "x-api-path-slug"=>"pcs-inspectionrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_PCI_AUDIT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_PCI_AUDIT", "x-api-path-slug"=>"pcs-pci-auditrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_PERMIT_EVENT/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_PERMIT_EVENT", "x-api-path-slug"=>"pcs-permit-eventrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_PERMIT_FACILITY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_PERMIT_FACILITY", "x-api-path-slug"=>"pcs-permit-facilityrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_PERMIT_NPID/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_PERMIT_NPID", "x-api-path-slug"=>"pcs-permit-npidrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_PIPE_SCHED/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_PIPE_SCHED", "x-api-path-slug"=>"pcs-pipe-schedrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_PIPE_SCHED_LAT_LOG/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_PIPE_SCHED_LAT_LOG", "x-api-path-slug"=>"pcs-pipe-sched-lat-logrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_PRETREATMENT_PERF_SUMMARY/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_PRETREATMENT_PERF_SUMMARY", "x-api-path-slug"=>"pcs-pretreatment-perf-summaryrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_SINGLE_EVENT_VIOL/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_SINGLE_EVENT_VIOL", "x-api-path-slug"=>"pcs-single-event-violrowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/PCS_SLUDGE/ROWS/{row_start}:{row_end}/{output}"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"enviroFacts_PCS_SLUDGE", "x-api-path-slug"=>"pcs-sludgerowsrow-startrow-endoutput-get", "parameters"=>[{"in"=>"path", "name"=>"output", "description"=>"which format to output (JSON,XML,CSV,Excel)"}, {"in"=>"path", "name"=>"row_end", "description"=>"which row to end on"}, {"in"=>"path", "name"=>"row_start", "description"=>"which row to start on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"EPA Envirofacts", "x-slug"=>"epa-envirofacts", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"5166", "tags"=>"API Provider,Dead,Enterprise,Environment,Environment,Environmental database,Federal Government,General Data,Historical Data API,Profiles,Science,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"epa-envirofacts/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"EPA Air Facility System (AFS) API", "x-api-slug"=>"epa-air-facility-system-afs-api", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://iaspub.epa.gov//enviro/efservice/", "tags"=>"API Provider,Dead,Enterprise,Environment,Environment,Environmental database,Federal Government,General Data,Historical Data API,Profiles,Science,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/effrs-afssubprowsrow-startrow-endoutput-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/epa-air-facility-system-afs-api-openapi.yaml"}]}, {"name"=>"EPA Biennial Report API", "x-api-slug"=>"epa-biennial-report-api", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://iaspub.epa.gov//enviro/efservice/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/rcr-lu-waste-coderowsrow-startrow-endoutput-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/epa-biennial-report-api-openapi.yaml"}]}, {"name"=>"EPA Comprehensive Environmental Response, Compensation, and Liability Information System API", "x-api-slug"=>"epa-comprehensive-environmental-response-compensation-and-liability-information-system-api", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://iaspub.epa.gov//enviro/efservice/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/cer-wst-src-media-contaminatedrowsrow-startrow-endoutput-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/epa-comprehensive-environmental-response-compensation-and-liability-information-system-api-openapi.yaml"}]}, {"name"=>"EPA Facility Registry System API", "x-api-slug"=>"epa-facility-registry-system-api", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://iaspub.epa.gov//enviro/efservice/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/g-inforowsrow-startrow-endoutput-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/epa-facility-registry-system-api-openapi.yaml"}]}, {"name"=>"EPA Greenhouse Gas API", "x-api-slug"=>"epa-greenhouse-gas-api", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://iaspub.epa.gov//enviro/efservice/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/z-tier4cems-qtrdtlsrowsrow-startrow-endoutput-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/epa-greenhouse-gas-api-openapi.yaml"}]}, {"name"=>"EPA Integrated Grants Management System API", "x-api-slug"=>"epa-integrated-grants-management-system-api", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://iaspub.epa.gov//enviro/efservice/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/ogd-stat-authorityrowsrow-startrow-endoutput-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/epa-integrated-grants-management-system-api-openapi.yaml"}]}, {"name"=>"EPA Locational information API", "x-api-slug"=>"epa-locational-information-api", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://iaspub.epa.gov//enviro/efservice/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/v-geo-pgm-coordinate-allrowsrow-startrow-endoutput-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/epa-locational-information-api-openapi.yaml"}]}, {"name"=>"EPA Permit Compliance System API", "x-api-slug"=>"epa-permit-compliance-system-api", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://iaspub.epa.gov//enviro/efservice/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/pcs-sludgerowsrow-startrow-endoutput-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/epa-permit-compliance-system-api-openapi.yaml"}]}, {"name"=>"EPA Radiation Ambient Monitoring API", "x-api-slug"=>"epa-radiation-ambient-monitoring-api", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://iaspub.epa.gov//enviro/efservice/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/lcr-sample-resultrowsrow-startrow-endoutput-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/epa-radiation-ambient-monitoring-api-openapi.yaml"}]}, {"name"=>"EPA Radiation Information Database API", "x-api-slug"=>"epa-radiation-information-database-api", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://iaspub.epa.gov//enviro/efservice/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/rad-regulatory-progrowsrow-startrow-endoutput-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/epa-radiation-information-database-api-openapi.yaml"}]}, {"name"=>"EPA Resource Conservation and Recovery Act Information API", "x-api-slug"=>"epa-resource-conservation-and-recovery-act-information-api", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://iaspub.epa.gov//enviro/efservice/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/rc-unit-of-measurerowsrow-startrow-endoutput-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/epa-resource-conservation-and-recovery-act-information-api-openapi.yaml"}]}, {"name"=>"EPA Safe Drinking Water Information System API", "x-api-slug"=>"epa-safe-drinking-water-information-system-api", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://iaspub.epa.gov//enviro/efservice/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/water-system-facilityrowsrow-startrow-endoutput-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/epa-safe-drinking-water-information-system-api-openapi.yaml"}]}, {"name"=>"EPA Toxics Release Inventory API", "x-api-slug"=>"epa-toxics-release-inventory-api", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://iaspub.epa.gov//enviro/efservice/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/tr-facility-rcra-historyrowsrow-startrow-endoutput-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/epa-toxics-release-inventory-api-openapi.yaml"}]}, {"name"=>"U.S. EPA Enforcement and Compliance History Online (ECHO) - All Data", "x-api-slug"=>"u-s--epa-enforcement-and-compliance-history-online-echo--all-data", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://ofmpub.epa.gov//echo", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/echo-rest-services-metadata-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/u-s--epa-enforcement-and-compliance-history-online-echo--all-data-openapi.yaml"}]}, {"name"=>"U.S. EPA Enforcement and Compliance History Online (ECHO) - Clean Air Act", "x-api-slug"=>"u-s--epa-enforcement-and-compliance-history-online-echo--clean-air-act", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://ofmpub.epa.gov//echo", "tags"=>"Environment,Combined,ECHO,Metadata,Service", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/air-rest-services-metadata-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/u-s--epa-enforcement-and-compliance-history-online-echo--clean-air-act-openapi.yaml"}]}, {"name"=>"U.S. EPA Enforcement and Compliance History Online (ECHO) - Clean Water Act (CWA) Rest Services", "x-api-slug"=>"u-s--epa-enforcement-and-compliance-history-online-echo--clean-water-act-cwa-rest-services", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://ofmpub.epa.gov//echo", "tags"=>"Environment,Clean,Air,Act,Metadata,Service", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/rest-lookups-wbd-name-lu-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/u-s--epa-enforcement-and-compliance-history-online-echo--clean-water-act-cwa-rest-services-openapi.yaml"}]}, {"name"=>"U.S. EPA Enforcement and Compliance History Online (ECHO) - Detailed Facility Report (DFR)", "x-api-slug"=>"u-s--epa-enforcement-and-compliance-history-online-echo--detailed-facility-report-dfr", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://ofmpub.epa.gov//echo", "tags"=>"Environment,ECHO,WBD,Name,Lookup,Service", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/dfr-rest-services-get-water-quality-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/u-s--epa-enforcement-and-compliance-history-online-echo--detailed-facility-report-dfr-openapi.yaml"}]}, {"name"=>"U.S. EPA Enforcement and Compliance History Online (ECHO) - Effluent Charting and Reporting", "x-api-slug"=>"u-s--epa-enforcement-and-compliance-history-online-echo--effluent-charting-and-reporting", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://ofmpub.epa.gov//echo", "tags"=>"Environment,Detailed,Facility,Report,Water,Quality,Service", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/rest-lookups-cwa-parameters-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/u-s--epa-enforcement-and-compliance-history-online-echo--effluent-charting-and-reporting-openapi.yaml"}]}, {"name"=>"U.S. EPA Enforcement and Compliance History Online (ECHO) - Enforcement Case Search", "x-api-slug"=>"u-s--epa-enforcement-and-compliance-history-online-echo--enforcement-case-search", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://ofmpub.epa.gov//echo", "tags"=>"Environment,ECHO,CWA,Parameter,Lookup,Service", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/rest-lookups-icis-law-sections-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/u-s--epa-enforcement-and-compliance-history-online-echo--enforcement-case-search-openapi.yaml"}]}, {"name"=>"U.S. EPA Enforcement and Compliance History Online (ECHO) - Resource Conservation and Recovery Act ", "x-api-slug"=>"u-s--epa-enforcement-and-compliance-history-online-echo--resource-conservation-and-recovery-act-", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://ofmpub.epa.gov//echo", "tags"=>"Environment,ECHO,ICIS,Law,Sections,Lookup,Service", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/rcra-rest-services-metadata-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/u-s--epa-enforcement-and-compliance-history-online-echo--resource-conservation-and-recovery-act--openapi.yaml"}]}, {"name"=>"U.S. EPA Enforcement and Compliance History Online (ECHO) - Safe Drinking Water Act", "x-api-slug"=>"u-s--epa-enforcement-and-compliance-history-online-echo--safe-drinking-water-act", "description"=>"EPAs purpose is to ensure that: - all Americans are protected from significant risks to human health and the environment where they live, learn and work; - national efforts to reduce environmental risk are based on the best available scientifi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/773-epa-envirofacts.jpg", "humanURL"=>"http://www.epa.gov", "baseURL"=>"https://ofmpub.epa.gov//echo", "tags"=>"Environment,Resource,Conservation,Recovery,Act,(RCRA),Metadata,Service", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/epa-envirofacts/sdw-rest-services-metadata-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/epa-envirofacts/u-s--epa-enforcement-and-compliance-history-online-echo--safe-drinking-water-act-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://iaspub.epa.gov/enviro/efservice/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/us-epa"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/u-s-environmental-protection-agency"}, {"type"=>"x-developer", "url"=>"http://www.epa.gov/enviro/facts/services.html"}, {"type"=>"x-email", "url"=>"breen.barry@epa.gov"}, {"type"=>"x-email", "url"=>"stanich.ted@epa.gov"}, {"type"=>"x-email", "url"=>"brennan.thomas@epa.gov"}, {"type"=>"x-email", "url"=>"R3_RA@epa.gov"}, {"type"=>"x-email", "url"=>"dunn.alexandra@epa.gov"}, {"type"=>"x-email", "url"=>"EPA-region01-RA@epa.gov"}, {"type"=>"x-email", "url"=>"hladick.christopher@epa.gov"}, {"type"=>"x-email", "url"=>"r7actionline@epa.gov"}, {"type"=>"x-email", "url"=>"vette.alan@epa.gov"}, {"type"=>"x-email", "url"=>"baxter.lisa@epa.gov"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/EPA"}, {"type"=>"x-website", "url"=>"http://www.epa.gov"}, {"type"=>"x-website", "url"=>"http://epa.gov"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "u-s--epa-enforcement-and-compliance-history-online-echo--clean-air-act-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EPA Envirofacts", "x-complete"=>1, "info"=>{"title"=>"U.S. EPA Enforcement and Compliance History Online (ECHO) - Clean Air Act", "description"=>"enforcement-and-compliance-history-online-echo-is-a-tool-developed-and-maintained-by-epas-office-of-enforcement-and-compliance-assurance-for-public-use--echo-provides-integrated-compliance-and-enforcement-information-for-about-800000-regulated-facilities-nationwide-brbrair-rest-services-provides-multiple-service-endpoints-each-with-specific-capabilities-to-search-and-retrieve-data-on-facilities-regulated-under-the-clean-air-act-caa--the-returned-results-reflect-data-drawn-from-epas-icisair-database-brbrthe-get-facilities-get-map-get-qid-and-get-download-end-points-are-meant-to-be-used-together-while-the-enhanced-get-facility-info-end-point-is-self-contained---the-get-facility-info-end-point-returns-either-an-array-of-state-county-or-zip-clusters-with-summary-statistics-per-cluster-or-an-array-of-facilities-brbrthe-recommended-use-scenario-for-get-facilities-get-qid-get-map-and-get-downoad-isbrbrb1bnbsp-use-get-facilities-to-validate-passed-query-parameters-obtain-summary-statistics-and-to-obtain-a-query-id-qid---qids-are-time-sensitive-and-will-be-valid-for-approximately-30-minutes-brb2bnbsp-use-get-qid-with-the-returned-qid-to-paginate-through-arrays-of-facility-results-brb3bnbsp-use-get-map-with-the-returned-qid-to-zoom-inout-and-pan-on-the-clustered-and-individual-facility-coordinates-that-meet-the-qid-query-criteria-brb4bnbsp-use-get-download-with-the-returned-qid-to-generate-a-comma-separated-value-csv-file-of-facility-information-that-meets-the-qid-query-criteria-brbruse-the-qcolumns-parameter-to-customize-your-search-results---use-the-metdata-service-endpoint-for-a-list-of-available-output-objects-their-column-ids-and-their-definitions-to-help-you-build-your-customized-output--brbradditional-echo-resourcesnbspnbsp-a-hrefhttpsecho-epa-govtoolswebservicesweb-servicesa-a-hrefhttpsecho-epa-govresourcesechodataaboutthedataabout-echos-dataa-a-hrefhttpsecho-epa-govtoolsdatadownloadsdata-downloadsabr", "contact"=>{"name"=>"US EPA, OECA Integration, Targeting and Access Branch"}, "version"=>"0.0.0"}, "host"=>"ofmpub.epa.gov", "basePath"=>"/echo", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/air_rest_services.get_download"=>{"get"=>{"summary"=>"Clean Air Act Download Data Service", "description"=>"Based on the QID obtained from a get_facilities or get_facility_info query, return a comma sepated vaule (CSV) file of the facilities found.", "operationId"=>"based-on-the-qid-obtained-from-a-get-facilities-or-get-facility-info-query-return-a-comma-sepated-va", "x-api-path-slug"=>"air-rest-services-get-download-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Clean", "Air", "Act", "Download", "Data", "Service"]}}, "/air_rest_services.get_facilities"=>{"get"=>{"summary"=>"Clean Air Act Facility Search", "description"=>"Validates query search parameters and returns query identifier. Use the responseset parameter to set the page size", "operationId"=>"validates-query-search-parameters-and-returns-query-identifier---use-the-responseset-parameter-to-se", "x-api-path-slug"=>"air-rest-services-get-facilities-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Clean", "Air", "Act", "Facility", "Search"]}}, "/air_rest_services.get_facility_info"=>{"get"=>{"summary"=>"Clean Air Act Facility Enhanced Search", "description"=>"Returns either an array of Facilities or an array of Clusters that meet the specified search criteria.", "operationId"=>"returns-either-an-array-of-facilities-or-an-array-of-clusters-that-meet-the-specified-search-criteri", "x-api-path-slug"=>"air-rest-services-get-facility-info-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Clean", "Air", "Act", "Facility", "Enhanced", "Search"]}}, "/air_rest_services.get_geojson"=>{"get"=>{"summary"=>"Clean Air Act GeoJSON Service", "description"=>"Based on the QID obtained from a get_facilities or get_facility_info query, return GeoJSON of the facilities found.", "operationId"=>"based-on-the-qid-obtained-from-a-get-facilities-or-get-facility-info-query-return-geojson-of-the-fac", "x-api-path-slug"=>"air-rest-services-get-geojson-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Clean", "Air", "Act", "GeoJSON", "Service"]}}, "/air_rest_services.get_info_clusters"=>{"get"=>{"summary"=>"Clean Air Act Info Clusters Service", "description"=>"Based on the QID obtained from a clustered get_facility_info query, download cluster facility information as either a CSV or GEOJSON file.", "operationId"=>"based-on-the-qid-obtained-from-a-clustered-get-facility-info-query-download-cluster-facility-informa", "x-api-path-slug"=>"air-rest-services-get-info-clusters-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Clean", "Air", "Act", "Info", "Clusters", "Service"]}}, "/air_rest_services.get_map"=>{"get"=>{"summary"=>"Clean Air Act Map Service", "description"=>"The purpose of the GET_MAP service is to display facility coordinates and facility clusters related to a get_facilities facility query. Currently, the maximum number of coordinates returned is 500. GET_MAP performs automatic clustering at the state, county, and zip code levels to maximize the number of coordinates returned.", "operationId"=>"the-purpose-of-the-get-map-service-is-to-display-facility-coordinates-and-facility-clusters-related-", "x-api-path-slug"=>"air-rest-services-get-map-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Clean", "Air", "Act", "Map", "Service"]}}, "/air_rest_services.get_qid"=>{"get"=>{"summary"=>"Clean Air Act Search by Query ID", "description"=>"GET_QID is passed with a query ID corresponding to a previously run get_facilities query. It then returns a Facility object containing all matching facilities. The main purpose of GET_QID is for large querysets that contain multiple pages (responsesets) of output. GET_QID allows for pagination and for the selection and sorting of columns.", "operationId"=>"get-qid-is-passed-with-a-query-id-corresponding-to-a-previously-run-get-facilities-query--it-then-re", "x-api-path-slug"=>"air-rest-services-get-qid-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Clean", "Air", "Act", "Search", "By", "Query", "ID"]}}, "/air_rest_services.metadata"=>{"get"=>{"summary"=>"Clean Air Act Metadata Service", "description"=>"Returns the JSON Object Name and ColumnId for usage with the qcolumns parameter for get_qid, get_facility_info and other service endpoints.", "operationId"=>"returns-the-json-object-name-and-columnid-for-usage-with-the-qcolumns-parameter-for-get-qid-get-faci", "x-api-path-slug"=>"air-rest-services-metadata-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"Output Format Flag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment", "Clean", "Air", "Act", "Metadata", "Service"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-key-vault{"azure-key-vault-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Key Vault", "x-complete"=>1, "info"=>{"title"=>"KeyVaultManagementClient", "description"=>"the-azure-management-api-provides-a-restful-set-of-web-services-that-interact-with-azure-key-vault-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}"=>{"put"=>{"summary"=>"Vaults Create Or Update", "description"=>"Create or update a key vault in the specified subscription.", "operationId"=>"Vaults_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-keyvaultvaultsvaultname-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters to create or update the vault", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Resource Group to which the server belongs"}, {"in"=>"path", "name"=>"vaultName", "description"=>"Name of the vault"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vaults"]}, "delete"=>{"summary"=>"Vaults Delete", "description"=>"Deletes the specified Azure key vault.", "operationId"=>"Vaults_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-keyvaultvaultsvaultname-delete", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Resource Group to which the vault belongs"}, {"in"=>"path", "name"=>"vaultName", "description"=>"The name of the vault to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vaults"]}, "get"=>{"summary"=>"Vaults Get", "description"=>"Gets the specified Azure key vault.", "operationId"=>"Vaults_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-keyvaultvaultsvaultname-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Resource Group to which the vault belongs"}, {"in"=>"path", "name"=>"vaultName", "description"=>"The name of the vault"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vaults"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults"=>{"get"=>{"summary"=>"Vaults List By Resource Group", "description"=>"The List operation gets information about the vaults associated with the subscription and within the specified resource group.", "operationId"=>"Vaults_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-keyvaultvaults-get", "parameters"=>[{"in"=>"query", "name"=>"$top", "description"=>"Maximum number of results to return"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Resource Group to which the vault belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vaults Resource Group"]}}, "/subscriptions/{subscriptionId}/resources"=>{"get"=>{"summary"=>"Vaults List", "description"=>"The List operation gets information about the vaults associated with the subscription.", "operationId"=>"Vaults_List", "x-api-path-slug"=>"subscriptionssubscriptionidresources-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"query", "name"=>"$top", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"api-version", "description"=>"Azure Resource Manager Api Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vaults"]}}}}, "apis"=>{"name"=>"Azure Key Vault", "x-slug"=>"azure-key-vault", "description"=>"Azure Key Vault offers an easy, cost-effective way to safeguard keys and other secrets in the cloud by using hardware security modules (HSMs). Protect cryptographic keys and small secrets like passwords with keys stored in HSMs. For added assurance, import or generate your keys in HSMs that are certified to FIPS 140-2 level 2 and Common Criteria EAL4+ standards, so that your keys stay within the HSM boundary. Key Vault is designed so that Microsoft does not see or extract your keys. Create new keys for Dev-Test in minutes and migrate seamlessly to production keys managed by security operations. Key Vault scales to meet the demands of your cloud applications without the hassle required to provision, deploy, and manage HSMs and key management software.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-enhance-data-protection.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Authentication,Management,Microsoft,Profiles,Relative Data,Security,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-key-vault/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Key Vault API", "x-api-slug"=>"azure-key-vault-api", "description"=>"Azure Key Vault offers an easy, cost-effective way to safeguard keys and other secrets in the cloud by using hardware security modules (HSMs). Protect cryptographic keys and small secrets like passwords with keys stored in HSMs. For added assurance, import or generate your keys in HSMs that are certified to FIPS 140-2 level 2 and Common Criteria EAL4+ standards, so that your keys stay within the HSM boundary. Key Vault is designed so that Microsoft does not see or extract your keys. Create new keys for Dev-Test in minutes and migrate seamlessly to production keys managed by security operations. Key Vault scales to meet the demands of your cloud applications without the hassle required to provision, deploy, and manage HSMs and key management software.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-enhance-data-protection.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/key-vault/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Authentication,Management,Microsoft,Profiles,Relative Data,Security,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-key-vault/subscriptionssubscriptionidresources-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-key-vault/azure-key-vault-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/key-vault/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/key-vault/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/key-vault/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/key-vault/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
twitter{"twitter-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Twitter", "x-complete"=>1, "info"=>{"title"=>"Twitter", "description"=>"the-twitter-api-gives-you-programmatic-control-over-any-twitter-account-and-most-aspect-of-the-platform--allowing-developers-to-build-social-applications-that-use-the-platform-and-automate-interactions-between-users-", "version"=>"1.1"}, "host"=>"api.twitter.com", "basePath"=>"/1.1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/statuses/mentions_timeline"=>{"get"=>{"summary"=>"Mentions Timelines", "description"=>"Returns the 20 most recent mentions for the authenticating user", "operationId"=>"returns-the-20-most-recent-mentions-for-the-authenticating-user", "x-api-path-slug"=>"statusesmentions-timeline-get", "parameters"=>[{"in"=>"query", "name"=>"contributor_details", "description"=>"This parameter enhances the contributors element of the status response"}, {"in"=>"query", "name"=>"count", "description"=>"Specifies the number of tweets to try and retrieve"}, {"in"=>"query", "name"=>"include_entities", "description"=>"The entities node will be disincluded when set to false"}, {"in"=>"query", "name"=>"max_id", "description"=>"Returns results with an ID less than or equal to the specified ID"}, {"in"=>"query", "name"=>"since_id", "description"=>"Returns result with an ID greater than the specified ID"}, {"in"=>"query", "name"=>"trim_user", "description"=>"When set to either true, t or 1, each tweet returned in a timeline will include a user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Statuses"]}}, "/statuses/user_timeline.json"=>{"get"=>{"summary"=>"Show Timelines Status", "description"=>"Returns a collection of the most recent Tweets posted by the User", "operationId"=>"returns-a-collection-of-the-most-recent-tweets-posted-by-the-user", "x-api-path-slug"=>"statusesuser-timeline-json-get", "parameters"=>[{"in"=>"query", "name"=>"contributor_details", "description"=>"This paramters enhances the contributors element of the status response to include the screen_name of the contributor"}, {"in"=>"query", "name"=>"count", "description"=>"Specifies the number of tweets to try and retrieve"}, {"in"=>"query", "name"=>"exclude_replies", "description"=>"This paramters will prevent from appearing in the returned timeline"}, {"in"=>"query", "name"=>"include_rts", "description"=>"When set to false, the timeline will strip any native retweet"}, {"in"=>"query", "name"=>"max_id", "description"=>"Returns results with an ID less than or equal to the specified ID"}, {"in"=>"query", "name"=>"screen_name", "description"=>"The user screen name", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"since_id", "description"=>"Returns result with an ID greater than the specified ID"}, {"in"=>"query", "name"=>"trim_user", "description"=>"When set to either true, t or 1, each tweet returned in a timeline will include a user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Statuses"]}}, "/statuses/home_timeline"=>{"get"=>{"summary"=>"Status Timeline", "description"=>"Returns a collection of the most recent Tweets", "operationId"=>"returns-a-collection-of-the-most-recent-tweets", "x-api-path-slug"=>"statuseshome-timeline-get", "parameters"=>[{"in"=>"query", "name"=>"contributor_details", "description"=>"This paramters enhances the contributors element of the status response to include the screen_name of the contributor"}, {"in"=>"query", "name"=>"exclude_replies", "description"=>"This paramters will prevent from appearing in the returned timeline"}, {"in"=>"query", "name"=>"max_id", "description"=>"Returns results with an ID less than or equal to the specified ID"}, {"in"=>"query", "name"=>"since_id", "description"=>"Returns result with an ID greater than the specified ID"}, {"in"=>"query", "name"=>"trim_user", "description"=>"When set to either true, t or 1, each tweet returned in a timeline will include a user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Statuses"]}}, "/statuses/retweets/{id}"=>{"post"=>{"summary"=>"Show Retweets", "description"=>"Retweens a tweet", "operationId"=>"retweens-a-tweet", "x-api-path-slug"=>"statusesretweetsid-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The numerical ID of the desired status"}, {"in"=>"query", "name"=>"trim_user", "description"=>"When set to either true, t or 1, each tweet returned in a timeline will include a user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Statuses"]}}, "/statuses/show/{id}"=>{"get"=>{"summary"=>"Show Retweet", "description"=>"Retruns a single Tweet", "operationId"=>"retruns-a-single-tweet", "x-api-path-slug"=>"statusesshowid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The numerical ID of the desired status"}, {"in"=>"query", "name"=>"include_entities", "description"=>"The entities node will be disincluded when set to false"}, {"in"=>"query", "name"=>"include_my_retweet", "description"=>"When set to either true, t or 1, any Tweets returned that have been retweeted by the authenticating"}, {"in"=>"query", "name"=>"trim_user", "description"=>"When set to either true, t or 1, each tweet returned in a timeline will include a user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Tweets"]}}, "/statuses/destroy/{id}"=>{"post"=>{"summary"=>"Remove Tweet", "description"=>"Destroys the status specified by the required ID parameter", "operationId"=>"destroys-the-status-specified-by-the-required-id-parameter", "x-api-path-slug"=>"statusesdestroyid-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The numerical ID of the desired status"}, {"in"=>"query", "name"=>"trim_user", "description"=>"When set to either true, t or 1, each tweet returned in a timeline will include a user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Statuses"]}}, "/statuses/update"=>{"post"=>{"summary"=>"Update Status", "description"=>"Updates the authenticating user's status", "operationId"=>"updates-the-authenticating-users-status", "x-api-path-slug"=>"statusesupdate-post", "parameters"=>[{"in"=>"query", "name"=>"display_coordinates", "description"=>"Whether or not to put a pin on the exact coordinates a tweet"}, {"in"=>"query", "name"=>"in_reply_to_status_id", "description"=>"The ID of an existing status"}, {"in"=>"query", "name"=>"lat", "description"=>"The latitude of the location"}, {"in"=>"query", "name"=>"long", "description"=>"The longitude of the location"}, {"in"=>"query", "name"=>"place_id", "description"=>"A place in the world"}, {"in"=>"query", "name"=>"status", "description"=>"The text of your status update"}, {"in"=>"query", "name"=>"trim_user", "description"=>"When set to either true, t or 1, each tweet returned in a timeline will include a user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Statuses"]}}, "/statuses/oembed"=>{"get"=>{"summary"=>"Oembed Statuses", "description"=>"Returns information allowing the creation of an embedded representation", "operationId"=>"returns-information-allowing-the-creation-of-an-embedded-representation", "x-api-path-slug"=>"statusesoembed-get", "parameters"=>[{"in"=>"query", "name"=>"align", "description"=>"Specifies whether the embedded Tweet should be left aligned"}, {"in"=>"query", "name"=>"hide_media", "description"=>"Specifies whether the embedded tweet should automatically show the original message in the case that the embedded Tweet is a reply"}, {"in"=>"query", "name"=>"hide_thread", "description"=>"Specifies whether the embedded Tweet html should include a script element pointing to widgets"}, {"in"=>"query", "name"=>"id", "description"=>"The tweet/status id to return embed code for"}, {"in"=>"query", "name"=>"lang", "description"=>"Languages code for the rendered embed"}, {"in"=>"query", "name"=>"maxwidth", "description"=>"The maximum width in pixels that the embed should be rendered at"}, {"in"=>"query", "name"=>"related", "description"=>"A value for the TWT related parameters"}, {"in"=>"query", "name"=>"url", "description"=>"The encoded URL of the Tweet status to be embedded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Statuses"]}}, "/lists/list"=>{"get"=>{"summary"=>"List LIst", "description"=>"Return all lists the authenticating or specified user subscribes to, including their own.", "operationId"=>"return-all-lists-the-authenticating-or-specified-user-subscribes-to-including-their-own", "x-api-path-slug"=>"listslist-get", "parameters"=>[{"in"=>"query", "name"=>"screen_name", "description"=>"The screen name of the user for whom to return results for"}, {"in"=>"query", "name"=>"user_id", "description"=>"The ID of the user for whom to return results for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/lists/statuses.json"=>{"get"=>{"summary"=>"List Statuses", "description"=>"Returns a timeline of tweets authored by memebers of the specified list", "operationId"=>"returns-a-timeline-of-tweets-authored-by-memebers-of-the-specified-list", "x-api-path-slug"=>"listsstatuses-json-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Specifies the number of results to retrieve per page"}, {"in"=>"query", "name"=>"include_entities", "description"=>"Entities are ON by default"}, {"in"=>"query", "name"=>"include_rts", "description"=>"When set to either true, t or 1, the list timeline will contain native retweets in addition to the standard stream of tweets"}, {"in"=>"query", "name"=>"list_id", "description"=>"The numerical id of the list"}, {"in"=>"query", "name"=>"max_id", "description"=>"Returns results with an ID less than or equal to the specified ID"}, {"in"=>"query", "name"=>"owner_id", "description"=>"The user ID of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"owner_screen_name", "description"=>"The screen name of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"since_id", "description"=>"Returns results with an ID greater than the sepcified ID"}, {"in"=>"query", "name"=>"slug", "description"=>"You can identify a list by its slug instead of its numerical id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/lists/members/destroy"=>{"get"=>{"summary"=>"Remove User From List", "description"=>"Returns the list of memebers destroy", "operationId"=>"returns-the-list-of-memebers-destroy", "x-api-path-slug"=>"listsmembersdestroy-get", "parameters"=>[{"in"=>"query", "name"=>"list_id", "description"=>"The numerical id of the list"}, {"in"=>"query", "name"=>"owner_id", "description"=>"The is of the user who wons the list being requested by a slug"}, {"in"=>"query", "name"=>"owner_screen_name", "description"=>"The screen name of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"screen_name", "description"=>"The screen name of the user for whom to remove from the list"}, {"in"=>"query", "name"=>"slug", "description"=>"You can identify a list by its slug instrad of its numerical id"}, {"in"=>"query", "name"=>"user_id", "description"=>"The id of the user for whom to remove from the list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/lists/memberships"=>{"get"=>{"summary"=>"Get Memberships", "description"=>"Returns the lists of the specified user has been added to", "operationId"=>"returns-the-lists-of-the-specified-user-has-been-added-to", "x-api-path-slug"=>"listsmemberships-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Breaks the results into pages"}, {"in"=>"query", "name"=>"filter_to_owned_lists", "description"=>"When set to true, t or 1, will return just lists the authenticating user owns"}, {"in"=>"query", "name"=>"screen_name", "description"=>"The screen name of the user for whom to return results for"}, {"in"=>"query", "name"=>"user_id", "description"=>"The id of the user for whom to return results for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/lists/subscribers"=>{"get"=>{"summary"=>"List Subscribers", "description"=>"Returns the subscribers of the specified list", "operationId"=>"returns-the-subscribers-of-the-specified-list", "x-api-path-slug"=>"listssubscribers-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Breaks the results into pages"}, {"in"=>"query", "name"=>"include_entities", "description"=>"Wehn set to either true, t or 1"}, {"in"=>"query", "name"=>"list_id", "description"=>"The numerical id of the list"}, {"in"=>"query", "name"=>"owner_id", "description"=>"The user ID of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"owner_screen_name", "description"=>"the screen name of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"skip_status", "description"=>"When set to either true, t or 1"}, {"in"=>"query", "name"=>"slug", "description"=>"You can identify a list by its slug insted of its numerical id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/lists/subscribers/create"=>{"post"=>{"summary"=>"Add List Subscribers", "description"=>"Subscribes the authenticated user to the specified list", "operationId"=>"subscribes-the-authenticated-user-to-the-specified-list", "x-api-path-slug"=>"listssubscriberscreate-post", "parameters"=>[{"in"=>"query", "name"=>"list_id", "description"=>"The numerical id of the list"}, {"in"=>"query", "name"=>"owner_id", "description"=>"The user ID of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"owner_screen_name", "description"=>"the screen name of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"slug", "description"=>"You can identify a list being requested by a slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/lists/subscribers/show"=>{"get"=>{"summary"=>"Show List Subscribers", "description"=>"Check if the specified user is a subscriber of the specified list", "operationId"=>"check-if-the-specified-user-is-a-subscriber-of-the-specified-list", "x-api-path-slug"=>"listssubscribersshow-get", "parameters"=>[{"in"=>"query", "name"=>"include_entities", "description"=>"Wehn set to either true, t or 1"}, {"in"=>"query", "name"=>"list_id", "description"=>"The numerical id of the list"}, {"in"=>"query", "name"=>"owner_id", "description"=>"The is of the user who wons the list being requested by a slug"}, {"in"=>"query", "name"=>"owner_screen_name", "description"=>"The screen name of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"screen_name", "description"=>"The screen name of the user for whom to remove from the list"}, {"in"=>"query", "name"=>"skip_status", "description"=>"When set to either true, t or 1"}, {"in"=>"query", "name"=>"slug", "description"=>"You can identify a list being requested by a slug"}, {"in"=>"query", "name"=>"user_id", "description"=>"The id of the user for whom to remove from the list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/lists/subscribers/destroy"=>{"get"=>{"summary"=>"Remove List Subscribers", "description"=>"Returns list of subscribers destroy", "operationId"=>"returns-list-of-subscribers-destroy", "x-api-path-slug"=>"listssubscribersdestroy-get", "parameters"=>[{"in"=>"query", "name"=>"list_id", "description"=>"The numerical id of the list"}, {"in"=>"query", "name"=>"owner_id", "description"=>"The user ID of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"owner_screen_name", "description"=>"the screen name of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"slug", "description"=>"You can identify a list being requested by a slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/lists/members/create_all"=>{"get"=>{"summary"=>"Add Users to List", "description"=>"Returns lists of members create_all", "operationId"=>"returns-lists-of-members-create-all", "x-api-path-slug"=>"listsmemberscreate-all-get", "parameters"=>[{"in"=>"query", "name"=>"list_id", "description"=>"The numerical id of the list"}, {"in"=>"query", "name"=>"owner_id", "description"=>"The user ID of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"owner_screen_name", "description"=>"the screen name of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"screen_name", "description"=>"The screen name of the user for whom to remove from the list"}, {"in"=>"query", "name"=>"slug", "description"=>"You can identify a list being requested by a slug"}, {"in"=>"query", "name"=>"user_id", "description"=>"The id of the user for whom to remove from the list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/list/members/show"=>{"get"=>{"summary"=>"Show Members", "description"=>"Check if the specified user is a member of the specified list", "operationId"=>"check-if-the-specified-user-is-a-member-of-the-specified-list", "x-api-path-slug"=>"listmembersshow-get", "parameters"=>[{"in"=>"query", "name"=>"include_entities", "description"=>"Wehn set to either true, t or 1"}, {"in"=>"query", "name"=>"list_id", "description"=>"The numerical id of the list"}, {"in"=>"query", "name"=>"owner_id", "description"=>"The user ID of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"owner_screen_name", "description"=>"The screen name of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"screen_name", "description"=>"The screen name of the user for whom to remove from the list"}, {"in"=>"query", "name"=>"skip_status", "description"=>"When set to either true, t or 1"}, {"in"=>"query", "name"=>"slug", "description"=>"You can identify a list being requested by a slug"}, {"in"=>"query", "name"=>"user_id", "description"=>"The id of the user for whom to remove from the list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/list/members"=>{"get"=>{"summary"=>"Get Members", "description"=>"Returns the members of the specified list", "operationId"=>"returns-the-members-of-the-specified-list", "x-api-path-slug"=>"listmembers-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Breaks the results into pages"}, {"in"=>"query", "name"=>"include_entities", "description"=>"Wehn set to either true, t or 1"}, {"in"=>"query", "name"=>"list_id", "description"=>"The numerical id of the list"}, {"in"=>"query", "name"=>"owner_id", "description"=>"The user ID of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"owner_screen_name", "description"=>"The screen name of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"skip_status", "description"=>"When set to either true, t or 1"}, {"in"=>"query", "name"=>"slug", "description"=>"You can identify a list being requested by a slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/list/members/create"=>{"post"=>{"summary"=>"Add Member", "description"=>"Returns list of members create", "operationId"=>"returns-list-of-members-create", "x-api-path-slug"=>"listmemberscreate-post", "parameters"=>[{"in"=>"query", "name"=>"list_id", "description"=>"The numerical id of the list"}, {"in"=>"query", "name"=>"owner_id", "description"=>"The user ID of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"owner_screen_name", "description"=>"The screen name of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"screen_name", "description"=>"The screen name of the user for whom to remove from the list"}, {"in"=>"query", "name"=>"slug", "description"=>"You can identify a list being requested by a slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/lists/destroy"=>{"post"=>{"summary"=>"Destroy List", "description"=>"Returns list of destroy", "operationId"=>"returns-list-of-destroy", "x-api-path-slug"=>"listsdestroy-post", "parameters"=>[{"in"=>"query", "name"=>"list_id", "description"=>"The numerical id of the list"}, {"in"=>"query", "name"=>"owner_id", "description"=>"The user ID of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"owner_screen_name", "description"=>"The screen name of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"slug", "description"=>"You can identify a list being requested by a slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/lists/update"=>{"post"=>{"summary"=>"Update List", "description"=>"Returns lists of updates", "operationId"=>"returns-lists-of-updates", "x-api-path-slug"=>"listsupdate-post", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"The description to give the list"}, {"in"=>"query", "name"=>"list_id", "description"=>"The numerical id of the list"}, {"in"=>"query", "name"=>"mode", "description"=>"Whether your list is public or private"}, {"in"=>"query", "name"=>"name", "description"=>"The name for the list"}, {"in"=>"query", "name"=>"owner_id", "description"=>"The user ID of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"owner_screen_name", "description"=>"The screen name of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"slug", "description"=>"You can identify a list being requested by a slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/lists/create"=>{"post"=>{"summary"=>"Create List", "description"=>"Returns list of create", "operationId"=>"returns-list-of-create", "x-api-path-slug"=>"listscreate-post", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"The description to give the list"}, {"in"=>"query", "name"=>"mode", "description"=>"Whether your list is public or private"}, {"in"=>"query", "name"=>"name", "description"=>"The name for the list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/lists/show"=>{"get"=>{"summary"=>"Show LIsts", "description"=>"Returns list of show", "operationId"=>"returns-list-of-show", "x-api-path-slug"=>"listsshow-get", "parameters"=>[{"in"=>"query", "name"=>"list_id", "description"=>"The numerical id of the list"}, {"in"=>"query", "name"=>"owner_id", "description"=>"The user ID of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"owner_screen_name", "description"=>"The screen name of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"slug", "description"=>"You can identify a list being requested by a slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/lists/subscriptions"=>{"get"=>{"summary"=>"Show List Subscriptions", "description"=>"Returns list of subscriptions", "operationId"=>"returns-list-of-subscriptions", "x-api-path-slug"=>"listssubscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"The amount of results to return per page"}, {"in"=>"query", "name"=>"cursor", "description"=>"Breaks the results into pages"}, {"in"=>"query", "name"=>"screen_name", "description"=>"The screen name of the user"}, {"in"=>"query", "name"=>"user_id", "description"=>"The id of the user for whom to return results for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/list/members/destroy_all"=>{"get"=>{"summary"=>"Remove Members", "description"=>"Returns lists of destroy all", "operationId"=>"returns-lists-of-destroy-all", "x-api-path-slug"=>"listmembersdestroy-all-get", "parameters"=>[{"in"=>"query", "name"=>"list_id", "description"=>"The numerical id of the list"}, {"in"=>"query", "name"=>"owner_id", "description"=>"The user ID of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"owner_screen_name", "description"=>"The screen name of the user who owns the list being requested by a slug"}, {"in"=>"query", "name"=>"screen_name", "description"=>"The screen name of the user for whom to remove from the list"}, {"in"=>"query", "name"=>"slug", "description"=>"You can identify a list being requested by a slug"}, {"in"=>"query", "name"=>"user_id", "description"=>"The id of the user for whom to remove from the list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/direct_messages/sent"=>{"get"=>{"summary"=>"Get Sent Direct Messages", "description"=>"return 20 most recent direct messages sent", "operationId"=>"return-20-most-recent-direct-messages-sent", "x-api-path-slug"=>"direct-messagessent-get", "parameters"=>[{"in"=>"query", "name"=>"count"}, {"in"=>"query", "name"=>"include_entities"}, {"in"=>"query", "name"=>"max_id"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"since_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Messages"]}}, "/direct_messages/show"=>{"get"=>{"summary"=>"Show Direct Message", "description"=>"returns a single direct message specified by an id", "operationId"=>"returns-a-single-direct-message-specified-by-an-id", "x-api-path-slug"=>"direct-messagesshow-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"ID of direct message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Messages"]}}, "/search/tweets.json"=>{"get"=>{"summary"=>"Search Tweets", "description"=>"returns collection of relevant Tweets matching query", "operationId"=>"returns-collection-of-relevant-tweets-matching-query", "x-api-path-slug"=>"searchtweets-json-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"response will use the callback with given name"}, {"in"=>"query", "name"=>"count", "description"=>"number of tweets to return"}, {"in"=>"query", "name"=>"geocode", "description"=>"returns tweets by users located within given radius"}, {"in"=>"query", "name"=>"include_entities", "description"=>"whether or not to include entities"}, {"in"=>"query", "name"=>"lang", "description"=>"restricts tweets to a given language"}, {"in"=>"query", "name"=>"locale", "description"=>"language of query you are sending"}, {"in"=>"query", "name"=>"max_id", "description"=>"returns results with an ID less than/equal to specified ID"}, {"in"=>"query", "name"=>"q", "description"=>"URL-encoded search query of 500 characters max"}, {"in"=>"query", "name"=>"result_type", "description"=>"specifies type of search results you prefer"}, {"in"=>"query", "name"=>"since_id", "description"=>"return results with ID greater than specified"}, {"in"=>"query", "name"=>"until", "description"=>"returns tweets created before given date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Statuses"]}}, "/saved_searches/list"=>{"get"=>{"summary"=>"List Saved Searches", "description"=>"Returns the authenticated user's saved search queries", "operationId"=>"returns-the-authenticated-users-saved-search-queries", "x-api-path-slug"=>"saved-searcheslist-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Search"]}}, "/saved_searches/show/{id}"=>{"get"=>{"summary"=>"Get Saved Search", "description"=>"Retrieve the information for the saved search represented by the given id", "operationId"=>"retrieve-the-information-for-the-saved-search-represented-by-the-given-id", "x-api-path-slug"=>"saved-searchesshowid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the saved search"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Search"]}}, "/saved_searches/create"=>{"post"=>{"summary"=>"Create Saved Search", "description"=>"Create a new saved search for the authenticated user", "operationId"=>"create-a-new-saved-search-for-the-authenticated-user", "x-api-path-slug"=>"saved-searchescreate-post", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"The query of the search the user would like to save"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Search"]}}, "/saved_searches/destroy/{id}"=>{"post"=>{"summary"=>"Destroy Saved Search", "description"=>"Destroy a saved search for the authenticating user", "operationId"=>"destroy-a-saved-search-for-the-authenticating-user", "x-api-path-slug"=>"saved-searchesdestroyid-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the saved search"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Search"]}}, "/direct_messages"=>{"get"=>{"summary"=>"Get Direct Messages", "description"=>"return 20 most recent direct messages sent to user", "operationId"=>"return-20-most-recent-direct-messages-sent-to-user", "x-api-path-slug"=>"direct-messages-get", "parameters"=>[{"in"=>"query", "name"=>"include_entities", "description"=>"whether or not to include entities"}, {"in"=>"query", "name"=>"max_id", "description"=>"returns results with an ID less than/equal to specified ID"}, {"in"=>"query", "name"=>"since_id", "description"=>"return results with ID greater than specified"}, {"in"=>"query", "name"=>"skip_status", "description"=>"whether or not to include status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Messages"]}}, "/direct_messages/destroy"=>{"post"=>{"summary"=>"Remove Direct Message", "description"=>"destroys direct messages specified in required ID", "operationId"=>"destroys-direct-messages-specified-in-required-id", "x-api-path-slug"=>"direct-messagesdestroy-post", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"ID of direct message to delete"}, {"in"=>"query", "name"=>"include_entities", "description"=>"whether or not to include entities"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Messages"]}}, "/direct_messages/new"=>{"post"=>{"summary"=>"Create Direct Message", "description"=>"sends a new direct message to specified user", "operationId"=>"sends-a-new-direct-message-to-specified-user", "x-api-path-slug"=>"direct-messagesnew-post", "parameters"=>[{"in"=>"query", "name"=>"screen_name", "description"=>"screen name of user receiving message"}, {"in"=>"query", "name"=>"text", "description"=>"text of your direct message"}, {"in"=>"query", "name"=>"user_id", "description"=>"description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Messages"]}}, "/friends/ids"=>{"get"=>{"summary"=>"Get Friends", "description"=>"returns a cursored collection of user IDs followed by user", "operationId"=>"returns-a-cursored-collection-of-user-ids-followed-by-user", "x-api-path-slug"=>"friendsids-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"number of IDs to attempt retrieval of"}, {"in"=>"query", "name"=>"cursor", "description"=>"causes list of connections to be broken in pages"}, {"in"=>"query", "name"=>"screen_name", "description"=>"screen name of user for whom to return results for"}, {"in"=>"query", "name"=>"stringify_ids", "description"=>"IDs converted to strings"}, {"in"=>"query", "name"=>"user_id", "description"=>"ID of user for whom to return results for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Friends"]}}, "/followers/ids"=>{"get"=>{"summary"=>"Get Followers", "description"=>"returns a cursored collection of user IDs following the user", "operationId"=>"returns-a-cursored-collection-of-user-ids-following-the-user", "x-api-path-slug"=>"followersids-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"number of IDs to attempt retrieval of"}, {"in"=>"query", "name"=>"cursor", "description"=>"causes list of connections to be broken in pages"}, {"in"=>"query", "name"=>"screen_name", "description"=>"screen name of user for whom to return results for"}, {"in"=>"query", "name"=>"stringify_ids", "description"=>"IDs converted to strings"}, {"in"=>"query", "name"=>"user_id", "description"=>"ID of user for whom to return results for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Friends"]}}, "/friendships/incoming"=>{"get"=>{"summary"=>"Get Friend Requests", "description"=>"returns collection of IDs of users with pending follow request", "operationId"=>"returns-collection-of-ids-of-users-with-pending-follow-request", "x-api-path-slug"=>"friendshipsincoming-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"causes list of connections to be broken in pages"}, {"in"=>"query", "name"=>"stringify_ids", "description"=>"IDs converted to strings"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Friends"]}}, "/friendships/outgoing"=>{"get"=>{"summary"=>"Get Friend Requests", "description"=>"returns collection of IDs of users with pending follow request from the user", "operationId"=>"returns-collection-of-ids-of-users-with-pending-follow-request-from-the-user", "x-api-path-slug"=>"friendshipsoutgoing-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"causes list of connections to be broken in pages"}, {"in"=>"query", "name"=>"stringify_ids", "description"=>"IDs converted to strings"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Friends"]}}, "/friendships/create"=>{"post"=>{"summary"=>"Follow User", "description"=>"allows users to follow user sepcified by ID", "operationId"=>"allows-users-to-follow-user-sepcified-by-id", "x-api-path-slug"=>"friendshipscreate-post", "parameters"=>[{"in"=>"query", "name"=>"follow", "description"=>"enable notifications for target user"}, {"in"=>"query", "name"=>"screen_name", "description"=>"screen name of user for whom to befriend"}, {"in"=>"query", "name"=>"user_id", "description"=>"ID of user for whom to befriend"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Friends"]}}, "/friendships/destroy"=>{"post"=>{"summary"=>"Unfollow user", "description"=>"allows user to unfollow user psecified by ID", "operationId"=>"allows-user-to-unfollow-user-psecified-by-id", "x-api-path-slug"=>"friendshipsdestroy-post", "parameters"=>[{"in"=>"query", "name"=>"screen_name", "description"=>"screen name of user for whom to befriend"}, {"in"=>"query", "name"=>"user_id", "description"=>"ID of user for whom to befriend"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Friends"]}}, "/friendships/update"=>{"post"=>{"summary"=>"Unfollow User", "description"=>"Allows one to enable or disable settings for specified user", "operationId"=>"allows-one-to-enable-or-disable-settings-for-specified-user", "x-api-path-slug"=>"friendshipsupdate-post", "parameters"=>[{"in"=>"query", "name"=>"device", "description"=>"enable/disable device notifications for user"}, {"in"=>"query", "name"=>"retweets", "description"=>"enable/disable retweets from target user"}, {"in"=>"query", "name"=>"screen_name", "description"=>"screen name of user for whom to befriend"}, {"in"=>"query", "name"=>"user_id", "description"=>"ID of user for whom to befriend"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Friends"]}}, "/friendships/show"=>{"get"=>{"summary"=>"Get Friends", "description"=>"returns detailed info about relationship between two users", "operationId"=>"returns-detailed-info-about-relationship-between-two-users", "x-api-path-slug"=>"friendshipsshow-get", "parameters"=>[{"in"=>"query", "name"=>"source_id", "description"=>"user id of subject user"}, {"in"=>"query", "name"=>"source_screen_name", "description"=>"screen_name of subject user"}, {"in"=>"query", "name"=>"target_id", "description"=>"user id of target user"}, {"in"=>"query", "name"=>"target_screen_name", "description"=>"screen name of target user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Friends"]}}, "/account/settings"=>{"get"=>{"summary"=>"Get Account Settings", "description"=>"returns settings for user", "operationId"=>"returns-settings-for-user", "x-api-path-slug"=>"accountsettings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Account"]}, "post"=>{"summary"=>"Update Account Settings", "description"=>"updates user's settings", "operationId"=>"updates-users-settings", "x-api-path-slug"=>"accountsettings-post", "parameters"=>[{"in"=>"query", "name"=>"end_sleep_time", "description"=>"the hour that sleep time should end if enabled"}, {"in"=>"query", "name"=>"lang", "description"=>"language which Twitter should render in for the user"}, {"in"=>"query", "name"=>"sleep_time_enabled", "description"=>"enables/disables sleep time, silencing notifications"}, {"in"=>"query", "name"=>"start_sleep_time", "description"=>"the hour that sleep time should begin if enabled"}, {"in"=>"query", "name"=>"time_zone", "description"=>"timezone dates and times should be displayed in"}, {"in"=>"query", "name"=>"trend_location_woeid", "description"=>"the Yahoo! Where On Earth ID to user as defaul tend location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Account"]}}, "/account/update_delivery_device"=>{"post"=>{"summary"=>"Update Account Deliver Service", "description"=>"sets which device Twitter delivers updates to for user", "operationId"=>"sets-which-device-twitter-delivers-updates-to-for-user", "x-api-path-slug"=>"accountupdate-delivery-device-post", "parameters"=>[{"in"=>"query", "name"=>"device", "description"=>"must be one of sms, none"}, {"in"=>"query", "name"=>"include_entities", "description"=>"whether or not to include entities"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Account"]}}, "/account/update_profile"=>{"post"=>{"summary"=>"Update Profile", "description"=>"sets values that users ar eable to set under Account tab", "operationId"=>"sets-values-that-users-ar-eable-to-set-under-account-tab", "x-api-path-slug"=>"accountupdate-profile-post", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"a description of user owning account"}, {"in"=>"query", "name"=>"include_entities", "description"=>"whether or not to include entities"}, {"in"=>"query", "name"=>"location", "description"=>"city or country describing where user of account is"}, {"in"=>"query", "name"=>"name", "description"=>"full name of profile"}, {"in"=>"query", "name"=>"skip_status", "description"=>"whether or not to include statuses in response"}, {"in"=>"query", "name"=>"url", "description"=>"url associated with profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Account"]}}, "/account/update_profile_background_image"=>{"post"=>{"summary"=>"Update Profile Background Image", "description"=>"updates user's profile background image", "operationId"=>"updates-users-profile-background-image", "x-api-path-slug"=>"accountupdate-profile-background-image-post", "parameters"=>[{"in"=>"formData", "name"=>"file", "description"=>"image to replace background image of profile"}, {"in"=>"query", "name"=>"include_entities", "description"=>"whether or not to include entities"}, {"in"=>"query", "name"=>"skip_status", "description"=>"whether or not to include status in returned user objects"}, {"in"=>"query", "name"=>"tile", "description"=>"whether or not to tile background image"}, {"in"=>"query", "name"=>"use", "description"=>"display background image or not"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Account"]}}, "/account/update_profile_colors"=>{"post"=>{"summary"=>"Update Profile Colors", "description"=>"sets one or more hex values that controls color scheme", "operationId"=>"sets-one-or-more-hex-values-that-controls-color-scheme", "x-api-path-slug"=>"accountupdate-profile-colors-post", "parameters"=>[{"in"=>"query", "name"=>"include_entities", "description"=>"whether or not to include entities"}, {"in"=>"query", "name"=>"profile_background_color", "description"=>"profile background color"}, {"in"=>"query", "name"=>"profile_link_color", "description"=>"profile link color"}, {"in"=>"query", "name"=>"profile_sidebar_border_color", "description"=>"profile sidebars border color"}, {"in"=>"query", "name"=>"profile_sidebar_fill_color", "description"=>"profiles sidebar background color"}, {"in"=>"query", "name"=>"profile_text_color", "description"=>"profile text color"}, {"in"=>"query", "name"=>"skip_status", "description"=>"whether or not to include statuses"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Account"]}}, "/account/update_profile_image"=>{"post"=>{"summary"=>"Update Profile Image", "description"=>"updates user's profile image", "operationId"=>"updates-users-profile-image", "x-api-path-slug"=>"accountupdate-profile-image-post", "parameters"=>[{"in"=>"formData", "name"=>"image", "description"=>"image to be set as profile image"}, {"in"=>"query", "name"=>"skip_status", "description"=>"whether or not to include statuses"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Account"]}}, "/blocks/list"=>{"get"=>{"summary"=>"Block List", "description"=>"disallows retweets and device notifications from a user", "operationId"=>"disallows-retweets-and-device-notifications-from-a-user", "x-api-path-slug"=>"blockslist-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"breaks block of user to be broken up into pages"}, {"in"=>"query", "name"=>"include_entities", "description"=>"whether or not to include entities"}, {"in"=>"query", "name"=>"skip_status", "description"=>"whether or not to include statuses in response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Block"]}}, "/blocks/ids"=>{"get"=>{"summary"=>"Block Users", "description"=>"returns array of numeric user ids of blocked users", "operationId"=>"returns-array-of-numeric-user-ids-of-blocked-users", "x-api-path-slug"=>"blocksids-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"breaks up block of user IDs into pages"}, {"in"=>"query", "name"=>"stringify_ids", "description"=>"returns array of numeric IDs as string IDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Block"]}}, "/blocks/create"=>{"post"=>{"summary"=>"Block User", "description"=>"blocks the specified user", "operationId"=>"blocks-the-specified-user", "x-api-path-slug"=>"blockscreate-post", "parameters"=>[{"in"=>"query", "name"=>"include_entities", "description"=>"whether or not to include entities"}, {"in"=>"query", "name"=>"screen_name", "description"=>"screen name of user to be blocked"}, {"in"=>"query", "name"=>"skip_status", "description"=>"whether or not to skip statuses"}, {"in"=>"query", "name"=>"user_id", "description"=>"ID of user to be blocked"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Block"]}}, "/blocks/destroy"=>{"post"=>{"summary"=>"Unblock User", "description"=>"un-blocks the specified user", "operationId"=>"unblocks-the-specified-user", "x-api-path-slug"=>"blocksdestroy-post", "parameters"=>[{"in"=>"query", "name"=>"include_entities", "description"=>"whether or not to include entities"}, {"in"=>"query", "name"=>"screen_name", "description"=>"screen name of user to be un-blocked"}, {"in"=>"query", "name"=>"skip_status", "description"=>"whether or not to skip statuses"}, {"in"=>"query", "name"=>"user_id", "description"=>"ID of user to be un-blocked"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Block"]}}, "/users/lookup"=>{"get"=>{"summary"=>"User Lookup", "description"=>"returns fully-hydrated user objects up to 100", "operationId"=>"returns-fullyhydrated-user-objects-up-to-100", "x-api-path-slug"=>"userslookup-get", "parameters"=>[{"in"=>"query", "name"=>"include_entities", "description"=>"whether or not to include entities"}, {"in"=>"query", "name"=>"screen_name", "description"=>"screen name of user to lookup"}, {"in"=>"query", "name"=>"user_id", "description"=>"ID of user to lookup"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Users"]}}, "/users/show"=>{"get"=>{"summary"=>"Show User", "description"=>"returns a variety of info about specified user", "operationId"=>"returns-a-variety-of-info-about-specified-user", "x-api-path-slug"=>"usersshow-get", "parameters"=>[{"in"=>"query", "name"=>"include_entities", "description"=>"whether or not to include entities"}, {"in"=>"query", "name"=>"screen_name", "description"=>"screen name of user to be shown"}, {"in"=>"query", "name"=>"user_id", "description"=>"ID of user to be shown"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Users"]}}, "/users/search.json"=>{"get"=>{"summary"=>"User Search", "description"=>"simple relevance-based user search", "operationId"=>"simple-relevancebased-user-search", "x-api-path-slug"=>"userssearch-json-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"number of people to return per page"}, {"in"=>"query", "name"=>"include_entities", "description"=>"whether or not to include entities"}, {"in"=>"query", "name"=>"page", "description"=>"specifies the page of results to receive"}, {"in"=>"query", "name"=>"q", "description"=>"the search query to run against people search"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Users"]}}, "/users/contributees"=>{"get"=>{"summary"=>"User Contributees", "description"=>"collection of users specified user can contribute to", "operationId"=>"collection-of-users-specified-user-can-contribute-to", "x-api-path-slug"=>"userscontributees-get", "parameters"=>[{"in"=>"query", "name"=>"include_entities", "description"=>"whether or not to include entities"}, {"in"=>"query", "name"=>"screen_name", "description"=>"screen name of user that is contributed to"}, {"in"=>"query", "name"=>"skip_status", "description"=>"whether or not to skip statuses"}, {"in"=>"query", "name"=>"user_id", "description"=>"ID of user to that is contributed to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Users"]}}, "/users/contributors"=>{"get"=>{"summary"=>"User Contributors", "description"=>"collection of users that can contribute to specified account", "operationId"=>"collection-of-users-that-can-contribute-to-specified-account", "x-api-path-slug"=>"userscontributors-get", "parameters"=>[{"in"=>"query", "name"=>"include_entities", "description"=>"whether or not to include entities"}, {"in"=>"query", "name"=>"screen_name", "description"=>"screen name of user contributing"}, {"in"=>"query", "name"=>"skip_status", "description"=>"whether or not to skip statuses"}, {"in"=>"query", "name"=>"user_id", "description"=>"ID of user contributing"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Users"]}}, "/geo/id/{place_id}"=>{"get"=>{"summary"=>"Get Place", "description"=>"Returns all the information about a know place", "operationId"=>"returns-all-the-information-about-a-know-place", "x-api-path-slug"=>"geoidplace-id-get", "parameters"=>[{"in"=>"path", "name"=>"place_id", "description"=>"A place in the world"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places"]}}, "/geo/reverse_geoncode"=>{"get"=>{"summary"=>"Get Lat / Log", "description"=>"Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updatting a status", "operationId"=>"given-a-latitude-and-a-longitude-searches-for-up-to-20-places-that-can-be-used-as-a-place-id-when-up", "x-api-path-slug"=>"georeverse-geoncode-get", "parameters"=>[{"in"=>"query", "name"=>"accuracy", "description"=>"A hint on region in which to search"}, {"in"=>"query", "name"=>"callback", "description"=>"If supplied, the responses will use the JSON format with a callback of the given name"}, {"in"=>"query", "name"=>"granularity", "description"=>"This is the minimal granularity of place types to return"}, {"in"=>"query", "name"=>"lat", "description"=>"The latitude to search around"}, {"in"=>"query", "name"=>"long", "description"=>"The longtitude to search around"}, {"in"=>"query", "name"=>"max_results", "description"=>"A hint as to the number of results to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "Search"]}}, "/geo/search"=>{"get"=>{"summary"=>"Geo Search", "description"=>"Search for places that can be attached to a statuses/updates", "operationId"=>"search-for-places-that-can-be-attached-to-a-statusesupdates", "x-api-path-slug"=>"geosearch-get", "parameters"=>[{"in"=>"query", "name"=>"accuracy", "description"=>"A hint on region in which to search"}, {"in"=>"query", "name"=>"attribute:street_address", "description"=>"This parameter searches for places which have this givven street address"}, {"in"=>"query", "name"=>"callback", "description"=>"If supplied, the responses will use the JSON format with a callback of the given name"}, {"in"=>"query", "name"=>"contained_within", "description"=>"This is the place_id which you would like to restrict the search results to"}, {"in"=>"query", "name"=>"granularity", "description"=>"This is the minimal granularity of place types to return"}, {"in"=>"query", "name"=>"ip", "description"=>"An Ip address"}, {"in"=>"query", "name"=>"lat", "description"=>"The latitude to search around"}, {"in"=>"query", "name"=>"long", "description"=>"The longtitude to search around"}, {"in"=>"query", "name"=>"query", "description"=>"Free-form text to match against while executing a geo-based query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "Similar"]}}, "/geo/similar_places"=>{"get"=>{"summary"=>"Get Similar Places", "description"=>"Locates places near the given coordinates which are similar in name", "operationId"=>"locates-places-near-the-given-coordinates-which-are-similar-in-name", "x-api-path-slug"=>"geosimilar-places-get", "parameters"=>[{"in"=>"query", "name"=>"attribute:street_address", "description"=>"This parameter searches for places which have this givven street address"}, {"in"=>"query", "name"=>"callback", "description"=>"If supplied, the responses will use the JSON format with a callback of the given name"}, {"in"=>"query", "name"=>"contained_within", "description"=>"This is the place_id which you would like to restrict the search results to"}, {"in"=>"query", "name"=>"lat", "description"=>"The latitude to search around"}, {"in"=>"query", "name"=>"long", "description"=>"The longtitude to search around"}, {"in"=>"query", "name"=>"name", "description"=>"The name a place is known as"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "Similar"]}}, "/geo/places"=>{"get"=>{"summary"=>"Get Places", "description"=>"Create a new place object at the given latitude and logitude", "operationId"=>"create-a-new-place-object-at-the-given-latitude-and-logitude", "x-api-path-slug"=>"geoplaces-get", "parameters"=>[{"in"=>"query", "name"=>"attribute:street_address", "description"=>"This parameter searches for places which have this givven street address"}, {"in"=>"query", "name"=>"callback", "description"=>"If supplied, the responses will use the JSON format with a callback of the given name"}, {"in"=>"query", "name"=>"contained_within", "description"=>"This is the place_id which you would like to restrict the search results to"}, {"in"=>"query", "name"=>"lat", "description"=>"The latitude to search around"}, {"in"=>"query", "name"=>"long", "description"=>"The longtitude to search around"}, {"in"=>"query", "name"=>"name", "description"=>"The name a place is known as"}, {"in"=>"query", "name"=>"token", "description"=>"The token found in the response from geo/similar_places"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places"]}}, "/trends/place.json"=>{"get"=>{"summary"=>"Show Place Trends", "description"=>"Returns the top 10 trending topics for a specific WOEID", "operationId"=>"returns-the-top-10-trending-topics-for-a-specific-woeid", "x-api-path-slug"=>"trendsplace-json-get", "parameters"=>[{"in"=>"query", "name"=>"exclude", "description"=>"Setting this equal to hashtages will remove all hashtages from the trends list"}, {"in"=>"query", "name"=>"id", "description"=>"The yahoo where on earch id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Trends"]}}, "/trends/available.json"=>{"get"=>{"summary"=>"Show Available Trends", "description"=>"Returns the availability", "operationId"=>"returns-the-availability", "x-api-path-slug"=>"trendsavailable-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Trends"]}}, "/trends/closest.json"=>{"get"=>{"summary"=>"Show Closes Trends", "description"=>"Returns the location that Twitter has trending topic information for", "operationId"=>"returns-the-location-that-twitter-has-trending-topic-information-for", "x-api-path-slug"=>"trendsclosest-json-get", "parameters"=>[{"in"=>"query", "name"=>"lat", "description"=>"If provided with a long parameter the available trend locations wil be stored by distance"}, {"in"=>"query", "name"=>"long", "description"=>"If provided with a lat parameters the available trend locations will be sorted by distance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Trends"]}}, "/users/report_spam"=>{"post"=>{"summary"=>"Report User Spam", "description"=>"Returna users report spam", "operationId"=>"returna-users-report-spam", "x-api-path-slug"=>"usersreport-spam-post", "parameters"=>[{"in"=>"query", "name"=>"screen_name", "description"=>"The ID or screen_name of the user you want to report as a spammer"}, {"in"=>"query", "name"=>"user_id", "description"=>"The ID of the user you want to report as a spammer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Users", "Spam"]}}, "/help/configuration"=>{"get"=>{"summary"=>"Help Configuration", "description"=>"Returns the current configuration used by Twitter including twitter.com slugs which are not usernames", "operationId"=>"returns-the-current-configuration-used-by-twitter-including-twittercom-slugs-which-are-not-usernames", "x-api-path-slug"=>"helpconfiguration-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Help", "Configuration"]}}, "/help/languages"=>{"get"=>{"summary"=>"Help Langues", "description"=>"Returns the list of languages supported by Twitter along with the language code supported by Twitter", "operationId"=>"returns-the-list-of-languages-supported-by-twitter-along-with-the-language-code-supported-by-twitter", "x-api-path-slug"=>"helplanguages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Languages"]}}, "/help/privacy"=>{"get"=>{"summary"=>"Help Privacy", "description"=>"Returns Twitter's privacy policy", "operationId"=>"returns-twitters-privacy-policy", "x-api-path-slug"=>"helpprivacy-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Terms of Service"]}}, "/help/tos"=>{"get"=>{"summary"=>"Help Terms of Services", "description"=>"Returns the Twitter Terms of Service", "operationId"=>"returns-the-twitter-terms-of-service", "x-api-path-slug"=>"helptos-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social", "Lists"]}}, "/application/rate_limit_status"=>{"get"=>{"summary"=>"Get Rate Limit Sttaus", "description"=>"Returns the current rate limits for methods belonging to the specified resource families", "operationId"=>"returns-the-current-rate-limits-for-methods-belonging-to-the-specified-resource-families", "x-api-path-slug"=>"applicationrate-limit-status-get", "parameters"=>[{"in"=>"query", "name"=>"resources", "description"=>"A comma-separated list of resource families you want to know the current rate limit disposition for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rate Limit"]}}}}, "apis"=>{"name"=>"Twitter", "x-slug"=>"twitter", "description"=>"From breaking news and entertainment to sports and politics, get the full story with all the live commentary.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/twitter-logo.png", "x-kinRank"=>"9", "x-alexaRank"=>"12", "tags"=>"API LIfeyclessss,General Data,Historical Data API,Imports,Indie EdTech Data Jam,internet,Mobile,My API Stack,Pedestal,Relative Data,Relative StreamRank,Service API,Social,Social,Social,Social Networks,Stack,Stack Network,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"twitter/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Twitter", "x-api-slug"=>"twitter", "description"=>"From breaking news and entertainment to sports and politics, get the full story with all the live commentary.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/twitter-logo.png", "humanURL"=>"https://twitter.com/", "baseURL"=>"https://api.twitter.com//1.1", "tags"=>"API LIfeyclessss,General Data,Historical Data API,Imports,Indie EdTech Data Jam,internet,Mobile,My API Stack,Pedestal,Relative Data,Relative StreamRank,Service API,Social,Social,Social,Social Networks,Stack,Stack Network,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/twitter/applicationrate-limit-status-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/twitter/twitter-openapi.yaml"}]}], "x-common"=>[{"type"=>"x--net-library", "url"=>"https://tweetinvi.codeplex.com/"}, {"type"=>"x-advertising-development-kit", "url"=>"https://docs.fabric.io/unity/mopub/overview.html"}, {"type"=>"x-android-sdk", "url"=>"https://docs.fabric.io/android/fabric/overview.html"}, {"type"=>"x-apple-sdk", "url"=>"https://docs.fabric.io/apple/fabric/overview.html"}, {"type"=>"x-application-management", "url"=>"https://apps.twitter.com/"}, {"type"=>"x-application-only-authentication", "url"=>"https://dev.twitter.com/oauth/application-only"}, {"type"=>"x-authentication", "url"=>"https://dev.twitter.com/oauth"}, {"type"=>"x-authentication-overview", "url"=>"https://dev.twitter.com/oauth/overview"}, {"type"=>"x-base", "url"=>"https://api.twitter.com"}, {"type"=>"x-best-practices", "url"=>"https://dev.twitter.com/overview/general"}, {"type"=>"x-beta", "url"=>"https://docs.fabric.io/unity/beta/overview.html"}, {"type"=>"x-branding", "url"=>"https://brand.twitter.com/"}, {"type"=>"x-branding", "url"=>"https://dev.twitter.com/overview/terms/display-requirements"}, {"type"=>"x-branding", "url"=>"https://about.twitter.com/company/brand-assets"}, {"type"=>"x-case-studies", "url"=>"https://dev.twitter.com/overview/case-studies"}, {"type"=>"x-change-log", "url"=>"https://dev.twitter.com/ads/overview/recent-changes"}, {"type"=>"x-code-libraries", "url"=>"https://dev.twitter.com/overview/api/twitter-libraries"}, {"type"=>"x-coldfusion-library", "url"=>"http://monkehtweet.riaforge.org/"}, {"type"=>"x-console", "url"=>"http://dev.twitter.com/rest/tools/console"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/twitter"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/twitter"}, {"type"=>"x-css-control", "url"=>"https://dev.twitter.com/web/overview/css"}, {"type"=>"x-developer", "url"=>"https://developer.twitter.com/"}, {"type"=>"x-blog", "url"=>"https://dev.twitter.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"https://blog.twitter.com/api/blog.rss?name=developer"}, {"type"=>"x-documentation", "url"=>"https://dev.twitter.com/overview/documentation"}, {"type"=>"x-email", "url"=>"copyright@twitter.com"}, {"type"=>"x-embeddable", "url"=>"https://dev.twitter.com/web/overview"}, {"type"=>"x-encryption", "url"=>"https://dev.twitter.com/overview/api/tls"}, {"type"=>"x-blog", "url"=>"https://blog.twitter.com/engineering"}, {"type"=>"x-blog-rss", "url"=>"https://blog.twitter.com/api/blog.rss?name=engineering"}, {"type"=>"x-error-codes", "url"=>"https://dev.twitter.com/overview/api/response-codes"}, {"type"=>"x-events", "url"=>"https://dev.twitter.com/overview/events"}, {"type"=>"x-forum", "url"=>"https://twittercommunity.com/"}, {"type"=>"x-forum", "url"=>"https://twittercommunity.com/c/fabric"}, {"type"=>"x-geo-guidelines", "url"=>"https://dev.twitter.com/overview/terms/geo-developer-guidelines"}, {"type"=>"x-github", "url"=>"https://github.com/twitter"}, {"type"=>"x-go-library", "url"=>"https://github.com/kurrik/twittergo"}, {"type"=>"x-internationalization", "url"=>"https://dev.twitter.com/overview/general/adding-international-support-to-your-apps"}, {"type"=>"x-java-library", "url"=>"https://www.github.com/twitter/hbc"}, {"type"=>"x-node-js-library", "url"=>"https://github.com/BoyCook/TwitterJSClient"}, {"type"=>"x-oembed", "url"=>"https://dev.twitter.com/web/embedded-timelines/oembed"}, {"type"=>"x-partners", "url"=>"https://dev.twitter.com/overview/general/official-partner-program"}, {"type"=>"x-php-library", "url"=>"https://github.com/abraham/twitteroauth"}, {"type"=>"x-pin-based-authorization", "url"=>"https://dev.twitter.com/oauth/pin-based"}, {"type"=>"x-blog", "url"=>"https://blog.twitter.com/"}, {"type"=>"x-blog-rss", "url"=>"https://blog.twitter.com/api/blog.rss?name=company"}, {"type"=>"x-privacy", "url"=>"https://twitter.com/privacy?lang=en"}, {"type"=>"x-python-library", "url"=>"https://github.com/bear/python-twitter"}, {"type"=>"x-rate-limits", "url"=>"https://dev.twitter.com/rest/public/rate-limiting"}, {"type"=>"x-rate-limits-chart", "url"=>"https://dev.twitter.com/rest/public/rate-limits"}, {"type"=>"x-road-map", "url"=>"https://dev.twitter.com/ads/overview/upcoming-changes"}, {"type"=>"x-ruby-library", "url"=>"https://github.com/sferik/twitter"}, {"type"=>"x-schema", "url"=>"https://dev.twitter.com/overview/api/entities-in-twitter-objects"}, {"type"=>"x-security", "url"=>"https://dev.twitter.com/overview/general/security-best-practices"}, {"type"=>"x-statistics", "url"=>"https://docs.fabric.io/unity/answers/overview.html"}, {"type"=>"x-status", "url"=>"https://dev.twitter.com/overview/status"}, {"type"=>"x-streaming", "url"=>"https://dev.twitter.com/streaming/overview"}, {"type"=>"x-support", "url"=>"https://support.twitter.com/"}, {"type"=>"x-terms-of-service", "url"=>"https://dev.twitter.com/overview/terms"}, {"type"=>"x-transparency-report", "url"=>"https://transparency.twitter.com/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Twitter"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/twitterapi/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/twittereng/"}, {"type"=>"x-website", "url"=>"https://twitter.com/"}, {"type"=>"x-wordpress", "url"=>"https://dev.twitter.com/web/wordpress"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-simple-queue-service{"aws-simple-queue-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Simple Queue Service", "x-complete"=>1, "info"=>{"title"=>"AWS Simple Queue Service API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddPermission"=>{"get"=>{"summary"=>"Add Permission", "description"=>"Adds a permission to a queue for a specific.", "operationId"=>"addPermission", "x-api-path-slug"=>"actionaddpermission-get", "parameters"=>[{"in"=>"query", "name"=>"ActionName.N", "description"=>"The action the client wants to allow for the specified principal", "type"=>"string"}, {"in"=>"query", "name"=>"AWSAccountId.N", "description"=>"The AWS account number of the principal who is given permission", "type"=>"string"}, {"in"=>"query", "name"=>"Label", "description"=>"The unique identification of the permission youre setting (for example, AliceSendMessage)", "type"=>"string"}, {"in"=>"query", "name"=>"QueueUrl", "description"=>"The URL of the Amazon SQS queue to which permissions are added", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permissions"]}}, "/?Action=ChangeMessageVisibility"=>{"get"=>{"summary"=>"Change Message Visibility", "description"=>"Changes the visibility timeout of a specified message in a queue to a new value.", "operationId"=>"changeMessageVisibility", "x-api-path-slug"=>"actionchangemessagevisibility-get", "parameters"=>[{"in"=>"query", "name"=>"QueueUrl", "description"=>"The URL of the Amazon SQS queue whose messages visibility is changed", "type"=>"string"}, {"in"=>"query", "name"=>"ReceiptHandle", "description"=>"The receipt handle associated with the message whose visibility timeout is changed", "type"=>"string"}, {"in"=>"query", "name"=>"VisibilityTimeout", "description"=>"The new value for the messages visibility timeout (in seconds)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message Visibility"]}}, "/?Action=ChangeMessageVisibilityBatch"=>{"get"=>{"summary"=>"Change Message Visibility Batch", "description"=>"Changes the visibility timeout of multiple messages.", "operationId"=>"changeMessageVisibilityBatch", "x-api-path-slug"=>"actionchangemessagevisibilitybatch-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeMessageVisibilityBatchRequestEntry.N", "description"=>"A list of receipt handles of the messages for which the visibility timeout must be changed", "type"=>"string"}, {"in"=>"query", "name"=>"QueueUrl", "description"=>"The URL of the Amazon SQS queue whose messages visibility is changed", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message Visibility"]}}, "/?Action=CreateQueue"=>{"get"=>{"summary"=>"Create Queue", "description"=>"Creates a new standard or FIFO queue or returns the URL of an existing queue.", "operationId"=>"createQueue", "x-api-path-slug"=>"actioncreatequeue-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute\n , Attribute.N.Name (key), Attribute.N.Value (value)", "description"=>"A map of attributes with their corresponding values", "type"=>"string"}, {"in"=>"query", "name"=>"QueueName", "description"=>"The name of the new queue", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues"]}}, "/?Action=DeleteMessage"=>{"get"=>{"summary"=>"Delete Message", "description"=>"Deletes the specified message from the specified queue.", "operationId"=>"deleteMessage", "x-api-path-slug"=>"actiondeletemessage-get", "parameters"=>[{"in"=>"query", "name"=>"QueueUrl", "description"=>"The URL of the Amazon SQS queue from which messages are deleted", "type"=>"string"}, {"in"=>"query", "name"=>"ReceiptHandle", "description"=>"The receipt handle associated with the message to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages"]}}, "/?Action=DeleteMessageBatch"=>{"get"=>{"summary"=>"Delete Message Batch", "description"=>"Deletes up to ten messages from the specified queue.", "operationId"=>"deleteMessageBatch", "x-api-path-slug"=>"actiondeletemessagebatch-get", "parameters"=>[{"in"=>"query", "name"=>"DeleteMessageBatchRequestEntry.N", "description"=>"A list of receipt handles for the messages to be deleted", "type"=>"string"}, {"in"=>"query", "name"=>"QueueUrl", "description"=>"The URL of the Amazon SQS queue from which messages are deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages"]}}, "/?Action=DeleteQueue"=>{"get"=>{"summary"=>"Delete Queue", "description"=>"Deletes the queue specified by the QueueUrl, even if the queue is empty.", "operationId"=>"deleteQueue", "x-api-path-slug"=>"actiondeletequeue-get", "parameters"=>[{"in"=>"query", "name"=>"QueueUrl", "description"=>"The URL of the Amazon SQS queue to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues"]}}, "/?Action=GetQueueAttributes"=>{"get"=>{"summary"=>"Get Queue Attributes", "description"=>"Gets attributes for the specified queue.", "operationId"=>"getQueueAttributes", "x-api-path-slug"=>"actiongetqueueattributes-get", "parameters"=>[{"in"=>"query", "name"=>"AttributeName.N", "description"=>"A list of attributes for which to retrieve information", "type"=>"string"}, {"in"=>"query", "name"=>"QueueUrl", "description"=>"The URL of the Amazon SQS queue whose attribute information is retrieved", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues"]}}, "/?Action=GetQueueUrl"=>{"get"=>{"summary"=>"Get Queue Url", "description"=>"Returns the URL of an existing queue.", "operationId"=>"getQueueUrl", "x-api-path-slug"=>"actiongetqueueurl-get", "parameters"=>[{"in"=>"query", "name"=>"QueueName", "description"=>"The name of the queue whose URL must be fetched", "type"=>"string"}, {"in"=>"query", "name"=>"QueueOwnerAWSAccountId", "description"=>"The AWS account ID of the account that created the queue", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues"]}}, "/?Action=ListDeadLetterSourceQueues"=>{"get"=>{"summary"=>"List Dead Letter Source Queues", "description"=>"Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.", "operationId"=>"listDeadLetterSourceQueues", "x-api-path-slug"=>"actionlistdeadlettersourcequeues-get", "parameters"=>[{"in"=>"query", "name"=>"QueueUrl", "description"=>"The URL of a dead letter queue", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues"]}}, "/?Action=ListQueues"=>{"get"=>{"summary"=>"List Queues", "description"=>"Returns a list of your queues.", "operationId"=>"listQueues", "x-api-path-slug"=>"actionlistqueues-get", "parameters"=>[{"in"=>"query", "name"=>"QueueNamePrefix", "description"=>"A string to use for filtering the list results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues"]}}, "/?Action=PurgeQueue"=>{"get"=>{"summary"=>"Purge Queue", "description"=>"Deletes the messages in a queue specified by the QueueURL parameter.", "operationId"=>"purgeQueue", "x-api-path-slug"=>"actionpurgequeue-get", "parameters"=>[{"in"=>"query", "name"=>"QueueUrl", "description"=>"The URL of the queue from which the PurgeQueue action deletes messages", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues"]}}, "/?Action=ReceiveMessage"=>{"get"=>{"summary"=>"Receive Message", "description"=>"Retrieves one or more messages (up to 10), from the specified queue.", "operationId"=>"receiveMessage", "x-api-path-slug"=>"actionreceivemessage-get", "parameters"=>[{"in"=>"query", "name"=>"AttributeName.N", "description"=>"A list of attributes that need to be returned along with each message", "type"=>"string"}, {"in"=>"query", "name"=>"MaxNumberOfMessages", "description"=>"The maximum number of messages to return", "type"=>"string"}, {"in"=>"query", "name"=>"MessageAttributeName.N", "description"=>"The name of the message attribute, where N is the index", "type"=>"string"}, {"in"=>"query", "name"=>"QueueUrl", "description"=>"The URL of the Amazon SQS queue from which messages are received", "type"=>"string"}, {"in"=>"query", "name"=>"ReceiveRequestAttemptId", "description"=>"This parameter applies only to FIFO (first-in-first-out) queues", "type"=>"string"}, {"in"=>"query", "name"=>"VisibilityTimeout", "description"=>"The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request", "type"=>"string"}, {"in"=>"query", "name"=>"WaitTimeSeconds", "description"=>"The duration (in seconds) for which the call waits for a message to arrive in the queue before returning", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages"]}}, "/?Action=RemovePermission"=>{"get"=>{"summary"=>"Remove Permission", "description"=>"Revokes any permissions in the queue policy that matches the specified Label parameter.", "operationId"=>"removePermission", "x-api-path-slug"=>"actionremovepermission-get", "parameters"=>[{"in"=>"query", "name"=>"Label", "description"=>"The identification of the permission to remove", "type"=>"string"}, {"in"=>"query", "name"=>"QueueUrl", "description"=>"The URL of the Amazon SQS queue from which permissions are removed", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permissions"]}}, "/?Action=SendMessage"=>{"get"=>{"summary"=>"Send Message", "description"=>"Delivers a message to the specified queue.", "operationId"=>"sendMessage", "x-api-path-slug"=>"actionsendmessage-get", "parameters"=>[{"in"=>"query", "name"=>"DelaySeconds", "description"=>"The number of seconds to delay a specific message", "type"=>"string"}, {"in"=>"query", "name"=>"MessageAttribute\n , MessageAttribute.N.Name (key), MessageAttribute.N.Value (value)", "description"=>"Each message attribute consists of a Name, Type, and Value", "type"=>"string"}, {"in"=>"query", "name"=>"MessageBody", "description"=>"The message to send", "type"=>"string"}, {"in"=>"query", "name"=>"MessageDeduplicationId", "description"=>"This parameter applies only to FIFO (first-in-first-out) queues", "type"=>"string"}, {"in"=>"query", "name"=>"MessageGroupId", "description"=>"This parameter applies only to FIFO (first-in-first-out) queues", "type"=>"string"}, {"in"=>"query", "name"=>"QueueUrl", "description"=>"The URL of the Amazon SQS queue to which a message is sent", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages"]}}, "/?Action=SendMessageBatch"=>{"get"=>{"summary"=>"Send Message Batch", "description"=>"Delivers up to ten messages to the specified queue.", "operationId"=>"sendMessageBatch", "x-api-path-slug"=>"actionsendmessagebatch-get", "parameters"=>[{"in"=>"query", "name"=>"QueueUrl", "description"=>"The URL of the Amazon SQS queue to which batched messages are sent", "type"=>"string"}, {"in"=>"query", "name"=>"SendMessageBatchRequestEntry.N", "description"=>"A list of SendMessageBatchRequestEntry items", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages"]}}, "/?Action=SetQueueAttributes"=>{"get"=>{"summary"=>"Set Queue Attributes", "description"=>"Sets the value of one or more queue attributes.", "operationId"=>"setQueueAttributes", "x-api-path-slug"=>"actionsetqueueattributes-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute\n , Attribute.N.Name (key), Attribute.N.Value (value)", "description"=>"A map of attributes to set", "type"=>"string"}, {"in"=>"query", "name"=>"QueueUrl", "description"=>"The URL of the Amazon SQS queue whose attributes are set", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queues"]}}}}, "apis"=>{"name"=>"AWS Simple Queue Service", "x-slug"=>"aws-simple-queue-service", "description"=>"Amazon Simple Queue Service (SQS) is a fast, reliable, scalable, fully managed message queuing service. Amazon SQS makes it simple and cost-effective to decouple the components of a cloud application. You can use Amazon SQS to transmit any volume of data, without losing messages or requiring other services to be always available. Amazon SQS includesstandard queueswith high throughput and at-least-once processing, andFIFO queuesthat provide FIFO (first-in, first-out) delivery and exactly-once processing. With Amazon SQS, you can offload the administrative burden of operating and scaling a highly available messaging cluster, while paying a low price for only what you use.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Application-Services_AmazonSQS.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Jobs,Orchestration,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-simple-queue-service/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Simple Queue Service API", "x-api-slug"=>"aws-simple-queue-service-api", "description"=>"Amazon Simple Queue Service (SQS) is a fast, reliable, scalable, fully managed message queuing service. Amazon SQS makes it simple and cost-effective to decouple the components of a cloud application. You can use Amazon SQS to transmit any volume of data, without losing messages or requiring other services to be always available. Amazon SQS includesstandard queueswith high throughput and at-least-once processing, andFIFO queuesthat provide FIFO (first-in, first-out) delivery and exactly-once processing. With Amazon SQS, you can offload the administrative burden of operating and scaling a highly available messaging cluster, while paying a low price for only what you use.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Application-Services_AmazonSQS.png", "humanURL"=>"https://aws.amazon.com/sqs/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Jobs,Orchestration,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-simple-queue-service/aws-simple-queue-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-log", "url"=>"http://aws.amazon.com/releasenotes/Amazon-SQ"}, {"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html"}, {"type"=>"x-console", "url"=>"https://console.aws.amazon.com/sqs/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/sqs/faqs/"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=12"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/sqs/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/sqs/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/sqs/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
betterdoctor{"betterdoctor-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"BetterDoctor", "x-complete"=>1, "info"=>{"title"=>"BetterDoctor", "description"=>"betterdoctor-helps-people-find-and-connect-to-the-best-doctors-through-our-consumer-app-doctor-marketing-services-and-api--our-mission-is-to-help-increase-transparency-in-healthcare-and-help-consumers-make-better-decisions-", "version"=>"1.0.0"}, "host"=>"api.betterdoctor.com", "basePath"=>"/2016-03-01", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/doctors"=>{"get"=>{"summary"=>"Doctor search", "description"=>"Doctor search", "operationId"=>"doctor-search", "x-api-path-slug"=>"doctors-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-separated list of fields to include"}, {"in"=>"query", "name"=>"first_name", "description"=>"The doctors first name; partial (type-ahead) characters/names are accepted"}, {"in"=>"query", "name"=>"gender", "description"=>"The doctors gender (male or female)"}, {"in"=>"query", "name"=>"insurance_uid", "description"=>"UID of an insurance plan (e"}, {"in"=>"query", "name"=>"last_name", "description"=>"The doctors last name; partial (type-ahead) characters/names are accepted"}, {"in"=>"query", "name"=>"limit", "description"=>"For paginated list operations; specifies the maximum number of items to retrieve"}, {"in"=>"query", "name"=>"location", "description"=>"Search area - Either Circular (lat,lon,range (miles)) or Bounding box (top-right, bottom-left) (lat,lon,lat,lon)"}, {"in"=>"query", "name"=>"name", "description"=>"The doctors name; searches in both first and last names"}, {"in"=>"query", "name"=>"practice_uid", "description"=>"BetterDoctor Practice UID"}, {"in"=>"query", "name"=>"query", "description"=>"Search all fields by a keyword query (e"}, {"in"=>"query", "name"=>"skip", "description"=>"For paginated list operations; specifies the zero-based start index of the first item to retrieve"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort order for the search results (full-name-asc: Alphabetical sort by full provider name ascending"}, {"in"=>"query", "name"=>"specialty_uid", "description"=>"UID of a specialty (e"}, {"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}, {"in"=>"query", "name"=>"user_location", "description"=>"Users current location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Doctor", "Search"]}}, "/doctors/{uid}"=>{"get"=>{"summary"=>"Retrieve a specific doctor description", "description"=>"Returns a doctor object based on an uid or a slug", "operationId"=>"returns-a-doctor-object-based-on-an-uid-or-a-slug", "x-api-path-slug"=>"doctorsuid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-separated list of fields to include"}, {"in"=>"path", "name"=>"uid", "description"=>"BetterDoctor Doctor UID"}, {"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Doctors"]}}, "/doctors/npi/{npi}"=>{"get"=>{"summary"=>"Retrieve a specific doctor description using NPI", "description"=>"Returns a doctor object using NPI", "operationId"=>"returns-a-doctor-object-using-npi", "x-api-path-slug"=>"doctorsnpinpi-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-separated list of fields to include"}, {"in"=>"path", "name"=>"npi", "description"=>"The National Provider Identifier of the doctor to retrieve"}, {"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Doctors"]}}, "/practices"=>{"get"=>{"summary"=>"Practice Search", "description"=>"Results are provider service locations, commonly referred as practices or doctor's offices.", "operationId"=>"results-are-provider-service-locations-commonly-referred-as-practices-or-doctors-offices", "x-api-path-slug"=>"practices-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-separated list of fields to include"}, {"in"=>"query", "name"=>"limit", "description"=>"For paginated list operations; specifies the maximum number of items to retrieve"}, {"in"=>"query", "name"=>"location", "description"=>"Search area - Either Circular (lat,lon,range (miles)) or Bounding box (top-right, bottom-left) (lat,lon,lat,lon)"}, {"in"=>"query", "name"=>"name", "description"=>"The practice???s name"}, {"in"=>"query", "name"=>"skip", "description"=>"For paginated list operations; specifies the zero-based start index of the first item to retrieve"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort order for the search results (full-name-asc: Alphabetical sort by full provider name ascending"}, {"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}, {"in"=>"query", "name"=>"user_location", "description"=>"Users current location: lat, lon"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Practices", "Search"]}}, "/practices/{uid}"=>{"get"=>{"summary"=>"Retrieve a specific practice description", "description"=>"Returns a practice object based on an uid or a slug", "operationId"=>"returns-a-practice-object-based-on-an-uid-or-a-slug", "x-api-path-slug"=>"practicesuid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-separated list of fields to include"}, {"in"=>"path", "name"=>"uid", "description"=>"BetterDoctor Practice UID"}, {"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Practices"]}}, "/practices/npi/{npi}"=>{"get"=>{"summary"=>"Retrieve a specific practice description using NPI", "description"=>"Returns a practice object based on an NPI. The office returned is registered in the NPI directory. There may be additional offices with this NPI registered at this location. Use the /practices search to find additional locations.", "operationId"=>"returns-a-practice-object-based-on-an-npi-the-office-returned-is-registered-in-the-npi-directory-the", "x-api-path-slug"=>"practicesnpinpi-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-separated list of fields to include"}, {"in"=>"path", "name"=>"npi", "description"=>"National Provider Identifier (NPI)"}, {"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Practices"]}}, "/practices/{uid}/doctors"=>{"get"=>{"summary"=>"Retrieve a list of doctors in this practice.", "description"=>"Returns a paginated list of doctors in the specified practice. This is a convenience endpoint, you may also use /doctors search for all doctors.", "operationId"=>"returns-a-paginated-list-of-doctors-in-the-specified-practice-this-is-a-convenience-endpoint-you-may", "x-api-path-slug"=>"practicesuiddoctors-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-separated list of fields to include"}, {"in"=>"query", "name"=>"limit", "description"=>"For paginated list operations; specifies the maximum number of items to retrieve"}, {"in"=>"query", "name"=>"skip", "description"=>"For paginated list operations; specifies the zero-based start index of the first item to retrieve"}, {"in"=>"path", "name"=>"uid", "description"=>"BetterDoctor Practice UID"}, {"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Practices", "Doctors"]}}, "/practices/npi/{npi}/doctors"=>{"get"=>{"summary"=>"Retrieve a list of doctors in this practice using NPI", "description"=>"Returns a paginated list of doctors in the specified practice. This is a convenience endpoint, you may also use /doctors search for all doctors.", "operationId"=>"returns-a-paginated-list-of-doctors-in-the-specified-practice-this-is-a-convenience-endpoint-you-may", "x-api-path-slug"=>"practicesnpinpidoctors-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-separated list of fields to include"}, {"in"=>"query", "name"=>"limit", "description"=>"For paginated list operations; specifies the maximum number of items to retrieve"}, {"in"=>"path", "name"=>"npi", "description"=>"National Provider Identifier (NPI)"}, {"in"=>"query", "name"=>"skip", "description"=>"For paginated list operations; specifies the zero-based start index of the first item to retrieve"}, {"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Practices", "Doctors"]}}, "/specialties"=>{"get"=>{"summary"=>"Retrieve a list of all specialties", "description"=>"Specialty group list", "operationId"=>"specialty-group-list", "x-api-path-slug"=>"specialties-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-separated list of fields to include"}, {"in"=>"query", "name"=>"limit", "description"=>"For paginated list operations; specifies the maximum number of items to retrieve"}, {"in"=>"query", "name"=>"skip", "description"=>"For paginated list operations; specifies the zero-based start index of the first item to retrieve"}, {"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specialties"]}}, "/insurances"=>{"get"=>{"summary"=>"Retrieve insurance providers and plans", "description"=>"Insurance provider & plan list", "operationId"=>"insurance-provider--plan-list", "x-api-path-slug"=>"insurances-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-separated list of fields to include"}, {"in"=>"query", "name"=>"limit", "description"=>"For paginated list operations; specifies the maximum number of items to retrieve"}, {"in"=>"query", "name"=>"skip", "description"=>"For paginated list operations; specifies the zero-based start index of the first item to retrieve"}, {"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance"]}}, "/conditions"=>{"get"=>{"summary"=>"Retrieve a list of known conditions", "description"=>"List all conditions", "operationId"=>"list-all-conditions", "x-api-path-slug"=>"conditions-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-separated list of fields to include"}, {"in"=>"query", "name"=>"limit", "description"=>"For paginated list operations; specifies the maximum number of items to retrieve"}, {"in"=>"query", "name"=>"skip", "description"=>"For paginated list operations; specifies the zero-based start index of the first item to retrieve"}, {"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conditions"]}}, "/validations"=>{"post"=>{"summary"=>"Add a new record", "description"=>"Creates validation document using the request body, and returns the document created with unique identifier in Location header for reference. This is how validation data is submitted to BetterDoctor for addition to the API. The posted document must conform to BetterDoctor???s JSON schema for validation objects, see included model specification for more information. Return HeadersLocation: The uid of the created document. This can be used to access the document again without executing a search. ", "operationId"=>"creates-validation-document-using-the-request-body-and-returns-the-document-created-with-unique-iden", "x-api-path-slug"=>"validations-post", "parameters"=>[{"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}, {"in"=>"body", "name"=>"validation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Record", "Search", "Validations"]}, "get"=>{"summary"=>"Record search", "description"=>"The endpoint can be used to identify providers with validation data. The search supports BetterDoctor unique provider identifier, National Provider Identifier (NPI) or reference uid based provider lookups. BetterDoctor identifiers and NPIs for doctors and practices can be discovered using BetterDoctor API???s search functionalities. Return HeadersLast-Modified: Timestamp of the last validation made over the matching validations. The value can be used to query changes in the validation status for the provider using since parameter in collaboration with HEAD method. ", "operationId"=>"the-endpoint-can-be-used-to-identify-providers-with-validation-data-the-search-supports-betterdoctor", "x-api-path-slug"=>"validations-get", "parameters"=>[{"in"=>"query", "name"=>"data_type", "description"=>"Provider type to search validations for"}, {"in"=>"query", "name"=>"data_uid", "description"=>"Paired with data_type"}, {"in"=>"query", "name"=>"limit", "description"=>"For paginated list operations; specifies the maximum number of items to retrieve"}, {"in"=>"query", "name"=>"npi", "description"=>"Paired with data_type"}, {"in"=>"query", "name"=>"ref_uid", "description"=>"Optional to data_type style queries"}, {"in"=>"query", "name"=>"since", "description"=>"Limits validations returned to the validations after the given timestamp value (ISO 8601)"}, {"in"=>"query", "name"=>"skip", "description"=>"For paginated list operations; specifies the zero-based start index of the first item to retrieve"}, {"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}, {"in"=>"query", "name"=>"validation_method", "description"=>"Limits validations returned to a validation method wanted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Record", "Search", "Validations"]}, "head"=>{"summary"=>"Check if new records exists", "description"=>"The endpoint can be used to identify providers with validation data, and discover changes. It providers search functionalities like its GET method alternative, but does not return any validation data. Instead of the data itself, it returns 200 OK if matching validation documents based on the given query are found. And it returns 304 if no validation documents are found after the timestamp given using If-Modified-Since HTTP header or since parameter. Return HeadersLast-Modified: Timestamp of the last validation made over the matching validations. ", "operationId"=>"the-endpoint-can-be-used-to-identify-providers-with-validation-data-and-discover-changes-it-provider", "x-api-path-slug"=>"validations-head", "parameters"=>[{"in"=>"query", "name"=>"data_type", "description"=>"Provider type to search validations for"}, {"in"=>"query", "name"=>"data_uid", "description"=>"Paired with data_type"}, {"in"=>"query", "name"=>"limit", "description"=>"For paginated list operations; specifies the maximum number of items to retrieve"}, {"in"=>"query", "name"=>"npi", "description"=>"Paired with data_type"}, {"in"=>"query", "name"=>"ref_uid", "description"=>"Optional to data_type style queries"}, {"in"=>"query", "name"=>"since", "description"=>"Limits validations returned to the validations after the given timestamp value (ISO 8601)"}, {"in"=>"query", "name"=>"skip", "description"=>"For paginated list operations; specifies the zero-based start index of the first item to retrieve"}, {"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}, {"in"=>"query", "name"=>"validation_method", "description"=>"Limits validations returned to a validation method wanted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Record", "Search", "Validations"]}}, "/validations/{uid}"=>{"get"=>{"summary"=>"Retrieve a specific record", "description"=>"Returns requested validation document. The endpoint is a conveniece method to check status and accepted data of a specific validation, like after creation of a validation. The response consist of raw data from the validation event and related validation information. Return HeadersLast-Modified: Timestamp of the validation made. ", "operationId"=>"returns-requested-validation-document-the-endpoint-is-a-conveniece-method-to-check-status-and-accept", "x-api-path-slug"=>"validationsuid-get", "parameters"=>[{"in"=>"path", "name"=>"uid", "description"=>"Unique identifier of a validation document"}, {"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Record", "Search", "Validations"]}, "head"=>{"summary"=>"Check if a specific record exists", "description"=>"The endpoint can be used to discover if a validation document exists in the API. Return HeadersLast-Modified: Timestamp of the validation made. ", "operationId"=>"the-endpoint-can-be-used-to-discover-if-a-validation-document-exists-in-the-api-brh4-stylemarginbott", "x-api-path-slug"=>"validationsuid-head", "parameters"=>[{"in"=>"path", "name"=>"uid", "description"=>"Unique identifier of a validation document"}, {"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Record", "Search", "Validations"]}}, "/info"=>{"get"=>{"summary"=>"API Health Check", "description"=>"Returns basic API health information for monitoring", "operationId"=>"returns-basic-api-health-information-for-monitoring", "x-api-path-slug"=>"info-get", "parameters"=>[{"in"=>"query", "name"=>"user_key", "description"=>"Your API access key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API", "Health", "Check"]}}}}, "apis"=>{"name"=>"BetterDoctor", "x-slug"=>"betterdoctor", "description"=>"BetterDoctor helps people find and connect to the best doctors through our consumer app, doctor marketing services, and API. Our mission is to help increase transparency in healthcare and help consumers make better decisions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/18991-betterdoctor.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"625342", "tags"=>"API Provider,Doctors,General Data,Healthcare,Insurance,Mobile,Profiles,SaaS,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"betterdoctor/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"BetterDoctor", "x-api-slug"=>"betterdoctor", "description"=>"BetterDoctor helps people find and connect to the best doctors through our consumer app, doctor marketing services, and API. Our mission is to help increase transparency in healthcare and help consumers make better decisions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/18991-betterdoctor.jpg", "humanURL"=>"https://developer.betterdoctor.com", "baseURL"=>"https://api.betterdoctor.com//2016-03-01", "tags"=>"API Provider,Doctors,General Data,Healthcare,Insurance,Mobile,Profiles,SaaS,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/betterdoctor/betterdoctor-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://betterdoctor.com/health/"}, {"type"=>"x-blog-rss", "url"=>"https://betterdoctor.com/health/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/betterdoctor-inc"}, {"type"=>"x-developer", "url"=>"https://developer.betterdoctor.com"}, {"type"=>"x-email", "url"=>"hello@betterdoctor.com"}, {"type"=>"x-email", "url"=>"press@betterdoctor.com"}, {"type"=>"x-email", "url"=>"tony@betterdoctor.com"}, {"type"=>"x-email", "url"=>"privacy@betterdoctor.com"}, {"type"=>"x-email", "url"=>"support@betterdoctor.com"}, {"type"=>"x-email", "url"=>"copyright@betterdoctor.com"}, {"type"=>"x-github", "url"=>"https://github.com/betterdoctor"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/betterdoctor"}, {"type"=>"x-website", "url"=>"https://betterdoctor.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-resource-manager{"google-cloud-resource-manager-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Resource Manager", "x-complete"=>1, "info"=>{"title"=>"Google Cloud Resource Manager", "description"=>"the-google-cloud-resource-manager-api-provides-methods-for-creating-reading-and-updating-project-metadata-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"cloudresourcemanager.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/liens"=>{"get"=>{"summary"=>"List Liens", "description"=>"List all Liens applied to the `parent` resource.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.get`.", "operationId"=>"cloudresourcemanager.liens.list", "x-api-path-slug"=>"v1liens-get", "parameters"=>[{"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The `next_page_token` value returned from a previous List request, if any"}, {"in"=>"query", "name"=>"parent", "description"=>"The name of the resource to list all attached Liens"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lien"]}, "post"=>{"summary"=>"Create Lien", "description"=>"Create a Lien which applies to the resource denoted by the `parent` field.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, applying to `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.\n\nNOTE: Some resources may limit the number of Liens which may be applied.", "operationId"=>"cloudresourcemanager.liens.create", "x-api-path-slug"=>"v1liens-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lien"]}}, "/v1/organizations:search"=>{"post"=>{"summary"=>"Search Organization", "description"=>"Searches Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the\nresults.", "operationId"=>"cloudresourcemanager.organizations.search", "x-api-path-slug"=>"v1organizationssearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization"]}}, "/v1/projects"=>{"get"=>{"summary"=>"List Projects", "description"=>"Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nNew Projects do not necessarily appear at the end of the list.", "operationId"=>"cloudresourcemanager.projects.list", "x-api-path-slug"=>"v1projects-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"An expression for filtering the results of the request"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of Projects to return in the response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A pagination token returned from a previous call to ListProjectsthat indicates from where listing should continue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project"]}, "post"=>{"summary"=>"Create Project", "description"=>"Request that a new Project be created. The result is an Operation which\ncan be used to track the creation process. It is automatically deleted\nafter a few hours, so there is no need to call DeleteOperation.\n\nOur SLO permits Project creation to take up to 30 seconds at the 90th\npercentile. As of 2016-08-29, we are observing 6 seconds 50th percentile\nlatency. 95th percentile latency is around 11 seconds. We recommend\npolling at the 5th second with an exponential backoff.", "operationId"=>"cloudresourcemanager.projects.create", "x-api-path-slug"=>"v1projects-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project"]}}, "/v1/projects/{projectId}"=>{"delete"=>{"summary"=>"Delete Project", "description"=>"Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time,\nat which point the Project is no longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.", "operationId"=>"cloudresourcemanager.projects.delete", "x-api-path-slug"=>"v1projectsprojectid-delete", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"The Project ID (for example, `foo-bar-123`)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project"]}, "get"=>{"summary"=>"Get Project", "description"=>"Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.", "operationId"=>"cloudresourcemanager.projects.get", "x-api-path-slug"=>"v1projectsprojectid-get", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"The Project ID (for example, `my-project-123`)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project"]}, "put"=>{"summary"=>"Update Project", "description"=>"Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project.", "operationId"=>"cloudresourcemanager.projects.update", "x-api-path-slug"=>"v1projectsprojectid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"The project ID (for example, `my-project-123`)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project"]}}, "/v1/projects/{projectId}:getAncestry"=>{"post"=>{"summary"=>"Get Project Ancestry", "description"=>"Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.", "operationId"=>"cloudresourcemanager.projects.getAncestry", "x-api-path-slug"=>"v1projectsprojectidgetancestry-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"The Project ID (for example, `my-project-123`)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project"]}}, "/v1/projects/{projectId}:undelete"=>{"post"=>{"summary"=>"Restore Project", "description"=>"Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.", "operationId"=>"cloudresourcemanager.projects.undelete", "x-api-path-slug"=>"v1projectsprojectidundelete-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"The project ID (for example, `foo-bar-123`)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project"]}}, "/v1/projects/{resource}:getIamPolicy"=>{"post"=>{"summary"=>"Get IAM Policy", "description"=>"Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.", "operationId"=>"cloudresourcemanager.projects.getIamPolicy", "x-api-path-slug"=>"v1projectsresourcegetiampolicy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}, "/v1/projects/{resource}:setIamPolicy"=>{"post"=>{"summary"=>"Set IAM Policy", "description"=>"Sets the IAM access control policy for the specified Project. Replaces\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`;\nthey must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ There must be at least one owner who has accepted the Terms of\nService (ToS) agreement in the policy. Calling `setIamPolicy()` to\nto remove the last ToS-accepted owner from the policy will fail. This\nrestriction also applies to legacy projects that no longer have owners\nwho have accepted the ToS. Edits to IAM policies will be rejected until\nthe lack of a ToS-accepting owner is rectified.\n\n+ Calling this method requires enabling the App Engine Admin API.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.", "operationId"=>"cloudresourcemanager.projects.setIamPolicy", "x-api-path-slug"=>"v1projectsresourcesetiampolicy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy is being specified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}, "/v1/projects/{resource}:testIamPermissions"=>{"post"=>{"summary"=>"Test IAM Policy", "description"=>"Returns permissions that a caller has on the specified Project.", "operationId"=>"cloudresourcemanager.projects.testIamPermissions", "x-api-path-slug"=>"v1projectsresourcetestiampermissions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy detail is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}, "/v1/{name}"=>{"delete"=>{"summary"=>"Delete Lien", "description"=>"Delete a Lien by `name`.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.", "operationId"=>"cloudresourcemanager.liens.delete", "x-api-path-slug"=>"v1name-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name/identifier of the Lien to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lien"]}, "get"=>{"summary"=>"Get Operation", "description"=>"Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", "operationId"=>"cloudresourcemanager.operations.get", "x-api-path-slug"=>"v1name-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the operation resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1/{resource}:getIamPolicy"=>{"post"=>{"summary"=>"Get Organization IAM Policy", "description"=>"Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".", "operationId"=>"cloudresourcemanager.organizations.getIamPolicy", "x-api-path-slug"=>"v1resourcegetiampolicy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization"]}}, "/v1/{resource}:setIamPolicy"=>{"post"=>{"summary"=>"Set Organization IAM Policy", "description"=>"Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".", "operationId"=>"cloudresourcemanager.organizations.setIamPolicy", "x-api-path-slug"=>"v1resourcesetiampolicy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy is being specified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization"]}}, "/v1/{resource}:testIamPermissions"=>{"post"=>{"summary"=>"TEst Organization IAM Permissions", "description"=>"Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".", "operationId"=>"cloudresourcemanager.organizations.testIamPermissions", "x-api-path-slug"=>"v1resourcetestiampermissions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy detail is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization"]}}}}, "apis"=>{"name"=>"Google Cloud Resource Manager", "x-slug"=>"google-cloud-resource-manager", "description"=>"Google Cloud Platform provides resource containers such as Organizations and Projects, that allow you to group and hierarchically organize other Cloud Platform resources. This hierarchical organization lets you easily manage common aspects of your resources such as access control and configuration settings. The Google Cloud Resource Manager service enables you to programmatically manage these resource containers.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Generic-GCP.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Management,Orchestration,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-resource-manager/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Resource Manager API", "x-api-slug"=>"google-cloud-resource-manager-api", "description"=>"Google Cloud Platform provides resource containers such as Organizations and Projects, that allow you to group and hierarchically organize other Cloud Platform resources. This hierarchical organization lets you easily manage common aspects of your resources such as access control and configuration settings. The Google Cloud Resource Manager service enables you to programmatically manage these resource containers.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Generic-GCP.png", "humanURL"=>"https://cloud.google.com/resource-manager/", "baseURL"=>"://cloudresourcemanager.googleapis.com//", "tags"=>"API Provider,API Service Provider,Google APIs,Management,Orchestration,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-resource-manager/google-cloud-resource-manager-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://cloud.google.com/resource-manager/docs/authorizing"}, {"type"=>"x-code", "url"=>"https://cloud.google.com/resource-manager/docs/libraries"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/resource-manager/docs/"}, {"type"=>"x-errors", "url"=>"https://cloud.google.com/resource-manager/docs/core_errors"}, {"type"=>"x-how-to-guides", "url"=>"https://cloud.google.com/resource-manager/docs/how-to"}, {"type"=>"x-performance", "url"=>"https://cloud.google.com/resource-manager/docs/performance"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/resource-manager/pricing"}, {"type"=>"x-rate-limits", "url"=>"https://cloud.google.com/resource-manager/docs/limits"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/resource-manager/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vestorly{"vestorly-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Vestorly", "x-complete"=>1, "info"=>{"title"=>"Vestorly", "description"=>"vestorly-developers-api", "termsOfService"=>"http://www.vestorly.com/terms/", "contact"=>{"name"=>"Vestorly Team"}, "version"=>"1.0.0"}, "host"=>"staging.vestorly.com", "basePath"=>"/api/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/advisors/{id}"=>{"get"=>{"summary"=>"Get Advisors", "description"=>"Returns a single advisor given their ID", "operationId"=>"findAdvisorByID", "x-api-path-slug"=>"advisorsid-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"path", "name"=>"id", "description"=>"Advisor Id to fetch"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advisors"]}}, "/articles"=>{"get"=>{"summary"=>"Get Articles", "description"=>"Returns all articles", "operationId"=>"findArticles", "x-api-path-slug"=>"articles-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit on the number of articles to return"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Field on model to sort by"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction of sort (used with sort_by parameter)"}, {"in"=>"query", "name"=>"text_query", "description"=>"Search query parameter"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Articles"]}}, "/articles/{id}"=>{"get"=>{"summary"=>"Get Articles", "description"=>"Returns a single article", "operationId"=>"findArticleByID", "x-api-path-slug"=>"articlesid-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"path", "name"=>"id", "description"=>"Article Id to fetch"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Articles"]}}, "/events"=>{"get"=>{"summary"=>"Get Events", "description"=>"Returns all events", "operationId"=>"findEvents", "x-api-path-slug"=>"events-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}, "post"=>{"summary"=>"Post Events", "description"=>"Creates a new event in the system", "operationId"=>"createEvent", "x-api-path-slug"=>"events-post", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"body", "name"=>"event", "description"=>"Event", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/events/{id}"=>{"get"=>{"summary"=>"Get Events", "description"=>"Returns a single event if the user has access", "operationId"=>"findEventByID", "x-api-path-slug"=>"eventsid-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"path", "name"=>"id", "description"=>"Mongo ID of event to fetch"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/groups"=>{"get"=>{"summary"=>"Get Groups", "description"=>"Returns all groups", "operationId"=>"findGroups", "x-api-path-slug"=>"groups-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, "post"=>{"summary"=>"Post Groups", "description"=>"Creates a new Group", "operationId"=>"createGroup", "x-api-path-slug"=>"groups-post", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"body", "name"=>"group", "description"=>"Group to add", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/groups/{id}"=>{"delete"=>{"summary"=>"Delete Groups", "description"=>"Deletes a Group", "operationId"=>"deleteGroup", "x-api-path-slug"=>"groupsid-delete", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"path", "name"=>"id", "description"=>"id of group to delete"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, "get"=>{"summary"=>"Get Groups", "description"=>"Returns a single group if user has access", "operationId"=>"findGroupByID", "x-api-path-slug"=>"groupsid-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"path", "name"=>"id", "description"=>"Mongo ID of group to fetch"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, "put"=>{"summary"=>"Put Groups", "description"=>"Updates a Group", "operationId"=>"updateGroupById", "x-api-path-slug"=>"groupsid-put", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"body", "name"=>"group", "description"=>"Group to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"id of group to update"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/member_events"=>{"get"=>{"summary"=>"Get Member Events", "description"=>"Returns all MemberEvents", "operationId"=>"findMemberEvents", "x-api-path-slug"=>"member-events-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Member", "Events"]}}, "/member_reports"=>{"get"=>{"summary"=>"Get Member Reports", "description"=>"Returns all member reports", "operationId"=>"findMemberReports", "x-api-path-slug"=>"member-reports-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Member", "Reports"]}}, "/members"=>{"get"=>{"summary"=>"Get Members", "description"=>"Returns all members", "operationId"=>"findMembers", "x-api-path-slug"=>"members-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of members to return"}, {"in"=>"query", "name"=>"start", "description"=>"Skips number of members from start"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members"]}, "post"=>{"summary"=>"Post Members", "description"=>"Create a new member in the Vestorly Platform", "operationId"=>"createMember", "x-api-path-slug"=>"members-post", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"body", "name"=>"member", "description"=>"Member you want to create", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members"]}}, "/members/{id}"=>{"get"=>{"summary"=>"Get Members", "description"=>"Returns a single member", "operationId"=>"findMemberByID", "x-api-path-slug"=>"membersid-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"path", "name"=>"id", "description"=>"Mongo ID of member to fetch"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members"]}, "put"=>{"summary"=>"Put Members", "description"=>"Updates a single member", "operationId"=>"updateMemberByID", "x-api-path-slug"=>"membersid-put", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"path", "name"=>"id", "description"=>"Mongo ID of member to fetch"}, {"in"=>"body", "name"=>"member", "description"=>"Member you want to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members"]}}, "/newsletter_settings"=>{"get"=>{"summary"=>"Get Newsletter Settings", "description"=>"Returns all newsletter settings", "operationId"=>"findNewsletterSettings", "x-api-path-slug"=>"newsletter-settings-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Newsletter", "Settings"]}}, "/newsletter_settings/{id}"=>{"get"=>{"summary"=>"Get Newsletter Settings", "description"=>"Returns a single newsletter settings if the user has access", "operationId"=>"findNewsletterSettingsByID", "x-api-path-slug"=>"newsletter-settingsid-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"path", "name"=>"id", "description"=>"Mongo ID of newsletter settings to fetch"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Newsletter", "Settings"]}, "put"=>{"summary"=>"Put Newsletter Settings", "description"=>"Update a single newsletter setting by ID", "operationId"=>"updateNewsletterSettingsByID", "x-api-path-slug"=>"newsletter-settingsid-put", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"path", "name"=>"id", "description"=>"Mongo ID of newsletter settings to update"}, {"in"=>"body", "name"=>"newsletter_setting", "description"=>"newsletter settings", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Newsletter", "Settings"]}}, "/newsletters"=>{"get"=>{"summary"=>"Get Newsletters", "description"=>"Returns all newsletters", "operationId"=>"findNewsletters", "x-api-path-slug"=>"newsletters-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Newsletters"]}}, "/newsletters/{id}"=>{"get"=>{"summary"=>"Get Newsletters", "description"=>"Get a newsletter by ID", "operationId"=>"getNewsletterByID", "x-api-path-slug"=>"newslettersid-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"path", "name"=>"id", "description"=>"Mongo ID of event to get"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Newsletters"]}, "put"=>{"summary"=>"Put Newsletters", "description"=>"Updates a newsletter", "operationId"=>"updateNewsletterByID", "x-api-path-slug"=>"newslettersid-put", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"path", "name"=>"id", "description"=>"Mongo ID of event to update"}, {"in"=>"body", "name"=>"newsletter", "description"=>"Newsletter", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Newsletters"]}}, "/posts"=>{"get"=>{"summary"=>"Get Posts", "description"=>"Query all posts", "operationId"=>"findPosts", "x-api-path-slug"=>"posts-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"query", "name"=>"external_url", "description"=>"Filter by External URL"}, {"in"=>"query", "name"=>"is_published", "description"=>"Filter by is_published boolean"}, {"in"=>"query", "name"=>"text_query", "description"=>"Filter post by parameters"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts"]}, "post"=>{"summary"=>"Add Post", "description"=>"Create a new post in the Vestorly Platform", "operationId"=>"createPost", "x-api-path-slug"=>"posts-post", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"body", "name"=>"post", "description"=>"Post you want to create", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts"]}}, "/posts/{id}"=>{"get"=>{"summary"=>"Get Post", "description"=>"Query all posts", "operationId"=>"getPostByID", "x-api-path-slug"=>"postsid-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"path", "name"=>"id", "description"=>"ID of post to fetch"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts"]}, "put"=>{"summary"=>"Update Post", "description"=>"Update A Post", "operationId"=>"updatePostByID", "x-api-path-slug"=>"postsid-put", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"path", "name"=>"id", "description"=>"id of post to update"}, {"in"=>"body", "name"=>"post", "description"=>"Post you want to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S"]}}, "/sessions"=>{"post"=>{"summary"=>"Post Sessions", "description"=>"Login To Vestorly Platform", "operationId"=>"login", "x-api-path-slug"=>"sessions-post", "parameters"=>[{"in"=>"query", "name"=>"password", "description"=>"Password in Vestorly Platform"}, {"in"=>"query", "name"=>"username", "description"=>"Username in the vestorly platform"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions"]}}, "/sessions/{id}"=>{"delete"=>{"summary"=>"Delete Sessions", "description"=>"Logout of the vestorly platform", "operationId"=>"logout", "x-api-path-slug"=>"sessionsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of pet to session"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Authenication token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Authenication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions"]}}, "/sources"=>{"get"=>{"summary"=>"Get Sources", "description"=>"Returns all sources", "operationId"=>"findSources", "x-api-path-slug"=>"sources-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sources"]}, "post"=>{"summary"=>"Post Sources", "description"=>"Create source", "operationId"=>"createSource", "x-api-path-slug"=>"sources-post", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"body", "name"=>"source", "description"=>"Source", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sources"]}}, "/sources/{id}"=>{"get"=>{"summary"=>"Get Sources", "description"=>"Get Source By ID", "operationId"=>"getSourceByID", "x-api-path-slug"=>"sourcesid-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"path", "name"=>"id", "description"=>"ID of source to fetch"}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sources"]}, "put"=>{"summary"=>"Put Sources", "description"=>"Update Source By ID", "operationId"=>"updateSourceByID", "x-api-path-slug"=>"sourcesid-put", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"OAuth Token"}, {"in"=>"path", "name"=>"id", "description"=>"ID of source to fetch"}, {"in"=>"body", "name"=>"source", "description"=>"Source", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"vestorly-auth", "description"=>"Vestorly Auth Token"}, {"in"=>"query", "name"=>"vestorly_auth", "description"=>"Vestorly Auth Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sources"]}}}}, "apis"=>{"name"=>"Vestorly", "x-slug"=>"vestorly", "description"=>"", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/vestorly.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Content,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"vestorly/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Vestorly", "x-api-slug"=>"vestorly", "description"=>"", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/vestorly.png", "humanURL"=>"http://vestorly.com", "baseURL"=>"https://staging.vestorly.com//api/v2", "tags"=>"Content,Relative Data,Service API", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/vestorly/vestorly-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"https://www.vestorly.com/enterprise/api/"}, {"type"=>"x-github", "url"=>"https://github.com/vestorly"}, {"type"=>"x-pricing", "url"=>"https://www.vestorly.com/pricing/"}, {"type"=>"x-security", "url"=>"https://www.vestorly.com/enterprise/security/"}, {"type"=>"x-support", "url"=>"https://www.vestorly.com/enterprise/support/"}, {"type"=>"x-support", "url"=>"https://www.vestorly.com/blog/"}, {"type"=>"x-twitter", "url"=>"https://www.twitter.com/vestorly"}, {"type"=>"x-website", "url"=>"http://vestorly.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bureau-of-alcohol-tobacco-firearms-and-explosives{"api-for-national-firearms-act-tax-revenues-and-related-activities-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bureau of Alcohol, Tobacco, Firearms, and Explosives", "x-complete"=>1, "info"=>{"title"=>"API for National Firearms Act Tax Revenues And Related Activities", "description"=>"api-for-exhibit-6-of-annual-atf-commerce-report", "version"=>"v1"}, "host"=>"data.atf.gov", "basePath"=>"/resource/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"national-firearms-act-tax-revenues-and-related-activities.json"=>{"get"=>{"summary"=>"National Firearms Act Tax Revenues And Related Activities", "description"=>"National Firearms Act Tax Revenues And Related Activities", "operationId"=>"", "x-api-path-slug"=>"nationalfirearmsacttaxrevenuesandrelatedactivities-json-get", "parameters"=>[{"in"=>"query", "name"=>"enforcement_support_certifications"}, {"in"=>"query", "name"=>"enforcement_support_records_checks"}, {"in"=>"query", "name"=>"fical_year"}, {"in"=>"query", "name"=>"occupational_tax_paid"}, {"in"=>"query", "name"=>"transfer_and_making_tax_paid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "api-for-pistols--firearms-manufacturing-report-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bureau of Alcohol, Tobacco, Firearms, and Explosives", "x-complete"=>1, "info"=>{"title"=>"API for Pistols - Firearms Manufacturing Report", "description"=>"api-for-firearms-manufacturing-report-related-to-pistol-manufacturing", "version"=>"v1"}, "host"=>"data.atf.gov", "basePath"=>"/resource/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"pistols-firearms-manufacturing-report.json"=>{"get"=>{"summary"=>"Pistol Manufacturing Report", "description"=>"Pistol Manufacturing Report", "operationId"=>"", "x-api-path-slug"=>"pistolsfirearmsmanufacturingreport-json-get", "parameters"=>[{"in"=>"query", "name"=>"license_name"}, {"in"=>"query", "name"=>"premise_city"}, {"in"=>"query", "name"=>"premise_location"}, {"in"=>"query", "name"=>"premise_state"}, {"in"=>"query", "name"=>"premise_street"}, {"in"=>"query", "name"=>"pstl_22_sum"}, {"in"=>"query", "name"=>"pstl_25_sum"}, {"in"=>"query", "name"=>"pstl_32_sum"}, {"in"=>"query", "name"=>"pstl_380_sum"}, {"in"=>"query", "name"=>"pstl_50_sum"}, {"in"=>"query", "name"=>"pstl_totl_sum"}, {"in"=>"query", "name"=>"rds_key"}, {"in"=>"query", "name"=>"year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "api-for-top-recovery-cities-for-firearms-with-a-recovery-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bureau of Alcohol, Tobacco, Firearms, and Explosives", "x-complete"=>1, "info"=>{"title"=>"API for Top Recovery Cities For Firearms With A Recovery", "description"=>"a-key-component-of-the-bureau-of-alcohol-tobacco-firearms-and-explosivesu2019-atf-enforcement-mission-is-the-tracing-of-firearms-on-behalf-of-thousands-of-federal-state-local-and-foreign-law-enforcement-agencies--firearms-trace-data-is-critically-important-information-developed-by-atf--atf-has-prepared-the-following-statebystate-trace-data-which-is-intended-to-provide-the-public-with-insight-into-firearms-recoveries-", "version"=>"v1"}, "host"=>"data.atf.gov", "basePath"=>"/resource/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"top-recovery-cities-for-firearms-with-a-recovery.json"=>{"get"=>{"summary"=>"Top Recovery Cities For Firearms", "description"=>"Top Recovery Cities For Firearms", "operationId"=>"", "x-api-path-slug"=>"toprecoverycitiesforfirearmswitharecovery-json-get", "parameters"=>[{"in"=>"query", "name"=>"analytical_criteria_used_to_compile_the_enclosed_statistics"}, {"in"=>"query", "name"=>"city"}, {"in"=>"query", "name"=>"notes_if_any"}, {"in"=>"query", "name"=>"state"}, {"in"=>"query", "name"=>"traces"}, {"in"=>"query", "name"=>"year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "api-for-firearms-imported-into-the-united-states-by-country-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bureau of Alcohol, Tobacco, Firearms, and Explosives", "x-complete"=>1, "info"=>{"title"=>"API for Firearms Imported Into The United States By Country", "description"=>"api-for-exhibit-5-of-annual-atf-commerce-report", "version"=>"v1"}, "host"=>"data.atf.gov", "basePath"=>"/resource/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"firearms-imported-into-the-united-states-by-country.json"=>{"get"=>{"summary"=>"Firearms Imported Into The United States By Country", "description"=>"Firearms Imported Into The United States By Country", "operationId"=>"", "x-api-path-slug"=>"firearmsimportedintotheunitedstatesbycountry-json-get", "parameters"=>[{"in"=>"query", "name"=>"country"}, {"in"=>"query", "name"=>"handguns"}, {"in"=>"query", "name"=>"rifles"}, {"in"=>"query", "name"=>"shotguns"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "api-for-firearms-manufacturers-exports-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bureau of Alcohol, Tobacco, Firearms, and Explosives", "x-complete"=>1, "info"=>{"title"=>"API for Firearms Manufacturers Exports", "description"=>"api-for-exhibit-2-of-annual-atf-commerce-report", "version"=>"v1"}, "host"=>"data.atf.gov", "basePath"=>"/resource/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"firearms-manufacturers-exports.json"=>{"get"=>{"summary"=>"Firearms Manufacturers Exports", "description"=>"Firearms Manufacturers Exports", "operationId"=>"", "x-api-path-slug"=>"firearmsmanufacturersexports-json-get", "parameters"=>[{"in"=>"query", "name"=>"calendar_year"}, {"in"=>"query", "name"=>"misc_firearms"}, {"in"=>"query", "name"=>"pistols"}, {"in"=>"query", "name"=>"revolvers"}, {"in"=>"query", "name"=>"rifles"}, {"in"=>"query", "name"=>"shotguns"}, {"in"=>"query", "name"=>"total_firearms"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "api-for-federal-firearms-licensees-by-state-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bureau of Alcohol, Tobacco, Firearms, and Explosives", "x-complete"=>1, "info"=>{"title"=>"API for Federal Firearms Licensees By State", "description"=>"api-for-exhibit-11-of-annual-atf-commerce-report", "version"=>"v1"}, "host"=>"data.atf.gov", "basePath"=>"/resource/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"federal-firearms-licensees-by-state.json"=>{"get"=>{"summary"=>"Federal Firearms Licensees", "description"=>"Federal Firearms Licensees", "operationId"=>"", "x-api-path-slug"=>"federalfirearmslicenseesbystate-json-get", "parameters"=>[{"in"=>"query", "name"=>"ffl_population"}, {"in"=>"query", "name"=>"state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "api-time-to-crime-rates-for-firearms-with-a-recovery-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bureau of Alcohol, Tobacco, Firearms, and Explosives", "x-complete"=>1, "info"=>{"title"=>"API Time To Crime Rates For Firearms With A Recovery", "description"=>"a-key-component-of-the-bureau-of-alcohol-tobacco-firearms-and-explosivesu2019-atf-enforcement-mission-is-the-tracing-of-firearms-on-behalf-of-thousands-of-federal-state-local-and-foreign-law-enforcement-agencies--firearms-trace-data-is-critically-important-information-developed-by-atf--atf-has-prepared-the-following-statebystate-trace-data-which-is-intended-to-provide-the-public-with-insight-into-firearms-recoveries-", "version"=>"v1"}, "host"=>"data.atf.gov", "basePath"=>"/resource/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"time-to-crime-rates-for-firearms-with-a-recovery.json"=>{"get"=>{"summary"=>"Crime Rates For Firearms", "description"=>"Crime Rates For Firearms", "operationId"=>"", "x-api-path-slug"=>"timetocrimeratesforfirearmswitharecovery-json-get", "parameters"=>[{"in"=>"query", "name"=>"average_time_to_crime"}, {"in"=>"query", "name"=>"state"}, {"in"=>"query", "name"=>"under_3_months"}, {"in"=>"query", "name"=>"year"}, {"in"=>"query", "name"=>"_1_year_to_under_3_years"}, {"in"=>"query", "name"=>"_2_years_to_under_3_years"}, {"in"=>"query", "name"=>"_3_months_to_under_7_months"}, {"in"=>"query", "name"=>"_3_years_and_over"}, {"in"=>"query", "name"=>"_7_months_to_under_1_year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "api-for-actions-on-federal-firearms-license-applications-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bureau of Alcohol, Tobacco, Firearms, and Explosives", "x-complete"=>1, "info"=>{"title"=>"API for Actions On Federal Firearms License Applications", "description"=>"api-for-exhibit-12-of-annual-atf-commerce-report", "version"=>"v1"}, "host"=>"data.atf.gov", "basePath"=>"/resource/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"actions-on-federal-firearms-license-applications.json"=>{"get"=>{"summary"=>"Actions On Federal Firearms License Applications", "description"=>"Actions On Federal Firearms License Applications", "operationId"=>"getActionsOnFederalFirearmsLicenseApplications.json", "x-api-path-slug"=>"actionsonfederalfirearmslicenseapplications-json-get", "parameters"=>[{"in"=>"query", "name"=>"applications_abandoned"}, {"in"=>"query", "name"=>"applications_denied"}, {"in"=>"query", "name"=>"applications_withdrawn"}, {"in"=>"query", "name"=>"fiscal_year"}, {"in"=>"query", "name"=>"original_applications_processed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "On", "Federal", "Firearms", "License", "Applications", "Json"]}}}}, "api-for-firearms-types-with-a-recovery-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bureau of Alcohol, Tobacco, Firearms, and Explosives", "x-complete"=>1, "info"=>{"title"=>"API for Firearms Types With A Recovery", "description"=>"a-key-component-of-the-bureau-of-alcohol-tobacco-firearms-and-explosivesu2019-atf-enforcement-mission-is-the-tracing-of-firearms-on-behalf-of-thousands-of-federal-state-local-and-foreign-law-enforcement-agencies--firearms-trace-data-is-critically-important-information-developed-by-atf--atf-has-prepared-the-following-statebystate-trace-data-which-is-intended-to-provide-the-public-with-insight-into-firearms-recoveries-", "version"=>"v1"}, "host"=>"data.atf.gov", "basePath"=>"/resource/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"firearms-types-with-a-recovery.json"=>{"get"=>{"summary"=>"Firearms Types", "description"=>"Firearms Types", "operationId"=>"", "x-api-path-slug"=>"firearmstypeswitharecovery-json-get", "parameters"=>[{"in"=>"query", "name"=>"analytical_criteria_used_to_compile_the_enclosed_statistics"}, {"in"=>"query", "name"=>"notes_if_any"}, {"in"=>"query", "name"=>"number_of_recoveries"}, {"in"=>"query", "name"=>"state"}, {"in"=>"query", "name"=>"types"}, {"in"=>"query", "name"=>"year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "api-for-top-categories-reported-on-firearm-traces-with-a-recovery-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bureau of Alcohol, Tobacco, Firearms, and Explosives", "x-complete"=>1, "info"=>{"title"=>"API for Top Categories Reported On Firearm Traces with a Recovery", "description"=>"a-key-component-of-the-bureau-of-alcohol-tobacco-firearms-and-explosivesu2019-atf-enforcement-mission-is-the-tracing-of-firearms-on-behalf-of-thousands-of-federal-state-local-and-foreign-law-enforcement-agencies--firearms-trace-data-is-critically-important-information-developed-by-atf--atf-has-prepared-the-following-statebystate-trace-data-which-is-intended-to-provide-the-public-with-insight-into-firearms-recoveri", "version"=>"v1"}, "host"=>"data.atf.gov", "basePath"=>"/resource/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"top-categories-reported-on-firearm-traces-with-a-recovery.json"=>{"get"=>{"summary"=>"Top Categories Reported On Firearm Traces", "description"=>"Top Categories Reported On Firearm Traces", "operationId"=>"", "x-api-path-slug"=>"topcategoriesreportedonfirearmtraceswitharecovery-json-get", "parameters"=>[{"in"=>"query", "name"=>"analytical_criteria_used_to_compile_the_enclosed_statistics"}, {"in"=>"query", "name"=>"categories"}, {"in"=>"query", "name"=>"count"}, {"in"=>"query", "name"=>"notes"}, {"in"=>"query", "name"=>"state"}, {"in"=>"query", "name"=>"year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "api-for-firearms-imports-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bureau of Alcohol, Tobacco, Firearms, and Explosives", "x-complete"=>1, "info"=>{"title"=>"API for Firearms Imports", "description"=>"api-for-exhibit-3-of-annual-atf-commerce-report", "version"=>"v1"}, "host"=>"data.atf.gov", "basePath"=>"/resource/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"firearms-imports.json"=>{"get"=>{"summary"=>"Firearms Imports", "description"=>"Firearms Imports", "operationId"=>"", "x-api-path-slug"=>"firearmsimports-json-get", "parameters"=>[{"in"=>"query", "name"=>"calendar_year"}, {"in"=>"query", "name"=>"handguns"}, {"in"=>"query", "name"=>"rifles"}, {"in"=>"query", "name"=>"shotguns"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "api-for-importation-applications-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bureau of Alcohol, Tobacco, Firearms, and Explosives", "x-complete"=>1, "info"=>{"title"=>"API for Importation Applications", "description"=>"api-for-exhibit-4-of-annual-atf-commerce-report", "version"=>"v1"}, "host"=>"data.atf.gov", "basePath"=>"/resource/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"importation-applications.json"=>{"get"=>{"summary"=>"Importation Applications", "description"=>"Importation Applications", "operationId"=>"", "x-api-path-slug"=>"importationapplications-json-get", "parameters"=>[{"in"=>"query", "name"=>"fiscal_year"}, {"in"=>"query", "name"=>"licensed_importer"}, {"in"=>"query", "name"=>"military"}, {"in"=>"query", "name"=>"other"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "api-for-national-firearms-act-firearms-processed-by-form-type-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bureau of Alcohol, Tobacco, Firearms, and Explosives", "x-complete"=>1, "info"=>{"title"=>"API for National Firearms Act Firearms Processed By Form Type", "description"=>"api-for-exhibit-7-of-annual-atf-commerce-report", "version"=>"v1"}, "host"=>"data.atf.gov", "basePath"=>"/resource/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"national-firearms-act-firearms-processed-by-form-type.json"=>{"get"=>{"summary"=>"National Firearms Act Firearms Processed By Form Type", "description"=>"National Firearms Act Firearms Processed By Form Type", "operationId"=>"", "x-api-path-slug"=>"nationalfirearmsactfirearmsprocessedbyformtype-json-get", "parameters"=>[{"in"=>"query", "name"=>"application_for_taxpaid_transfer_atf_form_4"}, {"in"=>"query", "name"=>"application_for_tax_exempt_transfer_3_atf_form_5"}, {"in"=>"query", "name"=>"application_for_tax_exempt_transfer_between_licensees_atf_form_3"}, {"in"=>"query", "name"=>"application_to_make_nfa_firearms_atf_form_1"}, {"in"=>"query", "name"=>"calendar_year"}, {"in"=>"query", "name"=>"exported_atf_form_9"}, {"in"=>"query", "name"=>"manufactured_and_imported_atf_form_2"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "api-for-national-firearms-act-special-occupational-taxpayers-by-state-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bureau of Alcohol, Tobacco, Firearms, and Explosives", "x-complete"=>1, "info"=>{"title"=>"API for National Firearms Act Special Occupational Taxpayers By State", "description"=>"api-for-exhibit-9-of-annual-atf-commerce-report", "version"=>"v1"}, "host"=>"data.atf.gov", "basePath"=>"/resource/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"national-firearms-act-special-occupational-taxpayers-by-state.json"=>{"get"=>{"summary"=>"National Firearms Act Special Occupational Taxpayers By State", "description"=>"National Firearms Act Special Occupational Taxpayers By State", "operationId"=>"", "x-api-path-slug"=>"nationalfirearmsactspecialoccupationaltaxpayersbystate-json-get", "parameters"=>[{"in"=>"query", "name"=>"dealers"}, {"in"=>"query", "name"=>"importers"}, {"in"=>"query", "name"=>"location_1"}, {"in"=>"query", "name"=>"manufacturers"}, {"in"=>"query", "name"=>"state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"Bureau of Alcohol, Tobacco, Firearms, and Explosives", "x-slug"=>"bureau-of-alcohol-tobacco-firearms-and-explosives", "description"=>"The Bureau of Alcohol, Tobacco, Firearms and Explosives (ATF, BATF, and BATFE) is a federal law enforcement organization within the United States Department of Justice.[4] Its responsibilities include the investigation and prevention of federal offenses involving the unlawful use, manufacture and possession of firearms and explosives; acts of arson and bombings; and illegal trafficking of alcohol and tobacco products. The ATF also regulates via licensing the sale, possession, and transportation of firearms, ammunition, and explosives in interstate commerce. Many of ATFs activities are carried out in conjunction with task forces made up of state and local law enforcement officers, such as Project Safe Neighborhoods. ATF operates a unique fire research laboratory in Beltsville, Maryland, where full-scale mock-ups of criminal arson can be reconstructed.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/399px-US-AlcoholTobaccoFirearmsAndExplosives-Seal.svg.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,Federal Government,General Data,Historical Data API,Policing,Profiles,Stack Network,Surveillance", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bureau-of-alcohol-tobacco-firearms-and-explosives/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"API for Actions On Federal Firearms License Applications", "x-api-slug"=>"api-for-actions-on-federal-firearms-license-applications", "description"=>"The Bureau of Alcohol, Tobacco, Firearms and Explosives (ATF, BATF, and BATFE) is a federal law enforcement organization within the United States Department of Justice.[4] Its responsibilities include the investigation and prevention of federal offenses involving the unlawful use, manufacture and possession of firearms and explosives; acts of arson and bombings; and illegal trafficking of alcohol and tobacco products. The ATF also regulates via licensing the sale, possession, and transportation of firearms, ammunition, and explosives in interstate commerce. Many of ATFs activities are carried out in conjunction with task forces made up of state and local law enforcement officers, such as Project Safe Neighborhoods. ATF operates a unique fire research laboratory in Beltsville, Maryland, where full-scale mock-ups of criminal arson can be reconstructed.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/399px-US-AlcoholTobaccoFirearmsAndExplosives-Seal.svg.png", "humanURL"=>"http://atf.gov", "baseURL"=>"https://data.atf.gov//resource/", "tags"=>"API Provider,Federal Government,General Data,Historical Data API,Policing,Profiles,Stack Network,Surveillance", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/actionsonfederalfirearmslicenseapplications-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/api-for-actions-on-federal-firearms-license-applications-openapi.yaml"}]}, {"name"=>"API for Federal Firearms Licensees By State", "x-api-slug"=>"api-for-federal-firearms-licensees-by-state", "description"=>"The Bureau of Alcohol, Tobacco, Firearms and Explosives (ATF, BATF, and BATFE) is a federal law enforcement organization within the United States Department of Justice.[4] Its responsibilities include the investigation and prevention of federal offenses involving the unlawful use, manufacture and possession of firearms and explosives; acts of arson and bombings; and illegal trafficking of alcohol and tobacco products. The ATF also regulates via licensing the sale, possession, and transportation of firearms, ammunition, and explosives in interstate commerce. Many of ATFs activities are carried out in conjunction with task forces made up of state and local law enforcement officers, such as Project Safe Neighborhoods. ATF operates a unique fire research laboratory in Beltsville, Maryland, where full-scale mock-ups of criminal arson can be reconstructed.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/399px-US-AlcoholTobaccoFirearmsAndExplosives-Seal.svg.png", "humanURL"=>"http://atf.gov", "baseURL"=>"https://data.atf.gov//resource/", "tags"=>"Actions,On,Federal,Firearms,License,Applications,Json", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/federalfirearmslicenseesbystate-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/api-for-federal-firearms-licensees-by-state-openapi.yaml"}]}, {"name"=>"API for Firearms Imported Into The United States By Country", "x-api-slug"=>"api-for-firearms-imported-into-the-united-states-by-country", "description"=>"The Bureau of Alcohol, Tobacco, Firearms and Explosives (ATF, BATF, and BATFE) is a federal law enforcement organization within the United States Department of Justice.[4] Its responsibilities include the investigation and prevention of federal offenses involving the unlawful use, manufacture and possession of firearms and explosives; acts of arson and bombings; and illegal trafficking of alcohol and tobacco products. The ATF also regulates via licensing the sale, possession, and transportation of firearms, ammunition, and explosives in interstate commerce. Many of ATFs activities are carried out in conjunction with task forces made up of state and local law enforcement officers, such as Project Safe Neighborhoods. ATF operates a unique fire research laboratory in Beltsville, Maryland, where full-scale mock-ups of criminal arson can be reconstructed.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/399px-US-AlcoholTobaccoFirearmsAndExplosives-Seal.svg.png", "humanURL"=>"http://atf.gov", "baseURL"=>"https://data.atf.gov//resource/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/firearmsimportedintotheunitedstatesbycountry-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/api-for-firearms-imported-into-the-united-states-by-country-openapi.yaml"}]}, {"name"=>"API for Firearms Imports", "x-api-slug"=>"api-for-firearms-imports", "description"=>"The Bureau of Alcohol, Tobacco, Firearms and Explosives (ATF, BATF, and BATFE) is a federal law enforcement organization within the United States Department of Justice.[4] Its responsibilities include the investigation and prevention of federal offenses involving the unlawful use, manufacture and possession of firearms and explosives; acts of arson and bombings; and illegal trafficking of alcohol and tobacco products. The ATF also regulates via licensing the sale, possession, and transportation of firearms, ammunition, and explosives in interstate commerce. Many of ATFs activities are carried out in conjunction with task forces made up of state and local law enforcement officers, such as Project Safe Neighborhoods. ATF operates a unique fire research laboratory in Beltsville, Maryland, where full-scale mock-ups of criminal arson can be reconstructed.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/399px-US-AlcoholTobaccoFirearmsAndExplosives-Seal.svg.png", "humanURL"=>"http://atf.gov", "baseURL"=>"https://data.atf.gov//resource/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/firearmsimports-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/api-for-firearms-imports-openapi.yaml"}]}, {"name"=>"API for Firearms Manufacturers Exports", "x-api-slug"=>"api-for-firearms-manufacturers-exports", "description"=>"The Bureau of Alcohol, Tobacco, Firearms and Explosives (ATF, BATF, and BATFE) is a federal law enforcement organization within the United States Department of Justice.[4] Its responsibilities include the investigation and prevention of federal offenses involving the unlawful use, manufacture and possession of firearms and explosives; acts of arson and bombings; and illegal trafficking of alcohol and tobacco products. The ATF also regulates via licensing the sale, possession, and transportation of firearms, ammunition, and explosives in interstate commerce. Many of ATFs activities are carried out in conjunction with task forces made up of state and local law enforcement officers, such as Project Safe Neighborhoods. ATF operates a unique fire research laboratory in Beltsville, Maryland, where full-scale mock-ups of criminal arson can be reconstructed.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/399px-US-AlcoholTobaccoFirearmsAndExplosives-Seal.svg.png", "humanURL"=>"http://atf.gov", "baseURL"=>"https://data.atf.gov//resource/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/firearmsmanufacturersexports-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/api-for-firearms-manufacturers-exports-openapi.yaml"}]}, {"name"=>"API for Firearms Types With A Recovery", "x-api-slug"=>"api-for-firearms-types-with-a-recovery", "description"=>"The Bureau of Alcohol, Tobacco, Firearms and Explosives (ATF, BATF, and BATFE) is a federal law enforcement organization within the United States Department of Justice.[4] Its responsibilities include the investigation and prevention of federal offenses involving the unlawful use, manufacture and possession of firearms and explosives; acts of arson and bombings; and illegal trafficking of alcohol and tobacco products. The ATF also regulates via licensing the sale, possession, and transportation of firearms, ammunition, and explosives in interstate commerce. Many of ATFs activities are carried out in conjunction with task forces made up of state and local law enforcement officers, such as Project Safe Neighborhoods. ATF operates a unique fire research laboratory in Beltsville, Maryland, where full-scale mock-ups of criminal arson can be reconstructed.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/399px-US-AlcoholTobaccoFirearmsAndExplosives-Seal.svg.png", "humanURL"=>"http://atf.gov", "baseURL"=>"https://data.atf.gov//resource/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/firearmstypeswitharecovery-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/api-for-firearms-types-with-a-recovery-openapi.yaml"}]}, {"name"=>"API for Importation Applications", "x-api-slug"=>"api-for-importation-applications", "description"=>"The Bureau of Alcohol, Tobacco, Firearms and Explosives (ATF, BATF, and BATFE) is a federal law enforcement organization within the United States Department of Justice.[4] Its responsibilities include the investigation and prevention of federal offenses involving the unlawful use, manufacture and possession of firearms and explosives; acts of arson and bombings; and illegal trafficking of alcohol and tobacco products. The ATF also regulates via licensing the sale, possession, and transportation of firearms, ammunition, and explosives in interstate commerce. Many of ATFs activities are carried out in conjunction with task forces made up of state and local law enforcement officers, such as Project Safe Neighborhoods. ATF operates a unique fire research laboratory in Beltsville, Maryland, where full-scale mock-ups of criminal arson can be reconstructed.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/399px-US-AlcoholTobaccoFirearmsAndExplosives-Seal.svg.png", "humanURL"=>"http://atf.gov", "baseURL"=>"https://data.atf.gov//resource/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/importationapplications-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/api-for-importation-applications-openapi.yaml"}]}, {"name"=>"API for National Firearms Act Firearms Processed By Form Type", "x-api-slug"=>"api-for-national-firearms-act-firearms-processed-by-form-type", "description"=>"The Bureau of Alcohol, Tobacco, Firearms and Explosives (ATF, BATF, and BATFE) is a federal law enforcement organization within the United States Department of Justice.[4] Its responsibilities include the investigation and prevention of federal offenses involving the unlawful use, manufacture and possession of firearms and explosives; acts of arson and bombings; and illegal trafficking of alcohol and tobacco products. The ATF also regulates via licensing the sale, possession, and transportation of firearms, ammunition, and explosives in interstate commerce. Many of ATFs activities are carried out in conjunction with task forces made up of state and local law enforcement officers, such as Project Safe Neighborhoods. ATF operates a unique fire research laboratory in Beltsville, Maryland, where full-scale mock-ups of criminal arson can be reconstructed.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/399px-US-AlcoholTobaccoFirearmsAndExplosives-Seal.svg.png", "humanURL"=>"http://atf.gov", "baseURL"=>"https://data.atf.gov//resource/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/nationalfirearmsactfirearmsprocessedbyformtype-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/api-for-national-firearms-act-firearms-processed-by-form-type-openapi.yaml"}]}, {"name"=>"API for National Firearms Act Special Occupational Taxpayers By State", "x-api-slug"=>"api-for-national-firearms-act-special-occupational-taxpayers-by-state", "description"=>"The Bureau of Alcohol, Tobacco, Firearms and Explosives (ATF, BATF, and BATFE) is a federal law enforcement organization within the United States Department of Justice.[4] Its responsibilities include the investigation and prevention of federal offenses involving the unlawful use, manufacture and possession of firearms and explosives; acts of arson and bombings; and illegal trafficking of alcohol and tobacco products. The ATF also regulates via licensing the sale, possession, and transportation of firearms, ammunition, and explosives in interstate commerce. Many of ATFs activities are carried out in conjunction with task forces made up of state and local law enforcement officers, such as Project Safe Neighborhoods. ATF operates a unique fire research laboratory in Beltsville, Maryland, where full-scale mock-ups of criminal arson can be reconstructed.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/399px-US-AlcoholTobaccoFirearmsAndExplosives-Seal.svg.png", "humanURL"=>"http://atf.gov", "baseURL"=>"https://data.atf.gov//resource/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/nationalfirearmsactspecialoccupationaltaxpayersbystate-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/api-for-national-firearms-act-special-occupational-taxpayers-by-state-openapi.yaml"}]}, {"name"=>"API for National Firearms Act Tax Revenues And Related Activities", "x-api-slug"=>"api-for-national-firearms-act-tax-revenues-and-related-activities", "description"=>"The Bureau of Alcohol, Tobacco, Firearms and Explosives (ATF, BATF, and BATFE) is a federal law enforcement organization within the United States Department of Justice.[4] Its responsibilities include the investigation and prevention of federal offenses involving the unlawful use, manufacture and possession of firearms and explosives; acts of arson and bombings; and illegal trafficking of alcohol and tobacco products. The ATF also regulates via licensing the sale, possession, and transportation of firearms, ammunition, and explosives in interstate commerce. Many of ATFs activities are carried out in conjunction with task forces made up of state and local law enforcement officers, such as Project Safe Neighborhoods. ATF operates a unique fire research laboratory in Beltsville, Maryland, where full-scale mock-ups of criminal arson can be reconstructed.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/399px-US-AlcoholTobaccoFirearmsAndExplosives-Seal.svg.png", "humanURL"=>"http://atf.gov", "baseURL"=>"https://data.atf.gov//resource/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/nationalfirearmsacttaxrevenuesandrelatedactivities-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/api-for-national-firearms-act-tax-revenues-and-related-activities-openapi.yaml"}]}, {"name"=>"API for Pistols - Firearms Manufacturing Report", "x-api-slug"=>"api-for-pistols--firearms-manufacturing-report", "description"=>"The Bureau of Alcohol, Tobacco, Firearms and Explosives (ATF, BATF, and BATFE) is a federal law enforcement organization within the United States Department of Justice.[4] Its responsibilities include the investigation and prevention of federal offenses involving the unlawful use, manufacture and possession of firearms and explosives; acts of arson and bombings; and illegal trafficking of alcohol and tobacco products. The ATF also regulates via licensing the sale, possession, and transportation of firearms, ammunition, and explosives in interstate commerce. Many of ATFs activities are carried out in conjunction with task forces made up of state and local law enforcement officers, such as Project Safe Neighborhoods. ATF operates a unique fire research laboratory in Beltsville, Maryland, where full-scale mock-ups of criminal arson can be reconstructed.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/399px-US-AlcoholTobaccoFirearmsAndExplosives-Seal.svg.png", "humanURL"=>"http://atf.gov", "baseURL"=>"https://data.atf.gov//resource/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/pistolsfirearmsmanufacturingreport-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/api-for-pistols--firearms-manufacturing-report-openapi.yaml"}]}, {"name"=>"API for Top Categories Reported On Firearm Traces with a Recovery", "x-api-slug"=>"api-for-top-categories-reported-on-firearm-traces-with-a-recovery", "description"=>"The Bureau of Alcohol, Tobacco, Firearms and Explosives (ATF, BATF, and BATFE) is a federal law enforcement organization within the United States Department of Justice.[4] Its responsibilities include the investigation and prevention of federal offenses involving the unlawful use, manufacture and possession of firearms and explosives; acts of arson and bombings; and illegal trafficking of alcohol and tobacco products. The ATF also regulates via licensing the sale, possession, and transportation of firearms, ammunition, and explosives in interstate commerce. Many of ATFs activities are carried out in conjunction with task forces made up of state and local law enforcement officers, such as Project Safe Neighborhoods. ATF operates a unique fire research laboratory in Beltsville, Maryland, where full-scale mock-ups of criminal arson can be reconstructed.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/399px-US-AlcoholTobaccoFirearmsAndExplosives-Seal.svg.png", "humanURL"=>"http://atf.gov", "baseURL"=>"https://data.atf.gov//resource/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/topcategoriesreportedonfirearmtraceswitharecovery-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/api-for-top-categories-reported-on-firearm-traces-with-a-recovery-openapi.yaml"}]}, {"name"=>"API for Top Recovery Cities For Firearms With A Recovery", "x-api-slug"=>"api-for-top-recovery-cities-for-firearms-with-a-recovery", "description"=>"The Bureau of Alcohol, Tobacco, Firearms and Explosives (ATF, BATF, and BATFE) is a federal law enforcement organization within the United States Department of Justice.[4] Its responsibilities include the investigation and prevention of federal offenses involving the unlawful use, manufacture and possession of firearms and explosives; acts of arson and bombings; and illegal trafficking of alcohol and tobacco products. The ATF also regulates via licensing the sale, possession, and transportation of firearms, ammunition, and explosives in interstate commerce. Many of ATFs activities are carried out in conjunction with task forces made up of state and local law enforcement officers, such as Project Safe Neighborhoods. ATF operates a unique fire research laboratory in Beltsville, Maryland, where full-scale mock-ups of criminal arson can be reconstructed.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/399px-US-AlcoholTobaccoFirearmsAndExplosives-Seal.svg.png", "humanURL"=>"http://atf.gov", "baseURL"=>"https://data.atf.gov//resource/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/toprecoverycitiesforfirearmswitharecovery-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/api-for-top-recovery-cities-for-firearms-with-a-recovery-openapi.yaml"}]}, {"name"=>"API Time To Crime Rates For Firearms With A Recovery", "x-api-slug"=>"api-time-to-crime-rates-for-firearms-with-a-recovery", "description"=>"The Bureau of Alcohol, Tobacco, Firearms and Explosives (ATF, BATF, and BATFE) is a federal law enforcement organization within the United States Department of Justice.[4] Its responsibilities include the investigation and prevention of federal offenses involving the unlawful use, manufacture and possession of firearms and explosives; acts of arson and bombings; and illegal trafficking of alcohol and tobacco products. The ATF also regulates via licensing the sale, possession, and transportation of firearms, ammunition, and explosives in interstate commerce. Many of ATFs activities are carried out in conjunction with task forces made up of state and local law enforcement officers, such as Project Safe Neighborhoods. ATF operates a unique fire research laboratory in Beltsville, Maryland, where full-scale mock-ups of criminal arson can be reconstructed.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/399px-US-AlcoholTobaccoFirearmsAndExplosives-Seal.svg.png", "humanURL"=>"http://atf.gov", "baseURL"=>"https://data.atf.gov//resource/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/timetocrimeratesforfirearmswitharecovery-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bureau-of-alcohol-tobacco-firearms-and-explosives/api-time-to-crime-rates-for-firearms-with-a-recovery-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"https://data.atf.gov/developers"}, {"type"=>"x-website", "url"=>"http://atf.gov"}, {"type"=>"x-website", "url"=>"https://www.atf.gov"}, {"type"=>"x-wikipedia", "url"=>"http://en.wikipedia.org/wiki/Bureau_of_Alcohol,_Tobacco,_Firearms,_and_Explosives"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-workspaces{"aws-workspaces-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS WorkSpaces", "x-complete"=>1, "info"=>{"title"=>"AWS WorkSpaces Service API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=CreateTags"=>{"get"=>{"summary"=>"Create Tags", "description"=>"Creates tags for a WorkSpace.", "operationId"=>"createTags", "x-api-path-slug"=>"actioncreatetags-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceId", "description"=>"The resource ID of the request", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"The tags of the request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=CreateWorkspaces"=>{"get"=>{"summary"=>"Create Workspaces", "description"=>"Creates one or more WorkSpaces.", "operationId"=>"createWorkspaces", "x-api-path-slug"=>"actioncreateworkspaces-get", "parameters"=>[{"in"=>"query", "name"=>"Workspaces", "description"=>"An array of structures that specify the WorkSpaces to create", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/?Action=DeleteTags"=>{"get"=>{"summary"=>"Delete Tags", "description"=>"Deletes tags from a WorkSpace.", "operationId"=>"deleteTags", "x-api-path-slug"=>"actiondeletetags-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceId", "description"=>"The resource ID of the request", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys", "description"=>"The tag keys of the request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=DescribeTags"=>{"get"=>{"summary"=>"Describe Tags", "description"=>"Describes tags for a WorkSpace.", "operationId"=>"describeTags", "x-api-path-slug"=>"actiondescribetags-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceId", "description"=>"The resource ID of the request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=DescribeWorkspaceBundles"=>{"get"=>{"summary"=>"Describe Workspace Bundles", "description"=>"Obtains information about the WorkSpace bundles that are available to your account in the specified region.", "operationId"=>"describeWorkspaceBundles", "x-api-path-slug"=>"actiondescribeworkspacebundles-get", "parameters"=>[{"in"=>"query", "name"=>"BundleIds", "description"=>"An array of strings that contains the identifiers of the bundles to retrieve", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The NextToken value from a previous call to this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Owner", "description"=>"The owner of the bundles to retrieve", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspace Bundles"]}}, "/?Action=DescribeWorkspaceDirectories"=>{"get"=>{"summary"=>"Describe Workspace Directories", "description"=>"Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.", "operationId"=>"describeWorkspaceDirectories", "x-api-path-slug"=>"actiondescribeworkspacedirectories-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryIds", "description"=>"An array of strings that contains the directory identifiers to retrieve information for", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The NextToken value from a previous call to this operation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspace Directories"]}}, "/?Action=DescribeWorkspaces"=>{"get"=>{"summary"=>"Describe Workspaces", "description"=>"Obtains information about the specified WorkSpaces.", "operationId"=>"describeWorkspaces", "x-api-path-slug"=>"actiondescribeworkspaces-get", "parameters"=>[{"in"=>"query", "name"=>"BundleId", "description"=>"The identifier of a bundle to obtain the WorkSpaces for", "type"=>"string"}, {"in"=>"query", "name"=>"DirectoryId", "description"=>"Specifies the directory identifier to which to limit the WorkSpaces", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The NextToken value from a previous call to this operation", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"Used with the DirectoryId parameter to specify the directory user for whom to obtain the WorkSpace", "type"=>"string"}, {"in"=>"query", "name"=>"WorkspaceIds", "description"=>"An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspaces"]}}, "/?Action=DescribeWorkspacesConnectionStatus"=>{"get"=>{"summary"=>"Describe Workspaces Connection Status", "description"=>"Describes the connection status of a specified WorkSpace.", "operationId"=>"describeWorkspacesConnectionStatus", "x-api-path-slug"=>"actiondescribeworkspacesconnectionstatus-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"The next token of the request", "type"=>"string"}, {"in"=>"query", "name"=>"WorkspaceIds", "description"=>"An array of strings that contain the identifiers of the WorkSpaces", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspaces"]}}, "/?Action=ModifyWorkspaceProperties"=>{"get"=>{"summary"=>"Modify Workspace Properties", "description"=>"Modifies the WorkSpace properties, including the running mode and AutoStop time.", "operationId"=>"modifyWorkspaceProperties", "x-api-path-slug"=>"actionmodifyworkspaceproperties-get", "parameters"=>[{"in"=>"query", "name"=>"WorkspaceId", "description"=>"The ID of the WorkSpace", "type"=>"string"}, {"in"=>"query", "name"=>"WorkspaceProperties", "description"=>"The WorkSpace properties of the request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspaces"]}}, "/?Action=RebootWorkspaces"=>{"get"=>{"summary"=>"Reboot Workspaces", "description"=>"Reboots the specified WorkSpaces.", "operationId"=>"rebootWorkspaces", "x-api-path-slug"=>"actionrebootworkspaces-get", "parameters"=>[{"in"=>"query", "name"=>"RebootWorkspaceRequests", "description"=>"An array of structures that specify the WorkSpaces to reboot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspaces"]}}, "/?Action=RebuildWorkspaces"=>{"get"=>{"summary"=>"Rebuild Workspaces", "description"=>"Rebuilds the specified WorkSpaces.", "operationId"=>"rebuildWorkspaces", "x-api-path-slug"=>"actionrebuildworkspaces-get", "parameters"=>[{"in"=>"query", "name"=>"RebuildWorkspaceRequests", "description"=>"An array of structures that specify the WorkSpaces to rebuild", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspaces"]}}, "/?Action=StartWorkspaces"=>{"get"=>{"summary"=>"Start Workspaces", "description"=>"Starts the specified WorkSpaces.", "operationId"=>"startWorkspaces", "x-api-path-slug"=>"actionstartworkspaces-get", "parameters"=>[{"in"=>"query", "name"=>"StartWorkspaceRequests", "description"=>"The requests", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspaces"]}}, "/?Action=StopWorkspaces"=>{"get"=>{"summary"=>"Stop Workspaces", "description"=>"Stops the specified WorkSpaces.", "operationId"=>"stopWorkspaces", "x-api-path-slug"=>"actionstopworkspaces-get", "parameters"=>[{"in"=>"query", "name"=>"StopWorkspaceRequests", "description"=>"The requests", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspaces"]}}, "/?Action=TerminateWorkspaces"=>{"get"=>{"summary"=>"Terminate Workspaces", "description"=>"Terminates the specified WorkSpaces.", "operationId"=>"terminateWorkspaces", "x-api-path-slug"=>"actionterminateworkspaces-get", "parameters"=>[{"in"=>"query", "name"=>"TerminateWorkspaceRequests", "description"=>"An array of structures that specify the WorkSpaces to terminate", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspaces"]}}}}, "apis"=>{"name"=>"AWS WorkSpaces", "x-slug"=>"aws-workspaces", "description"=>"Amazon WorkSpaces is a fully managed, secure desktop computing service which runs on the AWS cloud. Amazon WorkSpaces allows you to easily provision cloud-based virtual desktops and provide your users access to the documents, applications, and resources they need from any supported device, including Windows and Mac computers, Chromebooks, iPads, Fire tablets, Android tablets, and Chrome and Firefox web browsers. With just a few clicks in the AWS Management Console, you can deploy high-quality cloud desktops for any number of users. With Amazon WorkSpaces, you pay either monthly or hourly just for the Amazon WorkSpaces you launch, which helps you save money when compared to traditional desktops and on-premises Virtual Desktop Infrastructure (VDI) solutions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Enterprise-Applications_AmazonWorkSpaces.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Desktops,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-workspaces/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS WorkSpaces Service API", "x-api-slug"=>"aws-workspaces-service-api", "description"=>"Amazon WorkSpaces is a fully managed, secure desktop computing service which runs on the AWS cloud. Amazon WorkSpaces allows you to easily provision cloud-based virtual desktops and provide your users access to the documents, applications, and resources they need from any supported device, including Windows and Mac computers, Chromebooks, iPads, Fire tablets, Android tablets, and Chrome and Firefox web browsers. With just a few clicks in the AWS Management Console, you can deploy high-quality cloud desktops for any number of users. With Amazon WorkSpaces, you pay either monthly or hourly just for the Amazon WorkSpaces you launch, which helps you save money when compared to traditional desktops and on-premises Virtual Desktop Infrastructure (VDI) solutions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Enterprise-Applications_AmazonWorkSpaces.png", "humanURL"=>"https://aws.amazon.com/workspaces/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Desktops,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-workspaces/aws-workspaces-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/workspaces/latest/api/api-reference.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/workspaces/faqs/"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=164"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/workspaces/pricing/"}, {"type"=>"x-testimonials", "url"=>"https://aws.amazon.com/workspaces/testimonials/"}, {"type"=>"x-webinars", "url"=>"https://aws.amazon.com/workspaces/resources/#webinars"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/workspaces/"}, {"type"=>"x-white-papers", "url"=>"https://aws.amazon.com/workspaces/resources/#whitepapers"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
authoritylabs{"authority-labs-partner-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AuthorityLabs", "x-complete"=>1, "info"=>{"title"=>"Authority Labs Partner API", "description"=>"the-partner-api-should-be-used-when-you-only-require-search-results-and-is-different-from-our-standard-interface-accounts--pricing-is-based-on-specific-endpoint-usage-per-thousand-calls-", "termsOfService"=>"http://authoritylabs.com/terms/", "version"=>"v1"}, "host"=>"api.authoritylabs.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/keywords"=>{"post"=>{"summary"=>"Delayed Queue", "description"=>"Delayed Queue", "operationId"=>"delayed-queue", "x-api-path-slug"=>"keywords-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keywords"]}}, "/keywords/priority"=>{"post"=>{"summary"=>"Priority Queue", "description"=>"Priority Queue", "operationId"=>"priority-queue", "x-api-path-slug"=>"keywordspriority-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keywords", "Priority"]}}, "/keywords/{keyword}"=>{"get"=>{"summary"=>"Search Results", "description"=>"Search Results", "operationId"=>"search-results", "x-api-path-slug"=>"keywordskeyword-get", "parameters"=>[{"in"=>"path", "name"=>"keyword"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keywords", "Keyword"]}}}}, "apis"=>{"name"=>"AuthorityLabs", "x-slug"=>"authoritylabs", "description"=>"Track website rankings in Google, Yahoo!, and Bing daily. Our automated SERP tracking saves you time and helps you respond quickly to ranking changes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/694-authoritylabs.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"297230", "tags"=>"Analysis,Analysis,API Service Provider,General Data,internet,Profiles,Relative Data,SaaS,SEO,SEO Rank checking service,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"authoritylabs/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Authority Labs Partner API", "x-api-slug"=>"authority-labs-partner-api", "description"=>"Track website rankings in Google, Yahoo!, and Bing daily. Our automated SERP tracking saves you time and helps you respond quickly to ranking changes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/694-authoritylabs.jpg", "humanURL"=>"http://authoritylabs.com", "baseURL"=>"https://api.authoritylabs.com//", "tags"=>"Analysis,Analysis,API Service Provider,General Data,internet,Profiles,Relative Data,SaaS,SEO,SEO Rank checking service,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/authoritylabs/keywordskeyword-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/authoritylabs/authority-labs-partner-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.authoritylabs.com/"}, {"type"=>"x-blog", "url"=>"http://blog.authoritylabs.com"}, {"type"=>"x-blog-rss", "url"=>"http://feeds.feedburner.com/authoritylabsblog"}, {"type"=>"x-console", "url"=>"http://authoritylabs.com/api/console/"}, {"type"=>"x-contact-form", "url"=>"http://authoritylabs.com/contact/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/authoritylabs"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/authoritylabs"}, {"type"=>"x-developer", "url"=>"http://authoritylabs.com/api/"}, {"type"=>"x-documentation", "url"=>"http://docs.authoritylabs.apiary.io/#keywordrankresource"}, {"type"=>"x-email", "url"=>"info@authoritylabs.com"}, {"type"=>"x-github", "url"=>"https://github.com/authoritylabs"}, {"type"=>"x-pricing", "url"=>"https://authoritylabs.com/pricing/"}, {"type"=>"x-privacy", "url"=>"http://authoritylabs.com/privacy/"}, {"type"=>"x-rate-limits", "url"=>"http://authoritylabs.com/api/partner-api/#rate-limiting"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/authoritylabs"}, {"type"=>"x-website", "url"=>"http://authoritylabs.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-kinesis{"aws-kinesis-firehose-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Kinesis", "x-complete"=>1, "info"=>{"title"=>"AWS Kinesis Firehose API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=CreateDeliveryStream"=>{"get"=>{"summary"=>"Create Delivery Stream", "description"=>"creates a delivery stream.", "operationId"=>"CreateDeliveryStream", "x-api-path-slug"=>"actioncreatedeliverystream-get", "parameters"=>[{"in"=>"query", "name"=>"DeliveryStreamName", "description"=>"The name of the delivery stream", "type"=>"string"}, {"in"=>"query", "name"=>"ElasticsearchDestinationConfiguration", "description"=>"The destination in Amazon ES", "type"=>"string"}, {"in"=>"query", "name"=>"ExtendedS3DestinationConfiguration", "description"=>"The destination in Amazon S3", "type"=>"string"}, {"in"=>"query", "name"=>"RedshiftDestinationConfiguration", "description"=>"The destination in Amazon Redshift", "type"=>"string"}, {"in"=>"query", "name"=>"S3DestinationConfiguration", "description"=>"[Deprecated] The destination in Amazon S3", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Delivery Streams"]}}, "/?Action=DeleteDeliveryStream"=>{"get"=>{"summary"=>"Delete Delivery Stream", "description"=>"deletes a delivery stream and its data.", "operationId"=>"DeleteDeliveryStream", "x-api-path-slug"=>"actiondeletedeliverystream-get", "parameters"=>[{"in"=>"query", "name"=>"DeliveryStreamName", "description"=>"The name of the delivery stream", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Delivery Streams"]}}, "/?Action=DescribeDeliveryStream"=>{"get"=>{"summary"=>"Describe Delivery Stream", "description"=>"describes the specified delivery stream and gets the status.", "operationId"=>"DescribeDeliveryStream", "x-api-path-slug"=>"actiondescribedeliverystream-get", "parameters"=>[{"in"=>"query", "name"=>"DeliveryStreamName", "description"=>"The name of the delivery stream", "type"=>"string"}, {"in"=>"query", "name"=>"ExclusiveStartDestinationId", "description"=>"The ID of the destination to start returning the destination information", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The limit on the number of destinations to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Delivery Streams"]}}, "/?Action=ListDeliveryStreams"=>{"get"=>{"summary"=>"List Delivery Streams", "description"=>"lists your delivery streams.", "operationId"=>"ListDeliveryStreams", "x-api-path-slug"=>"actionlistdeliverystreams-get", "parameters"=>[{"in"=>"query", "name"=>"ExclusiveStartDeliveryStreamName", "description"=>"The name of the delivery stream to start the list with", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of delivery streams to list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Delivery Streams"]}}, "/?Action=PutRecord"=>{"get"=>{"summary"=>"Put Record", "description"=>"writes a single data record into an Amazon Kinesis Firehose delivery stream.", "operationId"=>"PutRecord", "x-api-path-slug"=>"actionputrecord-get", "parameters"=>[{"in"=>"query", "name"=>"DeliveryStreamName", "description"=>"The name of the delivery stream", "type"=>"string"}, {"in"=>"query", "name"=>"Record", "description"=>"The record", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Records"]}}, "/?Action=PutRecordBatch"=>{"get"=>{"summary"=>"Put Record Batch", "description"=>"writes multiple data records into a delivery stream in a single call, which can\n achieve higher throughput per producer than when writing single records.", "operationId"=>"PutRecordBatch", "x-api-path-slug"=>"actionputrecordbatch-get", "parameters"=>[{"in"=>"query", "name"=>"DeliveryStreamName", "description"=>"The name of the delivery stream", "type"=>"string"}, {"in"=>"query", "name"=>"Records", "description"=>"One or more records", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Records"]}}, "/?Action=UpdateDestination"=>{"get"=>{"summary"=>"Update Destination", "description"=>"updates the specified destination of the specified delivery stream.", "operationId"=>"UpdateDestination", "x-api-path-slug"=>"actionupdatedestination-get", "parameters"=>[{"in"=>"query", "name"=>"CurrentDeliveryStreamVersionId", "description"=>"Obtain this value from the VersionId result of DeliveryStreamDescription", "type"=>"string"}, {"in"=>"query", "name"=>"DeliveryStreamName", "description"=>"The name of the delivery stream", "type"=>"string"}, {"in"=>"query", "name"=>"DestinationId", "description"=>"The ID of the destination", "type"=>"string"}, {"in"=>"query", "name"=>"ElasticsearchDestinationUpdate", "description"=>"Describes an update for a destination in Amazon ES", "type"=>"string"}, {"in"=>"query", "name"=>"ExtendedS3DestinationUpdate", "description"=>"Describes an update for a destination in Amazon S3", "type"=>"string"}, {"in"=>"query", "name"=>"RedshiftDestinationUpdate", "description"=>"Describes an update for a destination in Amazon Redshift", "type"=>"string"}, {"in"=>"query", "name"=>"S3DestinationUpdate", "description"=>"[Deprecated] Describes an update for a destination in Amazon S3", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Destinations"]}}}}, "apis"=>{"name"=>"AWS Kinesis", "x-slug"=>"aws-kinesis", "description"=>"Amazon Kinesis Firehose is the easiest way to load streaming data into AWS. It can capture, transform, and load streaming data into Amazon Kinesis Analytics, Amazon S3, Amazon Redshift, and Amazon Elasticsearch Service, enabling near real-time analytics with existing business intelligence tools and dashboards you are already using today.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Analytics_AmazonKinesis_AmazonKinesisFirehose.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Data,Databases,Profiles,Real Time,Relative Data,SDIO Competition,Service API,Stack Network,Streaming", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-kinesis/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Kinesis Firehose API", "x-api-slug"=>"aws-kinesis-firehose-api", "description"=>"Amazon Kinesis Firehose is the easiest way to load streaming data into AWS. It can capture, transform, and load streaming data into Amazon Kinesis Analytics, Amazon S3, Amazon Redshift, and Amazon Elasticsearch Service, enabling near real-time analytics with existing business intelligence tools and dashboards you are already using today.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Analytics_AmazonKinesis_AmazonKinesisFirehose.png", "humanURL"=>"https://aws.amazon.com/kinesis/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Data,Databases,Profiles,Real Time,Relative Data,SDIO Competition,Service API,Stack Network,Streaming", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-kinesis/aws-kinesis-firehose-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-hacker-news-search", "url"=>"Amazon Kinesis"}, {"type"=>"x-console", "url"=>"https://console.aws.amazon.com/firehose/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/firehose/latest/APIReference/Welcome.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/kinesis/firehose/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/kinesis/firehose/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/kinesis/firehose/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/kinesis/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-directory-service{"aws-directory-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Directory Service", "x-complete"=>1, "info"=>{"title"=>"AWS Directory Service API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddIpRoutes"=>{"get"=>{"summary"=>"Add Ip Routes", "description"=>"If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services.", "operationId"=>"addIpRoutes", "x-api-path-slug"=>"actionaddiproutes-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"Identifier (ID) of the directory to which to add the address block", "type"=>"string"}, {"in"=>"query", "name"=>"IpRoutes", "description"=>"IP address blocks, using CIDR format, of the traffic to route", "type"=>"string"}, {"in"=>"query", "name"=>"UpdateSecurityGroupForDirectoryControllers", "description"=>"If set to true, updates the inbound and outbound rules of the security group that has the description: AWS created security group for directory ID directory controllers", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Address Routes"]}}, "/?Action=AddTagsToResource"=>{"get"=>{"summary"=>"Add Tags To Resource", "description"=>"Adds or overwrites one or more tags for the specified directory.", "operationId"=>"addTagsToResource", "x-api-path-slug"=>"actionaddtagstoresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceId", "description"=>"Identifier (ID) for the directory to which to add the tag", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"The tags to be assigned to the directory", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Tags"]}}, "/?Action=CancelSchemaExtension"=>{"get"=>{"summary"=>"Cancel Schema Extension", "description"=>"Cancels an in-progress schema extension to a Microsoft AD directory.", "operationId"=>"cancelSchemaExtension", "x-api-path-slug"=>"actioncancelschemaextension-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The identifier of the directory whose schema extension will be canceled", "type"=>"string"}, {"in"=>"query", "name"=>"SchemaExtensionId", "description"=>"The identifier of the schema extension that will be canceled", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schemas"]}}, "/?Action=ConnectDirectory"=>{"get"=>{"summary"=>"Connect Directory", "description"=>"Creates an AD Connector to connect to an on-premises directory.", "operationId"=>"connectDirectory", "x-api-path-slug"=>"actionconnectdirectory-get", "parameters"=>[{"in"=>"query", "name"=>"ConnectSettings", "description"=>"A DirectoryConnectSettings object that contains additional information for the operation", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A textual description for the directory", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The fully-qualified name of the on-premises directory, such as corp", "type"=>"string"}, {"in"=>"query", "name"=>"Password", "description"=>"The password for the on-premises user account", "type"=>"string"}, {"in"=>"query", "name"=>"ShortName", "description"=>"The NetBIOS name of the on-premises directory, such as CORP", "type"=>"string"}, {"in"=>"query", "name"=>"Size", "description"=>"The size of the directory", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Directories"]}}, "/?Action=CreateAlias"=>{"get"=>{"summary"=>"Create Alias", "description"=>"Creates an alias for a directory and assigns the alias to the directory.", "operationId"=>"createAlias", "x-api-path-slug"=>"actioncreatealias-get", "parameters"=>[{"in"=>"query", "name"=>"Alias", "description"=>"The requested alias", "type"=>"string"}, {"in"=>"query", "name"=>"DirectoryId", "description"=>"The identifier of the directory for which to create the alias", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alias"]}}, "/?Action=CreateComputer"=>{"get"=>{"summary"=>"Create Computer", "description"=>"Creates a computer account in the specified directory, and joins the computer to the directory.", "operationId"=>"createComputer", "x-api-path-slug"=>"actioncreatecomputer-get", "parameters"=>[{"in"=>"query", "name"=>"ComputerAttributes", "description"=>"An array of Attribute objects that contain any LDAP attributes to apply to the computer account", "type"=>"string"}, {"in"=>"query", "name"=>"ComputerName", "description"=>"The name of the computer account", "type"=>"string"}, {"in"=>"query", "name"=>"DirectoryId", "description"=>"The identifier of the directory in which to create the computer account", "type"=>"string"}, {"in"=>"query", "name"=>"OrganizationalUnitDistinguishedName", "description"=>"The fully-qualified distinguished name of the organizational unit to place the computer account in", "type"=>"string"}, {"in"=>"query", "name"=>"Password", "description"=>"A one-time password that is used to join the computer to the directory", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Computer"]}}, "/?Action=CreateConditionalForwarder"=>{"get"=>{"summary"=>"Create Conditional Forwarder", "description"=>"Creates a conditional forwarder associated with your AWS directory.", "operationId"=>"createConditionalForwarder", "x-api-path-slug"=>"actioncreateconditionalforwarder-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The directory ID of the AWS directory for which you are creating the conditional forwarder", "type"=>"string"}, {"in"=>"query", "name"=>"DnsIpAddrs", "description"=>"The IP addresses of the remote DNS server associated with RemoteDomainName", "type"=>"string"}, {"in"=>"query", "name"=>"RemoteDomainName", "description"=>"The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conditional Forwarder"]}}, "/?Action=CreateDirectory"=>{"get"=>{"summary"=>"Create Directory", "description"=>"Creates a Simple AD directory.", "operationId"=>"createDirectory", "x-api-path-slug"=>"actioncreatedirectory-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"A textual description for the directory", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The fully qualified name for the directory, such as corp", "type"=>"string"}, {"in"=>"query", "name"=>"Password", "description"=>"The password for the directory administrator", "type"=>"string"}, {"in"=>"query", "name"=>"ShortName", "description"=>"The short name of the directory, such as CORP", "type"=>"string"}, {"in"=>"query", "name"=>"Size", "description"=>"The size of the directory", "type"=>"string"}, {"in"=>"query", "name"=>"VpcSettings", "description"=>"A DirectoryVpcSettings object that contains additional information for the operation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Directories"]}}, "/?Action=CreateMicrosoftAD"=>{"get"=>{"summary"=>"Create Microsoft A D", "description"=>"Creates a Microsoft AD in the AWS cloud.", "operationId"=>"createMicrosoftAD", "x-api-path-slug"=>"actioncreatemicrosoftad-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"A textual description for the directory", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The fully qualified domain name for the directory, such as corp", "type"=>"string"}, {"in"=>"query", "name"=>"Password", "description"=>"The password for the default administrative user named Admin", "type"=>"string"}, {"in"=>"query", "name"=>"ShortName", "description"=>"The NetBIOS name for your domain", "type"=>"string"}, {"in"=>"query", "name"=>"VpcSettings", "description"=>"Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Microsoft AD"]}}, "/?Action=CreateSnapshot"=>{"get"=>{"summary"=>"Create Snapshot", "description"=>"Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.", "operationId"=>"createSnapshot", "x-api-path-slug"=>"actioncreatesnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The identifier of the directory of which to take a snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The descriptive name to apply to the snapshot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshot"]}}, "/?Action=CreateTrust"=>{"get"=>{"summary"=>"Create Trust", "description"=>"AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships.", "operationId"=>"createTrust", "x-api-path-slug"=>"actioncreatetrust-get", "parameters"=>[{"in"=>"query", "name"=>"ConditionalForwarderIpAddrs", "description"=>"The IP addresses of the remote DNS server associated with RemoteDomainName", "type"=>"string"}, {"in"=>"query", "name"=>"DirectoryId", "description"=>"The Directory ID of the Microsoft AD in the AWS cloud for which to establish the trust relationship", "type"=>"string"}, {"in"=>"query", "name"=>"RemoteDomainName", "description"=>"The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship", "type"=>"string"}, {"in"=>"query", "name"=>"TrustDirection", "description"=>"The direction of the trust relationship", "type"=>"string"}, {"in"=>"query", "name"=>"TrustPassword", "description"=>"The trust password", "type"=>"string"}, {"in"=>"query", "name"=>"TrustType", "description"=>"The trust relationship type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trust"]}}, "/?Action=DeleteConditionalForwarder"=>{"get"=>{"summary"=>"Delete Conditional Forwarder", "description"=>"Deletes a conditional forwarder that has been set up for your AWS directory.", "operationId"=>"deleteConditionalForwarder", "x-api-path-slug"=>"actiondeleteconditionalforwarder-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The directory ID for which you are deleting the conditional forwarder", "type"=>"string"}, {"in"=>"query", "name"=>"RemoteDomainName", "description"=>"The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conditional Forwarder"]}}, "/?Action=DeleteDirectory"=>{"get"=>{"summary"=>"Delete Directory", "description"=>"Deletes an AWS Directory Service directory.", "operationId"=>"deleteDirectory", "x-api-path-slug"=>"actiondeletedirectory-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The identifier of the directory to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Directories"]}}, "/?Action=DeleteSnapshot"=>{"get"=>{"summary"=>"Delete Snapshot", "description"=>"Deletes a directory snapshot.", "operationId"=>"deleteSnapshot", "x-api-path-slug"=>"actiondeletesnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"SnapshotId", "description"=>"The identifier of the directory snapshot to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=DeleteTrust"=>{"get"=>{"summary"=>"Delete Trust", "description"=>"Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.", "operationId"=>"deleteTrust", "x-api-path-slug"=>"actiondeletetrust-get", "parameters"=>[{"in"=>"query", "name"=>"DeleteAssociatedConditionalForwarder", "description"=>"Delete a conditional forwarder as part of a DeleteTrustRequest", "type"=>"string"}, {"in"=>"query", "name"=>"TrustId", "description"=>"The Trust ID of the trust relationship to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trust"]}}, "/?Action=DeregisterEventTopic"=>{"get"=>{"summary"=>"Deregister Event Topic", "description"=>"Removes the specified directory as a publisher to the specified SNS topic.", "operationId"=>"deregisterEventTopic", "x-api-path-slug"=>"actionderegistereventtopic-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The Directory ID to remove as a publisher", "type"=>"string"}, {"in"=>"query", "name"=>"TopicName", "description"=>"The name of the SNS topic from which to remove the directory as a publisher", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Topics"]}}, "/?Action=DescribeConditionalForwarders"=>{"get"=>{"summary"=>"Describe Conditional Forwarders", "description"=>"Obtains information about the conditional forwarders for this account.", "operationId"=>"describeConditionalForwarders", "x-api-path-slug"=>"actiondescribeconditionalforwarders-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The directory ID for which to get the list of associated conditional forwarders", "type"=>"string"}, {"in"=>"query", "name"=>"RemoteDomainNames", "description"=>"The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conditional Forwarder"]}}, "/?Action=DescribeDirectories"=>{"get"=>{"summary"=>"Describe Directories", "description"=>"Obtains information about the directories that belong to this account.", "operationId"=>"describeDirectories", "x-api-path-slug"=>"actiondescribedirectories-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryIds", "description"=>"A list of identifiers of the directories for which to obtain the information", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The DescribeDirectoriesResult", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Directories"]}}, "/?Action=DescribeEventTopics"=>{"get"=>{"summary"=>"Describe Event Topics", "description"=>"Obtains information about which SNS topics receive status messages from the specified directory.", "operationId"=>"describeEventTopics", "x-api-path-slug"=>"actiondescribeeventtopics-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The Directory ID for which to get the list of associated SNS topics", "type"=>"string"}, {"in"=>"query", "name"=>"TopicNames", "description"=>"A list of SNS topic names for which to obtain the information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Topics"]}}, "/?Action=DescribeSnapshots"=>{"get"=>{"summary"=>"Describe Snapshots", "description"=>"Obtains information about the directory snapshots that belong to this account.", "operationId"=>"describeSnapshots", "x-api-path-slug"=>"actiondescribesnapshots-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The identifier of the directory for which to retrieve snapshot information", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of objects to return", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The DescribeSnapshotsResult", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotIds", "description"=>"A list of identifiers of the snapshots to obtain the information for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=DescribeTrusts"=>{"get"=>{"summary"=>"Describe Trusts", "description"=>"Obtains information about the trust relationships for this account.", "operationId"=>"describeTrusts", "x-api-path-slug"=>"actiondescribetrusts-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The Directory ID of the AWS directory that is a part of the requested trust relationship", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of objects to return", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The DescribeTrustsResult", "type"=>"string"}, {"in"=>"query", "name"=>"TrustIds", "description"=>"A list of identifiers of the trust relationships for which to obtain the information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trust"]}}, "/?Action=DisableRadius"=>{"get"=>{"summary"=>"Disable Radius", "description"=>"Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.", "operationId"=>"disableRadius", "x-api-path-slug"=>"actiondisableradius-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The identifier of the directory for which to disable MFA", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Radius"]}}, "/?Action=DisableSso"=>{"get"=>{"summary"=>"Disable Sso", "description"=>"Disables single-sign on for a directory.", "operationId"=>"disableSso", "x-api-path-slug"=>"actiondisablesso-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The identifier of the directory for which to disable single-sign on", "type"=>"string"}, {"in"=>"query", "name"=>"Password", "description"=>"The password of an alternate account to use to disable single-sign on", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The username of an alternate account to use to disable single-sign on", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SSO"]}}, "/?Action=EnableRadius"=>{"get"=>{"summary"=>"Enable Radius", "description"=>"Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.", "operationId"=>"enableRadius", "x-api-path-slug"=>"actionenableradius-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The identifier of the directory for which to enable MFA", "type"=>"string"}, {"in"=>"query", "name"=>"RadiusSettings", "description"=>"A RadiusSettings object that contains information about the RADIUS server", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Radius"]}}, "/?Action=EnableSso"=>{"get"=>{"summary"=>"Enable Sso", "description"=>"Enables single sign-on for a directory.", "operationId"=>"enableSso", "x-api-path-slug"=>"actionenablesso-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The identifier of the directory for which to enable single-sign on", "type"=>"string"}, {"in"=>"query", "name"=>"Password", "description"=>"The password of an alternate account to use to enable single-sign on", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The username of an alternate account to use to enable single-sign on", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SSO"]}}, "/?Action=GetDirectoryLimits"=>{"get"=>{"summary"=>"Get Directory Limits", "description"=>"Obtains directory limit information for the current region.", "operationId"=>"getDirectoryLimits", "x-api-path-slug"=>"actiongetdirectorylimits-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryLimits", "description"=>"A DirectoryLimits object that contains the directory limits for the current region", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Directories"]}}, "/?Action=GetSnapshotLimits"=>{"get"=>{"summary"=>"Get Snapshot Limits", "description"=>"Obtains the manual snapshot limits for a directory.", "operationId"=>"getSnapshotLimits", "x-api-path-slug"=>"actiongetsnapshotlimits-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"Contains the identifier of the directory to obtain the limits for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=ListIpRoutes"=>{"get"=>{"summary"=>"List Ip Routes", "description"=>"Lists the address blocks that you have added to a directory.", "operationId"=>"listIpRoutes", "x-api-path-slug"=>"actionlistiproutes-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"Identifier (ID) of the directory for which you want to retrieve the IP addresses", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"Maximum number of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The ListIpRoutes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Address Routes"]}}, "/?Action=ListSchemaExtensions"=>{"get"=>{"summary"=>"List Schema Extensions", "description"=>"Lists all schema extensions applied to a Microsoft AD Directory.", "operationId"=>"listSchemaExtensions", "x-api-path-slug"=>"actionlistschemaextensions-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The identifier of the directory from which to retrieve the schema extension information", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The ListSchemaExtensions", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schema Extension"]}}, "/?Action=ListTagsForResource"=>{"get"=>{"summary"=>"List Tags For Resource", "description"=>"Lists all tags on a directory.", "operationId"=>"listTagsForResource", "x-api-path-slug"=>"actionlisttagsforresource-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"Reserved for future use", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"Reserved for future use", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceId", "description"=>"Identifier (ID) of the directory for which you want to retrieve tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Tags"]}}, "/?Action=RegisterEventTopic"=>{"get"=>{"summary"=>"Register Event Topic", "description"=>"Associates a directory with an SNS topic.", "operationId"=>"registerEventTopic", "x-api-path-slug"=>"actionregistereventtopic-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The Directory ID that will publish status messages to the SNS topic", "type"=>"string"}, {"in"=>"query", "name"=>"TopicName", "description"=>"The SNS topic name to which the directory will publish status messages", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Topics"]}}, "/?Action=RemoveIpRoutes"=>{"get"=>{"summary"=>"Remove Ip Routes", "description"=>"Removes IP address blocks from a directory.", "operationId"=>"removeIpRoutes", "x-api-path-slug"=>"actionremoveiproutes-get", "parameters"=>[{"in"=>"query", "name"=>"CidrIps", "description"=>"IP address blocks that you want to remove", "type"=>"string"}, {"in"=>"query", "name"=>"DirectoryId", "description"=>"Identifier (ID) of the directory from which you want to remove the IP addresses", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Address Routes"]}}, "/?Action=RemoveTagsFromResource"=>{"get"=>{"summary"=>"Remove Tags From Resource", "description"=>"Removes tags from a directory.", "operationId"=>"removeTagsFromResource", "x-api-path-slug"=>"actionremovetagsfromresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceId", "description"=>"Identifier (ID) of the directory from which to remove the tag", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys", "description"=>"The tag key (name) of the tag to be removed", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Tags"]}}, "/?Action=RestoreFromSnapshot"=>{"get"=>{"summary"=>"Restore From Snapshot", "description"=>"Restores a directory using an existing directory snapshot.", "operationId"=>"restoreFromSnapshot", "x-api-path-slug"=>"actionrestorefromsnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"SnapshotId", "description"=>"The identifier of the snapshot to restore from", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=StartSchemaExtension"=>{"get"=>{"summary"=>"Start Schema Extension", "description"=>"Applies a schema extension to a Microsoft AD directory.", "operationId"=>"startSchemaExtension", "x-api-path-slug"=>"actionstartschemaextension-get", "parameters"=>[{"in"=>"query", "name"=>"CreateSnapshotBeforeSchemaExtension", "description"=>"If true, creates a snapshot of the directory before applying the schema extension", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A description of the schema extension", "type"=>"string"}, {"in"=>"query", "name"=>"DirectoryId", "description"=>"The identifier of the directory for which the schema extension will be applied to", "type"=>"string"}, {"in"=>"query", "name"=>"LdifContent", "description"=>"The LDIF file represented as a string", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schema Extension"]}}, "/?Action=UpdateConditionalForwarder"=>{"get"=>{"summary"=>"Update Conditional Forwarder", "description"=>"Updates a conditional forwarder that has been set up for your AWS directory.", "operationId"=>"updateConditionalForwarder", "x-api-path-slug"=>"actionupdateconditionalforwarder-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The directory ID of the AWS directory for which to update the conditional forwarder", "type"=>"string"}, {"in"=>"query", "name"=>"DnsIpAddrs", "description"=>"The updated IP addresses of the remote DNS server associated with the conditional forwarder", "type"=>"string"}, {"in"=>"query", "name"=>"RemoteDomainName", "description"=>"The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conditional Forwarder"]}}, "/?Action=UpdateRadius"=>{"get"=>{"summary"=>"Update Radius", "description"=>"Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.", "operationId"=>"updateRadius", "x-api-path-slug"=>"actionupdateradius-get", "parameters"=>[{"in"=>"query", "name"=>"DirectoryId", "description"=>"The identifier of the directory for which to update the RADIUS server information", "type"=>"string"}, {"in"=>"query", "name"=>"RadiusSettings", "description"=>"A RadiusSettings object that contains information about the RADIUS server", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Radius"]}}, "/?Action=VerifyTrust"=>{"get"=>{"summary"=>"Verify Trust", "description"=>"AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.", "operationId"=>"verifyTrust", "x-api-path-slug"=>"actionverifytrust-get", "parameters"=>[{"in"=>"query", "name"=>"TrustId", "description"=>"The unique Trust ID of the trust relationship to verify", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trust"]}}}}, "apis"=>{"name"=>"AWS Directory Service", "x-slug"=>"aws-directory-service", "description"=>"AWS Directory Service for Microsoft Active Directory (Enterprise Edition), also known as AWS Microsoft AD, enables your directory-aware workloads and AWS resources to use managed Active Directory in the AWS Cloud. The Microsoft AD service is built on actual Microsoft Active Directory and does not require you to synchronize or replicate data from your existing Active Directory to the cloud. You can use standard Active Directory administration tools and take advantage of built-in Active Directory features such as Group Policy, trusts, and single sign-on. With Microsoft AD, you can easily joinAmazon EC2andAmazon RDS for SQL Serverinstances to a domain, and useAWS Enterprise IT applicationssuch asAmazon WorkSpaceswith Active Directory users and groups.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Security-Identity_AWSDirectoryService.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Authentication,Discovery,Profiles,Relative Data,Security,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-directory-service/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Directory Service API", "x-api-slug"=>"aws-directory-service-api", "description"=>"AWS Directory Service for Microsoft Active Directory (Enterprise Edition), also known as AWS Microsoft AD, enables your directory-aware workloads and AWS resources to use managed Active Directory in the AWS Cloud. The Microsoft AD service is built on actual Microsoft Active Directory and does not require you to synchronize or replicate data from your existing Active Directory to the cloud. You can use standard Active Directory administration tools and take advantage of built-in Active Directory features such as Group Policy, trusts, and single sign-on. With Microsoft AD, you can easily joinAmazon EC2andAmazon RDS for SQL Serverinstances to a domain, and useAWS Enterprise IT applicationssuch asAmazon WorkSpaceswith Active Directory users and groups.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Security-Identity_AWSDirectoryService.png", "humanURL"=>"https://aws.amazon.com/directoryservice/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Authentication,Discovery,Profiles,Relative Data,Security,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-directory-service/actionverifytrust-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-directory-service/aws-directory-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/cli/latest/reference/ds/index.html"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/directoryservice/latest/devguide/api-ref.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/directoryservice/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/directoryservice/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/directoryservice/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/directoryservice/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
payrun{"pay-run-io-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"PayRun", "x-complete"=>1, "info"=>{"title"=>"Pay Run.IO", "description"=>"open-scableable-transparent-payroll-api-", "version"=>"17.18.6.206"}, "host"=>"api.test.payrun.io", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/Employer/{EmployerId}"=>{"delete"=>{"summary"=>"Delete an Employer", "description"=>"Delete the specified employer", "operationId"=>"DeleteEmployer", "x-api-path-slug"=>"employeremployerid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employer"]}, "get"=>{"summary"=>"Gets the employer", "description"=>"Get the specified employer object", "operationId"=>"GetEmployer", "x-api-path-slug"=>"employeremployerid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employer"]}, "patch"=>{"summary"=>"Patches the employer", "description"=>"Patches the specified employer with the supplied values", "operationId"=>"PatchEmployer", "x-api-path-slug"=>"employeremployerid-patch", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"body", "name"=>"Employer", "description"=>"The employer object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Patches", "Employer"]}, "put"=>{"summary"=>"Updates the Employer", "description"=>"Updates the existing specified employer object", "operationId"=>"PutEmployer", "x-api-path-slug"=>"employeremployerid-put", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"body", "name"=>"Employer", "description"=>"The employer object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employer"]}}, "/Employer/{EmployerId}/DpsMessage/{DpsMessageId}"=>{"delete"=>{"summary"=>"Deletes the DPS message", "description"=>"Deletes the DPS message", "operationId"=>"DeleteDpsMessage", "x-api-path-slug"=>"employeremployeriddpsmessagedpsmessageid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"DpsMessageId", "description"=>"The DPS message unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DPMessage"]}, "get"=>{"summary"=>"Gets the DPS message", "description"=>"Gets the DPS message", "operationId"=>"GetDpsMessageFromEmployer", "x-api-path-slug"=>"employeremployeriddpsmessagedpsmessageid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"DpsMessageId", "description"=>"The DPS message unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DPMessage"]}, "patch"=>{"summary"=>"Patches the DPS message", "description"=>"Patches the specified DPS message with the supplied values", "operationId"=>"PatchDpsMessage", "x-api-path-slug"=>"employeremployeriddpsmessagedpsmessageid-patch", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"DpsMessageId", "description"=>"The DPS message unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Patches", "DPMessage"]}}, "/Employer/{EmployerId}/DpsMessages"=>{"get"=>{"summary"=>"Gets the DPS messages", "description"=>"Gets the DPS message links", "operationId"=>"GetDpsMessagesFromEmployer", "x-api-path-slug"=>"employeremployeriddpsmessages-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DPMessages"]}}, "/Employer/{EmployerId}/Employee/{EmployeeId}"=>{"delete"=>{"summary"=>"Delete an Employee", "description"=>"Delete the specified employee", "operationId"=>"DeleteEmployee", "x-api-path-slug"=>"employeremployeridemployeeemployeeid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employee"]}, "get"=>{"summary"=>"Get employee from employer", "description"=>"Gets the specified employee from employer by employee code.", "operationId"=>"GetEmployeeFromEmployer", "x-api-path-slug"=>"employeremployeridemployeeemployeeid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employee", "From", "Employer"]}, "patch"=>{"summary"=>"Patches the employee", "description"=>"Patches the specified employee with the supplied values", "operationId"=>"PatchEmployee", "x-api-path-slug"=>"employeremployeridemployeeemployeeid-patch", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"body", "name"=>"Employee", "description"=>"The employee object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Patches", "Employee"]}, "put"=>{"summary"=>"Updates the Employee", "description"=>"Updates the existing specified employee object", "operationId"=>"PutEmployeeIntoEmployer", "x-api-path-slug"=>"employeremployeridemployeeemployeeid-put", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"body", "name"=>"Employee", "description"=>"The employee object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employee"]}}, "/Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessment/{AEAssessmentId}"=>{"delete"=>{"summary"=>"Delete auto enrolment assessment", "description"=>"Deletes an existing auto enrolment assessment for the employee. Used to remove historical assessments", "operationId"=>"DeleteAEAssessment", "x-api-path-slug"=>"employeremployeridemployeeemployeeidaeassessmentaeassessmentid-delete", "parameters"=>[{"in"=>"path", "name"=>"AEAssessmentId", "description"=>"The auto enrolment assessment unique identifier"}, {"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auto", "Enrolment", "Assessment"]}, "get"=>{"summary"=>"Get the auto enrolment assessment", "description"=>"Gets the auto enrolment assessment from the specified employee", "operationId"=>"GetAEAssessmentFromEmployee", "x-api-path-slug"=>"employeremployeridemployeeemployeeidaeassessmentaeassessmentid-get", "parameters"=>[{"in"=>"path", "name"=>"AEAssessmentId", "description"=>"The auto enrolment assessment unique identifier"}, {"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auto", "Enrolment", "Assessment"]}, "put"=>{"summary"=>"Insert new auto enrolment assessment", "description"=>"Creates a new auto enrolment assessment for the employee. Used to insert historical assessments", "operationId"=>"PutNewAEAssessment", "x-api-path-slug"=>"employeremployeridemployeeemployeeidaeassessmentaeassessmentid-put", "parameters"=>[{"in"=>"body", "name"=>"AEAssessment", "description"=>"The auto enrolment assessment object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"AEAssessmentId", "description"=>"The auto enrolment assessment unique identifier"}, {"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insert", "New", "Auto", "Enrolment", "Assessment"]}}, "/Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessments"=>{"get"=>{"summary"=>"Get the auto enrolment assessments", "description"=>"Gets all auto enrolment assessments from the specified employee", "operationId"=>"GetAEAssessmentsFromEmployee", "x-api-path-slug"=>"employeremployeridemployeeemployeeidaeassessments-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auto", "Enrolment", "Assessments"]}, "post"=>{"summary"=>"Insert new auto enrolment assessment", "description"=>"Creates a new auto enrolment assessment for the employee. Used to insert historical assessments", "operationId"=>"PostNewAEAssessment", "x-api-path-slug"=>"employeremployeridemployeeemployeeidaeassessments-post", "parameters"=>[{"in"=>"body", "name"=>"AEAssessment", "description"=>"The auto enrolment assessment object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insert", "New", "Auto", "Enrolment", "Assessment"]}}, "/Employer/{EmployerId}/Employee/{EmployeeId}/Commentaries"=>{"get"=>{"summary"=>"Get links to all commentaries for the specified employee", "description"=>"Get links to all commentaries for the specified employee.", "operationId"=>"GetCommentariesFromEmployee", "x-api-path-slug"=>"employeremployeridemployeeemployeeidcommentaries-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Links", "To", "", "Commentariesthe", "Specified", "Employee"]}}, "/Employer/{EmployerId}/Employee/{EmployeeId}/Commentary/{CommentaryId}"=>{"get"=>{"summary"=>"Get commentary from employee", "description"=>"Gets the specified commentary report from the employee", "operationId"=>"GetCommentaryFromEmployee", "x-api-path-slug"=>"employeremployeridemployeeemployeeidcommentarycommentaryid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"CommentaryId", "description"=>"The commentary unique identifier"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commentary", "From", "Employee"]}}, "/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}"=>{"delete"=>{"summary"=>"Deletes a pay instruction", "description"=>"Delete the specified pay instruction", "operationId"=>"DeletePayInstruction", "x-api-path-slug"=>"employeremployeridemployeeemployeeidpayinstructionpayinstructionid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayInstructionId", "description"=>"The pay instruction unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Instruction"]}, "get"=>{"summary"=>"Gets the specified pay instruction from the employee", "description"=>"Returns the specified pay instruction from employee", "operationId"=>"GetPayInstructionFromEmployee", "x-api-path-slug"=>"employeremployeridemployeeemployeeidpayinstructionpayinstructionid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayInstructionId", "description"=>"The pay instruction unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specified", "Pay", "Instruction", "From", "Employee"]}, "patch"=>{"summary"=>"Sparse Update of a Pay Instruction", "description"=>"Patches the specified pay instruction with the supplied values", "operationId"=>"PatchPayInstruction", "x-api-path-slug"=>"employeremployeridemployeeemployeeidpayinstructionpayinstructionid-patch", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"body", "name"=>"PayInstruction", "description"=>"The pay instruction object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"PayInstructionId", "description"=>"The pay instruction unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sparse", "", "Of", "Pay", "Instruction"]}, "put"=>{"summary"=>"Update a Pay Instruction", "description"=>"Updates the existing specified pay instruction object", "operationId"=>"PutPayInstruction", "x-api-path-slug"=>"employeremployeridemployeeemployeeidpayinstructionpayinstructionid-put", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"body", "name"=>"PayInstruction", "description"=>"The pay instruction object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"PayInstructionId", "description"=>"The pay instruction unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Instruction"]}}, "/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions"=>{"get"=>{"summary"=>"Gets the pay instructions from the specified employee", "description"=>"Get links to all pay instructions for the specified employee", "operationId"=>"GetPayInstructionsFromEmployee", "x-api-path-slug"=>"employeremployeridemployeeemployeeidpayinstructions-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Instructions", "From", "Specified", "Employee"]}, "post"=>{"summary"=>"Creates a new Pay Instruction", "description"=>"Creates a new pay instruction object", "operationId"=>"PostPayInstruction", "x-api-path-slug"=>"employeremployeridemployeeemployeeidpayinstructions-post", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"body", "name"=>"PayInstruction", "description"=>"The pay instruction object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "New", "Pay", "Instruction"]}}, "/Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}"=>{"get"=>{"summary"=>"Gets the specified pay line from the employee", "description"=>"Returns the specified pay line from employee", "operationId"=>"GetPayLineFromEmployee", "x-api-path-slug"=>"employeremployeridemployeeemployeeidpaylinepaylineid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayLineId", "description"=>"The pay line unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specified", "Pay", "Line", "From", "Employee"]}}, "/Employer/{EmployerId}/Employee/{EmployeeId}/PayLines"=>{"get"=>{"summary"=>"Gets the pay lines from the specified employee", "description"=>"Get links to all pay lines for the specified employee", "operationId"=>"GetPayLinesFromEmployee", "x-api-path-slug"=>"employeremployeridemployeeemployeeidpaylines-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Lines", "From", "Specified", "Employee"]}}, "/Employer/{EmployerId}/Employee/{EmployeeId}/PayRuns"=>{"get"=>{"summary"=>"Gets the pay runs from the employee", "description"=>"Get links to all pay runs for the specified employee.", "operationId"=>"GetPayRunsFromEmployee", "x-api-path-slug"=>"employeremployeridemployeeemployeeidpayruns-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Runs", "From", "Employee"]}}, "/Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId}"=>{"delete"=>{"summary"=>"Delete employee tag", "description"=>"Deletes a tag from the employee", "operationId"=>"DeleteEmployeeTag", "x-api-path-slug"=>"employeremployeridemployeeemployeeidtagtagid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employee", "Tag"]}, "get"=>{"summary"=>"Get employee tag", "description"=>"Gets the tag from the employee", "operationId"=>"GetTagFromEmployee", "x-api-path-slug"=>"employeremployeridemployeeemployeeidtagtagid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employee", "Tag"]}, "put"=>{"summary"=>"Insert employee tag", "description"=>"Inserts a new tag on the employee", "operationId"=>"PutEmployeeTag", "x-api-path-slug"=>"employeremployeridemployeeemployeeidtagtagid-put", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insert", "Employee", "Tag"]}}, "/Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId}/{EffectiveDate}"=>{"get"=>{"summary"=>"Get employee revision tag", "description"=>"Gets the tag from the employee revision", "operationId"=>"GetTagFromEmployeeRevision", "x-api-path-slug"=>"employeremployeridemployeeemployeeidtagtagideffectivedate-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EffectiveDate", "description"=>"The effective date to be applied"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employee", "Revision", "Tag"]}}, "/Employer/{EmployerId}/Employee/{EmployeeId}/Tags"=>{"get"=>{"summary"=>"Get all employee tags", "description"=>"Gets all the tags from the employee", "operationId"=>"GetTagsFromEmployee", "x-api-path-slug"=>"employeremployeridemployeeemployeeidtags-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employee", "Tags"]}}, "/Employer/{EmployerId}/Employee/{EmployeeId}/Tags/{EffectiveDate}"=>{"get"=>{"summary"=>"Get all employee revision tags", "description"=>"Gets all the tags from the employee revision", "operationId"=>"GetTagsFromEmployeeRevision", "x-api-path-slug"=>"employeremployeridemployeeemployeeidtagseffectivedate-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EffectiveDate", "description"=>"The effective date to be applied"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employee", "Revision", "Tags"]}}, "/Employer/{EmployerId}/Employee/{EmployeeId}/{EffectiveDate}"=>{"delete"=>{"summary"=>"Delete an Employee revision matching the specified revision date.", "description"=>"Deletes the specified employee revision for the matching revision date", "operationId"=>"DeleteEmployeeRevision", "x-api-path-slug"=>"employeremployeridemployeeemployeeideffectivedate-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EffectiveDate", "description"=>"The effective date to be applied"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employee", "Revision", "Matching", "Specified", "Revision", "Date"]}, "get"=>{"summary"=>"Get employee by effective date.", "description"=>"Returns the employee's state at the specified effective date.", "operationId"=>"GetEmployeeByEffectiveDate", "x-api-path-slug"=>"employeremployeridemployeeemployeeideffectivedate-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EffectiveDate", "description"=>"The effective date to be applied"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employee", "By", "Effective", "Date"]}}, "/Employer/{EmployerId}/Employees"=>{"get"=>{"summary"=>"Get employees from employer.", "description"=>"Get links to all employees for the specified employer.", "operationId"=>"GetEmployeesFromEmployer", "x-api-path-slug"=>"employeremployeridemployees-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employees", "From", "Employer"]}, "post"=>{"summary"=>"Create a new Employee", "description"=>"Create a new employee object", "operationId"=>"PostEmployeeIntoEmployer", "x-api-path-slug"=>"employeremployeridemployees-post", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"body", "name"=>"Employee", "description"=>"The employee object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Employee"]}}, "/Employer/{EmployerId}/Employees/Tag/{TagId}"=>{"get"=>{"summary"=>"Get employees with tag", "description"=>"Gets the employees with the tag", "operationId"=>"GetEmployeesWithTag", "x-api-path-slug"=>"employeremployeridemployeestagtagid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employees", "Tag"]}}, "/Employer/{EmployerId}/Employees/Tags"=>{"get"=>{"summary"=>"Get all employee tags", "description"=>"Gets all the employee tags", "operationId"=>"GetAllEmployeeTags", "x-api-path-slug"=>"employeremployeridemployeestags-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employee", "Tags"]}}, "/Employer/{EmployerId}/Employees/{EffectiveDate}"=>{"get"=>{"summary"=>"Get employees from employer at a given effective date.", "description"=>"Get links to all employees for the employer on specified effective date.", "operationId"=>"GetEmployeesByEffectiveDate", "x-api-path-slug"=>"employeremployeridemployeeseffectivedate-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EffectiveDate", "description"=>"The effective date to be applied"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employees", "From", "Employer", "At", "Given", "Effective", "Date"]}}, "/Employer/{EmployerId}/NominalCode/{NominalCodeId}"=>{"delete"=>{"summary"=>"Deletes the nominal codes", "description"=>"Deletes the nominal code", "operationId"=>"DeleteNominalCode", "x-api-path-slug"=>"employeremployeridnominalcodenominalcodeid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"NominalCodeId", "description"=>"The nominal code unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nominal", "Codes"]}, "get"=>{"summary"=>"Gets the nominal code", "description"=>"Gets the nominal code", "operationId"=>"GetNominalCodeFromEmployer", "x-api-path-slug"=>"employeremployeridnominalcodenominalcodeid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"NominalCodeId", "description"=>"The nominal code unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nominal", "Code"]}, "put"=>{"summary"=>"Insert nominal code", "description"=>"Inserts a new nominal code at the specified resource location", "operationId"=>"PutNominalCode", "x-api-path-slug"=>"employeremployeridnominalcodenominalcodeid-put", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"body", "name"=>"NominalCode", "description"=>"The nominal code object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"NominalCodeId", "description"=>"The nominal code unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insert", "Nominal", "Code"]}}, "/Employer/{EmployerId}/NominalCodes"=>{"get"=>{"summary"=>"Gets the nominal codes", "description"=>"Gets the nominal code links", "operationId"=>"GetNominalCodesFromEmployer", "x-api-path-slug"=>"employeremployeridnominalcodes-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nominal", "Codes"]}, "post"=>{"summary"=>"Insert nominal code", "description"=>"Inserts a new nominal code", "operationId"=>"PostNominalCode", "x-api-path-slug"=>"employeremployeridnominalcodes-post", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"body", "name"=>"NominalCode", "description"=>"The nominal code object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insert", "Nominal", "Code"]}}, "/Employer/{EmployerId}/PayCode/{PayCodeId}"=>{"delete"=>{"summary"=>"Deletes a pay code", "description"=>"Delete the specified pay code", "operationId"=>"DeletePayCode", "x-api-path-slug"=>"employeremployeridpaycodepaycodeid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayCodeId", "description"=>"The pay code unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Code"]}, "get"=>{"summary"=>"Gets the specified pay code from the employer", "description"=>"Returns the specified pay code from the employer", "operationId"=>"GetPayCodeFromEmployer", "x-api-path-slug"=>"employeremployeridpaycodepaycodeid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayCodeId", "description"=>"The pay code unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specified", "Pay", "Code", "From", "Employer"]}, "patch"=>{"summary"=>"Patches the pay code", "description"=>"Patches the specified pay code object with the supplied values", "operationId"=>"PatchPayCode", "x-api-path-slug"=>"employeremployeridpaycodepaycodeid-patch", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"body", "name"=>"PayCode", "description"=>"The pay code object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"PayCodeId", "description"=>"The pay code unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Patches", "Pay", "Code"]}, "put"=>{"summary"=>"Updates a pay code", "description"=>"Updates the existing specified pay code object", "operationId"=>"PutPayCode", "x-api-path-slug"=>"employeremployeridpaycodepaycodeid-put", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"body", "name"=>"PayCode", "description"=>"The pay code object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"PayCodeId", "description"=>"The pay code unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Code"]}}, "/Employer/{EmployerId}/PayCode/{PayCodeId}/Tag/{TagId}"=>{"delete"=>{"summary"=>"Delete pay code tag", "description"=>"Deletes a tag from the pay code", "operationId"=>"DeletePayCodeTag", "x-api-path-slug"=>"employeremployeridpaycodepaycodeidtagtagid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayCodeId", "description"=>"The pay code unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Code", "Tag"]}, "get"=>{"summary"=>"Get pay code tag", "description"=>"Gets the tag from the pay code", "operationId"=>"GetTagFromPayCode", "x-api-path-slug"=>"employeremployeridpaycodepaycodeidtagtagid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayCodeId", "description"=>"The pay code unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Code", "Tag"]}, "put"=>{"summary"=>"Insert pay code tag", "description"=>"Inserts a new tag on the pay code", "operationId"=>"PutPayCodeTag", "x-api-path-slug"=>"employeremployeridpaycodepaycodeidtagtagid-put", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayCodeId", "description"=>"The pay code unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insert", "Pay", "Code", "Tag"]}}, "/Employer/{EmployerId}/PayCode/{PayCodeId}/Tags"=>{"get"=>{"summary"=>"Get all pay code tags", "description"=>"Gets all the tags from the pay code", "operationId"=>"GetTagsFromPayCode", "x-api-path-slug"=>"employeremployeridpaycodepaycodeidtags-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayCodeId", "description"=>"The pay code unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Code", "Tags"]}}, "/Employer/{EmployerId}/PayCode/{PayCodeId}/{EffectiveDate}"=>{"delete"=>{"summary"=>"Deletes a pay code revision", "description"=>"Delete the pay code revision for the specified date", "operationId"=>"DeletePayCodeRevision", "x-api-path-slug"=>"employeremployeridpaycodepaycodeideffectivedate-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EffectiveDate", "description"=>"The effective date to be applied"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayCodeId", "description"=>"The pay code unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Code", "Revision"]}, "get"=>{"summary"=>"Gets pay code for specified date", "description"=>"Gets the pay code revision for the specified effective date", "operationId"=>"GetPayCodeByEffectiveDate", "x-api-path-slug"=>"employeremployeridpaycodepaycodeideffectivedate-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EffectiveDate", "description"=>"The effective date to be applied"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayCodeId", "description"=>"The pay code unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Codespecified", "Date"]}}, "/Employer/{EmployerId}/PayCodes"=>{"get"=>{"summary"=>"Gets the pay codes from the employer", "description"=>"Get links to all the pay codes for the specified employer", "operationId"=>"GetPayCodesFromEmployer", "x-api-path-slug"=>"employeremployeridpaycodes-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Codes", "From", "Employer"]}, "post"=>{"summary"=>"Create a new pay code", "description"=>"Create a new pay code object", "operationId"=>"PostPayCode", "x-api-path-slug"=>"employeremployeridpaycodes-post", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"body", "name"=>"PayCode", "description"=>"The pay code object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Pay", "Code"]}}, "/Employer/{EmployerId}/PayCodes/Tag/{TagId}"=>{"get"=>{"summary"=>"Get pay codes with tag", "description"=>"Gets the pay codes with the tag", "operationId"=>"GetPayCodesWithTag", "x-api-path-slug"=>"employeremployeridpaycodestagtagid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Codes", "Tag"]}}, "/Employer/{EmployerId}/PayCodes/Tags"=>{"get"=>{"summary"=>"Get all pay code tags", "description"=>"Gets all the pay code tags", "operationId"=>"GetAllPayCodeTags", "x-api-path-slug"=>"employeremployeridpaycodestags-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Code", "Tags"]}}, "/Employer/{EmployerId}/PayCodes/{EffectiveDate}"=>{"get"=>{"summary"=>"Gets all pay codes for specified date", "description"=>"Gets the effective pay code revision for the specified date", "operationId"=>"GetPayCodesByEffectiveDate", "x-api-path-slug"=>"employeremployeridpaycodeseffectivedate-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EffectiveDate", "description"=>"The effective date to be applied"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["", "Pay", "Codesspecified", "Date"]}}, "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}"=>{"delete"=>{"summary"=>"Deletes a pay schedule", "description"=>"Delete the specified pay schedule", "operationId"=>"DeletePaySchedule", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Schedule"]}, "get"=>{"summary"=>"Gets the specified pay schedule from the employer", "description"=>"Returns the specified pay schedule object from employer", "operationId"=>"GetPayScheduleFromEmployer", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specified", "Pay", "Schedule", "From", "Employer"]}, "put"=>{"summary"=>"Updates a pay schedule", "description"=>"Updates the existing specified pay schedule object", "operationId"=>"PutPaySchedule", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleid-put", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"body", "name"=>"PaySchedule", "description"=>"The pay schedule object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Schedule"]}}, "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Employees"=>{"get"=>{"summary"=>"Get employees from a pay schedule.", "description"=>"Gets links to all employees included in the specified pay schedule.", "operationId"=>"GetEmployeesFromPaySchedule", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidemployees-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employees", "From", "Pay", "Schedule"]}}, "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}"=>{"delete"=>{"summary"=>"Deletes a pay run", "description"=>"Delete the specified pay run", "operationId"=>"DeletePayRun", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidpayrunpayrunid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayRunId", "description"=>"The pay runs unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Run"]}, "get"=>{"summary"=>"Gets the pay run from the pay schedule", "description"=>"Returns the pay run from the pay schedule", "operationId"=>"GetPayRunFromPaySchedule", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidpayrunpayrunid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayRunId", "description"=>"The pay runs unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Run", "From", "Pay", "Schedule"]}}, "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/AEAssessments"=>{"get"=>{"summary"=>"Get the auto enrolment assessments", "description"=>"Gets all auto enrolment assessments from the specified pay run", "operationId"=>"GetAEAssessmentsFromPayRun", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidpayrunpayrunidaeassessments-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayRunId", "description"=>"The pay runs unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auto", "Enrolment", "Assessments"]}}, "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Employee/{EmployeeId}"=>{"delete"=>{"summary"=>"Deletes a pay run employee", "description"=>"Delete pay run results for a single employee", "operationId"=>"DeletePayRunEmployee", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidpayrunpayrunidemployeeemployeeid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployeeId", "description"=>"The employees unique identifier"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayRunId", "description"=>"The pay runs unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Run", "Employee"]}}, "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Employees"=>{"get"=>{"summary"=>"Get employees from the pay run", "description"=>"Gets links to all employees included in the specified pay run.", "operationId"=>"GetEmployeesFromPayRun", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidpayrunpayrunidemployees-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayRunId", "description"=>"The pay runs unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employees", "From", "Pay", "Run"]}}, "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/ReportLines"=>{"get"=>{"summary"=>"Gets the report lines from the specified pay run", "description"=>"Returns all report lines associated with the specified pay run", "operationId"=>"GetReportLinesFromPayRun", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidpayrunpayrunidreportlines-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayRunId", "description"=>"The pay runs unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report", "Lines", "From", "Specified", "Pay", "Run"]}}, "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Tag/{TagId}"=>{"delete"=>{"summary"=>"Delete pay run tag", "description"=>"Deletes a tag from the pay run", "operationId"=>"DeletePayRunTag", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidpayrunpayrunidtagtagid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayRunId", "description"=>"The pay runs unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Run", "Tag"]}, "get"=>{"summary"=>"Get pay run tag", "description"=>"Gets the tag from the pay run", "operationId"=>"GetTagFromPayRun", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidpayrunpayrunidtagtagid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayRunId", "description"=>"The pay runs unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Run", "Tag"]}, "put"=>{"summary"=>"Insert pay run tag", "description"=>"Inserts a new tag on the pay run", "operationId"=>"PutPayRunTag", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidpayrunpayrunidtagtagid-put", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayRunId", "description"=>"The pay runs unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insert", "Pay", "Run", "Tag"]}}, "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Tags"=>{"get"=>{"summary"=>"Get all pay run tags", "description"=>"Gets all the tags from the pay run", "operationId"=>"GetTagsFromPayRun", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidpayrunpayrunidtags-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayRunId", "description"=>"The pay runs unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Run", "Tags"]}}, "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRuns"=>{"get"=>{"summary"=>"Gets the pay runs from the pay schedule", "description"=>"Get links to all pay runs for the specified pay schedule", "operationId"=>"GetPayRunsFromPaySchedule", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidpayruns-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Runs", "From", "Pay", "Schedule"]}}, "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRuns/Tag/{TagId}"=>{"get"=>{"summary"=>"Get pay runs with tag", "description"=>"Gets the pay runs with the tag", "operationId"=>"GetPayRunsWithTag", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidpayrunstagtagid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Runs", "Tag"]}}, "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRuns/Tags"=>{"get"=>{"summary"=>"Get all pay run tags", "description"=>"Gets all the pay run tags", "operationId"=>"GetAllPayRunTags", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidpayrunstags-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Run", "Tags"]}}, "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Tag/{TagId}"=>{"delete"=>{"summary"=>"Delete pay schedule tag", "description"=>"Deletes a tag from the pay schedule", "operationId"=>"DeletePayScheduleTag", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidtagtagid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Schedule", "Tag"]}, "get"=>{"summary"=>"Get pay schedule tag", "description"=>"Gets the tag from the pay schedule", "operationId"=>"GetTagFromPaySchedule", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidtagtagid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Schedule", "Tag"]}, "put"=>{"summary"=>"Insert pay schedule tag", "description"=>"Inserts a new tag on the pay schedule", "operationId"=>"PutPayScheduleTag", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidtagtagid-put", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insert", "Pay", "Schedule", "Tag"]}}, "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Tags"=>{"get"=>{"summary"=>"Get all pay schedule tags", "description"=>"Gets all the tags from the pay schedule", "operationId"=>"GetTagsFromPaySchedule", "x-api-path-slug"=>"employeremployeridpayschedulepayscheduleidtags-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PayScheduleId", "description"=>"The pay schedules unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Schedule", "Tags"]}}, "/Employer/{EmployerId}/PaySchedules"=>{"get"=>{"summary"=>"Gets the pay schedule from the specified employer", "description"=>"Get links to all pay schedules for the specified employer", "operationId"=>"GetPaySchedulesFromEmployer", "x-api-path-slug"=>"employeremployeridpayschedules-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Schedule", "From", "Specified", "Employer"]}, "post"=>{"summary"=>"Create a new pay schedule", "description"=>"Create a new pay schedule object", "operationId"=>"PostPaySchedule", "x-api-path-slug"=>"employeremployeridpayschedules-post", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"body", "name"=>"PaySchedule", "description"=>"The pay schedule object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Pay", "Schedule"]}}, "/Employer/{EmployerId}/PaySchedules/Tag/{TagId}"=>{"get"=>{"summary"=>"Get pay schedule with tag", "description"=>"Gets the pay schedules with the tag", "operationId"=>"GetPaySchedulesWithTag", "x-api-path-slug"=>"employeremployeridpayschedulestagtagid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Schedule", "Tag"]}}, "/Employer/{EmployerId}/PaySchedules/Tags"=>{"get"=>{"summary"=>"Get all pay schedule tags", "description"=>"Gets all the pay schedule tags", "operationId"=>"GetAllPayScheduleTags", "x-api-path-slug"=>"employeremployeridpayschedulestags-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Schedule", "Tags"]}}, "/Employer/{EmployerId}/Pension/{PensionId}"=>{"delete"=>{"summary"=>"Delete a Pension", "description"=>"Delete the specified ppension", "operationId"=>"DeletePension", "x-api-path-slug"=>"employeremployeridpensionpensionid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PensionId", "description"=>"The pensions unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pension"]}, "get"=>{"summary"=>"Get pension from employer", "description"=>"Gets the specified pension from employer by pension code.", "operationId"=>"GetPensionFromEmployer", "x-api-path-slug"=>"employeremployeridpensionpensionid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PensionId", "description"=>"The pensions unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pension", "From", "Employer"]}, "patch"=>{"summary"=>"Patches the pension", "description"=>"Patches the specified pension with the supplied values", "operationId"=>"PatchPension", "x-api-path-slug"=>"employeremployeridpensionpensionid-patch", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"body", "name"=>"Pension", "description"=>"The pension object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"PensionId", "description"=>"The pensions unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Patches", "Pension"]}, "put"=>{"summary"=>"Updates the Pension", "description"=>"Updates existing or inserts the specified pension object", "operationId"=>"PutPensionIntoEmployer", "x-api-path-slug"=>"employeremployeridpensionpensionid-put", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"body", "name"=>"Pension", "description"=>"The pension object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"PensionId", "description"=>"The pensions unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pension"]}}, "/Employer/{EmployerId}/Pension/{PensionId}/{EffectiveDate}"=>{"delete"=>{"summary"=>"Delete an Pension revision matching the specified revision date.", "description"=>"Deletes the specified pension revision for the matching revision date", "operationId"=>"DeletePensionRevision", "x-api-path-slug"=>"employeremployeridpensionpensionideffectivedate-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EffectiveDate", "description"=>"The effective date to be applied"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PensionId", "description"=>"The pensions unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pension", "Revision", "Matching", "Specified", "Revision", "Date"]}, "get"=>{"summary"=>"Get pension by effective date.", "description"=>"Returns the penion's state at the specified effective date.", "operationId"=>"GetPensionByEffectiveDate", "x-api-path-slug"=>"employeremployeridpensionpensionideffectivedate-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EffectiveDate", "description"=>"The effective date to be applied"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"PensionId", "description"=>"The pensions unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pension", "By", "Effective", "Date"]}}, "/Employer/{EmployerId}/Pensions"=>{"get"=>{"summary"=>"Get pensions from employer.", "description"=>"Get links to all pensions for the specified employer.", "operationId"=>"GetPensionsFromEmployer", "x-api-path-slug"=>"employeremployeridpensions-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pensions", "From", "Employer"]}, "post"=>{"summary"=>"Create a new Pension", "description"=>"Create a new pension object", "operationId"=>"PostPensionIntoEmployer", "x-api-path-slug"=>"employeremployeridpensions-post", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"body", "name"=>"Pension", "description"=>"The pension object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Pension"]}}, "/Employer/{EmployerId}/Pensions/{EffectiveDate}"=>{"get"=>{"summary"=>"Get pensions from employer at a given effective date.", "description"=>"Get links to all pensions for the employer on specified effective date.", "operationId"=>"GetPensionsByEffectiveDate", "x-api-path-slug"=>"employeremployeridpensionseffectivedate-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EffectiveDate", "description"=>"The effective date to be applied"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pensions", "From", "Employer", "At", "Given", "Effective", "Date"]}}, "/Employer/{EmployerId}/ReportLine/{ReportLineId}"=>{"get"=>{"summary"=>"Gets the specified report line from the employer", "description"=>"Returns the specified pay line from employee", "operationId"=>"GetReportLineFromEmployer", "x-api-path-slug"=>"employeremployeridreportlinereportlineid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"ReportLineId", "description"=>"The report line unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specified", "Report", "Line", "From", "Employer"]}}, "/Employer/{EmployerId}/ReportLines"=>{"get"=>{"summary"=>"Gets the report lines from the specified employer", "description"=>"Get links to all report lines for the specified employee", "operationId"=>"GetReportLinesFromEmployer", "x-api-path-slug"=>"employeremployeridreportlines-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report", "Lines", "From", "Specified", "Employer"]}}, "/Employer/{EmployerId}/ReportingInstruction/{ReportingInstructionId}"=>{"delete"=>{"summary"=>"Deletes a reporting instruction", "description"=>"Delete the specified reporting instruction", "operationId"=>"DeleteReportingInstruction", "x-api-path-slug"=>"employeremployeridreportinginstructionreportinginstructionid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"ReportingInstructionId", "description"=>"The reporting instruction unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reporting", "Instruction"]}, "get"=>{"summary"=>"Gets the specified reporting instruction from the employer", "description"=>"Returns the specified pay instruction from employee", "operationId"=>"GetReportingInstructionFromEmployer", "x-api-path-slug"=>"employeremployeridreportinginstructionreportinginstructionid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"ReportingInstructionId", "description"=>"The reporting instruction unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specified", "Reporting", "Instruction", "From", "Employer"]}, "put"=>{"summary"=>"Update a reporting Instruction", "description"=>"Updates the existing specified reporting instruction object", "operationId"=>"PutReportingInstruction", "x-api-path-slug"=>"employeremployeridreportinginstructionreportinginstructionid-put", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"ReportingInstructionId", "description"=>"The reporting instruction unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reporting", "Instruction"]}}, "/Employer/{EmployerId}/ReportingInstructions"=>{"get"=>{"summary"=>"Gets the reporting instructions from the specified employer", "description"=>"Get links to all pay instructions for the specified employee", "operationId"=>"GetReportingInstructionsFromEmployer", "x-api-path-slug"=>"employeremployeridreportinginstructions-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reporting", "Instructions", "From", "Specified", "Employer"]}, "post"=>{"summary"=>"Creates a new Reporting Instruction", "description"=>"Creates a new reporting instruction object", "operationId"=>"PostReportingInstruction", "x-api-path-slug"=>"employeremployeridreportinginstructions-post", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "New", "Reporting", "Instruction"]}}, "/Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}"=>{"get"=>{"summary"=>"Get the RTI transaction", "description"=>"Returns the specified RTI transaction", "operationId"=>"GetRtiTransactionFromEmployer", "x-api-path-slug"=>"employeremployeridrtitransactionrtitransactionid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"RtiTransactionId", "description"=>"The RTI transaction unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RTI", "Transaction"]}}, "/Employer/{EmployerId}/RtiTransactions"=>{"get"=>{"summary"=>"Get all RTI transactions for the employer", "description"=>"Get links for all RTI transactions for the specified employer", "operationId"=>"GetRtiTransactionsFromEmployer", "x-api-path-slug"=>"employeremployeridrtitransactions-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RTI", "Transactionsthe", "Employer"]}}, "/Employer/{EmployerId}/Tag/{TagId}"=>{"delete"=>{"summary"=>"Delete employer tag", "description"=>"Deletes a tag from the employer", "operationId"=>"DeleteEmployerTag", "x-api-path-slug"=>"employeremployeridtagtagid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employer", "Tag"]}, "get"=>{"summary"=>"Get employer tag", "description"=>"Gets the tag from the employer", "operationId"=>"GetTagFromEmployer", "x-api-path-slug"=>"employeremployeridtagtagid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employer", "Tag"]}, "put"=>{"summary"=>"Insert employer tag", "description"=>"Inserts a new tag on the employer", "operationId"=>"PutEmployerTag", "x-api-path-slug"=>"employeremployeridtagtagid-put", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insert", "Employer", "Tag"]}}, "/Employer/{EmployerId}/Tag/{TagId}/{EffectiveDate}"=>{"get"=>{"summary"=>"Get employer revision tag", "description"=>"Gets the tag from the employer revision", "operationId"=>"GetTagFromEmployerRevision", "x-api-path-slug"=>"employeremployeridtagtagideffectivedate-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EffectiveDate", "description"=>"The effective date to be applied"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employer", "Revision", "Tag"]}}, "/Employer/{EmployerId}/Tags"=>{"get"=>{"summary"=>"Get all employer tags", "description"=>"Gets all the tags from the employer", "operationId"=>"GetTagsFromEmployer", "x-api-path-slug"=>"employeremployeridtags-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employer", "Tags"]}}, "/Employer/{EmployerId}/Tags/{EffectiveDate}"=>{"get"=>{"summary"=>"Get all employer revision tags", "description"=>"Gets all the tags from the employer revision", "operationId"=>"GetTagsFromEmployerRevision", "x-api-path-slug"=>"employeremployeridtagseffectivedate-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EffectiveDate", "description"=>"The effective date to be applied"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employer", "Revision", "Tags"]}}, "/Employer/{EmployerId}/{EffectiveDate}"=>{"delete"=>{"summary"=>"Delete an Employer revision matching the specified revision date.", "description"=>"Deletes the specified employer revision for the matching revision date", "operationId"=>"DeleteEmployerRevision", "x-api-path-slug"=>"employeremployerideffectivedate-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EffectiveDate", "description"=>"The effective date to be applied"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employer", "Revision", "Matching", "Specified", "Revision", "Date"]}, "get"=>{"summary"=>"Gets the employer at the specified effective", "description"=>"Returns the employer's state at the specified effective date.", "operationId"=>"GetEmployerByEffectiveDate", "x-api-path-slug"=>"employeremployerideffectivedate-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EffectiveDate", "description"=>"The effective date to be applied"}, {"in"=>"path", "name"=>"EmployerId", "description"=>"The employers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employer", "At", "Specified", "Effective"]}}, "/Employers"=>{"get"=>{"summary"=>"Gets all employers", "description"=>"Gets links to all employers contained under the authorised application scope", "operationId"=>"GetEmployers", "x-api-path-slug"=>"employers-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["", "Employers"]}, "post"=>{"summary"=>"Create a new Employer", "description"=>"Create a new employer object", "operationId"=>"PostEmployer", "x-api-path-slug"=>"employers-post", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"body", "name"=>"Employer", "description"=>"The employer object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Employer"]}}, "/Employers/Tag/{TagId}"=>{"get"=>{"summary"=>"Get employers with tag", "description"=>"Gets the employers with the tag", "operationId"=>"GetEmployersWithTag", "x-api-path-slug"=>"employerstagtagid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"TagId", "description"=>"The tag unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employers", "Tag"]}}, "/Employers/Tags"=>{"get"=>{"summary"=>"Get all employer tags", "description"=>"Gets all the employer tags", "operationId"=>"GetAllEmployerTags", "x-api-path-slug"=>"employerstags-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employer", "Tags"]}}, "/Employers/{EffectiveDate}"=>{"get"=>{"summary"=>"Gets all employers at the specified effective date", "description"=>"Gets links to all employers contained under the authorised application scope for the specified effective date.", "operationId"=>"GetEmployersByEffectiveDate", "x-api-path-slug"=>"employerseffectivedate-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"EffectiveDate", "description"=>"The effective date to be applied"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["", "Employers", "At", "Specified", "Effective", "Date"]}}, "/Healthcheck"=>{"get"=>{"summary"=>"Get health check status", "description"=>"Returns the health status of the application", "operationId"=>"GetHealthCheck", "x-api-path-slug"=>"healthcheck-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Health", "Check", "Status"]}}, "/Jobs/Dps"=>{"get"=>{"summary"=>"Get all DPS jobs", "description"=>"Gets all the DPS jobs", "operationId"=>"GetDpsJobs", "x-api-path-slug"=>"jobsdps-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DPJobs"]}, "post"=>{"summary"=>"Create new DPS job", "description"=>"Creates the new DPS job to the queue and returns the job info", "operationId"=>"PostNewDpsJob", "x-api-path-slug"=>"jobsdps-post", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"body", "name"=>"DpsJobInstruction", "description"=>"The the DPS job instruction object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "DPJob"]}}, "/Jobs/Dps/{JobId}"=>{"delete"=>{"summary"=>"Delete the DPS job", "description"=>"Deletes the the DPS job", "operationId"=>"DeleteDpsJob", "x-api-path-slug"=>"jobsdpsjobid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"JobId", "description"=>"The job unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DPJob"]}}, "/Jobs/Dps/{JobId}/Info"=>{"get"=>{"summary"=>"Get the DPS job information", "description"=>"Return the the DPS job information", "operationId"=>"GetDpsJobInfo", "x-api-path-slug"=>"jobsdpsjobidinfo-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"JobId", "description"=>"The job unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DPJob", "Information"]}}, "/Jobs/Dps/{JobId}/Progress"=>{"get"=>{"summary"=>"Get the DPS job progress", "description"=>"Return the the DPS job progress", "operationId"=>"GetDpsJobProgress", "x-api-path-slug"=>"jobsdpsjobidprogress-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"JobId", "description"=>"The job unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DPJob", "Progress"]}}, "/Jobs/Dps/{JobId}/Status"=>{"get"=>{"summary"=>"Get the DPS job status", "description"=>"Return the the DPS job status", "operationId"=>"GetDpsJobStatus", "x-api-path-slug"=>"jobsdpsjobidstatus-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"JobId", "description"=>"The job unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DPJob", "Status"]}}, "/Jobs/PayRuns"=>{"get"=>{"summary"=>"Get all PayRun jobs", "description"=>"Gets all the pay run jobs", "operationId"=>"GetPayRunJobs", "x-api-path-slug"=>"jobspayruns-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PayRun", "Jobs"]}, "post"=>{"summary"=>"Create new PayRun job", "description"=>"Creates the new pay run job to the queue and returns the job info", "operationId"=>"PostNewPayRunJob", "x-api-path-slug"=>"jobspayruns-post", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"body", "name"=>"PayRunJobInstruction", "description"=>"The pay run job instruction object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "PayRun", "Job"]}}, "/Jobs/PayRuns/{JobId}"=>{"delete"=>{"summary"=>"Delete the pay run job", "description"=>"Deletes the the payrun job", "operationId"=>"DeletePayRunJob", "x-api-path-slug"=>"jobspayrunsjobid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"JobId", "description"=>"The job unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Run", "Job"]}}, "/Jobs/PayRuns/{JobId}/Info"=>{"get"=>{"summary"=>"Get the pay run job information", "description"=>"Return the the payrun job information", "operationId"=>"GetPayRunJobInfo", "x-api-path-slug"=>"jobspayrunsjobidinfo-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"JobId", "description"=>"The job unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Run", "Job", "Information"]}}, "/Jobs/PayRuns/{JobId}/Progress"=>{"get"=>{"summary"=>"Get the pay run job progress", "description"=>"Return the the payrun job progress", "operationId"=>"GetPayRunJobProgress", "x-api-path-slug"=>"jobspayrunsjobidprogress-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"JobId", "description"=>"The job unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Run", "Job", "Progress"]}}, "/Jobs/PayRuns/{JobId}/Status"=>{"get"=>{"summary"=>"Get the pay run job status", "description"=>"Return the the payrun job status", "operationId"=>"GetPayRunJobStatus", "x-api-path-slug"=>"jobspayrunsjobidstatus-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"JobId", "description"=>"The job unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Run", "Job", "Status"]}}, "/Jobs/Rti"=>{"get"=>{"summary"=>"Get all RTI jobs", "description"=>"Gets all the RTI jobs", "operationId"=>"GetRtiJobs", "x-api-path-slug"=>"jobsrti-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RTI", "Jobs"]}, "post"=>{"summary"=>"Create new RTI job", "description"=>"Creates the new RTI job to the queue and returns the job info", "operationId"=>"PostNewRtiJob", "x-api-path-slug"=>"jobsrti-post", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"body", "name"=>"RtiJobInstruction", "description"=>"The the RTI job instruction object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "RTI", "Job"]}}, "/Jobs/Rti/{JobId}"=>{"delete"=>{"summary"=>"Delete the RTI job", "description"=>"Deletes the the RTI job", "operationId"=>"DeleteRtiJob", "x-api-path-slug"=>"jobsrtijobid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"JobId", "description"=>"The job unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RTI", "Job"]}}, "/Jobs/Rti/{JobId}/Info"=>{"get"=>{"summary"=>"Get the RTI job information", "description"=>"Return the the RTI job information", "operationId"=>"GetRtiJobInfo", "x-api-path-slug"=>"jobsrtijobidinfo-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"JobId", "description"=>"The job unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RTI", "Job", "Information"]}}, "/Jobs/Rti/{JobId}/Progress"=>{"get"=>{"summary"=>"Get the RTI job progress", "description"=>"Return the the RTI job progress", "operationId"=>"GetRtiJobProgress", "x-api-path-slug"=>"jobsrtijobidprogress-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"JobId", "description"=>"The job unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RTI", "Job", "Progress"]}}, "/Jobs/Rti/{JobId}/Status"=>{"get"=>{"summary"=>"Get the RTI job status", "description"=>"Return the the RTI job status", "operationId"=>"GetRtiJobStatus", "x-api-path-slug"=>"jobsrtijobidstatus-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"JobId", "description"=>"The job unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RTI", "Job", "Status"]}}, "/Query"=>{"post"=>{"summary"=>"Get the query result", "description"=>"Get the results for the specified query", "operationId"=>"GetQueryResponse", "x-api-path-slug"=>"query-post", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"body", "name"=>"Query", "description"=>"The query object to be executed against the application data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Query", "Result"]}}, "/Report/ACTPAYINS/run"=>{"get"=>{"summary"=>"Runs the active pay instructions report", "description"=>"Returns the result of the executed active pay instructions report for the given query parameters", "operationId"=>"GetActivePayInstructionsReportOutput", "x-api-path-slug"=>"reportactpayinsrun-get", "parameters"=>[{"in"=>"query", "name"=>"ActiveOn", "description"=>"The active date to consider"}, {"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"query", "name"=>"EmployeeKey", "description"=>"The employee unique key"}, {"in"=>"query", "name"=>"EmployerKey", "description"=>"The employer unique key"}, {"in"=>"query", "name"=>"Type", "description"=>"the data type to filter on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs", "Active", "Pay", "Instructions", "Report"]}}, "/Report/DPSMSG/run"=>{"get"=>{"summary"=>"Runs the DPS message report", "description"=>"Returns the result of the executed DPS message report for the given query parameters", "operationId"=>"GetDpsMessageReportOutput", "x-api-path-slug"=>"reportdpsmsgrun-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"query", "name"=>"EmployerKey", "description"=>"The employer unique key"}, {"in"=>"query", "name"=>"FromDate", "description"=>"The lower filter date"}, {"in"=>"query", "name"=>"MessageStatuses", "description"=>"The DPS message status as a CSV list"}, {"in"=>"query", "name"=>"MessageTypes", "description"=>"The DPS message types as a CSV list"}, {"in"=>"query", "name"=>"ToDate", "description"=>"The upper filter date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs", "DPMessage", "Report"]}}, "/Report/GRO2NET/run"=>{"get"=>{"summary"=>"Runs the gross to net report", "description"=>"Returns the result of the executed gross to net report for the given query parameters", "operationId"=>"GetGrossToNetReportOutput", "x-api-path-slug"=>"reportgro2netrun-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"query", "name"=>"EmployerKey", "description"=>"The employer unique key"}, {"in"=>"query", "name"=>"PayScheduleKey", "description"=>"The pay schedule unique key"}, {"in"=>"query", "name"=>"TaxPeriod", "description"=>"The tax period number"}, {"in"=>"query", "name"=>"TaxYear", "description"=>"The tax year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs", "Gross", "To", "Net", "Report"]}}, "/Report/NETPAY/run"=>{"get"=>{"summary"=>"Runs the net pay report", "description"=>"Returns the result of the executed net pay report for the given query parameters", "operationId"=>"GetNetPayReportOutput", "x-api-path-slug"=>"reportnetpayrun-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"query", "name"=>"EmployerKey", "description"=>"The employer unique key"}, {"in"=>"query", "name"=>"PayScheduleKey", "description"=>"The pay schedule unique key"}, {"in"=>"query", "name"=>"TaxPeriod", "description"=>"The tax period number"}, {"in"=>"query", "name"=>"TaxYear", "description"=>"The tax year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs", "Net", "Pay", "Report"]}}, "/Report/P11SUM/run"=>{"get"=>{"summary"=>"Runs the P11 summary report", "description"=>"Returns the result of the executed P11 summary report for the given query parameters", "operationId"=>"GetP11SummaryReportOutput", "x-api-path-slug"=>"reportp11sumrun-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"query", "name"=>"EmployerKey", "description"=>"The employer unique key"}, {"in"=>"query", "name"=>"PayScheduleKey", "description"=>"The pay schedule unique key"}, {"in"=>"query", "name"=>"TaxPeriod", "description"=>"The tax period number"}, {"in"=>"query", "name"=>"TaxYear", "description"=>"The tax year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs", "P11", "Summary", "Report"]}}, "/Report/P32/run"=>{"get"=>{"summary"=>"Runs the P32 report", "description"=>"Returns the result of the executed P32 report for the given query parameters", "operationId"=>"GetP32NetReportOutput", "x-api-path-slug"=>"reportp32run-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"query", "name"=>"EmployerKey", "description"=>"The employer unique key"}, {"in"=>"query", "name"=>"TaxYear", "description"=>"The tax year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs", "P32", "Report"]}}, "/Report/P32SUM/run"=>{"get"=>{"summary"=>"Runs the P32 summary report", "description"=>"Returns the result of the executed P32 summary report for the given query parameters", "operationId"=>"GetP32SummaryNetReportOutput", "x-api-path-slug"=>"reportp32sumrun-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"query", "name"=>"EmployerKey", "description"=>"The employer unique key"}, {"in"=>"query", "name"=>"TaxYear", "description"=>"The tax year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs", "P32", "Summary", "Report"]}}, "/Report/P45/run"=>{"get"=>{"summary"=>"Runs the P45 report", "description"=>"Returns the result of the executed P45 report for the given query parameters", "operationId"=>"GetP45ReportOutput", "x-api-path-slug"=>"reportp45run-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"query", "name"=>"EmployeeKey", "description"=>"The employee unique key"}, {"in"=>"query", "name"=>"EmployerKey", "description"=>"The employer unique key"}, {"in"=>"query", "name"=>"TransformDefinitionKey", "description"=>"The transform definition unique key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs", "P45", "Report"]}}, "/Report/P60/run"=>{"get"=>{"summary"=>"Runs the P60 report", "description"=>"Returns the result of the executed P60 report for the given query parameters", "operationId"=>"GetP60ReportOutput", "x-api-path-slug"=>"reportp60run-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"query", "name"=>"EmployeeCodes", "description"=>"A comma separated list of the employee codes"}, {"in"=>"query", "name"=>"EmployerKey", "description"=>"The employer unique key"}, {"in"=>"query", "name"=>"TaxYear", "description"=>"The tax year"}, {"in"=>"query", "name"=>"TransformDefinitionKey", "description"=>"The transform definition unique key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs", "P60", "Report"]}}, "/Report/PAYSLIP/run"=>{"get"=>{"summary"=>"Runs the payslip report", "description"=>"Returns the result of the executed payslip report for the given query parameters", "operationId"=>"GetPayslipReportOutput", "x-api-path-slug"=>"reportpaysliprun-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"query", "name"=>"EmployeeCodes", "description"=>"A comma separated list of the employee codes"}, {"in"=>"query", "name"=>"EmployerKey", "description"=>"The employer unique key"}, {"in"=>"query", "name"=>"TaxPeriod", "description"=>"The tax period number"}, {"in"=>"query", "name"=>"TaxYear", "description"=>"The tax year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs", "Payslip", "Report"]}}, "/Report/PENLIABILITY/run"=>{"get"=>{"summary"=>"Runs the pension liability report", "description"=>"Returns the result of the executed pension liability report for the given query parameters", "operationId"=>"GetPensionLiabilityReportOutput", "x-api-path-slug"=>"reportpenliabilityrun-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"query", "name"=>"EmployerKey", "description"=>"The employer unique key"}, {"in"=>"query", "name"=>"PensionKey", "description"=>"The pension scheme unique key"}, {"in"=>"query", "name"=>"TaxYear", "description"=>"The tax year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs", "Pension", "Liability", "Report"]}}, "/Report/{ReportDefinitionId}"=>{"delete"=>{"summary"=>"Deletes a report definition", "description"=>"Delete the specified report definition", "operationId"=>"DeleteReportDefinition", "x-api-path-slug"=>"reportreportdefinitionid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"ReportDefinitionId", "description"=>"The report definition unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report", "Definition"]}, "get"=>{"summary"=>"Get the report definition", "description"=>"Returns the specified report definition from the authroised application", "operationId"=>"GetReportDefinitionFromApplication", "x-api-path-slug"=>"reportreportdefinitionid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"ReportDefinitionId", "description"=>"The report definition unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report", "Definition"]}, "put"=>{"summary"=>"Updates a report definition", "description"=>"Updates the existing specified report definition object", "operationId"=>"PutReportDefinition", "x-api-path-slug"=>"reportreportdefinitionid-put", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"body", "name"=>"ReportDefinition", "description"=>"The report definition object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"ReportDefinitionId", "description"=>"The report definition unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report", "Definition"]}}, "/Report/{ReportDefinitionId}/run"=>{"get"=>{"summary"=>"Runs the specified report definition", "description"=>"Returns the result of the executed report definition", "operationId"=>"GetReportOutput", "x-api-path-slug"=>"reportreportdefinitionidrun-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"ReportDefinitionId", "description"=>"The report definition unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs", "Specified", "Report", "Definition"]}}, "/Reports"=>{"get"=>{"summary"=>"Gets all reports", "description"=>"Get links to all saved report definitions under authorised application", "operationId"=>"GetReportDefinitionsFromApplication", "x-api-path-slug"=>"reports-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["", "Reports"]}, "post"=>{"summary"=>"Create a new report definition", "description"=>"Creates a new report defintion object", "operationId"=>"PostReportDefinition", "x-api-path-slug"=>"reports-post", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"body", "name"=>"ReportDefinition", "description"=>"The report definition object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Report", "Definition"]}}, "/Schemas"=>{"get"=>{"summary"=>"Get a list of all available schemas", "description"=>"Returns a collection of links to all the available data object schemas", "operationId"=>"GetSchemas", "x-api-path-slug"=>"schemas-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "", "Available", "Schemas"]}}, "/Schemas/AbsencePayInstruction.xsd"=>{"get"=>{"summary"=>"Get the AbsencePayInstruction schema", "description"=>"Returns the AbsencePayInstruction schema object", "operationId"=>"GetAbsencePayInstructionSchema", "x-api-path-slug"=>"schemasabsencepayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AbsencePayInstruction", "Schema"]}}, "/Schemas/AbsenceYtdPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the AbsenceYtdPayInstruction schema", "description"=>"Returns the AbsenceYtdPayInstruction schema object", "operationId"=>"GetAbsenceYtdPayInstructionSchema", "x-api-path-slug"=>"schemasabsenceytdpayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AbsenceYtdPayInstruction", "Schema"]}}, "/Schemas/Address.xsd"=>{"get"=>{"summary"=>"Get the Address schema", "description"=>"Returns the Address schema object", "operationId"=>"GetAddressSchema", "x-api-path-slug"=>"schemasaddress-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ress", "Schema"]}}, "/Schemas/ArrayOfEmployee.xsd"=>{"get"=>{"summary"=>"Get the ArrayOfEmployee schema", "description"=>"Returns the ArrayOfEmployee schema object", "operationId"=>"GetArrayOfEmployeeSchema", "x-api-path-slug"=>"schemasarrayofemployee-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ArrayOfEmployee", "Schema"]}}, "/Schemas/BankAccount.xsd"=>{"get"=>{"summary"=>"Get the BankAccount schema", "description"=>"Returns the BankAccount schema object", "operationId"=>"GetBankAccountSchema", "x-api-path-slug"=>"schemasbankaccount-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankAccount", "Schema"]}}, "/Schemas/BenefitPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the BenefitPayInstruction schema", "description"=>"Returns the BenefitPayInstruction schema object", "operationId"=>"GetBenefitPayInstructionSchema", "x-api-path-slug"=>"schemasbenefitpayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BenefitPayInstruction", "Schema"]}}, "/Schemas/BenefitYtdPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the BenefitYtdPayInstruction schema", "description"=>"Returns the BenefitYtdPayInstruction schema object", "operationId"=>"GetBenefitYtdPayInstructionSchema", "x-api-path-slug"=>"schemasbenefitytdpayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BenefitYtdPayInstruction", "Schema"]}}, "/Schemas/Common.xsd"=>{"get"=>{"summary"=>"Get the Common schema", "description"=>"Returns the Common schema object", "operationId"=>"GetCommonSchema", "x-api-path-slug"=>"schemascommon-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Common", "Schema"]}}, "/Schemas/Employee.xsd"=>{"get"=>{"summary"=>"Get the Employee schema", "description"=>"Returns the Employee schema object", "operationId"=>"GetEmployeeSchema", "x-api-path-slug"=>"schemasemployee-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employee", "Schema"]}}, "/Schemas/EmployeePartner.xsd"=>{"get"=>{"summary"=>"Get the EmployeePartner schema", "description"=>"Returns the EmployeePartner schema object", "operationId"=>"GetEmployeePartnerSchema", "x-api-path-slug"=>"schemasemployeepartner-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["EmployeePartner", "Schema"]}}, "/Schemas/Employer.xsd"=>{"get"=>{"summary"=>"Get the Employer schema", "description"=>"Returns the Employer schema object", "operationId"=>"GetEmployerSchema", "x-api-path-slug"=>"schemasemployer-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employer", "Schema"]}}, "/Schemas/HmrcSettings.xsd"=>{"get"=>{"summary"=>"Get the HmrcSettings schema", "description"=>"Returns the HmrcSettings schema object", "operationId"=>"GetHmrcSettingsSchema", "x-api-path-slug"=>"schemashmrcsettings-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["HmrcSettings", "Schema"]}}, "/Schemas/Link.xsd"=>{"get"=>{"summary"=>"Get the Link schema", "description"=>"Returns the Link schema object", "operationId"=>"GetLinkSchema", "x-api-path-slug"=>"schemaslink-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Schema"]}}, "/Schemas/NiAdjustmentPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the NiAdjustmentPayInstruction schema", "description"=>"Returns the NiAdjustmentPayInstruction schema object", "operationId"=>"GetNiAdjustmentPayInstructionSchema", "x-api-path-slug"=>"schemasniadjustmentpayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["NiAdjustmentPayInstruction", "Schema"]}}, "/Schemas/NiPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the NiPayInstruction schema", "description"=>"Returns the NiPayInstruction schema object", "operationId"=>"GetNiPayInstructionSchema", "x-api-path-slug"=>"schemasnipayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["NiPayInstruction", "Schema"]}}, "/Schemas/NiYtdPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the NiYtdPayInstruction schema", "description"=>"Returns the NiYtdPayInstruction schema object", "operationId"=>"GetNiYtdPayInstructionSchema", "x-api-path-slug"=>"schemasniytdpayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["NiYtdPayInstruction", "Schema"]}}, "/Schemas/P45PayInstruction.xsd"=>{"get"=>{"summary"=>"Get the P45PayInstruction schema", "description"=>"Returns the P45PayInstruction schema object", "operationId"=>"GetP45PayInstructionSchema", "x-api-path-slug"=>"schemasp45payinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["P45PayInstruction", "Schema"]}}, "/Schemas/PayInstruction.xsd"=>{"get"=>{"summary"=>"Get the PayInstruction schema", "description"=>"Returns the PayInstruction schema object", "operationId"=>"GetPayInstructionSchema", "x-api-path-slug"=>"schemaspayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PayInstruction", "Schema"]}}, "/Schemas/PayRunJobInstruction.xsd"=>{"get"=>{"summary"=>"Get the PayRunJobInstruction schema", "description"=>"Returns the PayRunJobInstruction schema object", "operationId"=>"GetPayRunJobInstructionSchema", "x-api-path-slug"=>"schemaspayrunjobinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PayRunJobInstruction", "Schema"]}}, "/Schemas/PaySchedule.xsd"=>{"get"=>{"summary"=>"Get the PaySchedule schema", "description"=>"Returns the PaySchedule schema object", "operationId"=>"GetPayScheduleSchema", "x-api-path-slug"=>"schemaspayschedule-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PaySchedule", "Schema"]}}, "/Schemas/PensionPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the PensionPayInstruction schema", "description"=>"Returns the PensionPayInstruction schema object", "operationId"=>"GetPensionPayInstructionSchema", "x-api-path-slug"=>"schemaspensionpayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PensionPayInstruction", "Schema"]}}, "/Schemas/PensionYtdPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the PensionYtdPayInstruction schema", "description"=>"Returns the PensionYtdPayInstruction schema object", "operationId"=>"GetPensionYtdPayInstructionSchema", "x-api-path-slug"=>"schemaspensionytdpayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PensionYtdPayInstruction", "Schema"]}}, "/Schemas/PrimitivePayInstruction.xsd"=>{"get"=>{"summary"=>"Get the PrimitivePayInstruction schema", "description"=>"Returns the PrimitivePayInstruction schema object", "operationId"=>"GetPrimitivePayInstructionSchema", "x-api-path-slug"=>"schemasprimitivepayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PrimitivePayInstruction", "Schema"]}}, "/Schemas/RtiJobInstruction.xsd"=>{"get"=>{"summary"=>"Get the RtiJobInstruction schema", "description"=>"Returns the RtiJobInstruction schema object", "operationId"=>"GetRtiJobInstructionSchema", "x-api-path-slug"=>"schemasrtijobinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RtiJobInstruction", "Schema"]}}, "/Schemas/SalaryPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the SalaryPayInstruction schema", "description"=>"Returns the SalaryPayInstruction schema object", "operationId"=>"GetSalaryPayInstructionSchema", "x-api-path-slug"=>"schemassalarypayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SalaryPayInstruction", "Schema"]}}, "/Schemas/SapPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the SapPayInstruction schema", "description"=>"Returns the SapPayInstruction schema object", "operationId"=>"GetSapPayInstructionSchema", "x-api-path-slug"=>"schemassappayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SapPayInstruction", "Schema"]}}, "/Schemas/SapYtdPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the SapYtdPayInstruction schema", "description"=>"Returns the SapYtdPayInstruction schema object", "operationId"=>"GetSapYtdPayInstructionSchema", "x-api-path-slug"=>"schemassapytdpayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SapYtdPayInstruction", "Schema"]}}, "/Schemas/ShppPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the ShppPayInstruction schema", "description"=>"Returns the ShppPayInstruction schema object", "operationId"=>"GetShppPayInstructionSchema", "x-api-path-slug"=>"schemasshpppayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ShppPayInstruction", "Schema"]}}, "/Schemas/ShppYtdPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the ShppYtdPayInstruction schema", "description"=>"Returns the ShppYtdPayInstruction schema object", "operationId"=>"GetShppYtdPayInstructionSchema", "x-api-path-slug"=>"schemasshppytdpayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ShppYtdPayInstruction", "Schema"]}}, "/Schemas/SmpPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the SmpPayInstruction schema", "description"=>"Returns the SmpPayInstruction schema object", "operationId"=>"GetSmpPayInstructionSchema", "x-api-path-slug"=>"schemassmppayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SmpPayInstruction", "Schema"]}}, "/Schemas/SmpYtdPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the SmpYtdPayInstruction schema", "description"=>"Returns the SmpYtdPayInstruction schema object", "operationId"=>"GetSmpYtdPayInstructionSchema", "x-api-path-slug"=>"schemassmpytdpayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SmpYtdPayInstruction", "Schema"]}}, "/Schemas/SppPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the SppPayInstruction schema", "description"=>"Returns the SppPayInstruction schema object", "operationId"=>"GetSppPayInstructionSchema", "x-api-path-slug"=>"schemasspppayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SppPayInstruction", "Schema"]}}, "/Schemas/SppYtdPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the SppYtdPayInstruction schema", "description"=>"Returns the SppYtdPayInstruction schema object", "operationId"=>"GetSppYtdPayInstructionSchema", "x-api-path-slug"=>"schemassppytdpayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SppYtdPayInstruction", "Schema"]}}, "/Schemas/SspPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the SspPayInstruction schema", "description"=>"Returns the SspPayInstruction schema object", "operationId"=>"GetSspPayInstructionSchema", "x-api-path-slug"=>"schemasssppayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SspPayInstruction", "Schema"]}}, "/Schemas/SspYtdPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the SspYtdPayInstruction schema", "description"=>"Returns the SspYtdPayInstruction schema object", "operationId"=>"GetSspYtdPayInstructionSchema", "x-api-path-slug"=>"schemassspytdpayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SspYtdPayInstruction", "Schema"]}}, "/Schemas/StudentLoanPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the StudentLoanPayInstruction schema", "description"=>"Returns the StudentLoanPayInstruction schema object", "operationId"=>"GetStudentLoanPayInstructionSchema", "x-api-path-slug"=>"schemasstudentloanpayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["StudentLoanPayInstruction", "Schema"]}}, "/Schemas/StudentLoanYtdPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the StudentLoanYtdPayInstruction schema", "description"=>"Returns the StudentLoanYtdPayInstruction schema object", "operationId"=>"GetStudentLoanYtdPayInstructionSchema", "x-api-path-slug"=>"schemasstudentloanytdpayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["StudentLoanYtdPayInstruction", "Schema"]}}, "/Schemas/TaxPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the TaxPayInstruction schema", "description"=>"Returns the TaxPayInstruction schema object", "operationId"=>"GetTaxPayInstructionSchema", "x-api-path-slug"=>"schemastaxpayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TaxPayInstruction", "Schema"]}}, "/Schemas/TaxYtdPayInstruction.xsd"=>{"get"=>{"summary"=>"Get the TaxYtdPayInstruction schema", "description"=>"Returns the TaxYtdPayInstruction schema object", "operationId"=>"GetTaxYtdPayInstructionSchema", "x-api-path-slug"=>"schemastaxytdpayinstruction-xsd-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TaxYtdPayInstruction", "Schema"]}}, "/Templates"=>{"get"=>{"summary"=>"Get a list of all available data object tempaltes", "description"=>"Returns a collection of links to all the available data object templates", "operationId"=>"GetTemplates", "x-api-path-slug"=>"templates-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "", "Available", "Data", "Object", "Tempaltes"]}}, "/Templates/address"=>{"get"=>{"summary"=>"Gets the address template", "description"=>"Return the address data object template", "operationId"=>"GetAddressTemplate", "x-api-path-slug"=>"templatesaddress-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "Template"]}}, "/Templates/applicationinfo"=>{"get"=>{"summary"=>"Gets the application info template", "description"=>"Return the application info data object template", "operationId"=>"GetApplicationInfoTemplate", "x-api-path-slug"=>"templatesapplicationinfo-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Info", "Template"]}}, "/Templates/bankaccount"=>{"get"=>{"summary"=>"Gets the bank account template", "description"=>"Return the bank account data object template", "operationId"=>"GetBankAccountTemplate", "x-api-path-slug"=>"templatesbankaccount-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bank", "Account", "Template"]}}, "/Templates/benefitpayinstruction"=>{"get"=>{"summary"=>"Gets the benefit pay instruction template", "description"=>"Return the benefit pay instruction data object template", "operationId"=>"GetBenefitPayInstructionTemplate", "x-api-path-slug"=>"templatesbenefitpayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Benefit", "Pay", "Instruction", "Template"]}}, "/Templates/benefitytdpayinstruction"=>{"get"=>{"summary"=>"Gets the benefit YTD pay instruction template", "description"=>"Return the benefit YTD pay instruction data object template", "operationId"=>"GetBenefitYtdPayInstructionTemplate", "x-api-path-slug"=>"templatesbenefitytdpayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Benefit", "YTD", "Pay", "Instruction", "Template"]}}, "/Templates/commentary"=>{"get"=>{"summary"=>"Gets the commentary template", "description"=>"Return the commentary data object template", "operationId"=>"GetCommentaryTemplate", "x-api-path-slug"=>"templatescommentary-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commentary", "Template"]}}, "/Templates/employee"=>{"get"=>{"summary"=>"Gets the employee template", "description"=>"Return the employee data object template", "operationId"=>"GetEmployeeTemplate", "x-api-path-slug"=>"templatesemployee-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employee", "Template"]}}, "/Templates/employeepartner"=>{"get"=>{"summary"=>"Gets the employee partner template", "description"=>"Return the employee partner data object template", "operationId"=>"GetEmployeePartnerTemplate", "x-api-path-slug"=>"templatesemployeepartner-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employee", "Partner", "Template"]}}, "/Templates/employer"=>{"get"=>{"summary"=>"Gets the employer template", "description"=>"Return the employer data object template", "operationId"=>"GetEmployerTemplate", "x-api-path-slug"=>"templatesemployer-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employer", "Template"]}}, "/Templates/errormodel"=>{"get"=>{"summary"=>"Gets the error model template", "description"=>"Return the error model data object template", "operationId"=>"GetErrorModelTemplate", "x-api-path-slug"=>"templateserrormodel-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Error", "Model", "Template"]}}, "/Templates/hmrcsettings"=>{"get"=>{"summary"=>"Gets the hmrc settings template", "description"=>"Return the hmrc settings data object template", "operationId"=>"GetHmrcSettingsTemplate", "x-api-path-slug"=>"templateshmrcsettings-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hmrc", "Settings", "Template"]}}, "/Templates/jobinfo"=>{"get"=>{"summary"=>"Gets the job info template", "description"=>"Return the job info data object template", "operationId"=>"GetJobInfoTemplate", "x-api-path-slug"=>"templatesjobinfo-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "Info", "Template"]}}, "/Templates/link"=>{"get"=>{"summary"=>"Gets the link template", "description"=>"Return the link data object template", "operationId"=>"GetLinkTemplate", "x-api-path-slug"=>"templateslink-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Template"]}}, "/Templates/linkcollection"=>{"get"=>{"summary"=>"Gets the link collection template", "description"=>"Return the link collection data object template", "operationId"=>"GetLinkCollectionTemplate", "x-api-path-slug"=>"templateslinkcollection-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Collection", "Template"]}}, "/Templates/niadjustmentpayinstruction"=>{"get"=>{"summary"=>"Gets the NI adjustment pay instruction template", "description"=>"Return the NI adjustment pay instruction data object template", "operationId"=>"GetNiAdjustmentPayInstructionTemplate", "x-api-path-slug"=>"templatesniadjustmentpayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["NI", "Adjustment", "Pay", "Instruction", "Template"]}}, "/Templates/nipayinstruction"=>{"get"=>{"summary"=>"Gets the NI pay instruction template", "description"=>"Return the NI pay instruction data object template", "operationId"=>"GetNiPayInstructionTemplate", "x-api-path-slug"=>"templatesnipayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["NI", "Pay", "Instruction", "Template"]}}, "/Templates/niytdpayinstruction"=>{"get"=>{"summary"=>"Gets the NI YTD pay instruction template", "description"=>"Return the NI YTD pay instruction data object template", "operationId"=>"GetNiYtdPayInstructionTemplate", "x-api-path-slug"=>"templatesniytdpayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["NI", "YTD", "Pay", "Instruction", "Template"]}}, "/Templates/p45payinstruction"=>{"get"=>{"summary"=>"Gets the P45 pay instruction template", "description"=>"Return the P45 pay instruction data object template", "operationId"=>"GetP45PayInstructionTemplate", "x-api-path-slug"=>"templatesp45payinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["P45", "Pay", "Instruction", "Template"]}}, "/Templates/paycode"=>{"get"=>{"summary"=>"Gets the pay code template", "description"=>"Return the pay code data object template", "operationId"=>"GetPayCodeTemplate", "x-api-path-slug"=>"templatespaycode-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Code", "Template"]}}, "/Templates/payinstruction"=>{"get"=>{"summary"=>"Gets the pay instruction template", "description"=>"Return the pay instruction data object template", "operationId"=>"GetPayInstructionTemplate", "x-api-path-slug"=>"templatespayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Instruction", "Template"]}}, "/Templates/payline"=>{"get"=>{"summary"=>"Gets the pay line template", "description"=>"Return the pay line data object template", "operationId"=>"GetPayLineTemplate", "x-api-path-slug"=>"templatespayline-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Line", "Template"]}}, "/Templates/paylinebenefit"=>{"get"=>{"summary"=>"Gets the pay line benefit template", "description"=>"Return the pay line benefit data object template", "operationId"=>"GetPayLineBenefitTemplate", "x-api-path-slug"=>"templatespaylinebenefit-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Line", "Benefit", "Template"]}}, "/Templates/paylineni"=>{"get"=>{"summary"=>"Gets the pay line NI template", "description"=>"Return the pay line NI data object template", "operationId"=>"GetPayLineNiTemplate", "x-api-path-slug"=>"templatespaylineni-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Line", "NI", "Template"]}}, "/Templates/paylinepension"=>{"get"=>{"summary"=>"Gets the pay line pension template", "description"=>"Return the pay line pension data object template", "operationId"=>"GetPayLinePensionTemplate", "x-api-path-slug"=>"templatespaylinepension-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Line", "Pension", "Template"]}}, "/Templates/paylinesap"=>{"get"=>{"summary"=>"Gets the pay line sap template", "description"=>"Return the pay line sap data object template", "operationId"=>"GetPayLineSapTemplate", "x-api-path-slug"=>"templatespaylinesap-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Line", "Sap", "Template"]}}, "/Templates/paylineshpp"=>{"get"=>{"summary"=>"Gets the pay line shpp template", "description"=>"Return the pay line shpp data object template", "operationId"=>"GetPayLineShppTemplate", "x-api-path-slug"=>"templatespaylineshpp-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Line", "Shpp", "Template"]}}, "/Templates/paylinesmp"=>{"get"=>{"summary"=>"Gets the pay line smp template", "description"=>"Return the pay line smp data object template", "operationId"=>"GetPayLineSmpTemplate", "x-api-path-slug"=>"templatespaylinesmp-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Line", "Smp", "Template"]}}, "/Templates/paylinespp"=>{"get"=>{"summary"=>"Gets the pay line spp template", "description"=>"Return the pay line spp data object template", "operationId"=>"GetPayLineSppTemplate", "x-api-path-slug"=>"templatespaylinespp-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Line", "Spp", "Template"]}}, "/Templates/paylinessp"=>{"get"=>{"summary"=>"Gets the pay line ssp template", "description"=>"Return the pay line ssp data object template", "operationId"=>"GetPayLineSspTemplate", "x-api-path-slug"=>"templatespaylinessp-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Line", "Ssp", "Template"]}}, "/Templates/paylinestudentloan"=>{"get"=>{"summary"=>"Gets the pay line student loan template", "description"=>"Return the pay line student loan data object template", "operationId"=>"GetPayLineStudentLoanTemplate", "x-api-path-slug"=>"templatespaylinestudentloan-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Line", "Student", "Loan", "Template"]}}, "/Templates/paylinetax"=>{"get"=>{"summary"=>"Gets the pay line tax template", "description"=>"Return the pay line tax data object template", "operationId"=>"GetPayLineTaxTemplate", "x-api-path-slug"=>"templatespaylinetax-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Line", "Tax", "Template"]}}, "/Templates/payrun"=>{"get"=>{"summary"=>"Gets the pay run template", "description"=>"Return the pay run data object template", "operationId"=>"GetPayRunTemplate", "x-api-path-slug"=>"templatespayrun-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Run", "Template"]}}, "/Templates/payrunjob"=>{"get"=>{"summary"=>"Gets the pay run job template", "description"=>"Return the pay run job data object template", "operationId"=>"GetPayRunJobTemplate", "x-api-path-slug"=>"templatespayrunjob-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Run", "Job", "Template"]}}, "/Templates/payrunjobinstruction"=>{"get"=>{"summary"=>"Gets the pay run job instruction template", "description"=>"Return the pay run job instruction data object template", "operationId"=>"GetPayRunJobInstructionTemplate", "x-api-path-slug"=>"templatespayrunjobinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Run", "Job", "Instruction", "Template"]}}, "/Templates/payschedule"=>{"get"=>{"summary"=>"Gets the pay schedule template", "description"=>"Return the pay schedule data object template", "operationId"=>"GetPayScheduleTemplate", "x-api-path-slug"=>"templatespayschedule-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pay", "Schedule", "Template"]}}, "/Templates/pensionpayinstruction"=>{"get"=>{"summary"=>"Gets the pension pay instruction template", "description"=>"Return the pension pay instruction data object template", "operationId"=>"GetPensionPayInstructionTemplate", "x-api-path-slug"=>"templatespensionpayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pension", "Pay", "Instruction", "Template"]}}, "/Templates/pensionytdpayinstruction"=>{"get"=>{"summary"=>"Gets the pension YTD pay instruction template", "description"=>"Return the pension YTD pay instruction data object template", "operationId"=>"GetPensionYtdPayInstructionTemplate", "x-api-path-slug"=>"templatespensionytdpayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pension", "YTD", "Pay", "Instruction", "Template"]}}, "/Templates/primitivepayinstruction"=>{"get"=>{"summary"=>"Gets the primitive pay instruction template", "description"=>"Return the primitive pay instruction data object template", "operationId"=>"GetPrimitivePayInstructionTemplate", "x-api-path-slug"=>"templatesprimitivepayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Primitive", "Pay", "Instruction", "Template"]}}, "/Templates/reportdefinition"=>{"get"=>{"summary"=>"Gets the report definition template", "description"=>"Return the report definition data object template", "operationId"=>"GetReportDefinitionTemplate", "x-api-path-slug"=>"templatesreportdefinition-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report", "Definition", "Template"]}}, "/Templates/rtieastransaction"=>{"get"=>{"summary"=>"Gets the rti eas transaction template", "description"=>"Return the rti eas transaction data object template", "operationId"=>"GetRtiEasTransactionTemplate", "x-api-path-slug"=>"templatesrtieastransaction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rti", "Eas", "Transaction", "Template"]}}, "/Templates/rtiepstransaction"=>{"get"=>{"summary"=>"Gets the rti eps transaction template", "description"=>"Return the rti eps transaction data object template", "operationId"=>"GetRtiEpsTransactionTemplate", "x-api-path-slug"=>"templatesrtiepstransaction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rti", "Eps", "Transaction", "Template"]}}, "/Templates/rtieyutransaction"=>{"get"=>{"summary"=>"Gets the rti eyu transaction template", "description"=>"Return the rti eyu transaction data object template", "operationId"=>"GetRtiEyuTransactionTemplate", "x-api-path-slug"=>"templatesrtieyutransaction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rti", "Eyu", "Transaction", "Template"]}}, "/Templates/rtifpstransaction"=>{"get"=>{"summary"=>"Gets the rti fps transaction template", "description"=>"Return the rti fps transaction data object template", "operationId"=>"GetRtiFpsTransactionTemplate", "x-api-path-slug"=>"templatesrtifpstransaction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rti", "Fps", "Transaction", "Template"]}}, "/Templates/rtijob"=>{"get"=>{"summary"=>"Gets the rti job template", "description"=>"Return the rti job data object template", "operationId"=>"GetRtiJobTemplate", "x-api-path-slug"=>"templatesrtijob-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rti", "Job", "Template"]}}, "/Templates/rtijobinstruction"=>{"get"=>{"summary"=>"Gets the rti job instruction template", "description"=>"Return the rti job instruction data object template", "operationId"=>"GetRtiJobInstructionTemplate", "x-api-path-slug"=>"templatesrtijobinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rti", "Job", "Instruction", "Template"]}}, "/Templates/rtinvrtransaction"=>{"get"=>{"summary"=>"Gets the rti nvr transaction template", "description"=>"Return the rti nvr transaction data object template", "operationId"=>"GetRtiNvrTransactionTemplate", "x-api-path-slug"=>"templatesrtinvrtransaction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rti", "Nvr", "Transaction", "Template"]}}, "/Templates/rtitransactionbase"=>{"get"=>{"summary"=>"Gets the rti transaction base template", "description"=>"Return the rti transaction base data object template", "operationId"=>"GetRtiTransactionBaseTemplate", "x-api-path-slug"=>"templatesrtitransactionbase-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rti", "Transaction", "Base", "Template"]}}, "/Templates/salarypayinstruction"=>{"get"=>{"summary"=>"Gets the salary pay instruction template", "description"=>"Return the salary pay instruction data object template", "operationId"=>"GetSalaryPayInstructionTemplate", "x-api-path-slug"=>"templatessalarypayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Salary", "Pay", "Instruction", "Template"]}}, "/Templates/sappayinstruction"=>{"get"=>{"summary"=>"Gets the sap pay instruction template", "description"=>"Return the sap pay instruction data object template", "operationId"=>"GetSapPayInstructionTemplate", "x-api-path-slug"=>"templatessappayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sap", "Pay", "Instruction", "Template"]}}, "/Templates/sapytdpayinstruction"=>{"get"=>{"summary"=>"Gets the sap YTD pay instruction template", "description"=>"Return the sap YTD pay instruction data object template", "operationId"=>"GetSapYtdPayInstructionTemplate", "x-api-path-slug"=>"templatessapytdpayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sap", "YTD", "Pay", "Instruction", "Template"]}}, "/Templates/shpppayinstruction"=>{"get"=>{"summary"=>"Gets the shpp pay instruction template", "description"=>"Return the shpp pay instruction data object template", "operationId"=>"GetShppPayInstructionTemplate", "x-api-path-slug"=>"templatesshpppayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shpp", "Pay", "Instruction", "Template"]}}, "/Templates/shppytdpayinstruction"=>{"get"=>{"summary"=>"Gets the shpp YTD pay instruction template", "description"=>"Return the shpp YTD pay instruction data object template", "operationId"=>"GetShppYtdPayInstructionTemplate", "x-api-path-slug"=>"templatesshppytdpayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shpp", "YTD", "Pay", "Instruction", "Template"]}}, "/Templates/smppayinstruction"=>{"get"=>{"summary"=>"Gets the smp pay instruction template", "description"=>"Return the smp pay instruction data object template", "operationId"=>"GetSmpPayInstructionTemplate", "x-api-path-slug"=>"templatessmppayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Smp", "Pay", "Instruction", "Template"]}}, "/Templates/smpytdpayinstruction"=>{"get"=>{"summary"=>"Gets the smp YTD pay instruction template", "description"=>"Return the smp YTD pay instruction data object template", "operationId"=>"GetSmpYtdPayInstructionTemplate", "x-api-path-slug"=>"templatessmpytdpayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Smp", "YTD", "Pay", "Instruction", "Template"]}}, "/Templates/spppayinstruction"=>{"get"=>{"summary"=>"Gets the spp pay instruction template", "description"=>"Return the spp pay instruction data object template", "operationId"=>"GetSppPayInstructionTemplate", "x-api-path-slug"=>"templatesspppayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spp", "Pay", "Instruction", "Template"]}}, "/Templates/sppytdpayinstruction"=>{"get"=>{"summary"=>"Gets the spp YTD pay instruction template", "description"=>"Return the spp YTD pay instruction data object template", "operationId"=>"GetSppYtdPayInstructionTemplate", "x-api-path-slug"=>"templatessppytdpayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spp", "YTD", "Pay", "Instruction", "Template"]}}, "/Templates/ssppayinstruction"=>{"get"=>{"summary"=>"Gets the ssp pay instruction template", "description"=>"Return the ssp pay instruction data object template", "operationId"=>"GetSspPayInstructionTemplate", "x-api-path-slug"=>"templatesssppayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ssp", "Pay", "Instruction", "Template"]}}, "/Templates/sspytdpayinstruction"=>{"get"=>{"summary"=>"Gets the ssp YTD pay instruction template", "description"=>"Return the ssp YTD pay instruction data object template", "operationId"=>"GetSspYtdPayInstructionTemplate", "x-api-path-slug"=>"templatessspytdpayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ssp", "YTD", "Pay", "Instruction", "Template"]}}, "/Templates/studentloanpayinstruction"=>{"get"=>{"summary"=>"Gets the student loan pay instruction template", "description"=>"Return the student loan pay instruction data object template", "operationId"=>"GetStudentLoanPayInstructionTemplate", "x-api-path-slug"=>"templatesstudentloanpayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Student", "Loan", "Pay", "Instruction", "Template"]}}, "/Templates/studentloanytdpayinstruction"=>{"get"=>{"summary"=>"Gets the student loan YTD pay instruction template", "description"=>"Return the student loan YTD pay instruction data object template", "operationId"=>"GetStudentLoanYtdPayInstructionTemplate", "x-api-path-slug"=>"templatesstudentloanytdpayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Student", "Loan", "YTD", "Pay", "Instruction", "Template"]}}, "/Templates/taxpayinstruction"=>{"get"=>{"summary"=>"Gets the tax pay instruction template", "description"=>"Return the tax pay instruction data object template", "operationId"=>"GetTaxPayInstructionTemplate", "x-api-path-slug"=>"templatestaxpayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tax", "Pay", "Instruction", "Template"]}}, "/Templates/taxytdpayinstruction"=>{"get"=>{"summary"=>"Gets the tax YTD pay instruction template", "description"=>"Return the tax YTD pay instruction data object template", "operationId"=>"GetTaxYtdPayInstructionTemplate", "x-api-path-slug"=>"templatestaxytdpayinstruction-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tax", "YTD", "Pay", "Instruction", "Template"]}}, "/Transform/{TransformDefinitionId}"=>{"delete"=>{"summary"=>"Deletes a transform definition", "description"=>"Delete the specified transform definition", "operationId"=>"DeleteTransformDefinition", "x-api-path-slug"=>"transformtransformdefinitionid-delete", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"TransformDefinitionId", "description"=>"The transform definition unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transform", "Definition"]}, "get"=>{"summary"=>"Get the transform definition", "description"=>"Returns the specified transform definition from the authroised application", "operationId"=>"GetTransformDefinitionFromApplication", "x-api-path-slug"=>"transformtransformdefinitionid-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"path", "name"=>"TransformDefinitionId", "description"=>"The transform definition unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transform", "Definition"]}, "put"=>{"summary"=>"Updates a transform definition", "description"=>"Updates the existing specified transform definition object", "operationId"=>"PutTransformDefinition", "x-api-path-slug"=>"transformtransformdefinitionid-put", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"body", "name"=>"TransformDefinition", "description"=>"The transform definition object to be executed against the report data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"TransformDefinitionId", "description"=>"The transform definition unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transform", "Definition"]}}, "/Transforms"=>{"get"=>{"summary"=>"Gets all transform definitions", "description"=>"Get links to all saved transform definitions under authorised application", "operationId"=>"GetTransformDefinitionsFromApplication", "x-api-path-slug"=>"transforms-get", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["", "Transform", "Definitions"]}, "post"=>{"summary"=>"Create a new transform definition", "description"=>"Creates a new transform defintion object", "operationId"=>"PostTransformDefinition", "x-api-path-slug"=>"transforms-post", "parameters"=>[{"in"=>"header", "name"=>"Api-Version", "description"=>"The version of the api to target"}, {"in"=>"header", "name"=>"Authorization", "description"=>"The OAuth 1 authorization header"}, {"in"=>"body", "name"=>"TransformDefinition", "description"=>"The transform definition object to be executed against the report data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Transform", "Definition"]}}}}, "apis"=>{"name"=>"PayRun", "x-slug"=>"payrun", "description"=>"An open, scalable, transparent and HMRC accredited payroll API. Put the power of payroll into your application today.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28484-payrun-io.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,Payments,Profiles,Relative Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"payrun/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Pay Run.IO", "x-api-slug"=>"pay-run-io", "description"=>"An open, scalable, transparent and HMRC accredited payroll API. Put the power of payroll into your application today.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28484-payrun-io.jpg", "humanURL"=>"http://www.payrun.io", "baseURL"=>"https://api.test.payrun.io//", "tags"=>"API Provider,Payments,Profiles,Relative Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/payrun/pay-run-io-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://www.payrun.io"}, {"type"=>"x-documentation", "url"=>"https://developer.payrun.io/docs/home/index.html"}, {"type"=>"x-email", "url"=>"support@payrun.io"}, {"type"=>"x-email", "url"=>"info@payrun.io"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/PayRun_io"}, {"type"=>"x-website", "url"=>"http://api.test.payrun.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
gotomeeting{"scim-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"GoToMeeting", "x-complete"=>1, "info"=>{"title"=>"SCIM", "description"=>"the-scim-api-lets-you-manage-users-in-your-organization--you-can-then-automate-the-provisioning-of-product-licenses-for-these-users-and-they-can-use-your-companys-single-signon-solution-through-an-identity-provider-", "termsOfService"=>"https://developer.citrixonline.com/terms-use", "contact"=>{"name"=>"Developer Support", "url"=>"https://developer.citrixonline.com", "email"=>"developer-support@citrixonline.com"}, "version"=>"N/A"}, "host"=>"api.citrixonline.com", "basePath"=>"/identity/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/Groups"=>{"get"=>{"summary"=>"Get Groups", "description"=>"Queries multiple group identities in the organization domain. Filtering, sorting and pagination are available. This call requires the role ROLE_ORG_READ.", "operationId"=>"getGroups", "x-api-path-slug"=>"groups-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Without a filter, all groups are returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, "post"=>{"summary"=>"Create Group", "description"=>"Creates a new organization group and adds it to the user domain. Member groups and member users must be in the organization. This call requires the role ROLE_ORG_WRITE.", "operationId"=>"createGroup", "x-api-path-slug"=>"groups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The details of the group to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/Groups/{groupKey}"=>{"delete"=>{"summary"=>"Delete Group", "description"=>"Deletes a group from the organization (but not from the account). The group must be in the organization. This call requires the role ROLE_ORG_WRITE.", "operationId"=>"deleteGroup", "x-api-path-slug"=>"groupsgroupkey-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "GroupKey"]}, "get"=>{"summary"=>"Get Group", "description"=>"Queries group details in the organization domain. This call requires the role ROLE_ORG_READ.", "operationId"=>"getGroup", "x-api-path-slug"=>"groupsgroupkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "GroupKey"]}, "patch"=>{"summary"=>"Update Group", "description"=>"Updates one or more values of an existing group without sending the full definition. Member groups and member users must be in the organization. This call requires the role ROLE_ORG_WRITE.", "operationId"=>"updateGroup", "x-api-path-slug"=>"groupsgroupkey-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The group data to update", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "GroupKey"]}, "put"=>{"summary"=>"Replace Group", "description"=>"Updates an existing group. The request must include the full group definition. To modify one or more values without sending the full definition, see \"Update Group\". Member groups and member users must be in the organization. This call requires the role ROLE_ORG_WRITE.", "operationId"=>"replaceGroup", "x-api-path-slug"=>"groupsgroupkey-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The new group definition", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "GroupKey"]}}, "/Schemas/Users"=>{"get"=>{"summary"=>"Get User Schema", "description"=>"Queries the user schema. The user schema is defined in SCIM Core Schema (http://www.simplecloud.info/specs/draft-scim-core-schema-01.html#resource-schema).", "operationId"=>"getUserSchema", "x-api-path-slug"=>"schemasusers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schemas", "Users"]}}, "/ServiceProviderConfigs"=>{"get"=>{"summary"=>"Get Service Provider Configurations", "description"=>"Queries service provider configurations. The service provider configurations are defined in SCIM Core Schema (http://www.simplecloud.info/specs/draft-scim-core-schema-01.html#anchor6). This call returns a description, a documentationURL, name, and specURL.", "operationId"=>"getServiceProviderConfigs", "x-api-path-slug"=>"serviceproviderconfigs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ServiceProviderConfigs"]}}, "/Users"=>{"get"=>{"summary"=>"Get Users", "description"=>"Queries multiple user identities in the organization domain. Filtering is available.", "operationId"=>"getUsers", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Without a filter, all users in a user domain are returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "post"=>{"summary"=>"Create User", "description"=>"Creates a new organization user and adds them to the user domain. The user email domain must match an existing organization email domain.", "operationId"=>"createUsers", "x-api-path-slug"=>"users-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The details of the user to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/Users/me"=>{"get"=>{"summary"=>"Get Current User", "description"=>"Queries the identity of the current authenticated user.", "operationId"=>"getMe", "x-api-path-slug"=>"usersme-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Me"]}, "patch"=>{"summary"=>"Update Current User", "description"=>"Changes a limited set (or all if you choose) of the current authenticated user's data. The updated user email domain must be an existing organization email domain.", "operationId"=>"updateMe", "x-api-path-slug"=>"usersme-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The new user data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Me"]}, "put"=>{"summary"=>"Replace Current User", "description"=>"Changes the current authenticated user's displayName, locale, timezone, username and password. The request must include the full user definition (to modify one or more values without sending the full definition, see Update User). The replaced user email domain must be an existing organization email domain.", "operationId"=>"replaceMe", "x-api-path-slug"=>"usersme-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The new user data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Me"]}}, "/Users/{userKey}"=>{"delete"=>{"summary"=>"Delete User", "description"=>"Deletes a user from the organization (but not from the account).", "operationId"=>"deleteUser", "x-api-path-slug"=>"usersuserkey-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "UserKey"]}, "get"=>{"summary"=>"Get User", "description"=>"Queries user identity in the organization domain.", "operationId"=>"getUser", "x-api-path-slug"=>"usersuserkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "UserKey"]}, "patch"=>{"summary"=>"Update User", "description"=>"Changes a limited set (or all if you choose) of the user's data. The updated user email domain must be an existing organization email domain.", "operationId"=>"updateUser", "x-api-path-slug"=>"usersuserkey-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The new user data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "UserKey"]}, "put"=>{"summary"=>"Replace User", "description"=>"Changes an existing user's displayName, locale, timezone, username and password. The request must include the full user definition (to modify one or more values without sending the full definition, see Update User). The replaced user email domain must be an existing organization email domain.", "operationId"=>"replaceUser", "x-api-path-slug"=>"usersuserkey-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The new user data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "UserKey"]}}}}, "go-to-assist-seeit-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"GoToMeeting", "x-complete"=>1, "info"=>{"title"=>"Go To Assist Seeit", "description"=>"pallows-you-to-integrate-gotoassist-seeit-into-your-own-solutions-ppgeneral-notesulligotoassist-seeit-sessions-are-identified-by-their-uuid--the-more-readable-9-digit-support-key-e-g--123456789-may-be-reused-later-for-another-session-and-thus-cannot-be-used-to-unambiguously-identify-a-session-liliif-not-explicitly-stated-otherwise-all-timestamps-represent-the-number-of-milliseconds-since-19700101-in-utc-similar-to-a-unix-timestamp-but-with-millisecond-resolutionliulp", "version"=>"0.9.0"}, "host"=>"api.citrixonline.com", "basePath"=>"/seeit/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/sessions"=>{"get"=>{"summary"=>"Get details for multiple GoToAssist Seeit sessions", "description"=>" This endpoint allows you to get all relevant details for mulitple GoToAssist Seeit sessions. Session details are available for 90 days. The fields and their values in the response depend on session status and the time elapsed since session end; e.g. session data like snapshots or the session recording are only available for 72 hours.The results will be paged, with paging customizable to match your requirements. ", "operationId"=>"sessions.get", "x-api-path-slug"=>"sessions-get", "parameters"=>[{"in"=>"query", "name"=>"endTime", "description"=>"Optional end of date range as timestamp (will be compared against session creation time)"}, {"in"=>"query", "name"=>"page", "description"=>"Optional page number"}, {"in"=>"query", "name"=>"size", "description"=>"Optional page size"}, {"in"=>"query", "name"=>"sort", "description"=>"Optional sort criteria, i"}, {"in"=>"query", "name"=>"startTime", "description"=>"Optional start of date range as timestamp (will be compared against session creation time)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions"]}, "post"=>{"summary"=>"Create a GoToAssist Seeit session", "description"=>"This endpoint allows you to create a GoToAssist Seeit session. The session logically exists but is not started until you open the returned startUrl in a suitable browser.", "operationId"=>"sessions.post", "x-api-path-slug"=>"sessions-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions"]}}, "/sessions/{uuid}"=>{"get"=>{"summary"=>"Get details for a single GoToAssist Seeit session", "description"=>"This endpoint allows you to get all relevant details for a single GoToAssist Seeit session. Session details are available for 90 days. The fields and their values in the response depend on session status and the time elapsed since session end; e.g. session data like snapshots or the session recording are only available for 72 hours. ", "operationId"=>"sessions.uuid.get", "x-api-path-slug"=>"sessionsuuid-get", "parameters"=>[{"in"=>"path", "name"=>"uuid", "description"=>"the uuid returned when creating the session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions", "Uuid"]}}}}, "go-to-webinar-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"GoToMeeting", "x-complete"=>1, "info"=>{"title"=>"Go To Webinar", "description"=>"the-gotowebinar-api-provides-seamless-integration-of-webinar-registrant-and-attendee-data-into-your-existing-infrastructure-or-thirdparty-applications--the-ability-to-register-participants-as-well-as-pull-lists-of-registrants-and-attendees-for-a-webinar-allows-organizers-to-manage-the-flow-of-information-between-their-primary-applications-without-manual-intervention-", "termsOfService"=>"https://developer.citrixonline.com/terms-use", "contact"=>{"name"=>"Developer Support", "url"=>"https://developer.citrixonline.com", "email"=>"developer-support@citrixonline.com"}, "version"=>"1.0.0"}, "host"=>"api.citrixonline.com", "basePath"=>"/G2W/rest", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/accounts/{accountKey}/webinars"=>{"get"=>{"summary"=>"Get all webinars for an account", "description"=>"Retrieves the list of webinars for an account within a given date range. __*Page*__ and __*size*__ parameters are optional. Default __*page*__ is 0 and default __*size*__ is 20. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.", "operationId"=>"getAllAccountWebinars", "x-api-path-slug"=>"accountsaccountkeywebinars-get", "parameters"=>[{"in"=>"query", "name"=>"fromTime", "description"=>"A required start of datetime range in ISO8601 UTC format, e"}, {"in"=>"query", "name"=>"page", "description"=>"The page number to be displayed"}, {"in"=>"query", "name"=>"size", "description"=>"The size of the page"}, {"in"=>"query", "name"=>"toTime", "description"=>"A required end of datetime range in ISO8601 UTC format, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "AccountKey", "Webinars"]}}, "/organizers/{organizerKey}/historicalWebinars"=>{"get"=>{"summary"=>"Get historical webinars", "description"=>"Returns details for completed webinars for the specified organizer and completed webinars of other organizers where the specified organizer is a co-organizer.", "operationId"=>"getHistoricalWebinars", "x-api-path-slug"=>"organizersorganizerkeyhistoricalwebinars-get", "parameters"=>[{"in"=>"query", "name"=>"fromTime", "description"=>"A required start of datetime range in ISO8601 UTC format, e"}, {"in"=>"query", "name"=>"toTime", "description"=>"A required end of datetime range in ISO8601 UTC format, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "HistoricalWebinars"]}}, "/organizers/{organizerKey}/sessions"=>{"get"=>{"summary"=>"Get organizer sessions", "description"=>"Retrieve all completed sessions of all the webinars of a given organizer.", "operationId"=>"getOrganizerSessions", "x-api-path-slug"=>"organizersorganizerkeysessions-get", "parameters"=>[{"in"=>"query", "name"=>"fromTime", "description"=>"A required start of datetime range in ISO8601 UTC format, e"}, {"in"=>"query", "name"=>"toTime", "description"=>"A required end of datetime range in ISO8601 UTC format, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Sessions"]}}, "/organizers/{organizerKey}/upcomingWebinars"=>{"get"=>{"summary"=>"Get upcoming webinars", "description"=>"Returns webinars scheduled for the future for the specified organizer and webinars of other organizers where the specified organizer is a co-organizer.", "operationId"=>"getUpcomingWebinars", "x-api-path-slug"=>"organizersorganizerkeyupcomingwebinars-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "UpcomingWebinars"]}}, "/organizers/{organizerKey}/webinars"=>{"get"=>{"summary"=>"Get all webinars", "description"=>"Returns webinars scheduled for the future for a specified organizer.", "operationId"=>"getAllWebinars", "x-api-path-slug"=>"organizersorganizerkeywebinars-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars"]}, "post"=>{"summary"=>"Create webinar", "description"=>"Creates a single session webinar, a sequence of webinars or a series of webinars depending on the type field in the body: \"single_session\" creates a single webinar session, \"sequence\" creates a webinar with multiple meeting times where attendees are expected to be the same for all sessions, and \"series\" creates a webinar with multiple meetings times where attendees choose only one to attend. The default, if no type is declared, is single_session. A sequence webinar requires a \"recurrenceStart\" object consisting of a \"startTime\" and \"endTime\" key for the first webinar of the sequence, a \"recurrencePattern\" of \"daily\", \"weekly\", \"monthly\", and a \"recurrenceEnd\" which is the last date of the sequence (for example, 2016-12-01). A series webinar requires a \"times\" array with a discrete \"startTime\" and \"endTime\" for each webinar in the series. The call requires a webinar subject and description. The \"isPasswordProtected\" sets whether the webinar requires a password for attendees to join. If set to True, the organizer must go to Registration Settings at My Webinars (https://global.gotowebinar.com/webinars.tmpl) and add the password to the webinar, and send the password to the registrants. The response provides a numeric webinarKey in string format for the new webinar. Once a webinar has been created with this method, you can accept registrations.", "operationId"=>"createWebinar", "x-api-path-slug"=>"organizersorganizerkeywebinars-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The webinar details", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}"=>{"delete"=>{"summary"=>"Cancel webinar", "description"=>"Cancels a specific webinar. If the webinar is a series or sequence, this call deletes all scheduled sessions. To send cancellation emails to registrants set sendCancellationEmails=true in the request. When the cancellation emails are sent, the default generated message is used in the cancellation email body.", "operationId"=>"cancelWebinar", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkey-delete", "parameters"=>[{"in"=>"query", "name"=>"sendCancellationEmails", "description"=>"Indicates whether cancellation notice emails should be sent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey"]}, "get"=>{"summary"=>"Get webinar", "description"=>"Retrieve information on a specific webinar. If the type of the webinar is 'sequence', a sequence of future times will be provided. Webinars of type 'series' are treated the same as normal webinars - each session in the webinar series has a different webinarKey. If an organizer cancels a webinar, then a request to get that webinar would return a '404 Not Found' error.", "operationId"=>"getWebinar", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey"]}, "put"=>{"summary"=>"Update webinar", "description"=>"Updates a webinar. The call requires at least one of the parameters in the request body. The request completely replaces the existing session, series, or sequence and so must include the full definition of each as for the Create call. Set notifyParticipants=true to send update emails to registrants.", "operationId"=>"updateWebinar", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkey-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The webinar details", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"notifyParticipants", "description"=>"Defines whether to send notifications to participants"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/attendees"=>{"get"=>{"summary"=>"Get attendees for all webinar sessions", "description"=>"Returns all attendees for all sessions of the specified webinar.", "operationId"=>"getAttendeesForAllWebinarSessions", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeyattendees-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Attendees"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/audio"=>{"get"=>{"summary"=>"Get audio information", "description"=>"Retrieves the audio/conferencing information for a specific webinar.", "operationId"=>"getAudioInformation", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeyaudio-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Audio"]}, "post"=>{"summary"=>"Update audio information", "description"=>"Updates the audio/conferencing settings for a specific webinar", "operationId"=>"updateAudioInformation", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeyaudio-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The audio/conferencing settings", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"notifyParticipants", "description"=>"Defines whether to send notifications to participants"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Audio"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/coorganizers"=>{"get"=>{"summary"=>"Get co-organizers", "description"=>"Returns the co-organizers for the specified webinar. The original organizer who created the webinar is filtered out of the list. If the webinar has no co-organizers, an empty array is returned. Co-organizers that do not have a GoToWebinar account are returned as external co-organizers. For those organizers no surname is returned.", "operationId"=>"getCoorganizers", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeycoorganizers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Coorganizers"]}, "post"=>{"summary"=>"Create co-organizers", "description"=>"Creates co-organizers for the specified webinar. For co-organizers that have a GoToWebinar account you have to set the parameter 'external' to 'false'. In this case you have to pass the parameter 'organizerKey' only. For co-organizers that have no GoToWebinar account you have to set the parameter 'external' to 'true'. In this case you have to pass the parameters 'givenName' and 'email'. Since there is no parameter for 'surname' you should pass first and last name to the parameter 'givenName'.", "operationId"=>"createCoorganizers", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeycoorganizers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The co-organizer details", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Coorganizers"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/coorganizers/{coorganizerKey}"=>{"delete"=>{"summary"=>"Delete co-organizer", "description"=>"Deletes an internal co-organizer specified by the coorganizerKey (memberKey).", "operationId"=>"deleteCoorganizer", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeycoorganizerscoorganizerkey-delete", "parameters"=>[{"in"=>"query", "name"=>"external", "description"=>"By default only internal co-organizers (with a GoToWebinar account) can be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Coorganizers", "CoorganizerKey"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/coorganizers/{coorganizerKey}/resendInvitation"=>{"post"=>{"summary"=>"Resend invitation", "description"=>"Resends an invitation email to the specified co-organizer", "operationId"=>"resendCoorganizerInvitation", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeycoorganizerscoorganizerkeyresendinvitation-post", "parameters"=>[{"in"=>"query", "name"=>"external", "description"=>"By default only internal co-organizers (with a GoToWebinar account) will retrieve the resent invitation email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Coorganizers", "CoorganizerKey", "ResendInvitation"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/meetingtimes"=>{"get"=>{"summary"=>"Get webinar meeting times", "description"=>"Retrieves the meeting times for a webinar.", "operationId"=>"getWebinarMeetingTimes", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeymeetingtimes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Meetingtimes"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/panelists"=>{"get"=>{"summary"=>"Get webinar panelists", "description"=>"Retrieves all the panelists for a specific webinar.", "operationId"=>"getPanelists", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeypanelists-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Panelists"]}, "post"=>{"summary"=>"Create Panelists", "description"=>"Create panelists for a specified webinar", "operationId"=>"createPanelists", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeypanelists-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Array of panelists", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Panelists"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/panelists/{panelistKey}"=>{"delete"=>{"summary"=>"Delete webinar panelist", "description"=>"Removes a webinar panelist.", "operationId"=>"deleteWebinarPanelist", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeypanelistspanelistkey-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Panelists", "PanelistKey"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/panelists/{panelistKey}/resendInvitation"=>{"post"=>{"summary"=>"Resend panelist invitation", "description"=>"Resend the panelist invitation email.", "operationId"=>"resendPanelistInvitation", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeypanelistspanelistkeyresendinvitation-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Panelists", "PanelistKey", "ResendInvitation"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/performance"=>{"get"=>{"summary"=>"Get performance for all webinar sessions", "description"=>"Gets performance details for all sessions of a specific webinar.", "operationId"=>"getPerformanceForAllWebinarSessions", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeyperformance-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Performance"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/registrants"=>{"get"=>{"summary"=>"Get registrants", "description"=>"Retrieve registration details for all registrants of a specific webinar. Registrant details will not include all fields captured when creating the registrant. To see all data, use the API call 'Get Registrant'. Registrants can have one of the following states;WAITING - registrant registered and is awaiting approval (where organizer has required approval), APPROVED - registrant registered and is approved, and DENIED - registrant registered and was denied.", "operationId"=>"getAllRegistrantsForWebinar", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeyregistrants-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Registrants"]}, "post"=>{"summary"=>"Create registrant", "description"=>"Register an attendee for a scheduled webinar. The response contains the registrantKey and join URL for the registrant. An email will be sent to the registrant unless the organizer turns off the confirmation email setting from the GoToWebinar website. Please note that you must provide all required fields including custom fields defined during the webinar creation. Use the API call 'Get registration fields' to get a list of all fields, if they are required, and their possible values. At this time there are two versions of the 'Create Registrant' call. The first version only accepts firstName, lastName, and email and ignores all other fields. If you have custom fields or want to capture additional information this version won't work for you. The second version allows you to pass all required and optional fields, including custom fields defined when creating the webinar. To use the second version you must pass the header value 'Accept: application/vnd.citrix.g2wapi-v1.1+json' instead of 'Accept: application/json'. Leaving this header out results in the first version of the API call.", "operationId"=>"createRegistrant", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeyregistrants-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Set to application/vnd"}, {"in"=>"body", "name"=>"body", "description"=>"The registrant details", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"resendConfirmation", "description"=>"Indicates whether the confirmation email should be resent when a registrant is re-registered"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Registrants"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/registrants/fields"=>{"get"=>{"summary"=>"Get registration fields", "description"=>"Retrieve required, optional registration, and custom questions for a specified webinar.", "operationId"=>"getRegistrationFields", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeyregistrantsfields-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Registrants", "Fields"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/registrants/{registrantKey}"=>{"delete"=>{"summary"=>"Delete registrant", "description"=>"Removes a webinar registrant from current registrations for the specified webinar. The webinar must be a scheduled, future webinar.", "operationId"=>"deleteRegistrant", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeyregistrantsregistrantkey-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Registrants", "RegistrantKey"]}, "get"=>{"summary"=>"Get registrant", "description"=>"Retrieve registration details for a specific registrant.", "operationId"=>"getRegistrant", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeyregistrantsregistrantkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Registrants", "RegistrantKey"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/sessions"=>{"get"=>{"summary"=>"Get webinar sessions", "description"=>"Retrieves details for all past sessions of a specific webinar.", "operationId"=>"getAllSessions", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeysessions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Sessions"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}"=>{"get"=>{"summary"=>"Get webinar session", "description"=>"Retrieves attendance details for a specific webinar session that has ended. If attendees attended the session ('registrantsAttended'), specific attendance details, such as attendenceTime for a registrant, will also be retrieved. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.", "operationId"=>"getWebinarSession", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeysessionssessionkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Sessions", "SessionKey"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees"=>{"get"=>{"summary"=>"Get session attendees", "description"=>"Retrieve details for all attendees of a specific webinar session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.", "operationId"=>"getAttendees", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeysessionssessionkeyattendees-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Sessions", "SessionKey", "Attendees"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees/{registrantKey}"=>{"get"=>{"summary"=>"Get attendee", "description"=>"Retrieve registration details for a particular attendee of a specific webinar session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.", "operationId"=>"getAttendee", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeysessionssessionkeyattendeesregistrantkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Sessions", "SessionKey", "Attendees", "RegistrantKey"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees/{registrantKey}/polls"=>{"get"=>{"summary"=>"Get attendee poll answers", "description"=>"Get poll answers from a particular attendee of a specific webinar session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.", "operationId"=>"getAttendeePollAnswers", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeysessionssessionkeyattendeesregistrantkeypolls-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Sessions", "SessionKey", "Attendees", "RegistrantKey", "Polls"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees/{registrantKey}/questions"=>{"get"=>{"summary"=>"Get attendee questions", "description"=>"Get questions asked by an attendee during a webinar session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.", "operationId"=>"getAttendeeQuestions", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeysessionssessionkeyattendeesregistrantkeyquestions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Sessions", "SessionKey", "Attendees", "RegistrantKey", "Questions"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees/{registrantKey}/surveys"=>{"get"=>{"summary"=>"Get attendee survey answers", "description"=>"Retrieve survey answers from a particular attendee during a webinar session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.", "operationId"=>"getAttendeeSurveyAnswers", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeysessionssessionkeyattendeesregistrantkeysurveys-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Sessions", "SessionKey", "Attendees", "RegistrantKey", "Surveys"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/performance"=>{"get"=>{"summary"=>"Get session performance", "description"=>"Get performance details for a session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.", "operationId"=>"getPerformance", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeysessionssessionkeyperformance-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Sessions", "SessionKey", "Performance"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/polls"=>{"get"=>{"summary"=>"Get session polls", "description"=>"Retrieve all collated attendee questions and answers for polls from a specific webinar session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.", "operationId"=>"getPolls", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeysessionssessionkeypolls-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Sessions", "SessionKey", "Polls"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/questions"=>{"get"=>{"summary"=>"Get session questions", "description"=>"Retrieve questions and answers for a past webinar session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.", "operationId"=>"getQuestions", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeysessionssessionkeyquestions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Sessions", "SessionKey", "Questions"]}}, "/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/surveys"=>{"get"=>{"summary"=>"Get session surveys", "description"=>"Retrieve surveys for a past webinar session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.", "operationId"=>"getSurveys", "x-api-path-slug"=>"organizersorganizerkeywebinarswebinarkeysessionssessionkeysurveys-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Webinars", "WebinarKey", "Sessions", "SessionKey", "Surveys"]}}}}, "go-to-meeting-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"GoToMeeting", "x-complete"=>1, "info"=>{"title"=>"Go To Meeting", "description"=>"brthe-gotomeeting-api-provides-seamless-integration-of-gotomeeting-provisioning-and-meeting-management-into-your-existing-infrastructure-or-third-party-applications-brbrfor-customers-the-ability-to-add-suspend-or-delete-an-organizer-in-your-gotomeeting-corporate-account-from-within-your-primary-management-systems-simplifies-and-streamlines-the-entire-process-of-account-management--the-ability-to-monitor-meeting-schedules-history-and-active-meeting-status-allows-managers-to-leverage-gotomeeting-activities-through-your-primary-applications-brbrfor-third-parties-the-ability-to-create-update-or-delete-a-meeting-from-within-your-application-makes-realtime-collaboration-possible-for-your-customers--the-ability-to-update-meeting-schedules-view-history-and-scheduled-meetings-and-view-attendees-from-past-meetings-allows-you-to-enhance-your-users-experience-and-the-value-of-your-applications-", "termsOfService"=>"https://developer.citrixonline.com/terms-use", "contact"=>{"name"=>"Developer Support", "url"=>"https://developer.citrixonline.com", "email"=>"developer-support@citrixonline.com"}, "version"=>"1.0.0"}, "host"=>"api.citrixonline.com", "basePath"=>"/G2M/rest", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/groups"=>{"get"=>{"summary"=>"Get groups", "description"=>"List all groups for an account. This API call is only available to users with the admin role.", "operationId"=>"list-all-groups-for-an-account--this-api-call-is-only-available-to-users-with-the-admin-role-", "x-api-path-slug"=>"groups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/groups/{groupKey}/attendees"=>{"get"=>{"summary"=>"Get attendees by group", "description"=>"Returns all attendees for all meetings within specified date range held by organizers within the specified group. This API call is only available to users with the admin role. This API call can be used only for groups with maximum 50 organizers.", "operationId"=>"returns-all-attendees-for-all-meetings-within-specified-date-range-held-by-organizers-within-the-spe", "x-api-path-slug"=>"groupsgroupkeyattendees-get", "parameters"=>[{"in"=>"query", "name"=>"endDate", "description"=>"End of date range, in ISO8601 UTC format, e"}, {"in"=>"query", "name"=>"startDate", "description"=>"Start of date range, in ISO8601 UTC format, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "GroupKey", "Attendees"]}}, "/groups/{groupKey}/historicalMeetings"=>{"get"=>{"summary"=>"Get historical meetings by group", "description"=>"Get historical meetings for the specified group that started within the specified date/time range. This API call is only available to users with the admin role. This API call is restricted to groups with a maximum of 50 organizers. Remark: Meetings which are still ongoing at the time of the request are NOT contained in the result array.", "operationId"=>"get-historical-meetings-for-the-specified-group-that-started-within-the-specified-datetime-range--th", "x-api-path-slug"=>"groupsgroupkeyhistoricalmeetings-get", "parameters"=>[{"in"=>"query", "name"=>"endDate", "description"=>"Required end of date range, in ISO8601 UTC format, e"}, {"in"=>"query", "name"=>"startDate", "description"=>"Required start of date range, in ISO8601 UTC format, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "GroupKey", "HistoricalMeetings"]}}, "/groups/{groupKey}/meetings"=>{"get"=>{"summary"=>"DEPRECATED: Get historical meetings by group", "description"=>"DEPRECATED: Please use the new API calls 'Get historical meetings by group' and 'Get upcoming meetings by group'. Get meetings for a specified group. Additional filters can be used to view only meetings within a specified date range. This API call is only available to users with the admin role.", "operationId"=>"deprecated-please-use-the-new-api-calls-get-historical-meetings-by-group-and-get-upcoming-meetings-b", "x-api-path-slug"=>"groupsgroupkeymeetings-get", "parameters"=>[{"in"=>"query", "name"=>"endDate", "description"=>"If history=true, required end of date range, in ISO8601 UTC format, e"}, {"in"=>"query", "name"=>"history", "description"=>"When true, returns all past meetings within date range"}, {"in"=>"query", "name"=>"startDate", "description"=>"If history=true, required start of date range, in ISO8601 UTC format, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "GroupKey", "Meetings"]}}, "/groups/{groupKey}/organizers"=>{"get"=>{"summary"=>"Get organizers by group", "description"=>"Returns all the organizers within a specific group. This API call is only available to users with the admin role.", "operationId"=>"returns-all-the-organizers-within-a-specific-group--this-api-call-is-only-available-to-users-with-th", "x-api-path-slug"=>"groupsgroupkeyorganizers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "GroupKey", "Organizers"]}, "post"=>{"summary"=>"Create organizer in group", "description"=>"Creates a new organizer and sends an email to the email address defined in request. This API call is only available to users with the admin role. You may also pass 'G2W' or 'G2T' or 'OPENVOICE' as productType variables, creating organizers for those products. A G2W or G2T organizer will also have access to G2M.", "operationId"=>"creates-a-new-organizer-and-sends-an-email-to-the-email-address-defined-in-request--this-api-call-is", "x-api-path-slug"=>"groupsgroupkeyorganizers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The details of the organizer to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "GroupKey", "Organizers"]}}, "/groups/{groupKey}/upcomingMeetings"=>{"get"=>{"summary"=>"Get upcoming meetings by group", "description"=>"Get upcoming meetings for a specified group. This API call is only available to users with the admin role. This API call can be used only for groups with maximum 50 organizers.", "operationId"=>"get-upcoming-meetings-for-a-specified-group--this-api-call-is-only-available-to-users-with-the-admin", "x-api-path-slug"=>"groupsgroupkeyupcomingmeetings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "GroupKey", "UpcomingMeetings"]}}, "/historicalMeetings"=>{"get"=>{"summary"=>"Get historical meetings", "description"=>"Get historical meetings for the currently authenticated organizer that started within the specified date/time range. Remark: Meetings which are still ongoing at the time of the request are NOT contained in the result array.", "operationId"=>"get-historical-meetings-for-the-currently-authenticated-organizer-that-started-within-the-specified-", "x-api-path-slug"=>"historicalmeetings-get", "parameters"=>[{"in"=>"query", "name"=>"endDate", "description"=>"Required end of date range, in ISO8601 UTC format, e"}, {"in"=>"query", "name"=>"startDate", "description"=>"Required start of date range, in ISO8601 UTC format, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["HistoricalMeetings"]}}, "/meetings"=>{"get"=>{"summary"=>"DEPRECATED: Get historical meetings", "description"=>"DEPRECATED: Please use the new API calls 'Get historical meetings' and 'Get upcoming meetings'. Gets historical meetings for the current authenticated organizer. Requires date range for filtering results to only meetings within specified dates. History searches will contain the parameter 'meetingInstanceKey' which is used in conjunction with the call 'Get Attendees by Meeting' to get attendee information for a past meeting.", "operationId"=>"deprecated-please-use-the-new-api-calls-get-historical-meetings-and-get-upcoming-meetings---gets-his", "x-api-path-slug"=>"meetings-get", "parameters"=>[{"in"=>"query", "name"=>"endDate", "description"=>"If history=true, required end of date range, in ISO8601 UTC format, e"}, {"in"=>"query", "name"=>"history", "description"=>"When true, returns all past meetings within date range"}, {"in"=>"query", "name"=>"startDate", "description"=>"If history=true, required start of date range, in ISO8601 UTC format, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meetings"]}, "post"=>{"summary"=>"Create meeting", "description"=>"Create a new meeting based on the parameters specified.", "operationId"=>"create-a-new-meeting-based-on-the-parameters-specified-", "x-api-path-slug"=>"meetings-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The meeting details", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meetings"]}}, "/meetings/{meetingId}"=>{"delete"=>{"summary"=>"Delete meeting", "description"=>"Deletes the meeting identified by the meetingId.", "operationId"=>"deletes-the-meeting-identified-by-the-meetingid-", "x-api-path-slug"=>"meetingsmeetingid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meetings", "MeetingId"]}, "get"=>{"summary"=>"Get meeting", "description"=>"Returns the meeting details for the specified meeting.", "operationId"=>"returns-the-meeting-details-for-the-specified-meeting-", "x-api-path-slug"=>"meetingsmeetingid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meetings", "MeetingId"]}, "put"=>{"summary"=>"Update meeting", "description"=>"Updates an existing meeting specified by meetingId.", "operationId"=>"updates-an-existing-meeting-specified-by-meetingid-", "x-api-path-slug"=>"meetingsmeetingid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The meeting details", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meetings", "MeetingId"]}}, "/meetings/{meetingId}/attendees"=>{"get"=>{"summary"=>"Get attendees by meeting", "description"=>"List all attendees for specified meetingId of historical meeting. The historical meetings can be fetched using 'Get historical meetings', 'Get historical meetings by organizer', and 'Get historical meetings by group'. For users with the admin role this call returns attendees for any meeting. For any other user the call will return attendees for meetings on which the user is a valid organizer.", "operationId"=>"list-all-attendees-for-specified-meetingid-of-historical-meeting--the-historical-meetings-can-be-fet", "x-api-path-slug"=>"meetingsmeetingidattendees-get", "parameters"=>[{"in"=>"path", "name"=>"meetingId", "description"=>"The meeting ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meetings", "MeetingId", "Attendees"]}}, "/meetings/{meetingId}/start"=>{"get"=>{"summary"=>"Start meeting", "description"=>"Returns a host URL that can be used to start a meeting. When this URL is opened in a web browser, the GoToMeeting client will be downloaded and launched and the meeting will start. The end user is not required to login to a client.", "operationId"=>"returns-a-host-url-that-can-be-used-to-start-a-meeting--when-this-url-is-opened-in-a-web-browser-the", "x-api-path-slug"=>"meetingsmeetingidstart-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meetings", "MeetingId", "Start"]}}, "/organizers"=>{"delete"=>{"summary"=>"Delete organizer by email", "description"=>"Deletes the individual organizer specified by the email address. This API call is only available to users with the admin role.", "operationId"=>"deletes-the-individual-organizer-specified-by-the-email-address--this-api-call-is-only-available-to-", "x-api-path-slug"=>"organizers-delete", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"The email address of the organizer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers"]}, "get"=>{"summary"=>"Get organizer by email / Get all organizers", "description"=>"Gets the individual organizer specified by the organizer's email address. If an email address is not specified, all organizers are returned. This API call is only available to users with the admin role.", "operationId"=>"gets-the-individual-organizer-specified-by-the-organizers-email-address--if-an-email-address-is-not-", "x-api-path-slug"=>"organizers-get", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"The email address of the organizer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers"]}, "post"=>{"summary"=>"Create organizer", "description"=>"Creates a new organizer and sends an email to the email address defined in the request. This API call is only available to users with the admin role. You may also pass 'G2W' or 'G2T' or 'OPENVOICE' as productType variables, creating organizers for those products. A G2W or G2T organizer will also have access to G2M.", "operationId"=>"creates-a-new-organizer-and-sends-an-email-to-the-email-address-defined-in-the-request--this-api-cal", "x-api-path-slug"=>"organizers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The details of the organizer to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers"]}}, "/organizers/{organizerKey}"=>{"delete"=>{"summary"=>"Delete organizer", "description"=>"Deletes the individual organizer specified by the organizer key. This API call is only available to users with the admin role.", "operationId"=>"deletes-the-individual-organizer-specified-by-the-organizer-key--this-api-call-is-only-available-to-", "x-api-path-slug"=>"organizersorganizerkey-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey"]}, "get"=>{"summary"=>"Get organizer", "description"=>"Returns the individual organizer specified by the key. This API call is only available to users with the admin role. Non-admin users can only make this call for their own organizerKey.", "operationId"=>"returns-the-individual-organizer-specified-by-the-key--this-api-call-is-only-available-to-users-with", "x-api-path-slug"=>"organizersorganizerkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey"]}, "put"=>{"summary"=>"Update organizer", "description"=>"Updates the products of the specified organizer. To add a product (G2M, G2W, G2T, OPENVOICE) for the organizer, the call must be sent once for each product you want to add. To remove all products for the organizer, set status to 'suspended'. The call is limited to users with the admin role.", "operationId"=>"updates-the-products-of-the-specified-organizer--to-add-a-product-g2m-g2w-g2t-openvoice-for-the-orga", "x-api-path-slug"=>"organizersorganizerkey-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The organizers status", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey"]}}, "/organizers/{organizerKey}/attendees"=>{"get"=>{"summary"=>"Get attendees by organizer", "description"=>"Lists all attendees for all meetings within a specified date range for a specified organizer. This API call is only available to users with the admin role.", "operationId"=>"lists-all-attendees-for-all-meetings-within-a-specified-date-range-for-a-specified-organizer--this-a", "x-api-path-slug"=>"organizersorganizerkeyattendees-get", "parameters"=>[{"in"=>"query", "name"=>"endDate", "description"=>"A required end of date range in ISO8601 UTC format, e"}, {"in"=>"query", "name"=>"startDate", "description"=>"A required start of date range in ISO8601 UTC format, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Attendees"]}}, "/organizers/{organizerKey}/historicalMeetings"=>{"get"=>{"summary"=>"Get historical meetings by organizer", "description"=>"Get historical meetings for the specified organizer that started within the specified date/time range. Remark: Meetings which are still ongoing at the time of the request are NOT contained in the result array.", "operationId"=>"get-historical-meetings-for-the-specified-organizer-that-started-within-the-specified-datetime-range", "x-api-path-slug"=>"organizersorganizerkeyhistoricalmeetings-get", "parameters"=>[{"in"=>"query", "name"=>"endDate", "description"=>"Required end of date range, in ISO8601 UTC format, e"}, {"in"=>"query", "name"=>"startDate", "description"=>"Required start of date range, in ISO8601 UTC format, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "HistoricalMeetings"]}}, "/organizers/{organizerKey}/meetings"=>{"get"=>{"summary"=>"DEPRECATED: Get meetings by organizer", "description"=>"DEPRECATED: Please use the new API calls 'Get historical meetings by organizer' and 'Get upcoming meetings by organizer'. Gets future (scheduled) or past (history) meetings for a specified organizer. Include 'history=true' and the past start and end dates in the URL to retrieve past meetings. Enter 'scheduled=true' (without dates) to get scheduled meetings.", "operationId"=>"deprecated-please-use-the-new-api-calls-get-historical-meetings-by-organizer-and-get-upcoming-meetin", "x-api-path-slug"=>"organizersorganizerkeymeetings-get", "parameters"=>[{"in"=>"query", "name"=>"endDate", "description"=>"If history is true, required end of date range, in ISO8601 UTC format, e"}, {"in"=>"query", "name"=>"history", "description"=>"When true, returns all past meetings within date range"}, {"in"=>"query", "name"=>"scheduled", "description"=>"When true, returns all future meetings"}, {"in"=>"query", "name"=>"startDate", "description"=>"If history is true, required start of date range, in ISO8601 UTC format, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Meetings"]}}, "/organizers/{organizerKey}/upcomingMeetings"=>{"get"=>{"summary"=>"Get upcoming meetings by organizer", "description"=>"Get upcoming meetings for a specified organizer. This API call is only available to users with the admin role.", "operationId"=>"get-upcoming-meetings-for-a-specified-organizer--this-api-call-is-only-available-to-users-with-the-a", "x-api-path-slug"=>"organizersorganizerkeyupcomingmeetings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "UpcomingMeetings"]}}, "/upcomingMeetings"=>{"get"=>{"summary"=>"Get upcoming meetings", "description"=>"Gets upcoming meetings for the current authenticated organizer.", "operationId"=>"gets-upcoming-meetings-for-the-current-authenticated-organizer-", "x-api-path-slug"=>"upcomingmeetings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["UpcomingMeetings"]}}}}, "go-to-training-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"GoToMeeting", "x-complete"=>1, "info"=>{"title"=>"Go To Training", "description"=>"the-gototraining-api-enables-developers-to-use-the-stable-and-robust-gototraining-functionality-as-the-basis-for-online-trainings-in-a-proprietary-learning-management-system--the-gototraining-apis-provide-the-ability-to-access-the-scheduling-registration-management-and-reporting-functions-of-gototraining-from-external-applications--with-the-ability-to-tightly-integrate-gototraining-into-your-learning-infrastructure-you-can-offer-your-learners-a-seamless-user-experience-and-provide-them-with-a-market-leading-virtual-classroom-environment-", "termsOfService"=>"https://developer.citrixonline.com/terms-use", "contact"=>{"name"=>"Developer Support", "url"=>"https://developer.citrixonline.com", "email"=>"developer-support@citrixonline.com"}, "version"=>"1.0.0"}, "host"=>"api.citrixonline.com", "basePath"=>"/G2T/rest", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/accounts/{accountKey}/organizers"=>{"get"=>{"summary"=>"DEPRECATED: Get Organizers", "description"=>"DEPRECATED: Please use the Admin API call 'Get all users' instead. For details see https://developer.citrixonline.com/get-all-users.", "operationId"=>"getAllOrganisers", "x-api-path-slug"=>"accountsaccountkeyorganizers-get", "parameters"=>[{"in"=>"path", "name"=>"accountKey", "description"=>"The key of the multi-user account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "AccountKey", "Organizers"]}}, "/organizers/{organizerKey}/trainings"=>{"get"=>{"summary"=>"Get Trainings", "description"=>"This call retrieves information on all scheduled trainings for a given organizer. The trainings are returned in the order in which they were created. Completed trainings are not included; ongoing trainings with past sessions are included along with the past sessions. If the organizer does not have any scheduled trainings, the response will be empty.", "operationId"=>"getAllTrainings", "x-api-path-slug"=>"organizersorganizerkeytrainings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Trainings"]}, "post"=>{"summary"=>"Create Training", "description"=>"Schedules a training of one or more sessions. The call requires a training's name, at least one start and end time, and optionally may include additional sessions, a description, additional organizers (presenters), and registration settings. You can only add organizers to a training if you have a multi-user account. Once a training has been created with this method, you can accept registrations to the training. Registration is for the entire training - all sessions. (The GoToTraining admin site enables you to create trainings that allow participants to register for individual sessions as well as automatically create weekly or monthly events.) Registration settings controls whether you allow web registration for this training, and whether a confirmation email is sent to the registrant following registration. Disabling the confirmation email is an API-only setting. If the user registers through the GoToTraining website, a confirmation email is sent. If the user is manually approved by the training administrator through the GoToTraining web site, the confirmation email is sent. It is recommended that you disable web registration if you disable confirmation emails. The response contains a trainingKey for the scheduled training.", "operationId"=>"scheduleTraining", "x-api-path-slug"=>"organizersorganizerkeytrainings-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The details of the training to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Trainings"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}"=>{"delete"=>{"summary"=>"Delete Training", "description"=>"Deletes a scheduled or completed training. For scheduled trainings, it deletes all scheduled sessions of the training. For completed trainings, the sessions remain in the database. No email is sent to organizers or registrants, but when participants attempt to start or join the training, they are directed to a page that states: Training Not Found: The training you are trying to join is no longer available.", "operationId"=>"cancelTraining", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkey-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Trainings", "TrainingKey"]}, "get"=>{"summary"=>"Get Training", "description"=>"Uses the organizer key and training key to retrieve information on a scheduled training.", "operationId"=>"getTraining", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Trainings", "TrainingKey"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}/manageUrl"=>{"get"=>{"summary"=>"Get Management URL for Training", "description"=>"A request for a direct URL to the admin portal for a specific training. The request identifies the organizer and the training; the response provides a link the organizer can use to manage or launch the training in the admin portal. The training organizer will be required to log in. You can schedule and manage the training (e.g., add tests, polls and training materials) from the URL provided in the response.", "operationId"=>"getManageTrainingURL", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeymanageurl-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Trainings", "TrainingKey", "ManageUrl"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}/nameDescription"=>{"put"=>{"summary"=>"Update Training Name and Description", "description"=>"Request to update a scheduled training name and description.", "operationId"=>"updateTrainingNameDescription", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeynamedescription-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The new name and description for the training", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Trainings", "TrainingKey", "NameDescription"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}/organizers"=>{"get"=>{"summary"=>"Get Training Organizers", "description"=>"Retrieves organizer details for a specific training. This is only applicable to multi-user accounts with sharing enabled (co-organizers).", "operationId"=>"getOrganisersForTraining", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeyorganizers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Trainings", "TrainingKey", "Organizers"]}, "put"=>{"summary"=>"Update Training Organizers", "description"=>"Replaces the co-organizers for a specific training. The scheduling organizer cannot be unassigned. Organizers will be notified via email if the notifyOrganizers parameter is set to true. Replaced organizers are not notified. This method is only applicable to multi-user accounts with sharing enabled (co-organizers).", "operationId"=>"updateOrganisersForTraining", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeyorganizers-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The details of the training to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Trainings", "TrainingKey", "Organizers"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}/registrants"=>{"get"=>{"summary"=>"Get Training Registrants", "description"=>"Retrieves details on all registrants for a specific training. Registrants can be: WAITING - registrant registered and is awaiting approval (where organizer has required approval) APPROVED - registrant registered and is approved DENIED - registrant registered and was not approved. IMPORTANT: The registrant data caches are typically updated immediately and the data will be returned in the response. However, the update can take as long as two hours.", "operationId"=>"getRegistrants", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeyregistrants-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Trainings", "TrainingKey", "Registrants"]}, "post"=>{"summary"=>"Register for Training", "description"=>"Registers one person, identified by a unique email address, for a training. Approval is automatic unless payment or approval is required. The response contains the Confirmation page URL and Join URL for the registrant. NOTE: If some registrants do not receive a confirmation email, the emails could be getting blocked by their email server due to spam filtering or a grey-listing setting.", "operationId"=>"registerForTraining", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeyregistrants-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The details of the registrant to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Trainings", "TrainingKey", "Registrants"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}/registrants/{registrantKey}"=>{"delete"=>{"summary"=>"Cancel Registration", "description"=>"This call cancels a registration in a scheduled training for a specific registrant. If the registrant has paid for the training, a cancellation cannot be completed with this method; it must be completed on the external admin site. No notification is sent to the registrant or the organizer by default. The registrant can re-register if needed.", "operationId"=>"cancelRegistration", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeyregistrantsregistrantkey-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Trainings", "TrainingKey", "Registrants", "RegistrantKey"]}, "get"=>{"summary"=>"Get Registrant", "description"=>"Retrieves details for specific registrant in a specific training. Registrants can be: WAITING - registrant registered and is awaiting approval (where organizer has required approval) APPROVED - registrant registered and is approved DENIED - registrant registered and was not approved. IMPORTANT: The registrant data caches are typically updated immediately and the data will be returned in the response. However, the update can take as long as two hours.", "operationId"=>"getRegistrant", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeyregistrantsregistrantkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Trainings", "TrainingKey", "Registrants", "RegistrantKey"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}/registrationSettings"=>{"put"=>{"summary"=>"Update Training Registration Settings", "description"=>"An API request to automatically enable or disable web registrations and confirmation emails to registrants.", "operationId"=>"updateRegistrationSettingsForTraining", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeyregistrationsettings-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The new registration settings for the training", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Trainings", "TrainingKey", "RegistrationSettings"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}/startUrl"=>{"get"=>{"summary"=>"Get Start Url", "description"=>"Returns a URL that can be used to start a training. When this URL is opened in a web browser, the GoToTraining client will be downloaded and launched and the training will start after the organizer logs in with its credentials.", "operationId"=>"getStartUrl", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeystarturl-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Trainings", "TrainingKey", "StartUrl"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}/times"=>{"put"=>{"summary"=>"Update Training Times", "description"=>"A request to update a scheduled training's start and end times. If the request contains 'notifyTrainers = true' and 'notifyRegistrants = true', both organizers and registrants are notified. The response provides the number of notified trainers and registrants.", "operationId"=>"updateTrainingTimes", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeytimes-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The new start and end times for the scheduled training", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "OrganizerKey", "Trainings", "TrainingKey", "Times"]}}, "/reports/organizers/{organizerKey}/sessions"=>{"post"=>{"summary"=>"Get Sessions by Date Range", "description"=>"This call returns all session details over a given date range for a given organizer. A session is a completed training event.", "operationId"=>"getSessionDetailsForDateRange", "x-api-path-slug"=>"reportsorganizersorganizerkeysessions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The start and end times for the time range over which to retrieve training sessions", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "Organizers", "OrganizerKey", "Sessions"]}}, "/reports/organizers/{organizerKey}/sessions/{sessionKey}/attendees"=>{"get"=>{"summary"=>"Get Attendance Details", "description"=>"This call retrieves a list of registrants from a specific completed training session. The response includes the registrants' email addresses, and if they attended, it includes the duration of each period of their attendance in minutes, and the times at which they joined and left. If a registrant does not attend, they appear at the bottom of the listing with timeInSession = 0.", "operationId"=>"getAttendanceDetails", "x-api-path-slug"=>"reportsorganizersorganizerkeysessionssessionkeyattendees-get", "parameters"=>[{"in"=>"path", "name"=>"sessionKey", "description"=>"The key of the training session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "Organizers", "OrganizerKey", "Sessions", "SessionKey", "Attendees"]}}, "/reports/organizers/{organizerKey}/trainings/{trainingKey}"=>{"get"=>{"summary"=>"Get Sessions By Training", "description"=>"This call returns session details for a given training. A session is a completed training event. Each training may contain one or more sessions.", "operationId"=>"getSessionDetailsForTraining", "x-api-path-slug"=>"reportsorganizersorganizerkeytrainingstrainingkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "Organizers", "OrganizerKey", "Trainings", "TrainingKey"]}}, "/trainings/{trainingKey}/recordings"=>{"get"=>{"summary"=>"Get Online Recordings for Training", "description"=>"This call retrieves information on all online recordings for a given training. If there are none, it returns an empty list.", "operationId"=>"getRecordingsForTraining", "x-api-path-slug"=>"trainingstrainingkeyrecordings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trainings", "TrainingKey", "Recordings"]}}, "/trainings/{trainingKey}/recordings/{recordingId}"=>{"get"=>{"summary"=>"Get Download for Online Recordings", "description"=>"This call provides the download for the given recording by returning a 302 redirect to the original file.", "operationId"=>"getRecordingDownloadById", "x-api-path-slug"=>"trainingstrainingkeyrecordingsrecordingid-get", "parameters"=>[{"in"=>"path", "name"=>"recordingId", "description"=>"the unique id of the recording"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trainings", "TrainingKey", "Recordings", "RecordingId"]}}, "/trainings/{trainingKey}/start"=>{"get"=>{"summary"=>"Start Training", "description"=>"Returns a URL that can be used to start a training. When this URL is opened in a web browser, the GoToTraining client will be downloaded and launched and the training will start. A login of the organizer is not required.", "operationId"=>"startTraining", "x-api-path-slug"=>"trainingstrainingkeystart-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trainings", "TrainingKey", "Start"]}}}}, "apis"=>{"name"=>"GoToMeeting", "x-slug"=>"gotomeeting", "description"=>"Citrix enables business mobility through the secure delivery of apps and data to any device on any network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/731-gotomeeting.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"7422", "tags"=>"API Provider,Collaboration,Conferences,Enterprise,Meetings,Meetings,Networks,Office,Profiles,Relative Data,SaaS,Service API,Technology,Video Conferencing,Video Conferencing", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"gotomeeting/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Go To Assist Seeit", "x-api-slug"=>"go-to-assist-seeit", "description"=>"Citrix enables business mobility through the secure delivery of apps and data to any device on any network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/731-gotomeeting.jpg", "humanURL"=>"https://citrixonline.com", "baseURL"=>"https://api.citrixonline.com//seeit/v1", "tags"=>"API Provider,Collaboration,Conferences,Enterprise,Meetings,Meetings,Networks,Office,Profiles,Relative Data,SaaS,Service API,Technology,Video Conferencing,Video Conferencing", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/gotomeeting/sessionsuuid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/gotomeeting/go-to-assist-seeit-openapi.yaml"}]}, {"name"=>"Go To Meeting", "x-api-slug"=>"go-to-meeting", "description"=>"Citrix enables business mobility through the secure delivery of apps and data to any device on any network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/731-gotomeeting.jpg", "humanURL"=>"https://citrixonline.com", "baseURL"=>"https://api.citrixonline.com//G2M/rest", "tags"=>"Sessions,Uuid", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/gotomeeting/go-to-meeting-openapi.yaml"}]}, {"name"=>"Go To Training", "x-api-slug"=>"go-to-training", "description"=>"Citrix enables business mobility through the secure delivery of apps and data to any device on any network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/731-gotomeeting.jpg", "humanURL"=>"https://citrixonline.com", "baseURL"=>"https://api.citrixonline.com//G2T/rest", "tags"=>"UpcomingMeetings", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/gotomeeting/go-to-training-openapi.yaml"}]}, {"name"=>"Go To Webinar", "x-api-slug"=>"go-to-webinar", "description"=>"Citrix enables business mobility through the secure delivery of apps and data to any device on any network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/731-gotomeeting.jpg", "humanURL"=>"https://citrixonline.com", "baseURL"=>"https://api.citrixonline.com//G2W/rest", "tags"=>"Trainings,TrainingKey,Start", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/gotomeeting/organizersorganizerkeywebinarswebinarkeysessionssessionkeysurveys-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/gotomeeting/go-to-webinar-openapi.yaml"}]}, {"name"=>"SCIM", "x-api-slug"=>"scim", "description"=>"Citrix enables business mobility through the secure delivery of apps and data to any device on any network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/731-gotomeeting.jpg", "humanURL"=>"https://citrixonline.com", "baseURL"=>"https://api.citrixonline.com//identity/v1", "tags"=>"Organizers,OrganizerKey,Webinars,WebinarKey,Sessions,SessionKey,Surveys", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/gotomeeting/scim-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.citrixonline.com"}, {"type"=>"x-blog", "url"=>"http://blogs.citrix.com/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/citrix-systems"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/citrix-systems"}, {"type"=>"x-developer", "url"=>"https://developer.citrixonline.com/"}, {"type"=>"x-email", "url"=>"secure@citrix.com"}, {"type"=>"x-email", "url"=>"americasconsulting@citrix.com"}, {"type"=>"x-email", "url"=>"poland@citrix.com"}, {"type"=>"x-email", "url"=>"citrix_ru@citrix.com"}, {"type"=>"x-email", "url"=>"Licensing-emea@eu.citrix.com"}, {"type"=>"x-email", "url"=>"eduardo.fleites@citrix.com"}, {"type"=>"x-email", "url"=>"CitrixReady@citrix.com"}, {"type"=>"x-email", "url"=>"CSP@citrix.com"}, {"type"=>"x-email", "url"=>"partneroperationsEMEA@eu.citrix.com"}, {"type"=>"x-github", "url"=>"https://github.com/citrix"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/gotomeeting"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/citrix"}, {"type"=>"x-website", "url"=>"https://citrixonline.com"}, {"type"=>"x-website", "url"=>"http://citrixonline.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vinli{"vinli-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Vinli", "x-complete"=>1, "info"=>{"title"=>"Vinli", "description"=>"todo-add-description", "version"=>"1.0.0"}, "host"=>"events.vin.li", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/devices/62976d30-b6dc-40f1-8422-ccc367572101/events"=>{"get"=>{"summary"=>"Get All Events for a Device", "description"=>"Get all events for a device.", "operationId"=>"Devices62976d30B6dc40f18422Ccc367572101EventsGet", "x-api-path-slug"=>"devices62976d30b6dc40f18422ccc367572101events-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Eventsa", "Device"]}}, "/devices/cf217c2d-df3c-41f7-b610-8bc3e11b4b79/vehicles"=>{"get"=>{"summary"=>"List a Device's Vehicles", "description"=>"List a device's vehicles.", "operationId"=>"DevicesCf217c2dDf3c41f7B6108bc3e11b4b79VehiclesGet", "x-api-path-slug"=>"devicescf217c2ddf3c41f7b6108bc3e11b4b79vehicles-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Devices", "Vehicles"]}}, "/rules/b7ad3604-c795-46af-9d5f-71be30ed4143"=>{"get"=>{"summary"=>"Get a Specific Rule", "description"=>"Get a specific rule.", "operationId"=>"RulesB7ad3604C79546af9d5f71be30ed4143Get", "x-api-path-slug"=>"rulesb7ad3604c79546af9d5f71be30ed4143-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "Rule"]}}, "/devices/7eac0d62-854f-41c1-a5b2-ba13c460058a/collisions"=>{"get"=>{"summary"=>"Get a List of Collisions for a Device", "description"=>"Get a list of collisions for a device.", "operationId"=>"Devices7eac0d62854f41c1A5b2Ba13c460058aCollisionsGet", "x-api-path-slug"=>"devices7eac0d62854f41c1a5b2ba13c460058acollisions-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Collisionsa", "Device"]}}, "/odometer_triggers/ce8f9a53-906a-4d39-b06a-d466d29a13f1"=>{"get"=>{"summary"=>"Get an Odometer Trigger", "description"=>"Get an odometer trigger.", "operationId"=>"OdometerTriggersCe8f9a53906a4d39B06aD466d29a13f1Get", "x-api-path-slug"=>"odometer-triggersce8f9a53906a4d39b06ad466d29a13f1-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Odometer", "Trigger"]}, "delete"=>{"summary"=>"Delete an Odometer Trigger", "description"=>"Delete an odometer trigger.", "operationId"=>"OdometerTriggersCe8f9a53906a4d39B06aD466d29a13f1Delete", "x-api-path-slug"=>"odometer-triggersce8f9a53906a4d39b06ad466d29a13f1-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Odometer", "Trigger"]}}, "/events/1caa8fff-c9be-4506-bcb8-38371c25aa14"=>{"get"=>{"summary"=>"Get a Specific Event", "description"=>"Get a specific event.", "operationId"=>"Events1caa8fffC9be4506Bcb838371c25aa14Get", "x-api-path-slug"=>"events1caa8fffc9be4506bcb838371c25aa14-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "Event"]}}, "/vehicles/9aa35c64-b046-43cc-9cd8-4c353a6d0b30/odometer_triggers"=>{"get"=>{"summary"=>"List all Odometer Triggers for a Vehicle", "description"=>"List all odometer triggers for a vehicle.", "operationId"=>"Vehicles9aa35c64B04643cc9cd84c353a6d0b30OdometerTriggersGet", "x-api-path-slug"=>"vehicles9aa35c64b04643cc9cd84c353a6d0b30odometer-triggers-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Odometer", "Triggersa", "Vehicle"]}, "post"=>{"summary"=>"Create an Odometer Trigger", "description"=>"Create an odometer trigger.", "operationId"=>"Vehicles9aa35c64B04643cc9cd84c353a6d0b30OdometerTriggersPost", "x-api-path-slug"=>"vehicles9aa35c64b04643cc9cd84c353a6d0b30odometer-triggers-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Odometer", "Trigger"]}}, "/vehicles/aa44769b-3c0a-4662-9bad-25481cf5198f"=>{"get"=>{"summary"=>"Get Vehicle Details", "description"=>"Get vehicle details.", "operationId"=>"VehiclesAa44769b3c0a46629bad25481cf5198fGet", "x-api-path-slug"=>"vehiclesaa44769b3c0a46629bad25481cf5198f-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vehicle", "Details"]}}, "/devices/62976d30-b6dc-40f1-8422-ccc367572101/snapshots"=>{"get"=>{"summary"=>"Telemetry Snapshots", "description"=>"Telemetry snapshots.", "operationId"=>"Devices62976d30B6dc40f18422Ccc367572101SnapshotsGet", "x-api-path-slug"=>"devices62976d30b6dc40f18422ccc367572101snapshots-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"fields"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Telemetry", "Snapshots"]}}, "/devices/62976d30-b6dc-40f1-8422-ccc367572101/subscriptions"=>{"get"=>{"summary"=>"Get all Subscriptions for a Device", "description"=>"Get all subscriptions for a device.", "operationId"=>"Devices62976d30B6dc40f18422Ccc367572101SubscriptionsGet", "x-api-path-slug"=>"devices62976d30b6dc40f18422ccc367572101subscriptions-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptionsa", "Device"]}, "post"=>{"summary"=>"Update a Subscription", "description"=>"Update a subscription.", "operationId"=>"Devices62976d30B6dc40f18422Ccc367572101SubscriptionsPost2", "x-api-path-slug"=>"devices62976d30b6dc40f18422ccc367572101subscriptions-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/vehicles/9aa35c64-b046-43cc-9cd8-4c353a6d0b30/trips"=>{"get"=>{"summary"=>"List All of a Vehicle's Trips", "description"=>"List all of a vehicle's trips.", "operationId"=>"Vehicles9aa35c64B04643cc9cd84c353a6d0b30TripsGet", "x-api-path-slug"=>"vehicles9aa35c64b04643cc9cd84c353a6d0b30trips-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Of", "Vehicles", "Trips"]}}, "/devices"=>{"get"=>{"summary"=>"List all devices", "description"=>"List all devices.", "operationId"=>"DevicesGet", "x-api-path-slug"=>"devices-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Devices"]}, "post"=>{"summary"=>"Register a Device", "description"=>"Register a device.", "operationId"=>"DevicesPost", "x-api-path-slug"=>"devices-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "Device"]}}, "/vehicles/428bc621-16e7-489b-a02a-eb98526d01ef/collisions"=>{"get"=>{"summary"=>"Get a List of Collisions for a Vehicle", "description"=>"Get a list of collisions for a vehicle.", "operationId"=>"Vehicles428bc62116e7489bA02aEb98526d01efCollisionsGet", "x-api-path-slug"=>"vehicles428bc62116e7489ba02aeb98526d01efcollisions-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Collisionsa", "Vehicle"]}}, "/collisions/e43ff87d-bb58-42da-998e-d7f10a3f7a64"=>{"get"=>{"summary"=>"Get a specific Collision", "description"=>"Get a specific collision.", "operationId"=>"CollisionsE43ff87dBb5842da998eD7f10a3f7a64Get", "x-api-path-slug"=>"collisionse43ff87dbb5842da998ed7f10a3f7a64-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "Collision"]}}, "/codes"=>{"get"=>{"summary"=>"Get Info about a DTC", "description"=>"Get info about a dtc.", "operationId"=>"CodesGet", "x-api-path-slug"=>"codes-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Info", "About", "DTC"]}}, "/trips/report_card"=>{"post"=>{"summary"=>"Report Card for a Trip", "description"=>"Report card for a trip.", "operationId"=>"TripsReportCardPost", "x-api-path-slug"=>"tripsreport-card-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report", "Card", "Trip"]}}, "/devices/821374c0-d6d8-11e3-9c1a-0800200c9a66/vehicles/_latest"=>{"get"=>{"summary"=>"Get Device's Latest Vehicle", "description"=>"Get device's latest vehicle.", "operationId"=>"Devices821374c0D6d811e39c1a0800200c9a66VehiclesLatestGet", "x-api-path-slug"=>"devices821374c0d6d811e39c1a0800200c9a66vehicles-latest-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices", "Latest", "Vehicle"]}}, "/messages/ade8e85c-a1aa-4373-8c6e-e37e87762f29"=>{"get"=>{"summary"=>"Get a Specific Telemety Message", "description"=>"Get a specific telemety message.", "operationId"=>"MessagesAde8e85cA1aa43738c6eE37e87762f29Get", "x-api-path-slug"=>"messagesade8e85ca1aa43738c6ee37e87762f29-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "Telemety", "Message"]}}, "/devices/62976d30-b6dc-40f1-8422-ccc367572101/locations"=>{"get"=>{"summary"=>"Locations Request", "description"=>"Locations request.", "operationId"=>"Devices62976d30B6dc40f18422Ccc367572101LocationsGet", "x-api-path-slug"=>"devices62976d30b6dc40f18422ccc367572101locations-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"fields"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Locations", "Request"]}}, "/vehicles/8480c5b7-6f3e-40b3-a78e-3555617d44b0/report_cards"=>{"get"=>{"summary"=>"Report Cards for a Vehicle", "description"=>"Report cards for a vehicle.", "operationId"=>"Vehicles8480c5b76f3e40b3A78e3555617d44b0ReportCardsGet", "x-api-path-slug"=>"vehicles8480c5b76f3e40b3a78e3555617d44b0report-cards-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report", "Cardsa", "Vehicle"]}}, "/dummies/01e668ba-6967-4536-9f72-cc28ff18d7b6/runs"=>{"post"=>{"summary"=>"Create a Dummy Run", "description"=>"Create a dummy run.", "operationId"=>"Dummies01e668ba696745369f72Cc28ff18d7b6RunsPost", "x-api-path-slug"=>"dummies01e668ba696745369f72cc28ff18d7b6runs-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dummy", "Run"]}}, "/dummies/01e668ba-6967-4536-9f72-cc28ff18d7b6/runs/_current"=>{"get"=>{"summary"=>"Get Current Run", "description"=>"Get current run.", "operationId"=>"Dummies01e668ba696745369f72Cc28ff18d7b6RunsCurrentGet", "x-api-path-slug"=>"dummies01e668ba696745369f72cc28ff18d7b6runs-current-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "Run"]}, "delete"=>{"summary"=>"Delete a Run", "description"=>"Delete a run.", "operationId"=>"Dummies01e668ba696745369f72Cc28ff18d7b6RunsCurrentDelete", "x-api-path-slug"=>"dummies01e668ba696745369f72cc28ff18d7b6runs-current-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Run"]}}, "/vehicles/9aa35c64-b046-43cc-9cd8-4c353a6d0b30/odometers"=>{"get"=>{"summary"=>"List All Odometer Reports for a Vehicle", "description"=>"List all odometer reports for a vehicle.", "operationId"=>"Vehicles9aa35c64B04643cc9cd84c353a6d0b30OdometersGet", "x-api-path-slug"=>"vehicles9aa35c64b04643cc9cd84c353a6d0b30odometers-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Odometer", "Reportsa", "Vehicle"]}, "post"=>{"summary"=>"Create an Odometer Report", "description"=>"Create an odometer report.", "operationId"=>"Vehicles9aa35c64B04643cc9cd84c353a6d0b30OdometersPost", "x-api-path-slug"=>"vehicles9aa35c64b04643cc9cd84c353a6d0b30odometers-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Odometer", "Report"]}}, "/dummies"=>{"get"=>{"summary"=>"List Dummy Devices", "description"=>"List dummy devices.", "operationId"=>"DummiesGet", "x-api-path-slug"=>"dummies-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Dummy", "Devices"]}, "post"=>{"summary"=>"Create a Dummy Device", "description"=>"Create a dummy device.", "operationId"=>"DummiesPost", "x-api-path-slug"=>"dummies-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dummy", "Device"]}}, "/routes"=>{"get"=>{"summary"=>"List Dummy Routes", "description"=>"List dummy routes.", "operationId"=>"RoutesGet", "x-api-path-slug"=>"routes-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Dummy", "Routes"]}}, "/devices/cf217c2d-df3c-41f7-b610-8bc3e11b4b79"=>{"get"=>{"summary"=>"get a single device", "description"=>"Get a single device.", "operationId"=>"DevicesCf217c2dDf3c41f7B6108bc3e11b4b79Get", "x-api-path-slug"=>"devicescf217c2ddf3c41f7b6108bc3e11b4b79-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Single", "Device"]}}, "/notifications/E4A2E663-D23B-4398-8B91-B826D5477B8F"=>{"get"=>{"summary"=>"Get a Specific Notification", "description"=>"Get a specific notification.", "operationId"=>"NotificationsE4A2E663D23B43988B91B826D5477B8FGet", "x-api-path-slug"=>"notificationse4a2e663d23b43988b91b826d5477b8f-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "Notification"]}}, "/subscriptions/4ffd7abb-6c04-45e9-a09a-a669abf4f885"=>{"get"=>{"summary"=>"Get a Specific Subscription", "description"=>"Get a specific subscription.", "operationId"=>"Subscriptions4ffd7abb6c0445e9A09aA669abf4f885Get", "x-api-path-slug"=>"subscriptions4ffd7abb6c0445e9a09aa669abf4f885-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "Subscription"]}}, "/subscriptions/78acd627-e2ea-4b34-9599-b94b2f10f2f9/notifications"=>{"get"=>{"summary"=>"Get Notifications for a Subscription", "description"=>"Get notifications for a subscription.", "operationId"=>"Subscriptions78acd627E2ea4b349599B94b2f10f2f9NotificationsGet", "x-api-path-slug"=>"subscriptions78acd627e2ea4b349599b94b2f10f2f9notifications-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notificationsa", "Subscription"]}}, "/events/d69cc8be-a809-441d-8a70-1bf0a0d48fb3/notifications"=>{"get"=>{"summary"=>"Get Notifications for an Event", "description"=>"Get notifications for an event.", "operationId"=>"EventsD69cc8beA809441d8a701bf0a0d48fb3NotificationsGet", "x-api-path-slug"=>"eventsd69cc8bea809441d8a701bf0a0d48fb3notifications-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notificationsan", "Event"]}}, "/trips/89abe0bd-ea2e-44e5-b573-a8a346fdfb54"=>{"get"=>{"summary"=>"Get Details of a Trip", "description"=>"Get details of a trip.", "operationId"=>"Trips89abe0bdEa2e44e5B573A8a346fdfb54Get", "x-api-path-slug"=>"trips89abe0bdea2e44e5b573a8a346fdfb54-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Details", "Of", "Trip"]}}, "/devices/7eac0d62-854f-41c1-a5b2-ba13c460058a/report_cards/overall"=>{"get"=>{"summary"=>"Lifetime Report Card for a Device", "description"=>"Lifetime report card for a device.", "operationId"=>"Devices7eac0d62854f41c1A5b2Ba13c460058aReportCardsOverallGet", "x-api-path-slug"=>"devices7eac0d62854f41c1a5b2ba13c460058areport-cardsoverall-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lifetime", "Report", "Carda", "Device"]}}, "/transactions"=>{"get"=>{"summary"=>"Get all transactions for this app", "description"=>"Get all transactions for this app.", "operationId"=>"TransactionsGet", "x-api-path-slug"=>"transactions-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactionsthis", "App"]}}, "/devices/62976d30-b6dc-40f1-8422-ccc367572101/rules"=>{"post"=>{"summary"=>"Create a Rule for a Device", "description"=>"Create a rule for a device.", "operationId"=>"Devices62976d30B6dc40f18422Ccc367572101RulesPost", "x-api-path-slug"=>"devices62976d30b6dc40f18422ccc367572101rules-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rulea", "Device"]}}, "/odometers/74b7562d-f002-4fc9-8d85-48ec9f917954"=>{"get"=>{"summary"=>"Get an Odometer", "description"=>"Get an odometer.", "operationId"=>"Odometers74b7562dF0024fc98d8548ec9f917954Get", "x-api-path-slug"=>"odometers74b7562df0024fc98d8548ec9f917954-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Odometer"]}, "delete"=>{"summary"=>"Delete an Odometer", "description"=>"Delete an odometer.", "operationId"=>"Odometers74b7562dF0024fc98d8548ec9f917954Delete", "x-api-path-slug"=>"odometers74b7562df0024fc98d8548ec9f917954-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Odometer"]}}, "/devices/7eac0d62-854f-41c1-a5b2-ba13c460058a/report_cards"=>{"get"=>{"summary"=>"Report Cards for a Device", "description"=>"Report cards for a device.", "operationId"=>"Devices7eac0d62854f41c1A5b2Ba13c460058aReportCardsGet", "x-api-path-slug"=>"devices7eac0d62854f41c1a5b2ba13c460058areport-cards-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report", "Cardsa", "Device"]}}, "/vehicles/9aa35c64-b046-43cc-9cd8-4c353a6d0b30/distances"=>{"get"=>{"summary"=>"Get list of a Vehicles Distances", "description"=>"Get list of a vehicles distances.", "operationId"=>"Vehicles9aa35c64B04643cc9cd84c353a6d0b30DistancesGet", "x-api-path-slug"=>"vehicles9aa35c64b04643cc9cd84c353a6d0b30distances-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "", "Vehicles", "Distances"]}}, "/rules/68d489c0-d7a2-11e3-9c1a-0800200c9a66"=>{"delete"=>{"summary"=>"Delete a Rule", "description"=>"Delete a rule.", "operationId"=>"Rules68d489c0D7a211e39c1a0800200c9a66Delete", "x-api-path-slug"=>"rules68d489c0d7a211e39c1a0800200c9a66-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rule"]}}, "/devices/cf217c2d-df3c-41f7-b610-8bc3e11b4b79/messages"=>{"get"=>{"summary"=>"List Telemetry Messages", "description"=>"List telemetry messages.", "operationId"=>"DevicesCf217c2dDf3c41f7B6108bc3e11b4b79MessagesGet", "x-api-path-slug"=>"devicescf217c2ddf3c41f7b6108bc3e11b4b79messages-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Telemetry", "Messages"]}}, "/devices/cf217c2d-df3c-41f7-b610-8bc3e11b4b79/rules"=>{"get"=>{"summary"=>"List all Rules for a Device", "description"=>"List all rules for a device.", "operationId"=>"DevicesCf217c2dDf3c41f7B6108bc3e11b4b79RulesGet", "x-api-path-slug"=>"devicescf217c2ddf3c41f7b6108bc3e11b4b79rules-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Rulesa", "Device"]}}, "/subscriptions/5b6a6164-aa14-4e00-9f50-b5c61faeb167"=>{"delete"=>{"summary"=>"Delete a Subscription", "description"=>"Delete a subscription.", "operationId"=>"Subscriptions5b6a6164Aa144e009f50B5c61faeb167Delete", "x-api-path-slug"=>"subscriptions5b6a6164aa144e009f50b5c61faeb167-delete", "parameters"=>[{"in"=>"header", "name"=>"ac"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/devices/821374c0-d6d8-11e3-9c1a-0800200c9a66"=>{"delete"=>{"summary"=>"Deregister a Device", "description"=>"Deregister a device.", "operationId"=>"Devices821374c0D6d811e39c1a0800200c9a66Delete", "x-api-path-slug"=>"devices821374c0d6d811e39c1a0800200c9a66-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deregister", "Device"]}}, "/vehicles/9aa35c64-b046-43cc-9cd8-4c353a6d0b30/codes"=>{"get"=>{"summary"=>"List all DTCs for a Device", "description"=>"List all dtcs for a device.", "operationId"=>"Vehicles9aa35c64B04643cc9cd84c353a6d0b30CodesGet", "x-api-path-slug"=>"vehicles9aa35c64b04643cc9cd84c353a6d0b30codes-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "DTCsa", "Device"]}}, "/report_cards/549d628c-48dc-412d-8087-44a9f82f187e"=>{"get"=>{"summary"=>"Get a Specific Report Card", "description"=>"Get a specific report card.", "operationId"=>"ReportCards549d628c48dc412d808744a9f82f187eGet", "x-api-path-slug"=>"report-cards549d628c48dc412d808744a9f82f187e-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "Report", "Card"]}}, "/devices/cf217c2d-df3c-41f7-b610-8bc3e11b4b79/trips"=>{"get"=>{"summary"=>"List All of a Device's Trips", "description"=>"List all of a device's trips.", "operationId"=>"DevicesCf217c2dDf3c41f7B6108bc3e11b4b79TripsGet", "x-api-path-slug"=>"devicescf217c2ddf3c41f7b6108bc3e11b4b79trips-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Of", "Devices", "Trips"]}}}}, "apis"=>{"name"=>"Vinli", "x-slug"=>"vinli", "description"=>"Vinli - The easiest, most advanced connected-car system in the world. Vinli is a platform for easily and quickly building connected car apps. Apps get vehicle data through Vinli services.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28875-www-vin-li.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"2170360", "tags"=>"Automobiles,Mobile,Relative Data,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"vinli/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Vinli", "x-api-slug"=>"vinli", "description"=>"Vinli - The easiest, most advanced connected-car system in the world. Vinli is a platform for easily and quickly building connected car apps. Apps get vehicle data through Vinli services.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28875-www-vin-li.jpg", "humanURL"=>"http://vinli.com", "baseURL"=>"https://events.vin.li//api/v1", "tags"=>"Automobiles,Mobile,Relative Data,Service API,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/vinli/vinli-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog-rss", "url"=>"https://blog.vin.li/rss/"}, {"type"=>"x-github", "url"=>"https://github.com/vinli"}, {"type"=>"x-website", "url"=>"http://vinli.com"}, {"type"=>"x-blog", "url"=>"https://blog.vin.li/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/vinli"}, {"type"=>"x-developer", "url"=>"https://dev.vin.li/#/home"}, {"type"=>"x-email", "url"=>"customerservice@vin.li"}, {"type"=>"x-email", "url"=>"support@vin.li"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/vinli"}, {"type"=>"x-website", "url"=>"https://www.vin.li"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
salesloft{"salesloft-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"SalesLoft", "x-complete"=>1, "info"=>{"title"=>"SalesLoft", "description"=>"salesloft-helps-transform-sales-teams-into-modern-sales-organizations---converting-more-target-accounts-into-customer-accounts", "version"=>"v2"}, "host"=>"api.salesloft.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v2/accounts.json"=>{"get"=>{"summary"=>"List accounts", "description"=>"Fetches multiple account records. The records can be filtered, paged, and sorted according to\nthe respective parameters.", "operationId"=>"v2.accounts.json.get", "x-api-path-slug"=>"v2accounts-json-get", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"Domain of the accounts to fetch"}, {"in"=>"query", "name"=>"ids", "description"=>"IDs of accounts to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: created_at, updated_at, last_contacted_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}, {"in"=>"query", "name"=>"updated_at", "description"=>"Equality filters that are applied to the updated_at field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Accounts"]}, "post"=>{"summary"=>"Create an account", "description"=>"Creates an account.\n\n\"domain\" must be unique on the current team.", "operationId"=>"v2.accounts.json.post", "x-api-path-slug"=>"v2accounts-json-post", "parameters"=>[{"in"=>"formData", "name"=>"city", "description"=>"City"}, {"in"=>"formData", "name"=>"company_stage_id", "description"=>"ID of the CompanyStage assigned to this Account"}, {"in"=>"formData", "name"=>"company_type", "description"=>"Type of the Accounts company"}, {"in"=>"formData", "name"=>"conversational_name", "description"=>"Conversational name of the Account"}, {"in"=>"formData", "name"=>"country", "description"=>"Country"}, {"in"=>"formData", "name"=>"custom_fields", "description"=>"Custom fields are defined by the users team"}, {"in"=>"formData", "name"=>"description", "description"=>"Description"}, {"in"=>"formData", "name"=>"domain", "description"=>"Website domain, not a fully qualified URI"}, {"in"=>"formData", "name"=>"do_not_contact", "description"=>"Whether this company can not be contacted"}, {"in"=>"formData", "name"=>"founded", "description"=>"Date or year of founding"}, {"in"=>"formData", "name"=>"industry", "description"=>"Industry"}, {"in"=>"formData", "name"=>"linkedin_url", "description"=>"Full LinkedIn url"}, {"in"=>"formData", "name"=>"locale", "description"=>"Time locale"}, {"in"=>"formData", "name"=>"name", "description"=>"Account Full Name"}, {"in"=>"formData", "name"=>"owner_id", "description"=>"ID of the User that owns this Account"}, {"in"=>"formData", "name"=>"phone", "description"=>"Phone number without formatting"}, {"in"=>"formData", "name"=>"postal_code", "description"=>"Postal code"}, {"in"=>"formData", "name"=>"revenue_range", "description"=>"Estimated revenue range"}, {"in"=>"formData", "name"=>"size", "description"=>"Estimated number of people in employment"}, {"in"=>"formData", "name"=>"state", "description"=>"State"}, {"in"=>"formData", "name"=>"street", "description"=>"Street name and number"}, {"in"=>"formData", "name"=>"tags", "description"=>"All tags applied to this Account"}, {"in"=>"formData", "name"=>"twitter_handle", "description"=>"Twitter handle, with @"}, {"in"=>"formData", "name"=>"website", "description"=>"Website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Account"]}}, "/v2/accounts/{id}.json"=>{"delete"=>{"summary"=>"Delete an account", "description"=>"Deletes an account. This operation is not reversible without contacting support.\nThis operation can be called multiple times successfully.\n\nDeleting an account will remove all connected people from that account.", "operationId"=>"v2.accounts.id.json.delete", "x-api-path-slug"=>"v2accountsid-json-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Account ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Account"]}, "get"=>{"summary"=>"Fetch an account", "description"=>"Fetches an account, by ID only.", "operationId"=>"v2.accounts.id.json.get", "x-api-path-slug"=>"v2accountsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Account ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Account"]}, "put"=>{"summary"=>"Update an existing Account", "description"=>"Updates an account.\n\n\"domain\" must be unique on the current team.", "operationId"=>"v2.accounts.id.json.put", "x-api-path-slug"=>"v2accountsid-json-put", "parameters"=>[{"in"=>"formData", "name"=>"city", "description"=>"City"}, {"in"=>"formData", "name"=>"company_stage_id", "description"=>"ID of the CompanyStage assigned to this Account"}, {"in"=>"formData", "name"=>"company_type", "description"=>"Type of the Accounts company"}, {"in"=>"formData", "name"=>"conversational_name", "description"=>"Conversational name of the Account"}, {"in"=>"formData", "name"=>"country", "description"=>"Country"}, {"in"=>"formData", "name"=>"custom_fields", "description"=>"Custom fields are defined by the users team"}, {"in"=>"formData", "name"=>"description", "description"=>"Description"}, {"in"=>"formData", "name"=>"domain", "description"=>"Website domain, not a fully qualified URI"}, {"in"=>"formData", "name"=>"do_not_contact", "description"=>"Whether this company can not be contacted"}, {"in"=>"formData", "name"=>"founded", "description"=>"Date or year of founding"}, {"in"=>"path", "name"=>"id", "description"=>"Account ID"}, {"in"=>"formData", "name"=>"industry", "description"=>"Industry"}, {"in"=>"formData", "name"=>"linkedin_url", "description"=>"Full LinkedIn url"}, {"in"=>"formData", "name"=>"locale", "description"=>"Time locale"}, {"in"=>"formData", "name"=>"name", "description"=>"Account Full Name"}, {"in"=>"formData", "name"=>"owner_id", "description"=>"ID of the User that owns this Account"}, {"in"=>"formData", "name"=>"phone", "description"=>"Phone number without formatting"}, {"in"=>"formData", "name"=>"postal_code", "description"=>"Postal code"}, {"in"=>"formData", "name"=>"revenue_range", "description"=>"Estimated revenue range"}, {"in"=>"formData", "name"=>"size", "description"=>"Estimated number of people in employment"}, {"in"=>"formData", "name"=>"state", "description"=>"State"}, {"in"=>"formData", "name"=>"street", "description"=>"Street name and number"}, {"in"=>"formData", "name"=>"tags", "description"=>"All tags applied to this Account"}, {"in"=>"formData", "name"=>"twitter_handle", "description"=>"Twitter handle, with @"}, {"in"=>"formData", "name"=>"website", "description"=>"Website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Existing", "Account"]}}, "/v2/action_details/call_instructions.json"=>{"get"=>{"summary"=>"List call instructions", "description"=>"Fetches multiple call instruction records. The records can be filtered, paged, and sorted according to\nthe respective parameters.", "operationId"=>"v2.action_details.call_instructions.json.get", "x-api-path-slug"=>"v2action-detailscall-instructions-json-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"IDs of call instructions to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: created_at, updated_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Call", "Instructions"]}}, "/v2/action_details/call_instructions/{id}.json"=>{"get"=>{"summary"=>"Fetch a call instructions", "description"=>"Fetches a call instruction, by ID only.", "operationId"=>"v2.action_details.call_instructions.id.json.get", "x-api-path-slug"=>"v2action-detailscall-instructionsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Call instructions ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Call", "Instructions"]}}, "/v2/actions.json"=>{"get"=>{"summary"=>"List actions", "description"=>"Fetches multiple action records. The records can be filtered, paged, and sorted according to\nthe respective parameters. Only actions that are currently \"in_progess\" will be returned by\nthis endpoint.", "operationId"=>"v2.actions.json.get", "x-api-path-slug"=>"v2actions-json-get", "parameters"=>[{"in"=>"query", "name"=>"due_on", "description"=>"Equality filters that are applied to the due_on field"}, {"in"=>"query", "name"=>"ids", "description"=>"IDs of actions to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: created_at, updated_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}, {"in"=>"query", "name"=>"step_id", "description"=>"Fetch actions by step ID"}, {"in"=>"query", "name"=>"type", "description"=>"Filter actions by type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Actions"]}}, "/v2/actions/{id}.json"=>{"get"=>{"summary"=>"Fetch an action", "description"=>"Fetches an action, by ID only.\nThis endpoint will only return actions that are in_progress or pending_activity.\nOnce an action is complete, the request for that action will return a 404 status code.", "operationId"=>"v2.actions.id.json.get", "x-api-path-slug"=>"v2actionsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Action ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Action"]}}, "/v2/activities/calls.json"=>{"get"=>{"summary"=>"List calls", "description"=>"Fetches multiple call records. The records can be filtered, paged, and sorted according to\nthe respective parameters.", "operationId"=>"v2.activities.calls.json.get", "x-api-path-slug"=>"v2activitiescalls-json-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"IDs of calls to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: created_at, updated_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}, {"in"=>"query", "name"=>"updated_at", "description"=>"Equality filters that are applied to the updated_at field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Calls"]}}, "/v2/activities/calls/{id}.json"=>{"get"=>{"summary"=>"Fetch a call", "description"=>"Fetches a call, by ID only.", "operationId"=>"v2.activities.calls.id.json.get", "x-api-path-slug"=>"v2activitiescallsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Call ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Call"]}}, "/v2/activities/emails.json"=>{"get"=>{"summary"=>"List emails", "description"=>"Fetches multiple email records. The records can be filtered, paged, and sorted according to\nthe respective parameters.", "operationId"=>"v2.activities.emails.json.get", "x-api-path-slug"=>"v2activitiesemails-json-get", "parameters"=>[{"in"=>"query", "name"=>"bounced", "description"=>"Filters emails by whether they have bounced or not"}, {"in"=>"query", "name"=>"ids", "description"=>"IDs of emails to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: updated_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}, {"in"=>"query", "name"=>"updated_at", "description"=>"Equality filters that are applied to the updated_at field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Emails"]}}, "/v2/activities/emails/{id}.json"=>{"get"=>{"summary"=>"Fetch an email", "description"=>"Fetches an email, by ID only.", "operationId"=>"v2.activities.emails.id.json.get", "x-api-path-slug"=>"v2activitiesemailsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Email ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Email"]}}, "/v2/cadence_memberships.json"=>{"get"=>{"summary"=>"List cadence memberships", "description"=>"Fetches multiple cadence membership records. The records can be filtered, paged, and sorted according to\nthe respective parameters. A cadence membership is the association between a person and their current and\nhistorical time on a cadence. Cadence membership records are mutable and change over time. If a person is\nadded to a cadence and re-added to the same cadence in the future, there is a single membership record.", "operationId"=>"v2.cadence_memberships.json.get", "x-api-path-slug"=>"v2cadence-memberships-json-get", "parameters"=>[{"in"=>"query", "name"=>"cadence_id", "description"=>"ID of the cadence to find cadence memberships for"}, {"in"=>"query", "name"=>"ids", "description"=>"IDs of cadence memberships to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"person_id", "description"=>"ID of the person to find cadence memberships for"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: updated_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}, {"in"=>"query", "name"=>"updated_at", "description"=>"Equality filters that are applied to the updated_at field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Cadence", "Memberships"]}, "post"=>{"summary"=>"Create a cadence membership", "description"=>"Adds a person to a cadence. person_id and cadence_id are required, and must be visible to the authenticated user. user_id will\ndefault to the authenticated user, but can be set to any visible user on the authenticated team.\n\nA person cannot be added to a cadence on behalf of a teammate unless the cadence is a team cadence, or the cadence is owned by\nthe teammate.", "operationId"=>"v2.cadence_memberships.json.post", "x-api-path-slug"=>"v2cadence-memberships-json-post", "parameters"=>[{"in"=>"query", "name"=>"cadence_id", "description"=>"ID of the cadence to create a cadence membership for"}, {"in"=>"query", "name"=>"person_id", "description"=>"ID of the person to create a cadence membership for"}, {"in"=>"query", "name"=>"user_id", "description"=>"ID of the user to create a cadence membership for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Cadence", "Membership"]}}, "/v2/cadence_memberships/{id}.json"=>{"delete"=>{"summary"=>"Delete a cadence membership", "description"=>"", "operationId"=>"v2.cadence_memberships.id.json.delete", "x-api-path-slug"=>"v2cadence-membershipsid-json-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"CadenceMembership ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Cadence", "Membership"]}, "get"=>{"summary"=>"Fetch a cadence membership", "description"=>"Fetches a cadence membership, by ID only.", "operationId"=>"v2.cadence_memberships.id.json.get", "x-api-path-slug"=>"v2cadence-membershipsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"CadenceMembership ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Cadence", "Membership"]}}, "/v2/cadences.json"=>{"get"=>{"summary"=>"List cadences", "description"=>"Fetches multiple cadence records. The records can be filtered, paged, and sorted according to\nthe respective parameters.", "operationId"=>"v2.cadences.json.get", "x-api-path-slug"=>"v2cadences-json-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"IDs of cadences to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: created_at, updated_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}, {"in"=>"query", "name"=>"team_cadence", "description"=>"Filters cadences by whether they are a team cadence or not"}, {"in"=>"query", "name"=>"updated_at", "description"=>"Equality filters that are applied to the updated_at field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Cadences"]}}, "/v2/cadences/{id}.json"=>{"get"=>{"summary"=>"Fetch a cadence", "description"=>"Fetches a cadence, by ID only.", "operationId"=>"v2.cadences.id.json.get", "x-api-path-slug"=>"v2cadencesid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Cadence ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Cadence"]}}, "/v2/call_data_records.json"=>{"get"=>{"summary"=>"List call data records", "description"=>"Fetches multiple call data records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n\nCall data records are records of all inbound and outbound calls through SalesLoft. A call data record may\nbe associated with a call, but does not have to be.", "operationId"=>"v2.call_data_records.json.get", "x-api-path-slug"=>"v2call-data-records-json-get", "parameters"=>[{"in"=>"query", "name"=>"has_call", "description"=>"Return only call data records which have or do not have a call logged for them"}, {"in"=>"query", "name"=>"ids", "description"=>"IDs of call data records to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: created_at, updated_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}, {"in"=>"query", "name"=>"updated_at", "description"=>"Equality filters that are applied to the updated_at field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Call", "Data", "Records"]}}, "/v2/call_data_records/{id}.json"=>{"get"=>{"summary"=>"Fetch a call data record", "description"=>"Fetches a call data record, by ID only.", "operationId"=>"v2.call_data_records.id.json.get", "x-api-path-slug"=>"v2call-data-recordsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"CallDataRecord ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Call", "Data", "Record"]}}, "/v2/crm_activities.json"=>{"get"=>{"summary"=>"List crm activities", "description"=>"Fetches multiple crm activity records. The records can be filtered, paged, and sorted according to\nthe respective parameters.", "operationId"=>"v2.crm_activities.json.get", "x-api-path-slug"=>"v2crm-activities-json-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"IDs of crm activities to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: created_at, updated_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}, {"in"=>"query", "name"=>"updated_at", "description"=>"Equality filters that are applied to the updated_at field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Crm", "Activities"]}}, "/v2/crm_activities/{id}.json"=>{"get"=>{"summary"=>"Fetch a crm activity", "description"=>"Fetches a crm activity, by ID only.", "operationId"=>"v2.crm_activities.id.json.get", "x-api-path-slug"=>"v2crm-activitiesid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Crm activity ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Crm", "Activity"]}}, "/v2/custom_fields.json"=>{"get"=>{"summary"=>"List custom fields", "description"=>"Fetches multiple custom field records. The records can be filtered, paged, and sorted according to\nthe respective parameters.", "operationId"=>"v2.custom_fields.json.get", "x-api-path-slug"=>"v2custom-fields-json-get", "parameters"=>[{"in"=>"query", "name"=>"field_type", "description"=>"Type of field to fetch"}, {"in"=>"query", "name"=>"ids", "description"=>"IDs of custom fields to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: created_at, updated_at, name"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Custom", "Fields"]}, "post"=>{"summary"=>"Create a custom field", "description"=>"Creates a custom field.", "operationId"=>"v2.custom_fields.json.post", "x-api-path-slug"=>"v2custom-fields-json-post", "parameters"=>[{"in"=>"formData", "name"=>"field_type", "description"=>"The field type of the custom field"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the custom field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Custom", "Field"]}}, "/v2/custom_fields/{id}.json"=>{"delete"=>{"summary"=>"Delete a custom field", "description"=>"Deletes a custom field.", "operationId"=>"v2.custom_fields.id.json.delete", "x-api-path-slug"=>"v2custom-fieldsid-json-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Custom Field ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Custom", "Field"]}, "get"=>{"summary"=>"Fetch a custom field", "description"=>"Fetches a custom field, by ID only.", "operationId"=>"v2.custom_fields.id.json.get", "x-api-path-slug"=>"v2custom-fieldsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Custom Field ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Custom", "Field"]}, "put"=>{"summary"=>"Update a custom field", "description"=>"Update a custom field.", "operationId"=>"v2.custom_fields.id.json.put", "x-api-path-slug"=>"v2custom-fieldsid-json-put", "parameters"=>[{"in"=>"formData", "name"=>"field_type", "description"=>"The field type of the custom field"}, {"in"=>"path", "name"=>"id", "description"=>"Custom Field ID"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the custom field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Custom", "Field"]}}, "/v2/email_templates.json"=>{"get"=>{"summary"=>"List email templates", "description"=>"Fetches multiple email template records. The records can be filtered, paged, and sorted according to\nthe respective parameters.", "operationId"=>"v2.email_templates.json.get", "x-api-path-slug"=>"v2email-templates-json-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"IDs of email templates to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"linked_to_team_template", "description"=>"Filters email templates by whether they are linked to a team template or not"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: created_at, updated_at, last_used_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}, {"in"=>"query", "name"=>"updated_at", "description"=>"Equality filters that are applied to the updated_at field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Email", "Templates"]}}, "/v2/email_templates/{id}.json"=>{"get"=>{"summary"=>"Fetch an email template", "description"=>"Fetches an email template, by ID only.", "operationId"=>"v2.email_templates.id.json.get", "x-api-path-slug"=>"v2email-templatesid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"EmailTemplate ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Email", "Template"]}}, "/v2/imports.json"=>{"get"=>{"summary"=>"List imports", "description"=>"Fetches multiple imports.", "operationId"=>"v2.imports.json.get", "x-api-path-slug"=>"v2imports-json-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"IDs of imports to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: created_at, updated_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}, {"in"=>"query", "name"=>"user_ids", "description"=>"ID of users to fetch imports for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Imports"]}, "post"=>{"summary"=>"Create an import", "description"=>"Creates an import.", "operationId"=>"v2.imports.json.post", "x-api-path-slug"=>"v2imports-json-post", "parameters"=>[{"in"=>"formData", "name"=>"name", "description"=>"Name, recommended to be easily identifiable to a user"}, {"in"=>"formData", "name"=>"user_id", "description"=>"ID of the User that owns this Import"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Import"]}}, "/v2/imports/{id}.json"=>{"delete"=>{"summary"=>"Delete an import", "description"=>"Deletes an import, by ID only. The associated people can be deleted as part of the deletion process.\n\nAdmin users can access imports for the entire team, but non-admin users can only access their own imports.", "operationId"=>"v2.imports.id.json.delete", "x-api-path-slug"=>"v2importsid-json-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Import ID"}, {"in"=>"query", "name"=>"undo", "description"=>"Whether to delete people on this Import"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Import"]}, "get"=>{"summary"=>"Fetch an import", "description"=>"Fetches an import, by ID only.\n\nAdmin users can access imports for the entire team, but non-admin users can only access their own imports.", "operationId"=>"v2.imports.id.json.get", "x-api-path-slug"=>"v2importsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Import ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Import"]}, "put"=>{"summary"=>"Update an import", "description"=>"Updates an import, by ID only.\n\nAdmin users can access imports for the entire team, but non-admin users can only access their own imports.", "operationId"=>"v2.imports.id.json.put", "x-api-path-slug"=>"v2importsid-json-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Import ID"}, {"in"=>"formData", "name"=>"name", "description"=>"Name, recommended to be easily identifiable to a user"}, {"in"=>"formData", "name"=>"user_id", "description"=>"ID of the User that owns this Import"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Import"]}}, "/v2/me.json"=>{"get"=>{"summary"=>"Fetch current user", "description"=>"Authenticated user information. This endpoint does not accept any parameters as it is\nrepresents your authenticated user. The \"Users\" resource provides user information\nfor other users on the team.", "operationId"=>"v2.me.json.get", "x-api-path-slug"=>"v2me-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Current", "User"]}}, "/v2/notes.json"=>{"get"=>{"summary"=>"List notes", "description"=>"Fetches multiple note records. The records can be filtered, paged, and sorted according to\nthe respective parameters.", "operationId"=>"v2.notes.json.get", "x-api-path-slug"=>"v2notes-json-get", "parameters"=>[{"in"=>"query", "name"=>"associated_with_id", "description"=>"ID of the item with which the note is associated"}, {"in"=>"query", "name"=>"associated_with_type", "description"=>"Case insensitive type of item with which the note is associated"}, {"in"=>"query", "name"=>"ids", "description"=>"IDs of notes to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: created_at, updated_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}, {"in"=>"query", "name"=>"updated_at", "description"=>"Equality filters that are applied to the updated_at field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Notes"]}, "post"=>{"summary"=>"Create a note", "description"=>"Creates a note.", "operationId"=>"v2.notes.json.post", "x-api-path-slug"=>"v2notes-json-post", "parameters"=>[{"in"=>"formData", "name"=>"associated_with_id", "description"=>"ID of the item with which the note is associated"}, {"in"=>"formData", "name"=>"associated_with_type", "description"=>"Case insensitive type of item with which the note is associated"}, {"in"=>"formData", "name"=>"call_id", "description"=>"ID of the call with which the note is associated"}, {"in"=>"formData", "name"=>"content", "description"=>"The content of the note"}, {"in"=>"formData", "name"=>"skip_crm_sync", "description"=>"Boolean indicating if the CRM sync should be skipped"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Note"]}}, "/v2/notes/{id}.json"=>{"get"=>{"summary"=>"Fetch a note", "description"=>"Fetches a note, by ID only.", "operationId"=>"v2.notes.id.json.get", "x-api-path-slug"=>"v2notesid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Note ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Note"]}, "put"=>{"summary"=>"Update a note", "description"=>"Updates a note. Any changes to the note or associated records will not reflect in Salesforce.com.", "operationId"=>"v2.notes.id.json.put", "x-api-path-slug"=>"v2notesid-json-put", "parameters"=>[{"in"=>"formData", "name"=>"call_id", "description"=>"ID of the call with which the note is associated"}, {"in"=>"formData", "name"=>"content", "description"=>"The content of the note"}, {"in"=>"path", "name"=>"id", "description"=>"Note ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Note"]}}, "/v2/people.json"=>{"get"=>{"summary"=>"List people", "description"=>"Fetches multiple person records. The records can be filtered, paged, and sorted according to\nthe respective parameters.", "operationId"=>"v2.people.json.get", "x-api-path-slug"=>"v2people-json-get", "parameters"=>[{"in"=>"query", "name"=>"email_addresses", "description"=>"Filters people by email address"}, {"in"=>"query", "name"=>"ids", "description"=>"IDs of people to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: created_at, updated_at, last_contacted_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}, {"in"=>"query", "name"=>"updated_at", "description"=>"Equality filters that are applied to the updated_at field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "People"]}, "post"=>{"summary"=>"Create a person", "description"=>"Creates a person. Either email_address or phone/last_name must be provided as a unique lookup\non the team.", "operationId"=>"v2.people.json.post", "x-api-path-slug"=>"v2people-json-post", "parameters"=>[{"in"=>"formData", "name"=>"account_id", "description"=>"ID of the Account to link this person to"}, {"in"=>"formData", "name"=>"autotag_date", "description"=>"Whether the date should be added to this person as a tag"}, {"in"=>"formData", "name"=>"city", "description"=>"City"}, {"in"=>"formData", "name"=>"country", "description"=>"Country"}, {"in"=>"formData", "name"=>"custom_fields", "description"=>"Custom fields are defined by the users team"}, {"in"=>"formData", "name"=>"do_not_contact", "description"=>"Whether this person can not be contacted"}, {"in"=>"formData", "name"=>"email_address", "description"=>"Email address"}, {"in"=>"formData", "name"=>"first_name", "description"=>"First name"}, {"in"=>"formData", "name"=>"home_phone", "description"=>"Home phone without formatting"}, {"in"=>"formData", "name"=>"import_id", "description"=>"ID of the Import this person is a part of"}, {"in"=>"formData", "name"=>"last_name", "description"=>"Last name"}, {"in"=>"formData", "name"=>"linkedin_url", "description"=>"Linkedin URL"}, {"in"=>"formData", "name"=>"locale", "description"=>"Time locale of the person"}, {"in"=>"formData", "name"=>"mobile_phone", "description"=>"Mobile phone without formatting"}, {"in"=>"formData", "name"=>"owner_id", "description"=>"ID of the User that owns this person"}, {"in"=>"formData", "name"=>"personal_email_address", "description"=>"Personal email address"}, {"in"=>"formData", "name"=>"personal_website", "description"=>"The website of this person"}, {"in"=>"formData", "name"=>"person_company_industry", "description"=>"Company industry"}, {"in"=>"formData", "name"=>"person_company_name", "description"=>"Company name"}, {"in"=>"formData", "name"=>"person_company_website", "description"=>"Company website"}, {"in"=>"formData", "name"=>"person_stage_id", "description"=>"ID of the PersonStage of this person"}, {"in"=>"formData", "name"=>"phone", "description"=>"Phone without formatting"}, {"in"=>"formData", "name"=>"phone_extension", "description"=>"Phone extension without formatting"}, {"in"=>"formData", "name"=>"secondary_email_address", "description"=>"Alternate email address"}, {"in"=>"formData", "name"=>"state", "description"=>"State"}, {"in"=>"formData", "name"=>"tags", "description"=>"All tags applied to this person"}, {"in"=>"formData", "name"=>"title", "description"=>"Job title"}, {"in"=>"formData", "name"=>"twitter_handle", "description"=>"The twitter handle of this person"}, {"in"=>"formData", "name"=>"work_city", "description"=>"Work location - city"}, {"in"=>"formData", "name"=>"work_country", "description"=>"Work location - country"}, {"in"=>"formData", "name"=>"work_state", "description"=>"Work location - state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Person"]}}, "/v2/people/{id}.json"=>{"delete"=>{"summary"=>"Delete a person", "description"=>"Deletes a person. This operation is not reversible without contacting support.\nThis operation can be called multiple times successfully.", "operationId"=>"v2.people.id.json.delete", "x-api-path-slug"=>"v2peopleid-json-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Person id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Person"]}, "get"=>{"summary"=>"Fetch a person", "description"=>"Fetches a person, by ID only.", "operationId"=>"v2.people.id.json.get", "x-api-path-slug"=>"v2peopleid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Person ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Person"]}, "put"=>{"summary"=>"Update a person", "description"=>"Updates a person.", "operationId"=>"v2.people.id.json.put", "x-api-path-slug"=>"v2peopleid-json-put", "parameters"=>[{"in"=>"formData", "name"=>"account_id", "description"=>"ID of the Account to link this person to"}, {"in"=>"formData", "name"=>"city", "description"=>"City"}, {"in"=>"formData", "name"=>"country", "description"=>"Country"}, {"in"=>"formData", "name"=>"custom_fields", "description"=>"Custom fields are defined by the users team"}, {"in"=>"formData", "name"=>"do_not_contact", "description"=>"Whether this person can not be contacted"}, {"in"=>"formData", "name"=>"email_address", "description"=>"Email address"}, {"in"=>"formData", "name"=>"first_name", "description"=>"First name"}, {"in"=>"formData", "name"=>"home_phone", "description"=>"Home phone without formatting"}, {"in"=>"path", "name"=>"id", "description"=>"Person id"}, {"in"=>"formData", "name"=>"import_id", "description"=>"ID of the Import this person is a part of"}, {"in"=>"formData", "name"=>"last_name", "description"=>"Last name"}, {"in"=>"formData", "name"=>"linkedin_url", "description"=>"Linkedin URL"}, {"in"=>"formData", "name"=>"locale", "description"=>"Time locale of the person"}, {"in"=>"formData", "name"=>"mobile_phone", "description"=>"Mobile phone without formatting"}, {"in"=>"formData", "name"=>"owner_id", "description"=>"ID of the User that owns this person"}, {"in"=>"formData", "name"=>"personal_email_address", "description"=>"Personal email address"}, {"in"=>"formData", "name"=>"personal_website", "description"=>"The website of this person"}, {"in"=>"formData", "name"=>"person_company_industry", "description"=>"Company industry"}, {"in"=>"formData", "name"=>"person_company_name", "description"=>"Company name"}, {"in"=>"formData", "name"=>"person_company_website", "description"=>"Company website"}, {"in"=>"formData", "name"=>"person_stage_id", "description"=>"ID of the PersonStage of this person"}, {"in"=>"formData", "name"=>"phone", "description"=>"Phone without formatting"}, {"in"=>"formData", "name"=>"phone_extension", "description"=>"Phone extension without formatting"}, {"in"=>"formData", "name"=>"secondary_email_address", "description"=>"Alternate email address"}, {"in"=>"formData", "name"=>"state", "description"=>"State"}, {"in"=>"formData", "name"=>"tags", "description"=>"All tags applied to this person"}, {"in"=>"formData", "name"=>"title", "description"=>"Job title"}, {"in"=>"formData", "name"=>"twitter_handle", "description"=>"The twitter handle of this person"}, {"in"=>"formData", "name"=>"work_city", "description"=>"Work location - city"}, {"in"=>"formData", "name"=>"work_country", "description"=>"Work location - country"}, {"in"=>"formData", "name"=>"work_state", "description"=>"Work location - state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Person"]}}, "/v2/person_stages.json"=>{"get"=>{"summary"=>"List person stages", "description"=>"Fetches multiple person stage records. The records can be filtered, paged, and sorted according to\nthe respective parameters.", "operationId"=>"v2.person_stages.json.get", "x-api-path-slug"=>"v2person-stages-json-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"IDs of person stages to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: created_at, updated_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Person", "Stages"]}, "post"=>{"summary"=>"Create a person stage", "description"=>"Creates a person stage.", "operationId"=>"v2.person_stages.json.post", "x-api-path-slug"=>"v2person-stages-json-post", "parameters"=>[{"in"=>"formData", "name"=>"name", "description"=>"The name of the new stage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Person", "Stage"]}}, "/v2/person_stages/{id}.json"=>{"delete"=>{"summary"=>"Delete an person stage", "description"=>"Deletes a person stage. This operation is not reversible without contacting support.\nThis operation can be called multiple times successfully.", "operationId"=>"v2.person_stages.id.json.delete", "x-api-path-slug"=>"v2person-stagesid-json-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Stage ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Person", "Stage"]}, "get"=>{"summary"=>"Fetch a person stage", "description"=>"Fetches a person stage, by ID only.", "operationId"=>"v2.person_stages.id.json.get", "x-api-path-slug"=>"v2person-stagesid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Stage ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Person", "Stage"]}, "put"=>{"summary"=>"Update a person stage", "description"=>"Updates a person stage.", "operationId"=>"v2.person_stages.id.json.put", "x-api-path-slug"=>"v2person-stagesid-json-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Stage ID"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the stage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Person", "Stage"]}}, "/v2/phone_numbers/caller_ids.json"=>{"get"=>{"summary"=>"List caller ids", "description"=>"Each entry is a possible caller ID match for the number. Multiple\nentries may be returned if the phone number is present on more than one\nperson in the system. Phone number should be in E.164 format.", "operationId"=>"v2.phone_numbers.caller_ids.json.get", "x-api-path-slug"=>"v2phone-numberscaller-ids-json-get", "parameters"=>[{"in"=>"query", "name"=>"phone_number", "description"=>"E"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Caller", "Ids"]}}, "/v2/phone_numbers/recording_settings/{id}.json"=>{"get"=>{"summary"=>"Fetch recording setting", "description"=>"Fetches the recording status for a given phone number, based on Do Not Record and Recording Governance for your team.\nPhone number should be in E.164 format.", "operationId"=>"v2.phone_numbers.recording_settings.id.json.get", "x-api-path-slug"=>"v2phone-numbersrecording-settingsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"E"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Recording", "Setting"]}}, "/v2/steps.json"=>{"get"=>{"summary"=>"List steps", "description"=>"Fetches multiple step records. The records can be filtered, paged, and sorted according to\nthe respective parameters.", "operationId"=>"v2.steps.json.get", "x-api-path-slug"=>"v2steps-json-get", "parameters"=>[{"in"=>"query", "name"=>"cadence_id", "description"=>"Filter by cadence ID"}, {"in"=>"query", "name"=>"has_due_actions", "description"=>"Filter by whether a step has due actions"}, {"in"=>"query", "name"=>"ids", "description"=>"IDs of steps to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: created_at, updated_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}, {"in"=>"query", "name"=>"type", "description"=>"Filter by step type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Steps"]}}, "/v2/steps/{id}.json"=>{"get"=>{"summary"=>"Fetch a step", "description"=>"Fetches a step, by ID only.", "operationId"=>"v2.steps.id.json.get", "x-api-path-slug"=>"v2stepsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Step ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Step"]}}, "/v2/successes.json"=>{"get"=>{"summary"=>"List successes", "description"=>"Fetches multiple success records. The records can be filtered, paged, and sorted according to\nthe respective parameters.", "operationId"=>"v2.successes.json.get", "x-api-path-slug"=>"v2successes-json-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"IDs of successes to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: created_at, updated_at, succeeded_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}, {"in"=>"query", "name"=>"updated_at", "description"=>"Equality filters that are applied to the updated_at field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Successes"]}}, "/v2/team.json"=>{"get"=>{"summary"=>"Fetch current team", "description"=>"Fetches the team of the authenticated user.", "operationId"=>"v2.team.json.get", "x-api-path-slug"=>"v2team-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Current", "Team"]}}, "/v2/team_templates.json"=>{"get"=>{"summary"=>"List team templates", "description"=>"Fetches multiple team template records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n\nTeam templates are templates that are available team-wide. Admins may use\nteam templates to create original content for the entire team, monitor version control to ensure templates are always up to date,\nand track template performance across the entire organization. All metrics on a team template reflect usage across the team; individual metrics can be found with the email_templates API endpoint.", "operationId"=>"v2.team_templates.json.get", "x-api-path-slug"=>"v2team-templates-json-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"IDs of team templates to fetch"}, {"in"=>"query", "name"=>"include_paging_counts", "description"=>"Whether to include total_pages and total_count in the metadata"}, {"in"=>"query", "name"=>"page", "description"=>"The current page to fetch results from"}, {"in"=>"query", "name"=>"per_page", "description"=>"How many records to show per page in the range [1, 100]"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Key to sort on, must be one of: created_at, updated_at, last_used_at"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Direction to sort in, must be one of: ASC, DESC"}, {"in"=>"query", "name"=>"updated_at", "description"=>"Equality filters that are applied to the updated_at field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Team", "Templates"]}}, "/v2/team_templates/{id}.json"=>{"get"=>{"summary"=>"Fetch a team template", "description"=>"Fetches a team template, by ID only.", "operationId"=>"v2.team_templates.id.json.get", "x-api-path-slug"=>"v2team-templatesid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Team Template ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "Team", "Template"]}}, "/v2/users.json"=>{"get"=>{"summary"=>"List users", "description"=>"Non Admin: Lists only your user, or all on team depending on group visibility policy\nTeam Admin: Lists users associated with your team", "operationId"=>"v2.users.json.get", "x-api-path-slug"=>"v2users-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "List", "Users"]}}, "/v2/users/{id}.json"=>{"get"=>{"summary"=>"Fetch a user", "description"=>"Fetches a user, by ID only.", "operationId"=>"v2.users.id.json.get", "x-api-path-slug"=>"v2usersid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Fetch", "User"]}}}}, "apis"=>{"name"=>"SalesLoft", "x-slug"=>"salesloft", "description"=>"SalesLoft, the leading sales engagement platform, transforms the way sellers engage with their customers by delivering a better selling experience. Our sales engagement platform helps teams set and execute on a cadence of phone, email, and social communications to convert more target accounts into customer accounts. The platform equips sales leaders with new capabilities to test, learn and adapt to ensure their sales reps execute on the most effective selling process for their account-based approach. SalesLoft delivers access to an extensive ecosystem of 3rd party integrations allowing teams to perform all their sales engagement from a single platform.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/salesloft.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Relative Data,Sales,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"salesloft/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"SalesLoft", "x-api-slug"=>"salesloft", "description"=>"SalesLoft, the leading sales engagement platform, transforms the way sellers engage with their customers by delivering a better selling experience. Our sales engagement platform helps teams set and execute on a cadence of phone, email, and social communications to convert more target accounts into customer accounts. The platform equips sales leaders with new capabilities to test, learn and adapt to ensure their sales reps execute on the most effective selling process for their account-based approach. SalesLoft delivers access to an extensive ecosystem of 3rd party integrations allowing teams to perform all their sales engagement from a single platform.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/salesloft.png", "humanURL"=>"http://salesloft.com", "baseURL"=>"https://api.salesloft.com//", "tags"=>"Relative Data,Sales,Service API", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/salesloft/v2usersid-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/salesloft/salesloft-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://salesloft.com/resources/blog/"}, {"type"=>"x-blog-rss", "url"=>"https://salesloft.com/feed/"}, {"type"=>"x-developer", "url"=>"https://developers.salesloft.com/api.html"}, {"type"=>"x-documentation", "url"=>"https://developers.salesloft.com/api.html#!/Topic/Introduction"}, {"type"=>"x-github", "url"=>"https://github.com/SalesLoft"}, {"type"=>"x-pricing", "url"=>"https://salesloft.com/plans/"}, {"type"=>"x-support", "url"=>"https://salesloft.com/support/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/SalesLoft"}, {"type"=>"x-website", "url"=>"http://salesloft.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
gsa-per-diem-api{"gsa-per-diem-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"GSA Per Diem API", "x-complete"=>1, "info"=>{"title"=>"GSA Per Diem API", "description"=>"per-diem-rates-are-the-allowed-reimbursement-rates-for-hotel-stays-and-meals-for-federal-travelers--rates-are-set-for-each-of-the-federal-governments-fiscal-years-fy-2014-is-october-1-2013-to-september-30-2014--gsa-is-responsible-for-setting-the-rates-in-the-continental-united-states---many-businesses-and-other-organizations-adopt-these-rates-as-well--gsa-is-making-the-rates-available-using-the-ckans-action-api-via-data-gov-to-allow-software-developers-programmatic-access-the-data-and-create-innovative-uses-for-it-", "version"=>"1.0.0"}, "host"=>"inventory.data.gov", "basePath"=>"/api/action/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/datastore_search?resource_id=8ea44bc4-22ba-4386-b84c-1494ab28964b"=>{"get"=>{"summary"=>"Per Diem Rates", "description"=>"GSA sets rates for geographic areas it determines called primary destinations. Areas outside the primary destinations are covered by the same, nation-wide standard rate.", "operationId"=>"getPerDiemRates", "x-api-path-slug"=>"datastore-searchresource-id8ea44bc422ba4386b84c1494ab28964b-get", "parameters"=>[{"in"=>"query", "name"=>"filters", "description"=>"FiscalYear, Zip, State, DestinationID, City, County, Month, Meals", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Per Diem Rates"]}}}}, "apis"=>{"name"=>"GSA Per Diem API", "x-slug"=>"gsa-per-diem-api", "description"=>"Per Diem Rates are the allowed reimbursement rates for hotel stays and meals for federal travelers. Rates are set for each of the federal governments fiscal years (FY 2014 is October 1, 2013 to September 30, 2014.) GSA is responsible for setting the rates in the continental United States. Many businesses and other organizations adopt these rates as well. GSA is making the rates available using the CKANs Action API via Data.gov to allow software developers programmatic access the data and create innovative uses for it.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/gsa-logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Provider,Federal Government GSA,General Data,Profiles", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"gsa-per-diem-api/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"GSA Per Diem API", "x-api-slug"=>"gsa-per-diem-api", "description"=>"Per Diem Rates are the allowed reimbursement rates for hotel stays and meals for federal travelers. Rates are set for each of the federal governments fiscal years (FY 2014 is October 1, 2013 to September 30, 2014.) GSA is responsible for setting the rates in the continental United States. Many businesses and other organizations adopt these rates as well. GSA is making the rates available using the CKANs Action API via Data.gov to allow software developers programmatic access the data and create innovative uses for it.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/gsa-logo.png", "humanURL"=>"http://gsa.gov/portal/content/162379", "baseURL"=>"https://inventory.data.gov//api/action/", "tags"=>"API Provider,Federal Government GSA,General Data,Profiles", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/gsa-per-diem-api/gsa-per-diem-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://gsa.gov/portal/content/162379"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hacker-news{"hacker-news-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Hacker News", "x-complete"=>1, "info"=>{"title"=>"Hacker News", "description"=>"phacker-news-apip", "version"=>"1.0.0"}, "host"=>"hacker-news.firebaseio.com", "basePath"=>"/v0", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/updates.json"=>{"get"=>{"summary"=>"Get the changed items and profiles", "description"=>"Get the changed items and profiles", "operationId"=>"get", "x-api-path-slug"=>"updates-json-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Links", "Stories", "Updates"]}}, "/topstories.json"=>{"get"=>{"summary"=>"Returns the current top 100 stories.", "description"=>"Returns the current top 100 stories.", "operationId"=>"get_top_stories", "x-api-path-slug"=>"topstories-json-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Links", "Stories", "Top"]}}, "/user/{id}.json"=>{"get"=>{"summary"=>"Users are identified by case-sensitive ids", "description"=>"Users are identified by case-sensitive ids", "operationId"=>"get_user", "x-api-path-slug"=>"userid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"User ID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Links", "Stories"]}}, "/maxitem.json"=>{"get"=>{"summary"=>"Get the current largest item id", "description"=>"Get the current largest item id", "operationId"=>"get_max_item", "x-api-path-slug"=>"maxitem-json-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Links", "Stories"]}}, "/item/{id}.json"=>{"get"=>{"summary"=>"Get the Item (story, comment, jobs, Ask HN, etc)", "description"=>"Stories, comments, jobs, Ask HNs and even polls are just items. They're identified by their ids, which are unique integers.", "operationId"=>"get_item", "x-api-path-slug"=>"itemid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Item ID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Links", "Stories"]}}}}, "apis"=>{"name"=>"Hacker News", "x-slug"=>"hacker-news", "description"=>"Hacker News is a social news website focusing on computer science and entrepreneurship. It is run by Paul Grahams investment fund and startup incubator, Y Combinator.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/hn-246x0w.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"", "tags"=>"Bookmarks,Curation,General Data,Links,SDIO Syndication", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"hacker-news/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Hacker News", "x-api-slug"=>"hacker-news", "description"=>"Hacker News is a social news website focusing on computer science and entrepreneurship. It is run by Paul Grahams investment fund and startup incubator, Y Combinator.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/hn-246x0w.jpg", "humanURL"=>"https://news.ycombinator.com/", "baseURL"=>"https://hacker-news.firebaseio.com//v0", "tags"=>"Bookmarks,Curation,General Data,Links,SDIO Syndication", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/hacker-news/itemid-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/hacker-news/hacker-news-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-twitter", "url"=>"https://twitter.com/newsycombinator"}, {"type"=>"x-developer", "url"=>"https://github.com/HackerNews/API"}, {"type"=>"x-github", "url"=>"https://github.com/HackerNews"}, {"type"=>"x-website", "url"=>"https://news.ycombinator.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-people{"google-people-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google People", "x-complete"=>1, "info"=>{"title"=>"Google People", "description"=>"provides-access-to-information-about-profiles-and-contacts-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"people.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/people:batchGet"=>{"get"=>{"summary"=>"Get People", "description"=>"Provides information about a list of specific people by specifying a list\nof requested resource names. Use `people/me` to indicate the authenticated\nuser.", "operationId"=>"people.people.getBatchGet", "x-api-path-slug"=>"v1peoplebatchget-get", "parameters"=>[{"in"=>"query", "name"=>"requestMask.includeField", "description"=>"Comma-separated list of fields to be included in the response"}, {"in"=>"query", "name"=>"resourceNames", "description"=>"The resource name, such as one returned by[`people"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People"]}}, "/v1/{resourceName}"=>{"get"=>{"summary"=>"Get Person", "description"=>"Provides information about a person resource for a resource name. Use\n`people/me` to indicate the authenticated user.", "operationId"=>"people.people.get", "x-api-path-slug"=>"v1resourcename-get", "parameters"=>[{"in"=>"query", "name"=>"requestMask.includeField", "description"=>"Comma-separated list of fields to be included in the response"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The resource name of the person to provide information about"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People"]}}, "/v1/{resourceName}/connections"=>{"get"=>{"summary"=>"Get Connections", "description"=>"Provides a list of the authenticated user's contacts merged with any\nlinked profiles.", "operationId"=>"people.people.connections.list", "x-api-path-slug"=>"v1resourcenameconnections-get", "parameters"=>[{"in"=>"query", "name"=>"pageSize", "description"=>"The number of connections to include in the response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token of the page to be returned"}, {"in"=>"query", "name"=>"requestMask.includeField", "description"=>"Comma-separated list of fields to be included in the response"}, {"in"=>"query", "name"=>"requestSyncToken", "description"=>"Whether the response should include a sync token, which can be used to getall changes since the last request"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The resource name to return connections for"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"The order in which the connections should be sorted"}, {"in"=>"query", "name"=>"syncToken", "description"=>"A sync token, returned by a previous call to `people"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connection"]}}}}, "apis"=>{"name"=>"Google People", "x-slug"=>"google-people", "description"=>"The People API lets you list authenticated users Contacts and retrieve profile information for authenticated users and their contacts. For example, lets say the authenticated user, Jen, has Fabian and Ranjith in her private contacts. When your app calls people.connections.list to retrieve a list of her connections, Jen is presented with a consent screen asking to give the app access to the list. If Jen consents, the app retrieves a list containing Fabian and Ranjith (with a resource name for each person). The app can then call people.get, passing in a resource name, to get private contact and public profile data for each person.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-people.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,People,Profiles,Relative Data,Service API,Stack Network,Users", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-people/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google People API", "x-api-slug"=>"google-people-api", "description"=>"The People API lets you list authenticated users Contacts and retrieve profile information for authenticated users and their contacts. For example, lets say the authenticated user, Jen, has Fabian and Ranjith in her private contacts. When your app calls people.connections.list to retrieve a list of her connections, Jen is presented with a consent screen asking to give the app access to the list. If Jen consents, the app retrieves a list containing Fabian and Ranjith (with a resource name for each person). The app can then call people.get, passing in a resource name, to get private contact and public profile data for each person.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-people.png", "humanURL"=>"https://developers.google.com/people/", "baseURL"=>"://people.googleapis.com//", "tags"=>"API Provider,API Service Provider,Google APIs,People,Profiles,Relative Data,Service API,Stack Network,Users", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/google-people/v1resourcenameconnections-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/google-people/google-people-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-code", "url"=>"https://developers.google.com/people/v1/libraries"}, {"type"=>"x-terms-of-service", "url"=>"https://developers.google.com/people/terms"}, {"type"=>"x-website", "url"=>"https://developers.google.com/people/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
reviewshake{"reviewshake-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Reviewshake", "x-complete"=>1, "info"=>{"title"=>"Reviewshake API", "description"=>"welcome-to-the-reviewshake-api-documentation-where-you-will-find-all-details-required-to-interact-with-our-api-in-order-to-make-calls-you-will-need-two-pieces-of-information1--your-reviewshake-subdomain-eg--demo-reviewshake-com2--your-api-key-see-the-authentication-section-below--authenticationyour-account-will-have-a-unique-api-key-associated-with-it-which-can-be-found-under--configurations----general-settings--in-your-dashboard-", "version"=>"1.0"}, "host"=>"subdomain.reviewshake.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/order"=>{"post"=>{"summary"=>"Create order", "description"=>"Creating orders in Reviewshake allows you to automate the sending of review invitations. You can setup this automation in your dashboard by visiting *Review Invitations* -> *Triggers*.\n\nSet the *Trigger* as *Order created*, and you can then setup the trigger options such as templates and subject lines to use as well as delays.", "operationId"=>"OrderPost", "x-api-path-slug"=>"order-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"X-Spree-Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order"]}}, "/widgets"=>{"get"=>{"summary"=>"List widgets", "description"=>"List widgets.", "operationId"=>"WidgetsGet", "x-api-path-slug"=>"widgets-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"X-Spree-Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Widgets"]}, "post"=>{"summary"=>"Create widget", "description"=>"You can create the following widget types:\n\n1. List\n2. Caroussel\n3. Slider\n4. Grid\n5. Quote", "operationId"=>"WidgetsPost", "x-api-path-slug"=>"widgets-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"X-Spree-Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Widget"]}}, "/widgets/1"=>{"get"=>{"summary"=>"View widget", "description"=>"View widget.", "operationId"=>"Widgets1Get", "x-api-path-slug"=>"widgets1-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"X-Spree-Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "Widget"]}}, "/widgets/ |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
botify{"botify-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Botify", "x-complete"=>1, "info"=>{"title"=>"Botify", "description"=>"botify-saas-api", "version"=>"1.0.0"}, "host"=>"api.botify.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/analyses/{username}/{project_slug}"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug", "description"=>"Get analyses username project slug.", "operationId"=>"getAnalysesUsernameProjectSlug", "x-api-path-slug"=>"analysesusernameproject-slug-get", "parameters"=>[{"in"=>"query", "name"=>"only_success", "description"=>"Return only successfully finished analyses"}, {"in"=>"query", "name"=>"page", "description"=>"Page Number"}, {"in"=>"query", "name"=>"size", "description"=>"Page Size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug", "description"=>"Parameters analyses username project slug.", "operationId"=>"parametersAnalysesUsernameProjectSlug", "x-api-path-slug"=>"analysesusernameproject-slug-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug", "description"=>"Get analyses username project slug analysis slug.", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlug", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slug-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug", "description"=>"Parameters analyses username project slug analysis slug.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlug", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slug-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug Crawl Statistics", "description"=>"Get analyses username project slug analysis slug crawl statistics.", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlugCrawlStatistics", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugcrawl-statistics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Crawl", "Statistics"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Crawl Statistics", "description"=>"Parameters analyses username project slug analysis slug crawl statistics.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugCrawlStatistics", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugcrawl-statistics-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Crawl", "Statistics"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics/time"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug Crawl Statistics Time", "description"=>"Return crawl statistics grouped by time frequency (1 min, 5 mins or 60 min) for an analysis", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlugCrawlStatisticsTime", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugcrawl-statisticstime-get", "parameters"=>[{"in"=>"query", "name"=>"frequency", "description"=>"Aggregation frequency"}, {"in"=>"query", "name"=>"limit", "description"=>"max number of elements to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Crawl", "Statistics", "Time"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Crawl Statistics Time", "description"=>"Parameters analyses username project slug analysis slug crawl statistics time.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugCrawlStatisticsTime", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugcrawl-statisticstime-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Crawl", "Statistics", "Time"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics/urls/{list_type}"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug Crawl Statistics Urls List Type", "description"=>"Return a list of 1000 latest URLs crawled (all crawled URLs or only URLS with HTTP errors)", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlugCrawlStatisticsUrlsListType", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugcrawl-statisticsurlslist-type-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Crawl", "Statistics", "Urls", "List", "Type"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Crawl Statistics Urls List Type", "description"=>"Parameters analyses username project slug analysis slug crawl statistics urls list type.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugCrawlStatisticsUrlsListType", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugcrawl-statisticsurlslist-type-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Crawl", "Statistics", "Urls", "List", "Type"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/features/ganalytics/orphan_urls/{medium}/{source}"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug Features Ganalytics Orphan Urls Medium Source", "description"=>"Legacy List of Orphan URLs. URLs which generated visits from the selected source according to Google Analytics data, but were not crawled with by the Botify crawler (either because no links to them were found on the website, or because the crawler was not allowed to follow these links according to the project settings). For a search engine (medium: origanic; sources: all, aol, ask, baidu, bing, google, naver, yahoo, yandex) or a social network (medium: social; sources: all, facebook, google+, linkedin, pinterest, reddit, tumblr, twitter)", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlugFeaturesGanalyticsOrphanUrlsMediumSource", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeaturesganalyticsorphan-urlsmediumsource-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Page Number"}, {"in"=>"query", "name"=>"size", "description"=>"Page Size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Ganalytics", "Orphan", "Urls", "Medium", "Source"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Features Ganalytics Orphan Urls Medium Source", "description"=>"Parameters analyses username project slug analysis slug features ganalytics orphan urls medium source.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugFeaturesGanalyticsOrphanUrlsMediumSource", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeaturesganalyticsorphan-urlsmediumsource-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Ganalytics", "Orphan", "Urls", "Medium", "Source"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/features/links/percentiles"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug Features Links Percentiles", "description"=>"Get analyses username project slug analysis slug features links percentiles.", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlugFeaturesLinksPercentiles", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeatureslinkspercentiles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Links", "Percentiles"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Features Links Percentiles", "description"=>"Parameters analyses username project slug analysis slug features links percentiles.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugFeaturesLinksPercentiles", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeatureslinkspercentiles-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Links", "Percentiles"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/features/pagerank/lost"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug Features Pagerank Lost", "description"=>"Get analyses username project slug analysis slug features pagerank lost.", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlugFeaturesPagerankLost", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeaturespageranklost-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Pagerank", "Lost"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Features Pagerank Lost", "description"=>"Parameters analyses username project slug analysis slug features pagerank lost.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugFeaturesPagerankLost", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeaturespageranklost-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Pagerank", "Lost"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/report"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug Features Sitemaps Report", "description"=>"Get global information of the sitemaps found (sitemaps indexes, invalid sitemaps urls, etc.)", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlugFeaturesSitemapsReport", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeaturessitemapsreport-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Sitemaps", "Report"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Features Sitemaps Report", "description"=>"Parameters analyses username project slug analysis slug features sitemaps report.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugFeaturesSitemapsReport", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeaturessitemapsreport-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Sitemaps", "Report"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/samples/out_of_config"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug Features Sitemaps Samples Out Of Config", "description"=>"Sample list of URLs which were found in your sitemaps but outside of the crawl perimeter defined for the project, for instance domain/subdomain or protocol (HTTP/HTTPS) not allowed in the crawl settings.", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlugFeaturesSitemapsSamplesOutOfConfig", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeaturessitemapssamplesout-of-config-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Page Number"}, {"in"=>"query", "name"=>"size", "description"=>"Page Size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Sitemaps", "Samples", "Out", "Of", "Config"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Features Sitemaps Samples Out Of Config", "description"=>"Parameters analyses username project slug analysis slug features sitemaps samples out of config.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugFeaturesSitemapsSamplesOutOfConfig", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeaturessitemapssamplesout-of-config-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Sitemaps", "Samples", "Out", "Of", "Config"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/samples/sitemap_only"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug Features Sitemaps Samples Sitemap Only", "description"=>"Sample list of URLs which were found in your sitemaps, within the project allowed scope (allowed domains/subdomains/protocols), but not found by the Botify crawler.", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlugFeaturesSitemapsSamplesSitemapOnly", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeaturessitemapssamplessitemap-only-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Page Number"}, {"in"=>"query", "name"=>"size", "description"=>"Page Size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Sitemaps", "Samples", "Sitemap", "Only"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Features Sitemaps Samples Sitemap Only", "description"=>"Parameters analyses username project slug analysis slug features sitemaps samples sitemap only.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugFeaturesSitemapsSamplesSitemapOnly", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeaturessitemapssamplessitemap-only-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Sitemaps", "Samples", "Sitemap", "Only"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/features/top_domains/domains"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug Features Top Domains Domains", "description"=>"Get analyses username project slug analysis slug features top domains domains.", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlugFeaturesTopDomainsDomains", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeaturestop-domainsdomains-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Page Number"}, {"in"=>"query", "name"=>"size", "description"=>"Page Size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Top", "Domains", "Domains"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Features Top Domains Domains", "description"=>"Parameters analyses username project slug analysis slug features top domains domains.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugFeaturesTopDomainsDomains", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeaturestop-domainsdomains-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Top", "Domains", "Domains"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/features/top_domains/subdomains"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug Features Top Domains Subdomains", "description"=>"Get analyses username project slug analysis slug features top domains subdomains.", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlugFeaturesTopDomainsSubdomains", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeaturestop-domainssubdomains-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Page Number"}, {"in"=>"query", "name"=>"size", "description"=>"Page Size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Top", "Domains", "Subdomains"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Features Top Domains Subdomains", "description"=>"Parameters analyses username project slug analysis slug features top domains subdomains.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugFeaturesTopDomainsSubdomains", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeaturestop-domainssubdomains-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Top", "Domains", "Subdomains"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/features/visits/orphan_urls/{medium}/{source}"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug Features Visits Orphan Urls Medium Source", "description"=>"List of Orphan URLs. URLs which generated visits from the selected source according to Google Analytics data, but were not crawled with by the Botify crawler (either because no links to them were found on the website, or because the crawler was not allowed to follow these links according to the project settings). For a search engine (medium: origanic; sources: all, aol, ask, baidu, bing, google, naver, yahoo, yandex) or a social network (medium: social; sources: all, facebook, google+, linkedin, pinterest, reddit, tumblr, twitter)", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlugFeaturesVisitsOrphanUrlsMediumSource", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeaturesvisitsorphan-urlsmediumsource-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Page Number"}, {"in"=>"query", "name"=>"size", "description"=>"Page Size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Visits", "Orphan", "Urls", "Medium", "Source"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Features Visits Orphan Urls Medium Source", "description"=>"Parameters analyses username project slug analysis slug features visits orphan urls medium source.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugFeaturesVisitsOrphanUrlsMediumSource", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugfeaturesvisitsorphan-urlsmediumsource-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Features", "Visits", "Orphan", "Urls", "Medium", "Source"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/urls"=>{"parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Urls", "description"=>"Parameters analyses username project slug analysis slug urls.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugUrls", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugurls-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Urls"]}, "post"=>{"summary"=>"Post Analyses Username Project Slug Analysis Slug Urls", "description"=>"Post analyses username project slug analysis slug urls.", "operationId"=>"postAnalysesUsernameProjectSlugAnalysisSlugUrls", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugurls-post", "parameters"=>[{"in"=>"query", "name"=>"area", "description"=>"Analysis context"}, {"in"=>"query", "name"=>"page", "description"=>"Page Number"}, {"in"=>"query", "name"=>"size", "description"=>"Page Size"}, {"in"=>"body", "name"=>"UrlsQuery", "description"=>"Urls query", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Urls"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/urls/aggs"=>{"parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Urls Aggs", "description"=>"Parameters analyses username project slug analysis slug urls aggs.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugUrlsAggs", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugurlsaggs-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Urls", "Aggs"]}, "post"=>{"summary"=>"Post Analyses Username Project Slug Analysis Slug Urls Aggs", "description"=>"Post analyses username project slug analysis slug urls aggs.", "operationId"=>"postAnalysesUsernameProjectSlugAnalysisSlugUrlsAggs", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugurlsaggs-post", "parameters"=>[{"in"=>"query", "name"=>"area", "description"=>"Analysis context"}, {"in"=>"body", "name"=>"UrlsAggsQueries", "description"=>"UrlsAggs queries", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Urls", "Aggs"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/urls/datamodel"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug Urls Datamodel", "description"=>"Get analyses username project slug analysis slug urls datamodel.", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlugUrlsDatamodel", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugurlsdatamodel-get", "parameters"=>[{"in"=>"query", "name"=>"area", "description"=>"Analysis context"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Urls", "Datamodel"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Urls Datamodel", "description"=>"Parameters analyses username project slug analysis slug urls datamodel.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugUrlsDatamodel", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugurlsdatamodel-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Urls", "Datamodel"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/urls/export"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug Urls Export", "description"=>"Get analyses username project slug analysis slug urls export.", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlugUrlsExport", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugurlsexport-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Page Number"}, {"in"=>"query", "name"=>"size", "description"=>"Page Size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Urls", "Export"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Urls Export", "description"=>"Parameters analyses username project slug analysis slug urls export.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugUrlsExport", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugurlsexport-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Urls", "Export"]}, "post"=>{"summary"=>"Post Analyses Username Project Slug Analysis Slug Urls Export", "description"=>"Creates a new UrlExport object and starts a task that will export the results into a csv. Returns the model id that manages the task", "operationId"=>"postAnalysesUsernameProjectSlugAnalysisSlugUrlsExport", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugurlsexport-post", "parameters"=>[{"in"=>"query", "name"=>"area", "description"=>"Analysis context"}, {"in"=>"body", "name"=>"UrlsQuery", "description"=>"Urls query", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Urls", "Export"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/urls/export/{url_export_id}"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug Urls Export Url Export", "description"=>"Checks the status of an CSVUrlExportJob object. Returns json object with the status.", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlugUrlsExportUrlExport", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugurlsexporturl-export-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Urls", "Export", "Url", "Export", "Id"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Urls Export Url Export", "description"=>"Parameters analyses username project slug analysis slug urls export url export.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugUrlsExportUrlExport", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugurlsexporturl-export-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Urls", "Export", "Url", "Export", "Id"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/urls/suggested_filters"=>{"parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Urls Suggested Filters", "description"=>"Parameters analyses username project slug analysis slug urls suggested filters.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugUrlsSuggestedFilters", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugurlssuggested-filters-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Urls", "Suggested", "Filters"]}, "post"=>{"summary"=>"Post Analyses Username Project Slug Analysis Slug Urls Suggested Filters", "description"=>"Return most frequent segments (= suggested patterns in the previous version) for a Botify Query.", "operationId"=>"postAnalysesUsernameProjectSlugAnalysisSlugUrlsSuggestedFilters", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugurlssuggested-filters-post", "parameters"=>[{"in"=>"query", "name"=>"area", "description"=>"Analysis context"}, {"in"=>"body", "name"=>"UrlsAggsQuery", "description"=>"UrlsAggs query", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Urls", "Suggested", "Filters"]}}, "/analyses/{username}/{project_slug}/{analysis_slug}/urls/{url}"=>{"get"=>{"summary"=>"Get Analyses Username Project Slug Analysis Slug Urls Url", "description"=>"Get analyses username project slug analysis slug urls url.", "operationId"=>"getAnalysesUsernameProjectSlugAnalysisSlugUrlsUrl", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugurlsurl-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"comma separated list of fields to return (c"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Urls", "Url"]}, "parameters"=>{"summary"=>"Parameters Analyses Username Project Slug Analysis Slug Urls Url", "description"=>"Parameters analyses username project slug analysis slug urls url.", "operationId"=>"parametersAnalysesUsernameProjectSlugAnalysisSlugUrlsUrl", "x-api-path-slug"=>"analysesusernameproject-sluganalysis-slugurlsurl-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Username", "Project", "Slug", "Analysis", "Slug", "Urls", "Url"]}}, "/projects/{username}"=>{"get"=>{"summary"=>"Get Projects Username", "description"=>"List all active projects for the user", "operationId"=>"getProjectsUsername", "x-api-path-slug"=>"projectsusername-get", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"Projects name"}, {"in"=>"query", "name"=>"page", "description"=>"Page Number"}, {"in"=>"query", "name"=>"size", "description"=>"Page Size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Username"]}, "parameters"=>{"summary"=>"Parameters Projects Username", "description"=>"Parameters projects username.", "operationId"=>"parametersProjectsUsername", "x-api-path-slug"=>"projectsusername-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Username"]}}, "/projects/{username}/{project_slug}/filters"=>{"get"=>{"summary"=>"Get Projects Username Project Slug Filters", "description"=>"List all the project's saved filters (each filter's name, ID and filter value)", "operationId"=>"getProjectsUsernameProjectSlugFilters", "x-api-path-slug"=>"projectsusernameproject-slugfilters-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Page Number"}, {"in"=>"query", "name"=>"size", "description"=>"Page Size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Username", "Project", "Slug", "Filters"]}, "parameters"=>{"summary"=>"Parameters Projects Username Project Slug Filters", "description"=>"Parameters projects username project slug filters.", "operationId"=>"parametersProjectsUsernameProjectSlugFilters", "x-api-path-slug"=>"projectsusernameproject-slugfilters-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Username", "Project", "Slug", "Filters"]}}, "/projects/{username}/{project_slug}/filters/{identifier}"=>{"get"=>{"summary"=>"Get Projects Username Project Slug Filters Entifier", "description"=>"Retrieves a specific saved filter's name, ID and filter value", "operationId"=>"getProjectsUsernameProjectSlugFiltersEntifier", "x-api-path-slug"=>"projectsusernameproject-slugfiltersidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Username", "Project", "Slug", "Filters", "Identifier"]}, "parameters"=>{"summary"=>"Parameters Projects Username Project Slug Filters Entifier", "description"=>"Parameters projects username project slug filters entifier.", "operationId"=>"parametersProjectsUsernameProjectSlugFiltersEntifier", "x-api-path-slug"=>"projectsusernameproject-slugfiltersidentifier-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Username", "Project", "Slug", "Filters", "Identifier"]}}, "/projects/{username}/{project_slug}/urls/aggs"=>{"parameters"=>{"summary"=>"Parameters Projects Username Project Slug Urls Aggs", "description"=>"Parameters projects username project slug urls aggs.", "operationId"=>"parametersProjectsUsernameProjectSlugUrlsAggs", "x-api-path-slug"=>"projectsusernameproject-slugurlsaggs-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Username", "Project", "Slug", "Urls", "Aggs"]}, "post"=>{"summary"=>"Post Projects Username Project Slug Urls Aggs", "description"=>"Project Query aggregator. It accepts multiple queries that will be executed on all completed analyses in the project", "operationId"=>"postProjectsUsernameProjectSlugUrlsAggs", "x-api-path-slug"=>"projectsusernameproject-slugurlsaggs-post", "parameters"=>[{"in"=>"query", "name"=>"area", "description"=>"Analyses context"}, {"in"=>"query", "name"=>"last_analysis_slug", "description"=>"Last analysis on the trend"}, {"in"=>"query", "name"=>"nb_analyses", "description"=>"Max number of analysis to return"}, {"in"=>"body", "name"=>"UrlsAggsQueries", "description"=>"UrlsAggs queries", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Username", "Project", "Slug", "Urls", "Aggs"]}}}}, "apis"=>{"name"=>"Botify", "x-slug"=>"botify", "description"=>"We are passionate about SEO. Botify offers unparalleled insights into your websites SEO through crawl data and log analysis. Optimize your website and see the organic traffic results youve been seeking. Founded in 2012, Botify is a SaaS SEO platfo...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28561-botify.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"274018", "tags"=>"API Provider,API Service Provider,Bots,Enterprise,internet,Profiles,Relative Data,SaaS,Search,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"botify/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Botify", "x-api-slug"=>"botify", "description"=>"We are passionate about SEO. Botify offers unparalleled insights into your websites SEO through crawl data and log analysis. Optimize your website and see the organic traffic results youve been seeking. Founded in 2012, Botify is a SaaS SEO platfo...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28561-botify.jpg", "humanURL"=>"http://www.botify.com", "baseURL"=>"https://api.botify.com//v1", "tags"=>"API Provider,API Service Provider,Bots,Enterprise,internet,Profiles,Relative Data,SaaS,Search,Service API,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/botify/botify-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://www.botify.com"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/botify"}, {"type"=>"x-developer", "url"=>"https://developers.botify.com/api/"}, {"type"=>"x-email", "url"=>"jobs@botify.com"}, {"type"=>"x-email", "url"=>"privacy@botify.com"}, {"type"=>"x-email", "url"=>"hello@botify.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/botify"}, {"type"=>"x-website", "url"=>"http://botify.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
opendns{"opendns-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"OpenDNS", "x-complete"=>1, "info"=>{"title"=>"OpenDNS", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/networkdevices"=>{"post"=>{"summary"=>"Network Devices", "description"=>"The Network Device Registration API provides a way for networking hardware vendors to integrate their network devices with the OpenDNS Umbrella Dashboard.", "operationId"=>"networkDevices", "x-api-path-slug"=>"networkdevices-post", "parameters"=>[{"in"=>"query", "name"=>"macAddress", "description"=>"The MAC address of the device (formatted as 12 characters, no hyphens or colons)", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"label", "description"=>"A label for the device; this is how the device will be designated in the customer???s Umbrella dashboard", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"model", "description"=>"The model name of the device", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"serialNumber", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"tag", "description"=>"A text tag that describes the device (or this particular origin assigned to the device)", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Devices"]}}, "/domains/categories/"=>{"get"=>{"summary"=>"Domain Status and Categorization", "description"=>"This API method returns the domain status, which the quickest and easiest way to know whether a domain has been flagged as malicious by the OpenDNS Security Labs team (score of -1 for status), if it is believed to be safe (score of 1), or if it has yet to be given a status (score of 0).", "operationId"=>"domainStatus", "x-api-path-slug"=>"domainscategories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/domains/score/{domain}"=>{"get"=>{"summary"=>"Domain Scores", "description"=>"This API method is the quickest and easiest way to know whether a domain has been flagged as malicious by the OpenDNS security team (score of -1), if it is believed to be safe (score of 1), or if it hasn't been categorized yet (score of 0).", "operationId"=>"domainScore", "x-api-path-slug"=>"domainsscoredomain-get", "parameters"=>[{"in"=>"path", "name"=>"domain", "description"=>"Domain Name", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domain Score"]}}, "/search/"=>{"get"=>{"summary"=>"Pattern Search", "description"=>"To perform a pattern search in the API, use the /search/ endpoint, append a RegEx pattern search to the API query and a start time.", "operationId"=>"patternSearch", "x-api-path-slug"=>"search-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pattern Search"]}}, "/recommendations/{name}/"=>{"get"=>{"summary"=>"Co-Occurrences for a Domain", "description"=>"This API method returns a list of co-occurences for the specified domain. A co-occurrence is when two or more domains are being accessed by the same users within a small window of time. Being a co-occurrence isn't necessarily a bad thing, legitimate sites co-occur with each other as a part of normal web activity. However, unusual or suspicious co-occurence can provide additional information regarding attacks.", "operationId"=>"coOccurrencesDomain", "x-api-path-slug"=>"recommendationsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Domain Name", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/links/{name}/"=>{"get"=>{"summary"=>"Related Domains", "description"=>"This API method returns a list of domain names that have been frequently seen requested b around the same time (up to 60 seconds before or after) as the given domain name, but that are not frequently associated with other domain names.", "operationId"=>"relatedDomains", "x-api-path-slug"=>"linksname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Domain Name", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Related Domains"]}}, "/security/{name}/"=>{"get"=>{"summary"=>"Security Information", "description"=>"The security information API method contains multiple scores or security features, each of which can be used to determine relevant datapoints to build insight on the reputation or security risk posed by the site. No one security information feature is conclusive, instead these features should be looked at in conjunction with one another as part of your security research.", "operationId"=>"securityInformation", "x-api-path-slug"=>"securityname-get", "parameters"=>[{"in"=>"path", "name"=>"Domain Name", "description"=>"Domain Name", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security"]}}, "/domains/{name}/latest_tags"=>{"get"=>{"summary"=>"Tagging", "description"=>"This endpoint returns the date range when the domain being queried was a part of the OpenDNS block list. A common use case is to find how long a domain has been in the block list for domains being blocked currently. However it will also show a record of the history of the domain in the OpenDNS blocklis", "operationId"=>"domainTagging", "x-api-path-slug"=>"domainsnamelatest-tags-get", "parameters"=>[{"in"=>"path", "name"=>"Domain Name", "description"=>"Domain Name", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/dnsdb/{name}/a/"=>{"get"=>{"summary"=>"DNS RR History", "description"=>"The DNS database can be used to query the history that OpenDNS has seen for a given domain.", "operationId"=>"rrHistory", "x-api-path-slug"=>"dnsdbnamea-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Domain Name", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["History"]}}, "/bgp_routes/ip/{ip}/"=>{"get"=>{"summary"=>"IP Address History", "description"=>"To help better understand how IP addresses are related to each other and to the regional registries, the API can provide data about ASN and IP relationships. You can also find out more about the IP space associated with an AS with this endpoint and correlate BGP routing information between AS.", "operationId"=>"ipAddressHistory", "x-api-path-slug"=>"bgp-routesipip-get", "parameters"=>[{"in"=>"path", "name"=>"ip", "description"=>"The IP Address", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Address"]}}, "/whois/emails/"=>{"get"=>{"summary"=>"Whois", "description"=>"This API method returns the WHOIS information for the specified email address(es), nameserver(s) and domains. You can also search by multiple email addresses or multiple nameservers.", "operationId"=>"whois", "x-api-path-slug"=>"whoisemails-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Whois"]}}, "/ips/{ip}/latest_domains"=>{"get"=>{"summary"=>"Latest Malicious Domains", "description"=>"The latest_domains endpoint shows whether the IP address you???ve entered as input has any known malicious domains associated with it.", "operationId"=>"latestMaliciousDomains", "x-api-path-slug"=>"ipsiplatest-domains-get", "parameters"=>[{"in"=>"path", "name"=>"ip", "description"=>"The IP Address", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Malicious Domains"]}}, "/events"=>{"put"=>{"summary"=>"Post Event", "description"=>"Posts a Malware event to the API for processing and optionally adding to a customer's domain lists.", "operationId"=>"postEvent", "x-api-path-slug"=>"events-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/domains"=>{"get"=>{"summary"=>"Get Domains", "description"=>"To gather the lists of domains already added to the shared customer???s domain list, run a GET request against the domains endpoint of the API.", "operationId"=>"getDomains", "x-api-path-slug"=>"domains-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}, "delete"=>{"summary"=>"Delete Domain", "description"=>"To delete a domain from the shared customer???s domain list, run a DELETE request against the domains endpoint of the API.", "operationId"=>"deleteDomain", "x-api-path-slug"=>"domains-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}}}, "apis"=>{"name"=>"OpenDNS", "x-slug"=>"opendns", "description"=>"OpenDNS was founded in 2006 and acquired by Cisco in 2015. Today, more than 12,000 business worldwide rely on our enterprise security products. Cisco Umbrella is a cloud security platform that provides the first line of defense against threats on the i...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20022-opendns.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"4178", "tags"=>"DNS,DNS New,Enterprise,internet,ISP,Networks,Relative Data,SaaS,Security,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"opendns/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"OpenDNS", "x-api-slug"=>"opendns", "description"=>"OpenDNS was founded in 2006 and acquired by Cisco in 2015. Today, more than 12,000 business worldwide rely on our enterprise security products. Cisco Umbrella is a cloud security platform that provides the first line of defense against threats on the i...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20022-opendns.jpg", "humanURL"=>"https://www.opendns.com/", "baseURL"=>"https:///", "tags"=>"DNS,DNS New,Enterprise,internet,ISP,Networks,Relative Data,SaaS,Security,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/opendns/domains-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/opendns/opendns-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://blog.opendns.com/"}, {"type"=>"x-blog-rss", "url"=>"https://blog.opendns.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/opendns"}, {"type"=>"x-developer", "url"=>"https://docs.opendns.com/"}, {"type"=>"x-email", "url"=>"support@opendns.com"}, {"type"=>"x-github", "url"=>"https://github.com/opendns"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/OpenDNS"}, {"type"=>"x-website", "url"=>"https://www.opendns.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-deployment-manager{"google-cloud-deployment-manager-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Deployment Manager", "x-complete"=>1, "info"=>{"title"=>"Google Cloud Deployment Manager", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{project}/global/deployments"=>{"get"=>{"summary"=>"Get Deployments", "description"=>"Lists all deployments for a given project.", "operationId"=>"deploymentmanager.deployments.list", "x-api-path-slug"=>"projectglobaldeployments-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment"]}, "post"=>{"summary"=>"Create Deployment", "description"=>"Creates a deployment and all of the resources described by the deployment manifest.", "operationId"=>"deploymentmanager.deployments.insert", "x-api-path-slug"=>"projectglobaldeployments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"preview", "description"=>"If set to true, creates a deployment and creates shell resources but does not actually instantiate these resources"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment"]}}, "/{project}/global/deployments/{deployment}"=>{"delete"=>{"summary"=>"Delete Deployment", "description"=>"Deletes a deployment and all of the resources in the deployment.", "operationId"=>"deploymentmanager.deployments.delete", "x-api-path-slug"=>"projectglobaldeploymentsdeployment-delete", "parameters"=>[{"in"=>"query", "name"=>"deletePolicy", "description"=>"Sets the policy to use for deleting resources"}, {"in"=>"path", "name"=>"deployment", "description"=>"The name of the deployment for this request"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment"]}, "get"=>{"summary"=>"Get Deployment", "description"=>"Gets information about a specific deployment.", "operationId"=>"deploymentmanager.deployments.get", "x-api-path-slug"=>"projectglobaldeploymentsdeployment-get", "parameters"=>[{"in"=>"path", "name"=>"deployment", "description"=>"The name of the deployment for this request"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment"]}, "patch"=>{"summary"=>"update Deployment", "description"=>"Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.", "operationId"=>"deploymentmanager.deployments.patch", "x-api-path-slug"=>"projectglobaldeploymentsdeployment-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"createPolicy", "description"=>"Sets the policy to use for creating new resources"}, {"in"=>"query", "name"=>"deletePolicy", "description"=>"Sets the policy to use for deleting resources"}, {"in"=>"path", "name"=>"deployment", "description"=>"The name of the deployment for this request"}, {"in"=>"query", "name"=>"preview", "description"=>"If set to true, updates the deployment and creates and updates the shell resources but does not actually alter or instantiate these resources"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment"]}, "put"=>{"summary"=>"update Deployment", "description"=>"Updates a deployment and all of the resources described by the deployment manifest.", "operationId"=>"deploymentmanager.deployments.update", "x-api-path-slug"=>"projectglobaldeploymentsdeployment-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"createPolicy", "description"=>"Sets the policy to use for creating new resources"}, {"in"=>"query", "name"=>"deletePolicy", "description"=>"Sets the policy to use for deleting resources"}, {"in"=>"path", "name"=>"deployment", "description"=>"The name of the deployment for this request"}, {"in"=>"query", "name"=>"preview", "description"=>"If set to true, updates the deployment and creates and updates the shell resources but does not actually alter or instantiate these resources"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment"]}}, "/{project}/global/deployments/{deployment}/cancelPreview"=>{"post"=>{"summary"=>"Cancel Preview", "description"=>"Cancels and removes the preview currently associated with the deployment.", "operationId"=>"deploymentmanager.deployments.cancelPreview", "x-api-path-slug"=>"projectglobaldeploymentsdeploymentcancelpreview-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"deployment", "description"=>"The name of the deployment for this request"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment"]}}, "/{project}/global/deployments/{deployment}/manifests"=>{"get"=>{"summary"=>"List Manifests", "description"=>"Lists all manifests for a given deployment.", "operationId"=>"deploymentmanager.manifests.list", "x-api-path-slug"=>"projectglobaldeploymentsdeploymentmanifests-get", "parameters"=>[{"in"=>"path", "name"=>"deployment", "description"=>"The name of the deployment for this request"}, {"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Manifest"]}}, "/{project}/global/deployments/{deployment}/manifests/{manifest}"=>{"get"=>{"summary"=>"Get Manifest", "description"=>"Gets information about a specific manifest.", "operationId"=>"deploymentmanager.manifests.get", "x-api-path-slug"=>"projectglobaldeploymentsdeploymentmanifestsmanifest-get", "parameters"=>[{"in"=>"path", "name"=>"deployment", "description"=>"The name of the deployment for this request"}, {"in"=>"path", "name"=>"manifest", "description"=>"The name of the manifest for this request"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Manifest"]}}, "/{project}/global/deployments/{deployment}/resources"=>{"get"=>{"summary"=>"List Resources", "description"=>"Lists all resources in a given deployment.", "operationId"=>"deploymentmanager.resources.list", "x-api-path-slug"=>"projectglobaldeploymentsdeploymentresources-get", "parameters"=>[{"in"=>"path", "name"=>"deployment", "description"=>"The name of the deployment for this request"}, {"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource"]}}, "/{project}/global/deployments/{deployment}/resources/{resource}"=>{"get"=>{"summary"=>"Get Resource", "description"=>"Gets information about a single resource.", "operationId"=>"deploymentmanager.resources.get", "x-api-path-slug"=>"projectglobaldeploymentsdeploymentresourcesresource-get", "parameters"=>[{"in"=>"path", "name"=>"deployment", "description"=>"The name of the deployment for this request"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID for this request"}, {"in"=>"path", "name"=>"resource", "description"=>"The name of the resource for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource"]}}, "/{project}/global/deployments/{deployment}/stop"=>{"post"=>{"summary"=>"Stop Deployment", "description"=>"Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.", "operationId"=>"deploymentmanager.deployments.stop", "x-api-path-slug"=>"projectglobaldeploymentsdeploymentstop-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"deployment", "description"=>"The name of the deployment for this request"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment"]}}, "/{project}/global/deployments/{resource}/getIamPolicy"=>{"get"=>{"summary"=>"Get IAM Policy", "description"=>"Gets the access control policy for a resource. May be empty if no such policy or resource exists.", "operationId"=>"deploymentmanager.deployments.getIamPolicy", "x-api-path-slug"=>"projectglobaldeploymentsresourcegetiampolicy-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"resource", "description"=>"Name of the resource for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}, "/{project}/global/deployments/{resource}/setIamPolicy"=>{"post"=>{"summary"=>"Set IAM Policy", "description"=>"Sets the access control policy on the specified resource. Replaces any existing policy.", "operationId"=>"deploymentmanager.deployments.setIamPolicy", "x-api-path-slug"=>"projectglobaldeploymentsresourcesetiampolicy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"resource", "description"=>"Name of the resource for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}, "/{project}/global/deployments/{resource}/testIamPermissions"=>{"post"=>{"summary"=>"Test IAM Permission", "description"=>"Returns permissions that a caller has on the specified resource.", "operationId"=>"deploymentmanager.deployments.testIamPermissions", "x-api-path-slug"=>"projectglobaldeploymentsresourcetestiampermissions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"resource", "description"=>"Name of the resource for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}, "/{project}/global/operations"=>{"get"=>{"summary"=>"Get Operations", "description"=>"Lists all operations for a project.", "operationId"=>"deploymentmanager.operations.list", "x-api-path-slug"=>"projectglobaloperations-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/{project}/global/operations/{operation}"=>{"get"=>{"summary"=>"Get Operation", "description"=>"Gets information about a specific operation.", "operationId"=>"deploymentmanager.operations.get", "x-api-path-slug"=>"projectglobaloperationsoperation-get", "parameters"=>[{"in"=>"path", "name"=>"operation", "description"=>"The name of the operation for this request"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/{project}/global/types"=>{"get"=>{"summary"=>"Get Types", "description"=>"Lists all resource types for Deployment Manager.", "operationId"=>"deploymentmanager.types.list", "x-api-path-slug"=>"projectglobaltypes-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TYpe"]}}, "/v1/{name}"=>{"delete"=>{"summary"=>"Delete Operation", "description"=>"Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", "operationId"=>"runtimeconfig.operations.delete", "x-api-path-slug"=>"v1name-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the operation resource to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}, "get"=>{"summary"=>"Get Operations", "description"=>"Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.", "operationId"=>"runtimeconfig.operations.list", "x-api-path-slug"=>"v1name-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"The standard list filter"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the operation collection"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The standard list page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The standard list page token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1/{name}:cancel"=>{"post"=>{"summary"=>"Cancel Operation", "description"=>"Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", "operationId"=>"runtimeconfig.operations.cancel", "x-api-path-slug"=>"v1namecancel-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The name of the operation resource to be cancelled"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}}}, "apis"=>{"name"=>"Google Cloud Deployment Manager", "x-slug"=>"google-cloud-deployment-manager", "description"=>"Google Cloud Deployment Manager allows you to specify all the resources needed for your application in a declarative format using yaml. You can also use Python or Jinja2 templates to parameterize the configuration and allow reuse of common deployment paradigms such as a load balanced, auto-scaled instance group. Treat your configuration as code and perform repeatable deployments.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/repeatable-deployment-process.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Cloud,Deployments,Google APIs,Orchestration,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-deployment-manager/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Deployment Manager", "x-api-slug"=>"google-cloud-deployment-manager", "description"=>"Google Cloud Deployment Manager allows you to specify all the resources needed for your application in a declarative format using yaml. You can also use Python or Jinja2 templates to parameterize the configuration and allow reuse of common deployment paradigms such as a load balanced, auto-scaled instance group. Treat your configuration as code and perform repeatable deployments.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/repeatable-deployment-process.png", "humanURL"=>"https://cloud.google.com/deployment-manager/", "baseURL"=>"https:///", "tags"=>"API Provider,API Service Provider,Cloud,Deployments,Google APIs,Orchestration,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-deployment-manager/google-cloud-deployment-manager-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://cloud.google.com/deployment-manager/docs/reference/latest/authorization"}, {"type"=>"x-change-log", "url"=>"https://cloud.google.com/deployment-manager/docs/release-notes"}, {"type"=>"x-code", "url"=>"https://cloud.google.com/deployment-manager/docs/reference/latest/libraries"}, {"type"=>"x-concepts", "url"=>"https://cloud.google.com/deployment-manager/docs/concepts"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/deployment-manager/docs/"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/deployment-manager/docs/quickstart"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/deployment-manager/docs/how-to"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/deployment-manager/pricing-and-quotas"}, {"type"=>"x-tutorials", "url"=>"https://cloud.google.com/deployment-manager/docs/tutorials"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/deployment-manager/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-analytics{"google-analytics-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Analytics", "x-complete"=>1, "info"=>{"title"=>"Google Analytics", "description"=>"views-and-manages-your-google-analytics-data-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v3"}, "host"=>"www.googleapis.com", "basePath"=>"/analytics/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/data/ga"=>{"get"=>{"summary"=>"Return Analytics Data", "description"=>"Returns Analytics data for a view (profile).", "operationId"=>"analytics.data.ga.get", "x-api-path-slug"=>"dataga-get", "parameters"=>[{"in"=>"query", "name"=>"dimensions", "description"=>"A comma-separated list of Analytics dimensions"}, {"in"=>"query", "name"=>"end-date", "description"=>"End date for fetching Analytics data"}, {"in"=>"query", "name"=>"filters", "description"=>"A comma-separated list of dimension or metric filters to be applied to Analytics data"}, {"in"=>"query", "name"=>"ids", "description"=>"Unique table ID for retrieving Analytics data"}, {"in"=>"query", "name"=>"include-empty-rows", "description"=>"The response will include empty rows if this parameter is set to true, the default is true"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of entries to include in this feed"}, {"in"=>"query", "name"=>"metrics", "description"=>"A comma-separated list of Analytics metrics"}, {"in"=>"query", "name"=>"output", "description"=>"The selected format for the response"}, {"in"=>"query", "name"=>"samplingLevel", "description"=>"The desired sampling level"}, {"in"=>"query", "name"=>"segment", "description"=>"An Analytics segment to be applied to data"}, {"in"=>"query", "name"=>"sort", "description"=>"A comma-separated list of dimensions or metrics that determine the sort order for Analytics data"}, {"in"=>"query", "name"=>"start-date", "description"=>"Start date for fetching Analytics data"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first entity to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytic Data"]}}, "/data/mcf"=>{"get"=>{"summary"=>"Returns Analytics Multi-Channel Funnels Data", "description"=>"Returns Analytics Multi-Channel Funnels data for a view (profile).", "operationId"=>"analytics.data.mcf.get", "x-api-path-slug"=>"datamcf-get", "parameters"=>[{"in"=>"query", "name"=>"dimensions", "description"=>"A comma-separated list of Multi-Channel Funnels dimensions"}, {"in"=>"query", "name"=>"end-date", "description"=>"End date for fetching Analytics data"}, {"in"=>"query", "name"=>"filters", "description"=>"A comma-separated list of dimension or metric filters to be applied to the Analytics data"}, {"in"=>"query", "name"=>"ids", "description"=>"Unique table ID for retrieving Analytics data"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of entries to include in this feed"}, {"in"=>"query", "name"=>"metrics", "description"=>"A comma-separated list of Multi-Channel Funnels metrics"}, {"in"=>"query", "name"=>"samplingLevel", "description"=>"The desired sampling level"}, {"in"=>"query", "name"=>"sort", "description"=>"A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data"}, {"in"=>"query", "name"=>"start-date", "description"=>"Start date for fetching Analytics data"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first entity to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytic Data"]}}, "/data/realtime"=>{"get"=>{"summary"=>"Return Real Time Data", "description"=>"Returns real time data for a view (profile).", "operationId"=>"analytics.data.realtime.get", "x-api-path-slug"=>"datarealtime-get", "parameters"=>[{"in"=>"query", "name"=>"dimensions", "description"=>"A comma-separated list of real time dimensions"}, {"in"=>"query", "name"=>"filters", "description"=>"A comma-separated list of dimension or metric filters to be applied to real time data"}, {"in"=>"query", "name"=>"ids", "description"=>"Unique table ID for retrieving real time data"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of entries to include in this feed"}, {"in"=>"query", "name"=>"metrics", "description"=>"A comma-separated list of real time metrics"}, {"in"=>"query", "name"=>"sort", "description"=>"A comma-separated list of dimensions or metrics that determine the sort order for real time data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Real Time Data"]}}, "/management/accountSummaries"=>{"get"=>{"summary"=>"Get Account Summary", "description"=>"Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.", "operationId"=>"analytics.management.accountSummaries.list", "x-api-path-slug"=>"managementaccountsummaries-get", "parameters"=>[{"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of account summaries to include in this response, where the largest acceptable value is 1000"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first entity to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/management/accounts"=>{"get"=>{"summary"=>"Get Accounts", "description"=>"Lists all accounts to which the user has access.", "operationId"=>"analytics.management.accounts.list", "x-api-path-slug"=>"managementaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of accounts to include in this response"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first account to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/management/accounts/{accountId}/entityUserLinks"=>{"get"=>{"summary"=>"Get users", "description"=>"Lists account-user links for a given account.", "operationId"=>"analytics.management.accountUserLinks.list", "x-api-path-slug"=>"managementaccountsaccountidentityuserlinks-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to retrieve the user links for"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of account-user links to include in this response"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first account-user link to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "post"=>{"summary"=>"Add New Users", "description"=>"Adds a new user to the given account.", "operationId"=>"analytics.management.accountUserLinks.insert", "x-api-path-slug"=>"managementaccountsaccountidentityuserlinks-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to create the user link for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/management/accounts/{accountId}/entityUserLinks/{linkId}"=>{"delete"=>{"summary"=>"Remove User", "description"=>"Removes a user from the given account.", "operationId"=>"analytics.management.accountUserLinks.delete", "x-api-path-slug"=>"managementaccountsaccountidentityuserlinkslinkid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to delete the user link for"}, {"in"=>"path", "name"=>"linkId", "description"=>"Link ID to delete the user link for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "put"=>{"summary"=>"Update Permissions", "description"=>"Updates permissions for an existing user on the given account.", "operationId"=>"analytics.management.accountUserLinks.update", "x-api-path-slug"=>"managementaccountsaccountidentityuserlinkslinkid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to update the account-user link for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"linkId", "description"=>"Link ID to update the account-user link for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}}, "/management/accounts/{accountId}/filters"=>{"get"=>{"summary"=>"Get Filters", "description"=>"Lists all filters for an account", "operationId"=>"analytics.management.filters.list", "x-api-path-slug"=>"managementaccountsaccountidfilters-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to retrieve filters for"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of filters to include in this response"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first entity to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filter"]}, "post"=>{"summary"=>"Create Filter", "description"=>"Create a new filter.", "operationId"=>"analytics.management.filters.insert", "x-api-path-slug"=>"managementaccountsaccountidfilters-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to create filter for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filter"]}}, "/management/accounts/{accountId}/filters/{filterId}"=>{"delete"=>{"summary"=>"Delete Filter", "description"=>"Delete a filter.", "operationId"=>"analytics.management.filters.delete", "x-api-path-slug"=>"managementaccountsaccountidfiltersfilterid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to delete the filter for"}, {"in"=>"path", "name"=>"filterId", "description"=>"ID of the filter to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filter"]}, "get"=>{"summary"=>"Get Filter", "description"=>"Returns a filters to which the user has access.", "operationId"=>"analytics.management.filters.get", "x-api-path-slug"=>"managementaccountsaccountidfiltersfilterid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to retrieve filters for"}, {"in"=>"path", "name"=>"filterId", "description"=>"Filter ID to retrieve filters for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filter"]}, "patch"=>{"summary"=>"Update Filter", "description"=>"Updates an existing filter. This method supports patch semantics.", "operationId"=>"analytics.management.filters.patch", "x-api-path-slug"=>"managementaccountsaccountidfiltersfilterid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to which the filter belongs"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"filterId", "description"=>"ID of the filter to be updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filter"]}, "put"=>{"summary"=>"Update Filter", "description"=>"Updates an existing filter.", "operationId"=>"analytics.management.filters.update", "x-api-path-slug"=>"managementaccountsaccountidfiltersfilterid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to which the filter belongs"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"filterId", "description"=>"ID of the filter to be updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filter"]}}, "/management/accounts/{accountId}/webproperties"=>{"get"=>{"summary"=>"Get Web Properties", "description"=>"Lists web properties to which the user has access.", "operationId"=>"analytics.management.webproperties.list", "x-api-path-slug"=>"managementaccountsaccountidwebproperties-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to retrieve web properties for"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of web properties to include in this response"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first entity to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web Property"]}, "post"=>{"summary"=>"Create Web Property", "description"=>"Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile.", "operationId"=>"analytics.management.webproperties.insert", "x-api-path-slug"=>"managementaccountsaccountidwebproperties-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to create the web property for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web Property"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}"=>{"get"=>{"summary"=>"Get Web Property", "description"=>"Gets a web property to which the user has access.", "operationId"=>"analytics.management.webproperties.get", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to retrieve the web property for"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"ID to retrieve the web property for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web Property"]}, "patch"=>{"summary"=>"Update Web Property", "description"=>"Updates an existing web property. This method supports patch semantics.", "operationId"=>"analytics.management.webproperties.patch", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to which the web property belongs"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web Property"]}, "put"=>{"summary"=>"Update Web Property", "description"=>"Updates an existing web property.", "operationId"=>"analytics.management.webproperties.update", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to which the web property belongs"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web Property"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources"=>{"get"=>{"summary"=>"Get Custom Data", "description"=>"List custom data sources to which the user has access.", "operationId"=>"analytics.management.customDataSources.list", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidcustomdatasources-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account Id for the custom data sources to retrieve"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of custom data sources to include in this response"}, {"in"=>"query", "name"=>"start-index", "description"=>"A 1-based index of the first custom data source to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property Id for the custom data sources to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom Data"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData"=>{"post"=>{"summary"=>"Delete Data", "description"=>"Delete data associated with a previous upload.", "operationId"=>"analytics.management.uploads.deleteUploadData", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidcustomdatasourcescustomdatasourceiddeleteuploaddata-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account Id for the uploads to be deleted"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customDataSourceId", "description"=>"Custom data source Id for the uploads to be deleted"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property Id for the uploads to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads"=>{"get"=>{"summary"=>"List Uploads", "description"=>"List uploads to which the user has access.", "operationId"=>"analytics.management.uploads.list", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidcustomdatasourcescustomdatasourceiduploads-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account Id for the uploads to retrieve"}, {"in"=>"path", "name"=>"customDataSourceId", "description"=>"Custom data source Id for uploads to retrieve"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of uploads to include in this response"}, {"in"=>"query", "name"=>"start-index", "description"=>"A 1-based index of the first upload to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property Id for the uploads to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload"]}, "post"=>{"summary"=>"Upload Data", "description"=>"Upload data for a custom data source.", "operationId"=>"analytics.management.uploads.uploadData", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidcustomdatasourcescustomdatasourceiduploads-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account Id associated with the upload"}, {"in"=>"path", "name"=>"customDataSourceId", "description"=>"Custom data source Id to which the data being uploaded belongs"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property UA-string associated with the upload"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}"=>{"get"=>{"summary"=>"Get UPloads", "description"=>"List uploads to which the user has access.", "operationId"=>"analytics.management.uploads.get", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidcustomdatasourcescustomdatasourceiduploadsuploadid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account Id for the upload to retrieve"}, {"in"=>"path", "name"=>"customDataSourceId", "description"=>"Custom data source Id for upload to retrieve"}, {"in"=>"path", "name"=>"uploadId", "description"=>"Upload Id to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property Id for the upload to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions"=>{"get"=>{"summary"=>"Get Custom Dimensions", "description"=>"Lists custom dimensions to which the user has access.", "operationId"=>"analytics.management.customDimensions.list", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidcustomdimensions-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID for the custom dimensions to retrieve"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of custom dimensions to include in this response"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first entity to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID for the custom dimensions to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dimension"]}, "post"=>{"summary"=>"Create Custom Dimension", "description"=>"Create a new custom dimension.", "operationId"=>"analytics.management.customDimensions.insert", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidcustomdimensions-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID for the custom dimension to create"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID for the custom dimension to create"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dimension"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}"=>{"get"=>{"summary"=>"Get Custom Dimension", "description"=>"Get a custom dimension to which the user has access.", "operationId"=>"analytics.management.customDimensions.get", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidcustomdimensionscustomdimensionid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID for the custom dimension to retrieve"}, {"in"=>"path", "name"=>"customDimensionId", "description"=>"The ID of the custom dimension to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID for the custom dimension to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dimension"]}, "patch"=>{"summary"=>"Update Custom Dimensions", "description"=>"Updates an existing custom dimension. This method supports patch semantics.", "operationId"=>"analytics.management.customDimensions.patch", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidcustomdimensionscustomdimensionid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID for the custom dimension to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customDimensionId", "description"=>"Custom dimension ID for the custom dimension to update"}, {"in"=>"query", "name"=>"ignoreCustomDataSourceLinks", "description"=>"Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID for the custom dimension to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dimension"]}, "put"=>{"summary"=>"Update Custom Dimensions", "description"=>"Updates an existing custom dimension.", "operationId"=>"analytics.management.customDimensions.update", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidcustomdimensionscustomdimensionid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID for the custom dimension to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customDimensionId", "description"=>"Custom dimension ID for the custom dimension to update"}, {"in"=>"query", "name"=>"ignoreCustomDataSourceLinks", "description"=>"Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID for the custom dimension to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dimension"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics"=>{"get"=>{"summary"=>"Get Custom Metrics", "description"=>"Lists custom metrics to which the user has access.", "operationId"=>"analytics.management.customMetrics.list", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidcustommetrics-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID for the custom metrics to retrieve"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of custom metrics to include in this response"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first entity to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID for the custom metrics to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metric"]}, "post"=>{"summary"=>"Create Custom Metric", "description"=>"Create a new custom metric.", "operationId"=>"analytics.management.customMetrics.insert", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidcustommetrics-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID for the custom metric to create"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID for the custom dimension to create"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metric"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}"=>{"get"=>{"summary"=>"Get Custom Metric", "description"=>"Get a custom metric to which the user has access.", "operationId"=>"analytics.management.customMetrics.get", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidcustommetricscustommetricid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID for the custom metric to retrieve"}, {"in"=>"path", "name"=>"customMetricId", "description"=>"The ID of the custom metric to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID for the custom metric to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metric"]}, "patch"=>{"summary"=>"Update Custom Metric", "description"=>"Updates an existing custom metric. This method supports patch semantics.", "operationId"=>"analytics.management.customMetrics.patch", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidcustommetricscustommetricid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID for the custom metric to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customMetricId", "description"=>"Custom metric ID for the custom metric to update"}, {"in"=>"query", "name"=>"ignoreCustomDataSourceLinks", "description"=>"Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID for the custom metric to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metric"]}, "put"=>{"summary"=>"Update Custom Metric", "description"=>"Updates an existing custom metric.", "operationId"=>"analytics.management.customMetrics.update", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidcustommetricscustommetricid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID for the custom metric to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customMetricId", "description"=>"Custom metric ID for the custom metric to update"}, {"in"=>"query", "name"=>"ignoreCustomDataSourceLinks", "description"=>"Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID for the custom metric to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metric"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks"=>{"get"=>{"summary"=>"List AdWords", "description"=>"Lists webProperty-AdWords links for a given web property.", "operationId"=>"analytics.management.webPropertyAdWordsLinks.list", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidentityadwordslinks-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"ID of the account which the given web property belongs to"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of webProperty-AdWords links to include in this response"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first webProperty-AdWords link to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to retrieve the AdWords links for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AdWord"]}, "post"=>{"summary"=>"Create AdWord", "description"=>"Creates a webProperty-AdWords link.", "operationId"=>"analytics.management.webPropertyAdWordsLinks.insert", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidentityadwordslinks-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"ID of the Google Analytics account to create the link for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to create the link for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AdWord"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}"=>{"delete"=>{"summary"=>"Delete AdWord", "description"=>"Deletes a web property-AdWords link.", "operationId"=>"analytics.management.webPropertyAdWordsLinks.delete", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidentityadwordslinkswebpropertyadwordslinkid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"ID of the account which the given web property belongs to"}, {"in"=>"path", "name"=>"webPropertyAdWordsLinkId", "description"=>"Web property AdWords link ID"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to delete the AdWords link for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AdWord"]}, "get"=>{"summary"=>"Get AdWord", "description"=>"Returns a web property-AdWords link to which the user has access.", "operationId"=>"analytics.management.webPropertyAdWordsLinks.get", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidentityadwordslinkswebpropertyadwordslinkid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"ID of the account which the given web property belongs to"}, {"in"=>"path", "name"=>"webPropertyAdWordsLinkId", "description"=>"Web property-AdWords link ID"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to retrieve the AdWords link for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AdWord"]}, "patch"=>{"summary"=>"Update AdWord", "description"=>"Updates an existing webProperty-AdWords link. This method supports patch semantics.", "operationId"=>"analytics.management.webPropertyAdWordsLinks.patch", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidentityadwordslinkswebpropertyadwordslinkid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"ID of the account which the given web property belongs to"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"webPropertyAdWordsLinkId", "description"=>"Web property-AdWords link ID"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to retrieve the AdWords link for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AdWord"]}, "put"=>{"summary"=>"Update AdWord", "description"=>"Updates an existing webProperty-AdWords link.", "operationId"=>"analytics.management.webPropertyAdWordsLinks.update", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidentityadwordslinkswebpropertyadwordslinkid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"ID of the account which the given web property belongs to"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"webPropertyAdWordsLinkId", "description"=>"Web property-AdWords link ID"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to retrieve the AdWords link for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AdWord"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks"=>{"get"=>{"summary"=>"Get Users", "description"=>"Lists webProperty-user links for a given web property.", "operationId"=>"analytics.management.webpropertyUserLinks.list", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidentityuserlinks-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID which the given web property belongs to"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of webProperty-user Links to include in this response"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first webProperty-user link to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web Property ID for the webProperty-user links to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "post"=>{"summary"=>"Add User", "description"=>"Adds a new user to the given web property.", "operationId"=>"analytics.management.webpropertyUserLinks.insert", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidentityuserlinks-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to create the user link for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web Property ID to create the user link for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}"=>{"delete"=>{"summary"=>"Remove User", "description"=>"Removes a user from the given web property.", "operationId"=>"analytics.management.webpropertyUserLinks.delete", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidentityuserlinkslinkid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to delete the user link for"}, {"in"=>"path", "name"=>"linkId", "description"=>"Link ID to delete the user link for"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web Property ID to delete the user link for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "put"=>{"summary"=>"Update Permission", "description"=>"Updates permissions for an existing user on the given web property.", "operationId"=>"analytics.management.webpropertyUserLinks.update", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidentityuserlinkslinkid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to update the account-user link for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"linkId", "description"=>"Link ID to update the account-user link for"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to update the account-user link for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles"=>{"get"=>{"summary"=>"List Views", "description"=>"Lists views (profiles) to which the user has access.", "operationId"=>"analytics.management.profiles.list", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofiles-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID for the view (profiles) to retrieve"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of views (profiles) to include in this response"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first entity to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID for the views (profiles) to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View"]}, "post"=>{"summary"=>"Create View", "description"=>"Create a new view (profile).", "operationId"=>"analytics.management.profiles.insert", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofiles-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to create the view (profile) for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to create the view (profile) for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}"=>{"delete"=>{"summary"=>"Delete View", "description"=>"Deletes a view (profile).", "operationId"=>"analytics.management.profiles.delete", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to delete the view (profile) for"}, {"in"=>"path", "name"=>"profileId", "description"=>"ID of the view (profile) to be deleted"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to delete the view (profile) for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View"]}, "get"=>{"summary"=>"Get View", "description"=>"Gets a view (profile) to which the user has access.", "operationId"=>"analytics.management.profiles.get", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to retrieve the view (profile) for"}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to retrieve the view (profile) for"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to retrieve the view (profile) for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View"]}, "patch"=>{"summary"=>"Update View", "description"=>"Updates an existing view (profile). This method supports patch semantics.", "operationId"=>"analytics.management.profiles.patch", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to which the view (profile) belongs"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"ID of the view (profile) to be updated"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to which the view (profile) belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View"]}, "put"=>{"summary"=>"Update View", "description"=>"Updates an existing view (profile).", "operationId"=>"analytics.management.profiles.update", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to which the view (profile) belongs"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"ID of the view (profile) to be updated"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to which the view (profile) belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks"=>{"get"=>{"summary"=>"List Users", "description"=>"Lists profile-user links for a given view (profile).", "operationId"=>"analytics.management.profileUserLinks.list", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidentityuserlinks-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID which the given view (profile) belongs to"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of profile-user links to include in this response"}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to retrieve the profile-user links for"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first profile-user link to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web Property ID which the given view (profile) belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "post"=>{"summary"=>"Add User", "description"=>"Adds a new user to the given view (profile).", "operationId"=>"analytics.management.profileUserLinks.insert", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidentityuserlinks-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to create the user link for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to create the user link for"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web Property ID to create the user link for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}"=>{"delete"=>{"summary"=>"Remove User", "description"=>"Removes a user from the given view (profile).", "operationId"=>"analytics.management.profileUserLinks.delete", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidentityuserlinkslinkid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to delete the user link for"}, {"in"=>"path", "name"=>"linkId", "description"=>"Link ID to delete the user link for"}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to delete the user link for"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web Property ID to delete the user link for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "put"=>{"summary"=>"Update Permissions", "description"=>"Updates permissions for an existing user on the given view (profile).", "operationId"=>"analytics.management.profileUserLinks.update", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidentityuserlinkslinkid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to update the user link for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"linkId", "description"=>"Link ID to update the user link for"}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile ID) to update the user link for"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web Property ID to update the user link for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments"=>{"get"=>{"summary"=>"List Experiments", "description"=>"Lists experiments to which the user has access.", "operationId"=>"analytics.management.experiments.list", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidexperiments-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to retrieve experiments for"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of experiments to include in this response"}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to retrieve experiments for"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first experiment to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to retrieve experiments for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Experiment"]}, "post"=>{"summary"=>"Create Experiment", "description"=>"Create a new experiment.", "operationId"=>"analytics.management.experiments.insert", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidexperiments-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to create the experiment for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to create the experiment for"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to create the experiment for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Experiment"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}"=>{"delete"=>{"summary"=>"Delete Experiment", "description"=>"Delete an experiment.", "operationId"=>"analytics.management.experiments.delete", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidexperimentsexperimentid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to which the experiment belongs"}, {"in"=>"path", "name"=>"experimentId", "description"=>"ID of the experiment to delete"}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to which the experiment belongs"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to which the experiment belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Experiment"]}, "get"=>{"summary"=>"Get Experiment", "description"=>"Returns an experiment to which the user has access.", "operationId"=>"analytics.management.experiments.get", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidexperimentsexperimentid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to retrieve the experiment for"}, {"in"=>"path", "name"=>"experimentId", "description"=>"Experiment ID to retrieve the experiment for"}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to retrieve the experiment for"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to retrieve the experiment for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Experiment"]}, "patch"=>{"summary"=>"Update Experiment", "description"=>"Update an existing experiment. This method supports patch semantics.", "operationId"=>"analytics.management.experiments.patch", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidexperimentsexperimentid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID of the experiment to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"experimentId", "description"=>"Experiment ID of the experiment to update"}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID of the experiment to update"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID of the experiment to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Experiment"]}, "put"=>{"summary"=>"Update Experiment", "description"=>"Update an existing experiment.", "operationId"=>"analytics.management.experiments.update", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidexperimentsexperimentid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID of the experiment to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"experimentId", "description"=>"Experiment ID of the experiment to update"}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID of the experiment to update"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID of the experiment to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Experiment"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals"=>{"get"=>{"summary"=>"Get Goals", "description"=>"Lists goals to which the user has access.", "operationId"=>"analytics.management.goals.list", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidgoals-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to retrieve goals for"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of goals to include in this response"}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to retrieve goals for"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first goal to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to retrieve goals for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Goal"]}, "post"=>{"summary"=>"Create Goal", "description"=>"Create a new goal.", "operationId"=>"analytics.management.goals.insert", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidgoals-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to create the goal for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to create the goal for"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to create the goal for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Goal"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}"=>{"get"=>{"summary"=>"Get Goal", "description"=>"Gets a goal to which the user has access.", "operationId"=>"analytics.management.goals.get", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidgoalsgoalid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to retrieve the goal for"}, {"in"=>"path", "name"=>"goalId", "description"=>"Goal ID to retrieve the goal for"}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to retrieve the goal for"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to retrieve the goal for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Goal"]}, "patch"=>{"summary"=>"Update Goal", "description"=>"Updates an existing goal. This method supports patch semantics.", "operationId"=>"analytics.management.goals.patch", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidgoalsgoalid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to update the goal"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"goalId", "description"=>"Index of the goal to be updated"}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to update the goal"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to update the goal"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Goal"]}, "put"=>{"summary"=>"Update Goal", "description"=>"Updates an existing goal.", "operationId"=>"analytics.management.goals.update", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidgoalsgoalid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to update the goal"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"goalId", "description"=>"Index of the goal to be updated"}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to update the goal"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to update the goal"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Goal"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks"=>{"get"=>{"summary"=>"Get Profile Filter", "description"=>"Lists all profile filter links for a profile.", "operationId"=>"analytics.management.profileFilterLinks.list", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidprofilefilterlinks-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to retrieve profile filter links for"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of profile filter links to include in this response"}, {"in"=>"path", "name"=>"profileId", "description"=>"Profile ID to retrieve filter links for"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first entity to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property Id for profile filter links for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile Filter"]}, "post"=>{"summary"=>"Create Profile Filter", "description"=>"Create a new profile filter link.", "operationId"=>"analytics.management.profileFilterLinks.insert", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidprofilefilterlinks-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to create profile filter link for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"Profile ID to create filter link for"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property Id to create profile filter link for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile Filter"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}"=>{"delete"=>{"summary"=>"Delete Profile Filter", "description"=>"Delete a profile filter link.", "operationId"=>"analytics.management.profileFilterLinks.delete", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidprofilefilterlinkslinkid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to which the profile filter link belongs"}, {"in"=>"path", "name"=>"linkId", "description"=>"ID of the profile filter link to delete"}, {"in"=>"path", "name"=>"profileId", "description"=>"Profile ID to which the filter link belongs"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property Id to which the profile filter link belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile Filter"]}, "get"=>{"summary"=>"Get Profile Filter", "description"=>"Returns a single profile filter link.", "operationId"=>"analytics.management.profileFilterLinks.get", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidprofilefilterlinkslinkid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to retrieve profile filter link for"}, {"in"=>"path", "name"=>"linkId", "description"=>"ID of the profile filter link"}, {"in"=>"path", "name"=>"profileId", "description"=>"Profile ID to retrieve filter link for"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property Id to retrieve profile filter link for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile Filter"]}, "patch"=>{"summary"=>"Update Profile Filter", "description"=>"Update an existing profile filter link. This method supports patch semantics.", "operationId"=>"analytics.management.profileFilterLinks.patch", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidprofilefilterlinkslinkid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to which profile filter link belongs"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"linkId", "description"=>"ID of the profile filter link to be updated"}, {"in"=>"path", "name"=>"profileId", "description"=>"Profile ID to which filter link belongs"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property Id to which profile filter link belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile Filter"]}, "put"=>{"summary"=>"Update Profile Filter", "description"=>"Update an existing profile filter link.", "operationId"=>"analytics.management.profileFilterLinks.update", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidprofilefilterlinkslinkid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to which profile filter link belongs"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"linkId", "description"=>"ID of the profile filter link to be updated"}, {"in"=>"path", "name"=>"profileId", "description"=>"Profile ID to which filter link belongs"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property Id to which profile filter link belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile Filter"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports"=>{"get"=>{"summary"=>"Get Unsampled Reports", "description"=>"Lists unsampled reports to which the user has access.", "operationId"=>"analytics.management.unsampledReports.list", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidunsampledreports-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to retrieve unsampled reports for"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of unsampled reports to include in this response"}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to retrieve unsampled reports for"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first unsampled report to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to retrieve unsampled reports for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report"]}, "post"=>{"summary"=>"Create Unsampled Report", "description"=>"Create a new unsampled report.", "operationId"=>"analytics.management.unsampledReports.insert", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidunsampledreports-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to create the unsampled report for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to create the unsampled report for"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to create the unsampled report for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}"=>{"delete"=>{"summary"=>"Delete Unsampled Report", "description"=>"Deletes an unsampled report.", "operationId"=>"analytics.management.unsampledReports.delete", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidunsampledreportsunsampledreportid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to delete the unsampled report for"}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to delete the unsampled report for"}, {"in"=>"path", "name"=>"unsampledReportId", "description"=>"ID of the unsampled report to be deleted"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to delete the unsampled reports for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report"]}, "get"=>{"summary"=>"Get Unsampled Report", "description"=>"Returns a single unsampled report.", "operationId"=>"analytics.management.unsampledReports.get", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidprofilesprofileidunsampledreportsunsampledreportid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID to retrieve unsampled report for"}, {"in"=>"path", "name"=>"profileId", "description"=>"View (Profile) ID to retrieve unsampled report for"}, {"in"=>"path", "name"=>"unsampledReportId", "description"=>"ID of the unsampled report to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID to retrieve unsampled reports for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences"=>{"get"=>{"summary"=>"Get Remarketing Audiences", "description"=>"Lists remarketing audiences to which the user has access.", "operationId"=>"analytics.management.remarketingAudience.list", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidremarketingaudiences-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The account ID of the remarketing audiences to retrieve"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of remarketing audiences to include in this response"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first entity to retrieve"}, {"in"=>"query", "name"=>"type"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"The web property ID of the remarketing audiences to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remarketing Audience"]}, "post"=>{"summary"=>"Create Remarketing Audience", "description"=>"Creates a new remarketing audience.", "operationId"=>"analytics.management.remarketingAudience.insert", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidremarketingaudiences-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The account ID for which to create the remarketing audience"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"Web property ID for which to create the remarketing audience"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remarketing Audience"]}}, "/management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}"=>{"get"=>{"summary"=>"Get Remarketing Audience", "description"=>"Gets a remarketing audience to which the user has access.", "operationId"=>"analytics.management.remarketingAudience.get", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidremarketingaudiencesremarketingaudienceid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The account ID of the remarketing audience to retrieve"}, {"in"=>"path", "name"=>"remarketingAudienceId", "description"=>"The ID of the remarketing audience to retrieve"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"The web property ID of the remarketing audience to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remarketing Audience"]}, "patch"=>{"summary"=>"Update Remarketing Audience", "description"=>"Updates an existing remarketing audience. This method supports patch semantics.", "operationId"=>"analytics.management.remarketingAudience.patch", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidremarketingaudiencesremarketingaudienceid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The account ID of the remarketing audience to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"remarketingAudienceId", "description"=>"The ID of the remarketing audience to update"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"The web property ID of the remarketing audience to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remarketing Audience"]}, "put"=>{"summary"=>"Update Remarketing Audience", "description"=>"Updates an existing remarketing audience.", "operationId"=>"analytics.management.remarketingAudience.update", "x-api-path-slug"=>"managementaccountsaccountidwebpropertieswebpropertyidremarketingaudiencesremarketingaudienceid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The account ID of the remarketing audience to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"remarketingAudienceId", "description"=>"The ID of the remarketing audience to update"}, {"in"=>"path", "name"=>"webPropertyId", "description"=>"The web property ID of the remarketing audience to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remarketing Audience"]}}, "/management/segments"=>{"get"=>{"summary"=>"Get Segments", "description"=>"Lists segments to which the user has access.", "operationId"=>"analytics.management.segments.list", "x-api-path-slug"=>"managementsegments-get", "parameters"=>[{"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of segments to include in this response"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first segment to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Segment"]}}, "/metadata/{reportType}/columns"=>{"get"=>{"summary"=>"Get Columsn", "description"=>"Lists all columns for a report type", "operationId"=>"analytics.metadata.columns.list", "x-api-path-slug"=>"metadatareporttypecolumns-get", "parameters"=>[{"in"=>"path", "name"=>"reportType", "description"=>"Report type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Column"]}}, "/provisioning/createAccountTicket"=>{"post"=>{"summary"=>"Create Account Ticket", "description"=>"Creates an account ticket.", "operationId"=>"analytics.provisioning.createAccountTicket", "x-api-path-slug"=>"provisioningcreateaccountticket-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tickets"]}}}}, "apis"=>{"name"=>"Google Analytics", "x-slug"=>"google-analytics", "description"=>"Google Analytics gives you the digital analytics tools you need to analyze data from all touchpoints in one place, for a deeper understanding of the customer experience. You can then share the insights that matter with your whole organization.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/logo_lockup_analytics_icon_vertical_black_2x.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"Analysis,Analytics,API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Service API,Stack,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-analytics/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Analytics", "x-api-slug"=>"google-analytics", "description"=>"Google Analytics gives you the digital analytics tools you need to analyze data from all touchpoints in one place, for a deeper understanding of the customer experience. You can then share the insights that matter with your whole organization.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/logo_lockup_analytics_icon_vertical_black_2x.png", "humanURL"=>"https://www.google.com/analytics/#?modal_active=none", "baseURL"=>"https://www.googleapis.com//analytics/v3", "tags"=>"Analysis,Analytics,API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Service API,Stack,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-analytics/google-analytics-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://analytics.googleblog.com/"}, {"type"=>"x-blog-rss", "url"=>"https://analytics.googleblog.com/feeds/posts/default?alt=rss"}, {"type"=>"x-developer", "url"=>"https://developers.google.com/analytics/"}, {"type"=>"x-github", "url"=>"https://github.com/googleanalytics/"}, {"type"=>"x-google-plus", "url"=>"https://plus.google.com/+GoogleAnalytics"}, {"type"=>"x-partners", "url"=>"https://developers.google.com/analytics/program/"}, {"type"=>"x-stack-overflow", "url"=>"http://stackoverflow.com/questions/tagged/google-analytics"}, {"type"=>"x-support", "url"=>"https://developers.google.com/analytics/help/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/googleanalytics"}, {"type"=>"x-videos", "url"=>"https://www.youtube.com/user/googleanalytics"}, {"type"=>"x-website", "url"=>"https://www.google.com/analytics/#?modal_active=none"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
easycron{"easycron-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EasyCron", "x-complete"=>1, "info"=>{"title"=>"Easycron API", "description"=>"all-registered-users-of-easycron-can-utilize-our-api-to-manage-their-cron-jobs-without-logging-in-easycron-com-", "termsOfService"=>"https://www.easycron.com/terms", "contact"=>{"name"=>"EasyCron", "url"=>"https://www.easycron.com/contact"}, "version"=>"1.0.0"}, "host"=>"www.easycron.com", "basePath"=>"/rest", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/add"=>{"get"=>{"summary"=>"Add a cron job.", "description"=>"Add a cron job.", "operationId"=>"addCronJob", "x-api-path-slug"=>"add-get", "parameters"=>[{"in"=>"query", "name"=>"cookies", "description"=>"Cookie variable-value pairs"}, {"in"=>"query", "name"=>"cron_expression", "description"=>"Cron expression that following the syntax defined at our Cron Expression page"}, {"in"=>"query", "name"=>"cron_job_name", "description"=>"The name of your cron job"}, {"in"=>"query", "name"=>"email_me", "description"=>"Email notification setting of the cron job"}, {"in"=>"query", "name"=>"log_output_length", "description"=>"Length of execution log of the cron job"}, {"in"=>"query", "name"=>"posts", "description"=>"POST variable-value pairs"}, {"in"=>"query", "name"=>"testfirst", "description"=>"If to test the cron job URL first before adding"}, {"in"=>"query", "name"=>"token", "description"=>"You API token"}, {"in"=>"query", "name"=>"url", "description"=>"URL of the cron job"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cron", "Job"]}}, "/delete"=>{"get"=>{"summary"=>"Delete a cron job.", "description"=>"Delete a cron job.", "operationId"=>"deleteCronJob", "x-api-path-slug"=>"delete-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"ID of the cron job you want to delete"}, {"in"=>"query", "name"=>"token", "description"=>"You API token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cron", "Job"]}}, "/detail"=>{"get"=>{"summary"=>"Get detail of a cron job.", "description"=>"Get detail of a cron job.", "operationId"=>"getDetailCronJob", "x-api-path-slug"=>"detail-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"ID of the cron job you want to get detail of"}, {"in"=>"query", "name"=>"token", "description"=>"You API token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Detail", "Of", "Cron", "Job"]}}, "/disable"=>{"get"=>{"summary"=>"Disable a cron job", "description"=>"Disable a cron job", "operationId"=>"disableCronJbo", "x-api-path-slug"=>"disable-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"ID of the cron job you want to disable"}, {"in"=>"query", "name"=>"token", "description"=>"You API token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disable", "Cron", "Job"]}}, "/edit"=>{"get"=>{"summary"=>"Edit a cron job.", "description"=>"Edit a cron job.", "operationId"=>"editCronJob", "x-api-path-slug"=>"edit-get", "parameters"=>[{"in"=>"query", "name"=>"cookies", "description"=>"Cookie variable-value pairs"}, {"in"=>"query", "name"=>"cron_expression", "description"=>"Cron expression that following the syntax defined at our Cron Expression page"}, {"in"=>"query", "name"=>"cron_job_name", "description"=>"The name of your cron job"}, {"in"=>"query", "name"=>"email_me", "description"=>"Email notification setting of the cron job"}, {"in"=>"query", "name"=>"id", "description"=>"ID of the cron job you want to edit"}, {"in"=>"query", "name"=>"log_output_length", "description"=>"Length of execution log of the cron job"}, {"in"=>"query", "name"=>"posts", "description"=>"POST variable-value pairs"}, {"in"=>"query", "name"=>"testfirst", "description"=>"If to test the cron job URL first before updating"}, {"in"=>"query", "name"=>"token", "description"=>"You API token"}, {"in"=>"query", "name"=>"url", "description"=>"URL of the cron job"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Cron", "Job"]}}, "/enable"=>{"get"=>{"summary"=>"Enable a cron job.", "description"=>"Enable a cron job.", "operationId"=>"enableCronJob", "x-api-path-slug"=>"enable-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"ID of the cron job you want to enable"}, {"in"=>"query", "name"=>"token", "description"=>"You API token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Enable", "Cron", "Job"]}}, "/logs"=>{"get"=>{"summary"=>"View the latest 10 execution logs of a cron job.", "description"=>"View the latest 10 execution logs of a cron job.", "operationId"=>"viewLast10Logs", "x-api-path-slug"=>"logs-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"ID of the cron job you want to delete"}, {"in"=>"query", "name"=>"token", "description"=>"You API token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "Latest", "10", "Execution", "Logs", "Of", "Cron", "Job"]}}, "/timezone"=>{"get"=>{"summary"=>"Get the timezone of a user account.", "description"=>"Get the timezone of a user account.", "operationId"=>"getTimzone", "x-api-path-slug"=>"timezone-get", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"You API token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Timezone", "Of", "User", "Account"]}}}}, "apis"=>{"name"=>"EasyCron", "x-slug"=>"easycron", "description"=>"EasyCron provides the most stable Cron Job Services. Here you can schedule cron jobs with execution logs, Email notifications, run time predictions and a bunch of other featuers!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1806-easycron.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"181380", "tags"=>"API Provider,API Service Provider,Marketplace,My API Stack,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology,Workers", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"easycron/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Easycron API", "x-api-slug"=>"easycron-api", "description"=>"EasyCron provides the most stable Cron Job Services. Here you can schedule cron jobs with execution logs, Email notifications, run time predictions and a bunch of other featuers!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1806-easycron.jpg", "humanURL"=>"http://easycron.com", "baseURL"=>"https://www.easycron.com//rest", "tags"=>"API Provider,API Service Provider,Marketplace,My API Stack,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology,Workers", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/easycron/timezone-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/easycron/easycron-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-affiliate", "url"=>"https://www.easycron.com/affiliates/program"}, {"type"=>"x-blog", "url"=>"http://blog.easycron.com"}, {"type"=>"x-blog-rss", "url"=>"http://blog.easycron.com/feeds/posts/default?alt=rss"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/easycron"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/easycron"}, {"type"=>"x-developer", "url"=>"https://www.easycron.com/document"}, {"type"=>"x-email", "url"=>"info@easycron.com"}, {"type"=>"x-pricing", "url"=>"https://www.easycron.com/user/plan"}, {"type"=>"x-privacy", "url"=>"https://www.easycron.com/privacy"}, {"type"=>"x-support", "url"=>"https://www.easycron.com/contact"}, {"type"=>"x-terms-of-service", "url"=>"https://www.easycron.com/terms"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/easycron"}, {"type"=>"x-website", "url"=>"http://easycron.com"}, {"type"=>"x-website", "url"=>"http://www.easycron.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
sensr-net{"devices-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Sensr.net", "x-complete"=>1, "info"=>{"title"=>"Devices API", "description"=>"the-devices-api-", "version"=>"1.0.0"}, "host"=>"api.serverdensity.io.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/inventory/devices"=>{""=>{"summary"=>"Creating a device", "description"=>"You can create new devices via the API, useful if you want to automatically provision new devices and start monitoring automatically.\nThis API method is used by our Puppet manifest, Chef cookbook and installer shell script to automatically create devices during the agent installation.", "operationId"=>"creating-a-device", "x-api-path-slug"=>"inventorydevices-", "parameters"=>[{"in"=>"body", "name"=>"cpuCores", "description"=>"Item???s number of cores", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"group", "description"=>"Name of group", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"hostname", "description"=>"Device???s hostname", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"installedRAM", "description"=>"RAM installed", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"location", "description"=>"A dictionary containing countryCode, text (which is the city) and countryName", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"name", "description"=>"Name of device", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"os", "description"=>"A dictionary containing code and name", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"privateIPs", "description"=>"Item???s private IP addresses as a JSON encoded list", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"provider", "description"=>"The provider dependent string that identifies this item", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"publicIPs", "description"=>"Item???s public IP addresses as a JSON encoded list", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"swapSpace", "description"=>"Item???s swap space", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"tags", "description"=>"A JSON list of tag IDs", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"token", "description"=>"Your API token", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Devices"]}}, "/inventory/devices/deviceId"=>{""=>{"summary"=>"Updating a device", "description"=>"Update a device and the associated metadata.", "operationId"=>"updating-a-device", "x-api-path-slug"=>"inventorydevicesdeviceid-", "parameters"=>[{"in"=>"path", "name"=>"cpuCores", "description"=>"Item???s number of cores", "type"=>"string"}, {"in"=>"body", "name"=>"cpuCores", "description"=>"Item???s number of cores", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"deviceId", "description"=>"The ID of the device to update", "type"=>"string"}, {"in"=>"path", "name"=>"group", "description"=>"Name of group", "type"=>"string"}, {"in"=>"body", "name"=>"group", "description"=>"Name of group", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"hostname", "description"=>"Item???s hostname", "type"=>"string"}, {"in"=>"body", "name"=>"hostname", "description"=>"Item???s hostname", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"installedRAM", "description"=>"RAM installed", "type"=>"string"}, {"in"=>"body", "name"=>"installedRAM", "description"=>"RAM installed", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"Name of the device", "type"=>"string"}, {"in"=>"body", "name"=>"name", "description"=>"Name of the device", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"os", "description"=>"Operating system that it runs", "type"=>"string"}, {"in"=>"body", "name"=>"os", "description"=>"Operating system that it runs", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"privateIPs", "description"=>"Item???s private IP addresses as a JSON encoded list", "type"=>"string"}, {"in"=>"body", "name"=>"privateIPs", "description"=>"Item???s private IP addresses as a JSON encoded list", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"provider", "description"=>"Provider where the item is hosted", "type"=>"string"}, {"in"=>"body", "name"=>"provider", "description"=>"Provider where the item is hosted", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"providerId", "description"=>"The provider dependent string that identifies this item", "type"=>"string"}, {"in"=>"body", "name"=>"providerId", "description"=>"The provider dependent string that identifies this item", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"publicIPs", "description"=>"Item???s public IP addresss as a JSON encoded list", "type"=>"string"}, {"in"=>"body", "name"=>"publicIPs", "description"=>"Item???s public IP addresss as a JSON encoded list", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"swapSpace", "description"=>"Item???s swap space", "type"=>"string"}, {"in"=>"body", "name"=>"swapSpace", "description"=>"Item???s swap space", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tags", "description"=>"A JSON list of tag IDs", "type"=>"string"}, {"in"=>"body", "name"=>"tags", "description"=>"A JSON list of tag IDs", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"body", "name"=>"token", "description"=>"Your API token", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Devices"]}}, "/inventory/devices/agentKey/byagentkey"=>{""=>{"summary"=>"View device by agent key", "description"=>"View device by agent key.", "operationId"=>"view-device-by-agent-key", "x-api-path-slug"=>"inventorydevicesagentkeybyagentkey-", "parameters"=>[{"in"=>"path", "name"=>"agentKey", "description"=>"The key used by the agent", "type"=>"string"}, {"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Devices"]}}}}, "apis"=>{"name"=>"Sensr.net", "x-slug"=>"sensr-net", "description"=>"Sensr.net keeps track of interesting images and alert you when something happens. Were starting off with basic motion detection. We keep the images around and organize them by time and day. Well send you an email or a text message if youd like when ...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/924-sensr-net.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"766070", "tags"=>"Cameras,Devices,internet,Internet of Things,Mobile,Relative Data,Sensors,Service API,Surveillance,Technology,Webcams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"sensr-net/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Devices API", "x-api-slug"=>"devices-api", "description"=>"Sensr.net keeps track of interesting images and alert you when something happens. Were starting off with basic motion detection. We keep the images around and organize them by time and day. Well send you an email or a text message if youd like when ...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/924-sensr-net.jpg", "humanURL"=>"https://sensr.net/api", "baseURL"=>"://api.serverdensity.io./", "tags"=>"Cameras,Devices,internet,Internet of Things,Mobile,Relative Data,Sensors,Service API,Surveillance,Technology,Webcams", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/sensr-net/devices-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://sensr.net/api"}, {"type"=>"x-blog", "url"=>"http://sensr.net/blog"}, {"type"=>"x-blog-rss", "url"=>"http://sensr.net/blog/feed/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/sensr-net"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/sensr-net"}, {"type"=>"x-documentation", "url"=>"https://api.sensr.net/doc/v3/index.html"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/sensr"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
moltin{"moltin-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"moltin", "x-complete"=>1, "info"=>{"title"=>"Moltin", "description"=>"-welcomethis-is-a-place-to-put-general-notes-and-extra-information-for-internal-use-to-get-started-designingdocumenting-this-api-select-a-version-on-the-left-", "version"=>"1.0.0"}, "host"=>"api.moltin.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v2/customers/{customerID}/addresses/{addressID}"=>{"get"=>{"summary"=>"Get an Address", "description"=>"Get an address.", "operationId"=>"V2CustomersAddressesByCustomerIDAndAddressIDGet", "x-api-path-slug"=>"v2customerscustomeridaddressesaddressid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"addressID"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"customerID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Addresses"]}, "put"=>{"summary"=>"Update an Address", "description"=>"Update an address.", "operationId"=>"V2CustomersAddressesByCustomerIDAndAddressIDPut", "x-api-path-slug"=>"v2customerscustomeridaddressesaddressid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"addressID"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"customerID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Addresses"]}, "delete"=>{"summary"=>"Delete an Address", "description"=>"Delete an address.", "operationId"=>"V2CustomersAddressesByCustomerIDAndAddressIDDelete", "x-api-path-slug"=>"v2customerscustomeridaddressesaddressid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"addressID"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"customerID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Addresses"]}}, "/v2/promotions/{promotionID}/codes"=>{"get"=>{"summary"=>"Get a list of promotion codes", "description"=>"Get a list of promotion codes.", "operationId"=>"V2PromotionsCodesByPromotionIDGet", "x-api-path-slug"=>"v2promotionspromotionidcodes-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"promotionID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Promotion", "Codes"]}, "post"=>{"summary"=>"Create promotion codes", "description"=>"Create promotion codes.", "operationId"=>"V2PromotionsCodesByPromotionIDPost", "x-api-path-slug"=>"v2promotionspromotionidcodes-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"promotionID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Promotion", "Codes"]}}, "/v2/customers/{customerID}/addresses"=>{"get"=>{"summary"=>"Get an list of Addresses", "description"=>"Get an list of addresses.", "operationId"=>"V2CustomersAddressesByCustomerIDGet2", "x-api-path-slug"=>"v2customerscustomeridaddresses-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"customerID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Addresseses"]}, "post"=>{"summary"=>"Create an Address", "description"=>"Create an address.", "operationId"=>"V2CustomersAddressesByCustomerIDPost", "x-api-path-slug"=>"v2customerscustomeridaddresses-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Change default locale"}, {"in"=>"path", "name"=>"customerID"}, {"in"=>"header", "name"=>"X-Moltin-Customer-Token", "description"=>"Change from default currency"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Addresses"]}}, "/v2/integrations/{integrationID}"=>{"get"=>{"summary"=>"Get an Integration", "description"=>"Get an integration.", "operationId"=>"V2IntegrationsByIntegrationIDGet", "x-api-path-slug"=>"v2integrationsintegrationid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"integrationID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Integration"]}, "put"=>{"summary"=>"Update an Integration", "description"=>"Update an integration.", "operationId"=>"V2IntegrationsByIntegrationIDPut", "x-api-path-slug"=>"v2integrationsintegrationid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"integrationID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Integration"]}, "delete"=>{"summary"=>"Delete an Integration", "description"=>"Delete an integration.", "operationId"=>"V2IntegrationsByIntegrationIDDelete", "x-api-path-slug"=>"v2integrationsintegrationid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"integrationID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Integration"]}}, "/v2/brands/{brandID}"=>{"get"=>{"summary"=>"Get a Brand", "description"=>"Get a brand.", "operationId"=>"V2BrandsByBrandIDGet", "x-api-path-slug"=>"v2brandsbrandid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"brandID"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"include"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Brands"]}, "put"=>{"summary"=>"Update a Brand", "description"=>"Update a brand.", "operationId"=>"V2BrandsByBrandIDPut", "x-api-path-slug"=>"v2brandsbrandid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"brandID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Brands"]}, "delete"=>{"summary"=>"Delete a Brand", "description"=>"Delete a brand.", "operationId"=>"V2BrandsByBrandIDDelete", "x-api-path-slug"=>"v2brandsbrandid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"brandID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Brands"]}}, "/v2/flows"=>{"get"=>{"summary"=>"Get all flows", "description"=>"Get all flows.", "operationId"=>"V2FlowsGet2", "x-api-path-slug"=>"v2flows-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flows"]}, "post"=>{"summary"=>"Create a flow", "description"=>"Create a flow.", "operationId"=>"V2FlowsPost", "x-api-path-slug"=>"v2flows-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow"]}}, "/v2/customers/{customerID}"=>{"get"=>{"summary"=>"Get a Customer", "description"=>"Get a customer.", "operationId"=>"V2CustomersByCustomerIDGet", "x-api-path-slug"=>"v2customerscustomerid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"customerID"}, {"in"=>"header", "name"=>"X-Moltin-Customer-Token", "description"=>"A customer token"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Customer"]}, "put"=>{"summary"=>"Update a Customer", "description"=>"Update a customer.", "operationId"=>"V2CustomersByCustomerIDPut", "x-api-path-slug"=>"v2customerscustomerid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"customerID"}, {"in"=>"header", "name"=>"X-Moltin-Customer-Token"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Customer"]}, "delete"=>{"summary"=>"Delete a Customer", "description"=>"Deletes a customer.", "operationId"=>"V2CustomersByCustomerIDDelete", "x-api-path-slug"=>"v2customerscustomerid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"customerID"}, {"in"=>"header", "name"=>"X-Moltin-Customer-Token"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Customer"]}}, "/v2/flows/{flowSlug}/entries/{entryID}"=>{"get"=>{"summary"=>"Get an entry", "description"=>"Get an entry.", "operationId"=>"V2FlowsEntriesByFlowSlugAndEntryIDGet", "x-api-path-slug"=>"v2flowsflowslugentriesentryid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"entryID"}, {"in"=>"path", "name"=>"flowSlug"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Entry"]}, "put"=>{"summary"=>"Update an entry", "description"=>"Update an entry.", "operationId"=>"V2FlowsEntriesByFlowSlugAndEntryIDPut", "x-api-path-slug"=>"v2flowsflowslugentriesentryid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"entryID"}, {"in"=>"path", "name"=>"flowSlug"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Entry"]}, "delete"=>{"summary"=>"Delete an entry", "description"=>"Delete an entry.", "operationId"=>"V2FlowsEntriesByFlowSlugAndEntryIDDelete", "x-api-path-slug"=>"v2flowsflowslugentriesentryid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"entryID"}, {"in"=>"path", "name"=>"flowSlug"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Entry"]}}, "/v2/orders/{orderID}"=>{"get"=>{"summary"=>"Get a single order", "description"=>"Get a single order.", "operationId"=>"V2OrdersByOrderIDGet", "x-api-path-slug"=>"v2ordersorderid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"orderID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Single", "Order"]}, "put"=>{"summary"=>"Update an order", "description"=>"Transactions are created and updated automatically whenever you make a payment request. When a payment is successful, the transaction ID returned from the gateway will be attached to the transaction.\n\nIt is possible for an order to have more than one transaction attached as each attempted payment will be created as a new transaction.", "operationId"=>"V2OrdersByOrderIDPut", "x-api-path-slug"=>"v2ordersorderid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"orderID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Order"]}}, "/v2/products/{productID}/relationships/variations"=>{"put"=>{"summary"=>"Update Product <=> Variations Relationships", "description"=>"`Product Variation`'s specified in the payload willbe related to the `Product` any relatiosnhips to `Product Variation`'s **NOT** specified in payload will be removed.", "operationId"=>"V2ProductsRelationshipsVariationsByProductIDPut", "x-api-path-slug"=>"v2productsproductidrelationshipsvariations-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Variations", "Relationships"]}, "post"=>{"summary"=>"Create Product <=> Variations Relationships", "description"=>"Here you can add and remove `Product Variation`'s to a product. `Product Variation`'s specified in the payload willbe related to the product.", "operationId"=>"V2ProductsRelationshipsVariationsByProductIDPost", "x-api-path-slug"=>"v2productsproductidrelationshipsvariations-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Variations", "Relationships"]}, "delete"=>{"summary"=>"Delete Product <=> Variations Relationships", "description"=>"Here you can add and remove `Product Variation`'s to a product. Only relationships to `Product Variation`'s specified in the payload will be removed.", "operationId"=>"V2ProductsRelationshipsVariationsByProductIDDelete", "x-api-path-slug"=>"v2productsproductidrelationshipsvariations-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Variations", "Relationships"]}}, "/v2/brands/{brandID}/relationships/parent"=>{"put"=>{"summary"=>"Update Parent Brand Relationship", "description"=>"Update parent brand relationship.", "operationId"=>"V2BrandsRelationshipsParentByBrandIDPut", "x-api-path-slug"=>"v2brandsbrandidrelationshipsparent-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"brandID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Parent", "Brands", "Relationship"]}, "post"=>{"summary"=>"Create Parent Brand Relationship", "description"=>"Create parent brand relationship.", "operationId"=>"V2BrandsRelationshipsParentByBrandIDPost", "x-api-path-slug"=>"v2brandsbrandidrelationshipsparent-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"brandID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Parent", "Brands", "Relationship"]}, "delete"=>{"summary"=>"Delete Parent Brand Relationship", "description"=>"Delete parent brand relationship.", "operationId"=>"V2BrandsRelationshipsParentByBrandIDDelete", "x-api-path-slug"=>"v2brandsbrandidrelationshipsparent-delete", "parameters"=>[{"in"=>"path", "name"=>"brandID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Parent", "Brands", "Relationship"]}}, "/v2/promotions/{promotionID}"=>{"get"=>{"summary"=>"Get a promotion", "description"=>"Get a promotion.", "operationId"=>"V2PromotionsByPromotionIDGet", "x-api-path-slug"=>"v2promotionspromotionid-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"promotionID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Promotion"]}, "put"=>{"summary"=>"Update promotion", "description"=>"Update promotion.", "operationId"=>"V2PromotionsByPromotionIDPut", "x-api-path-slug"=>"v2promotionspromotionid-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"promotionID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Promotion"]}, "delete"=>{"summary"=>"Delete Promotion", "description"=>"Delete promotion.", "operationId"=>"V2PromotionsByPromotionIDDelete", "x-api-path-slug"=>"v2promotionspromotionid-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"promotionID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Promotion"]}}, "/v2/carts/{CART_REFERENCE} "=>{"delete"=>{"summary"=>"Delete Cart", "description"=>"Update an existing item in a cart. The updated cart contents are returned if the call is successful.\n\n**Note:** `{item_id}` in the path is the identifier for the item in the cart **OR** productID.\n\nWhen updating custom itesm you must use the identifier in the cart - you can update more properties of a custom cart item.", "operationId"=>"V2CartsByCARTREFERENCEDelete", "x-api-path-slug"=>"v2cartscart-reference-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"CART_REFERENCE"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Cart"]}}, "/v2/settings"=>{"get"=>{"summary"=>"Get Settings Attributes", "description"=>"Get settings attributes.", "operationId"=>"V2SettingsGet2", "x-api-path-slug"=>"v2settings-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Settings", "Attributes"]}, "put"=>{"summary"=>"Update Settings", "description"=>"Update settings.", "operationId"=>"V2SettingsPut", "x-api-path-slug"=>"v2settings-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Settings"]}}, "/v2/categories/{categoryID}"=>{"get"=>{"summary"=>"Get a Category", "description"=>"Get a category.", "operationId"=>"V2CategoriesByCategoryIDGet", "x-api-path-slug"=>"v2categoriescategoryid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"categoryID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Category"]}, "put"=>{"summary"=>"Update a Category", "description"=>"Update a category.", "operationId"=>"V2CategoriesByCategoryIDPut", "x-api-path-slug"=>"v2categoriescategoryid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"categoryID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Category"]}, "delete"=>{"summary"=>"Delete a Category", "description"=>"Delete a category.", "operationId"=>"V2CategoriesByCategoryIDDelete", "x-api-path-slug"=>"v2categoriescategoryid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"categoryID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Category"]}}, "/v2/carts/123456/items"=>{"get"=>{"summary"=>"Get the items in a cart", "description"=>"Get the items in a cart.", "operationId"=>"V2Carts123456ItemsGet", "x-api-path-slug"=>"v2carts123456items-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Items", "Cart"]}, "post"=>{"summary"=>"Add a promotion to a cart", "description"=>"Update an existing item in a cart. The updated cart contents are returned if the call is successful.\n\n**Note:** `{item_id}` in the path is the identifier for the item in the cart **OR** productID.\n\nWhen updating custom itesm you must use the identifier in the cart - you can update more properties of a custom cart item.", "operationId"=>"V2Carts123456ItemsPost2", "x-api-path-slug"=>"v2carts123456items-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Promotion", "To", "Cart"]}}, "/v2/products/{productID}/relationships/files"=>{"put"=>{"summary"=>"Update Products <=> Files Relationships", "description"=>"`File`'s specified in the payload willbe related to the product any relatiosnhips to `File`'s **NOT** specified in payload will be removed.", "operationId"=>"V2ProductsRelationshipsFilesByProductIDPut", "x-api-path-slug"=>"v2productsproductidrelationshipsfiles-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Productss", "Files", "Relationships"]}, "post"=>{"summary"=>"Create Products <=> Files Relationships", "description"=>"Here you can add `File`'s to a product. `File`'s specified in the payload willbe related to the product.", "operationId"=>"V2ProductsRelationshipsFilesByProductIDPost", "x-api-path-slug"=>"v2productsproductidrelationshipsfiles-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Productss", "Files", "Relationships"]}, "delete"=>{"summary"=>"Delete Products <=> Files Relationship", "description"=>"Here you can delete a relationship between a `Product` and `File`'s. Only relationships to `File`'s specified in the payload will be removed.", "operationId"=>"V2ProductsRelationshipsFilesByProductIDDelete", "x-api-path-slug"=>"v2productsproductidrelationshipsfiles-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Productss", "Files", "Relationship"]}}, "/v2/integrations/attributes"=>{"get"=>{"summary"=>"Get Integration Attributes", "description"=>"Get integration attributes.", "operationId"=>"V2IntegrationsAttributesGet", "x-api-path-slug"=>"v2integrationsattributes-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Integration", "Attributes"]}}, "/v2/gateways/braintree"=>{"put"=>{"summary"=>"Braintree - Update", "description"=>"This endpoint allows you to pay for an order using Braintree and a users credit card.", "operationId"=>"V2GatewaysBraintreePut", "x-api-path-slug"=>"v2gatewaysbraintree-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Braintree", "-"]}}, "/v2/collections/{collectionID}/relationships/collections"=>{"post"=>{"summary"=>"Create Collection Relationships", "description"=>"Create collection relationships.", "operationId"=>"V2CollectionsRelationshipsCollectionsByCollectionIDPost", "x-api-path-slug"=>"v2collectionscollectionidrelationshipscollections-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"collectionID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Collection", "Relationships"]}}, "/v2/integrations/{integrationID}/logs"=>{"get"=>{"summary"=>"Get Logs for an Integration", "description"=>"Get logs for an integration.", "operationId"=>"V2IntegrationsLogsByIntegrationIDGet", "x-api-path-slug"=>"v2integrationsintegrationidlogs-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"integrationID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Logsan", "Integration"]}}, "/v2/categories/{categoryID}/relationships/children"=>{"put"=>{"summary"=>"Update Child Category Relationships", "description"=>"Update child category relationships.", "operationId"=>"V2CategoriesRelationshipsChildrenByCategoryIDPut", "x-api-path-slug"=>"v2categoriescategoryidrelationshipschildren-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"categoryID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Child", "Category", "Relationships"]}, "delete"=>{"summary"=>"Delete Child Category Relationships", "description"=>"Delete child category relationships.", "operationId"=>"V2CategoriesRelationshipsChildrenByCategoryIDDelete", "x-api-path-slug"=>"v2categoriescategoryidrelationshipschildren-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"categoryID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Child", "Category", "Relationships"]}}, "/v2/collections"=>{"get"=>{"summary"=>"Get Collections List", "description"=>"Get collections list.", "operationId"=>"V2CollectionsGet", "x-api-path-slug"=>"v2collections-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Collections", "List"]}, "post"=>{"summary"=>"Create a Collection", "description"=>"Create a collection.", "operationId"=>"V2CollectionsPost", "x-api-path-slug"=>"v2collections-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Collection"]}}, "/categories/{categoryID}/relationships/children"=>{"post"=>{"summary"=>"Create Child Category Relationships", "description"=>"Create child category relationships.", "operationId"=>"CategoriesRelationshipsChildrenByCategoryIDPost", "x-api-path-slug"=>"categoriescategoryidrelationshipschildren-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"categoryID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Child", "Category", "Relationships"]}}, "/v2/carts/123456"=>{"get"=>{"summary"=>"Get a Cart", "description"=>"Get a cart.", "operationId"=>"V2Carts123456Get", "x-api-path-slug"=>"v2carts123456-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Cart"]}}, "/v2/collections/{collectionID}"=>{"get"=>{"summary"=>"Get a Collection", "description"=>"Get a collection.", "operationId"=>"V2CollectionsByCollectionIDGet", "x-api-path-slug"=>"v2collectionscollectionid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"collectionID"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"filter"}, {"in"=>"query", "name"=>"include"}, {"in"=>"query", "name"=>"page[limit]"}, {"in"=>"query", "name"=>"page[offset]"}, {"in"=>"query", "name"=>"sort"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Collection"]}, "put"=>{"summary"=>"Update a Collection", "description"=>"Update a collection.", "operationId"=>"V2CollectionsByCollectionIDPut", "x-api-path-slug"=>"v2collectionscollectionid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"collectionID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Collection"]}, "delete"=>{"summary"=>"Delete a Collection", "description"=>"Delete a collection.", "operationId"=>"V2CollectionsByCollectionIDDelete", "x-api-path-slug"=>"v2collectionscollectionid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"collectionID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Collection"]}}, "/v2/inventories "=>{"get"=>{"summary"=>"Get all stock", "description"=>"Get all stock.", "operationId"=>"V2InventoriesGet", "x-api-path-slug"=>"v2inventories-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Stock"]}}, "/v2/flows/{flowID}"=>{"get"=>{"summary"=>"Get a flow", "description"=>"Get a flow.", "operationId"=>"V2FlowsByFlowIDGet", "x-api-path-slug"=>"v2flowsflowid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"flowID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow"]}, "put"=>{"summary"=>"Update a flow", "description"=>"Update a flow.", "operationId"=>"V2FlowsByFlowIDPut", "x-api-path-slug"=>"v2flowsflowid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"flowID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow"]}, "delete"=>{"summary"=>"Delete a flow", "description"=>"Delete a flow.", "operationId"=>"V2FlowsByFlowIDDelete", "x-api-path-slug"=>"v2flowsflowid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"flowID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow"]}}, "/v2/gateways/adyen"=>{"put"=>{"summary"=>"Adyen - Card Update", "description"=>"This endpoint allows you to pay for an order using Braintree and a users credit card.", "operationId"=>"V2GatewaysAdyenPut", "x-api-path-slug"=>"v2gatewaysadyen-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Adyen", "-", "Card"]}}, "/v2/carts/123456/items/{itemID}"=>{"put"=>{"summary"=>"Update an item in a cart", "description"=>"Update an existing item in a cart. The updated cart contents are returned if the call is successful.\n\n**Note:** `{item_id}` in the path is the identifier for the item in the cart **OR** productID.\n\nWhen updating custom itesm you must use the identifier in the cart - you can update more properties of a custom cart item.", "operationId"=>"V2Carts123456ItemsByItemIDPut", "x-api-path-slug"=>"v2carts123456itemsitemid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"itemID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Item", "Cart"]}}, "/v2/flows/{flowSlug}/entries/{ENTRY_ID}/relationships/{flowSlug}"=>{"put"=>{"summary"=>"Update Entry Relationship(s)", "description"=>"Update entry relationship(s).", "operationId"=>"V2FlowsEntriesRelationshipsFlowSlugByFlowSlugAndENTRYIDPut", "x-api-path-slug"=>"v2flowsflowslugentriesentry-idrelationshipsflowslug-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"ENTRY_ID"}, {"in"=>"path", "name"=>"flowSlug"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Entry", "Relationship(s)"]}, "delete"=>{"summary"=>"Delete Entry Relationship(s)", "description"=>"Delete entry relationship(s).", "operationId"=>"V2FlowsEntriesRelationshipsFlowSlugByFlowSlugAndENTRYIDDelete", "x-api-path-slug"=>"v2flowsflowslugentriesentry-idrelationshipsflowslug-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"ENTRY_ID"}, {"in"=>"path", "name"=>"flowSlug"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Entry", "Relationship(s)"]}}, "/v2/inventories/{productID}/transactions"=>{"get"=>{"summary"=>"Stock transactions for a product", "description"=>"Stock transactions for a product.", "operationId"=>"V2InventoriesTransactionsByProductIDGet", "x-api-path-slug"=>"v2inventoriesproductidtransactions-get", "parameters"=>[{"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Stock", "Transactionsa", "Products"]}, "post"=>{"summary"=>"Create a stock transaction for a product", "description"=>"Create a stock transaction for a product.", "operationId"=>"V2InventoriesTransactionsByProductIDPost", "x-api-path-slug"=>"v2inventoriesproductidtransactions-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Stock", "Transactiona", "Products"]}}, "/v2/products/{productID}"=>{"get"=>{"summary"=>"Get a Product", "description"=>"Get a product.", "operationId"=>"V2ProductsByProductIDGet", "x-api-path-slug"=>"v2productsproductid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products"]}, "put"=>{"summary"=>"Update a Product", "description"=>"Update a product.", "operationId"=>"V2ProductsByProductIDPut", "x-api-path-slug"=>"v2productsproductid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products"]}, "delete"=>{"summary"=>"Delete a Product", "description"=>"Delete a product.", "operationId"=>"V2ProductsByProductIDDelete", "x-api-path-slug"=>"v2productsproductid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products"]}}, "/v2/products/{productID}/relationships/brands"=>{"put"=>{"summary"=>"Update Product <=> Brands Relationships", "description"=>"Here you can set relations `Brand`'s to a product. The result of this request will set relationships between product and the specified brnads in teh payload and remove any other relations the product had with brands.", "operationId"=>"V2ProductsRelationshipsBrandsByProductIDPut", "x-api-path-slug"=>"v2productsproductidrelationshipsbrands-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Brandss", "Relationships"]}, "post"=>{"summary"=>"Create Product <=> Brands Relationships", "description"=>"Here you can add `Brand`'s to a product. The `Brand`'s found in the payload will be added to any other relationships to `Brand`'s present.", "operationId"=>"V2ProductsRelationshipsBrandsByProductIDPost", "x-api-path-slug"=>"v2productsproductidrelationshipsbrands-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Brandss", "Relationships"]}, "delete"=>{"summary"=>"Delete Products <=> Brands Relationships", "description"=>"Here you can delete a relationship between a `Product` and `Brand`'s. Only those relationshops to `Brand`'s specified in the paylaod will be removed.", "operationId"=>"V2ProductsRelationshipsBrandsByProductIDDelete2", "x-api-path-slug"=>"v2productsproductidrelationshipsbrands-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Brands", "Relationships"]}}, "/v2/files/{fileID}"=>{"get"=>{"summary"=>"Get a file", "description"=>"Get a file.", "operationId"=>"V2FilesByFileIDGet", "x-api-path-slug"=>"v2filesfileid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"fileID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["File"]}, "delete"=>{"summary"=>"Delete a file", "description"=>"Delete a file.", "operationId"=>"V2FilesByFileIDDelete", "x-api-path-slug"=>"v2filesfileid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"fileID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["File"]}}, "/v2/fields"=>{"get"=>{"summary"=>"Get a field list", "description"=>"Get a field list.", "operationId"=>"V2FieldsGet", "x-api-path-slug"=>"v2fields-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Field", "List"]}, "post"=>{"summary"=>"Create a field", "description"=>"Create a field.", "operationId"=>"V2FieldsPost", "x-api-path-slug"=>"v2fields-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Field"]}}, "/v2/brands/{brandID}/relationships/children"=>{"put"=>{"summary"=>"Update Child Brand Relationship", "description"=>"Update child brand relationship.", "operationId"=>"V2BrandsRelationshipsChildrenByBrandIDPut", "x-api-path-slug"=>"v2brandsbrandidrelationshipschildren-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"brandID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Child", "Brands", "Relationship"]}, "post"=>{"summary"=>"Create Child Brand Relationship", "description"=>"Create child brand relationship.", "operationId"=>"V2BrandsRelationshipsChildrenByBrandIDPost", "x-api-path-slug"=>"v2brandsbrandidrelationshipschildren-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"brandID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Child", "Brands", "Relationship"]}, "delete"=>{"summary"=>"Update Child Brand Relationship Copy", "description"=>"Update child brand relationship copy.", "operationId"=>"V2BrandsRelationshipsChildrenByBrandIDDelete", "x-api-path-slug"=>"v2brandsbrandidrelationshipschildren-delete", "parameters"=>[{"in"=>"path", "name"=>"brandID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Child", "Brands", "Relationship", "Copy"]}}, "/v2/collections/{collectionID}/relationships/parent"=>{"put"=>{"summary"=>"Update Parent Collection Relationship", "description"=>"Update parent collection relationship.", "operationId"=>"V2CollectionsRelationshipsParentByCollectionIDPut", "x-api-path-slug"=>"v2collectionscollectionidrelationshipsparent-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"collectionID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Parent", "Collection", "Relationship"]}, "post"=>{"summary"=>"Create Parent Collection Relationship", "description"=>"Create parent collection relationship.", "operationId"=>"V2CollectionsRelationshipsParentByCollectionIDPost", "x-api-path-slug"=>"v2collectionscollectionidrelationshipsparent-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"collectionID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Parent", "Collection", "Relationship"]}, "delete"=>{"summary"=>"Delete Parent Collection Relationship", "description"=>"Delete parent collection relationship.", "operationId"=>"V2CollectionsRelationshipsParentByCollectionIDDelete", "x-api-path-slug"=>"v2collectionscollectionidrelationshipsparent-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"collectionID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Parent", "Collection", "Relationship"]}}, "/v2/variations/{variationID}"=>{"get"=>{"summary"=>"Get a Product Variation", "description"=>"Get a product variation.", "operationId"=>"V2VariationsByVariationIDGet", "x-api-path-slug"=>"v2variationsvariationid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"variationID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Variation"]}, "put"=>{"summary"=>"Update a Product Variation", "description"=>"Update a product variation.", "operationId"=>"V2VariationsByVariationIDPut", "x-api-path-slug"=>"v2variationsvariationid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"variationID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Variation"]}, "delete"=>{"summary"=>"Delete a Product Variation", "description"=>"Delete a product variation.", "operationId"=>"V2VariationsByVariationIDDelete", "x-api-path-slug"=>"v2variationsvariationid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"variationID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Variation"]}}, "/v2/customers"=>{"get"=>{"summary"=>"Get Customers List", "description"=>"Get customers list.", "operationId"=>"V2CustomersGet", "x-api-path-slug"=>"v2customers-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"filter"}, {"in"=>"query", "name"=>"page[limit]"}, {"in"=>"query", "name"=>"page[offset]"}, {"in"=>"query", "name"=>"sort"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Customers", "List"]}, "post"=>{"summary"=>"Create a Customer", "description"=>"Create a customer.", "operationId"=>"V2CustomersPost", "x-api-path-slug"=>"v2customers-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Customer"]}}, "/v2/products/{productID}/build"=>{"post"=>{"summary"=>"Build Child Products", "description"=>"Build child products.", "operationId"=>"V2ProductsBuildByProductIDPost", "x-api-path-slug"=>"v2productsproductidbuild-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Build", "Child", "Products"]}}, "/oauth/access_token"=>{"post"=>{"summary"=>"Client credential token", "description"=>"An access token will allow you to make requests for your store. We support two types of token: `client_credentials` and `implicit`.\n\nAn `implcit` token is typically used for situations where you are requesting data on the client side and you are exposing your public key - such as JavaScript - and adding your client secret would be disastrous. You will only be able to perform a limited number of operations on the API endpoints.\n\nA `client_credentials` token is used when the credentials are not publicly exposed, usually a server side language such as PHP. You will be able to perform all operations on API endpoints.\n\nA `refresh_token` type can be used when you have an existing token which you would like to extend the life of. When your `grant_type` is `refresh_token` you must also provide the original token in the `refresh_token` field.", "operationId"=>"OauthAccessTokenPost2", "x-api-path-slug"=>"oauthaccess-token-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"formData", "name"=>"client_id", "description"=>"Replace with the values from your dashboard"}, {"in"=>"formData", "name"=>"client_secret", "description"=>"Replace with the values from your dashboard"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"formData", "name"=>"grant_type", "description"=>"client_credentials | implicit | refresh_token"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Client", "Credential", "Token"]}}, "/v2/collections/tree"=>{"get"=>{"summary"=>"Get Collection tree", "description"=>"Get collection tree.", "operationId"=>"V2CollectionsTreeGet", "x-api-path-slug"=>"v2collectionstree-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Collection", "Tree"]}}, "/v2/products/{ProductID}relationships/brands"=>{"post"=>{"summary"=>"Create Products <=> Main Image Relationships", "description"=>"Here you can add a `Main Image` to a product. The `Main Image` will be a file and that file will be shown as the first image for the product it is related to.\n\nIt's worth noting that you can only have 1 main image so unlike other relationships, you will be passing an object instead of an array in the body.\n\nIn the Object, the type will be `main_image` and the ID will be the ID of the file you wish to make the main image for that product.", "operationId"=>"V2ProductsRelationshipsBrandsByProductIDPost2", "x-api-path-slug"=>"v2productsproductidrelationshipsbrands-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"ProductID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Productss", "Main", "Image", "Relationships"]}, "delete"=>{"summary"=>"Delete Products <=> Main Image Relationships", "description"=>"Here you can delete the `Main Image` from a product.\n\nIn the Object payload, the type will be `main_image` and the ID will be the ID of the main image you wish to delete from that product.", "operationId"=>"V2ProductsRelationshipsBrandsByProductIDDelete", "x-api-path-slug"=>"v2productsproductidrelationshipsbrands-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"ProductID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Productss", "Main", "Image", "Relationships"]}}, "/v2/flows/{flowSlug}/entries"=>{"get"=>{"summary"=>"Get all entries on a flow", "description"=>"Get all entries on a flow.", "operationId"=>"V2FlowsEntriesByFlowSlugGet", "x-api-path-slug"=>"v2flowsflowslugentries-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"flowSlug"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Entries", "On", "Flow"]}, "post"=>{"summary"=>"Create an entry", "description"=>"Create an entry.", "operationId"=>"V2FlowsEntriesByFlowSlugPost", "x-api-path-slug"=>"v2flowsflowslugentries-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"flowSlug"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Entry"]}}, "/v2/fields/{fieldID}"=>{"get"=>{"summary"=>"Get a field", "description"=>"Get a field.", "operationId"=>"V2FieldsByFieldIDGet", "x-api-path-slug"=>"v2fieldsfieldid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"fieldID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Field"]}, "put"=>{"summary"=>"Update a field", "description"=>"Update a field.", "operationId"=>"V2FieldsByFieldIDPut", "x-api-path-slug"=>"v2fieldsfieldid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"fieldID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Field"]}, "delete"=>{"summary"=>"Delete a field", "description"=>"Delete a field.", "operationId"=>"V2FieldsByFieldIDDelete", "x-api-path-slug"=>"v2fieldsfieldid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"fieldID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Field"]}}, "/v2/carts/123456/checkout"=>{"post"=>{"summary"=>"Checkout using customer id", "description"=>"Converts a cart to an incomplete order. The original cart will remain and can be modified and checked out again if required.\n\nThe new order will be returned and `data.meta.payment_gateways` will contain an array of the available payment gateways for this order.", "operationId"=>"V2Carts123456CheckoutPost2", "x-api-path-slug"=>"v2carts123456checkout-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Checkout", "Using", "Customer", "Id"]}}, "/v2/products/{productID}/relationships/categories"=>{"put"=>{"summary"=>"Update Product <=> Categories Relationships", "description"=>"Here you can update `Categories` to a product. `Categories` specified in the payload willbe related to the product any relatiosnhips to `Categories` **NOT** specified in payload will be removed.", "operationId"=>"V2ProductsRelationshipsCategoriesByProductIDPut", "x-api-path-slug"=>"v2productsproductidrelationshipscategories-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Categories", "Relationships"]}, "post"=>{"summary"=>"Create Product <=> Categories Relationships", "description"=>"Here you can add `Categories` to a product. `Categories` specified in the payload willbe related to the product.", "operationId"=>"V2ProductsRelationshipsCategoriesByProductIDPost", "x-api-path-slug"=>"v2productsproductidrelationshipscategories-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Categories", "Relationships"]}, "delete"=>{"summary"=>"Delete Product <=> Categories Relationships", "description"=>"Here you can delete a relationship between a `Product` and `Category`. Only relationships to `Categories` specified in the payload will be removed.", "operationId"=>"V2ProductsRelationshipsCategoriesByProductIDDelete", "x-api-path-slug"=>"v2productsproductidrelationshipscategories-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Categories", "Relationships"]}}, "/v2/variations"=>{"get"=>{"summary"=>"Get Product Variations List", "description"=>"Get product variations list.", "operationId"=>"V2VariationsGet", "x-api-path-slug"=>"v2variations-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Variations", "List"]}, "post"=>{"summary"=>"Create a Product Variation", "description"=>"Create a product variation.", "operationId"=>"V2VariationsPost", "x-api-path-slug"=>"v2variations-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Variation"]}}, "/v2/brands/tree"=>{"get"=>{"summary"=>"Get a Brand tree", "description"=>"Get a brand tree.", "operationId"=>"V2BrandsTreeGet", "x-api-path-slug"=>"v2brandstree-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Brands", "Tree"]}}, "/v2/flows/{flowSlug}/fields"=>{"get"=>{"summary"=>"Get all fields on a flow", "description"=>"Get all fields on a flow.", "operationId"=>"V2FlowsFieldsByFlowSlugGet", "x-api-path-slug"=>"v2flowsflowslugfields-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"flowSlug"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Fields", "On", "Flow"]}}, "/v2/currencies"=>{"get"=>{"summary"=>"Get Currencies List", "description"=>"Get currencies list.", "operationId"=>"V2CurrenciesGet", "x-api-path-slug"=>"v2currencies-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Currencies", "List"]}, "post"=>{"summary"=>"Create a Currency", "description"=>"Create a currency.", "operationId"=>"V2CurrenciesPost", "x-api-path-slug"=>"v2currencies-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Currency"]}}, "/v2/products/{productID}/relationships/collections"=>{"put"=>{"summary"=>"Update Products <=> Collections Relationships", "description"=>"`Collection`'s specified in the payload willbe related to the product any relatiosnhips to `Collection`'s **NOT** specified in payload will be removed.", "operationId"=>"V2ProductsRelationshipsCollectionsByProductIDPut", "x-api-path-slug"=>"v2productsproductidrelationshipscollections-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Productss", "Collections", "Relationships"]}, "post"=>{"summary"=>"Create Products <=> Collections Relationships", "description"=>"Here you can add `Collection`'s to a product. `Collection`'s specified in the payload willbe related to the product.", "operationId"=>"V2ProductsRelationshipsCollectionsByProductIDPost", "x-api-path-slug"=>"v2productsproductidrelationshipscollections-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Productss", "Collections", "Relationships"]}, "delete"=>{"summary"=>"Delete Products <=> Collections Relationships", "description"=>"Here you can delete a relationship between a `Product` and `Collections`. Only relationships to `Collections` specified in the payload will be removed.", "operationId"=>"V2ProductsRelationshipsCollectionsByProductIDDelete", "x-api-path-slug"=>"v2productsproductidrelationshipscollections-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Productss", "Collections", "Relationships"]}}, "/v2/currencies/{currencyID}"=>{"get"=>{"summary"=>"Get a Currency", "description"=>"Get a currency.", "operationId"=>"V2CurrenciesByCurrencyIDGet", "x-api-path-slug"=>"v2currenciescurrencyid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"currencyID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Currency"]}, "put"=>{"summary"=>"Update a Currency", "description"=>"Update a currency.", "operationId"=>"V2CurrenciesByCurrencyIDPut", "x-api-path-slug"=>"v2currenciescurrencyid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"currencyID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Currency"]}, "delete"=>{"summary"=>"Delete a Currency", "description"=>"Delete a currency.", "operationId"=>"V2CurrenciesByCurrencyIDDelete", "x-api-path-slug"=>"v2currenciescurrencyid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"currencyID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Currency"]}}, "/v2/variations/{variationID}/options/{optionID}"=>{"put"=>{"summary"=>"Update a Product Variation Option", "description"=>"Update a product variation option.", "operationId"=>"V2VariationsOptionsByVariationIDAndOptionIDPut", "x-api-path-slug"=>"v2variationsvariationidoptionsoptionid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"optionID"}, {"in"=>"path", "name"=>"variationID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Variation", "Option"]}, "delete"=>{"summary"=>"Delete a Product Variation Option", "description"=>"Delete a product variation option.", "operationId"=>"V2VariationsOptionsByVariationIDAndOptionIDDelete", "x-api-path-slug"=>"v2variationsvariationidoptionsoptionid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"optionID"}, {"in"=>"path", "name"=>"variationID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Variation", "Option"]}}, "/v2/categories/{parentCatID}/relationships/parent"=>{"put"=>{"summary"=>"Update Parent Category Parent", "description"=>"Update parent category parent.", "operationId"=>"V2CategoriesRelationshipsParentByParentCatIDPut", "x-api-path-slug"=>"v2categoriesparentcatidrelationshipsparent-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"parentCatID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Parent", "Category", "Parent"]}}, "/v2/gateways"=>{"get"=>{"summary"=>"Get a list of gateways", "description"=>"This endpoint allows you to pay for an order using Braintree and a users credit card.", "operationId"=>"V2GatewaysGet", "x-api-path-slug"=>"v2gateways-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Gateways"]}}, "/v2/variations/{variationID}/options/{optionID}/modifiers/{modifierID}"=>{"put"=>{"summary"=>"Update Product Modifier", "description"=>"Update product modifier.", "operationId"=>"V2VariationsOptionsModifiersModifierIDByVariationIDAndOptionIDPut", "x-api-path-slug"=>"v2variationsvariationidoptionsoptionidmodifiersmodifierid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"modifierID"}, {"in"=>"path", "name"=>"optionID"}, {"in"=>"path", "name"=>"variationID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Modifier"]}, "delete"=>{"summary"=>"Delete Product Modifier", "description"=>"Delete product modifier.", "operationId"=>"V2VariationsOptionsModifiersModifierIDByVariationIDAndOptionIDDelete", "x-api-path-slug"=>"v2variationsvariationidoptionsoptionidmodifiersmodifierid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"modifierID"}, {"in"=>"path", "name"=>"optionID"}, {"in"=>"path", "name"=>"variationID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Modifier"]}}, "/categories/{categoryID}/relationships/categories"=>{"delete"=>{"summary"=>"Delete Category-Category Relationships", "description"=>"Delete category-category relationships.", "operationId"=>"CategoriesRelationshipsCategoriesByCategoryIDDelete", "x-api-path-slug"=>"categoriescategoryidrelationshipscategories-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"categoryID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Category-Category", "Relationships"]}}, "/v2/variations/{variationID}/options/{optionID}/modifiers"=>{"post"=>{"summary"=>"Create Product Modifier", "description"=>"Create product modifier.", "operationId"=>"V2VariationsOptionsModifiersByVariationIDAndOptionIDPost", "x-api-path-slug"=>"v2variationsvariationidoptionsoptionidmodifiers-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"optionID"}, {"in"=>"path", "name"=>"variationID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Modifier"]}}, "/v2/brands/attributes"=>{"get"=>{"summary"=>"Get Brand Attributes", "description"=>"Get brand attributes.", "operationId"=>"V2BrandsAttributesGet", "x-api-path-slug"=>"v2brandsattributes-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Brands", "Attributes"]}}, "/v2/gateways/stripe"=>{"get"=>{"summary"=>"Get a gateway (stripe)", "description"=>"This endpoint allows you to pay for an order using Braintree and a users credit card.", "operationId"=>"V2GatewaysStripeGet", "x-api-path-slug"=>"v2gatewaysstripe-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Gateway", "(stripe)"]}}, "/v2/collections/{collectionID}/relationships/children"=>{"put"=>{"summary"=>"Update Child Collection Relationship", "description"=>"Update child collection relationship.", "operationId"=>"V2CollectionsRelationshipsChildrenByCollectionIDPut", "x-api-path-slug"=>"v2collectionscollectionidrelationshipschildren-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"collectionID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Child", "Collection", "Relationship"]}, "post"=>{"summary"=>"Create Child Collection Relationships", "description"=>"Create child collection relationships.", "operationId"=>"V2CollectionsRelationshipsChildrenByCollectionIDPost", "x-api-path-slug"=>"v2collectionscollectionidrelationshipschildren-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"collectionID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Child", "Collection", "Relationships"]}, "delete"=>{"summary"=>"Delete Child Collection Relationship", "description"=>"Delete child collection relationship.", "operationId"=>"V2CollectionsRelationshipsChildrenByCollectionIDDelete", "x-api-path-slug"=>"v2collectionscollectionidrelationshipschildren-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"collectionID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Child", "Collection", "Relationship"]}}, "/v2/categories/{categoryID}/relationships/categories"=>{"post"=>{"summary"=>"Create Parent Category Relationship", "description"=>"Using this endpoint you can create a relationship between a category and a parent category. When returning the category tree, you will see this relationship in place.", "operationId"=>"V2CategoriesRelationshipsCategoriesByCategoryIDPost", "x-api-path-slug"=>"v2categoriescategoryidrelationshipscategories-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"categoryID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Parent", "Category", "Relationship"]}}, "/v2/carts/123456/items/{cartItemID}"=>{"delete"=>{"summary"=>"Delete an item from a cart", "description"=>"Delete an item from a cart. The remaining cart contents are returned on a successful delete.\n\n**Note:** `{item_id}` in the path is the identifier for the item in the cart rather than the product_id", "operationId"=>"V2Carts123456ItemsByCartItemIDDelete", "x-api-path-slug"=>"v2carts123456itemscartitemid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"cartItemID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Item", "From", "Cart"]}}, "/orders/{orderID}/items"=>{"get"=>{"summary"=>"Get Order Items", "description"=>"Get order items.", "operationId"=>"OrdersItemsByOrderIDGet", "x-api-path-slug"=>"ordersorderiditems-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"orderID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Order", "Items"]}}, "/v2/inventories/{productID}"=>{"get"=>{"summary"=>"Get stock for a product", "description"=>"Get stock for a product.", "operationId"=>"V2InventoriesByProductIDGet", "x-api-path-slug"=>"v2inventoriesproductid-get", "parameters"=>[{"in"=>"path", "name"=>"productID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Stocka", "Products"]}}, "/v2/integrations/{integrationID}/jobs"=>{"get"=>{"summary"=>"Get all Jobs for an Integration", "description"=>"Get all jobs for an integration.", "operationId"=>"V2IntegrationsJobsByIntegrationIDGet", "x-api-path-slug"=>"v2integrationsintegrationidjobs-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"integrationID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Jobsan", "Integration"]}}, "/v2/integrations/{integrationID}/jobs/{integrationJobID}/logs"=>{"get"=>{"summary"=>"Get Logs for a Job", "description"=>"Get logs for a job.", "operationId"=>"V2IntegrationsJobsLogsByIntegrationIDAndIntegrationJobIDGet", "x-api-path-slug"=>"v2integrationsintegrationidjobsintegrationjobidlogs-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"integrationID"}, {"in"=>"path", "name"=>"integrationJobID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Logsa", "Job"]}}, "/v2/integrations"=>{"get"=>{"summary"=>"Get Integrations list", "description"=>"Get integrations list.", "operationId"=>"V2IntegrationsGet", "x-api-path-slug"=>"v2integrations-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Integrations", "List"]}, "post"=>{"summary"=>"Create an Integration", "description"=>"Create an integration.", "operationId"=>"V2IntegrationsPost", "x-api-path-slug"=>"v2integrations-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Integration"]}}, "/v2/orders/{orderID}/transactions/{TransactionID}/capture"=>{"post"=>{"summary"=>"Capture an authorize", "description"=>"Capture an authorize.", "operationId"=>"V2OrdersTransactionsCaptureByOrderIDAndTransactionIDPost", "x-api-path-slug"=>"v2ordersorderidtransactionstransactionidcapture-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"orderID"}, {"in"=>"path", "name"=>"TransactionID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Capture", "Authorize"]}}, "/categories/attributes"=>{"get"=>{"summary"=>"Get Category Attributes", "description"=>"Get category attributes.", "operationId"=>"CategoriesAttributesGet", "x-api-path-slug"=>"categoriesattributes-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Category", "Attributes"]}}, "/v2/products/attributes"=>{"get"=>{"summary"=>"Get Product Attributes", "description"=>"Get product attributes.", "operationId"=>"V2ProductsAttributesGet", "x-api-path-slug"=>"v2productsattributes-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Attributes"]}}, "/v2/orders/{ORDER_ID}/transactions/{TRANSACTION_ID}/capture"=>{"put"=>{"summary"=>"Stripe - Card Update", "description"=>"This endpoint allows you to pay for an order using Braintree and a users credit card.", "operationId"=>"V2OrdersTransactionsCaptureByORDERIDAndTRANSACTIONIDPut", "x-api-path-slug"=>"v2ordersorder-idtransactionstransaction-idcapture-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"ORDER_ID"}, {"in"=>"path", "name"=>"TRANSACTION_ID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Stripe", "-", "Card"]}}, "/v2/categories/{categoryID}/relationships/parent"=>{"delete"=>{"summary"=>"Delete Parent Category Parent", "description"=>"Delete parent category parent.", "operationId"=>"V2CategoriesRelationshipsParentByCategoryIDDelete", "x-api-path-slug"=>"v2categoriescategoryidrelationshipsparent-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"categoryID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Parent", "Category", "Parent"]}}, "/v2/files"=>{"get"=>{"summary"=>"Get all files", "description"=>"Get all files.", "operationId"=>"V2FilesGet", "x-api-path-slug"=>"v2files-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"filter"}, {"in"=>"query", "name"=>"page[limit]"}, {"in"=>"query", "name"=>"page[offset]"}, {"in"=>"query", "name"=>"sort"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Files"]}, "post"=>{"summary"=>"Create a file", "description"=>"Create a file.", "operationId"=>"V2FilesPost", "x-api-path-slug"=>"v2files-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["File"]}}, "/v2/categories"=>{"get"=>{"summary"=>"Get Categories List", "description"=>"Get categories list.", "operationId"=>"V2CategoriesGet", "x-api-path-slug"=>"v2categories-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Categories", "List"]}, "post"=>{"summary"=>"Create a Category", "description"=>"Create a category.", "operationId"=>"V2CategoriesPost", "x-api-path-slug"=>"v2categories-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Category"]}}, "/v2/categories/categories/tree"=>{"get"=>{"summary"=>"Category Tree", "description"=>"Category tree.", "operationId"=>"V2CategoriesCategoriesTreeGet", "x-api-path-slug"=>"v2categoriescategoriestree-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Category", "Tree"]}}, "/carts/{cartRef}"=>{"delete"=>{"summary"=>"Delete a Cart", "description"=>"Removes all items in a cart.", "operationId"=>"CartsByCartRefDelete", "x-api-path-slug"=>"cartscartref-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"cartRef"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Cart"]}}, "/v2/integrations/logs"=>{"get"=>{"summary"=>"Get all Logs", "description"=>"Get all logs.", "operationId"=>"V2IntegrationsLogsGet", "x-api-path-slug"=>"v2integrationslogs-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Logs"]}}, "/v2/brands"=>{"get"=>{"summary"=>"Get a list of Brands", "description"=>"Get a list of brands.", "operationId"=>"V2BrandsGet", "x-api-path-slug"=>"v2brands-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Brands"]}, "post"=>{"summary"=>"Create a Brand", "description"=>"Create a brand.", "operationId"=>"V2BrandsPost", "x-api-path-slug"=>"v2brands-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Brands"]}}, "/v2/promotions"=>{"get"=>{"summary"=>"Get a list of promotions", "description"=>"Get a list of promotions.", "operationId"=>"V2PromotionsGet", "x-api-path-slug"=>"v2promotions-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Promotions"]}, "post"=>{"summary"=>"Create a promotion", "description"=>"Create a promotion.", "operationId"=>"V2PromotionsPost", "x-api-path-slug"=>"v2promotions-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Promotion"]}}, "/v2/customers/tokens "=>{"post"=>{"summary"=>"Generate a customer token", "description"=>"Generate a customer token.", "operationId"=>"V2CustomersTokensPost", "x-api-path-slug"=>"v2customerstokens-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Generate", "Customer", "Token"]}}, "/v2/brands/{brandID}/relationships/brands"=>{"post"=>{"summary"=>"Create Brand Relationships", "description"=>"Create brand relationships.", "operationId"=>"V2BrandsRelationshipsBrandsByBrandIDPost", "x-api-path-slug"=>"v2brandsbrandidrelationshipsbrands-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"brandID"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Brands", "Relationships"]}}, "/v2/products"=>{"get"=>{"summary"=>"Get Products List", "description"=>"Get products list.", "operationId"=>"V2ProductsGet", "x-api-path-slug"=>"v2products-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"filter"}, {"in"=>"query", "name"=>"include"}, {"in"=>"query", "name"=>"page[limit]"}, {"in"=>"query", "name"=>"page[offset]"}, {"in"=>"query", "name"=>"sort"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Productss", "List"]}, "post"=>{"summary"=>"Create a new Product", "description"=>"Create a new product.", "operationId"=>"V2ProductsPost", "x-api-path-slug"=>"v2products-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["New", "Products"]}}, "/v2/flows/{flowSlug}/entries/{entryID}/relationships/{fieldSlug}"=>{"post"=>{"summary"=>"Create Entry Relationship(s)", "description"=>"Create entry relationship(s).", "operationId"=>"V2FlowsEntriesRelationshipsFieldSlugByFlowSlugAndEntryIDPost", "x-api-path-slug"=>"v2flowsflowslugentriesentryidrelationshipsfieldslug-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"entryID"}, {"in"=>"path", "name"=>"fieldSlug"}, {"in"=>"path", "name"=>"flowSlug"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Entry", "Relationship(s)"]}}, "/v2/categories/tree"=>{"get"=>{"summary"=>"Get Categories Tree", "description"=>"Get categories tree.", "operationId"=>"V2CategoriesTreeGet", "x-api-path-slug"=>"v2categoriestree-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Categories", "Tree"]}}, "/v2/variations/{variationID}/options"=>{"post"=>{"summary"=>"Create a Product Variation Option", "description"=>"Create a product variation option.", "operationId"=>"V2VariationsOptionsByVariationIDPost", "x-api-path-slug"=>"v2variationsvariationidoptions-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"variationID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Products", "Variation", "Option"]}}, "/v2/orders"=>{"get"=>{"summary"=>"Get all orders", "description"=>"Get all orders.", "operationId"=>"V2OrdersGet", "x-api-path-slug"=>"v2orders-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Orders"]}}}}, "apis"=>{"name"=>"moltin", "x-slug"=>"moltin", "description"=>"The comprehensive eCommerce API infrastructure for any platform. Moltin handles data storage and eCommerce logic in the cloud so that you can focus on creating great customer experiences.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/moltin-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Commerce,Commerce,Kiosk,Relative Data,Retail,Service API,Stack Network,Target", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"moltin/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Moltin API", "x-api-slug"=>"moltin-api", "description"=>"The comprehensive eCommerce API infrastructure for any platform. Moltin handles data storage and eCommerce logic in the cloud so that you can focus on creating great customer experiences.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/moltin-logo.png", "humanURL"=>"https://moltin.com", "baseURL"=>"https://api.moltin.com//", "tags"=>"Commerce,Commerce,Kiosk,Relative Data,Retail,Service API,Stack Network,Target", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/moltin/moltin-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.molt.in/"}, {"type"=>"x-blog", "url"=>"https://molt.in/blog"}, {"type"=>"x-developer", "url"=>"https://molt.in/developers"}, {"type"=>"x-documentation", "url"=>"https://docs.moltin.com/"}, {"type"=>"x-email", "url"=>"support@molt.in"}, {"type"=>"x-github", "url"=>"https://github.com/moltin"}, {"type"=>"x-postman", "url"=>"https://www.getpostman.com/collections/e9bdcde0ccb5a08640e6"}, {"type"=>"x-pricing", "url"=>"https://moltin.com/pricing"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/moltin"}, {"type"=>"x-website", "url"=>"https://moltin.com"}, {"type"=>"x-website", "url"=>"https://molt.in/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
awhere{"awhere-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"aWhere", "x-complete"=>1, "info"=>{"title"=>"aWhere API Platform", "description"=>"todo-add-description", "version"=>"1.0.0"}, "host"=>"api.awhere.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v2/agronomics/fields/field1/agronomicvalues/2015-08-01,2015-08-03"=>{"get"=>{"summary"=>"Agronomic Values & Accumulations", "description"=>"####Request\nThis API call gets calculated agronomics and accumulations at a field location. \n\nThe URL used here will get the values for a certain range of days. This is a very flexible API and so you're encouraged to review the [Agronomics Documentation](http://developer.awhere.com/api/reference/agronomics/values).\n\n_Tip: Remember to use a field ID that exists in your account. By default, this collection uses a default field ID of 'field1'_\n\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2AgronomicsFieldsField1Agronomicvalues2015080120150803Get", "x-api-path-slug"=>"v2agronomicsfieldsfield1agronomicvalues2015080120150803-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Agronomic", "Values", "&", "Accumulations"]}}, "/v2/agronomics/fields/field1/agronomicnorms/08-01,08-03/years/2010,2014"=>{"get"=>{"summary"=>"Agronomic Norms", "description"=>"####Request\nThis API call gets the long term averages for agronomic values and accumulations at a field location. \n\nThe URL used here will get the values for a certain range of days over a certain range of years. This is a very flexible API and so you're encouraged to review the [Agronomics Documentation](http://developer.awhere.com/api/reference/agronomics/norms).\n\n_Tip: Remember to use a field ID that exists in your account. By default, this collection uses a default field ID of 'field1'_\n\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2AgronomicsFieldsField1Agronomicnorms08010803Years20102014Get", "x-api-path-slug"=>"v2agronomicsfieldsfield1agronomicnorms08010803years20102014-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Agronomic", "Norms"]}}, "/v2/fields"=>{"get"=>{"summary"=>"Get Fields List", "description"=>"####Request\nThis API call retrieves the list of fields in your account. \n\n[Get Fields Documentation](http://developer.awhere.com/api/reference/fields/get-fields)\n\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2FieldsGet", "x-api-path-slug"=>"v2fields-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Fields", "List"]}, "post"=>{"summary"=>"Create a Field", "description"=>"####Request\nThis API call creates a field location in your account. Be sure to change the body payload. \n\n[Create Fields Documentation](http://developer.awhere.com/api/reference/fields/create-field)\n\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2FieldsPost", "x-api-path-slug"=>"v2fields-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Field"]}}, "/v2/fields/field1"=>{"get"=>{"summary"=>"Get a Single Field by ID", "description"=>"####Request\nThis API call retrieves a single field by ID.\n\n[Get Fields Documentation](http://developer.awhere.com/api/reference/fields/get-fields)\n\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2FieldsField1Get", "x-api-path-slug"=>"v2fieldsfield1-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Single", "Field", "By", "ID"]}, "patch"=>{"summary"=>"Update Field", "description"=>"####Request\nThis API call shows how to update the farm ID on a field location. You can also change the name.\n\n[Update Field Documentation](http://developer.awhere.com/api/reference/fields/update-field)\n\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2FieldsField1Patch", "x-api-path-slug"=>"v2fieldsfield1-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Field"]}}, "/v2/agronomics/fields/field1/plantings"=>{"get"=>{"summary"=>"Get Plantings List for a Field", "description"=>"####Request\nThis API call retrieves the list of plantings for a specific field in your account. \n\n[Get Plantings Documentation](http://developer.awhere.com/api/reference/plantings/get-plantings)\n\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2AgronomicsFieldsField1PlantingsGet", "x-api-path-slug"=>"v2agronomicsfieldsfield1plantings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Plantings", "Lista", "Field"]}, "post"=>{"summary"=>"Create a Planting", "description"=>"####Request\nThis API call creates a planting for a specific field in your account. \n\n__Note:__ You should at least change the dates in the request body.\n\n[Create Planting Documentation](http://developer.awhere.com/api/reference/plantings/create)\n\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2AgronomicsFieldsField1PlantingsPost", "x-api-path-slug"=>"v2agronomicsfieldsfield1plantings-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Planting"]}}, "/v2/agronomics/fields/field1/plantings/current"=>{"patch"=>{"summary"=>"Update Part of a Planting", "description"=>"####Request\nThis API call shows how to update only a couple of fields in a planting instead of having to update the entire object.\n\n__Note:__ You probably what to change the date in the request body.\n\n[Update Planting Documentation](http://developer.awhere.com/api/reference/plantings/update)\n\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2AgronomicsFieldsField1PlantingsCurrentPatch", "x-api-path-slug"=>"v2agronomicsfieldsfield1plantingscurrent-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Part", "Of", "Planting"]}}, "/v2/agronomics/crops"=>{"get"=>{"summary"=>"Get Crops", "description"=>"####Request\nThis API call returns the list of currently available crops in the aWhere platform.\n\n[Crops Documentation](http://developer.awhere.com/api/reference/crops).\n\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2AgronomicsCropsGet", "x-api-path-slug"=>"v2agronomicscrops-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Crops"]}}, "/v2/agronomics/models"=>{"get"=>{"summary"=>"Get Models", "description"=>"####Request\nThis API call returns the list of currently available models in the aWhere platform.\n\n[Crops Documentation](http://developer.awhere.com/api/reference/models/get-models).\n\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2AgronomicsModelsGet", "x-api-path-slug"=>"v2agronomicsmodels-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Models"]}}, "/v2/agronomics/models/BarleyGenericMSU/details"=>{"get"=>{"summary"=>"Get Model Details", "description"=>"####Request\nThis API call returns the details about a particular model. Currently, growth stage models are available via the API, so the details are a list of the possible stages with GDD threshold information. \n\n[Model Details Documentation](http://developer.awhere.com/api/reference/models/details).\n\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2AgronomicsModelsBarleyGenericMSUDetailsGet", "x-api-path-slug"=>"v2agronomicsmodelsbarleygenericmsudetails-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Model", "Details"]}}, "/v2/agronomics/fields/field1/models/BarleyGenericMSU/results"=>{"get"=>{"summary"=>"Get Model Results", "description"=>"####Request\nThis API call returns the current results of a model based on the data provided for the identified field location. \n\n[Model Results Documentation](http://developer.awhere.com/api/reference/models/results).\n\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2AgronomicsFieldsField1ModelsBarleyGenericMSUResultsGet", "x-api-path-slug"=>"v2agronomicsfieldsfield1modelsbarleygenericmsuresults-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Model", "Results"]}}, "/v2/weather/fields/field1/observations"=>{"get"=>{"summary"=>"Daily Observations", "description"=>"####Request\nThis API call gets the weather at a field location.\n\nThe default URL will get the last seven days of actual weather observations. You can add dates to the end of the URL to get the weather for a specific range of days, like so: \n\n`/v2/weather/fields/field1/observations/2015-08-01` gets a single day\n`/v2/weather/fields/field1/observations/2015-08-01,2015-08-15` gets everything from August 1-15\n\nYou can customize the response payload using query string parameters. Learn more in the [Daily Observations Documentation](http://developer.awhere.com/api/reference/weather/observations).\n\n_Tip: Remember to use a field ID that exists in your account. By default, this collection uses a default field ID of 'field1'_\n\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2WeatherFieldsField1ObservationsGet", "x-api-path-slug"=>"v2weatherfieldsfield1observations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Daily", "Observations"]}}, "/v2/weather/fields/field1/forecasts"=>{"get"=>{"summary"=>"Forecasts", "description"=>"####Request\nThis API call gets the forecast at a field location.\n\nWith the default configuration you'll get the hourly forecast for today +8 days. Add dates to the end of the URL to request only specific days, like so: \n\n`/v2/weather/fields/field1/forecasts/YYYY-MM-DD` returns a single day\n`/v2/weather/fields/field1/forecasts/YYYY-MM-DD,YYYY-MM-DD` returns a range of days\n\nYou can also use query string parameters to customize the payloads. Read the [Forecast Documentation](http://developer.awhere.com/api/reference/weather/forecast) for details.\n\n\n_Tip: Remember to use a field ID that exists in your account. By default, this collection uses a default field ID of 'field1'_\n\n\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2WeatherFieldsField1ForecastsGet", "x-api-path-slug"=>"v2weatherfieldsfield1forecasts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Forecasts"]}}, "/v2/weather/fields/field1/norms/08-01,08-15/years/2010,2015"=>{"get"=>{"summary"=>"Norms", "description"=>"####Request\nUse this API to calculate long-term averages for the weather for any set of days across any set of years (minumum 3). This is a very flexible API, and you're encouraged to review the [Weather Norms Documentation](http://developer.awhere.com/api/reference/weather/norms) for details.\n\n_Tip: Remember to use a field ID that exists in your account. By default, this collection uses a default field ID of 'field1'_\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2WeatherFieldsField1Norms08010815Years20102015Get", "x-api-path-slug"=>"v2weatherfieldsfield1norms08010815years20102015-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Norms"]}}, "/v2/weather/fields/field1/currentconditions"=>{"get"=>{"summary"=>"Current Conditions", "description"=>"####Request\nThis API call provides a snapshot of recent weather using the weather station nearest to the field location.\n\n[Current Conditions Documentation](http://developer.awhere.com/api/reference/weather/current)\n\n_Tip: Remember to use a field ID that exists in your account. By default, this collection uses a default field ID of 'field1'_\n\n\n####Security\nThis API call uses the security Access Token that is retrieved with the \"Get a Token\" request. If you run that request first, it will save a token to Postman and this API will use it automatically. You can also see where the token should normally go by clicking the \"Headers\" tab below. The Authorization header holds the token, replacing the \"{{aWhereAccessToken}}\" part.", "operationId"=>"V2WeatherFieldsField1CurrentconditionsGet", "x-api-path-slug"=>"v2weatherfieldsfield1currentconditions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Current", "Conditions"]}}, "/oauth/token"=>{"post"=>{"summary"=>"Get a Token", "description"=>"This is the first API call you will make any time you use the API \n(but you only need to use once per hour). This request will \nrequest a security access token and save it to Postman. Later \nAPI calls will use the token from Postman's saved variables. \n\n[Authentication Documentation](http://developer.awhere.com/api/authentication)\n\nPrior to using this API call you should load the aWhere Environment\nfile into Postman and change the settings to your API Key and Secret.\nYou can also see where the key and secret should go, or enter\nthem manually, by choosing the \"Authorization\" tab below, selecting\n\"Basic Auth,\" and then entering the key and secret as the username\nand password.", "operationId"=>"OauthTokenPost", "x-api-path-slug"=>"oauthtoken-post", "parameters"=>[{"in"=>"formData", "name"=>"grant_type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agriculture", "Token"]}}}}, "apis"=>{"name"=>"aWhere", "x-slug"=>"awhere", "description"=>"aWhere Ag Data Management harnesses agriculture analytics to create unprecedented visibility and insight from farm level to national policy. Learn more at aWhere.com!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/21116-developer-awhere-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"891345", "tags"=>"Agriculture,Enterprise,General Data,Profiles,SaaS,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"awhere/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"aWhere", "x-api-slug"=>"awhere", "description"=>"aWhere Ag Data Management harnesses agriculture analytics to create unprecedented visibility and insight from farm level to national policy. Learn more at aWhere.com!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/21116-developer-awhere-com.jpg", "humanURL"=>"http://developer.awhere.com/", "baseURL"=>"https://api.awhere.com//", "tags"=>"Agriculture,Enterprise,General Data,Profiles,SaaS,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/awhere/awhere-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog-rss", "url"=>"http://blog.awhere.com/rss.xml"}, {"type"=>"x-github", "url"=>"https://github.com/aWhereAPI"}, {"type"=>"x-website", "url"=>"http://www.awhere.com"}, {"type"=>"x-blog", "url"=>"http://blog.awhere.com/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/awhere"}, {"type"=>"x-developers", "url"=>"http://developer.awhere.com/"}, {"type"=>"x-website", "url"=>"http://awhere.com"}, {"type"=>"x-support", "url"=>"http://www.awhere.com/services-and-support"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/aWhere"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| site24x7{"maintenance-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Site24x7", "x-complete"=>1, "info"=>{"title"=>"Maintenance API", "description"=>"the-maintenance-api-", "version"=>"1.0.0"}, "host"=>"www.site24x7.com.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/maintenance/{maintenance_id}"=>{"get"=>{"summary"=>"Retrieve Maintenance", "description"=>"Retrieve configuration of a Scheduled Maintenance.", "operationId"=>"retrieve-maintenance", "x-api-path-slug"=>"maintenancemaintenance-id-get", "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, "Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Maintenance"]}, "delete"=>{"summary"=>"Delete Maintenance", "description"=>"Delete an existing Scheduled Maintenance.", "operationId"=>"delete-maintenance", "x-api-path-slug"=>"maintenancemaintenance-id-delete", "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, "Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Maintenance"]}}}}, "operation-dashboard-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Site24x7", "x-complete"=>1, "info"=>{"title"=>"Operation Dashboard API", "description"=>"the-operation-dashboard-api-", "version"=>"1.0.0"}, "host"=>"www.site24x7.com.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/operations_dashboards"=>{"post"=>{"summary"=>"Create Operations Dashboard", "description"=>"Create a new Operations Dashboard", "operationId"=>"create-operations-dashboard", "x-api-path-slug"=>"operations-dashboards-post", "parameters"=>[{"in"=>"path", "name"=>"display_name\n \n \n required\n Display name for the Operations Dashboard.\n \n \n \n \n layout_type\n \n \n required\n Layout to be used for the Operations Dashboa"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation Dashboards"]}, "get"=>{"summary"=>"List Operations Dashboards", "description"=>"List of all Operations Dashboards.", "operationId"=>"list-operations-dashboards", "x-api-path-slug"=>"operations-dashboards-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation Dashboards"]}}, "/operations_dashboards/{dashboard_id}"=>{"put"=>{"summary"=>"Update Operations Dashboard", "description"=>"Update the configuration of an existing Operations Dashboard.", "operationId"=>"update-operations-dashboard", "x-api-path-slug"=>"operations-dashboardsdashboard-id-put", "parameters"=>[{"in"=>"path", "name"=>"display_name\n \n \n required\n Display name for the Operations Dashboard.\n \n \n \n \n layout_type\n \n \n required\n Layout to be used for the Operations Dashboa"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation Dashboards"]}}}}, "status-dashboard-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Site24x7", "x-complete"=>1, "info"=>{"title"=>"Status Dashboard API", "description"=>"the-status-dashboard-api-", "version"=>"1.0.0"}, "host"=>"www.site24x7.com.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/status_dashboards"=>{"post"=>{"summary"=>"Create Status Dashboard", "description"=>"Create a new Status Dashboard", "operationId"=>"create-status-dashboard", "x-api-path-slug"=>"status-dashboards-post", "parameters"=>[{"in"=>"path", "name"=>"display_name\n \n \n required\n Display name for the Status Dashboard.\n \n \n \n \n description\n \n \n optional\n Description for the Status Dashboard."}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Status Dashboards"]}, "get"=>{"summary"=>"List Status Dashboards", "description"=>"List of all Status Dashboards.", "operationId"=>"list-status-dashboards", "x-api-path-slug"=>"status-dashboards-get", "parameters"=>[{"in"=>"path", "name"=>"monitor_id\n \n \n string\n Unique ID generated by the server. This can be used as an identifier.\n \n \n \n \n time_period\n \n \n int\n Time period fo"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Status Dashboards"]}}, "/status_dashboards/{report_id}"=>{"put"=>{"summary"=>"Update Status Dashboard", "description"=>"Update the configuration of an existing Status Dashboard.", "operationId"=>"update-status-dashboard", "x-api-path-slug"=>"status-dashboardsreport-id-put", "parameters"=>[{"in"=>"path", "name"=>"display_name\n \n \n required\n Display name for the Status Dashboard.\n \n \n \n \n description\n \n \n optional\n Description for the Status Dashboard."}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Status Dashboards"]}}}}, "report-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Site24x7", "x-complete"=>1, "info"=>{"title"=>"Report API", "description"=>"the-report-api-", "version"=>"1.0.0"}, "host"=>"www.site24x7.com.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/customize_report"=>{"get"=>{"summary"=>"Get Custom Report Settings", "description"=>"Retrieve Custom Report Settings.", "operationId"=>"get-custom-report-settings", "x-api-path-slug"=>"customize-report-get", "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/busy_hours/{monitor_id}?period={report_period_constants}&segment_type={segment_types}"=>{"get"=>{"summary"=>"Busy Hours Report", "description"=>"Request Example", "operationId"=>"busy-hours-report", "x-api-path-slug"=>"reportsbusy-hoursmonitor-idperiodreport-period-constantssegment-typesegment-types-get", "parameters"=>[{"in"=>"path", "name"=>"monitor_id", "description"=>"MandatoryUnique ID of the monitor", "type"=>" | string | "}], "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/outage?period={report_period_constants}"=>{"get"=>{"summary"=>"Get Outage Details", "description"=>"Obtain the actual down period and the total down duration of your monitors for a specified duration of time.", "operationId"=>"get-outage-details", "x-api-path-slug"=>"reportsoutageperiodreport-period-constants-get", "parameters"=>[{"in"=>"path", "name"=>"period", "description"=>"Mandatory Outage details report is generated within this predefined interval", "type"=>"int | "}], "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/outage/group/{monitor_group_id}?period={report_period_constants}"=>{"get"=>{"summary"=>"Get Outage Details of Monitor Groups", "description"=>"Obtain the actual down period and the total down duration of your chosen monitor group during a selected duration of time.", "operationId"=>"get-outage-details-of-monitor-groups", "x-api-path-slug"=>"reportsoutagegroupmonitor-group-idperiodreport-period-constants-get", "parameters"=>[{"in"=>"path", "name"=>"monitor_group_id", "description"=>"MandatoryMonitor group ID", "type"=>"string | "}], "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/outage/{monitor_id}/{outage_id}"=>{"delete"=>{"summary"=>"Delete Outage", "description"=>"Delete the faulty downtime alerts to reflect the actual available state of the monitor.", "operationId"=>"delete-outage", "x-api-path-slug"=>"reportsoutagemonitor-idoutage-id-delete", "parameters"=>[{"in"=>"path", "name"=>"monitor_id", "description"=>"MandatoryMonitor group ID", "type"=>"string | "}], "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/alarm/{monitor_id}?period={report_period_constants}"=>{"get"=>{"summary"=>"Get Alarms of Monitor", "description"=>"Obtain the actual down, trouble and maintenance status of your configured monitors. Alert types", "operationId"=>"get-alarms-of-monitor", "x-api-path-slug"=>"reportsalarmmonitor-idperiodreport-period-constants-get", "parameters"=>[{"in"=>"path", "name"=>"monitor_id", "description"=>"MandatoryMonitor ID", "type"=>"string | "}], "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/comments/{monitor_id}?period={report_period_constants}"=>{"get"=>{"summary"=>"Get comments for a monitor", "description"=>"Get all the comments for a monitor for the given duration.", "operationId"=>"get-comments-for-a-monitor", "x-api-path-slug"=>"reportscommentsmonitor-idperiodreport-period-constants-get", "parameters"=>[{"in"=>"path", "name"=>"monitor_id", "description"=>"MandatoryMonitor ID", "type"=>"string | "}], "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/comments/{monitor_id}/{outage_id}"=>{"put"=>{"summary"=>"Update outage comments.", "description"=>"Update the comment for a given monitor.", "operationId"=>"update-outage-comments", "x-api-path-slug"=>"reportscommentsmonitor-idoutage-id-put", "parameters"=>[{"in"=>"path", "name"=>"monitor_id", "description"=>"MandatoryMonitor ID", "type"=>"string | "}], "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/comments/{monitor_id}/{outage_id}?comment_time={comment_id}"=>{"delete"=>{"summary"=>"Delete comment", "description"=>"Delete an outage comment.", "operationId"=>"delete-comment", "x-api-path-slug"=>"reportscommentsmonitor-idoutage-idcomment-timecomment-id-delete", "parameters"=>[{"in"=>"path", "name"=>"monitor_id", "description"=>"MandatoryMonitor ID", "type"=>"string | "}], "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/availability_summary/group/{group_id}?period="=>{"get"=>{"summary"=>"Availability Summary by monitor group", "description"=>"Request Example", "operationId"=>"availability-summary-by-monitor-group", "x-api-path-slug"=>"reportsavailability-summarygroupgroup-idperiod-get", "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/availability_summary?period="=>{"get"=>{"summary"=>"Availability Summary for all monitors", "description"=>"Request Example", "operationId"=>"availability-summary-for-all-monitors", "x-api-path-slug"=>"reportsavailability-summaryperiod-get", "parameters"=>[{"in"=>"path", "name"=>"period", "description"=>"Availability and performance details are generated within this predefined interval", "type"=>"int | "}], "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/summary/group/{group_id}?period="=>{"get"=>{"summary"=>"Summary by monitor group", "description"=>"Request Example", "operationId"=>"summary-by-monitor-group", "x-api-path-slug"=>"reportssummarygroupgroup-idperiod-get", "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/summary?period="=>{"get"=>{"summary"=>"Summary for all monitors", "description"=>"Request Example", "operationId"=>"summary-for-all-monitors", "x-api-path-slug"=>"reportssummaryperiod-get", "parameters"=>[{"in"=>"path", "name"=>"availability_percentage", "description"=>"Gives the total availability percentage of the monitor for the month", "type"=>"float | "}], "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/trend/group/{group_id}"=>{"get"=>{"summary"=>"Health Trend Report by Monitor group", "description"=>"Request Example", "operationId"=>"health-trend-report-by-monitor-group", "x-api-path-slug"=>"reportstrendgroupgroup-id-get", "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/trend"=>{"get"=>{"summary"=>"Health trend Report for all monitors", "description"=>"Request Example", "operationId"=>"health-trend-report-for-all-monitors", "x-api-path-slug"=>"reportstrend-get", "parameters"=>[{"in"=>"path", "name"=>"period", "description"=>"Top N report is generated within this predefined interval", "type"=>"int | "}], "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/top_n/{monitor_type}/{attribute_name}?limit={N}&period={report_period_constants}"=>{"get"=>{"summary"=>"Top N Report by monitor and attribute type", "description"=>"Request Example", "operationId"=>"top-n-report-by-monitor-and-attribute-type", "x-api-path-slug"=>"reportstop-nmonitor-typeattribute-namelimitnperiodreport-period-constants-get", "parameters"=>[{"in"=>"path", "name"=>"period", "description"=>"Performance details report is generated within this predefined interval", "type"=>"int | "}], "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/performance/group/{group_id}?period=3"=>{"get"=>{"summary"=>"Performance Report by Monitor group", "description"=>"Request Example", "operationId"=>"performance-report-by-monitor-group", "x-api-path-slug"=>"reportsperformancegroupgroup-idperiod3-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"It contains the name of all the monitors in the group", "type"=>"string array | "}], "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/performance?period=3"=>{"get"=>{"summary"=>"Performance Report of all monitors", "description"=>"Request Example", "operationId"=>"performance-report-of-all-monitors", "x-api-path-slug"=>"reportsperformanceperiod3-get", "parameters"=>[{"in"=>"path", "name"=>"period", "description"=>"SLA report is generated within this predefined interval", "type"=>"int | "}], "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}, "/reports/sla_reports/response?period=3"=>{"get"=>{"summary"=>"Response SLA", "description"=>"Request Example", "operationId"=>"response-sla", "x-api-path-slug"=>"reportssla-reportsresponseperiod3-get", "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Reports"]}}}}, "notification-profile-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Site24x7", "x-complete"=>1, "info"=>{"title"=>"Notification Profile API", "description"=>"the-notification-profile-api-", "version"=>"1.0.0"}, "host"=>"www.site24x7.com.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/notification_profiles"=>{"post"=>{"summary"=>"Create Notification Profile", "description"=>"Create a new notification profile.", "operationId"=>"create-notification-profile", "x-api-path-slug"=>"notification-profiles-post", "parameters"=>[{"in"=>"path", "name"=>"profile_name\n \n \n required\n Display name for the location profile.\n \n \n \n \n downtime_notification_delay\n \n \n optional\n Configuration for delayed notifi"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, "Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}, 200=>{"description"=>"OK"}}, "tags"=>["Notification Profiles"]}, "get"=>{"summary"=>"List Notification Profiles", "description"=>"List of all notification profiles.", "operationId"=>"list-notification-profiles", "x-api-path-slug"=>"notification-profiles-get", "parameters"=>[{"in"=>"path", "name"=>"template_id\n \n \n string\n Unique ID generated by the server. This can be used as an identifier.\n \n \n \n \n display_name\n \n \n string\n Display n"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Profiles"]}}, "/notification_profiles/{profile_id}"=>{"put"=>{"summary"=>"Update Notification Profile", "description"=>"Update an existing notification profile", "operationId"=>"update-notification-profile", "x-api-path-slug"=>"notification-profilesprofile-id-put", "parameters"=>[{"in"=>"path", "name"=>"profile_name\n \n \n required\n Display name for the location profile.\n \n \n \n \n downtime_notification_delay\n \n \n optional\n Configuration for delayed notifi"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Profiles"]}}}}, "current-status-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Site24x7", "x-complete"=>1, "info"=>{"title"=>"Current Status API", "description"=>"the-current-status-api-", "version"=>"1.0.0"}, "host"=>"www.site24x7.com.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/current_status/{monitor_id}"=>{"get"=>{"summary"=>"Current Status of Monitor", "description"=>"Request Example", "operationId"=>"current-status-of-monitor", "x-api-path-slug"=>"current-statusmonitor-id-get", "parameters"=>[{"in"=>"path", "name"=>"monitor_id", "description"=>"MandatoryUnique ID of the monitor", "type"=>"string | "}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, "Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Current Status"]}}, "/current_status/type/{monitor_type}"=>{"get"=>{"summary"=>"Current Status by Monitor Type", "description"=>"Request Example", "operationId"=>"current-status-by-monitor-type", "x-api-path-slug"=>"current-statustypemonitor-type-get", "parameters"=>[{"in"=>"path", "name"=>"monitor_type", "description"=>"MandatoryType of the monitor", "type"=>"string | "}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, "Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Current Status"]}}}}, "business-hours-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Site24x7", "x-complete"=>1, "info"=>{"title"=>"Business Hours API", "description"=>"the-business-hours-api-", "version"=>"1.0.0"}, "host"=>"www.site24x7.com.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/business_hours"=>{"post"=>{"summary"=>"Create Business Hour", "description"=>"Create a new Business Hour.", "operationId"=>"create-business-hour", "x-api-path-slug"=>"business-hours-post", "parameters"=>[{"in"=>"path", "name"=>"display_name\n \n \n required\n Display name for the Business Hour.\n \n \n \n \n description\n \n \n optional\n Description for the Business Hour"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, "Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Business Hours"]}, "get"=>{"summary"=>"List Business Hours", "description"=>"List of all Business Hours.", "operationId"=>"list-business-hours", "x-api-path-slug"=>"business-hours-get", "parameters"=>[{"in"=>"path", "name"=>"background_color\n \n \n string\n Back ground color for your reports.\n \n \n \n \n foreground_color\n \n \n string\n Foreground ground color for your r"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, "Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Business Hours"]}}, "/business_hours/{business_hours_id}"=>{"put"=>{"summary"=>"Update Business Hour", "description"=>"Update an existing Business Hour.", "operationId"=>"update-business-hour", "x-api-path-slug"=>"business-hoursbusiness-hours-id-put", "parameters"=>[{"in"=>"path", "name"=>"display_name\n \n \n required\n Display name for the Business Hour.\n \n \n \n \n description\n \n \n optional\n Description for the Business Hour"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, "Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Business Hours"]}}}}, "monitor-group-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Site24x7", "x-complete"=>1, "info"=>{"title"=>"Monitor Group API", "description"=>"the-monitor-group-api-", "version"=>"1.0.0"}, "host"=>"www.site24x7.com.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/monitor_groups"=>{"post"=>{"summary"=>"Create a Monitor Group", "description"=>"Create a new Monitor Group.", "operationId"=>"create-a-monitor-group", "x-api-path-slug"=>"monitor-groups-post", "parameters"=>[{"in"=>"path", "name"=>"display_name\n \n \n required\n Display Name for the Monitor Group.\n \n \n \n \n description\n \n \n optional\n Description for the Monitor Group."}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, "Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Monitor Groups"]}, "get"=>{"summary"=>"List of all Monitor Groups", "description"=>"List of all Monitor Groups.", "operationId"=>"list-of-all-monitor-groups", "x-api-path-slug"=>"monitor-groups-get", "parameters"=>[{"in"=>"path", "name"=>"user_id\n \n \n string\n Unique ID generated by the server. This can be used as an identifier.\n \n \n \n \n display_name\n \n \n string\n Name of the U"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, "Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Monitor Groups"]}}, "/monitor_groups/{monitor_group_id}"=>{"put"=>{"summary"=>"Update a Monitor Group", "description"=>"Update an existing Monitor Group.", "operationId"=>"update-a-monitor-group", "x-api-path-slug"=>"monitor-groupsmonitor-group-id-put", "parameters"=>[{"in"=>"path", "name"=>"display_name\n \n \n required\n Display Name for the Monitor Group.\n \n \n \n \n description\n \n \n optional\n Description for the Monitor Group."}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, "Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Monitor Groups"]}}}}, "email-template-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Site24x7", "x-complete"=>1, "info"=>{"title"=>"Email Template API", "description"=>"the-email-template-api-", "version"=>"1.0.0"}, "host"=>"www.site24x7.com.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/email_templates/{template_id}"=>{"get"=>{"summary"=>"Retrieve Email Template", "description"=>"Retrieve configuration of a Email Template.", "operationId"=>"retrieve-email-template", "x-api-path-slug"=>"email-templatestemplate-id-get", "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, "Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Email Templates"]}, "delete"=>{"summary"=>"Delete Email Template", "description"=>"Delete an existing Email Template.", "operationId"=>"delete-email-template", "x-api-path-slug"=>"email-templatestemplate-id-delete", "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, "Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Email Templates"]}}}}, "threshold-profile-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Site24x7", "x-complete"=>1, "info"=>{"title"=>"Threshold Profile API", "description"=>"the-threshold-profile-api-", "version"=>"1.0.0"}, "host"=>"www.site24x7.com.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/threshold_profiles/{profile_id}"=>{"get"=>{"summary"=>"Retrieve Threshold Profile", "description"=>"Retrieve the configuration of a Threshold profile.", "operationId"=>"retrieve-threshold-profile", "x-api-path-slug"=>"threshold-profilesprofile-id-get", "responses"=>{"400: for badly-formed requests, e.g. missing or invalid parameters"=>{"description"=>""}, "403: for authentication issues"=>{"description"=>""}, "409: for issues where the request is well-formed but cannot be completed"=>{"description"=>""}}, "tags"=>["Threshold Profiles"]}, "delete"=>{"summary"=>"Delete Threshold Profile", "description"=>"Delete an existing Threshold profile.", "operationId"=>"delete-threshold-profile", "x-api-path-slug"=>"threshold-profilesprofile-id-delete", "responses"=>{"400: for badly-formed requests, e.g. missing or invalid parameters"=>{"description"=>""}, "403: for authentication issues"=>{"description"=>""}, "409: for issues where the request is well-formed but cannot be completed"=>{"description"=>""}}, "tags"=>["Threshold Profiles"]}}}}, "sla-setting-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Site24x7", "x-complete"=>1, "info"=>{"title"=>"SLA Setting API", "description"=>"the-sla-setting-api-", "version"=>"1.0.0"}, "host"=>"www.site24x7.com.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/sla_settings/{sla_id}"=>{"get"=>{"summary"=>"Get SLA Report", "description"=>"Retrieve the configuration of a SLA Report.", "operationId"=>"get-sla-report", "x-api-path-slug"=>"sla-settingssla-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SLA Settings"]}, "delete"=>{"summary"=>"Delete SLA Report", "description"=>"Delete the existing SLA Report.", "operationId"=>"delete-sla-report", "x-api-path-slug"=>"sla-settingssla-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SLA Settings"]}}}}, "update-button-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Site24x7", "x-complete"=>1, "info"=>{"title"=>"Update Button API", "description"=>"the-update-button-api-", "version"=>"1.0.0"}, "host"=>"www.site24x7.com.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/uptime_buttons/{monitor_id}"=>{"get"=>{"summary"=>"Get Uptime Button", "description"=>"Retrieve the configuration of the Uptime Button.", "operationId"=>"get-uptime-button", "x-api-path-slug"=>"uptime-buttonsmonitor-id-get", "responses"=>{"400: for badly-formed requests, e.g. missing or invalid parameters"=>{"description"=>""}, "403: for authentication issues"=>{"description"=>""}, "409: for issues where the request is well-formed but cannot be completed"=>{"description"=>""}}, "tags"=>["Uptime Buttons"]}, "delete"=>{"summary"=>"Delete Uptime Button", "description"=>"Delete the uptime button for a monitor.", "operationId"=>"delete-uptime-button", "x-api-path-slug"=>"uptime-buttonsmonitor-id-delete", "responses"=>{"400: for badly-formed requests, e.g. missing or invalid parameters"=>{"description"=>""}, "403: for authentication issues"=>{"description"=>""}, "409: for issues where the request is well-formed but cannot be completed"=>{"description"=>""}}, "tags"=>["Uptime Buttons"]}}}}, "scheduled-report-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Site24x7", "x-complete"=>1, "info"=>{"title"=>"Scheduled Report API", "description"=>"the-scheduled-report-api-", "version"=>"1.0.0"}, "host"=>"www.site24x7.com.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/scheduled_reports"=>{"post"=>{"summary"=>"Schedule a Report", "description"=>"Schedule a report to be received on a specific day and time.", "operationId"=>"schedule-a-report", "x-api-path-slug"=>"scheduled-reports-post", "parameters"=>[{"in"=>"path", "name"=>"display_name\n \n \n required\n Display name for the Report.\n \n \n \n \n report_type\n \n \n required\n Type of report to be Scheduled.Report Constants"}], "responses"=>{"Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}, 200=>{"description"=>"OK"}}, "tags"=>["Scheduled Reports"]}, "get"=>{"summary"=>"List Scheduled Reports", "description"=>"List of all Scheduled Reports.", "operationId"=>"list-scheduled-reports", "x-api-path-slug"=>"scheduled-reports-get", "parameters"=>[{"in"=>"path", "name"=>"sla_id\n \n \n string\n Unique ID generated by the server. This can be used as an identifier.\n \n \n \n \n display_name\n \n \n string\n Display name f"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scheduled Reports"]}}, "/scheduled_reports/{report_id}"=>{"put"=>{"summary"=>"Update Scheduled Report", "description"=>"Update the configuration of an existing Scheduled Report.", "operationId"=>"update-scheduled-report", "x-api-path-slug"=>"scheduled-reportsreport-id-put", "parameters"=>[{"in"=>"path", "name"=>"display_name\n \n \n required\n Display name for the Report.\n \n \n \n \n report_type\n \n \n required\n Type of report to be Scheduled.Report Constants"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scheduled Reports"]}}}}, "user-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Site24x7", "x-complete"=>1, "info"=>{"title"=>"User API", "description"=>"the-user-api-", "version"=>"1.0.0"}, "host"=>"www.site24x7.com.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/users/{user_id}"=>{"get"=>{"summary"=>"Retrieve an user info", "description"=>"Retrieve information for an existing user.", "operationId"=>"retrieve-an-user-info", "x-api-path-slug"=>"usersuser-id-get", "responses"=>{"400: for badly-formed requests, e.g. missing or invalid parameters"=>{"description"=>""}, "403: for authentication issues"=>{"description"=>""}, "409: for issues where the request is well-formed but cannot be completed"=>{"description"=>""}, 200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "delete"=>{"summary"=>"Delete an user", "description"=>"Delete an existing User.", "operationId"=>"delete-an-user", "x-api-path-slug"=>"usersuser-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}}}, "location-profile-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Site24x7", "x-complete"=>1, "info"=>{"title"=>"Location Profile API", "description"=>"the-location-profile-api-", "version"=>"1.0.0"}, "host"=>"www.site24x7.com.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/location_profiles/{profile_id}"=>{"get"=>{"summary"=>"Retrieve Location Profile", "description"=>"Retrieve configuration of a location profile.", "operationId"=>"retrieve-location-profile", "x-api-path-slug"=>"location-profilesprofile-id-get", "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, "Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Location Profiles"]}, "delete"=>{"summary"=>"Delete Location Profile", "description"=>"Delete an existing location profile.", "operationId"=>"delete-location-profile", "x-api-path-slug"=>"location-profilesprofile-id-delete", "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, "Maximum record size"=>{"description"=>"100 KiB"}, "Maximum number of records per datastore"=>{"description"=>"100,000"}, "Maximum datastore size"=>{"description"=>"10 MiB"}, "Maximum size of a delta"=>{"description"=>"2 MiB"}}, "tags"=>["Location Profiles"]}}}}, "apis"=>{"name"=>"Site24x7", "x-slug"=>"site24x7", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"42122", "tags"=>"Monitoring,Networks,Relative Data,SaaS,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"site24x7/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Business Hours API", "x-api-slug"=>"business-hours-api", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "humanURL"=>"https://www.site24x7.com/", "baseURL"=>"://www.site24x7.com./", "tags"=>"Monitoring,Networks,Relative Data,SaaS,Service API,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/site24x7/business-hours-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/site24x7/business-hours-api-openapi.yaml"}]}, {"name"=>"Current Status API", "x-api-slug"=>"current-status-api", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "humanURL"=>"https://www.site24x7.com/", "baseURL"=>"://www.site24x7.com./", "tags"=>"Business Hours", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/site24x7/current-statustypemonitor-type-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/site24x7/current-status-api-openapi.yaml"}]}, {"name"=>"Email Template API", "x-api-slug"=>"email-template-api", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "humanURL"=>"https://www.site24x7.com/", "baseURL"=>"://www.site24x7.com./", "tags"=>"Current Status", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/site24x7/email-templatestemplate-id-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/site24x7/email-template-api-openapi.yaml"}]}, {"name"=>"Location Profile API", "x-api-slug"=>"location-profile-api", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "humanURL"=>"https://www.site24x7.com/", "baseURL"=>"://www.site24x7.com./", "tags"=>"Email Templates", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/site24x7/location-profilesprofile-id-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/site24x7/location-profile-api-openapi.yaml"}]}, {"name"=>"Maintenance API", "x-api-slug"=>"maintenance-api", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "humanURL"=>"https://www.site24x7.com/", "baseURL"=>"://www.site24x7.com./", "tags"=>"Location Profiles", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/site24x7/maintenancemaintenance-id-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/site24x7/maintenance-api-openapi.yaml"}]}, {"name"=>"Monitor Group API", "x-api-slug"=>"monitor-group-api", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "humanURL"=>"https://www.site24x7.com/", "baseURL"=>"://www.site24x7.com./", "tags"=>"Maintenance", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/site24x7/monitor-groups-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/site24x7/monitor-group-api-openapi.yaml"}]}, {"name"=>"Notification Profile API", "x-api-slug"=>"notification-profile-api", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "humanURL"=>"https://www.site24x7.com/", "baseURL"=>"://www.site24x7.com./", "tags"=>"Monitor Groups", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/site24x7/notification-profiles-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/site24x7/notification-profile-api-openapi.yaml"}]}, {"name"=>"Operation Dashboard API", "x-api-slug"=>"operation-dashboard-api", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "humanURL"=>"https://www.site24x7.com/", "baseURL"=>"://www.site24x7.com./", "tags"=>"Notification Profiles", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/site24x7/operations-dashboards-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/site24x7/operation-dashboard-api-openapi.yaml"}]}, {"name"=>"Report API", "x-api-slug"=>"report-api", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "humanURL"=>"https://www.site24x7.com/", "baseURL"=>"://www.site24x7.com./", "tags"=>"Operation Dashboards", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/site24x7/reportssla-reportsresponseperiod3-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/site24x7/report-api-openapi.yaml"}]}, {"name"=>"Scheduled Report API", "x-api-slug"=>"scheduled-report-api", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "humanURL"=>"https://www.site24x7.com/", "baseURL"=>"://www.site24x7.com./", "tags"=>"Reports", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/site24x7/scheduled-reports-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/site24x7/scheduled-report-api-openapi.yaml"}]}, {"name"=>"SLA Setting API", "x-api-slug"=>"sla-setting-api", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "humanURL"=>"https://www.site24x7.com/", "baseURL"=>"://www.site24x7.com./", "tags"=>"Scheduled Reports", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/site24x7/sla-settingssla-id-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/site24x7/sla-setting-api-openapi.yaml"}]}, {"name"=>"Status Dashboard API", "x-api-slug"=>"status-dashboard-api", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "humanURL"=>"https://www.site24x7.com/", "baseURL"=>"://www.site24x7.com./", "tags"=>"SLA Settings", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/site24x7/status-dashboards-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/site24x7/status-dashboard-api-openapi.yaml"}]}, {"name"=>"Threshold Profile API", "x-api-slug"=>"threshold-profile-api", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "humanURL"=>"https://www.site24x7.com/", "baseURL"=>"://www.site24x7.com./", "tags"=>"Status Dashboards", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/site24x7/threshold-profilesprofile-id-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/site24x7/threshold-profile-api-openapi.yaml"}]}, {"name"=>"Update Button API", "x-api-slug"=>"update-button-api", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "humanURL"=>"https://www.site24x7.com/", "baseURL"=>"://www.site24x7.com./", "tags"=>"Threshold Profiles", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/site24x7/uptime-buttonsmonitor-id-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/site24x7/update-button-api-openapi.yaml"}]}, {"name"=>"User API", "x-api-slug"=>"user-api", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "humanURL"=>"https://www.site24x7.com/", "baseURL"=>"://www.site24x7.com./", "tags"=>"Uptime Buttons", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/site24x7/usersuser-id-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/site24x7/user-api-openapi.yaml"}]}, {"name"=>"User Group API", "x-api-slug"=>"user-group-api", "description"=>"Site24x7 offers both free & paid website monitoring services. Monitor websites remotely and receive instant email/sms alerts if your website becomes unavailable. View uptime & performance graphs of your website monitors.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/481-site24x7.jpg", "humanURL"=>"https://www.site24x7.com/", "baseURL"=>"://www.site24x7.com./", "tags"=>"Users", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/site24x7/user-groups-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/site24x7/user-group-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://www.site24x7.com/"}, {"type"=>"x-blog", "url"=>"http://blogs.site24x7.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blogs.site24x7.com/feed"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/site24x7"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/site24x7"}, {"type"=>"x-developer", "url"=>"https://www.site24x7.com/help/api/"}, {"type"=>"x-email", "url"=>"support@site24x7.com"}, {"type"=>"x-email", "url"=>"sales@site24x7.com"}, {"type"=>"x-github", "url"=>"https://github.com/site24x7"}, {"type"=>"x-partner-program", "url"=>"https://www.site24x7.com/partners.html"}, {"type"=>"x-pricing", "url"=>"https://www.site24x7.com/site24x7-pricing.html"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/site24x7"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "user-group-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Site24x7", "x-complete"=>1, "info"=>{"title"=>"User Group API", "description"=>"the-user-group-api-", "version"=>"1.0.0"}, "host"=>"www.site24x7.com.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/user_groups"=>{"post"=>{"summary"=>"Create a new user group", "description"=>"Create a new user group.", "operationId"=>"create-a-new-user-group", "x-api-path-slug"=>"user-groups-post", "parameters"=>[{"in"=>"path", "name"=>"display_name\n \n \n required\n Display name for the user group.\n \n \n \n \n users\n \n \n required\n Users to be associated for the group."}], "responses"=>{"400: for badly-formed requests, e.g. missing or invalid parameters"=>{"description"=>""}, "403: for authentication issues"=>{"description"=>""}, "409: for issues where the request is well-formed but cannot be completed"=>{"description"=>""}}, "tags"=>["Groups"]}, "get"=>{"summary"=>"List of all User Groups", "description"=>"List of all User Groups.", "operationId"=>"list-of-all-user-groups", "x-api-path-slug"=>"user-groups-get", "parameters"=>[{"in"=>"path", "name"=>"profile_id\n \n \n string\n Unique ID generated by the server. This can be used as an identifier.\n \n \n \n \n profile_name\n \n \n string\n Display na"}], "responses"=>{"400: for badly-formed requests, e.g. missing or invalid parameters"=>{"description"=>""}, "403: for authentication issues"=>{"description"=>""}, "409: for issues where the request is well-formed but cannot be completed"=>{"description"=>""}}, "tags"=>["Groups"]}}, "/user_groups/{user_group_id}"=>{"put"=>{"summary"=>"Update an user group details", "description"=>"Update an existing User Group Information.", "operationId"=>"update-an-user-group-details", "x-api-path-slug"=>"user-groupsuser-group-id-put", "parameters"=>[{"in"=>"path", "name"=>"display_name\n \n \n required\n Display name for the user group.\n \n \n \n \n users\n \n \n required\n Users to be associated for the group."}], "responses"=>{"400: for badly-formed requests, e.g. missing or invalid parameters"=>{"description"=>""}, "403: for authentication issues"=>{"description"=>""}, "409: for issues where the request is well-formed but cannot be completed"=>{"description"=>""}}, "tags"=>["Groups"]}}}}}|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
europeana{"europeana-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Europeana", "x-complete"=>1, "info"=>{"title"=>"Europeana", "description"=>"this-swagger-api-console-provides-an-overview-of-an-interface-to-the-europeana-rest-api--you-can-build-and-test-anything-from-the-simplest-search-to-a-complex-query-using-facetlist-such-as-dates-geotags-and-permissions--for-more-help-and-information-head-to-our-comprehensive-a-hrefhttplabs-europeana-euapionline-documentationa-", "termsOfService"=>"http://www.europeana.eu/portal/en/rights.html", "contact"=>{"name"=>"http://labs.europeana.eu/api"}, "version"=>"1.0.0"}, "host"=>"www.europeana.eu", "basePath"=>"v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/dataset/{id}.json"=>{"get"=>{"summary"=>"get information about a specific dataset", "description"=>"Get information about a specific dataset.", "operationId"=>"getDataset", "x-api-path-slug"=>"datasetid-json-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"callback"}, {"in"=>"path", "name"=>"id", "description"=>"id"}, {"in"=>"query", "name"=>"wskey", "description"=>"wskey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset", "Id"]}}, "/datasets.json"=>{"get"=>{"summary"=>"get the list of Europeana datasets", "description"=>"Get the list of europeana datasets.", "operationId"=>"listDatasets", "x-api-path-slug"=>"datasets-json-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"callback"}, {"in"=>"query", "name"=>"countryCode", "description"=>"countryCode"}, {"in"=>"query", "name"=>"edmDatasetName", "description"=>"edmDatasetName"}, {"in"=>"query", "name"=>"offset", "description"=>"offset"}, {"in"=>"query", "name"=>"pagesize", "description"=>"pagesize"}, {"in"=>"query", "name"=>"status", "description"=>"status"}, {"in"=>"query", "name"=>"wskey", "description"=>"wskey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets"]}}, "/opensearch.rss"=>{"get"=>{"summary"=>"basic search function following the OpenSearch specification", "description"=>"Basic search function following the opensearch specification.", "operationId"=>"openSearch", "x-api-path-slug"=>"opensearch-rss-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"count"}, {"in"=>"query", "name"=>"searchTerms", "description"=>"searchTerms"}, {"in"=>"query", "name"=>"startIndex", "description"=>"startIndex"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}, "/provider/{id}.json"=>{"get"=>{"summary"=>"get information about a specific Europeana provider", "description"=>"Get information about a specific europeana provider.", "operationId"=>"getProvider", "x-api-path-slug"=>"providerid-json-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"callback"}, {"in"=>"path", "name"=>"id", "description"=>"id"}, {"in"=>"query", "name"=>"wskey", "description"=>"wskey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provider"]}}, "/provider/{id}/datasets.json"=>{"get"=>{"summary"=>"get the list of datasets provided by a specific provider", "description"=>"Get the list of datasets provided by a specific provider.", "operationId"=>"listProviderDatasets", "x-api-path-slug"=>"provideriddatasets-json-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"callback"}, {"in"=>"path", "name"=>"id", "description"=>"id"}, {"in"=>"query", "name"=>"wskey", "description"=>"wskey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Providers", "Datasets"]}}, "/providers.json"=>{"get"=>{"summary"=>"get the list of Europeana data providers", "description"=>"Get the list of europeana data providers.", "operationId"=>"listProviders", "x-api-path-slug"=>"providers-json-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"callback"}, {"in"=>"query", "name"=>"countryCode", "description"=>"countryCode"}, {"in"=>"query", "name"=>"offset", "description"=>"offset"}, {"in"=>"query", "name"=>"pagesize", "description"=>"pagesize"}, {"in"=>"query", "name"=>"wskey", "description"=>"wskey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Providers"]}}, "/record/{collectionId}/{recordId}.json"=>{"get"=>{"summary"=>"get a single record in JSON format", "description"=>"Get a single record in json format.", "operationId"=>"getSingleRecordJson", "x-api-path-slug"=>"recordcollectionidrecordid-json-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"callback"}, {"in"=>"path", "name"=>"collectionId", "description"=>"collectionId"}, {"in"=>"query", "name"=>"hierarchytimeout", "description"=>"hierarchytimeout"}, {"in"=>"query", "name"=>"profile", "description"=>"profile"}, {"in"=>"path", "name"=>"recordId", "description"=>"recordId"}, {"in"=>"query", "name"=>"wskey", "description"=>"wskey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collections"]}}, "/record/{collectionId}/{recordId}.jsonld"=>{"get"=>{"summary"=>"get single record in JSON LD format", "description"=>"Get single record in json ld format.", "operationId"=>"getSingleRecordJsonLD", "x-api-path-slug"=>"recordcollectionidrecordid-jsonld-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"callback"}, {"in"=>"path", "name"=>"collectionId", "description"=>"collectionId"}, {"in"=>"query", "name"=>"format", "description"=>"format"}, {"in"=>"path", "name"=>"recordId", "description"=>"recordId"}, {"in"=>"query", "name"=>"wskey", "description"=>"wskey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collections"]}}, "/record/{collectionId}/{recordId}.rdf"=>{"get"=>{"summary"=>"get single record in RDF format)", "description"=>"Get single record in rdf format).", "operationId"=>"getSingleRecordRDF", "x-api-path-slug"=>"recordcollectionidrecordid-rdf-get", "parameters"=>[{"in"=>"path", "name"=>"collectionId", "description"=>"collectionId"}, {"in"=>"path", "name"=>"recordId", "description"=>"recordId"}, {"in"=>"query", "name"=>"wskey", "description"=>"wskey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collections"]}}, "/search.json"=>{"get"=>{"summary"=>"search for records", "description"=>"Search for records.", "operationId"=>"searchRecords", "x-api-path-slug"=>"search-json-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"callback"}, {"in"=>"query", "name"=>"colourpalette", "description"=>"colourpalette"}, {"in"=>"query", "name"=>"cursor", "description"=>"cursor"}, {"in"=>"query", "name"=>"facet", "description"=>"facet"}, {"in"=>"query", "name"=>"landingpage", "description"=>"landingpage"}, {"in"=>"query", "name"=>"media", "description"=>"media"}, {"in"=>"query", "name"=>"profile", "description"=>"profile"}, {"in"=>"query", "name"=>"qf", "description"=>"qf"}, {"in"=>"query", "name"=>"query", "description"=>"query"}, {"in"=>"query", "name"=>"reusability", "description"=>"reusability"}, {"in"=>"query", "name"=>"rows", "description"=>"rows"}, {"in"=>"query", "name"=>"sort", "description"=>"sort"}, {"in"=>"query", "name"=>"start", "description"=>"start"}, {"in"=>"query", "name"=>"text_fulltext", "description"=>"text_fulltext"}, {"in"=>"query", "name"=>"thumbnail", "description"=>"thumbnail"}, {"in"=>"query", "name"=>"wskey", "description"=>"wskey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}, "/search.rss"=>{"get"=>{"summary"=>"Google Fieldtrip formatted RSS of selected collections", "description"=>"Google fieldtrip formatted rss of selected collections.", "operationId"=>"fieldTrip", "x-api-path-slug"=>"search-rss-get", "parameters"=>[{"in"=>"query", "name"=>"language", "description"=>"language"}, {"in"=>"query", "name"=>"limit", "description"=>"limit"}, {"in"=>"query", "name"=>"offset", "description"=>"offset"}, {"in"=>"query", "name"=>"profile", "description"=>"profile"}, {"in"=>"query", "name"=>"query", "description"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}, "/suggestions.json"=>{"get"=>{"summary"=>"get autocompletion recommendations for search queries", "description"=>"Get autocompletion recommendations for search queries.", "operationId"=>"suggestions", "x-api-path-slug"=>"suggestions-json-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"callback"}, {"in"=>"query", "name"=>"phrases", "description"=>"phrases"}, {"in"=>"query", "name"=>"query", "description"=>"query"}, {"in"=>"query", "name"=>"rows", "description"=>"rows"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suggestions"]}}, "/translateQuery.json"=>{"get"=>{"summary"=>"translate a term to different languages", "description"=>"Translate a term to different languages.", "operationId"=>"translateQueryUsingGET", "x-api-path-slug"=>"translatequery-json-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"callback"}, {"in"=>"query", "name"=>"languageCodes", "description"=>"languageCodes"}, {"in"=>"query", "name"=>"profile", "description"=>"profile"}, {"in"=>"query", "name"=>"term", "description"=>"term"}, {"in"=>"query", "name"=>"wskey", "description"=>"wskey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Translations", "Query"]}}}}, "apis"=>{"name"=>"Europeana", "x-slug"=>"europeana", "description"=>"Explore 51,990,182 artworks, artefacts, books, videos and sounds from more than 3,500 museums, galleries, libraries and archives across Europe.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/777-europeana.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"68066", "tags"=>"API LIfeyclessss,API Provider,Art,General Data,Historical Data API,History,Library,Museum,Museums,Profiles,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"europeana/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Europeana", "x-api-slug"=>"europeana", "description"=>"Explore 51,990,182 artworks, artefacts, books, videos and sounds from more than 3,500 museums, galleries, libraries and archives across Europe.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/777-europeana.jpg", "humanURL"=>"http://europeana.eu/portal/", "baseURL"=>"https://www.europeana.eu/v2/", "tags"=>"API LIfeyclessss,API Provider,Art,General Data,Historical Data API,History,Library,Museum,Museums,Profiles,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/europeana/translatequery-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/europeana/europeana-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://www.europeana.eu/api/"}, {"type"=>"x-blog", "url"=>"http://blog.europeana.eu/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.europeana.eu/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/europeana"}, {"type"=>"x-developer", "url"=>"http://europeana.eu/portal/api-introduction.html"}, {"type"=>"x-github", "url"=>"https://github.com/europeana"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/EuropeanaEU"}, {"type"=>"x-website", "url"=>"http://europeana.eu/portal/"}, {"type"=>"x-website", "url"=>"http://europeana.eu"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-identity-access-management{"google-cloud-identity-access-management-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Identity Access Management", "x-complete"=>1, "info"=>{"title"=>"Google Identity and Access Management (IAM)", "description"=>"manages-identity-and-access-control-for-google-cloud-platform-resources-including-the-creation-of-service-accounts-which-you-can-use-to-authenticate-to-google-and-make-api-calls-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"iam.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/roles:queryGrantableRoles"=>{"post"=>{"summary"=>"Query Roles", "description"=>"Queries roles that can be granted on a particular resource.\nA role is grantable if it can be used as the role in a binding for a policy\nfor that resource.", "operationId"=>"iam.roles.queryGrantableRoles", "x-api-path-slug"=>"v1rolesquerygrantableroles-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Role"]}}, "/v1/{name}"=>{"delete"=>{"summary"=>"Delete Service Account Key", "description"=>"Deletes a ServiceAccountKey.", "operationId"=>"iam.projects.serviceAccounts.keys.delete", "x-api-path-slug"=>"v1name-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The resource name of the service account key in the following format:`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Account Key"]}, "get"=>{"summary"=>"Get Service Account Key", "description"=>"Gets the ServiceAccountKey\nby key id.", "operationId"=>"iam.projects.serviceAccounts.keys.get", "x-api-path-slug"=>"v1name-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The resource name of the service account key in the following format:`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`"}, {"in"=>"query", "name"=>"publicKeyType", "description"=>"The output format of the public key requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Account Key"]}, "put"=>{"summary"=>"Update Service Account Key", "description"=>"Updates a ServiceAccount.\n\nCurrently, only the following fields are updatable:\n`display_name` .\nThe `etag` is mandatory.", "operationId"=>"iam.projects.serviceAccounts.update", "x-api-path-slug"=>"v1name-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The resource name of the service account in the following format:`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Account Key"]}}, "/v1/{name}/keys"=>{"get"=>{"summary"=>"Get Service Account Keys", "description"=>"Lists ServiceAccountKeys.", "operationId"=>"iam.projects.serviceAccounts.keys.list", "x-api-path-slug"=>"v1namekeys-get", "parameters"=>[{"in"=>"query", "name"=>"keyTypes", "description"=>"Filters the types of keys the user wants to include in the listresponse"}, {"in"=>"path", "name"=>"name", "description"=>"The resource name of the service account in the following format:`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Account Key"]}, "post"=>{"summary"=>"Create Service Account Key", "description"=>"Creates a ServiceAccountKey\nand returns it.", "operationId"=>"iam.projects.serviceAccounts.keys.create", "x-api-path-slug"=>"v1namekeys-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The resource name of the service account in the following format:`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Account Key"]}}, "/v1/{name}/serviceAccounts"=>{"get"=>{"summary"=>"Get Service Accounts", "description"=>"Lists ServiceAccounts for a project.", "operationId"=>"iam.projects.serviceAccounts.list", "x-api-path-slug"=>"v1nameserviceaccounts-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Required"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Optional limit on the number of service accounts to include in theresponse"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Optional pagination token returned in an earlierListServiceAccountsResponse"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Account"]}, "post"=>{"summary"=>"Create Service Account", "description"=>"Creates a ServiceAccount\nand returns it.", "operationId"=>"iam.projects.serviceAccounts.create", "x-api-path-slug"=>"v1nameserviceaccounts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Account"]}}, "/v1/{name}:signBlob"=>{"post"=>{"summary"=>"Sign Blob", "description"=>"Signs a blob using a service account's system-managed private key.", "operationId"=>"iam.projects.serviceAccounts.signBlob", "x-api-path-slug"=>"v1namesignblob-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The resource name of the service account in the following format:`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blob"]}}, "/v1/{name}:signJwt"=>{"post"=>{"summary"=>"Sign JWT", "description"=>"Signs a JWT using a service account's system-managed private key.\n\nIf no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an\nan expiry time of one hour by default. If you request an expiry time of\nmore than one hour, the request will fail.", "operationId"=>"iam.projects.serviceAccounts.signJwt", "x-api-path-slug"=>"v1namesignjwt-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The resource name of the service account in the following format:`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["JWT"]}}, "/v1/{resource}:getIamPolicy"=>{"post"=>{"summary"=>"Return IAM Access Control Policy", "description"=>"Returns the IAM access control policy for a\nServiceAccount.", "operationId"=>"iam.projects.serviceAccounts.getIamPolicy", "x-api-path-slug"=>"v1resourcegetiampolicy-post", "parameters"=>[{"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}, "/v1/{resource}:setIamPolicy"=>{"post"=>{"summary"=>"Set IAM Access Control Policy", "description"=>"Sets the IAM access control policy for a\nServiceAccount.", "operationId"=>"iam.projects.serviceAccounts.setIamPolicy", "x-api-path-slug"=>"v1resourcesetiampolicy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy is being specified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}, "/v1/{resource}:testIamPermissions"=>{"post"=>{"summary"=>"Tests Permissions", "description"=>"Tests the specified permissions against the IAM access control policy\nfor a ServiceAccount.", "operationId"=>"iam.projects.serviceAccounts.testIamPermissions", "x-api-path-slug"=>"v1resourcetestiampermissions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy detail is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}}}}, "apis"=>{"name"=>"Google Cloud Identity Access Management", "x-slug"=>"google-cloud-identity-access-management", "description"=>"Google Cloud Identity & Access Management (IAM) lets administrators authorize who can take action on specific resources, giving you full control and visibility to manage cloud resources centrally. For established enterprises with complex organizational structures, hundreds of workgroups and potentially many more projects, Cloud IAM provides a unified view into security policy across your entire organization, with built-in auditing to ease compliance processes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/right-roles.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Authentication,Google APIs,IAM,Identities,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-identity-access-management/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Identity & Access Management API", "x-api-slug"=>"google-cloud-identity-access-management-api", "description"=>"Google Cloud Identity & Access Management (IAM) lets administrators authorize who can take action on specific resources, giving you full control and visibility to manage cloud resources centrally. For established enterprises with complex organizational structures, hundreds of workgroups and potentially many more projects, Cloud IAM provides a unified view into security policy across your entire organization, with built-in auditing to ease compliance processes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/right-roles.png", "humanURL"=>"https://cloud.google.com/iam/", "baseURL"=>"://iam.googleapis.com//", "tags"=>"API Provider,API Service Provider,Authentication,Google APIs,IAM,Identities,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-identity-access-management/google-cloud-identity-access-management-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-concepts", "url"=>"https://cloud.google.com/iam/docs/concepts"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/iam/docs/"}, {"type"=>"x-faq", "url"=>"https://cloud.google.com/iam/docs/faq"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/iam/docs/quickstart"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/iam/docs/how-to"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/iam/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
disney-post{} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
zencoder{"zencoder-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Zencoder", "x-complete"=>1, "info"=>{"title"=>"Zencoder", "version"=>"v2"}, "host"=>"app.zencoder.com", "basePath"=>"/api/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/account"=>{"get"=>{"summary"=>"Get Account Details", "description"=>"Get Account Details", "operationId"=>"getAccount", "x-api-path-slug"=>"account-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"The API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}, "post"=>{"summary"=>"Create an Account", "description"=>"Create an Account", "operationId"=>"postAccount", "x-api-path-slug"=>"account-post", "parameters"=>[{"in"=>"query", "name"=>"email"}, {"in"=>"query", "name"=>"password"}, {"in"=>"query", "name"=>"password_confirmation"}, {"in"=>"query", "name"=>"terms_of_service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/account/integration"=>{"put"=>{"summary"=>"Integration Mode", "description"=>"Integration Mode", "operationId"=>"putAccountIntegration", "x-api-path-slug"=>"accountintegration-put", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"The API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Integration"]}}, "/account/live"=>{"put"=>{"summary"=>"Integration Mode - Live", "description"=>"Integration Mode - Live", "operationId"=>"putAccountLive", "x-api-path-slug"=>"accountlive-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Live"]}}, "/inputs/{input_id}"=>{"get"=>{"summary"=>"Get Input Details", "description"=>"Get Input Details", "operationId"=>"getInupdatesInupdate", "x-api-path-slug"=>"inputsinput-id-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"The API key"}, {"in"=>"query", "name"=>"callback", "description"=>"JSONP Callback"}, {"in"=>"query", "name"=>"input_id", "description"=>"The input id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Inputs", "Input", "Id"]}}, "/inputs/{input_id}/progress"=>{"get"=>{"summary"=>"Input Progress", "description"=>"The return will contain one or more of the following keys: state, current_event, current_event_progress and progress.", "operationId"=>"getInupdatesInupdateProgress", "x-api-path-slug"=>"inputsinput-idprogress-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Inputs", "Input", "Id", "Progress"]}}, "/jobs"=>{"get"=>{"summary"=>"List Jobs", "description"=>"A list of jobs can be obtained by sending an HTTP GET request.", "operationId"=>"getJobs", "x-api-path-slug"=>"jobs-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}, "post"=>{"summary"=>"Create a Job", "description"=>"Encoding jobs are created by sending an HTTP POST request.", "operationId"=>"postJobs", "x-api-path-slug"=>"jobs-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"The API key"}, {"in"=>"query", "name"=>"Encoding Settings", "description"=>"(see: https://app"}, {"in"=>"query", "name"=>"input", "description"=>"A valid URL to a media file (HTTP/HTTPS, FTP/FTPS, SFTP, GCS, CF or S3), with or without authentication"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/jobs/{job_id}"=>{"get"=>{"summary"=>"Get Job Details", "description"=>"Get Job Details", "operationId"=>"getJobsJob", "x-api-path-slug"=>"jobsjob-id-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"The API Key"}, {"in"=>"query", "name"=>"Get Job Details", "description"=>"The Job id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs", "Job", "Id"]}}, "/jobs/{job_id}/cancel"=>{"put"=>{"summary"=>"Cancel a Job", "description"=>"If you wish to cancel a job that has not yet finished processing you may send a request.", "operationId"=>"putJobsJobCancel", "x-api-path-slug"=>"jobsjob-idcancel-put", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"The API Key"}, {"in"=>"query", "name"=>"job_id", "description"=>"The job id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs", "Job", "Id", "Cancel"]}}, "/jobs/{job_id}/finish"=>{"put"=>{"summary"=>"Finish a LIve Job", "description"=>"Finishes the input on a Live streaming job.", "operationId"=>"putJobsJobFinish", "x-api-path-slug"=>"jobsjob-idfinish-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs", "Job", "Id", "Finish"]}}, "/jobs/{job_id}/progress"=>{"get"=>{"summary"=>"Job Progress", "description"=>"The return will contain one or more of the following keys: state, input, outputs, and progress.", "operationId"=>"getJobsJobProgress", "x-api-path-slug"=>"jobsjob-idprogress-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs", "Job", "Id", "Progress"]}}, "/jobs/{job_id}/resubmit"=>{"put"=>{"summary"=>"Resubmit a Job", "description"=>"If a job has failed processing you may request that it be attempted again.", "operationId"=>"putJobsJobResubmit", "x-api-path-slug"=>"jobsjob-idresubmit-put", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"The API Key"}, {"in"=>"query", "name"=>"job_id", "description"=>"The job id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs", "Job", "Id", "Resubmit"]}}, "/outputs/{output_id}/progress"=>{"get"=>{"summary"=>"Output Progress", "description"=>"The return will contain one or more of the following keys: state, current_event, current_event_progress and progress.", "operationId"=>"getOutupdatesOutupdateProgress", "x-api-path-slug"=>"outputsoutput-idprogress-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"The API key"}, {"in"=>"query", "name"=>"callback", "description"=>"JSONP Callback"}, {"in"=>"query", "name"=>"output_id", "description"=>"The output id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Outputs", "Output", "Id", "Progress"]}}, "/reports/all"=>{"get"=>{"summary"=>"Get Usage for VOD & Live", "description"=>"Get Usage for VOD & Live", "operationId"=>"getReportsAll", "x-api-path-slug"=>"reportsall-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"The API key"}, {"in"=>"query", "name"=>"from", "description"=>"Start date in the format YYYY-MM-DD (default: 30 days ago)"}, {"in"=>"query", "name"=>"grouping", "description"=>"Hour usage for only one report grouping (default: none)"}, {"in"=>"query", "name"=>"to", "description"=>"End date in the format YYYY-MM-DD (default: yesterday)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports"]}}, "/reports/live"=>{"get"=>{"summary"=>"Get Usage for Live", "description"=>"Get Usage for Live", "operationId"=>"getReportsLive", "x-api-path-slug"=>"reportslive-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"The API key"}, {"in"=>"query", "name"=>"from", "description"=>"Start date in the format YYYY-MM-DD (default: 30 days ago)"}, {"in"=>"query", "name"=>"grouping", "description"=>"Hour usage for only one report grouping (default: none)"}, {"in"=>"query", "name"=>"to", "description"=>"End date in the format YYYY-MM-DD (default: yesterday)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "Live"]}}, "/reports/minutes"=>{"get"=>{"summary"=>"Get Minutes Used", "description"=>"Get Minutes Used", "operationId"=>"getReportsMinutes", "x-api-path-slug"=>"reportsminutes-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "Minutes"]}}, "/reports/vod"=>{"get"=>{"summary"=>"Get Usage for VOD", "description"=>"Get Usage for VOD", "operationId"=>"getReportsVod", "x-api-path-slug"=>"reportsvod-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"The API key"}, {"in"=>"query", "name"=>"from", "description"=>"Start date in the format YYYY-MM-DD (default: 30 days ago)"}, {"in"=>"query", "name"=>"grouping", "description"=>"Minute usage for only one report grouping (default: none)"}, {"in"=>"query", "name"=>"to", "description"=>"End date in the format YYYY-MM-DD (default: yesterday)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "Vod"]}}, "/v2/outputs/{output_id}"=>{"get"=>{"summary"=>"Get Output Details", "description"=>"Get Output Details", "operationId"=>"getV2OutupdatesOutupdate", "x-api-path-slug"=>"v2outputsoutput-id-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"The API key"}, {"in"=>"query", "name"=>"output_id", "description"=>"The output id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Outputs", "Output", "Id"]}}}}, "apis"=>{"name"=>"Zencoder", "x-slug"=>"zencoder", "description"=>"Audio and video encoding/transcoding software as a service. Convert videos online into web and mobile formats using our cloud encoding API.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/282-zencoder.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"596400", "tags"=>"Encoding,Enterprise,Getting Started Example,internet,Relative Data,SaaS,Service API,Stack Network,Technology,Video Encoding", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"zencoder/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Zencoder API", "x-api-slug"=>"zencoder-api", "description"=>"Zencoders Video Encoding API allows you to seamlessly integrate your application with Zencoder???s extremely fast and scalable encoding platform. Our RESTful API is extensively documented with easy-to-use guides and detailed descriptions, as well as thoroughly tested code libraries and code examples for every encoding setting. Backed by an uptime SLA and live support with real encoding engineers, integrating with Zencoder couldn???t be easier.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/282-zencoder.jpg", "humanURL"=>"http://zencoder.com/", "baseURL"=>"https://app.zencoder.com//api/v2", "tags"=>"Encoding,Enterprise,Getting Started Example,internet,Relative Data,SaaS,Service API,Stack Network,Technology,Video Encoding", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/zencoder/v2outputsoutput-id-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/zencoder/zencoder-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://app.zencoder.com/api/"}, {"type"=>"x-blog", "url"=>"http://blog.zencoder.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.zencoder.com/feed/"}, {"type"=>"x-contact-form", "url"=>"https://zencoder.com/en/sales"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/zencoder"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/zencoder"}, {"type"=>"x-developer", "url"=>"http://zencoder.com/api/"}, {"type"=>"x-email", "url"=>"privacy@zencoder.com"}, {"type"=>"x-error-codes", "url"=>"https://app.zencoder.com/docs/errors"}, {"type"=>"x-facebook", "url"=>"http://www.facebook.com/zencoderinc"}, {"type"=>"x-faq", "url"=>"https://app.zencoder.com/docs/faq"}, {"type"=>"x-getting-started", "url"=>"https://app.zencoder.com/docs/guides/getting-started"}, {"type"=>"x-github", "url"=>"https://github.com/zencoder"}, {"type"=>"x-pricing", "url"=>"https://zencoder.com/en/file-transcoding/pricing#basic"}, {"type"=>"x-pricing", "url"=>"https://zencoder.com/en/live-transcoding/pricing"}, {"type"=>"x-privacy", "url"=>"http://zencoder.com/privacy"}, {"type"=>"x-selfservice-registration", "url"=>"https://app.zencoder.com/signup"}, {"type"=>"x-terms-of-service", "url"=>"http://zencoder.com/terms"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/zencoderinc"}, {"type"=>"x-website", "url"=>"http://zencoder.com/"}, {"type"=>"x-website", "url"=>"http://zencoder.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
box{"box-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Box", "x-complete"=>1, "info"=>{"title"=>"Box", "description"=>"the-box-content-api-gives-you-access-to-secure-content-management-and-content-experience-features-for-use-in-your-own-app--it-strives-to-be-restful-and-is-organized-around-the-main-resources-youre-familiar-with-from-the-box-web-interface-", "version"=>"1.0.0"}, "host"=>"api.box.com", "basePath"=>"/2.0", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/files/content"=>{"options"=>{"summary"=>"File upload preflight check", "description"=>"The Pre-flight check API will verify that a file will be accepted by Box before you send all the bytes over the wire.", "operationId"=>"fileUploadPreflightCheck", "x-api-path-slug"=>"filescontent-options", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "Content"]}}, "/files/{FILE_ID}"=>{"get"=>{"summary"=>"Get File's Info, Get Embed Link", "description"=>"Used to retrieve the metadata about a file.", "operationId"=>"getFile", "x-api-path-slug"=>"filesfile-id-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"FILE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File"]}, "put"=>{"summary"=>"Update File Info, Lock and Unlock, Create Shared Link", "description"=>"Used to update individual or multiple fields in the file object, including renaming the file, changing its description, and creating a shared link for the file. To move a file, change the ID of its parent folder. An optional If-Match header can be included to prevent race conditions.\n\nTo lock and unlock files, you execute a PUT operation on the /files/{file id} endpoint and set or clear the lock properties on the file.\n\nUsed to create a shared link for this particular file. Please see here for more information on the permissions available for shared links. In order to get default shared link status, set it to an empty access level, i.e. {\"shared_link\": {}}. In order to disable a shared link, send this same type of PUT request with the value of shared_link set to null, i.e. {\"shared_link\": null}", "operationId"=>"updateFileInfo", "x-api-path-slug"=>"filesfile-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FILE_ID"}, {"in"=>"header", "name"=>"If-Match", "description"=>"The etag of the file can be included as an ???If-Match??? header to prevent race conditions"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File"]}, "delete"=>{"summary"=>"Delete File", "description"=>"Discards a file to the trash. The etag of the file can be included as an ???If-Match??? header to prevent race conditions.", "operationId"=>"deleteFile", "x-api-path-slug"=>"filesfile-id-delete", "parameters"=>[{"in"=>"path", "name"=>"FILE_ID"}, {"in"=>"header", "name"=>"If-Match", "description"=>"The etag of the file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File"]}, "post"=>{"summary"=>"Restore Item", "description"=>"Restores an item that has been moved to the trash. Default behavior is to restore the item to the folder it was in before it was moved to the trash. If that parent folder no longer exists or if there is now an item with the same name in that parent folder, the new parent folder and/or new name will need to be included in the request.", "operationId"=>"restoreTrashedFile", "x-api-path-slug"=>"filesfile-id-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FILE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File"]}}, "/files/{FILE_ID}/content"=>{"get"=>{"summary"=>"Download File", "description"=>"Retrieves the actual data of the file. An optional version parameter can be set to download a previous version of the file.", "operationId"=>"getFileContent", "x-api-path-slug"=>"filesfile-idcontent-get", "parameters"=>[{"in"=>"header", "name"=>"BoxApi", "description"=>"The shared link for this item"}, {"in"=>"path", "name"=>"FILE_ID"}, {"in"=>"header", "name"=>"Range", "description"=>"The range value in bytes"}, {"in"=>"query", "name"=>"version", "description"=>"The ID specific version of this file to download"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Content"]}}, "/files/{FILE_ID}/versions"=>{"get"=>{"summary"=>"View Versions", "description"=>"If there are previous versions of this file, this method can be used to retrieve information about the older versions. (Versions are only tracked for Box users with premium accounts.)", "operationId"=>"getFileVersions", "x-api-path-slug"=>"filesfile-idversions-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"FILE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Versions"]}}, "/files/{FILE_ID}/versions/current"=>{"post"=>{"summary"=>"Promote Version", "description"=>"If there are previous versions of this file, this method can be used to promote one of the older versions to the top of the stack. This actually mints a copy of the old version and puts it on the top of the versions stack. The file will have the exact same contents, the same SHA1/etag, and the same name as the original. Other properties such as comments do not get updated to their former values.", "operationId"=>"promotoeFileVersion", "x-api-path-slug"=>"filesfile-idversionscurrent-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FILE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Versions", "Current"]}}, "/files/{FILE_ID}/versions/{VERSION_ID}"=>{"delete"=>{"summary"=>"Delete Old Version", "description"=>"Discards a specific file version to the trash. (Depending on the enterprise settings for this user, the item will either be actually deleted from Box or moved to the trash.)", "operationId"=>"deleteFileVersion", "x-api-path-slug"=>"filesfile-idversionsversion-id-delete", "parameters"=>[{"in"=>"path", "name"=>"FILE_ID"}, {"in"=>"header", "name"=>"If-Match", "description"=>"The etag of the file"}, {"in"=>"path", "name"=>"VERSION_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Versions", "Version"]}}, "/files/{FILE_ID}/copy"=>{"post"=>{"summary"=>"Copy File", "description"=>"Used to create a copy of a file in another folder. The original version of the file will not be altered.", "operationId"=>"copyFile", "x-api-path-slug"=>"filesfile-idcopy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FILE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Copy"]}}, "/files/{FILE_ID}/thumbnail.{EXTENSION}"=>{"get"=>{"summary"=>"Get Thumbnail", "description"=>"Retrieves a thumbnail, or smaller image representation, of this file. Sizes of 32x32,64x64, 128x128, and 256x256 can be returned in the .png format and sizes of 32x32, 94x94, 160x160, and 320x320 can be returned in the .jpg format. Thumbnails can be generated for the image and video file formats listed here.", "operationId"=>"getFileThumbnail", "x-api-path-slug"=>"filesfile-idthumbnail-extension-get", "parameters"=>[{"in"=>"path", "name"=>"EXTENSION", "description"=>"The preview format, e"}, {"in"=>"path", "name"=>"FILE_ID"}, {"in"=>"query", "name"=>"max_height", "description"=>"The maximum height of the thumbnail"}, {"in"=>"query", "name"=>"max_width", "description"=>"The maximum width of the thumbnail"}, {"in"=>"query", "name"=>"min_height", "description"=>"The minimum height of the thumbnail"}, {"in"=>"query", "name"=>"min_width", "description"=>"The minimum width of the thumbnail"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Thumbnail.", "Extension"]}}, "/files/{FILE_ID}/trash"=>{"get"=>{"summary"=>"Get Trashed File", "description"=>"Retrieves an item that has been moved to the trash.", "operationId"=>"getTrashedFile", "x-api-path-slug"=>"filesfile-idtrash-get", "parameters"=>[{"in"=>"path", "name"=>"FILE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Trash"]}, "delete"=>{"summary"=>"Permanently Delete", "description"=>"Permanently deletes an item that is in the trash. The item will no longer exist in Box. This action cannot be undone.", "operationId"=>"deleteTrashedFile", "x-api-path-slug"=>"filesfile-idtrash-delete", "parameters"=>[{"in"=>"path", "name"=>"FILE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Trash"]}}, "/files/{FILE_ID}/comments"=>{"get"=>{"summary"=>"Get File's Comments", "description"=>"Retrieves the comments on a particular file, if any exist.", "operationId"=>"getFileComments", "x-api-path-slug"=>"filesfile-idcomments-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"FILE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Comments"]}}, "/files/{FILE_ID}/collaborations"=>{"get"=>{"summary"=>"Get File's Collaborations", "description"=>"Use this to get a list of all the collaborations on a file", "operationId"=>"getFileCollaborations", "x-api-path-slug"=>"filesfile-idcollaborations-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"FILE_ID"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return in a page"}, {"in"=>"query", "name"=>"offset", "description"=>"The item at which to begin the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Collaborations"]}}, "/files/{FILE_ID}/tasks"=>{"get"=>{"summary"=>"Get File's Tasks", "description"=>"Retrieves all of the tasks for given file.", "operationId"=>"getFileTasks", "x-api-path-slug"=>"filesfile-idtasks-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"FILE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Tasks"]}}, "/folders"=>{"post"=>{"summary"=>"Create Folder", "description"=>"Used to create a new empty folder. The new folder will be created inside of the specified parent folder", "operationId"=>"createFolder", "x-api-path-slug"=>"folders-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders"]}}, "/folders/{FOLDER_ID}"=>{"get"=>{"summary"=>"Get Folder's Info", "description"=>"Retrieves the full metadata about a folder, including information about when it was last updated as well as the files and folders contained in it. The root folder of a Box account is always represented by the id ???0???.", "operationId"=>"getFolder", "x-api-path-slug"=>"foldersfolder-id-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"FOLDER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder"]}, "put"=>{"summary"=>"Update Folder, Create Shared Link, Create or Delete", "description"=>"Used to update information about the folder. To move a folder, update the ID of its parent. To enable an email address that can be used to upload files to this folder, update the folder_upload_email attribute. An optional If-Match header can be included to ensure that client only updates the folder if it knows about the latest version.\n\nUsed to create a shared link for this particular folder. Please see here for more information on the permissions available for shared links. In order to get default shared link status, set it to an empty access level, i.e. {\"shared_link\": {}}. In order to disable a shared link, send this same type of PUT request with the value of shared_link set to null, i.e. {\"shared_link\": null}\n\nTo add or remove an item from a collection, you do a PUT on that item and change the list of collections it belongs to. Philosophically, this is similar to the way ???move??? operations work on files and folders: you do a PUT on the item and change its parent. It???s the same idea with collections, except you???re changing which collection(s) the item belongs to instead of the folder it belongs to. Currently the only collection available is the favorites collection, and you???ll need to know it???s ID for the user that is making the API call, since every user has a different favorites collection_id.\nThe Add/Remove API handling will check all ids passed in before performing any add/removal operations. If any collection ids are malformed or do not exist in the user???s account, the API call will throw a 400. Only if all of the collection ids are valid will the adds and removals be carried out.", "operationId"=>"updateFolder", "x-api-path-slug"=>"foldersfolder-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"FOLDER_ID"}, {"in"=>"header", "name"=>"If-Match", "description"=>"This is in the ???etag??? field of the folder object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder"]}, "delete"=>{"summary"=>"Delete Folder", "description"=>"Used to delete a folder. A recursive parameter must be included in order to delete folders that have items inside of them. An optional If-Match header can be included to ensure that client only deletes the folder if it knows about the latest version.", "operationId"=>"deleteFolder", "x-api-path-slug"=>"foldersfolder-id-delete", "parameters"=>[{"in"=>"path", "name"=>"FOLDER_ID"}, {"in"=>"header", "name"=>"If-Match", "description"=>"This is in the ???etag??? field of the folder object"}, {"in"=>"query", "name"=>"recursive"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder"]}, "post"=>{"summary"=>"Restore Folder", "description"=>"Restores an item that has been moved to the trash. Default behavior is to restore the item to the folder it was in before it was moved to the trash. If that parent folder no longer exists or if there is now an item with the same name in that parent folder, the new parent folder and/or new name will need to be included in the request.", "operationId"=>"restoreTrashedFolder", "x-api-path-slug"=>"foldersfolder-id-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"FOLDER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder"]}}, "/folders/{FOLDER_ID}/items"=>{"get"=>{"summary"=>"Get Folder???s Items", "description"=>"Retrieves the files and/or folders contained within this folder without any other metadata about the folder. Any attribute in the full files or folders objects can be passed in with the fields parameter to get specific attributes, and only those specific attributes back; otherwise, the mini format is returned for each item by default. Multiple attributes can be passed in separated by commas e.g. fields=name,created_at. Paginated results can be retrieved using the limit and offset parameters.", "operationId"=>"getFolderItems", "x-api-path-slug"=>"foldersfolder-iditems-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"FOLDER_ID"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return in a page"}, {"in"=>"query", "name"=>"offset", "description"=>"The offset at which to begin the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder", "", "Items"]}}, "/folders/{FOLDER_ID}/copy"=>{"post"=>{"summary"=>"Copy Folder", "description"=>"Used to create a copy of a folder in another folder. The original version of the folder will not be altered.", "operationId"=>"copyFolder", "x-api-path-slug"=>"foldersfolder-idcopy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"FOLDER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder", "", "Copy"]}}, "/folders/{FOLDER_ID}/collaborations"=>{"get"=>{"summary"=>"Get Folder Collaborations", "description"=>"Use this to get a list of all the collaborations on a folder i.e. all of the users that have access to that folder.", "operationId"=>"getFolderCollaborations", "x-api-path-slug"=>"foldersfolder-idcollaborations-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"FOLDER_ID"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return in a page"}, {"in"=>"query", "name"=>"offset", "description"=>"The item at which to begin the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder", "", "Collaborations"]}}, "/folders/{FOLDER_ID}/trash"=>{"get"=>{"summary"=>"Get Trashed Folder", "description"=>"Retrieves an folder that has been moved to the trash.", "operationId"=>"getTrashedFolder", "x-api-path-slug"=>"foldersfolder-idtrash-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"FOLDER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder", "", "Trash"]}, "delete"=>{"summary"=>"Permanently Delete", "description"=>"Permanently deletes an folder that is in the trash. The item will no longer exist in Box. This action cannot be undone.", "operationId"=>"deleteTrashedFolder", "x-api-path-slug"=>"foldersfolder-idtrash-delete", "parameters"=>[{"in"=>"path", "name"=>"FOLDER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder", "", "Trash"]}}, "/folders/trash/items"=>{"get"=>{"summary"=>"Get Trashed Items", "description"=>"Retrieves the files and/or folders that have been moved to the trash. Any attribute in the full files or folders objects can be passed in with the fields parameter to get specific attributes, and only those specific attributes back; otherwise, the mini format is returned for each item by default. Multiple attributes can be passed in separated by commas e.g. fields=name,created_at. Paginated results can be retrieved using the limit and offset parameters.", "operationId"=>"getTrashedItems", "x-api-path-slug"=>"folderstrashitems-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"offset", "description"=>"The item at which to begin the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Trash", "Items"]}}, "/files/{FILE_ID}/watermark"=>{"get"=>{"summary"=>"Get Watermark on File", "description"=>"Used to retrieve the watermark for a corresponding Box file.", "operationId"=>"getFileWatermark", "x-api-path-slug"=>"filesfile-idwatermark-get", "parameters"=>[{"in"=>"path", "name"=>"FILE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Watermark"]}, "put"=>{"summary"=>"Apply Watermark on File", "description"=>"Used to apply or update the watermark for a corresponding Box file. The endpoint accepts a JSON body describing the watermark to apply.", "operationId"=>"updateFileWatermark", "x-api-path-slug"=>"filesfile-idwatermark-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FILE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Watermark"]}, "delete"=>{"summary"=>"Remove Watermark on File", "description"=>"Used to remove the watermark for a corresponding Box file.", "operationId"=>"deleteFileWatermark", "x-api-path-slug"=>"filesfile-idwatermark-delete", "parameters"=>[{"in"=>"path", "name"=>"FILE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Watermark"]}}, "/folders/{FOLDER_ID}/watermark"=>{"get"=>{"summary"=>"Get Watermark on Folder", "description"=>"Used to retrieve the watermark for a corresponding Box folder.", "operationId"=>"getFolderWatermark", "x-api-path-slug"=>"foldersfolder-idwatermark-get", "parameters"=>[{"in"=>"path", "name"=>"FOLDER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder", "", "Watermark"]}, "put"=>{"summary"=>"Apply Watermark on Folder", "description"=>"Used to apply or update the watermark for a corresponding Box folder. The endpoints accepts a JSON body describing the watermark to apply.", "operationId"=>"updateFolderWatermark", "x-api-path-slug"=>"foldersfolder-idwatermark-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FOLDER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder", "", "Watermark"]}, "delete"=>{"summary"=>"Remove Watermark on Folder", "description"=>"Used to remove the watermark for a corresponding Box Folder.", "operationId"=>"deleteFolderWatermark", "x-api-path-slug"=>"foldersfolder-idwatermark-delete", "parameters"=>[{"in"=>"path", "name"=>"FOLDER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder", "", "Watermark"]}}, "/web_links"=>{"post"=>{"summary"=>"Create Web Link", "description"=>"Creates a web link object within a given folder.", "operationId"=>"createWebLink", "x-api-path-slug"=>"web-links-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Web", "Links"]}}, "/web_links/{WEB_LINK_ID}"=>{"get"=>{"summary"=>"Get Web Link", "description"=>"Use to get information about the web link.", "operationId"=>"getWebLink", "x-api-path-slug"=>"web-linksweb-link-id-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"WEB_LINK_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Web", "Links", "Web", "Link"]}, "put"=>{"summary"=>"Update Web Link", "description"=>"Updates information for a web link.", "operationId"=>"updateWebLink", "x-api-path-slug"=>"web-linksweb-link-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"WEB_LINK_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Web", "Links", "Web", "Link"]}, "delete"=>{"summary"=>"Delete Web Link", "description"=>"Deletes a web link and moves it to the trash", "operationId"=>"deleteWebLink", "x-api-path-slug"=>"web-linksweb-link-id-delete", "parameters"=>[{"in"=>"path", "name"=>"WEB_LINK_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Web", "Links", "Web", "Link"]}}, "/metadata_templates/schema"=>{"post"=>{"summary"=>"Create Metadata Template", "description"=>"Used to create a new metadata template with the specified schema.", "operationId"=>"createMetadataTemplate", "x-api-path-slug"=>"metadata-templatesschema-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Metadata", "Templates", "Schema"]}}, "/metadata_templates/{SCOPE}"=>{"get"=>{"summary"=>"Get Enterprise Metadata", "description"=>"Used to retrieve all metadata templates within a user's enterprise. Currently only the enterprise scope is supported.", "operationId"=>"getEnterpriseMetadataTemplates", "x-api-path-slug"=>"metadata-templatesscope-get", "parameters"=>[{"in"=>"path", "name"=>"SCOPE"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Metadata", "Templates", "Scope"]}}, "/metadata_templates/{SCOPE}/{TEMPLATE}/schema"=>{"get"=>{"summary"=>"Get Metadata Template", "description"=>"Used to retrieve the schema for a given metadata template.", "operationId"=>"getMetadataTemplate", "x-api-path-slug"=>"metadata-templatesscopetemplateschema-get", "parameters"=>[{"in"=>"path", "name"=>"SCOPE"}, {"in"=>"path", "name"=>"TEMPLATE"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Metadata", "Templates", "Scope", "Template", "Schema"]}, "put"=>{"summary"=>"Update Metadata Template", "description"=>"Used to update the schema of an existing template.", "operationId"=>"updateMetadataTemplate", "x-api-path-slug"=>"metadata-templatesscopetemplateschema-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"SCOPE"}, {"in"=>"path", "name"=>"TEMPLATE"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Metadata", "Templates", "Scope", "Template", "Schema"]}}, "/files/{FILE_ID}/metadata"=>{"get"=>{"summary"=>"Get all Metadata on File", "description"=>"Used to retrieve all metadata associated with a given file", "operationId"=>"getAllFileMetadata", "x-api-path-slug"=>"filesfile-idmetadata-get", "parameters"=>[{"in"=>"path", "name"=>"FILE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Metadata"]}}, "/files/{FILE_ID}/metadata/{SCOPE}/{TEMPLATE}"=>{"post"=>{"summary"=>"Create Metadata on File", "description"=>"Used to create the metadata template instance for a corresponding Box file. When creating metadata, only values that adhere to the metadata template schema will be accepted.", "operationId"=>"createFileMetadata", "x-api-path-slug"=>"filesfile-idmetadatascopetemplate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FILE_ID"}, {"in"=>"path", "name"=>"SCOPE"}, {"in"=>"path", "name"=>"TEMPLATE"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Metadata", "Scope", "Template"]}, "get"=>{"summary"=>"Get Metadata on File", "description"=>"Used to retrieve the metadata template instance for a corresponding Box file.", "operationId"=>"getFileMetadata", "x-api-path-slug"=>"filesfile-idmetadatascopetemplate-get", "parameters"=>[{"in"=>"path", "name"=>"FILE_ID"}, {"in"=>"path", "name"=>"SCOPE"}, {"in"=>"path", "name"=>"TEMPLATE"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Metadata", "Scope", "Template"]}, "put"=>{"summary"=>"Update Metadata on File", "description"=>"Used to update the template instance. The request body must follow the JSON-Patch specification, which is represented as a JSON array of operation objects (see examples for more details). Updates can be either add, replace, remove , test, move, or copy. The template instance can only be updated if the template instance already exists. When editing metadata, only values that adhere to the metadata template schema will be accepted.\nThe update is applied atomically. If any errors occur during the application of the update operations, the metadata instance remains unchanged.", "operationId"=>"updateFileMetadata", "x-api-path-slug"=>"filesfile-idmetadatascopetemplate-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FILE_ID"}, {"in"=>"path", "name"=>"SCOPE"}, {"in"=>"path", "name"=>"TEMPLATE"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Metadata", "Scope", "Template"]}, "delete"=>{"summary"=>"Delete Metadata on File", "description"=>"Used to delete the template instance. To delete custom key:value pairs within a template instance, you should refer to the updating metadata section.", "operationId"=>"deleteFileMetadata", "x-api-path-slug"=>"filesfile-idmetadatascopetemplate-delete", "parameters"=>[{"in"=>"path", "name"=>"FILE_ID"}, {"in"=>"path", "name"=>"SCOPE"}, {"in"=>"path", "name"=>"TEMPLATE"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Files", "File", "", "Metadata", "Scope", "Template"]}}, "/folders/{FOLDER_ID}/metadata"=>{"get"=>{"summary"=>"Get All Metadata on Folder", "description"=>"Used to retrieve all metadata associated with a given folder", "operationId"=>"getAllFolderMetadata", "x-api-path-slug"=>"foldersfolder-idmetadata-get", "parameters"=>[{"in"=>"path", "name"=>"FOLDER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder", "", "Metadata"]}}, "/folders/{FOLDER_ID}/metadata/{SCOPE}/{TEMPLATE}"=>{"post"=>{"summary"=>"Create Metadata on Folder", "description"=>"Used to create the metadata template instance for a corresponding Box folder. When creating metadata, only values that adhere to the metadata template schema will be accepted.", "operationId"=>"createFolderMetadata", "x-api-path-slug"=>"foldersfolder-idmetadatascopetemplate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FOLDER_ID"}, {"in"=>"path", "name"=>"SCOPE"}, {"in"=>"path", "name"=>"TEMPLATE"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder", "", "Metadata", "Scope", "Template"]}, "get"=>{"summary"=>"Get Metadata on Folder", "description"=>"Used to retrieve the metadata template instance for a corresponding Box folder.", "operationId"=>"getFolderMetadata", "x-api-path-slug"=>"foldersfolder-idmetadatascopetemplate-get", "parameters"=>[{"in"=>"path", "name"=>"FOLDER_ID"}, {"in"=>"path", "name"=>"SCOPE"}, {"in"=>"path", "name"=>"TEMPLATE"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder", "", "Metadata", "Scope", "Template"]}, "put"=>{"summary"=>"Update Metadata on Folder", "description"=>"Used to update the template instance. Updates can be either add, replace, remove , or test. The template instance can only be updated if the template instance already exists. When editing metadata, only values that adhere to the metadata template schema will be accepted.", "operationId"=>"updateFolderMetadata", "x-api-path-slug"=>"foldersfolder-idmetadatascopetemplate-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FOLDER_ID"}, {"in"=>"path", "name"=>"SCOPE"}, {"in"=>"path", "name"=>"TEMPLATE"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder", "", "Metadata", "Scope", "Template"]}, "delete"=>{"summary"=>"Delete Metadata on Folder", "description"=>"Used to delete the template instance. To delete custom key:value pairs within a template instance, you should refer to the updating metadata section.", "operationId"=>"deleteFolderMetadata", "x-api-path-slug"=>"foldersfolder-idmetadatascopetemplate-delete", "parameters"=>[{"in"=>"path", "name"=>"FOLDER_ID"}, {"in"=>"path", "name"=>"SCOPE"}, {"in"=>"path", "name"=>"TEMPLATE"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Folders", "Folder", "", "Metadata", "Scope", "Template"]}}, "/collaborations"=>{"get"=>{"summary"=>"Pending Collaborations", "description"=>"Used to retrieve all pending collaboration invites for this user.", "operationId"=>"getPendingCollaborations", "x-api-path-slug"=>"collaborations-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"query", "name"=>"status", "description"=>"Must be pending"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Collaborations"]}, "post"=>{"summary"=>"Create Collaboration", "description"=>"Used to add a collaboration for a single user or a single group to a folder. Either an email address, a user ID, or a group id can be used to create the collaboration. If the collaboration is being created with a group, access to this endpoint is granted based on the group's invitability_level.", "operationId"=>"createCollaboration", "x-api-path-slug"=>"collaborations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Collaborations"]}}, "/collaborations/{COLLAB_ID}"=>{"get"=>{"summary"=>"Get Collaboration", "description"=>"Used to get information about a single collaboration. All collaborations for a single folder can be retrieved through GET /folders/{id}/collaborations. A complete list of the user???s pending collaborations can also be retrieved.", "operationId"=>"getCollaboration", "x-api-path-slug"=>"collaborationscollab-id-get", "parameters"=>[{"in"=>"path", "name"=>"COLLAB_ID"}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"query", "name"=>"status", "description"=>"Can only be pending"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Collaborations", "Collab"]}, "put"=>{"summary"=>"Update Collaboration", "description"=>"Used to edit an existing collaboration. Descriptions of the various roles can be found here.", "operationId"=>"updateCollaboation", "x-api-path-slug"=>"collaborationscollab-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"COLLAB_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Collaborations", "Collab"]}, "delete"=>{"summary"=>"Delete Collaboration", "description"=>"Used to delete a single collaboration.", "operationId"=>"deleteCollaboration", "x-api-path-slug"=>"collaborationscollab-id-delete", "parameters"=>[{"in"=>"path", "name"=>"COLLAB_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Collaborations", "Collab"]}}, "/search"=>{"get"=>{"summary"=>"Searching for Content", "description"=>"The search endpoint provides a powerful way of finding items that are accessible by a single user or an entire enterprise. Leverage the parameters listed below to generate targeted advanced searches.", "operationId"=>"search", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"ancestor_folder_ids", "description"=>"Limit searches to specific parent folders"}, {"in"=>"query", "name"=>"content_types", "description"=>"Limit searches to specific Box designated content types"}, {"in"=>"query", "name"=>"created_at_range", "description"=>"The date for when the item was created"}, {"in"=>"query", "name"=>"file_extensions", "description"=>"Limit searches to specific file extensions like pdf,png,doc"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of search results to return"}, {"in"=>"query", "name"=>"mdfilters", "description"=>"Filters for a specific metadata template for files with metadata object associations"}, {"in"=>"query", "name"=>"offset", "description"=>"The search result at which to start the response"}, {"in"=>"query", "name"=>"owner_user_ids", "description"=>"Search by item owners"}, {"in"=>"query", "name"=>"query", "description"=>"The string to search for; can be matched against item names, descriptions, text content of a file, and other fields of the different item types"}, {"in"=>"query", "name"=>"scope", "description"=>"The scope for which you want to limit your search to"}, {"in"=>"query", "name"=>"size_range", "description"=>"Filter by a file size range"}, {"in"=>"query", "name"=>"trash_content", "description"=>"Allows you to search within the trash"}, {"in"=>"query", "name"=>"type", "description"=>"The type you want to return in your search"}, {"in"=>"query", "name"=>"updated_at_range", "description"=>"The date for when the item was last updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Search"]}}, "/shared_items"=>{"get"=>{"summary"=>"Shared Items", "description"=>"Shared items are any files or folders that are represented by a shared link. Shared items are different from other API resources in that a shared resource doesn???t necessarily have to be in the account of the user accessing it. The actual shared link itself is used along with a normal access token.\nUsed to retrieve the metadata about a shared item when only given a shared link. Because of varying permission for shared links, a password may be required to retrieve the shared item. Once the item has been retrieved, you can make API requests against the actual resource /files/{id} or /folders/{id} as long as the shared link and optional password are in the header.", "operationId"=>"getSharedItems", "x-api-path-slug"=>"shared-items-get", "parameters"=>[{"in"=>"header", "name"=>"BoxApi", "description"=>"The usage is BoxApi: shared_link=SHARED_LINK&shared_link_password=SHARED_LINK_PASSWORD"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Shared", "Items"]}}, "/collections"=>{"get"=>{"summary"=>"Get Collections", "description"=>"Retrieves the collections for the given user. Currently, only the favorites collection is supported.", "operationId"=>"getCollections", "x-api-path-slug"=>"collections-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Collections"]}}, "/collections/{COLLECTION_ID}/items"=>{"get"=>{"summary"=>"Get Collection Items", "description"=>"Retrieves the files and/or folders contained within this collection. Collection item lists behave a lot like getting a folder???s items.\nPaginated results can be retrieved using the limit and offset parameters.\nSub-object fields can be requested via the ?fields parameter", "operationId"=>"getCollectionItems", "x-api-path-slug"=>"collectionscollection-iditems-get", "parameters"=>[{"in"=>"path", "name"=>"COLLECTION_ID"}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return in a page"}, {"in"=>"query", "name"=>"offset", "description"=>"The offset at which to begin the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Collections", "Collection", "", "Items"]}}, "/comments"=>{"post"=>{"summary"=>"Create Comment", "description"=>"Used to add a comment by the user to a specific file or comment (i.e. as a reply comment).", "operationId"=>"createComment", "x-api-path-slug"=>"comments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Comments"]}}, "/comments/{COMMENT_ID}"=>{"get"=>{"summary"=>"Get Comment", "description"=>"Used to retrieve the message and metadata about a specific comment. Information about the user who created the comment is also included.", "operationId"=>"getComment", "x-api-path-slug"=>"commentscomment-id-get", "parameters"=>[{"in"=>"path", "name"=>"COMMENT_ID"}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Comments", "Comment"]}, "put"=>{"summary"=>"Update Comment", "description"=>"Used to update the message of the comment.", "operationId"=>"updateComment", "x-api-path-slug"=>"commentscomment-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"COMMENT_ID"}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Comments", "Comment"]}, "delete"=>{"summary"=>"Delete Comment", "description"=>"Permanently deletes a comment.", "operationId"=>"deleteComment", "x-api-path-slug"=>"commentscomment-id-delete", "parameters"=>[{"in"=>"path", "name"=>"COMMENT_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Comments", "Comment"]}}, "/tasks"=>{"post"=>{"summary"=>"Create Task", "description"=>"Used to create a single task for single user on a single file.", "operationId"=>"createTask", "x-api-path-slug"=>"tasks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Tasks"]}}, "/tasks/{TASK_ID}"=>{"get"=>{"summary"=>"Get Task", "description"=>"Fetches a specific task.", "operationId"=>"getTask", "x-api-path-slug"=>"taskstask-id-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"TASK_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Tasks", "Task"]}, "put"=>{"summary"=>"Update Task", "description"=>"Updates a specific task.", "operationId"=>"updateTask", "x-api-path-slug"=>"taskstask-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"TASK_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Tasks", "Task"]}, "delete"=>{"summary"=>"Delete Task", "description"=>"Permanently deletes a specific task.", "operationId"=>"deleteTask", "x-api-path-slug"=>"taskstask-id-delete", "parameters"=>[{"in"=>"path", "name"=>"TASK_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Tasks", "Task"]}}, "/tasks/{TASK_ID}/assignments"=>{"get"=>{"summary"=>"Get Assignments", "description"=>"Retrieves all of the assignments for a given task.", "operationId"=>"getTaskAssignments", "x-api-path-slug"=>"taskstask-idassignments-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"TASK_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Tasks", "Task", "", "Assignments"]}}, "/task_assignments"=>{"post"=>{"summary"=>"Create Task Assignment", "description"=>"Used to assign a task to a single user. There can be multiple assignments on a given task.", "operationId"=>"createTaskAssignment", "x-api-path-slug"=>"task-assignments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Task", "Assignments"]}}, "/task_assignments/{TASK_ASSIGNMENT_ID}"=>{"get"=>{"summary"=>"Get Task Assignment", "description"=>"Fetches a specific task assignment.", "operationId"=>"getTaskAssignment", "x-api-path-slug"=>"task-assignmentstask-assignment-id-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"TASK_ASSIGNMENT_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Task", "Assignments", "Task", "Assignment"]}, "put"=>{"summary"=>"Update Task Assignment", "description"=>"Used to update a task assignment.", "operationId"=>"updateTaskAssignment", "x-api-path-slug"=>"task-assignmentstask-assignment-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"TASK_ASSIGNMENT_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Task", "Assignments", "Task", "Assignment"]}, "delete"=>{"summary"=>"Delete Task Assignment", "description"=>"Deletes a specific task assignment.", "operationId"=>"deleteTaskAssignment", "x-api-path-slug"=>"task-assignmentstask-assignment-id-delete", "parameters"=>[{"in"=>"path", "name"=>"TASK_ASSIGNMENT_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Task", "Assignments", "Task", "Assignment"]}}, "/events"=>{"get"=>{"summary"=>"User Events, Enterprise Events", "description"=>"Use this to get events for a given user. A chunk of event objects is returned for the user based on the parameters passed in. Parameters indicating how many chunks are left as well as the next stream_position are also returned.\n\nTo retrieve Enterprise Events specify 'stream_type=admin_logs'. Retrieves up to a year' events for all users in an enterprise. Upper and lower bounds as well as filters can be applied to the results.", "operationId"=>"getUserEvents", "x-api-path-slug"=>"events-get", "parameters"=>[{"in"=>"query", "name"=>"created_after", "description"=>"A lower bound on the timestamp of the events returned"}, {"in"=>"query", "name"=>"created_before", "description"=>"An upper bound on the timestamp of the events returned"}, {"in"=>"query", "name"=>"event_type", "description"=>"A comma-separated list of events to filter by"}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of events returned"}, {"in"=>"query", "name"=>"stream_position", "description"=>"The location in the event stream at which you want to start receiving events"}, {"in"=>"query", "name"=>"stream_type", "description"=>"Limits the type of events returned: all: returns everything, changes: returns tree changes, sync: returns tree changes only for sync folders"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Events"]}, "options"=>{"summary"=>"Long polling", "description"=>"To get real-time notification of activity in a Box account, use the long poll feature of the /events API. To do so, first call the /events API with an OPTIONS call to retrieve the long poll URL to use. Next, make a GET request to the provided URL to begin listening for events. If an event occurs within an account you are monitoring, you will receive a response with the value new_change. It???s important to note that this response will not come with any other details, but should serve as a prompt to take further action such as calling the /events endpoint with your last known stream_position. After sending this response, the server will close the connection and you will need to repeat the long poll process to begin listening for events again.\nIf no events occur for a period of time after you make the GET request to the long poll URL, you will receive a response with the value reconnect. When you receive this response, you???ll make another OPTIONS call to the /events endpoint and repeat the long poll process.\nIf you receive no events in retry_timeout seconds, you should make another GET request to the real time server (i.e. URL in the response). This might be necessary in case you do not receive the reconnect message in the face of network errors.\nIf you receive max_retries error when making GET requests to the real time server, you should make another OPTIONS request.", "operationId"=>"eventLongPolling", "x-api-path-slug"=>"events-options", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Events"]}}, "/users"=>{"post"=>{"summary"=>"Create User", "description"=>"Used to provision a new user in an enterprise. This method only works for enterprise admins.", "operationId"=>"createUser", "x-api-path-slug"=>"users-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Users"]}, "get"=>{"summary"=>"Get Enterprise Users", "description"=>"Returns a list of all users for the Enterprise along with their user_id, public_name, and login.", "operationId"=>"getEnterpriseUsers", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"query", "name"=>"filter_term", "description"=>"A string used to filter the results to only users starting with the filter_term in either the name or the login"}, {"in"=>"query", "name"=>"limit", "description"=>"The number of records to return"}, {"in"=>"query", "name"=>"offset", "description"=>"The record at which to start"}, {"in"=>"query", "name"=>"user_type", "description"=>"The type of user to search for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Users"]}}, "/users/me"=>{"get"=>{"summary"=>"Get Current User", "description"=>"Retrieves information about the user who is currently logged in i.e. the user for whom this auth token was generated.", "operationId"=>"getCurrentUser", "x-api-path-slug"=>"usersme-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Users", "Me"]}}, "/users/{USER_ID}"=>{"get"=>{"summary"=>"Get User's Info", "description"=>"Retrieves information about a user in the enterprise. Requires enterprise administration authorization.", "operationId"=>"getUser", "x-api-path-slug"=>"usersuser-id-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"USER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Users", "User"]}, "put"=>{"summary"=>"Update User, Change User's Login", "description"=>"Used to edit the settings and information about a user. This method only works for enterprise admins. To roll a user out of the enterprise (and convert them to a standalone free user), update the special enterprise attribute to be null.\n\nUsed to convert one of the user???s confirmed email aliases into the user???s primary login.", "operationId"=>"updateUser", "x-api-path-slug"=>"usersuser-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"USER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Users", "User"]}, "delete"=>{"summary"=>"Delete User", "description"=>"Deletes a user in an enterprise account.", "operationId"=>"deleteUser", "x-api-path-slug"=>"usersuser-id-delete", "parameters"=>[{"in"=>"query", "name"=>"force"}, {"in"=>"query", "name"=>"notify"}, {"in"=>"path", "name"=>"USER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Users", "User"]}}, "/users/{USER_ID}/folders/{FOLDER_ID}"=>{"put"=>{"summary"=>"Move User's Folder", "description"=>"Moves all of the owned content from within one user???s folder into a new folder in another user???s account. You can move folders across users as long as the you have administrative permissions and the ???source??? user owns the folders. To move everything from the root folder, use ???0??? which always represents the root folder of a Box account.", "operationId"=>"updateUserFolder", "x-api-path-slug"=>"usersuser-idfoldersfolder-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"FOLDER_ID"}, {"in"=>"query", "name"=>"notify"}, {"in"=>"path", "name"=>"USER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Users", "User", "", "Folders", "Folder"]}}, "/users/{USER_ID}/email_aliases"=>{"get"=>{"summary"=>"Get Email Aliases", "description"=>"Retrieves all email aliases for this user. The collection of email aliases does not include the primary login for the user; use GET /users/USER_ID to retrieve the login email address.", "operationId"=>"getEmailAliases", "x-api-path-slug"=>"usersuser-idemail-aliases-get", "parameters"=>[{"in"=>"path", "name"=>"USER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Users", "User", "", "Email", "Aliases"]}, "post"=>{"summary"=>"Add Email Alias", "description"=>"Adds a new email alias to the given user???s account.", "operationId"=>"addEmailAlias", "x-api-path-slug"=>"usersuser-idemail-aliases-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"USER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Users", "User", "", "Email", "Aliases"]}}, "/users/{USER_ID}/email_aliases/{EMAIL_ALIAS_ID}"=>{"delete"=>{"summary"=>"Delete Email Alias", "description"=>"Removes an email alias from a user.", "operationId"=>"deleteUserEmailAlias", "x-api-path-slug"=>"usersuser-idemail-aliasesemail-alias-id-delete", "parameters"=>[{"in"=>"path", "name"=>"EMAIL_ALIAS_ID"}, {"in"=>"path", "name"=>"USER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Users", "User", "", "Email", "Aliases", "Email", "Alias"]}}, "/invites"=>{"post"=>{"summary"=>"Invite User", "description"=>"Invites an existing user to join an Enterprise. The existing user can not be part of another Enterprise and must already have a Box account. Once invited, the user will receive an email and prompt to accept the invitation within the Box web application. This method requires the \"Manage An Enterprise\" scope for the enterprise, which can be enabled within your developer console.", "operationId"=>"createInvite", "x-api-path-slug"=>"invites-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Invites"]}}, "/invites/{INVITE_ID}"=>{"get"=>{"summary"=>"Get status of the invite", "description"=>"", "operationId"=>"getInvite", "x-api-path-slug"=>"invitesinvite-id-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"INVITE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Invites", "Invite"]}}, "/groups"=>{"post"=>{"summary"=>"Create Group", "description"=>"Used to create a group.", "operationId"=>"createGroup", "x-api-path-slug"=>"groups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Groups"]}, "get"=>{"summary"=>"Get Groups for an Enterprise", "description"=>"Retrieves all of the groups for given enterprise. Must have permissions to see an enterprise's groups.", "operationId"=>"getEnterpriseGroups", "x-api-path-slug"=>"groups-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return in a page"}, {"in"=>"query", "name"=>"offset", "description"=>"The item at which to begin the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Groups"]}}, "/groups/{GROUP_ID}"=>{"get"=>{"summary"=>"Get Group", "description"=>"Used to get information about a group.", "operationId"=>"getGroup", "x-api-path-slug"=>"groupsgroup-id-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"GROUP_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Groups", "Group"]}, "put"=>{"summary"=>"Update Group", "description"=>"Updates a specific group.", "operationId"=>"updateGroup", "x-api-path-slug"=>"groupsgroup-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"GROUP_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Groups", "Group"]}, "delete"=>{"summary"=>"Delete Group", "description"=>"Permanently deletes a specific group.", "operationId"=>"deleteGroup", "x-api-path-slug"=>"groupsgroup-id-delete", "parameters"=>[{"in"=>"path", "name"=>"GROUP_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Groups", "Group"]}}, "/group_memberships"=>{"post"=>{"summary"=>"Create Membership", "description"=>"Used to add a member to a Group.", "operationId"=>"createGroupMembership", "x-api-path-slug"=>"group-memberships-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Group", "Memberships"]}}, "/group_memberships/{GROUP_MEMBERSHIP_ID}"=>{"get"=>{"summary"=>"Get Membership", "description"=>"Fetches a specific group membership entry.", "operationId"=>"getGroupMembership", "x-api-path-slug"=>"group-membershipsgroup-membership-id-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"GROUP_MEMBERSHIP_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Group", "Memberships", "Group", "Membership"]}, "put"=>{"summary"=>"Update Membership", "description"=>"Used to update a group membership.", "operationId"=>"updateGroupMembership", "x-api-path-slug"=>"group-membershipsgroup-membership-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"GROUP_MEMBERSHIP_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Group", "Memberships", "Group", "Membership"]}, "delete"=>{"summary"=>"Delete Membership", "description"=>"Deletes a specific group membership.", "operationId"=>"deleteGroupMembership", "x-api-path-slug"=>"group-membershipsgroup-membership-id-delete", "parameters"=>[{"in"=>"path", "name"=>"GROUP_MEMBERSHIP_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Group", "Memberships", "Group", "Membership"]}}, "/groups/{GROUP_ID}/memberships"=>{"get"=>{"summary"=>"Get Memberships for Group", "description"=>"Retrieves all of the members for a given group if the requesting user has access (see Group Object member_viewability_level).", "operationId"=>"getGroupMemberships", "x-api-path-slug"=>"groupsgroup-idmemberships-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"GROUP_ID"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return in a page"}, {"in"=>"query", "name"=>"offset", "description"=>"The item at which to begin the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Groups", "Group", "", "Memberships"]}}, "/users/{USER_ID}/memberships"=>{"get"=>{"summary"=>"Get Memberships for User", "description"=>"Retrieves all of the group memberships for a given user. Note this is only available to group admins. To retrieve group memberships for the user making the API request, use the users/me/memberships endpoint.", "operationId"=>"getUserGroupMembership", "x-api-path-slug"=>"usersuser-idmemberships-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"query", "name"=>"limit", "description"=>"Default is 100"}, {"in"=>"query", "name"=>"offset", "description"=>"The item at which to begin the response"}, {"in"=>"path", "name"=>"USER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Users", "User", "", "Memberships"]}}, "/groups/{GROUP_ID}/collaborations"=>{"get"=>{"summary"=>"Get Collaborations for Group", "description"=>"Retrieves all of the group collaborations for a given group. Note this is only available to group admins.", "operationId"=>"getGroupCollaborations", "x-api-path-slug"=>"groupsgroup-idcollaborations-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Attribute(s) to include in the response"}, {"in"=>"path", "name"=>"GROUP_ID"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return in a page"}, {"in"=>"query", "name"=>"offset", "description"=>"The item at which to begin the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Groups", "Group", "", "Collaborations"]}}, "/enterprises/{ENTERPRISE_ID}/device_pinners"=>{"get"=>{"summary"=>"Get Enterprise Device Pins", "description"=>"Gets all the device pins within a given enterprise. Must be an enterprise admin with the manage enterprise scope to make this call.", "operationId"=>"getEnterpriseDevicePins", "x-api-path-slug"=>"enterprisesenterprise-iddevice-pinners-get", "parameters"=>[{"in"=>"query", "name"=>"direction", "description"=>"Default is asc"}, {"in"=>"path", "name"=>"ENTERPRISE_ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Default value is 100"}, {"in"=>"query", "name"=>"marker", "description"=>"Needs not be passed or can be empty for first invocation of the API"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Enterprises", "Enterprise", "", "Device", "Pinners"]}}, "/device_pinners/{ID}"=>{"get"=>{"summary"=>"Get Device Pin", "description"=>"Gets information about an individual device pin.", "operationId"=>"getDevicePin", "x-api-path-slug"=>"device-pinnersid-get", "parameters"=>[{"in"=>"path", "name"=>"ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Device", "Pinners"]}, "delete"=>{"summary"=>"Delete Device Pin", "description"=>"Delete individual device pin.", "operationId"=>"deleteDevicePin", "x-api-path-slug"=>"device-pinnersid-delete", "parameters"=>[{"in"=>"path", "name"=>"ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Device", "Pinners"]}}, "/retention_policies"=>{"post"=>{"summary"=>"Create Retention Policy", "description"=>"Used to create a new retention policy.", "operationId"=>"createRetentionPolicy", "x-api-path-slug"=>"retention-policies-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Retention", "Policies"]}, "get"=>{"summary"=>"Get Retention Policies", "description"=>"Retrieves all of the retention policies for the given enterprise.", "operationId"=>"getRetentionPolicies", "x-api-path-slug"=>"retention-policies-get", "parameters"=>[{"in"=>"query", "name"=>"created_by_user_id", "description"=>"A user id to filter the retention policies by"}, {"in"=>"query", "name"=>"policy_name", "description"=>"A name to filter the retention policies by"}, {"in"=>"query", "name"=>"policy_type", "description"=>"A policy type to filter the retention policies by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Retention", "Policies"]}}, "/retention_policies/{POLICY_ID}"=>{"get"=>{"summary"=>"Get Retention Policy", "description"=>"Used to retrieve information about a retention policy", "operationId"=>"getRetentionPolicy", "x-api-path-slug"=>"retention-policiespolicy-id-get", "parameters"=>[{"in"=>"path", "name"=>"POLICY_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Retention", "Policies", "Policy"]}, "put"=>{"summary"=>"Update Retention Policy", "description"=>"Used to update a retention policy.", "operationId"=>"updateRetentionPolicy", "x-api-path-slug"=>"retention-policiespolicy-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"POLICY_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Retention", "Policies", "Policy"]}}, "/retention_policies/{POLICY_ID}/assignments"=>{"get"=>{"summary"=>"Get Retention Policy Assignments", "description"=>"Returns a list of all retention policy assignments associated with a specified retention policy.", "operationId"=>"getRetentionPolicyAssignments", "x-api-path-slug"=>"retention-policiespolicy-idassignments-get", "parameters"=>[{"in"=>"path", "name"=>"POLICY_ID"}, {"in"=>"query", "name"=>"type", "description"=>"The type of the retention policy assignment to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Retention", "Policies", "Policy", "", "Assignments"]}}, "/retention_policy_assignments"=>{"post"=>{"summary"=>"Create Retention Policy Assignment", "description"=>"Returns a list of all retention policy assignments associated with a specified retention policy.", "operationId"=>"createRetentionPolicyAssignment", "x-api-path-slug"=>"retention-policy-assignments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Retention", "Policy", "Assignments"]}}, "/retention_policy_assignments/{RETENTION_POLICY_ASSIGNMENT_ID}"=>{"get"=>{"summary"=>"Get Retention Policy Assignment", "description"=>"Used to retrieve information about a retention policy assignment.", "operationId"=>"getRetentionPolicyAssignment", "x-api-path-slug"=>"retention-policy-assignmentsretention-policy-assignment-id-get", "parameters"=>[{"in"=>"path", "name"=>"RETENTION_POLICY_ASSIGNMENT_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Retention", "Policy", "Assignments", "Retention", "Policy", "Assignment"]}}, "/file_version_retentions"=>{"get"=>{"summary"=>"Get File Version Retentions", "description"=>"Retrieves all file version retentions for the given enterprise.", "operationId"=>"getFileVersionRetentions", "x-api-path-slug"=>"file-version-retentions-get", "parameters"=>[{"in"=>"query", "name"=>"disposition_action", "description"=>"The disposition action of the retention policy"}, {"in"=>"query", "name"=>"disposition_after", "description"=>"See content times for formatting"}, {"in"=>"query", "name"=>"disposition_before", "description"=>"See content times for formatting"}, {"in"=>"query", "name"=>"file_id", "description"=>"A file id to filter the file version retentions by"}, {"in"=>"query", "name"=>"file_version_id", "description"=>"A file version id to filter the file version retentions by"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return in a page"}, {"in"=>"query", "name"=>"marker", "description"=>"Base 64 encoded string that represents where the paging should being"}, {"in"=>"query", "name"=>"policy_id", "description"=>"A policy id to filter the file version retentions by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "File", "Version", "Retentions"]}}, "/file_version_retentions/{FILE_VERSION_RETENTION_ID}"=>{"get"=>{"summary"=>"Get File Version Retention", "description"=>"Used to retrieve information about a file version retention", "operationId"=>"getFileVersionRetention", "x-api-path-slug"=>"file-version-retentionsfile-version-retention-id-get", "parameters"=>[{"in"=>"path", "name"=>"FILE_VERSION_RETENTION_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "File", "Version", "Retentions", "File", "Version", "Retention"]}}, "/legal_hold_policies"=>{"post"=>{"summary"=>"Create New Legal Hold Policy", "description"=>"Create a new Legal Hold Policy. Optional date filter may be passed. If Policy has a date filter, any Custodian assignments will apply only to file versions created or uploaded inside of the date range.", "operationId"=>"createLegalHoldPolicy", "x-api-path-slug"=>"legal-hold-policies-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Legal", "Hold", "Policies"]}, "get"=>{"summary"=>"Get Legal Hold Policies", "description"=>"Get a list of Legal Hold Policies that belong to your Enterprise.", "operationId"=>"getLegalHoldPolicies", "x-api-path-slug"=>"legal-hold-policies-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limit result size to this number"}, {"in"=>"query", "name"=>"marker", "description"=>"Take from next_marker column of a prior call to get the next page"}, {"in"=>"query", "name"=>"policy_name", "description"=>"Case insensitive prefix-match filter on Policy name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Legal", "Hold", "Policies"]}}, "/legal_hold_policies/{ID}"=>{"put"=>{"summary"=>"Update Existing Legal Hold Policy", "description"=>"Update existing Legal Hold Policy. Only name and description can be modified.", "operationId"=>"updateLegalHoldPolicy", "x-api-path-slug"=>"legal-hold-policiesid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Legal", "Hold", "Policies"]}, "get"=>{"summary"=>"Get Legal Hold Policy", "description"=>"Get details of a single Legal Hold Policy", "operationId"=>"getLegalHoldPolicy", "x-api-path-slug"=>"legal-hold-policiesid-get", "parameters"=>[{"in"=>"path", "name"=>"ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Legal", "Hold", "Policies"]}, "delete"=>{"summary"=>"Delete Legal Hold Policy", "description"=>"Sends request to delete an existing Legal Hold Policy. Note that this is an asynchronous process - the Policy will not be fully deleted yet when the response comes back.", "operationId"=>"deleteLegalHoldPolicy", "x-api-path-slug"=>"legal-hold-policiesid-delete", "parameters"=>[{"in"=>"path", "name"=>"ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Legal", "Hold", "Policies"]}}, "/legal_hold_policies/{ID}/assignments"=>{"get"=>{"summary"=>"Get Legal hold policy assignments", "description"=>"Get list of assignments for a single Policy.", "operationId"=>"getLegalHoldPolicyAssignments", "x-api-path-slug"=>"legal-hold-policiesidassignments-get", "parameters"=>[{"in"=>"path", "name"=>"ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Legal", "Hold", "Policies", "", "Assignments"]}}, "/legal_hold_policy_assignments"=>{"post"=>{"summary"=>"Create New Legal Hold Policy Assignment", "description"=>"Create a new Assignment, which will apply the Legal Hold Policy to the target of the Assignment.", "operationId"=>"createLegalHoldPolicyAssignment", "x-api-path-slug"=>"legal-hold-policy-assignments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Legal", "Hold", "Policy", "Assignments"]}}, "/legal_hold_policy_assignments/{ASSIGNMENT_ID}"=>{"get"=>{"summary"=>"Get Legal Hold Policy Assignment", "description"=>"Get details of a single assignment.", "operationId"=>"getLegalHoldPolicyAssignment", "x-api-path-slug"=>"legal-hold-policy-assignmentsassignment-id-get", "parameters"=>[{"in"=>"path", "name"=>"ASSIGNMENT_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Legal", "Hold", "Policy", "Assignments", "Assignment"]}, "delete"=>{"summary"=>"Delete Legal Hold Policy Assignment", "description"=>"Sends request to delete an existing Assignment. Note that this is an asynchronous process - the Assignment will not be fully deleted yet when the response comes back.", "operationId"=>"deleteLegalHoldPolicyAssignment", "x-api-path-slug"=>"legal-hold-policy-assignmentsassignment-id-delete", "parameters"=>[{"in"=>"path", "name"=>"ASSIGNMENT_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Legal", "Hold", "Policy", "Assignments", "Assignment"]}}, "/file_version_legal_holds"=>{"get"=>{"summary"=>"Get List of File Version Legal Holds", "description"=>"Get list of non-deleted Holds for a single Policy.", "operationId"=>"getFileVersionLegalHoldPolicies", "x-api-path-slug"=>"file-version-legal-holds-get", "parameters"=>[{"in"=>"query", "name"=>"policy_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "File", "Version", "Legal", "Holds"]}}, "/file_version_legal_holds/{ID}"=>{"get"=>{"summary"=>"Get File Version Legal Hold", "description"=>"Get details of a single File Version Legal Hold.", "operationId"=>"getFileVersionLegalHoldPolicy", "x-api-path-slug"=>"file-version-legal-holdsid-get", "parameters"=>[{"in"=>"path", "name"=>"ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "File", "Version", "Legal", "Holds"]}}, "/webhooks"=>{"post"=>{"summary"=>"Create Webhook", "description"=>"Create Webhook", "operationId"=>"createWebhook", "x-api-path-slug"=>"webhooks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Webhooks"]}, "get"=>{"summary"=>"Get Webhooks", "description"=>"Returns all defined webhooks for the requesting application and user, up to the limit. If no limit is supplied then Box uses the default limit of 100.\nIf more than limit webhooks are defined then Box returns the webhooks in batches. When the results are batched, Box sends limit webhooks along with a next_marker field in the response object. The value of the next_marker field is a marker string that you can use in later requests to tell Box which batch to send next.\nWhen you send a request that includes a marker string, Box sends the next batch of webhooks, beginning after the last webhook of the previous batch. When the response contains the last of the defined webhooks, Box omits the next_marker field from its response.\nYou can use limit and marker together with the marker string returned in the next_marker field to paginate lists of webhooks.", "operationId"=>"getWebhooks", "x-api-path-slug"=>"webhooks-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"The maximum number of webhooks to return per page"}, {"in"=>"query", "name"=>"marker", "description"=>"A marker string returned by Box if the result contains less than the full number of webhooks that are defined"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Webhooks"]}}, "/webhooks/{WEBHOOK_ID}"=>{"get"=>{"summary"=>"Get Webhook", "description"=>"Get a Webhook", "operationId"=>"getWebhook", "x-api-path-slug"=>"webhookswebhook-id-get", "parameters"=>[{"in"=>"path", "name"=>"WEBHOOK_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Webhooks", "Webhook"]}, "put"=>{"summary"=>"Update Webhook", "description"=>"Update a Webhook", "operationId"=>"updateWebhook", "x-api-path-slug"=>"webhookswebhook-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"WEBHOOK_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Webhooks", "Webhook"]}, "delete"=>{"summary"=>"Delete Webhook", "description"=>"Permanently deletes a webhook", "operationId"=>"deleteWebhook", "x-api-path-slug"=>"webhookswebhook-id-delete", "parameters"=>[{"in"=>"path", "name"=>"WEBHOOK_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Webhooks", "Webhook"]}}}}, "apis"=>{"name"=>"Box", "x-slug"=>"box", "description"=>"Box is changing how you manage content across your business from simple file sharing to building custom apps.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/162-box.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"445", "tags"=>"API Provider,Backups,Collaboration,Enterprise,Files,Productivity,Profiles,Publish,Relative Data,Relative StreamRank,SaaS,Service API,Sharing,Stack,Stack Network,Storage,Storage,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"box/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Box", "x-api-slug"=>"box", "description"=>"Box.net provides a sophisticated API for their online document sharing and collaboration web application.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/162-box.jpg", "humanURL"=>"http://box.com", "baseURL"=>"https://api.box.com//2.0", "tags"=>"API Provider,Backups,Collaboration,Enterprise,Files,Productivity,Profiles,Publish,Relative Data,Relative StreamRank,SaaS,Service API,Sharing,Stack,Stack Network,Storage,Storage,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/box/webhookswebhook-id-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/box/box-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.box.com/"}, {"type"=>"x-blog", "url"=>"http://blog.box.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.box.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/box"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/box"}, {"type"=>"x-developer", "url"=>"http://developers.box.com"}, {"type"=>"x-github", "url"=>"https://github.com/box"}, {"type"=>"x-pricing", "url"=>"https://developers.box.com/box-platform-pricing/"}, {"type"=>"x-road-map", "url"=>"https://developers.box.com/roadmap/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/BoxPlatform"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/BoxHQ"}, {"type"=>"x-website", "url"=>"http://box.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
news-api{"news-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"News API", "x-complete"=>1, "info"=>{"title"=>"News API", "description"=>"get-breaking-news-headlines-and-search-for-articles-from-over-5000-news-sources-and-blogs-with-our-news-api-", "termsOfService"=>"https://newsapi.org/terms", "version"=>"1.0.0"}, "host"=>"newsapi.org", "basePath"=>"v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"top-headlines/"=>{"get"=>{"summary"=>"Top Headlines", "description"=>"This endpoint provides live top and breaking headlines for a country, specific category in a country, single source, or multiple sources. You can also search with keywords. Articles are sorted by the earliest date published first.", "operationId"=>"getTopHeadlines", "x-api-path-slug"=>"topheadlines-get", "parameters"=>[{"in"=>"header", "name"=>"apiKey", "description"=>"Your API key", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"category", "description"=>"Find sources that display news of this category", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Use this to page through the results", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The number of results to return per page", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"q", "description"=>"Keywords or phrases to search for", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"sources", "description"=>"A comma-seperated string of identifiers (maximum 20) for the news sources or blogs you want headlines from", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News"]}}, "everything/"=>{"get"=>{"summary"=>"Everything", "description"=>"Search through millions of articles from over 5,000 large and small news sources and blogs. This includes breaking news as well as lesser articles.", "operationId"=>"getEverything", "x-api-path-slug"=>"everything-get", "parameters"=>[{"in"=>"header", "name"=>"apiKey", "description"=>"Your API key", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"domains", "description"=>"A comma-seperated string of domains (eg bbc", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Use this to page through the results", "type"=>"integer", "format"=>"string"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The number of results to return per page", "type"=>"integer", "format"=>"string"}, {"in"=>"query", "name"=>"q", "description"=>"Keywords or phrases to search for", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"sources", "description"=>"A comma-seperated string of identifiers (maximum 20) for the news sources or blogs you want headlines from", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News"]}}, "sources/"=>{"get"=>{"summary"=>"Sources", "description"=>"This endpoint returns the subset of news publishers that top headlines (/v2/top-headlines) are available from. It's mainly a convenience endpoint that you can use to keep track of the publishers available on the API, and you can pipe it straight through to your users.", "operationId"=>"getsources", "x-api-path-slug"=>"sources-get", "parameters"=>[{"in"=>"header", "name"=>"apiKey", "description"=>"Your API key", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"category", "description"=>"Find sources that display news of this category", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"country", "description"=>"Find sources that display news in a specific country", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"language", "description"=>"Find sources that display news in a specific language", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News"]}}}}, "apis"=>{"name"=>"News API", "x-slug"=>"news-api", "description"=>"Get live article metadata from a range of sources including BBC News, TechCrunch, Huffington Post and more with our free News API.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/26590-news-api.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"120829", "tags"=>"API Provider,General Data,Media,News,Profiles,Publish,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"news-api/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"News API", "x-api-slug"=>"news-api", "description"=>"Get live article metadata from a range of sources including BBC News, TechCrunch, Huffington Post and more with our free News API.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/26590-news-api.jpg", "humanURL"=>"https://newsapi.org", "baseURL"=>"https://newsapi.org/v2/", "tags"=>"API Provider,General Data,Media,News,Profiles,Publish,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/news-api/news-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-email", "url"=>"support@newsapi.org"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/NewsAPIorg"}, {"type"=>"x-website", "url"=>"https://newsapi.org"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
baltimore-open311{"baltimore-open311-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Baltimore Open311", "x-complete"=>1, "info"=>{"title"=>"Open311 GeoReport API", "description"=>"open311-allows-you-to-getpost-civic-information-of-cities-via-a-unified-interface--the-georeport-part-allows-you-to-submit-and-view-issues-at-the-public-local-space", "termsOfService"=>"(depends on server instance for example NYC http://dev.cityofchicago.org/docs/api/tos)", "contact"=>{"name"=>"Open311 community", "url"=>"http://wiki.open311.org/GeoReport_v2/", "email"=>"discuss@lists.open311.org"}, "version"=>"1.0.0"}, "host"=>"311.baltimorecity.gov", "basePath"=>"/open311/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/requests.{response_format}"=>{"get"=>{"summary"=>"Requests", "description"=>"Query the current status of multiple requests.", "operationId"=>"query-the-current-status-of-multiple-requests", "x-api-path-slug"=>"requests-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"Latest datetime to include in search"}, {"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"service_code", "description"=>"Specify the service type by calling the unique ID of the service_code"}, {"in"=>"query", "name"=>"service_request_id", "description"=>"To call multiple Service Requests at once, multiple service_request_id can be declared; comma delimited"}, {"in"=>"query", "name"=>"start_date", "description"=>"Earliest datetime to include in search"}, {"in"=>"query", "name"=>"status", "description"=>"Allows one to search for requests which have a specific status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Requests"]}, "post"=>{"summary"=>"Create Service Request", "description"=>"Submit a new request for with specific details of a single service. Must provide a location via lat/long or address_string or address_id", "operationId"=>"submit-a-new-request-for-with-specific-details-of-a-single-service-must-provide-a-location-via-latlo", "x-api-path-slug"=>"requests-response-format-post", "parameters"=>[{"in"=>"query", "name"=>"address_id"}, {"in"=>"query", "name"=>"address_string"}, {"in"=>"query", "name"=>"attribute", "description"=>"array of key/value responses based on Service Definitions"}, {"in"=>"query", "name"=>"lat", "description"=>"WGS-84 latitude"}, {"in"=>"query", "name"=>"long", "description"=>"WGS-84 longitude"}, {"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"service_code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Service", "Request"]}}, "/request/{service_request_id}.{response_format}"=>{"get"=>{"summary"=>"Current Status", "description"=>"Query the current status of an individual request", "operationId"=>"query-the-current-status-of-an-individual-request", "x-api-path-slug"=>"requestservice-request-id-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"service_request_id", "description"=>"Is specified in the main URL path rather than an added query string parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Current", "Status"]}}, "/services.{response_format}"=>{"get"=>{"summary"=>"Service Types", "description"=>"List acceptable service request types and their associated service codes. These request types can be unique to the city/jurisdiction.", "operationId"=>"list-acceptable-service-request-types-and-their-associated-service-codes-these-request-types-can-be-", "x-api-path-slug"=>"services-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Service", "Types"]}}, "/services/{service_code}.{response_format}"=>{"get"=>{"summary"=>"(extended) Definition Of A Service Type", "description"=>"Define attributes associated with a service code. These attributes can be unique to the city/jurisdiction.", "operationId"=>"define-attributes-associated-with-a-service-code-these-attributes-can-be-unique-to-the-cityjurisdict", "x-api-path-slug"=>"servicesservice-code-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"service_code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "(extended)", "Definition", "Service", "Type"]}}, "/tokens/{token_id}.{response_format}"=>{"get"=>{"summary"=>"Id Of Service_request Via Token", "description"=>"Get the service_request_id from a temporary token. This is unnecessary if the response from creating a service request does not contain a token.", "operationId"=>"get-the-service-request-id-from-a-temporary-token-this-is-unnecessary-if-the-response-from-creating-", "x-api-path-slug"=>"tokenstoken-id-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"token_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Id", "Service", "Request", "Via", "Token"]}}}}, "apis"=>{"name"=>"Baltimore Open311", "x-slug"=>"baltimore-open311", "description"=>"Baltimore 311 helps residents make their neighborhoods more beautiful by reporting local issues including potholes, graffiti, and streetlight outages. Residents can track the status of reports they or other members of the community have submitted", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/baltimore311-logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"311,API Provider,Government,Open311,Profiles,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"baltimore-open311/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Baltimore Open311", "x-api-slug"=>"baltimore-open311", "description"=>"Baltimore 311 helps residents make their neighborhoods more beautiful by reporting local issues including potholes, graffiti, and streetlight outages. Residents can track the status of reports they or other members of the community have submitted", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/baltimore311-logo.png", "humanURL"=>"http://wiki.open311.org/GeoReport_v2/Servers", "baseURL"=>"http://311.baltimorecity.gov//open311/v2/", "tags"=>"311,API Provider,Government,Open311,Profiles,Streams,Streams", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/baltimore-open311/tokenstoken-id-response-format-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/baltimore-open311/baltimore-open311-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://wiki.open311.org/GeoReport_v2/Servers"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-simple-email-service{"aws-simple-email-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Simple Email Service", "x-complete"=>1, "info"=>{"title"=>"AWS Simple Email Service API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=CloneReceiptRuleSet"=>{"get"=>{"summary"=>"Clone Receipt Rule Set", "description"=>"Creates a receipt rule set by cloning an existing one.", "operationId"=>"cloneReceiptRuleSet", "x-api-path-slug"=>"actionclonereceiptruleset-get", "parameters"=>[{"in"=>"query", "name"=>"OriginalRuleSetName", "description"=>"The name of the rule set to clone", "type"=>"string"}, {"in"=>"query", "name"=>"RuleSetName", "description"=>"The name of the rule set to create", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipt Rule Sets"]}}, "/?Action=CreateConfigurationSet"=>{"get"=>{"summary"=>"Create Configuration Set", "description"=>"Creates a configuration set.", "operationId"=>"createConfigurationSet", "x-api-path-slug"=>"actioncreateconfigurationset-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigurationSet", "description"=>"A data structure that contains the name of the configuration set", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Sets"]}}, "/?Action=CreateConfigurationSetEventDestination"=>{"get"=>{"summary"=>"Create Configuration Set Event Destination", "description"=>"Creates a configuration set event destination.", "operationId"=>"createConfigurationSetEventDestination", "x-api-path-slug"=>"actioncreateconfigurationseteventdestination-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigurationSetName", "description"=>"The name of the configuration set to which to apply the event destination", "type"=>"string"}, {"in"=>"query", "name"=>"EventDestination", "description"=>"An object that describes the AWS service to which Amazon SES will publish the email sending events associated with the specified configuration set", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Set Event Destination"]}}, "/?Action=CreateReceiptFilter"=>{"get"=>{"summary"=>"Create Receipt Filter", "description"=>"Creates a new IP address filter.", "operationId"=>"createReceiptFilter", "x-api-path-slug"=>"actioncreatereceiptfilter-get", "parameters"=>[{"in"=>"query", "name"=>"Filter", "description"=>"A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipt Filters"]}}, "/?Action=CreateReceiptRule"=>{"get"=>{"summary"=>"Create Receipt Rule", "description"=>"Creates a receipt rule.", "operationId"=>"createReceiptRule", "x-api-path-slug"=>"actioncreatereceiptrule-get", "parameters"=>[{"in"=>"query", "name"=>"After", "description"=>"The name of an existing rule after which the new rule will be placed", "type"=>"string"}, {"in"=>"query", "name"=>"Rule", "description"=>"A data structure that contains the specified rules name, actions, recipients, domains, enabled status, scan status, and TLS policy", "type"=>"string"}, {"in"=>"query", "name"=>"RuleSetName", "description"=>"The name of the rule set to which to add the rule", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipt Rules"]}}, "/?Action=CreateReceiptRuleSet"=>{"get"=>{"summary"=>"Create Receipt Rule Set", "description"=>"Creates an empty receipt rule set.", "operationId"=>"createReceiptRuleSet", "x-api-path-slug"=>"actioncreatereceiptruleset-get", "parameters"=>[{"in"=>"query", "name"=>"RuleSetName", "description"=>"The name of the rule set to create", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipt Rule Sets"]}}, "/?Action=DeleteConfigurationSet"=>{"get"=>{"summary"=>"Delete Configuration Set", "description"=>"Deletes a configuration set.", "operationId"=>"deleteConfigurationSet", "x-api-path-slug"=>"actiondeleteconfigurationset-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigurationSetName", "description"=>"The name of the configuration set to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Sets"]}}, "/?Action=DeleteConfigurationSetEventDestination"=>{"get"=>{"summary"=>"Delete Configuration Set Event Destination", "description"=>"Deletes a configuration set event destination.", "operationId"=>"deleteConfigurationSetEventDestination", "x-api-path-slug"=>"actiondeleteconfigurationseteventdestination-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigurationSetName", "description"=>"The name of the configuration set from which to delete the event destination", "type"=>"string"}, {"in"=>"query", "name"=>"EventDestinationName", "description"=>"The name of the event destination to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Set Event Destination"]}}, "/?Action=DeleteIdentity"=>{"get"=>{"summary"=>"Delete Identity", "description"=>"Deletes the specified identity (an email address or a domain) from the list of verified identities.", "operationId"=>"deleteIdentity", "x-api-path-slug"=>"actiondeleteidentity-get", "parameters"=>[{"in"=>"query", "name"=>"Identity", "description"=>"The identity to be removed from the list of identities for the AWS Account", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=DeleteIdentityPolicy"=>{"get"=>{"summary"=>"Delete Identity Policy", "description"=>"Deletes the specified sending authorization policy for the given identity (an email address or a domain).", "operationId"=>"deleteIdentityPolicy", "x-api-path-slug"=>"actiondeleteidentitypolicy-get", "parameters"=>[{"in"=>"query", "name"=>"Identity", "description"=>"The identity that is associated with the policy that you want to delete", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyName", "description"=>"The name of the policy to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=DeleteReceiptFilter"=>{"get"=>{"summary"=>"Delete Receipt Filter", "description"=>"Deletes the specified IP address filter.", "operationId"=>"deleteReceiptFilter", "x-api-path-slug"=>"actiondeletereceiptfilter-get", "parameters"=>[{"in"=>"query", "name"=>"FilterName", "description"=>"The name of the IP address filter to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipt Filters"]}}, "/?Action=DeleteReceiptRule"=>{"get"=>{"summary"=>"Delete Receipt Rule", "description"=>"Deletes the specified receipt rule.", "operationId"=>"deleteReceiptRule", "x-api-path-slug"=>"actiondeletereceiptrule-get", "parameters"=>[{"in"=>"query", "name"=>"RuleName", "description"=>"The name of the receipt rule to delete", "type"=>"string"}, {"in"=>"query", "name"=>"RuleSetName", "description"=>"The name of the receipt rule set that contains the receipt rule to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipt Rules"]}}, "/?Action=DeleteReceiptRuleSet"=>{"get"=>{"summary"=>"Delete Receipt Rule Set", "description"=>"Deletes the specified receipt rule set and all of the receipt rules it contains.", "operationId"=>"deleteReceiptRuleSet", "x-api-path-slug"=>"actiondeletereceiptruleset-get", "parameters"=>[{"in"=>"query", "name"=>"RuleSetName", "description"=>"The name of the receipt rule set to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipt Rule Sets"]}}, "/?Action=DeleteVerifiedEmailAddress"=>{"get"=>{"summary"=>"Delete Verified Email Address", "description"=>"Deletes the specified email address from the list of verified addresses.", "operationId"=>"deleteVerifiedEmailAddress", "x-api-path-slug"=>"actiondeleteverifiedemailaddress-get", "parameters"=>[{"in"=>"query", "name"=>"EmailAddress", "description"=>"An email address to be removed from the list of verified addresses", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Verified Email Addresses"]}}, "/?Action=DescribeActiveReceiptRuleSet"=>{"get"=>{"summary"=>"Describe Active Receipt Rule Set", "description"=>"Returns the metadata and receipt rules for the receipt rule set that is currently active.", "operationId"=>"describeActiveReceiptRuleSet", "x-api-path-slug"=>"actiondescribeactivereceiptruleset-get", "parameters"=>[{"in"=>"query", "name"=>"Metadata", "description"=>"The metadata for the currently active receipt rule set", "type"=>"string"}, {"in"=>"query", "name"=>"Rules.member.N", "description"=>"The receipt rules that belong to the active rule set", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipt Rule Sets"]}}, "/?Action=DescribeConfigurationSet"=>{"get"=>{"summary"=>"Describe Configuration Set", "description"=>"Returns the details of the specified configuration set.", "operationId"=>"describeConfigurationSet", "x-api-path-slug"=>"actiondescribeconfigurationset-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigurationSetAttributeNames.member.N", "description"=>"A list of configuration set attributes to return", "type"=>"string"}, {"in"=>"query", "name"=>"ConfigurationSetName", "description"=>"The name of the configuration set to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Sets"]}}, "/?Action=DescribeReceiptRule"=>{"get"=>{"summary"=>"Describe Receipt Rule", "description"=>"Returns the details of the specified receipt rule.", "operationId"=>"describeReceiptRule", "x-api-path-slug"=>"actiondescribereceiptrule-get", "parameters"=>[{"in"=>"query", "name"=>"RuleName", "description"=>"The name of the receipt rule", "type"=>"string"}, {"in"=>"query", "name"=>"RuleSetName", "description"=>"The name of the receipt rule set to which the receipt rule belongs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipt Rules"]}}, "/?Action=DescribeReceiptRuleSet"=>{"get"=>{"summary"=>"Describe Receipt Rule Set", "description"=>"Returns the details of the specified receipt rule set.", "operationId"=>"describeReceiptRuleSet", "x-api-path-slug"=>"actiondescribereceiptruleset-get", "parameters"=>[{"in"=>"query", "name"=>"RuleSetName", "description"=>"The name of the receipt rule set to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipt Rule Sets"]}}, "/?Action=GetIdentityDkimAttributes"=>{"get"=>{"summary"=>"Get Identity Dkim Attributes", "description"=>"Returns the current status of Easy DKIM signing for an entity.", "operationId"=>"getIdentityDkimAttributes", "x-api-path-slug"=>"actiongetidentitydkimattributes-get", "parameters"=>[{"in"=>"query", "name"=>"Identities.member.N", "description"=>"A list of one or more verified identities - email addresses, domains, or both", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=GetIdentityMailFromDomainAttributes"=>{"get"=>{"summary"=>"Get Identity Mail From Domain Attributes", "description"=>"Returns the custom MAIL FROM attributes for a list of identities (email addresses and/or domains).", "operationId"=>"getIdentityMailFromDomainAttributes", "x-api-path-slug"=>"actiongetidentitymailfromdomainattributes-get", "parameters"=>[{"in"=>"query", "name"=>"Identities.member.N", "description"=>"A list of one or more identities", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=GetIdentityNotificationAttributes"=>{"get"=>{"summary"=>"Get Identity Notification Attributes", "description"=>"Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.", "operationId"=>"getIdentityNotificationAttributes", "x-api-path-slug"=>"actiongetidentitynotificationattributes-get", "parameters"=>[{"in"=>"query", "name"=>"Identities.member.N", "description"=>"A list of one or more identities", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=GetIdentityPolicies"=>{"get"=>{"summary"=>"Get Identity Policies", "description"=>"Returns the requested sending authorization policies for the given identity (an email address or a domain).", "operationId"=>"getIdentityPolicies", "x-api-path-slug"=>"actiongetidentitypolicies-get", "parameters"=>[{"in"=>"query", "name"=>"Identity", "description"=>"The identity for which the policies will be retrieved", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyNames.member.N", "description"=>"A list of the names of policies to be retrieved", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=GetIdentityVerificationAttributes"=>{"get"=>{"summary"=>"Get Identity Verification Attributes", "description"=>"Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.", "operationId"=>"getIdentityVerificationAttributes", "x-api-path-slug"=>"actiongetidentityverificationattributes-get", "parameters"=>[{"in"=>"query", "name"=>"Identities.member.N", "description"=>"A list of identities", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=GetSendQuota"=>{"get"=>{"summary"=>"Get Send Quota", "description"=>"Returns the user's current sending limits.", "operationId"=>"getSendQuota", "x-api-path-slug"=>"actiongetsendquota-get", "parameters"=>[{"in"=>"query", "name"=>"Max24HourSend", "description"=>"The maximum number of emails the user is allowed to send in a 24-hour interval", "type"=>"string"}, {"in"=>"query", "name"=>"MaxSendRate", "description"=>"The maximum number of emails that Amazon SES can accept from the users account per second", "type"=>"string"}, {"in"=>"query", "name"=>"SentLast24Hours", "description"=>"The number of emails sent during the previous 24 hours", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send Quota"]}}, "/?Action=GetSendStatistics"=>{"get"=>{"summary"=>"Get Send Statistics", "description"=>"Returns the user's sending statistics.", "operationId"=>"getSendStatistics", "x-api-path-slug"=>"actiongetsendstatistics-get", "parameters"=>[{"in"=>"query", "name"=>"SendDataPoints.member.N", "description"=>"A list of data points, each of which represents 15 minutes of activity", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send Statistics"]}}, "/?Action=ListConfigurationSets"=>{"get"=>{"summary"=>"List Configuration Sets", "description"=>"Lists the configuration sets associated with your AWS account.", "operationId"=>"listConfigurationSets", "x-api-path-slug"=>"actionlistconfigurationsets-get", "parameters"=>[{"in"=>"query", "name"=>"MaxItems", "description"=>"The number of configuration sets to return", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"A token returned from a previous call to ListConfigurationSets to indicate the position of the configuration set in the configuration set list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Sets"]}}, "/?Action=ListIdentities"=>{"get"=>{"summary"=>"List Identities", "description"=>"Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.", "operationId"=>"listIdentities", "x-api-path-slug"=>"actionlistidentities-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityType", "description"=>"The type of the identities to list", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"The maximum number of identities per page", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to use for pagination", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=ListIdentityPolicies"=>{"get"=>{"summary"=>"List Identity Policies", "description"=>"Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain).", "operationId"=>"listIdentityPolicies", "x-api-path-slug"=>"actionlistidentitypolicies-get", "parameters"=>[{"in"=>"query", "name"=>"Identity", "description"=>"The identity that is associated with the policy for which the policies will be listed", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=ListReceiptFilters"=>{"get"=>{"summary"=>"List Receipt Filters", "description"=>"Lists the IP address filters associated with your AWS account.", "operationId"=>"listReceiptFilters", "x-api-path-slug"=>"actionlistreceiptfilters-get", "parameters"=>[{"in"=>"query", "name"=>"Filters.member.N", "description"=>"A list of IP address filter data structures, which each consist of a name, an IP address range, and whether to allow or block mail from it", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipt Filters"]}}, "/?Action=ListReceiptRuleSets"=>{"get"=>{"summary"=>"List Receipt Rule Sets", "description"=>"Lists the receipt rule sets that exist under your AWS account.", "operationId"=>"listReceiptRuleSets", "x-api-path-slug"=>"actionlistreceiptrulesets-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"A token returned from a previous call to ListReceiptRuleSets to indicate the position in the receipt rule set list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipt Rule Sets"]}}, "/?Action=ListVerifiedEmailAddresses"=>{"get"=>{"summary"=>"List Verified Email Addresses", "description"=>"Returns a list containing all of the email addresses that have been verified.", "operationId"=>"listVerifiedEmailAddresses", "x-api-path-slug"=>"actionlistverifiedemailaddresses-get", "parameters"=>[{"in"=>"query", "name"=>"VerifiedEmailAddresses.member.N", "description"=>"A list of email addresses that have been verified", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Verified Email Addresses"]}}, "/?Action=PutIdentityPolicy"=>{"get"=>{"summary"=>"Put Identity Policy", "description"=>"Adds or updates a sending authorization policy for the specified identity (an email address or a domain).", "operationId"=>"putIdentityPolicy", "x-api-path-slug"=>"actionputidentitypolicy-get", "parameters"=>[{"in"=>"query", "name"=>"Identity", "description"=>"The identity to which the policy will apply", "type"=>"string"}, {"in"=>"query", "name"=>"Policy", "description"=>"The text of the policy in JSON format", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyName", "description"=>"The name of the policy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=ReorderReceiptRuleSet"=>{"get"=>{"summary"=>"Reorder Receipt Rule Set", "description"=>"Reorders the receipt rules within a receipt rule set.", "operationId"=>"reorderReceiptRuleSet", "x-api-path-slug"=>"actionreorderreceiptruleset-get", "parameters"=>[{"in"=>"query", "name"=>"RuleNames.member.N", "description"=>"A list of the specified receipt rule sets receipt rules in the order that you want to put them", "type"=>"string"}, {"in"=>"query", "name"=>"RuleSetName", "description"=>"The name of the receipt rule set to reorder", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipt Rule Sets"]}}, "/?Action=SendBounce"=>{"get"=>{"summary"=>"Send Bounce", "description"=>"Generates and sends a bounce message to the sender of an email you received through Amazon SES.", "operationId"=>"sendBounce", "x-api-path-slug"=>"actionsendbounce-get", "parameters"=>[{"in"=>"query", "name"=>"BouncedRecipientInfoList.member.N", "description"=>"A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients", "type"=>"string"}, {"in"=>"query", "name"=>"BounceSender", "description"=>"The address to use in the From header of the bounce message", "type"=>"string"}, {"in"=>"query", "name"=>"BounceSenderArn", "description"=>"This parameter is used only for sending authorization", "type"=>"string"}, {"in"=>"query", "name"=>"Explanation", "description"=>"Human-readable text for the bounce message to explain the failure", "type"=>"string"}, {"in"=>"query", "name"=>"MessageDsn", "description"=>"Message-related DSN fields", "type"=>"string"}, {"in"=>"query", "name"=>"OriginalMessageId", "description"=>"The message ID of the message to be bounced", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bounce"]}}, "/?Action=SendEmail"=>{"get"=>{"summary"=>"Send Email", "description"=>"Composes an email message based on input data, and then immediately queues the message for sending.", "operationId"=>"sendEmail", "x-api-path-slug"=>"actionsendemail-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigurationSetName", "description"=>"The name of the configuration set to use when you send an email using SendEmail", "type"=>"string"}, {"in"=>"query", "name"=>"Destination", "description"=>"The destination for this email, composed of To:, CC:, and BCC: fields", "type"=>"string"}, {"in"=>"query", "name"=>"Message", "description"=>"The message to be sent", "type"=>"string"}, {"in"=>"query", "name"=>"ReplyToAddresses.member.N", "description"=>"The reply-to email address(es) for the message", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnPath", "description"=>"The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnPathArn", "description"=>"This parameter is used only for sending authorization", "type"=>"string"}, {"in"=>"query", "name"=>"Source", "description"=>"The email address that is sending the email", "type"=>"string"}, {"in"=>"query", "name"=>"SourceArn", "description"=>"This parameter is used only for sending authorization", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.member.N", "description"=>"A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}}, "/?Action=SendRawEmail"=>{"get"=>{"summary"=>"Send Raw Email", "description"=>"Sends an email message, with header and content specified by the client.", "operationId"=>"sendRawEmail", "x-api-path-slug"=>"actionsendrawemail-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigurationSetName", "description"=>"The name of the configuration set to use when you send an email using SendRawEmail", "type"=>"string"}, {"in"=>"query", "name"=>"Destinations.member.N", "description"=>"A list of destinations for the message, consisting of To:, CC:, and BCC: addresses", "type"=>"string"}, {"in"=>"query", "name"=>"FromArn", "description"=>"This parameter is used only for sending authorization", "type"=>"string"}, {"in"=>"query", "name"=>"RawMessage", "description"=>"The raw text of the message", "type"=>"string"}, {"in"=>"query", "name"=>"ReturnPathArn", "description"=>"This parameter is used only for sending authorization", "type"=>"string"}, {"in"=>"query", "name"=>"Source", "description"=>"The identitys email address", "type"=>"string"}, {"in"=>"query", "name"=>"SourceArn", "description"=>"This parameter is used only for sending authorization", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.member.N", "description"=>"A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}}, "/?Action=SetActiveReceiptRuleSet"=>{"get"=>{"summary"=>"Set Active Receipt Rule Set", "description"=>"Sets the specified receipt rule set as the active receipt rule set.", "operationId"=>"setActiveReceiptRuleSet", "x-api-path-slug"=>"actionsetactivereceiptruleset-get", "parameters"=>[{"in"=>"query", "name"=>"RuleSetName", "description"=>"The name of the receipt rule set to make active", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipt Rule Sets"]}}, "/?Action=SetIdentityDkimEnabled"=>{"get"=>{"summary"=>"Set Identity Dkim Enabled", "description"=>"Enables or disables Easy DKIM signing of email sent from an identity:If Easy DKIM\n signing is enabled for a domain name identity (e.", "operationId"=>"setIdentityDkimEnabled", "x-api-path-slug"=>"actionsetidentitydkimenabled-get", "parameters"=>[{"in"=>"query", "name"=>"DkimEnabled", "description"=>"Sets whether DKIM signing is enabled for an identity", "type"=>"string"}, {"in"=>"query", "name"=>"Identity", "description"=>"The identity for which DKIM signing should be enabled or disabled", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=SetIdentityFeedbackForwardingEnabled"=>{"get"=>{"summary"=>"Set Identity Feedback Forwarding Enabled", "description"=>"Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email.", "operationId"=>"setIdentityFeedbackForwardingEnabled", "x-api-path-slug"=>"actionsetidentityfeedbackforwardingenabled-get", "parameters"=>[{"in"=>"query", "name"=>"ForwardingEnabled", "description"=>"Sets whether Amazon SES will forward bounce and complaint notifications as email", "type"=>"string"}, {"in"=>"query", "name"=>"Identity", "description"=>"The identity for which to set bounce and complaint notification forwarding", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=SetIdentityHeadersInNotificationsEnabled"=>{"get"=>{"summary"=>"Set Identity Headers In Notifications Enabled", "description"=>"Given an identity (an email address or a domain), sets whether Amazon SES includes \n the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications \n of a specified type.", "operationId"=>"setIdentityHeadersInNotificationsEnabled", "x-api-path-slug"=>"actionsetidentityheadersinnotificationsenabled-get", "parameters"=>[{"in"=>"query", "name"=>"Enabled", "description"=>"Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type", "type"=>"string"}, {"in"=>"query", "name"=>"Identity", "description"=>"The identity for which to enable or disable headers in notifications", "type"=>"string"}, {"in"=>"query", "name"=>"NotificationType", "description"=>"The notification type for which to enable or disable headers in notifications", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=SetIdentityMailFromDomain"=>{"get"=>{"summary"=>"Set Identity Mail From Domain", "description"=>"Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).", "operationId"=>"setIdentityMailFromDomain", "x-api-path-slug"=>"actionsetidentitymailfromdomain-get", "parameters"=>[{"in"=>"query", "name"=>"BehaviorOnMXFailure", "description"=>"The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email", "type"=>"string"}, {"in"=>"query", "name"=>"Identity", "description"=>"The verified identity for which you want to enable or disable the specified custom MAIL FROM domain", "type"=>"string"}, {"in"=>"query", "name"=>"MailFromDomain", "description"=>"The custom MAIL FROM domain that you want the verified identity to use", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=SetIdentityNotificationTopic"=>{"get"=>{"summary"=>"Set Identity Notification Topic", "description"=>"Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish\n bounce, complaint, and/or delivery notifications for emails sent with that identity as the Source.", "operationId"=>"setIdentityNotificationTopic", "x-api-path-slug"=>"actionsetidentitynotificationtopic-get", "parameters"=>[{"in"=>"query", "name"=>"Identity", "description"=>"The identity for which the Amazon SNS topic will be set", "type"=>"string"}, {"in"=>"query", "name"=>"NotificationType", "description"=>"The type of notifications that will be published to the specified Amazon SNS topic", "type"=>"string"}, {"in"=>"query", "name"=>"SnsTopic", "description"=>"The Amazon Resource Name (ARN) of the Amazon SNS topic", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=SetReceiptRulePosition"=>{"get"=>{"summary"=>"Set Receipt Rule Position", "description"=>"Sets the position of the specified receipt rule in the receipt rule set.", "operationId"=>"setReceiptRulePosition", "x-api-path-slug"=>"actionsetreceiptruleposition-get", "parameters"=>[{"in"=>"query", "name"=>"After", "description"=>"The name of the receipt rule after which to place the specified receipt rule", "type"=>"string"}, {"in"=>"query", "name"=>"RuleName", "description"=>"The name of the receipt rule to reposition", "type"=>"string"}, {"in"=>"query", "name"=>"RuleSetName", "description"=>"The name of the receipt rule set that contains the receipt rule to reposition", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipt Rules"]}}, "/?Action=UpdateConfigurationSetEventDestination"=>{"get"=>{"summary"=>"Update Configuration Set Event Destination", "description"=>"Updates the event destination of a configuration set.", "operationId"=>"updateConfigurationSetEventDestination", "x-api-path-slug"=>"actionupdateconfigurationseteventdestination-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigurationSetName", "description"=>"The name of the configuration set that you want to update", "type"=>"string"}, {"in"=>"query", "name"=>"EventDestination", "description"=>"The event destination object that you want to apply to the specified configuration set", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Set Event Destination"]}}, "/?Action=UpdateReceiptRule"=>{"get"=>{"summary"=>"Update Receipt Rule", "description"=>"Updates a receipt rule.", "operationId"=>"updateReceiptRule", "x-api-path-slug"=>"actionupdatereceiptrule-get", "parameters"=>[{"in"=>"query", "name"=>"Rule", "description"=>"A data structure that contains the updated receipt rule information", "type"=>"string"}, {"in"=>"query", "name"=>"RuleSetName", "description"=>"The name of the receipt rule set to which the receipt rule belongs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipt Rule s"]}}, "/?Action=VerifyDomainDkim"=>{"get"=>{"summary"=>"Verify Domain Dkim", "description"=>"Returns a set of DKIM tokens for a domain.", "operationId"=>"verifyDomainDkim", "x-api-path-slug"=>"actionverifydomaindkim-get", "parameters"=>[{"in"=>"query", "name"=>"Domain", "description"=>"The name of the domain to be verified for Easy DKIM signing", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/?Action=VerifyDomainIdentity"=>{"get"=>{"summary"=>"Verify Domain Identity", "description"=>"Verifies a domain.", "operationId"=>"verifyDomainIdentity", "x-api-path-slug"=>"actionverifydomainidentity-get", "parameters"=>[{"in"=>"query", "name"=>"Domain", "description"=>"The domain to be verified", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=VerifyEmailAddress"=>{"get"=>{"summary"=>"Verify Email Address", "description"=>"Verifies an email address.", "operationId"=>"verifyEmailAddress", "x-api-path-slug"=>"actionverifyemailaddress-get", "parameters"=>[{"in"=>"query", "name"=>"EmailAddress", "description"=>"The email address to be verified", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email Addresses"]}}, "/?Action=VerifyEmailIdentity"=>{"get"=>{"summary"=>"Verify Email Identity", "description"=>"Verifies an email address.", "operationId"=>"verifyEmailIdentity", "x-api-path-slug"=>"actionverifyemailidentity-get", "parameters"=>[{"in"=>"query", "name"=>"EmailAddress", "description"=>"The email address to be verified", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}}}, "apis"=>{"name"=>"AWS Simple Email Service", "x-slug"=>"aws-simple-email-service", "description"=>"Amazon Simple Email Service (Amazon SES) is a cost-effective email service built on the reliable and scalable infrastructure that Amazon.com developed to serve its own customer base. With Amazon SES, you can send and receive email with no required minimum commitments – you pay as you go, and you only pay for what you use.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Application-Services_AmazonSES.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Emails,Messages,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-simple-email-service/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Simple Email Service API", "x-api-slug"=>"aws-simple-email-service-api", "description"=>"Amazon Simple Email Service (Amazon SES) is a cost-effective email service built on the reliable and scalable infrastructure that Amazon.com developed to serve its own customer base. With Amazon SES, you can send and receive email with no required minimum commitments – you pay as you go, and you only pay for what you use.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Application-Services_AmazonSES.png", "humanURL"=>"https://aws.amazon.com/ses/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Emails,Messages,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-simple-email-service/actionverifyemailidentity-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-simple-email-service/aws-simple-email-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-log", "url"=>"http://aws.amazon.com/releasenotes/Amazon-SES"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/ses/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/ses/faqs/"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=90"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/ses/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/ses/pricing/"}, {"type"=>"x-sdk", "url"=>"http://aws.amazon.com/tools"}, {"type"=>"x-service-health", "url"=>"http://status.aws.amazon.com/"}, {"type"=>"x-tools", "url"=>"http://aws.amazon.com/developertools/Amazon-SES"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/ses/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| pingdom{"credits-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Pingdom", "x-complete"=>1, "info"=>{"title"=>"Credits API", "description"=>"the-credits-api-", "version"=>"1.0.0"}, "host"=>"api.pingdom.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"\n /api/{version}/credits"=>{"\n get"=>{"summary"=>"Get Credits List", "description"=>"Returns information about remaining checks, SMS credits and SMS auto-refill status.", "operationId"=>"get-credits-list", "x-api-path-slug"=>"apiversioncredits-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Credits"]}}}}, "settings-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Pingdom", "x-complete"=>1, "info"=>{"title"=>"Settings API", "description"=>"the-settings-api-", "version"=>"1.0.0"}, "host"=>"api.pingdom.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"\n /api/{version}/settings"=>{"\n get"=>{"summary"=>"Get Account Settings", "description"=>"Returns all account-specific settings.", "operationId"=>"get-account-settings", "x-api-path-slug"=>"apiversionsettings-get", "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}}, "tags"=>["Settings"]}}}}, "single-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Pingdom", "x-complete"=>1, "info"=>{"title"=>"Single API", "description"=>"the-single-api-", "version"=>"1.0.0"}, "host"=>"api.pingdom.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"\n /api/{version}/single"=>{"\n get"=>{"summary"=>"Make A Single Test", "description"=>"Performs a single test using a specified Pingdom probe against a specified target. Please note that this method is meant to be used sparingly, not to set up your own monitoring solution.", "operationId"=>"make-a-single-test", "x-api-path-slug"=>"apiversionsingle-get", "parameters"=>[{"in"=>"query", "name"=>"host", "description"=>"Target host", "type"=>" | string | "}, {"in"=>"query", "name"=>"ipv6", "description"=>"Use ipv6 instead of ipv4", "type"=>"boolean | "}, {"in"=>"query", "name"=>"probeid", "description"=>"Probe identifier", "type"=>"integer | "}, {"in"=>"query", "name"=>"type", "description"=>"Type of test", "type"=>"string (http, httpcustom, tcp, ping, dns,"}], "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}, 200=>{"description"=>"OK"}}, "tags"=>["Single"]}}}}, "reference-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Pingdom", "x-complete"=>1, "info"=>{"title"=>"Reference API", "description"=>"the-reference-api-", "version"=>"1.0.0"}, "host"=>"api.pingdom.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"\n /api/{version}/reference"=>{"\n get"=>{"summary"=>"Get Reference", "description"=>"Get a reference of regions, timezones and date/time/number formats and their identifiers.", "operationId"=>"get-reference", "x-api-path-slug"=>"apiversionreference-get", "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}}, "tags"=>["Reerence"]}}}}, "reports-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Pingdom", "x-complete"=>1, "info"=>{"title"=>"Reports API", "description"=>"the-reports-api-", "version"=>"1.0.0"}, "host"=>"api.pingdom.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"\n /api/{version}/reports.email"=>{"\n get"=>{"summary"=>"Get Email Report Subscription List", "description"=>"Returns a list of email report subscriptions.", "operationId"=>"get-email-report-subscription-list", "x-api-path-slug"=>"apiversionreports-email-get", "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}}, "tags"=>["Reports"]}}, "\n /api/{version}/reports.public"=>{"\n get"=>{"summary"=>"Get Public Report List", "description"=>"Returns a list of public (web-based) reports.", "operationId"=>"get-public-report-list", "x-api-path-slug"=>"apiversionreports-public-get", "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}}, "tags"=>["Reports"]}}, "\n /api/{version}/reports.shared"=>{"\n get"=>{"summary"=>"Get Shared Reports (Banners) List", "description"=>"Returns a list of shared reports (banners).", "operationId"=>"get-shared-reports-banners-list", "x-api-path-slug"=>"apiversionreports-shared-get", "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}}, "tags"=>["Reports"]}}}}, "servertime-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Pingdom", "x-complete"=>1, "info"=>{"title"=>"Servertime API", "description"=>"the-servertime-api-", "version"=>"1.0.0"}, "host"=>"api.pingdom.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"\n /api/{version}/servertime"=>{"\n get"=>{"summary"=>"Get Current Server Time", "description"=>"Get the current time of the API server.", "operationId"=>"get-current-server-time", "x-api-path-slug"=>"apiversionservertime-get", "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}}, "tags"=>["Servertime"]}}}}, "results-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Pingdom", "x-complete"=>1, "info"=>{"title"=>"Results API", "description"=>"the-results-api-", "version"=>"1.0.0"}, "host"=>"api.pingdom.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"\n /api/{version}/results/{checkid}"=>{"\n get"=>{"summary"=>"Get Raw Check Results", "description"=>"Return a list of raw test results for a specified check", "operationId"=>"get-raw-check-results", "x-api-path-slug"=>"apiversionresultscheckid-get", "parameters"=>[{"in"=>"query", "name"=>"from", "description"=>"Start of period", "type"=>" | integer | "}, {"in"=>"query", "name"=>"includeanalysis", "description"=>"Attach available root cause analysis identifiers to corresponding results", "type"=>"boolean | "}, {"in"=>"query", "name"=>"limit", "description"=>"Number of results to show (Will be set to 1000 if the provided value is greater than 1000)", "type"=>"integer | "}, {"in"=>"query", "name"=>"maxresponse", "description"=>"Maximum response time (ms)", "type"=>"integer | "}, {"in"=>"query", "name"=>"minresponse", "description"=>"Minimum response time (ms)", "type"=>"integer | "}, {"in"=>"query", "name"=>"offset", "description"=>"Number of results to skip (Max value is 43200)", "type"=>"integer | "}, {"in"=>"query", "name"=>"probes", "description"=>"Filter to only show results from a list of probes", "type"=>"string | "}, {"in"=>"query", "name"=>"status", "description"=>"Filter to only show results with specified statuses", "type"=>"string | "}, {"in"=>"query", "name"=>"to", "description"=>"End of period", "type"=>"integer | "}], "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}, 200=>{"description"=>"OK"}}, "tags"=>["Results"]}}}}, "checks-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Pingdom", "x-complete"=>1, "info"=>{"title"=>"Checks API", "description"=>"the-checks-api-", "version"=>"1.0.0"}, "host"=>"api.pingdom.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/checks "=>{" get "=>{"summary"=>"Get Checks", "description"=>"Gets a list of all checks that are visible to you as a user or a customer depending on the request context.", "operationId"=>"getChecks", "x-api-path-slug"=>"checks-get", "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}, 200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}, "/checks/{checkId} "=>{" get "=>{"summary"=>"Get Check", "description"=>"Gets info about a check, current SLA, last result and its status.", "operationId"=>"getChecksCheck", "x-api-path-slug"=>"checkscheckid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}, " put "=>{"summary"=>"Update Check", "description"=>"Updates a check.", "operationId"=>"putChecksCheck", "x-api-path-slug"=>"checkscheckid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}, " delete "=>{"summary"=>"Delete Check", "description"=>"Deletes a check.", "operationId"=>"deleteChecksCheck", "x-api-path-slug"=>"checkscheckid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}, "/checks/{checkId}/lastvalue "=>{" get "=>{"summary"=>"Get Checks Lastvalue", "description"=>"Gets the absolute last value of a specific check.", "operationId"=>"getChecksCheckLastvalue", "x-api-path-slug"=>"checkscheckidlastvalue-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}, "/checks/{checkId}/results/{millisecondsUtc}"=>{" get "=>{"summary"=>"Get Checks Results", "description"=>"Gets a specific check result by a numeric java timestamp.", "operationId"=>"getChecksCheckResultsMillisecondsutcDetailLevelDetailLevel", "x-api-path-slug"=>"checkscheckidresultsmillisecondsutc-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}, "/checks/{checkId}/results"=>{" get "=>{"summary"=>"Get Checks Results", "description"=>"Gets the most recent check results.", "operationId"=>"getChecksCheckResultsMostrecentMostrecent&detailLevelDetailLevel", "x-api-path-slug"=>"checkscheckidresults-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}, "\n /api/{version}/checks"=>{"\n get"=>{"summary"=>"Get Check List", "description"=>"Returns a list overview of all checks.", "operationId"=>"\ngetApiVersionChecks", "x-api-path-slug"=>"apiversionchecks-get", "parameters"=>[{"in"=>"query", "name"=>"include_tags", "description"=>"Include tag list for each check", "type"=>"boolean | "}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of returned probes to the specified quantity", "type"=>"integer | "}, {"in"=>"query", "name"=>"offset", "description"=>"Offset for listing", "type"=>"integer | "}, {"in"=>"query", "name"=>"tags", "description"=>"Tag list separated by commas", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}}}, "analysis-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Pingdom", "x-complete"=>1, "info"=>{"title"=>"Analysis API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"\n /api/{version}/analysis/{checkid}"=>{"\n get"=>{"summary"=>"Get Root Cause Analysis Results List", "description"=>"Returns a list of the latest root cause analysis results for a specified check.", "operationId"=>"get-root-cause-analysis-results-list", "x-api-path-slug"=>"apiversionanalysischeckid-get", "parameters"=>[{"in"=>"query", "name"=>"from", "description"=>"Return only results with timestamp of first test greater or equal to this value", "type"=>"integer | "}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of returned results to the specified quantity", "type"=>"integer | "}, {"in"=>"query", "name"=>"offset", "description"=>"Offset for listing", "type"=>"integer | "}, {"in"=>"query", "name"=>"to", "description"=>"Return only results with timestamp of first test less or equal to this value", "type"=>"integer | "}], "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}}, "tags"=>["Analysis"]}}}}, "traceroute-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Pingdom", "x-complete"=>1, "info"=>{"title"=>"Traceroute API", "description"=>"the-traceroute-api-", "version"=>"1.0.0"}, "host"=>"api.pingdom.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"\n /api/{version}/traceroute"=>{"\n get"=>{"summary"=>"Make A Traceroute", "description"=>"Perform a traceroute to a specified target from a specified Pingdom probe.", "operationId"=>"make-a-traceroute", "x-api-path-slug"=>"apiversiontraceroute-get", "parameters"=>[{"in"=>"query", "name"=>"host", "description"=>"Target host", "type"=>"string | "}, {"in"=>"query", "name"=>"probeid", "description"=>"Probe identifier", "type"=>"integer | "}], "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}, "apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Traceroute"]}}}}, "probes-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Pingdom", "x-complete"=>1, "info"=>{"title"=>"Probes API", "description"=>"the-probes-api-", "version"=>"1.0.0"}, "host"=>"api.pingdom.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"\n /api/{version}/probes"=>{"\n get"=>{"summary"=>"Get Probe Server List", "description"=>"Returns a list of all Pingdom probe servers for Uptime and Transaction checks.", "operationId"=>"get-probe-server-list", "x-api-path-slug"=>"apiversionprobes-get", "parameters"=>[{"in"=>"query", "name"=>"includedeleted", "description"=>"Include old probes that are no longer in use", "type"=>"boolean | "}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of returned probes to the specified quantity", "type"=>"integer | "}, {"in"=>"query", "name"=>"offset", "description"=>"Offset for listing", "type"=>"integer | "}, {"in"=>"query", "name"=>"onlyactive", "description"=>"Return only active probes", "type"=>"boolean | "}], "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}}, "tags"=>["Proves"]}}}}, "summary-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Pingdom", "x-complete"=>1, "info"=>{"title"=>"Summary API", "description"=>"the-summary-api-", "version"=>"1.0.0"}, "host"=>"api.pingdom.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"\n /api/{version}/summary.average/{checkid}"=>{"\n get"=>{"summary"=>"Get A Response Time / Uptime Average", "description"=>"Get the average time / uptime value for a specified check and time period.", "operationId"=>"get-a-response-time--uptime-average", "x-api-path-slug"=>"apiversionsummary-averagecheckid-get", "parameters"=>[{"in"=>"query", "name"=>"bycountry", "description"=>"Split response times into country groups", "type"=>"boolean | "}, {"in"=>"query", "name"=>"byprobe", "description"=>"Split response times into probe groups", "type"=>"boolean | "}, {"in"=>"query", "name"=>"from", "description"=>"Start time of period", "type"=>"integer | "}, {"in"=>"query", "name"=>"includeuptime", "description"=>"Include uptime information", "type"=>"boolean | "}, {"in"=>"query", "name"=>"probes", "description"=>"Filter to only use results from a list of probes", "type"=>"string | "}, {"in"=>"query", "name"=>"to", "description"=>"End time of period", "type"=>"integer | "}], "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}}, "tags"=>["Summary"]}}, "\n /api/{version}/summary.hoursofday/{checkid}"=>{"\n get"=>{"summary"=>"Get Response Time Averages For Each Hour Of The Day", "description"=>"Returns the average response time for each hour of the day (0-23) for a specific check over a selected time period. I.e. it shows you what an average day looks like during that time period.", "operationId"=>"get-response-time-averages-for-each-hour-of-the-day", "x-api-path-slug"=>"apiversionsummary-hoursofdaycheckid-get", "parameters"=>[{"in"=>"query", "name"=>"from", "description"=>"Start time of period", "type"=>"integer | "}, {"in"=>"query", "name"=>"probes", "description"=>"Filter to only use results from a list of probes", "type"=>"string | "}, {"in"=>"query", "name"=>"to", "description"=>"End time of period", "type"=>"integer | "}, {"in"=>"query", "name"=>"uselocaltime", "description"=>"If true, use the users local time zone for results (from and to parameters should still be specified in UTC)", "type"=>"boolean | "}], "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}}, "tags"=>["Summary"]}}, "\n /api/{version}/summary.outage/{checkid}"=>{"\n get"=>{"summary"=>"Get List of Outages", "description"=>"Get a list of status changes for a specified check and time period. If order is speficied to descending, the list is ordered by newest first. (Default is ordered by oldest first.)", "operationId"=>"get-list-of-outages", "x-api-path-slug"=>"apiversionsummary-outagecheckid-get", "parameters"=>[{"in"=>"query", "name"=>"from", "description"=>"Start time of period", "type"=>"integer | "}, {"in"=>"query", "name"=>"order", "description"=>"Sorting order of outages", "type"=>"string (asc,desc) | "}, {"in"=>"query", "name"=>"to", "description"=>"End time of period", "type"=>"integer | "}], "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}}, "tags"=>["Summary"]}}, "\n /api/{version}/summary.performance/{checkid}"=>{"\n get"=>{"summary"=>"Get Intervals of Average Response Time and Uptime During a Given Interval", "description"=>"For a given interval in time, return a list of sub intervals with the given resolution. Useful for generating graphs. A sub interval may be a week,\n a day or an hour depending on the choosen resolution.", "operationId"=>"get-intervals-of-average-response-time-and-uptime-during-a-given-interval", "x-api-path-slug"=>"apiversionsummary-performancecheckid-get", "parameters"=>[{"in"=>"query", "name"=>"from", "description"=>"Start time of period", "type"=>"integer | "}, {"in"=>"query", "name"=>"includeuptime", "description"=>"Include uptime information", "type"=>"boolean | "}, {"in"=>"query", "name"=>"order", "description"=>"Sorting order of sub intervals", "type"=>"string (asc,desc) | "}, {"in"=>"query", "name"=>"probes", "description"=>"Filter to only use results from a list of probes", "type"=>"string | "}, {"in"=>"query", "name"=>"resolution", "description"=>"Interval size", "type"=>"string (hour, day, week) | "}, {"in"=>"query", "name"=>"to", "description"=>"End time of period", "type"=>"integer | "}], "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}}, "tags"=>["Summary"]}}, "\n /api/{version}/summary.probes/{checkid}"=>{"\n get"=>{"summary"=>"Get Active Probes For A Period", "description"=>"Get a list of probes that performed tests for a specified check during a specified period.", "operationId"=>"get-active-probes-for-a-period", "x-api-path-slug"=>"apiversionsummary-probescheckid-get", "parameters"=>[{"in"=>"query", "name"=>"from", "description"=>"Start time of period", "type"=>"integer | "}, {"in"=>"query", "name"=>"to", "description"=>"End time of period", "type"=>"integer | "}], "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}}, "tags"=>["Summary"]}}}}, "apis"=>{"name"=>"Pingdom", "x-slug"=>"pingdom", "description"=>"Monitor your websites availability and performance for free with Pingdom and always be the first to know when your website is down. No installation required.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/456-pingdom.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"5876", "tags"=>"internet,Monitoring,Performance,Relative Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"pingdom/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Analysis API", "x-api-slug"=>"analysis-api", "description"=>"Monitor your websites availability and performance for free with Pingdom and always be the first to know when your website is down. No installation required.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/456-pingdom.jpg", "humanURL"=>"http://www.pingdom.com", "baseURL"=>":///", "tags"=>"internet,Monitoring,Performance,Relative Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/pingdom/apiversionanalysischeckid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/pingdom/analysis-api-openapi.yaml"}]}, {"name"=>"Checks API", "x-api-slug"=>"checks-api", "description"=>"Monitor your websites availability and performance for free with Pingdom and always be the first to know when your website is down. No installation required.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/456-pingdom.jpg", "humanURL"=>"http://www.pingdom.com", "baseURL"=>"https://api.pingdom.com//", "tags"=>"Analysis", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/pingdom/checks-api-openapi.yaml"}]}, {"name"=>"Credits API", "x-api-slug"=>"credits-api", "description"=>"Monitor your websites availability and performance for free with Pingdom and always be the first to know when your website is down. No installation required.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/456-pingdom.jpg", "humanURL"=>"http://www.pingdom.com", "baseURL"=>"https://api.pingdom.com//", "tags"=>"Checks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/pingdom/apiversioncredits-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/pingdom/credits-api-openapi.yaml"}]}, {"name"=>"Probes API", "x-api-slug"=>"probes-api", "description"=>"Monitor your websites availability and performance for free with Pingdom and always be the first to know when your website is down. No installation required.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/456-pingdom.jpg", "humanURL"=>"http://www.pingdom.com", "baseURL"=>"https://api.pingdom.com//", "tags"=>"Credits", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/pingdom/apiversionprobes-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/pingdom/probes-api-openapi.yaml"}]}, {"name"=>"Reference API", "x-api-slug"=>"reference-api", "description"=>"Monitor your websites availability and performance for free with Pingdom and always be the first to know when your website is down. No installation required.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/456-pingdom.jpg", "humanURL"=>"http://www.pingdom.com", "baseURL"=>"https://api.pingdom.com//", "tags"=>"Proves", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/pingdom/apiversionreference-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/pingdom/reference-api-openapi.yaml"}]}, {"name"=>"Reports API", "x-api-slug"=>"reports-api", "description"=>"Monitor your websites availability and performance for free with Pingdom and always be the first to know when your website is down. No installation required.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/456-pingdom.jpg", "humanURL"=>"http://www.pingdom.com", "baseURL"=>"https://api.pingdom.com//", "tags"=>"Reerence", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/pingdom/apiversionreports-shared-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/pingdom/reports-api-openapi.yaml"}]}, {"name"=>"Results API", "x-api-slug"=>"results-api", "description"=>"Monitor your websites availability and performance for free with Pingdom and always be the first to know when your website is down. No installation required.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/456-pingdom.jpg", "humanURL"=>"http://www.pingdom.com", "baseURL"=>"https://api.pingdom.com//", "tags"=>"Reports", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/pingdom/apiversionresultscheckid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/pingdom/results-api-openapi.yaml"}]}, {"name"=>"Servertime API", "x-api-slug"=>"servertime-api", "description"=>"Monitor your websites availability and performance for free with Pingdom and always be the first to know when your website is down. No installation required.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/456-pingdom.jpg", "humanURL"=>"http://www.pingdom.com", "baseURL"=>"https://api.pingdom.com//", "tags"=>"Results", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/pingdom/apiversionservertime-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/pingdom/servertime-api-openapi.yaml"}]}, {"name"=>"Settings API", "x-api-slug"=>"settings-api", "description"=>"Monitor your websites availability and performance for free with Pingdom and always be the first to know when your website is down. No installation required.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/456-pingdom.jpg", "humanURL"=>"http://www.pingdom.com", "baseURL"=>"https://api.pingdom.com//", "tags"=>"Servertime", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/pingdom/apiversionsettings-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/pingdom/settings-api-openapi.yaml"}]}, {"name"=>"Single API", "x-api-slug"=>"single-api", "description"=>"Monitor your websites availability and performance for free with Pingdom and always be the first to know when your website is down. No installation required.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/456-pingdom.jpg", "humanURL"=>"http://www.pingdom.com", "baseURL"=>"https://api.pingdom.com//", "tags"=>"Settings", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/pingdom/apiversionsingle-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/pingdom/single-api-openapi.yaml"}]}, {"name"=>"Summary API", "x-api-slug"=>"summary-api", "description"=>"Monitor your websites availability and performance for free with Pingdom and always be the first to know when your website is down. No installation required.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/456-pingdom.jpg", "humanURL"=>"http://www.pingdom.com", "baseURL"=>"https://api.pingdom.com//", "tags"=>"Single", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/pingdom/apiversionsummary-probescheckid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/pingdom/summary-api-openapi.yaml"}]}, {"name"=>"Traceroute API", "x-api-slug"=>"traceroute-api", "description"=>"Monitor your websites availability and performance for free with Pingdom and always be the first to know when your website is down. No installation required.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/456-pingdom.jpg", "humanURL"=>"http://www.pingdom.com", "baseURL"=>"https://api.pingdom.com//", "tags"=>"Summary", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/pingdom/apiversiontraceroute-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/pingdom/traceroute-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.pingdom.com"}, {"type"=>"x-blog", "url"=>"http://royal.pingdom.com/"}, {"type"=>"x-blog-rss", "url"=>"http://royal.pingdom.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/pingdom"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/pingdom"}, {"type"=>"x-developer", "url"=>"https://www.pingdom.com/features/api/"}, {"type"=>"x-email", "url"=>"sales@pingdom.com"}, {"type"=>"x-github", "url"=>"https://github.com/Pingdom"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/pingdom"}, {"type"=>"x-pricing", "url"=>"https://www.pingdom.com/pricing"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/#!/pingdom"}, {"type"=>"x-webhook", "url"=>"https://www.pingdom.com/resources/webhooks/"}, {"type"=>"x-website", "url"=>"http://www.pingdom.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}}|||||||||||||||||||||||||||||||||||||||||||||||||
|
cisco-webex{"webex-teams-admin-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Cisco WebEx", "x-complete"=>1, "info"=>{"title"=>"Webex Teams Admin API", "description"=>"the-webex-teams-api-includes-administration-apis-that-allow-administrators-to-programatically-perform-administration-actions-such-as-provisioning-a-user--by-automating-administration-user-management-and-provisioning-can-be-centralized-in-an-existing-tool-rather-than-using-the-webex-teams-control-hub--for-example-a-partner-selling-multiple-collaboration-tools-to-customers-can-use-these-apis-to-enable-webex-teams-provisioning-through-a-centralized-portal-httpsdeveloper-webex-comadminapi-html-whats-possible-with-admin-apiscurrently-administration-is-focused-on-user-provisioning--using-these-apis-an-admin-can-create-a-user-update-a-user-view-license-usage-of-an-organization-view-available-roles-of-an-organization-manage-hybrid-services-licenses-and-users-authenticationuse-of-these-apis-requires-you-to-be-an-administrator-of-an-organization-if-you-are-an-administrator-you-can-login-here-to-get-a-development-auth-token-with-necessary-scopes-creating-an-integration-that-will-act-on-behalf-of-an-administrator-can-be-done-by-including-one-or-more-of-the-following-scopes-when-requesting-an-auth-token-via-oauth--sparkadminpeople-read--access-to-read-your-users-company-directory-sparkadminpeople-write--access-to-write-to-your-users-company-directory-sparkadminorganizations-read--access-to-write-to-your-users-company-directory-sparkadminroles-read--access-to-read-roles-available-in-your-users-organization-sparkadminlicenses-read--access-to-read-licenses-available-in-your-users-organizations", "version"=>"1.0.0"}, "host"=>"api.ciscospark.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/people/{_person}"=>{"get"=>{"summary"=>"Get Person Details1", "description"=>"Shows details for a person, by ID.\nSpecify the person ID in the personId parameter in the URI.\n\nhttps://developer.webex.com/endpoint-people-personId-get.html", "operationId"=>"PeopleByPersonGet2", "x-api-path-slug"=>"people-person-get", "parameters"=>[{"in"=>"path", "name"=>"_person"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Person", "Details1"]}, "put"=>{"summary"=>"Update a Person", "description"=>"Update details for a person, by ID.\r\n\r\nSpecify the person ID in the personId parameter in the URI. Only an admin can update a person details.\r\n\r\nhttps://developer.webex.com/endpoint-people-personId-put.html\r\n\r\nExample Request:\r\n``` json\r\n{\r\n 'emails\" : [ 'johnny.chang@foomail.com', 'jchang@barmail.com' ],\r\n 'displayName' : 'John Andersen',\r\n 'firstName' : 'John',\r\n 'lastName' : 'Andersen',\r\n 'avatar' : 'https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600',\r\n 'orgId' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\r\n 'roles' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ],\r\n 'licenses' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ]\r\n}\r\n```", "operationId"=>"PeopleByPersonPut", "x-api-path-slug"=>"people-person-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"_person"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Person"]}, "delete"=>{"summary"=>"Delete a Person", "description"=>"Remove a person from the system. Only an admin can remove a person.\n\nSpecify the person ID in the personId parameter in the URI.\n\nhttps://developer.webex.com/endpoint-people-personId-delete.html", "operationId"=>"PeopleByPersonDelete", "x-api-path-slug"=>"people-person-delete", "parameters"=>[{"in"=>"path", "name"=>"_person"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Person"]}}, "/roles"=>{"get"=>{"summary"=>"Get roles (to fetch a role id)", "description"=>"List all roles.\n\nhttps://developer.webex.com/endpoint-roles-get.html\n\nExample Response:\n``` json\n{\n 'items' : [ {\n 'id' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\n 'displayName' : 'Full Administrator'\n } ]\n}\n```", "operationId"=>"RolesGet2", "x-api-path-slug"=>"roles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Roles", "(to", "Fetch", "Role", "Id)"]}}, "/licenses/{_license}"=>{"get"=>{"summary"=>"Get License Details", "description"=>"Shows details for a license, by ID.\r\n\r\nSpecify the license ID in the licenseId parameter in the URI.\r\n\r\nhttps://developer.webex.com/endpoint-licenses-licenseId-get.html\r\n\r\nExample Response:\r\n``` json\r\n{\r\n 'id' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\r\n 'displayName' : 'Spark Calling',\r\n 'totalUnits' : '42',\r\n 'consumedUnits' : \"8'\r\n}\r\n```", "operationId"=>"LicensesByLicenseGet", "x-api-path-slug"=>"licenses-license-get", "parameters"=>[{"in"=>"path", "name"=>"_license"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "License", "Details"]}}, "/roles/{_role}"=>{"get"=>{"summary"=>"Get Role Details", "description"=>"Shows details for a role, by ID.\n\nSpecify the role ID in the roleId parameter in the URI.\n\nhttps://developer.webex.com/endpoint-roles-roleId-get.html\n\nExample Response:\n``` json\n{\n 'id' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\n 'displayName' : 'Full Administrator'\n}\n```", "operationId"=>"RolesByRoleGet", "x-api-path-slug"=>"roles-role-get", "parameters"=>[{"in"=>"path", "name"=>"_role"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Role", "Details"]}}, "/people/me"=>{"get"=>{"summary"=>"Get Person Details (me)", "description"=>"Show the profile for the authenticated user.\n\nhttps://developer.webex.com/endpoint-people-me-get.html", "operationId"=>"PeopleMeGet", "x-api-path-slug"=>"peopleme-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Person", "Details", "(me)"]}}, "/events"=>{"get"=>{"summary"=>"List Events (new messages)", "description"=>"List events in your organization. Several query parameters are available to filter the response.\nLong result sets will be split into pages.\n\nhttps://developer.webex.com/endpoint-events-get.html", "operationId"=>"EventsGet4", "x-api-path-slug"=>"events-get", "parameters"=>[{"in"=>"query", "name"=>"resource"}, {"in"=>"query", "name"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "List", "Events", "(new", "Messages)"]}}, "/licenses"=>{"get"=>{"summary"=>"List Licenses", "description"=>"List all licenses for a given organization. If no orgId is specified, the default is the organization of the authenticated user.\n\nhttps://developer.webex.com/endpoint-licenses-get.html\n\nExample of a response:\n``` json\n{\n 'items' : [ {\n 'id' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\n 'displayName' : 'Spark Calling',\n 'totalUnits' : '42',\n 'consumedUnits' : '8'\n } ]\n}\n```", "operationId"=>"LicensesGet", "x-api-path-slug"=>"licenses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "List", "Licenses"]}}, "/events/{_event}"=>{"get"=>{"summary"=>"Get Events Details", "description"=>"Shows details for an event, by event ID.\r\nSpecify the event ID in the eventId parameter in the URI.\r\n\r\nhttps://developer.webex.com/endpoint-events-eventId-get.html", "operationId"=>"EventsByEventGet", "x-api-path-slug"=>"events-event-get", "parameters"=>[{"in"=>"path", "name"=>"_event"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Events", "Details"]}}, "/organizations"=>{"get"=>{"summary"=>"List Organizations", "description"=>"List all organizations visible by your account.\n\nhttps://developer.webex.com/endpoint-organizations-get.html\n\nExample Response:\n``` json\n{\n 'items' : [ {\n 'id' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\n 'displayName' : 'Acme, Inc.',\n 'created' : '2015-10-18T14:26:16+00:00'\n } ]\n}\n```", "operationId"=>"OrganizationsGet", "x-api-path-slug"=>"organizations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "List", "Organizations"]}}, "/people"=>{"get"=>{"summary"=>"List people (with exact email)", "description"=>"List people in your organization.\n\nhttps://developer.webex.com/endpoint-people-get.html", "operationId"=>"PeopleGet", "x-api-path-slug"=>"people-get", "parameters"=>[{"in"=>"query", "name"=>"email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "List", "People", "(with", "Exact", "Email)"]}, "post"=>{"summary"=>"Create a Person (random)", "description"=>"Create a new user account for a given organization. Only an admin can create a new user account.\n\nhttps://developer.webex.com/endpoint-people-post.html\n\nExample Request:\n``` json\n{\n 'emails' : [ 'johnny.chang@foomail.com', 'jchang@barmail.com' ],\n 'displayName' : 'John Andersen',\n 'firstName' : 'John',\n 'lastName' : 'Andersen',\n 'avatar' : 'https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600',\n 'orgId' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\n 'roles' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ],\n 'licenses' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ]\n}\n\nExample Response:\n{\n 'id' : 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY',\n 'emails' : [ 'johnny.chang@foomail.com', 'jchang@barmail.com' ],\n 'displayName' : 'John Andersen',\n 'firstName' : 'John',\n 'lastName' : 'Andersen',\n 'avatar' : 'https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600',\n 'orgId' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\n 'roles' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ],\n 'licenses' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ],\n 'created' : '2015-10-18T14:26:16+00:00',\n 'timezone' : 'America/Denver'\n}\n```", "operationId"=>"PeoplePost", "x-api-path-slug"=>"people-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Person", "(random)"]}}, "/organizations/{_organization}"=>{"get"=>{"summary"=>"Get Organization Details", "description"=>"Shows details for an organization, by ID.\r\n\r\nSpecify the org ID in the orgId parameter in the URI.\r\n\r\nhttps://developer.webex.com/endpoint-organizations-orgId-get.html\r\n\r\nExample Response:\r\n``` json\r\n{\r\n 'id' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\r\n 'displayName' : 'Acme, Inc.',\r\n 'created' : '2015-10-18T14:26:16+00:00'\r\n}\r\n```", "operationId"=>"OrganizationsByOrganizationGet", "x-api-path-slug"=>"organizations-organization-get", "parameters"=>[{"in"=>"path", "name"=>"_organization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Organization", "Details"]}}}}, "webex-teams-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Cisco WebEx", "x-complete"=>1, "info"=>{"title"=>"Webex Teams API", "description"=>"hey-there-thanks-for-checking-out-cisco-webex-for-developers--if-youve-used-cisco-webex-meetings-or-cisco-webex-teams-formerly-cisco-spark-you-know-how-easy-it-is-to-meet-and-collaborate-with-your-team-members-and-customers-the-webex-for-developers-program-opens-up-the-power-behind-the-webex-platform-to-anyone-seeking-to-extend-the-webex-experience-webex-meetings-is-a-powerful-conferencing-solution-that-lets-you-connect-with-anyone-anywhere-in-real-time--by-combining-video-audio-and-content-sharing-webex-meetings-creates-an-effective-conferencing-environment-leading-to-more-productive-meetings-and-increased-productivity--developer-information-for-webex-meetings-will-soon-be-available-on-this-site--in-the-meantime-to-get-started-with-developing-for-webex-meetings-please-see-the-getting-started-guides-over-on-cisco-devnet--keep-reading-for-information-about-webex-teams-webex-teams-makes-staying-in-sync-with-your-teammates-and-customers-easy-conversations-in-webex-teams-take-place-in-virtual-meeting-rooms--some-rooms-live-for-a-few-hours-while-others-become-permanent-fixtures-of-your-teams-workflow-with-titles-like-daily-standup-or-build-status--webex-teams-allows-conversations-to-flow-seamlessly-between-messages-video-calls-and-realtime-whiteboarding-sessions--no-other-solution-brings-together-so-many-facets-of-collaboration-into-a-single-unified-platform-httpsdeveloper-webex-comgettingstarted-html", "version"=>"1.0.0"}, "host"=>"api.ciscospark.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/webhooks"=>{"get"=>{"summary"=>"List webhooks", "description"=>"Lists all of your webhooks.\n\nhttps://developer.webex.com/endpoint-webhooks-get.html", "operationId"=>"WebhooksGet", "x-api-path-slug"=>"webhooks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "List", "Webhooks"]}, "post"=>{"summary"=>"Create a webhook (all events, all rooms)", "description"=>"Creates a webhook for messages/created event.\n\nNote that you'll need to change the requestb.in URI to your own to see the webhook in action.\n\nhttps://developer.webex.com/endpoint-webhooks-post.html", "operationId"=>"WebhooksPost", "x-api-path-slug"=>"webhooks-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Webhook", "(all", "Events", "", "", "Rooms)"]}}, "/rooms"=>{"get"=>{"summary"=>"List rooms", "description"=>"List rooms.\r\n\r\nBy default, lists rooms to which the authenticated user belongs.\r\n\r\nhttps://developer.webex.com/endpoint-rooms-get.html", "operationId"=>"RoomsGet3", "x-api-path-slug"=>"rooms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "List", "Rooms"]}, "post"=>{"summary"=>"Create a Team room", "description"=>"Creates a room. The authenticated user is automatically added as a member of the room. See the Memberships API to learn how to add more people to the room.\n\nhttps://developer.webex.com/endpoint-rooms-post.html", "operationId"=>"RoomsPost5", "x-api-path-slug"=>"rooms-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Team", "Room"]}}, "/memberships/{_membership}"=>{"get"=>{"summary"=>"Get membership details", "description"=>"Get details for a membership by ID.\r\n\r\nSpecify the membership ID in the membershipId URI parameter.\r\n\r\nhttps://developer.webex.com/endpoint-memberships-membershipId-get.html", "operationId"=>"MembershipsByMembershipGet", "x-api-path-slug"=>"memberships-membership-get", "parameters"=>[{"in"=>"path", "name"=>"_membership"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Membership", "Details"]}, "put"=>{"summary"=>"Update a membership", "description"=>"Updates properties for a membership by ID.\n\nSpecify the membership ID in the membershipId URI parameter.\n\nhttps://developer.ciscospark.com/endpoint-memberships-membershipId-put.html", "operationId"=>"MembershipsByMembershipPut", "x-api-path-slug"=>"memberships-membership-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"_membership"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Membership"]}, "delete"=>{"summary"=>"Delete membership", "description"=>"Deletes a membership by ID.\r\n\r\nSpecify the membership ID in the membershipId URI parameter.\r\n\r\nhttps://developer.webex.com/endpoint-memberships-membershipId-delete.html", "operationId"=>"MembershipsByMembershipDelete", "x-api-path-slug"=>"memberships-membership-delete", "parameters"=>[{"in"=>"path", "name"=>"_membership"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Membership"]}}, "/messages/{_message}"=>{"get"=>{"summary"=>"Get message details", "description"=>"Shows details for a message, by message ID.\n\nSpecify the message ID in the messageId parameter in the URI.\n\nhttps://developer.webex.com/endpoint-messages-messageId-get.html", "operationId"=>"MessagesByMessageGet", "x-api-path-slug"=>"messages-message-get", "parameters"=>[{"in"=>"path", "name"=>"_message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Message", "Details"]}, "delete"=>{"summary"=>"Delete a message", "description"=>"Deletes a message, by message ID.\n\nSpecify the message ID in the messageId parameter in the URI.\n\nhttps://developer.webex.com/endpoint-messages-messageId-delete.html", "operationId"=>"MessagesByMessageDelete", "x-api-path-slug"=>"messages-message-delete", "parameters"=>[{"in"=>"path", "name"=>"_message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Message"]}}, "/messages"=>{"get"=>{"summary"=>"List messages", "description"=>"Lists all messages in a room. If present, includes the associated media content attachment for each message.\r\n\r\nThe list sorts the messages in descending order by creation date.\r\n\r\nhttps://developer.webex.com/endpoint-messages-get.html", "operationId"=>"MessagesGet", "x-api-path-slug"=>"messages-get", "parameters"=>[{"in"=>"query", "name"=>"roomId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "List", "Messages"]}, "post"=>{"summary"=>"Create a message (html)", "description"=>"HTML is not officially supported by the API, but will work in some cases\n\nTo get more info about message formatting, check https://developer.ciscospark.com/formatting-messages.html\n\nhttps://developer.webex.com/endpoint-messages-post.html", "operationId"=>"MessagesPost11", "x-api-path-slug"=>"messages-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Message", "(html)"]}}, "/people/me"=>{"get"=>{"summary"=>"Get person details (me)", "description"=>"Show the profile for the authenticated user.\n\nhttps://developer.webex.com/endpoint-people-me-get.html", "operationId"=>"PeopleMeGet", "x-api-path-slug"=>"peopleme-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Person", "Details", "(me)"]}}, "/rooms/{_room}"=>{"get"=>{"summary"=>"Get Team room details", "description"=>"Shows details for a room, by ID.\r\n\r\nSpecify the room ID in the roomId parameter in the URI.\r\n\r\nhttps://developer.webex.com/endpoint-rooms-roomId-get.html", "operationId"=>"RoomsByRoomGet2", "x-api-path-slug"=>"rooms-room-get", "parameters"=>[{"in"=>"path", "name"=>"_room"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Team", "Room", "Details"]}, "put"=>{"summary"=>"Update a room", "description"=>"Updates details for a room, by ID.\r\n\r\nSpecify the room ID in the roomId parameter in the URI.\r\n\r\nhttps://developer.webex.com/endpoint-rooms-roomId-put.html", "operationId"=>"RoomsByRoomPut2", "x-api-path-slug"=>"rooms-room-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"_room"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Room"]}, "delete"=>{"summary"=>"Delete a Team room", "description"=>"Deletes a room, by ID.\r\n\r\nSpecify the room ID in the roomId parameter in the URI.\r\n\r\nhttps://developer.webex.com/endpoint-rooms-roomId-delete.html", "operationId"=>"RoomsByRoomDelete5", "x-api-path-slug"=>"rooms-room-delete", "parameters"=>[{"in"=>"path", "name"=>"_room"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Team", "Room"]}}, "/teams"=>{"get"=>{"summary"=>"List teams", "description"=>"List teams.\n\nhttps://developer.webex.com/endpoint-teams-get.html", "operationId"=>"TeamsGet", "x-api-path-slug"=>"teams-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "List", "Teams"]}, "post"=>{"summary"=>"Create a team", "description"=>"Create a new team.\n\nhttps://developer.webex.com/endpoint-teams-post.html", "operationId"=>"TeamsPost2", "x-api-path-slug"=>"teams-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Team"]}}, "/people"=>{"get"=>{"summary"=>"List people (whose name starts with)", "description"=>"List people in your organization.\n\nhttps://developer.webex.com/endpoint-people-get.html", "operationId"=>"PeopleGet2", "x-api-path-slug"=>"people-get", "parameters"=>[{"in"=>"query", "name"=>"displayName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "List", "People", "(whose", "Name", "Starts", "With)"]}}, "/webhooks/{_webhook}"=>{"get"=>{"summary"=>"Get webhook details1", "description"=>"Shows details for a webhook, by ID.\r\n\r\nSpecify the webhook ID in the webhookId parameter in the URI.\r\n\r\nhttps://developer.webex.com/endpoint-webhooks-webhookId-get.html", "operationId"=>"WebhooksByWebhookGet2", "x-api-path-slug"=>"webhooks-webhook-get", "parameters"=>[{"in"=>"path", "name"=>"_webhook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Webhook", "Details1"]}, "put"=>{"summary"=>"Update a webhook", "description"=>"Updates a webhook, by ID.\r\n\r\nSpecify the webhook ID in the webhookId parameter in the URI.\r\n\r\nhttps://developer.webex.com/endpoint-webhooks-webhookId-put.html", "operationId"=>"WebhooksByWebhookPut", "x-api-path-slug"=>"webhooks-webhook-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"_webhook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Webhook"]}, "delete"=>{"summary"=>"Delete a webhook1", "description"=>"Deletes a webhook, by ID.\r\n\r\nSpecify the webhook ID in the webhookId parameter in the URI.\r\n\r\nhttps://developer.webex.com/endpoint-webhooks-delete.html", "operationId"=>"WebhooksByWebhookDelete2", "x-api-path-slug"=>"webhooks-webhook-delete", "parameters"=>[{"in"=>"path", "name"=>"_webhook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Webhook1"]}}, "/memberships"=>{"get"=>{"summary"=>"List memberships (for all rooms)", "description"=>"Lists all room memberships. By default, lists memberships for rooms to which the authenticated user belongs.\n\nUse query parameters to filter the response.\n\nUse roomId to list memberships for a room, by ID.\n\nUse either personId or personEmail to filter the results.\n\nhttps://developer.webex.com/endpoint-memberships-get.html", "operationId"=>"MembershipsGet2", "x-api-path-slug"=>"memberships-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "List", "Memberships", "(for", "", "Rooms)"]}, "post"=>{"summary"=>"Create a membership", "description"=>"Add someone to a room by Person ID or email address; optionally making them a moderator.\n\nhttps://developer.webex.com/endpoint-memberships-post.html", "operationId"=>"MembershipsPost", "x-api-path-slug"=>"memberships-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Membership"]}}, "/team/memberships/{_membership}"=>{"get"=>{"summary"=>"Get team membership details", "description"=>"Get details for a membership by ID.\r\n\r\nSpecify the membership ID in the membershipId URI parameter.\r\n\r\nhttps://developer.webex.com/endpoint-teammemberships-membershipId-get.html", "operationId"=>"TeamMembershipsByMembershipGet", "x-api-path-slug"=>"teammemberships-membership-get", "parameters"=>[{"in"=>"path", "name"=>"_membership"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Team", "Membership", "Details"]}, "put"=>{"summary"=>"Update a team membership", "description"=>"Updates properties for a membership by ID.\n\nSpecify the membership ID in the membershipId URI parameter.\n\nhttps://developer.webex.com/endpoint-teammemberships-membershipId-put.html", "operationId"=>"TeamMembershipsByMembershipPut", "x-api-path-slug"=>"teammemberships-membership-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"_membership"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Team", "Membership"]}, "delete"=>{"summary"=>"Delete a team membership", "description"=>"Deletes a membership by ID.\r\n\r\nSpecify the membership ID in the membershipId URI parameter.\r\n\r\nhttps://developer.webex.com/endpoint-teammemberships-membershipId-delete.html", "operationId"=>"TeamMembershipsByMembershipDelete", "x-api-path-slug"=>"teammemberships-membership-delete", "parameters"=>[{"in"=>"path", "name"=>"_membership"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Team", "Membership"]}}, "/13f99fq1"=>{"get"=>{"summary"=>"Check requestb.in (test purpose)", "description"=>"check an event has been posted", "operationId"=>"13f99fq1Get", "x-api-path-slug"=>"13f99fq1-get", "parameters"=>[{"in"=>"query", "name"=>"inspect"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Check", "Requestb", "In", "(test", "Purpose)"]}}, "/teams/{_team}"=>{"get"=>{"summary"=>"Get team details", "description"=>"Show details for a team.\n\nhttps://developer.webex.com/endpoint-teams-teamId-get.html", "operationId"=>"TeamsByTeamGet", "x-api-path-slug"=>"teams-team-get", "parameters"=>[{"in"=>"path", "name"=>"_team"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Team", "Details"]}, "put"=>{"summary"=>"Update a team", "description"=>"Update a team.\n\nhttps://developer.webex.com/endpoint-teams-teamId-put.html", "operationId"=>"TeamsByTeamPut", "x-api-path-slug"=>"teams-team-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"_team"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Team"]}, "delete"=>{"summary"=>"Delete a team", "description"=>"Delete a team.\n\nhttps://developer.webex.com/endpoint-teams-teamId-delete.html", "operationId"=>"TeamsByTeamDelete2", "x-api-path-slug"=>"teams-team-delete", "parameters"=>[{"in"=>"path", "name"=>"_team"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Team"]}}, "/team/memberships"=>{"get"=>{"summary"=>"List team memberships", "description"=>"Lists all team memberships. By default, lists memberships for teams to which the authenticated user belongs.\r\n\r\nUse query parameters to filter the response.\r\n\r\nUse teamId to list memberships for a team, by ID.\r\n\r\nUse either personId or personEmail to filter the results.\r\n\r\nhttps://developer.webex.com/endpoint-teammemberships-get.html", "operationId"=>"TeamMembershipsGet", "x-api-path-slug"=>"teammemberships-get", "parameters"=>[{"in"=>"query", "name"=>"teamId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "List", "Team", "Memberships"]}, "post"=>{"summary"=>"Create a team membership", "description"=>"Add someone to a team by Person ID or email address; optionally making them a moderator.\n\nhttps://developer.webex.com/endpoint-teammemberships-post.html", "operationId"=>"TeamMembershipsPost", "x-api-path-slug"=>"teammemberships-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Team", "Membership"]}}, "/people/{_person}"=>{"get"=>{"summary"=>"Get person details", "description"=>"Shows details for a person, by ID.\r\n\r\nSpecify the person ID in the personId parameter in the URI.\r\n\r\nhttps://developer.webex.com/endpoint-people-personId-get.html", "operationId"=>"PeopleByPersonGet", "x-api-path-slug"=>"people-person-get", "parameters"=>[{"in"=>"path", "name"=>"_person"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Person", "Details"]}}, "/webhooks/"=>{"post"=>{"summary"=>"Create a webhook (messages/created)", "description"=>"Creates a webhook for messages/created event.\n\nNote that you'll need to change the requestb.in URI to your own to see the webhook in action.\n\nhttps://developer.webex.com/endpoint-webhooks-post.html", "operationId"=>"WebhooksPost2", "x-api-path-slug"=>"webhooks-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video Conferencing", "Webhook", "(messages", "Created)"]}}}}, "apis"=>{"name"=>"Cisco WebEx", "x-slug"=>"cisco-webex", "description"=>"Cisco Webex is the leading enterprise solution for video conferencing & web conferencing today. This secure software-based platform for video & audio conferencing, group messaging & webinars helps organizations be more productive.Participants can join ...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/730-cisco-webex.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"632", "tags"=>"API Provider,Collaboration,Enterprise,Office,Profiles,Relative Data,SaaS,Service API,Technology,Telecommunications,Video Conferencing,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"cisco-webex/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Webex Teams Admin API", "x-api-slug"=>"webex-teams-admin-api", "description"=>"Cisco Webex is the leading enterprise solution for video conferencing & web conferencing today. This secure software-based platform for video & audio conferencing, group messaging & webinars helps organizations be more productive.Participants can join ...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/730-cisco-webex.jpg", "humanURL"=>"https://webex.com", "baseURL"=>"https://api.ciscospark.com//v1", "tags"=>"API Provider,Collaboration,Enterprise,Office,Profiles,Relative Data,SaaS,Service API,Technology,Telecommunications,Video Conferencing,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/cisco-webex/webex-teams-admin-api-openapi.yaml"}]}, {"name"=>"WebEx Teams API", "x-api-slug"=>"webex-teams-api", "description"=>"Cisco Webex is the leading enterprise solution for video conferencing & web conferencing today. This secure software-based platform for video & audio conferencing, group messaging & webinars helps organizations be more productive.Participants can join ...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/730-cisco-webex.jpg", "humanURL"=>"https://webex.com", "baseURL"=>"https://api.ciscospark.com//v1", "tags"=>"Video Conferencing,Organization,Details", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/cisco-webex/webex-teams-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-postman-collection", "url"=>"https://app.getpostman.com/run-collection/1f5e101d8290a5303c90"}, {"type"=>"x-blog", "url"=>"http://blogs.webex.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blogs.webex.com/webex_interactions/index.rdf"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/webex-communications"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/webex"}, {"type"=>"x-postman-collection", "url"=>"https://app.getpostman.com/run-collection/0aa22af74405f82086d4"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/webex"}, {"type"=>"x-webhook", "url"=>"https://developer.webex.com/resource-webhooks.html"}, {"type"=>"x-developer", "url"=>"https://developer.webex.com/"}, {"type"=>"x-website", "url"=>"https://webex.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
spreaker{"spreaker-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Spreaker", "x-complete"=>1, "info"=>{"title"=>"Spreaker API", "version"=>"v1"}, "host"=>"api.spreaker.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/categories/flat"=>{"get"=>{"summary"=>"Get Categories", "description"=>"Retrieves all categories in Spreaker", "operationId"=>"getCategoriesFlat", "x-api-path-slug"=>"categoriesflat-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Podcasts", "Categories"]}}, "/episode/ |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-rds{"amazon-rds-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS RDS", "x-complete"=>1, "info"=>{"title"=>"AWS RDS API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddRoleToDBCluster"=>{"get"=>{"summary"=>"Add Role To D B Cluster", "description"=>"Associates an Identity and Access Management (IAM) role from an Aurora DB cluster.", "operationId"=>"addroletodbcluster", "x-api-path-slug"=>"actionaddroletodbcluster-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterIdentifier", "description"=>"The name of the DB cluster to associate the IAM role with", "type"=>"string"}, {"in"=>"query", "name"=>"RoleArn", "description"=>"The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=AddSourceIdentifierToSubscription"=>{"get"=>{"summary"=>"Add Source Identifier To Subscription", "description"=>"Adds a source identifier to an existing RDS event notification subscription.", "operationId"=>"addsourceidentifiertosubscription", "x-api-path-slug"=>"actionaddsourceidentifiertosubscription-get", "parameters"=>[{"in"=>"query", "name"=>"SourceIdentifier", "description"=>"The identifier of the event source to be added", "type"=>"string"}, {"in"=>"query", "name"=>"SubscriptionName", "description"=>"The name of the RDS event notification subscription you want to add a source identifier to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/?Action=AddTagsToResource"=>{"get"=>{"summary"=>"Add Tags To Resource", "description"=>"Adds metadata tags to an Amazon RDS resource.", "operationId"=>"addtagstoresource", "x-api-path-slug"=>"actionaddtagstoresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceName", "description"=>"The Amazon RDS resource the tags will be added to", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"The tags to be assigned to the Amazon RDS resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=ApplyPendingMaintenanceAction"=>{"get"=>{"summary"=>"Apply Pending Maintenance Action", "description"=>"Applies a pending maintenance action to a resource (for example, to a DB instance).", "operationId"=>"applypendingmaintenanceaction", "x-api-path-slug"=>"actionapplypendingmaintenanceaction-get", "parameters"=>[{"in"=>"query", "name"=>"ApplyAction", "description"=>"The pending maintenance action to apply to this resource", "type"=>"string"}, {"in"=>"query", "name"=>"OptInType", "description"=>"A value that specifies the type of opt-in request, or undoes an opt-in request", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceIdentifier", "description"=>"The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance Actions"]}}, "/?Action=AuthorizeDBSecurityGroupIngress"=>{"get"=>{"summary"=>"Authorize D B Security Group Ingress", "description"=>"Enables ingress to a DBSecurityGroup using one of two forms of authorization.", "operationId"=>"authorizedbsecuritygroupingress", "x-api-path-slug"=>"actionauthorizedbsecuritygroupingress-get", "parameters"=>[{"in"=>"query", "name"=>"CIDRIP", "description"=>"The IP range to authorize", "type"=>"string"}, {"in"=>"query", "name"=>"DBSecurityGroupName", "description"=>"The name of the DB security group to add authorization to", "type"=>"string"}, {"in"=>"query", "name"=>"EC2SecurityGroupId", "description"=>"Id of the EC2 security group to authorize", "type"=>"string"}, {"in"=>"query", "name"=>"EC2SecurityGroupName", "description"=>"Name of the EC2 security group to authorize", "type"=>"string"}, {"in"=>"query", "name"=>"EC2SecurityGroupOwnerId", "description"=>"AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Groups"]}}, "/?Action=CopyDBClusterParameterGroup"=>{"get"=>{"summary"=>"Copy D B Cluster Parameter Group", "description"=>"Copies the specified DB cluster parameter group.", "operationId"=>"copydbclusterparametergroup", "x-api-path-slug"=>"actioncopydbclusterparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"SourceDBClusterParameterGroupIdentifier", "description"=>"The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}, {"in"=>"query", "name"=>"TargetDBClusterParameterGroupDescription", "description"=>"A description for the copied DB cluster parameter group", "type"=>"string"}, {"in"=>"query", "name"=>"TargetDBClusterParameterGroupIdentifier", "description"=>"The identifier for the copied DB cluster parameter group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Parameter Groups"]}}, "/?Action=CopyDBClusterSnapshot"=>{"get"=>{"summary"=>"Copy D B Cluster Snapshot", "description"=>"Creates a snapshot of a DB cluster.", "operationId"=>"copydbclustersnapshot", "x-api-path-slug"=>"actioncopydbclustersnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"SourceDBClusterSnapshotIdentifier", "description"=>"The identifier of the DB cluster snapshot to copy", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}, {"in"=>"query", "name"=>"TargetDBClusterSnapshotIdentifier", "description"=>"The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Snapshots"]}}, "/?Action=CopyDBParameterGroup"=>{"get"=>{"summary"=>"Copy D B Parameter Group", "description"=>"Copies the specified DB parameter group.", "operationId"=>"copydbparametergroup", "x-api-path-slug"=>"actioncopydbparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"SourceDBParameterGroupIdentifier", "description"=>"The identifier or ARN for the source DB parameter group", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}, {"in"=>"query", "name"=>"TargetDBParameterGroupDescription", "description"=>"A description for the copied DB parameter group", "type"=>"string"}, {"in"=>"query", "name"=>"TargetDBParameterGroupIdentifier", "description"=>"The identifier for the copied DB parameter group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameter Groups"]}}, "/?Action=CopyDBSnapshot"=>{"get"=>{"summary"=>"Copy D B Snapshot", "description"=>"Copies the specified DB snapshot.", "operationId"=>"copydbsnapshot", "x-api-path-slug"=>"actioncopydbsnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"CopyTags", "description"=>"True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyId", "description"=>"The AWS KMS key ID for an encrypted DB snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"PreSignedUrl", "description"=>"The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the AWS region that contains the source DB snapshot to copy", "type"=>"string"}, {"in"=>"query", "name"=>"SourceDBSnapshotIdentifier", "description"=>"The identifier for the source DB snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}, {"in"=>"query", "name"=>"TargetDBSnapshotIdentifier", "description"=>"The identifier for the copied snapshot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=CopyOptionGroup"=>{"get"=>{"summary"=>"Copy Option Group", "description"=>"Copies the specified option group.", "operationId"=>"copyoptiongroup", "x-api-path-slug"=>"actioncopyoptiongroup-get", "parameters"=>[{"in"=>"query", "name"=>"SourceOptionGroupIdentifier", "description"=>"The identifier or ARN for the source option group", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}, {"in"=>"query", "name"=>"TargetOptionGroupDescription", "description"=>"The description for the copied option group", "type"=>"string"}, {"in"=>"query", "name"=>"TargetOptionGroupIdentifier", "description"=>"The identifier for the copied option group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Option Groups"]}}, "/?Action=CreateDBCluster"=>{"get"=>{"summary"=>"Create D B Cluster", "description"=>"Creates a new Amazon Aurora DB cluster.", "operationId"=>"createdbcluster", "x-api-path-slug"=>"actioncreatedbcluster-get", "parameters"=>[{"in"=>"query", "name"=>"AvailabilityZones.AvailabilityZone.N", "description"=>"A list of EC2 Availability Zones that instances in the DB cluster can be created in", "type"=>"string"}, {"in"=>"query", "name"=>"BackupRetentionPeriod", "description"=>"The number of days for which automated backups are retained", "type"=>"string"}, {"in"=>"query", "name"=>"CharacterSetName", "description"=>"A value that indicates that the DB cluster should be associated with the specified CharacterSet", "type"=>"string"}, {"in"=>"query", "name"=>"DatabaseName", "description"=>"The name for your database of up to 8 alpha-numeric characters", "type"=>"string"}, {"in"=>"query", "name"=>"DBClusterIdentifier", "description"=>"The DB cluster identifier", "type"=>"string"}, {"in"=>"query", "name"=>"DBClusterParameterGroupName", "description"=>"The name of the DB cluster parameter group to associate with this DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"DBSubnetGroupName", "description"=>"A DB subnet group to associate with this DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"Engine", "description"=>"The name of the database engine to be used for this DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"EngineVersion", "description"=>"The version number of the database engine to use", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyId", "description"=>"The KMS key identifier for an encrypted DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"MasterUsername", "description"=>"The name of the master user for the DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"MasterUserPassword", "description"=>"The password for the master database user", "type"=>"string"}, {"in"=>"query", "name"=>"OptionGroupName", "description"=>"A value that indicates that the DB cluster should be associated with the specified option group", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port number on which the instances in the DB cluster accept connections", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredBackupWindow", "description"=>"The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredMaintenanceWindow", "description"=>"The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC)", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationSourceIdentifier", "description"=>"The Amazon Resource Name (ARN) of the source DB cluster if this DB cluster is created as a Read Replica", "type"=>"string"}, {"in"=>"query", "name"=>"StorageEncrypted", "description"=>"Specifies whether the DB cluster is encrypted", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}, {"in"=>"query", "name"=>"VpcSecurityGroupIds.VpcSecurityGroupId.N", "description"=>"A list of EC2 VPC security groups to associate with this DB cluster", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=CreateDBClusterParameterGroup"=>{"get"=>{"summary"=>"Create D B Cluster Parameter Group", "description"=>"Creates a new DB cluster parameter group.", "operationId"=>"createdbclusterparametergroup", "x-api-path-slug"=>"actioncreatedbclusterparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterParameterGroupName", "description"=>"The name of the DB cluster parameter group", "type"=>"string"}, {"in"=>"query", "name"=>"DBParameterGroupFamily", "description"=>"The DB cluster parameter group family name", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"The description for the DB cluster parameter group", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Parameter Groups"]}}, "/?Action=CreateDBClusterSnapshot"=>{"get"=>{"summary"=>"Create D B Cluster Snapshot", "description"=>"Creates a snapshot of a DB cluster.", "operationId"=>"createdbclustersnapshot", "x-api-path-slug"=>"actioncreatedbclustersnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterIdentifier", "description"=>"The identifier of the DB cluster to create a snapshot for", "type"=>"string"}, {"in"=>"query", "name"=>"DBClusterSnapshotIdentifier", "description"=>"The identifier of the DB cluster snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"The tags to be assigned to the DB cluster snapshot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Snapshots"]}}, "/?Action=CreateDBInstance"=>{"get"=>{"summary"=>"Create D B Instance", "description"=>"Creates a new DB instance.", "operationId"=>"createdbinstance", "x-api-path-slug"=>"actioncreatedbinstance-get", "parameters"=>[{"in"=>"query", "name"=>"AllocatedStorage", "description"=>"The amount of storage (in gigabytes) to be initially allocated for the database instance", "type"=>"string"}, {"in"=>"query", "name"=>"AutoMinorVersionUpgrade", "description"=>"Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window", "type"=>"string"}, {"in"=>"query", "name"=>"AvailabilityZone", "description"=>"The EC2 Availability Zone that the database instance will be created in", "type"=>"string"}, {"in"=>"query", "name"=>"BackupRetentionPeriod", "description"=>"The number of days for which automated backups are retained", "type"=>"string"}, {"in"=>"query", "name"=>"CharacterSetName", "description"=>"For supported engines, indicates that the DB instance should be associated with the specified CharacterSet", "type"=>"string"}, {"in"=>"query", "name"=>"CopyTagsToSnapshot", "description"=>"True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false", "type"=>"string"}, {"in"=>"query", "name"=>"DBClusterIdentifier", "description"=>"The identifier of the DB cluster that the instance will belong to", "type"=>"string"}, {"in"=>"query", "name"=>"DBInstanceClass", "description"=>"The compute and memory capacity of the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"DBInstanceIdentifier", "description"=>"The DB instance identifier", "type"=>"string"}, {"in"=>"query", "name"=>"DBName", "description"=>"The meaning of this parameter differs according to the database engine you use", "type"=>"string"}, {"in"=>"query", "name"=>"DBParameterGroupName", "description"=>"The name of the DB parameter group to associate with this DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"DBSecurityGroups.DBSecurityGroupName.N", "description"=>"A list of DB security groups to associate with this DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"DBSubnetGroupName", "description"=>"A DB subnet group to associate with this DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"Domain", "description"=>"Specify the Active Directory Domain to create the instance in", "type"=>"string"}, {"in"=>"query", "name"=>"DomainIAMRoleName", "description"=>"Specify the name of the IAM role to be used when making API calls to the Directory Service", "type"=>"string"}, {"in"=>"query", "name"=>"Engine", "description"=>"The name of the database engine to be used for this instance", "type"=>"string"}, {"in"=>"query", "name"=>"EngineVersion", "description"=>"The version number of the database engine to use", "type"=>"string"}, {"in"=>"query", "name"=>"Iops", "description"=>"The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyId", "description"=>"The KMS key identifier for an encrypted DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"LicenseModel", "description"=>"License model information for this DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"MasterUsername", "description"=>"The name of master user for the client DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"MasterUserPassword", "description"=>"The password for the master database user", "type"=>"string"}, {"in"=>"query", "name"=>"MonitoringInterval", "description"=>"The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"MonitoringRoleArn", "description"=>"The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs", "type"=>"string"}, {"in"=>"query", "name"=>"MultiAZ", "description"=>"Specifies if the DB instance is a Multi-AZ deployment", "type"=>"string"}, {"in"=>"query", "name"=>"OptionGroupName", "description"=>"Indicates that the DB instance should be associated with the specified option group", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port number on which the database accepts connections", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredBackupWindow", "description"=>"The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredMaintenanceWindow", "description"=>"The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC)", "type"=>"string"}, {"in"=>"query", "name"=>"PromotionTier", "description"=>"A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance", "type"=>"string"}, {"in"=>"query", "name"=>"PubliclyAccessible", "description"=>"Specifies the accessibility options for the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"StorageEncrypted", "description"=>"Specifies whether the DB instance is encrypted", "type"=>"string"}, {"in"=>"query", "name"=>"StorageType", "description"=>"Specifies the storage type to be associated with the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}, {"in"=>"query", "name"=>"TdeCredentialArn", "description"=>"The ARN from the Key Store with which to associate the instance for TDE encryption", "type"=>"string"}, {"in"=>"query", "name"=>"TdeCredentialPassword", "description"=>"The password for the given ARN from the Key Store in order to access the device", "type"=>"string"}, {"in"=>"query", "name"=>"Timezone", "description"=>"The time zone of the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"VpcSecurityGroupIds.VpcSecurityGroupId.N", "description"=>"A list of EC2 VPC security groups to associate with this DB instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=CreateDBInstanceReadReplica"=>{"get"=>{"summary"=>"Create D B Instance Read Replica", "description"=>"Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance.", "operationId"=>"createdbinstancereadreplica", "x-api-path-slug"=>"actioncreatedbinstancereadreplica-get", "parameters"=>[{"in"=>"query", "name"=>"AutoMinorVersionUpgrade", "description"=>"Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window", "type"=>"string"}, {"in"=>"query", "name"=>"AvailabilityZone", "description"=>"The Amazon EC2 Availability Zone that the Read Replica will be created in", "type"=>"string"}, {"in"=>"query", "name"=>"CopyTagsToSnapshot", "description"=>"True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false", "type"=>"string"}, {"in"=>"query", "name"=>"DBInstanceClass", "description"=>"The compute and memory capacity of the Read Replica", "type"=>"string"}, {"in"=>"query", "name"=>"DBInstanceIdentifier", "description"=>"The DB instance identifier of the Read Replica", "type"=>"string"}, {"in"=>"query", "name"=>"DBSubnetGroupName", "description"=>"Specifies a DB subnet group for the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"Iops", "description"=>"The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"MonitoringInterval", "description"=>"The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica", "type"=>"string"}, {"in"=>"query", "name"=>"MonitoringRoleArn", "description"=>"The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs", "type"=>"string"}, {"in"=>"query", "name"=>"OptionGroupName", "description"=>"The option group the DB instance will be associated with", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port number that the DB instance uses for connections", "type"=>"string"}, {"in"=>"query", "name"=>"PubliclyAccessible", "description"=>"Specifies the accessibility options for the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"SourceDBInstanceIdentifier", "description"=>"The identifier of the DB instance that will act as the source for the Read Replica", "type"=>"string"}, {"in"=>"query", "name"=>"StorageType", "description"=>"Specifies the storage type to be associated with the Read Replica", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=CreateDBParameterGroup"=>{"get"=>{"summary"=>"Create D B Parameter Group", "description"=>"Creates a new DB parameter group.", "operationId"=>"createdbparametergroup", "x-api-path-slug"=>"actioncreatedbparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"DBParameterGroupFamily", "description"=>"The DB parameter group family name", "type"=>"string"}, {"in"=>"query", "name"=>"DBParameterGroupName", "description"=>"The name of the DB parameter group", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"The description for the DB parameter group", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameter Groups"]}}, "/?Action=CreateDBSecurityGroup"=>{"get"=>{"summary"=>"Create D B Security Group", "description"=>"Creates a new DB security group.", "operationId"=>"createdbsecuritygroup", "x-api-path-slug"=>"actioncreatedbsecuritygroup-get", "parameters"=>[{"in"=>"query", "name"=>"DBSecurityGroupDescription", "description"=>"The description for the DB security group", "type"=>"string"}, {"in"=>"query", "name"=>"DBSecurityGroupName", "description"=>"The name for the DB security group", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Groups"]}}, "/?Action=CreateDBSnapshot"=>{"get"=>{"summary"=>"Create D B Snapshot", "description"=>"Creates a DBSnapshot.", "operationId"=>"createdbsnapshot", "x-api-path-slug"=>"actioncreatedbsnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"DBInstanceIdentifier", "description"=>"The DB instance identifier", "type"=>"string"}, {"in"=>"query", "name"=>"DBSnapshotIdentifier", "description"=>"The identifier for the DB snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=CreateDBSubnetGroup"=>{"get"=>{"summary"=>"Create D B Subnet Group", "description"=>"Creates a new DB subnet group.", "operationId"=>"createdbsubnetgroup", "x-api-path-slug"=>"actioncreatedbsubnetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"DBSubnetGroupDescription", "description"=>"The description for the DB subnet group", "type"=>"string"}, {"in"=>"query", "name"=>"DBSubnetGroupName", "description"=>"The name for the DB subnet group", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetIds.SubnetIdentifier.N", "description"=>"The EC2 Subnet IDs for the DB subnet group", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnet Groups"]}}, "/?Action=CreateEventSubscription"=>{"get"=>{"summary"=>"Create Event Subscription", "description"=>"Creates an RDS event notification subscription.", "operationId"=>"createeventsubscription", "x-api-path-slug"=>"actioncreateeventsubscription-get", "parameters"=>[{"in"=>"query", "name"=>"Enabled", "description"=>"A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it", "type"=>"string"}, {"in"=>"query", "name"=>"EventCategories.EventCategory.N", "description"=>"A list of event categories for a SourceType that you want to subscribe to", "type"=>"string"}, {"in"=>"query", "name"=>"SnsTopicArn", "description"=>"The Amazon Resource Name (ARN) of the SNS topic created for event notification", "type"=>"string"}, {"in"=>"query", "name"=>"SourceIds.SourceId.N", "description"=>"The list of identifiers of the event sources for which events will be returned", "type"=>"string"}, {"in"=>"query", "name"=>"SourceType", "description"=>"The type of source that will be generating the events", "type"=>"string"}, {"in"=>"query", "name"=>"SubscriptionName", "description"=>"The name of the subscription", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Subscriptions"]}}, "/?Action=CreateOptionGroup"=>{"get"=>{"summary"=>"Create Option Group", "description"=>"Creates a new option group.", "operationId"=>"createoptiongroup", "x-api-path-slug"=>"actioncreateoptiongroup-get", "parameters"=>[{"in"=>"query", "name"=>"EngineName", "description"=>"Specifies the name of the engine that this option group should be associated with", "type"=>"string"}, {"in"=>"query", "name"=>"MajorEngineVersion", "description"=>"Specifies the major version of the engine that this option group should be associated with", "type"=>"string"}, {"in"=>"query", "name"=>"OptionGroupDescription", "description"=>"The description of the option group", "type"=>"string"}, {"in"=>"query", "name"=>"OptionGroupName", "description"=>"Specifies the name of the option group to be created", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Option Groups"]}}, "/?Action=DeleteDBCluster"=>{"get"=>{"summary"=>"Delete D B Cluster", "description"=>"The DeleteDBCluster action deletes a previously provisioned DB cluster.", "operationId"=>"deletedbcluster", "x-api-path-slug"=>"actiondeletedbcluster-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterIdentifier", "description"=>"The DB cluster identifier for the DB cluster to be deleted", "type"=>"string"}, {"in"=>"query", "name"=>"FinalDBSnapshotIdentifier", "description"=>"The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false", "type"=>"string"}, {"in"=>"query", "name"=>"SkipFinalSnapshot", "description"=>"Determines whether a final DB cluster snapshot is created before the DB cluster is deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=DeleteDBClusterParameterGroup"=>{"get"=>{"summary"=>"Delete D B Cluster Parameter Group", "description"=>"Deletes a specified DB cluster parameter group.", "operationId"=>"deletedbclusterparametergroup", "x-api-path-slug"=>"actiondeletedbclusterparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterParameterGroupName", "description"=>"The name of the DB cluster parameter group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Parameter Groups"]}}, "/?Action=DeleteDBClusterSnapshot"=>{"get"=>{"summary"=>"Delete D B Cluster Snapshot", "description"=>"Deletes a DB cluster snapshot.", "operationId"=>"deletedbclustersnapshot", "x-api-path-slug"=>"actiondeletedbclustersnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterSnapshotIdentifier", "description"=>"The identifier of the DB cluster snapshot to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Snapshots"]}}, "/?Action=DeleteDBInstance"=>{"get"=>{"summary"=>"Delete D B Instance", "description"=>"The DeleteDBInstance action deletes a previously provisioned DB instance.", "operationId"=>"deletedbinstance", "x-api-path-slug"=>"actiondeletedbinstance-get", "parameters"=>[{"in"=>"query", "name"=>"DBInstanceIdentifier", "description"=>"The DB instance identifier for the DB instance to be deleted", "type"=>"string"}, {"in"=>"query", "name"=>"FinalDBSnapshotIdentifier", "description"=>"The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false", "type"=>"string"}, {"in"=>"query", "name"=>"SkipFinalSnapshot", "description"=>"Determines whether a final DB snapshot is created before the DB instance is deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=DeleteDBParameterGroup"=>{"get"=>{"summary"=>"Delete D B Parameter Group", "description"=>"Deletes a specified DBParameterGroup.", "operationId"=>"deletedbparametergroup", "x-api-path-slug"=>"actiondeletedbparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"DBParameterGroupName", "description"=>"The name of the DB parameter group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameter Groups"]}}, "/?Action=DeleteDBSecurityGroup"=>{"get"=>{"summary"=>"Delete D B Security Group", "description"=>"Deletes a DB security group.", "operationId"=>"deletedbsecuritygroup", "x-api-path-slug"=>"actiondeletedbsecuritygroup-get", "parameters"=>[{"in"=>"query", "name"=>"DBSecurityGroupName", "description"=>"The name of the DB security group to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Groups"]}}, "/?Action=DeleteDBSnapshot"=>{"get"=>{"summary"=>"Delete D B Snapshot", "description"=>"Deletes a DBSnapshot.", "operationId"=>"deletedbsnapshot", "x-api-path-slug"=>"actiondeletedbsnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"DBSnapshotIdentifier", "description"=>"The DBSnapshot identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=DeleteDBSubnetGroup"=>{"get"=>{"summary"=>"Delete D B Subnet Group", "description"=>"Deletes a DB subnet group.", "operationId"=>"deletedbsubnetgroup", "x-api-path-slug"=>"actiondeletedbsubnetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"DBSubnetGroupName", "description"=>"The name of the database subnet group to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnet Groups"]}}, "/?Action=DeleteEventSubscription"=>{"get"=>{"summary"=>"Delete Event Subscription", "description"=>"Deletes an RDS event notification subscription.", "operationId"=>"deleteeventsubscription", "x-api-path-slug"=>"actiondeleteeventsubscription-get", "parameters"=>[{"in"=>"query", "name"=>"SubscriptionName", "description"=>"The name of the RDS event notification subscription you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Subscriptions"]}}, "/?Action=DeleteOptionGroup"=>{"get"=>{"summary"=>"Delete Option Group", "description"=>"Deletes an existing option group.", "operationId"=>"deleteoptiongroup", "x-api-path-slug"=>"actiondeleteoptiongroup-get", "parameters"=>[{"in"=>"query", "name"=>"OptionGroupName", "description"=>"The name of the option group to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Option Groups"]}}, "/?Action=DescribeAccountAttributes"=>{"get"=>{"summary"=>"Describe Account Attributes", "description"=>"Lists all of the attributes for a customer account.", "operationId"=>"describeaccountattributes", "x-api-path-slug"=>"actiondescribeaccountattributes-get", "parameters"=>[{"in"=>"query", "name"=>"AccountQuotas.AccountQuota.N", "description"=>"A list of AccountQuota objects", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/?Action=DescribeCertificates"=>{"get"=>{"summary"=>"Describe Certificates", "description"=>"Lists the set of CA certificates provided by Amazon RDS for this AWS account.", "operationId"=>"describecertificates", "x-api-path-slug"=>"actiondescribecertificates-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateIdentifier", "description"=>"The user-supplied certificate identifier", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeCertificates request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=DescribeDBClusterParameterGroups"=>{"get"=>{"summary"=>"Describe D B Cluster Parameter Groups", "description"=>"Returns a list of DBClusterParameterGroup descriptions.", "operationId"=>"describedbclusterparametergroups", "x-api-path-slug"=>"actiondescribedbclusterparametergroups-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterParameterGroupName", "description"=>"The name of a specific DB cluster parameter group to return details for", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeDBClusterParameterGroups request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Parameter Groups"]}}, "/?Action=DescribeDBClusterParameters"=>{"get"=>{"summary"=>"Describe D B Cluster Parameters", "description"=>"Returns the detailed parameter list for a particular DB cluster parameter group.", "operationId"=>"describedbclusterparameters", "x-api-path-slug"=>"actiondescribedbclusterparameters-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterParameterGroupName", "description"=>"The name of a specific DB cluster parameter group to return parameter details for", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeDBClusterParameters request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"Source", "description"=>"A value that indicates to return only parameters for a specific source", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Parameters"]}}, "/?Action=DescribeDBClusters"=>{"get"=>{"summary"=>"Describe D B Clusters", "description"=>"Returns information about provisioned Aurora DB clusters.", "operationId"=>"describedbclusters", "x-api-path-slug"=>"actiondescribedbclusters-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterIdentifier", "description"=>"The user-supplied DB cluster identifier", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"A filter that specifies one or more DB clusters to describe", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeDBClusters request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=DescribeDBClusterSnapshotAttributes"=>{"get"=>{"summary"=>"Describe D B Cluster Snapshot Attributes", "description"=>"Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.", "operationId"=>"describedbclustersnapshotattributes", "x-api-path-slug"=>"actiondescribedbclustersnapshotattributes-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterSnapshotIdentifier", "description"=>"The identifier for the DB cluster snapshot to describe the attributes for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Snapshots"]}}, "/?Action=DescribeDBClusterSnapshots"=>{"get"=>{"summary"=>"Describe D B Cluster Snapshots", "description"=>"Returns information about DB cluster snapshots.", "operationId"=>"describedbclustersnapshots", "x-api-path-slug"=>"actiondescribedbclustersnapshots-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterIdentifier", "description"=>"The ID of the DB cluster to retrieve the list of DB cluster snapshots for", "type"=>"string"}, {"in"=>"query", "name"=>"DBClusterSnapshotIdentifier", "description"=>"A specific DB cluster snapshot identifier to describe", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"IncludePublic", "description"=>"Set this value to true to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false", "type"=>"string"}, {"in"=>"query", "name"=>"IncludeShared", "description"=>"Set this value to true to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeDBClusterSnapshots request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotType", "description"=>"The type of DB cluster snapshots to be returned", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Snapshots"]}}, "/?Action=DescribeDBEngineVersions"=>{"get"=>{"summary"=>"Describe D B Engine Versions", "description"=>"Returns a list of the available DB engines.", "operationId"=>"describedbengineversions", "x-api-path-slug"=>"actiondescribedbengineversions-get", "parameters"=>[{"in"=>"query", "name"=>"DBParameterGroupFamily", "description"=>"The name of a specific DB parameter group family to return details for", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultOnly", "description"=>"Indicates that only the default version of the specified engine or engine and major version combination is returned", "type"=>"string"}, {"in"=>"query", "name"=>"Engine", "description"=>"The database engine to return", "type"=>"string"}, {"in"=>"query", "name"=>"EngineVersion", "description"=>"The database engine version to return", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"Not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"ListSupportedCharacterSets", "description"=>"If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version", "type"=>"string"}, {"in"=>"query", "name"=>"ListSupportedTimezones", "description"=>"If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Engines"]}}, "/?Action=DescribeDBInstances"=>{"get"=>{"summary"=>"Describe D B Instances", "description"=>"Returns information about provisioned RDS instances.", "operationId"=>"describedbinstances", "x-api-path-slug"=>"actiondescribedbinstances-get", "parameters"=>[{"in"=>"query", "name"=>"DBInstanceIdentifier", "description"=>"The user-supplied instance identifier", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"A filter that specifies one or more DB instances to describe", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeDBInstances request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=DescribeDBLogFiles"=>{"get"=>{"summary"=>"Describe D B Log Files", "description"=>"Returns a list of DB log files for the DB instance.", "operationId"=>"describedblogfiles", "x-api-path-slug"=>"actiondescribedblogfiles-get", "parameters"=>[{"in"=>"query", "name"=>"DBInstanceIdentifier", "description"=>"The customer-assigned name of the DB instance that contains the log files you want to list", "type"=>"string"}, {"in"=>"query", "name"=>"FileLastWritten", "description"=>"Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds", "type"=>"string"}, {"in"=>"query", "name"=>"FilenameContains", "description"=>"Filters the available log files for log file names that contain the specified string", "type"=>"string"}, {"in"=>"query", "name"=>"FileSize", "description"=>"Filters the available log files for files larger than the specified size", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"The pagination token provided in the previous request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog Files"]}}, "/?Action=DescribeDBParameterGroups"=>{"get"=>{"summary"=>"Describe D B Parameter Groups", "description"=>"Returns a list of DBParameterGroup descriptions.", "operationId"=>"describedbparametergroups", "x-api-path-slug"=>"actiondescribedbparametergroups-get", "parameters"=>[{"in"=>"query", "name"=>"DBParameterGroupName", "description"=>"The name of a specific DB parameter group to return details for", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeDBParameterGroups request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameter Groups"]}}, "/?Action=DescribeDBParameters"=>{"get"=>{"summary"=>"Describe D B Parameters", "description"=>"Returns the detailed parameter list for a particular DB parameter group.", "operationId"=>"describedbparameters", "x-api-path-slug"=>"actiondescribedbparameters-get", "parameters"=>[{"in"=>"query", "name"=>"DBParameterGroupName", "description"=>"The name of a specific DB parameter group to return details for", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeDBParameters request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"Source", "description"=>"The parameter types to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters"]}}, "/?Action=DescribeDBSecurityGroups"=>{"get"=>{"summary"=>"Describe D B Security Groups", "description"=>"Returns a list of DBSecurityGroup descriptions.", "operationId"=>"describedbsecuritygroups", "x-api-path-slug"=>"actiondescribedbsecuritygroups-get", "parameters"=>[{"in"=>"query", "name"=>"DBSecurityGroupName", "description"=>"The name of the DB security group to return details for", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeDBSecurityGroups request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Groups"]}}, "/?Action=DescribeDBSnapshotAttributes"=>{"get"=>{"summary"=>"Describe D B Snapshot Attributes", "description"=>"Returns a list of DB snapshot attribute names and values for a manual DB snapshot.", "operationId"=>"describedbsnapshotattributes", "x-api-path-slug"=>"actiondescribedbsnapshotattributes-get", "parameters"=>[{"in"=>"query", "name"=>"DBSnapshotIdentifier", "description"=>"The identifier for the DB snapshot to describe the attributes for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=DescribeDBSnapshots"=>{"get"=>{"summary"=>"Describe D B Snapshots", "description"=>"Returns information about DB snapshots.", "operationId"=>"describedbsnapshots", "x-api-path-slug"=>"actiondescribedbsnapshots-get", "parameters"=>[{"in"=>"query", "name"=>"DBInstanceIdentifier", "description"=>"The ID of the DB instance to retrieve the list of DB snapshots for", "type"=>"string"}, {"in"=>"query", "name"=>"DBSnapshotIdentifier", "description"=>"A specific DB snapshot identifier to describe", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"IncludePublic", "description"=>"Set this value to true to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false", "type"=>"string"}, {"in"=>"query", "name"=>"IncludeShared", "description"=>"Set this value to true to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeDBSnapshots request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotType", "description"=>"The type of snapshots to be returned", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=DescribeDBSubnetGroups"=>{"get"=>{"summary"=>"Describe D B Subnet Groups", "description"=>"Returns a list of DBSubnetGroup descriptions.", "operationId"=>"describedbsubnetgroups", "x-api-path-slug"=>"actiondescribedbsubnetgroups-get", "parameters"=>[{"in"=>"query", "name"=>"DBSubnetGroupName", "description"=>"The name of the DB subnet group to return details for", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeDBSubnetGroups request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnet Groups"]}}, "/?Action=DescribeEngineDefaultClusterParameters"=>{"get"=>{"summary"=>"Describe Engine Default Cluster Parameters", "description"=>"Returns the default engine and system parameter information for the cluster database engine.", "operationId"=>"describeenginedefaultclusterparameters", "x-api-path-slug"=>"actiondescribeenginedefaultclusterparameters-get", "parameters"=>[{"in"=>"query", "name"=>"DBParameterGroupFamily", "description"=>"The name of the DB cluster parameter group family to return engine parameter information for", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Default Cluster Parameters"]}}, "/?Action=DescribeEngineDefaultParameters"=>{"get"=>{"summary"=>"Describe Engine Default Parameters", "description"=>"Returns the default engine and system parameter information for the specified database engine.", "operationId"=>"describeenginedefaultparameters", "x-api-path-slug"=>"actiondescribeenginedefaultparameters-get", "parameters"=>[{"in"=>"query", "name"=>"DBParameterGroupFamily", "description"=>"The name of the DB parameter group family", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"Not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeEngineDefaultParameters request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Default Parameters"]}}, "/?Action=DescribeEventCategories"=>{"get"=>{"summary"=>"Describe Event Categories", "description"=>"Displays a list of categories for all event source types, or, if specified, for a specified source type.", "operationId"=>"describeeventcategories", "x-api-path-slug"=>"actiondescribeeventcategories-get", "parameters"=>[{"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"SourceType", "description"=>"The type of source that will be generating the events", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Categories"]}}, "/?Action=DescribeEvents"=>{"get"=>{"summary"=>"Describe Events", "description"=>"Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.", "operationId"=>"describeevents", "x-api-path-slug"=>"actiondescribeevents-get", "parameters"=>[{"in"=>"query", "name"=>"Duration", "description"=>"The number of minutes to retrieve events for", "type"=>"string"}, {"in"=>"query", "name"=>"EndTime", "description"=>"The end of the time interval for which to retrieve events, specified in ISO 8601 format", "type"=>"string"}, {"in"=>"query", "name"=>"EventCategories.EventCategory.N", "description"=>"A list of event categories that trigger notifications for a event notification subscription", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeEvents request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"SourceIdentifier", "description"=>"The identifier of the event source for which events will be returned", "type"=>"string"}, {"in"=>"query", "name"=>"SourceType", "description"=>"The event source to retrieve events for", "type"=>"string"}, {"in"=>"query", "name"=>"StartTime", "description"=>"The beginning of the time interval to retrieve events for, specified in ISO 8601 format", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/?Action=DescribeEventSubscriptions"=>{"get"=>{"summary"=>"Describe Event Subscriptions", "description"=>"Lists all the subscription descriptions for a customer account.", "operationId"=>"describeeventsubscriptions", "x-api-path-slug"=>"actiondescribeeventsubscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"SubscriptionName", "description"=>"The name of the RDS event notification subscription you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Subscriptions"]}}, "/?Action=DescribeOptionGroupOptions"=>{"get"=>{"summary"=>"Describe Option Group Options", "description"=>"Describes all available options.", "operationId"=>"describeoptiongroupoptions", "x-api-path-slug"=>"actiondescribeoptiongroupoptions-get", "parameters"=>[{"in"=>"query", "name"=>"EngineName", "description"=>"A required parameter", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"MajorEngineVersion", "description"=>"If specified, filters the results to include only options for the specified major engine version", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Option Groups"]}}, "/?Action=DescribeOptionGroups"=>{"get"=>{"summary"=>"Describe Option Groups", "description"=>"Describes the available option groups.", "operationId"=>"describeoptiongroups", "x-api-path-slug"=>"actiondescribeoptiongroups-get", "parameters"=>[{"in"=>"query", "name"=>"EngineName", "description"=>"Filters the list of option groups to only include groups associated with a specific database engine", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"MajorEngineVersion", "description"=>"Filters the list of option groups to only include groups associated with a specific database engine version", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeOptionGroups request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"OptionGroupName", "description"=>"The name of the option group to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Option Groups"]}}, "/?Action=DescribeOrderableDBInstanceOptions"=>{"get"=>{"summary"=>"Describe Orderable D B Instance Options", "description"=>"Returns a list of orderable DB instance options for the specified engine.", "operationId"=>"describeorderabledbinstanceoptions", "x-api-path-slug"=>"actiondescribeorderabledbinstanceoptions-get", "parameters"=>[{"in"=>"query", "name"=>"DBInstanceClass", "description"=>"The DB instance class filter value", "type"=>"string"}, {"in"=>"query", "name"=>"Engine", "description"=>"The name of the engine to retrieve DB instance options for", "type"=>"string"}, {"in"=>"query", "name"=>"EngineVersion", "description"=>"The engine version filter value", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"LicenseModel", "description"=>"The license model filter value", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"Vpc", "description"=>"The VPC filter value", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=DescribePendingMaintenanceActions"=>{"get"=>{"summary"=>"Describe Pending Maintenance Actions", "description"=>"Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.", "operationId"=>"describependingmaintenanceactions", "x-api-path-slug"=>"actiondescribependingmaintenanceactions-get", "parameters"=>[{"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"A filter that specifies one or more resources to return pending maintenance actions for", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribePendingMaintenanceActions request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceIdentifier", "description"=>"The ARN of a resource to return pending maintenance actions for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance Actions"]}}, "/?Action=DescribeReservedDBInstances"=>{"get"=>{"summary"=>"Describe Reserved D B Instances", "description"=>"Returns information about reserved DB instances for this account, or about a specified reserved DB instance.", "operationId"=>"describereserveddbinstances", "x-api-path-slug"=>"actiondescribereserveddbinstances-get", "parameters"=>[{"in"=>"query", "name"=>"DBInstanceClass", "description"=>"The DB instance class filter value", "type"=>"string"}, {"in"=>"query", "name"=>"Duration", "description"=>"The duration filter value, specified in years or seconds", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"MultiAZ", "description"=>"The Multi-AZ filter value", "type"=>"string"}, {"in"=>"query", "name"=>"OfferingType", "description"=>"The offering type filter value", "type"=>"string"}, {"in"=>"query", "name"=>"ProductDescription", "description"=>"The product description filter value", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedDBInstanceId", "description"=>"The reserved DB instance identifier filter value", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedDBInstancesOfferingId", "description"=>"The offering identifier filter value", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=DescribeReservedDBInstancesOfferings"=>{"get"=>{"summary"=>"Describe Reserved D B Instances Offerings", "description"=>"Lists available reserved DB instance offerings.", "operationId"=>"describereserveddbinstancesofferings", "x-api-path-slug"=>"actiondescribereserveddbinstancesofferings-get", "parameters"=>[{"in"=>"query", "name"=>"DBInstanceClass", "description"=>"The DB instance class filter value", "type"=>"string"}, {"in"=>"query", "name"=>"Duration", "description"=>"Duration filter value, specified in years or seconds", "type"=>"string"}, {"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"MultiAZ", "description"=>"The Multi-AZ filter value", "type"=>"string"}, {"in"=>"query", "name"=>"OfferingType", "description"=>"The offering type filter value", "type"=>"string"}, {"in"=>"query", "name"=>"ProductDescription", "description"=>"Product description filter value", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedDBInstancesOfferingId", "description"=>"The offering identifier filter value", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=DescribeSourceRegions"=>{"get"=>{"summary"=>"Describe Source Regions", "description"=>"Returns a list of the source AWS regions where the current AWS region can create a Read Replica \n or copy a DB snapshot from.", "operationId"=>"describesourceregions", "x-api-path-slug"=>"actiondescribesourceregions-get", "parameters"=>[{"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeSourceRegions request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"RegionName", "description"=>"The source region name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source Regions"]}}, "/?Action=DownloadDBLogFilePortion"=>{"get"=>{"summary"=>"Download D B Log File Portion", "description"=>"Downloads all or a portion of the specified log file, up to 1 MB in size.", "operationId"=>"downloaddblogfileportion", "x-api-path-slug"=>"actiondownloaddblogfileportion-get", "parameters"=>[{"in"=>"query", "name"=>"DBInstanceIdentifier", "description"=>"The customer-assigned name of the DB instance that contains the log files you want to list", "type"=>"string"}, {"in"=>"query", "name"=>"LogFileName", "description"=>"The name of the log file to be downloaded", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"The pagination token provided in the previous request or 0", "type"=>"string"}, {"in"=>"query", "name"=>"NumberOfLines", "description"=>"The number of lines to download", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Log Files"]}}, "/?Action=FailoverDBCluster"=>{"get"=>{"summary"=>"Failover D B Cluster", "description"=>"Forces a failover for a DB cluster.", "operationId"=>"failoverdbcluster", "x-api-path-slug"=>"actionfailoverdbcluster-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterIdentifier", "description"=>"A DB cluster identifier to force a failover for", "type"=>"string"}, {"in"=>"query", "name"=>"TargetDBInstanceIdentifier", "description"=>"The name of the instance to promote to the primary instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=ListTagsForResource"=>{"get"=>{"summary"=>"List Tags For Resource", "description"=>"Lists all tags on an Amazon RDS resource.", "operationId"=>"listtagsforresource", "x-api-path-slug"=>"actionlisttagsforresource-get", "parameters"=>[{"in"=>"query", "name"=>"Filters.Filter.N", "description"=>"This parameter is not currently supported", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceName", "description"=>"The Amazon RDS resource with tags to be listed", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=ModifyDBCluster"=>{"get"=>{"summary"=>"Modify D B Cluster", "description"=>"Modify a setting for an Amazon Aurora DB cluster.", "operationId"=>"modifydbcluster", "x-api-path-slug"=>"actionmodifydbcluster-get", "parameters"=>[{"in"=>"query", "name"=>"ApplyImmediately", "description"=>"A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"BackupRetentionPeriod", "description"=>"The number of days for which automated backups are retained", "type"=>"string"}, {"in"=>"query", "name"=>"DBClusterIdentifier", "description"=>"The DB cluster identifier for the cluster being modified", "type"=>"string"}, {"in"=>"query", "name"=>"DBClusterParameterGroupName", "description"=>"The name of the DB cluster parameter group to use for the DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"MasterUserPassword", "description"=>"The new password for the master database user", "type"=>"string"}, {"in"=>"query", "name"=>"NewDBClusterIdentifier", "description"=>"The new DB cluster identifier for the DB cluster when renaming a DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"OptionGroupName", "description"=>"A value that indicates that the DB cluster should be associated with the specified option group", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port number on which the DB cluster accepts connections", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredBackupWindow", "description"=>"The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredMaintenanceWindow", "description"=>"The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC)", "type"=>"string"}, {"in"=>"query", "name"=>"VpcSecurityGroupIds.VpcSecurityGroupId.N", "description"=>"A lst of VPC security groups that the DB cluster will belong to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=ModifyDBClusterParameterGroup"=>{"get"=>{"summary"=>"Modify D B Cluster Parameter Group", "description"=>"Modifies the parameters of a DB cluster parameter group.", "operationId"=>"modifydbclusterparametergroup", "x-api-path-slug"=>"actionmodifydbclusterparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterParameterGroupName", "description"=>"The name of the DB cluster parameter group to modify", "type"=>"string"}, {"in"=>"query", "name"=>"Parameters.Parameter.N", "description"=>"A list of parameters in the DB cluster parameter group to modify", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Parameter Groups"]}}, "/?Action=ModifyDBClusterSnapshotAttribute"=>{"get"=>{"summary"=>"Modify D B Cluster Snapshot Attribute", "description"=>"Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.", "operationId"=>"modifydbclustersnapshotattribute", "x-api-path-slug"=>"actionmodifydbclustersnapshotattribute-get", "parameters"=>[{"in"=>"query", "name"=>"AttributeName", "description"=>"The name of the DB cluster snapshot attribute to modify", "type"=>"string"}, {"in"=>"query", "name"=>"DBClusterSnapshotIdentifier", "description"=>"The identifier for the DB cluster snapshot to modify the attributes for", "type"=>"string"}, {"in"=>"query", "name"=>"ValuesToAdd.AttributeValue.N", "description"=>"A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName", "type"=>"string"}, {"in"=>"query", "name"=>"ValuesToRemove.AttributeValue.N", "description"=>"A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Snapshots"]}}, "/?Action=ModifyDBInstance"=>{"get"=>{"summary"=>"Modify D B Instance", "description"=>"Modifies settings for a DB instance.", "operationId"=>"modifydbinstance", "x-api-path-slug"=>"actionmodifydbinstance-get", "parameters"=>[{"in"=>"query", "name"=>"AllocatedStorage", "description"=>"The new storage capacity of the RDS instance", "type"=>"string"}, {"in"=>"query", "name"=>"AllowMajorVersionUpgrade", "description"=>"Indicates that major version upgrades are allowed", "type"=>"string"}, {"in"=>"query", "name"=>"ApplyImmediately", "description"=>"Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"AutoMinorVersionUpgrade", "description"=>"Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window", "type"=>"string"}, {"in"=>"query", "name"=>"BackupRetentionPeriod", "description"=>"The number of days to retain automated backups", "type"=>"string"}, {"in"=>"query", "name"=>"CACertificateIdentifier", "description"=>"Indicates the certificate that needs to be associated with the instance", "type"=>"string"}, {"in"=>"query", "name"=>"CopyTagsToSnapshot", "description"=>"True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false", "type"=>"string"}, {"in"=>"query", "name"=>"DBInstanceClass", "description"=>"The new compute and memory capacity of the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"DBInstanceIdentifier", "description"=>"The DB instance identifier", "type"=>"string"}, {"in"=>"query", "name"=>"DBParameterGroupName", "description"=>"The name of the DB parameter group to apply to the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"DBPortNumber", "description"=>"The port number on which the database accepts connections", "type"=>"string"}, {"in"=>"query", "name"=>"DBSecurityGroups.DBSecurityGroupName.N", "description"=>"A list of DB security groups to authorize on this DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"DBSubnetGroupName", "description"=>"The new DB subnet group for the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"Domain", "description"=>"The Active Directory Domain to move the instance to", "type"=>"string"}, {"in"=>"query", "name"=>"DomainIAMRoleName", "description"=>"The name of the IAM role to use when making API calls to the Directory Service", "type"=>"string"}, {"in"=>"query", "name"=>"EngineVersion", "description"=>"The version number of the database engine to upgrade to", "type"=>"string"}, {"in"=>"query", "name"=>"Iops", "description"=>"The new Provisioned IOPS (I/O operations per second) value for the RDS instance", "type"=>"string"}, {"in"=>"query", "name"=>"LicenseModel", "description"=>"The license model for the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"MasterUserPassword", "description"=>"The new password for the DB instance master user", "type"=>"string"}, {"in"=>"query", "name"=>"MonitoringInterval", "description"=>"The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"MonitoringRoleArn", "description"=>"The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs", "type"=>"string"}, {"in"=>"query", "name"=>"MultiAZ", "description"=>"Specifies if the DB instance is a Multi-AZ deployment", "type"=>"string"}, {"in"=>"query", "name"=>"NewDBInstanceIdentifier", "description"=>"The new DB instance identifier for the DB instance when renaming a DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"OptionGroupName", "description"=>"Indicates that the DB instance should be associated with the specified option group", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredBackupWindow", "description"=>"The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredMaintenanceWindow", "description"=>"The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage", "type"=>"string"}, {"in"=>"query", "name"=>"PromotionTier", "description"=>"A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance", "type"=>"string"}, {"in"=>"query", "name"=>"PubliclyAccessible", "description"=>"Boolean value that indicates if the DB instance has a publicly resolvable DNS name", "type"=>"string"}, {"in"=>"query", "name"=>"StorageType", "description"=>"Specifies the storage type to be associated with the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"TdeCredentialArn", "description"=>"The ARN from the Key Store with which to associate the instance for TDE encryption", "type"=>"string"}, {"in"=>"query", "name"=>"TdeCredentialPassword", "description"=>"The password for the given ARN from the Key Store in order to access the device", "type"=>"string"}, {"in"=>"query", "name"=>"VpcSecurityGroupIds.VpcSecurityGroupId.N", "description"=>"A list of EC2 VPC security groups to authorize on this DB instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=ModifyDBParameterGroup"=>{"get"=>{"summary"=>"Modify D B Parameter Group", "description"=>"Modifies the parameters of a DB parameter group.", "operationId"=>"modifydbparametergroup", "x-api-path-slug"=>"actionmodifydbparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"DBParameterGroupName", "description"=>"The name of the DB parameter group", "type"=>"string"}, {"in"=>"query", "name"=>"Parameters.Parameter.N", "description"=>"An array of parameter names, values, and the apply method for the parameter update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameter Groups"]}}, "/?Action=ModifyDBSnapshotAttribute"=>{"get"=>{"summary"=>"Modify D B Snapshot Attribute", "description"=>"Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.", "operationId"=>"modifydbsnapshotattribute", "x-api-path-slug"=>"actionmodifydbsnapshotattribute-get", "parameters"=>[{"in"=>"query", "name"=>"AttributeName", "description"=>"The name of the DB snapshot attribute to modify", "type"=>"string"}, {"in"=>"query", "name"=>"DBSnapshotIdentifier", "description"=>"The identifier for the DB snapshot to modify the attributes for", "type"=>"string"}, {"in"=>"query", "name"=>"ValuesToAdd.AttributeValue.N", "description"=>"A list of DB snapshot attributes to add to the attribute specified by AttributeName", "type"=>"string"}, {"in"=>"query", "name"=>"ValuesToRemove.AttributeValue.N", "description"=>"A list of DB snapshot attributes to remove from the attribute specified by AttributeName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=ModifyDBSubnetGroup"=>{"get"=>{"summary"=>"Modify D B Subnet Group", "description"=>"Modifies an existing DB subnet group.", "operationId"=>"modifydbsubnetgroup", "x-api-path-slug"=>"actionmodifydbsubnetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"DBSubnetGroupDescription", "description"=>"The description for the DB subnet group", "type"=>"string"}, {"in"=>"query", "name"=>"DBSubnetGroupName", "description"=>"The name for the DB subnet group", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetIds.SubnetIdentifier.N", "description"=>"The EC2 subnet IDs for the DB subnet group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnet Groups"]}}, "/?Action=ModifyEventSubscription"=>{"get"=>{"summary"=>"Modify Event Subscription", "description"=>"Modifies an existing RDS event notification subscription.", "operationId"=>"modifyeventsubscription", "x-api-path-slug"=>"actionmodifyeventsubscription-get", "parameters"=>[{"in"=>"query", "name"=>"Enabled", "description"=>"A Boolean value; set to true to activate the subscription", "type"=>"string"}, {"in"=>"query", "name"=>"EventCategories.EventCategory.N", "description"=>"A list of event categories for a SourceType that you want to subscribe to", "type"=>"string"}, {"in"=>"query", "name"=>"SnsTopicArn", "description"=>"The Amazon Resource Name (ARN) of the SNS topic created for event notification", "type"=>"string"}, {"in"=>"query", "name"=>"SourceType", "description"=>"The type of source that will be generating the events", "type"=>"string"}, {"in"=>"query", "name"=>"SubscriptionName", "description"=>"The name of the RDS event notification subscription", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Subscriptions"]}}, "/?Action=ModifyOptionGroup"=>{"get"=>{"summary"=>"Modify Option Group", "description"=>"Modifies an existing option group.", "operationId"=>"modifyoptiongroup", "x-api-path-slug"=>"actionmodifyoptiongroup-get", "parameters"=>[{"in"=>"query", "name"=>"ApplyImmediately", "description"=>"Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group", "type"=>"string"}, {"in"=>"query", "name"=>"OptionGroupName", "description"=>"The name of the option group to be modified", "type"=>"string"}, {"in"=>"query", "name"=>"OptionsToInclude.OptionConfiguration.N", "description"=>"Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration", "type"=>"string"}, {"in"=>"query", "name"=>"OptionsToRemove.member.N", "description"=>"Options in this list are removed from the option group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Option Groups"]}}, "/?Action=PromoteReadReplica"=>{"get"=>{"summary"=>"Promote Read Replica", "description"=>"Promotes a Read Replica DB instance to a standalone DB instance.", "operationId"=>"promotereadreplica", "x-api-path-slug"=>"actionpromotereadreplica-get", "parameters"=>[{"in"=>"query", "name"=>"BackupRetentionPeriod", "description"=>"The number of days to retain automated backups", "type"=>"string"}, {"in"=>"query", "name"=>"DBInstanceIdentifier", "description"=>"The DB instance identifier", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredBackupWindow", "description"=>"The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replicas"]}}, "/?Action=PromoteReadReplicaDBCluster"=>{"get"=>{"summary"=>"Promote Read Replica D B Cluster", "description"=>"Promotes a Read Replica DB cluster to a standalone DB cluster.", "operationId"=>"promotereadreplicadbcluster", "x-api-path-slug"=>"actionpromotereadreplicadbcluster-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterIdentifier", "description"=>"The identifier of the DB cluster Read Replica to promote", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replicas"]}}, "/?Action=PurchaseReservedDBInstancesOffering"=>{"get"=>{"summary"=>"Purchase Reserved D B Instances Offering", "description"=>"Purchases a reserved DB instance offering.", "operationId"=>"purchasereserveddbinstancesoffering", "x-api-path-slug"=>"actionpurchasereserveddbinstancesoffering-get", "parameters"=>[{"in"=>"query", "name"=>"DBInstanceCount", "description"=>"The number of instances to reserve", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedDBInstanceId", "description"=>"Customer-specified identifier to track this reservation", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedDBInstancesOfferingId", "description"=>"The ID of the Reserved DB instance offering to purchase", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=RebootDBInstance"=>{"get"=>{"summary"=>"Reboot D B Instance", "description"=>"Rebooting a DB instance restarts the database engine service.", "operationId"=>"rebootdbinstance", "x-api-path-slug"=>"actionrebootdbinstance-get", "parameters"=>[{"in"=>"query", "name"=>"DBInstanceIdentifier", "description"=>"The DB instance identifier", "type"=>"string"}, {"in"=>"query", "name"=>"ForceFailover", "description"=>"When true, the reboot will be conducted through a MultiAZ failover", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=RemoveRoleFromDBCluster"=>{"get"=>{"summary"=>"Remove Role From D B Cluster", "description"=>"Disassociates an Identity and Access Management (IAM) role from an Aurora DB cluster.", "operationId"=>"removerolefromdbcluster", "x-api-path-slug"=>"actionremoverolefromdbcluster-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterIdentifier", "description"=>"The name of the DB cluster to disassociate the IAM role rom", "type"=>"string"}, {"in"=>"query", "name"=>"RoleArn", "description"=>"The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=RemoveSourceIdentifierFromSubscription"=>{"get"=>{"summary"=>"Remove Source Identifier From Subscription", "description"=>"Removes a source identifier from an existing RDS event notification subscription.", "operationId"=>"removesourceidentifierfromsubscription", "x-api-path-slug"=>"actionremovesourceidentifierfromsubscription-get", "parameters"=>[{"in"=>"query", "name"=>"SourceIdentifier", "description"=>"The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group", "type"=>"string"}, {"in"=>"query", "name"=>"SubscriptionName", "description"=>"The name of the RDS event notification subscription you want to remove a source identifier from", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/?Action=RemoveTagsFromResource"=>{"get"=>{"summary"=>"Remove Tags From Resource", "description"=>"Removes metadata tags from an Amazon RDS resource.", "operationId"=>"removetagsfromresource", "x-api-path-slug"=>"actionremovetagsfromresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceName", "description"=>"The Amazon RDS resource the tags will be removed from", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys.member.N", "description"=>"The tag key (name) of the tag to be removed", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=ResetDBClusterParameterGroup"=>{"get"=>{"summary"=>"Reset D B Cluster Parameter Group", "description"=>"Modifies the parameters of a DB cluster parameter group to the default value.", "operationId"=>"resetdbclusterparametergroup", "x-api-path-slug"=>"actionresetdbclusterparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterParameterGroupName", "description"=>"The name of the DB cluster parameter group to reset", "type"=>"string"}, {"in"=>"query", "name"=>"Parameters.Parameter.N", "description"=>"A list of parameter names in the DB cluster parameter group to reset to the default values", "type"=>"string"}, {"in"=>"query", "name"=>"ResetAllParameters", "description"=>"A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Parameter Groups"]}}, "/?Action=ResetDBParameterGroup"=>{"get"=>{"summary"=>"Reset D B Parameter Group", "description"=>"Modifies the parameters of a DB parameter group to the engine/system default value.", "operationId"=>"resetdbparametergroup", "x-api-path-slug"=>"actionresetdbparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"DBParameterGroupName", "description"=>"The name of the DB parameter group", "type"=>"string"}, {"in"=>"query", "name"=>"Parameters.Parameter.N", "description"=>"An array of parameter names, values, and the apply method for the parameter update", "type"=>"string"}, {"in"=>"query", "name"=>"ResetAllParameters", "description"=>"Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameter Groups"]}}, "/?Action=RestoreDBClusterFromS3"=>{"get"=>{"summary"=>"Restore D B Cluster From S3", "description"=>"Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket.", "operationId"=>"restoredbclusterfroms3", "x-api-path-slug"=>"actionrestoredbclusterfroms3-get", "parameters"=>[{"in"=>"query", "name"=>"AvailabilityZones.AvailabilityZone.N", "description"=>"A list of EC2 Availability Zones that instances in the restored DB cluster can be created in", "type"=>"string"}, {"in"=>"query", "name"=>"BackupRetentionPeriod", "description"=>"The number of days for which automated backups of the restored DB cluster are retained", "type"=>"string"}, {"in"=>"query", "name"=>"CharacterSetName", "description"=>"A value that indicates that the restored DB cluster should be associated with the specified CharacterSet", "type"=>"string"}, {"in"=>"query", "name"=>"DatabaseName", "description"=>"The database name for the restored DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"DBClusterIdentifier", "description"=>"The name of the DB cluster to create from the source data in the S3 bucket", "type"=>"string"}, {"in"=>"query", "name"=>"DBClusterParameterGroupName", "description"=>"The name of the DB cluster parameter group to associate with the restored DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"DBSubnetGroupName", "description"=>"A DB subnet group to associate with the restored DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"Engine", "description"=>"The name of the database engine to be used for the restored DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"EngineVersion", "description"=>"The version number of the database engine to use", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyId", "description"=>"The KMS key identifier for an encrypted DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"MasterUsername", "description"=>"The name of the master user for the restored DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"MasterUserPassword", "description"=>"The password for the master database user", "type"=>"string"}, {"in"=>"query", "name"=>"OptionGroupName", "description"=>"A value that indicates that the restored DB cluster should be associated with the specified option group", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port number on which the instances in the restored DB cluster accept connections", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredBackupWindow", "description"=>"The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredMaintenanceWindow", "description"=>"The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC)", "type"=>"string"}, {"in"=>"query", "name"=>"S3BucketName", "description"=>"The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"S3IngestionRoleArn", "description"=>"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf", "type"=>"string"}, {"in"=>"query", "name"=>"S3Prefix", "description"=>"The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"SourceEngine", "description"=>"The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket", "type"=>"string"}, {"in"=>"query", "name"=>"SourceEngineVersion", "description"=>"The version of the database that the backup files were created from", "type"=>"string"}, {"in"=>"query", "name"=>"StorageEncrypted", "description"=>"Specifies whether the restored DB cluster is encrypted", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}, {"in"=>"query", "name"=>"VpcSecurityGroupIds.VpcSecurityGroupId.N", "description"=>"A list of EC2 VPC security groups to associate with the restored DB cluster", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=RestoreDBClusterFromSnapshot"=>{"get"=>{"summary"=>"Restore D B Cluster From Snapshot", "description"=>"Creates a new DB cluster from a DB cluster snapshot.", "operationId"=>"restoredbclusterfromsnapshot", "x-api-path-slug"=>"actionrestoredbclusterfromsnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"AvailabilityZones.AvailabilityZone.N", "description"=>"Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in", "type"=>"string"}, {"in"=>"query", "name"=>"DatabaseName", "description"=>"The database name for the restored DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"DBClusterIdentifier", "description"=>"The name of the DB cluster to create from the DB cluster snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"DBSubnetGroupName", "description"=>"The name of the DB subnet group to use for the new DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"Engine", "description"=>"The database engine to use for the new DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"EngineVersion", "description"=>"The version of the database engine to use for the new DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyId", "description"=>"The KMS key identifier to use when restoring an encrypted DB cluster from a DB cluster snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"OptionGroupName", "description"=>"The name of the option group to use for the restored DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port number on which the new DB cluster accepts connections", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotIdentifier", "description"=>"The identifier for the DB cluster snapshot to restore from", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"The tags to be assigned to the restored DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"VpcSecurityGroupIds.VpcSecurityGroupId.N", "description"=>"A list of VPC security groups that the new DB cluster will belong to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=RestoreDBClusterToPointInTime"=>{"get"=>{"summary"=>"Restore D B Cluster To Point In Time", "description"=>"Restores a DB cluster to an arbitrary point in time.", "operationId"=>"restoredbclustertopointintime", "x-api-path-slug"=>"actionrestoredbclustertopointintime-get", "parameters"=>[{"in"=>"query", "name"=>"DBClusterIdentifier", "description"=>"The name of the new DB cluster to be created", "type"=>"string"}, {"in"=>"query", "name"=>"DBSubnetGroupName", "description"=>"The DB subnet group name to use for the new DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyId", "description"=>"The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"OptionGroupName", "description"=>"The name of the option group for the new DB cluster", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port number on which the new DB cluster accepts connections", "type"=>"string"}, {"in"=>"query", "name"=>"RestoreToTime", "description"=>"The date and time to restore the DB cluster to", "type"=>"string"}, {"in"=>"query", "name"=>"SourceDBClusterIdentifier", "description"=>"The identifier of the source DB cluster from which to restore", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}, {"in"=>"query", "name"=>"UseLatestRestorableTime", "description"=>"A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise", "type"=>"string"}, {"in"=>"query", "name"=>"VpcSecurityGroupIds.VpcSecurityGroupId.N", "description"=>"A lst of VPC security groups that the new DB cluster belongs to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=RestoreDBInstanceFromDBSnapshot"=>{"get"=>{"summary"=>"Restore D B Instance From D B Snapshot", "description"=>"Creates a new DB instance from a DB snapshot.", "operationId"=>"restoredbinstancefromdbsnapshot", "x-api-path-slug"=>"actionrestoredbinstancefromdbsnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"AutoMinorVersionUpgrade", "description"=>"Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window", "type"=>"string"}, {"in"=>"query", "name"=>"AvailabilityZone", "description"=>"The EC2 Availability Zone that the database instance will be created in", "type"=>"string"}, {"in"=>"query", "name"=>"CopyTagsToSnapshot", "description"=>"True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false", "type"=>"string"}, {"in"=>"query", "name"=>"DBInstanceClass", "description"=>"The compute and memory capacity of the Amazon RDS DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"DBInstanceIdentifier", "description"=>"Name of the DB instance to create from the DB snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"DBName", "description"=>"The database name for the restored DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"DBSnapshotIdentifier", "description"=>"The identifier for the DB snapshot to restore from", "type"=>"string"}, {"in"=>"query", "name"=>"DBSubnetGroupName", "description"=>"The DB subnet group name to use for the new instance", "type"=>"string"}, {"in"=>"query", "name"=>"Domain", "description"=>"Specify the Active Directory Domain to restore the instance in", "type"=>"string"}, {"in"=>"query", "name"=>"DomainIAMRoleName", "description"=>"Specify the name of the IAM role to be used when making API calls to the Directory Service", "type"=>"string"}, {"in"=>"query", "name"=>"Engine", "description"=>"The database engine to use for the new instance", "type"=>"string"}, {"in"=>"query", "name"=>"Iops", "description"=>"Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second", "type"=>"string"}, {"in"=>"query", "name"=>"LicenseModel", "description"=>"License model information for the restored DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"MultiAZ", "description"=>"Specifies if the DB instance is a Multi-AZ deployment", "type"=>"string"}, {"in"=>"query", "name"=>"OptionGroupName", "description"=>"The name of the option group to be used for the restored DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port number on which the database accepts connections", "type"=>"string"}, {"in"=>"query", "name"=>"PubliclyAccessible", "description"=>"Specifies the accessibility options for the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"StorageType", "description"=>"Specifies the storage type to be associated with the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}, {"in"=>"query", "name"=>"TdeCredentialArn", "description"=>"The ARN from the Key Store with which to associate the instance for TDE encryption", "type"=>"string"}, {"in"=>"query", "name"=>"TdeCredentialPassword", "description"=>"The password for the given ARN from the Key Store in order to access the device", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=RestoreDBInstanceToPointInTime"=>{"get"=>{"summary"=>"Restore D B Instance To Point In Time", "description"=>"Restores a DB instance to an arbitrary point in time.", "operationId"=>"restoredbinstancetopointintime", "x-api-path-slug"=>"actionrestoredbinstancetopointintime-get", "parameters"=>[{"in"=>"query", "name"=>"AutoMinorVersionUpgrade", "description"=>"Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window", "type"=>"string"}, {"in"=>"query", "name"=>"AvailabilityZone", "description"=>"The EC2 Availability Zone that the database instance will be created in", "type"=>"string"}, {"in"=>"query", "name"=>"CopyTagsToSnapshot", "description"=>"True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false", "type"=>"string"}, {"in"=>"query", "name"=>"DBInstanceClass", "description"=>"The compute and memory capacity of the Amazon RDS DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"DBName", "description"=>"The database name for the restored DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"DBSubnetGroupName", "description"=>"The DB subnet group name to use for the new instance", "type"=>"string"}, {"in"=>"query", "name"=>"Domain", "description"=>"Specify the Active Directory Domain to restore the instance in", "type"=>"string"}, {"in"=>"query", "name"=>"DomainIAMRoleName", "description"=>"Specify the name of the IAM role to be used when making API calls to the Directory Service", "type"=>"string"}, {"in"=>"query", "name"=>"Engine", "description"=>"The database engine to use for the new instance", "type"=>"string"}, {"in"=>"query", "name"=>"Iops", "description"=>"The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"LicenseModel", "description"=>"License model information for the restored DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"MultiAZ", "description"=>"Specifies if the DB instance is a Multi-AZ deployment", "type"=>"string"}, {"in"=>"query", "name"=>"OptionGroupName", "description"=>"The name of the option group to be used for the restored DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port number on which the database accepts connections", "type"=>"string"}, {"in"=>"query", "name"=>"PubliclyAccessible", "description"=>"Specifies the accessibility options for the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"RestoreTime", "description"=>"The date and time to restore from", "type"=>"string"}, {"in"=>"query", "name"=>"SourceDBInstanceIdentifier", "description"=>"The identifier of the source DB instance from which to restore", "type"=>"string"}, {"in"=>"query", "name"=>"StorageType", "description"=>"Specifies the storage type to be associated with the DB instance", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tags", "type"=>"string"}, {"in"=>"query", "name"=>"TargetDBInstanceIdentifier", "description"=>"The name of the new database instance to be created", "type"=>"string"}, {"in"=>"query", "name"=>"TdeCredentialArn", "description"=>"The ARN from the Key Store with which to associate the instance for TDE encryption", "type"=>"string"}, {"in"=>"query", "name"=>"TdeCredentialPassword", "description"=>"The password for the given ARN from the Key Store in order to access the device", "type"=>"string"}, {"in"=>"query", "name"=>"UseLatestRestorableTime", "description"=>"Specifies whether (true) or not (false) the DB instance is restored from the latest backup time", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=RevokeDBSecurityGroupIngress"=>{"get"=>{"summary"=>"Revoke D B Security Group Ingress", "description"=>"Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups.", "operationId"=>"revokedbsecuritygroupingress", "x-api-path-slug"=>"actionrevokedbsecuritygroupingress-get", "parameters"=>[{"in"=>"query", "name"=>"CIDRIP", "description"=>"The IP range to revoke access from", "type"=>"string"}, {"in"=>"query", "name"=>"DBSecurityGroupName", "description"=>"The name of the DB security group to revoke ingress from", "type"=>"string"}, {"in"=>"query", "name"=>"EC2SecurityGroupId", "description"=>"The id of the EC2 security group to revoke access from", "type"=>"string"}, {"in"=>"query", "name"=>"EC2SecurityGroupName", "description"=>"The name of the EC2 security group to revoke access from", "type"=>"string"}, {"in"=>"query", "name"=>"EC2SecurityGroupOwnerId", "description"=>"The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Groups"]}}}}, "apis"=>{"name"=>"AWS RDS", "x-slug"=>"aws-rds", "description"=>"Amazon Relational Database Service (Amazon RDS) makes it easy to set up, operate, and scale arelational databasein the cloud. It provides cost-efficient and resizable capacity while managing time-consuming database administration tasks, freeing you up to focus on your applications and business. Amazon RDS provides you six familiar database engines to choose from, includingAmazon Aurora,PostgreSQL,MySQL,MariaDB,Oracle, andMicrosoft SQL Server.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Database_AmazonRDS.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Databases,Profiles,Relative Data,Service API,Stack,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-rds/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Amazon RDS API", "x-api-slug"=>"amazon-rds-api", "description"=>"Amazon Relational Database Service (Amazon RDS) makes it easy to set up, operate, and scale arelational databasein the cloud. It provides cost-efficient and resizable capacity while managing time-consuming database administration tasks, freeing you up to focus on your applications and business. Amazon RDS provides you six familiar database engines to choose from, includingAmazon Aurora,PostgreSQL,MySQL,MariaDB,Oracle, andMicrosoft SQL Server.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Database_AmazonRDS.png", "humanURL"=>"https://aws.amazon.com/rds/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Databases,Profiles,Relative Data,Service API,Stack,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-rds/amazon-rds-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-articles", "url"=>"https://aws.amazon.com/articles/Amazon-RDS"}, {"type"=>"x-blog", "url"=>"https://aws.amazon.com/blogs/database/"}, {"type"=>"x-change-log", "url"=>"http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=291"}, {"type"=>"x-code", "url"=>"http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=293"}, {"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/AmazonRDS/latest/CommandLineReference/"}, {"type"=>"x-customer-highlights", "url"=>"https://aws.amazon.com/rds/customers/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/rds/faqs/"}, {"type"=>"x-forum", "url"=>"http://developer.amazonwebservices.com/connect/forum.jspa?forumID=60"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/rds/getting-started/"}, {"type"=>"x-partners", "url"=>"https://aws.amazon.com/rds/partners/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/rds/pricing/"}, {"type"=>"x-service-level-agreement", "url"=>"https://aws.amazon.com/rds/sla/"}, {"type"=>"x-tools", "url"=>"http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=294"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/rds/"}, {"type"=>"x-whats-new", "url"=>"https://aws.amazon.com/rds/whats-new/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
national-snow-and-ice-data-center{"nsidc-web-service-documentation-index-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"National Snow and Ice Data Center", "x-complete"=>1, "info"=>{"title"=>"NSIDC Web Service Documentation Index", "description"=>"this-api-allows-programmers-to-build-national-snow-and-ice-data-center-data-and-metadata-services-into-their-applications-", "version"=>"1.0.0"}, "host"=>"nsidc.org", "basePath"=>"/api/dataset/2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/Facets"=>{"get"=>{"summary"=>"View the facet information corresponding to a search", "description"=>"In the NSIDC Search and Arctic Data Explorer interfaces, this endpoint is used in conjunction with /OpenSearch whenever a user submits a new search. Consequently, it has the same parameters as /OpenSearch.", "operationId"=>"facets", "x-api-path-slug"=>"facets-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"The number of search results per page desired by the client; OpenSearch 1"}, {"in"=>"query", "name"=>"endDate", "description"=>"The end date in yyyy-mm-dd format"}, {"in"=>"query", "name"=>"facetFilters", "description"=>"Describes faceted restrictions on the search"}, {"in"=>"query", "name"=>"searchTerms", "description"=>"URL-encoded keyword or keywords desired by the client; OpenSearch 1"}, {"in"=>"query", "name"=>"sortKeys", "description"=>"Sort the results by most relevant (default), smallest or largest spatial area, shortest or longest temporal duration, or most recently updated; partial implementation of OpenSearch SRU 1"}, {"in"=>"query", "name"=>"source", "description"=>"Custom parameter for selecting which source to use; the Arctic Data Explorer (ADE) uses data aggregated from many sources, including, but not limited to, NSIDC"}, {"in"=>"query", "name"=>"spatial", "description"=>"4 comma separated values - W, S, E, N; OpenSearch-Geo 1"}, {"in"=>"query", "name"=>"startDate", "description"=>"The start date in yyyy-mm-dd format"}, {"in"=>"query", "name"=>"startIndex", "description"=>"First search result desired by the search client; OpenSearch 1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment"]}}, "/OpenSearch"=>{"get"=>{"summary"=>"Search documents using the OpenSearch 1.1 Specification", "description"=>"This endpoint uses parameters from the OpenSearch 1.1 specification, as well as parameters from the OpenSearch Geo (1.0) and SRU (1.0) extensions.", "operationId"=>"OpenSearch.get", "x-api-path-slug"=>"opensearch-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"The number of search results per page desired by the client; OpenSearch 1"}, {"in"=>"query", "name"=>"endDate", "description"=>"The end date in yyyy-mm-dd format"}, {"in"=>"query", "name"=>"facetFilters", "description"=>"Describes faceted restrictions on the search"}, {"in"=>"query", "name"=>"searchTerms", "description"=>"URL-encoded keyword or keywords desired by the client; OpenSearch 1"}, {"in"=>"query", "name"=>"sortKeys", "description"=>"Sort the results by most relevant (default), smallest or largest spatial area, shortest or longest temporal duration, or most recently updated; partial implementation of OpenSearch SRU 1"}, {"in"=>"query", "name"=>"source", "description"=>"Custom parameter for selecting which source to use; the Arctic Data Explorer (ADE) uses data aggregated from many sources, including, but not limited to, NSIDC"}, {"in"=>"query", "name"=>"spatial", "description"=>"4 comma separated values - W, S, E, N; OpenSearch-Geo 1"}, {"in"=>"query", "name"=>"startDate", "description"=>"The start date in yyyy-mm-dd format"}, {"in"=>"query", "name"=>"startIndex", "description"=>"First search result desired by the search client; OpenSearch 1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment"]}}, "/OpenSearchDescription"=>{"get"=>{"summary"=>"Describes the web interface of NSIDC's data search engine", "description"=>"Describes the web interface of NSIDC's data search engine", "operationId"=>"OpenSearchDescription.get", "x-api-path-slug"=>"opensearchdescription-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment"]}}, "/suggest"=>{"get"=>{"summary"=>"Suggest search terms based on a partial query", "description"=>"In NSIDC Search and the Arctic Data Explorer, this endpoint is queried whenever the user types into the search terms box, and the returned suggestions are displayed in a dropdown beneath the search terms box. The q parameter and returned JSON follow the specifications of the OpenSearch Suggestions 1.0 extension.", "operationId"=>"getSuggest", "x-api-path-slug"=>"suggest-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"Search terms typed into the interface (minimum two characters)"}, {"in"=>"query", "name"=>"source", "description"=>"Custom parameter for selecting which source to use; the Arctic Data Explorer (ADE) uses data aggregated from many sources, including, but not limited to, NSIDC"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environment"]}}}}, "apis"=>{"name"=>"National Snow and Ice Data Center", "x-slug"=>"national-snow-and-ice-data-center", "description"=>"NSIDC manages and distributes scientific data, creates tools for data access, supports data users, performs scientific research, and educates the public about the cryosphere.", "image"=>"", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,Environment,General Data,Profiles,Sensors,Water,Weather", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"national-snow-and-ice-data-center/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"NSIDC Web Service Documentation Index", "x-api-slug"=>"nsidc-web-service-documentation-index", "description"=>"NSIDC manages and distributes scientific data, creates tools for data access, supports data users, performs scientific research, and educates the public about the cryosphere.", "image"=>"", "humanURL"=>"http://nsidc.org", "baseURL"=>"https://nsidc.org//api/dataset/2", "tags"=>"API Provider,Environment,General Data,Profiles,Sensors,Water,Weather", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/national-snow-and-ice-data-center/suggest-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/national-snow-and-ice-data-center/nsidc-web-service-documentation-index-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://nsidc.org"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-knowledge-graph-search{"google-knowledge-graph-search-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Knowledge Graph Search", "x-complete"=>1, "info"=>{"title"=>"Knowledge Graph Search", "description"=>"searches-the-google-knowledge-graph-for-entities-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"kgsearch.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/entities:search"=>{"get"=>{"summary"=>"Search Knowledge Graph", "description"=>"Searches Knowledge Graph for entities that match the constraints.\nA list of matched entities will be returned in response, which will be in\nJSON-LD format and compatible with http://schema.org", "operationId"=>"kgsearch.entities.search", "x-api-path-slug"=>"v1entitiessearch-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"The list of entity id to be used for search instead of query string"}, {"in"=>"query", "name"=>"indent", "description"=>"Enables indenting of json results"}, {"in"=>"query", "name"=>"languages", "description"=>"The list of language codes (defined in ISO 693) to run the query with,e"}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of entities to be returned"}, {"in"=>"query", "name"=>"prefix", "description"=>"Enables prefix match against names and aliases of entities"}, {"in"=>"query", "name"=>"query", "description"=>"The literal query string for search"}, {"in"=>"query", "name"=>"types", "description"=>"Restricts returned entities with these types, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Knowledge Graph"]}}}}, "apis"=>{"name"=>"Google Knowledge Graph Search", "x-slug"=>"google-knowledge-graph-search", "description"=>"The Knowledge Graph Search API lets you find entities in the Google Knowledge Graph. The API uses standard schema.org types and is compliant with the JSON-LD specification. Some examples of how you can use the Knowledge Graph Search API include: Getting a ranked list of the most notable entities that match certain criteria. Predictively completing entities in a search box. Annotating/organizing content using the Knowledge Graph entities.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Google-Knowledge-Graph.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Search,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-knowledge-graph-search/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Knowledge Graph Search API", "x-api-slug"=>"google-knowledge-graph-search-api", "description"=>"The Knowledge Graph Search API lets you find entities in the Google Knowledge Graph. The API uses standard schema.org types and is compliant with the JSON-LD specification. Some examples of how you can use the Knowledge Graph Search API include: Getting a ranked list of the most notable entities that match certain criteria. Predictively completing entities in a search box. Annotating/organizing content using the Knowledge Graph entities.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Google-Knowledge-Graph.jpg", "humanURL"=>"https://developers.google.com/knowledge-graph/", "baseURL"=>"://kgsearch.googleapis.com//", "tags"=>"API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Search,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/google-knowledge-graph-search/v1entitiessearch-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/google-knowledge-graph-search/google-knowledge-graph-search-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://developers.google.com/knowledge-graph/how-tos/authorizing"}, {"type"=>"x-code", "url"=>"https://developers.google.com/knowledge-graph/libraries"}, {"type"=>"x-rate-limits", "url"=>"https://developers.google.com/knowledge-graph/reference/rest/v1/usage-limits"}, {"type"=>"x-terms-of-service", "url"=>"https://developers.google.com/knowledge-graph/terms"}, {"type"=>"x-website", "url"=>"https://developers.google.com/knowledge-graph/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-cloudfront{"aws-cloudfront-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS CloudFront", "x-complete"=>1, "info"=>{"title"=>"AWS CloudFront API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=CreateCloudFrontOriginAccessIdentity"=>{"get"=>{"summary"=>"Create Cloud Front Origin Access Identity", "description"=>"Creates a new origin access identity.", "operationId"=>"createCloudFrontOriginAccessIdentity", "x-api-path-slug"=>"actioncreatecloudfrontoriginaccessidentity-get", "parameters"=>[{"in"=>"query", "name"=>"CloudFrontOriginAccessIdentityConfig", "description"=>"The current configuration information for the identity", "type"=>"string"}, {"in"=>"query", "name"=>"CreateCloudFrontOriginAccessIdentityRequest", "description"=>"Root level tag for the CreateCloudFrontOriginAccessIdentityRequest parameters", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId.N", "description"=>"One or more VPCs for which you want to describe the ClassicLink status", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cloud", "Front", "Origin", "Access", "Identity"]}}, "/?Action=CreateDistribution"=>{"get"=>{"summary"=>"Create Distribution", "description"=>"Creates a new web distribution.", "operationId"=>"createDistribution", "x-api-path-slug"=>"actioncreatedistribution-get", "parameters"=>[{"in"=>"query", "name"=>"CreateDistributionRequest", "description"=>"Root level tag for the CreateDistributionRequest parameters", "type"=>"string"}, {"in"=>"query", "name"=>"DistributionConfig", "description"=>"The distributions configuration information", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this request", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"VpcIds.N", "description"=>"One or more VPC IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Distribution"]}}, "/?Action=CreateDistributionWithTags"=>{"get"=>{"summary"=>"Create Distribution With Tags", "description"=>"Create a new distribution with tags.", "operationId"=>"createDistributionWithTags", "x-api-path-slug"=>"actioncreatedistributionwithtags-get", "parameters"=>[{"in"=>"query", "name"=>"CreateDistributionWithTagsRequest", "description"=>"Root level tag for the CreateDistributionWithTagsRequest parameters", "type"=>"string"}, {"in"=>"query", "name"=>"DistributionConfigWithTags", "description"=>"The distributions configuration information", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance to unlink from the VPC", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC to which the instance is linked", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Distribution", "Tags"]}}, "/?Action=CreateInvalidation"=>{"get"=>{"summary"=>"Create Invalidation", "description"=>"Create a new invalidation.", "operationId"=>"createInvalidation", "x-api-path-slug"=>"actioncreateinvalidation-get", "parameters"=>[{"in"=>"query", "name"=>"DistributionId", "description"=>"The distributions id", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invalidation"]}}, "/?Action=CreateStreamingDistribution"=>{"get"=>{"summary"=>"Create Streaming Distribution", "description"=>"Creates a new RMTP distribution.", "operationId"=>"createStreamingDistribution", "x-api-path-slug"=>"actioncreatestreamingdistribution-get", "parameters"=>[{"in"=>"query", "name"=>"CreateStreamingDistributionRequest", "description"=>"Root level tag for the CreateStreamingDistributionRequest parameters", "type"=>"string"}, {"in"=>"query", "name"=>"StreamingDistributionConfig", "description"=>"The streaming distributions configuration information", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Streaming", "Distribution"]}}, "/?Action=CreateStreamingDistributionWithTags"=>{"get"=>{"summary"=>"Create Streaming Distribution With Tags", "description"=>"Create a new streaming distribution with tags.", "operationId"=>"createStreamingDistributionWithTags", "x-api-path-slug"=>"actioncreatestreamingdistributionwithtags-get", "parameters"=>[{"in"=>"query", "name"=>"CreateStreamingDistributionWithTagsRequest", "description"=>"Root level tag for the CreateStreamingDistributionWithTagsRequest parameters", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"StreamingDistributionConfigWithTags", "description"=>"The streaming distributions configuration information", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Streaming", "Distribution", "Tags"]}}, "/?Action=DeleteCloudFrontOriginAccessIdentity"=>{"get"=>{"summary"=>"Delete Cloud Front Origin Access Identity", "description"=>"Delete an origin access identity.", "operationId"=>"deleteCloudFrontOriginAccessIdentity", "x-api-path-slug"=>"actiondeletecloudfrontoriginaccessidentity-get", "parameters"=>[{"in"=>"query", "name"=>"Id", "description"=>"The origin access identitys ID", "type"=>"string"}, {"in"=>"query", "name"=>"If-Match", "description"=>"The value of the ETag header you received from a previous GET or PUT request", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cloud", "Front", "Origin", "Access", "Identity"]}}, "/?Action=DeleteDistribution"=>{"get"=>{"summary"=>"Delete Distribution", "description"=>"Delete a distribution.", "operationId"=>"deleteDistribution", "x-api-path-slug"=>"actiondeletedistribution-get", "parameters"=>[{"in"=>"query", "name"=>"BgpAsn", "description"=>"For devices that support BGP, the customer gateways BGP ASN", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The distribution ID", "type"=>"string"}, {"in"=>"query", "name"=>"If-Match", "description"=>"The value of the ETag header that you received when you disabled the distribution", "type"=>"string"}, {"in"=>"query", "name"=>"IpAddress", "description"=>"The Internet-routable IP address for the customer gateways outside interface", "type"=>"string"}, {"in"=>"query", "name"=>"Type", "description"=>"The type of VPN connection that this customer gateway supports (ipsec", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Distribution"]}}, "/?Action=DeleteStreamingDistribution"=>{"get"=>{"summary"=>"Delete Streaming Distribution", "description"=>"Delete a streaming distribution.", "operationId"=>"deleteStreamingDistribution", "x-api-path-slug"=>"actiondeletestreamingdistribution-get", "parameters"=>[{"in"=>"query", "name"=>"CustomerGatewayId", "description"=>"The ID of the customer gateway", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The distribution ID", "type"=>"string"}, {"in"=>"query", "name"=>"If-Match", "description"=>"The value of the ETag header that you received when you disabled the streaming distribution", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Streaming", "Distribution"]}}, "/?Action=GetCloudFrontOriginAccessIdentity"=>{"get"=>{"summary"=>"Get Cloud Front Origin Access Identity", "description"=>"Get the information about an origin access identity.", "operationId"=>"getCloudFrontOriginAccessIdentity", "x-api-path-slug"=>"actiongetcloudfrontoriginaccessidentity-get", "parameters"=>[{"in"=>"query", "name"=>"CustomerGatewayId.N", "description"=>"One or more customer gateway IDs", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The identitys ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cloud", "Front", "Origin", "Access", "Identity"]}}, "/?Action=GetCloudFrontOriginAccessIdentityConfig"=>{"get"=>{"summary"=>"Get Cloud Front Origin Access Identity Config", "description"=>"Get the configuration information about an origin access identity.", "operationId"=>"getCloudFrontOriginAccessIdentityConfig", "x-api-path-slug"=>"actiongetcloudfrontoriginaccessidentityconfig-get", "parameters"=>[{"in"=>"query", "name"=>"AutoPlacement", "description"=>"This is enabled by default", "type"=>"string"}, {"in"=>"query", "name"=>"AvailabilityZone", "description"=>"The Availability Zone for the Dedicated Hosts", "type"=>"string"}, {"in"=>"query", "name"=>"ClientToken", "description"=>"Unique, case-sensitive identifier you provide to ensure idempotency of the request", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The identitys ID", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceType", "description"=>"Specify the instance type that you want your Dedicated Hosts to be configured for", "type"=>"string"}, {"in"=>"query", "name"=>"Quantity", "description"=>"The number of Dedicated Hosts you want to allocate to your account with these parameters", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cloud", "Front", "Origin", "Access", "Identity", "Config"]}}, "/?Action=GetDistribution"=>{"get"=>{"summary"=>"Get Distribution", "description"=>"Get the information about a distribution.", "operationId"=>"getDistribution", "x-api-path-slug"=>"actiongetdistribution-get", "parameters"=>[{"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"HostId.N", "description"=>"The IDs of the Dedicated Hosts", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The distributions ID", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return for the request in a single page", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to retrieve the next page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Distribution"]}}, "/?Action=GetDistributionConfig"=>{"get"=>{"summary"=>"Get Distribution Config", "description"=>"Get the configuration information about a distribution.", "operationId"=>"getDistributionConfig", "x-api-path-slug"=>"actiongetdistributionconfig-get", "parameters"=>[{"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The distributions ID", "type"=>"string"}, {"in"=>"query", "name"=>"MaxDuration", "description"=>"This is the maximum duration of the reservation youd like to purchase, specified in seconds", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return for the request in a single page", "type"=>"string"}, {"in"=>"query", "name"=>"MinDuration", "description"=>"This is the minimum duration of the reservation youd like to purchase, specified in seconds", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to use to retrieve the next page of results", "type"=>"string"}, {"in"=>"query", "name"=>"OfferingId", "description"=>"The ID of the reservation offering", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Distribution", "Config"]}}, "/?Action=GetInvalidation"=>{"get"=>{"summary"=>"Get Invalidation", "description"=>"Get the information about an invalidation.", "operationId"=>"getInvalidation", "x-api-path-slug"=>"actiongetinvalidation-get", "parameters"=>[{"in"=>"query", "name"=>"DistributionId", "description"=>"The distributions ID", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"HostReservationIdSet.N", "description"=>"One or more host reservation IDs", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The identifier for the invalidation request, for example, IDFDVBD632BHDS5", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return for the request in a single page", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to use to retrieve the next page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invalidation"]}}, "/?Action=GetStreamingDistribution"=>{"get"=>{"summary"=>"Get Streaming Distribution", "description"=>"Gets information about a specified RTMP distribution, including the distribution\n configuration.", "operationId"=>"getStreamingDistribution", "x-api-path-slug"=>"actiongetstreamingdistribution-get", "parameters"=>[{"in"=>"query", "name"=>"HostIdSet.N", "description"=>"The ID/s of the Dedicated Host/s that the reservation will be associated with", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The streaming distributions ID", "type"=>"string"}, {"in"=>"query", "name"=>"OfferingId", "description"=>"The offering ID of the reservation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Streaming", "Distribution"]}}, "/?Action=GetStreamingDistributionConfig"=>{"get"=>{"summary"=>"Get Streaming Distribution Config", "description"=>"Get the configuration information about a streaming distribution.", "operationId"=>"getStreamingDistributionConfig", "x-api-path-slug"=>"actiongetstreamingdistributionconfig-get", "parameters"=>[{"in"=>"query", "name"=>"AutoPlacement", "description"=>"Specify whether to enable or disable auto-placement", "type"=>"string"}, {"in"=>"query", "name"=>"HostId.N", "description"=>"The host IDs of the Dedicated Hosts you want to modify", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The streaming distributions ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Streaming", "Distribution", "Config"]}}, "/?Action=ListCloudFrontOriginAccessIdentities"=>{"get"=>{"summary"=>"List Cloud Front Origin Access Identities", "description"=>"Lists origin access identities.", "operationId"=>"listCloudFrontOriginAccessIdentities", "x-api-path-slug"=>"actionlistcloudfrontoriginaccessidentities-get", "parameters"=>[{"in"=>"query", "name"=>"Affinity", "description"=>"The new affinity setting for the instance", "type"=>"string"}, {"in"=>"query", "name"=>"HostId", "description"=>"The ID of the Dedicated Host that the instance will have affinity with", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance that you are modifying", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use this when paginating results to indicate where to begin in your list of origin access identities", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"The maximum number of origin access identities you want in the response body", "type"=>"string"}, {"in"=>"query", "name"=>"Tenancy", "description"=>"The tenancy of the instance that you are modifying", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Cloud", "Front", "Origin", "Access", "Identities"]}}, "/?Action=ListDistributions"=>{"get"=>{"summary"=>"List Distributions", "description"=>"List distributions.", "operationId"=>"listDistributions", "x-api-path-slug"=>"actionlistdistributions-get", "parameters"=>[{"in"=>"query", "name"=>"ClientToken", "description"=>"Unique, case-sensitive identifier you provide to ensure idempotency of the request", "type"=>"string"}, {"in"=>"query", "name"=>"CurrencyCode", "description"=>"The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified", "type"=>"string"}, {"in"=>"query", "name"=>"HostIdSet.N", "description"=>"The ID/s of the Dedicated Host/s that the reservation will be associated with", "type"=>"string"}, {"in"=>"query", "name"=>"LimitPrice", "description"=>"The specified limit is checked against the total upfront cost of the reservation (calculated as the offerings upfront cost multiplied by the host count)", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use this when paginating results to indicate where to begin in your list of distributions", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"The maximum number of distributions you want in the response body", "type"=>"string"}, {"in"=>"query", "name"=>"OfferingId", "description"=>"The ID of the offering", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Distributions"]}}, "/?Action=ListDistributionsByWebACLId"=>{"get"=>{"summary"=>"List Distributions By Web A C L Id", "description"=>"List the distributions that are associated with a specified AWS WAF web ACL.", "operationId"=>"listDistributionsByWebACLId", "x-api-path-slug"=>"actionlistdistributionsbywebaclid-get", "parameters"=>[{"in"=>"query", "name"=>"HostId.N", "description"=>"The IDs of the Dedicated Hosts you want to release", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use Marker and MaxItems to control pagination of results", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"The maximum number of distributions that you want CloudFront to return in the response body", "type"=>"string"}, {"in"=>"query", "name"=>"WebACLId", "description"=>"The ID of the AWS WAF web ACL that you want to list the associated distributions", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Distributions", "Web", "C", "L", "Id"]}}, "/?Action=ListInvalidations"=>{"get"=>{"summary"=>"List Invalidations", "description"=>"Lists invalidation batches.", "operationId"=>"listInvalidations", "x-api-path-slug"=>"actionlistinvalidations-get", "parameters"=>[{"in"=>"query", "name"=>"DhcpOptionsId", "description"=>"The ID of the DHCP options set, or default to associate no DHCP options with the VPC", "type"=>"string"}, {"in"=>"query", "name"=>"DistributionId", "description"=>"The distributions ID", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"The maximum number of invalidation batches that you want in the response body", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Invalidations"]}}, "/?Action=ListStreamingDistributions"=>{"get"=>{"summary"=>"List Streaming Distributions", "description"=>"List streaming distributions.", "operationId"=>"listStreamingDistributions", "x-api-path-slug"=>"actionliststreamingdistributions-get", "parameters"=>[{"in"=>"query", "name"=>"DhcpConfiguration.N", "description"=>"A DHCP configuration option", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"The value that you provided for the Marker request parameter", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"The value that you provided for the MaxItems request parameter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Streaming", "Distributions"]}}, "/?Action=ListTagsForResource"=>{"get"=>{"summary"=>"List Tags For Resource", "description"=>"List tags for a CloudFront resource.", "operationId"=>"listTagsForResource", "x-api-path-slug"=>"actionlisttagsforresource-get", "parameters"=>[{"in"=>"query", "name"=>"DhcpOptionsId", "description"=>"The ID of the DHCP options set", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Resource", "description"=>"An ARN of a CloudFront resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Tags", "Resource"]}}, "/?Action=TagResource"=>{"get"=>{"summary"=>"Tag Resource", "description"=>"Add tags to a CloudFront resource.", "operationId"=>"tagResource", "x-api-path-slug"=>"actiontagresource-get", "parameters"=>[{"in"=>"query", "name"=>"DhcpOptionsId.N", "description"=>"The IDs of one or more DHCP options sets", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"Resource", "description"=>"An ARN of a CloudFront resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tag", "Resource"]}}, "/?Action=UntagResource"=>{"get"=>{"summary"=>"Untag Resource", "description"=>"Remove tags from a CloudFront resource.", "operationId"=>"untagResource", "x-api-path-slug"=>"actionuntagresource-get", "parameters"=>[{"in"=>"query", "name"=>"Device", "description"=>"The device name to expose to the instance (for example, /dev/sdh or xvdh)", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"Resource", "description"=>"An ARN of a CloudFront resource", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId", "description"=>"The ID of the EBS volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Untag", "Resource"]}}, "/?Action=UpdateCloudFrontOriginAccessIdentity"=>{"get"=>{"summary"=>"Update Cloud Front Origin Access Identity", "description"=>"Update an origin access identity.", "operationId"=>"updateCloudFrontOriginAccessIdentity", "x-api-path-slug"=>"actionupdatecloudfrontoriginaccessidentity-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"A description for the EBS snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"DestinationRegion", "description"=>"The destination region to use in the PresignedUrl parameter of a snapshot copy operation", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Encrypted", "description"=>"Specifies whether the destination snapshot should be encrypted", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The identitys id", "type"=>"string"}, {"in"=>"query", "name"=>"If-Match", "description"=>"The value of the ETag header that you received when retrieving the identitys configuration", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyId", "description"=>"The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy", "type"=>"string"}, {"in"=>"query", "name"=>"PresignedUrl", "description"=>"The pre-signed URL that facilitates copying an encrypted snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"SourceRegion", "description"=>"The ID of the region that contains the snapshot to be copied", "type"=>"string"}, {"in"=>"query", "name"=>"SourceSnapshotId", "description"=>"The ID of the EBS snapshot to copy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cloud", "Front", "Origin", "Access", "Identity"]}}, "/?Action=UpdateDistribution"=>{"get"=>{"summary"=>"Update Distribution", "description"=>"Update a distribution.", "operationId"=>"updateDistribution", "x-api-path-slug"=>"actionupdatedistribution-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"A description for the snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The distributions id", "type"=>"string"}, {"in"=>"query", "name"=>"If-Match", "description"=>"The value of the ETag header that you received when retrieving the distributions configuration", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId", "description"=>"The ID of the EBS volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Distribution"]}}, "/?Action=UpdateStreamingDistribution"=>{"get"=>{"summary"=>"Update Streaming Distribution", "description"=>"Update a streaming distribution.", "operationId"=>"updateStreamingDistribution", "x-api-path-slug"=>"actionupdatestreamingdistribution-get", "parameters"=>[{"in"=>"query", "name"=>"AvailabilityZone", "description"=>"The Availability Zone in which to create the volume", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Encrypted", "description"=>"Specifies whether the volume should be encrypted", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The streaming distributions id", "type"=>"string"}, {"in"=>"query", "name"=>"If-Match", "description"=>"The value of the ETag header that you received when retrieving the streaming distributions configuration", "type"=>"string"}, {"in"=>"query", "name"=>"Iops", "description"=>"Only valid for Provisioned IOPS SSD volumes", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyId", "description"=>"The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume", "type"=>"string"}, {"in"=>"query", "name"=>"Size", "description"=>"The size of the volume, in GiBs", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotId", "description"=>"The snapshot from which to create the volume", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeType", "description"=>"The volume type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Streaming", "Distribution"]}}}}, "apis"=>{"name"=>"AWS CloudFront", "x-slug"=>"aws-cloudfront", "description"=>"Amazon CloudFront is a global content delivery network (CDN) service that accelerates delivery of your websites, APIs, video content or other web assets. It integrates with other Amazon Web Services products to give developers and businesses an easy way to accelerate content to end users with no minimum usage commitments.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Storage-Content-Delivery_AmazonCloudFront.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,CDN,Content,Profiles,Relative Data,Service API,Stack Network,Storage", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-cloudfront/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS CloudFront API", "x-api-slug"=>"aws-cloudfront-api", "description"=>"Amazon CloudFront is a global content delivery network (CDN) service that accelerates delivery of your websites, APIs, video content or other web assets. It integrates with other Amazon Web Services products to give developers and businesses an easy way to accelerate content to end users with no minimum usage commitments.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Storage-Content-Delivery_AmazonCloudFront.png", "humanURL"=>"https://aws.amazon.com/cloudfront/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,CDN,Content,Profiles,Relative Data,Service API,Stack Network,Storage", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-cloudfront/aws-cloudfront-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-analysis", "url"=>"https://aws.amazon.com/cloudfront/reporting/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/AmazonCloudFront/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/cloudfront/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/cloudfront/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/cloudfront/pricing/"}, {"type"=>"x-service-level-agreement", "url"=>"https://aws.amazon.com/cloudfront/sla/"}, {"type"=>"x-webinars", "url"=>"https://aws.amazon.com/cloudfront/webinars/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/cloudfront/"}, {"type"=>"x-whats-new", "url"=>"https://aws.amazon.com/cloudfront/whats-new/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-sql{"google-cloud-sql-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud SQL", "x-complete"=>1, "info"=>{"title"=>"Cloud SQL Administration", "description"=>"creates-and-configures-cloud-sql-instances-which-provide-fullymanaged-mysql-databases-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1beta4"}, "host"=>"www.googleapis.com", "basePath"=>"/sql/v1beta4", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/flags"=>{"get"=>{"summary"=>"Get Flags", "description"=>"List all available database flags for Google Cloud SQL instances.", "operationId"=>"sql.flags.list", "x-api-path-slug"=>"flags-get", "parameters"=>[{"in"=>"query", "name"=>"databaseVersion", "description"=>"Database version for flag retrieval"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Flags"]}}, "/projects/{project}/instances"=>{"get"=>{"summary"=>"Get Projects Project Instances", "description"=>"Lists instances under a given project in the alphabetical order of the instance name.", "operationId"=>"sql.instances.list", "x-api-path-slug"=>"projectsprojectinstances-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"A filter expression for filtering listed instances"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results to return per response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A previously-returned page token representing part of the larger set of results to view"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project for which to list Cloud SQL instances"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances"]}, "post"=>{"summary"=>"Add Projects Project Instances", "description"=>"Creates a new Cloud SQL instance.", "operationId"=>"sql.instances.insert", "x-api-path-slug"=>"projectsprojectinstances-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project to which the newly created Cloud SQL instances should belong"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances"]}}, "/projects/{project}/instances/{instance}"=>{"delete"=>{"summary"=>"Delete Projects Project Instances Instance", "description"=>"Deletes a Cloud SQL instance.", "operationId"=>"sql.instances.delete", "x-api-path-slug"=>"projectsprojectinstancesinstance-delete", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance"]}, "get"=>{"summary"=>"Get Projects Project Instances Instance", "description"=>"Retrieves a resource containing information about a Cloud SQL instance.", "operationId"=>"sql.instances.get", "x-api-path-slug"=>"projectsprojectinstancesinstance-get", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Database instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance"]}, "patch"=>{"summary"=>"Patch Projects Project Instances Instance", "description"=>"Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.. This method supports patch semantics.", "operationId"=>"sql.instances.patch", "x-api-path-slug"=>"projectsprojectinstancesinstance-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance"]}, "put"=>{"summary"=>"Put Projects Project Instances Instance", "description"=>"Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.", "operationId"=>"sql.instances.update", "x-api-path-slug"=>"projectsprojectinstancesinstance-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Put", "Projects", "Project", "Instances", "Instance"]}}, "/projects/{project}/instances/{instance}/backupRuns"=>{"get"=>{"summary"=>"Get Projects Project Instances Instance Backupruns", "description"=>"Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the enqueued time.", "operationId"=>"sql.backupRuns.list", "x-api-path-slug"=>"projectsprojectinstancesinstancebackupruns-get", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of backup runs per response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A previously-returned page token representing part of the larger set of results to view"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Backupruns"]}, "post"=>{"summary"=>"Add Projects Project Instances Instance Backupruns", "description"=>"Creates a new backup run on demand. This method is applicable only to Second Generation instances.", "operationId"=>"sql.backupRuns.insert", "x-api-path-slug"=>"projectsprojectinstancesinstancebackupruns-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Backupruns"]}}, "/projects/{project}/instances/{instance}/backupRuns/{id}"=>{"delete"=>{"summary"=>"Delete Projects Project Instances Instance Backupruns", "description"=>"Deletes the backup taken by a backup run.", "operationId"=>"sql.backupRuns.delete", "x-api-path-slug"=>"projectsprojectinstancesinstancebackuprunsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the Backup Run to delete"}, {"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Backupruns"]}, "get"=>{"summary"=>"Get Projects Project Instances Instance Backupruns", "description"=>"Retrieves a resource containing information about a backup run.", "operationId"=>"sql.backupRuns.get", "x-api-path-slug"=>"projectsprojectinstancesinstancebackuprunsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of this Backup Run"}, {"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Backupruns"]}}, "/projects/{project}/instances/{instance}/clone"=>{"post"=>{"summary"=>"Add Projects Project Instances Instance Clone", "description"=>"Creates a Cloud SQL instance as a clone of the source instance. The API is not ready for Second Generation instances yet.", "operationId"=>"sql.instances.clone", "x-api-path-slug"=>"projectsprojectinstancesinstanceclone-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"The ID of the Cloud SQL instance to be cloned (source)"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the source as well as the clone Cloud SQL instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Clone"]}}, "/projects/{project}/instances/{instance}/createEphemeral"=>{"post"=>{"summary"=>"Add Projects Project Instances Instance Createephemeral", "description"=>"Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.", "operationId"=>"sql.sslCerts.createEphemeral", "x-api-path-slug"=>"projectsprojectinstancesinstancecreateephemeral-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the Cloud SQL project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Createephemeral"]}}, "/projects/{project}/instances/{instance}/databases"=>{"get"=>{"summary"=>"Get Projects Project Instances Instance Databases", "description"=>"Lists databases in the specified Cloud SQL instance.", "operationId"=>"sql.databases.list", "x-api-path-slug"=>"projectsprojectinstancesinstancedatabases-get", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project for which to list Cloud SQL instances"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Databases"]}, "post"=>{"summary"=>"Add Projects Project Instances Instance Databases", "description"=>"Inserts a resource containing information about a database inside a Cloud SQL instance.", "operationId"=>"sql.databases.insert", "x-api-path-slug"=>"projectsprojectinstancesinstancedatabases-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Database instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Databases"]}}, "/projects/{project}/instances/{instance}/databases/{database}"=>{"delete"=>{"summary"=>"Delete Projects Project Instances Instance Databases Database", "description"=>"Deletes a database from a Cloud SQL instance.", "operationId"=>"sql.databases.delete", "x-api-path-slug"=>"projectsprojectinstancesinstancedatabasesdatabase-delete", "parameters"=>[{"in"=>"path", "name"=>"database", "description"=>"Name of the database to be deleted in the instance"}, {"in"=>"path", "name"=>"instance", "description"=>"Database instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Databases", "Database"]}, "get"=>{"summary"=>"Get Projects Project Instances Instance Databases Database", "description"=>"Retrieves a resource containing information about a database inside a Cloud SQL instance.", "operationId"=>"sql.databases.get", "x-api-path-slug"=>"projectsprojectinstancesinstancedatabasesdatabase-get", "parameters"=>[{"in"=>"path", "name"=>"database", "description"=>"Name of the database in the instance"}, {"in"=>"path", "name"=>"instance", "description"=>"Database instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Databases", "Database"]}, "patch"=>{"summary"=>"Patch Projects Project Instances Instance Databases Database", "description"=>"Updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.", "operationId"=>"sql.databases.patch", "x-api-path-slug"=>"projectsprojectinstancesinstancedatabasesdatabase-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"database", "description"=>"Name of the database to be updated in the instance"}, {"in"=>"path", "name"=>"instance", "description"=>"Database instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Databases", "Database"]}, "put"=>{"summary"=>"Put Projects Project Instances Instance Databases Database", "description"=>"Updates a resource containing information about a database inside a Cloud SQL instance.", "operationId"=>"sql.databases.update", "x-api-path-slug"=>"projectsprojectinstancesinstancedatabasesdatabase-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"database", "description"=>"Name of the database to be updated in the instance"}, {"in"=>"path", "name"=>"instance", "description"=>"Database instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Put", "Projects", "Project", "Instances", "Instance", "Databases", "Database"]}}, "/projects/{project}/instances/{instance}/export"=>{"post"=>{"summary"=>"Add Projects Project Instances Instance Export", "description"=>"Exports data from a Cloud SQL instance to a Google Cloud Storage bucket as a MySQL dump file.", "operationId"=>"sql.instances.export", "x-api-path-slug"=>"projectsprojectinstancesinstanceexport-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance to be exported"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Export"]}}, "/projects/{project}/instances/{instance}/failover"=>{"post"=>{"summary"=>"Add Projects Project Instances Instance Failover", "description"=>"Failover the instance to its failover replica instance.", "operationId"=>"sql.instances.failover", "x-api-path-slug"=>"projectsprojectinstancesinstancefailover-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"ID of the project that contains the read replica"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Failover"]}}, "/projects/{project}/instances/{instance}/import"=>{"post"=>{"summary"=>"Add Projects Project Instances Instance Import", "description"=>"Imports data into a Cloud SQL instance from a MySQL dump file in Google Cloud Storage.", "operationId"=>"sql.instances.import", "x-api-path-slug"=>"projectsprojectinstancesinstanceimport-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Import"]}}, "/projects/{project}/instances/{instance}/promoteReplica"=>{"post"=>{"summary"=>"Add Projects Project Instances Instance Promotereplica", "description"=>"Promotes the read replica instance to be a stand-alone Cloud SQL instance.", "operationId"=>"sql.instances.promoteReplica", "x-api-path-slug"=>"projectsprojectinstancesinstancepromotereplica-post", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL read replica instance name"}, {"in"=>"path", "name"=>"project", "description"=>"ID of the project that contains the read replica"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Promotereplica"]}}, "/projects/{project}/instances/{instance}/resetSslConfig"=>{"post"=>{"summary"=>"Add Projects Project Instances Instance Resetsslconfig", "description"=>"Deletes all client certificates and generates a new server SSL certificate for the instance. The changes will not take effect until the instance is restarted. Existing instances without a server certificate will need to call this once to set a server certificate.", "operationId"=>"sql.instances.resetSslConfig", "x-api-path-slug"=>"projectsprojectinstancesinstanceresetsslconfig-post", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Resetsslconfig"]}}, "/projects/{project}/instances/{instance}/restart"=>{"post"=>{"summary"=>"Add Projects Project Instances Instance Restart", "description"=>"Restarts a Cloud SQL instance.", "operationId"=>"sql.instances.restart", "x-api-path-slug"=>"projectsprojectinstancesinstancerestart-post", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance to be restarted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Restart"]}}, "/projects/{project}/instances/{instance}/restoreBackup"=>{"post"=>{"summary"=>"Add Projects Project Instances Instance Restorebackup", "description"=>"Restores a backup of a Cloud SQL instance.", "operationId"=>"sql.instances.restoreBackup", "x-api-path-slug"=>"projectsprojectinstancesinstancerestorebackup-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Restorebackup"]}}, "/projects/{project}/instances/{instance}/sslCerts"=>{"get"=>{"summary"=>"Get Projects Project Instances Instance Sslcerts", "description"=>"Lists all of the current SSL certificates for the instance.", "operationId"=>"sql.sslCerts.list", "x-api-path-slug"=>"projectsprojectinstancesinstancesslcerts-get", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project for which to list Cloud SQL instances"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Sslcerts"]}, "post"=>{"summary"=>"Add Projects Project Instances Instance Sslcerts", "description"=>"Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted.", "operationId"=>"sql.sslCerts.insert", "x-api-path-slug"=>"projectsprojectinstancesinstancesslcerts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project to which the newly created Cloud SQL instances should belong"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Sslcerts"]}}, "/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}"=>{"delete"=>{"summary"=>"Delete Projects Project Instances Instance Sslcerts Sha1fingerprint", "description"=>"Deletes the SSL certificate. The change will not take effect until the instance is restarted.", "operationId"=>"sql.sslCerts.delete", "x-api-path-slug"=>"projectsprojectinstancesinstancesslcertssha1fingerprint-delete", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance to be deleted"}, {"in"=>"path", "name"=>"sha1Fingerprint", "description"=>"Sha1 FingerPrint"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Sslcerts", "Sha1fingerprint"]}, "get"=>{"summary"=>"Get Projects Project Instances Instance Sslcerts Sha1fingerprint", "description"=>"Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation.", "operationId"=>"sql.sslCerts.get", "x-api-path-slug"=>"projectsprojectinstancesinstancesslcertssha1fingerprint-get", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}, {"in"=>"path", "name"=>"sha1Fingerprint", "description"=>"Sha1 FingerPrint"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Sslcerts", "Sha1fingerprint"]}}, "/projects/{project}/instances/{instance}/startReplica"=>{"post"=>{"summary"=>"Add Projects Project Instances Instance Startreplica", "description"=>"Starts the replication in the read replica instance.", "operationId"=>"sql.instances.startReplica", "x-api-path-slug"=>"projectsprojectinstancesinstancestartreplica-post", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL read replica instance name"}, {"in"=>"path", "name"=>"project", "description"=>"ID of the project that contains the read replica"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Startreplica"]}}, "/projects/{project}/instances/{instance}/stopReplica"=>{"post"=>{"summary"=>"Add Projects Project Instances Instance Stopreplica", "description"=>"Stops the replication in the read replica instance.", "operationId"=>"sql.instances.stopReplica", "x-api-path-slug"=>"projectsprojectinstancesinstancestopreplica-post", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL read replica instance name"}, {"in"=>"path", "name"=>"project", "description"=>"ID of the project that contains the read replica"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Stopreplica"]}}, "/projects/{project}/instances/{instance}/truncateLog"=>{"post"=>{"summary"=>"Add Projects Project Instances Instance Truncatelog", "description"=>"Truncate MySQL general and slow query log tables", "operationId"=>"sql.instances.truncateLog", "x-api-path-slug"=>"projectsprojectinstancesinstancetruncatelog-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the Cloud SQL project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Truncatelog"]}}, "/projects/{project}/instances/{instance}/users"=>{"delete"=>{"summary"=>"Delete Projects Project Instances Instance Users", "description"=>"Deletes a user from a Cloud SQL instance.", "operationId"=>"sql.users.delete", "x-api-path-slug"=>"projectsprojectinstancesinstanceusers-delete", "parameters"=>[{"in"=>"query", "name"=>"host", "description"=>"Host of the user in the instance"}, {"in"=>"path", "name"=>"instance", "description"=>"Database instance ID"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the user in the instance"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Users"]}, "get"=>{"summary"=>"Get Projects Project Instances Instance Users", "description"=>"Lists users in the specified Cloud SQL instance.", "operationId"=>"sql.users.list", "x-api-path-slug"=>"projectsprojectinstancesinstanceusers-get", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Database instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Users"]}, "post"=>{"summary"=>"Add Projects Project Instances Instance Users", "description"=>"Creates a new user in a Cloud SQL instance.", "operationId"=>"sql.users.insert", "x-api-path-slug"=>"projectsprojectinstancesinstanceusers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Database instance ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Instances", "Instance", "Users"]}, "put"=>{"summary"=>"Put Projects Project Instances Instance Users", "description"=>"Updates an existing user in a Cloud SQL instance.", "operationId"=>"sql.users.update", "x-api-path-slug"=>"projectsprojectinstancesinstanceusers-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"host", "description"=>"Host of the user in the instance"}, {"in"=>"path", "name"=>"instance", "description"=>"Database instance ID"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the user in the instance"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Put", "Projects", "Project", "Instances", "Instance", "Users"]}}, "/projects/{project}/operations"=>{"get"=>{"summary"=>"Get Projects Project Operations", "description"=>"Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.", "operationId"=>"sql.operations.list", "x-api-path-slug"=>"projectsprojectoperations-get", "parameters"=>[{"in"=>"query", "name"=>"instance", "description"=>"Cloud SQL instance ID"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of operations per response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A previously-returned page token representing part of the larger set of results to view"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Operations"]}}, "/projects/{project}/operations/{operation}"=>{"get"=>{"summary"=>"Get Projects Project Operations Operation", "description"=>"Retrieves an instance operation that has been performed on an instance.", "operationId"=>"sql.operations.get", "x-api-path-slug"=>"projectsprojectoperationsoperation-get", "parameters"=>[{"in"=>"path", "name"=>"operation", "description"=>"Instance operation ID"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID of the project that contains the instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Operations", "Operation"]}}, "/projects/{project}/tiers"=>{"get"=>{"summary"=>"Get Projects Project Tiers", "description"=>"Lists all available service tiers for Google Cloud SQL, for example D1, D2. For related information, see Pricing.", "operationId"=>"sql.tiers.list", "x-api-path-slug"=>"projectsprojecttiers-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID of the project for which to list tiers"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Project", "Tiers"]}}}}, "apis"=>{"name"=>"Google Cloud SQL", "x-slug"=>"google-cloud-sql", "description"=>"Cloud SQL is a fully-managed database service that makes it easy to set up, maintain, manage, and administer your relational PostgreSQL BETA and MySQL databases in the cloud. Cloud SQL offers high performance, scalability, and convenience. Hosted on Google Cloud Platform, Cloud SQL provides a database infrastructure for applications running anywhere.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-cloud-sql-lead-2x.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Databases,Google APIs,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-sql/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud SQL API", "x-api-slug"=>"google-cloud-sql-api", "description"=>"Cloud SQL is a fully-managed database service that makes it easy to set up, maintain, manage, and administer your relational PostgreSQL BETA and MySQL databases in the cloud. Cloud SQL offers high performance, scalability, and convenience. Hosted on Google Cloud Platform, Cloud SQL provides a database infrastructure for applications running anywhere.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-cloud-sql-lead-2x.png", "humanURL"=>"https://cloud.google.com/sql/", "baseURL"=>"://www.googleapis.com//sql/v1beta4", "tags"=>"API Provider,API Service Provider,Databases,Google APIs,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/google-cloud-sql/projectsprojecttiers-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/google-cloud-sql/google-cloud-sql-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-log", "url"=>"https://cloud.google.com/sql/docs/release-notes"}, {"type"=>"x-code", "url"=>"https://cloud.google.com/sql/docs/admin-api/libraries"}, {"type"=>"x-concepts", "url"=>"https://cloud.google.com/sql/docs/postgres/concepts"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/sql/docs/"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/sql/docs/postgres/quickstart"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/sql/docs/postgres/how-to"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/sql/pricing"}, {"type"=>"x-service-level-agreements", "url"=>"https://cloud.google.com/sql/sla"}, {"type"=>"x-support", "url"=>"https://cloud.google.com/sql/docs/support"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/sql/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
wikipedia{"apis"=>{"name"=>"Wikipedia", "x-slug"=>"wikipedia", "description"=>"Wikipedia is a free online encyclopedia, created and edited by volunteers around the world and hosted by the Wikimedia Foundation.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/144-wikipedia.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"5", "tags"=>"Content,General Data,Historical Data API,Imports,internet,Media,Pedestal,Stack,Stack Network,Technology,Wiki", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"wikipedia/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Wikipedia", "x-api-slug"=>"wikipedia", "description"=>"Wikipedia is a free online encyclopedia, created and edited by volunteers around the world and hosted by the Wikimedia Foundation.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/144-wikipedia.jpg", "humanURL"=>"https://www.wikipedia.org/", "baseURL"=>"https://wikimedia.org//api/rest_v1", "tags"=>"Content,General Data,Historical Data API,Imports,internet,Media,Pedestal,Stack,Stack Network,Technology,Wiki", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/wikipedia/wikipedia-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://en.wikipedia.org/w/api.php"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/wikipedia"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/wikipedia"}, {"type"=>"x-developer", "url"=>"http://www.mediawiki.org/wiki/API"}, {"type"=>"x-github", "url"=>"https://github.com/Wikipedia"}, {"type"=>"x-swagger--original", "url"=>"http://rest.wikimedia.org/en.wikipedia.org/v1/?spec"}, {"type"=>"x-transparency-report", "url"=>"https://transparency.wikimedia.org/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/wikipedia"}, {"type"=>"x-website", "url"=>"https://www.wikipedia.org/"}, {"type"=>"x-website", "url"=>"http://wikipedia.org"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "wikipedia-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Wikipedia", "x-complete"=>1, "info"=>{"title"=>"Wikipedia", "description"=>"this-api-provides-cacheable-and-straightforward-access-to-wikimedia-content-and-data-in-machinereadable-formats-", "termsOfService"=>"https://wikimediafoundation.org/wiki/Terms_of_Use", "contact"=>{"name"=>"the Wikimedia Services team", "url"=>"http://mediawiki.org/wiki/REST_API"}, "version"=>"v1"}, "host"=>"wikimedia.org", "basePath"=>"/api/rest_v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/media/math/check/{type}"=>{"post"=>{"summary"=>"Check and normalize a TeX formula.", "description"=>"Checks the supplied TeX formula for correctness and returns the\nnormalised formula representation as well as information about\nidentifiers. Available types are tex and inline-tex. The response\ncontains the `x-resource-location` header which can be used to retrieve\nthe render of the checked formula in one of the supported rendering\nformats. Just append the value of the header to `/media/math/{format}/`\nand perform a GET request against that URL.\n\nStability: [stable](https://www.mediawiki.org/wiki/API_versioning#Stable).", "operationId"=>"checks-the-supplied-tex-formula-for-correctness-and-returns-thenormalised-formula-representation-as-", "x-api-path-slug"=>"mediamathchecktype-post", "parameters"=>[{"in"=>"formData", "name"=>"q", "description"=>"The formula to check"}, {"in"=>"path", "name"=>"type", "description"=>"The input type of the given formula; can be tex or inline-tex"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/media/math/formula/{hash}"=>{"get"=>{"summary"=>"Get a previously-stored formula", "description"=>"Returns the previously-stored formula via `/media/math/check/{type}` for\nthe given hash.\n\nStability: [stable](https://www.mediawiki.org/wiki/API_versioning#Stable).", "operationId"=>"returns-the-previouslystored-formula-via-mediamathchecktype-forthe-given-hashstability-stablehttpsww", "x-api-path-slug"=>"mediamathformulahash-get", "parameters"=>[{"in"=>"path", "name"=>"hash", "description"=>"The hash string of the previous POST data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/media/math/render/{format}/{hash}"=>{"get"=>{"summary"=>"Get rendered formula in the given format.", "description"=>"Given a request hash, renders a TeX formula into its mathematic\nrepresentation in the given format. When a request is issued to the\n`/media/math/check/{format}` POST endpoint, the response contains the\n`x-resource-location` header denoting the hash ID of the POST data. Once\nobtained, this endpoint has to be used to obtain the actual render.\n\nStability: [stable](https://www.mediawiki.org/wiki/API_versioning#Stable).", "operationId"=>"given-a-request-hash-renders-a-tex-formula-into-its-mathematicrepresentation-in-the-given-format-whe", "x-api-path-slug"=>"mediamathrenderformathash-get", "parameters"=>[{"in"=>"path", "name"=>"format", "description"=>"The output format; can be svg or mml"}, {"in"=>"path", "name"=>"hash", "description"=>"The hash string of the previous POST data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/bytes-difference/absolute/aggregate/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Get the sum of absolute value of text bytes difference between current edit and\nprevious one.", "description"=>"Given a Mediawiki project and a date range, returns a timeseries of absolute bytes\ndifference sums. You can filter by editors-type (all-editor-types, anonymous, group-bot,\nname-bot, user) and page-type (all-page-types, content, non-content). You can choose\nbetween daily and monthly granularity as well.\n\n- Stability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-mediawiki-project-and-a-date-range-returns-a-timeseries-of-absolute-bytesdifference-sums-you", "x-api-path-slug"=>"metricsbytesdifferenceabsoluteaggregateprojecteditortypepagetypegranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"editor-type", "description"=>"If you want to filter by editor-type, use one of anonymous, group-bot (registeredaccounts belonging to the bot group), name-bot (registered accounts not belonging tothe bot group but having bot-like names) or user (registered account not in bot groupnor having bot-like name)"}, {"in"=>"path", "name"=>"end", "description"=>"The date of the last day to include, in YYYYMMDD format"}, {"in"=>"path", "name"=>"granularity", "description"=>"Time unit for the response data"}, {"in"=>"path", "name"=>"page-type", "description"=>"If you want to filter by page-type, use one of content (edits on pages in contentnamespaces) or non-content (edits on pages in non-content namespaces)"}, {"in"=>"path", "name"=>"project", "description"=>"The name of any Wikimedia project formatted like {language code}"}, {"in"=>"path", "name"=>"start", "description"=>"The date of the first day to include, in YYYYMMDD format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/bytes-difference/net/aggregate/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Get the sum of net text bytes difference between current edit and previous one.", "description"=>"Given a Mediawiki project and a date range, returns a timeseries of bytes difference net\nsums. You can filter by editors-type (all-editor-types, anonymous, group-bot, name-bot,\nuser) and page-type (all-page-types, content or non-content). You can choose between\ndaily and monthly granularity as well.\n\n- Stability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-mediawiki-project-and-a-date-range-returns-a-timeseries-of-bytes-difference-netsums-you-can-", "x-api-path-slug"=>"metricsbytesdifferencenetaggregateprojecteditortypepagetypegranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"editor-type", "description"=>"If you want to filter by editor-type, use one of anonymous, group-bot (registeredaccounts belonging to the bot group), name-bot (registered accounts not belonging tothe bot group but having bot-like names) or user (registered account not in bot groupnor having bot-like name)"}, {"in"=>"path", "name"=>"end", "description"=>"The date of the last day to include, in YYYYMMDD format"}, {"in"=>"path", "name"=>"granularity", "description"=>"Time unit for the response data"}, {"in"=>"path", "name"=>"page-type", "description"=>"If you want to filter by page-type, use one of content (edits on pages in contentnamespaces) or non-content (edits on pages in non-content namespaces)"}, {"in"=>"path", "name"=>"project", "description"=>"The name of any Wikimedia project formatted like {language code}"}, {"in"=>"path", "name"=>"start", "description"=>"The date of the first day to include, in YYYYMMDD format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/edited-pages/aggregate/{project}/{editor-type}/{page-type}/{activity-level}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Get edited-pages counts for a project.", "description"=>"Given a Mediawiki project and a date range, returns a timeseries of its edited-pages counts.\nYou can filter by editor-type (all-editor-types, anonymous, group-bot, name-bot, user),\npage-type (all-page-types, content or non-content) or activity-level (1..4-edits,\n5..24-edits, 25..99-edits, 100..-edits). You can choose between daily and monthly\ngranularity as well.\n\n- Stability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-mediawiki-project-and-a-date-range-returns-a-timeseries-of-its-editedpages-countsyou-can-fil", "x-api-path-slug"=>"metricseditedpagesaggregateprojecteditortypepagetypeactivitylevelgranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"activity-level", "description"=>"If you want to filter by activity-level, use one of 1"}, {"in"=>"path", "name"=>"editor-type", "description"=>"If you want to filter by editor-type, use one of anonymous, group-bot (registeredaccounts belonging to the bot group), name-bot (registered accounts not belonging tothe bot group but having bot-like names) or user (registered account not in bot groupnor having bot-like name)"}, {"in"=>"path", "name"=>"end", "description"=>"The date of the last day to include, in YYYYMMDD format"}, {"in"=>"path", "name"=>"granularity", "description"=>"The time unit for the response data"}, {"in"=>"path", "name"=>"page-type", "description"=>"If you want to filter by page-type, use one of content (edited-pages in contentnamespaces) or non-content (edited-pages in non-content namespaces)"}, {"in"=>"path", "name"=>"project", "description"=>"The name of any Wikimedia project formatted like {language code}"}, {"in"=>"path", "name"=>"start", "description"=>"The date of the first day to include, in YYYYMMDD format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/edited-pages/new/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Get new pages counts for a project.", "description"=>"Given a Mediawiki project and a date range, returns a timeseries of its new pages counts.\nYou can filter by editor type (all-editor-types, anonymous, group-bot, name-bot, user)\nor page-type (all-page-types, content or non-content). You can choose between daily and\nmonthly granularity as well.\nThe new pages value is computed as follow:\n [number of created pages] - [number of deleted pages] + [number of restored pages]\nfor the chosen filters.\n\n- Stability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-mediawiki-project-and-a-date-range-returns-a-timeseries-of-its-new-pages-countsyou-can-filte", "x-api-path-slug"=>"metricseditedpagesnewprojecteditortypepagetypegranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"editor-type", "description"=>"If you want to filter by editor-type, use one of anonymous, group-bot (registeredaccounts belonging to the bot group), name-bot (registered accounts not belongingto the bot group but having bot-like names) or user (registered account not in botgroup nor having bot-like name)"}, {"in"=>"path", "name"=>"end", "description"=>"The date of the last day to include, in YYYYMMDD format"}, {"in"=>"path", "name"=>"granularity", "description"=>"The time unit for the response data"}, {"in"=>"path", "name"=>"page-type", "description"=>"If you want to filter by page-type, use one of content (new pages in contentnamespaces) or non-content (new pages in non-content namespaces)"}, {"in"=>"path", "name"=>"project", "description"=>"The name of any Wikimedia project formatted like {language code}"}, {"in"=>"path", "name"=>"start", "description"=>"The date of the first day to include, in YYYYMMDD format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/edited-pages/top-by-absolute-bytes-difference/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Get top 100 edited-pages by absolute bytes-difference.", "description"=>"Given a Mediawiki project and a date range, returns a timeseries of the top 100 edited-pages\nby absolute bytes-difference. You can filter by editor-type (all-editor-types, anonymous,\ngroup-bot, name-bot, user) or page-type (all-page-types, content or non-content). You can\nchoose between daily and monthly granularity as well.\n\n- Stability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-mediawiki-project-and-a-date-range-returns-a-timeseries-of-the-top-100-editedpagesby-absolut", "x-api-path-slug"=>"metricseditedpagestopbyabsolutebytesdifferenceprojecteditortypepagetypegranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"editor-type", "description"=>"If you want to filter by editor-type, use one of anonymous, group-bot (registeredaccounts belonging to the bot group), name-bot (registered accounts not belonging tothe bot group but having bot-like names) or user (registered account not in bot groupnor having bot-like name)"}, {"in"=>"path", "name"=>"end", "description"=>"The date of the last day to include, in YYYYMMDD format"}, {"in"=>"path", "name"=>"granularity", "description"=>"Time unit for the response data"}, {"in"=>"path", "name"=>"page-type", "description"=>"If you want to filter by page-type, use one of content (edits on pages in contentnamespaces) or non-content (edits on pages in non-content namespaces)"}, {"in"=>"path", "name"=>"project", "description"=>"The name of any Wikimedia project formatted like {language code}"}, {"in"=>"path", "name"=>"start", "description"=>"The date of the first day to include, in YYYYMMDD format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/edited-pages/top-by-edits/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Get top 100 edited-pages by edits count.", "description"=>"Given a Mediawiki project and a date range, returns a timeseries of the top 100 edited-pages\nby edits count. You can filter by editor-type (all-editor-types, anonymous, group-bot,\nname-bot, user) or page-type (all-page-types, content or non-content). You can choose\nbetween daily and monthly granularity as well.\n\n- Stability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-mediawiki-project-and-a-date-range-returns-a-timeseries-of-the-top-100-editedpagesby-edits-c", "x-api-path-slug"=>"metricseditedpagestopbyeditsprojecteditortypepagetypegranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"editor-type", "description"=>"If you want to filter by editor-type, use one of anonymous, group-bot (registeredaccounts belonging to the bot group), name-bot (registered accounts not belonging tothe bot group but having bot-like names) or user (registered account not in bot groupnor having bot-like name)"}, {"in"=>"path", "name"=>"end", "description"=>"The date of the last day to include, in YYYYMMDD format"}, {"in"=>"path", "name"=>"granularity", "description"=>"Time unit for the response data"}, {"in"=>"path", "name"=>"page-type", "description"=>"If you want to filter by page-type, use one of content (edits on pages in contentnamespaces) or non-content (edits on pages in non-content namespaces)"}, {"in"=>"path", "name"=>"project", "description"=>"The name of any Wikimedia project formatted like {language code}"}, {"in"=>"path", "name"=>"start", "description"=>"The date of the first day to include, in YYYYMMDD format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/edited-pages/top-by-net-bytes-difference/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Get top 100 edited-pages by net bytes-difference.", "description"=>"Given a Mediawiki project and a date range, returns a timeseries of the top 100 edited-pages\nby net bytes-difference. You can filter by editor-type (all-editor-types, anonymous,\ngroup-bot, name-bot, user) or page-type (all-page-types, content or non-content). You can\nchoose between daily and monthly granularity as well.\n\n- Stability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-mediawiki-project-and-a-date-range-returns-a-timeseries-of-the-top-100-editedpagesby-net-byt", "x-api-path-slug"=>"metricseditedpagestopbynetbytesdifferenceprojecteditortypepagetypegranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"editor-type", "description"=>"If you want to filter by editor-type, use one of anonymous, group-bot (registeredaccounts belonging to the bot group), name-bot (registered accounts not belonging tothe bot group but having bot-like names) or user (registered account not in bot groupnor having bot-like name)"}, {"in"=>"path", "name"=>"end", "description"=>"The date of the last day to include, in YYYYMMDD format"}, {"in"=>"path", "name"=>"granularity", "description"=>"Time unit for the response data"}, {"in"=>"path", "name"=>"page-type", "description"=>"If you want to filter by page-type, use one of content (edits on pages in contentnamespaces) or non-content (edits on pages in non-content namespaces)"}, {"in"=>"path", "name"=>"project", "description"=>"The name of any Wikimedia project formatted like {language code}"}, {"in"=>"path", "name"=>"start", "description"=>"The date of the first day to include, in YYYYMMDD format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/editors/aggregate/{project}/{editor-type}/{page-type}/{activity-level}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Get editors counts for a project.", "description"=>"Given a Mediawiki project and a date range, returns a timeseries of its editors counts.\nYou can filter by editory-type (all-editor-types, anonymous, group-bot, name-bot, user),\npage-type (all-page-types, content or non-content) or activity-level (1..4-edits,\n5..24-edits, 25..99-edits or 100..-edits). You can choose between daily and monthly\ngranularity as well.\n\n- Stability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-mediawiki-project-and-a-date-range-returns-a-timeseries-of-its-editors-countsyou-can-filter-", "x-api-path-slug"=>"metricseditorsaggregateprojecteditortypepagetypeactivitylevelgranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"activity-level", "description"=>"If you want to filter by activity-level, use one of 1"}, {"in"=>"path", "name"=>"editor-type", "description"=>"If you want to filter by editor-type, use one of anonymous, group-bot (registeredaccounts belonging to the bot group), name-bot (registered accounts not belongingto the bot group but having bot-like names) or user (registered account not in botgroup nor having bot-like name)"}, {"in"=>"path", "name"=>"end", "description"=>"The date of the last day to include, in YYYYMMDD format"}, {"in"=>"path", "name"=>"granularity", "description"=>"The time unit for the response data"}, {"in"=>"path", "name"=>"page-type", "description"=>"If you want to filter by page-type, use one of content (edits made in contentnamespaces) or non-content (edits made in non-content namespaces)"}, {"in"=>"path", "name"=>"project", "description"=>"The name of any Wikimedia project formatted like {language code}"}, {"in"=>"path", "name"=>"start", "description"=>"The date of the first day to include, in YYYYMMDD format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/editors/top-by-absolute-bytes-difference/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Get top 100 editors by absolute bytes-difference.", "description"=>"Given a Mediawiki project and a date range, returns a timeseries of the top 100 editors by\nabsolute bytes-difference. You can filter by editor-type (all-editor-types, anonymous,\ngroup-bot, name-bot, user) or page-type (all-page-types, content or non-content). You can\nchoose between daily and monthly granularity as well. The user_id returned is either the\nmediawiki user_id if user is registered, or his/her IP if the user is anonymous.\n\n- Stability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-mediawiki-project-and-a-date-range-returns-a-timeseries-of-the-top-100-editors-byabsolute-by", "x-api-path-slug"=>"metricseditorstopbyabsolutebytesdifferenceprojecteditortypepagetypegranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"editor-type", "description"=>"If you want to filter by editor-type, use one of anonymous, group-bot (registeredaccounts belonging to the bot group), name-bot (registered accounts not belonging tothe bot group but having bot-like names) or user (registered account not in bot groupnor having bot-like name)"}, {"in"=>"path", "name"=>"end", "description"=>"The date of the last day to include, in YYYYMMDD format"}, {"in"=>"path", "name"=>"granularity", "description"=>"Time unit for the response data"}, {"in"=>"path", "name"=>"page-type", "description"=>"If you want to filter by page-type, use one of content (edits on pages in contentnamespaces) or non-content (edits on pages in non-content namespaces)"}, {"in"=>"path", "name"=>"project", "description"=>"The name of any Wikimedia project formatted like {language code}"}, {"in"=>"path", "name"=>"start", "description"=>"The date of the first day to include, in YYYYMMDD format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/editors/top-by-edits/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Get top 100 editors by edits count.", "description"=>"Given a Mediawiki project and a date range, returns a timeseries of the top 100 editors by\nedits count. You can filter by editor-type (all-editor-types, anonymous, group-bot,\nname-bot, user) or page-type (all-page-types, content or non-content). You can choose\nbetween daily and monthly granularity as well. The user_id returned is either the\nmediawiki user_id if user is registered, or his/her IP if the user is anonymous.\n\n- Stability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-mediawiki-project-and-a-date-range-returns-a-timeseries-of-the-top-100-editors-byedits-count", "x-api-path-slug"=>"metricseditorstopbyeditsprojecteditortypepagetypegranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"editor-type", "description"=>"If you want to filter by editor-type, use one of anonymous, group-bot (registeredaccounts belonging to the bot group), name-bot (registered accounts not belonging tothe bot group but having bot-like names) or user (registered account not in bot groupnor having bot-like name)"}, {"in"=>"path", "name"=>"end", "description"=>"The date of the last day to include, in YYYYMMDD format"}, {"in"=>"path", "name"=>"granularity", "description"=>"Time unit for the response data"}, {"in"=>"path", "name"=>"page-type", "description"=>"If you want to filter by page-type, use one of content (edits on pages in contentnamespaces) or non-content (edits on pages in non-content namespaces)"}, {"in"=>"path", "name"=>"project", "description"=>"The name of any Wikimedia project formatted like {language code}"}, {"in"=>"path", "name"=>"start", "description"=>"The date of the first day to include, in YYYYMMDD format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/editors/top-by-net-bytes-difference/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Get top 100 editors by net bytes-difference.", "description"=>"Given a Mediawiki project and a date range, returns a timeseries of the top 100 editors by\nnet bytes-difference. You can filter by editor-type (all-editor-types, anonymous, group-bot,\nname-bot, user) or page-type (all-page-types, content or non-content). You can choose\nbetween daily and monthly granularity as well. The user_id returned is either the mediawiki\nuser_id if user is registered, or his/her IP if the user is anonymous.\n\n- Stability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-mediawiki-project-and-a-date-range-returns-a-timeseries-of-the-top-100-editors-bynet-bytesdi", "x-api-path-slug"=>"metricseditorstopbynetbytesdifferenceprojecteditortypepagetypegranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"editor-type", "description"=>"If you want to filter by editor-type, use one of anonymous, group-bot (registeredaccounts belonging to the bot group), name-bot (registered accounts not belonging tothe bot group but having bot-like names) or user (registered account not in bot groupnor having bot-like name)"}, {"in"=>"path", "name"=>"end", "description"=>"The date of the last day to include, in YYYYMMDD format"}, {"in"=>"path", "name"=>"granularity", "description"=>"Time unit for the response data"}, {"in"=>"path", "name"=>"page-type", "description"=>"If you want to filter by page-type, use one of content (edits on pages in contentnamespaces) or non-content (edits on pages in non-content namespaces)"}, {"in"=>"path", "name"=>"project", "description"=>"The name of any Wikimedia project formatted like {language code}"}, {"in"=>"path", "name"=>"start", "description"=>"The date of the first day to include, in YYYYMMDD format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/edits/aggregate/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Get edits counts for a project.", "description"=>"Given a Mediawiki project and a date range, returns a timeseries of edits counts.\nYou can filter by editors-type (all-editor-types, anonymous, bot, registered) and\npage-type (all-page-types, content or non-content). You can choose between daily and\nmonthly granularity as well.\n\n- Stability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-mediawiki-project-and-a-date-range-returns-a-timeseries-of-edits-countsyou-can-filter-by-edi", "x-api-path-slug"=>"metricseditsaggregateprojecteditortypepagetypegranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"editor-type", "description"=>"If you want to filter by editor-type, use one of anonymous, group-bot (registeredaccounts belonging to the bot group), name-bot (registered accounts not belongingto the bot group but having bot-like names) or user (registered account not in botgroup nor having bot-like name)"}, {"in"=>"path", "name"=>"end", "description"=>"The date of the last day to include, in YYYYMMDD format"}, {"in"=>"path", "name"=>"granularity", "description"=>"The time unit for the response data"}, {"in"=>"path", "name"=>"page-type", "description"=>"If you want to filter by page-type, use one of content (edits on pages in contentnamespaces) or non-content (edits on pages in non-content namespaces)"}, {"in"=>"path", "name"=>"project", "description"=>"The name of any Wikimedia project formatted like {language code}"}, {"in"=>"path", "name"=>"start", "description"=>"The date of the first day to include, in YYYYMMDD format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/legacy/pagecounts/aggregate/{project}/{access-site}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Given a project and a date range, returns a timeseries of pagecounts. You can filter by access site (mobile or desktop) and you can choose between monthly, daily and hourly granularity as well.", "description"=>"Given a project and a date range, returns a timeseries of pagecounts.\nYou can filter by access site (mobile or desktop) and you can choose between monthly,\ndaily and hourly granularity as well.\n\n- Stability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-project-and-a-date-range-returns-a-timeseries-of-pagecountsyou-can-filter-by-access-site-mob", "x-api-path-slug"=>"metricslegacypagecountsaggregateprojectaccesssitegranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"access-site", "description"=>"If you want to filter by access site, use one of desktop-site or mobile-site"}, {"in"=>"path", "name"=>"end", "description"=>"The timestamp of the last hour/day/month to include, in YYYYMMDDHH format"}, {"in"=>"path", "name"=>"granularity", "description"=>"The time unit for the response data"}, {"in"=>"path", "name"=>"project", "description"=>"The name of any Wikimedia project formatted like {language code}"}, {"in"=>"path", "name"=>"start", "description"=>"The timestamp of the first hour/day/month to include, in YYYYMMDDHH format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/pageviews/aggregate/{project}/{access}/{agent}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Get pageview counts for a project.", "description"=>"Given a date range, returns a timeseries of pageview counts. You can filter by project,\naccess method and/or agent type. You can choose between daily and hourly granularity\nas well.\n\n- Stability: [stable](https://www.mediawiki.org/wiki/API_versioning#Stable)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-date-range-returns-a-timeseries-of-pageview-counts-you-can-filter-by-projectaccess-method-an", "x-api-path-slug"=>"metricspageviewsaggregateprojectaccessagentgranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"access", "description"=>"If you want to filter by access method, use one of desktop, mobile-app or mobile-web"}, {"in"=>"path", "name"=>"agent", "description"=>"If you want to filter by agent type, use one of user or spider"}, {"in"=>"path", "name"=>"end", "description"=>"The timestamp of the last hour/day/month to include, in YYYYMMDDHH format"}, {"in"=>"path", "name"=>"granularity", "description"=>"The time unit for the response data"}, {"in"=>"path", "name"=>"project", "description"=>"If you want to filter by project, use the domain of any Wikimedia project,for example en"}, {"in"=>"path", "name"=>"start", "description"=>"The timestamp of the first hour/day/month to include, in YYYYMMDDHH format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/pageviews/per-article/{project}/{access}/{agent}/{article}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Get pageview counts for a page.", "description"=>"Given a Mediawiki article and a date range, returns a daily timeseries of its pageview\ncounts. You can also filter by access method and/or agent type.\n\n- Stability: [stable](https://www.mediawiki.org/wiki/API_versioning#Stable)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-mediawiki-article-and-a-date-range-returns-a-daily-timeseries-of-its-pageviewcounts-you-can-", "x-api-path-slug"=>"metricspageviewsperarticleprojectaccessagentarticlegranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"access", "description"=>"If you want to filter by access method, use one of desktop, mobile-appor mobile-web"}, {"in"=>"path", "name"=>"agent", "description"=>"If you want to filter by agent type, use one of user, bot or spider"}, {"in"=>"path", "name"=>"article", "description"=>"The title of any article in the specified project"}, {"in"=>"path", "name"=>"end", "description"=>"The date of the last day to include, in YYYYMMDD or YYYYMMDDHH format"}, {"in"=>"path", "name"=>"granularity", "description"=>"The time unit for the response data"}, {"in"=>"path", "name"=>"project", "description"=>"If you want to filter by project, use the domain of any Wikimedia project,for example en"}, {"in"=>"path", "name"=>"start", "description"=>"The date of the first day to include, in YYYYMMDD or YYYYMMDDHH format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/pageviews/top-by-country/{project}/{access}/{year}/{month}"=>{"get"=>{"summary"=>"Get pageviews by country and access method.", "description"=>"Lists the pageviews to this project, split by country of origin for a given month.\nBecause of privacy reasons, pageviews are given in a bucketed format, and countries\nwith less than 100 views do not get reported.\nStability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"lists-the-pageviews-to-this-project-split-by-country-of-origin-for-a-given-monthbecause-of-privacy-r", "x-api-path-slug"=>"metricspageviewstopbycountryprojectaccessyearmonth-get", "parameters"=>[{"in"=>"path", "name"=>"access", "description"=>"If you want to filter by access method, use one of desktop, mobile-app or mobile-web"}, {"in"=>"path", "name"=>"month", "description"=>"The month of the date for which to retrieve top countries, in MM format"}, {"in"=>"path", "name"=>"project", "description"=>"If you want to filter by project, use the domain of any Wikimedia project,for example en"}, {"in"=>"path", "name"=>"year", "description"=>"The year of the date for which to retrieve top countries, in YYYY format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/pageviews/top/{project}/{access}/{year}/{month}/{day}"=>{"get"=>{"summary"=>"Get the most viewed articles for a project.", "description"=>"Lists the 1000 most viewed articles for a given project and timespan (month or day).\nYou can filter by access method.\n\n- Stability: [stable](https://www.mediawiki.org/wiki/API_versioning#Stable)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"lists-the-1000-most-viewed-articles-for-a-given-project-and-timespan-month-or-dayyou-can-filter-by-a", "x-api-path-slug"=>"metricspageviewstopprojectaccessyearmonthday-get", "parameters"=>[{"in"=>"path", "name"=>"access", "description"=>"If you want to filter by access method, use one of desktop, mobile-app or mobile-web"}, {"in"=>"path", "name"=>"day", "description"=>"The day of the date for which to retrieve top articles, in DD format"}, {"in"=>"path", "name"=>"month", "description"=>"The month of the date for which to retrieve top articles, in MM format"}, {"in"=>"path", "name"=>"project", "description"=>"If you want to filter by project, use the domain of any Wikimedia project,for example en"}, {"in"=>"path", "name"=>"year", "description"=>"The year of the date for which to retrieve top articles, in YYYY format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/registered-users/new/{project}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Get newly registered users counts for a project.", "description"=>"Given a Mediawiki project and a date range, returns a timeseries of its newly registered\nusers counts. You can choose between daily and monthly granularity. The newly registered\nusers value is computed with self-created users only, not auto-login created ones.\n\n- Stability: [experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-mediawiki-project-and-a-date-range-returns-a-timeseries-of-its-newly-registeredusers-counts-", "x-api-path-slug"=>"metricsregisteredusersnewprojectgranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"end", "description"=>"The date of the last day to include, in YYYYMMDD format"}, {"in"=>"path", "name"=>"granularity", "description"=>"The time unit for the response data"}, {"in"=>"path", "name"=>"project", "description"=>"The name of any Wikimedia project formatted like {language code}"}, {"in"=>"path", "name"=>"start", "description"=>"The date of the first day to include, in YYYYMMDD format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/metrics/unique-devices/{project}/{access-site}/{granularity}/{start}/{end}"=>{"get"=>{"summary"=>"Get unique devices count per project", "description"=>"Given a project and a date range, returns a timeseries of unique devices counts.\nYou need to specify a project, and can filter by accessed site (mobile or desktop).\nYou can choose between daily and hourly granularity as well.\n\n- Stability: [stable](https://www.mediawiki.org/wiki/API_versioning#Stable)\n- Rate limit: 100 req/s\n- License: Data accessible via this endpoint is available under the\n [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).", "operationId"=>"given-a-project-and-a-date-range-returns-a-timeseries-of-unique-devices-countsyou-need-to-specify-a-", "x-api-path-slug"=>"metricsuniquedevicesprojectaccesssitegranularitystartend-get", "parameters"=>[{"in"=>"path", "name"=>"access-site", "description"=>"If you want to filter by accessed site, use one of desktop-site or mobile-site"}, {"in"=>"path", "name"=>"end", "description"=>"The timestamp of the last day/month to include, in YYYYMMDD format"}, {"in"=>"path", "name"=>"granularity", "description"=>"The time unit for the response data"}, {"in"=>"path", "name"=>"project", "description"=>"If you want to filter by project, use the domain of any Wikimedia project,for example en"}, {"in"=>"path", "name"=>"start", "description"=>"The timestamp of the first day/month to include, in YYYYMMDD format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/transform/html/from/{from_lang}/to/{to_lang}"=>{"post"=>{"summary"=>"Machine-translate content", "description"=>"Fetches the machine translation for the posted content from the source\nto the destination language.\n\nStability: [unstable](https://www.mediawiki.org/wiki/API_versioning#Unstable)", "operationId"=>"fetches-the-machine-translation-for-the-posted-content-from-the-sourceto-the-destination-languagesta", "x-api-path-slug"=>"transformhtmlfromfrom-langtoto-lang-post", "parameters"=>[{"in"=>"path", "name"=>"from_lang", "description"=>"The source language code"}, {"in"=>"formData", "name"=>"html", "description"=>"The HTML content to translate"}, {"in"=>"path", "name"=>"to_lang", "description"=>"The target language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/transform/html/from/{from_lang}/to/{to_lang}/{provider}"=>{"post"=>{"summary"=>"Machine-translate content", "description"=>"Fetches the machine translation for the posted content from the source\nto the destination language.\n\nStability: [unstable](https://www.mediawiki.org/wiki/API_versioning#Unstable)", "operationId"=>"fetches-the-machine-translation-for-the-posted-content-from-the-sourceto-the-destination-languagesta", "x-api-path-slug"=>"transformhtmlfromfrom-langtoto-langprovider-post", "parameters"=>[{"in"=>"path", "name"=>"from_lang", "description"=>"The source language code"}, {"in"=>"formData", "name"=>"html", "description"=>"The HTML content to translate"}, {"in"=>"path", "name"=>"provider", "description"=>"The machine translation provider id"}, {"in"=>"path", "name"=>"to_lang", "description"=>"The target language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/transform/list/languagepairs/"=>{"get"=>{"summary"=>"Lists the language pairs supported by the back-end", "description"=>"Fetches the list of language pairs the back-end service can translate\n\nStability: [unstable](https://www.mediawiki.org/wiki/API_versioning#Unstable)", "operationId"=>"fetches-the-list-of-language-pairs-the-backend-service-can-translatestability-unstablehttpswwwmediaw", "x-api-path-slug"=>"transformlistlanguagepairs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/transform/list/pair/{from}/{to}/"=>{"get"=>{"summary"=>"Lists the tools available for a language pair", "description"=>"Fetches the list of tools that are available for the given pair of languages.\n\nStability: [unstable](https://www.mediawiki.org/wiki/API_versioning#Unstable)", "operationId"=>"fetches-the-list-of-tools-that-are-available-for-the-given-pair-of-languagesstability-unstablehttpsw", "x-api-path-slug"=>"transformlistpairfromto-get", "parameters"=>[{"in"=>"path", "name"=>"from", "description"=>"The source language code"}, {"in"=>"path", "name"=>"to", "description"=>"The target language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/transform/list/tool/{tool}/"=>{"get"=>{"summary"=>"Lists the tools and language pairs available for the given tool category", "description"=>"Fetches the list of tools and all of the language pairs it can translate\n\nStability: [unstable](https://www.mediawiki.org/wiki/API_versioning#Unstable)", "operationId"=>"fetches-the-list-of-tools-and-all-of-the-language-pairs-it-can-translatestability-unstablehttpswwwme", "x-api-path-slug"=>"transformlisttooltool-get", "parameters"=>[{"in"=>"path", "name"=>"tool", "description"=>"The tool category to list tools and language pairs for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/transform/word/from/{from_lang}/to/{to_lang}/{word}"=>{"get"=>{"summary"=>"Fetch the dictionary meaning of a word", "description"=>"Fetches the dictionary meaning of a word from a language and displays\nit in the target language.\n\nStability: [unstable](https://www.mediawiki.org/wiki/API_versioning#Unstable)", "operationId"=>"fetches-the-dictionary-meaning-of-a-word-from-a-language-and-displaysit-in-the-target-languagestabil", "x-api-path-slug"=>"transformwordfromfrom-langtoto-langword-get", "parameters"=>[{"in"=>"path", "name"=>"from_lang", "description"=>"The source language code"}, {"in"=>"path", "name"=>"to_lang", "description"=>"The target language code"}, {"in"=>"path", "name"=>"word", "description"=>"The word to lookup"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}, "/transform/word/from/{from_lang}/to/{to_lang}/{word}/{provider}"=>{"get"=>{"summary"=>"Fetch the dictionary meaning of a word", "description"=>"Fetches the dictionary meaning of a word from a language and displays\nit in the target language.\n\nStability: [unstable](https://www.mediawiki.org/wiki/API_versioning#Unstable)", "operationId"=>"fetches-the-dictionary-meaning-of-a-word-from-a-language-and-displaysit-in-the-target-languagestabil", "x-api-path-slug"=>"transformwordfromfrom-langtoto-langwordprovider-get", "parameters"=>[{"in"=>"path", "name"=>"from_lang", "description"=>"The source language code"}, {"in"=>"path", "name"=>"provider", "description"=>"The dictionary provider id"}, {"in"=>"path", "name"=>"to_lang", "description"=>"The target language code"}, {"in"=>"path", "name"=>"word", "description"=>"The word to lookup"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wiki"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
myspace-developers{"my-space-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"MySpace Developers", "x-complete"=>1, "info"=>{"title"=>"My Space", "description"=>"create-apps-and-games-within-the-myspace-platform--monetize-through-advertising-and-virtual-goods-", "version"=>"1.0.0"}, "host"=>"api.myspace.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/1.0/statusmoodcomments/{personId}/@self/{statusId}"=>{"post"=>{"summary"=>"Post Statusmoodcomments Personid Self Statusid", "description"=>"Posts a comment to a status.", "operationId"=>"1.0.statusmoodcomments.personId._self.statusId.post", "x-api-path-slug"=>"1-0statusmoodcommentspersonidselfstatusid-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"filterBy", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterOp", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterValue", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"selector", "description"=>"Indicates which set of individuals to query for activities"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}, {"in"=>"path", "name"=>"statusId", "description"=>"Specifies which status or mood to post a comment for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Statusmoodcomments", "People", "Self", "StatusId"]}}, "/1.0/statusmood/{personId}/{selector}/{friendId}/history"=>{"get"=>{"summary"=>"Get Statusmood Personid Selector Friendid History", "description"=>"Returns History Friend.", "operationId"=>"1.0.statusmood.personId.selector.friendId.history.get", "x-api-path-slug"=>"1-0statusmoodpersonidselectorfriendidhistory-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"filterBy", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterOp", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterValue", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"friendId", "description"=>"Is the same as {personId}, but for the persons friend"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"path", "name"=>"selector", "description"=>"Indicates which set of individuals to query for activities"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Statusmood", "People", "Selector", "FriendId", "History"]}}, "/1.0/statusmood/{personId}/{selector}/{friendId}"=>{"get"=>{"summary"=>"Get Statusmood Personid Selector Friendid", "description"=>"Returns a status for Friend.", "operationId"=>"1.0.statusmood.personId.selector.friendId.get", "x-api-path-slug"=>"1-0statusmoodpersonidselectorfriendid-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"filterBy", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterOp", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterValue", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"friendId", "description"=>"Is the same as {personId}, but for the persons friend"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"path", "name"=>"selector", "description"=>"Indicates which set of individuals to query for activities"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Statusmood", "People", "Selector", "FriendId"]}}, "/1.0/statusmood/{personId}/{selector}/history"=>{"get"=>{"summary"=>"Get Statusmood Personid Selector History", "description"=>"Returns History User.", "operationId"=>"1.0.statusmood.personId.selector.history.get", "x-api-path-slug"=>"1-0statusmoodpersonidselectorhistory-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"filterBy", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterOp", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterValue", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"path", "name"=>"selector", "description"=>"Indicates which set of individuals to query for activities"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Statusmood", "People", "Selector", "History"]}}, "/1.0/statusmood/{personId}/{selector}"=>{"put"=>{"summary"=>"Put Statusmood Personid Selector", "description"=>"Updates a status for User.", "operationId"=>"1.0.statusmood.personId.selector.put", "x-api-path-slug"=>"1-0statusmoodpersonidselector-put", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"filterBy", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterOp", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterValue", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"path", "name"=>"selector", "description"=>"Indicates which set of individuals to query for activities"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Statusmood", "People", "Selector"]}, "get"=>{"summary"=>"Get Statusmood Personid Selector", "description"=>"Returns a status for User.", "operationId"=>"1.0.statusmood.personId.selector.get", "x-api-path-slug"=>"1-0statusmoodpersonidselector-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"filterBy", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterOp", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterValue", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"path", "name"=>"selector", "description"=>"Indicates which set of individuals to query for activities"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Statusmood", "People", "Selector"]}}, "/1.0/statusmood/{personId}/@supportedMood/{moodId}"=>{"put"=>{"summary"=>"Put Statusmood Personid @supportedmood Moodid", "description"=>"Updates a mood.", "operationId"=>"1.0.statusmood.personId._supportedMood.moodId.put", "x-api-path-slug"=>"1-0statusmoodpersonidsupportedmoodmoodid-put", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"filterBy", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterOp", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterValue", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"moodId", "description"=>"The integer value of the specific mood that you want to retrieve data for"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Statusmood", "People", "Supported", "Mood", "MoodId"]}, "get"=>{"summary"=>"Get Statusmood Personid @supportedmood Moodid", "description"=>"Retrieves a mood.", "operationId"=>"1.0.statusmood.personId._supportedMood.moodId.get", "x-api-path-slug"=>"1-0statusmoodpersonidsupportedmoodmoodid-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"filterBy", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterOp", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterValue", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"moodId", "description"=>"The integer value of the specific mood that you want to retrieve data for"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Statusmood", "People", "Supported", "Mood", "MoodId"]}}, "/1.0/statusmood/{personId}/@supportedMood"=>{"post"=>{"summary"=>"Post Statusmood Personid @supportedmood", "description"=>"Adds a mood.", "operationId"=>"1.0.statusmood.personId._supportedMood.post", "x-api-path-slug"=>"1-0statusmoodpersonidsupportedmood-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"filterBy", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterOp", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterValue", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Statusmood", "People", "Supported", "Mood"]}, "get"=>{"summary"=>"Get Statusmood Personid @supportedmood", "description"=>"Retrieves all supported moods.", "operationId"=>"1.0.statusmood.personId._supportedMood.get", "x-api-path-slug"=>"1-0statusmoodpersonidsupportedmood-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"filterBy", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterOp", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"filterValue", "description"=>"See: http://wiki"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Statusmood", "People", "Supported", "Mood"]}}, "/1.0/mediaitemcomments/{personId}/@self/{albumId}/{mediaItemId}"=>{"get"=>{"summary"=>"Get Mediaitemcomments Personid Self Albums Mediaitemid", "description"=>"Retrieves item comments from a specified album.", "operationId"=>"1.0.mediaitemcomments.personId._self.albumId.mediaItemId.get", "x-api-path-slug"=>"1-0mediaitemcommentspersonidselfalbumidmediaitemid-get", "parameters"=>[{"in"=>"path", "name"=>"albumId", "description"=>"Indicates which single album from the group identified by {selector} should be returned"}, {"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"mediaItemId", "description"=>"Indicates which single media item from the album identified by {albumId} should be returned"}, {"in"=>"query", "name"=>"msPrivacyLevel", "description"=>"MySpace specific field"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mediaitemcomments", "People", "Self", "AlbumId", "MediaItemId"]}}, "/1.0/mediaItems/{personId}/@videos/@supportedcategories/{categoryId}"=>{"get"=>{"summary"=>"Get Mediaitems Personid Videos Supported Categories Categoryid", "description"=>"Retrieves videos for Category.", "operationId"=>"1.0.mediaItems.personId._videos._supportedcategories.categoryId.get", "x-api-path-slug"=>"1-0mediaitemspersonidvideossupportedcategoriescategoryid-get", "parameters"=>[{"in"=>"path", "name"=>"categoryId", "description"=>"Indicates the video category about which you want to retrieve data"}, {"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"msPrivacyLevel", "description"=>"MySpace specific field"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MediaItems", "People", "@videos", "Supported", "categories", "CategoryId"]}}, "/1.0/mediaItems/{personId}/@videos/@supportedcategories"=>{"get"=>{"summary"=>"Get Mediaitems Personid Videos Supported Categories", "description"=>"Retrieves supported categories.", "operationId"=>"1.0.mediaItems.personId._videos._supportedcategories.get", "x-api-path-slug"=>"1-0mediaitemspersonidvideossupportedcategories-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"msPrivacyLevel", "description"=>"MySpace specific field"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MediaItems", "People", "@videos", "Supported", "categories"]}}, "/1.0/mediaItems/{personId}/@self/@videos/{mediaItemId}"=>{"put"=>{"summary"=>"Put Mediaitems Personid Self Videos Mediaitemid", "description"=>"Updates an video.", "operationId"=>"1.0.mediaItems.personId._self._videos.mediaItemId.put", "x-api-path-slug"=>"1-0mediaitemspersonidselfvideosmediaitemid-put", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"mediaItemId", "description"=>"Indicates which single media item should be returned"}, {"in"=>"query", "name"=>"msPrivacyLevel", "description"=>"MySpace specific field"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MediaItems", "People", "Self", "@videos", "MediaItemId"]}, "get"=>{"summary"=>"Get Mediaitems Personid Self Videos Mediaitemid", "description"=>"Retrieves a video.", "operationId"=>"1.0.mediaItems.personId._self._videos.mediaItemId.get", "x-api-path-slug"=>"1-0mediaitemspersonidselfvideosmediaitemid-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"mediaItemId", "description"=>"Indicates which single media item should be returned"}, {"in"=>"query", "name"=>"msPrivacyLevel", "description"=>"MySpace specific field"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MediaItems", "People", "Self", "@videos", "MediaItemId"]}}, "/1.0/mediaItems/{personId}/@self/@videos"=>{"post"=>{"summary"=>"Post Mediaitems Personid Self Videos", "description"=>"Adds videos from a specified album.", "operationId"=>"1.0.mediaItems.personId._self._videos.post", "x-api-path-slug"=>"1-0mediaitemspersonidselfvideos-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"msPrivacyLevel", "description"=>"MySpace specific field"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MediaItems", "People", "Self", "@videos"]}, "get"=>{"summary"=>"Get Mediaitems Personid Self Videos", "description"=>"Retrieves all the videos.", "operationId"=>"1.0.mediaItems.personId._self._videos.get", "x-api-path-slug"=>"1-0mediaitemspersonidselfvideos-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"msPrivacyLevel", "description"=>"MySpace specific field"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MediaItems", "People", "Self", "@videos"]}}, "/1.0/mediaItems/{personId}/@self/{albumId}/{mediaItemId}"=>{"put"=>{"summary"=>"Put Mediaitems Personid Self Albums Mediaitemid", "description"=>"Updates an item from a specified album.", "operationId"=>"1.0.mediaItems.personId._self.albumId.mediaItemId.put", "x-api-path-slug"=>"1-0mediaitemspersonidselfalbumidmediaitemid-put", "parameters"=>[{"in"=>"path", "name"=>"albumId", "description"=>"Indicates which single album from the group identified by {selector} should be returned"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"mediaItemId", "description"=>"Indicates which single media item from the album identified by {albumId} should be returned"}, {"in"=>"query", "name"=>"msPrivacyLevel", "description"=>"MySpace specific field"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MediaItems", "People", "Self", "AlbumId", "MediaItemId"]}, "get"=>{"summary"=>"Get Mediaitems Personid Self Albums Mediaitemid", "description"=>"Retrieves an item from a specified album.", "operationId"=>"1.0.mediaItems.personId._self.albumId.mediaItemId.get", "x-api-path-slug"=>"1-0mediaitemspersonidselfalbumidmediaitemid-get", "parameters"=>[{"in"=>"path", "name"=>"albumId", "description"=>"Indicates which single album from the group identified by {selector} should be returned"}, {"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"mediaItemId", "description"=>"Indicates which single media item from the album identified by {albumId} should be returned"}, {"in"=>"query", "name"=>"msPrivacyLevel", "description"=>"MySpace specific field"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MediaItems", "People", "Self", "AlbumId", "MediaItemId"]}}, "/1.0/mediaItems/{personId}/@self/{albumId}"=>{"post"=>{"summary"=>"Post Mediaitems Personid Self Albums", "description"=>"Adds items from a specified album.", "operationId"=>"1.0.mediaItems.personId._self.albumId.post", "x-api-path-slug"=>"1-0mediaitemspersonidselfalbumid-post", "parameters"=>[{"in"=>"path", "name"=>"albumId", "description"=>"Indicates which single album from the group identified by {selector} should be returned"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"msPrivacyLevel", "description"=>"MySpace specific field"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MediaItems", "People", "Self", "AlbumId"]}, "get"=>{"summary"=>"Get Mediaitems Personid Self Albums", "description"=>"Retrieves items from a specified album.", "operationId"=>"1.0.mediaItems.personId._self.albumId.get", "x-api-path-slug"=>"1-0mediaitemspersonidselfalbumid-get", "parameters"=>[{"in"=>"path", "name"=>"albumId", "description"=>"Indicates which single album from the group identified by {selector} should be returned"}, {"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"msPrivacyLevel", "description"=>"MySpace specific field"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MediaItems", "People", "Self", "AlbumId"]}}, "/1.0/mediaItems/@supportedFields"=>{"get"=>{"summary"=>"Get Mediaitems Supported Fields", "description"=>"Retrieves all supported fields.", "operationId"=>"1.0.mediaItems._supportedFields.get", "x-api-path-slug"=>"1-0mediaitemssupportedfields-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"msPrivacyLevel", "description"=>"MySpace specific field"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MediaItems", "Supported", "Fields"]}}, "/stream/subscription/@all"=>{"delete"=>{"summary"=>"Delete Stream Subscription All", "description"=>"Deletes all subscriptions.", "operationId"=>"stream.subscription._all.delete", "x-api-path-slug"=>"streamsubscriptionall-delete", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stream", "Subscription", "@all"]}, "get"=>{"summary"=>"Get Stream Subscription All", "description"=>"Retrieves all subscriptions.", "operationId"=>"stream.subscription._all.get", "x-api-path-slug"=>"streamsubscriptionall-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stream", "Subscription", "@all"]}}, "/stream/subscription/{subscriptionId}"=>{"delete"=>{"summary"=>"Delete Stream Subscription Subscriptionid", "description"=>"Deletes a subscription.", "operationId"=>"stream.subscription.subscriptionId.delete", "x-api-path-slug"=>"streamsubscriptionsubscriptionid-delete", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"The subscriptions identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stream", "Subscription", "SubscriptionId"]}, "put"=>{"summary"=>"Put Stream Subscription Subscriptionid", "description"=>"Updates a subscription.", "operationId"=>"stream.subscription.subscriptionId.put", "x-api-path-slug"=>"streamsubscriptionsubscriptionid-put", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"The subscriptions identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stream", "Subscription", "SubscriptionId"]}, "get"=>{"summary"=>"Get Stream Subscription Subscriptionid", "description"=>"Retrieves a subscription.", "operationId"=>"stream.subscription.subscriptionId.get", "x-api-path-slug"=>"streamsubscriptionsubscriptionid-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"The subscriptions identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stream", "Subscription", "SubscriptionId"]}}, "/stream/subscription"=>{"post"=>{"summary"=>"Post Stream Subscription", "description"=>"Creates a subscription.", "operationId"=>"stream.subscription.post", "x-api-path-slug"=>"streamsubscription-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stream", "Subscription"]}}, "/opensearch/videos"=>{"get"=>{"summary"=>"Get Opensearch Veos", "description"=>"Returns search results for videos.", "operationId"=>"opensearch.videos.get", "x-api-path-slug"=>"opensearchvideos-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"culture", "description"=>"The culture context of the search"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"searchTerms", "description"=>"Free form search terms or query words"}, {"in"=>"query", "name"=>"startPage", "description"=>"Which page to start at for the results"}, {"in"=>"query", "name"=>"tag", "description"=>"Determine if searching on tags, as opposed to contents"}, {"in"=>"query", "name"=>"videoMode", "description"=>"Search for specific video types"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Opensearch", "Videos"]}}, "/opensearch/images"=>{"get"=>{"summary"=>"Get Opensearch Images", "description"=>"Returns search results for images.", "operationId"=>"opensearch.images.get", "x-api-path-slug"=>"opensearchimages-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"culture", "description"=>"The culture context of the search"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"searchTerms", "description"=>"Free form search terms or query words"}, {"in"=>"query", "name"=>"sortBy", "description"=>"How to sort the images"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Indicates whether to sort ascending or descending"}, {"in"=>"query", "name"=>"startPage", "description"=>"Which page to start at for the results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Opensearch", "Images"]}}, "/opensearch/people"=>{"get"=>{"summary"=>"Get Opensearch People", "description"=>"Returns search results for people.", "operationId"=>"opensearch.people.get", "x-api-path-slug"=>"opensearchpeople-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"countryCode", "description"=>"Country code to search with"}, {"in"=>"query", "name"=>"culture", "description"=>"The culture context of the search"}, {"in"=>"query", "name"=>"distance", "description"=>"Distance away from location to return results"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"gender", "description"=>"The gender to filter on"}, {"in"=>"query", "name"=>"hasPhoto", "description"=>"Filter for only those who have a photo"}, {"in"=>"query", "name"=>"latitude", "description"=>"Geographic latitude"}, {"in"=>"query", "name"=>"location", "description"=>"The location field, such as city, state and/or country"}, {"in"=>"query", "name"=>"longitude", "description"=>"Geographic longitude"}, {"in"=>"query", "name"=>"maxAge", "description"=>"Maximum age for returned people"}, {"in"=>"query", "name"=>"minAge", "description"=>"Minimum age for returned people"}, {"in"=>"query", "name"=>"searchBy", "description"=>"Which field the search should go through"}, {"in"=>"query", "name"=>"searchTerms", "description"=>"Free form search terms or query words"}, {"in"=>"query", "name"=>"startPage", "description"=>"Which page to start at for the results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Opensearch", "People"]}}, "/1.0/profilecomments/{personId}/@self"=>{"get"=>{"summary"=>"Get Profilecomments Personid Self", "description"=>"Retrieves profile comments.", "operationId"=>"1.0.profilecomments.personId._self.get", "x-api-path-slug"=>"1-0profilecommentspersonidself-get", "parameters"=>[{"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profilecomments", "People", "Self"]}}, "/1.0/people/{personId}/{selector}/{friendId}"=>{"get"=>{"summary"=>"Get People Personid Selector Friendid", "description"=>"Retrieves friend data.", "operationId"=>"1.0.people.personId.selector.friendId.get", "x-api-path-slug"=>"1-0peoplepersonidselectorfriendid-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"filterBy", "description"=>"@friends, hasapp, @topfriends, @toponlinefriends,networkpresence"}, {"in"=>"query", "name"=>"filterOp", "description"=>"contains, equalsSee: http://wiki"}, {"in"=>"query", "name"=>"filterValue", "description"=>", online, true|false See: http://wiki"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"friendId", "description"=>"Is the same as {personId}, but for the persons friend"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"path", "name"=>"selector", "description"=>"Indicates which set of individuals to query for activities"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People", "People", "Selector", "FriendId"]}}, "/1.0/people/{personId}/{selector}"=>{"get"=>{"summary"=>"Get People Personid Selector", "description"=>"Retrieves user data.", "operationId"=>"1.0.people.personId.selector.get", "x-api-path-slug"=>"1-0peoplepersonidselector-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"filterBy", "description"=>"@friends, hasapp, @topfriends, @toponlinefriends,networkpresence"}, {"in"=>"query", "name"=>"filterOp", "description"=>"contains, equalsSee: http://wiki"}, {"in"=>"query", "name"=>"filterValue", "description"=>", online, true|false See: http://wiki"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"path", "name"=>"selector", "description"=>"Indicates which set of individuals to query for activities"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People", "People", "Selector"]}}, "/1.0/people/@supportedFields"=>{"get"=>{"summary"=>"Get People Supported Fields", "description"=>"Retrieves all supported fields.", "operationId"=>"1.0.people._supportedFields.get", "x-api-path-slug"=>"1-0peoplesupportedfields-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People", "Supported", "Fields"]}}, "/1.0/appdata/{personId}/{selector}/{appId}"=>{"delete"=>{"summary"=>"Delete Appdata Personid Selector Appid", "description"=>"Deletes a specified user's application data.", "operationId"=>"1.0.appdata.personId.selector.appId.delete", "x-api-path-slug"=>"1-0appdatapersonidselectorappid-delete", "parameters"=>[{"in"=>"path", "name"=>"appId", "description"=>"The applications ID associated with the OAuth ConsumerKey/ConsumerSecret pair"}, {"in"=>"query", "name"=>"fields", "description"=>"The fields correspond to keys in the application data"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"path", "name"=>"selector", "description"=>"Indicates which set of individuals to query for activities"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appdata", "People", "Selector", "AppId"]}, "post"=>{"summary"=>"Post Appdata Personid Selector Appid", "description"=>"Adds or updates a specified user's application data.", "operationId"=>"1.0.appdata.personId.selector.appId.post", "x-api-path-slug"=>"1-0appdatapersonidselectorappid-post", "parameters"=>[{"in"=>"path", "name"=>"appId", "description"=>"The applications ID associated with the OAuth ConsumerKey/ConsumerSecret pair"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"query", "name"=>"fields", "description"=>"The fields correspond to keys in the application data"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"path", "name"=>"selector", "description"=>"Indicates which set of individuals to query for activities"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appdata", "People", "Selector", "AppId"]}, "get"=>{"summary"=>"Get Appdata Personid Selector Appid", "description"=>"Retrieves all application data for a specified user.", "operationId"=>"1.0.appdata.personId.selector.appId.get", "x-api-path-slug"=>"1-0appdatapersonidselectorappid-get", "parameters"=>[{"in"=>"path", "name"=>"appId", "description"=>"The applications ID associated with the OAuth ConsumerKey/ConsumerSecret pair"}, {"in"=>"query", "name"=>"fields", "description"=>"The fields correspond to keys in the application data"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"path", "name"=>"selector", "description"=>"Indicates which set of individuals to query for activities"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appdata", "People", "Selector", "AppId"]}}, "/1.0/notifications/{personId}/@self"=>{"post"=>{"summary"=>"Post Notifications Personid Self", "description"=>"Sends notification.", "operationId"=>"1.0.notifications.personId._self.post", "x-api-path-slug"=>"1-0notificationspersonidself-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "People", "Self"]}}, "/1.0/groups/{personId}"=>{"get"=>{"summary"=>"Get Groups Personid", "description"=>"Retrieves the current user's groups.", "operationId"=>"1.0.groups.personId.get", "x-api-path-slug"=>"1-0groupspersonid-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported: id and title"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"msPrivacyLevel", "description"=>"MySpace specific field"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "People"]}}, "/1.0/groups/@supportedFields"=>{"get"=>{"summary"=>"Get Groups Supported Fields", "description"=>"Retrieves all supported fields.", "operationId"=>"1.0.groups._supportedFields.get", "x-api-path-slug"=>"1-0groupssupportedfields-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported: id and title"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"msPrivacyLevel", "description"=>"MySpace specific field"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Supported", "Fields"]}}, "/1.0/albums/{personId}/@self/{albumId}"=>{"put"=>{"summary"=>"Put Albums Personid Self Albums", "description"=>"Update an Album.", "operationId"=>"1.0.albums.personId._self.albumId.put", "x-api-path-slug"=>"1-0albumspersonidselfalbumid-put", "parameters"=>[{"in"=>"path", "name"=>"albumId", "description"=>"Indicates which single album should be returned"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Albums", "People", "Self", "AlbumId"]}, "get"=>{"summary"=>"Get Albums Personid Self Albums", "description"=>"Retrieves an album.", "operationId"=>"1.0.albums.personId._self.albumId.get", "x-api-path-slug"=>"1-0albumspersonidselfalbumid-get", "parameters"=>[{"in"=>"path", "name"=>"albumId", "description"=>"Indicates which single album should be returned"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Albums", "People", "Self", "AlbumId"]}}, "/1.0/albums/{personId}/@self"=>{"post"=>{"summary"=>"Post Albums Personid Self", "description"=>"Adding an Album.", "operationId"=>"1.0.albums.personId._self.post", "x-api-path-slug"=>"1-0albumspersonidself-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Albums", "People", "Self"]}, "get"=>{"summary"=>"Get Albums Personid Self", "description"=>"Retrieves the current user's albums.", "operationId"=>"1.0.albums.personId._self.get", "x-api-path-slug"=>"1-0albumspersonidself-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"msPrivacyLevel", "description"=>"MySpace specific field"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Albums", "People", "Self"]}}, "/1.0/albums/@supportedFields"=>{"get"=>{"summary"=>"Get Albums Supported Fields", "description"=>"Retrieves all supported fields.", "operationId"=>"1.0.albums._supportedFields.get", "x-api-path-slug"=>"1-0albumssupportedfields-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"msPrivacyLevel", "description"=>"MySpace specific field"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Albums", "Supported", "Fields"]}}, "/1.0/activities/{personId}/{selector}/{appId}"=>{"get"=>{"summary"=>"Get Activities Personid Selector Appid", "description"=>"Retrieves activities created by an application.", "operationId"=>"1.0.activities.personId.selector.appId.get", "x-api-path-slug"=>"1-0activitiespersonidselectorappid-get", "parameters"=>[{"in"=>"path", "name"=>"appId", "description"=>"The applications ID associated with the OAuth ConsumerKey/ConsumerSecret pair"}, {"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"path", "name"=>"selector", "description"=>"Indicates which set of individuals to query for activities"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}, {"in"=>"query", "name"=>"updatedSince", "description"=>"Indicates the date before which no activities should be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activities", "People", "Selector", "AppId"]}}, "/1.0/activities/@supportedObjectTypes"=>{"get"=>{"summary"=>"Get Activities Supported Object Types", "description"=>"Retrieves all supported object types.", "operationId"=>"1.0.activities._supportedObjectTypes.get", "x-api-path-slug"=>"1-0activitiessupportedobjecttypes-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}, {"in"=>"query", "name"=>"updatedSince", "description"=>"Indicates the date before which no activities should be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activities", "Supported", "ObjectTypes"]}}, "/1.0/activities/@supportedVerbs"=>{"get"=>{"summary"=>"Get Activities Supported Verbs", "description"=>"Retrieves all supported verbs.", "operationId"=>"1.0.activities._supportedVerbs.get", "x-api-path-slug"=>"1-0activitiessupportedverbs-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}, {"in"=>"query", "name"=>"updatedSince", "description"=>"Indicates the date before which no activities should be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activities", "Supported", "Verbs"]}}, "/1.0/activities/@supportedFields"=>{"get"=>{"summary"=>"Get Activities Supported Fields", "description"=>"Retrieves all supported fields.", "operationId"=>"1.0.activities._supportedFields.get", "x-api-path-slug"=>"1-0activitiessupportedfields-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}, {"in"=>"query", "name"=>"updatedSince", "description"=>"Indicates the date before which no activities should be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activities", "Supported", "Fields"]}}, "/1.0/activities/{personId}/@self"=>{"post"=>{"summary"=>"Post Activities Personid Self", "description"=>"Creates an activity for the user.", "operationId"=>"1.0.activities.personId._self.post", "x-api-path-slug"=>"1-0activitiespersonidself-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activities", "People", "Self"]}}, "/1.0/activities/{personId}/{selector}"=>{"get"=>{"summary"=>"Get Activities Personid Selector", "description"=>"Retrieves all activities for the user or for the friends of the viewer.", "operationId"=>"1.0.activities.personId.selector.get", "x-api-path-slug"=>"1-0activitiespersonidselector-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Only returns the nearest multiple of 3 compared to the original value"}, {"in"=>"query", "name"=>"fields", "description"=>"The following field names are supported"}, {"in"=>"query", "name"=>"format", "description"=>"Determines the format of the response"}, {"in"=>"path", "name"=>"personId", "description"=>"The persons identifier"}, {"in"=>"path", "name"=>"selector", "description"=>"Indicates which set of individuals to query for activities"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Indicates the index of the first item to retrieve from the query set"}, {"in"=>"query", "name"=>"updatedSince", "description"=>"Indicates the date before which no activities should be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activities", "People", "Selector"]}}}}, "apis"=>{"name"=>"MySpace Developers", "x-slug"=>"myspace-developers", "description"=>"AskMyspace: http://askmyspace.com Twitter: http://twitter.com/Myspace Instagram: http://instagram.com/Myspace Tumblr: http://myspace.tumblr.com YouTube: http://www.youtube.com/Myspace", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1619-myspace-developers.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"4691", "tags"=>"API Provider,General Data,internet,Mobile,Opensocial,Profiles,Relative Data,Service API,Social,Social,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"myspace-developers/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"My Space", "x-api-slug"=>"my-space", "description"=>"AskMyspace: http://askmyspace.com Twitter: http://twitter.com/Myspace Instagram: http://instagram.com/Myspace Tumblr: http://myspace.tumblr.com YouTube: http://www.youtube.com/Myspace", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1619-myspace-developers.jpg", "humanURL"=>"http://wiki.developer.myspace.com/index.php?title=Category:RESTful_API", "baseURL"=>"https://api.myspace.com//", "tags"=>"API Provider,General Data,internet,Mobile,Opensocial,Profiles,Relative Data,Service API,Social,Social,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/myspace-developers/1-0activitiespersonidselector-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/myspace-developers/my-space-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://wiki.developer.myspace.com/index.php?title=Category:RESTful_API"}, {"type"=>"x-blog", "url"=>"http://www.myspace.com/pressroom?url=/company+blog/"}, {"type"=>"x-blog-rss", "url"=>"http://myspace.tekgroupweb.com/company+blog/rss.xml"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/myspace"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/myspace"}, {"type"=>"x-github", "url"=>"https://github.com/myspace"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/#!/MySpaceDevTeam"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Myspace"}, {"type"=>"x-website", "url"=>"http://myspace.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
barchart{"barchart-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Barchart", "x-complete"=>1, "info"=>{"title"=>"Barchart API", "description"=>"stock-futures-and-forex-quotes-and-historical-data-", "version"=>"1.0.0"}, "host"=>"marketdata.websol.barchart.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/getQuote.json"=>{"get"=>{"summary"=>"Get Quote", "description"=>"The getQuote API is used to request price data, either real-time, delayed or end-of-day, by symbol. In addition to Last Price or Settlement, other fields such as Open, High, Low, Close, Bid, Ask, 52-week high and low, and more are available.", "operationId"=>"getQuote", "x-api-path-slug"=>"getquote-json-get", "parameters"=>[{"in"=>"query", "name"=>"symbols", "description"=>"A symbol or code that identifies a financial instrument", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Quotes"]}}, "/getEquitiesByExchange.json"=>{"get"=>{"summary"=>"Get Equities by Exchange", "description"=>"Receive all real-time or delayed stock and/or index price data by exchange through a single onDemand query.", "operationId"=>"getEquitiesByExchange", "x-api-path-slug"=>"getequitiesbyexchange-json-get", "parameters"=>[{"in"=>"query", "name"=>"symbols", "description"=>"A symbol or code that identifies a financial instrument", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Equities"]}}, "/getFuturesByExchange.json"=>{"get"=>{"summary"=>"Get Futures by Exchange", "description"=>"Receive all real-time or delayed, or end-of-day Futures data by exchange through a single onDemand query.", "operationId"=>"getFuturesByExchange", "x-api-path-slug"=>"getfuturesbyexchange-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Futures"]}}, "/getClosePrice.json"=>{"get"=>{"summary"=>"Get Close Price", "description"=>"Get the close price for given instruments for the given date.", "operationId"=>"getClosePrice", "x-api-path-slug"=>"getcloseprice-json-get", "parameters"=>[{"in"=>"query", "name"=>"symbols", "description"=>"A symbol or code that identifies a financial instrument", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stocks", "Price"]}}}}, "apis"=>{"name"=>"Barchart", "x-slug"=>"barchart", "description"=>"Barchart.com is the leading provider of intraday stock and commodities real-time or delayed charts with powerful indicators and technical analysis.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/21632-www-barchart-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"15739", "tags"=>"API Provider,Market Data,Profiles,Publish,SaaS,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"barchart/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Barchart API", "x-api-slug"=>"barchart-api", "description"=>"Barchart.com is the leading provider of intraday stock and commodities real-time or delayed charts with powerful indicators and technical analysis.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/21632-www-barchart-com.jpg", "humanURL"=>"https://www.barchart.com", "baseURL"=>"https://marketdata.websol.barchart.com//", "tags"=>"API Provider,Market Data,Profiles,Publish,SaaS,Service API", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/barchart/getcloseprice-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/barchart/barchart-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/barchart-com"}, {"type"=>"x-email", "url"=>"solutions@barchart.com"}, {"type"=>"x-email", "url"=>"careers@barchart.com"}, {"type"=>"x-email", "url"=>"colleen.sheeren@barchart.com"}, {"type"=>"x-github", "url"=>"https://github.com/barchart"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Barchart"}, {"type"=>"x-website", "url"=>"https://www.barchart.com"}, {"type"=>"x-websockets", "url"=>"https://github.com/barchart/barchart-ondemand-client-js"}, {"type"=>"x-website", "url"=>"http://www.barchart.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
mastercard{"mastercard-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"MasterCard", "x-complete"=>1, "info"=>{"title"=>"MasterCard", "description"=>"as-a-technology-company-in-the-global-payments-business-we-operate-the-worlds-fastest-payments-processing-network-connecting-consumers-financial-institutions-merchants-governments-and-businesses-in-more-than-210-countries-and-territories--mastercards-products-and-solutions-make-everyday-commerce-activities--such-as-shopping-traveling-running-a-business-and-managing-finances--easier-more-secure-and-more-efficient-for-everyone-", "version"=>"1.0.0"}, "host"=>"eas5stl0.mastercard.int:13046", "basePath"=>"/z0/core/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/status"=>{"get"=>{"summary"=>"Get Status", "description"=>"Gets general metadata about the current state of the blockchain network.\nUseful for building dashboards.", "operationId"=>"getStatus", "x-api-path-slug"=>"status-get", "parameters"=>[{"in"=>"header", "name"=>"MCWSSAML", "description"=>"SAML Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Status"]}}, "/node"=>{"get"=>{"summary"=>"Get Node", "description"=>"By default, this call gets information about your local node and its\nconnections. The `scope` parameter enabled this query to be extended\nto get further information about nodes that are visible to your node.", "operationId"=>"getNode", "x-api-path-slug"=>"node-get", "parameters"=>[{"in"=>"header", "name"=>"MCWSSAML", "description"=>"SAML Authorization"}, {"in"=>"query", "name"=>"scope"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Node"]}}, "/node/{address}"=>{"get"=>{"summary"=>"Get Node Address", "description"=>"Information about a specific node may be retrieved by its address.\nThis is useful when navigating the network.", "operationId"=>"getNodeAddress", "x-api-path-slug"=>"nodeaddress-get", "parameters"=>[{"in"=>"path", "name"=>"address"}, {"in"=>"header", "name"=>"MCWSSAML", "description"=>"SAML Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Node", "Address"]}}, "/app/{id}"=>{"get"=>{"summary"=>"Get App", "description"=>"Information about an application referenced by the `id` parameter. If\nyou are permissioned to that application, this will also return the\nmessage definitions you will need to comply with to issue valid transaction\nentries for that application.", "operationId"=>"getApp", "x-api-path-slug"=>"appid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"MCWSSAML", "description"=>"SAML Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "App"]}, "post"=>{"summary"=>"Add App", "description"=>"When you are permissioned onto the network, you will be issued one or\nmore `id`s to use. You may then send or update configurations of the\ntransaction message types you wish to use. These are specified using\nProtocol Buffer version 3 files as specified\n[here](https://developers.google.com/protocol-buffers/docs/proto3)\nThis specification may be sent either as the canonical JSON transform\nor the native `.proto` file encoded as hex, base58 or base64.", "operationId"=>"postApp", "x-api-path-slug"=>"appid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"MCWSSAML", "description"=>"SAML Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "App"]}}, "/address/{address}"=>{"get"=>{"summary"=>"Get Address Address", "description"=>"Information about a particular address on the network. Note that this\ncall may return information about a blockchain node or a signing entity.\nAlso, the level of detail returned will vary depending on your permissions\nfor the query target.", "operationId"=>"getAddressAddress", "x-api-path-slug"=>"addressaddress-get", "parameters"=>[{"in"=>"path", "name"=>"address"}, {"in"=>"header", "name"=>"MCWSSAML", "description"=>"SAML Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Address", "Address"]}}, "/block"=>{"get"=>{"summary"=>"Get Block", "description"=>"By default, this call returns the last confirmed block, since the `from`\nand `to` parameters will both default to the last confirmed slot number.\nTo get a range of blocks, use the `from` and `to` parameters. Specifying\nonly the `from` parameter will get a range of blocks up to the current slot.\nNote that this also means that specifying `to` without `from` will result\nin an error since that will mean a negative range.\n\nFor each returned item, the data will contain header information from\nthe block binary, and references to the block entries via the merkle roots.\n\nNote that the maximum range request allowed is 600 entries.", "operationId"=>"getBlock", "x-api-path-slug"=>"block-get", "parameters"=>[{"in"=>"query", "name"=>"from", "description"=>"Specify the starting slot to return"}, {"in"=>"header", "name"=>"MCWSSAML", "description"=>"SAML Authorization"}, {"in"=>"query", "name"=>"to", "description"=>"Specify the last slot to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Block"]}}, "/block/{key}"=>{"get"=>{"summary"=>"Get Block Key", "description"=>"A specific block may be retrieved by its hash key. This is useful when\nnavigating the chain.", "operationId"=>"getBlockKey", "x-api-path-slug"=>"blockkey-get", "parameters"=>[{"in"=>"path", "name"=>"key", "description"=>"The hash key of the block to retrieve"}, {"in"=>"header", "name"=>"MCWSSAML", "description"=>"SAML Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Block", "Key"]}}, "/entry"=>{"put"=>{"summary"=>"Put Entry", "description"=>"Add a transaction entry for your application to the blockchain. Note that\nthis entry must be a valid message according to the application configuration\nthat you set up.", "operationId"=>"putEntry", "x-api-path-slug"=>"entry-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"MCWSSAML", "description"=>"SAML Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Entry"]}}, "/entry/{key}"=>{"get"=>{"summary"=>"Get Entry Key", "description"=>"Returns full detail of the value of the blockchain entry\nreferenced by the specified key, if it has been previously recorded\nby your node's key-value store (database).", "operationId"=>"getEntryKey", "x-api-path-slug"=>"entrykey-get", "parameters"=>[{"in"=>"path", "name"=>"key"}, {"in"=>"header", "name"=>"MCWSSAML", "description"=>"SAML Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Entry", "Key"]}}, "/support/encoding"=>{"post"=>{"summary"=>"Add Support Encoding", "description"=>"A utility function that can be used temporarily if you don't have a\nlibrary handy for a specific encoding. Provides transforms between\nBase-58, Base-64 and Hexadecimal encodings. You specify the input format\nand output format you wish, and a list of values to transcode.", "operationId"=>"postSupportEncoding", "x-api-path-slug"=>"supportencoding-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"MCWSSAML", "description"=>"SAML Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Support", "Encoding"]}}}}, "apis"=>{"name"=>"MasterCard", "x-slug"=>"mastercard", "description"=>"Mastercard is a leading global payments & technology company that connects consumers, businesses, merchants, issuers & governments around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/366-mastercard.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"48280", "tags"=>"API Provider,Blockchain,Blockchains,Commerce,Coupons,Finance,Finance,Financial Services,Hosting,Merchant,Merchants,Offers,Payments,Payments,Profiles,Relative Data,Service API,Shopping,Shopping,Stack,Stack Network,Target,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"mastercard/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Mastercard", "x-api-slug"=>"mastercard", "description"=>"Mastercard is a leading global payments & technology company that connects consumers, businesses, merchants, issuers & governments around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/366-mastercard.jpg", "humanURL"=>"https://developer.mastercard.com/", "baseURL"=>"https://eas5stl0.mastercard.int:13046//z0/core/v1", "tags"=>"API Provider,Blockchain,Blockchains,Commerce,Coupons,Finance,Finance,Financial Services,Hosting,Merchant,Merchants,Offers,Payments,Payments,Profiles,Relative Data,Service API,Shopping,Shopping,Stack,Stack Network,Target,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/mastercard/mastercard-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.simplify.com"}, {"type"=>"x-blog", "url"=>"https://developer.mastercard.com/portal/display/blogs/Developer+Blogs"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/mastercard"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/mastercard"}, {"type"=>"x-github", "url"=>"https://github.com/MasterCard"}, {"type"=>"x-website", "url"=>"https://developer.mastercard.com/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/AskMastercard"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/MasterCardDev"}, {"type"=>"x-webhook", "url"=>"https://www.simplify.com/commerce/docs/misc/webhooks"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
lisk{"lisk-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Lisk", "x-complete"=>1, "info"=>{"title"=>"Lisk API Documentation", "description"=>"-welcome-access-restrictionsthe-api-endpoints-are-by-default-restricted-to-a-whitelist-of-ips-that-can-be-found-in-config-json-in-the-section-api-access-whitelisthttpsgithub-comliskhqliskblob1-0-0config-jsonl35-if-you-want-your-api-to-be-accessable-by-the-public-you-can-do-this-by-changing-api-access-public-to-true-this-will-allow-anyone-to-make-requests-to-your-lisk-core-node-however-some-endpoints-stay-private-that-means-only-a-list-of-whitelisted-ips-can-successfully-make-api-calls-to-that-particular-endpointthis-includes-all-forging-related-api-calls-by-default-only-the-nodes-local-ip-is-included-in-the-whitelist-you-can-change-the-setting-in-config-json-in-the-section-forging-access-whitelisthttpsgithub-comliskhqliskblob1-0-0config-jsonl114-for-more-details-see-the-descriptions-at-the-respective-endpoint--requestschained-filter-parameters-are-logically-connected-with-and-http-is-the-supported-url-schema-by-default-to-enable-https-please-adjust-the-the-sslhttpsgithub-comliskhqliskblob1-0-0config-jsonl124-section-in-config-json--responsesthe-general-response-format-is-json-applicationjson-the-responses-for-each-api-request-have-a-common-basic-structurejavascriptdata--contains-the-requested-datameta--contains-additional-metadata-e-g--the-values-of-limit-and-offsetlinks--will-contain-links-to-connected-api-calls-from-here-e-g--pagination-links-date-formatsmost-of-the-timestamp-parameters-are-in-the-lisk-timestamp-format-which-is-similar-to-the-unix-timestamp-format-the-lisk-timestamp-is-the-number-of-seconds-that-have-elapsed-since-the-lisk-epoch-time-20160524t170000-000z-not-counting-leap-seconds-the-lisk-epoch-time-is-returned-in-the-iso8601httpsen-wikipedia-orgwikiiso-8601-format-combined-date-and-time-yyyymmddthhmmssz-for-details-see-the-descriptions-and-examples-at-the-respective-endpoint--paginationone-can-paginate-nicely-through-the-results-by-providing-limit-and-offset-parameters-to-the-requests-limit-and-offset-can-be-found-in-the-metaobject-of-the-response-of-an-api-request-if-no-limit-and-offset-are-provided-they-are-set-to-10-and-0-by-default-what-will-display-the-first-10-results--list-of-endpointsall-possible-api-endpoints-for-lisk-core-are-listed-below-click-on-an-endpoint-to-show-descriptions-details-and-examples-", "version"=>"1.0.0"}, "basePath"=>"/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/accounts"=>{"get"=>{"summary"=>"Requests account data", "description"=>"Search for matching accounts in the system.", "operationId"=>"getAccounts", "x-api-path-slug"=>"accounts-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Address of an account"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit applied to results"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset value for results"}, {"in"=>"query", "name"=>"publicKey", "description"=>"Public key to query"}, {"in"=>"query", "name"=>"secondPublicKey", "description"=>"Second public key to query"}, {"in"=>"query", "name"=>"sort", "description"=>"Fields to sort results by"}, {"in"=>"query", "name"=>"username", "description"=>"Delegate username to query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Account", "Data"]}}, "/accounts/{address}/multisignature_groups"=>{"get"=>{"summary"=>"Requests multisignature groups data", "description"=>"Searches for the specified account in the system and responds with a list of the multisignature groups that this account is member of.", "operationId"=>"getMultisignatureGroups", "x-api-path-slug"=>"accountsaddressmultisignature-groups-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Lisk address of an account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Multisignature", "Groups", "Data"]}}, "/accounts/{address}/multisignature_memberships"=>{"get"=>{"summary"=>"Requests multisignature membership data", "description"=>"Searches for the specified multisignature group and responds with a list of all members of this particular multisignature group.", "operationId"=>"getMultisignatureMemberships", "x-api-path-slug"=>"accountsaddressmultisignature-memberships-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Lisk address of a multisignature account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Multisignature", "Membership", "Data"]}}, "/dapps"=>{"get"=>{"summary"=>"Requests dapps data", "description"=>"Search for a specified dapp in the system.", "operationId"=>"getDapps", "x-api-path-slug"=>"dapps-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limit applied to results"}, {"in"=>"query", "name"=>"name", "description"=>"Name to query - Fuzzy search"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset value for results"}, {"in"=>"query", "name"=>"sort", "description"=>"Fields to sort results by"}, {"in"=>"query", "name"=>"transactionId", "description"=>"Dapp registration transaction ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Dapps", "Data"]}}, "/peers"=>{"get"=>{"summary"=>"Requests peers data", "description"=>"Search for specified peers.", "operationId"=>"getPeers", "x-api-path-slug"=>"peers-get", "parameters"=>[{"in"=>"query", "name"=>"broadhash", "description"=>"Broadhash of the network"}, {"in"=>"query", "name"=>"height", "description"=>"Current height of the network"}, {"in"=>"query", "name"=>"httpPort", "description"=>"Http port of the node or delegate"}, {"in"=>"query", "name"=>"ip", "description"=>"IP of the node or delegate"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit applied to results"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset value for results"}, {"in"=>"query", "name"=>"os", "description"=>"OS of the node"}, {"in"=>"query", "name"=>"sort", "description"=>"Fields to sort results by"}, {"in"=>"query", "name"=>"state", "description"=>"Current state of the network"}, {"in"=>"query", "name"=>"version", "description"=>"Lisk version of the node"}, {"in"=>"query", "name"=>"wsPort", "description"=>"Web socket port for the node or delegate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Peers", "Data"]}}, "/node/constants"=>{"get"=>{"summary"=>"Requests constants data", "description"=>"Returns all current constants data on the system, e.g. Lisk epoch time and version.", "operationId"=>"getConstants", "x-api-path-slug"=>"nodeconstants-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Constants", "Data"]}}, "/node/status"=>{"get"=>{"summary"=>"Requests status data", "description"=>"Returns all current status data of the node, e.g. height and broadhash.", "operationId"=>"getStatus", "x-api-path-slug"=>"nodestatus-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Status", "Data"]}}, "/node/status/forging"=>{"get"=>{"summary"=>"Requests forging status of a delegate", "description"=>"*Attention! This is a **private endpoint only authorized to whitelisted IPs.**\nTo edit the whitelist, please edit the `forging.access.whitelist` section in `config.json`* \nResponds with the forging status of a delegate on a node.", "operationId"=>"getForgingStatus", "x-api-path-slug"=>"nodestatusforging-get", "parameters"=>[{"in"=>"query", "name"=>"publicKey", "description"=>"Public key to query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Forging", "Status", "Of", "Delegate"]}, "put"=>{"summary"=>"Toggles the forging status of a delegate", "description"=>"*Attention! This is a **private endpoint only authorized to whitelisted IPs.**\nTo edit the whitelist, please edit the `forging.access.whitelist` section in `config.json`* \nUpon passing the correct password and publicKey, forging will be enabled or disabled for the delegate of this particular node.\nThe password can be generated locally by encrypting your passphrase, either by using Lisk Commander or with Lisk Elements.", "operationId"=>"updateForgingStatus", "x-api-path-slug"=>"nodestatusforging-put", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"Password for decrypting passphrase of delegate with corresponding public key", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Toggles", "Forging", "Status", "Of", "Delegate"]}}, "/node/transactions/{state}"=>{"get"=>{"summary"=>"Requests unprocessed transactions data", "description"=>"By specifying the state of the transactions, you get a list of unprocessed transactions matching this state.\nSearch for specific transactions by providing the appropriate parameters.\nIf you post a batch of transactions, they will appear in the unprocessed list after a small delay, depending on server load.", "operationId"=>"getPooledTransactions", "x-api-path-slug"=>"nodetransactionsstate-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"Transaction id to query"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit applied to results"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset value for results"}, {"in"=>"query", "name"=>"recipientId", "description"=>"Recipient lisk address"}, {"in"=>"query", "name"=>"recipientPublicKey", "description"=>"Recipient public key"}, {"in"=>"query", "name"=>"senderId", "description"=>"Sender lisk address"}, {"in"=>"query", "name"=>"senderPublicKey", "description"=>"Sender public key"}, {"in"=>"query", "name"=>"sort", "description"=>"Fields to sort results by"}, {"in"=>"path", "name"=>"state", "description"=>"State of transactions to query"}, {"in"=>"query", "name"=>"type", "description"=>"Transaction type (0-7)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Unprocessed", "Transactions", "Data"]}}, "/delegates"=>{"get"=>{"summary"=>"Requests delegates data", "description"=>"Search for a specified delegate in the system.", "operationId"=>"getDelegates", "x-api-path-slug"=>"delegates-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Address of an account"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit applied to results"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset value for results"}, {"in"=>"query", "name"=>"publicKey", "description"=>"Public key to query"}, {"in"=>"query", "name"=>"search", "description"=>"Fuzzy delegate username to query"}, {"in"=>"query", "name"=>"secondPublicKey", "description"=>"Second public key to query"}, {"in"=>"query", "name"=>"sort", "description"=>"Fields to sort results by"}, {"in"=>"query", "name"=>"username", "description"=>"Delegate username to query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Delegates", "Data"]}}, "/delegates/forgers"=>{"get"=>{"summary"=>"Requests next forgers data", "description"=>"Returns a list of the next forgers in this delegate round.", "operationId"=>"getForgers", "x-api-path-slug"=>"delegatesforgers-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limit applied to results"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset value for results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Next", "Forgers", "Data"]}}, "/delegates/{address}/forging_statistics"=>{"get"=>{"summary"=>"Requests forging stats by delegate", "description"=>"By passing an existing delegate address and the desired unix timestamps, you can get its forging statistics within the specified timespan.\nIf no timestamps are provided, it will use the timestamps from Lisk epoch to current date.", "operationId"=>"getForgingStatistics", "x-api-path-slug"=>"delegatesaddressforging-statistics-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Lisk address of a delegate"}, {"in"=>"query", "name"=>"fromTimestamp", "description"=>"Starting unix timestamp"}, {"in"=>"query", "name"=>"toTimestamp", "description"=>"Ending unix timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Forging", "Stats", "By", "Delegate"]}}, "/blocks"=>{"get"=>{"summary"=>"Requests blocks data", "description"=>"Search for a specified block in the system.", "operationId"=>"getBlocks", "x-api-path-slug"=>"blocks-get", "parameters"=>[{"in"=>"query", "name"=>"blockId", "description"=>"Block id to query"}, {"in"=>"query", "name"=>"generatorPublicKey", "description"=>"Public key of the forger of the block"}, {"in"=>"query", "name"=>"height", "description"=>"Current height of the network"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit applied to results"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset value for results"}, {"in"=>"query", "name"=>"sort", "description"=>"Fields to sort results by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Blocks", "Data"]}}, "/voters"=>{"get"=>{"summary"=>"Requests voters data for a delegate", "description"=>"*Attention: At least **one of the filter parameters must be provided.***\nReturns all votes received by a delegate.", "operationId"=>"getVoters", "x-api-path-slug"=>"voters-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Address of an account"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit applied to results"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset value for results"}, {"in"=>"query", "name"=>"publicKey", "description"=>"Public key to query"}, {"in"=>"query", "name"=>"secondPublicKey", "description"=>"Second public key to query"}, {"in"=>"query", "name"=>"sort", "description"=>"Fields to sort results by"}, {"in"=>"query", "name"=>"username", "description"=>"Delegate username to query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Voters", "Dataa", "Delegate"]}}, "/votes"=>{"get"=>{"summary"=>"Requests votes data for an account", "description"=>"*Attention: At least **one of the filter parameters must be provided.***\nReturns all votes placed by an account.", "operationId"=>"getVotes", "x-api-path-slug"=>"votes-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Address of an account"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit applied to results"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset value for results"}, {"in"=>"query", "name"=>"publicKey", "description"=>"Public key to query"}, {"in"=>"query", "name"=>"secondPublicKey", "description"=>"Second public key to query"}, {"in"=>"query", "name"=>"sort", "description"=>"Fields to sort results by"}, {"in"=>"query", "name"=>"username", "description"=>"Delegate username to query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Votes", "Dataan", "Account"]}}, "/signatures"=>{"post"=>{"summary"=>"Submits a signature object to sign multisignature transactions", "description"=>"Submits signature to sign a multisignature transaction.\nSignature objects can be generated locally either by using Lisk Commander or with Lisk Elements.", "operationId"=>"postSignature", "x-api-path-slug"=>"signatures-post", "parameters"=>[{"in"=>"body", "name"=>"signature", "description"=>"Signature object to submit to the network", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Submits", "Signature", "Object", "To", "Sign", "Multisignature", "Transactions"]}}, "/transactions"=>{"get"=>{"summary"=>"Requests transactions data", "description"=>"Search for a specified transaction in the system.", "operationId"=>"getTransactions", "x-api-path-slug"=>"transactions-get", "parameters"=>[{"in"=>"query", "name"=>"blockId", "description"=>"Block id to query"}, {"in"=>"query", "name"=>"fromTimestamp", "description"=>"Starting unix timestamp"}, {"in"=>"query", "name"=>"height", "description"=>"Current height of the network"}, {"in"=>"query", "name"=>"id", "description"=>"Transaction id to query"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit applied to results"}, {"in"=>"query", "name"=>"maxAmount", "description"=>"Maximum transaction amount in Beddows"}, {"in"=>"query", "name"=>"minAmount", "description"=>"Minimum transaction amount in Beddows"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset value for results"}, {"in"=>"query", "name"=>"recipientId", "description"=>"Recipient lisk address"}, {"in"=>"query", "name"=>"recipientPublicKey", "description"=>"Recipient public key"}, {"in"=>"query", "name"=>"senderId", "description"=>"Sender lisk address"}, {"in"=>"query", "name"=>"senderIdOrRecipientId", "description"=>"Lisk address"}, {"in"=>"query", "name"=>"senderPublicKey", "description"=>"Sender public key"}, {"in"=>"query", "name"=>"sort", "description"=>"Fields to sort results by"}, {"in"=>"query", "name"=>"toTimestamp", "description"=>"Ending unix timestamp"}, {"in"=>"query", "name"=>"type", "description"=>"Transaction type (0-7)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Transactions", "Data"]}, "post"=>{"summary"=>"Submits signed transaction for processing", "description"=>"Submits signed transaction object for processing by the transaction pool.\nTransaction objects can be generated locally either by using Lisk Commander or with Lisk Elements.", "operationId"=>"postTransaction", "x-api-path-slug"=>"transactions-post", "parameters"=>[{"in"=>"body", "name"=>"transaction", "description"=>"Transaction object to submit to the network", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Submits", "Signed", "Transactionprocessing"]}}, "/spec"=>{"x-swagger-pipe"=>{"summary"=>"", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"spec-xswaggerpipe", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", ""]}}}}, "apis"=>{"name"=>"Lisk", "x-slug"=>"lisk", "description"=>"Lisk makes it easy for developers to build and deploy blockchain applications in JavaScript. Join the leading platform for world-changing dapps.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/26631-lisk.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"145661", "tags"=>"Blockchain,Enterprise,SaaS,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"lisk/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Lisk", "x-api-slug"=>"lisk", "description"=>"Lisk makes it easy for developers to build and deploy blockchain applications in JavaScript. Join the leading platform for world-changing dapps.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/26631-lisk.jpg", "humanURL"=>"https://lisk.io", "baseURL"=>"https:////api", "tags"=>"Blockchain,Enterprise,SaaS,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/lisk/lisk-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/lisk"}, {"type"=>"x-email", "url"=>"support@lisk.io"}, {"type"=>"x-email", "url"=>"dataprotection@lisk.io"}, {"type"=>"x-email", "url"=>"help@lisk.io"}, {"type"=>"x-email", "url"=>"business@lisk.io"}, {"type"=>"x-email", "url"=>"events@lisk.io"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/LiskHQ"}, {"type"=>"x-website", "url"=>"https://lisk.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-iot-hub{"azure-iot-hub-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure IoT Hub", "x-complete"=>1, "info"=>{"title"=>"iotHubClient", "description"=>"use-this-api-to-manage-the-iot-hubs-in-your-subscription-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}"=>{"get"=>{"summary"=>"Iot Hub Resource Get", "description"=>"Get the non-security related metadata of an IoT hub.", "operationId"=>"IotHubResource_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubsresourcename-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hub"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the IoT hub"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource"]}, "put"=>{"summary"=>"Iot Hub Resource Create Or Update", "description"=>"Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub.", "operationId"=>"IotHubResource_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubsresourcename-put", "parameters"=>[{"in"=>"body", "name"=>"iotHubDescription", "description"=>"The IoT hub metadata and security metadata", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hub"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the IoT hub to create or update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource"]}, "delete"=>{"summary"=>"Iot Hub Resource Delete", "description"=>"Delete an IoT hub.", "operationId"=>"IotHubResource_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubsresourcename-delete", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hub"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the IoT hub to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs"=>{"get"=>{"summary"=>"Iot Hub Resource List By Subscription", "description"=>"Get all the IoT hubs in a subscription.", "operationId"=>"IotHubResource_ListBySubscription", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-devicesiothubs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource Subscription"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs"=>{"get"=>{"summary"=>"Iot Hub Resource List By Resource Group", "description"=>"Get all the IoT hubs in a resource group.", "operationId"=>"IotHubResource_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubs-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hubs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource Resource Group"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats"=>{"get"=>{"summary"=>"Iot Hub Resource Get Stats", "description"=>"Get the statistics from an IoT hub.", "operationId"=>"IotHubResource_GetStats", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubsresourcenameiothubstats-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hub"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the IoT hub"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource Stats"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus"=>{"get"=>{"summary"=>"Iot Hub Resource Get Valid Skus", "description"=>"Get the list of valid SKUs for an IoT hub.", "operationId"=>"IotHubResource_GetValidSkus", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubsresourcenameskus-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hub"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the IoT hub"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource Valid Skus"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups"=>{"get"=>{"summary"=>"Iot Hub Resource List Event Hub Consumer Groups", "description"=>"Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.", "operationId"=>"IotHubResource_ListEventHubConsumerGroups", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubsresourcenameeventhubendpointseventhubendpointnameconsumergroups-get", "parameters"=>[{"in"=>"path", "name"=>"eventHubEndpointName", "description"=>"The name of the Event Hub-compatible endpoint"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hub"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the IoT hub"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource Event Hub Consumer Groups"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}"=>{"get"=>{"summary"=>"Iot Hub Resource Get Event Hub Consumer Group", "description"=>"Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.", "operationId"=>"IotHubResource_GetEventHubConsumerGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubsresourcenameeventhubendpointseventhubendpointnameconsumergroupsname-get", "parameters"=>[{"in"=>"path", "name"=>"eventHubEndpointName", "description"=>"The name of the Event Hub-compatible endpoint in the IoT hub"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the consumer group to retrieve"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hub"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the IoT hub"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource Event Hub Consumer Group"]}, "put"=>{"summary"=>"Iot Hub Resource Create Event Hub Consumer Group", "description"=>"Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.", "operationId"=>"IotHubResource_CreateEventHubConsumerGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubsresourcenameeventhubendpointseventhubendpointnameconsumergroupsname-put", "parameters"=>[{"in"=>"path", "name"=>"eventHubEndpointName", "description"=>"The name of the Event Hub-compatible endpoint in the IoT hub"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the consumer group to add"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hub"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the IoT hub"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource Event Hub Consumer Group"]}, "delete"=>{"summary"=>"Iot Hub Resource Delete Event Hub Consumer Group", "description"=>"Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.", "operationId"=>"IotHubResource_DeleteEventHubConsumerGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubsresourcenameeventhubendpointseventhubendpointnameconsumergroupsname-delete", "parameters"=>[{"in"=>"path", "name"=>"eventHubEndpointName", "description"=>"The name of the Event Hub-compatible endpoint in the IoT hub"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the consumer group to delete"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hub"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the IoT hub"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource Event Hub Consumer Group"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs"=>{"get"=>{"summary"=>"Iot Hub Resource List Jobs", "description"=>"Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.", "operationId"=>"IotHubResource_ListJobs", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubsresourcenamejobs-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hub"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the IoT hub"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource Jobs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}"=>{"get"=>{"summary"=>"Iot Hub Resource Get Job", "description"=>"Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.", "operationId"=>"IotHubResource_GetJob", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubsresourcenamejobsjobid-get", "parameters"=>[{"in"=>"path", "name"=>"jobId", "description"=>"The job identifier"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hub"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the IoT hub"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource Job"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics"=>{"get"=>{"summary"=>"Iot Hub Resource Get Quota Metrics", "description"=>"Get the quota metrics for an IoT hub.", "operationId"=>"IotHubResource_GetQuotaMetrics", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubsresourcenamequotametrics-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hub"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the IoT hub"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource Quota Metrics"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability"=>{"post"=>{"summary"=>"Iot Hub Resource Check Name Availability", "description"=>"Check if an IoT hub name is available.", "operationId"=>"IotHubResource_CheckNameAvailability", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-deviceschecknameavailability-post", "parameters"=>[{"in"=>"body", "name"=>"operationInputs", "description"=>"Set the name parameter in the OperationInputs structure to the name of the IoT hub to check", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource Name Availability"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys"=>{"post"=>{"summary"=>"Iot Hub Resource List Keys", "description"=>"Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.", "operationId"=>"IotHubResource_ListKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubsresourcenamelistkeys-post", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hub"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the IoT hub"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys"=>{"post"=>{"summary"=>"Iot Hub Resource Get Keys For Key Name", "description"=>"Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.", "operationId"=>"IotHubResource_GetKeysForKeyName", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubsresourcenameiothubkeyskeynamelistkeys-post", "parameters"=>[{"in"=>"path", "name"=>"keyName", "description"=>"The name of the shared access policy"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hub"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the IoT hub"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource Keys For Key Name"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices"=>{"post"=>{"summary"=>"Iot Hub Resource Export Devices", "description"=>"Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.", "operationId"=>"IotHubResource_ExportDevices", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubsresourcenameexportdevices-post", "parameters"=>[{"in"=>"body", "name"=>"exportDevicesParameters", "description"=>"The parameters that specify the export devices operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hub"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the IoT hub"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource Export Devices"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/importDevices"=>{"post"=>{"summary"=>"Iot Hub Resource Import Devices", "description"=>"Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.", "operationId"=>"IotHubResource_ImportDevices", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devicesiothubsresourcenameimportdevices-post", "parameters"=>[{"in"=>"body", "name"=>"importDevicesParameters", "description"=>"The parameters that specify the import devices operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the IoT hub"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the IoT hub"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Iot Hub Resource Import Devices"]}}}}, "apis"=>{"name"=>"Azure IoT Hub", "x-slug"=>"azure-iot-hub", "description"=>"Jumpstart your Internet of Things project with Microsoft IoT Hub. Connect, monitor, and control billions of IoT assets running on a broad set of operating systems and protocols. Establish reliable, bi-directional communication with these assets, even if they’re intermittently connected, and analyze—and act on—incoming telemetry data. Enhance the security of your IoT solutions by using per-device authentication to communicate with devices that have the appropriate credentials. Revoke access rights to specific devices to maintain the integrity of your system.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-iot-01-establish.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Devices,Internet of Things,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-iot-hub/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure IoT Hub API", "x-api-slug"=>"azure-iot-hub-api", "description"=>"Jumpstart your Internet of Things project with Microsoft IoT Hub. Connect, monitor, and control billions of IoT assets running on a broad set of operating systems and protocols. Establish reliable, bi-directional communication with these assets, even if they’re intermittently connected, and analyze—and act on—incoming telemetry data. Enhance the security of your IoT solutions by using per-device authentication to communicate with devices that have the appropriate credentials. Revoke access rights to specific devices to maintain the integrity of your system.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-iot-01-establish.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/iot-hub/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Devices,Internet of Things,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/azure-iot-hub/azure-iot-hub-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/iot-hub/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/iot-hub/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/iot-hub/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/iot-hub/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
gitlab{"apis"=>{"name"=>"GitLab", "x-slug"=>"gitlab", "description"=>"GitLab is a web-based Git-repository manager with wiki, issue-tracking and CI/CD pipelines features, using an open-source license, developed by GitLab Inc.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/githlab-logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"", "tags"=>"Code,Orchestration,Relative Data,Service API,Static,Versions,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"gitlab/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"GitLab", "x-api-slug"=>"gitlab", "description"=>"GitLab is a web-based Git-repository manager with wiki, issue-tracking and CI/CD pipelines features, using an open-source license, developed by GitLab Inc.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/githlab-logo.png", "humanURL"=>"http://gitlab.com", "baseURL"=>"https://localhost:3000//api", "tags"=>"Code,Orchestration,Relative Data,Service API,Static,Versions,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/gitlab/v3version-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/gitlab/gitlab-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.gitlab.com/"}, {"type"=>"x-github", "url"=>"https://github.com/gitlab"}, {"type"=>"x-openapi", "url"=>"https://axil.gitlab.io/swaggerapi/static/swagger.json"}, {"type"=>"x-pricing", "url"=>"https://about.gitlab.com/pricing/"}, {"type"=>"x-privacy-policy", "url"=>"https://about.gitlab.com/privacy/"}, {"type"=>"x-support", "url"=>"https://about.gitlab.com/getting-help/"}, {"type"=>"x-terms-of-service", "url"=>"https://about.gitlab.com/terms/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/gitlab"}, {"type"=>"x-webhook", "url"=>"https://docs.gitlab.com/ce/user/project/integrations/webhooks.html"}, {"type"=>"x-website", "url"=>"http://gitlab.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "gitlab-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"GitLab", "x-complete"=>1, "info"=>{"title"=>"API title", "version"=>"1.0.0"}, "host"=>"localhost:3000", "basePath"=>"/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v3/groups/{id}/access_requests"=>{"get"=>{"summary"=>"Get Groups Access Requests", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"getV3GroupsIdAccessRequests", "x-api-path-slug"=>"v3groupsidaccess-requests-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The group ID"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Access", "Requests"]}, "post"=>{"summary"=>"Post Groups Access Requests", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"postV3GroupsIdAccessRequests", "x-api-path-slug"=>"v3groupsidaccess-requests-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The group ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Access", "Requests"]}}, "/v3/groups/{id}/access_requests/{user_id}/approve"=>{"put"=>{"summary"=>"Put Groups Access Requests User Approve", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"putV3GroupsIdAccessRequestsUserIdApprove", "x-api-path-slug"=>"v3groupsidaccess-requestsuser-idapprove-put", "parameters"=>[{"in"=>"formData", "name"=>"access_level", "description"=>"A valid access level (defaults: `30`, developer access level)"}, {"in"=>"path", "name"=>"id", "description"=>"The group ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The user ID of the access requester"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Access", "Requests", "User", "Approve"]}}, "/v3/groups/{id}/access_requests/{user_id}"=>{"delete"=>{"summary"=>"Delete Groups Access Requests User", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"deleteV3GroupsIdAccessRequestsUserId", "x-api-path-slug"=>"v3groupsidaccess-requestsuser-id-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The group ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The user ID of the access requester"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Access", "Requests", "User"]}}, "/v3/groups"=>{"get"=>{"summary"=>"Get Groups", "description"=>"Get a groups list", "operationId"=>"getV3Groups", "x-api-path-slug"=>"v3groups-get", "parameters"=>[{"in"=>"query", "name"=>"all_available", "description"=>"Show all group that you have access to"}, {"in"=>"query", "name"=>"order_by", "description"=>"Order by name or path"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"search", "description"=>"Search for a specific group"}, {"in"=>"formData", "name"=>"skip_groups", "description"=>"Array of group ids to exclude from list"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort by asc (ascending) or desc (descending)"}, {"in"=>"query", "name"=>"statistics", "description"=>"Include project statistics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, "post"=>{"summary"=>"Post Groups", "description"=>"Create a group. Available only for users who can create groups.", "operationId"=>"postV3Groups", "x-api-path-slug"=>"v3groups-post", "parameters"=>[{"in"=>"formData", "name"=>"description", "description"=>"The description of the group"}, {"in"=>"formData", "name"=>"lfs_enabled", "description"=>"Enable/disable LFS for the projects in this group"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the group"}, {"in"=>"formData", "name"=>"path", "description"=>"The path of the group"}, {"in"=>"formData", "name"=>"request_access_enabled", "description"=>"Allow users to request member access"}, {"in"=>"formData", "name"=>"visibility_level", "description"=>"The visibility level of the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/v3/groups/owned"=>{"get"=>{"summary"=>"Get Groups Owned", "description"=>"Get list of owned groups for authenticated user", "operationId"=>"getV3GroupsOwned", "x-api-path-slug"=>"v3groupsowned-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"statistics", "description"=>"Include project statistics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Owned"]}}, "/v3/groups/{id}"=>{"put"=>{"summary"=>"Put Groups", "description"=>"Update a group. Available only for users who can administrate groups.", "operationId"=>"putV3GroupsId", "x-api-path-slug"=>"v3groupsid-put", "parameters"=>[{"in"=>"formData", "name"=>"description", "description"=>"The description of the group"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a group"}, {"in"=>"formData", "name"=>"lfs_enabled", "description"=>"Enable/disable LFS for the projects in this group"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the group"}, {"in"=>"formData", "name"=>"path", "description"=>"The path of the group"}, {"in"=>"formData", "name"=>"request_access_enabled", "description"=>"Allow users to request member access"}, {"in"=>"formData", "name"=>"visibility_level", "description"=>"The visibility level of the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, "get"=>{"summary"=>"Get Groups", "description"=>"Get a single group, with containing projects.", "operationId"=>"getV3GroupsId", "x-api-path-slug"=>"v3groupsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, "delete"=>{"summary"=>"Delete Groups", "description"=>"Remove a group.", "operationId"=>"deleteV3GroupsId", "x-api-path-slug"=>"v3groupsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/v3/groups/{id}/projects"=>{"get"=>{"summary"=>"Get Groups Projects", "description"=>"Get a list of projects in this group.", "operationId"=>"getV3GroupsIdProjects", "x-api-path-slug"=>"v3groupsidprojects-get", "parameters"=>[{"in"=>"query", "name"=>"archived", "description"=>"Limit by archived status"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a group"}, {"in"=>"query", "name"=>"order_by", "description"=>"Return projects ordered by field"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"search", "description"=>"Return list of authorized projects matching the search criteria"}, {"in"=>"query", "name"=>"simple", "description"=>"Return only the ID, URL, name, and path of each project"}, {"in"=>"query", "name"=>"sort", "description"=>"Return projects sorted in ascending and descending order"}, {"in"=>"query", "name"=>"visibility", "description"=>"Limit by visibility"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Projects"]}}, "/v3/groups/{id}/projects/{project_id}"=>{"post"=>{"summary"=>"Post Groups Projects Project", "description"=>"Transfer a project to the group namespace. Available only for admin.", "operationId"=>"postV3GroupsIdProjectsProjectId", "x-api-path-slug"=>"v3groupsidprojectsproject-id-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a group"}, {"in"=>"path", "name"=>"project_id", "description"=>"The ID or path of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Projects", "Project"]}}, "/v3/groups/{id}/issues"=>{"get"=>{"summary"=>"Get Groups Issues", "description"=>"Get a list of group issues", "operationId"=>"getV3GroupsIdIssues", "x-api-path-slug"=>"v3groupsidissues-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a group"}, {"in"=>"query", "name"=>"labels", "description"=>"Comma-separated list of label names"}, {"in"=>"query", "name"=>"milestone", "description"=>"Return issues for a specific milestone"}, {"in"=>"query", "name"=>"order_by", "description"=>"Return issues ordered by `created_at` or `updated_at` fields"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"sort", "description"=>"Return issues sorted in `asc` or `desc` order"}, {"in"=>"query", "name"=>"state", "description"=>"Return opened, closed, or all issues"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Issues"]}}, "/v3/groups/{id}/members"=>{"get"=>{"summary"=>"Get Groups Members", "description"=>"Gets a list of group or project members viewable by the authenticated user.", "operationId"=>"getV3GroupsIdMembers", "x-api-path-slug"=>"v3groupsidmembers-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The group ID"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"query", "description"=>"A query string to search for members"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Members"]}, "post"=>{"summary"=>"Post Groups Members", "description"=>"Adds a member to a group or project.", "operationId"=>"postV3GroupsIdMembers", "x-api-path-slug"=>"v3groupsidmembers-post", "parameters"=>[{"in"=>"formData", "name"=>"access_level", "description"=>"A valid access level (defaults: `30`, developer access level)"}, {"in"=>"formData", "name"=>"expires_at", "description"=>"Date string in the format YEAR-MONTH-DAY"}, {"in"=>"path", "name"=>"id", "description"=>"The group ID"}, {"in"=>"formData", "name"=>"user_id", "description"=>"The user ID of the new member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Members"]}}, "/v3/groups/{id}/members/{user_id}"=>{"get"=>{"summary"=>"Get Groups Members User", "description"=>"Gets a member of a group or project.", "operationId"=>"getV3GroupsIdMembersUserId", "x-api-path-slug"=>"v3groupsidmembersuser-id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The group ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The user ID of the member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Members", "User"]}, "put"=>{"summary"=>"Put Groups Members User", "description"=>"Updates a member of a group or project.", "operationId"=>"putV3GroupsIdMembersUserId", "x-api-path-slug"=>"v3groupsidmembersuser-id-put", "parameters"=>[{"in"=>"formData", "name"=>"access_level", "description"=>"A valid access level"}, {"in"=>"formData", "name"=>"expires_at", "description"=>"Date string in the format YEAR-MONTH-DAY"}, {"in"=>"path", "name"=>"id", "description"=>"The group ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The user ID of the new member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Members", "User"]}, "delete"=>{"summary"=>"Delete Groups Members User", "description"=>"Removes a user from a group or project.", "operationId"=>"deleteV3GroupsIdMembersUserId", "x-api-path-slug"=>"v3groupsidmembersuser-id-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The group ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The user ID of the member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Members", "User"]}}, "/v3/groups/{id}/notification_settings"=>{"get"=>{"summary"=>"Get Groups Notification Settings", "description"=>"This feature was introduced in GitLab 8.12", "operationId"=>"getV3GroupsIdNotificationSettings", "x-api-path-slug"=>"v3groupsidnotification-settings-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The group ID or project ID or project NAMESPACE/PROJECT_NAME"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Notification", "Settings"]}, "put"=>{"summary"=>"Put Groups Notification Settings", "description"=>"This feature was introduced in GitLab 8.12", "operationId"=>"putV3GroupsIdNotificationSettings", "x-api-path-slug"=>"v3groupsidnotification-settings-put", "parameters"=>[{"in"=>"formData", "name"=>"close_issue", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"close_merge_request", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"failed_pipeline", "description"=>"Enable/disable this notification"}, {"in"=>"path", "name"=>"id", "description"=>"The group ID or project ID or project NAMESPACE/PROJECT_NAME"}, {"in"=>"formData", "name"=>"level", "description"=>"The group notification level"}, {"in"=>"formData", "name"=>"merge_merge_request", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"new_issue", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"new_merge_request", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"new_note", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"reassign_issue", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"reassign_merge_request", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"reopen_issue", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"reopen_merge_request", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"success_pipeline", "description"=>"Enable/disable this notification"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Notification", "Settings"]}}, "/v3/projects/{id}/access_requests"=>{"get"=>{"summary"=>"Get Projects Access Requests", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"getV3ProjectsIdAccessRequests", "x-api-path-slug"=>"v3projectsidaccess-requests-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Access", "Requests"]}, "post"=>{"summary"=>"Post Projects Access Requests", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"postV3ProjectsIdAccessRequests", "x-api-path-slug"=>"v3projectsidaccess-requests-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Access", "Requests"]}}, "/v3/projects/{id}/access_requests/{user_id}/approve"=>{"put"=>{"summary"=>"Put Projects Access Requests User Approve", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"putV3ProjectsIdAccessRequestsUserIdApprove", "x-api-path-slug"=>"v3projectsidaccess-requestsuser-idapprove-put", "parameters"=>[{"in"=>"formData", "name"=>"access_level", "description"=>"A valid access level (defaults: `30`, developer access level)"}, {"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The user ID of the access requester"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Access", "Requests", "User", "Approve"]}}, "/v3/projects/{id}/access_requests/{user_id}"=>{"delete"=>{"summary"=>"Delete Projects Access Requests User", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"deleteV3ProjectsIdAccessRequestsUserId", "x-api-path-slug"=>"v3projectsidaccess-requestsuser-id-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The user ID of the access requester"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Access", "Requests", "User"]}}, "/v3/projects/{id}/issues/{issue_id}/award_emoji"=>{"get"=>{"summary"=>"Get Projects Issues Issue Award Emoji", "description"=>"Get projects issues issue award emoji.", "operationId"=>"getV3ProjectsIdIssuesIssueIdAwardEmoji", "x-api-path-slug"=>"v3projectsidissuesissue-idaward-emoji-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"issue_id", "description"=>"The ID of an Issue, Merge Request or Snippet"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue", "Award", "Emoji"]}, "post"=>{"summary"=>"Post Projects Issues Issue Award Emoji", "description"=>"Post projects issues issue award emoji.", "operationId"=>"postV3ProjectsIdIssuesIssueIdAwardEmoji", "x-api-path-slug"=>"v3projectsidissuesissue-idaward-emoji-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"issue_id"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of a award_emoji (without colons)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue", "Award", "Emoji"]}}, "/v3/projects/{id}/issues/{issue_id}/award_emoji/{award_id}"=>{"get"=>{"summary"=>"Get Projects Issues Issue Award Emoji Award", "description"=>"Get projects issues issue award emoji award.", "operationId"=>"getV3ProjectsIdIssuesIssueIdAwardEmojiAwardId", "x-api-path-slug"=>"v3projectsidissuesissue-idaward-emojiaward-id-get", "parameters"=>[{"in"=>"path", "name"=>"award_id", "description"=>"The ID of the award"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"issue_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue", "Award", "Emoji", "Award"]}, "delete"=>{"summary"=>"Delete Projects Issues Issue Award Emoji Award", "description"=>"Delete projects issues issue award emoji award.", "operationId"=>"deleteV3ProjectsIdIssuesIssueIdAwardEmojiAwardId", "x-api-path-slug"=>"v3projectsidissuesissue-idaward-emojiaward-id-delete", "parameters"=>[{"in"=>"path", "name"=>"award_id", "description"=>"The ID of an award emoji"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"issue_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue", "Award", "Emoji", "Award"]}}, "/v3/projects/{id}/issues/{issue_id}/notes/{note_id}/award_emoji"=>{"get"=>{"summary"=>"Get Projects Issues Issue Notes Note Award Emoji", "description"=>"Get projects issues issue notes note award emoji.", "operationId"=>"getV3ProjectsIdIssuesIssueIdNotesNoteIdAwardEmoji", "x-api-path-slug"=>"v3projectsidissuesissue-idnotesnote-idaward-emoji-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"issue_id"}, {"in"=>"path", "name"=>"note_id"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue", "Notes", "Note", "Award", "Emoji"]}, "post"=>{"summary"=>"Post Projects Issues Issue Notes Note Award Emoji", "description"=>"Post projects issues issue notes note award emoji.", "operationId"=>"postV3ProjectsIdIssuesIssueIdNotesNoteIdAwardEmoji", "x-api-path-slug"=>"v3projectsidissuesissue-idnotesnote-idaward-emoji-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"issue_id"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of a award_emoji (without colons)"}, {"in"=>"path", "name"=>"note_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue", "Notes", "Note", "Award", "Emoji"]}}, "/v3/projects/{id}/issues/{issue_id}/notes/{note_id}/award_emoji/{award_id}"=>{"get"=>{"summary"=>"Get Projects Issues Issue Notes Note Award Emoji Award", "description"=>"Get projects issues issue notes note award emoji award.", "operationId"=>"getV3ProjectsIdIssuesIssueIdNotesNoteIdAwardEmojiAwardId", "x-api-path-slug"=>"v3projectsidissuesissue-idnotesnote-idaward-emojiaward-id-get", "parameters"=>[{"in"=>"path", "name"=>"award_id", "description"=>"The ID of the award"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"issue_id"}, {"in"=>"path", "name"=>"note_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue", "Notes", "Note", "Award", "Emoji", "Award"]}, "delete"=>{"summary"=>"Delete Projects Issues Issue Notes Note Award Emoji Award", "description"=>"Delete projects issues issue notes note award emoji award.", "operationId"=>"deleteV3ProjectsIdIssuesIssueIdNotesNoteIdAwardEmojiAwardId", "x-api-path-slug"=>"v3projectsidissuesissue-idnotesnote-idaward-emojiaward-id-delete", "parameters"=>[{"in"=>"path", "name"=>"award_id", "description"=>"The ID of an award emoji"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"issue_id"}, {"in"=>"path", "name"=>"note_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue", "Notes", "Note", "Award", "Emoji", "Award"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/award_emoji"=>{"get"=>{"summary"=>"Get Projects Merge Requests Merge Request Award Emoji", "description"=>"Get projects merge requests merge request award emoji.", "operationId"=>"getV3ProjectsIdMergeRequestsMergeRequestIdAwardEmoji", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idaward-emoji-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id", "description"=>"The ID of an Issue, Merge Request or Snippet"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Award", "Emoji"]}, "post"=>{"summary"=>"Post Projects Merge Requests Merge Request Award Emoji", "description"=>"Post projects merge requests merge request award emoji.", "operationId"=>"postV3ProjectsIdMergeRequestsMergeRequestIdAwardEmoji", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idaward-emoji-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"merge_request_id"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of a award_emoji (without colons)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Award", "Emoji"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/award_emoji/{award_id}"=>{"get"=>{"summary"=>"Get Projects Merge Requests Merge Request Award Emoji Award", "description"=>"Get projects merge requests merge request award emoji award.", "operationId"=>"getV3ProjectsIdMergeRequestsMergeRequestIdAwardEmojiAwardId", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idaward-emojiaward-id-get", "parameters"=>[{"in"=>"path", "name"=>"award_id", "description"=>"The ID of the award"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"merge_request_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Award", "Emoji", "Award"]}, "delete"=>{"summary"=>"Delete Projects Merge Requests Merge Request Award Emoji Award", "description"=>"Delete projects merge requests merge request award emoji award.", "operationId"=>"deleteV3ProjectsIdMergeRequestsMergeRequestIdAwardEmojiAwardId", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idaward-emojiaward-id-delete", "parameters"=>[{"in"=>"path", "name"=>"award_id", "description"=>"The ID of an award emoji"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"merge_request_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Award", "Emoji", "Award"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/notes/{note_id}/award_emoji"=>{"get"=>{"summary"=>"Get Projects Merge Requests Merge Request Notes Note Award Emoji", "description"=>"Get projects merge requests merge request notes note award emoji.", "operationId"=>"getV3ProjectsIdMergeRequestsMergeRequestIdNotesNoteIdAwardEmoji", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idnotesnote-idaward-emoji-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"merge_request_id"}, {"in"=>"path", "name"=>"note_id"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Notes", "Note", "Award", "Emoji"]}, "post"=>{"summary"=>"Post Projects Merge Requests Merge Request Notes Note Award Emoji", "description"=>"Post projects merge requests merge request notes note award emoji.", "operationId"=>"postV3ProjectsIdMergeRequestsMergeRequestIdNotesNoteIdAwardEmoji", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idnotesnote-idaward-emoji-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"merge_request_id"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of a award_emoji (without colons)"}, {"in"=>"path", "name"=>"note_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Notes", "Note", "Award", "Emoji"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/notes/{note_id}/award_emoji/{award_id}"=>{"get"=>{"summary"=>"Get Projects Merge Requests Merge Request Notes Note Award Emoji Award", "description"=>"Get projects merge requests merge request notes note award emoji award.", "operationId"=>"getV3ProjectsIdMergeRequestsMergeRequestIdNotesNoteIdAwardEmojiAwardId", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idnotesnote-idaward-emojiaward-id-get", "parameters"=>[{"in"=>"path", "name"=>"award_id", "description"=>"The ID of the award"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"merge_request_id"}, {"in"=>"path", "name"=>"note_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Notes", "Note", "Award", "Emoji", "Award"]}, "delete"=>{"summary"=>"Delete Projects Merge Requests Merge Request Notes Note Award Emoji Award", "description"=>"Delete projects merge requests merge request notes note award emoji award.", "operationId"=>"deleteV3ProjectsIdMergeRequestsMergeRequestIdNotesNoteIdAwardEmojiAwardId", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idnotesnote-idaward-emojiaward-id-delete", "parameters"=>[{"in"=>"path", "name"=>"award_id", "description"=>"The ID of an award emoji"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"merge_request_id"}, {"in"=>"path", "name"=>"note_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Notes", "Note", "Award", "Emoji", "Award"]}}, "/v3/projects/{id}/snippets/{snippet_id}/award_emoji"=>{"get"=>{"summary"=>"Get Projects Snippets Snippet Award Emoji", "description"=>"Get projects snippets snippet award emoji.", "operationId"=>"getV3ProjectsIdSnippetsSnippetIdAwardEmoji", "x-api-path-slug"=>"v3projectsidsnippetssnippet-idaward-emoji-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"path", "name"=>"snippet_id", "description"=>"The ID of an Issue, Merge Request or Snippet"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Snippet", "Award", "Emoji"]}, "post"=>{"summary"=>"Post Projects Snippets Snippet Award Emoji", "description"=>"Post projects snippets snippet award emoji.", "operationId"=>"postV3ProjectsIdSnippetsSnippetIdAwardEmoji", "x-api-path-slug"=>"v3projectsidsnippetssnippet-idaward-emoji-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of a award_emoji (without colons)"}, {"in"=>"path", "name"=>"snippet_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Snippet", "Award", "Emoji"]}}, "/v3/projects/{id}/snippets/{snippet_id}/award_emoji/{award_id}"=>{"get"=>{"summary"=>"Get Projects Snippets Snippet Award Emoji Award", "description"=>"Get projects snippets snippet award emoji award.", "operationId"=>"getV3ProjectsIdSnippetsSnippetIdAwardEmojiAwardId", "x-api-path-slug"=>"v3projectsidsnippetssnippet-idaward-emojiaward-id-get", "parameters"=>[{"in"=>"path", "name"=>"award_id", "description"=>"The ID of the award"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"snippet_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Snippet", "Award", "Emoji", "Award"]}, "delete"=>{"summary"=>"Delete Projects Snippets Snippet Award Emoji Award", "description"=>"Delete projects snippets snippet award emoji award.", "operationId"=>"deleteV3ProjectsIdSnippetsSnippetIdAwardEmojiAwardId", "x-api-path-slug"=>"v3projectsidsnippetssnippet-idaward-emojiaward-id-delete", "parameters"=>[{"in"=>"path", "name"=>"award_id", "description"=>"The ID of an award emoji"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"snippet_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Snippet", "Award", "Emoji", "Award"]}}, "/v3/projects/{id}/snippets/{snippet_id}/notes/{note_id}/award_emoji"=>{"get"=>{"summary"=>"Get Projects Snippets Snippet Notes Note Award Emoji", "description"=>"Get projects snippets snippet notes note award emoji.", "operationId"=>"getV3ProjectsIdSnippetsSnippetIdNotesNoteIdAwardEmoji", "x-api-path-slug"=>"v3projectsidsnippetssnippet-idnotesnote-idaward-emoji-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"note_id"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"path", "name"=>"snippet_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Snippet", "Notes", "Note", "Award", "Emoji"]}, "post"=>{"summary"=>"Post Projects Snippets Snippet Notes Note Award Emoji", "description"=>"Post projects snippets snippet notes note award emoji.", "operationId"=>"postV3ProjectsIdSnippetsSnippetIdNotesNoteIdAwardEmoji", "x-api-path-slug"=>"v3projectsidsnippetssnippet-idnotesnote-idaward-emoji-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of a award_emoji (without colons)"}, {"in"=>"path", "name"=>"note_id"}, {"in"=>"path", "name"=>"snippet_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Snippet", "Notes", "Note", "Award", "Emoji"]}}, "/v3/projects/{id}/snippets/{snippet_id}/notes/{note_id}/award_emoji/{award_id}"=>{"get"=>{"summary"=>"Get Projects Snippets Snippet Notes Note Award Emoji Award", "description"=>"Get projects snippets snippet notes note award emoji award.", "operationId"=>"getV3ProjectsIdSnippetsSnippetIdNotesNoteIdAwardEmojiAwardId", "x-api-path-slug"=>"v3projectsidsnippetssnippet-idnotesnote-idaward-emojiaward-id-get", "parameters"=>[{"in"=>"path", "name"=>"award_id", "description"=>"The ID of the award"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"note_id"}, {"in"=>"path", "name"=>"snippet_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Snippet", "Notes", "Note", "Award", "Emoji", "Award"]}, "delete"=>{"summary"=>"Delete Projects Snippets Snippet Notes Note Award Emoji Award", "description"=>"Delete projects snippets snippet notes note award emoji award.", "operationId"=>"deleteV3ProjectsIdSnippetsSnippetIdNotesNoteIdAwardEmojiAwardId", "x-api-path-slug"=>"v3projectsidsnippetssnippet-idnotesnote-idaward-emojiaward-id-delete", "parameters"=>[{"in"=>"path", "name"=>"award_id", "description"=>"The ID of an award emoji"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"note_id"}, {"in"=>"path", "name"=>"snippet_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Snippet", "Notes", "Note", "Award", "Emoji", "Award"]}}, "/v3/projects/{id}/boards"=>{"get"=>{"summary"=>"Get Projects Boards", "description"=>"This feature was introduced in 8.13", "operationId"=>"getV3ProjectsIdBoards", "x-api-path-slug"=>"v3projectsidboards-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Boards"]}}, "/v3/projects/{id}/repository/branches"=>{"get"=>{"summary"=>"Get Projects Repository Branches", "description"=>"Get a project repository branches", "operationId"=>"getV3ProjectsIdRepositoryBranches", "x-api-path-slug"=>"v3projectsidrepositorybranches-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Branches"]}, "post"=>{"summary"=>"Post Projects Repository Branches", "description"=>"Post projects repository branches.", "operationId"=>"postV3ProjectsIdRepositoryBranches", "x-api-path-slug"=>"v3projectsidrepositorybranches-post", "parameters"=>[{"in"=>"formData", "name"=>"branch_name", "description"=>"The name of the branch"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"ref", "description"=>"Create branch from commit sha or existing branch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Branches"]}}, "/v3/projects/{id}/repository/branches/{branch}"=>{"get"=>{"summary"=>"Get Projects Repository Branches Branch", "description"=>"Get projects repository branches branch.", "operationId"=>"getV3ProjectsIdRepositoryBranchesBranch", "x-api-path-slug"=>"v3projectsidrepositorybranchesbranch-get", "parameters"=>[{"in"=>"path", "name"=>"branch", "description"=>"The name of the branch"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Branches", "Branch"]}, "delete"=>{"summary"=>"Delete Projects Repository Branches Branch", "description"=>"Delete projects repository branches branch.", "operationId"=>"deleteV3ProjectsIdRepositoryBranchesBranch", "x-api-path-slug"=>"v3projectsidrepositorybranchesbranch-delete", "parameters"=>[{"in"=>"path", "name"=>"branch", "description"=>"The name of the branch"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Branches", "Branch"]}}, "/v3/projects/{id}/repository/branches/{branch}/protect"=>{"put"=>{"summary"=>"Put Projects Repository Branches Branch Protect", "description"=>"Put projects repository branches branch protect.", "operationId"=>"putV3ProjectsIdRepositoryBranchesBranchProtect", "x-api-path-slug"=>"v3projectsidrepositorybranchesbranchprotect-put", "parameters"=>[{"in"=>"path", "name"=>"branch", "description"=>"The name of the branch"}, {"in"=>"formData", "name"=>"developers_can_merge", "description"=>"Flag if developers can merge to that branch"}, {"in"=>"formData", "name"=>"developers_can_push", "description"=>"Flag if developers can push to that branch"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Branches", "Branch", "Protect"]}}, "/v3/projects/{id}/repository/branches/{branch}/unprotect"=>{"put"=>{"summary"=>"Put Projects Repository Branches Branch Unprotect", "description"=>"Put projects repository branches branch unprotect.", "operationId"=>"putV3ProjectsIdRepositoryBranchesBranchUnprotect", "x-api-path-slug"=>"v3projectsidrepositorybranchesbranchunprotect-put", "parameters"=>[{"in"=>"path", "name"=>"branch", "description"=>"The name of the branch"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Branches", "Branch", "Unprotect"]}}, "/v3/projects/{id}/repository/merged_branches"=>{"delete"=>{"summary"=>"Delete Projects Repository Merged Branches", "description"=>"Delete projects repository merged branches.", "operationId"=>"deleteV3ProjectsIdRepositoryMergedBranches", "x-api-path-slug"=>"v3projectsidrepositorymerged-branches-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Merged", "Branches"]}}, "/v3/projects/{id}/builds"=>{"get"=>{"summary"=>"Get Projects Builds", "description"=>"Get a project builds", "operationId"=>"getV3ProjectsIdBuilds", "x-api-path-slug"=>"v3projectsidbuilds-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"scope", "description"=>"The scope of builds to show"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Builds"]}}, "/v3/projects/{id}/repository/commits/{sha}/builds"=>{"get"=>{"summary"=>"Get Projects Repository Commits Sha Builds", "description"=>"Get builds for a specific commit of a project", "operationId"=>"getV3ProjectsIdRepositoryCommitsShaBuilds", "x-api-path-slug"=>"v3projectsidrepositorycommitsshabuilds-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"scope", "description"=>"The scope of builds to show"}, {"in"=>"path", "name"=>"sha", "description"=>"The SHA id of a commit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Commits", "Sha", "Builds"]}}, "/v3/projects/{id}/builds/{build_id}"=>{"get"=>{"summary"=>"Get Projects Builds Build", "description"=>"Get a specific build of a project", "operationId"=>"getV3ProjectsIdBuildsBuildId", "x-api-path-slug"=>"v3projectsidbuildsbuild-id-get", "parameters"=>[{"in"=>"path", "name"=>"build_id", "description"=>"The ID of a build"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Builds", "Build"]}}, "/v3/projects/{id}/builds/{build_id}/artifacts"=>{"get"=>{"summary"=>"Get Projects Builds Build Artifacts", "description"=>"This feature was introduced in GitLab 8.5", "operationId"=>"getV3ProjectsIdBuildsBuildIdArtifacts", "x-api-path-slug"=>"v3projectsidbuildsbuild-idartifacts-get", "parameters"=>[{"in"=>"path", "name"=>"build_id", "description"=>"The ID of a build"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Builds", "Build", "Artifacts"]}}, "/v3/projects/{id}/builds/artifacts/{ref_name}/download"=>{"get"=>{"summary"=>"Get Projects Builds Artifacts Ref Name Download", "description"=>"Get projects builds artifacts ref name download.", "operationId"=>"getV3ProjectsIdBuildsArtifactsRefNameDownload", "x-api-path-slug"=>"v3projectsidbuildsartifactsref-namedownload-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"job", "description"=>"The name for the build"}, {"in"=>"path", "name"=>"ref_name", "description"=>"The ref from repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Builds", "Artifacts", "Ref", "Name", "Download"]}}, "/v3/projects/{id}/builds/{build_id}/trace"=>{"get"=>{"summary"=>"Get Projects Builds Build Trace", "description"=>"Get a trace of a specific build of a project", "operationId"=>"getV3ProjectsIdBuildsBuildIdTrace", "x-api-path-slug"=>"v3projectsidbuildsbuild-idtrace-get", "parameters"=>[{"in"=>"path", "name"=>"build_id", "description"=>"The ID of a build"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Builds", "Build", "Trace"]}}, "/v3/projects/{id}/builds/{build_id}/cancel"=>{"post"=>{"summary"=>"Post Projects Builds Build Cancel", "description"=>"Cancel a specific build of a project", "operationId"=>"postV3ProjectsIdBuildsBuildIdCancel", "x-api-path-slug"=>"v3projectsidbuildsbuild-idcancel-post", "parameters"=>[{"in"=>"path", "name"=>"build_id", "description"=>"The ID of a build"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Builds", "Build", "Cancel"]}}, "/v3/projects/{id}/builds/{build_id}/retry"=>{"post"=>{"summary"=>"Post Projects Builds Build Retry", "description"=>"Retry a specific build of a project", "operationId"=>"postV3ProjectsIdBuildsBuildIdRetry", "x-api-path-slug"=>"v3projectsidbuildsbuild-idretry-post", "parameters"=>[{"in"=>"path", "name"=>"build_id", "description"=>"The ID of a build"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Builds", "Build", "Retry"]}}, "/v3/projects/{id}/builds/{build_id}/erase"=>{"post"=>{"summary"=>"Post Projects Builds Build Erase", "description"=>"Erase build (remove artifacts and build trace)", "operationId"=>"postV3ProjectsIdBuildsBuildIdErase", "x-api-path-slug"=>"v3projectsidbuildsbuild-iderase-post", "parameters"=>[{"in"=>"path", "name"=>"build_id", "description"=>"The ID of a build"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Builds", "Build", "Erase"]}}, "/v3/projects/{id}/builds/{build_id}/artifacts/keep"=>{"post"=>{"summary"=>"Post Projects Builds Build Artifacts Keep", "description"=>"Keep the artifacts to prevent them from being deleted", "operationId"=>"postV3ProjectsIdBuildsBuildIdArtifactsKeep", "x-api-path-slug"=>"v3projectsidbuildsbuild-idartifactskeep-post", "parameters"=>[{"in"=>"path", "name"=>"build_id", "description"=>"The ID of a build"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Builds", "Build", "Artifacts", "Keep"]}}, "/v3/projects/{id}/builds/{build_id}/play"=>{"post"=>{"summary"=>"Post Projects Builds Build Play", "description"=>"This feature was added in GitLab 8.11", "operationId"=>"postV3ProjectsIdBuildsBuildIdPlay", "x-api-path-slug"=>"v3projectsidbuildsbuild-idplay-post", "parameters"=>[{"in"=>"path", "name"=>"build_id", "description"=>"The ID of a Build"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Builds", "Build", "Play"]}}, "/v3/projects/{id}/repository/commits"=>{"get"=>{"summary"=>"Get Projects Repository Commits", "description"=>"Get a project repository commits", "operationId"=>"getV3ProjectsIdRepositoryCommits", "x-api-path-slug"=>"v3projectsidrepositorycommits-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"page", "description"=>"The page for pagination"}, {"in"=>"query", "name"=>"path", "description"=>"The file path"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of results per page"}, {"in"=>"query", "name"=>"ref_name", "description"=>"The name of a repository branch or tag, if not given the default branch is used"}, {"in"=>"query", "name"=>"since", "description"=>"Only commits after or in this date will be returned"}, {"in"=>"query", "name"=>"until", "description"=>"Only commits before or in this date will be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Commits"]}, "post"=>{"summary"=>"Post Projects Repository Commits", "description"=>"This feature was introduced in GitLab 8.13", "operationId"=>"postV3ProjectsIdRepositoryCommits", "x-api-path-slug"=>"v3projectsidrepositorycommits-post", "parameters"=>[{"in"=>"formData", "name"=>"actions", "description"=>"Actions to perform in commit"}, {"in"=>"formData", "name"=>"author_email", "description"=>"Author email for commit"}, {"in"=>"formData", "name"=>"author_name", "description"=>"Author name for commit"}, {"in"=>"formData", "name"=>"branch_name", "description"=>"The name of branch"}, {"in"=>"formData", "name"=>"commit_message", "description"=>"Commit message"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Commits"]}}, "/v3/projects/{id}/repository/commits/{sha}"=>{"get"=>{"summary"=>"Get Projects Repository Commits Sha", "description"=>"Get projects repository commits sha.", "operationId"=>"getV3ProjectsIdRepositoryCommitsSha", "x-api-path-slug"=>"v3projectsidrepositorycommitssha-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"sha", "description"=>"A commit sha, or the name of a branch or tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Commits", "Sha"]}}, "/v3/projects/{id}/repository/commits/{sha}/diff"=>{"get"=>{"summary"=>"Get Projects Repository Commits Sha Diff", "description"=>"Get the diff for a specific commit of a project", "operationId"=>"getV3ProjectsIdRepositoryCommitsShaDiff", "x-api-path-slug"=>"v3projectsidrepositorycommitsshadiff-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"sha", "description"=>"A commit sha, or the name of a branch or tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Commits", "Sha", "Diff"]}}, "/v3/projects/{id}/repository/commits/{sha}/comments"=>{"get"=>{"summary"=>"Get Projects Repository Commits Sha Comments", "description"=>"Get projects repository commits sha comments.", "operationId"=>"getV3ProjectsIdRepositoryCommitsShaComments", "x-api-path-slug"=>"v3projectsidrepositorycommitsshacomments-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"path", "name"=>"sha", "description"=>"A commit sha, or the name of a branch or tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Commits", "Sha", "Comments"]}, "post"=>{"summary"=>"Post Projects Repository Commits Sha Comments", "description"=>"Post projects repository commits sha comments.", "operationId"=>"postV3ProjectsIdRepositoryCommitsShaComments", "x-api-path-slug"=>"v3projectsidrepositorycommitsshacomments-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"line", "description"=>"The line number"}, {"in"=>"formData", "name"=>"line_type", "description"=>"The type of the line"}, {"in"=>"formData", "name"=>"note", "description"=>"The text of the comment"}, {"in"=>"formData", "name"=>"path", "description"=>"The file path"}, {"in"=>"path", "name"=>"sha", "description"=>"The commits SHA"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Commits", "Sha", "Comments"]}}, "/v3/projects/{id}/repository/commits/{sha}/cherry_pick"=>{"post"=>{"summary"=>"Post Projects Repository Commits Sha Cherry Pick", "description"=>"Post projects repository commits sha cherry pick.", "operationId"=>"postV3ProjectsIdRepositoryCommitsShaCherryPick", "x-api-path-slug"=>"v3projectsidrepositorycommitsshacherry-pick-post", "parameters"=>[{"in"=>"formData", "name"=>"branch", "description"=>"The name of the branch"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"sha", "description"=>"A commit sha to be cherry picked"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Commits", "Sha", "Cherry", "Pick"]}}, "/v3/projects/{id}/repository/commits/{sha}/statuses"=>{"get"=>{"summary"=>"Get Projects Repository Commits Sha Statuses", "description"=>"Get projects repository commits sha statuses.", "operationId"=>"getV3ProjectsIdRepositoryCommitsShaStatuses", "x-api-path-slug"=>"v3projectsidrepositorycommitsshastatuses-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Show all statuses, default: false"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"name", "description"=>"The name"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"ref", "description"=>"The ref"}, {"in"=>"path", "name"=>"sha", "description"=>"The commit hash"}, {"in"=>"query", "name"=>"stage", "description"=>"The stage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Commits", "Sha", "Statuses"]}}, "/v3/projects/{id}/statuses/{sha}"=>{"post"=>{"summary"=>"Post Projects Statuses Sha", "description"=>"Post projects statuses sha.", "operationId"=>"postV3ProjectsIdStatusesSha", "x-api-path-slug"=>"v3projectsidstatusessha-post", "parameters"=>[{"in"=>"formData", "name"=>"context", "description"=>"A string label to differentiate this status from the status of other systems"}, {"in"=>"formData", "name"=>"description", "description"=>"A short description of the status"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"name", "description"=>"A string label to differentiate this status from the status of other systems"}, {"in"=>"formData", "name"=>"ref", "description"=>"The ref"}, {"in"=>"path", "name"=>"sha", "description"=>"The commit hash"}, {"in"=>"formData", "name"=>"state", "description"=>"The state of the status"}, {"in"=>"formData", "name"=>"target_url", "description"=>"The target URL to associate with this status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Statuses", "Sha"]}}, "/v3/projects/{id}/keys"=>{"get"=>{"summary"=>"Get Projects Keys", "description"=>"Get a specific project's deploy keys", "operationId"=>"getV3ProjectsIdKeys", "x-api-path-slug"=>"v3projectsidkeys-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Keys"]}, "post"=>{"summary"=>"Post Projects Keys", "description"=>"Add new deploy key to currently authenticated user", "operationId"=>"postV3ProjectsIdKeys", "x-api-path-slug"=>"v3projectsidkeys-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the project"}, {"in"=>"formData", "name"=>"key", "description"=>"The new deploy key"}, {"in"=>"formData", "name"=>"title", "description"=>"The name of the deploy key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Keys"]}}, "/v3/projects/{id}/keys/{key_id}"=>{"get"=>{"summary"=>"Get Projects Keys Key", "description"=>"Get projects keys key.", "operationId"=>"getV3ProjectsIdKeysKeyId", "x-api-path-slug"=>"v3projectsidkeyskey-id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"key_id", "description"=>"The ID of the deploy key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Keys", "Key"]}, "delete"=>{"summary"=>"Delete Projects Keys Key", "description"=>"Delete deploy key for a project", "operationId"=>"deleteV3ProjectsIdKeysKeyId", "x-api-path-slug"=>"v3projectsidkeyskey-id-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"key_id", "description"=>"The ID of the deploy key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Keys", "Key"]}}, "/v3/projects/{id}/keys/{key_id}/enable"=>{"post"=>{"summary"=>"Post Projects Keys Key Enable", "description"=>"This feature was added in GitLab 8.11", "operationId"=>"postV3ProjectsIdKeysKeyIdEnable", "x-api-path-slug"=>"v3projectsidkeyskey-idenable-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"key_id", "description"=>"The ID of the deploy key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Keys", "Key", "Enable"]}}, "/v3/projects/{id}/keys/{key_id}/disable"=>{"delete"=>{"summary"=>"Delete Projects Keys Key Disable", "description"=>"This feature was added in GitLab 8.11", "operationId"=>"deleteV3ProjectsIdKeysKeyIdDisable", "x-api-path-slug"=>"v3projectsidkeyskey-iddisable-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"key_id", "description"=>"The ID of the deploy key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Keys", "Key", "Disable"]}}, "/v3/projects/{id}/deploy_keys"=>{"get"=>{"summary"=>"Get Projects Deploy Keys", "description"=>"Get a specific project's deploy keys", "operationId"=>"getV3ProjectsIdDeployKeys", "x-api-path-slug"=>"v3projectsiddeploy-keys-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Deploy", "Keys"]}, "post"=>{"summary"=>"Post Projects Deploy Keys", "description"=>"Add new deploy key to currently authenticated user", "operationId"=>"postV3ProjectsIdDeployKeys", "x-api-path-slug"=>"v3projectsiddeploy-keys-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the project"}, {"in"=>"formData", "name"=>"key", "description"=>"The new deploy key"}, {"in"=>"formData", "name"=>"title", "description"=>"The name of the deploy key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Deploy", "Keys"]}}, "/v3/projects/{id}/deploy_keys/{key_id}"=>{"get"=>{"summary"=>"Get Projects Deploy Keys Key", "description"=>"Get projects deploy keys key.", "operationId"=>"getV3ProjectsIdDeployKeysKeyId", "x-api-path-slug"=>"v3projectsiddeploy-keyskey-id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"key_id", "description"=>"The ID of the deploy key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Deploy", "Keys", "Key"]}, "delete"=>{"summary"=>"Delete Projects Deploy Keys Key", "description"=>"Delete projects deploy keys key.", "operationId"=>"deleteV3ProjectsIdDeployKeysKeyId", "x-api-path-slug"=>"v3projectsiddeploy-keyskey-id-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"key_id", "description"=>"The ID of the deploy key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Deploy", "Keys", "Key"]}}, "/v3/projects/{id}/deploy_keys/{key_id}/enable"=>{"post"=>{"summary"=>"Post Projects Deploy Keys Key Enable", "description"=>"This feature was added in GitLab 8.11", "operationId"=>"postV3ProjectsIdDeployKeysKeyIdEnable", "x-api-path-slug"=>"v3projectsiddeploy-keyskey-idenable-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"key_id", "description"=>"The ID of the deploy key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Deploy", "Keys", "Key", "Enable"]}}, "/v3/projects/{id}/deploy_keys/{key_id}/disable"=>{"delete"=>{"summary"=>"Delete Projects Deploy Keys Key Disable", "description"=>"Delete projects deploy keys key disable.", "operationId"=>"deleteV3ProjectsIdDeployKeysKeyIdDisable", "x-api-path-slug"=>"v3projectsiddeploy-keyskey-iddisable-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"key_id", "description"=>"The ID of the deploy key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Deploy", "Keys", "Key", "Disable"]}}, "/v3/projects/{id}/deployments"=>{"get"=>{"summary"=>"Get Projects Deployments", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"getV3ProjectsIdDeployments", "x-api-path-slug"=>"v3projectsiddeployments-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Deployments"]}}, "/v3/projects/{id}/deployments/{deployment_id}"=>{"get"=>{"summary"=>"Get Projects Deployments Deployment", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"getV3ProjectsIdDeploymentsDeploymentId", "x-api-path-slug"=>"v3projectsiddeploymentsdeployment-id-get", "parameters"=>[{"in"=>"path", "name"=>"deployment_id", "description"=>"The deployment ID"}, {"in"=>"path", "name"=>"id", "description"=>"The project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Deployments", "Deployment"]}}, "/v3/projects/{id}/environments"=>{"get"=>{"summary"=>"Get Projects Environments", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"getV3ProjectsIdEnvironments", "x-api-path-slug"=>"v3projectsidenvironments-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Environments"]}, "post"=>{"summary"=>"Post Projects Environments", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"postV3ProjectsIdEnvironments", "x-api-path-slug"=>"v3projectsidenvironments-post", "parameters"=>[{"in"=>"formData", "name"=>"external_url", "description"=>"URL on which this deployment is viewable"}, {"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the environment to be created"}, {"in"=>"formData", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Environments"]}}, "/v3/projects/{id}/environments/{environment_id}"=>{"put"=>{"summary"=>"Put Projects Environments Environment", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"putV3ProjectsIdEnvironmentsEnvironmentId", "x-api-path-slug"=>"v3projectsidenvironmentsenvironment-id-put", "parameters"=>[{"in"=>"path", "name"=>"environment_id", "description"=>"The environment ID"}, {"in"=>"formData", "name"=>"external_url", "description"=>"The new URL on which this deployment is viewable"}, {"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"formData", "name"=>"name", "description"=>"The new environment name"}, {"in"=>"formData", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Environments", "Environment"]}, "delete"=>{"summary"=>"Delete Projects Environments Environment", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"deleteV3ProjectsIdEnvironmentsEnvironmentId", "x-api-path-slug"=>"v3projectsidenvironmentsenvironment-id-delete", "parameters"=>[{"in"=>"path", "name"=>"environment_id", "description"=>"The environment ID"}, {"in"=>"path", "name"=>"id", "description"=>"The project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Environments", "Environment"]}}, "/v3/projects/{id}/repository/files"=>{"get"=>{"summary"=>"Get Projects Repository Files", "description"=>"Get projects repository files.", "operationId"=>"getV3ProjectsIdRepositoryFiles", "x-api-path-slug"=>"v3projectsidrepositoryfiles-get", "parameters"=>[{"in"=>"query", "name"=>"file_path", "description"=>"The path to the file"}, {"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"query", "name"=>"ref", "description"=>"The name of branch, tag, or commit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Files"]}, "post"=>{"summary"=>"Post Projects Repository Files", "description"=>"Post projects repository files.", "operationId"=>"postV3ProjectsIdRepositoryFiles", "x-api-path-slug"=>"v3projectsidrepositoryfiles-post", "parameters"=>[{"in"=>"formData", "name"=>"author_email", "description"=>"The email of the author"}, {"in"=>"formData", "name"=>"author_name", "description"=>"The name of the author"}, {"in"=>"formData", "name"=>"branch_name", "description"=>"The name of branch"}, {"in"=>"formData", "name"=>"commit_message", "description"=>"Commit Message"}, {"in"=>"formData", "name"=>"content", "description"=>"File content"}, {"in"=>"formData", "name"=>"encoding", "description"=>"File encoding"}, {"in"=>"formData", "name"=>"file_path", "description"=>"The path to new file"}, {"in"=>"path", "name"=>"id", "description"=>"The project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Files"]}, "put"=>{"summary"=>"Put Projects Repository Files", "description"=>"Update existing file in repository", "operationId"=>"putV3ProjectsIdRepositoryFiles", "x-api-path-slug"=>"v3projectsidrepositoryfiles-put", "parameters"=>[{"in"=>"formData", "name"=>"author_email", "description"=>"The email of the author"}, {"in"=>"formData", "name"=>"author_name", "description"=>"The name of the author"}, {"in"=>"formData", "name"=>"branch_name", "description"=>"The name of branch"}, {"in"=>"formData", "name"=>"commit_message", "description"=>"Commit Message"}, {"in"=>"formData", "name"=>"content", "description"=>"File content"}, {"in"=>"formData", "name"=>"encoding", "description"=>"File encoding"}, {"in"=>"formData", "name"=>"file_path", "description"=>"The path to new file"}, {"in"=>"path", "name"=>"id", "description"=>"The project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Files"]}, "delete"=>{"summary"=>"Delete Projects Repository Files", "description"=>"Delete an existing file in repository", "operationId"=>"deleteV3ProjectsIdRepositoryFiles", "x-api-path-slug"=>"v3projectsidrepositoryfiles-delete", "parameters"=>[{"in"=>"query", "name"=>"author_email", "description"=>"The email of the author"}, {"in"=>"query", "name"=>"author_name", "description"=>"The name of the author"}, {"in"=>"query", "name"=>"branch_name", "description"=>"The name of branch"}, {"in"=>"query", "name"=>"commit_message", "description"=>"Commit Message"}, {"in"=>"query", "name"=>"file_path", "description"=>"The path to new file"}, {"in"=>"path", "name"=>"id", "description"=>"The project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Files"]}}, "/v3/projects/{id}/issues/{issue_id}/time_estimate"=>{"post"=>{"summary"=>"Post Projects Issues Issue Time Estimate", "description"=>"Post projects issues issue time estimate.", "operationId"=>"postV3ProjectsIdIssuesIssueIdTimeEstimate", "x-api-path-slug"=>"v3projectsidissuesissue-idtime-estimate-post", "parameters"=>[{"in"=>"formData", "name"=>"duration", "description"=>"The duration to be parsed"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"issue_id", "description"=>"The ID of a project issue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue", "Time", "Estimate"]}}, "/v3/projects/{id}/issues/{issue_id}/reset_time_estimate"=>{"post"=>{"summary"=>"Post Projects Issues Issue Reset Time Estimate", "description"=>"Post projects issues issue reset time estimate.", "operationId"=>"postV3ProjectsIdIssuesIssueIdResetTimeEstimate", "x-api-path-slug"=>"v3projectsidissuesissue-idreset-time-estimate-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"issue_id", "description"=>"The ID of a project issue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue", "Reset", "Time", "Estimate"]}}, "/v3/projects/{id}/issues/{issue_id}/add_spent_time"=>{"post"=>{"summary"=>"Post Projects Issues Issue Add Spent Time", "description"=>"Post projects issues issue add spent time.", "operationId"=>"postV3ProjectsIdIssuesIssueIdAddSpentTime", "x-api-path-slug"=>"v3projectsidissuesissue-idadd-spent-time-post", "parameters"=>[{"in"=>"formData", "name"=>"duration", "description"=>"The duration to be parsed"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"issue_id", "description"=>"The ID of a project issue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue", "", "Spent", "Time"]}}, "/v3/projects/{id}/issues/{issue_id}/reset_spent_time"=>{"post"=>{"summary"=>"Post Projects Issues Issue Reset Spent Time", "description"=>"Post projects issues issue reset spent time.", "operationId"=>"postV3ProjectsIdIssuesIssueIdResetSpentTime", "x-api-path-slug"=>"v3projectsidissuesissue-idreset-spent-time-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"issue_id", "description"=>"The ID of a project issue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue", "Reset", "Spent", "Time"]}}, "/v3/projects/{id}/issues/{issue_id}/time_stats"=>{"get"=>{"summary"=>"Get Projects Issues Issue Time Stats", "description"=>"Get projects issues issue time stats.", "operationId"=>"getV3ProjectsIdIssuesIssueIdTimeStats", "x-api-path-slug"=>"v3projectsidissuesissue-idtime-stats-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"issue_id", "description"=>"The ID of a project issue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue", "Time", "Stats"]}}, "/v3/projects/{id}/issues"=>{"get"=>{"summary"=>"Get Projects Issues", "description"=>"Get a list of project issues", "operationId"=>"getV3ProjectsIdIssues", "x-api-path-slug"=>"v3projectsidissues-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"iid", "description"=>"Return the issue having the given `iid`"}, {"in"=>"query", "name"=>"labels", "description"=>"Comma-separated list of label names"}, {"in"=>"query", "name"=>"milestone", "description"=>"Return issues for a specific milestone"}, {"in"=>"query", "name"=>"order_by", "description"=>"Return issues ordered by `created_at` or `updated_at` fields"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"sort", "description"=>"Return issues sorted in `asc` or `desc` order"}, {"in"=>"query", "name"=>"state", "description"=>"Return opened, closed, or all issues"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues"]}, "post"=>{"summary"=>"Post Projects Issues", "description"=>"Create a new project issue", "operationId"=>"postV3ProjectsIdIssues", "x-api-path-slug"=>"v3projectsidissues-post", "parameters"=>[{"in"=>"formData", "name"=>"assignee_id", "description"=>"The ID of a user to assign issue"}, {"in"=>"formData", "name"=>"confidential", "description"=>"Boolean parameter if the issue should be confidential"}, {"in"=>"formData", "name"=>"created_at", "description"=>"Date time when the issue was created"}, {"in"=>"formData", "name"=>"description", "description"=>"The description of an issue"}, {"in"=>"formData", "name"=>"due_date", "description"=>"Date time string in the format YEAR-MONTH-DAY"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"labels", "description"=>"Comma-separated list of label names"}, {"in"=>"formData", "name"=>"merge_request_for_resolving_discussions", "description"=>"The IID of a merge request for which to resolve discussions"}, {"in"=>"formData", "name"=>"milestone_id", "description"=>"The ID of a milestone to assign issue"}, {"in"=>"formData", "name"=>"title", "description"=>"The title of an issue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues"]}}, "/v3/projects/{id}/issues/{issue_id}"=>{"get"=>{"summary"=>"Get Projects Issues Issue", "description"=>"Get a single project issue", "operationId"=>"getV3ProjectsIdIssuesIssueId", "x-api-path-slug"=>"v3projectsidissuesissue-id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"issue_id", "description"=>"The ID of a project issue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue"]}, "put"=>{"summary"=>"Put Projects Issues Issue", "description"=>"Put projects issues issue.", "operationId"=>"putV3ProjectsIdIssuesIssueId", "x-api-path-slug"=>"v3projectsidissuesissue-id-put", "parameters"=>[{"in"=>"formData", "name"=>"assignee_id", "description"=>"The ID of a user to assign issue"}, {"in"=>"formData", "name"=>"confidential", "description"=>"Boolean parameter if the issue should be confidential"}, {"in"=>"formData", "name"=>"created_at"}, {"in"=>"formData", "name"=>"description", "description"=>"The description of an issue"}, {"in"=>"formData", "name"=>"due_date", "description"=>"Date time string in the format YEAR-MONTH-DAY"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"issue_id", "description"=>"The ID of a project issue"}, {"in"=>"formData", "name"=>"labels", "description"=>"Comma-separated list of label names"}, {"in"=>"formData", "name"=>"milestone_id", "description"=>"The ID of a milestone to assign issue"}, {"in"=>"formData", "name"=>"state_event", "description"=>"State of the issue"}, {"in"=>"formData", "name"=>"title", "description"=>"The title of an issue"}, {"in"=>"formData", "name"=>"updated_at", "description"=>"Date time when the issue was updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue"]}, "delete"=>{"summary"=>"Delete Projects Issues Issue", "description"=>"Delete projects issues issue.", "operationId"=>"deleteV3ProjectsIdIssuesIssueId", "x-api-path-slug"=>"v3projectsidissuesissue-id-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"issue_id", "description"=>"The ID of a project issue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue"]}}, "/v3/projects/{id}/issues/{issue_id}/move"=>{"post"=>{"summary"=>"Post Projects Issues Issue Move", "description"=>"Post projects issues issue move.", "operationId"=>"postV3ProjectsIdIssuesIssueIdMove", "x-api-path-slug"=>"v3projectsidissuesissue-idmove-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"issue_id", "description"=>"The ID of a project issue"}, {"in"=>"formData", "name"=>"to_project_id", "description"=>"The ID of the new project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue", "Move"]}}, "/v3/projects/{id}/labels"=>{"get"=>{"summary"=>"Get Projects Labels", "description"=>"Get all labels of the project", "operationId"=>"getV3ProjectsIdLabels", "x-api-path-slug"=>"v3projectsidlabels-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Labels"]}, "post"=>{"summary"=>"Post Projects Labels", "description"=>"Post projects labels.", "operationId"=>"postV3ProjectsIdLabels", "x-api-path-slug"=>"v3projectsidlabels-post", "parameters"=>[{"in"=>"formData", "name"=>"color", "description"=>"The color of the label given in 6-digit hex notation with leading # sign (e"}, {"in"=>"formData", "name"=>"description", "description"=>"The description of label to be created"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the label to be created"}, {"in"=>"formData", "name"=>"priority", "description"=>"The priority of the label"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Labels"]}, "delete"=>{"summary"=>"Delete Projects Labels", "description"=>"Delete an existing label", "operationId"=>"deleteV3ProjectsIdLabels", "x-api-path-slug"=>"v3projectsidlabels-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the label to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Labels"]}, "put"=>{"summary"=>"Put Projects Labels", "description"=>"Update an existing label. At least one optional parameter is required.", "operationId"=>"putV3ProjectsIdLabels", "x-api-path-slug"=>"v3projectsidlabels-put", "parameters"=>[{"in"=>"formData", "name"=>"color", "description"=>"The new color of the label given in 6-digit hex notation with leading # sign (e"}, {"in"=>"formData", "name"=>"description", "description"=>"The new description of label"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the label to be updated"}, {"in"=>"formData", "name"=>"new_name", "description"=>"The new name of the label"}, {"in"=>"formData", "name"=>"priority", "description"=>"The priority of the label"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Labels"]}}, "/v3/projects/{id}/members"=>{"get"=>{"summary"=>"Get Projects Members", "description"=>"Gets a list of group or project members viewable by the authenticated user.", "operationId"=>"getV3ProjectsIdMembers", "x-api-path-slug"=>"v3projectsidmembers-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"query", "description"=>"A query string to search for members"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Members"]}, "post"=>{"summary"=>"Post Projects Members", "description"=>"Adds a member to a group or project.", "operationId"=>"postV3ProjectsIdMembers", "x-api-path-slug"=>"v3projectsidmembers-post", "parameters"=>[{"in"=>"formData", "name"=>"access_level", "description"=>"A valid access level (defaults: `30`, developer access level)"}, {"in"=>"formData", "name"=>"expires_at", "description"=>"Date string in the format YEAR-MONTH-DAY"}, {"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"formData", "name"=>"user_id", "description"=>"The user ID of the new member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Members"]}}, "/v3/projects/{id}/members/{user_id}"=>{"get"=>{"summary"=>"Get Projects Members User", "description"=>"Gets a member of a group or project.", "operationId"=>"getV3ProjectsIdMembersUserId", "x-api-path-slug"=>"v3projectsidmembersuser-id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The user ID of the member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Members", "User"]}, "put"=>{"summary"=>"Put Projects Members User", "description"=>"Updates a member of a group or project.", "operationId"=>"putV3ProjectsIdMembersUserId", "x-api-path-slug"=>"v3projectsidmembersuser-id-put", "parameters"=>[{"in"=>"formData", "name"=>"access_level", "description"=>"A valid access level"}, {"in"=>"formData", "name"=>"expires_at", "description"=>"Date string in the format YEAR-MONTH-DAY"}, {"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The user ID of the new member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Members", "User"]}, "delete"=>{"summary"=>"Delete Projects Members User", "description"=>"Removes a user from a group or project.", "operationId"=>"deleteV3ProjectsIdMembersUserId", "x-api-path-slug"=>"v3projectsidmembersuser-id-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The user ID of the member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Members", "User"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/versions"=>{"get"=>{"summary"=>"Get Projects Merge Requests Merge Request Versions", "description"=>"Get projects merge requests merge request versions.", "operationId"=>"getV3ProjectsIdMergeRequestsMergeRequestIdVersions", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idversions-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id", "description"=>"The ID of a merge request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Versions"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/versions/{version_id}"=>{"get"=>{"summary"=>"Get Projects Merge Requests Merge Request Versions Version", "description"=>"Get projects merge requests merge request versions version.", "operationId"=>"getV3ProjectsIdMergeRequestsMergeRequestIdVersionsVersionId", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idversionsversion-id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id", "description"=>"The ID of a merge request"}, {"in"=>"path", "name"=>"version_id", "description"=>"The ID of a merge request diff version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Versions", "Version"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/time_estimate"=>{"post"=>{"summary"=>"Post Projects Merge Requests Merge Request Time Estimate", "description"=>"Post projects merge requests merge request time estimate.", "operationId"=>"postV3ProjectsIdMergeRequestsMergeRequestIdTimeEstimate", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idtime-estimate-post", "parameters"=>[{"in"=>"formData", "name"=>"duration", "description"=>"The duration to be parsed"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id", "description"=>"The ID of a project merge_request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Time", "Estimate"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/reset_time_estimate"=>{"post"=>{"summary"=>"Post Projects Merge Requests Merge Request Reset Time Estimate", "description"=>"Post projects merge requests merge request reset time estimate.", "operationId"=>"postV3ProjectsIdMergeRequestsMergeRequestIdResetTimeEstimate", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idreset-time-estimate-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id", "description"=>"The ID of a project merge_request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Reset", "Time", "Estimate"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/add_spent_time"=>{"post"=>{"summary"=>"Post Projects Merge Requests Merge Request Add Spent Time", "description"=>"Post projects merge requests merge request add spent time.", "operationId"=>"postV3ProjectsIdMergeRequestsMergeRequestIdAddSpentTime", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idadd-spent-time-post", "parameters"=>[{"in"=>"formData", "name"=>"duration", "description"=>"The duration to be parsed"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id", "description"=>"The ID of a project merge_request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "", "Spent", "Time"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/reset_spent_time"=>{"post"=>{"summary"=>"Post Projects Merge Requests Merge Request Reset Spent Time", "description"=>"Post projects merge requests merge request reset spent time.", "operationId"=>"postV3ProjectsIdMergeRequestsMergeRequestIdResetSpentTime", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idreset-spent-time-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id", "description"=>"The ID of a project merge_request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Reset", "Spent", "Time"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/time_stats"=>{"get"=>{"summary"=>"Get Projects Merge Requests Merge Request Time Stats", "description"=>"Get projects merge requests merge request time stats.", "operationId"=>"getV3ProjectsIdMergeRequestsMergeRequestIdTimeStats", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idtime-stats-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id", "description"=>"The ID of a project merge_request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Time", "Stats"]}}, "/v3/projects/{id}/merge_requests"=>{"get"=>{"summary"=>"Get Projects Merge Requests", "description"=>"Get projects merge requests.", "operationId"=>"getV3ProjectsIdMergeRequests", "x-api-path-slug"=>"v3projectsidmerge-requests-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"iid", "description"=>"The IID of the merge requests"}, {"in"=>"query", "name"=>"order_by", "description"=>"Return merge requests ordered by `created_at` or `updated_at` fields"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"sort", "description"=>"Return merge requests sorted in `asc` or `desc` order"}, {"in"=>"query", "name"=>"state", "description"=>"Return opened, closed, merged, or all merge requests"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests"]}, "post"=>{"summary"=>"Post Projects Merge Requests", "description"=>"Post projects merge requests.", "operationId"=>"postV3ProjectsIdMergeRequests", "x-api-path-slug"=>"v3projectsidmerge-requests-post", "parameters"=>[{"in"=>"formData", "name"=>"assignee_id", "description"=>"The ID of a user to assign the merge request"}, {"in"=>"formData", "name"=>"description", "description"=>"The description of the merge request"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"labels", "description"=>"Comma-separated list of label names"}, {"in"=>"formData", "name"=>"milestone_id", "description"=>"The ID of a milestone to assign the merge request"}, {"in"=>"formData", "name"=>"remove_source_branch", "description"=>"Remove source branch when merging"}, {"in"=>"formData", "name"=>"source_branch", "description"=>"The source branch"}, {"in"=>"formData", "name"=>"target_branch", "description"=>"The target branch"}, {"in"=>"formData", "name"=>"target_project_id", "description"=>"The target project of the merge request defaults to the :id of the project"}, {"in"=>"formData", "name"=>"title", "description"=>"The title of the merge request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}"=>{"delete"=>{"summary"=>"Delete Projects Merge Requests Merge Request", "description"=>"Delete projects merge requests merge request.", "operationId"=>"deleteV3ProjectsIdMergeRequestsMergeRequestId", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-id-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id", "description"=>"The ID of a merge request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request"]}, "get"=>{"summary"=>"Get Projects Merge Requests Merge Request", "description"=>"Get projects merge requests merge request.", "operationId"=>"getV3ProjectsIdMergeRequestsMergeRequestId", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request"]}, "put"=>{"summary"=>"Put Projects Merge Requests Merge Request", "description"=>"Put projects merge requests merge request.", "operationId"=>"putV3ProjectsIdMergeRequestsMergeRequestId", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-id-put", "parameters"=>[{"in"=>"formData", "name"=>"assignee_id", "description"=>"The ID of a user to assign the merge request"}, {"in"=>"formData", "name"=>"description", "description"=>"The description of the merge request"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"labels", "description"=>"Comma-separated list of label names"}, {"in"=>"path", "name"=>"merge_request_id"}, {"in"=>"formData", "name"=>"milestone_id", "description"=>"The ID of a milestone to assign the merge request"}, {"in"=>"formData", "name"=>"remove_source_branch", "description"=>"Remove source branch when merging"}, {"in"=>"formData", "name"=>"state_event", "description"=>"Status of the merge request"}, {"in"=>"formData", "name"=>"target_branch", "description"=>"The target branch"}, {"in"=>"formData", "name"=>"title", "description"=>"The title of the merge request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request"]}}, "/v3/projects/{id}/merge_request/{merge_request_id}"=>{"get"=>{"summary"=>"Get Projects Merge Request Merge Request", "description"=>"This endpoint is deprecated and will be removed in GitLab 9.0.", "operationId"=>"getV3ProjectsIdMergeRequestMergeRequestId", "x-api-path-slug"=>"v3projectsidmerge-requestmerge-request-id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id", "description"=>"The ID of a merge request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Request", "Merge", "Request"]}, "put"=>{"summary"=>"Put Projects Merge Request Merge Request", "description"=>"Put projects merge request merge request.", "operationId"=>"putV3ProjectsIdMergeRequestMergeRequestId", "x-api-path-slug"=>"v3projectsidmerge-requestmerge-request-id-put", "parameters"=>[{"in"=>"formData", "name"=>"assignee_id", "description"=>"The ID of a user to assign the merge request"}, {"in"=>"formData", "name"=>"description", "description"=>"The description of the merge request"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"labels", "description"=>"Comma-separated list of label names"}, {"in"=>"path", "name"=>"merge_request_id"}, {"in"=>"formData", "name"=>"milestone_id", "description"=>"The ID of a milestone to assign the merge request"}, {"in"=>"formData", "name"=>"remove_source_branch", "description"=>"Remove source branch when merging"}, {"in"=>"formData", "name"=>"state_event", "description"=>"Status of the merge request"}, {"in"=>"formData", "name"=>"target_branch", "description"=>"The target branch"}, {"in"=>"formData", "name"=>"title", "description"=>"The title of the merge request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Request", "Merge", "Request"]}}, "/v3/projects/{id}/merge_request/{merge_request_id}/commits"=>{"get"=>{"summary"=>"Get Projects Merge Request Merge Request Commits", "description"=>"Get projects merge request merge request commits.", "operationId"=>"getV3ProjectsIdMergeRequestMergeRequestIdCommits", "x-api-path-slug"=>"v3projectsidmerge-requestmerge-request-idcommits-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Request", "Merge", "Request", "Commits"]}}, "/v3/projects/{id}/merge_request/{merge_request_id}/changes"=>{"get"=>{"summary"=>"Get Projects Merge Request Merge Request Changes", "description"=>"Get projects merge request merge request changes.", "operationId"=>"getV3ProjectsIdMergeRequestMergeRequestIdChanges", "x-api-path-slug"=>"v3projectsidmerge-requestmerge-request-idchanges-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Request", "Merge", "Request", "Changes"]}}, "/v3/projects/{id}/merge_request/{merge_request_id}/merge"=>{"put"=>{"summary"=>"Put Projects Merge Request Merge Request Merge", "description"=>"Put projects merge request merge request merge.", "operationId"=>"putV3ProjectsIdMergeRequestMergeRequestIdMerge", "x-api-path-slug"=>"v3projectsidmerge-requestmerge-request-idmerge-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"merge_commit_message", "description"=>"Custom merge commit message"}, {"in"=>"path", "name"=>"merge_request_id"}, {"in"=>"formData", "name"=>"merge_when_build_succeeds", "description"=>"When true, this merge request will be merged when the pipeline succeeds"}, {"in"=>"formData", "name"=>"sha", "description"=>"When present, must have the HEAD SHA of the source branch"}, {"in"=>"formData", "name"=>"should_remove_source_branch", "description"=>"When true, the source branch will be deleted if possible"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Request", "Merge", "Request", "Merge"]}}, "/v3/projects/{id}/merge_request/{merge_request_id}/cancel_merge_when_build_succeeds"=>{"post"=>{"summary"=>"Post Projects Merge Request Merge Request Cancel Merge When Build Succeeds", "description"=>"Post projects merge request merge request cancel merge when build succeeds.", "operationId"=>"postV3ProjectsIdMergeRequestMergeRequestIdCancelMergeWhenBuildSucceeds", "x-api-path-slug"=>"v3projectsidmerge-requestmerge-request-idcancel-merge-when-build-succeeds-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Request", "Merge", "Request", "Cancel", "Merge", "When", "Build", "Succeeds"]}}, "/v3/projects/{id}/merge_request/{merge_request_id}/comments"=>{"get"=>{"summary"=>"Get Projects Merge Request Merge Request Comments", "description"=>"Get projects merge request merge request comments.", "operationId"=>"getV3ProjectsIdMergeRequestMergeRequestIdComments", "x-api-path-slug"=>"v3projectsidmerge-requestmerge-request-idcomments-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Request", "Merge", "Request", "Comments"]}, "post"=>{"summary"=>"Post Projects Merge Request Merge Request Comments", "description"=>"Post projects merge request merge request comments.", "operationId"=>"postV3ProjectsIdMergeRequestMergeRequestIdComments", "x-api-path-slug"=>"v3projectsidmerge-requestmerge-request-idcomments-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id"}, {"in"=>"formData", "name"=>"note", "description"=>"The text of the comment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Request", "Merge", "Request", "Comments"]}}, "/v3/projects/{id}/merge_request/{merge_request_id}/closes_issues"=>{"get"=>{"summary"=>"Get Projects Merge Request Merge Request Closes Issues", "description"=>"Get projects merge request merge request closes issues.", "operationId"=>"getV3ProjectsIdMergeRequestMergeRequestIdClosesIssues", "x-api-path-slug"=>"v3projectsidmerge-requestmerge-request-idcloses-issues-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Request", "Merge", "Request", "Closes", "Issues"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/commits"=>{"get"=>{"summary"=>"Get Projects Merge Requests Merge Request Commits", "description"=>"Get projects merge requests merge request commits.", "operationId"=>"getV3ProjectsIdMergeRequestsMergeRequestIdCommits", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idcommits-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Commits"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/changes"=>{"get"=>{"summary"=>"Get Projects Merge Requests Merge Request Changes", "description"=>"Get projects merge requests merge request changes.", "operationId"=>"getV3ProjectsIdMergeRequestsMergeRequestIdChanges", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idchanges-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Changes"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/merge"=>{"put"=>{"summary"=>"Put Projects Merge Requests Merge Request Merge", "description"=>"Put projects merge requests merge request merge.", "operationId"=>"putV3ProjectsIdMergeRequestsMergeRequestIdMerge", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idmerge-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"merge_commit_message", "description"=>"Custom merge commit message"}, {"in"=>"path", "name"=>"merge_request_id"}, {"in"=>"formData", "name"=>"merge_when_build_succeeds", "description"=>"When true, this merge request will be merged when the pipeline succeeds"}, {"in"=>"formData", "name"=>"sha", "description"=>"When present, must have the HEAD SHA of the source branch"}, {"in"=>"formData", "name"=>"should_remove_source_branch", "description"=>"When true, the source branch will be deleted if possible"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Merge"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/cancel_merge_when_build_succeeds"=>{"post"=>{"summary"=>"Post Projects Merge Requests Merge Request Cancel Merge When Build Succeeds", "description"=>"Post projects merge requests merge request cancel merge when build succeeds.", "operationId"=>"postV3ProjectsIdMergeRequestsMergeRequestIdCancelMergeWhenBuildSucceeds", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idcancel-merge-when-build-succeeds-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Cancel", "Merge", "When", "Build", "Succeeds"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/comments"=>{"get"=>{"summary"=>"Get Projects Merge Requests Merge Request Comments", "description"=>"Get projects merge requests merge request comments.", "operationId"=>"getV3ProjectsIdMergeRequestsMergeRequestIdComments", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idcomments-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Comments"]}, "post"=>{"summary"=>"Post Projects Merge Requests Merge Request Comments", "description"=>"Post projects merge requests merge request comments.", "operationId"=>"postV3ProjectsIdMergeRequestsMergeRequestIdComments", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idcomments-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id"}, {"in"=>"formData", "name"=>"note", "description"=>"The text of the comment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Comments"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/closes_issues"=>{"get"=>{"summary"=>"Get Projects Merge Requests Merge Request Closes Issues", "description"=>"Get projects merge requests merge request closes issues.", "operationId"=>"getV3ProjectsIdMergeRequestsMergeRequestIdClosesIssues", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idcloses-issues-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Closes", "Issues"]}}, "/v3/projects/{id}/milestones"=>{"get"=>{"summary"=>"Get Projects Milestones", "description"=>"Get a list of project milestones", "operationId"=>"getV3ProjectsIdMilestones", "x-api-path-slug"=>"v3projectsidmilestones-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"iid", "description"=>"The IID of the milestone"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"state", "description"=>"Return active, closed, or all milestones"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Milestones"]}, "post"=>{"summary"=>"Post Projects Milestones", "description"=>"Create a new project milestone", "operationId"=>"postV3ProjectsIdMilestones", "x-api-path-slug"=>"v3projectsidmilestones-post", "parameters"=>[{"in"=>"formData", "name"=>"description", "description"=>"The description of the milestone"}, {"in"=>"formData", "name"=>"due_date", "description"=>"The due date of the milestone"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"start_date", "description"=>"The start date of the milestone"}, {"in"=>"formData", "name"=>"title", "description"=>"The title of the milestone"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Milestones"]}}, "/v3/projects/{id}/milestones/{milestone_id}"=>{"get"=>{"summary"=>"Get Projects Milestones Milestone", "description"=>"Get projects milestones milestone.", "operationId"=>"getV3ProjectsIdMilestonesMilestoneId", "x-api-path-slug"=>"v3projectsidmilestonesmilestone-id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"milestone_id", "description"=>"The ID of a project milestone"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Milestones", "Milestone"]}, "put"=>{"summary"=>"Put Projects Milestones Milestone", "description"=>"Update an existing project milestone", "operationId"=>"putV3ProjectsIdMilestonesMilestoneId", "x-api-path-slug"=>"v3projectsidmilestonesmilestone-id-put", "parameters"=>[{"in"=>"formData", "name"=>"description", "description"=>"The description of the milestone"}, {"in"=>"formData", "name"=>"due_date", "description"=>"The due date of the milestone"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"milestone_id", "description"=>"The ID of a project milestone"}, {"in"=>"formData", "name"=>"start_date", "description"=>"The start date of the milestone"}, {"in"=>"formData", "name"=>"state_event", "description"=>"The state event of the milestone"}, {"in"=>"formData", "name"=>"title", "description"=>"The title of the milestone"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Milestones", "Milestone"]}}, "/v3/projects/{id}/milestones/{milestone_id}/issues"=>{"get"=>{"summary"=>"Get Projects Milestones Milestone Issues", "description"=>"Get all issues for a single project milestone", "operationId"=>"getV3ProjectsIdMilestonesMilestoneIdIssues", "x-api-path-slug"=>"v3projectsidmilestonesmilestone-idissues-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"milestone_id", "description"=>"The ID of a project milestone"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Milestones", "Milestone", "Issues"]}}, "/v3/projects/{id}/issues/{noteable_id}/notes"=>{"get"=>{"summary"=>"Get Projects Issues Noteable Notes", "description"=>"Get a list of project +noteable+ notes", "operationId"=>"getV3ProjectsIdIssuesNoteableIdNotes", "x-api-path-slug"=>"v3projectsidissuesnoteable-idnotes-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"noteable_id", "description"=>"The ID of the noteable"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Noteable", "Notes"]}, "post"=>{"summary"=>"Post Projects Issues Noteable Notes", "description"=>"Post projects issues noteable notes.", "operationId"=>"postV3ProjectsIdIssuesNoteableIdNotes", "x-api-path-slug"=>"v3projectsidissuesnoteable-idnotes-post", "parameters"=>[{"in"=>"formData", "name"=>"body", "description"=>"The content of a note"}, {"in"=>"formData", "name"=>"created_at", "description"=>"The creation date of the note"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"noteable_id", "description"=>"The ID of the noteable"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Noteable", "Notes"]}}, "/v3/projects/{id}/issues/{noteable_id}/notes/{note_id}"=>{"get"=>{"summary"=>"Get Projects Issues Noteable Notes Note", "description"=>"Get projects issues noteable notes note.", "operationId"=>"getV3ProjectsIdIssuesNoteableIdNotesNoteId", "x-api-path-slug"=>"v3projectsidissuesnoteable-idnotesnote-id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"noteable_id", "description"=>"The ID of the noteable"}, {"in"=>"path", "name"=>"note_id", "description"=>"The ID of a note"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Noteable", "Notes", "Note"]}, "put"=>{"summary"=>"Put Projects Issues Noteable Notes Note", "description"=>"Put projects issues noteable notes note.", "operationId"=>"putV3ProjectsIdIssuesNoteableIdNotesNoteId", "x-api-path-slug"=>"v3projectsidissuesnoteable-idnotesnote-id-put", "parameters"=>[{"in"=>"formData", "name"=>"body", "description"=>"The content of a note"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"noteable_id", "description"=>"The ID of the noteable"}, {"in"=>"path", "name"=>"note_id", "description"=>"The ID of a note"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Noteable", "Notes", "Note"]}, "delete"=>{"summary"=>"Delete Projects Issues Noteable Notes Note", "description"=>"Delete projects issues noteable notes note.", "operationId"=>"deleteV3ProjectsIdIssuesNoteableIdNotesNoteId", "x-api-path-slug"=>"v3projectsidissuesnoteable-idnotesnote-id-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"noteable_id", "description"=>"The ID of the noteable"}, {"in"=>"path", "name"=>"note_id", "description"=>"The ID of a note"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Noteable", "Notes", "Note"]}}, "/v3/projects/{id}/merge_requests/{noteable_id}/notes"=>{"get"=>{"summary"=>"Get Projects Merge Requests Noteable Notes", "description"=>"Get projects merge requests noteable notes.", "operationId"=>"getV3ProjectsIdMergeRequestsNoteableIdNotes", "x-api-path-slug"=>"v3projectsidmerge-requestsnoteable-idnotes-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"noteable_id", "description"=>"The ID of the noteable"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Noteable", "Notes"]}, "post"=>{"summary"=>"Post Projects Merge Requests Noteable Notes", "description"=>"Post projects merge requests noteable notes.", "operationId"=>"postV3ProjectsIdMergeRequestsNoteableIdNotes", "x-api-path-slug"=>"v3projectsidmerge-requestsnoteable-idnotes-post", "parameters"=>[{"in"=>"formData", "name"=>"body", "description"=>"The content of a note"}, {"in"=>"formData", "name"=>"created_at", "description"=>"The creation date of the note"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"noteable_id", "description"=>"The ID of the noteable"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Noteable", "Notes"]}}, "/v3/projects/{id}/merge_requests/{noteable_id}/notes/{note_id}"=>{"get"=>{"summary"=>"Get Projects Merge Requests Noteable Notes Note", "description"=>"Get projects merge requests noteable notes note.", "operationId"=>"getV3ProjectsIdMergeRequestsNoteableIdNotesNoteId", "x-api-path-slug"=>"v3projectsidmerge-requestsnoteable-idnotesnote-id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"noteable_id", "description"=>"The ID of the noteable"}, {"in"=>"path", "name"=>"note_id", "description"=>"The ID of a note"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Noteable", "Notes", "Note"]}, "put"=>{"summary"=>"Put Projects Merge Requests Noteable Notes Note", "description"=>"Put projects merge requests noteable notes note.", "operationId"=>"putV3ProjectsIdMergeRequestsNoteableIdNotesNoteId", "x-api-path-slug"=>"v3projectsidmerge-requestsnoteable-idnotesnote-id-put", "parameters"=>[{"in"=>"formData", "name"=>"body", "description"=>"The content of a note"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"noteable_id", "description"=>"The ID of the noteable"}, {"in"=>"path", "name"=>"note_id", "description"=>"The ID of a note"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Noteable", "Notes", "Note"]}, "delete"=>{"summary"=>"Delete Projects Merge Requests Noteable Notes Note", "description"=>"Delete projects merge requests noteable notes note.", "operationId"=>"deleteV3ProjectsIdMergeRequestsNoteableIdNotesNoteId", "x-api-path-slug"=>"v3projectsidmerge-requestsnoteable-idnotesnote-id-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"noteable_id", "description"=>"The ID of the noteable"}, {"in"=>"path", "name"=>"note_id", "description"=>"The ID of a note"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Noteable", "Notes", "Note"]}}, "/v3/projects/{id}/snippets/{noteable_id}/notes"=>{"get"=>{"summary"=>"Get Projects Snippets Noteable Notes", "description"=>"Get a list of project +noteable+ notes", "operationId"=>"getV3ProjectsIdSnippetsNoteableIdNotes", "x-api-path-slug"=>"v3projectsidsnippetsnoteable-idnotes-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"noteable_id", "description"=>"The ID of the noteable"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Noteable", "Notes"]}, "post"=>{"summary"=>"Post Projects Snippets Noteable Notes", "description"=>"Post projects snippets noteable notes.", "operationId"=>"postV3ProjectsIdSnippetsNoteableIdNotes", "x-api-path-slug"=>"v3projectsidsnippetsnoteable-idnotes-post", "parameters"=>[{"in"=>"formData", "name"=>"body", "description"=>"The content of a note"}, {"in"=>"formData", "name"=>"created_at", "description"=>"The creation date of the note"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"noteable_id", "description"=>"The ID of the noteable"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Noteable", "Notes"]}}, "/v3/projects/{id}/snippets/{noteable_id}/notes/{note_id}"=>{"get"=>{"summary"=>"Get Projects Snippets Noteable Notes Note", "description"=>"Get projects snippets noteable notes note.", "operationId"=>"getV3ProjectsIdSnippetsNoteableIdNotesNoteId", "x-api-path-slug"=>"v3projectsidsnippetsnoteable-idnotesnote-id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"noteable_id", "description"=>"The ID of the noteable"}, {"in"=>"path", "name"=>"note_id", "description"=>"The ID of a note"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Noteable", "Notes", "Note"]}, "put"=>{"summary"=>"Put Projects Snippets Noteable Notes Note", "description"=>"Put projects snippets noteable notes note.", "operationId"=>"putV3ProjectsIdSnippetsNoteableIdNotesNoteId", "x-api-path-slug"=>"v3projectsidsnippetsnoteable-idnotesnote-id-put", "parameters"=>[{"in"=>"formData", "name"=>"body", "description"=>"The content of a note"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"noteable_id", "description"=>"The ID of the noteable"}, {"in"=>"path", "name"=>"note_id", "description"=>"The ID of a note"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Noteable", "Notes", "Note"]}, "delete"=>{"summary"=>"Delete Projects Snippets Noteable Notes Note", "description"=>"Delete projects snippets noteable notes note.", "operationId"=>"deleteV3ProjectsIdSnippetsNoteableIdNotesNoteId", "x-api-path-slug"=>"v3projectsidsnippetsnoteable-idnotesnote-id-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"noteable_id", "description"=>"The ID of the noteable"}, {"in"=>"path", "name"=>"note_id", "description"=>"The ID of a note"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Noteable", "Notes", "Note"]}}, "/v3/projects/{id}/notification_settings"=>{"get"=>{"summary"=>"Get Projects Notification Settings", "description"=>"This feature was introduced in GitLab 8.12", "operationId"=>"getV3ProjectsIdNotificationSettings", "x-api-path-slug"=>"v3projectsidnotification-settings-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The group ID or project ID or project NAMESPACE/PROJECT_NAME"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Notification", "Settings"]}, "put"=>{"summary"=>"Put Projects Notification Settings", "description"=>"This feature was introduced in GitLab 8.12", "operationId"=>"putV3ProjectsIdNotificationSettings", "x-api-path-slug"=>"v3projectsidnotification-settings-put", "parameters"=>[{"in"=>"formData", "name"=>"close_issue", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"close_merge_request", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"failed_pipeline", "description"=>"Enable/disable this notification"}, {"in"=>"path", "name"=>"id", "description"=>"The group ID or project ID or project NAMESPACE/PROJECT_NAME"}, {"in"=>"formData", "name"=>"level", "description"=>"The project notification level"}, {"in"=>"formData", "name"=>"merge_merge_request", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"new_issue", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"new_merge_request", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"new_note", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"reassign_issue", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"reassign_merge_request", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"reopen_issue", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"reopen_merge_request", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"success_pipeline", "description"=>"Enable/disable this notification"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Notification", "Settings"]}}, "/v3/projects/{id}/pipelines"=>{"get"=>{"summary"=>"Get Projects Pipelines", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"getV3ProjectsIdPipelines", "x-api-path-slug"=>"v3projectsidpipelines-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"scope", "description"=>"Either running, branches, or tags"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Pipelines"]}}, "/v3/projects/{id}/pipeline"=>{"post"=>{"summary"=>"Post Projects Pipeline", "description"=>"This feature was introduced in GitLab 8.14", "operationId"=>"postV3ProjectsIdPipeline", "x-api-path-slug"=>"v3projectsidpipeline-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"formData", "name"=>"ref", "description"=>"Reference"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Pipeline"]}}, "/v3/projects/{id}/pipelines/{pipeline_id}"=>{"get"=>{"summary"=>"Get Projects Pipelines Pipeline", "description"=>"This feature was introduced in GitLab 8.11", "operationId"=>"getV3ProjectsIdPipelinesPipelineId", "x-api-path-slug"=>"v3projectsidpipelinespipeline-id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"path", "name"=>"pipeline_id", "description"=>"The pipeline ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Pipelines", "Pipeline"]}}, "/v3/projects/{id}/pipelines/{pipeline_id}/retry"=>{"post"=>{"summary"=>"Post Projects Pipelines Pipeline Retry", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"postV3ProjectsIdPipelinesPipelineIdRetry", "x-api-path-slug"=>"v3projectsidpipelinespipeline-idretry-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"path", "name"=>"pipeline_id", "description"=>"The pipeline ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Pipelines", "Pipeline", "Retry"]}}, "/v3/projects/{id}/pipelines/{pipeline_id}/cancel"=>{"post"=>{"summary"=>"Post Projects Pipelines Pipeline Cancel", "description"=>"This feature was introduced in GitLab 8.11.", "operationId"=>"postV3ProjectsIdPipelinesPipelineIdCancel", "x-api-path-slug"=>"v3projectsidpipelinespipeline-idcancel-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The project ID"}, {"in"=>"path", "name"=>"pipeline_id", "description"=>"The pipeline ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Pipelines", "Pipeline", "Cancel"]}}, "/v3/projects/{id}/hooks"=>{"get"=>{"summary"=>"Get Projects Hooks", "description"=>"Get projects hooks.", "operationId"=>"getV3ProjectsIdHooks", "x-api-path-slug"=>"v3projectsidhooks-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Hooks"]}, "post"=>{"summary"=>"Post Projects Hooks", "description"=>"Post projects hooks.", "operationId"=>"postV3ProjectsIdHooks", "x-api-path-slug"=>"v3projectsidhooks-post", "parameters"=>[{"in"=>"formData", "name"=>"build_events", "description"=>"Trigger hook on build events"}, {"in"=>"formData", "name"=>"enable_ssl_verification", "description"=>"Do SSL verification when triggering the hook"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"issues_events", "description"=>"Trigger hook on issues events"}, {"in"=>"formData", "name"=>"merge_requests_events", "description"=>"Trigger hook on merge request events"}, {"in"=>"formData", "name"=>"note_events", "description"=>"Trigger hook on note(comment) events"}, {"in"=>"formData", "name"=>"pipeline_events", "description"=>"Trigger hook on pipeline events"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Trigger hook on push events"}, {"in"=>"formData", "name"=>"tag_push_events", "description"=>"Trigger hook on tag push events"}, {"in"=>"formData", "name"=>"token", "description"=>"Secret token to validate received payloads; this will not be returned in the response"}, {"in"=>"formData", "name"=>"url", "description"=>"The URL to send the request to"}, {"in"=>"formData", "name"=>"wiki_page_events", "description"=>"Trigger hook on wiki events"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Hooks"]}}, "/v3/projects/{id}/hooks/{hook_id}"=>{"get"=>{"summary"=>"Get Projects Hooks Hook", "description"=>"Get projects hooks hook.", "operationId"=>"getV3ProjectsIdHooksHookId", "x-api-path-slug"=>"v3projectsidhookshook-id-get", "parameters"=>[{"in"=>"path", "name"=>"hook_id", "description"=>"The ID of a project hook"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Hooks", "Hook"]}, "put"=>{"summary"=>"Put Projects Hooks Hook", "description"=>"Update an existing project hook", "operationId"=>"putV3ProjectsIdHooksHookId", "x-api-path-slug"=>"v3projectsidhookshook-id-put", "parameters"=>[{"in"=>"formData", "name"=>"build_events", "description"=>"Trigger hook on build events"}, {"in"=>"formData", "name"=>"enable_ssl_verification", "description"=>"Do SSL verification when triggering the hook"}, {"in"=>"path", "name"=>"hook_id", "description"=>"The ID of the hook to update"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"issues_events", "description"=>"Trigger hook on issues events"}, {"in"=>"formData", "name"=>"merge_requests_events", "description"=>"Trigger hook on merge request events"}, {"in"=>"formData", "name"=>"note_events", "description"=>"Trigger hook on note(comment) events"}, {"in"=>"formData", "name"=>"pipeline_events", "description"=>"Trigger hook on pipeline events"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Trigger hook on push events"}, {"in"=>"formData", "name"=>"tag_push_events", "description"=>"Trigger hook on tag push events"}, {"in"=>"formData", "name"=>"token", "description"=>"Secret token to validate received payloads; this will not be returned in the response"}, {"in"=>"formData", "name"=>"url", "description"=>"The URL to send the request to"}, {"in"=>"formData", "name"=>"wiki_page_events", "description"=>"Trigger hook on wiki events"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Hooks", "Hook"]}, "delete"=>{"summary"=>"Delete Projects Hooks Hook", "description"=>"Delete projects hooks hook.", "operationId"=>"deleteV3ProjectsIdHooksHookId", "x-api-path-slug"=>"v3projectsidhookshook-id-delete", "parameters"=>[{"in"=>"path", "name"=>"hook_id", "description"=>"The ID of the hook to delete"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Hooks", "Hook"]}}, "/v3/projects/visible"=>{"get"=>{"summary"=>"Get Projects Visible", "description"=>"Get a list of visible projects for authenticated user", "operationId"=>"getV3ProjectsVisible", "x-api-path-slug"=>"v3projectsvisible-get", "parameters"=>[{"in"=>"query", "name"=>"archived", "description"=>"Limit by archived status"}, {"in"=>"query", "name"=>"order_by", "description"=>"Return projects ordered by field"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"search", "description"=>"Return list of authorized projects matching the search criteria"}, {"in"=>"query", "name"=>"simple", "description"=>"Return only the ID, URL, name, and path of each project"}, {"in"=>"query", "name"=>"sort", "description"=>"Return projects sorted in ascending and descending order"}, {"in"=>"query", "name"=>"visibility", "description"=>"Limit by visibility"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Visible"]}}, "/v3/projects"=>{"get"=>{"summary"=>"Get Projects", "description"=>"Get a projects list for authenticated user", "operationId"=>"getV3Projects", "x-api-path-slug"=>"v3projects-get", "parameters"=>[{"in"=>"query", "name"=>"archived", "description"=>"Limit by archived status"}, {"in"=>"query", "name"=>"order_by", "description"=>"Return projects ordered by field"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"search", "description"=>"Return list of authorized projects matching the search criteria"}, {"in"=>"query", "name"=>"simple", "description"=>"Return only the ID, URL, name, and path of each project"}, {"in"=>"query", "name"=>"sort", "description"=>"Return projects sorted in ascending and descending order"}, {"in"=>"query", "name"=>"visibility", "description"=>"Limit by visibility"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}, "post"=>{"summary"=>"Post Projects", "description"=>"Create new project", "operationId"=>"postV3Projects", "x-api-path-slug"=>"v3projects-post", "parameters"=>[{"in"=>"formData", "name"=>"builds_enabled", "description"=>"Flag indication if builds are enabled"}, {"in"=>"formData", "name"=>"container_registry_enabled", "description"=>"Flag indication if the container registry is enabled for that project"}, {"in"=>"formData", "name"=>"description", "description"=>"The description of the project"}, {"in"=>"formData", "name"=>"import_url", "description"=>"URL from which the project is imported"}, {"in"=>"formData", "name"=>"issues_enabled", "description"=>"Flag indication if the issue tracker is enabled"}, {"in"=>"formData", "name"=>"lfs_enabled", "description"=>"Flag indication if Git LFS is enabled for that project"}, {"in"=>"formData", "name"=>"merge_requests_enabled", "description"=>"Flag indication if merge requests are enabled"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the project"}, {"in"=>"formData", "name"=>"namespace_id", "description"=>"Namespace ID for the new project"}, {"in"=>"formData", "name"=>"only_allow_merge_if_all_discussions_are_resolved", "description"=>"Only allow to merge if all discussions are resolved"}, {"in"=>"formData", "name"=>"only_allow_merge_if_build_succeeds", "description"=>"Only allow to merge if builds succeed"}, {"in"=>"formData", "name"=>"path", "description"=>"The path of the repository"}, {"in"=>"formData", "name"=>"public", "description"=>"Create a public project"}, {"in"=>"formData", "name"=>"public_builds", "description"=>"Perform public builds"}, {"in"=>"formData", "name"=>"request_access_enabled", "description"=>"Allow users to request member access"}, {"in"=>"formData", "name"=>"shared_runners_enabled", "description"=>"Flag indication if shared runners are enabled for that project"}, {"in"=>"formData", "name"=>"snippets_enabled", "description"=>"Flag indication if snippets are enabled"}, {"in"=>"formData", "name"=>"visibility_level", "description"=>"Create a public project"}, {"in"=>"formData", "name"=>"wiki_enabled", "description"=>"Flag indication if the wiki is enabled"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/v3/projects/owned"=>{"get"=>{"summary"=>"Get Projects Owned", "description"=>"Get an owned projects list for authenticated user", "operationId"=>"getV3ProjectsOwned", "x-api-path-slug"=>"v3projectsowned-get", "parameters"=>[{"in"=>"query", "name"=>"archived", "description"=>"Limit by archived status"}, {"in"=>"query", "name"=>"order_by", "description"=>"Return projects ordered by field"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"search", "description"=>"Return list of authorized projects matching the search criteria"}, {"in"=>"query", "name"=>"simple", "description"=>"Return only the ID, URL, name, and path of each project"}, {"in"=>"query", "name"=>"sort", "description"=>"Return projects sorted in ascending and descending order"}, {"in"=>"query", "name"=>"statistics", "description"=>"Include project statistics"}, {"in"=>"query", "name"=>"visibility", "description"=>"Limit by visibility"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Owned"]}}, "/v3/projects/starred"=>{"get"=>{"summary"=>"Get Projects Starred", "description"=>"Gets starred project for the authenticated user", "operationId"=>"getV3ProjectsStarred", "x-api-path-slug"=>"v3projectsstarred-get", "parameters"=>[{"in"=>"query", "name"=>"archived", "description"=>"Limit by archived status"}, {"in"=>"query", "name"=>"order_by", "description"=>"Return projects ordered by field"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"search", "description"=>"Return list of authorized projects matching the search criteria"}, {"in"=>"query", "name"=>"simple", "description"=>"Return only the ID, URL, name, and path of each project"}, {"in"=>"query", "name"=>"sort", "description"=>"Return projects sorted in ascending and descending order"}, {"in"=>"query", "name"=>"visibility", "description"=>"Limit by visibility"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Starred"]}}, "/v3/projects/all"=>{"get"=>{"summary"=>"Get Projects All", "description"=>"Get all projects for admin user", "operationId"=>"getV3ProjectsAll", "x-api-path-slug"=>"v3projectsall-get", "parameters"=>[{"in"=>"query", "name"=>"archived", "description"=>"Limit by archived status"}, {"in"=>"query", "name"=>"order_by", "description"=>"Return projects ordered by field"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"search", "description"=>"Return list of authorized projects matching the search criteria"}, {"in"=>"query", "name"=>"simple", "description"=>"Return only the ID, URL, name, and path of each project"}, {"in"=>"query", "name"=>"sort", "description"=>"Return projects sorted in ascending and descending order"}, {"in"=>"query", "name"=>"statistics", "description"=>"Include project statistics"}, {"in"=>"query", "name"=>"visibility", "description"=>"Limit by visibility"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/v3/projects/search/{query}"=>{"get"=>{"summary"=>"Get Projects Search Query", "description"=>"Search for projects the current user has access to", "operationId"=>"getV3ProjectsSearchQuery", "x-api-path-slug"=>"v3projectssearchquery-get", "parameters"=>[{"in"=>"query", "name"=>"order_by", "description"=>"Return projects ordered by field"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"path", "name"=>"query", "description"=>"The project name to be searched"}, {"in"=>"query", "name"=>"sort", "description"=>"Return projects sorted in ascending and descending order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Search", "Query"]}}, "/v3/projects/user/{user_id}"=>{"post"=>{"summary"=>"Post Projects User User", "description"=>"Create new project for a specified user. Only available to admin users.", "operationId"=>"postV3ProjectsUserUserId", "x-api-path-slug"=>"v3projectsuseruser-id-post", "parameters"=>[{"in"=>"formData", "name"=>"builds_enabled", "description"=>"Flag indication if builds are enabled"}, {"in"=>"formData", "name"=>"container_registry_enabled", "description"=>"Flag indication if the container registry is enabled for that project"}, {"in"=>"formData", "name"=>"default_branch", "description"=>"The default branch of the project"}, {"in"=>"formData", "name"=>"description", "description"=>"The description of the project"}, {"in"=>"formData", "name"=>"import_url", "description"=>"URL from which the project is imported"}, {"in"=>"formData", "name"=>"issues_enabled", "description"=>"Flag indication if the issue tracker is enabled"}, {"in"=>"formData", "name"=>"lfs_enabled", "description"=>"Flag indication if Git LFS is enabled for that project"}, {"in"=>"formData", "name"=>"merge_requests_enabled", "description"=>"Flag indication if merge requests are enabled"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the project"}, {"in"=>"formData", "name"=>"namespace_id", "description"=>"Namespace ID for the new project"}, {"in"=>"formData", "name"=>"only_allow_merge_if_all_discussions_are_resolved", "description"=>"Only allow to merge if all discussions are resolved"}, {"in"=>"formData", "name"=>"only_allow_merge_if_build_succeeds", "description"=>"Only allow to merge if builds succeed"}, {"in"=>"formData", "name"=>"public", "description"=>"Create a public project"}, {"in"=>"formData", "name"=>"public_builds", "description"=>"Perform public builds"}, {"in"=>"formData", "name"=>"request_access_enabled", "description"=>"Allow users to request member access"}, {"in"=>"formData", "name"=>"shared_runners_enabled", "description"=>"Flag indication if shared runners are enabled for that project"}, {"in"=>"formData", "name"=>"snippets_enabled", "description"=>"Flag indication if snippets are enabled"}, {"in"=>"path", "name"=>"user_id", "description"=>"The ID of a user"}, {"in"=>"formData", "name"=>"visibility_level", "description"=>"Create a public project"}, {"in"=>"formData", "name"=>"wiki_enabled", "description"=>"Flag indication if the wiki is enabled"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "User", "User"]}}, "/v3/projects/{id}"=>{"get"=>{"summary"=>"Get Projects", "description"=>"Get a single project", "operationId"=>"getV3ProjectsId", "x-api-path-slug"=>"v3projectsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}, "put"=>{"summary"=>"Put Projects", "description"=>"Update an existing project", "operationId"=>"putV3ProjectsId", "x-api-path-slug"=>"v3projectsid-put", "parameters"=>[{"in"=>"formData", "name"=>"builds_enabled", "description"=>"Flag indication if builds are enabled"}, {"in"=>"formData", "name"=>"container_registry_enabled", "description"=>"Flag indication if the container registry is enabled for that project"}, {"in"=>"formData", "name"=>"default_branch", "description"=>"The default branch of the project"}, {"in"=>"formData", "name"=>"description", "description"=>"The description of the project"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"issues_enabled", "description"=>"Flag indication if the issue tracker is enabled"}, {"in"=>"formData", "name"=>"lfs_enabled", "description"=>"Flag indication if Git LFS is enabled for that project"}, {"in"=>"formData", "name"=>"merge_requests_enabled", "description"=>"Flag indication if merge requests are enabled"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the project"}, {"in"=>"formData", "name"=>"only_allow_merge_if_all_discussions_are_resolved", "description"=>"Only allow to merge if all discussions are resolved"}, {"in"=>"formData", "name"=>"only_allow_merge_if_build_succeeds", "description"=>"Only allow to merge if builds succeed"}, {"in"=>"formData", "name"=>"path", "description"=>"The path of the repository"}, {"in"=>"formData", "name"=>"public", "description"=>"Create a public project"}, {"in"=>"formData", "name"=>"public_builds", "description"=>"Perform public builds"}, {"in"=>"formData", "name"=>"request_access_enabled", "description"=>"Allow users to request member access"}, {"in"=>"formData", "name"=>"shared_runners_enabled", "description"=>"Flag indication if shared runners are enabled for that project"}, {"in"=>"formData", "name"=>"snippets_enabled", "description"=>"Flag indication if snippets are enabled"}, {"in"=>"formData", "name"=>"visibility_level", "description"=>"Create a public project"}, {"in"=>"formData", "name"=>"wiki_enabled", "description"=>"Flag indication if the wiki is enabled"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}, "delete"=>{"summary"=>"Delete Projects", "description"=>"Remove a project", "operationId"=>"deleteV3ProjectsId", "x-api-path-slug"=>"v3projectsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/v3/projects/{id}/events"=>{"get"=>{"summary"=>"Get Projects Events", "description"=>"Get events for a single project", "operationId"=>"getV3ProjectsIdEvents", "x-api-path-slug"=>"v3projectsidevents-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Events"]}}, "/v3/projects/fork/{id}"=>{"post"=>{"summary"=>"Post Projects Fork", "description"=>"Fork new project for the current user or provided namespace.", "operationId"=>"postV3ProjectsForkId", "x-api-path-slug"=>"v3projectsforkid-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"namespace", "description"=>"The ID or name of the namespace that the project will be forked into"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Fork"]}}, "/v3/projects/{id}/archive"=>{"post"=>{"summary"=>"Post Projects Archive", "description"=>"Post projects archive.", "operationId"=>"postV3ProjectsIdArchive", "x-api-path-slug"=>"v3projectsidarchive-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Archive"]}}, "/v3/projects/{id}/unarchive"=>{"post"=>{"summary"=>"Post Projects Unarchive", "description"=>"Post projects unarchive.", "operationId"=>"postV3ProjectsIdUnarchive", "x-api-path-slug"=>"v3projectsidunarchive-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Unarchive"]}}, "/v3/projects/{id}/star"=>{"post"=>{"summary"=>"Post Projects Star", "description"=>"Post projects star.", "operationId"=>"postV3ProjectsIdStar", "x-api-path-slug"=>"v3projectsidstar-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Star"]}, "delete"=>{"summary"=>"Delete Projects Star", "description"=>"Delete projects star.", "operationId"=>"deleteV3ProjectsIdStar", "x-api-path-slug"=>"v3projectsidstar-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Star"]}}, "/v3/projects/{id}/fork/{forked_from_id}"=>{"post"=>{"summary"=>"Post Projects Fork Forked From", "description"=>"Mark this project as forked from another", "operationId"=>"postV3ProjectsIdForkForkedFromId", "x-api-path-slug"=>"v3projectsidforkforked-from-id-post", "parameters"=>[{"in"=>"path", "name"=>"forked_from_id", "description"=>"The ID of the project it was forked from"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Fork", "Forked", "From"]}}, "/v3/projects/{id}/fork"=>{"delete"=>{"summary"=>"Delete Projects Fork", "description"=>"Remove a forked_from relationship", "operationId"=>"deleteV3ProjectsIdFork", "x-api-path-slug"=>"v3projectsidfork-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Fork"]}}, "/v3/projects/{id}/share"=>{"post"=>{"summary"=>"Post Projects Share", "description"=>"Share the project with a group", "operationId"=>"postV3ProjectsIdShare", "x-api-path-slug"=>"v3projectsidshare-post", "parameters"=>[{"in"=>"formData", "name"=>"expires_at", "description"=>"Share expiration date"}, {"in"=>"formData", "name"=>"group_access", "description"=>"The group access level"}, {"in"=>"formData", "name"=>"group_id", "description"=>"The ID of a group"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Share"]}}, "/v3/projects/{id}/share/{group_id}"=>{"delete"=>{"summary"=>"Delete Projects Share Group", "description"=>"Delete projects share group.", "operationId"=>"deleteV3ProjectsIdShareGroupId", "x-api-path-slug"=>"v3projectsidsharegroup-id-delete", "parameters"=>[{"in"=>"path", "name"=>"group_id", "description"=>"The ID of the group"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Share", "Group"]}}, "/v3/projects/{id}/uploads"=>{"post"=>{"summary"=>"Post Projects Uploads", "description"=>"Post projects uploads.", "operationId"=>"postV3ProjectsIdUploads", "x-api-path-slug"=>"v3projectsiduploads-post", "parameters"=>[{"in"=>"formData", "name"=>"file", "description"=>"The file to be uploaded"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Uploads"]}}, "/v3/projects/{id}/users"=>{"get"=>{"summary"=>"Get Projects Users", "description"=>"Get the users list of a project", "operationId"=>"getV3ProjectsIdUsers", "x-api-path-slug"=>"v3projectsidusers-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"search", "description"=>"Return list of users matching the search criteria"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Users"]}}, "/v3/projects/{id}/snippets"=>{"get"=>{"summary"=>"Get Projects Snippets", "description"=>"Get all project snippets", "operationId"=>"getV3ProjectsIdSnippets", "x-api-path-slug"=>"v3projectsidsnippets-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets"]}, "post"=>{"summary"=>"Post Projects Snippets", "description"=>"Create a new project snippet", "operationId"=>"postV3ProjectsIdSnippets", "x-api-path-slug"=>"v3projectsidsnippets-post", "parameters"=>[{"in"=>"formData", "name"=>"code", "description"=>"The content of the snippet"}, {"in"=>"formData", "name"=>"file_name", "description"=>"The file name of the snippet"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"title", "description"=>"The title of the snippet"}, {"in"=>"formData", "name"=>"visibility_level", "description"=>"The visibility level of the snippet"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets"]}}, "/v3/projects/{id}/snippets/{snippet_id}"=>{"get"=>{"summary"=>"Get Projects Snippets Snippet", "description"=>"Get projects snippets snippet.", "operationId"=>"getV3ProjectsIdSnippetsSnippetId", "x-api-path-slug"=>"v3projectsidsnippetssnippet-id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"snippet_id", "description"=>"The ID of a project snippet"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Snippet"]}, "put"=>{"summary"=>"Put Projects Snippets Snippet", "description"=>"Update an existing project snippet", "operationId"=>"putV3ProjectsIdSnippetsSnippetId", "x-api-path-slug"=>"v3projectsidsnippetssnippet-id-put", "parameters"=>[{"in"=>"formData", "name"=>"code", "description"=>"The content of the snippet"}, {"in"=>"formData", "name"=>"file_name", "description"=>"The file name of the snippet"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"snippet_id", "description"=>"The ID of a project snippet"}, {"in"=>"formData", "name"=>"title", "description"=>"The title of the snippet"}, {"in"=>"formData", "name"=>"visibility_level", "description"=>"The visibility level of the snippet"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Snippet"]}, "delete"=>{"summary"=>"Delete Projects Snippets Snippet", "description"=>"Delete projects snippets snippet.", "operationId"=>"deleteV3ProjectsIdSnippetsSnippetId", "x-api-path-slug"=>"v3projectsidsnippetssnippet-id-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"snippet_id", "description"=>"The ID of a project snippet"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Snippet"]}}, "/v3/projects/{id}/snippets/{snippet_id}/raw"=>{"get"=>{"summary"=>"Get Projects Snippets Snippet Raw", "description"=>"Get projects snippets snippet raw.", "operationId"=>"getV3ProjectsIdSnippetsSnippetIdRaw", "x-api-path-slug"=>"v3projectsidsnippetssnippet-idraw-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"snippet_id", "description"=>"The ID of a project snippet"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Snippets", "Snippet", "Raw"]}}, "/v3/projects/{id}/repository/tree"=>{"get"=>{"summary"=>"Get Projects Repository Tree", "description"=>"Get a project repository tree", "operationId"=>"getV3ProjectsIdRepositoryTree", "x-api-path-slug"=>"v3projectsidrepositorytree-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"path", "description"=>"The path of the tree"}, {"in"=>"query", "name"=>"recursive", "description"=>"Used to get a recursive tree"}, {"in"=>"query", "name"=>"ref_name", "description"=>"The name of a repository branch or tag, if not given the default branch is used"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Tree"]}}, "/v3/projects/{id}/repository/blobs/{sha}"=>{"get"=>{"summary"=>"Get Projects Repository Blobs Sha", "description"=>"Get projects repository blobs sha.", "operationId"=>"getV3ProjectsIdRepositoryBlobsSha", "x-api-path-slug"=>"v3projectsidrepositoryblobssha-get", "parameters"=>[{"in"=>"query", "name"=>"filepath", "description"=>"The path to the file to display"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"sha", "description"=>"The commit, branch name, or tag name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Blobs", "Sha"]}}, "/v3/projects/{id}/repository/commits/{sha}/blob"=>{"get"=>{"summary"=>"Get Projects Repository Commits Sha Blob", "description"=>"Get projects repository commits sha blob.", "operationId"=>"getV3ProjectsIdRepositoryCommitsShaBlob", "x-api-path-slug"=>"v3projectsidrepositorycommitsshablob-get", "parameters"=>[{"in"=>"query", "name"=>"filepath", "description"=>"The path to the file to display"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"sha", "description"=>"The commit, branch name, or tag name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Commits", "Sha", "Blob"]}}, "/v3/projects/{id}/repository/raw_blobs/{sha}"=>{"get"=>{"summary"=>"Get Projects Repository Raw Blobs Sha", "description"=>"Get projects repository raw blobs sha.", "operationId"=>"getV3ProjectsIdRepositoryRawBlobsSha", "x-api-path-slug"=>"v3projectsidrepositoryraw-blobssha-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"sha", "description"=>"The commit, branch name, or tag name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Raw", "Blobs", "Sha"]}}, "/v3/projects/{id}/repository/archive"=>{"get"=>{"summary"=>"Get Projects Repository Archive", "description"=>"Get an archive of the repository", "operationId"=>"getV3ProjectsIdRepositoryArchive", "x-api-path-slug"=>"v3projectsidrepositoryarchive-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The archive format"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"sha", "description"=>"The commit sha of the archive to be downloaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Archive"]}}, "/v3/projects/{id}/repository/compare"=>{"get"=>{"summary"=>"Get Projects Repository Compare", "description"=>"Compare two branches, tags, or commits", "operationId"=>"getV3ProjectsIdRepositoryCompare", "x-api-path-slug"=>"v3projectsidrepositorycompare-get", "parameters"=>[{"in"=>"query", "name"=>"from", "description"=>"The commit, branch name, or tag name to start comparison"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"to", "description"=>"The commit, branch name, or tag name to stop comparison"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Compare"]}}, "/v3/projects/{id}/repository/contributors"=>{"get"=>{"summary"=>"Get Projects Repository Contributors", "description"=>"Get projects repository contributors.", "operationId"=>"getV3ProjectsIdRepositoryContributors", "x-api-path-slug"=>"v3projectsidrepositorycontributors-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Contributors"]}}, "/v3/projects/{id}/runners"=>{"get"=>{"summary"=>"Get Projects Runners", "description"=>"Get runners available for project", "operationId"=>"getV3ProjectsIdRunners", "x-api-path-slug"=>"v3projectsidrunners-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"scope", "description"=>"The scope of specific runners to show"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Runners"]}, "post"=>{"summary"=>"Post Projects Runners", "description"=>"Enable a runner for a project", "operationId"=>"postV3ProjectsIdRunners", "x-api-path-slug"=>"v3projectsidrunners-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"runner_id", "description"=>"The ID of the runner"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Runners"]}}, "/v3/projects/{id}/runners/{runner_id}"=>{"delete"=>{"summary"=>"Delete Projects Runners Runner", "description"=>"Delete projects runners runner.", "operationId"=>"deleteV3ProjectsIdRunnersRunnerId", "x-api-path-slug"=>"v3projectsidrunnersrunner-id-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"runner_id", "description"=>"The ID of the runner"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Runners", "Runner"]}}, "/v3/projects/{id}/services/asana"=>{"put"=>{"summary"=>"Put Projects Services Asana", "description"=>"Set asana service for project", "operationId"=>"putV3ProjectsIdServicesAsana", "x-api-path-slug"=>"v3projectsidservicesasana-put", "parameters"=>[{"in"=>"formData", "name"=>"api_key", "description"=>"User API token"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"restrict_to_branch", "description"=>"Comma-separated list of branches which will be automatically inspected"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Asana"]}}, "/v3/projects/{id}/services/assembla"=>{"put"=>{"summary"=>"Put Projects Services Assembla", "description"=>"Set assembla service for project", "operationId"=>"putV3ProjectsIdServicesAssembla", "x-api-path-slug"=>"v3projectsidservicesassembla-put", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"subdomain", "description"=>"Subdomain setting"}, {"in"=>"formData", "name"=>"token", "description"=>"The authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Assembla"]}}, "/v3/projects/{id}/services/bamboo"=>{"put"=>{"summary"=>"Put Projects Services Bamboo", "description"=>"Set bamboo service for project", "operationId"=>"putV3ProjectsIdServicesBamboo", "x-api-path-slug"=>"v3projectsidservicesbamboo-put", "parameters"=>[{"in"=>"formData", "name"=>"bamboo_url", "description"=>"Bamboo root URL like https://bamboo"}, {"in"=>"formData", "name"=>"build_key", "description"=>"Bamboo build plan key like"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"password", "description"=>"Passord of the user"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"username", "description"=>"A user with API access, if applicable"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Bamboo"]}}, "/v3/projects/{id}/services/bugzilla"=>{"put"=>{"summary"=>"Put Projects Services Bugzilla", "description"=>"Set bugzilla service for project", "operationId"=>"putV3ProjectsIdServicesBugzilla", "x-api-path-slug"=>"v3projectsidservicesbugzilla-put", "parameters"=>[{"in"=>"formData", "name"=>"description", "description"=>"Description"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"issues_url", "description"=>"Issues URL"}, {"in"=>"formData", "name"=>"new_issue_url", "description"=>"New issue URL"}, {"in"=>"formData", "name"=>"project_url", "description"=>"Project URL"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"title", "description"=>"Title"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Bugzilla"]}}, "/v3/projects/{id}/services/buildkite"=>{"put"=>{"summary"=>"Put Projects Services Buildkite", "description"=>"Set buildkite service for project", "operationId"=>"putV3ProjectsIdServicesBuildkite", "x-api-path-slug"=>"v3projectsidservicesbuildkite-put", "parameters"=>[{"in"=>"formData", "name"=>"enable_ssl_verification", "description"=>"Enable SSL verification for communication"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"project_url", "description"=>"The buildkite project URL"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"token", "description"=>"Buildkite project GitLab token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Buildkite"]}}, "/v3/projects/{id}/services/builds-email"=>{"put"=>{"summary"=>"Put Projects Services Builds Email", "description"=>"Set builds-email service for project", "operationId"=>"putV3ProjectsIdServicesBuildsEmail", "x-api-path-slug"=>"v3projectsidservicesbuildsemail-put", "parameters"=>[{"in"=>"formData", "name"=>"add_pusher", "description"=>"Add pusher to recipients list"}, {"in"=>"formData", "name"=>"build_events", "description"=>"Event will be triggered when a build status changes"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"notify_only_broken_builds", "description"=>"Notify only broken builds"}, {"in"=>"formData", "name"=>"recipients", "description"=>"Comma-separated list of recipient email addresses"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Builds", "Email"]}}, "/v3/projects/{id}/services/campfire"=>{"put"=>{"summary"=>"Put Projects Services Campfire", "description"=>"Set campfire service for project", "operationId"=>"putV3ProjectsIdServicesCampfire", "x-api-path-slug"=>"v3projectsidservicescampfire-put", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"room", "description"=>"Campfire room"}, {"in"=>"formData", "name"=>"subdomain", "description"=>"Campfire subdomain"}, {"in"=>"formData", "name"=>"token", "description"=>"Campfire token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Campfire"]}}, "/v3/projects/{id}/services/custom-issue-tracker"=>{"put"=>{"summary"=>"Put Projects Services Custom Issue Tracker", "description"=>"Set custom-issue-tracker service for project", "operationId"=>"putV3ProjectsIdServicesCustomIssueTracker", "x-api-path-slug"=>"v3projectsidservicescustomissuetracker-put", "parameters"=>[{"in"=>"formData", "name"=>"description", "description"=>"Description"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"issues_url", "description"=>"Issues URL"}, {"in"=>"formData", "name"=>"new_issue_url", "description"=>"New issue URL"}, {"in"=>"formData", "name"=>"project_url", "description"=>"Project URL"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"title", "description"=>"Title"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Custom", "Issue", "Tracker"]}}, "/v3/projects/{id}/services/drone-ci"=>{"put"=>{"summary"=>"Put Projects Services Drone Ci", "description"=>"Set drone-ci service for project", "operationId"=>"putV3ProjectsIdServicesDroneCi", "x-api-path-slug"=>"v3projectsidservicesdroneci-put", "parameters"=>[{"in"=>"formData", "name"=>"drone_url", "description"=>"Drone CI URL"}, {"in"=>"formData", "name"=>"enable_ssl_verification", "description"=>"Enable SSL verification for communication"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"merge_request_events", "description"=>"Event will be triggered when a merge request is created/updated/merged"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"tag_push_events", "description"=>"Event will be triggered when a new tag is pushed to the repository"}, {"in"=>"formData", "name"=>"token", "description"=>"Drone CI token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Drone", "Ci"]}}, "/v3/projects/{id}/services/emails-on-push"=>{"put"=>{"summary"=>"Put Projects Services Emails On Push", "description"=>"Set emails-on-push service for project", "operationId"=>"putV3ProjectsIdServicesEmailsOnPush", "x-api-path-slug"=>"v3projectsidservicesemailsonpush-put", "parameters"=>[{"in"=>"formData", "name"=>"disable_diffs", "description"=>"Disable code diffs"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"recipients", "description"=>"Comma-separated list of recipient email addresses"}, {"in"=>"formData", "name"=>"send_from_committer_email", "description"=>"Send from committer"}, {"in"=>"formData", "name"=>"tag_push_events", "description"=>"Event will be triggered when a new tag is pushed to the repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Emails", "On", "Push"]}}, "/v3/projects/{id}/services/external-wiki"=>{"put"=>{"summary"=>"Put Projects Services External Wiki", "description"=>"Set external-wiki service for project", "operationId"=>"putV3ProjectsIdServicesExternalWiki", "x-api-path-slug"=>"v3projectsidservicesexternalwiki-put", "parameters"=>[{"in"=>"formData", "name"=>"external_wiki_url", "description"=>"The URL of the external Wiki"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "External", "Wiki"]}}, "/v3/projects/{id}/services/flowdock"=>{"put"=>{"summary"=>"Put Projects Services Flowdock", "description"=>"Set flowdock service for project", "operationId"=>"putV3ProjectsIdServicesFlowdock", "x-api-path-slug"=>"v3projectsidservicesflowdock-put", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"token", "description"=>"Flowdock token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Flowdock"]}}, "/v3/projects/{id}/services/gemnasium"=>{"put"=>{"summary"=>"Put Projects Services Gemnasium", "description"=>"Set gemnasium service for project", "operationId"=>"putV3ProjectsIdServicesGemnasium", "x-api-path-slug"=>"v3projectsidservicesgemnasium-put", "parameters"=>[{"in"=>"formData", "name"=>"api_key", "description"=>"Your personal API key on gemnasium"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"token", "description"=>"The projects slug on gemnasium"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Gemnasium"]}}, "/v3/projects/{id}/services/hipchat"=>{"put"=>{"summary"=>"Put Projects Services Hipchat", "description"=>"Set hipchat service for project", "operationId"=>"putV3ProjectsIdServicesHipchat", "x-api-path-slug"=>"v3projectsidserviceshipchat-put", "parameters"=>[{"in"=>"formData", "name"=>"api_version", "description"=>"Leave blank for default (v2)"}, {"in"=>"formData", "name"=>"build_events", "description"=>"Event will be triggered when a build status changes"}, {"in"=>"formData", "name"=>"color", "description"=>"The room color"}, {"in"=>"formData", "name"=>"confidential_issue_events", "description"=>"Event will be triggered when a confidential issue is created/updated/closed"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"issue_events", "description"=>"Event will be triggered when an issue is created/updated/closed"}, {"in"=>"formData", "name"=>"merge_request_events", "description"=>"Event will be triggered when a merge request is created/updated/merged"}, {"in"=>"formData", "name"=>"note_events", "description"=>"Event will be triggered when someone adds a comment"}, {"in"=>"formData", "name"=>"notify", "description"=>"Enable notifications"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"room", "description"=>"The room name or ID"}, {"in"=>"formData", "name"=>"server", "description"=>"Leave blank for default"}, {"in"=>"formData", "name"=>"tag_push_events", "description"=>"Event will be triggered when a new tag is pushed to the repository"}, {"in"=>"formData", "name"=>"token", "description"=>"The room token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Hipchat"]}}, "/v3/projects/{id}/services/irker"=>{"put"=>{"summary"=>"Put Projects Services Irker", "description"=>"Set irker service for project", "operationId"=>"putV3ProjectsIdServicesIrker", "x-api-path-slug"=>"v3projectsidservicesirker-put", "parameters"=>[{"in"=>"formData", "name"=>"colorize_messages", "description"=>"Colorize messages"}, {"in"=>"formData", "name"=>"default_irc_uri", "description"=>"Default: irc://irc"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"recipients", "description"=>"Recipients/channels separated by whitespaces"}, {"in"=>"formData", "name"=>"server_host", "description"=>"Server host"}, {"in"=>"formData", "name"=>"server_port", "description"=>"Server port"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Irker"]}}, "/v3/projects/{id}/services/jira"=>{"put"=>{"summary"=>"Put Projects Services Jira", "description"=>"Set jira service for project", "operationId"=>"putV3ProjectsIdServicesJira", "x-api-path-slug"=>"v3projectsidservicesjira-put", "parameters"=>[{"in"=>"formData", "name"=>"commit_events", "description"=>"Event will be triggered when a commit is created/updated"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"jira_issue_transition_id", "description"=>"The ID of a transition that moves issues to a closed state"}, {"in"=>"formData", "name"=>"merge_request_events", "description"=>"Event will be triggered when a merge request is created/updated/merged"}, {"in"=>"formData", "name"=>"password", "description"=>"The password of the user created to be used with GitLab/JIRA"}, {"in"=>"formData", "name"=>"project_key", "description"=>"The short identifier for your JIRA project, all uppercase, e"}, {"in"=>"formData", "name"=>"url", "description"=>"The URL to the JIRA project which is being linked to this GitLab project, e"}, {"in"=>"formData", "name"=>"username", "description"=>"The username of the user created to be used with GitLab/JIRA"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Jira"]}}, "/v3/projects/{id}/services/kubernetes"=>{"put"=>{"summary"=>"Put Projects Services Kubernetes", "description"=>"Set kubernetes service for project", "operationId"=>"putV3ProjectsIdServicesKubernetes", "x-api-path-slug"=>"v3projectsidserviceskubernetes-put", "parameters"=>[{"in"=>"formData", "name"=>"api_url", "description"=>"The URL to the Kubernetes cluster API, e"}, {"in"=>"formData", "name"=>"ca_pem", "description"=>"A custom certificate authority bundle to verify the Kubernetes cluster with (PEM format)"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"namespace", "description"=>"The Kubernetes namespace to use"}, {"in"=>"formData", "name"=>"token", "description"=>"The service token to authenticate against the Kubernetes cluster with"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Kubernetes"]}}, "/v3/projects/{id}/services/mattermost-slash-commands"=>{"put"=>{"summary"=>"Put Projects Services Mattermost Slash Commands", "description"=>"Set mattermost-slash-commands service for project", "operationId"=>"putV3ProjectsIdServicesMattermostSlashCommands", "x-api-path-slug"=>"v3projectsidservicesmattermostslashcommands-put", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"token", "description"=>"The Mattermost token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Mattermost", "Slash", "Commands"]}}, "/v3/projects/{id}/services/slack-slash-commands"=>{"put"=>{"summary"=>"Put Projects Services Slack Slash Commands", "description"=>"Set slack-slash-commands service for project", "operationId"=>"putV3ProjectsIdServicesSlackSlashCommands", "x-api-path-slug"=>"v3projectsidservicesslackslashcommands-put", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"token", "description"=>"The Slack token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Slack", "Slash", "Commands"]}}, "/v3/projects/{id}/services/pipelines-email"=>{"put"=>{"summary"=>"Put Projects Services Pipelines Email", "description"=>"Set pipelines-email service for project", "operationId"=>"putV3ProjectsIdServicesPipelinesEmail", "x-api-path-slug"=>"v3projectsidservicespipelinesemail-put", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"notify_only_broken_builds", "description"=>"Notify only broken builds"}, {"in"=>"formData", "name"=>"pipeline_events"}, {"in"=>"formData", "name"=>"recipients", "description"=>"Comma-separated list of recipient email addresses"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Pipelines", "Email"]}}, "/v3/projects/{id}/services/pivotaltracker"=>{"put"=>{"summary"=>"Put Projects Services Pivotaltracker", "description"=>"Set pivotaltracker service for project", "operationId"=>"putV3ProjectsIdServicesPivotaltracker", "x-api-path-slug"=>"v3projectsidservicespivotaltracker-put", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"restrict_to_branch", "description"=>"Comma-separated list of branches which will be automatically inspected"}, {"in"=>"formData", "name"=>"token", "description"=>"The Pivotaltracker token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Pivotaltracker"]}}, "/v3/projects/{id}/services/pushover"=>{"put"=>{"summary"=>"Put Projects Services Pushover", "description"=>"Set pushover service for project", "operationId"=>"putV3ProjectsIdServicesPushover", "x-api-path-slug"=>"v3projectsidservicespushover-put", "parameters"=>[{"in"=>"formData", "name"=>"api_key", "description"=>"The application key"}, {"in"=>"formData", "name"=>"device", "description"=>"Leave blank for all active devices"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"priority", "description"=>"The priority"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"sound", "description"=>"The sound of the notification"}, {"in"=>"formData", "name"=>"user_key", "description"=>"The user key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Pushover"]}}, "/v3/projects/{id}/services/redmine"=>{"put"=>{"summary"=>"Put Projects Services Redmine", "description"=>"Set redmine service for project", "operationId"=>"putV3ProjectsIdServicesRedmine", "x-api-path-slug"=>"v3projectsidservicesredmine-put", "parameters"=>[{"in"=>"formData", "name"=>"description", "description"=>"The description of the tracker"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"issues_url", "description"=>"The issues URL"}, {"in"=>"formData", "name"=>"new_issue_url", "description"=>"The new issue URL"}, {"in"=>"formData", "name"=>"project_url", "description"=>"The project URL"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Redmine"]}}, "/v3/projects/{id}/services/slack"=>{"put"=>{"summary"=>"Put Projects Services Slack", "description"=>"Set slack service for project", "operationId"=>"putV3ProjectsIdServicesSlack", "x-api-path-slug"=>"v3projectsidservicesslack-put", "parameters"=>[{"in"=>"formData", "name"=>"build_events", "description"=>"Event will be triggered when a build status changes"}, {"in"=>"formData", "name"=>"channel", "description"=>"The channel name"}, {"in"=>"formData", "name"=>"confidential_issue_events", "description"=>"Event will be triggered when a confidential issue is created/updated/closed"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"issue_events", "description"=>"Event will be triggered when an issue is created/updated/closed"}, {"in"=>"formData", "name"=>"merge_request_events", "description"=>"Event will be triggered when a merge request is created/updated/merged"}, {"in"=>"formData", "name"=>"new_issue_url", "description"=>"The user name"}, {"in"=>"formData", "name"=>"note_events", "description"=>"Event will be triggered when someone adds a comment"}, {"in"=>"formData", "name"=>"pipeline_events"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"tag_push_events", "description"=>"Event will be triggered when a new tag is pushed to the repository"}, {"in"=>"formData", "name"=>"webhook", "description"=>"The Slack webhook"}, {"in"=>"formData", "name"=>"wiki_page_events", "description"=>"Event will be triggered when a wiki page is created/updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Slack"]}}, "/v3/projects/{id}/services/mattermost"=>{"put"=>{"summary"=>"Put Projects Services Mattermost", "description"=>"Set mattermost service for project", "operationId"=>"putV3ProjectsIdServicesMattermost", "x-api-path-slug"=>"v3projectsidservicesmattermost-put", "parameters"=>[{"in"=>"formData", "name"=>"build_events", "description"=>"Event will be triggered when a build status changes"}, {"in"=>"formData", "name"=>"confidential_issue_events", "description"=>"Event will be triggered when a confidential issue is created/updated/closed"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"issue_events", "description"=>"Event will be triggered when an issue is created/updated/closed"}, {"in"=>"formData", "name"=>"merge_request_events", "description"=>"Event will be triggered when a merge request is created/updated/merged"}, {"in"=>"formData", "name"=>"note_events", "description"=>"Event will be triggered when someone adds a comment"}, {"in"=>"formData", "name"=>"pipeline_events"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"tag_push_events", "description"=>"Event will be triggered when a new tag is pushed to the repository"}, {"in"=>"formData", "name"=>"webhook", "description"=>"The Mattermost webhook"}, {"in"=>"formData", "name"=>"wiki_page_events", "description"=>"Event will be triggered when a wiki page is created/updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Mattermost"]}}, "/v3/projects/{id}/services/teamcity"=>{"put"=>{"summary"=>"Put Projects Services Teamcity", "description"=>"Set teamcity service for project", "operationId"=>"putV3ProjectsIdServicesTeamcity", "x-api-path-slug"=>"v3projectsidservicesteamcity-put", "parameters"=>[{"in"=>"formData", "name"=>"build_type", "description"=>"Build configuration ID"}, {"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"password", "description"=>"The password of the user"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Event will be triggered by a push to the repository"}, {"in"=>"formData", "name"=>"teamcity_url", "description"=>"TeamCity root URL like https://teamcity"}, {"in"=>"formData", "name"=>"username", "description"=>"A user with permissions to trigger a manual build"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Teamcity"]}}, "/v3/projects/{id}/services/{service_slug}"=>{"delete"=>{"summary"=>"Delete Projects Services Service Slug", "description"=>"Delete projects services service slug.", "operationId"=>"deleteV3ProjectsIdServicesServiceSlug", "x-api-path-slug"=>"v3projectsidservicesservice-slug-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"service_slug", "description"=>"The name of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Service", "Slug"]}, "get"=>{"summary"=>"Get Projects Services Service Slug", "description"=>"Get the service settings for project", "operationId"=>"getV3ProjectsIdServicesServiceSlug", "x-api-path-slug"=>"v3projectsidservicesservice-slug-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"service_slug", "description"=>"The name of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Service", "Slug"]}}, "/v3/projects/{id}/services/mattermost_slash_commands/trigger"=>{"post"=>{"summary"=>"Post Projects Services Mattermost Slash Commands Trigger", "description"=>"Post projects services mattermost slash commands trigger.", "operationId"=>"postV3ProjectsIdServicesMattermostSlashCommandsTrigger", "x-api-path-slug"=>"v3projectsidservicesmattermost-slash-commandstrigger-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"token", "description"=>"The Mattermost token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Mattermost", "Slash", "Commands", "Trigger"]}}, "/v3/projects/{id}/services/slack_slash_commands/trigger"=>{"post"=>{"summary"=>"Post Projects Services Slack Slash Commands Trigger", "description"=>"Post projects services slack slash commands trigger.", "operationId"=>"postV3ProjectsIdServicesSlackSlashCommandsTrigger", "x-api-path-slug"=>"v3projectsidservicesslack-slash-commandstrigger-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"token", "description"=>"The Slack token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Services", "Slack", "Slash", "Commands", "Trigger"]}}, "/v3/projects/{id}/merge_request/{subscribable_id}/subscription"=>{"post"=>{"summary"=>"Post Projects Merge Request Subscribable Subscription", "description"=>"Post projects merge request subscribable subscription.", "operationId"=>"postV3ProjectsIdMergeRequestSubscribableIdSubscription", "x-api-path-slug"=>"v3projectsidmerge-requestsubscribable-idsubscription-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"subscribable_id", "description"=>"The ID of a resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Request", "Subscribable", "Subscription"]}, "delete"=>{"summary"=>"Delete Projects Merge Request Subscribable Subscription", "description"=>"Delete projects merge request subscribable subscription.", "operationId"=>"deleteV3ProjectsIdMergeRequestSubscribableIdSubscription", "x-api-path-slug"=>"v3projectsidmerge-requestsubscribable-idsubscription-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"subscribable_id", "description"=>"The ID of a resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Request", "Subscribable", "Subscription"]}}, "/v3/projects/{id}/merge_requests/{subscribable_id}/subscription"=>{"post"=>{"summary"=>"Post Projects Merge Requests Subscribable Subscription", "description"=>"Post projects merge requests subscribable subscription.", "operationId"=>"postV3ProjectsIdMergeRequestsSubscribableIdSubscription", "x-api-path-slug"=>"v3projectsidmerge-requestssubscribable-idsubscription-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"subscribable_id", "description"=>"The ID of a resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Subscribable", "Subscription"]}, "delete"=>{"summary"=>"Delete Projects Merge Requests Subscribable Subscription", "description"=>"Delete projects merge requests subscribable subscription.", "operationId"=>"deleteV3ProjectsIdMergeRequestsSubscribableIdSubscription", "x-api-path-slug"=>"v3projectsidmerge-requestssubscribable-idsubscription-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"subscribable_id", "description"=>"The ID of a resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Subscribable", "Subscription"]}}, "/v3/projects/{id}/issues/{subscribable_id}/subscription"=>{"post"=>{"summary"=>"Post Projects Issues Subscribable Subscription", "description"=>"Post projects issues subscribable subscription.", "operationId"=>"postV3ProjectsIdIssuesSubscribableIdSubscription", "x-api-path-slug"=>"v3projectsidissuessubscribable-idsubscription-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"subscribable_id", "description"=>"The ID of a resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Subscribable", "Subscription"]}, "delete"=>{"summary"=>"Delete Projects Issues Subscribable Subscription", "description"=>"Delete projects issues subscribable subscription.", "operationId"=>"deleteV3ProjectsIdIssuesSubscribableIdSubscription", "x-api-path-slug"=>"v3projectsidissuessubscribable-idsubscription-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"subscribable_id", "description"=>"The ID of a resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Subscribable", "Subscription"]}}, "/v3/projects/{id}/labels/{subscribable_id}/subscription"=>{"post"=>{"summary"=>"Post Projects Labels Subscribable Subscription", "description"=>"Post projects labels subscribable subscription.", "operationId"=>"postV3ProjectsIdLabelsSubscribableIdSubscription", "x-api-path-slug"=>"v3projectsidlabelssubscribable-idsubscription-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"subscribable_id", "description"=>"The ID of a resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Labels", "Subscribable", "Subscription"]}, "delete"=>{"summary"=>"Delete Projects Labels Subscribable Subscription", "description"=>"Delete projects labels subscribable subscription.", "operationId"=>"deleteV3ProjectsIdLabelsSubscribableIdSubscription", "x-api-path-slug"=>"v3projectsidlabelssubscribable-idsubscription-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"subscribable_id", "description"=>"The ID of a resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Labels", "Subscribable", "Subscription"]}}, "/v3/projects/{id}/repository/tags"=>{"get"=>{"summary"=>"Get Projects Repository Tags", "description"=>"Get a project repository tags", "operationId"=>"getV3ProjectsIdRepositoryTags", "x-api-path-slug"=>"v3projectsidrepositorytags-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Tags"]}, "post"=>{"summary"=>"Post Projects Repository Tags", "description"=>"Post projects repository tags.", "operationId"=>"postV3ProjectsIdRepositoryTags", "x-api-path-slug"=>"v3projectsidrepositorytags-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"message", "description"=>"Specifying a message creates an annotated tag"}, {"in"=>"formData", "name"=>"ref", "description"=>"The commit sha or branch name"}, {"in"=>"formData", "name"=>"release_description", "description"=>"Specifying release notes stored in the GitLab database"}, {"in"=>"formData", "name"=>"tag_name", "description"=>"The name of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Tags"]}}, "/v3/projects/{id}/repository/tags/{tag_name}"=>{"get"=>{"summary"=>"Get Projects Repository Tags Tag Name", "description"=>"Get projects repository tags tag name.", "operationId"=>"getV3ProjectsIdRepositoryTagsTagName", "x-api-path-slug"=>"v3projectsidrepositorytagstag-name-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"tag_name", "description"=>"The name of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Tags", "Tag", "Name"]}, "delete"=>{"summary"=>"Delete Projects Repository Tags Tag Name", "description"=>"Delete projects repository tags tag name.", "operationId"=>"deleteV3ProjectsIdRepositoryTagsTagName", "x-api-path-slug"=>"v3projectsidrepositorytagstag-name-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"tag_name", "description"=>"The name of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Tags", "Tag", "Name"]}}, "/v3/projects/{id}/repository/tags/{tag_name}/release"=>{"post"=>{"summary"=>"Post Projects Repository Tags Tag Name Release", "description"=>"Post projects repository tags tag name release.", "operationId"=>"postV3ProjectsIdRepositoryTagsTagNameRelease", "x-api-path-slug"=>"v3projectsidrepositorytagstag-namerelease-post", "parameters"=>[{"in"=>"formData", "name"=>"description", "description"=>"Release notes with markdown support"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"tag_name", "description"=>"The name of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Tags", "Tag", "Name", "Release"]}, "put"=>{"summary"=>"Put Projects Repository Tags Tag Name Release", "description"=>"Put projects repository tags tag name release.", "operationId"=>"putV3ProjectsIdRepositoryTagsTagNameRelease", "x-api-path-slug"=>"v3projectsidrepositorytagstag-namerelease-put", "parameters"=>[{"in"=>"formData", "name"=>"description", "description"=>"Release notes with markdown support"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"tag_name", "description"=>"The name of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Repository", "Tags", "Tag", "Name", "Release"]}}, "/v3/projects/{id}/merge_requests/{merge_request_id}/todo"=>{"post"=>{"summary"=>"Post Projects Merge Requests Merge Request Todo", "description"=>"Post projects merge requests merge request todo.", "operationId"=>"postV3ProjectsIdMergeRequestsMergeRequestIdTodo", "x-api-path-slug"=>"v3projectsidmerge-requestsmerge-request-idtodo-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"merge_request_id", "description"=>"The ID of an issuable"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Merge", "Requests", "Merge", "Request", "Todo"]}}, "/v3/projects/{id}/issues/{issue_id}/todo"=>{"post"=>{"summary"=>"Post Projects Issues Issue Todo", "description"=>"Post projects issues issue todo.", "operationId"=>"postV3ProjectsIdIssuesIssueIdTodo", "x-api-path-slug"=>"v3projectsidissuesissue-idtodo-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"issue_id", "description"=>"The ID of an issuable"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Issues", "Issue", "Todo"]}}, "/v3/projects/{id}/(ref/{ref}/)trigger/builds"=>{"post"=>{"summary"=>"Post Projects (ref Ref )trigger Builds", "description"=>"Post projects (ref ref )trigger builds.", "operationId"=>"postV3ProjectsId(refRef)triggerBuilds", "x-api-path-slug"=>"v3projectsidrefreftriggerbuilds-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"ref", "description"=>"The commit sha or name of a branch or tag"}, {"in"=>"formData", "name"=>"token", "description"=>"The unique token of trigger"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "(ref", "Ref", ")trigger", "Builds"]}}, "/v3/projects/{id}/triggers"=>{"get"=>{"summary"=>"Get Projects Triggers", "description"=>"Get projects triggers.", "operationId"=>"getV3ProjectsIdTriggers", "x-api-path-slug"=>"v3projectsidtriggers-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Triggers"]}, "post"=>{"summary"=>"Post Projects Triggers", "description"=>"Post projects triggers.", "operationId"=>"postV3ProjectsIdTriggers", "x-api-path-slug"=>"v3projectsidtriggers-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Triggers"]}}, "/v3/projects/{id}/triggers/{token}"=>{"get"=>{"summary"=>"Get Projects Triggers Token", "description"=>"Get specific trigger of a project", "operationId"=>"getV3ProjectsIdTriggersToken", "x-api-path-slug"=>"v3projectsidtriggerstoken-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"token", "description"=>"The unique token of trigger"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Triggers", "Token"]}, "delete"=>{"summary"=>"Delete Projects Triggers Token", "description"=>"Delete projects triggers token.", "operationId"=>"deleteV3ProjectsIdTriggersToken", "x-api-path-slug"=>"v3projectsidtriggerstoken-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"token", "description"=>"The unique token of trigger"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Triggers", "Token"]}}, "/v3/projects/{id}/variables"=>{"get"=>{"summary"=>"Get Projects Variables", "description"=>"Get projects variables.", "operationId"=>"getV3ProjectsIdVariables", "x-api-path-slug"=>"v3projectsidvariables-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Variables"]}, "post"=>{"summary"=>"Post Projects Variables", "description"=>"Create a new variable in a project", "operationId"=>"postV3ProjectsIdVariables", "x-api-path-slug"=>"v3projectsidvariables-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"key", "description"=>"The key of the variable"}, {"in"=>"formData", "name"=>"value", "description"=>"The value of the variable"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Variables"]}}, "/v3/projects/{id}/variables/{key}"=>{"get"=>{"summary"=>"Get Projects Variables Key", "description"=>"Get a specific variable from a project", "operationId"=>"getV3ProjectsIdVariablesKey", "x-api-path-slug"=>"v3projectsidvariableskey-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"key", "description"=>"The key of the variable"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Variables", "Key"]}, "put"=>{"summary"=>"Put Projects Variables Key", "description"=>"Update an existing variable from a project", "operationId"=>"putV3ProjectsIdVariablesKey", "x-api-path-slug"=>"v3projectsidvariableskey-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"key", "description"=>"The key of the variable"}, {"in"=>"formData", "name"=>"value", "description"=>"The value of the variable"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Variables", "Key"]}, "delete"=>{"summary"=>"Delete Projects Variables Key", "description"=>"Delete an existing variable from a project", "operationId"=>"deleteV3ProjectsIdVariablesKey", "x-api-path-slug"=>"v3projectsidvariableskey-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"key", "description"=>"The key of the variable"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Variables", "Key"]}}, "/v3/projects/{id}/boards/{board_id}/lists"=>{"get"=>{"summary"=>"Get Projects Boards Board Lists", "description"=>"Does not include `backlog` and `done` lists. This feature was introduced in 8.13", "operationId"=>"getV3ProjectsIdBoardsBoardIdLists", "x-api-path-slug"=>"v3projectsidboardsboard-idlists-get", "parameters"=>[{"in"=>"path", "name"=>"board_id", "description"=>"The ID of a board"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Boards", "Board", "Lists"]}, "post"=>{"summary"=>"Post Projects Boards Board Lists", "description"=>"This feature was introduced in 8.13", "operationId"=>"postV3ProjectsIdBoardsBoardIdLists", "x-api-path-slug"=>"v3projectsidboardsboard-idlists-post", "parameters"=>[{"in"=>"path", "name"=>"board_id", "description"=>"The ID of a board"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"formData", "name"=>"label_id", "description"=>"The ID of an existing label"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Boards", "Board", "Lists"]}}, "/v3/projects/{id}/boards/{board_id}/lists/{list_id}"=>{"get"=>{"summary"=>"Get Projects Boards Board Lists List", "description"=>"Get projects boards board lists list.", "operationId"=>"getV3ProjectsIdBoardsBoardIdListsListId", "x-api-path-slug"=>"v3projectsidboardsboard-idlistslist-id-get", "parameters"=>[{"in"=>"path", "name"=>"board_id", "description"=>"The ID of a board"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"list_id", "description"=>"The ID of a list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Boards", "Board", "Lists", "List"]}, "put"=>{"summary"=>"Put Projects Boards Board Lists List", "description"=>"Put projects boards board lists list.", "operationId"=>"putV3ProjectsIdBoardsBoardIdListsListId", "x-api-path-slug"=>"v3projectsidboardsboard-idlistslist-id-put", "parameters"=>[{"in"=>"path", "name"=>"board_id", "description"=>"The ID of a board"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"list_id", "description"=>"The ID of a list"}, {"in"=>"formData", "name"=>"position", "description"=>"The position of the list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Boards", "Board", "Lists", "List"]}, "delete"=>{"summary"=>"Delete Projects Boards Board Lists List", "description"=>"Delete projects boards board lists list.", "operationId"=>"deleteV3ProjectsIdBoardsBoardIdListsListId", "x-api-path-slug"=>"v3projectsidboardsboard-idlistslist-id-delete", "parameters"=>[{"in"=>"path", "name"=>"board_id", "description"=>"The ID of a board"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a project"}, {"in"=>"path", "name"=>"list_id", "description"=>"The ID of a board list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Boards", "Board", "Lists", "List"]}}, "/v3/internal/allowed"=>{"post"=>{"summary"=>"Post Internal Allowed", "description"=>"Post internal allowed.", "operationId"=>"postV3InternalAllowed", "x-api-path-slug"=>"v3internalallowed-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internal", "Owed"]}}, "/v3/internal/lfs_authenticate"=>{"post"=>{"summary"=>"Post Internal Lfs Authenticate", "description"=>"Post internal lfs authenticate.", "operationId"=>"postV3InternalLfsAuthenticate", "x-api-path-slug"=>"v3internallfs-authenticate-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internal", "Lfs", "Authenticate"]}}, "/v3/internal/merge_request_urls"=>{"get"=>{"summary"=>"Get Internal Merge Request Urls", "description"=>"Get internal merge request urls.", "operationId"=>"getV3InternalMergeRequestUrls", "x-api-path-slug"=>"v3internalmerge-request-urls-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internal", "Merge", "Request", "Urls"]}}, "/v3/internal/discover"=>{"get"=>{"summary"=>"Get Internal Discover", "description"=>"Get internal discover.", "operationId"=>"getV3InternalDiscover", "x-api-path-slug"=>"v3internaldiscover-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internal", "Discover"]}}, "/v3/internal/check"=>{"get"=>{"summary"=>"Get Internal Check", "description"=>"Get internal check.", "operationId"=>"getV3InternalCheck", "x-api-path-slug"=>"v3internalcheck-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internal", "Check"]}}, "/v3/internal/broadcast_message"=>{"get"=>{"summary"=>"Get Internal Broadcast Message", "description"=>"Get internal broadcast message.", "operationId"=>"getV3InternalBroadcastMessage", "x-api-path-slug"=>"v3internalbroadcast-message-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internal", "Broadcast", "Message"]}}, "/v3/internal/two_factor_recovery_codes"=>{"post"=>{"summary"=>"Post Internal Two Factor Recovery Codes", "description"=>"Post internal two factor recovery codes.", "operationId"=>"postV3InternalTwoFactorRecoveryCodes", "x-api-path-slug"=>"v3internaltwo-factor-recovery-codes-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internal", "Two", "Factor", "Recovery", "Codes"]}}, "/v3/issues"=>{"get"=>{"summary"=>"Get Issues", "description"=>"Get currently authenticated user's issues", "operationId"=>"getV3Issues", "x-api-path-slug"=>"v3issues-get", "parameters"=>[{"in"=>"query", "name"=>"labels", "description"=>"Comma-separated list of label names"}, {"in"=>"query", "name"=>"milestone", "description"=>"Return issues for a specific milestone"}, {"in"=>"query", "name"=>"order_by", "description"=>"Return issues ordered by `created_at` or `updated_at` fields"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"sort", "description"=>"Return issues sorted in `asc` or `desc` order"}, {"in"=>"query", "name"=>"state", "description"=>"Return opened, closed, or all issues"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Issues"]}}, "/v3/keys/{id}"=>{"get"=>{"summary"=>"Get Keys", "description"=>"Get single ssh key by id. Only available to admin users", "operationId"=>"getV3KeysId", "x-api-path-slug"=>"v3keysid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/v3/ci/lint"=>{"post"=>{"summary"=>"Post Ci Lint", "description"=>"Validation of .gitlab-ci.yml content", "operationId"=>"postV3CiLint", "x-api-path-slug"=>"v3cilint-post", "parameters"=>[{"in"=>"formData", "name"=>"content", "description"=>"Content of "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ci", "Lint"]}}, "/v3/namespaces"=>{"get"=>{"summary"=>"Get Namespaces", "description"=>"Get a namespaces list", "operationId"=>"getV3Namespaces", "x-api-path-slug"=>"v3namespaces-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"search", "description"=>"Search query for namespaces"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces"]}}, "/v3/notification_settings"=>{"get"=>{"summary"=>"Get Notification Settings", "description"=>"This feature was introduced in GitLab 8.12", "operationId"=>"getV3NotificationSettings", "x-api-path-slug"=>"v3notification-settings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification", "Settings"]}, "put"=>{"summary"=>"Put Notification Settings", "description"=>"This feature was introduced in GitLab 8.12", "operationId"=>"putV3NotificationSettings", "x-api-path-slug"=>"v3notification-settings-put", "parameters"=>[{"in"=>"formData", "name"=>"close_issue", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"close_merge_request", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"failed_pipeline", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"level", "description"=>"The global notification level"}, {"in"=>"formData", "name"=>"merge_merge_request", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"new_issue", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"new_merge_request", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"new_note", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"notification_email", "description"=>"The email address to send notifications"}, {"in"=>"formData", "name"=>"reassign_issue", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"reassign_merge_request", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"reopen_issue", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"reopen_merge_request", "description"=>"Enable/disable this notification"}, {"in"=>"formData", "name"=>"success_pipeline", "description"=>"Enable/disable this notification"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification", "Settings"]}}, "/v3/runners"=>{"get"=>{"summary"=>"Get Runners", "description"=>"Get runners available for user", "operationId"=>"getV3Runners", "x-api-path-slug"=>"v3runners-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"scope", "description"=>"The scope of specific runners to show"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runners"]}}, "/v3/runners/all"=>{"get"=>{"summary"=>"Get Runners All", "description"=>"Get all runners - shared and specific", "operationId"=>"getV3RunnersAll", "x-api-path-slug"=>"v3runnersall-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"scope", "description"=>"The scope of specific runners to show"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runners"]}}, "/v3/runners/{id}"=>{"get"=>{"summary"=>"Get Runners", "description"=>"Get runner's details", "operationId"=>"getV3RunnersId", "x-api-path-slug"=>"v3runnersid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the runner"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runners"]}, "put"=>{"summary"=>"Put Runners", "description"=>"Update runner's details", "operationId"=>"putV3RunnersId", "x-api-path-slug"=>"v3runnersid-put", "parameters"=>[{"in"=>"formData", "name"=>"active", "description"=>"The state of a runner"}, {"in"=>"formData", "name"=>"description", "description"=>"The description of the runner"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the runner"}, {"in"=>"formData", "name"=>"locked", "description"=>"Flag indicating the runner is locked"}, {"in"=>"formData", "name"=>"run_untagged", "description"=>"Flag indicating the runner can execute untagged jobs"}, {"in"=>"formData", "name"=>"tag_list", "description"=>"The list of tags for a runner"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runners"]}, "delete"=>{"summary"=>"Delete Runners", "description"=>"Remove a runner", "operationId"=>"deleteV3RunnersId", "x-api-path-slug"=>"v3runnersid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the runner"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runners"]}}, "/v3/snippets"=>{"get"=>{"summary"=>"Get Snippets", "description"=>"This feature was introduced in GitLab 8.15.", "operationId"=>"getV3Snippets", "x-api-path-slug"=>"v3snippets-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets"]}, "post"=>{"summary"=>"Post Snippets", "description"=>"This feature was introduced in GitLab 8.15.", "operationId"=>"postV3Snippets", "x-api-path-slug"=>"v3snippets-post", "parameters"=>[{"in"=>"formData", "name"=>"content", "description"=>"The content of a snippet"}, {"in"=>"formData", "name"=>"file_name", "description"=>"The name of a snippet file"}, {"in"=>"formData", "name"=>"title", "description"=>"The title of a snippet"}, {"in"=>"formData", "name"=>"visibility_level", "description"=>"The visibility level of the snippet"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets"]}}, "/v3/snippets/public"=>{"get"=>{"summary"=>"Get Snippets Public", "description"=>"This feature was introduced in GitLab 8.15.", "operationId"=>"getV3SnippetsPublic", "x-api-path-slug"=>"v3snippetspublic-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Public"]}}, "/v3/snippets/{id}"=>{"get"=>{"summary"=>"Get Snippets", "description"=>"This feature was introduced in GitLab 8.15.", "operationId"=>"getV3SnippetsId", "x-api-path-slug"=>"v3snippetsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a snippet"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets"]}, "put"=>{"summary"=>"Put Snippets", "description"=>"This feature was introduced in GitLab 8.15.", "operationId"=>"putV3SnippetsId", "x-api-path-slug"=>"v3snippetsid-put", "parameters"=>[{"in"=>"formData", "name"=>"content", "description"=>"The content of a snippet"}, {"in"=>"formData", "name"=>"file_name", "description"=>"The name of a snippet file"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of a snippet"}, {"in"=>"formData", "name"=>"title", "description"=>"The title of a snippet"}, {"in"=>"formData", "name"=>"visibility_level", "description"=>"The visibility level of the snippet"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets"]}, "delete"=>{"summary"=>"Delete Snippets", "description"=>"This feature was introduced in GitLab 8.15.", "operationId"=>"deleteV3SnippetsId", "x-api-path-slug"=>"v3snippetsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a snippet"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets"]}}, "/v3/snippets/{id}/raw"=>{"get"=>{"summary"=>"Get Snippets Raw", "description"=>"This feature was introduced in GitLab 8.15.", "operationId"=>"getV3SnippetsIdRaw", "x-api-path-slug"=>"v3snippetsidraw-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of a snippet"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Raw"]}}, "/v3/hooks"=>{"get"=>{"summary"=>"Get Hooks", "description"=>"Get the list of system hooks", "operationId"=>"getV3Hooks", "x-api-path-slug"=>"v3hooks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hooks"]}, "post"=>{"summary"=>"Post Hooks", "description"=>"Create a new system hook", "operationId"=>"postV3Hooks", "x-api-path-slug"=>"v3hooks-post", "parameters"=>[{"in"=>"formData", "name"=>"enable_ssl_verification", "description"=>"Do SSL verification when triggering the hook"}, {"in"=>"formData", "name"=>"push_events", "description"=>"Trigger hook on push events"}, {"in"=>"formData", "name"=>"tag_push_events", "description"=>"Trigger hook on tag push events"}, {"in"=>"formData", "name"=>"token", "description"=>"The token used to validate payloads"}, {"in"=>"formData", "name"=>"url", "description"=>"The URL to send the request to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hooks"]}}, "/v3/hooks/{id}"=>{"get"=>{"summary"=>"Get Hooks", "description"=>"Test a hook", "operationId"=>"getV3HooksId", "x-api-path-slug"=>"v3hooksid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the system hook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hooks"]}, "delete"=>{"summary"=>"Delete Hooks", "description"=>"Delete a hook", "operationId"=>"deleteV3HooksId", "x-api-path-slug"=>"v3hooksid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the system hook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hooks"]}}, "/v3/todos"=>{"get"=>{"summary"=>"Get Todos", "description"=>"Get a todo list", "operationId"=>"getV3Todos", "x-api-path-slug"=>"v3todos-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Todos"]}, "delete"=>{"summary"=>"Delete Todos", "description"=>"Mark all todos as done", "operationId"=>"deleteV3Todos", "x-api-path-slug"=>"v3todos-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Todos"]}}, "/v3/todos/{id}"=>{"delete"=>{"summary"=>"Delete Todos", "description"=>"Mark a todo as done", "operationId"=>"deleteV3TodosId", "x-api-path-slug"=>"v3todosid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the todo being marked as done"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Todos"]}}, "/v3/users"=>{"get"=>{"summary"=>"Get Users", "description"=>"Get the list of users", "operationId"=>"getV3Users", "x-api-path-slug"=>"v3users-get", "parameters"=>[{"in"=>"query", "name"=>"active", "description"=>"Filters only active users"}, {"in"=>"query", "name"=>"blocked", "description"=>"Filters only blocked users"}, {"in"=>"query", "name"=>"external", "description"=>"Filters only external users"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}, {"in"=>"query", "name"=>"search", "description"=>"Search for a username"}, {"in"=>"query", "name"=>"username", "description"=>"Get a single user with a specific username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "post"=>{"summary"=>"Post Users", "description"=>"Create a user. Available only for admins.", "operationId"=>"postV3Users", "x-api-path-slug"=>"v3users-post", "parameters"=>[{"in"=>"formData", "name"=>"admin", "description"=>"Flag indicating the user is an administrator"}, {"in"=>"formData", "name"=>"bio", "description"=>"The biography of the user"}, {"in"=>"formData", "name"=>"can_create_group", "description"=>"Flag indicating the user can create groups"}, {"in"=>"formData", "name"=>"confirm", "description"=>"Flag indicating the account needs to be confirmed"}, {"in"=>"formData", "name"=>"email", "description"=>"The email of the user"}, {"in"=>"formData", "name"=>"external", "description"=>"Flag indicating the user is an external user"}, {"in"=>"formData", "name"=>"extern_uid", "description"=>"The external authentication provider UID"}, {"in"=>"formData", "name"=>"linkedin", "description"=>"The LinkedIn username"}, {"in"=>"formData", "name"=>"location", "description"=>"The location of the user"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the user"}, {"in"=>"formData", "name"=>"organization", "description"=>"The organization of the user"}, {"in"=>"formData", "name"=>"password", "description"=>"The password of the new user"}, {"in"=>"formData", "name"=>"projects_limit", "description"=>"The number of projects a user can create"}, {"in"=>"formData", "name"=>"provider", "description"=>"The external provider"}, {"in"=>"formData", "name"=>"skype", "description"=>"The Skype username"}, {"in"=>"formData", "name"=>"twitter", "description"=>"The Twitter username"}, {"in"=>"formData", "name"=>"username", "description"=>"The username of the user"}, {"in"=>"formData", "name"=>"website_url", "description"=>"The website of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/v3/users/{id}"=>{"get"=>{"summary"=>"Get Users", "description"=>"Get a single user", "operationId"=>"getV3UsersId", "x-api-path-slug"=>"v3usersid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "put"=>{"summary"=>"Put Users", "description"=>"Update a user. Available only for admins.", "operationId"=>"putV3UsersId", "x-api-path-slug"=>"v3usersid-put", "parameters"=>[{"in"=>"formData", "name"=>"admin", "description"=>"Flag indicating the user is an administrator"}, {"in"=>"formData", "name"=>"bio", "description"=>"The biography of the user"}, {"in"=>"formData", "name"=>"can_create_group", "description"=>"Flag indicating the user can create groups"}, {"in"=>"formData", "name"=>"confirm", "description"=>"Flag indicating the account needs to be confirmed"}, {"in"=>"formData", "name"=>"email", "description"=>"The email of the user"}, {"in"=>"formData", "name"=>"external", "description"=>"Flag indicating the user is an external user"}, {"in"=>"formData", "name"=>"extern_uid", "description"=>"The external authentication provider UID"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the user"}, {"in"=>"formData", "name"=>"linkedin", "description"=>"The LinkedIn username"}, {"in"=>"formData", "name"=>"location", "description"=>"The location of the user"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the user"}, {"in"=>"formData", "name"=>"organization", "description"=>"The organization of the user"}, {"in"=>"formData", "name"=>"password", "description"=>"The password of the new user"}, {"in"=>"formData", "name"=>"projects_limit", "description"=>"The number of projects a user can create"}, {"in"=>"formData", "name"=>"provider", "description"=>"The external provider"}, {"in"=>"formData", "name"=>"skype", "description"=>"The Skype username"}, {"in"=>"formData", "name"=>"twitter", "description"=>"The Twitter username"}, {"in"=>"formData", "name"=>"username", "description"=>"The username of the user"}, {"in"=>"formData", "name"=>"website_url", "description"=>"The website of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "delete"=>{"summary"=>"Delete Users", "description"=>"Delete a user. Available only for admins.", "operationId"=>"deleteV3UsersId", "x-api-path-slug"=>"v3usersid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/v3/users/{id}/keys"=>{"post"=>{"summary"=>"Post Users Keys", "description"=>"Add an SSH key to a specified user. Available only for admins.", "operationId"=>"postV3UsersIdKeys", "x-api-path-slug"=>"v3usersidkeys-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the user"}, {"in"=>"formData", "name"=>"key", "description"=>"The new SSH key"}, {"in"=>"formData", "name"=>"title", "description"=>"The title of the new SSH key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Keys"]}, "get"=>{"summary"=>"Get Users Keys", "description"=>"Get the SSH keys of a specified user. Available only for admins.", "operationId"=>"getV3UsersIdKeys", "x-api-path-slug"=>"v3usersidkeys-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Keys"]}}, "/v3/users/{id}/keys/{key_id}"=>{"delete"=>{"summary"=>"Delete Users Keys Key", "description"=>"Delete an existing SSH key from a specified user. Available only for admins.", "operationId"=>"deleteV3UsersIdKeysKeyId", "x-api-path-slug"=>"v3usersidkeyskey-id-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the user"}, {"in"=>"path", "name"=>"key_id", "description"=>"The ID of the SSH key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Keys", "Key"]}}, "/v3/users/{id}/emails"=>{"post"=>{"summary"=>"Post Users Emails", "description"=>"Add an email address to a specified user. Available only for admins.", "operationId"=>"postV3UsersIdEmails", "x-api-path-slug"=>"v3usersidemails-post", "parameters"=>[{"in"=>"formData", "name"=>"email", "description"=>"The email of the user"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Emails"]}, "get"=>{"summary"=>"Get Users Emails", "description"=>"Get the emails addresses of a specified user. Available only for admins.", "operationId"=>"getV3UsersIdEmails", "x-api-path-slug"=>"v3usersidemails-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Emails"]}}, "/v3/users/{id}/emails/{email_id}"=>{"delete"=>{"summary"=>"Delete Users Emails Email", "description"=>"Delete an email address of a specified user. Available only for admins.", "operationId"=>"deleteV3UsersIdEmailsEmailId", "x-api-path-slug"=>"v3usersidemailsemail-id-delete", "parameters"=>[{"in"=>"path", "name"=>"email_id", "description"=>"The ID of the email"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Emails", "Email"]}}, "/v3/users/{id}/block"=>{"put"=>{"summary"=>"Put Users Block", "description"=>"Block a user. Available only for admins.", "operationId"=>"putV3UsersIdBlock", "x-api-path-slug"=>"v3usersidblock-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Block"]}}, "/v3/users/{id}/unblock"=>{"put"=>{"summary"=>"Put Users Unblock", "description"=>"Unblock a user. Available only for admins.", "operationId"=>"putV3UsersIdUnblock", "x-api-path-slug"=>"v3usersidunblock-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Unblock"]}}, "/v3/users/{id}/events"=>{"get"=>{"summary"=>"Get Users Events", "description"=>"This feature was introduced in GitLab 8.13.", "operationId"=>"getV3UsersIdEvents", "x-api-path-slug"=>"v3usersidevents-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the user"}, {"in"=>"query", "name"=>"page", "description"=>"Current page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Events"]}}, "/v3/user"=>{"get"=>{"summary"=>"Get User", "description"=>"Get the currently authenticated user", "operationId"=>"getV3User", "x-api-path-slug"=>"v3user-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/v3/user/keys"=>{"get"=>{"summary"=>"Get User Keys", "description"=>"Get the currently authenticated user's SSH keys", "operationId"=>"getV3UserKeys", "x-api-path-slug"=>"v3userkeys-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Keys"]}, "post"=>{"summary"=>"Post User Keys", "description"=>"Add a new SSH key to the currently authenticated user", "operationId"=>"postV3UserKeys", "x-api-path-slug"=>"v3userkeys-post", "parameters"=>[{"in"=>"formData", "name"=>"key", "description"=>"The new SSH key"}, {"in"=>"formData", "name"=>"title", "description"=>"The title of the new SSH key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Keys"]}}, "/v3/user/keys/{key_id}"=>{"get"=>{"summary"=>"Get User Keys Key", "description"=>"Get a single key owned by currently authenticated user", "operationId"=>"getV3UserKeysKeyId", "x-api-path-slug"=>"v3userkeyskey-id-get", "parameters"=>[{"in"=>"path", "name"=>"key_id", "description"=>"The ID of the SSH key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Keys", "Key"]}, "delete"=>{"summary"=>"Delete User Keys Key", "description"=>"Delete an SSH key from the currently authenticated user", "operationId"=>"deleteV3UserKeysKeyId", "x-api-path-slug"=>"v3userkeyskey-id-delete", "parameters"=>[{"in"=>"path", "name"=>"key_id", "description"=>"The ID of the SSH key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Keys", "Key"]}}, "/v3/user/emails"=>{"get"=>{"summary"=>"Get User Emails", "description"=>"Get the currently authenticated user's email addresses", "operationId"=>"getV3UserEmails", "x-api-path-slug"=>"v3useremails-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Emails"]}, "post"=>{"summary"=>"Post User Emails", "description"=>"Add new email address to the currently authenticated user", "operationId"=>"postV3UserEmails", "x-api-path-slug"=>"v3useremails-post", "parameters"=>[{"in"=>"formData", "name"=>"email", "description"=>"The new email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Emails"]}}, "/v3/user/emails/{email_id}"=>{"get"=>{"summary"=>"Get User Emails Email", "description"=>"Get a single email address owned by the currently authenticated user", "operationId"=>"getV3UserEmailsEmailId", "x-api-path-slug"=>"v3useremailsemail-id-get", "parameters"=>[{"in"=>"path", "name"=>"email_id", "description"=>"The ID of the email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Emails", "Email"]}, "delete"=>{"summary"=>"Delete User Emails Email", "description"=>"Delete an email address from the currently authenticated user", "operationId"=>"deleteV3UserEmailsEmailId", "x-api-path-slug"=>"v3useremailsemail-id-delete", "parameters"=>[{"in"=>"path", "name"=>"email_id", "description"=>"The ID of the email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Emails", "Email"]}}, "/v3/deploy_keys"=>{"get"=>{"summary"=>"Get Deploy Keys", "description"=>"Get deploy keys.", "operationId"=>"getV3DeployKeys", "x-api-path-slug"=>"v3deploy-keys-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deploy", "Keys"]}}, "/v3/session"=>{"post"=>{"summary"=>"Post Session", "description"=>"Login to get token", "operationId"=>"postV3Session", "x-api-path-slug"=>"v3session-post", "parameters"=>[{"in"=>"formData", "name"=>"email", "description"=>"The email of the user"}, {"in"=>"formData", "name"=>"login", "description"=>"The username"}, {"in"=>"formData", "name"=>"password", "description"=>"The password of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session"]}}, "/v3/application/settings"=>{"get"=>{"summary"=>"Get Application Settings", "description"=>"Get the current application settings", "operationId"=>"getV3ApplicationSettings", "x-api-path-slug"=>"v3applicationsettings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Settings"]}, "put"=>{"summary"=>"Put Application Settings", "description"=>"Modify application settings", "operationId"=>"putV3ApplicationSettings", "x-api-path-slug"=>"v3applicationsettings-put", "parameters"=>[{"in"=>"formData", "name"=>"admin_notification_email", "description"=>"Abuse reports will be sent to this address if it is set"}, {"in"=>"formData", "name"=>"after_sign_out_path", "description"=>"We will redirect users to this page after they sign out"}, {"in"=>"formData", "name"=>"after_sign_up_text", "description"=>"Text shown after sign up"}, {"in"=>"formData", "name"=>"akismet_api_key", "description"=>"Generate API key at http://www"}, {"in"=>"formData", "name"=>"akismet_enabled", "description"=>"Helps prevent bots from creating issues"}, {"in"=>"formData", "name"=>"container_registry_token_expire_delay", "description"=>"Authorization token duration (minutes)"}, {"in"=>"formData", "name"=>"default_branch_protection", "description"=>"Determine if developers can push to master"}, {"in"=>"formData", "name"=>"default_group_visibility", "description"=>"The default group visibility"}, {"in"=>"formData", "name"=>"default_projects_limit", "description"=>"The maximum number of personal projects"}, {"in"=>"formData", "name"=>"default_project_visibility", "description"=>"The default project visibility"}, {"in"=>"formData", "name"=>"default_snippet_visibility", "description"=>"The default snippet visibility"}, {"in"=>"formData", "name"=>"disabled_oauth_sign_in_sources", "description"=>"Disable certain OAuth sign-in sources"}, {"in"=>"formData", "name"=>"domain_blacklist", "description"=>"Users with e-mail addresses that match these domain(s) will NOT be able to sign-up"}, {"in"=>"formData", "name"=>"domain_blacklist_enabled", "description"=>"Enable domain blacklist for sign ups"}, {"in"=>"formData", "name"=>"domain_whitelist", "description"=>"ONLY users with e-mail addresses that match these domain(s) will be able to sign-up"}, {"in"=>"formData", "name"=>"email_author_in_body", "description"=>"Some email servers do not support overriding the email sender name"}, {"in"=>"formData", "name"=>"enabled_git_access_protocol", "description"=>"Allow only the selected protocols to be used for Git access"}, {"in"=>"formData", "name"=>"gravatar_enabled", "description"=>"Flag indicating if the Gravatar service is enabled"}, {"in"=>"formData", "name"=>"help_page_text", "description"=>"Custom text displayed on the help page"}, {"in"=>"formData", "name"=>"home_page_url", "description"=>"We will redirect non-logged in users to this page"}, {"in"=>"formData", "name"=>"housekeeping_bitmaps_enabled", "description"=>"Creating pack file bitmaps makes housekeeping take a little longer but bitmaps should accelerate git clone performance"}, {"in"=>"formData", "name"=>"housekeeping_enabled", "description"=>"Enable automatic repository housekeeping (git repack, git gc)"}, {"in"=>"formData", "name"=>"housekeeping_full_repack_period", "description"=>"Number of Git pushes after which a full git repack is run"}, {"in"=>"formData", "name"=>"housekeeping_gc_period", "description"=>"Number of Git pushes after which git gc is run"}, {"in"=>"formData", "name"=>"housekeeping_incremental_repack_period", "description"=>"Number of Git pushes after which an incremental git repack is run"}, {"in"=>"formData", "name"=>"html_emails_enabled", "description"=>"By default GitLab sends emails in HTML and plain text formats so mail clients can choose what format to use"}, {"in"=>"formData", "name"=>"import_sources", "description"=>"Enabled sources for code import during project creation"}, {"in"=>"formData", "name"=>"koding_enabled", "description"=>"Enable Koding"}, {"in"=>"formData", "name"=>"koding_url", "description"=>"The Koding team URL"}, {"in"=>"formData", "name"=>"max_artifacts_size", "description"=>"Set the maximum file size each builds artifacts can have"}, {"in"=>"formData", "name"=>"max_attachment_size", "description"=>"Maximum attachment size in MB"}, {"in"=>"formData", "name"=>"metrics_enabled", "description"=>"Enable the InfluxDB metrics"}, {"in"=>"formData", "name"=>"metrics_host", "description"=>"The InfluxDB host"}, {"in"=>"formData", "name"=>"metrics_method_call_threshold", "description"=>"A method call is only tracked when it takes longer to complete than the given amount of milliseconds"}, {"in"=>"formData", "name"=>"metrics_packet_size", "description"=>"The amount of points to store in a single UDP packet"}, {"in"=>"formData", "name"=>"metrics_pool_size", "description"=>"The amount of InfluxDB connections to open"}, {"in"=>"formData", "name"=>"metrics_port", "description"=>"The UDP port to use for connecting to InfluxDB"}, {"in"=>"formData", "name"=>"metrics_sample_interval", "description"=>"The sampling interval in seconds"}, {"in"=>"formData", "name"=>"metrics_timeout", "description"=>"The amount of seconds after which an InfluxDB connection will time out"}, {"in"=>"formData", "name"=>"plantuml_enabled", "description"=>"Enable PlantUML"}, {"in"=>"formData", "name"=>"plantuml_url", "description"=>"The PlantUML server URL"}, {"in"=>"formData", "name"=>"recaptcha_enabled", "description"=>"Helps prevent bots from creating accounts"}, {"in"=>"formData", "name"=>"recaptcha_private_key", "description"=>"Generate private key at http://www"}, {"in"=>"formData", "name"=>"recaptcha_site_key", "description"=>"Generate site key at http://www"}, {"in"=>"formData", "name"=>"repository_checks_enabled", "description"=>"GitLab will periodically run git fsck in all project and wiki repositories to look for silent disk corruption issues"}, {"in"=>"formData", "name"=>"repository_storage", "description"=>"Storage paths for new projects"}, {"in"=>"formData", "name"=>"require_two_factor_authentication", "description"=>"Require all users to setup Two-factor authentication"}, {"in"=>"formData", "name"=>"restricted_visibility_levels", "description"=>"Selected levels cannot be used by non-admin users for projects or snippets"}, {"in"=>"formData", "name"=>"send_user_confirmation_email", "description"=>"Send confirmation email on sign-up"}, {"in"=>"formData", "name"=>"sentry_dsn", "description"=>"Sentry Data Source Name"}, {"in"=>"formData", "name"=>"sentry_enabled", "description"=>"Sentry is an error reporting and logging tool which is currently not shipped with GitLab, get it here: https://getsentry"}, {"in"=>"formData", "name"=>"session_expire_delay", "description"=>"Session duration in minutes"}, {"in"=>"formData", "name"=>"shared_runners_enabled", "description"=>"Enable shared runners for new projects"}, {"in"=>"formData", "name"=>"shared_runners_text", "description"=>"Shared runners text"}, {"in"=>"formData", "name"=>"sidekiq_throttling_enabled", "description"=>"Enable Sidekiq Job Throttling"}, {"in"=>"formData", "name"=>"sidekiq_throttling_factor", "description"=>"The factor by which the queues should be throttled"}, {"in"=>"formData", "name"=>"sidekiq_throttling_queus", "description"=>"Choose which queues you wish to throttle"}, {"in"=>"formData", "name"=>"signin_enabled", "description"=>"Flag indicating if sign in is enabled"}, {"in"=>"formData", "name"=>"signup_enabled", "description"=>"Flag indicating if sign up is enabled"}, {"in"=>"formData", "name"=>"sign_in_text", "description"=>"The sign in text of the GitLab application"}, {"in"=>"formData", "name"=>"two_factor_grace_period", "description"=>"Amount of time (in hours) that users are allowed to skip forced configuration of two-factor authentication"}, {"in"=>"formData", "name"=>"user_default_external", "description"=>"Newly registered users will by default be external"}, {"in"=>"formData", "name"=>"user_oauth_applications", "description"=>"Allow users to register any application to use GitLab as an OAuth provider"}, {"in"=>"formData", "name"=>"version_check_enabled", "description"=>"Let GitLab inform you when an update is available"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Settings"]}}, "/v3/sidekiq/queue_metrics"=>{"get"=>{"summary"=>"Get Sekiq Queue Metrics", "description"=>"Get the Sidekiq queue metrics", "operationId"=>"getV3SidekiqQueueMetrics", "x-api-path-slug"=>"v3sidekiqqueue-metrics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sekiq", "Queue", "Metrics"]}}, "/v3/sidekiq/process_metrics"=>{"get"=>{"summary"=>"Get Sekiq Process Metrics", "description"=>"Get the Sidekiq process metrics", "operationId"=>"getV3SidekiqProcessMetrics", "x-api-path-slug"=>"v3sidekiqprocess-metrics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sekiq", "Process", "Metrics"]}}, "/v3/sidekiq/job_stats"=>{"get"=>{"summary"=>"Get Sekiq Job Stats", "description"=>"Get the Sidekiq job statistics", "operationId"=>"getV3SidekiqJobStats", "x-api-path-slug"=>"v3sidekiqjob-stats-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sekiq", "Job", "Stats"]}}, "/v3/sidekiq/compound_metrics"=>{"get"=>{"summary"=>"Get Sekiq Compound Metrics", "description"=>"Get the Sidekiq Compound metrics. Includes queue, process, and job statistics", "operationId"=>"getV3SidekiqCompoundMetrics", "x-api-path-slug"=>"v3sidekiqcompound-metrics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sekiq", "Compound", "Metrics"]}}, "/v3/licenses"=>{"get"=>{"summary"=>"Get Licenses", "description"=>"This feature was introduced in GitLab 8.7. This endpoint is deprecated and will be removed in GitLab 9.0.", "operationId"=>"getV3Licenses", "x-api-path-slug"=>"v3licenses-get", "parameters"=>[{"in"=>"query", "name"=>"popular", "description"=>"If passed, returns only popular licenses"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licenses"]}}, "/v3/licenses/{name}"=>{"get"=>{"summary"=>"Get Licenses Name", "description"=>"This feature was introduced in GitLab 8.7. This endpoint is deprecated and will be removed in GitLab 9.0.", "operationId"=>"getV3LicensesName", "x-api-path-slug"=>"v3licensesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the template"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licenses", "Name"]}}, "/v3/templates/licenses"=>{"get"=>{"summary"=>"Get Templates Licenses", "description"=>"This feature was introduced in GitLab 8.7.", "operationId"=>"getV3TemplatesLicenses", "x-api-path-slug"=>"v3templateslicenses-get", "parameters"=>[{"in"=>"query", "name"=>"popular", "description"=>"If passed, returns only popular licenses"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates", "Licenses"]}}, "/v3/templates/licenses/{name}"=>{"get"=>{"summary"=>"Get Templates Licenses Name", "description"=>"This feature was introduced in GitLab 8.7.", "operationId"=>"getV3TemplatesLicensesName", "x-api-path-slug"=>"v3templateslicensesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the template"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates", "Licenses", "Name"]}}, "/v3/templates/gitignores"=>{"get"=>{"summary"=>"Get Templates Gitignores", "description"=>"This feature was introduced in GitLab 8.8.", "operationId"=>"getV3TemplatesGitignores", "x-api-path-slug"=>"v3templatesgitignores-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates", "Gitignores"]}}, "/v3/templates/gitignores/{name}"=>{"get"=>{"summary"=>"Get Templates Gitignores Name", "description"=>"This feature was introduced in GitLab 8.8.", "operationId"=>"getV3TemplatesGitignoresName", "x-api-path-slug"=>"v3templatesgitignoresname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the template"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates", "Gitignores", "Name"]}}, "/v3/templates/gitlab_ci_ymls"=>{"get"=>{"summary"=>"Get Templates Gitlab Ci Ymls", "description"=>"This feature was introduced in GitLab 8.9.", "operationId"=>"getV3TemplatesGitlabCiYmls", "x-api-path-slug"=>"v3templatesgitlab-ci-ymls-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates", "Gitlab", "Ci", "Ymls"]}}, "/v3/templates/gitlab_ci_ymls/{name}"=>{"get"=>{"summary"=>"Get Templates Gitlab Ci Ymls Name", "description"=>"This feature was introduced in GitLab 8.9.", "operationId"=>"getV3TemplatesGitlabCiYmlsName", "x-api-path-slug"=>"v3templatesgitlab-ci-ymlsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the template"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates", "Gitlab", "Ci", "Ymls", "Name"]}}, "/v3/templates/dockerfiles"=>{"get"=>{"summary"=>"Get Templates Dockerfiles", "description"=>"This feature was introduced in GitLab 8.15.", "operationId"=>"getV3TemplatesDockerfiles", "x-api-path-slug"=>"v3templatesdockerfiles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates", "Dockerfiles"]}}, "/v3/templates/dockerfiles/{name}"=>{"get"=>{"summary"=>"Get Templates Dockerfiles Name", "description"=>"This feature was introduced in GitLab 8.15.", "operationId"=>"getV3TemplatesDockerfilesName", "x-api-path-slug"=>"v3templatesdockerfilesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the template"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates", "Dockerfiles", "Name"]}}, "/v3/gitignores"=>{"get"=>{"summary"=>"Get Gitignores", "description"=>"This feature was introduced in GitLab 8.8. This endpoint is deprecated and will be removed in GitLab 9.0.", "operationId"=>"getV3Gitignores", "x-api-path-slug"=>"v3gitignores-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gitignores"]}}, "/v3/gitignores/{name}"=>{"get"=>{"summary"=>"Get Gitignores Name", "description"=>"This feature was introduced in GitLab 8.8. This endpoint is deprecated and will be removed in GitLab 9.0.", "operationId"=>"getV3GitignoresName", "x-api-path-slug"=>"v3gitignoresname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the template"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gitignores", "Name"]}}, "/v3/gitlab_ci_ymls"=>{"get"=>{"summary"=>"Get Gitlab Ci Ymls", "description"=>"This feature was introduced in GitLab 8.9. This endpoint is deprecated and will be removed in GitLab 9.0.", "operationId"=>"getV3GitlabCiYmls", "x-api-path-slug"=>"v3gitlab-ci-ymls-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gitlab", "Ci", "Ymls"]}}, "/v3/gitlab_ci_ymls/{name}"=>{"get"=>{"summary"=>"Get Gitlab Ci Ymls Name", "description"=>"This feature was introduced in GitLab 8.9. This endpoint is deprecated and will be removed in GitLab 9.0.", "operationId"=>"getV3GitlabCiYmlsName", "x-api-path-slug"=>"v3gitlab-ci-ymlsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the template"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gitlab", "Ci", "Ymls", "Name"]}}, "/v3/dockerfiles"=>{"get"=>{"summary"=>"Get Dockerfiles", "description"=>"This feature was introduced in GitLab 8.15. This endpoint is deprecated and will be removed in GitLab 9.0.", "operationId"=>"getV3Dockerfiles", "x-api-path-slug"=>"v3dockerfiles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dockerfiles"]}}, "/v3/dockerfiles/{name}"=>{"get"=>{"summary"=>"Get Dockerfiles Name", "description"=>"This feature was introduced in GitLab 8.15. This endpoint is deprecated and will be removed in GitLab 9.0.", "operationId"=>"getV3DockerfilesName", "x-api-path-slug"=>"v3dockerfilesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the template"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dockerfiles", "Name"]}}, "/v3/version"=>{"get"=>{"summary"=>"Get Version", "description"=>"This feature was introduced in GitLab 8.13.", "operationId"=>"getV3Version", "x-api-path-slug"=>"v3version-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
shopping-com{"shopping-com-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Shopping.com", "x-complete"=>1, "info"=>{"title"=>"Shopping.com", "description"=>"shopping-com-offers-publishers-rich-content-via-the-shopping-coms-api-", "version"=>"1.0.0"}, "host"=>"sandbox.api.shopping.com", "basePath"=>"/publisher/3.0/rest/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GeneralSearch"=>{"parameters"=>{"summary"=>"", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"generalsearch-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "get"=>{"summary"=>"", "description"=>"Searches for products by offer. See API docs for request parameters/format.", "operationId"=>"GeneralSearch.get", "x-api-path-slug"=>"generalsearch-get", "parameters"=>[{"in"=>"query", "name"=>"groupItemsByCategory", "description"=>"Control whether or not items are separated into different categories"}, {"in"=>"query", "name"=>"numFeatured", "description"=>"Set the maximum number of featured stores to include in a result containing a list of offers, when using the featured-store offer sort type"}, {"in"=>"query", "name"=>"offerSortOrder", "description"=>"Control whether results containing only offers will be sorted in ascending or descending order"}, {"in"=>"query", "name"=>"offerSortType", "description"=>"Set the method of sorting offers"}, {"in"=>"query", "name"=>"postalCode", "description"=>"Set the postal code of the current user, for tax and shipping purposes"}, {"in"=>"query", "name"=>"productReviewSortType", "description"=>"Control how to sort product reviews listings"}, {"in"=>"query", "name"=>"productReviewsSortOrder", "description"=>"Control whether product reviews listings will be sorted in ascending or descending order"}, {"in"=>"query", "name"=>"showAllMatchingCategories", "description"=>"Control whether or not this query will return all matching categories, regardless of relevance"}, {"in"=>"query", "name"=>"showSmartBuy", "description"=>"Control whether or not the lowest-price offer from a trusted store will be flagged"}, {"in"=>"query", "name"=>"subTrackingId", "description"=>"User generated ID used to further break down traffic sources beyond SDC campaign level tracking"}, {"in"=>"query", "name"=>"visitorIPAddress", "description"=>"The IP address of the visitor to which this data is being presented"}, {"in"=>"query", "name"=>"visitorUserAgent", "description"=>"The browser user-agent of the visitor to which this data is being presented"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/CategoryTree"=>{"parameters"=>{"summary"=>"", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"categorytree-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "get"=>{"summary"=>"", "description"=>"Returns information on a single category (e.g. name) or the relationship hierarchy between categories.", "operationId"=>"CategoryTree.get", "x-api-path-slug"=>"categorytree-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId", "description"=>"The ID of the category for to return information for, as well as the information for all its immediate children (if any)"}, {"in"=>"query", "name"=>"showAllDescendants", "description"=>"Specifies that information for all descendants of the specified category should be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"Shopping.com", "x-slug"=>"shopping-com", "description"=>"", "image"=>"", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"shopping-com/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Shopping.com", "x-api-slug"=>"shopping-com", "description"=>"", "image"=>"", "humanURL"=>"http://sandbox.api.shopping.com", "baseURL"=>"https://sandbox.api.shopping.com//publisher/3.0/rest/", "tags"=>"Relative Data,Service API", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/shopping-com/categorytree-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/shopping-com/shopping-com-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://sandbox.api.shopping.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
sap{"sap-translation-hub-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"SAP", "x-complete"=>1, "info"=>{"title"=>"SAP Translation Hub", "description"=>"to-provide-users-of-software-in-a-global-market-with-texts-in-their-own-language-translations-are-required--sap-translation-hub-enables-you-to-draw-on-saps-translation-experience-across-multiple-products-and-languages-to-propose-translations-for-short-texts-", "contact"=>{"name"=>"SAP Translation Hub team", "email"=>"translationhub@sap.com"}, "version"=>"1.0.0"}, "host"=>"sandbox.api.sap.com", "basePath"=>"/translationhub/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/domains"=>{"get"=>{"summary"=>"SAP product domains", "description"=>"SAP product terminology is organized by domains. Domains are used in the translation process to determine the correct terminology for a given application. This resource returns a list of the domains and domain groups that are available in SAP Translation Hub. You can combine the domain resource with the translation resource to more accurately reflect the subject area of your texts.", "operationId"=>"sap-product-terminology-is-organized-by-domains-domains-are-used-in-the-translation-process-to-deter", "x-api-path-slug"=>"domains-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies the nature of the data in the body so that the receiving agent can process the data accordingly"}, {"in"=>"query", "name"=>"onlyGroups", "description"=>"Shows a list of the domain groups that SAP Translation Hub supports"}, {"in"=>"query", "name"=>"search", "description"=>"Shows whether a particular domain is available in SAP Translation Hub"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["SAP", "Product", "Domains"]}}, "/languages"=>{"get"=>{"summary"=>"Languages that SAP Translation Hub supports.", "description"=>"Returns a list of the languages that SAP Translation Hub supports. You can also check whether a particualr language is available in SAP Translation Hub.", "operationId"=>"returns-a-list-of-the-languages-that-sap-translation-hub-supports-you-can-also-check-whether-a-parti", "x-api-path-slug"=>"languages-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies the nature of the data in the body so that the receiving agent can process the data accordingly"}, {"in"=>"query", "name"=>"search", "description"=>"Determines whether a particular language is available in SAP Translation Hub"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Languages", "That", "SAP", "Translation", "Hub", "Supports"]}}, "/suggestions"=>{"get"=>{"summary"=>"The suggestion resource enables you to get suggestions for short texts during the development process.", "description"=>"Provides suggestions for short texts based on complete or partial texts and their translations. You can, for example, use the suggestion resource to propose texts while you type texts in a development environment. The texts that the resource proposes are already available in additional languages in the multilingual text repository (MLTR).", "operationId"=>"provides-suggestions-for-short-texts-based-on-complete-or-partial-texts-and-their-translations-you-c", "x-api-path-slug"=>"suggestions-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies the nature of the data in the body so that the receiving agent can process the data accordingly"}, {"in"=>"query", "name"=>"domain", "description"=>"Searches for texts in the specified domain(s) or domain group(s)"}, {"in"=>"query", "name"=>"language", "description"=>"Allows you to search for a text that has translations in the specified language(s)"}, {"in"=>"query", "name"=>"maxLength", "description"=>"Searches for texts up to the specified number of characters"}, {"in"=>"query", "name"=>"search", "description"=>"Allows you to search for a text in SAP Translation Hub in English"}, {"in"=>"query", "name"=>"searchLanguage", "description"=>"Allows you to search for a text in any of the languages that SAP Translation Hub supports"}, {"in"=>"query", "name"=>"texttype", "description"=>"Allows you to search for a text that is assigned to one or more text types"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["The", "Suggestion", "Resource", "Enables", "You", "To", "Get", "Suggestionsshort", "Texts", "During", "Development", "Process"]}}, "/texttypes"=>{"get"=>{"summary"=>"Returns a list of the text types available in SAP Translation Hub.", "description"=>"In SAP products, short texts, such as those used on user interfaces (UIs), are characterized by various text types. The type of a specific text is determined by the UI element that it describes. For example, button texts are described by the text type ```XBUT```. The text type resource returns a list of the text types that are available in SAP Translation Hub. You can combine the '/text type' resource with the '/suggestion' resource to narrow down the results of the suggestion resource.", "operationId"=>"in-sap-products-short-texts-such-as-those-used-on-user-interfaces-uis-are-characterized-by-various-t", "x-api-path-slug"=>"texttypes-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies the nature of the data in the body so that the receiving agent can process the data accordingly"}, {"in"=>"query", "name"=>"search", "description"=>"Allows you to search for a specific text type, such as message"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Returns", "List", "Of", "Text", "Types", "Available", "In", "SAP", "Translation", "Hub"]}}, "/translate"=>{"post"=>{"summary"=>"The '/translate' resource enables you to get translations of English short texts that exist in SAP Translation Hub.", "description"=>"Provides translations of short texts based on a combination of existing texts and their translations that are used in SAP products and machine translation capabilities.", "operationId"=>"provides-translations-of-short-texts-based-on-a-combination-of-existing-texts-and-their-translations", "x-api-path-slug"=>"translate-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Specifies the nature of the data in the body so that the receiving agent can process the data accordingly"}, {"in"=>"body", "name"=>"translate", "description"=>"The JSON request contains an array of ```units``` JSON objects", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["The", "", "Translate", "Resource", "Enables", "You", "To", "Get", "Translations", "Of", "English", "Short", "Texts", "That", "Exist", "In", "SAP", "Translation", "Hub"]}}}}, "sap-manufacturing-network-partner-apis-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"SAP", "x-complete"=>1, "info"=>{"title"=>"Manufacturing Network Partner APIs", "description"=>"a-partner-api-is-used-to-retrieve-or-operate-on-the-data-of-other-organizations--the-client-oauth-2-0-client-making-api-requests-require-explicit-authorization-from-these-organizations-to-make-an-api-request-you-need-to-get-an-access-token-using-your-oauth-2-0-client-credentials--for-more-information-see-make-an-api-requesthttpshelp-sap-comviewerdmcmndevguide15b2822c62d9489c8e47034665eadda7-html-please-be-aware-that-the-version-of-most-apis-is-v1-but-the-version-of-the-documents-apis-is-v2-", "version"=>"1.0.0"}, "host"=>"hostname", "basePath"=>"/dim/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/callback"=>{"post"=>{"summary"=>"Sends a callback message", "description"=>"Upon the receipt of an event, send a response in an async way to the event framework of Manufacturing Network.\n\nIn the callback message, be sure to include the event ID. Add other information as appropriate.", "operationId"=>"upon-the-receipt-of-an-event-send-a-response-in-an-async-way-to-the-event-framework-of-manufacturing", "x-api-path-slug"=>"callback-post", "parameters"=>[{"in"=>"body", "name"=>"Callback", "description"=>"A callback message", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sends", "Callback", "Message"]}}, "/collaborationRooms/{collaborationRoomId}"=>{"get"=>{"summary"=>"Retrieves a collaboration room", "description"=>"Retrieves the information of a collaboration room by its ID.", "operationId"=>"retrieves-the-information-of-a-collaboration-room-by-its-id", "x-api-path-slug"=>"collaborationroomscollaborationroomid-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Collaboration", "Room"]}}, "/collaborationRooms/{collaborationRoomId}/basic"=>{"get"=>{"summary"=>"Retrieves basic info of a collaboration room", "description"=>"Retrieves the information of a collaboration room in a simplified form.", "operationId"=>"retrieves-the-information-of-a-collaboration-room-in-a-simplified-form", "x-api-path-slug"=>"collaborationroomscollaborationroomidbasic-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Basic", "Info", "Of", "Collaboration", "Room"]}}, "/collaborationRooms/{collaborationRoomId}/documents"=>{"get"=>{"summary"=>"Retrieves documents in a collaboration room", "description"=>"Retrieves the information of all documents in a collaboration room, such as design files and specifications.", "operationId"=>"retrieves-the-information-of-all-documents-in-a-collaboration-room-such-as-design-files-and-specific", "x-api-path-slug"=>"collaborationroomscollaborationroomiddocuments-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Documents", "In", "Collaboration", "Room"]}}, "/collaborationRooms/{collaborationRoomId}/documents/{fileId}"=>{"get"=>{"summary"=>"Retrieves a document", "description"=>"Retrieves the information of a document by its ID.", "operationId"=>"retrieves-the-information-of-a-document-by-its-id", "x-api-path-slug"=>"collaborationroomscollaborationroomiddocumentsfileid-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of a file"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Document"]}, "delete"=>{"summary"=>"Deletes a document", "description"=>"Deletes a document. \nThe login technical user must be the one who uploaded the document.", "operationId"=>"deletes-a-document--the-login-technical-user-must-be-the-one-who-uploaded-the-document", "x-api-path-slug"=>"collaborationroomscollaborationroomiddocumentsfileid-delete", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of a file"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Document"]}}, "/collaborationRooms/{collaborationRoomId}/productionData"=>{"get"=>{"summary"=>"Retrieves the production data", "description"=>"Retrieves the production data in a collaboration room, including the currency, all the production options, and the initial pricings provided by the supplier.", "operationId"=>"retrieves-the-production-data-in-a-collaboration-room-including-the-currency-all-the-production-opti", "x-api-path-slug"=>"collaborationroomscollaborationroomidproductiondata-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Production", "Data"]}}, "/documents/collaborationRooms/{collaborationRoomId}/download"=>{"get"=>{"summary"=>"Downloads a file", "description"=>"Downloads a file from a collaboration room.", "operationId"=>"downloads-a-file-from-a-collaboration-room", "x-api-path-slug"=>"documentscollaborationroomscollaborationroomiddownload-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"query", "name"=>"fileId", "description"=>"The ID of a file"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Downloads", "File"]}}, "/documents/collaborationRooms/{collaborationRoomId}/upload"=>{"post"=>{"summary"=>"Uploads a file", "description"=>"Uploads a file to a collaboration room.", "operationId"=>"uploads-a-file-to-a-collaboration-room", "x-api-path-slug"=>"documentscollaborationroomscollaborationroomidupload-post", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"formData", "name"=>"fileUpload", "description"=>"A file to be uploaded"}, {"in"=>"formData", "name"=>"originFileDisplay", "description"=>"Indicates if a file is visible to all participants in the collaboration room (public) or to the uploader only (private)"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Uploads", "File"]}}, "/documents/collaborationRooms/{collaborationRoomId}/thumbnail/download"=>{"get"=>{"summary"=>"Downloads the thumbnail of a design file", "description"=>"Downloads the thumbnail selected as the icon for a collaboration room.", "operationId"=>"downloads-the-thumbnail-selected-as-the-icon-for-a-collaboration-room", "x-api-path-slug"=>"documentscollaborationroomscollaborationroomidthumbnaildownload-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Downloads", "Thumbnail", "Of", "Design", "File"]}}, "/extensions"=>{"get"=>{"summary"=>"Retrieves all extensions", "description"=>"Retrieves all the extensions that have been registered with Manufacturing Network. \nThese extensions are developed by Manufacturing Network customers or partners to enhance the functionality of the application.", "operationId"=>"retrieves-all-the-extensions-that-have-been-registered-with-manufacturing-network--these-extensions-", "x-api-path-slug"=>"extensions-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "", "Extensions"]}}, "/organizations/{organizationId}"=>{"get"=>{"summary"=>"Retrieves an organization", "description"=>"Retrieves an organization by its ID.", "operationId"=>"retrieves-an-organization-by-its-id", "x-api-path-slug"=>"organizationsorganizationid-get", "parameters"=>[{"in"=>"path", "name"=>"organizationId", "description"=>"The ID of an organization"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Organization"]}}, "/organizations/{organizationId}/collaborationRooms"=>{"get"=>{"summary"=>"Retrieves the collaboration rooms of an organization", "description"=>"Retrieves the collaboration rooms where an organization is a collaboration party.", "operationId"=>"retrieves-the-collaboration-rooms-where-an-organization-is-a-collaboration-party---", "x-api-path-slug"=>"organizationsorganizationidcollaborationrooms-get", "parameters"=>[{"in"=>"path", "name"=>"organizationId", "description"=>"The ID of an organization"}, {"in"=>"query", "name"=>"organizationIds", "description"=>"The IDs of other organizations"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Collaboration", "Rooms", "Of", "Organization"]}}, "/organizations/{organizationId}/collaborationRooms/owned"=>{"get"=>{"summary"=>"Retrieves the collaboration rooms created by an organization", "description"=>"Retrieves the collaboration rooms created and owned by an organization.", "operationId"=>"retrieves-the-collaboration-rooms-created-and-owned-by-an-organization--", "x-api-path-slug"=>"organizationsorganizationidcollaborationroomsowned-get", "parameters"=>[{"in"=>"path", "name"=>"organizationId", "description"=>"The ID of the owner organization"}, {"in"=>"query", "name"=>"organizationIds", "description"=>"The IDs of other organizations"}, {"in"=>"query", "name"=>"partId", "description"=>"The ID of a part"}, {"in"=>"query", "name"=>"serviceType", "description"=>"The type of service that a supplier organization provides during the collaboration"}, {"in"=>"query", "name"=>"status", "description"=>"The status of a collaboration"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Collaboration", "Rooms", "Created", "By", "Organization"]}}, "/partsAnalysis/worklists/{worklistId}"=>{"get"=>{"summary"=>"Retrieves a parts analysis worklist", "description"=>"Retrieves a parts analysis worklist. \nThe analysis is made to identify parts that are suitable for additive manufacturing.", "operationId"=>"retrieves-a-parts-analysis-worklist--the-analysis-is-made-to-identify-parts-that-are-suitable-for-ad", "x-api-path-slug"=>"partsanalysisworklistsworklistid-get", "parameters"=>[{"in"=>"query", "name"=>"$format", "description"=>"Specifies the response format"}, {"in"=>"path", "name"=>"worklistId", "description"=>"The UUID for a published worklist"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Parts", "Analysis", "Worklist"]}}, "/partsAnalysis/worklists/{worklistId}/parts/{partId}"=>{"put"=>{"summary"=>"Updates a part", "description"=>"Updates a part in a worklist", "operationId"=>"updates-a-part-in-a-worklist", "x-api-path-slug"=>"partsanalysisworklistsworklistidpartspartid-put", "parameters"=>[{"in"=>"path", "name"=>"partId", "description"=>"A self-generated ID for a part in the worklist"}, {"in"=>"body", "name"=>"PartsAnalysisUpdateDTO", "description"=>"A request about updating a parts analysis worklist", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"worklistId", "description"=>"The UUID for a published worklist"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Part"]}}, "/partsAnalysis/worklists/{worklistId}/parts/{partId}/designFiles/{designFileId}"=>{"get"=>{"summary"=>"Downloads the design file of a part", "description"=>"Downloads the design file for a part", "operationId"=>"downloads-the-design-file-for-a-part", "x-api-path-slug"=>"partsanalysisworklistsworklistidpartspartiddesignfilesdesignfileid-get", "parameters"=>[{"in"=>"path", "name"=>"designFileId", "description"=>"A self-generated ID for a design file"}, {"in"=>"path", "name"=>"partId", "description"=>"A self-generated ID for a part in the worklist"}, {"in"=>"path", "name"=>"worklistId", "description"=>"The UUID for a published worklist"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Downloads", "Design", "File", "Of", "Part"]}}}}, "sap-manufacturing-network-customer-apis-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"SAP", "x-complete"=>1, "info"=>{"title"=>"Manufacturing Network Customer APIs", "description"=>"a-customer-api-is-used-to-retrieve-the-data-of-ones-own-organization--the-client-making-api-requests-also-needs-to-be-registered-with-your-organization-but-doesnt-require-special-approval-or-authorization-to-make-an-api-request-you-need-to-get-an-access-token-using-your-oauth-2-0-client-credentials--for-more-information-see-make-an-api-requesthttpshelp-sap-comviewerdmcmndevguide15b2822c62d9489c8e47034665eadda7-html-please-be-aware-that-the-version-of-most-apis-is-v1-but-the-version-of-the-documents-apis-is-v2-", "version"=>"1.0.0"}, "host"=>"hostname", "basePath"=>"/dim/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/callback"=>{"post"=>{"summary"=>"Sends a callback message", "description"=>"Upon the receipt of an event, send a response in an async way to the event framework of Manufacturing Network.\n\nIn the callback message, be sure to include the event ID. Add other information as appropriate.", "operationId"=>"upon-the-receipt-of-an-event-send-a-response-in-an-async-way-to-the-event-framework-of-manufacturing", "x-api-path-slug"=>"callback-post", "parameters"=>[{"in"=>"body", "name"=>"Callback", "description"=>"A callback message", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sends", "Callback", "Message"]}}, "/collaborationRooms"=>{"post"=>{"summary"=>"Creates a collaboration room", "description"=>"Creates a collaboration room. \nThe login user must be from a customer.", "operationId"=>"creates-a-collaboration-room--the-login-user-must-be-from-a-customer", "x-api-path-slug"=>"collaborationrooms-post", "parameters"=>[{"in"=>"body", "name"=>"CollaborationRoomCreateRequest", "description"=>"A request about creating a collaboration room", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Creates", "Collaboration", "Room"]}}, "/collaborationRooms/{collaborationRoomId}"=>{"get"=>{"summary"=>"Retrieves a collaboration room", "description"=>"Retrieves the information of a collaboration room by its ID.", "operationId"=>"retrieves-the-information-of-a-collaboration-room-by-its-id", "x-api-path-slug"=>"collaborationroomscollaborationroomid-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Collaboration", "Room"]}, "patch"=>{"summary"=>"Updates a collaboration room", "description"=>"Updates a collaboration room.", "operationId"=>"updates-a-collaboration-room", "x-api-path-slug"=>"collaborationroomscollaborationroomid-patch", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"body", "name"=>"CollaborationRoomUpdateRequest", "description"=>"A request about updating a collaboration room", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Collaboration", "Room"]}, "delete"=>{"summary"=>"Deletes a collaboration room", "description"=>"Deletes a collaboration room\nThe login user must be a collaboration lead for the customer and it must be a new or discarded collaboration.", "operationId"=>"deletes-a-collaboration-roomthe-login-user-must-be-a-collaboration-lead-for-the-customer-and-it-must", "x-api-path-slug"=>"collaborationroomscollaborationroomid-delete", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Collaboration", "Room"]}}, "/collaborationRooms/{collaborationRoomId}/basic"=>{"get"=>{"summary"=>"Retrieves basic info of a collaboration room", "description"=>"Retrieves the information of a collaboration room in a simplified form.", "operationId"=>"retrieves-the-information-of-a-collaboration-room-in-a-simplified-form", "x-api-path-slug"=>"collaborationroomscollaborationroomidbasic-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Basic", "Info", "Of", "Collaboration", "Room"]}}, "/collaborationRooms/{collaborationRoomId}/start"=>{"post"=>{"summary"=>"Starts a collaboration", "description"=>"Sets a collaboration in process. \nThe collaboration must be a new collaboration.", "operationId"=>"sets-a-collaboration-in-process--the-collaboration-must-be-a-new-collaboration", "x-api-path-slug"=>"collaborationroomscollaborationroomidstart-post", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Starts", "Collaboration"]}}, "/collaborationRooms/{collaborationRoomId}/complete"=>{"post"=>{"summary"=>"Completes a collaboration", "description"=>"Sets a collaboration as completed\n- The login user must be a collaboration lead for the customer.\n- If there's already a supplier in the collaboration room, the collaboration must already or still be in process.\n- If there's already a completed collaboration with the same additive manufacturing supplier, part ID, and customer, this operation fails.", "operationId"=>"sets-a-collaboration-as-completed-the-login-user-must-be-a-collaboration-lead-for-the-customer-if-th", "x-api-path-slug"=>"collaborationroomscollaborationroomidcomplete-post", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Completes", "Collaboration"]}}, "/collaborationRooms/{collaborationRoomId}/discard"=>{"post"=>{"summary"=>"Discards a collaboration", "description"=>"Sets a collaboration as discarded. \nThe login user must be a collaboration lead for the customer and the collaboration must be in process or completed.", "operationId"=>"sets-a-collaboration-as-discarded--the-login-user-must-be-a-collaboration-lead-for-the-customer-and-", "x-api-path-slug"=>"collaborationroomscollaborationroomiddiscard-post", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Discards", "Collaboration"]}}, "/collaborationRooms/{collaborationRoomId}/reopen"=>{"post"=>{"summary"=>"Reopens a collaboration", "description"=>"Reopens a completed collaboration. \nThe collaboration is set back to the status 'In Process'.\nThe login user must be a collaboration lead for the customer.", "operationId"=>"reopens-a-completed-collaboration--the-collaboration-is-set-back-to-the-status-in-processthe-login-u", "x-api-path-slug"=>"collaborationroomscollaborationroomidreopen-post", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Reopens", "Collaboration"]}}, "/collaborationRooms/{collaborationRoomId}/documents"=>{"get"=>{"summary"=>"Retrieves documents in a collaboration room", "description"=>"Retrieves the information of all documents in a collaboration room, such as design files and specifications.", "operationId"=>"retrieves-the-information-of-all-documents-in-a-collaboration-room-such-as-design-files-and-specific", "x-api-path-slug"=>"collaborationroomscollaborationroomiddocuments-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Documents", "In", "Collaboration", "Room"]}}, "/collaborationRooms/{collaborationRoomId}/documents/{fileId}"=>{"get"=>{"summary"=>"Retrieves a document", "description"=>"Retrieves the information of a document by its ID.", "operationId"=>"retrieves-the-information-of-a-document-by-its-id", "x-api-path-slug"=>"collaborationroomscollaborationroomiddocumentsfileid-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of a file"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Document"]}, "delete"=>{"summary"=>"Deletes a document", "description"=>"Deletes a document. \nThe login user must be the one who uploaded the file.", "operationId"=>"deletes-a-document--the-login-user-must-be-the-one-who-uploaded-the-file", "x-api-path-slug"=>"collaborationroomscollaborationroomiddocumentsfileid-delete", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of a file"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Document"]}}, "/collaborationRooms/{collaborationRoomId}/documents/{fileId}/conversion"=>{"get"=>{"summary"=>"Gets conversion info of a design file", "description"=>"Retrieves the information of the conversion event for a design file.\nA conversion event converts a design file into a VDS file. \nSee a full list of supported formats in the [online help](https://help.sap.com/viewer/dmc-mn-app-help-customer/710ee60457ca457cbda854c363bcf71f.html).", "operationId"=>"retrieves-the-information-of-the-conversion-event-for-a-design-filea-conversion-event-converts-a-des", "x-api-path-slug"=>"collaborationroomscollaborationroomiddocumentsfileidconversion-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of a file"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Conversion", "Info", "Of", "Design", "File"]}, "post"=>{"summary"=>"Converts a design file", "description"=>"Invokes a conversion event that converts a design file into a VDS file.\n\nSee a full list of supported formats in the [online help](https://help.sap.com/viewer/dmc-mn-app-help-customer/710ee60457ca457cbda854c363bcf71f.html).", "operationId"=>"invokes-a-conversion-event-that-converts-a-design-file-into-a-vds-filesee-a-full-list-of-supported-f", "x-api-path-slug"=>"collaborationroomscollaborationroomiddocumentsfileidconversion-post", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of a file"}, {"in"=>"header", "name"=>"Prefer", "description"=>"Sets the conversion event to run asynchronously"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Converts", "Design", "File"]}}, "/collaborationRooms/{collaborationRoomId}/productionData"=>{"get"=>{"summary"=>"Retrieves the production data", "description"=>"Retrieves the production data in a collaboration room, including the currency, all the production options, and the initial pricings provided by the supplier.", "operationId"=>"retrieves-the-production-data-in-a-collaboration-room-including-the-currency-all-the-production-opti", "x-api-path-slug"=>"collaborationroomscollaborationroomidproductiondata-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Production", "Data"]}, "post"=>{"summary"=>"Creates a production option", "description"=>"Creates a new production option, providing the pricing information in the meantime. \nThe login user must be a collaboration lead from the additive manufacturing supplier.", "operationId"=>"creates-a-new-production-option-providing-the-pricing-information-in-the-meantime--the-login-user-mu", "x-api-path-slug"=>"collaborationroomscollaborationroomidproductiondata-post", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"body", "name"=>"ProductionDataCreateRequest", "description"=>"A request about creating a production option", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Creates", "Production", "Option"]}}, "/collaborationRooms/{collaborationRoomId}/productionData/basic"=>{"post"=>{"summary"=>"Creates a production option without pricing", "description"=>"Creates a new production option without an initial pricing. \nThis endpoint is used by users from the additive manufactuirng supplier that're not collaboration leads.", "operationId"=>"creates-a-new-production-option-without-an-initial-pricing--this-endpoint-is-used-by-users-from-the-", "x-api-path-slug"=>"collaborationroomscollaborationroomidproductiondatabasic-post", "parameters"=>[{"in"=>"body", "name"=>"AdditionalProductionDataBasicCreateRequest", "description"=>"A request about creating a production option without pricing", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Creates", "Production", "Option", "Without", "Pricing"]}}, "/collaborationRooms/{collaborationRoomId}/productionData/original/pricing"=>{"put"=>{"summary"=>"Updates the pricing", "description"=>"Updates the initial pricing for the customer's production option. \nThe login user must be a collaboration lead from an additive manufacturing supplier. \nNote: The planned quantity is defined by the customer and not available for update by the supplier.", "operationId"=>"updates-the-initial-pricing-for-the-customers-production-option--the-login-user-must-be-a-collaborat", "x-api-path-slug"=>"collaborationroomscollaborationroomidproductiondataoriginalpricing-put", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"body", "name"=>"ProductionDataPricingRequest", "description"=>"A request about updating the pricing of a production option", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Pricing"]}}, "/collaborationRooms/{collaborationRoomId}/productionData/original/requirement"=>{"put"=>{"summary"=>"Updates the customer's production option", "description"=>"Updates the customer's production option. \nThe login user must be from the customer.", "operationId"=>"updates-the-customers-production-option---the-login-user-must-be-from-the-customer", "x-api-path-slug"=>"collaborationroomscollaborationroomidproductiondataoriginalrequirement-put", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"body", "name"=>"ProductionDataRequirementRequest", "description"=>"A request about a production option", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Customers", "Production", "Option"]}}, "/collaborationRooms/{collaborationRoomId}/productionData/{productionDataId}"=>{"put"=>{"summary"=>"Updates a supplier's production option", "description"=>"Updates a production option proposed by the additive manufacturing supplier as well as the initial pricing for this option. \nThe login user must be a collaboration lead from the additive manufacturing supplier.", "operationId"=>"updates-a-production-option-proposed-by-the-additive-manufacturing-supplier-as-well-as-the-initial-p", "x-api-path-slug"=>"collaborationroomscollaborationroomidproductiondataproductiondataid-put", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"path", "name"=>"productionDataId", "description"=>"The ID of a production option"}, {"in"=>"body", "name"=>"ProductionDataUpdateRequest", "description"=>"A request about updating a production option", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Suppliers", "Production", "Option"]}, "delete"=>{"summary"=>"Deletes a supplier's production option", "description"=>"Deletes a production option proposed by the additive manufacturing supplier. The initial pricing is deleted along with it. \nThe login user must be from the additive manufacturing supplier.", "operationId"=>"deletes-a-production-option-proposed-by-the-additive-manufacturing-supplier-the-initial-pricing-is-d", "x-api-path-slug"=>"collaborationroomscollaborationroomidproductiondataproductiondataid-delete", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"path", "name"=>"productionDataId", "description"=>"The ID of a production option"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Suppliers", "Production", "Option"]}}, "/collaborationRooms/{collaborationRoomId}/productionData/{productionDataId}/basic"=>{"put"=>{"summary"=>"Updates a supplier's production option", "description"=>"Updates a production option proposed by the additive manufacturing supplier. \nThis endpoint is used by users from the additive manufactuirng supplier that're not collaboration leads. The initial pricing cannot be updated.", "operationId"=>"updates-a-production-option-proposed-by-the-additive-manufacturing-supplier----this-endpoint-is-used", "x-api-path-slug"=>"collaborationroomscollaborationroomidproductiondataproductiondataidbasic-put", "parameters"=>[{"in"=>"body", "name"=>"AdditionalProductionDataBasicUpdateRequest", "description"=>"A request about updating a suppliers production option, excluding pricing information", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"path", "name"=>"productionDataId", "description"=>"The ID of a production option"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Suppliers", "Production", "Option"]}}, "/collaborationRooms/{collaborationRoomId}/productionData/confirmed"=>{"get"=>{"summary"=>"Retrieves the confirmed production option", "description"=>"Retrieves the production option confirmed as the finalized production requirements, and the initial pricing for it.", "operationId"=>"retrieves-the-production-option-confirmed-as-the-finalized-production-requirements-and-the-initial-p", "x-api-path-slug"=>"collaborationroomscollaborationroomidproductiondataconfirmed-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Confirmed", "Production", "Option"]}}, "/collaborationRooms/{collaborationRoomId}/productionData/{productionDataId}/confirm"=>{"post"=>{"summary"=>"Confirms a production option", "description"=>"Confirms a production option along with the initial pricing for it. \nThe production option might be proposed by the customer or the additive manufacturing supplier. \nThe login user must be from the customer.", "operationId"=>"confirms-a-production-option-along-with-the-initial-pricing-for-it--the-production-option-might-be-p", "x-api-path-slug"=>"collaborationroomscollaborationroomidproductiondataproductiondataidconfirm-post", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"path", "name"=>"productionDataId", "description"=>"The ID of a production option"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Confirms", "Production", "Option"]}}, "/collaborationRooms/{collaborationRoomId}/productionData/{productionDataId}/cancelConfirm"=>{"post"=>{"summary"=>"Cancels the confirmation of a production option", "description"=>"Undos the confirmation of a production option. \nThe login user must be from the customer.", "operationId"=>"undos-the-confirmation-of-a-production-option--the-login-user-must-be-from-the-customer", "x-api-path-slug"=>"collaborationroomscollaborationroomidproductiondataproductiondataidcancelconfirm-post", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"path", "name"=>"productionDataId", "description"=>"The ID of a production option"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Cancels", "Confirmation", "Of", "Production", "Option"]}}, "/collaborationRooms/{collaborationRoomId}/thumbnails"=>{"get"=>{"summary"=>"Retrieves the thumbnail of a design file", "description"=>"Retrieves the thumbnail information in a collaboration room.\nEach design file has a corresponding thumbnail file automatically generated.", "operationId"=>"retrieves-the-thumbnail-information-in-a-collaboration-roomeach-design-file-has-a-corresponding-thum", "x-api-path-slug"=>"collaborationroomscollaborationroomidthumbnails-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Thumbnail", "Of", "Design", "File"]}}, "/collaborationTemplates"=>{"get"=>{"summary"=>"Retrieves available collaboration room templates", "description"=>"Retrieves available collaboration room templates.", "operationId"=>"retrieves-available-collaboration-room-templates", "x-api-path-slug"=>"collaborationtemplates-get", "parameters"=>[{"in"=>"query", "name"=>"typeId", "description"=>"The ID of a collaboration room template"}, {"in"=>"query", "name"=>"typeName", "description"=>"The name of a collaboration room template"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Available", "Collaboration", "Room", "Templates"]}}, "/documents/collaborationRooms/{collaborationRoomId}/download"=>{"get"=>{"summary"=>"Downloads a file", "description"=>"Downloads a file from a collaboration room.", "operationId"=>"downloads-a-file-from-a-collaboration-room", "x-api-path-slug"=>"documentscollaborationroomscollaborationroomiddownload-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"query", "name"=>"fileId", "description"=>"The ID of a file"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Downloads", "File"]}}, "/documents/collaborationRooms/{collaborationRoomId}/upload"=>{"post"=>{"summary"=>"Uploads a file to a collaboration room", "description"=>"Uploads a file to a collaboration room.", "operationId"=>"uploads-a-file-to-a-collaboration-room", "x-api-path-slug"=>"documentscollaborationroomscollaborationroomidupload-post", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}, {"in"=>"formData", "name"=>"fileUpload", "description"=>"A file to be uploaded"}, {"in"=>"formData", "name"=>"originFileDisplay", "description"=>"Indicates if a file is visible to all participants in the collaboration room (public) or to the uploader only (private)"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Uploads", "File", "To", "Collaboration", "Room"]}}, "/documents/collaborationRooms/{collaborationRoomId}/thumbnail/download"=>{"get"=>{"summary"=>"Downloads the thumbnail of a design file", "description"=>"Downloads the thumbnail selected as the icon for a collaboration room.", "operationId"=>"downloads-the-thumbnail-selected-as-the-icon-for-a-collaboration-room", "x-api-path-slug"=>"documentscollaborationroomscollaborationroomidthumbnaildownload-get", "parameters"=>[{"in"=>"path", "name"=>"collaborationRoomId", "description"=>"The ID of a collaboration room"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Downloads", "Thumbnail", "Of", "Design", "File"]}}, "/documents/organizations/{organizationId}/TEMP/upload"=>{"post"=>{"summary"=>"Uploads a file to the temp folder", "description"=>"Uploads a file to the temp folder for an organization.", "operationId"=>"uploads-a-file-to-the-temp-folder-for-an-organization", "x-api-path-slug"=>"documentsorganizationsorganizationidtempupload-post", "parameters"=>[{"in"=>"formData", "name"=>"fileUpload", "description"=>"A file to be uploaded"}, {"in"=>"path", "name"=>"organizationId", "description"=>"The ID of an organization"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Uploads", "File", "To", "Temp", "Folder"]}}, "/extensions"=>{"get"=>{"summary"=>"Retrieves all extensions", "description"=>"Retrieves all the extensions that have been registered with Manufacturing Network. \nThese extensions are developed by Manufacturing Network customers or partners to enhance the functionality of the application.", "operationId"=>"retrieves-all-the-extensions-that-have-been-registered-with-manufacturing-network--these-extensions-", "x-api-path-slug"=>"extensions-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "", "Extensions"]}}, "/extensions/available"=>{"get"=>{"summary"=>"Retrieves extensions available for use", "description"=>"Retrieves extensions that can be used during a collaboration. \nA supplier enables an extension for collaboration by selecting it for use in the supplier profile.", "operationId"=>"retrieves-extensions-that-can-be-used-during-a-collaboration--a-supplier-enables-an-extension-for-co", "x-api-path-slug"=>"extensionsavailable-get", "parameters"=>[{"in"=>"query", "name"=>"organizationIds", "description"=>"The IDs of organizations as collaboration partiesSeparate the IDs using commas"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Extensions", "Availableuse"]}}, "/masterData"=>{"get"=>{"summary"=>"Retrieves supplier profile master data", "description"=>"Retrieves master data such as processes and materials.\nNarrow down the result by specifying the master data types.", "operationId"=>"retrieves-master-data-such-as-processes-and-materialsnarrow-down-the-result-by-specifying-the-master", "x-api-path-slug"=>"masterdata-get", "parameters"=>[{"in"=>"query", "name"=>"type", "description"=>"A master data typeValid values: [certificates, currencies, materialRequirement, postProcesses, preferredLanguages, processMaterial, servicePortfolio]"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Supplier", "Profile", "Master", "Data"]}}, "/orders"=>{"post"=>{"summary"=>"Creates an order", "description"=>"Creates an order for the part for which the customer and the supplier haven been colloabrating\nThe order is based on the confirmed production option and pricing.\nThe login user must be from the customer.", "operationId"=>"creates-an-order-for-the-part-for-which-the-customer-and-the-supplier-haven-been-colloabratingthe-or", "x-api-path-slug"=>"orders-post", "parameters"=>[{"in"=>"body", "name"=>"OrderRequest", "description"=>"A request about an order", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Creates", "Order"]}}, "/orders/{orderNumber}/history"=>{"post"=>{"summary"=>"Adds a record to the order history", "description"=>"Adds a record to the history of an order. \nThe order number is sent in the message body of the Order Created event. \nThe login user must be from the additive manufacturing supplier.", "operationId"=>"adds-a-record-to-the-history-of-an-order---the-order-number-is-sent-in-the-message-body-of-the-order", "x-api-path-slug"=>"ordersordernumberhistory-post", "parameters"=>[{"in"=>"body", "name"=>"OrderItemRequest", "description"=>"A request about an order", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"orderNumber", "description"=>"An order number"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Record", "To", "Order", "History"]}}, "/organizations/self"=>{"get"=>{"summary"=>"Retrieves your own organization", "description"=>"Retrieves the information of the login user's own organization.", "operationId"=>"retrieves-the-information-of-the-login-users-own-organization", "x-api-path-slug"=>"organizationsself-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Your", "Own", "Organization"]}}, "/organizations/visible"=>{"get"=>{"summary"=>"Retrieves organizations available for collaboration", "description"=>"Retrieves organizations in a specific business role that are available for collaboration. \nThese organizations may have been approved for or blocked from collaboration, or they're still pending for approval.\nThe login user must be from a customer.", "operationId"=>"retrieves-organizations-in-a-specific-business-role-that-are-available-for-collaboration--these-orga", "x-api-path-slug"=>"organizationsvisible-get", "parameters"=>[{"in"=>"query", "name"=>"activeServices", "description"=>"The types of service that a supplier provides"}, {"in"=>"query", "name"=>"approved", "description"=>"Specify approved=true to restrict the search to organizations that are approved for collaboration"}, {"in"=>"query", "name"=>"roleCode", "description"=>"The code for the business role of the organizations"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Organizations", "Availablecollaboration"]}}, "/organizations/{organizationId}"=>{"get"=>{"summary"=>"Retrieves an organization", "description"=>"Retrieves an organization by its ID.", "operationId"=>"retrieves-an-organization-by-its-id", "x-api-path-slug"=>"organizationsorganizationid-get", "parameters"=>[{"in"=>"path", "name"=>"organizationId", "description"=>"The ID of the login users organization"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Organization"]}, "put"=>{"summary"=>"Updates a supplier profile", "description"=>"Updates the supplier profile of a specific organization.\nThe login user must be from a supplier.", "operationId"=>"updates-the-supplier-profile-of-a-specific-organizationthe-login-user-must-be-from-a-supplier", "x-api-path-slug"=>"organizationsorganizationid-put", "parameters"=>[{"in"=>"path", "name"=>"organizationId", "description"=>"The ID of the login users organization"}, {"in"=>"body", "name"=>"OrganizationUpdateRequest", "description"=>"A request about updating an organization", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Supplier", "Profile"]}}, "/organizations/{organizationId}/collaborationRooms"=>{"get"=>{"summary"=>"Retrieves the collaboration rooms of an organization", "description"=>"Retrieves the collaboration rooms where the login user's organization is a collaboration party. \n- If the login user is not an organization admin, only the collaboration rooms where the login user is a participant are retrieved. \n- If the login user is an organization admin, all the collaboration rooms where the login user's organization is a collaboration party are retrieved. The login user may not be part of the collaborations.", "operationId"=>"retrieves-the-collaboration-rooms-where-the-login-users-organization-is-a-collaboration-party----if-", "x-api-path-slug"=>"organizationsorganizationidcollaborationrooms-get", "parameters"=>[{"in"=>"path", "name"=>"organizationId", "description"=>"The ID of the login users organization"}, {"in"=>"query", "name"=>"organizationIds", "description"=>"The IDs of other organizations"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Collaboration", "Rooms", "Of", "Organization"]}}, "/organizations/{organizationId}/collaborationRooms/owned"=>{"get"=>{"summary"=>"Retrieves the collaboration rooms created by an organization", "description"=>"Retrieves the collaboration rooms created and owned by an organization. \n- If the login user is not an organization admin, only the collaboration rooms where the login user is a participant are retrieved. \n- If the login user is an organization admin, all the collaboration rooms owned by the login user's organization are retrieved.", "operationId"=>"retrieves-the-collaboration-rooms-created-and-owned-by-an-organization---if-the-login-user-is-not-an", "x-api-path-slug"=>"organizationsorganizationidcollaborationroomsowned-get", "parameters"=>[{"in"=>"path", "name"=>"organizationId", "description"=>"The ID of the login users organization"}, {"in"=>"query", "name"=>"organizationIds", "description"=>"The IDs of other organizations"}, {"in"=>"query", "name"=>"partId", "description"=>"The ID of a part"}, {"in"=>"query", "name"=>"serviceType", "description"=>"The type of service that a supplier organization provides during the collaboration"}, {"in"=>"query", "name"=>"status", "description"=>"The status of a collaboration"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Collaboration", "Rooms", "Created", "By", "Organization"]}}, "/organizations/{organizationId}/serviceProfiles"=>{"get"=>{"summary"=>"Retrieves a service profile", "description"=>"Retrieves the service portfolios of a supplier. \nA supplier may provide more than one type of service. The service profile may be comprised of various service portfolios for different service types. \n- If the login user is not an organization admin, he or she can retrieve only the active service portfolios. \n- if the login user is an organization admin, he or she can retrieve both active and inactive service portfolios.", "operationId"=>"retrieves-the-service-portfolios-of-a-supplier---a-supplier-may-provide-more-than-one-type-of-servic", "x-api-path-slug"=>"organizationsorganizationidserviceprofiles-get", "parameters"=>[{"in"=>"path", "name"=>"organizationId", "description"=>"The ID of the login users organization"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Service", "Profile"]}}, "/templateTypes"=>{"get"=>{"summary"=>"Retrieves collaboration room template types", "description"=>"Retrieves available collaboration room template types.", "operationId"=>"retrieves-available-collaboration-room-template-types", "x-api-path-slug"=>"templatetypes-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Collaboration", "Room", "Template", "Types"]}}, "/users"=>{"get"=>{"summary"=>"Retrieves the users of an organization", "description"=>"Retrieves the users of a specific organization. \nThe login user must be from this organization as well.", "operationId"=>"retrieves-the-users-of-a-specific-organization--the-login-user-must-be-from-this-organization-as-wel", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"query", "name"=>"organizationId", "description"=>"The ID of an organization"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Users", "Of", "Organization"]}}, "/users/self"=>{"get"=>{"summary"=>"Retrieves your own user info", "description"=>"Retrieves the information of the current login user.", "operationId"=>"retrieves-the-information-of-the-current-login-user", "x-api-path-slug"=>"usersself-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Your", "Own", "User", "Info"]}}, "/users/{userId}/collaborationRooms"=>{"get"=>{"summary"=>"Retrieves a user's collaboration rooms", "description"=>"Retrieves the collaboration rooms where a user is a participant. \n- If the login user is not an organization admin, he or she can search only by his or her own user ID and retrieve the collaboration rooms where he or she is a participant. \n- If the login user is an organization admin, he or she can search by the user ID of any user in the same organization.", "operationId"=>"retrieves-the-collaboration-rooms-where-a-user-is-a-participant---if-the-login-user-is-not-an-organi", "x-api-path-slug"=>"usersuseridcollaborationrooms-get", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"The ID of a user"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Users", "Collaboration", "Rooms"]}}}}, "apis"=>{"name"=>"SAP", "x-slug"=>"sap", "description"=>"Get software and technology solutions from SAP, the leader in business applications. Run simple with the best in cloud, analytics, mobile and IT solutions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28252-www-sap-com.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"1965", "tags"=>"Enterprise,Relative Data,SaaS,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"sap/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"SAP Manufacturing Network Customer APIs", "x-api-slug"=>"sap-manufacturing-network-customer-apis", "description"=>"Get software and technology solutions from SAP, the leader in business applications. Run simple with the best in cloud, analytics, mobile and IT solutions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28252-www-sap-com.jpg", "humanURL"=>"https://www.sap.com/index.html", "baseURL"=>"https://hostname//dim/api", "tags"=>"Enterprise,Relative Data,SaaS,Service API,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/sap/sap-manufacturing-network-customer-apis-openapi.yaml"}]}, {"name"=>"SAP Manufacturing Network Partner APIs", "x-api-slug"=>"sap-manufacturing-network-partner-apis", "description"=>"Get software and technology solutions from SAP, the leader in business applications. Run simple with the best in cloud, analytics, mobile and IT solutions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28252-www-sap-com.jpg", "humanURL"=>"https://www.sap.com/index.html", "baseURL"=>"https://hostname//dim/api", "tags"=>"Retrieves,Users,Collaboration,Rooms", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/sap/sap-manufacturing-network-partner-apis-openapi.yaml"}]}, {"name"=>"SAP Translation Hub", "x-api-slug"=>"sap-translation-hub", "description"=>"Get software and technology solutions from SAP, the leader in business applications. Run simple with the best in cloud, analytics, mobile and IT solutions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28252-www-sap-com.jpg", "humanURL"=>"https://www.sap.com/index.html", "baseURL"=>"https://sandbox.api.sap.com//translationhub/api/v1", "tags"=>"Downloads,Design,File,Of,Part", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/sap/sap-translation-hub-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://www.sap.com/index.html"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/sap-canada"}, {"type"=>"x-developer", "url"=>"https://api.sap.com/"}, {"type"=>"x-github", "url"=>"https://github.com/sap"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/SAP"}, {"type"=>"x-website", "url"=>"https://www.sap.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aculab-cloud{"db-direct-identity-resolution-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Aculab Cloud", "x-complete"=>1, "info"=>{"title"=>"D&B Direct+ Identity Resolution", "description"=>"todo-add-description", "version"=>"1.0.0"}, "host"=>"plus.dnb.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/match/cleanseMatch"=>{"get"=>{"summary"=>"IDR Domain Email", "description"=>"Idr domain email.", "operationId"=>"V1MatchCleanseMatchGet10", "x-api-path-slug"=>"v1matchcleansematch-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"countryISOAlpha2Code"}, {"in"=>"query", "name"=>"email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Domain", "Email"]}}, "/v1/match/extendedMatch"=>{"get"=>{"summary"=>"IDR & Append Domain URL", "description"=>"Idr & append domain url.", "operationId"=>"V1MatchExtendedMatchGet4", "x-api-path-slug"=>"v1matchextendedmatch-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"countryISOAlpha2Code"}, {"in"=>"query", "name"=>"productId"}, {"in"=>"query", "name"=>"url"}, {"in"=>"query", "name"=>"versionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Append", "Domain", "URL"]}}, "/v2/token"=>{"post"=>{"summary"=>"Authentication - Access Token", "description"=>"Authentication - access token.", "operationId"=>"V2TokenPost", "x-api-path-slug"=>"v2token-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Authentication", "Access", "Token"]}}, "/v1/match/cleanseAndStandardize"=>{"get"=>{"summary"=>"Cleanse & Standardize", "description"=>"Cleanse & standardize.", "operationId"=>"V1MatchCleanseAndStandardizeGet", "x-api-path-slug"=>"v1matchcleanseandstandardize-get", "parameters"=>[{"in"=>"query", "name"=>"addressLocality"}, {"in"=>"query", "name"=>"addressRegion"}, {"in"=>"query", "name"=>"countryISOAlpha2Code"}, {"in"=>"query", "name"=>"name"}, {"in"=>"query", "name"=>"streetAddressLine1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Cleanse", "Standardize"]}}}}, "apis"=>{"name"=>"Aculab Cloud", "x-slug"=>"aculab-cloud", "description"=>"Aculab offers a comprehensive range of telephony platforms - cloud-based, software-based, hardware-based - and a wide range of gateways.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/305-aculab-cloud.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"3174268", "tags"=>"API Provider,API United Kingdom,Cloud,Conferencing,Enterprise,Faxes,ISP,Profiles,SaaS,Technology,Telecommunications,Telecommunications", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aculab-cloud/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"D&B Direct+ Identity Resolution", "x-api-slug"=>"db-direct-identity-resolution", "description"=>"D&B (NYSE:DNB) is the worlds leading source of commercial information and insight on businesses, enabling companies to Decide with Confidence® for 170 years. D&Bs global commercial database contains more than 195 million business records. The database is enhanced by D&Bs proprietary DUNSRight® Quality Process, which provides our customers with quality business information. This quality information is the foundation of our global solutions that customers rely on to make critical business decisions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/305-aculab-cloud.jpg", "humanURL"=>"https://www.aculab.com/", "baseURL"=>"https://plus.dnb.com//", "tags"=>"API Provider,API United Kingdom,Cloud,Conferencing,Enterprise,Faxes,ISP,Profiles,SaaS,Technology,Telecommunications,Telecommunications", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aculab-cloud/db-direct-identity-resolution-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://cloudblog.aculab.com/"}, {"type"=>"x-blog-rss", "url"=>"https://twitter.com/zomato"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/aculab-cloud"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/aculab"}, {"type"=>"x-developer", "url"=>"https://www.aculab.com/cloud"}, {"type"=>"x-email", "url"=>"support@aculab.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Aculabcloud"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/aculab"}, {"type"=>"x-website", "url"=>"https://www.aculab.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-tag-manager{"google-tag-manager-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Tag Manager", "x-complete"=>1, "info"=>{"title"=>"Tag Manager", "description"=>"accesses-tag-manager-accounts-and-containers-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"www.googleapis.com", "basePath"=>"/tagmanager/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/accounts"=>{"get"=>{"summary"=>"Get Accounts", "description"=>"Lists all GTM Accounts that a user has access to.", "operationId"=>"tagmanager.accounts.list", "x-api-path-slug"=>"accounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/accounts/{accountId}"=>{"get"=>{"summary"=>"Get Account", "description"=>"Gets a GTM Account.", "operationId"=>"tagmanager.accounts.get", "x-api-path-slug"=>"accountsaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}, "put"=>{"summary"=>"Update Account", "description"=>"Updates a GTM Account.", "operationId"=>"tagmanager.accounts.update", "x-api-path-slug"=>"accountsaccountid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fingerprint", "description"=>"When provided, this fingerprint must match the fingerprint of the account in storage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/accounts/{accountId}/containers"=>{"get"=>{"summary"=>"Get Conainers", "description"=>"Lists all Containers that belongs to a GTM Account.", "operationId"=>"tagmanager.accounts.containers.list", "x-api-path-slug"=>"accountsaccountidcontainers-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Container"]}, "post"=>{"summary"=>"Create Container", "description"=>"Creates a Container.", "operationId"=>"tagmanager.accounts.containers.create", "x-api-path-slug"=>"accountsaccountidcontainers-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Container"]}}, "/accounts/{accountId}/containers/{containerId}"=>{"delete"=>{"summary"=>"Delete Container", "description"=>"Deletes a Container.", "operationId"=>"tagmanager.accounts.containers.delete", "x-api-path-slug"=>"accountsaccountidcontainerscontainerid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Container"]}, "get"=>{"summary"=>"Get Container", "description"=>"Gets a Container.", "operationId"=>"tagmanager.accounts.containers.get", "x-api-path-slug"=>"accountsaccountidcontainerscontainerid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Container"]}, "put"=>{"summary"=>"Update Container", "description"=>"Updates a Container.", "operationId"=>"tagmanager.accounts.containers.update", "x-api-path-slug"=>"accountsaccountidcontainerscontainerid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"query", "name"=>"fingerprint", "description"=>"When provided, this fingerprint must match the fingerprint of the container in storage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Container"]}}, "/accounts/{accountId}/containers/{containerId}/environments"=>{"get"=>{"summary"=>"Get GTM Environments", "description"=>"Lists all GTM Environments of a GTM Container.", "operationId"=>"tagmanager.accounts.containers.environments.list", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridenvironments-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Environment"]}, "post"=>{"summary"=>"Create GTM Environment", "description"=>"Creates a GTM Environment.", "operationId"=>"tagmanager.accounts.containers.environments.create", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridenvironments-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Environment"]}}, "/accounts/{accountId}/containers/{containerId}/environments/{environmentId}"=>{"delete"=>{"summary"=>"Delete GTM Environment", "description"=>"Deletes a GTM Environment.", "operationId"=>"tagmanager.accounts.containers.environments.delete", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridenvironmentsenvironmentid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"environmentId", "description"=>"The GTM Environment ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Environment"]}, "get"=>{"summary"=>"Get GTM Environment", "description"=>"Gets a GTM Environment.", "operationId"=>"tagmanager.accounts.containers.environments.get", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridenvironmentsenvironmentid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"environmentId", "description"=>"The GTM Environment ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Environment"]}, "patch"=>{"summary"=>"Update GTM Environment", "description"=>"Updates a GTM Environment. This method supports patch semantics.", "operationId"=>"tagmanager.accounts.containers.environments.patch", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridenvironmentsenvironmentid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"environmentId", "description"=>"The GTM Environment ID"}, {"in"=>"query", "name"=>"fingerprint", "description"=>"When provided, this fingerprint must match the fingerprint of the environment in storage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Environment"]}, "put"=>{"summary"=>"Update GTM Environment", "description"=>"Updates a GTM Environment.", "operationId"=>"tagmanager.accounts.containers.environments.update", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridenvironmentsenvironmentid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"environmentId", "description"=>"The GTM Environment ID"}, {"in"=>"query", "name"=>"fingerprint", "description"=>"When provided, this fingerprint must match the fingerprint of the environment in storage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Environment"]}}, "/accounts/{accountId}/containers/{containerId}/folders"=>{"get"=>{"summary"=>"Get GTM Folders", "description"=>"Lists all GTM Folders of a Container.", "operationId"=>"tagmanager.accounts.containers.folders.list", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridfolders-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Folder"]}, "post"=>{"summary"=>"Create GTM Folder", "description"=>"Creates a GTM Folder.", "operationId"=>"tagmanager.accounts.containers.folders.create", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridfolders-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Folder"]}}, "/accounts/{accountId}/containers/{containerId}/folders/{folderId}"=>{"delete"=>{"summary"=>"Delete GTM Folder", "description"=>"Deletes a GTM Folder.", "operationId"=>"tagmanager.accounts.containers.folders.delete", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridfoldersfolderid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"folderId", "description"=>"The GTM Folder ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Folder"]}, "get"=>{"summary"=>"Get GTM Folder", "description"=>"Gets a GTM Folder.", "operationId"=>"tagmanager.accounts.containers.folders.get", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridfoldersfolderid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"folderId", "description"=>"The GTM Folder ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Folder"]}, "put"=>{"summary"=>"Update GTM Folder", "description"=>"Updates a GTM Folder.", "operationId"=>"tagmanager.accounts.containers.folders.update", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridfoldersfolderid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"query", "name"=>"fingerprint", "description"=>"When provided, this fingerprint must match the fingerprint of the folder in storage"}, {"in"=>"path", "name"=>"folderId", "description"=>"The GTM Folder ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Folder"]}}, "/accounts/{accountId}/containers/{containerId}/folders/{folderId}/entities"=>{"get"=>{"summary"=>"Get Entities", "description"=>"List all entities in a GTM Folder.", "operationId"=>"tagmanager.accounts.containers.folders.entities.list", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridfoldersfolderidentities-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"folderId", "description"=>"The GTM Folder ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entity"]}}, "/accounts/{accountId}/containers/{containerId}/move_folders/{folderId}"=>{"put"=>{"summary"=>"Move Entity", "description"=>"Moves entities to a GTM Folder.", "operationId"=>"tagmanager.accounts.containers.move_folders.update", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridmove-foldersfolderid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"folderId", "description"=>"The GTM Folder ID"}, {"in"=>"query", "name"=>"tagId", "description"=>"The tags to be moved to the folder"}, {"in"=>"query", "name"=>"triggerId", "description"=>"The triggers to be moved to the folder"}, {"in"=>"query", "name"=>"variableId", "description"=>"The variables to be moved to the folder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entity"]}}, "/accounts/{accountId}/containers/{containerId}/reauthorize_environments/{environmentId}"=>{"put"=>{"summary"=>"Regenerate Authorization", "description"=>"Re-generates the authorization code for a GTM Environment.", "operationId"=>"tagmanager.accounts.containers.reauthorize_environments.update", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridreauthorize-environmentsenvironmentid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"environmentId", "description"=>"The GTM Environment ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorization"]}}, "/accounts/{accountId}/containers/{containerId}/tags"=>{"get"=>{"summary"=>"Get GTM Tags", "description"=>"Lists all GTM Tags of a Container.", "operationId"=>"tagmanager.accounts.containers.tags.list", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridtags-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Tag"]}, "post"=>{"summary"=>"Create GTM Tag", "description"=>"Creates a GTM Tag.", "operationId"=>"tagmanager.accounts.containers.tags.create", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridtags-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Tag"]}}, "/accounts/{accountId}/containers/{containerId}/tags/{tagId}"=>{"delete"=>{"summary"=>"Delete GTM Tag", "description"=>"Deletes a GTM Tag.", "operationId"=>"tagmanager.accounts.containers.tags.delete", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridtagstagid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"tagId", "description"=>"The GTM Tag ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Tag"]}, "get"=>{"summary"=>"Get GTM Tag", "description"=>"Gets a GTM Tag.", "operationId"=>"tagmanager.accounts.containers.tags.get", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridtagstagid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"tagId", "description"=>"The GTM Tag ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Tag"]}, "put"=>{"summary"=>"Update GTM Tag", "description"=>"Updates a GTM Tag.", "operationId"=>"tagmanager.accounts.containers.tags.update", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridtagstagid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"query", "name"=>"fingerprint", "description"=>"When provided, this fingerprint must match the fingerprint of the tag in storage"}, {"in"=>"path", "name"=>"tagId", "description"=>"The GTM Tag ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Tag"]}}, "/accounts/{accountId}/containers/{containerId}/triggers"=>{"get"=>{"summary"=>"Get GTM Triggers", "description"=>"Lists all GTM Triggers of a Container.", "operationId"=>"tagmanager.accounts.containers.triggers.list", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridtriggers-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Trigger"]}, "post"=>{"summary"=>"Create GTM Trigger", "description"=>"Creates a GTM Trigger.", "operationId"=>"tagmanager.accounts.containers.triggers.create", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridtriggers-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Trigger"]}}, "/accounts/{accountId}/containers/{containerId}/triggers/{triggerId}"=>{"delete"=>{"summary"=>"Delete GTM Trigger", "description"=>"Deletes a GTM Trigger.", "operationId"=>"tagmanager.accounts.containers.triggers.delete", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridtriggerstriggerid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"triggerId", "description"=>"The GTM Trigger ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Trigger"]}, "get"=>{"summary"=>"Get GTM Trigger", "description"=>"Gets a GTM Trigger.", "operationId"=>"tagmanager.accounts.containers.triggers.get", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridtriggerstriggerid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"triggerId", "description"=>"The GTM Trigger ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Trigger"]}, "put"=>{"summary"=>"Update GTM Trigger", "description"=>"Updates a GTM Trigger.", "operationId"=>"tagmanager.accounts.containers.triggers.update", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridtriggerstriggerid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"query", "name"=>"fingerprint", "description"=>"When provided, this fingerprint must match the fingerprint of the trigger in storage"}, {"in"=>"path", "name"=>"triggerId", "description"=>"The GTM Trigger ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Trigger"]}}, "/accounts/{accountId}/containers/{containerId}/variables"=>{"get"=>{"summary"=>"Get GTM Variables", "description"=>"Lists all GTM Variables of a Container.", "operationId"=>"tagmanager.accounts.containers.variables.list", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridvariables-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Variable"]}, "post"=>{"summary"=>"Create GTM Variable", "description"=>"Creates a GTM Variable.", "operationId"=>"tagmanager.accounts.containers.variables.create", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridvariables-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Variable"]}}, "/accounts/{accountId}/containers/{containerId}/variables/{variableId}"=>{"delete"=>{"summary"=>"Delete GTM Variable", "description"=>"Deletes a GTM Variable.", "operationId"=>"tagmanager.accounts.containers.variables.delete", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridvariablesvariableid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"variableId", "description"=>"The GTM Variable ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Variable"]}, "get"=>{"summary"=>"Get GTM Variable", "description"=>"Gets a GTM Variable.", "operationId"=>"tagmanager.accounts.containers.variables.get", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridvariablesvariableid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"variableId", "description"=>"The GTM Variable ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Variable"]}, "put"=>{"summary"=>"Update GTM Variable", "description"=>"Updates a GTM Variable.", "operationId"=>"tagmanager.accounts.containers.variables.update", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridvariablesvariableid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"query", "name"=>"fingerprint", "description"=>"When provided, this fingerprint must match the fingerprint of the variable in storage"}, {"in"=>"path", "name"=>"variableId", "description"=>"The GTM Variable ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GTM Variable"]}}, "/accounts/{accountId}/containers/{containerId}/versions"=>{"get"=>{"summary"=>"Get Container Versions", "description"=>"Lists all Container Versions of a GTM Container.", "operationId"=>"tagmanager.accounts.containers.versions.list", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridversions-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"query", "name"=>"headers", "description"=>"Retrieve headers only when true"}, {"in"=>"query", "name"=>"includeDeleted", "description"=>"Also retrieve deleted (archived) versions when true"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Versions"]}, "post"=>{"summary"=>"Create Container Version", "description"=>"Creates a Container Version.", "operationId"=>"tagmanager.accounts.containers.versions.create", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridversions-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Versions"]}}, "/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}"=>{"delete"=>{"summary"=>"Delete Container Version", "description"=>"Deletes a Container Version.", "operationId"=>"tagmanager.accounts.containers.versions.delete", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridversionscontainerversionid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"containerVersionId", "description"=>"The GTM Container Version ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Versions"]}, "get"=>{"summary"=>"Get Container Version", "description"=>"Gets a Container Version.", "operationId"=>"tagmanager.accounts.containers.versions.get", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridversionscontainerversionid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"containerVersionId", "description"=>"The GTM Container Version ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Versions"]}, "put"=>{"summary"=>"Update Container Version", "description"=>"Updates a Container Version.", "operationId"=>"tagmanager.accounts.containers.versions.update", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridversionscontainerversionid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"containerVersionId", "description"=>"The GTM Container Version ID"}, {"in"=>"query", "name"=>"fingerprint", "description"=>"When provided, this fingerprint must match the fingerprint of the container version in storage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Versions"]}}, "/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/publish"=>{"post"=>{"summary"=>"Publish Container Version", "description"=>"Publishes a Container Version.", "operationId"=>"tagmanager.accounts.containers.versions.publish", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridversionscontainerversionidpublish-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"containerVersionId", "description"=>"The GTM Container Version ID"}, {"in"=>"query", "name"=>"fingerprint", "description"=>"When provided, this fingerprint must match the fingerprint of the container version in storage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Versions"]}}, "/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/restore"=>{"post"=>{"summary"=>"Restore Container Version", "description"=>"Restores a Container Version. This will overwrite the container's current configuration (including its variables, triggers and tags). The operation will not have any effect on the version that is being served (i.e. the published version).", "operationId"=>"tagmanager.accounts.containers.versions.restore", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridversionscontainerversionidrestore-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"containerVersionId", "description"=>"The GTM Container Version ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Versions"]}}, "/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/undelete"=>{"post"=>{"summary"=>"Undelete Container Version", "description"=>"Undeletes a Container Version.", "operationId"=>"tagmanager.accounts.containers.versions.undelete", "x-api-path-slug"=>"accountsaccountidcontainerscontaineridversionscontainerversionidundelete-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"containerId", "description"=>"The GTM Container ID"}, {"in"=>"path", "name"=>"containerVersionId", "description"=>"The GTM Container Version ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Versions"]}}, "/accounts/{accountId}/permissions"=>{"get"=>{"summary"=>"Get User Permissions", "description"=>"List all users that have access to the account along with Account and Container Permissions granted to each of them.", "operationId"=>"tagmanager.accounts.permissions.list", "x-api-path-slug"=>"accountsaccountidpermissions-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Permission"]}, "post"=>{"summary"=>"Create User Permission", "description"=>"Creates a user's Account & Container Permissions.", "operationId"=>"tagmanager.accounts.permissions.create", "x-api-path-slug"=>"accountsaccountidpermissions-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Permission"]}}, "/accounts/{accountId}/permissions/{permissionId}"=>{"delete"=>{"summary"=>"Remove User", "description"=>"Removes a user from the account, revoking access to it and all of its containers.", "operationId"=>"tagmanager.accounts.permissions.delete", "x-api-path-slug"=>"accountsaccountidpermissionspermissionid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"permissionId", "description"=>"The GTM User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "get"=>{"summary"=>"Get User", "description"=>"Gets a user's Account & Container Permissions.", "operationId"=>"tagmanager.accounts.permissions.get", "x-api-path-slug"=>"accountsaccountidpermissionspermissionid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"path", "name"=>"permissionId", "description"=>"The GTM User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "put"=>{"summary"=>"Update User", "description"=>"Updates a user's Account & Container Permissions.", "operationId"=>"tagmanager.accounts.permissions.update", "x-api-path-slug"=>"accountsaccountidpermissionspermissionid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The GTM Account ID"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"permissionId", "description"=>"The GTM User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}}}, "apis"=>{"name"=>"Google Tag Manager", "x-slug"=>"google-tag-manager", "description"=>"Deploy and update measurement tags on your websites and mobile apps without major code changes and app releases. Use Google Tag Manager to manage tags (such as tracking and marketing optimization JavaScript tags) on your site. Without editing your site code, you use GTM user interface to add and update AdWords, Google Analytics, Floodlight, and non-Google tags. This reduces errors and allows you to to deploy tags on your site quickly.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/googl_tag_manager_gplus-250.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Service API,Stack Network,Tags", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-tag-manager/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Tag Manager API", "x-api-slug"=>"google-tag-manager-api", "description"=>"Deploy and update measurement tags on your websites and mobile apps without major code changes and app releases. Use Google Tag Manager to manage tags (such as tracking and marketing optimization JavaScript tags) on your site. Without editing your site code, you use GTM user interface to add and update AdWords, Google Analytics, Floodlight, and non-Google tags. This reduces errors and allows you to to deploy tags on your site quickly.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/googl_tag_manager_gplus-250.png", "humanURL"=>"https://developers.google.com/tag-manager/", "baseURL"=>"://www.googleapis.com//tagmanager/v1", "tags"=>"API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Service API,Stack Network,Tags", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-tag-manager/google-tag-manager-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://developers.google.com/tag-manager/api/v1/authorization"}, {"type"=>"x-change-log", "url"=>"https://developers.google.com/tag-manager/api/v1/changelog"}, {"type"=>"x-code", "url"=>"https://developers.google.com/tag-manager/api/v1/libraries"}, {"type"=>"x-documentation", "url"=>"https://developers.google.com/tag-manager/api/v1/"}, {"type"=>"x-performance", "url"=>"https://developers.google.com/tag-manager/api/v1/performance"}, {"type"=>"x-website", "url"=>"https://developers.google.com/tag-manager/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-auto-scaling{"aws-auto-scaling-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Auto Scaling", "x-complete"=>1, "info"=>{"title"=>"AWS Auto Scaling API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AttachInstances"=>{"get"=>{"summary"=>"Attach Instances", "description"=>"Attaches one or more EC2 instances to the specified Auto Scaling group.", "operationId"=>"attachInstances", "x-api-path-slug"=>"actionattachinstances-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceIds.member.N", "description"=>"One or more instance IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Instance"]}}, "/?Action=AttachLoadBalancers"=>{"get"=>{"summary"=>"Attach Load Balancers", "description"=>"Attaches one or more Classic load balancers to the specified Auto Scaling group.", "operationId"=>"attachLoadBalancers", "x-api-path-slug"=>"actionattachloadbalancers-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"LoadBalancerNames.member.N", "description"=>"One or more load balancer names", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load Balancers"]}}, "/?Action=AttachLoadBalancerTargetGroups"=>{"get"=>{"summary"=>"Attach Load Balancer Target Groups", "description"=>"Attaches one or more target groups to the specified Auto Scaling group.", "operationId"=>"attachLoadBalancerTargetGroups", "x-api-path-slug"=>"actionattachloadbalancertargetgroups-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"TargetGroupARNs.member.N", "description"=>"The Amazon Resource Names (ARN) of the target groups", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load Balancers"]}}, "/?Action=CompleteLifecycleAction"=>{"get"=>{"summary"=>"Complete Lifecycle Action", "description"=>"Completes the lifecycle action for the specified token or instance with the specified result.", "operationId"=>"completeLifecycleAction", "x-api-path-slug"=>"actioncompletelifecycleaction-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the group for the lifecycle hook", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"LifecycleActionResult", "description"=>"The action for the group to take", "type"=>"string"}, {"in"=>"query", "name"=>"LifecycleActionToken", "description"=>"A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance", "type"=>"string"}, {"in"=>"query", "name"=>"LifecycleHookName", "description"=>"The name of the lifecycle hook", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Life Cycle"]}}, "/?Action=CreateAutoScalingGroup"=>{"get"=>{"summary"=>"Create Auto Scaling Group", "description"=>"Creates an Auto Scaling group with the specified name and attributes.", "operationId"=>"createAutoScalingGroup", "x-api-path-slug"=>"actioncreateautoscalinggroup-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"AvailabilityZones.member.N", "description"=>"One or more Availability Zones for the group", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultCooldown", "description"=>"The amount of time, in seconds, after a scaling activity completes before another scaling activity can start", "type"=>"string"}, {"in"=>"query", "name"=>"DesiredCapacity", "description"=>"The number of EC2 instances that should be running in the group", "type"=>"string"}, {"in"=>"query", "name"=>"HealthCheckGracePeriod", "description"=>"The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service", "type"=>"string"}, {"in"=>"query", "name"=>"HealthCheckType", "description"=>"The service to use for the health checks", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance used to create a launch configuration for the group", "type"=>"string"}, {"in"=>"query", "name"=>"LaunchConfigurationName", "description"=>"The name of the launch configuration", "type"=>"string"}, {"in"=>"query", "name"=>"LoadBalancerNames.member.N", "description"=>"One or more Classic load balancers", "type"=>"string"}, {"in"=>"query", "name"=>"MaxSize", "description"=>"The maximum size of the group", "type"=>"string"}, {"in"=>"query", "name"=>"MinSize", "description"=>"The minimum size of the group", "type"=>"string"}, {"in"=>"query", "name"=>"NewInstancesProtectedFromScaleIn", "description"=>"Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in", "type"=>"string"}, {"in"=>"query", "name"=>"PlacementGroup", "description"=>"The name of the placement group into which youll launch your instances, if any", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.member.N", "description"=>"One or more tags", "type"=>"string"}, {"in"=>"query", "name"=>"TargetGroupARNs.member.N", "description"=>"The Amazon Resource Names (ARN) of the target groups", "type"=>"string"}, {"in"=>"query", "name"=>"TerminationPolicies.member.N", "description"=>"One or more termination policies used to select the instance to terminate", "type"=>"string"}, {"in"=>"query", "name"=>"VPCZoneIdentifier", "description"=>"A comma-separated list of subnet identifiers for your virtual private cloud (VPC)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auto Scaling Groups"]}}, "/?Action=CreateLaunchConfiguration"=>{"get"=>{"summary"=>"Create Launch Configuration", "description"=>"Creates a launch configuration.", "operationId"=>"createLaunchConfiguration", "x-api-path-slug"=>"actioncreatelaunchconfiguration-get", "parameters"=>[{"in"=>"query", "name"=>"AssociatePublicIpAddress", "description"=>"Used for groups that launch instances into a virtual private cloud (VPC)", "type"=>"string"}, {"in"=>"query", "name"=>"BlockDeviceMappings.member.N", "description"=>"One or more mappings that specify how block devices are exposed to the instance", "type"=>"string"}, {"in"=>"query", "name"=>"ClassicLinkVPCId", "description"=>"The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to", "type"=>"string"}, {"in"=>"query", "name"=>"ClassicLinkVPCSecurityGroups.member.N", "description"=>"The IDs of one or more security groups for the specified ClassicLink-enabled VPC", "type"=>"string"}, {"in"=>"query", "name"=>"EbsOptimized", "description"=>"Indicates whether the instance is optimized for Amazon EBS I/O", "type"=>"string"}, {"in"=>"query", "name"=>"IamInstanceProfile", "description"=>"The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance", "type"=>"string"}, {"in"=>"query", "name"=>"ImageId", "description"=>"The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance to use to create the launch configuration", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceMonitoring", "description"=>"Enables detailed monitoring (true) or basic monitoring (false) for the Auto Scaling instances", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceType", "description"=>"The instance type of the EC2 instance", "type"=>"string"}, {"in"=>"query", "name"=>"KernelId", "description"=>"The ID of the kernel associated with the AMI", "type"=>"string"}, {"in"=>"query", "name"=>"KeyName", "description"=>"The name of the key pair", "type"=>"string"}, {"in"=>"query", "name"=>"LaunchConfigurationName", "description"=>"The name of the launch configuration", "type"=>"string"}, {"in"=>"query", "name"=>"PlacementTenancy", "description"=>"The tenancy of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"RamdiskId", "description"=>"The ID of the RAM disk associated with the AMI", "type"=>"string"}, {"in"=>"query", "name"=>"SecurityGroups.member.N", "description"=>"One or more security groups with which to associate the instances", "type"=>"string"}, {"in"=>"query", "name"=>"SpotPrice", "description"=>"The maximum hourly price to be paid for any Spot Instance launched to fulfill the request", "type"=>"string"}, {"in"=>"query", "name"=>"UserData", "description"=>"The user data to make available to the launched EC2 instances", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Launch"]}}, "/?Action=CreateOrUpdateTags"=>{"get"=>{"summary"=>"Create Or Update Tags", "description"=>"Creates or updates tags for the specified Auto Scaling group.", "operationId"=>"createOrUpdateTags", "x-api-path-slug"=>"actioncreateorupdatetags-get", "parameters"=>[{"in"=>"query", "name"=>"Tags.member.N", "description"=>"One or more tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=DeleteAutoScalingGroup"=>{"get"=>{"summary"=>"Delete Auto Scaling Group", "description"=>"Deletes the specified Auto Scaling group.", "operationId"=>"deleteAutoScalingGroup", "x-api-path-slug"=>"actiondeleteautoscalinggroup-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the group to delete", "type"=>"string"}, {"in"=>"query", "name"=>"ForceDelete", "description"=>"Specifies that the group will be deleted along with all instances associated with the group, without waiting for all instances to be terminated", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auto Scaling Groups"]}}, "/?Action=DeleteLaunchConfiguration"=>{"get"=>{"summary"=>"Delete Launch Configuration", "description"=>"Deletes the specified launch configuration.", "operationId"=>"deleteLaunchConfiguration", "x-api-path-slug"=>"actiondeletelaunchconfiguration-get", "parameters"=>[{"in"=>"query", "name"=>"LaunchConfigurationName", "description"=>"The name of the launch configuration", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Launch"]}}, "/?Action=DeleteLifecycleHook"=>{"get"=>{"summary"=>"Delete Lifecycle Hook", "description"=>"Deletes the specified lifecycle hook.", "operationId"=>"deleteLifecycleHook", "x-api-path-slug"=>"actiondeletelifecyclehook-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the Auto Scaling group for the lifecycle hook", "type"=>"string"}, {"in"=>"query", "name"=>"LifecycleHookName", "description"=>"The name of the lifecycle hook", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Life Cycle"]}}, "/?Action=DeleteNotificationConfiguration"=>{"get"=>{"summary"=>"Delete Notification Configuration", "description"=>"Deletes the specified notification.", "operationId"=>"deleteNotificationConfiguration", "x-api-path-slug"=>"actiondeletenotificationconfiguration-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"TopicARN", "description"=>"The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications"]}}, "/?Action=DeletePolicy"=>{"get"=>{"summary"=>"Delete Policy", "description"=>"Deletes the specified Auto Scaling policy.", "operationId"=>"deletePolicy", "x-api-path-slug"=>"actiondeletepolicy-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyName", "description"=>"The name or Amazon Resource Name (ARN) of the policy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=DeleteScheduledAction"=>{"get"=>{"summary"=>"Delete Scheduled Action", "description"=>"Deletes the specified scheduled action.", "operationId"=>"deleteScheduledAction", "x-api-path-slug"=>"actiondeletescheduledaction-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"ScheduledActionName", "description"=>"The name of the action to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scheduled Action"]}}, "/?Action=DeleteTags"=>{"get"=>{"summary"=>"Delete Tags", "description"=>"Deletes the specified tags.", "operationId"=>"deleteTags", "x-api-path-slug"=>"actiondeletetags-get", "parameters"=>[{"in"=>"query", "name"=>"Tags.member.N", "description"=>"One or more tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=DescribeAccountLimits"=>{"get"=>{"summary"=>"Describe Account Limits", "description"=>"Describes the current Auto Scaling resource limits for your AWS account.", "operationId"=>"describeAccountLimits", "x-api-path-slug"=>"actiondescribeaccountlimits-get", "parameters"=>[{"in"=>"query", "name"=>"MaxNumberOfAutoScalingGroups", "description"=>"The maximum number of groups allowed for your AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"MaxNumberOfLaunchConfigurations", "description"=>"The maximum number of launch configurations allowed for your AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"NumberOfAutoScalingGroups", "description"=>"The current number of groups for your AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"NumberOfLaunchConfigurations", "description"=>"The current number of launch configurations for your AWS account", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account Limits"]}}, "/?Action=DescribeAdjustmentTypes"=>{"get"=>{"summary"=>"Describe Adjustment Types", "description"=>"Describes the policy adjustment types for use with.", "operationId"=>"describeAdjustmentTypes", "x-api-path-slug"=>"actiondescribeadjustmenttypes-get", "parameters"=>[{"in"=>"query", "name"=>"AdjustmentTypes.member.N", "description"=>"The policy adjustment types", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Adjustment Types"]}}, "/?Action=DescribeAutoScalingGroups"=>{"get"=>{"summary"=>"Describe Auto Scaling Groups", "description"=>"Describes one or more Auto Scaling groups.", "operationId"=>"describeAutoScalingGroups", "x-api-path-slug"=>"actiondescribeautoscalinggroups-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupNames.member.N", "description"=>"The group names", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of items to return with this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auto Scaling Groups"]}}, "/?Action=DescribeAutoScalingInstances"=>{"get"=>{"summary"=>"Describe Auto Scaling Instances", "description"=>"Describes one or more Auto Scaling instances.", "operationId"=>"describeAutoScalingInstances", "x-api-path-slug"=>"actiondescribeautoscalinginstances-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceIds.member.N", "description"=>"The instances to describe; up to 50 instance IDs", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of items to return with this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auto Scaling Instances"]}}, "/?Action=DescribeAutoScalingNotificationTypes"=>{"get"=>{"summary"=>"Describe Auto Scaling Notification Types", "description"=>"Describes the notification types that are supported by Auto Scaling.", "operationId"=>"describeAutoScalingNotificationTypes", "x-api-path-slug"=>"actiondescribeautoscalingnotificationtypes-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingNotificationTypes.member.N", "description"=>"The notification types", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auto Scaling Notifications"]}}, "/?Action=DescribeLaunchConfigurations"=>{"get"=>{"summary"=>"Describe Launch Configurations", "description"=>"Describes one or more launch configurations.", "operationId"=>"describeLaunchConfigurations", "x-api-path-slug"=>"actiondescribelaunchconfigurations-get", "parameters"=>[{"in"=>"query", "name"=>"LaunchConfigurationNames.member.N", "description"=>"The launch configuration names", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of items to return with this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Launch"]}}, "/?Action=DescribeLifecycleHooks"=>{"get"=>{"summary"=>"Describe Lifecycle Hooks", "description"=>"Describes the lifecycle hooks for the specified Auto Scaling group.", "operationId"=>"describeLifecycleHooks", "x-api-path-slug"=>"actiondescribelifecyclehooks-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"LifecycleHookNames.member.N", "description"=>"The names of one or more lifecycle hooks", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Life Cycle"]}}, "/?Action=DescribeLifecycleHookTypes"=>{"get"=>{"summary"=>"Describe Lifecycle Hook Types", "description"=>"Describes the available types of lifecycle hooks.", "operationId"=>"describeLifecycleHookTypes", "x-api-path-slug"=>"actiondescribelifecyclehooktypes-get", "parameters"=>[{"in"=>"query", "name"=>"LifecycleHookTypes.member.N", "description"=>"The lifecycle hook types", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Life Cycle"]}}, "/?Action=DescribeLoadBalancers"=>{"get"=>{"summary"=>"Describe Load Balancers", "description"=>"Describes the load balancers for the specified Auto Scaling group.", "operationId"=>"describeLoadBalancers", "x-api-path-slug"=>"actiondescribeloadbalancers-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of items to return with this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load Balancers"]}}, "/?Action=DescribeLoadBalancerTargetGroups"=>{"get"=>{"summary"=>"Describe Load Balancer Target Groups", "description"=>"Describes the target groups for the specified Auto Scaling group.", "operationId"=>"describeLoadBalancerTargetGroups", "x-api-path-slug"=>"actiondescribeloadbalancertargetgroups-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of items to return with this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load Balancers"]}}, "/?Action=DescribeMetricCollectionTypes"=>{"get"=>{"summary"=>"Describe Metric Collection Types", "description"=>"Describes the available CloudWatch metrics for Auto Scaling.", "operationId"=>"describeMetricCollectionTypes", "x-api-path-slug"=>"actiondescribemetriccollectiontypes-get", "parameters"=>[{"in"=>"query", "name"=>"Granularities.member.N", "description"=>"The granularities for the metrics", "type"=>"string"}, {"in"=>"query", "name"=>"Metrics.member.N", "description"=>"One or more metrics", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metric Collection"]}}, "/?Action=DescribeNotificationConfigurations"=>{"get"=>{"summary"=>"Describe Notification Configurations", "description"=>"Describes the notification actions associated with the specified Auto Scaling group.", "operationId"=>"describeNotificationConfigurations", "x-api-path-slug"=>"actiondescribenotificationconfigurations-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupNames.member.N", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of items to return with this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications"]}}, "/?Action=DescribePolicies"=>{"get"=>{"summary"=>"Describe Policies", "description"=>"Describes the policies for the specified Auto Scaling group.", "operationId"=>"describePolicies", "x-api-path-slug"=>"actiondescribepolicies-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of items to be returned with each call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyNames.member.N", "description"=>"One or more policy names or policy ARNs to be described", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyTypes.member.N", "description"=>"One or more policy types", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=DescribeScalingActivities"=>{"get"=>{"summary"=>"Describe Scaling Activities", "description"=>"Describes one or more scaling activities for the specified Auto Scaling group.", "operationId"=>"describeScalingActivities", "x-api-path-slug"=>"actiondescribescalingactivities-get", "parameters"=>[{"in"=>"query", "name"=>"ActivityIds.member.N", "description"=>"The activity IDs of the desired scaling activities", "type"=>"string"}, {"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of items to return with this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scaling Activities"]}}, "/?Action=DescribeScalingProcessTypes"=>{"get"=>{"summary"=>"Describe Scaling Process Types", "description"=>"Describes the scaling process types for use with.", "operationId"=>"describeScalingProcessTypes", "x-api-path-slug"=>"actiondescribescalingprocesstypes-get", "parameters"=>[{"in"=>"query", "name"=>"Processes.member.N", "description"=>"The names of the process types", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scaling Process"]}}, "/?Action=DescribeScheduledActions"=>{"get"=>{"summary"=>"Describe Scheduled Actions", "description"=>"Describes the actions scheduled for your Auto Scaling group that haven't run.", "operationId"=>"describeScheduledActions", "x-api-path-slug"=>"actiondescribescheduledactions-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"EndTime", "description"=>"The latest scheduled start time to return", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of items to return with this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"ScheduledActionNames.member.N", "description"=>"Describes one or more scheduled actions", "type"=>"string"}, {"in"=>"query", "name"=>"StartTime", "description"=>"The earliest scheduled start time to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scheduled Actions"]}}, "/?Action=DescribeTags"=>{"get"=>{"summary"=>"Describe Tags", "description"=>"Describes the specified tags.", "operationId"=>"describeTags", "x-api-path-slug"=>"actiondescribetags-get", "parameters"=>[{"in"=>"query", "name"=>"Filters.member.N", "description"=>"A filter used to scope the tags to return", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of items to return with this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=DescribeTerminationPolicyTypes"=>{"get"=>{"summary"=>"Describe Termination Policy Types", "description"=>"Describes the termination policies supported by Auto Scaling.", "operationId"=>"describeTerminationPolicyTypes", "x-api-path-slug"=>"actiondescribeterminationpolicytypes-get", "parameters"=>[{"in"=>"query", "name"=>"TerminationPolicyTypes.member.N", "description"=>"The termination policies supported by Auto Scaling (OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, and Default)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Termination Policies"]}}, "/?Action=DetachInstances"=>{"get"=>{"summary"=>"Detach Instances", "description"=>"Removes one or more instances from the specified Auto Scaling group.", "operationId"=>"detachInstances", "x-api-path-slug"=>"actiondetachinstances-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceIds.member.N", "description"=>"One or more instance IDs", "type"=>"string"}, {"in"=>"query", "name"=>"ShouldDecrementDesiredCapacity", "description"=>"If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Instances"]}}, "/?Action=DetachLoadBalancers"=>{"get"=>{"summary"=>"Detach Load Balancers", "description"=>"Detaches one or more Classic load balancers from the specified Auto Scaling group.", "operationId"=>"detachLoadBalancers", "x-api-path-slug"=>"actiondetachloadbalancers-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"LoadBalancerNames.member.N", "description"=>"One or more load balancer names", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load Balancers"]}}, "/?Action=DetachLoadBalancerTargetGroups"=>{"get"=>{"summary"=>"Detach Load Balancer Target Groups", "description"=>"Detaches one or more target groups from the specified Auto Scaling group.", "operationId"=>"detachLoadBalancerTargetGroups", "x-api-path-slug"=>"actiondetachloadbalancertargetgroups-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"TargetGroupARNs.member.N", "description"=>"The Amazon Resource Names (ARN) of the target groups", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load Balancers"]}}, "/?Action=DisableMetricsCollection"=>{"get"=>{"summary"=>"Disable Metrics Collection", "description"=>"Disables group metrics for the specified Auto Scaling group.", "operationId"=>"disableMetricsCollection", "x-api-path-slug"=>"actiondisablemetricscollection-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name or Amazon Resource Name (ARN) of the group", "type"=>"string"}, {"in"=>"query", "name"=>"Metrics.member.N", "description"=>"One or more of the following metrics", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics Collection"]}}, "/?Action=EnableMetricsCollection"=>{"get"=>{"summary"=>"Enable Metrics Collection", "description"=>"Enables group metrics for the specified Auto Scaling group.", "operationId"=>"enableMetricsCollection", "x-api-path-slug"=>"actionenablemetricscollection-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name or ARN of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"Granularity", "description"=>"The granularity to associate with the metrics to collect", "type"=>"string"}, {"in"=>"query", "name"=>"Metrics.member.N", "description"=>"One or more of the following metrics", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics Collection"]}}, "/?Action=EnterStandby"=>{"get"=>{"summary"=>"Enter Standby", "description"=>"Moves the specified instances into Standby mode.", "operationId"=>"enterStandby", "x-api-path-slug"=>"actionenterstandby-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceIds.member.N", "description"=>"One or more instances to move into Standby mode", "type"=>"string"}, {"in"=>"query", "name"=>"ShouldDecrementDesiredCapacity", "description"=>"Specifies whether the instances moved to Standby mode count as part of the Auto Scaling groups desired capacity", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stand By"]}}, "/?Action=ExecutePolicy"=>{"get"=>{"summary"=>"Execute Policy", "description"=>"Executes the specified policy.", "operationId"=>"executePolicy", "x-api-path-slug"=>"actionexecutepolicy-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name or Amazon Resource Name (ARN) of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"BreachThreshold", "description"=>"The breach threshold for the alarm", "type"=>"string"}, {"in"=>"query", "name"=>"HonorCooldown", "description"=>"If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy", "type"=>"string"}, {"in"=>"query", "name"=>"MetricValue", "description"=>"The metric value to compare to BreachThreshold", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyName", "description"=>"The name or ARN of the policy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=ExitStandby"=>{"get"=>{"summary"=>"Exit Standby", "description"=>"Moves the specified instances out of Standby mode.", "operationId"=>"exitStandby", "x-api-path-slug"=>"actionexitstandby-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceIds.member.N", "description"=>"One or more instance IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stand By"]}}, "/?Action=PutLifecycleHook"=>{"get"=>{"summary"=>"Put Lifecycle Hook", "description"=>"Creates or updates a lifecycle hook for the specified Auto Scaling Group.", "operationId"=>"putLifecycleHook", "x-api-path-slug"=>"actionputlifecyclehook-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the Auto Scaling group to which you want to assign the lifecycle hook", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultResult", "description"=>"Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs", "type"=>"string"}, {"in"=>"query", "name"=>"HeartbeatTimeout", "description"=>"The amount of time, in seconds, that can elapse before the lifecycle hook times out", "type"=>"string"}, {"in"=>"query", "name"=>"LifecycleHookName", "description"=>"The name of the lifecycle hook", "type"=>"string"}, {"in"=>"query", "name"=>"LifecycleTransition", "description"=>"The instance state to which you want to attach the lifecycle hook", "type"=>"string"}, {"in"=>"query", "name"=>"NotificationMetadata", "description"=>"Contains additional information that you want to include any time Auto Scaling sends a message to the notification target", "type"=>"string"}, {"in"=>"query", "name"=>"NotificationTargetARN", "description"=>"The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook", "type"=>"string"}, {"in"=>"query", "name"=>"RoleARN", "description"=>"The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Life Cycle"]}}, "/?Action=PutNotificationConfiguration"=>{"get"=>{"summary"=>"Put Notification Configuration", "description"=>"Configures an Auto Scaling group to send notifications when specified events take place.", "operationId"=>"putNotificationConfiguration", "x-api-path-slug"=>"actionputnotificationconfiguration-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"NotificationTypes.member.N", "description"=>"The type of event that will cause the notification to be sent", "type"=>"string"}, {"in"=>"query", "name"=>"TopicARN", "description"=>"The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications"]}}, "/?Action=PutScalingPolicy"=>{"get"=>{"summary"=>"Put Scaling Policy", "description"=>"Creates or updates a policy for an Auto Scaling group.", "operationId"=>"putScalingPolicy", "x-api-path-slug"=>"actionputscalingpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"AdjustmentType", "description"=>"The adjustment type", "type"=>"string"}, {"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name or ARN of the group", "type"=>"string"}, {"in"=>"query", "name"=>"Cooldown", "description"=>"The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start", "type"=>"string"}, {"in"=>"query", "name"=>"EstimatedInstanceWarmup", "description"=>"The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics", "type"=>"string"}, {"in"=>"query", "name"=>"MetricAggregationType", "description"=>"The aggregation type for the CloudWatch metrics", "type"=>"string"}, {"in"=>"query", "name"=>"MinAdjustmentMagnitude", "description"=>"The minimum number of instances to scale", "type"=>"string"}, {"in"=>"query", "name"=>"MinAdjustmentStep", "description"=>"Available for backward compatibility", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyName", "description"=>"The name of the policy", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyType", "description"=>"The policy type", "type"=>"string"}, {"in"=>"query", "name"=>"ScalingAdjustment", "description"=>"The amount by which to scale, based on the specified adjustment type", "type"=>"string"}, {"in"=>"query", "name"=>"StepAdjustments.member.N", "description"=>"A set of adjustments that enable you to scale based on the size of the alarm breach", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scaling Policy"]}}, "/?Action=PutScheduledUpdateGroupAction"=>{"get"=>{"summary"=>"Put Scheduled Update Group Action", "description"=>"Creates or updates a scheduled scaling action for an Auto Scaling group.", "operationId"=>"putScheduledUpdateGroupAction", "x-api-path-slug"=>"actionputscheduledupdategroupaction-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name or Amazon Resource Name (ARN) of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"DesiredCapacity", "description"=>"The number of EC2 instances that should be running in the group", "type"=>"string"}, {"in"=>"query", "name"=>"EndTime", "description"=>"The time for the recurring schedule to end", "type"=>"string"}, {"in"=>"query", "name"=>"MaxSize", "description"=>"The maximum size for the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"MinSize", "description"=>"The minimum size for the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"Recurrence", "description"=>"The recurring schedule for this action, in Unix cron syntax format", "type"=>"string"}, {"in"=>"query", "name"=>"ScheduledActionName", "description"=>"The name of this scaling action", "type"=>"string"}, {"in"=>"query", "name"=>"StartTime", "description"=>"The time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only (for example, 2014-06-01T00:00:00Z)", "type"=>"string"}, {"in"=>"query", "name"=>"Time", "description"=>"This parameter is deprecated", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scheduled Update"]}}, "/?Action=RecordLifecycleActionHeartbeat"=>{"get"=>{"summary"=>"Record Lifecycle Action Heartbeat", "description"=>"Records a heartbeat for the lifecycle action associated with the specified token or instance.", "operationId"=>"recordLifecycleActionHeartbeat", "x-api-path-slug"=>"actionrecordlifecycleactionheartbeat-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the Auto Scaling group for the hook", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"LifecycleActionToken", "description"=>"A token that uniquely identifies a specific lifecycle action associated with an instance", "type"=>"string"}, {"in"=>"query", "name"=>"LifecycleHookName", "description"=>"The name of the lifecycle hook", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Life Cycle"]}}, "/?Action=ResumeProcesses"=>{"get"=>{"summary"=>"Resume Processes", "description"=>"Resumes the specified suspended Auto Scaling processes, or all suspended process, for the specified Auto Scaling group.", "operationId"=>"resumeProcesses", "x-api-path-slug"=>"actionresumeprocesses-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name or Amazon Resource Name (ARN) of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"ScalingProcesses.member.N", "description"=>"One or more of the following processes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Processes"]}}, "/?Action=SetDesiredCapacity"=>{"get"=>{"summary"=>"Set Desired Capacity", "description"=>"Sets the size of the specified Auto Scaling group.", "operationId"=>"setDesiredCapacity", "x-api-path-slug"=>"actionsetdesiredcapacity-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"DesiredCapacity", "description"=>"The number of EC2 instances that should be running in the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"HonorCooldown", "description"=>"By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Desired Capacity"]}}, "/?Action=SetInstanceHealth"=>{"get"=>{"summary"=>"Set Instance Health", "description"=>"Sets the health status of the specified instance.", "operationId"=>"setInstanceHealth", "x-api-path-slug"=>"actionsetinstancehealth-get", "parameters"=>[{"in"=>"query", "name"=>"HealthStatus", "description"=>"The health status of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"ShouldRespectGracePeriod", "description"=>"If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call will respect the grace period", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Health"]}}, "/?Action=SetInstanceProtection"=>{"get"=>{"summary"=>"Set Instance Protection", "description"=>"Updates the instance protection settings of the specified instances.", "operationId"=>"setInstanceProtection", "x-api-path-slug"=>"actionsetinstanceprotection-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceIds.member.N", "description"=>"One or more instance IDs", "type"=>"string"}, {"in"=>"query", "name"=>"ProtectedFromScaleIn", "description"=>"Indicates whether the instance is protected from termination by Auto Scaling when scaling in", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Protection"]}}, "/?Action=SuspendProcesses"=>{"get"=>{"summary"=>"Suspend Processes", "description"=>"Suspends the specified Auto Scaling processes, or all processes, for the specified Auto Scaling group.", "operationId"=>"suspendProcesses", "x-api-path-slug"=>"actionsuspendprocesses-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name or Amazon Resource Name (ARN) of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"ScalingProcesses.member.N", "description"=>"One or more of the following processes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Processes"]}}, "/?Action=TerminateInstanceInAutoScalingGroup"=>{"get"=>{"summary"=>"Terminate Instance In Auto Scaling Group", "description"=>"Terminates the specified instance and optionally adjusts the desired group size.", "operationId"=>"terminateInstanceInAutoScalingGroup", "x-api-path-slug"=>"actionterminateinstanceinautoscalinggroup-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"ShouldDecrementDesiredCapacity", "description"=>"If true, terminating the instance also decrements the size of the Auto Scaling group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Auto Scaling"]}}, "/?Action=UpdateAutoScalingGroup"=>{"get"=>{"summary"=>"Update Auto Scaling Group", "description"=>"Updates the configuration for the specified Auto Scaling group.", "operationId"=>"updateAutoScalingGroup", "x-api-path-slug"=>"actionupdateautoscalinggroup-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingGroupName", "description"=>"The name of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"AvailabilityZones.member.N", "description"=>"One or more Availability Zones for the group", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultCooldown", "description"=>"The amount of time, in seconds, after a scaling activity completes before another scaling activity can start", "type"=>"string"}, {"in"=>"query", "name"=>"DesiredCapacity", "description"=>"The number of EC2 instances that should be running in the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"HealthCheckGracePeriod", "description"=>"The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service", "type"=>"string"}, {"in"=>"query", "name"=>"HealthCheckType", "description"=>"The service to use for the health checks", "type"=>"string"}, {"in"=>"query", "name"=>"LaunchConfigurationName", "description"=>"The name of the launch configuration", "type"=>"string"}, {"in"=>"query", "name"=>"MaxSize", "description"=>"The maximum size of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"MinSize", "description"=>"The minimum size of the Auto Scaling group", "type"=>"string"}, {"in"=>"query", "name"=>"NewInstancesProtectedFromScaleIn", "description"=>"Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in", "type"=>"string"}, {"in"=>"query", "name"=>"PlacementGroup", "description"=>"The name of the placement group into which youll launch your instances, if any", "type"=>"string"}, {"in"=>"query", "name"=>"TerminationPolicies.member.N", "description"=>"A standalone termination policy or a list of termination policies used to select the instance to terminate", "type"=>"string"}, {"in"=>"query", "name"=>"VPCZoneIdentifier", "description"=>"The ID of the subnet, if you are launching into a VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auto Scaling"]}}}}, "apis"=>{"name"=>"AWS Auto Scaling", "x-slug"=>"aws-auto-scaling", "description"=>"Auto Scaling helps you maintain application availability and allows you to scale yourAmazon EC2capacity up or down automatically according to conditions you define. You can use Auto Scaling to help ensure that you are running your desired number of Amazon EC2 instances. Auto Scaling can also automatically increase the number of Amazon EC2 instances during demand spikes to maintain performance and decrease capacity during lulls to reduce costs. Auto Scaling is well suited both to applications that have stable demand patterns or that experience hourly, daily, or weekly variability in usage.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_AmazonEC2_AutoScaling.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Compute,Deployments,Performance,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-auto-scaling/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Auto Scaling API", "x-api-slug"=>"aws-auto-scaling-api", "description"=>"Auto Scaling helps you maintain application availability and allows you to scale yourAmazon EC2capacity up or down automatically according to conditions you define. You can use Auto Scaling to help ensure that you are running your desired number of Amazon EC2 instances. Auto Scaling can also automatically increase the number of Amazon EC2 instances during demand spikes to maintain performance and decrease capacity during lulls to reduce costs. Auto Scaling is well suited both to applications that have stable demand patterns or that experience hourly, daily, or weekly variability in usage.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_AmazonEC2_AutoScaling.png", "humanURL"=>"https://aws.amazon.com/autoscaling/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Compute,Deployments,Performance,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-auto-scaling/aws-auto-scaling-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-articles", "url"=>"http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=100"}, {"type"=>"x-change-log", "url"=>"http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=86"}, {"type"=>"x-code", "url"=>"http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=85"}, {"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/cli/latest/reference/autoscaling/index.html"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/AutoScaling/latest/APIReference/"}, {"type"=>"x-forum", "url"=>"http://developer.amazonwebservices.com/connect/forum.jspa?forumID=30"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/autoscaling/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/autoscaling/pricing/"}, {"type"=>"x-service-health", "url"=>"http://status.aws.amazon.com/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/autoscaling/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
quovo{"quovo-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Quovo", "x-complete"=>1, "info"=>{"title"=>"Quovo API v3", "description"=>"todo-add-description", "version"=>"1.0.0"}, "host"=>"example.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/connections/{connection_id}/sync"=>{"get"=>{"summary"=>"Get a connection's sync progress", "description"=>"Check the ongoing Sync progress of an Account.", "operationId"=>"ConnectionsSyncByConnectionIdGet", "x-api-path-slug"=>"connectionsconnection-idsync-get", "parameters"=>[{"in"=>"path", "name"=>"connection_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connections", "Sync", "Progress"]}, "post"=>{"summary"=>"Initiate a Sync on the Connection", "description"=>"Initiates a new sync on the connection.\n\nSyncs are an ongoing update attempt on a connection. Syncing a newly created connection ensures the connction contains the most recent, available financial data, which includes current holdings and historical transactions.\n\nBefore making the request, check that the `{{connection_id}}` Postman variable is set properly, or that the URL contains the correct connection id.\n\nThe request will return a sync object with a `progress.state` of \"queued\", which indicates the sync request was sent successfully.", "operationId"=>"ConnectionsSyncByConnectionIdPost5", "x-api-path-slug"=>"connectionsconnection-idsync-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"connection_id"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Initiate", "Sync", "On", "Connection"]}}, "/users/{user_id}/terms_of_use"=>{"get"=>{"summary"=>"Check a user's TOU status", "description"=>"Check whether or not a User has accepted Quovo’s terms of use.", "operationId"=>"UsersTermsOfUseByUserIdGet", "x-api-path-slug"=>"usersuser-idterms-of-use-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Check", "Users", "TOU", "Status"]}, "put"=>{"summary"=>"Update a user's TOU status", "description"=>"Update whether or not a User has accepted Quovo’s terms of use.", "operationId"=>"UsersTermsOfUseByUserIdPut", "x-api-path-slug"=>"usersuser-idterms-of-use-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "TOU", "Status"]}}, "/tokens"=>{"get"=>{"summary"=>"Get all active access tokens", "description"=>"Retrieves all of your current Access Tokens.", "operationId"=>"TokensGet", "x-api-path-slug"=>"tokens-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Active", "Access", "Tokens"]}, "post"=>{"summary"=>"Create a new access token", "description"=>"Creates and returns a new Access Token.", "operationId"=>"TokensPost4", "x-api-path-slug"=>"tokens-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Access", "Token"]}, "delete"=>{"summary"=>"Delete an existing access token", "description"=>"Deletes an Access Token.", "operationId"=>"TokensDelete", "x-api-path-slug"=>"tokens-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Existing", "Access", "Token"]}}, "/connections/{connection_id}"=>{"get"=>{"summary"=>"Get a single connection", "description"=>"Provides information on a specific connection.", "operationId"=>"ConnectionsByConnectionIdGet", "x-api-path-slug"=>"connectionsconnection-id-get", "parameters"=>[{"in"=>"path", "name"=>"connection_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Connection"]}, "put"=>{"summary"=>"Modify a connection", "description"=>"Modifies an existing connection.", "operationId"=>"ConnectionsByConnectionIdPut", "x-api-path-slug"=>"connectionsconnection-id-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"connection_id"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Modify", "Connection"]}, "delete"=>{"summary"=>"Delete a connection", "description"=>"Deletes an existing Quovo connection.", "operationId"=>"ConnectionsByConnectionIdDelete", "x-api-path-slug"=>"connectionsconnection-id-delete", "parameters"=>[{"in"=>"path", "name"=>"connection_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connection"]}}, "/users/{user_id}"=>{"get"=>{"summary"=>"Get a single user", "description"=>"Provides information on a single User.", "operationId"=>"UsersByUserIdGet", "x-api-path-slug"=>"usersuser-id-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "User"]}, "put"=>{"summary"=>"Modify a user", "description"=>"Modifies an existing User.", "operationId"=>"UsersByUserIdPut", "x-api-path-slug"=>"usersuser-id-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Modify", "User"]}, "delete"=>{"summary"=>"Delete a User", "description"=>"Deletes a Quovo User.", "operationId"=>"UsersByUserIdDelete", "x-api-path-slug"=>"usersuser-id-delete", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/users"=>{"get"=>{"summary"=>"Get all users", "description"=>"Fetches all of your Users.", "operationId"=>"UsersGet", "x-api-path-slug"=>"users-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "post"=>{"summary"=>"Create a new Quovo User", "description"=>"Creates a new Quovo User.\n\nUsers are owners of Accounts, Portfolios, and any related financial data such as Positions and History.\n\nIf you have a Postman Environment set up, the previous request should have set your Access Token automatically. If not, be sure that your Access Token is included in the current request:\n\n1. Click on the \"Headers\" tab.\n2. Enter `Authorization` as the header field.\n3. Enter `Bearer token` as the header value, where `token` should be replaced with your actual Access Token.\n\nAfter sending the request, the Environment variable `user_id` will be automatically set to the newly created User's id.", "operationId"=>"UsersPost4", "x-api-path-slug"=>"users-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Quovo", "User"]}}, "/connections/{connection_id}/transactions"=>{"get"=>{"summary"=>"Get a connection's transactions", "description"=>"Provides information on a connection's historical transactions.", "operationId"=>"ConnectionsTransactionsByConnectionIdGet", "x-api-path-slug"=>"connectionsconnection-idtransactions-get", "parameters"=>[{"in"=>"path", "name"=>"connection_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connections", "Transactions"]}}, "/connections"=>{"get"=>{"summary"=>"Get all connections", "description"=>"Retrieves all connections across all users.", "operationId"=>"ConnectionsGet", "x-api-path-slug"=>"connections-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connections"]}}, "/institutions"=>{"get"=>{"summary"=>"Get all institutions", "description"=>"Provides information on all of Quovo's supported institutions.", "operationId"=>"InstitutionsGet", "x-api-path-slug"=>"institutions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Institutions"]}}, "/connections/{connection_id}/accounts"=>{"get"=>{"summary"=>"Fetch the Connection's Accounts", "description"=>"Fetches all of the accounts belonging to the connection. These are automatically created by Quovo after an initial sync.\n\nIf you have a Postman Environment set up, this request will automatically set the variable `account_id` to the id of the first account returned.", "operationId"=>"ConnectionsAccountsByConnectionIdGet4", "x-api-path-slug"=>"connectionsconnection-idaccounts-get", "parameters"=>[{"in"=>"path", "name"=>"connection_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fetch", "Connections", "Accounts"]}}, "/users/{user_id}/connections"=>{"get"=>{"summary"=>"Get a user's connections", "description"=>"Returns all of a user's connections.", "operationId"=>"UsersConnectionsByUserIdGet", "x-api-path-slug"=>"usersuser-idconnections-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Connections"]}, "post"=>{"summary"=>"Create a Connection", "description"=>"Creates a new Quovo Connection.", "operationId"=>"UsersConnectionsByUserIdPost4", "x-api-path-slug"=>"usersuser-idconnections-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connection"]}}, "/me"=>{"get"=>{"summary"=>"Get info about your API user", "description"=>"Fetch information about your Quovo API user.", "operationId"=>"MeGet", "x-api-path-slug"=>"me-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Info", "About", "Your", "User"]}, "put"=>{"summary"=>"Update your password", "description"=>"Update your API password. All future requests to /v3/tokens must use the new password to properly authenticate.\r\n\r\nNew API passwords have several requirements:\r\n\r\n* Must be at least 6 characters long\r\n* Must contain a letter, a number, and a special character\r\n* Must not contain or be similar to your registered email or Quovo API username", "operationId"=>"MePut", "x-api-path-slug"=>"me-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Your", "Password"]}}, "/users/{user_id}/holdings"=>{"get"=>{"summary"=>"Get a user's holdings", "description"=>"Fetches all holdings for a specific user.", "operationId"=>"UsersHoldingsByUserIdGet", "x-api-path-slug"=>"usersuser-idholdings-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Holdings"]}}, "/users/{user_id}/institution_requests"=>{"post"=>{"summary"=>"Request a new institution", "description"=>"Requests a new financial institution for Quovo to retrieve data from.", "operationId"=>"UsersInstitutionRequestsByUserIdPost", "x-api-path-slug"=>"usersuser-idinstitution-requests-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "New", "Institution"]}}, "/webhooks"=>{"get"=>{"summary"=>"Get all registered webhooks", "description"=>"Retrieve your registered webhooks. \n\nNote: secret is intentionally omitted from all GET requests. It is only returned after being updated or after a new webhook is created.", "operationId"=>"WebhooksGet", "x-api-path-slug"=>"webhooks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registered", "Webhooks"]}, "put"=>{"summary"=>"Update an existing webhook", "description"=>"Used to update an existing webhook.", "operationId"=>"WebhooksPut", "x-api-path-slug"=>"webhooks-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Existing", "Webhook"]}, "post"=>{"summary"=>"Register a new webhook", "description"=>"Used to register new webhooks.", "operationId"=>"WebhooksPost", "x-api-path-slug"=>"webhooks-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "New", "Webhook"]}, "delete"=>{"summary"=>"Delete a webhook", "description"=>"Deletes an existing webhook.", "operationId"=>"WebhooksDelete", "x-api-path-slug"=>"webhooks-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook"]}}, "/connections/{connection_id}/challenges"=>{"get"=>{"summary"=>"Get challenges for a connection", "description"=>"Retrieves any Challenges associated with a connection.", "operationId"=>"ConnectionsChallengesByConnectionIdGet", "x-api-path-slug"=>"connectionsconnection-idchallenges-get", "parameters"=>[{"in"=>"path", "name"=>"connection_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Challengesa", "Connection"]}, "put"=>{"summary"=>"Answer MFA challenges", "description"=>"Answer available MFA Challenges for a connection.", "operationId"=>"ConnectionsChallengesByConnectionIdPut", "x-api-path-slug"=>"connectionsconnection-idchallenges-put", "parameters"=>[{"in"=>"path", "name"=>"connection_id"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Answer", "MFA", "Challenges"]}}, "/holdings"=>{"get"=>{"summary"=>"Get all holdings", "description"=>"Fetches all holdings across all accounts and connections.", "operationId"=>"HoldingsGet", "x-api-path-slug"=>"holdings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Holdings"]}}, "/accounts/{account_id}/holdings"=>{"get"=>{"summary"=>"Get an account's holdings", "description"=>"Fetches all holdings for a specific account.", "operationId"=>"AccountsHoldingsByAccountIdGet", "x-api-path-slug"=>"accountsaccount-idholdings-get", "parameters"=>[{"in"=>"path", "name"=>"account_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Holdings"]}}, "/manual_accounts/{manual_account_id}"=>{"get"=>{"summary"=>"Get a single manual account", "description"=>"Returns a single Manual Account.", "operationId"=>"ManualAccountsByManualAccountIdGet", "x-api-path-slug"=>"manual-accountsmanual-account-id-get", "parameters"=>[{"in"=>"path", "name"=>"manual_account_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Manual", "Account"]}, "put"=>{"summary"=>"Update a manual account", "description"=>"Modifies a Manual Account.", "operationId"=>"ManualAccountsByManualAccountIdPut", "x-api-path-slug"=>"manual-accountsmanual-account-id-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"manual_account_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Manual", "Account"]}, "delete"=>{"summary"=>"Delete a manual account", "description"=>"Deletes a Manual Account.", "operationId"=>"ManualAccountsByManualAccountIdDelete", "x-api-path-slug"=>"manual-accountsmanual-account-id-delete", "parameters"=>[{"in"=>"path", "name"=>"manual_account_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Manual", "Account"]}}, "/accounts/{account_id}/extras"=>{"get"=>{"summary"=>"Fetch an Account's Extras Information", "description"=>"Retrieves an Account's Extras Information.", "operationId"=>"AccountsExtrasByAccountIdGet", "x-api-path-slug"=>"accountsaccount-idextras-get", "parameters"=>[{"in"=>"path", "name"=>"account_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fetch", "Accounts", "Extras", "Information"]}}, "/manual_accounts/{manual_account_id}/manual_holdings"=>{"get"=>{"summary"=>"Get a manual account's holdings", "description"=>"Fetches all of the Portfolio's Manual Assets.", "operationId"=>"ManualAccountsManualHoldingsByManualAccountIdGet", "x-api-path-slug"=>"manual-accountsmanual-account-idmanual-holdings-get", "parameters"=>[{"in"=>"path", "name"=>"manual_account_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Manual", "Accounts", "Holdings"]}, "put"=>{"summary"=>"Update a manual holding", "description"=>"Updates an existing Manual Asset for the given Manual Portfolio.", "operationId"=>"ManualAccountsManualHoldingsByManualAccountIdPut", "x-api-path-slug"=>"manual-accountsmanual-account-idmanual-holdings-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"manual_account_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Manual", "Holding"]}, "post"=>{"summary"=>"Create a manual holding", "description"=>"Creates a new Manual Asset for the given Manual Portfolio.", "operationId"=>"ManualAccountsManualHoldingsByManualAccountIdPost", "x-api-path-slug"=>"manual-accountsmanual-account-idmanual-holdings-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"manual_account_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Manual", "Holding"]}, "delete"=>{"summary"=>"Delete a manual holding", "description"=>"Deletes an existing Manual Asset for the given Manual Portfolio.", "operationId"=>"ManualAccountsManualHoldingsByManualAccountIdDelete", "x-api-path-slug"=>"manual-accountsmanual-account-idmanual-holdings-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"manual_account_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Manual", "Holding"]}}, "/users/{user_id}/manual_accounts"=>{"get"=>{"summary"=>"Get a user's manual accounts", "description"=>"Returns all Manual Portfolios of a given User.", "operationId"=>"UsersManualAccountsByUserIdGet", "x-api-path-slug"=>"usersuser-idmanual-accounts-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Manual", "Accounts"]}, "post"=>{"summary"=>"Create a manual account", "description"=>"Creates a Manual Account.", "operationId"=>"UsersManualAccountsByUserIdPost", "x-api-path-slug"=>"usersuser-idmanual-accounts-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Manual", "Account"]}}, "/accounts/{account_id}/transactions"=>{"get"=>{"summary"=>"Get an account's transactions", "description"=>"Provides information on an account's historical transactions.", "operationId"=>"AccountsTransactionsByAccountIdGet", "x-api-path-slug"=>"accountsaccount-idtransactions-get", "parameters"=>[{"in"=>"path", "name"=>"account_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Transactions"]}}, "/connections/{connection_id}/manual_holdings"=>{"get"=>{"summary"=>"Get a connection's manual holdings", "description"=>"Fetches all Manual Assets for an Account.", "operationId"=>"ConnectionsManualHoldingsByConnectionIdGet", "x-api-path-slug"=>"connectionsconnection-idmanual-holdings-get", "parameters"=>[{"in"=>"path", "name"=>"connection_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connections", "Manual", "Holdings"]}}, "/users/{user_id}/transactions"=>{"get"=>{"summary"=>"Get a user's transactions", "description"=>"Provides historical transactions for a specific user.", "operationId"=>"UsersTransactionsByUserIdGet", "x-api-path-slug"=>"usersuser-idtransactions-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Transactions"]}}, "/manual_accounts"=>{"get"=>{"summary"=>"Get all manual accounts", "description"=>"Retrieves all Manual Accounts across all Users.", "operationId"=>"ManualAccountsGet", "x-api-path-slug"=>"manual-accounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Manual", "Accounts"]}}, "/accounts"=>{"get"=>{"summary"=>"Get all accounts", "description"=>"Fetches all Accounts accross all Users.", "operationId"=>"AccountsGet", "x-api-path-slug"=>"accounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/connections/{connection_id}/holdings"=>{"get"=>{"summary"=>"Get a connection's holdings", "description"=>"Fetches all holdings for a specific connection.", "operationId"=>"ConnectionsHoldingsByConnectionIdGet", "x-api-path-slug"=>"connectionsconnection-idholdings-get", "parameters"=>[{"in"=>"path", "name"=>"connection_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connections", "Holdings"]}}, "/accounts/{account_id}/auth"=>{"get"=>{"summary"=>"Get auth for an account", "description"=>"Retrieves all authentication information associated with an account.", "operationId"=>"AccountsAuthByAccountIdGet2", "x-api-path-slug"=>"accountsaccount-idauth-get", "parameters"=>[{"in"=>"path", "name"=>"account_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authan", "Account"]}}, "/manual_holdings"=>{"get"=>{"summary"=>"Get all manual holdings", "description"=>"Fetches all Manual Holdings accross all users.", "operationId"=>"ManualHoldingsGet", "x-api-path-slug"=>"manual-holdings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Manual", "Holdings"]}}, "/users/{user_id}/ui_token"=>{"post"=>{"summary"=>"Create a UI token", "description"=>"This creates a single use ui token for a user.", "operationId"=>"UsersUiTokenByUserIdPost", "x-api-path-slug"=>"usersuser-idui-token-post", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["UI", "Token"]}}, "/users/{user_id}/manual_holdings"=>{"get"=>{"summary"=>"Get a user's manual holdings", "description"=>"Fetches all Manual Assets for a User.", "operationId"=>"UsersManualHoldingsByUserIdGet", "x-api-path-slug"=>"usersuser-idmanual-holdings-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Manual", "Holdings"]}}, "/transactions/{transaction_id}"=>{"get"=>{"summary"=>"Get a single transaction", "description"=>"Provides information on a single historical transaction.", "operationId"=>"TransactionsByTransactionIdGet", "x-api-path-slug"=>"transactionstransaction-id-get", "parameters"=>[{"in"=>"path", "name"=>"transaction_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Transaction"]}, "put"=>{"summary"=>"Update a transaction", "description"=>"Update an existing historical transaction. \n\nCurrently, only used to update a transaction's expense_category.", "operationId"=>"TransactionsByTransactionIdPut", "x-api-path-slug"=>"transactionstransaction-id-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"transaction_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transaction"]}}, "/users/{user_id}/accounts"=>{"get"=>{"summary"=>"Get a user's accounts", "description"=>"Fetches all Accounts for a specific user.", "operationId"=>"UsersAccountsByUserIdGet", "x-api-path-slug"=>"usersuser-idaccounts-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Accounts"]}}, "/accounts/{account_id}"=>{"get"=>{"summary"=>"Get a single account", "description"=>"Provides information on a single account.", "operationId"=>"AccountsByAccountIdGet", "x-api-path-slug"=>"accountsaccount-id-get", "parameters"=>[{"in"=>"path", "name"=>"account_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Account"]}, "put"=>{"summary"=>"Update an account", "description"=>"Modifies an existing account.", "operationId"=>"AccountsByAccountIdPut", "x-api-path-slug"=>"accountsaccount-id-put", "parameters"=>[{"in"=>"path", "name"=>"account_id"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/institutions/{institution_id}"=>{"get"=>{"summary"=>"Get a single institution", "description"=>"Provides information on a single Quovo-supported institution.", "operationId"=>"InstitutionsByInstitutionIdGet", "x-api-path-slug"=>"institutionsinstitution-id-get", "parameters"=>[{"in"=>"path", "name"=>"institution_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Institution"]}}}}, "apis"=>{"name"=>"Quovo", "x-slug"=>"quovo", "description"=>"Quovo’s API provides methods for retrieving data from financial institutions on behalf of clients, advisors, and other users. This documentation includes detailed explanations of API endpoints and common data definitions. Please note that this documentation does not list all API endpoints. Additionally, you may not have access to all of the listed endpoints depending on the services you’ve purchased from Quovo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28293-quovo.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"391003", "tags"=>"Enterprise,Financial,Financial Services,General Data,Market Data,Profiles,Relative Data,SaaS,Service API,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"quovo/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Quovo", "x-api-slug"=>"quovo", "description"=>"Quovo’s API provides methods for retrieving data from financial institutions on behalf of clients, advisors, and other users. This documentation includes detailed explanations of API endpoints and common data definitions. Please note that this documentation does not list all API endpoints. Additionally, you may not have access to all of the listed endpoints depending on the services you’ve purchased from Quovo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28293-quovo.jpg", "humanURL"=>"http://quovo.com", "baseURL"=>"https://example.com//", "tags"=>"Enterprise,Financial,Financial Services,General Data,Market Data,Profiles,Relative Data,SaaS,Service API,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/quovo/quovo-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog-rss", "url"=>"https://www.quovo.com/fintech-blog/feed/"}, {"type"=>"x-postman-collection", "url"=>"https://www.getpostman.com/collections/82cf673bb22d4f8b8881"}, {"type"=>"x-website", "url"=>"http://quovo.com"}, {"type"=>"x-authentication", "url"=>"https://api.quovo.com/docs/v3/#authentication"}, {"type"=>"x-blog", "url"=>"https://www.quovo.com/fintech-blog/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/quovo"}, {"type"=>"x-developer", "url"=>"https://api.quovo.com/docs/v3/"}, {"type"=>"x-email", "url"=>"audit@quovo.com"}, {"type"=>"x-email", "url"=>"info@quovo.com"}, {"type"=>"x-email", "url"=>"copyright@quovo.com"}, {"type"=>"x-email", "url"=>"support@quovo.com"}, {"type"=>"x-github", "url"=>"https://github.com/quovo"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/quovo"}, {"type"=>"x-webhook", "url"=>"https://api.quovo.com/docs/v3/#webhooks"}, {"type"=>"x-website", "url"=>"https://www.quovo.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
coinfabrik{"coinfabrik-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"CoinFabrik", "x-complete"=>1, "info"=>{"title"=>"Coinbase API", "description"=>"the-coinbase-v2-api", "contact"=>{"name"=>"CoinFabrik", "url"=>"http://www.coinfabrik.com/"}, "version"=>"1.0.0"}, "host"=>"api.coinbase.com", "basePath"=>"/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/users/{user_id}"=>{"get"=>{"summary"=>"Show a user", "description"=>"Get any user’s public information with their ID.", "operationId"=>"get-any-users-public-information-with-their-id", "x-api-path-slug"=>"usersuser-id-get", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"The user id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Show", "User"]}}, "/user"=>{"get"=>{"summary"=>"Show current user", "description"=>"Get current user’s public information. To get user’s email or private information, use permissions wallet:user:email and wallet:user:read.", "operationId"=>"get-current-users-public-information-to-get-users-email-or-private-information-use-permissions-walle", "x-api-path-slug"=>"user-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Show", "Current", "User"]}, "put"=>{"summary"=>"Update current user", "description"=>"Modify current user and their preferences.", "operationId"=>"modify-current-user-and-their-preferences", "x-api-path-slug"=>"user-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Properties to update", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Current", "User"]}}, "/user/auth"=>{"get"=>{"summary"=>"Show authorization information", "description"=>"Get current user’s authorization information including granted scopes and send limits when using OAuth2 authentication.", "operationId"=>"get-current-users-authorization-information-including-granted-scopes-and-send-limits-when-using-oaut", "x-api-path-slug"=>"userauth-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Show", "Authorization", "Information"]}}, "/accounts"=>{"get"=>{"summary"=>"List accounts", "description"=>"Lists current user’s accounts to which the authentication method has access to.", "operationId"=>"lists-current-users-accounts-to-which-the-authentication-method-has-access-to", "x-api-path-slug"=>"accounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "List", "Accounts"]}, "post"=>{"summary"=>"Create account", "description"=>"Creates a new account for user.", "operationId"=>"creates-a-new-account-for-user", "x-api-path-slug"=>"accounts-post", "parameters"=>[{"in"=>"body", "name"=>"account_properties", "description"=>"Account properties", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Account"]}}, "/accounts/{account_id}"=>{"get"=>{"summary"=>"Show an account", "description"=>"Show current user’s account. To access user’s primary account, primary keyword can be used instead of the account id in the URL.", "operationId"=>"show-current-users-account-to-access-users-primary-account-primary-keyword-can-be-used-instead-of-th", "x-api-path-slug"=>"accountsaccount-id-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"The account id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Show", "Account"]}, "put"=>{"summary"=>"Update account", "description"=>"Modifies user’s account name.", "operationId"=>"modifies-users-account-name", "x-api-path-slug"=>"accountsaccount-id-put", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"The account id"}, {"in"=>"body", "name"=>"account_properties", "description"=>"Properties to update", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Account"]}, "delete"=>{"summary"=>"Delete account", "description"=>"Removes user’s account. In order to remove an account it can’t be\n\n- Primary account\n- Account with non-zero balance\n- Fiat account\n- Vault with a pending withdrawal", "operationId"=>"removes-users-account-in-order-to-remove-an-account-it-cant-be-primary-account-account-with-nonzero-", "x-api-path-slug"=>"accountsaccount-id-delete", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"The account id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Account"]}}, "/accounts/{account_id}/primary"=>{"get"=>{"summary"=>"Set account as primary", "description"=>"Promote an account as primary account.", "operationId"=>"promote-an-account-as-primary-account", "x-api-path-slug"=>"accountsaccount-idprimary-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"The account id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Set", "Account", "As", "Primary"]}}, "/accounts/{account_id}/addresses"=>{"get"=>{"summary"=>"List addresses", "description"=>"Lists addresses for an account.\n\n*Important*: Addresses should be considered one time use only.", "operationId"=>"lists-addresses-for-an-accountimportant-addresses-should-be-considered-one-time-use-only", "x-api-path-slug"=>"accountsaccount-idaddresses-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"The account id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "List", "Addresses"]}, "post"=>{"summary"=>"Create address", "description"=>"Creates a new address for an account. As all the arguments are optinal, it’s possible just to do a empty POST which will create a new address. This is handy if you need to create new receive addresses for an account on-demand.\nAddresses can be created for all account types. With fiat accounts, funds will be received with Instant Exchange.", "operationId"=>"creates-a-new-address-for-an-account-as-all-the-arguments-are-optinal-its-possible-just-to-do-a-empt", "x-api-path-slug"=>"accountsaccount-idaddresses-post", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"The account id"}, {"in"=>"body", "name"=>"address_properties", "description"=>"Properties to update", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Address"]}}, "/accounts/{account_id}/addresses/{address_id}"=>{"get"=>{"summary"=>"Show an address", "description"=>"Show an individual address for an account.\nRegular bitcoin address can be used in place of address_id but the address has to be associated to the correct account.\n \n*Important* Addresses should be considered one time use only.", "operationId"=>"show-an-individual-address-for-an-accountregular-bitcoin-address-can-be-used-in-place-of-address-id-", "x-api-path-slug"=>"accountsaccount-idaddressesaddress-id-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"The account id"}, {"in"=>"path", "name"=>"address_id", "description"=>"The account id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Show", "Address"]}}, "/accounts/{account_id}/addresses/{address_id}/transactions"=>{"get"=>{"summary"=>"List address’s transactions", "description"=>"list transactions that have been sent to a specific address. Regular bitcoin address can be used in place of address_id but the address has to be associated to the correct account.", "operationId"=>"list-transactions-that-have-been-sent-to-a-specific-address-regular-bitcoin-address-can-be-used-in-p", "x-api-path-slug"=>"accountsaccount-idaddressesaddress-idtransactions-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"The account id"}, {"in"=>"path", "name"=>"address_id", "description"=>"The account id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "List", "Address’s", "Transactions"]}}, "/accounts/{account_id}/transactions"=>{"get"=>{"summary"=>"List transactions", "description"=>"Lists account’s transactions. See Transaction resource for more information.", "operationId"=>"lists-accounts-transactions-see-transaction-resource-for-more-information", "x-api-path-slug"=>"accountsaccount-idtransactions-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"The account id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "List", "Transactions"]}, "post"=>{"summary"=>"Send or request money", "description"=>"Type=send\n=========\n\nSend funds to a bitcoin address or email address. No transaction fees are required for off blockchain transactions, and Coinbase waives fees for on-blockchain transactions greater than 0.0001 BTC, up to a threshold of 25 per day. Read more about free transactions.\n\nWhen used with OAuth2 authentication, this endpoint requires two factor authentication unless used with wallet:transactions:send:bypass-2fa scope.\n\nIf the user is able to buy bitcoin, they can send funds from their fiat account using instant exchange feature. Buy fees will be included in the created transaction and the recipient will receive the user defined amount.\n\nTo create a multisig transaction, visit Multisig documentation.\n\nType=request\n============\n\nRequests money from an email address.", "operationId"=>"typesendsend-funds-to-a-bitcoin-address-or-email-address-no-transaction-fees-are-required-for-off-bl", "x-api-path-slug"=>"accountsaccount-idtransactions-post", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"The account id"}, {"in"=>"body", "name"=>"transaction_options", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Send", "Request", "Money"]}}, "/accounts/{account_id}/transactions/{transaction_id}"=>{"get"=>{"summary"=>"Show a transaction", "description"=>"Show an individual transaction for an account. See Transaction resource for more information.", "operationId"=>"show-an-individual-transaction-for-an-account-see-transaction-resource-for-more-information", "x-api-path-slug"=>"accountsaccount-idtransactionstransaction-id-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"The account id"}, {"in"=>"path", "name"=>"transaction_id", "description"=>"The transaction id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Show", "Transaction"]}, "delete"=>{"summary"=>"Cancel request money", "description"=>"Lets a user cancel a money request. Money requests can be canceled by the sender or the recipient.", "operationId"=>"lets-a-user-cancel-a-money-request-money-requests-can-be-canceled-by-the-sender-or-the-recipient", "x-api-path-slug"=>"accountsaccount-idtransactionstransaction-id-delete", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"The account id"}, {"in"=>"path", "name"=>"transaction_id", "description"=>"The transaction id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Cancel", "Request", "Money"]}}, "/accounts/{account_id}/transactions/{transaction_id}/complete"=>{"post"=>{"summary"=>"Complete request money", "description"=>"Lets the recipient of a money request complete the request by sending money to the user who requested the money. This can only be completed by the user to whom the request was made, not the user who sent the request.", "operationId"=>"lets-the-recipient-of-a-money-request-complete-the-request-by-sending-money-to-the-user-who-requeste", "x-api-path-slug"=>"accountsaccount-idtransactionstransaction-idcomplete-post", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"The account id"}, {"in"=>"path", "name"=>"transaction_id", "description"=>"The transaction id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Complete", "Request", "Money"]}}, "/accounts/{account_id}/transactions/{transaction_id}/resend"=>{"post"=>{"summary"=>"Re-send request money", "description"=>"Lets the user resend a money request. This will notify recipient with a new email.", "operationId"=>"lets-the-user-resend-a-money-request-this-will-notify-recipient-with-a-new-email", "x-api-path-slug"=>"accountsaccount-idtransactionstransaction-idresend-post", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"The account id"}, {"in"=>"path", "name"=>"transaction_id", "description"=>"The transaction id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Re-send", "Request", "Money"]}}}}, "apis"=>{"name"=>"CoinFabrik", "x-slug"=>"coinfabrik", "description"=>"Our smart contract development and full stack blockchain development services are supported by more than 20 years of experience building and reviewing secure applications. CoinFabrik is a full stack blockchain development company. Our expertise range from extending cryptocurrency nodes like Bitcoin and Ethereum to providing high level APIs and UIs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/coinfabrik.png", "x-kinRank"=>"7", "x-alexaRank"=>"970321", "tags"=>"Blockchain,General Data,SaaS", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"coinfabrik/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"CoinFabrik", "x-api-slug"=>"coinfabrik", "description"=>"Our smart contract development and full stack blockchain development services are supported by more than 20 years of experience building and reviewing secure applications. CoinFabrik is a full stack blockchain development company. Our expertise range from extending cryptocurrency nodes like Bitcoin and Ethereum to providing high level APIs and UIs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/coinfabrik.png", "humanURL"=>"https://www.coinfabrik.com", "baseURL"=>"https://api.coinbase.com//v2", "tags"=>"Blockchain,General Data,SaaS", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/coinfabrik/coinfabrik-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog-rss", "url"=>"https://blog.coinfabrik.com/feed/"}, {"type"=>"x-github", "url"=>"https://github.com/CoinFabrik"}, {"type"=>"x-openapi", "url"=>"https://raw.githubusercontent.com/CoinFabrik/coinbase-api-swagger/master/swagger.json"}, {"type"=>"x-blog", "url"=>"https://blog.coinfabrik.com/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/coinfabrik"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/coinfabrik"}, {"type"=>"x-website", "url"=>"https://www.coinfabrik.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
coord{"coord-bike-share-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Coord", "x-complete"=>1, "info"=>{"title"=>"Bike Share API", "description"=>"the-bike-share-api-is-a-comprehensive-api-that-provides-information-about-bike-sharesystems-including-available-bikes-and-prices-for-an-example-of-how-to-use-the-bike-share-api-see-the-a-hrefhttpscoord-coquickstartbikeshare-target-blankbike-share-guidea--examplesearch-for-a-bikecurl-g-httpsapi-coord-cov1bikelocationlatitude40-73935542longitude73-99931783radius-km0-1access-keyyour-api-keythe-api-methods-allow-you-to-search-for-available-bikes-and-get-quotes-on-bike-rentalsas-well-as-get-detailed-information-about-bike-share-systems-and-bike-share-locations-bike-share-systems-have-one-or-more-locations--since-bikes-in-a-bike-share-system-may-be-in-adock-or-individually-parked-a-bike-location-can-refer-to-either-a-dock-or-a-single-separatelyparked-bike--therefore-a-search-for-bike-locations-is-really-a-search-for-rideable-bikes-bikes-that-are-currently-inuse-or-otherwise-not-ready-for-rental-are-not-searchable-throughthis-api-the-simplest-method-to-call-is-locationreference0findbikesbylocation-with-a-targetlatitude-and-longitude-and-a-search-radius--this-will-return-all-available-locations-withinthat-radius-and-information-about-each-location-calling-quotereference0getquote-will-return-all-quotes-for-allsystems-or-if-provided-with-specific-system-ids-quotes-for-just-the-specified-systems-calls-to-systemsystem-idreference0getbikesystem-orlocationsystem-idlocation-idreference0getbikelocation-are-helpful-toget-more-information-about-individual-systems-or-locations-respectively-calling-systemreference0findbikesystemsbylocation-with-a-target-latitude-and-longitudeand-a-search-radius-will-return-all-systems-within-that-radius-and-information-about-eachsystem--quotes-and-passesquotes-are-the-cost-and-details-of-renting-a-single-bike-from-a-system--they-consist-of-aset-of-pass-types-where-each-type-defines-a-buyable-pass-for-a-system--a-passrepresents-the-right-to-rent-bikes-from-a-single-system-for-a-certain-length-of-time-or-acertain-number-of-rides--for-instance-you-could-see-a-single-ride-pass-a-single-day-passa-30day-pass-or-an-annual-pass-passes-also-come-with-usage-fees-that-represent-the-cost-of-riding-a-bike-for-a-certainlength-of-time-within-a-given-rental--to-model-systems-that-charge-solely-by-the-length-ofeach-ride-with-no-upfront-charge-we-return-a-single-0-pass-type-representing-the-systemspricing-in-general-with-charge-by-time-set-to-true--finally-we-have-information-about-thetax-rate-this-pass-could-be-subject-to-here-is-an-example-3day-pass-that-costs-24-00-where-rides-over-30-minutes-are-billed-at-5-per15-minutes---id-2--system-id-citibike--max-days-3--charge-by-time-false--cost-----currency-usd----amount-2400----usage-fees-----cost-------currency-usd------amount-500--------prorated-false----start-time-seconds-1800----fee-increment-seconds-900----tax-regions-----name-new-york-city----tax-rate-0-08875-------name-jersey-city----tax-rate-0-07--here-is-an-example-7-95-singleride-pass-with-usage-fees-and-tax-details-omitted--id-1--system-id-citibike--max-rides-1--charge-by-time-false--cost-----currency-usd----amount-795----usage-fees------------tax-regions----------and-heres-an-example-from-a-pay-as-you-go-system-that-charges-2-for-30-minutes-and-7-cents-aminute-thereafter--as-you-can-see-usage-fees-are-cumulative-they-all-get-charged-togetheras-a-single-ride-increases-in-length-and-passes-each-of-their-start-time-seconds-values---id-3--system-id-jumpdc--charge-by-time-true--usage-fees-----cost-------currency-usd------amount-200--------prorated-false----start-time-seconds-0-------cost-------currency-usd------amount-7--------prorated-false----start-time-seconds-1800----fee-increment-seconds-60----tax-regions----------", "version"=>"1.0.0"}, "host"=>"api.coord.co", "basePath"=>"/v1/bike", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/location"=>{"get"=>{"summary"=>"Get bike locations in the requested search area, as a GeoJSON FeatureCollection.", "description"=>"Get a list of locations given the input parameters. Specify a search area by radius around\na latitude and longitude, as well as any filter for specific systems. Each location will\nbe a GeoJSON Feature, and aggregated into a GeoJSON FeatureCollection.\n\n### Example\n\n#### Request:\n`curl -G \"https://api.coord.co/v1/bike/location?latitude=40.742868&longitude=-73.989186&radius_km=0.25&access_key=\"`\n\n#### Response:\n```\n{\n \"features\": [\n {\n \"geometry\": {\n \"coordinates\": [\n -73.98918628692627,\n 40.74286877312112\n ],\n \"type\": \"Point\"\n },\n \"id\": \"CitiBike-3641\",\n \"properties\": {\n \"is_renting\": true,\n \"is_returning\": true,\n \"last_reported\": \"2018-05-17T15:39:24.000Z\",\n \"lat\": 40.74286877312112,\n \"location_id\": \"3641\",\n \"location_type\": \"bike_station_dock\",\n \"lon\": -73.98918628692627,\n \"name\": \"Broadway & W 25 St\",\n \"num_bikes_available\": 53,\n \"num_docks_available\": 1,\n \"region_id\": \"71\",\n \"system_id\": \"CitiBike\"\n },\n \"type\": \"Feature\"\n },\n {\n \"geometry\": {\n \"coordinates\": [\n -73.99144871,\n 40.74395411\n ],\n \"type\": \"Point\"\n },\n \"id\": \"CitiBike-466\",\n \"properties\": {\n \"is_renting\": true,\n \"is_returning\": true,\n \"last_reported\": \"2018-05-17T15:32:40.000Z\",\n \"lat\": 40.74395411,\n \"location_id\": \"466\",\n \"location_type\": \"bike_station_dock\",\n \"lon\": -73.99144871,\n \"name\": \"W 25 St & 6 Ave\",\n \"num_bikes_available\": 35,\n \"region_id\": \"71\",\n \"system_id\": \"CitiBike\"\n },\n \"type\": \"Feature\"\n }\n ],\n \"type\": \"FeatureCollection\"\n}\n```", "operationId"=>"search_locations", "x-api-path-slug"=>"location-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}, {"in"=>"query", "name"=>"latitude", "description"=>"Latitude to return results for"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude to return results for"}, {"in"=>"query", "name"=>"radius_km", "description"=>"Distance, in kilometers, from (latitude, longitude) we will return results for"}, {"in"=>"query", "name"=>"system_ids", "description"=>"Comma separated list of the bike system IDs to include in the search"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bike", "Locations", "In", "Requested", "Search", "Area", "", "As", "GeoJSON", "FeatureCollection"]}}, "/location/{system_id}/{location_id}"=>{"get"=>{"summary"=>"Get detailed information on a bike location, as a GeoJSON Feature.", "description"=>"A bike location may be a single bike station (which can have multiple docked bikes) or a\nsingle dockless bike itself. All working docks are returned, but only free and rentable\ndockless bikes are returned.\n\n### Example\n\n#### Request:\n`curl -G \"https://api.coord.co/v1/bike/location/CitiBike/482?access_key=\"`\n\n#### Response:\n```\n{\n \"geometry\": {\n \"coordinates\": [\n -73.99931783,\n 40.73935542\n ],\n \"type\": \"Point\"\n },\n \"id\": \"CitiBike-482\",\n \"properties\": {\n \"is_renting\": true,\n \"is_returning\": true,\n \"last_reported\": \"2018-05-17T15:41:06.000Z\",\n \"lat\": 40.73935542,\n \"location_id\": \"482\",\n \"location_type\": \"bike_station_dock\",\n \"lon\": -73.99931783,\n \"name\": \"W 15 St & 7 Ave\",\n \"num_bikes_available\": 19,\n \"num_docks_available\": 19,\n \"region_id\": \"71\",\n \"system_id\": \"CitiBike\"\n },\n \"type\": \"Feature\"\n}\n```", "operationId"=>"get_bike_location", "x-api-path-slug"=>"locationsystem-idlocation-id-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Detailed", "Information", "On", "Bike", "Location", "", "As", "GeoJSON", "Feature"]}}, "/quote"=>{"get"=>{"summary"=>"Get the cost of renting a bike.", "description"=>"Provide price quotes for renting a bike. There can be multiple quotes per system, reflecting\ndifferent options for buying membership such as single-ride, single-day, and multi-day\npasses. Please keep in mind that quotes are estimates.\n\n### Example\n\n#### Request:\n`curl -G \"https://api.coord.co/v1/bike/quote?access_key=\"`\n\n#### Response:\n```\n[\n {\n \"cost\": {\n \"amount\": 108,\n \"currency\": \"USD\"\n },\n \"id\": 2,\n \"max_days\": 1,\n \"system_id\": \"CitiBike\",\n \"tax_regions\": [{\n \"name\": \"New York City\",\n \"tax_rate\": 0.08875\n }, {\n \"name\": \"Jersey City\",\n \"tax_rate\": 0.07\n }],\n \"usage_fees\": [\n {\n \"cost\": {\n \"amount\": 200,\n \"currency\": \"USD\"\n },\n \"id\": 1,\n \"pass_type_id\": 2,\n \"prorated\": false,\n \"start_time_seconds\": 1800\n },\n {\n \"cost\": 1.5,\n \"fee_increment_seconds\": 900,\n \"prorated\": false,\n \"start_time_seconds\": 3600\n }\n ]\n },\n {\n \"cost\": {\n \"amount\": 272,\n \"currency\": \"USD\"\n },\n \"id\": 3,\n \"max_days\": 3,\n \"system_id\": \"CitiBike\",\n \"tax_regions\": [{\n \"name\": \"New York City\",\n \"tax_rate\": 0.08875\n }, {\n \"name\": \"Jersey City\",\n \"tax_rate\": 0.07\n }],\n \"usage_fees\": [\n {\n \"cost\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"fee_increment_seconds\": 900,\n \"prorated\": false,\n \"start_time_seconds\": 1800\n }\n ]\n }\n]\n```", "operationId"=>"get_quote", "x-api-path-slug"=>"quote-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}, {"in"=>"query", "name"=>"system_ids", "description"=>"A comma separated list of the bike systems that the user wants quotes for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cost", "Of", "Renting", "Bike"]}}, "/system"=>{"get"=>{"summary"=>"Get information on all bike systems in an area, as a GeoJSON FeatureCollection.", "description"=>"Bike systems are individual bike share systems, often per-region.\n\nInformation about each system is returned as a GeoJSON Feature, within a single GeoJSON\nFeatureCollection.\n\nSee the [/system/{system_id}](#reference/0/get-information-for-a-bike-system) call for more\ndetails on the individual system Features.\n\n### Example\n\n#### Request:\n`curl -G \"https://api.coord.co/v1/bike/system?latitude=40.74286877312112&longitude=-73.98918628692627&radius_km=0.5&access_key=\"`\n\n#### Response:\n```\n{\n \"features\": [\n {\n \"geometry\": {\n \"coordinates\": [\n [\n [\n [\n -74.055701,\n 40.707838\n ],\n [\n -74.083639,\n 40.714807\n ],\n ...,\n [\n -74.055701,\n 40.707838\n ]\n ]\n ]\n ],\n \"type\": \"MultiPolygon\"\n },\n \"id\": \"CitiBike\",\n \"properties\": {\n \"is_transactable\": true,\n \"station_type\": \"dock\"\n },\n \"type\": \"Feature\"\n }\n ],\n \"type\": \"FeatureCollection\"\n}\n```", "operationId"=>"search_bike_systems", "x-api-path-slug"=>"system-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}, {"in"=>"query", "name"=>"latitude", "description"=>"Latitude to return results for"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude to return results for"}, {"in"=>"query", "name"=>"radius_km", "description"=>"Distance, in kilometers, from (latitude, longitude) we will return results for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Information", "On", "", "Bike", "Systems", "In", "Area", "", "As", "GeoJSON", "FeatureCollection"]}}, "/system/{system_id}"=>{"get"=>{"summary"=>"Get detailed information on a bike system, as a GeoJSON feature.", "description"=>"Bike systems are individual bike share systems, often per-region.\n\nInformation is returned as a GeoJSON Feature. The geometry of the GeoJSON Feature is\na MultiPolygon that defines the system's operational area. All bike systems have an\noperational area, in which bikes may be found and parked.\nFor systems that require bikes be docked, this area is somewhat arbitrary, as bikes are\nonly found at stations. In this case, the operational area is roughly the city or\njurisdiction that the system covers.\nFor semi-dockless and dockless systems that allow bikes to be parked anywhere, the\noperational area is very important and strictly defined. Often there are extra fees for\nparking outside of the operational area (also known as a \"catchment area\"), and almost all\nbikes should be within the area.\n\nThese bike system types are reflected in the `station_type` property.\n* `dock` - All bikes must be taken from and returned to a dock.\n* `dockless` - All bikes are only dockless.\n* `dockless_with_hub` - Bikes may be dockless, or taken from or returned to a hub.\nA hub can be an area rather than a discrete station, where a bike can be returned and\nlocked but not explicitly docked. The total price of a rental may change based on whether\na bike is returned to a hub or not.\n\nAreas are returned as a GeoJSON MultiPolygon since areas may be discontiguous or have\nholes.\n\n### Example\n\n#### Request:\n`curl -G \"https://api.coord.co/v1/bike/system/CitiBike?access_key=\"`\n\n#### Response:\n```\n{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"MultiPolygon\",\n \"coordinates\": [\n [\n [ [-74.00, 40.70], [-74.00, 40.80], [-73.90, 40.80], ..., [-74.00, 40.70] ]\n ],\n ...,\n [\n [ [-73.00, 41.70], [-73.00, 41.80], [-72.90, 41.80], ..., [-73.00, 41.70] ],\n [ [-72.98, 41.75], [-72.98, 41.78], [-72.95, 41.78], ..., [-72.98, 41.75] ]\n ]\n ]\n },\n \"id\": \"CitiBike\",\n \"properties\": {\n \"email\": \"support@coord.co\",\n \"phone_number\": \"+6789998212\",\n \"station_type\": \"dock\",\n \"is_transactable\": \"false\"\n }\n}\n```", "operationId"=>"get_bike_system", "x-api-path-slug"=>"systemsystem-id-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Detailed", "Information", "On", "Bike", "System", "", "As", "GeoJSON", "Feature"]}}}}, "coord-shared-vehicle-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Coord", "x-complete"=>1, "info"=>{"title"=>"Shared Vehicle (Bike+Scooter) API", "description"=>"the-shared-vehicle-api-is-a-comprehensive-api-that-provides-information-about-bike-and-scooter-share-systems-including-available-vehicles-and-prices-", "version"=>"1.0.0"}, "host"=>"api.coord.co", "basePath"=>"/v1/sv/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/location"=>{"get"=>{"summary"=>"Find Vehicles by location", "description"=>"Get locations in the requested search area, as a GeoJSON FeatureCollection.", "operationId"=>"findVehiclesbyLocation", "x-api-path-slug"=>"location-get", "parameters"=>[{"in"=>"query", "name"=>"latitude", "description"=>"Latitude to return results for", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude to return results for", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"radius_km", "description"=>"Distance, in kilometers, from (latitude, longitude) we will return results for", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scooters", "Bikes"]}}}}, "coord-tolls-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Coord", "x-complete"=>1, "info"=>{"title"=>"Tolls API", "description"=>"the-tolls-api-is-a-readonly-service-to-answer-questions-about-theprices-and-locations-of-toll-roads-some-tolls-are-charged-at--single-points--so-you-pay-them-when-you-cross-atoll-gate-or-pass-a-toll-booth--other-tolls-are--distancebased--the-amountthat-you-pay-depends-on-where-you-enter-a-toll-road-and-also-where-youexit--some-toll-roads-charge-different-prices-by--time-of-day--and-some-aretotally--dynamic--changing-their-price-depending-on-demand-at-a-given-time-note-that-while-we-support-distance-based-tolls-that-are-applied-using-tollgates-or-booths-we-currently-do-not-support-mileagebased-user-fees-thatare-assessed-based-on-odometer-readings-we-provide-toll-information-in-four-different-ways---we-can-tell-you-how-much-you-will-pay-based-on-your-trips-gps-trajectory-----to-find-this-out-use-the-gps-tracereference0tollsonagpstrace-post-request----we-can-tell-you-how-much-you-will-pay-to-drive-a-given-route-----to-find-this-out-use-the-routereference0tollsonaroute-post-request----we-can-tell-you-the-full-payment-details-of-all-the-toll-locations-in----an-area-using-the-tollreference0tollsinanarea-get-request----we-can-tell-you-the-payment-details-of-a-single-toll-location----using-the-tollidreference0tolldetails-get-request-in-all-four-cases-we-can-return-multiple-costs-for-a-single-toll--this-is-becausethe-amount-a-user-pays-can-depend-on-the-kind-of-vehicle-the-occupancy-and-thepayment-method--to-figure-out-how-much-a-particular-user-pays-you-must-know-therequisite-information-about-them-and-find-the-matching-cost-for-more-information-about-how-the-tolls-api-can-be-used-see-the-a-hrefhttpscoord-coquickstarttolls-target-blanktoll-guidea-", "version"=>"1.0.0"}, "host"=>"api.coord.co", "basePath"=>"/v1/search/tolling", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/gps_trace"=>{"post"=>{"summary"=>"Get toll rates corresponding to a sequence of timestamped GPS locations", "description"=>"Returns information about the toll cost of a route given the GPS trace along the route.\n\nBelow is an example of a request:\n```json\n{\n \"locations\": [\n {\n \"timestamp\": \"2017-07-28T17:39:00.000Z\",\n \"lat\": 47.28348,\n \"lng\": -122.56066\n },\n {\n \"timestamp\": \"2017-07-28T17:39:30.000Z\",\n \"lat\": 47.28154,\n \"lng\": -122.56069\n },\n {\n \"timestamp\": \"2017-07-28T17:40:00.000Z\",\n \"lat\": 47.28000,\n \"lng\": -122.56075\n },\n {\n \"timestamp\": \"2017-07-28T17:40:30.000Z\",\n \"lat\": 47.27901,\n \"lng\": -122.56081\n },\n {\n \"timestamp\": \"2017-07-28T17:41:00.000Z\",\n \"lat\": 47.27900,\n \"lng\": -122.56081\n },\n {\n \"timestamp\": \"2017-07-28T17:41:30.000Z\",\n \"lat\": 47.27831,\n \"lng\": -122.56082\n },\n {\n \"timestamp\": \"2017-07-28T17:42:00.000Z\",\n \"lat\": 47.27823,\n \"lng\": -122.56082\n },\n {\n \"timestamp\": \"2017-07-28T17:42:30.000Z\",\n \"lat\": 47.27798,\n \"lng\": -122.56082\n }\n ],\n \"vehicle\": {\n \"axles\": 2\n }\n}\n```\n\nThe order of the `coordinates` and `timestamps` matters. Also, `coordinates` are\none-to-one mapped to `timestamps`. The response would look like:\n ```json\n [\n {\n \"checkpoints\": [\n {\n \"end\": {\n \"lat\": 42.348327,\n \"lng\": -71.103810\n },\n \"start\": {\n \"lat\": 42.348411,\n \"lng\": -71.104341\n }\n }\n ],\n \"estimated_cross_time\": \"2014-11-06T17:08:36.000Z\",\n \"id\": 1467,\n \"name\": \"Allston (EB)\",\n \"prices\": [...],\n \"roadway_name\": \"Massachusetts Turnpike\"\n }\n ]\n ```", "operationId"=>"get_cost_for_gps_trace", "x-api-path-slug"=>"gps-trace-post", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}, {"in"=>"body", "name"=>"body", "description"=>"A sequence of timestamped GPS locations in chronological order", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GPS", "Trace"]}}, "/route"=>{"post"=>{"summary"=>"Get all toll rates corresponding to a single route", "description"=>"Returns information about the cost of a particular route due to tolls.\n\nBelow is an example of a route:\n```json\n{\n \"departure_time\": \"2017-07-28T17:39:43.611Z\",\n \"steps\": [\n {\n \"polyline\": [\n {\"lat\": 47.28348, \"lng\": -122.56066},\n {\"lat\": 47.28154, \"lng\": -122.56069},\n {\"lat\": 47.28000, \"lng\": -122.56075},\n {\"lat\": 47.27901, \"lng\": -122.56081},\n {\"lat\": 47.27900, \"lng\": -122.56081},\n {\"lat\": 47.27831, \"lng\": -122.56082},\n {\"lat\": 47.27823, \"lng\": -122.56082},\n {\"lat\": 47.27798, \"lng\": -122.56082}\n ]\n }\n ],\n \"vehicle\": {\n \"axles\": 2\n }\n}\n```\n\nIf you already have a list of waypoints along a route, you can use these directly, but if\nnot, you can use a routing service like\n\nGoogle's Directions API\n to estimate the cost of travel between a given origin and destination.\n\nFor example, imagine we are interested in the\ntoll cost of a route between origin `47.287741,-122.561391` and\ndestination `47.258214,-122.537900` (you may use street names instead of coordinates):\n\n* Make a request to Google's Directions API and get the route(s)\n between these two locations, e.g.:\n ```\n https://maps.googleapis.com/maps/api/directions/json?origin=47.287741,-122.561391&destination=47.258214,-122.537900\n ```\n* The result will be a JSON which includes one or more routes where each route has one or\n more legs and each leg has one or more steps:\n\n Therefore, if the result of above request is:\n ```json\n {...\n \"routes\": [\n {...\n \"legs\": [\n {...\n \"steps\": [\n {\n \"duration\": {\n \"text\": \"2 mins\",\n \"value\": 117\n },\n \"html_instructions\": \"Head south on WA-16 EToll road\",\n \"polyline\": {\n \"points\": \"m{r_Hnw`kVb@Qn@Up@Sr@QvAWjAO|@I^A^Mj@Ap@@v@?r@@hA@dB?bKDrHJdEJ@?hC@N?p@?`@?t@Cf@Gp@Kh@Kb@KXIVI`@O`@QXMd@WVOj@SZUf@_@b@c@l@s@vCwDfCiDjBkC~BcDlBiC|@mAZc@dPsTvCyDrEmGdEwFnDwErEiGdB}Bb@g@d@i@jBgC\"\n },\n \"travel_mode\": \"DRIVING\"\n },\n {\n \"duration\": {\n \"text\": \"1 min\",\n \"value\": 38\n },\n \"html_instructions\": \"Take exit 4 for Jackson Ave toward 6th AveToll road\",\n \"polyline\": {\n \"points\": \"o{m_Hhh}jVJCBA@AHIx@eA\\\\e@^g@lAiBp@iAf@{@|D{G\\\\o@`@q@n@gA`C{DNYHSDQFU\"\n },\n \"travel_mode\": \"DRIVING\"\n }\n ],\n }\n ], ...\n }\n ], ...\n }\n ```\n* For each route, iterate on all steps (of all legs) and create a `RouteStep`\n for each step, so that `encoded_polyline` is filled by `polyline.points`,\n `road_name` by `html_instructions`, and `duration` by `duration.value`. The result should look like:\n ```json\n {\n \"steps\": [\n {\n \"encoded_polyline\": \"m{r_Hnw`kVb@Qn@Up@Sr@QvAWjAO|@I^A^Mj@Ap@@v@?r@@hA@dB?bKDrHJdEJ@?hC@N?p@?`@?t@Cf@Gp@Kh@Kb@KXIVI`@O`@QXMd@WVOj@SZUf@_@b@c@l@s@vCwDfCiDjBkC~BcDlBiC|@mAZc@dPsTvCyDrEmGdEwFnDwErEiGdB}Bb@g@d@i@jBgC\",\n \"road_name\": \"Head south on WA-16 E\",\n \"duration\": \"117s\"\n },\n {\n \"encoded_polyline\": \"m{r_Hnw`kVb@Qn@Up@Sr@QvAWjAO|@I^A^Mj@Ap@@v@?r@@hA@dB?bKDrHJdEJ@?hC@N?p@?`@?t@Cf@Gp@Kh@Kb@KXIVI`@O`@QXMd@WVOj@SZUf@_@b@c@l@s@vCwDfCiDjBkC~BcDlBiC|@mAZc@dPsTvCyDrEmGdEwFnDwErEiGdB}Bb@g@d@i@jBgC\",\n \"road_name\": \"Take exit 4 for Jackson Ave toward 6th Ave\",\n \"duration\": \"38s\"\n }\n ],\n \"departure_time\": \"2017-07-28T17:39:43.611Z\",\n \"vehicle\": {\n \"axles\": 2\n }\n }\n ```\n\nNote: Google's `html_instructions` is not really equivalent to `road_name` but it usually\ncontains road names. For simplicity, you can use `html_instructions` as road name. If\nyour router provides road names then use that instead.\n\nNote: In case Google's Directions API returns `n` routes you will\nneed to call the Tolls API `n` times, once per route.\n\nNote: The order of the steps should remain the same as the order returned\nby the router.", "operationId"=>"get_cost_for_route", "x-api-path-slug"=>"route-post", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}, {"in"=>"body", "name"=>"route", "description"=>"A description of the route being taken", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Routes"]}}, "/toll"=>{"get"=>{"summary"=>"Get all tolls in an area defined by a center location and a radius", "description"=>"Returns information on all tolls within a given radius.", "operationId"=>"details_by_area", "x-api-path-slug"=>"toll-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}, {"in"=>"query", "name"=>"latitude", "description"=>"Latitude to return results for"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude to return results for"}, {"in"=>"query", "name"=>"radius_km", "description"=>"Distance, in kilometers, from (`latitude`, `longitude`) we will returnresults for"}, {"in"=>"query", "name"=>"return_geometry", "description"=>"Should we return geometry in the response?"}, {"in"=>"query", "name"=>"return_price", "description"=>"Should we return prices in the response?"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tolls"]}}, "/toll/{id}"=>{"get"=>{"summary"=>"Get the details (e.g. pricing) of a toll specified by toll's ID", "description"=>"Returns full pricing and location details for a single toll location\nacross all times, vehicle types, and payment methods.", "operationId"=>"details_by_id", "x-api-path-slug"=>"tollid-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the toll location to retrieve"}, {"in"=>"query", "name"=>"return_geometry", "description"=>"Should we return geometry in the response?"}, {"in"=>"query", "name"=>"return_price", "description"=>"Should we return prices in the response?"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tolls"]}}}}, "coord-parking-access-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Coord", "x-complete"=>1, "info"=>{"title"=>"Parking Access API", "description"=>"the-parking-access-api-allows-you-to-authorize-one-of-your-end-users-to-park-at-a-supportedparking-location-by-means-of-creating-a-new-parkingsession-for-your-user-at-the-location-for-a-list-of-supported-locations-seea-hrefhttpscoord-codocssearchparking-target-blankthe-parking-search-apia-you-may-only-call-the-accessparking-api-using-parkinglocation-ids-returned-from-the-searchapi-for-locations-where-online-access-type-is-set-to-something-other-than-not-available-all-other-ids-will-be-rejected--parking-creating-a-sessionto-allow-a-user-to-park-at-a-given-lot-or-garage-you-create-a-session-for-that-user-atthe-location-you-can-create-a-new-session-by-callingpost-location-idsessionreference0createandretrievesessionscreateanewsessionwhich-will-return-a-new-session-that-either-is-already-started-has-an-end-time-set-orcontains-any-information-necessary-to-display-to-your-end-user-to-start-the-session-forexample-a-barcode-that-must-be-scanned-in-at-the-location-to-authorize-access--apicontrolled-sessionssessions-that-come-back-with-a-start-time-already-set-are-apicontrolled-meaning-thatthe-location-itself-has-no-way-of-telling-when-your-user-enters-or-leaves-but-insteaddepends-on-you-to-do-this-through-the-api--for-these-sessions-you-must-eventually-callput-location-idsessionsession-idendreference0endingsessionsendapreviouslystartedsessionto-end-the-session-at-which-point-billing-info-will-be-attached-and-returned-in-the-response-typically-you-would-provide-a-way-for-your-end-user-to-tell-you-that-they-are-leaving-theparking-lot-and-then-call-this--note-that-if-you-fail-to-call-this-method-you-risk-accruingthe-maximum-charge-possible-for-the-given-location--sitecontrolled-sessionsat-locations-that-have-a-means-of-telling-when-users-enter-and-leave-like-human-attendants-ora-barcode-scanner-the-session-end-time-and-billing-information-will-be-set-only-afterthe-user-ends-their-session-at-the-location-e-g--scans-out-with-a-barcode-or-checks-out-withan-attendant--in-such-cases-you-may-want-to-pollget-location-idsessionsession-idreference0retrieveanexistingsessionretrieveanexistingsessionuntil-an-end-time-exists-in-the-response--this-is-useful-to-provide-a-summarynotification-toyour-user-after-checkout-and-for-your-own-records-note-that-parkingsession-objects-last-forever--you-can-always-callget-location-idsessionsession-idreference0retrieveanexistingsessionretrieveanexistingsessionfor-information-on-a-session-that-you-created--maximum-stayssome-apicontrolled-and-sitecontrolled-sessions-may-be-subject-to-a-maximum-duration-whichmeans-that-after-a-set-amount-of-time-the-session-will-automatically-be-assigned-an-end-timeand-be-billed-for-usage-up-to-that-time--though-you-can-generally-avoid-this-by-callinga-hrefhttpscoord-codocssearchparking-target-blankthe-parking-search-apiabeforehand-to-determine-if-your-users-expected-parking-time-will-be-valid-at-a-locationsince-that-method-only-returns-locations-that-can-accept-parking-for-a-given-start-time-andduration-pair-your-user-might-still-stay-beyond-their-original-expected-duration-and-hit-amaximum-stay-time-you-can-poll-get-location-idsessionsession-idreference0retrieveanexistingsessionretrieveanexistingsession-todetermine-if-a-session-has-automatically-closed-and-notify-your-user-that-this-has-happened-if-this-happens-your-user-has-the-following-options---for-apicontrolled-sessions-your-user-should-leave-the-location-immediately-to-avoid-some--kind-of-enforcement-action-car-booting-towing-stickering-etc--note-that-you-will-not--need-to-explicitly-call--put-location-idsessionsession-idendreference0endingsessionsendapreviouslystartedsession-since-the--session-is-already-ended----for-sitecontrolled-sessions-your-user-may-or-may-not-be-able-to-check-out-using-the--redemption-info-provided-in-the-session--if-checkout-fails-gate-arm-does-not-go-up-your--user-may-have-to-resort-to-local-onsite-help-speaking-with-an-attendant-calling-posted--telephone-numbers-or-using-onsite-intercoms-for-assistance----finding-sessions--in-addition-to-querying-for-the-status-of-a-single-session-you-can-also-get-all-of-the--sessions-for-a-given-user-by-calling---get-sessionreference0retrieveauserssessionsretrieveauserssessions--this-will--return-both-the-currently-open-session-if-it-exists-and-all-closed-sessions---to-get-all-of-a-users-sessions-at-a-given-location-you-can-call--get-location-idsessionreference0createandretrievesessionsretrievealocationssessions-", "version"=>"1.0.0"}, "host"=>"api.coord.co", "basePath"=>"/v1/access/parking", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{location_id}/session"=>{"get"=>{"summary"=>"Retrieve a location's sessions", "description"=>"Retrieve information about all existing sessions at a location.\n\nOn success, the response will be a list of existing sessions. At most one will still be\nactive:\n```\n [\n {\n \"id\":1,\n \"start_time\":\"2018-04-12T00:14:20.292Z\",\n \"end_time\":\"2018-04-12T04:10:13.456Z\",\n \"user_id\":\"00000000-0000-0000-0000-000000000000\"\n },\n {\n \"id\":2,\n \"start_time\":\"2018-04-12T00:14:20.292Z\",\n \"user_id\":\"00000000-0000-0000-0000-000000000000\"\n }\n ]\n```", "operationId"=>"get_location_sessions", "x-api-path-slug"=>"location-idsession-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Locations", "Sessions"]}, "post"=>{"summary"=>"Create a new session", "description"=>"Create a new session for the specified user at this location_id. Returns it with either\nthe start_time set, or a follow-on token (barcode, number, etc.) that the end user must use\nto initiate the session at the location.\n\nOn success, the response will be the newly created session:\n```\n {\n \"id\":1,\n \"start_time\":\"2018-04-12T00:14:20.292Z\",\n \"user_id\":\"00000000-0000-0000-0000-000000000000\"\n }\n```", "operationId"=>"post_session", "x-api-path-slug"=>"location-idsession-post", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Session"]}}, "/{location_id}/session/{session_id}"=>{"get"=>{"summary"=>"Retrieve an existing session", "description"=>"Retrieve information about an existing session. This is useful to determine if/when an\nexisting session has been started or ended (via external, barcode mechanism, for example).\nIt may be polled to provide live feedback to an end user.\n\nOn success, the response will be the existing session:\n```\n {\n \"id\":1,\n \"start_time\":\"2018-04-12T00:14:20.292Z\",\n \"user_id\":\"00000000-0000-0000-0000-000000000000\"\n }\n```", "operationId"=>"get_session", "x-api-path-slug"=>"location-idsessionsession-id-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Existing", "Session"]}}, "/{location_id}/session/{session_id}/end"=>{"put"=>{"summary"=>"End a previously started session", "description"=>"End a previously started session. Note that it is invalid to call this method for sessions\nwhere checkout is controlled physically (those returned with a `redemption_info` field).\n\nOn success, the response will be the existing session with billing info:\n```\n {\n \"billing_info\": {\n \"cost\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n }\n },\n \"end_time\": \"2018-04-12T00:17:50.161Z\",\n \"id\":1,\n \"start_time\":\"2018-04-12T00:14:20.292Z\",\n \"user_id\":\"00000000-0000-0000-0000-000000000000\"\n }\n```", "operationId"=>"end_session", "x-api-path-slug"=>"location-idsessionsession-idend-put", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["End", "Previously", "Started", "Session"]}}, "/barcode"=>{"post"=>{"summary"=>"Create a barcode", "description"=>"Create a barcode for a user to be scanned upon entering/exiting a parking lot.", "operationId"=>"create_barcode", "x-api-path-slug"=>"barcode-post", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}, {"in"=>"body", "name"=>"request", "description"=>"A request to simulate an arrival/departure associated with the session", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Barcode"]}}, "/session"=>{"get"=>{"summary"=>"Retrieve a user's sessions", "description"=>"Retrieve information about all of a user's existing sessions.\n\nOn success, the response will be a list of existing sessions. At most one will still be\nactive:\n```\n [\n {\n \"id\":1,\n \"start_time\":\"2018-04-12T00:14:20.292Z\",\n \"end_time\":\"2018-04-12T04:10:13.456Z\",\n \"user_id\":\"00000000-0000-0000-0000-000000000000\"\n },\n {\n \"id\":2,\n \"start_time\":\"2018-04-12T00:14:20.292Z\",\n \"user_id\":\"00000000-0000-0000-0000-000000000000\"\n }\n ]\n```", "operationId"=>"get_user_sessions", "x-api-path-slug"=>"session-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Users", "Sessions"]}}, "/testing/{location_id}/{session_id}/simulate_redemption"=>{"post"=>{"summary"=>"For test users only - Simulate a user redemption", "description"=>"Some sessions don't automatically start when created. Instead, they are returned with\n`redemption_info`, which might be a barcode, for example, that needs to be scanned at the\ntarget location. For such sessions started by test users, you can use this method to\nsimulate a redemption (arrival+departure). The system will behave as though a user checked\nin at a location where the session was creationg at the time you make the call and checked\nout at a time `duration_m` minutes in the future. **This method is only available for\nsessions started by test users.**", "operationId"=>"fake_redemption", "x-api-path-slug"=>"testinglocation-idsession-idsimulate-redemption-post", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}, {"in"=>"body", "name"=>"request", "description"=>"A request to simulate an arrival/departure associated with the session", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["For", "Test", "Users", "Only", "-", "Simulate", "User", "Redemption"]}}}}, "coord-multimodal-routing-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Coord", "x-complete"=>1, "info"=>{"title"=>"Multimodal Routing API", "description"=>"the-multimodal-routing-api-allows-you-to-plan-a-journey-between-two-points-in-the-same-city-depending-on-the-options-you-specify-this-trip-can-include-walking-buses-trains-and-sharedbicycles--trips-and-legsa-trip-is-a-single-option-for-getting-from-the-origin-to-the-destination--the-api-willreturn-multiple-trip-options-you-can-configure-how-many-using-the-num-options-parameter-every-trip-is-composed-of-legs--a-leg-of-a-trip-represents-a-single-mode-the-travelertakes-for-a-continuous-stretch-of-time--for-instance-taking-a-single-bus-or-subway-traincounts-as-one-leg--so-does-renting-a-bike-at-one-dock-and-returning-it-at-another-or-unlockinga-dockless-bike-riding-it-and-locking-it-again--a-public-transit-leg-ends-at-a-transfer-ifyou-take-two-different-bus-routes-we-will-model-that-as-two-legs-even-if-there-is-no-other-modein-between-note-that-for-certain-rare-trips-we-will-direct-the-traveler-to-walk-their-rented-bike-for-abrief-period--when-this-happens-the-bike-rental-will-be-split-over-multiple-legs--there-couldbe-one-bike-leg-when-the-traveler-rents-the-bike-and-rides-it-a-walk-leg-when-the-travelerwalks-the-bike-and-another-bike-leg-when-the-traveler-rides-the-bike-to-the-destination-the-trip-starts-at-the-same-time-as-its-first-leg-and-ends-at-the-same-time-as-its-last-legbut-there-can-be-gaps-between-legs--these-gaps-represent-the-transfer-time-between-arriving-ata-transit-station-and-departing-on-a-bus-or-rail-vehicle--this-means-that-you-cant-add-up-thedurations-of-all-the-legs-to-get-the-duration-of-the-trip-as-a-whole--on-the-other-hand-everyleg-ends-at-exactly-the-same-point-in-space-as-the-next-leg-starts-so-you-can-add-up-thedistance-of-each-leg-to-get-the-distance-traveled-for-the-trip-as-a-whole-", "version"=>"1.0.0"}, "host"=>"api.coord.co", "basePath"=>"/v1/routing", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/route"=>{"get"=>{"summary"=>"Find a route.", "description"=>"Find possible trips between two points using either or both of bike-share and transit.", "operationId"=>"route_search", "x-api-path-slug"=>"route-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}, {"in"=>"query", "name"=>"bike_systems", "description"=>"A comma-separated list of bike systems (as named in thebike share API)to use when routing"}, {"in"=>"query", "name"=>"destination_latitude", "description"=>"The latitude of the destination point"}, {"in"=>"query", "name"=>"destination_longitude", "description"=>"The longitude of the destination point"}, {"in"=>"query", "name"=>"modes", "description"=>"The modes we can use in returned trip options"}, {"in"=>"query", "name"=>"num_options", "description"=>"The maximum number of different trip options we should provide at once"}, {"in"=>"query", "name"=>"origin_latitude", "description"=>"The latitude of the origin point"}, {"in"=>"query", "name"=>"origin_longitude", "description"=>"The longitude of the origin point"}, {"in"=>"query", "name"=>"priority", "description"=>"How we choose and sort the trip options"}, {"in"=>"query", "name"=>"time", "description"=>"The time the trip starts or ends (depending on the `time_mode` flag), in ISO 8601format"}, {"in"=>"query", "name"=>"time_mode", "description"=>"Whether `time` is the requested departure time or the requested arrival time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Routes"]}}}}, "coord-parking-search-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Coord", "x-complete"=>1, "info"=>{"title"=>"Parking Search API", "description"=>"the-parking-search-api-is-a-readonly-service-to-answer-questionsabout-where-and-when-a-person-can-park-in-lots-and-garages--for-onstreet-parkinguse-the-curbs-api-finding-parking-locationsa-place-where-you-can-park-is-called-a-location--this-is-usually-either-a-surface-parkinglot-or-a-parking-garage--to-find-parking-locations-in-a-given-area-use-thelocationreference0getalistoflocations-request--this-will-return-an-object-for-each-open--location-in-that-area-ordered-by-distance-when-we-have-live-parking-availability-for-a-location-we-will-also-fill-inavailability-probability-for-it--this-represents-the-probability-that-there-will-be-at-leastthreshold-spaces-available-at-the-location--we-find-availability-probability-a-prettygreat-way-to-reason-about-parking-locations-which-may-have-uncertainty-around-theiravailability-both-at-the-current-time-and-in-the-future-when-someone-may-be-arriving-aftera-trip-getting-data-on-a-single-locationuse-locationreference0getasinglelocations-requests-to-get-the-same-information-aboutjust-one-location-accessing-a-lotyou-can-allow-your-mobile-users-to-check-into-and-out-of-select-locationsusing-the-parking-access-api--parking-rates-select-locations-will-have-a-rates-field-set-with-a-list-of-rates-which-can-be-displayed-toyour-end-users-for-a-rough-idea-on-the-price-of-parking-all-locations-will-include-a-total-price-if--parking-start-time-and-duration-m-are-setappropriately-", "version"=>"1.0.0"}, "host"=>"api.coord.co", "basePath"=>"/v1/search/parking", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/location"=>{"get"=>{"summary"=>"Get a list of off-street parking locations.", "description"=>"Find all of the locations within a given are and return their pricing information and\n(when present) availability. If the `duration_m` parameter is set, total cost for a stay\nof that duration will also be returned.", "operationId"=>"get_locations", "x-api-path-slug"=>"location-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}, {"in"=>"query", "name"=>"duration_m", "description"=>"The expected length of time, in minutes, that the car will remainparked for"}, {"in"=>"query", "name"=>"latitude", "description"=>"Latitude to return results for"}, {"in"=>"query", "name"=>"location_ids", "description"=>"Comma separated list of the location IDs to include in the search"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude to return results for"}, {"in"=>"query", "name"=>"parking_start_time", "description"=>"The ISO-8601 formatted string representing the time when the vehicle will arrive atthe parking location"}, {"in"=>"query", "name"=>"radius_km", "description"=>"Distance, in kilometers, from (latitude, longitude) we will returnresults for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Off-street", "Parking", "Locations"]}}, "/location/{id}"=>{"get"=>{"summary"=>"Get a list of off-street parking locations.", "description"=>"Find a single locations within a given are and return their pricing information and\n(when present) availability. If the `duration_m` parameter is set, total cost for a stay\nof that duration will also be returned.", "operationId"=>"get_location", "x-api-path-slug"=>"locationid-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}, {"in"=>"query", "name"=>"duration_m", "description"=>"The expected length of time, in minutes, that the car will remainparked for"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the parking location to retrieve"}, {"in"=>"query", "name"=>"parking_start_time", "description"=>"The ISO-8601 formatted string representing the time when the vehicle will arrive atthe parking location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Off-street", "Parking", "Locations"]}}}}, "coord-curb-search-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Coord", "x-complete"=>1, "info"=>{"title"=>"Curb Search API", "description"=>"the-curb-search-api-is-a-readonly-service-to-describe-what-you-can-do-on-a-curb-a-curb-is-defined-as-one-side-of-one-roadway-so-every-street-has-at-least-twocurbs-those-with-medians-could-have-four-say-to-see-the-curb-search-api-in-action-and-examine-example-requests-and-responses-check-outour-a-hrefhttpscoord-coexplorer-target-blankcurb-explorer-toola-which-is-builtentirely-on-this-apicurbs-geometries-are-positioned-along-the-edge-of-the-roadway-meaning-that-curbs-meet-atthe-corners-of-intersections--curbs-will-never-cross-over-each-other--in-general-curbs-startand-end-at-intersections-though-behavior-at-t-intersections-alleys-pedestrian-pathsand-other-crossings-will-vary-by-city--how-we-model-curb-rulesevery-segment-of-a-curb-has-at-any-given-time-a-primary-use-andpermitted-uses--the-primary-use-is-what-the-regulator-has-defined-as-the-desired-use-of-thecurb-at-that-time--the-permitted-uses-comprise-everything-that-is-allowed-including-the-primaryuse-if-any--we-distinguish-these-so-that-we-can-tell-apart-areas-signed-say-passenger-loadingzone-from-those-signed-no-standing-which-may-also-allow-passenger-pickup-and-dropoff-a-segment-of-curb-can-also-have-a-vehicle-type--in-this-case-only-vehicles-of-this-type-areallowed-to-perform-the-permitted-uses-on-this-segment-though-other-vehicles-mayhave-a-smaller-list-of-permitted-uses-for-instance-an-area-signed-commercial-vehicle-loading-only-all-others-no-stopping-would-have---a-vehicle-type-of-commercial---a-primary-use-of-load-goods---a-permitted-use-of-load-passengers---no-uses-in-other-vehicles-permitted-on-the-other-hand-an-area-signed-truck-parking-all-others-no-standing-might-have---a-vehicle-type-of-truck---a-primary-use-of-park---permitted-uses-of-load-goods-and-load-passengers---load-passengers-in-other-vehicles-permitted--uses-and-vehicle-typesthe-different-uses-are---park-leave-a-vehicle-somewhere-for-a-period-of-time----load-goods-load-and-unload-goods-from-a-vehicle--the-vehicle-may-be-left-unattended-for-a----few-minutes-during-this-process----load-passengers-load-and-unload-passengers-from-a-vehicle--the-vehicle-may-not-be-left----unattended-during-passenger-loading----none-if-a-segment-has-no-primary-use-e-g--it-is-signed-no-parking-its-primary----use-will-be-specified-as-none--it-can-still-have-permitted-uses-for-instance----in-most-cities-drivers-are-still-allowed-to-load-and-unload-passengers-in-no-parking----areas-the-different-vehicle-types-are---all-if-a-segment-of-curb-has-a-vehicle-type-of-all-this-means-that-all-kinds-of----vehicles-including-private-cars-can-engage-in-its-permitted-uses----taxi-any-forhire-passenger-vehicle--this-includes-medallion-taxis-livery-companies-and----ridesharing-companies-like-lyft-and-uber----commercial-a-vehicle-used-for-transporting-goods-commercially--the-exact-definition----varies-by-city-but-usually-commercial-vehicles-must-have-commercial-license-plates----truck-a-large-vehicle-used-for-transporting-goods-commercially--the-exact-definition----varies-by-city-but-usually-trucks-have-three-or-more-axles-in-addition-to-meeting-the----requirements-of-a-commercial-vehicle----motorcycle-a-twowheeled-motorized-vehicle--this-includes-fullsized-motorcycles-as----well-as-mopeds--geometry-and-directionevery-curb-has-a-specific-direction-and-thus-a-start-and-an-end--regardless-of-the-direction-oftravel-all-curbs-are-oriented-to-the-right-of-their-respective-streets--this-means-that-if-youwalk-from-the-start-of-the-curb-to-the-end-the-street-will-be-on-your-lefthand-side-the-wholetime-each-segment-has-distances-in-meters-defining-their-linear-position-along-the-curb--these-aremeasured-from-the-start-of-the-curb--note-that-if-you-restrict-the-segments-you-return-usingquery-parameters-you-may-not-get-a-given-curbs-complete-geometry--but-querying-with-norestrictions-will-always-return-all-the-segments-on-a-curb--when-you-do-this-the-segments-willalways-be-connected-in-both-geometry-and-distance-every-subsequent-segment-will-start-atexactly-the-point-the-last-one-ended-and-its-distance-start-meters-will-be-the-lastsegments-distance-end-meters--this-allows-you-to-reconstruct-a-linear-view-of-any-curb-andto-know-what-the-regulations-are-at-every-point--temporary-rulesin-some-cities-we-have-data-about-temporary-changes-to-parking-regulations--these-can-be-due-toconstruction-events-or-other-activities-that-use-the-road--we-take-these-temporary-regulationsinto-account-as-soon-as-we-find-out-about-them-but-not-all-regulations-arrive-at-the-same-timeso-its-always-possible-for-future-temporary-regulations-to-change--temporary-regulations-thatare-in-the-past-will-never-change-in-time-rules-requests-you-dont-have-to-do-anything-special-for-temporary-regulations-weuse-them-automatically-to-compute-the-regulations-that-apply-at-the-requested-time--forall-rules-requests-you-can-use-the-temp-rules-window-start-and-temp-rules-window-endparameters-to-control-the-timedate-range-of-the-rules-we-return--we-will-return-any-temporaryrule-that-takes-effect-at-any-time-within-this-window-even-if-it-is-on-the-edge-for-instancea-rule-that-starts-before-temp-rules-window-start-and-ends-within-the-window-will-bereturned-temporary-rules-override-all-other-rules-on-their-segment-for-their-specified-time-period--getting-rules-at-a-particular-timethe-simplest-methods-to-call-arebyboundstime-rulesreference0allrulesforcurbswithinaboundingboxataparticulartimebylocationtime-rulesreference0rulesatapointintimeforcurbsnearalocation-andbycurbidtime-rulesreference0rulesatapointintimeforasinglecurb-all-three-of-these-methods-take-a-particular-starting-time-and-tell-you-how-long-if-at-allyou-can-perform-any-given-use-at-each-segment-of-curb-starting-at-this-time-and-how-much-itwill-cost--in-all-cases-the-response-data-has-the-same-format-a-geojson-featurecollectionwhere-each-feature-is-a-curb-segment-with-its-own-usage-information--sample-requestcurl-g-httpsapi-coord-cov1searchcurbsbycurbbnljojewndmznqtime-rulestime20180612t1100000400access-keyyour-api-key-sample-response--features----------some-features-omitted-for-brevity------------each-feature-contains-the-geography-of-just-the-portion-of-the-curb-that-it-applies-to-------geometry---------coordinates-----------73-9775270524428-40-75197120090719----------73-9773964310734-40-751917110446385----------------type-linestring------------properties---------metadata------------the-id-of-this-curb-note-that-all-features-that-are-on-the-same-curb-have-the-same-----------curb-id-----------curb-id-bnljojewndmznq-----------distance-start-meters-and-distance-end-meters-represent-the-distance-from-the-----------beginning-of-the-curb-that-this-feature-startsends-at-----------distance-end-meters-18-653505116785006----------distance-start-meters-6-1-----------additional-metadata-about-this-curb-----------end-street-name-lexington-avenue----------side-of-street-sw----------start-street-name-east-42-street----------street-name-east-42-street----------time-zone-americanew-york-----------------using-the-curb-for-the-purposes-designated-below-is-free---------price-price-per-hour-amount-0-currency-usd---------the-rules-for-this-curb-feature-are-specified-by-a-sign---------reasons-sign--------uses------------the-only-permitted-use-for-this-part-of-the-curb-is-loadingunloading-passengers-----------permitted-------------use-load-passengers-vehicle-type-all-------------------------------there-is-no-primary-use-this-means-that-this-is-signed-as-no-standing-rather-than-----------as-a-specific-passenger-loading-zone-----------use-none----------vehicle-type-all--------------------type-feature--------------geometry---------coordinates-----------73-9773964310734-40-751917110446385----------73-97715562215994-40-75181739119557----------73-97689946982429-40-75171053502362----------73-97624207098005-40-75143628919809----------------type-linestring------------properties---------metadata-----------curb-id-bnljojewndmznq----------distance-end-meters-129-7443128858502----------distance-start-meters-18-653505116785006----------end-street-name-lexington-avenue----------side-of-street-sw----------start-street-name-east-42-street----------street-name-east-42-street----------time-zone-americanew-york-----------------using-this-curb-costs-3-dollars-and-50-cents-per-hour---------price-price-per-hour-amount-350-currency-usd---------this-curbs-rules-are-specified-by-signs-and-parking-meter-data---------reasons-sign-meter--------uses------------this-curb-allows-parking-for-commercial-vehicles-and-loading-goodspassengers-for-----------any-vehicle-commercial-or-otherwise--note-that-in-all-cases-the-use-ends-at------------2pm-3-hours-after-the-requested-time--it-turns-out-that-this-is-because-the-curb-----------is-signed-for-threehour-parking-but-this-could-have-meant-that-there-was-e-g------------a-no-stopping-regulation-that-takes-effect-at-2pm-----------permitted---------------------------end-time-20180612t140000-0000400--------------use-load-goods--------------vehicle-type-all--------------------------------------end-time-20180612t140000-0000400--------------use-load-passengers--------------vehicle-type-all--------------------------------------end-time-20180612t140000-0000400--------------use-park--------------vehicle-type-commercial---------------------------------the-primary-use-case-for-this-portion-of-the-curb-is-commercial-vehicle-parking-----------until-4pm-----------primary-until-20180612t160000-0000400----------use-park----------vehicle-type-commercial--------------------type-feature--------------geometry---------coordinates-----------73-97624207098005-40-75143628919809----------73-97617870763244-40-751409856030875----------------type-linestring------------properties---------metadata-----------curb-id-bnljojewndmznq----------distance-end-meters-135-8443128858502----------distance-start-meters-129-7443128858502----------end-street-name-lexington-avenue----------side-of-street-sw----------start-street-name-east-42-street----------street-name-east-42-street----------time-zone-americanew-york-----------------because-this-feature-is-too-close-to-the-intersection-it-doesnt-permit-any-uses---------price-null--------reasons-intersection--------uses-----------permitted-null----------use-none----------vehicle-type-all--------------------type-feature--------type-featurecollection-getting-all-rules-if-you-want-to-analyze-all-of-a-curbs-rules-across-time-you-can-callbyboundsall-rulesreference0allrulesforcurbswithinaboundingboxbylocationall-rulesreference0allrulesforcurbsnearalocation-andbycurbidall-rulesreference0allrulesforasinglecurb-these-methods-give-you-comprehensive-information-for-the-relevant-curbs-but-require-you-to-domore-work-to-figure-out-what-a-given-vehicle-can-do-at-a-given-time--these-methods-return-a-geojsonfeaturecollection-where-each-feature-is-a-curb-segment-with-its-own-usage-information-but-withdifferent-properties-than-the-methods-that-take-a-time-parameter--sample-requestcurl-g-httpsapi-coord-cov1searchcurbsbycurbbnljojewndmznqall-rulesaccess-keyyour-api-key-sample-response--features----------some-features-omitted-for-brevity------------note-that-geometry-and-metadata-are-structured-the-same-in-all-rules-and-time-rules-------requests-------geometry---------coordinates-----------73-9773964310734-40-751917110446385----------73-97715562215994-40-75181739119557----------73-97689946982429-40-75171053502362-----------73-97624207098005-40-75143628919809----------------type-linestring------------properties---------metadata-----------curb-id-bnljojewndmznq----------distance-end-meters-129-7443128858502----------distance-start-meters-18-653505116785006----------end-street-name-lexington-avenue----------side-of-street-sw----------start-street-name-east-42-street----------street-name-east-42-street----------time-zone-americanew-york-----------------every-feature-can-have-multiple-rules-that-apply-at-different-times--there-is-always---------exactly-one-rule-that-applies-at-any-one-time---------rules------------rule-1-passenger-loading-only-from-7am10am-and-4pm7pm-monsat------------------------other-vehicles-permitted-describes-what-vehicles-not-matching-vehicle-type-can-------------do-when-this-rule-applies--it-is-empty-when-vehicle-type-is-all-as-it-is-for-------------this-rule-------------other-vehicles-permitted-------------permitted-load-passengers------------price-price-per-hour-amount-0-currency-usd------------primary-none------------reasons-sign------------times-------------------------------days-1-2-3-4-5-6----------------time-of-day-end-1000----------------time-of-day-start-0700--------------------------------------------days-1-2-3-4-5-6----------------time-of-day-end-1900----------------time-of-day-start-1600--------------------------------------vehicle-type-all---------------------rule-2-3hour-pay-parking-for-commercial-vehicles-from-10am4pm-monsat------------------------any-vehicle-can-stay-here-at-most-three-hours-------------max-duration-h-3-------------this-rule-has-vehicle-type-of-commercial-so-other-vehicles-permitted-------------describes-what-noncommercial-vehicles-can-do-while-permitted-describes-what-------------commercial-vehicles-can-do-------------other-vehicles-permitted-load-goods-load-passengers------------permitted-park-load-goods-load-passengers------------price-price-per-hour-amount-350-currency-usd-------------the-primary-use-is-parking-------------primary-park------------reasons-sign-meter------------times-------------------------------days-1-2-3-4-5-6----------------time-of-day-end-1600----------------time-of-day-start-1000---------------------------------------the-primary-vehicle-type-is-commercial-------------vehicle-type-commercial---------------------rule-3-free-parking-all-day-sunday-before-7am-after-7pm-----------------------other-vehicles-permitted-------------permitted-park-load-goods-load-passengers------------price-price-per-hour-amount-0-currency-usd------------primary-park-------------reasons-is-null-because-free-parking-is-the-default-regulation-in-the-absence-of-------------any-other-information-------------reasons-null--------------times-------------------------------days-0----------------time-of-day-end-2400----------------time-of-day-start-0000--------------------------------------------days-1-2-3-4-5-6----------------time-of-day-end-0700----------------time-of-day-start-0000--------------------------------------------days-1-2-3-4-5-6----------------time-of-day-end-2400----------------time-of-day-start-1900--------------------------------------vehicle-type-all---------------------------no-temporary-rules-in-effect-for-the-coming-week-for-this-curb-segment---------temporary-rules-null------------type-feature--------type-featurecollection", "version"=>"1.0.0"}, "host"=>"api.coord.co", "basePath"=>"/v1/search/curbs", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/bybounds/all_rules"=>{"get"=>{"summary"=>"Find the rules for all curbs within a bounding box.", "description"=>"Find the rules for all curbs within a bounding box..", "operationId"=>"get_by_bounds", "x-api-path-slug"=>"byboundsall-rules-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Rules", "Curbs", "Within", "Bounding", "Box"]}}, "/bybounds/time_rules"=>{"get"=>{"summary"=>"Find the rules for all curbs within a bounding box at a particular time.", "description"=>"Find the rules for all curbs within a bounding box at a particular time..", "operationId"=>"get_at_time_by_bounds", "x-api-path-slug"=>"byboundstime-rules-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}, {"in"=>"query", "name"=>"max_latitude", "description"=>"The largest latitude to return results for", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"max_longitude", "description"=>"The largest longitude to return results for", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"min_latitude", "description"=>"The smallest latitude to return results for", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"min_longitude", "description"=>"The smallest longitude to return results for", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Rules", "Curbs", "Within", "Bounding", "Box", "At", "Particular", "Time"]}}, "/bycurb/{id}/all_rules"=>{"get"=>{"summary"=>"Find the rules on single curb.", "description"=>"Find the rules on single curb..", "operationId"=>"get_by_curb_id", "x-api-path-slug"=>"bycurbidall-rules-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Rules", "On", "Single", "Curb"]}}, "/bycurb/{id}/time_rules"=>{"get"=>{"summary"=>"Find the rules on a single curb at a certain time.", "description"=>"Find the rules on a single curb at a certain time..", "operationId"=>"get_at_time_by_curb_id", "x-api-path-slug"=>"bycurbidtime-rules-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Rules", "On", "Single", "Curb", "At", "Certain", "Time"]}}, "/bylocation/all_rules"=>{"get"=>{"summary"=>"Find the rules for curbs near a location.", "description"=>"Find all of the curbs within a given radius of a particular point, and return all of their\nrules across all times of day, days of the week, times of year, etc.", "operationId"=>"get_by_location", "x-api-path-slug"=>"bylocationall-rules-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}, {"in"=>"query", "name"=>"latitude", "description"=>"Latitude to return results for", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude to return results for", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"radius_km", "description"=>"Distance, in kilometers, from (latitude, longitude) we will return results for", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Rulescurbs", "Near", "Location"]}}, "/bylocation/time_rules"=>{"get"=>{"summary"=>"Find the rules for curbs near a location at a certain time.", "description"=>"Find the rules for a given curb at a given time and on a given day. You can also use this\nto find all of the places that it is possible to perform a given action (for instance, find\nall the loading zones, or everywhere with two-hour parking).", "operationId"=>"get_at_time_by_location", "x-api-path-slug"=>"bylocationtime-rules-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"The API access key for the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Rulescurbs", "Near", "Location", "At", "Certain", "Time"]}}}}, "coord-users-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Coord", "x-complete"=>1, "info"=>{"title"=>"Users API", "description"=>"the-users-api-allows-you-to-manage-user-data-on-the-coord-platform--sending-user-data-to-coordallows-you-to-perform-transactions-with-mobility-systems-like-renting-a-bike-parking-ina-parking-lot-or-booking-a-ridehail-trip-on-behalf-of-that-user-using-the-coord-platform-the-requirements-for-performing-a-transaction-for-a-given-user-vary-depending-on-the-systemyoure-connecting-with--some-systems-require-particular-data-about-a-user-in-order-for-thetransaction-to-take-place-and-some-systems-require-you-to-link-a-users-account--alltransactions-require-you-to-authenticate-the-user-using-a-jwt-every-coord-api-that-supports-transactions-has-an-endpoint-for-getting-information-aboutthat-apis-systems-along-with-what-you-need-to-provide-for-a-user-in-order-to-perform-atransaction-for-them--the-users-api-provides-tools-that-help-you-enable-users-to-performtransactions-as-well-as-tools-for-learning-about-the-transactions-that-a-user-can-alreadyperform-read-on-for-more-information-about-authenticating-users-linking-accounts-and-managing-userdata--authenticating-users-with-jwtsall-coord-api-endpoints-that-either-manipulate-data-or-perform-a-transaction-on-behalf-of-alogged-in-user-require-http-calls-to-include-an-authorization-bearer-jwt-token-so-thatthe-current-user-can-be-identified--all-endpoints-in-the-users-api-fall-into-this-categoryexcept-for-the-test-jwt-creation-endpoint-which-is-designed-to-allow-you-to-create-test-tokensfor-use-in-such-requests-for-information-on-how-to-create-nontest-user-authorization-tokensplease-contact-a-hrefmailtosalescoord-co-target-blanksalescoord-coaas-this-is-available-only-for-transaction-enabled-partners-see-post-v1userstestinguser-and-jwtreference0testjwtcreation-for-information-onhow-to-create-jwts-for-testing--linking-accountsmany-systems-require-you-to-link-a-user-in-order-to-perform-a-transaction--you-can-do-this-byredirecting-the-users-browser-or-webview-to-theget-v1userslink-accountreference0linkauseraccounttoenabletransactions-endpoint-this-will-allow-the-user-to-link-to-an-existing-account-with-that-system-if-they-have-one-orwill-create-a-new-one-for-them--if-you-call-this-endpoint-with-a-test-jwt-we-will-simulateaccount-linking-by-redirecting-the-user-to-a-demo-permission-page-you-can-also-simulate-linking-or-unlinking-test-users-accounts-serverside-by-calling-thepost-v1userstestingusercurrenttransactable-systemsreference0simulateaccountlinkingfortestingendpoint-remember-that-not-all-systems-are-transactable-and-not-all-transactable-systems-requireaccount-linking--getting-and-setting-user-infowe-automatically-ingest-user-information-like-email-addresses-and-names-from-the-jwtauthorization-token-you-send-us--information-about-a-users-vehicle-like-their-license-plateneeds-to-be-set-through-our-api--we-require-this-in-order-for-the-user-to-transact-with-certainparking-operators-you-can-call-get-v1usersusercurrentreference0getuserinfo-to-get-all-theinformation-we-have-about-a-user-including-the-fields-we-deduce-from-their-jwt-and-those-thatyou-have-already-set-through-our-api-you-can-call-v1usersusercurrentupdate-vehiclereference0updateuservehicle-toupdate-the-vehicle-thats-associated-with-a-users-account-", "version"=>"1.0.0"}, "host"=>"api.coord.co", "basePath"=>"/v1/users", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/create_jwt"=>{"post"=>{"summary"=>"Create JWT", "description"=>"Create a JWT for accessing user-authenticated APIs.\n\nIf you currently are using an identity provider like Auth0 or Firebase or are generating\nyour own JWTs to manage your end users' idenitites, you shouldn't need to use this API\nmethod. Please contact sales@coord.co so that we can set you up to use your existing JWTs!\n\nOtherwise, as long as you have your own backend, you may instead call this API method to\ngenerate valid JWTs. Note that you must include both your access_key on the URL parameter\nAND include a special `Authorization: Bearer |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-cognito{"aws-cognito-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Cognito", "x-complete"=>1, "info"=>{"title"=>"AWS Cognito Merged API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddCustomAttributes"=>{"get"=>{"summary"=>"Add Custom Attributes", "description"=>"Adds additional user attributes to the user pool schema.", "operationId"=>"addCustomAttributes", "x-api-path-slug"=>"actionaddcustomattributes-get", "parameters"=>[{"in"=>"query", "name"=>"CustomAttributes", "description"=>"An array of custom attributes, such as Mutable and Name", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool where you want to add custom attributes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attributes"]}}, "/?Action=AdminAddUserToGroup"=>{"get"=>{"summary"=>"Admin Add User To Group", "description"=>"Adds the specified user to the specified group.", "operationId"=>"adminAddUserToGroup", "x-api-path-slug"=>"actionadminaddusertogroup-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The group name", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The username for the user", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Groups"]}}, "/?Action=AdminConfirmSignUp"=>{"get"=>{"summary"=>"Admin Confirm Sign Up", "description"=>"Confirms user registration as an admin without using a confirmation code.", "operationId"=>"adminConfirmSignUp", "x-api-path-slug"=>"actionadminconfirmsignup-get", "parameters"=>[{"in"=>"query", "name"=>"Username", "description"=>"The user name for which you want to confirm user registration", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for which you want to confirm user registration", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sign Up"]}}, "/?Action=AdminCreateUser"=>{"get"=>{"summary"=>"Admin Create User", "description"=>"Creates a new user in the specified user pool and sends a welcome message via email\n or phone (SMS).", "operationId"=>"adminCreateUser", "x-api-path-slug"=>"actionadmincreateuser-get", "parameters"=>[{"in"=>"query", "name"=>"DesiredDeliveryMediums", "description"=>"Specify EMAIL if email will be used to send the welcome message", "type"=>"string"}, {"in"=>"query", "name"=>"ForceAliasCreation", "description"=>"This parameter is only used if the phone_number_verified or email_verified attribute is set to True", "type"=>"string"}, {"in"=>"query", "name"=>"MessageAction", "description"=>"Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the users account", "type"=>"string"}, {"in"=>"query", "name"=>"TemporaryPassword", "description"=>"The users temporary password", "type"=>"string"}, {"in"=>"query", "name"=>"UserAttributes", "description"=>"An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The username for the user", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool where the user will be created", "type"=>"string"}, {"in"=>"query", "name"=>"ValidationData", "description"=>"The users validation data", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=AdminDeleteUser"=>{"get"=>{"summary"=>"Admin Delete User", "description"=>"Deletes a user as an administrator.", "operationId"=>"adminDeleteUser", "x-api-path-slug"=>"actionadmindeleteuser-get", "parameters"=>[{"in"=>"query", "name"=>"Username", "description"=>"The user name of the user you wish to delete", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool where you want to delete the user", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=AdminDeleteUserAttributes"=>{"get"=>{"summary"=>"Admin Delete User Attributes", "description"=>"Deletes the user attributes in a user pool as an administrator.", "operationId"=>"adminDeleteUserAttributes", "x-api-path-slug"=>"actionadmindeleteuserattributes-get", "parameters"=>[{"in"=>"query", "name"=>"UserAttributeNames", "description"=>"An array of strings representing the user attribute names you wish to delete", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The user name of the user from which you would like to delete attributes", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool where you want to delete user attributes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=AdminDisableUser"=>{"get"=>{"summary"=>"Admin Disable User", "description"=>"Disables the specified user as an administrator.", "operationId"=>"adminDisableUser", "x-api-path-slug"=>"actionadmindisableuser-get", "parameters"=>[{"in"=>"query", "name"=>"Username", "description"=>"The user name of the user you wish to disable", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool where you want to disable the user", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=AdminEnableUser"=>{"get"=>{"summary"=>"Admin Enable User", "description"=>"Enables the specified user as an administrator.", "operationId"=>"adminEnableUser", "x-api-path-slug"=>"actionadminenableuser-get", "parameters"=>[{"in"=>"query", "name"=>"Username", "description"=>"The user name of the user you wish to enable", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool where you want to enable the user", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=AdminForgetDevice"=>{"get"=>{"summary"=>"Admin Forget Device", "description"=>"Forgets the device, as an administrator.", "operationId"=>"adminForgetDevice", "x-api-path-slug"=>"actionadminforgetdevice-get", "parameters"=>[{"in"=>"query", "name"=>"DeviceKey", "description"=>"The device key", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The user name", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/?Action=AdminGetDevice"=>{"get"=>{"summary"=>"Admin Get Device", "description"=>"Gets the device, as an administrator.", "operationId"=>"adminGetDevice", "x-api-path-slug"=>"actionadmingetdevice-get", "parameters"=>[{"in"=>"query", "name"=>"DeviceKey", "description"=>"The device key", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The user name", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["http://laneworks.net/api-stack/pull/pull-amazon-cognito-sync.php"]}}, "/?Action=AdminGetUser"=>{"get"=>{"summary"=>"Admin Get User", "description"=>"Gets the specified user by user name in a user pool as an administrator.", "operationId"=>"adminGetUser", "x-api-path-slug"=>"actionadmingetuser-get", "parameters"=>[{"in"=>"query", "name"=>"Username", "description"=>"The user name of the user you wish to retrieve", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool where you want to get information about the user", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=AdminInitiateAuth"=>{"get"=>{"summary"=>"Admin Initiate Auth", "description"=>"Initiates the authentication flow, as an administrator.", "operationId"=>"adminInitiateAuth", "x-api-path-slug"=>"actionadmininitiateauth-get", "parameters"=>[{"in"=>"query", "name"=>"AuthFlow", "description"=>"The authentication flow", "type"=>"string"}, {"in"=>"query", "name"=>"AuthParameters", "description"=>"The authentication parameters", "type"=>"string"}, {"in"=>"query", "name"=>"ClientId", "description"=>"The client app ID", "type"=>"string"}, {"in"=>"query", "name"=>"ClientMetadata", "description"=>"The client app metadata", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The ID of the Amazon Cognito user pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authnetication"]}}, "/?Action=AdminListDevices"=>{"get"=>{"summary"=>"Admin List Devices", "description"=>"Lists devices, as an administrator.", "operationId"=>"adminListDevices", "x-api-path-slug"=>"actionadminlistdevices-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"The limit of the devices request", "type"=>"string"}, {"in"=>"query", "name"=>"PaginationToken", "description"=>"The pagination token", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The user name", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["http://laneworks.net/api-stack/pull/pull-amazon-cognito-sync.php"]}}, "/?Action=AdminListGroupsForUser"=>{"get"=>{"summary"=>"Admin List Groups For User", "description"=>"Lists the groups that the user belongs to.", "operationId"=>"adminListGroupsForUser", "x-api-path-slug"=>"actionadminlistgroupsforuser-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"The limit of the request to list groups", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The username for the user", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Groups"]}}, "/?Action=AdminRemoveUserFromGroup"=>{"get"=>{"summary"=>"Admin Remove User From Group", "description"=>"Removes the specified user from the specified group.", "operationId"=>"adminRemoveUserFromGroup", "x-api-path-slug"=>"actionadminremoveuserfromgroup-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The group name", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The username for the user", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Groups"]}}, "/?Action=AdminResetUserPassword"=>{"get"=>{"summary"=>"Admin Reset User Password", "description"=>"Resets the specified user's password in a user pool as an administrator.", "operationId"=>"adminResetUserPassword", "x-api-path-slug"=>"actionadminresetuserpassword-get", "parameters"=>[{"in"=>"query", "name"=>"Username", "description"=>"The user name of the user whose password you wish to reset", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool where you want to reset the users password", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Passwords"]}}, "/?Action=AdminRespondToAuthChallenge"=>{"get"=>{"summary"=>"Admin Respond To Auth Challenge", "description"=>"Responds to an authentication challenge, as an administrator.", "operationId"=>"adminRespondToAuthChallenge", "x-api-path-slug"=>"actionadminrespondtoauthchallenge-get", "parameters"=>[{"in"=>"query", "name"=>"ChallengeName", "description"=>"The name of the challenge", "type"=>"string"}, {"in"=>"query", "name"=>"ChallengeResponses", "description"=>"The challenge response", "type"=>"string"}, {"in"=>"query", "name"=>"ClientId", "description"=>"The client ID", "type"=>"string"}, {"in"=>"query", "name"=>"Session", "description"=>"The session", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The ID of the Amazon Cognito user pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authentication Challenge"]}}, "/?Action=AdminSetUserSettings"=>{"get"=>{"summary"=>"Admin Set User Settings", "description"=>"Sets all the user settings for a specified user name.", "operationId"=>"adminSetUserSettings", "x-api-path-slug"=>"actionadminsetusersettings-get", "parameters"=>[{"in"=>"query", "name"=>"MFAOptions", "description"=>"Specifies the options for MFA (e", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The user name of the user for whom you wish to set user settings", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool where you want to set the users settings, such as MFA options", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=AdminUpdateDeviceStatus"=>{"get"=>{"summary"=>"Admin Update Device Status", "description"=>"Updates the device status as an administrator.", "operationId"=>"adminUpdateDeviceStatus", "x-api-path-slug"=>"actionadminupdatedevicestatus-get", "parameters"=>[{"in"=>"query", "name"=>"DeviceKey", "description"=>"The device key", "type"=>"string"}, {"in"=>"query", "name"=>"DeviceRememberedStatus", "description"=>"The status indicating whether a device has been remembered or not", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The user name", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID>", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=AdminUpdateUserAttributes"=>{"get"=>{"summary"=>"Admin Update User Attributes", "description"=>"Updates the specified user's attributes, including developer attributes, as an\n administrator.", "operationId"=>"adminUpdateUserAttributes", "x-api-path-slug"=>"actionadminupdateuserattributes-get", "parameters"=>[{"in"=>"query", "name"=>"UserAttributes", "description"=>"An array of name-value pairs representing user attributes", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The user name of the user for whom you want to update user attributes", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool where you want to update user attributes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=AdminUserGlobalSignOut"=>{"get"=>{"summary"=>"Admin User Global Sign Out", "description"=>"Signs out users from all devices, as an administrator.", "operationId"=>"adminUserGlobalSignOut", "x-api-path-slug"=>"actionadminuserglobalsignout-get", "parameters"=>[{"in"=>"query", "name"=>"Username", "description"=>"The user name", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Global Sign Out"]}}, "/?Action=ChangePassword"=>{"get"=>{"summary"=>"Change Password", "description"=>"Changes the password for a specified user in a user pool.", "operationId"=>"changePassword", "x-api-path-slug"=>"actionchangepassword-get", "parameters"=>[{"in"=>"query", "name"=>"AccessToken", "description"=>"The access token in the change password request", "type"=>"string"}, {"in"=>"query", "name"=>"PreviousPassword", "description"=>"The old password in the change password request", "type"=>"string"}, {"in"=>"query", "name"=>"ProposedPassword", "description"=>"The new password in the change password request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Password"]}}, "/?Action=ConfirmDevice"=>{"get"=>{"summary"=>"Confirm Device", "description"=>"Confirms tracking of the device.", "operationId"=>"confirmDevice", "x-api-path-slug"=>"actionconfirmdevice-get", "parameters"=>[{"in"=>"query", "name"=>"AccessToken", "description"=>"The access token", "type"=>"string"}, {"in"=>"query", "name"=>"DeviceKey", "description"=>"The device key", "type"=>"string"}, {"in"=>"query", "name"=>"DeviceName", "description"=>"The device name", "type"=>"string"}, {"in"=>"query", "name"=>"DeviceSecretVerifierConfig", "description"=>"The configuration of the device secret verifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/?Action=ConfirmForgotPassword"=>{"get"=>{"summary"=>"Confirm Forgot Password", "description"=>"Allows a user to enter a code provided when they reset their password to update\n their password.", "operationId"=>"confirmForgotPassword", "x-api-path-slug"=>"actionconfirmforgotpassword-get", "parameters"=>[{"in"=>"query", "name"=>"ClientId", "description"=>"The ID of the client associated with the user pool", "type"=>"string"}, {"in"=>"query", "name"=>"ConfirmationCode", "description"=>"The confirmation code sent by a users request to retrieve a forgotten password", "type"=>"string"}, {"in"=>"query", "name"=>"Password", "description"=>"The password sent by sent by a users request to retrieve a forgotten password", "type"=>"string"}, {"in"=>"query", "name"=>"SecretHash", "description"=>"A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The user name of the user for whom you want to enter a code to retrieve a forgotten password", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Passwords"]}}, "/?Action=ConfirmSignUp"=>{"get"=>{"summary"=>"Confirm Sign Up", "description"=>"Confirms registration of a user and handles the existing alias from a previous\n user.", "operationId"=>"confirmSignUp", "x-api-path-slug"=>"actionconfirmsignup-get", "parameters"=>[{"in"=>"query", "name"=>"ClientId", "description"=>"The ID of the client associated with the user pool", "type"=>"string"}, {"in"=>"query", "name"=>"ConfirmationCode", "description"=>"The confirmation code sent by a users request to confirm registration", "type"=>"string"}, {"in"=>"query", "name"=>"ForceAliasCreation", "description"=>"Boolean to be specified to force user confirmation irrespective of existing alias", "type"=>"string"}, {"in"=>"query", "name"=>"SecretHash", "description"=>"A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The user name of the user whose registration you wish to confirm", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sign Ups"]}}, "/?Action=CreateGroup"=>{"get"=>{"summary"=>"Create Group", "description"=>"Creates a new group in the specified user pool.", "operationId"=>"createGroup", "x-api-path-slug"=>"actioncreategroup-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"A string containing the description of the group", "type"=>"string"}, {"in"=>"query", "name"=>"GroupName", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"Precedence", "description"=>"A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool", "type"=>"string"}, {"in"=>"query", "name"=>"RoleArn", "description"=>"The role ARN for the group", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/?Action=CreateUserImportJob"=>{"get"=>{"summary"=>"Create User Import Job", "description"=>"Creates the user import job.", "operationId"=>"createUserImportJob", "x-api-path-slug"=>"actioncreateuserimportjob-get", "parameters"=>[{"in"=>"query", "name"=>"CloudWatchLogsRoleArn", "description"=>"The role ARN for the Amazon CloudWatch Logging role for the user import job", "type"=>"string"}, {"in"=>"query", "name"=>"JobName", "description"=>"The job name for the user import job", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool that the users are being imported into", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Imports"]}}, "/?Action=CreateUserPool"=>{"get"=>{"summary"=>"Create User Pool", "description"=>"Creates a new Amazon Cognito user pool and sets the password policy for the\n pool.", "operationId"=>"createUserPool", "x-api-path-slug"=>"actioncreateuserpool-get", "parameters"=>[{"in"=>"query", "name"=>"AdminCreateUserConfig", "description"=>"The configuration for AdminCreateUser requests", "type"=>"string"}, {"in"=>"query", "name"=>"AliasAttributes", "description"=>"Attributes supported as an alias for this user pool", "type"=>"string"}, {"in"=>"query", "name"=>"AutoVerifiedAttributes", "description"=>"The attributes to be auto-verified", "type"=>"string"}, {"in"=>"query", "name"=>"DeviceConfiguration", "description"=>"The device configuration", "type"=>"string"}, {"in"=>"query", "name"=>"EmailConfiguration", "description"=>"The email configuration", "type"=>"string"}, {"in"=>"query", "name"=>"EmailVerificationMessage", "description"=>"A string representing the email verification message", "type"=>"string"}, {"in"=>"query", "name"=>"EmailVerificationSubject", "description"=>"A string representing the email verification subject", "type"=>"string"}, {"in"=>"query", "name"=>"LambdaConfig", "description"=>"The Lambda trigger configuration information for the new user pool", "type"=>"string"}, {"in"=>"query", "name"=>"MfaConfiguration", "description"=>"Specifies MFA configuration details", "type"=>"string"}, {"in"=>"query", "name"=>"Policies", "description"=>"The policies associated with the new user pool", "type"=>"string"}, {"in"=>"query", "name"=>"PoolName", "description"=>"A string used to name the user pool", "type"=>"string"}, {"in"=>"query", "name"=>"Schema", "description"=>"An array of schema attributes for the new user pool", "type"=>"string"}, {"in"=>"query", "name"=>"SmsAuthenticationMessage", "description"=>"A string representing the SMS authentication message", "type"=>"string"}, {"in"=>"query", "name"=>"SmsConfiguration", "description"=>"The SMS configuration", "type"=>"string"}, {"in"=>"query", "name"=>"SmsVerificationMessage", "description"=>"A string representing the SMS verification message", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolTags", "description"=>"The cost allocation tags for the user pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Pools"]}}, "/?Action=CreateUserPoolClient"=>{"get"=>{"summary"=>"Create User Pool Client", "description"=>"Creates the user pool client.", "operationId"=>"createUserPoolClient", "x-api-path-slug"=>"actioncreateuserpoolclient-get", "parameters"=>[{"in"=>"query", "name"=>"ClientName", "description"=>"The client name for the user pool client you would like to create", "type"=>"string"}, {"in"=>"query", "name"=>"ExplicitAuthFlows", "description"=>"The explicit authentication flows", "type"=>"string"}, {"in"=>"query", "name"=>"GenerateSecret", "description"=>"Boolean to specify whether you want to generate a secret for the user pool client being created", "type"=>"string"}, {"in"=>"query", "name"=>"ReadAttributes", "description"=>"The read attributes", "type"=>"string"}, {"in"=>"query", "name"=>"RefreshTokenValidity", "description"=>"The validity of the refresh token, in days", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool where you want to create a user pool client", "type"=>"string"}, {"in"=>"query", "name"=>"WriteAttributes", "description"=>"The write attributes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Pool Clients"]}}, "/?Action=DeleteGroup"=>{"get"=>{"summary"=>"Delete Group", "description"=>"Deletes a group.", "operationId"=>"deleteGroup", "x-api-path-slug"=>"actiondeletegroup-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/?Action=DeleteUser"=>{"get"=>{"summary"=>"Delete User", "description"=>"Allows a user to delete one's self.", "operationId"=>"deleteUser", "x-api-path-slug"=>"actiondeleteuser-get", "parameters"=>[{"in"=>"query", "name"=>"AccessToken", "description"=>"The access token from a request to delete a user", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=DeleteUserAttributes"=>{"get"=>{"summary"=>"Delete User Attributes", "description"=>"Deletes the attributes for a user.", "operationId"=>"deleteUserAttributes", "x-api-path-slug"=>"actiondeleteuserattributes-get", "parameters"=>[{"in"=>"query", "name"=>"AccessToken", "description"=>"The access token used in the request to delete user attributes", "type"=>"string"}, {"in"=>"query", "name"=>"UserAttributeNames", "description"=>"An array of strings representing the user attribute names you wish to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=DeleteUserPool"=>{"get"=>{"summary"=>"Delete User Pool", "description"=>"Deletes the specified Amazon Cognito user pool.", "operationId"=>"deleteUserPool", "x-api-path-slug"=>"actiondeleteuserpool-get", "parameters"=>[{"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Pools"]}}, "/?Action=DeleteUserPoolClient"=>{"get"=>{"summary"=>"Delete User Pool Client", "description"=>"Allows the developer to delete the user pool client.", "operationId"=>"deleteUserPoolClient", "x-api-path-slug"=>"actiondeleteuserpoolclient-get", "parameters"=>[{"in"=>"query", "name"=>"ClientId", "description"=>"The ID of the client associated with the user pool", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool where you want to delete the client", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Pools"]}}, "/?Action=DescribeUserImportJob"=>{"get"=>{"summary"=>"Describe User Import Job", "description"=>"Describes the user import job.", "operationId"=>"describeUserImportJob", "x-api-path-slug"=>"actiondescribeuserimportjob-get", "parameters"=>[{"in"=>"query", "name"=>"JobId", "description"=>"The job ID for the user import job", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool that the users are being imported into", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Imports"]}}, "/?Action=DescribeUserPool"=>{"get"=>{"summary"=>"Describe User Pool", "description"=>"Returns the configuration information and metadata of the specified user\n pool.", "operationId"=>"describeUserPool", "x-api-path-slug"=>"actiondescribeuserpool-get", "parameters"=>[{"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Pools"]}}, "/?Action=DescribeUserPoolClient"=>{"get"=>{"summary"=>"Describe User Pool Client", "description"=>"Client method for returning the configuration information and metadata of the\n specified user pool client.", "operationId"=>"describeUserPoolClient", "x-api-path-slug"=>"actiondescribeuserpoolclient-get", "parameters"=>[{"in"=>"query", "name"=>"ClientId", "description"=>"The ID of the client associated with the user pool", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Pool Clients"]}}, "/?Action=ForgetDevice"=>{"get"=>{"summary"=>"Forget Device", "description"=>"Forgets the specified device.", "operationId"=>"forgetDevice", "x-api-path-slug"=>"actionforgetdevice-get", "parameters"=>[{"in"=>"query", "name"=>"AccessToken", "description"=>"The access token for the forgotten device request", "type"=>"string"}, {"in"=>"query", "name"=>"DeviceKey", "description"=>"The device key", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/?Action=ForgotPassword"=>{"get"=>{"summary"=>"Forgot Password", "description"=>"Retrieves the password for the specified client ID or username.", "operationId"=>"forgotPassword", "x-api-path-slug"=>"actionforgotpassword-get", "parameters"=>[{"in"=>"query", "name"=>"ClientId", "description"=>"The ID of the client associated with the user pool", "type"=>"string"}, {"in"=>"query", "name"=>"SecretHash", "description"=>"A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The user name of the user for whom you want to enter a code to reset a forgotten password", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Passwords"]}}, "/?Action=GetCSVHeader"=>{"get"=>{"summary"=>"Get C S V Header", "description"=>"Gets the header information for the.", "operationId"=>"getCSVHeader", "x-api-path-slug"=>"actiongetcsvheader-get", "parameters"=>[{"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool that the users are to be imported into", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CSV Header"]}}, "/?Action=GetDevice"=>{"get"=>{"summary"=>"Get Device", "description"=>"Gets the device.", "operationId"=>"getDevice", "x-api-path-slug"=>"actiongetdevice-get", "parameters"=>[{"in"=>"query", "name"=>"AccessToken", "description"=>"The access token", "type"=>"string"}, {"in"=>"query", "name"=>"DeviceKey", "description"=>"The device key", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Pools"]}}, "/?Action=GetGroup"=>{"get"=>{"summary"=>"Get Group", "description"=>"Gets a group.", "operationId"=>"getGroup", "x-api-path-slug"=>"actiongetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/?Action=GetUser"=>{"get"=>{"summary"=>"Get User", "description"=>"Gets the user attributes and metadata for a user.", "operationId"=>"getUser", "x-api-path-slug"=>"actiongetuser-get", "parameters"=>[{"in"=>"query", "name"=>"AccessToken", "description"=>"The access token returned by the server response to get information about the user", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=GetUserAttributeVerificationCode"=>{"get"=>{"summary"=>"Get User Attribute Verification Code", "description"=>"Gets the user attribute verification code for the specified attribute\n name.", "operationId"=>"getUserAttributeVerificationCode", "x-api-path-slug"=>"actiongetuserattributeverificationcode-get", "parameters"=>[{"in"=>"query", "name"=>"AccessToken", "description"=>"The access token returned by the server response to get the user attribute verification code", "type"=>"string"}, {"in"=>"query", "name"=>"AttributeName", "description"=>"The attribute name returned by the server response to get the user attribute verification code", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Verification Codes"]}}, "/?Action=GlobalSignOut"=>{"get"=>{"summary"=>"Global Sign Out", "description"=>"Signs out users from all devices.", "operationId"=>"globalSignOut", "x-api-path-slug"=>"actionglobalsignout-get", "parameters"=>[{"in"=>"query", "name"=>"AccessToken", "description"=>"The access token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sign Out"]}}, "/?Action=InitiateAuth"=>{"get"=>{"summary"=>"Initiate Auth", "description"=>"Initiates the authentication flow.", "operationId"=>"initiateAuth", "x-api-path-slug"=>"actioninitiateauth-get", "parameters"=>[{"in"=>"query", "name"=>"AuthFlow", "description"=>"The authentication flow", "type"=>"string"}, {"in"=>"query", "name"=>"AuthParameters", "description"=>"The authentication parameters", "type"=>"string"}, {"in"=>"query", "name"=>"ClientId", "description"=>"The client ID", "type"=>"string"}, {"in"=>"query", "name"=>"ClientMetadata", "description"=>"The client apps metadata", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authentication"]}}, "/?Action=ListDevices"=>{"get"=>{"summary"=>"List Devices", "description"=>"Lists the devices.", "operationId"=>"listDevices", "x-api-path-slug"=>"actionlistdevices-get", "parameters"=>[{"in"=>"query", "name"=>"AccessToken", "description"=>"The access tokens for the request to list devices", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The limit of the device request", "type"=>"string"}, {"in"=>"query", "name"=>"PaginationToken", "description"=>"The pagination token for the list request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/?Action=ListGroups"=>{"get"=>{"summary"=>"List Groups", "description"=>"Lists the groups associated with a user pool.", "operationId"=>"listGroups", "x-api-path-slug"=>"actionlistgroups-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"The limit of the request to list groups", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/?Action=ListUserImportJobs"=>{"get"=>{"summary"=>"List User Import Jobs", "description"=>"Lists the user import jobs.", "operationId"=>"listUserImportJobs", "x-api-path-slug"=>"actionlistuserimportjobs-get", "parameters"=>[{"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of import jobs you want the request to return", "type"=>"string"}, {"in"=>"query", "name"=>"PaginationToken", "description"=>"An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool that the users are being imported into", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Imports"]}}, "/?Action=ListUserPoolClients"=>{"get"=>{"summary"=>"List User Pool Clients", "description"=>"Lists the clients that have been created for the specified user pool.", "operationId"=>"listUserPoolClients", "x-api-path-slug"=>"actionlistuserpoolclients-get", "parameters"=>[{"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results you want the request to return when listing the user pool clients", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool where you want to list user pool clients", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["user Pool Clients"]}}, "/?Action=ListUserPools"=>{"get"=>{"summary"=>"List User Pools", "description"=>"Lists the user pools associated with an AWS account.", "operationId"=>"listUserPools", "x-api-path-slug"=>"actionlistuserpools-get", "parameters"=>[{"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results you want the request to return when listing the user pools", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["user Pools"]}}, "/?Action=ListUsers"=>{"get"=>{"summary"=>"List Users", "description"=>"Lists the users in the Amazon Cognito user pool.", "operationId"=>"listUsers", "x-api-path-slug"=>"actionlistusers-get", "parameters"=>[{"in"=>"query", "name"=>"AttributesToGet", "description"=>"The attributes to get from the request to list users", "type"=>"string"}, {"in"=>"query", "name"=>"Filter", "description"=>"The filter for the list users request", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The limit of the request to list users", "type"=>"string"}, {"in"=>"query", "name"=>"PaginationToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for which you want to list users", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=ListUsersInGroup"=>{"get"=>{"summary"=>"List Users In Group", "description"=>"Lists the users in the specified group.", "operationId"=>"listUsersInGroup", "x-api-path-slug"=>"actionlistusersingroup-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The limit of the request to list users", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Groups"]}}, "/?Action=ResendConfirmationCode"=>{"get"=>{"summary"=>"Resend Confirmation Code", "description"=>"Resends the confirmation (for confirmation of registration) to a specific user in\n the user pool.", "operationId"=>"resendConfirmationCode", "x-api-path-slug"=>"actionresendconfirmationcode-get", "parameters"=>[{"in"=>"query", "name"=>"ClientId", "description"=>"The ID of the client associated with the user pool", "type"=>"string"}, {"in"=>"query", "name"=>"SecretHash", "description"=>"A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The user name of the user to whom you wish to resend a confirmation code", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Confirmation Code"]}}, "/?Action=RespondToAuthChallenge"=>{"get"=>{"summary"=>"Respond To Auth Challenge", "description"=>"Responds to the authentication challenge.", "operationId"=>"respondToAuthChallenge", "x-api-path-slug"=>"actionrespondtoauthchallenge-get", "parameters"=>[{"in"=>"query", "name"=>"ChallengeName", "description"=>"The name of the challenge", "type"=>"string"}, {"in"=>"query", "name"=>"ChallengeResponses", "description"=>"The responses to the authentication challenge", "type"=>"string"}, {"in"=>"query", "name"=>"ClientId", "description"=>"The client ID", "type"=>"string"}, {"in"=>"query", "name"=>"Session", "description"=>"The session", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authentication Challenges"]}}, "/?Action=SetUserSettings"=>{"get"=>{"summary"=>"Set User Settings", "description"=>"Sets the user settings like multi-factor authentication (MFA).", "operationId"=>"setUserSettings", "x-api-path-slug"=>"actionsetusersettings-get", "parameters"=>[{"in"=>"query", "name"=>"AccessToken", "description"=>"The access token for the set user settings request", "type"=>"string"}, {"in"=>"query", "name"=>"MFAOptions", "description"=>"Specifies the options for MFA (e", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=SignUp"=>{"get"=>{"summary"=>"Sign Up", "description"=>"Registers the user in the specified user pool and creates a user name, password,\n and user attributes.", "operationId"=>"signUp", "x-api-path-slug"=>"actionsignup-get", "parameters"=>[{"in"=>"query", "name"=>"ClientId", "description"=>"The ID of the client associated with the user pool", "type"=>"string"}, {"in"=>"query", "name"=>"Password", "description"=>"The password of the user you wish to register", "type"=>"string"}, {"in"=>"query", "name"=>"SecretHash", "description"=>"A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message", "type"=>"string"}, {"in"=>"query", "name"=>"UserAttributes", "description"=>"An array of name-value pairs representing user attributes", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The user name of the user you wish to register", "type"=>"string"}, {"in"=>"query", "name"=>"ValidationData", "description"=>"The validation data in the request to register a user", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sign Up"]}}, "/?Action=StartUserImportJob"=>{"get"=>{"summary"=>"Start User Import Job", "description"=>"Starts the user import.", "operationId"=>"startUserImportJob", "x-api-path-slug"=>"actionstartuserimportjob-get", "parameters"=>[{"in"=>"query", "name"=>"JobId", "description"=>"The job ID for the user import job", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool that the users are being imported into", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Imports"]}}, "/?Action=StopUserImportJob"=>{"get"=>{"summary"=>"Stop User Import Job", "description"=>"Stops the user import job.", "operationId"=>"stopUserImportJob", "x-api-path-slug"=>"actionstopuserimportjob-get", "parameters"=>[{"in"=>"query", "name"=>"JobId", "description"=>"The job ID for the user import job", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool that the users are being imported into", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Iimport"]}}, "/?Action=UpdateDeviceStatus"=>{"get"=>{"summary"=>"Update Device Status", "description"=>"Updates the device status.", "operationId"=>"updateDeviceStatus", "x-api-path-slug"=>"actionupdatedevicestatus-get", "parameters"=>[{"in"=>"query", "name"=>"AccessToken", "description"=>"The access token", "type"=>"string"}, {"in"=>"query", "name"=>"DeviceKey", "description"=>"The device key", "type"=>"string"}, {"in"=>"query", "name"=>"DeviceRememberedStatus", "description"=>"The status of whether a device is remembered", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/?Action=UpdateGroup"=>{"get"=>{"summary"=>"Update Group", "description"=>"Updates the specified group with the specified attributes.", "operationId"=>"updateGroup", "x-api-path-slug"=>"actionupdategroup-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"A string containing the new description of the group", "type"=>"string"}, {"in"=>"query", "name"=>"GroupName", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"Precedence", "description"=>"The new precedence value for the group", "type"=>"string"}, {"in"=>"query", "name"=>"RoleArn", "description"=>"The new role ARN for the group", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/?Action=UpdateUserAttributes"=>{"get"=>{"summary"=>"Update User Attributes", "description"=>"Allows a user to update a specific attribute (one at a time).", "operationId"=>"updateUserAttributes", "x-api-path-slug"=>"actionupdateuserattributes-get", "parameters"=>[{"in"=>"query", "name"=>"AccessToken", "description"=>"The access token for the request to update user attributes", "type"=>"string"}, {"in"=>"query", "name"=>"UserAttributes", "description"=>"An array of name-value pairs representing user attributes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=UpdateUserPool"=>{"get"=>{"summary"=>"Update User Pool", "description"=>"Updates the specified user pool with the specified attributes.", "operationId"=>"updateUserPool", "x-api-path-slug"=>"actionupdateuserpool-get", "parameters"=>[{"in"=>"query", "name"=>"AdminCreateUserConfig", "description"=>"The configuration for AdminCreateUser requests", "type"=>"string"}, {"in"=>"query", "name"=>"AutoVerifiedAttributes", "description"=>"The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools", "type"=>"string"}, {"in"=>"query", "name"=>"DeviceConfiguration", "description"=>"Device configuration", "type"=>"string"}, {"in"=>"query", "name"=>"EmailConfiguration", "description"=>"Email configuration", "type"=>"string"}, {"in"=>"query", "name"=>"EmailVerificationMessage", "description"=>"The contents of the email verification message", "type"=>"string"}, {"in"=>"query", "name"=>"EmailVerificationSubject", "description"=>"The subject of the email verification message", "type"=>"string"}, {"in"=>"query", "name"=>"LambdaConfig", "description"=>"The AWS Lambda configuration information from the request to update the user pool", "type"=>"string"}, {"in"=>"query", "name"=>"MfaConfiguration", "description"=>"Can be one of the following values:", "type"=>"string"}, {"in"=>"query", "name"=>"Policies", "description"=>"A container with the policies you wish to update in a user pool", "type"=>"string"}, {"in"=>"query", "name"=>"SmsAuthenticationMessage", "description"=>"The contents of the SMS authentication message", "type"=>"string"}, {"in"=>"query", "name"=>"SmsConfiguration", "description"=>"SMS configuration", "type"=>"string"}, {"in"=>"query", "name"=>"SmsVerificationMessage", "description"=>"A container with information about the SMS verification message", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool you want to update", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolTags", "description"=>"The cost allocation tags for the user pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Pools"]}}, "/?Action=UpdateUserPoolClient"=>{"get"=>{"summary"=>"Update User Pool Client", "description"=>"Allows the developer to update the specified user pool client and password\n policy.", "operationId"=>"updateUserPoolClient", "x-api-path-slug"=>"actionupdateuserpoolclient-get", "parameters"=>[{"in"=>"query", "name"=>"ClientId", "description"=>"The ID of the client associated with the user pool", "type"=>"string"}, {"in"=>"query", "name"=>"ClientName", "description"=>"The client name from the update user pool client request", "type"=>"string"}, {"in"=>"query", "name"=>"ExplicitAuthFlows", "description"=>"Explicit authentication flows", "type"=>"string"}, {"in"=>"query", "name"=>"ReadAttributes", "description"=>"The read-only attributes of the user pool", "type"=>"string"}, {"in"=>"query", "name"=>"RefreshTokenValidity", "description"=>"The validity of the refresh token, in days", "type"=>"string"}, {"in"=>"query", "name"=>"UserPoolId", "description"=>"The user pool ID for the user pool where you want to update the user pool client", "type"=>"string"}, {"in"=>"query", "name"=>"WriteAttributes", "description"=>"The writeable attributes of the user pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Pool Clients"]}}, "/?Action=VerifyUserAttribute"=>{"get"=>{"summary"=>"Verify User Attribute", "description"=>"Verifies the specified user attributes in the user pool.", "operationId"=>"verifyUserAttribute", "x-api-path-slug"=>"actionverifyuserattribute-get", "parameters"=>[{"in"=>"query", "name"=>"AccessToken", "description"=>"Represents the access token of the request to verify user attributes", "type"=>"string"}, {"in"=>"query", "name"=>"AttributeName", "description"=>"The attribute name in the request to verify user attributes", "type"=>"string"}, {"in"=>"query", "name"=>"Code", "description"=>"The verification code in the request to verify user attributes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=CreateIdentityPool"=>{"get"=>{"summary"=>"Create Identity Pool", "description"=>"Creates a new identity pool.", "operationId"=>"createIdentityPool", "x-api-path-slug"=>"actioncreateidentitypool-get", "parameters"=>[{"in"=>"query", "name"=>"AllowUnauthenticatedIdentities", "description"=>"TRUE if the identity pool supports unauthenticated logins", "type"=>"string"}, {"in"=>"query", "name"=>"CognitoIdentityProviders", "description"=>"An array of Amazon Cognito Identity user pools and their client IDs", "type"=>"string"}, {"in"=>"query", "name"=>"DeveloperProviderName", "description"=>"The domain by which Cognito will refer to your users", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolName", "description"=>"A string that you provide", "type"=>"string"}, {"in"=>"query", "name"=>"OpenIdConnectProviderARNs", "description"=>"A list of OpendID Connect provider ARNs", "type"=>"string"}, {"in"=>"query", "name"=>"SamlProviderARNs", "description"=>"An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool", "type"=>"string"}, {"in"=>"query", "name"=>"SupportedLoginProviders", "description"=>"Optional key:value pairs mapping provider names to provider app IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Pool"]}}, "/?Action=DeleteIdentities"=>{"get"=>{"summary"=>"Delete Identities", "description"=>"Deletes identities from an identity pool.", "operationId"=>"deleteIdentities", "x-api-path-slug"=>"actiondeleteidentities-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityIdsToDelete", "description"=>"A list of 1-60 identities that you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identities"]}}, "/?Action=DeleteIdentityPool"=>{"get"=>{"summary"=>"Delete Identity Pool", "description"=>"Deletes a user pool.", "operationId"=>"deleteIdentityPool", "x-api-path-slug"=>"actiondeleteidentitypool-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityPoolId", "description"=>"An identity pool ID in the format REGION:GUID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Pool"]}}, "/?Action=DescribeIdentity"=>{"get"=>{"summary"=>"Describe Identity", "description"=>"Returns metadata related to the given identity, including when the identity was\n created and any associated linked logins.", "operationId"=>"describeIdentity", "x-api-path-slug"=>"actiondescribeidentity-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityId", "description"=>"A unique identifier in the format REGION:GUID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identities"]}}, "/?Action=DescribeIdentityPool"=>{"get"=>{"summary"=>"Describe Identity Pool", "description"=>"Gets details about a particular identity pool, including the pool name, ID\n description, creation date, and current number of users.", "operationId"=>"describeIdentityPool", "x-api-path-slug"=>"actiondescribeidentitypool-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityPoolId", "description"=>"An identity pool ID in the format REGION:GUID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Pool"]}}, "/?Action=GetCredentialsForIdentity"=>{"get"=>{"summary"=>"Get Credentials For Identity", "description"=>"Returns credentials for the provided identity ID.", "operationId"=>"getCredentialsForIdentity", "x-api-path-slug"=>"actiongetcredentialsforidentity-get", "parameters"=>[{"in"=>"query", "name"=>"CustomRoleArn", "description"=>"The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityId", "description"=>"A unique identifier in the format REGION:GUID", "type"=>"string"}, {"in"=>"query", "name"=>"Logins", "description"=>"A set of optional name-value pairs that map provider names to provider tokens", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identities"]}}, "/?Action=GetId"=>{"get"=>{"summary"=>"Get Id", "description"=>"Generates (or retrieves) a Cognito ID.", "operationId"=>"getId", "x-api-path-slug"=>"actiongetid-get", "parameters"=>[{"in"=>"query", "name"=>"AccountId", "description"=>"A standard AWS account ID (9+ digits)", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolId", "description"=>"An identity pool ID in the format REGION:GUID", "type"=>"string"}, {"in"=>"query", "name"=>"Logins", "description"=>"A set of optional name-value pairs that map provider names to provider tokens", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identities"]}}, "/?Action=GetIdentityPoolRoles"=>{"get"=>{"summary"=>"Get Identity Pool Roles", "description"=>"Gets the roles for an identity pool.", "operationId"=>"getIdentityPoolRoles", "x-api-path-slug"=>"actiongetidentitypoolroles-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityPoolId", "description"=>"An identity pool ID in the format REGION:GUID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Pool Roles"]}}, "/?Action=GetOpenIdToken"=>{"get"=>{"summary"=>"Get Open Id Token", "description"=>"Gets an OpenID token, using a known Cognito ID.", "operationId"=>"getOpenIdToken", "x-api-path-slug"=>"actiongetopenidtoken-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityId", "description"=>"A unique identifier in the format REGION:GUID", "type"=>"string"}, {"in"=>"query", "name"=>"Logins", "description"=>"A set of optional name-value pairs that map provider names to provider tokens", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open ID Token"]}}, "/?Action=GetOpenIdTokenForDeveloperIdentity"=>{"get"=>{"summary"=>"Get Open Id Token For Developer Identity", "description"=>"Registers (or retrieves) a Cognito IdentityId and an OpenID Connect\n token for a user authenticated by your backend authentication process.", "operationId"=>"getOpenIdTokenForDeveloperIdentity", "x-api-path-slug"=>"actiongetopenidtokenfordeveloperidentity-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityId", "description"=>"A unique identifier in the format REGION:GUID", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolId", "description"=>"An identity pool ID in the format REGION:GUID", "type"=>"string"}, {"in"=>"query", "name"=>"Logins", "description"=>"A set of optional name-value pairs that map provider names to provider tokens", "type"=>"string"}, {"in"=>"query", "name"=>"TokenDuration", "description"=>"The expiration time of the token, in seconds", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open ID Token for Developer Identities"]}}, "/?Action=ListIdentities"=>{"get"=>{"summary"=>"List Identities", "description"=>"Lists the identities in a pool.", "operationId"=>"listIdentities", "x-api-path-slug"=>"actionlistidentities-get", "parameters"=>[{"in"=>"query", "name"=>"HideDisabled", "description"=>"An optional boolean parameter that allows you to hide disabled identities", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolId", "description"=>"An identity pool ID in the format REGION:GUID", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of identities to return", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"A pagination token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identities"]}}, "/?Action=ListIdentityPools"=>{"get"=>{"summary"=>"List Identity Pools", "description"=>"Lists all of the Cognito identity pools registered for your account.", "operationId"=>"listIdentityPools", "x-api-path-slug"=>"actionlistidentitypools-get", "parameters"=>[{"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of identities to return", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"A pagination token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Pool"]}}, "/?Action=LookupDeveloperIdentity"=>{"get"=>{"summary"=>"Lookup Developer Identity", "description"=>"Retrieves the IdentityID associated with a\n DeveloperUserIdentifier or the list of\n DeveloperUserIdentifiers associated with an IdentityId for an\n existing identity.", "operationId"=>"lookupDeveloperIdentity", "x-api-path-slug"=>"actionlookupdeveloperidentity-get", "parameters"=>[{"in"=>"query", "name"=>"DeveloperUserIdentifier", "description"=>"A unique ID used by your backend authentication process to identify a user", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityId", "description"=>"A unique identifier in the format REGION:GUID", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolId", "description"=>"An identity pool ID in the format REGION:GUID", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of identities to return", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"A pagination token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Developer Identities"]}}, "/?Action=MergeDeveloperIdentities"=>{"get"=>{"summary"=>"Merge Developer Identities", "description"=>"Merges two users having different IdentityIds, existing in the same\n identity pool, and identified by the same developer provider.", "operationId"=>"mergeDeveloperIdentities", "x-api-path-slug"=>"actionmergedeveloperidentities-get", "parameters"=>[{"in"=>"query", "name"=>"DestinationUserIdentifier", "description"=>"User identifier for the destination user", "type"=>"string"}, {"in"=>"query", "name"=>"DeveloperProviderName", "description"=>"The domain by which Cognito will refer to your users", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolId", "description"=>"An identity pool ID in the format REGION:GUID", "type"=>"string"}, {"in"=>"query", "name"=>"SourceUserIdentifier", "description"=>"User identifier for the source user", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Developer Identities"]}}, "/?Action=SetIdentityPoolRoles"=>{"get"=>{"summary"=>"Set Identity Pool Roles", "description"=>"Sets the roles for an identity pool.", "operationId"=>"setIdentityPoolRoles", "x-api-path-slug"=>"actionsetidentitypoolroles-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityPoolId", "description"=>"An identity pool ID in the format REGION:GUID", "type"=>"string"}, {"in"=>"query", "name"=>"RoleMappings", "description"=>"How users for a specific identity provider are to mapped to roles", "type"=>"string"}, {"in"=>"query", "name"=>"Roles", "description"=>"The map of roles associated with this pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Pool"]}}, "/?Action=UnlinkDeveloperIdentity"=>{"get"=>{"summary"=>"Unlink Developer Identity", "description"=>"Unlinks a DeveloperUserIdentifier from an existing identity.", "operationId"=>"unlinkDeveloperIdentity", "x-api-path-slug"=>"actionunlinkdeveloperidentity-get", "parameters"=>[{"in"=>"query", "name"=>"DeveloperProviderName", "description"=>"The domain by which Cognito will refer to your users", "type"=>"string"}, {"in"=>"query", "name"=>"DeveloperUserIdentifier", "description"=>"A unique ID used by your backend authentication process to identify a user", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityId", "description"=>"A unique identifier in the format REGION:GUID", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolId", "description"=>"An identity pool ID in the format REGION:GUID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Developer Identities"]}}, "/?Action=UnlinkIdentity"=>{"get"=>{"summary"=>"Unlink Identity", "description"=>"Unlinks a federated identity from an existing account.", "operationId"=>"unlinkIdentity", "x-api-path-slug"=>"actionunlinkidentity-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityId", "description"=>"A unique identifier in the format REGION:GUID", "type"=>"string"}, {"in"=>"query", "name"=>"Logins", "description"=>"A set of optional name-value pairs that map provider names to provider tokens", "type"=>"string"}, {"in"=>"query", "name"=>"LoginsToRemove", "description"=>"Provider names to unlink from this identity", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identities"]}}, "/?Action=UpdateIdentityPool"=>{"get"=>{"summary"=>"Update Identity Pool", "description"=>"Updates a user pool.", "operationId"=>"updateIdentityPool", "x-api-path-slug"=>"actionupdateidentitypool-get", "parameters"=>[{"in"=>"query", "name"=>"AllowUnauthenticatedIdentities", "description"=>"TRUE if the identity pool supports unauthenticated logins", "type"=>"string"}, {"in"=>"query", "name"=>"CognitoIdentityProviders", "description"=>"A list representing an Amazon Cognito Identity User Pool and its client ID", "type"=>"string"}, {"in"=>"query", "name"=>"DeveloperProviderName", "description"=>"The domain by which Cognito will refer to your users", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolId", "description"=>"An identity pool ID in the format REGION:GUID", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolName", "description"=>"A string that you provide", "type"=>"string"}, {"in"=>"query", "name"=>"OpenIdConnectProviderARNs", "description"=>"A list of OpendID Connect provider ARNs", "type"=>"string"}, {"in"=>"query", "name"=>"SamlProviderARNs", "description"=>"An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool", "type"=>"string"}, {"in"=>"query", "name"=>"SupportedLoginProviders", "description"=>"Optional key:value pairs mapping provider names to provider app IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Pool"]}}, "/?Action=BulkPublish"=>{"get"=>{"summary"=>"Bulk Publish", "description"=>"Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream.", "operationId"=>"bulkPublish", "x-api-path-slug"=>"actionbulkpublish-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityPoolId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Publish"]}}, "/?Action=DeleteDataset"=>{"get"=>{"summary"=>"Delete Dataset", "description"=>"Deletes the specific dataset.", "operationId"=>"deleteDataset", "x-api-path-slug"=>"actiondeletedataset-get", "parameters"=>[{"in"=>"query", "name"=>"DatasetName", "description"=>"A string of up to 128 characters", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}}, "/?Action=DescribeDataset"=>{"get"=>{"summary"=>"Describe Dataset", "description"=>"Gets meta data about a dataset by identity and dataset name.", "operationId"=>"describeDataset", "x-api-path-slug"=>"actiondescribedataset-get", "parameters"=>[{"in"=>"query", "name"=>"DatasetName", "description"=>"A string of up to 128 characters", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}}, "/?Action=DescribeIdentityPoolUsage"=>{"get"=>{"summary"=>"Describe Identity Pool Usage", "description"=>"Gets usage details (for example, data storage) about a particular identity pool.", "operationId"=>"describeIdentityPoolUsage", "x-api-path-slug"=>"actiondescribeidentitypoolusage-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityPoolId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Pool Usage"]}}, "/?Action=DescribeIdentityUsage"=>{"get"=>{"summary"=>"Describe Identity Usage", "description"=>"Gets usage information for an identity, including number of datasets and data usage.", "operationId"=>"describeIdentityUsage", "x-api-path-slug"=>"actiondescribeidentityusage-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Pool Usage"]}}, "/?Action=GetBulkPublishDetails"=>{"get"=>{"summary"=>"Get Bulk Publish Details", "description"=>"Get the status of the last BulkPublish operation for an identity pool.", "operationId"=>"getBulkPublishDetails", "x-api-path-slug"=>"actiongetbulkpublishdetails-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityPoolId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Publish"]}}, "/?Action=GetCognitoEvents"=>{"get"=>{"summary"=>"Get Cognito Events", "description"=>"Gets the events and the corresponding Lambda functions associated with an identity pool.", "operationId"=>"getCognitoEvents", "x-api-path-slug"=>"actiongetcognitoevents-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityPoolId", "description"=>"The Cognito Identity Pool ID for the request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/?Action=GetIdentityPoolConfiguration"=>{"get"=>{"summary"=>"Get Identity Pool Configuration", "description"=>"Gets the configuration settings of an identity pool.", "operationId"=>"getIdentityPoolConfiguration", "x-api-path-slug"=>"actiongetidentitypoolconfiguration-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityPoolId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Pools"]}}, "/?Action=ListDatasets"=>{"get"=>{"summary"=>"List Datasets", "description"=>"Lists datasets for an identity.", "operationId"=>"listDatasets", "x-api-path-slug"=>"actionlistdatasets-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to be returned", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"A pagination token for obtaining the next page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}}, "/?Action=ListIdentityPoolUsage"=>{"get"=>{"summary"=>"List Identity Pool Usage", "description"=>"Gets a list of identity pools registered with Cognito.", "operationId"=>"listIdentityPoolUsage", "x-api-path-slug"=>"actionlistidentitypoolusage-get", "parameters"=>[{"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to be returned", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"A pagination token for obtaining the next page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Pools"]}}, "/?Action=ListRecords"=>{"get"=>{"summary"=>"List Records", "description"=>"Gets paginated records, optionally changed after a particular sync count for a dataset and identity.", "operationId"=>"listRecords", "x-api-path-slug"=>"actionlistrecords-get", "parameters"=>[{"in"=>"query", "name"=>"DatasetName", "description"=>"A string of up to 128 characters", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}, {"in"=>"query", "name"=>"LastSyncCount", "description"=>"The last server sync count for this record", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to be returned", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"A pagination token for obtaining the next page of results", "type"=>"string"}, {"in"=>"query", "name"=>"SyncSessionToken", "description"=>"A token containing a session ID, identity ID, and expiration", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Records"]}}, "/?Action=RegisterDevice"=>{"get"=>{"summary"=>"Register Device", "description"=>"Registers a device to receive push sync notifications.", "operationId"=>"registerDevice", "x-api-path-slug"=>"actionregisterdevice-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityId", "description"=>"The unique ID for this identity", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/?Action=SetCognitoEvents"=>{"get"=>{"summary"=>"Set Cognito Events", "description"=>"Sets the AWS Lambda function for a given event type for an identity pool.", "operationId"=>"setCognitoEvents", "x-api-path-slug"=>"actionsetcognitoevents-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityPoolId", "description"=>"The Cognito Identity Pool to use when configuring Cognito Events", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/?Action=SetIdentityPoolConfiguration"=>{"get"=>{"summary"=>"Set Identity Pool Configuration", "description"=>"Sets the necessary configuration for push sync.", "operationId"=>"setIdentityPoolConfiguration", "x-api-path-slug"=>"actionsetidentitypoolconfiguration-get", "parameters"=>[{"in"=>"query", "name"=>"IdentityPoolId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Pools"]}}, "/?Action=SubscribeToDataset"=>{"get"=>{"summary"=>"Subscribe To Dataset", "description"=>"Subscribes to receive notifications when a dataset is modified by another device.", "operationId"=>"subscribeToDataset", "x-api-path-slug"=>"actionsubscribetodataset-get", "parameters"=>[{"in"=>"query", "name"=>"DatasetName", "description"=>"The name of the dataset to subcribe to", "type"=>"string"}, {"in"=>"query", "name"=>"DeviceId", "description"=>"The unique ID generated for this device by Cognito", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityId", "description"=>"Unique ID for this identity", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}}, "/?Action=UnsubscribeFromDataset"=>{"get"=>{"summary"=>"Unsubscribe From Dataset", "description"=>"Unsubscribes from receiving notifications when a dataset is modified by another device.", "operationId"=>"unsubscribeFromDataset", "x-api-path-slug"=>"actionunsubscribefromdataset-get", "parameters"=>[{"in"=>"query", "name"=>"DatasetName", "description"=>"The name of the dataset from which to unsubcribe", "type"=>"string"}, {"in"=>"query", "name"=>"DeviceId", "description"=>"The unique ID generated for this device by Cognito", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityId", "description"=>"Unique ID for this identity", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}}, "/?Action=UpdateRecords"=>{"get"=>{"summary"=>"Update Records", "description"=>"Posts updates to records and adds and deletes records for a dataset and user.", "operationId"=>"updateRecords", "x-api-path-slug"=>"actionupdaterecords-get", "parameters"=>[{"in"=>"query", "name"=>"ClientContext", "description"=>"Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods", "type"=>"string"}, {"in"=>"query", "name"=>"DatasetName", "description"=>"A string of up to 128 characters", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}, {"in"=>"query", "name"=>"IdentityPoolId", "description"=>"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Records"]}}}}, "apis"=>{"name"=>"AWS Cognito", "x-slug"=>"aws-cognito", "description"=>"Amazon Cognito lets you easily add user sign-up and sign-in to your mobile and web apps. With Amazon Cognito, you also have the options to authenticate users through social identity providers such as Facebook, Twitter, or Amazon, with SAML identity solutions, or by using your own identity system. In addition, Amazon Cognito enables you to save data locally on users devices, allowing your applications to work even when the devices are offline. You can then synchronize data across users devices so that their app experience remains consistent regardless of the device they use. With Amazon Cognito, you can focus on creating great app experiences instead of worrying about building, securing, and scaling a solution to handle user management, authentication, and sync across devices.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-cognito.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Authentication,Facebook,Identities,Profiles,Relative Data,Service API,Social,Stack Network,Twitter", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-cognito/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Cognito API", "x-api-slug"=>"aws-cognito-api", "description"=>"Amazon Cognito lets you easily add user sign-up and sign-in to your mobile and web apps. With Amazon Cognito, you also have the options to authenticate users through social identity providers such as Facebook, Twitter, or Amazon, with SAML identity solutions, or by using your own identity system. In addition, Amazon Cognito enables you to save data locally on users devices, allowing your applications to work even when the devices are offline. You can then synchronize data across users devices so that their app experience remains consistent regardless of the device they use. With Amazon Cognito, you can focus on creating great app experiences instead of worrying about building, securing, and scaling a solution to handle user management, authentication, and sync across devices.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-cognito.png", "humanURL"=>"https://aws.amazon.com/cognito/", "baseURL"=>"https:///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Authentication,Facebook,Identities,Profiles,Relative Data,Service API,Social,Stack Network,Twitter", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-cognito/actionupdaterecords-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-cognito/aws-cognito-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://aws.amazon.com/cognito/dev-resources/#blogposts"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/Welcome.html"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/cognitosync/latest/APIReference/Welcome.html"}, {"type"=>"x-faq", "url"=>"http://aws.amazon.com/cognito/faqs"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=173"}, {"type"=>"x-pricing", "url"=>"http://aws.amazon.com/cognito/pricing"}, {"type"=>"x-sdk", "url"=>"https://aws.amazon.com/cognito/dev-resources/#documentation"}, {"type"=>"x-slides", "url"=>"https://aws.amazon.com/cognito/dev-resources/#slides"}, {"type"=>"x-videos", "url"=>"https://aws.amazon.com/cognito/dev-resources/#videos"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/cognito/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bureau-of-justice-statistics{"national-crime-victimization-survey-ncvs-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bureau of Justice Statistics", "x-complete"=>1, "info"=>{"title"=>"National Crime Victimization Survey (NCVS) API", "description"=>"the-ncvs-national-crime-victimization-survey-restful-api-is-a-web-service-that-provides-criminal-victimization-data-obtained-annually-from-a-nationally-representative-sample-of-about-79800-households-and-143210-persons-interviewed-each-year--", "version"=>"v2"}, "host"=>"www.bjs.gov", "basePath"=>"/bjs/ncvs/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"v2/"=>{"get"=>{"summary"=>"Get", "description"=>"Returns a list of available datasets and data types they are available in.", "operationId"=>"getV2", "x-api-path-slug"=>"v2-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "v2/household/fields/"=>{"get"=>{"summary"=>"Get Household Fields", "description"=>"Returns a description of the fields/columns used returned in the household data sets.", "operationId"=>"getV2HouseholdFields", "x-api-path-slug"=>"v2householdfields-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Household", "Fields"]}}, "v2/household/population/{year}"=>{"get"=>{"summary"=>"Get Household Population Year", "description"=>"Returns the personal population of reported incidents.", "operationId"=>"getV2HouseholdPopulationYear", "x-api-path-slug"=>"v2householdpopulationyear-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Format the data will be provided in"}, {"in"=>"query", "name"=>"year", "description"=>"Year will limit the data to only values that occurred the given year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Household", "Population", "Year"]}}, "v2/household/{year}"=>{"get"=>{"summary"=>"Get Household Year", "description"=>"Returns the household counts of reported incidents", "operationId"=>"getV2HouseholdYear", "x-api-path-slug"=>"v2householdyear-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Format the data will be provided in"}, {"in"=>"query", "name"=>"year", "description"=>"Year will limit the data to only values that occurred the given year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Household", "Year"]}}, "v2/personal/fields/"=>{"get"=>{"summary"=>"Get Personal Fields", "description"=>"Returns a description of the fields/columns used returned in the personal data sets.", "operationId"=>"getV2PersonalFields", "x-api-path-slug"=>"v2personalfields-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Personal", "Fields"]}}, "v2/personal/population/{year}"=>{"get"=>{"summary"=>"Get Personal Population Year", "description"=>"Returns the personal population of reported incidents.", "operationId"=>"getV2PersonalPopulationYear", "x-api-path-slug"=>"v2personalpopulationyear-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Format the data will be provided in"}, {"in"=>"query", "name"=>"year", "description"=>"Year will limit the data to only values that occurred the given year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Personal", "Population", "Year"]}}, "v2/personal/{year}"=>{"get"=>{"summary"=>"Get Personal Year", "description"=>"Returns the personal counts of reported incidents.", "operationId"=>"getV2PersonalYear", "x-api-path-slug"=>"v2personalyear-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Format the data will be provided in"}, {"in"=>"query", "name"=>"year", "description"=>"Year will limit the data to only values that occurred the given year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Personal", "Year"]}}}}, "apis"=>{"name"=>"Bureau of Justice Statistics", "x-slug"=>"bureau-of-justice-statistics", "description"=>"The United States Bureau of Justice Statistics (BJS) is a federal government agency belonging to the U.S. Department of Justice and a principal agency of the U.S. Federal Statistical System. Established on December 27, 1979, the bureau collects, analyzes and publishes data relating to crime in the United States. The agency publishes data regarding statistics gathered from the roughly fifty-thousand agencies that comprise the U.S. justice system on its Web site.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/US-DeptOfJustice-Seal.svg.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,Data Provider,Federal Government,General Data,Profiles,Stack Network,Surveillance", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bureau-of-justice-statistics/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"National Crime Victimization Survey (NCVS) API", "x-api-slug"=>"national-crime-victimization-survey-ncvs-api", "description"=>"NCVS data describe the frequency, characteristics and consequences of criminal victimization in the United States. The NCVS provides the largest national forum for victims to describe the impact of crime and characteristics of violent offenders. It is one of two primary data collections about crime in the United States and is the only source of data about crimes not reported to the police. The NCVS API page provides developers with end-points in XML, JSON, and CSV formats along with related codebooks, methodology, metadata and usage instructions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/US-DeptOfJustice-Seal.svg.png", "humanURL"=>"http://bjs.gov", "baseURL"=>"http://www.bjs.gov//bjs/ncvs/", "tags"=>"API Provider,Data Provider,Federal Government,General Data,Profiles,Stack Network,Surveillance", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bureau-of-justice-statistics/v2personalyear-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bureau-of-justice-statistics/national-crime-victimization-survey-ncvs-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"http://www.bjs.gov/developer/"}, {"type"=>"x-website", "url"=>"http://bjs.gov"}, {"type"=>"x-website", "url"=>"http://www.bjs.gov"}, {"type"=>"x-wikipedia", "url"=>"http://en.wikipedia.org/wiki/Bureau_of_Justice_Statistics"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
onsched{"onsched-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"OnSched", "x-complete"=>1, "info"=>{"title"=>"OnSched API", "description"=>"build-secure-and-scalable-custom-apps-for-online-booking--our-flexible-api-provides-many-options-for-availability-and-booking--take-the-api-for-a-test-drive--just-click-on-the-authorize-button-above-and-authenticate---you-can-access-our-demo-company-profile-if-you-are-not-a-customer-or-your-own-profile-by-using-your-assigned-clientid-and-secret---------------------", "termsOfService"=>"None", "contact"=>{"name"=>"OnSched.com", "url"=>"https://onsched.com", "email"=>"info@onsched.com"}, "version"=>"1.0.0"}, "host"=>"api.onsched.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/consumer/v1/appointments"=>{"get"=>{"summary"=>"Returns a list of appointments.", "description"=>"The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20.\r\nUse the other query parameters to optionally filter the results list.", "operationId"=>"ConsumerV1AppointmentsGet", "x-api-path-slug"=>"consumerv1appointments-get", "parameters"=>[{"in"=>"query", "name"=>"customerId", "description"=>"Filter appointments by customer"}, {"in"=>"query", "name"=>"email", "description"=>"Filter appointments by email address"}, {"in"=>"query", "name"=>"limit", "description"=>"Page limit, default 20"}, {"in"=>"query", "name"=>"locationId", "description"=>"The id of the business location"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting row of page, default 0"}, {"in"=>"query", "name"=>"resourceId", "description"=>"Filter appointments by resource"}, {"in"=>"query", "name"=>"serviceId", "description"=>"Filter appointments by service"}, {"in"=>"query", "name"=>"status", "description"=>"Filter appointments by status: IN, BK, CN, RE, RS"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointments"]}, "post"=>{"summary"=>"Returns an appointment object", "description"=>"This end point creates a new appointment in an Initial \"IN\" status. \r\n\r\nA valid serviceId is required. Use GET consumer/v1/services to retrieve a list of your services.\r\n\r\nA valid resourceId is required if your calendar is a resource based calendar. Use consumer/v1/resources to retrieve a list of your resources.\r\n\r\nStartDateTime and EndDateTime are required. Use the ISO 8601 format for DateTime Timezone. e.g. 2016-10-30T9:00:00-5:00", "operationId"=>"ConsumerV1AppointmentsPost", "x-api-path-slug"=>"consumerv1appointments-post", "parameters"=>[{"in"=>"body", "name"=>"appointmentIM", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointments"]}}, "/consumer/v1/appointments/{id}"=>{"get"=>{"summary"=>"Returns an appointment object.", "description"=>"The result returned is a single appointment object. A valid id is required to find the appointment. \r\n\r\nFind appointment id's using the GET consumer/v1/appointments end point.", "operationId"=>"ConsumerV1AppointmentsByIdGet", "x-api-path-slug"=>"consumerv1appointmentsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the appointment object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointments"]}, "delete"=>{"summary"=>"Returns an appointment object", "description"=>"This end point deletes a booking. Only appointments in a \"IN\" initial status can be deleted.\r\nPast dated appointments cannot be cancelled.\r\n\r\nA valid appointment id is required. Use the appointmentId returned from GET /consumer/v1/appointments", "operationId"=>"ConsumerV1AppointmentsByIdDelete", "x-api-path-slug"=>"consumerv1appointmentsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointments"]}}, "/consumer/v1/appointments/{id}/book"=>{"put"=>{"summary"=>"Returns an appointment object", "description"=>"This end point completes a new booking. Only appointments in the \"IN\" initial status can be booked.\r\nby saving all the relevant details of the booking.\r\n\r\nA valid appointment id is required. Use the appointmentId returned from POST /consumer/v1/appointments\r\n\r\nTo update appointment custom field values, use the GET /consumer/v1/appointments/customfields information\r\nto understand your definitions of custom fields and what key and values to update.", "operationId"=>"ConsumerV1AppointmentsByIdBookPut", "x-api-path-slug"=>"consumerv1appointmentsidbook-put", "parameters"=>[{"in"=>"body", "name"=>"appointmentBookModel", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointments", "Book"]}}, "/consumer/v1/appointments/{id}/cancel"=>{"put"=>{"summary"=>"Returns an appointment object", "description"=>"This end point cancels a booking or reservation. Only appointments in a \"BK\" booked, or \"RS\" reserved status can be cancelled.\r\nPast dated appointments cannot be cancelled.\r\n\r\nA valid appointment id is required. Use the appointmentId returned from POST /consumer/v1/appointments", "operationId"=>"ConsumerV1AppointmentsByIdCancelPut", "x-api-path-slug"=>"consumerv1appointmentsidcancel-put", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointments", "Cancel"]}}, "/consumer/v1/appointments/{id}/reschedule"=>{"put"=>{"summary"=>"Returns an appointment object", "description"=>"This end point reschedules a booking. Only appointments in a \"BK\" booked status can be rescheduled.\r\nPast dated appointments cannot be cancelled.\r\n\r\nA valid appointment id is required. Use the appointmentId returned from GET /consumer/v1/appointments.\r\n\r\nThe serviceId and resourceId are optional. If you want your users to change the resource or service on a reschedule\r\nyou will have to use the regular availability endpoint rather than the reschedule availability end point.\r\n\r\nUse the GET /consumer/v1/availability/{id}/reschedule endpoint to display a list of available times\r\nfor the end user to choose from to reschedule the original appointment.", "operationId"=>"ConsumerV1AppointmentsByIdReschedulePut", "x-api-path-slug"=>"consumerv1appointmentsidreschedule-put", "parameters"=>[{"in"=>"body", "name"=>"appointmentRM", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"appointment id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointments", "Reschedule"]}}, "/consumer/v1/appointments/customfields"=>{"get"=>{"summary"=>"Returns a list of appointment custom field definitions", "description"=>"This end point returns your Appointment custom field definitions.\r\n\r\nAppointment custom fields are different than Customer custom fields. Appointment custom fields are\r\nstored with each appointment. They are used when the information collected during the booking is specific\r\nto a particular visit.\r\n\r\nUse the field, and type to determine how to update field values\r\nin PUT /consumer/v1/appointments/{id}/book", "operationId"=>"ConsumerV1AppointmentsCustomfieldsGet", "x-api-path-slug"=>"consumerv1appointmentscustomfields-get", "parameters"=>[{"in"=>"query", "name"=>"locationId", "description"=>"The id of the business location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointments", "Customfields"]}}, "/consumer/v1/appointments/bookingfields"=>{"get"=>{"summary"=>"", "description"=>"", "operationId"=>"ConsumerV1AppointmentsBookingfieldsGet", "x-api-path-slug"=>"consumerv1appointmentsbookingfields-get", "parameters"=>[{"in"=>"query", "name"=>"locationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointments", "Bookingfields"]}}, "/consumer/v1/availability/{serviceId}/{startDate}/{endDate}"=>{"get"=>{"summary"=>"Returns a list of available times.", "description"=>"Choose your search criteria carefully. Availability is an expensive call. If you search availability for all resources\r\nthen you should only do so for a single date. If you decide to search availability for multiple dates you should only do so\r\nfor a specific resource by specifying the optional resourceId parameter.\r\n\r\nStart and End times are specified as military times e.g. 800 = 8:00am, 2230 = 10:30pm. \r\nYou will only see availability within the boundary of your business start and end times.\r\n\r\ndayAvailability will return day availablility for the number of days requested from the start date.\r\n\r\nfirstDayAvailable only works with day availability. If set to true it will look for the first day available within the range specified\r\nby the dayAvailability parameter. The two parameters together can be a clever way to display availability for a week or month.\r\nTip - pass in the beginning of the week or month, and available times are displayed for the first available date if exists.\r\n\r\nYou should only specify the duration parameter if you let your customers choose the duration of the appointment. e.g. from a list.\r\n\r\nThe tz parameter allows you to select a suitable timezone for the customer to book in. Your app should be timezone aware if you \r\nuse this option. The requested timezone is specified as an offset(plus or minus) from GMT time.", "operationId"=>"ConsumerV1AvailabilityByServiceIdByStartDateByEndDateGet", "x-api-path-slug"=>"consumerv1availabilityserviceidstartdateenddate-get", "parameters"=>[{"in"=>"query", "name"=>"dayAvailability", "description"=>"Return day availability for number of days specified"}, {"in"=>"query", "name"=>"duration", "description"=>"Duration of the service if different than the default"}, {"in"=>"path", "name"=>"endDate", "description"=>"End Date for availability search"}, {"in"=>"query", "name"=>"endTime", "description"=>"End Time for availability search"}, {"in"=>"query", "name"=>"firstDayAvailable", "description"=>"Return available times for the first available day"}, {"in"=>"query", "name"=>"locationId", "description"=>"The id of the business location"}, {"in"=>"query", "name"=>"resourceGroupId", "description"=>"Resource Group Id for availability search"}, {"in"=>"query", "name"=>"resourceId", "description"=>"Resource Id for availability search"}, {"in"=>"query", "name"=>"resourceIds", "description"=>"Comma separated Resource Ids for availability search"}, {"in"=>"path", "name"=>"serviceId", "description"=>"Service Id for availability search"}, {"in"=>"path", "name"=>"startDate", "description"=>"Start Date for availability search"}, {"in"=>"query", "name"=>"startTime", "description"=>"Start Time for availability search"}, {"in"=>"query", "name"=>"tzOffset", "description"=>"Request timezone offset to view availability"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availability", "ServiceId", "StartDate", "EndDate"]}}, "/consumer/v1/availability/{serviceId}/{startDate}/{endDate}/days"=>{"get"=>{"summary"=>"Returns a list of available days.", "description"=>"This end point is used to show day level availability. For example if the business is closed, or there is a public holiday.\r\n\r\nDay level availability is a good way to restrict your choices of dates in your app and improve usability.", "operationId"=>"ConsumerV1AvailabilityByServiceIdByStartDateByEndDateDaysGet", "x-api-path-slug"=>"consumerv1availabilityserviceidstartdateenddatedays-get", "parameters"=>[{"in"=>"path", "name"=>"endDate", "description"=>"End Date for availability search"}, {"in"=>"query", "name"=>"locationId", "description"=>"The id of the business location"}, {"in"=>"query", "name"=>"resourceId", "description"=>"Resource Id to filter on"}, {"in"=>"path", "name"=>"serviceId", "description"=>"Service Id for availability search"}, {"in"=>"path", "name"=>"startDate", "description"=>"Start Date for availability search"}, {"in"=>"query", "name"=>"tzOffset", "description"=>"Request timezone offset to view availability"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availability", "ServiceId", "StartDate", "EndDate", "Days"]}}, "/consumer/v1/availability/{serviceId}/{startDate}/{endDate}/unavailable"=>{"get"=>{"summary"=>"Returns a list of unavailable times.", "description"=>"This endpoint is used to show unavailable times and provides information why the timeslot is unavailable.", "operationId"=>"ConsumerV1AvailabilityByServiceIdByStartDateByEndDateUnavailableGet", "x-api-path-slug"=>"consumerv1availabilityserviceidstartdateenddateunavailable-get", "parameters"=>[{"in"=>"query", "name"=>"duration", "description"=>"Duration of the service if different than the default"}, {"in"=>"path", "name"=>"endDate", "description"=>"End Date for unavailable time search"}, {"in"=>"query", "name"=>"locationId", "description"=>"The id of the business location"}, {"in"=>"query", "name"=>"resourceId", "description"=>"Resource Id to filter on"}, {"in"=>"path", "name"=>"serviceId", "description"=>"Service Id for availability search"}, {"in"=>"path", "name"=>"startDate", "description"=>"Start Date for unavailable time search"}, {"in"=>"query", "name"=>"tzOffset", "description"=>"Request timezone offset to view unavailable times"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availability", "ServiceId", "StartDate", "EndDate", "Unavailable"]}}, "/consumer/v1/availability/{appointmentId}/reschedule"=>{"get"=>{"summary"=>"Returns a list of available times.", "description"=>"This end point is used to find availability for the purpose of rescheduling an appointment.\r\nAvailability defaults to the serviceId, resourceId and timezone from the original appointment.\r\nAfter choosing from the availability, you can call the appointment reschedule endpoint.", "operationId"=>"ConsumerV1AvailabilityByAppointmentIdRescheduleGet", "x-api-path-slug"=>"consumerv1availabilityappointmentidreschedule-get", "parameters"=>[{"in"=>"path", "name"=>"appointmentId", "description"=>"Appointment Id of the original appointment being rescheduled"}, {"in"=>"query", "name"=>"tzOffset", "description"=>"Request timezone offset to view availability"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availability", "AppointmentId", "Reschedule"]}}, "/consumer/v1/customers"=>{"get"=>{"summary"=>"Returns a list of customers.", "description"=>"The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20.\r\nUse the other query parameters to optionally filter the results list.", "operationId"=>"ConsumerV1CustomersGet", "x-api-path-slug"=>"consumerv1customers-get", "parameters"=>[{"in"=>"query", "name"=>"deleted", "description"=>"Filter customers by deleted status"}, {"in"=>"query", "name"=>"email", "description"=>"Filter customers by email address"}, {"in"=>"query", "name"=>"groupId", "description"=>"Filter customers by group"}, {"in"=>"query", "name"=>"lastname", "description"=>"Search customers by lastname"}, {"in"=>"query", "name"=>"limit", "description"=>"Page limit, default 20"}, {"in"=>"query", "name"=>"locationId", "description"=>"The id of the business location"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting row of page, default 0"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}, "post"=>{"summary"=>"Creates a new customer object.", "description"=>"Use this endpoint to create a new customer. If not specified the business location id defaults to the first location in the company.\r\nEmail Address and a lastname are required for creating a new customer.", "operationId"=>"ConsumerV1CustomersPost", "x-api-path-slug"=>"consumerv1customers-post", "parameters"=>[{"in"=>"body", "name"=>"customerIM", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}}, "/consumer/v1/customers/{id}"=>{"get"=>{"summary"=>"Returns a customer object.", "description"=>"The result returned is a single customer object. An id is required to find the customer. Find customer id's using either the GET consumer/v1/customers end point,\r\nor the GET consumer/v1/appointments end point. A customer object is automatically created with the first booking if it doesn't already exist.", "operationId"=>"ConsumerV1CustomersByIdGet", "x-api-path-slug"=>"consumerv1customersid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the customer object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}, "put"=>{"summary"=>"Updates a customer object.", "description"=>"Use this endpoint to update customer information. If not specified the business location id defaults to the first location in the company.\r\nBlank fields are not changed", "operationId"=>"ConsumerV1CustomersByIdPut", "x-api-path-slug"=>"consumerv1customersid-put", "parameters"=>[{"in"=>"body", "name"=>"customerUM", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}, "delete"=>{"summary"=>"Deletes a customer subscription object.", "description"=>"Deletes a customer subscription object.", "operationId"=>"ConsumerV1CustomersByIdDelete", "x-api-path-slug"=>"consumerv1customersid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}}, "/consumer/v1/customers/customfields"=>{"get"=>{"summary"=>"Returns a list of customField objects", "description"=>"This end point returns your Customer custom field definitions.\r\n\r\nCustomer custom fields are different than Appointment custom fields. Appointment custom fields are\r\nstored with each appointment. They are used when the information collected during the booking is specific\r\nto a particular visit, where as Customer custom fields are stored with the customer profile. \r\n\r\nUse the key field, and type to determine how to update field values\r\nin POST /consumer/v1/customers and PUT /consumer/v1/customers/{id}", "operationId"=>"ConsumerV1CustomersCustomfieldsGet", "x-api-path-slug"=>"consumerv1customerscustomfields-get", "parameters"=>[{"in"=>"query", "name"=>"leadQuestions", "description"=>"A true/false indicator to filter on custom fields used for lead questions"}, {"in"=>"query", "name"=>"locationId", "description"=>"The id of the business location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Customfields"]}}, "/consumer/v1/customers/registrationfields"=>{"get"=>{"summary"=>"Returns a list of lead questions", "description"=>"This end point returns your Customer Registration fields.\r\n\r\nCustomer custom fields are different than Appointment custom fields. Appointment custom fields are\r\nstored with each appointment. They are used when the information collected during the booking is specific\r\nto a particular visit, where as Customer custom fields are stored with the customer profile.", "operationId"=>"ConsumerV1CustomersRegistrationfieldsGet", "x-api-path-slug"=>"consumerv1customersregistrationfields-get", "parameters"=>[{"in"=>"query", "name"=>"locationId", "description"=>"The id of the business location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Registrationfields"]}}, "/consumer/v1/customers/plans"=>{"get"=>{"summary"=>"Returns a list of customers.", "description"=>"The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20.\r\nUse the other query parameters to optionally filter the results list.", "operationId"=>"ConsumerV1CustomersPlansGet", "x-api-path-slug"=>"consumerv1customersplans-get", "parameters"=>[{"in"=>"query", "name"=>"groupId", "description"=>"Filter customers by group"}, {"in"=>"query", "name"=>"limit", "description"=>"Page limit, default 20"}, {"in"=>"query", "name"=>"locationId", "description"=>"The id of the business location"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting row of page, default 0"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Plans"]}}, "/consumer/v1/customers/plans/{id}"=>{"get"=>{"summary"=>"Returns a customer object.", "description"=>"The result returned is a single customer object. An id is required to find the customer. Find customer id's using either the GET consumer/v1/customers end point,\r\nor the GET consumer/v1/appointments end point. A customer object is automatically created with the first booking if it doesn't already exist.", "operationId"=>"ConsumerV1CustomersPlansByIdGet", "x-api-path-slug"=>"consumerv1customersplansid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the customer object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Plans"]}}, "/consumer/v1/customers/{id}/planlimits/{serviceId}/{resourceId}/{dateTimeTz}"=>{"get"=>{"summary"=>"Returns a list of customer booking limits.", "description"=>"The result returned is list of limit rules as defined by the subscribed customer plan along with Booking Counts/Minutes\r\nThe results indicate the remaining bookings count / minutes. Use the results in your app to determine if the customer should continue booking.\r\nYou can enforce Limits in periods: Daily,Weekly,Monthly and for maximum total limits. Maximum total limits is based on six months prior to\r\nthe DateTimeTz and six months after the DateTimeTz. Daily, Weekly and Monthly limits are based on the calculated period relative to the\r\nsubscription plan start. Daily,Weekly and Monthly limits can be setup on a per interval basis e.g. to biweekly, or daily every 10 days.\r\nSee customer plans setup in the Portal for more information.\r\nAll parameters are required. If resourceId is not applicable for a non-resource calendar, pass zero.\r\nFormat of the dateTimeTz field is 2018-10-30T10:00-5:00", "operationId"=>"ConsumerV1CustomersByIdPlanlimitsByServiceIdByResourceIdByDateTimeTzGet", "x-api-path-slug"=>"consumerv1customersidplanlimitsserviceidresourceiddatetimetz-get", "parameters"=>[{"in"=>"path", "name"=>"dateTimeTz", "description"=>"The DateTimeTz to check"}, {"in"=>"path", "name"=>"id", "description"=>"The id of the customer object"}, {"in"=>"path", "name"=>"resourceId", "description"=>"The id of the resource object"}, {"in"=>"path", "name"=>"serviceId", "description"=>"The id of the service object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Planlimits", "ServiceId", "ResourceId", "DateTimeTz"]}}, "/consumer/v1/customers/subscriptions"=>{"get"=>{"summary"=>"Returns a list of customer subscriptions.", "description"=>"The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20.\r\nUse the other query parameters to optionally filter the results list.", "operationId"=>"ConsumerV1CustomersSubscriptionsGet", "x-api-path-slug"=>"consumerv1customerssubscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Page limit, default 20"}, {"in"=>"query", "name"=>"locationId", "description"=>"The id of the business location"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting row of page, default 0"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Subscriptions"]}}, "/consumer/v1/customers/{id}/subscriptions"=>{"get"=>{"summary"=>"Returns a customer subscription object.", "description"=>"The result returned is a single customer subscription object. A customer can only be subsribed to a single Customer Plan", "operationId"=>"ConsumerV1CustomersByIdSubscriptionsGet", "x-api-path-slug"=>"consumerv1customersidsubscriptions-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the customer object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Subscriptions"]}, "post"=>{"summary"=>"Creates a new customer subscription object.", "description"=>"Use this endpoint to create a new customer subscription.", "operationId"=>"ConsumerV1CustomersByIdSubscriptionsPost", "x-api-path-slug"=>"consumerv1customersidsubscriptions-post", "parameters"=>[{"in"=>"body", "name"=>"customerSubscriptionIM", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The id of the customer object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Subscriptions"]}}, "/consumer/v1/customers/subscriptions/{id}"=>{"get"=>{"summary"=>"Returns a customer subscription object.", "description"=>"The result returned is a single customer subscription object.", "operationId"=>"ConsumerV1CustomersSubscriptionsByIdGet", "x-api-path-slug"=>"consumerv1customerssubscriptionsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the customer subscription object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Subscriptions"]}, "put"=>{"summary"=>"Updates a customer subscription object.", "description"=>"Use this endpoint to update customer subscription information.", "operationId"=>"ConsumerV1CustomersSubscriptionsByIdPut", "x-api-path-slug"=>"consumerv1customerssubscriptionsid-put", "parameters"=>[{"in"=>"body", "name"=>"customerSubscriptionUM", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The id of the customer subscription object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Subscriptions"]}, "delete"=>{"summary"=>"Deletes a list of lead questions", "description"=>"Deletes a list of lead questions", "operationId"=>"ConsumerV1CustomersSubscriptionsByIdDelete", "x-api-path-slug"=>"consumerv1customerssubscriptionsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Subscriptions"]}}, "/consumer/v1/customers/countries"=>{"get"=>{"summary"=>"Returns a list of country objects", "description"=>"Returns a list of countries with the associated country code. Country codes are based on the 2 character ANSI standard.", "operationId"=>"ConsumerV1CustomersCountriesGet", "x-api-path-slug"=>"consumerv1customerscountries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Countries"]}}, "/consumer/v1/customers/states"=>{"get"=>{"summary"=>"Returns a list of state objects", "description"=>"Returns a list of states with the associated state code and country. \r\n\r\nContact us if states for your countries of operation are not currently loaded.", "operationId"=>"ConsumerV1CustomersStatesGet", "x-api-path-slug"=>"consumerv1customersstates-get", "parameters"=>[{"in"=>"query", "name"=>"country"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "States"]}}, "/consumer/v1/locations"=>{"get"=>{"summary"=>"Returns a list of business locations.", "description"=>"Use this api end point if you have multiple business locations in your company.\r\nThe results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20.\r\nUse the other query parameters to optionally filter the results list.", "operationId"=>"ConsumerV1LocationsGet", "x-api-path-slug"=>"consumerv1locations-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Page limit, default 20"}, {"in"=>"query", "name"=>"name", "description"=>"Location name(full or partial) to filter on"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting row of page, default 0"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Locations"]}}, "/consumer/v1/locations/{id}"=>{"get"=>{"summary"=>"Returns a business location object.", "description"=>"The result returned is a single location object. An id is required to find the location. Find location id's using the GET consumer/v1/locations end point,", "operationId"=>"ConsumerV1LocationsByIdGet", "x-api-path-slug"=>"consumerv1locationsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the business location object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Locations"]}}, "/consumer/v1/resources"=>{"get"=>{"summary"=>"Returns a list of resources.", "description"=>"The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20.\r\nUse the other query parameters to optionally filter the results list.", "operationId"=>"ConsumerV1ResourcesGet", "x-api-path-slug"=>"consumerv1resources-get", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"Filter resources by email address"}, {"in"=>"query", "name"=>"limit", "description"=>"Page limit, default 20"}, {"in"=>"query", "name"=>"locationId", "description"=>"The id of the business location"}, {"in"=>"query", "name"=>"name", "description"=>"Search resources by name"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting row of page, default 0"}, {"in"=>"query", "name"=>"resourceGroupId", "description"=>"Filter resources by group"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Specify sort order of response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources"]}}, "/consumer/v1/resources/{id}"=>{"get"=>{"summary"=>"Returns a resource object.", "description"=>"The result returned is a single resource object. An id is required to find the resource. Find customer id's using either the GET consumer/v1/resources end point,\r\nor the GET consumer/v1/appointments end point.", "operationId"=>"ConsumerV1ResourcesByIdGet", "x-api-path-slug"=>"consumerv1resourcesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the resource object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources"]}}, "/consumer/v1/resources/{id}/services"=>{"get"=>{"summary"=>"Returns a list of resource services.", "description"=>"The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20.\r\nUse the other query parameters to optionally filter the results list.\r\nResource services are used to explicitly define the services that can be booked for a resource. If no resource services are defined then by\r\ndefault all services can be booked for the resource.", "operationId"=>"ConsumerV1ResourcesByIdServicesGet", "x-api-path-slug"=>"consumerv1resourcesidservices-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the resource object"}, {"in"=>"query", "name"=>"limit", "description"=>"Page limit, default 20"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting row of page, default 0"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Services"]}}, "/consumer/v1/servicegroups"=>{"get"=>{"summary"=>"Returns a list of service groups.", "description"=>"The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20.\r\nUse the other query parameters to optionally filter the results list.", "operationId"=>"ConsumerV1ServiceGroupsGet", "x-api-path-slug"=>"consumerv1servicegroups-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Page limit, default 20"}, {"in"=>"query", "name"=>"locationId", "description"=>"The id of the business location"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting row of page, default 0"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servicegroups"]}}, "/consumer/v1/servicegroups/{id}"=>{"get"=>{"summary"=>"Returns a serviceGroup object.", "description"=>"The result returned is a single serviceGroup object. An id is required to find the serviceGroup. Find serviceGroup id's using \r\nthe GET consumer/v1/servicegroups end point,", "operationId"=>"ConsumerV1ServiceGroupsByIdGet", "x-api-path-slug"=>"consumerv1servicegroupsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the serviceGroup object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servicegroups"]}}, "/consumer/v1/services"=>{"get"=>{"summary"=>"Returns a list of services.", "description"=>"The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20.\r\nUse the other query parameters to optionally filter the results list.", "operationId"=>"ConsumerV1ServicesGet", "x-api-path-slug"=>"consumerv1services-get", "parameters"=>[{"in"=>"query", "name"=>"defaultService", "description"=>"Filter services by default service"}, {"in"=>"query", "name"=>"limit", "description"=>"Page limit, default 20"}, {"in"=>"query", "name"=>"locationId", "description"=>"The id of the business location"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting row of page, default 0"}, {"in"=>"query", "name"=>"serviceGroupId", "description"=>"Filter services by group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/consumer/v1/services/{id}"=>{"get"=>{"summary"=>"Returns a service object.", "description"=>"The result returned is a single service object. An id is required to find the service. Find service id's using either the GET consumer/v1/service end point,\r\nor the GET consumer/v1/appointments end point.", "operationId"=>"ConsumerV1ServicesByIdGet", "x-api-path-slug"=>"consumerv1servicesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the service object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/consumer/v1/services/{id}/resources"=>{"get"=>{"summary"=>"Returns a list of resources.", "description"=>"The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20.\r\nUse the other query parameters to optionally filter the results list.", "operationId"=>"ConsumerV1ServicesByIdResourcesGet", "x-api-path-slug"=>"consumerv1servicesidresources-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the service object"}, {"in"=>"query", "name"=>"limit", "description"=>"Page limit, default 20"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting row of page, default 0"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services", "Resources"]}}, "/consumer/v1/settings"=>{"get"=>{"summary"=>"Returns a list of customers.", "description"=>"The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20.\r\nUse the other query parameters to optionally filter the results list.", "operationId"=>"ConsumerV1SettingsGet", "x-api-path-slug"=>"consumerv1settings-get", "parameters"=>[{"in"=>"query", "name"=>"locationId", "description"=>"The id of the business location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settings"]}}}}, "apis"=>{"name"=>"OnSched", "x-slug"=>"onsched", "description"=>"Build secure and scalable custom apps for Online Booking. Our flexible API provides many options for availability and booking. OnSched is an API first booking software that allows you to bring your design to life by creating your own booking flow. Using our robust API you can customize the interaction between your consumers and vendors while we do all the leg work behind the scenes. Want to offer online booking to your vendors? Ask about our white labelling solutions and rebrand our software as your own.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/onsched-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"", "tags"=>"API Provider,Bookings,Profiles,Relative Data,Schedules,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"onsched/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"OnSched", "x-api-slug"=>"onsched", "description"=>"Build secure and scalable custom apps for Online Booking. Our flexible API provides many options for availability and booking. OnSched is an API first booking software that allows you to bring your design to life by creating your own booking flow. Using our robust API you can customize the interaction between your consumers and vendors while we do all the leg work behind the scenes. Want to offer online booking to your vendors? Ask about our white labelling solutions and rebrand our software as your own.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/onsched-logo.png", "humanURL"=>"http://www.onsched.com", "baseURL"=>"https://api.onsched.com//", "tags"=>"API Provider,Bookings,Profiles,Relative Data,Schedules,Service API", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/onsched/onsched-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://www.onsched.com/api/docs/"}, {"type"=>"x-pricing", "url"=>"https://www.onsched.com/index.html#self-service"}, {"type"=>"x-website", "url"=>"http://www.onsched.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
heroku{"heroku-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Heroku", "x-complete"=>1, "info"=>{"title"=>"Heroku", "description"=>"manage-your-heroku-apps-configs-collaborators-resources", "version"=>"1"}, "host"=>"api.heroku.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/addons"=>{"parameters"=>{"summary"=>"Parameters Addons", "description"=>"Parameters addons.", "operationId"=>"parametersAddons", "x-api-path-slug"=>"addons-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "ons"]}, "get"=>{"summary"=>"Get Addons", "description"=>"List all available addons.", "operationId"=>"getAddons", "x-api-path-slug"=>"addons-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ons"]}}, "/apps/{app}/addons"=>{"parameters"=>{"summary"=>"Parameter Application Addons", "description"=>"Parameter application addons.", "operationId"=>"parametersAppsAppAddons", "x-api-path-slug"=>"appsappaddons-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameter", "Application", "ons"]}, "get"=>{"summary"=>"Get Application Addons", "description"=>"List addons installed on an app.", "operationId"=>"getAppsAppAddons", "x-api-path-slug"=>"appsappaddons-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "ons"]}}, "/apps/{app}/addons/{addon}"=>{"parameters"=>{"summary"=>"Parameters Applications Addons", "description"=>"Parameters applications addons.", "operationId"=>"parametersAppsAppAddonsAddon", "x-api-path-slug"=>"appsappaddonsaddon-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Applications", "ons"]}, "post"=>{"summary"=>"Add Application Addons", "description"=>"Install an addon to an app.", "operationId"=>"postAppsAppAddonsAddon", "x-api-path-slug"=>"appsappaddonsaddon-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"addon", "description"=>"the addon name"}, {"in"=>"path", "name"=>"addon"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "ons"]}, "put"=>{"summary"=>"Put Application Addons", "description"=>"Upgrade an addon to an app.", "operationId"=>"putAppsAppAddonsAddon", "x-api-path-slug"=>"appsappaddonsaddon-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"addon", "description"=>"the addon name"}, {"in"=>"path", "name"=>"addon"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Put", "Application", "ons"]}, "delete"=>{"summary"=>"Delete Applications Addons", "description"=>"Uninstall an addon from an app.", "operationId"=>"deleteAppsAppAddonsAddon", "x-api-path-slug"=>"appsappaddonsaddon-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"addon", "description"=>"the addon name"}, {"in"=>"path", "name"=>"addon"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "ons"]}}, "/apps"=>{"parameters"=>{"summary"=>"Parameters Applications", "description"=>"Parameters applications.", "operationId"=>"parametersApps", "x-api-path-slug"=>"apps-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Applications"]}, "get"=>{"summary"=>"Get Applications", "description"=>"Get applications.", "operationId"=>"getApps", "x-api-path-slug"=>"apps-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}, "post"=>{"summary"=>"Add Applications", "description"=>"Add applications.", "operationId"=>"postApps", "x-api-path-slug"=>"apps-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/apps/{name}"=>{"parameters"=>{"summary"=>"Parameters Applications Name", "description"=>"Parameters applications name.", "operationId"=>"parametersAppsName", "x-api-path-slug"=>"appsname-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Applications", "Name"]}, "get"=>{"summary"=>"Get Applications Name", "description"=>"Get applications name.", "operationId"=>"getAppsName", "x-api-path-slug"=>"appsname-get", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"name", "description"=>"The app name"}, {"in"=>"path", "name"=>"name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "Name"]}, "delete"=>{"summary"=>"Delete Applications Name", "description"=>"Delete applications name.", "operationId"=>"deleteAppsName", "x-api-path-slug"=>"appsname-delete", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"name", "description"=>"The app name"}, {"in"=>"path", "name"=>"name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "Name"]}}, "/apps/{app}/collaborators"=>{"parameters"=>{"summary"=>"Parameters Application Collaborators", "description"=>"Parameters application collaborators.", "operationId"=>"parametersAppsAppCollaborators", "x-api-path-slug"=>"appsappcollaborators-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Application", "Collaborators"]}, "get"=>{"summary"=>"Get Application Collaborators", "description"=>"List collaborators for an app.", "operationId"=>"getAppsAppCollaborators", "x-api-path-slug"=>"appsappcollaborators-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Collaborators"]}}, "/apps/{app}/collaborators/{email}"=>{"parameters"=>{"summary"=>"Parameters Application Collaborators Email", "description"=>"Parameters application collaborators email.", "operationId"=>"parametersAppsAppCollaboratorsEmail", "x-api-path-slug"=>"appsappcollaboratorsemail-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Application", "Collaborators", "Email"]}, "delete"=>{"summary"=>"Delete Application Collaborators Email", "description"=>"Delete application collaborators email.", "operationId"=>"deleteAppsAppCollaboratorsEmail", "x-api-path-slug"=>"appsappcollaboratorsemail-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}, {"in"=>"query", "name"=>"email", "description"=>"The email of the user to remove as a collaborator"}, {"in"=>"path", "name"=>"email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Collaborators", "Email"]}}, "/apps/{app}/config_vars"=>{"parameters"=>{"summary"=>"Parameters Application Config Variables", "description"=>"Parameters application config variables.", "operationId"=>"parametersAppsAppConfigVars", "x-api-path-slug"=>"appsappconfig-vars-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Application", "Config", "Variables"]}, "get"=>{"summary"=>"Get Application Config Variables", "description"=>"Get application config variables.", "operationId"=>"getAppsAppConfigVars", "x-api-path-slug"=>"appsappconfig-vars-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Config", "Variables"]}, "put"=>{"summary"=>"Put Application Config Variables", "description"=>"Put application config variables.", "operationId"=>"putAppsAppConfigVars", "x-api-path-slug"=>"appsappconfig-vars-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Put", "Application", "Config", "Variables"]}}, "/apps/{app}/config_vars/{key}"=>{"parameters"=>{"summary"=>"Parameters Application Config Variables Key", "description"=>"Parameters application config variables key.", "operationId"=>"parametersAppsAppConfigVarsKey", "x-api-path-slug"=>"appsappconfig-varskey-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Application", "Config", "Variables", "Key"]}, "delete"=>{"summary"=>"Delete Application Config Variables Key", "description"=>"Delete application config variables key.", "operationId"=>"deleteAppsAppConfigVarsKey", "x-api-path-slug"=>"appsappconfig-varskey-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}, {"in"=>"query", "name"=>"key", "description"=>"The config var to remove"}, {"in"=>"path", "name"=>"key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Config", "Variables", "Key"]}}, "/apps/{app}/domains"=>{"parameters"=>{"summary"=>"Parameters Application Domains", "description"=>"Parameters application domains.", "operationId"=>"parametersAppsAppDomains", "x-api-path-slug"=>"appsappdomains-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Application", "Domains"]}, "get"=>{"summary"=>"Get Application Domains", "description"=>"List domains for an app.", "operationId"=>"getAppsAppDomains", "x-api-path-slug"=>"appsappdomains-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Domains"]}}, "/apps/{app}/domains/{domain_name}"=>{"parameters"=>{"summary"=>"Parameters Application Domain Name", "description"=>"Parameters application domain name.", "operationId"=>"parametersAppsAppDomainsDomainName", "x-api-path-slug"=>"appsappdomainsdomain-name-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Application", "Domain", "Name"]}, "delete"=>{"summary"=>"Delete Application Domain Name", "description"=>"Delete application domain name.", "operationId"=>"deleteAppsAppDomainsDomainName", "x-api-path-slug"=>"appsappdomainsdomain-name-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}, {"in"=>"query", "name"=>"domain_name", "description"=>"The domain to remove"}, {"in"=>"path", "name"=>"domain_name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Domain", "Name"]}}, "/user/keys"=>{"parameters"=>{"summary"=>"Parameters User Keys", "description"=>"Parameters user keys.", "operationId"=>"parametersUserKeys", "x-api-path-slug"=>"userkeys-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "User", "Keys"]}, "get"=>{"summary"=>"Get User Keys", "description"=>"List SSH keys.", "operationId"=>"getUserKeys", "x-api-path-slug"=>"userkeys-get", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"header", "name"=>"Accept", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Keys"]}, "post"=>{"summary"=>"Add User Keys", "description"=>"Associate an SSH key with this account.", "operationId"=>"postUserKeys", "x-api-path-slug"=>"userkeys-post", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"header", "name"=>"Accept", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Keys"]}}, "/user/keys/{key}"=>{"parameters"=>{"summary"=>"Parameters User Keys Key", "description"=>"Parameters user keys key.", "operationId"=>"parametersUserKeysKey", "x-api-path-slug"=>"userkeyskey-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "User", "Keys", "Key"]}, "delete"=>{"summary"=>"Delete User Keys Key", "description"=>"Remove an SSH key from this account.", "operationId"=>"deleteUserKeysKey", "x-api-path-slug"=>"userkeyskey-delete", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"key", "description"=>"The username@hostname description field of the key"}, {"in"=>"path", "name"=>"key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Keys", "Key"]}}, "/apps/{app}/logs"=>{"parameters"=>{"summary"=>"Parameters Application Logs", "description"=>"Parameters application logs.", "operationId"=>"parametersAppsAppLogs", "x-api-path-slug"=>"appsapplogs-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Application", "Logs"]}, "get"=>{"summary"=>"Get Application Logs", "description"=>"Get application logs.", "operationId"=>"getAppsAppLogs", "x-api-path-slug"=>"appsapplogs-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}, {"in"=>"query", "name"=>"logplex", "description"=>"Use logplex to stream logs (always true)"}, {"in"=>"query", "name"=>"num", "description"=>"The number of lines to display"}, {"in"=>"query", "name"=>"ps", "description"=>"Only display logs from a given process"}, {"in"=>"query", "name"=>"source", "description"=>"Only display logs from a given source"}, {"in"=>"query", "name"=>"tail", "description"=>"1: continually stream logs - : display only num logs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Logs"]}}, "/apps/{app}/ps"=>{"parameters"=>{"summary"=>"Parameters Application PS", "description"=>"Parameters application ps.", "operationId"=>"parametersAppsAppPs", "x-api-path-slug"=>"appsappps-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Application", "PS"]}, "get"=>{"summary"=>"Get Application PS", "description"=>"List processes for an app.", "operationId"=>"getAppsAppPs", "x-api-path-slug"=>"appsappps-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "PS"]}, "post"=>{"summary"=>"Add Application PS", "description"=>"Run a one-off process.", "operationId"=>"postAppsAppPs", "x-api-path-slug"=>"appsappps-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}, {"in"=>"query", "name"=>"attach", "description"=>"true: use rendezvous to access stdin/stdout - : stream process output to the application log"}, {"in"=>"query", "name"=>"command", "description"=>"The command to run"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "PS"]}}, "/apps/{app}/ps/restart"=>{"parameters"=>{"summary"=>"Parameters Application PS Restart", "description"=>"Parameters application ps restart.", "operationId"=>"parametersAppsAppPsRestart", "x-api-path-slug"=>"appsapppsrestart-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Application", "PS", "Restart"]}, "post"=>{"summary"=>"Add Application PS Restart", "description"=>"Restart processes of an app. Specify either ps or type to restart only the specified processes. Leave both blank to restart the entire app.", "operationId"=>"postAppsAppPsRestart", "x-api-path-slug"=>"appsapppsrestart-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}, {"in"=>"query", "name"=>"ps", "description"=>"The name of a process to restart"}, {"in"=>"query", "name"=>"type", "description"=>"The type of process to restart"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "PS", "Restart"]}}, "/apps/{app}/ps/stop"=>{"parameters"=>{"summary"=>"Parameters Application PS Stop", "description"=>"Parameters application ps stop.", "operationId"=>"parametersAppsAppPsStop", "x-api-path-slug"=>"appsapppsstop-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Application", "PS", "Stop"]}, "post"=>{"summary"=>"Add Application PS Stop", "description"=>"Stop processes of an app. Specify either ps or type to stop the specified processes.", "operationId"=>"postAppsAppPsStop", "x-api-path-slug"=>"appsapppsstop-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"path", "name"=>"app"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"query", "name"=>"ps", "description"=>"The name of a process to stop"}, {"in"=>"query", "name"=>"type", "description"=>"The type of process to stop"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "PS", "Stop"]}}, "/apps/{app}/ps/scale"=>{"parameters"=>{"summary"=>"Parameters Application PS Scale", "description"=>"Parameters application ps scale.", "operationId"=>"parametersAppsAppPsScale", "x-api-path-slug"=>"appsapppsscale-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Application", "PS", "Scale"]}, "post"=>{"summary"=>"Add Application PS Scale", "description"=>"Scale processes of an app.", "operationId"=>"postAppsAppPsScale", "x-api-path-slug"=>"appsapppsscale-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}, {"in"=>"query", "name"=>"qty", "description"=>"The desired number of processes of this type"}, {"in"=>"query", "name"=>"type", "description"=>"The type of process to scale"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "PS", "Scale"]}}, "/apps/{app}/releases"=>{"parameters"=>{"summary"=>"Parameters Application Releases", "description"=>"Parameters application releases.", "operationId"=>"parametersAppsAppReleases", "x-api-path-slug"=>"appsappreleases-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Application", "Releases"]}, "get"=>{"summary"=>"Get Application Releases", "description"=>"List releases for an app.", "operationId"=>"getAppsAppReleases", "x-api-path-slug"=>"appsappreleases-get", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Releases"]}, "post"=>{"summary"=>"Add Application Releases", "description"=>"Add application releases.", "operationId"=>"postAppsAppReleases", "x-api-path-slug"=>"appsappreleases-post", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}, {"in"=>"query", "name"=>"rollback", "description"=>"The release to which to roll back"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Releases"]}}, "/apps/{app}/releases/{release}"=>{"parameters"=>{"summary"=>"Parameters Application Releases", "description"=>"Parameters application releases.", "operationId"=>"parametersAppsAppReleasesRelease", "x-api-path-slug"=>"appsappreleasesrelease-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Application", "Releases"]}, "get"=>{"summary"=>"Get Application Releases", "description"=>"Get application releases.", "operationId"=>"getAppsAppReleasesRelease", "x-api-path-slug"=>"appsappreleasesrelease-get", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}, {"in"=>"query", "name"=>"release", "description"=>"The release name"}, {"in"=>"path", "name"=>"release"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Releases"]}}, "/apps/{app}/stack"=>{"parameters"=>{"summary"=>"Parameters Application Stack", "description"=>"Parameters application stack.", "operationId"=>"parametersAppsAppStack", "x-api-path-slug"=>"appsappstack-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Application", "Stack"]}, "get"=>{"summary"=>"Get Application Stack", "description"=>"List available stacks for an app.", "operationId"=>"getAppsAppStack", "x-api-path-slug"=>"appsappstack-get", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Stack"]}, "put"=>{"summary"=>"Put Application Stack", "description"=>"Migrate an app to a new stack.", "operationId"=>"putAppsAppStack", "x-api-path-slug"=>"appsappstack-put", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"header", "name"=>"Accept", "description"=>"Content type"}, {"in"=>"query", "name"=>"app", "description"=>"The app name"}, {"in"=>"path", "name"=>"app"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Put", "Application", "Stack"]}}}}, "apis"=>{"name"=>"Heroku", "x-slug"=>"heroku", "description"=>"Heroku is a platform as a service (PaaS) that enables developers to build, run, and operate applications entirely in the cloud.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/211-heroku.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"6044", "tags"=>"API LIfeyclessss,API Provider,API Service Provider,Code,Command Line Interface,Compute,Databases,Developers,Federal Government,Federal Government,Federal Government,Federal Government,Getting Started Example,Issues,Issues Example,My API Stack,PaaS,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"heroku/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Heroku", "x-api-slug"=>"heroku", "description"=>"Learn about building, deploying and managing your apps on Heroku.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/211-heroku.jpg", "humanURL"=>"http://heroku.com", "baseURL"=>"https://api.heroku.com//", "tags"=>"API LIfeyclessss,API Provider,API Service Provider,Code,Command Line Interface,Compute,Databases,Developers,Federal Government,Federal Government,Federal Government,Federal Government,Getting Started Example,Issues,Issues Example,My API Stack,PaaS,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/heroku/appsappstack-put-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/heroku/heroku-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.heroku.com"}, {"type"=>"x-blog", "url"=>"https://blog.heroku.com/"}, {"type"=>"x-blog-rss", "url"=>"http://feeds2.feedburner.com/heroku"}, {"type"=>"x-command-line-interface", "url"=>"https://devcenter.heroku.com/articles/heroku-command"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/heroku"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/heroku"}, {"type"=>"x-developer", "url"=>"https://devcenter.heroku.com/"}, {"type"=>"x-email", "url"=>"pr@heroku.com"}, {"type"=>"x-email", "url"=>"abuse@heroku.com"}, {"type"=>"x-email", "url"=>"feedback@heroku.com"}, {"type"=>"x-getting-started", "url"=>"https://devcenter.heroku.com/start"}, {"type"=>"x-github", "url"=>"https://github.com/heroku"}, {"type"=>"x-issues", "url"=>"https://status.heroku.com/incidents"}, {"type"=>"x-java-library", "url"=>"https://devcenter.heroku.com/categories/java"}, {"type"=>"x-node-js", "url"=>"https://devcenter.heroku.com/categories/nodejs"}, {"type"=>"x-php-library", "url"=>"https://devcenter.heroku.com/categories/php"}, {"type"=>"x-pricing", "url"=>"https://www.heroku.com/pricing"}, {"type"=>"x-privacy", "url"=>"https://www.heroku.com/policy/privacy"}, {"type"=>"x-python-library", "url"=>"https://devcenter.heroku.com/categories/python"}, {"type"=>"x-ruby-library", "url"=>"https://devcenter.heroku.com/categories/ruby"}, {"type"=>"x-security", "url"=>"https://www.heroku.com/policy/security"}, {"type"=>"x-selfservice-registration", "url"=>"https://signup.heroku.com/dc"}, {"type"=>"x-support", "url"=>"https://www.heroku.com/support"}, {"type"=>"x-terms-of-service", "url"=>"https://www.heroku.com/policy/tos"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/heroku"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/HerokuDevCenter"}, {"type"=>"x-webhook", "url"=>"https://devcenter.heroku.com/articles/app-webhooks"}, {"type"=>"x-website", "url"=>"http://heroku.com"}, {"type"=>"x-website", "url"=>"https://www.heroku.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
clover{"clover-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Clover", "x-complete"=>1, "info"=>{"title"=>"", "version"=>"1.0.0"}, "host"=>"/merchants", "basePath"=>"https://api.clover.com", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v3/merchants/{mId}"=>{"get"=>{"summary"=>"Get a single merchant", "description"=>"Get a single merchant.", "operationId"=>"GetMerchant", "x-api-path-slug"=>"v3merchantsmid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [employees, bankProcessing, externalMerchant, merchantBoarding, deviceBoarding, programExpress, hierarchy, shifts, orders, address, logos, owner, items, tags, tenders, payments, gateway, printers, modifierGroups, properties, tipSuggestions, openingHours, partnerApp, selfBoardingApplication]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "MId"]}, "post"=>{"summary"=>"Update a merchant", "description"=>"Update a merchant.", "operationId"=>"UpdateMerchant", "x-api-path-slug"=>"v3merchantsmid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [employees, bankProcessing, externalMerchant, merchantBoarding, deviceBoarding, programExpress, hierarchy, shifts, orders, address, logos, owner, items, tags, tenders, payments, gateway, printers, modifierGroups, properties, tipSuggestions, openingHours, partnerApp, selfBoardingApplication]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "MId"]}}, "/v3/merchants/{mId}/address"=>{"get"=>{"summary"=>"Get a merchant's address", "description"=>"Get a merchant's address.", "operationId"=>"GetMerchantAddress", "x-api-path-slug"=>"v3merchantsmidaddress-get", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Address"]}}, "/v3/merchants/{mId}/gateway"=>{"get"=>{"summary"=>"Get a merchant's payment gateway configuration", "description"=>"Get a merchant's payment gateway configuration.", "operationId"=>"GetMerchantGateway", "x-api-path-slug"=>"v3merchantsmidgateway-get", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Gateway"]}}, "/v3/merchants/{mId}/properties"=>{"get"=>{"summary"=>"Get a merchant's properties", "description"=>"Get a merchant's properties.", "operationId"=>"GetMerchantProperties", "x-api-path-slug"=>"v3merchantsmidproperties-get", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Properties"]}, "post"=>{"summary"=>"Update merchant properties", "description"=>"Update merchant properties.", "operationId"=>"UpdateMerchantProperties", "x-api-path-slug"=>"v3merchantsmidproperties-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Properties"]}}, "/v3/merchants/{mId}/default_service_charge"=>{"get"=>{"summary"=>"Get default service charge for a merchant", "description"=>"The Merchant's default service charge, set via the Setup App (https://www.clover.com/setupapp).", "operationId"=>"GetDefaultServiceCharge", "x-api-path-slug"=>"v3merchantsmiddefault-service-charge-get", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Default", "Service", "Charge"]}}, "/v3/merchants/{mId}/sync/{table}"=>{"get"=>{"summary"=>"Get a sync token (deprecated)", "description"=>"Get a sync token (deprecated).", "operationId"=>"GetSyncToken", "x-api-path-slug"=>"v3merchantsmidsynctable-get", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"table", "description"=>"Table Name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Sync", "Table"]}}, "/v3/merchants/{mId}/tip_suggestions"=>{"get"=>{"summary"=>"Get all tip suggestions for a merchant", "description"=>"Get all tip suggestions for a merchant.", "operationId"=>"GetTipSuggestions", "x-api-path-slug"=>"v3merchantsmidtip-suggestions-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [id, name, percentage, enabled]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tip", "Suggestions"]}}, "/v3/merchants/{mId}/tip_suggestions/{tId}"=>{"get"=>{"summary"=>"Get a single tip suggestion", "description"=>"Get a single tip suggestion.", "operationId"=>"GetTipSuggestion", "x-api-path-slug"=>"v3merchantsmidtip-suggestionstid-get", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"tId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tip", "Suggestions", "TId"]}, "post"=>{"summary"=>"Update a single tip suggestion", "description"=>"Update a single tip suggestion.", "operationId"=>"UpdateTipSuggestion", "x-api-path-slug"=>"v3merchantsmidtip-suggestionstid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"tId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tip", "Suggestions", "TId"]}}, "/v3/merchants/{mId}/order_types"=>{"get"=>{"summary"=>"Get all order types for a merchant", "description"=>"Merchants have the ability to create custom order types via the Setup App (https://www.clover.com/setupapp). These custom order types can be associated with a System Order Type (see /v3/merchants/{mId}/system_order_types). Custom Order Types can support items in all categories (filterCategories=false) or a subset of the merchant's categories (filterCategories=true and categories property contains the list of supported categories). Note that when expanding the categories for an order type, they will only be returned if this orderType only supports a subset of the categories (filterCategories=true). If the orderType supports all categories (filterCategories=false) then you should make a GET request to /v3/merchants/{mId}/categories.", "operationId"=>"GetOrderTypes", "x-api-path-slug"=>"v3merchantsmidorder-types-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [hours, attributes, categories]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [id, deletedTime]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Order", "Types"]}, "post"=>{"summary"=>"Create Order Type For Merchant", "description"=>"Create order type for merchant.", "operationId"=>"CreateOrderType", "x-api-path-slug"=>"v3merchantsmidorder-types-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [hours, attributes, categories]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Order", "Types"]}}, "/v3/merchants/{mId}/order_types/{orderTypeId}"=>{"get"=>{"summary"=>"Get a single order type", "description"=>"Get a single order type.", "operationId"=>"GetOrderType", "x-api-path-slug"=>"v3merchantsmidorder-typesordertypeid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [hours, attributes, categories]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderTypeId", "description"=>"Order Type Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Order", "Types", "OrderTypeId"]}, "post"=>{"summary"=>"Update a single order type", "description"=>"Update a single order type.", "operationId"=>"UpdateOrderType", "x-api-path-slug"=>"v3merchantsmidorder-typesordertypeid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [hours, attributes, categories]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderTypeId", "description"=>"Order Type Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Order", "Types", "OrderTypeId"]}, "delete"=>{"summary"=>"Delete an order type", "description"=>"Delete an order type.", "operationId"=>"DeleteOrderType", "x-api-path-slug"=>"v3merchantsmidorder-typesordertypeid-delete", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderTypeId", "description"=>"Order Type Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Order", "Types", "OrderTypeId"]}}, "/v3/merchants/{mId}/order_type_categories"=>{"post"=>{"summary"=>"Create or delete a order type category", "description"=>"Create or delete a order type category.", "operationId"=>"CreateOrDeleteOrderTypeCategories", "x-api-path-slug"=>"v3merchantsmidorder-type-categories-post", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Order", "Type", "Categories"]}}, "/v3/merchants/{mId}/system_order_types"=>{"get"=>{"summary"=>"Return a list of system order types", "description"=>"Merchants can create custom Order Types via \"/v3/merchants/{mId}/order_types\". It is useful to associate these custom order types with particular system order types in order to group things functionally. For example, a merchant may have a \"Lunch Take-Out\" order type and a \"Dinner Take-Out\" order type. These two order types can be associated with the \"TAKE-OUT-TYPE\" system order type so that applications can understand that they are both take-out order types.", "operationId"=>"GetSystemOrderTypes", "x-api-path-slug"=>"v3merchantsmidsystem-order-types-get", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "System", "Order", "Types"]}}, "/v3/merchants/{mId}/roles"=>{"get"=>{"summary"=>"Get all roles from a merchant", "description"=>"Get all roles from a merchant.", "operationId"=>"GetRoles", "x-api-path-slug"=>"v3merchantsmidroles-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [employees]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, systemRole, name, id, deletedTime]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Roles"]}, "post"=>{"summary"=>"Create a role", "description"=>"Create a role.", "operationId"=>"CreateRole", "x-api-path-slug"=>"v3merchantsmidroles-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Roles"]}}, "/v3/merchants/{mId}/roles/{rId}"=>{"get"=>{"summary"=>"Get a single role", "description"=>"Get a single role.", "operationId"=>"GetRole", "x-api-path-slug"=>"v3merchantsmidrolesrid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [employees]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"rId", "description"=>"Role Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Roles", "RId"]}, "post"=>{"summary"=>"Update a single role", "description"=>"Update a single role.", "operationId"=>"UpdateRole", "x-api-path-slug"=>"v3merchantsmidrolesrid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [employees]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"rId", "description"=>"Role Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Roles", "RId"]}, "delete"=>{"summary"=>"Delete a role", "description"=>"Delete a role.", "operationId"=>"DeleteRole", "x-api-path-slug"=>"v3merchantsmidrolesrid-delete", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"rId", "description"=>"Role Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Roles", "RId"]}}, "/v3/merchants/{mId}/tenders"=>{"get"=>{"summary"=>"Get all tenders for a merchant", "description"=>"Get all tenders for a merchant.", "operationId"=>"GetMerchantTenders", "x-api-path-slug"=>"v3merchantsmidtenders-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [labelKey, label, opensCashDrawer, enabled, visible, instruction, id, merchantId, systemTenderId, deletedTime, modifiedTime]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tenders"]}, "post"=>{"summary"=>"Adds a new tender", "description"=>"Returns an object representing newly added merchant tender, with a generated ID.", "operationId"=>"CreateMerchantTender", "x-api-path-slug"=>"v3merchantsmidtenders-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tenders"]}}, "/v3/merchants/{mId}/tenders/{tenderId}"=>{"get"=>{"summary"=>"Get a single merchant tender", "description"=>"Get a single merchant tender.", "operationId"=>"GetMerchantTender", "x-api-path-slug"=>"v3merchantsmidtenderstenderid-get", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"tenderId", "description"=>"Tender Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tenders", "TenderId"]}, "post"=>{"summary"=>"Updates an existing tender", "description"=>"Returns an object representing updated merchant tender.", "operationId"=>"UpdateMerchantTender", "x-api-path-slug"=>"v3merchantsmidtenderstenderid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"tenderId", "description"=>"Tender Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tenders", "TenderId"]}, "delete"=>{"summary"=>"Deletes an existing tender", "description"=>"Deletes an existing tender.", "operationId"=>"DeleteMerchantTender", "x-api-path-slug"=>"v3merchantsmidtenderstenderid-delete", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"tenderId", "description"=>"Tender Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tenders", "TenderId"]}}, "/v3/merchants/{mId}/opening_hours"=>{"get"=>{"summary"=>"Get a list this merchant opening hours", "description"=>"Get a list this merchant opening hours.", "operationId"=>"GetAllMerchantOpeningHours", "x-api-path-slug"=>"v3merchantsmidopening-hours-get", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Opening", "Hours"]}, "post"=>{"summary"=>"Create a set of merchant opening hours", "description"=>"Create a set of merchant opening hours.", "operationId"=>"CreateMerchantOpeningHours", "x-api-path-slug"=>"v3merchantsmidopening-hours-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Opening", "Hours"]}}, "/v3/merchants/{mId}/opening_hours/{hId}"=>{"get"=>{"summary"=>"Get a specific set of merchant opening hours", "description"=>"Get a specific set of merchant opening hours.", "operationId"=>"GetMerchantOpeningHours", "x-api-path-slug"=>"v3merchantsmidopening-hourshid-get", "parameters"=>[{"in"=>"path", "name"=>"hId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Opening", "Hours", "HId"]}, "post"=>{"summary"=>"Update a set of merchant opening hours", "description"=>"Update a set of merchant opening hours.", "operationId"=>"UpdateMerchantOpeningHours", "x-api-path-slug"=>"v3merchantsmidopening-hourshid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"hId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Opening", "Hours", "HId"]}, "delete"=>{"summary"=>"Delete a set of merchant opening hours", "description"=>"Delete a set of merchant opening hours.", "operationId"=>"DeleteMerchantOpeningHours", "x-api-path-slug"=>"v3merchantsmidopening-hourshid-delete", "parameters"=>[{"in"=>"path", "name"=>"hId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Opening", "Hours", "HId"]}}, "/v3/merchants/{mId}/devices"=>{"get"=>{"summary"=>"Get all devices provisioned to a merchant", "description"=>"Returns a list of all devices that are provisioned to the a merchant. This list can be viewed from the Setup App on the merchant's device or web dashboard (https://www.clover.com/setupapp/m/{mId}/devices).", "operationId"=>"GetMerchantDevices", "x-api-path-slug"=>"v3merchantsmiddevices-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [id, model, name, orderPrefix, serial, deleted_time, merchant"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Devices"]}}, "/v3/merchants/{mId}/devices/{deviceId}"=>{"get"=>{"summary"=>"Get a single device provisioned to a merchant", "description"=>"Returns a single device that is provisioned to a merchant.", "operationId"=>"GetMerchantDevice", "x-api-path-slug"=>"v3merchantsmiddevicesdeviceid-get", "parameters"=>[{"in"=>"path", "name"=>"deviceId", "description"=>"Device Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Devices", "DeviceId"]}}, "/v3/merchants/{mId}/cash_events"=>{"get"=>{"summary"=>"Get all cash events", "description"=>"Retrieve all cash events for this merchant. Cash events can also be consumed by registering a Webhook callback. See https://docs.clover.com/build/webhooks/", "operationId"=>"GetAllCashEvents", "x-api-path-slug"=>"v3merchantsmidcash-events-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [employee, device]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [employee"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Cash", "Events"]}}, "/v3/merchants/{mId}/employees/{empId}/cash_events"=>{"get"=>{"summary"=>"Get all cash events for an employee", "description"=>"Retrieve cash events filtered by employee ID. Cash events can also be consumed by registering a Webhook callback. See https://docs.clover.com/build/webhooks/", "operationId"=>"GetEmployeeCashEvents", "x-api-path-slug"=>"v3merchantsmidemployeesempidcash-events-get", "parameters"=>[{"in"=>"path", "name"=>"empId", "description"=>"Employee Id"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [employee, device]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [employee"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employees", "EmpId", "Cash", "Events"]}}, "/v3/merchants/{mId}/devices/{deviceId}/cash_events"=>{"get"=>{"summary"=>"Get all cash events for a device", "description"=>"Retrieve cash events filtered by device ID. Cash events can also be consumed by registering a Webhook callback. See https://docs.clover.com/build/webhooks/", "operationId"=>"GetDeviceCashEvents", "x-api-path-slug"=>"v3merchantsmiddevicesdeviceidcash-events-get", "parameters"=>[{"in"=>"path", "name"=>"deviceId", "description"=>"Device Id"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [employee, device]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [employee"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Devices", "DeviceId", "Cash", "Events"]}}, "/v3/merchants/{mId}/customers.csv"=>{"get"=>{"summary"=>"Get a list of customers", "description"=>"Gives information for every customer of a merchant by default.", "operationId"=>"DelegatedGetCustomers", "x-api-path-slug"=>"v3merchantsmidcustomers-csv-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [addresses, emailAddresses, phoneNumbers, cards, metadata]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [id, firstName, lastName, fullName, customerSince, marketingAllowed, deletedTime, phoneNumber, emailAddress]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "Csv"]}}, "/v3/merchants/{mId}/customers"=>{"get"=>{"summary"=>"Get a list of customers", "description"=>"Gives information for every customer of a merchant by default.", "operationId"=>"DelegatedGetCustomers", "x-api-path-slug"=>"v3merchantsmidcustomers-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [addresses, emailAddresses, phoneNumbers, cards, metadata]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [id, firstName, lastName, fullName, customerSince, marketingAllowed, deletedTime, phoneNumber, emailAddress]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers"]}, "post"=>{"summary"=>"Create a customer", "description"=>"Creates an customer for a merchant.", "operationId"=>"DelegatedCreateCustomer", "x-api-path-slug"=>"v3merchantsmidcustomers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [addresses, emailAddresses, phoneNumbers, cards, metadata]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers"]}}, "/v3/merchants/{mId}/customers/{customerId}"=>{"get"=>{"summary"=>"Get a single customer", "description"=>"Returns information for a single customer.", "operationId"=>"DelegatedGetCustomer", "x-api-path-slug"=>"v3merchantsmidcustomerscustomerid-get", "parameters"=>[{"in"=>"path", "name"=>"customerId"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [addresses, emailAddresses, phoneNumbers, cards, metadata]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [id, firstName, lastName, fullName, customerSince, marketingAllowed, deletedTime, phoneNumber, emailAddress]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "CustomerId"]}, "post"=>{"summary"=>"Update a customer", "description"=>"Updates information for a single customer. Only specified fields are overwritten.", "operationId"=>"DelegatedUpdateCustomer", "x-api-path-slug"=>"v3merchantsmidcustomerscustomerid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [addresses, emailAddresses, phoneNumbers, cards, metadata]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "CustomerId"]}, "delete"=>{"summary"=>"Delete a customer", "description"=>"Deletes a single customer from a merchant.", "operationId"=>"DelegatedDeleteCustomer", "x-api-path-slug"=>"v3merchantsmidcustomerscustomerid-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "CustomerId"]}}, "/v3/merchants/{mId}/employees"=>{"get"=>{"summary"=>"Get all employees", "description"=>"Gives information for every employee associated to a merchant by default. Accepts optional filter and expand query parameters.", "operationId"=>"GetEmployees", "x-api-path-slug"=>"v3merchantsmidemployees-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [roles, shifts]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [id, name, email, role, customId, role"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employees"]}, "post"=>{"summary"=>"Create an employee", "description"=>"Creates an employee for a merchant. Accepts optional expand parameters.", "operationId"=>"CreateEmployee", "x-api-path-slug"=>"v3merchantsmidemployees-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [shifts, payments, orders, roles]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employees"]}}, "/v3/merchants/{mId}/customers/{customerId}/phone_numbers"=>{"post"=>{"summary"=>"Create a phone number for a customer", "description"=>"Creates a phone number associated to a merchant's customer.", "operationId"=>"DelegatedCreateCustomerPhoneNumber", "x-api-path-slug"=>"v3merchantsmidcustomerscustomeridphone-numbers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "CustomerId", "Phone", "Numbers"]}}, "/v3/merchants/{mId}/employees/{empId}"=>{"get"=>{"summary"=>"Get a single employee", "description"=>"Returns information for a single employee. Accepts optional expand query parameters", "operationId"=>"GetEmployee", "x-api-path-slug"=>"v3merchantsmidemployeesempid-get", "parameters"=>[{"in"=>"path", "name"=>"empId", "description"=>"Employee Id"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [roles, shifts]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employees", "EmpId"]}, "post"=>{"summary"=>"Update an employee", "description"=>"Updates information for a single employee. Accepts optional expand query params.", "operationId"=>"UpdateEmployee", "x-api-path-slug"=>"v3merchantsmidemployeesempid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"empId", "description"=>"Employee Id"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [shifts, payments, orders, roles]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employees", "EmpId"]}, "delete"=>{"summary"=>"Delete an employee", "description"=>"Deletes a single employee from a merchant. Third party developers cannot delete the 'owner' employee.", "operationId"=>"DeleteEmployee", "x-api-path-slug"=>"v3merchantsmidemployeesempid-delete", "parameters"=>[{"in"=>"path", "name"=>"empId", "description"=>"Employee Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employees", "EmpId"]}}, "/v3/merchants/{mId}/customers/{customerId}/phone_numbers/{phoneId}"=>{"post"=>{"summary"=>"Update a phone number for a customer", "description"=>"Updates a merchant's customer's phone number.", "operationId"=>"DelegatedUpdateCustomerPhoneNumber", "x-api-path-slug"=>"v3merchantsmidcustomerscustomeridphone-numbersphoneid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"phoneId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "CustomerId", "Phone", "Numbers", "PhoneId"]}, "delete"=>{"summary"=>"Delete a customer phone number", "description"=>"Deletes a merchant's customer's phone number.", "operationId"=>"DelegatedDeleteCustomerPhoneNumber", "x-api-path-slug"=>"v3merchantsmidcustomerscustomeridphone-numbersphoneid-delete", "parameters"=>[{"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"phoneId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "CustomerId", "Phone", "Numbers", "PhoneId"]}}, "/v3/merchants/{mId}/items"=>{"get"=>{"summary"=>"Get all inventory items", "description"=>"Get all inventory items.", "operationId"=>"GetItems", "x-api-path-slug"=>"v3merchantsmiditems-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [tags, categories, taxRates, modifierGroups, itemStock, options]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [id, name, sku, modifiedTime, deleted, hidden, price, alternateName, itemCode, item"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Items"]}, "post"=>{"summary"=>"Create an inventory item", "description"=>"Create an inventory item.", "operationId"=>"CreateItem", "x-api-path-slug"=>"v3merchantsmiditems-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [tags, categories, taxRates, modifierGroups, itemStock, options]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Items"]}, "delete"=>{"summary"=>"Bulk delete inventory items", "description"=>"Bulk delete inventory items.", "operationId"=>"BulkDeleteItems", "x-api-path-slug"=>"v3merchantsmiditems-delete", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Items"]}}, "/v3/merchants/{mId}/customers/{customerId}/email_addresses"=>{"post"=>{"summary"=>"Create an email address for a customer", "description"=>"Creates an email address associated to a merchant's customer.", "operationId"=>"DelegatedCreateCustomerEmailAddress", "x-api-path-slug"=>"v3merchantsmidcustomerscustomeridemail-addresses-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "CustomerId", "Email", "Addresses"]}}, "/v3/merchants/{mId}/shifts"=>{"get"=>{"summary"=>"Get all shifts", "description"=>"Get all shifts.", "operationId"=>"GetAllShifts", "x-api-path-slug"=>"v3merchantsmidshifts-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [employee, overrideInEmployee, overrideOutEmployee]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [id, employee"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Shifts"]}}, "/v3/merchants/{mId}/customers/{customerId}/email_addresses/{emailId}"=>{"post"=>{"summary"=>"Update an email address for a customer", "description"=>"Updates a merchant's customer's email address.", "operationId"=>"DelegatedUpdateCustomerEmailAddress", "x-api-path-slug"=>"v3merchantsmidcustomerscustomeridemail-addressesemailid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"emailId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "CustomerId", "Email", "Addresses", "EmailId"]}, "delete"=>{"summary"=>"Delete a customer email address", "description"=>"Deletes a merchant's customer's email address.", "operationId"=>"DelegatedDeleteCustomerEmailAddress", "x-api-path-slug"=>"v3merchantsmidcustomerscustomeridemail-addressesemailid-delete", "parameters"=>[{"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"emailId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "CustomerId", "Email", "Addresses", "EmailId"]}}, "/v3/merchants/{mId}/shifts/{shiftId}"=>{"get"=>{"summary"=>"Get a single shift", "description"=>"Get a single shift.", "operationId"=>"GetShift", "x-api-path-slug"=>"v3merchantsmidshiftsshiftid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [employee, overrideInEmployee, overrideOutEmployee]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"shiftId", "description"=>"Employee Shift Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Shifts", "ShiftId"]}}, "/v3/merchants/{mId}/items/{itemId}"=>{"get"=>{"summary"=>"Get a single inventory item", "description"=>"Get a single inventory item.", "operationId"=>"GetItem", "x-api-path-slug"=>"v3merchantsmiditemsitemid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [tags, categories, taxRates, modifierGroups, itemStock, options]"}, {"in"=>"path", "name"=>"itemId", "description"=>"Item Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Items", "ItemId"]}, "post"=>{"summary"=>"Update an existing inventory item", "description"=>"Update an existing inventory item.", "operationId"=>"UpdateItem", "x-api-path-slug"=>"v3merchantsmiditemsitemid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [tags, categories, taxRates, modifierGroups, itemStock, options]"}, {"in"=>"path", "name"=>"itemId", "description"=>"Item Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Items", "ItemId"]}, "delete"=>{"summary"=>"Delete an inventory item", "description"=>"Delete an inventory item.", "operationId"=>"DeleteItem", "x-api-path-slug"=>"v3merchantsmiditemsitemid-delete", "parameters"=>[{"in"=>"path", "name"=>"itemId", "description"=>"Item Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Items", "ItemId"]}}, "/v3/merchants/{mId}/shifts.csv"=>{"get"=>{"summary"=>"Get .csv of all shifts", "description"=>"Get .csv of all shifts.", "operationId"=>"GetAllShiftsCSV", "x-api-path-slug"=>"v3merchantsmidshifts-csv-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [id, employee"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Shifts", "Csv"]}}, "/v3/apps/{aId}/merchants/{mId}/notifications"=>{"post"=>{"summary"=>"Create a notification for an app", "description"=>"Push a message to all merchant devices that have your app installed and are listening for notifications. For details on how to use Clover's Android SDK to receive notifications see: https://github.com/clover/android-examples/tree/master/pushnotificationexample", "operationId"=>"CreateMerchantAppNotification", "x-api-path-slug"=>"v3appsaidmerchantsmidnotifications-post", "parameters"=>[{"in"=>"path", "name"=>"aId", "description"=>"App Id"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apps", "Merchants", "Notifications"]}}, "/v3/merchants/{mId}/employees/{empId}/shifts"=>{"get"=>{"summary"=>"Get all shifts for an employee", "description"=>"Get all shifts for an employee.", "operationId"=>"GetEmployeeShifts", "x-api-path-slug"=>"v3merchantsmidemployeesempidshifts-get", "parameters"=>[{"in"=>"path", "name"=>"empId", "description"=>"Employee Id"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [employee, overrideInEmployee, overrideOutEmployee]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [id, employee"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employees", "EmpId", "Shifts"]}, "post"=>{"summary"=>"Create shift for an employee", "description"=>"Create shift for an employee.", "operationId"=>"CreateShift", "x-api-path-slug"=>"v3merchantsmidemployeesempidshifts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"empId", "description"=>"Employee Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employees", "EmpId", "Shifts"]}}, "/v3/merchants/{mId}/customers/{customerId}/addresses"=>{"post"=>{"summary"=>"Create an address for a customer", "description"=>"Creates an address associated to a merchant's customer.", "operationId"=>"DelegatedCreateCustomerAddress", "x-api-path-slug"=>"v3merchantsmidcustomerscustomeridaddresses-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "CustomerId", "Addresses"]}}, "/v3/apps/{aId}/devices/{dId}/notifications"=>{"post"=>{"summary"=>"Create a notification for a device", "description"=>"Push a message to a device that has your app installed and is listening for notifications. For details on how to use Clover's Android SDK to receive notifications see: https://github.com/clover/android-examples/tree/master/pushnotificationexample", "operationId"=>"CreateDeviceAppNotification", "x-api-path-slug"=>"v3appsaiddevicesdidnotifications-post", "parameters"=>[{"in"=>"path", "name"=>"aId", "description"=>"App Id"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"dId", "description"=>"Developer Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apps", "Devices", "DId", "Notifications"]}}, "/v3/merchants/{mId}/customers/{customerId}/addresses/{addressId}"=>{"post"=>{"summary"=>"Update an address for a customer", "description"=>"Updates a merchant's customer's address.", "operationId"=>"DelegatedUpdateCustomerAddress", "x-api-path-slug"=>"v3merchantsmidcustomerscustomeridaddressesaddressid-post", "parameters"=>[{"in"=>"path", "name"=>"addressId"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "CustomerId", "Addresses", "AddressId"]}, "delete"=>{"summary"=>"Delete a customer address", "description"=>"Deletes a merchant's customer's address.", "operationId"=>"DelegatedDeleteCustomerAddress", "x-api-path-slug"=>"v3merchantsmidcustomerscustomeridaddressesaddressid-delete", "parameters"=>[{"in"=>"path", "name"=>"addressId"}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "CustomerId", "Addresses", "AddressId"]}}, "/v3/merchants/{mId}/bulk_items"=>{"post"=>{"summary"=>"Create multiple inventory items.", "description"=>"This API is to create multiple inventory items. Use the PATCH HTTP method to update existing inventory items.", "operationId"=>"BulkCreateInventoryItems", "x-api-path-slug"=>"v3merchantsmidbulk-items-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Bulk", "Items"]}, "put"=>{"summary"=>"Update existing inventory items.", "description"=>"This API is to going to update only the changes present in the payload. Not going to replace the existing inventory items. Use the POST HTTP method to create inventory items.", "operationId"=>"BulkPatchInventoryItems", "x-api-path-slug"=>"v3merchantsmidbulk-items-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Bulk", "Items"]}}, "/v3/merchants/{mId}/employees/{empId}/shifts/{shiftId}"=>{"get"=>{"summary"=>"Get a single shift", "description"=>"Get a single shift.", "operationId"=>"GetEmployeeShift", "x-api-path-slug"=>"v3merchantsmidemployeesempidshiftsshiftid-get", "parameters"=>[{"in"=>"path", "name"=>"empId", "description"=>"Employee Id"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [employee, overrideInEmployee, overrideOutEmployee]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"shiftId", "description"=>"Employee Shift Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employees", "EmpId", "Shifts", "ShiftId"]}, "post"=>{"summary"=>"Update a single shift", "description"=>"Update a single shift.", "operationId"=>"UpdateShift", "x-api-path-slug"=>"v3merchantsmidemployeesempidshiftsshiftid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"empId", "description"=>"Employee Id"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [employee, overrideInEmployee, overrideOutEmployee]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"shiftId", "description"=>"Employee Shift Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employees", "EmpId", "Shifts", "ShiftId"]}, "delete"=>{"summary"=>"Delete a single shift", "description"=>"Delete a single shift.", "operationId"=>"DeleteShift", "x-api-path-slug"=>"v3merchantsmidemployeesempidshiftsshiftid-delete", "parameters"=>[{"in"=>"path", "name"=>"empId", "description"=>"Employee Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"shiftId", "description"=>"Employee Shift Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employees", "EmpId", "Shifts", "ShiftId"]}}, "/v3/merchants/{mId}/item_stocks"=>{"get"=>{"summary"=>"Get the stock of all inventory items", "description"=>"Get the stock of all inventory items.", "operationId"=>"GetItemStocks", "x-api-path-slug"=>"v3merchantsmiditem-stocks-get", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Item", "Stocks"]}}, "/v3/merchants/{mId}/customers/{customerId}/cards"=>{"post"=>{"summary"=>"Create a credit/debit card entry for a customer", "description"=>"Create a credit/debit card entry for a customer.", "operationId"=>"DelegatedCreateCustomerCard", "x-api-path-slug"=>"v3merchantsmidcustomerscustomeridcards-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "CustomerId", "Cards"]}}, "/v3/merchants/{mId}/item_stocks/{itemId}"=>{"get"=>{"summary"=>"Get the stock of an inventory item", "description"=>"Get the stock of an inventory item.", "operationId"=>"GetItemStock", "x-api-path-slug"=>"v3merchantsmiditem-stocksitemid-get", "parameters"=>[{"in"=>"path", "name"=>"itemId", "description"=>"Item Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Item", "Stocks", "ItemId"]}, "post"=>{"summary"=>"Update the stock of an inventory item", "description"=>"Update the stock of an inventory item.", "operationId"=>"UpdateItemStock", "x-api-path-slug"=>"v3merchantsmiditem-stocksitemid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"itemId", "description"=>"Item Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Item", "Stocks", "ItemId"]}, "delete"=>{"summary"=>"Delete the stock of an inventory item", "description"=>"Delete the stock of an inventory item.", "operationId"=>"DeleteItemStock", "x-api-path-slug"=>"v3merchantsmiditem-stocksitemid-delete", "parameters"=>[{"in"=>"path", "name"=>"itemId", "description"=>"Item Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Item", "Stocks", "ItemId"]}}, "/v3/merchants/{mId}/customers/{customerId}/cards/{cardId}"=>{"post"=>{"summary"=>"Update a credit/debit card record for a customer", "description"=>"Update a credit/debit card record for a customer.", "operationId"=>"DelegatedUpdateCustomerCard", "x-api-path-slug"=>"v3merchantsmidcustomerscustomeridcardscardid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"cardId"}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "CustomerId", "Cards", "CardId"]}, "delete"=>{"summary"=>"Delete a customer card", "description"=>"Delete a customer card.", "operationId"=>"DelegatedDeleteCustomerCard", "x-api-path-slug"=>"v3merchantsmidcustomerscustomeridcardscardid-delete", "parameters"=>[{"in"=>"path", "name"=>"cardId"}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "CustomerId", "Cards", "CardId"]}}, "/v3/merchants/{mId}/orders"=>{"get"=>{"summary"=>"Gets a list of orders", "description"=>"Returns a list of orders. See https://docs.clover.com/build/working-with-orders/ for more details.", "operationId"=>"GetOrders", "x-api-path-slug"=>"v3merchantsmidorders-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [lineItems, serviceCharge, discounts, credits, payments, refunds]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [employee"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders"]}, "post"=>{"summary"=>"Create an order", "description"=>"Only supports basic order creation. Valid fields are limited to taxRemoved, note, title, and orderType. Adding line items must be done in separate calls.", "operationId"=>"CreateOrder", "x-api-path-slug"=>"v3merchantsmidorders-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders"]}}, "/v3/merchants/{mId}/item_groups"=>{"get"=>{"summary"=>"Get all item groups", "description"=>"Item Groups help merchants create and manage large groups of related items. This is described to merchants as an 'Item with variants'.\n\nFor example a merchants may sell a t-shirt that is available in numerous various sizes and colors. Each of the t-shirt variations is an item and belongs to the t-shirt item group. Once an item group is created it appears in Register as a single button and tapping it brings up a choice of which variation is to be sold. Before adding items to an item group you first need to create the item group, then create attributes ('size', 'color') and then options for each attribute ('small', 'blue'), then associate options with an item and then associate items with an item group.\n\nThe name of an item which is a member of an item group is automatically generated by the Clover server as a combination of the item group name and the name of all the options associated with that item. It cannot be changed. If the item group name is changed, or if an option name is changed, then the item names will be automatically regenerated.\n\nAn item can only be a member of a single item group and once it is part of an item group it can never be removed or moved to another item group, it can only be deleted.", "operationId"=>"GetItemGroups", "x-api-path-slug"=>"v3merchantsmiditem-groups-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items, attributes]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, name, id, deletedTime]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Item", "Groups"]}, "post"=>{"summary"=>"Create an item group", "description"=>"Create an item group.", "operationId"=>"CreateItemGroup", "x-api-path-slug"=>"v3merchantsmiditem-groups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items, attributes]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Item", "Groups"]}}, "/v3/merchants/{mId}/employees/{empId}/orders"=>{"get"=>{"summary"=>"Get all orders for an employee", "description"=>"Get all orders for an employee.", "operationId"=>"GetEmployeeOrders", "x-api-path-slug"=>"v3merchantsmidemployeesempidorders-get", "parameters"=>[{"in"=>"path", "name"=>"empId", "description"=>"Employee Id"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [lineItems, customers, payments, credits, refunds, serviceCharge, discounts]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [lineItems, customers, payments, credits, refunds, serviceCharge, discounts]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employees", "EmpId", "Orders"]}}, "/v3/merchants/{mId}/customers/{customerId}/metadata"=>{"post"=>{"summary"=>"Create note, birthday, business name for a customer", "description"=>"Creates note, birthday, business name associated to a merchant's customer.", "operationId"=>"DelegatedCreateOrUpdateCustomerMetadata", "x-api-path-slug"=>"v3merchantsmidcustomerscustomeridmetadata-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Customers", "CustomerId", "Metadata"]}}, "/v3/merchants/{mId}/orders/{orderId}"=>{"get"=>{"summary"=>"Get a single order", "description"=>"Returns a single order. See https://docs.clover.com/build/working-with-orders/ for more details.", "operationId"=>"GetOrder", "x-api-path-slug"=>"v3merchantsmidordersorderid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [lineItems, customers, payments, credits, refunds, serviceCharge, discounts]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId"]}, "post"=>{"summary"=>"Update an order", "description"=>"Update an order.", "operationId"=>"UpdateOrder", "x-api-path-slug"=>"v3merchantsmidordersorderid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [lineItems, customers, payments, credits, refunds, serviceCharge, discounts]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId"]}, "delete"=>{"summary"=>"Delete an order", "description"=>"Delete an order.", "operationId"=>"DeleteOrder", "x-api-path-slug"=>"v3merchantsmidordersorderid-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId"]}}, "/v3/merchants/{mId}/authorizations"=>{"get"=>{"summary"=>"Get all authorizations.", "description"=>"An authorization is a promise by a card issuer that a merchant can charge the customer up to the specified amount in the future. These are typically created when a merchant uses the \"Bar Tabs\" app and \"Authorizations\" app.", "operationId"=>"GetAuthorizations", "x-api-path-slug"=>"v3merchantsmidauthorizations-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [payment]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [last4, note, amount, tabName, orderId, cardType, orderModifiedTime, type, device"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Authorizations"]}, "post"=>{"summary"=>"Create an authorization on a Payment", "description"=>"Authorization must reference a payment, have an amount greater than 0, and have a type.", "operationId"=>"CreateAuthorization", "x-api-path-slug"=>"v3merchantsmidauthorizations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Authorizations"]}}, "/v3/merchants/{mId}/item_groups/{itemGroupId}"=>{"get"=>{"summary"=>"Get a single item group", "description"=>"Get a single item group.", "operationId"=>"GetItemGroup", "x-api-path-slug"=>"v3merchantsmiditem-groupsitemgroupid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items, attributes]"}, {"in"=>"path", "name"=>"itemGroupId", "description"=>"Item Group Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Item", "Groups", "ItemGroupId"]}, "post"=>{"summary"=>"Update an item group", "description"=>"Update an item group.", "operationId"=>"UpdateItemGroup", "x-api-path-slug"=>"v3merchantsmiditem-groupsitemgroupid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items, attributes]"}, {"in"=>"path", "name"=>"itemGroupId", "description"=>"Item Group Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Item", "Groups", "ItemGroupId"]}, "delete"=>{"summary"=>"Delete an item group", "description"=>"Delete an item group.", "operationId"=>"DeleteItemGroup", "x-api-path-slug"=>"v3merchantsmiditem-groupsitemgroupid-delete", "parameters"=>[{"in"=>"path", "name"=>"itemGroupId", "description"=>"Item Group Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Item", "Groups", "ItemGroupId"]}}, "/v3/apps/{aId}/merchants/{mId}/billing_info"=>{"get"=>{"summary"=>"Get merchant's billing information for an app", "description"=>"Gives detailed information about the status of the merchant's billing for the app including current subscription tier and trial status. Requires an OAuth generated token.", "operationId"=>"GetMerchantBillingInfo", "x-api-path-slug"=>"v3appsaidmerchantsmidbilling-info-get", "parameters"=>[{"in"=>"path", "name"=>"aId", "description"=>"App Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apps", "Merchants", "Billing", "Info"]}}, "/v3/merchants/{mId}/authorizations/{authId}"=>{"get"=>{"summary"=>"Get a single authorization", "description"=>"Get a single authorization.", "operationId"=>"GetAuthorization", "x-api-path-slug"=>"v3merchantsmidauthorizationsauthid-get", "parameters"=>[{"in"=>"path", "name"=>"authId"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [cardTransaction, dccInfo, germanInfo, appTracking, taxRates, lineItemPayments, refunds, order, tender, employee, transactionInfo]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Authorizations", "AuthId"]}, "post"=>{"summary"=>"Add a single authorization", "description"=>".Add a single authorization", "operationId"=>"UpdateAuthorization", "x-api-path-slug"=>"v3merchantsmidauthorizationsauthid-post", "parameters"=>[{"in"=>"path", "name"=>"authId"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Authorizations", "AuthId"]}, "delete"=>{"summary"=>"Delete a single authorization", "description"=>".Delete a single authorization", "operationId"=>"DeleteAuthorization", "x-api-path-slug"=>"v3merchantsmidauthorizationsauthid-delete", "parameters"=>[{"in"=>"path", "name"=>"authId"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Authorizations", "AuthId"]}}, "/v3/apps/{aId}/merchants/{mId}/metereds/{meteredId}"=>{"post"=>{"summary"=>"Create an app billing metered event", "description"=>"This creates an app billing metered event. The amount Clover will charge the specified merchant is based on the cost specified for this metered object in the Developer Dashboard. The merchant will be billed during their next scheduled billing cycle. Passing \"count\" as a query parameter will bill the merchant for that number of metered events. \"count\" must be passed as a query parameter in order to function properly ??? if passed in the request body, it will be ignored. If not specified, \"count\" will default to 1. See https://docs.clover.com/launch/billing/ for more information. Requires an OAuth generated token.", "operationId"=>"CreateMerchantAppMeteredEvent", "x-api-path-slug"=>"v3appsaidmerchantsmidmeteredsmeteredid-post", "parameters"=>[{"in"=>"path", "name"=>"aId", "description"=>"App Id"}, {"in"=>"path", "name"=>"meteredId", "description"=>"Metered Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apps", "Merchants", "Metereds", "MeteredId"]}, "get"=>{"summary"=>"Get the app metered billing events for an app metered, e.g. all the billing events for the event 'reservation'", "description"=>"Get the app metered billing events for an app metered, e.g. all the billing events for the event 'reservation'.", "operationId"=>"GetMerchantAppMeteredEvents", "x-api-path-slug"=>"v3appsaidmerchantsmidmeteredsmeteredid-get", "parameters"=>[{"in"=>"path", "name"=>"aId", "description"=>"App Id"}, {"in"=>"path", "name"=>"meteredId", "description"=>"Metered Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apps", "Merchants", "Metereds", "MeteredId"]}}, "/v3/merchants/{mId}/tags"=>{"get"=>{"summary"=>"Get all tags", "description"=>"Similarly to how they are described by wikipedia, tags are an informal way of establishing a relationship. Tags currently may be associated with items and printers. When an tag is associated with both an item and a printer that establishes a special relationship that results in those items being printed out on the associated printer when printing an order. Other than that special case there is no effect when an item is associated with a tag. Developers may use tags to establish a relationship meaningful for their needs.", "operationId"=>"GetTags", "x-api-path-slug"=>"v3merchantsmidtags-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items, printers]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, deleted, name, id]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tags"]}, "post"=>{"summary"=>"Create a tag", "description"=>"Create a tag.", "operationId"=>"CreateTag", "x-api-path-slug"=>"v3merchantsmidtags-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tags"]}}, "/v3/merchants/{mId}/orders/{orderId}/discounts"=>{"get"=>{"summary"=>"Get all discounts for an order", "description"=>"Get all discounts for an order.", "operationId"=>"GetOrderDiscounts", "x-api-path-slug"=>"v3merchantsmidordersorderiddiscounts-get", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Discounts"]}, "post"=>{"summary"=>"Create a discount on an order or line item", "description"=>"Create a discount on an order or line item.", "operationId"=>"CreateDiscount", "x-api-path-slug"=>"v3merchantsmidordersorderiddiscounts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Discounts"]}}, "/v3/apps/{aId}/merchants/{mId}/metereds/{meteredId}/events/{eventId}"=>{"get"=>{"summary"=>"Get an app billing metered event", "description"=>"This enables you to fetch the details on a merchants app billing metered event. Requires an OAuth generated token.", "operationId"=>"GetMerchantAppMeteredEvent", "x-api-path-slug"=>"v3appsaidmerchantsmidmeteredsmeteredideventseventid-get", "parameters"=>[{"in"=>"path", "name"=>"aId", "description"=>"App Id"}, {"in"=>"path", "name"=>"eventId"}, {"in"=>"path", "name"=>"meteredId", "description"=>"Metered Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apps", "Merchants", "Metereds", "MeteredId", "Events", "EventId"]}, "delete"=>{"summary"=>"Delete an app billing metered event, if not charged.", "description"=>"This deletes an app billing metered event, if the event has not been charged yet. See https://docs.clover.com/launch/billing/ for more information. Requires an OAuth generated token.", "operationId"=>"DeleteMerchantAppMeteredEvent", "x-api-path-slug"=>"v3appsaidmerchantsmidmeteredsmeteredideventseventid-delete", "parameters"=>[{"in"=>"path", "name"=>"aId", "description"=>"App Id"}, {"in"=>"path", "name"=>"eventId"}, {"in"=>"path", "name"=>"meteredId", "description"=>"Metered Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apps", "Merchants", "Metereds", "MeteredId", "Events", "EventId"]}}, "/v3/merchants/{mId}/orders/{orderId}/discounts/{discountId}"=>{"delete"=>{"summary"=>"Delete a discount", "description"=>"Delete a discount.", "operationId"=>"RemoveDiscount", "x-api-path-slug"=>"v3merchantsmidordersorderiddiscountsdiscountid-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"discountId", "description"=>"Discount Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Discounts", "DiscountId"]}}, "/v3/merchants/{mId}/tags/{tagId}"=>{"get"=>{"summary"=>"Get a single tag", "description"=>"Get a single tag.", "operationId"=>"GetTag", "x-api-path-slug"=>"v3merchantsmidtagstagid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items, printers]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"tagId", "description"=>"Tag Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tags", "TagId"]}, "post"=>{"summary"=>"Update a single tag", "description"=>"Update a single tag.", "operationId"=>"UpdateTag", "x-api-path-slug"=>"v3merchantsmidtagstagid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items, printers]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"tagId", "description"=>"Tag Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tags", "TagId"]}, "delete"=>{"summary"=>"Delete a tag", "description"=>"Delete a tag.", "operationId"=>"DeleteTag", "x-api-path-slug"=>"v3merchantsmidtagstagid-delete", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"tagId", "description"=>"Tag Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tags", "TagId"]}}, "/v3/merchants/{mId}/orders/{orderId}/line_items"=>{"get"=>{"summary"=>"Get all line items for an order", "description"=>"Get all line items for an order.", "operationId"=>"GetOrderLineItems", "x-api-path-slug"=>"v3merchantsmidordersorderidline-items-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [employee, orderType, discounts, modifications, taxRates, payments]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Line", "Items"]}, "post"=>{"summary"=>"Create a new line item", "description"=>"Create a new line item.", "operationId"=>"CreateLineItem", "x-api-path-slug"=>"v3merchantsmidordersorderidline-items-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Line", "Items"]}}, "/v3/merchants/{mId}/items/{itemId}/tags"=>{"get"=>{"summary"=>"Get tags for a single item", "description"=>"Get tags for a single item.", "operationId"=>"GetItemTags", "x-api-path-slug"=>"v3merchantsmiditemsitemidtags-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items, printers]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, deleted, name, id]"}, {"in"=>"path", "name"=>"itemId", "description"=>"Item Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Items", "ItemId", "Tags"]}}, "/v3/merchants/{mId}/orders/{orderId}/line_items/{lineItemId}"=>{"get"=>{"summary"=>"Get a line item", "description"=>"Get a line item.", "operationId"=>"GetOrderLineItem", "x-api-path-slug"=>"v3merchantsmidordersorderidline-itemslineitemid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [employee, orderType, discounts, modifications, taxRates, payments]"}, {"in"=>"path", "name"=>"lineItemId", "description"=>"Line Item Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Line", "Items", "LineItemId"]}, "post"=>{"summary"=>"Update a line item", "description"=>"Update a line item.", "operationId"=>"UpdateOrderLineItem", "x-api-path-slug"=>"v3merchantsmidordersorderidline-itemslineitemid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [employee, orderType, discounts, modifications, taxRates, payments]"}, {"in"=>"path", "name"=>"lineItemId", "description"=>"Line Item Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Line", "Items", "LineItemId"]}, "delete"=>{"summary"=>"Void a line item", "description"=>"Void a line item.", "operationId"=>"DeleteOrderLineItem", "x-api-path-slug"=>"v3merchantsmidordersorderidline-itemslineitemid-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"lineItemId", "description"=>"Line Item Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Line", "Items", "LineItemId"]}}, "/v3/merchants/{mId}/tags/{tagId}/items"=>{"get"=>{"summary"=>"Get all items for a single tag", "description"=>"Get all items for a single tag.", "operationId"=>"GetTaggedItems", "x-api-path-slug"=>"v3merchantsmidtagstagiditems-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items, printers]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, hidden, itemCode, alternateName, option"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"tagId", "description"=>"Tag Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tags", "TagId", "Items"]}}, "/v3/merchants/{mId}/tag_items"=>{"post"=>{"summary"=>"Create or delete tag items", "description"=>"Create or delete tag items.", "operationId"=>"CreateOrDeleteTagItems", "x-api-path-slug"=>"v3merchantsmidtag-items-post", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tag", "Items"]}}, "/v3/merchants/{mId}/tax_rates"=>{"get"=>{"summary"=>"Get all tax rates", "description"=>"Get all tax rates.", "operationId"=>"GetTaxRates", "x-api-path-slug"=>"v3merchantsmidtax-rates-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [isDefault, rate, items"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tax", "Rates"]}, "post"=>{"summary"=>"Create a tax rate for a merchant", "description"=>"Create a tax rate for a merchant.", "operationId"=>"CreateTaxRate", "x-api-path-slug"=>"v3merchantsmidtax-rates-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tax", "Rates"]}}, "/v3/merchants/{mId}/orders/{orderId}/line_items/{lineItemId}/discounts"=>{"post"=>{"summary"=>"Create a discount on an order or line item", "description"=>"Create a discount on an order or line item.", "operationId"=>"CreateDiscount", "x-api-path-slug"=>"v3merchantsmidordersorderidline-itemslineitemiddiscounts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"lineItemId", "description"=>"Line Item Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Line", "Items", "LineItemId", "Discounts"]}}, "/v3/merchants/{mId}/tax_rates/{taxId}"=>{"get"=>{"summary"=>"Get a single tax rate", "description"=>"Get a single tax rate.", "operationId"=>"GetTaxRate", "x-api-path-slug"=>"v3merchantsmidtax-ratestaxid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"taxId", "description"=>"Tax Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tax", "Rates", "TaxId"]}, "post"=>{"summary"=>"Update a single tax rate", "description"=>"Update a single tax rate.", "operationId"=>"UpdateTaxRate", "x-api-path-slug"=>"v3merchantsmidtax-ratestaxid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"taxId", "description"=>"Tax Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tax", "Rates", "TaxId"]}, "delete"=>{"summary"=>"Delete a single tax rate", "description"=>"Delete a single tax rate.", "operationId"=>"DeleteTaxRate", "x-api-path-slug"=>"v3merchantsmidtax-ratestaxid-delete", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"taxId", "description"=>"Tax Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tax", "Rates", "TaxId"]}}, "/v3/merchants/{mId}/orders/{orderId}/line_items/{lineItemId}/discounts/{discountId}"=>{"delete"=>{"summary"=>"Delete a discount", "description"=>"Delete a discount.", "operationId"=>"RemoveDiscount", "x-api-path-slug"=>"v3merchantsmidordersorderidline-itemslineitemiddiscountsdiscountid-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"discountId", "description"=>"Discount Id"}, {"in"=>"path", "name"=>"lineItemId", "description"=>"Line Item Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Line", "Items", "LineItemId", "Discounts", "DiscountId"]}}, "/v3/merchants/{mId}/orders/{orderId}/line_items/{lineItemId}/modifications"=>{"post"=>{"summary"=>"Apply a modification to a line item", "description"=>"Create a modification, a record of a modifier as it exists at the time it is applied to the lineItem. To view current modifications use an 'expand=modifications' query parameter on the lineItem. To learn more about applying a modification see: https://docs.clover.com/build/working-with-orders/#add-item-modifiers", "operationId"=>"ApplyModification", "x-api-path-slug"=>"v3merchantsmidordersorderidline-itemslineitemidmodifications-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"lineItemId", "description"=>"Line Item Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Line", "Items", "LineItemId", "Modifications"]}}, "/v3/merchants/{mId}/categories"=>{"get"=>{"summary"=>"Get all categories", "description"=>"Categories alter the user experience of the Register app. Items will appear in the Register app within the categories they are members of. Items may be associated with no, one or multiple categories. Items are displayed in Register in the order in which they are added to a category. Categories are displayed in Register using the sort order value for each category.", "operationId"=>"GetCategories", "x-api-path-slug"=>"v3merchantsmidcategories-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, deleted, sortOrder, name, id]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Categories"]}, "post"=>{"summary"=>"Create an item category", "description"=>"Create an item category.", "operationId"=>"CreateCategory", "x-api-path-slug"=>"v3merchantsmidcategories-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Categories"]}}, "/v3/merchants/{mId}/orders/{orderId}/line_items/{lineItemId}/modifications/{modificationId}"=>{"delete"=>{"summary"=>"Remove a modification from a line item", "description"=>"Delete a modification by UUID, removing the record of an applied modification", "operationId"=>"RemoveModification", "x-api-path-slug"=>"v3merchantsmidordersorderidline-itemslineitemidmodificationsmodificationid-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"lineItemId", "description"=>"Line Item Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"modificationId"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Line", "Items", "LineItemId", "Modifications", "ModificationId"]}}, "/v3/merchants/{mId}/categories/{catId}"=>{"get"=>{"summary"=>"Get a category", "description"=>"Get a category.", "operationId"=>"GetCategory", "x-api-path-slug"=>"v3merchantsmidcategoriescatid-get", "parameters"=>[{"in"=>"path", "name"=>"catId", "description"=>"Category Id"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Categories", "CatId"]}, "post"=>{"summary"=>"Update a category", "description"=>"Update a category.", "operationId"=>"UpdateCategory", "x-api-path-slug"=>"v3merchantsmidcategoriescatid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"catId", "description"=>"Category Id"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Categories", "CatId"]}, "delete"=>{"summary"=>"Delete a single item category", "description"=>"Delete a single item category.", "operationId"=>"DeleteCategory", "x-api-path-slug"=>"v3merchantsmidcategoriescatid-delete", "parameters"=>[{"in"=>"path", "name"=>"catId", "description"=>"Category Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Categories", "CatId"]}}, "/v3/merchants/{mId}/orders/{orderId}/bulk_line_items"=>{"post"=>{"summary"=>"Create multiple line items in bulk.", "description"=>"Create multiple line items in bulk..", "operationId"=>"BulkCreateLineItems", "x-api-path-slug"=>"v3merchantsmidordersorderidbulk-line-items-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Bulk", "Line", "Items"]}}, "/v3/merchants/{mId}/orders/{orderId}/payments"=>{"post"=>{"summary"=>"Create a payment record on an order", "description"=>"Create a payment record on an order.", "operationId"=>"CreatePaymentForOrder", "x-api-path-slug"=>"v3merchantsmidordersorderidpayments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Payments"]}, "get"=>{"summary"=>"Get all payments for an order", "description"=>"Get all payments for an order.", "operationId"=>"GetOrderPayments", "x-api-path-slug"=>"v3merchantsmidordersorderidpayments-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [cardTransaction, dccInfo, germanInfo, appTracking, taxRates, lineItemPayments, refunds, order, tender, employee, transactionInfo]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, voidReason, cardTransaction"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Payments"]}}, "/v3/merchants/{mId}/categories/{catId}/items"=>{"get"=>{"summary"=>"Get all items in a single category", "description"=>"Get all items in a single category.", "operationId"=>"GetCategoryItems", "x-api-path-slug"=>"v3merchantsmidcategoriescatiditems-get", "parameters"=>[{"in"=>"path", "name"=>"catId", "description"=>"Category Id"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, deleted, sortOrder, name, id]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Categories", "CatId", "Items"]}}, "/v3/merchants/{mId}/items/{itemId}/categories"=>{"get"=>{"summary"=>"Get all categories of a single item", "description"=>"Get all categories of a single item.", "operationId"=>"GetItemCategories", "x-api-path-slug"=>"v3merchantsmiditemsitemidcategories-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, deleted, sortOrder, name, id]"}, {"in"=>"path", "name"=>"itemId", "description"=>"Item Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Items", "ItemId", "Categories"]}}, "/v3/merchants/{mId}/category_items"=>{"post"=>{"summary"=>"Create or delete an item/category association", "description"=>"Create or delete an item/category association.", "operationId"=>"CreateOrDeleteCategoryItems", "x-api-path-slug"=>"v3merchantsmidcategory-items-post", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Category", "Items"]}}, "/v3/merchants/{mId}/tax_rate_items"=>{"post"=>{"summary"=>"Create or delete a tax rate item", "description"=>"Create or delete a tax rate item.", "operationId"=>"CreateOrDeleteTaxRateItems", "x-api-path-slug"=>"v3merchantsmidtax-rate-items-post", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tax", "Rate", "Items"]}}, "/v3/merchants/{mId}/tax_rates/{taxId}/items"=>{"get"=>{"summary"=>"Get items by tax rate", "description"=>"Get items by tax rate.", "operationId"=>"GetItemsByTaxRate", "x-api-path-slug"=>"v3merchantsmidtax-ratestaxiditems-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [items]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [id, name, sku, modifiedTime, deleted, hidden, price, alternateName, itemCode, item"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"taxId", "description"=>"Tax Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Tax", "Rates", "TaxId", "Items"]}}, "/v3/merchants/{mId}/modifier_groups"=>{"get"=>{"summary"=>"Get all modifier groups", "description"=>"These groupings are the categories different modifiers belong to. Modifier groups can be made available for specific inventory Items by creating an item to modifier group association.", "operationId"=>"GetModifierGroups", "x-api-path-slug"=>"v3merchantsmidmodifier-groups-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [modifiers, items]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, item"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Modifier", "Groups"]}, "post"=>{"summary"=>"Create a modifier group", "description"=>"Create a new modifier group. Modifiers can be associated with a modifier group after it has been created.", "operationId"=>"CreateModifierGroup", "x-api-path-slug"=>"v3merchantsmidmodifier-groups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [modifiers, items]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Modifier", "Groups"]}}, "/v3/merchants/{mId}/modifier_groups/{modGroupId}"=>{"get"=>{"summary"=>"Get a modifier group", "description"=>"Get a single modifier group by it's UUID", "operationId"=>"GetModifierGroup", "x-api-path-slug"=>"v3merchantsmidmodifier-groupsmodgroupid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [modifiers, items]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"modGroupId", "description"=>"Modifier Group Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Modifier", "Groups", "ModGroupId"]}, "post"=>{"summary"=>"Update a modifier group", "description"=>"Update a modifier group. In order to add modifiers use the create modifiers endpoint.", "operationId"=>"UpdateModifierGroup", "x-api-path-slug"=>"v3merchantsmidmodifier-groupsmodgroupid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [modifiers, items]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"modGroupId", "description"=>"Modifier Group Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Modifier", "Groups", "ModGroupId"]}, "delete"=>{"summary"=>"Delete a modifier group", "description"=>"Delete an existing modifier group, identified by UUID. This also deletes all modifiers within that group.", "operationId"=>"DeleteModifierGroup", "x-api-path-slug"=>"v3merchantsmidmodifier-groupsmodgroupid-delete", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"modGroupId", "description"=>"Modifier Group Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Modifier", "Groups", "ModGroupId"]}}, "/v3/merchants/{mId}/item_modifier_groups"=>{"post"=>{"summary"=>"Create or delete item to modifier group associations", "description"=>"Create or delete one or more association objects (item modifier groups). Modifiers can only be applied to items associated with that modifier's group. Learn more about object associations here: https://docs.clover.com/build/web-api/#object-associations", "operationId"=>"CreateOrDeleteItemModifierGroups", "x-api-path-slug"=>"v3merchantsmiditem-modifier-groups-post", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Item", "Modifier", "Groups"]}}, "/v3/merchants/{mId}/modifier_group_sort_orders"=>{"post"=>{"summary"=>"Update the priorities for a collection of up to 200 modifier groups at a time", "description"=>"Update the priorities for a collection of up to 200 modifier groups at a time.", "operationId"=>"UpdateModifierGroupSortOrders", "x-api-path-slug"=>"v3merchantsmidmodifier-group-sort-orders-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Modifier", "Group", "Sort", "Orders"]}}, "/v3/merchants/{mId}/payments"=>{"get"=>{"summary"=>"Get all payments", "description"=>"Retrieve payment information including total amount, tipAmount, taxAmount, and result status.To POST a payment see: https://docs.clover.com/build/developer-pay-api/", "operationId"=>"GetPayments", "x-api-path-slug"=>"v3merchantsmidpayments-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [tender, taxRates, germanInfo, lineItemPayments, cardTransaction, dccInfo, appTracking, refunds, order, transactionInfo]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, voidReason, cardTransaction"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Payments"]}}, "/v3/merchants/{mId}/modifiers"=>{"get"=>{"summary"=>"Get all modifiers", "description"=>"Get all modifiers regardless of their modifier group.", "operationId"=>"GetModifiers", "x-api-path-slug"=>"v3merchantsmidmodifiers-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [modifierGroup]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, price, name, alternateName, id, modifierGroup"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Modifiers"]}}, "/v3/merchants/{mId}/payments/{payId}"=>{"get"=>{"summary"=>"Get a single payment", "description"=>"Get a single payment.", "operationId"=>"GetPayment", "x-api-path-slug"=>"v3merchantsmidpaymentspayid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [cardTransaction, dccInfo, germanInfo, appTracking, taxRates, lineItemPayments, refunds, order, tender, employee, transactionInfo]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"payId", "description"=>"Payment Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Payments", "PayId"]}, "post"=>{"summary"=>"", "description"=>".", "operationId"=>"UpdatePayment", "x-api-path-slug"=>"v3merchantsmidpaymentspayid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"payId", "description"=>"Payment Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Payments", "PayId"]}}, "/v3/merchants/{mId}/modifier_groups/{modGroupId}/modifiers"=>{"get"=>{"summary"=>"Get all modifiers belonging to a single modifier group", "description"=>"Get an array containing the modifiers in a single modifier group.", "operationId"=>"GetModifiersByGroup", "x-api-path-slug"=>"v3merchantsmidmodifier-groupsmodgroupidmodifiers-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [modifiers, items]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, price, name, alternateName, id, modifierGroup"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"modGroupId", "description"=>"Modifier Group Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Modifier", "Groups", "ModGroupId", "Modifiers"]}, "post"=>{"summary"=>"Create a modifier", "description"=>"Create a modifier object belonging to the modifier group identified in the URL.", "operationId"=>"CreateModifier", "x-api-path-slug"=>"v3merchantsmidmodifier-groupsmodgroupidmodifiers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [modifierGroup]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"modGroupId", "description"=>"Modifier Group Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Modifier", "Groups", "ModGroupId", "Modifiers"]}}, "/v3/merchants/{mId}/modifier_groups/{modGroupId}/modifiers/{modId}"=>{"get"=>{"summary"=>"Get a single modifier", "description"=>"Get a single modifier by it's group, and it's UUID", "operationId"=>"GetModifier", "x-api-path-slug"=>"v3merchantsmidmodifier-groupsmodgroupidmodifiersmodid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [modifierGroup]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"modGroupId", "description"=>"Modifier Group Id"}, {"in"=>"path", "name"=>"modId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Modifier", "Groups", "ModGroupId", "Modifiers", "ModId"]}, "post"=>{"summary"=>"Update a single modifier", "description"=>"Update a modifier. Note that once it has been created, it is not possible to change a modifier's group.", "operationId"=>"UpdateModifier", "x-api-path-slug"=>"v3merchantsmidmodifier-groupsmodgroupidmodifiersmodid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [modifierGroup]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"modGroupId", "description"=>"Modifier Group Id"}, {"in"=>"path", "name"=>"modId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Modifier", "Groups", "ModGroupId", "Modifiers", "ModId"]}, "delete"=>{"summary"=>"Delete a single modifier", "description"=>"Delete a single modifier by it's UUID", "operationId"=>"DeleteModifier", "x-api-path-slug"=>"v3merchantsmidmodifier-groupsmodgroupidmodifiersmodid-delete", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"modGroupId", "description"=>"Modifier Group Id"}, {"in"=>"path", "name"=>"modId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Modifier", "Groups", "ModGroupId", "Modifiers", "ModId"]}}, "/v3/merchants/{mId}/employees/{empId}/payments"=>{"get"=>{"summary"=>"Get all payments under an employee", "description"=>"Get all payments under an employee.", "operationId"=>"GetEmployeePayments", "x-api-path-slug"=>"v3merchantsmidemployeesempidpayments-get", "parameters"=>[{"in"=>"path", "name"=>"empId", "description"=>"Employee Id"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [cardTransaction, dccInfo, germanInfo, appTracking, taxRates, lineItemPayments, refunds, order, tender, employee, transactionInfo]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, voidReason, cardTransaction"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employees", "EmpId", "Payments"]}}, "/v3/merchants/{mId}/refunds"=>{"get"=>{"summary"=>"Get all refunds for a merchant", "description"=>"Get all refunds for a merchant.", "operationId"=>"GetRefunds", "x-api-path-slug"=>"v3merchantsmidrefunds-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [payment, germanInfo, appTracking, employee, overrideMerchantTender, serviceCharge, lineItems]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Refunds"]}}, "/v3/merchants/{mId}/refunds/{refundId}"=>{"get"=>{"summary"=>"Get a single refund", "description"=>"Get a single refund.", "operationId"=>"GetRefund", "x-api-path-slug"=>"v3merchantsmidrefundsrefundid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [payment, germanInfo, appTracking, employee, overrideMerchantTender, serviceCharge, lineItems]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"refundId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Refunds", "RefundId"]}}, "/v3/merchants/{mId}/credits"=>{"get"=>{"summary"=>"Get a list of credits", "description"=>"Get a list of credits.", "operationId"=>"GetCredits", "x-api-path-slug"=>"v3merchantsmidcredits-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [dccInfo, germanInfo, appTracking, tender, employee, cardTransaction, order, taxRates]"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [device"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Credits"]}}, "/v3/merchants/{mId}/attributes"=>{"get"=>{"summary"=>"Get all attributes", "description"=>"See the description for 'get all item groups'.", "operationId"=>"GetAttributes", "x-api-path-slug"=>"v3merchantsmidattributes-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, name, id, deletedTime, itemGroup"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Attributes"]}, "post"=>{"summary"=>"Create an attribute", "description"=>"Create an attribute.", "operationId"=>"CreateAttribute", "x-api-path-slug"=>"v3merchantsmidattributes-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [options]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Attributes"]}}, "/v3/merchants/{mId}/credits/{cId}"=>{"get"=>{"summary"=>"Get a single credit", "description"=>"Get a single credit.", "operationId"=>"GetCredit", "x-api-path-slug"=>"v3merchantsmidcreditscid-get", "parameters"=>[{"in"=>"path", "name"=>"cId"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [dccInfo, germanInfo, appTracking, tender, employee, cardTransaction, order, taxRates]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Credits", "CId"]}}, "/v3/merchants/{mId}/credit_refunds"=>{"get"=>{"summary"=>"Get a list of credit refunds", "description"=>"Get a list of credit refunds.", "operationId"=>"GetCreditRefunds", "x-api-path-slug"=>"v3merchantsmidcredit-refunds-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [credit, germanInfo, appTracking]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Credit", "Refunds"]}}, "/v3/merchants/{mId}/attributes/{attributeId}"=>{"get"=>{"summary"=>"Get a single attribute", "description"=>"Get a single attribute.", "operationId"=>"GetAttribute", "x-api-path-slug"=>"v3merchantsmidattributesattributeid-get", "parameters"=>[{"in"=>"path", "name"=>"attributeId", "description"=>"Attribute Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Attributes", "AttributeId"]}, "post"=>{"summary"=>"Update a single attribute", "description"=>"Update a single attribute.", "operationId"=>"UpdateAttribute", "x-api-path-slug"=>"v3merchantsmidattributesattributeid-post", "parameters"=>[{"in"=>"path", "name"=>"attributeId", "description"=>"Attribute Id"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [options]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Attributes", "AttributeId"]}, "delete"=>{"summary"=>"Delete a single attribute", "description"=>"Delete a single attribute.", "operationId"=>"DeleteAttribute", "x-api-path-slug"=>"v3merchantsmidattributesattributeid-delete", "parameters"=>[{"in"=>"path", "name"=>"attributeId", "description"=>"Attribute Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Attributes", "AttributeId"]}}, "/v3/merchants/{mId}/credit_refunds/{crId}"=>{"get"=>{"summary"=>"Get a credit refund", "description"=>"Get a credit refund.", "operationId"=>"GetCreditRefund", "x-api-path-slug"=>"v3merchantsmidcredit-refundscrid-get", "parameters"=>[{"in"=>"path", "name"=>"crId"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: [credit, germanInfo, appTracking]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Credit", "Refunds", "CrId"]}}, "/v3/merchants/{mId}/employee_cards"=>{"post"=>{"summary"=>"Add employee cards", "description"=>".Add employee cards", "operationId"=>"CreateOrUpdateEmployeeCard", "x-api-path-slug"=>"v3merchantsmidemployee-cards-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employee", "Cards"]}, "get"=>{"summary"=>"Get employee cards", "description"=>".Get employee cards", "operationId"=>"GetEmployeeCards", "x-api-path-slug"=>"v3merchantsmidemployee-cards-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [id, employee"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employee", "Cards"]}}, "/v3/merchants/{mId}/options"=>{"get"=>{"summary"=>"Get all options", "description"=>"See the description for 'get all item groups'.", "operationId"=>"GetOptions", "x-api-path-slug"=>"v3merchantsmidoptions-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: []"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, item"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Options"]}}, "/v3/merchants/{mId}/employee_cards/{employeeCardId}"=>{"get"=>{"summary"=>"Get employee card", "description"=>".Get employee card", "operationId"=>"GetEmployeeCard", "x-api-path-slug"=>"v3merchantsmidemployee-cardsemployeecardid-get", "parameters"=>[{"in"=>"path", "name"=>"employeeCardId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employee", "Cards", "EmployeeCardId"]}, "delete"=>{"summary"=>"Delete employee cards", "description"=>".Delete employee cards", "operationId"=>"DeleteEmployeeCard", "x-api-path-slug"=>"v3merchantsmidemployee-cardsemployeecardid-delete", "parameters"=>[{"in"=>"path", "name"=>"employeeCardId"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Employee", "Cards", "EmployeeCardId"]}}, "/v3/merchants/{mId}/attributes/{attributeId}/options"=>{"get"=>{"summary"=>"Get all options with a given attribute", "description"=>"Get all options with a given attribute.", "operationId"=>"GetOptionsByAttribute", "x-api-path-slug"=>"v3merchantsmidattributesattributeidoptions-get", "parameters"=>[{"in"=>"path", "name"=>"attributeId", "description"=>"Attribute Id"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: []"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, item"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Attributes", "AttributeId", "Options"]}, "post"=>{"summary"=>"Create an option", "description"=>"Create an option.", "operationId"=>"CreateOption", "x-api-path-slug"=>"v3merchantsmidattributesattributeidoptions-post", "parameters"=>[{"in"=>"path", "name"=>"attributeId", "description"=>"Attribute Id"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: []"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Attributes", "AttributeId", "Options"]}}, "/v3/merchants/{mId}/orders/{orderId}/service_charge/"=>{"post"=>{"summary"=>"", "description"=>".", "operationId"=>"ApplyServiceCharge", "x-api-path-slug"=>"v3merchantsmidordersorderidservice-charge-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Service", "Charge"]}}, "/v3/merchants/{mId}/attributes/{attributeId}/options/{optionId}"=>{"get"=>{"summary"=>"Get all options with a given attribute", "description"=>"Get all options with a given attribute.", "operationId"=>"GetOptionsByAttribute", "x-api-path-slug"=>"v3merchantsmidattributesattributeidoptionsoptionid-get", "parameters"=>[{"in"=>"path", "name"=>"attributeId", "description"=>"Attribute Id"}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: []"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [modifiedTime, item"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"optionId", "description"=>"Option Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Attributes", "AttributeId", "Options", "OptionId"]}, "post"=>{"summary"=>"Update an option", "description"=>"Update an option.", "operationId"=>"UpdateOption", "x-api-path-slug"=>"v3merchantsmidattributesattributeidoptionsoptionid-post", "parameters"=>[{"in"=>"path", "name"=>"attributeId", "description"=>"Attribute Id"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"expand", "description"=>"Expandable fields: []"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"optionId", "description"=>"Option Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Attributes", "AttributeId", "Options", "OptionId"]}, "delete"=>{"summary"=>"Delete an option", "description"=>"Delete an option.", "operationId"=>"DeleteOption", "x-api-path-slug"=>"v3merchantsmidattributesattributeidoptionsoptionid-delete", "parameters"=>[{"in"=>"path", "name"=>"attributeId", "description"=>"Attribute Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"optionId", "description"=>"Option Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Attributes", "AttributeId", "Options", "OptionId"]}}, "/v3/merchants/{mId}/orders/{orderId}/service_charge/{chargeId}"=>{"delete"=>{"summary"=>"Remove service charge from an order", "description"=>"Remove service charge from an order.", "operationId"=>"RemoveServiceCharge", "x-api-path-slug"=>"v3merchantsmidordersorderidservice-chargechargeid-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"chargeId", "description"=>"Service Charge Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Service", "Charge", "ChargeId"]}}, "/v3/merchants/{mId}/orders/{orderId}/voided_line_items"=>{"post"=>{"summary"=>"Void a line item", "description"=>"Void a line item.", "operationId"=>"VoidOrderLineItem", "x-api-path-slug"=>"v3merchantsmidordersorderidvoided-line-items-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Voided", "Line", "Items"]}}, "/v3/merchants/{mId}/voided_line_items"=>{"get"=>{"summary"=>"Get order line items that were recorded after a void", "description"=>"Get order line items that were recorded after a void.", "operationId"=>"GetVoidedOrderLineItems", "x-api-path-slug"=>"v3merchantsmidvoided-line-items-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [reason, id, name, price, quantity, printed, deletedTime, merchantId, orderId, removedById]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Voided", "Line", "Items"]}}, "/v3/merchants/{mId}/orders/{orderId}/line_items/{oldLineItemId}/exchange/{lineItemId}"=>{"post"=>{"summary"=>"Create or exchange a line item", "description"=>"Create or exchange a line item.", "operationId"=>"SetOrderLineItem", "x-api-path-slug"=>"v3merchantsmidordersorderidline-itemsoldlineitemidexchangelineitemid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"lineItemId", "description"=>"Line Item Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}, {"in"=>"path", "name"=>"oldLineItemId", "description"=>"Old Line Item Id"}, {"in"=>"path", "name"=>"orderId", "description"=>"Order Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Orders", "OrderId", "Line", "Items", "OldLineItemId", "Exchange", "LineItemId"]}}, "/v3/merchants/{mId}/option_items"=>{"post"=>{"summary"=>"Create or delete item/option association", "description"=>"See the description for 'get all item groups'.", "operationId"=>"CreateOrDeleteOptionItems", "x-api-path-slug"=>"v3merchantsmidoption-items-post", "parameters"=>[{"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Option", "Items"]}}, "/v3/merchants/{mId}/discounts"=>{"get"=>{"summary"=>"Get all discounts", "description"=>"Get all discounts.", "operationId"=>"GetDiscounts", "x-api-path-slug"=>"v3merchantsmiddiscounts-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter fields: [id, amount, percentage, modifiedtime]"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Discounts"]}, "post"=>{"summary"=>"Create an discount", "description"=>"Create an discount.", "operationId"=>"CreateDiscount", "x-api-path-slug"=>"v3merchantsmiddiscounts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Discounts"]}}, "/v3/merchants/{mId}/discounts/{discountId}"=>{"get"=>{"summary"=>"Get a single discount", "description"=>"Get a single discount.", "operationId"=>"GetDiscount", "x-api-path-slug"=>"v3merchantsmiddiscountsdiscountid-get", "parameters"=>[{"in"=>"path", "name"=>"discountId", "description"=>"Discount Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Discounts", "DiscountId"]}, "post"=>{"summary"=>"Update an discount", "description"=>"Update an discount.", "operationId"=>"UpdateDiscount", "x-api-path-slug"=>"v3merchantsmiddiscountsdiscountid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"discountId", "description"=>"Discount Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Discounts", "DiscountId"]}, "delete"=>{"summary"=>"Delete a discount", "description"=>"Delete a discount.", "operationId"=>"DeleteDiscount", "x-api-path-slug"=>"v3merchantsmiddiscountsdiscountid-delete", "parameters"=>[{"in"=>"path", "name"=>"discountId", "description"=>"Discount Id"}, {"in"=>"path", "name"=>"mId", "description"=>"Merchant Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchants", "Discounts", "DiscountId"]}}}}, "apis"=>{"name"=>"Clover", "x-slug"=>"clover", "description"=>"0316861 Clover is a cloud-based Android point of sale platform that was launched in April 2012.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28757-clover.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"20716", "tags"=>"internet,Mobile,New,Point of Sale,Pos,Relative Data,SaaS,Service API,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"clover/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Clover", "x-api-slug"=>"clover", "description"=>"0316861 Clover is a cloud-based Android point of sale platform that was launched in April 2012.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28757-clover.jpg", "humanURL"=>"https://docs.clover.com", "baseURL"=>"https:///merchants/https://api.clover.com", "tags"=>"internet,Mobile,New,Point of Sale,Pos,Relative Data,SaaS,Service API,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/clover/clover-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/clover"}, {"type"=>"x-developer", "url"=>"https://www.clover.com/developers"}, {"type"=>"x-documentation", "url"=>"https://docs.clover.com/"}, {"type"=>"x-github", "url"=>"https://github.com/clover"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/CloverPOS"}, {"type"=>"x-webhook", "url"=>"https://docs.clover.com/build/webhooks/"}, {"type"=>"x-website", "url"=>"https://docs.clover.com"}, {"type"=>"x-website", "url"=>"https://www.clover.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
newscred{"news-cred-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"NewsCred", "x-complete"=>1, "info"=>{"title"=>"News Cred", "description"=>"returns-a-list-of-articles-according-to-the-specified-set-of-parameters-", "version"=>"v1"}, "host"=>"api.newscred.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/topic/{guid]/articles/"=>{"get"=>{"summary"=>"Topic Articles", "description"=>"Returns a list of articles related to the specified topic.", "operationId"=>"getTopicGu]Articles", "x-api-path-slug"=>"topicguidarticles-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"article_filter_mode", "description"=>"Enables article_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"article_filter_name", "description"=>"Limit items to a predefined list of articles"}, {"in"=>"query", "name"=>"categories", "description"=>"Limit items to the categories specified"}, {"in"=>"query", "name"=>"from_date", "description"=>"Beginning of date range for which items are searched"}, {"in"=>"query", "name"=>"get_topics", "description"=>"Set to true to include associated topics inline with each article"}, {"in"=>"path", "name"=>"guid", "description"=>"The topic guid"}, {"in"=>"query", "name"=>"has_images", "description"=>"Return only articles that have associated images (accessible via article/GUID/images)"}, {"in"=>"query", "name"=>"languages", "description"=>"Limit items to those in the specified language"}, {"in"=>"query", "name"=>"licensed", "description"=>"Search exclusively for fully licensed, full text content"}, {"in"=>"query", "name"=>"media_types", "description"=>"Limit the media type of the returned items"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of items to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort order for returned items"}, {"in"=>"query", "name"=>"sources", "description"=>"List of sources to retrieve items from"}, {"in"=>"query", "name"=>"source_countries", "description"=>"Search against only sources from the specified countries"}, {"in"=>"query", "name"=>"source_filter_mode", "description"=>"Enables source_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"source_filter_name", "description"=>"Limit items to a predefined list of sources"}, {"in"=>"query", "name"=>"to_date", "description"=>"End of date range for which items are searched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Topic", "Articles"]}}, "articles/"=>{"get"=>{"summary"=>"Articles", "description"=>"Returns a list of articles according to the specified set of parameters.", "operationId"=>"getArticles", "x-api-path-slug"=>"articles-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"article_filter_mode", "description"=>"Enables article_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"article_filter_name", "description"=>"Limit items to a predefined list of articles"}, {"in"=>"query", "name"=>"boolean_operator", "description"=>"Indicates the boolean operation to use on search keywords that do not have explicit whitelist (+) or blacklist (-) operators on them"}, {"in"=>"query", "name"=>"categories", "description"=>"Limit items to the categories specified"}, {"in"=>"query", "name"=>"exact", "description"=>"If this parameter is not specified, then stemming is applied, so that for example the query term ship matches articles containing shipping, and vice versa"}, {"in"=>"query", "name"=>"from_date", "description"=>"Beginning of publication date range for which items are searched"}, {"in"=>"query", "name"=>"get_topics", "description"=>"Set to true to include associated topics inline with each article"}, {"in"=>"query", "name"=>"has_images", "description"=>"Sort order for returned items"}, {"in"=>"query", "name"=>"languages", "description"=>"Limit items to those in the specified language"}, {"in"=>"query", "name"=>"licensed", "description"=>"Search exclusively for fully licensed, full text content"}, {"in"=>"query", "name"=>"links", "description"=>"Value is a space delimited list of article links"}, {"in"=>"query", "name"=>"max_length", "description"=>"Returns only articles with at most this many words"}, {"in"=>"query", "name"=>"media_types", "description"=>"Limit the media type of the returned items"}, {"in"=>"query", "name"=>"min_length", "description"=>"Returns only articles with at least this many words"}, {"in"=>"query", "name"=>"mm", "description"=>"Minimum Match: specifies how many of the non whitelist/blacklist keywords must match for an article to be included in the results"}, {"in"=>"query", "name"=>"modified_since", "description"=>"Get only articles that have been modified since the supplied date"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of items to skip before beginning the result set"}, {"in"=>"query", "name"=>"query", "description"=>"Specifies the set of words and phrases to search for"}, {"in"=>"query", "name"=>"query_fields", "description"=>"Specifies which field to search when searching for articles"}, {"in"=>"query", "name"=>"safe_search", "description"=>"Removes articles containing offensive words from search result; when set to true"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort order for returned items"}, {"in"=>"query", "name"=>"sources", "description"=>"Limit items to the sources specified"}, {"in"=>"query", "name"=>"source_countries", "description"=>"Search against only sources from the specified countries"}, {"in"=>"query", "name"=>"source_filter_mode", "description"=>"Enables source_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"source_filter_name", "description"=>"Limit items to a predefined list of sources"}, {"in"=>"query", "name"=>"topics", "description"=>"Value is a space delimited list of topic guids"}, {"in"=>"query", "name"=>"topic_filter_mode", "description"=>"Enables topic_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"topic_filter_name", "description"=>"Limit items to a predefined list of topics"}, {"in"=>"query", "name"=>"to_date", "description"=>"End of publication date range for which items are searched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Articles"]}}, "author/"=>{"get"=>{"summary"=>"Author", "description"=>"Returns an author that has written content available via this API.", "operationId"=>"getAuthor", "x-api-path-slug"=>"author-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Author"]}}, "author/{guid}/articles/"=>{"get"=>{"summary"=>"Author Articles", "description"=>"Returns articles written by the specified author and matching the given query string.", "operationId"=>"getAuthorGuArticles", "x-api-path-slug"=>"authorguidarticles-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"article_filter_mode", "description"=>"Enables article_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"article_filter_name", "description"=>"Limit items to a predefined list of articles"}, {"in"=>"query", "name"=>"categories", "description"=>"Limit items to the categories specified"}, {"in"=>"query", "name"=>"from_date", "description"=>"Beginning of date range for which items are searched"}, {"in"=>"query", "name"=>"get_topics", "description"=>"Set to true to include associated topics inline with each article"}, {"in"=>"path", "name"=>"guid", "description"=>"The guid for the author"}, {"in"=>"query", "name"=>"has_images", "description"=>"Return only articles that have associated images (accessible via article/GUID/images)"}, {"in"=>"query", "name"=>"languages", "description"=>"Limit items to those in the specified language"}, {"in"=>"query", "name"=>"licensed", "description"=>"Search exclusively for fully licensed, full text content"}, {"in"=>"query", "name"=>"media_types", "description"=>"Limit the media type of the returned items"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of items to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort order for returned items"}, {"in"=>"query", "name"=>"sources", "description"=>"List of sources to retrieve items from"}, {"in"=>"query", "name"=>"source_countries", "description"=>"Search against only sources from the specified countries"}, {"in"=>"query", "name"=>"source_filter_mode", "description"=>"Enables source_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"source_filter_name", "description"=>"Limit items to a predefined list of sources"}, {"in"=>"query", "name"=>"topics", "description"=>"List of topics to retrieve items from"}, {"in"=>"query", "name"=>"topic_filter_mode", "description"=>"Enables topic_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"topic_filter_name", "description"=>"Limit items to a predefined list of topics"}, {"in"=>"query", "name"=>"to_date", "description"=>"End of date range for which items are searched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Author", "Articles"]}}, "author/{guid}/topics/"=>{"get"=>{"summary"=>"Author Topics", "description"=>"Gets a list of topics related to an author.", "operationId"=>"getAuthorGuTopics", "x-api-path-slug"=>"authorguidtopics-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"from_date", "description"=>"Beginning of date range for which items are searched"}, {"in"=>"path", "name"=>"guid", "description"=>"The guid for the author"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of items to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"topics", "description"=>"List of topics to retrieve items from"}, {"in"=>"query", "name"=>"topic_classifications", "description"=>"Limit results to those with the specified topic classification"}, {"in"=>"query", "name"=>"topic_filter_mode", "description"=>"Enables topic_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"topic_filter_name", "description"=>"Limit items to a predefined list of topics"}, {"in"=>"query", "name"=>"topic_subclassifications", "description"=>"Limit results to those with the specified topic sub-classification"}, {"in"=>"query", "name"=>"to_date", "description"=>"End of date range for which items are searched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Author", "Topics"]}}, "categories/"=>{"get"=>{"summary"=>"Categories", "description"=>"Search for categories", "operationId"=>"getCategories", "x-api-path-slug"=>"categories-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"autosuggest", "description"=>"If true, partial matches will be returned, i"}, {"in"=>"query", "name"=>"query", "description"=>"The query string to find categories matching"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Categories"]}}, "category/dashed-name/sources/"=>{"get"=>{"summary"=>"Category Sources", "description"=>"Gets a list of sources that write most frequently about the category specified by the dashed name", "operationId"=>"getCategoryDashedNameSources", "x-api-path-slug"=>"categorydashednamesources-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"from_date", "description"=>"Beginning of date range for which items are searched"}, {"in"=>"query", "name"=>"media_types", "description"=>"Space delimited list of media types to retreive articles from"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of items to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"sources", "description"=>"List of sources to retrieve items from"}, {"in"=>"query", "name"=>"source_countries", "description"=>"Search against only sources from the specified countries"}, {"in"=>"query", "name"=>"source_filter_mode", "description"=>"Enables source_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"source_filter_name", "description"=>"Limit items to a predefined list of sources"}, {"in"=>"query", "name"=>"to_date", "description"=>"End of date range for which items are searched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Category", "Dashed-name", "Sources"]}}, "category/dashed-name/topics/"=>{"get"=>{"summary"=>"Category Topics", "description"=>"Gets a list of topics within the category specified by the dashed name.", "operationId"=>"getCategoryDashedNameTopics", "x-api-path-slug"=>"categorydashednametopics-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"from_date", "description"=>"Beginning of date range for which items are searched"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of items to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"topic_classifications", "description"=>"Limit results to those with the specified topic classification"}, {"in"=>"query", "name"=>"topic_filter_mode", "description"=>"Enables topic_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"topic_filter_name", "description"=>"Limit items to a predefined list of topics"}, {"in"=>"query", "name"=>"topic_subclassifications", "description"=>"Limit results to those with the specified topic sub-classification"}, {"in"=>"query", "name"=>"to_date", "description"=>"End of date range for which items are searched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Category", "Dashed-name", "Topics"]}}, "category/{category-name]/stories/"=>{"get"=>{"summary"=>"Category Stories", "description"=>"Find the top news stories related to a given category. A story is a collection of similar articles.", "operationId"=>"getCategoryCategoryName]Stories", "x-api-path-slug"=>"categorycategorynamestories-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"article_filter_mode", "description"=>"Enables article_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"article_filter_name", "description"=>"Limit items to a predefined list of articles"}, {"in"=>"query", "name"=>"cluster_size", "description"=>"Number of articles returned for each story"}, {"in"=>"query", "name"=>"from_date", "description"=>"Beginning of date range for which items are searched"}, {"in"=>"query", "name"=>"get_topics", "description"=>"Set to true to include associated topics inline with each article"}, {"in"=>"query", "name"=>"has_images", "description"=>"Return only articles that have associated images (accessible via article/GUID/images)"}, {"in"=>"query", "name"=>"languages", "description"=>"Limit items to those with the specified language"}, {"in"=>"query", "name"=>"licensed", "description"=>"Search exclusively for fully licensed, full text content"}, {"in"=>"query", "name"=>"media_types", "description"=>"Limit the media type of the returned items"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of items to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"sources", "description"=>"List of sources to retrieve items from"}, {"in"=>"query", "name"=>"source_countries", "description"=>"Search against only sources from the specified countries"}, {"in"=>"query", "name"=>"source_filter_mode", "description"=>"Enables source_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"source_filter_name", "description"=>"Restricts the query to a predefined list of sources"}, {"in"=>"query", "name"=>"to_date", "description"=>"End of date range for which items are searched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Category", "Category-name]", "Stories"]}}, "category/{dashed-name}/articles/"=>{"get"=>{"summary"=>"Category Articles", "description"=>"Search for articles within the category specified by dashed name.", "operationId"=>"getCategoryDashedNameArticles", "x-api-path-slug"=>"categorydashednamearticles-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"article_filter_mode", "description"=>"Enables article_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"article_filter_name", "description"=>"Limit items to a predefined list of articles"}, {"in"=>"query", "name"=>"from_date", "description"=>"Beginning of date range for which items are searched"}, {"in"=>"query", "name"=>"get_topics", "description"=>"Set to true to include associated topics inline with each article"}, {"in"=>"query", "name"=>"has_images", "description"=>"Return only articles that have associated images (accessible via article/GUID/images)"}, {"in"=>"query", "name"=>"languages", "description"=>"Limit items to those with the specified language"}, {"in"=>"query", "name"=>"licensed", "description"=>"Search exclusively for fully licensed, full text content"}, {"in"=>"query", "name"=>"media_types", "description"=>"Limit the media type of the returned items"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of items to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort order for returned items"}, {"in"=>"query", "name"=>"sources", "description"=>"List of sources to retrieve items from"}, {"in"=>"query", "name"=>"source_countries", "description"=>"Search against only sources from the specified countries"}, {"in"=>"query", "name"=>"source_filter_mode", "description"=>"Enables source_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"source_filter_name", "description"=>"Restricts the query to a predefined list of sources"}, {"in"=>"query", "name"=>"to_date", "description"=>"End of date range for which items are searched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Category", "Dashed-name", "Articles"]}}, "category/{dashed-name}/images/"=>{"get"=>{"summary"=>"Category Images", "description"=>"Gets images related to the specified category.", "operationId"=>"getCategoryDashedNameImages", "x-api-path-slug"=>"categorydashednameimages-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"safe_search", "description"=>"Returns only images marked as safe when set to true"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Category", "Dashed-name", "Images"]}}, "image/{guid}/"=>{"get"=>{"summary"=>"Image", "description"=>"Returns the image specified by the given GUID.", "operationId"=>"getImageGu", "x-api-path-slug"=>"imageguid-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"path", "name"=>"guid", "description"=>"The guid for the image"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image"]}}, "images/"=>{"get"=>{"summary"=>"Search Images", "description"=>"Returns images matched by the query string", "operationId"=>"getImages", "x-api-path-slug"=>"images-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"from_date", "description"=>"Beginning of date range for which items are searched"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of items to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"query", "description"=>"Query string you want to search for"}, {"in"=>"query", "name"=>"to_date", "description"=>"End of date range for which items are searched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images"]}}, "source/"=>{"get"=>{"summary"=>"Source", "description"=>"Returns the source represented by the specified GUID.", "operationId"=>"getSource", "x-api-path-slug"=>"source-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"path", "name"=>"GUID", "description"=>"GUID representing news source"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source"]}}, "source/{GUID}/articles/"=>{"get"=>{"summary"=>"Source Articles", "description"=>"Returns a list of articles provided by the specified source", "operationId"=>"getSourceGuArticles", "x-api-path-slug"=>"sourceguidarticles-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"article_filter_mode", "description"=>"Enables article_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"article_filter_name", "description"=>"Limit items to a predefined list of articles"}, {"in"=>"query", "name"=>"categories", "description"=>"Limit items to the categories specified"}, {"in"=>"query", "name"=>"from_date", "description"=>"Beginning of date range for which items are searched"}, {"in"=>"query", "name"=>"get_topics", "description"=>"Set to true to include associated topics inline with each article"}, {"in"=>"query", "name"=>"has_images", "description"=>"Return only articles that have associated images (accessible via article/GUID/images)"}, {"in"=>"query", "name"=>"languages", "description"=>"Limit items to those in the specified language"}, {"in"=>"query", "name"=>"licensed", "description"=>"Search exclusively for fully licensed, full text content"}, {"in"=>"query", "name"=>"media_types", "description"=>"Limit the media type of the returned items"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of items to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort order for returned items"}, {"in"=>"query", "name"=>"topics", "description"=>"List of topics to retrieve items from"}, {"in"=>"query", "name"=>"topic_filter_mode", "description"=>"Enables topic_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"topic_filter_name", "description"=>"Limit items to a predefined list of topics"}, {"in"=>"query", "name"=>"to_date", "description"=>"End of date range for which items are searched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Source", "GUID", "Articles"]}}, "source/{GUID}/topics/"=>{"get"=>{"summary"=>"Source Topics", "description"=>"Returns a list of topics related to the source specified by the given GUID.", "operationId"=>"getSourceGuTopics", "x-api-path-slug"=>"sourceguidtopics-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"from_date", "description"=>"Beginning of date range for which items are searched"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of items to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"topics", "description"=>"List of topics to retrieve items from"}, {"in"=>"query", "name"=>"topic_classifications", "description"=>"Limit results to those with the specified topic classification"}, {"in"=>"query", "name"=>"topic_filter_mode", "description"=>"Enables topic_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"topic_filter_name", "description"=>"Limit items to a predefined list of topics"}, {"in"=>"query", "name"=>"topic_subclassifications", "description"=>"Limit results to those with the specified topic sub-classification"}, {"in"=>"query", "name"=>"to_date", "description"=>"End of date range for which items are searched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Source", "GUID", "Topics"]}}, "sources/"=>{"get"=>{"summary"=>"Sources", "description"=>"Search sources by name. Returns a list of sources objects", "operationId"=>"getSources", "x-api-path-slug"=>"sources-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"autosuggest", "description"=>"If true, partial matches will be returned starting from 3 characters, i"}, {"in"=>"query", "name"=>"licensed", "description"=>"If true, return only licensed sources with fully licensed content"}, {"in"=>"query", "name"=>"media_types", "description"=>"Limit the media type of the returned items"}, {"in"=>"query", "name"=>"query", "description"=>"Query string to search on"}, {"in"=>"query", "name"=>"sources", "description"=>"List of sources to retrieve items from"}, {"in"=>"query", "name"=>"source_countries", "description"=>"Search against only sources from the specified countries"}, {"in"=>"query", "name"=>"source_filter_mode", "description"=>"Enables source_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"source_filter_name", "description"=>"Limit items to a predefined list of sources"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Sources"]}}, "stories/"=>{"get"=>{"summary"=>"Stories", "description"=>"Returns the top stories related to the specified query. A story is a group of similar articles. By default, stories are sorted by a combination of recency and importance. If the from_date and/or to_date parameters are specified, stories are sorted by importance only.", "operationId"=>"getStories", "x-api-path-slug"=>"stories-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"article_filter_mode", "description"=>"Enables article_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"article_filter_name", "description"=>"Limit items to a predefined list of articles"}, {"in"=>"query", "name"=>"boolean_operator", "description"=>"Indicates the boolean operation to use on search keywords that do not have explicit whitelist (+) or blacklist (-) operators on them"}, {"in"=>"query", "name"=>"categories", "description"=>"Limit items to the categories specified"}, {"in"=>"query", "name"=>"cluster_size", "description"=>"Number of articles returned for each story"}, {"in"=>"query", "name"=>"exact", "description"=>"If this parameter is not specified, then stemming is applied, so that for example the query term ship matches articles containing shipping, and vice versa"}, {"in"=>"query", "name"=>"from_date", "description"=>"Beginning of publication date range for which items are searched"}, {"in"=>"query", "name"=>"get_topics", "description"=>"Set to true to include associated topics inline with each article"}, {"in"=>"query", "name"=>"has_images", "description"=>"Sort order for returned items"}, {"in"=>"query", "name"=>"languages", "description"=>"Limit items to those in the specified language"}, {"in"=>"query", "name"=>"licensed", "description"=>"Search exclusively for fully licensed, full text content"}, {"in"=>"query", "name"=>"links", "description"=>"Value is a space delimited list of article links"}, {"in"=>"query", "name"=>"max_length", "description"=>"Returns only articles with at most this many words"}, {"in"=>"query", "name"=>"media_types", "description"=>"Limit the media type of the returned items"}, {"in"=>"query", "name"=>"min_length", "description"=>"Returns only articles with at least this many words"}, {"in"=>"query", "name"=>"mm", "description"=>"Minimum Match: specifies how many of the non whitelist/blacklist keywords must match for an article to be included in the results"}, {"in"=>"query", "name"=>"modified_since", "description"=>"Get only articles that have been modified since the supplied date"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of items to skip before beginning the result set"}, {"in"=>"query", "name"=>"query", "description"=>"Specifies the set of words and phrases to search for"}, {"in"=>"query", "name"=>"query_fields", "description"=>"Specifies which field to search when searching for articles"}, {"in"=>"query", "name"=>"safe_search", "description"=>"Removes articles containing offensive words from search result; when set to true"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort order for returned items"}, {"in"=>"query", "name"=>"sources", "description"=>"Limit items to the sources specified"}, {"in"=>"query", "name"=>"source_countries", "description"=>"Search against only sources from the specified countries"}, {"in"=>"query", "name"=>"source_filter_mode", "description"=>"Enables source_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"source_filter_name", "description"=>"Limit items to a predefined list of sources"}, {"in"=>"query", "name"=>"topics", "description"=>"Value is a space delimited list of topic guids"}, {"in"=>"query", "name"=>"topic_filter_mode", "description"=>"Enables topic_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"topic_filter_name", "description"=>"Limit items to a predefined list of topics"}, {"in"=>"query", "name"=>"to_date", "description"=>"End of publication date range for which items are searched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Stories"]}}, "topic/{guide{/images/"=>{"get"=>{"summary"=>"Topic Images", "description"=>"Returns images related to the specified topic.", "operationId"=>"getTopicGueImages", "x-api-path-slug"=>"topicguideimages-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"path", "name"=>"guid", "description"=>"The topic guid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Topice", "Images"]}}, "topic/{guid}/"=>{"get"=>{"summary"=>"Topic", "description"=>"Return the topic specified by the given GUID.", "operationId"=>"getTopicGu", "x-api-path-slug"=>"topicguid-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Topic"]}}, "topic/{guid}/sources/"=>{"get"=>{"summary"=>"Topic Sources", "description"=>"The guid for the topic.", "operationId"=>"getTopicGuSources", "x-api-path-slug"=>"topicguidsources-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"from_date", "description"=>"Beginning of date range for which items are searched"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of items to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"sources", "description"=>"List of sources to retrieve items from"}, {"in"=>"query", "name"=>"source_countries", "description"=>"Search against only sources from the specified countries"}, {"in"=>"query", "name"=>"source_filter_mode", "description"=>"Enables source_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"source_filter_name", "description"=>"Limit items to a predefined list of sources"}, {"in"=>"path", "name"=>"Topic Sources", "description"=>"The guid for the topic"}, {"in"=>"query", "name"=>"to_date", "description"=>"End of date range for which items are searched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Topic", "Sources"]}}, "topic/{guid}/topics/"=>{"get"=>{"summary"=>"Related Topics", "description"=>"Returns a list of topics related to the topic specified.", "operationId"=>"getTopicGuTopics", "x-api-path-slug"=>"topicguidtopics-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"from_date", "description"=>"Beginning of date range for which items are searched"}, {"in"=>"query", "name"=>"guid", "description"=>"The guid for the topic"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of items to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"topics", "description"=>"List of topics to retrieve items from"}, {"in"=>"query", "name"=>"topic_classifications", "description"=>"Limit results to those with the specified topic classification"}, {"in"=>"query", "name"=>"topic_filter_mode", "description"=>"Enables topic_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"topic_filter_name", "description"=>"Limit items to a predefined list of topics"}, {"in"=>"query", "name"=>"topic_subclassifications", "description"=>"Limit results to those with the specified topic sub-classification"}, {"in"=>"query", "name"=>"to_date", "description"=>"End of date range for which items are searched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Topic", "Topics"]}}, "topic/{guid}/tweets/"=>{"get"=>{"summary"=>"Related Tweets", "description"=>"Returns a list of real-time tweets related to the specified topic.", "operationId"=>"getTopicGuTweets", "x-api-path-slug"=>"topicguidtweets-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"path", "name"=>"guid", "description"=>"The guid for the topic"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of tweets to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of tweets to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Topic", "Tweets"]}}, "topic/{guid}/videos/"=>{"get"=>{"summary"=>"Topic Videos", "description"=>"Returns a list of videos related to the specified topic.", "operationId"=>"getTopicGuVeos", "x-api-path-slug"=>"topicguidvideos-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"categories", "description"=>"Limit videos to the categories specified"}, {"in"=>"path", "name"=>"guid", "description"=>"The guid for the topic"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of videos to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of videos to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Topic", "Videos"]}}, "topic/{topic_guid}/stories/"=>{"get"=>{"summary"=>"Topic Stories", "description"=>"Find the top stories that are happening for a given topic. A story is a collection of similar articles.", "operationId"=>"getTopicTopicGuStories", "x-api-path-slug"=>"topictopic-guidstories-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"article_filter_mode", "description"=>"Enables article_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"article_filter_name", "description"=>"Limit items to a predefined list of articles"}, {"in"=>"query", "name"=>"categories", "description"=>"Limit items to the categories specified"}, {"in"=>"query", "name"=>"cluster_size", "description"=>"Number of articles returned for each story"}, {"in"=>"query", "name"=>"from_date", "description"=>"Beginning of date range for which items are searched"}, {"in"=>"query", "name"=>"get_topics", "description"=>"Set to true to include associated topics inline with each article"}, {"in"=>"query", "name"=>"has_images", "description"=>"Return only articles that have associated images (accessible via article/GUID/images)"}, {"in"=>"query", "name"=>"languages", "description"=>"Limit items to those in the specified language"}, {"in"=>"query", "name"=>"licensed", "description"=>"Search exclusively for fully licensed, full text content"}, {"in"=>"query", "name"=>"media_types", "description"=>"Limit the media type of the returned items"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of items to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"sources", "description"=>"List of sources to retrieve items from"}, {"in"=>"query", "name"=>"source_countries", "description"=>"Search against only sources from the specified countries"}, {"in"=>"query", "name"=>"source_filter_mode", "description"=>"Enables source_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"source_filter_name", "description"=>"Limit items to a predefined list of sources"}, {"in"=>"path", "name"=>"topic_guid", "description"=>"The topic guid"}, {"in"=>"query", "name"=>"to_date", "description"=>"End of date range for which items are searched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Topic", "Topic", "Stories"]}}, "topics/"=>{"get"=>{"summary"=>"Search Topics", "description"=>"Search for a specific topics.", "operationId"=>"getTopics", "x-api-path-slug"=>"topics-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"exact", "description"=>"If true, the topic name must match the query exactly"}, {"in"=>"query", "name"=>"query", "description"=>"The query string to find topics for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Topics"]}}, "topics/extract/"=>{"get"=>{"summary"=>"Extract Related Topics", "description"=>"Returns a list of topics extracted from the input query.", "operationId"=>"getTopicsExtract", "x-api-path-slug"=>"topicsextract-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"query", "description"=>"The string to extract topics from"}, {"in"=>"query", "name"=>"topics", "description"=>"List of topics to retrieve items from"}, {"in"=>"query", "name"=>"topic_classifications", "description"=>"Limit results to those with the specified topic classification"}, {"in"=>"query", "name"=>"topic_filter_mode", "description"=>"Enables topic_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"topic_filter_name", "description"=>"Limit items to a predefined list of topics"}, {"in"=>"query", "name"=>"topic_subclassifications", "description"=>"Limit results to those with the specified topic sub-classification"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Topics", "Extract"]}}, "topics/related/"=>{"get"=>{"summary"=>"Related Topics", "description"=>"Given some search criteria, returns a list of topics related to those criteria.", "operationId"=>"getTopicsRelated", "x-api-path-slug"=>"topicsrelated-get", "parameters"=>[{"in"=>"query", "name"=>"access_key", "description"=>"Unique API access key"}, {"in"=>"query", "name"=>"from_date, to_date", "description"=>"Find topics that were trending (written about more than usual) during the specified date range"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of topics to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of topics to return"}, {"in"=>"query", "name"=>"query", "description"=>"Find topics related to these keywords"}, {"in"=>"query", "name"=>"topics", "description"=>"List of topics to retrieve items from"}, {"in"=>"query", "name"=>"topic_classifications", "description"=>"Limit results to those with the specified topic classification"}, {"in"=>"query", "name"=>"topic_filter_mode", "description"=>"Enables topic_filter_name and indicates filtering type"}, {"in"=>"query", "name"=>"topic_filter_name", "description"=>"Limit items to a predefined list of topics"}, {"in"=>"query", "name"=>"topic_subclassifications", "description"=>"Limit results to those with the specified topic sub-classification"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Topics", "Related"]}}, "videos/"=>{"get"=>{"summary"=>"Videos", "description"=>"Returns videos matching the given query string", "operationId"=>"getVeos", "x-api-path-slug"=>"videos-get", "parameters"=>[{"in"=>"query", "name"=>"from_date", "description"=>"Beginning of date range for which items are searched"}, {"in"=>"query", "name"=>"licensed", "description"=>"Return only licensed videos"}, {"in"=>"query", "name"=>"maxduration", "description"=>"Maximum duration for searched videos (in milliseconds)"}, {"in"=>"query", "name"=>"minduration", "description"=>"Minimum duration for searched videos (in milliseconds)"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of items to skip before beginning the result set"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"query", "description"=>"Query that you want to search on"}, {"in"=>"query", "name"=>"to_date", "description"=>"End of date range for which items are searched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Videos"]}}}}, "apis"=>{"name"=>"NewsCred", "x-slug"=>"newscred", "description"=>"NewsCred is the leading enterprise content marketing company. NewsCred delivers content marketing solutions that drive business results for top brands", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/869-newscred.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"91598", "tags"=>"API LIfeyclessss,API Provider,Articles,Enterprise,General Data,News,News,News API,News syndication service,Profiles,SaaS,Service API,Syndication,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"newscred/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"News Cred", "x-api-slug"=>"news-cred", "description"=>"NewsCred is the leading enterprise content marketing company. NewsCred delivers content marketing solutions that drive business results for top brands", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/869-newscred.jpg", "humanURL"=>"http://newscred.com", "baseURL"=>"https://api.newscred.com//", "tags"=>"API LIfeyclessss,API Provider,Articles,Enterprise,General Data,News,News,News API,News syndication service,Profiles,SaaS,Service API,Syndication,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/newscred/videos-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/newscred/news-cred-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api.newscred.com"}, {"type"=>"x-blog", "url"=>"http://blog.newscred.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.newscred.com/feed/rss/"}, {"type"=>"x-case-studies", "url"=>"http://www.newscred.com/casestudies"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/newscred"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/newscred"}, {"type"=>"x-developer", "url"=>"http://www.newscred.com/developer/docs"}, {"type"=>"x-drupal-plugin", "url"=>"http://www.newscred.com/developer/drupal_integration"}, {"type"=>"x-email", "url"=>"legal@newscred.com"}, {"type"=>"x-email", "url"=>"sales@newscred.com"}, {"type"=>"x-faq", "url"=>"http://www.newscred.com/developer/faq"}, {"type"=>"x-github", "url"=>"https://github.com/newscred"}, {"type"=>"x-pricing", "url"=>"http://newscred.com/pricing"}, {"type"=>"x-privacy", "url"=>"http://www.newscred.com/legal/privacy"}, {"type"=>"x-selfservice-registration", "url"=>"http://www.newscred.com/developer/accesskey"}, {"type"=>"x-terms-of-service", "url"=>"http://www.newscred.com/legal/tos"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/newscred"}, {"type"=>"x-website", "url"=>"http://newscred.com"}, {"type"=>"x-website", "url"=>"https://newscred.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-machine-learning{"azure-machine-learning-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Machine Learning", "x-complete"=>1, "info"=>{"title"=>"Azure ML Web Services Management Client", "description"=>"these-apis-allow-end-users-to-operate-on-azure-machine-learning-web-services-resources--they-support-the-following-operationsullicreate-or-update-a-web-serviceliliget-a-web-servicelilipatch-a-web-servicelilidelete-a-web-serviceliliget-all-web-services-in-a-resource-group-liliget-all-web-services-in-a-subscriptionliliget-web-services-keysliul", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}"=>{"put"=>{"summary"=>"Web Services Create Or Update", "description"=>"Create or update a web service. This call will overwrite an existing web service. Note that there is no warning or confirmation. This is a nonrecoverable operation. If your intent is to create a new web service, call the Get operation first to verify that it does not exist.", "operationId"=>"WebServices_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-machinelearningwebserviceswebservicename-put", "parameters"=>[{"in"=>"body", "name"=>"createOrUpdatePayload", "description"=>"The payload that is used to create or update the web service", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Web Services"]}, "get"=>{"summary"=>"Web Services Get", "description"=>"Gets the Web Service Definition as specified by a subscription, resource group, and name. Note that the storage credentials and web service keys are not returned by this call. To get the web service access keys, call List Keys.", "operationId"=>"WebServices_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-machinelearningwebserviceswebservicename-get", "parameters"=>[{"in"=>"query", "name"=>"region", "description"=>"The region for which encrypted credential parameters are valid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Web Services"]}, "patch"=>{"summary"=>"Web Services Patch", "description"=>"Modifies an existing web service resource. The PATCH API call is an asynchronous operation. To determine whether it has completed successfully, you must perform a Get operation.", "operationId"=>"WebServices_Patch", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-machinelearningwebserviceswebservicename-patch", "parameters"=>[{"in"=>"body", "name"=>"patchPayload", "description"=>"The payload to use to patch the web service", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Web Services"]}, "delete"=>{"summary"=>"Web Services Remove", "description"=>"Deletes the specified web service.", "operationId"=>"WebServices_Remove", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-machinelearningwebserviceswebservicename-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Web Services"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}/CreateRegionalBlob"=>{"post"=>{"summary"=>"Web Services Create Regional Properties", "description"=>"Creates an encrypted credentials parameter blob for the specified region. To get the web service from a region other than the region in which it has been created, you must first call Create Regional Web Services Properties to create a copy of the encrypted credential parameter blob in that region. You only need to do this before the first time that you get the web service in the new region.", "operationId"=>"WebServices_CreateRegionalProperties", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-machinelearningwebserviceswebservicenamecreateregionalblob-post", "parameters"=>[{"in"=>"query", "name"=>"region", "description"=>"The region for which encrypted credential parameters are created"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Web Services Regional Properties"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}/listKeys"=>{"get"=>{"summary"=>"Web Services List Keys", "description"=>"Gets the access keys for the specified web service.", "operationId"=>"WebServices_ListKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-machinelearningwebserviceswebservicenamelistkeys-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Web Services Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices"=>{"get"=>{"summary"=>"Web Services List By Resource Group", "description"=>"Gets the web services in the specified resource group.", "operationId"=>"WebServices_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-machinelearningwebservices-get", "parameters"=>[{"in"=>"query", "name"=>"$skiptoken", "description"=>"Continuation token for pagination"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Web Services Resource Group"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/webServices"=>{"get"=>{"summary"=>"Web Services List By Subscription Id", "description"=>"Gets the web services in the specified subscription.", "operationId"=>"WebServices_ListBySubscriptionId", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-machinelearningwebservices-get", "parameters"=>[{"in"=>"query", "name"=>"$skiptoken", "description"=>"Continuation token for pagination"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Web Services Subscription Id"]}}}}, "apis"=>{"name"=>"Azure Machine Learning", "x-slug"=>"azure-machine-learning", "description"=>"Azure Machine Learning lets you easily design, test, operationalize, and manage predictive analytics solutions in the cloud. Azure Machine Learning was designed for applied machine learning. Use best-in-class algorithms and a simple drag-and-drop interface—and go from idea to deployment in a matter of clicks. Try it free. If youre a developer who wants the data science built in, check out our APIs and Azure Marketplace.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-simple-scalable-cutting-edge.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Machine Learning,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-machine-learning/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Machine Learning API", "x-api-slug"=>"azure-machine-learning-api", "description"=>"Azure Machine Learning lets you easily design, test, operationalize, and manage predictive analytics solutions in the cloud. Azure Machine Learning was designed for applied machine learning. Use best-in-class algorithms and a simple drag-and-drop interface—and go from idea to deployment in a matter of clicks. Try it free. If youre a developer who wants the data science built in, check out our APIs and Azure Marketplace.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-simple-scalable-cutting-edge.jpg", "humanURL"=>"https://azure.microsoft.com/en-us/services/machine-learning/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Machine Learning,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-machine-learning/subscriptionssubscriptionidprovidersmicrosoft-machinelearningwebservices-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-machine-learning/azure-machine-learning-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/machine-learning/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/machine-learning/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/machine-learning/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/machine-learning/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
idx-broker{"idx-broker-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"IDX Broker", "x-complete"=>1, "info"=>{"title"=>"IDX API 1.4.0 Test Runner", "description"=>"idx-broker-api-calls-in-version-1-4-0required-environment-variable-url-environment-variable-for-request-headers-environment-variable-partner-key-client-account-with-at-least-one-featured-listingtests-are-in-this-order-as-variables-such-as-listing-id-and-approved-mls-are-passed-to-subsequent-api-calls-", "version"=>"1.0.0"}, "host"=>"example.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/mls/approvedmls"=>{"get"=>{"summary"=>"Get Approved MLS", "description"=>"This method provides all of the IDX IDs and names for all of the paperwork approved MLSs on the client's account.\n\nNote: This method was previously camelcased as \"approvedMLS\" but was made lower case to fit the API naming convention. Calls to \"approvedMLS\" will be forwarded to \"approvedmls\" and \"approvedMLS\" is listed as deprecated in the method list.", "operationId"=>"MlsApprovedmlsGet", "x-api-path-slug"=>"mlsapprovedmls-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Approved", "MLS"]}}, "/mls/age/{approvedMLS}"=>{"get"=>{"summary"=>"Get Mls Age Approved MLS", "description"=>"TODO: Add Description", "operationId"=>"MlsAgeByApprovedMLSGet", "x-api-path-slug"=>"mlsageapprovedmls-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"path", "name"=>"approvedMLS"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mls", "Age", "Approved", "MLS"]}}, "/mls/cities/{approvedMLS}"=>{"get"=>{"summary"=>"Get Mls Cities Approved MLS", "description"=>"All cities represented in the current set of MLS data are available from this method.", "operationId"=>"MlsCitiesByApprovedMLSGet", "x-api-path-slug"=>"mlscitiesapprovedmls-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"path", "name"=>"approvedMLS"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mls", "Cities", "Approved", "MLS"]}}, "/mls/listcomponents"=>{"get"=>{"summary"=>"Get Mls List Components", "description"=>"This is a simple, access anywhere, method for getting a list of all API components available.", "operationId"=>"MlsListcomponentsGet", "x-api-path-slug"=>"mlslistcomponents-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mls", "List", "Components"]}}, "/mls/listmethods"=>{"get"=>{"summary"=>"Get Mls Listmethods", "description"=>"A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.", "operationId"=>"MlsListmethodsGet", "x-api-path-slug"=>"mlslistmethods-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mls", "Listmethods"]}}, "/mls/postalcodes/{approvedMLS}"=>{"get"=>{"summary"=>"Get Mls Addalcodes Approvedmls", "description"=>"All postal codes represented in the current set of MLS data are available from this method.", "operationId"=>"MlsPostalcodesByApprovedMLSGet", "x-api-path-slug"=>"mlspostalcodesapprovedmls-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"path", "name"=>"approvedMLS"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mls", "Alcodes", "Approvedmls"]}}, "/mls/prices/{approvedMLS}"=>{"get"=>{"summary"=>"Get Mls Prices Approvedmls", "description"=>"The sum total of properties listed in a given MLS as well as sums for each property type in the MLS.", "operationId"=>"MlsPricesByApprovedMLSGet", "x-api-path-slug"=>"mlspricesapprovedmls-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"path", "name"=>"approvedMLS"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mls", "Prices", "Approvedmls"]}}, "/mls/propertycount/{approvedMLS}"=>{"get"=>{"summary"=>"Get Mls Propertycount Approvedmls", "description"=>"Gives a total number of listings available for a given city, county, or zipcode", "operationId"=>"MlsPropertycountByApprovedMLSGet", "x-api-path-slug"=>"mlspropertycountapprovedmls-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"path", "name"=>"approvedMLS"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"countSpecifier"}, {"in"=>"query", "name"=>"countType"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mls", "Propertycount", "Approvedmls"]}}, "/mls/propertytypes/{approvedMLS}"=>{"get"=>{"summary"=>"Get Mls Propertytypes Approvedmls", "description"=>"Gives the property type information for all types that are available on a given MLS.", "operationId"=>"MlsPropertytypesByApprovedMLSGet", "x-api-path-slug"=>"mlspropertytypesapprovedmls-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"path", "name"=>"approvedMLS"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mls", "Propertytypes", "Approvedmls"]}}, "/mls/searchfields/{approvedMLS}"=>{"get"=>{"summary"=>"Get Mls Searchfields Approvedmls", "description"=>"All the fields in a given MLS that are currently allowed to be searched according to MLS guidelines.", "operationId"=>"MlsSearchfieldsByApprovedMLSGet", "x-api-path-slug"=>"mlssearchfieldsapprovedmls-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"path", "name"=>"approvedMLS"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mls", "Searchfields", "Approvedmls"]}}, "/mls/searchfieldvalues/{approvedMLS}"=>{"get"=>{"summary"=>"Get Mls Search Field Values Approved MLS", "description"=>"Field values in a given MLS that are currently allowed to be searched according to MLS guidelines.", "operationId"=>"MlsSearchfieldvaluesByApprovedMLSGet", "x-api-path-slug"=>"mlssearchfieldvaluesapprovedmls-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"path", "name"=>"approvedMLS"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"mlsPtID"}, {"in"=>"query", "name"=>"name"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mls", "Search", "Field", "Values", "Approved", "MLS"]}}, "/mls/zipcodes/{approvedMLS}"=>{"get"=>{"summary"=>"Get Mls Zipcodes Approved MLS", "description"=>"All zip codes represented in the current set of MLS data are available from this method.", "operationId"=>"MlsZipcodesByApprovedMLSGet", "x-api-path-slug"=>"mlszipcodesapprovedmls-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"path", "name"=>"approvedMLS"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mls", "Zipcodes", "Approved", "MLS"]}}, "/clients/agents"=>{"get"=>{"summary"=>"Get Agents", "description"=>"View agent information on a multi-user account.", "operationId"=>"ClientsAgentsGet", "x-api-path-slug"=>"clientsagents-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agents"]}}, "/clients/apiversion"=>{"get"=>{"summary"=>"Get Apiversion", "description"=>"Get the default api version.", "operationId"=>"ClientsApiversionGet", "x-api-path-slug"=>"clientsapiversion-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apiversion"]}}, "/clients/cities"=>{"get"=>{"summary"=>"Get Cities", "description"=>"Returns the cities available in each of a client's city lists.", "operationId"=>"ClientsCitiesGet", "x-api-path-slug"=>"clientscities-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cities"]}}, "/clients/citieslistname"=>{"get"=>{"summary"=>"Get Cities List Name", "description"=>"Returns the IDs and names for each of a client's city lists including MLS city lists.", "operationId"=>"ClientsCitieslistnameGet", "x-api-path-slug"=>"clientscitieslistname-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cities", "List", "Name"]}}, "/clients/counties"=>{"get"=>{"summary"=>"Get Counties", "description"=>"Returns the counties available in each of a client's county lists.", "operationId"=>"ClientsCountiesGet", "x-api-path-slug"=>"clientscounties-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Counties"]}}, "/clients/countieslistname"=>{"get"=>{"summary"=>"Get Countieslistname", "description"=>"Returns the IDs and names for each of a client's counties lists including MLS counties lists.", "operationId"=>"ClientsCountieslistnameGet", "x-api-path-slug"=>"clientscountieslistname-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countieslistname"]}}, "/clients/dynamicwrapperurl"=>{"post"=>{"summary"=>"Post Dynamicwrapperurl", "description"=>"Set wrapper URL. This is the global url.", "operationId"=>"ClientsDynamicwrapperurlPost", "x-api-path-slug"=>"clientsdynamicwrapperurl-post", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"formData", "name"=>"dynamicURL"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dynamicwrapperurl"]}}, "/clients/featured"=>{"get"=>{"summary"=>"Get Featured", "description"=>"Returns a basic set of information for all of the client's featured (active) properties", "operationId"=>"ClientsFeaturedGet", "x-api-path-slug"=>"clientsfeatured-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Featured"]}}, "/clients/listallowedfields/{approvedMLS}/{featuredId}"=>{"get"=>{"summary"=>"Get List Allowed Fields Approved MLS Featured", "description"=>"Returns the allowed returnable fields for a given listingID.", "operationId"=>"ClientsListallowedfieldsByApprovedMLSAndFeaturedIdGet", "x-api-path-slug"=>"clientslistallowedfieldsapprovedmlsfeaturedid-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"path", "name"=>"approvedMLS"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"featuredId"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Owed", "Fields", "Approved", "MLS", "Featured"]}}, "/clients/listcomponents"=>{"get"=>{"summary"=>"Get Listcomponents", "description"=>"This is a simple, access anywhere, method for getting a list of all API components available.", "operationId"=>"ClientsListcomponentsGet", "x-api-path-slug"=>"clientslistcomponents-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listcomponents"]}}, "/clients/listing/{approvedMLS}/{featuredId}"=>{"get"=>{"summary"=>"Get Listing Approved MLS Featuredid", "description"=>"Returns the detailed information for a given listingID.", "operationId"=>"ClientsListingByApprovedMLSAndFeaturedIdGet", "x-api-path-slug"=>"clientslistingapprovedmlsfeaturedid-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"path", "name"=>"approvedMLS"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"featuredId"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listing", "Approved", "MLS", "Featuredid"]}}, "/clients/listmethods"=>{"get"=>{"summary"=>"Get List Methods", "description"=>"A simple method for listing all available methods in the current API component.", "operationId"=>"ClientsListmethodsGet", "x-api-path-slug"=>"clientslistmethods-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Methods"]}}, "/clients/offices"=>{"get"=>{"summary"=>"Get Offices", "description"=>"View all offices on a mutli-user account.", "operationId"=>"ClientsOfficesGet", "x-api-path-slug"=>"clientsoffices-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offices"]}}, "/clients/postalcodes"=>{"get"=>{"summary"=>"Get Addalcodes", "description"=>"Returns the postalcodes available in each of a client's postalcode lists.", "operationId"=>"ClientsPostalcodesGet", "x-api-path-slug"=>"clientspostalcodes-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alcodes"]}}, "/clients/postalcodeslistname"=>{"get"=>{"summary"=>"Get Addalcodeslistname", "description"=>"Returns the IDs and names for each of a client's postalcode lists including MLS postalcode lists.", "operationId"=>"ClientsPostalcodeslistnameGet", "x-api-path-slug"=>"clientspostalcodeslistname-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alcodeslistname"]}}, "/clients/savedlinks"=>{"get"=>{"summary"=>"Get Saved Link", "description"=>"Getclient saved links", "operationId"=>"ClientsSavedlinksGet", "x-api-path-slug"=>"clientssavedlinks-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Saved", "Link"]}, "put"=>{"summary"=>"Put Saved Link", "description"=>"Create a new client saved link", "operationId"=>"ClientsSavedlinksPut", "x-api-path-slug"=>"clientssavedlinks-put", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"formData", "name"=>"linkName"}, {"in"=>"formData", "name"=>"linkTitle"}, {"in"=>"header", "name"=>"outputtype"}, {"in"=>"formData", "name"=>"pageTitle"}, {"in"=>"formData", "name"=>"queryString[hp]"}, {"in"=>"formData", "name"=>"queryString[idxID]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Saved", "Link"]}}, "/clients/properties/{savedLinkId}"=>{"get"=>{"summary"=>"Get Properties Saved Link", "description"=>"Get client saved links results", "operationId"=>"ClientsPropertiesBySavedLinkIdGet", "x-api-path-slug"=>"clientspropertiessavedlinkid-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}, {"in"=>"path", "name"=>"savedLinkId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Properties", "Saved", "Link"]}}, "/clients/savedlinks/{savedLinkId}"=>{"post"=>{"summary"=>"Post Saved Link Saved Link", "description"=>"Update a client saved link", "operationId"=>"ClientsSavedlinksBySavedLinkIdPost", "x-api-path-slug"=>"clientssavedlinkssavedlinkid-post", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"formData", "name"=>"linkName"}, {"in"=>"formData", "name"=>"linkTitle"}, {"in"=>"header", "name"=>"outputtype"}, {"in"=>"formData", "name"=>"pageTitle"}, {"in"=>"formData", "name"=>"queryString[hp]"}, {"in"=>"formData", "name"=>"queryString[idxID]"}, {"in"=>"path", "name"=>"savedLinkId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Saved", "Link", "Saved", "Link"]}, "delete"=>{"summary"=>"Delete Saved Link Saved Link", "description"=>"Delete a client saved link", "operationId"=>"ClientsSavedlinksBySavedLinkIdDelete", "x-api-path-slug"=>"clientssavedlinkssavedlinkid-delete", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"formData", "name"=>"linkName"}, {"in"=>"formData", "name"=>"linkTitle"}, {"in"=>"header", "name"=>"outputtype"}, {"in"=>"formData", "name"=>"pageTitle"}, {"in"=>"formData", "name"=>"queryString[hp]"}, {"in"=>"formData", "name"=>"queryString[idxID]"}, {"in"=>"path", "name"=>"savedLinkId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Saved", "Link", "Saved", "Link"]}}, "/clients/searchquery"=>{"get"=>{"summary"=>"Get Search Query", "description"=>"Performs search and returns the results.", "operationId"=>"ClientsSearchqueryGet", "x-api-path-slug"=>"clientssearchquery-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Query"]}}, "/clients/soldpending"=>{"get"=>{"summary"=>"Get Sold Pending", "description"=>"Returns a basic set of information for all of the client's sold and pending properties.", "operationId"=>"ClientsSoldpendingGet", "x-api-path-slug"=>"clientssoldpending-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sold", "Pending"]}}, "/clients/supplemental"=>{"get"=>{"summary"=>"Get Supplemental", "description"=>"Get supplemental listings.", "operationId"=>"ClientsSupplementalGet", "x-api-path-slug"=>"clientssupplemental-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Supplemental"]}, "put"=>{"summary"=>"Put Supplemental", "description"=>"Create a new supplemental listing.", "operationId"=>"ClientsSupplementalPut", "x-api-path-slug"=>"clientssupplemental-put", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"formData", "name"=>"images[hp]"}, {"in"=>"formData", "name"=>"likeIdxID"}, {"in"=>"formData", "name"=>"likeMlsPtID"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Supplemental"]}}, "/clients/supplemental/{suppId}"=>{"post"=>{"summary"=>"Post Supplemental", "description"=>"Update a supplemental listing.", "operationId"=>"ClientsSupplementalBySuppIdPost", "x-api-path-slug"=>"clientssupplementalsuppid-post", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"formData", "name"=>"images[hp]"}, {"in"=>"formData", "name"=>"likeIdxID"}, {"in"=>"formData", "name"=>"likeMlsPtID"}, {"in"=>"header", "name"=>"outputtype"}, {"in"=>"path", "name"=>"suppId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Supplemental"]}, "delete"=>{"summary"=>"Delete Supplemental", "description"=>"Delete a supplemental listing.", "operationId"=>"ClientsSupplementalBySuppIdDelete", "x-api-path-slug"=>"clientssupplementalsuppid-delete", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}, {"in"=>"path", "name"=>"suppId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Supplemental"]}}, "/clients/systemlinks"=>{"get"=>{"summary"=>"Get System Links", "description"=>"Gathers all the pages system pages (search, featured, contact, etc) that can be directly linked to without additional property information being included in the URL.", "operationId"=>"ClientsSystemlinksGet", "x-api-path-slug"=>"clientssystemlinks-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["System", "Links"]}}, "/clients/widgetsrc"=>{"get"=>{"summary"=>"Get Wgetsrc", "description"=>"Gather all the URLs for javascript widgets on the user's account. These widgets can then be placed on the user's main site via the included URLs.", "operationId"=>"ClientsWidgetsrcGet", "x-api-path-slug"=>"clientswidgetsrc-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wgetsrc"]}}, "/clients/wrappercache"=>{"delete"=>{"summary"=>"Delete Wrapper Cache", "description"=>"Delete wrapper cache.", "operationId"=>"ClientsWrappercacheDelete", "x-api-path-slug"=>"clientswrappercache-delete", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wrapper", "Cache"]}}, "/clients/zipcodes"=>{"get"=>{"summary"=>"Get Zipcodes", "description"=>"Returns the zipcodes available in each of a client's zipcode lists.", "operationId"=>"ClientsZipcodesGet", "x-api-path-slug"=>"clientszipcodes-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zipcodes"]}}, "/leads/lead"=>{"get"=>{"summary"=>"Get Leads Lead", "description"=>"Get information for one or multiple leads.\n\nExample Request: https://api.idxbroker.com/leads/lead?interval=24&startDatetime=2016-01-01+23:59:59&dateType=subscribeDate\n\nFor Data on a specific lead add/LEAD_ID_HERE\n\nExample: https://api.idxbroker.com/leads/lead/123", "operationId"=>"LeadsLeadGet", "x-api-path-slug"=>"leadslead-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Lead"]}, "put"=>{"summary"=>"Put Leads Lead", "description"=>"Get information for one or multiple leads.\n\nExample Request: https://api.idxbroker.com/leads/lead?interval=24&startDatetime=2016-01-01+23:59:59&dateType=subscribeDate\n\nFor Data on a specific lead add/LEAD_ID_HERE\n\nExample: https://api.idxbroker.com/leads/lead/123", "operationId"=>"LeadsLeadPut", "x-api-path-slug"=>"leadslead-put", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"formData", "name"=>"email"}, {"in"=>"formData", "name"=>"firstName"}, {"in"=>"formData", "name"=>"lastName"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Lead"]}}, "/leads/lead/{leadId}"=>{"post"=>{"summary"=>"Post Leads Lead Lead", "description"=>"Post information for a lead.\n\n\nExample: https://api.idxbroker.com/leads/lead/123", "operationId"=>"LeadsLeadByLeadIdPost", "x-api-path-slug"=>"leadsleadleadid-post", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"formData", "name"=>"email"}, {"in"=>"formData", "name"=>"firstName"}, {"in"=>"formData", "name"=>"lastName"}, {"in"=>"path", "name"=>"leadId"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Lead", "Lead"]}, "delete"=>{"summary"=>"Delete Leads Lead Lead", "description"=>"Delete Lead\n\nExample: https://api.idxbroker.com/leads/lead/123", "operationId"=>"LeadsLeadByLeadIdDelete", "x-api-path-slug"=>"leadsleadleadid-delete", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"leadId"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Lead", "Lead"]}}, "/leads/note/{leadId}"=>{"put"=>{"summary"=>"Put Leads Note", "description"=>"Add new note information for a lead.", "operationId"=>"LeadsNoteByLeadIdPut", "x-api-path-slug"=>"leadsnoteleadid-put", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"leadId"}, {"in"=>"formData", "name"=>"note"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Note"]}}, "/leads/note/{noteId}"=>{"get"=>{"summary"=>"Get Leads Not", "description"=>"Get note information for a lead.", "operationId"=>"LeadsNoteByNoteIdGet", "x-api-path-slug"=>"leadsnotenoteid-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"noteId"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Not"]}}, "/leads/note/{leadId}/{noteId}"=>{"post"=>{"summary"=>"Post Leads Note", "description"=>"Post new note information for a lead.", "operationId"=>"LeadsNoteByLeadIdAndNoteIdPost", "x-api-path-slug"=>"leadsnoteleadidnoteid-post", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"leadId"}, {"in"=>"formData", "name"=>"note"}, {"in"=>"path", "name"=>"noteId"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Note"]}, "delete"=>{"summary"=>"Delete Leads Note", "description"=>"Delete note information for a lead.", "operationId"=>"LeadsNoteByLeadIdAndNoteIdDelete", "x-api-path-slug"=>"leadsnoteleadidnoteid-delete", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"leadId"}, {"in"=>"formData", "name"=>"note"}, {"in"=>"path", "name"=>"noteId"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Note"]}}, "/leads/property/{leadId}"=>{"get"=>{"summary"=>"Get Leads Property", "description"=>"Get a property information for a lead.", "operationId"=>"LeadsPropertyByLeadIdGet", "x-api-path-slug"=>"leadspropertyleadid-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"leadId"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Property"]}, "put"=>{"summary"=>"Put Leads Property", "description"=>"Add new property information for a lead.", "operationId"=>"LeadsPropertyByLeadIdPut", "x-api-path-slug"=>"leadspropertyleadid-put", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"leadId"}, {"in"=>"header", "name"=>"outputtype"}, {"in"=>"formData", "name"=>"propertyName"}, {"in"=>"formData", "name"=>"property[idxID]"}, {"in"=>"formData", "name"=>"property[listingID]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Property"]}}, "/leads/property/{leadId}/{propId}"=>{"post"=>{"summary"=>"Post Leads Property", "description"=>"Update a property information for a lead.", "operationId"=>"LeadsPropertyByLeadIdAndPropIdPost", "x-api-path-slug"=>"leadspropertyleadidpropid-post", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"leadId"}, {"in"=>"header", "name"=>"outputtype"}, {"in"=>"formData", "name"=>"propertyName"}, {"in"=>"formData", "name"=>"property[idxID]"}, {"in"=>"formData", "name"=>"property[listingID]"}, {"in"=>"path", "name"=>"propId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Property"]}, "delete"=>{"summary"=>"Delete Leads Property", "description"=>"Delete a property information for a lead.", "operationId"=>"LeadsPropertyByLeadIdAndPropIdDelete", "x-api-path-slug"=>"leadspropertyleadidpropid-delete", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"leadId"}, {"in"=>"header", "name"=>"outputtype"}, {"in"=>"path", "name"=>"propId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Property"]}}, "/leads/search/{leadId}"=>{"get"=>{"summary"=>"Get Leads Search", "description"=>"Get saved search information for a lead.", "operationId"=>"LeadsSearchByLeadIdGet", "x-api-path-slug"=>"leadssearchleadid-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"leadId"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Search"]}, "put"=>{"summary"=>"Put Leads Search", "description"=>"New search information for a lead.", "operationId"=>"LeadsSearchByLeadIdPut", "x-api-path-slug"=>"leadssearchleadid-put", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"leadId"}, {"in"=>"header", "name"=>"outputtype"}, {"in"=>"formData", "name"=>"searchName"}, {"in"=>"formData", "name"=>"search[hp]"}, {"in"=>"formData", "name"=>"search[idxID]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Search"]}}, "/leads/search/{leadId}/{searchId}"=>{"post"=>{"summary"=>"Post Leads Search", "description"=>"Update search information for a lead.", "operationId"=>"LeadsSearchByLeadIdAndSearchIdPost", "x-api-path-slug"=>"leadssearchleadidsearchid-post", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"leadId"}, {"in"=>"header", "name"=>"outputtype"}, {"in"=>"path", "name"=>"searchId"}, {"in"=>"formData", "name"=>"searchName"}, {"in"=>"formData", "name"=>"search[hp]"}, {"in"=>"formData", "name"=>"search[idxID]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Search"]}, "delete"=>{"summary"=>"Delete Leads Search", "description"=>"Delete search information for a lead.", "operationId"=>"LeadsSearchByLeadIdAndSearchIdDelete", "x-api-path-slug"=>"leadssearchleadidsearchid-delete", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"leadId"}, {"in"=>"header", "name"=>"outputtype"}, {"in"=>"path", "name"=>"searchId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Search"]}}, "/leads/leadtraffic/{leadId}"=>{"get"=>{"summary"=>"Get Leads Lead Traffic", "description"=>"Get information on a lead's traffic history.", "operationId"=>"LeadsLeadtrafficByLeadIdGet", "x-api-path-slug"=>"leadsleadtrafficleadid-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"leadId"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Lead", "Traffic"]}}, "/leads/listcomponents"=>{"get"=>{"summary"=>"Get Leads List Components", "description"=>"This is a simple, access anywhere, method for getting a list of all API components available.", "operationId"=>"LeadsListcomponentsGet", "x-api-path-slug"=>"leadslistcomponents-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "List", "Components"]}}, "/leads/listmethods"=>{"get"=>{"summary"=>"Get Leads List Methods", "description"=>"A simple method for listing all available methods in the current API component.", "operationId"=>"LeadsListmethodsGet", "x-api-path-slug"=>"leadslistmethods-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"ancillarykey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "List", "Methods"]}}, "/partners/aggregatedagents"=>{"get"=>{"summary"=>"Get Partners Aggregated Agents", "description"=>"Get a list of all agents for your clients.", "operationId"=>"PartnersAggregatedagentsGet", "x-api-path-slug"=>"partnersaggregatedagents-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners", "Aggregated", "Agents"]}}, "/partners/aggregatedfeatured"=>{"get"=>{"summary"=>"Get Partners Aggregated Featured", "description"=>"Get a list of featured MLS properties.", "operationId"=>"PartnersAggregatedfeaturedGet", "x-api-path-slug"=>"partnersaggregatedfeatured-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners", "Aggregated", "Featured"]}}, "/partners/aggregatedleads"=>{"get"=>{"summary"=>"Get Partners Aggregated Leads", "description"=>"Get a list of all leads.", "operationId"=>"PartnersAggregatedleadsGet", "x-api-path-slug"=>"partnersaggregatedleads-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners", "Aggregated", "Leads"]}}, "/partners/aggregatedleadtraffic"=>{"get"=>{"summary"=>"Get Partners Aggregated Lead Traffic", "description"=>"Get a list of all leads traffic history.", "operationId"=>"PartnersAggregatedleadtrafficGet", "x-api-path-slug"=>"partnersaggregatedleadtraffic-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners", "Aggregated", "Lead", "Traffic"]}}, "/partners/aggregatedlistingstatus"=>{"get"=>{"summary"=>"Get Partners Aggregated Listing Status", "description"=>"This method gives the status for all MLS listings (not supplemental) broken down by client account ID. This includes sold/pending listings with an unknown status which are not usually returned by sold/pending api methods. This is helpful if you need to know when previously gathered featured properties have left the market.", "operationId"=>"PartnersAggregatedlistingstatusGet", "x-api-path-slug"=>"partnersaggregatedlistingstatus-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners", "Aggregated", "Listing", "Status"]}}, "/partners/aggregatedproperties"=>{"get"=>{"summary"=>"Get Partners Aggregated Properties", "description"=>"Get a list of all lead saved properties.", "operationId"=>"PartnersAggregatedpropertiesGet", "x-api-path-slug"=>"partnersaggregatedproperties-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners", "Aggregated", "Properties"]}}, "/partners/aggregatedsearches"=>{"get"=>{"summary"=>"Get Partners Aggregated Searches", "description"=>"Get a list of all lead saved searches.", "operationId"=>"PartnersAggregatedsearchesGet", "x-api-path-slug"=>"partnersaggregatedsearches-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners", "Aggregated", "Searches"]}}, "/partners/aggregatedsoldpending"=>{"get"=>{"summary"=>"Get Partners Aggregated Sold Pending", "description"=>"Get a list of sold/pending MLS properties.", "operationId"=>"PartnersAggregatedsoldpendingGet", "x-api-path-slug"=>"partnersaggregatedsoldpending-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners", "Aggregated", "Sold", "Pending"]}}, "/partners/aggregatedsupplemental"=>{"get"=>{"summary"=>"Get Partners Aggregated Supplemental", "description"=>"Get a list of supplemental (non-MLS) properties.", "operationId"=>"PartnersAggregatedsupplementalGet", "x-api-path-slug"=>"partnersaggregatedsupplemental-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners", "Aggregated", "Supplemental"]}}, "/partners/clients"=>{"get"=>{"summary"=>"Get Partners Clients", "description"=>"A list of clients available to a given partner. The list of clients can be filtered by GET values.", "operationId"=>"PartnersClientsGet", "x-api-path-slug"=>"partnersclients-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners", "Clients"]}}, "/partners/listcomponents"=>{"get"=>{"summary"=>"Get Partners List Components", "description"=>"This is a simple, access anywhere, method for getting a list of all API components available.", "operationId"=>"PartnersListcomponentsGet", "x-api-path-slug"=>"partnerslistcomponents-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners", "List", "Components"]}}, "/partners/listmethods"=>{"get"=>{"summary"=>"Get Partners List Methods", "description"=>"A simple method for listing all available methods in the current API component.", "operationId"=>"PartnersListmethodsGet", "x-api-path-slug"=>"partnerslistmethods-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners", "List", "Methods"]}}, "/partners/propertytypes"=>{"get"=>{"summary"=>"Get Partners Property Types", "description"=>"Gives the names and IDs of all available property types. This method differs from the property type lookup method in the client API component in that it can look up property types for any active Platinum MLS, not just those for which the client is a member.", "operationId"=>"PartnersPropertytypesGet", "x-api-path-slug"=>"partnerspropertytypes-get", "parameters"=>[{"in"=>"header", "name"=>"accesskey"}, {"in"=>"header", "name"=>"apiversion"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"outputtype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners", "Property", "Types"]}}}}, "apis"=>{"name"=>"IDX Broker", "x-slug"=>"idx-broker", "description"=>"Based in Eugene, OR, IDX, LLC is nationally known as a leading provider of real estate search applications. IDX, LLC actively manages more than $2 trillion worth of active listing data from more than 600 individual Multiple Listings Services (MLS). IDX, LLC provides integrated IDX software, customizable listing search utilities and lead management tools for real estate based websites (IDX Broker).", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/idx-broker.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,Profiles,Real Estate,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"idx-broker/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"IDX Broker", "x-api-slug"=>"idx-broker", "description"=>"Based in Eugene, OR, IDX, LLC is nationally known as a leading provider of real estate search applications. IDX, LLC actively manages more than $2 trillion worth of active listing data from more than 600 individual Multiple Listings Services (MLS). IDX, LLC provides integrated IDX software, customizable listing search utilities and lead management tools for real estate based websites (IDX Broker).", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/idx-broker.png", "humanURL"=>"http://www.idxbroker.com", "baseURL"=>"https://example.com//", "tags"=>"API Provider,Profiles,Real Estate,Relative Data,Service API", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/idx-broker/partnerspropertytypes-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/idx-broker/idx-broker-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://blog.idxbroker.com/"}, {"type"=>"x-blog-rss", "url"=>"https://blog.idxbroker.com/feed/"}, {"type"=>"x-website", "url"=>"http://www.idxbroker.com"}, {"type"=>"x-developer", "url"=>"https://developers.idxbroker.com/"}, {"type"=>"x-forum", "url"=>"https://developers.idxbroker.com/forums-home/"}, {"type"=>"x-getting-started", "url"=>"https://developers.idxbroker.com/getting-started/"}, {"type"=>"x-partners", "url"=>"https://developers.idxbroker.com/partnership/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/idxbroker"}, {"type"=>"x-website", "url"=>"http://www.idxbroker.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
spectrocoin{"spectrocoin-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"SpectroCoin", "x-complete"=>1, "info"=>{"title"=>"SpectroCoin Merchant", "description"=>"this-is-an-api-designed-for-merchants-who-are-using-spectrocoin-services-and-wishes-to-integrate-them-locally-", "contact"=>{"name"=>"info@spectrocoin.com"}, "version"=>"1.0.0"}, "host"=>"spectrocoin.com", "basePath"=>"/api/merchant/1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/createOrder"=>{"post"=>{"summary"=>"Create merchant order", "description"=>"", "operationId"=>"createOrder", "x-api-path-slug"=>"apicreateorder-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Request to create order", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "spectro-coin-merchant-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"SpectroCoin", "x-complete"=>1, "info"=>{"title"=>"Spectro Coin Merchant", "description"=>"this-is-an-api-designed-for-merchants-who-are-using-spectrocoin-services-and-wishes-to-integrate-them-locally-", "contact"=>{"name"=>"info@spectrocoin.com"}, "version"=>"1.0.0"}, "host"=>"spectrocoin.com", "basePath"=>"/api/merchant/1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/createOrder"=>{"post"=>{"summary"=>"Create merchant order", "description"=>"Create merchant order", "operationId"=>"createOrder", "x-api-path-slug"=>"apicreateorder-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Request to create order", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders"]}}}}, "apis"=>{"name"=>"SpectroCoin", "x-slug"=>"spectrocoin", "description"=>"SpectroCoin offers bitcoin exchange, bitcoin wallet, bitcoin debit card, and bitcoin payment processing services. Buy and sell bitcoins through SEPA, international and local bank transfers, or credit and debit cards.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/26436-spectrocoin-com.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"13042", "tags"=>"Blockchain,Financial Services,General Data,Marketplace,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"spectrocoin/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Spectro Coin Merchant", "x-api-slug"=>"spectro-coin-merchant", "description"=>"SpectroCoin offers bitcoin exchange, bitcoin wallet, bitcoin debit card, and bitcoin payment processing services. Buy and sell bitcoins through SEPA, international and local bank transfers, or credit and debit cards.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/26436-spectrocoin-com.jpg", "humanURL"=>"http://spectrocoin.com", "baseURL"=>"https://spectrocoin.com//api/merchant/1", "tags"=>"Blockchain,Financial Services,General Data,Marketplace,Service API,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/spectrocoin/spectro-coin-merchant-openapi.yaml"}]}, {"name"=>"Spectrocoin", "x-api-slug"=>"spectrocoin", "description"=>"SpectroCoin offers bitcoin exchange, bitcoin wallet, bitcoin debit card, and bitcoin payment processing services. Buy and sell bitcoins through SEPA, international and local bank transfers, or credit and debit cards.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/26436-spectrocoin-com.jpg", "humanURL"=>"http://spectrocoin.com", "baseURL"=>"https://spectrocoin.com//api/merchant/1", "tags"=>"Orders", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/spectrocoin/spectrocoin-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/spectrocoin"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/spectrocoin"}, {"type"=>"x-website", "url"=>"http://spectrocoin.com"}, {"type"=>"x-website", "url"=>"https://spectrocoin.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
school-digger{"school-digger-api-v1-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"School Digger", "x-complete"=>1, "info"=>{"title"=>"School Digger API V1", "description"=>"get-detailed-data-on-over-120000-schools-and-18500-districts-in-the-u-s-", "termsOfService"=>"https://developer.schooldigger.com/termsofservice", "contact"=>{"name"=>"SchoolDigger", "email"=>"api@schooldigger.com"}, "version"=>"v1"}, "host"=>"api.schooldigger.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/districts"=>{"get"=>{"summary"=>"Returns a list of districts", "description"=>"Search the SchoolDigger database for districts. You may use any combination of criteria as query parameters.", "operationId"=>"Districts_GetAllDistricts", "x-api-path-slug"=>"v1districts-get", "parameters"=>[{"in"=>"query", "name"=>"appID", "description"=>"Your API app id"}, {"in"=>"query", "name"=>"appKey", "description"=>"Your API app key"}, {"in"=>"query", "name"=>"boundaryAddress", "description"=>"Full U"}, {"in"=>"query", "name"=>"boxLatitudeNW", "description"=>"Search for districts within a box defined by (BoxLatitudeNW/BoxLongitudeNW) to (BoxLongitudeSE/BoxLatitudeSE) (optional)"}, {"in"=>"query", "name"=>"boxLatitudeSE", "description"=>"Search for districts within a box defined by (BoxLatitudeNW/BoxLongitudeNW) to (BoxLongitudeSE/BoxLatitudeSE) (optional)"}, {"in"=>"query", "name"=>"boxLongitudeNW", "description"=>"Search for districts within a box defined by (BoxLatitudeNW/BoxLongitudeNW) to (BoxLongitudeSE/BoxLatitudeSE) (optional)"}, {"in"=>"query", "name"=>"boxLongitudeSE", "description"=>"Search for districts within a box defined by (BoxLatitudeNW/BoxLongitudeNW) to (BoxLongitudeSE/BoxLatitudeSE) (optional)"}, {"in"=>"query", "name"=>"city", "description"=>"Search for districts in this city (optional)"}, {"in"=>"query", "name"=>"distanceMiles", "description"=>"Search for districts within (distanceMiles) of (nearLatitude)/(nearLongitude) (Default 5 miles) (optional) (Pro, Enterprise API levels only)"}, {"in"=>"query", "name"=>"isInBoundaryOnly", "description"=>"Return only the districts that include given location (nearLatitdue/nearLongitude) or (nearAddress) in its attendance boundary (Enterprise API level only)"}, {"in"=>"query", "name"=>"nearLatitude", "description"=>"Search for districts within (distanceMiles) of (nearLatitude)/(nearLongitude) (e"}, {"in"=>"query", "name"=>"nearLongitude", "description"=>"Search for districts within (distanceMiles) of (nearLatitude)/(nearLongitude) (e"}, {"in"=>"query", "name"=>"page", "description"=>"Page number to retrieve (optional, default: 1)"}, {"in"=>"query", "name"=>"perPage", "description"=>"Number of districts to retrieve on a page (50 max) (optional, default: 10)"}, {"in"=>"query", "name"=>"q", "description"=>"Search term - note: will match district name or city (optional)"}, {"in"=>"query", "name"=>"sortBy", "description"=>"Sort list"}, {"in"=>"query", "name"=>"st", "description"=>"Two character state (e"}, {"in"=>"query", "name"=>"zip", "description"=>"Search for districts in this 5-digit zip code (optional)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/districts/{id}"=>{"get"=>{"summary"=>"Returns a detailed record for one district", "description"=>"Retrieve a single district record from the SchoolDigger database", "operationId"=>"Districts_GetDistrict", "x-api-path-slug"=>"v1districtsid-get", "parameters"=>[{"in"=>"query", "name"=>"appID", "description"=>"Your API app id"}, {"in"=>"query", "name"=>"appKey", "description"=>"Your API app key"}, {"in"=>"path", "name"=>"id", "description"=>"The 7 digit District ID (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/rankings/districts/{st}"=>{"get"=>{"summary"=>"Returns a SchoolDigger district ranking list", "description"=>"", "operationId"=>"v1.rankings.districts.st.get", "x-api-path-slug"=>"v1rankingsdistrictsst-get", "parameters"=>[{"in"=>"query", "name"=>"appID", "description"=>"Your API app id"}, {"in"=>"query", "name"=>"appKey", "description"=>"Your API app key"}, {"in"=>"query", "name"=>"page", "description"=>"Page number to retrieve (optional, default: 1)"}, {"in"=>"query", "name"=>"perPage", "description"=>"Number of districts to retrieve on a page (50 max) (optional, default: 10)"}, {"in"=>"path", "name"=>"st", "description"=>"Two character state (e"}, {"in"=>"query", "name"=>"year", "description"=>"The ranking year (leave blank for most recent year)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/rankings/schools/{st}"=>{"get"=>{"summary"=>"Returns a SchoolDigger school ranking list", "description"=>"", "operationId"=>"v1.rankings.schools.st.get", "x-api-path-slug"=>"v1rankingsschoolsst-get", "parameters"=>[{"in"=>"query", "name"=>"appID", "description"=>"Your API app id"}, {"in"=>"query", "name"=>"appKey", "description"=>"Your API app key"}, {"in"=>"query", "name"=>"level", "description"=>"Level of ranking: Elementary, Middle, or High"}, {"in"=>"query", "name"=>"page", "description"=>"Page number to retrieve (optional, default: 1)"}, {"in"=>"query", "name"=>"perPage", "description"=>"Number of schools to retrieve on a page (50 max) (optional, default: 10)"}, {"in"=>"path", "name"=>"st", "description"=>"Two character state (e"}, {"in"=>"query", "name"=>"year", "description"=>"The ranking year (leave blank for most recent year)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/schools"=>{"get"=>{"summary"=>"Returns a list of schools", "description"=>"Search the SchoolDigger database for schools. You may use any combination of criteria as query parameters.", "operationId"=>"Schools_GetAllSchools", "x-api-path-slug"=>"v1schools-get", "parameters"=>[{"in"=>"query", "name"=>"appID", "description"=>"Your API app id"}, {"in"=>"query", "name"=>"appKey", "description"=>"Your API app key"}, {"in"=>"query", "name"=>"boundaryAddress", "description"=>"Full U"}, {"in"=>"query", "name"=>"boxLatitudeNW", "description"=>"Search for schools within a box defined by (boxLatitudeNW/boxLongitudeNW) to (boxLongitudeSE/boxLatitudeSE) (optional)"}, {"in"=>"query", "name"=>"boxLatitudeSE", "description"=>"Search for schools within a box defined by (boxLatitudeNW/boxLongitudeNW) to (boxLongitudeSE/boxLatitudeSE) (optional)"}, {"in"=>"query", "name"=>"boxLongitudeNW", "description"=>"Search for schools within a box defined by (boxLatitudeNW/boxLongitudeNW) to (boxLongitudeSE/boxLatitudeSE) (optional)"}, {"in"=>"query", "name"=>"boxLongitudeSE", "description"=>"Search for schools within a box defined by (boxLatitudeNW/boxLongitudeNW) to (boxLongitudeSE/boxLatitudeSE) (optional)"}, {"in"=>"query", "name"=>"city", "description"=>"Search for schools in this city (optional)"}, {"in"=>"query", "name"=>"distanceMiles", "description"=>"Search for schools within (distanceMiles) of (nearLatitude)/(nearLongitude) (Default 5 miles) (optional) (Pro, Enterprise API levels only)"}, {"in"=>"query", "name"=>"districtID", "description"=>"Search for schools within this district (7 digit district id) (optional)"}, {"in"=>"query", "name"=>"isCharter", "description"=>"True = return only charter schools, False = return only non-charter schools (optional) (Pro, Enterprise API levels only)"}, {"in"=>"query", "name"=>"isInBoundaryOnly", "description"=>"Return only the schools that include given location (nearLatitdue/nearLongitude) or (nearAddress) in its attendance boundary (Enterprise API level only)"}, {"in"=>"query", "name"=>"isMagnet", "description"=>"True = return only magnet schools, False = return only non-magnet schools (optional) (Pro, Enterprise API levels only)"}, {"in"=>"query", "name"=>"isTitleI", "description"=>"True = return only Title I schools, False = return only non-Title I schools (optional) (Pro, Enterprise API levels only)"}, {"in"=>"query", "name"=>"isTitleISchoolwide", "description"=>"True = return only Title I schoolwide schools, False = return only non-Title I Schoolwide schools (optional) (Pro, Enterprise API levels only)"}, {"in"=>"query", "name"=>"isVirtual", "description"=>"True = return only virtual schools, False = return only non-virtual schools (optional) (Pro, Enterprise API levels only)"}, {"in"=>"query", "name"=>"level", "description"=>"Search for schools at this level"}, {"in"=>"query", "name"=>"nearLatitude", "description"=>"Search for schools within (distanceMiles) of (nearLatitude)/(nearLongitude) (e"}, {"in"=>"query", "name"=>"nearLongitude", "description"=>"Search for schools within (distanceMiles) of (nearLatitude)/(nearLongitude) (e"}, {"in"=>"query", "name"=>"page", "description"=>"Page number to retrieve (optional, default: 1)"}, {"in"=>"query", "name"=>"perPage", "description"=>"Number of schools to retrieve on a page (50 max) (optional, default: 10)"}, {"in"=>"query", "name"=>"q", "description"=>"Search term - note: will match school name or city (optional)"}, {"in"=>"query", "name"=>"sortBy", "description"=>"Sort list"}, {"in"=>"query", "name"=>"st", "description"=>"Two character state (e"}, {"in"=>"query", "name"=>"zip", "description"=>"Search for schools in this 5-digit zip code (optional)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/schools/{id}"=>{"get"=>{"summary"=>"Returns a detailed record for one school", "description"=>"Retrieve a school record from the SchoolDigger database", "operationId"=>"Schools_GetSchool", "x-api-path-slug"=>"v1schoolsid-get", "parameters"=>[{"in"=>"query", "name"=>"appID", "description"=>"Your API app id"}, {"in"=>"query", "name"=>"appKey", "description"=>"Your API app key"}, {"in"=>"path", "name"=>"id", "description"=>"The 12 digit School ID (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"School Digger", "x-slug"=>"school-digger", "description"=>"Start your search for a great school at SchoolDigger.com! We have test scores, rankings, school and district boundaries, student/teacher ratios, ethnic makeup, and scores of other useful metrics and information for over 120,000 elementary, middle, and high schools in the United States!", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/schooldigger.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"General Data,Schools", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"school-digger/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"School Digger API V1", "x-api-slug"=>"school-digger-api-v1", "description"=>"Start your search for a great school at SchoolDigger.com! We have test scores, rankings, school and district boundaries, student/teacher ratios, ethnic makeup, and scores of other useful metrics and information for over 120,000 elementary, middle, and high schools in the United States!", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/schooldigger.png", "humanURL"=>"http://schooldigger.com", "baseURL"=>"https://api.schooldigger.com//", "tags"=>"General Data,Schools", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/school-digger/v1schoolsid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/school-digger/school-digger-api-v1-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-log", "url"=>"https://developer.schooldigger.com/changelog"}, {"type"=>"x-developer", "url"=>"https://developer.schooldigger.com/?r=schooldigger"}, {"type"=>"x-documentation", "url"=>"https://developer.schooldigger.com/docs"}, {"type"=>"x-website", "url"=>"http://schooldigger.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
predicthq{"predicthq-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"PredictHQ", "x-complete"=>1, "info"=>{"title"=>"PredictHQ API", "description"=>"todo-add-description", "version"=>"1.0.0"}, "host"=>"api.predicthq.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/signals/{signal_id}/analysis/"=>{"get"=>{"summary"=>"Retrieve Analysis", "description"=>"This action returns a complete analysis of your Signal, which includes what your actual figures were, what could be expected, and what was in excess in terms of **demand**, **lead time** and **duration** and can be explained using events. Note that lead time (`lead`) and duration (`span`) analysis are only available when an `initiated` and `completed` dates are provided with data points, respectively.\n\nTo retrieve a list of events that we estimate impacted your business at a specific date in the past, use the `signal.id` and `signal.explain` parameters with the events endpoint.\n\nAlternatively, to retrieve a list of predicted events that we estimate will impact your business in the future, use the `signal.id` parameter and the date range you wish a prediction for using `active` or `start`.\n\nSee the events endpoint for more details.\n\nThe `significance` parameter corresponds to percentage of variation in your data that is considered normal when computing excess that can be attributed to events. If you were to look at a normal distribution, it would correspond to the percentage of values that lie within a band around the mean.\n\nAs an example:\n- ~68.27% = 1 standard deviation from the mean\n- ~95.45% = 2 standard deviations from the mean\n- ~99.73% = 3 standard deviations from the mean\n\nA high `significance` means that only extreme spikes and troughs will be attributed to events. We use 50% as a default, which corresponds to ~0.68 standard deviations.", "operationId"=>"V1SignalsAnalysisBySignalIdGet", "x-api-path-slug"=>"v1signalssignal-idanalysis-get", "parameters"=>[{"in"=>"path", "name"=>"signal_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signals", "Signal", "Analysis"]}}, "/v1/signals/{signal_id}/"=>{"get"=>{"summary"=>"Retrieve A Signal", "description"=>"This action returns a Signal according to the unique identifier you provide.", "operationId"=>"V1SignalsBySignalIdGet", "x-api-path-slug"=>"v1signalssignal-id-get", "parameters"=>[{"in"=>"path", "name"=>"signal_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signals", "Signal"]}, "put"=>{"summary"=>"Update a Signal", "description"=>"This action modifies a Signal according to the unique identifier you provide.", "operationId"=>"V1SignalsBySignalIdPut", "x-api-path-slug"=>"v1signalssignal-id-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"signal_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signals", "Signal"]}, "delete"=>{"summary"=>"Delete A Signal", "description"=>"This action will delete a Signal altogether along with the Data Points associated with it, according to the unique identifier you provide.", "operationId"=>"V1SignalsBySignalIdDelete", "x-api-path-slug"=>"v1signalssignal-id-delete", "parameters"=>[{"in"=>"path", "name"=>"signal_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signals", "Signal"]}}, "/v1/places/"=>{"get"=>{"summary"=>"Search Places", "description"=>"Use the below parameters to search and filter all places. Places are sorted by relevance (location or text query proximity).\n\nA search requires at least one of the `q`, `id`, `country` or `location` parameters.", "operationId"=>"V1PlacesGet", "x-api-path-slug"=>"v1places-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places"]}}, "/v1/signals/{signal_id}/sink/"=>{"post"=>{"summary"=>"Create Data Points", "description"=>"Every Signal needs a series of Data Points for the API to do its job.\n\nUnlike the other endpoints, the Data Point sink accepts three content types for uploading your data:\n- `application/json`: A JSON array of Data Points.\n- `application/x-ldjson`: A list of JSON Data Points, one on each line.\n- `text/csv`: A list of Data Points with each column comma-separated, and column names on the first row.\n\nAs a rule of thumb, you should limit the number of records you upload with any single request to 1,000. If you use the CSV format, make sure to repeat the CSV header with each call.\n\nThe global rate limit applies, but to prevent any disruption on critical aspects of your systems, this endpoint will never respond with a `402 Payment Required` in case your subscription expires.\n\nWhen required details are missing for some Data Points, instead of rejecting the whole batch, the valid Data Points will be accepted, and the invalid ones will be returned as an array in the body of the response along with a description of the problem.\nIf this is the case, the response code will be `202 Accepted` instead of `201 Created`.", "operationId"=>"V1SignalsSinkBySignalIdPost", "x-api-path-slug"=>"v1signalssignal-idsink-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"signal_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signals", "Signal", "Sink"]}}, "/oauth2/revoke/"=>{"post"=>{"summary"=>"Revoking an Access Token", "description"=>"Access Tokens never expire so once you have it, it's yours for the life of your PredictHQ API subscription.\n\nHowever, if you think your token may have been compromised, you have the power to revoke it at any time.", "operationId"=>"Oauth2RevokePost", "x-api-path-slug"=>"oauth2revoke-post", "parameters"=>[{"in"=>"formData", "name"=>"token"}, {"in"=>"formData", "name"=>"token_type_hint"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Oauth2", "Revoke"]}}, "/v1/accounts/self/"=>{"get"=>{"summary"=>"Retrieve Account Details", "description"=>"If you need your account details for whatever reason, it's really easy to get them.", "operationId"=>"V1AccountsSelfGet", "x-api-path-slug"=>"v1accountsself-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Self"]}}, "/v1/signals/"=>{"get"=>{"summary"=>"Retrieve All Signals", "description"=>"It's easy to get a list of all Signals that are associated with your account.", "operationId"=>"V1SignalsGet", "x-api-path-slug"=>"v1signals-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signals"]}, "post"=>{"summary"=>"Create a Signal", "description"=>"Before you do anything else, you need to create a new Signal that represents a time series that's important to your business.", "operationId"=>"V1SignalsPost", "x-api-path-slug"=>"v1signals-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signals"]}}, "/v1/events/calendar/"=>{"get"=>{"summary"=>"Retrieve Events Calendar", "description"=>"This endpoint accepts the same parameters as the ones described in Retrieve All Events and can be used to get a calendar view of all matching events that are available to your account.\n\nEach day in the calendar contains aggregate counts of all _active_ events for that day.", "operationId"=>"V1EventsCalendarGet", "x-api-path-slug"=>"v1eventscalendar-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Calendar"]}}, "/v1/events/count/"=>{"get"=>{"summary"=>"Retrieve Events Count", "description"=>"This endpoint accepts the same parameters as the ones described in Retrieve All Events and can be used to get aggregated counts of all matching events that are available to your account.", "operationId"=>"V1EventsCountGet", "x-api-path-slug"=>"v1eventscount-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Count"]}}, "/v1/events/"=>{"get"=>{"summary"=>"Retrieve All Events", "description"=>"Use the below parameters to search and filter all events that are available to your account.", "operationId"=>"V1EventsGet", "x-api-path-slug"=>"v1events-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/oauth2/token/"=>{"post"=>{"summary"=>"Requesting an Access Token", "description"=>"When requesting an Access Token, use the `client_credentials` grant type, then request the scope or scopes you wish to have access to.\n\nThese scopes can be any or all of the following, separated by a space:\n - `account` Grants access to the account endpoint.\n - `events` Grants access to the events endpoint.\n - `places` Grants access to the places endpoint.\n - `signals` Grants access to the signals endpoint.\n\nPlease note that Access Tokens requested via the client_credentials grant type never expire.", "operationId"=>"Oauth2TokenPost", "x-api-path-slug"=>"oauth2token-post", "parameters"=>[{"in"=>"formData", "name"=>"grant_type"}, {"in"=>"formData", "name"=>"scope"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Oauth2", "Token"]}}, "/v1/signals/{signal_id}/dimensions/"=>{"get"=>{"summary"=>"Retrieve All Dimensions", "description"=>"This action returns a summary for each dimension of your Signal.", "operationId"=>"V1SignalsDimensionsBySignalIdGet", "x-api-path-slug"=>"v1signalssignal-iddimensions-get", "parameters"=>[{"in"=>"path", "name"=>"signal_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signals", "Signal", "Dimensions"]}}}}, "apis"=>{"name"=>"PredictHQ", "x-slug"=>"predicthq", "description"=>"Event visibility yields higher returns & reduces operational costs. PredictHQ is the worlds largest source of intelligent event data making businesses smarter.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28211-predicthq.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"292227", "tags"=>"API Provider,Events,Profiles,Relative Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"predicthq/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"PredictHQ", "x-api-slug"=>"predicthq", "description"=>"Event visibility yields higher returns & reduces operational costs. PredictHQ is the worlds largest source of intelligent event data making businesses smarter.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28211-predicthq.jpg", "humanURL"=>"http://www.predicthq.com/", "baseURL"=>"https://api.predicthq.com//", "tags"=>"API Provider,Events,Profiles,Relative Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/predicthq/v1signalssignal-iddimensions-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/predicthq/predicthq-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://www.predicthq.com/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/predicthq"}, {"type"=>"x-email", "url"=>"support@predicthq.com"}, {"type"=>"x-email", "url"=>"8Bsupport@predicthq.com"}, {"type"=>"x-email", "url"=>"notices@predicthq.com"}, {"type"=>"x-github", "url"=>"https://github.com/predicthq"}, {"type"=>"x-linkedin", "url"=>"PredictHQ"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/PredictHQ"}, {"type"=>"x-website", "url"=>"https://developer.predicthq.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-s3{"aws-s3-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS S3", "x-complete"=>1, "info"=>{"title"=>"No Title", "version"=>"1.0.0"}, "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/"=>{"delete"=>{"summary"=>"DELETE Bucket", "description"=>"This implementation of the DELETE operation deletes the bucket named inthe URI", "operationId"=>"delete-bucket", "x-api-path-slug"=>"delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket"]}, "head"=>{"summary"=>"HEAD Bucket", "description"=>"This operation is useful to determine if a bucket exists and you have permission to accessit", "operationId"=>"head-bucket", "x-api-path-slug"=>"head", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket"]}, "post"=>{"summary"=>"POST Object", "description"=>"The POST operation adds an object to a specified bucket using HTML forms", "operationId"=>"post-object", "x-api-path-slug"=>"post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object"]}, "put"=>{"summary"=>"PUT Bucket", "description"=>"This implementation of the PUT operation creates a new bucket", "operationId"=>"put-bucket", "x-api-path-slug"=>"put", "parameters"=>[{"in"=>"header", "name"=>"x-amz-acl", "description"=>"The canned ACL to apply to the bucket you are creating"}, {"in"=>"header", "name"=>"x-amz-grant-full-control", "description"=>"Allows grantee the READ, WRITE, READ_ACP, and WRITE_ACP permissions on thettttttttttttbucket"}, {"in"=>"header", "name"=>"x-amz-grant-read", "description"=>"Allows grantee to list the objects in the bucket"}, {"in"=>"header", "name"=>"x-amz-grant-read-acp", "description"=>"Allows grantee to read the bucket ACL"}, {"in"=>"header", "name"=>"x-amz-grant-write", "description"=>"Allows grantee to create, overwrite, and delete any object in the bucket"}, {"in"=>"header", "name"=>"x-amz-grant-write-acp", "description"=>"Allows grantee to write the ACL for the applicable bucket"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket"]}}, "/?accelerate"=>{"get"=>{"summary"=>"GET Bucket accelerate", "description"=>"This implementation of the GET operation uses the acceleratesubresource to return the Transfer Acceleration state of a bucket, which is eitherEnabled or Suspended", "operationId"=>"get-bucket-accelerate", "x-api-path-slug"=>"accelerate-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Accelerate"]}, "put"=>{"summary"=>"PUT Bucket accelerate", "description"=>"This implementation of the PUT operation uses the acceleratesubresource to set the Transfer Acceleration state of an existing bucket", "operationId"=>"put-bucket-accelerate", "x-api-path-slug"=>"accelerate-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Accelerate"]}}, "/?acl"=>{"get"=>{"summary"=>"GET Bucket ACL", "description"=>"This implementation of the GET operation uses the aclsubresource to return the access control list (ACL) of a bucket", "operationId"=>"get-bucket-acl", "x-api-path-slug"=>"acl-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "ACL"]}, "put"=>{"summary"=>"PUT Bucket ACL", "description"=>"This implementation of the PUT operation uses the aclsubresource to set the permissions on an existing bucket using access control lists(ACL)", "operationId"=>"put-bucket-acl", "x-api-path-slug"=>"acl-put", "parameters"=>[{"in"=>"header", "name"=>"x-amz-acl", "description"=>"Sets the ACL of the bucket using the specified canned ACL"}, {"in"=>"header", "name"=>"x-amz-grant-full-control", "description"=>"Allows the specified grantee(s) the READ, WRITE, READ_ACP, and WRITE_ACPtttttttttpermissions on the bucket"}, {"in"=>"header", "name"=>"x-amz-grant-read", "description"=>"Allows the specified grantee(s) to list the objects in the bucket"}, {"in"=>"header", "name"=>"x-amz-grant-read-acp", "description"=>"Allows the specified grantee(s) to read the bucket ACL"}, {"in"=>"header", "name"=>"x-amz-grant-write", "description"=>"Allows the specified grantee(s) to create, overwrite, and delete any object in thetttttttttbucket"}, {"in"=>"header", "name"=>"x-amz-grant-write-acp", "description"=>"Allows the specified grantee(s) to write the ACL for the applicabletttttttttbucket"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "ACL"]}}, "/?analytics"=>{"get"=>{"summary"=>"List Bucket Analytics Configurations", "description"=>"This implementation of the GET operation returns a list of analyticsconfigurations for the bucket", "operationId"=>"list-bucket-analytics-configurations", "x-api-path-slug"=>"analytics-get", "parameters"=>[{"in"=>"query", "name"=>"ContinuationToken", "description"=>"The marker that is used to continue an analytics configuration listing that has beenttttttttttruncated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Bucket", "Analytics", "Configurations"]}}, "/?analytics&id=analytics-configuration-ID"=>{"delete"=>{"summary"=>"DELETE Bucket analyticsnttconfiguration", "description"=>"This implementation of the DELETE operation deletes an analytics configuration(identified by the analytics configuration ID) from the bucket", "operationId"=>"delete-bucket-analyticsconfiguration", "x-api-path-slug"=>"analyticsampidanalyticsconfigurationid-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The ID that identifies the analytics configuration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Analyticsnttconfiguration"]}, "get"=>{"summary"=>"GET Bucket analytics configuration", "description"=>"This implementation of the GET operation returns an analytics configuration (identified bythe analytics configuration ID) from the bucket", "operationId"=>"get-bucket-analytics-configuration", "x-api-path-slug"=>"analyticsampidanalyticsconfigurationid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Analytics", "Configuration"]}}, "/?analytics&id=configuration-ID"=>{"put"=>{"summary"=>"PUT Bucket analytics configuration", "description"=>"This implementation of the PUT operation adds an analytics configuration(identified by the analytics ID) to the bucket", "operationId"=>"put-bucket-analytics-configuration", "x-api-path-slug"=>"analyticsampidconfigurationid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Analytics", "Configuration"]}}, "/?cors"=>{"delete"=>{"summary"=>"DELETE Bucket CORS", "description"=>"Deletes the cors configuration information set for the bucket", "operationId"=>"delete-bucket-cors", "x-api-path-slug"=>"cors-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "CORS"]}, "get"=>{"summary"=>"GET Bucket CORS", "description"=>"Returns the cors configuration information set for thebucket", "operationId"=>"get-bucket-cors", "x-api-path-slug"=>"cors-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "CORS"]}}, "/?delete"=>{"post"=>{"summary"=>"Delete Multiple Objects", "description"=>"The Multi-Object Delete operation enables you to delete multiple objects from a bucketusing a single HTTP request", "operationId"=>"delete-multiple-objects", "x-api-path-slug"=>"delete-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Length", "description"=>"Length of the body according to RFC 2616"}, {"in"=>"header", "name"=>"Content-MD5", "description"=>"The base64-encoded 128-bit MD5 digest of the data"}, {"in"=>"header", "name"=>"x-amz-mfa", "description"=>"The value is the concatenation of the authentication devices serial number, a space,tttttttttand the value that is displayed on your authenticationtttttttttdevice"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multiple", "Objects"]}}, "/?inventory"=>{"get"=>{"summary"=>"List Bucket Inventory Configurations", "description"=>"This implementation of the GET operation returns a list of inventoryconfigurations for the bucket", "operationId"=>"list-bucket-inventory-configurations", "x-api-path-slug"=>"inventory-get", "parameters"=>[{"in"=>"query", "name"=>"ContinuationToken", "description"=>"The marker that is used to continue an inventory configuration listing that has beenttttttttttruncated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Bucket", "Inventory", "Configurations"]}}, "/?inventory&id=configuration-ID"=>{"put"=>{"summary"=>"PUT Bucket inventory configuration", "description"=>"This implementation of the PUT operation adds an inventory configuration(identified by the inventory ID) to the bucket", "operationId"=>"put-bucket-inventory-configuration", "x-api-path-slug"=>"inventoryampidconfigurationid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Inventory", "Configuration"]}}, "/?inventory&id=inventory-configuration-ID"=>{"delete"=>{"summary"=>"DELETE Bucket inventory configuration", "description"=>"This implementation of the DELETE operation deletes an inventory configuration(identified by the inventory configuration ID) from the bucket", "operationId"=>"delete-bucket-inventoryconfiguration", "x-api-path-slug"=>"inventoryampidinventoryconfigurationid-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The ID that identifies the inventory configuration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Inventory", "Configuration"]}, "get"=>{"summary"=>"GET Bucket inventory configuration", "description"=>"This implementation of the GET operation returns an inventory configuration (identified bythe inventory configuration ID) from the bucket", "operationId"=>"get-bucket-inventory-configuration", "x-api-path-slug"=>"inventoryampidinventoryconfigurationid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Inventory", "Configuration"]}}, "/?lifecycle"=>{"delete"=>{"summary"=>"DELETE Bucket lifecycle", "description"=>"Deletes the lifecycle configuration from the specified bucket", "operationId"=>"delete-bucket-lifecycle", "x-api-path-slug"=>"lifecycle-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Lifecycle"]}, "get"=>{"summary"=>"GET Bucket lifecycle", "description"=>"NoteBucket lifecycle configuration now supports specifying lifecycle rule usingobject key name prefix, one or more object tags, or combination of both", "operationId"=>"get-bucket-lifecycle", "x-api-path-slug"=>"lifecycle-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Lifecycle"]}, "put"=>{"summary"=>"PUT Bucket lifecycle", "description"=>"Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration", "operationId"=>"put-bucket-lifecycle", "x-api-path-slug"=>"lifecycle-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Lifecycle"]}}, "/?list-type=2"=>{"get"=>{"summary"=>"GET Bucket (List Objects) Version 2", "description"=>"This implementation of the GET operation returns some or all (up to 1,000) ofthe objects in a bucket", "operationId"=>"get-bucket-list-objects-version-2", "x-api-path-slug"=>"listtype2-get", "parameters"=>[{"in"=>"query", "name"=>"continuation-token", "description"=>"When the Amazon S3 response to this API call is truncated (that is, IsTruncated responsetttttttttelement value is true), the response also includes thettttttttttNextContinuationToken element, the value of whichtttttttttyou can use in the next request as thettttttttttcontinuation-token to list the next settttttttttof objects"}, {"in"=>"query", "name"=>"delimiter", "description"=>"A delimiter is a character you use to group keys"}, {"in"=>"query", "name"=>"encoding-type", "description"=>"Requests Amazon S3 to encode the response and specifies the encoding method totttttttttuse"}, {"in"=>"query", "name"=>"fetch-owner", "description"=>"By default, the API does not return the Owner information in the response"}, {"in"=>"query", "name"=>"list-type", "description"=>"Version 2 of the API requires this parameter and you must set its value to 2"}, {"in"=>"query", "name"=>"max-keys", "description"=>"Sets the maximum number of keys returned in the response body"}, {"in"=>"query", "name"=>"prefix", "description"=>"Limits the response to keys that begin with the specifiedtttttttttprefix"}, {"in"=>"query", "name"=>"start-after", "description"=>"If you want the API to return key names after a specifictttttttttobject key in your key space, you can add this parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "(List", "Objects)", "Version", "2"]}}, "/?location"=>{"get"=>{"summary"=>"GET Bucket location", "description"=>"This implementation of the GET operation uses thelocation subresource to return a bucket's region", "operationId"=>"get-bucket-location", "x-api-path-slug"=>"location-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Location"]}}, "/?logging"=>{"get"=>{"summary"=>"GET Bucket logging", "description"=>"This implementation of the GET operation uses thelogging subresource to return the logging status of a bucketand the permissions users have to view and modify that status", "operationId"=>"get-bucket-logging", "x-api-path-slug"=>"logging-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Logging"]}}, "/?metrics"=>{"get"=>{"summary"=>"List Bucket Metrics", "description"=>"Lists the metrics configurations for the CloudWatch request metrics of the bucket", "operationId"=>"list-bucket-metrics", "x-api-path-slug"=>"metrics-get", "parameters"=>[{"in"=>"query", "name"=>"BucketName", "description"=>"The name of the bucket containing the metrics configurationstttttttttto retrieve"}, {"in"=>"query", "name"=>"ContinuationToken", "description"=>"The marker that is used to continue a metrics configurationtttttttttlisting that has been truncated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Bucket", "Metrics"]}}, "/?metrics&id=Id"=>{"delete"=>{"summary"=>"DELETE Bucket Metrics", "description"=>"Deletes a metrics configuration for the CloudWatch request metrics (specified by the metricsconfiguration ID) from the bucket", "operationId"=>"delete-bucket-metrics", "x-api-path-slug"=>"metricsampidid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Metrics"]}, "put"=>{"summary"=>"PUT Bucket Metrics", "description"=>"Sets or updates a metrics configuration for the CloudWatch request metrics (specified by themetrics configuration ID) from the bucket", "operationId"=>"put-bucket-metrics", "x-api-path-slug"=>"metricsampidid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Metrics"]}}, "/?metrics&id=id"=>{"get"=>{"summary"=>"GET Bucket Metrics", "description"=>"Gets a metrics configuration for the CloudWatch request metrics (specified by the metricsconfiguration ID) from the bucket", "operationId"=>"get-bucket-metrics", "x-api-path-slug"=>"metricsampidid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Metrics"]}}, "/?notification"=>{"get"=>{"summary"=>"GET Bucket notification", "description"=>"This implementation of the GET operation uses thenotification subresource to return the notificationconfiguration of a bucket", "operationId"=>"get-bucket-notification", "x-api-path-slug"=>"notification-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Notification"]}, "put"=>{"summary"=>"PUT Bucket notification", "description"=>"The Amazon S3 notification feature enables you to receive notifications when certain eventshappen in your bucket", "operationId"=>"put-bucket-notification", "x-api-path-slug"=>"notification-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Notification"]}}, "/?policy"=>{"delete"=>{"summary"=>"DELETE Bucket policy", "description"=>"This implementation of the DELETE operation uses the policy subresource to delete the policy on a specified bucket", "operationId"=>"delete-bucket-policy", "x-api-path-slug"=>"policy-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Policy"]}, "get"=>{"summary"=>"GET Bucket policy", "description"=>"This implementation of the GET operation uses the policysubresource to return the policy of a specified bucket", "operationId"=>"get-bucket-policy", "x-api-path-slug"=>"policy-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Policy"]}, "put"=>{"summary"=>"PUT Bucket policy", "description"=>"This implementation of the PUT operation uses the policysubresource to add to or replace a policy on a bucket", "operationId"=>"put-bucket-policy", "x-api-path-slug"=>"policy-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Policy"]}}, "/?replication"=>{"delete"=>{"summary"=>"DELETE Bucket replication", "description"=>"Deletes the replication subresource associated with the specified bucket", "operationId"=>"delete-bucket-replication", "x-api-path-slug"=>"replication-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Replication"]}, "get"=>{"summary"=>"GET Bucket replication", "description"=>"Returns the replication configuration information set on the bucket", "operationId"=>"get-bucket-replication", "x-api-path-slug"=>"replication-get", "parameters"=>[{"in"=>"query", "name"=>"AWS Documentation » Amazon Simple Storage Service (S3) » API Reference » Operations on Buckets » GET Bucket replication"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Replication"]}, "put"=>{"summary"=>"PUT Bucket replication", "description"=>"In a versioning-enabled bucket, this operation creates a new replication configuration (or replaces an existing one, if present)", "operationId"=>"put-bucket-replication", "x-api-path-slug"=>"replication-put", "parameters"=>[{"in"=>"query", "name"=>"AWS Documentation » Amazon Simple Storage Service (S3) » API Reference » Operations on Buckets » PUT Bucket replication"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Replication"]}}, "/?tagging"=>{"delete"=>{"summary"=>"DELETE Bucket tagging", "description"=>"This implementation of the DELETE operation uses the taggingsubresource to remove a tag set from the specified bucket", "operationId"=>"delete-bucket-tagging", "x-api-path-slug"=>"tagging-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Tagging"]}, "get"=>{"summary"=>"GET Bucket tagging", "description"=>"This implementation of the GET operation uses the taggingsubresource to return the tag set associated with the bucket", "operationId"=>"get-bucket-tagging", "x-api-path-slug"=>"tagging-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Tagging"]}, "put"=>{"summary"=>"PUT Bucket tagging", "description"=>"This implementation of the PUT operation uses the taggingsubresource to add a set of tags to an existing bucket", "operationId"=>"put-bucket-tagging", "x-api-path-slug"=>"tagging-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Tagging"]}}, "/?uploads"=>{"get"=>{"summary"=>"List Multipart Uploads", "description"=>"This operation lists in-progress multipart uploads", "operationId"=>"list-multipart-uploads", "x-api-path-slug"=>"uploads-get", "parameters"=>[{"in"=>"query", "name"=>"delimiter", "description"=>"Character you use to group keys"}, {"in"=>"query", "name"=>"encoding-type", "description"=>"Requests Amazon S3 to encode the response and specifies the encoding method totttttttttuse"}, {"in"=>"query", "name"=>"key-marker", "description"=>"Together with upload-id-marker, this parameter specifies the multiparttttttttttupload after which listing should begin"}, {"in"=>"query", "name"=>"max-uploads", "description"=>"Sets the maximum number of multipart uploads, from 1 to 1,000, to return in thetttttttttresponse body"}, {"in"=>"query", "name"=>"prefix", "description"=>"Lists in-progress uploads only for those keys that begin with the specified prefix"}, {"in"=>"query", "name"=>"upload-id-marker", "description"=>"Together with key-marker, specifies the multipart upload after whichtttttttttlisting should begin"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Multipart", "Uploads"]}}, "/?versioning"=>{"get"=>{"summary"=>"GET Bucket versioning", "description"=>"This implementation of the GET operation uses theversioning subresource to return the versioning state of abucket", "operationId"=>"get-bucket-versioning", "x-api-path-slug"=>"versioning-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Versioning"]}, "put"=>{"summary"=>"PUT Bucket versioning", "description"=>"This implementation of the PUT operation uses theversioning subresource to set the versioning state of anexisting bucket", "operationId"=>"put-bucket-versioning", "x-api-path-slug"=>"versioning-put", "parameters"=>[{"in"=>"header", "name"=>"x-amz-mfa", "description"=>"The value is the concatenation of the authenticationtttttttttdevices serial number, a space, and the value displayed on yourtttttttttauthentication device"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Versioning"]}}, "/?versions"=>{"get"=>{"summary"=>"GET Bucket Object versions", "description"=>"You can use the versions subresource to list metadata about all ofthe versions of objects in a bucket", "operationId"=>"get-bucket-object-versions", "x-api-path-slug"=>"versions-get", "parameters"=>[{"in"=>"query", "name"=>"delimiter", "description"=>"A delimiter is a character that you specify to group keys"}, {"in"=>"query", "name"=>"encoding-type", "description"=>"Requests Amazon S3 to encode the response and specifies the encoding method totttttttttuse"}, {"in"=>"query", "name"=>"key-marker", "description"=>"Specifies the key in the bucket that you want to start listingtttttttttfrom"}, {"in"=>"query", "name"=>"max-keys", "description"=>"Sets the maximum number of keys returned in the response body"}, {"in"=>"query", "name"=>"prefix", "description"=>"Use this parameter to select only those keys that begin withtttttttttthe specified prefix"}, {"in"=>"query", "name"=>"version-id-marker", "description"=>"Specifies the object version you want to start listing from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Object", "Versions"]}}, "/?website"=>{"delete"=>{"summary"=>"DELETE Bucket website", "description"=>"This operation removes the website configuration for a bucket", "operationId"=>"delete-bucket-website", "x-api-path-slug"=>"website-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Website"]}, "get"=>{"summary"=>"GET Bucket website", "description"=>"This implementation of the GET operation returns the website configurationassociated with a bucket", "operationId"=>"get-bucket-website", "x-api-path-slug"=>"website-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Website"]}, "put"=>{"summary"=>"PUT Bucket website", "description"=>"Sets the configuration of the website that is specified in thewebsite subresource", "operationId"=>"put-bucket-website", "x-api-path-slug"=>"website-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "Website"]}}, "/destinationObject"=>{"put"=>{"summary"=>"PUT Object - Copy", "description"=>"This implementation of the PUT operation creates a copy of an object that is already stored in Amazon S3", "operationId"=>"put-object--copy", "x-api-path-slug"=>"destinationobject-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object", "-", "Copy"]}}, "/ObjectName"=>{"delete"=>{"summary"=>"DELETE Object", "description"=>"The DELETE operation removes the null version (if there is one) of anobject and inserts a delete marker, which becomes the current version of the object", "operationId"=>"delete-object", "x-api-path-slug"=>"objectname-delete", "parameters"=>[{"in"=>"header", "name"=>"x-amz-mfa", "description"=>"The value is the concatenation of the authenticationtttttttttdevices serial number, a space, and the value displayed on yourtttttttttauthentication device"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object"]}, "get"=>{"summary"=>"GET Object", "description"=>"This implementation of the GET operation retrieves objects from Amazon S3", "operationId"=>"get-object", "x-api-path-slug"=>"objectname-get", "parameters"=>[{"in"=>"query", "name"=>"response-cache-control", "description"=>"Sets the Cache-Control header of the response"}, {"in"=>"query", "name"=>"response-content-disposition", "description"=>"Sets the Content-Disposition header of thetttttttttresponse"}, {"in"=>"query", "name"=>"response-content-encoding", "description"=>"Sets the Content-Encoding header of the response"}, {"in"=>"query", "name"=>"response-content-language", "description"=>"Sets the Content-Language header of thetttttttttresponse"}, {"in"=>"query", "name"=>"response-content-type", "description"=>"Sets the Content-Type header of thetttttttttresponse"}, {"in"=>"query", "name"=>"response-expires", "description"=>"Sets the Expires header of the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object"]}, "head"=>{"summary"=>"HEAD Object", "description"=>"The HEAD operation retrieves metadata from an object without returning theobject itself", "operationId"=>"head-object", "x-api-path-slug"=>"objectname-head", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed)"}, {"in"=>"header", "name"=>"If-Modified-Since", "description"=>"Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified)"}, {"in"=>"header", "name"=>"If-None-Match", "description"=>"Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified)"}, {"in"=>"header", "name"=>"If-Unmodified-Since", "description"=>"Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed)"}, {"in"=>"header", "name"=>"Range", "description"=>"Downloads the specified range bytes of an object"}, {"in"=>"header", "name"=>"x-amz-server-side-encryption-customer-algorithm", "description"=>"Specifies the algorithm to use to when decrypting the requested object"}, {"in"=>"header", "name"=>"x-amz-server-side-encryption-customer-key", "description"=>"Specifies the customer-provided base64-encoded encryption key to use to decrypt the requested object"}, {"in"=>"header", "name"=>"x-amz-server-side-encryption-customer-key-MD5", "description"=>"Specifies the base64-encoded 128-bit MD5 digest of the customer-provided encryption key according to ttttRFC 1321"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object"]}, "options"=>{"summary"=>"OPTIONS object", "description"=>"A browser can send this preflight request to Amazon S3 to determine if it can send an actualrequest with the specific origin, HTTP method, and headers", "operationId"=>"options-object", "x-api-path-slug"=>"objectname-options", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OPTIONS", "Object"]}, "put"=>{"summary"=>"PUT Object", "description"=>"This implementation of the PUT operation adds an object to a bucket", "operationId"=>"put-object", "x-api-path-slug"=>"objectname-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object"]}}, "/ObjectName?acl"=>{"get"=>{"summary"=>"GET Object ACL", "description"=>"This implementation of the GET operation uses the aclsubresource to return the access control list (ACL) of an object", "operationId"=>"get-object-acl", "x-api-path-slug"=>"objectnameacl-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object", "ACL"]}, "put"=>{"summary"=>"PUT Object ACL", "description"=>"This implementation of the PUT operation uses the aclsubresource to set the access control list (ACL) permissions for an object that alreadyexists in a bucket", "operationId"=>"put-object-acl", "x-api-path-slug"=>"objectnameacl-put", "parameters"=>[{"in"=>"header", "name"=>"x-amz-acl", "description"=>"Sets the ACL of the object using the specified canned ACL"}, {"in"=>"header", "name"=>"x-amz-grant-full-control", "description"=>"Allows the specified grantee the READ, WRITE, READ_ACP, andtttttttttWRITE_ACP permissions on the bucket"}, {"in"=>"header", "name"=>"x-amz-grant-read", "description"=>"Allows the specified grantee to list the objects in thetttttttttbucket"}, {"in"=>"header", "name"=>"x-amz-grant-read-acp", "description"=>"Allows the specified grantee to read the buckettttttttttACL"}, {"in"=>"header", "name"=>"x-amz-grant-write", "description"=>"Not applicable when granting access permissions on objects"}, {"in"=>"header", "name"=>"x-amz-grant-write-acp", "description"=>"Allows the specified grantee to write the ACL for thetttttttttapplicable bucket"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object", "ACL"]}}, "/ObjectName?partNumber=PartNumber&uploadId=UploadId"=>{"put"=>{"summary"=>"Upload Part", "description"=>"This operation uploads a part in a multipart upload", "operationId"=>"upload-part", "x-api-path-slug"=>"objectnamepartnumberpartnumberampuploadiduploadid-put", "parameters"=>[{"in"=>"query", "name"=>"AWS Documentation » Amazon Simple Storage Service (S3) » API Reference » Operations on Objects » Upload Part - Copy"}, {"in"=>"header", "name"=>"Content-Length", "description"=>"The size of the part, in bytes"}, {"in"=>"header", "name"=>"Content-MD5", "description"=>"The base64-encoded 128-bit MD5 digest of the part data"}, {"in"=>"header", "name"=>"Expect", "description"=>"When your application uses 100-continue, it does not send the request body until ittttttttttreceives an acknowledgment"}, {"in"=>"header", "name"=>"x-amz-copy-source", "description"=>"The name of the source bucket and the source object key name separated by a slash (/)"}, {"in"=>"header", "name"=>"x-amz-copy-source-server-side-encryption-customer-algorithm", "description"=>"Specifies algorithm to use when decrypting the source object"}, {"in"=>"header", "name"=>"x-amz-copy-source-server-side-encryption-customer-key", "description"=>"Specifies the customer provided base-64 encoded encryption key for Amazon S3 to use to decrypt the source object"}, {"in"=>"header", "name"=>"x-amz-copy-source-server-side-encryption-customer-key-MD5", "description"=>"Specifies the base64-encoded 128-bit MD5 digest of the encryption key according to RFC 1321"}, {"in"=>"header", "name"=>"x-amz-copy-source-if-match", "description"=>"Perform a copy if the source object entity tag (ETag) matches the specified value"}, {"in"=>"header", "name"=>"x-amz-copy-source-if-modified-since", "description"=>"Perform a copy if the source object is modified after the time specified using this header"}, {"in"=>"header", "name"=>"x-amz-copy-source-if-none-match", "description"=>"Perform a copy if the source object entity tag (ETag) is different than the value specified using this header"}, {"in"=>"header", "name"=>"x-amz-copy-source-if-unmodified-since", "description"=>"Perform a copy if the source object is not modified after the time specified using this header"}, {"in"=>"header", "name"=>"x-amz-copy-source-range", "description"=>"The range of bytes to copy from the source object"}, {"in"=>"header", "name"=>"x-amz-server-side-encryption-customer-algorithm", "description"=>"Specifies the algorithm to use to when encrypting the object"}, {"in"=>"header", "name"=>"x-amz-server-side-encryption-customer-key", "description"=>"Specifies the customer-provided base64-encoded encryption key for Amazon S3 to use intttttttttttttencrypting data"}, {"in"=>"header", "name"=>"x-amz-server-side-encryption-customer-key-MD5", "description"=>"Specifies the base64-encoded 128-bit MD5 digest of the encryption key according to RFC 1321"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Part"]}}, "/ObjectName?restore&versionId=VersionID"=>{"post"=>{"summary"=>"POST Object restore", "description"=>"Restores a temporary copy of an archived object", "operationId"=>"post-object-restore", "x-api-path-slug"=>"objectnamerestoreampversionidversionid-post", "parameters"=>[{"in"=>"header", "name"=>"Content-MD5", "description"=>"The base64-encoded 128-bit MD5 digest of the data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object", "Restore"]}}, "/ObjectName?tagging"=>{"get"=>{"summary"=>"GET Object tagging", "description"=>"This implementation of the GET operation returns the tags associated with anobject", "operationId"=>"get-object-tagging", "x-api-path-slug"=>"objectnametagging-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object", "Tagging"]}, "put"=>{"summary"=>"PUT Object tagging", "description"=>"This implementation of the PUT operation uses the taggingsubresource to add a set of tags to an existing object", "operationId"=>"put-object-tagging", "x-api-path-slug"=>"objectnametagging-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object", "Tagging"]}}, "/ObjectName?torrent"=>{"get"=>{"summary"=>"GET Object torrent", "description"=>"This implementation of the GET operation uses thetorrent subresource to return torrent files from a bucket", "operationId"=>"get-object-torrent", "x-api-path-slug"=>"objectnametorrent-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object", "Torrent"]}}, "/ObjectName?uploadId=UploadId"=>{"delete"=>{"summary"=>"Abort Multipart Upload", "description"=>"This operation aborts a multipart upload", "operationId"=>"abort-multipart-upload", "x-api-path-slug"=>"objectnameuploadiduploadid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Abort", "Multipart", "Upload"]}, "get"=>{"summary"=>"List Parts", "description"=>"This operation lists the parts that have been uploaded for a specific multipart upload", "operationId"=>"list-parts", "x-api-path-slug"=>"objectnameuploadiduploadid-get", "parameters"=>[{"in"=>"query", "name"=>"encoding-type", "description"=>"Requests Amazon S3 to encode the response and specifies the encoding method totttttttttuse"}, {"in"=>"query", "name"=>"max-parts", "description"=>"Sets the maximum number of parts to return in the response body"}, {"in"=>"query", "name"=>"part-number-marker", "description"=>"Specifies the part after which listing should begin"}, {"in"=>"query", "name"=>"uploadId", "description"=>"Upload ID identifying the multipart upload whose parts are being listed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Parts"]}, "post"=>{"summary"=>"Complete Multipart Upload", "description"=>"This operation completes a multipart upload by assembling previously uploaded parts", "operationId"=>"complete-multipart-upload", "x-api-path-slug"=>"objectnameuploadiduploadid-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Complete", "Multipart", "Upload"]}}, "/ObjectName?uploads"=>{"post"=>{"summary"=>"Initiate Multipart Upload", "description"=>"This operation initiates a multipart upload and returns an upload ID", "operationId"=>"initiate-multipart-upload", "x-api-path-slug"=>"objectnameuploads-post", "parameters"=>[{"in"=>"header", "name"=>"Cache-Control", "description"=>"Can be used to specify caching behavior along the request/reply chain"}, {"in"=>"header", "name"=>"Content-Disposition", "description"=>"Specifies presentational information for the object"}, {"in"=>"header", "name"=>"Content-Encoding", "description"=>"Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"A standard MIME type describing the format of the object data"}, {"in"=>"header", "name"=>"Expires", "description"=>"The date and time at which the object is no longer cacheable"}, {"in"=>"header", "name"=>"x-amz-acl", "description"=>"The canned ACL to apply to the object"}, {"in"=>"header", "name"=>"x-amz-grant-full-control", "description"=>"Allows grantee the READ, READ_ACP, and WRITE_ACP permissions on the object"}, {"in"=>"header", "name"=>"x-amz-grant-read", "description"=>"Allows grantee to read the object data and its metadata"}, {"in"=>"header", "name"=>"x-amz-grant-read-acp", "description"=>"Allows grantee to read the object ACL"}, {"in"=>"header", "name"=>"x-amz-grant-write", "description"=>"Not applicable"}, {"in"=>"header", "name"=>"x-amz-grant-write-acp", "description"=>"Allows grantee to write the ACL for the applicable object"}, {"in"=>"header", "name"=>"x-amz-meta-", "description"=>"Headers starting with this prefix are user-defined metadata"}, {"in"=>"header", "name"=>"x-amz-server-side-encryption", "description"=>"Specifies a server-side encryption algorithm to use when Amazon S3 creates an object"}, {"in"=>"header", "name"=>"x-amz-server-side-encryption-customer-algorithm", "description"=>"Specifies the algorithm to use to when encrypting the object"}, {"in"=>"header", "name"=>"x-amz-server-side-encryption-customer-key", "description"=>"Specifies the customer-provided base64-encoded encryption key for Amazon S3 to use in encrypting data"}, {"in"=>"header", "name"=>"x-amz-server-side-encryption-customer-key-MD5", "description"=>"Specifies the base64-encoded 128-bit MD5 digest of the encryption key according to RFC 1321"}, {"in"=>"header", "name"=>"x-amz-server-side-encryption-aws-kms-key-id", "description"=>"If the x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object"}, {"in"=>"header", "name"=>"x-amz-server-side-encryption-context", "description"=>"If x-amz-server-side-encryption is present, and if its value is aws:kms, this header specifies the encryption context for the object"}, {"in"=>"header", "name"=>"x-amz-storage-class", "description"=>"The type of storage to use for the object that is created after successful multipart upload"}, {"in"=>"header", "name"=>"x-amz-website-redirect-location", "description"=>"If the bucket is configured as a website, redirect requests for this object to another object in the same bucket or to an external URL"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Initiate", "Multipart", "Upload"]}}, "?requestPayment"=>{"get"=>{"summary"=>"GET Bucket requestPayment", "description"=>"This implementation of the GET operation uses therequestPayment subresource to return the request paymentconfiguration of a bucket", "operationId"=>"get-bucket-requestpayment", "x-api-path-slug"=>"requestpayment-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "RequestPayment"]}, "put"=>{"summary"=>"PUT Bucket requestPayment", "description"=>"This implementation of the PUT operation uses therequestPayment subresource to set the request paymentconfiguration of a bucket", "operationId"=>"put-bucket-requestpayment", "x-api-path-slug"=>"requestpayment-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket", "RequestPayment"]}}, "ObjectKey/?tagging"=>{"delete"=>{"summary"=>"DELETE Object tagging", "description"=>"This implementation of the DELETE operation uses thetagging subresource to remove the entire tag set from thespecified object", "operationId"=>"delete-object-tagging", "x-api-path-slug"=>"objectkeytagging-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object", "Tagging"]}}}}, "apis"=>{"name"=>"AWS S3", "x-slug"=>"aws-s3", "description"=>"Amazon Simple Storage Service (Amazon S3) is object storage with a simple web service interface to store and retrieve any amount of data from anywhere on the web. It is designed to deliver 99.999999999% durability, and scale past trillions of objects worldwide.Customers use S3 as a bulk repository, or data lake, for analytics; backup & recovery; disaster recovery; and serverless computing. Many cloud-native applications even use S3 as primary storage.Its simple to move large volumes of data into or out of S3 with Amazonscloud data migrationoptions. Once data is stored in Amazon S3, it can be automatically tiered into lower cost, longer-termcloud storageclasses like S3 Standard - Infrequent Access and Amazon Glacier for archiving.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Storage-Content-Delivery_AmazonS3.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Profiles,Relative Data,Service API,Stack,Stack Network,Storage", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-s3/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS S3", "x-api-slug"=>"aws-s3", "description"=>"Amazon Simple Storage Service (Amazon S3) is object storage with a simple web service interface to store and retrieve any amount of data from anywhere on the web. It is designed to deliver 99.999999999% durability, and scale past trillions of objects worldwide.Customers use S3 as a bulk repository, or data lake, for analytics; backup & recovery; disaster recovery; and serverless computing. Many cloud-native applications even use S3 as primary storage.Its simple to move large volumes of data into or out of S3 with Amazonscloud data migrationoptions. Once data is stored in Amazon S3, it can be automatically tiered into lower cost, longer-termcloud storageclasses like S3 Standard - Infrequent Access and Amazon Glacier for archiving.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Storage-Content-Delivery_AmazonS3.png", "humanURL"=>"https://aws.amazon.com/s3/", "baseURL"=>"https:////", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Profiles,Relative Data,Service API,Stack,Stack Network,Storage", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-s3/objectkeytagging-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-s3/aws-s3-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/s3/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/s3/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/s3/pricing/"}, {"type"=>"x-sla", "url"=>"https://aws.amazon.com/s3/sla/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/s3/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
click-meter{"click-meter-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Click Meter", "x-complete"=>1, "info"=>{"title"=>"Click Meter", "description"=>"api-dashboard-for-clickmeter-api", "contact"=>{"name"=>"Api Support", "url"=>"http://www.clickmeter.com/api", "email"=>"api@clickmeter.com"}, "version"=>"v2"}, "host"=>"apiv2.clickmeter.com:80", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/account"=>{"get"=>{"summary"=>"Retrieve current account data", "description"=>"Retrieve current account data.", "operationId"=>"getAccount", "x-api-path-slug"=>"account-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}, "post"=>{"summary"=>"Update current account data", "description"=>"Update current account data.", "operationId"=>"postAccount", "x-api-path-slug"=>"account-post", "parameters"=>[{"in"=>"body", "name"=>"value", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/account/domainwhitelist"=>{"get"=>{"summary"=>"Retrieve list of a domains allowed to redirect in DDU mode", "description"=>"Retrieve list of a domains allowed to redirect in ddu mode.", "operationId"=>"getAccountDomainwhitelist", "x-api-path-slug"=>"accountdomainwhitelist-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limit results to this number"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset where to start from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Domainwhitelist"]}, "post"=>{"summary"=>"Create an domain entry", "description"=>"Create an domain entry.", "operationId"=>"postAccountDomainwhitelist", "x-api-path-slug"=>"accountdomainwhitelist-post", "parameters"=>[{"in"=>"body", "name"=>"value", "description"=>"The entry to add", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Domainwhitelist"]}}, "/account/domainwhitelist/{whitelistId}"=>{"delete"=>{"summary"=>"Delete an domain entry", "description"=>"Delete an domain entry.", "operationId"=>"deleteAccountDomainwhitelistWhitelist", "x-api-path-slug"=>"accountdomainwhitelistwhitelistid-delete", "parameters"=>[{"in"=>"path", "name"=>"whitelistId", "description"=>"The id of the domain to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Domainwhitelist", "WhitelistId"]}}, "/account/guests"=>{"get"=>{"summary"=>"Retrieve list of a guest", "description"=>"Retrieve list of a guest.", "operationId"=>"getAccountGuests", "x-api-path-slug"=>"accountguests-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limit results to this number"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset where to start from"}, {"in"=>"query", "name"=>"sortBy", "description"=>"Field to sort by"}, {"in"=>"query", "name"=>"sortDirection", "description"=>"Direction of sort asc or desc"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Guests"]}, "post"=>{"summary"=>"Create a guest", "description"=>"Create a guest.", "operationId"=>"postAccountGuests", "x-api-path-slug"=>"accountguests-post", "parameters"=>[{"in"=>"body", "name"=>"value", "description"=>"Guest object to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Guests"]}}, "/account/guests/count"=>{"get"=>{"summary"=>"Retrieve count of guests", "description"=>"Retrieve count of guests.", "operationId"=>"getAccountGuestsCount", "x-api-path-slug"=>"accountguestscount-get", "parameters"=>[{"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Guests", "Count"]}}, "/account/guests/{guestId}"=>{"delete"=>{"summary"=>"Delete a guest", "description"=>"Delete a guest.", "operationId"=>"deleteAccountGuestsGuest", "x-api-path-slug"=>"accountguestsguestid-delete", "parameters"=>[{"in"=>"path", "name"=>"guestId", "description"=>"Id of the guest"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Guests", "GuestId"]}, "get"=>{"summary"=>"Retrieve a guest", "description"=>"Retrieve a guest.", "operationId"=>"getAccountGuestsGuest", "x-api-path-slug"=>"accountguestsguestid-get", "parameters"=>[{"in"=>"path", "name"=>"guestId", "description"=>"Id of the guest"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Guests", "GuestId"]}, "post"=>{"summary"=>"Update a guest", "description"=>"Update a guest.", "operationId"=>"postAccountGuestsGuest", "x-api-path-slug"=>"accountguestsguestid-post", "parameters"=>[{"in"=>"path", "name"=>"guestId", "description"=>"Id of the guest"}, {"in"=>"body", "name"=>"value", "description"=>"Guest object with field updated", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Guests", "GuestId"]}}, "/account/guests/{guestId}/permissions"=>{"get"=>{"summary"=>"Retrieve permissions for a guest", "description"=>"Retrieve permissions for a guest.", "operationId"=>"getAccountGuestsGuestPermissions", "x-api-path-slug"=>"accountguestsguestidpermissions-get", "parameters"=>[{"in"=>"query", "name"=>"entityId", "description"=>"Optional id of the datapoint/group entity to filter by"}, {"in"=>"query", "name"=>"entityType", "description"=>"Can be datapoint or group"}, {"in"=>"path", "name"=>"guestId", "description"=>"Id of the guest"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit results to this number"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset where to start from"}, {"in"=>"query", "name"=>"type", "description"=>"Can be w or r"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Guests", "GuestId", "Permissions"]}}, "/account/guests/{guestId}/permissions/count"=>{"get"=>{"summary"=>"Retrieve count of the permissions for a guest", "description"=>"Retrieve count of the permissions for a guest.", "operationId"=>"getAccountGuestsGuestPermissionsCount", "x-api-path-slug"=>"accountguestsguestidpermissionscount-get", "parameters"=>[{"in"=>"query", "name"=>"entityId", "description"=>"Optional id of the datapoint/group entity to filter by"}, {"in"=>"query", "name"=>"entityType", "description"=>"Can be datapoint or group"}, {"in"=>"path", "name"=>"guestId", "description"=>"Id of the guest"}, {"in"=>"query", "name"=>"type", "description"=>"Can be w or r"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Guests", "GuestId", "Permissions", "Count"]}}, "/account/guests/{guestId}/{type}/permissions/patch"=>{"post"=>{"summary"=>"Change the permission on a shared object", "description"=>"Change the permission on a shared object.", "operationId"=>"postAccountGuestsGuestTypePermissionsPatch", "x-api-path-slug"=>"accountguestsguestidtypepermissionspatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The patch permission request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"guestId", "description"=>"Id of the guest"}, {"in"=>"path", "name"=>"type", "description"=>"Can be datapoint or group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Guests", "GuestId", "Type", "Permissions", "Patch"]}, "put"=>{"summary"=>"Change the permission on a shared object", "description"=>"Change the permission on a shared object.", "operationId"=>"putAccountGuestsGuestTypePermissionsPatch", "x-api-path-slug"=>"accountguestsguestidtypepermissionspatch-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The patch permission request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"guestId", "description"=>"Id of the guest"}, {"in"=>"path", "name"=>"type", "description"=>"Can be datapoint or group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Guests", "GuestId", "Type", "Permissions", "Patch"]}}, "/account/ipblacklist"=>{"get"=>{"summary"=>"Retrieve list of a ip to exclude from event tracking", "description"=>"Retrieve list of a ip to exclude from event tracking.", "operationId"=>"getAccountIpblacklist", "x-api-path-slug"=>"accountipblacklist-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limit results to this number"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset where to start from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Ipblacklist"]}, "post"=>{"summary"=>"Create an ip blacklist entry", "description"=>"Create an ip blacklist entry.", "operationId"=>"postAccountIpblacklist", "x-api-path-slug"=>"accountipblacklist-post", "parameters"=>[{"in"=>"body", "name"=>"value", "description"=>"The entry to add", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Ipblacklist"]}}, "/account/ipblacklist/{blacklistId}"=>{"delete"=>{"summary"=>"Delete an ip blacklist entry", "description"=>"Delete an ip blacklist entry.", "operationId"=>"deleteAccountIpblacklistBlacklist", "x-api-path-slug"=>"accountipblacklistblacklistid-delete", "parameters"=>[{"in"=>"path", "name"=>"blacklistId", "description"=>"The id of the ip to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Ipblacklist", "BlacklistId"]}}, "/account/plan"=>{"get"=>{"summary"=>"Retrieve current account plan", "description"=>"Retrieve current account plan.", "operationId"=>"getAccountPlan", "x-api-path-slug"=>"accountplan-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Plan"]}}, "/aggregated"=>{"get"=>{"summary"=>"Retrieve statistics about this customer for a timeframe", "description"=>"Retrieve statistics about this customer for a timeframe.", "operationId"=>"getAggregated", "x-api-path-slug"=>"aggregated-get", "parameters"=>[{"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"hourly", "description"=>"If using yesterday or today timeframe you can ask for the hourly detail"}, {"in"=>"query", "name"=>"onlyFavorites"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Aggregated"]}}, "/aggregated/list"=>{"get"=>{"summary"=>"Retrieve statistics about this customer for a timeframe grouped by some temporal entity (day/week/month)", "description"=>"Retrieve statistics about this customer for a timeframe grouped by some temporal entity (day/week/month).", "operationId"=>"getAggregatedList", "x-api-path-slug"=>"aggregatedlist-get", "parameters"=>[{"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"groupBy", "description"=>"The temporal entity you want to group by (week/month)"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Aggregated", "List"]}}, "/aggregated/summary/conversions"=>{"get"=>{"summary"=>"Retrieve statistics about a subset of conversions for a timeframe with conversions data", "description"=>"Retrieve statistics about a subset of conversions for a timeframe with conversions data.", "operationId"=>"getAggregatedSummaryConversions", "x-api-path-slug"=>"aggregatedsummaryconversions-get", "parameters"=>[{"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit results to this number"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset where to start from"}, {"in"=>"query", "name"=>"sortBy", "description"=>"Field to sort by"}, {"in"=>"query", "name"=>"sortDirection", "description"=>"Direction of sort asc or desc"}, {"in"=>"query", "name"=>"status", "description"=>"Status of conversion (deleted/active)"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Aggregated", "Summary", "Conversions"]}}, "/aggregated/summary/datapoints"=>{"get"=>{"summary"=>"Retrieve statistics about a subset of datapoints for a timeframe with datapoints data", "description"=>"Retrieve statistics about a subset of datapoints for a timeframe with datapoints data.", "operationId"=>"getAggregatedSummaryDatapoints", "x-api-path-slug"=>"aggregatedsummarydatapoints-get", "parameters"=>[{"in"=>"query", "name"=>"favourite", "description"=>"Is the datapoint marked as favourite"}, {"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"groupId", "description"=>"Filter by this group id"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit results to this number"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset where to start from"}, {"in"=>"query", "name"=>"sortBy", "description"=>"Field to sort by"}, {"in"=>"query", "name"=>"sortDirection", "description"=>"Direction of sort asc or desc"}, {"in"=>"query", "name"=>"status", "description"=>"Status of datapoint (deleted/active/paused/spam)"}, {"in"=>"query", "name"=>"tag", "description"=>"A comma separated list of tags you want to filter with"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}, {"in"=>"query", "name"=>"type", "description"=>"Type of datapoint (tl/tp)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Aggregated", "Summary", "Datapoints"]}}, "/aggregated/summary/groups"=>{"get"=>{"summary"=>"Retrieve statistics about a subset of groups for a timeframe with groups data", "description"=>"Retrieve statistics about a subset of groups for a timeframe with groups data.", "operationId"=>"getAggregatedSummaryGroups", "x-api-path-slug"=>"aggregatedsummarygroups-get", "parameters"=>[{"in"=>"query", "name"=>"favourite", "description"=>"Is the group marked as favourite"}, {"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit results to this number"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset where to start from"}, {"in"=>"query", "name"=>"sortBy", "description"=>"Field to sort by"}, {"in"=>"query", "name"=>"sortDirection", "description"=>"Direction of sort asc or desc"}, {"in"=>"query", "name"=>"status", "description"=>"Status of group (deleted/active)"}, {"in"=>"query", "name"=>"tag", "description"=>"A comma separated list of tags you want to filter with"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Aggregated", "Summary", "Groups"]}}, "/clickstream"=>{"get"=>{"summary"=>"Retrieve the latest list of events of this account. Limited to last 100.", "description"=>"Retrieve the latest list of events of this account. limited to last 100..", "operationId"=>"getClickstream", "x-api-path-slug"=>"clickstream-get", "parameters"=>[{"in"=>"query", "name"=>"conversion", "description"=>"Filter by this conversion id (mutually exclusive with datapoint and group)"}, {"in"=>"query", "name"=>"datapoint", "description"=>"Filter by this datapoint id (mutually exclusive with group and conversion)"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter event type (spiders/uniques/nonuniques/conversions)"}, {"in"=>"query", "name"=>"group", "description"=>"Filter by this group id (mutually exclusive with datapoint and conversion)"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Limit results to this number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clickstream"]}}, "/conversions"=>{"get"=>{"summary"=>"Retrieve a list of conversions", "description"=>"Retrieve a list of conversions.", "operationId"=>"getConversions", "x-api-path-slug"=>"conversions-get", "parameters"=>[{"in"=>"query", "name"=>"createdAfter", "description"=>"Exclude conversions created before this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"createdBefore", "description"=>"Exclude conversions created after this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit results to this number"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset where to start from"}, {"in"=>"query", "name"=>"status", "description"=>"Status of conversion (deleted/active)"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversions"]}, "post"=>{"summary"=>"Create a conversion", "description"=>"Create a conversion.", "operationId"=>"postConversions", "x-api-path-slug"=>"conversions-post", "parameters"=>[{"in"=>"body", "name"=>"value", "description"=>"The body of the conversion", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversions"]}}, "/conversions/aggregated/list"=>{"get"=>{"summary"=>"Retrieve statistics about this customer for a timeframe related to a subset of conversions grouped by some temporal entity (day/week/month)", "description"=>"Retrieve statistics about this customer for a timeframe related to a subset of conversions grouped by some temporal entity (day/week/month).", "operationId"=>"getConversionsAggregatedList", "x-api-path-slug"=>"conversionsaggregatedlist-get", "parameters"=>[{"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"groupBy", "description"=>"The temporal entity you want to group by (week/month)"}, {"in"=>"query", "name"=>"status", "description"=>"Status of conversion (deleted/active)"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversions", "Aggregated", "List"]}}, "/conversions/count"=>{"get"=>{"summary"=>"Retrieve a count of conversions", "description"=>"Retrieve a count of conversions.", "operationId"=>"getConversionsCount", "x-api-path-slug"=>"conversionscount-get", "parameters"=>[{"in"=>"query", "name"=>"createdAfter", "description"=>"Exclude conversions created before this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"createdBefore", "description"=>"Exclude conversions created after this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"status", "description"=>"Status of conversion (deleted/active)"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversions", "Count"]}}, "/conversions/{conversionId}"=>{"delete"=>{"summary"=>"Delete conversion specified by id", "description"=>"Delete conversion specified by id.", "operationId"=>"deleteConversionsConversion", "x-api-path-slug"=>"conversionsconversionid-delete", "parameters"=>[{"in"=>"path", "name"=>"conversionId", "description"=>"Id of the conversion"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversions", "ConversionId"]}, "get"=>{"summary"=>"Retrieve conversion specified by id", "description"=>"Retrieve conversion specified by id.", "operationId"=>"getConversionsConversion", "x-api-path-slug"=>"conversionsconversionid-get", "parameters"=>[{"in"=>"path", "name"=>"conversionId", "description"=>"Id of the conversion"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversions", "ConversionId"]}, "post"=>{"summary"=>"Update conversion specified by id", "description"=>"Update conversion specified by id.", "operationId"=>"postConversionsConversion", "x-api-path-slug"=>"conversionsconversionid-post", "parameters"=>[{"in"=>"path", "name"=>"conversionId", "description"=>"Id of the conversion"}, {"in"=>"body", "name"=>"value", "description"=>"Updated body of the conversion", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversions", "ConversionId"]}}, "/conversions/{conversionId}/aggregated"=>{"get"=>{"summary"=>"Retrieve statistics about this conversion for a timeframe", "description"=>"Retrieve statistics about this conversion for a timeframe.", "operationId"=>"getConversionsConversionAggregated", "x-api-path-slug"=>"conversionsconversionidaggregated-get", "parameters"=>[{"in"=>"path", "name"=>"conversionId", "description"=>"Id of the conversion"}, {"in"=>"query", "name"=>"favourite", "description"=>"Is the datapoint marked as favourite"}, {"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"hourly", "description"=>"If using yesterday or today timeframe you can ask for the hourly detail"}, {"in"=>"query", "name"=>"tag", "description"=>"Filter by this tag name"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversions", "ConversionId", "Aggregated"]}}, "/conversions/{conversionId}/aggregated/list"=>{"get"=>{"summary"=>"Retrieve statistics about this conversion for a timeframe grouped by some temporal entity (day/week/month)", "description"=>"Retrieve statistics about this conversion for a timeframe grouped by some temporal entity (day/week/month).", "operationId"=>"getConversionsConversionAggregatedList", "x-api-path-slug"=>"conversionsconversionidaggregatedlist-get", "parameters"=>[{"in"=>"path", "name"=>"conversionId", "description"=>"Id of the conversion"}, {"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"groupBy", "description"=>"The temporal entity you want to group by (week/month)"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversions", "ConversionId", "Aggregated", "List"]}}, "/conversions/{conversionId}/datapoints"=>{"get"=>{"summary"=>"Retrieve a list of datapoints connected to this conversion", "description"=>"Retrieve a list of datapoints connected to this conversion.", "operationId"=>"getConversionsConversionDatapoints", "x-api-path-slug"=>"conversionsconversioniddatapoints-get", "parameters"=>[{"in"=>"path", "name"=>"conversionId", "description"=>"Id of the conversion"}, {"in"=>"query", "name"=>"createdAfter", "description"=>"Exclude datapoints created before this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"createdBefore", "description"=>"Exclude datapoints created after this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit results to this number"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset where to start from"}, {"in"=>"query", "name"=>"status", "description"=>"Status of datapoint (deleted/active/paused/spam)"}, {"in"=>"query", "name"=>"tags", "description"=>"Filter by this tag name"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}, {"in"=>"query", "name"=>"type", "description"=>"Type of datapoint (tl/tp)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversions", "ConversionId", "Datapoints"]}}, "/conversions/{conversionId}/datapoints/batch/patch"=>{"put"=>{"summary"=>"Modify the association between a conversion and multiple datapoints", "description"=>"Modify the association between a conversion and multiple datapoints.", "operationId"=>"putConversionsConversionDatapointsBatchPatch", "x-api-path-slug"=>"conversionsconversioniddatapointsbatchpatch-put", "parameters"=>[{"in"=>"path", "name"=>"conversionId", "description"=>"Id of the conversion"}, {"in"=>"body", "name"=>"data", "description"=>"Patch requests", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversions", "ConversionId", "Datapoints", "Batch", "Patch"]}}, "/conversions/{conversionId}/datapoints/count"=>{"get"=>{"summary"=>"Retrieve a count of datapoints connected to this conversion", "description"=>"Retrieve a count of datapoints connected to this conversion.", "operationId"=>"getConversionsConversionDatapointsCount", "x-api-path-slug"=>"conversionsconversioniddatapointscount-get", "parameters"=>[{"in"=>"path", "name"=>"conversionId", "description"=>"Id of the conversion"}, {"in"=>"query", "name"=>"createdAfter", "description"=>"Exclude datapoints created before this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"createdBefore", "description"=>"Exclude datapoints created after this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"status", "description"=>"Status of datapoint (deleted/active/paused/spam)"}, {"in"=>"query", "name"=>"tags", "description"=>"Filter by this tag name"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}, {"in"=>"query", "name"=>"type", "description"=>"Type of datapoint (tl/tp)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversions", "ConversionId", "Datapoints", "Count"]}}, "/conversions/{conversionId}/datapoints/patch"=>{"put"=>{"summary"=>"Modify the association between a conversion and a datapoint", "description"=>"Modify the association between a conversion and a datapoint.", "operationId"=>"putConversionsConversionDatapointsPatch", "x-api-path-slug"=>"conversionsconversioniddatapointspatch-put", "parameters"=>[{"in"=>"path", "name"=>"conversionId", "description"=>"Id of the conversion"}, {"in"=>"body", "name"=>"data", "description"=>"Patch request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversions", "ConversionId", "Datapoints", "Patch"]}}, "/conversions/{conversionId}/hits"=>{"get"=>{"summary"=>"Retrieve the list of events related to this conversion.", "description"=>"Retrieve the list of events related to this conversion..", "operationId"=>"getConversionsConversionHits", "x-api-path-slug"=>"conversionsconversionidhits-get", "parameters"=>[{"in"=>"path", "name"=>"conversionId", "description"=>"Id of the conversion"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter event type (spiders/uniques/nonuniques/conversions)"}, {"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit results to this number"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset where to start from (its the lastKey field in the response object)"}, {"in"=>"query", "name"=>"timeframe", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversions", "ConversionId", "Hits"]}}, "/conversions/{conversionId}/notes"=>{"put"=>{"summary"=>"Fast patch the \"notes\" field of a conversion", "description"=>"Fast patch the \"notes\" field of a conversion.", "operationId"=>"putConversionsConversionNotes", "x-api-path-slug"=>"conversionsconversionidnotes-put", "parameters"=>[{"in"=>"path", "name"=>"conversionId", "description"=>"Id of the conversion"}, {"in"=>"body", "name"=>"note", "description"=>"Patch requests", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversions", "ConversionId", "Notes"]}}, "/conversions/{conversionId}/reports"=>{"get"=>{"summary"=>"Retrieve a top report connected to this conversion", "description"=>"Retrieve a top report connected to this conversion.", "operationId"=>"getConversionsConversionReports", "x-api-path-slug"=>"conversionsconversionidreports-get", "parameters"=>[{"in"=>"path", "name"=>"conversionId", "description"=>"Id of the conversion"}, {"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"hittype", "description"=>"Type of the event you want to filter this report with"}, {"in"=>"query", "name"=>"timeframe", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}, {"in"=>"query", "name"=>"type", "description"=>"Type of the report"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversions", "ConversionId", "Reports"]}}, "/datapoints"=>{"get"=>{"summary"=>"List of all the datapoints associated to the user", "description"=>"List of all the datapoints associated to the user.", "operationId"=>"getDatapoints", "x-api-path-slug"=>"datapoints-get", "parameters"=>[{"in"=>"query", "name"=>"createdAfter", "description"=>"Exclude datapoints created before this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"createdBefore", "description"=>"Exclude datapoints created after this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum elements to retrieve"}, {"in"=>"query", "name"=>"offset", "description"=>"Where to start when retrieving elements"}, {"in"=>"query", "name"=>"onlyFavorites", "description"=>"Filter fields by favourite status"}, {"in"=>"query", "name"=>"sortBy", "description"=>"Field to sort by"}, {"in"=>"query", "name"=>"sortDirection", "description"=>"Direction of sort asc or desc"}, {"in"=>"query", "name"=>"status", "description"=>"Status of the datapoint"}, {"in"=>"query", "name"=>"tags", "description"=>"A comma separated list of tags you want to filter with"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}, {"in"=>"query", "name"=>"type", "description"=>"Type of the datapoint (tp/tl)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints"]}, "post"=>{"summary"=>"Create a datapoint", "description"=>"Create a datapoint.", "operationId"=>"postDatapoints", "x-api-path-slug"=>"datapoints-post", "parameters"=>[{"in"=>"body", "name"=>"value", "description"=>"The body of the datapoint", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints"]}}, "/datapoints/aggregated"=>{"get"=>{"summary"=>"Retrieve statistics about this customer for a timeframe by groups", "description"=>"Retrieve statistics about this customer for a timeframe by groups.", "operationId"=>"getDatapointsAggregated", "x-api-path-slug"=>"datapointsaggregated-get", "parameters"=>[{"in"=>"query", "name"=>"favourite", "description"=>"Is the datapoint is marked as favourite"}, {"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"hourly", "description"=>"If using yesterday or today timeframe you can ask for the hourly detail"}, {"in"=>"query", "name"=>"status", "description"=>"Status of datapoint (deleted/active/paused/spam)"}, {"in"=>"query", "name"=>"tag", "description"=>"A comma separated list of tags you want to filter with"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}, {"in"=>"query", "name"=>"type", "description"=>"Type of datapoint (tl/tp)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints", "Aggregated"]}}, "/datapoints/aggregated/list"=>{"get"=>{"summary"=>"Retrieve statistics about all datapoints of this customer for a timeframe grouped by some temporal entity (day/week/month)", "description"=>"Retrieve statistics about all datapoints of this customer for a timeframe grouped by some temporal entity (day/week/month).", "operationId"=>"getDatapointsAggregatedList", "x-api-path-slug"=>"datapointsaggregatedlist-get", "parameters"=>[{"in"=>"query", "name"=>"favourite", "description"=>"Is the datapoint is marked as favourite"}, {"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"groupBy", "description"=>"The temporal entity you want to group by (week/month)"}, {"in"=>"query", "name"=>"status", "description"=>"Status of datapoint (deleted/active/paused/spam)"}, {"in"=>"query", "name"=>"tag", "description"=>"A comma separated list of tags you want to filter with"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}, {"in"=>"query", "name"=>"type", "description"=>"Type of datapoint (tl/tp)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints", "Aggregated", "List"]}}, "/datapoints/batch"=>{"delete"=>{"summary"=>"Delete multiple datapoints", "description"=>"Delete multiple datapoints.", "operationId"=>"deleteDatapointsBatch", "x-api-path-slug"=>"datapointsbatch-delete", "parameters"=>[{"in"=>"body", "name"=>"batch", "description"=>"A json containing the datapoints to delete", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints", "Batch"]}, "post"=>{"summary"=>"Update multiple datapoints", "description"=>"Update multiple datapoints.", "operationId"=>"postDatapointsBatch", "x-api-path-slug"=>"datapointsbatch-post", "parameters"=>[{"in"=>"body", "name"=>"batch", "description"=>"A json containing the datapoints to update", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints", "Batch"]}, "put"=>{"summary"=>"Create multiple datapoints", "description"=>"Create multiple datapoints.", "operationId"=>"putDatapointsBatch", "x-api-path-slug"=>"datapointsbatch-put", "parameters"=>[{"in"=>"body", "name"=>"batch", "description"=>"A json containing the datapoints to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints", "Batch"]}}, "/datapoints/count"=>{"get"=>{"summary"=>"Count the datapoints associated to the user", "description"=>"Count the datapoints associated to the user.", "operationId"=>"getDatapointsCount", "x-api-path-slug"=>"datapointscount-get", "parameters"=>[{"in"=>"query", "name"=>"createdAfter", "description"=>"Exclude datapoints created before this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"createdBefore", "description"=>"Exclude datapoints created after this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"onlyFavorites", "description"=>"Filter fields by favourite status"}, {"in"=>"query", "name"=>"status", "description"=>"Status of the datapoint"}, {"in"=>"query", "name"=>"tags", "description"=>"A comma separated list of tags you want to filter with"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}, {"in"=>"query", "name"=>"type", "description"=>"Type of the datapoint (tp/tl)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints", "Count"]}}, "/datapoints/{id}"=>{"delete"=>{"summary"=>"Delete a datapoint", "description"=>"Delete a datapoint.", "operationId"=>"deleteDatapoints", "x-api-path-slug"=>"datapointsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the datapoint"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints", "Id"]}, "get"=>{"summary"=>"Get a datapoint", "description"=>"Get a datapoint.", "operationId"=>"getDatapoints", "x-api-path-slug"=>"datapointsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the datapoint"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints", "Id"]}, "post"=>{"summary"=>"Update a datapoint", "description"=>"Update a datapoint.", "operationId"=>"postDatapoints", "x-api-path-slug"=>"datapointsid-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the datapoint"}, {"in"=>"body", "name"=>"value", "description"=>"The body of the datapoint", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints", "Id"]}}, "/datapoints/{id}/aggregated"=>{"get"=>{"summary"=>"Retrieve statistics about this datapoint for a timeframe", "description"=>"Retrieve statistics about this datapoint for a timeframe.", "operationId"=>"getDatapointsAggregated", "x-api-path-slug"=>"datapointsidaggregated-get", "parameters"=>[{"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"hourly", "description"=>"If using yesterday or today timeframe you can ask for the hourly detail"}, {"in"=>"path", "name"=>"id", "description"=>"Id of the datapoint"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints", "Id", "Aggregated"]}}, "/datapoints/{id}/aggregated/list"=>{"get"=>{"summary"=>"Retrieve statistics about this datapoint for a timeframe grouped by some temporal entity (day/week/month)", "description"=>"Retrieve statistics about this datapoint for a timeframe grouped by some temporal entity (day/week/month).", "operationId"=>"getDatapointsAggregatedList", "x-api-path-slug"=>"datapointsidaggregatedlist-get", "parameters"=>[{"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"groupBy", "description"=>"The temporal entity you want to group by (week/month)"}, {"in"=>"path", "name"=>"id", "description"=>"Id of the datapoint"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints", "Id", "Aggregated", "List"]}}, "/datapoints/{id}/favourite"=>{"put"=>{"summary"=>"Fast switch the \"favourite\" field of a datapoint", "description"=>"Fast switch the \"favourite\" field of a datapoint.", "operationId"=>"putDatapointsFavourite", "x-api-path-slug"=>"datapointsidfavourite-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the datapoint"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints", "Id", "Favourite"]}}, "/datapoints/{id}/hits"=>{"get"=>{"summary"=>"Retrieve the list of events related to this datapoint.", "description"=>"Retrieve the list of events related to this datapoint..", "operationId"=>"getDatapointsHits", "x-api-path-slug"=>"datapointsidhits-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter event type (spiders/uniques/nonuniques/conversions)"}, {"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"path", "name"=>"id", "description"=>"Id of the datapoint"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit results to this number"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset where to start from (its the lastKey field in the response object)"}, {"in"=>"query", "name"=>"timeframe", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints", "Id", "Hits"]}}, "/datapoints/{id}/notes"=>{"put"=>{"summary"=>"Fast patch the \"notes\" field of a datapoint", "description"=>"Fast patch the \"notes\" field of a datapoint.", "operationId"=>"putDatapointsNotes", "x-api-path-slug"=>"datapointsidnotes-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the datapoint"}, {"in"=>"body", "name"=>"note", "description"=>"Patch requests", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints", "Id", "Notes"]}}, "/datapoints/{id}/reports"=>{"get"=>{"summary"=>"Retrieve a top report connected to this datapoint", "description"=>"Retrieve a top report connected to this datapoint.", "operationId"=>"getDatapointsReports", "x-api-path-slug"=>"datapointsidreports-get", "parameters"=>[{"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"path", "name"=>"id", "description"=>"Id of the datapoint"}, {"in"=>"query", "name"=>"timeframe", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}, {"in"=>"query", "name"=>"type", "description"=>"Type of the report"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datapoints", "Id", "Reports"]}}, "/domains"=>{"get"=>{"summary"=>"Retrieve a list of domains", "description"=>"Retrieve a list of domains.", "operationId"=>"getDomains", "x-api-path-slug"=>"domains-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limit results to this number"}, {"in"=>"query", "name"=>"name", "description"=>"Filter domains with this anmen"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset where to start from"}, {"in"=>"query", "name"=>"type", "description"=>"Type of domain (system/go/personal/dedicated)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}, "post"=>{"summary"=>"Create a domain", "description"=>"Create a domain.", "operationId"=>"postDomains", "x-api-path-slug"=>"domains-post", "parameters"=>[{"in"=>"body", "name"=>"value", "description"=>"The domain to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/domains/count"=>{"get"=>{"summary"=>"Retrieve count of domains", "description"=>"Retrieve count of domains.", "operationId"=>"getDomainsCount", "x-api-path-slug"=>"domainscount-get", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"Filter domains with this anmen"}, {"in"=>"query", "name"=>"type", "description"=>"Type of domain (system/go/personal/dedicated)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains", "Count"]}}, "/domains/{id}"=>{"delete"=>{"summary"=>"Delete a domain", "description"=>"Delete a domain.", "operationId"=>"deleteDomains", "x-api-path-slug"=>"domainsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of domain"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains", "Id"]}, "get"=>{"summary"=>"Get a domain", "description"=>"Get a domain.", "operationId"=>"getDomains", "x-api-path-slug"=>"domainsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of domain"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains", "Id"]}, "post"=>{"summary"=>"Update a domain", "description"=>"Update a domain.", "operationId"=>"postDomains", "x-api-path-slug"=>"domainsid-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of domain"}, {"in"=>"body", "name"=>"value", "description"=>"The domain to update", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains", "Id"]}}, "/groups"=>{"get"=>{"summary"=>"List of all the groups associated to the user.", "description"=>"List of all the groups associated to the user..", "operationId"=>"getGroups", "x-api-path-slug"=>"groups-get", "parameters"=>[{"in"=>"query", "name"=>"createdAfter", "description"=>"Exclude groups created before this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"createdBefore", "description"=>"Exclude groups created after this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum elements to retrieve"}, {"in"=>"query", "name"=>"offset", "description"=>"Where to start when retrieving elements"}, {"in"=>"query", "name"=>"status", "description"=>"Status of the group"}, {"in"=>"query", "name"=>"tags", "description"=>"A comma separated list of tags you want to filter with"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}, {"in"=>"query", "name"=>"write", "description"=>"Write permission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, "post"=>{"summary"=>"Create a group", "description"=>"Create a group.", "operationId"=>"postGroups", "x-api-path-slug"=>"groups-post", "parameters"=>[{"in"=>"body", "name"=>"value", "description"=>"The body of the group", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/groups/aggregated"=>{"get"=>{"summary"=>"Retrieve statistics about this customer for a timeframe by groups", "description"=>"Retrieve statistics about this customer for a timeframe by groups.", "operationId"=>"getGroupsAggregated", "x-api-path-slug"=>"groupsaggregated-get", "parameters"=>[{"in"=>"query", "name"=>"favourite", "description"=>"Is the group is marked as favourite"}, {"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"hourly", "description"=>"If using yesterday or today timeframe you can ask for the hourly detail"}, {"in"=>"query", "name"=>"status", "description"=>"Status of group (deleted/active)"}, {"in"=>"query", "name"=>"tag", "description"=>"A comma separated list of tags you want to filter with"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Aggregated"]}}, "/groups/aggregated/list"=>{"get"=>{"summary"=>"Retrieve statistics about all groups of this customer for a timeframe grouped by some temporal entity (day/week/month)", "description"=>"Retrieve statistics about all groups of this customer for a timeframe grouped by some temporal entity (day/week/month).", "operationId"=>"getGroupsAggregatedList", "x-api-path-slug"=>"groupsaggregatedlist-get", "parameters"=>[{"in"=>"query", "name"=>"favourite", "description"=>"Is the group is marked as favourite"}, {"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"groupBy", "description"=>"The temporal entity you want to group by (week/month)"}, {"in"=>"query", "name"=>"status", "description"=>"Status of group (deleted/active)"}, {"in"=>"query", "name"=>"tag", "description"=>"A comma separated list of tags you want to filter with"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Aggregated", "List"]}}, "/groups/count"=>{"get"=>{"summary"=>"Count the groups associated to the user.", "description"=>"Count the groups associated to the user..", "operationId"=>"getGroupsCount", "x-api-path-slug"=>"groupscount-get", "parameters"=>[{"in"=>"query", "name"=>"createdAfter", "description"=>"Exclude groups created before this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"createdBefore", "description"=>"Exclude groups created after this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"status", "description"=>"Status of the datapoint"}, {"in"=>"query", "name"=>"tags", "description"=>"A comma separated list of tags you want to filter with"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}, {"in"=>"query", "name"=>"write", "description"=>"Write permission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Count"]}}, "/groups/{id}"=>{"delete"=>{"summary"=>"Delete group specified by id", "description"=>"Delete group specified by id.", "operationId"=>"deleteGroups", "x-api-path-slug"=>"groupsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Id"]}, "get"=>{"summary"=>"Get a group", "description"=>"Get a group.", "operationId"=>"getGroups", "x-api-path-slug"=>"groupsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Id"]}, "post"=>{"summary"=>"Update a group", "description"=>"Update a group.", "operationId"=>"postGroups", "x-api-path-slug"=>"groupsid-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the group"}, {"in"=>"body", "name"=>"value", "description"=>"The body of the group", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Id"]}}, "/groups/{id}/aggregated"=>{"get"=>{"summary"=>"Retrieve statistics about this group for a timeframe", "description"=>"Retrieve statistics about this group for a timeframe.", "operationId"=>"getGroupsAggregated", "x-api-path-slug"=>"groupsidaggregated-get", "parameters"=>[{"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"hourly", "description"=>"If using yesterday or today timeframe you can ask for the hourly detail"}, {"in"=>"path", "name"=>"id", "description"=>"Id of the group"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Id", "Aggregated"]}}, "/groups/{id}/aggregated/list"=>{"get"=>{"summary"=>"Retrieve statistics about this group for a timeframe grouped by some temporal entity (day/week/month)", "description"=>"Retrieve statistics about this group for a timeframe grouped by some temporal entity (day/week/month).", "operationId"=>"getGroupsAggregatedList", "x-api-path-slug"=>"groupsidaggregatedlist-get", "parameters"=>[{"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"groupBy", "description"=>"The temporal entity you want to group by (week/month)"}, {"in"=>"path", "name"=>"id", "description"=>"Id of the group"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Id", "Aggregated", "List"]}}, "/groups/{id}/aggregated/summary"=>{"get"=>{"summary"=>"Retrieve statistics about a subset of datapoints for a timeframe with datapoints data", "description"=>"Retrieve statistics about a subset of datapoints for a timeframe with datapoints data.", "operationId"=>"getGroupsAggregatedSummary", "x-api-path-slug"=>"groupsidaggregatedsummary-get", "parameters"=>[{"in"=>"query", "name"=>"favourite", "description"=>"Is the datapoint marked as favourite"}, {"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"path", "name"=>"id", "description"=>"Filter by this group id"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit results to this number"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset where to start from"}, {"in"=>"query", "name"=>"sortBy", "description"=>"Field to sort by"}, {"in"=>"query", "name"=>"sortDirection", "description"=>"Direction of sort asc or desc"}, {"in"=>"query", "name"=>"status", "description"=>"Status of datapoint (deleted/active/paused/spam)"}, {"in"=>"query", "name"=>"tag", "description"=>"A comma separated list of tags you want to filter with"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}, {"in"=>"query", "name"=>"timeFrame", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}, {"in"=>"query", "name"=>"type", "description"=>"Type of datapoint (tl/tp)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Id", "Aggregated", "Summary"]}}, "/groups/{id}/datapoints"=>{"get"=>{"summary"=>"List of all the datapoints associated to the user in this group.", "description"=>"List of all the datapoints associated to the user in this group..", "operationId"=>"getGroupsDatapoints", "x-api-path-slug"=>"groupsiddatapoints-get", "parameters"=>[{"in"=>"query", "name"=>"createdAfter", "description"=>"Exclude datapoints created before this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"createdBefore", "description"=>"Exclude datapoints created after this date (YYYYMMDD)"}, {"in"=>"path", "name"=>"id", "description"=>"Id of the group"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum elements to retrieve"}, {"in"=>"query", "name"=>"offset", "description"=>"Where to start when retrieving elements"}, {"in"=>"query", "name"=>"onlyFavorites", "description"=>"Filter fields by favourite status"}, {"in"=>"query", "name"=>"sortBy", "description"=>"Field to sort by"}, {"in"=>"query", "name"=>"sortDirection", "description"=>"Direction of sort asc or desc"}, {"in"=>"query", "name"=>"status", "description"=>"Status of the datapoint"}, {"in"=>"query", "name"=>"tags", "description"=>"A comma separated list of tags you want to filter with"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}, {"in"=>"query", "name"=>"type", "description"=>"Type of the datapoint (tp/tl)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Id", "Datapoints"]}, "post"=>{"summary"=>"Create a datapoint in this group", "description"=>"Create a datapoint in this group.", "operationId"=>"postGroupsDatapoints", "x-api-path-slug"=>"groupsiddatapoints-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the group"}, {"in"=>"body", "name"=>"value", "description"=>"The body of the datapoint", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Id", "Datapoints"]}}, "/groups/{id}/datapoints/count"=>{"get"=>{"summary"=>"Count the datapoints associated to the user in this group.", "description"=>"Count the datapoints associated to the user in this group..", "operationId"=>"getGroupsDatapointsCount", "x-api-path-slug"=>"groupsiddatapointscount-get", "parameters"=>[{"in"=>"query", "name"=>"createdAfter", "description"=>"Exclude datapoints created before this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"createdBefore", "description"=>"Exclude datapoints created after this date (YYYYMMDD)"}, {"in"=>"path", "name"=>"id", "description"=>"Id of the group"}, {"in"=>"query", "name"=>"onlyFavorites", "description"=>"Filter fields by favourite status"}, {"in"=>"query", "name"=>"status", "description"=>"Status of the datapoint"}, {"in"=>"query", "name"=>"tags", "description"=>"A comma separated list of tags you want to filter with"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}, {"in"=>"query", "name"=>"type", "description"=>"Type of the datapoint (tp/tl)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Id", "Datapoints", "Count"]}}, "/groups/{id}/favourite"=>{"put"=>{"summary"=>"Fast switch the \"favourite\" field of a group", "description"=>"Fast switch the \"favourite\" field of a group.", "operationId"=>"putGroupsFavourite", "x-api-path-slug"=>"groupsidfavourite-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Id", "Favourite"]}}, "/groups/{id}/hits"=>{"get"=>{"summary"=>"Retrieve the list of events related to this group.", "description"=>"Retrieve the list of events related to this group..", "operationId"=>"getGroupsHits", "x-api-path-slug"=>"groupsidhits-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter event type (spiders/uniques/nonuniques/conversions)"}, {"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"path", "name"=>"id", "description"=>"Id of the group"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit results to this number"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset where to start from (its the lastKey field in the response object)"}, {"in"=>"query", "name"=>"timeframe", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Id", "Hits"]}}, "/groups/{id}/notes"=>{"put"=>{"summary"=>"Fast patch the \"notes\" field of a group", "description"=>"Fast patch the \"notes\" field of a group.", "operationId"=>"putGroupsNotes", "x-api-path-slug"=>"groupsidnotes-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the group"}, {"in"=>"body", "name"=>"note", "description"=>"Patch requests", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Id", "Notes"]}}, "/groups/{id}/reports"=>{"get"=>{"summary"=>"Retrieve a top report connected to this group", "description"=>"Retrieve a top report connected to this group.", "operationId"=>"getGroupsReports", "x-api-path-slug"=>"groupsidreports-get", "parameters"=>[{"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"hittype", "description"=>"Type of the event you want to filter this report with"}, {"in"=>"path", "name"=>"id", "description"=>"Id of the group"}, {"in"=>"query", "name"=>"timeframe", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}, {"in"=>"query", "name"=>"type", "description"=>"Type of the report"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Id", "Reports"]}}, "/hits"=>{"get"=>{"summary"=>"Retrieve the list of events related to this account.", "description"=>"Retrieve the list of events related to this account..", "operationId"=>"getHits", "x-api-path-slug"=>"hits-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter event type (spiders/uniques/nonuniques/conversions)"}, {"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit results to this number"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset where to start from (its the lastKey field in the response object)"}, {"in"=>"query", "name"=>"timeframe", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hits"]}}, "/me"=>{"get"=>{"summary"=>"Retrieve current account data", "description"=>"Retrieve current account data.", "operationId"=>"getMe", "x-api-path-slug"=>"me-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me"]}}, "/me/plan"=>{"get"=>{"summary"=>"Retrieve current account plan", "description"=>"Retrieve current account plan.", "operationId"=>"getMePlan", "x-api-path-slug"=>"meplan-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Plan"]}}, "/reports"=>{"get"=>{"summary"=>"Retrieve a top report", "description"=>"Retrieve a top report.", "operationId"=>"getReports", "x-api-path-slug"=>"reports-get", "parameters"=>[{"in"=>"query", "name"=>"conversion", "description"=>"Filter by this conversion id (mutually exclusive with datapoint and group)"}, {"in"=>"query", "name"=>"datapoint", "description"=>"Filter by this datapoint id (mutually exclusive with group and conversion)"}, {"in"=>"query", "name"=>"fromDay", "description"=>"If using a custom timeFrame you can specify the starting day (YYYYMMDD)"}, {"in"=>"query", "name"=>"group", "description"=>"Filter by this group id (mutually exclusive with datapoint and conversion)"}, {"in"=>"query", "name"=>"hittype", "description"=>"Type of the event you want to filter this report with"}, {"in"=>"query", "name"=>"timeframe", "description"=>"Timeframe of the request"}, {"in"=>"query", "name"=>"toDay", "description"=>"If using a custom timeFrame you can specify the ending day (YYYYMMDD)"}, {"in"=>"query", "name"=>"type", "description"=>"Type of the report"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports"]}}, "/retargeting"=>{"get"=>{"summary"=>"List of all the retargeting scripts associated to the user", "description"=>"List of all the retargeting scripts associated to the user.", "operationId"=>"getRetargeting", "x-api-path-slug"=>"retargeting-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum elements to retrieve"}, {"in"=>"query", "name"=>"offset", "description"=>"Where to start when retrieving elements"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retargeting"]}, "post"=>{"summary"=>"Creates a retargeting script", "description"=>"Creates a retargeting script.", "operationId"=>"postRetargeting", "x-api-path-slug"=>"retargeting-post", "parameters"=>[{"in"=>"body", "name"=>"value", "description"=>"The body of the retargeting script", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retargeting"]}}, "/retargeting/count"=>{"get"=>{"summary"=>"Retrieve count of retargeting scripts", "description"=>"Retrieve count of retargeting scripts.", "operationId"=>"getRetargetingCount", "x-api-path-slug"=>"retargetingcount-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retargeting", "Count"]}}, "/retargeting/{id}"=>{"delete"=>{"summary"=>"Deletes a retargeting script (and remove associations)", "description"=>"Deletes a retargeting script (and remove associations).", "operationId"=>"deleteRetargeting", "x-api-path-slug"=>"retargetingid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the retargeting script"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retargeting", "Id"]}, "get"=>{"summary"=>"Get a retargeting script object", "description"=>"Get a retargeting script object.", "operationId"=>"getRetargeting", "x-api-path-slug"=>"retargetingid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the retargeting script"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retargeting", "Id"]}, "post"=>{"summary"=>"Updates a retargeting script", "description"=>"Updates a retargeting script.", "operationId"=>"postRetargeting", "x-api-path-slug"=>"retargetingid-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the retargeting script"}, {"in"=>"body", "name"=>"value", "description"=>"The body of the retargeting script", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retargeting", "Id"]}}, "/retargeting/{id}/datapoints"=>{"get"=>{"summary"=>"List of all the datapoints associated to the retargeting script.", "description"=>"List of all the datapoints associated to the retargeting script..", "operationId"=>"getRetargetingDatapoints", "x-api-path-slug"=>"retargetingiddatapoints-get", "parameters"=>[{"in"=>"query", "name"=>"createdAfter", "description"=>"Exclude datapoints created before this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"createdBefore", "description"=>"Exclude datapoints created after this date (YYYYMMDD)"}, {"in"=>"path", "name"=>"id", "description"=>"Id of the retargeting script"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum elements to retrieve"}, {"in"=>"query", "name"=>"offset", "description"=>"Where to start when retrieving elements"}, {"in"=>"query", "name"=>"onlyFavorites", "description"=>"Filter fields by favourite status"}, {"in"=>"query", "name"=>"sortBy", "description"=>"Field to sort by"}, {"in"=>"query", "name"=>"sortDirection", "description"=>"Direction of sort asc or desc"}, {"in"=>"query", "name"=>"status", "description"=>"Status of the datapoint"}, {"in"=>"query", "name"=>"tags", "description"=>"A comma separated list of tags you want to filter with"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retargeting", "Id", "Datapoints"]}}, "/retargeting/{id}/datapoints/count"=>{"get"=>{"summary"=>"Count the datapoints associated to the retargeting script.", "description"=>"Count the datapoints associated to the retargeting script..", "operationId"=>"getRetargetingDatapointsCount", "x-api-path-slug"=>"retargetingiddatapointscount-get", "parameters"=>[{"in"=>"query", "name"=>"createdAfter", "description"=>"Exclude datapoints created before this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"createdBefore", "description"=>"Exclude datapoints created after this date (YYYYMMDD)"}, {"in"=>"path", "name"=>"id", "description"=>"Id of the group"}, {"in"=>"query", "name"=>"onlyFavorites", "description"=>"Filter fields by favourite status"}, {"in"=>"query", "name"=>"status", "description"=>"Status of the datapoint"}, {"in"=>"query", "name"=>"tags", "description"=>"A comma separated list of tags you want to filter with"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retargeting", "Id", "Datapoints", "Count"]}}, "/tags"=>{"get"=>{"summary"=>"List of all the groups associated to the user filtered by this tag.", "description"=>"List of all the groups associated to the user filtered by this tag..", "operationId"=>"getTags", "x-api-path-slug"=>"tags-get", "parameters"=>[{"in"=>"query", "name"=>"datapoints", "description"=>"Comma separated list of datapoints id to filter by"}, {"in"=>"query", "name"=>"groups", "description"=>"Comma separated list of groups id to filter by"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum elements to retrieve"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the tag"}, {"in"=>"query", "name"=>"offset", "description"=>"Where to start when retrieving elements"}, {"in"=>"query", "name"=>"type", "description"=>"Type of entity related to the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}, "post"=>{"summary"=>"Create a tag", "description"=>"Create a tag.", "operationId"=>"postTags", "x-api-path-slug"=>"tags-post", "parameters"=>[{"in"=>"body", "name"=>"value", "description"=>"The body of the tag", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/tags/count"=>{"get"=>{"summary"=>"List of all the groups associated to the user filtered by this tag.", "description"=>"List of all the groups associated to the user filtered by this tag..", "operationId"=>"getTagsCount", "x-api-path-slug"=>"tagscount-get", "parameters"=>[{"in"=>"query", "name"=>"datapoints", "description"=>"Comma separated list of datapoints id to filter by"}, {"in"=>"query", "name"=>"groups", "description"=>"Comma separated list of groups id to filter by"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the tag"}, {"in"=>"query", "name"=>"type", "description"=>"Type of entity related to the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Count"]}}, "/tags/{tagId}"=>{"delete"=>{"summary"=>"Delete a tag", "description"=>"Delete a tag.", "operationId"=>"deleteTagsTag", "x-api-path-slug"=>"tagstagid-delete", "parameters"=>[{"in"=>"path", "name"=>"tagId", "description"=>"Id of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "TagId"]}, "get"=>{"summary"=>"Retrieve a tag", "description"=>"Retrieve a tag.", "operationId"=>"getTagsTag", "x-api-path-slug"=>"tagstagid-get", "parameters"=>[{"in"=>"path", "name"=>"tagId", "description"=>"Id of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "TagId"]}}, "/tags/{tagId}/datapoints"=>{"delete"=>{"summary"=>"Delete the association of this tag with all datapoints", "description"=>"Delete the association of this tag with all datapoints.", "operationId"=>"deleteTagsTagDatapoints", "x-api-path-slug"=>"tagstagiddatapoints-delete", "parameters"=>[{"in"=>"path", "name"=>"tagId", "description"=>"Id of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "TagId", "Datapoints"]}, "get"=>{"summary"=>"List of all the datapoints associated to the user filtered by this tag", "description"=>"List of all the datapoints associated to the user filtered by this tag.", "operationId"=>"getTagsTagDatapoints", "x-api-path-slug"=>"tagstagiddatapoints-get", "parameters"=>[{"in"=>"query", "name"=>"createdAfter", "description"=>"Exclude datapoints created before this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"createdBefore", "description"=>"Exclude datapoints created after this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum elements to retrieve"}, {"in"=>"query", "name"=>"offset", "description"=>"Where to start when retrieving elements"}, {"in"=>"query", "name"=>"status", "description"=>"Status of the datapoint"}, {"in"=>"path", "name"=>"tagId", "description"=>"Id of the tag"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}, {"in"=>"query", "name"=>"type", "description"=>"Type of the datapoint (tp/tl)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "TagId", "Datapoints"]}}, "/tags/{tagId}/datapoints/count"=>{"get"=>{"summary"=>"Count the datapoints associated to the user filtered by this tag", "description"=>"Count the datapoints associated to the user filtered by this tag.", "operationId"=>"getTagsTagDatapointsCount", "x-api-path-slug"=>"tagstagiddatapointscount-get", "parameters"=>[{"in"=>"query", "name"=>"createdAfter", "description"=>"Exclude datapoints created before this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"createdBefore", "description"=>"Exclude datapoints created after this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"status", "description"=>"Status of the datapoint"}, {"in"=>"path", "name"=>"tagId", "description"=>"Id of the tag"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}, {"in"=>"query", "name"=>"type", "description"=>"Type of the datapoint (tp/tl)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "TagId", "Datapoints", "Count"]}}, "/tags/{tagId}/datapoints/patch"=>{"put"=>{"summary"=>"Associate/Deassociate a tag with a datapoint", "description"=>"Associate/deassociate a tag with a datapoint.", "operationId"=>"putTagsTagDatapointsPatch", "x-api-path-slug"=>"tagstagiddatapointspatch-put", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"The body patch", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tagId", "description"=>"Id of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "TagId", "Datapoints", "Patch"]}}, "/tags/{tagId}/groups"=>{"delete"=>{"summary"=>"Delete the association of this tag with all groups", "description"=>"Delete the association of this tag with all groups.", "operationId"=>"deleteTagsTagGroups", "x-api-path-slug"=>"tagstagidgroups-delete", "parameters"=>[{"in"=>"path", "name"=>"tagId", "description"=>"Id of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "TagId", "Groups"]}, "get"=>{"summary"=>"List of all the groups associated to the user filtered by this tag.", "description"=>"List of all the groups associated to the user filtered by this tag..", "operationId"=>"getTagsTagGroups", "x-api-path-slug"=>"tagstagidgroups-get", "parameters"=>[{"in"=>"query", "name"=>"createdAfter", "description"=>"Exclude groups created before this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"createdBefore", "description"=>"Exclude groups created after this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum elements to retrieve"}, {"in"=>"query", "name"=>"offset", "description"=>"Where to start when retrieving elements"}, {"in"=>"query", "name"=>"status", "description"=>"Status of the datapoint"}, {"in"=>"path", "name"=>"tagId", "description"=>"Id of the tag"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "TagId", "Groups"]}}, "/tags/{tagId}/groups/count"=>{"get"=>{"summary"=>"Count the groups associated to the user filtered by this tag", "description"=>"Count the groups associated to the user filtered by this tag.", "operationId"=>"getTagsTagGroupsCount", "x-api-path-slug"=>"tagstagidgroupscount-get", "parameters"=>[{"in"=>"query", "name"=>"createdAfter", "description"=>"Exclude groups created before this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"createdBefore", "description"=>"Exclude groups created after this date (YYYYMMDD)"}, {"in"=>"query", "name"=>"status", "description"=>"Status of the datapoint"}, {"in"=>"path", "name"=>"tagId", "description"=>"Id of the tag"}, {"in"=>"query", "name"=>"textSearch", "description"=>"Filter fields by this pattern"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "TagId", "Groups", "Count"]}}, "/tags/{tagId}/groups/patch"=>{"put"=>{"summary"=>"Associate/Deassociate a tag with a group", "description"=>"Associate/deassociate a tag with a group.", "operationId"=>"putTagsTagGroupsPatch", "x-api-path-slug"=>"tagstagidgroupspatch-put", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"The body patch", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tagId", "description"=>"Id of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "TagId", "Groups", "Patch"]}}, "/tags/{tagId}/name"=>{"put"=>{"summary"=>"Fast patch a tag name", "description"=>"Fast patch a tag name.", "operationId"=>"putTagsTagName", "x-api-path-slug"=>"tagstagidname-put", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"The body patch", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tagId", "description"=>"Id of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "TagId", "Name"]}}}}, "apis"=>{"name"=>"Click Meter", "x-slug"=>"click-meter", "description"=>"ClickMeter was founded in 2012 as a byproduct of an experienced web-marketing agency. The ClickMeter System was initially a web tool created to address the needs of our agency to precisely count and track the web-marketing actions we performed for our customers.The system evolved rapidly, and emerged as one of the most widely used software solutions in our agency to collect, analyze, and share data for and with our customers. After few years after the development of the first ClickMeter system, we decided to go live with a service that can be useful to everyone involved in web-marketing activities.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/clickmeter-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,Links,Profiles,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"click-meter/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Click Meter", "x-api-slug"=>"click-meter", "description"=>"ClickMeter was founded in 2012 as a byproduct of an experienced web-marketing agency. The ClickMeter System was initially a web tool created to address the needs of our agency to precisely count and track the web-marketing actions we performed for our customers.The system evolved rapidly, and emerged as one of the most widely used software solutions in our agency to collect, analyze, and share data for and with our customers. After few years after the development of the first ClickMeter system, we decided to go live with a service that can be useful to everyone involved in web-marketing activities.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/clickmeter-logo.png", "humanURL"=>"http://clickmeter.com", "baseURL"=>"https://apiv2.clickmeter.com:80//", "tags"=>"API Provider,Links,Profiles,Relative Data,Service API", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/click-meter/click-meter-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://blog.clickmeter.com/"}, {"type"=>"x-pricing", "url"=>"http://clickmeter.com/pricing-signup"}, {"type"=>"x-support", "url"=>"https://support.clickmeter.com/hc/en-us"}, {"type"=>"x-terms-of-service", "url"=>"http://clickmeter.com/terms-conditions"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/clickmeter"}, {"type"=>"x-website", "url"=>"http://clickmeter.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
viddler{"viddler--api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Viddler", "x-complete"=>1, "info"=>{"title"=>"Viddler API", "description"=>"the-viddler-api-exposes-viddleru2019s-key-features-to-those-that-would-like-to-build-custom-solutions-on-top-of-viddleru2019s-video-platform-", "termsOfService"=>"http://www.viddler.com/terms-of-use/", "version"=>"v2"}, "host"=>"api.viddler.com", "basePath"=>"/api/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"viddler.api.echo"=>{"get"=>{"summary"=>"Api Echo", "description"=>"This method is used for testing purposes only. Simply call this method to make sure the API is responding fine.", "operationId"=>"api-echo", "x-api-path-slug"=>"viddler-api-echo-get", "parameters"=>[{"in"=>"query", "name"=>"message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Api", "Echo"]}}, "viddler.encoding.cancel"=>{"post"=>{"summary"=>"Encoding Cancel", "description"=>"Cancel encoding a specific video file.", "operationId"=>"encoding-cancel", "x-api-path-slug"=>"viddler-encoding-cancel-post", "parameters"=>[{"in"=>"query", "name"=>"file_id"}, {"in"=>"query", "name"=>"sessionid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Encoding", "Cancel"]}}, "viddler.encoding.getSettings"=>{"get"=>{"summary"=>"Encoding GetSettings", "description"=>"Returns the current encoding options for an account.", "operationId"=>"encoding-getsettings", "x-api-path-slug"=>"viddler-encoding-getsettings-get", "parameters"=>[{"in"=>"query", "name"=>"sessionid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Encoding", "GetSettings"]}}, "viddler.encoding.getStatus2"=>{"get"=>{"summary"=>"Encoding GetStatus2", "description"=>"This method is the same as viddler.encoding.getStatus except that it groups files better for users to easily find what they are looking for. We could not easily update the previous method without causing complications with external applications.", "operationId"=>"encoding-getstatus2", "x-api-path-slug"=>"viddler-encoding-getstatus2-get", "parameters"=>[{"in"=>"query", "name"=>"sessionid"}, {"in"=>"query", "name"=>"video_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Encoding", "GetStatus2"]}}, "viddler.logins.add"=>{"post"=>{"summary"=>"Logins Add", "description"=>"Adds a new login to user account when the main account has multi-user sign-on enabled. You must have this feature enabled for your account. Please call us at 1-888-444-1119 to enable for you account.", "operationId"=>"logins-add", "x-api-path-slug"=>"viddler-logins-add-post", "parameters"=>[{"in"=>"query", "name"=>"analytics_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"api_access_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"api_settings_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"billing_settings_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"branding_settings_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"email", "description"=>"The email of the user"}, {"in"=>"query", "name"=>"encoding_settings_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"interaction_settings_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"invoices_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"itunes_settings_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"login", "description"=>"The login username you would like to create"}, {"in"=>"query", "name"=>"logins_permissions", "description"=>"options: create, read, update and delete"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the user"}, {"in"=>"query", "name"=>"password", "description"=>"The password of the user"}, {"in"=>"query", "name"=>"player_settings_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"playlists_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"playlist_ids", "description"=>"A comma delimited list of playlist IDs this user can view"}, {"in"=>"query", "name"=>"privacy_settings_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"profile_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"recorder_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"sessionid"}, {"in"=>"query", "name"=>"subaccounts_permissions", "description"=>"options: create, read, update and delete"}, {"in"=>"query", "name"=>"support_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"videos_permissions", "description"=>"options: create, read, update and delete"}, {"in"=>"query", "name"=>"vidgets_permissions", "description"=>"options: manage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Logins", "Add"]}}, "viddler.logins.get"=>{"get"=>{"summary"=>"Logins Get", "description"=>"Return the current permissions for a specific user.", "operationId"=>"logins-get", "x-api-path-slug"=>"viddler-logins-get-get", "parameters"=>[{"in"=>"query", "name"=>"login", "description"=>"The login username you would like to return information for"}, {"in"=>"query", "name"=>"sessionid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Logins", "Get"]}}, "viddler.logins.update"=>{"post"=>{"summary"=>"Logins Update", "description"=>"Updates a current login.", "operationId"=>"logins-update", "x-api-path-slug"=>"viddler-logins-update-post", "parameters"=>[{"in"=>"query", "name"=>"analytics_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"api_access_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"api_settings_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"billing_settings_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"branding_settings_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"email", "description"=>"The email of the user"}, {"in"=>"query", "name"=>"encoding_settings_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"interaction_settings_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"invoices_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"itunes_settings_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"login", "description"=>"The login username you would like to create"}, {"in"=>"query", "name"=>"logins_permissions", "description"=>"options: create, read, update and delete"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the user"}, {"in"=>"query", "name"=>"password", "description"=>"The password of the user"}, {"in"=>"query", "name"=>"player_settings_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"playlists_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"playlist_ids", "description"=>"A comma delimited list of playlist IDs this user can view"}, {"in"=>"query", "name"=>"privacy_settings_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"profile_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"recorder_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"sessionid"}, {"in"=>"query", "name"=>"subaccounts_permissions", "description"=>"options: create, read, update and delete"}, {"in"=>"query", "name"=>"support_permissions", "description"=>"options: manage"}, {"in"=>"query", "name"=>"videos_permissions", "description"=>"options: create, read, update and delete"}, {"in"=>"query", "name"=>"vidgets_permissions", "description"=>"options: manage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Logins", "Update"]}}, "viddler.playlists.create"=>{"post"=>{"summary"=>"Playlists Create", "description"=>"Create a playlist. Regular playlist represents user defined videos. Smart playlist updates in realtime returning videos matching selected filtering rules.", "operationId"=>"playlists-create", "x-api-path-slug"=>"viddler-playlists-create-post", "parameters"=>[{"in"=>"query", "name"=>"max_age"}, {"in"=>"query", "name"=>"max_update_date"}, {"in"=>"query", "name"=>"max_views"}, {"in"=>"query", "name"=>"min_update_date"}, {"in"=>"query", "name"=>"min_views"}, {"in"=>"query", "name"=>"name"}, {"in"=>"query", "name"=>"playlist_visibility"}, {"in"=>"query", "name"=>"Regular Playlist Params (all optional)nnvideo_ids"}, {"in"=>"query", "name"=>"sessionid"}, {"in"=>"query", "name"=>"Smart Playlist Params (all optional)nnusers"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"tags"}, {"in"=>"query", "name"=>"type"}, {"in"=>"query", "name"=>"visibility"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Playlists", "Create"]}}, "viddler.playlists.delete"=>{"post"=>{"summary"=>"Playlists Delete", "description"=>"Delete a playlist.u00a0Caution: This operation cannot be undone.", "operationId"=>"playlists-delete", "x-api-path-slug"=>"viddler-playlists-delete-post", "parameters"=>[{"in"=>"query", "name"=>"playlist_id"}, {"in"=>"query", "name"=>"sessionid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Playlists", "Delete"]}}, "viddler.playlists.list"=>{"get"=>{"summary"=>"Playlists List", "description"=>"List all playlists for an account.", "operationId"=>"playlists-list", "x-api-path-slug"=>"viddler-playlists-list-get", "parameters"=>[{"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}, {"in"=>"query", "name"=>"sessionid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Playlists", "List"]}}, "viddler.playlists.moveVideo"=>{"get"=>{"summary"=>"Playlists MoveVideo", "description"=>"Reorder videos in regular playlist.", "operationId"=>"playlists-movevideo", "x-api-path-slug"=>"viddler-playlists-movevideo-get", "parameters"=>[{"in"=>"query", "name"=>"from"}, {"in"=>"query", "name"=>"playlist_id"}, {"in"=>"query", "name"=>"sessionid"}, {"in"=>"query", "name"=>"to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Playlists", "MoveVideo"]}}, "viddler.resellers.getSubaccounts"=>{"get"=>{"summary"=>"Resellers GetSubaccounts", "description"=>"List all subaccounts under your account. Only applies to reseller accounts. Other accounts do not have access to this method.", "operationId"=>"resellers-getsubaccounts", "x-api-path-slug"=>"viddler-resellers-getsubaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}, {"in"=>"query", "name"=>"sessionid"}, {"in"=>"query", "name"=>"sort"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Resellers", "GetSubaccounts"]}}, "viddler.users.getPlayerBranding"=>{"get"=>{"summary"=>"Users GetPlayerBranding", "description"=>"Returns your player branding configuration.", "operationId"=>"users-getplayerbranding", "x-api-path-slug"=>"viddler-users-getplayerbranding-get", "parameters"=>[{"in"=>"query", "name"=>"sessionid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Users", "GetPlayerBranding"]}}, "viddler.users.getProfile"=>{"get"=>{"summary"=>"Users GetProfile", "description"=>"Get the public information for a profile. Can only get profile information for public profiles.", "operationId"=>"users-getprofile", "x-api-path-slug"=>"viddler-users-getprofile-get", "parameters"=>[{"in"=>"query", "name"=>"sessionid"}, {"in"=>"query", "name"=>"user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Users", "GetProfile"]}}, "viddler.users.getSettings"=>{"get"=>{"summary"=>"Users GetSettings", "description"=>"Return account settings.", "operationId"=>"users-getsettings", "x-api-path-slug"=>"viddler-users-getsettings-get", "parameters"=>[{"in"=>"query", "name"=>"sessionid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Users", "GetSettings"]}}, "viddler.users.setPlayerBranding"=>{"post"=>{"summary"=>"Users SetPlayerBranding", "description"=>"Sets your player branding options. All options are optional other than your sessionid. Color formats are inu00a0hexadecimalu00a0format with preceding pound sign (IE: #rrggbb)", "operationId"=>"users-setplayerbranding", "x-api-path-slug"=>"viddler-users-setplayerbranding-post", "parameters"=>[{"in"=>"query", "name"=>"bclicked"}, {"in"=>"query", "name"=>"bhover"}, {"in"=>"query", "name"=>"bidle"}, {"in"=>"query", "name"=>"control_bar"}, {"in"=>"query", "name"=>"enable_stripes"}, {"in"=>"query", "name"=>"logo_align"}, {"in"=>"query", "name"=>"logo_click_url"}, {"in"=>"query", "name"=>"logo_offset_x"}, {"in"=>"query", "name"=>"logo_offset_y"}, {"in"=>"query", "name"=>"logo_url"}, {"in"=>"query", "name"=>"logo_visible"}, {"in"=>"query", "name"=>"pclicked"}, {"in"=>"query", "name"=>"phover"}, {"in"=>"query", "name"=>"pidle"}, {"in"=>"query", "name"=>"sessionid"}, {"in"=>"query", "name"=>"shade_dark"}, {"in"=>"query", "name"=>"simple_color"}, {"in"=>"query", "name"=>"timebackground"}, {"in"=>"query", "name"=>"timeloaded"}, {"in"=>"query", "name"=>"timeplayed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Users", "SetPlayerBranding"]}}, "viddler.users.setProfile"=>{"get"=>{"summary"=>"Users SetProfile", "description"=>"Update your profile information.", "operationId"=>"users-setprofile", "x-api-path-slug"=>"viddler-users-setprofile-get", "parameters"=>[{"in"=>"query", "name"=>"avatar_url"}, {"in"=>"query", "name"=>"homepage"}, {"in"=>"query", "name"=>"sessionid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Users", "SetProfile"]}}, "viddler.videos.addClosedCaptioning"=>{"post"=>{"summary"=>"Videos AddClosedCaptioning", "description"=>"Add new closed captioning file for a specific video. All uploaded closed captioning files are enabled by default. The first uploaded file is default for a video.", "operationId"=>"videos-addclosedcaptioning", "x-api-path-slug"=>"viddler-videos-addclosedcaptioning-post", "parameters"=>[{"in"=>"query", "name"=>"closed_captioning_url"}, {"in"=>"query", "name"=>"default"}, {"in"=>"query", "name"=>"language", "description"=>"The language of the file (Max Characters: 50)"}, {"in"=>"query", "name"=>"sessionid"}, {"in"=>"query", "name"=>"video_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Videos", "AddClosedCaptioning"]}}, "viddler.videos.comments.get"=>{"get"=>{"summary"=>"Videos Comments Get", "description"=>"Get comments for a video. If logged in and querying comments for own video – all comments with any moderation status will be returned. If quering comments as logged out or for not owned video – only approved comments will be returned if the video itself is public.", "operationId"=>"videos-comments-get", "x-api-path-slug"=>"viddler-videos-comments-get-get", "parameters"=>[{"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"parent_id", "description"=>"comment parent ID if you want to get the responses to that particular comment"}, {"in"=>"query", "name"=>"per_page"}, {"in"=>"query", "name"=>"sessionid"}, {"in"=>"query", "name"=>"video_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Videos", "Comments", "Get"]}}, "viddler.videos.delClosedCaptioning"=>{"post"=>{"summary"=>"Videos DelClosedCaptioning", "description"=>"Remove an existing closed captioning file.", "operationId"=>"videos-delclosedcaptioning", "x-api-path-slug"=>"viddler-videos-delclosedcaptioning-post", "parameters"=>[{"in"=>"query", "name"=>"closed_captioning_id"}, {"in"=>"query", "name"=>"sessionid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Videos", "DelClosedCaptioning"]}}, "viddler.videos.delete"=>{"post"=>{"summary"=>"Videos Delete", "description"=>"Delete a video.", "operationId"=>"videos-delete", "x-api-path-slug"=>"viddler-videos-delete-post", "parameters"=>[{"in"=>"query", "name"=>"sessionid"}, {"in"=>"query", "name"=>"video_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Videos", "Delete"]}}, "viddler.videos.enableAds"=>{"post"=>{"summary"=>"Videos EnableAds", "description"=>"Turn ads off for specified videos.", "operationId"=>"videos-enableads", "x-api-path-slug"=>"viddler-videos-enableads-post", "parameters"=>[{"in"=>"query", "name"=>"sessionid"}, {"in"=>"query", "name"=>"video_ids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Videos", "EnableAds"]}}, "viddler.videos.getAdsStatus"=>{"get"=>{"summary"=>"Videos GetAdsStatus", "description"=>"viddler.videos.getAdsStatusnGET", "operationId"=>"videos-getadsstatus", "x-api-path-slug"=>"viddler-videos-getadsstatus-get", "parameters"=>[{"in"=>"query", "name"=>"sessionid"}, {"in"=>"query", "name"=>"video_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Videos", "GetAdsStatus"]}}, "viddler.videos.getEmbedCodeTypes"=>{"get"=>{"summary"=>"Videos GetEmbedCodeTypes", "description"=>"Return a list of the embed code types for your account.", "operationId"=>"videos-getembedcodetypes", "x-api-path-slug"=>"viddler-videos-getembedcodetypes-get", "parameters"=>[{"in"=>"query", "name"=>"sessionid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Videos", "GetEmbedCodeTypes"]}}, "viddler.videos.getRecordToken"=>{"get"=>{"summary"=>"Videos GetRecordToken", "description"=>"Return a record token to use with Viddler’s Flash video recorder.", "operationId"=>"videos-getrecordtoken", "x-api-path-slug"=>"viddler-videos-getrecordtoken-get", "parameters"=>[{"in"=>"query", "name"=>"sessionid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Videos", "GetRecordToken"]}}, "viddler.videos.prepareUpload"=>{"get"=>{"summary"=>"Videos PrepareUpload", "description"=>"Returns the end-point and token for a new upload session.", "operationId"=>"videos-prepareupload", "x-api-path-slug"=>"viddler-videos-prepareupload-get", "parameters"=>[{"in"=>"query", "name"=>"allow_replace", "description"=>"Set to true if you are allowing the incoming upload to replace an already existing video"}, {"in"=>"query", "name"=>"sessionid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Videos", "PrepareUpload"]}}, "viddler.videos.setClosedCaptioning"=>{"post"=>{"summary"=>"Videos SetClosedCaptioning", "description"=>"Update closed captioning details on a previously uploaded file.", "operationId"=>"videos-setclosedcaptioning", "x-api-path-slug"=>"viddler-videos-setclosedcaptioning-post", "parameters"=>[{"in"=>"query", "name"=>"closed_captioning_id"}, {"in"=>"query", "name"=>"default"}, {"in"=>"query", "name"=>"enabled"}, {"in"=>"query", "name"=>"language", "description"=>"The language of the file (Max Characters: 50)"}, {"in"=>"query", "name"=>"sessionid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Videos", "SetClosedCaptioning"]}}, "viddler.videos.uploadProgress"=>{"get"=>{"summary"=>"Videos UploadProgress", "description"=>"Return the status of an upload.", "operationId"=>"videos-uploadprogress", "x-api-path-slug"=>"viddler-videos-uploadprogress-get", "parameters"=>[{"in"=>"query", "name"=>"sessionid"}, {"in"=>"query", "name"=>"token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Viddler", "Videos", "UploadProgress"]}}}}, "apis"=>{"name"=>"Viddler", "x-slug"=>"viddler", "description"=>"Viddler is an online sales training platform with integrated tools for practice and evaluation. The Viddler service offers video-based instruction and optional coaching, and allows customers to engage with course content through guided assignments and self-recorded practice sessions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/274-viddler.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"81111", "tags"=>"Enterprise,internet,Relative Data,SaaS,Sales,Service API,Technology,Trainings,Videos", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"viddler/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Viddler API", "x-api-slug"=>"viddler--api", "description"=>"The Viddler API exposes Viddler’s key features to those that would like to build custom solutionson topof Viddler’s video platform.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/274-viddler.jpg", "humanURL"=>"http://www.viddler.com/", "baseURL"=>"https://api.viddler.com//api/v2", "tags"=>"Enterprise,internet,Relative Data,SaaS,Sales,Service API,Technology,Trainings,Videos", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/viddler/viddler-videos-uploadprogress-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/viddler/viddler--api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api.viddler.com/api/"}, {"type"=>"x-blog", "url"=>"http://blog.viddler.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.viddler.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/viddler"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/viddler"}, {"type"=>"x-developer", "url"=>"http://developers.viddler.com/"}, {"type"=>"x-email", "url"=>"sales@viddler.com"}, {"type"=>"x-email", "url"=>"privacy@viddler.com"}, {"type"=>"x-email", "url"=>"support@viddler.com"}, {"type"=>"x-email", "url"=>"copyright@viddler.com"}, {"type"=>"x-faq", "url"=>"http://www.viddler.com/help/"}, {"type"=>"x-github", "url"=>"https://github.com/viddler"}, {"type"=>"x-google-plus", "url"=>"https://plus.google.com/+viddler"}, {"type"=>"x-privacy", "url"=>"http://www.viddler.com/privacy-policy/"}, {"type"=>"x-terms-of-service", "url"=>"http://www.viddler.com/terms-of-use/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/viddler"}, {"type"=>"x-website", "url"=>"http://www.viddler.com/"}, {"type"=>"x-website", "url"=>"http://viddler.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-application-insights{"azure-application-insights-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Application Insights", "x-complete"=>1, "info"=>{"title"=>"Application Insights API", "description"=>"application-insights-in-preview-is-an-allinone-telemetry-solution-that-can-help-you-detect-issues-triage-impact-and-solve-problems-in-your-web-apps-and-services--it-provides-deep-diagnostics-and-realtime-insights-while-being-a-seamless-part-of-your-alm-processes-through-visual-studio-visual-studio-team-services-and-azure-diagnostics-integrations--it-supports-asp-net-j2ee-and-most-of-the-popular-web-technologies-for-web-apps-on-azure-or-on-your-own-servers-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/providers/microsoft.insights/operations"=>{"get"=>{"summary"=>"List Operations", "description"=>"Lists all of the available insights REST API operations.", "operationId"=>"Operations_List", "x-api-path-slug"=>"providersmicrosoft-insightsoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations"]}}, "/subscriptions/{subscriptionId}/providers/microsoft.insights/components"=>{"get"=>{"summary"=>"List Components", "description"=>"Gets a list of all Application Insights components within a subscription.", "operationId"=>"Components_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-insightscomponents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Components"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/components"=>{"get"=>{"summary"=>"List Components By Resource Group", "description"=>"Gets a list of Application Insights components within a resource group.", "operationId"=>"Components_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightscomponents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Components"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/components/{resourceName}"=>{"delete"=>{"summary"=>"Delete Components", "description"=>"Deletes an Application Insights component.", "operationId"=>"Components_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightscomponentsresourcename-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Components"]}, "get"=>{"summary"=>"Get Components", "description"=>"Returns an Application Insights component.", "operationId"=>"Components_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightscomponentsresourcename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Components"]}, "put"=>{"summary"=>"Create or Update Components", "description"=>"Creates (or updates) an Application Insights component. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.", "operationId"=>"Components_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightscomponentsresourcename-put", "parameters"=>[{"in"=>"body", "name"=>"InsightProperties", "description"=>"Properties that need to be specified to create an Application Insights component", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Components"]}, "patch"=>{"summary"=>"Update Components Tags", "description"=>"Updates an existing component's tags. To update other fields use the CreateOrUpdate method.", "operationId"=>"Components_UpdateTags", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightscomponentsresourcename-patch", "parameters"=>[{"in"=>"body", "name"=>"ComponentTags", "description"=>"Updated tag information to set into the component instance", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Components"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/webtests"=>{"get"=>{"summary"=>"Web Tests By Resource Group", "description"=>"Get all Application Insights web tests defined within a specified resource group.", "operationId"=>"WebTests_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightswebtests-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web Tests"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/webtests/{webTestName}"=>{"get"=>{"summary"=>"Get Web Tests", "description"=>"Get a specific Application Insights web test definition.", "operationId"=>"WebTests_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightswebtestswebtestname-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web Tests"]}, "put"=>{"summary"=>"Create or Update Web Tests", "description"=>"Creates or updates an Application Insights web test definition.", "operationId"=>"WebTests_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightswebtestswebtestname-put", "parameters"=>[{"in"=>"body", "name"=>"WebTestDefinition", "description"=>"Properties that need to be specified to create or update an Application Insights web test definition", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web Tests"]}, "patch"=>{"summary"=>"Update Web Tests Tags", "description"=>"Creates or updates an Application Insights web test definition.", "operationId"=>"WebTests_UpdateTags", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightswebtestswebtestname-patch", "parameters"=>[{"in"=>"body", "name"=>"WebTestTags", "description"=>"Updated tag information to set into the web test instance", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web Tests"]}, "delete"=>{"summary"=>"Delete Web Tests", "description"=>"Deletes an Application Insights web test.", "operationId"=>"WebTests_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightswebtestswebtestname-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web Tests"]}}, "/subscriptions/{subscriptionId}/providers/microsoft.insights/webtests"=>{"get"=>{"summary"=>"List Web Tests", "description"=>"Get all Application Insights web test alerts definitioned within a subscription.", "operationId"=>"WebTests_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-insightswebtests-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web Tests"]}}}}, "apis"=>{"name"=>"Azure Application Insights", "x-slug"=>"azure-application-insights", "description"=>"Get rich performance monitoring, powerful alerting, and easy-to-consume dashboards to help ensure your applications are available and performing as you expect. Quickly see if you have a problem, how many customers are affected, and perform a root cause analysis to find and fix the issue.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/performance-management.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Diagnostics,Microsoft,Monitoring,Profiles,Relative Data,Service API,Stack Network,Testing", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-application-insights/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Application Insights API", "x-api-slug"=>"azure-application-insights-api", "description"=>"Application Insights (in preview) is an all-in-one telemetry solution that can help you detect issues, triage impact and solve problems in your web apps and services. It provides deep diagnostics and real-time insights while being a seamless part of your ALM processes through Visual Studio, Visual Studio Team Services, and Azure Diagnostics integrations. It supports ASP.NET, J2EE and most of the popular web technologies for web apps on Azure or on your own servers.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/performance-management.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/application-insights/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Diagnostics,Microsoft,Monitoring,Profiles,Relative Data,Service API,Stack Network,Testing", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/azure-application-insights/azure-application-insights-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/application-insights/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/application-insights/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/application-insights/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/application-insights/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
respoke{"respoke-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Respoke", "x-complete"=>1, "info"=>{"title"=>"Respoke REST API", "description"=>"add-live-voice-video-text-and-data-features-to-your-website-or-app-", "termsOfService"=>"https://www.respoke.io/files/respoke-tos-20141007.pdf", "version"=>"v1"}, "host"=>"api.respoke.io", "basePath"=>"v1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"admin-sessions/"=>{"post"=>{"summary"=>"Admin Sessions", "description"=>"Log in with the account username and password. Get an Admin-Token.", "operationId"=>"postAdminSessions", "x-api-path-slug"=>"adminsessions-post", "parameters"=>[{"in"=>"query", "name"=>"password", "description"=>"Your password"}, {"in"=>"query", "name"=>"username", "description"=>"Your username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Sessions"]}}, "adminsessions/"=>{"post"=>{"summary"=>"Permissions", "description"=>"Full API permissions are obtained by POSTing your username and password to [base]/adminsessions.", "operationId"=>"postAdminsessions", "x-api-path-slug"=>"adminsessions-post", "parameters"=>[{"in"=>"query", "name"=>"password", "description"=>"Your username"}, {"in"=>"query", "name"=>"username", "description"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Adminsessions"]}}, "appauthsessions/"=>{"post"=>{"summary"=>"App Auth Sessions", "description"=>"Your users authenticate to Respoke using an App-Token obtained when they POST your tokenId to [base]/appauthsessions.", "operationId"=>"postAppauthsessions", "x-api-path-slug"=>"appauthsessions-post", "parameters"=>[{"in"=>"query", "name"=>"App-Token", "description"=>"Your application token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appauthsessions"]}}, "apps/"=>{"get"=>{"summary"=>"Apps", "description"=>"Create an app.", "operationId"=>"getApps", "x-api-path-slug"=>"apps-get", "parameters"=>[{"in"=>"header", "name"=>"Admin-Token", "description"=>"Your admin token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apps"]}}, "roles/"=>{"post"=>{"summary"=>"Roles", "description"=>"Create roleId and roleName for creating tokens.", "operationId"=>"postRoles", "x-api-path-slug"=>"roles-post", "parameters"=>[{"schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"App-Secret", "description"=>"Your application secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles"]}}, "session-tokens/"=>{"post"=>{"summary"=>"Session Tokens", "description"=>"An end-user client posts a tokenId from POST [base]/tokens to authenticate to an app as endpointId.", "operationId"=>"postSessionTokens", "x-api-path-slug"=>"sessiontokens-post", "parameters"=>[{"schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"App-Token", "description"=>"Your application token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session", "Tokens"]}}, "tokens/"=>{"post"=>{"summary"=>"Tokens", "description"=>"Get an access token tokenId for an end-user.", "operationId"=>"postTokens", "x-api-path-slug"=>"tokens-post", "parameters"=>[{"schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"App-Secret", "description"=>"Your application secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tokens"]}, "put"=>{"summary"=>"Tokens", "description"=>"By using the App-Secret header, you can perform API calls to obtain Respoke sessions for your users via POST to [base]/tokens. App-Secrets are found in the Dev Console.", "operationId"=>"putTokens", "x-api-path-slug"=>"tokens-put", "parameters"=>[{"in"=>"query", "name"=>"App-Secret", "description"=>"Your application token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tokens"]}}, "turn/"=>{"post"=>{"summary"=>"Turn", "description"=>"Get TURN credentials.", "operationId"=>"postTurn", "x-api-path-slug"=>"turn-post", "parameters"=>[{"in"=>"header", "name"=>"App-Token", "description"=>"Get TURN credentials"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Turn"]}}}}, "apis"=>{"name"=>"Respoke", "x-slug"=>"respoke", "description"=>"Respoke makes it incredibly easy to add real-time communications capabilities to the things you build. Integrate text chat, audio calling, video collaboration, screen sharing, and peer-to-peer data with just a few lines of JavaScript.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/respoke-web-communications-300x101.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"Change Log Example,Relative Data,Service API,Target,Voice", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"respoke/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Respoke", "x-api-slug"=>"respoke", "description"=>"Respoke makes it incredibly easy to add real-time communications capabilities to the things you build. Integrate text chat, audio calling, video collaboration, screen sharing, and peer-to-peer data with just a few lines of JavaScript.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/respoke-web-communications-300x101.jpg", "humanURL"=>"https://www.respoke.io", "baseURL"=>"https://api.respoke.io/v1/", "tags"=>"Change Log Example,Relative Data,Service API,Target,Voice", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/respoke/respoke-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-account-management", "url"=>"https://portal.respoke.io/#/account?section=Profile"}, {"type"=>"x-application-management", "url"=>"https://portal.respoke.io/#/apps"}, {"type"=>"x-authentication", "url"=>"https://docs.respoke.io/tutorials/brokered-auth.html"}, {"type"=>"x-billing-management", "url"=>"https://portal.respoke.io/#/account?section=Payments"}, {"type"=>"x-blog", "url"=>"http://blog.respoke.io/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.respoke.io/rss"}, {"type"=>"x-change-log", "url"=>"https://docs.respoke.io/reference/changelog.html"}, {"type"=>"x-developer", "url"=>"https://portal.respoke.io"}, {"type"=>"x-documentation", "url"=>"https://docs.respoke.io/"}, {"type"=>"x-email", "url"=>"info@respoke.io"}, {"type"=>"x-facebook", "url"=>"https://www.facebook.com/respokeIO"}, {"type"=>"x-forum", "url"=>"http://community.respoke.io/"}, {"type"=>"x-github", "url"=>"https://github.com/respoke"}, {"type"=>"x-google-plus", "url"=>"https://plus.google.com/+RespokeIo"}, {"type"=>"x-javascript-library", "url"=>"https://docs.respoke.io/js-library/respoke.html"}, {"type"=>"x-node-js-library", "url"=>"http://respoke.github.io/node-respoke-admin"}, {"type"=>"x-pricing", "url"=>"https://www.respoke.io/#pricing"}, {"type"=>"x-selfservice-registration", "url"=>"https://www.respoke.io/#sign-up-form"}, {"type"=>"x-starter-apps", "url"=>"https://docs.respoke.io/tutorials/example-apps.html"}, {"type"=>"x-terms-of-service", "url"=>"https://www.respoke.io/files/respoke-tos-20141007.pdf"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/respoke"}, {"type"=>"x-website", "url"=>"https://www.respoke.io"}, {"type"=>"x-website", "url"=>"http://respoke.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
duckduckgo{"duckduckgo-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DuckDuckGo", "x-complete"=>1, "info"=>{"title"=>"DuckDuckGo Instant Answer API", "description"=>"our-instant-answer-api-gives-you-free-access-to-many-of-our-instant-answers-like-topic-summaries-api-example-categories-api-example-disambiguation-api-example-and-bang-redirects-api-example--this-api-does-not-include-all-of-our-links-however--that-is-it-is-not-a-full-search-results-api-or-a-way-to-get-duckduckgo-results-into-your-applications-beyond-our-instant-answers--because-of-the-way-we-generate-our-search-results-we-unfortunately-do-not-have-the-rights-to-fully-syndicate-our-results-free-or-paid--for-the-same-reason-we-cannot-allow-framing-our-results-without-our-branding--please-see-our-partnerships-page-for-more-info-on-guidelines-and-getting-in-touch-with-us-", "version"=>"1.0.0"}, "host"=>"api.duckduckgo.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/"=>{"get"=>{"summary"=>"Search", "description"=>"Our Zero-click Info API gives you free access to much of our topic summaries, categories, disambiguation, !bang redirects, definitions and more.", "operationId"=>"zero-click-info", "x-api-path-slug"=>"get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Function to callback (for a JSONP formatted response)"}, {"in"=>"query", "name"=>"format"}, {"in"=>"query", "name"=>"no_html", "description"=>"1 to remove HTML from text, e"}, {"in"=>"query", "name"=>"no_redirect", "description"=>"1 to skip HTTP redirects (for !bang commands - see http://duckduckgo"}, {"in"=>"query", "name"=>"q", "description"=>"Search terms"}, {"in"=>"query", "name"=>"skip_disambig", "description"=>"1 to skip disambiguation (D) Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}}}, "apis"=>{"name"=>"DuckDuckGo", "x-slug"=>"duckduckgo", "description"=>"The Internet privacy company that empowers you to seamlessly take control of your personal information online, without any tradeoffs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/581-duckduckgo.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"286", "tags"=>"API Provider,General Data,internet,Mobile,Pedestal,Profiles,SaaS,Search,Search,Search engine,Stack Network,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"duckduckgo/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"DuckDuckGo", "x-api-slug"=>"duckduckgo", "description"=>"The Internet privacy company that empowers you to seamlessly take control of your personal information online, without any tradeoffs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/581-duckduckgo.jpg", "humanURL"=>"http://duckduckgo.com", "baseURL"=>"https://api.duckduckgo.com//", "tags"=>"API Provider,General Data,internet,Mobile,Pedestal,Profiles,SaaS,Search,Search,Search engine,Stack Network,Streams,Streams,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/duckduckgo/get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/duckduckgo/duckduckgo-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api.duckduckgo.com/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/duck-duck-go"}, {"type"=>"x-developer", "url"=>"https://duckduckgo.com/api"}, {"type"=>"x-github", "url"=>"https://github.com/duckduckgo"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/duckduckgo"}, {"type"=>"x-website", "url"=>"http://duckduckgo.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
dezrez{"dezrez-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Dezrez", "x-complete"=>1, "info"=>{"title"=>"Dezrez.Rezi.Client.Api", "version"=>"1.0.0"}, "host"=>"api.dezrez.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/account/{id}"=>{"get"=>{"summary"=>"Get Account By Id", "description"=>"Get account by id.", "operationId"=>"Account_GetByid", "x-api-path-slug"=>"apiaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Id"]}}, "/api/account/all"=>{"get"=>{"summary"=>"Get all accounts paginated", "description"=>"Get all accounts paginated.", "operationId"=>"Account_GetAllBypageSizeBypageNumber", "x-api-path-slug"=>"apiaccountall-get", "parameters"=>[{"in"=>"query", "name"=>"pageNumber"}, {"in"=>"query", "name"=>"pageSize"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Paginated"]}}, "/api/account/{id}/ledger"=>{"post"=>{"summary"=>"Retrieve ledger posting details for an account", "description"=>"Retrieve ledger posting details for an account.", "operationId"=>"Account_GetLedgerByidBydataContract", "x-api-path-slug"=>"apiaccountidledger-post", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Ledger", "Posting", "Detailsan", "Account"]}}, "/api/account/ledger"=>{"post"=>{"summary"=>"Retrive ledger postings without account id", "description"=>"Retrive ledger postings without account id.", "operationId"=>"Account_GetAllLedgerBydataContract", "x-api-path-slug"=>"apiaccountledger-post", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrive", "Ledger", "Postings", "Without", "Account", "Id"]}}, "/api/account/create"=>{"post"=>{"summary"=>"Create account for groupId provided", "description"=>"Create account for groupid provided.", "operationId"=>"Account_CreateGroupAccountBydataContract", "x-api-path-slug"=>"apiaccountcreate-post", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AccountgroupId", "Provided"]}}, "/api/account/setstatus"=>{"post"=>{"summary"=>"Set an accounts status", "description"=>"Set an accounts status.", "operationId"=>"Account_SetStatusBydataContract", "x-api-path-slug"=>"apiaccountsetstatus-post", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Accounts", "Status"]}}, "/api/account/{id}/update"=>{"put"=>{"summary"=>"Update account details", "description"=>"Update account details.", "operationId"=>"Account_UpdateAccountDetailsByidBydetailsDataContract", "x-api-path-slug"=>"apiaccountidupdate-put", "parameters"=>[{"in"=>"body", "name"=>"detailsDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Details"]}}, "/api/account/{id}/statement"=>{"post"=>{"summary"=>"Get a statement for an account", "description"=>"Get a statement for an account.", "operationId"=>"Account_GetStatementByidBystatementDataContract", "x-api-path-slug"=>"apiaccountidstatement-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"body", "name"=>"statementDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Statementan", "Account"]}}, "/api/account/createsystemaccount"=>{"post"=>{"summary"=>"Create a new System account eg. new client account", "description"=>"Create a new system account eg. new client account.", "operationId"=>"Account_CreateSystemAccountBydataContract", "x-api-path-slug"=>"apiaccountcreatesystemaccount-post", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "System", "Account", "Eg", "", "New", "Client", "Account"]}}, "/api/account/systemaccounts"=>{"get"=>{"summary"=>"Get list of all system accounts", "description"=>"Get list of all system accounts.", "operationId"=>"Account_GetSystemAccounts", "x-api-path-slug"=>"apiaccountsystemaccounts-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "", "System", "Accounts"]}}, "/api/account/{id}/balances"=>{"get"=>{"summary"=>"Get balance of an account", "description"=>"Get balance of an account.", "operationId"=>"Account_GetAccountBalancesByidBystartDateByendDate", "x-api-path-slug"=>"apiaccountidbalances-get", "parameters"=>[{"in"=>"query", "name"=>"endDate"}, {"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"query", "name"=>"startDate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Balance", "Of", "Account"]}}, "/api/account/pm/list"=>{"post"=>{"summary"=>"Get list of accounts with sorting and searching and by type of group for the accounts", "description"=>"Get list of accounts with sorting and searching and by type of group for the accounts.", "operationId"=>"Account_GetPMAccountsBydataContractBypageSizeBypageNumber", "x-api-path-slug"=>"apiaccountpmlist-post", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"pageNumber"}, {"in"=>"query", "name"=>"pageSize"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Accounts", "Sorting", "Searching", "By", "Type", "Of", "Groupthe", "Accounts"]}}, "/api/account/customer/overview"=>{"get"=>{"summary"=>"Get an overview of customer accounts", "description"=>"Get an overview of customer accounts.", "operationId"=>"Account_GetCustomersOverview", "x-api-path-slug"=>"apiaccountcustomeroverview-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Overview", "Of", "Customer", "Accounts"]}}, "/api/account/payments/overview"=>{"get"=>{"summary"=>"Get an overview of account amounts and totals", "description"=>"Get an overview of account amounts and totals.", "operationId"=>"Account_GetPaymentsOverview", "x-api-path-slug"=>"apiaccountpaymentsoverview-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Overview", "Of", "Account", "Amounts", "Totals"]}}, "/api/account/{id}/setbank"=>{"post"=>{"summary"=>"", "description"=>".", "operationId"=>"Account_SetBankByidBydataContract", "x-api-path-slug"=>"apiaccountidsetbank-post", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/api/account/{id}/receipts"=>{"get"=>{"summary"=>"Get Receipts for account", "description"=>"Get receipts for account.", "operationId"=>"Account_GetReceiptsByidBydepositId", "x-api-path-slug"=>"apiaccountidreceipts-get", "parameters"=>[{"in"=>"query", "name"=>"depositId"}, {"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receiptsaccount"]}}, "/api/account/{id}/deposits"=>{"get"=>{"summary"=>"Get Deposits processed for an Account", "description"=>"Get deposits processed for an account.", "operationId"=>"Account_GetDepositsByid", "x-api-path-slug"=>"apiaccountiddeposits-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deposits", "Processedan", "Account"]}}, "/api/account/{id}/invoiceoverview"=>{"post"=>{"summary"=>"Get summary of an account based on invoice amounts allocated", "description"=>"Get summary of an account based on invoice amounts allocated.", "operationId"=>"Account_GetInvoiceOverviewByidBydataContract", "x-api-path-slug"=>"apiaccountidinvoiceoverview-post", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Summary", "Of", "Account", "Based", "On", "Invoice", "Amounts", "Ocated"]}}, "/api/account/{id}/paymentoverview"=>{"post"=>{"summary"=>"Get payment overview for an account", "description"=>"Get payment overview for an account.", "operationId"=>"Account_GetAccountPaymentOverviewByid", "x-api-path-slug"=>"apiaccountidpaymentoverview-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment", "Overviewan", "Account"]}}, "/api/account/systemaccount"=>{"get"=>{"summary"=>"Get System Account for the Accounting System", "description"=>"Get system account for the accounting system.", "operationId"=>"Account_GetSystemAccount", "x-api-path-slug"=>"apiaccountsystemaccount-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["System", "Accountthe", "Accounting", "System"]}}, "/api/accounting/exports/batchexport"=>{"post"=>{"summary"=>"Get details for batch payment export", "description"=>"Get details for batch payment export.", "operationId"=>"AccountingExport_SetBatchPaymentExportBydataContract", "x-api-path-slug"=>"apiaccountingexportsbatchexport-post", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Detailsbatch", "Payment", "Export"]}}, "/api/accounting/exports/batch/{id}/removepayment"=>{"put"=>{"summary"=>"Remove an individual payment from batch export", "description"=>"Remove an individual payment from batch export.", "operationId"=>"AccountingExport_RemoveFromBatchByidBypaymentId", "x-api-path-slug"=>"apiaccountingexportsbatchidremovepayment-put", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"paymentId"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Individual", "Payment", "From", "Batch", "Export"]}}, "/api/accounting/exports/list/batches"=>{"get"=>{"summary"=>"Get list of batch exports", "description"=>"Get list of batch exports.", "operationId"=>"AccountingExport_GetBatchPaymentsBybankAccountIdByincludeProcessed", "x-api-path-slug"=>"apiaccountingexportslistbatches-get", "parameters"=>[{"in"=>"query", "name"=>"bankAccountId"}, {"in"=>"query", "name"=>"includeProcessed"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Batch", "Exports"]}}, "/api/accounting/exports/batchpaymentcsv"=>{"post"=>{"summary"=>"Get details formatted for batch payment csv", "description"=>"Get details formatted for batch payment csv.", "operationId"=>"AccountingExport_ExportBatchPaymentBydataContract", "x-api-path-slug"=>"apiaccountingexportsbatchpaymentcsv-post", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Details", "Formattedbatch", "Payment", "Csv"]}}, "/api/accounting/exports/ledgerentriescsv"=>{"post"=>{"summary"=>"Get ledger items formatted for export csv", "description"=>"Get ledger items formatted for export csv.", "operationId"=>"AccountingExport_ExportLedgerEntriesCsvBydataContract", "x-api-path-slug"=>"apiaccountingexportsledgerentriescsv-post", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ledger", "Items", "Formattedexport", "Csv"]}}, "/api/accountingsystem"=>{"get"=>{"summary"=>"Gets accounting system for a legal entity", "description"=>"Gets accounting system for a legal entity.", "operationId"=>"AccountingSystem_Get", "x-api-path-slug"=>"apiaccountingsystem-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Accounting", "Systema", "Legal", "Entity"]}}, "/api/accountingsystem/systembalance"=>{"get"=>{"summary"=>"Gets accounting system balance", "description"=>"Gets accounting system balance.", "operationId"=>"AccountingSystem_GetSystemBalance", "x-api-path-slug"=>"apiaccountingsystemsystembalance-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Accounting", "System", "Balance"]}, "put"=>{"summary"=>"Archives the accounting system", "description"=>"Archives the accounting system.", "operationId"=>"AccountingSystem_ArchiveSystemByforce", "x-api-path-slug"=>"apiaccountingsystemsystembalance-put", "parameters"=>[{"in"=>"query", "name"=>"force"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Archives", "Accounting", "System"]}}, "/api/accountingsystem/taxstatus"=>{"get"=>{"summary"=>"Get Tax Status of Accounting System", "description"=>"Get tax status of accounting system.", "operationId"=>"AccountingSystem_GetTaxStatus", "x-api-path-slug"=>"apiaccountingsystemtaxstatus-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tax", "Status", "Of", "Accounting", "System"]}}, "/api/accountingsystem/suspense"=>{"get"=>{"summary"=>"Get amount of funds held in suspense account of the accounting system", "description"=>"Get amount of funds held in suspense account of the accounting system.", "operationId"=>"AccountingSystem_GetSuspenseFunds", "x-api-path-slug"=>"apiaccountingsystemsuspense-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Amount", "Of", "Funds", "Held", "In", "Suspense", "Account", "Of", "Accounting", "System"]}}, "/api/accountingsystem/agentcash"=>{"get"=>{"summary"=>"Gets overview of the agent cash account", "description"=>"Gets overview of the agent cash account.", "operationId"=>"AccountingSystem_GetAgentCash", "x-api-path-slug"=>"apiaccountingsystemagentcash-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Overview", "Of", "Agent", "Cash", "Account"]}}, "/api/accountingsystem/enum/{enumType}"=>{"get"=>{"summary"=>"", "description"=>".", "operationId"=>"AccountingSystem_GetAccountingEnumsByenumType", "x-api-path-slug"=>"apiaccountingsystemenumenumtype-get", "parameters"=>[{"in"=>"path", "name"=>"enumType"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/api/accountingsystem/createofficeaccount"=>{"post"=>{"summary"=>"Create an office account for the accounting system", "description"=>"Create an office account for the accounting system.", "operationId"=>"AccountingSystem_CreateOfficeAccountBydataContract", "x-api-path-slug"=>"apiaccountingsystemcreateofficeaccount-post", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Office", "Accountthe", "Accounting", "System"]}}, "/api/accountingsystem/officeaccounts"=>{"get"=>{"summary"=>"Get list of office accounts associated with the accounting system", "description"=>"Get list of office accounts associated with the accounting system.", "operationId"=>"AccountingSystem_GetOfficeAccounts", "x-api-path-slug"=>"apiaccountingsystemofficeaccounts-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Office", "Accounts", "Associated", "Accounting", "System"]}}, "/api/accountingsystem/setprimaryaccount"=>{"post"=>{"summary"=>"Set Primary Bank Account for Accounting System", "description"=>"Set primary bank account for accounting system.", "operationId"=>"AccountingSystem_SetPrimarySystemBankAccountByid", "x-api-path-slug"=>"apiaccountingsystemsetprimaryaccount-post", "parameters"=>[{"in"=>"query", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Primary", "Bank", "AccountAccounting", "System"]}}, "/api/address/{id}"=>{"get"=>{"summary"=>"Get an address by its Id", "description"=>"Get an address by its id.", "operationId"=>"Address_GetByid", "x-api-path-slug"=>"apiaddressid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the address to get"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "By", "Its", "Id"]}}, "/api/address/{id}/centerpoint"=>{"put"=>{"summary"=>"Update the Center Point for an Address", "description"=>"Update the center point for an address.", "operationId"=>"Address_UpdateCenterPointByidByupdateCommand", "x-api-path-slug"=>"apiaddressidcenterpoint-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The Id of the address to update"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"body", "name"=>"updateCommand", "description"=>"The point details which will be updated on the address", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Center", "Pointan", "Ress"]}}, "/api/address/{id}/viewpoints/add"=>{"put"=>{"summary"=>"Adds one or more View Points for an Address", "description"=>"Adds one or more view points for an address.", "operationId"=>"Address_AddViewPointsByidByviewPoints", "x-api-path-slug"=>"apiaddressidviewpointsadd-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The Id of the address to update"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"body", "name"=>"viewPoints", "description"=>"One or more viewpoints to add", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "More", "View", "Pointsan", "Ress"]}}, "/api/address/{id}/viewpoints/edit"=>{"put"=>{"summary"=>"Edits one or more ViewPoints of an address", "description"=>"Edits one or more viewpoints of an address.", "operationId"=>"Address_EditViewPointsByidBypoints", "x-api-path-slug"=>"apiaddressidviewpointsedit-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The Id of the address to update"}, {"in"=>"body", "name"=>"points", "description"=>"One or more ViewPoints to edit", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edits", "More", "ViewPoints", "Of", "Address"]}}, "/api/address/{id}/viewpoints/remove"=>{"put"=>{"summary"=>"Removes one or more ViewPoints of an address", "description"=>"Removes one or more viewpoints of an address.", "operationId"=>"Address_RemoveViewPointsByidByviewpointIds", "x-api-path-slug"=>"apiaddressidviewpointsremove-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The Id of the address to update"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"body", "name"=>"viewpointIds", "description"=>"One or more ViewPoints Ids to remove", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Removes", "More", "ViewPoints", "Of", "Address"]}}, "/api/agency/branches"=>{"get"=>{"summary"=>"Get the branches for an agency", "description"=>"Get the branches for an agency.", "operationId"=>"Agency_Branches", "x-api-path-slug"=>"apiagencybranches-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branchesan", "Agency"]}}, "/api/agency/milestoneconfigurations"=>{"get"=>{"summary"=>"Get the milestone configurations for an agency", "description"=>"Get the milestone configurations for an agency.", "operationId"=>"Agency_MilestoneConfigurations", "x-api-path-slug"=>"apiagencymilestoneconfigurations-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Milestone", "Configurationsan", "Agency"]}}, "/api/agency/administrators"=>{"get"=>{"summary"=>"Get the administrators for an agency", "description"=>"Get the administrators for an agency.", "operationId"=>"Agency_Administrators", "x-api-path-slug"=>"apiagencyadministrators-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Administratorsan", "Agency"]}}, "/api/agency/accountmanager"=>{"get"=>{"summary"=>"Get the account manager for an agency", "description"=>"Get the account manager for an agency.", "operationId"=>"Agency_AccountManager", "x-api-path-slug"=>"apiagencyaccountmanager-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Manageran", "Agency"]}}, "/api/agency/meetingplaces"=>{"get"=>{"summary"=>"Get meeting places for an agency", "description"=>"Get meeting places for an agency.", "operationId"=>"Agency_MeetingPlaces", "x-api-path-slug"=>"apiagencymeetingplaces-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meeting", "Placesan", "Agency"]}}, "/api/agency/savemeetingplace"=>{"post"=>{"summary"=>"Saves a new meeting place to that particular agency", "description"=>"Saves a new meeting place to that particular agency.", "operationId"=>"Agency_SaveMeetingPlaceBydataContract", "x-api-path-slug"=>"apiagencysavemeetingplace-post", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Saves", "New", "Meeting", "Place", "To", "That", "Particular", "Agency"]}}, "/api/agency/fees"=>{"get"=>{"summary"=>"Get fees for logged in agency", "description"=>"Get fees for logged in agency.", "operationId"=>"Agency_FeesBytransactionTypeBydefaultOnly", "x-api-path-slug"=>"apiagencyfees-get", "parameters"=>[{"in"=>"query", "name"=>"defaultOnly"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"query", "name"=>"transactionType", "description"=>"The transaction type of the fee to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feeslogged", "In", "Agency"]}}, "/api/agency/updatefee"=>{"put"=>{"summary"=>"Add or update fee for logged in agency.", "description"=>"Add or update fee for logged in agency..", "operationId"=>"Agency_UpdateAgencyFeeByfeeDataContract", "x-api-path-slug"=>"apiagencyupdatefee-put", "parameters"=>[{"in"=>"body", "name"=>"feeDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Feelogged", "In", "Agency"]}}, "/api/agency/deletefee/{defaultFeeId}"=>{"delete"=>{"summary"=>"Delete fee for logged in agency.", "description"=>"Delete fee for logged in agency..", "operationId"=>"Agency_DeleteAgencyFeeBydefaultFeeId", "x-api-path-slug"=>"apiagencydeletefeedefaultfeeid-delete", "parameters"=>[{"in"=>"path", "name"=>"defaultFeeId"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feelogged", "In", "Agency"]}}, "/api/agency/teams"=>{"get"=>{"summary"=>"Returns a list of team groups for the agency.", "description"=>"Returns a list of team groups for the agency..", "operationId"=>"Agency_TeamsBypageSizeBypageNumberByteamType", "x-api-path-slug"=>"apiagencyteams-get", "parameters"=>[{"in"=>"query", "name"=>"pageNumber"}, {"in"=>"query", "name"=>"pageSize"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"query", "name"=>"teamType"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "List", "Of", "Team", "Groupsthe", "Agency"]}}, "/api/agency/portalconfigurations"=>{"get"=>{"summary"=>"Get a list of portal configurations for the brand within a branch.", "description"=>"Get a list of portal configurations for the brand within a branch..", "operationId"=>"Agency_PortalConfigurationsBypageSizeBypageNumber", "x-api-path-slug"=>"apiagencyportalconfigurations-get", "parameters"=>[{"in"=>"query", "name"=>"pageNumber"}, {"in"=>"query", "name"=>"pageSize"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Portal", "Configurationsthe", "Brand", "Within", "Branch"]}}, "/api/agency/updateportalcustomisation"=>{"put"=>{"summary"=>"THIS IS A TEMPORARY ENDPOINT TO Update a portal customisation against a brand within a branch.\r\nPLEASE NOTE: This will be replaced by a FE Tool in future. If not, Security must be improved.", "description"=>"This is a temporary endpoint to update a portal customisation against a brand within a branch.\r\nplease note: this will be replaced by a fe tool in future. if not, security must be improved..", "operationId"=>"Agency_UpdatePortalCustomisationByportalCustomisation", "x-api-path-slug"=>"apiagencyupdateportalcustomisation-put", "parameters"=>[{"in"=>"body", "name"=>"portalCustomisation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["THIS", "IS", "TEMPORARY", "ENDPOINT", "TO", "", "Portal", "Customisation", "Against", "Brand", "Within", "Branch", "PLEASE", "NOTE:", "This", "Will", "Be", "Replaced", "By", "FE", "Tool", "In", "Future", "", "If", "Not", "", "Security", "Must", "Be", "Improved"]}}, "/api/agency/apikey"=>{"post"=>{"summary"=>"Issues an API key for use with the simple role/search endpoints", "description"=>"Issues an api key for use with the simple role/search endpoints.", "operationId"=>"Agency_IssueApiKeyBysubjectId", "x-api-path-slug"=>"apiagencyapikey-post", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"query", "name"=>"subjectId", "description"=>"The Id of the group to assign a key to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Issues", "Keyuse", "Simple", "Role", "Search", "Endpoints"]}}, "/api/agency/feestructure"=>{"get"=>{"summary"=>"Gets the fee structure of the agency", "description"=>"Gets the fee structure of the agency.", "operationId"=>"Agency_GetFeeStructure", "x-api-path-slug"=>"apiagencyfeestructure-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Fee", "Structure", "Of", "Agency"]}}, "/api/agency/getvatrate"=>{"get"=>{"summary"=>"Gets the current VAT rate unless the date is specified", "description"=>"Gets the current vat rate unless the date is specified.", "operationId"=>"Agency_GetVatRateByvatRateTypeByvatDate", "x-api-path-slug"=>"apiagencygetvatrate-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"query", "name"=>"vatDate", "description"=>"Date of VAT value, used to get historic or future VAT Rates"}, {"in"=>"query", "name"=>"vatRateType", "description"=>"Vat Rate type, standard is currently option"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Current", "VAT", "Rate", "Unless", "Date", "Is", "Specified"]}}, "/api/agency/{id}/getbrand"=>{"get"=>{"summary"=>"Get a specific brand by brandId or default agency brand if brandId is not supplied.", "description"=>"Get a specific brand by brandid or default agency brand if brandid is not supplied..", "operationId"=>"Agency_GetAgencyBrandByidBybrandId", "x-api-path-slug"=>"apiagencyidgetbrand-get", "parameters"=>[{"in"=>"query", "name"=>"brandId", "description"=>"The id of brand to get"}, {"in"=>"path", "name"=>"id", "description"=>"The id of an agency"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "Brand", "By", "BrandId", "Default", "Agency", "Brand", "If", "BrandId", "Is", "Not", "Supplied"]}}, "/api/agency/tenantclause"=>{"get"=>{"summary"=>"Get meeting places for an agency", "description"=>"Get meeting places for an agency.", "operationId"=>"Agency_TenantClause", "x-api-path-slug"=>"apiagencytenantclause-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meeting", "Placesan", "Agency"]}}, "/api/Agency"=>{"get"=>{"summary"=>"Get details of the current users agency", "description"=>"Get details of the current users agency.", "operationId"=>"Agency_Get", "x-api-path-slug"=>"apiagency-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Details", "Of", "Current", "Users", "Agency"]}}, "/api/admin/agency/{id}/setfeestructure"=>{"post"=>{"summary"=>"Sets the fee structure on an agency", "description"=>"Sets the fee structure on an agency.", "operationId"=>"AgencyAdmin_SetFeeStructureByidByfeeStructure", "x-api-path-slug"=>"apiadminagencyidsetfeestructure-post", "parameters"=>[{"in"=>"body", "name"=>"feeStructure", "description"=>"The fee structure text", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The agency id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sets", "Fee", "Structure", "On", "Agency"]}}, "/api/amenitydescription/Save"=>{"post"=>{"summary"=>"Save or update an Amenity Description", "description"=>"Save or update an amenity description.", "operationId"=>"AmenityDescription_SaveDescriptionByamenityDescriptionDataContract", "x-api-path-slug"=>"apiamenitydescriptionsave-post", "parameters"=>[{"in"=>"body", "name"=>"amenityDescriptionDataContract", "description"=>"The amenity description to save", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Save", "Update", "Amenity", "Description"]}}, "/api/amenitydescription/Delete"=>{"delete"=>{"summary"=>"Delete an Amenity Description by its Id", "description"=>"Delete an amenity description by its id.", "operationId"=>"AmenityDescription_DeleteDescriptionByid", "x-api-path-slug"=>"apiamenitydescriptiondelete-delete", "parameters"=>[{"in"=>"query", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Amenity", "Description", "By", "Its", "Id"]}}, "/api/AmenityDescription/{id}"=>{"get"=>{"summary"=>"Get an Amenity Description by its Id", "description"=>"Get an amenity description by its id.", "operationId"=>"AmenityDescription_GetByid", "x-api-path-slug"=>"apiamenitydescriptionid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Amenity", "Description", "By", "Its", "Id"]}}, "/api/analytics/campaigns"=>{"get"=>{"summary"=>"returns a list of all of the campaigns for an agency", "description"=>"Returns a list of all of the campaigns for an agency.", "operationId"=>"Analytics_GetCampaigns", "x-api-path-slug"=>"apianalyticscampaigns-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "List", "Of", "", "Of", "Campaignsan", "Agency"]}}, "/api/analytics/saveorupdategoogle"=>{"post"=>{"summary"=>"Updates or Creates a Campaign", "description"=>"Updates or creates a campaign.", "operationId"=>"Analytics_UpdateGoogleCampaignBycampaign", "x-api-path-slug"=>"apianalyticssaveorupdategoogle-post", "parameters"=>[{"in"=>"body", "name"=>"campaign", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Creates", "Campaign"]}}, "/api/analytics/unlinktemplate/{templateId}"=>{"post"=>{"summary"=>"Updates or Creates a Campaign", "description"=>"Updates or creates a campaign.", "operationId"=>"Analytics_UpdateGoogleCampaignBytemplateId", "x-api-path-slug"=>"apianalyticsunlinktemplatetemplateid-post", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"path", "name"=>"templateId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Creates", "Campaign"]}}, "/api/analytics/delete/{id}"=>{"delete"=>{"summary"=>"Updates or Creates a Campaign", "description"=>"Updates or creates a campaign.", "operationId"=>"Analytics_DeleteCampaignByid", "x-api-path-slug"=>"apianalyticsdeleteid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Creates", "Campaign"]}}, "/api/appointment/{id}"=>{"get"=>{"summary"=>"Get an appointment by its id.", "description"=>"Get an appointment by its id..", "operationId"=>"Appointment_GetByid", "x-api-path-slug"=>"apiappointmentid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the appointment to get"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointment", "By", "Its", "Id"]}}, "/api/appointment/{id}/Date/{date}"=>{"get"=>{"summary"=>"Get details of a calculated appointment using it's id and date.", "description"=>"Get details of a calculated appointment using it's id and date..", "operationId"=>"Appointment_GetByidBydate", "x-api-path-slug"=>"apiappointmentiddatedate-get", "parameters"=>[{"in"=>"path", "name"=>"date"}, {"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Details", "Of", "Calculated", "Appointment", "Using", "Its", "Id", "Date"]}}, "/api/appointment/delete/{id}"=>{"put"=>{"summary"=>"Delete an appointment by id if it exists.", "description"=>"Delete an appointment by id if it exists..", "operationId"=>"Appointment_DeleteByidBydeleteAppointmentDataContract", "x-api-path-slug"=>"apiappointmentdeleteid-put", "parameters"=>[{"in"=>"body", "name"=>"deleteAppointmentDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"the appointment id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointment", "By", "Id", "If", "It", "Exists"]}}, "/api/appointment/cancel/{id}"=>{"put"=>{"summary"=>"Cancel an appointment by id if it exists.", "description"=>"Cancel an appointment by id if it exists..", "operationId"=>"Appointment_CancelByidBycancelAppointmentDataContract", "x-api-path-slug"=>"apiappointmentcancelid-put", "parameters"=>[{"in"=>"body", "name"=>"cancelAppointmentDataContract", "description"=>"The cancellation details, including reason of cancellation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"the appointment id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Appointment", "By", "Id", "If", "It", "Exists"]}}, "/api/appointment/cancel/{id}/Date/{date}"=>{"put"=>{"summary"=>"Cancel calculated appointment by id and datetime, if it exists.", "description"=>"Cancel calculated appointment by id and datetime, if it exists..", "operationId"=>"Appointment_CancelByidBydateBycancelAppointmentDataContract", "x-api-path-slug"=>"apiappointmentcanceliddatedate-put", "parameters"=>[{"in"=>"body", "name"=>"cancelAppointmentDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"date", "description"=>"appointment start date"}, {"in"=>"path", "name"=>"id", "description"=>"appointment id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Calculated", "Appointment", "By", "Id", "Datetime", "", "If", "It", "Exists"]}}, "/api/appointment/appointmentstatus/{id}"=>{"put"=>{"summary"=>"", "description"=>".", "operationId"=>"Appointment_AppointmentConfirmationByidBystatus", "x-api-path-slug"=>"apiappointmentappointmentstatusid-put", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"body", "name"=>"status", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/api/appointment/saveappointment"=>{"put"=>{"summary"=>"Save or update an appointment.", "description"=>"Save or update an appointment..", "operationId"=>"Appointment_SaveAppointmentByappointment", "x-api-path-slug"=>"apiappointmentsaveappointment-put", "parameters"=>[{"in"=>"body", "name"=>"appointment", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Save", "Update", "Appointment"]}}, "/api/appointment/freebusy"=>{"post"=>{"summary"=>"Returns Free/Busy information regarding multiple people.", "description"=>"Returns free/busy information regarding multiple people..", "operationId"=>"Appointment_GetFreeBusyByquery", "x-api-path-slug"=>"apiappointmentfreebusy-post", "parameters"=>[{"in"=>"body", "name"=>"query", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Free", "Busy", "Information", "Regarding", "Multiple", "People"]}}, "/api/appointment/suggest"=>{"post"=>{"summary"=>"Auto-picks attendees and the next available appointment slot given the parameters in the request.", "description"=>"Auto-picks attendees and the next available appointment slot given the parameters in the request..", "operationId"=>"Appointment_SuggestAppointmentSlotByrequest", "x-api-path-slug"=>"apiappointmentsuggest-post", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"An appointment suggest request containing information about the desired appointment", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auto-picks", "Attendees", "Next", "Available", "Appointment", "Slot", "Given", "Parameters", "In", "Request"]}}, "/api/auction/{id}"=>{"get"=>{"summary"=>"Get an auction by its id.", "description"=>"Get an auction by its id..", "operationId"=>"Auction_GetByid", "x-api-path-slug"=>"apiauctionid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the auction to get"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auction", "By", "Its", "Id"]}}, "/api/auction/saveauction"=>{"put"=>{"summary"=>"Save or update an auction.", "description"=>"Save or update an auction..", "operationId"=>"Auction_SaveAuctionByauction", "x-api-path-slug"=>"apiauctionsaveauction-put", "parameters"=>[{"in"=>"body", "name"=>"auction", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Save", "Update", "Auction"]}}, "/api/auction/{id}/confirmlots"=>{"post"=>{"summary"=>"To confirm or unconfirm a list of lots for the auction", "description"=>"To confirm or unconfirm a list of lots for the auction.", "operationId"=>"Auction_ConfirmLotsByidByconfirmLotsDataContract", "x-api-path-slug"=>"apiauctionidconfirmlots-post", "parameters"=>[{"in"=>"body", "name"=>"confirmLotsDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["To", "Confirm", "Unconfirm", "List", "Of", "Lotsthe", "Auction"]}}, "/api/auction/{id}/withdrawlots"=>{"post"=>{"summary"=>"To withdraw a list of properties from the auction", "description"=>"To withdraw a list of properties from the auction.", "operationId"=>"Auction_WithdrawLotsByidBywithdrawLotsDataContract", "x-api-path-slug"=>"apiauctionidwithdrawlots-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The auction ID"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"body", "name"=>"withdrawLotsDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["To", "Withdraw", "List", "Of", "Properties", "From", "Auction"]}}, "/api/auction/{id}/postponelots"=>{"post"=>{"summary"=>"To postpone a list of lots for the auction", "description"=>"To postpone a list of lots for the auction.", "operationId"=>"Auction_PostponeLotsByidBypostponeLotsDataContract", "x-api-path-slug"=>"apiauctionidpostponelots-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The auction ID"}, {"in"=>"body", "name"=>"postponeLotsDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["To", "Postpone", "List", "Of", "Lotsthe", "Auction"]}}, "/api/auction/savecontact"=>{"post"=>{"summary"=>"Add a new contact to the given auction Role or edit an existing contact", "description"=>"Add a new contact to the given auction role or edit an existing contact.", "operationId"=>"Auction_SaveAuctionContactBysaveContactDataContract", "x-api-path-slug"=>"apiauctionsavecontact-post", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"body", "name"=>"saveContactDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Contact", "To", "Given", "Auction", "Role", "Edit", "Existing", "Contact"]}}, "/api/auction/removecontact"=>{"post"=>{"summary"=>"Remove an existing auction contact from the auction role", "description"=>"Remove an existing auction contact from the auction role.", "operationId"=>"Auction_RemoveAuctionContactByremoveContactDataContract", "x-api-path-slug"=>"apiauctionremovecontact-post", "parameters"=>[{"in"=>"body", "name"=>"removeContactDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Existing", "Auction", "Contact", "From", "Auction", "Role"]}}, "/api/auction/{id}/recordbid"=>{"post"=>{"summary"=>"Record auction bid details", "description"=>"Record auction bid details.", "operationId"=>"Auction_ReccordAuctionBidByidBydataContactDataContract", "x-api-path-slug"=>"apiauctionidrecordbid-post", "parameters"=>[{"in"=>"body", "name"=>"dataContactDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Record", "Auction", "Bid", "Details"]}}, "/api/progression/auction/instructforauction"=>{"post"=>{"summary"=>"Instructs a role to be let", "description"=>"Instructs a role to be let.", "operationId"=>"AuctionProgression_InstructForAuctionByinstructToSellCommandDataContract", "x-api-path-slug"=>"apiprogressionauctioninstructforauction-post", "parameters"=>[{"in"=>"body", "name"=>"instructToSellCommandDataContract", "description"=>"Details of the instruction", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instructs", "Role", "To", "Be", "Let"]}}, "/api/role/auction/{id}/setrequestedlotnumber"=>{"post"=>{"summary"=>"Set the requested lot number for a property auction role.", "description"=>"Set the requested lot number for a property auction role..", "operationId"=>"AuctionRole_SetRequestedLotNumberByidBylotNumber", "x-api-path-slug"=>"apiroleauctionidsetrequestedlotnumber-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"the id of the role"}, {"in"=>"query", "name"=>"lotNumber", "description"=>"the requested lot number"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Requested", "Lot", "Numbera", "Property", "Auction", "Role"]}}, "/api/role/auction/{id}/setlotnumber"=>{"post"=>{"summary"=>"Set the lot number for a property auction role.", "description"=>"Set the lot number for a property auction role..", "operationId"=>"AuctionRole_SetLotNumberByidByauctionIdBylotNumber", "x-api-path-slug"=>"apiroleauctionidsetlotnumber-post", "parameters"=>[{"in"=>"query", "name"=>"auctionId", "description"=>"the id of the auction to set the lot number for"}, {"in"=>"path", "name"=>"id", "description"=>"the id of the role"}, {"in"=>"query", "name"=>"lotNumber", "description"=>"the lot number"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Lot", "Numbera", "Property", "Auction", "Role"]}}, "/api/role/auction/{id}/addtoauction"=>{"post"=>{"summary"=>"Add a property auction role to an existing auction", "description"=>"Add a property auction role to an existing auction.", "operationId"=>"AuctionRole_AddToAuctionByidByauctionIdBylotNumber", "x-api-path-slug"=>"apiroleauctionidaddtoauction-post", "parameters"=>[{"in"=>"query", "name"=>"auctionId", "description"=>"the id of the auction to add the role to"}, {"in"=>"path", "name"=>"id", "description"=>"the id of the role"}, {"in"=>"query", "name"=>"lotNumber", "description"=>"the lot number"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Property", "Auction", "Role", "To", "Existing", "Auction"]}}, "/api/role/auction/{id}/removefromauction"=>{"post"=>{"summary"=>"Add a property auction role to an existing auction", "description"=>"Add a property auction role to an existing auction.", "operationId"=>"AuctionRole_RemoveFromAuctionByidByremoveFromAuctionDataContract", "x-api-path-slug"=>"apiroleauctionidremovefromauction-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"the id of the role"}, {"in"=>"body", "name"=>"removeFromAuctionDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Property", "Auction", "Role", "To", "Existing", "Auction"]}}, "/api/role/auction/{id}/setreserve"=>{"post"=>{"summary"=>"Set the reserve for a property auction role.", "description"=>"Set the reserve for a property auction role..", "operationId"=>"AuctionRole_SetReserveByidBysetReserveDataContract", "x-api-path-slug"=>"apiroleauctionidsetreserve-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"the id of the role"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"body", "name"=>"setReserveDataContract", "description"=>"SetReserveDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Reservea", "Property", "Auction", "Role"]}}, "/api/role/auction/{id}/settype"=>{"post"=>{"summary"=>"Set the type of auction role (Commercial or Residential)", "description"=>"Set the type of auction role (commercial or residential).", "operationId"=>"AuctionRole_SetTypeByidByauctionRoleTypeSystemName", "x-api-path-slug"=>"apiroleauctionidsettype-post", "parameters"=>[{"in"=>"query", "name"=>"auctionRoleTypeSystemName", "description"=>"The auction role type"}, {"in"=>"path", "name"=>"id", "description"=>"the id of the role"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Type", "Of", "Auction", "Role", "(Commercial", "Residential)"]}}, "/api/role/auction/milestone/{roleId}"=>{"get"=>{"summary"=>"Get auction role milestones", "description"=>"Get auction role milestones.", "operationId"=>"AuctionRole_GetRoleMilestonesByroleId", "x-api-path-slug"=>"apiroleauctionmilestoneroleid-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"path", "name"=>"roleId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auction", "Role", "Milestones"]}, "put"=>{"summary"=>"Update an auction role milestone", "description"=>"Update an auction role milestone.", "operationId"=>"AuctionRole_SaveAuctionMilestoneByroleIdBydataContract", "x-api-path-slug"=>"apiroleauctionmilestoneroleid-put", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"path", "name"=>"roleId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auction", "Role", "Milestone"]}, "post"=>{"summary"=>"Add a new auction role milestone", "description"=>"Add a new auction role milestone.", "operationId"=>"AuctionRole_AddAuctionMilestoneByroleIdBydataContract", "x-api-path-slug"=>"apiroleauctionmilestoneroleid-post", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"path", "name"=>"roleId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Auction", "Role", "Milestone"]}}, "/api/role/auction/milestone/{roleId}/{milestoneId}"=>{"delete"=>{"summary"=>"Delete a custom auction milestone", "description"=>"Delete a custom auction milestone.", "operationId"=>"AuctionRole_DeleteAuctionMilestoneByroleIdBymilestoneId", "x-api-path-slug"=>"apiroleauctionmilestoneroleidmilestoneid-delete", "parameters"=>[{"in"=>"path", "name"=>"milestoneId"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"path", "name"=>"roleId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Auction", "Milestone"]}}, "/api/role/auction/milestone/{roleId}/create"=>{"put"=>{"summary"=>"Create default milestones for role if they dont exist", "description"=>"Create default milestones for role if they dont exist.", "operationId"=>"AuctionRole_PopulateAuctionMilestonesByroleId", "x-api-path-slug"=>"apiroleauctionmilestoneroleidcreate-put", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"path", "name"=>"roleId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Default", "Milestonesrole", "If", "They", "Dont", "Exist"]}}, "/api/branch/{id}"=>{"get"=>{"summary"=>"Get a Branch by its id.", "description"=>"Get a branch by its id..", "operationId"=>"Branch_GetByid", "x-api-path-slug"=>"apibranchid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the Branch to get"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branch", "By", "Its", "Id"]}}, "/api/branch/{id}/Brandings"=>{"get"=>{"summary"=>"Get a Branch brandings by its id.", "description"=>"Get a branch brandings by its id..", "operationId"=>"Branch_BrandingsByid", "x-api-path-slug"=>"apibranchidbrandings-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the Branch brandings to get"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branch", "Brandings", "By", "Its", "Id"]}}, "/api/branch/{id}/administrators"=>{"get"=>{"summary"=>"Get Branch administrators by its id.", "description"=>"Get branch administrators by its id..", "operationId"=>"Branch_AdministratorsByid", "x-api-path-slug"=>"apibranchidadministrators-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the Branch administrators to get"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branch", "Administrators", "By", "Its", "Id"]}}, "/api/branch/{id}/members"=>{"get"=>{"summary"=>"Get Branch members by its id.", "description"=>"Get branch members by its id..", "operationId"=>"Branch_MembersByid", "x-api-path-slug"=>"apibranchidmembers-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the Branch members to get"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branch", "Members", "By", "Its", "Id"]}}, "/api/branch/{id}/addnegotiator"=>{"post"=>{"summary"=>"Adds a negoatiator to a branch", "description"=>"Adds a negoatiator to a branch.", "operationId"=>"Branch_AddNegotiatorByidBycommand", "x-api-path-slug"=>"apibranchidaddnegotiator-post", "parameters"=>[{"in"=>"body", "name"=>"command", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Negoatiator", "To", "Branch"]}}, "/api/branch/{id}/getbrand"=>{"get"=>{"summary"=>"Get a specific brand by brandId or default brand within a branch if brandId is not supplied.", "description"=>"Get a specific brand by brandid or default brand within a branch if brandid is not supplied..", "operationId"=>"Branch_GetBranchBrandByidBybrandId", "x-api-path-slug"=>"apibranchidgetbrand-get", "parameters"=>[{"in"=>"query", "name"=>"brandId", "description"=>"The id of brand to get"}, {"in"=>"path", "name"=>"id", "description"=>"The id of a branch"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "Brand", "By", "BrandId", "Default", "Brand", "Within", "Branch", "If", "BrandId", "Is", "Not", "Supplied"]}}, "/api/branch/updatefee"=>{"put"=>{"summary"=>"Add or update fee for logged in branch.", "description"=>"Add or update fee for logged in branch..", "operationId"=>"Branch_UpdateBranchFeeByfeeDataContract", "x-api-path-slug"=>"apibranchupdatefee-put", "parameters"=>[{"in"=>"body", "name"=>"feeDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Feelogged", "In", "Branch"]}}, "/api/branch/deletefee/{defaultFeeId}"=>{"delete"=>{"summary"=>"Delete fee for logged in branch.", "description"=>"Delete fee for logged in branch..", "operationId"=>"Branch_DeleteBranchFeeBydefaultFeeId", "x-api-path-slug"=>"apibranchdeletefeedefaultfeeid-delete", "parameters"=>[{"in"=>"path", "name"=>"defaultFeeId"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feelogged", "In", "Branch"]}}, "/api/branch/fees"=>{"get"=>{"summary"=>"Get fees for logged in branch.", "description"=>"Get fees for logged in branch..", "operationId"=>"Branch_GetFeesBytransactionTypeBydefaultOnly", "x-api-path-slug"=>"apibranchfees-get", "parameters"=>[{"in"=>"query", "name"=>"defaultOnly"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"query", "name"=>"transactionType"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feeslogged", "In", "Branch"]}}, "/api/branch/updatefeelevel"=>{"put"=>{"summary"=>"Update the Fee Level Setting for branch", "description"=>"Update the fee level setting for branch.", "operationId"=>"Branch_UpdateFeeLevelByfeeLevel", "x-api-path-slug"=>"apibranchupdatefeelevel-put", "parameters"=>[{"in"=>"query", "name"=>"feeLevel"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fee", "Level", "Settingbranch"]}}, "/api/branch/createscheduledmailmerge"=>{"post"=>{"summary"=>"Save a scheduled mail merge.", "description"=>"Save a scheduled mail merge..", "operationId"=>"Branch_CreateScheduledMailMergeByscheduledMailMerge", "x-api-path-slug"=>"apibranchcreatescheduledmailmerge-post", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"body", "name"=>"scheduledMailMerge", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Save", "Scheduled", "Mail", "Merge"]}}, "/api/branch/scheduledmailmerges"=>{"get"=>{"summary"=>"Get all scheduled mail merges for the logged in branch.", "description"=>"Get all scheduled mail merges for the logged in branch..", "operationId"=>"Branch_GetScheduledMailMergesBypageSizeBypageNumber", "x-api-path-slug"=>"apibranchscheduledmailmerges-get", "parameters"=>[{"in"=>"query", "name"=>"pageNumber"}, {"in"=>"query", "name"=>"pageSize"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scheduled", "Mail", "Mergesthe", "Logged", "In", "Branch"]}}, "/api/branch/updatescheduledtaskstatus/{id}"=>{"post"=>{"summary"=>"Update SystemStatus of ScheduledTask to Active, Inactive, Deleted or Archived.", "description"=>"Update systemstatus of scheduledtask to active, inactive, deleted or archived..", "operationId"=>"Branch_UpdateScheduledTaskStatusByidBysystemStatus", "x-api-path-slug"=>"apibranchupdatescheduledtaskstatusid-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"query", "name"=>"systemStatus"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SystemStatus", "Of", "ScheduledTask", "To", "Active", "", "Inactive", "", "D", "Archived"]}}, "/api/branch/checkkeycodesexist"=>{"get"=>{"summary"=>"Check specified key codes exist in branch", "description"=>"Check specified key codes exist in branch.", "operationId"=>"Branch_CheckKeycodesExistBykeyCodes", "x-api-path-slug"=>"apibranchcheckkeycodesexist-get", "parameters"=>[{"in"=>"query", "name"=>"keyCodes"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Check", "Specified", "Key", "Codes", "Exist", "In", "Branch"]}}, "/api/branding/{id}"=>{"get"=>{"summary"=>"", "description"=>".", "operationId"=>"Branding_GetByid", "x-api-path-slug"=>"apibrandingid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/api/branding/getallbrands"=>{"get"=>{"summary"=>"Get all brands with details for an agency", "description"=>"Get all brands with details for an agency.", "operationId"=>"Branding_GetAllBrandsForAgency", "x-api-path-slug"=>"apibrandinggetallbrands-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Brands", "Detailsan", "Agency"]}}, "/api/branding/branch"=>{"get"=>{"summary"=>"Gets a sumary all of the brands for a branch", "description"=>"Gets a sumary all of the brands for a branch.", "operationId"=>"Branding_GetBranch", "x-api-path-slug"=>"apibrandingbranch-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Sumary", "", "Of", "Brandsa", "Branch"]}}, "/api/branding/{id}/attachexternaldocument"=>{"put"=>{"summary"=>"Attaches an external document to brand.", "description"=>"Attaches an external document to brand..", "operationId"=>"Branding_AttachExternalDocumentByidByexternalDocument", "x-api-path-slug"=>"apibrandingidattachexternaldocument-put", "parameters"=>[{"in"=>"body", "name"=>"externalDocument", "description"=>"Details of the external document", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The BrandId"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attaches", "External", "Document", "To", "Brand"]}}, "/api/branding/{id}/uploadandattachdocument"=>{"put"=>{"summary"=>"Uploads and attaches a document to a brand.", "description"=>"Uploads and attaches a document to a brand..", "operationId"=>"Branding_UploadAndAttachDocumentByidBydocumentDetails", "x-api-path-slug"=>"apibrandingiduploadandattachdocument-put", "parameters"=>[{"in"=>"body", "name"=>"documentDetails", "description"=>"Details of the file", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The brandId"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Uploads", "Attaches", "Document", "To", "Brand"]}}, "/api/branding/{id}/uploadandattachdocumenttodefault"=>{"put"=>{"summary"=>"Uploads and attaches a document to a brand.", "description"=>"Uploads and attaches a document to a brand..", "operationId"=>"Branding_UploadAndAttachDocumentToDefaultBrandBydocumentDetailsByid", "x-api-path-slug"=>"apibrandingiduploadandattachdocumenttodefault-put", "parameters"=>[{"in"=>"body", "name"=>"documentDetails", "description"=>"Details of the file", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Uploads", "Attaches", "Document", "To", "Brand"]}}, "/api/branding/{id}/attachdocument"=>{"put"=>{"summary"=>"Attaches a document to a brand.", "description"=>"Attaches a document to a brand..", "operationId"=>"Branding_AttachDocumentByidBydocumentId", "x-api-path-slug"=>"apibrandingidattachdocument-put", "parameters"=>[{"in"=>"query", "name"=>"documentId", "description"=>"The documentId"}, {"in"=>"path", "name"=>"id", "description"=>"The BrandId"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attaches", "Document", "To", "Brand"]}}, "/api/branding/{id}/detachdocument"=>{"put"=>{"summary"=>"Detaches a document from a brand.", "description"=>"Detaches a document from a brand..", "operationId"=>"Branding_DetachDocumentByidBydocumentId", "x-api-path-slug"=>"apibrandingiddetachdocument-put", "parameters"=>[{"in"=>"query", "name"=>"documentId", "description"=>"The documentId"}, {"in"=>"path", "name"=>"id", "description"=>"The BrandId"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Detaches", "Document", "From", "Brand"]}}, "/api/branding/{id}/uploaddocumentcustomisation"=>{"put"=>{"summary"=>"Upload the data to customise a Brand Document.", "description"=>"Upload the data to customise a brand document..", "operationId"=>"Branding_UploadDocumentCustomisationByidBycustomisationSaveData", "x-api-path-slug"=>"apibrandingiduploaddocumentcustomisation-put", "parameters"=>[{"in"=>"body", "name"=>"customisationSaveData", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"BrandId"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Data", "To", "Customise", "Brand", "Document"]}}, "/api/branding/{id}/getcustomisationdata"=>{"get"=>{"summary"=>"", "description"=>".", "operationId"=>"Branding_GetCustomisationDataByidByroleIdBydocumentId", "x-api-path-slug"=>"apibrandingidgetcustomisationdata-get", "parameters"=>[{"in"=>"query", "name"=>"documentId"}, {"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"query", "name"=>"roleId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/api/branding/uploadsmstemplate"=>{"post"=>{"summary"=>"Upload the data to create a SMS Document Template for a Brand.", "description"=>"Upload the data to create a sms document template for a brand..", "operationId"=>"Branding_UploadSMSTemplateBybrandTemplateSaveDataContract", "x-api-path-slug"=>"apibrandinguploadsmstemplate-post", "parameters"=>[{"in"=>"body", "name"=>"brandTemplateSaveDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Data", "To", "Create", "SMS", "Document", "Templatea", "Brand"]}}, "/api/branding/uploademailtemplate"=>{"post"=>{"summary"=>"Upload the data to create a Email Document Template for a Brand.", "description"=>"Upload the data to create a email document template for a brand..", "operationId"=>"Branding_UploadEmailTemplateBybrandTemplateSaveDataContract", "x-api-path-slug"=>"apibrandinguploademailtemplate-post", "parameters"=>[{"in"=>"body", "name"=>"brandTemplateSaveDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Data", "To", "Create", "Email", "Document", "Templatea", "Brand"]}}, "/api/branding/websitesetup/{brandId}"=>{"get"=>{"summary"=>"Get files and details that can be used to customize a website", "description"=>"Get files and details that can be used to customize a website.", "operationId"=>"Branding_WebsiteSetupBybrandId", "x-api-path-slug"=>"apibrandingwebsitesetupbrandid-get", "parameters"=>[{"in"=>"path", "name"=>"brandId"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files", "Details", "That", "Can", "Be", "Used", "To", "Customize", "Website"]}}, "/api/branding/htmladvert/{brandId}"=>{"post"=>{"summary"=>"Upload the a html advert for a brand.", "description"=>"Upload the a html advert for a brand..", "operationId"=>"Branding_UpdateHtmlAdvertBybrandIdBybrandHtmlAdvertDataContract", "x-api-path-slug"=>"apibrandinghtmladvertbrandid-post", "parameters"=>[{"in"=>"body", "name"=>"brandHtmlAdvertDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"brandId"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Html", "Adverta", "Brand"]}}, "/api/branding/htmladverts/{brandId}"=>{"get"=>{"summary"=>"Upload the a html advert for a brand.", "description"=>"Upload the a html advert for a brand..", "operationId"=>"Branding_HtmlAdvertsBybrandId", "x-api-path-slug"=>"apibrandinghtmladvertsbrandid-get", "parameters"=>[{"in"=>"path", "name"=>"brandId"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Html", "Adverta", "Brand"]}}, "/api/Branding"=>{"get"=>{"summary"=>"Gets a sumary all of the brands for a agency", "description"=>"Gets a sumary all of the brands for a agency.", "operationId"=>"Branding_Get", "x-api-path-slug"=>"apibranding-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Sumary", "", "Of", "Brandsa", "Agency"]}}, "/api/admin/businessworkflow/start"=>{"post"=>{"summary"=>"Starts a workflow with the given parameters.", "description"=>"Starts a workflow with the given parameters..", "operationId"=>"BusinessWorkflow_StartWorkflowByinvokeCommand", "x-api-path-slug"=>"apiadminbusinessworkflowstart-post", "parameters"=>[{"in"=>"body", "name"=>"invokeCommand", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Starts", "Workflow", "Given", "Parameters"]}}, "/api/admin/businessworkflow/listWorkflows"=>{"get"=>{"summary"=>"Starts a workflow with the given parameters.", "description"=>"Starts a workflow with the given parameters..", "operationId"=>"BusinessWorkflow_ListWorkflowsByskipBytake", "x-api-path-slug"=>"apiadminbusinessworkflowlistworkflows-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"query", "name"=>"skip", "description"=>"Used for paging results"}, {"in"=>"query", "name"=>"take", "description"=>"Used for paging results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Starts", "Workflow", "Given", "Parameters"]}}, "/api/admin/businessworkflow/{workflowName}"=>{"get"=>{"summary"=>"Lists instances of a given workflow", "description"=>"Lists instances of a given workflow.", "operationId"=>"BusinessWorkflow_ListWorkflowInstancesByworkflowNameByskipBytake", "x-api-path-slug"=>"apiadminbusinessworkflowworkflowname-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"query", "name"=>"skip"}, {"in"=>"query", "name"=>"take"}, {"in"=>"path", "name"=>"workflowName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Instances", "Of", "Given", "Workflow"]}, "delete"=>{"summary"=>"Terminates a running workflow instance.", "description"=>"Terminates a running workflow instance..", "operationId"=>"BusinessWorkflow_TerminateWorkflowInstanceByworkflowNameByworkflowInstanceHandleByreason", "x-api-path-slug"=>"apiadminbusinessworkflowworkflowname-delete", "parameters"=>[{"in"=>"query", "name"=>"reason"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"query", "name"=>"workflowInstanceHandle"}, {"in"=>"path", "name"=>"workflowName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Terminates", "Running", "Workflow", "Instance"]}}, "/api/admin/businessworkflow/trigger"=>{"post"=>{"summary"=>"", "description"=>".", "operationId"=>"BusinessWorkflow_FireExternalTriggerByfireTriggerCommand", "x-api-path-slug"=>"apiadminbusinessworkflowtrigger-post", "parameters"=>[{"in"=>"body", "name"=>"fireTriggerCommand", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/api/cache/{itemKey}"=>{"get"=>{"summary"=>"Retrieves an object stored in the cache system by its {itemKey}", "description"=>"Retrieves an object stored in the cache system by its {itemkey}.", "operationId"=>"Cache_GetObjectByitemKey", "x-api-path-slug"=>"apicacheitemkey-get", "parameters"=>[{"in"=>"path", "name"=>"itemKey", "description"=>"The item key"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieves", "Object", "Stored", "In", "Cache", "System", "By", "Its", "ItemKey"]}, "put"=>{"summary"=>"Stores the {objectToPersist} in the cache subsystem.", "description"=>"Stores the {objecttopersist} in the cache subsystem..", "operationId"=>"Cache_SetObjectByobjectToPersistByitemKeyBytimeToLive", "x-api-path-slug"=>"apicacheitemkey-put", "parameters"=>[{"in"=>"path", "name"=>"itemKey", "description"=>"The item key"}, {"in"=>"body", "name"=>"objectToPersist", "description"=>"The object to persist", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"query", "name"=>"timeToLive", "description"=>"The time to live"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stores", "ObjectToPersist", "In", "Cache", "Subsystem"]}, "delete"=>{"summary"=>"Deletes the item stored at {itemKey}", "description"=>"Deletes the item stored at {itemkey}.", "operationId"=>"Cache_DeleteItemByitemKey", "x-api-path-slug"=>"apicacheitemkey-delete", "parameters"=>[{"in"=>"path", "name"=>"itemKey", "description"=>"The item key"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Item", "Stored", "At", "ItemKey"]}}, "/api/cache/List/{listKey}"=>{"get"=>{"summary"=>"Retrieves a list of objects stored in the cache system by its {listKey}", "description"=>"Retrieves a list of objects stored in the cache system by its {listkey}.", "operationId"=>"Cache_GetListBylistKey", "x-api-path-slug"=>"apicachelistlistkey-get", "parameters"=>[{"in"=>"path", "name"=>"listKey", "description"=>"The list key"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieves", "List", "Of", "Objects", "Stored", "In", "Cache", "System", "By", "Its", "ListKey"]}}, "/api/cache/List/{listKey}/Append"=>{"put"=>{"summary"=>"Adds {itemToAppend} to the tail of an existing list, or creates a new list with the object in it.", "description"=>"Adds {itemtoappend} to the tail of an existing list, or creates a new list with the object in it..", "operationId"=>"Cache_AppendToListByitemToAppendBylistKeyBytimeToLive", "x-api-path-slug"=>"apicachelistlistkeyappend-put", "parameters"=>[{"in"=>"body", "name"=>"itemToAppend", "description"=>"The item to append", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"listKey", "description"=>"The list key"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"query", "name"=>"timeToLive", "description"=>"The time to live"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "ItemToAppend", "To", "Tail", "Of", "Existing", "List", "", "Creates", "New", "List", "Object", "In", "It"]}}, "/api/cache/List/{listKey}/Prepend"=>{"put"=>{"summary"=>"Adds {itemToPrepend} to the head of an existing list, or creates a new list with the object in it.", "description"=>"Adds {itemtoprepend} to the head of an existing list, or creates a new list with the object in it..", "operationId"=>"Cache_PrependToListByitemToPrependBylistKeyBytimeToLive", "x-api-path-slug"=>"apicachelistlistkeyprepend-put", "parameters"=>[{"in"=>"body", "name"=>"itemToPrepend", "description"=>"The item to prepend", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"listKey", "description"=>"The list key"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"query", "name"=>"timeToLive", "description"=>"The time to live"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "ItemToPrepend", "To", "Head", "Of", "Existing", "List", "", "Creates", "New", "List", "Object", "In", "It"]}}, "/api/cache/List/{listKey}/Item"=>{"delete"=>{"summary"=>"Removes a given item from the list.", "description"=>"Removes a given item from the list..", "operationId"=>"Cache_RemoveItemFromListByitemToRemoveBylistKey", "x-api-path-slug"=>"apicachelistlistkeyitem-delete", "parameters"=>[{"in"=>"body", "name"=>"itemToRemove", "description"=>"The item to remove", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"listKey", "description"=>"The list key"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Removes", "Given", "Item", "From", "List"]}}, "/api/cache/List/{listKey}/Pop"=>{"get"=>{"summary"=>"Pops an items from the list head.", "description"=>"Pops an items from the list head..", "operationId"=>"Cache_PopFromListHeadBylistKey", "x-api-path-slug"=>"apicachelistlistkeypop-get", "parameters"=>[{"in"=>"path", "name"=>"listKey", "description"=>"The list key"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pops", "Items", "From", "List", "Head"]}}, "/api/cache/Key"=>{"get"=>{"summary"=>"Generate a guid for use as a key", "description"=>"Generate a guid for use as a key.", "operationId"=>"Cache_GenerateKey", "x-api-path-slug"=>"apicachekey-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generate", "Guiduse", "As", "Key"]}}, "/api/chargesdescription/Save"=>{"post"=>{"summary"=>"", "description"=>".", "operationId"=>"ChargesDescription_SaveBychargesDescriptionDataContract", "x-api-path-slug"=>"apichargesdescriptionsave-post", "parameters"=>[{"in"=>"body", "name"=>"chargesDescriptionDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/api/chargesdescription/Delete"=>{"delete"=>{"summary"=>"", "description"=>".", "operationId"=>"ChargesDescription_DeleteDescriptionByid", "x-api-path-slug"=>"apichargesdescriptiondelete-delete", "parameters"=>[{"in"=>"query", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/api/ChargesDescription/{id}"=>{"get"=>{"summary"=>"", "description"=>".", "operationId"=>"ChargesDescription_GetByid", "x-api-path-slug"=>"apichargesdescriptionid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/api/chat/unreadsummary"=>{"get"=>{"summary"=>"Get a count of unread chat messages for the negotiator plus a list of corresponding message id's which are unread.", "description"=>"Get a count of unread chat messages for the negotiator plus a list of corresponding message id's which are unread..", "operationId"=>"Chat_UnreadSummary", "x-api-path-slug"=>"apichatunreadsummary-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Count", "Of", "Unread", "Chat", "Messagesthe", "Negotiator", "Plus", "List", "Of", "Corresponding", "Message", "Ids", "Which", "Are", "Unread"]}}, "/api/chat/savemessage"=>{"post"=>{"summary"=>"Save a new chat message.", "description"=>"Save a new chat message..", "operationId"=>"Chat_SaveMessageBychatMessageSave", "x-api-path-slug"=>"apichatsavemessage-post", "parameters"=>[{"in"=>"body", "name"=>"chatMessageSave", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Save", "New", "Chat", "Message"]}}, "/api/chat/message/markasread/{messageId}"=>{"put"=>{"summary"=>"This will update the cache with a new timestamp for when this chat message was last read.", "description"=>"This will update the cache with a new timestamp for when this chat message was last read..", "operationId"=>"Chat_MarkMessageAsReadBymessageId", "x-api-path-slug"=>"apichatmessagemarkasreadmessageid-put", "parameters"=>[{"in"=>"path", "name"=>"messageId"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Will", "Update", "Cache", "New", "Timestampwhen", "This", "Chat", "Message", "Was", "Last", "Read"]}}, "/api/Chat"=>{"get"=>{"summary"=>"Get a previous chat message to append to.", "description"=>"Get a previous chat message to append to..", "operationId"=>"Chat_GetBymessageId", "x-api-path-slug"=>"apichat-get", "parameters"=>[{"in"=>"query", "name"=>"messageId"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Previous", "Chat", "Message", "To", "Append", "To"]}, "put"=>{"summary"=>"Put - to update a chat message.", "description"=>"Put - to update a chat message..", "operationId"=>"Chat_PutBychatMessageSave", "x-api-path-slug"=>"apichat-put", "parameters"=>[{"in"=>"body", "name"=>"chatMessageSave", "description"=>"The Appointment JSON object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["-", "To", "Update", "Chat", "Message"]}}, "/api/coreplatformstate/reportMigration"=>{"post"=>{"summary"=>"Reports that a data migration has been shedueled.", "description"=>"Reports that a data migration has been shedueled..", "operationId"=>"CorePlatformState_ReportMigrationStateBymigrationState", "x-api-path-slug"=>"apicoreplatformstatereportmigration-post", "parameters"=>[{"in"=>"body", "name"=>"migrationState", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "That", "Data", "Migration", "Has", "Been", "Shedueled"]}}, "/api/coreplatformstate/reportMigration/{migrationId}"=>{"post"=>{"summary"=>"Reports that a data migration has been shedueled - used by workflow", "description"=>"Reports that a data migration has been shedueled - used by workflow.", "operationId"=>"CorePlatformState_ReportMigrationStateBymigrationId", "x-api-path-slug"=>"apicoreplatformstatereportmigrationmigrationid-post", "parameters"=>[{"in"=>"path", "name"=>"migrationId"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "That", "Data", "Migration", "Has", "Been", "Shedueled", "-", "Used", "By", "Workflow"]}}, "/api/coreplatformstate/{stateItemReference}"=>{"delete"=>{"summary"=>"Clears a state item.", "description"=>"Clears a state item..", "operationId"=>"CorePlatformState_ClearStateItemBystateItemReference", "x-api-path-slug"=>"apicoreplatformstatestateitemreference-delete", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"path", "name"=>"stateItemReference", "description"=>"The state item reference"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clears", "State", "Item"]}}, "/api/coreplatformstate/platformissue"=>{"post"=>{"summary"=>"Allows business workflows to post system issues to the platform state service.", "description"=>"Allows business workflows to post system issues to the platform state service..", "operationId"=>"CorePlatformState_PostPlatformIssueByalertDataContract", "x-api-path-slug"=>"apicoreplatformstateplatformissue-post", "parameters"=>[{"in"=>"body", "name"=>"alertDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Allows", "Business", "Workflows", "To", "Post", "System", "Issues", "To", "Platform", "State", "Service"]}}, "/api/coreplatformstate/health"=>{"get"=>{"summary"=>"Gets core platform master health status", "description"=>"Gets core platform master health status.", "operationId"=>"CorePlatformState_GetPlatformHealth", "x-api-path-slug"=>"apicoreplatformstatehealth-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Core", "Platform", "Master", "Health", "Status"]}}, "/api/coreplatformstate/sendpendingalerts"=>{"post"=>{"summary"=>"Sends alerts for all current platform issues.", "description"=>"Sends alerts for all current platform issues..", "operationId"=>"CorePlatformState_SendPendingAlerts", "x-api-path-slug"=>"apicoreplatformstatesendpendingalerts-post", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sends", "Alerts", "Current", "Platform", "Issues"]}}, "/api/costdescription/Save"=>{"post"=>{"summary"=>"", "description"=>".", "operationId"=>"CostDescription_SaveBycostDescriptionDataContract", "x-api-path-slug"=>"apicostdescriptionsave-post", "parameters"=>[{"in"=>"body", "name"=>"costDescriptionDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/api/costdescription/Delete"=>{"delete"=>{"summary"=>"", "description"=>".", "operationId"=>"CostDescription_DeleteDescriptionByid", "x-api-path-slug"=>"apicostdescriptiondelete-delete", "parameters"=>[{"in"=>"query", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/api/CostDescription/{id}"=>{"get"=>{"summary"=>"", "description"=>".", "operationId"=>"CostDescription_GetByid", "x-api-path-slug"=>"apicostdescriptionid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/api/credentials/upsertusernamepassword"=>{"post"=>{"summary"=>"Creates or Updates Security Credentials", "description"=>"Creates or updates security credentials.", "operationId"=>"Credentials_UpsertUsernamePasswordBycredentialDataContract", "x-api-path-slug"=>"apicredentialsupsertusernamepassword-post", "parameters"=>[{"in"=>"body", "name"=>"credentialDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "S", "Security", "Credentials"]}}, "/api/credentials/emailsync/usernamepassword"=>{"get"=>{"summary"=>"Gets Email Sync Security Credentials", "description"=>"Gets email sync security credentials.", "operationId"=>"Credentials_EmailSyncUsernamePasswordBycredentialDataContract.usernameBycredentialDataContract.passw", "x-api-path-slug"=>"apicredentialsemailsyncusernamepassword-get", "parameters"=>[{"in"=>"query", "name"=>"credentialDataContract.password"}, {"in"=>"query", "name"=>"credentialDataContract.username"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Email", "Sync", "Security", "Credentials"]}, "post"=>{"summary"=>"Creates or Updates Email Sync Security Credentials\r\nThis also uses the credentials to do a quick check and see if they are working\r\nit will throw an internal server error if there is an issue with the connection\r\nbut this may be the server address (s", "description"=>"Creates or updates email sync security credentials\r\nthis also uses the credentials to do a quick check and see if they are working\r\nit will throw an internal server error if there is an issue with the connection\r\nbut this may be the server address (s.", "operationId"=>"Credentials_UpsertEmailSyncUsernamePasswordBycredentialDataContract", "x-api-path-slug"=>"apicredentialsemailsyncusernamepassword-post", "parameters"=>[{"in"=>"body", "name"=>"credentialDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "S", "Email", "Sync", "Security", "Credentials\r\nThis", "Also", "Uses", "Credentials", "To", "Do", "Quick", "Check", "See", "If", "They", "Are", "Working\r\nIt", "Will", "Throw", "Internal", "Server", "Error", "If", "There", "Is", "Issue", "Connection\r\nBut", "This", "May", "Be", "Server", "Address", "(s"]}, "delete"=>{"summary"=>"Delete Email Sync For a User", "description"=>"Delete email sync for a user.", "operationId"=>"Credentials_DeleteEmailSyncUsernamePassword", "x-api-path-slug"=>"apicredentialsemailsyncusernamepassword-delete", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Sync", "User"]}}, "/api/credentials/deleteusernamepassword/{name}"=>{"delete"=>{"summary"=>"Delete Security Credentials", "description"=>"Delete security credentials.", "operationId"=>"Credentials_DeleteUsernamePasswordByname", "x-api-path-slug"=>"apicredentialsdeleteusernamepasswordname-delete", "parameters"=>[{"in"=>"path", "name"=>"name"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Credentials"]}}, "/api/CustomField"=>{"put"=>{"summary"=>"", "description"=>".", "operationId"=>"CustomField_SaveCustomFieldValueBysaveCustomFieldValueCommandSaveDataContract", "x-api-path-slug"=>"apicustomfield-put", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"body", "name"=>"saveCustomFieldValueCommandSaveDataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/api/customfieldgroup/{typeName}"=>{"get"=>{"summary"=>"Get a list of custom field groups for a type and optional group name specified.", "description"=>"Get a list of custom field groups for a type and optional group name specified..", "operationId"=>"CustomFieldGroup_GetBytypeNameBygroupName", "x-api-path-slug"=>"apicustomfieldgrouptypename-get", "parameters"=>[{"in"=>"query", "name"=>"groupName", "description"=>"An optional parameter to filter by group name"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"path", "name"=>"typeName", "description"=>"The name of the type to get the custom field groups for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Custom", "Field", "Groupsa", "Type", "Optional", "Group", "Name", "Specified"]}}, "/api/customtextdescription/distinctcustompropertydescriptions"=>{"get"=>{"summary"=>"Returns a list of the distinct defined custom descriptions for a property", "description"=>"Returns a list of the distinct defined custom descriptions for a property.", "operationId"=>"CustomTextDescription_DistinctCustomPropertyDescriptions", "x-api-path-slug"=>"apicustomtextdescriptiondistinctcustompropertydescriptions-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "List", "Of", "Distinct", "Defined", "Custom", "Descriptionsa", "Property"]}}, "/api/dashboard/create"=>{"post"=>{"summary"=>"Create/Update dashboard", "description"=>"Create/update dashboard.", "operationId"=>"Dashboard_SetDashboardBydataContract", "x-api-path-slug"=>"apidashboardcreate-post", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dashboard"]}}, "/api/dashboard/{id}/delete"=>{"delete"=>{"summary"=>"Delete dashboard", "description"=>"Delete dashboard.", "operationId"=>"Dashboard_DeleteDashboardByid", "x-api-path-slug"=>"apidashboardiddelete-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Dashboard Id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dashboard"]}}, "/api/dashboard/{id}/removewidgets"=>{"put"=>{"summary"=>"Remove widgets from a dashboard", "description"=>"Remove widgets from a dashboard.", "operationId"=>"Dashboard_RemoveWidgetsFromDashboardByid", "x-api-path-slug"=>"apidashboardidremovewidgets-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Dashboard Id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Widgets", "From", "Dashboard"]}}, "/api/dashboard/{id}/share"=>{"put"=>{"summary"=>"Share dashboard", "description"=>"Share dashboard.", "operationId"=>"Dashboard_ShareDashboardByidBydataContract", "x-api-path-slug"=>"apidashboardidshare-put", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Dashboard Id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Share", "Dashboard"]}}, "/api/dashboard/{id}/setwidget"=>{"put"=>{"summary"=>"Add widget to dashboard", "description"=>"Add widget to dashboard.", "operationId"=>"Dashboard_SetWidgetByidBydataContract", "x-api-path-slug"=>"apidashboardidsetwidget-put", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "description"=>"Widget to be added to dashboard", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Dashboard Id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Widget", "To", "Dashboard"]}}, "/api/dashboard/{id}/deletewidget/{widgetId}"=>{"delete"=>{"summary"=>"Delete widget on dashboard", "description"=>"Delete widget on dashboard.", "operationId"=>"Dashboard_DeleteWidgetByidBywidgetId", "x-api-path-slug"=>"apidashboardiddeletewidgetwidgetid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Dashboard Id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}, {"in"=>"path", "name"=>"widgetId", "description"=>"Widget Id to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Widget", "On", "Dashboard"]}}, "/api/dashboard/movewidget"=>{"put"=>{"summary"=>"Move widget onto another dashboard", "description"=>"Move widget onto another dashboard.", "operationId"=>"Dashboard_MoveWidgetBydataContract", "x-api-path-slug"=>"apidashboardmovewidget-put", "parameters"=>[{"in"=>"body", "name"=>"dataContract", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Move", "Widget", "Onto", "Another", "Dashboard"]}}, "/api/dashboard/{id}/addnegotiator"=>{"put"=>{"summary"=>"Add negotiator to dashboard id", "description"=>"Add negotiator to dashboard id.", "operationId"=>"Dashboard_AddNegotiatorToDashboardByid", "x-api-path-slug"=>"apidashboardidaddnegotiator-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Dashboard Id"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Negotiator", "To", "Dashboard", "Id"]}}, "/api/dashboard/{id}/setlayout"=>{"put"=>{"summary"=>"Set widget layout on dashboards", "description"=>"Set widget layout on dashboards.", "operationId"=>"Dashboard_SetWidgetLayoutByidBylayouts", "x-api-path-slug"=>"apidashboardidsetlayout-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Dashboard Id"}, {"in"=>"body", "name"=>"layouts", "description"=>"Array of layout objects", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Widget", "Layout", "On", "Dashboards"]}}, "/api/dashboard/getshared"=>{"get"=>{"summary"=>"Get all shared dashboards", "description"=>"Get all shared dashboards.", "operationId"=>"Dashboard_AllDashboards", "x-api-path-slug"=>"apidashboardgetshared-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shared", "Dashboards"]}}, "/api/dashboard/my"=>{"get"=>{"summary"=>"Get all shared dashboards", "description"=>"Get all shared dashboards.", "operationId"=>"Dashboard_MyDashboards", "x-api-path-slug"=>"apidashboardmy-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shared", "Dashboards"]}}, "/api/dashboard/available"=>{"get"=>{"summary"=>"Get all available dashboards", "description"=>"Get all available dashboards.", "operationId"=>"Dashboard_AvailableDashboards", "x-api-path-slug"=>"apidashboardavailable-get", "parameters"=>[{"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Available", "Dashboards"]}}, "/api/admin/database/setperformancelevel"=>{"post"=>{"summary"=>"Set the performance level of a database node", "description"=>"Set the performance level of a database node.", "operationId"=>"Database_SetNodeDatabasePerformanceLevelBynodeIdBylevel", "x-api-path-slug"=>"apiadmindatabasesetperformancelevel-post", "parameters"=>[{"in"=>"query", "name"=>"level", "description"=>"The level to scale to"}, {"in"=>"query", "name"=>"nodeId", "description"=>"The id of the database node to scale"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Performance", "Level", "Of", "Database", "Node"]}}, "/api/todo/getall"=>{"get"=>{"summary"=>"Get the list of all ToDo's if no parameter is sent;\r\nif provided will filter by ToDo type", "description"=>"Get the list of all todo's if no parameter is sent;\r\nif provided will filter by todo type.", "operationId"=>"DefaultToDo_GetAllBypageSizeBypageNumberByfilterToDo.filterCategoryByfilterToDo.toDoTypeByfilterToDo", "x-api-path-slug"=>"apitodogetall-get", "parameters"=>[{"in"=>"query", "name"=>"filterToDo.branchId"}, {"in"=>"query", "name"=>"filterToDo.filterCategory"}, {"in"=>"query", "name"=>"filterToDo.negotiatorIds"}, {"in"=>"query", "name"=>"filterToDo.toDoType"}, {"in"=>"query", "name"=>"pageNumber"}, {"in"=>"query", "name"=>"pageSize"}, {"in"=>"header", "name"=>"Rezi-Api-Version", "description"=>"Specifies which version of the API to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "", "ToDos", "If", "No", "Parameter", "Is", "Sent;\r\n |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
storecove{"storecove-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Storecove", "x-complete"=>1, "info"=>{"title"=>"Storecove", "description"=>"storecove-api", "version"=>"2.0.1"}, "host"=>"api.storecove.com", "basePath"=>"/api/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/invoice_submissions"=>{"post"=>{"summary"=>"Submit a new invoice", "description"=>"Submit an invoice for delivery.\ninclude::examples/invoice_submissions/create_invoice_submission/tabs.adoc[]", "operationId"=>"create_invoice_submission", "x-api-path-slug"=>"invoice-submissions-post", "parameters"=>[{"in"=>"body", "name"=>"invoice_submission", "description"=>"Invoice to submit", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice", "Submissions"]}}, "/invoice_submissions/preflight"=>{"post"=>{"summary"=>"Preflight an invoice recipient", "description"=>"Check whether Storecove can deliver an invoice for a list of ids.\ninclude::examples/invoice_submissions/preflight_invoice_recipient/tabs.adoc[]", "operationId"=>"preflight_invoice_recipient", "x-api-path-slug"=>"invoice-submissionspreflight-post", "parameters"=>[{"in"=>"body", "name"=>"invoice_recipient_preflight", "description"=>"The invoice recipient to preflight", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice", "Submissions", "Preflight"]}}, "/legal_entities"=>{"post"=>{"summary"=>"Create a new LegalEntity", "description"=>"Create a new LegalEntity.", "operationId"=>"create_legal_entity", "x-api-path-slug"=>"legal-entities-post", "parameters"=>[{"in"=>"body", "name"=>"legal_entity", "description"=>"LegalEntity to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Legal", "Entities"]}}, "/legal_entities/{id}"=>{"delete"=>{"summary"=>"Delete LegalEntity", "description"=>"Delete a specific LegalEntity.", "operationId"=>"delete_legal_entity", "x-api-path-slug"=>"legal-entitiesid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"legal_entity id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Legal", "Entities"]}, "get"=>{"summary"=>"Get LegalEntity", "description"=>"Get a specific LegalEntity.", "operationId"=>"get_legal_entity", "x-api-path-slug"=>"legal-entitiesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"legal_entity id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Legal", "Entities"]}, "patch"=>{"summary"=>"Update LegalEntity", "description"=>"Update a specific LegalEntity.", "operationId"=>"update_legal_entity", "x-api-path-slug"=>"legal-entitiesid-patch", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"legal_entity id"}, {"in"=>"body", "name"=>"legal_entity", "description"=>"LegalEntity updates", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Legal", "Entities"]}}, "/legal_entities/{legal_entity_id}/peppol_identifiers"=>{"post"=>{"summary"=>"Create a new PeppolIdentifier", "description"=>"Create a new PeppolIdentifier.", "operationId"=>"create_peppol_identifier", "x-api-path-slug"=>"legal-entitieslegal-entity-idpeppol-identifiers-post", "parameters"=>[{"in"=>"path", "name"=>"legal_entity_id"}, {"in"=>"body", "name"=>"peppol_identifier", "description"=>"PeppolIdentifier to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Legal", "Entities", "Legal", "Entity", "Peppolentifiers"]}}, "/legal_entities/{legal_entity_id}/peppol_identifiers/iso6523-actorid-upis/{scheme}/{identifier}"=>{"delete"=>{"summary"=>"Delete PeppolIdentifier", "description"=>"Delete a specific PeppolIdentifier.", "operationId"=>"delete_peppol_identifier", "x-api-path-slug"=>"legal-entitieslegal-entity-idpeppol-identifiersiso6523actoridupisschemeidentifier-delete", "parameters"=>[{"in"=>"path", "name"=>"identifier", "description"=>"PEPPOL identifier"}, {"in"=>"path", "name"=>"legal_entity_id", "description"=>"The id of the LegalEntity this PeppolIdentifier belongs to"}, {"in"=>"path", "name"=>"scheme", "description"=>"PEPPOL identifier scheme id, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Legal", "Entities", "Legal", "Entity", "Peppolentifiers", "Iso6523", "Actorid", "Upis", "Schemeentifier"]}, "patch"=>{"summary"=>"Update PeppolIdentifier", "description"=>"Update a specific PeppolIdentifier.", "operationId"=>"update_peppol_identifier", "x-api-path-slug"=>"legal-entitieslegal-entity-idpeppol-identifiersiso6523actoridupisschemeidentifier-patch", "parameters"=>[{"in"=>"path", "name"=>"identifier", "description"=>"PEPPOL identifier"}, {"in"=>"path", "name"=>"legal_entity_id", "description"=>"The id of the LegalEntity this PeppolIdentifier belongs to"}, {"in"=>"body", "name"=>"peppol_identifier", "description"=>"PeppolIdentifier updates", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"scheme", "description"=>"PEPPOL identifier scheme id, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Legal", "Entities", "Legal", "Entity", "Peppolentifiers", "Iso6523", "Actorid", "Upis", "Schemeentifier"]}}, "/shop_account_requests"=>{"get"=>{"summary"=>"Get ShopAccountRequests", "description"=>"Retrieve all active ShopAccountRequests for one of your entities.\ninclude::examples/shop_account_requests/shop_account_requests_index/tabs.adoc[]", "operationId"=>"shop_account_requests_index", "x-api-path-slug"=>"shop-account-requests-get", "parameters"=>[{"in"=>"query", "name"=>"external_user_id", "description"=>"Filter by the external_user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Account", "Requests"]}, "post"=>{"summary"=>"Create ShopAccountRequest", "description"=>"Create a new ShopAccountRequest\ninclude::examples/shop_account_requests/create_shop_account_request/tabs.adoc[]", "operationId"=>"create_shop_account_request", "x-api-path-slug"=>"shop-account-requests-post", "parameters"=>[{"in"=>"body", "name"=>"shop_account_request", "description"=>"ShopAccountRequest to add", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Account", "Requests"]}}, "/shop_account_requests/{id}"=>{"delete"=>{"summary"=>"Delete ShopAccountRequest", "description"=>"Delete a specific ShopAccountRequest\ninclude::examples/shop_account_requests/delete_shop_account_request/tabs.adoc[]", "operationId"=>"delete_shop_account_request", "x-api-path-slug"=>"shop-account-requestsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"shop_account_request id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Account", "Requests"]}, "get"=>{"summary"=>"Get ShopAccountRequest", "description"=>"Show a specific ShopAccountRequest\ninclude::examples/shop_account_requests/get_shop_account_request/tabs.adoc[]", "operationId"=>"get_shop_account_request", "x-api-path-slug"=>"shop-account-requestsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"shop_account_request id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Account", "Requests"]}, "patch"=>{"summary"=>"Update ShopAccountRequest", "description"=>"Update a specific ShopAccountRequest\ninclude::examples/shop_account_requests/update_shop_account_request/tabs.adoc[]", "operationId"=>"update_shop_account_request", "x-api-path-slug"=>"shop-account-requestsid-patch", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"shop_account_request id"}, {"in"=>"body", "name"=>"shop_account_request", "description"=>"ShopAccountRequest updates", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Account", "Requests"]}}, "/shop_accounts"=>{"get"=>{"summary"=>"Get ShopAccounts for an entity", "description"=>"Retrieve all active ShopAccounts for one of your entities.\ninclude::examples/shop_accounts/shop_accounts_index/tabs.adoc[]", "operationId"=>"shop_accounts_index", "x-api-path-slug"=>"shop-accounts-get", "parameters"=>[{"in"=>"query", "name"=>"external_user_id", "description"=>"Filter by the external_user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Accounts"]}, "post"=>{"summary"=>"Create ShopAccount", "description"=>"Create a new ShopAccount.\ninclude::examples/shop_accounts/create_shop_account/tabs.adoc[]", "operationId"=>"create_shop_account", "x-api-path-slug"=>"shop-accounts-post", "parameters"=>[{"in"=>"body", "name"=>"shop_account", "description"=>"ShopAccount to add", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Accounts"]}}, "/shop_accounts/auth_failures"=>{"get"=>{"summary"=>"Get ShopAccounts with authorization failures", "description"=>"Get ShopAccounts with authorization failures.\ninclude::examples/shop_accounts/shop_accounts_auth_failures/tabs.adoc[]", "operationId"=>"shop_accounts_auth_failures", "x-api-path-slug"=>"shop-accountsauth-failures-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Accounts", "Auth", "Failures"]}}, "/shop_accounts/{id}"=>{"delete"=>{"summary"=>"Delete ShopAccount", "description"=>"Delete a specific ShopAccount.\ninclude::examples/shop_accounts/delete_shop_account/tabs.adoc[]", "operationId"=>"delete_shop_account", "x-api-path-slug"=>"shop-accountsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"shop_account id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Accounts"]}, "get"=>{"summary"=>"Get ShopAccount", "description"=>"Get a specific ShopAccount.\ninclude::examples/shop_accounts/get_shop_account/tabs.adoc[]", "operationId"=>"get_shop_account", "x-api-path-slug"=>"shop-accountsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"shop_account id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Accounts"]}, "patch"=>{"summary"=>"Update ShopAccount", "description"=>"Update a specific ShopAccount.\ninclude::examples/shop_accounts/update_shop_account/tabs.adoc[]", "operationId"=>"update_shop_account", "x-api-path-slug"=>"shop-accountsid-patch", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"shop_account id"}, {"in"=>"body", "name"=>"shop_account", "description"=>"ShopAccount updates", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Accounts"]}}, "/shops"=>{"get"=>{"summary"=>"Get Shops", "description"=>"Get all available shops.\ninclude::examples/shops/shops_index/tabs.adoc[]", "operationId"=>"shops_index", "x-api-path-slug"=>"shops-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops"]}}}}, "apis"=>{"name"=>"Storecove", "x-slug"=>"storecove", "description"=>"Storecove is Netherlands’ first online platform that provides people and companies with a way to view all their invoices in one online overview. Dolf Kars, founder and former owner of Videostrip (acquired by RTL Nederland), established Storecove in 2014 with cofounder Michael Riviera and Willem Stemfoort. Storecove mainly focuses on automatically collecting invoices, which saves time and money.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/storecove-logo.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Invoices,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"storecove/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Storecove", "x-api-slug"=>"storecove", "description"=>"Storecove is Netherlands’ first online platform that provides people and companies with a way to view all their invoices in one online overview. Dolf Kars, founder and former owner of Videostrip (acquired by RTL Nederland), established Storecove in 2014 with cofounder Michael Riviera and Willem Stemfoort. Storecove mainly focuses on automatically collecting invoices, which saves time and money.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/storecove-logo.jpg", "humanURL"=>"http://www.storecove.com", "baseURL"=>"https://api.storecove.com//api/v2", "tags"=>"Invoices,Relative Data,Service API", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/storecove/storecove-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://www.storecove.com"}, {"type"=>"x-blog", "url"=>"https://www.storecove.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"https://www.storecove.com/blog/rss/"}, {"type"=>"x-documentation", "url"=>"https://www.storecove.com/en/docs"}, {"type"=>"x-github", "url"=>"https://github.com/storecove"}, {"type"=>"x-openapi", "url"=>"https://www.storecove.com/api/v2/openapi.json"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/storecove"}, {"type"=>"x-website", "url"=>"http://storecove.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
transitfeeds{"transitfeeds-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"TransitFeeds", "x-complete"=>1, "info"=>{"title"=>"TransitFeeds API", "description"=>"api-to-view-feed-information-and-download-feeds-from-transitfeeds-com", "contact"=>{"name"=>"TransitFeeds.com", "url"=>"https://transitfeeds.com/issues", "email"=>"support@transitfeeds.com"}, "version"=>"1.0.0"}, "host"=>"api.transitfeeds.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/getLocations"=>{"get"=>{"summary"=>"Retrieve a list of locations.", "description"=>"Retrieve a list of locations. Each location (except for the root) has a parent location, and each\nlocation has zero or more child locations. This hierarchy is generally structured so countries contain\nstates, states contain cities (although this typically depends on the country).", "operationId"=>"getLocations", "x-api-path-slug"=>"getlocations-get", "parameters"=>[{"in"=>"query", "name"=>"key", "description"=>"Your personal API key, used for authentication"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Locations"]}}, "/getFeeds"=>{"get"=>{"summary"=>"Retrieve a list of feeds.", "description"=>"Used this API to retrieve a list of feeds in the system. Doing so can be usedful to discover feed IDs that\ncan be used in other API calls.", "operationId"=>"getFeeds", "x-api-path-slug"=>"getfeeds-get", "parameters"=>[{"in"=>"query", "name"=>"descendants", "description"=>"If a location is specified in `location`, this flag can be used to control if returned feeds must be assigned directly to the location, or if feeds belonging to sub-locations can also be returned"}, {"in"=>"query", "name"=>"key", "description"=>"Your personal API key, used for authentication"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of results to return"}, {"in"=>"query", "name"=>"location", "description"=>"This is the unique ID of a location"}, {"in"=>"query", "name"=>"page", "description"=>"The page number of results to return"}, {"in"=>"query", "name"=>"type", "description"=>"The type of feeds to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Feeds"]}}, "/getLatestFeedVersion"=>{"get"=>{"summary"=>"Retrieve the download URL for the latest version of a feed.", "description"=>"Once you have used `/getFeeds` to discover a feed's URL, you can use this endpoint to download its latest version from TranstiFeeds.\nIt will be unmodified in the original format from the provider.", "operationId"=>"getLatestFeedVersion", "x-api-path-slug"=>"getlatestfeedversion-get", "parameters"=>[{"in"=>"query", "name"=>"feed", "description"=>"The ID of the feed to retrieve the latest feed version for"}, {"in"=>"query", "name"=>"key", "description"=>"Your personal API key, used for authentication"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Download", "URLthe", "Latest", "Version", "Of", "Feed"]}}, "/getFeedVersions"=>{"get"=>{"summary"=>"Retrieve a list of versions of specified (or all) feeds.", "description"=>"This API call allows you to easily see every single feed update in the TranstiFeeds.com system. Since this can be quite\nlong, it's also possible to filter this list by a single feed ID.", "operationId"=>"getFeedVersions", "x-api-path-slug"=>"getfeedversions-get", "parameters"=>[{"in"=>"query", "name"=>"err", "description"=>"To include any errors detected when importing this feed in the response, specify a valud of `1`"}, {"in"=>"query", "name"=>"feed", "description"=>"If you only want to retrieve feed versions for a particular feed, include its ID here"}, {"in"=>"query", "name"=>"key", "description"=>"Your personal API key, used for authentication"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of results to return"}, {"in"=>"query", "name"=>"page", "description"=>"The page number of results to return"}, {"in"=>"query", "name"=>"warn", "description"=>"To include any warnings detected when importing this feed in the response, specify a valud of `1`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Versions", "Of", "Specified", "(or", ")", "Feeds"]}}}}, "apis"=>{"name"=>"TransitFeeds", "x-slug"=>"transitfeeds", "description"=>"The best source of open official public transit data. Maintained by @qzervaas + others", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/26209-rta-service-alerts.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"558301", "tags"=>"General Data,Service API,Transit", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"transitfeeds/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"TransitFeeds", "x-api-slug"=>"transitfeeds", "description"=>"The best source of open official public transit data. Maintained by @qzervaas + others", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/26209-rta-service-alerts.jpg", "humanURL"=>"https://transitfeeds.com", "baseURL"=>"https://api.transitfeeds.com//v1", "tags"=>"General Data,Service API,Transit", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/transitfeeds/getfeedversions-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/transitfeeds/transitfeeds-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-twitter", "url"=>"https://twitter.com/TransitFeeds"}, {"type"=>"x-website", "url"=>"https://transitfeeds.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fraudlabs-pro{"fraudlabs-pro-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"FraudLabs Pro", "x-complete"=>1, "info"=>{"title"=>"FraudLabs Pro", "description"=>"online-payment-fraud-detection-service--it-helps-merchants-to-minimize-chargebacks-and-therefore-maximize-the-revenue--it-can-be-used-to-detect-fraud-for-various-kinds-of-payment-method-such-as-credit-card-paypal-cod-and-so-on--please-visit-httpswww-fraudlabspro-com-to-learn-more-", "version"=>"1.0.0"}, "host"=>"virtserver.swaggerhub.com", "basePath"=>"/fraudlabspro/fraudlabspro/1.0", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/order/screen"=>{"post"=>{"summary"=>"V1OrderScreen_POST", "description"=>"Screen order for payment fraud.", "operationId"=>"V1OrderScreenPost", "x-api-path-slug"=>"v1orderscreen-post", "parameters"=>[{"in"=>"query", "name"=>"amount"}, {"in"=>"query", "name"=>"avs_result"}, {"in"=>"query", "name"=>"bill_addr"}, {"in"=>"query", "name"=>"bill_city"}, {"in"=>"query", "name"=>"bill_country"}, {"in"=>"query", "name"=>"bill_state"}, {"in"=>"query", "name"=>"bill_zip_code"}, {"in"=>"query", "name"=>"bin_no"}, {"in"=>"query", "name"=>"card_hash"}, {"in"=>"query", "name"=>"currency"}, {"in"=>"query", "name"=>"cvv_result"}, {"in"=>"query", "name"=>"department"}, {"in"=>"query", "name"=>"email"}, {"in"=>"query", "name"=>"email_domain"}, {"in"=>"query", "name"=>"email_hash"}, {"in"=>"query", "name"=>"first_name"}, {"in"=>"query", "name"=>"flp_checksum"}, {"in"=>"query", "name"=>"format"}, {"in"=>"query", "name"=>"ip"}, {"in"=>"query", "name"=>"key"}, {"in"=>"query", "name"=>"last_name"}, {"in"=>"query", "name"=>"password_hash"}, {"in"=>"query", "name"=>"payment_mode"}, {"in"=>"query", "name"=>"quantity"}, {"in"=>"query", "name"=>"ship_addr"}, {"in"=>"query", "name"=>"ship_city"}, {"in"=>"query", "name"=>"ship_country"}, {"in"=>"query", "name"=>"ship_state"}, {"in"=>"query", "name"=>"ship_zip_code"}, {"in"=>"query", "name"=>"username_hash"}, {"in"=>"query", "name"=>"user_order_id"}, {"in"=>"query", "name"=>"user_order_memo"}, {"in"=>"query", "name"=>"user_phone"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Fraud"]}}, "/v1/order/feedback"=>{"post"=>{"summary"=>"V1OrderFeedback_POST", "description"=>"Feedback the status of an order transaction.", "operationId"=>"V1OrderFeedbackPost", "x-api-path-slug"=>"v1orderfeedback-post", "parameters"=>[{"in"=>"query", "name"=>"action"}, {"in"=>"query", "name"=>"format"}, {"in"=>"query", "name"=>"id"}, {"in"=>"query", "name"=>"key"}, {"in"=>"query", "name"=>"notes"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Fraud", "Feedback"]}}}}, "apis"=>{"name"=>"FraudLabs Pro", "x-slug"=>"fraudlabs-pro", "description"=>"FraudLabs Pro provides sophisticated fraud detection solution helping merchants to prevent payment fraud and minimize chargeback & losses.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28712-www-fraudlabspro-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"555056", "tags"=>"Fake,Fraud,Relative Data,SaaS,Service API,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"fraudlabs-pro/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"FraudLabs Pro", "x-api-slug"=>"fraudlabs-pro", "description"=>"FraudLabs Pro provides sophisticated fraud detection solution helping merchants to prevent payment fraud and minimize chargeback & losses.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28712-www-fraudlabspro-com.jpg", "humanURL"=>"https://www.fraudlabspro.com", "baseURL"=>"https://virtserver.swaggerhub.com//fraudlabspro/fraudlabspro/1.0", "tags"=>"Fake,Fraud,Relative Data,SaaS,Service API,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/fraudlabs-pro/v1orderfeedback-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/fraudlabs-pro/fraudlabs-pro-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/fraudlabs-pro"}, {"type"=>"x-documentation", "url"=>"https://www.fraudlabspro.com/developer/api/screen-order"}, {"type"=>"x-email", "url"=>"support@fraudlabspro.com"}, {"type"=>"x-embeddable", "url"=>"https://www.fraudlabspro.com/secured-seal"}, {"type"=>"x-faq", "url"=>"https://www.fraudlabspro.com/faqs/general"}, {"type"=>"x-github", "url"=>"https://github.com/fraudlabspro/"}, {"type"=>"x-integrations", "url"=>"https://www.fraudlabspro.com/supported-platforms"}, {"type"=>"x-partners", "url"=>"https://www.fraudlabspro.com/reseller-program"}, {"type"=>"x-plugin", "url"=>"https://www.fraudlabspro.com/addon-pricing"}, {"type"=>"x-pricing", "url"=>"https://www.fraudlabspro.com/pricing"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/FraudLabsPro"}, {"type"=>"x-webhook", "url"=>"https://www.fraudlabspro.com/developer/webhook"}, {"type"=>"x-website", "url"=>"https://www.fraudlabspro.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
expedia-partner-solutions{"expedia-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Expedia Partner Solutions", "x-complete"=>1, "info"=>{"title"=>"Expedia", "description"=>"expedia-mobile-api-documentation--brfont-colorblue-note-in-case-of-authorization-exception-just-a-hrefstaticmobileswaggeruiusersigninusersigninafont", "version"=>"0.0.1"}, "host"=>"apim.expedia.com", "basePath"=>"x/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/flight/search"=>{"get"=>{"summary"=>"Search", "description"=>"Mobile API Flights", "operationId"=>"flights-search", "x-api-path-slug"=>"apiflightsearch-get", "parameters"=>[{"in"=>"query", "name"=>"arrivalAirport", "description"=>"The three letter airport code to where the customer is going"}, {"in"=>"query", "name"=>"childTravelerAge", "description"=>"childTravelerAge represents the age of a single child traveler"}, {"in"=>"query", "name"=>"correlationId", "description"=>"Optional parameter to define a correlation between a hotel search and a flight search"}, {"in"=>"query", "name"=>"departureAirport", "description"=>"The three letter airport code for where the customer is leaving from"}, {"in"=>"query", "name"=>"departureDate", "description"=>"Date the customer wants to leave for their flight on, in ISO format"}, {"in"=>"query", "name"=>"featureOverride", "description"=>"Optional field to specify a comma separated list of feature toggling flag names, use _ (underscore) ahead of flag name to disable feature ex, Flex,FlightSearchCacheGet,_FlightSearchCachePut"}, {"in"=>"query", "name"=>"infantSeatingInLap", "description"=>"Set to true if infant(s) are without a reserved seat (in an adults lap)"}, {"in"=>"query", "name"=>"lccAndMerchantFareCheckoutAllowed", "description"=>"flag to indicate whether lcc and merchant fares should be returned in search response"}, {"in"=>"query", "name"=>"maxOfferCount", "description"=>"Maximum number of offers to return"}, {"in"=>"query", "name"=>"nonStopFlight", "description"=>"Set to true to return only non stop flights in the search response "}, {"in"=>"query", "name"=>"numberOfAdultTravelers", "description"=>"Number of Adult Travelers (Default: 1)"}, {"in"=>"query", "name"=>"prettyPrint", "description"=>"Controls JSON response formatting"}, {"in"=>"query", "name"=>"returnDate", "description"=>"Date the customer wants to return on"}, {"in"=>"query", "name"=>"showRefundableFlight", "description"=>"Set to true to return only refundable(Free cancellation available) flights in the search response "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Airports", "Airplanes", "Airlines"]}}, "/api/flight/trip/create"=>{"post"=>{"summary"=>"Create A Trip", "description"=>"Mobile API Flights Create Trip Operation", "operationId"=>"flights-create-trip", "x-api-path-slug"=>"apiflighttripcreate-post", "parameters"=>[{"in"=>"formData", "name"=>"fareFamilyCode"}, {"in"=>"formData", "name"=>"fareFamilyTotalPrice"}, {"in"=>"formData", "name"=>"mobileShoppingKey", "description"=>"The mobile shopping key we are going to create a trip for"}, {"in"=>"formData", "name"=>"productKey", "description"=>"The product key, obtained from /api/flight/search, we are going to create a trip for"}, {"in"=>"formData", "name"=>"qualifyAirAttach", "description"=>"Whether to return a qualified air attach product for this trip"}, {"in"=>"formData", "name"=>"tripTitle", "description"=>"The name of this itinerary as it will appear to customer service and in the itinerary list"}, {"in"=>"formData", "name"=>"withInsurance", "description"=>"Whether to return the available insurance options for this trip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Airports", "Airplanes", "Trips", "Airlines"]}}, "/api/flight/trip/cardFee"=>{"post"=>{"summary"=>"Get the credit card fee for a trip", "description"=>"This api provides an accurate credit card fee that a user would have to pay when booking a trip.", "operationId"=>"flights-trip-fee", "x-api-path-slug"=>"apiflighttripcardfee-post", "parameters"=>[{"in"=>"formData", "name"=>"clientId", "description"=>"Client Id"}, {"in"=>"formData", "name"=>"creditCardId", "description"=>"This is a string that identifies the credit card that will be used to pay for the trip"}, {"in"=>"formData", "name"=>"tripId", "description"=>"The id of the trip to get the credit card fee for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Airports", "Airplanes", "Airlines"]}}, "/api/flight/details"=>{"get"=>{"summary"=>"Details", "description"=>"Mobile API Flight Details Operation", "operationId"=>"flights-details", "x-api-path-slug"=>"apiflightdetails-get", "parameters"=>[{"in"=>"query", "name"=>"arrivalAirport", "description"=>"The three letter airport code for where the customer is going"}, {"in"=>"query", "name"=>"childTravelerAge", "description"=>"childTravelerAge represents the age of a single child traveler"}, {"in"=>"query", "name"=>"departureAirport", "description"=>"The three letter airport code for where the customer is leaving from"}, {"in"=>"query", "name"=>"departureDate", "description"=>"Date the customer wants to leave for their flight on, in ISO format"}, {"in"=>"query", "name"=>"infantSeatingInLap", "description"=>"Set to true if infant(s) are without a reserved seat (in an adults lap)"}, {"in"=>"query", "name"=>"numberOfAdultTravelers", "description"=>"Number of Adult Travelers (Default: 1)"}, {"in"=>"query", "name"=>"productKey", "description"=>"A productKey, obtained from a call to flight search, within the past 20 minutes"}, {"in"=>"query", "name"=>"returnDate", "description"=>"Date the customer wants to return on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Airports", "Airplanes", "Airlines"]}}, "/api/flight/image"=>{"get"=>{"summary"=>"Flight Image", "description"=>"Mobile API Flight Image Operation", "operationId"=>"flights-image", "x-api-path-slug"=>"apiflightimage-get", "parameters"=>[{"in"=>"query", "name"=>"destinationCode", "description"=>"The three letter airport code or metro code of the destination"}, {"in"=>"query", "name"=>"imageHeight", "description"=>"Requested height of the image"}, {"in"=>"query", "name"=>"imageWidth", "description"=>"Requested width of the image"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Airports", "Airplanes", "Images", "Airlines"]}}, "/api/mobile/image"=>{"get"=>{"summary"=>"Mobile Image", "description"=>"Mobile API Flight Mobile Image Operation", "operationId"=>"flights-mobile-image", "x-api-path-slug"=>"apimobileimage-get", "parameters"=>[{"in"=>"query", "name"=>"imageCode", "description"=>"image primary key, for example CAR:ECONOMY ACTIVITY:DISNEY DESTINATION:JFK DESTINATIONMOBILEWEB:JFK CARMOBILEWEB:MINI"}, {"in"=>"query", "name"=>"imageHeight", "description"=>"Requested height of the image"}, {"in"=>"query", "name"=>"imageType", "description"=>"type of image"}, {"in"=>"query", "name"=>"imageWidth", "description"=>"Requested width of the image"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Airports", "Airplanes", "Images", "Airlines"]}}, "/api/flight/airportDropDown"=>{"get"=>{"summary"=>"Airport Dropdown", "description"=>"Mobile API Flight Airport Dropdown Operation", "operationId"=>"flights-airport-dropdown", "x-api-path-slug"=>"apiflightairportdropdown-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Airports", "Airplanes", "Airlines"]}}, "/api/flight/checkout"=>{"post"=>{"summary"=>"Mobile Flight Checkout", "description"=>"Checkout a previously created flight trip, requiring payment fields, the trip id, and the passenger fields", "operationId"=>"flights-checkout", "x-api-path-slug"=>"apiflightcheckout-post", "parameters"=>[{"in"=>"formData", "name"=>"associatedFlightPassengers[0].birthDate", "description"=>"Birth date of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"associatedFlightPassengers[0].gender", "description"=>"Gender of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"associatedFlightPassengers[0].knownTravelerNumber", "description"=>"knownTravelerNumber(PreCheckNumber) of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"associatedFlightPassengers[0].passengerCategory", "description"=>":Passenger category of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"associatedFlightPassengers[0].passportCountryCode", "description"=>"Passport country code of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"associatedFlightPassengers[0].seatPreference", "description"=>"Seat preference of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"associatedFlightPassengers[0].seats[0].arrivalAirportCode", "description"=>"The arrival airport code for the selected seat of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"associatedFlightPassengers[0].seats[0].departureAirportCode", "description"=>"The departure airport code for the selected seat of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"associatedFlightPassengers[0].seats[0].seatNumber", "description"=>"Selected Seat Number of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"associatedFlightPassengers[0].specialAssistanceOption", "description"=>"Special assistance option for the associated flight passenger fields"}, {"in"=>"formData", "name"=>"associatedFlightPassengers[0].title", "description"=>"Title of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"associatedFlightPassengers[0].TSARedressNumber", "description"=>"TSA redress number of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"birthDate", "description"=>"Birth date of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"city", "description"=>"The city of the travelers billing address"}, {"in"=>"formData", "name"=>"country", "description"=>"The 3 letter country code of the travelers billing address"}, {"in"=>"formData", "name"=>"creditCardNumber", "description"=>"The credit card number used for this booking, if checking out with a new card"}, {"in"=>"formData", "name"=>"cvv", "description"=>"The CVV of the travelers credit card used for this booking"}, {"in"=>"formData", "name"=>"doIThinkImSignedIn", "description"=>"As a client I am checking-out with the assumption that I am signed in"}, {"in"=>"formData", "name"=>"email", "description"=>"Email address of the main flight passenger"}, {"in"=>"formData", "name"=>"expectedCardFee", "description"=>"The expected credit card fee, as returned by the createTrip call in the validFormsOfPayment object for whatever credit card the user is paying with"}, {"in"=>"formData", "name"=>"expectedCardFeeCurrencyCode", "description"=>"Three letter 4217 ISO currency code of the expected credit card fee"}, {"in"=>"formData", "name"=>"expectedFareCurrencyCode", "description"=>"Three letter 4217 ISO currency code of the expected total price"}, {"in"=>"formData", "name"=>"expectedTotalFare", "description"=>"The expected total price of the trip, matching exactly whatever the user last saw"}, {"in"=>"formData", "name"=>"expediaEmailOptIn", "description"=>"If the main flight passenger wishes to opt out for Expedia emails or not"}, {"in"=>"formData", "name"=>"expirationDateMonth", "description"=>"The expiration date month of the credit card used for this booking"}, {"in"=>"formData", "name"=>"expirationDateYear", "description"=>"The 4 digit expiration date year of the credit card used for this booking"}, {"in"=>"formData", "name"=>"firstName", "description"=>"The first name of the traveler"}, {"in"=>"formData", "name"=>"frequentFlyerDetails[0].flightAirlineCode", "description"=>"Airline code for the flight to be booked"}, {"in"=>"formData", "name"=>"frequentFlyerDetails[0].frequentFlyerPlanAirlineCode", "description"=>"Airline code for the airline whose frequent Flyer programme is to be used"}, {"in"=>"formData", "name"=>"frequentFlyerDetails[0].frequentFlyerPlanCode", "description"=>"Plan code for Airline program"}, {"in"=>"formData", "name"=>"frequentFlyerDetails[0].membershipNumber", "description"=>"User specific membership number for the frequent flyer programme"}, {"in"=>"formData", "name"=>"gender", "description"=>"Gender of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"knownTravelerNumber", "description"=>"knownTravelerNumber(PreCheckNumber) of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"lastName", "description"=>"The last name of the traveler"}, {"in"=>"formData", "name"=>"mainFlightPassenger[0].email", "description"=>"Email address of the main flight passenger"}, {"in"=>"formData", "name"=>"mainFlightPassenger[0].expediaEmailOptIn", "description"=>"If the main flight passenger wishes to opt out for Expedia emails or not"}, {"in"=>"formData", "name"=>"mainFlightPassenger[0].password", "description"=>"Password of the main flight passenger"}, {"in"=>"formData", "name"=>"mainFlightPassenger[0].phone", "description"=>"Phone number of the main flight passenger"}, {"in"=>"formData", "name"=>"mainFlightPassenger[0].phoneCountryCode", "description"=>"Country code of the phone of the main flight passenger"}, {"in"=>"formData", "name"=>"middleName", "description"=>"The middle name of the traveler"}, {"in"=>"formData", "name"=>"nameOnCard", "description"=>"The card holders name"}, {"in"=>"formData", "name"=>"omniturePartnerId", "description"=>"Omniture partner identification string"}, {"in"=>"formData", "name"=>"passengerCategory", "description"=>":Passenger category of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"passportCountryCode", "description"=>"Passport country code of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"password", "description"=>"Password of the main flight passenger"}, {"in"=>"formData", "name"=>"phone", "description"=>"Phone number of the main flight passenger"}, {"in"=>"formData", "name"=>"phoneCountryCode", "description"=>"Country code of the phone of the main flight passenger"}, {"in"=>"formData", "name"=>"postalCode", "description"=>"The postal code of the travelers billing address"}, {"in"=>"formData", "name"=>"prettyPrint", "description"=>"If true, return JSON with tabs, spaces and newlines to be human readable"}, {"in"=>"formData", "name"=>"seatPreference", "description"=>"Seat preference of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"seats[0].arrivalAirportCode", "description"=>"The arrival airport code for the selected seat of the Main flight passenger fields"}, {"in"=>"formData", "name"=>"seats[0].departureAirportCode", "description"=>"The departure airport code for the selected seat of the Main flight passenger fields"}, {"in"=>"formData", "name"=>"seats[0].seatNumber", "description"=>"Selected Seat Number of the Main flight passenger fields"}, {"in"=>"formData", "name"=>"sendEmailConfirmation", "description"=>"Used to check if confirmation email needs to be sent or not"}, {"in"=>"formData", "name"=>"specialAssistanceOption", "description"=>"Special assistance option for the associated flight passenger fields"}, {"in"=>"formData", "name"=>"state", "description"=>"The state (or province) of the travelers billing address"}, {"in"=>"formData", "name"=>"storeCreditCardInUserProfile", "description"=>"Indicates whether to save the credit card information as a stored credit card in the user profile"}, {"in"=>"formData", "name"=>"storedCreditCardId", "description"=>"The GUID for the stored credit card information to be used for payment"}, {"in"=>"formData", "name"=>"streetAddress", "description"=>"The street part of the credit card owners billing address"}, {"in"=>"formData", "name"=>"streetAddress2", "description"=>"Apartment or suite number of the travelers billing address"}, {"in"=>"formData", "name"=>"suppressFinalBooking", "description"=>"If true, do not actually charge for and book the trip, stop after creating the itinerary"}, {"in"=>"formData", "name"=>"tealeafTransactionId", "description"=>"The unique transaction ID used in TeaLeaf PSR tracking"}, {"in"=>"formData", "name"=>"title", "description"=>"Title of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"tripId", "description"=>"The trip ID of an existing trip, from /api/flight/trip/create"}, {"in"=>"formData", "name"=>"TSARedressNumber", "description"=>"TSA redress number of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"validateWithChildren", "description"=>"Set this flag to true to enable child validation logic on the server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Airports", "Airplanes", "Airlines"]}}, "/m/api/flight/trip/V2/create"=>{"post"=>{"summary"=>"Create a trip for partner", "description"=>"Creates a flight trip, passing a product key and all required fields.", "operationId"=>"flights-checkout", "x-api-path-slug"=>"mapiflighttripv2create-post", "parameters"=>[{"in"=>"formData", "name"=>"childTravelerAge[0]", "description"=>"childTravelerAge represents the age of a single child traveler"}, {"in"=>"formData", "name"=>"infantSeatingInLap", "description"=>"Set to true if infant(s) are without a reserved seat (in an adults lap)"}, {"in"=>"formData", "name"=>"numberOfAdultTravelers", "description"=>"Number of Adult Travelers (Default: 1)"}, {"in"=>"formData", "name"=>"productKey", "description"=>"The product key we are going to create a trip for"}, {"in"=>"formData", "name"=>"tripTitle", "description"=>"The name of this itinerary as it will appear to customer service and in the itinerary list"}, {"in"=>"formData", "name"=>"withInsurance", "description"=>"Whether to return the available insurance options for this trip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Airplanes", "Airlines"]}}, "/api/flight/fareRules/{tripId}"=>{"get"=>{"summary"=>"Fare Rules for the trip", "description"=>"Air Fare Rule information of the trip created", "operationId"=>"flights-fareRules", "x-api-path-slug"=>"apiflightfarerulestripid-get", "parameters"=>[{"in"=>"path", "name"=>"tripId", "description"=>"The trip ID of an existing trip, from /api/flight/trip/create"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Airports", "Airplanes", "Airlines"]}}, "/m/api/hotel/search"=>{"get"=>{"summary"=>"Search", "description"=>"Mobile API Hotels Search\n\nThere are multiple successful responses for this operation.\nSee the examples below for more information.", "operationId"=>"hotels-search", "x-api-path-slug"=>"mapihotelsearch-get", "parameters"=>[{"in"=>"query", "name"=>"airAttachQualificationCode", "description"=>"Qualification code needed to get air attached hotel prices"}, {"in"=>"query", "name"=>"checkInDate", "description"=>"Check in date in ISO format (yyyy-MM-dd)"}, {"in"=>"query", "name"=>"checkOutDate", "description"=>"Check out date in ISO format (yyyy-MM-dd)"}, {"in"=>"query", "name"=>"city", "description"=>"A string to identify the city to search"}, {"in"=>"query", "name"=>"correlationId", "description"=>"Define a correlation between a hotel search and a flight search"}, {"in"=>"query", "name"=>"enableSponsoredListings", "description"=>"Used to check for sponsoredListing"}, {"in"=>"query", "name"=>"filterAmenities", "description"=>"Used to filter by amenities"}, {"in"=>"query", "name"=>"filterHotelName", "description"=>"Hotel name used to filter the search results"}, {"in"=>"query", "name"=>"filterInventoryType", "description"=>"A parameter to filter by inventory type"}, {"in"=>"query", "name"=>"filterPrice", "description"=>"Used to filter by price, make sure it matches filterPriceBuckets if counts are desired"}, {"in"=>"query", "name"=>"filterPriceBuckets", "description"=>"Used to define custom price filter buckets"}, {"in"=>"query", "name"=>"filterStarRatings", "description"=>"Used to filter by star rating"}, {"in"=>"query", "name"=>"filterUnavailable", "description"=>"Unavailable hotels will be removed from the response if set to true"}, {"in"=>"query", "name"=>"forceV2Search", "description"=>"A flag to indicate whether the api should do a domain V2 search for the mobile app"}, {"in"=>"query", "name"=>"hgid", "description"=>"If the hotel group ID parameter (hgid) is present it will take precedence over city, location or lat/long"}, {"in"=>"query", "name"=>"latitude", "description"=>"Latitude to be used in combination with longitude for a coordinate search"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude to be used in combination with latitude for a coordinate search"}, {"in"=>"query", "name"=>"pageIndex", "description"=>"The zero-based index of the page that you are requesting"}, {"in"=>"query", "name"=>"regionId", "description"=>"An Expedia region ID to limit the search to a particular region"}, {"in"=>"query", "name"=>"resultsPerPage", "description"=>"The number of hotels to return per page"}, {"in"=>"query", "name"=>"returnOpaqueHotels", "description"=>"Return Opaque hotels if set to true"}, {"in"=>"query", "name"=>"room", "description"=>"[Optional if room1 field is specified] A Comma Separated Value of #OfAdults, followed by childrens ages for all children that are 18 and under"}, {"in"=>"query", "name"=>"room1", "description"=>"[Optional if room field is specified] A Comma Separated Value of #OfAdults, followed by childrens ages for all children that are 18 and under"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order to sort the list of hotels by Expedia picks, star rating, price and guest rating"}, {"in"=>"query", "name"=>"sortOrderFilter", "description"=>"A post process sort order filter used to apply post sort order filtering to the sorted (sortOrder) search results"}, {"in"=>"query", "name"=>"sourceType", "description"=>"Source type for the request"}, {"in"=>"query", "name"=>"tripId", "description"=>"This field is optional and will default to the the POS default PriceType"}, {"in"=>"query", "name"=>"vipOnly", "description"=>"Used to filter only VIP type hotels"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Hotels"]}}, "/m/api/hotel/offers"=>{"get"=>{"summary"=>"Get Offers", "description"=>"Mobile API Hotels Offers", "operationId"=>"hotels-offers", "x-api-path-slug"=>"mapihoteloffers-get", "parameters"=>[{"in"=>"query", "name"=>"checkInDate", "description"=>"Checkin Date"}, {"in"=>"query", "name"=>"checkOutDate", "description"=>"Checkout Date"}, {"in"=>"query", "name"=>"hotelId", "description"=>"a 32-bit integer, currently between 1 through 7 digit number"}, {"in"=>"query", "name"=>"priceType", "description"=>"Price Type, can only be TOTAL_PRICE or BASE_PRICE_ONLY"}, {"in"=>"query", "name"=>"room", "description"=>"[Optional if room1 field is specified] A Comma Separated Value of #OfAdults, followed by childrens ages for all children that are 18 and under"}, {"in"=>"query", "name"=>"room1", "description"=>"[Optional if room field is specified] A Comma Separated Value of #OfAdults, followed by childrens ages for all children that are 18 and under"}, {"in"=>"query", "name"=>"sourceType", "description"=>"Source Type, for example mobilweb or mobileapp"}, {"in"=>"query", "name"=>"useCacheForAirAttach", "description"=>"[Optional] If this flag is set then the hotel offers (on a successful offers call) and the search fields will be cached"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Hotels"]}}, "/m/api/hotel/offers/v3"=>{"get"=>{"summary"=>"Get Offers", "description"=>"Mobile API Hotels Offers", "operationId"=>"hotels-offers", "x-api-path-slug"=>"mapihoteloffersv3-get", "parameters"=>[{"in"=>"query", "name"=>"checkInDate", "description"=>"Checkin Date"}, {"in"=>"query", "name"=>"checkOutDate", "description"=>"Checkout Date"}, {"in"=>"query", "name"=>"hotelId", "description"=>"a 32-bit integer, currently between 1 through 7 digit number"}, {"in"=>"query", "name"=>"priceType", "description"=>"Price Type, can only be TOTAL_PRICE or BASE_PRICE_ONLY"}, {"in"=>"query", "name"=>"room", "description"=>"[Optional if room1 field is specified] A Comma Separated Value of #OfAdults, followed by childrens ages for all children that are 18 and under"}, {"in"=>"query", "name"=>"room1", "description"=>"[Optional if room field is specified] A Comma Separated Value of #OfAdults, followed by childrens ages for all children that are 18 and under"}, {"in"=>"query", "name"=>"sourceType", "description"=>"Source Type, for example mobilweb or mobileapp"}, {"in"=>"query", "name"=>"useCacheForAirAttach", "description"=>"[Optional] If this flag is set then the hotel offers (on a successful offers call) and the search fields will be cached"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Hotels"]}}, "/m/api/hotel/trip/create"=>{"post"=>{"summary"=>"Create A Trip", "description"=>"Mobile API Hotels Create Trip", "operationId"=>"hotels-create-trip", "x-api-path-slug"=>"mapihoteltripcreate-post", "parameters"=>[{"in"=>"formData", "name"=>"productKey", "description"=>"The product key, obtained by calling /m/api/hotel/offers, we are going to create a trip for"}, {"in"=>"formData", "name"=>"qualifyAirAttach", "description"=>"[Optional] Whether to return a qualified air attach product for this trip"}, {"in"=>"formData", "name"=>"roomInfoFields[0].room", "description"=>"A Comma Separated Value of #OfAdults, followed by childrens ages for all children that are 18 and under"}, {"in"=>"formData", "name"=>"tripTitle", "description"=>"[Optional] The name of this itinerary as it will appear to customer service and in the itinerary list"}, {"in"=>"formData", "name"=>"withInsurance", "description"=>"[Optional] Whether to return the available insurance options for this trip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Hotels"]}}, "/m/api/hotel/trip/checkout"=>{"post"=>{"summary"=>"Checkout", "description"=>"Mobile API Hotels Checkout", "operationId"=>"hotels-checkout", "x-api-path-slug"=>"mapihoteltripcheckout-post", "parameters"=>[{"in"=>"formData", "name"=>"bedTypeId", "description"=>"Parameter that indicates the selected bed Type"}, {"in"=>"formData", "name"=>"checkInDate", "description"=>"Check in date in ISO format (yyyy-MM-dd)"}, {"in"=>"formData", "name"=>"checkOutDate", "description"=>"Check out date in ISO format (yyyy-MM-DD)"}, {"in"=>"formData", "name"=>"city", "description"=>"The city of the travelers billing address"}, {"in"=>"formData", "name"=>"country", "description"=>"The 3 letter country code of the travelers billing address"}, {"in"=>"formData", "name"=>"creditCardNumber", "description"=>"The credit card number used for this booking, if checking out with a new card"}, {"in"=>"formData", "name"=>"cvv", "description"=>"The CVV of the travelers credit card used for this booking"}, {"in"=>"formData", "name"=>"doIThinkImSignedIn", "description"=>"As a client I am checking-out with the assumption that I am signed in"}, {"in"=>"formData", "name"=>"email", "description"=>"This passengers email address"}, {"in"=>"formData", "name"=>"expectedCardFee", "description"=>"The expected credit card fee, as returned by the createTrip call in the validFormsOfPayment object for whatever credit card the user is paying with"}, {"in"=>"formData", "name"=>"expectedCardFeeCurrencyCode", "description"=>"Three letter 4217 ISO currency code of the expected total price"}, {"in"=>"formData", "name"=>"expectedFareCurrencyCode", "description"=>"Three letter 4217 ISO currency code of the expected credit card fee"}, {"in"=>"formData", "name"=>"expectedTotalFare", "description"=>"The expected total price of the trip, matching exactly whatever the user last saw"}, {"in"=>"formData", "name"=>"expediaEmailOptIn", "description"=>"Whether to opt-in the users email to travel deals"}, {"in"=>"formData", "name"=>"expirationDateMonth", "description"=>"The expiration date month of the credit card used for this booking"}, {"in"=>"formData", "name"=>"expirationDateYear", "description"=>"The 4 digit expiration date year of the credit card used for this booking"}, {"in"=>"formData", "name"=>"firstName", "description"=>"The first name of the traveler"}, {"in"=>"formData", "name"=>"lastName", "description"=>"The last name of the traveler"}, {"in"=>"formData", "name"=>"middleName", "description"=>"The middle name of the traveler"}, {"in"=>"formData", "name"=>"nameOnCard", "description"=>"The card holders name"}, {"in"=>"formData", "name"=>"omniturePartnerId", "description"=>"Omniture partner identification string"}, {"in"=>"formData", "name"=>"password", "description"=>"The password provided by the expedia user"}, {"in"=>"formData", "name"=>"phone", "description"=>"The phone number of the traveler"}, {"in"=>"formData", "name"=>"phoneCountryCode", "description"=>"The country code of the phone number of the traveler"}, {"in"=>"formData", "name"=>"postalCode", "description"=>"The postal code of the travelers billing address"}, {"in"=>"formData", "name"=>"prettyPrint", "description"=>"If true, return JSON with tabs, spaces and newlines to be human readable"}, {"in"=>"formData", "name"=>"rooms", "description"=>"A list of room preferences to be applied to the rooms being booked"}, {"in"=>"formData", "name"=>"rooms[0].accessibilityOptionIds", "description"=>"A Comma Separated Value of accessibility option Ids"}, {"in"=>"formData", "name"=>"rooms[0].specialRequests", "description"=>"A text field for special requests"}, {"in"=>"formData", "name"=>"sendEmailConfirmation", "description"=>"Used to check if confirmation email needs to be sent or not"}, {"in"=>"formData", "name"=>"state", "description"=>"The state (or province) of the travelers billing address"}, {"in"=>"formData", "name"=>"storeCreditCardInUserProfile", "description"=>"Indicates whether to save the credit card information as a stored credit card in the user profile"}, {"in"=>"formData", "name"=>"storedCreditCardId", "description"=>"The GUID for the stored credit card information to be used for payment"}, {"in"=>"formData", "name"=>"streetAddress", "description"=>"The street part of the credit card owners billing address"}, {"in"=>"formData", "name"=>"streetAddress2", "description"=>"Apartment or suite number of the travelers billing address"}, {"in"=>"formData", "name"=>"suppressFinalBooking", "description"=>"If true, do not actually charge for and book the trip, stop after creating the itinerary"}, {"in"=>"formData", "name"=>"tealeafTransactionId", "description"=>"The unique transaction ID used in TeaLeaf PSR tracking"}, {"in"=>"formData", "name"=>"tripId", "description"=>"The trip ID of an existing trip, from /m/api/hotel/trip/create"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Hotels"]}}, "/m/api/hotel/trip/V2/checkout"=>{"post"=>{"summary"=>"Hotel Checkout With JSON Request Body", "description"=>"Mobile API Hotel Checkout V2", "operationId"=>"checkoutV2", "x-api-path-slug"=>"mapihoteltripv2checkout-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON body with all the fields required for a Hotel checkout", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Hotels"]}}, "/m/api/hotel/trip/checkoutfields"=>{"get"=>{"summary"=>"Get Required Checkout Fields", "description"=>"Service that returns the fields that are required or optional for a given point of sale.", "operationId"=>"hotels-checkout-fields", "x-api-path-slug"=>"mapihoteltripcheckoutfields-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Hotels"]}}, "/m/api/hotel/trip/cancelEnquiry"=>{"get"=>{"summary"=>"Cancel Enquiry", "description"=>"Cancel Enquiry for hotel, pass in itinerary id, email address of trip owner.", "operationId"=>"hotels-cancel-enquiry", "x-api-path-slug"=>"mapihoteltripcancelenquiry-get", "parameters"=>[{"in"=>"query", "name"=>"emailAddress", "description"=>"Email address of the traveler"}, {"in"=>"query", "name"=>"itineraryId", "description"=>"Itinerary containing trip to cancel"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Hotels"]}}, "/m/api/hotel/trip/V2/cancelEnquiry"=>{"get"=>{"summary"=>"Cancel Enquiry", "description"=>"Cancel Enquiry for hotel, pass in itinerary id, email address of trip owner.", "operationId"=>"hotels-cancel-enquiry", "x-api-path-slug"=>"mapihoteltripv2cancelenquiry-get", "parameters"=>[{"in"=>"query", "name"=>"emailAddress", "description"=>"Email address of the traveler"}, {"in"=>"query", "name"=>"itineraryId", "description"=>"Itinerary containing trip to cancel"}, {"in"=>"query", "name"=>"orderLineGUIDs", "description"=>"Comma separated order line guids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Hotels"]}}, "/m/api/hotel/product"=>{"get"=>{"summary"=>"Product", "description"=>"Hotel Product", "operationId"=>"hotels-product", "x-api-path-slug"=>"mapihotelproduct-get", "parameters"=>[{"in"=>"query", "name"=>"opaqueProduct", "description"=>"Set to true if the product key is an opaque hotel product key"}, {"in"=>"query", "name"=>"productKey", "description"=>"The product key of the offer, obtained by calling /m/api/hotel/offers"}, {"in"=>"query", "name"=>"roomOccupants[0].childGuestAge", "description"=>"represents the age of a single child guest staying in this room"}, {"in"=>"query", "name"=>"roomOccupants[0].numberOfAdultGuests", "description"=>"Number of adults staying in this room (default: 1)"}, {"in"=>"query", "name"=>"sourceType", "description"=>"Source type for the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Hotels"]}}, "/m/api/hotel/info"=>{"get"=>{"summary"=>"Info", "description"=>"Hotel Information", "operationId"=>"hotels-info", "x-api-path-slug"=>"mapihotelinfo-get", "parameters"=>[{"in"=>"query", "name"=>"hotelId", "description"=>"Hotel Id usually 5 digits"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Hotels"]}}, "/m/api/hotel/trip/cancel"=>{"post"=>{"summary"=>"Cancel Trip", "description"=>"Hotel Trip Cancellation", "operationId"=>"hotels-trip-cancel", "x-api-path-slug"=>"mapihoteltripcancel-post", "parameters"=>[{"in"=>"formData", "name"=>"emailAddress", "description"=>"Email address of the traveler"}, {"in"=>"formData", "name"=>"itineraryId", "description"=>"Itinerary id of the trip to cancel"}, {"in"=>"formData", "name"=>"sendConfirmationEmail", "description"=>"Email the traveler after cancellation or not"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Hotels"]}}, "/m/api/hotel/rooms/cancel"=>{"post"=>{"summary"=>"Cancel Room", "description"=>"Hotel Room Cancellation", "operationId"=>"hotels-room-cancel", "x-api-path-slug"=>"mapihotelroomscancel-post", "parameters"=>[{"in"=>"formData", "name"=>"orderLineGUIDs", "description"=>"The list of order line guids"}, {"in"=>"formData", "name"=>"orderNumber", "description"=>"The order number ( returned by OMS ) associated with the trip"}, {"in"=>"formData", "name"=>"tripId", "description"=>"The trip ID ( returned while checkout ) associated with the trip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Hotels"]}}, "/m/api/trip/calculatePoints"=>{"post"=>{"summary"=>"Points Conversion", "description"=>"Converts from a given currency amount to the equivalent in rewards points.\n[Note: Works only if the User is signed-in and is the owner of the trip.]", "operationId"=>"hotels-trip-calculate", "x-api-path-slug"=>"mapitripcalculatepoints-post", "parameters"=>[{"in"=>"formData", "name"=>"amount", "description"=>"The amount the user would want to convert to points"}, {"in"=>"formData", "name"=>"programName", "description"=>"The Rewards program name"}, {"in"=>"formData", "name"=>"rateId", "description"=>"The rate id to use for this conversion"}, {"in"=>"formData", "name"=>"tripId", "description"=>"The trip ID of an existing trip, from /api/packages/createTrip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Trips"]}}, "/getpackages/v1"=>{"get"=>{"summary"=>"Get Packages", "description"=>"Gets packages and supports changed flights and hotels for flexible shopping.", "operationId"=>"get-packages", "x-api-path-slug"=>"getpackagesv1-get", "parameters"=>[{"in"=>"query", "name"=>"adultsPerRoom[1]", "description"=>"How many adults will stay in the given room"}, {"in"=>"query", "name"=>"destination", "description"=>"The userss search string"}, {"in"=>"query", "name"=>"destinationId", "description"=>"Region ID of the origin or destination"}, {"in"=>"query", "name"=>"fromDate", "description"=>"The date the customer wants to leave the origin"}, {"in"=>"query", "name"=>"ftla", "description"=>"TLA (airport code or metrocode) for the origin (ftla) or destination (ttla)"}, {"in"=>"query", "name"=>"numberOfRooms", "description"=>"How many hotel rooms you want"}, {"in"=>"query", "name"=>"origin", "description"=>"The users search string"}, {"in"=>"query", "name"=>"originId", "description"=>"Region ID of the origin or destination"}, {"in"=>"query", "name"=>"packagePIID", "description"=>"Taken from a previous package response"}, {"in"=>"query", "name"=>"packageTripType", "description"=>"i"}, {"in"=>"query", "name"=>"packageType", "description"=>"Supports different views of F+H package"}, {"in"=>"query", "name"=>"pageType", "description"=>"Only for change hotel"}, {"in"=>"query", "name"=>"searchProduct", "description"=>"i"}, {"in"=>"query", "name"=>"toDate", "description"=>"The date the customer wants to leave the destination"}, {"in"=>"query", "name"=>"ttla", "description"=>"TLA (airport code or metrocode) for the origin (ftla) or destination (ttla)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Packages"]}}, "/api/packages/hotelOffers"=>{"get"=>{"summary"=>"Get Package Offers", "description"=>"Mobile API Packages", "operationId"=>"packages-offers", "x-api-path-slug"=>"apipackageshoteloffers-get", "parameters"=>[{"in"=>"query", "name"=>"checkInDate", "description"=>"Date the traveler will be checking in to their hotel"}, {"in"=>"query", "name"=>"checkOutDate", "description"=>"Date the traveler will be checking out of their hotel"}, {"in"=>"query", "name"=>"childTravelerAge", "description"=>"childTravelerAge represents the age of a single child traveler"}, {"in"=>"query", "name"=>"infantSeatingInLap", "description"=>"Set to true if infant(s) are without a reserved seat (in an adults lap)"}, {"in"=>"query", "name"=>"numberOfAdultTravelers", "description"=>"Number of Adult Travelers (Default: 1)"}, {"in"=>"query", "name"=>"productKey", "description"=>"The product ID (piid) of the package you would like to get hotel offers for"}, {"in"=>"query", "name"=>"ratePlanCode", "description"=>"Rate Plan Code of the selected hotel offer"}, {"in"=>"query", "name"=>"roomTypeCode", "description"=>"Room Type Code of the selected hotel offer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Packages", "Offers", "Hotels"]}}, "/api/packages/createTrip"=>{"post"=>{"summary"=>"Create A Trip", "description"=>"Mobile API Packages Create Trip operation", "operationId"=>"packages-create-trip", "x-api-path-slug"=>"apipackagescreatetrip-post", "parameters"=>[{"in"=>"formData", "name"=>"destinationId", "description"=>"stubbed"}, {"in"=>"formData", "name"=>"productKey", "description"=>"The product ID (piid) of the package you would like to get hotel offers for"}, {"in"=>"formData", "name"=>"roomOccupants[0].childGuestAge", "description"=>"represents the age of a single child guest staying in this room"}, {"in"=>"formData", "name"=>"roomOccupants[0].infantsInSeat", "description"=>"Any infants in seat"}, {"in"=>"formData", "name"=>"roomOccupants[0].numberOfAdultGuests", "description"=>"Number of adults staying in this room (default: 1)"}, {"in"=>"formData", "name"=>"roomOccupants[0].seniorCount", "description"=>"Number of seniors staying in this room (default: 0)"}, {"in"=>"formData", "name"=>"tripName", "description"=>"stubbed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Packages"]}}, "/api/packages/checkout"=>{"post"=>{"summary"=>"Checkout", "description"=>"Mobile API Packages Checkout", "operationId"=>"packages-checkout", "x-api-path-slug"=>"apipackagescheckout-post", "parameters"=>[{"in"=>"formData", "name"=>"city", "description"=>"The city of the travelers billing address"}, {"in"=>"formData", "name"=>"country", "description"=>"The 3 letter country code of the travelers billing address"}, {"in"=>"formData", "name"=>"creditCardNumber", "description"=>"The credit card number used for this booking, if checking out with a new card"}, {"in"=>"formData", "name"=>"cvv", "description"=>"The CVV of the travelers credit card used for this booking"}, {"in"=>"formData", "name"=>"doIThinkImSignedIn", "description"=>"As a client I am checking-out with the assumption that I am signed in"}, {"in"=>"formData", "name"=>"expectedCardFee", "description"=>"The expected credit card fee, as returned by the createTrip call in the validFormsOfPayment object for whatever credit card the user is paying with"}, {"in"=>"formData", "name"=>"expectedCardFeeCurrencyCode", "description"=>"Three letter 4217 ISO currency code of the expected total price"}, {"in"=>"formData", "name"=>"expectedFareCurrencyCode", "description"=>"Three letter 4217 ISO currency code of the expected credit card fee"}, {"in"=>"formData", "name"=>"expectedTotalFare", "description"=>"The expected total price of the trip, matching exactly whatever the user last saw"}, {"in"=>"formData", "name"=>"expirationDateMonth", "description"=>"The expiration date month of the credit card used for this booking"}, {"in"=>"formData", "name"=>"expirationDateYear", "description"=>"The 4 digit expiration date year of the credit card used for this booking"}, {"in"=>"formData", "name"=>"flight[0].associatedFlightPassengers[0].birthDate", "description"=>"Birth date of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"flight[0].associatedFlightPassengers[0].gender", "description"=>"Gender of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"flight[0].associatedFlightPassengers[0].knownTravelerNumber", "description"=>"knownTravelerNumber(PreCheckNumber) of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"flight[0].associatedFlightPassengers[0].passengerCategory", "description"=>":Passenger category of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"flight[0].associatedFlightPassengers[0].passportCountryCode", "description"=>"Passport country code of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"flight[0].associatedFlightPassengers[0].seatPreference", "description"=>"Seat preference of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"flight[0].associatedFlightPassengers[0].specialAssistanceOption", "description"=>"Special assistance option for the associated flight passenger fields"}, {"in"=>"formData", "name"=>"flight[0].associatedFlightPassengers[0].title", "description"=>"Title of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"flight[0].associatedFlightPassengers[0].TSARedressNumber", "description"=>"TSA redress number of the associated flight passenger fields"}, {"in"=>"formData", "name"=>"flight[0].mainFlightPassenger[0].email", "description"=>"Email address of the main flight passenger"}, {"in"=>"formData", "name"=>"flight[0].mainFlightPassenger[0].expediaEmailOptIn", "description"=>"If the main flight passenger wishes to opt out for Expedia emails or not"}, {"in"=>"formData", "name"=>"flight[0].mainFlightPassenger[0].password", "description"=>"Password of the main flight passenger"}, {"in"=>"formData", "name"=>"flight[0].mainFlightPassenger[0].phone", "description"=>"Phone number of the main flight passenger"}, {"in"=>"formData", "name"=>"flight[0].mainFlightPassenger[0].phoneCountryCode", "description"=>"Country code of the phone of the main flight passenger"}, {"in"=>"formData", "name"=>"hotel[0].bedTypeId", "description"=>"Indicates the selected bed Type"}, {"in"=>"formData", "name"=>"hotel[0].primaryContactFullName", "description"=>"Full name of the person who will be checking in"}, {"in"=>"formData", "name"=>"nameOnCard", "description"=>"The card holders name"}, {"in"=>"formData", "name"=>"omniturePartnerId", "description"=>"Omniture partner identification string"}, {"in"=>"formData", "name"=>"postalCode", "description"=>"The postal code of the travelers billing address"}, {"in"=>"formData", "name"=>"sendEmailConfirmation", "description"=>"Used to check if confirmation email needs to be sent or not"}, {"in"=>"formData", "name"=>"state", "description"=>"The state (or province) of the travelers billing address"}, {"in"=>"formData", "name"=>"storeCreditCardInUserProfile", "description"=>"Indicates whether to save the credit card information as a stored credit card in the user profile"}, {"in"=>"formData", "name"=>"storedCreditCardId", "description"=>"The GUID for the stored credit card information to be used for payment"}, {"in"=>"formData", "name"=>"streetAddress", "description"=>"The street part of the credit card owners billing address"}, {"in"=>"formData", "name"=>"streetAddress2", "description"=>"Apartment or suite number of the travelers billing address"}, {"in"=>"formData", "name"=>"tealeafTransactionId", "description"=>"The unique transaction ID used in TeaLeaf PSR tracking"}, {"in"=>"formData", "name"=>"tripId", "description"=>"The trip ID of an existing trip, from /api/packages/createTrip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Packages"]}}, "/api/m/trip/coupon"=>{"post"=>{"summary"=>"Apply Coupon", "description"=>"Mobile API Packages Apply Coupon", "operationId"=>"packages-apply-coupon", "x-api-path-slug"=>"apimtripcoupon-post", "parameters"=>[{"in"=>"formData", "name"=>"coupon.code", "description"=>"Coupon Code"}, {"in"=>"formData", "name"=>"coupon.instanceId", "description"=>"Instance ID"}, {"in"=>"formData", "name"=>"coupon.name", "description"=>"Coupon Name"}, {"in"=>"formData", "name"=>"tripId", "description"=>"The tripId we are going to apply the coupon to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Airports", "Airplanes", "Coupons", "Airlines"]}}, "/api/m/trip/remove/coupon"=>{"post"=>{"summary"=>"Remove Coupon", "description"=>"Mobile API Packages Remove Coupon", "operationId"=>"packages-remove-coupon", "x-api-path-slug"=>"apimtripremovecoupon-post", "parameters"=>[{"in"=>"formData", "name"=>"tripId", "description"=>"The tripId we are going to apply the coupon to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Airports", "Airplanes", "Coupons", "Airlines"]}}, "/api/trips"=>{"get"=>{"summary"=>"Get Trips", "description"=>"Mobile API Trips", "operationId"=>"trips-search", "x-api-path-slug"=>"apitrips-get", "parameters"=>[{"in"=>"query", "name"=>"filterBookingStatus", "description"=>"An optional parameter to filter by booking status"}, {"in"=>"query", "name"=>"filterLineOfBusiness", "description"=>"An optional parameters to filter by line of business"}, {"in"=>"query", "name"=>"filterTimePeriod", "description"=>"An optional parameter to filter by time period"}, {"in"=>"query", "name"=>"getCachedDetails", "description"=>"Optionally get full details for the first N trips"}, {"in"=>"query", "name"=>"sort", "description"=>"An optional parameter to sort by date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Search"]}}, "/api/trips/{tripId}"=>{"get"=>{"summary"=>"Trips by tripId", "description"=>"Mobile API Trips", "operationId"=>"trips-search-id", "x-api-path-slug"=>"apitripstripid-get", "parameters"=>[{"in"=>"query", "name"=>"currencyCode", "description"=>"Currency parameter"}, {"in"=>"query", "name"=>"decimalPlaceCount", "description"=>"Decimal place count for the expected amount"}, {"in"=>"query", "name"=>"decorator", "description"=>"Nullifies complex elements of a Trip with exception of Price related elements and their parents"}, {"in"=>"query", "name"=>"email", "description"=>"To pull a guest itinerary specify the email address associated with the trip"}, {"in"=>"query", "name"=>"expectedAmount", "description"=>"Expected Amount during car cancellation"}, {"in"=>"path", "name"=>"tripId", "description"=>"The trip ID"}, {"in"=>"query", "name"=>"useCache", "description"=>"An optional flag to make a cached read trip call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Search", "Trips"]}}, "/api/trips/{tripId}/updateTripNameDescription"=>{"post"=>{"summary"=>"Update Trip Name and Description", "description"=>"Mobile API Trips update trip name and description operation", "operationId"=>"trips-update-trip", "x-api-path-slug"=>"apitripstripidupdatetripnamedescription-post", "parameters"=>[{"in"=>"path", "name"=>"tripId", "description"=>"Trip ID"}, {"in"=>"formData", "name"=>"tripname", "description"=>"The name of the trip"}, {"in"=>"formData", "name"=>"tripnote", "description"=>"The comments of the trip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Search", "Trips"]}}, "/api/users/{userId}/trips/{tripId}"=>{"get"=>{"summary"=>"(Internal Only)", "description"=>"(Internal Only) Retrieve trip (tripId) for given customer (userId)", "operationId"=>"trips-user-trips", "x-api-path-slug"=>"apiusersuseridtripstripid-get", "parameters"=>[{"in"=>"query", "name"=>"currencyCode", "description"=>"currency paramater"}, {"in"=>"query", "name"=>"decimalPlaceCount", "description"=>"Decimal place count for the expected amount"}, {"in"=>"query", "name"=>"decorator", "description"=>"Nullifies complex elements of a Trip with exception of Price related elements and their parents"}, {"in"=>"query", "name"=>"email", "description"=>"To pull a guest itinerary specify the email address associated with the trip"}, {"in"=>"query", "name"=>"expectedAmount", "description"=>"Expected Amount during car cancellation"}, {"in"=>"path", "name"=>"tripId", "description"=>"Trip ID"}, {"in"=>"query", "name"=>"useCache", "description"=>"An optional flag to make a cached read trip call"}, {"in"=>"path", "name"=>"userId", "description"=>"User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Users"]}}, "/api/users/{userId}/trips"=>{"get"=>{"summary"=>"(Internal Only)", "description"=>"(Internal Only) Returns array of trips for passed userId", "operationId"=>"trips-by-user-id", "x-api-path-slug"=>"apiusersuseridtrips-get", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Users"]}}, "/m/api/rails/trip/cardFee"=>{"post"=>{"summary"=>"Get the credit card fee for a trip", "description"=>"This api provides an accurate credit card fee that a user would have to pay when booking a trip.", "operationId"=>"rails-trip-fee", "x-api-path-slug"=>"mapirailstripcardfee-post", "parameters"=>[{"in"=>"formData", "name"=>"clientId", "description"=>"Client Id"}, {"in"=>"formData", "name"=>"creditCardId", "description"=>"This is a string that identifies the credit card that will be used to pay for the trip"}, {"in"=>"formData", "name"=>"tdoToken", "description"=>"This is a string that identifies the ticket delivery option that will be used for the trip"}, {"in"=>"formData", "name"=>"tripId", "description"=>"The id of the trip to get the credit card fee for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Trips"]}}, "/m/api/rails/trip/checkout"=>{"post"=>{"summary"=>"Rails Checkout With JSON Request Body", "description"=>"Mobile API Rails Checkout", "operationId"=>"rails-cko", "x-api-path-slug"=>"mapirailstripcheckout-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON body with all the fields required for a Rails checkout", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Trains", "Rails"]}}, "/api/user/sign-in"=>{"post"=>{"summary"=>"User Sign-In", "description"=>"Mobile API User Sign-In", "operationId"=>"signin-user", "x-api-path-slug"=>"apiusersignin-post", "parameters"=>[{"in"=>"formData", "name"=>"email", "description"=>"Email Address"}, {"in"=>"formData", "name"=>"firstTimeSigin", "description"=>"Boolean to indicate if this is a first time sign-in"}, {"in"=>"formData", "name"=>"guestLoginWithItin", "description"=>"When logging in with an Itin Number and Email set this field to True"}, {"in"=>"formData", "name"=>"includeFullPaymentProfile"}, {"in"=>"formData", "name"=>"itinNumber", "description"=>"The Itinerary Number can be used instead of a password to authenticate the user"}, {"in"=>"formData", "name"=>"password", "description"=>"User Password"}, {"in"=>"formData", "name"=>"profileOnly", "description"=>"If true, dont provide username/password fields and just re-retrieve the currently signed on users profile"}, {"in"=>"formData", "name"=>"profileTypes", "description"=>"This is a comma-separated list of profile types to retrieve when the login is processed"}, {"in"=>"formData", "name"=>"retrieveCoupons", "description"=>"Whether to include user coupons in the response"}, {"in"=>"formData", "name"=>"staySignedIn", "description"=>"Sign Me In checkbox"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Users"]}}, "/api/user/profile"=>{"get"=>{"summary"=>"Profile", "description"=>"Mobile API User Profile", "operationId"=>"profile-user", "x-api-path-slug"=>"apiuserprofile-get", "parameters"=>[{"in"=>"query", "name"=>"profileTypes", "description"=>"This is a comma-separated list of profile types to retrieve when the login is processed"}, {"in"=>"query", "name"=>"retrieveCoupons", "description"=>"Whether to include user coupons in the response"}, {"in"=>"query", "name"=>"tuid", "description"=>"The tuid of the user/account whose profile you would like"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Users"]}}, "/api/user/create"=>{"post"=>{"summary"=>"Create User", "description"=>"Mobile API User Create", "operationId"=>"create-user", "x-api-path-slug"=>"apiusercreate-post", "parameters"=>[{"in"=>"formData", "name"=>"email", "description"=>"Users email address"}, {"in"=>"formData", "name"=>"enrollInLoyalty", "description"=>"Whether to enroll the user in loyalty"}, {"in"=>"formData", "name"=>"expediaEmailOptIn", "description"=>"Whether to opt-in the users email to travel deals"}, {"in"=>"formData", "name"=>"firstName", "description"=>"Users first name"}, {"in"=>"formData", "name"=>"lastName", "description"=>"Users last name"}, {"in"=>"formData", "name"=>"middleName", "description"=>"Users middle name"}, {"in"=>"formData", "name"=>"password", "description"=>"Users password"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Users"]}}, "/api/user/update-traveler"=>{"post"=>{"summary"=>"Update", "description"=>"Mobile API User Update Traveler", "operationId"=>"update-traveler", "x-api-path-slug"=>"apiuserupdatetraveler-post", "parameters"=>[{"in"=>"formData", "name"=>"birthDate", "description"=>"TSA required field; passengers birth date"}, {"in"=>"formData", "name"=>"email", "description"=>"This passengers email address"}, {"in"=>"formData", "name"=>"expediaEmailOptIn", "description"=>"Whether to opt-in the users email to travel deals"}, {"in"=>"formData", "name"=>"firstName", "description"=>"The first name of the traveler"}, {"in"=>"formData", "name"=>"gender", "description"=>"TSA required field, MALE or FEMALE"}, {"in"=>"formData", "name"=>"knownTravelerNumber", "description"=>"Passengers knownTravelerNumber(PreCheckNumber), a 9 digit number"}, {"in"=>"formData", "name"=>"lastName", "description"=>"The last name of the traveler"}, {"in"=>"formData", "name"=>"middleName", "description"=>"The middle name of the traveler"}, {"in"=>"formData", "name"=>"passengerCategory", "description"=>"The passengers category"}, {"in"=>"formData", "name"=>"passportCountryCode", "description"=>"Passport country, UPPERCASE three letter country code"}, {"in"=>"formData", "name"=>"password", "description"=>"The password provided by the Expedia user"}, {"in"=>"formData", "name"=>"phone", "description"=>"The phone number of the traveler"}, {"in"=>"formData", "name"=>"phoneCountryCode", "description"=>"The country code of the phone number of the traveler"}, {"in"=>"formData", "name"=>"seatPreference", "description"=>"Passengers seat preference"}, {"in"=>"formData", "name"=>"specialAssistanceOption", "description"=>"Special assistance choice"}, {"in"=>"formData", "name"=>"title", "description"=>"Title of passenger"}, {"in"=>"formData", "name"=>"TSARedressNumber", "description"=>"Passengers TSA redress number, which is, in theory a 7 digit number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Users"]}}, "/api/user/associateUserToTrip"=>{"post"=>{"summary"=>"Associate User To Trip", "description"=>"Mobile API User Associate To Trip", "operationId"=>"user-associate-to-trip", "x-api-path-slug"=>"apiuserassociateusertotrip-post", "parameters"=>[{"in"=>"formData", "name"=>"foo", "description"=>"stubbed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Search", "Trips"]}}, "/m/api/cars/search/airport"=>{"get"=>{"summary"=>"Search", "description"=>"Mobile API Cars", "operationId"=>"cars-search", "x-api-path-slug"=>"mapicarssearchairport-get", "parameters"=>[{"in"=>"query", "name"=>"airportCode", "description"=>"3 letter airport code where you will be picking up and dropping off your rental car"}, {"in"=>"query", "name"=>"dropOffTime", "description"=>"When you will pick up the car"}, {"in"=>"query", "name"=>"pickupTime", "description"=>"When you will pick up the car"}, {"in"=>"query", "name"=>"vendorCode", "description"=>"The vendor code to filter/limit search results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Cars"]}}, "/m/api/cars/search/location"=>{"get"=>{"summary"=>"Search", "description"=>"Mobile API Cars", "operationId"=>"cars-search", "x-api-path-slug"=>"mapicarssearchlocation-get", "parameters"=>[{"in"=>"query", "name"=>"dropOffTime", "description"=>"When you will pick up the car"}, {"in"=>"query", "name"=>"pickupLocation.lat", "description"=>"The location (latitude) to search near"}, {"in"=>"query", "name"=>"pickupLocation.lon", "description"=>"The location (longitude) to search near"}, {"in"=>"query", "name"=>"pickupTime", "description"=>"When you will pick up the car"}, {"in"=>"query", "name"=>"searchRadius", "description"=>"The max distance around the location to search in"}, {"in"=>"query", "name"=>"vendorCode", "description"=>"The vendor code to filter/limit search results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Cars"]}}, "/m/api/cars/search"=>{"get"=>{"summary"=>"Search", "description"=>"Mobile API Cars", "operationId"=>"cars-search", "x-api-path-slug"=>"mapicarssearch-get", "parameters"=>[{"in"=>"query", "name"=>"destinationAirportCode", "description"=>"3 letter airport code where you will dropping off your rental car"}, {"in"=>"query", "name"=>"dropOffLocation.lat", "description"=>"The location (latitude) for drop off"}, {"in"=>"query", "name"=>"dropOffLocation.lon", "description"=>"The location (longitude) for drop off"}, {"in"=>"query", "name"=>"dropOffTime", "description"=>"When you will pick up the car"}, {"in"=>"query", "name"=>"originAirportCode", "description"=>"3 letter airport code where you will be picking up your rental car"}, {"in"=>"query", "name"=>"pickupLocation.lat", "description"=>"The location (latitude) to search near"}, {"in"=>"query", "name"=>"pickupLocation.lon", "description"=>"The location (longitude) to search near"}, {"in"=>"query", "name"=>"pickupTime", "description"=>"When you will pick up the car"}, {"in"=>"query", "name"=>"searchRadius", "description"=>"The max distance around the location to search in"}, {"in"=>"query", "name"=>"vendorCode", "description"=>"The vendor code to filter/limit search results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Cars"]}}, "/m/api/cars/trip/create"=>{"post"=>{"summary"=>"Create A Trip", "description"=>"Mobile API Cars Create Trip", "operationId"=>"cars-create-trip", "x-api-path-slug"=>"mapicarstripcreate-post", "parameters"=>[{"in"=>"formData", "name"=>"expectedTotalFare", "description"=>"The expected total price of the trip, matching exactly whatever the user last saw"}, {"in"=>"formData", "name"=>"productKey", "description"=>"The product ID (piid) you would like to create a trip"}, {"in"=>"formData", "name"=>"tripName", "description"=>"Name of this trip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Cars"]}}, "/m/api/cars/trip/checkout"=>{"post"=>{"summary"=>"Checkout", "description"=>"Mobile API Cars Checkout", "operationId"=>"cars-checkout", "x-api-path-slug"=>"mapicarstripcheckout-post", "parameters"=>[{"in"=>"formData", "name"=>"airlineCode", "description"=>"Airline code of the travelers flight"}, {"in"=>"formData", "name"=>"city", "description"=>"The city of the travelers billing address"}, {"in"=>"formData", "name"=>"country", "description"=>"The 3 letter country code of the travelers billing address"}, {"in"=>"formData", "name"=>"creditCardNumber", "description"=>"The credit card number used for this booking, if checking out with a new card"}, {"in"=>"formData", "name"=>"cvv", "description"=>"The CVV of the travelers credit card used for this booking"}, {"in"=>"formData", "name"=>"doIThinkImSignedIn", "description"=>"As a client I am checking-out with the assumption that I am signed in"}, {"in"=>"formData", "name"=>"expectedCardFee", "description"=>"The expected credit card fee, as returned by the createTrip call in the validFormsOfPayment object for whatever credit card the user is paying with"}, {"in"=>"formData", "name"=>"expectedCardFeeCurrencyCode", "description"=>"Three letter 4217 ISO currency code of the expected credit card fee"}, {"in"=>"formData", "name"=>"expectedFareCurrencyCode", "description"=>"Three letter 4217 ISO currency code of the expected total price"}, {"in"=>"formData", "name"=>"expectedTotalFare", "description"=>"The expected total price of the trip, matching exactly whatever the user last saw"}, {"in"=>"formData", "name"=>"expirationDateMonth", "description"=>"The expiration date month of the credit card used for this booking"}, {"in"=>"formData", "name"=>"expirationDateYear", "description"=>"The 4 digit expiration date year of the credit card used for this booking"}, {"in"=>"formData", "name"=>"flightNumber", "description"=>"Flight number of the traveler"}, {"in"=>"formData", "name"=>"loyaltyNumber", "description"=>"Loyalty number of the traveler"}, {"in"=>"formData", "name"=>"mainMobileTraveler.email", "description"=>"This passengers email address"}, {"in"=>"formData", "name"=>"mainMobileTraveler.expediaEmailOptIn", "description"=>"Whether to opt-in the users email to travel deals"}, {"in"=>"formData", "name"=>"mainMobileTraveler.firstName", "description"=>"The first name of the traveler"}, {"in"=>"formData", "name"=>"mainMobileTraveler.lastName", "description"=>"The last name of the traveler"}, {"in"=>"formData", "name"=>"mainMobileTraveler.middleName", "description"=>"The middle name of the traveler"}, {"in"=>"formData", "name"=>"mainMobileTraveler.password", "description"=>"The password provided by the expedia user"}, {"in"=>"formData", "name"=>"mainMobileTraveler.phone", "description"=>"The phone number of the traveler"}, {"in"=>"formData", "name"=>"mainMobileTraveler.phoneCountryCode", "description"=>"The country code of the phone number of the traveler"}, {"in"=>"formData", "name"=>"nameOnCard", "description"=>"The card holders name"}, {"in"=>"formData", "name"=>"omniturePartnerId", "description"=>"Omniture partner identification string"}, {"in"=>"formData", "name"=>"postalCode", "description"=>"The postal code of the travelers billing address"}, {"in"=>"formData", "name"=>"prettyPrint", "description"=>"If true, return JSON with tabs, spaces and newlines to be human readable"}, {"in"=>"formData", "name"=>"specialEquipments", "description"=>"Special Equipments to be requested"}, {"in"=>"formData", "name"=>"state", "description"=>"The state (or province) of the travelers billing address"}, {"in"=>"formData", "name"=>"storeCreditCardInUserProfile", "description"=>"Indicates whether to save the credit card information as a stored credit card in the user profile"}, {"in"=>"formData", "name"=>"storedCreditCardId", "description"=>"The GUID for the stored credit card information to be used for payment"}, {"in"=>"formData", "name"=>"streetAddress", "description"=>"The street part of the credit card owners billing address"}, {"in"=>"formData", "name"=>"streetAddress2", "description"=>"Apartment or suite number of the travelers billing address"}, {"in"=>"formData", "name"=>"suppressFinalBooking", "description"=>"If true, do not actually charge for and book the trip, stop after creating the itinerary"}, {"in"=>"formData", "name"=>"tealeafTransactionId", "description"=>"The unique transaction ID used in TeaLeaf PSR tracking"}, {"in"=>"formData", "name"=>"tripId", "description"=>"The trip ID of an existing trip, from /api/flight/trip/create"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Cars"]}}, "/m/api/cars/trip/cancel"=>{"post"=>{"summary"=>"Cancel Trip", "description"=>"car Trip Cancellation", "operationId"=>"car-trip-cancel", "x-api-path-slug"=>"mapicarstripcancel-post", "parameters"=>[{"in"=>"formData", "name"=>"emailAddress", "description"=>"Email address of the traveler"}, {"in"=>"formData", "name"=>"itineraryNumber", "description"=>"Itinerary Number of the trip to cancel"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Cars"]}}, "/lx/api/search"=>{"get"=>{"summary"=>"Search", "description"=>"LX Shop Search", "operationId"=>"lx-search", "x-api-path-slug"=>"lxapisearch-get", "parameters"=>[{"in"=>"query", "name"=>"endDate", "description"=>"(optional) dates in YYY-MM-DD format (preferred) or POS configuration format (e"}, {"in"=>"query", "name"=>"langid", "description"=>"Use langid as defined for a POS secondary language"}, {"in"=>"query", "name"=>"location", "description"=>"This represents the location in POS configuration language, the term is more accurate if it is closer to ESS representation of region"}, {"in"=>"query", "name"=>"startDate", "description"=>"(optional) dates in YYY-MM-DD format (preferred) or POS configuration format (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Shop"]}}, "/lx/api/activity"=>{"get"=>{"summary"=>"Infosite/Details", "description"=>"Lx Details Search", "operationId"=>"lx-details", "x-api-path-slug"=>"lxapiactivity-get", "parameters"=>[{"in"=>"query", "name"=>"activityId", "description"=>"This represents the location in POS configuration language, the term is more accurate if it is closer to ESS representation of region"}, {"in"=>"query", "name"=>"endDate", "description"=>"(optional) dates in YYY-MM-DD format (preferred) or POS configuration format (e"}, {"in"=>"query", "name"=>"langid", "description"=>"Use langid as defined for a POS secondary language"}, {"in"=>"query", "name"=>"startDate", "description"=>"(optional) dates in YYY-MM-DD format (preferred) or POS configuration format (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Activities"]}}, "/m/api/lx/trip/create"=>{"post"=>{"summary"=>"Create A Trip", "description"=>"Mobile API Lx Create Trip", "operationId"=>"lx-create-trip", "x-api-path-slug"=>"mapilxtripcreate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Lx Trip consisting of chosen item information and trip name", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Trips"]}}, "/m/api/lx/trip/checkout"=>{"post"=>{"summary"=>"Checkout", "description"=>"Mobile API Lx Checkout", "operationId"=>"lx-checkout", "x-api-path-slug"=>"mapilxtripcheckout-post", "parameters"=>[{"in"=>"formData", "name"=>"city", "description"=>"The city of the travelers billing address"}, {"in"=>"formData", "name"=>"country", "description"=>"The 3 letter country code of the travelers billing address"}, {"in"=>"formData", "name"=>"creditCardNumber", "description"=>"The credit card number used for this booking, if checking out with a new card"}, {"in"=>"formData", "name"=>"cvv", "description"=>"The CVV of the travelers credit card used for this booking"}, {"in"=>"formData", "name"=>"doIThinkImSignedIn", "description"=>"As a client I am checking-out with the assumption that I am signed in"}, {"in"=>"formData", "name"=>"email", "description"=>"This passengers email address"}, {"in"=>"formData", "name"=>"expectedCardFee", "description"=>"The expected credit card fee, as returned by the createTrip call in the validFormsOfPayment object for whatever credit card the user is paying with"}, {"in"=>"formData", "name"=>"expectedCardFeeCurrencyCode", "description"=>"Three letter 4217 ISO currency code of the expected credit card fee"}, {"in"=>"formData", "name"=>"expectedFareCurrencyCode", "description"=>"Three letter 4217 ISO currency code of the expected total price"}, {"in"=>"formData", "name"=>"expectedTotalFare", "description"=>"The expected total price of the trip, matching exactly whatever the user last saw"}, {"in"=>"formData", "name"=>"expediaEmailOptIn", "description"=>"Whether to opt-in the users email to travel deals"}, {"in"=>"formData", "name"=>"expirationDateMonth", "description"=>"The expiration date month of the credit card used for this booking"}, {"in"=>"formData", "name"=>"expirationDateYear", "description"=>"The 4 digit expiration date year of the credit card used for this booking"}, {"in"=>"formData", "name"=>"firstName", "description"=>"The first name of the traveler"}, {"in"=>"formData", "name"=>"lastName", "description"=>"The last name of the traveler"}, {"in"=>"formData", "name"=>"middleName", "description"=>"The middle name of the traveler"}, {"in"=>"formData", "name"=>"nameOnCard", "description"=>"The card holders name"}, {"in"=>"formData", "name"=>"omniturePartnerId", "description"=>"Omniture partner identification string"}, {"in"=>"formData", "name"=>"password", "description"=>"The password provided by the expedia user"}, {"in"=>"formData", "name"=>"phone", "description"=>"The phone number of the traveler"}, {"in"=>"formData", "name"=>"phoneCountryCode", "description"=>"The country code of the phone number of the traveler"}, {"in"=>"formData", "name"=>"postalCode", "description"=>"The postal code of the travelers billing address"}, {"in"=>"formData", "name"=>"prettyPrint", "description"=>"If true, return JSON with tabs, spaces and newlines to be human readable"}, {"in"=>"formData", "name"=>"state", "description"=>"The state (or province) of the travelers billing address"}, {"in"=>"formData", "name"=>"storeCreditCardInUserProfile", "description"=>"Indicates whether to save the credit card information as a stored credit card in the user profile"}, {"in"=>"formData", "name"=>"storedCreditCardId", "description"=>"The GUID for the stored credit card information to be used for payment"}, {"in"=>"formData", "name"=>"streetAddress", "description"=>"The street part of the credit card owners billing address"}, {"in"=>"formData", "name"=>"streetAddress2", "description"=>"Apartment or suite number of the travelers billing address"}, {"in"=>"formData", "name"=>"suppressFinalBooking", "description"=>"If true, do not actually charge for and book the trip, stop after creating the itinerary"}, {"in"=>"formData", "name"=>"tealeafTransactionId", "description"=>"The unique transaction ID used in TeaLeaf PSR tracking"}, {"in"=>"formData", "name"=>"tripId", "description"=>"The trip ID of an existing trip, from /api/flight/trip/create"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Hotels"]}}, "/m/api/hotel/search/v3"=>{"get"=>{"summary"=>"LPAS Search", "description"=>"Mobile API Hotel Search using LPAS", "operationId"=>"hotel-search-lpas", "x-api-path-slug"=>"mapihotelsearchv3-get", "parameters"=>[{"in"=>"query", "name"=>"airAttachQualificationCode", "description"=>"Qualification code needed to get air attached hotel prices"}, {"in"=>"query", "name"=>"brandNameId", "description"=>"Filter"}, {"in"=>"query", "name"=>"checkInDate", "description"=>"Check in date in ISO format (yyyy-MM-dd)"}, {"in"=>"query", "name"=>"checkOutDate", "description"=>"Check out date in ISO format (yyyy-MM-dd)"}, {"in"=>"query", "name"=>"city", "description"=>"Name of the city to search hotels in"}, {"in"=>"query", "name"=>"correlationId", "description"=>"Define a correlation between a hotel search and a flight search"}, {"in"=>"query", "name"=>"enableSponsoredListings", "description"=>"Check for sponsoredListing"}, {"in"=>"query", "name"=>"enableTravelAdsList", "description"=>"Check whether travelAds are required in a separate list"}, {"in"=>"query", "name"=>"filterAmenities", "description"=>"Filter"}, {"in"=>"query", "name"=>"filterHotelName", "description"=>"Filter"}, {"in"=>"query", "name"=>"filterInventoryType", "description"=>"Filter"}, {"in"=>"query", "name"=>"filterPrice", "description"=>"Filter by given price buckets"}, {"in"=>"query", "name"=>"filterPriceBuckets", "description"=>"Price filter buckets"}, {"in"=>"query", "name"=>"filterStarRatings", "description"=>"Filter by star ratings"}, {"in"=>"query", "name"=>"filterUnavailable", "description"=>"Whether unavailable hotels should be returned"}, {"in"=>"query", "name"=>"hgid", "description"=>"List of hotel ids to be searched for"}, {"in"=>"query", "name"=>"latitude", "description"=>"Location search"}, {"in"=>"query", "name"=>"longitude", "description"=>"Location search"}, {"in"=>"query", "name"=>"pageIndex", "description"=>"0 based page index of search results"}, {"in"=>"query", "name"=>"priceType", "description"=>"Return only hotels matching given priceType"}, {"in"=>"query", "name"=>"regionId", "description"=>"Region based search"}, {"in"=>"query", "name"=>"resultsPerPage", "description"=>"Expected number of hotels per page"}, {"in"=>"query", "name"=>"returnOpaqueHotels", "description"=>"Whether opaque hotels should be returned"}, {"in"=>"query", "name"=>"room", "description"=>"[Optional if room1 field is specified] A Comma Separated Value of #OfAdults, followed by childrens ages for all children that are 18 and under"}, {"in"=>"query", "name"=>"room1", "description"=>"[Optional if room field is specified] A Comma Separated Value of #OfAdults, followed by childrens ages for all children that are 18 and under"}, {"in"=>"query", "name"=>"sendAdaptedResponse", "description"=>"Whether package-adapted response should be returned"}, {"in"=>"query", "name"=>"shopWithPoints", "description"=>"Whether shopping with points be enabled"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of search results"}, {"in"=>"query", "name"=>"sortOrderFilter", "description"=>"Filter results post sorting"}, {"in"=>"query", "name"=>"tripId", "description"=>"Trip Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Hotels"]}}}}, "apis"=>{"name"=>"Expedia Partner Solutions", "x-slug"=>"expedia-partner-solutions", "description"=>"Expedia Partner Solutions is the B2B partnership brand of Expedia Group. Our mission is to fuel our partners growth through our unparalleled technology, travel supply and support services.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/195-expedia.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"522533", "tags"=>"API Provider,Bookings,Enterprise,Flights,General Data,Hotels,Networks,New,Pedestal,Profiles,Relative Data,Reservations,Stack,Stack Network,Technology,Transportation,Travel,Travel,Travel", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"expedia-partner-solutions/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Expedia", "x-api-slug"=>"expedia", "description"=>"Expedia is the leader in travel and technology and is the worlds largest travel company. The EAN Developer Hub gives developers FREE access to our highly flexible APIs that power cutting-edge websites, mobile apps, and much more. Some of the best travel applications on the market are powered by the EAN API. Learn more reasons to partner with EAN by taking a look at our brochure and watching our video. The world of travel awaits you!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/195-expedia.jpg", "humanURL"=>"http://developer.ean.com/", "baseURL"=>"https://apim.expedia.com/x/", "tags"=>"API Provider,Bookings,Enterprise,Flights,General Data,Hotels,Networks,New,Pedestal,Profiles,Relative Data,Reservations,Stack,Stack Network,Technology,Transportation,Travel,Travel,Travel", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/expedia-partner-solutions/mapihotelsearchv3-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/expedia-partner-solutions/expedia-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api.ean.com"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/expedia"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/ean-upc-codes-com"}, {"type"=>"x-documentation", "url"=>"https://www.expedia.com/static/mobile/swaggerui/"}, {"type"=>"x-email", "url"=>"support@ean.com"}, {"type"=>"x-email", "url"=>"support@expediapartnersolutions.com"}, {"type"=>"x-github", "url"=>"https://github.com/Expedia"}, {"type"=>"x-swagger--original", "url"=>"https://www.expedia.com/static/mobile/swaggerui/swagger.json"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/ExpediaEAN"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/expediapartners"}, {"type"=>"x-website", "url"=>"http://developer.ean.com/"}, {"type"=>"x-website", "url"=>"http://expedia.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
swagger{"swagger-generator-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Swagger", "x-complete"=>1, "info"=>{"title"=>"Swagger Generator", "description"=>"this-is-an-online-swagger-codegen-server---you-can-find-out-more-at-httpsgithub-comswaggerapiswaggercodegen-or-on-irc-freenode-net-swaggerhttpswagger-ioirc-", "termsOfService"=>"http://swagger.io/terms/", "contact"=>{"name"=>"apiteam@swagger.io"}, "version"=>"2.2.3"}, "host"=>"generator.swagger.io", "basePath"=>"/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/gen/clients"=>{"get"=>{"summary"=>"Gets languages supported by the client generator", "description"=>"Gets languages supported by the client generator.", "operationId"=>"clientOptions", "x-api-path-slug"=>"genclients-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generate", "Clients"]}}, "/gen/clients/{language}"=>{"get"=>{"summary"=>"Returns options for a client library", "description"=>"Returns options for a client library.", "operationId"=>"getClientOptions", "x-api-path-slug"=>"genclientslanguage-get", "parameters"=>[{"in"=>"path", "name"=>"language", "description"=>"The target language for the client library"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generate", "Clients", "Language"]}, "post"=>{"summary"=>"Generates a client library", "description"=>"Accepts a `GeneratorInput` options map for spec location and generation options", "operationId"=>"generateClient", "x-api-path-slug"=>"genclientslanguage-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Configuration for building the client library", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"language", "description"=>"The target language for the client library"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generate", "Clients", "Language"]}}, "/gen/download/{fileId}"=>{"get"=>{"summary"=>"Downloads a pre-generated file", "description"=>"A valid `fileId` is generated by the `/clients/{language}` or `/servers/{language}` POST operations. The fileId code can be used just once, after which a new `fileId` will need to be requested.", "operationId"=>"downloadFile", "x-api-path-slug"=>"gendownloadfileid-get", "parameters"=>[{"in"=>"path", "name"=>"fileId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generate", "Download", "FileId"]}}, "/gen/servers"=>{"get"=>{"summary"=>"Gets languages supported by the server generator", "description"=>"Gets languages supported by the server generator.", "operationId"=>"serverOptions", "x-api-path-slug"=>"genservers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generate", "Servers"]}}, "/gen/servers/{framework}"=>{"get"=>{"summary"=>"Returns options for a server framework", "description"=>"Returns options for a server framework.", "operationId"=>"getServerOptions", "x-api-path-slug"=>"genserversframework-get", "parameters"=>[{"in"=>"path", "name"=>"framework", "description"=>"The target language for the server framework"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generate", "Servers", "Framework"]}, "post"=>{"summary"=>"Generates a server library", "description"=>"Accepts a `GeneratorInput` options map for spec location and generation options.", "operationId"=>"generateServerForLanguage", "x-api-path-slug"=>"genserversframework-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"framework", "description"=>"framework"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generate", "Servers", "Framework"]}}}}, "apis"=>{"name"=>"Swagger", "x-slug"=>"swagger", "description"=>"Swagger aides in development across the entire API lifecycle, from design and documentation, to test and deployment. Try it today!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1684-swagger.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"23531", "tags"=>"API LIfeyclessss,SaaS,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"swagger/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Swagger Generator", "x-api-slug"=>"swagger-generator", "description"=>"Swagger aides in development across the entire API lifecycle, from design and documentation, to test and deployment. Try it today!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1684-swagger.jpg", "humanURL"=>"http://swagger.io/", "baseURL"=>"https://generator.swagger.io//api", "tags"=>"API LIfeyclessss,SaaS,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/swagger/swagger-generator-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://swagger.io/blog/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/swagger"}, {"type"=>"x-github", "url"=>"https://github.com/swagger-api"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/SwaggerApi"}, {"type"=>"x-website", "url"=>"http://swagger.io/"}, {"type"=>"x-website", "url"=>"http://swagger.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
healthcare-gov{"healthcare-gov-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Healthcare.gov", "x-complete"=>1, "info"=>{"title"=>"Healthcare", "version"=>"1.0.0"}, "host"=>"www.healthcare.gov", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/articles{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Articles", "description"=>"Returns pages content.", "operationId"=>"getApiArticlesMediatypeextension", "x-api-path-slug"=>"apiarticlesmediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension", "description"=>"Omiting the param causes html to be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Articles"]}}, "/api/blog{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Blog", "description"=>"Returns pages content.", "operationId"=>"getApiBlogMediatypeextension", "x-api-path-slug"=>"apiblogmediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension", "description"=>"Omiting the param causes html to be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog"]}}, "/api/glossary{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Glossary", "description"=>"Returns pages content.", "operationId"=>"getApiGlossaryMediatypeextension", "x-api-path-slug"=>"apiglossarymediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension", "description"=>"Omiting the param causes html to be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Glossary"]}}, "/api/questions{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Questions", "description"=>"Returns pages content.", "operationId"=>"getApiQuestionsMediatypeextension", "x-api-path-slug"=>"apiquestionsmediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension", "description"=>"Omiting the param causes html to be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Questions"]}}, "/api/states{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get States", "description"=>"Returns pages content.", "operationId"=>"getApiStatesMediatypeextension", "x-api-path-slug"=>"apistatesmediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension", "description"=>"Omiting the param causes html to be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["States"]}}, "/api/topics{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Topics", "description"=>"Returns pages content.", "operationId"=>"getApiTopicsMediatypeextension", "x-api-path-slug"=>"apitopicsmediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension", "description"=>"Omiting the param causes html to be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics"]}}, "/blog/{pageName}{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Blog Pagename", "description"=>"Returns pages content.", "operationId"=>"getBlogPagenameMediatypeextension", "x-api-path-slug"=>"blogpagenamemediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension", "description"=>"Omiting the param causes html to be returned"}, {"in"=>"path", "name"=>"pageName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog", "Pagename"]}}, "/es/blog/{pageName}{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Es Blog Pagename", "description"=>"Returns pages content.", "operationId"=>"getEsBlogPagenameMediatypeextension", "x-api-path-slug"=>"esblogpagenamemediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension", "description"=>"Omiting the param causes html to be returned"}, {"in"=>"path", "name"=>"pageName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Es", "Blog", "Pagename"]}}, "/es/glossary/{pageName}{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Es Glossary Pagename", "description"=>"Returns pages content.", "operationId"=>"getEsGlossaryPagenameMediatypeextension", "x-api-path-slug"=>"esglossarypagenamemediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension", "description"=>"Omiting the param causes html to be returned"}, {"in"=>"path", "name"=>"pageName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Es", "Glossary", "Pagename"]}}, "/es/question/{pageName}{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Es Question Pagename", "description"=>"Returns pages content.", "operationId"=>"getEsQuestionPagenameMediatypeextension", "x-api-path-slug"=>"esquestionpagenamemediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension", "description"=>"Omiting the param causes html to be returned"}, {"in"=>"path", "name"=>"pageName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Es", "Question", "Pagename"]}}, "/es/{pageName}{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Es Pagename", "description"=>"Returns pages content.", "operationId"=>"getEsPagenameMediatypeextension", "x-api-path-slug"=>"espagenamemediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension", "description"=>"Omiting the param causes html to be returned"}, {"in"=>"path", "name"=>"pageName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Es", "Pagename"]}}, "/es/{stateName}{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Es Statename", "description"=>"Returns pages content.", "operationId"=>"getEsStatenameMediatypeextension", "x-api-path-slug"=>"esstatenamemediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension", "description"=>"Omiting the param causes html to be returned"}, {"in"=>"path", "name"=>"stateName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Es", "Statename"]}}, "/glossary/{pageName}{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Glossary Pagename", "description"=>"Returns pages content.", "operationId"=>"getGlossaryPagenameMediatypeextension", "x-api-path-slug"=>"glossarypagenamemediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension", "description"=>"Omiting the param causes html to be returned"}, {"in"=>"path", "name"=>"pageName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Glossary", "Pagename"]}}, "/question/{pageName}{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Question Pagename", "description"=>"Returns pages content.", "operationId"=>"getQuestionPagenameMediatypeextension", "x-api-path-slug"=>"questionpagenamemediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension", "description"=>"Omiting the param causes html to be returned"}, {"in"=>"path", "name"=>"pageName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Question", "Pagename"]}}, "/{pageName}{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Pagename", "description"=>"Returns pages content.", "operationId"=>"getPagenameMediatypeextension", "x-api-path-slug"=>"pagenamemediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension", "description"=>"Omiting the param causes html to be returned"}, {"in"=>"path", "name"=>"pageName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pagename"]}}, "/{stateName}{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Statename", "description"=>"Returns pages content.", "operationId"=>"getStatenameMediatypeextension", "x-api-path-slug"=>"statenamemediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension", "description"=>"Omiting the param causes html to be returned"}, {"in"=>"path", "name"=>"stateName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Statename"]}}}}, "apis"=>{"name"=>"Healthcare.gov", "x-slug"=>"healthcare-gov", "description"=>"HealthCare.gov is a health insurance exchange website operated under the United States federal government under the provisions of the Patient Protection and Affordable Care Act (ACA, often known as Obamacare), designed to serve the residents of the thirty-six U.S. states that opted not to create their own state exchanges. The exchange facilitates the sale of private health insurance plans to residents of the United States[2] and offers subsidies to those who earn less than four times the federal poverty line. The website also assists those persons who are eligible to sign up for Medicaid, and has a separate marketplace for small businesses.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Healthcare.gov_logo.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,Federal Government,Federal Government,General Data,Healthcare,Insurance,Profiles,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"healthcare-gov/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Healthcare.gov", "x-api-slug"=>"healthcare-gov", "description"=>"HealthCare.gov is a health insurance exchange website operated under the United States federal government under the provisions of the Patient Protection and Affordable Care Act (ACA, often known as Obamacare), designed to serve the residents of the thirty-six U.S. states that opted not to create their own state exchanges. The exchange facilitates the sale of private health insurance plans to residents of the United States[2] and offers subsidies to those who earn less than four times the federal poverty line. The website also assists those persons who are eligible to sign up for Medicaid, and has a separate marketplace for small businesses.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Healthcare.gov_logo.png", "humanURL"=>"http://www.healthcare.gov", "baseURL"=>"https://www.healthcare.gov//", "tags"=>"API Provider,Federal Government,Federal Government,General Data,Healthcare,Insurance,Profiles,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/healthcare-gov/statenamemediatypeextension-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/healthcare-gov/healthcare-gov-openapi.yaml"}]}, {"name"=>"HealthCare.gov", "x-api-slug"=>"healthcare-gov", "description"=>"The Health Insurance Marketplace at HeathCare.gov provides information on health care and health insurance options in the United States. Starting October 1, 2013, users will be able to fill out applications and view a custom list of health care plan options. From there, users will be able to compare plans and select the best one for them. Meanwhile, there is still plenty of healthcare and insurance information available.All of the Health Insurance Marketplace's educational content is available programmatically via API so that developers can use it to create new products and services. The API uses REST calls issued in JSON and JSONP.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Healthcare.gov_logo.png", "humanURL"=>"http://www.healthcare.gov", "baseURL"=>"https://www.healthcare.gov//", "tags"=>"Insurance,State, Name, Media, Type, Extension", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/healthcare-gov/statenamemediatypeextension-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/healthcare-gov/healthcare-gov-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"http://www.healthcare.gov/developers"}, {"type"=>"x-website", "url"=>"http://www.healthcare.gov"}, {"type"=>"x-website", "url"=>"http://healthcare.gov"}, {"type"=>"x-wikipedia", "url"=>"http://en.wikipedia.org/wiki/Healthcare.gov"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bitly{"bitly-link-metrics-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bitly", "x-complete"=>1, "info"=>{"title"=>"Bitly Link Metrics API", "description"=>"the-bitly-link-metrics-api", "termsOfService"=>"http://dev.bitly.com/best_practices.html", "version"=>"v3"}, "host"=>"api-ssl.bitly.com", "basePath"=>"/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/link/clicks"=>{"get"=>{"summary"=>"Link Clicks", "description"=>"Returns the number of clicks on a single Bitlink.", "operationId"=>"linkClicks", "x-api-path-slug"=>"linkclicks-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"json, xml, txt"}, {"in"=>"query", "name"=>"limit", "description"=>"1 to 1000 (default=100)"}, {"in"=>"query", "name"=>"link", "description"=>"a Bitlink"}, {"in"=>"query", "name"=>"rollup", "description"=>"Return data for multiple units rolled up to a single result instead of a separate value for each period of time"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14 to 14), or a timezone string default: America/New_York"}, {"in"=>"query", "name"=>"unit", "description"=>"minute, hour, day, week or month, default: day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics, default: now"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Clicks"]}}, "/link/countries"=>{"get"=>{"summary"=>"Link Clicks by Country", "description"=>"Returns metrics about the countries referring click traffic to a single Bitlink.", "operationId"=>"linkClicksbyCountry", "x-api-path-slug"=>"linkcountries-get", "parameters"=>[{"in"=>"query", "name"=>"link", "description"=>"a Bitlink"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14"}, {"in"=>"query", "name"=>"unit", "description"=>"minute | hour | day | week | month default:day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Countries"]}}, "/link/encoders"=>{"get"=>{"summary"=>"User Who Encoded Link", "description"=>"Returns users who have encoded this long URL (optionally only those in the requesting users social graph).", "operationId"=>"userWhoEncodedLink", "x-api-path-slug"=>"linkencoders-get", "parameters"=>[{"in"=>"query", "name"=>"expand_user", "description"=>"include display names of encoders"}, {"in"=>"query", "name"=>"limit", "description"=>"integer in the range of 1 to 25 that specifies the number of records to return (default: 10)"}, {"in"=>"query", "name"=>"link", "description"=>"a Bitlink"}, {"in"=>"query", "name"=>"my_network", "description"=>"restrict to my network"}, {"in"=>"query", "name"=>"subaccounts", "description"=>"true or false - restrict to this enterprise account and its subaccounts"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Encoders"]}}, "/link/encoders_by_count"=>{"get"=>{"summary"=>"Users Who Encoded Link", "description"=>"Returns users who have encoded this link (optionally only those in the requesting users social graph), sorted by the number of clicks on each encoding users link.", "operationId"=>"usersWhoEncodedLink", "x-api-path-slug"=>"linkencoders-by-count-get", "parameters"=>[{"in"=>"query", "name"=>"expand_user", "description"=>"include display names of encoders"}, {"in"=>"query", "name"=>"limit", "description"=>"integer in the range 1:100 that specifies the number of records to return (default:10)"}, {"in"=>"query", "name"=>"link", "description"=>"a Bitlink"}, {"in"=>"query", "name"=>"my_network", "description"=>"restrict to my network"}, {"in"=>"query", "name"=>"subaccounts", "description"=>"restrict to this enterprise account and its subaccounts"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Encoders", "By", "Count"]}}, "/link/encoders_count"=>{"get"=>{"summary"=>"Number of Encoders", "description"=>"Returns the number of users who have shortened (encoded) a single Bitlink.", "operationId"=>"numberOfEncoders", "x-api-path-slug"=>"linkencoders-count-get", "parameters"=>[{"in"=>"query", "name"=>"link", "description"=>"a Bitlink"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Encoders", "Count"]}}, "/link/referrers"=>{"get"=>{"summary"=>"Link Referrers", "description"=>"Returns metrics about the pages referring click traffic to a single Bitlink.", "operationId"=>"linkReferrers", "x-api-path-slug"=>"linkreferrers-get", "parameters"=>[{"in"=>"query", "name"=>"link", "description"=>"a Bitlink"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14"}, {"in"=>"query", "name"=>"unit", "description"=>"minute | hour | day | week | month default:day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Referrers"]}}, "/link/referrers_by_domain"=>{"get"=>{"summary"=>"Link Referrers by Domain", "description"=>"Returns metrics about the pages referring click traffic to a single Bitlink, grouped by referring domain.", "operationId"=>"linkReferrersByDomain", "x-api-path-slug"=>"linkreferrers-by-domain-get", "parameters"=>[{"in"=>"query", "name"=>"link", "description"=>"a Bitlink"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14"}, {"in"=>"query", "name"=>"unit", "description"=>"minute | hour | day | week | month default:day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Referrers", "By", "Domain"]}}}}, "bitly-user-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bitly", "x-complete"=>1, "info"=>{"title"=>"Bitly User API", "description"=>"the-bitly-user-api", "termsOfService"=>"http://dev.bitly.com/best_practices.html", "version"=>"v3"}, "host"=>"api-ssl.bitly.com", "basePath"=>"/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v3/oauth/app"=>{"get"=>{"summary"=>"OAuth App", "description"=>"Return information about an OAuth app.", "operationId"=>"oauthApp", "x-api-path-slug"=>"v3oauthapp-get", "parameters"=>[{"in"=>"query", "name"=>"client_id", "description"=>"the client ID of the app"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OAuth", "App"]}}, "/v3/user/info"=>{"get"=>{"summary"=>"User Info", "description"=>"Return or update information about a user.", "operationId"=>"userInfo", "x-api-path-slug"=>"v3userinfo-get", "parameters"=>[{"in"=>"query", "name"=>"full_name", "description"=>"set the users full name value"}, {"in"=>"query", "name"=>"login", "description"=>"the bitly login of the user whose info to look up"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Info"]}}, "/v3/user/link_history"=>{"get"=>{"summary"=>"User Link History", "description"=>"Returns entries from a users link history in reverse chronological order.", "operationId"=>"userLinkHistory", "x-api-path-slug"=>"v3userlink-history-get", "parameters"=>[{"in"=>"query", "name"=>"archived", "description"=>"on, offor both whether to include or exclude archived history entries"}, {"in"=>"query", "name"=>"campaign_id", "description"=>"filter to return only links for the given campaign_id, can be provided multiple times"}, {"in"=>"query", "name"=>"created_after", "description"=>"timestamp as an integer unix epoch"}, {"in"=>"query", "name"=>"created_before", "description"=>"timestamp as an integer unix epoch"}, {"in"=>"query", "name"=>"exact_domain", "description"=>"n exact domain to filter on history entries"}, {"in"=>"query", "name"=>"expand_client_id", "description"=>"whether to provide additional information about encoding application"}, {"in"=>"query", "name"=>"keyword", "description"=>"custom keyword to filter on history entries"}, {"in"=>"query", "name"=>"limit", "description"=>"integer in the range 1 to 100 default: 50, specifying the max number of results to return"}, {"in"=>"query", "name"=>"link", "description"=>"optional the Bitlink or Bitlinks to return metadata for (when specified, overrides all other options), can be provided multiple times"}, {"in"=>"query", "name"=>"modified_after", "description"=>"timestamp as an integer unix epoch"}, {"in"=>"query", "name"=>"offset", "description"=>"integer specifying the numbered result at which to start (for pagination)"}, {"in"=>"query", "name"=>"private", "description"=>"on, off and both whether to include or exclude private history entries"}, {"in"=>"query", "name"=>"query", "description"=>"optional ad hoc text search string"}, {"in"=>"query", "name"=>"root_domain", "description"=>"a root domain to filter on history entries"}, {"in"=>"query", "name"=>"user", "description"=>"the user for whom to retrieve history entries (if different from authenticated user)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Link", "History"]}}, "/v3/user/network_history"=>{"get"=>{"summary"=>"User Network History", "description"=>"Returns entries from a users network history in reverse chronogical order. (A users network history includes publicly saved links from Twitter and Facebook connections.)", "operationId"=>"userNetworkHistory", "x-api-path-slug"=>"v3usernetwork-history-get", "parameters"=>[{"in"=>"query", "name"=>"expand_client_id", "description"=>"whether to provide additional information about encoding application"}, {"in"=>"query", "name"=>"expand_user", "description"=>"include extra user info in response (login, avatar_url, display_name, profile_url, full_name)"}, {"in"=>"query", "name"=>"limit", "description"=>"integer in the range of 1 to 100 that specifies the number of records to return (default: 20)"}, {"in"=>"query", "name"=>"offset", "description"=>"integer that specifies the first record to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Network", "History"]}}, "/v3/user/tracking_domain_list"=>{"get"=>{"summary"=>"User Tracking Domain List", "description"=>"Returns a list of tracking domains a user has configured.", "operationId"=>"userTrackingDomainList", "x-api-path-slug"=>"v3usertracking-domain-list-get", "parameters"=>[{"in"=>"query", "name"=>"tracking_domains", "description"=>"a list of tracking domains configured for the authenticated user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Tracking", "Domain", "List"]}}}}, "bitly-user-metrics-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bitly", "x-complete"=>1, "info"=>{"title"=>"Bitly User Metrics API", "description"=>"the-bitly-user-metrics-api", "termsOfService"=>"http://dev.bitly.com/best_practices.html", "version"=>"v3"}, "host"=>"api-ssl.bitly.com", "basePath"=>"/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v3/user/clicks"=>{"get"=>{"summary"=>"User Clicks", "description"=>"Returns the aggregate number of clicks on all of the authenticated users Bitlinks.", "operationId"=>"userClicks", "x-api-path-slug"=>"v3userclicks-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"json, xml, txt"}, {"in"=>"query", "name"=>"limit", "description"=>"1 to 1000 (default=100)"}, {"in"=>"query", "name"=>"rollup", "description"=>"Return data for multiple units rolled up to a single result instead of a separate value for each period of time"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14 to 14), or a timezone string default: America/New_York"}, {"in"=>"query", "name"=>"unit", "description"=>"minute, hour, day, week or month, default: day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics, default: now"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Clicks"]}}, "/v3/user/countries"=>{"get"=>{"summary"=>"User Countries", "description"=>"Returns aggregate metrics about the countries referring click traffic to all of the authenticated users Bitlinks.", "operationId"=>"userCountries", "x-api-path-slug"=>"v3usercountries-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"1 to 1000 (default=100)"}, {"in"=>"query", "name"=>"rollup", "description"=>"Return data for multiple units rolled up to a single result instead of a separate value for each period of time"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14 to 14), or a timezone string default: America/New_York"}, {"in"=>"query", "name"=>"unit", "description"=>"minute, hour, day, week or month, default: day"}, {"in"=>"query", "name"=>"units", "description"=>"Successful response"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics, default: now"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Countries"]}}, "/v3/user/popular_earned_by_clicks"=>{"get"=>{"summary"=>"User Popular Earned By Clicks", "description"=>"Returns the top links to your tracking domain (or domains) created by users not associated with your account, ordered by clicks.", "operationId"=>"userPopularEarnedbyClicks", "x-api-path-slug"=>"v3userpopular-earned-by-clicks-get", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"a tracking domain as returned from /v3/user/tracking_domain_list"}, {"in"=>"query", "name"=>"limit", "description"=>"1"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14"}, {"in"=>"query", "name"=>"unit", "description"=>"hour | day | week | month default:day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Popular", "Earned", "Clicks"]}}, "/v3/user/popular_earned_by_shortens"=>{"get"=>{"summary"=>"User Popular Earned By Shortens", "description"=>"Returns the top links to your tracking domain (or domains) created by users not associated with your account, ordered by shortens.", "operationId"=>"userPopularEarnedByShortens", "x-api-path-slug"=>"v3userpopular-earned-by-shortens-get", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"a tracking domain as returned from /v3/user/tracking_domain_list"}, {"in"=>"query", "name"=>"limit", "description"=>"1"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14"}, {"in"=>"query", "name"=>"unit", "description"=>"hour | day | week | month default:day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Popular", "Earned", "Shortens"]}}, "/v3/user/popular_links"=>{"get"=>{"summary"=>"User Popular Links", "description"=>"Returns the authenticated users most-clicked Bitlinks (ordered by number of clicks) in a given time period.", "operationId"=>"userPopularLinks", "x-api-path-slug"=>"v3userpopular-links-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"1"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14"}, {"in"=>"query", "name"=>"unit", "description"=>"minute | hour | day | week | month default:day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Popular", "Links"]}}, "/v3/user/popular_owned_by_clicks"=>{"get"=>{"summary"=>"User Popular Owned By Clicks", "description"=>"Returns the top links to your tracking domain (or domains) created by you or your subaccounts ordered by clicks.", "operationId"=>"userPopularOwnedByClicks", "x-api-path-slug"=>"v3userpopular-owned-by-clicks-get", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"a tracking domain as returned from /v3/user/tracking_domain_list (may be specified multiple times)"}, {"in"=>"query", "name"=>"limit", "description"=>"1"}, {"in"=>"query", "name"=>"subaccount", "description"=>"restrict to links created by this subaccount (may be specified multiple times)"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14"}, {"in"=>"query", "name"=>"unit", "description"=>"hour | day | week | month default:day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Popular", "Owned", "Clicks"]}}, "/v3/user/popular_owned_by_shortens"=>{"get"=>{"summary"=>"User Popular Owned by Shortens", "description"=>"Returns the top links to your tracking domain (or domains) created by you or your subaccounts ordered by number of shortens.", "operationId"=>"userPopularOwnedByShortens", "x-api-path-slug"=>"v3userpopular-owned-by-shortens-get", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"a tracking domain as returned from /v3/user/tracking_domain_list (may be specified multiple times)"}, {"in"=>"query", "name"=>"limit", "description"=>"1"}, {"in"=>"query", "name"=>"subaccount", "description"=>"restrict to links created by this subaccount (may be specified multiple times)"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14"}, {"in"=>"query", "name"=>"unit", "description"=>"hour | day | week | month default:day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Popular", "Owned", "By", "Shortens"]}}, "/v3/user/referrers"=>{"get"=>{"summary"=>"User Referrers", "description"=>"Returns aggregate metrics about the pages referring click traffic to all of the authenticated users Bitlinks.", "operationId"=>"userReferrers", "x-api-path-slug"=>"v3userreferrers-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"1 to 1000 (default=100)"}, {"in"=>"query", "name"=>"rollup", "description"=>"Return data for multiple units rolled up to a single result instead of a separate value for each period of time"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14 to 14), or a timezone string default: America/New_York"}, {"in"=>"query", "name"=>"unit", "description"=>"minute, hour, day, week or month, default: day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics, default: now"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Referrers"]}}, "/v3/user/referring_domains"=>{"get"=>{"summary"=>"User Referring Domains", "description"=>"eturns aggregate metrics about the domains referring click traffic to all of the authenticated users Bitlinks. If the user is a master account, or is a subaccount with full_reports permission, the user may choose to view the metrics of any account belonging to the master account.", "operationId"=>"userReferringDomains", "x-api-path-slug"=>"v3userreferring-domains-get", "parameters"=>[{"in"=>"query", "name"=>"exclude_social_networks", "description"=>"If true, exclude domains that are part of a social network that bitly tracks (default=true)"}, {"in"=>"query", "name"=>"limit", "description"=>"1 to 1000 (default=100)"}, {"in"=>"query", "name"=>"login", "description"=>"an optional string consisting of the account name used to report the appropriate statistics; defaults to the current user"}, {"in"=>"query", "name"=>"rollup", "description"=>"Return data for multiple units rolled up to a single result instead of a separate value for each period of time"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14 to 14), or a timezone string default: America/New_York"}, {"in"=>"query", "name"=>"unit", "description"=>"minute, hour, day, week or month, default: day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics, default: now"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Referring", "Domains"]}}, "/v3/user/shorten_counts"=>{"get"=>{"summary"=>"User Shorten Counts", "description"=>"Returns the number of Bitlinks created in a given time period by the authenticated user.", "operationId"=>"userShortenCounts", "x-api-path-slug"=>"v3usershorten-counts-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"json, xml, txt"}, {"in"=>"query", "name"=>"limit", "description"=>"1 to 1000 (default=100)"}, {"in"=>"query", "name"=>"rollup", "description"=>"Return data for multiple units rolled up to a single result instead of a separate value for each period of time"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14 to 14), or a timezone string default: America/New_York"}, {"in"=>"query", "name"=>"unit", "description"=>"minute, hour, day, week or month, default: day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics, default: now"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Shorten", "Counts"]}}}}, "bitly-link-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bitly", "x-complete"=>1, "info"=>{"title"=>"Bitly Link API", "description"=>"the-bitly-link-api-", "termsOfService"=>"http://dev.bitly.com/best_practices.html", "version"=>"3.0"}, "host"=>"api-ssl.bitly.com", "basePath"=>"/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/search"=>{"get"=>{"summary"=>"Get Search", "description"=>"Get search.", "operationId"=>"getSearch", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"cities", "description"=>"show links active in this city (ordered like country-state-city, e"}, {"in"=>"query", "name"=>"domain", "description"=>"restrict results to this web domain (like bitly"}, {"in"=>"query", "name"=>"fields", "description"=>"which fields to return in the response (comma-separated)"}, {"in"=>"query", "name"=>"full_domain", "description"=>"restrict results to this full web domain (like blog"}, {"in"=>"query", "name"=>"lang", "description"=>"favor results in this language (two letter ISO code)"}, {"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"offset", "description"=>"which result to start with (defaults to 0)"}, {"in"=>"query", "name"=>"query", "description"=>"string to query for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}, "/v3/expand"=>{"get"=>{"summary"=>"Get Expand", "description"=>"Get expand.", "operationId"=>"getV3Expand", "x-api-path-slug"=>"v3expand-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"json, xml, txt"}, {"in"=>"query", "name"=>"hash", "description"=>"refers to one or more bitly hashes"}, {"in"=>"query", "name"=>"shortUrl", "description"=>"refers to one or more Bitlinks"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Expand"]}}, "/v3/info"=>{"get"=>{"summary"=>"Get Info", "description"=>"Get info.", "operationId"=>"getV3Info", "x-api-path-slug"=>"v3info-get", "parameters"=>[{"in"=>"query", "name"=>"expand_user", "description"=>"optional true|false - include extra user info in response"}, {"in"=>"query", "name"=>"hash", "description"=>"refers to one or more bitly hashes, (e"}, {"in"=>"query", "name"=>"shortUrl", "description"=>"refers to one or more Bitlinks e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Info"]}}, "/v3/link/lookup"=>{"get"=>{"summary"=>"Get Link Lookup", "description"=>"Get link lookup.", "operationId"=>"getV3LinkLookup", "x-api-path-slug"=>"v3linklookup-get", "parameters"=>[{"in"=>"query", "name"=>"url", "description"=>"one or more long URLs to lookup"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Lookup"]}}, "/v3/shorten"=>{"get"=>{"summary"=>"Get Shorten", "description"=>"Get shorten.", "operationId"=>"getV3Shorten", "x-api-path-slug"=>"v3shorten-get", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"until we have model"}, {"in"=>"query", "name"=>"format", "description"=>"json, xml, txt"}, {"in"=>"query", "name"=>"longUrl", "description"=>"a long URL to be shortened (example: http://betaworks"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shorten"]}}, "/v3/user/link_edit"=>{"get"=>{"summary"=>"Get User Link Edit", "description"=>"Get user link edit.", "operationId"=>"getV3UserLinkEdit", "x-api-path-slug"=>"v3userlink-edit-get", "parameters"=>[{"in"=>"query", "name"=>"archived", "description"=>"indicating whether or not link is to be archived"}, {"in"=>"query", "name"=>"clear_deeplinks", "description"=>"indicating that all deeplinks should be removed form the bitlink"}, {"in"=>"query", "name"=>"deeplinks", "description"=>"urlencoded json array of deeplink items"}, {"in"=>"query", "name"=>"edit", "description"=>"a comma separated string of fields to be edited"}, {"in"=>"query", "name"=>"link", "description"=>"Successful response"}, {"in"=>"query", "name"=>"note", "description"=>"a description of, or note about, this Bitlink"}, {"in"=>"query", "name"=>"private", "description"=>"boolean true or false indicating privacy setting (defaults to user-level setting)"}, {"in"=>"query", "name"=>"title", "description"=>"the title of this Bitlink"}, {"in"=>"query", "name"=>"user_ts", "description"=>"timestamp as an integer epoch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Link", "Edit"]}}, "/v3/user/link_lookup"=>{"get"=>{"summary"=>"Get User Link Lookup", "description"=>"Get user link lookup.", "operationId"=>"getV3UserLinkLookup", "x-api-path-slug"=>"v3userlink-lookup-get", "parameters"=>[{"in"=>"query", "name"=>"link", "description"=>"one or more Bitlinks to lookup"}, {"in"=>"query", "name"=>"url", "description"=>"one or more long URLs to lookup"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Link", "Lookup"]}}, "/v3/user/link_save"=>{"get"=>{"summary"=>"Get User Link Save", "description"=>"Get user link save.", "operationId"=>"getV3UserLinkSave", "x-api-path-slug"=>"v3userlink-save-get", "parameters"=>[{"in"=>"query", "name"=>"deeplinks", "description"=>"urlencoded json array of deeplink items"}, {"in"=>"query", "name"=>"domain", "description"=>"the short domain to use; either bit"}, {"in"=>"query", "name"=>"longUrl", "description"=>"the URL to be saved as a Bitlink"}, {"in"=>"query", "name"=>"note", "description"=>"a description of, or note about, this Bitlink"}, {"in"=>"query", "name"=>"private", "description"=>"indicating privacy setting (defaults to user-level setting)"}, {"in"=>"query", "name"=>"title", "description"=>"the title of this Bitlink"}, {"in"=>"query", "name"=>"user_ts", "description"=>"timestamp as an integer epoch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Link", "Save"]}}, "/v3/user/save_custom_domain_keyword"=>{"get"=>{"summary"=>"Get User Save Custom Domain Keyword", "description"=>"Get user save custom domain keyword.", "operationId"=>"getV3UserSaveCustomDomainKeyword", "x-api-path-slug"=>"v3usersave-custom-domain-keyword-get", "parameters"=>[{"in"=>"query", "name"=>"keyword_link", "description"=>"the Custom Bitlink (short domain and keyword combination) to set"}, {"in"=>"query", "name"=>"overwrite", "description"=>"Ovewrite existing entry if one exists"}, {"in"=>"query", "name"=>"target_link", "description"=>"the Bitlink the specified keyword will map to (as returned from /v3/shorten)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Save", "Custom", "Domain", "Keyword"]}}}}, "bitly-domains-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bitly", "x-complete"=>1, "info"=>{"title"=>"Bitly", "description"=>"shorten-share-and-track-your-links-with-the-bitly-apis-", "version"=>"1.0.0"}, "host"=>"api-ssl.bitly.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v3/shorten"=>{"get"=>{"summary"=>"Get Shorten", "description"=>"Given a long URL, returns a bitly short URL.", "operationId"=>"Get_shorten_", "x-api-path-slug"=>"v3shorten-get", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"(optional) refers to a preferred domain; either bit"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"longUrl", "description"=>"a long URL to be shortened (example: http://betaworks"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shorten"]}}, "/v3/expand"=>{"get"=>{"summary"=>"Get Expand", "description"=>"Given a bitly URL or hash (or multiple), returns the target (long) URL.", "operationId"=>"Get_expand_", "x-api-path-slug"=>"v3expand-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"hash", "description"=>"Refers to one or more bitly hashes"}, {"in"=>"query", "name"=>"shortUrl", "description"=>"Short URL to be expanded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Expand"]}}, "/v3/link/lookup"=>{"get"=>{"summary"=>"Get Link Lookup", "description"=>"This is used to query for a bitly link based on a long URL.", "operationId"=>"Get_lookup_", "x-api-path-slug"=>"v3linklookup-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"url", "description"=>"One or more long URLs to lookup"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Lookup"]}}, "/v3/info"=>{"get"=>{"summary"=>"Get Info", "description"=>"This is used to return the page title for a given bitly link.", "operationId"=>"Get_info_", "x-api-path-slug"=>"v3info-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"hash", "description"=>"Refers to one or more bitly hashes"}, {"in"=>"query", "name"=>"shortUrl", "description"=>"Refers to one or more short URLs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Info"]}}, "/v3/user/info"=>{"get"=>{"summary"=>"Get User Info", "description"=>"Return information about a user.", "operationId"=>"Get_user_info_", "x-api-path-slug"=>"v3userinfo-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"login", "description"=>"(optional) the bitly login of the user whose info to look up"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Info"]}}, "/v3/user/link_history"=>{"get"=>{"summary"=>"Get User Link History", "description"=>"Returns entries from a user's link history in reverse chronological order.", "operationId"=>"Get_user_link_history_", "x-api-path-slug"=>"v3userlink-history-get", "parameters"=>[{"in"=>"query", "name"=>"created_after", "description"=>"(optional) timestamp as an integer unix epoch"}, {"in"=>"query", "name"=>"created_before", "description"=>"(optional) timestamp as an integer unix epoch"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"limit", "description"=>"(optional) integer in the range 1 to 100 - default: 50, specifying the max number of results to return"}, {"in"=>"query", "name"=>"user", "description"=>"(optional) the user for whom to retrieve history entries (if different from authenticated user)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Link", "History"]}}, "/v3/user/popular_links"=>{"get"=>{"summary"=>"Get User Popular Links", "description"=>"Returns the authenticated user's most-clicked bitly links (ordered by number of clicks) in a given time period.", "operationId"=>"Get_user_popular_links_", "x-api-path-slug"=>"v3userpopular-links-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"limit", "description"=>"(optional) 1 to 1000 (default=100)"}, {"in"=>"query", "name"=>"rollup", "description"=>"(optional) true or false"}, {"in"=>"query", "name"=>"timezone", "description"=>"(optional) an integer hour offset from UTC (-14 to 14)"}, {"in"=>"query", "name"=>"unit", "description"=>"minute, hour, day, week or month"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Popular", "Links"]}}, "/v3/link/clicks"=>{"get"=>{"summary"=>"Get Link Clicks", "description"=>"Returns entries from a user's link history in reverse chronological order.", "operationId"=>"Get_link_clicks_", "x-api-path-slug"=>"v3linkclicks-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"limit", "description"=>"(optional) 1 to 1000 (default=100)"}, {"in"=>"query", "name"=>"link", "description"=>"a bltly link"}, {"in"=>"query", "name"=>"rollup", "description"=>"(optional) true or false"}, {"in"=>"query", "name"=>"timezone", "description"=>"(optional) an integer hour offset from UTC (-14 to 14)"}, {"in"=>"query", "name"=>"unit", "description"=>"minute, hour, day, week or month"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Clicks"]}}, "/v3/link/countries"=>{"get"=>{"summary"=>"Get Link Countries", "description"=>"Returns metrics about the countries referring click traffic to a single bitly link.", "operationId"=>"Get_link_countries_", "x-api-path-slug"=>"v3linkcountries-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"limit", "description"=>"(optional) 1 to 1000 (default=100)"}, {"in"=>"query", "name"=>"link", "description"=>"a bltly link"}, {"in"=>"query", "name"=>"rollup", "description"=>"(optional) true or false"}, {"in"=>"query", "name"=>"timezone", "description"=>"(optional) an integer hour offset from UTC (-14 to 14)"}, {"in"=>"query", "name"=>"unit", "description"=>"minute, hour, day, week or month"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Countries"]}}, "/v3/link/referrers"=>{"get"=>{"summary"=>"Get Link Referrers", "description"=>"Returns metrics about the pages referring click traffic to a single bitly link.", "operationId"=>"Get_link_referrers_", "x-api-path-slug"=>"v3linkreferrers-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"limit", "description"=>"(optional) 1 to 1000 (default=100)"}, {"in"=>"query", "name"=>"link", "description"=>"a bltly link"}, {"in"=>"query", "name"=>"rollup", "description"=>"(optional) true or false"}, {"in"=>"query", "name"=>"timezone", "description"=>"(optional) an integer hour offset from UTC (-14 to 14)"}, {"in"=>"query", "name"=>"unit", "description"=>"minute, hour, day, week or month"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Referrers"]}}, "/v3/link/shares"=>{"get"=>{"summary"=>"Get Link Shares", "description"=>"Returns metrics about a shares of a single link.", "operationId"=>"Get_link_shares_", "x-api-path-slug"=>"v3linkshares-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"limit", "description"=>"(optional) 1 to 1000 (default=100)"}, {"in"=>"query", "name"=>"link", "description"=>"a bltly link"}, {"in"=>"query", "name"=>"rollup", "description"=>"(optional) true or false"}, {"in"=>"query", "name"=>"timezone", "description"=>"(optional) an integer hour offset from UTC (-14 to 14)"}, {"in"=>"query", "name"=>"unit", "description"=>"minute, hour, day, week or month"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Shares"]}}, "/v3/search"=>{"get"=>{"summary"=>"Get Search", "description"=>"Search links receiving clicks across bitly by content, language, location, and more.", "operationId"=>"Get_realtime_search_", "x-api-path-slug"=>"v3search-get", "parameters"=>[{"in"=>"query", "name"=>"cities", "description"=>"(optional) show links active in this city (ordered like country-state-city, e"}, {"in"=>"query", "name"=>"domain", "description"=>"(optional) restrict results to this web domain"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"lang", "description"=>"(optional) favor results in this language (two letter ISO code)"}, {"in"=>"query", "name"=>"limit", "description"=>"(optional) the maximum number of links to return"}, {"in"=>"query", "name"=>"offset", "description"=>"(optional) which result to start with (defaults to 0)"}, {"in"=>"query", "name"=>"query", "description"=>"string to query for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}, "/v3/realtime/bursting_phrases"=>{"get"=>{"summary"=>"Get Realtime Bursting Phrases", "description"=>"Returns phrases that are receiving an uncharacteristically high volume of click traffic, and the individual links (hashes) driving traffic to pages containing these phrases.", "operationId"=>"Get_realtime_bursting_phrases_", "x-api-path-slug"=>"v3realtimebursting-phrases-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Realtime", "Bursting", "Phrases"]}}, "/v3/realtime/hot_phrases"=>{"get"=>{"summary"=>"Get Realtime Hot Phrases", "description"=>"Returns phrases that are receiving a consistently high volume of click traffic, and the individual links (hashes) driving traffic to pages containing these phrases.", "operationId"=>"Get_realtime_hot_phrases_", "x-api-path-slug"=>"v3realtimehot-phrases-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Realtime", "Hot", "Phrases"]}}}}, "apis"=>{"name"=>"Bitly", "x-slug"=>"bitly", "description"=>"Get the most out of your social and online marketing efforts. Own, understand and activate your best audience through the power of the link with Bitly Enterprise.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1503-bitly.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"737", "tags"=>"API Provider,Library,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology,Universities,University In Progress,University Library", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bitly/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Bitly Domains API", "x-api-slug"=>"bitly-domains-api", "description"=>"Get the most out of your social and online marketing efforts. Own, understand and activate your best audience through the power of the link with Bitly Enterprise.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1503-bitly.jpg", "humanURL"=>"http://bitly.com", "baseURL"=>"https://api-ssl.bitly.com//", "tags"=>"API Provider,Library,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology,Universities,University In Progress,University Library", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bitly/v3realtimehot-phrases-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bitly/bitly-domains-api-openapi.yaml"}]}, {"name"=>"Bitly Link API", "x-api-slug"=>"bitly-link-api", "description"=>"Get the most out of your social and online marketing efforts. Own, understand and activate your best audience through the power of the link with Bitly Enterprise.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1503-bitly.jpg", "humanURL"=>"http://bitly.com", "baseURL"=>"https://api-ssl.bitly.com//v3", "tags"=>"Realtime,Hot,Phrases", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bitly/v3usersave-custom-domain-keyword-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bitly/bitly-link-api-openapi.yaml"}]}, {"name"=>"Bitly Link Metrics API", "x-api-slug"=>"bitly-link-metrics-api", "description"=>"Get the most out of your social and online marketing efforts. Own, understand and activate your best audience through the power of the link with Bitly Enterprise.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1503-bitly.jpg", "humanURL"=>"http://bitly.com", "baseURL"=>"https://api-ssl.bitly.com//v3", "tags"=>"User,Save,Custom,Domain,Keyword", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bitly/linkreferrers-by-domain-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bitly/bitly-link-metrics-api-openapi.yaml"}]}, {"name"=>"Bitly Organization Metric API", "x-api-slug"=>"bitly-organization-metric-api", "description"=>"Get the most out of your social and online marketing efforts. Own, understand and activate your best audience through the power of the link with Bitly Enterprise.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1503-bitly.jpg", "humanURL"=>"http://bitly.com", "baseURL"=>"https://api-ssl.bitly.com//v3", "tags"=>"Link,Referrers,By,Domain", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bitly/v3organizationshorten-counts-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bitly/bitly-organization-metric-api-openapi.yaml"}]}, {"name"=>"Bitly User API", "x-api-slug"=>"bitly-user-api", "description"=>"Get the most out of your social and online marketing efforts. Own, understand and activate your best audience through the power of the link with Bitly Enterprise.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1503-bitly.jpg", "humanURL"=>"http://bitly.com", "baseURL"=>"https://api-ssl.bitly.com//v3", "tags"=>"Organization,Shorten,Counts", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bitly/v3usertracking-domain-list-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bitly/bitly-user-api-openapi.yaml"}]}, {"name"=>"Bitly User Metrics API", "x-api-slug"=>"bitly-user-metrics-api", "description"=>"Get the most out of your social and online marketing efforts. Own, understand and activate your best audience through the power of the link with Bitly Enterprise.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1503-bitly.jpg", "humanURL"=>"http://bitly.com", "baseURL"=>"https://api-ssl.bitly.com//v3", "tags"=>"User,Tracking,Domain,List", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bitly/v3usershorten-counts-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bitly/bitly-user-metrics-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x--net-library", "url"=>"http://code.google.com/p/bitly-dot-net"}, {"type"=>"x-application-management", "url"=>"http://dev.bitly.com/my_apps.html"}, {"type"=>"x-base", "url"=>"http://api.bitly.com"}, {"type"=>"x-best-practices", "url"=>"http://dev.bitly.com/best_practices.html"}, {"type"=>"x-blog", "url"=>"http://word.bitly.com/"}, {"type"=>"x-blog-rss", "url"=>"http://word.bitly.com/rss"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/bit-ly"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/hootsuite"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/bitly"}, {"type"=>"x-developer", "url"=>"http://data.info.yorku.ca/"}, {"type"=>"x-email", "url"=>"media@hootsuite.com"}, {"type"=>"x-email", "url"=>"legal@hootsuite.com"}, {"type"=>"x-email", "url"=>"privacy@hootsuite.com"}, {"type"=>"x-email", "url"=>"hootsuite-dpa@hootsuite.com"}, {"type"=>"x-email", "url"=>"security@hootsuite.com"}, {"type"=>"x-email", "url"=>"app.directory@hootsuite.com"}, {"type"=>"x-email", "url"=>"apis@hootsuite.com"}, {"type"=>"x-email", "url"=>"partnersupport@hootsuite.com"}, {"type"=>"x-email", "url"=>"partners@bitly.com"}, {"type"=>"x-email", "url"=>"press@bitly.com"}, {"type"=>"x-email", "url"=>"office@bitly.com"}, {"type"=>"x-email", "url"=>"support@bitly.com"}, {"type"=>"x-email", "url"=>"api@bitly.com"}, {"type"=>"x-forum", "url"=>"http://dev.bitly.com/api_discussion_group.html"}, {"type"=>"x-github", "url"=>"https://github.com/bitly"}, {"type"=>"x-java-library", "url"=>"https://github.com/stackmagic/bitly-api-client"}, {"type"=>"x-javascript-library", "url"=>"https://npmjs.org/package/node-bitlyapi"}, {"type"=>"x-partners", "url"=>"https://bitly.com/pages/partners"}, {"type"=>"x-php-library", "url"=>"http://github.com/Falicon/BitlyPHP"}, {"type"=>"x-privacy", "url"=>"https://bitly.com/pages/privacy"}, {"type"=>"x-python-library", "url"=>"http://github.com/bitly/bitly-api-python"}, {"type"=>"x-ruby-library", "url"=>"http://github.com/nas/url_shortener"}, {"type"=>"x-sdks-io", "url"=>"https://sdks.io/SDK/View/bitly-13"}, {"type"=>"x-support", "url"=>"http://support.bitly.com/"}, {"type"=>"x-temboo-pdk", "url"=>"https://live.temboo.com/library/Library/Bitly/"}, {"type"=>"x-terms-of-service", "url"=>"https://bitly.com/pages/terms-of-service"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Bitly"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/hootsuite"}, {"type"=>"x-website", "url"=>"http://bitly.com"}, {"type"=>"x-website", "url"=>"http://dev.bitly.com/data_apis.html"}, {"type"=>"x-website", "url"=>"http://bit.ly/1j56kms"}, {"type"=>"x-website", "url"=>"http://hootsuite.com"}, {"type"=>"x-website", "url"=>"http://bit.ly"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "bitly-organization-metric-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bitly", "x-complete"=>1, "info"=>{"title"=>"Bitly Organization Metric API", "description"=>"the-bitly-organization-metric-api", "termsOfService"=>"http://dev.bitly.com/best_practices.html", "version"=>"v3"}, "host"=>"api-ssl.bitly.com", "basePath"=>"/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v3/organization/brand_messages"=>{"get"=>{"summary"=>"Organization Brand Messages", "description"=>"Returns the top Bitlinks created by you with traffic, that did not also have non-organization traffic in the same time period, ordered by clicks.", "operationId"=>"organizationBrandMessages", "x-api-path-slug"=>"v3organizationbrand-messages-get", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"a tracking or e2e domain for this organization"}, {"in"=>"query", "name"=>"limit", "description"=>"1"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14"}, {"in"=>"query", "name"=>"unit", "description"=>"hour | day | week | month default:day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization", "Brand", "Messages"]}}, "/v3/organization/clicks"=>{"get"=>{"summary"=>"Organization Clicks", "description"=>"Returns the number of clicks on Bitlinks created by your organization or by other Bitly users that point to your domains.", "operationId"=>"organizationClicks", "x-api-path-slug"=>"v3organizationclicks-get", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"filter to a tracking or e2e domain for this organization"}, {"in"=>"query", "name"=>"limit", "description"=>"1"}, {"in"=>"query", "name"=>"login", "description"=>"an account in this organization"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14"}, {"in"=>"query", "name"=>"unit", "description"=>"hour | day | week | month default:day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization", "Clicks"]}}, "/v3/organization/intersecting_links"=>{"get"=>{"summary"=>"Organization Intersecting Links", "description"=>"Returns the top links shared by both your audience and by your account, ordered by clicks.", "operationId"=>"organizationIntersectingLinks", "x-api-path-slug"=>"v3organizationintersecting-links-get", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"a tracking or e2e domain for this organization"}, {"in"=>"query", "name"=>"limit", "description"=>"1"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14"}, {"in"=>"query", "name"=>"unit", "description"=>"hour | day | week | month default:day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization", "Intersecting", "Links"]}}, "/v3/organization/leaderboard"=>{"get"=>{"summary"=>"Organization Leaderboard", "description"=>"Returns the top-performing organization members ordered by clicks or shortens.", "operationId"=>"organizationLeaderBoard", "x-api-path-slug"=>"v3organizationleaderboard-get", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"a tracking or e2e domain for this organization"}, {"in"=>"query", "name"=>"limit", "description"=>"1"}, {"in"=>"query", "name"=>"orderby", "description"=>"either clicks or shortens"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14"}, {"in"=>"query", "name"=>"unit", "description"=>"hour | day | week | month default:day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization", "Leaderboard"]}}, "/v3/organization/missed_opportunities"=>{"get"=>{"summary"=>"Organization Missed Opportunities", "description"=>"Returns the top links shared by your audience, but not by you, ordered by clicks.", "operationId"=>"organizationMissedOpportunities", "x-api-path-slug"=>"v3organizationmissed-opportunities-get", "parameters"=>[{"in"=>"query", "name"=>"an epoch timestamp, indicating the most recent time for which to pull metrics. default:now", "description"=>"hour | day | week | month default:day"}, {"in"=>"query", "name"=>"domain", "description"=>"a tracking or e2e domain for this organization"}, {"in"=>"query", "name"=>"limit", "description"=>"1"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14"}, {"in"=>"query", "name"=>"unit", "description"=>"hour | day | week | month default:day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization", "Missed", "Opportunities"]}}, "/v3/organization/popular_links"=>{"get"=>{"summary"=>"Organization Popular Links", "description"=>"Returns the top links shared by you or your audience, ordered by clicks", "operationId"=>"organizationPopularLinks", "x-api-path-slug"=>"v3organizationpopular-links-get", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"a tracking or e2e domain for this organization"}, {"in"=>"query", "name"=>"limit", "description"=>"1"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14"}, {"in"=>"query", "name"=>"unit", "description"=>"hour | day | week | month default:day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization", "Popular", "Links"]}}, "/v3/organization/shorten_counts"=>{"get"=>{"summary"=>"Organization Shorten Counts", "description"=>"Returns the number of Bitlinks created by your organization or by other Bitly users that point to your domains.", "operationId"=>"organizationShortenCounts", "x-api-path-slug"=>"v3organizationshorten-counts-get", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"filter to a tracking or e2e domain for this organization"}, {"in"=>"query", "name"=>"limit", "description"=>"1"}, {"in"=>"query", "name"=>"login", "description"=>"an account in this organization"}, {"in"=>"query", "name"=>"timezone", "description"=>"an integer hour offset from UTC (-14"}, {"in"=>"query", "name"=>"unit", "description"=>"hour | day | week | month default:day"}, {"in"=>"query", "name"=>"units", "description"=>"an integer representing the time units to query data for"}, {"in"=>"query", "name"=>"unit_reference_ts", "description"=>"an epoch timestamp, indicating the most recent time for which to pull metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization", "Shorten", "Counts"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-virtual-network{"azure-virtual-network-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Virtual Network", "x-complete"=>1, "info"=>{"title"=>"NetworkManagementClient", "description"=>"the-microsoft-azure-network-management-api-provides-a-restful-set-of-web-services-that-interact-with-microsoft-azure-networks-service-to-manage-your-network-resources--the-api-has-entities-that-capture-the-relationship-between-an-end-user-and-the-microsoft-azure-networks-service-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}"=>{"delete"=>{"summary"=>"Application Gateways Delete", "description"=>"Deletes the specified application gateway.", "operationId"=>"ApplicationGateways_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkapplicationgatewaysapplicationgatewayname-delete", "parameters"=>[{"in"=>"path", "name"=>"applicationGatewayName", "description"=>"The name of the application gateway"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Gateways"]}, "get"=>{"summary"=>"Application Gateways Get", "description"=>"Gets the specified application gateway.", "operationId"=>"ApplicationGateways_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkapplicationgatewaysapplicationgatewayname-get", "parameters"=>[{"in"=>"path", "name"=>"applicationGatewayName", "description"=>"The name of the application gateway"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Gateways"]}, "put"=>{"summary"=>"Application Gateways Create Or Update", "description"=>"Creates or updates the specified application gateway.", "operationId"=>"ApplicationGateways_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkapplicationgatewaysapplicationgatewayname-put", "parameters"=>[{"in"=>"path", "name"=>"applicationGatewayName", "description"=>"The name of the application gateway"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the create or update application gateway operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Gateways"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways"=>{"get"=>{"summary"=>"Application Gateways List", "description"=>"Lists all application gateways in a resource group.", "operationId"=>"ApplicationGateways_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkapplicationgateways-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Gateways"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGateways"=>{"get"=>{"summary"=>"Application Gateways List All", "description"=>"Gets all the application gateways in a subscription.", "operationId"=>"ApplicationGateways_ListAll", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networkapplicationgateways-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Gateways"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/start"=>{"post"=>{"summary"=>"Application Gateways Start", "description"=>"Starts the specified application gateway.", "operationId"=>"ApplicationGateways_Start", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkapplicationgatewaysapplicationgatewaynamestart-post", "parameters"=>[{"in"=>"path", "name"=>"applicationGatewayName", "description"=>"The name of the application gateway"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Gateways"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/stop"=>{"post"=>{"summary"=>"Application Gateways Stop", "description"=>"Stops the specified application gateway in a resource group.", "operationId"=>"ApplicationGateways_Stop", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkapplicationgatewaysapplicationgatewaynamestop-post", "parameters"=>[{"in"=>"path", "name"=>"applicationGatewayName", "description"=>"The name of the application gateway"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Gateways"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendhealth"=>{"post"=>{"summary"=>"Application Gateways Backend Health", "description"=>"Gets the backend health of the specified application gateway in a resource group.", "operationId"=>"ApplicationGateways_BackendHealth", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkapplicationgatewaysapplicationgatewaynamebackendhealth-post", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Expands BackendAddressPool and BackendHttpSettings referenced in backend health"}, {"in"=>"path", "name"=>"applicationGatewayName", "description"=>"The name of the application gateway"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Gateways"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableWafRuleSets"=>{"get"=>{"summary"=>"Application Gateways List Available Waf Rule Sets", "description"=>"Lists all available web application firewall rule sets.", "operationId"=>"ApplicationGateways_ListAvailableWafRuleSets", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networkapplicationgatewayavailablewafrulesets-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Gateways"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/CheckDnsNameAvailability"=>{"get"=>{"summary"=>"Check Dns Name Availability", "description"=>"Checks whether a domain name in the cloudapp.net zone is available for use.", "operationId"=>"CheckDnsNameAvailability", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networklocationslocationcheckdnsnameavailability-get", "parameters"=>[{"in"=>"query", "name"=>"domainNameLabel", "description"=>"The domain name to be verified"}, {"in"=>"path", "name"=>"location", "description"=>"The location of the domain name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dns Name Availability"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations/{authorizationName}"=>{"delete"=>{"summary"=>"Express Route Circuit Authorizations Delete", "description"=>"Deletes the specified authorization from the specified express route circuit.", "operationId"=>"ExpressRouteCircuitAuthorizations_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuitscircuitnameauthorizationsauthorizationname-delete", "parameters"=>[{"in"=>"path", "name"=>"authorizationName", "description"=>"The name of the authorization"}, {"in"=>"path", "name"=>"circuitName", "description"=>"The name of the express route circuit"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuit Authorizations"]}, "get"=>{"summary"=>"Express Route Circuit Authorizations Get", "description"=>"Gets the specified authorization from the specified express route circuit.", "operationId"=>"ExpressRouteCircuitAuthorizations_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuitscircuitnameauthorizationsauthorizationname-get", "parameters"=>[{"in"=>"path", "name"=>"authorizationName", "description"=>"The name of the authorization"}, {"in"=>"path", "name"=>"circuitName", "description"=>"The name of the express route circuit"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuit Authorizations"]}, "put"=>{"summary"=>"Express Route Circuit Authorizations Create Or Update", "description"=>"Creates or updates an authorization in the specified express route circuit.", "operationId"=>"ExpressRouteCircuitAuthorizations_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuitscircuitnameauthorizationsauthorizationname-put", "parameters"=>[{"in"=>"path", "name"=>"authorizationName", "description"=>"The name of the authorization"}, {"in"=>"body", "name"=>"authorizationParameters", "description"=>"Parameters supplied to the create or update express route circuit authorization operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"circuitName", "description"=>"The name of the express route circuit"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuit Authorizations"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations"=>{"get"=>{"summary"=>"Express Route Circuit Authorizations List", "description"=>"Gets all authorizations in an express route circuit.", "operationId"=>"ExpressRouteCircuitAuthorizations_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuitscircuitnameauthorizations-get", "parameters"=>[{"in"=>"path", "name"=>"circuitName", "description"=>"The name of the circuit"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuit Authorizations"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}"=>{"delete"=>{"summary"=>"Express Route Circuit Peerings Delete", "description"=>"Deletes the specified peering from the specified express route circuit.", "operationId"=>"ExpressRouteCircuitPeerings_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuitscircuitnamepeeringspeeringname-delete", "parameters"=>[{"in"=>"path", "name"=>"circuitName", "description"=>"The name of the express route circuit"}, {"in"=>"path", "name"=>"peeringName", "description"=>"The name of the peering"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuit Peerings"]}, "get"=>{"summary"=>"Express Route Circuit Peerings Get", "description"=>"Gets the specified authorization from the specified express route circuit.", "operationId"=>"ExpressRouteCircuitPeerings_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuitscircuitnamepeeringspeeringname-get", "parameters"=>[{"in"=>"path", "name"=>"circuitName", "description"=>"The name of the express route circuit"}, {"in"=>"path", "name"=>"peeringName", "description"=>"The name of the peering"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuit Peerings"]}, "put"=>{"summary"=>"Express Route Circuit Peerings Create Or Update", "description"=>"Creates or updates a peering in the specified express route circuits.", "operationId"=>"ExpressRouteCircuitPeerings_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuitscircuitnamepeeringspeeringname-put", "parameters"=>[{"in"=>"path", "name"=>"circuitName", "description"=>"The name of the express route circuit"}, {"in"=>"path", "name"=>"peeringName", "description"=>"The name of the peering"}, {"in"=>"body", "name"=>"peeringParameters", "description"=>"Parameters supplied to the create or update express route circuit peering operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuit Peerings"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings"=>{"get"=>{"summary"=>"Express Route Circuit Peerings List", "description"=>"Gets all peerings in a specified express route circuit.", "operationId"=>"ExpressRouteCircuitPeerings_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuitscircuitnamepeerings-get", "parameters"=>[{"in"=>"path", "name"=>"circuitName", "description"=>"The name of the express route circuit"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuit Peerings"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}"=>{"delete"=>{"summary"=>"Express Route Circuits Delete", "description"=>"Deletes the specified express route circuit.", "operationId"=>"ExpressRouteCircuits_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuitscircuitname-delete", "parameters"=>[{"in"=>"path", "name"=>"circuitName", "description"=>"The name of the express route circuit"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuits"]}, "get"=>{"summary"=>"Express Route Circuits Get", "description"=>"Gets information about the specified express route circuit.", "operationId"=>"ExpressRouteCircuits_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuitscircuitname-get", "parameters"=>[{"in"=>"path", "name"=>"circuitName", "description"=>"The name of express route circuit"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuits"]}, "put"=>{"summary"=>"Express Route Circuits Create Or Update", "description"=>"Creates or updates an express route circuit.", "operationId"=>"ExpressRouteCircuits_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuitscircuitname-put", "parameters"=>[{"in"=>"path", "name"=>"circuitName", "description"=>"The name of the circuit"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the create or update express route circuit operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuits"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/arpTables/{devicePath}"=>{"post"=>{"summary"=>"Express Route Circuits List Arp Table", "description"=>"Gets the currently advertised ARP table associated with the express route circuit in a resource group.", "operationId"=>"ExpressRouteCircuits_ListArpTable", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuitscircuitnamepeeringspeeringnamearptablesdevicepath-post", "parameters"=>[{"in"=>"path", "name"=>"circuitName", "description"=>"The name of the express route circuit"}, {"in"=>"path", "name"=>"devicePath", "description"=>"The path of the device"}, {"in"=>"path", "name"=>"peeringName", "description"=>"The name of the peering"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuits"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTables/{devicePath}"=>{"post"=>{"summary"=>"Express Route Circuits List Routes Table", "description"=>"Gets the currently advertised routes table associated with the express route circuit in a resource group.", "operationId"=>"ExpressRouteCircuits_ListRoutesTable", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuitscircuitnamepeeringspeeringnameroutetablesdevicepath-post", "parameters"=>[{"in"=>"path", "name"=>"circuitName", "description"=>"The name of the express route circuit"}, {"in"=>"path", "name"=>"devicePath", "description"=>"The path of the device"}, {"in"=>"path", "name"=>"peeringName", "description"=>"The name of the peering"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuits"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTablesSummary/{devicePath}"=>{"post"=>{"summary"=>"Express Route Circuits List Routes Table Summary", "description"=>"Gets the currently advertised routes table summary associated with the express route circuit in a resource group.", "operationId"=>"ExpressRouteCircuits_ListRoutesTableSummary", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuitscircuitnamepeeringspeeringnameroutetablessummarydevicepath-post", "parameters"=>[{"in"=>"path", "name"=>"circuitName", "description"=>"The name of the express route circuit"}, {"in"=>"path", "name"=>"devicePath", "description"=>"The path of the device"}, {"in"=>"path", "name"=>"peeringName", "description"=>"The name of the peering"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuits"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/stats"=>{"get"=>{"summary"=>"Express Route Circuits Get Stats", "description"=>"Gets all the stats from an express route circuit in a resource group.", "operationId"=>"ExpressRouteCircuits_GetStats", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuitscircuitnamestats-get", "parameters"=>[{"in"=>"path", "name"=>"circuitName", "description"=>"The name of the express route circuit"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuits"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/stats"=>{"get"=>{"summary"=>"Express Route Circuits Get Peering Stats", "description"=>"Gets all stats from an express route circuit in a resource group.", "operationId"=>"ExpressRouteCircuits_GetPeeringStats", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuitscircuitnamepeeringspeeringnamestats-get", "parameters"=>[{"in"=>"path", "name"=>"circuitName", "description"=>"The name of the express route circuit"}, {"in"=>"path", "name"=>"peeringName", "description"=>"The name of the peering"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuits"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits"=>{"get"=>{"summary"=>"Express Route Circuits List", "description"=>"Gets all the express route circuits in a resource group.", "operationId"=>"ExpressRouteCircuits_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkexpressroutecircuits-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuits"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCircuits"=>{"get"=>{"summary"=>"Express Route Circuits List All", "description"=>"Gets all the express route circuits in a subscription.", "operationId"=>"ExpressRouteCircuits_ListAll", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networkexpressroutecircuits-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Circuits"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteServiceProviders"=>{"get"=>{"summary"=>"Express Route Service Providers List", "description"=>"Gets all the available express route service providers.", "operationId"=>"ExpressRouteServiceProviders_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networkexpressrouteserviceproviders-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Express Route Service Providers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}"=>{"delete"=>{"summary"=>"Load Balancers Delete", "description"=>"Deletes the specified load balancer.", "operationId"=>"LoadBalancers_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkloadbalancersloadbalancername-delete", "parameters"=>[{"in"=>"path", "name"=>"loadBalancerName", "description"=>"The name of the load balancer"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load Balancers"]}, "get"=>{"summary"=>"Load Balancers Get", "description"=>"Gets the specified load balancer.", "operationId"=>"LoadBalancers_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkloadbalancersloadbalancername-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Expands referenced resources"}, {"in"=>"path", "name"=>"loadBalancerName", "description"=>"The name of the load balancer"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load Balancers"]}, "put"=>{"summary"=>"Load Balancers Create Or Update", "description"=>"Creates or updates a load balancer.", "operationId"=>"LoadBalancers_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkloadbalancersloadbalancername-put", "parameters"=>[{"in"=>"path", "name"=>"loadBalancerName", "description"=>"The name of the load balancer"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the create or update load balancer operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load Balancers"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/loadBalancers"=>{"get"=>{"summary"=>"Load Balancers List All", "description"=>"Gets all the load balancers in a subscription.", "operationId"=>"LoadBalancers_ListAll", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networkloadbalancers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load Balancers All"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers"=>{"get"=>{"summary"=>"Load Balancers List", "description"=>"Gets all the load balancers in a resource group.", "operationId"=>"LoadBalancers_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkloadbalancers-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load Balancers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}"=>{"delete"=>{"summary"=>"Network Interfaces Delete", "description"=>"Deletes the specified network interface.", "operationId"=>"NetworkInterfaces_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkinterfacesnetworkinterfacename-delete", "parameters"=>[{"in"=>"path", "name"=>"networkInterfaceName", "description"=>"The name of the network interface"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interfaces"]}, "get"=>{"summary"=>"Network Interfaces Get", "description"=>"Gets information about the specified network interface.", "operationId"=>"NetworkInterfaces_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkinterfacesnetworkinterfacename-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Expands referenced resources"}, {"in"=>"path", "name"=>"networkInterfaceName", "description"=>"The name of the network interface"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interfaces"]}, "put"=>{"summary"=>"Network Interfaces Create Or Update", "description"=>"Creates or updates a network interface.", "operationId"=>"NetworkInterfaces_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkinterfacesnetworkinterfacename-put", "parameters"=>[{"in"=>"path", "name"=>"networkInterfaceName", "description"=>"The name of the network interface"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the create or update network interface operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interfaces"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkInterfaces"=>{"get"=>{"summary"=>"Network Interfaces List All", "description"=>"Gets all network interfaces in a subscription.", "operationId"=>"NetworkInterfaces_ListAll", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networknetworkinterfaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interfaces"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces"=>{"get"=>{"summary"=>"Network Interfaces List", "description"=>"Gets all network interfaces in a resource group.", "operationId"=>"NetworkInterfaces_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkinterfaces-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interfaces"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/effectiveRouteTable"=>{"post"=>{"summary"=>"Network Interfaces Get Effective Route Table", "description"=>"Gets all route tables applied to a network interface.", "operationId"=>"NetworkInterfaces_GetEffectiveRouteTable", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkinterfacesnetworkinterfacenameeffectiveroutetable-post", "parameters"=>[{"in"=>"path", "name"=>"networkInterfaceName", "description"=>"The name of the network interface"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interfaces"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/effectiveNetworkSecurityGroups"=>{"post"=>{"summary"=>"Network Interfaces List Effective Network Security Groups", "description"=>"Gets all network security groups applied to a network interface.", "operationId"=>"NetworkInterfaces_ListEffectiveNetworkSecurityGroups", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkinterfacesnetworkinterfacenameeffectivenetworksecuritygroups-post", "parameters"=>[{"in"=>"path", "name"=>"networkInterfaceName", "description"=>"The name of the network interface"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interfaces"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}"=>{"delete"=>{"summary"=>"Network Security Groups Delete", "description"=>"Deletes the specified network security group.", "operationId"=>"NetworkSecurityGroups_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworksecuritygroupsnetworksecuritygroupname-delete", "parameters"=>[{"in"=>"path", "name"=>"networkSecurityGroupName", "description"=>"The name of the network security group"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Security Groups"]}, "get"=>{"summary"=>"Network Security Groups Get", "description"=>"Gets the specified network security group.", "operationId"=>"NetworkSecurityGroups_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworksecuritygroupsnetworksecuritygroupname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Expands referenced resources"}, {"in"=>"path", "name"=>"networkSecurityGroupName", "description"=>"The name of the network security group"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Security Groups"]}, "put"=>{"summary"=>"Network Security Groups Create Or Update", "description"=>"Creates or updates a network security group in the specified resource group.", "operationId"=>"NetworkSecurityGroups_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworksecuritygroupsnetworksecuritygroupname-put", "parameters"=>[{"in"=>"path", "name"=>"networkSecurityGroupName", "description"=>"The name of the network security group"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the create or update network security group operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Security Groups"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkSecurityGroups"=>{"get"=>{"summary"=>"Network Security Groups List All", "description"=>"Gets all network security groups in a subscription.", "operationId"=>"NetworkSecurityGroups_ListAll", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networknetworksecuritygroups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Security Groups"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups"=>{"get"=>{"summary"=>"Network Security Groups List", "description"=>"Gets all network security groups in a resource group.", "operationId"=>"NetworkSecurityGroups_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworksecuritygroups-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Security Groups"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}"=>{"delete"=>{"summary"=>"Security Rules Delete", "description"=>"Deletes the specified network security rule.", "operationId"=>"SecurityRules_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworksecuritygroupsnetworksecuritygroupnamesecurityrulessecurityrulename-delete", "parameters"=>[{"in"=>"path", "name"=>"networkSecurityGroupName", "description"=>"The name of the network security group"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"securityRuleName", "description"=>"The name of the security rule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Rules"]}, "get"=>{"summary"=>"Security Rules Get", "description"=>"Get the specified network security rule.", "operationId"=>"SecurityRules_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworksecuritygroupsnetworksecuritygroupnamesecurityrulessecurityrulename-get", "parameters"=>[{"in"=>"path", "name"=>"networkSecurityGroupName", "description"=>"The name of the network security group"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"securityRuleName", "description"=>"The name of the security rule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Rules"]}, "put"=>{"summary"=>"Security Rules Create Or Update", "description"=>"Creates or updates a security rule in the specified network security group.", "operationId"=>"SecurityRules_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworksecuritygroupsnetworksecuritygroupnamesecurityrulessecurityrulename-put", "parameters"=>[{"in"=>"path", "name"=>"networkSecurityGroupName", "description"=>"The name of the network security group"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"securityRuleName", "description"=>"The name of the security rule"}, {"in"=>"body", "name"=>"securityRuleParameters", "description"=>"Parameters supplied to the create or update network security rule operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Rules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules"=>{"get"=>{"summary"=>"Security Rules List", "description"=>"Gets all security rules in a network security group.", "operationId"=>"SecurityRules_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworksecuritygroupsnetworksecuritygroupnamesecurityrules-get", "parameters"=>[{"in"=>"path", "name"=>"networkSecurityGroupName", "description"=>"The name of the network security group"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Rules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}"=>{"put"=>{"summary"=>"Network Watchers Create Or Update", "description"=>"Creates or updates a network watcher in the specified resource group.", "operationId"=>"NetworkWatchers_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchername-put", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the network watcher"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters that define the network watcher resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Watchers"]}, "get"=>{"summary"=>"Network Watchers Get", "description"=>"Gets the specified network watcher by resource group.", "operationId"=>"NetworkWatchers_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchername-get", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the network watcher"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Watchers"]}, "delete"=>{"summary"=>"Network Watchers Delete", "description"=>"Deletes the specified network watcher resource.", "operationId"=>"NetworkWatchers_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchername-delete", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the network watcher"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Watchers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers"=>{"get"=>{"summary"=>"Network Watchers List", "description"=>"Gets all network watchers by resource group.", "operationId"=>"NetworkWatchers_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchers-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Watchers"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkWatchers"=>{"get"=>{"summary"=>"Network Watchers List All", "description"=>"Gets all network watchers by subscription.", "operationId"=>"NetworkWatchers_ListAll", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networknetworkwatchers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Watchers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/topology"=>{"post"=>{"summary"=>"Network Watchers Get Topology", "description"=>"Gets the current network topology by resource group.", "operationId"=>"NetworkWatchers_GetTopology", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchernametopology-post", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the network watcher"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters that define the representation of topology", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Watchers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/ipFlowVerify"=>{"post"=>{"summary"=>"Network Watchers Verify IPFlow", "description"=>"Verify IP flow from the specified VM to a location given the currently configured NSG rules.", "operationId"=>"NetworkWatchers_VerifyIPFlow", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchernameipflowverify-post", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the network watcher"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters that define the IP flow to be verified", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Watchers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/nextHop"=>{"post"=>{"summary"=>"Network Watchers Get Next Hop", "description"=>"Gets the next hop from the specified VM.", "operationId"=>"NetworkWatchers_GetNextHop", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchernamenexthop-post", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the network watcher"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters that define the source and destination endpoint", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Watchers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/securityGroupView"=>{"post"=>{"summary"=>"Network Watchers Get VMSecurity Rules", "description"=>"Gets the configured and effective security group rules on the specified VM.", "operationId"=>"NetworkWatchers_GetVMSecurityRules", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchernamesecuritygroupview-post", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the network watcher"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters that define the VM to check security groups for", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Watchers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}"=>{"put"=>{"summary"=>"Packet Captures Create", "description"=>"Create and start a packet capture on the specified VM.", "operationId"=>"PacketCaptures_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchernamepacketcapturespacketcapturename-put", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the network watcher"}, {"in"=>"path", "name"=>"packetCaptureName", "description"=>"The name of the packet capture session"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters that define the create packet capture operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Packet Captures"]}, "get"=>{"summary"=>"Packet Captures Get", "description"=>"Gets a packet capture session by name.", "operationId"=>"PacketCaptures_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchernamepacketcapturespacketcapturename-get", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the network watcher"}, {"in"=>"path", "name"=>"packetCaptureName", "description"=>"The name of the packet capture session"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Packet Captures"]}, "delete"=>{"summary"=>"Packet Captures Delete", "description"=>"Deletes the specified packet capture session.", "operationId"=>"PacketCaptures_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchernamepacketcapturespacketcapturename-delete", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the network watcher"}, {"in"=>"path", "name"=>"packetCaptureName", "description"=>"The name of the packet capture session"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Packet Captures"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/stop"=>{"post"=>{"summary"=>"Packet Captures Stop", "description"=>"Stops a specified packet capture session.", "operationId"=>"PacketCaptures_Stop", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchernamepacketcapturespacketcapturenamestop-post", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the network watcher"}, {"in"=>"path", "name"=>"packetCaptureName", "description"=>"The name of the packet capture session"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Packet Captures"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/queryStatus"=>{"post"=>{"summary"=>"Packet Captures Get Status", "description"=>"Query the status of a running packet capture session.", "operationId"=>"PacketCaptures_GetStatus", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchernamepacketcapturespacketcapturenamequerystatus-post", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the Network Watcher resource"}, {"in"=>"path", "name"=>"packetCaptureName", "description"=>"The name given to the packet capture session"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Packet Captures"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures"=>{"get"=>{"summary"=>"Packet Captures List", "description"=>"Lists all packet capture sessions within the specified resource group.", "operationId"=>"PacketCaptures_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchernamepacketcaptures-get", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the Network Watcher resource"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Packet Captures"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/troubleshoot"=>{"post"=>{"summary"=>"Network Watchers Get Troubleshooting", "description"=>"Initiate troubleshooting on a specified resource", "operationId"=>"NetworkWatchers_GetTroubleshooting", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchernametroubleshoot-post", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the network watcher resource"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters that define the resource to troubleshoot", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Watchers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryTroubleshootResult"=>{"post"=>{"summary"=>"Network Watchers Get Troubleshooting Result", "description"=>"Get the last completed troubleshooting result on a specified resource", "operationId"=>"NetworkWatchers_GetTroubleshootingResult", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchernamequerytroubleshootresult-post", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the network watcher resource"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters that define the resource to query the troubleshooting result", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Watchers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/configureFlowLog"=>{"post"=>{"summary"=>"Network Watchers Set Flow Log Configuration", "description"=>"Configures flow log on a specified resource.", "operationId"=>"NetworkWatchers_SetFlowLogConfiguration", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchernameconfigureflowlog-post", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the network watcher resource"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters that define the configuration of flow log", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the network watcher resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Watchers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryFlowLogStatus"=>{"post"=>{"summary"=>"Network Watchers Get Flow Log Status", "description"=>"Queries status of flow log on a specified resource.", "operationId"=>"NetworkWatchers_GetFlowLogStatus", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networknetworkwatchersnetworkwatchernamequeryflowlogstatus-post", "parameters"=>[{"in"=>"path", "name"=>"networkWatcherName", "description"=>"The name of the network watcher resource"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters that define a resource to query flow log status", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the network watcher resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Watchers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}"=>{"delete"=>{"summary"=>"Public IPAddresses Delete", "description"=>"Deletes the specified public IP address.", "operationId"=>"PublicIPAddresses_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkpublicipaddressespublicipaddressname-delete", "parameters"=>[{"in"=>"path", "name"=>"publicIpAddressName", "description"=>"The name of the subnet"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Public IP Address"]}, "get"=>{"summary"=>"Public IPAddresses Get", "description"=>"Gets the specified public IP address in a specified resource group.", "operationId"=>"PublicIPAddresses_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkpublicipaddressespublicipaddressname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Expands referenced resources"}, {"in"=>"path", "name"=>"publicIpAddressName", "description"=>"The name of the subnet"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Public IP Address"]}, "put"=>{"summary"=>"Public IPAddresses Create Or Update", "description"=>"Creates or updates a static or dynamic public IP address.", "operationId"=>"PublicIPAddresses_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkpublicipaddressespublicipaddressname-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the create or update public IP address operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"publicIpAddressName", "description"=>"The name of the public IP address"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Public IP Address"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPAddresses"=>{"get"=>{"summary"=>"Public IPAddresses List All", "description"=>"Gets all the public IP addresses in a subscription.", "operationId"=>"PublicIPAddresses_ListAll", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networkpublicipaddresses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Public IP Address"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses"=>{"get"=>{"summary"=>"Public IPAddresses List", "description"=>"Gets all public IP addresses in a resource group.", "operationId"=>"PublicIPAddresses_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkpublicipaddresses-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Public IP Address"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}"=>{"delete"=>{"summary"=>"Route Filters Delete", "description"=>"Deletes the specified route filter.", "operationId"=>"RouteFilters_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutefiltersroutefiltername-delete", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"routeFilterName", "description"=>"The name of the route filter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Filters"]}, "get"=>{"summary"=>"Route Filters Get", "description"=>"Gets the specified route filter.", "operationId"=>"RouteFilters_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutefiltersroutefiltername-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Expands referenced express route bgp peering resources"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"routeFilterName", "description"=>"The name of the route filter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Filters"]}, "put"=>{"summary"=>"Route Filters Create Or Update", "description"=>"Creates or updates a route filter in a specified resource group.", "operationId"=>"RouteFilters_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutefiltersroutefiltername-put", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"routeFilterName", "description"=>"The name of the route filter"}, {"in"=>"body", "name"=>"routeFilterParameters", "description"=>"Parameters supplied to the create or update route filter operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Filters"]}, "patch"=>{"summary"=>"Route Filters Update", "description"=>"Updates a route filter in a specified resource group.", "operationId"=>"RouteFilters_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutefiltersroutefiltername-patch", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"routeFilterName", "description"=>"The name of the route filter"}, {"in"=>"body", "name"=>"routeFilterParameters", "description"=>"Parameters supplied to the update route filter operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Filters"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters"=>{"get"=>{"summary"=>"Route Filters List By Resource Group", "description"=>"Gets all route filters in a resource group.", "operationId"=>"RouteFilters_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutefilters-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Filters"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeFilters"=>{"get"=>{"summary"=>"Route Filters List", "description"=>"Gets all route filters in a subscription.", "operationId"=>"RouteFilters_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networkroutefilters-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Filters"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}"=>{"delete"=>{"summary"=>"Route Filter Rules Delete", "description"=>"Deletes the specified rule from a route filter.", "operationId"=>"RouteFilterRules_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutefiltersroutefilternameroutefilterrulesrulename-delete", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"routeFilterName", "description"=>"The name of the route filter"}, {"in"=>"path", "name"=>"ruleName", "description"=>"The name of the rule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Filter Rules"]}, "get"=>{"summary"=>"Route Filter Rules Get", "description"=>"Gets the specified rule from a route filter.", "operationId"=>"RouteFilterRules_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutefiltersroutefilternameroutefilterrulesrulename-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"routeFilterName", "description"=>"The name of the route filter"}, {"in"=>"path", "name"=>"ruleName", "description"=>"The name of the rule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Filter Rules"]}, "put"=>{"summary"=>"Route Filter Rules Create Or Update", "description"=>"Creates or updates a route in the specified route filter.", "operationId"=>"RouteFilterRules_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutefiltersroutefilternameroutefilterrulesrulename-put", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"routeFilterName", "description"=>"The name of the route filter"}, {"in"=>"body", "name"=>"routeFilterRuleParameters", "description"=>"Parameters supplied to the create or update route filter rule operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"ruleName", "description"=>"The name of the route filter rule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Filter Rules"]}, "patch"=>{"summary"=>"Route Filter Rules Update", "description"=>"Updates a route in the specified route filter.", "operationId"=>"RouteFilterRules_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutefiltersroutefilternameroutefilterrulesrulename-patch", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"routeFilterName", "description"=>"The name of the route filter"}, {"in"=>"body", "name"=>"routeFilterRuleParameters", "description"=>"Parameters supplied to the update route filter rule operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"ruleName", "description"=>"The name of the route filter rule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Filter Rules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules"=>{"get"=>{"summary"=>"Route Filter Rules List By Route Filter", "description"=>"Gets all RouteFilterRules in a route filter.", "operationId"=>"RouteFilterRules_ListByRouteFilter", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutefiltersroutefilternameroutefilterrules-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"routeFilterName", "description"=>"The name of the route filter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Filter Rules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}"=>{"delete"=>{"summary"=>"Route Tables Delete", "description"=>"Deletes the specified route table.", "operationId"=>"RouteTables_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutetablesroutetablename-delete", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"routeTableName", "description"=>"The name of the route table"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Tables"]}, "get"=>{"summary"=>"Route Tables Get", "description"=>"Gets the specified route table.", "operationId"=>"RouteTables_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutetablesroutetablename-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Expands referenced resources"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"routeTableName", "description"=>"The name of the route table"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Tables"]}, "put"=>{"summary"=>"Route Tables Create Or Update", "description"=>"Create or updates a route table in a specified resource group.", "operationId"=>"RouteTables_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutetablesroutetablename-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the create or update route table operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"routeTableName", "description"=>"The name of the route table"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Tables"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables"=>{"get"=>{"summary"=>"Route Tables List", "description"=>"Gets all route tables in a resource group.", "operationId"=>"RouteTables_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutetables-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Tables"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeTables"=>{"get"=>{"summary"=>"Route Tables List All", "description"=>"Gets all route tables in a subscription.", "operationId"=>"RouteTables_ListAll", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networkroutetables-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Tables"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}"=>{"delete"=>{"summary"=>"Routes Delete", "description"=>"Deletes the specified route from a route table.", "operationId"=>"Routes_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutetablesroutetablenameroutesroutename-delete", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"routeName", "description"=>"The name of the route"}, {"in"=>"path", "name"=>"routeTableName", "description"=>"The name of the route table"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Routes"]}, "get"=>{"summary"=>"Routes Get", "description"=>"Gets the specified route from a route table.", "operationId"=>"Routes_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutetablesroutetablenameroutesroutename-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"routeName", "description"=>"The name of the route"}, {"in"=>"path", "name"=>"routeTableName", "description"=>"The name of the route table"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Routes"]}, "put"=>{"summary"=>"Routes Create Or Update", "description"=>"Creates or updates a route in the specified route table.", "operationId"=>"Routes_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutetablesroutetablenameroutesroutename-put", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"routeName", "description"=>"The name of the route"}, {"in"=>"body", "name"=>"routeParameters", "description"=>"Parameters supplied to the create or update route operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"routeTableName", "description"=>"The name of the route table"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Routes"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes"=>{"get"=>{"summary"=>"Routes List", "description"=>"Gets all routes in a route table.", "operationId"=>"Routes_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkroutetablesroutetablenameroutes-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"routeTableName", "description"=>"The name of the route table"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Routes"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/bgpServiceCommunities"=>{"get"=>{"summary"=>"Bgp Service Communities List", "description"=>"Gets all the available bgp service communities.", "operationId"=>"BgpServiceCommunities_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networkbgpservicecommunities-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bgp Service Communities"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/usages"=>{"get"=>{"summary"=>"Usages List", "description"=>"Lists compute usages for a subscription.", "operationId"=>"Usages_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networklocationslocationusages-get", "parameters"=>[{"in"=>"path", "name"=>"location", "description"=>"The location where resource usage is queried"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Usages"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}"=>{"delete"=>{"summary"=>"Virtual Networks Delete", "description"=>"Deletes the specified virtual network.", "operationId"=>"VirtualNetworks_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworksvirtualnetworkname-delete", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkName", "description"=>"The name of the virtual network"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Networks"]}, "get"=>{"summary"=>"Virtual Networks Get", "description"=>"Gets the specified virtual network by resource group.", "operationId"=>"VirtualNetworks_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworksvirtualnetworkname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Expands referenced resources"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkName", "description"=>"The name of the virtual network"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Networks"]}, "put"=>{"summary"=>"Virtual Networks Create Or Update", "description"=>"Creates or updates a virtual network in the specified resource group.", "operationId"=>"VirtualNetworks_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworksvirtualnetworkname-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the create or update virtual network operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkName", "description"=>"The name of the virtual network"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Networks"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworks"=>{"get"=>{"summary"=>"Virtual Networks List All", "description"=>"Gets all virtual networks in a subscription.", "operationId"=>"VirtualNetworks_ListAll", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networkvirtualnetworks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Networks"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks"=>{"get"=>{"summary"=>"Virtual Networks List", "description"=>"Gets all virtual networks in a resource group.", "operationId"=>"VirtualNetworks_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworks-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Networks"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"=>{"delete"=>{"summary"=>"Subnets Delete", "description"=>"Deletes the specified subnet.", "operationId"=>"Subnets_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworksvirtualnetworknamesubnetssubnetname-delete", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"subnetName", "description"=>"The name of the subnet"}, {"in"=>"path", "name"=>"virtualNetworkName", "description"=>"The name of the virtual network"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnets"]}, "get"=>{"summary"=>"Subnets Get", "description"=>"Gets the specified subnet by virtual network and resource group.", "operationId"=>"Subnets_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworksvirtualnetworknamesubnetssubnetname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Expands referenced resources"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"subnetName", "description"=>"The name of the subnet"}, {"in"=>"path", "name"=>"virtualNetworkName", "description"=>"The name of the virtual network"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnets"]}, "put"=>{"summary"=>"Subnets Create Or Update", "description"=>"Creates or updates a subnet in the specified virtual network.", "operationId"=>"Subnets_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworksvirtualnetworknamesubnetssubnetname-put", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"subnetName", "description"=>"The name of the subnet"}, {"in"=>"body", "name"=>"subnetParameters", "description"=>"Parameters supplied to the create or update subnet operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"virtualNetworkName", "description"=>"The name of the virtual network"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnets"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets"=>{"get"=>{"summary"=>"Subnets List", "description"=>"Gets all subnets in a virtual network.", "operationId"=>"Subnets_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworksvirtualnetworknamesubnets-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkName", "description"=>"The name of the virtual network"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnets"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}"=>{"delete"=>{"summary"=>"Virtual Network Peerings Delete", "description"=>"Deletes the specified virtual network peering.", "operationId"=>"VirtualNetworkPeerings_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworksvirtualnetworknamevirtualnetworkpeeringsvirtualnetworkpeeringname-delete", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkName", "description"=>"The name of the virtual network"}, {"in"=>"path", "name"=>"virtualNetworkPeeringName", "description"=>"The name of the virtual network peering"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Peerings"]}, "get"=>{"summary"=>"Virtual Network Peerings Get", "description"=>"Gets the specified virtual network peering.", "operationId"=>"VirtualNetworkPeerings_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworksvirtualnetworknamevirtualnetworkpeeringsvirtualnetworkpeeringname-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkName", "description"=>"The name of the virtual network"}, {"in"=>"path", "name"=>"virtualNetworkPeeringName", "description"=>"The name of the virtual network peering"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Peerings"]}, "put"=>{"summary"=>"Virtual Network Peerings Create Or Update", "description"=>"Creates or updates a peering in the specified virtual network.", "operationId"=>"VirtualNetworkPeerings_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworksvirtualnetworknamevirtualnetworkpeeringsvirtualnetworkpeeringname-put", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkName", "description"=>"The name of the virtual network"}, {"in"=>"path", "name"=>"virtualNetworkPeeringName", "description"=>"The name of the peering"}, {"in"=>"body", "name"=>"VirtualNetworkPeeringParameters", "description"=>"Parameters supplied to the create or update virtual network peering operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Peerings"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings"=>{"get"=>{"summary"=>"Virtual Network Peerings List", "description"=>"Gets all virtual network peerings in a virtual network.", "operationId"=>"VirtualNetworkPeerings_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworksvirtualnetworknamevirtualnetworkpeerings-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkName", "description"=>"The name of the virtual network"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Peerings"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/CheckIPAddressAvailability"=>{"get"=>{"summary"=>"Virtual Networks Check IPAddress Availability", "description"=>"Checks whether a private IP address is available for use.", "operationId"=>"VirtualNetworks_CheckIPAddressAvailability", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworksvirtualnetworknamecheckipaddressavailability-get", "parameters"=>[{"in"=>"query", "name"=>"ipAddress", "description"=>"The private IP address to be verified"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkName", "description"=>"The name of the virtual network"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Networks"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}"=>{"put"=>{"summary"=>"Virtual Network Gateways Create Or Update", "description"=>"Creates or updates a virtual network gateway in the specified resource group.", "operationId"=>"VirtualNetworkGateways_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworkgatewaysvirtualnetworkgatewayname-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to create or update virtual network gateway operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkGatewayName", "description"=>"The name of the virtual network gateway"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Gateways"]}, "get"=>{"summary"=>"Virtual Network Gateways Get", "description"=>"Gets the specified virtual network gateway by resource group.", "operationId"=>"VirtualNetworkGateways_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworkgatewaysvirtualnetworkgatewayname-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkGatewayName", "description"=>"The name of the virtual network gateway"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Gateways"]}, "delete"=>{"summary"=>"Virtual Network Gateways Delete", "description"=>"Deletes the specified virtual network gateway.", "operationId"=>"VirtualNetworkGateways_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworkgatewaysvirtualnetworkgatewayname-delete", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkGatewayName", "description"=>"The name of the virtual network gateway"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Gateways"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways"=>{"get"=>{"summary"=>"Virtual Network Gateways List", "description"=>"Gets all virtual network gateways by resource group.", "operationId"=>"VirtualNetworkGateways_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworkgateways-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Gateways"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/reset"=>{"post"=>{"summary"=>"Virtual Network Gateways Reset", "description"=>"Resets the primary of the virtual network gateway in the specified resource group.", "operationId"=>"VirtualNetworkGateways_Reset", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworkgatewaysvirtualnetworkgatewaynamereset-post", "parameters"=>[{"in"=>"query", "name"=>"gatewayVip", "description"=>"Virtual network gateway vip address supplied to the begin reset of the active-active feature enabled gateway"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkGatewayName", "description"=>"The name of the virtual network gateway"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Gateways"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnclientpackage"=>{"post"=>{"summary"=>"Virtual Network Gateways Generatevpnclientpackage", "description"=>"Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.", "operationId"=>"VirtualNetworkGateways_Generatevpnclientpackage", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworkgatewaysvirtualnetworkgatewaynamegeneratevpnclientpackage-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the generate virtual network gateway VPN client package operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkGatewayName", "description"=>"The name of the virtual network gateway"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Gateways"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getBgpPeerStatus"=>{"post"=>{"summary"=>"Virtual Network Gateways Get Bgp Peer Status", "description"=>"The GetBgpPeerStatus operation retrieves the status of all BGP peers.", "operationId"=>"VirtualNetworkGateways_GetBgpPeerStatus", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworkgatewaysvirtualnetworkgatewaynamegetbgppeerstatus-post", "parameters"=>[{"in"=>"query", "name"=>"peer", "description"=>"The IP address of the peer to retrieve the status of"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkGatewayName", "description"=>"The name of the virtual network gateway"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Gateways"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getLearnedRoutes"=>{"post"=>{"summary"=>"Virtual Network Gateways Get Learned Routes", "description"=>"This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.", "operationId"=>"VirtualNetworkGateways_GetLearnedRoutes", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworkgatewaysvirtualnetworkgatewaynamegetlearnedroutes-post", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkGatewayName", "description"=>"The name of the virtual network gateway"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Gateways"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getAdvertisedRoutes"=>{"post"=>{"summary"=>"Virtual Network Gateways Get Advertised Routes", "description"=>"This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.", "operationId"=>"VirtualNetworkGateways_GetAdvertisedRoutes", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkvirtualnetworkgatewaysvirtualnetworkgatewaynamegetadvertisedroutes-post", "parameters"=>[{"in"=>"query", "name"=>"peer", "description"=>"The IP address of the peer"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkGatewayName", "description"=>"The name of the virtual network gateway"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Gateways"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}"=>{"put"=>{"summary"=>"Virtual Network Gateway Connections Create Or Update", "description"=>"Creates or updates a virtual network gateway connection in the specified resource group.", "operationId"=>"VirtualNetworkGatewayConnections_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkconnectionsvirtualnetworkgatewayconnectionname-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the create or update virtual network gateway connection operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkGatewayConnectionName", "description"=>"The name of the virtual network gateway connection"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Gateway Connections"]}, "get"=>{"summary"=>"Virtual Network Gateway Connections Get", "description"=>"Gets the specified virtual network gateway connection by resource group.", "operationId"=>"VirtualNetworkGatewayConnections_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkconnectionsvirtualnetworkgatewayconnectionname-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkGatewayConnectionName", "description"=>"The name of the virtual network gateway connection"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Gateway Connections"]}, "delete"=>{"summary"=>"Virtual Network Gateway Connections Delete", "description"=>"Deletes the specified virtual network Gateway connection.", "operationId"=>"VirtualNetworkGatewayConnections_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkconnectionsvirtualnetworkgatewayconnectionname-delete", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkGatewayConnectionName", "description"=>"The name of the virtual network gateway connection"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Gateway Connections"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey"=>{"put"=>{"summary"=>"Virtual Network Gateway Connections Set Shared Key", "description"=>"The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.", "operationId"=>"VirtualNetworkGatewayConnections_SetSharedKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkconnectionsvirtualnetworkgatewayconnectionnamesharedkey-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkGatewayConnectionName", "description"=>"The virtual network gateway connection name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Gateway Connections"]}, "get"=>{"summary"=>"Virtual Network Gateway Connections Get Shared Key", "description"=>"The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.", "operationId"=>"VirtualNetworkGatewayConnections_GetSharedKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkconnectionsvirtualnetworkgatewayconnectionnamesharedkey-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkGatewayConnectionName", "description"=>"The virtual network gateway connection shared key name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Gateway Connections"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections"=>{"get"=>{"summary"=>"Virtual Network Gateway Connections List", "description"=>"The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.", "operationId"=>"VirtualNetworkGatewayConnections_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkconnections-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Gateway Connections"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey/reset"=>{"post"=>{"summary"=>"Virtual Network Gateway Connections Reset Shared Key", "description"=>"The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.", "operationId"=>"VirtualNetworkGatewayConnections_ResetSharedKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkconnectionsvirtualnetworkgatewayconnectionnamesharedkeyreset-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualNetworkGatewayConnectionName", "description"=>"The virtual network gateway connection reset shared key Name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Network Gateway Connections"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}"=>{"put"=>{"summary"=>"Local Network Gateways Create Or Update", "description"=>"Creates or updates a local network gateway in the specified resource group.", "operationId"=>"LocalNetworkGateways_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networklocalnetworkgatewayslocalnetworkgatewayname-put", "parameters"=>[{"in"=>"path", "name"=>"localNetworkGatewayName", "description"=>"The name of the local network gateway"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the create or update local network gateway operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Local Network Gateways"]}, "get"=>{"summary"=>"Local Network Gateways Get", "description"=>"Gets the specified local network gateway in a resource group.", "operationId"=>"LocalNetworkGateways_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networklocalnetworkgatewayslocalnetworkgatewayname-get", "parameters"=>[{"in"=>"path", "name"=>"localNetworkGatewayName", "description"=>"The name of the local network gateway"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Local Network Gateways"]}, "delete"=>{"summary"=>"Local Network Gateways Delete", "description"=>"Deletes the specified local network gateway.", "operationId"=>"LocalNetworkGateways_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networklocalnetworkgatewayslocalnetworkgatewayname-delete", "parameters"=>[{"in"=>"path", "name"=>"localNetworkGatewayName", "description"=>"The name of the local network gateway"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Local Network Gateways"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways"=>{"get"=>{"summary"=>"Local Network Gateways List", "description"=>"Gets all the local network gateways in a resource group.", "operationId"=>"LocalNetworkGateways_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networklocalnetworkgateways-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Local Network Gateways"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces"=>{"get"=>{"summary"=>"Network Interfaces List Virtual Machine Scale Set VMNetwork Interfaces", "description"=>"Gets information about all network interfaces in a virtual machine in a virtual machine scale set.", "operationId"=>"NetworkInterfaces_ListVirtualMachineScaleSetVMNetworkInterfaces", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-computevirtualmachinescalesetsvirtualmachinescalesetnamevirtualmachinesvirtualmachineindexnetworkinterfaces-get", "parameters"=>[{"in"=>"query", "name"=>"api-version", "description"=>"Client API version"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualmachineIndex", "description"=>"The virtual machine index"}, {"in"=>"path", "name"=>"virtualMachineScaleSetName", "description"=>"The name of the virtual machine scale set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interfaces"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/networkInterfaces"=>{"get"=>{"summary"=>"Network Interfaces List Virtual Machine Scale Set Network Interfaces", "description"=>"Gets all network interfaces in a virtual machine scale set.", "operationId"=>"NetworkInterfaces_ListVirtualMachineScaleSetNetworkInterfaces", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-computevirtualmachinescalesetsvirtualmachinescalesetnamenetworkinterfaces-get", "parameters"=>[{"in"=>"query", "name"=>"api-version", "description"=>"Client API version"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualMachineScaleSetName", "description"=>"The name of the virtual machine scale set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interfaces"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}"=>{"get"=>{"summary"=>"Network Interfaces Get Virtual Machine Scale Set Network Interface", "description"=>"Get the specified network interface in a virtual machine scale set.", "operationId"=>"NetworkInterfaces_GetVirtualMachineScaleSetNetworkInterface", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-computevirtualmachinescalesetsvirtualmachinescalesetnamevirtualmachinesvirtualmachineindexnetworkinterfacesnetworkinterfacename-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Expands referenced resources"}, {"in"=>"query", "name"=>"api-version", "description"=>"Client API version"}, {"in"=>"path", "name"=>"networkInterfaceName", "description"=>"The name of the network interface"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"virtualmachineIndex", "description"=>"The virtual machine index"}, {"in"=>"path", "name"=>"virtualMachineScaleSetName", "description"=>"The name of the virtual machine scale set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interfaces"]}}}}, "apis"=>{"name"=>"Azure Virtual Network", "x-slug"=>"azure-virtual-network", "description"=>"Azure Virtual Network lets you create private networks in the cloud with full control over IP addresses, DNS servers, security rules, and traffic flows. Securely connect a virtual network to on-premises networks by using a VPN tunnel, or connect privately by using the ExpressRoute service.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-network-topology.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Microsoft,Networks,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-virtual-network/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Virtual Network API", "x-api-slug"=>"azure-virtual-network-api", "description"=>"Azure Virtual Network lets you create private networks in the cloud with full control over IP addresses, DNS servers, security rules, and traffic flows. Securely connect a virtual network to on-premises networks by using a VPN tunnel, or connect privately by using the ExpressRoute service.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-network-topology.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/virtual-network/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Microsoft,Networks,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-virtual-network/subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-computevirtualmachinescalesetsvirtualmachinescalesetnamevirtualmachinesvirtualmachineindexnetworkinterfacesnetworkinterfacename-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-virtual-network/azure-virtual-network-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/virtual-network/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/virtual-network/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/virtual-network/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
yapily{"yapily-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Yapily", "x-complete"=>1, "info"=>{"title"=>"Yapily API", "description"=>"to-access-endpoints-that-require-authentication-use-your-application-key-and-secret-created-in-the-dashboard-httpsdashboard-yapily-com", "version"=>"1.0.0"}, "host"=>"api.yapily.com:443", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/accounts"=>{"get"=>{"summary"=>"Get accounts", "description"=>"Get accounts.", "operationId"=>"getAccountsUsingGET", "x-api-path-slug"=>"accounts-get", "parameters"=>[{"in"=>"header", "name"=>"consent", "description"=>"Consent Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/accounts/{accountId}"=>{"get"=>{"summary"=>"Get account", "description"=>"Get account.", "operationId"=>"getAccountUsingGET", "x-api-path-slug"=>"accountsaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"accountId"}, {"in"=>"header", "name"=>"consent", "description"=>"Consent Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/accounts/{accountId}/transactions"=>{"get"=>{"summary"=>"Get account transactions", "description"=>"Get account transactions.", "operationId"=>"getTransactionsUsingGET", "x-api-path-slug"=>"accountsaccountidtransactions-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"accountId"}, {"in"=>"header", "name"=>"consent", "description"=>"Consent Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Transactions"]}}, "/identity"=>{"get"=>{"summary"=>"Get identity", "description"=>"Get identity.", "operationId"=>"identityUsingGET", "x-api-path-slug"=>"identity-get", "parameters"=>[{"in"=>"header", "name"=>"consent", "description"=>"Consent Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/institutions"=>{"get"=>{"summary"=>"Retrieves the list of institutions available in Yapily", "description"=>"Retrieves the list of institutions available in yapily.", "operationId"=>"getInstitutionsUsingGET", "x-api-path-slug"=>"institutions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieves", "List", "Institutions", "Available", "In", "Yapily"]}}, "/institutions/{institutionId}"=>{"get"=>{"summary"=>"Retrieves details of a specific institution available in Yapily", "description"=>"Retrieves details of a specific institution available in yapily.", "operationId"=>"getInstitutionUsingGET", "x-api-path-slug"=>"institutionsinstitutionid-get", "parameters"=>[{"in"=>"path", "name"=>"institutionId", "description"=>"institutionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieves", "Details", "Specific", "Institution", "Available", "In", "Yapily"]}}, "/institutions/{institutionId}/personal-current-accounts"=>{"get"=>{"summary"=>"Retrieves details of personal current accounts for an institution", "description"=>"Retrieves details of personal current accounts for an institution.", "operationId"=>"getPersonalCurrentAccountsUsingGET", "x-api-path-slug"=>"institutionsinstitutionidpersonalcurrentaccounts-get", "parameters"=>[{"in"=>"path", "name"=>"institutionId", "description"=>"institutionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieves", "Details", "Personal", "Current", "Accountsan", "Institution"]}}, "/me"=>{"get"=>{"summary"=>"Returns the details of the application which owns the request credentials", "description"=>"Returns the details of the application which owns the request credentials.", "operationId"=>"getApplicationMeUsingGET", "x-api-path-slug"=>"me-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Details", "Application", "Which", "Owns", "Request", "Credentials"]}}, "/users"=>{"get"=>{"summary"=>"Get application users", "description"=>"Get application users.", "operationId"=>"getUsersUsingGET", "x-api-path-slug"=>"users-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Users"]}, "post"=>{"summary"=>"Add an application user", "description"=>"Add an application user.", "operationId"=>"addUserUsingPOST", "x-api-path-slug"=>"users-post", "parameters"=>[{"in"=>"body", "name"=>"applicationUser", "description"=>"applicationUser", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "User"]}}, "/users/{userUuid}/consents"=>{"get"=>{"summary"=>"Get consent", "description"=>"Get consent.", "operationId"=>"getUserConsentsUsingGET", "x-api-path-slug"=>"usersuseruuidconsents-get", "parameters"=>[{"in"=>"query", "name"=>"institutionId", "description"=>"institutionId"}, {"in"=>"path", "name"=>"userUuid", "description"=>"userUuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Consent"]}, "post"=>{"summary"=>"Post consent", "description"=>"Post consent.", "operationId"=>"addConsentUsingPOST", "x-api-path-slug"=>"usersuseruuidconsents-post", "parameters"=>[{"in"=>"body", "name"=>"createConsentApiKey", "description"=>"createConsentApiKey", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userUuid", "description"=>"userUuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Consent"]}}, "/users/{userUuid}/consents/{consentToken}"=>{"delete"=>{"summary"=>"Delete consent", "description"=>"Delete consent.", "operationId"=>"deleteUsingDELETE", "x-api-path-slug"=>"usersuseruuidconsentsconsenttoken-delete", "parameters"=>[{"in"=>"path", "name"=>"consentToken", "description"=>"consentToken"}, {"in"=>"path", "name"=>"userUuid", "description"=>"userUuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Consent"]}}, "/users/{uuid}"=>{"get"=>{"summary"=>"Get an application user", "description"=>"Get an application user.", "operationId"=>"getUserUsingGET", "x-api-path-slug"=>"usersuuid-get", "parameters"=>[{"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "User"]}, "put"=>{"summary"=>"Update an application user", "description"=>"Update an application user.", "operationId"=>"updateUserUsingPUT", "x-api-path-slug"=>"usersuuid-put", "parameters"=>[{"in"=>"body", "name"=>"applicationUser", "description"=>"applicationUser", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "User"]}}}}, "apis"=>{"name"=>"Yapily", "x-slug"=>"yapily", "description"=>"Yapily is how people connect to banks, easily! We are an API Only technology provider whose mission is to enable innovative products to connect to banks, empowering a new generation of financial services.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/yapily-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"7167103", "tags"=>"Banking,Financial,New,OpenAPI,Postman,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"yapily/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Yapily", "x-api-slug"=>"yapily", "description"=>"Yapily is how people connect to banks, easily! We are an API Only technology provider whose mission is to enable innovative products to connect to banks, empowering a new generation of financial services.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/yapily-logo.png", "humanURL"=>"https://www.yapily.com", "baseURL"=>"https://api.yapily.com:443//", "tags"=>"Banking,Financial,New,OpenAPI,Postman,Relative Data,Service API", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/yapily/yapily-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://doc.yapily.com/#api-authentication"}, {"type"=>"x-documentation", "url"=>"https://doc.yapily.com/"}, {"type"=>"x-email", "url"=>"hello@yapily.com"}, {"type"=>"x-email", "url"=>"developers@yapily.com"}, {"type"=>"x-email", "url"=>"info@yapily.com"}, {"type"=>"x-getting-started", "url"=>"https://doc.yapily.com/#get-started"}, {"type"=>"x-github", "url"=>"https://github.com/yapily"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/YapilyLtd"}, {"type"=>"x-website", "url"=>"https://www.yapily.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-safe-browsing{"google-safe-browsing-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Safe Browsing", "x-complete"=>1, "info"=>{"title"=>"Google Safe Browsing", "description"=>"the-safe-browsing-api-is-an-experimental-api-that-allows-client-applications-to-check-urls-against-googles-constantlyupdated-blacklists-of-suspected-phishing-and-malware-pages--your-client-application-can-use-the-api-to-download-an-encrypted-table-for-local-clientside-lookups-of-urls-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v4"}, "host"=>"safebrowsing.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v4/encodedFullHashes/{encodedRequest}"=>{"get"=>{"summary"=>"Encode Full Hashes", "description"=>"Encode Full Hashes", "operationId"=>"safebrowsing.encodedFullHashes.get", "x-api-path-slug"=>"v4encodedfullhashesencodedrequest-get", "parameters"=>[{"in"=>"query", "name"=>"clientId", "description"=>"A client ID that (hopefully) uniquely identifies the client implementationof the Safe Browsing API"}, {"in"=>"query", "name"=>"clientVersion", "description"=>"The version of the client implementation"}, {"in"=>"path", "name"=>"encodedRequest", "description"=>"A serialized FindFullHashesRequest proto"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hash"]}}, "/v4/encodedUpdates/{encodedRequest}"=>{"get"=>{"summary"=>"Encoded Updates", "description"=>"Encoded Updates", "operationId"=>"safebrowsing.encodedUpdates.get", "x-api-path-slug"=>"v4encodedupdatesencodedrequest-get", "parameters"=>[{"in"=>"query", "name"=>"clientId", "description"=>"A client ID that uniquely identifies the client implementation of the SafeBrowsing API"}, {"in"=>"query", "name"=>"clientVersion", "description"=>"The version of the client implementation"}, {"in"=>"path", "name"=>"encodedRequest", "description"=>"A serialized FetchThreatListUpdatesRequest proto"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Updates"]}}, "/v4/fullHashes:find"=>{"post"=>{"summary"=>"Find Full Hash Match", "description"=>"Finds the full hashes that match the requested hash prefixes.", "operationId"=>"safebrowsing.fullHashes.find", "x-api-path-slug"=>"v4fullhashesfind-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hash"]}}, "/v4/threatListUpdates:fetch"=>{"post"=>{"summary"=>"List Most Recent Threats", "description"=>"Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.", "operationId"=>"safebrowsing.threatListUpdates.fetch", "x-api-path-slug"=>"v4threatlistupdatesfetch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Threats"]}}, "/v4/threatLists"=>{"get"=>{"summary"=>"List Threats", "description"=>"Lists the Safe Browsing threat lists available for download.", "operationId"=>"safebrowsing.threatLists.list", "x-api-path-slug"=>"v4threatlists-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Threats"]}}, "/v4/threatMatches:find"=>{"post"=>{"summary"=>"Find Threat Entry", "description"=>"Finds the threat entries that match the Safe Browsing lists.", "operationId"=>"safebrowsing.threatMatches.find", "x-api-path-slug"=>"v4threatmatchesfind-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Threats"]}}}}, "apis"=>{"name"=>"Google Safe Browsing", "x-slug"=>"google-safe-browsing", "description"=>"The Safe Browsing APIs (v4) let your client applications check URLs against Googles constantly updated lists of unsafe web resources. Examples of unsafe web resources are social engineering sites (phishing and deceptive sites) and sites that host malware or unwanted software. Any URL found on a Safe Browsing list is considered unsafe.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/SafeBrowsing_Icon.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Links,Privacy,Profiles,Relative Data,Security,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-safe-browsing/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Safe Browsing API", "x-api-slug"=>"google-safe-browsing-api", "description"=>"The Safe Browsing APIs (v4) let your client applications check URLs against Googles constantly updated lists of unsafe web resources. Examples of unsafe web resources are social engineering sites (phishing and deceptive sites) and sites that host malware or unwanted software. Any URL found on a Safe Browsing list is considered unsafe.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/SafeBrowsing_Icon.png", "humanURL"=>"https://developers.google.com/safe-browsing/", "baseURL"=>"://safebrowsing.googleapis.com//", "tags"=>"API Provider,API Service Provider,Google APIs,Links,Privacy,Profiles,Relative Data,Security,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-safe-browsing/google-safe-browsing-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://developers.google.com/safe-browsing/v4/"}, {"type"=>"x-forum", "url"=>"http://groups.google.com/group/google-safe-browsing-api"}, {"type"=>"x-getting-started", "url"=>"https://developers.google.com/safe-browsing/v4/get-started"}, {"type"=>"x-website", "url"=>"https://developers.google.com/safe-browsing/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
urban-airship{"urban-airship-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Urban Airship", "x-complete"=>1, "info"=>{"title"=>"Urban Airship", "description"=>"the-urban-airships-api-powers-mobile-applications-with-push-rich-push-inapp-purchases-and-subscription-services-", "version"=>"v3"}, "host"=>"go.urbanairship.com", "basePath"=>"/api/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/device_tokens/{token}"=>{"put"=>{"summary"=>"Put Device Tokens Token", "description"=>"Registers a device token.", "operationId"=>"device_tokens.token.put", "x-api-path-slug"=>"device-tokenstoken-put", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Device tokens should be represented as an uppercase string, 64 characters long, without spaces or other separators"}, {"in"=>"path", "name"=>"token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Tokens", "Token"]}, "get"=>{"summary"=>"Get Device Tokens Token", "description"=>"Gets a device token???s alias.", "operationId"=>"device_tokens.token.get", "x-api-path-slug"=>"device-tokenstoken-get", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Device tokens should be represented as an uppercase string, 64 characters long, without spaces or other separators"}, {"in"=>"path", "name"=>"token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Tokens", "Token"]}, "delete"=>{"summary"=>"Delete Device Tokens Token", "description"=>"Marks the device token as inactive. No notifications will be delivered to it until a PUT is executed again. The DELETE returns HTTP 204 No Content, and needs no payload. When a token is deleted in this manner, any alias or tags will be cleared.", "operationId"=>"device_tokens.token.delete", "x-api-path-slug"=>"device-tokenstoken-delete", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Device tokens should be represented as an uppercase string, 64 characters long, without spaces or other separators"}, {"in"=>"path", "name"=>"token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Tokens", "Token"]}}, "/push"=>{"post"=>{"summary"=>"Post Push", "description"=>"Sends a push message to one or more users. Only one of aliases, tags, or device_pins is required, but they can be mixed and matched as much as you???d like.", "operationId"=>"push.post", "x-api-path-slug"=>"push-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Push"]}}, "/push/scheduled/{notification}"=>{"delete"=>{"summary"=>"Delete Push Scheduled Notification", "description"=>"Cancels a scheduled notification. A successful delete will have an HTTP status code of 204. If the scheduled notification does not exist, has already been successfully deleted, or was sent, the status code will be 404.", "operationId"=>"push.scheduled.notification.delete", "x-api-path-slug"=>"pushschedulednotification-delete", "parameters"=>[{"in"=>"query", "name"=>"notification", "description"=>"Scheduled notification ID"}, {"in"=>"path", "name"=>"notification"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Push", "Scheduled", "Notification"]}}, "/push/scheduled"=>{"post"=>{"summary"=>"Post Push Scheduled", "description"=>"Bulk deletes scheduled notifications. If you include URLs or aliases for scheduled notifications that don???t exist or have already been sent, they will be ignored. Any device token in the cancel_device_tokens payload will have every notification that is sent to it removed. This will not prevent it from receiving scheduled notifications to tags or broadcast messages.", "operationId"=>"push.scheduled.post", "x-api-path-slug"=>"pushscheduled-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Push", "Scheduled"]}}, "/push/scheduled/alias/{alias}"=>{"put"=>{"summary"=>"Put Push Scheduled Alias Alias", "description"=>"Changes a scheduled notification alias. Aliases for scheduled notifications are unique per Urban Airship application, so you might want to hash the aliases with a device ID or use some other mechanism to ensure uniqueness. The only other limit is that they must be 255 characters or less.", "operationId"=>"push.scheduled.alias.alias.put", "x-api-path-slug"=>"pushscheduledaliasalias-put", "parameters"=>[{"in"=>"query", "name"=>"alias", "description"=>"Scheduled notification alias"}, {"in"=>"path", "name"=>"alias"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Push", "Scheduled", "Alias", "Alias"]}, "delete"=>{"summary"=>"Delete Push Scheduled Alias Alias", "description"=>"Deletes a scheduled notification alias. If you attempt to schedule an aliased scheduled notification with an alias that already exists for your application, it will overwrite the existing one.", "operationId"=>"push.scheduled.alias.alias.delete", "x-api-path-slug"=>"pushscheduledaliasalias-delete", "parameters"=>[{"in"=>"query", "name"=>"alias", "description"=>"Scheduled notification alias"}, {"in"=>"path", "name"=>"alias"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Push", "Scheduled", "Alias", "Alias"]}}, "/push/batch"=>{"post"=>{"summary"=>"Post Push Batch", "description"=>"Sends a push message to all the listed PINs. Each item in the list can contain 0 or many device_pins and 0 or many aliases or tags, and the blackberry payload is in the same format as for individual pushes.", "operationId"=>"push.batch.post", "x-api-path-slug"=>"pushbatch-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Push", "Batch"]}}, "/push/broadcast"=>{"post"=>{"summary"=>"Post Push Broadcast", "description"=>"Sends a push message to all active APIDs (Broadcast). Important: The maximum message size is 1024 bytes. This is calculated as the UTF-8 lengths of alert and extra fields together.", "operationId"=>"push.broadcast.post", "x-api-path-slug"=>"pushbroadcast-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Push", "Broadcast"]}}, "/push/stats"=>{"get"=>{"summary"=>"Get Push Stats", "description"=>"Returns hourly message counts for your application. By default, results are returned in JSON. For CSV, either add the header:Accept:text/csv or append &format=csv to the query string. Times are in UTC, and data is provided for each push platform (currently: iOS, BlackBerry, Android, and C2DM, in that order). The statistics system is updated every 15 minutes, so the final count for an hour will be done at the latest 15 minutes after the hour is done.", "operationId"=>"push.stats.get", "x-api-path-slug"=>"pushstats-get", "parameters"=>[{"in"=>"query", "name"=>"end", "description"=>"End date in UTC format"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"start", "description"=>"Start date in UTC format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Push", "Stats"]}}, "/device_tokens"=>{"get"=>{"summary"=>"Get Device Tokens", "description"=>"Gets information about all of your device tokens. If your application has a large number of device tokens, we???ll paginate the request for you. By default, we paginate at 5000 device tokens. You can receive the next page simply by retrieving the URL from \"next_page\" - in this way it is easy to export all of your device tokens and all their data.", "operationId"=>"device_tokens.get", "x-api-path-slug"=>"device-tokens-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"The total items to return"}, {"in"=>"query", "name"=>"page", "description"=>"The page number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Tokens"]}}, "/device_tokens/count"=>{"get"=>{"summary"=>"Get Device Tokens Count", "description"=>"Gets the number of device tokens you have registered.", "operationId"=>"device_tokens.count.get", "x-api-path-slug"=>"device-tokenscount-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"The total items to return"}, {"in"=>"query", "name"=>"page", "description"=>"The page number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Tokens", "Count"]}}, "/device_tokens/feedback"=>{"get"=>{"summary"=>"Get Device Tokens Feedback", "description"=>"Gets what device tokens are now invalid. Apple informs us when a push notification is sent to a device that can???t receive it because the application has been uninstalled. We mark the device token as inactive and immediately stop sending notifications to that device. Once a day is a good interval for querying the feedback service, but you can do it more often to save on bandwidth from unnecessary notifications. In the response, what does marked_inactive_on mean? Apple sends a timestamp for each device token returned via the feedback service. Since a device can be off the network for a while, this can be a point in the recent past. In order to make this API work smoothly for you, we record the timestamp we marked as inactive. This means you only need to query for data since the last time you queried. Once a day is a good timeframe, or once a week for very small or infrequently used applications. A few times a day is good for applications with heavy use.", "operationId"=>"device_tokens.feedback.get", "x-api-path-slug"=>"device-tokensfeedback-get", "parameters"=>[{"in"=>"query", "name"=>"since", "description"=>"Since timestamp in ISO 8601 format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Tokens", "Feedback"]}}, "/apids/{apid}"=>{"put"=>{"summary"=>"Put Aps Ap", "description"=>"Registers an APID. Unlike registration for iOS and BlackBerry applications, basic registration tying an APID to your application happens automatically. The registration API can be used to set aliases or tags. This returns HTTP 200 OK for any updates. Registering without any body is a no-op. Not including the alias field will clear it. To clear the list of tags, set it to the empty list []. If you are registering an APID to be used with C2DM, you will also need to include a C2DM registration ID.", "operationId"=>"apids.apid.put", "x-api-path-slug"=>"apidsapid-put", "parameters"=>[{"in"=>"query", "name"=>"apid", "description"=>"An APID (Android Push ID) is the Urban Airship ID of a device to which a message can be pushed"}, {"in"=>"path", "name"=>"apid"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apids", "Apid"]}, "get"=>{"summary"=>"Get Aps Ap", "description"=>"Gets APID information.", "operationId"=>"apids.apid.get", "x-api-path-slug"=>"apidsapid-get", "parameters"=>[{"in"=>"query", "name"=>"apid", "description"=>"An APID (Android Push ID) is the Urban Airship ID of a device to which a message can be pushed"}, {"in"=>"path", "name"=>"apid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apids", "Apid"]}, "delete"=>{"summary"=>"Delete Aps Ap", "description"=>"Marks an APID as invalid. No notifications will be delivered to it until it re-registers.", "operationId"=>"apids.apid.delete", "x-api-path-slug"=>"apidsapid-delete", "parameters"=>[{"in"=>"query", "name"=>"apid", "description"=>"An APID (Android Push ID) is the Urban Airship ID of a device to which a message can be pushed"}, {"in"=>"path", "name"=>"apid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apids", "Apid"]}}, "/apids"=>{"get"=>{"summary"=>"Get Aps", "description"=>"Gets APIDs. You can control how many APIDs are returned at a time by using the limit GET argument. The maximum limit is 5000.", "operationId"=>"apids.get", "x-api-path-slug"=>"apids-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Control how many APIDs are returned at a time"}, {"in"=>"query", "name"=>"start", "description"=>"APID from where to start from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apids"]}}, "/device_pins/{pin}"=>{"put"=>{"summary"=>"Put Device Pins Pin", "description"=>"Registers a BlackBerry PIN. This is optional, but recommended, for BlackBerry push messages. This returns HTTP 201 Created for the first registration and 200 OK for any updates. If you wish to include additional information about a device pin, for instance an alias or tags, include a JSON payload along with this request. Not including one of these keys removes it from the device pin.", "operationId"=>"device_pins.pin.put", "x-api-path-slug"=>"device-pinspin-put", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"pin", "description"=>"A BlackBerry PIN"}, {"in"=>"path", "name"=>"pin"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Pins", "Pin"]}, "get"=>{"summary"=>"Get Device Pins Pin", "description"=>"Gets Device PIN information.", "operationId"=>"device_pins.pin.get", "x-api-path-slug"=>"device-pinspin-get", "parameters"=>[{"in"=>"query", "name"=>"pin", "description"=>"A BlackBerry PIN"}, {"in"=>"path", "name"=>"pin"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Pins", "Pin"]}, "delete"=>{"summary"=>"Delete Device Pins Pin", "description"=>"Marks a PIN as inactive. No notifications will be delivered to it until a PUT is executed again.", "operationId"=>"device_pins.pin.delete", "x-api-path-slug"=>"device-pinspin-delete", "parameters"=>[{"in"=>"query", "name"=>"pin", "description"=>"A BlackBerry PIN"}, {"in"=>"path", "name"=>"pin"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Pins", "Pin"]}}, "/user"=>{"post"=>{"summary"=>"Post User", "description"=>"Creates a new user and returns the credentials.", "operationId"=>"user.post", "x-api-path-slug"=>"user-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/user/{user_id}"=>{"put"=>{"summary"=>"Put User User", "description"=>"Changes properties of an user - for example, changing or adding an email address.", "operationId"=>"user.user_id.put", "x-api-path-slug"=>"useruser-id-put", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"user_id", "description"=>"The user ID"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id"]}, "delete"=>{"summary"=>"Delete User User", "description"=>"Deletes an user.", "operationId"=>"user.user_id.delete", "x-api-path-slug"=>"useruser-id-delete", "parameters"=>[{"in"=>"query", "name"=>"user_id", "description"=>"The user ID"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id"]}, "get"=>{"summary"=>"Get User User", "description"=>"Retrieves an user???s subscription information.", "operationId"=>"user.user_id.get", "x-api-path-slug"=>"useruser-id-get", "parameters"=>[{"in"=>"query", "name"=>"user_id", "description"=>"User ID"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id"]}}, "/user/{user_id}/creds/reset"=>{"post"=>{"summary"=>"Post User User Creds Reset", "description"=>"Changes the password of an user.", "operationId"=>"user.user_id.creds.reset.post", "x-api-path-slug"=>"useruser-idcredsreset-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"user_id", "description"=>"The user ID"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id", "Creds", "Reset"]}}, "/airmail/send"=>{"post"=>{"summary"=>"Post Airmail Send", "description"=>"Sends a message. All fields except message are optional, but at least one of tags, users or aliases must be specified. Much like the push API, we have a batch API call that can make sending multiple messages easier. It???s located at /api/airmail/send/batch/ and accepts a list of messages in the same format as the standard push call.", "operationId"=>"airmail.send.post", "x-api-path-slug"=>"airmailsend-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Airmail", "Send"]}}, "/airmail/send/broadcast"=>{"post"=>{"summary"=>"Post Airmail Send Broadcast", "description"=>"Sends a message to all users (broadcast). Only message is required. The message will be sent out to every registered user. Badge numbers will be handled automatically as long as the push key is present.", "operationId"=>"airmail.send.broadcast.post", "x-api-path-slug"=>"airmailsendbroadcast-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Airmail", "Send", "Broadcast"]}}, "/user/{user_id}/messages"=>{"get"=>{"summary"=>"Get User User Messages", "description"=>"Returns a list of messages and some metadata about them. It will also include some metadata about the user.", "operationId"=>"user.user_id.messages.get", "x-api-path-slug"=>"useruser-idmessages-get", "parameters"=>[{"in"=>"query", "name"=>"full_list", "description"=>"Get the full message included in this list (which might take a while to download)"}, {"in"=>"query", "name"=>"since", "description"=>"Return only new items"}, {"in"=>"query", "name"=>"user_id", "description"=>"The user ID"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id", "Messages"]}}, "/user/{user_id}/messages/unread"=>{"get"=>{"summary"=>"Get User User Messages Unread", "description"=>"Returns a list of unread message IDs and their URLs.", "operationId"=>"user.user_id.messages.unread.get", "x-api-path-slug"=>"useruser-idmessagesunread-get", "parameters"=>[{"in"=>"query", "name"=>"user_id", "description"=>"The user ID"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id", "Messages", "Unread"]}, "post"=>{"summary"=>"Post User User Messages Unread", "description"=>"Marks multiple messages as read at once. If a message has already been marked as read, it will be silently skipped.", "operationId"=>"user.user_id.messages.unread.post", "x-api-path-slug"=>"useruser-idmessagesunread-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"user_id", "description"=>"The user ID"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id", "Messages", "Unread"]}}, "/user/{user_id}/messages/message/{message_id}"=>{"get"=>{"summary"=>"Get User User Messages Message Message", "description"=>"Gets a message.", "operationId"=>"user.user_id.messages.message.message_id.get", "x-api-path-slug"=>"useruser-idmessagesmessagemessage-id-get", "parameters"=>[{"in"=>"query", "name"=>"message_id", "description"=>"The message ID"}, {"in"=>"path", "name"=>"message_id"}, {"in"=>"query", "name"=>"user_id", "description"=>"The user ID"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id", "Messages", "Message", "Message", "Id"]}, "delete"=>{"summary"=>"Delete User User Messages Message Message", "description"=>"Deletes a message.", "operationId"=>"user.user_id.messages.message.message_id.delete", "x-api-path-slug"=>"useruser-idmessagesmessagemessage-id-delete", "parameters"=>[{"in"=>"query", "name"=>"message_id", "description"=>"The message ID"}, {"in"=>"path", "name"=>"message_id"}, {"in"=>"query", "name"=>"user_id", "description"=>"The user ID"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id", "Messages", "Message", "Message", "Id"]}}, "/user/{user_id}/messages/message/{message_id}/body"=>{"get"=>{"summary"=>"Get User User Messages Message Message Body", "description"=>"Gets a message's body.", "operationId"=>"user.user_id.messages.message.message_id.body.get", "x-api-path-slug"=>"useruser-idmessagesmessagemessage-idbody-get", "parameters"=>[{"in"=>"query", "name"=>"message_id", "description"=>"The message ID"}, {"in"=>"path", "name"=>"message_id"}, {"in"=>"query", "name"=>"user_id", "description"=>"The user ID"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id", "Messages", "Message", "Message", "Id", "Body"]}}, "/user/{user_id}/messages/message/{message_id}/read"=>{"post"=>{"summary"=>"Post User User Messages Message Message Read", "description"=>"Marks a message as read.", "operationId"=>"user.user_id.messages.message.message_id.read.post", "x-api-path-slug"=>"useruser-idmessagesmessagemessage-idread-post", "parameters"=>[{"in"=>"query", "name"=>"message_id", "description"=>"The message ID"}, {"in"=>"path", "name"=>"message_id"}, {"in"=>"query", "name"=>"user_id", "description"=>"The user ID"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id", "Messages", "Message", "Message", "Id", "Read"]}}, "/user/{user_id}/messages/delete"=>{"post"=>{"summary"=>"Post User User Messages Delete", "description"=>"Deletes multiple messages at once. If a message has already been deleted, it will be silently skipped.", "operationId"=>"user.user_id.messages.delete.post", "x-api-path-slug"=>"useruser-idmessagesdelete-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"user_id", "description"=>"The user ID"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id", "Messages", "Delete"]}}, "/app/content"=>{"get"=>{"summary"=>"Get App Content", "description"=>"Gets the store inventory.", "operationId"=>"app.content.get", "x-api-path-slug"=>"appcontent-get", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"user_id", "description"=>"The user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App", "Content"]}}, "/app/content/{product_id}/download"=>{"post"=>{"summary"=>"Post App Content Product Download", "description"=>"Returns a temporary URL where the client can download the content. In the payload, the receipt string is the receipt data from the purchase. It should be unaltered from how Apple delivers it to your application.udid is an optional field to help identify a particular user???s purchases, which can aid debugging. It should always be a hash of the UDID, not the actual UDID, to ensure compliance with Apple???s TOS. The optional version field should be the StoreFront library version, or custom if you???re building your own.", "operationId"=>"app.content.product_id.download.post", "x-api-path-slug"=>"appcontentproduct-iddownload-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"product_id", "description"=>"The product ID"}, {"in"=>"path", "name"=>"product_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App", "Content", "Product", "Id", "Download"]}}, "/app/updates"=>{"post"=>{"summary"=>"Post App Updates", "description"=>"Checks for updates. It can be useful on application launch to compare a list of installed updates with our server to see if there are any updates to be had for the content.", "operationId"=>"app.updates.post", "x-api-path-slug"=>"appupdates-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"product_id", "description"=>"The product ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App", "Updates"]}}, "/user/recover"=>{"post"=>{"summary"=>"Post User Recover", "description"=>"Uses the user???s email address as a way to restore subscription content across devices.", "operationId"=>"user.recover.post", "x-api-path-slug"=>"userrecover-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Recover"]}}, "/user/recover/{id}"=>{"get"=>{"summary"=>"Get User Recover", "description"=>"Checks the recovery status.", "operationId"=>"user.recover.id.get", "x-api-path-slug"=>"userrecoverid-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"ID of the useru2019s account recovery"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Recover", "Id"]}}, "/user/{user_id}/available_subscriptions"=>{"get"=>{"summary"=>"Get User User Available Subscriptions", "description"=>"Retrieves subscription options.", "operationId"=>"user.user_id.available_subscriptions.get", "x-api-path-slug"=>"useruser-idavailable-subscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"user_id", "description"=>"User ID"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id", "Available", "Subscriptions"]}}, "/user/{user_id}/subscriptions/{subscription_key}/purchase"=>{"post"=>{"summary"=>"Post User User Subscriptions Subscription Key Purchase", "description"=>"Adds a new subscription.", "operationId"=>"user.user_id.subscriptions.subscription_key.purchase.post", "x-api-path-slug"=>"useruser-idsubscriptionssubscription-keypurchase-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"subscription_key", "description"=>"Subscription Key"}, {"in"=>"path", "name"=>"subscription_key"}, {"in"=>"query", "name"=>"user_id", "description"=>"User ID"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id", "Subscriptions", "Subscription", "Key", "Purchase"]}}, "/user/{user_id}/subscription_content"=>{"get"=>{"summary"=>"Get User User Subscription Content", "description"=>"Returns a list of available content.", "operationId"=>"user.user_id.subscription_content.get", "x-api-path-slug"=>"useruser-idsubscription-content-get", "parameters"=>[{"in"=>"query", "name"=>"user_id", "description"=>"User ID"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id", "Subscription", "Content"]}}, "/user/{user_id}/subscriptions/content/{content_id}/download"=>{"post"=>{"summary"=>"Post User User Subscriptions Content Content Download", "description"=>"Downloads the content.", "operationId"=>"user.user_id.subscriptions.content.content_id.download.post", "x-api-path-slug"=>"useruser-idsubscriptionscontentcontent-iddownload-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"content_id", "description"=>"Content ID"}, {"in"=>"path", "name"=>"content_id"}, {"in"=>"query", "name"=>"user_id", "description"=>"User ID"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id", "Subscriptions", "Content", "Content", "Id", "Download"]}}, "/feeds"=>{"post"=>{"summary"=>"Post Feeds", "description"=>"Creates a new feed item.", "operationId"=>"feeds.post", "x-api-path-slug"=>"feeds-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feeds"]}, "get"=>{"summary"=>"Get Feeds", "description"=>"Gets a list of feeds.", "operationId"=>"feeds.get", "x-api-path-slug"=>"feeds-get", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feeds"]}}, "/feeds/{feed_id}"=>{"get"=>{"summary"=>"Get Feeds Feed", "description"=>"Returns information about a particular feed.", "operationId"=>"feeds.feed_id.get", "x-api-path-slug"=>"feedsfeed-id-get", "parameters"=>[{"in"=>"query", "name"=>"feed_id", "description"=>"A particular feed"}, {"in"=>"path", "name"=>"feed_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feeds", "Feed", "Id"]}, "put"=>{"summary"=>"Put Feeds Feed", "description"=>"Updates a feed.", "operationId"=>"feeds.feed_id.put", "x-api-path-slug"=>"feedsfeed-id-put", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"feed_id", "description"=>"A particular feed"}, {"in"=>"path", "name"=>"feed_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feeds", "Feed", "Id"]}, "delete"=>{"summary"=>"Delete Feeds Feed", "description"=>"Deletes a feed.", "operationId"=>"feeds.feed_id.delete", "x-api-path-slug"=>"feedsfeed-id-delete", "parameters"=>[{"in"=>"query", "name"=>"feed_id", "description"=>"A particular feed"}, {"in"=>"path", "name"=>"feed_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feeds", "Feed", "Id"]}}, "/tags"=>{"get"=>{"summary"=>"Get Tags", "description"=>"Returns all the tags that you have created.", "operationId"=>"tags.get", "x-api-path-slug"=>"tags-get", "parameters"=>[{"in"=>"query", "name"=>"feed_id", "description"=>"A particular feed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/tags/{tag}"=>{"put"=>{"summary"=>"Put Tags Tag", "description"=>"Deletes a tag.", "operationId"=>"tags.tag.put", "x-api-path-slug"=>"tagstag-put", "parameters"=>[{"in"=>"query", "name"=>"tag", "description"=>"Tags can be of any format you wish, but we recommend that they be URL-safe in order to make less work for you"}, {"in"=>"path", "name"=>"tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Tag"]}, "post"=>{"summary"=>"Post Tags Tag", "description"=>"Modifies device tokens on a tag.", "operationId"=>"tags.tag.post", "x-api-path-slug"=>"tagstag-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"tag", "description"=>"Tags can be of any format you wish, but we recommend that they be URL-safe in order to make less work for you"}, {"in"=>"path", "name"=>"tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Tag"]}}, "/device_tokens/{device_token}/tags"=>{"get"=>{"summary"=>"Get Device Tokens Device Token Tags", "description"=>"Gets tags for a specific device token.", "operationId"=>"device_tokens.device_token.tags.get", "x-api-path-slug"=>"device-tokensdevice-tokentags-get", "parameters"=>[{"in"=>"query", "name"=>"device_token", "description"=>"A specific device token"}, {"in"=>"path", "name"=>"device_token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Tokens", "Device", "Token", "Tags"]}}, "/device_tokens/{device_token}/tags/{tag}"=>{"put"=>{"summary"=>"Put Device Tokens Device Token Tags Tag", "description"=>"Creates a tag and associate it with the specific device token.", "operationId"=>"device_tokens.device_token.tags.tag.put", "x-api-path-slug"=>"device-tokensdevice-tokentagstag-put", "parameters"=>[{"in"=>"query", "name"=>"device_token", "description"=>"A specific device token"}, {"in"=>"path", "name"=>"device_token"}, {"in"=>"query", "name"=>"tag", "description"=>"Tags can be of any format you wish, but we recommend that they be URL-safe in order to make less work for you"}, {"in"=>"path", "name"=>"tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Tokens", "Device", "Token", "Tags", "Tag"]}, "delete"=>{"summary"=>"Delete Device Tokens Device Token Tags Tag", "description"=>"Removes a single tag from a device token.", "operationId"=>"device_tokens.device_token.tags.tag.delete", "x-api-path-slug"=>"device-tokensdevice-tokentagstag-delete", "parameters"=>[{"in"=>"query", "name"=>"device_token", "description"=>"A specific device token"}, {"in"=>"path", "name"=>"device_token"}, {"in"=>"query", "name"=>"tag", "description"=>"Tags can be of any format you wish, but we recommend that they be URL-safe in order to make less work for you"}, {"in"=>"path", "name"=>"tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Tokens", "Device", "Token", "Tags", "Tag"]}}, "/partner/apps"=>{"get"=>{"summary"=>"Get Partner Apps", "description"=>"List applications.", "operationId"=>"partner.apps.get", "x-api-path-slug"=>"partnerapps-get", "parameters"=>[{"in"=>"query", "name"=>"device_token", "description"=>"A specific device token"}, {"in"=>"query", "name"=>"tag", "description"=>"Tags can be of any format you wish, but we recommend that they be URL-safe in order to make less work for you"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partner", "Apps"]}, "post"=>{"summary"=>"Post Partner Apps", "description"=>"Adds a new application.", "operationId"=>"partner.apps.post", "x-api-path-slug"=>"partnerapps-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partner", "Apps"]}}, "/partner/apps/{app_id}"=>{"put"=>{"summary"=>"Put Partner Apps App", "description"=>"Updates an application.", "operationId"=>"partner.apps.app_id.put", "x-api-path-slug"=>"partnerappsapp-id-put", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"A specific application"}, {"in"=>"path", "name"=>"app_id"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partner", "Apps", "App", "Id"]}}}}, "apis"=>{"name"=>"Urban Airship", "x-slug"=>"urban-airship", "description"=>"A market-leading mobile app engagement, mobile analytics, mobile data integration and mobile wallet marketing solution.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/75-urban-airship.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"79571", "tags"=>"BaaS,internet,Locations,Locations,Mobile,Push Notifications,Relative Data,Relative StreamRank,SaaS,Service API,Stack Network,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"urban-airship/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Urban Airship", "x-api-slug"=>"urban-airship", "description"=>"The Urban Airship Push API is a major update which unifies several legacy endpoints into two— one for sending messages and one for scheduling.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/75-urban-airship.jpg", "humanURL"=>"http://urbanairship.com/", "baseURL"=>"https://go.urbanairship.com//api/", "tags"=>"BaaS,internet,Locations,Locations,Mobile,Push Notifications,Relative Data,Relative StreamRank,SaaS,Service API,Stack Network,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/urban-airship/partnerappsapp-id-put-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/urban-airship/urban-airship-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://urbanairship.com/"}, {"type"=>"x-android-sdk", "url"=>"http://docs.urbanairship.com/platform/android.html"}, {"type"=>"x-blackberry-sdk", "url"=>"http://docs.urbanairship.com/platform/blackberry.html"}, {"type"=>"x-blog", "url"=>"http://urbanairship.com/blog"}, {"type"=>"x-blog-rss", "url"=>"http://urbanairship.com/blog/rss"}, {"type"=>"x-case-studies", "url"=>"http://urbanairship.com/resources/case-studies"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/urban-airship"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/urban-airship"}, {"type"=>"x-developer", "url"=>"http://docs.urbanairship.com/"}, {"type"=>"x-email", "url"=>"legal@urbanairship.com"}, {"type"=>"x-email", "url"=>"privacy@urbanairship.com"}, {"type"=>"x-email", "url"=>"support@urbanairship.com"}, {"type"=>"x-github", "url"=>"https://github.com/urbanairship"}, {"type"=>"x-glossary", "url"=>"http://docs.urbanairship.com/reference/glossary.html"}, {"type"=>"x-ios-sdk", "url"=>"http://docs.urbanairship.com/platform/ios.html"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/urban-airship/"}, {"type"=>"x-phonegap-sdk", "url"=>"http://docs.urbanairship.com/platform/phonegap.html"}, {"type"=>"x-pricing", "url"=>"https://www.urbanairship.com/products/engage/pricing"}, {"type"=>"x-privacy", "url"=>"http://urbanairship.com/legal/privacy-policy"}, {"type"=>"x-security", "url"=>"http://docs.urbanairship.com/reference/app_keys_secrets.html"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/urbanairship"}, {"type"=>"x-website", "url"=>"http://urbanairship.com"}, {"type"=>"x-white-papers", "url"=>"http://urbanairship.com/resources/whitepapers"}, {"type"=>"x-windows-sdk", "url"=>"http://docs.urbanairship.com/platform/windows.html"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-biquery{"google-bigquery-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Biquery", "x-complete"=>1, "info"=>{"title"=>"BigQuery", "description"=>"a-data-platform-for-customers-to-create-manage-share-and-query-data-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v2"}, "host"=>"www.googleapis.com", "basePath"=>"/bigquery/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/projects"=>{"get"=>{"summary"=>"Get Projects", "description"=>"Lists all projects to which you have been granted any project role.", "operationId"=>"bigquery.projects.list", "x-api-path-slug"=>"projects-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Page token, returned by a previous call, to request the next page of results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project"]}}, "/projects/{projectId}/datasets"=>{"get"=>{"summary"=>"Get Datasets", "description"=>"Lists all datasets in the specified project to which you have been granted the READER dataset role.", "operationId"=>"bigquery.datasets.list", "x-api-path-slug"=>"projectsprojectiddatasets-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Whether to list all datasets, including hidden ones"}, {"in"=>"query", "name"=>"filter", "description"=>"An expression for filtering the results of the request by label"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Page token, returned by a previous call, to request the next page of results"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the datasets to be listed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}, "post"=>{"summary"=>"Create Dataset", "description"=>"Creates a new empty dataset.", "operationId"=>"bigquery.datasets.insert", "x-api-path-slug"=>"projectsprojectiddatasets-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the new dataset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}}, "/projects/{projectId}/datasets/{datasetId}"=>{"delete"=>{"summary"=>"Delete Dataset", "description"=>"Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.", "operationId"=>"bigquery.datasets.delete", "x-api-path-slug"=>"projectsprojectiddatasetsdatasetid-delete", "parameters"=>[{"in"=>"path", "name"=>"datasetId", "description"=>"Dataset ID of dataset being deleted"}, {"in"=>"query", "name"=>"deleteContents", "description"=>"If True, delete all the tables in the dataset"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the dataset being deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}, "get"=>{"summary"=>"Get Dataset", "description"=>"Returns the dataset specified by datasetID.", "operationId"=>"bigquery.datasets.get", "x-api-path-slug"=>"projectsprojectiddatasetsdatasetid-get", "parameters"=>[{"in"=>"path", "name"=>"datasetId", "description"=>"Dataset ID of the requested dataset"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the requested dataset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}, "patch"=>{"summary"=>"Update Dataset", "description"=>"Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics.", "operationId"=>"bigquery.datasets.patch", "x-api-path-slug"=>"projectsprojectiddatasetsdatasetid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"datasetId", "description"=>"Dataset ID of the dataset being updated"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the dataset being updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}, "put"=>{"summary"=>"Update Dataset", "description"=>"Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.", "operationId"=>"bigquery.datasets.update", "x-api-path-slug"=>"projectsprojectiddatasetsdatasetid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"datasetId", "description"=>"Dataset ID of the dataset being updated"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the dataset being updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}}, "/projects/{projectId}/datasets/{datasetId}/tables"=>{"get"=>{"summary"=>"Get Tables", "description"=>"Lists all tables in the specified dataset. Requires the READER dataset role.", "operationId"=>"bigquery.tables.list", "x-api-path-slug"=>"projectsprojectiddatasetsdatasetidtables-get", "parameters"=>[{"in"=>"path", "name"=>"datasetId", "description"=>"Dataset ID of the tables to list"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Page token, returned by a previous call, to request the next page of results"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the tables to list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}, "post"=>{"summary"=>"Create Table", "description"=>"Creates a new, empty table in the dataset.", "operationId"=>"bigquery.tables.insert", "x-api-path-slug"=>"projectsprojectiddatasetsdatasetidtables-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"datasetId", "description"=>"Dataset ID of the new table"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the new table"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}}, "/projects/{projectId}/datasets/{datasetId}/tables/{tableId}"=>{"delete"=>{"summary"=>"Delete Table", "description"=>"Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.", "operationId"=>"bigquery.tables.delete", "x-api-path-slug"=>"projectsprojectiddatasetsdatasetidtablestableid-delete", "parameters"=>[{"in"=>"path", "name"=>"datasetId", "description"=>"Dataset ID of the table to delete"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the table to delete"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table ID of the table to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}, "get"=>{"summary"=>"Get Tble", "description"=>"Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.", "operationId"=>"bigquery.tables.get", "x-api-path-slug"=>"projectsprojectiddatasetsdatasetidtablestableid-get", "parameters"=>[{"in"=>"path", "name"=>"datasetId", "description"=>"Dataset ID of the requested table"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the requested table"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table ID of the requested table"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}, "patch"=>{"summary"=>"Update Table", "description"=>"Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics.", "operationId"=>"bigquery.tables.patch", "x-api-path-slug"=>"projectsprojectiddatasetsdatasetidtablestableid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"datasetId", "description"=>"Dataset ID of the table to update"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the table to update"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table ID of the table to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}, "put"=>{"summary"=>"Update Table", "description"=>"Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource.", "operationId"=>"bigquery.tables.update", "x-api-path-slug"=>"projectsprojectiddatasetsdatasetidtablestableid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"datasetId", "description"=>"Dataset ID of the table to update"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the table to update"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table ID of the table to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}}, "/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/data"=>{"get"=>{"summary"=>"Get Table", "description"=>"Retrieves table data from a specified set of rows. Requires the READER dataset role.", "operationId"=>"bigquery.tabledata.list", "x-api-path-slug"=>"projectsprojectiddatasetsdatasetidtablestableiddata-get", "parameters"=>[{"in"=>"path", "name"=>"datasetId", "description"=>"Dataset ID of the table to read"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Page token, returned by a previous call, identifying the result set"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the table to read"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Zero-based index of the starting row to read"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table ID of the table to read"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table Data"]}}, "/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/insertAll"=>{"post"=>{"summary"=>"Insert Data", "description"=>"Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.", "operationId"=>"bigquery.tabledata.insertAll", "x-api-path-slug"=>"projectsprojectiddatasetsdatasetidtablestableidinsertall-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"datasetId", "description"=>"Dataset ID of the destination table"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the destination table"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table ID of the destination table"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table Data"]}}, "/projects/{projectId}/jobs"=>{"get"=>{"summary"=>"Get Jobs", "description"=>"Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.", "operationId"=>"bigquery.jobs.list", "x-api-path-slug"=>"projectsprojectidjobs-get", "parameters"=>[{"in"=>"query", "name"=>"allUsers", "description"=>"Whether to display jobs owned by all users in the project"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Page token, returned by a previous call, to request the next page of results"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the jobs to list"}, {"in"=>"query", "name"=>"projection", "description"=>"Restrict information returned to a set of selected fields"}, {"in"=>"query", "name"=>"stateFilter", "description"=>"Filter for job state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}, "post"=>{"summary"=>"Create Job", "description"=>"Starts a new asynchronous job. Requires the Can View project role.", "operationId"=>"bigquery.jobs.insert", "x-api-path-slug"=>"projectsprojectidjobs-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the project that will be billed for the job"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/projects/{projectId}/jobs/{jobId}"=>{"get"=>{"summary"=>"Get Job", "description"=>"Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.", "operationId"=>"bigquery.jobs.get", "x-api-path-slug"=>"projectsprojectidjobsjobid-get", "parameters"=>[{"in"=>"path", "name"=>"jobId", "description"=>"[Required] Job ID of the requested job"}, {"in"=>"path", "name"=>"projectId", "description"=>"[Required] Project ID of the requested job"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/projects/{projectId}/jobs/{jobId}/cancel"=>{"post"=>{"summary"=>"Cancel Job", "description"=>"Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.", "operationId"=>"bigquery.jobs.cancel", "x-api-path-slug"=>"projectsprojectidjobsjobidcancel-post", "parameters"=>[{"in"=>"path", "name"=>"jobId", "description"=>"[Required] Job ID of the job to cancel"}, {"in"=>"path", "name"=>"projectId", "description"=>"[Required] Project ID of the job to cancel"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/projects/{projectId}/queries"=>{"post"=>{"summary"=>"Run Query Job", "description"=>"Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.", "operationId"=>"bigquery.jobs.query", "x-api-path-slug"=>"projectsprojectidqueries-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID of the project billed for the query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/projects/{projectId}/queries/{jobId}"=>{"get"=>{"summary"=>"Get Query Job Results", "description"=>"Retrieves the results of a query job.", "operationId"=>"bigquery.jobs.getQueryResults", "x-api-path-slug"=>"projectsprojectidqueriesjobid-get", "parameters"=>[{"in"=>"path", "name"=>"jobId", "description"=>"[Required] Job ID of the query job"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to read"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Page token, returned by a previous call, to request the next page of results"}, {"in"=>"path", "name"=>"projectId", "description"=>"[Required] Project ID of the query job"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Zero-based index of the starting row"}, {"in"=>"query", "name"=>"timeoutMs", "description"=>"How long to wait for the query to complete, in milliseconds, before returning"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}}}, "apis"=>{"name"=>"Google Biquery", "x-slug"=>"google-biquery", "description"=>"BigQuery is Googles fully managed, petabyte scale, low cost enterprise data warehouse for analytics. BigQuery is serverless. There is no infrastructure to manage and you dont need a database administrator, so you can focus on analyzing data to find meaningful insights using familiar SQL. BigQuery is a powerful Big Data analytics platform used by all types of organizations, from startups to Fortune 500 companies.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/BigQuery_500px.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Cloud,Data,Databases,Google APIs,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-biquery/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google BigQuery API", "x-api-slug"=>"google-bigquery-api", "description"=>"BigQuery is Googles fully managed, petabyte scale, low cost enterprise data warehouse for analytics. BigQuery is serverless. There is no infrastructure to manage and you dont need a database administrator, so you can focus on analyzing data to find meaningful insights using familiar SQL. BigQuery is a powerful Big Data analytics platform used by all types of organizations, from startups to Fortune 500 companies.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/BigQuery_500px.png", "humanURL"=>"https://cloud.google.com/bigquery/", "baseURL"=>"://www.googleapis.com//bigquery/v2", "tags"=>"API Provider,API Service Provider,Cloud,Data,Databases,Google APIs,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-biquery/google-bigquery-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-code", "url"=>"https://cloud.google.com/bigquery/docs/reference/libraries"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/bigquery/docs/"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/bigquery/docs/quickstarts"}, {"type"=>"x-how-to-guides", "url"=>"https://cloud.google.com/bigquery/docs/how-to"}, {"type"=>"x-partners", "url"=>"https://cloud.google.com/bigquery/partners/"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/bigquery/pricing"}, {"type"=>"x-quotas", "url"=>"https://cloud.google.com/bigquery/quota-policy"}, {"type"=>"x-service-level-agreement", "url"=>"https://cloud.google.com/bigquery/sla"}, {"type"=>"x-support", "url"=>"https://cloud.google.com/bigquery/support"}, {"type"=>"x-tutorials", "url"=>"https://cloud.google.com/bigquery/docs/tutorials"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/bigquery/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-service-fabric{"azure-service-fabric-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Service Fabric", "x-complete"=>1, "info"=>{"title"=>"ServiceFabricManagementClient", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}"=>{"patch"=>{"summary"=>"Clusters Update", "description"=>"Update cluster configuration", "operationId"=>"Clusters_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicefabricclustersclustername-patch", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The parameters which contains the property value and property name which used to update the cluster configuration", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}, "get"=>{"summary"=>"Clusters Get", "description"=>"Get cluster resource", "operationId"=>"Clusters_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicefabricclustersclustername-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}, "put"=>{"summary"=>"Clusters Create", "description"=>"Create cluster resource", "operationId"=>"Clusters_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicefabricclustersclustername-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Put Request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}, "delete"=>{"summary"=>"Clusters Delete", "description"=>"Delete cluster resource", "operationId"=>"Clusters_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicefabricclustersclustername-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters"=>{"get"=>{"summary"=>"Clusters List By Resource Group", "description"=>"List cluster resource by resource group", "operationId"=>"Clusters_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-servicefabricclusters-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters Resource Group"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/clusters"=>{"get"=>{"summary"=>"Clusters List", "description"=>"List cluster resource", "operationId"=>"Clusters_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-servicefabricclusters-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions"=>{"get"=>{"summary"=>"Cluster Versions List", "description"=>"List cluster code versions by location", "operationId"=>"ClusterVersions_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-servicefabriclocationslocationenvironmentsenvironmentclusterversions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Versions"]}}, "/providers/Microsoft.ServiceFabric/operations"=>{"get"=>{"summary"=>"Operations List", "description"=>"Lists all of the available ServiceFabric REST API operations.", "operationId"=>"Operations_List", "x-api-path-slug"=>"providersmicrosoft-servicefabricoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations"]}}}}, "apis"=>{"name"=>"Azure Service Fabric", "x-slug"=>"azure-service-fabric", "description"=>"Service Fabric is a microservices platform used to build scalable, reliable, and easily managed applications for the cloud. Addressing the significant challenges in developing and managing cloud applications, Service Fabric allows developers and administrators to avoid solving complex infrastructure problems and focus instead on implementing mission-critical, demanding workloads.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/service-fabric-02.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Applications,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-service-fabric/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Service Fabric API", "x-api-slug"=>"azure-service-fabric-api", "description"=>"Service Fabric is a microservices platform used to build scalable, reliable, and easily managed applications for the cloud. Addressing the significant challenges in developing and managing cloud applications, Service Fabric allows developers and administrators to avoid solving complex infrastructure problems and focus instead on implementing mission-critical, demanding workloads.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/service-fabric-02.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/service-fabric/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Applications,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-service-fabric/providersmicrosoft-servicefabricoperations-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-service-fabric/azure-service-fabric-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/service-fabric/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/service-fabric/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/service-fabric/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/service-fabric/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-ec2{"aws-ec2-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS EC2", "x-complete"=>1, "info"=>{"title"=>"AWS EC2 API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=DescribeAccountAttributes"=>{"get"=>{"summary"=>"Describe Account Attributes", "description"=>"Describes attributes of your AWS account.", "operationId"=>"describeaccountattributes", "x-api-path-slug"=>"actiondescribeaccountattributes-get", "parameters"=>[{"in"=>"query", "name"=>"ClientToken", "description"=>"Unique, case-sensitive identifier you provide to ensureidempotency of the request", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A description for the new AMI in the destination region", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Encrypted", "description"=>"Specifies whether the destination snapshots of the copied image should be encrypted", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyId", "description"=>"The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the new AMI in the destination region", "type"=>"string"}, {"in"=>"query", "name"=>"SourceImageId", "description"=>"The ID of the AMI to copy", "type"=>"string"}, {"in"=>"query", "name"=>"SourceRegion", "description"=>"The name of the region that contains the AMI to copy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/?Action=CopyImage"=>{"get"=>{"summary"=>"Copy Image", "description"=>"Initiates the copy of an AMI from the specified source region to the current region.", "operationId"=>"copyimage", "x-api-path-slug"=>"actioncopyimage-get", "parameters"=>[{"in"=>"query", "name"=>"BlockDeviceMapping.N", "description"=>"Information about one or more block device mappings", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A description for the new image", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"A name for the new image", "type"=>"string"}, {"in"=>"query", "name"=>"NoReboot", "description"=>"By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Image"]}}, "/?Action=CreateImage"=>{"get"=>{"summary"=>"Create Image", "description"=>"Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.", "operationId"=>"createimage", "x-api-path-slug"=>"actioncreateimage-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"ImageId", "description"=>"The ID of the AMI", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Image"]}}, "/?Action=DeregisterImage"=>{"get"=>{"summary"=>"Deregister Image", "description"=>"Deregisters the specified AMI.", "operationId"=>"deregisterimage", "x-api-path-slug"=>"actionderegisterimage-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The AMI attribute", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"ImageId", "description"=>"The ID of the AMI", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Image"]}}, "/?Action=DescribeImageAttribute"=>{"get"=>{"summary"=>"Describe Image Attribute", "description"=>"Describes the specified attribute of the specified AMI.", "operationId"=>"describeimageattribute", "x-api-path-slug"=>"actiondescribeimageattribute-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"ExecutableBy.N", "description"=>"Scopes the images by users with explicit launch permissions", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"ImageId.N", "description"=>"One or more image IDs", "type"=>"string"}, {"in"=>"query", "name"=>"Owner.N", "description"=>"Filters the images by the owner", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Image"]}}, "/?Action=DescribeImages"=>{"get"=>{"summary"=>"Describe Images", "description"=>"Describes one or more of the images (AMIs, AKIs, and ARIs) available to you.", "operationId"=>"describeimages", "x-api-path-slug"=>"actiondescribeimages-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The name of the attribute to modify", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A description for the AMI", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"ImageId", "description"=>"The ID of the AMI", "type"=>"string"}, {"in"=>"query", "name"=>"LaunchPermission", "description"=>"A launch permission modification", "type"=>"string"}, {"in"=>"query", "name"=>"OperationType", "description"=>"The operation type", "type"=>"string"}, {"in"=>"query", "name"=>"ProductCode.N", "description"=>"One or more product codes", "type"=>"string"}, {"in"=>"query", "name"=>"UserGroup.N", "description"=>"One or more user groups", "type"=>"string"}, {"in"=>"query", "name"=>"UserId.N", "description"=>"One or more AWS account IDs", "type"=>"string"}, {"in"=>"query", "name"=>"Value", "description"=>"The value of the attribute being modified", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Image"]}}, "/?Action=ModifyImageAttribute"=>{"get"=>{"summary"=>"Modify Image Attribute", "description"=>"Modifies the specified attribute of the specified AMI.", "operationId"=>"modifyimageattribute", "x-api-path-slug"=>"actionmodifyimageattribute-get", "parameters"=>[{"in"=>"query", "name"=>"Architecture", "description"=>"The architecture of the AMI", "type"=>"string"}, {"in"=>"query", "name"=>"BlockDeviceMapping.N", "description"=>"One or more block device mapping entries", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A description for your AMI", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"EnaSupport", "description"=>"Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI", "type"=>"string"}, {"in"=>"query", "name"=>"ImageLocation", "description"=>"The full path to your AMI manifest in Amazon S3 storage", "type"=>"string"}, {"in"=>"query", "name"=>"KernelId", "description"=>"The ID of the kernel", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"A name for your AMI", "type"=>"string"}, {"in"=>"query", "name"=>"RamdiskId", "description"=>"The ID of the RAM disk", "type"=>"string"}, {"in"=>"query", "name"=>"RootDeviceName", "description"=>"The name of the root device (for example, /dev/sda1, or/dev/xvda)", "type"=>"string"}, {"in"=>"query", "name"=>"SriovNetSupport", "description"=>"Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI", "type"=>"string"}, {"in"=>"query", "name"=>"VirtualizationType", "description"=>"The type of virtualization", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Image"]}}, "/?Action=RegisterImage"=>{"get"=>{"summary"=>"Register Image", "description"=>"Registers an AMI.", "operationId"=>"registerimage", "x-api-path-slug"=>"actionregisterimage-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The attribute to reset (currently you can only reset the launch permission attribute)", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"ImageId", "description"=>"The ID of the AMI", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Image"]}}, "/?Action=ResetImageAttribute"=>{"get"=>{"summary"=>"Reset Image Attribute", "description"=>"Resets an attribute of an AMI to its default value.", "operationId"=>"resetimageattribute", "x-api-path-slug"=>"actionresetimageattribute-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"ProductCode", "description"=>"The product code", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Image"]}}, "/?Action=ConfirmProductInstance"=>{"get"=>{"summary"=>"Confirm Product Instance", "description"=>"Determines whether a product code is associated with an instance.", "operationId"=>"confirmproductinstance", "x-api-path-slug"=>"actionconfirmproductinstance-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance to bundle", "type"=>"string"}, {"in"=>"query", "name"=>"Storage", "description"=>"The bucket in which to store the AMI", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product Instance"]}}, "/?Action=BundleInstance"=>{"get"=>{"summary"=>"Bundle Instance", "description"=>"Bundles an Amazon instance store-backed Windows instance.", "operationId"=>"bundleinstance", "x-api-path-slug"=>"actionbundleinstance-get", "parameters"=>[{"in"=>"query", "name"=>"BundleId", "description"=>"The ID of the bundle task", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bundle Instance"]}}, "/?Action=CancelBundleTask"=>{"get"=>{"summary"=>"Cancel Bundle Task", "description"=>"Cancels a bundling operation for an instance store-backed Windows instance.", "operationId"=>"cancelbundletask", "x-api-path-slug"=>"actioncancelbundletask-get", "parameters"=>[{"in"=>"query", "name"=>"BundleId.N", "description"=>"One or more bundle task IDs", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bundle Task"]}}, "/?Action=DescribeBundleTasks"=>{"get"=>{"summary"=>"Describe Bundle Tasks", "description"=>"Describes one or more of your bundling tasks.", "operationId"=>"describebundletasks", "x-api-path-slug"=>"actiondescribebundletasks-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC", "type"=>"string"}, {"in"=>"query", "name"=>"SecurityGroupId.N", "description"=>"The ID of one or more of the VPCs security groups", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of a ClassicLink-enabled VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bundle Task"]}}, "/?Action=AttachClassicLinkVpc"=>{"get"=>{"summary"=>"Attach Classic Link Vpc", "description"=>"Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's\n\t\t\tsecurity groups.", "operationId"=>"attachclassiclinkvpc", "x-api-path-slug"=>"actionattachclassiclinkvpc-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId.N", "description"=>"One or more instance IDs", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return for the request in a single page", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to retrieve the next page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC Link"]}}, "/?Action=DescribeClassicLinkInstances"=>{"get"=>{"summary"=>"Describe Classic Link Instances", "description"=>"Describes one or more of your linked EC2-Classic instances.", "operationId"=>"describeclassiclinkinstances", "x-api-path-slug"=>"actiondescribeclassiclinkinstances-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId.N", "description"=>"One or more VPCs for which you want to describe the ClassicLink status", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Instance"]}}, "/?Action=DescribeVpcClassicLink"=>{"get"=>{"summary"=>"Describe Vpc Classic Link", "description"=>"Describes the ClassicLink status of one or more VPCs.", "operationId"=>"describevpcclassiclink", "x-api-path-slug"=>"actiondescribevpcclassiclink-get", "parameters"=>[{"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this request", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"VpcIds.N", "description"=>"One or more VPC IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/?Action=DescribeVpcClassicLinkDnsSupport"=>{"get"=>{"summary"=>"Describe Vpc Classic Link Dns Support", "description"=>"Describes the ClassicLink DNS support status of one or more VPCs.", "operationId"=>"describevpcclassiclinkdnssupport", "x-api-path-slug"=>"actiondescribevpcclassiclinkdnssupport-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance to unlink from the VPC", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC to which the instance is linked", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC DNS"]}}, "/?Action=DetachClassicLinkVpc"=>{"get"=>{"summary"=>"Detach Classic Link Vpc", "description"=>"Unlinks (detaches) a linked EC2-Classic instance from a VPC.", "operationId"=>"detachclassiclinkvpc", "x-api-path-slug"=>"actiondetachclassiclinkvpc-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/?Action=DisableVpcClassicLink"=>{"get"=>{"summary"=>"Disable Vpc Classic Link", "description"=>"Disables ClassicLink for a VPC.", "operationId"=>"disablevpcclassiclink", "x-api-path-slug"=>"actiondisablevpcclassiclink-get", "parameters"=>[{"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/?Action=DisableVpcClassicLinkDnsSupport"=>{"get"=>{"summary"=>"Disable Vpc Classic Link Dns Support", "description"=>"Disables ClassicLink DNS support for a VPC.", "operationId"=>"disablevpcclassiclinkdnssupport", "x-api-path-slug"=>"actiondisablevpcclassiclinkdnssupport-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC DNS"]}}, "/?Action=EnableVpcClassicLink"=>{"get"=>{"summary"=>"Enable Vpc Classic Link", "description"=>"Enables a VPC for ClassicLink.", "operationId"=>"enablevpcclassiclink", "x-api-path-slug"=>"actionenablevpcclassiclink-get", "parameters"=>[{"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/?Action=EnableVpcClassicLinkDnsSupport"=>{"get"=>{"summary"=>"Enable Vpc Classic Link Dns Support", "description"=>"Enables a VPC to support DNS hostname resolution for ClassicLink.", "operationId"=>"enablevpcclassiclinkdnssupport", "x-api-path-slug"=>"actionenablevpcclassiclinkdnssupport-get", "parameters"=>[{"in"=>"query", "name"=>"BgpAsn", "description"=>"For devices that support BGP, the customer gateways BGP ASN", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"IpAddress", "description"=>"The Internet-routable IP address for the customer gateways outside interface", "type"=>"string"}, {"in"=>"query", "name"=>"Type", "description"=>"The type of VPN connection that this customer gateway supports (ipsec", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC NS"]}}, "/?Action=CreateCustomerGateway"=>{"get"=>{"summary"=>"Create Customer Gateway", "description"=>"Provides information to AWS about your VPN customer gateway device.", "operationId"=>"createcustomergateway", "x-api-path-slug"=>"actioncreatecustomergateway-get", "parameters"=>[{"in"=>"query", "name"=>"CustomerGatewayId", "description"=>"The ID of the customer gateway", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gateway"]}}, "/?Action=DeleteCustomerGateway"=>{"get"=>{"summary"=>"Delete Customer Gateway", "description"=>"Deletes the specified customer gateway.", "operationId"=>"deletecustomergateway", "x-api-path-slug"=>"actiondeletecustomergateway-get", "parameters"=>[{"in"=>"query", "name"=>"CustomerGatewayId.N", "description"=>"One or more customer gateway IDs", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer Gateway"]}}, "/?Action=DescribeCustomerGateways"=>{"get"=>{"summary"=>"Describe Customer Gateways", "description"=>"Describes one or more of your VPN customer gateways.", "operationId"=>"describecustomergateways", "x-api-path-slug"=>"actiondescribecustomergateways-get", "parameters"=>[{"in"=>"query", "name"=>"AutoPlacement", "description"=>"This is enabled by default", "type"=>"string"}, {"in"=>"query", "name"=>"AvailabilityZone", "description"=>"The Availability Zone for the Dedicated Hosts", "type"=>"string"}, {"in"=>"query", "name"=>"ClientToken", "description"=>"Unique, case-sensitive identifier you provide to ensure idempotency of the request", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceType", "description"=>"Specify the instance type that you want your Dedicated Hosts to be configured for", "type"=>"string"}, {"in"=>"query", "name"=>"Quantity", "description"=>"The number of Dedicated Hosts you want to allocate to your account with these parameters", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer Gateways"]}}, "/?Action=AllocateHosts"=>{"get"=>{"summary"=>"Allocate Hosts", "description"=>"Allocates a Dedicated Host to your account.", "operationId"=>"allocatehosts", "x-api-path-slug"=>"actionallocatehosts-get", "parameters"=>[{"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"HostId.N", "description"=>"The IDs of the Dedicated Hosts", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return for the request in a single page", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to retrieve the next page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Host"]}}, "/?Action=DescribeHosts"=>{"get"=>{"summary"=>"Describe Hosts", "description"=>"Describes one or more of your Dedicated Hosts.", "operationId"=>"describehosts", "x-api-path-slug"=>"actiondescribehosts-get", "parameters"=>[{"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxDuration", "description"=>"This is the maximum duration of the reservation youd like to purchase, specified in seconds", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return for the request in a single page", "type"=>"string"}, {"in"=>"query", "name"=>"MinDuration", "description"=>"This is the minimum duration of the reservation youd like to purchase, specified in seconds", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to use to retrieve the next page of results", "type"=>"string"}, {"in"=>"query", "name"=>"OfferingId", "description"=>"The ID of the reservation offering", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hosts"]}}, "/?Action=DescribeHostReservationOfferings"=>{"get"=>{"summary"=>"Describe Host Reservation Offerings", "description"=>"Describes the Dedicated Host Reservations that are available to purchase.", "operationId"=>"describehostreservationofferings", "x-api-path-slug"=>"actiondescribehostreservationofferings-get", "parameters"=>[{"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"HostReservationIdSet.N", "description"=>"One or more host reservation IDs", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return for the request in a single page", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to use to retrieve the next page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Host Reservation"]}}, "/?Action=DescribeHostReservations"=>{"get"=>{"summary"=>"Describe Host Reservations", "description"=>"Describes Dedicated Host Reservations which are associated with Dedicated Hosts in\n your account.", "operationId"=>"describehostreservations", "x-api-path-slug"=>"actiondescribehostreservations-get", "parameters"=>[{"in"=>"query", "name"=>"HostIdSet.N", "description"=>"The ID/s of the Dedicated Host/s that the reservation will be associated with", "type"=>"string"}, {"in"=>"query", "name"=>"OfferingId", "description"=>"The offering ID of the reservation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Host Reservation"]}}, "/?Action=GetHostReservationPurchasePreview"=>{"get"=>{"summary"=>"Get Host Reservation Purchase Preview", "description"=>"Preview a reservation purchase with configurations that match those of your\n Dedicated Host.", "operationId"=>"gethostreservationpurchasepreview", "x-api-path-slug"=>"actiongethostreservationpurchasepreview-get", "parameters"=>[{"in"=>"query", "name"=>"AutoPlacement", "description"=>"Specify whether to enable or disable auto-placement", "type"=>"string"}, {"in"=>"query", "name"=>"HostId.N", "description"=>"The host IDs of the Dedicated Hosts you want to modify", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Host Reservation"]}}, "/?Action=ModifyHosts"=>{"get"=>{"summary"=>"Modify Hosts", "description"=>"Modify the auto-placement setting of a Dedicated Host.", "operationId"=>"modifyhosts", "x-api-path-slug"=>"actionmodifyhosts-get", "parameters"=>[{"in"=>"query", "name"=>"Affinity", "description"=>"The new affinity setting for the instance", "type"=>"string"}, {"in"=>"query", "name"=>"HostId", "description"=>"The ID of the Dedicated Host that the instance will have affinity with", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance that you are modifying", "type"=>"string"}, {"in"=>"query", "name"=>"Tenancy", "description"=>"The tenancy of the instance that you are modifying", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hosts"]}}, "/?Action=ModifyInstancePlacement"=>{"get"=>{"summary"=>"Modify Instance Placement", "description"=>"Set the instance affinity value for a specific stopped instance and modify the\n instance tenancy setting.", "operationId"=>"modifyinstanceplacement", "x-api-path-slug"=>"actionmodifyinstanceplacement-get", "parameters"=>[{"in"=>"query", "name"=>"ClientToken", "description"=>"Unique, case-sensitive identifier you provide to ensure idempotency of the request", "type"=>"string"}, {"in"=>"query", "name"=>"CurrencyCode", "description"=>"The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified", "type"=>"string"}, {"in"=>"query", "name"=>"HostIdSet.N", "description"=>"The ID/s of the Dedicated Host/s that the reservation will be associated with", "type"=>"string"}, {"in"=>"query", "name"=>"LimitPrice", "description"=>"The specified limit is checked against the total upfront cost of the reservation (calculated as the offerings upfront cost multiplied by the host count)", "type"=>"string"}, {"in"=>"query", "name"=>"OfferingId", "description"=>"The ID of the offering", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Instance"]}}, "/?Action=PurchaseHostReservation"=>{"get"=>{"summary"=>"Purchase Host Reservation", "description"=>"Purchase a reservation with configurations that match those of your Dedicated Host.", "operationId"=>"purchasehostreservation", "x-api-path-slug"=>"actionpurchasehostreservation-get", "parameters"=>[{"in"=>"query", "name"=>"HostId.N", "description"=>"The IDs of the Dedicated Hosts you want to release", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Host Reservation"]}}, "/?Action=ReleaseHosts"=>{"get"=>{"summary"=>"Release Hosts", "description"=>"When you no longer want to use an On-Demand Dedicated Host it can be released.", "operationId"=>"releasehosts", "x-api-path-slug"=>"actionreleasehosts-get", "parameters"=>[{"in"=>"query", "name"=>"DhcpOptionsId", "description"=>"The ID of the DHCP options set, or default to associate no DHCP options with the VPC", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hosts"]}}, "/?Action=AssociateDhcpOptions"=>{"get"=>{"summary"=>"Associate Dhcp Options", "description"=>"Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.", "operationId"=>"associatedhcpoptions", "x-api-path-slug"=>"actionassociatedhcpoptions-get", "parameters"=>[{"in"=>"query", "name"=>"DhcpConfiguration.N", "description"=>"A DHCP configuration option", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DHCP"]}}, "/?Action=CreateDhcpOptions"=>{"get"=>{"summary"=>"Create Dhcp Options", "description"=>"Creates a set of DHCP options for your VPC.", "operationId"=>"createdhcpoptions", "x-api-path-slug"=>"actioncreatedhcpoptions-get", "parameters"=>[{"in"=>"query", "name"=>"DhcpOptionsId", "description"=>"The ID of the DHCP options set", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DHCP"]}}, "/?Action=DeleteDhcpOptions"=>{"get"=>{"summary"=>"Delete Dhcp Options", "description"=>"Deletes the specified set of DHCP options.", "operationId"=>"deletedhcpoptions", "x-api-path-slug"=>"actiondeletedhcpoptions-get", "parameters"=>[{"in"=>"query", "name"=>"DhcpOptionsId.N", "description"=>"The IDs of one or more DHCP options sets", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DHCP"]}}, "/?Action=DescribeDhcpOptions"=>{"get"=>{"summary"=>"Describe Dhcp Options", "description"=>"Describes one or more of your DHCP options sets.", "operationId"=>"describedhcpoptions", "x-api-path-slug"=>"actiondescribedhcpoptions-get", "parameters"=>[{"in"=>"query", "name"=>"Device", "description"=>"The device name to expose to the instance (for example, /dev/sdh or xvdh)", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId", "description"=>"The ID of the EBS volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DHCP"]}}, "/?Action=AttachVolume"=>{"get"=>{"summary"=>"Attach Volume", "description"=>"Attaches an EBS volume to a running or stopped instance and exposes it to the instance with\n the specified device name.", "operationId"=>"attachvolume", "x-api-path-slug"=>"actionattachvolume-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"A description for the EBS snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"DestinationRegion", "description"=>"The destination region to use in the PresignedUrl parameter of a snapshot copy operation", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Encrypted", "description"=>"Specifies whether the destination snapshot should be encrypted", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyId", "description"=>"The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy", "type"=>"string"}, {"in"=>"query", "name"=>"PresignedUrl", "description"=>"The pre-signed URL that facilitates copying an encrypted snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"SourceRegion", "description"=>"The ID of the region that contains the snapshot to be copied", "type"=>"string"}, {"in"=>"query", "name"=>"SourceSnapshotId", "description"=>"The ID of the EBS snapshot to copy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Drive Volume"]}}, "/?Action=CopySnapshot"=>{"get"=>{"summary"=>"Copy Snapshot", "description"=>"Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3.", "operationId"=>"copysnapshot", "x-api-path-slug"=>"actioncopysnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"A description for the snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId", "description"=>"The ID of the EBS volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Drive Snapshot"]}}, "/?Action=CreateSnapshot"=>{"get"=>{"summary"=>"Create Snapshot", "description"=>"Creates a snapshot of an EBS volume and stores it in Amazon S3.", "operationId"=>"createsnapshot", "x-api-path-slug"=>"actioncreatesnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"AvailabilityZone", "description"=>"The Availability Zone in which to create the volume", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Encrypted", "description"=>"Specifies whether the volume should be encrypted", "type"=>"string"}, {"in"=>"query", "name"=>"Iops", "description"=>"Only valid for Provisioned IOPS SSD volumes", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyId", "description"=>"The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume", "type"=>"string"}, {"in"=>"query", "name"=>"Size", "description"=>"The size of the volume, in GiBs", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotId", "description"=>"The snapshot from which to create the volume", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeType", "description"=>"The volume type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshot"]}}, "/?Action=CreateVolume"=>{"get"=>{"summary"=>"Create Volume", "description"=>"Creates an EBS volume that can be attached to an instance in the same Availability Zone.", "operationId"=>"createvolume", "x-api-path-slug"=>"actioncreatevolume-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotId", "description"=>"The ID of the EBS snapshot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume"]}}, "/?Action=DeleteSnapshot"=>{"get"=>{"summary"=>"Delete Snapshot", "description"=>"Deletes the specified snapshot.", "operationId"=>"deletesnapshot", "x-api-path-slug"=>"actiondeletesnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId", "description"=>"The ID of the volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshot"]}}, "/?Action=DeleteVolume"=>{"get"=>{"summary"=>"Delete Volume", "description"=>"Deletes the specified EBS volume.", "operationId"=>"deletevolume", "x-api-path-slug"=>"actiondeletevolume-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The snapshot attribute you would like to view", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotId", "description"=>"The ID of the EBS snapshot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume"]}}, "/?Action=DescribeSnapshotAttribute"=>{"get"=>{"summary"=>"Describe Snapshot Attribute", "description"=>"Describes the specified attribute of the specified snapshot.", "operationId"=>"describesnapshotattribute", "x-api-path-slug"=>"actiondescribesnapshotattribute-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of snapshot results returned by DescribeSnapshots in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter", "type"=>"string"}, {"in"=>"query", "name"=>"Owner.N", "description"=>"Returns the snapshots owned by the specified owner", "type"=>"string"}, {"in"=>"query", "name"=>"RestorableBy.N", "description"=>"One or more AWS accounts IDs that can create volumes from the snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotId.N", "description"=>"One or more snapshot IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Drive Snapshot"]}}, "/?Action=DescribeSnapshots"=>{"get"=>{"summary"=>"Describe Snapshots", "description"=>"Describes one or more of the EBS snapshots available to you.", "operationId"=>"describesnapshots", "x-api-path-slug"=>"actiondescribesnapshots-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The instance attribute", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId", "description"=>"The ID of the volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Drive Snapshot"]}}, "/?Action=DescribeVolumeAttribute"=>{"get"=>{"summary"=>"Describe Volume Attribute", "description"=>"Describes the specified attribute of the specified volume.", "operationId"=>"describevolumeattribute", "x-api-path-slug"=>"actiondescribevolumeattribute-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of volume results returned by DescribeVolumes in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId.N", "description"=>"One or more volume IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volumes"]}}, "/?Action=DescribeVolumes"=>{"get"=>{"summary"=>"Describe Volumes", "description"=>"Describes the specified EBS volumes.", "operationId"=>"describevolumes", "x-api-path-slug"=>"actiondescribevolumes-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of volume results returned by DescribeVolumeStatus in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The NextToken value to include in a future DescribeVolumeStatus request", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId.N", "description"=>"One or more volume IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volumes"]}}, "/?Action=DescribeVolumeStatus"=>{"get"=>{"summary"=>"Describe Volume Status", "description"=>"Describes the status of the specified volumes.", "operationId"=>"describevolumestatus", "x-api-path-slug"=>"actiondescribevolumestatus-get", "parameters"=>[{"in"=>"query", "name"=>"Device", "description"=>"The device name", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Force", "description"=>"Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally)", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId", "description"=>"The ID of the volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume Status"]}}, "/?Action=DetachVolume"=>{"get"=>{"summary"=>"Detach Volume", "description"=>"Detaches an EBS volume from an instance.", "operationId"=>"detachvolume", "x-api-path-slug"=>"actiondetachvolume-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId", "description"=>"The ID of the volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume"]}}, "/?Action=EnableVolumeIO"=>{"get"=>{"summary"=>"Enable Volume I O", "description"=>"Enables I/O operations for a volume that had I/O operations disabled because the data on the\n volume was potentially inconsistent.", "operationId"=>"enablevolumeio", "x-api-path-slug"=>"actionenablevolumeio-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The snapshot attribute to modify", "type"=>"string"}, {"in"=>"query", "name"=>"CreateVolumePermission", "description"=>"A JSON representation of the snapshot attribute modification", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"OperationType", "description"=>"The type of operation to perform to the attribute", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotId", "description"=>"The ID of the snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"UserGroup.N", "description"=>"The group to modify for the snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"UserId.N", "description"=>"The account ID to modify for the snapshot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volumes"]}}, "/?Action=ModifySnapshotAttribute"=>{"get"=>{"summary"=>"Modify Snapshot Attribute", "description"=>"Adds or removes permission settings for the specified snapshot.", "operationId"=>"modifysnapshotattribute", "x-api-path-slug"=>"actionmodifysnapshotattribute-get", "parameters"=>[{"in"=>"query", "name"=>"AutoEnableIO", "description"=>"Indicates whether the volume should be auto-enabled for I/O operations", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId", "description"=>"The ID of the volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshot"]}}, "/?Action=ModifyVolumeAttribute"=>{"get"=>{"summary"=>"Modify Volume Attribute", "description"=>"Modifies a volume attribute.", "operationId"=>"modifyvolumeattribute", "x-api-path-slug"=>"actionmodifyvolumeattribute-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The attribute to reset", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotId", "description"=>"The ID of the snapshot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume"]}}, "/?Action=ResetSnapshotAttribute"=>{"get"=>{"summary"=>"Reset Snapshot Attribute", "description"=>"Resets permission settings for the specified snapshot.", "operationId"=>"resetsnapshotattribute", "x-api-path-slug"=>"actionresetsnapshotattribute-get", "parameters"=>[{"in"=>"query", "name"=>"Domain", "description"=>"Set to vpc to allocate the address for use with instances in a VPC", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshot"]}}, "/?Action=AllocateAddress"=>{"get"=>{"summary"=>"Allocate Address", "description"=>"Acquires an Elastic IP address.", "operationId"=>"allocateaddress", "x-api-path-slug"=>"actionallocateaddress-get", "parameters"=>[{"in"=>"query", "name"=>"AllocationId", "description"=>"[EC2-VPC] The allocation ID", "type"=>"string"}, {"in"=>"query", "name"=>"AllowReassociation", "description"=>"[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"[EC2-VPC] The ID of the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"PrivateIpAddress", "description"=>"[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address", "type"=>"string"}, {"in"=>"query", "name"=>"PublicIp", "description"=>"The Elastic IP address", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Address"]}}, "/?Action=AssociateAddress"=>{"get"=>{"summary"=>"Associate Address", "description"=>"Associates an Elastic IP address with an instance or a network interface.", "operationId"=>"associateaddress", "x-api-path-slug"=>"actionassociateaddress-get", "parameters"=>[{"in"=>"query", "name"=>"AllocationId.N", "description"=>"[EC2-VPC] One or more allocation IDs", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"PublicIp.N", "description"=>"[EC2-Classic] One or more Elastic IP addresses", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Address"]}}, "/?Action=DescribeAddresses"=>{"get"=>{"summary"=>"Describe Addresses", "description"=>"Describes one or more of your Elastic IP addresses.", "operationId"=>"describeaddresses", "x-api-path-slug"=>"actiondescribeaddresses-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return for the request in a single page", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to use to retrieve the next page of results", "type"=>"string"}, {"in"=>"query", "name"=>"PublicIp.N", "description"=>"One or more Elastic IP addresses", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP ADdress"]}}, "/?Action=DescribeMovingAddresses"=>{"get"=>{"summary"=>"Describe Moving Addresses", "description"=>"Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform.", "operationId"=>"describemovingaddresses", "x-api-path-slug"=>"actiondescribemovingaddresses-get", "parameters"=>[{"in"=>"query", "name"=>"AssociationId", "description"=>"[EC2-VPC] The association ID", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"PublicIp", "description"=>"[EC2-Classic] The Elastic IP address", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Address"]}}, "/?Action=DisassociateAddress"=>{"get"=>{"summary"=>"Disassociate Address", "description"=>"Disassociates an Elastic IP address from the instance or network interface it's associated with.", "operationId"=>"disassociateaddress", "x-api-path-slug"=>"actiondisassociateaddress-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"PublicIp", "description"=>"The Elastic IP address", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IIP Address"]}}, "/?Action=MoveAddressToVpc"=>{"get"=>{"summary"=>"Move Address To Vpc", "description"=>"Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform.", "operationId"=>"moveaddresstovpc", "x-api-path-slug"=>"actionmoveaddresstovpc-get", "parameters"=>[{"in"=>"query", "name"=>"AllocationId", "description"=>"[EC2-VPC] The allocation ID", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"PublicIp", "description"=>"[EC2-Classic] The Elastic IP address", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Address"]}}, "/?Action=ReleaseAddress"=>{"get"=>{"summary"=>"Release Address", "description"=>"Releases the specified Elastic IP address.", "operationId"=>"releaseaddress", "x-api-path-slug"=>"actionreleaseaddress-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"PublicIp", "description"=>"The Elastic IP address", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Address"]}}, "/?Action=RestoreAddressToClassic"=>{"get"=>{"summary"=>"Restore Address To Classic", "description"=>"Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform.", "operationId"=>"restoreaddresstoclassic", "x-api-path-slug"=>"actionrestoreaddresstoclassic-get", "parameters"=>[{"in"=>"query", "name"=>"Ipv6AddressCount", "description"=>"The number of IPv6 addresses to assign to the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"Ipv6Addresses.N", "description"=>"One or more specific IPv6 addresses to be assigned to the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The ID of the network interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP ADdress"]}}, "/?Action=AssignIpv6Addresses"=>{"get"=>{"summary"=>"Assign Ipv6 Addresses", "description"=>"Assigns one or more IPv6 addresses to the specified network interface.", "operationId"=>"assignipv6addresses", "x-api-path-slug"=>"actionassignipv6addresses-get", "parameters"=>[{"in"=>"query", "name"=>"AllowReassignment", "description"=>"Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The ID of the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"PrivateIpAddress.N", "description"=>"One or more IP addresses to be assigned as a secondary private IP address to the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"SecondaryPrivateIpAddressCount", "description"=>"The number of secondary IP addresses to assign to the network interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Address"]}}, "/?Action=AssignPrivateIpAddresses"=>{"get"=>{"summary"=>"Assign Private Ip Addresses", "description"=>"Assigns one or more secondary private IP addresses to the specified network interface.", "operationId"=>"assignprivateipaddresses", "x-api-path-slug"=>"actionassignprivateipaddresses-get", "parameters"=>[{"in"=>"query", "name"=>"DeviceIndex", "description"=>"The index of the device for the network interface attachment", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The ID of the network interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Address"]}}, "/?Action=AttachNetworkInterface"=>{"get"=>{"summary"=>"Attach Network Interface", "description"=>"Attaches a network interface to an instance.", "operationId"=>"attachnetworkinterface", "x-api-path-slug"=>"actionattachnetworkinterface-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"A description for the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Ipv6AddressCount", "description"=>"The number of IPv6 addresses to assign to a network interface", "type"=>"string"}, {"in"=>"query", "name"=>"Ipv6Addresses.N", "description"=>"One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet", "type"=>"string"}, {"in"=>"query", "name"=>"PrivateIpAddress", "description"=>"The primary private IPv4 address of the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"PrivateIpAddresses.N", "description"=>"One or more private IPv4 addresses", "type"=>"string"}, {"in"=>"query", "name"=>"SecondaryPrivateIpAddressCount", "description"=>"The number of secondary private IPv4 addresses to assign to a network interface", "type"=>"string"}, {"in"=>"query", "name"=>"SecurityGroupId.N", "description"=>"The IDs of one or more security groups", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetId", "description"=>"The ID of the subnet to associate with the network interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interface"]}}, "/?Action=CreateNetworkInterface"=>{"get"=>{"summary"=>"Create Network Interface", "description"=>"Creates a network interface in the specified subnet.", "operationId"=>"createnetworkinterface", "x-api-path-slug"=>"actioncreatenetworkinterface-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The ID of the network interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interface"]}}, "/?Action=DeleteNetworkInterface"=>{"get"=>{"summary"=>"Delete Network Interface", "description"=>"Deletes the specified network interface.", "operationId"=>"deletenetworkinterface", "x-api-path-slug"=>"actiondeletenetworkinterface-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The attribute of the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The ID of the network interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interface"]}}, "/?Action=DescribeNetworkInterfaceAttribute"=>{"get"=>{"summary"=>"Describe Network Interface Attribute", "description"=>"Describes a network interface attribute.", "operationId"=>"describenetworkinterfaceattribute", "x-api-path-slug"=>"actiondescribenetworkinterfaceattribute-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId.N", "description"=>"One or more network interface IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interface"]}}, "/?Action=DescribeNetworkInterfaces"=>{"get"=>{"summary"=>"Describe Network Interfaces", "description"=>"Describes one or more of your network interfaces.", "operationId"=>"describenetworkinterfaces", "x-api-path-slug"=>"actiondescribenetworkinterfaces-get", "parameters"=>[{"in"=>"query", "name"=>"AttachmentId", "description"=>"The ID of the attachment", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Force", "description"=>"Specifies whether to force a detachment", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interface"]}}, "/?Action=DetachNetworkInterface"=>{"get"=>{"summary"=>"Detach Network Interface", "description"=>"Detaches a network interface from an instance.", "operationId"=>"detachnetworkinterface", "x-api-path-slug"=>"actiondetachnetworkinterface-get", "parameters"=>[{"in"=>"query", "name"=>"Attachment", "description"=>"Information about the interface attachment", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A description for the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The ID of the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"SecurityGroupId.N", "description"=>"Changes the security groups for the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"SourceDestCheck", "description"=>"Indicates whether source/destination checking is enabled", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interface"]}}, "/?Action=ModifyNetworkInterfaceAttribute"=>{"get"=>{"summary"=>"Modify Network Interface Attribute", "description"=>"Modifies the specified network interface attribute.", "operationId"=>"modifynetworkinterfaceattribute", "x-api-path-slug"=>"actionmodifynetworkinterfaceattribute-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The ID of the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"SourceDestCheck", "description"=>"The source/destination checking attribute", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interface"]}}, "/?Action=ResetNetworkInterfaceAttribute"=>{"get"=>{"summary"=>"Reset Network Interface Attribute", "description"=>"Resets a network interface attribute.", "operationId"=>"resetnetworkinterfaceattribute", "x-api-path-slug"=>"actionresetnetworkinterfaceattribute-get", "parameters"=>[{"in"=>"query", "name"=>"Ipv6Addresses.N", "description"=>"The IPv6 addresses to unassign from the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The ID of the network interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Interface"]}}, "/?Action=UnassignIpv6Addresses"=>{"get"=>{"summary"=>"Unassign Ipv6 Addresses", "description"=>"Unassigns one or more IPv6 addresses from a network interface.", "operationId"=>"unassignipv6addresses", "x-api-path-slug"=>"actionunassignipv6addresses-get", "parameters"=>[{"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The ID of the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"PrivateIpAddress.N", "description"=>"The secondary private IP addresses to unassign from the network interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IPv6 Addresses"]}}, "/?Action=UnassignPrivateIpAddresses"=>{"get"=>{"summary"=>"Unassign Private Ip Addresses", "description"=>"Unassigns one or more secondary private IP addresses from a network interface.", "operationId"=>"unassignprivateipaddresses", "x-api-path-slug"=>"actionunassignprivateipaddresses-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The instance attribute", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP ADdress"]}}, "/?Action=DescribeInstanceAttribute"=>{"get"=>{"summary"=>"Describe Instance Attribute", "description"=>"Describes the specified attribute of the specified instance.", "operationId"=>"describeinstanceattribute", "x-api-path-slug"=>"actiondescribeinstanceattribute-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId.N", "description"=>"One or more instance IDs", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return in a single call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to request the next page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Instance"]}}, "/?Action=DescribeInstances"=>{"get"=>{"summary"=>"Describe Instances", "description"=>"Describes one or more of your instances.", "operationId"=>"describeinstances", "x-api-path-slug"=>"actiondescribeinstances-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"IncludeAllInstances", "description"=>"When true, includes the health status for all instances", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId.N", "description"=>"One or more instance IDs", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return in a single call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to retrieve the next page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Instance"]}}, "/?Action=DescribeInstanceStatus"=>{"get"=>{"summary"=>"Describe Instance Status", "description"=>"Describes the status of one or more instances.", "operationId"=>"describeinstancestatus", "x-api-path-slug"=>"actiondescribeinstancestatus-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Instance Status"]}}, "/?Action=GetConsoleOutput"=>{"get"=>{"summary"=>"Get Console Output", "description"=>"Gets the console output for the specified instance.", "operationId"=>"getconsoleoutput", "x-api-path-slug"=>"actiongetconsoleoutput-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"WakeUp", "description"=>"When set to true, acts as keystroke input and wakes up an instance thats in standby or sleep mode", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Console Output"]}}, "/?Action=GetConsoleScreenshot"=>{"get"=>{"summary"=>"Get Console Screenshot", "description"=>"Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.", "operationId"=>"getconsolescreenshot", "x-api-path-slug"=>"actiongetconsolescreenshot-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the Windows instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Console Screenshot"]}}, "/?Action=GetPasswordData"=>{"get"=>{"summary"=>"Get Password Data", "description"=>"Retrieves the encrypted administrator password for an instance running Windows.", "operationId"=>"getpassworddata", "x-api-path-slug"=>"actiongetpassworddata-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The name of the attribute", "type"=>"string"}, {"in"=>"query", "name"=>"BlockDeviceMapping.N", "description"=>"Modifies the DeleteOnTermination attribute for volumesthat are currently attached", "type"=>"string"}, {"in"=>"query", "name"=>"DisableApiTermination", "description"=>"If the value is true, you cant terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"EbsOptimized", "description"=>"Specifies whether the instance is optimized for EBS I/O", "type"=>"string"}, {"in"=>"query", "name"=>"EnaSupport", "description"=>"Set to true to enable enhanced networking with ENA for the instance", "type"=>"string"}, {"in"=>"query", "name"=>"GroupId.N", "description"=>"[EC2-VPC] Changes the security groups of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceInitiatedShutdownBehavior", "description"=>"Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown)", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceType", "description"=>"Changes the instance type to the specified value", "type"=>"string"}, {"in"=>"query", "name"=>"Kernel", "description"=>"Changes the instances kernel to the specified value", "type"=>"string"}, {"in"=>"query", "name"=>"Ramdisk", "description"=>"Changes the instances RAM disk to the specified value", "type"=>"string"}, {"in"=>"query", "name"=>"SourceDestCheck", "description"=>"Specifies whether source/destination checking is enabled", "type"=>"string"}, {"in"=>"query", "name"=>"SriovNetSupport", "description"=>"Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance", "type"=>"string"}, {"in"=>"query", "name"=>"UserData", "description"=>"Changes the instances user data to the specified value", "type"=>"string"}, {"in"=>"query", "name"=>"Value", "description"=>"A new value for the attribute", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Password Data"]}}, "/?Action=ModifyInstanceAttribute"=>{"get"=>{"summary"=>"Modify Instance Attribute", "description"=>"Modifies the specified attribute of the specified instance.", "operationId"=>"modifyinstanceattribute", "x-api-path-slug"=>"actionmodifyinstanceattribute-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId.N", "description"=>"One or more instance IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Instance"]}}, "/?Action=MonitorInstances"=>{"get"=>{"summary"=>"Monitor Instances", "description"=>"Enables detailed monitoring for a running instance.", "operationId"=>"monitorinstances", "x-api-path-slug"=>"actionmonitorinstances-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId.N", "description"=>"One or more instance IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitor Instance"]}}, "/?Action=RebootInstances"=>{"get"=>{"summary"=>"Reboot Instances", "description"=>"Requests a reboot of one or more instances.", "operationId"=>"rebootinstances", "x-api-path-slug"=>"actionrebootinstances-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"Descriptive text about the health state of your instance", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"EndTime", "description"=>"The time at which the reported instance health state ended", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId.N", "description"=>"One or more instances", "type"=>"string"}, {"in"=>"query", "name"=>"ReasonCode.N", "description"=>"One or more reason codes that describes the health state of your instance", "type"=>"string"}, {"in"=>"query", "name"=>"StartTime", "description"=>"The time at which the reported instance health state began", "type"=>"string"}, {"in"=>"query", "name"=>"Status", "description"=>"The status of all instances listed", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/?Action=ReportInstanceStatus"=>{"get"=>{"summary"=>"Report Instance Status", "description"=>"Submits feedback about the status of an instance.", "operationId"=>"reportinstancestatus", "x-api-path-slug"=>"actionreportinstancestatus-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The attribute to reset", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Instance"]}}, "/?Action=ResetInstanceAttribute"=>{"get"=>{"summary"=>"Reset Instance Attribute", "description"=>"Resets an attribute of an instance to its default value.", "operationId"=>"resetinstanceattribute", "x-api-path-slug"=>"actionresetinstanceattribute-get", "parameters"=>[{"in"=>"query", "name"=>"AdditionalInfo", "description"=>"Reserved", "type"=>"string"}, {"in"=>"query", "name"=>"BlockDeviceMapping.N", "description"=>"The block device mapping", "type"=>"string"}, {"in"=>"query", "name"=>"ClientToken", "description"=>"Unique, case-sensitive identifier you provide to ensure the idempotency of the request", "type"=>"string"}, {"in"=>"query", "name"=>"DisableApiTermination", "description"=>"If you set this parameter to true, you cant terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"EbsOptimized", "description"=>"Indicates whether the instance is optimized for EBS I/O", "type"=>"string"}, {"in"=>"query", "name"=>"IamInstanceProfile", "description"=>"The IAM instance profile", "type"=>"string"}, {"in"=>"query", "name"=>"ImageId", "description"=>"The ID of the AMI, which you can get by calling DescribeImages", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceInitiatedShutdownBehavior", "description"=>"Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown)", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceType", "description"=>"The instance type", "type"=>"string"}, {"in"=>"query", "name"=>"Ipv6Address.N", "description"=>"[EC2-VPC] Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network interface", "type"=>"string"}, {"in"=>"query", "name"=>"Ipv6AddressCount", "description"=>"[EC2-VPC] A number of IPv6 addresses to associate with the primary network interface", "type"=>"string"}, {"in"=>"query", "name"=>"KernelId", "description"=>"The ID of the kernel", "type"=>"string"}, {"in"=>"query", "name"=>"KeyName", "description"=>"The name of the key pair", "type"=>"string"}, {"in"=>"query", "name"=>"MaxCount", "description"=>"The maximum number of instances to launch", "type"=>"string"}, {"in"=>"query", "name"=>"MinCount", "description"=>"The minimum number of instances to launch", "type"=>"string"}, {"in"=>"query", "name"=>"Monitoring", "description"=>"The monitoring for the instance", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterface.N", "description"=>"One or more network interfaces", "type"=>"string"}, {"in"=>"query", "name"=>"Placement", "description"=>"The placement for the instance", "type"=>"string"}, {"in"=>"query", "name"=>"PrivateIpAddress", "description"=>"[EC2-VPC] The primary IPv4 address", "type"=>"string"}, {"in"=>"query", "name"=>"RamdiskId", "description"=>"The ID of the RAM disk", "type"=>"string"}, {"in"=>"query", "name"=>"SecurityGroup.N", "description"=>"[EC2-Classic, default VPC] One or more security group names", "type"=>"string"}, {"in"=>"query", "name"=>"SecurityGroupId.N", "description"=>"One or more security group IDs", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetId", "description"=>"[EC2-VPC] The ID of the subnet to launch the instance into", "type"=>"string"}, {"in"=>"query", "name"=>"UserData", "description"=>"The user data to make available to the instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Instance"]}}, "/?Action=RunInstances"=>{"get"=>{"summary"=>"Run Instances", "description"=>"Launches the specified number of instances using an AMI for which you have\n permissions.", "operationId"=>"runinstances", "x-api-path-slug"=>"actionruninstances-get", "parameters"=>[{"in"=>"query", "name"=>"AdditionalInfo", "description"=>"Reserved", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId.N", "description"=>"One or more instance IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Instances"]}}, "/?Action=StartInstances"=>{"get"=>{"summary"=>"Start Instances", "description"=>"Starts an Amazon EBS-backed AMI that you've previously stopped.", "operationId"=>"startinstances", "x-api-path-slug"=>"actionstartinstances-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Force", "description"=>"Forces the instances to stop", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId.N", "description"=>"One or more instance IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Instances"]}}, "/?Action=StopInstances"=>{"get"=>{"summary"=>"Stop Instances", "description"=>"Stops an Amazon EBS-backed instance.", "operationId"=>"stopinstances", "x-api-path-slug"=>"actionstopinstances-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId.N", "description"=>"One or more instance IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Instances"]}}, "/?Action=TerminateInstances"=>{"get"=>{"summary"=>"Terminate Instances", "description"=>"Shuts down one or more instances.", "operationId"=>"terminateinstances", "x-api-path-slug"=>"actionterminateinstances-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId.N", "description"=>"One or more instance IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Terminal Instances"]}}, "/?Action=UnmonitorInstances"=>{"get"=>{"summary"=>"Unmonitor Instances", "description"=>"Disables detailed monitoring for a running instance.", "operationId"=>"unmonitorinstances", "x-api-path-slug"=>"actionunmonitorinstances-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InternetGatewayId", "description"=>"The ID of the Internet gateway", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Instance"]}}, "/?Action=AttachInternetGateway"=>{"get"=>{"summary"=>"Attach Internet Gateway", "description"=>"Attaches an Internet gateway to a VPC, enabling connectivity between the Internet\n\t\t\t\tand the VPC.", "operationId"=>"attachinternetgateway", "x-api-path-slug"=>"actionattachinternetgateway-get", "parameters"=>[{"in"=>"query", "name"=>"ClientToken", "description"=>"Unique, case-sensitive identifier you provide to ensure the idempotency of the request", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC for which to create the egress-only Internet gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet Gateway"]}}, "/?Action=CreateEgressOnlyInternetGateway"=>{"get"=>{"summary"=>"Create Egress Only Internet Gateway", "description"=>"[IPv6 only] Creates an egress-only Internet gateway for your VPC.", "operationId"=>"createegressonlyinternetgateway", "x-api-path-slug"=>"actioncreateegressonlyinternetgateway-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet Gateway"]}}, "/?Action=CreateInternetGateway"=>{"get"=>{"summary"=>"Create Internet Gateway", "description"=>"Creates an Internet gateway for use with a VPC.", "operationId"=>"createinternetgateway", "x-api-path-slug"=>"actioncreateinternetgateway-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"EgressOnlyInternetGatewayId", "description"=>"The ID of the egress-only Internet gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet Gateway"]}}, "/?Action=DeleteEgressOnlyInternetGateway"=>{"get"=>{"summary"=>"Delete Egress Only Internet Gateway", "description"=>"Deletes an egress-only Internet gateway.", "operationId"=>"deleteegressonlyinternetgateway", "x-api-path-slug"=>"actiondeleteegressonlyinternetgateway-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InternetGatewayId", "description"=>"The ID of the Internet gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet Gateway"]}}, "/?Action=DeleteInternetGateway"=>{"get"=>{"summary"=>"Delete Internet Gateway", "description"=>"Deletes the specified Internet gateway.", "operationId"=>"deleteinternetgateway", "x-api-path-slug"=>"actiondeleteinternetgateway-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"EgressOnlyInternetGatewayId.N", "description"=>"One or more egress-only Internet gateway IDs", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return for the request in a single page", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to retrieve the next page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet Gateway"]}}, "/?Action=DescribeEgressOnlyInternetGateways"=>{"get"=>{"summary"=>"Describe Egress Only Internet Gateways", "description"=>"Describes one or more of your egress-only Internet gateways.", "operationId"=>"describeegressonlyinternetgateways", "x-api-path-slug"=>"actiondescribeegressonlyinternetgateways-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"InternetGatewayId.N", "description"=>"One or more Internet gateway IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet Gateway"]}}, "/?Action=DescribeInternetGateways"=>{"get"=>{"summary"=>"Describe Internet Gateways", "description"=>"Describes one or more of your Internet gateways.", "operationId"=>"describeinternetgateways", "x-api-path-slug"=>"actiondescribeinternetgateways-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InternetGatewayId", "description"=>"The ID of the Internet gateway", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet Gateways"]}}, "/?Action=DetachInternetGateway"=>{"get"=>{"summary"=>"Detach Internet Gateway", "description"=>"Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC.", "operationId"=>"detachinternetgateway", "x-api-path-slug"=>"actiondetachinternetgateway-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"KeyName", "description"=>"A unique name for the key pair", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet Gateway"]}}, "/?Action=CreateKeyPair"=>{"get"=>{"summary"=>"Create Key Pair", "description"=>"Creates a 2048-bit RSA key pair with the specified name.", "operationId"=>"createkeypair", "x-api-path-slug"=>"actioncreatekeypair-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"KeyName", "description"=>"The name of the key pair", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key Pair"]}}, "/?Action=DeleteKeyPair"=>{"get"=>{"summary"=>"Delete Key Pair", "description"=>"Deletes the specified key pair, by removing the public key from Amazon EC2.", "operationId"=>"deletekeypair", "x-api-path-slug"=>"actiondeletekeypair-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"KeyName.N", "description"=>"One or more key pair names", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key Pair"]}}, "/?Action=DescribeKeyPairs"=>{"get"=>{"summary"=>"Describe Key Pairs", "description"=>"Describes one or more of your key pairs.", "operationId"=>"describekeypairs", "x-api-path-slug"=>"actiondescribekeypairs-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"KeyName", "description"=>"A unique name for the key pair", "type"=>"string"}, {"in"=>"query", "name"=>"PublicKeyMaterial", "description"=>"The public key", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key Paris"]}}, "/?Action=ImportKeyPair"=>{"get"=>{"summary"=>"Import Key Pair", "description"=>"Imports the public key from an RSA key pair that you created with a third-party tool.", "operationId"=>"importkeypair", "x-api-path-slug"=>"actionimportkeypair-get", "parameters"=>[{"in"=>"query", "name"=>"AllocationId", "description"=>"The allocation ID of an Elastic IP address to associate with the NAT gateway", "type"=>"string"}, {"in"=>"query", "name"=>"ClientToken", "description"=>"Unique, case-sensitive identifier you provide to ensure the idempotency of the request", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetId", "description"=>"The subnet in which to create the NAT gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key Pair"]}}, "/?Action=CreateNatGateway"=>{"get"=>{"summary"=>"Create Nat Gateway", "description"=>"Creates a NAT gateway in the specified subnet.", "operationId"=>"createnatgateway", "x-api-path-slug"=>"actioncreatenatgateway-get", "parameters"=>[{"in"=>"query", "name"=>"NatGatewayId", "description"=>"The ID of the NAT gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gateway"]}}, "/?Action=DeleteNatGateway"=>{"get"=>{"summary"=>"Delete Nat Gateway", "description"=>"Deletes the specified NAT gateway.", "operationId"=>"deletenatgateway", "x-api-path-slug"=>"actiondeletenatgateway-get", "parameters"=>[{"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this request", "type"=>"string"}, {"in"=>"query", "name"=>"NatGatewayId.N", "description"=>"One or more NAT gateway IDs", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to retrieve the next page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gateway"]}}, "/?Action=DescribeNatGateways"=>{"get"=>{"summary"=>"Describe Nat Gateways", "description"=>"Describes one or more of the your NAT gateways.", "operationId"=>"describenatgateways", "x-api-path-slug"=>"actiondescribenatgateways-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["NAT Gateways"]}}, "/?Action=CreateNetworkAcl"=>{"get"=>{"summary"=>"Create Network Acl", "description"=>"Creates a network ACL in a VPC.", "operationId"=>"createnetworkacl", "x-api-path-slug"=>"actioncreatenetworkacl-get", "parameters"=>[{"in"=>"query", "name"=>"CidrBlock", "description"=>"The IPv4 network range to allow or deny, in CIDR notation (for example 172", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Egress", "description"=>"Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet)", "type"=>"string"}, {"in"=>"query", "name"=>"Icmp", "description"=>"ICMP protocol: The ICMP or ICMPv6 type and code", "type"=>"string"}, {"in"=>"query", "name"=>"Ipv6CidrBlock", "description"=>"The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64)", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkAclId", "description"=>"The ID of the network ACL", "type"=>"string"}, {"in"=>"query", "name"=>"PortRange", "description"=>"TCP or UDP protocols: The range of ports the rule applies to", "type"=>"string"}, {"in"=>"query", "name"=>"Protocol", "description"=>"The protocol", "type"=>"string"}, {"in"=>"query", "name"=>"RuleAction", "description"=>"Indicates whether to allow or deny the traffic that matches the rule", "type"=>"string"}, {"in"=>"query", "name"=>"RuleNumber", "description"=>"The rule number for the entry (for example, 100)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC ACL"]}}, "/?Action=CreateNetworkAclEntry"=>{"get"=>{"summary"=>"Create Network Acl Entry", "description"=>"Creates an entry (a rule) in a network ACL with the specified rule number.", "operationId"=>"createnetworkaclentry", "x-api-path-slug"=>"actioncreatenetworkaclentry-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkAclId", "description"=>"The ID of the network ACL", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC ACL"]}}, "/?Action=DeleteNetworkAcl"=>{"get"=>{"summary"=>"Delete Network Acl", "description"=>"Deletes the specified network ACL.", "operationId"=>"deletenetworkacl", "x-api-path-slug"=>"actiondeletenetworkacl-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Egress", "description"=>"Indicates whether the rule is an egress rule", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkAclId", "description"=>"The ID of the network ACL", "type"=>"string"}, {"in"=>"query", "name"=>"RuleNumber", "description"=>"The rule number of the entry to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network ACL"]}}, "/?Action=DeleteNetworkAclEntry"=>{"get"=>{"summary"=>"Delete Network Acl Entry", "description"=>"Deletes the specified ingress or egress entry (rule) from the specified network ACL.", "operationId"=>"deletenetworkaclentry", "x-api-path-slug"=>"actiondeletenetworkaclentry-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkAclId.N", "description"=>"One or more network ACL IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network ACL"]}}, "/?Action=DescribeNetworkAcls"=>{"get"=>{"summary"=>"Describe Network Acls", "description"=>"Describes one or more of your network ACLs.", "operationId"=>"describenetworkacls", "x-api-path-slug"=>"actiondescribenetworkacls-get", "parameters"=>[{"in"=>"query", "name"=>"AssociationId", "description"=>"The ID of the current association between the original network ACL and the subnet", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkAclId", "description"=>"The ID of the new network ACL to associate with the subnet", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network ACL"]}}, "/?Action=ReplaceNetworkAclAssociation"=>{"get"=>{"summary"=>"Replace Network Acl Association", "description"=>"Changes which network ACL a subnet is associated with.", "operationId"=>"replacenetworkaclassociation", "x-api-path-slug"=>"actionreplacenetworkaclassociation-get", "parameters"=>[{"in"=>"query", "name"=>"CidrBlock", "description"=>"The IPv4 network range to allow or deny, in CIDR notation (for example 172", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Egress", "description"=>"Indicates whether to replace the egress rule", "type"=>"string"}, {"in"=>"query", "name"=>"Icmp", "description"=>"ICMP protocol: The ICMP or ICMPv6 type and code", "type"=>"string"}, {"in"=>"query", "name"=>"Ipv6CidrBlock", "description"=>"The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64)", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkAclId", "description"=>"The ID of the ACL", "type"=>"string"}, {"in"=>"query", "name"=>"PortRange", "description"=>"TCP or UDP protocols: The range of ports the rule applies to", "type"=>"string"}, {"in"=>"query", "name"=>"Protocol", "description"=>"The IP protocol", "type"=>"string"}, {"in"=>"query", "name"=>"RuleAction", "description"=>"Indicates whether to allow or deny the traffic that matches the rule", "type"=>"string"}, {"in"=>"query", "name"=>"RuleNumber", "description"=>"The rule number of the entry to replace", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network ACL"]}}, "/?Action=ReplaceNetworkAclEntry"=>{"get"=>{"summary"=>"Replace Network Acl Entry", "description"=>"Replaces an entry (rule) in a network ACL.", "operationId"=>"replacenetworkaclentry", "x-api-path-slug"=>"actionreplacenetworkaclentry-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"GroupName", "description"=>"A name for the placement group", "type"=>"string"}, {"in"=>"query", "name"=>"Strategy", "description"=>"The placement strategy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network ACL"]}}, "/?Action=CreatePlacementGroup"=>{"get"=>{"summary"=>"Create Placement Group", "description"=>"Creates a placement group that you launch cluster instances into.", "operationId"=>"createplacementgroup", "x-api-path-slug"=>"actioncreateplacementgroup-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"GroupName", "description"=>"The name of the placement group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Placement Group"]}}, "/?Action=DeletePlacementGroup"=>{"get"=>{"summary"=>"Delete Placement Group", "description"=>"Deletes the specified placement group.", "operationId"=>"deleteplacementgroup", "x-api-path-slug"=>"actiondeleteplacementgroup-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"GroupName.N", "description"=>"One or more placement group names", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Placement Group"]}}, "/?Action=DescribePlacementGroups"=>{"get"=>{"summary"=>"Describe Placement Groups", "description"=>"Describes one or more of your placement groups.", "operationId"=>"describeplacementgroups", "x-api-path-slug"=>"actiondescribeplacementgroups-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"ZoneName.N", "description"=>"The names of one or more Availability Zones", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Placement Groups"]}}, "/?Action=DescribeAvailabilityZones"=>{"get"=>{"summary"=>"Describe Availability Zones", "description"=>"Describes one or more of the Availability Zones that are available to you.", "operationId"=>"describeavailabilityzones", "x-api-path-slug"=>"actiondescribeavailabilityzones-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"RegionName.N", "description"=>"The names of one or more regions", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availability Zones"]}}, "/?Action=DescribeRegions"=>{"get"=>{"summary"=>"Describe Regions", "description"=>"Describes one or more regions that are currently available to you.", "operationId"=>"describeregions", "x-api-path-slug"=>"actiondescriberegions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions"]}}, "/?Action=AcceptReservedInstancesExchangeQuote"=>{"get"=>{"summary"=>"Accept Reserved Instances Exchange Quote", "description"=>"Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.", "operationId"=>"acceptreservedinstancesexchangequote", "x-api-path-slug"=>"actionacceptreservedinstancesexchangequote-get", "parameters"=>[{"in"=>"query", "name"=>"ReservedInstancesListingId", "description"=>"The ID of the Reserved Instance listing", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reserved Instances"]}}, "/?Action=CancelReservedInstancesListing"=>{"get"=>{"summary"=>"Cancel Reserved Instances Listing", "description"=>"Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.", "operationId"=>"cancelreservedinstanceslisting", "x-api-path-slug"=>"actioncancelreservedinstanceslisting-get", "parameters"=>[{"in"=>"query", "name"=>"ClientToken", "description"=>"Unique, case-sensitive identifier you provide to ensure idempotency of yourlistings", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceCount", "description"=>"The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace", "type"=>"string"}, {"in"=>"query", "name"=>"PriceSchedules.N", "description"=>"A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedInstancesId", "description"=>"The ID of the active Standard Reserved Instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reserved Instance"]}}, "/?Action=CreateReservedInstancesListing"=>{"get"=>{"summary"=>"Create Reserved Instances Listing", "description"=>"Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance\n\t\t\tMarketplace.", "operationId"=>"createreservedinstanceslisting", "x-api-path-slug"=>"actioncreatereservedinstanceslisting-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"OfferingClass", "description"=>"Describes whether the Reserved Instance is Standard or Convertible", "type"=>"string"}, {"in"=>"query", "name"=>"OfferingType", "description"=>"The Reserved Instance offering type", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedInstancesId.N", "description"=>"One or more Reserved Instance IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reserved Instance"]}}, "/?Action=DescribeReservedInstances"=>{"get"=>{"summary"=>"Describe Reserved Instances", "description"=>"Describes one or more of the Reserved Instances that you purchased.", "operationId"=>"describereservedinstances", "x-api-path-slug"=>"actiondescribereservedinstances-get", "parameters"=>[{"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedInstancesId", "description"=>"One or more Reserved Instance IDs", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedInstancesListingId", "description"=>"One or more Reserved Instance listing IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reserved Instances"]}}, "/?Action=DescribeReservedInstancesListings"=>{"get"=>{"summary"=>"Describe Reserved Instances Listings", "description"=>"Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.", "operationId"=>"describereservedinstanceslistings", "x-api-path-slug"=>"actiondescribereservedinstanceslistings-get", "parameters"=>[{"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to retrieve the next page of results", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedInstancesModificationId.N", "description"=>"IDs for the submitted modification request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reserved Instances"]}}, "/?Action=DescribeReservedInstancesModifications"=>{"get"=>{"summary"=>"Describe Reserved Instances Modifications", "description"=>"Describes the modifications made to your Reserved Instances.", "operationId"=>"describereservedinstancesmodifications", "x-api-path-slug"=>"actiondescribereservedinstancesmodifications-get", "parameters"=>[{"in"=>"query", "name"=>"AvailabilityZone", "description"=>"The Availability Zone in which the Reserved Instance can be used", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"IncludeMarketplace", "description"=>"Include Reserved Instance Marketplace offerings in the response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceTenancy", "description"=>"The tenancy of the instances covered by the reservation", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceType", "description"=>"The instance type that the reservation will cover (for example, m1", "type"=>"string"}, {"in"=>"query", "name"=>"MaxDuration", "description"=>"The maximum duration (in seconds) to filter when searching for offerings", "type"=>"string"}, {"in"=>"query", "name"=>"MaxInstanceCount", "description"=>"The maximum number of instances to filter when searching for offerings", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return for the request in a single page", "type"=>"string"}, {"in"=>"query", "name"=>"MinDuration", "description"=>"The minimum duration (in seconds) to filter when searching for offerings", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to retrieve the next page of results", "type"=>"string"}, {"in"=>"query", "name"=>"OfferingClass", "description"=>"The offering class of the Reserved Instance", "type"=>"string"}, {"in"=>"query", "name"=>"OfferingType", "description"=>"The Reserved Instance offering type", "type"=>"string"}, {"in"=>"query", "name"=>"ProductDescription", "description"=>"The Reserved Instance product platform description", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedInstancesOfferingId.N", "description"=>"One or more Reserved Instances offering IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reserved Instances"]}}, "/?Action=DescribeReservedInstancesOfferings"=>{"get"=>{"summary"=>"Describe Reserved Instances Offerings", "description"=>"Describes Reserved Instance offerings that are available for purchase.", "operationId"=>"describereservedinstancesofferings", "x-api-path-slug"=>"actiondescribereservedinstancesofferings-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedInstanceId.N", "description"=>"The IDs of the Convertible Reserved Instances to exchange", "type"=>"string"}, {"in"=>"query", "name"=>"TargetConfiguration.N", "description"=>"The configuration requirements of the Convertible Reserved Instances to exchange for your current Convertible Reserved Instances", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reserved Instances"]}}, "/?Action=GetReservedInstancesExchangeQuote"=>{"get"=>{"summary"=>"Get Reserved Instances Exchange Quote", "description"=>"Returns details about the values and term of your specified Convertible Reserved Instances.", "operationId"=>"getreservedinstancesexchangequote", "x-api-path-slug"=>"actiongetreservedinstancesexchangequote-get", "parameters"=>[{"in"=>"query", "name"=>"ClientToken", "description"=>"A unique, case-sensitive token you provide to ensure idempotency of your modification request", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedInstancesConfigurationSetItemType.N", "description"=>"The configuration settings for the Reserved Instances to modify", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedInstancesId.N", "description"=>"The IDs of the Reserved Instances to modify", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reserved Instances"]}}, "/?Action=ModifyReservedInstances"=>{"get"=>{"summary"=>"Modify Reserved Instances", "description"=>"Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Standard Reserved Instances.", "operationId"=>"modifyreservedinstances", "x-api-path-slug"=>"actionmodifyreservedinstances-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceCount", "description"=>"The number of Reserved Instances to purchase", "type"=>"string"}, {"in"=>"query", "name"=>"LimitPrice", "description"=>"Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedInstancesOfferingId", "description"=>"The ID of the Reserved Instance offering to purchase", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reserved Instance"]}}, "/?Action=PurchaseReservedInstancesOffering"=>{"get"=>{"summary"=>"Purchase Reserved Instances Offering", "description"=>"Purchases a Reserved Instance for use with your account.", "operationId"=>"purchasereservedinstancesoffering", "x-api-path-slug"=>"actionpurchasereservedinstancesoffering-get", "parameters"=>[{"in"=>"query", "name"=>"PrincipalArn", "description"=>"The ARN of the principal, which can be an IAM role, IAM user, or the root user", "type"=>"string"}, {"in"=>"query", "name"=>"Resource", "description"=>"The type of resource: instance | reservation | snapshot | volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reserved Instance"]}}, "/?Action=DescribeIdentityIdFormat"=>{"get"=>{"summary"=>"Describe Identity Id Format", "description"=>"Describes the ID format settings for resources for the specified IAM user, IAM role, or root\n user.", "operationId"=>"describeidentityidformat", "x-api-path-slug"=>"actiondescribeidentityidformat-get", "parameters"=>[{"in"=>"query", "name"=>"Resource", "description"=>"The type of resource: instance | reservation | snapshot | volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Format"]}}, "/?Action=DescribeIdFormat"=>{"get"=>{"summary"=>"Describe Id Format", "description"=>"Describes the ID format settings for your resources on a per-region basis, for example, to view which resource types are enabled for longer IDs.", "operationId"=>"describeidformat", "x-api-path-slug"=>"actiondescribeidformat-get", "parameters"=>[{"in"=>"query", "name"=>"PrincipalArn", "description"=>"The ARN of the principal, which can be an IAM user, IAM role, or the root user", "type"=>"string"}, {"in"=>"query", "name"=>"Resource", "description"=>"The type of resource: instance | reservation | snapshot | volume", "type"=>"string"}, {"in"=>"query", "name"=>"UseLongIds", "description"=>"Indicates whether the resource should use longer IDs (17-character IDs)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Format"]}}, "/?Action=ModifyIdentityIdFormat"=>{"get"=>{"summary"=>"Modify Identity Id Format", "description"=>"Modifies the ID format of a resource for a specified IAM user, IAM role, or the root\n user for an account; or all IAM users, IAM roles, and the root user for an account.", "operationId"=>"modifyidentityidformat", "x-api-path-slug"=>"actionmodifyidentityidformat-get", "parameters"=>[{"in"=>"query", "name"=>"Resource", "description"=>"The type of resource: instance | reservation | snapshot | volume", "type"=>"string"}, {"in"=>"query", "name"=>"UseLongIds", "description"=>"Indicate whether the resource should use longer IDs (17-character IDs)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Format"]}}, "/?Action=ModifyIdFormat"=>{"get"=>{"summary"=>"Modify Id Format", "description"=>"Modifies the ID format for the specified resource on a per-region basis.", "operationId"=>"modifyidformat", "x-api-path-slug"=>"actionmodifyidformat-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"RouteTableId", "description"=>"The ID of the route table", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetId", "description"=>"The ID of the subnet", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Format"]}}, "/?Action=AssociateRouteTable"=>{"get"=>{"summary"=>"Associate Route Table", "description"=>"Associates a subnet with a route table.", "operationId"=>"associateroutetable", "x-api-path-slug"=>"actionassociateroutetable-get", "parameters"=>[{"in"=>"query", "name"=>"DestinationCidrBlock", "description"=>"The IPv4 CIDR address block used for the destination match", "type"=>"string"}, {"in"=>"query", "name"=>"DestinationIpv6CidrBlock", "description"=>"The IPv6 CIDR block used for the destination match", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"EgressOnlyInternetGatewayId", "description"=>"[IPv6 traffic only] The ID of an egress-only Internet gateway", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayId", "description"=>"The ID of an Internet gateway or virtual private gateway attached to your VPC", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of a NAT instance in your VPC", "type"=>"string"}, {"in"=>"query", "name"=>"NatGatewayId", "description"=>"[IPv4 traffic only] The ID of a NAT gateway", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The ID of a network interface", "type"=>"string"}, {"in"=>"query", "name"=>"RouteTableId", "description"=>"The ID of the route table for the route", "type"=>"string"}, {"in"=>"query", "name"=>"VpcPeeringConnectionId", "description"=>"The ID of a VPC peering connection", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Table"]}}, "/?Action=CreateRoute"=>{"get"=>{"summary"=>"Create Route", "description"=>"Creates a route in a route table within a VPC.", "operationId"=>"createroute", "x-api-path-slug"=>"actioncreateroute-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Table"]}}, "/?Action=CreateRouteTable"=>{"get"=>{"summary"=>"Create Route Table", "description"=>"Creates a route table for the specified VPC.", "operationId"=>"createroutetable", "x-api-path-slug"=>"actioncreateroutetable-get", "parameters"=>[{"in"=>"query", "name"=>"DestinationCidrBlock", "description"=>"The IPv4 CIDR range for the route", "type"=>"string"}, {"in"=>"query", "name"=>"DestinationIpv6CidrBlock", "description"=>"The IPv6 CIDR range for the route", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"RouteTableId", "description"=>"The ID of the route table", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Table"]}}, "/?Action=DeleteRoute"=>{"get"=>{"summary"=>"Delete Route", "description"=>"Deletes the specified route from the specified route table.", "operationId"=>"deleteroute", "x-api-path-slug"=>"actiondeleteroute-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"RouteTableId", "description"=>"The ID of the route table", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route"]}}, "/?Action=DeleteRouteTable"=>{"get"=>{"summary"=>"Delete Route Table", "description"=>"Deletes the specified route table.", "operationId"=>"deleteroutetable", "x-api-path-slug"=>"actiondeleteroutetable-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"RouteTableId.N", "description"=>"One or more route table IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Table"]}}, "/?Action=DescribeRouteTables"=>{"get"=>{"summary"=>"Describe Route Tables", "description"=>"Describes one or more of your route tables.", "operationId"=>"describeroutetables", "x-api-path-slug"=>"actiondescriberoutetables-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayId", "description"=>"The ID of the virtual private gateway", "type"=>"string"}, {"in"=>"query", "name"=>"RouteTableId", "description"=>"The ID of the route table", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Tables"]}}, "/?Action=DisableVgwRoutePropagation"=>{"get"=>{"summary"=>"Disable Vgw Route Propagation", "description"=>"Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.", "operationId"=>"disablevgwroutepropagation", "x-api-path-slug"=>"actiondisablevgwroutepropagation-get", "parameters"=>[{"in"=>"query", "name"=>"AssociationId", "description"=>"The association ID representing the current association between the route table and subnet", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Private Gateway"]}}, "/?Action=DisassociateRouteTable"=>{"get"=>{"summary"=>"Disassociate Route Table", "description"=>"Disassociates a subnet from a route table.", "operationId"=>"disassociateroutetable", "x-api-path-slug"=>"actiondisassociateroutetable-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayId", "description"=>"The ID of the virtual private gateway", "type"=>"string"}, {"in"=>"query", "name"=>"RouteTableId", "description"=>"The ID of the route table", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Table"]}}, "/?Action=EnableVgwRoutePropagation"=>{"get"=>{"summary"=>"Enable Vgw Route Propagation", "description"=>"Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.", "operationId"=>"enablevgwroutepropagation", "x-api-path-slug"=>"actionenablevgwroutepropagation-get", "parameters"=>[{"in"=>"query", "name"=>"DestinationCidrBlock", "description"=>"The IPv4 CIDR address block used for the destination match", "type"=>"string"}, {"in"=>"query", "name"=>"DestinationIpv6CidrBlock", "description"=>"The IPv6 CIDR address block used for the destination match", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"EgressOnlyInternetGatewayId", "description"=>"[IPv6 traffic only] The ID of an egress-only Internet gateway", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayId", "description"=>"The ID of an Internet gateway or virtual private gateway", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of a NAT instance in your VPC", "type"=>"string"}, {"in"=>"query", "name"=>"NatGatewayId", "description"=>"[IPv4 traffic only] The ID of a NAT gateway", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The ID of a network interface", "type"=>"string"}, {"in"=>"query", "name"=>"RouteTableId", "description"=>"The ID of the route table", "type"=>"string"}, {"in"=>"query", "name"=>"VpcPeeringConnectionId", "description"=>"The ID of a VPC peering connection", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Private Gateway Route Propogation"]}}, "/?Action=ReplaceRoute"=>{"get"=>{"summary"=>"Replace Route", "description"=>"Replaces an existing route within a route table in a VPC.", "operationId"=>"replaceroute", "x-api-path-slug"=>"actionreplaceroute-get", "parameters"=>[{"in"=>"query", "name"=>"AssociationId", "description"=>"The association ID", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"RouteTableId", "description"=>"The ID of the new route table to associate with the subnet", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route"]}}, "/?Action=ReplaceRouteTableAssociation"=>{"get"=>{"summary"=>"Replace Route Table Association", "description"=>"Changes the route table associated with a given subnet in a VPC.", "operationId"=>"replaceroutetableassociation", "x-api-path-slug"=>"actionreplaceroutetableassociation-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route Table"]}}, "/?Action=DescribeScheduledInstanceAvailability"=>{"get"=>{"summary"=>"Describe Scheduled Instance Availability", "description"=>"Finds available schedules that meet the specified criteria.", "operationId"=>"describescheduledinstanceavailability", "x-api-path-slug"=>"actiondescribescheduledinstanceavailability-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Instance Availability"]}}, "/?Action=DescribeScheduledInstances"=>{"get"=>{"summary"=>"Describe Scheduled Instances", "description"=>"Describes one or more of your Scheduled Instances.", "operationId"=>"describescheduledinstances", "x-api-path-slug"=>"actiondescribescheduledinstances-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scheduled Server Instances"]}}, "/?Action=PurchaseScheduledInstances"=>{"get"=>{"summary"=>"Purchase Scheduled Instances", "description"=>"Purchases one or more Scheduled Instances with the specified schedule.", "operationId"=>"purchasescheduledinstances", "x-api-path-slug"=>"actionpurchasescheduledinstances-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scheduled Instance"]}}, "/?Action=RunScheduledInstances"=>{"get"=>{"summary"=>"Run Scheduled Instances", "description"=>"Launches the specified Scheduled Instances.", "operationId"=>"runscheduledinstances", "x-api-path-slug"=>"actionrunscheduledinstances-get", "parameters"=>[{"in"=>"query", "name"=>"CidrIp", "description"=>"The CIDR IPv4 address range", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"FromPort", "description"=>"The start of port range for the TCP and UDP protocols, or an ICMP type number", "type"=>"string"}, {"in"=>"query", "name"=>"GroupId", "description"=>"The ID of the security group", "type"=>"string"}, {"in"=>"query", "name"=>"IpPermissions.N", "description"=>"A set of IP permissions", "type"=>"string"}, {"in"=>"query", "name"=>"IpProtocol", "description"=>"The IP protocol name or number", "type"=>"string"}, {"in"=>"query", "name"=>"SourceSecurityGroupName", "description"=>"The name of a destination security group", "type"=>"string"}, {"in"=>"query", "name"=>"SourceSecurityGroupOwnerId", "description"=>"The AWS account number for a destination security group", "type"=>"string"}, {"in"=>"query", "name"=>"ToPort", "description"=>"The end of port range for the TCP and UDP protocols, or an ICMP type number", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scheduled Instances"]}}, "/?Action=AuthorizeSecurityGroupEgress (EC2-VPC only)"=>{"get"=>{"summary"=>"Authorize Security Group Egress ( E C2- V P C only)", "description"=>"[EC2-VPC only] Adds one or more egress rules to a security group for use with a VPC.", "operationId"=>"authorizesecuritygroupegress-ec2vpc-only", "x-api-path-slug"=>"actionauthorizesecuritygroupegress-ec2vpc-only-get", "parameters"=>[{"in"=>"query", "name"=>"CidrIp", "description"=>"The CIDR IPv4 address range", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"FromPort", "description"=>"The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number", "type"=>"string"}, {"in"=>"query", "name"=>"GroupId", "description"=>"The ID of the security group", "type"=>"string"}, {"in"=>"query", "name"=>"GroupName", "description"=>"[EC2-Classic, default VPC] The name of the security group", "type"=>"string"}, {"in"=>"query", "name"=>"IpPermissions.N", "description"=>"A set of IP permissions", "type"=>"string"}, {"in"=>"query", "name"=>"IpProtocol", "description"=>"The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers)", "type"=>"string"}, {"in"=>"query", "name"=>"SourceSecurityGroupName", "description"=>"[EC2-Classic, default VPC] The name of the source security group", "type"=>"string"}, {"in"=>"query", "name"=>"SourceSecurityGroupOwnerId", "description"=>"[EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account", "type"=>"string"}, {"in"=>"query", "name"=>"ToPort", "description"=>"The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code number", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Group"]}}, "/?Action=AuthorizeSecurityGroupIngress"=>{"get"=>{"summary"=>"Authorize Security Group Ingress", "description"=>"Adds one or more ingress rules to a security group.", "operationId"=>"authorizesecuritygroupingress", "x-api-path-slug"=>"actionauthorizesecuritygroupingress-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"GroupDescription", "description"=>"A description for the security group", "type"=>"string"}, {"in"=>"query", "name"=>"GroupName", "description"=>"The name of the security group", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"[EC2-VPC] The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Group"]}}, "/?Action=CreateSecurityGroup"=>{"get"=>{"summary"=>"Create Security Group", "description"=>"Creates a security group.", "operationId"=>"createsecuritygroup", "x-api-path-slug"=>"actioncreatesecuritygroup-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"GroupId", "description"=>"The ID of the security group", "type"=>"string"}, {"in"=>"query", "name"=>"GroupName", "description"=>"[EC2-Classic, default VPC] The name of the security group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Group"]}}, "/?Action=DeleteSecurityGroup"=>{"get"=>{"summary"=>"Delete Security Group", "description"=>"Deletes a security group.", "operationId"=>"deletesecuritygroup", "x-api-path-slug"=>"actiondeletesecuritygroup-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"GroupId.N", "description"=>"One or more security group IDs in your account", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Group"]}}, "/?Action=DescribeSecurityGroupReferences (EC2-VPC only)"=>{"get"=>{"summary"=>"Describe Security Group References ( E C2- V P C only)", "description"=>"[EC2-VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.", "operationId"=>"describesecuritygroupreferences-ec2vpc-only", "x-api-path-slug"=>"actiondescribesecuritygroupreferences-ec2vpc-only-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"GroupId.N", "description"=>"One or more security group IDs", "type"=>"string"}, {"in"=>"query", "name"=>"GroupName.N", "description"=>"[EC2-Classic and default VPC only] One or more security group names", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Group"]}}, "/?Action=DescribeSecurityGroups"=>{"get"=>{"summary"=>"Describe Security Groups", "description"=>"Describes one or more of your security groups.", "operationId"=>"describesecuritygroups", "x-api-path-slug"=>"actiondescribesecuritygroups-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this request", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Group"]}}, "/?Action=DescribeStaleSecurityGroups (EC2-VPC only)"=>{"get"=>{"summary"=>"Describe Stale Security Groups ( E C2- V P C only)", "description"=>"[EC2-VPC only] Describes the stale security group rules for security groups in a specified VPC.", "operationId"=>"describestalesecuritygroups-ec2vpc-only", "x-api-path-slug"=>"actiondescribestalesecuritygroups-ec2vpc-only-get", "parameters"=>[{"in"=>"query", "name"=>"CidrIp", "description"=>"The CIDR IP address range", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"FromPort", "description"=>"The start of port range for the TCP and UDP protocols, or an ICMP type number", "type"=>"string"}, {"in"=>"query", "name"=>"GroupId", "description"=>"The ID of the security group", "type"=>"string"}, {"in"=>"query", "name"=>"IpPermissions.N", "description"=>"A set of IP permissions", "type"=>"string"}, {"in"=>"query", "name"=>"IpProtocol", "description"=>"The IP protocol name or number", "type"=>"string"}, {"in"=>"query", "name"=>"SourceSecurityGroupName", "description"=>"The name of a destination security group", "type"=>"string"}, {"in"=>"query", "name"=>"SourceSecurityGroupOwnerId", "description"=>"The AWS account number for a destination security group", "type"=>"string"}, {"in"=>"query", "name"=>"ToPort", "description"=>"The end of port range for the TCP and UDP protocols, or an ICMP type number", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Groups"]}}, "/?Action=RevokeSecurityGroupEgress (EC2-VPC only)"=>{"get"=>{"summary"=>"Revoke Security Group Egress ( E C2- V P C only)", "description"=>"[EC2-VPC only] Removes one or more egress rules from a security group for EC2-VPC.", "operationId"=>"revokesecuritygroupegress-ec2vpc-only", "x-api-path-slug"=>"actionrevokesecuritygroupegress-ec2vpc-only-get", "parameters"=>[{"in"=>"query", "name"=>"CidrIp", "description"=>"The CIDR IP address range", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"FromPort", "description"=>"The start of port range for the TCP and UDP protocols, or an ICMP type number", "type"=>"string"}, {"in"=>"query", "name"=>"GroupId", "description"=>"The ID of the security group", "type"=>"string"}, {"in"=>"query", "name"=>"GroupName", "description"=>"[EC2-Classic, default VPC] The name of the security group", "type"=>"string"}, {"in"=>"query", "name"=>"IpPermissions.N", "description"=>"A set of IP permissions", "type"=>"string"}, {"in"=>"query", "name"=>"IpProtocol", "description"=>"The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers)", "type"=>"string"}, {"in"=>"query", "name"=>"SourceSecurityGroupName", "description"=>"[EC2-Classic, default VPC] The name of the source security group", "type"=>"string"}, {"in"=>"query", "name"=>"SourceSecurityGroupOwnerId", "description"=>"[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account", "type"=>"string"}, {"in"=>"query", "name"=>"ToPort", "description"=>"The end of port range for the TCP and UDP protocols, or an ICMP code number", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Groups"]}}, "/?Action=RevokeSecurityGroupIngress"=>{"get"=>{"summary"=>"Revoke Security Group Ingress", "description"=>"Removes one or more ingress rules from a security group.", "operationId"=>"revokesecuritygroupingress", "x-api-path-slug"=>"actionrevokesecuritygroupingress-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"SpotInstanceRequestId.N", "description"=>"One or more Spot instance request IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Groups"]}}, "/?Action=CancelSpotInstanceRequests"=>{"get"=>{"summary"=>"Cancel Spot Instance Requests", "description"=>"Cancels one or more Spot instance requests.", "operationId"=>"cancelspotinstancerequests", "x-api-path-slug"=>"actioncancelspotinstancerequests-get", "parameters"=>[{"in"=>"query", "name"=>"Bucket", "description"=>"The Amazon S3 bucket in which to store the Spot instance data feed", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Prefix", "description"=>"A prefix for the data feed file names", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spot Instance"]}}, "/?Action=CreateSpotDatafeedSubscription"=>{"get"=>{"summary"=>"Create Spot Datafeed Subscription", "description"=>"Creates a data feed for Spot instances, enabling you to view Spot instance usage logs.", "operationId"=>"createspotdatafeedsubscription", "x-api-path-slug"=>"actioncreatespotdatafeedsubscription-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnet"]}}, "/?Action=DeleteSpotDatafeedSubscription"=>{"get"=>{"summary"=>"Delete Spot Datafeed Subscription", "description"=>"Deletes the data feed for Spot instances.", "operationId"=>"deletespotdatafeedsubscription", "x-api-path-slug"=>"actiondeletespotdatafeedsubscription-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spot Data Feed Subscription"]}}, "/?Action=DescribeSpotDatafeedSubscription"=>{"get"=>{"summary"=>"Describe Spot Datafeed Subscription", "description"=>"Describes the data feed for Spot instances.", "operationId"=>"describespotdatafeedsubscription", "x-api-path-slug"=>"actiondescribespotdatafeedsubscription-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"SpotInstanceRequestId.N", "description"=>"One or more Spot instance request IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spot Data Feed"]}}, "/?Action=DescribeSpotInstanceRequests"=>{"get"=>{"summary"=>"Describe Spot Instance Requests", "description"=>"Describes the Spot instance requests that belong to your account.", "operationId"=>"describespotinstancerequests", "x-api-path-slug"=>"actiondescribespotinstancerequests-get", "parameters"=>[{"in"=>"query", "name"=>"AvailabilityZone", "description"=>"Filters the results by the specified Availability Zone", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"EndTime", "description"=>"The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ)", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceType.N", "description"=>"Filters the results by the specified instance types", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return in a single call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"ProductDescription.N", "description"=>"Filters the results by the specified basic product descriptions", "type"=>"string"}, {"in"=>"query", "name"=>"StartTime", "description"=>"The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spot Instance Requests"]}}, "/?Action=DescribeSpotPriceHistory"=>{"get"=>{"summary"=>"Describe Spot Price History", "description"=>"Describes the Spot price history.", "operationId"=>"describespotpricehistory", "x-api-path-slug"=>"actiondescribespotpricehistory-get", "parameters"=>[{"in"=>"query", "name"=>"AvailabilityZoneGroup", "description"=>"The user-specified name for a logical grouping of bids", "type"=>"string"}, {"in"=>"query", "name"=>"BlockDurationMinutes", "description"=>"The required duration for the Spot instances (also known as Spot blocks), in minutes", "type"=>"string"}, {"in"=>"query", "name"=>"ClientToken", "description"=>"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceCount", "description"=>"The maximum number of Spot instances to launch", "type"=>"string"}, {"in"=>"query", "name"=>"LaunchGroup", "description"=>"The instance launch group", "type"=>"string"}, {"in"=>"query", "name"=>"LaunchSpecification", "description"=>"Describes the launch specification for an instance", "type"=>"string"}, {"in"=>"query", "name"=>"SpotPrice", "description"=>"The maximum hourly price (bid) for any Spot instance launched to fulfill the request", "type"=>"string"}, {"in"=>"query", "name"=>"Type", "description"=>"The Spot instance request type", "type"=>"string"}, {"in"=>"query", "name"=>"ValidFrom", "description"=>"The start date of the request", "type"=>"string"}, {"in"=>"query", "name"=>"ValidUntil", "description"=>"The end date of the request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spot Price History"]}}, "/?Action=RequestSpotInstances"=>{"get"=>{"summary"=>"Request Spot Instances", "description"=>"Creates a Spot instance request.", "operationId"=>"requestspotinstances", "x-api-path-slug"=>"actionrequestspotinstances-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"SpotFleetRequestId.N", "description"=>"The IDs of the Spot fleet requests", "type"=>"string"}, {"in"=>"query", "name"=>"TerminateInstances", "description"=>"Indicates whether to terminate instances for a Spot fleet request if it is canceled successfully", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spot Instance"]}}, "/?Action=CancelSpotFleetRequests"=>{"get"=>{"summary"=>"Cancel Spot Fleet Requests", "description"=>"Cancels the specified Spot fleet requests.", "operationId"=>"cancelspotfleetrequests", "x-api-path-slug"=>"actioncancelspotfleetrequests-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return in a single call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"SpotFleetRequestId", "description"=>"The ID of the Spot fleet request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spot Fleet"]}}, "/?Action=DescribeSpotFleetInstances"=>{"get"=>{"summary"=>"Describe Spot Fleet Instances", "description"=>"Describes the running instances for the specified Spot fleet.", "operationId"=>"describespotfleetinstances", "x-api-path-slug"=>"actiondescribespotfleetinstances-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"EventType", "description"=>"The type of events to describe", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return in a single call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"SpotFleetRequestId", "description"=>"The ID of the Spot fleet request", "type"=>"string"}, {"in"=>"query", "name"=>"StartTime", "description"=>"The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spot Fleet Instance"]}}, "/?Action=DescribeSpotFleetRequestHistory"=>{"get"=>{"summary"=>"Describe Spot Fleet Request History", "description"=>"Describes the events for the specified Spot fleet request during the specified time.", "operationId"=>"describespotfleetrequesthistory", "x-api-path-slug"=>"actiondescribespotfleetrequesthistory-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return in a single call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"SpotFleetRequestId.N", "description"=>"The IDs of the Spot fleet requests", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spot Fleet Request History"]}}, "/?Action=DescribeSpotFleetRequests"=>{"get"=>{"summary"=>"Describe Spot Fleet Requests", "description"=>"Describes your Spot fleet requests.", "operationId"=>"describespotfleetrequests", "x-api-path-slug"=>"actiondescribespotfleetrequests-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sport Fleet Requests"]}}, "/?Action=ModifySpotFleetRequest"=>{"get"=>{"summary"=>"Modify Spot Fleet Request", "description"=>"Modifies the specified Spot fleet request", "operationId"=>"modifyspotfleetrequest", "x-api-path-slug"=>"actionmodifyspotfleetrequest-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"SpotFleetRequestConfig", "description"=>"The configuration for the Spot fleet request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spot Fleet"]}}, "/?Action=RequestSpotFleet"=>{"get"=>{"summary"=>"Request Spot Fleet", "description"=>"Creates a Spot fleet request.", "operationId"=>"requestspotfleet", "x-api-path-slug"=>"actionrequestspotfleet-get", "parameters"=>[{"in"=>"query", "name"=>"Ipv6CidrBlock", "description"=>"The IPv6 CIDR block for your subnet", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetId", "description"=>"The ID of your subnet", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spot Fleet"]}}, "/?Action=AssociateSubnetCidrBlock"=>{"get"=>{"summary"=>"Associate Subnet Cidr Block", "description"=>"Associates a CIDR block with your subnet.", "operationId"=>"associatesubnetcidrblock", "x-api-path-slug"=>"actionassociatesubnetcidrblock-get", "parameters"=>[{"in"=>"query", "name"=>"AvailabilityZone", "description"=>"The Availability Zone for the subnet", "type"=>"string"}, {"in"=>"query", "name"=>"CidrBlock", "description"=>"The IPv4 network range for the subnet, in CIDR notation", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Ipv6CidrBlock", "description"=>"The IPv6 network range for the subnet, in CIDR notation", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CIDR Block"]}}, "/?Action=CreateSubnet"=>{"get"=>{"summary"=>"Create Subnet", "description"=>"Creates a subnet in an existing VPC.", "operationId"=>"createsubnet", "x-api-path-slug"=>"actioncreatesubnet-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetId", "description"=>"The ID of the subnet", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnet"]}}, "/?Action=DeleteSubnet"=>{"get"=>{"summary"=>"Delete Subnet", "description"=>"Deletes the specified subnet.", "operationId"=>"deletesubnet", "x-api-path-slug"=>"actiondeletesubnet-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetId.N", "description"=>"One or more subnet IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnet"]}}, "/?Action=DescribeSubnets"=>{"get"=>{"summary"=>"Describe Subnets", "description"=>"Describes one or more of your subnets.", "operationId"=>"describesubnets", "x-api-path-slug"=>"actiondescribesubnets-get", "parameters"=>[{"in"=>"query", "name"=>"AssociationId", "description"=>"The association ID for the CIDR block", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnets"]}}, "/?Action=DisassociateSubnetCidrBlock"=>{"get"=>{"summary"=>"Disassociate Subnet Cidr Block", "description"=>"Disassociates a CIDR block from a subnet.", "operationId"=>"disassociatesubnetcidrblock", "x-api-path-slug"=>"actiondisassociatesubnetcidrblock-get", "parameters"=>[{"in"=>"query", "name"=>"AssignIpv6AddressOnCreation", "description"=>"Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address", "type"=>"string"}, {"in"=>"query", "name"=>"MapPublicIpOnLaunch", "description"=>"Specify true to indicate that network interfaces created in the specified subnet should be assigned a public IPv4 address", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetId", "description"=>"The ID of the subnet", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CIDR Block"]}}, "/?Action=ModifySubnetAttribute"=>{"get"=>{"summary"=>"Modify Subnet Attribute", "description"=>"Modifies a subnet attribute.", "operationId"=>"modifysubnetattribute", "x-api-path-slug"=>"actionmodifysubnetattribute-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceId.N", "description"=>"The IDs of one or more resources to tag", "type"=>"string"}, {"in"=>"query", "name"=>"Tag.N", "description"=>"One or more tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnet"]}}, "/?Action=CreateTags"=>{"get"=>{"summary"=>"Create Tags", "description"=>"Adds or overwrites one or more tags for the specified Amazon EC2 resource or\n resources.", "operationId"=>"createtags", "x-api-path-slug"=>"actioncreatetags-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceId.N", "description"=>"The ID of the resource", "type"=>"string"}, {"in"=>"query", "name"=>"Tag.N", "description"=>"One or more tags to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=DeleteTags"=>{"get"=>{"summary"=>"Delete Tags", "description"=>"Deletes the specified set of tags from the specified set of resources.", "operationId"=>"deletetags", "x-api-path-slug"=>"actiondeletetags-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return in a single call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to retrieve the next page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=DescribeTags"=>{"get"=>{"summary"=>"Describe Tags", "description"=>"Describes one or more of the tags for your EC2 resources.", "operationId"=>"describetags", "x-api-path-slug"=>"actiondescribetags-get", "parameters"=>[{"in"=>"query", "name"=>"ConversionTaskId", "description"=>"The ID of the conversion task", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"ReasonMessage", "description"=>"The reason for canceling the conversion task", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=CancelConversionTask"=>{"get"=>{"summary"=>"Cancel Conversion Task", "description"=>"Cancels an active conversion task.", "operationId"=>"cancelconversiontask", "x-api-path-slug"=>"actioncancelconversiontask-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bundle Task"]}}, "/?Action=CancelImportTask"=>{"get"=>{"summary"=>"Cancel Import Task", "description"=>"Cancels an in-process import virtual machine or import snapshot task.", "operationId"=>"cancelimporttask", "x-api-path-slug"=>"actioncancelimporttask-get", "parameters"=>[{"in"=>"query", "name"=>"ConversionTaskId.N", "description"=>"One or more conversion task IDs", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import Task"]}}, "/?Action=DescribeConversionTasks"=>{"get"=>{"summary"=>"Describe Conversion Tasks", "description"=>"Describes one or more of your conversion tasks.", "operationId"=>"describeconversiontasks", "x-api-path-slug"=>"actiondescribeconversiontasks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version Tasks"]}}, "/?Action=DescribeImportImageTasks"=>{"get"=>{"summary"=>"Describe Import Image Tasks", "description"=>"Displays details about an import virtual machine or import snapshot tasks that are already created.", "operationId"=>"describeimportimagetasks", "x-api-path-slug"=>"actiondescribeimportimagetasks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import Image Tasks"]}}, "/?Action=DescribeImportSnapshotTasks"=>{"get"=>{"summary"=>"Describe Import Snapshot Tasks", "description"=>"Describes your import snapshot tasks.", "operationId"=>"describeimportsnapshottasks", "x-api-path-slug"=>"actiondescribeimportsnapshottasks-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"A description for the instance being imported", "type"=>"string"}, {"in"=>"query", "name"=>"DiskImage.N", "description"=>"The disk image", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"LaunchSpecification", "description"=>"The launch specification", "type"=>"string"}, {"in"=>"query", "name"=>"Platform", "description"=>"The instance operating system", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import Snapshot Takss"]}}, "/?Action=ImportInstance"=>{"get"=>{"summary"=>"Import Instance", "description"=>"Creates an import instance task using metadata from the specified disk image.", "operationId"=>"importinstance", "x-api-path-slug"=>"actionimportinstance-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/?Action=ImportImage"=>{"get"=>{"summary"=>"Import Image", "description"=>"Displays details about an import virtual machine or import snapshot tasks that are already created.", "operationId"=>"importimage", "x-api-path-slug"=>"actionimportimage-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import Image"]}}, "/?Action=ImportSnapshot"=>{"get"=>{"summary"=>"Import Snapshot", "description"=>"Describes your import snapshot tasks.", "operationId"=>"importsnapshot", "x-api-path-slug"=>"actionimportsnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"AvailabilityZone", "description"=>"The Availability Zone for the resulting EBS volume", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A description of the volume", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Image", "description"=>"The disk image", "type"=>"string"}, {"in"=>"query", "name"=>"Volume", "description"=>"The volume size", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshot"]}}, "/?Action=ImportVolume"=>{"get"=>{"summary"=>"Import Volume", "description"=>"Creates an import volume task using metadata from the specified disk image.", "operationId"=>"importvolume", "x-api-path-slug"=>"actionimportvolume-get", "parameters"=>[{"in"=>"query", "name"=>"ExportTaskId", "description"=>"The ID of the export task", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume"]}}, "/?Action=CancelExportTask"=>{"get"=>{"summary"=>"Cancel Export Task", "description"=>"Cancels an active export task.", "operationId"=>"cancelexporttask", "x-api-path-slug"=>"actioncancelexporttask-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"A description for the conversion task or the resource being exported", "type"=>"string"}, {"in"=>"query", "name"=>"ExportToS3", "description"=>"The format and location for an instance export task", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"TargetEnvironment", "description"=>"The target virtualization environment", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Export Task"]}}, "/?Action=CreateInstanceExportTask"=>{"get"=>{"summary"=>"Create Instance Export Task", "description"=>"Exports a running or stopped instance to an S3 bucket.", "operationId"=>"createinstanceexporttask", "x-api-path-slug"=>"actioncreateinstanceexporttask-get", "parameters"=>[{"in"=>"query", "name"=>"ExportTaskId.N", "description"=>"One or more export task IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Export Task"]}}, "/?Action=DescribeExportTasks"=>{"get"=>{"summary"=>"Describe Export Tasks", "description"=>"Describes one or more of your export tasks.", "operationId"=>"describeexporttasks", "x-api-path-slug"=>"actiondescribeexporttasks-get", "parameters"=>[{"in"=>"query", "name"=>"AmazonProvidedIpv6CidrBlock", "description"=>"Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Export Takss"]}}, "/?Action=AssociateVpcCidrBlock"=>{"get"=>{"summary"=>"Associate Vpc Cidr Block", "description"=>"Associates a CIDR block with your VPC.", "operationId"=>"associatevpccidrblock", "x-api-path-slug"=>"actionassociatevpccidrblock-get", "parameters"=>[{"in"=>"query", "name"=>"AmazonProvidedIpv6CidrBlock", "description"=>"Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC", "type"=>"string"}, {"in"=>"query", "name"=>"CidrBlock", "description"=>"The IPv4 network range for the VPC, in CIDR notation", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceTenancy", "description"=>"The tenancy options for instances launched into the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CIDR Block"]}}, "/?Action=CreateVpc"=>{"get"=>{"summary"=>"Create Vpc", "description"=>"Creates a VPC with the specified IPv4 CIDR block.", "operationId"=>"createvpc", "x-api-path-slug"=>"actioncreatevpc-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/?Action=DeleteVpc"=>{"get"=>{"summary"=>"Delete Vpc", "description"=>"Deletes the specified VPC.", "operationId"=>"deletevpc", "x-api-path-slug"=>"actiondeletevpc-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The VPC attribute", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/?Action=DescribeVpcAttribute"=>{"get"=>{"summary"=>"Describe Vpc Attribute", "description"=>"Describes the specified attribute of the specified VPC.", "operationId"=>"describevpcattribute", "x-api-path-slug"=>"actiondescribevpcattribute-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId.N", "description"=>"One or more VPC IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/?Action=DescribeVpcs"=>{"get"=>{"summary"=>"Describe Vpcs", "description"=>"Describes one or more of your VPCs.", "operationId"=>"describevpcs", "x-api-path-slug"=>"actiondescribevpcs-get", "parameters"=>[{"in"=>"query", "name"=>"AssociationId", "description"=>"The association ID for the CIDR block", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/?Action=DisassociateVpcCidrBlock"=>{"get"=>{"summary"=>"Disassociate Vpc Cidr Block", "description"=>"Disassociates a CIDR block from a VPC.", "operationId"=>"disassociatevpccidrblock", "x-api-path-slug"=>"actiondisassociatevpccidrblock-get", "parameters"=>[{"in"=>"query", "name"=>"EnableDnsHostnames", "description"=>"Indicates whether the instances launched in the VPC get DNS hostnames", "type"=>"string"}, {"in"=>"query", "name"=>"EnableDnsSupport", "description"=>"Indicates whether the DNS resolution is supported for the VPC", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CIDR Block"]}}, "/?Action=ModifyVpcAttribute"=>{"get"=>{"summary"=>"Modify Vpc Attribute", "description"=>"Modifies the specified attribute of the specified VPC.", "operationId"=>"modifyvpcattribute", "x-api-path-slug"=>"actionmodifyvpcattribute-get", "parameters"=>[{"in"=>"query", "name"=>"ClientToken", "description"=>"Unique, case-sensitive identifier you provide to ensure the idempotency of the request", "type"=>"string"}, {"in"=>"query", "name"=>"DeliverLogsPermissionArn", "description"=>"The ARN for the IAM role thats used to post flow logs to a CloudWatch Logs log group", "type"=>"string"}, {"in"=>"query", "name"=>"LogGroupName", "description"=>"The name of the CloudWatch log group", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceId.N", "description"=>"One or more subnet, network interface, or VPC IDs", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceType", "description"=>"The type of resource on which to create the flow log", "type"=>"string"}, {"in"=>"query", "name"=>"TrafficType", "description"=>"The type of traffic to log", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/?Action=CreateFlowLogs"=>{"get"=>{"summary"=>"Create Flow Logs", "description"=>"Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC.", "operationId"=>"createflowlogs", "x-api-path-slug"=>"actioncreateflowlogs-get", "parameters"=>[{"in"=>"query", "name"=>"FlowLogId.N", "description"=>"One or more flow log IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Flow Logs"]}}, "/?Action=DeleteFlowLogs"=>{"get"=>{"summary"=>"Delete Flow Logs", "description"=>"Deletes one or more flow logs.", "operationId"=>"deleteflowlogs", "x-api-path-slug"=>"actiondeleteflowlogs-get", "parameters"=>[{"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"FlowLogId.N", "description"=>"One or more flow log IDs", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return for the request in a single page", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to retrieve the next page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["FLow Logs"]}}, "/?Action=DescribeFlowLogs"=>{"get"=>{"summary"=>"Describe Flow Logs", "description"=>"Describes one or more flow logs.", "operationId"=>"describeflowlogs", "x-api-path-slug"=>"actiondescribeflowlogs-get", "parameters"=>[{"in"=>"query", "name"=>"ClientToken", "description"=>"Unique, case-sensitive identifier you provide to ensure the idempotency of the request", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyDocument", "description"=>"A policy to attach to the endpoint that controls access to the service", "type"=>"string"}, {"in"=>"query", "name"=>"RouteTableId.N", "description"=>"One or more route table IDs", "type"=>"string"}, {"in"=>"query", "name"=>"ServiceName", "description"=>"The AWS service name, in the form com", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC in which the endpoint will be used", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Flow Logs"]}}, "/?Action=CreateVpcEndpoint"=>{"get"=>{"summary"=>"Create Vpc Endpoint", "description"=>"Creates a VPC endpoint for a specified AWS service.", "operationId"=>"createvpcendpoint", "x-api-path-slug"=>"actioncreatevpcendpoint-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpcEndpointId.N", "description"=>"One or more endpoint IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC Endpoint"]}}, "/?Action=DeleteVpcEndpoints"=>{"get"=>{"summary"=>"Delete Vpc Endpoints", "description"=>"Deletes one or more specified VPC endpoints.", "operationId"=>"deletevpcendpoints", "x-api-path-slug"=>"actiondeletevpcendpoints-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this request", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"PrefixListId.N", "description"=>"One or more prefix list IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC Endpoints"]}}, "/?Action=DescribePrefixLists"=>{"get"=>{"summary"=>"Describe Prefix Lists", "description"=>"Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.", "operationId"=>"describeprefixlists", "x-api-path-slug"=>"actiondescribeprefixlists-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this request", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"VpcEndpointId.N", "description"=>"One or more endpoint IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Prefix List"]}}, "/?Action=DescribeVpcEndpoints"=>{"get"=>{"summary"=>"Describe Vpc Endpoints", "description"=>"Describes one or more of your VPC endpoints.", "operationId"=>"describevpcendpoints", "x-api-path-slug"=>"actiondescribevpcendpoints-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this request", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC Endpoints"]}}, "/?Action=DescribeVpcEndpointServices"=>{"get"=>{"summary"=>"Describe Vpc Endpoint Services", "description"=>"Describes all supported AWS services that can be specified when creating a VPC endpoint.", "operationId"=>"describevpcendpointservices", "x-api-path-slug"=>"actiondescribevpcendpointservices-get", "parameters"=>[{"in"=>"query", "name"=>"AddRouteTableId.N", "description"=>"One or more route tables IDs to associate with the endpoint", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyDocument", "description"=>"A policy document to attach to the endpoint", "type"=>"string"}, {"in"=>"query", "name"=>"RemoveRouteTableId.N", "description"=>"One or more route table IDs to disassociate from the endpoint", "type"=>"string"}, {"in"=>"query", "name"=>"ResetPolicy", "description"=>"Specify true to reset the policy document to the default policy", "type"=>"string"}, {"in"=>"query", "name"=>"VpcEndpointId", "description"=>"The ID of the endpoint", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC Endpoint Services"]}}, "/?Action=ModifyVpcEndpoint"=>{"get"=>{"summary"=>"Modify Vpc Endpoint", "description"=>"Modifies attributes of a specified VPC endpoint.", "operationId"=>"modifyvpcendpoint", "x-api-path-slug"=>"actionmodifyvpcendpoint-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpcPeeringConnectionId", "description"=>"The ID of the VPC peering connection", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC Endpoint"]}}, "/?Action=AcceptVpcPeeringConnection"=>{"get"=>{"summary"=>"Accept Vpc Peering Connection", "description"=>"Accept a VPC peering connection request.", "operationId"=>"acceptvpcpeeringconnection", "x-api-path-slug"=>"actionacceptvpcpeeringconnection-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"PeerOwnerId", "description"=>"The AWS account ID of the owner of the peer VPC", "type"=>"string"}, {"in"=>"query", "name"=>"PeerVpcId", "description"=>"The ID of the VPC with which you are creating the VPC peering connection", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the requester VPC", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC Peering Connection"]}}, "/?Action=CreateVpcPeeringConnection"=>{"get"=>{"summary"=>"Create Vpc Peering Connection", "description"=>"Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection.", "operationId"=>"createvpcpeeringconnection", "x-api-path-slug"=>"actioncreatevpcpeeringconnection-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpcPeeringConnectionId", "description"=>"The ID of the VPC peering connection", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC Peering Connection"]}}, "/?Action=DeleteVpcPeeringConnection"=>{"get"=>{"summary"=>"Delete Vpc Peering Connection", "description"=>"Deletes a VPC peering connection.", "operationId"=>"deletevpcpeeringconnection", "x-api-path-slug"=>"actiondeletevpcpeeringconnection-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"VpcPeeringConnectionId.N", "description"=>"One or more VPC peering connection IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC Peering Connection"]}}, "/?Action=DescribeVpcPeeringConnections"=>{"get"=>{"summary"=>"Describe Vpc Peering Connections", "description"=>"Describes one or more of your VPC peering connections.", "operationId"=>"describevpcpeeringconnections", "x-api-path-slug"=>"actiondescribevpcpeeringconnections-get", "parameters"=>[{"in"=>"query", "name"=>"AccepterPeeringConnectionOptions", "description"=>"The VPC peering connection options for the accepter VPC", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"RequesterPeeringConnectionOptions", "description"=>"The VPC peering connection options for the requester VPC", "type"=>"string"}, {"in"=>"query", "name"=>"VpcPeeringConnectionId", "description"=>"The ID of the VPC peering connection", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC Peering Connections"]}}, "/?Action=ModifyVpcPeeringConnectionOptions"=>{"get"=>{"summary"=>"Modify Vpc Peering Connection Options", "description"=>"Modifies the VPC peering connection options on one side of a VPC peering connection.", "operationId"=>"modifyvpcpeeringconnectionoptions", "x-api-path-slug"=>"actionmodifyvpcpeeringconnectionoptions-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpcPeeringConnectionId", "description"=>"The ID of the VPC peering connection", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC Peering Connection"]}}, "/?Action=RejectVpcPeeringConnection"=>{"get"=>{"summary"=>"Reject Vpc Peering Connection", "description"=>"Rejects a VPC peering connection request.", "operationId"=>"rejectvpcpeeringconnection", "x-api-path-slug"=>"actionrejectvpcpeeringconnection-get", "parameters"=>[{"in"=>"query", "name"=>"CustomerGatewayId", "description"=>"The ID of the customer gateway", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Options", "description"=>"Indicates whether the VPN connection requires static routes", "type"=>"string"}, {"in"=>"query", "name"=>"Type", "description"=>"The type of VPN connection (ipsec", "type"=>"string"}, {"in"=>"query", "name"=>"VpnGatewayId", "description"=>"The ID of the virtual private gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC Peering Connection"]}}, "/?Action=CreateVpnConnection"=>{"get"=>{"summary"=>"Create Vpn Connection", "description"=>"Creates a VPN connection between an existing virtual private gateway and a VPN customer\n gateway.", "operationId"=>"createvpnconnection", "x-api-path-slug"=>"actioncreatevpnconnection-get", "parameters"=>[{"in"=>"query", "name"=>"DestinationCidrBlock", "description"=>"The CIDR block associated with the local subnet of the customer network", "type"=>"string"}, {"in"=>"query", "name"=>"VpnConnectionId", "description"=>"The ID of the VPN connection", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC Connection"]}}, "/?Action=CreateVpnConnectionRoute"=>{"get"=>{"summary"=>"Create Vpn Connection Route", "description"=>"Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway.", "operationId"=>"createvpnconnectionroute", "x-api-path-slug"=>"actioncreatevpnconnectionroute-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpnConnectionId", "description"=>"The ID of the VPN connection", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC Connection Route"]}}, "/?Action=DeleteVpnConnection"=>{"get"=>{"summary"=>"Delete Vpn Connection", "description"=>"Deletes the specified VPN connection.", "operationId"=>"deletevpnconnection", "x-api-path-slug"=>"actiondeletevpnconnection-get", "parameters"=>[{"in"=>"query", "name"=>"DestinationCidrBlock", "description"=>"The CIDR block associated with the local subnet of the customer network", "type"=>"string"}, {"in"=>"query", "name"=>"VpnConnectionId", "description"=>"The ID of the VPN connection", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPN Connection"]}}, "/?Action=DeleteVpnConnectionRoute"=>{"get"=>{"summary"=>"Delete Vpn Connection Route", "description"=>"Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway.", "operationId"=>"deletevpnconnectionroute", "x-api-path-slug"=>"actiondeletevpnconnectionroute-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"VpnConnectionId.N", "description"=>"One or more VPN connection IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPN Connection Route"]}}, "/?Action=DescribeVpnConnections"=>{"get"=>{"summary"=>"Describe Vpn Connections", "description"=>"Describes one or more of your VPN connections.", "operationId"=>"describevpnconnections", "x-api-path-slug"=>"actiondescribevpnconnections-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}, {"in"=>"query", "name"=>"VpnGatewayId", "description"=>"The ID of the virtual private gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPN Connections"]}}, "/?Action=AttachVpnGateway"=>{"get"=>{"summary"=>"Attach Vpn Gateway", "description"=>"Attaches a virtual private gateway to a VPC.", "operationId"=>"attachvpngateway", "x-api-path-slug"=>"actionattachvpngateway-get", "parameters"=>[{"in"=>"query", "name"=>"AvailabilityZone", "description"=>"The Availability Zone for the virtual private gateway", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Type", "description"=>"The type of VPN connection this virtual private gateway supports", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPN Gateway"]}}, "/?Action=CreateVpnGateway"=>{"get"=>{"summary"=>"Create Vpn Gateway", "description"=>"Creates a virtual private gateway.", "operationId"=>"createvpngateway", "x-api-path-slug"=>"actioncreatevpngateway-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpnGatewayId", "description"=>"The ID of the virtual private gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPN Gateway"]}}, "/?Action=DeleteVpnGateway"=>{"get"=>{"summary"=>"Delete Vpn Gateway", "description"=>"Deletes the specified virtual private gateway.", "operationId"=>"deletevpngateway", "x-api-path-slug"=>"actiondeletevpngateway-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"VpnGatewayId.N", "description"=>"One or more virtual private gateway IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPN Gateway"]}}, "/?Action=DescribeVpnGateways"=>{"get"=>{"summary"=>"Describe Vpn Gateways", "description"=>"Describes one or more of your virtual private gateways.", "operationId"=>"describevpngateways", "x-api-path-slug"=>"actiondescribevpngateways-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC", "type"=>"string"}, {"in"=>"query", "name"=>"VpnGatewayId", "description"=>"The ID of the virtual private gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPN Gateways"]}}}}, "apis"=>{"name"=>"AWS EC2", "x-slug"=>"aws-ec2", "description"=>"Amazon Elastic Compute Cloud is a web service that provides resizable compute capacity in the cloud. It is designed to make web-scale cloud computing easier for developers. Amazon EC2s simple web service interface allows you to obtain and configure capacity with minimal friction. It provides you with complete control of your computing resources and lets you run on Amazon’s proven computing environment. Amazon EC2 reduces the time required to obtain and boot new server instances to minutes, allowing you to quickly scale capacity, both up and down, as your computing requirements change. Amazon EC2 changes the economics of computing by allowing you to pay only for capacity that you actually use. Amazon EC2 provides developers the tools to build failure resilient applications and isolate themselves from common failure scenarios.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_AmazonEC2.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Compute,Profiles,Relative Data,Service API,Stack,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-ec2/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS EC2 API", "x-api-slug"=>"aws-ec2-api", "description"=>"Amazon Elastic Compute Cloud is a web service that provides resizable compute capacity in the cloud. It is designed to make web-scale cloud computing easier for developers. Amazon EC2s simple web service interface allows you to obtain and configure capacity with minimal friction. It provides you with complete control of your computing resources and lets you run on Amazon’s proven computing environment. Amazon EC2 reduces the time required to obtain and boot new server instances to minutes, allowing you to quickly scale capacity, both up and down, as your computing requirements change. Amazon EC2 changes the economics of computing by allowing you to pay only for capacity that you actually use. Amazon EC2 provides developers the tools to build failure resilient applications and isolate themselves from common failure scenarios.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_AmazonEC2.png", "humanURL"=>"https://aws.amazon.com/ec2/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Compute,Profiles,Relative Data,Service API,Stack,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-ec2/aws-ec2-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-code", "url"=>"http://aws.amazon.com/code/Amazon-EC2/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Welcome.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/ec2/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/ec2/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/ec2/pricing/"}, {"type"=>"x-sla", "url"=>"https://aws.amazon.com/ec2/sla/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/ec2/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ge-tt{"ge-tt--rest-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Ge.tt", "x-complete"=>1, "info"=>{"title"=>"Ge.tt REST API", "description"=>"the-ge-tt-api-allows-you-to-use-ge-tt-in-your-own-applications--we-believe-that-our-users-should-be-able-to-access-their-files-and-share-their-content-in-their-platform-of-choice--by-using-the-api-developers-are-able-to-easily-put-their-own-content-or-the-content-of-their-users-online--at-the-same-time-they-are-able-to-use-ge-tts-unique-realtime-file-sharing-technology-where-files-are-available-before-they-are-even-uploaded-", "termsOfService"=>"http://ge.tt/terms", "version"=>"1"}, "host"=>"open.ge.tt", "basePath"=>"/1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/1/files/{sharename}/create"=>{"post"=>{"summary"=>"Files Create", "description"=>"To upload files to Ge.tt you must first create the file under a given share. You do that by posting the filename:", "operationId"=>"post1FilesSharenameCreate", "x-api-path-slug"=>"1filessharenamecreate-post", "parameters"=>[{"in"=>"query", "name"=>"accesstoken"}, {"in"=>"path", "name"=>"sharename"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files", "Sharename", "Create"]}}, "/1/files/{sharename}/{fileid}"=>{"get"=>{"summary"=>"Files", "description"=>"Get the state of a file. This returns the following data:", "operationId"=>"get1FilesSharenameFile", "x-api-path-slug"=>"1filessharenamefileid-get", "parameters"=>[{"in"=>"path", "name"=>"fileid"}, {"in"=>"path", "name"=>"sharename"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files", "Sharename", "Fileid"]}}, "/1/files/{sharename}/{fileid}/blob"=>{"get"=>{"summary"=>"Files Blob", "description"=>"Will redirect to the binary content of the file", "operationId"=>"get1FilesSharenameFileBlob", "x-api-path-slug"=>"1filessharenamefileidblob-get", "parameters"=>[{"in"=>"path", "name"=>"fileid"}, {"in"=>"path", "name"=>"sharename"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files", "Sharename", "Fileid", "Blob"]}}, "/1/files/{sharename}/{fileid}/blob/thumb"=>{"get"=>{"summary"=>"Files Blob Thumb", "description"=>"Will redirect to a thumbnail of the binary file. Currently only available for images.", "operationId"=>"get1FilesSharenameFileBlobThumb", "x-api-path-slug"=>"1filessharenamefileidblobthumb-get", "parameters"=>[{"in"=>"path", "name"=>"fileid"}, {"in"=>"path", "name"=>"sharename"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files", "Sharename", "Fileid", "Blob", "Thumb"]}}, "/1/files/{sharename}/{fileid}/destroy"=>{"post"=>{"summary"=>"Files Destroy", "description"=>"Delete a file and the binary contents.", "operationId"=>"post1FilesSharenameFileDestroy", "x-api-path-slug"=>"1filessharenamefileiddestroy-post", "parameters"=>[{"in"=>"query", "name"=>"accesstoken"}, {"in"=>"path", "name"=>"fileid"}, {"in"=>"path", "name"=>"sharename"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files", "Sharename", "Fileid", "Destroy"]}}, "/1/files/{sharename}/{fileid}/upload"=>{"get"=>{"summary"=>"Files Upload", "description"=>"Get upload urls to the file. This returns a new PUT and POST url for you to upload the file to.nOBS You can also choose to use the put- or posturl that you were previously given to override the file.", "operationId"=>"get1FilesSharenameFileUpload", "x-api-path-slug"=>"1filessharenamefileidupload-get", "parameters"=>[{"in"=>"query", "name"=>"accesstoken"}, {"in"=>"path", "name"=>"fileid"}, {"in"=>"path", "name"=>"sharename"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files", "Sharename", "Fileid", "Upload"]}}, "/1/shares"=>{"get"=>{"summary"=>"Shares", "description"=>"Returns all your shares and the containing files:", "operationId"=>"get1Shares", "x-api-path-slug"=>"1shares-get", "parameters"=>[{"in"=>"query", "name"=>"accesstoken"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shares"]}}, "/1/shares/create"=>{"post"=>{"summary"=>"Shares Create", "description"=>"Creates a new share. The request body is optional but can look like:", "operationId"=>"post1SharesCreate", "x-api-path-slug"=>"1sharescreate-post", "parameters"=>[{"in"=>"query", "name"=>"accesstoken"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shares", "Create"]}}, "/1/shares/{sharename}"=>{"get"=>{"summary"=>"Shares", "description"=>"Lists a share.", "operationId"=>"get1SharesSharename", "x-api-path-slug"=>"1sharessharename-get", "parameters"=>[{"in"=>"path", "name"=>"sharename"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shares", "Sharename"]}}, "/1/shares/{sharename}/destroy"=>{"post"=>{"summary"=>"Shares Destroy", "description"=>"Delete a share and all of its files.", "operationId"=>"post1SharesSharenameDestroy", "x-api-path-slug"=>"1sharessharenamedestroy-post", "parameters"=>[{"in"=>"query", "name"=>"accesstoken"}, {"in"=>"path", "name"=>"sharename"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shares", "Sharename", "Destroy"]}}, "/1/shares/{sharename}/update"=>{"post"=>{"summary"=>"Shares Update", "description"=>"Updates a share. Currently you can only update the title", "operationId"=>"post1SharesSharenameUpdate", "x-api-path-slug"=>"1sharessharenameupdate-post", "parameters"=>[{"in"=>"query", "name"=>"accesstoken"}, {"in"=>"path", "name"=>"sharename"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shares", "Sharename", "Update"]}}, "/1/users/login"=>{"post"=>{"summary"=>"Users Login", "description"=>"The API is based on oauth with an xauth handshake. The request body looks like this:", "operationId"=>"post1UsersLogin", "x-api-path-slug"=>"1userslogin-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Login"]}}, "/1/users/me"=>{"get"=>{"summary"=>"Users Me", "description"=>"Returns your user information:", "operationId"=>"get1UsersMe", "x-api-path-slug"=>"1usersme-get", "parameters"=>[{"in"=>"query", "name"=>"accesstoken"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Me"]}}}}, "apis"=>{"name"=>"Ge.tt", "x-slug"=>"ge-tt", "description"=>"Extremely simple realtime filesharing. No signup required. Share any number of photos, videos, music, anything - in seconds - no matter how large.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1012-ge-tt.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"36546", "tags"=>"API Provider,File,File Sharing,File Transfer,Files,Getting Started Example,internet,Mobile,Profiles,Relative Data,Service API,Stack Network,Storage,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"ge-tt/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Ge.tt REST API", "x-api-slug"=>"ge-tt--rest-api", "description"=>"The Ge.tt API allows you to use Ge.tt in your own applications. We believe that our users should be able to access their files and share their content in their platform of choice. By using the API, developers are able to easily put their own content, or the content of their users online. At the same time they are able to use Ge.tts unique real-time file sharing technology where files are available before they are even uploaded.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1012-ge-tt.jpg", "humanURL"=>"http://ge.tt", "baseURL"=>"https://open.ge.tt//1", "tags"=>"API Provider,File,File Sharing,File Transfer,Files,Getting Started Example,internet,Mobile,Profiles,Relative Data,Service API,Stack Network,Storage,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/ge-tt/1usersme-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/ge-tt/ge-tt--rest-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x--net-library", "url"=>"http://ge.tt/developers/csharp"}, {"type"=>"x-base", "url"=>"http://open.ge.tt"}, {"type"=>"x-blog", "url"=>"http://ge.tt/blog"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/ge-tt"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/ge-tt"}, {"type"=>"x-developer", "url"=>"http://ge.tt/developers"}, {"type"=>"x-email", "url"=>"hello@ge.tt"}, {"type"=>"x-facebook", "url"=>"https://www.facebook.com/gettsharing"}, {"type"=>"x-faq", "url"=>"http://ge.tt/faq"}, {"type"=>"x-getting-started", "url"=>"http://ge.tt/developers/start"}, {"type"=>"x-github", "url"=>"https://github.com/gett"}, {"type"=>"x-java-library", "url"=>"http://ge.tt/developers/java"}, {"type"=>"x-perl-library", "url"=>"http://ge.tt/developers/perl"}, {"type"=>"x-python-library", "url"=>"http://ge.tt/developers/python"}, {"type"=>"x-terms-of-service", "url"=>"http://ge.tt/terms"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/gettsharing"}, {"type"=>"x-website", "url"=>"http://ge.tt"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-recovery-services{"azure-recovery-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Recovery Services", "x-complete"=>1, "info"=>{"title"=>"RecoveryServicesClient", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/operations"=>{"get"=>{"summary"=>"Operations List", "description"=>"Returns the list of available operations.", "operationId"=>"Operations_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations"]}}, "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupconfig/vaultconfig"=>{"get"=>{"summary"=>"Backup Vault Configs Get", "description"=>"Fetches vault config.", "operationId"=>"BackupVaultConfigs_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaultsvaultnamebackupconfigvaultconfig-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backup Vault Configs"]}, "patch"=>{"summary"=>"Backup Vault Configs Update", "description"=>"Updates vault config model type.", "operationId"=>"BackupVaultConfigs_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaultsvaultnamebackupconfigvaultconfig-patch", "parameters"=>[{"in"=>"body", "name"=>"backupVaultConfig", "description"=>"Backup vault config", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backup Vault Configs"]}}, "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig"=>{"get"=>{"summary"=>"Backup Storage Configs Get", "description"=>"Fetches resource storage config.", "operationId"=>"BackupStorageConfigs_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaultsvaultnamebackupstorageconfigvaultstorageconfig-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backup Storage Configs"]}, "patch"=>{"summary"=>"Backup Storage Configs Update", "description"=>"Updates vault storage model type.", "operationId"=>"BackupStorageConfigs_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaultsvaultnamebackupstorageconfigvaultstorageconfig-patch", "parameters"=>[{"in"=>"body", "name"=>"backupStorageConfig", "description"=>"Backup storage config", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backup Storage Configs"]}}, "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/certificates/{certificateName}"=>{"put"=>{"summary"=>"Vault Certificates Create", "description"=>"Upload a certificate for a resource.", "operationId"=>"VaultCertificates_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaultsvaultnamecertificatescertificatename-put", "parameters"=>[{"in"=>"path", "name"=>"certificateName", "description"=>"Certificate friendly name"}, {"in"=>"body", "name"=>"certificateRequest", "description"=>"Input parameters for uploading the vault certificate", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vault Certificates"]}}, "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/registeredIdentities/{identityName}"=>{"delete"=>{"summary"=>"Registered Identities Delete", "description"=>"Unregisters the given container from your Recovery Services vault.", "operationId"=>"RegisteredIdentities_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaultsvaultnameregisteredidentitiesidentityname-delete", "parameters"=>[{"in"=>"path", "name"=>"identityName", "description"=>"Name of the protection container to unregister"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registered Identities"]}}, "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/replicationUsages"=>{"get"=>{"summary"=>"Replication Usages List", "description"=>"Fetches the replication usages of the vault.", "operationId"=>"ReplicationUsages_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaultsvaultnamereplicationusages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Usages"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/vaults"=>{"get"=>{"summary"=>"Vaults List By Subscription Id", "description"=>"Fetches all the resources of the specified type in the subscription.", "operationId"=>"Vaults_ListBySubscriptionId", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-recoveryservicesvaults-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vaults Subscription"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults"=>{"get"=>{"summary"=>"Vaults List By Resource Group", "description"=>"Retrieve a list of Vaults.", "operationId"=>"Vaults_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaults-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vaults Resource Group"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}"=>{"get"=>{"summary"=>"Vaults Get", "description"=>"Get the Vault details.", "operationId"=>"Vaults_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaultsvaultname-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vaults"]}, "put"=>{"summary"=>"Vaults Create Or Update", "description"=>"Creates or updates a Recovery Services vault.", "operationId"=>"Vaults_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaultsvaultname-put", "parameters"=>[{"in"=>"body", "name"=>"vault", "description"=>"Recovery Services Vault to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vaults"]}, "delete"=>{"summary"=>"Vaults Delete", "description"=>"Deletes a vault.", "operationId"=>"Vaults_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaultsvaultname-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vaults"]}, "patch"=>{"summary"=>"Vaults Update", "description"=>"Updates the vault.", "operationId"=>"Vaults_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaultsvaultname-patch", "parameters"=>[{"in"=>"body", "name"=>"vault", "description"=>"Recovery Services Vault to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vaults"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/extendedInformation/vaultExtendedInfo"=>{"get"=>{"summary"=>"Vault Extended Info Get", "description"=>"Get the vault extended info.", "operationId"=>"VaultExtendedInfo_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaultsvaultnameextendedinformationvaultextendedinfo-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vault Extended Info"]}, "put"=>{"summary"=>"Vault Extended Info Create Or Update", "description"=>"Create vault extended info.", "operationId"=>"VaultExtendedInfo_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaultsvaultnameextendedinformationvaultextendedinfo-put", "parameters"=>[{"in"=>"body", "name"=>"resourceResourceExtendedInfoDetails", "description"=>"resourceResourceExtendedInfoDetails", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vault Extended Info"]}, "patch"=>{"summary"=>"Vault Extended Info Update", "description"=>"Update vault extended info.", "operationId"=>"VaultExtendedInfo_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaultsvaultnameextendedinformationvaultextendedinfo-patch", "parameters"=>[{"in"=>"body", "name"=>"resourceResourceExtendedInfoDetails", "description"=>"resourceResourceExtendedInfoDetails", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vault Extended Info"]}}, "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/usages"=>{"get"=>{"summary"=>"Usages List By Vaults", "description"=>"Fetches the usages of the vault.", "operationId"=>"Usages_ListByVaults", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaultsvaultnameusages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Usages Vaults"]}}}}, "apis"=>{"name"=>"Azure Recovery Services", "x-slug"=>"azure-recovery-services", "description"=>"Learn how to use Site Recovery for business continuity and disaster recovery strategy for private clouds. Tutorials and other documentation show you how to plan, deploy, and manage the orchestration of replicating on-premises physical servers and virtual machines to the cloud or to a secondary datacenter.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-site-recovery.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Backups,Microsoft,Profiles,Recovery,Relative Data,Service API,Stability,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-recovery-services/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Recovery Service API", "x-api-slug"=>"azure-recovery-service-api", "description"=>"Learn how to use Site Recovery for business continuity and disaster recovery strategy for private clouds. Tutorials and other documentation show you how to plan, deploy, and manage the orchestration of replicating on-premises physical servers and virtual machines to the cloud or to a secondary datacenter.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-site-recovery.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/site-recovery/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Backups,Microsoft,Profiles,Recovery,Relative Data,Service API,Stability,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-recovery-services/subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-recoveryservicesvaultsvaultnameusages-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-recovery-services/azure-recovery-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/site-recovery/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/site-recovery/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/site-recovery/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/site-recovery/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-simple-notification-service{"aws-simple-notification-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Simple Notification Service", "x-complete"=>1, "info"=>{"title"=>"AWS Simple Notification Service API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddPermission"=>{"get"=>{"summary"=>"Add Permission", "description"=>"Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.", "operationId"=>"addPermission", "x-api-path-slug"=>"actionaddpermission-get", "parameters"=>[{"in"=>"query", "name"=>"ActionName.member.N", "description"=>"The action you want to allow for the specified principal(s)", "type"=>"string"}, {"in"=>"query", "name"=>"AWSAccountId.member.N", "description"=>"The AWS account IDs of the users (principals) who will be given access to the specified actions", "type"=>"string"}, {"in"=>"query", "name"=>"Label", "description"=>"A unique identifier for the new policy statement", "type"=>"string"}, {"in"=>"query", "name"=>"TopicArn", "description"=>"The ARN of the topic whose access control policy you wish to modify", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permissions"]}}, "/?Action=CheckIfPhoneNumberIsOptedOut"=>{"get"=>{"summary"=>"Check If Phone Number Is Opted Out", "description"=>"Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account.", "operationId"=>"checkIfPhoneNumberIsOptedOut", "x-api-path-slug"=>"actioncheckifphonenumberisoptedout-get", "parameters"=>[{"in"=>"query", "name"=>"phoneNumber", "description"=>"The phone number for which you want to check the opt out status", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Opt Out"]}}, "/?Action=ConfirmSubscription"=>{"get"=>{"summary"=>"Confirm Subscription", "description"=>"Verifies an endpoint owner's intent to receive messages by validating the token sent to the\n endpoint by an earlier Subscribe action.", "operationId"=>"confirmSubscription", "x-api-path-slug"=>"actionconfirmsubscription-get", "parameters"=>[{"in"=>"query", "name"=>"AuthenticateOnUnsubscribe", "description"=>"Disallows unauthenticated unsubscribes of the subscription", "type"=>"string"}, {"in"=>"query", "name"=>"Token", "description"=>"Short-lived token sent to an endpoint during the Subscribe action", "type"=>"string"}, {"in"=>"query", "name"=>"TopicArn", "description"=>"The ARN of the topic for which you wish to confirm a subscription", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/?Action=CreatePlatformApplication"=>{"get"=>{"summary"=>"Create Platform Application", "description"=>"Creates a platform application object for one of the supported push notification services,\n such as APNS and GCM, to which devices and mobile apps may register.", "operationId"=>"createPlatformApplication", "x-api-path-slug"=>"actioncreateplatformapplication-get", "parameters"=>[{"in"=>"query", "name"=>"Attributes\n , Attributes.entry.N.key (key), Attributesentry.N.value (value)", "description"=>"For a list of attributes, see SetPlatformApplicationAttributes", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long", "type"=>"string"}, {"in"=>"query", "name"=>"Platform", "description"=>"The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Platform Applications"]}}, "/?Action=CreatePlatformEndpoint"=>{"get"=>{"summary"=>"Create Platform Endpoint", "description"=>"Creates an endpoint for a device and mobile app on one of the supported push notification\n services, such as GCM and APNS.", "operationId"=>"createPlatformEndpoint", "x-api-path-slug"=>"actioncreateplatformendpoint-get", "parameters"=>[{"in"=>"query", "name"=>"Attributes\n , Attributes.entry.N.key (key), Attributesentry.N.value (value)", "description"=>"For a list of attributes, see SetEndpointAttributes", "type"=>"string"}, {"in"=>"query", "name"=>"CustomUserData", "description"=>"Arbitrary user data to associate with the endpoint", "type"=>"string"}, {"in"=>"query", "name"=>"PlatformApplicationArn", "description"=>"PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint", "type"=>"string"}, {"in"=>"query", "name"=>"Token", "description"=>"Unique identifier created by the notification service for an app on a device", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Platform Endpoints"]}}, "/?Action=CreateTopic"=>{"get"=>{"summary"=>"Create Topic", "description"=>"Creates a topic to which notifications can be published.", "operationId"=>"createTopic", "x-api-path-slug"=>"actioncreatetopic-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"The name of the topic you want to create", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics"]}}, "/?Action=DeleteEndpoint"=>{"get"=>{"summary"=>"Delete Endpoint", "description"=>"Deletes the endpoint for a device and mobile app from Amazon SNS.", "operationId"=>"deleteEndpoint", "x-api-path-slug"=>"actiondeleteendpoint-get", "parameters"=>[{"in"=>"query", "name"=>"EndpointArn", "description"=>"EndpointArn of endpoint to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoints"]}}, "/?Action=DeletePlatformApplication"=>{"get"=>{"summary"=>"Delete Platform Application", "description"=>"Deletes a platform application object for one of the supported push notification services,\n such as APNS and GCM.", "operationId"=>"deletePlatformApplication", "x-api-path-slug"=>"actiondeleteplatformapplication-get", "parameters"=>[{"in"=>"query", "name"=>"PlatformApplicationArn", "description"=>"PlatformApplicationArn of platform application object to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Platform Applications"]}}, "/?Action=DeleteTopic"=>{"get"=>{"summary"=>"Delete Topic", "description"=>"Deletes a topic and all its subscriptions.", "operationId"=>"deleteTopic", "x-api-path-slug"=>"actiondeletetopic-get", "parameters"=>[{"in"=>"query", "name"=>"TopicArn", "description"=>"The ARN of the topic you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics"]}}, "/?Action=GetEndpointAttributes"=>{"get"=>{"summary"=>"Get Endpoint Attributes", "description"=>"Retrieves the endpoint attributes for a device on one of the supported push notification\n services, such as GCM and APNS.", "operationId"=>"getEndpointAttributes", "x-api-path-slug"=>"actiongetendpointattributes-get", "parameters"=>[{"in"=>"query", "name"=>"EndpointArn", "description"=>"EndpointArn for GetEndpointAttributes input", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoints"]}}, "/?Action=GetPlatformApplicationAttributes"=>{"get"=>{"summary"=>"Get Platform Application Attributes", "description"=>"Retrieves the attributes of the platform application object for the supported push\n notification services, such as APNS and GCM.", "operationId"=>"getPlatformApplicationAttributes", "x-api-path-slug"=>"actiongetplatformapplicationattributes-get", "parameters"=>[{"in"=>"query", "name"=>"PlatformApplicationArn", "description"=>"PlatformApplicationArn for GetPlatformApplicationAttributesInput", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Platform Applications"]}}, "/?Action=GetSMSAttributes"=>{"get"=>{"summary"=>"Get S M S Attributes", "description"=>"Returns the settings for sending SMS messages from your account.", "operationId"=>"getSMSAttributes", "x-api-path-slug"=>"actiongetsmsattributes-get", "parameters"=>[{"in"=>"query", "name"=>"attributes.member.N", "description"=>"A list of the individual attribute names, such as MonthlySpendLimit, for which you want values", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SMS"]}}, "/?Action=GetSubscriptionAttributes"=>{"get"=>{"summary"=>"Get Subscription Attributes", "description"=>"Returns all of the properties of a subscription.", "operationId"=>"getSubscriptionAttributes", "x-api-path-slug"=>"actiongetsubscriptionattributes-get", "parameters"=>[{"in"=>"query", "name"=>"SubscriptionArn", "description"=>"The ARN of the subscription whose properties you want to get", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/?Action=GetTopicAttributes"=>{"get"=>{"summary"=>"Get Topic Attributes", "description"=>"Returns all of the properties of a topic.", "operationId"=>"getTopicAttributes", "x-api-path-slug"=>"actiongettopicattributes-get", "parameters"=>[{"in"=>"query", "name"=>"TopicArn", "description"=>"The ARN of the topic whose properties you want to get", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics"]}}, "/?Action=ListEndpointsByPlatformApplication"=>{"get"=>{"summary"=>"List Endpoints By Platform Application", "description"=>"Lists the endpoints and endpoint attributes for devices in a supported push notification\n service, such as GCM and APNS.", "operationId"=>"listEndpointsByPlatformApplication", "x-api-path-slug"=>"actionlistendpointsbyplatformapplication-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results", "type"=>"string"}, {"in"=>"query", "name"=>"PlatformApplicationArn", "description"=>"PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoints"]}}, "/?Action=ListPhoneNumbersOptedOut"=>{"get"=>{"summary"=>"List Phone Numbers Opted Out", "description"=>"Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.", "operationId"=>"listPhoneNumbersOptedOut", "x-api-path-slug"=>"actionlistphonenumbersoptedout-get", "parameters"=>[{"in"=>"query", "name"=>"nextToken", "description"=>"A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Opt Out"]}}, "/?Action=ListPlatformApplications"=>{"get"=>{"summary"=>"List Platform Applications", "description"=>"Lists the platform application objects for the supported push notification services, such as\n APNS and GCM.", "operationId"=>"listPlatformApplications", "x-api-path-slug"=>"actionlistplatformapplications-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Platform Applications"]}}, "/?Action=ListSubscriptions"=>{"get"=>{"summary"=>"List Subscriptions", "description"=>"Returns a list of the requester's subscriptions.", "operationId"=>"listSubscriptions", "x-api-path-slug"=>"actionlistsubscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"Token returned by the previous ListSubscriptions request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/?Action=ListSubscriptionsByTopic"=>{"get"=>{"summary"=>"List Subscriptions By Topic", "description"=>"Returns a list of the subscriptions to a specific topic.", "operationId"=>"listSubscriptionsByTopic", "x-api-path-slug"=>"actionlistsubscriptionsbytopic-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"Token returned by the previous ListSubscriptionsByTopic request", "type"=>"string"}, {"in"=>"query", "name"=>"TopicArn", "description"=>"The ARN of the topic for which you wish to find subscriptions", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/?Action=ListTopics"=>{"get"=>{"summary"=>"List Topics", "description"=>"Returns a list of the requester's topics.", "operationId"=>"listTopics", "x-api-path-slug"=>"actionlisttopics-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"Token returned by the previous ListTopics request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics"]}}, "/?Action=OptInPhoneNumber"=>{"get"=>{"summary"=>"Opt In Phone Number", "description"=>"Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.", "operationId"=>"optInPhoneNumber", "x-api-path-slug"=>"actionoptinphonenumber-get", "parameters"=>[{"in"=>"query", "name"=>"phoneNumber", "description"=>"The phone number to opt in", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Opt Out"]}}, "/?Action=Publish"=>{"get"=>{"summary"=>"Publish", "description"=>"Sends a message to all of a topic's subscribed endpoints.", "operationId"=>"publish", "x-api-path-slug"=>"actionpublish-get", "parameters"=>[{"in"=>"query", "name"=>"Message", "description"=>"The message you want to send to the topic", "type"=>"string"}, {"in"=>"query", "name"=>"MessageAttributes\n , MessageAttributes.entry.N.Name (key), MessageAttributesentry.N.Value (value)", "description"=>"Message attributes for Publish action", "type"=>"string"}, {"in"=>"query", "name"=>"MessageStructure", "description"=>"Set MessageStructure to json if you want to send a different message for each protocol", "type"=>"string"}, {"in"=>"query", "name"=>"PhoneNumber", "description"=>"The phone number to which you want to deliver an SMS message", "type"=>"string"}, {"in"=>"query", "name"=>"Subject", "description"=>"Optional parameter to be used as the Subject line when the message is delivered to email endpoints", "type"=>"string"}, {"in"=>"query", "name"=>"TargetArn", "description"=>"Either TopicArn or EndpointArn, but not both", "type"=>"string"}, {"in"=>"query", "name"=>"TopicArn", "description"=>"The topic you want to publish to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Publish"]}}, "/?Action=RemovePermission"=>{"get"=>{"summary"=>"Remove Permission", "description"=>"Removes a statement from a topic's access control policy.", "operationId"=>"removePermission", "x-api-path-slug"=>"actionremovepermission-get", "parameters"=>[{"in"=>"query", "name"=>"Label", "description"=>"The unique label of the statement you want to remove", "type"=>"string"}, {"in"=>"query", "name"=>"TopicArn", "description"=>"The ARN of the topic whose access control policy you wish to modify", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permissions"]}}, "/?Action=SetEndpointAttributes"=>{"get"=>{"summary"=>"Set Endpoint Attributes", "description"=>"Sets the attributes for an endpoint for a device on one of the supported push notification\n services, such as GCM and APNS.", "operationId"=>"setEndpointAttributes", "x-api-path-slug"=>"actionsetendpointattributes-get", "parameters"=>[{"in"=>"query", "name"=>"Attributes\n , Attributes.entry.N.key (key), Attributesentry.N.value (value)", "description"=>"A map of the endpoint attributes", "type"=>"string"}, {"in"=>"query", "name"=>"EndpointArn", "description"=>"EndpointArn used for SetEndpointAttributes action", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoints"]}}, "/?Action=SetPlatformApplicationAttributes"=>{"get"=>{"summary"=>"Set Platform Application Attributes", "description"=>"Sets the attributes of the platform application object for the supported push notification\n services, such as APNS and GCM.", "operationId"=>"setPlatformApplicationAttributes", "x-api-path-slug"=>"actionsetplatformapplicationattributes-get", "parameters"=>[{"in"=>"query", "name"=>"Attributes\n , Attributes.entry.N.key (key), Attributesentry.N.value (value)", "description"=>"A map of the platform application attributes", "type"=>"string"}, {"in"=>"query", "name"=>"PlatformApplicationArn", "description"=>"PlatformApplicationArn for SetPlatformApplicationAttributes action", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Platform Applications"]}}, "/?Action=SetSMSAttributes"=>{"get"=>{"summary"=>"Set SMS Attributes", "description"=>"Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.", "operationId"=>"setSMSAttributes", "x-api-path-slug"=>"actionsetsmsattributes-get", "parameters"=>[{"in"=>"query", "name"=>"attributes\n , attributes.entry.N.key (key), attributesentry.N.value (value)", "description"=>"The default settings for sending SMS messages from your account", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SMS"]}}, "/?Action=SetSubscriptionAttributes"=>{"get"=>{"summary"=>"Set Subscription Attributes", "description"=>"Allows a subscription owner to set an attribute of the topic to a new value.", "operationId"=>"setSubscriptionAttributes", "x-api-path-slug"=>"actionsetsubscriptionattributes-get", "parameters"=>[{"in"=>"query", "name"=>"AttributeName", "description"=>"The name of the attribute you want to set", "type"=>"string"}, {"in"=>"query", "name"=>"AttributeValue", "description"=>"The new value for the attribute in JSON format", "type"=>"string"}, {"in"=>"query", "name"=>"SubscriptionArn", "description"=>"The ARN of the subscription to modify", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/?Action=SetTopicAttributes"=>{"get"=>{"summary"=>"Set Topic Attributes", "description"=>"Allows a topic owner to set an attribute of the topic to a new value.", "operationId"=>"setTopicAttributes", "x-api-path-slug"=>"actionsettopicattributes-get", "parameters"=>[{"in"=>"query", "name"=>"AttributeName", "description"=>"The name of the attribute you want to set", "type"=>"string"}, {"in"=>"query", "name"=>"AttributeValue", "description"=>"The new value for the attribute", "type"=>"string"}, {"in"=>"query", "name"=>"TopicArn", "description"=>"The ARN of the topic to modify", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics"]}}, "/?Action=Subscribe"=>{"get"=>{"summary"=>"Subscribe", "description"=>"Prepares to subscribe an endpoint by sending the endpoint a confirmation message.", "operationId"=>"subscribe", "x-api-path-slug"=>"actionsubscribe-get", "parameters"=>[{"in"=>"query", "name"=>"Endpoint", "description"=>"The endpoint that you want to receive notifications", "type"=>"string"}, {"in"=>"query", "name"=>"Protocol", "description"=>"The protocol you want to use", "type"=>"string"}, {"in"=>"query", "name"=>"TopicArn", "description"=>"The ARN of the topic you want to subscribe to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoints"]}}, "/?Action=Unsubscribe"=>{"get"=>{"summary"=>"Unsubscribe", "description"=>"Deletes a subscription.", "operationId"=>"unsubscribe", "x-api-path-slug"=>"actionunsubscribe-get", "parameters"=>[{"in"=>"query", "name"=>"SubscriptionArn", "description"=>"The ARN of the subscription to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"AWS Simple Notification Service", "x-slug"=>"aws-simple-notification-service", "description"=>"Amazon Simple Notification Service (Amazon SNS) is a fast, flexible, fully managed push notification service that lets you send individual messages or to fan-out messages to large numbers of recipients. Amazon SNS makes it simple and cost effective to send push notifications to mobile device users, email recipients or even send messages to other distributed services.With Amazon SNS, you can send notifications to Apple, Google, Fire OS, and Windows devices, as well as to Android devices in China with Baidu Cloud Push. You can use SNS to send SMS messages to mobile device users worldwide.Beyond these endpoints, Amazon SNS can also deliver messages toAmazon Simple Queue Service(SQS),AWS Lambda functions, or to any HTTP endpoint.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Mobile-Services_AmazonSNS.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Messages,Notifications,Profiles,Relative Data,Service API,SMS,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-simple-notification-service/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Simple Notification Service API", "x-api-slug"=>"aws-simple-notification-service-api", "description"=>"Amazon Simple Notification Service (Amazon SNS) is a fast, flexible, fully managed push notification service that lets you send individual messages or to fan-out messages to large numbers of recipients. Amazon SNS makes it simple and cost effective to send push notifications to mobile device users, email recipients or even send messages to other distributed services.With Amazon SNS, you can send notifications to Apple, Google, Fire OS, and Windows devices, as well as to Android devices in China with Baidu Cloud Push. You can use SNS to send SMS messages to mobile device users worldwide.Beyond these endpoints, Amazon SNS can also deliver messages toAmazon Simple Queue Service(SQS),AWS Lambda functions, or to any HTTP endpoint.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Mobile-Services_AmazonSNS.png", "humanURL"=>"https://aws.amazon.com/sns/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Messages,Notifications,Profiles,Relative Data,Service API,SMS,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-simple-notification-service/actionunsubscribe-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-simple-notification-service/aws-simple-notification-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-log", "url"=>"http://aws.amazon.com/releasenotes/Amazon-SN"}, {"type"=>"x-console", "url"=>"https://console.aws.amazon.com/sns"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/sns/latest/api/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/sns/faqs/"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=72"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/sns/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/sns/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/sns/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
international-trade-administration{"ita-offices-and-centers-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"International Trade Administration", "x-complete"=>1, "info"=>{"title"=>"ITA Offices And Centers", "description"=>"this-api-provides-contact-and-address-information-for-all-of-itau2019s-domestic-and-international-export-assistance-centers--incorporating-these-listings-into-directories-of-business-counseling-services-is-one-example-of-how-developers-can-use-this-api-to-assist-exporters-", "termsOfService"=>"http://developer.trade.gov/tos.html", "version"=>"1.0"}, "host"=>"api.trade.gov", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/ita_office_locations/search"=>{"get"=>{"summary"=>"ITA Offices and Centers Search", "description"=>"This API provides contact and address information for all of ITAs domestic and international export assistance centers.", "operationId"=>"office", "x-api-path-slug"=>"ita-office-locationssearch-get", "parameters"=>[{"in"=>"query", "name"=>"city", "description"=>"Returns office locations based on city name"}, {"in"=>"query", "name"=>"countries", "description"=>"Returns office locations based on ISO alpha-2 country codes"}, {"in"=>"query", "name"=>"keyword", "description"=>"Returns office locations for a match within the post or office name fields"}, {"in"=>"query", "name"=>"offset", "description"=>"The offset parameter defines the offset from the first result you want to fetch"}, {"in"=>"query", "name"=>"size", "description"=>"The size parameter allows you to configure the maximum amount of hits to be returned"}, {"in"=>"query", "name"=>"state", "description"=>"Returns locations for export assistance centers located in a specific U"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offices"]}}}}, "apis"=>{"name"=>"International Trade Administration", "x-slug"=>"international-trade-administration", "description"=>"The International Trade Administration (ITA) strengthens the competitiveness of U.S. industry, promotes trade and investment, and ensures fair trade through the rigorous enforcement of our trade laws and agreements. ITA works to improve the global busi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11180-international-trade-administration.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"81093", "tags"=>"API Provider,Federal Government,Federal Government,General Data,Marketplace,Profiles,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"international-trade-administration/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"ITA Offices And Centers", "x-api-slug"=>"ita-offices-and-centers", "description"=>"The International Trade Administration (ITA) strengthens the competitiveness of U.S. industry, promotes trade and investment, and ensures fair trade through the rigorous enforcement of our trade laws and agreements. ITA works to improve the global busi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11180-international-trade-administration.jpg", "humanURL"=>"http://trade.gov", "baseURL"=>"https://api.trade.gov//", "tags"=>"API Provider,Federal Government,Federal Government,General Data,Marketplace,Profiles,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/international-trade-administration/ita-office-locationssearch-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/international-trade-administration/ita-offices-and-centers-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api.trade.gov/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/international-trade-administration/timeline"}, {"type"=>"x-developer", "url"=>"http://developer.trade.gov/"}, {"type"=>"x-email", "url"=>"petition.counseling@trade.gov"}, {"type"=>"x-email", "url"=>"tfac@trade.gov"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/TradeGov"}, {"type"=>"x-website", "url"=>"http://trade.gov"}, {"type"=>"x-website", "url"=>"http://trade.gov/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
the-new-york-times{"the-new-york-times-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"The New York Times", "x-complete"=>1, "info"=>{"title"=>"New York Times", "description"=>"you-already-know-that-nytimes-com-is-an-unparalleled-source-of-news-and-information--but-now-its-a-premier-source-of-data-too--why-just-read-the-news-when-you-can-hack-it", "termsOfService"=>"https://developer.nytimes.com/tou", "version"=>"2.0.0"}, "host"=>"api.nytimes.com", "basePath"=>"/svc", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/topstories/v2/{section}.{format}"=>{"get"=>{"summary"=>"Top Stories", "description"=>"The Top Stories API returns a list of articles and associated images currently on the specified section. Support JSON and JSONP.", "operationId"=>"the-top-stories-api-returns-a-list-of-articles-and-associated-images-currently-on-the-specified-sect", "x-api-path-slug"=>"topstoriesv2section-format-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"The name of the function the API call results will be passed to"}, {"in"=>"path", "name"=>"format", "description"=>"if this is JSONP or JSON"}, {"in"=>"path", "name"=>"section", "description"=>"The section the story appears in"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News"]}}, "/search/v2/articlesearch.json"=>{"get"=>{"summary"=>"Article Search", "description"=>"Article SearchWith the Article Search API, you can search New York Times articles from Sept. 18, 1851 to today, retrieving headlines, abstracts, lead paragraphs, links to associated multimedia and other article.", "operationId"=>"article-search-requests-use-the-following-uri-structure", "x-api-path-slug"=>"searchv2articlesearch-json-get", "parameters"=>[{"in"=>"query", "name"=>"api-key", "description"=>"The API key", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"begin_date", "description"=>"Format: YYYYMMDD Restricts responses to results with publication dates of the date specified or later"}, {"in"=>"query", "name"=>"end_date", "description"=>"Format: YYYYMMDD Restricts responses to results with publication dates of the date specified or earlier"}, {"in"=>"query", "name"=>"facet_field", "description"=>"Comma-delimited list of facetsSpecifies the sets of facet values to include in the facets array at the end of response, which collects the facet values from all the search results"}, {"in"=>"query", "name"=>"facet_filter", "description"=>"When set to true, facet counts will respect any applied filters (fq, date range, etc"}, {"in"=>"query", "name"=>"fl", "description"=>"Comma-delimited list of fields (no limit) Limits the fields returned in your search results"}, {"in"=>"query", "name"=>"fq", "description"=>"Filtered search query using standard Lucene syntax"}, {"in"=>"query", "name"=>"hl", "description"=>"Enables highlighting in search results"}, {"in"=>"query", "name"=>"page", "description"=>"The value of page corresponds to a set of 10 results (it does not indicate the starting number of the result set)"}, {"in"=>"query", "name"=>"q", "description"=>"Search query term"}, {"in"=>"query", "name"=>"sort", "description"=>"By default, search results are sorted by their relevance to the query term (q)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News"]}}, "/books/v2/lists/best-sellers/history.json"=>{"get"=>{"summary"=>"Best Seller History List", "description"=>"The Best Sellers history service returns books and their history on the NYT Best Sellers lists.", "operationId"=>"GET_lists-best-sellers-history-json", "x-api-path-slug"=>"booksv2listsbestsellershistory-json-get", "parameters"=>[{"in"=>"query", "name"=>"age-group", "description"=>"The target age group for the best seller"}, {"in"=>"query", "name"=>"author", "description"=>"The author of the best seller"}, {"in"=>"query", "name"=>"contributor", "description"=>"The author of the best seller, as well as other contributors such as the illustrator (to search or sort by author name only, use author instead)"}, {"in"=>"query", "name"=>"isbn", "description"=>"International Standard Book Number, 10 or 13 digitsA best seller may have both 10-digit and 13-digit ISBNs, and may have multiple ISBNs of each type"}, {"in"=>"query", "name"=>"price", "description"=>"The publishers list price of the best seller, including decimal point"}, {"in"=>"query", "name"=>"publisher", "description"=>"The standardized name of the publisher"}, {"in"=>"query", "name"=>"title", "description"=>"The title of the best sellerWhen searching, you can specify a portion of a title or a full title"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Books"]}}, "/books/v2/lists.{format}"=>{"get"=>{"summary"=>"Best Seller List", "description"=>"The Books API has services for getting information about The New York Times Best Sellers Lists and Book Reviews.", "operationId"=>"GET_lists-format", "x-api-path-slug"=>"booksv2lists-format-get", "parameters"=>[{"in"=>"query", "name"=>"bestsellers-date", "description"=>"YYYY-MM-DDThe week-ending date for the sales reflected on list-name"}, {"in"=>"query", "name"=>"date", "description"=>"YYYY-MM-DD The date the best-seller list was published on NYTimes"}, {"in"=>"path", "name"=>"format", "description"=>"The format", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"isbn", "description"=>"International Standard Book Number, 10 or 13 digits"}, {"in"=>"query", "name"=>"list", "description"=>"The name of the Times best-seller list"}, {"in"=>"query", "name"=>"offset", "description"=>"Sets the starting point of the result set"}, {"in"=>"query", "name"=>"published-date", "description"=>"YYYY-MM-DDThe date the best-seller list was published on NYTimes"}, {"in"=>"query", "name"=>"rank", "description"=>"The rank of the best seller on list-name as of bestsellers-date"}, {"in"=>"query", "name"=>"rank-last-week", "description"=>"The rank of the best seller on list-name one week prior to bestsellers-date"}, {"in"=>"query", "name"=>"sort-order", "description"=>"Sets the sort order of the result set"}, {"in"=>"query", "name"=>"weeks-on-list", "description"=>"The number of weeks that the best seller has been on list-name, as of bestsellers-date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Lists"]}}, "/books/v2/lists/{date}/{list}.json"=>{"get"=>{"summary"=>"Best Seller List by Date", "description"=>"You can optionally request an overview for a specific published date using the published_date query parameter.", "operationId"=>"GET_lists-date-list-json", "x-api-path-slug"=>"booksv2listsdatelist-json-get", "parameters"=>[{"in"=>"query", "name"=>"api-key", "description"=>"The API key", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"bestsellers-date", "description"=>"YYYY-MM-DDThe week-ending date for the sales reflected on list-name"}, {"in"=>"query", "name"=>"isbn", "description"=>"International Standard Book Number, 10 or 13 digits"}, {"in"=>"query", "name"=>"list-name", "description"=>"The name of the Times best-seller list"}, {"in"=>"query", "name"=>"offset", "description"=>"Sets the starting point of the result set"}, {"in"=>"query", "name"=>"published-date", "description"=>"YYYY-MM-DDThe date the best-seller list was published on NYTimes"}, {"in"=>"query", "name"=>"rank", "description"=>"The rank of the best seller on list-name as of bestsellers-date"}, {"in"=>"query", "name"=>"rank-last-week", "description"=>"The rank of the best seller on list-name one week prior to bestsellers-date"}, {"in"=>"query", "name"=>"sort-order", "description"=>"The default is ASC (ascending)"}, {"in"=>"query", "name"=>"weeks-on-list", "description"=>"The number of weeks that the best seller has been on list-name, as of bestsellers-date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Books"]}}, "/books/v2/lists/overview.{format}"=>{"get"=>{"summary"=>"Best Seller List Overview", "description"=>"The overview service returns the top 5 books for all the Best Sellers lists.", "operationId"=>"GET_lists-overview-format", "x-api-path-slug"=>"booksv2listsoverview-format-get", "parameters"=>[{"in"=>"query", "name"=>"api-key", "description"=>"The API key"}, {"in"=>"query", "name"=>"format", "description"=>"The format", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"published_date", "description"=>"The best-seller list publication date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Books"]}}, "/books/v2/lists/names.{format}"=>{"get"=>{"summary"=>"Best Seller List Names", "description"=>"The names service returns a list of Best Sellers list names. It includes in the response the type of list (weekly or monthly) and when it was first published and last published. Lists have been added and removed over time. For example the Food and Diet list was added in 2013 and the Children???s Chapter Books list was removed in 2012. The response also includes the list_name_encoded which you use when calling the details service.", "operationId"=>"GET_lists-names-format", "x-api-path-slug"=>"booksv2listsnames-format-get", "parameters"=>[{"in"=>"query", "name"=>"api-key", "description"=>"The API key"}, {"in"=>"query", "name"=>"format", "description"=>"The format", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Books"]}}, "/query.json"=>{"get"=>{"summary"=>"Geographic API", "description"=>"The Geographic API extends the Semantic API, using a linked data approach to enhance location concepts used in The New York Times' controlled vocabulary and data resources which combine them with the GeoNames database, an authoritative and free to use database of global geographical places, names and features.", "operationId"=>"geographic-api", "x-api-path-slug"=>"query-json-get", "parameters"=>[{"in"=>"query", "name"=>"date_range", "description"=>"Start date to end date in the following format- YYYY-MM-DD:YYYY-MM-DD"}, {"in"=>"query", "name"=>"elevation", "description"=>"The elevation of the specified place, in meters"}, {"in"=>"query", "name"=>"facets", "description"=>"When facets is set to 1, a count of all facets will be included in the response"}, {"in"=>"query", "name"=>"filter", "description"=>"Filters search results based on the facets provided"}, {"in"=>"query", "name"=>"latitude", "description"=>"The latitude of the specified place"}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of results returned"}, {"in"=>"query", "name"=>"longitude", "description"=>"The longitude of the specified place"}, {"in"=>"query", "name"=>"name", "description"=>"A displayable name for the specified place"}, {"in"=>"query", "name"=>"offset", "description"=>"Sets the starting point of the result set"}, {"in"=>"query", "name"=>"query", "description"=>"Search keywords to perform a text search on the fields: web_description, event_name and venue_name"}, {"in"=>"query", "name"=>"sort", "description"=>"Sorts your results on the fields specified"}, {"in"=>"query", "name"=>"sw", "description"=>"Along with ne, forms a bounded box using the longitude and latitude coordinates specified as the southwest corner"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Geo"]}}, "/mostpopular/v2/mostshared/{section}/{time-period}.json"=>{"get"=>{"summary"=>"Most Shared by Section & Time Period", "description"=>"With the Most Popular API, you can get links and metadata for the blog posts and articles that are most frequently e-mailed, shared and viewed by NYTimes.co", "operationId"=>"GET_mostshared-section-time-period-json", "x-api-path-slug"=>"mostpopularv2mostsharedsectiontimeperiod-json-get", "parameters"=>[{"in"=>"path", "name"=>"section", "description"=>"The section of the paper", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"time-period", "description"=>"The period of time", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News"]}}, "/mostpopular/v2/mostemailed/{section}/{time-period}.json"=>{"get"=>{"summary"=>"Most Emailed by Section & Time Period", "description"=>"With the Most Popular API, you can get links and metadata for the blog posts and articles that are most frequently e-mailed, shared and viewed by NYTimes.co", "operationId"=>"GET_mostemailed-section-time-period-json", "x-api-path-slug"=>"mostpopularv2mostemailedsectiontimeperiod-json-get", "parameters"=>[{"in"=>"path", "name"=>"section", "description"=>"The section of the paper", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"time-period", "description"=>"The period of time", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News"]}}, "/mostpopular/v2/mostviewed/{section}/{time-period}.json"=>{"get"=>{"summary"=>"Most Viewed by Section & Time Period", "description"=>"With the Most Popular API, you can get links and metadata for the blog posts and articles that are most frequently e-mailed, shared and viewed by NYTimes.co", "operationId"=>"GET_mostviewed-section-time-period-json", "x-api-path-slug"=>"mostpopularv2mostviewedsectiontimeperiod-json-get", "parameters"=>[{"in"=>"path", "name"=>"section", "description"=>"The section of the paper", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"time-period", "description"=>"The period of time", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News"]}}, "/movies/v2/reviews/search.json"=>{"get"=>{"summary"=>"Movie Review Search", "description"=>"With the Movie Reviews API, you can search New York Times movie reviews by keyword and get lists of NYT Critics' Picks.", "operationId"=>"getMoveReviews", "x-api-path-slug"=>"moviesv2reviewssearch-json-get", "parameters"=>[{"in"=>"query", "name"=>"critics-pick", "description"=>"Set this parameter to Y to limit the results to NYT Critics Picks"}, {"in"=>"query", "name"=>"offset", "description"=>"Positive integer, multiple of 20"}, {"in"=>"query", "name"=>"opening-date", "description"=>"Single date: YYYY-MM-DDStart and end date: YYYY-MM-DD;YYYY-MM-DDThe opening-date is the date the movies opening date in the New York region"}, {"in"=>"query", "name"=>"order", "description"=>"Sets the sort order of the results"}, {"in"=>"query", "name"=>"publication-date", "description"=>"Single date: YYYY-MM-DDStart and end date: YYYY-MM-DD;YYYY-MM-DDThe publication-date is the date the review was first published in The Times"}, {"in"=>"query", "name"=>"query", "description"=>"Search keywords; matches movie title and indexed termsTo limit your search to exact matches only, surround your search string with single quotation marks (e"}, {"in"=>"query", "name"=>"reviewer", "description"=>"Include this parameter to limit your results to reviews by a specific critic"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies", "Reviews"]}}, "/name/{concept-type}/{specific-concept}.json"=>{"get"=>{"summary"=>"The Semantic API", "description"=>"The Semantic API complements the Articles API. With the Semantic API, you get access to the long list of people, places, organizations and other locations, entities and descriptors that make up the controlled vocabulary used as metadata by The New York Times (sometimes referred to as Times Tags and used for Times Topics pages.", "operationId"=>"getSemantics", "x-api-path-slug"=>"nameconcepttypespecificconcept-json-get", "parameters"=>[{"in"=>"path", "name"=>"concept-type", "description"=>"The type of the concept, used for Constructing a Semantic API Request by Concept Type and Specific Concept Name"}, {"in"=>"query", "name"=>"fields", "description"=>"all or comma-separated list of specific optional fields: pages, ticker_symbol, links, taxonomy, combinations, geocodes, article_list, scope_notes, search_api_queryOptional fields are returned in result_set"}, {"in"=>"query", "name"=>"query", "description"=>"Precedes the search term string"}, {"in"=>"path", "name"=>"specific-concept", "description"=>"The name of the concept, used for Constructing a Semantic API Request by Concept Type and Specific Concept Name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Semantics", "News"]}}, "/timestags"=>{"get"=>{"summary"=>"Times Tag", "description"=>"With the TimesTags API, you can mine the riches of the New York Times tag set. The TimesTags service matches your query to the controlled vocabularies that fuel NYTimes.com metadata. You supply a string of characters, and the service returns a ranked list of suggested terms.", "operationId"=>"getTimesTag", "x-api-path-slug"=>"timestags-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"If you do not specify a value for filter (see the Optional Parameters), your query will be matched to tags in all four Times dictionaries: subject, geographic location, organization and person"}, {"in"=>"query", "name"=>"max", "description"=>"Sets the maximum number of results"}, {"in"=>"query", "name"=>"query", "description"=>"Your search query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}}}, "apis"=>{"name"=>"The New York Times", "x-slug"=>"the-new-york-times", "description"=>"The New York Times: Find breaking news, multimedia, reviews & opinion on Washington, business, sports, movies, travel, books, jobs, education, real estate, cars & more at nytimes.com.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/18820-new-york-times.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"117", "tags"=>"API Provider,General Data,Historical Data API,Media,News,Pedestal,Profiles,Publish,Relative Data,Relative StreamRank,Service API,Streams,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"the-new-york-times/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"The New York Times", "x-api-slug"=>"the-new-york-times", "description"=>"The New York Times: Find breaking news, multimedia, reviews & opinion on Washington, business, sports, movies, travel, books, jobs, education, real estate, cars & more at nytimes.com.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/18820-new-york-times.jpg", "humanURL"=>"http://nytimes.com", "baseURL"=>"https://api.nytimes.com//svc", "tags"=>"API Provider,General Data,Historical Data API,Media,News,Pedestal,Profiles,Publish,Relative Data,Relative StreamRank,Service API,Streams,Streams,Streams", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/the-new-york-times/timestags-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/the-new-york-times/the-new-york-times-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-application-gallery", "url"=>"http://developer.nytimes.com/gallery"}, {"type"=>"x-application-management", "url"=>"http://developer.nytimes.com/apps/mykeys"}, {"type"=>"x-base", "url"=>"http://api.nytimes.com"}, {"type"=>"x-curated-source", "url"=>"http://bits.blogs.nytimes.com/2016/01/27/lyft-agrees-to-settle-class-action-lawsuit-with-california-drivers/"}, {"type"=>"x-blog", "url"=>"http://open.blogs.nytimes.com/"}, {"type"=>"x-blog-rss", "url"=>"http://open.blogs.nytimes.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/newyorktimes"}, {"type"=>"x-curated-source", "url"=>"http://dealbook.nytimes.com/2013/06/04/salesforce-to-buy-exacttarget-for-2-5-billion/"}, {"type"=>"x-developer", "url"=>"http://developer.nytimes.com"}, {"type"=>"x-documentation", "url"=>"http://developer.nytimes.com/docs"}, {"type"=>"x-email", "url"=>"ayuda@nytimes.com"}, {"type"=>"x-email", "url"=>"accessibility@nytimes.com"}, {"type"=>"x-events", "url"=>"http://developers.nytimes.com/events/"}, {"type"=>"x-explorer", "url"=>"http://developer.nytimes.com/io-docs"}, {"type"=>"x-forum", "url"=>"http://developer.nytimes.com/forum"}, {"type"=>"x-forum-rss", "url"=>"http://developer.nytimes.com/forum.rss"}, {"type"=>"x-jobs", "url"=>"http://developers.nytimes.com/careers/"}, {"type"=>"x-blog-rss", "url"=>"http://www.nytimes.com/services/xml/rss/nyt/Technology.xml"}, {"type"=>"x-privacy", "url"=>"http://www.nytimes.com/content/help/rights/privacy/policy/privacy-policy.html"}, {"type"=>"x-curated-source", "url"=>"http://rss.nytimes.com/c/34625/f/640387/s/4ef17202/sc/13/l/0L0Snytimes0N0C20A160C0A40C150Ctechnology0Cmicrosoft0Esues0Eus0Eover0Eorders0Ebarring0Eit0Efrom0Erevealing0Esurveillance0Bhtml0Dpartner0Frss0Gemc0Frss/story01.htm"}, {"type"=>"x-selfservice-registration", "url"=>"https://myaccount.nytimes.com/register"}, {"type"=>"x-terms-of-service", "url"=>"http://developer.nytimes.com/Api_terms_of_use"}, {"type"=>"x-terms-of-service", "url"=>"https://developer.nytimes.com/tou"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/nytimes"}, {"type"=>"x-website", "url"=>"http://nytimes.com"}, {"type"=>"x-website", "url"=>"http://nytimes.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
transavia{"transavia-airports-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Transavia", "x-complete"=>1, "info"=>{"title"=>"Airports API v2", "description"=>"returns-all-airports", "version"=>"1.0"}, "host"=>"api.transavia.com", "basePath"=>"/v2/airports", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/"=>{"get"=>{"summary"=>"Get Airports", "description"=>"Retrieve all airports.", "operationId"=>".get", "x-api-path-slug"=>"get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Airports"]}}, "/countrycode/{countryCode}"=>{"get"=>{"summary"=>"Get Country Codes", "description"=>"Retrieve airports by country code.", "operationId"=>"countrycode.countryCode.get", "x-api-path-slug"=>"countrycodecountrycode-get", "parameters"=>[{"in"=>"path", "name"=>"countryCode", "description"=>"Comma-separated list of country codes (2-character ISO 3166-1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Airports", "Countrycode"]}}, "/nearest"=>{"get"=>{"summary"=>"Get Nearest Airports", "description"=>"Retrieve nearest airports by geo coordinates (latitude/longitude).", "operationId"=>"nearest.get", "x-api-path-slug"=>"nearest-get", "parameters"=>[{"in"=>"query", "name"=>"latitude", "description"=>"Latitude in decimals, lower than -90"}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the result, lower than 0 is not allowed"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude in decimals, lower than -180"}, {"in"=>"query", "name"=>"maxDistanceInKm", "description"=>"Maximum distance in kilometers, lower than 1 and higher than 500 is not allowed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Airports", "Nearest"]}}, "/nearest/{id}"=>{"get"=>{"summary"=>"Get Nearest Airport", "description"=>"Retrieve nearest airports by station id.", "operationId"=>"nearest.id.get", "x-api-path-slug"=>"nearestid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Airport (IATA code) to search nearest airports for"}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the result, lower than 0 is not allowed"}, {"in"=>"query", "name"=>"maxDistanceInKm", "description"=>"Maximum distance in kilometers, lower than 1 and higher than 500 is not allowed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Airports", "Nearest"]}}, "/{id}"=>{"get"=>{"summary"=>"Get Aiport", "description"=>"Retrieve airport by id.", "operationId"=>"id.get", "x-api-path-slug"=>"id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Airport code (3-character IATA code)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Airports"]}}}}, "transavia-routes-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Transavia", "x-complete"=>1, "info"=>{"title"=>"Routes API v3", "description"=>"returns-all-available-routes", "version"=>"1.0.0"}, "host"=>"tst.api.transavia.com", "basePath"=>"/v3/routes", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/"=>{"get"=>{"summary"=>"Get all routes by origin and/or destination", "description"=>"Retrieves all routes.", "operationId"=>"58d3ca3eab95b50fe4da10fd", "x-api-path-slug"=>"get", "parameters"=>[{"in"=>"query", "name"=>"Destination", "description"=>"IATA-code (3 characters) of the destination airport"}, {"in"=>"query", "name"=>"Origin", "description"=>"IATA-code (3 characters) of the origin airport"}], "responses"=>{2=>{"description"=>"Successful response"}, 200=>{"description"=>"Successful response"}}, "tags"=>["Airplanes", "Routes"]}}, "/{id}"=>{"get"=>{"summary"=>"Get route by id", "description"=>"Gets the route. Note, this request doesn't have a data property in the response.", "operationId"=>"58d3ca3eab95b50fe4da10fe", "x-api-path-slug"=>"id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Route identifier, {origin airport IATA-code}-{destination airport IATA-code}"}], "responses"=>{2=>{"description"=>"Successful response"}, 200=>{"description"=>"Successful response"}}, "tags"=>["Airplanes", "Routes"]}}}}, "transavia-flight-offers-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Transavia", "x-complete"=>1, "info"=>{"title"=>"Flight Offers API v1", "description"=>"returns-flight-offers", "version"=>"1.0.0"}, "host"=>"tst.api.transavia.com", "basePath"=>"/v1/flightoffers", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/"=>{"get"=>{"summary"=>"Flight offers", "description"=>"Retrieve flight offers by query string parameters.", "operationId"=>"58e50bf6ab95b50b8410ea72", "x-api-path-slug"=>"get", "parameters"=>[{"in"=>"query", "name"=>"Adults", "description"=>"Number of adult passengers (default = 1)"}, {"in"=>"query", "name"=>"Children", "description"=>"Number of children passengers (default = 0)"}, {"in"=>"query", "name"=>"DaysAtDestination", "description"=>"Duration in days of the time spent on the destination"}, {"in"=>"query", "name"=>"Destination", "description"=>"Routekey (single or multiple) of the destination based on airport IATA-code, comma separated"}, {"in"=>"query", "name"=>"DestinationArrivalDate", "description"=>"Date / Range to arrive at destination airport"}, {"in"=>"query", "name"=>"DestinationArrivalDayOfWeek", "description"=>"Preferred departureday(s) of week to arrive on destination airport, comma separated (mo,th,we)"}, {"in"=>"query", "name"=>"DestinationArrivalTime", "description"=>"Time range in which to arrive on destination airport"}, {"in"=>"query", "name"=>"DestinationDepartureDate", "description"=>"Date / Range to depart from destination airport"}, {"in"=>"query", "name"=>"DestinationDepartureDayOfWeek", "description"=>"Preferred departureday(s) of week to depart from destination airport, comma separated (mo,th,we)"}, {"in"=>"query", "name"=>"DestinationDepartureTime", "description"=>"Time range in which to depart from destination airport"}, {"in"=>"query", "name"=>"DirectFlight", "description"=>"When set to true, will only return direct flights"}, {"in"=>"query", "name"=>"GroupPricing", "description"=>"Show price-per-adult by default, or price for all passengers when set to true"}, {"in"=>"query", "name"=>"Include", "description"=>"Comma-separated list of advanced/optional fields to be included in the response"}, {"in"=>"query", "name"=>"Limit", "description"=>"Maximum number of items in the response (default = 100, max = 1000 for one-way / 200 for round-trip)"}, {"in"=>"query", "name"=>"LowestPricePerDestination", "description"=>"Return only the lowest price per destination when set to true (default = false)"}, {"in"=>"query", "name"=>"Loyalty", "description"=>"When set to FlyingBlue, filtering is based on Flying Blue points and results are returned in Flying Blue points"}, {"in"=>"query", "name"=>"Offset", "description"=>"Paging number of the limited result set (default = 0)"}, {"in"=>"query", "name"=>"OrderBy", "description"=>"Comma-separated list of fields on which the result must be ordered"}, {"in"=>"query", "name"=>"Origin", "description"=>"Routekey (single or multiple) of the origin based on airport IATA-code, comma separated"}, {"in"=>"query", "name"=>"OriginArrivalDate", "description"=>"Date / Range to arrive at origin airport"}, {"in"=>"query", "name"=>"OriginArrivalDayOfWeek", "description"=>"Preferred departureday(s) of week to arrive on origin airport, comma separated (mo,th,we)"}, {"in"=>"query", "name"=>"OriginArrivalTime", "description"=>"Time range in which to arrive at origin airport"}, {"in"=>"query", "name"=>"OriginDepartureDate", "description"=>"Date / Range to depart from origin airport"}, {"in"=>"query", "name"=>"OriginDepartureDayOfWeek", "description"=>"Preferred departureday(s) of week to depart from origin airport, comma separated (mo,th,we)"}, {"in"=>"query", "name"=>"OriginDepartureTime", "description"=>"Time range in which to depart from origin airport"}, {"in"=>"query", "name"=>"Price", "description"=>"Price range in euros or loyalty points for the flight offer"}, {"in"=>"query", "name"=>"ProductClass", "description"=>"Product Class or branded fare (basic, plus, max) (default = basic)"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Airlines", "Offers"]}}}}, "apis"=>{"name"=>"Transavia", "x-slug"=>"transavia", "description"=>"Want to fly affordably to more than 100 destinations in Europe? Book a flight with Transavia!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28522-airports-api-v2.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"12365", "tags"=>"Airlines,General Data,Service API,Travel", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"transavia/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Transavia Airports API", "x-api-slug"=>"transavia-airports-api", "description"=>"Want to fly affordably to more than 100 destinations in Europe? Book a flight with Transavia!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28522-airports-api-v2.jpg", "humanURL"=>"http://transavia.com", "baseURL"=>"https://api.transavia.com//v2/airports", "tags"=>"Airlines,General Data,Service API,Travel", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/transavia/id-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/transavia/transavia-airports-api-openapi.yaml"}]}, {"name"=>"Transavia Flight Offers API", "x-api-slug"=>"transavia-flight-offers-api", "description"=>"Want to fly affordably to more than 100 destinations in Europe? Book a flight with Transavia!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28522-airports-api-v2.jpg", "humanURL"=>"http://transavia.com", "baseURL"=>"https://tst.api.transavia.com//v1/flightoffers", "tags"=>"Airports", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/transavia/get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/transavia/transavia-flight-offers-api-openapi.yaml"}]}, {"name"=>"Transavia Routes API", "x-api-slug"=>"transavia-routes-api", "description"=>"Want to fly affordably to more than 100 destinations in Europe? Book a flight with Transavia!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28522-airports-api-v2.jpg", "humanURL"=>"http://transavia.com", "baseURL"=>"https://tst.api.transavia.com//v3/routes", "tags"=>"Airlines,Offers", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/transavia/id-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/transavia/transavia-routes-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/transavia-airlines"}, {"type"=>"x-developer", "url"=>"https://developer.transavia.com/"}, {"type"=>"x-documentation", "url"=>"https://tst.developer.transavia.com/docs/services/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/transavia"}, {"type"=>"x-website", "url"=>"http://transavia.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sendgrid{"sendgrid-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"SendGrid", "x-complete"=>1, "info"=>{"title"=>"SendGrid", "description"=>"the-sendgrid-web-api-v3-documentation--this-is-the-entirety-of-the-documented-v3-endpoints--we-have-updated-all-the-descriptions-parameters-requests-and-responses--authentication-every-endpoint-requires-authentication-in-the-form-of-an-authorization-header-authorization-bearer-api-key", "version"=>"1.0.0"}, "host"=>"api.sendgrid.com", "basePath"=>"/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/access_settings/activity"=>{"get"=>{"summary"=>"Get Access Settings Activity", "description"=>"**This endpoint allows you to retrieve a list of all of the IP addresses that recently attempted to access your account either through the User Interface or the API.**\n\nIP Access Management allows you to control which IP addresses can be used to access your account, either through the User Interface or the API. There is no limit to the number of IP addresses that you can add to your whitelist. It is possible to remove your own IP address from the whitelist, thus preventing yourself from accessing your account.\n\nFor more information, please see our [User Guide](http://sendgrid.com/docs/User_Guide/Settings/ip_access_management.html).", "operationId"=>"access_settings.activity.get", "x-api-path-slug"=>"access-settingsactivity-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limits the number of IPs to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Access", "Settings", "Activity"]}}, "/access_settings/whitelist"=>{"delete"=>{"summary"=>"Delete Access Settings Whitelist", "description"=>"**This endpoint allows you to remove one or more IPs from your IP whitelist.**\n\nYou can remove one IP at a time, or you can remove multiple IP addresses.\n\nIP Access Management allows you to control which IP addresses can be used to access your account, either through the User Interface or the API. There is no limit to the number of IP addresses that you can add to your whitelist. It is possible to remove your own IP address from the whitelist, thus preventing yourself from accessing your account.\n\nFor more information, please see our [User Guide](http://sendgrid.com/docs/User_Guide/Settings/ip_access_management.html).", "operationId"=>"access_settings.whitelist.delete", "x-api-path-slug"=>"access-settingswhitelist-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Access", "Settings", "Whitelist"]}, "get"=>{"summary"=>"Get Access Settings Whitelist", "description"=>"**This endpoint allows you to retrieve a list of IP addresses that are currently whitelisted.**\n\nIP Access Management allows you to control which IP addresses can be used to access your account, either through the User Interface or the API. There is no limit to the number of IP addresses that you can add to your whitelist. It is possible to remove your own IP address from the whitelist, thus preventing yourself from accessing your account.\n\nFor more information, please see our [User Guide](http://sendgrid.com/docs/User_Guide/Settings/ip_access_management.html).", "operationId"=>"access_settings.whitelist.get", "x-api-path-slug"=>"access-settingswhitelist-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Access", "Settings", "Whitelist"]}, "post"=>{"summary"=>"Add Access Settings Whitelist", "description"=>"**This endpoint allows you to add one or more IP addresses to your IP whitelist.**\n\nWhen adding an IP to your whitelist, include the IP address in an array. You can whitelist one IP at a time, or you can whitelist multiple IPs at once.\n\nIP Access Management allows you to control which IP addresses can be used to access your account, either through the User Interface or the API. There is no limit to the number of IP addresses that you can add to your whitelist. It is possible to remove your own IP address from the whitelist, thus preventing yourself from accessing your account.\n\nFor more information, please see our [User Guide](http://sendgrid.com/docs/User_Guide/Settings/ip_access_management.html).", "operationId"=>"access_settings.whitelist.post", "x-api-path-slug"=>"access-settingswhitelist-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Access", "Settings", "Whitelist"]}}, "/access_settings/whitelist/{rule_id}"=>{"delete"=>{"summary"=>"Delete Access Settings Whitelist Rule", "description"=>"**This endpoint allows you to remove a specific IP address from your IP whitelist.**\n\nWhen removing a specific IP address from your whitelist, you must include the ID in your call.\n\nIP Access Management allows you to control which IP addresses can be used to access your account, either through the User Interface or the API. There is no limit to the number of IP addresses that you can add to your whitelist. It is possible to remove your own IP address from the whitelist, thus preventing yourself from accessing your account.\n\nFor more information, please see our [User Guide](http://sendgrid.com/docs/User_Guide/Settings/ip_access_management.html).", "operationId"=>"access_settings.whitelist.rule_id.delete", "x-api-path-slug"=>"access-settingswhitelistrule-id-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Access", "Settings", "Whitelist", "Rule"]}, "get"=>{"summary"=>"Get Access Settings Whitelist Rule", "description"=>"**This endpoint allows you to retreive a specific IP address that has been whitelisted.**\n\nYou must include the ID for the specific IP address you want to retrieve in your call.\n\nIP Access Management allows you to control which IP addresses can be used to access your account, either through the User Interface or the API. There is no limit to the number of IP addresses that you can add to your whitelist. It is possible to remove your own IP address from the whitelist, thus preventing yourself from accessing your account.\n\nFor more information, please see our [User Guide](http://sendgrid.com/docs/User_Guide/Settings/ip_access_management.html).", "operationId"=>"access_settings.whitelist.rule_id.get", "x-api-path-slug"=>"access-settingswhitelistrule-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Access", "Settings", "Whitelist", "Rule"]}}, "/alerts"=>{"get"=>{"summary"=>"Get Alerts", "description"=>"**This endpoint allows you to retieve all of your alerts.**\n\nAlerts allow you to specify an email address to receive notifications regarding your email usage or statistics. \n* Usage alerts allow you to set the threshold at which an alert will be sent.\n* Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, \"daily\", \"weekly\", or \"monthly\".\n\nFor more information about alerts, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/alerts.html).", "operationId"=>"GET_alerts", "x-api-path-slug"=>"alerts-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Alerts"]}, "post"=>{"summary"=>"Add Alerts", "description"=>"**This endpoint allows you to create a new alert.**\n\nAlerts allow you to specify an email address to receive notifications regarding your email usage or statistics. There are two types of alerts that can be created with this endpoint:\n\n* `usage_limit` allows you to set the threshold at which an alert will be sent.\n* `stats_notification` allows you to set how frequently you would like to receive email statistics reports. For example, \"daily\", \"weekly\", or \"monthly\".\n\nFor more information about alerts, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/alerts.html).", "operationId"=>"POST_alerts", "x-api-path-slug"=>"alerts-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"on-behalf-of"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Alerts"]}}, "/alerts/{alert_id}"=>{"delete"=>{"summary"=>"Delete Alerts Alert", "description"=>"**This endpoint allows you to delete an alert.**\n\nAlerts allow you to specify an email address to receive notifications regarding your email usage or statistics. \n* Usage alerts allow you to set the threshold at which an alert will be sent.\n* Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, \"daily\", \"weekly\", or \"monthly\".\n\nFor more information about alerts, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/alerts.html).", "operationId"=>"alerts.alert_id.delete", "x-api-path-slug"=>"alertsalert-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Alerts", "Alert"]}, "get"=>{"summary"=>"Get Alerts Alert", "description"=>"**This endpoint allows you to retrieve a specific alert.**\n\nAlerts allow you to specify an email address to receive notifications regarding your email usage or statistics. \n* Usage alerts allow you to set the threshold at which an alert will be sent.\n* Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, \"daily\", \"weekly\", or \"monthly\".\n\nFor more information about alerts, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/alerts.html).", "operationId"=>"alerts.alert_id.get", "x-api-path-slug"=>"alertsalert-id-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Alerts", "Alert"]}, "patch"=>{"summary"=>"Patch Alerts Alert", "description"=>"**This endpoint allows you to update an alert.**\n\nAlerts allow you to specify an email address to receive notifications regarding your email usage or statistics. \n* Usage alerts allow you to set the threshold at which an alert will be sent.\n* Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, \"daily\", \"weekly\", or \"monthly\".\n\nFor more information about alerts, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/alerts.html).", "operationId"=>"alerts.alert_id.patch", "x-api-path-slug"=>"alertsalert-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Alerts", "Alert"]}}, "/api_keys"=>{"get"=>{"summary"=>"Get Api Keys", "description"=>"**This endpoint allows you to retrieve all API Keys that belong to the authenticated user.**\n\nThe API Keys feature allows customers to be able to generate an API Key credential which can be used for authentication with the SendGrid v3 Web API or the [Mail API Endpoint](https://sendgrid.com/docs/API_Reference/Web_API/mail.html).", "operationId"=>"GET_api_keys", "x-api-path-slug"=>"api-keys-get", "parameters"=>[{"in"=>"query", "name"=>"limit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Api", "Keys"]}, "post"=>{"summary"=>"Add Api Keys", "description"=>"**This endpoint allows you to create a new random API Key for the user.**\n\nA JSON request body containing a \"name\" property is required. If number of maximum keys is reached, HTTP 403 will be returned.\n\nThere is a limit of 100 API Keys on your account.\n\nThe API Keys feature allows customers to be able to generate an API Key credential which can be used for authentication with the SendGrid v3 Web API or the [Mail API Endpoint](https://sendgrid.com/docs/API_Reference/Web_API/mail.html).\n\nSee the [API Key Permissions List](https://sendgrid.com/docs/API_Reference/Web_API_v3/API_Keys/api_key_permissions_list.html) for a list of all available scopes.", "operationId"=>"api_keys.post", "x-api-path-slug"=>"api-keys-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Api", "Keys"]}}, "/api_keys/{api_key_id}"=>{"delete"=>{"summary"=>"Delete Api Keys Api Key", "description"=>"**This endpoint allows you to revoke an existing API Key**\n\nAuthentications using this API Key will fail after this request is made, with some small propogation delay.If the API Key ID does not exist an HTTP 404 will be returned.\n\nThe API Keys feature allows customers to be able to generate an API Key credential which can be used for authentication with the SendGrid v3 Web API or the [Mail API Endpoint](https://sendgrid.com/docs/API_Reference/Web_API/mail.html).\n\n## URI Parameters\n\n| URI Parameter | Type | Required? | Description |\n|---|---|---|---|\n|api_key_id |string | required | The ID of the API Key you are deleting.|", "operationId"=>"api_keys.api_key_id.delete", "x-api-path-slug"=>"api-keysapi-key-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Api", "Keys", "Api", "Key"]}, "get"=>{"summary"=>"Get Api Keys Api Key", "description"=>"**This endpoint allows you to retrieve a single api key.**\n\nIf the API Key ID does not exist an HTTP 404 will be returned.", "operationId"=>"api_keys.api_key_id.get", "x-api-path-slug"=>"api-keysapi-key-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Api", "Keys", "Api", "Key"]}, "patch"=>{"summary"=>"Patch Api Keys Api Key", "description"=>"**This endpoint allows you to update the name of an existing API Key.**\n\nA JSON request body with a \"name\" property is required.\n\nThe API Keys feature allows customers to be able to generate an API Key credential which can be used for authentication with the SendGrid v3 Web API or the [Mail API Endpoint](https://sendgrid.com/docs/API_Reference/Web_API/mail.html).\n\n## URI Parameters\n\n| URI Parameter | Type | Required? | Description |\n|---|---|---|---|\n|api_key_id |string | required | The ID of the API Key you are updating.|", "operationId"=>"api_keys.api_key_id.patch", "x-api-path-slug"=>"api-keysapi-key-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Api", "Keys", "Api", "Key"]}, "put"=>{"summary"=>"Put Api Keys Api Key", "description"=>"**This endpoint allows you to update the name and scopes of a given API key.**\n\nA JSON request body with a \"name\" property is required.\nMost provide the list of all the scopes an api key should have.\n\nThe API Keys feature allows customers to be able to generate an API Key credential which can be used for authentication with the SendGrid v3 Web API or the [Mail API Endpoint](https://sendgrid.com/docs/API_Reference/Web_API/mail.html).", "operationId"=>"api_keys.api_key_id.put", "x-api-path-slug"=>"api-keysapi-key-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Api", "Keys", "Api", "Key"]}}, "/asm/groups"=>{"get"=>{"summary"=>"Get Asm Groups", "description"=>"**This endpoint allows you to retrieve information about multiple suppression groups.**\n\nThis endpoint will return information for each group ID that you include in your request. To add a group ID to your request, simply append `&id=` followed by the group ID.\n\nSuppressions are a list of email addresses that will not receive content sent under a given [group](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html).\n\nSuppression groups, or [unsubscribe groups](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html), allow you to label a category of content that you regularly send. This gives your recipients the ability to opt out of a specific set of your email. For example, you might define a group for your transactional email, and one for your marketing email so that your users can continue recieving your transactional email witout having to receive your marketing content.", "operationId"=>"asm.groups.get", "x-api-path-slug"=>"asmgroups-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The ID of a suppression group that you want to retrieve information for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Asm", "Groups"]}, "post"=>{"summary"=>"Add Asm Groups", "description"=>"**This endpoint allows you to create a new suppression group.**\n\nSuppression groups, or unsubscribe groups, are specific types or categories of email that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.\n\nThe **name** and **description** of the unsubscribe group will be visible by recipients when they are managing their subscriptions.\n\nEach user can create up to 25 different suppression groups.", "operationId"=>"asm.groups.post", "x-api-path-slug"=>"asmgroups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Asm", "Groups"]}}, "/asm/groups/{group_id}"=>{"delete"=>{"summary"=>"Delete Asm Groups Group", "description"=>"**This endpoint allows you to delete a suppression group.**\n\nYou can only delete groups that have not been attached to sent mail in the last 60 days. If a recipient uses the \"one-click unsubscribe\" option on an email associated with a deleted group, that recipient will be added to the global suppression list.\n\nSuppression groups, or unsubscribe groups, are specific types or categories of email that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.\n\nThe **name** and **description** of the unsubscribe group will be visible by recipients when they are managing their subscriptions.\n\nEach user can create up to 25 different suppression groups.", "operationId"=>"asm.groups.group_id.delete", "x-api-path-slug"=>"asmgroupsgroup-id-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Asm", "Groups", "Group"]}, "get"=>{"summary"=>"Get Asm Groups Group", "description"=>"**This endpoint allows you to retrieve a single suppression group.**\n\nSuppression groups, or unsubscribe groups, are specific types or categories of email that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.\n\nThe **name** and **description** of the unsubscribe group will be visible by recipients when they are managing their subscriptions.\n\nEach user can create up to 25 different suppression groups.", "operationId"=>"asm.groups.group_id.get", "x-api-path-slug"=>"asmgroupsgroup-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Asm", "Groups", "Group"]}, "patch"=>{"summary"=>"Patch Asm Groups Group", "description"=>"**This endpoint allows you to update or change a suppression group.**\n\nSuppression groups, or unsubscribe groups, are specific types or categories of email that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.\n\nThe **name** and **description** of the unsubscribe group will be visible by recipients when they are managing their subscriptions.\n\nEach user can create up to 25 different suppression groups.", "operationId"=>"asm.groups.group_id.patch", "x-api-path-slug"=>"asmgroupsgroup-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Asm", "Groups", "Group"]}}, "/asm/groups/{group_id}/suppressions"=>{"get"=>{"summary"=>"Get Asm Groups Group Suppressions", "description"=>"**This endpoint allows you to retrieve all suppressed email addresses belonging to the given group.**\n\nSuppressions are recipient email addresses that are added to [unsubscribe groups](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html). Once a recipient's address is on the suppressions list for an unsubscribe group, they will not receive any emails that are tagged with that unsubscribe group.", "operationId"=>"asm.groups.group_id.suppressions.get", "x-api-path-slug"=>"asmgroupsgroup-idsuppressions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Asm", "Groups", "Group", "", "Suppressions"]}, "post"=>{"summary"=>"Add Asm Groups Group Suppressions", "description"=>"**This endpoint allows you to add email addresses to an unsubscribe group.**\n\nIf you attempt to add suppressions to a group that has been deleted or does not exist, the suppressions will be added to the global suppressions list.\n\nSuppressions are recipient email addresses that are added to [unsubscribe groups](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html). Once a recipient's address is on the suppressions list for an unsubscribe group, they will not receive any emails that are tagged with that unsubscribe group.", "operationId"=>"asm.groups.group_id.suppressions.post", "x-api-path-slug"=>"asmgroupsgroup-idsuppressions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Asm", "Groups", "Group", "", "Suppressions"]}}, "/asm/groups/{group_id}/suppressions/search"=>{"post"=>{"summary"=>"Add Asm Groups Group Suppressions Search", "description"=>"**This endpoint allows you to search a suppression group for multiple suppressions.**\n\nWhen given a list of email addresses and a group ID, this endpoint will return only the email addresses that have been unsubscribed from the given group.\n\nSuppressions are a list of email addresses that will not receive content sent under a given [group](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html).", "operationId"=>"asm.groups.group_id.suppressions.search.post", "x-api-path-slug"=>"asmgroupsgroup-idsuppressionssearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Asm", "Groups", "Group", "", "Suppressions", "Search"]}}, "/asm/groups/{group_id}/suppressions/{email}"=>{"delete"=>{"summary"=>"Delete Asm Groups Group Suppressions Email", "description"=>"**This endpoint allows you to remove a suppressed email address from the given suppression group.**\n\nSuppressions are recipient email addresses that are added to [unsubscribe groups](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html). Once a recipient's address is on the suppressions list for an unsubscribe group, they will not receive any emails that are tagged with that unsubscribe group.", "operationId"=>"asm.groups.group_id.suppressions.email.delete", "x-api-path-slug"=>"asmgroupsgroup-idsuppressionsemail-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Asm", "Groups", "Group", "", "Suppressions", "Email"]}}, "/asm/suppressions"=>{"get"=>{"summary"=>"Get Asm Suppressions", "description"=>"**This endpoint allows you to retrieve a list of all suppressions.**\n\nSuppressions are a list of email addresses that will not receive content sent under a given [group](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html).", "operationId"=>"asm.suppressions.get", "x-api-path-slug"=>"asmsuppressions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Asm", "Suppressions"]}}, "/asm/suppressions/global"=>{"post"=>{"summary"=>"Add Asm Suppressions Global", "description"=>"**This endpoint allows you to add one or more email addresses to the global suppressions group.**\n\nA global suppression (or global unsubscribe) is an email address of a recipient who does not want to receive any of your messages. A globally suppressed recipient will be removed from any email you send. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Suppressions/global_unsubscribes.html).", "operationId"=>"asm.suppressions.global.post", "x-api-path-slug"=>"asmsuppressionsglobal-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Asm", "Suppressions", "Global"]}}, "/asm/suppressions/global/{email}"=>{"delete"=>{"summary"=>"Delete Asm Suppressions Global Email", "description"=>"**This endpoint allows you to remove an email address from the global suppressions group.**\n\nA global suppression (or global unsubscribe) is an email address of a recipient who does not want to receive any of your messages. A globally suppressed recipient will be removed from any email you send. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Suppressions/global_unsubscribes.html).", "operationId"=>"asm.suppressions.global.email.delete", "x-api-path-slug"=>"asmsuppressionsglobalemail-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Asm", "Suppressions", "Global", "Email"]}, "get"=>{"summary"=>"Get Asm Suppressions Global Email", "description"=>"**This endpoint allows you to retrieve a global suppression. You can also use this endpoint to confirm if an email address is already globally suppresed.**\n\nIf the email address you include in the URL path parameter `{email}` is alreayd globally suppressed, the response will include that email address. If the address you enter for `{email}` is not globally suppressed, an empty JSON object `{}` will be returned.\n\nA global suppression (or global unsubscribe) is an email address of a recipient who does not want to receive any of your messages. A globally suppressed recipient will be removed from any email you send. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Suppressions/global_unsubscribes.html).", "operationId"=>"asm.suppressions.global.email.get", "x-api-path-slug"=>"asmsuppressionsglobalemail-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Asm", "Suppressions", "Global", "Email"]}}, "/asm/suppressions/{email}"=>{"get"=>{"summary"=>"Get Asm Suppressions Email", "description"=>"**This endpoint returns the list of all groups that the given email address has been unsubscribed from.**\n\nSuppressions are a list of email addresses that will not receive content sent under a given [group](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html).", "operationId"=>"asm.suppressions.email.get", "x-api-path-slug"=>"asmsuppressionsemail-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Asm", "Suppressions", "Email"]}}, "/browsers/stats"=>{"get"=>{"summary"=>"Get Browsers Stats", "description"=>"**This endpoint allows you to retrieve your email statistics segmented by browser type.**\n\n**We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints.\n\nAdvanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/index.html).", "operationId"=>"browsers.stats.get", "x-api-path-slug"=>"browsersstats-get", "parameters"=>[{"in"=>"query", "name"=>"aggregated_by", "description"=>"How to group the stats"}, {"in"=>"query", "name"=>"browsers", "description"=>"The browsers to get statistics for"}, {"in"=>"query", "name"=>"end_date", "description"=>"The end date of the statistics to retrieve"}, {"in"=>"query", "name"=>"limit", "description"=>"The number of results to include on each page"}, {"in"=>"query", "name"=>"offset", "description"=>"The number of results to exclude"}, {"in"=>"query", "name"=>"start_date", "description"=>"The starting date of the statistics to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Browsers", "Stats"]}}, "/campaigns"=>{"get"=>{"summary"=>"Get Campaigns", "description"=>"**This endpoint allows you to retrieve a list of all of your campaigns.**\n\nReturns campaigns in reverse order they were created (newest first).\n\nReturns an empty array if no campaigns exist.\n\nFor more information:\n\n* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html)", "operationId"=>"GET_campaigns", "x-api-path-slug"=>"campaigns-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"The number of results you would like to receive at a time"}, {"in"=>"query", "name"=>"offset", "description"=>"The index of the first campaign to return, where 0 is the first campaign"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Campaigns"]}, "post"=>{"summary"=>"Add Campaigns", "description"=>"**This endpoint allows you to create a campaign.**\n\nOur Marketing Campaigns API lets you create, manage, send, and schedule campaigns.\n\nNote: In order to send or schedule the campaign, you will be required to provide a subject, sender ID, content (we suggest both html and plain text), and at least one list or segment ID. This information is not required when you create a campaign.\n\nFor more information:\n\n* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html)", "operationId"=>"POST_campaigns", "x-api-path-slug"=>"campaigns-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Campaigns"]}}, "/campaigns/{campaign_id}"=>{"delete"=>{"summary"=>"Delete Campaigns Campaign", "description"=>"**This endpoint allows you to delete a specific campaign.**\n\nOur Marketing Campaigns API lets you create, manage, send, and schedule campaigns.\n\nFor more information:\n\n* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html)", "operationId"=>"campaigns.campaign_id.delete", "x-api-path-slug"=>"campaignscampaign-id-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Campaigns", "Campaign"]}, "get"=>{"summary"=>"Get Campaigns Campaign", "description"=>"**This endpoint allows you to retrieve a specific campaign.**\n\nOur Marketing Campaigns API lets you create, manage, send, and schedule campaigns.\n\nFor more information:\n\n* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html)", "operationId"=>"campaigns.campaign_id.get", "x-api-path-slug"=>"campaignscampaign-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Campaigns", "Campaign"]}, "patch"=>{"summary"=>"Patch Campaigns Campaign", "description"=>"Update a campaign. This is especially useful if you only set up the campaign using POST /campaigns, but didn't set many of the parameters.\n\nFor more information:\n\n* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html)", "operationId"=>"campaigns.campaign_id.patch", "x-api-path-slug"=>"campaignscampaign-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Campaigns", "Campaign"]}}, "/campaigns/{campaign_id}/schedules"=>{"delete"=>{"summary"=>"Delete Campaigns Campaign Schedules", "description"=>"**This endpoint allows you to unschedule a campaign that has already been scheduled to be sent.**\n\nA successful unschedule will return a 204.\nIf the specified campaign is in the process of being sent, the only option is to cancel (a different method).\n\nFor more information:\n\n* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html)", "operationId"=>"campaigns.campaign_id.schedules.delete", "x-api-path-slug"=>"campaignscampaign-idschedules-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Campaigns", "Campaign", "", "Schedules"]}, "get"=>{"summary"=>"Get Campaigns Campaign Schedules", "description"=>"**This endpoint allows you to retrieve the date and time that the given campaign has been scheduled to be sent.**\n\nFor more information:\n\n* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html)", "operationId"=>"campaigns.campaign_id.schedules.get", "x-api-path-slug"=>"campaignscampaign-idschedules-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Campaigns", "Campaign", "", "Schedules"]}, "patch"=>{"summary"=>"Patch Campaigns Campaign Schedules", "description"=>"**This endpoint allows to you change the scheduled time and date for a campaign to be sent.**\n\nFor more information:\n\n* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html)", "operationId"=>"campaigns.campaign_id.schedules.patch", "x-api-path-slug"=>"campaignscampaign-idschedules-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Campaigns", "Campaign", "", "Schedules"]}, "post"=>{"summary"=>"Add Campaigns Campaign Schedules", "description"=>"**This endpoint allows you to schedule a specific date and time for your campaign to be sent.**\n\nFor more information:\n\n* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html)", "operationId"=>"campaigns.campaign_id.schedules.post", "x-api-path-slug"=>"campaignscampaign-idschedules-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Campaigns", "Campaign", "", "Schedules"]}}, "/campaigns/{campaign_id}/schedules/now"=>{"post"=>{"summary"=>"Add Campaigns Campaign Schedules Now", "description"=>"**This endpoint allows you to immediately send a campaign at the time you make the API call.**\n\nNormally a POST would have a request body, but since this endpoint is telling us to send a resource that is already created, a request body is not needed.\n\nFor more information:\n\n* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html)", "operationId"=>"campaigns.campaign_id.schedules.now.post", "x-api-path-slug"=>"campaignscampaign-idschedulesnow-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Campaigns", "Campaign", "", "Schedules", "Now"]}}, "/campaigns/{campaign_id}/schedules/test"=>{"post"=>{"summary"=>"Add Campaigns Campaign Schedules Test", "description"=>"**This endpoint allows you to send a test campaign.**\n\nTo send to multiple addresses, use an array for the JSON \"to\" value [\"one@address\",\"two@address\"]\n\nFor more information:\n\n* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html)", "operationId"=>"campaigns.campaign_id.schedules.test.post", "x-api-path-slug"=>"campaignscampaign-idschedulestest-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Campaigns", "Campaign", "", "Schedules", "Test"]}}, "/categories"=>{"get"=>{"summary"=>"Get Categories", "description"=>"**This endpoint allows you to retrieve a list of all of your categories.**\n\nCategories can help organize your email analytics by enabling you to ???tag??? emails by type or broad topic. You can define your own custom categories. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/categories.html).", "operationId"=>"GET_categories", "x-api-path-slug"=>"categories-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"Allows you to perform a prefix search on this particular category"}, {"in"=>"query", "name"=>"limit", "description"=>"The number of categories to display per page"}, {"in"=>"query", "name"=>"offset", "description"=>"The point in the list that you would like to begin displaying results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Categories"]}}, "/categories/stats"=>{"get"=>{"summary"=>"Get Categories Stats", "description"=>"**This endpoint allows you to retrieve all of your email statistics for each of your categories.**\n\nIf you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.\n\nCategories allow you to group your emails together according to broad topics that you define. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/categories.html).", "operationId"=>"categories.stats.get", "x-api-path-slug"=>"categoriesstats-get", "parameters"=>[{"in"=>"query", "name"=>"aggregated_by", "description"=>"How to group the statistics"}, {"in"=>"query", "name"=>"categories", "description"=>"The individual categories that you want to retrieve statistics for"}, {"in"=>"query", "name"=>"end_date", "description"=>"The end date of the statistics to retrieve"}, {"in"=>"query", "name"=>"limit", "description"=>"The number of results to include"}, {"in"=>"query", "name"=>"offset", "description"=>"The number of results to skip"}, {"in"=>"query", "name"=>"start_date", "description"=>"The starting date of the statistics to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Categories", "Stats"]}}, "/categories/stats/sums"=>{"get"=>{"summary"=>"Get Categories Stats Sums", "description"=>"**This endpoint allows you to retrieve the total sum of each email statistic for every category over the given date range.**\n\nIf you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.\n\nCategories allow you to group your emails together according to broad topics that you define. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/categories.html).", "operationId"=>"categories.stats.sums.get", "x-api-path-slug"=>"categoriesstatssums-get", "parameters"=>[{"in"=>"query", "name"=>"aggregated_by", "description"=>"How to group the statistics"}, {"in"=>"query", "name"=>"end_date", "description"=>"The end date of the statistics to retrieve"}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of results returned"}, {"in"=>"query", "name"=>"offset", "description"=>"The point in the list to begin retrieving results"}, {"in"=>"query", "name"=>"sort_by_direction", "description"=>"The direction you want to sort"}, {"in"=>"query", "name"=>"sort_by_metric", "description"=>"The metric that you want to sort by"}, {"in"=>"query", "name"=>"start_date", "description"=>"The starting date of the statistics to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Categories", "Stats", "Sums"]}}, "/clients/stats"=>{"get"=>{"summary"=>"Get Clients Stats", "description"=>"**This endpoint allows you to retrieve your email statistics segmented by client type.**\n\n**We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints.\n\nAdvanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/index.html).", "operationId"=>"clients.stats.get", "x-api-path-slug"=>"clientsstats-get", "parameters"=>[{"in"=>"query", "name"=>"aggregated_by", "description"=>"How to group the statistics"}, {"in"=>"query", "name"=>"end_date", "description"=>"The end date of the statistics to retrieve"}, {"in"=>"query", "name"=>"start_date", "description"=>"The starting date of the statistics to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Clients", "Stats"]}}, "/clients/{client_type}/stats"=>{"get"=>{"summary"=>"Get Clients Client Type Stats", "description"=>"**This endpoint allows you to retrieve your email statistics segmented by a specific client type.**\n\n**We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints.\n\n## Available Client Types\n- phone\n- tablet\n- webmail\n- desktop\n\nAdvanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/index.html).", "operationId"=>"clients.client_type.stats.get", "x-api-path-slug"=>"clientsclient-typestats-get", "parameters"=>[{"in"=>"query", "name"=>"aggregated_by", "description"=>"How to group the statistics"}, {"in"=>"query", "name"=>"end_date", "description"=>"The end date of the statistics to retrieve"}, {"in"=>"query", "name"=>"start_date", "description"=>"The starting date of the statistics to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Clients", "Client", "Type", "Stats"]}}, "/contactdb/custom_fields"=>{"get"=>{"summary"=>"Get Contactdb Custom Fields", "description"=>"**This endpoint allows you to retrieve all custom fields.** \n\nThe contactdb is a database of your contacts for [SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html).", "operationId"=>"contactdb.custom_fields.get", "x-api-path-slug"=>"contactdbcustom-fields-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Custom", "Fields"]}, "post"=>{"summary"=>"Add Contactdb Custom Fields", "description"=>"**This endpoint allows you to create a custom field.**\n\nThe contactdb is a database of your contacts for [SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html).", "operationId"=>"contactdb.custom_fields.post", "x-api-path-slug"=>"contactdbcustom-fields-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Custom", "Fields"]}}, "/contactdb/custom_fields/{custom_field_id}"=>{"delete"=>{"summary"=>"Delete Contactdb Custom Fields Custom Field", "description"=>"**This endpoint allows you to delete a custom field by ID.**\n\nThe contactdb is a database of your contacts for [SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html).", "operationId"=>"contactdb.custom_fields.custom_field_id.delete", "x-api-path-slug"=>"contactdbcustom-fieldscustom-field-id-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Custom", "Fields", "Custom", "Field"]}, "get"=>{"summary"=>"Get Contactdb Custom Fields Custom Field", "description"=>"**This endpoint allows you to retrieve a custom field by ID.**\n\nThe contactdb is a database of your contacts for [SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html).", "operationId"=>"contactdb.custom_fields.custom_field_id.get", "x-api-path-slug"=>"contactdbcustom-fieldscustom-field-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Custom", "Fields", "Custom", "Field"]}}, "/contactdb/lists"=>{"delete"=>{"summary"=>"Delete Contactdb Lists", "description"=>"**This endpoint allows you to delete multiple recipient lists.**\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.", "operationId"=>"contactdb.lists.delete", "x-api-path-slug"=>"contactdblists-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Lists"]}, "get"=>{"summary"=>"Get Contactdb Lists", "description"=>"**This endpoint allows you to retrieve all of your recipient lists. If you don't have any lists, an empty array will be returned.**\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.", "operationId"=>"contactdb.lists.get", "x-api-path-slug"=>"contactdblists-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Lists"]}, "post"=>{"summary"=>"Add Contactdb Lists", "description"=>"**This endpoint allows you to create a list for your recipients.**\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.", "operationId"=>"contactdb.lists.post", "x-api-path-slug"=>"contactdblists-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Lists"]}}, "/contactdb/lists/{list_id}"=>{"delete"=>{"summary"=>"Delete Contactdb Lists List", "description"=>"**This endpoint allows you to delete a specific recipient list with the given ID.**\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.", "operationId"=>"contactdb.lists.list_id.delete", "x-api-path-slug"=>"contactdblistslist-id-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"delete_contacts", "description"=>"Adds the ability to delete all contacts on the list in addition to deleting the list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Lists", "List"]}, "get"=>{"summary"=>"Get Contactdb Lists List", "description"=>"This endpoint allows you to retrieve a single recipient list.\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.", "operationId"=>"contactdb.lists.list_id.get", "x-api-path-slug"=>"contactdblistslist-id-get", "parameters"=>[{"in"=>"query", "name"=>"list_id", "description"=>"The ID of the list to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Lists", "List"]}, "patch"=>{"summary"=>"Patch Contactdb Lists List", "description"=>"**This endpoint allows you to update the name of one of your recipient lists.**\n\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.", "operationId"=>"contactdb.lists.list_id.patch", "x-api-path-slug"=>"contactdblistslist-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"list_id", "description"=>"The ID of the list you are updating"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Lists", "List"]}}, "/contactdb/lists/{list_id}/recipients"=>{"get"=>{"summary"=>"Get Contactdb Lists List Recipients", "description"=>"**This endpoint allows you to retrieve all recipients on the list with the given ID.** \n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.", "operationId"=>"contactdb.lists.list_id.recipients.get", "x-api-path-slug"=>"contactdblistslist-idrecipients-get", "parameters"=>[{"in"=>"query", "name"=>"list_id", "description"=>"The ID of the list whose recipients you are requesting"}, {"in"=>"query", "name"=>"page", "description"=>"Page index of first recipient to return (must be a positive integer)"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of recipients to return at a time (must be a positive integer between 1 and 1000)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Lists", "List", "", "Recipients"]}, "post"=>{"summary"=>"Add Contactdb Lists List Recipients", "description"=>"**This endpoint allows you to add multiple recipients to a list.**\n\nAdds existing recipients to a list, passing in the recipient IDs to add. Recipient IDs should be passed exactly as they are returned from recipient endpoints.\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.", "operationId"=>"contactdb.lists.list_id.recipients.post", "x-api-path-slug"=>"contactdblistslist-idrecipients-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Lists", "List", "", "Recipients"]}}, "/contactdb/lists/{list_id}/recipients/{recipient_id}"=>{"delete"=>{"summary"=>"Delete Contactdb Lists List Recipients Recipient", "description"=>"**This endpoint allows you to delete a single recipient from a list.**\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.", "operationId"=>"contactdb.lists.list_id.recipients.recipient_id.delete", "x-api-path-slug"=>"contactdblistslist-idrecipientsrecipient-id-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"list_id", "description"=>"The ID of the list you are taking this recipient away from"}, {"in"=>"query", "name"=>"recipient_id", "description"=>"The ID of the recipient to take off the list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Lists", "List", "", "Recipients", "Recipient"]}, "post"=>{"summary"=>"Add Contactdb Lists List Recipients Recipient", "description"=>"**This endpoint allows you to add a single recipient to a list.**\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.", "operationId"=>"contactdb.lists.list_id.recipients.recipient_id.post", "x-api-path-slug"=>"contactdblistslist-idrecipientsrecipient-id-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Lists", "List", "", "Recipients", "Recipient"]}}, "/contactdb/recipients"=>{"delete"=>{"summary"=>"Delete Contactdb Recipients", "description"=>"**This endpoint allows you to deletes one or more recipients.**\n\nThe body of an API call to this endpoint must include an array of recipient IDs of the recipients you want to delete.\n\nThe contactdb is a database of your contacts for [SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html).", "operationId"=>"contactdb.recipients.delete", "x-api-path-slug"=>"contactdbrecipients-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Recipients"]}, "get"=>{"summary"=>"Get Contactdb Recipients", "description"=>"**This endpoint allows you to retrieve all of your Marketing Campaigns recipients.**\n\nBatch deletion of a page makes it possible to receive an empty page of recipients before reaching the end of\nthe list of recipients. To avoid this issue; iterate over pages until a 404 is retrieved.\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.", "operationId"=>"contactdb.recipients.get", "x-api-path-slug"=>"contactdbrecipients-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Page index of first recipients to return (must be a positive integer)"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of recipients to return at a time (must be a positive integer between 1 and 1000)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Recipients"]}, "patch"=>{"summary"=>"Patch Contactdb Recipients", "description"=>"**This endpoint allows you to update one or more recipients.**\n\nThe body of an API call to this endpoint must include an array of one or more recipient objects.\n\nIt is of note that you can add custom field data as parameters on recipient objects. We have provided an example using some of the default custom fields SendGrid provides.\n\nThe contactdb is a database of your contacts for [SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html).", "operationId"=>"contactdb.recipients.patch", "x-api-path-slug"=>"contactdbrecipients-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Recipients"]}, "post"=>{"summary"=>"Add Contactdb Recipients", "description"=>"**This endpoint allows you to add a Marketing Campaigns recipient.**\n\nYou can add custom field data as a parameter on this endpoint. We have provided an example using some of the default custom fields SendGrid provides.\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.", "operationId"=>"contactdb.recipients.post", "x-api-path-slug"=>"contactdbrecipients-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Recipients"]}}, "/contactdb/recipients/billable_count"=>{"get"=>{"summary"=>"Get Contactdb Recipients Billable Count", "description"=>"**This endpoint allows you to retrieve the number of Marketing Campaigns recipients that you will be billed for.**\n\nYou are billed for marketing campaigns based on the highest number of recipients you have had in your account at one time. This endpoint will allow you to know the current billable count value.\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.", "operationId"=>"contactdb.recipients.billable_count.get", "x-api-path-slug"=>"contactdbrecipientsbillable-count-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Recipients", "Billable", "Count"]}}, "/contactdb/recipients/count"=>{"get"=>{"summary"=>"Get Contactdb Recipients Count", "description"=>"**This endpoint allows you to retrieve the total number of Marketing Campaigns recipients.**\n\nThe contactdb is a database of your contacts for [SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html).", "operationId"=>"contactdb.recipients.count.get", "x-api-path-slug"=>"contactdbrecipientscount-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Recipients", "Count"]}}, "/contactdb/recipients/search"=>{"get"=>{"summary"=>"Get Contactdb Recipients Search", "description"=>"**This endpoint allows you to perform a search on all of your Marketing Campaigns recipients.**\n\nfield_name:\n\n* is a variable that is substituted for your actual custom field name from your recipient.\n* Text fields must be url-encoded. Date fields are searchable only by unix timestamp (e.g. 2/2/2015 becomes 1422835200)\n* If field_name is a 'reserved' date field, such as created_at or updated_at, the system will internally convert\nyour epoch time to a date range encompassing the entire day. For example, an epoch time of 1422835600 converts to\nMon, 02 Feb 2015 00:06:40 GMT, but internally the system will search from Mon, 02 Feb 2015 00:00:00 GMT through\nMon, 02 Feb 2015 23:59:59 GMT.\n\nThe contactdb is a database of your contacts for [SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html).", "operationId"=>"contactdb.recipients.search.get", "x-api-path-slug"=>"contactdbrecipientssearch-get", "parameters"=>[{"in"=>"query", "name"=>"{field_name}"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Recipients", "Search"]}}, "/contactdb/recipients/{recipient_id}"=>{"delete"=>{"summary"=>"Delete Contactdb Recipients Recipient", "description"=>"**This endpoint allows you to delete a single recipient with the given ID from your contact database.**\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.", "operationId"=>"contactdb.recipients.recipient_id.delete", "x-api-path-slug"=>"contactdbrecipientsrecipient-id-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Recipients", "Recipient"]}, "get"=>{"summary"=>"Get Contactdb Recipients Recipient", "description"=>"**This endpoint allows you to retrieve a single recipient by ID from your contact database.**\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.", "operationId"=>"contactdb.recipients.recipient_id.get", "x-api-path-slug"=>"contactdbrecipientsrecipient-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Recipients", "Recipient"]}}, "/contactdb/recipients/{recipient_id}/lists"=>{"get"=>{"summary"=>"Get Contactdb Recipients Recipient Lists", "description"=>"**This endpoint allows you to retrieve the lists that a given recipient belongs to.**\n\nEach recipient can be on many lists. This endpoint gives you all of the lists that any one recipient has been added to.\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.", "operationId"=>"contactdb.recipients.recipient_id.lists.get", "x-api-path-slug"=>"contactdbrecipientsrecipient-idlists-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Recipients", "Recipient", "", "Lists"]}}, "/contactdb/reserved_fields"=>{"get"=>{"summary"=>"Get Contactdb Reserved Fields", "description"=>"**This endpoint allows you to list all fields that are reserved and can't be used for custom field names.**\n\nThe contactdb is a database of your contacts for [SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html).", "operationId"=>"contactdb.reserved_fields.get", "x-api-path-slug"=>"contactdbreserved-fields-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Reserved", "Fields"]}}, "/contactdb/segments"=>{"get"=>{"summary"=>"Get Contactdb Segments", "description"=>"**This endpoint allows you to retrieve all of your segments.**\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.\n\nFor more information about segments in Marketing Campaigns, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/lists.html#-Create-a-Segment).", "operationId"=>"contactdb.segments.get", "x-api-path-slug"=>"contactdbsegments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Segments"]}, "post"=>{"summary"=>"Add Contactdb Segments", "description"=>"**This endpoint allows you to create a segment.**\n\nAll recipients in your contactdb will be added or removed automatically depending on whether they match the criteria for this segment.\n\nList Id:\n\n* Send this to segment from an existing list\n* Don't send this in order to segment from your entire contactdb.\n\nValid operators for create and update depend on the type of the field you are segmenting: \n\n* **Dates:** \"eq\", \"ne\", \"lt\" (before), \"gt\" (after) \n* **Text:** \"contains\", \"eq\" (is - matches the full field), \"ne\" (is not - matches any field where the entire field is not the condition value) \n* **Numbers:** \"eq\", \"lt\", \"gt\" \n* **Email Clicks and Opens:** \"eq\" (opened), \"ne\" (not opened) \n\nSegment conditions using \"eq\" or \"ne\" for email clicks and opens should provide a \"field\" of either *clicks.campaign_identifier* or *opens.campaign_identifier*. The condition value should be a string containing the id of a completed campaign. \n\nSegments may contain multiple condtions, joined by an \"and\" or \"or\" in the \"and_or\" field. The first condition in the conditions list must have an empty \"and_or\", and subsequent conditions must all specify an \"and_or\".\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.\n\nFor more information about segments in Marketing Campaigns, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/lists.html#-Create-a-Segment).", "operationId"=>"contactdb.segments.post", "x-api-path-slug"=>"contactdbsegments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Segments"]}}, "/contactdb/segments/{segment_id}"=>{"delete"=>{"summary"=>"Delete Contactdb Segments Segment", "description"=>"**This endpoint allows you to delete a segment from your recipients database.**\n\nYou also have the option to delete all the contacts from your Marketing Campaigns recipient database who were in this segment.\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.\n\nFor more information about segments in Marketing Campaigns, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/lists.html#-Create-a-Segment).", "operationId"=>"contactdb.segments.segment_id.delete", "x-api-path-slug"=>"contactdbsegmentssegment-id-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"delete_contacts", "description"=>"True to delete all contacts matching the segment in addition to deleting the segment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Segments", "Segment"]}, "get"=>{"summary"=>"Get Contactdb Segments Segment", "description"=>"**This endpoint allows you to retrieve a single segment with the given ID.**\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.\n\nFor more information about segments in Marketing Campaigns, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/lists.html#-Create-a-Segment).", "operationId"=>"contactdb.segments.segment_id.get", "x-api-path-slug"=>"contactdbsegmentssegment-id-get", "parameters"=>[{"in"=>"query", "name"=>"segment_id", "description"=>"The ID of the segment you want to request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Segments", "Segment"]}, "patch"=>{"summary"=>"Patch Contactdb Segments Segment", "description"=>"**This endpoint allows you to update a segment.**\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.\n\nFor more information about segments in Marketing Campaigns, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/lists.html#-Create-a-Segment).", "operationId"=>"contactdb.segments.segment_id.patch", "x-api-path-slug"=>"contactdbsegmentssegment-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"segment_id", "description"=>"The ID of the segment you are updating"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Segments", "Segment"]}}, "/contactdb/segments/{segment_id}/recipients"=>{"get"=>{"summary"=>"Get Contactdb Segments Segment Recipients", "description"=>"**This endpoint allows you to retrieve all of the recipients in a segment with the given ID.**\n\nThe Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.\n\nFor more information about segments in Marketing Campaigns, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/lists.html#-Create-a-Segment).", "operationId"=>"contactdb.segments.segment_id.recipients.get", "x-api-path-slug"=>"contactdbsegmentssegment-idrecipients-get", "parameters"=>[{"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"page_size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Segments", "Segment", "", "Recipients"]}}, "/contactdb/status"=>{"get"=>{"summary"=>"Get Contactdb Status", "description"=>"", "operationId"=>"contactdb.status.get", "x-api-path-slug"=>"contactdbstatus-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Contactdb", "Status"]}}, "/devices/stats"=>{"get"=>{"summary"=>"Get Devices Stats", "description"=>"**This endpoint allows you to retrieve your email statistics segmented by the device type.**\n\n**We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints.\n\n## Available Device Types\n| **Device** | **Description** | **Example** |\n|---|---|---|\n| Desktop | Email software on desktop computer. | I.E., Outlook, Sparrow, or Apple Mail. |\n| Webmail |\tA web-based email client. | I.E., Yahoo, Google, AOL, or Outlook.com. |\n| Phone | A smart phone. | iPhone, Android, Blackberry, etc.\n| Tablet | A tablet computer. | iPad, android based tablet, etc. |\n| Other | An unrecognized device. |\n\nAdvanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/index.html).", "operationId"=>"devices.stats.get", "x-api-path-slug"=>"devicesstats-get", "parameters"=>[{"in"=>"query", "name"=>"aggregated_by", "description"=>"How to group the statistics"}, {"in"=>"query", "name"=>"end_date", "description"=>"The end date of the statistics to retrieve"}, {"in"=>"query", "name"=>"limit", "description"=>"How many results to include on each page"}, {"in"=>"query", "name"=>"offset", "description"=>"How many results to exclude"}, {"in"=>"query", "name"=>"start_date", "description"=>"The starting date of the statistics to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Devices", "Stats"]}}, "/geo/stats"=>{"get"=>{"summary"=>"Get Geo Stats", "description"=>"**This endpoint allows you to retrieve your email statistics segmented by country and state/province.**\n\n**We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints.\n\nAdvanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/index.html).", "operationId"=>"geo.stats.get", "x-api-path-slug"=>"geostats-get", "parameters"=>[{"in"=>"query", "name"=>"aggregated_by", "description"=>"How you would like the statistics to be grouped"}, {"in"=>"query", "name"=>"country", "description"=>"The country you would like to see statistics for"}, {"in"=>"query", "name"=>"end_date", "description"=>"The end date of the statistics to retrieve"}, {"in"=>"query", "name"=>"limit", "description"=>"How many results to include on each page"}, {"in"=>"query", "name"=>"offset", "description"=>"How many results to exclude"}, {"in"=>"query", "name"=>"start_date", "description"=>"The starting date of the statistics to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Geo", "Stats"]}}, "/ips"=>{"get"=>{"summary"=>"Get Ips", "description"=>"**This endpoint allows you to retrieve a list of all assigned and unassigned IPs.**\n\nResponse includes warm up status, pools, assigned subusers, and whitelabel info. The start_date field corresponds to when warmup started for that IP.\n\nA single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it.", "operationId"=>"GET_ips", "x-api-path-slug"=>"ips-get", "parameters"=>[{"in"=>"query", "name"=>"exclude_whitelabels", "description"=>"Should we exclude whitelabels?"}, {"in"=>"query", "name"=>"ip", "description"=>"The IP address to get"}, {"in"=>"query", "name"=>"limit", "description"=>"The number of IPs you want returned at the same time"}, {"in"=>"query", "name"=>"offset", "description"=>"The offset for the number of IPs that you are requesting"}, {"in"=>"query", "name"=>"sort_by_direction", "description"=>"The direction to sort the results"}, {"in"=>"query", "name"=>"subuser", "description"=>"The subuser you are requesting for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ips"]}, "post"=>{"summary"=>"Add Ips", "description"=>"This endpoint is for adding a(n) IP Address(es) to your account.", "operationId"=>"POST_ips", "x-api-path-slug"=>"ips-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ips"]}}, "/ips/assigned"=>{"get"=>{"summary"=>"Get Ips Assigned", "description"=>"**This endpoint allows you to retrieve only assigned IP addresses.**\n\nA single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it.", "operationId"=>"ips.assigned.get", "x-api-path-slug"=>"ipsassigned-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ips", "Assigned"]}}, "/ips/pools"=>{"get"=>{"summary"=>"Get Ips Pools", "description"=>"**This endpoint allows you to retreive all of your IP pools.**\n\nIP Pools allow you to group your dedicated SendGrid IP addresses together. For example, you could create separate pools for your transactional and marketing email. When sending marketing emails, specify that you want to use the marketing IP pool. This allows you to maintain separate reputations for your different email traffic.\n\nIP pools can only be used with whitelabeled IP addresses.\n\nIf an IP pool is NOT specified for an email, it will use any IP available, including ones in pools.", "operationId"=>"ips.pools.get", "x-api-path-slug"=>"ipspools-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ips", "Pools"]}, "post"=>{"summary"=>"Add Ips Pools", "description"=>"**This endpoint allows you to create an IP pool.**\n\n**Each user can create up to 10 different IP pools.**\n\nIP Pools allow you to group your dedicated SendGrid IP addresses together. For example, you could create separate pools for your transactional and marketing email. When sending marketing emails, specify that you want to use the marketing IP pool. This allows you to maintain separate reputations for your different email traffic.\n\nIP pools can only be used with whitelabeled IP addresses.\n\nIf an IP pool is NOT specified for an email, it will use any IP available, including ones in pools.", "operationId"=>"ips.pools.post", "x-api-path-slug"=>"ipspools-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ips", "Pools"]}}, "/ips/pools/{pool_name}"=>{"delete"=>{"summary"=>"Delete Ips Pools Pool Name", "description"=>"**This endpoint allows you to delete an IP pool.**\n\nIP Pools allow you to group your dedicated SendGrid IP addresses together. For example, you could create separate pools for your transactional and marketing email. When sending marketing emails, specify that you want to use the marketing IP pool. This allows you to maintain separate reputations for your different email traffic.\n\nIP pools can only be used with whitelabeled IP addresses.\n\nIf an IP pool is NOT specified for an email, it will use any IP available, including ones in pools.", "operationId"=>"ips.pools.pool_name.delete", "x-api-path-slug"=>"ipspoolspool-name-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ips", "Pools", "Pool", "Name"]}, "get"=>{"summary"=>"Get Ips Pools Pool Name", "description"=>"**This endpoint allows you to list all of the IP addresses that are in a specific IP pool.**\n\nIP Pools allow you to group your dedicated SendGrid IP addresses together. For example, you could create separate pools for your transactional and marketing email. When sending marketing emails, specify that you want to use the marketing IP pool. This allows you to maintain separate reputations for your different email traffic.\n\nIP pools can only be used with whitelabeled IP addresses.\n\nIf an IP pool is NOT specified for an email, it will use any IP available, including ones in pools.", "operationId"=>"ips.pools.pool_name.get", "x-api-path-slug"=>"ipspoolspool-name-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ips", "Pools", "Pool", "Name"]}, "put"=>{"summary"=>"Put Ips Pools Pool Name", "description"=>"**This endpoint allows you to update the name of an IP pool.**\n\nIP Pools allow you to group your dedicated SendGrid IP addresses together. For example, you could create separate pools for your transactional and marketing email. When sending marketing emails, specify that you want to use the marketing IP pool. This allows you to maintain separate reputations for your different email traffic.\n\nIP pools can only be used with whitelabeled IP addresses.\n\nIf an IP pool is NOT specified for an email, it will use any IP available, including ones in pools.", "operationId"=>"ips.pools.pool_name.put", "x-api-path-slug"=>"ipspoolspool-name-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ips", "Pools", "Pool", "Name"]}}, "/ips/pools/{pool_name}/ips"=>{"post"=>{"summary"=>"Add Ips Pools Pool Name Ips", "description"=>"**This endpoint allows you to add an IP address to an IP pool.**\n\nYou can add the same IP address to multiple pools. It may take up to 60 seconds for your IP address to be added to a pool after your request is made.\n\nA single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it.", "operationId"=>"ips.pools.pool_name.ips.post", "x-api-path-slug"=>"ipspoolspool-nameips-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ips", "Pools", "Pool", "Name", "Ips"]}}, "/ips/pools/{pool_name}/ips/{ip}"=>{"delete"=>{"summary"=>"Delete Ips Pools Pool Name Ips Ip", "description"=>"**This endpoint allows you to remove an IP address from an IP pool.**\n\nThe same IP address can be added to multiple IP pools.\n\nA single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it.", "operationId"=>"ips.pools.pool_name.ips.ip.delete", "x-api-path-slug"=>"ipspoolspool-nameipsip-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ips", "Pools", "Pool", "Name", "Ips", "Ip"]}}, "/ips/remaining"=>{"get"=>{"summary"=>"Get Ips Remaining", "description"=>"This endpoint gets amount of IP Addresses that can still be created during a given period and the price of those IPs.", "operationId"=>"ips.remaining.get", "x-api-path-slug"=>"ipsremaining-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ips", "Remaining"]}}, "/ips/warmup"=>{"get"=>{"summary"=>"Get Ips Warmup", "description"=>"**This endpoint allows you to retrieve all of your IP addresses that are currently warming up.**\n\nSendGrid can automatically warm up dedicated IP addresses by limiting the amount of mail that can be sent through them per hour, with the limit determined by how long the IP address has been in warmup. See the [warmup schedule](https://sendgrid.com/docs/API_Reference/Web_API_v3/IP_Management/ip_warmup_schedule.html) for more details on how SendGrid limits your email traffic for IPs in warmup.\n\nFor more general information about warming up IPs, please see our [Classroom](https://sendgrid.com/docs/Classroom/Deliver/Delivery_Introduction/warming_up_ips.html).", "operationId"=>"ips.warmup.get", "x-api-path-slug"=>"ipswarmup-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ips", "Warmup"]}, "post"=>{"summary"=>"Add Ips Warmup", "description"=>"**This endpoint allows you to enter an IP address into warmup mode.**\n\nSendGrid can automatically warm up dedicated IP addresses by limiting the amount of mail that can be sent through them per hour, with the limit determined by how long the IP address has been in warmup. See the [warmup schedule](https://sendgrid.com/docs/API_Reference/Web_API_v3/IP_Management/ip_warmup_schedule.html) for more details on how SendGrid limits your email traffic for IPs in warmup.\n\nFor more general information about warming up IPs, please see our [Classroom](https://sendgrid.com/docs/Classroom/Deliver/Delivery_Introduction/warming_up_ips.html).", "operationId"=>"ips.warmup.post", "x-api-path-slug"=>"ipswarmup-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ips", "Warmup"]}}, "/ips/warmup/{ip_address}"=>{"delete"=>{"summary"=>"Delete Ips Warmup Ip Address", "description"=>"**This endpoint allows you to remove an IP address from warmup mode.**\n\nSendGrid can automatically warm up dedicated IP addresses by limiting the amount of mail that can be sent through them per hour, with the limit determined by how long the IP address has been in warmup. See the [warmup schedule](https://sendgrid.com/docs/API_Reference/Web_API_v3/IP_Management/ip_warmup_schedule.html) for more details on how SendGrid limits your email traffic for IPs in warmup.\n\nFor more general information about warming up IPs, please see our [Classroom](https://sendgrid.com/docs/Classroom/Deliver/Delivery_Introduction/warming_up_ips.html).", "operationId"=>"ips.warmup.ip_address.delete", "x-api-path-slug"=>"ipswarmupip-address-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ips", "Warmup", "Ip", "Address"]}, "get"=>{"summary"=>"Get Ips Warmup Ip Address", "description"=>"**This endpoint allows you to retrieve the warmup status for a specific IP address.**\n\nSendGrid can automatically warm up dedicated IP addresses by limiting the amount of mail that can be sent through them per hour, with the limit determined by how long the IP address has been in warmup. See the [warmup schedule](https://sendgrid.com/docs/API_Reference/Web_API_v3/IP_Management/ip_warmup_schedule.html) for more details on how SendGrid limits your email traffic for IPs in warmup.\n\nFor more general information about warming up IPs, please see our [Classroom](https://sendgrid.com/docs/Classroom/Deliver/Delivery_Introduction/warming_up_ips.html).", "operationId"=>"ips.warmup.ip_address.get", "x-api-path-slug"=>"ipswarmupip-address-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ips", "Warmup", "Ip", "Address"]}}, "/ips/{ip_address}"=>{"get"=>{"summary"=>"Get Ips Ip Address", "description"=>"**This endpoint allows you to see which IP pools a particular IP address has been added to.**\n\nThe same IP address can be added to multiple IP pools.\n\nA single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it.", "operationId"=>"ips.ip_address.get", "x-api-path-slug"=>"ipsip-address-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ips", "Ip", "Address"]}}, "/mail/batch"=>{"post"=>{"summary"=>"Add Mail Batch", "description"=>"**This endpoint allows you to generate a new batch ID. This batch ID can be associated with scheduled sends via the mail/send endpoint.**\n\nIf you set the SMTPAPI header `batch_id`, it allows you to then associate multiple scheduled mail/send requests together with the same ID. Then at anytime up to 10 minutes before the schedule date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint. \n\nMore Information:\n\n* [Scheduling Parameters > Batch ID](https://sendgrid.com/docs/API_Reference/SMTP_API/scheduling_parameters.html)", "operationId"=>"mail.batch.post", "x-api-path-slug"=>"mailbatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Batch"]}}, "/mail/batch/{batch_id}"=>{"get"=>{"summary"=>"Get Mail Batch Batch", "description"=>"**This endpoint allows you to validate a batch ID.**\n\nIf you set the SMTPAPI header `batch_id`, it allows you to then associate multiple scheduled mail/send requests together with the same ID. Then at anytime up to 10 minutes before the schedule date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint. \n\nMore Information:\n\n* [Scheduling Parameters > Batch ID](https://sendgrid.com/docs/API_Reference/SMTP_API/scheduling_parameters.html)", "operationId"=>"mail.batch.batch_id.get", "x-api-path-slug"=>"mailbatchbatch-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Batch", "Batch"]}}, "/mail/send"=>{"post"=>{"summary"=>"Add Mail Send", "description"=>"This endpoint allows you to send email over SendGrid???s v3 Web API, the most recent version of our API. If you are looking for documentation about the v2 Mail Send endpoint, please see our [v2 API Reference](https://sendgrid.com/docs/API_Reference/Web_API/mail.html).\n\n* Top level parameters are referred to as \"global\".\n* Individual fields within the personalizations array will override any other global, or ???message level???, parameters that are defined outside of personalizations.\n \n**SendGrid provides libraries to help you quickly and easily integrate with the v3 Web API in 7 different languages: [C#](https://github.com/sendgrid/sendgrid-csharp), [Go](https://github.com/sendgrid/sendgrid-go), [Java](https://github.com/sendgrid/sendgrid-java), [Node JS](https://github.com/sendgrid/sendgrid-nodejs), [PHP](https://github.com/sendgrid/sendgrid-php), [Python](https://github.com/sendgrid/sendgrid-python), and [Ruby](https://github.com/sendgrid/sendgrid-ruby).**\n\n\nFor more detailed information about how to use the v3 Mail Send endpoint, please visit our [Classroom](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/index.html).", "operationId"=>"mail.send.post", "x-api-path-slug"=>"mailsend-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Send"]}}, "/mail_settings"=>{"get"=>{"summary"=>"Get Mail Settings", "description"=>"**This endpoint allows you to retrieve a list of all mail settings.**\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"GET_mail_settings", "x-api-path-slug"=>"mail-settings-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"The number of settings to return"}, {"in"=>"query", "name"=>"offset", "description"=>"Where in the list of results to begin displaying settings"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings"]}}, "/mail_settings/address_whitelist"=>{"get"=>{"summary"=>"Get Mail Settings Address Whitelist", "description"=>"**This endpoint allows you to retrieve your current email address whitelist settings.**\n\nThe address whitelist setting whitelists a specified email address or domain for which mail should never be suppressed. For example, you own the domain ???example.com,??? and one or more of your recipients use email@example.com addresses, by placing example.com in the address whitelist setting, all bounces, blocks, and unsubscribes logged for that domain will be ignored and sent as if under normal sending conditions.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.address_whitelist.get", "x-api-path-slug"=>"mail-settingsaddress-whitelist-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Address", "Whitelist"]}, "patch"=>{"summary"=>"Patch Mail Settings Address Whitelist", "description"=>"**This endpoint allows you to update your current email address whitelist settings.**\n\nThe address whitelist setting whitelists a specified email address or domain for which mail should never be suppressed. For example, you own the domain ???example.com,??? and one or more of your recipients use email@example.com addresses, by placing example.com in the address whitelist setting, all bounces, blocks, and unsubscribes logged for that domain will be ignored and sent as if under normal sending conditions.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.address_whitelist.patch", "x-api-path-slug"=>"mail-settingsaddress-whitelist-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Address", "Whitelist"]}}, "/mail_settings/bcc"=>{"get"=>{"summary"=>"Get Mail Settings Bcc", "description"=>"**This endpoint allows you to retrieve your current BCC mail settings.**\n\nWhen the BCC mail setting is enabled, SendGrid will automatically send a blind carbon copy (BCC) to an address for every email sent without adding that address to the header. Please note that only one email address may be entered in this field, if you wish to distribute BCCs to multiple addresses you will need to create a distribution group or use forwarding rules.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.bcc.get", "x-api-path-slug"=>"mail-settingsbcc-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Bcc"]}, "patch"=>{"summary"=>"Patch Mail Settings Bcc", "description"=>"**This endpoint allows you to update your current BCC mail settings.**\n\nWhen the BCC mail setting is enabled, SendGrid will automatically send a blind carbon copy (BCC) to an address for every email sent without adding that address to the header. Please note that only one email address may be entered in this field, if you wish to distribute BCCs to multiple addresses you will need to create a distribution group or use forwarding rules.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.bcc.patch", "x-api-path-slug"=>"mail-settingsbcc-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Bcc"]}}, "/mail_settings/bounce_purge"=>{"get"=>{"summary"=>"Get Mail Settings Bounce Purge", "description"=>"**This endpoint allows you to retrieve your current bounce purge settings.**\n\nThis setting allows you to set a schedule for SendGrid to automatically delete contacts from your soft and hard bounce suppression lists.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.bounce_purge.get", "x-api-path-slug"=>"mail-settingsbounce-purge-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Bounce", "Purge"]}, "patch"=>{"summary"=>"Patch Mail Settings Bounce Purge", "description"=>"**This endpoint allows you to update your current bounce purge settings.**\n\nThis setting allows you to set a schedule for SendGrid to automatically delete contacts from your soft and hard bounce suppression lists.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.bounce_purge.patch", "x-api-path-slug"=>"mail-settingsbounce-purge-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Bounce", "Purge"]}}, "/mail_settings/footer"=>{"get"=>{"summary"=>"Get Mail Settings Footer", "description"=>"**This endpoint allows you to retrieve your current Footer mail settings.**\n\nThe footer setting will insert a custom footer at the bottom of the text and HTML bodies. Use the embedded HTML editor and plain text entry fields to create the content of the footers to be inserted into your emails.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.footer.get", "x-api-path-slug"=>"mail-settingsfooter-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Footer"]}, "patch"=>{"summary"=>"Patch Mail Settings Footer", "description"=>"**This endpoint allows you to update your current Footer mail settings.**\n\nThe footer setting will insert a custom footer at the bottom of the text and HTML bodies. Use the embedded HTML editor and plain text entry fields to create the content of the footers to be inserted into your emails.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.footer.patch", "x-api-path-slug"=>"mail-settingsfooter-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Footer"]}}, "/mail_settings/forward_bounce"=>{"get"=>{"summary"=>"Get Mail Settings Forward Bounce", "description"=>"**This endpoint allows you to retrieve your current bounce forwarding mail settings.**\n\nActivating this setting allows you to specify an email address to which bounce reports are forwarded.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.forward_bounce.get", "x-api-path-slug"=>"mail-settingsforward-bounce-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Forward", "Bounce"]}, "patch"=>{"summary"=>"Patch Mail Settings Forward Bounce", "description"=>"**This endpoint allows you to update your current bounce forwarding mail settings.**\n\nActivating this setting allows you to specify an email address to which bounce reports are forwarded.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.forward_bounce.patch", "x-api-path-slug"=>"mail-settingsforward-bounce-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Forward", "Bounce"]}}, "/mail_settings/forward_spam"=>{"get"=>{"summary"=>"Get Mail Settings Forward Spam", "description"=>"**This endpoint allows you to retrieve your current Forward Spam mail settings.**\n\nEnabling the forward spam setting allows you to specify an email address to which spam reports will be forwarded.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.forward_spam.get", "x-api-path-slug"=>"mail-settingsforward-spam-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Forward", "Spam"]}, "patch"=>{"summary"=>"Patch Mail Settings Forward Spam", "description"=>"**This endpoint allows you to update your current Forward Spam mail settings.**\n\nEnabling the forward spam setting allows you to specify an email address to which spam reports will be forwarded.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.forward_spam.patch", "x-api-path-slug"=>"mail-settingsforward-spam-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Forward", "Spam"]}}, "/mail_settings/plain_content"=>{"get"=>{"summary"=>"Get Mail Settings Plain Content", "description"=>"**This endpoint allows you to retrieve your current Plain Content mail settings.**\n\nThe plain content setting will automatically convert any plain text emails that you send to HTML before sending.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.plain_content.get", "x-api-path-slug"=>"mail-settingsplain-content-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Plain", "Content"]}, "patch"=>{"summary"=>"Patch Mail Settings Plain Content", "description"=>"**This endpoint allows you to update your current Plain Content mail settings.**\n\nThe plain content setting will automatically convert any plain text emails that you send to HTML before sending.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.plain_content.patch", "x-api-path-slug"=>"mail-settingsplain-content-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Plain", "Content"]}}, "/mail_settings/spam_check"=>{"get"=>{"summary"=>"Get Mail Settings Spam Check", "description"=>"**This endpoint allows you to retrieve your current Spam Checker mail settings.**\n\nThe spam checker filter notifies you when emails are detected that exceed a predefined spam threshold.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.spam_check.get", "x-api-path-slug"=>"mail-settingsspam-check-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Spam", "Check"]}, "patch"=>{"summary"=>"Patch Mail Settings Spam Check", "description"=>"**This endpoint allows you to update your current spam checker mail settings.**\n\nThe spam checker filter notifies you when emails are detected that exceed a predefined spam threshold.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.spam_check.patch", "x-api-path-slug"=>"mail-settingsspam-check-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Spam", "Check"]}}, "/mail_settings/template"=>{"get"=>{"summary"=>"Get Mail Settings Template", "description"=>"**This endpoint allows you to retrieve your current legacy email template settings.**\n\nThis setting refers to our original email templates. We currently support more fully featured [transactional templates](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html). \n\nThe legacy email template setting wraps an HTML template around your email content. This can be useful for sending out marketing email and/or other HTML formatted messages.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.template.get", "x-api-path-slug"=>"mail-settingstemplate-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Template"]}, "patch"=>{"summary"=>"Patch Mail Settings Template", "description"=>"**This endpoint allows you to update your current legacy email template settings.**\n\nThis setting refers to our original email templates. We currently support more fully featured [transactional templates](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html). \n\nThe legacy email template setting wraps an HTML template around your email content. This can be useful for sending out marketing email and/or other HTML formatted messages.\n\nMail settings allow you to tell SendGrid specific things to do to every email that you send to your recipients over SendGrid???s [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).", "operationId"=>"mail_settings.template.patch", "x-api-path-slug"=>"mail-settingstemplate-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mail", "Settings", "Template"]}}, "/mailbox_providers/stats"=>{"get"=>{"summary"=>"Get Mailbox Provers Stats", "description"=>"**This endpoint allows you to retrieve your email statistics segmented by recipient mailbox provider.**\n\n**We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints.\n\nAdvanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/index.html).", "operationId"=>"mailbox_providers.stats.get", "x-api-path-slug"=>"mailbox-providersstats-get", "parameters"=>[{"in"=>"query", "name"=>"aggregated_by", "description"=>"How to group the stats"}, {"in"=>"query", "name"=>"end_date", "description"=>"The end date of the statistics to retrieve"}, {"in"=>"query", "name"=>"limit", "description"=>"The number of results to include on each page"}, {"in"=>"query", "name"=>"mailbox_providers", "description"=>"The mail box providers to get statistics for"}, {"in"=>"query", "name"=>"offset", "description"=>"The number of results to exclude"}, {"in"=>"query", "name"=>"start_date", "description"=>"The starting date of the statistics to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Mailbox", "Provers", "Stats"]}}, "/partner_settings"=>{"get"=>{"summary"=>"Get Partner Settings", "description"=>"**This endpoint allows you to retrieve a list of all partner settings that you can enable.**\n\nOur partner settings allow you to integrate your SendGrid account with our partners to increase your SendGrid experience and functionality. For more information about our partners, and how you can begin integrating with them, please visit our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/partners.html).", "operationId"=>"GET_partner_settings", "x-api-path-slug"=>"partner-settings-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"The number of settings to return per page"}, {"in"=>"query", "name"=>"offset", "description"=>"The paging offset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Partner", "Settings"]}}, "/partner_settings/new_relic"=>{"get"=>{"summary"=>"Get Partner Settings New Relic", "description"=>"**This endpoint allows you to retrieve your current New Relic partner settings.**\n\nOur partner settings allow you to integrate your SendGrid account with our partners to increase your SendGrid experience and functionality. For more information about our partners, and how you can begin integrating with them, please visit our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/partners.html).\n\nBy integrating with New Relic, you can send your SendGrid email statistics to your New Relic Dashboard. If you enable this setting, your stats will be sent to New Relic every 5 minutes. You will need your New Relic License Key to enable this setting. For more information, please see our [Classroom](https://sendgrid.com/docs/Classroom/Track/Collecting_Data/new_relic.html).", "operationId"=>"partner_settings.new_relic.get", "x-api-path-slug"=>"partner-settingsnew-relic-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Partner", "Settings", "New", "Relic"]}, "patch"=>{"summary"=>"Patch Partner Settings New Relic", "description"=>"**This endpoint allows you to update or change your New Relic partner settings.**\n\nOur partner settings allow you to integrate your SendGrid account with our partners to increase your SendGrid experience and functionality. For more information about our partners, and how you can begin integrating with them, please visit our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/partners.html).\n\nBy integrating with New Relic, you can send your SendGrid email statistics to your New Relic Dashboard. If you enable this setting, your stats will be sent to New Relic every 5 minutes. You will need your New Relic License Key to enable this setting. For more information, please see our [Classroom](https://sendgrid.com/docs/Classroom/Track/Collecting_Data/new_relic.html).", "operationId"=>"partner_settings.new_relic.patch", "x-api-path-slug"=>"partner-settingsnew-relic-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Partner", "Settings", "New", "Relic"]}}, "/scopes"=>{"get"=>{"summary"=>"Get Scopes", "description"=>"**This endpoint returns a list of all scopes that this user has access to.**\n\nAPI Keys can be used to authenticate the use of [SendGrid???s v3 Web API](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html), or the [Mail API Endpoint](https://sendgrid.com/docs/API_Reference/Web_API/mail.html). API Keys may be assigned certain permissions, or scopes, that limit which API endpoints they are able to access. For a more detailed explanation of how you can use API Key permissios, please visit our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/api_keys.html#-API-Key-Permissions) or [Classroom](https://sendgrid.com/docs/Classroom/Basics/API/api_key_permissions.html).", "operationId"=>"GET_scopes", "x-api-path-slug"=>"scopes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Scopes"]}}, "/scopes/requests"=>{"get"=>{"summary"=>"Get Scopes Requests", "description"=>"This endpoint allows you to retrieve a list of all recent access requests.\n\n**Note:** The Response Header's 'link' parameter will include pagination info. For example:\n\nlink: ```
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
3dcart{"3dcart-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"3dcart", "x-complete"=>1, "info"=>{"title"=>"_3dCartWebAPI", "version"=>"1.0.0"}, "host"=>"apirest.3dcart.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/3dCartWebAPI/v1/Cart"=>{"post"=>{"summary"=>"Adds a new cart to the system", "description"=>"Adds a new cart to the system.", "operationId"=>"Carts_Post", "x-api-path-slug"=>"3dcartwebapiv1cart-post", "parameters"=>[{"in"=>"body", "name"=>"cart", "description"=>"A Json or XML object containing the new cart", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Cart", "To", "System"]}}, "/3dCartWebAPI/v1/Cart/{orderkey}"=>{"get"=>{"summary"=>"Get a specific cart", "description"=>"Get a specific cart.", "operationId"=>"Carts_GetCart", "x-api-path-slug"=>"3dcartwebapiv1cartorderkey-get", "parameters"=>[{"in"=>"path", "name"=>"orderkey", "description"=>"Order Key"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "Cart"]}, "put"=>{"summary"=>"This method is used to update a single cart record in the database. The {orderkey} parameter specifies which cart record to update.", "description"=>"This method is used to update a single cart record in the database. the {orderkey} parameter specifies which cart record to update..", "operationId"=>"Carts_Update", "x-api-path-slug"=>"3dcartwebapiv1cartorderkey-put", "parameters"=>[{"in"=>"body", "name"=>"cart", "description"=>"A Json or XML object containing the cart", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"orderkey", "description"=>"Order Key"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Single", "Cart", "Record", "In", "Database", "", "Orderkey", "Parameter", "Specifies", "Which", "Cart", "Record", "To", "Update"]}, "delete"=>{"summary"=>"Delete a Cart in the system", "description"=>"Delete a cart in the system.", "operationId"=>"Carts_Delete", "x-api-path-slug"=>"3dcartwebapiv1cartorderkey-delete", "parameters"=>[{"in"=>"path", "name"=>"orderkey", "description"=>"Order Key"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "In", "System"]}}, "/3dCartWebAPI/v1/Cart/{orderkey}/Item"=>{"post"=>{"summary"=>"Adds a new item to a cart", "description"=>"Adds a new item to a cart.", "operationId"=>"Carts_Post", "x-api-path-slug"=>"3dcartwebapiv1cartorderkeyitem-post", "parameters"=>[{"in"=>"body", "name"=>"item", "description"=>"A Json or XML object containing the new cart item", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"orderkey", "description"=>"Order Key"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Item", "To", "Cart"]}}, "/3dCartWebAPI/v1/Cart/{orderkey}/Item/{cartitemid}"=>{"put"=>{"summary"=>"Updates a specific item from a specific Cart", "description"=>"Updates a specific item from a specific cart.", "operationId"=>"Carts_Update", "x-api-path-slug"=>"3dcartwebapiv1cartorderkeyitemcartitemid-put", "parameters"=>[{"in"=>"path", "name"=>"cartitemid", "description"=>"The unique index ID of an Item"}, {"in"=>"body", "name"=>"item", "description"=>"A Json or XML object containing the new cart item", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"orderkey", "description"=>"Order Key"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Specific", "Item", "From", "Specific", "Cart"]}, "delete"=>{"summary"=>"Deletes a CartItem in the system", "description"=>"Deletes a cartitem in the system.", "operationId"=>"Carts_Delete", "x-api-path-slug"=>"3dcartwebapiv1cartorderkeyitemcartitemid-delete", "parameters"=>[{"in"=>"path", "name"=>"cartitemid", "description"=>"The unique index ID of an Item"}, {"in"=>"path", "name"=>"orderkey", "description"=>"Order Key"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "CartItem", "In", "System"]}}, "/3dCartWebAPI/v1/Categories"=>{"get"=>{"summary"=>"Get all Categories", "description"=>"Get all categories.", "operationId"=>"Category_GetAllCategories", "x-api-path-slug"=>"3dcartwebapiv1categories-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"Name of the Category"}, {"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories"]}, "put"=>{"summary"=>"This method is used to update multiple category records in the database. No {categoryid} parameters should be included.", "description"=>"This method is used to update multiple category records in the database. no {categoryid} parameters should be included..", "operationId"=>"Category_Update", "x-api-path-slug"=>"3dcartwebapiv1categories-put", "parameters"=>[{"in"=>"body", "name"=>"categories", "description"=>"A Json or XML object containing the new categories", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Multiple", "Category", "Records", "In", "Database", "", "No", "Categoryid", "Parameters", "Should", "Be", "Included"]}, "post"=>{"summary"=>"Adds a new category to the system", "description"=>"Adds a new category to the system.", "operationId"=>"Category_Post", "x-api-path-slug"=>"3dcartwebapiv1categories-post", "parameters"=>[{"in"=>"body", "name"=>"category", "description"=>"A Json or XML object containing the new category", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Category", "To", "System"]}}, "/3dCartWebAPI/v1/Categories/{categoryid}"=>{"put"=>{"summary"=>"This method is used to update a single category record in the database. The {categoryid} parameter specifies which category to update.", "description"=>"This method is used to update a single category record in the database. the {categoryid} parameter specifies which category to update..", "operationId"=>"Category_Update", "x-api-path-slug"=>"3dcartwebapiv1categoriescategoryid-put", "parameters"=>[{"in"=>"body", "name"=>"category", "description"=>"A Json or XML object containing the new category", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"categoryid", "description"=>"Category ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Single", "Category", "Record", "In", "Database", "", "Categoryid", "Parameter", "Specifies", "Which", "Category", "To", "Update"]}}, "/3dCartWebAPI/v1/Categories/{categoryid}/Options"=>{"get"=>{"summary"=>"Get the options from a specific Category", "description"=>"Get the options from a specific category.", "operationId"=>"Category_GetAllCategoryOptions", "x-api-path-slug"=>"3dcartwebapiv1categoriescategoryidoptions-get", "parameters"=>[{"in"=>"path", "name"=>"categoryid", "description"=>"Catalog ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Options", "From", "Specific", "Category"]}, "put"=>{"summary"=>"Updates a collection of options from a specific Category", "description"=>"Updates a collection of options from a specific category.", "operationId"=>"Category_Update", "x-api-path-slug"=>"3dcartwebapiv1categoriescategoryidoptions-put", "parameters"=>[{"in"=>"path", "name"=>"categoryid", "description"=>"CategoryID"}, {"in"=>"body", "name"=>"options", "description"=>"A Json or XML object containing the new options", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Collection", "Of", "Options", "From", "Specific", "Category"]}, "post"=>{"summary"=>"Adds a new OptionSet to the system", "description"=>"Adds a new optionset to the system.", "operationId"=>"Category_Post", "x-api-path-slug"=>"3dcartwebapiv1categoriescategoryidoptions-post", "parameters"=>[{"in"=>"path", "name"=>"categoryid", "description"=>"Category ID"}, {"in"=>"body", "name"=>"optionset", "description"=>"A Json or XML object containing the new optionset", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "OptionSet", "To", "System"]}}, "/3dCartWebAPI/v1/Categories/{categoryid}/Options/{optionsetid}"=>{"put"=>{"summary"=>"Updates specific options from a specific Category", "description"=>"Updates specific options from a specific category.", "operationId"=>"Category_Update", "x-api-path-slug"=>"3dcartwebapiv1categoriescategoryidoptionsoptionsetid-put", "parameters"=>[{"in"=>"path", "name"=>"categoryid", "description"=>"CategoryID"}, {"in"=>"body", "name"=>"option", "description"=>"A Json or XML object containing the new options", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"optionsetid", "description"=>"OptionSetID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Specific", "Options", "From", "Specific", "Category"]}}, "/3dCartWebAPI/v1/Categories/{categoryid}/Products"=>{"get"=>{"summary"=>"Get all products from a specific category", "description"=>"Get all products from a specific category.", "operationId"=>"Products_GetAllProductsFromCategory", "x-api-path-slug"=>"3dcartwebapiv1categoriescategoryidproducts-get", "parameters"=>[{"in"=>"path", "name"=>"categoryid", "description"=>"ID of the category"}, {"in"=>"query", "name"=>"categoryspecial", "description"=>"Category Special Flag"}, {"in"=>"query", "name"=>"costfrom", "description"=>"Cost of a product"}, {"in"=>"query", "name"=>"costto", "description"=>"Cost of a product"}, {"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"freeshipping", "description"=>"Free Shipping Flag"}, {"in"=>"query", "name"=>"giftcertificate", "description"=>"Gift Certificate Flag"}, {"in"=>"query", "name"=>"hide", "description"=>"Hide Flag"}, {"in"=>"query", "name"=>"homespecial", "description"=>"Home Special Flag"}, {"in"=>"query", "name"=>"lastupdateend", "description"=>"End Date that the product was last updated (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"lastupdatestart", "description"=>"Start Date that the product was last updated (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the product"}, {"in"=>"query", "name"=>"nonsearchable", "description"=>"Non-Searchable Flag"}, {"in"=>"query", "name"=>"nontax", "description"=>"Non-Taxable Flag"}, {"in"=>"query", "name"=>"notforsale", "description"=>"Not For Sale Flag"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"query", "name"=>"onsale", "description"=>"On Sale Flag"}, {"in"=>"query", "name"=>"pricefrom", "description"=>"Price of a product"}, {"in"=>"query", "name"=>"priceto", "description"=>"Price of a product"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"query", "name"=>"rewarddisable", "description"=>"Disable Rewards Flag"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"query", "name"=>"selfship", "description"=>"Ships by itself Flag"}, {"in"=>"query", "name"=>"sku", "description"=>"SKU Code of the product"}, {"in"=>"query", "name"=>"stockfrom", "description"=>"Stock of a product"}, {"in"=>"query", "name"=>"stockto", "description"=>"Stock of a product"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "From", "Specific", "Category"]}}, "/3dCartWebAPI/v1/Categories/{id}"=>{"get"=>{"summary"=>"Get a Category", "description"=>"Get a category.", "operationId"=>"Category_GetCategory", "x-api-path-slug"=>"3dcartwebapiv1categoriesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Category ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Category"]}, "delete"=>{"summary"=>"Deletes a Category in the system", "description"=>"Deletes a category in the system.", "operationId"=>"Category_Delete", "x-api-path-slug"=>"3dcartwebapiv1categoriesid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Category ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Category", "In", "System"]}}, "/3dCartWebAPI/v1/CRM"=>{"get"=>{"summary"=>"Get all CRMs", "description"=>"Get all crms.", "operationId"=>"CRM_GetAllCRMs", "x-api-path-slug"=>"3dcartwebapiv1crm-get", "parameters"=>[{"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"custid", "description"=>"Customer Id associated with the CRM"}, {"in"=>"query", "name"=>"customeremail", "description"=>"Customer Email"}, {"in"=>"query", "name"=>"customeripaddress", "description"=>"Customer Ip Address"}, {"in"=>"query", "name"=>"customername", "description"=>"Customer Name"}, {"in"=>"query", "name"=>"customerphone", "description"=>"Customer Phone"}, {"in"=>"query", "name"=>"departmentid", "description"=>"Department of the CRM"}, {"in"=>"query", "name"=>"lastactionenddate", "description"=>"Date Last Action (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"lastactionstartdate", "description"=>"Date Opened (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"query", "name"=>"openedenddate", "description"=>"Date Last Action (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"openedstartdate", "description"=>"Date Opened (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"orderid", "description"=>"Order Id associated with the CRM"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"query", "name"=>"productid", "description"=>"Product Id associated with the CRM"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"query", "name"=>"statusid", "description"=>"Status of the CRM"}, {"in"=>"query", "name"=>"subject", "description"=>"Subject of the CRM"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CRMs"]}, "post"=>{"summary"=>"Adds a new CRM to the system", "description"=>"Adds a new crm to the system.", "operationId"=>"CRM_PostCRM", "x-api-path-slug"=>"3dcartwebapiv1crm-post", "parameters"=>[{"in"=>"body", "name"=>"crm", "description"=>"A Json or XML object containing the new CRM", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "CRM", "To", "System"]}}, "/3dCartWebAPI/v1/CRM/{crmid}/message"=>{"get"=>{"summary"=>"Get all the messages from a specific CRM", "description"=>"Get all the messages from a specific crm.", "operationId"=>"CRM_GetAllCRMMessages", "x-api-path-slug"=>"3dcartwebapiv1crmcrmidmessage-get", "parameters"=>[{"in"=>"path", "name"=>"crmid", "description"=>"CRM ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "From", "Specific", "CRM"]}}, "/3dCartWebAPI/v1/CRM/{crmid}/message/{msgid}"=>{"get"=>{"summary"=>"Get a specific Message", "description"=>"Get a specific message.", "operationId"=>"CRM_GetCRMMessage", "x-api-path-slug"=>"3dcartwebapiv1crmcrmidmessagemsgid-get", "parameters"=>[{"in"=>"path", "name"=>"crmid", "description"=>"CRM ID"}, {"in"=>"path", "name"=>"msgid", "description"=>"Message ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "Message"]}, "delete"=>{"summary"=>"Delete a CRM Message in the system", "description"=>"Delete a crm message in the system.", "operationId"=>"CRM_DeleteCRM", "x-api-path-slug"=>"3dcartwebapiv1crmcrmidmessagemsgid-delete", "parameters"=>[{"in"=>"path", "name"=>"crmid", "description"=>"CrmID"}, {"in"=>"path", "name"=>"msgid", "description"=>"MessageID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CRM", "Message", "In", "System"]}}, "/3dCartWebAPI/v1/CRM/{id}"=>{"get"=>{"summary"=>"Get a specific CRM", "description"=>"Get a specific crm.", "operationId"=>"CRM_GetCRM", "x-api-path-slug"=>"3dcartwebapiv1crmid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"CRM ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "CRM"]}, "put"=>{"summary"=>"This method is used to update a single CRM record in the database. The {id} parameter specifies which CRM record to update.", "description"=>"This method is used to update a single crm record in the database. the {id} parameter specifies which crm record to update..", "operationId"=>"CRM_UpdateCRM", "x-api-path-slug"=>"3dcartwebapiv1crmid-put", "parameters"=>[{"in"=>"body", "name"=>"crm", "description"=>"A Json or XML object containing the new product", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Crm ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Single", "CRM", "Record", "In", "Database", "", "Id", "Parameter", "Specifies", "Which", "CRM", "Record", "To", "Update"]}, "delete"=>{"summary"=>"Delete a CRM in the system", "description"=>"Delete a crm in the system.", "operationId"=>"CRM_DeleteCRM", "x-api-path-slug"=>"3dcartwebapiv1crmid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"CrmID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CRM", "In", "System"]}}, "/3dCartWebAPI/v1/CRM/{id}/message"=>{"post"=>{"summary"=>"Adds a new CRM Message to the system", "description"=>"Adds a new crm message to the system.", "operationId"=>"CRM_PostMessage", "x-api-path-slug"=>"3dcartwebapiv1crmidmessage-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the CRM where the message will be added"}, {"in"=>"body", "name"=>"message", "description"=>"A Json or XML object containing the new CRM message", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "CRM", "Message", "To", "System"]}}, "/3dCartWebAPI/v1/CRM/department"=>{"get"=>{"summary"=>"Get all CRM Departments", "description"=>"Get all crm departments.", "operationId"=>"CRM_GetAllCRMDepartments", "x-api-path-slug"=>"3dcartwebapiv1crmdepartment-get", "parameters"=>[{"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CRM", "Departments"]}}, "/3dCartWebAPI/v1/CRM/department/{id}"=>{"put"=>{"summary"=>"This method is used to update a single CRM Department record in the database. The {id} parameter specifies which CRM Department record to update.", "description"=>"This method is used to update a single crm department record in the database. the {id} parameter specifies which crm department record to update..", "operationId"=>"CRM_UpdateDepartment", "x-api-path-slug"=>"3dcartwebapiv1crmdepartmentid-put", "parameters"=>[{"in"=>"body", "name"=>"department", "description"=>"A Json or XML object containing the new Department", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Department ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Single", "CRM", "Department", "Record", "In", "Database", "", "Id", "Parameter", "Specifies", "Which", "CRM", "Department", "Record", "To", "Update"]}}, "/3dCartWebAPI/v1/CRM/savedreply"=>{"get"=>{"summary"=>"Get all CRMs", "description"=>"Get all crms.", "operationId"=>"CRM_GetAllCRMSavedReplies", "x-api-path-slug"=>"3dcartwebapiv1crmsavedreply-get", "parameters"=>[{"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"query", "name"=>"title", "description"=>"Title"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CRMs"]}, "post"=>{"summary"=>"Adds a new CRM SaveReply to the system", "description"=>"Adds a new crm savereply to the system.", "operationId"=>"CRM_PostSavedReply", "x-api-path-slug"=>"3dcartwebapiv1crmsavedreply-post", "parameters"=>[{"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"body", "name"=>"savereply", "description"=>"A Json or XML object containing the new CRM SavedReply", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "CRM", "SaveReply", "To", "System"]}}, "/3dCartWebAPI/v1/CRM/savedreply/{id}"=>{"get"=>{"summary"=>"Get a specific CRM Saved Reply", "description"=>"Get a specific crm saved reply.", "operationId"=>"CRM_GetCRMSavedReply", "x-api-path-slug"=>"3dcartwebapiv1crmsavedreplyid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"CRM Saved Reply ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "CRM", "Saved", "Reply"]}, "put"=>{"summary"=>"This method is used to update a single CRM SavedReply record in the database. The {id} parameter specifies which CRM SavedReply record to update.", "description"=>"This method is used to update a single crm savedreply record in the database. the {id} parameter specifies which crm savedreply record to update..", "operationId"=>"CRM_UpdateSavedReply", "x-api-path-slug"=>"3dcartwebapiv1crmsavedreplyid-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"SavedReply ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"body", "name"=>"savedreply", "description"=>"A Json or XML object containing the new SavedReply", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Single", "CRM", "SavedReply", "Record", "In", "Database", "", "Id", "Parameter", "Specifies", "Which", "CRM", "SavedReply", "Record", "To", "Update"]}, "delete"=>{"summary"=>"Delete a CRM SavedReply in the system", "description"=>"Delete a crm savedreply in the system.", "operationId"=>"CRM_DeleteCRMSavedReply", "x-api-path-slug"=>"3dcartwebapiv1crmsavedreplyid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"SavedReplyID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CRM", "SavedReply", "In", "System"]}}, "/3dCartWebAPI/v1/CRM/status"=>{"get"=>{"summary"=>"Get all CRM Status", "description"=>"Get all crm status.", "operationId"=>"CRM_GetAllCRMStatus", "x-api-path-slug"=>"3dcartwebapiv1crmstatus-get", "parameters"=>[{"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CRM", "Status"]}}, "/3dCartWebAPI/v1/CRM/status/{id}"=>{"put"=>{"summary"=>"This method is used to update a single CRM Status record in the database. The {id} parameter specifies which CRM Status record to update.", "description"=>"This method is used to update a single crm status record in the database. the {id} parameter specifies which crm status record to update..", "operationId"=>"CRM_UpdateStatus", "x-api-path-slug"=>"3dcartwebapiv1crmstatusid-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Status ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"body", "name"=>"status", "description"=>"A Json or XML object containing the new Status", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Single", "CRM", "Status", "Record", "In", "Database", "", "Id", "Parameter", "Specifies", "Which", "CRM", "Status", "Record", "To", "Update"]}}, "/3dCartWebAPI/v1/CustomerGroups"=>{"get"=>{"summary"=>"Get all CustomerGroups", "description"=>"Get all customergroups.", "operationId"=>"CustomerGroups_GetAllCustomerGroups", "x-api-path-slug"=>"3dcartwebapiv1customergroups-get", "parameters"=>[{"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CustomerGroups"]}, "put"=>{"summary"=>"This method updates a collection of customer groups in the database. No URL parameters should be included.", "description"=>"This method updates a collection of customer groups in the database. no url parameters should be included..", "operationId"=>"CustomerGroups_Update", "x-api-path-slug"=>"3dcartwebapiv1customergroups-put", "parameters"=>[{"in"=>"body", "name"=>"customergroups", "description"=>"A Json or XML object containing the customer group", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Updates", "Collection", "Of", "Customer", "Groups", "In", "Database", "", "No", "URL", "Parameters", "Should", "Be", "Included"]}, "post"=>{"summary"=>"Adds a new customer group to the system", "description"=>"Adds a new customer group to the system.", "operationId"=>"CustomerGroups_Post", "x-api-path-slug"=>"3dcartwebapiv1customergroups-post", "parameters"=>[{"in"=>"body", "name"=>"customergroup", "description"=>"A Json or XML object containing the new customer group", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Customer", "Group", "To", "System"]}}, "/3dCartWebAPI/v1/CustomerGroups/{customergroupid}"=>{"put"=>{"summary"=>"This method is used to update a single customer group in the database. The {id} parameter specifies which customer group to update.", "description"=>"This method is used to update a single customer group in the database. the {id} parameter specifies which customer group to update..", "operationId"=>"CustomerGroups_Update", "x-api-path-slug"=>"3dcartwebapiv1customergroupscustomergroupid-put", "parameters"=>[{"in"=>"body", "name"=>"customergroup", "description"=>"A Json or XML object containing the customer group", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customergroupid", "description"=>"Customer Group ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Single", "Customer", "Group", "In", "Database", "", "Id", "Parameter", "Specifies", "Which", "Customer", "Group", "To", "Update"]}}, "/3dCartWebAPI/v1/CustomerGroups/{id}"=>{"get"=>{"summary"=>"Get a CustomerGroup", "description"=>"Get a customergroup.", "operationId"=>"CustomerGroups_GetCustomerGroup", "x-api-path-slug"=>"3dcartwebapiv1customergroupsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Customer Group ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CustomerGroup"]}, "delete"=>{"summary"=>"Deletes a customer group in the system", "description"=>"Deletes a customer group in the system.", "operationId"=>"CustomerGroups_Delete", "x-api-path-slug"=>"3dcartwebapiv1customergroupsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Customer Group ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Customer", "Group", "In", "System"]}}, "/3dCartWebAPI/v1/CustomerGroups/{id}/Customers"=>{"get"=>{"summary"=>"Get Customers from a Customer Group", "description"=>"Get customers from a customer group.", "operationId"=>"Customers_GetCustomerFromCustomerGroup", "x-api-path-slug"=>"3dcartwebapiv1customergroupsidcustomers-get", "parameters"=>[{"in"=>"query", "name"=>"city", "description"=>"City of the Customer"}, {"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"country", "description"=>"Country name of the Customer"}, {"in"=>"query", "name"=>"email", "description"=>"Email of the Customer"}, {"in"=>"query", "name"=>"firstname", "description"=>"Firstname of the Customer"}, {"in"=>"path", "name"=>"id", "description"=>"Customer Group ID"}, {"in"=>"query", "name"=>"lastname", "description"=>"Lastname of the Customer"}, {"in"=>"query", "name"=>"lastupdateend", "description"=>"End Date that the product was last updated (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"lastupdatestart", "description"=>"Start Date that the product was last updated (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"query", "name"=>"phone", "description"=>"Phone of the Customer"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"query", "name"=>"state", "description"=>"State of the Customer"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "From", "Customer", "Group"]}}, "/3dCartWebAPI/v1/Customers"=>{"get"=>{"summary"=>"Get all Customers", "description"=>"Get all customers.", "operationId"=>"Customers_GetAllCustomers", "x-api-path-slug"=>"3dcartwebapiv1customers-get", "parameters"=>[{"in"=>"query", "name"=>"city", "description"=>"City of the Customer"}, {"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"country", "description"=>"Country name of the Customer"}, {"in"=>"query", "name"=>"email", "description"=>"Email of the Customer"}, {"in"=>"query", "name"=>"firstname", "description"=>"Firstname of the Customer"}, {"in"=>"query", "name"=>"lastname", "description"=>"Lastname of the Customer"}, {"in"=>"query", "name"=>"lastupdateend", "description"=>"End Date that the product was last updated (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"lastupdatestart", "description"=>"Start Date that the product was last updated (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"query", "name"=>"phone", "description"=>"Phone of the Customer"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"query", "name"=>"state", "description"=>"State of the Customer"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}, "put"=>{"summary"=>"This method is used to update multiple customers in the system. No URL parameters should be included.", "description"=>"This method is used to update multiple customers in the system. no url parameters should be included..", "operationId"=>"Customers_Update", "x-api-path-slug"=>"3dcartwebapiv1customers-put", "parameters"=>[{"in"=>"body", "name"=>"customers", "description"=>"A Json or XML object containing the new customer", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Multiple", "Customers", "In", "System", "", "No", "URL", "Parameters", "Should", "Be", "Included"]}, "post"=>{"summary"=>"Adds a new customer to the system", "description"=>"Adds a new customer to the system.", "operationId"=>"Customers_Post", "x-api-path-slug"=>"3dcartwebapiv1customers-post", "parameters"=>[{"in"=>"body", "name"=>"customer", "description"=>"A Json or XML object containing the new customer", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Customer", "To", "System"]}}, "/3dCartWebAPI/v1/Customers/{customerid}"=>{"put"=>{"summary"=>"This method is used to update a single customer record in the database. The {id} parameter specifies which customer record to update.", "description"=>"This method is used to update a single customer record in the database. the {id} parameter specifies which customer record to update..", "operationId"=>"Customers_Update", "x-api-path-slug"=>"3dcartwebapiv1customerscustomerid-put", "parameters"=>[{"in"=>"body", "name"=>"customer", "description"=>"A Json or XML object containing the new customer", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerid", "description"=>"Customer ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Single", "Customer", "Record", "In", "Database", "", "Id", "Parameter", "Specifies", "Which", "Customer", "Record", "To", "Update"]}}, "/3dCartWebAPI/v1/Customers/{id}"=>{"get"=>{"summary"=>"Get a Customer", "description"=>"Get a customer.", "operationId"=>"Customers_GetAllCustomers", "x-api-path-slug"=>"3dcartwebapiv1customersid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Customer ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer"]}, "delete"=>{"summary"=>"Deletes a Customer in the system", "description"=>"Deletes a customer in the system.", "operationId"=>"Customers_Delete", "x-api-path-slug"=>"3dcartwebapiv1customersid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Customer ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Customer", "In", "System"]}}, "/3dCartWebAPI/v1/Distributors"=>{"get"=>{"summary"=>"Get all Distributors", "description"=>"Get all distributors.", "operationId"=>"Distributors_GetAllDistributors", "x-api-path-slug"=>"3dcartwebapiv1distributors-get", "parameters"=>[{"in"=>"query", "name"=>"city", "description"=>"City of the Distributor"}, {"in"=>"query", "name"=>"company", "description"=>"Company Name of the Distributor"}, {"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"country", "description"=>"Country name of the Distributor"}, {"in"=>"query", "name"=>"email", "description"=>"Email of the Distributor"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"query", "name"=>"phone", "description"=>"Phone of the Distributor"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"query", "name"=>"state", "description"=>"State of the Distributor"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Distributors"]}, "put"=>{"summary"=>"This method is used to update multiple distributor records in the database. No {distributorid} parameters should be included.", "description"=>"This method is used to update multiple distributor records in the database. no {distributorid} parameters should be included..", "operationId"=>"Distributors_Update", "x-api-path-slug"=>"3dcartwebapiv1distributors-put", "parameters"=>[{"in"=>"body", "name"=>"distributors", "description"=>"A Json or XML object containing the new distributors", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Multiple", "Distributor", "Records", "In", "Database", "", "No", "Distributorid", "Parameters", "Should", "Be", "Included"]}, "post"=>{"summary"=>"Adds a new distributor to the system", "description"=>"Adds a new distributor to the system.", "operationId"=>"Distributors_Post", "x-api-path-slug"=>"3dcartwebapiv1distributors-post", "parameters"=>[{"in"=>"body", "name"=>"distributor", "description"=>"A Json or XML object containing the new distributor", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Distributor", "To", "System"]}}, "/3dCartWebAPI/v1/Distributors/{distributorid}"=>{"put"=>{"summary"=>"This method is used to update a single distributor record in the database. The {distributorid} parameter specifies which distributor to update.", "description"=>"This method is used to update a single distributor record in the database. the {distributorid} parameter specifies which distributor to update..", "operationId"=>"Distributors_Update", "x-api-path-slug"=>"3dcartwebapiv1distributorsdistributorid-put", "parameters"=>[{"in"=>"body", "name"=>"distributor", "description"=>"A Json or XML object containing the new distributor", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"distributorid", "description"=>"Distributor ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Single", "Distributor", "Record", "In", "Database", "", "Distributorid", "Parameter", "Specifies", "Which", "Distributor", "To", "Update"]}}, "/3dCartWebAPI/v1/Distributors/{distributorid}/Products"=>{"get"=>{"summary"=>"Get all products from a specific distributor", "description"=>"Get all products from a specific distributor.", "operationId"=>"Products_GetAllProductsFromDistributor", "x-api-path-slug"=>"3dcartwebapiv1distributorsdistributoridproducts-get", "parameters"=>[{"in"=>"query", "name"=>"categoryspecial", "description"=>"Category Special Flag"}, {"in"=>"query", "name"=>"costfrom", "description"=>"Cost of a product"}, {"in"=>"query", "name"=>"costto", "description"=>"Cost of a product"}, {"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"path", "name"=>"distributorid", "description"=>"ID of the distributor"}, {"in"=>"query", "name"=>"freeshipping", "description"=>"Free Shipping Flag"}, {"in"=>"query", "name"=>"giftcertificate", "description"=>"Gift Certificate Flag"}, {"in"=>"query", "name"=>"hide", "description"=>"Hide Flag"}, {"in"=>"query", "name"=>"homespecial", "description"=>"Home Special Flag"}, {"in"=>"query", "name"=>"lastupdateend", "description"=>"End Date that the product was last updated (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"lastupdatestart", "description"=>"Start Date that the product was last updated (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the product"}, {"in"=>"query", "name"=>"nonsearchable", "description"=>"Non-Searchable Flag"}, {"in"=>"query", "name"=>"nontax", "description"=>"Non-Taxable Flag"}, {"in"=>"query", "name"=>"notforsale", "description"=>"Not For Sale Flag"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"query", "name"=>"onsale", "description"=>"On Sale Flag"}, {"in"=>"query", "name"=>"pricefrom", "description"=>"Price of a product"}, {"in"=>"query", "name"=>"priceto", "description"=>"Price of a product"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"query", "name"=>"rewarddisable", "description"=>"Disable Rewards Flag"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"query", "name"=>"selfship", "description"=>"Ships by itself Flag"}, {"in"=>"query", "name"=>"sku", "description"=>"SKU Code of the product"}, {"in"=>"query", "name"=>"stockfrom", "description"=>"Stock of a product"}, {"in"=>"query", "name"=>"stockto", "description"=>"Stock of a product"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "From", "Specific", "Distributor"]}}, "/3dCartWebAPI/v1/Distributors/{id}"=>{"get"=>{"summary"=>"Get a Distributor", "description"=>"Get a distributor.", "operationId"=>"Distributors_GetAllDistributors", "x-api-path-slug"=>"3dcartwebapiv1distributorsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Distributor ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Distributor"]}, "delete"=>{"summary"=>"Deletes a Distributor in the system", "description"=>"Deletes a distributor in the system.", "operationId"=>"Distributors_Delete", "x-api-path-slug"=>"3dcartwebapiv1distributorsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Distributor ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Distributor", "In", "System"]}}, "/3dCartWebAPI/v1/GiftRegistries"=>{"get"=>{"summary"=>"Get all GiftRegistries", "description"=>"Get all giftregistries.", "operationId"=>"GiftRegistries_GetAllGiftRegistries", "x-api-path-slug"=>"3dcartwebapiv1giftregistries-get", "parameters"=>[{"in"=>"query", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"dateendcreated", "description"=>"Created Date End (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"dateendevent", "description"=>"Event Date End (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"dateendexpiration", "description"=>"Expiration Date End (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"datestartcreated", "description"=>"Created Date Start (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"datestartevent", "description"=>"Event Date Start (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"datestartexpiration", "description"=>"Expiration Date Start (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"query", "name"=>"sku", "description"=>"SKU Code of the product"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GiftRegistries"]}}, "/3dCartWebAPI/v1/GiftRegistries/{giftregistryid}"=>{"get"=>{"summary"=>"Get a specific GiftRegistry", "description"=>"Get a specific giftregistry.", "operationId"=>"GiftRegistries_GetGiftRegistry", "x-api-path-slug"=>"3dcartwebapiv1giftregistriesgiftregistryid-get", "parameters"=>[{"in"=>"path", "name"=>"giftregistryid", "description"=>"Gift Resitry ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "GiftRegistry"]}}, "/3dCartWebAPI/v1/GiftRegistries/{giftregistryid}/Items"=>{"get"=>{"summary"=>"Gets the items from a specific Gift Registry", "description"=>"Gets the items from a specific gift registry.", "operationId"=>"GiftRegistries_GetAllGiftRegistryItem", "x-api-path-slug"=>"3dcartwebapiv1giftregistriesgiftregistryiditems-get", "parameters"=>[{"in"=>"path", "name"=>"giftregistryid", "description"=>"Gift Registry ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Items", "From", "Specific", "Gift", "Registry"]}}, "/3dCartWebAPI/v1/Manufacturers"=>{"get"=>{"summary"=>"Get all Manufacturers", "description"=>"Get all manufacturers.", "operationId"=>"Manufacturer_GetAllManufacturers", "x-api-path-slug"=>"3dcartwebapiv1manufacturers-get", "parameters"=>[{"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"manufacturer", "description"=>"Name of the Manufacturer"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Manufacturers"]}, "put"=>{"summary"=>"This method is used to update multiple manufacturers in the database. No URL parameters should be included.", "description"=>"This method is used to update multiple manufacturers in the database. no url parameters should be included..", "operationId"=>"Manufacturer_Update", "x-api-path-slug"=>"3dcartwebapiv1manufacturers-put", "parameters"=>[{"in"=>"body", "name"=>"manufacturers", "description"=>"A Json or XML object containing the new manufacturers", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Multiple", "Manufacturers", "In", "Database", "", "No", "URL", "Parameters", "Should", "Be", "Included"]}, "post"=>{"summary"=>"Adds a new manufacturer to the system", "description"=>"Adds a new manufacturer to the system.", "operationId"=>"Manufacturer_Post", "x-api-path-slug"=>"3dcartwebapiv1manufacturers-post", "parameters"=>[{"in"=>"body", "name"=>"manufacturer", "description"=>"A Json or XML object containing the new manufacturer", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Manufacturer", "To", "System"]}}, "/3dCartWebAPI/v1/Manufacturers/{id}"=>{"get"=>{"summary"=>"Get a Manufacturer", "description"=>"Get a manufacturer.", "operationId"=>"Manufacturer_GetManufacturer", "x-api-path-slug"=>"3dcartwebapiv1manufacturersid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Manufacturer ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Manufacturer"]}, "delete"=>{"summary"=>"Deletes a Manufacturer in the system", "description"=>"Deletes a manufacturer in the system.", "operationId"=>"Manufacturer_Delete", "x-api-path-slug"=>"3dcartwebapiv1manufacturersid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Manufacturer ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Manufacturer", "In", "System"]}}, "/3dCartWebAPI/v1/Manufacturers/{manufacturerid}"=>{"put"=>{"summary"=>"This method is used to update a single manufacturer record in the database. The {manufacturerid} parameter specifies which manufacturer record to update.", "description"=>"This method is used to update a single manufacturer record in the database. the {manufacturerid} parameter specifies which manufacturer record to update..", "operationId"=>"Manufacturer_Update", "x-api-path-slug"=>"3dcartwebapiv1manufacturersmanufacturerid-put", "parameters"=>[{"in"=>"body", "name"=>"manufacturer", "description"=>"A Json or XML object containing the new manufacturer", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"manufacturerid", "description"=>"Manufacturer ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Single", "Manufacturer", "Record", "In", "Database", "", "Manufacturerid", "Parameter", "Specifies", "Which", "Manufacturer", "Record", "To", "Update"]}}, "/3dCartWebAPI/v1/Manufacturers/{manufacturerid}/Products"=>{"get"=>{"summary"=>"Get all products from a specific manufacturer", "description"=>"Get all products from a specific manufacturer.", "operationId"=>"Products_GetAllProductsFromManufacturer", "x-api-path-slug"=>"3dcartwebapiv1manufacturersmanufactureridproducts-get", "parameters"=>[{"in"=>"query", "name"=>"categoryspecial", "description"=>"Category Special Flag"}, {"in"=>"query", "name"=>"costfrom", "description"=>"Cost of a product"}, {"in"=>"query", "name"=>"costto", "description"=>"Cost of a product"}, {"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"freeshipping", "description"=>"Free Shipping Flag"}, {"in"=>"query", "name"=>"giftcertificate", "description"=>"Gift Certificate Flag"}, {"in"=>"query", "name"=>"hide", "description"=>"Hide Flag"}, {"in"=>"query", "name"=>"homespecial", "description"=>"Home Special Flag"}, {"in"=>"query", "name"=>"lastupdateend", "description"=>"End Date that the product was last updated (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"lastupdatestart", "description"=>"Start Date that the product was last updated (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"path", "name"=>"manufacturerid", "description"=>"ID of the manufacturer"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the product"}, {"in"=>"query", "name"=>"nonsearchable", "description"=>"Non-Searchable Flag"}, {"in"=>"query", "name"=>"nontax", "description"=>"Non-Taxable Flag"}, {"in"=>"query", "name"=>"notforsale", "description"=>"Not For Sale Flag"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"query", "name"=>"onsale", "description"=>"On Sale Flag"}, {"in"=>"query", "name"=>"pricefrom", "description"=>"Price of a product"}, {"in"=>"query", "name"=>"priceto", "description"=>"Price of a product"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"query", "name"=>"rewarddisable", "description"=>"Disable Rewards Flag"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"query", "name"=>"selfship", "description"=>"Ships by itself Flag"}, {"in"=>"query", "name"=>"sku", "description"=>"SKU Code of the product"}, {"in"=>"query", "name"=>"stockfrom", "description"=>"Stock of a product"}, {"in"=>"query", "name"=>"stockto", "description"=>"Stock of a product"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "From", "Specific", "Manufacturer"]}}, "/3dCartWebAPI/v1/Orders"=>{"get"=>{"summary"=>"", "description"=>".", "operationId"=>"Orders_GetAllOrders", "x-api-path-slug"=>"3dcartwebapiv1orders-get", "parameters"=>[{"in"=>"query", "name"=>"billingemail"}, {"in"=>"query", "name"=>"countonly"}, {"in"=>"query", "name"=>"dateend"}, {"in"=>"query", "name"=>"datestart"}, {"in"=>"query", "name"=>"invoicenumber"}, {"in"=>"query", "name"=>"invoicenumberend"}, {"in"=>"query", "name"=>"invoicenumberstart"}, {"in"=>"query", "name"=>"invoiceprefix"}, {"in"=>"query", "name"=>"lastupdateend"}, {"in"=>"query", "name"=>"lastupdatestart"}, {"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"orderstatus"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "put"=>{"summary"=>"This method is used to update multiple orders in the database. No URL parameters should be included.", "description"=>"This method is used to update multiple orders in the database. no url parameters should be included..", "operationId"=>"Orders_Update", "x-api-path-slug"=>"3dcartwebapiv1orders-put", "parameters"=>[{"in"=>"body", "name"=>"orders", "description"=>"A Json or XML object containing the orders", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Multiple", "Orders", "In", "Database", "", "No", "URL", "Parameters", "Should", "Be", "Included"]}, "post"=>{"summary"=>"Adds a new order to the system", "description"=>"Adds a new order to the system.", "operationId"=>"Orders_Post", "x-api-path-slug"=>"3dcartwebapiv1orders-post", "parameters"=>[{"in"=>"query", "name"=>"bypassorderemail", "description"=>"will bypass sending the customer new order email if normally applicable"}, {"in"=>"query", "name"=>"bypassorderprocessing", "description"=>"will bypass/ignore stock updates, gift certificates generation, rewards, etc"}, {"in"=>"body", "name"=>"order", "description"=>"A Json or XML object containing the new order", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Order", "To", "System"]}}, "/3dCartWebAPI/v1/Orders/{orderid}"=>{"get"=>{"summary"=>"Get a specific order", "description"=>"Get a specific order.", "operationId"=>"Orders_GetOrder", "x-api-path-slug"=>"3dcartwebapiv1ordersorderid-get", "parameters"=>[{"in"=>"path", "name"=>"orderid", "description"=>"Order ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "Order"]}, "put"=>{"summary"=>"This method is used to update a single order record in the database. The {orderid} parameter specifies which order record to update.", "description"=>"This method is used to update a single order record in the database. the {orderid} parameter specifies which order record to update..", "operationId"=>"Orders_Update", "x-api-path-slug"=>"3dcartwebapiv1ordersorderid-put", "parameters"=>[{"in"=>"body", "name"=>"order", "description"=>"A Json or XML object containing the order", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"orderid", "description"=>"OrderID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Single", "Order", "Record", "In", "Database", "", "Orderid", "Parameter", "Specifies", "Which", "Order", "Record", "To", "Update"]}}, "/3dCartWebAPI/v1/Orders/{orderid}/Items"=>{"get"=>{"summary"=>"Gets the items from a specific Order", "description"=>"Gets the items from a specific order.", "operationId"=>"Orders_GetAllOrderItems", "x-api-path-slug"=>"3dcartwebapiv1ordersorderiditems-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"path", "name"=>"orderid", "description"=>"Order ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Items", "From", "Specific", "Order"]}, "put"=>{"summary"=>"Updates a collection of items from a specific Order", "description"=>"Updates a collection of items from a specific order.", "operationId"=>"Orders_Update", "x-api-path-slug"=>"3dcartwebapiv1ordersorderiditems-put", "parameters"=>[{"in"=>"body", "name"=>"items", "description"=>"A Json or XML object containing the new items", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"orderid", "description"=>"OrderID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Collection", "Of", "Items", "From", "Specific", "Order"]}, "post"=>{"summary"=>"Adds a new item on the order", "description"=>"Adds a new item on the order.", "operationId"=>"Orders_Post", "x-api-path-slug"=>"3dcartwebapiv1ordersorderiditems-post", "parameters"=>[{"in"=>"body", "name"=>"item", "description"=>"A Json or XML object containing the new item", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"orderid", "description"=>"Order ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Item", "On", "Order"]}}, "/3dCartWebAPI/v1/Orders/{orderid}/Items/{itemindexid}"=>{"put"=>{"summary"=>"Updates a specific item from a specific Product", "description"=>"Updates a specific item from a specific product.", "operationId"=>"Orders_Update", "x-api-path-slug"=>"3dcartwebapiv1ordersorderiditemsitemindexid-put", "parameters"=>[{"in"=>"body", "name"=>"item", "description"=>"A Json or XML object containing the new item", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"itemindexid", "description"=>"The unique indexID of an Item"}, {"in"=>"path", "name"=>"orderid", "description"=>"OrderID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Specific", "Item", "From", "Specific", "Product"]}}, "/3dCartWebAPI/v1/Orders/{orderid}/Questions"=>{"get"=>{"summary"=>"Gets the questions from a specific Order", "description"=>"Gets the questions from a specific order.", "operationId"=>"Orders_GetAllOrderQuestions", "x-api-path-slug"=>"3dcartwebapiv1ordersorderidquestions-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"path", "name"=>"orderid", "description"=>"Order ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Questions", "From", "Specific", "Order"]}, "put"=>{"summary"=>"Updates a collection of questions from a specific Order", "description"=>"Updates a collection of questions from a specific order.", "operationId"=>"Orders_Update", "x-api-path-slug"=>"3dcartwebapiv1ordersorderidquestions-put", "parameters"=>[{"in"=>"path", "name"=>"orderid", "description"=>"OrderID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"body", "name"=>"questions", "description"=>"A Json or XML object containing the new questions", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Collection", "Of", "Questions", "From", "Specific", "Order"]}, "post"=>{"summary"=>"Adds a new question on the order", "description"=>"Adds a new question on the order.", "operationId"=>"Orders_Post", "x-api-path-slug"=>"3dcartwebapiv1ordersorderidquestions-post", "parameters"=>[{"in"=>"path", "name"=>"orderid", "description"=>"Order ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"body", "name"=>"question", "description"=>"A Json or XML object containing the new question", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Question", "On", "Order"]}}, "/3dCartWebAPI/v1/Orders/{orderid}/Questions/{questionanswerindexid}"=>{"put"=>{"summary"=>"Updates a specific question from a specific Product", "description"=>"Updates a specific question from a specific product.", "operationId"=>"Orders_Update", "x-api-path-slug"=>"3dcartwebapiv1ordersorderidquestionsquestionanswerindexid-put", "parameters"=>[{"in"=>"path", "name"=>"orderid", "description"=>"OrderID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"body", "name"=>"question", "description"=>"A Json or XML object containing the new question", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"questionanswerindexid", "description"=>"QuestionID"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Specific", "Question", "From", "Specific", "Product"]}}, "/3dCartWebAPI/v1/Orders/{orderid}/Shipments"=>{"get"=>{"summary"=>"Gets the shipments from a specific Order", "description"=>"Gets the shipments from a specific order.", "operationId"=>"Orders_GetAllOrderShipments", "x-api-path-slug"=>"3dcartwebapiv1ordersorderidshipments-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"path", "name"=>"orderid"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Shipments", "From", "Specific", "Order"]}, "put"=>{"summary"=>"Updates a collection of shipments from a specific Order", "description"=>"Updates a collection of shipments from a specific order.", "operationId"=>"Orders_Update", "x-api-path-slug"=>"3dcartwebapiv1ordersorderidshipments-put", "parameters"=>[{"in"=>"path", "name"=>"orderid", "description"=>"OrderID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"body", "name"=>"shipments", "description"=>"A Json or XML object containing the new shipments", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Collection", "Of", "Shipments", "From", "Specific", "Order"]}, "post"=>{"summary"=>"Adds a new shipment on the order", "description"=>"Adds a new shipment on the order.", "operationId"=>"Orders_Post", "x-api-path-slug"=>"3dcartwebapiv1ordersorderidshipments-post", "parameters"=>[{"in"=>"path", "name"=>"orderid", "description"=>"Order ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"body", "name"=>"shipment", "description"=>"A Json or XML object containing the new shipment", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Shipment", "On", "Order"]}}, "/3dCartWebAPI/v1/Orders/{orderid}/Shipments/{shipmentid}"=>{"put"=>{"summary"=>"Updates a specific shipment from a specific Order", "description"=>"Updates a specific shipment from a specific order.", "operationId"=>"Orders_Update", "x-api-path-slug"=>"3dcartwebapiv1ordersorderidshipmentsshipmentid-put", "parameters"=>[{"in"=>"path", "name"=>"orderid", "description"=>"OrderID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"body", "name"=>"shipment", "description"=>"A Json or XML object containing the new shipment", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"shipmentid", "description"=>"ShipmentID"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Specific", "Shipment", "From", "Specific", "Order"]}}, "/3dCartWebAPI/v1/Orders/{orderid}/Transactions"=>{"get"=>{"summary"=>"Gets the transactions from a specific Order", "description"=>"Gets the transactions from a specific order.", "operationId"=>"Orders_GetAllOrderTransactions", "x-api-path-slug"=>"3dcartwebapiv1ordersorderidtransactions-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"path", "name"=>"orderid", "description"=>"Order ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Transactions", "From", "Specific", "Order"]}, "put"=>{"summary"=>"Updates a collection of transactions from a specific Order", "description"=>"Updates a collection of transactions from a specific order.", "operationId"=>"Orders_Update", "x-api-path-slug"=>"3dcartwebapiv1ordersorderidtransactions-put", "parameters"=>[{"in"=>"path", "name"=>"orderid", "description"=>"OrderID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}, {"in"=>"body", "name"=>"transactions", "description"=>"A Json or XML object containing the new transactions", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Collection", "Of", "Transactions", "From", "Specific", "Order"]}, "post"=>{"summary"=>"Adds a new transaction on the order", "description"=>"Adds a new transaction on the order.", "operationId"=>"Orders_Post", "x-api-path-slug"=>"3dcartwebapiv1ordersorderidtransactions-post", "parameters"=>[{"in"=>"path", "name"=>"orderid", "description"=>"Order ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}, {"in"=>"body", "name"=>"transaction", "description"=>"A Json or XML object containing the new transaction", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Transaction", "On", "Order"]}}, "/3dCartWebAPI/v1/Orders/{orderid}/Transactions/{transactionindexid}"=>{"put"=>{"summary"=>"Updates a specific transaction from a specific Product", "description"=>"Updates a specific transaction from a specific product.", "operationId"=>"Orders_Update", "x-api-path-slug"=>"3dcartwebapiv1ordersorderidtransactionstransactionindexid-put", "parameters"=>[{"in"=>"path", "name"=>"orderid", "description"=>"OrderID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}, {"in"=>"body", "name"=>"transaction", "description"=>"A Json or XML object containing the new transaction", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"transactionindexid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Specific", "Transaction", "From", "Specific", "Product"]}}, "/3dCartWebAPI/v1/OrderStatus"=>{"get"=>{"summary"=>"Get all OrderStatus", "description"=>"Get all orderstatus.", "operationId"=>"OrderStatus_GetAllOrderStatus", "x-api-path-slug"=>"3dcartwebapiv1orderstatus-get", "parameters"=>[{"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OrderStatus"]}}, "/3dCartWebAPI/v1/OrderStatus/{id}"=>{"get"=>{"summary"=>"Get an OrderStatus", "description"=>"Get an orderstatus.", "operationId"=>"OrderStatus_GetOrderStatus", "x-api-path-slug"=>"3dcartwebapiv1orderstatusid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"OrderStatus ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OrderStatus"]}}, "/3dCartWebAPI/v1/PaymentTokens"=>{"get"=>{"summary"=>"Get all Payment Tokens", "description"=>"Get all payment tokens.", "operationId"=>"PaymentToken_GetAllPaymentTokens", "x-api-path-slug"=>"3dcartwebapiv1paymenttokens-get", "parameters"=>[{"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment", "Tokens"]}, "put"=>{"summary"=>"This method is used to update multiple paymenttokens in the database. No URL parameters should be included.", "description"=>"This method is used to update multiple paymenttokens in the database. no url parameters should be included..", "operationId"=>"PaymentToken_Update", "x-api-path-slug"=>"3dcartwebapiv1paymenttokens-put", "parameters"=>[{"in"=>"body", "name"=>"paymenttokens", "description"=>"A Json or XML object containing the new PaymentTokens", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Multiple", "Paymenttokens", "In", "Database", "", "No", "URL", "Parameters", "Should", "Be", "Included"]}, "post"=>{"summary"=>"Adds a new paymenttoken to the system", "description"=>"Adds a new paymenttoken to the system.", "operationId"=>"PaymentToken_Post", "x-api-path-slug"=>"3dcartwebapiv1paymenttokens-post", "parameters"=>[{"in"=>"body", "name"=>"paymenttoken", "description"=>"A Json or XML object containing the new manufacturer", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Paymenttoken", "To", "System"]}}, "/3dCartWebAPI/v1/PaymentTokens/{id}"=>{"get"=>{"summary"=>"Get a Payment Token", "description"=>"Get a payment token.", "operationId"=>"PaymentToken_GetPaymentToken", "x-api-path-slug"=>"3dcartwebapiv1paymenttokensid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"PaymentTokenID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment", "Token"]}, "delete"=>{"summary"=>"Deletes a Payment Token in the system", "description"=>"Deletes a payment token in the system.", "operationId"=>"PaymentToken_Delete", "x-api-path-slug"=>"3dcartwebapiv1paymenttokensid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"PaymentTokenID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Payment", "Token", "In", "System"]}}, "/3dCartWebAPI/v1/PaymentTokens/{paymenttokenid}"=>{"put"=>{"summary"=>"This method is used to update a single paymenttoken record in the database. The {paymenttokenid} parameter specifies which paymenttoken record to update.", "description"=>"This method is used to update a single paymenttoken record in the database. the {paymenttokenid} parameter specifies which paymenttoken record to update..", "operationId"=>"PaymentToken_Update", "x-api-path-slug"=>"3dcartwebapiv1paymenttokenspaymenttokenid-put", "parameters"=>[{"in"=>"body", "name"=>"paymenttoken", "description"=>"A Json or XML object containing the new paymenttoken", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"paymenttokenid", "description"=>"PaymentTokenID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Single", "Paymenttoken", "Record", "In", "Database", "", "Paymenttokenid", "Parameter", "Specifies", "Which", "Paymenttoken", "Record", "To", "Update"]}}, "/3dCartWebAPI/v1/Products"=>{"get"=>{"summary"=>"Get all products", "description"=>"Get all products.", "operationId"=>"Products_GetAllProducts", "x-api-path-slug"=>"3dcartwebapiv1products-get", "parameters"=>[{"in"=>"query", "name"=>"categoryspecial", "description"=>"Category Special Flag"}, {"in"=>"query", "name"=>"costfrom", "description"=>"Cost of a product"}, {"in"=>"query", "name"=>"costto", "description"=>"Cost of a product"}, {"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"freeshipping", "description"=>"Free Shipping Flag"}, {"in"=>"query", "name"=>"giftcertificate", "description"=>"Gift Certificate Flag"}, {"in"=>"query", "name"=>"hide", "description"=>"Hide Flag"}, {"in"=>"query", "name"=>"homespecial", "description"=>"Home Special Flag"}, {"in"=>"query", "name"=>"lastupdateend", "description"=>"End Date that the product was last updated (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"lastupdatestart", "description"=>"Start Date that the product was last updated (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the product"}, {"in"=>"query", "name"=>"nonsearchable", "description"=>"Non-Searchable Flag"}, {"in"=>"query", "name"=>"nontax", "description"=>"Non-Taxable Flag"}, {"in"=>"query", "name"=>"notforsale", "description"=>"Not For Sale Flag"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"query", "name"=>"onsale", "description"=>"On Sale Flag"}, {"in"=>"query", "name"=>"pricefrom", "description"=>"Price of a product"}, {"in"=>"query", "name"=>"priceto", "description"=>"Price of a product"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"query", "name"=>"rewarddisable", "description"=>"Disable Rewards Flag"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"query", "name"=>"selfship", "description"=>"Ships by itself Flag"}, {"in"=>"query", "name"=>"sku", "description"=>"SKU Code of the product"}, {"in"=>"query", "name"=>"stockfrom", "description"=>"Stock of a product"}, {"in"=>"query", "name"=>"stockto", "description"=>"Stock of a product"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}, "put"=>{"summary"=>"This method is used to update multiple products in the database. No URL parameters should be included.", "description"=>"This method is used to update multiple products in the database. no url parameters should be included..", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1products-put", "parameters"=>[{"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"body", "name"=>"products", "description"=>"A Json or XML object containing the new product(s)", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Multiple", "Products", "In", "Database", "", "No", "URL", "Parameters", "Should", "Be", "Included"]}, "post"=>{"summary"=>"Adds a new product to the system", "description"=>"Adds a new product to the system.", "operationId"=>"Products_Post", "x-api-path-slug"=>"3dcartwebapiv1products-post", "parameters"=>[{"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"body", "name"=>"product", "description"=>"A Json or XML object containing the new product", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Product", "To", "System"]}}, "/3dCartWebAPI/v1/Products/{catalogid}"=>{"get"=>{"summary"=>"Get a product", "description"=>"Get a product.", "operationId"=>"Products_GetProduct", "x-api-path-slug"=>"3dcartwebapiv1productscatalogid-get", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalogid of the item"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}, "put"=>{"summary"=>"This method is used to update a single product record in the database. The {catalogid} parameter specifies which product record to update.", "description"=>"This method is used to update a single product record in the database. the {catalogid} parameter specifies which product record to update..", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogid-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"body", "name"=>"product", "description"=>"A Json or XML object containing the new product", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Single", "Product", "Record", "In", "Database", "", "Catalogid", "Parameter", "Specifies", "Which", "Product", "Record", "To", "Update"]}, "delete"=>{"summary"=>"Deletes a product in the system", "description"=>"Deletes a product in the system.", "operationId"=>"Products_Delete", "x-api-path-slug"=>"3dcartwebapiv1productscatalogid-delete", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Product", "In", "System"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/AdvancedOptions"=>{"get"=>{"summary"=>"Get the advanced options from a specific Product", "description"=>"Get the advanced options from a specific product.", "operationId"=>"Products_GetAllProductAdvancedOptions", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidadvancedoptions-get", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advanced", "Options", "From", "Specific", "Product"]}, "put"=>{"summary"=>"Updates a collection of advanced options from a specific Product", "description"=>"Updates a collection of advanced options from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidadvancedoptions-put", "parameters"=>[{"in"=>"body", "name"=>"advancedoptions", "description"=>"A Json or XML object containing the new advanced options", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Collection", "Of", "Advanced", "Options", "From", "Specific", "Product"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/AdvancedOptions/{advancedoptioncode}"=>{"put"=>{"summary"=>"Updates specific advanced options from a specific Product", "description"=>"Updates specific advanced options from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidadvancedoptionsadvancedoptioncode-put", "parameters"=>[{"in"=>"body", "name"=>"advancedoption", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"advancedoptioncode", "description"=>"AdvancedOptionCode"}, {"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Specific", "Advanced", "Options", "From", "Specific", "Product"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/Categories"=>{"get"=>{"summary"=>"Get the categories from a specific Product", "description"=>"Get the categories from a specific product.", "operationId"=>"Products_GetAllProductCategories", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidcategories-get", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories", "From", "Specific", "Product"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/Discount"=>{"get"=>{"summary"=>"Get the discounts from a specific Product", "description"=>"Get the discounts from a specific product.", "operationId"=>"Products_GetAllProductDiscount", "x-api-path-slug"=>"3dcartwebapiv1productscatalogiddiscount-get", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Discounts", "From", "Specific", "Product"]}, "put"=>{"summary"=>"Updates a collection of discounts from a specific Product", "description"=>"Updates a collection of discounts from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogiddiscount-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"body", "name"=>"discounts", "description"=>"A Json or XML object containing the new discount", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Collection", "Of", "Discounts", "From", "Specific", "Product"]}, "post"=>{"summary"=>"Adds a new discount to the system", "description"=>"Adds a new discount to the system.", "operationId"=>"Products_Post", "x-api-path-slug"=>"3dcartwebapiv1productscatalogiddiscount-post", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"body", "name"=>"discount", "description"=>"A Json or XML object containing the new discount", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Discount", "To", "System"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/Discount/{discountid}"=>{"put"=>{"summary"=>"Updates a specific discount from a specific Product", "description"=>"Updates a specific discount from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogiddiscountdiscountid-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"body", "name"=>"discount", "description"=>"A Json or XML object containing the new discounts", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"discountid", "description"=>"DiscountID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Specific", "Discount", "From", "Specific", "Product"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/Distributors"=>{"get"=>{"summary"=>"Get the distributors from a specific Product", "description"=>"Get the distributors from a specific product.", "operationId"=>"Products_GetAllProductDistributors", "x-api-path-slug"=>"3dcartwebapiv1productscatalogiddistributors-get", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Distributors", "From", "Specific", "Product"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/EProducts"=>{"get"=>{"summary"=>"Get the EProducts from a specific Product", "description"=>"Get the eproducts from a specific product.", "operationId"=>"Products_GetAllProductEProducts", "x-api-path-slug"=>"3dcartwebapiv1productscatalogideproducts-get", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["EProducts", "From", "Specific", "Product"]}, "put"=>{"summary"=>"Updates a collection of eproducts from a specific Product", "description"=>"Updates a collection of eproducts from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogideproducts-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"body", "name"=>"eproducts", "description"=>"A Json or XML object containing the new features", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Collection", "Of", "Eproducts", "From", "Specific", "Product"]}, "post"=>{"summary"=>"Adds a new eproduct to the system", "description"=>"Adds a new eproduct to the system.", "operationId"=>"Products_Post", "x-api-path-slug"=>"3dcartwebapiv1productscatalogideproducts-post", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"body", "name"=>"eproduct", "description"=>"A Json or XML object containing the new eproduct", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Eproduct", "To", "System"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/EProducts/{filenumber}"=>{"put"=>{"summary"=>"Updates a specific eproduct from a specific Product", "description"=>"Updates a specific eproduct from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogideproductsfilenumber-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"body", "name"=>"eproduct", "description"=>"A Json or XML object containing the new features", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"filenumber", "description"=>"FileNumber"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Specific", "Eproduct", "From", "Specific", "Product"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/Features"=>{"get"=>{"summary"=>"Get the features from a specific Product", "description"=>"Get the features from a specific product.", "operationId"=>"Products_GetAllProductFeatures", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidfeatures-get", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Features", "From", "Specific", "Product"]}, "put"=>{"summary"=>"Updates a collection of features from a specific Product", "description"=>"Updates a collection of features from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidfeatures-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"body", "name"=>"features", "description"=>"A Json or XML object containing the new features", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Collection", "Of", "Features", "From", "Specific", "Product"]}, "post"=>{"summary"=>"Adds a new feature to the system", "description"=>"Adds a new feature to the system.", "operationId"=>"Products_Post", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidfeatures-post", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"body", "name"=>"feature", "description"=>"A Json or XML object containing the new feature", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Feature", "To", "System"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/Features/{featureid}"=>{"put"=>{"summary"=>"Updates a specific feature from a specific Product", "description"=>"Updates a specific feature from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidfeaturesfeatureid-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"body", "name"=>"feature", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"featureid", "description"=>"FeatureID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Specific", "Feature", "From", "Specific", "Product"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/Images"=>{"get"=>{"summary"=>"Get the images from a specific Product", "description"=>"Get the images from a specific product.", "operationId"=>"Products_GetAllProductImages", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidimages-get", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "From", "Specific", "Product"]}, "put"=>{"summary"=>"Updates a collection of images from a specific Product", "description"=>"Updates a collection of images from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidimages-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"body", "name"=>"images", "description"=>"A Json or XML object containing the new images", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Collection", "Of", "Images", "From", "Specific", "Product"]}, "post"=>{"summary"=>"Adds a new image to the system", "description"=>"Adds a new image to the system.", "operationId"=>"Products_Post", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidimages-post", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"body", "name"=>"image", "description"=>"A Json or XML object containing the new image", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Image", "To", "System"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/Images/{imagegalleryid}"=>{"put"=>{"summary"=>"Updates a specific image from a specific Product", "description"=>"Updates a specific image from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidimagesimagegalleryid-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"body", "name"=>"image", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"imagegalleryid", "description"=>"ImageGalleryID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Specific", "Image", "From", "Specific", "Product"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/Options"=>{"get"=>{"summary"=>"Get the options from a specific Product", "description"=>"Get the options from a specific product.", "operationId"=>"Products_GetAllProductOptions", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidoptions-get", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Options", "From", "Specific", "Product"]}, "put"=>{"summary"=>"Updates a collection of options from a specific Product", "description"=>"Updates a collection of options from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidoptions-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"body", "name"=>"options", "description"=>"A Json or XML object containing the new options", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Collection", "Of", "Options", "From", "Specific", "Product"]}, "post"=>{"summary"=>"Adds a new OptionSet to the system", "description"=>"Adds a new optionset to the system.", "operationId"=>"Products_Post", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidoptions-post", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"body", "name"=>"optionset", "description"=>"A Json or XML object containing the new optionset", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "OptionSet", "To", "System"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/Options/{optionsetid}"=>{"put"=>{"summary"=>"Updates specific options from a specific Product", "description"=>"Updates specific options from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidoptionsoptionsetid-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"body", "name"=>"option", "description"=>"A Json or XML object containing the new options", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"optionsetid", "description"=>"OptionSetID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Specific", "Options", "From", "Specific", "Product"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/Related"=>{"get"=>{"summary"=>"Get the related products from a specific Product", "description"=>"Get the related products from a specific product.", "operationId"=>"Products_GetAllProductRelated", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidrelated-get", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Related", "Products", "From", "Specific", "Product"]}, "put"=>{"summary"=>"Updates a collection of related products from a specific Product", "description"=>"Updates a collection of related products from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidrelated-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"body", "name"=>"relatedproducts", "description"=>"A Json or XML object containing the new related products", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Collection", "Of", "Related", "Products", "From", "Specific", "Product"]}, "post"=>{"summary"=>"Adds a new related product to the system", "description"=>"Adds a new related product to the system.", "operationId"=>"Products_Post", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidrelated-post", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"body", "name"=>"relatedproduct", "description"=>"A Json or XML object containing the new related product", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Related", "Product", "To", "System"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/Related/{relatedindexid}"=>{"put"=>{"summary"=>"Updates a specific related product from a specific Product", "description"=>"Updates a specific related product from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidrelatedrelatedindexid-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"path", "name"=>"relatedindexid", "description"=>"RelatedIndexID"}, {"in"=>"body", "name"=>"relatedproduct", "description"=>"A Json or XML object containing the new related products", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Specific", "Related", "Product", "From", "Specific", "Product"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/Serials"=>{"get"=>{"summary"=>"Get the serials from a specific Product", "description"=>"Get the serials from a specific product.", "operationId"=>"Products_GetAllProductSerials", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidserials-get", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Serials", "From", "Specific", "Product"]}, "put"=>{"summary"=>"Updates a collection of serials from a specific Product", "description"=>"Updates a collection of serials from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidserials-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"body", "name"=>"serials", "description"=>"A Json or XML object containing the new serials", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Collection", "Of", "Serials", "From", "Specific", "Product"]}, "post"=>{"summary"=>"Adds a new serial to the system", "description"=>"Adds a new serial to the system.", "operationId"=>"Products_Post", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidserials-post", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"body", "name"=>"serial", "description"=>"A Json or XML object containing the new serial", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Serial", "To", "System"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/Serials/{serialid}"=>{"put"=>{"summary"=>"Updates a specific serial from a specific Product", "description"=>"Updates a specific serial from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidserialsserialid-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"body", "name"=>"serial", "description"=>"A Json or XML object containing the new features", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"serialid", "description"=>"FeatureID"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Specific", "Serial", "From", "Specific", "Product"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/skuinfo"=>{"get"=>{"summary"=>"Get all products (SKUInfo section only)", "description"=>"Get all products (skuinfo section only).", "operationId"=>"Products_GetAllProductsSKUInfo", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidskuinfo-get", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the product"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"query", "name"=>"sku", "description"=>"SKU Code of the product"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "(SKUInfo", "Section", "Only)"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/UpSelling"=>{"get"=>{"summary"=>"Get the upselling products from a specific Product", "description"=>"Get the upselling products from a specific product.", "operationId"=>"Products_GetAllProductUpSelling", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidupselling-get", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upselling", "Products", "From", "Specific", "Product"]}, "put"=>{"summary"=>"Updates a collection of upselling items from a specific Product", "description"=>"Updates a collection of upselling items from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidupselling-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}, {"in"=>"body", "name"=>"upsellingitems", "description"=>"A Json or XML object containing the new upselling items", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Collection", "Of", "Upselling", "Items", "From", "Specific", "Product"]}, "post"=>{"summary"=>"Adds a new upselling item to the system", "description"=>"Adds a new upselling item to the system.", "operationId"=>"Products_Post", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidupselling-post", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}, {"in"=>"body", "name"=>"upsellingitem", "description"=>"A Json or XML object containing the new upselling item", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "Upselling", "Item", "To", "System"]}}, "/3dCartWebAPI/v1/Products/{catalogid}/UpSelling/{upsellingindexid}"=>{"put"=>{"summary"=>"Updates a specific Upselling Item from a specific Product", "description"=>"Updates a specific upselling item from a specific product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"3dcartwebapiv1productscatalogidupsellingupsellingindexid-put", "parameters"=>[{"in"=>"path", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}, {"in"=>"path", "name"=>"upsellingindexid", "description"=>"UpSellingIndexID"}, {"in"=>"body", "name"=>"upsellingitem", "description"=>"A Json or XML object containing the new upselling tem", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Specific", "Upselling", "Item", "From", "Specific", "Product"]}}, "/3dCartWebAPI/v1/Products/skuinfo"=>{"get"=>{"summary"=>"Get all products (SKUInfo section only)", "description"=>"Get all products (skuinfo section only).", "operationId"=>"Products_GetAllProductsSKUInfo", "x-api-path-slug"=>"3dcartwebapiv1productsskuinfo-get", "parameters"=>[{"in"=>"query", "name"=>"catalogid", "description"=>"Catalog ID"}, {"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the product"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"query", "name"=>"sku", "description"=>"SKU Code of the product"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "(SKUInfo", "Section", "Only)"]}}, "/3dCartWebAPI/v1/RMA"=>{"get"=>{"summary"=>"Get all RMAs", "description"=>"Get all rmas.", "operationId"=>"RMA_GetAllRMAs", "x-api-path-slug"=>"3dcartwebapiv1rma-get", "parameters"=>[{"in"=>"query", "name"=>"catalogid", "description"=>"CatalogID"}, {"in"=>"query", "name"=>"countonly", "description"=>"Count the number of rows only"}, {"in"=>"query", "name"=>"dateend", "description"=>"Date End (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"datestart", "description"=>"Date Start (mm/dd/yyyy hh:mm:ss)"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"query", "name"=>"rmamethodid", "description"=>"Method of the RMA"}, {"in"=>"query", "name"=>"rmareasonid", "description"=>"Reason of the RMA"}, {"in"=>"query", "name"=>"rmastatusid", "description"=>"Status of the RMA"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"query", "name"=>"sku", "description"=>"SKU Code of the product"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RMAs"]}}, "/3dCartWebAPI/v1/RMA/{rmaid}"=>{"get"=>{"summary"=>"Get a specific RMA", "description"=>"Get a specific rma.", "operationId"=>"RMA_GetRMA", "x-api-path-slug"=>"3dcartwebapiv1rmarmaid-get", "parameters"=>[{"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"path", "name"=>"rmaid", "description"=>"RMA ID"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "RMA"]}}, "/3dCartWebAPI/v1/RMA/{rmaid}/Items"=>{"get"=>{"summary"=>"Gets the items from a specific RMA", "description"=>"Gets the items from a specific rma.", "operationId"=>"RMA_GetAllRMAItem", "x-api-path-slug"=>"3dcartwebapiv1rmarmaiditems-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items that can be returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Starting point for the return data"}, {"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"path", "name"=>"rmaid", "description"=>"Order ID"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Items", "From", "Specific", "RMA"]}}, "/3dCartWebAPI/v1/StoreSettings"=>{"get"=>{"summary"=>"Get the Store Settings", "description"=>"Get the store settings.", "operationId"=>"StoreSettings_GetStoreSettings", "x-api-path-slug"=>"3dcartwebapiv1storesettings-get", "parameters"=>[{"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store", "Settings"]}, "put"=>{"summary"=>"This method is used to update the Store Settings in the database.", "description"=>"This method is used to update the store settings in the database..", "operationId"=>"StoreSettings_UpdateStoreSettings", "x-api-path-slug"=>"3dcartwebapiv1storesettings-put", "parameters"=>[{"in"=>"header", "name"=>"PrivateKey", "description"=>"PrivateKey"}, {"in"=>"header", "name"=>"SecureURL", "description"=>"SecureURL"}, {"in"=>"body", "name"=>"settings", "description"=>"A Json or XML object containing the Store Settings", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Token", "description"=>"Token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Update", "Store", "Settings", "In", "Database"]}}}}, "apis"=>{"name"=>"3dcart", "x-slug"=>"3dcart", "description"=>"The 3dcart shopping cart software is a complete web store solution for anyone looking to start an online business, add a shopping cart to their existing website, or to replace their existing shopping cart platform. 3dcart includes the latest, most innovative features, tools, support and technology needed to build, promote and grow your online business.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/21488-www-3dcart-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"78099", "tags"=>"Commerce,internet,Relative Data,SaaS,Shopping Cart,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"3dcart/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"3dcart", "x-api-slug"=>"3dcart", "description"=>"The 3dcart shopping cart software is a complete web store solution for anyone looking to start an online business, add a shopping cart to their existing website, or to replace their existing shopping cart platform. 3dcart includes the latest, most innovative features, tools, support and technology needed to build, promote and grow your online business.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/21488-www-3dcart-com.jpg", "humanURL"=>"http://www.3dcart.com", "baseURL"=>"https://apirest.3dcart.com//", "tags"=>"Commerce,internet,Relative Data,SaaS,Shopping Cart,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/3dcart/3dcart-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-github", "url"=>"https://github.com/3dcart"}, {"type"=>"x-openapi", "url"=>"https://apirest.3dcart.com:443/docs/v1/swagger"}, {"type"=>"x-blog", "url"=>"https://blog.3dcart.com/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/3dcart-shopping-cart-software"}, {"type"=>"x-pricing", "url"=>"https://www.3dcart.com/pricing.htm"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/3dcart"}, {"type"=>"x-website", "url"=>"http://www.3dcart.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
clockwork{"clockwork-sms-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Clockwork", "x-complete"=>1, "info"=>{"title"=>"Clockwork SMS", "description"=>"the-http-interface-to-send-text-messages-can-be-accessed-using-get-or-post--all-parameters-must-be-url-encoded-and-sent-as-utf8-text-", "termsOfService"=>"http://www.clockworksms.com/terms-and-conditions/", "version"=>"v1"}, "host"=>"api.clockworksms.com", "basePath"=>"http/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/balance"=>{"get"=>{"summary"=>"Check Balance", "description"=>"Check how much credit you have left on your account.", "operationId"=>"getBalance", "x-api-path-slug"=>"balance-get", "parameters"=>[{"in"=>"query", "name"=>"Key", "description"=>"Your API key, available from your API account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Check", "Balance"]}}, "send.aspx"=>{"get"=>{"summary"=>"Send SMS Via HTTP", "description"=>"The HTTP interface to send text messages can be accessed using GET or POST. All parameters must be URL Encoded and sent as UTF-8 text.", "operationId"=>"getSend.aspx", "x-api-path-slug"=>"send-aspx-get", "parameters"=>[{"in"=>"query", "name"=>"Content", "description"=>"The message you want to send"}, {"in"=>"query", "name"=>"From", "description"=>"The text or phone number displayed when a text message is received on a phone"}, {"in"=>"query", "name"=>"Key", "description"=>"Your API key, available by logging in (with your username and password) to Clockwork"}, {"in"=>"query", "name"=>"Long", "description"=>"Set this to 1 and weu2019ll stick together multiple messages giving you up to 459 characters, rather than the standard 160 (each recipient will cost up to 3 message credits)"}, {"in"=>"query", "name"=>"total", "description"=>"Up to 50 comma separated numbers"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "SMS", "Via", "HTTP"]}}}}, "apis"=>{"name"=>"Clockwork", "x-slug"=>"clockwork", "description"=>"Clockwork is an Easy Text Message API. An SMS API for Developers. Build powerful apps and include SMS. Signup is free, Try it now.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1373-clockwork.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"643753", "tags"=>"API Provider,Bulk,Global,internet,Messages,Messages,Mobile,Profiles,Relative Data,SaaS,Service API,SMS,SMS,Stack Network,Target,Technology,Telecommunications,Telecommunications", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"clockwork/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Clockwork SMS", "x-api-slug"=>"clockwork-sms", "description"=>"The Clockwork SMS API access to an SMS gateway allowing users to send messages through an application. Clockwork is a service that allows for the sending of bulk SMS. The API uses RESTful, SOAP and SMPP protocol. Responses are formatted in XML.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1373-clockwork.jpg", "humanURL"=>"http://clockworksms.com", "baseURL"=>"http://api.clockworksms.com/http/", "tags"=>"API Provider,Bulk,Global,internet,Messages,Messages,Mobile,Profiles,Relative Data,SaaS,Service API,SMS,SMS,Stack Network,Target,Technology,Telecommunications,Telecommunications", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/clockwork/send-aspx-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/clockwork/clockwork-sms-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api.clockworksms.com"}, {"type"=>"x-blog", "url"=>"http://www.clockworksms.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"http://www.clockworksms.com/feed/"}, {"type"=>"x-contact-form", "url"=>"http://www.clockworksms.com/support/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/product/clockwork"}, {"type"=>"x-developer", "url"=>"http://www.clockworksms.com/doc/"}, {"type"=>"x-documentation", "url"=>"http://www.clockworksms.com/doc/easy-stuff/http-interface/send-sms/"}, {"type"=>"x-email", "url"=>"441234567980@YOURAPIKEY.clockworksms.com"}, {"type"=>"x-email", "url"=>"hello@clockworksms.com"}, {"type"=>"x-faq", "url"=>"http://www.clockworksms.com/faqs/"}, {"type"=>"x-pricing", "url"=>"http://www.clockworksms.com/pricing/"}, {"type"=>"x-selfservice-registration", "url"=>"https://app3.clockworksms.com/signup"}, {"type"=>"x-terms-of-service", "url"=>"http://www.clockworksms.com/terms-and-conditions/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/ClockworkSMS"}, {"type"=>"x-website", "url"=>"http://clockworksms.com"}, {"type"=>"x-website", "url"=>"http://www.clockworksms.com"}, {"type"=>"x-wordpress-plugin", "url"=>"http://wordpress.org/extend/plugins/contact-form-7-sms-addon/"}, {"type"=>"x-wordpress-plugin", "url"=>"http://wordpress.org/extend/plugins/booking-sms/"}, {"type"=>"x-zendesk", "url"=>"http://www.clockworksms.com/blog/sending-sms-from-zendesk/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
123formbuilder{"123formbuilder-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"123FormBuilder", "x-complete"=>1, "info"=>{"title"=>"", "version"=>"1.0.0"}, "host"=>"api.123contactform.com", "basePath"=>"/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/ping"=>{"get"=>{"summary"=>"Ping status", "description"=>"This indicates if our servers are up and running.", "operationId"=>"this-indicates-if-our-servers-are-up-and-running", "x-api-path-slug"=>"ping-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ping", "Status"]}}, "/token"=>{"post"=>{"summary"=>"User login", "description"=>"Allows you to authenticate users. \n\nRequired parameters:\n- username OR email\n- password OR passhash", "operationId"=>"allows-you-to-authenticate-users-required-parameters-username-or-email-password-or-passhash", "x-api-path-slug"=>"token-post", "parameters"=>[{"in"=>"query", "name"=>"email"}, {"in"=>"query", "name"=>"passhash", "description"=>"MD5 password"}, {"in"=>"query", "name"=>"password", "description"=>"Plain text password"}, {"in"=>"query", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Login"]}}, "/token/refresh"=>{"post"=>{"summary"=>"Refresh token", "description"=>"Refresh token", "operationId"=>"refresh-token", "x-api-path-slug"=>"tokenrefresh-post", "parameters"=>[{"in"=>"formData", "name"=>"JWT", "description"=>"JWT authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Refresh", "Token"]}}, "/token/invalidate"=>{"post"=>{"summary"=>"Invalidate token", "description"=>"Invalidate token", "operationId"=>"invalidate-token", "x-api-path-slug"=>"tokeninvalidate-post", "parameters"=>[{"in"=>"formData", "name"=>"JWT", "description"=>"JWT authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invalidate", "Token"]}}, "/forms"=>{"get"=>{"summary"=>"List forms", "description"=>"The forms endpoint returns information about the forms. The response includes submissions and other details about each form.", "operationId"=>"the-forms-endpoint-returns-information-about-the-forms-the-response-includes-submissions-and-other-d", "x-api-path-slug"=>"forms-get", "parameters"=>[{"in"=>"query", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"query", "name"=>"page", "description"=>"Page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of forms to get per page in a request"}, {"in"=>"query", "name"=>"search", "description"=>"Filter form name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Forms"]}, "post"=>{"summary"=>"Create a new form", "description"=>"Create a new form", "operationId"=>"create-a-new-form", "x-api-path-slug"=>"forms-post", "parameters"=>[{"in"=>"formData", "name"=>"active", "description"=>"Form activity status"}, {"in"=>"formData", "name"=>"active_date_from", "description"=>"If activity status is 1, this field is required"}, {"in"=>"formData", "name"=>"active_date_to", "description"=>"If activity status is 1, this field is required"}, {"in"=>"formData", "name"=>"active_days", "description"=>"If activity status is 4, this field is required"}, {"in"=>"formData", "name"=>"group_id", "description"=>"The ID of the group in which you want to create the form"}, {"in"=>"formData", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the new form"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Form"]}}, "/forms/bulk"=>{"delete"=>{"summary"=>"Delete multiple forms", "description"=>"Delete multiple forms", "operationId"=>"delete-multiple-forms", "x-api-path-slug"=>"formsbulk-delete", "parameters"=>[{"in"=>"formData", "name"=>"form_ids", "description"=>"The IDs of the forms separated by comma"}, {"in"=>"formData", "name"=>"JWT", "description"=>"JWT authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multiple", "Forms"]}}, "/forms/{form_id}"=>{"get"=>{"summary"=>"Get form details", "description"=>"Get the details of a single form", "operationId"=>"get-the-details-of-a-single-form", "x-api-path-slug"=>"formsform-id-get", "parameters"=>[{"in"=>"path", "name"=>"form_id", "description"=>"The ID of the form"}, {"in"=>"query", "name"=>"JWT", "description"=>"JWT authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Form", "Details"]}, "put"=>{"summary"=>"Update form details", "description"=>"Update form details", "operationId"=>"update-form-details", "x-api-path-slug"=>"formsform-id-put", "parameters"=>[{"in"=>"formData", "name"=>"active", "description"=>"Form activity status"}, {"in"=>"formData", "name"=>"active_date_from", "description"=>"If activity status is 1, this field is required"}, {"in"=>"formData", "name"=>"active_date_to", "description"=>"If activity status is 1, this field is required"}, {"in"=>"formData", "name"=>"active_days", "description"=>"If activity status is 4, this field is required"}, {"in"=>"path", "name"=>"form_id", "description"=>"The ID of the form"}, {"in"=>"formData", "name"=>"group_id", "description"=>"The ID of the group in which you want to create the form"}, {"in"=>"query", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"formData", "name"=>"name", "description"=>"Change the name of the form"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Form", "Details"]}, "delete"=>{"summary"=>"Delete a form", "description"=>"Delete a form", "operationId"=>"delete-a-form", "x-api-path-slug"=>"formsform-id-delete", "parameters"=>[{"in"=>"path", "name"=>"form_id", "description"=>"The ID of the form"}, {"in"=>"formData", "name"=>"JWT", "description"=>"JWT authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Form"]}}, "/forms/{form_id}/fields"=>{"get"=>{"summary"=>"Get form fields", "description"=>"Get the details of a single form and its fields", "operationId"=>"get-the-details-of-a-single-form-and-its-fields", "x-api-path-slug"=>"formsform-idfields-get", "parameters"=>[{"in"=>"path", "name"=>"form_id", "description"=>"The ID of the form"}, {"in"=>"query", "name"=>"JWT", "description"=>"JWT authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Form", "Fields"]}}, "/forms/{form_id}/submissions"=>{"get"=>{"summary"=>"Get submissions", "description"=>"Get all submissions received through a form", "operationId"=>"get-all-submissions-received-through-a-form", "x-api-path-slug"=>"formsform-idsubmissions-get", "parameters"=>[{"in"=>"path", "name"=>"form_id", "description"=>"The ID of the form"}, {"in"=>"query", "name"=>"include_recipients", "description"=>"Returns the recipient(s) who should receive the submissions"}, {"in"=>"query", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"query", "name"=>"page", "description"=>"Page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of submissions to get per page in a request"}, {"in"=>"query", "name"=>"start_date", "description"=>"List submissions starting with a specific date"}, {"in"=>"query", "name"=>"start_submission_id", "description"=>"List all submissions starting with the specified submission ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Submissions"]}}, "/forms/{form_id}/submissions/{submission_id}"=>{"get"=>{"summary"=>"Get submission details", "description"=>"Get the details of a single submission", "operationId"=>"get-the-details-of-a-single-submission", "x-api-path-slug"=>"formsform-idsubmissionssubmission-id-get", "parameters"=>[{"in"=>"path", "name"=>"form_id", "description"=>"The ID of the form"}, {"in"=>"query", "name"=>"include_recipients", "description"=>"Returns the recipient(s) who should receive the submission"}, {"in"=>"query", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"path", "name"=>"submission_id", "description"=>"The ID of the submission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Submission", "Details"]}, "put"=>{"summary"=>"Update Submission", "description"=>"Update Submission", "operationId"=>"update-submission", "x-api-path-slug"=>"formsform-idsubmissionssubmission-id-put", "parameters"=>[{"in"=>"query", "name"=>"approved", "description"=>"Approval status"}, {"in"=>"path", "name"=>"form_id", "description"=>"The ID of the form"}, {"in"=>"query", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"query", "name"=>"payed", "description"=>"Payment status"}, {"in"=>"path", "name"=>"submission_id", "description"=>"The ID of the submission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Submission"]}, "delete"=>{"summary"=>"Delete one form submission", "description"=>"Delete one form submission", "operationId"=>"delete-one-form-submission", "x-api-path-slug"=>"formsform-idsubmissionssubmission-id-delete", "parameters"=>[{"in"=>"path", "name"=>"form_id", "description"=>"The ID of the form"}, {"in"=>"query", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"path", "name"=>"submission_id", "description"=>"The ID of the submission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Form", "Submission"]}}, "/groups"=>{"get"=>{"summary"=>"Get all user groups", "description"=>"Get all user groups", "operationId"=>"get-all-user-groups", "x-api-path-slug"=>"groups-get", "parameters"=>[{"in"=>"query", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"query", "name"=>"page", "description"=>"Page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of groups to get per page in a request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Groups"]}, "post"=>{"summary"=>"Create a new group", "description"=>"Create a new group", "operationId"=>"create-a-new-group", "x-api-path-slug"=>"groups-post", "parameters"=>[{"in"=>"formData", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"formData", "name"=>"name", "description"=>"Form name"}, {"in"=>"formData", "name"=>"parent_id", "description"=>"Indicates the ID of the parent group"}, {"in"=>"formData", "name"=>"webhook_url", "description"=>"The URL of the WebHook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Group"]}}, "/groups/{group_id}"=>{"get"=>{"summary"=>"Get group details", "description"=>"Get information about a specific group.", "operationId"=>"get-information-about-a-specific-group", "x-api-path-slug"=>"groupsgroup-id-get", "parameters"=>[{"in"=>"path", "name"=>"group_id", "description"=>"The ID of the group"}, {"in"=>"query", "name"=>"JWT", "description"=>"JWT authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Details"]}, "put"=>{"summary"=>"Update group data", "description"=>"Updates the details of a group.", "operationId"=>"updates-the-details-of-a-group", "x-api-path-slug"=>"groupsgroup-id-put", "parameters"=>[{"in"=>"path", "name"=>"group_id", "description"=>"The ID of the group you want to edit"}, {"in"=>"formData", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"formData", "name"=>"name", "description"=>"This is required when the webhook_url or parent_id is missing"}, {"in"=>"formData", "name"=>"parent_id", "description"=>"Indicates the ID of the parent group"}, {"in"=>"formData", "name"=>"webhook_url", "description"=>"This is required when the name or parent_id is missing"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Data"]}}, "/groups/{group_id}/forms"=>{"get"=>{"summary"=>"Get all forms in a group", "description"=>"Displays a list of all of the forms within a specific group.", "operationId"=>"displays-a-list-of-all-of-the-forms-within-a-specific-group", "x-api-path-slug"=>"groupsgroup-idforms-get", "parameters"=>[{"in"=>"path", "name"=>"group_id", "description"=>"The ID of the group"}, {"in"=>"query", "name"=>"JWT", "description"=>"JWT authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forms", "In", "Group"]}}, "/groups/{group_id}/share"=>{"post"=>{"summary"=>"Share a group with a user", "description"=>"This may not be available for your account. It is specific to certain users.", "operationId"=>"this-may-not-be-available-for-your-account-it-is-specific-to-certain-users", "x-api-path-slug"=>"groupsgroup-idshare-post", "parameters"=>[{"in"=>"path", "name"=>"group_id", "description"=>"The ID of the group you want to share"}, {"in"=>"formData", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"formData", "name"=>"subuser_email", "description"=>"The username with whom you want to share this group"}, {"in"=>"formData", "name"=>"subuser_id", "description"=>"The ID of the user with whom you want to share this group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Share", "Group", "User"]}}, "/groups/{group_id}/unshare"=>{"post"=>{"summary"=>"Unshare a group from a user", "description"=>"This may not be available for your account. It is specific to certain users.", "operationId"=>"this-may-not-be-available-for-your-account-it-is-specific-to-certain-users", "x-api-path-slug"=>"groupsgroup-idunshare-post", "parameters"=>[{"in"=>"path", "name"=>"group_id", "description"=>"The ID of the group you want to unshare"}, {"in"=>"formData", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"formData", "name"=>"subuser_email", "description"=>"The username from whom you want to unshare the group"}, {"in"=>"formData", "name"=>"subuser_id", "description"=>"The ID of the subuser from whom you want to unshare the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unshare", "Group", "From", "User"]}}, "/users"=>{"get"=>{"summary"=>"Get info about master user and subusers", "description"=>"Get info about master user and subusers", "operationId"=>"get-info-about-master-user-and-subusers", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"query", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"query", "name"=>"page", "description"=>"Page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of groups to get per page in a request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Info", "About", "Master", "User", "Subusers"]}, "post"=>{"summary"=>"Create a new subuser", "description"=>"Create a new subuser", "operationId"=>"create-a-new-subuser", "x-api-path-slug"=>"users-post", "parameters"=>[{"in"=>"formData", "name"=>"admin", "description"=>"Indicates if the subuser is admin or not"}, {"in"=>"formData", "name"=>"allow_create_form", "description"=>"Allow or restrict subuser access to creating new forms"}, {"in"=>"formData", "name"=>"allow_delete_form", "description"=>"Allow subusers to delete forms"}, {"in"=>"formData", "name"=>"allow_duplicate_form", "description"=>"Allow subusers to duplicate forms"}, {"in"=>"formData", "name"=>"can_manage_groups", "description"=>"Allow admin subusers to manage groups"}, {"in"=>"formData", "name"=>"can_manage_users", "description"=>"Allow admin subusers to manage users"}, {"in"=>"formData", "name"=>"company_name", "description"=>"The name of the company to which the subuser belongs"}, {"in"=>"formData", "name"=>"email", "description"=>"Email address of the account"}, {"in"=>"formData", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"formData", "name"=>"name", "description"=>"Username of the account"}, {"in"=>"formData", "name"=>"passhash", "description"=>"MD5 password"}, {"in"=>"formData", "name"=>"password", "description"=>"Plain text password"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Subuser"]}}, "/users/{identifier}"=>{"put"=>{"summary"=>"Update user", "description"=>"Update user information", "operationId"=>"update-user-information", "x-api-path-slug"=>"usersidentifier-put", "parameters"=>[{"in"=>"formData", "name"=>"admin", "description"=>"Indicates if the subuser is admin or not"}, {"in"=>"formData", "name"=>"allow_create_form", "description"=>"Allow or restrict subuser access to creating new forms"}, {"in"=>"formData", "name"=>"allow_delete_form", "description"=>"Allow subusers to delete forms"}, {"in"=>"formData", "name"=>"allow_duplicate_form", "description"=>"Allow subusers to duplicate forms"}, {"in"=>"formData", "name"=>"can_manage_groups", "description"=>"Allow admin subusers to manage groups"}, {"in"=>"formData", "name"=>"can_manage_users", "description"=>"Allow admin subusers to manage users"}, {"in"=>"formData", "name"=>"company_name", "description"=>"The name of the company to which the subuser belongs"}, {"in"=>"formData", "name"=>"email", "description"=>"Email address of the account"}, {"in"=>"path", "name"=>"identifier", "description"=>"The ID or username of the user to be modified"}, {"in"=>"formData", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"formData", "name"=>"passhash", "description"=>"MD5 password"}, {"in"=>"formData", "name"=>"password", "description"=>"Plain text password"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/accounts"=>{"post"=>{"summary"=>"Create new account", "description"=>"Creates a new account (standalone user). This is available only upon request.", "operationId"=>"creates-a-new-account-standalone-user-this-is-available-only-upon-request", "x-api-path-slug"=>"accounts-post", "parameters"=>[{"in"=>"formData", "name"=>"company_name", "description"=>"The company name associated with the account"}, {"in"=>"formData", "name"=>"email", "description"=>"The email address associated with the account"}, {"in"=>"formData", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"formData", "name"=>"name", "description"=>"The username associated with the account"}, {"in"=>"formData", "name"=>"password", "description"=>"The password associated with the account"}, {"in"=>"formData", "name"=>"password_repeat", "description"=>"Password repeat"}, {"in"=>"formData", "name"=>"plan", "description"=>"The service plan of the account: 0 - Free (default value), 1 - Gold, 2 - Platinum, 3 - Diamond"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Account"]}}, "/accounts/{user_id}"=>{"put"=>{"summary"=>"Update account", "description"=>"Updates an account. You can only update the users that you have created using your account token.", "operationId"=>"updates-an-account-you-can-only-update-the-users-that-you-have-created-using-your-account-token", "x-api-path-slug"=>"accountsuser-id-put", "parameters"=>[{"in"=>"formData", "name"=>"company_name", "description"=>"The company name associated with the account"}, {"in"=>"formData", "name"=>"email", "description"=>"The email address associated with the account"}, {"in"=>"formData", "name"=>"JWT", "description"=>"JWT authentication token"}, {"in"=>"formData", "name"=>"password", "description"=>"The password associated with the account"}, {"in"=>"formData", "name"=>"password_repeat", "description"=>"Password repeat"}, {"in"=>"formData", "name"=>"plan", "description"=>"The service plan of the account: 0 - Free (default value), 1 - Gold, 2 - Platinum, 3 - Diamond"}, {"in"=>"path", "name"=>"user_id", "description"=>"The ID of the account that you want to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}}}, "apis"=>{"name"=>"123FormBuilder", "x-slug"=>"123formbuilder", "description"=>"Create free web forms for your website within minutes, build complex workflows, sell online and more. With the simple drag & drop interface, building an online form, survey, poll or quiz is a breeze. Sign up for free to get started!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1638-123contactform.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"24419", "tags"=>"API Provider,Forms,internet,Profiles,Relative Data,SaaS,Surveys,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"123formbuilder/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"123FormBuilder", "x-api-slug"=>"123formbuilder", "description"=>"Create free web forms for your website within minutes, build complex workflows, sell online and more. With the simple drag & drop interface, building an online form, survey, poll or quiz is a breeze. Sign up for free to get started!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1638-123contactform.jpg", "humanURL"=>"http://www.123formbuilder.com", "baseURL"=>"https://api.123contactform.com//v2", "tags"=>"API Provider,Forms,internet,Profiles,Relative Data,SaaS,Surveys,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/123formbuilder/accountsuser-id-put-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/123formbuilder/123formbuilder-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-api-json--authoritative", "url"=>"http://apis.io/apisdef/legacy/123contactform.json"}, {"type"=>"x-website", "url"=>"http://www.123formbuilder.com"}, {"type"=>"x-blog", "url"=>"http://blog.123contactform.com/"}, {"type"=>"x-blog-rss", "url"=>"http://feeds.feedburner.com/123contactformBlog"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/123contactform"}, {"type"=>"x-github", "url"=>"https://github.com/123contactform"}, {"type"=>"x-openapi", "url"=>"https://developer.123formbuilder.com/swagger/swagger_www.json"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/123formbuilder"}, {"type"=>"x-webhook", "url"=>"https://www.123formbuilder.com/docs/webhooks/"}, {"type"=>"x-website", "url"=>"https://www.123formbuilder.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
system-award-management{"system-award-management-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"System Award Management", "x-complete"=>1, "info"=>{"title"=>"System Award Management API", "description"=>"sam-gov-is-the-system-for-award-management--it-is-the-site-on-which-all-vendors-grantees-receivers-of-federal-financial-assistance-and-other-entities-doing-business-with-the-government-must-register-prior-to-receiving-an-award---the-registrations-api-currently-provides-the-publicly-available-data-for-a-specific-entity-along-with-status-and-progress-information-for-that-registration-", "version"=>"1.0.0"}, "host"=>"api.data.gov", "basePath"=>"/sam/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/registrations/{registrationId}"=>{"get"=>{"summary"=>"Find a registration by its DUN+4 number", "description"=>"If the entity only has a 9-digit DUNS number, pad the end to include 4 zeros", "operationId"=>"getData", "x-api-path-slug"=>"registrationsregistrationid-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"An API Key from api", "type"=>"string"}, {"in"=>"path", "name"=>"registrationId", "description"=>"DUNS+4 number (no - sign) of the registration to be fetched", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"System Award Management", "x-slug"=>"system-award-management", "description"=>"The SAM API is a RESTful method of retrieving public information about the businesses or individuals (referred to as “entities”) within the SAM data set. The entities publicly available data set can currently be retrieved on an entity-by-entity basis.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/53aa67a8-caec-11e3-9248-37414d200130.gif", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"Federal Government GSA,General Data,Government,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"system-award-management/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"System Award Management API", "x-api-slug"=>"system-award-management-api", "description"=>"The SAM API is a RESTful method of retrieving public information about the businesses or individuals (referred to as “entities”) within the SAM data set. The entities publicly available data set can currently be retrieved on an entity-by-entity basis.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/53aa67a8-caec-11e3-9248-37414d200130.gif", "humanURL"=>"http://gsa.github.io/sam_api/sam/", "baseURL"=>"https://api.data.gov//sam/v1", "tags"=>"Federal Government GSA,General Data,Government,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/system-award-management/registrationsregistrationid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/system-award-management/system-award-management-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://gsa.github.io/sam_api/sam/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-traffic-manager{"azure-traffic-manager-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Traffic Manager", "x-complete"=>1, "info"=>{"title"=>"TrafficManagerManagementClient", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}"=>{"patch"=>{"summary"=>"Endpoints Update", "description"=>"Update a Traffic Manager endpoint.", "operationId"=>"Endpoints_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networktrafficmanagerprofilesprofilenameendpointtypeendpointname-patch", "parameters"=>[{"in"=>"path", "name"=>"endpointName", "description"=>"The name of the Traffic Manager endpoint to be updated"}, {"in"=>"path", "name"=>"endpointType", "description"=>"The type of the Traffic Manager endpoint to be updated"}, {"in"=>"body", "name"=>"parameters", "description"=>"The Traffic Manager endpoint parameters supplied to the Update operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileName", "description"=>"The name of the Traffic Manager profile"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the Traffic Manager endpoint to be updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoints"]}, "get"=>{"summary"=>"Endpoints Get", "description"=>"Gets a Traffic Manager endpoint.", "operationId"=>"Endpoints_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networktrafficmanagerprofilesprofilenameendpointtypeendpointname-get", "parameters"=>[{"in"=>"path", "name"=>"endpointName", "description"=>"The name of the Traffic Manager endpoint"}, {"in"=>"path", "name"=>"endpointType", "description"=>"The type of the Traffic Manager endpoint"}, {"in"=>"path", "name"=>"profileName", "description"=>"The name of the Traffic Manager profile"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the Traffic Manager endpoint"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoints"]}, "put"=>{"summary"=>"Endpoints Create Or Update", "description"=>"Create or update a Traffic Manager endpoint.", "operationId"=>"Endpoints_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networktrafficmanagerprofilesprofilenameendpointtypeendpointname-put", "parameters"=>[{"in"=>"path", "name"=>"endpointName", "description"=>"The name of the Traffic Manager endpoint to be created or updated"}, {"in"=>"path", "name"=>"endpointType", "description"=>"The type of the Traffic Manager endpoint to be created or updated"}, {"in"=>"body", "name"=>"parameters", "description"=>"The Traffic Manager endpoint parameters supplied to the CreateOrUpdate operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileName", "description"=>"The name of the Traffic Manager profile"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the Traffic Manager endpoint to be created or updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoints"]}, "delete"=>{"summary"=>"Endpoints Delete", "description"=>"Deletes a Traffic Manager endpoint.", "operationId"=>"Endpoints_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networktrafficmanagerprofilesprofilenameendpointtypeendpointname-delete", "parameters"=>[{"in"=>"path", "name"=>"endpointName", "description"=>"The name of the Traffic Manager endpoint to be deleted"}, {"in"=>"path", "name"=>"endpointType", "description"=>"The type of the Traffic Manager endpoint to be deleted"}, {"in"=>"path", "name"=>"profileName", "description"=>"The name of the Traffic Manager profile"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the Traffic Manager endpoint to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoints"]}}, "/providers/Microsoft.Network/checkTrafficManagerNameAvailability"=>{"post"=>{"summary"=>"Profiles Check Traffic Manager Relative Dns Name Availability", "description"=>"Checks the availability of a Traffic Manager Relative DNS name.", "operationId"=>"Profiles_CheckTrafficManagerRelativeDnsNameAvailability", "x-api-path-slug"=>"providersmicrosoft-networkchecktrafficmanagernameavailability-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The Traffic Manager name parameters supplied to the CheckTrafficManagerNameAvailability operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profiles Traffic Manager Relative Dns Name Availability"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles"=>{"get"=>{"summary"=>"Profiles List By In Resource Group", "description"=>"Lists all Traffic Manager profiles within a resource group.", "operationId"=>"Profiles_ListByInResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networktrafficmanagerprofiles-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the Traffic Manager profiles to be listed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profiles"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficmanagerprofiles"=>{"get"=>{"summary"=>"Profiles List All", "description"=>"Lists all Traffic Manager profiles within a subscription.", "operationId"=>"Profiles_ListAll", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networktrafficmanagerprofiles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profiles"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}"=>{"get"=>{"summary"=>"Profiles Get", "description"=>"Gets a Traffic Manager profile.", "operationId"=>"Profiles_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networktrafficmanagerprofilesprofilename-get", "parameters"=>[{"in"=>"path", "name"=>"profileName", "description"=>"The name of the Traffic Manager profile"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the Traffic Manager profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profiles"]}, "put"=>{"summary"=>"Profiles Create Or Update", "description"=>"Create or update a Traffic Manager profile.", "operationId"=>"Profiles_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networktrafficmanagerprofilesprofilename-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The Traffic Manager profile parameters supplied to the CreateOrUpdate operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileName", "description"=>"The name of the Traffic Manager profile"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the Traffic Manager profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profiles"]}, "delete"=>{"summary"=>"Profiles Delete", "description"=>"Deletes a Traffic Manager profile.", "operationId"=>"Profiles_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networktrafficmanagerprofilesprofilename-delete", "parameters"=>[{"in"=>"path", "name"=>"profileName", "description"=>"The name of the Traffic Manager profile to be deleted"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the Traffic Manager profile to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profiles"]}, "patch"=>{"summary"=>"Profiles Update", "description"=>"Update a Traffic Manager profile.", "operationId"=>"Profiles_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networktrafficmanagerprofilesprofilename-patch", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The Traffic Manager profile parameters supplied to the Update operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileName", "description"=>"The name of the Traffic Manager profile"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the Traffic Manager profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profiles"]}}, "/providers/Microsoft.Network/trafficManagerGeographicHierarchies/default"=>{"get"=>{"summary"=>"Geographic Hierarchies Get Default", "description"=>"Gets the default Geographic Hierarchy used by the Geographic traffic routing method.", "operationId"=>"GeographicHierarchies_GetDefault", "x-api-path-slug"=>"providersmicrosoft-networktrafficmanagergeographichierarchiesdefault-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Geographic Hierarchies"]}}}}, "apis"=>{"name"=>"Azure Traffic Manager", "x-slug"=>"azure-traffic-manager", "description"=>"Azure Traffic Manager gives you three methods for traffic routing: failover, performance, or weighted round-robin. Choose the one that’s right for your application or scenario.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-traffic-improved-application-performance.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Analysis,API Provider,API Service Provider,Microsoft,Profiles,Relative Data,Service API,Stack Network,Traffic", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-traffic-manager/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Traffic Manager API", "x-api-slug"=>"azure-traffic-manager-api", "description"=>"Azure Traffic Manager gives you three methods for traffic routing: failover, performance, or weighted round-robin. Choose the one that’s right for your application or scenario.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-traffic-improved-application-performance.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/traffic-manager/", "baseURL"=>"://management.azure.com//", "tags"=>"Analysis,API Provider,API Service Provider,Microsoft,Profiles,Relative Data,Service API,Stack Network,Traffic", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-traffic-manager/providersmicrosoft-networktrafficmanagergeographichierarchiesdefault-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-traffic-manager/azure-traffic-manager-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/traffic-manager/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/traffic-manager/"}, {"type"=>"x-service-level-agreement", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/traffic-manager/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/traffic-manager/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fullcontact{"fullcontact-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"FullContact", "x-complete"=>1, "info"=>{"title"=>"FullContact Location API", "description"=>"the-api-for-managing-fullcontact-locations", "termsOfService"=>"https://www.fullcontact.com/terms/", "version"=>"1.0.0"}, "host"=>"api.fullcontact.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/batch.json"=>{"get"=>{"summary"=>"Batch Process", "description"=>"Batch Process", "operationId"=>"batchProcess", "x-api-path-slug"=>"batch-json-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"This API key is assigned to you by FullContact"}, {"in"=>"body", "name"=>"Body", "description"=>"{ requests : [ https://api", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch"]}}, "/stats.json"=>{"get"=>{"summary"=>"Get Account Stats", "description"=>"Get Account Stats", "operationId"=>"getAccountStats", "x-api-path-slug"=>"stats-json-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"This API key is assigned to you by FullContact"}, {"in"=>"query", "name"=>"period", "description"=>"You can define the month that you want to see usage stats for by using the period parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Statistics"]}}, "/email/disposable.json"=>{"get"=>{"summary"=>"Lookup Email", "description"=>"Lookup Email", "operationId"=>"lookupEmail", "x-api-path-slug"=>"emaildisposable-json-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"This API key is assigned to you by FullContact"}, {"in"=>"query", "name"=>"email", "description"=>"The email address that should be queried for being a disposable email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Emails"]}}, "/company/lookup.json"=>{"get"=>{"summary"=>"Get Company", "description"=>"Get Company", "operationId"=>"getCompany", "x-api-path-slug"=>"companylookup-json-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"This API key is assigned to you by FullContact"}, {"in"=>"query", "name"=>"callback", "description"=>"If specified, the response will be wrapped as JSONP in a function call"}, {"in"=>"query", "name"=>"domain", "description"=>"The domain of the company being looked up"}, {"in"=>"query", "name"=>"keyPeople", "description"=>"If true, a list of Executive and VP level employees at this company will be returned under the keyPeople field"}, {"in"=>"query", "name"=>"prettyPrint", "description"=>"The prettyPrint parameter can be used to disable prettyprint formatting on the API response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies"]}}, "/icon"=>{"get"=>{"summary"=>"Get Icons", "description"=>"Get Icons", "operationId"=>"getIcons", "x-api-path-slug"=>"icon-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"This API key is assigned to you by FullContact"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Icons"]}}, "/icon/{typeId}/{size}/{style}"=>{"get"=>{"summary"=>"Get Icon", "description"=>"Get Icon", "operationId"=>"getIcon", "x-api-path-slug"=>"icontypeidsizestyle-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"This API key is assigned to you by FullContact"}, {"in"=>"path", "name"=>"size", "description"=>"The size parameter allows you to specify the size of icon that you want"}, {"in"=>"path", "name"=>"style", "description"=>"The style parameter allows you to pick from the available styles of the icons"}, {"in"=>"path", "name"=>"typeId", "description"=>"The typeId is the name of the icon you want"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Icons"]}}, "/v2/person.json"=>{"get"=>{"summary"=>"", "description"=>"Find out more about a person", "operationId"=>"-v2-person", "x-api-path-slug"=>"v2person-json-get", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"The email address you wish to query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People"]}}, "/cardReader"=>{"get"=>{"summary"=>"Read Card", "description"=>"Read Card", "operationId"=>"readCard", "x-api-path-slug"=>"cardreader-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"This API key is assigned to you by FullContact"}, {"in"=>"query", "name"=>"casing", "description"=>"Card Reader can alter the casing of certain fields in the final results"}, {"in"=>"query", "name"=>"Custom Params", "description"=>"Card Reader has the ability to funnel your own custom params through requests"}, {"in"=>"query", "name"=>"format", "description"=>"Used to specify response in json"}, {"in"=>"body", "name"=>"requestBody", "description"=>"You can either send in the files as a multipart/form-data request or as a JSON object with BASE64 encoded images", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"returnedData", "description"=>"A response can contain verified and unverified data, this parameter can be used to exclude unverified data from being returned in the response"}, {"in"=>"query", "name"=>"sandbox", "description"=>"Card Reader Sandbox is a free, quick response mode for testing and development"}, {"in"=>"query", "name"=>"URID", "description"=>"URID stands for Unique Request Identifier"}, {"in"=>"query", "name"=>"verified", "description"=>"Used to specify the quality of transcription"}, {"in"=>"query", "name"=>"webhookUrl", "description"=>"This is the URL that a request will be made to once the card has been processed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Card Reader"]}}, "/name/normalizer.json"=>{"get"=>{"summary"=>"Name Normalization", "description"=>"The Name Normalization method takes quasi-structured name data provided as a string and outputs the data in a structured manner. It also returns a likelihood based only on the order of the given name and family name as seen in the US population.", "operationId"=>"normalizeName", "x-api-path-slug"=>"namenormalizer-json-get", "parameters"=>[{"in"=>"query", "name"=>"casing", "description"=>"Uppercase, lowercase, title case"}, {"in"=>"query", "name"=>"q", "description"=>"The q parameter allows you to pass a quasi-structured full name string which can include standard prefix, first name, nickname, middle name, last name and suffix"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Name", "Normalizers"]}}, "/address/locationNormalizer.json"=>{"get"=>{"summary"=>"Location Normalization", "description"=>"The Location Normalization method takes semi-structured location data via the place parameter, provided as a string, and returns structured location data in either JSON or XML format.", "operationId"=>"normalizeLocation", "x-api-path-slug"=>"addresslocationnormalizer-json-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"This API key is assigned to you by FullContact"}, {"in"=>"query", "name"=>"casing", "description"=>"Uppercase, lowercase, title case"}, {"in"=>"query", "name"=>"includeZeroPopulation", "description"=>"Appending includeZeroPopulation=true, will display 0 population census locations"}, {"in"=>"query", "name"=>"place", "description"=>"The place parameter allows you to pass a semi-structured location string which can include continent, country, state, city, or county"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "Locations"]}}}}, "apis"=>{"name"=>"FullContact", "x-slug"=>"fullcontact", "description"=>"Build a clearer picture of your customers in minutes with our data-focused APIs. Manage your personal or teams contacts with our contact apps.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/205-fullcontact.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"49636", "tags"=>"Addresses,API LIfeyclessss,API Provider,API Service Provider,Append,Business,Business Card,Contacts,Contacts,Contacts,Contacts,CRM,Enrichment,Enterprise,My API Stack,Office,Phones,Profiles,Relative Data,SaaS,Service API,Social,Social,Stack Network,Target", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"fullcontact/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"FullContact", "x-api-slug"=>"fullcontact", "description"=>"Build a clearer picture of your customers in minutes with our data-focused APIs. Manage your personal or teams contacts with our contact apps.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/205-fullcontact.jpg", "humanURL"=>"http://fullcontact.com", "baseURL"=>"https://api.fullcontact.com//", "tags"=>"Addresses,API LIfeyclessss,API Provider,API Service Provider,Append,Business,Business Card,Contacts,Contacts,Contacts,Contacts,CRM,Enrichment,Enterprise,My API Stack,Office,Phones,Profiles,Relative Data,SaaS,Service API,Social,Social,Stack Network,Target", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/fullcontact/fullcontact-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.fullcontact.com"}, {"type"=>"x-blog", "url"=>"http://fullcontact.com/blog"}, {"type"=>"x-blog-rss", "url"=>"http://www.fullcontact.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/fullcontact"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/fullcontact"}, {"type"=>"x-developer", "url"=>"http://www.fullcontact.com/developer"}, {"type"=>"x-email", "url"=>"Compliance@FullContact.com"}, {"type"=>"x-email", "url"=>"Privacy@fullcontact.com"}, {"type"=>"x-github", "url"=>"https://github.com/fullcontact"}, {"type"=>"x-pricing", "url"=>"https://www.fullcontact.com/apps/pricing/"}, {"type"=>"x-privacy", "url"=>"https://www.fullcontact.com/privacy/"}, {"type"=>"x-support", "url"=>"https://support.fullcontact.com/"}, {"type"=>"x-terms-of-service", "url"=>"https://www.fullcontact.com/terms/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/FullContactAPI"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/FullContact"}, {"type"=>"x-website", "url"=>"http://fullcontact.com"}, {"type"=>"x-website", "url"=>"http://www.fullcontact.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ehrscape{"ehr-scape-clinical-decision-support-apis-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EhrScape", "x-complete"=>1, "info"=>{"title"=>"Ehr Scape Clinical Decision Support APIs", "description"=>"lightweight-cds-services-to-support-execution-of-clinical-guidelines", "version"=>"1.0.0"}, "host"=>"rest.ehrscape.com", "basePath"=>"/ThinkCDS/services/CDSResources", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/guide"=>{"get"=>{"summary"=>"List available guides.", "description"=>"List available guides..", "operationId"=>"getGuides", "x-api-path-slug"=>"guide-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guide"]}}, "/guide/execute/{guideId}/{ehrIds}"=>{"get"=>{"summary"=>"Execute guide on given EHR IDs", "description"=>"Execute guide on given ehr ids.", "operationId"=>"executeGuide", "x-api-path-slug"=>"guideexecuteguideidehrids-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"ThinkEhr credentials as HTTP Basic Authorization"}, {"in"=>"header", "name"=>"Ehr-Session", "description"=>"Active Ehr Session token"}, {"in"=>"path", "name"=>"ehrIds", "description"=>"Comma separated list of EHR ids, * for all"}, {"in"=>"path", "name"=>"guideId", "description"=>"Guide ID"}, {"in"=>"query", "name"=>"persist", "description"=>"Should save result of execution into EHR?"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guide", "Execute", "GuideId", "EhrIds"]}}, "/guide/upload"=>{"post"=>{"summary"=>"Uploads new guide definition.", "description"=>"Uploads new guide definition..", "operationId"=>"uploadGuide", "x-api-path-slug"=>"guideupload-post", "parameters"=>[{"in"=>"form", "name"=>"guide", "description"=>"Base64 encoded guide definition"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guide", "Upload"]}}, "/guide/{guideId}"=>{"delete"=>{"summary"=>"Deletes guide.", "description"=>"Deletes guide..", "operationId"=>"deleteGuide", "x-api-path-slug"=>"guideguideid-delete", "parameters"=>[{"in"=>"path", "name"=>"guideId", "description"=>"Guide ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guide", "GuideId"]}}, "/guide/{guideId}/gdl"=>{"get"=>{"summary"=>"Returns guide definition.", "description"=>"Returns guide definition..", "operationId"=>"getGuideGDL", "x-api-path-slug"=>"guideguideidgdl-get", "parameters"=>[{"in"=>"path", "name"=>"guideId", "description"=>"Guide ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guide", "GuideId", "Gdl"]}}, "/guide/{guideId}/toggleGuidePersistence"=>{"put"=>{"summary"=>"Toggles default behaviour of persisting guide execution result.", "description"=>"Toggles default behaviour of persisting guide execution result..", "operationId"=>"toggleGuidePersistence", "x-api-path-slug"=>"guideguideidtoggleguidepersistence-put", "parameters"=>[{"in"=>"path", "name"=>"guideId", "description"=>"Guide ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guide", "GuideId", "ToggleGuidePersistence"]}}}}, "ehr-scape-electronic-health-record-apis-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EhrScape", "x-complete"=>1, "info"=>{"title"=>"Ehr Scape Electronic Health Record APIs", "description"=>"a-simple-yet-powerful-services-to-store-retrieve-and-query-health-data", "version"=>"1.0.0"}, "host"=>"rest.ehrscape.com", "basePath"=>"/rest/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/composition"=>{"post"=>{"summary"=>"Creates a new OpenEhr composition.", "description"=>"Creates a new openehr composition..", "operationId"=>"createComposition", "x-api-path-slug"=>"composition-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The composition to create, in one of the supported formats", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"committerId", "description"=>"The external id of the committer user"}, {"in"=>"query", "name"=>"committerName", "description"=>"The name of the committer user"}, {"in"=>"query", "name"=>"ehrId", "description"=>"The EHR id to save the composition into"}, {"in"=>"query", "name"=>"format", "description"=>"The format of the composition"}, {"in"=>"query", "name"=>"templateId", "description"=>"OpenEhr template id for the composition"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Composition"]}}, "/composition/{uid}"=>{"delete"=>{"summary"=>"Deletes an existing OpenEhr composition.", "description"=>"Deletes an existing openehr composition..", "operationId"=>"deleteComposition", "x-api-path-slug"=>"compositionuid-delete", "parameters"=>[{"in"=>"query", "name"=>"committerId", "description"=>"The external id of the committer user"}, {"in"=>"query", "name"=>"committerName", "description"=>"The name of the committer user"}, {"in"=>"path", "name"=>"uid", "description"=>"Composition UID to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Composition", "Uid"]}, "get"=>{"summary"=>"Loads an OpenEhr composition.", "description"=>"Loads an openehr composition..", "operationId"=>"getComposition", "x-api-path-slug"=>"compositionuid-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The format of the composition"}, {"in"=>"path", "name"=>"uid", "description"=>"The unique ID of the composition, with or without the domain and version part"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Composition", "Uid"]}, "put"=>{"summary"=>"Updates an existing OpenEhr composition.", "description"=>"Updates an existing openehr composition..", "operationId"=>"updateComposition", "x-api-path-slug"=>"compositionuid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The composition to create, in one of the supported formats", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"committerId", "description"=>"The external id of the committer user"}, {"in"=>"query", "name"=>"committerName", "description"=>"The name of the committer user"}, {"in"=>"query", "name"=>"format", "description"=>"The format of the composition"}, {"in"=>"query", "name"=>"templateId", "description"=>"OpenEhr template id for the composition"}, {"in"=>"path", "name"=>"uid", "description"=>"UID of an existing composition to be updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Composition", "Uid"]}}, "/demographics/ehr/{ehrId}/party"=>{"get"=>{"summary"=>"Retrieves the demographics info for the specified party.", "description"=>"Retrieves the demographics info for the specified party..", "operationId"=>"getPartyByEhrId", "x-api-path-slug"=>"demographicsehrehridparty-get", "parameters"=>[{"in"=>"path", "name"=>"ehrId", "description"=>"EHR ID of the party to retrieve"}, {"in"=>"query", "name"=>"when", "description"=>"The instant of time for which to return the information about the party in the ISO-8601 format (2014-03-03T15:05:43"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Demographics", "Ehr", "EhrId", "Party"]}}, "/demographics/party"=>{"post"=>{"summary"=>"Creates a new party record in the remote demographics store.", "description"=>"Creates a new party record in the remote demographics store..", "operationId"=>"addParty", "x-api-path-slug"=>"demographicsparty-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The party to create in whatever format the demographics service supports", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Demographics", "Party"]}, "put"=>{"summary"=>"Updates a party record in the remote demographics store.", "description"=>"Updates a party record in the remote demographics store..", "operationId"=>"updateParty", "x-api-path-slug"=>"demographicsparty-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The party to update", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Demographics", "Party"]}}, "/demographics/party/query"=>{"get"=>{"summary"=>"Queries the demographics store for matching parties, with the query parameters specified in the URL.", "description"=>"Queries the demographics store for matching parties, with the query parameters specified in the url..", "operationId"=>"queryParties", "x-api-path-slug"=>"demographicspartyquery-get", "parameters"=>[{"in"=>"query", "name"=>"maxHits", "description"=>"Limit the query results to this many hits"}, {"in"=>"query", "name"=>"parameters", "description"=>"Query parameters in the key1=value1&key2=value2 format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Demographics", "Party", "Query"]}, "post"=>{"summary"=>"Queries the demographics store for matching parties.", "description"=>"Queries the demographics store for matching parties..", "operationId"=>"queryParties", "x-api-path-slug"=>"demographicspartyquery-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An array of key-value query criteria", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"maxHits", "description"=>"Limit the query results to this many hits"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Demographics", "Party", "Query"]}}, "/demographics/party/{partyId}"=>{"delete"=>{"summary"=>"Deletes a party record from the remote demographics store.", "description"=>"Deletes a party record from the remote demographics store..", "operationId"=>"deleteParty", "x-api-path-slug"=>"demographicspartypartyid-delete", "parameters"=>[{"in"=>"path", "name"=>"partyId", "description"=>"The id of the party to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Demographics", "Party", "PartyId"]}, "get"=>{"summary"=>"Retrieves the demographics info for the specified party.", "description"=>"Retrieves the demographics info for the specified party..", "operationId"=>"getParty", "x-api-path-slug"=>"demographicspartypartyid-get", "parameters"=>[{"in"=>"path", "name"=>"partyId", "description"=>"The external ID of the party to retrieve"}, {"in"=>"query", "name"=>"when", "description"=>"The instant of time for which to return the information about the party in the ISO-8601 format (2014-03-03T15:05:43"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Demographics", "Party", "PartyId"]}}, "/ehr"=>{"get"=>{"summary"=>"Returns the EHR for the specified subject ID and namespace.", "description"=>"Returns the ehr for the specified subject id and namespace..", "operationId"=>"getEhr", "x-api-path-slug"=>"ehr-get", "parameters"=>[{"in"=>"query", "name"=>"subjectId", "description"=>"The subject ID whose EHR needs to be located"}, {"in"=>"query", "name"=>"subjectNamespace", "description"=>"The namespace that the subject belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ehr"]}, "post"=>{"summary"=>"Creates a new EHR.", "description"=>"Creates a new ehr..", "operationId"=>"createEhr", "x-api-path-slug"=>"ehr-post", "parameters"=>[{"in"=>"query", "name"=>"committerName", "description"=>"The name of the committer user"}, {"in"=>"query", "name"=>"subjectId", "description"=>"The external ID of the user who will own this EHR"}, {"in"=>"query", "name"=>"subjectNamespace", "description"=>"The namespace the subjectId belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ehr"]}}, "/ehr/status/{ehrId}"=>{"put"=>{"summary"=>"Update EHR_STATUS of an EHR.", "description"=>"Update ehr_status of an ehr..", "operationId"=>"updateEhrStatus", "x-api-path-slug"=>"ehrstatusehrid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"EHR status", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"ehrId", "description"=>"EHR ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ehr", "Status", "EhrId"]}}, "/ehr/{ehrId}"=>{"get"=>{"summary"=>"Returns information about the specified EHR.", "description"=>"Returns information about the specified ehr..", "operationId"=>"getEhr", "x-api-path-slug"=>"ehrehrid-get", "parameters"=>[{"in"=>"path", "name"=>"ehrId", "description"=>"The ID of the EHR to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ehr", "EhrId"]}}, "/form"=>{"get"=>{"summary"=>"Lists Think!Ehr forms.", "description"=>"Lists think!ehr forms..", "operationId"=>"getForms", "x-api-path-slug"=>"form-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Form"]}}, "/form/{name}/{version}"=>{"get"=>{"summary"=>"Loads a Think!Ehr form.", "description"=>"Loads a think!ehr form..", "operationId"=>"getForm", "x-api-path-slug"=>"formnameversion-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the form"}, {"in"=>"query", "name"=>"resources", "description"=>"Which, if any, resources to expand"}, {"in"=>"path", "name"=>"version", "description"=>"The version of the form, such as 1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Form", "Name", "Version"]}}, "/form/{name}/{version}/resource/{resource}"=>{"get"=>{"summary"=>"Loads a Think!Ehr form resource content.", "description"=>"Loads a think!ehr form resource content..", "operationId"=>"getFormResource", "x-api-path-slug"=>"formnameversionresourceresource-get", "parameters"=>[{"in"=>"query", "name"=>"envelope", "description"=>"Whether or not to wrap a response in a JSON object that includes meta-data, or just return the resource content (default)"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the form"}, {"in"=>"path", "name"=>"resource", "description"=>"The name of the form resource"}, {"in"=>"path", "name"=>"version", "description"=>"The version of the form, such as 1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Form", "Name", "Version", "Resource", "Resource"]}}, "/import/csv"=>{"post"=>{"summary"=>"Import CSV data.", "description"=>"Import csv data..", "operationId"=>"importData", "x-api-path-slug"=>"importcsv-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"committerName", "description"=>"Committer name (if not specified username is used instead)"}, {"in"=>"query", "name"=>"composerName", "description"=>"Composer name (if not specified username is used instead)"}, {"in"=>"query", "name"=>"converterLocale", "description"=>"Converter locale - specify when numeric values are formatted in a specific locale"}, {"in"=>"query", "name"=>"subjectNamespace", "description"=>"Subject namespace (required when using subjectIds to identify EHRs)"}, {"in"=>"query", "name"=>"templateId", "description"=>"Template ID"}, {"in"=>"query", "name"=>"templateLanguage", "description"=>"Template language"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import", "Csv"]}}, "/presentation"=>{"post"=>{"summary"=>"Returns presentation documents for a specified AQL query.", "description"=>"Returns presentation documents for a specified aql query..", "operationId"=>"getPresentationDocuments", "x-api-path-slug"=>"presentation-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Presentation"]}}, "/query"=>{"get"=>{"summary"=>"Returns the results of the specified AQL query.", "description"=>"Returns the results of the specified aql query..", "operationId"=>"query", "x-api-path-slug"=>"query-get", "parameters"=>[{"in"=>"query", "name"=>"aql", "description"=>"The AQL query to execute"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Query"]}, "post"=>{"summary"=>"Querying with named parameter support.", "description"=>"Querying with named parameter support..", "operationId"=>"query", "x-api-path-slug"=>"query-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A JSON object representing the AQL query and its parameters (see model)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Query"]}}, "/session"=>{"delete"=>{"summary"=>"Closes an OpenEhr session.", "description"=>"Closes an openehr session..", "operationId"=>"close", "x-api-path-slug"=>"session-delete", "parameters"=>[{"in"=>"header", "name"=>"Ehr-Session", "description"=>"The ID of the session to close"}, {"in"=>"query", "name"=>"sessionId", "description"=>"The ID of the session to close"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session"]}, "post"=>{"summary"=>"Creates a new OpenEhr session.", "description"=>"Creates a new openehr session..", "operationId"=>"login", "x-api-path-slug"=>"session-post", "parameters"=>[{"in"=>"query", "name"=>"password", "description"=>"Password"}, {"in"=>"query", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session"]}, "put"=>{"summary"=>"Pings an OpenEhr session.", "description"=>"Pings an openehr session..", "operationId"=>"ping", "x-api-path-slug"=>"session-put", "parameters"=>[{"in"=>"header", "name"=>"Ehr-Session", "description"=>"The ID of the session to ping"}, {"in"=>"query", "name"=>"sessionId", "description"=>"The ID of the session to ping"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session"]}}, "/session/ehr/{ehrId}"=>{"put"=>{"summary"=>"Sets the EHR on the session.", "description"=>"Sets the ehr on the session..", "operationId"=>"useEhr", "x-api-path-slug"=>"sessionehrehrid-put", "parameters"=>[{"in"=>"header", "name"=>"Ehr-Session", "description"=>"The ID of the session to set the EHR on"}, {"in"=>"path", "name"=>"ehrId", "description"=>"The ID of the EHR to set on the session"}, {"in"=>"query", "name"=>"sessionId", "description"=>"The ID of the session to set the EHR on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session", "Ehr", "EhrId"]}}, "/session/ehr/{subjectNamespace}/{subjectId}"=>{"put"=>{"summary"=>"Sets the EHR on the session (via subject namespace and ID).", "description"=>"Sets the ehr on the session (via subject namespace and id)..", "operationId"=>"findAndUseEhr", "x-api-path-slug"=>"sessionehrsubjectnamespacesubjectid-put", "parameters"=>[{"in"=>"header", "name"=>"Ehr-Session", "description"=>"The ID of the session to set the EHR on"}, {"in"=>"query", "name"=>"sessionId", "description"=>"The ID of the session to set the EHR on"}, {"in"=>"path", "name"=>"subjectId", "description"=>"The subject ID"}, {"in"=>"path", "name"=>"subjectNamespace", "description"=>"The namespace where the subject ID lives"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session", "Ehr", "SubjectNamespace", "SubjectId"]}}, "/smart/records/{ehrId}/{modelName}"=>{"get"=>{"summary"=>"Returns SMART records for a patient.", "description"=>"Returns smart records for a patient..", "operationId"=>"getRecords", "x-api-path-slug"=>"smartrecordsehridmodelname-get", "parameters"=>[{"in"=>"path", "name"=>"ehrId", "description"=>"EHR id"}, {"in"=>"path", "name"=>"modelName", "description"=>"SMART model name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Smart", "Records", "EhrId", "ModelName"]}}, "/smart/records/{ehrId}/{modelName}/{recordId}"=>{"get"=>{"summary"=>"Returns specific SMART record for a patient.", "description"=>"Returns specific smart record for a patient..", "operationId"=>"getRecord", "x-api-path-slug"=>"smartrecordsehridmodelnamerecordid-get", "parameters"=>[{"in"=>"path", "name"=>"ehrId", "description"=>"EHR id"}, {"in"=>"path", "name"=>"modelName", "description"=>"SMART model name"}, {"in"=>"path", "name"=>"recordId", "description"=>"Record id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Smart", "Records", "EhrId", "ModelName", "RecordId"]}}, "/tagging"=>{"delete"=>{"summary"=>"Delete a composition's tags.", "description"=>"Delete a composition's tags..", "operationId"=>"deleteTags", "x-api-path-slug"=>"tagging-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The tag request object specifies tags on what AQL paths to delete", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tagging"]}, "get"=>{"summary"=>"Returns objects matching the specified tags.", "description"=>"Returns objects matching the specified tags..", "operationId"=>"findObjectsWithTags", "x-api-path-slug"=>"tagging-get", "parameters"=>[{"in"=>"query", "name"=>"includeCurrentlyDeleted", "description"=>"Whether or not to include compositions whose current (last) version is deleted"}, {"in"=>"query", "name"=>"includeDeletedVersions", "description"=>"Whether or not to include deleted composition versions"}, {"in"=>"query", "name"=>"tags", "description"=>"A collection of tags that the returned objects need to be tagged with (a conjunction)"}, {"in"=>"query", "name"=>"versionsToReturn", "description"=>"Which composition versions to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tagging"]}, "post"=>{"summary"=>"Tags the specified composition and/or its sub-structures.", "description"=>"Tags the specified composition and/or its sub-structures..", "operationId"=>"tag", "x-api-path-slug"=>"tagging-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The tag request object specifies what to tag and how", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tagging"]}}, "/tagging/{compositionUid}"=>{"get"=>{"summary"=>"Returns tags for the specified composition.", "description"=>"Returns tags for the specified composition..", "operationId"=>"getTags", "x-api-path-slug"=>"taggingcompositionuid-get", "parameters"=>[{"in"=>"path", "name"=>"compositionUid", "description"=>"The ID of the composition whose tags to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tagging", "CompositionUid"]}}, "/template"=>{"get"=>{"summary"=>"Gets all template ids.", "description"=>"Gets all template ids..", "operationId"=>"getAllTemplates", "x-api-path-slug"=>"template-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Template"]}, "post"=>{"summary"=>"Uploads an operational template.", "description"=>"Uploads an operational template..", "operationId"=>"saveTemplate", "x-api-path-slug"=>"template-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Template"]}}, "/template/{templateId}"=>{"delete"=>{"summary"=>"Deletes an existing OpenEHR template.", "description"=>"Deletes an existing openehr template..", "operationId"=>"deleteTemplate", "x-api-path-slug"=>"templatetemplateid-delete", "parameters"=>[{"in"=>"path", "name"=>"templateId", "description"=>"The ID of the template to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Template", "TemplateId"]}, "get"=>{"summary"=>"Loads an OpenEhr web template.", "description"=>"Loads an openehr web template..", "operationId"=>"getTemplate", "x-api-path-slug"=>"templatetemplateid-get", "parameters"=>[{"in"=>"query", "name"=>"defaultLanguage", "description"=>"The default language to generate the returned web template with"}, {"in"=>"query", "name"=>"languages", "description"=>"Other languages to include in the returned web template, separated by a comma"}, {"in"=>"path", "name"=>"templateId", "description"=>"The ID of the template to load"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Template", "TemplateId"]}}, "/template/{templateId}/example"=>{"get"=>{"summary"=>"Returns an example of data values for a web template.", "description"=>"Returns an example of data values for a web template..", "operationId"=>"getTemplateExample", "x-api-path-slug"=>"templatetemplateidexample-get", "parameters"=>[{"in"=>"query", "name"=>"defaultLanguage", "description"=>"The default language to generate the web template with"}, {"in"=>"query", "name"=>"exampleFilter", "description"=>"The type of example to produce - intended for input (sent to the server), output (received back from the server) etc"}, {"in"=>"query", "name"=>"format", "description"=>"The format of JSON representation of the example composition to return"}, {"in"=>"query", "name"=>"languages", "description"=>"Other languages to include in the web template, separated by a comma"}, {"in"=>"path", "name"=>"templateId", "description"=>"The ID of the template to load"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Template", "TemplateId", "Example"]}}, "/view/{ehrId}/allergy"=>{"get"=>{"summary"=>"Gets allergies for a patient", "description"=>"Gets allergies for a patient.", "operationId"=>"get_allergy", "x-api-path-slug"=>"viewehridallergy-get", "parameters"=>[{"in"=>"path", "name"=>"ehrId", "description"=>"EHR ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return (default = 10, max = 100)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "EhrId", "Ergy"]}}, "/view/{ehrId}/blood_pressure"=>{"get"=>{"summary"=>"Gets recorded blood pressures for a patient", "description"=>"Gets recorded blood pressures for a patient.", "operationId"=>"get_blood_pressure", "x-api-path-slug"=>"viewehridblood-pressure-get", "parameters"=>[{"in"=>"path", "name"=>"ehrId", "description"=>"EHR ID"}, {"in"=>"query", "name"=>"from", "description"=>"Limit by date from"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return (default = 10, max = 100)"}, {"in"=>"query", "name"=>"to", "description"=>"Limit by date to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "EhrId", "Blood", "Pressure"]}}, "/view/{ehrId}/body_temperature"=>{"get"=>{"summary"=>"Gets recorded body temperatures for a patient", "description"=>"Gets recorded body temperatures for a patient.", "operationId"=>"get_body_temperature", "x-api-path-slug"=>"viewehridbody-temperature-get", "parameters"=>[{"in"=>"path", "name"=>"ehrId", "description"=>"EHR ID"}, {"in"=>"query", "name"=>"from", "description"=>"Limit by date from"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return (default = 10, max = 100)"}, {"in"=>"query", "name"=>"to", "description"=>"Limit by date to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "EhrId", "Body", "Temperature"]}}, "/view/{ehrId}/height"=>{"get"=>{"summary"=>"Gets recorded heights for a patient", "description"=>"Gets recorded heights for a patient.", "operationId"=>"get_height", "x-api-path-slug"=>"viewehridheight-get", "parameters"=>[{"in"=>"path", "name"=>"ehrId", "description"=>"EHR ID"}, {"in"=>"query", "name"=>"from", "description"=>"Limit by date from"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return (default = 10, max = 100)"}, {"in"=>"query", "name"=>"to", "description"=>"Limit by date to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "EhrId", "Height"]}}, "/view/{ehrId}/labs"=>{"get"=>{"summary"=>"Lab results", "description"=>"Lab results.", "operationId"=>"get_labs", "x-api-path-slug"=>"viewehridlabs-get", "parameters"=>[{"in"=>"path", "name"=>"ehrId", "description"=>"EHR ID"}, {"in"=>"query", "name"=>"from", "description"=>"Limit by date from"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return (default = 10, max = 100)"}, {"in"=>"query", "name"=>"to", "description"=>"Limit by date to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "EhrId", "Labs"]}}, "/view/{ehrId}/medication"=>{"get"=>{"summary"=>"Gets medications prescribed for a a patient", "description"=>"Gets medications prescribed for a a patient.", "operationId"=>"get_medication", "x-api-path-slug"=>"viewehridmedication-get", "parameters"=>[{"in"=>"path", "name"=>"ehrId", "description"=>"EHR ID"}, {"in"=>"query", "name"=>"from", "description"=>"Limit by date from"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return (default = 10, max = 100)"}, {"in"=>"query", "name"=>"to", "description"=>"Limit by date to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "EhrId", "Medication"]}}, "/view/{ehrId}/problem"=>{"get"=>{"summary"=>"Gets problems/diagnoses for a patient", "description"=>"Gets problems/diagnoses for a patient.", "operationId"=>"get_problem", "x-api-path-slug"=>"viewehridproblem-get", "parameters"=>[{"in"=>"path", "name"=>"ehrId", "description"=>"EHR ID"}, {"in"=>"query", "name"=>"from", "description"=>"Limit by date from"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return (default = 10, max = 100)"}, {"in"=>"query", "name"=>"to", "description"=>"Limit by date to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "EhrId", "Problem"]}}, "/view/{ehrId}/pulse"=>{"get"=>{"summary"=>"Gets pulse measurements for a patient", "description"=>"Gets pulse measurements for a patient.", "operationId"=>"get_pulse", "x-api-path-slug"=>"viewehridpulse-get", "parameters"=>[{"in"=>"path", "name"=>"ehrId", "description"=>"EHR ID"}, {"in"=>"query", "name"=>"from", "description"=>"Limit by date from"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return (default = 10, max = 100)"}, {"in"=>"query", "name"=>"to", "description"=>"Limit by date to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "EhrId", "Pulse"]}}, "/view/{ehrId}/spO2"=>{"get"=>{"summary"=>"Gets SpO2 measurements for a patient", "description"=>"Gets spo2 measurements for a patient.", "operationId"=>"get_spO2", "x-api-path-slug"=>"viewehridspo2-get", "parameters"=>[{"in"=>"path", "name"=>"ehrId", "description"=>"EHR ID"}, {"in"=>"query", "name"=>"from", "description"=>"Limit by date from"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return (default = 10, max = 100)"}, {"in"=>"query", "name"=>"to", "description"=>"Limit by date to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "EhrId", "SpO2"]}}, "/view/{ehrId}/weight"=>{"get"=>{"summary"=>"Gets recorded weights for a patient", "description"=>"Gets recorded weights for a patient.", "operationId"=>"get_weight", "x-api-path-slug"=>"viewehridweight-get", "parameters"=>[{"in"=>"path", "name"=>"ehrId", "description"=>"EHR ID"}, {"in"=>"query", "name"=>"from", "description"=>"Limit by date from"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return (default = 10, max = 100)"}, {"in"=>"query", "name"=>"to", "description"=>"Limit by date to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "EhrId", "Weight"]}}}}, "ehr-scape-terminology-apis-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EhrScape", "x-complete"=>1, "info"=>{"title"=>"Ehr Scape Terminology APIs", "description"=>"validates-and-resolves-terminology-codes", "version"=>"1.0.0"}, "host"=>"rest.ehrscape.com", "basePath"=>"/terminology-adapter/rest", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/terminology/codesystem/{codeSystem}/entities"=>{"get"=>{"summary"=>"List of entities in an explicit version of a single code system", "description"=>"", "operationId"=>"listEntities", "x-api-path-slug"=>"terminologycodesystemcodesystementities-get", "parameters"=>[{"in"=>"query", "name"=>"codelist", "description"=>"Filter to results whose code exactly matches one of the codes in this list"}, {"in"=>"path", "name"=>"codeSystem", "description"=>"Identifying code of the codesystem"}, {"in"=>"query", "name"=>"codesystemversion", "description"=>"Version of the codesystem"}, {"in"=>"query", "name"=>"matchvalue", "description"=>"Filter to results that contain this value, either in code or description"}, {"in"=>"query", "name"=>"page", "description"=>"Page of results to return"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Size of a single page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/terminology/codesystem/{codeSystem}/entity/{entity}"=>{"get"=>{"summary"=>"Returns details about a single entity", "description"=>"", "operationId"=>"getEntityDescription", "x-api-path-slug"=>"terminologycodesystemcodesystementityentity-get", "parameters"=>[{"in"=>"path", "name"=>"codeSystem", "description"=>"Identifying code of the codesystem"}, {"in"=>"query", "name"=>"codesystemversion", "description"=>"Version of the codesystem"}, {"in"=>"path", "name"=>"entity", "description"=>"code of the parent entity"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/terminology/codesystem/{codeSystem}/entity/{entity}/children"=>{"get"=>{"summary"=>"List of all children of a single entity", "description"=>"", "operationId"=>"listEntityChildren", "x-api-path-slug"=>"terminologycodesystemcodesystementityentitychildren-get", "parameters"=>[{"in"=>"query", "name"=>"codelist", "description"=>"Filter to results whose code exactly matches one of the codes in this list"}, {"in"=>"path", "name"=>"codeSystem", "description"=>"Identifying code of the codesystem"}, {"in"=>"query", "name"=>"codesystemversion", "description"=>"Version of the codesystem"}, {"in"=>"path", "name"=>"entity", "description"=>"code of the parent entity"}, {"in"=>"query", "name"=>"matchvalue", "description"=>"Filter to results that contain this value, either in code or description"}, {"in"=>"query", "name"=>"page", "description"=>"Page of results to return"}, {"in"=>"query", "name"=>"pagesize", "description"=>"Size of a single page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/terminology/codesystem/{codeSystem}/resolve"=>{"post"=>{"summary"=>"Resolves a list of entity codes with associated types into a list of actual entity codes", "description"=>" Resolves a list of entity codes with associated types into a list of actual entity codes Each entity code in the input has an associated type. Depending on the type, the code will resolve to the following:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
refuge-restrooms{"refuge-restrooms-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Refuge Restrooms", "x-complete"=>1, "info"=>{"title"=>"Refuge Restrooms", "description"=>"refuge-is-a-web-application-that-seeks-to-provide-safe-restroom-access-for-transgender-intersex-and-gender-nonconforming-individuals-", "version"=>"v1"}, "host"=>"www.refugerestrooms.org", "basePath"=>"/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/restrooms.json"=>{"get"=>{"summary"=>"Get all restroom records ordered by date descending.", "description"=>"", "operationId"=>"v1.restrooms.json.get", "x-api-path-slug"=>"v1restrooms-json-get", "parameters"=>[{"in"=>"query", "name"=>"ada", "description"=>"Only return restrooms that are ADA accessible"}, {"in"=>"query", "name"=>"offset", "description"=>"Pad a number of results"}, {"in"=>"query", "name"=>"page", "description"=>"Page offset to fetch"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of results to return per page"}, {"in"=>"query", "name"=>"unisex", "description"=>"Only return restrooms that are unisex"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/restrooms/by_date.json"=>{"get"=>{"summary"=>"Search for restroom records updated or created on or after a given date", "description"=>"", "operationId"=>"v1.restrooms.by_date.json.get", "x-api-path-slug"=>"v1restroomsby-date-json-get", "parameters"=>[{"in"=>"query", "name"=>"ada", "description"=>"Only return restrooms that are ADA accessible"}, {"in"=>"query", "name"=>"day", "description"=>"Day"}, {"in"=>"query", "name"=>"month", "description"=>"Month"}, {"in"=>"query", "name"=>"offset", "description"=>"Pad a number of results"}, {"in"=>"query", "name"=>"page", "description"=>"Page offset to fetch"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of results to return per page"}, {"in"=>"query", "name"=>"unisex", "description"=>"Only return restrooms that are unisex"}, {"in"=>"query", "name"=>"updated", "description"=>"Return restroom records updated (rather than created) since given date"}, {"in"=>"query", "name"=>"year", "description"=>"Year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/restrooms/by_location.json"=>{"get"=>{"summary"=>"Search by location.", "description"=>"", "operationId"=>"v1.restrooms.by_location.json.get", "x-api-path-slug"=>"v1restroomsby-location-json-get", "parameters"=>[{"in"=>"query", "name"=>"ada", "description"=>"Only return restrooms that are ADA accessible"}, {"in"=>"query", "name"=>"lat", "description"=>"latitude"}, {"in"=>"query", "name"=>"lng", "description"=>"longitude"}, {"in"=>"query", "name"=>"offset", "description"=>"Pad a number of results"}, {"in"=>"query", "name"=>"page", "description"=>"Page offset to fetch"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of results to return per page"}, {"in"=>"query", "name"=>"unisex", "description"=>"Only return restrooms that are unisex"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/restrooms/search.json"=>{"get"=>{"summary"=>"Perform full-text search of restroom records.", "description"=>"", "operationId"=>"v1.restrooms.search.json.get", "x-api-path-slug"=>"v1restroomssearch-json-get", "parameters"=>[{"in"=>"query", "name"=>"ada", "description"=>"Only return restrooms that are ADA accessible"}, {"in"=>"query", "name"=>"offset", "description"=>"Pad a number of results"}, {"in"=>"query", "name"=>"page", "description"=>"Page offset to fetch"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of results to return per page"}, {"in"=>"query", "name"=>"query", "description"=>"Your search query"}, {"in"=>"query", "name"=>"unisex", "description"=>"Only return restrooms that are unisex"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"Refuge Restrooms", "x-slug"=>"refuge-restrooms", "description"=>"Refuge Restrooms is a web application that seeks to provide safe restroom access for transgender, intersex, and gender nonconforming individuals. Users can search for restrooms by proximity to a search location, add new restroom listings, as well as comment and rate existing listings. We’re trans led and seek to create a community focused not only on finding existing safe restroom access, but also advocating for transgender, intersex, and gender nonconforming people’s safety.", "image"=>"", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Gender,General Data,Restrooms", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"refuge-restrooms/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Refuge Restrooms", "x-api-slug"=>"refuge-restrooms", "description"=>"Refuge Restrooms is a web application that seeks to provide safe restroom access for transgender, intersex, and gender nonconforming individuals. Users can search for restrooms by proximity to a search location, add new restroom listings, as well as comment and rate existing listings. We’re trans led and seek to create a community focused not only on finding existing safe restroom access, but also advocating for transgender, intersex, and gender nonconforming people’s safety.", "image"=>"", "humanURL"=>"http://refugerestrooms.org", "baseURL"=>"https://www.refugerestrooms.org//api", "tags"=>"Gender,General Data,Restrooms", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/refuge-restrooms/v1restroomssearch-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/refuge-restrooms/refuge-restrooms-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://refugerestrooms.org/api/docs/"}, {"type"=>"x-website", "url"=>"http://refugerestrooms.org"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
plentymarkets{"plentymarkets-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Plentymarkets", "x-complete"=>1, "info"=>{"title"=>"plentymarkets REST-API", "description"=>"the-plentymarkets-rest-api-expands-the-functionality-of-the-plentymarkets-cms-and-allows-access-to-resources-i-e--data-records-via-unique-uri-paths", "contact"=>{"name"=>"plentymarkets", "url"=>"https://forum.plentymarkets.com/c/rest-api"}, "version"=>"1.0.0"}, "host"=>"example.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/export/{exportKey}"=>{"get"=>{"summary"=>"Get Export Keys", "description"=>"Get export keys.", "operationId"=>"getExportExportkey", "x-api-path-slug"=>"exportexportkey-get", "parameters"=>[{"in"=>"path", "name"=>"exportKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/export/{exportKey}/{token}"=>{"get"=>{"summary"=>"Get Export Key", "description"=>"Get export keys..", "operationId"=>"getExportExportkeyToken", "x-api-path-slug"=>"exportexportkeytoken-get", "parameters"=>[{"in"=>"path", "name"=>"exportKey"}, {"in"=>"path", "name"=>"token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/rest/account/login"=>{"post"=>{"summary"=>"Login", "description"=>"Logs in to the online store with front end user credentials. The login call returns a JSON object that contains information, such as the access token and the refresh token.", "operationId"=>"postRestAccountLogin", "x-api-path-slug"=>"restaccountlogin-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/account/login", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Login"]}}, "/rest/account/login/refresh"=>{"post"=>{"summary"=>"Refresh", "description"=>"Refreshes the access token using the refresh token. The refresh token is part of the login call response.", "operationId"=>"postRestAccountLoginRefresh", "x-api-path-slug"=>"restaccountloginrefresh-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Refresh"]}}, "/rest/account/logout"=>{"post"=>{"summary"=>"Logout", "description"=>"Logs out the front end user from the online store. The access token expires.", "operationId"=>"postRestAccountLogout", "x-api-path-slug"=>"restaccountlogout-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logout"]}}, "/rest/accounting/locations"=>{"post"=>{"summary"=>"Create an accounting location", "description"=>"Creates an accounting location for a client. The plenty ID of the client must be specified.", "operationId"=>"postRestAccountingLocations", "x-api-path-slug"=>"restaccountinglocations-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/accounting/locations", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Location"]}}, "/rest/accounting/locations/existing_accounts"=>{"get"=>{"summary"=>"Get all unique posting accounts", "description"=>"Get all unique posting accounts.", "operationId"=>"getRestAccountingLocationsExistingAccounts", "x-api-path-slug"=>"restaccountinglocationsexisting-accounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unique", "Posting", "Accounts"]}}, "/rest/accounting/locations/posting_accounts"=>{"get"=>{"summary"=>"Get all posting accounts", "description"=>"Get all posting accounts.", "operationId"=>"getRestAccountingLocationsAddingAccounts", "x-api-path-slug"=>"restaccountinglocationsposting-accounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posting", "Accounts"]}, "post"=>{"summary"=>"Save posting accounts", "description"=>"Save posting accounts.", "operationId"=>"postRestAccountingLocationsAddingAccounts", "x-api-path-slug"=>"restaccountinglocationsposting-accounts-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Save", "Posting", "Accounts"]}}, "/rest/accounting/locations/posting_accounts/{id}"=>{"delete"=>{"summary"=>"Delete an posting account", "description"=>"Delete an posting account.", "operationId"=>"deleteRestAccountingLocationsAddingAccounts", "x-api-path-slug"=>"restaccountinglocationsposting-accountsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posting", "Account"]}, "get"=>{"summary"=>"Gets posting account by the unique id", "description"=>"Gets posting account by the unique id.", "operationId"=>"getRestAccountingLocationsAddingAccounts", "x-api-path-slug"=>"restaccountinglocationsposting-accountsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Posting", "Account", "By", "Unique", "Id"]}}, "/rest/accounting/locations/revenue_account_configurations"=>{"get"=>{"summary"=>"List revenue account configurations", "description"=>"Lists revenue account configurations of a system. The revenue accounts are returned as paginated result. By default 50 revenue accounts are on one page.", "operationId"=>"getRestAccountingLocationsRevenueAccountConfigurations", "x-api-path-slug"=>"restaccountinglocationsrevenue-account-configurations-get", "parameters"=>[{"in"=>"query", "name"=>"itemsPerPage", "description"=>"The number of revenue accounts to be displayed per page"}, {"in"=>"query", "name"=>"page", "description"=>"The page to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Revenue", "Account", "Configurations"]}}, "/rest/accounting/locations/{locationId}"=>{"delete"=>{"summary"=>"Delete an accounting location", "description"=>"Deletes an accounting location. The ID of the accounting location must be specified. Standard accounting locations can not be deleted.", "operationId"=>"deleteRestAccountingLocationsLocation", "x-api-path-slug"=>"restaccountinglocationslocationid-delete", "parameters"=>[{"in"=>"path", "name"=>"locationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Location"]}, "get"=>{"summary"=>"Get an accounting location", "description"=>"Gets an accounting location. The ID of the accounting location must be specified.", "operationId"=>"getRestAccountingLocationsLocation", "x-api-path-slug"=>"restaccountinglocationslocationid-get", "parameters"=>[{"in"=>"path", "name"=>"locationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Location"]}, "put"=>{"summary"=>"Update an accounting location", "description"=>"Updates an accounting location. The ID of the accounting location must be specified.", "operationId"=>"putRestAccountingLocationsLocation", "x-api-path-slug"=>"restaccountinglocationslocationid-put", "parameters"=>[{"in"=>"body", "name"=>"/rest/accounting/locations/{locationId}", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"locationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Location"]}}, "/rest/accounting/locations/{locationId}/countries/{countryId}/revenue_accounts"=>{"get"=>{"summary"=>"Get the revenue account configuration of a country", "description"=>"Get the revenue account configuration of a country. The ID of the accounting location that the country is associated with as well as the ID of the country must be specified.", "operationId"=>"getRestAccountingLocationsLocationCountriesCountryRevenueAccounts", "x-api-path-slug"=>"restaccountinglocationslocationidcountriescountryidrevenue-accounts-get", "parameters"=>[{"in"=>"path", "name"=>"countryId"}, {"in"=>"path", "name"=>"locationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Revenue", "Account", "Configuration", "Of", "Country"]}}, "/rest/accounting/locations/{locationId}/debtor_account_configurations"=>{"get"=>{"summary"=>"Get debtor account configuration of an accounting location", "description"=>"Gets the debtor account configuration of an accounting location. The ID of the accounting location has to be specified. The debtor account configuration can contain one standard debtor account only or e.g. several accounts for each country of delivery.", "operationId"=>"getRestAccountingLocationsLocationDebtorAccountConfigurations", "x-api-path-slug"=>"restaccountinglocationslocationiddebtor-account-configurations-get", "parameters"=>[{"in"=>"path", "name"=>"locationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Debtor", "Account", "Configuration", "Of", "Accounting", "Location"]}}, "/rest/accounting/locations/{locationId}/debtor_accounts/{mode}"=>{"get"=>{"summary"=>"Lists the debtor accounts by mode.", "description"=>"Lists the debtor accounts of an accounting location by mode. The ID of the accounting location and the mode have to be specified.", "operationId"=>"getRestAccountingLocationsLocationDebtorAccountsMode", "x-api-path-slug"=>"restaccountinglocationslocationiddebtor-accountsmode-get", "parameters"=>[{"in"=>"path", "name"=>"locationId"}, {"in"=>"path", "name"=>"mode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Debtor", "Accounts", "By", "Mode"]}}, "/rest/accounting/locations/{locationId}/posting_accounts"=>{"get"=>{"summary"=>"Get all posting accounts by locationId", "description"=>"Get all posting accounts by locationid.", "operationId"=>"getRestAccountingLocationsLocationAddingAccounts", "x-api-path-slug"=>"restaccountinglocationslocationidposting-accounts-get", "parameters"=>[{"in"=>"path", "name"=>"locationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posting", "Accounts", "By", "LocationId"]}}, "/rest/accounting/locations/{locationId}/posting_key_configurations"=>{"get"=>{"summary"=>"Get a posting key configuration of an accounting location", "description"=>"Gets a posting key configuration of an accounting location. The ID of the accounting location has to be specified. The posting key configuration can contain up to 4 posting keys.", "operationId"=>"getRestAccountingLocationsLocationAddingKeyConfigurations", "x-api-path-slug"=>"restaccountinglocationslocationidposting-key-configurations-get", "parameters"=>[{"in"=>"path", "name"=>"locationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posting", "Key", "Configuration", "Of", "Accounting", "Location"]}}, "/rest/accounting/locations/{locationId}/revenue_account_configurations"=>{"get"=>{"summary"=>"Get the revenue account configuration of an accounting location", "description"=>"Gets the revenue account configuration of an accounting location. A revenue account location configuration contains several revenue accounts. The ID of the accounting location has to be specified.", "operationId"=>"getRestAccountingLocationsLocationRevenueAccountConfigurations", "x-api-path-slug"=>"restaccountinglocationslocationidrevenue-account-configurations-get", "parameters"=>[{"in"=>"path", "name"=>"locationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Revenue", "Account", "Configuration", "Of", "Accounting", "Location"]}}, "/rest/accounting/locations/{locationId}/{type}/posting_accounts"=>{"get"=>{"summary"=>"Get all posting accounts by locationId and type", "description"=>"Get all posting accounts by locationid and type.", "operationId"=>"getRestAccountingLocationsLocationTypeAddingAccounts", "x-api-path-slug"=>"restaccountinglocationslocationidtypeposting-accounts-get", "parameters"=>[{"in"=>"path", "name"=>"locationId"}, {"in"=>"path", "name"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posting", "Accounts", "By", "LocationId", "Type"]}}, "/rest/accounting/locations/{webstoreId}/{countryId}/posting_accounts"=>{"get"=>{"summary"=>"Get all posting accounts for a country of a webstore", "description"=>"Get all posting accounts for a country of a webstore.", "operationId"=>"getRestAccountingLocationsWebstoreCountryAddingAccounts", "x-api-path-slug"=>"restaccountinglocationswebstoreidcountryidposting-accounts-get", "parameters"=>[{"in"=>"query", "name"=>"$webstoreId", "description"=>"The ID of the webstore"}, {"in"=>"path", "name"=>"countryId"}, {"in"=>"path", "name"=>"webstoreId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posting", "Accountsa", "Country", "Of", "Webstore"]}}, "/rest/accounting/stores/locations"=>{"get"=>{"summary"=>"List all accounting locations", "description"=>"List all accounting locations.", "operationId"=>"getRestAccountingStoresLocations", "x-api-path-slug"=>"restaccountingstoreslocations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Accounting", "Locations"]}}, "/rest/accounting/stores/{plentyId}/locations"=>{"get"=>{"summary"=>"List accounting locations of a client", "description"=>"Lists accounting locations of a client. The plenty ID of the client must be specified.", "operationId"=>"getRestAccountingStoresPlentyLocations", "x-api-path-slug"=>"restaccountingstoresplentyidlocations-get", "parameters"=>[{"in"=>"query", "name"=>"locationId", "description"=>"The plenty ID"}, {"in"=>"path", "name"=>"plentyId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Accounting", "Locations", "Of", "Client"]}}, "/rest/accounts"=>{"get"=>{"summary"=>"List accounts", "description"=>"List accounts.", "operationId"=>"getRestAccounts", "x-api-path-slug"=>"restaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"createdAt", "description"=>"Filter that restricts the search result to accounts that were created according to given filters"}, {"in"=>"query", "name"=>"updatedAt", "description"=>"Filter that restricts the search result to accounts that were updated according to given filters"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Accounts"]}, "post"=>{"summary"=>"Create an account", "description"=>"Create an account.", "operationId"=>"postRestAccounts", "x-api-path-slug"=>"restaccounts-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/accounts", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/rest/accounts/addresses"=>{"post"=>{"summary"=>"Create an address", "description"=>"Create an address.", "operationId"=>"postRestAccountsAddresses", "x-api-path-slug"=>"restaccountsaddresses-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/accounts/addresses", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address"]}}, "/rest/accounts/addresses/contact_relations"=>{"get"=>{"summary"=>"List address contact relations", "description"=>"List address contact relations.", "operationId"=>"getRestAccountsAddressesContactRelations", "x-api-path-slug"=>"restaccountsaddressescontact-relations-get", "parameters"=>[{"in"=>"query", "name"=>"addressId", "description"=>"Filter that restricts the search result to addresses with a specific ID"}, {"in"=>"query", "name"=>"contactId", "description"=>"Filter that restricts the search result to contacts with a specific ID"}, {"in"=>"query", "name"=>"id", "description"=>"Filter that restricts the search result to address contact relations with a specific ID"}, {"in"=>"query", "name"=>"isPrimary", "description"=>"Filter that restricts the search result depending on the flag used"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"The number of items to list per page"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to search for"}, {"in"=>"query", "name"=>"typeId", "description"=>"Filter that restricts the search result to address types with a specific ID"}, {"in"=>"query", "name"=>"with", "description"=>"Includes the specified address contact relation information in the results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Address", "Contact", "Relations"]}, "post"=>{"summary"=>"Create address contact relations", "description"=>"Create address contact relations.", "operationId"=>"postRestAccountsAddressesContactRelations", "x-api-path-slug"=>"restaccountsaddressescontact-relations-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/accounts/addresses/contact_relations", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "Contact", "Relations"]}, "put"=>{"summary"=>"Update address contact relations", "description"=>"Update address contact relations.", "operationId"=>"putRestAccountsAddressesContactRelations", "x-api-path-slug"=>"restaccountsaddressescontact-relations-put", "parameters"=>[{"in"=>"body", "name"=>"/rest/accounts/addresses/contact_relations", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "Contact", "Relations"]}}, "/rest/accounts/addresses/contact_relations/{addressContactRelationId}"=>{"delete"=>{"summary"=>"Delete an address contact relation", "description"=>"Deletes an address contact relation. The ID of the relation must be specified.", "operationId"=>"deleteRestAccountsAddressesContactRelationsAddresscontactrelation", "x-api-path-slug"=>"restaccountsaddressescontact-relationsaddresscontactrelationid-delete", "parameters"=>[{"in"=>"path", "name"=>"addressContactRelationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "Contact", "Relation"]}, "get"=>{"summary"=>"Get an address contact relation", "description"=>"Gets an address contact relation. The ID of the address contact relation must be specified.", "operationId"=>"getRestAccountsAddressesContactRelationsAddresscontactrelation", "x-api-path-slug"=>"restaccountsaddressescontact-relationsaddresscontactrelationid-get", "parameters"=>[{"in"=>"path", "name"=>"addressContactRelationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "Contact", "Relation"]}}, "/rest/accounts/addresses/option_types"=>{"get"=>{"summary"=>"List address option types", "description"=>"List address option types.", "operationId"=>"getRestAccountsAddressesOptionTypes", "x-api-path-slug"=>"restaccountsaddressesoption-types-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Address", "Option", "Types"]}, "post"=>{"summary"=>"Create an address option type", "description"=>"Create an address option type.", "operationId"=>"postRestAccountsAddressesOptionTypes", "x-api-path-slug"=>"restaccountsaddressesoption-types-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/accounts/addresses/option_types", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "Option", "Type"]}}, "/rest/accounts/addresses/option_types/{optionTypeId}"=>{"delete"=>{"summary"=>"Delete an address option type", "description"=>"Deletes an address option type. The ID of the option type must be specified.", "operationId"=>"deleteRestAccountsAddressesOptionTypesOptiontype", "x-api-path-slug"=>"restaccountsaddressesoption-typesoptiontypeid-delete", "parameters"=>[{"in"=>"path", "name"=>"optionTypeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "Option", "Type"]}, "get"=>{"summary"=>"Get an address option type", "description"=>"Gets an address option type. The ID of the option type must be specified.", "operationId"=>"getRestAccountsAddressesOptionTypesOptiontype", "x-api-path-slug"=>"restaccountsaddressesoption-typesoptiontypeid-get", "parameters"=>[{"in"=>"path", "name"=>"optionTypeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "Option", "Type"]}, "put"=>{"summary"=>"Update an address option type", "description"=>"Updates an address option type. The ID of the option type must be specified.", "operationId"=>"putRestAccountsAddressesOptionTypesOptiontype", "x-api-path-slug"=>"restaccountsaddressesoption-typesoptiontypeid-put", "parameters"=>[{"in"=>"body", "name"=>"/rest/accounts/addresses/option_types/{optionTypeId}", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"optionTypeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "Option", "Type"]}}, "/rest/accounts/addresses/options/{optionId}"=>{"delete"=>{"summary"=>"Delete an address option by the option ID", "description"=>"Deletes an address option. The ID of the option must be specified.", "operationId"=>"deleteRestAccountsAddressesOptionsOption", "x-api-path-slug"=>"restaccountsaddressesoptionsoptionid-delete", "parameters"=>[{"in"=>"path", "name"=>"optionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "Option", "By", "Option", "ID"]}, "get"=>{"summary"=>"Get an address option", "description"=>"Gets an address option. The ID of the option must be specified.", "operationId"=>"getRestAccountsAddressesOptionsOption", "x-api-path-slug"=>"restaccountsaddressesoptionsoptionid-get", "parameters"=>[{"in"=>"path", "name"=>"optionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "Option"]}, "put"=>{"summary"=>"Update an address option", "description"=>"Updates an address option. The ID of the option must be specified.", "operationId"=>"putRestAccountsAddressesOptionsOption", "x-api-path-slug"=>"restaccountsaddressesoptionsoptionid-put", "parameters"=>[{"in"=>"path", "name"=>"optionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "Option"]}}, "/rest/accounts/addresses/pos_relations"=>{"get"=>{"summary"=>"List address POS relations", "description"=>"List address pos relations.", "operationId"=>"getRestAccountsAddressesPosRelations", "x-api-path-slug"=>"restaccountsaddressespos-relations-get", "parameters"=>[{"in"=>"query", "name"=>"itemsPerPage", "description"=>"items per page"}, {"in"=>"query", "name"=>"page", "description"=>"page"}, {"in"=>"query", "name"=>"with", "description"=>"Includes the specified address pos relation information in the results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Address", "POS", "Relations"]}, "post"=>{"summary"=>"Create an address POS relation", "description"=>"Create an address pos relation.", "operationId"=>"postRestAccountsAddressesPosRelations", "x-api-path-slug"=>"restaccountsaddressespos-relations-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "POS", "Relation"]}}, "/rest/accounts/addresses/pos_relations/{addressPosRelationId}"=>{"delete"=>{"summary"=>"Delete an address POS relation", "description"=>"Deletes an address POS relation. The ID of the address POS relation must be specified.", "operationId"=>"deleteRestAccountsAddressesPosRelationsAddressposrelation", "x-api-path-slug"=>"restaccountsaddressespos-relationsaddressposrelationid-delete", "parameters"=>[{"in"=>"path", "name"=>"addressPosRelationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "POS", "Relation"]}, "get"=>{"summary"=>"Get an address POS relation", "description"=>"Gets an address POS relation. The ID of the address POS relation must be specified.", "operationId"=>"getRestAccountsAddressesPosRelationsAddressposrelation", "x-api-path-slug"=>"restaccountsaddressespos-relationsaddressposrelationid-get", "parameters"=>[{"in"=>"path", "name"=>"addressPosRelationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "POS", "Relation"]}, "put"=>{"summary"=>"Update an address POS relation", "description"=>"Updates an address POS relation. The ID of the address POS relation must be specified.", "operationId"=>"putRestAccountsAddressesPosRelationsAddressposrelation", "x-api-path-slug"=>"restaccountsaddressespos-relationsaddressposrelationid-put", "parameters"=>[{"in"=>"path", "name"=>"addressPosRelationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "POS", "Relation"]}}, "/rest/accounts/addresses/relation_types"=>{"get"=>{"summary"=>"List address relation types", "description"=>"List address relation types.", "operationId"=>"getRestAccountsAddressesRelationTypes", "x-api-path-slug"=>"restaccountsaddressesrelation-types-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Address", "Relation", "Types"]}}, "/rest/accounts/addresses/relations/types/applications/{application}/{lang}"=>{"get"=>{"summary"=>"List address relation types", "description"=>"Lists address relation types. The application and the language must be specified.\n Possible applications:\n
OutputParam entry.", "operationId"=>"getRestExportsGenerateToken", "x-api-path-slug"=>"restexportsgenerate-token-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generate", "Token"]}}, "/rest/exports/{exportId}"=>{"delete"=>{"summary"=>"Delete export", "description"=>"Deletes an export. The ID of the export must be specified.", "operationId"=>"deleteRestExportsExport", "x-api-path-slug"=>"restexportsexportid-delete", "parameters"=>[{"in"=>"path", "name"=>"exportId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Export"]}, "get"=>{"summary"=>"Get export", "description"=>"Gets detailed information about an export. The ID of the export must be specified.", "operationId"=>"getRestExportsExport", "x-api-path-slug"=>"restexportsexportid-get", "parameters"=>[{"in"=>"path", "name"=>"exportId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Export"]}, "put"=>{"summary"=>"Update an export", "description"=>"Updates an export. The ID of the export must be specified.", "operationId"=>"putRestExportsExport", "x-api-path-slug"=>"restexportsexportid-put", "parameters"=>[{"in"=>"body", "name"=>"/rest/exports/{exportId}", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"exportId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Export"]}}, "/rest/exports/{exportId}/filters/{filterId}"=>{"delete"=>{"summary"=>"", "description"=>".", "operationId"=>"deleteRestExportsExportFiltersFilter", "x-api-path-slug"=>"restexportsexportidfiltersfilterid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/exports/{exportId}/filters/{key}"=>{"delete"=>{"summary"=>"", "description"=>".", "operationId"=>"deleteRestExportsExportFiltersKey", "x-api-path-slug"=>"restexportsexportidfilterskey-delete", "parameters"=>[{"in"=>"path", "name"=>"exportId"}, {"in"=>"path", "name"=>"key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/feedbacks/comment"=>{"post"=>{"summary"=>"Create a feedback comment", "description"=>"Creates a feedback comment.", "operationId"=>"postRestFeedbacksComment", "x-api-path-slug"=>"restfeedbackscomment-post", "parameters"=>[{"in"=>"query", "name"=>"commentRelationTargetId", "description"=>"The ID of the comments target"}, {"in"=>"query", "name"=>"commentRelationTargetTypeId", "description"=>"The type ID of the comments target"}, {"in"=>"query", "name"=>"message", "description"=>"Feedback comment message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feedback", "Comment"]}}, "/rest/feedbacks/comment/{commentId}"=>{"delete"=>{"summary"=>"Delete a feedback comment", "description"=>"Deletes a feedback comment. The ID of the feedback comment must be specified.", "operationId"=>"deleteRestFeedbacksCommentComment", "x-api-path-slug"=>"restfeedbackscommentcommentid-delete", "parameters"=>[{"in"=>"path", "name"=>"commentId"}, {"in"=>"query", "name"=>"feedbackCommentId", "description"=>"The ID of the feedback comment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feedback", "Comment"]}, "get"=>{"summary"=>"Get a feedback comment", "description"=>"Gets a feedback comment. The ID of the feedback comment must be specified.", "operationId"=>"getRestFeedbacksCommentComment", "x-api-path-slug"=>"restfeedbackscommentcommentid-get", "parameters"=>[{"in"=>"path", "name"=>"commentId"}, {"in"=>"query", "name"=>"feedbackCommentId", "description"=>"The ID of the feedback comment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feedback", "Comment"]}, "put"=>{"summary"=>"", "description"=>".", "operationId"=>"putRestFeedbacksCommentComment", "x-api-path-slug"=>"restfeedbackscommentcommentid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/feedbacks/comments"=>{"get"=>{"summary"=>"List feedback comments", "description"=>"Lists feedback comments.", "operationId"=>"getRestFeedbacksComments", "x-api-path-slug"=>"restfeedbackscomments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Feedback", "Comments"]}}, "/rest/feedbacks/delete_feedbacks/{feedbackIds}"=>{"delete"=>{"summary"=>"Delete multiple feedbacks", "description"=>"Deletes multiple feedbacks. A list with IDs of feedbacks must be specified.", "operationId"=>"deleteRestFeedbacksDeleteFeedbacksFeedbacks", "x-api-path-slug"=>"restfeedbacksdelete-feedbacksfeedbackids-delete", "parameters"=>[{"in"=>"path", "name"=>"feedbackIds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multiple", "Feedbacks"]}}, "/rest/feedbacks/feedback"=>{"post"=>{"summary"=>"Create a feedback", "description"=>"Creates a feedback.", "operationId"=>"postRestFeedbacksFeedback", "x-api-path-slug"=>"restfeedbacksfeedback-post", "parameters"=>[{"in"=>"query", "name"=>"feedbackRelationSourceTypeId", "description"=>"The type ID of the feedbacks source"}, {"in"=>"query", "name"=>"feedbackRelationTargetId", "description"=>"The ID of the feedbacks target"}, {"in"=>"query", "name"=>"feedbackRelationTargetTypeId", "description"=>"The type ID of the feedbacks target"}, {"in"=>"query", "name"=>"title", "description"=>"Feedback title"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feedback"]}}, "/rest/feedbacks/feedback/replies/{feedbackId}"=>{"get"=>{"summary"=>"List feedback replies", "description"=>"Lists feedback replies. The ID of the feedback must be specified.", "operationId"=>"getRestFeedbacksFeedbackRepliesFeedback", "x-api-path-slug"=>"restfeedbacksfeedbackrepliesfeedbackid-get", "parameters"=>[{"in"=>"path", "name"=>"feedbackId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Feedback", "Replies"]}}, "/rest/feedbacks/feedback/{feedbackId}"=>{"delete"=>{"summary"=>"Delete a feedback", "description"=>"Deletes a feedback. The ID of the feedback must be specified.", "operationId"=>"deleteRestFeedbacksFeedbackFeedback", "x-api-path-slug"=>"restfeedbacksfeedbackfeedbackid-delete", "parameters"=>[{"in"=>"path", "name"=>"feedbackId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feedback"]}, "get"=>{"summary"=>"Get a feedback", "description"=>"Gets a feedback. The ID of the feedback must be specified.", "operationId"=>"getRestFeedbacksFeedbackFeedback", "x-api-path-slug"=>"restfeedbacksfeedbackfeedbackid-get", "parameters"=>[{"in"=>"path", "name"=>"feedbackId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feedback"]}, "put"=>{"summary"=>"Update a feedback", "description"=>"Updates a feedback. The ID of the feedback must be specified.", "operationId"=>"putRestFeedbacksFeedbackFeedback", "x-api-path-slug"=>"restfeedbacksfeedbackfeedbackid-put", "parameters"=>[{"in"=>"path", "name"=>"feedbackId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feedback"]}}, "/rest/feedbacks/feedbacks"=>{"get"=>{"summary"=>"List feedbacks", "description"=>"Lists feedbacks. The reference type and the reference value must be specified (e.g. the reference type is 'order' and the reference value is the ID of the order).", "operationId"=>"getRestFeedbacksFeedbacks", "x-api-path-slug"=>"restfeedbacksfeedbacks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Feedbacks"]}}, "/rest/feedbacks/feedbacks_visibility"=>{"put"=>{"summary"=>"Update the visibility of multiple feedbacks", "description"=>"Updates the visibility of multiple feedbacks. A list with IDs of feedbacks must be specified.", "operationId"=>"putRestFeedbacksFeedbacksVisibility", "x-api-path-slug"=>"restfeedbacksfeedbacks-visibility-put", "parameters"=>[{"in"=>"query", "name"=>"feedbackIds", "description"=>"The list of feedback IDs, separated by commas"}, {"in"=>"query", "name"=>"isVisible", "description"=>"The visibility value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Visibility", "Of", "Multiple", "Feedbacks"]}}, "/rest/feedbacks/migrate"=>{"post"=>{"summary"=>"Migrate legacy feedbacks", "description"=>"Migrate legacy feedbacks.", "operationId"=>"postRestFeedbacksMigrate", "x-api-path-slug"=>"restfeedbacksmigrate-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Migrate", "Legacy", "Feedbacks"]}}, "/rest/feedbacks/rating"=>{"post"=>{"summary"=>"Create a feedback rating", "description"=>"Creates a feedback rating.", "operationId"=>"postRestFeedbacksRating", "x-api-path-slug"=>"restfeedbacksrating-post", "parameters"=>[{"in"=>"query", "name"=>"ratingRelationTargetId", "description"=>"The ID of the ratings target"}, {"in"=>"query", "name"=>"ratingRelationTargetTypeId", "description"=>"The type ID of the ratings target"}, {"in"=>"query", "name"=>"ratingValue", "description"=>"The feedbacks comment message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feedback", "Rating"]}}, "/rest/feedbacks/rating/{ratingId}"=>{"delete"=>{"summary"=>"Delete a feedback rating", "description"=>"Deletes a feedback rating. The ID of the feedback rating must be specified.", "operationId"=>"deleteRestFeedbacksRatingRating", "x-api-path-slug"=>"restfeedbacksratingratingid-delete", "parameters"=>[{"in"=>"query", "name"=>"feedbackRatingId", "description"=>"The ID of the feedback rating"}, {"in"=>"path", "name"=>"ratingId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feedback", "Rating"]}, "get"=>{"summary"=>"Get a feedback rating", "description"=>"Gets a feedback rating. The ID of the feedback rating must be specified.", "operationId"=>"getRestFeedbacksRatingRating", "x-api-path-slug"=>"restfeedbacksratingratingid-get", "parameters"=>[{"in"=>"query", "name"=>"feedbackRatingId", "description"=>"The ID of the feedback rating"}, {"in"=>"path", "name"=>"ratingId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feedback", "Rating"]}, "put"=>{"summary"=>"", "description"=>".", "operationId"=>"putRestFeedbacksRatingRating", "x-api-path-slug"=>"restfeedbacksratingratingid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/feedbacks/ratings"=>{"get"=>{"summary"=>"List feedback ratings", "description"=>"Lists feedback ratings.", "operationId"=>"getRestFeedbacksRatings", "x-api-path-slug"=>"restfeedbacksratings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Feedback", "Ratings"]}}, "/rest/item_sets"=>{"delete"=>{"summary"=>"Delete item sets", "description"=>"Delete item sets.", "operationId"=>"deleteRestItemSets", "x-api-path-slug"=>"restitem-sets-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item", "Sets"]}, "get"=>{"summary"=>"List item sets", "description"=>"Lists all item sets.", "operationId"=>"getRestItemSets", "x-api-path-slug"=>"restitem-sets-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Item", "Sets"]}, "post"=>{"summary"=>"Create item sets", "description"=>"Create item sets.", "operationId"=>"postRestItemSets", "x-api-path-slug"=>"restitem-sets-post", "parameters"=>[{"in"=>"query", "name"=>"params", "description"=>"includes the item sets that have to be created"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item", "Sets"]}, "put"=>{"summary"=>"Update item sets", "description"=>"Update item sets.", "operationId"=>"putRestItemSets", "x-api-path-slug"=>"restitem-sets-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item", "Sets"]}}, "/rest/item_sets/{id}"=>{"delete"=>{"summary"=>"Delete an item set", "description"=>"Deletes an item set. The item ID of the item set must be specified.", "operationId"=>"deleteRestItemSets", "x-api-path-slug"=>"restitem-setsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item", "Set"]}, "get"=>{"summary"=>"Get an item set", "description"=>"Gets the configuration of an item set. The item ID of the item set must be specified.", "operationId"=>"getRestItemSets", "x-api-path-slug"=>"restitem-setsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item", "Set"]}, "put"=>{"summary"=>"Update an item set", "description"=>"Updates an item set. The item ID of the item set must be specified.", "operationId"=>"putRestItemSets", "x-api-path-slug"=>"restitem-setsid-put", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item", "Set"]}}, "/rest/item_sets/{setId}/components"=>{"delete"=>{"summary"=>"Delete item set components", "description"=>"Delete item set components.", "operationId"=>"deleteRestItemSetsSetComponents", "x-api-path-slug"=>"restitem-setssetidcomponents-delete", "parameters"=>[{"in"=>"path", "name"=>"setId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item", "Set", "Components"]}, "get"=>{"summary"=>"List item set components of an item set", "description"=>"Lists the item set components of an item set. The ID of the item set must be specified.", "operationId"=>"getRestItemSetsSetComponents", "x-api-path-slug"=>"restitem-setssetidcomponents-get", "parameters"=>[{"in"=>"path", "name"=>"setId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Item", "Set", "Components", "Of", "Item", "Set"]}, "post"=>{"summary"=>"Create item set components", "description"=>"Create item set components.", "operationId"=>"postRestItemSetsSetComponents", "x-api-path-slug"=>"restitem-setssetidcomponents-post", "parameters"=>[{"in"=>"path", "name"=>"setId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item", "Set", "Components"]}, "put"=>{"summary"=>"Update item set components", "description"=>"Update item set components.", "operationId"=>"putRestItemSetsSetComponents", "x-api-path-slug"=>"restitem-setssetidcomponents-put", "parameters"=>[{"in"=>"path", "name"=>"setId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item", "Set", "Components"]}}, "/rest/item_sets/{setId}/components/{id}"=>{"delete"=>{"summary"=>"Delete an item set component", "description"=>"Deletes an item set component. The item set component ID of the item set component must be specified.", "operationId"=>"deleteRestItemSetsSetComponents", "x-api-path-slug"=>"restitem-setssetidcomponentsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"setId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item", "Set", "Component"]}, "get"=>{"summary"=>"Get an item set component", "description"=>"Get an item set component.", "operationId"=>"getRestItemSetsSetComponents", "x-api-path-slug"=>"restitem-setssetidcomponentsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"setId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item", "Set", "Component"]}, "put"=>{"summary"=>"Update an item set component", "description"=>"Update an item set component.", "operationId"=>"putRestItemSetsSetComponents", "x-api-path-slug"=>"restitem-setssetidcomponentsid-put", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"setId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item", "Set", "Component"]}}, "/rest/item_sets/{setId}/config"=>{"get"=>{"summary"=>"Get the item set configuration of an item set", "description"=>"Get the item set configuration of an item set.", "operationId"=>"getRestItemSetsSetConfig", "x-api-path-slug"=>"restitem-setssetidconfig-get", "parameters"=>[{"in"=>"path", "name"=>"setId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item", "Set", "Configuration", "Of", "Item", "Set"]}, "put"=>{"summary"=>"Update an item set configuration", "description"=>"Update an item set configuration.", "operationId"=>"putRestItemSetsSetConfig", "x-api-path-slug"=>"restitem-setssetidconfig-put", "parameters"=>[{"in"=>"path", "name"=>"setId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item", "Set", "Configuration"]}}, "/rest/items"=>{"get"=>{"summary"=>"Search item", "description"=>"Search item.", "operationId"=>"getRestItems", "x-api-path-slug"=>"restitems-get", "parameters"=>[{"in"=>"query", "name"=>"flagOne", "description"=>"Filter restricts the list of results to items with the specified flagOne"}, {"in"=>"query", "name"=>"flagTwo", "description"=>"Filter restricts the list of results to items with the specified flagTwo"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"Limits the number of results listed per page to a specific number"}, {"in"=>"query", "name"=>"lang", "description"=>"The language of the variation information"}, {"in"=>"query", "name"=>"manufacturerId", "description"=>"Filter restricts the list of results to items with the specified manufacturerId"}, {"in"=>"query", "name"=>"name", "description"=>"Filter restricts the list of results to items with the specified item name"}, {"in"=>"query", "name"=>"page", "description"=>"Limits the results to a specific page"}, {"in"=>"query", "name"=>"tagId", "description"=>"Filter restricts the list of results to items with the specified tagId"}, {"in"=>"query", "name"=>"updatedBetween", "description"=>"Filter restricts the list of results to items updated during the specified period"}, {"in"=>"query", "name"=>"variationRelatedUpdatedBetween", "description"=>"Filter restricts the list of results to items with variations for which related information was updated during the specified period"}, {"in"=>"query", "name"=>"variationUpdatedBetween", "description"=>"Filter restricts the list of results to items with variations that were updated during the specified period"}, {"in"=>"query", "name"=>"with", "description"=>"Includes the specified variation information in the results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Item"]}, "post"=>{"summary"=>"Create new item", "description"=>"Create new item.", "operationId"=>"postRestItems", "x-api-path-slug"=>"restitems-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/items", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Item"]}}, "/rest/items/attribute_values/{valueId}/names"=>{"get"=>{"summary"=>"Get name and language for an attribute value ID", "description"=>"Gets name and language for an attribute value ID. The attribute value ID must be specified.", "operationId"=>"getRestItemsAttributeValuesValueNames", "x-api-path-slug"=>"restitemsattribute-valuesvalueidnames-get", "parameters"=>[{"in"=>"path", "name"=>"valueId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Name", "Languagean", "Attribute", "Value", "ID"]}, "post"=>{"summary"=>"Create an attribute value name", "description"=>"Creates an attribute value name.", "operationId"=>"postRestItemsAttributeValuesValueNames", "x-api-path-slug"=>"restitemsattribute-valuesvalueidnames-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/items/attribute_values/{valueId}/names", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"valueId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Value", "Name"]}}, "/rest/items/attribute_values/{valueId}/names/{lang}"=>{"delete"=>{"summary"=>"Delete an attribute value name", "description"=>"Deletes an attribute value name. The attribute value ID and language must be specified.", "operationId"=>"deleteRestItemsAttributeValuesValueNamesLang", "x-api-path-slug"=>"restitemsattribute-valuesvalueidnameslang-delete", "parameters"=>[{"in"=>"path", "name"=>"lang"}, {"in"=>"path", "name"=>"valueId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Value", "Name"]}, "get"=>{"summary"=>"Get an attribute value name", "description"=>"Gets the attribute value name. The attribute value ID and language must be specified.", "operationId"=>"getRestItemsAttributeValuesValueNamesLang", "x-api-path-slug"=>"restitemsattribute-valuesvalueidnameslang-get", "parameters"=>[{"in"=>"path", "name"=>"lang"}, {"in"=>"path", "name"=>"valueId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Value", "Name"]}, "put"=>{"summary"=>"Update an attribute value name", "description"=>"Updates an attribute value name.", "operationId"=>"putRestItemsAttributeValuesValueNamesLang", "x-api-path-slug"=>"restitemsattribute-valuesvalueidnameslang-put", "parameters"=>[{"in"=>"body", "name"=>"/rest/items/attribute_values/{valueId}/names/{lang}", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"lang"}, {"in"=>"path", "name"=>"valueId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Value", "Name"]}}, "/rest/items/attributes"=>{"get"=>{"summary"=>"List attributes", "description"=>"Lists all attributes.", "operationId"=>"getRestItemsAttributes", "x-api-path-slug"=>"restitemsattributes-get", "parameters"=>[{"in"=>"query", "name"=>"updatedAt", "description"=>"Filter restricts the list of results to items updated after the specified date"}, {"in"=>"query", "name"=>"with", "description"=>"Includes the specified attribute information in the results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attributes"]}, "post"=>{"summary"=>"Create an attribute", "description"=>"Creates an attribute.", "operationId"=>"postRestItemsAttributes", "x-api-path-slug"=>"restitemsattributes-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/items/attributes", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute"]}}, "/rest/items/attributes/maps"=>{"get"=>{"summary"=>"Lists all attribute maps.", "description"=>"Lists all attribute maps..", "operationId"=>"getRestItemsAttributesMaps", "x-api-path-slug"=>"restitemsattributesmaps-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "", "Attribute", "Maps"]}}, "/rest/items/attributes/markets/maps"=>{"post"=>{"summary"=>"Creates a new attribute map.", "description"=>"Creates a new attribute map..", "operationId"=>"postRestItemsAttributesMarketsMaps", "x-api-path-slug"=>"restitemsattributesmarketsmaps-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/items/attributes/markets/maps", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "New", "Attribute", "Map"]}}, "/rest/items/attributes/values/maps"=>{"get"=>{"summary"=>"Lists all attribute value maps.", "description"=>"Lists all attribute value maps..", "operationId"=>"getRestItemsAttributesValuesMaps", "x-api-path-slug"=>"restitemsattributesvaluesmaps-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "", "Attribute", "Value", "Maps"]}}, "/rest/items/attributes/values/markets/maps"=>{"post"=>{"summary"=>"Creates a new attribute value map.", "description"=>"Creates a new attribute value map..", "operationId"=>"postRestItemsAttributesValuesMarketsMaps", "x-api-path-slug"=>"restitemsattributesvaluesmarketsmaps-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/items/attributes/values/markets/maps", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "New", "Attribute", "Value", "Map"]}}, "/rest/items/attributes/{attributeId}/markets/{marketId}/maps"=>{"delete"=>{"summary"=>"Deletes an attribute map.", "description"=>"Deletes an attribute map. The ID of the attribute and the ID of the market must be specified.", "operationId"=>"deleteRestItemsAttributesAttributeMarketsMarketMaps", "x-api-path-slug"=>"restitemsattributesattributeidmarketsmarketidmaps-delete", "parameters"=>[{"in"=>"path", "name"=>"attributeId"}, {"in"=>"path", "name"=>"marketId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Attribute", "Map"]}, "get"=>{"summary"=>"Gets an attribute map.", "description"=>"Gets an attribute map. The ID of the attribute and the ID of the market must be specified.", "operationId"=>"getRestItemsAttributesAttributeMarketsMarketMaps", "x-api-path-slug"=>"restitemsattributesattributeidmarketsmarketidmaps-get", "parameters"=>[{"in"=>"path", "name"=>"attributeId"}, {"in"=>"path", "name"=>"marketId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Attribute", "Map"]}, "put"=>{"summary"=>"Updates an attribute map.", "description"=>"Updates an attribute map. The ID of the attribute and the ID of the market must be specified.", "operationId"=>"putRestItemsAttributesAttributeMarketsMarketMaps", "x-api-path-slug"=>"restitemsattributesattributeidmarketsmarketidmaps-put", "parameters"=>[{"in"=>"path", "name"=>"attributeId"}, {"in"=>"path", "name"=>"marketId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Attribute", "Map"]}}, "/rest/items/attributes/{attributeId}/names"=>{"get"=>{"summary"=>"Get an attribute name", "description"=>"Gets the attribute name in the specified language. The language code must be specified.", "operationId"=>"getRestItemsAttributesAttributeNames", "x-api-path-slug"=>"restitemsattributesattributeidnames-get", "parameters"=>[{"in"=>"path", "name"=>"attributeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Name"]}, "post"=>{"summary"=>"Create an attribute name", "description"=>"Creates an attribute name in the specified language. The language code must be specified.", "operationId"=>"postRestItemsAttributesAttributeNames", "x-api-path-slug"=>"restitemsattributesattributeidnames-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/items/attributes/{attributeId}/names", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"attributeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Name"]}}, "/rest/items/attributes/{attributeId}/names/{lang}"=>{"delete"=>{"summary"=>"Delete an attribute name", "description"=>"Deletes the attribute name in the specified language. The language code and attribute name must be specified.", "operationId"=>"deleteRestItemsAttributesAttributeNamesLang", "x-api-path-slug"=>"restitemsattributesattributeidnameslang-delete", "parameters"=>[{"in"=>"path", "name"=>"attributeId"}, {"in"=>"path", "name"=>"lang"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Name"]}, "get"=>{"summary"=>"List attribute names", "description"=>"Lists the attribute names of an attribute.", "operationId"=>"getRestItemsAttributesAttributeNamesLang", "x-api-path-slug"=>"restitemsattributesattributeidnameslang-get", "parameters"=>[{"in"=>"path", "name"=>"attributeId"}, {"in"=>"path", "name"=>"lang"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attribute", "Names"]}, "put"=>{"summary"=>"Update an attribute name", "description"=>"Updates the attribute name in the specified language. The language code and attribute name must be specified.", "operationId"=>"putRestItemsAttributesAttributeNamesLang", "x-api-path-slug"=>"restitemsattributesattributeidnameslang-put", "parameters"=>[{"in"=>"body", "name"=>"/rest/items/attributes/{attributeId}/names/{lang}", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"attributeId"}, {"in"=>"path", "name"=>"lang"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Name"]}}, "/rest/items/attributes/{attributeId}/value_market_names"=>{"get"=>{"summary"=>"Search attribute value market names", "description"=>"Search attribute value market names.", "operationId"=>"getRestItemsAttributesAttributeValueMarketNames", "x-api-path-slug"=>"restitemsattributesattributeidvalue-market-names-get", "parameters"=>[{"in"=>"path", "name"=>"attributeId"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"The number of items to list per page"}, {"in"=>"query", "name"=>"lang"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to search for"}, {"in"=>"query", "name"=>"referenceType"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Attribute", "Value", "Market", "Names"]}, "post"=>{"summary"=>"Create an attribute value market name", "description"=>"Creates an attribute value market name.", "operationId"=>"postRestItemsAttributesAttributeValueMarketNames", "x-api-path-slug"=>"restitemsattributesattributeidvalue-market-names-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/items/attributes/{attributeId}/value_market_names", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"attributeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Value", "Market", "Name"]}}, "/rest/items/attributes/{attributeId}/value_market_names/{valueId}/{lang}/{referenceType}"=>{"delete"=>{"summary"=>"Delete an attribute value market name", "description"=>"Deletes an attribute value market name. The attribute value ID and language must be specified.", "operationId"=>"deleteRestItemsAttributesAttributeValueMarketNamesValueLangReferencetype", "x-api-path-slug"=>"restitemsattributesattributeidvalue-market-namesvalueidlangreferencetype-delete", "parameters"=>[{"in"=>"path", "name"=>"attributeId"}, {"in"=>"path", "name"=>"lang"}, {"in"=>"path", "name"=>"referenceType"}, {"in"=>"path", "name"=>"valueId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Value", "Market", "Name"]}, "put"=>{"summary"=>"Update an attribute value market name", "description"=>"Updates an attribute value market name. The attribute value ID and language must be specified.", "operationId"=>"putRestItemsAttributesAttributeValueMarketNamesValueLangReferencetype", "x-api-path-slug"=>"restitemsattributesattributeidvalue-market-namesvalueidlangreferencetype-put", "parameters"=>[{"in"=>"body", "name"=>"/rest/items/attributes/{attributeId}/value_market_names/{valueId}/{lang}/{referenceType}", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"attributeId"}, {"in"=>"path", "name"=>"lang"}, {"in"=>"path", "name"=>"referenceType"}, {"in"=>"path", "name"=>"valueId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Value", "Market", "Name"]}}, "/rest/items/attributes/{attributeId}/values"=>{"get"=>{"summary"=>"List attribute values", "description"=>"Lists the attribute values for an attribute. The attribute ID must be specified.", "operationId"=>"getRestItemsAttributesAttributeValues", "x-api-path-slug"=>"restitemsattributesattributeidvalues-get", "parameters"=>[{"in"=>"path", "name"=>"attributeId"}, {"in"=>"query", "name"=>"updatedAt", "description"=>"Filter restricts the list of results to items updated after the specified date"}, {"in"=>"query", "name"=>"with", "description"=>"Includes the specified attribute value information in the results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attribute", "Values"]}, "post"=>{"summary"=>"Create an attribute value", "description"=>"Creates an attribute value.", "operationId"=>"postRestItemsAttributesAttributeValues", "x-api-path-slug"=>"restitemsattributesattributeidvalues-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/items/attributes/{attributeId}/values", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"attributeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Value"]}}, "/rest/items/attributes/{attributeId}/values/{attributeValueId}/markets/{marketId}/maps"=>{"delete"=>{"summary"=>"Deletes an attribute value map.", "description"=>"Deletes an attribute value map. The ID of the attribute, the ID of the attribute value and the ID of the market must be specified.", "operationId"=>"deleteRestItemsAttributesAttributeValuesAttributevalueMarketsMarketMaps", "x-api-path-slug"=>"restitemsattributesattributeidvaluesattributevalueidmarketsmarketidmaps-delete", "parameters"=>[{"in"=>"path", "name"=>"attributeId"}, {"in"=>"path", "name"=>"attributeValueId"}, {"in"=>"path", "name"=>"marketId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Attribute", "Value", "Map"]}, "get"=>{"summary"=>"Gets an attribute value map.", "description"=>"Gets an attribute value map. The ID of the attribute, the ID of the attribute value and the ID of the market must be specified.", "operationId"=>"getRestItemsAttributesAttributeValuesAttributevalueMarketsMarketMaps", "x-api-path-slug"=>"restitemsattributesattributeidvaluesattributevalueidmarketsmarketidmaps-get", "parameters"=>[{"in"=>"path", "name"=>"attributeId"}, {"in"=>"path", "name"=>"attributeValueId"}, {"in"=>"path", "name"=>"marketId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Attribute", "Value", "Map"]}, "put"=>{"summary"=>"Updates an attribute value map.", "description"=>"Updates an attribute value map. The ID of the attribute, the ID of the attribute value and the ID of the market must be specified.", "operationId"=>"putRestItemsAttributesAttributeValuesAttributevalueMarketsMarketMaps", "x-api-path-slug"=>"restitemsattributesattributeidvaluesattributevalueidmarketsmarketidmaps-put", "parameters"=>[{"in"=>"path", "name"=>"attributeId"}, {"in"=>"path", "name"=>"attributeValueId"}, {"in"=>"path", "name"=>"marketId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Attribute", "Value", "Map"]}}, "/rest/items/attributes/{attributeId}/values/{id}"=>{"delete"=>{"summary"=>"Delete an attribute value", "description"=>"Deletes an attribute value. The attribute ID must be specified.", "operationId"=>"deleteRestItemsAttributesAttributeValues", "x-api-path-slug"=>"restitemsattributesattributeidvaluesid-delete", "parameters"=>[{"in"=>"path", "name"=>"attributeId"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Value"]}, "get"=>{"summary"=>"Get an attribute value", "description"=>"Get an attribute value. The ID of the attribute value must be specified.", "operationId"=>"getRestItemsAttributesAttributeValues", "x-api-path-slug"=>"restitemsattributesattributeidvaluesid-get", "parameters"=>[{"in"=>"path", "name"=>"attributeId"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"with", "description"=>"Includes the specified attribute value information in the results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Value"]}, "put"=>{"summary"=>"Update an attribute value", "description"=>"Updates an attribute value. The attribute value must be specified.", "operationId"=>"putRestItemsAttributesAttributeValues", "x-api-path-slug"=>"restitemsattributesattributeidvaluesid-put", "parameters"=>[{"in"=>"body", "name"=>"/rest/items/attributes/{attributeId}/values/{id}", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"attributeId"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Value"]}}, "/rest/items/attributes/{id}"=>{"delete"=>{"summary"=>"Delete an attribute", "description"=>"Deletes an attribute. The ID of the attribute must be specified.", "operationId"=>"deleteRestItemsAttributes", "x-api-path-slug"=>"restitemsattributesid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute"]}, "get"=>{"summary"=>"Get an attribute", "description"=>"Gets an attribute. The ID of the attribute must be specified.", "operationId"=>"getRestItemsAttributes", "x-api-path-slug"=>"restitemsattributesid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"with", "description"=>"Includes the specified attribute information in the results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute"]}, "put"=>{"summary"=>"Update an attribute", "description"=>"Updates an attribute. The ID of the attribute must be specified.", "operationId"=>"putRestItemsAttributes", "x-api-path-slug"=>"restitemsattributesid-put", "parameters"=>[{"in"=>"body", "name"=>"/rest/items/attributes/{id}", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute"]}}, "/rest/items/barcodes"=>{"get"=>{"summary"=>"List barcodes", "description"=>"Lists all barcodes.", "operationId"=>"getRestItemsBarcodes", "x-api-path-slug"=>"restitemsbarcodes-get", "parameters"=>[{"in"=>"query", "name"=>"updatedAt", "description"=>"Filter restricts the list of results to items updated after the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Barcodes"]}, "post"=>{"summary"=>"Create a barcode", "description"=>"Creates a barcode.", "operationId"=>"postRestItemsBarcodes", "x-api-path-slug"=>"restitemsbarcodes-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/items/barcodes", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Barcode"]}}, "/rest/items/barcodes/referrer/{referrerId}"=>{"get"=>{"summary"=>"List barcodes by referrer", "description"=>"Lists barcodes linked to the specified referrer. The ID of the referrer must be specified.", "operationId"=>"getRestItemsBarcodesReferrerReferrer", "x-api-path-slug"=>"restitemsbarcodesreferrerreferrerid-get", "parameters"=>[{"in"=>"path", "name"=>"referrerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Barcodes", "By", "Referrer"]}}, "/rest/items/barcodes/type/{type}"=>{"get"=>{"summary"=>"List barcodes by type", "description"=>"Lists all barcodes of a specific type. The type must be specified.", "operationId"=>"getRestItemsBarcodesTypeType", "x-api-path-slug"=>"restitemsbarcodestypetype-get", "parameters"=>[{"in"=>"path", "name"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Barcodes", "By", "Type"]}}, "/rest/items/barcodes/{barcodeId}"=>{"delete"=>{"summary"=>"Delete a barcode", "description"=>"Deletes a barcode. The ID of the barcode must be specified.", "operationId"=>"deleteRestItemsBarcodesBarcode", "x-api-path-slug"=>"restitemsbarcodesbarcodeid-delete", "parameters"=>[{"in"=>"path", "name"=>"barcodeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Barcode"]}, "get"=>{"summary"=>"Get a barcode", "description"=>"Gets a barcode. The ID of the barcode must be specified.", "operationId"=>"getRestItemsBarcodesBarcode", "x-api-path-slug"=>"restitemsbarcodesbarcodeid-get", "parameters"=>[{"in"=>"path", "name"=>"barcodeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Barcode"]}, "put"=>{"summary"=>"Update a barcode", "description"=>"Updates a barcode. The ID of the barcode must be specified.", "operationId"=>"putRestItemsBarcodesBarcode", "x-api-path-slug"=>"restitemsbarcodesbarcodeid-put", "parameters"=>[{"in"=>"body", "name"=>"/rest/items/barcodes/{barcodeId}", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"barcodeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Barcode"]}}, "/rest/items/barcodes/{barcodeId}/referrer"=>{"post"=>{"summary"=>"Activate a referrer", "description"=>"Activate a referrer for a barcode.", "operationId"=>"postRestItemsBarcodesBarcodeReferrer", "x-api-path-slug"=>"restitemsbarcodesbarcodeidreferrer-post", "parameters"=>[{"in"=>"path", "name"=>"barcodeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activate", "Referrer"]}}, "/rest/items/barcodes/{barcodeId}/referrer/{referrerId}"=>{"delete"=>{"summary"=>"Deactivate a referrer", "description"=>"Deactivate a referrer for a barcode. The ID of the barcode and the ID of the referrer must be specified.", "operationId"=>"deleteRestItemsBarcodesBarcodeReferrerReferrer", "x-api-path-slug"=>"restitemsbarcodesbarcodeidreferrerreferrerid-delete", "parameters"=>[{"in"=>"path", "name"=>"barcodeId"}, {"in"=>"path", "name"=>"referrerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deactivate", "Referrer"]}}, "/rest/items/item_shipping_profiles"=>{"get"=>{"summary"=>"List all shipping profiles of all items", "description"=>"Lists all shipping profiles of all items. Results can be filtered by the timestamp of the link between items and shipping profiles (eq, lt, lte, gt, gte, between).\n
nextContinuationToken is returned. Use this token to get the next (up to) 1000 layout documents.\nUse the same request and include a field with the key continuationToken as well as the returned\ntoken from the previous call as the value.\n\nCheck the isTruncated field in the response to see if more results are available. If isTruncated is true,\nrepeat the request using the token from the nextContinuationToken field of the previous response to get all\nresults.", "operationId"=>"getRestStorageLayoutList", "x-api-path-slug"=>"reststoragelayoutlist-get", "parameters"=>[{"in"=>"query", "name"=>"continuationToken", "description"=>"Token for listing the next (up to) 1000 layout documents"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Layout", "Documents"]}}, "/rest/storage/layout/object-url"=>{"get"=>{"summary"=>"Get the URL for a layout document", "description"=>"Gets the URL of a layout document. The storage key must be specified. The returned URL expires after 10 minutes.", "operationId"=>"getRestStorageLayoutObjectUrl", "x-api-path-slug"=>"reststoragelayoutobjecturl-get", "parameters"=>[{"in"=>"query", "name"=>"key", "description"=>"The storage key for the layout document to retrieve the URL for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["URLa", "Layout", "Document"]}}, "/rest/storage/order-properties/object-url"=>{"get"=>{"summary"=>"Get the URL for a order property file", "description"=>"Gets the URL of a order property file. The storage key must be specified. The returned URL expires after 10\nminutes.", "operationId"=>"getRestStorageOrderPropertiesObjectUrl", "x-api-path-slug"=>"reststorageorderpropertiesobjecturl-get", "parameters"=>[{"in"=>"query", "name"=>"key", "description"=>"The storage key for the order property * file to retrieve the URL for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["URLa", "Order", "Property", "File"]}}, "/rest/storage/plugins/inbox"=>{"delete"=>{"summary"=>"Delete files from the inbox", "description"=>"Deletes a list of files from the inbox. A list of storage keys must be specified.", "operationId"=>"deleteRestStoragePluginsInbox", "x-api-path-slug"=>"reststoragepluginsinbox-delete", "parameters"=>[{"in"=>"query", "name"=>"keyList", "description"=>"List of storage keys for the files to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files", "From", "Inbox"]}, "post"=>{"summary"=>"Upload a file to the inbox", "description"=>"Uploads a file to the inbox. The storage key (i.e. file path) must be specified.", "operationId"=>"postRestStoragePluginsInbox", "x-api-path-slug"=>"reststoragepluginsinbox-post", "parameters"=>[{"in"=>"query", "name"=>"key", "description"=>"The storage key for the file to upload"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "File", "To", "Inbox"]}}, "/rest/storage/plugins/inbox/commit"=>{"post"=>{"summary"=>"", "description"=>".", "operationId"=>"postRestStoragePluginsInboxCommit", "x-api-path-slug"=>"reststoragepluginsinboxcommit-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/storage/plugins/inbox/list"=>{"get"=>{"summary"=>"List files from the inbox", "description"=>"Lists all files of all plugins stored in the inbox. A prefix can be specified to list all files of a specific\nplugin folder only.", "operationId"=>"getRestStoragePluginsInboxList", "x-api-path-slug"=>"reststoragepluginsinboxlist-get", "parameters"=>[{"in"=>"query", "name"=>"prefix", "description"=>"Prefix to list all files of a specific plugin folder only"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Files", "From", "Inbox"]}}, "/rest/storage/plugins/inbox/object-url"=>{"get"=>{"summary"=>"Get the content of a file from the inbox", "description"=>"Gets the content of a file stored in the inbox. The storage key (i.e. file path) must be specified.", "operationId"=>"getRestStoragePluginsInboxObjectUrl", "x-api-path-slug"=>"reststoragepluginsinboxobjecturl-get", "parameters"=>[{"in"=>"query", "name"=>"key", "description"=>"The storage key for the file to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content", "Of", "File", "From", "Inbox"]}}, "/rest/stores/{plentyId}/locations"=>{"get"=>{"summary"=>"Get the ID of an accounting location of a country", "description"=>"Gets the ID of an accounting location of a country. The plenty ID of the client and the ID of the country must be specified.", "operationId"=>"getRestStoresPlentyLocations", "x-api-path-slug"=>"reststoresplentyidlocations-get", "parameters"=>[{"in"=>"query", "name"=>"countryId", "description"=>"The ID of the country of the accounting location"}, {"in"=>"path", "name"=>"plentyId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ID", "Of", "Accounting", "Location", "Of", "Country"]}}, "/rest/system/cloud/metrics"=>{"get"=>{"summary"=>"Get the cloud metrics for this system", "description"=>"Get the cloud metrics for this system.", "operationId"=>"getRestSystemCloudMetrics", "x-api-path-slug"=>"restsystemcloudmetrics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cloud", "Metricsthis", "System"]}}, "/rest/system/metrics/{plentyId}/{date}"=>{"get"=>{"summary"=>"Supply usage data for given plentymarkets system", "description"=>"Supply usage data for given plentymarkets system.", "operationId"=>"getRestSystemMetricsPlentyDate", "x-api-path-slug"=>"restsystemmetricsplentyiddate-get", "parameters"=>[{"in"=>"path", "name"=>"date"}, {"in"=>"path", "name"=>"plentyId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Supply", "Usage", "Datagiven", "Plentymarkets", "System"]}}, "/rest/tickets"=>{"get"=>{"summary"=>"List tickets by filters", "description"=>"List tickets by filters.", "operationId"=>"getRestTickets", "x-api-path-slug"=>"resttickets-get", "parameters"=>[{"in"=>"query", "name"=>"confidential", "description"=>"Filter that restricts the search result to tickets of a specific confidential value"}, {"in"=>"query", "name"=>"contactId", "description"=>"Filter that restricts the search result to tickets with a specified contact ID"}, {"in"=>"query", "name"=>"customerClassId", "description"=>"Filter that restricts the search result to tickets with a specified customer class ID"}, {"in"=>"query", "name"=>"deadlineAt", "description"=>"Filter that restricts the search result to tickets with a specified deadline"}, {"in"=>"query", "name"=>"fulltext", "description"=>"Filter that restricts the search result to tickets with full-text search"}, {"in"=>"query", "name"=>"id", "description"=>"Filter that restricts the search result to tickets of a specific ticket ID"}, {"in"=>"query", "name"=>"ownerId", "description"=>"Filter that restricts the search result to tickets with a specified owner ID"}, {"in"=>"query", "name"=>"parentTicketId", "description"=>"Filter that restricts the search result to tickets with a specified parent ticket ID"}, {"in"=>"query", "name"=>"plentyId", "description"=>"Filter that restricts the search result to tickets with a specified client (store) ID"}, {"in"=>"query", "name"=>"priorityId", "description"=>"Filter that restricts the search result to tickets of a specific ticket priority ID"}, {"in"=>"query", "name"=>"progress", "description"=>"Filter that restricts the search result to tickets with a specified progress in percent"}, {"in"=>"query", "name"=>"resubmissionAt", "description"=>"Filter that restricts the search result to tickets with a specified resubmission date"}, {"in"=>"query", "name"=>"roleId", "description"=>"Filter that restricts the search result to tickets with a specified role ID"}, {"in"=>"query", "name"=>"source", "description"=>"Filter that restricts the search result to tickets with a specific source value"}, {"in"=>"query", "name"=>"statusGroupId", "description"=>"Filter that restricts the search result to tickets with a specified status group ID"}, {"in"=>"query", "name"=>"statusId", "description"=>"Filter that restricts the search result to tickets with a specified status ID"}, {"in"=>"query", "name"=>"title", "description"=>"Filter that restricts the search result to tickets with a specified phrase in title"}, {"in"=>"query", "name"=>"typeId", "description"=>"Filter that restricts the search result to tickets of specific ticket types"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Tickets", "By", "Filters"]}, "post"=>{"summary"=>"Create a ticket", "description"=>"Create a ticket.", "operationId"=>"postRestTickets", "x-api-path-slug"=>"resttickets-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/tickets", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket"]}}, "/rest/tickets/status/names"=>{"get"=>{"summary"=>"", "description"=>".", "operationId"=>"getRestTicketsStatusNames", "x-api-path-slug"=>"restticketsstatusnames-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/tickets/status/type/names"=>{"get"=>{"summary"=>"", "description"=>".", "operationId"=>"getRestTicketsStatusTypeNames", "x-api-path-slug"=>"restticketsstatustypenames-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/tickets/types/names"=>{"get"=>{"summary"=>"", "description"=>".", "operationId"=>"getRestTicketsTypesNames", "x-api-path-slug"=>"restticketstypesnames-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/tickets/{ticketId}"=>{"post"=>{"summary"=>"Create a message", "description"=>"Creates a message for the ticket. The ID of the ticket must be specified.", "operationId"=>"postRestTicketsTicket", "x-api-path-slug"=>"restticketsticketid-post", "parameters"=>[{"in"=>"path", "name"=>"ticketId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}, "put"=>{"summary"=>"Update a ticket", "description"=>"Updates a ticket. The ID of the ticket must be specified.", "operationId"=>"putRestTicketsTicket", "x-api-path-slug"=>"restticketsticketid-put", "parameters"=>[{"in"=>"path", "name"=>"ticketId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket"]}}, "/rest/user"=>{"get"=>{"summary"=>"", "description"=>".", "operationId"=>"getRestUser", "x-api-path-slug"=>"restuser-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/user/authorized_user_with_ui_config"=>{"get"=>{"summary"=>"Get authorized user with UiConfig", "description"=>"Gets an authorized user with UiConfig. This call returns a JSON object with information about the user after login. This information is used for correctly displaying the plentymarkets back end.", "operationId"=>"getRestUserAuthorizedUserWithUiConfig", "x-api-path-slug"=>"restuserauthorized-user-with-ui-config-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorized", "User", "UiConfig"]}}, "/rest/user/backend_pluginset"=>{"get"=>{"summary"=>"get the backend plugin set for user", "description"=>"Get the backend plugin set for user.", "operationId"=>"getRestUserBackendPluginset", "x-api-path-slug"=>"restuserbackend-pluginset-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Backend", "Plugin", "Setuser"]}, "post"=>{"summary"=>"set the backend plugin set for user", "description"=>"Set the backend plugin set for user.", "operationId"=>"postRestUserBackendPluginset", "x-api-path-slug"=>"restuserbackend-pluginset-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Backend", "Plugin", "Setuser"]}}, "/rest/vat"=>{"get"=>{"summary"=>"List VAT configurations.", "description"=>"Lists the VAT configurations for the given filter. Possible filters are locationId, countryId, taxIdNumber and startedAt.", "operationId"=>"getRestVat", "x-api-path-slug"=>"restvat-get", "parameters"=>[{"in"=>"query", "name"=>"columns", "description"=>"The properties to be loaded"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"The number of items per page"}, {"in"=>"query", "name"=>"page", "description"=>"The requested page"}, {"in"=>"query", "name"=>"with", "description"=>"The relations to load with the VAT object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "VAT", "Configurations"]}, "post"=>{"summary"=>"Create a VAT configuration", "description"=>"Create a vat configuration.", "operationId"=>"postRestVat", "x-api-path-slug"=>"restvat-post", "parameters"=>[{"in"=>"body", "name"=>"/rest/vat", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VAT", "Configuration"]}}, "/rest/vat/locations/{locationId}"=>{"get"=>{"summary"=>"List VAT configurations of an accounting location", "description"=>"Lists the VAT configurations for all countries of one accounting location", "operationId"=>"getRestVatLocationsLocation", "x-api-path-slug"=>"restvatlocationslocationid-get", "parameters"=>[{"in"=>"query", "name"=>"columns[]", "description"=>"The attributes of the VAT configuration"}, {"in"=>"path", "name"=>"locationId"}, {"in"=>"query", "name"=>"with[]", "description"=>"The relations to load with the VAT object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "VAT", "Configurations", "Of", "Accounting", "Location"]}}, "/rest/vat/locations/{locationId}/countries/{countryId}"=>{"get"=>{"summary"=>"List VAT configurations for one country of delivery", "description"=>"Lists the VAT configurations for a country of delivery of one accounting location. The ID of the accounting location and the ID of the country of delivery must be specified.", "operationId"=>"getRestVatLocationsLocationCountriesCountry", "x-api-path-slug"=>"restvatlocationslocationidcountriescountryid-get", "parameters"=>[{"in"=>"query", "name"=>"columns[]", "description"=>"The attributes of the VAT configuration"}, {"in"=>"path", "name"=>"countryId"}, {"in"=>"path", "name"=>"locationId"}, {"in"=>"query", "name"=>"with[]", "description"=>"The relations to load with the VAT object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "VAT", "Configurationsone", "Country", "Of", "Delivery"]}}, "/rest/vat/locations/{locationId}/countries/{countryId}/date/{date}"=>{"get"=>{"summary"=>"Get a VAT configuration for a country in a location.", "description"=>"Gets the VAT configuration found by matching the given location, delivery country and date of validity.", "operationId"=>"getRestVatLocationsLocationCountriesCountryDateDate", "x-api-path-slug"=>"restvatlocationslocationidcountriescountryiddatedate-get", "parameters"=>[{"in"=>"query", "name"=>"columns[]", "description"=>"The attributes of the VAT configuration"}, {"in"=>"path", "name"=>"countryId"}, {"in"=>"path", "name"=>"date"}, {"in"=>"path", "name"=>"locationId"}, {"in"=>"query", "name"=>"startDate", "description"=>"The date of validity"}, {"in"=>"query", "name"=>"with[]", "description"=>"The relations to load with the VAT object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VAT", "Configurationa", "Country", "In", "Location"]}}, "/rest/vat/standard"=>{"get"=>{"summary"=>"Get a VAT configuration for the standard accounting location of a client", "description"=>"Gets the VAT configuration currently used for the country of the standard accounting location of a client (store). The ID of the client (store) must be specified.", "operationId"=>"getRestVatStandard", "x-api-path-slug"=>"restvatstandard-get", "parameters"=>[{"in"=>"query", "name"=>"plentyId", "description"=>"The plenty ID of the client (store)"}, {"in"=>"query", "name"=>"startedAt", "description"=>"The date in the W3C format when the vat configuration went into effect"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VAT", "Configurationthe", "Standard", "Accounting", "Location", "Of", "Client"]}}, "/rest/vat/{vatId}"=>{"get"=>{"summary"=>"Get a VAT configuration by id", "description"=>"Get a vat configuration by id.", "operationId"=>"getRestVatVat", "x-api-path-slug"=>"restvatvatid-get", "parameters"=>[{"in"=>"path", "name"=>"vatId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VAT", "Configuration", "By", "Id"]}, "put"=>{"summary"=>"Update a VAT configuration", "description"=>"Update a vat configuration.", "operationId"=>"putRestVatVat", "x-api-path-slug"=>"restvatvatid-put", "parameters"=>[{"in"=>"body", "name"=>"/rest/vat/{vatId}", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"vatId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VAT", "Configuration"]}}, "/rest/warehouses/layouts"=>{"post"=>{"summary"=>"Create a warehouse location layout", "description"=>"Creates a warehouse location layout", "operationId"=>"postRestWarehousesLayouts", "x-api-path-slug"=>"restwarehouseslayouts-post", "parameters"=>[{"in"=>"query", "name"=>"dimensionId", "description"=>"The warehouse location dimension ID of the warehouse location level"}, {"in"=>"query", "name"=>"isActiveForPickupPath", "description"=>"Active flag for pickup path of the warehouse location dimension"}, {"in"=>"query", "name"=>"label", "description"=>"The label of the warehouse location"}, {"in"=>"query", "name"=>"level", "description"=>"The level of the warehouse location dimension"}, {"in"=>"query", "name"=>"levelId", "description"=>"The warehouse location level ID of the warehouse location"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the warehouse location dimension"}, {"in"=>"query", "name"=>"parentId", "description"=>"The parent ID of the warehouse location dimension"}, {"in"=>"query", "name"=>"position", "description"=>"The position of the warehouse location level"}, {"in"=>"query", "name"=>"purposeKey", "description"=>"The location type key of the warehouse location"}, {"in"=>"query", "name"=>"separator", "description"=>"The separator of the warehouse location dimension"}, {"in"=>"query", "name"=>"shortcut", "description"=>"The shortcut of the warehouse location dimension"}, {"in"=>"query", "name"=>"statusKey", "description"=>"The location status key of the warehouse location"}, {"in"=>"query", "name"=>"warehouseId", "description"=>"The warehouse ID of the warehouse location dimension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse", "Location", "Layout"]}}, "/rest/warehouses/locations"=>{"delete"=>{"summary"=>"Delete multiple warehouse locations", "description"=>"Deletes multiple warehouse locations", "operationId"=>"deleteRestWarehousesLocations", "x-api-path-slug"=>"restwarehouseslocations-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multiple", "Warehouse", "Locations"]}, "post"=>{"summary"=>"Create a warehouse location", "description"=>"Creates a warehouse location.", "operationId"=>"postRestWarehousesLocations", "x-api-path-slug"=>"restwarehouseslocations-post", "parameters"=>[{"in"=>"query", "name"=>"label", "description"=>"The label of the warehouse location"}, {"in"=>"query", "name"=>"levelId", "description"=>"The warehouse location level ID of the warehouse location"}, {"in"=>"query", "name"=>"position", "description"=>"The position of the warehouse location"}, {"in"=>"query", "name"=>"purposeKey", "description"=>"The location type key of the warehouse location"}, {"in"=>"query", "name"=>"statusKey", "description"=>"The location status key of the warehouse location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse", "Location"]}}, "/rest/warehouses/locations/details"=>{"get"=>{"summary"=>"Get warehouse location details", "description"=>"Gets warehouse location details", "operationId"=>"getRestWarehousesLocationsDetails", "x-api-path-slug"=>"restwarehouseslocationsdetails-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse", "Location", "Details"]}}, "/rest/warehouses/locations/dimensions"=>{"post"=>{"summary"=>"Create a warehouse location dimension", "description"=>"Creates a warehouse location dimension.", "operationId"=>"postRestWarehousesLocationsDimensions", "x-api-path-slug"=>"restwarehouseslocationsdimensions-post", "parameters"=>[{"in"=>"query", "name"=>"isActiveForPickupPath", "description"=>"Active flag for pickup path of the warehouse location dimension"}, {"in"=>"query", "name"=>"level", "description"=>"The level of the warehouse location dimension"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the warehouse location dimension"}, {"in"=>"query", "name"=>"parentId", "description"=>"The parent ID of the warehouse location dimension"}, {"in"=>"query", "name"=>"separator", "description"=>"The separator of the warehouse location dimension"}, {"in"=>"query", "name"=>"shortcut", "description"=>"The shortcut of the warehouse location dimension"}, {"in"=>"query", "name"=>"warehouseId", "description"=>"The warehouse ID of the warehouse location dimension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse", "Location", "Dimension"]}}, "/rest/warehouses/locations/dimensions/{warehouseLocationDimensionId}"=>{"delete"=>{"summary"=>"Delete a warehouse location dimension", "description"=>"Deletes a warehouse location dimension", "operationId"=>"deleteRestWarehousesLocationsDimensionsWarehouselocationdimension", "x-api-path-slug"=>"restwarehouseslocationsdimensionswarehouselocationdimensionid-delete", "parameters"=>[{"in"=>"path", "name"=>"warehouseLocationDimensionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse", "Location", "Dimension"]}, "get"=>{"summary"=>"Get a warehouse location dimension", "description"=>"Gets a warehouse location dimension by ID. The warehouse location ID is required.", "operationId"=>"getRestWarehousesLocationsDimensionsWarehouselocationdimension", "x-api-path-slug"=>"restwarehouseslocationsdimensionswarehouselocationdimensionid-get", "parameters"=>[{"in"=>"path", "name"=>"warehouseLocationDimensionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse", "Location", "Dimension"]}, "put"=>{"summary"=>"Update a warehouse location dimension", "description"=>"Updates a warehouse location dimension", "operationId"=>"putRestWarehousesLocationsDimensionsWarehouselocationdimension", "x-api-path-slug"=>"restwarehouseslocationsdimensionswarehouselocationdimensionid-put", "parameters"=>[{"in"=>"path", "name"=>"warehouseLocationDimensionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse", "Location", "Dimension"]}}, "/rest/warehouses/locations/group"=>{"put"=>{"summary"=>"Edit the purpose and status for a group of storage locations", "description"=>"Edits the purpose and status for a group of storage locations by passing the group storage location ID (can be sent as mass assignment)", "operationId"=>"putRestWarehousesLocationsGroup", "x-api-path-slug"=>"restwarehouseslocationsgroup-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Purpose", "Statusa", "Group", "Of", "Storage", "Locations"]}}, "/rest/warehouses/locations/levels"=>{"post"=>{"summary"=>"Create a warehouse location level", "description"=>"Creates a warehouse location level.", "operationId"=>"postRestWarehousesLocationsLevels", "x-api-path-slug"=>"restwarehouseslocationslevels-post", "parameters"=>[{"in"=>"query", "name"=>"dimensionId", "description"=>"The warehouse location dimension ID of the warehouse location level"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the warehouse location level"}, {"in"=>"query", "name"=>"parentId", "description"=>"The parent ID of the warehouse location level"}, {"in"=>"query", "name"=>"position", "description"=>"The position of the warehouse location level"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse", "Location", "Level"]}}, "/rest/warehouses/locations/levels/{warehouseLocationLevelId}"=>{"delete"=>{"summary"=>"Delete a warehouse location level", "description"=>"Deletes a warehouse location level", "operationId"=>"deleteRestWarehousesLocationsLevelsWarehouselocationlevel", "x-api-path-slug"=>"restwarehouseslocationslevelswarehouselocationlevelid-delete", "parameters"=>[{"in"=>"path", "name"=>"warehouseLocationLevelId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse", "Location", "Level"]}, "get"=>{"summary"=>"Get a warehouse location level", "description"=>"Gets a warehouse location level by ID. The warehouse location ID is required.", "operationId"=>"getRestWarehousesLocationsLevelsWarehouselocationlevel", "x-api-path-slug"=>"restwarehouseslocationslevelswarehouselocationlevelid-get", "parameters"=>[{"in"=>"path", "name"=>"warehouseLocationLevelId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse", "Location", "Level"]}, "put"=>{"summary"=>"Update a warehouse location level", "description"=>"Updates a warehouse location level", "operationId"=>"putRestWarehousesLocationsLevelsWarehouselocationlevel", "x-api-path-slug"=>"restwarehouseslocationslevelswarehouselocationlevelid-put", "parameters"=>[{"in"=>"path", "name"=>"warehouseLocationLevelId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse", "Location", "Level"]}}, "/rest/warehouses/locations/multiple_dimensions"=>{"post"=>{"summary"=>"Create multiple warehouse location dimensions", "description"=>"Creates multiple warehouse location dimension.", "operationId"=>"postRestWarehousesLocationsMultipleDimensions", "x-api-path-slug"=>"restwarehouseslocationsmultiple-dimensions-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multiple", "Warehouse", "Location", "Dimensions"]}}, "/rest/warehouses/locations/previews"=>{"post"=>{"summary"=>"Generate warehouse location preview and saves it", "description"=>"Generates warehouse location preview and saves it", "operationId"=>"postRestWarehousesLocationsPreviews", "x-api-path-slug"=>"restwarehouseslocationspreviews-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generate", "Warehouse", "Location", "Preview", "Saves", "It"]}}, "/rest/warehouses/locations/{warehouseId}/label"=>{"get"=>{"summary"=>"Generate the warehouse location label", "description"=>"Generates the warehouse location label", "operationId"=>"getRestWarehousesLocationsWarehouseLabel", "x-api-path-slug"=>"restwarehouseslocationswarehouseidlabel-get", "parameters"=>[{"in"=>"path", "name"=>"warehouseId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generate", "Warehouse", "Location", "Label"]}}, "/rest/warehouses/locations/{warehouseLocationId}"=>{"delete"=>{"summary"=>"Delete a warehouse location", "description"=>"Deletes a warehouse location", "operationId"=>"deleteRestWarehousesLocationsWarehouselocation", "x-api-path-slug"=>"restwarehouseslocationswarehouselocationid-delete", "parameters"=>[{"in"=>"path", "name"=>"warehouseLocationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse", "Location"]}, "get"=>{"summary"=>"Get a warehouse location", "description"=>"Gets a warehouse location by ID. The warehouse location ID is required.", "operationId"=>"getRestWarehousesLocationsWarehouselocation", "x-api-path-slug"=>"restwarehouseslocationswarehouselocationid-get", "parameters"=>[{"in"=>"path", "name"=>"warehouseLocationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse", "Location"]}, "put"=>{"summary"=>"Update a warehouse location", "description"=>"Updates a warehouse location", "operationId"=>"putRestWarehousesLocationsWarehouselocation", "x-api-path-slug"=>"restwarehouseslocationswarehouselocationid-put", "parameters"=>[{"in"=>"path", "name"=>"warehouseLocationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse", "Location"]}}, "/rest/warehouses/structure/{warehouseId}"=>{"get"=>{"summary"=>"Get a warehouse location structure", "description"=>"Gets a warehouse location structure by warehouse ID. The warehouse ID is required.", "operationId"=>"getRestWarehousesStructureWarehouse", "x-api-path-slug"=>"restwarehousesstructurewarehouseid-get", "parameters"=>[{"in"=>"path", "name"=>"warehouseId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse", "Location", "Structure"]}}, "/rest/warehouses/{warehouseId}/locations"=>{"get"=>{"summary"=>"List warehouse locations", "description"=>"Lists all warehouse locations.", "operationId"=>"getRestWarehousesWarehouseLocations", "x-api-path-slug"=>"restwarehouseswarehouseidlocations-get", "parameters"=>[{"in"=>"path", "name"=>"warehouseId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Warehouse", "Locations"]}}, "/rest/warehouses/{warehouseId}/locations/dimensions"=>{"get"=>{"summary"=>"List warehouse location dimensions", "description"=>"Lists all warehouse location dimensions.", "operationId"=>"getRestWarehousesWarehouseLocationsDimensions", "x-api-path-slug"=>"restwarehouseswarehouseidlocationsdimensions-get", "parameters"=>[{"in"=>"path", "name"=>"warehouseId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Warehouse", "Location", "Dimensions"]}}, "/rest/warehouses/{warehouseId}/locations/levels"=>{"get"=>{"summary"=>"List warehouse location levels", "description"=>"Lists all warehouse location levels.", "operationId"=>"getRestWarehousesWarehouseLocationsLevels", "x-api-path-slug"=>"restwarehouseswarehouseidlocationslevels-get", "parameters"=>[{"in"=>"path", "name"=>"warehouseId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Warehouse", "Location", "Levels"]}}, "/rest/webstores"=>{"get"=>{"summary"=>"List clients (stores)", "description"=>"List clients (stores).", "operationId"=>"getRestWebstores", "x-api-path-slug"=>"restwebstores-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Clients", "(stores)"]}}, "/rest/webstores/{webstoreId}/plugin_set"=>{"get"=>{"summary"=>"", "description"=>".", "operationId"=>"getRestWebstoresWebstorePluginSet", "x-api-path-slug"=>"restwebstoreswebstoreidplugin-set-get", "parameters"=>[{"in"=>"path", "name"=>"webstoreId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"", "description"=>".", "operationId"=>"postRestWebstoresWebstorePluginSet", "x-api-path-slug"=>"restwebstoreswebstoreidplugin-set-post", "parameters"=>[{"in"=>"path", "name"=>"webstoreId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"Plentymarkets", "x-slug"=>"plentymarkets", "description"=>"plentymarkets is an all-in-one e-commerce ERP solution, which combines a comprehensive stock management system with a versatile shop system and effortless multichannel sales. Thanks to comprehensive functions and interfaces that include all steps of the e-commerce value chain, you can use the cloud based software to completely automate all of your e-business processes as well as your companys own individual processes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/plentymarkets.png", "x-kinRank"=>"7", "x-alexaRank"=>"", "tags"=>"ERP,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"plentymarkets/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Plentymarkets", "x-api-slug"=>"plentymarkets", "description"=>"plentymarkets is an all-in-one e-commerce ERP solution, which combines a comprehensive stock management system with a versatile shop system and effortless multichannel sales. Thanks to comprehensive functions and interfaces that include all steps of the e-commerce value chain, you can use the cloud based software to completely automate all of your e-business processes as well as your companys own individual processes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/plentymarkets.png", "humanURL"=>"http://www.plentymarkets.co.uk", "baseURL"=>"https://example.com//", "tags"=>"ERP,Relative Data,Service API", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/plentymarkets/plentymarkets-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog-rss", "url"=>"https://www.plentymarkets.co.uk/?ActionCall=WebActionRSS&rrss_id=1"}, {"type"=>"x-github", "url"=>"https://github.com/plentymarkets"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/plentymarketsuk"}, {"type"=>"x-website", "url"=>"http://www.plentymarkets.co.uk"}, {"type"=>"x-blog", "url"=>"https://www.plentymarkets.co.uk/blog/"}, {"type"=>"x-pricing", "url"=>"https://www.plentymarkets.co.uk/prices/"}, {"type"=>"x-website", "url"=>"https://www.plentymarkets.co.uk"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
tyk{"tyk-api-management-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Tyk", "x-complete"=>1, "info"=>{"title"=>"Tyk Gateway REST API", "description"=>"the-api-for-managing-the-tyk-api-management-gateway-allowing-api-control-over-the-operation-of-a-variety-of-apis-", "termsOfService"=>"https://tyk.io/terms-and-conditions/", "version"=>"1.9"}, "host"=>"{baseURL}", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/tyk/keys/"=>{"get"=>{"summary"=>"Get Keys", "description"=>"Gets a list of *key* IDs (will only work with non-hashed installations)", "operationId"=>"gets-a-list-of-key-ids-will-only-work-with-nonhashed-installations", "x-api-path-slug"=>"tykkeys-get", "parameters"=>[{"in"=>"query", "name"=>"api_id", "description"=>"Back-end to target"}, {"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Key"]}}, "/tyk/keys/create"=>{"post"=>{"summary"=>"Create Key", "description"=>"Create a new *API token* with the *session object* defined in the body", "operationId"=>"create-a-new-api-token-with-the-session-object-defined-in-the-body", "x-api-path-slug"=>"tykkeyscreate-post", "parameters"=>[{"in"=>"body", "name"=>"session_object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"suppress_reset", "description"=>"Adding the `suppress_reset` parameter and setting it to `1`, will cause Tyk to not reset the quota limit that is in the current live quota manager"}, {"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Key"]}}, "/tyk/keys/{keyId}"=>{"put"=>{"summary"=>"Update Key", "description"=>"Update an *API token* with the *session object* defined in the body, this operatin overwrites the existing object", "operationId"=>"update-an-api-token-with-the-session-object-defined-in-the-body-this-operatin-overwrites-the-existin", "x-api-path-slug"=>"tykkeyskeyid-put", "parameters"=>[{"in"=>"query", "name"=>"api_id", "description"=>"Back-end to target"}, {"in"=>"path", "name"=>"keyId", "description"=>"Access Token"}, {"in"=>"body", "name"=>"session_object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"suppress_reset", "description"=>"Adding the `suppress_reset` parameter and setting it to `1`, will cause Tyk to not reset the quota limit that is in the current live quota manager"}, {"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Key"]}, "post"=>{"summary"=>"Add Custom Key", "description"=>"Add a pre-specified *API token* with the *session object* defined in the body, this operatin creates a custom token that dsoes not use the gateway naming convention for tokens", "operationId"=>"add-a-prespecified-api-token-with-the-session-object-defined-in-the-body-this-operatin-creates-a-cus", "x-api-path-slug"=>"tykkeyskeyid-post", "parameters"=>[{"in"=>"path", "name"=>"keyId", "description"=>"Access Token"}, {"in"=>"body", "name"=>"session_object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Key"]}, "delete"=>{"summary"=>"Remove Key", "description"=>"Remove this *API token* from the gateway, this will completely destroy the token and metadata associated with the token and instantly stop access from being granted", "operationId"=>"remove-this-api-token-from-the-gateway-this-will-completely-destroy-the-token-and-metadata-associate", "x-api-path-slug"=>"tykkeyskeyid-delete", "parameters"=>[{"in"=>"query", "name"=>"api_id", "description"=>"Back-end to target"}, {"in"=>"path", "name"=>"keyId", "description"=>"Access Token"}, {"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Key"]}}, "/tyk/apis/"=>{"get"=>{"summary"=>"Get APIs", "description"=>"Gets a list of *API Definition* objects that are currently live on the gateway", "operationId"=>"gets-a-list-of-api-definition-objects-that-are-currently-live-on-the-gateway", "x-api-path-slug"=>"tykapis-get", "parameters"=>[{"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API"]}, "post"=>{"summary"=>"Create API", "description"=>"Create an *API Definition* object", "operationId"=>"create-an-api-definition-object", "x-api-path-slug"=>"tykapis-post", "parameters"=>[{"in"=>"body", "name"=>"api_definition", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API"]}}, "/tyk/apis/{apiID}"=>{"get"=>{"summary"=>"Get API", "description"=>"Gets an *API Definition* object, if it exists", "operationId"=>"gets-an-api-definition-object-if-it-exists", "x-api-path-slug"=>"tykapisapiid-get", "parameters"=>[{"in"=>"path", "name"=>"apiID", "description"=>"API ID"}, {"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API"]}, "delete"=>{"summary"=>"Delete API", "description"=>"Deletes an *API Definition* object, if it exists", "operationId"=>"deletes-an-api-definition-object-if-it-exists", "x-api-path-slug"=>"tykapisapiid-delete", "parameters"=>[{"in"=>"path", "name"=>"apiID", "description"=>"API ID"}, {"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API"]}, "put"=>{"summary"=>"Update API", "description"=>"Updates an *API Definition* object, if it exists", "operationId"=>"updates-an-api-definition-object-if-it-exists", "x-api-path-slug"=>"tykapisapiid-put", "parameters"=>[{"in"=>"path", "name"=>"apiID", "description"=>"API ID"}, {"in"=>"body", "name"=>"api_definition", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API"]}}, "/tyk/health/"=>{"get"=>{"summary"=>"Check Health", "description"=>"Gets the health check values for an API if it is being recorded", "operationId"=>"gets-the-health-check-values-for-an-api-if-it-is-being-recorded", "x-api-path-slug"=>"tykhealth-get", "parameters"=>[{"in"=>"query", "name"=>"api_id", "description"=>"API ID to query"}, {"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Health"]}}, "/tyk/reload/"=>{"get"=>{"summary"=>"Reload Gateway", "description"=>"Will reload the targetted gateway", "operationId"=>"will-reload-the-targetted-gateway", "x-api-path-slug"=>"tykreload-get", "parameters"=>[{"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Reload"]}}, "/tyk/reload/group"=>{"get"=>{"summary"=>"Reload Group", "description"=>"Will reload the cluster via the targeted gateway", "operationId"=>"will-reload-the-cluster-via-the-targeted-gateway", "x-api-path-slug"=>"tykreloadgroup-get", "parameters"=>[{"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Reload"]}}, "/tyk/oauth/clients/create"=>{"post"=>{"summary"=>"OAuth Create Client", "description"=>"Create a new OAuth client", "operationId"=>"create-a-new-oauth-client", "x-api-path-slug"=>"tykoauthclientscreate-post", "parameters"=>[{"in"=>"body", "name"=>"oauth_client", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OAuth"]}}, "/tyk/oauth/clients/{apiId}/{clientId}"=>{"delete"=>{"summary"=>"Delete Client", "description"=>"Delete the OAuth client", "operationId"=>"delete-the-oauth-client", "x-api-path-slug"=>"tykoauthclientsapiidclientid-delete", "parameters"=>[{"in"=>"path", "name"=>"apiId", "description"=>"API ID that owns this client (back end)"}, {"in"=>"path", "name"=>"clientId", "description"=>"OAuth Client ID to delete"}, {"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OAuth"]}}, "/tyk/oauth/clients/{apiId}"=>{"get"=>{"summary"=>"OAuth Get Clients", "description"=>"Get a list of OAuth clients bound to this back end", "operationId"=>"get-a-list-of-oauth-clients-bound-to-this-back-end", "x-api-path-slug"=>"tykoauthclientsapiid-get", "parameters"=>[{"in"=>"path", "name"=>"apiId", "description"=>"API ID that owns this client (back end)"}, {"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OAuth"]}}, "/tyk/oauth/authorize-client/"=>{"post"=>{"summary"=>"OAuth Authorize Client", "description"=>"The final request from an authorising party for a redirect URI during the Tyk OAuth flow", "operationId"=>"the-final-request-from-an-authorising-party-for-a-redirect-uri-during-the-tyk-oauth-flow", "x-api-path-slug"=>"tykoauthauthorizeclient-post", "parameters"=>[{"in"=>"formData", "name"=>"client_id", "description"=>"Should be provided by requesting client as part of authorisation request"}, {"in"=>"formData", "name"=>"key_rules", "description"=>"A string representation of a *Session Object (form-encoded)*"}, {"in"=>"formData", "name"=>"redirect_uri", "description"=>"Should be provided by requesting client as part of authorisation request"}, {"in"=>"formData", "name"=>"response_type", "description"=>"Should be provided by requesting client as part of authorisation request, this should be either `code` or `token` depending on the methods you have specified for the API"}, {"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OAuth"]}}, "/tyk/oauth/refresh/{keyId}"=>{"delete"=>{"summary"=>"Invalidate Key", "description"=>"Invalidate a refresh token", "operationId"=>"invalidate-a-refresh-token", "x-api-path-slug"=>"tykoauthrefreshkeyid-delete", "parameters"=>[{"in"=>"query", "name"=>"apiID", "description"=>"API ID"}, {"in"=>"path", "name"=>"keyId", "description"=>"Access Token"}, {"in"=>"header", "name"=>"x-tyk-authorization", "description"=>"tyk gateway shared secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OAuth"]}}}}, "apis"=>{"name"=>"Tyk", "x-slug"=>"tyk", "description"=>"Tyk - Open Source API Gateway, API Management Platform, Developer Portal and Analytics - Tyk", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11408-tyk.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"489034", "tags"=>"API Deployment Gateways,Deployments,Management,Relative Data,SaaS,SDIO Partner,Service API,Stack Network,Technology,Tyk API Management,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"tyk/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Tyk API Management", "x-api-slug"=>"tyk-api-management", "description"=>"Tyk - Open Source API Gateway, API Management Platform, Developer Portal and Analytics - Tyk", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11408-tyk.jpg", "humanURL"=>"http://www.tyk.io", "baseURL"=>"https://{baseURL}//", "tags"=>"API Deployment Gateways,Deployments,Management,Relative Data,SaaS,SDIO Partner,Service API,Stack Network,Technology,Tyk API Management,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/tyk/tyk-api-management-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://www.tyk.io"}, {"type"=>"x-blog", "url"=>"https://tyk.io/news-2/"}, {"type"=>"x-blog-rss", "url"=>"https://tyk.io/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/tyk-technologies-ltd"}, {"type"=>"x-github", "url"=>"https://github.com/TykTechnologies"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/tyk_io"}, {"type"=>"x-webhook", "url"=>"https://tyk.io/docs/report-monitor-trigger-events/webhooks/"}, {"type"=>"x-website", "url"=>"http://tyk.io/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rackspace{"rackspace-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Rackspace", "x-complete"=>1, "info"=>{"title"=>"Rackspace", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1.0/{account}/limits\n"=>{"get"=>{"summary"=>"List limits", "description"=>"This call provides a list of all applicable limits for a specified account.The following examples show the requests and corresponding responses to list\nall limits for the specified account.", "operationId"=>"list-limits", "x-api-path-slug"=>"v1-0accountlimits-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>" | string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Limits"]}}, "/v1.0/{account}/limits/{type}\n"=>{"get"=>{"summary"=>"Show limits", "description"=>"This call provides a list of all applicable limits of a specified type for\nthe specified account.The following examples show the requests and corresponding responses to list\nall applicable limits of a specified type for the specified account.", "operationId"=>"show-limits", "x-api-path-slug"=>"v1-0accountlimitstype-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"type", "description"=>"The type of limit", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Limits"]}}, "/v1.0/{account}/limits/types\n"=>{"get"=>{"summary"=>"List limit types", "description"=>"This call provides a list of all applicable limit types for a specified account.The following examples show the requests and corresponding responses to list\nall limit types for the specified account.", "operationId"=>"list-limit-types", "x-api-path-slug"=>"v1-0accountlimitstypes-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Limits"]}}, "/v1.0/{account}/domains\n"=>{"get"=>{"summary"=>"List domains", "description"=>"These calls provide a list of all DNS domains manageable by a given account.\nThe resulting list is flat, and does not break the domains down hierarchically\nby subdomain. All representative domains are included in the list, even if a\ndomain is conceptually a subdomain of another domain in the list.Note", "operationId"=>"list-domains", "x-api-path-slug"=>"v1-0accountdomains-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}, "post"=>{"summary"=>"Create domain", "description"=>"NoteThis call returns an asynchronous response, See\nSynchronous and asynchronous responses\nfor more details and examples of the way that asynchronous responses work.", "operationId"=>"create-domain", "x-api-path-slug"=>"v1-0accountdomains-post", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}, "put"=>{"summary"=>"Update domains", "description"=>"NoteThis call returns an asynchronous response, as described in\nSynchronous and asynchronous responses.", "operationId"=>"update-domains", "x-api-path-slug"=>"v1-0accountdomains-put", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}, "delete"=>{"summary"=>"Delete domains", "description"=>"NoteThis call returns an asynchronous response, as described in\nSynchronous and asynchronous responses.", "operationId"=>"delete-domains", "x-api-path-slug"=>"v1-0accountdomains-delete", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/v1.0/{account}/domains/search\n"=>{"get"=>{"summary"=>"Search domains", "description"=>"NoteFilter criteria may consist of:", "operationId"=>"search-domains", "x-api-path-slug"=>"v1-0accountdomainssearch-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/v1.0/{account}/domains/{domainId}\n"=>{"get"=>{"summary"=>"List domain details without subdomains", "description"=>"This call provides the detailed output for a specified domain configured and\nassociated with an account. This call is not capable of returning details for a\ndomain that has been deleted.This call does not require a request body.", "operationId"=>"list-domain-details-without-subdomains", "x-api-path-slug"=>"v1-0accountdomainsdomainid-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"domainId", "description"=>"ID for the domain", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}, "put"=>{"summary"=>"Update domain", "description"=>"NoteThis call returns an asynchronous response. Refer to\nSynchronous and asynchronous responses\nfor more details and examples of the way that asynchronous responses work.", "operationId"=>"update-domain", "x-api-path-slug"=>"v1-0accountdomainsdomainid-put", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"domainId", "description"=>"ID for the domain", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}, "delete"=>{"summary"=>"Delete domain", "description"=>"NoteThis call returns an asynchronous response, as described in\nSynchronous and asynchronous responses.", "operationId"=>"delete-domain", "x-api-path-slug"=>"v1-0accountdomainsdomainid-delete", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"domainId", "description"=>"ID for the domain", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/v1.0/{account}/domains/{domainId}/changes\n"=>{"get"=>{"summary"=>"Show domain changes", "description"=>"This call shows all changes to a specified domain since a specified\ndate/time. The since parameter is optional and defaults to midnight of the\ncurrent day. See Date/Time format for details on how\nto specify this parameter's value.The examples below show the requests and corresponding responses to list the\ndomain changes since midnight, GMT-5, on September 13, 2011.", "operationId"=>"show-domain-changes", "x-api-path-slug"=>"v1-0accountdomainsdomainidchanges-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"domainId", "description"=>"ID for the domain", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/v1.0/{account}/domains/{domainId}/export\n"=>{"get"=>{"summary"=>"Export domain", "description"=>"NoteThis call returns an asynchronous response. Refer to\nSynchronous and asynchronous responses.", "operationId"=>"export-domain", "x-api-path-slug"=>"v1-0accountdomainsdomainidexport-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"domainId", "description"=>"ID for the domain", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/v1.0/{account}/domains/{domainId}/clone\n"=>{"post"=>{"summary"=>"Clone domain", "description"=>"Creates a specified domain ( example2.com ) by cloning a domain with id\ndomainId. All options except cloneName assume a default value of true.Note", "operationId"=>"clone-domain", "x-api-path-slug"=>"v1-0accountdomainsdomainidclone-post", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"domainId", "description"=>"ID for the domain", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/v1.0/{account}/domains/import\n"=>{"post"=>{"summary"=>"Import domain", "description"=>"NoteThis call returns an asynchronous response, as described in\nSynchronous and asynchronous responses.", "operationId"=>"import-domain", "x-api-path-slug"=>"v1-0accountdomainsimport-post", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/v1.0/{account}/domains/{domainId}/subdomains\n"=>{"get"=>{"summary"=>"List subdomains", "description"=>"This call provides a list of all DNS domains that are subdomains for a\nspecified domain. The resulting list is flat, and does not break the domains\ndown hierarchically by subdomain.Note", "operationId"=>"list-subdomains", "x-api-path-slug"=>"v1-0accountdomainsdomainidsubdomains-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"domainId", "description"=>"ID for the domain", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subdomains"]}}, "/v1.0/{account}/domains/{domainId}/records\n"=>{"get"=>{"summary"=>"List records", "description"=>"This call lists all records configured for the specified domain.Note", "operationId"=>"list-records", "x-api-path-slug"=>"v1-0accountdomainsdomainidrecords-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"domainId", "description"=>"ID for the domain", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Records"]}, "delete"=>{"summary"=>"Delete records", "description"=>"NoteThis call returns an asynchronous response, as described in\nSynchronous and asynchronous responses.", "operationId"=>"delete-records", "x-api-path-slug"=>"v1-0accountdomainsdomainidrecords-delete", "parameters"=>[{"in"=>"header", "name"=>"202", "description"=>"Request is accepted", "type"=>"accepted | "}, {"in"=>"header", "name"=>"400", "description"=>"The request is missingone or more elements, orthe values of someelements are invalid", "type"=>"bad request | "}, {"in"=>"header", "name"=>"400 500", "description"=>"The DNS service hasexperienced a fault", "type"=>"dnsfault | "}, {"in"=>"header", "name"=>"401", "description"=>"You are not authorizedto complete thisoperation", "type"=>"unauthorized | "}, {"in"=>"header", "name"=>"404", "description"=>"The requested item wasnot found", "type"=>"not found | "}, {"in"=>"header", "name"=>"413", "description"=>"The number of itemsreturned is above theallowed limit", "type"=>"over limit | "}, {"in"=>"header", "name"=>"503", "description"=>"The service is notavailable", "type"=>"service unavailable | "}, {"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"domainId", "description"=>"ID for the domain", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Records"]}, "put"=>{"summary"=>"Update records", "description"=>"NoteThis call returns an asynchronous response. Refer to\nSynchronous and asynchronous responses\nfor more details and examples of the way that asynchronous responses work.", "operationId"=>"update-records", "x-api-path-slug"=>"v1-0accountdomainsdomainidrecords-put", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"domainId", "description"=>"ID for the domain", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Records"]}}, "/v1.0/{account}/domains/{domainId}/records/{recordId}\n"=>{"delete"=>{"summary"=>"Delete record", "description"=>"NoteThis call returns an asynchronous response, as described in\nSynchronous and asynchronous responses.", "operationId"=>"delete-record", "x-api-path-slug"=>"v1-0accountdomainsdomainidrecordsrecordid-delete", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"domainId", "description"=>"ID for the domain", "type"=>"string | "}, {"in"=>"query", "name"=>"recordId", "description"=>"ID for the record", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Records"]}, "put"=>{"summary"=>"Update record", "description"=>"NoteThis call returns an asynchronous response. Refer to\nSynchronous and asynchronous responses\nfor more details and examples of the way that asynchronous responses work.", "operationId"=>"update-record", "x-api-path-slug"=>"v1-0accountdomainsdomainidrecordsrecordid-put", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"domainId", "description"=>"ID for the domain", "type"=>"string | "}, {"in"=>"query", "name"=>"recordId", "description"=>"ID for the record", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Records"]}, "get"=>{"summary"=>"Show record details", "description"=>"This call lists details for a specified record in the specified domain.This table shows the possible response codes for this operation:", "operationId"=>"show-record-details", "x-api-path-slug"=>"v1-0accountdomainsdomainidrecordsrecordid-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"domainId", "description"=>"ID for the domain", "type"=>"string | "}, {"in"=>"query", "name"=>"recordId", "description"=>"ID for the record", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Records"]}}, "/v1.0/{account}/rdns\n"=>{"put"=>{"summary"=>"Update PTR records", "description"=>"NoteThis call returns an asynchronous response. Refer to\nSynchronous and asynchronous responses\nfor more details and examples of the way that asynchronous responses work.", "operationId"=>"update-ptr-records", "x-api-path-slug"=>"v1-0accountrdns-put", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reverse DNS"]}, "post"=>{"summary"=>"Add PTR records", "description"=>"NoteThis call returns an asynchronous response. Refer to\nSynchronous and asynchronous responses\nfor more details and examples of the way that asynchronous responses work.", "operationId"=>"add-ptr-records", "x-api-path-slug"=>"v1-0accountrdns-post", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"Arbitrary characterstring generated by theauthentication servicein response to validcredentials", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reverse DNS"]}}, "/v1.0/{account}/rdns/{service-name}\n"=>{"get"=>{"summary"=>"List PTR records", "description"=>"This call lists all PTR records configured for a specified Cloud device.This table shows the possible response codes for this operation:", "operationId"=>"list-ptr-records", "x-api-path-slug"=>"v1-0accountrdnsservicename-get", "parameters"=>[{"in"=>"header", "name"=>"200", "description"=>"Request succeeded", "type"=>"success | "}, {"in"=>"header", "name"=>"400", "description"=>"The request is missingone or more elements, orthe values of someelements are invalid", "type"=>"bad request | "}, {"in"=>"header", "name"=>"401", "description"=>"You are not authorizedto complete thisoperation", "type"=>"unauthorized | "}, {"in"=>"header", "name"=>"404", "description"=>"The requested item wasnot found", "type"=>"not found | "}, {"in"=>"header", "name"=>"413", "description"=>"The number of itemsreturned is above theallowed limit", "type"=>"over limit | "}, {"in"=>"header", "name"=>"500", "description"=>"The DNS service hasexperienced a fault", "type"=>"dnsfault | "}, {"in"=>"header", "name"=>"503", "description"=>"The service is notavailable", "type"=>"service unavailable | "}, {"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"service-name", "description"=>"Name of the Cloudservice", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reverse DNS"]}, "delete"=>{"summary"=>"Delete PTR records", "description"=>"NoteThis call returns an asynchronous response, as described in\nSynchronous and asynchronous responses.", "operationId"=>"delete-ptr-records", "x-api-path-slug"=>"v1-0accountrdnsservicename-delete", "parameters"=>[{"in"=>"header", "name"=>"202", "description"=>"Request is accepted", "type"=>"accepted | "}, {"in"=>"header", "name"=>"400", "description"=>"The request is missingone or more elements, orthe values of someelements are invalid", "type"=>"bad request | "}, {"in"=>"header", "name"=>"400 500", "description"=>"The DNS service hasexperienced a fault", "type"=>"dnsfault | "}, {"in"=>"header", "name"=>"401", "description"=>"You are not authorizedto complete thisoperation", "type"=>"unauthorized | "}, {"in"=>"header", "name"=>"404", "description"=>"The requested item wasnot found", "type"=>"not found | "}, {"in"=>"header", "name"=>"413", "description"=>"The number of itemsreturned is above theallowed limit", "type"=>"over limit | "}, {"in"=>"header", "name"=>"503", "description"=>"The service is notavailable", "type"=>"service unavailable | "}, {"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"service-name", "description"=>"Name of the Cloudservice", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reverse DNS"]}}, "/v1.0/{account}/rdns/{service-name}/{recordId}\n"=>{"get"=>{"summary"=>"Show PTR record", "description"=>"This call shows details for a specified PTR record associated with a specified\ncloud device.This table shows the possible response codes for this operation:", "operationId"=>"show-ptr-record", "x-api-path-slug"=>"v1-0accountrdnsservicenamerecordid-get", "parameters"=>[{"in"=>"header", "name"=>"200", "description"=>"Request succeeded", "type"=>"success | "}, {"in"=>"header", "name"=>"400", "description"=>"The request is missingone or more elements, orthe values of someelements are invalid", "type"=>"bad request | "}, {"in"=>"header", "name"=>"400 500", "description"=>"The DNS service hasexperienced a fault", "type"=>"dnsfault | "}, {"in"=>"header", "name"=>"401", "description"=>"You are not authorizedto complete thisoperation", "type"=>"unauthorized | "}, {"in"=>"header", "name"=>"404", "description"=>"The requested item wasnot found", "type"=>"not found | "}, {"in"=>"header", "name"=>"413", "description"=>"The number of itemsreturned is above theallowed limit", "type"=>"over limit | "}, {"in"=>"header", "name"=>"503", "description"=>"The service is notavailable", "type"=>"service unavailable | "}, {"in"=>"query", "name"=>"account", "description"=>"The tenant ID", "type"=>"string | "}, {"in"=>"query", "name"=>"recordId", "description"=>"ID for the record", "type"=>"string | "}, {"in"=>"query", "name"=>"service-name", "description"=>"Name of the Cloudservice", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reverse DNS"]}}}}, "apis"=>{"name"=>"Rackspace", "x-slug"=>"rackspace", "description"=>"Host on our dedicated or cloud infrastructure or through one of our partners. Leverage our expertise to run fast and lean. We offer web, app or email hosting, data services and managed security solutions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/241-rackspace.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"4115", "tags"=>"API LIfeyclessss,Cloud,Cloud,Compute,Compute,DNS,DNS Cloud,Enterprise,Federal Government,Federal Government,Federal Government,Federal Government,ISP,Relative Data,SaaS,Service API,Stack Network,Storage,Storage,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"rackspace/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Rackspace", "x-api-slug"=>"rackspace", "description"=>"Host on our dedicated or cloud infrastructure or through one of our partners. Leverage our expertise to run fast and lean. We offer web, app or email hosting, data services and managed security solutions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/241-rackspace.jpg", "humanURL"=>"http://www.rackspace.com/", "baseURL"=>"https:///", "tags"=>"API LIfeyclessss,Cloud,Cloud,Compute,Compute,DNS,DNS Cloud,Enterprise,Federal Government,Federal Government,Federal Government,Federal Government,ISP,Relative Data,SaaS,Service API,Stack Network,Storage,Storage,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/rackspace/v1-0accountrdnsservicenamerecordid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/rackspace/rackspace-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://dfw.servers.api.rackspacecloud.com/"}, {"type"=>"x-blog", "url"=>"http://www.rackspace.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"http://www.rackspace.com/blog/feed/rss/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/rackspace"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/rackspace"}, {"type"=>"x-developer", "url"=>"http://docs.rackspace.com/"}, {"type"=>"x-email", "url"=>"abuse@rackspace.com"}, {"type"=>"x-email", "url"=>"abuse@rackspace.co.uk"}, {"type"=>"x-email", "url"=>"legalnotice@rackspace.com"}, {"type"=>"x-email", "url"=>"rackspacepartners@rackspace.com"}, {"type"=>"x-email", "url"=>"channel@rackspace.co.uk"}, {"type"=>"x-email", "url"=>"asia.partner@rackspace.com"}, {"type"=>"x-email", "url"=>"anz.partner@rackspace.com"}, {"type"=>"x-email", "url"=>"publicrelations@rackspace.com"}, {"type"=>"x-email", "url"=>"michael.house@rackspace.co.uk"}, {"type"=>"x-email", "url"=>"daniela.jimenezparke@rackspace.com"}, {"type"=>"x-github", "url"=>"https://github.com/rackspace"}, {"type"=>"x-pricing", "url"=>"https://www.rackspace.com/calculator"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/rackspace"}, {"type"=>"x-website", "url"=>"http://www.rackspace.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}}||
|
511-bay-area{"bay-area-511-transit-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"511 Bay Area", "x-complete"=>1, "info"=>{"title"=>"San Francisco 511", "description"=>"open511-aims-to-create-simple-uniform-and-resource-driven-apis-that-can-be-easily-used-by-consumers-to-retrieve-data-from-511-org--using-the-new-api-is-designed-to-be-as-simple-as-possible-and-is-available-to-all--users-of-the-api-are-required-to-obtain-access-tokens-and-must-send-those-tokens-as-part-of-their-request-", "version"=>"1.0.0"}, "host"=>"api.511.org", "basePath"=>"/transit", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/operators"=>{"get"=>{"summary"=>"Operatorators API", "description"=>"San francisco 511 transit operatorators api.", "operationId"=>"OperatorsGet", "x-api-path-slug"=>"operators-get", "parameters"=>[{"in"=>"query", "name"=>"api_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["511", "Operatorators", "API"]}}, "/VehicleMonitoring"=>{"get"=>{"summary"=>"San Francisco 511 Vehicle Monitoring API", "description"=>"San francisco 511 vehicle monitoring api.", "operationId"=>"VehicleMonitoringGet", "x-api-path-slug"=>"vehiclemonitoring-get", "parameters"=>[{"in"=>"query", "name"=>"agency"}, {"in"=>"query", "name"=>"api_key"}, {"in"=>"query", "name"=>"stopCode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["511", "San", "Francisco", "511", "Vehicle", "Monitoring", "API"]}}, "/stopPlaces"=>{"get"=>{"summary"=>"Stop Places API", "description"=>"San francisco 511 transit stop places api.", "operationId"=>"StopPlacesGet", "x-api-path-slug"=>"stopplaces-get", "parameters"=>[{"in"=>"query", "name"=>"api_key"}, {"in"=>"query", "name"=>"operator_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["511", "Stop", "Places", "API"]}}, "/GeneralAnnouncements"=>{"get"=>{"summary"=>"San Francisco 511 General Announcements API", "description"=>"San francisco 511 general announcements api.", "operationId"=>"GeneralAnnouncementsGet", "x-api-path-slug"=>"generalannouncements-get", "parameters"=>[{"in"=>"query", "name"=>"api_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["511", "San", "Francisco", "511", "General", "Announcements", "API"]}}, "/stoptimetable"=>{"get"=>{"summary"=>"Stop Timetable API", "description"=>"San francisco 511 transit stop timetable api.", "operationId"=>"StoptimetableGet", "x-api-path-slug"=>"stoptimetable-get", "parameters"=>[{"in"=>"query", "name"=>"api_key"}, {"in"=>"query", "name"=>"MonitoringRef"}, {"in"=>"query", "name"=>"OperatorRef"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["511", "Stop", "Timetable", "API"]}}, "/StopMonitoring"=>{"get"=>{"summary"=>"Stop Monitoring API", "description"=>"San francisco 511 transit stop monitoring api.", "operationId"=>"StopMonitoringGet", "x-api-path-slug"=>"stopmonitoring-get", "parameters"=>[{"in"=>"query", "name"=>"agency"}, {"in"=>"query", "name"=>"api_key"}, {"in"=>"query", "name"=>"stopCode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["511", "Stop", "Monitoring", "API"]}}, "/stops"=>{"get"=>{"summary"=>"Stops API", "description"=>"San francisco 511 transit stops api.", "operationId"=>"StopsGet", "x-api-path-slug"=>"stops-get", "parameters"=>[{"in"=>"query", "name"=>"api_key"}, {"in"=>"query", "name"=>"operator_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["511", "Stops", "API"]}}, "/patterns"=>{"get"=>{"summary"=>"Transit Patterns API", "description"=>"San francisco 511 transit transit patterns api.", "operationId"=>"PatternsGet", "x-api-path-slug"=>"patterns-get", "parameters"=>[{"in"=>"query", "name"=>"api_key"}, {"in"=>"query", "name"=>"operator_id"}, {"in"=>"query", "name"=>"pattern_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["511", "Transit", "Patterns", "API"]}}, "/lines"=>{"get"=>{"summary"=>"Lines API", "description"=>"San francisco 511 transit lines api.", "operationId"=>"LinesGet", "x-api-path-slug"=>"lines-get", "parameters"=>[{"in"=>"query", "name"=>"api_key"}, {"in"=>"query", "name"=>"operator_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["511", "Lines", "API"]}}}}, "apis"=>{"name"=>"511 Bay Area", "x-slug"=>"511-bay-area", "description"=>"511 is your free one-stop phone and web source for up-to-the minute Bay Area traffic, transit, rideshare, bicycling, and parking information.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/logo_511_128x128_400x400.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"511,API Provider,Cities,Profiles,Stack Network,Transit", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"511-bay-area/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Bay Area 511 Transit API", "x-api-slug"=>"bay-area-511-transit-api", "description"=>"511 is your free one-stop phone and web source for up-to-the minute Bay Area traffic, transit, rideshare, bicycling, and parking information.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/logo_511_128x128_400x400.jpg", "humanURL"=>"http://www.511.org/", "baseURL"=>"https://api.511.org//transit", "tags"=>"511,API Provider,Cities,Profiles,Stack Network,Transit", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/511-bay-area/lines-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/511-bay-area/bay-area-511-transit-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-twitter", "url"=>"https://twitter.com/511SFBay"}, {"type"=>"x-website", "url"=>"http://www.511.org/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bbc{"bbc-nitro-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"BBC", "x-complete"=>1, "info"=>{"title"=>"BBC Nitro", "description"=>"bbc-nitro-is-the-bbcs-application-programming-interface-api-for-bbc-programmes-metadata-", "termsOfService"=>"http://www.bbc.co.uk/terms/", "contact"=>{"name"=>"Open Nitro Project", "url"=>"http://developer.bbc.co.uk/", "email"=>"nitro@bbc.co.uk"}, "version"=>"1.0.0"}, "host"=>"programmes.api.bbc.com", "basePath"=>"/nitro/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/"=>{"get"=>{"summary"=>"Get API definition", "description"=>"Get API definition", "operationId"=>"getAPI", "x-api-path-slug"=>"get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/availabilities"=>{"get"=>{"summary"=>"Discover details of on-demand availability for programmes and their versions", "description"=>"Discover details of on-demand availability for programmes and their versions", "operationId"=>"listAvailability", "x-api-path-slug"=>"availabilities-get", "parameters"=>[{"in"=>"query", "name"=>"availability", "description"=>"filter for subset of availabilities"}, {"in"=>"query", "name"=>"debug", "description"=>"Turn on debug information (undocumented)"}, {"in"=>"query", "name"=>"descendants_of", "description"=>"filter for subset of availabilities that have PID as ancestor"}, {"in"=>"query", "name"=>"media_set", "description"=>"filter for subset of availabilities with media set"}, {"in"=>"query", "name"=>"page", "description"=>"which page of results to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"number of results in each page"}, {"in"=>"query", "name"=>"sort", "description"=>"Sorts:* scheduled_start: sort chronologically by scheduled start time/date, ascending"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Sort direction"}, {"in"=>"query", "name"=>"territory", "description"=>"filter for availabilities in given territory"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availabilities"]}}, "/broadcasts"=>{"get"=>{"summary"=>"Build schedules and find metadata for TV and radio broadcasts", "description"=>"Fetch metadata about linear Broadcasts and Services, allowing the generation of Television and Radio schedules and other datasets for broadcast items. Use /schedules instead of this feed as it is more efficient. Broadcasts will be deprecated in the future.", "operationId"=>"listBroadcasts", "x-api-path-slug"=>"broadcasts-get", "parameters"=>[{"in"=>"query", "name"=>"authority", "description"=>"filter for subset of broadcasts that have given authority"}, {"in"=>"query", "name"=>"descendants_of", "description"=>"filter for subset of broadcasts that are descendants of the given programme PID"}, {"in"=>"query", "name"=>"end_from", "description"=>"filter for subset of broadcasts that end on or later than the specified datetime"}, {"in"=>"query", "name"=>"end_to", "description"=>"filter for subset of broadcasts that end on or earlier than the specified datetime"}, {"in"=>"query", "name"=>"format", "description"=>"filter for subset of broadcasts that are classified in the given format ID"}, {"in"=>"query", "name"=>"genre", "description"=>"filter for subset of broadcasts that are classified in the given genre ID"}, {"in"=>"query", "name"=>"id", "description"=>"filter for subset of broadcasts that have given identifier"}, {"in"=>"query", "name"=>"item", "description"=>"filter for subset of broadcasts with the given item performed on it"}, {"in"=>"query", "name"=>"mixin", "description"=>"Mixins:* titles: return ancestor programme titles"}, {"in"=>"query", "name"=>"page", "description"=>"which page of results to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"number of results in each page"}, {"in"=>"query", "name"=>"people", "description"=>"filter for subset of broadcasts that have given contributor"}, {"in"=>"query", "name"=>"pid", "description"=>"filter for subset of broadcasts having given PID"}, {"in"=>"query", "name"=>"q", "description"=>"filter for subset of broadcasts matching supplied keyword/phrase (boolean operators permitted)"}, {"in"=>"query", "name"=>"schedule_day", "description"=>"filter for subset of broadcasts that start on the specified day (BBC time)"}, {"in"=>"query", "name"=>"schedule_day_from", "description"=>"filter for subset of broadcasts that start on or after the specified day (BBC time)"}, {"in"=>"query", "name"=>"schedule_day_to", "description"=>"filter for subset of broadcasts that start on or before the specified day (BBC time)"}, {"in"=>"query", "name"=>"service_master_brand", "description"=>"filter for subset of broadcasts with given service master brand"}, {"in"=>"query", "name"=>"sid", "description"=>"filter for subset of broadcasts that are on the specified linear service"}, {"in"=>"query", "name"=>"sort", "description"=>"Sorts:* start_date: sort chronologically by scheduled start time/date, ascending"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Sort direction"}, {"in"=>"query", "name"=>"start_from", "description"=>"filter for subset of broadcasts that start on or later than the specified datetime"}, {"in"=>"query", "name"=>"start_to", "description"=>"filter for subset of broadcasts that start on or earlier than the specified datetime"}, {"in"=>"query", "name"=>"version", "description"=>"filter for subset of broadcasts with given PID as their parent version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Broadcasts"]}}, "/groups"=>{"get"=>{"summary"=>"Find metadata for curated groups: seasons, collections, galleries or franchises", "description"=>"Long-lived curated collections of programmes and more, including Collections, Seasons, Franchises and Galleries", "operationId"=>"listGroups", "x-api-path-slug"=>"groups-get", "parameters"=>[{"in"=>"query", "name"=>"embargoed", "description"=>"Control return of embargoed items (undocumented)"}, {"in"=>"query", "name"=>"for_descendants_of", "description"=>"filter for groups related to given programme or its descendants"}, {"in"=>"query", "name"=>"for_programme", "description"=>"filter for subset of groups directly related to a given programme"}, {"in"=>"query", "name"=>"group", "description"=>"filter for subset of groups which belong to the given group pid"}, {"in"=>"query", "name"=>"group_type", "description"=>"filter for subset of groups that have the given group type"}, {"in"=>"query", "name"=>"member", "description"=>"filter for subset of groups which contain an entity with the given pid as a member"}, {"in"=>"query", "name"=>"mixin", "description"=>"Mixins:* alternate_images: mixin to return the alternate images for a group* group_for: mixin to return links to programme entities that group belongs to* images: mixin to add image information for a group* related_links: mixin to return related links for the group"}, {"in"=>"query", "name"=>"page", "description"=>"which page of results to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"number of results in each page"}, {"in"=>"query", "name"=>"partner_id", "description"=>"filter for groups by partner ID"}, {"in"=>"query", "name"=>"partner_pid", "description"=>"filter for groups by partner PID"}, {"in"=>"query", "name"=>"pid", "description"=>"filter for subset of seasons, collections, galleries or franchises having given PID"}, {"in"=>"query", "name"=>"q", "description"=>"filter for subset of groups matching supplied keyword/phrase (boolean operators permitted)"}, {"in"=>"query", "name"=>"sort", "description"=>"Sorts:* pid: sort alphabetically by PID"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Sort direction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/images"=>{"get"=>{"summary"=>"Find metadata for images", "description"=>"Find metadata for images, particularly those in galleries", "operationId"=>"listImages", "x-api-path-slug"=>"images-get", "parameters"=>[{"in"=>"query", "name"=>"embargoed", "description"=>"Control return of embargoed items (undocumented)"}, {"in"=>"query", "name"=>"group", "description"=>"filter for images belonging to the given group (i"}, {"in"=>"query", "name"=>"image_type", "description"=>"filter for images by type"}, {"in"=>"query", "name"=>"is_alternate_image_for", "description"=>"filter for alternate images by entity PID"}, {"in"=>"query", "name"=>"is_image_for", "description"=>"filter for images by entity PID"}, {"in"=>"query", "name"=>"page", "description"=>"which page of results to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"number of results in each page"}, {"in"=>"query", "name"=>"partner_id", "description"=>"filter for images by partner ID"}, {"in"=>"query", "name"=>"partner_pid", "description"=>"filter for images by partner PID"}, {"in"=>"query", "name"=>"pid", "description"=>"filter for subset of images having given PID"}, {"in"=>"query", "name"=>"q", "description"=>"filter for subset of images matching supplied keyword/phrase (boolean operators permitted)"}, {"in"=>"query", "name"=>"sort", "description"=>"Sorts:* group_position: sort numerically by position, ascending only* pid: sort alphabetically by PID"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Sort direction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images"]}}, "/items"=>{"get"=>{"summary"=>"Look inside programmes to find segments: chapters, tracks and more", "description"=>"Look inside programmes to find segments: chapters, tracks and more", "operationId"=>"listItems", "x-api-path-slug"=>"items-get", "parameters"=>[{"in"=>"query", "name"=>"authority", "description"=>"filter for subset of items that have an ID issued by the given authority"}, {"in"=>"query", "name"=>"id", "description"=>"filter for subset of items having given ID"}, {"in"=>"query", "name"=>"id_type", "description"=>"filter for subset of items that have given an ID of the given type"}, {"in"=>"query", "name"=>"item_type", "description"=>"filter for specific type(s) of items"}, {"in"=>"query", "name"=>"mixin", "description"=>"Mixins:* contributions: mixin to return information about contributors to items* images: mixin to add image information for an item* offset: mixin to return programme segment offsets, works in conjunction with programme filter* play_event: mixin to return programme segment events, works in conjunction with programme or segment_event filters"}, {"in"=>"query", "name"=>"page", "description"=>"which page of results to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"number of results in each page"}, {"in"=>"query", "name"=>"partner_id", "description"=>"filter for items by partner ID"}, {"in"=>"query", "name"=>"partner_pid", "description"=>"filter for items by partner PID"}, {"in"=>"query", "name"=>"people", "description"=>"filter for subset of items that have specified person involved"}, {"in"=>"query", "name"=>"pid", "description"=>"filter for subset of items matching one of the given PIDs"}, {"in"=>"query", "name"=>"programme", "description"=>"filter for subset of items that are part of the given programme"}, {"in"=>"query", "name"=>"q", "description"=>"filter for subset of items matching supplied keyword/phrase (boolean operators permitted)"}, {"in"=>"query", "name"=>"segment_event", "description"=>"filter for item with the given segment_event"}, {"in"=>"query", "name"=>"sort", "description"=>"Sorts:* pid: sort by pid, descending"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Sort direction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Items"]}}, "/master_brands"=>{"get"=>{"summary"=>"List all Master Brands", "description"=>"List all Master Brands", "operationId"=>"listMasterbrands", "x-api-path-slug"=>"master-brands-get", "parameters"=>[{"in"=>"query", "name"=>"mid", "description"=>"filter for subset of masterbrands that have given identifier"}, {"in"=>"query", "name"=>"mixin", "description"=>"Mixins:* images: mixin to add image information for a masterbrand"}, {"in"=>"query", "name"=>"page", "description"=>"which page of results to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"number of results in each page"}, {"in"=>"query", "name"=>"partner_id", "description"=>"filter for masterbrands by partner ID"}, {"in"=>"query", "name"=>"partner_pid", "description"=>"filter for masterbrands by partner PID"}, {"in"=>"query", "name"=>"q", "description"=>"filter for subset of masterbrands matching supplied keyword/phrase (boolean operators permitted)"}, {"in"=>"query", "name"=>"sort", "description"=>"Sorts:* mid: sort by mid, ascending"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Sort direction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Master", "Brands"]}}, "/people"=>{"get"=>{"summary"=>"Find the people behind and in programmes: cast, crew, guests and more", "description"=>"The People feed allows you to search for the people and groups that contribute to programmes. This is the starting point for cast and crew credits, as well as finding contributors using external IDs (such as Wikipedia URLs)", "operationId"=>"listPeople", "x-api-path-slug"=>"people-get", "parameters"=>[{"in"=>"query", "name"=>"authority", "description"=>"filter for subset of people that have an ID issued by the given authority"}, {"in"=>"query", "name"=>"has_external_id", "description"=>"filter for people who have an external identifier"}, {"in"=>"query", "name"=>"id", "description"=>"filter for subset of people having given ID"}, {"in"=>"query", "name"=>"id_type", "description"=>"filter for subset of people that have given an ID of the given type"}, {"in"=>"query", "name"=>"page", "description"=>"which page of results to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"number of results in each page"}, {"in"=>"query", "name"=>"partner_id", "description"=>"filter for people by partner ID"}, {"in"=>"query", "name"=>"partner_pid", "description"=>"filter for people by partner PID"}, {"in"=>"query", "name"=>"pid", "description"=>"filter for subset of people having given PID"}, {"in"=>"query", "name"=>"programme", "description"=>"filter for subset of people that have contributed to the given programme pid"}, {"in"=>"query", "name"=>"q", "description"=>"filter for subset of people matching supplied keyword/phrase (boolean operators permitted)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People"]}}, "/pips"=>{"get"=>{"summary"=>"Look inside pips entities", "description"=>"Look inside pips entities", "operationId"=>"listPips", "x-api-path-slug"=>"pips-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"which page of results to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"number of results in each page"}, {"in"=>"query", "name"=>"q", "description"=>"filter for subset of programmes matching supplied keyword/phrase (boolean operators permitted)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pips"]}}, "/programme_details"=>{"get"=>{"summary"=>"Exposes programme information for a single pid", "description"=>"Exposes programme information for a single pid", "operationId"=>"listProgrammeDetails", "x-api-path-slug"=>"programme-details-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"which page of results to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"number of results in each page"}, {"in"=>"query", "name"=>"partner_pid", "description"=>"Filter for programme information by partner PID"}, {"in"=>"query", "name"=>"pid", "description"=>"Filter for programme information for the provided PID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Programme", "Details"]}}, "/programmes"=>{"get"=>{"summary"=>"Start here for programmes metadata: Brands, Series, Episodes and Clips", "description"=>"Fetch metadata about Programmes (brands, series, episodes, clips). By applying different filter restrictions this feed can be used in many ways, for example to retrieve all series belonging to a brand, all the episodes and/or clips for a specific series, or any TLEO objects for a masterbrand. Other filters permit restricting to specific formats and/or genres, and you can request specific versions (for example Signed or Audio-Described). Parameters may be combined in any way suitable for your application.", "operationId"=>"listProgrammes", "x-api-path-slug"=>"programmes-get", "parameters"=>[{"in"=>"query", "name"=>"audio_described", "description"=>"filter for subset of programmes that are audio-described"}, {"in"=>"query", "name"=>"availability", "description"=>"filter for subset of programmes that have availability"}, {"in"=>"query", "name"=>"availability_entity_type", "description"=>"additional filter when availability=available"}, {"in"=>"query", "name"=>"availability_from", "description"=>"filter for subset of programmes that are available after or at the specified datetime"}, {"in"=>"query", "name"=>"availability_type", "description"=>"filter for a subset of programmes that are available for a given type"}, {"in"=>"query", "name"=>"children_of", "description"=>"filter for subset of programmes that have PID as immediate parent"}, {"in"=>"query", "name"=>"descendants_of", "description"=>"filter for subset of programmes that have PID as ancestor"}, {"in"=>"query", "name"=>"duration", "description"=>"filter for subset of programmes that have given duration"}, {"in"=>"query", "name"=>"embargoed", "description"=>"Control return of embargoed items (undocumented)"}, {"in"=>"query", "name"=>"entity_type", "description"=>"filter for subset of programmes that have given entity type"}, {"in"=>"query", "name"=>"format", "description"=>"filter for subset of programmes with format"}, {"in"=>"query", "name"=>"genre", "description"=>"filter for subset of programmes with genre"}, {"in"=>"query", "name"=>"group", "description"=>"filter for subset of programmes which belong to the given group pid"}, {"in"=>"query", "name"=>"initial_letter", "description"=>"filter for subset of programmes with title beginning with initial letter librarian style (ignoring leading The, An (Welsh), etc) 0-9 a-z"}, {"in"=>"query", "name"=>"initial_letter_end", "description"=>"Programmes with (librarian) titles whose initial letter is equal/before given letter"}, {"in"=>"query", "name"=>"initial_letter_start", "description"=>"Programmes with (librarian) titles whose initial letter is equal/after given letter"}, {"in"=>"query", "name"=>"initial_letter_strict", "description"=>"filter for subset of programmes with title beginning with initial letter"}, {"in"=>"query", "name"=>"item", "description"=>"filter for subset of programmes with linked to versions which have the given item pids"}, {"in"=>"query", "name"=>"master_brand", "description"=>"filter for subset of programmes with master_brand"}, {"in"=>"query", "name"=>"media_set", "description"=>"filter for subset of programmes with media set"}, {"in"=>"query", "name"=>"media_type", "description"=>"filter for subset of programmes with media type"}, {"in"=>"query", "name"=>"mixin", "description"=>"Mixins:* alternate_images: mixin to return the alternate images for a programme* ancestor_titles: mixin to return ancestor programme titles* availability: mixin to return programme availability information* available_simulcasts: mixin to return information about programmes that are currently available as simulcasts* available_versions: mixin to return information about programmes that are currently available on demand* available_webcasts: mixin to return information about programmes that are currently available as webcasts* contributions: mixin to return information about contributors to a programme* duration: mixin to return original version duration in programme concept entities* genre_groupings: mixin to return list of genre groupings* genre_groups: mixin to return list of genre groups* images: mixin to add image information for a programme* is_embeddable: mixin to add embeddable information for a programme* previous_next: mixin to return the programmes which appear before and after a programme (as determined by the sort applied in the request)* related_links: mixin to return information about related links to a programme* titles: mixin to return ancestor programme titles* versions_availability: mixin to return information about programmes that are currently available"}, {"in"=>"query", "name"=>"page", "description"=>"which page of results to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"number of results in each page"}, {"in"=>"query", "name"=>"partner_id", "description"=>"filter for programmes by partner ID"}, {"in"=>"query", "name"=>"partner_pid", "description"=>"filter for programmes by partner PID"}, {"in"=>"query", "name"=>"payment_type", "description"=>"filter for a subset of programmes that are of the given payment_type"}, {"in"=>"query", "name"=>"people", "description"=>"filter for subset of programmes with contributions by given people PID"}, {"in"=>"query", "name"=>"pid", "description"=>"filter for subset of programmes having given PID"}, {"in"=>"query", "name"=>"promoted_for", "description"=>"filter for subset of programmes which are promoted for given service"}, {"in"=>"query", "name"=>"q", "description"=>"filter for subset of programmes matching supplied keyword/phrase (boolean operators permitted)"}, {"in"=>"query", "name"=>"signed", "description"=>"filter for subset of programmes that are signed"}, {"in"=>"query", "name"=>"sort", "description"=>"Sorts:* group_position: sort numerically by position in group, ascending* pid: sort alphabetically by PID, descending* position: sort numerically by position, ascending* promotion: sort by promotion rank, ascending* release_date: sort chronologically by release date, descending* relevance: sort by weighting of search term (use with q parameter)* scheduled_start: sort chronologically by scheduled start time/date, ascending* strict_title: sort alphabetically by title, ascending* title: sort by title librarian style (ignoring leading The, A, etc), ascending* tree: sort by root pid and then preorder tree sort"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Sort direction"}, {"in"=>"query", "name"=>"tag_name", "description"=>"filter for subset of programmes with tag"}, {"in"=>"query", "name"=>"tag_scheme", "description"=>"filter for subset of programmes with a tag"}, {"in"=>"query", "name"=>"tleo", "description"=>"filter for subset of programmes that are TLEOs"}, {"in"=>"query", "name"=>"version", "description"=>"filter for subset of programmes with given PID as one of their versions"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Programmes"]}}, "/promotions"=>{"get"=>{"summary"=>"Discover metadata for content promotions", "description"=>"Details of short-term editorially curated \"promotions\", for instance those programmes featured on iPlayer today", "operationId"=>"listPromotions", "x-api-path-slug"=>"promotions-get", "parameters"=>[{"in"=>"query", "name"=>"context", "description"=>"filter for subset of promotions belonging to a given context"}, {"in"=>"query", "name"=>"mixin", "description"=>"Mixins:* related_links: mixin to return information about related links to a promotion"}, {"in"=>"query", "name"=>"page", "description"=>"which page of results to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"number of results in each page"}, {"in"=>"query", "name"=>"partner_id", "description"=>"filter for promotions by partner ID"}, {"in"=>"query", "name"=>"partner_pid", "description"=>"filter for promotions by partner PID"}, {"in"=>"query", "name"=>"pid", "description"=>"filter for subset of promotions having given PID"}, {"in"=>"query", "name"=>"promoted_by", "description"=>"filter for subset of promotions having given promoted by"}, {"in"=>"query", "name"=>"promoted_for", "description"=>"filter for subset of promotions having given promoted for"}, {"in"=>"query", "name"=>"q", "description"=>"filter for subset of promotions matching supplied keyword/phrase (boolean operators permitted)"}, {"in"=>"query", "name"=>"status", "description"=>"filter for subset of promotions with status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Promotions"]}}, "/schedules"=>{"get"=>{"summary"=>"Build schedules and find metadata for TV and radio broadcasts and webcasts", "description"=>"Dates, Times, Schedules: when and where are programmes being shown?", "operationId"=>"listSchedules", "x-api-path-slug"=>"schedules-get", "parameters"=>[{"in"=>"query", "name"=>"authority", "description"=>"filter for subset of broadcasts and webcasts that have given authority"}, {"in"=>"query", "name"=>"descendants_of", "description"=>"filter for subset of broadcasts and webcasts that are descendants of the given programme PID"}, {"in"=>"query", "name"=>"end_from", "description"=>"filter for subset of broadcasts and webcasts that end on or later than the specified datetime"}, {"in"=>"query", "name"=>"end_to", "description"=>"filter for subset of broadcasts and webcasts that end on or earlier than the specified datetime"}, {"in"=>"query", "name"=>"format", "description"=>"filter for subset of broadcasts and webcasts that are classified in the given format ID"}, {"in"=>"query", "name"=>"genre", "description"=>"filter for subset of broadcasts and webcasts that are classified in the given genre ID"}, {"in"=>"query", "name"=>"group", "description"=>"filter for subset of broadcasts and webcasts that have programmes in the given group"}, {"in"=>"query", "name"=>"id", "description"=>"filter for subset of broadcasts and webcasts that have given identifier"}, {"in"=>"query", "name"=>"id_type", "description"=>"filter for subset of broadcasts and webcasts that have given id type"}, {"in"=>"query", "name"=>"item", "description"=>"filter for subset of broadcasts and webcasts with the given item performed on it"}, {"in"=>"query", "name"=>"mixin", "description"=>"Mixins:* ancestor_titles: return ancestor programme titles* images: mixin to add image information for broadcasts and webcasts* titles: return ancestor programme titles"}, {"in"=>"query", "name"=>"page", "description"=>"which page of results to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"number of results in each page"}, {"in"=>"query", "name"=>"partner_id", "description"=>"filter for broadcasts and webcasts by partner ID"}, {"in"=>"query", "name"=>"partner_pid", "description"=>"filter for broadcasts and webcasts by partner PID"}, {"in"=>"query", "name"=>"people", "description"=>"filter for subset of broadcasts and webcasts that have given contributor"}, {"in"=>"query", "name"=>"pid", "description"=>"filter for subset of broadcasts and webcasts having given PID"}, {"in"=>"query", "name"=>"q", "description"=>"filter for subset of broadcasts and webcasts matching supplied keyword/phrase (boolean operators permitted)"}, {"in"=>"query", "name"=>"repeat", "description"=>"filter to show either only repeats or non-repeats"}, {"in"=>"query", "name"=>"schedule_day", "description"=>"filter for subset of broadcasts and webcasts that start on the specified day (BBC time)"}, {"in"=>"query", "name"=>"schedule_day_from", "description"=>"filter for subset of broadcasts and webcasts that start on or after the specified day (BBC time)"}, {"in"=>"query", "name"=>"schedule_day_to", "description"=>"filter for subset of broadcasts and webcasts that start on or before the specified day (BBC time)"}, {"in"=>"query", "name"=>"service_master_brand", "description"=>"filter for subset of broadcasts and webcasts with given service master brand"}, {"in"=>"query", "name"=>"sid", "description"=>"filter for subset of broadcasts and webcasts that are on the specified linear service"}, {"in"=>"query", "name"=>"sort", "description"=>"Sorts:* start_date: sort chronologically by scheduled start time/date, ascending"}, {"in"=>"query", "name"=>"sort_direction", "description"=>"Sort direction"}, {"in"=>"query", "name"=>"start_from", "description"=>"filter for subset of broadcasts and webcasts that start on or later than the specified datetime"}, {"in"=>"query", "name"=>"start_to", "description"=>"filter for subset of broadcasts and webcasts that start on or earlier than the specified datetime"}, {"in"=>"query", "name"=>"version", "description"=>"filter for subset of broadcasts and webcasts with given PID as their parent version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedules"]}}, "/schema"=>{"get"=>{"summary"=>"Get Schema definition", "description"=>"Get Schema definition", "operationId"=>"getXSD", "x-api-path-slug"=>"schema-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schema"]}}, "/services"=>{"get"=>{"summary"=>"Information about the linear services used for broadcast transmissions", "description"=>"The services feed exposes the linear broadcast \"services\" from PIPs. These are the actual services which broadcast programmes (eg bbc_one_oxford is the service for BBC One in Oxford).", "operationId"=>"listServices", "x-api-path-slug"=>"services-get", "parameters"=>[{"in"=>"query", "name"=>"end_from", "description"=>"Return services that end on or later than the specified datetime"}, {"in"=>"query", "name"=>"end_to", "description"=>"filter for subset of broadcasts that end on or earlier than the specified datetime"}, {"in"=>"query", "name"=>"mid", "description"=>"filter for services by masterbrand MID"}, {"in"=>"query", "name"=>"page", "description"=>"which page of results to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"number of results in each page"}, {"in"=>"query", "name"=>"partner_id", "description"=>"filter for services by partner ID"}, {"in"=>"query", "name"=>"partner_pid", "description"=>"filter for services by partner PID"}, {"in"=>"query", "name"=>"q", "description"=>"filter for subset of services matching supplied keyword/phrase (boolean operators permitted)"}, {"in"=>"query", "name"=>"service_type", "description"=>"filter for specified type of linear services"}, {"in"=>"query", "name"=>"sid", "description"=>"filter for specified linear service"}, {"in"=>"query", "name"=>"start_from", "description"=>"Return services that start on or later than the specified datetime"}, {"in"=>"query", "name"=>"start_to", "description"=>"Return services that start earlier than the specified datetime"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/v1/brands/{pid}"=>{"get"=>{"summary"=>"Get raw brand", "description"=>"Get raw brand", "operationId"=>"Get_Raw_brand", "x-api-path-slug"=>"v1brandspid-get", "parameters"=>[{"in"=>"path", "name"=>"pid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Brands", "Pid"]}}, "/v1/brands/{pid}/franchises/"=>{"get"=>{"summary"=>"Get raw brand franchise", "description"=>"Get raw brand franchises", "operationId"=>"Get_Raw_brand franchises", "x-api-path-slug"=>"v1brandspidfranchises-get", "parameters"=>[{"in"=>"path", "name"=>"pid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Brands", "Pid", "Franchises"]}}, "/v1/episodes/{pid}"=>{"get"=>{"summary"=>"Get raw episode", "description"=>"Get raw episode", "operationId"=>"Get_Raw_episode", "x-api-path-slug"=>"v1episodespid-get", "parameters"=>[{"in"=>"path", "name"=>"pid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Episodes", "Pid"]}}, "/v1/episodes/{pid}/ancestors/"=>{"get"=>{"summary"=>"Get raw ancestors", "description"=>"Get raw ancestors", "operationId"=>"Get_Raw_ancestors", "x-api-path-slug"=>"v1episodespidancestors-get", "parameters"=>[{"in"=>"path", "name"=>"pid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Episodes", "Pid", "Ancestors"]}}, "/v1/episodes/{pid}/formats/"=>{"get"=>{"summary"=>"Get raw formats", "description"=>"Get raw formats", "operationId"=>"Get_Raw_formats", "x-api-path-slug"=>"v1episodespidformats-get", "parameters"=>[{"in"=>"path", "name"=>"pid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Episodes", "Pid", "Formats"]}}, "/v1/episodes/{pid}/genre_groups/"=>{"get"=>{"summary"=>"Get raw genre groups", "description"=>"Get raw genre groups", "operationId"=>"Get_Raw_genre_groups", "x-api-path-slug"=>"v1episodespidgenre-groups-get", "parameters"=>[{"in"=>"path", "name"=>"pid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Episodes", "Pid", "Genre", "Groups"]}}, "/v1/images/{pid}"=>{"get"=>{"summary"=>"Get raw image", "description"=>"Get raw image", "operationId"=>"Get_Raw_image", "x-api-path-slug"=>"v1imagespid-get", "parameters"=>[{"in"=>"path", "name"=>"pid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Images", "Pid"]}}, "/v1/master_brands/{mbid}"=>{"get"=>{"summary"=>"Get raw masterbrand", "description"=>"Get raw masterbrand", "operationId"=>"Get_Raw_masterbrand", "x-api-path-slug"=>"v1master-brandsmbid-get", "parameters"=>[{"in"=>"path", "name"=>"mbid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Master", "Brands", "Mbid"]}}, "/v1/promotions/{pid}"=>{"get"=>{"summary"=>"Get raw promotion", "description"=>"Get raw promotion", "operationId"=>"Get_Raw_promotion", "x-api-path-slug"=>"v1promotionspid-get", "parameters"=>[{"in"=>"path", "name"=>"pid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Promotions", "Pid"]}}, "/versions"=>{"get"=>{"summary"=>"Metadata on editorial programme versions: original, signed, audio-described, etc", "description"=>"The versions feed exposes editorial \"Versions\" of programmes. These are concepts used to capture different presentations of an overall programme: for example, versions of a programme may include one with sign language, one with audio description, one edited for content and more. Versions are also important to understand for broadcasts: a linear broadcast or an ondemand is always of a specific version, not merely of a programme.", "operationId"=>"listVersions", "x-api-path-slug"=>"versions-get", "parameters"=>[{"in"=>"query", "name"=>"availability", "description"=>"filter for subset of versions that have availability"}, {"in"=>"query", "name"=>"descendants_of", "description"=>"filter for subset of versions having given programme PID"}, {"in"=>"query", "name"=>"embargoed", "description"=>"Control return of embargoed items (undocumented)"}, {"in"=>"query", "name"=>"media_set", "description"=>"filter for subset of versions with availability in the given media set"}, {"in"=>"query", "name"=>"page", "description"=>"which page of results to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"number of results in each page"}, {"in"=>"query", "name"=>"partner_id", "description"=>"filter for versions by partner ID"}, {"in"=>"query", "name"=>"partner_pid", "description"=>"filter for versions by partner PID"}, {"in"=>"query", "name"=>"payment_type", "description"=>"filter for a subset of versions that are of the given payment_type"}, {"in"=>"query", "name"=>"pid", "description"=>"filter for subset of versions having given PID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Versions"]}}}}, "apis"=>{"name"=>"BBC", "x-slug"=>"bbc", "description"=>"Breaking news, sport, TV, radio and a whole lot more. The BBC informs, educates and entertains - wherever you are, whatever your age.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28554-bbc-nitro.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"93", "tags"=>"API Provider,Broadcasts,General Data,Historical Data API,Media,Profiles,Publish", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bbc/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"BBC Nitro", "x-api-slug"=>"bbc-nitro", "description"=>"Breaking news, sport, TV, radio and a whole lot more. The BBC informs, educates and entertains - wherever you are, whatever your age.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28554-bbc-nitro.jpg", "humanURL"=>"http://www.bbc.com/", "baseURL"=>"https://programmes.api.bbc.com//nitro/api", "tags"=>"API Provider,Broadcasts,General Data,Historical Data API,Media,Profiles,Publish", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bbc/versions-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bbc/bbc-nitro-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/bbc-news"}, {"type"=>"x-email", "url"=>"dataprotection@bbc.com"}, {"type"=>"x-email", "url"=>"bbcworldwidelearning@bbc.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/BBCNews"}, {"type"=>"x-website", "url"=>"http://www.bbc.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-codebuild{"aws-codebuild-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS CodeBuild", "x-complete"=>1, "info"=>{"title"=>"AWS CodeBuild API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=BatchGetBuilds"=>{"get"=>{"summary"=>"Batch Get Builds", "description"=>"Gets information about one or more builds.", "operationId"=>"batchGetBuilds", "x-api-path-slug"=>"actionbatchgetbuilds-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"The IDs of the builds to get information about", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds"]}}, "/?Action=BatchGetProjects"=>{"get"=>{"summary"=>"Batch Get Projects", "description"=>"Gets information about one or more build projects.", "operationId"=>"batchGetProjects", "x-api-path-slug"=>"actionbatchgetprojects-get", "parameters"=>[{"in"=>"query", "name"=>"names", "description"=>"The names of the build projects to get information about", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/?Action=CreateProject"=>{"get"=>{"summary"=>"Create Project", "description"=>"Creates a build project.", "operationId"=>"createProject", "x-api-path-slug"=>"actioncreateproject-get", "parameters"=>[{"in"=>"query", "name"=>"artifacts", "description"=>"Information about the build projects build output artifacts", "type"=>"string"}, {"in"=>"query", "name"=>"description", "description"=>"A meaningful description of the build project", "type"=>"string"}, {"in"=>"query", "name"=>"encryptionKey", "description"=>"The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build projects build output artifacts", "type"=>"string"}, {"in"=>"query", "name"=>"environment", "description"=>"Information about the build projects build environment", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"The build projects name", "type"=>"string"}, {"in"=>"query", "name"=>"serviceRole", "description"=>"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"source", "description"=>"Information about the build projects build input source code", "type"=>"string"}, {"in"=>"query", "name"=>"tags", "description"=>"A set of tags for this build project", "type"=>"string"}, {"in"=>"query", "name"=>"timeoutInMinutes", "description"=>"How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/?Action=DeleteProject"=>{"get"=>{"summary"=>"Delete Project", "description"=>"Deletes a build project.", "operationId"=>"deleteProject", "x-api-path-slug"=>"actiondeleteproject-get", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"The name of the build project to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/?Action=ListBuilds"=>{"get"=>{"summary"=>"List Builds", "description"=>"Gets a list of build IDs, with each build ID representing a single build.", "operationId"=>"listBuilds", "x-api-path-slug"=>"actionlistbuilds-get", "parameters"=>[{"in"=>"query", "name"=>"nextToken", "description"=>"During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token", "type"=>"string"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"The order to list build IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds"]}}, "/?Action=ListBuildsForProject"=>{"get"=>{"summary"=>"List Builds For Project", "description"=>"Gets a list of build IDs for the specified build project, with each build ID representing a single build.", "operationId"=>"listBuildsForProject", "x-api-path-slug"=>"actionlistbuildsforproject-get", "parameters"=>[{"in"=>"query", "name"=>"nextToken", "description"=>"During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token", "type"=>"string"}, {"in"=>"query", "name"=>"projectName", "description"=>"The name of the build project to get a list of build IDs for", "type"=>"string"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"The order to list build IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project Builds"]}}, "/?Action=ListCuratedEnvironmentImages"=>{"get"=>{"summary"=>"List Curated Environment Images", "description"=>"Gets information about Docker images that are managed by AWS CodeBuild.", "operationId"=>"listCuratedEnvironmentImages", "x-api-path-slug"=>"actionlistcuratedenvironmentimages-get", "parameters"=>[{"in"=>"query", "name"=>"platforms", "description"=>"Information about supported platforms for Docker images that are managed by AWS CodeBuild", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Curated Environments"]}}, "/?Action=ListProjects"=>{"get"=>{"summary"=>"List Projects", "description"=>"Gets a list of build project names, with each build project name representing a single build project.", "operationId"=>"listProjects", "x-api-path-slug"=>"actionlistprojects-get", "parameters"=>[{"in"=>"query", "name"=>"nextToken", "description"=>"During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token", "type"=>"string"}, {"in"=>"query", "name"=>"sortBy", "description"=>"The criterion to be used to list build project names", "type"=>"string"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"The order in which to list build projects", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/?Action=StartBuild"=>{"get"=>{"summary"=>"Start Build", "description"=>"Starts running a build.", "operationId"=>"startBuild", "x-api-path-slug"=>"actionstartbuild-get", "parameters"=>[{"in"=>"query", "name"=>"artifactsOverride", "description"=>"Build output artifact settings that override, for this build only, the latest ones already defined in the corresponding build project", "type"=>"string"}, {"in"=>"query", "name"=>"buildspecOverride", "description"=>"A build spec declaration that overrides, for this build only, the latest one already defined in the corresponding build project", "type"=>"string"}, {"in"=>"query", "name"=>"environmentVariablesOverride", "description"=>"A set of environment variables that overrides, for this build only, the latest ones already defined in the corresponding build project", "type"=>"string"}, {"in"=>"query", "name"=>"projectName", "description"=>"The name of the build project to start running a build", "type"=>"string"}, {"in"=>"query", "name"=>"sourceVersion", "description"=>"A version of the build input to be built, for this build only", "type"=>"string"}, {"in"=>"query", "name"=>"timeoutInMinutesOverride", "description"=>"The number of build timeout minutes, from 5 to 480 (8 hours) that overrides, for this build only, the latest setting already defined in the corresponding build project", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds"]}}, "/?Action=StopBuild"=>{"get"=>{"summary"=>"Stop Build", "description"=>"Attempts to stop running a build.", "operationId"=>"stopBuild", "x-api-path-slug"=>"actionstopbuild-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The ID of the build to attempt to stop running", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds"]}}, "/?Action=UpdateProject"=>{"get"=>{"summary"=>"Update Project", "description"=>"Changes the settings of an existing build project.", "operationId"=>"updateProject", "x-api-path-slug"=>"actionupdateproject-get", "parameters"=>[{"in"=>"query", "name"=>"artifacts", "description"=>"Information to be changed about the build projects build output artifacts", "type"=>"string"}, {"in"=>"query", "name"=>"description", "description"=>"A new or replacement description of the build project", "type"=>"string"}, {"in"=>"query", "name"=>"encryptionKey", "description"=>"The replacement AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build projects build output artifacts", "type"=>"string"}, {"in"=>"query", "name"=>"environment", "description"=>"Information to be changed about the build projects build environment", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the existing build project to change settings", "type"=>"string"}, {"in"=>"query", "name"=>"serviceRole", "description"=>"The replacement Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"source", "description"=>"Information to be changed about the build projects build input source code", "type"=>"string"}, {"in"=>"query", "name"=>"tags", "description"=>"The replacement set of tags for this build project", "type"=>"string"}, {"in"=>"query", "name"=>"timeoutInMinutes", "description"=>"The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait to timeout any related build that did not get marked as completed", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}}}, "apis"=>{"name"=>"AWS CodeBuild", "x-slug"=>"aws-codebuild", "description"=>"AWS CodeBuild is a fully managed build service that compiles source code, runs tests, and produces software packages that are ready to deploy. With CodeBuild, you don’t need to provision, manage, and scale your own build servers. CodeBuild scales continuously and processes multiple builds concurrently, so your builds are not left waiting in a queue. You can get started quickly by using prepackaged build environments, or you can create custom build environments that use your own build tools. With CodeBuild, you are charged by the minute for the compute resources you use.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/code-build-console-icon.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Orchestration,Profiles,Relative Data,SDK,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-codebuild/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS CodeBuild API", "x-api-slug"=>"aws-codebuild-api", "description"=>"AWS CodeBuild is a fully managed build service that compiles source code, runs tests, and produces software packages that are ready to deploy. With CodeBuild, you don’t need to provision, manage, and scale your own build servers. CodeBuild scales continuously and processes multiple builds concurrently, so your builds are not left waiting in a queue. You can get started quickly by using prepackaged build environments, or you can create custom build environments that use your own build tools. With CodeBuild, you are charged by the minute for the compute resources you use.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/code-build-console-icon.png", "humanURL"=>"https://aws.amazon.com/codebuild/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Orchestration,Profiles,Relative Data,SDK,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-codebuild/aws-codebuild-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/cli/latest/reference/codebuild/index.html"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/codebuild/latest/APIReference/Welcome.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/codebuild/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/codebuild/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/codebuild/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/codebuild/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-resource-health{"azure-resource-health-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Resource Health", "x-complete"=>1, "info"=>{"title"=>"Microsoft.ResourceHealth", "description"=>"the-resource-health-client-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/availabilityStatuses"=>{"get"=>{"summary"=>"Availability Statuses List By Subscription Id", "description"=>"Lists the current availability status for all the resources in the subscription. Use the nextLink property in the response to get the next page of availability statuses.", "operationId"=>"AvailabilityStatuses_ListBySubscriptionId", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-resourcehealthavailabilitystatuses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availability Statuses Subscription Id"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceHealth/availabilityStatuses"=>{"get"=>{"summary"=>"Availability Statuses List By Resource Group", "description"=>"Lists the current availability status for all the resources in the resource group. Use the nextLink property in the response to get the next page of availability statuses.", "operationId"=>"AvailabilityStatuses_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-resourcehealthavailabilitystatuses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availability Statuses Resource Group"]}}, "/{resourceUri}/providers/Microsoft.ResourceHealth/availabilityStatuses/current"=>{"get"=>{"summary"=>"Availability Statuses Get By Resource", "description"=>"Gets current availability status for a single resource", "operationId"=>"AvailabilityStatuses_GetByResource", "x-api-path-slug"=>"resourceuriprovidersmicrosoft-resourcehealthavailabilitystatusescurrent-get", "parameters"=>[{"in"=>"path", "name"=>"resourceUri", "description"=>"The fully qualified ID of the resource, including the resource name and resource type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availability Statuses Resource"]}}, "/{resourceUri}/providers/Microsoft.ResourceHealth/availabilityStatuses"=>{"get"=>{"summary"=>"Availability Statuses List", "description"=>"Lists the historical availability statuses for a single resource. Use the nextLink property in the response to get the next page of availability status", "operationId"=>"AvailabilityStatuses_List", "x-api-path-slug"=>"resourceuriprovidersmicrosoft-resourcehealthavailabilitystatuses-get", "parameters"=>[{"in"=>"path", "name"=>"resourceUri", "description"=>"The fully qualified ID of the resource, including the resource name and resource type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availability Statuses"]}}, "/providers/Microsoft.ResourceHealth/operations"=>{"get"=>{"summary"=>"Operations List", "description"=>"Lists available operations for the resourcehealth resource provider", "operationId"=>"Operations_List", "x-api-path-slug"=>"providersmicrosoft-resourcehealthoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations"]}}}}, "apis"=>{"name"=>"Azure Resource Health", "x-slug"=>"azure-resource-health", "description"=>"Resource health helps you diagnose and get support when an Azure issue impacts your resources. It informs you about the current and past health of your resources and helps you mitigate issues. Resource health provides technical support when you need help with Azure service issues.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-resource-health.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Microsoft,Monitoring,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-resource-health/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Resource Health API", "x-api-slug"=>"azure-resource-health-api", "description"=>"Resource health helps you diagnose and get support when an Azure issue impacts your resources. It informs you about the current and past health of your resources and helps you mitigate issues. Resource health provides technical support when you need help with Azure service issues.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-resource-health.png", "humanURL"=>"https://docs.microsoft.com/en-us/azure/resource-health/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Microsoft,Monitoring,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-resource-health/providersmicrosoft-resourcehealthoperations-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-resource-health/azure-resource-health-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-faq", "url"=>"https://docs.microsoft.com/en-us/azure/resource-health/resource-health-faq"}, {"type"=>"x-website", "url"=>"https://docs.microsoft.com/en-us/azure/resource-health/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-glacier{"amazon-glacier-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Glacier", "x-complete"=>1, "info"=>{"title"=>"AWS Glacier API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{AccountId}/vaults/{VaultName}/archives"=>{"post"=>{"summary"=>"Upload Archive", "description"=>"DescriptionThis operation adds an archive to a vault. For a successful upload, your data is durably\n\t\t\tpersisted. In response, Amazon Glacier returns the archive ID in the\n\t\t\t\tx-amz-archive-id header of the response. You should save the archive ID\n\t\t\treturned so that you can access the archive later. You must provide a SHA256 tree hash of the data you are uploading. For information about\n\t\t\tcomputing a SHA256 tree hash, see Computing Checksums. When uploading an archive, you can optionally specify an archive description of up to 1,024\n\t\t\tprintable ASCII characters. Amazon Glacier returns the archive description when you\n\t\t\teither retrieve the archive or get the vault inventory. Amazon Glacier does not interpret the\n\t\t\tdescription in any way. An archive description does not need to be unique. You cannot\n\t\t\tuse the description to retrieve or sort the archive list. Except for the optional archive description, Amazon Glacier does not support any\n\t\t\tadditional metadata for the archives. The archive ID is an opaque sequence of characters\n\t\t\tfrom which you cannot infer any meaning about the archive. So you might maintain\n\t\t\tmetadata about the archives on the client-side. For more information, see \n\t\t\tWorking with Archives in Amazon Glacier.Archives are immutable. After you upload an archive, you cannot edit the archive or its\n\t\t\tdescription. RequestsTo upload an archive, you use the HTTP POST method and scope the request to the\n\t\t\t\tarchives subresource of the vault in which you want to save the\n\t\t\tarchive. The request must include the archive payload size, checksum (SHA256 tree hash),\n\t\t\tand can optionally include a description of the archive.", "operationId"=>"Upload Archive (POST archive)", "x-api-path-slug"=>"accountidvaultsvaultnamearchives-post", "parameters"=>[{"type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Archives"]}}, "/{AccountId}/policies/data-retrieval"=>{"get"=>{"summary"=>"Get Data Retrieval Policy", "description"=>"DescriptionThis operation returns the current data retrieval policy for the account and region specified in the\n\t\t\t\tGET request. For more information about data retrieval policies, see\n\t\t\tAmazon Glacier Data Retrieval Policies.RequestsTo return the current data retrieval policy, send an HTTP GET request to the data retrieval\n\t\t\tpolicy URI as shown in the following syntax example.", "operationId"=>"Get Data Retrieval Policy (GET policy)", "x-api-path-slug"=>"accountidpoliciesdataretrieval-get", "parameters"=>[{"in"=>"query", "name"=>"BytesPerHour", "description"=>"The maximum number of bytes that can be retrieved in an hour", "type"=>"string"}, {"in"=>"query", "name"=>"Rules", "description"=>"The policy rule", "type"=>"string"}, {"in"=>"query", "name"=>"Strategy", "description"=>"The type of data retrieval policy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data Retrieval Policies"]}, "put"=>{"summary"=>"Set Data Retrieval Policy", "description"=>"DescriptionThis operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one\n\t\t\tpolicy per region for an AWS account. The policy is enacted within a few minutes of a\n\t\t\tsuccessful PUT operation. The set policy operation does not affect retrieval jobs that were in progress before the policy was\n\t\t\tenacted. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies. Requests", "operationId"=>"Set Data Retrieval Policy (PUT policy)", "x-api-path-slug"=>"accountidpoliciesdataretrieval-put", "parameters"=>[{"in"=>"query", "name"=>"BytesPerHour", "description"=>"The maximum number of bytes that can be retrieved in an hour", "type"=>"string"}, {"in"=>"query", "name"=>"Rules", "description"=>"The policy rule", "type"=>"string"}, {"in"=>"query", "name"=>"Strategy", "description"=>"The type of data retrieval policy to set", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data Retrieval Policy"]}}, "/{AccountId}/provisioned-capacity"=>{"post"=>{"summary"=>"Purchase Provisioned Capacity", "description"=>"Purchase Provisioned Capacity (POST provisioned-capacity)This operation purchases a provisioned capacity unit for an AWS account.RequestsTo purchase provisioned capacity unit for an AWS account send an HTTP POST\n request to the provisioned-capacity URI.", "operationId"=>"Purchase Provisioned Capacity (POST provisioned-capacity)", "x-api-path-slug"=>"accountidprovisionedcapacity-post", "parameters"=>[{"type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Purchase Provisioned Capacity"]}}, "/{AccountID}/vaults/{VaultName}/jobs/{JobID}"=>{"get"=>{"summary"=>"Describe Job", "description"=>"DescriptionThis operation returns information about a job you previously initiated, including the job\n\t\t\tinitiation date, the user who initiated the job, the job status code/message and the\n\t\t\tAmazon Simple Notification Service (Amazon SNS) topic to notify after Amazon Glacier\n\t\t\tcompletes the job. For more information about initiating a job, see Initiate Job (POST jobs). \n\t\t\tNoteThis operation enables you to check the status of your job. However, it is\n\t\t\t\t\tstrongly recommended that you set up an Amazon SNS topic and specify it in your\n\t\t\t\t\tinitiate job request so that Amazon Glacier can notify the topic after it completes\n\t\t\t\t\tthe job. \n\t\tA job ID will not expire for at least 24 hours after Amazon Glacier completes the job. Requests", "operationId"=>"describe Job (GET JobID)", "x-api-path-slug"=>"accountidvaultsvaultnamejobsjobid-get", "parameters"=>[{"in"=>"query", "name"=>"Action", "description"=>"The job type", "type"=>"string"}, {"in"=>"query", "name"=>"ArchiveId", "description"=>"For an ArchiveRetrieval job, this is the archive ID requested for download", "type"=>"string"}, {"in"=>"query", "name"=>"ArchiveSHA256TreeHash", "description"=>"The SHA256 tree hash of the entire archive for an archive retrieval job", "type"=>"string"}, {"in"=>"query", "name"=>"ArchiveSizeInBytes", "description"=>"For an ArchiveRetrieval job, this is the size in bytes of the archive beingrequested for download", "type"=>"string"}, {"in"=>"query", "name"=>"Completed", "description"=>"The job status", "type"=>"string"}, {"in"=>"query", "name"=>"CompletionDate", "description"=>"The UTC time that the job request completed", "type"=>"string"}, {"in"=>"query", "name"=>"CreationDate", "description"=>"The UTC time that the job was created", "type"=>"string"}, {"in"=>"query", "name"=>"EndDate", "description"=>"The end of the date range in UTC for vault inventory retrieval that includes archives created before this date", "type"=>"string"}, {"in"=>"query", "name"=>"Format", "description"=>"The output format for the vault inventory list, which is set by the Initiate Job (POST jobs) request when initiating a job to retrieve a vault inventory", "type"=>"string"}, {"in"=>"query", "name"=>"InventorySizeInBytes", "description"=>"For an InventoryRetrieval job, this is the size in bytes of the inventoryrequested for download", "type"=>"string"}, {"in"=>"query", "name"=>"JobDescription", "description"=>"The job description you provided when you initiated the job", "type"=>"string"}, {"in"=>"query", "name"=>"JobId", "description"=>"The ID that represents the job in Amazon Glacier", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"Specifies the maximum number of inventory items returned per vault inventory retrieval request", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An opaque string that represents where to continue pagination of the vault inventoryretrieval results", "type"=>"string"}, {"in"=>"query", "name"=>"RetrievalByteRange", "description"=>"The retrieved byte range for archive retrieval jobs in the formStartByteValue-EndByteValueIf you dont specify a range in the archive retrieval, then the wholearchive is retrieved; also StartByteValue equals 0,and EndByteValue equals the size of the archiveminus 1", "type"=>"string"}, {"in"=>"query", "name"=>"SHA256TreeHash", "description"=>"The SHA256 tree hash value for the requested range of an archive", "type"=>"string"}, {"in"=>"query", "name"=>"SNSTopic", "description"=>"An Amazon Simple Notification Service (Amazon SNS) topic that receivesnotification", "type"=>"string"}, {"in"=>"query", "name"=>"StartDate", "description"=>"The start of the date range in UTC for vault inventory retrieval that includes archivescreated on or after this date", "type"=>"string"}, {"in"=>"query", "name"=>"StatusCode", "description"=>"The status code can be InProgress, Succeeded, orFailed, and indicates the status of the job", "type"=>"string"}, {"in"=>"query", "name"=>"StatusMessage", "description"=>"A friendly message that describes the job status", "type"=>"string"}, {"in"=>"query", "name"=>"Tier", "description"=>"The retrieval option to use for the archive retrieval", "type"=>"string"}, {"in"=>"query", "name"=>"VaultARN", "description"=>"The Amazon Resource Name (ARN) of the vault from which the archiveretrieval was requested", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/{AccountId}/vaults/{VaultName}/jobs/{JobID}/output"=>{"get"=>{"summary"=>"Get Job Output", "description"=>"DescriptionThis operation downloads the output of the job you initiated using Initiate Job (POST jobs). Depending\n\t\t\ton the job type you specified when you initiated the job, the output will be either the\n\t\t\tcontent of an archive or a vault inventory. You can download all the job output or download a portion of the output by specifying\n\t\t\ta byte range. For both archive and inventory retrieval jobs, you should verify the downloaded \n\t\t\tsize against the size returned in the headers from the \n\t\t\tGet Job Output response.For archive retrieval jobs, you should also verify that the size is what you expected. If\n\t\t\tyou download a portion of the output, the expected size is based on the range of bytes\n\t\t\tyou specified. For example, if you specify a range of bytes=0-1048575, you should\n\t\t\tverify your download size is 1,048,576 bytes. If you download an entire archive, the\n\t\t\texpected size is the size of the archive when you uploaded it to Amazon Glacier.\n\t\t\tThe expected size is also returned in the headers from the \n\t\t\tGet Job Output response.In the case of an archive retrieval job, depending on the byte range you\n\t\t\tspecify, Amazon Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded \n\t\t\tis the correct data, compute the checksum on the client, verify that the values match, \n\t\t\tand verify that the size is what you expected.A job ID does not expire for at least 24 hours after Amazon Glacier completes the job. That\n\t\t\tis, you can download the job output within the 24-hour period after Amazon Glacier\n\t\t\tcompletes the job.Requests", "operationId"=>"get Job Output (GET output)", "x-api-path-slug"=>"accountidvaultsvaultnamejobsjobidoutput-get", "parameters"=>[{"type"=>"string"}, {"in"=>"query", "name"=>"ArchiveDescription", "description"=>"The description of an archive", "type"=>"string"}, {"in"=>"query", "name"=>"ArchiveId", "description"=>"The ID of an archive", "type"=>"string"}, {"in"=>"query", "name"=>"ArchiveList", "description"=>"An array of archive metadata", "type"=>"string"}, {"in"=>"query", "name"=>"CreationDate", "description"=>"The UTC date and time the archive was created", "type"=>"string"}, {"in"=>"query", "name"=>"InventoryDate", "description"=>"The UTC date and time of the last inventory for the vault that was completed afterchanges to the vault", "type"=>"string"}, {"in"=>"query", "name"=>"SHA256TreeHash", "description"=>"The tree hash of the archive", "type"=>"string"}, {"in"=>"query", "name"=>"Size", "description"=>"The size in bytes of the archive", "type"=>"string"}, {"in"=>"query", "name"=>"VaultARN", "description"=>"The Amazon Resource Name (ARN) resource from which the archiveretrieval was requested", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/{AccountId}/vaults/{VaultName}/jobs"=>{"post"=>{"summary"=>"Initiate Job", "description"=>"Initiate Job (POST jobs)This operation initiates a job of the specified type, which can be an archive retrieval or vault inventory retrieval.Initializing a Data Retrieval Job Retrieving an archive or a vault inventory are asynchronous operations that require you to\n\t\t\tinitiate a job. Retrieval is a two-step process:\n\t\t\tInitiate a retrieval job.ImportantA data retrieval policy can cause your initiate retrieval job request to fail with a\n\t\t\t\t\t\t\t\tPolicyEnforcedException exception. For more information about data\n\t\t\t\t\t\t\tretrieval policies, see Amazon Glacier Data Retrieval Policies. For more information about the\n\t\t\t\t\t\t\t\tPolicyEnforcedException exception, see Error Responses.After the job completes, download the bytes. \n\t\tThe retrieval request is executed asynchronously. When you initiate a retrieval job, Amazon Glacier creates a job\n\t\t\tand returns a job ID in the response. When Amazon Glacier completes the job, you can get the job output (archive or\n\t\t\tinventory data). For information about getting job output, see the Get Job Output (GET output) operation. The job must complete before you can get its output. To determine when a job is complete, you have the\n\t\t\tfollowing options:\n\t\t\tUse an Amazon SNS notification— You can specify an Amazon Simple Notification Service\n\t\t\t\t\t\t(Amazon SNS) topic to which Amazon Glacier can post a notification after the job is completed. You can specify\n\t\t\t\t\t\tan SNS topic per job request. The notification is sent only after Amazon Glacier completes the job. In\n\t\t\t\t\t\taddition to specifying an SNS topic per job request, you can configure vault notifications for a\n\t\t\t\t\t\tvault so that job notifications are sent for all retrievals. For more information, see Set Vault Notification Configuration (PUT\n\t\tnotification-configuration). Get job details— You can make a Describe Job (GET JobID) request to obtain job\n\t\t\t\t\t\tstatus information while a job is in progress. However, it is more efficient to use an Amazon SNS\n\t\t\t\t\t\tnotification to determine when a job is complete.\n\t\t\n\t\t\tNoteThe information you get via notification is same that you get by calling Describe Job (GET JobID). \n\t\tIf for a specific event, you add both the notification configuration on the vault and also specify an SNS\n\t\t\ttopic in your initiate job request, Amazon Glacier sends both notifications. For more information, see Set Vault Notification Configuration (PUT\n\t\tnotification-configuration).", "operationId"=>"initiate Job (POST jobs)", "x-api-path-slug"=>"accountidvaultsvaultnamejobs-post", "parameters"=>[{"type"=>"string"}, {"in"=>"query", "name"=>"ArchiveId", "description"=>"The ID of the archive that you want to retrieve", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"The optional description for the job", "type"=>"string"}, {"in"=>"query", "name"=>"EndDate", "description"=>"The end of the date range in UTC for vault inventory retrieval that includes archivescreated before this date", "type"=>"string"}, {"in"=>"query", "name"=>"Format", "description"=>"When initiating a job to retrieve a vault inventory, you can optionally add this parameterto your request to specify the output format", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of inventory items returned per vault inventory retrievalrequest", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An opaque string that represents where to continue pagination of the vault inventoryretrieval results", "type"=>"string"}, {"in"=>"query", "name"=>"RetrievalByteRange", "description"=>"The byte range to retrieve for an archive retrieval", "type"=>"string"}, {"in"=>"query", "name"=>"SNSTopic", "description"=>"The Amazon SNS topic ARN where Amazon Glacier sends a notification when the job is completed, and theoutput is ready for you to download", "type"=>"string"}, {"in"=>"query", "name"=>"StartDate", "description"=>"The start of the date range in UTC for vault inventory retrieval that includes archivescreated on or after this date", "type"=>"string"}, {"in"=>"query", "name"=>"Tier", "description"=>"The retrieval option to use for the archive retrieval", "type"=>"string"}, {"in"=>"query", "name"=>"Type", "description"=>"The job type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}, "get"=>{"summary"=>"List Jobs", "description"=>"DescriptionThis operation lists jobs for a vault including jobs that are in-progress and jobs that have\n\t\t\trecently finished. \n\t\t\tNoteAmazon Glacier retains recently completed jobs for a period before deleting them; however,\n\t\t\t\t\tit eventually removes completed jobs. The output of completed jobs can be\n\t\t\t\t\tretrieved. Retaining completed jobs for a period of time after they have\n\t\t\t\t\tcompleted enables you to get a job output in the event you miss the job\n\t\t\t\t\tcompletion notification or your first attempt to download it fails. For example,\n\t\t\t\t\tsuppose you start an archive retrieval job to download an archive. After the job\n\t\t\t\t\tcompletes, you start to download the archive but encounter a network error. In\n\t\t\t\t\tthis scenario, you can retry and download the archive while the job exists. \n\t\tTo retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate\n\t\t\ta job, and after the job completes, you download the data. For an archive retrieval, the\n\t\t\toutput is the archive data. For an inventory retrieval, it is the inventory list.\n\t\t\tThe List Job operation returns a list of these jobs sorted by job initiation\n\t\t\ttime.The List Jobs operation supports pagination. You should always check the response\n\t\t\t\tMarker field. If there are no more jobs to list, the\n\t\t\t\tMarker field is set to null. If there are more jobs to\n\t\t\tlist, the Marker field is set to a non-null value, which you can use to\n\t\t\tcontinue the pagination of the list. To return a list of jobs that begins at a specific\n\t\t\tjob, set the marker request parameter to the Marker value for\n\t\t\tthat job that you obtained from a previous List Jobs request.You can set a maximum limit for the number of jobs returned in the response by specifying\n\t\t\tthe limit parameter in the request. The default limit is 1000. The number\n\t\t\tof jobs returned might be fewer than the limit but the number of returned jobs never\n\t\t\texceeds the limit.Additionally, you can filter the jobs list returned by specifying the optional\n\t\t\tstatuscode parameter or completed parameter, or both. Using\n\t\t\tthe statuscode parameter, you can specify to return only jobs that match\n\t\t\teither the InProgress, Succeeded, or Failed status.\n\t\t\tUsing the completed parameter, you can specify to return only jobs that were\n\t\t\tcompleted (true) or jobs that were not completed\n\t\t\t(false).Requests", "operationId"=>"list Jobs (GET jobs)", "x-api-path-slug"=>"accountidvaultsvaultnamejobs-get", "parameters"=>[{"in"=>"query", "name"=>"Action", "description"=>"For archive retrieval jobs, this value is ArchiveRetrieval", "type"=>"string"}, {"in"=>"query", "name"=>"ArchiveId", "description"=>"The ID of the archive that was requested in an archive retrieval", "type"=>"string"}, {"in"=>"query", "name"=>"ArchiveSHA256TreeHash", "description"=>"The SHA256 tree hash of the entire archive for an archive retrieval", "type"=>"string"}, {"in"=>"query", "name"=>"ArchiveSizeInBytes", "description"=>"The size of the archive for which the archive retrieval job requestwas initiated", "type"=>"string"}, {"in"=>"query", "name"=>"Completed", "description"=>"true if the job is completed; false otherwise", "type"=>"string"}, {"in"=>"query", "name"=>"CompletionDate", "description"=>"The Universal Coordinated Time (UTC) date when the job completed", "type"=>"string"}, {"in"=>"query", "name"=>"CreationDate", "description"=>"The Universal Coordinated Time (UTC) date the job started", "type"=>"string"}, {"in"=>"query", "name"=>"EndDate", "description"=>"The end of the date range in UTC for vault inventory retrieval that includes archives created before this date", "type"=>"string"}, {"in"=>"query", "name"=>"Format", "description"=>"The output format for the vault inventory list, which is set by the Initiate Job (POST jobs) request when initiating a job to retrieve a vault inventory", "type"=>"string"}, {"in"=>"query", "name"=>"InventorySizeInBytes", "description"=>"The size of the inventory associated with an inventory retrieval job request", "type"=>"string"}, {"in"=>"query", "name"=>"JobDescription", "description"=>"A description of the job", "type"=>"string"}, {"in"=>"query", "name"=>"JobId", "description"=>"The ID that represents the job in Amazon Glacier", "type"=>"string"}, {"in"=>"query", "name"=>"JobList", "description"=>"An array of job objects", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"Specifies the maximum number of inventory items returned per vault inventory retrievalrequest", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An opaque string that represents where to continue pagination of the results", "type"=>"string"}, {"in"=>"query", "name"=>"Marker (InventoryRetrievalParameters)", "description"=>"An opaque string that represents where to continue pagination of the vault inventoryretrieval results", "type"=>"string"}, {"in"=>"query", "name"=>"RetrievalByteRange", "description"=>"The retrieved byte range for archive retrieval jobs in the formStartByteValue-EndByteValueIf no range was specified in the archive retrieval, then the wholearchive is retrieved and StartByteValue equals 0and EndByteValue equals the size of the archiveminus 1", "type"=>"string"}, {"in"=>"query", "name"=>"SHA256TreeHash", "description"=>"The SHA256 tree hash value for the requested range of an archive", "type"=>"string"}, {"in"=>"query", "name"=>"SNSTopic", "description"=>"The Amazon Resource Name (ARN) that represents an Amazon SNS topic where notification ofjob completion or failure is sent, if notification was configured in thejob initiation (Initiate Job (POST jobs))", "type"=>"string"}, {"in"=>"query", "name"=>"StartDate", "description"=>"The start of the date range in UTC for vault inventory retrieval that includes archivescreated on or after this date", "type"=>"string"}, {"in"=>"query", "name"=>"StatusCode", "description"=>"The job status code", "type"=>"string"}, {"in"=>"query", "name"=>"StatusMessage", "description"=>"The job status message", "type"=>"string"}, {"in"=>"query", "name"=>"Tier", "description"=>"The retrieval option to use for the archive retrieval", "type"=>"string"}, {"in"=>"query", "name"=>"VaultARN", "description"=>"The Amazon Resource Name (ARN) of the vault of which the job is asubresource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/{AccountId}/vaults/{VaultName}/multipart-uploads/{uploadID}"=>{"delete"=>{"summary"=>"Abort Multipart Upload", "description"=>"DescriptionThis multipart upload operation aborts a multipart upload identified by the upload\n\t\t\tID", "operationId"=>"abort Multipart Upload (DELETE uploadID)", "x-api-path-slug"=>"accountidvaultsvaultnamemultipartuploadsuploadid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multipart Uploads"]}, "post"=>{"summary"=>"Complete Multipart Upload", "description"=>"DescriptionYou call this multipart upload operation to inform Amazon Glacier that all the archive parts have\n\t\t\tbeen uploaded and Amazon Glacier can now assemble the archive from the uploaded parts", "operationId"=>"complete Multipart Upload (POST uploadID)", "x-api-path-slug"=>"accountidvaultsvaultnamemultipartuploadsuploadid-post", "parameters"=>[{"type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multipart Uploads"]}, "get"=>{"summary"=>"List Parts", "description"=>"DescriptionThis multipart upload operation lists the parts of an archive that have been uploaded in a\n\t\t\tspecific multipart upload identified by an upload ID", "operationId"=>"list Parts (GET uploadID)", "x-api-path-slug"=>"accountidvaultsvaultnamemultipartuploadsuploadid-get", "parameters"=>[{"in"=>"query", "name"=>"ArchiveDescription", "description"=>"The description of the archive that was specified in the Initiate Multipart Uploadrequest", "type"=>"string"}, {"in"=>"query", "name"=>"CreationDate", "description"=>"The UTC time that the multipart upload was initiated", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An opaque string that represents where to continue pagination of the results", "type"=>"string"}, {"in"=>"query", "name"=>"MultipartUploadId", "description"=>"The ID of the upload to which the parts are associated", "type"=>"string"}, {"in"=>"query", "name"=>"Parts", "description"=>"A list of the part sizes of the multipart upload", "type"=>"string"}, {"in"=>"query", "name"=>"PartSizeInBytes", "description"=>"The part size in bytes", "type"=>"string"}, {"in"=>"query", "name"=>"RangeInBytes", "description"=>"The byte range of a part, inclusive of the upper value of the range", "type"=>"string"}, {"in"=>"query", "name"=>"SHA256TreeHash", "description"=>"The SHA256 tree hash value that Amazon Glacier calculated for the part", "type"=>"string"}, {"in"=>"query", "name"=>"VaultARN", "description"=>"The Amazon Resource Name (ARN) of the vault to which the multipartupload was initiated", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parts"]}, "put"=>{"summary"=>"Upload Part", "description"=>"DescriptionThis multipart upload operation uploads a part of an archive", "operationId"=>"upload Part (PUT uploadID)", "x-api-path-slug"=>"accountidvaultsvaultnamemultipartuploadsuploadid-put", "parameters"=>[{"type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parts"]}}, "/{AccountId}/vaults/{VaultName}/multipart-uploads"=>{"get"=>{"summary"=>"List Multipart Uploads", "description"=>"DescriptionThis multipart upload operation lists in-progress multipart uploads for the specified vault", "operationId"=>"list Multipart Uploads (GET multipart-uploads)", "x-api-path-slug"=>"accountidvaultsvaultnamemultipartuploads-get", "parameters"=>[{"in"=>"query", "name"=>"ArchiveDescription", "description"=>"The description of the archive that was specified in the Initiate Multipart Uploadrequest", "type"=>"string"}, {"in"=>"query", "name"=>"CreationDate", "description"=>"The UTC time that the multipart upload was initiated", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An opaque string that represents where to continue pagination of the results", "type"=>"string"}, {"in"=>"query", "name"=>"MultipartUploadId", "description"=>"The ID of the multipart upload", "type"=>"string"}, {"in"=>"query", "name"=>"PartSizeInBytes", "description"=>"The part size specified in the Initiate Multipart Upload (POSTmultipart-uploads) request", "type"=>"string"}, {"in"=>"query", "name"=>"UploadsList", "description"=>"A list of metadata about multipart upload objects", "type"=>"string"}, {"in"=>"query", "name"=>"VaultARN", "description"=>"The Amazon Resource Name (ARN) of the vault that contains the archive", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multipart Uploads"]}}, "/{AccountId}/vaults/{vaultName}/lock-policy"=>{"delete"=>{"summary"=>"Abort Vault Lock", "description"=>"DescriptionThis operation aborts the vault locking process if the vault lock is not in the\n\t\t\t\tLocked state. If the vault lock is in the Locked state\n\t\t\twhen this operation is requested, the operation returns an\n\t\t\t\tAccessDeniedException error. Aborting the vault locking process removes\n\t\t\tthe vault lock policy from the specified vault. A vault lock is put into the InProgress state by calling Initiate Vault Lock (POST lock-policy). A vault\n\t\t\tlock is put into the Locked state by calling Complete Vault Lock (POST lockId). You can\n\t\t\tget the state of a vault lock by calling Get Vault Lock (GET lock-policy). For more information about the vault\n\t\t\tlocking process, see Amazon Glacier Vault Lock. For more\n\t\t\tinformation about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.This operation is idempotent. You can successfully invoke this operation multiple times, if\n\t\t\tthe vault lock is in the InProgress state or if there is no policy\n\t\t\tassociated with the vault.RequestsTo delete the vault lock policy, send an HTTP DELETE request to the URI\n\t\t\tof the vault's lock-policy subresource.", "operationId"=>"Abort Vault Lock (DELETE lock-policy)", "x-api-path-slug"=>"accountidvaultsvaultnamelockpolicy-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vault Locks"]}, "get"=>{"summary"=>"Get Vault Lock", "description"=>"DescriptionThis operation retrieves the following attributes from the lock-policy\n\t\t\tsubresource set on the specified vault: \n\t\t\tThe vault lock policy set on the vault.The state of the vault lock, which is either InProgess or\n\t\t\t\t\t\t\tLocked.When the lock ID expires. The lock ID is used to complete the vault locking\n\t\t\t\t\t\tprocess.When the vault lock was initiated and put into the InProgress state.\n\t\tA vault lock is put into the InProgress state by calling Initiate Vault Lock (POST lock-policy). A vault\n\t\t\tlock is put into the Locked state by calling Complete Vault Lock (POST lockId). You can\n\t\t\tabort the vault locking process by calling Abort Vault Lock (DELETE lock-policy). For more information about the vault locking\n\t\t\tprocess, see Amazon Glacier Vault Lock.If there is no vault lock policy set on the vault, the operation returns a 404 Not\n\t\t\t\tfound error. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.RequestsTo return the current vault lock policy and other attributes, send an HTTP GET\n\t\t\trequest to the URI of the vault's lock-policy subresource as shown in the\n\t\t\tfollowing syntax example.", "operationId"=>"Get Vault Lock (GET lock-policy)", "x-api-path-slug"=>"accountidvaultsvaultnamelockpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"CreationDate", "description"=>"The UTC date and time at which the vault lock was put into the InProgressstate", "type"=>"string"}, {"in"=>"query", "name"=>"ExpirationDate", "description"=>"The UTC date and time at which the lock ID expires", "type"=>"string"}, {"in"=>"query", "name"=>"Policy", "description"=>"The vault lock policy as a JSON string, which uses \\ as an escape character", "type"=>"string"}, {"in"=>"query", "name"=>"State", "description"=>"The state of the vault lock", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vault Locks"]}, "post"=>{"summary"=>"Initiate Vault Lock", "description"=>"DescriptionThis operation initiates the vault locking process by doing the following: Installing a vault lock policy on the specified vault.Setting the lock state of vault lock to InProgress.Returning a lock ID, which is used to complete the vault locking process.\n\t\t\t\t\t\n\t\tYou can set one vault lock policy for each vault and this policy can be up to 20 KB in size.\n\t\t\tFor more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.You must complete the vault locking process within 24 hours after the vault lock enters the\n\t\t\t\tInProgress state. After the 24 hour window ends, the lock ID expires,\n\t\t\tthe vault automatically exits the InProgress state, and the vault lock\n\t\t\tpolicy is removed from the vault. You call Complete Vault Lock (POST lockId) to complete the vault locking process by\n\t\t\tsetting the state of the vault lock to Locked. NoteAfter a vault lock is in the Locked state, you cannot initiate a new vault lock\n\t\t\t\tfor the vault.You can abort the vault locking process by calling Abort Vault Lock (DELETE lock-policy). You can get the state of the vault lock by\n\t\t\tcalling Get Vault Lock (GET lock-policy). For more\n\t\t\tinformation about the vault locking process, see Amazon Glacier Vault Lock.If this operation is called when the vault lock is in the InProgress state, the\n\t\t\toperation returns an AccessDeniedException error. When the vault lock is in\n\t\t\tthe InProgress state you must call Abort Vault Lock (DELETE lock-policy) before you can initiate a new vault lock\n\t\t\tpolicy. RequestsTo initiate the vault locking process, send an HTTP POST request to the URI of\n\t\t\tthe lock-policy subresource of the vault, as shown in the following syntax\n\t\t\texample.", "operationId"=>"Initiate Vault Lock (POST lock-policy)", "x-api-path-slug"=>"accountidvaultsvaultnamelockpolicy-post", "parameters"=>[{"type"=>"string"}, {"in"=>"query", "name"=>"Policy", "description"=>"The vault lock policy as a JSON string, which uses \\ as an escapecharacter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vault Locks"]}}, "/{AccountId}/vaults/{VaultName}"=>{"put"=>{"summary"=>"Create Vault", "description"=>"DescriptionThis operation creates a new vault with the specified name. The name of the vault must be\n\t\t\tunique within a region for an AWS account. You can create up to 1,000 vaults per\n\t\t\taccount. For information on creating more vaults, go to the Amazon Glacier product detail\n\t\t\tpage.You must use the following guidelines when naming a vault. \n\t\t\t Names can be between 1 and 255 characters long. Allowed characters are a–z, A–Z, 0–9, '_' (underscore), '-' (hyphen),\n\t\t\t\t\t\tand '.' (period).\n\t\tThis operation is idempotent, you can send the same request multiple times and it has no\n\t\t\tfurther effect after the first time Amazon Glacier creates the specified vault.Requests", "operationId"=>"Create Vault (PUT vault)", "x-api-path-slug"=>"accountidvaultsvaultname-put", "parameters"=>[{"type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vaults"]}, "delete"=>{"summary"=>"Delete Vault", "description"=>"DescriptionThis operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives\n\t\t\tin the vault as per the last inventory and there have been no writes to the vault since\n\t\t\tthe last inventory. If either of these conditions is not satisfied, the vault deletion\n\t\t\tfails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use the Describe Vault (GET vault)\n\t\t\toperation that provides vault information, including the number of archives in the vault;\n\t\t\thowever, the information is based on the vault inventory Amazon Glacier last\n\t\t\tgenerated.This operation is idempotent.NoteWhen you delete a vault, the vault access policy attached to the vault is also deleted. \n\t\t\t\tFor more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.RequestsTo delete a vault, send a DELETE request to the vault resource URI.", "operationId"=>"Delete Vault (DELETE vault)", "x-api-path-slug"=>"accountidvaultsvaultname-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vaults"]}, "get"=>{"summary"=>"Describe Vault", "description"=>"DescriptionThis operation returns information about a vault, including the vault Amazon Resource Name\n\t\t\t(ARN), the date the vault was created, the number of archives contained within the\n\t\t\tvault, and the total size of all the archives in the vault. The number of archives and\n\t\t\ttheir total size are as of the last vault inventory Amazon Glacier generated (see Working with Vaults in Amazon Glacier). Amazon Glacier\n\t\t\tgenerates vault inventories approximately daily. This means that if you add or remove an\n\t\t\tarchive from a vault, and then immediately send a Describe Vault request, the response\n\t\t\tmight not reflect the changes. RequestsTo get information about a vault, send a GET request to the URI of the specific\n\t\t\tvault resource.", "operationId"=>"Describe Vault (GET vault)", "x-api-path-slug"=>"accountidvaultsvaultname-get", "parameters"=>[{"in"=>"query", "name"=>"CreationDate", "description"=>"The UTC date when the vault was created", "type"=>"string"}, {"in"=>"query", "name"=>"LastInventoryDate", "description"=>"The UTC date when Amazon Glacier completed the last vault inventory", "type"=>"string"}, {"in"=>"query", "name"=>"NumberOfArchives", "description"=>"The number of archives in the vault as per the last vault inventory", "type"=>"string"}, {"in"=>"query", "name"=>"SizeInBytes", "description"=>"The total size in bytes of the archives in the vault including any per-archive overhead,as of the last inventory date", "type"=>"string"}, {"in"=>"query", "name"=>"VaultARN", "description"=>"The Amazon Resource Name (ARN) of the vault", "type"=>"string"}, {"in"=>"query", "name"=>"VaultName", "description"=>"The vault name that was specified at creation time", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vaults"]}}, "/{AccountId}/vaults/{vaultName}/lock-policy/{lockId}"=>{"post"=>{"summary"=>"Complete Vault Lock", "description"=>"DescriptionThis operation completes the vault locking process by transitioning the vault lock from\n the InProgress state to the Locked state, which causes the vault\n lock policy to become unchangeable. A vault lock is put into the InProgress\n state by calling Initiate Vault Lock (POST lock-policy). You can obtain the state of the vault lock by\n calling Get Vault Lock (GET lock-policy). For more\n information about the vault locking process, see Amazon Glacier Vault Lock. This operation is idempotent. This request is always successful if the vault lock is in the\n Locked state and the provided lock ID matches the lock ID originally used to\n lock the vault.If an invalid lock ID is passed in the request when the vault lock is in the Locked state,\n the operation returns an AccessDeniedException error. If an invalid lock ID is\n passed in the request when the vault lock is in the InProgress state, the operation throws an\n InvalidParameter error.RequestsTo complete the vault locking process, send an HTTP POST request to the URI\n of the vault's lock-policy subresource with a valid lock ID.", "operationId"=>"Complete Vault Lock (POST lockId)", "x-api-path-slug"=>"accountidvaultsvaultnamelockpolicylockid-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vault Locks"]}}, "/{AccountId}/vaults/{vaultName}/access-policy"=>{"delete"=>{"summary"=>"Delete Vault Access Policy", "description"=>"DescriptionThis operation deletes the access policy associated with the specified vault. The\n\t\t\toperation is eventually consistent—that is, it might take some time for Amazon Glacier to\n\t\t\tcompletely remove the access policy, and you might still see the effect of the policy\n\t\t\tfor a short time after you send the delete request. This operation is idempotent. You can invoke delete multiple times, even if there is\n\t\t\tno policy associated with the vault. For more information about vault access policies,\n\t\t\tsee Amazon Glacier Access Control with Vault Access Policies.RequestsTo delete the current vault access policy, send an HTTP DELETE request to\n\t\t\tthe URI of the vault's access-policy subresource.", "operationId"=>"Delete Vault Access Policy (DELETE\n\t\taccess-policy)", "x-api-path-slug"=>"accountidvaultsvaultnameaccesspolicy-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vault Access Policies"]}, "get"=>{"summary"=>"Get Vault Access Policy", "description"=>"DescriptionThis operation retrieves the access-policy subresource set on the\n\t\t\tvault—for more information on setting this subresource, see Set Vault Access Policy (PUT access-policy). If\n\t\t\tthere is no access policy set on the vault, the operation returns a 404 Not\n\t\t\t\tfound error. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.RequestsTo return the current vault access policy, send an HTTP GET request to\n\t\t\tthe URI of the vault's access-policy subresource.", "operationId"=>"Get Vault Access Policy (GET access-policy)", "x-api-path-slug"=>"accountidvaultsvaultnameaccesspolicy-get", "parameters"=>[{"in"=>"query", "name"=>"Policy", "description"=>"The vault access policy as a JSON string, which uses \\ as an escape character", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vault Access Policies"]}, "put"=>{"summary"=>"Set Vault Access Policy", "description"=>"DescriptionThis operation configures an access policy for a vault and will overwrite an existing\n\t\t\tpolicy. To configure a vault access policy, send a PUT request to the\n\t\t\t\taccess-policy subresource of the vault. You can set one access policy per vault\n\t\t\tand the policy can be up to 20 KB in size. For more information about vault access\n\t\t\tpolicies, see Amazon Glacier Access Control with Vault Access Policies. Requests", "operationId"=>"Set Vault Access Policy (PUT access-policy)", "x-api-path-slug"=>"accountidvaultsvaultnameaccesspolicy-put", "parameters"=>[{"in"=>"query", "name"=>"Policy", "description"=>"The vault access policy as a JSON string, which uses \\ as an escape character", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vault Access Policies"]}}, "/{AccountId}/vaults/{VaultName}/notification-configuration"=>{"delete"=>{"summary"=>"Delete Vault Notifications", "description"=>"DescriptionThis operation deletes the notification configuration set for a vault \n\t\t\tSet Vault Notification Configuration (PUT\n\t\tnotification-configuration). The operation is\n\t\t\teventually consistent—that is, it might take some time for Amazon Glacier to\n\t\t\tcompletely disable the notifications, and you might still receive some notifications for\n\t\t\ta short time after you send the delete request. RequestsTo delete a vault's notification configuration, send a DELETE request to the\n\t\t\tvault's notification-configuration subresource.", "operationId"=>"Delete Vault Notifications (DELETE\n\t\tnotification-configuration)", "x-api-path-slug"=>"accountidvaultsvaultnamenotificationconfiguration-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vault Notifications"]}, "get"=>{"summary"=>"Get Vault Notifications", "description"=>"DescriptionThis operation retrieves the notification-configuration subresource set on the\n\t\t\tvault (see Set Vault Notification Configuration (PUT\n\t\tnotification-configuration). If notification configuration for a\n\t\t\tvault is not set, the operation returns a 404 Not Found error. For more\n\t\t\tinformation about vault notifications, see Configuring Vault Notifications in Amazon Glacier. RequestsTo retrieve the notification configuration information, send a GET request to\n\t\t\tthe URI of a vault's notification-configuration subresource.", "operationId"=>"Get Vault Notifications (GET\n\t\tnotification-configuration)", "x-api-path-slug"=>"accountidvaultsvaultnamenotificationconfiguration-get", "parameters"=>[{"in"=>"query", "name"=>"Events", "description"=>"A list of one or more events for which Amazon Glacier will send a notification to thespecified Amazon SNS topic", "type"=>"string"}, {"in"=>"query", "name"=>"SNSTopic", "description"=>"The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vault Notifications"]}, "put"=>{"summary"=>"Set Vault Notification Configuration", "description"=>"DescriptionRetrieving an archive and a vault inventory are asynchronous operations in Amazon Glacier for which\n\t\t\tyou must first initiate a job and wait for the job to complete before you can download\n\t\t\tthe job output. Most Amazon Glacier jobs take about four hours to complete. You can configure a\n\t\t\tvault to post a message to an Amazon Simple Notification Service (Amazon SNS) topic when these jobs complete. You can\n\t\t\tuse this operation to set notification configuration on the vault. For more information,\n\t\t\tsee Configuring Vault Notifications in Amazon Glacier.\n\t\t\t\n\t\tTo configure vault notifications, send a PUT request to the\n\t\t\t\tnotification-configuration subresource of the vault. A notification\n\t\t\tconfiguration is specific to a vault; therefore, it is also referred to as a vault\n\t\t\tsubresource. The request should include a JSON document that provides an Amazon Simple Notification Service (Amazon SNS) topic and the events for which you want Amazon Glacier to\n\t\t\tsend notifications to the topic.You can configure a vault to publish a notification for the following vault events:\n\t\t\tArchiveRetrievalCompleted— This event\n\t\t\t\t\t\toccurs when a job that was initiated for an archive retrieval is completed\n\t\t\t\t\t\t\t(Initiate Job (POST jobs)). The status of the completed\n\t\t\t\t\t\tjob can be Succeeded or Failed. The notification\n\t\t\t\t\t\tsent to the SNS topic is the same output as returned from Describe Job (GET JobID).InventoryRetrievalCompleted— This event\n\t\t\t\t\t\toccurs when a job that was initiated for an inventory retrieval is completed\n\t\t\t\t\t\t\t(Initiate Job (POST jobs)). The status of the completed\n\t\t\t\t\t\tjob can be Succeeded or Failed. The notification\n\t\t\t\t\t\tsent to the SNS topic is the same output as returned from Describe Job (GET JobID).\n\t\tAmazon SNS topics must grant permission to the vault to be allowed to publish notifications\n\t\t\tto the topic.RequestsTo set notification configuration on your vault, send a PUT request to the URI of the\n\t\t\tvault's notification-configuration subresource. You specify the\n\t\t\tconfiguration in the request body. The configuration includes the Amazon SNS topic name\n\t\t\tand an array of events that trigger notification to each topic.", "operationId"=>"Set Vault Notification Configuration (PUT\n\t\tnotification-configuration)", "x-api-path-slug"=>"accountidvaultsvaultnamenotificationconfiguration-put", "parameters"=>[{"in"=>"query", "name"=>"Events", "description"=>"An array of one or more events for which you want Amazon Glacier to sendnotification", "type"=>"string"}, {"in"=>"query", "name"=>"SNSTopic", "description"=>"The Amazon SNS topic ARN", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vault Notifications"]}}, "/{AccountId}/vaults"=>{"get"=>{"summary"=>"List Vaults", "description"=>"DescriptionThis operation lists all vaults owned by the calling user’s account. The list returned in\n\t\t\tthe response is ASCII-sorted by vault name. By default, this operation returns up to 1,000 items per request. If there are more vaults\n\t\t\tto list, the marker field in the response body contains the vault Amazon\n\t\t\tResource Name (ARN) at which to continue the list with a new List Vaults request;\n\t\t\totherwise, the marker field is null. In your next List Vaults\n\t\t\trequest you set the marker parameter to the value Amazon Glacier returned in the\n\t\t\tresponses to your previous List Vaults request. You can also limit the number of vaults\n\t\t\treturned in the response by specifying the limit parameter in the request. RequestsTo get a list of vaults, you send a GET request to the\n\t\t\t\tvaults resource.", "operationId"=>"List Vaults (GET vaults)", "x-api-path-slug"=>"accountidvaults-get", "parameters"=>[{"in"=>"query", "name"=>"CreationDate", "description"=>"The date the vault was created, in Coordinated Universal Time (UTC)", "type"=>"string"}, {"in"=>"query", "name"=>"LastInventoryDate", "description"=>"The date of the last vault inventory, in Coordinated Universal Time (UTC)", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"The vaultARN that represents where to continue pagination of the results", "type"=>"string"}, {"in"=>"query", "name"=>"NumberOfArchives", "description"=>"The number of archives in the vault as of the last inventory date", "type"=>"string"}, {"in"=>"query", "name"=>"SizeInBytes", "description"=>"The total size, in bytes, of all the archives in the vault including any per-archiveoverhead, as of the last inventory date", "type"=>"string"}, {"in"=>"query", "name"=>"VaultARN", "description"=>"The Amazon Resource Name (ARN) of the vault", "type"=>"string"}, {"in"=>"query", "name"=>"VaultList", "description"=>"An array of objects, with each object providing a description of a vault", "type"=>"string"}, {"in"=>"query", "name"=>"VaultName", "description"=>"The vault name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vaults"]}}, "/{AccountId}/vaults/{VaultName}/archives/{ArchiveID}"=>{"delete"=>{"summary"=>"Delete Archive", "description"=>"DescriptionThis operation deletes an archive from a vault. You can delete one archive at a time from a vault. \n\t\t\tTo delete the archive you must provide its archive ID in the delete request. \n\t\t\tYou can get the archive ID by downloading the vault inventory for the vault that contains the archive. \n\t\t\tFor more information about downloading the vault inventory, \n\t\t\tsee Downloading a Vault Inventory in Amazon Glacier.After you delete an archive, you might still\n\t\t\tbe able to make a successful request to initiate a job to retrieve the deleted archive,\n\t\t\tbut the archive retrieval job will fail. Archive retrievals that are in progress for an archive ID when you delete the\n\t\t\tarchive might or might not succeed according to the following scenarios:\n\t\t\tIf the archive retrieval job is actively preparing the data for download when Amazon Glacier\n\t\t\t\t\t\treceives the delete archive request, the archival retrieval\toperation might fail. If the archive retrieval job has successfully prepared the archive for download when\n\t\t\t\t\t\tAmazon Glacier receives the delete archive request, you will be able to\n\t\t\t\t\t\tdownload the output. \n\t\tFor more information about archive retrieval, see \n\t\t\tDownloading an Archive in Amazon Glacier. This operation is idempotent. Attempting\n\t\t\tto delete an already-deleted archive does not result in an error. RequestsTo delete an archive you send a DELETE request to the archive resource\n\t\t\tURI.", "operationId"=>"Delete Archive (DELETE archive)", "x-api-path-slug"=>"accountidvaultsvaultnamearchivesarchiveid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Archives"]}}, "Synta"=>{"syntax"=>{"summary"=>"List Provisioned Capacity", "description"=>"List Provisioned Capacity (GET\n provisioned-capacity)This operation lists the provisioned capacity for the specified AWS account.\n Request SyntaxTo list the provisioned retrieval capacity for an account, send an HTTP GET request\n to the provisioned-capacity URI as shown in the following syntax example.GET /AccountId/provisioned-capacity HTTP/1.1\nHost: glacier.Region.amazonaws.com\nDate: Date\nAuthorization: SignatureValue\nx-amz-glacier-version: 2012-06-01\n\n NoteThe AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.\n Request ParametersThis operation does not use request parameters.Request HeadersThis operation uses only request headers that are common to all operations. For information about common request headers, see \n\tCommon Request Headers.Request BodyThis operation does not have a request body.ResponsesIf the operation is successful, the service sends back an HTTP 200 OK response.", "operationId"=>"List Provisioned Capacity (GET\n provisioned-capacity)", "x-api-path-slug"=>"synta-syntax", "parameters"=>[{"in"=>"query", "name"=>"CapacityId", "description"=>"The ID that identifies the provisioned capacity unit", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"ExpirationDate", "description"=>"The date that the provisioned capacity unit expires, in Coordinated Universal Time (UTC)", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId.N", "description"=>"One or more network interface IDs", "type"=>"string"}, {"in"=>"query", "name"=>"StartDate", "description"=>"The date that the provisioned capacity unit was purchased, in Coordinated Universal Time (UTC)", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys", "description"=>"A list of tag keys", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"The tags attached to the vault", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"AWS Glacier", "x-slug"=>"aws-glacier", "description"=>"Amazon Glacier is a secure, durable, and extremely low-cost cloud storage service for data archiving and long-term backup. Customers can reliably store large or small amounts of data for as little as $0.004 per gigabyte per month, a significant savings compared to on-premises solutions. To keep costs low yet suitable for varying retrieval needs, Amazon Glacier provides three options for access to archives, from a few minutes to several hours.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Storage-Content-Delivery_AmazonGlacier.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Profiles,Relative Data,Service API,Stack Network,Storage", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-glacier/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Amazon Glacier API", "x-api-slug"=>"amazon-glacier-api", "description"=>"Amazon Glacier is a secure, durable, and extremely low-cost cloud storage service for data archiving and long-term backup. Customers can reliably store large or small amounts of data for as little as $0.004 per gigabyte per month, a significant savings compared to on-premises solutions. To keep costs low yet suitable for varying retrieval needs, Amazon Glacier provides three options for access to archives, from a few minutes to several hours.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Storage-Content-Delivery_AmazonGlacier.png", "humanURL"=>"https://aws.amazon.com/glacier/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Profiles,Relative Data,Service API,Stack Network,Storage", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-glacier/amazon-glacier-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-log", "url"=>"http://aws.amazon.com/releasenotes/Amazon-Glacier/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/amazonglacier/latest/dev/amazon-glacier-api.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/glacier/faqs/"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=140"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/glacier/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/glacier/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/glacier/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
climacell{"climacell-openapi"=>false, "apis"=>{"name"=>"ClimaCell", "x-slug"=>"climacell", "description"=>"ClimaCell provides the most accurate weather data in the world by integrating proprietary data extracted from wireless networks and other new sensing technologies with data from traditional sensors. With 90% correlation to ground truth (vs. 50% using radar), it’s the best you can get for your enterprise.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28707-climacell.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"617213", "tags"=>"API Provider,General Data,Profiles,Weather", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"climacell/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"ClimaCell", "x-api-slug"=>"climacell", "description"=>"ClimaCell provides the most accurate weather data in the world by integrating proprietary data extracted from wireless networks and other new sensing technologies with data from traditional sensors. With 90% correlation to ground truth (vs. 50% using radar), it’s the best you can get for your enterprise.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28707-climacell.jpg", "humanURL"=>"https://www.climacell.co", "baseURL"=>"https://api2.climacell.co//v2", "tags"=>"API Provider,General Data,Profiles,Weather", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/climacell/climacell-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://www.climacell.co/blog/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/climacell"}, {"type"=>"x-developer", "url"=>"https://www.climacell.co/api/"}, {"type"=>"x-email", "url"=>"info@climacell.co"}, {"type"=>"x-email", "url"=>"support@climacell.co"}, {"type"=>"x-email", "url"=>"sales@climacell.co"}, {"type"=>"x-faq", "url"=>"https://developer.climacell.co/FAQ"}, {"type"=>"x-github", "url"=>"https://github.com/climacell"}, {"type"=>"x-pricing", "url"=>"https://developer.climacell.co/"}, {"type"=>"x-privacy-policy", "url"=>"https://www.climacell.co/privacy/"}, {"type"=>"x-terms-of-service", "url"=>"https://www.climacell.co/terms-of-service/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/WeatherRevealed"}, {"type"=>"x-website", "url"=>"https://www.climacell.co"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
flickr{"flickr-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Flickr", "x-complete"=>1, "info"=>{"title"=>"Flickr", "description"=>"explore-upload-and-organize-photos-on-flickr", "version"=>"1.0.0"}, "host"=>"api.flickr.com", "basePath"=>"/services/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/upload"=>{"post"=>{"summary"=>"Upload", "description"=>"Uploads a photo. Uploading apps can call the flickr.people.getUploadStatus method in the regular API to obtain file and bandwidth limits for the user.", "operationId"=>"postUpload", "x-api-path-slug"=>"upload-post", "parameters"=>[{"in"=>"query", "name"=>"async", "description"=>"Flickr can process photos in async mode, for applications that need to post multiple photos and dont want to wait around for each one to complete, leaving a socket connection open the whole time"}, {"in"=>"query", "name"=>"content_type", "description"=>"Set to 1 for Photo, 2 for Screenshot, or 3 for Other"}, {"in"=>"query", "name"=>"description", "description"=>"A description of the photo"}, {"in"=>"query", "name"=>"hidden", "description"=>"Set to 1 to keep the photo in global search results, 2 to hide from public searches"}, {"in"=>"query", "name"=>"is_family", "description"=>"Set to 0 for no, 1 for yes"}, {"in"=>"query", "name"=>"is_friend", "description"=>"Set to 0 for no, 1 for yes"}, {"in"=>"query", "name"=>"is_public", "description"=>"Set to 0 for no, 1 for yes"}, {"in"=>"query", "name"=>"safety_level", "description"=>"Set to 1 for Safe, 2 for Moderate, or 3 for Restricted"}, {"in"=>"query", "name"=>"tags", "description"=>"A space-seperated list of tags to apply to the photo"}, {"in"=>"query", "name"=>"title", "description"=>"The title of the photo"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload"]}}, "/replace"=>{"post"=>{"summary"=>"Replace", "description"=>"Replaces a photo that has already been uploaded to Flickr. Uploading apps can call the flickr.people.getUploadStatus method in the regular API to obtain file and bandwidth limits for the user.", "operationId"=>"postReplace", "x-api-path-slug"=>"replace-post", "parameters"=>[{"in"=>"query", "name"=>"async", "description"=>"Photos may be replaced in async mode, for applications that dont want to wait around for an upload to complete, leaving a socket connection open the whole time"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The ID of the photo to replace"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replace"]}}, "/rest/?method=flickr.activity.userComments"=>{"get"=>{"summary"=>"Activity User Comments", "description"=>"Returns a list of recent activity on photos commented on by the calling user. Do not poll this method more than once an hour.", "operationId"=>"getRestMethodFlickr.activity.usercomments", "x-api-path-slug"=>"restmethodflickr-activity-usercomments-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity", "UserComments"]}}, "/rest/?method=flickr.activity.userPhotos"=>{"get"=>{"summary"=>"Activity User Photos", "description"=>"Returns a list of recent activity on photos commented on by the calling user. Do not poll this method more than once an hour.", "operationId"=>"getRestMethodFlickr.activity.userphotos", "x-api-path-slug"=>"restmethodflickr-activity-userphotos-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items to return per page"}, {"in"=>"query", "name"=>"timeframe", "description"=>"The timeframe in which to return updates for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity", "UserPhotos"]}}, "/rest/?method=flickr.auth.checkToken"=>{"get"=>{"summary"=>"Auth Check Token", "description"=>"Returns the credentials attached to an authentication token. This call must be signed as specified in the authentication API spec.", "operationId"=>"getRestMethodFlickr.auth.checktoken", "x-api-path-slug"=>"restmethodflickr-auth-checktoken-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"auth_token", "description"=>"The authentication token to check"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auth", "CheckToken"]}}, "/rest/?method=flickr.auth.getFrob"=>{"get"=>{"summary"=>"Auth Get Frob", "description"=>"Returns a frob to be used during authentication. This method call must be signed, and is deprecated in favour of OAuth.", "operationId"=>"getRestMethodFlickr.auth.getfrob", "x-api-path-slug"=>"restmethodflickr-auth-getfrob-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auth", "GetFrob"]}}, "/rest/?method=flickr.auth.getFullToken"=>{"get"=>{"summary"=>"Auth Get Full Token", "description"=>"Get the full authentication token for a mini-token. This method call must be signed.", "operationId"=>"getRestMethodFlickr.auth.getfulltoken", "x-api-path-slug"=>"restmethodflickr-auth-getfulltoken-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"mini_token", "description"=>"The mini-token typed in by a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auth", "GetFullToken"]}}, "/rest/?method=flickr.auth.getToken"=>{"get"=>{"summary"=>"Auth Get Token", "description"=>"Returns the auth token for the given frob, if one has been attached. This method call must be signed, and is deprecated in favour of OAuth.", "operationId"=>"getRestMethodFlickr.auth.gettoken", "x-api-path-slug"=>"restmethodflickr-auth-gettoken-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"frob", "description"=>"The frob to check"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auth", "GetToken"]}}, "/rest/?method=flickr.auth.oauth.getAccessToken"=>{"get"=>{"summary"=>"Auth Oauth Get Access Token", "description"=>"Exchange an auth token from the old Authentication API, to an OAuth access token. Calling this method will delete the auth token used to make the request. The request must be signed.", "operationId"=>"getRestMethodFlickr.auth.oauth.getaccesstoken", "x-api-path-slug"=>"restmethodflickr-auth-oauth-getaccesstoken-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auth", "Oauth", "GetAccessToken"]}}, "/rest/?method=flickr.blogs.getList"=>{"get"=>{"summary"=>"Blogs Get List", "description"=>"Get a list of configured blogs for the calling user.", "operationId"=>"getRestMethodFlickr.blogs.getlist", "x-api-path-slug"=>"restmethodflickr-blogs-getlist-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"service", "description"=>"Optionally only return blogs for a given service id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blogs", "GetList"]}}, "/rest/?method=flickr.blogs.getServices"=>{"get"=>{"summary"=>"Blogs Get Services", "description"=>"Returns a list of Flickr supported blogging services.", "operationId"=>"getRestMethodFlickr.blogs.getservices", "x-api-path-slug"=>"restmethodflickr-blogs-getservices-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blogs", "GetServices"]}}, "/rest/?method=flickr.blogs.postPhoto"=>{"get"=>{"summary"=>"Blogs Add Photo", "description"=>"Posts a photo to a blog.", "operationId"=>"getRestMethodFlickr.blogs.addphoto", "x-api-path-slug"=>"restmethodflickr-blogs-postphoto-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"blog_id", "description"=>"The ID of the blog to post to"}, {"in"=>"query", "name"=>"blog_password", "description"=>"The password for the blog (used when the blog does not have a stored password)"}, {"in"=>"query", "name"=>"description", "description"=>"The blog post body"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The ID of the photo to blog"}, {"in"=>"query", "name"=>"service", "description"=>"A Flickr supported blogging service"}, {"in"=>"query", "name"=>"title", "description"=>"The blog post title"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blogs", "PostPhoto"]}}, "/rest/?method=flickr.collections.getInfo"=>{"get"=>{"summary"=>"Collections Get Info", "description"=>"Returns information for a single collection. Currently can only be called by the collection owner, this may change.", "operationId"=>"getRestMethodFlickr.collections.getinfo", "x-api-path-slug"=>"restmethodflickr-collections-getinfo-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"collection_id", "description"=>"The ID of the collection to fetch information for"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collections", "GetInfo"]}}, "/rest/?method=flickr.collections.getTree"=>{"get"=>{"summary"=>"Collections Get Tree", "description"=>"Returns a tree (or sub tree) of collections belonging to a given user.", "operationId"=>"getRestMethodFlickr.collections.gettree", "x-api-path-slug"=>"restmethodflickr-collections-gettree-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"collection_id", "description"=>"The ID of the collection to fetch a tree for, or zero to fetch the root collection"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"user_id", "description"=>"The ID of the account to fetch the collection tree for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collections", "GetTree"]}}, "/rest/?method=flickr.commons.getInstitutions"=>{"get"=>{"summary"=>"Commons Get Institutions", "description"=>"Retrieves a list of the current Commons institutions.", "operationId"=>"getRestMethodFlickr.commons.getinstitutions", "x-api-path-slug"=>"restmethodflickr-commons-getinstitutions-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commons", "GetInstitutions"]}}, "/rest/?method=flickr.contacts.getList"=>{"get"=>{"summary"=>"Contacts Get List", "description"=>"Get a list of contacts for the calling user.", "operationId"=>"getRestMethodFlickr.contacts.getlist", "x-api-path-slug"=>"restmethodflickr-contacts-getlist-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"filter", "description"=>"An optional filter of the results"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "GetList"]}}, "/rest/?method=flickr.contacts.getListRecentlyUploaded"=>{"get"=>{"summary"=>"Contacts Get List Recently Uploaded", "description"=>"Return a list of contacts for a user who have recently uploaded photos along with the total count of photos uploaded. This method is still considered experimental. We don't plan for it to change or to go away but so long as this notice is present you should write your code accordingly.", "operationId"=>"getRestMethodFlickr.contacts.getlistrecentlyuploaded", "x-api-path-slug"=>"restmethodflickr-contacts-getlistrecentlyuploaded-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"date_lastupload", "description"=>"Limits the resultset to contacts that have uploaded photos since this date"}, {"in"=>"query", "name"=>"filter", "description"=>"Limit the result set to all contacts or only those who are friends or family"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "GetListRecentlyUploaded"]}}, "/rest/?method=flickr.contacts.getPublicList"=>{"get"=>{"summary"=>"Contacts Get Public List", "description"=>"Get the contact list for a user.", "operationId"=>"getRestMethodFlickr.contacts.getpubliclist", "x-api-path-slug"=>"restmethodflickr-contacts-getpubliclist-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user to fetch the contact list for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "GetPublicList"]}}, "/rest/?method=flickr.favorites.add"=>{"get"=>{"summary"=>"Favorites Add", "description"=>"Adds a photo to a user's favorites list.", "operationId"=>"getRestMethodFlickr.favorites.add", "x-api-path-slug"=>"restmethodflickr-favorites-add-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to add to the users favorites"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Favorites", "Add"]}}, "/rest/?method=flickr.favorites.getList"=>{"get"=>{"summary"=>"Favorites Get List", "description"=>"Returns a list of the user's favorite photos. Only photos which the calling user has permission to see are returned.", "operationId"=>"getRestMethodFlickr.favorites.getlist", "x-api-path-slug"=>"restmethodflickr-favorites-getlist-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"max_fave_date", "description"=>"Maximum date that a photo was favorited on"}, {"in"=>"query", "name"=>"min_fave_date", "description"=>"Minimum date that a photo was favorited on"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Favorites", "GetList"]}}, "/rest/?method=flickr.favorites.getPublicList"=>{"get"=>{"summary"=>"Favorites Get Public List", "description"=>"Returns a list of favorite public photos for the given user.", "operationId"=>"getRestMethodFlickr.favorites.getpubliclist", "x-api-path-slug"=>"restmethodflickr-favorites-getpubliclist-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"max_fave_date", "description"=>"Maximum date that a photo was favorited on"}, {"in"=>"query", "name"=>"min_fave_date", "description"=>"Minimum date that a photo was favorited on"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}, {"in"=>"query", "name"=>"user_id", "description"=>"The user to fetch the favorites list for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Favorites", "GetPublicList"]}}, "/rest/?method=flickr.favorites.remove"=>{"get"=>{"summary"=>"Favorites Remove", "description"=>"Adds a photo to a user's favorites list.", "operationId"=>"getRestMethodFlickr.favorites.remove", "x-api-path-slug"=>"restmethodflickr-favorites-remove-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to remove to the users favorites"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Favorites", "Remove"]}}, "/rest/?method=flickr.galleries.addPhoto"=>{"post"=>{"summary"=>"Galleries Add Photo", "description"=>"Add a photo to a gallery.", "operationId"=>"postRestMethodFlickr.galleries.addphoto", "x-api-path-slug"=>"restmethodflickr-galleries-addphoto-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"comment", "description"=>"A short comment or story to accompany the photo"}, {"in"=>"query", "name"=>"gallery_id", "description"=>"The ID of the gallery to add a photo to"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The photo ID to add to the gallery"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Galleries", "AddPhoto"]}}, "/rest/?method=flickr.galleries.create"=>{"post"=>{"summary"=>"Galleries Create", "description"=>"Create a new gallery for the calling user.", "operationId"=>"postRestMethodFlickr.galleries.create", "x-api-path-slug"=>"restmethodflickr-galleries-create-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"description", "description"=>"A short description for the gallery"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"primary_photo_id", "description"=>"The first photo to add to your gallery"}, {"in"=>"query", "name"=>"title", "description"=>"The title of the gallery"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Galleries", "Create"]}}, "/rest/?method=flickr.galleries.editMeta"=>{"post"=>{"summary"=>"Galleries Edit Meta", "description"=>"Modify the metadata for a gallery.", "operationId"=>"postRestMethodFlickr.galleries.editmeta", "x-api-path-slug"=>"restmethodflickr-galleries-editmeta-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"description", "description"=>"The new description for the gallery"}, {"in"=>"query", "name"=>"gallery_id", "description"=>"The gallery ID to update"}, {"in"=>"query", "name"=>"title", "description"=>"The new title for the gallery"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Galleries", "EditMeta"]}}, "/rest/?method=flickr.galleries.editPhoto"=>{"post"=>{"summary"=>"Galleries Edit Photo", "description"=>"Edit the comment for a gallery photo.", "operationId"=>"postRestMethodFlickr.galleries.editphoto", "x-api-path-slug"=>"restmethodflickr-galleries-editphoto-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"comment", "description"=>"The updated comment the photo"}, {"in"=>"query", "name"=>"gallery_id", "description"=>"The ID of the gallery to add a photo to"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The photo ID to add to the gallery"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Galleries", "EditPhoto"]}}, "/rest/?method=flickr.galleries.editPhotos"=>{"post"=>{"summary"=>"Galleries Edit Photos", "description"=>"Modify the photos in a gallery. Use this method to add, remove and re-order photos.", "operationId"=>"postRestMethodFlickr.galleries.editphotos", "x-api-path-slug"=>"restmethodflickr-galleries-editphotos-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"gallery_id", "description"=>"The id of the gallery to modify"}, {"in"=>"query", "name"=>"photo_ids", "description"=>"A comma-delimited list of photo ids to include in the gallery"}, {"in"=>"query", "name"=>"primary_photo_id", "description"=>"The id of the photo to use as the primary photo for the gallery"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Galleries", "EditPhotos"]}}, "/rest/?method=flickr.galleries.getInfo"=>{"get"=>{"summary"=>"Galleries Get Info", "description"=>"Returns information about a gallery.", "operationId"=>"getRestMethodFlickr.galleries.getinfo", "x-api-path-slug"=>"restmethodflickr-galleries-getinfo-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"gallery_id", "description"=>"The gallery ID you are requesting information for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Galleries", "GetInfo"]}}, "/rest/?method=flickr.galleries.getList"=>{"get"=>{"summary"=>"Galleries Get List", "description"=>"Return the list of galleries created by a user. Sorted from newest to oldest.", "operationId"=>"getRestMethodFlickr.galleries.getlist", "x-api-path-slug"=>"restmethodflickr-galleries-getlist-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of galleries to return per page"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user to get a galleries list for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Galleries", "GetList"]}}, "/rest/?method=flickr.galleries.getListForPhoto"=>{"get"=>{"summary"=>"Galleries Get List For Photo", "description"=>"Return the list of galleries to which a photo has been added. Galleries are returned sorted by date which the photo was added to the gallery.", "operationId"=>"getRestMethodFlickr.galleries.getlistforphoto", "x-api-path-slug"=>"restmethodflickr-galleries-getlistforphoto-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of galleries to return per page"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The ID of the photo to fetch a list of galleries for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Galleries", "GetListForPhoto"]}}, "/rest/?method=flickr.galleries.getPhotos"=>{"get"=>{"summary"=>"Galleries Get Photos", "description"=>"Return the list of photos for a gallery.", "operationId"=>"getRestMethodFlickr.galleries.getphotos", "x-api-path-slug"=>"restmethodflickr-galleries-getphotos-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"gallery_id", "description"=>"The ID of the gallery of photos to return"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of galleries to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Galleries", "GetPhotos"]}}, "/rest/?method=flickr.groups.browse"=>{"get"=>{"summary"=>"Groups Browse", "description"=>"Browse the group category tree, finding groups and sub-categories.", "operationId"=>"getRestMethodFlickr.groups.browse", "x-api-path-slug"=>"restmethodflickr-groups-browse-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"cat_id", "description"=>"The category id to fetch a list of groups and sub-categories for"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Browse"]}}, "/rest/?method=flickr.groups.getInfo"=>{"get"=>{"summary"=>"Groups Get Info", "description"=>"Get information about a group.", "operationId"=>"getRestMethodFlickr.groups.getinfo", "x-api-path-slug"=>"restmethodflickr-groups-getinfo-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"group_id", "description"=>"The NSID of the group to fetch information for"}, {"in"=>"query", "name"=>"lang", "description"=>"The language of the group name and description to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "GetInfo"]}}, "/rest/?method=flickr.groups.search"=>{"get"=>{"summary"=>"Groups Search", "description"=>"Search for groups. 18+ groups will only be returned for authenticated calls where the authenticated user is over 18.", "operationId"=>"getRestMethodFlickr.groups.search", "x-api-path-slug"=>"restmethodflickr-groups-search-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of groups to return per page"}, {"in"=>"query", "name"=>"text", "description"=>"The text to search for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Search"]}}, "/rest/?method=flickr.groups.members.getList"=>{"get"=>{"summary"=>"Groups Members Get List", "description"=>"Get a list of the members of a group. The call must be signed on behalf of a Flickr member, and the ability to see the group membership will be determined by the Flickr member's group privileges.", "operationId"=>"getRestMethodFlickr.groups.members.getlist", "x-api-path-slug"=>"restmethodflickr-groups-members-getlist-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"group_id", "description"=>"Return a list of members for this group"}, {"in"=>"query", "name"=>"membertypes", "description"=>"Comma separated list of member types"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of groups to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Members", "GetList"]}}, "/rest/?method=flickr.groups.pools.add"=>{"post"=>{"summary"=>"Groups Pools Add", "description"=>"Add a photo to a group's pool.", "operationId"=>"postRestMethodFlickr.groups.pools.add", "x-api-path-slug"=>"restmethodflickr-groups-pools-add-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"group_id", "description"=>"The NSID of the group whose pool the photo is to be added to"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to add to the group pool"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Pools", "Add"]}}, "/rest/?method=flickr.groups.pools.getContext"=>{"get"=>{"summary"=>"Groups Pools Get Context", "description"=>"Returns next and previous photos for a photo in a group pool.", "operationId"=>"getRestMethodFlickr.groups.pools.getcontext", "x-api-path-slug"=>"restmethodflickr-groups-pools-getcontext-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"group_id", "description"=>"The NSID of the group whose pool to fetch the photos context for"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to fetch the context for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Pools", "GetContext"]}}, "/rest/?method=flickr.groups.pools.getGroups"=>{"get"=>{"summary"=>"Groups Pools Get Groups", "description"=>"Returns a list of groups to which you can add photos.", "operationId"=>"getRestMethodFlickr.groups.pools.getgroups", "x-api-path-slug"=>"restmethodflickr-groups-pools-getgroups-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of groups to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Pools", "GetGroups"]}}, "/rest/?method=flickr.groups.pools.getPhotos"=>{"get"=>{"summary"=>"Groups Pools Get Photos", "description"=>"Returns a list of pool photos for a given group, based on the permissions of the group and the user logged in (if any).", "operationId"=>"getRestMethodFlickr.groups.pools.getphotos", "x-api-path-slug"=>"restmethodflickr-groups-pools-getphotos-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}, {"in"=>"query", "name"=>"tags", "description"=>"A tag to filter the pool with"}, {"in"=>"query", "name"=>"user_id", "description"=>"The nsid of a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Pools", "GetPhotos"]}}, "/rest/?method=flickr.groups.pools.remove"=>{"post"=>{"summary"=>"Groups Pools Remove", "description"=>"Remove a photo from a group pool.", "operationId"=>"postRestMethodFlickr.groups.pools.remove", "x-api-path-slug"=>"restmethodflickr-groups-pools-remove-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"group_id", "description"=>"The NSID of the group whos pool the photo is to removed from"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to remove from the group pool"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Pools", "Remove"]}}, "/rest/?method=flickr.interestingness.getList"=>{"get"=>{"summary"=>"Interestingness Get List", "description"=>"Returns the list of interesting photos for the most recent day or a user-specified date.", "operationId"=>"getRestMethodFlickr.interestingness.getlist", "x-api-path-slug"=>"restmethodflickr-interestingness-getlist-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"date", "description"=>"A specific date, formatted as YYYY-MM-DD, to return interesting photos for"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Interestingness", "GetList"]}}, "/rest/?method=flickr.machinetags.getNamespaces"=>{"get"=>{"summary"=>"Machinetags Get Namespaces", "description"=>"Return a list of unique namespaces, optionally limited by a given predicate, in alphabetical order.", "operationId"=>"getRestMethodFlickr.machinetags.getnamespaces", "x-api-path-slug"=>"restmethodflickr-machinetags-getnamespaces-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}, {"in"=>"query", "name"=>"predicate", "description"=>"Limit the list of namespaces returned to those that have the following predicate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machinetags", "GetNamespaces"]}}, "/rest/?method=flickr.machinetags.getPairs"=>{"get"=>{"summary"=>"Machinetags Get Pairs", "description"=>"Return a list of unique namespace and predicate pairs, optionally limited by predicate or namespace, in alphabetical order.", "operationId"=>"getRestMethodFlickr.machinetags.getpairs", "x-api-path-slug"=>"restmethodflickr-machinetags-getpairs-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"namespace", "description"=>"Limit the list of pairs returned to those that have the following namespace"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}, {"in"=>"query", "name"=>"predicate", "description"=>"Limit the list of namespaces returned to those that have the following predicate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machinetags", "GetPairs"]}}, "/rest/?method=flickr.machinetags.getPredicates"=>{"get"=>{"summary"=>"Machinetags Get Predicates", "description"=>"Return a list of unique predicates, optionally limited by a given namespace.", "operationId"=>"getRestMethodFlickr.machinetags.getpredicates", "x-api-path-slug"=>"restmethodflickr-machinetags-getpredicates-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"namespace", "description"=>"Limit the list of predicates returned to those that have the following namespace"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of predicates to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machinetags", "GetPredicates"]}}, "/rest/?method=flickr.machinetags.getRecentValues"=>{"get"=>{"summary"=>"Machinetags Get Recent Values", "description"=>"Fetch recently used (or created) machine tags values.", "operationId"=>"getRestMethodFlickr.machinetags.getrecentvalues", "x-api-path-slug"=>"restmethodflickr-machinetags-getrecentvalues-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"namespace", "description"=>"A namespace that all values should be restricted to"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of values to return per page"}, {"in"=>"query", "name"=>"predicate", "description"=>"A predicate that all values should be restricted to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machinetags", "GetRecentValues"]}}, "/rest/?method=flickr.machinetags.getValues"=>{"get"=>{"summary"=>"Machinetags Get Values", "description"=>"Return a list of unique values for a namespace and predicate.", "operationId"=>"getRestMethodFlickr.machinetags.getvalues", "x-api-path-slug"=>"restmethodflickr-machinetags-getvalues-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"namespace", "description"=>"A namespace that all values should be restricted to"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of values to return per page"}, {"in"=>"query", "name"=>"predicate", "description"=>"A predicate that all values should be restricted to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machinetags", "GetValues"]}}, "/rest/?method=flickr.panda.getList"=>{"get"=>{"summary"=>"Panda Get List", "description"=>"Return a list of Flickr pandas, from whom you can request photos using the flickr.panda.getPhotos API method. More information about the pandas can be found on the dev blog.", "operationId"=>"getRestMethodFlickr.panda.getlist", "x-api-path-slug"=>"restmethodflickr-panda-getlist-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Panda", "GetList"]}}, "/rest/?method=flickr.panda.getPhotos"=>{"get"=>{"summary"=>"Panda Get Photos", "description"=>"Ask the Flickr Pandas for a list of recent public (and \"safe\") photos. More information about the pandas can be found on the dev blog.", "operationId"=>"getRestMethodFlickr.panda.getphotos", "x-api-path-slug"=>"restmethodflickr-panda-getphotos-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"panda_name", "description"=>"The name of the panda to ask for photos from"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Panda", "GetPhotos"]}}, "/rest/?method=flickr.people.findByEmail"=>{"get"=>{"summary"=>"People Find By Email", "description"=>"Return a user's NSID, given their email address", "operationId"=>"getRestMethodFlickr.people.findbyemail", "x-api-path-slug"=>"restmethodflickr-people-findbyemail-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"find_email", "description"=>"The email address of the user to find (may be primary or secondary)"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People", "FindByEmail"]}}, "/rest/?method=flickr.people.findByUsername"=>{"get"=>{"summary"=>"People Find By Username", "description"=>"Return a user's NSID, given their username.", "operationId"=>"getRestMethodFlickr.people.findbyusername", "x-api-path-slug"=>"restmethodflickr-people-findbyusername-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"username", "description"=>"The username of the user to lookup"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People", "FindByUsername"]}}, "/rest/?method=flickr.people.getInfo"=>{"get"=>{"summary"=>"People Get Info", "description"=>"Get information about a user.", "operationId"=>"getRestMethodFlickr.people.getinfo", "x-api-path-slug"=>"restmethodflickr-people-getinfo-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user to fetch information about"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People", "GetInfo"]}}, "/rest/?method=flickr.people.getPhotos"=>{"get"=>{"summary"=>"People Get Photos", "description"=>"Return photos from the given user's photostream. Only photos visible to the calling user will be returned. This method must be authenticated; to return public photos for a user, use flickr.people.getPublicPhotos.", "operationId"=>"getRestMethodFlickr.people.getphotos", "x-api-path-slug"=>"restmethodflickr-people-getphotos-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"content_type", "description"=>"Content type setting"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"max_taken_date", "description"=>"Maximum taken date"}, {"in"=>"query", "name"=>"max_upload_date", "description"=>"Maximum upload date"}, {"in"=>"query", "name"=>"min_taken_date", "description"=>"Minimum taken date"}, {"in"=>"query", "name"=>"min_upload_date", "description"=>"Minimum upload date"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}, {"in"=>"query", "name"=>"privacy_filter", "description"=>"Return photos only matching a certain privacy level"}, {"in"=>"query", "name"=>"safe_search", "description"=>"Safe search setting"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user whose photos to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People", "GetPhotos"]}}, "/rest/?method=flickr.people.getPhotosOf"=>{"get"=>{"summary"=>"People Get Photos Of", "description"=>"Returns a list of photos containing a particular Flickr member.", "operationId"=>"getRestMethodFlickr.people.getphotosof", "x-api-path-slug"=>"restmethodflickr-people-getphotosof-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"owner_id", "description"=>"An NSID of a Flickr member"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user you want to find photos of"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People", "GetPhotosOf"]}}, "/rest/?method=flickr.people.getPublicGroups"=>{"get"=>{"summary"=>"People Get Public Groups", "description"=>"Returns the list of public groups a user is a member of.", "operationId"=>"getRestMethodFlickr.people.getpublicgroups", "x-api-path-slug"=>"restmethodflickr-people-getpublicgroups-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user to fetch groups for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People", "GetPublicGroups"]}}, "/rest/?method=flickr.people.getPublicPhotos"=>{"get"=>{"summary"=>"People Get Public Photos", "description"=>"Get a list of public photos for the given user.", "operationId"=>"getRestMethodFlickr.people.getpublicphotos", "x-api-path-slug"=>"restmethodflickr-people-getpublicphotos-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}, {"in"=>"query", "name"=>"safe_search", "description"=>"Safe search setting"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user whose photos to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People", "GetPublicPhotos"]}}, "/rest/?method=flickr.people.getUploadStatus"=>{"get"=>{"summary"=>"People Get Upload Status", "description"=>"Returns information for the calling user related to photo uploads.", "operationId"=>"getRestMethodFlickr.people.getuploadstatus", "x-api-path-slug"=>"restmethodflickr-people-getuploadstatus-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People", "GetUploadStatus"]}}, "/rest/?method=flickr.photos.addTags"=>{"post"=>{"summary"=>"Photos Add Tags", "description"=>"Add tags to a photo.", "operationId"=>"postRestMethodFlickr.photos.addtags", "x-api-path-slug"=>"restmethodflickr-photos-addtags-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to add tags to"}, {"in"=>"query", "name"=>"tags", "description"=>"The tags to add to the photo"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "AddTags"]}}, "/rest/?method=flickr.photos.delete"=>{"post"=>{"summary"=>"Photos Delete", "description"=>"Delete a photo from Flickr.", "operationId"=>"postRestMethodFlickr.photos.delete", "x-api-path-slug"=>"restmethodflickr-photos-delete-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Delete"]}}, "/rest/?method=flickr.photos.getAllContexts"=>{"get"=>{"summary"=>"Photos Get All Contexts", "description"=>"Returns all visible sets and pools the photo belongs to.", "operationId"=>"getRestMethodFlickr.photos.getallcontexts", "x-api-path-slug"=>"restmethodflickr-photos-getallcontexts-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The photo to return information for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "GetAllContexts"]}}, "/rest/?method=flickr.photos.getContactsPhotos"=>{"get"=>{"summary"=>"Photos Get Contacts Photos", "description"=>"Fetch a list of recent photos from the calling users' contacts.", "operationId"=>"getRestMethodFlickr.photos.getcontactsphotos", "x-api-path-slug"=>"restmethodflickr-photos-getcontactsphotos-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"count", "description"=>"Number of photos to return"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"include_self", "description"=>"Set to 1 to include photos from the calling user"}, {"in"=>"query", "name"=>"just_friends", "description"=>"Set as 1 to only show photos from friends and family (excluding regular contacts)"}, {"in"=>"query", "name"=>"single_photo", "description"=>"Only fetch one photo (the latest) per contact, instead of all photos in chronological order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "GetContactsPhotos"]}}, "/rest/?method=flickr.photos.getContactsPublicPhotos"=>{"get"=>{"summary"=>"Photos Get Contacts Public Photos", "description"=>"Fetch a list of recent public photos from a users' contacts.", "operationId"=>"getRestMethodFlickr.photos.getcontactspublicphotos", "x-api-path-slug"=>"restmethodflickr-photos-getcontactspublicphotos-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"count", "description"=>"Number of photos to return"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"include_self", "description"=>"Set to 1 to include photos from the calling user"}, {"in"=>"query", "name"=>"just_friends", "description"=>"Set as 1 to only show photos from friends and family (excluding regular contacts)"}, {"in"=>"query", "name"=>"single_photo", "description"=>"Only fetch one photo (the latest) per contact, instead of all photos in chronological order"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user to fetch photos for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "GetContactsPublicPhotos"]}}, "/rest/?method=flickr.photos.getContext"=>{"get"=>{"summary"=>"Photos Get Context", "description"=>"Returns next and previous photos for a photo in a photostream.", "operationId"=>"getRestMethodFlickr.photos.getcontext", "x-api-path-slug"=>"restmethodflickr-photos-getcontext-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to fetch the context for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "GetContext"]}}, "/rest/?method=flickr.photos.getCounts"=>{"get"=>{"summary"=>"Photos Get Counts", "description"=>"Returns next and previous photos for a photo in a photostream.", "operationId"=>"getRestMethodFlickr.photos.getcounts", "x-api-path-slug"=>"restmethodflickr-photos-getcounts-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"dates", "description"=>"A comma delimited list of unix timestamps, denoting the periods to return counts for"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"taken_dates", "description"=>"A comma delimited list of mysql datetimes, denoting the periods to return counts for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "GetCounts"]}}, "/rest/?method=flickr.photos.getExif"=>{"get"=>{"summary"=>"Photos Get Exif", "description"=>"Retrieves a list of EXIF/TIFF/GPS tags for a given photo. The calling user must have permission to view the photo.", "operationId"=>"getRestMethodFlickr.photos.getexif", "x-api-path-slug"=>"restmethodflickr-photos-getexif-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to fetch information for"}, {"in"=>"query", "name"=>"secret", "description"=>"The secret for the photo"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "GetExif"]}}, "/rest/?method=flickr.photos.getFavorites"=>{"get"=>{"summary"=>"Photos Get Favorites", "description"=>"Returns the list of people who have favorited a given photo.", "operationId"=>"getRestMethodFlickr.photos.getfavorites", "x-api-path-slug"=>"restmethodflickr-photos-getfavorites-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of users to return per page"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to fetch the favoriters list for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "GetFavorites"]}}, "/rest/?method=flickr.photos.getInfo"=>{"get"=>{"summary"=>"Photos Get Info", "description"=>"Get information about a photo. The calling user must have permission to view the photo.", "operationId"=>"getRestMethodFlickr.photos.getinfo", "x-api-path-slug"=>"restmethodflickr-photos-getinfo-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to get information for"}, {"in"=>"query", "name"=>"secret", "description"=>"The secret for the photo"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "GetInfo"]}}, "/rest/?method=flickr.photos.getNotInSet"=>{"get"=>{"summary"=>"Photos Get Not In Set", "description"=>"Returns a list of your photos that are not part of any sets.", "operationId"=>"getRestMethodFlickr.photos.getnotinset", "x-api-path-slug"=>"restmethodflickr-photos-getnotinset-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"max_taken_date", "description"=>"Maximum taken date"}, {"in"=>"query", "name"=>"max_upload_date", "description"=>"Maximum upload date"}, {"in"=>"query", "name"=>"media", "description"=>"Filter results by media type"}, {"in"=>"query", "name"=>"min_taken_date", "description"=>"Minimum taken date"}, {"in"=>"query", "name"=>"min_upload_date", "description"=>"Minimum upload date"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}, {"in"=>"query", "name"=>"privacy_filter", "description"=>"Return photos only matching a certain privacy level"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "GetNotInSet"]}}, "/rest/?method=flickr.photos.getPerms"=>{"get"=>{"summary"=>"Photos Get Perms", "description"=>"Get permissions for a photo.", "operationId"=>"getRestMethodFlickr.photos.getperms", "x-api-path-slug"=>"restmethodflickr-photos-getperms-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to get permissions for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "GetPerms"]}}, "/rest/?method=flickr.photos.getRecent"=>{"get"=>{"summary"=>"Photos Get Recent", "description"=>"Returns the list of people who have favorited a given photo.", "operationId"=>"getRestMethodFlickr.photos.getrecent", "x-api-path-slug"=>"restmethodflickr-photos-getrecent-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "GetRecent"]}}, "/rest/?method=flickr.photos.getSizes"=>{"get"=>{"summary"=>"Photos Get Sizes", "description"=>"Returns the available sizes for a photo. The calling user must have permission to view the photo.", "operationId"=>"getRestMethodFlickr.photos.getsizes", "x-api-path-slug"=>"restmethodflickr-photos-getsizes-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to fetch size information for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "GetSizes"]}}, "/rest/?method=flickr.photos.getUntagged"=>{"get"=>{"summary"=>"Photos Get Untagged", "description"=>"Returns a list of your photos that are not tagged.", "operationId"=>"getRestMethodFlickr.photos.getuntagged", "x-api-path-slug"=>"restmethodflickr-photos-getuntagged-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"max_taken_date", "description"=>"Maximum taken date"}, {"in"=>"query", "name"=>"max_upload_date", "description"=>"Maximum upload date"}, {"in"=>"query", "name"=>"media", "description"=>"Filter results by media type"}, {"in"=>"query", "name"=>"min_taken_date", "description"=>"Minimum taken date"}, {"in"=>"query", "name"=>"min_upload_date", "description"=>"Minimum upload date"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}, {"in"=>"query", "name"=>"privacy_filter", "description"=>"Return photos only matching a certain privacy level"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "GetUntagged"]}}, "/rest/?method=flickr.photos.getWithGeoData"=>{"get"=>{"summary"=>"Photos Get With Geo Data", "description"=>"Returns a list of your geo-tagged photos.", "operationId"=>"getRestMethodFlickr.photos.getwithgeodata", "x-api-path-slug"=>"restmethodflickr-photos-getwithgeodata-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"max_taken_date", "description"=>"Maximum taken date"}, {"in"=>"query", "name"=>"max_upload_date", "description"=>"Maximum upload date"}, {"in"=>"query", "name"=>"media", "description"=>"Filter results by media type"}, {"in"=>"query", "name"=>"min_taken_date", "description"=>"Minimum taken date"}, {"in"=>"query", "name"=>"min_upload_date", "description"=>"Minimum upload date"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}, {"in"=>"query", "name"=>"privacy_filter", "description"=>"Return photos only matching a certain privacy level"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "GetWithGeoData"]}}, "/rest/?method=flickr.photos.getWithoutGeoData"=>{"get"=>{"summary"=>"Photos Get Without Geo Data", "description"=>"Returns a list of your photos which haven't been geo-tagged.", "operationId"=>"getRestMethodFlickr.photos.getwithoutgeodata", "x-api-path-slug"=>"restmethodflickr-photos-getwithoutgeodata-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"max_taken_date", "description"=>"Maximum taken date"}, {"in"=>"query", "name"=>"max_upload_date", "description"=>"Maximum upload date"}, {"in"=>"query", "name"=>"media", "description"=>"Filter results by media type"}, {"in"=>"query", "name"=>"min_taken_date", "description"=>"Minimum taken date"}, {"in"=>"query", "name"=>"min_upload_date", "description"=>"Minimum upload date"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}, {"in"=>"query", "name"=>"privacy_filter", "description"=>"Return photos only matching a certain privacy level"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "GetWithoutGeoData"]}}, "/rest/?method=flickr.photos.getRecentlyUpdated"=>{"get"=>{"summary"=>"Photos Get Recently Updated", "description"=>"Return a list of your photos that have been recently created or which have been recently modified. Recently modified may mean that the photo's metadata (title, description, tags) may have been changed or a comment has been added (or just modified somehow :-)", "operationId"=>"getRestMethodFlickr.photos.getrecentlyupdated", "x-api-path-slug"=>"restmethodflickr-photos-getrecentlyupdated-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"min_date", "description"=>"A Unix timestamp or any English textual datetime description indicating the date from which modifications should be compared"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "GetRecentlyd"]}}, "/rest/?method=flickr.photos.removeTag"=>{"post"=>{"summary"=>"Photos Remove Tag", "description"=>"Remove a tag from a photo.", "operationId"=>"postRestMethodFlickr.photos.removetag", "x-api-path-slug"=>"restmethodflickr-photos-removetag-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to add tags to"}, {"in"=>"query", "name"=>"tag_id", "description"=>"The tag to remove from the photo"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "RemoveTag"]}}, "/rest/?method=flickr.photos.search"=>{"get"=>{"summary"=>"Photos Search", "description"=>"Return a list of photos matching some criteria. Only photos visible to the calling user will be returned. To return private or semi-private photos, the caller must be authenticated with 'read' permissions, and have permission to view the photos. Unauthenticated calls will only return public photos.", "operationId"=>"getRestMethodFlickr.photos.search", "x-api-path-slug"=>"restmethodflickr-photos-search-get", "parameters"=>[{"in"=>"query", "name"=>"accuracy", "description"=>"Recorded accuracy level of the location information"}, {"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"contacts", "description"=>"Search your contacts"}, {"in"=>"query", "name"=>"content_type", "description"=>"Content type setting"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"geo_context", "description"=>"Geo context is a numeric value representing the photos geotagginess beyond latitude and longitude"}, {"in"=>"query", "name"=>"group_id", "description"=>"The id of a group whos pool to search"}, {"in"=>"query", "name"=>"has_geo", "description"=>"Any photo that has been geotagged, or if the value is 0 any photo that has not been geotagged"}, {"in"=>"query", "name"=>"hbox", "description"=>"A comma-delimited list of 4 values defining the Bounding Box of the area that will be searched"}, {"in"=>"query", "name"=>"is_commons", "description"=>"Limit the scope of the search to only photos that are part of the Flickr Commons project"}, {"in"=>"query", "name"=>"is_gallery", "description"=>"Limit the scope of the search to only photos that are in a gallery? Default is false, search all photos"}, {"in"=>"query", "name"=>"is_getty", "description"=>"Limit the scope of the search to only photos that are for sale on Getty"}, {"in"=>"query", "name"=>"lat", "description"=>"A valid latitude, in decimal format, for doing radial geo queries"}, {"in"=>"query", "name"=>"license", "description"=>"The license id for photos (for possible values see the flickr"}, {"in"=>"query", "name"=>"lon", "description"=>"A valid longitude, in decimal format, for doing radial geo queries"}, {"in"=>"query", "name"=>"machine_tags", "description"=>"Machine tag(s)"}, {"in"=>"query", "name"=>"machine_tag_mode", "description"=>"Either any for an OR combination of tags, or all for an AND combination"}, {"in"=>"query", "name"=>"max_taken_date", "description"=>"Maximum taken date"}, {"in"=>"query", "name"=>"max_upload_date", "description"=>"Maximum upload date"}, {"in"=>"query", "name"=>"media", "description"=>"Filter results by media type"}, {"in"=>"query", "name"=>"min_taken_date", "description"=>"Minimum taken date"}, {"in"=>"query", "name"=>"min_upload_date", "description"=>"Minimum upload date"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}, {"in"=>"query", "name"=>"place_id", "description"=>"A Flickr place id"}, {"in"=>"query", "name"=>"privacy_filter", "description"=>"Return photos only matching a certain privacy level"}, {"in"=>"query", "name"=>"radius", "description"=>"A valid radius used for geo queries, greater than zero and less than 20 miles (or 32 kilometers), for use with point-based geo queries"}, {"in"=>"query", "name"=>"radius_units", "description"=>"The unit of measure when doing radial geo queries"}, {"in"=>"query", "name"=>"safe_search", "description"=>"Safe search setting"}, {"in"=>"query", "name"=>"sort", "description"=>"The order in which to sort returned photos"}, {"in"=>"query", "name"=>"tags", "description"=>"A comma-delimited list of tags"}, {"in"=>"query", "name"=>"tag_mode", "description"=>"Either any for an OR combination of tags, or all for an AND combination"}, {"in"=>"query", "name"=>"text", "description"=>"A free text search"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user whos photo to search"}, {"in"=>"query", "name"=>"woe_id", "description"=>"A 32-bit identifier that uniquely represents spatial entities"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Search"]}}, "/rest/?method=flickr.photos.setContentType"=>{"post"=>{"summary"=>"Photos Set Content Type", "description"=>"Set the content type of a photo.", "operationId"=>"postRestMethodFlickr.photos.setcontenttype", "x-api-path-slug"=>"restmethodflickr-photos-setcontenttype-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"content_type", "description"=>"The content type of the photo"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to set the adultness of"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "SetContentType"]}}, "/rest/?method=flickr.photos.setDates"=>{"post"=>{"summary"=>"Photos Set Dates", "description"=>"Set one or both of the dates for a photo.", "operationId"=>"postRestMethodFlickr.photos.setdates", "x-api-path-slug"=>"restmethodflickr-photos-setdates-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"date_posted", "description"=>"The date the photo was uploaded to flickr (see the dates documentation)"}, {"in"=>"query", "name"=>"date_taken", "description"=>"The date the photo was taken (see the dates documentation)"}, {"in"=>"query", "name"=>"date_taken_granularity", "description"=>"The granularity of the date the photo was taken (see the dates documentation)"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to edit dates for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "SetDates"]}}, "/rest/?method=flickr.photos.setMeta"=>{"post"=>{"summary"=>"Photos Set Meta", "description"=>"Set the meta information for a photo.", "operationId"=>"postRestMethodFlickr.photos.setmeta", "x-api-path-slug"=>"restmethodflickr-photos-setmeta-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"description", "description"=>"The description for the photo"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to set information for"}, {"in"=>"query", "name"=>"title", "description"=>"The title for the photo"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "SetMeta"]}}, "/rest/?method=flickr.photos.setPerms"=>{"post"=>{"summary"=>"Photos Set Perms", "description"=>"Set permissions for a photo.", "operationId"=>"postRestMethodFlickr.photos.setperms", "x-api-path-slug"=>"restmethodflickr-photos-setperms-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"is_family", "description"=>"1 to make the photo visible to family when private, 0 to not"}, {"in"=>"query", "name"=>"is_friend", "description"=>"1 to make the photo visible to friends when private, 0 to not"}, {"in"=>"query", "name"=>"is_public", "description"=>"1 to set the photo to public, 0 to set it to private"}, {"in"=>"query", "name"=>"perm_addmeta", "description"=>"Who can add notes and tags to the photo"}, {"in"=>"query", "name"=>"perm_comment", "description"=>"Who can add comments to the photo and its notes"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to set permissions for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "SetPerms"]}}, "/rest/?method=flickr.photos.setSafetyLevel"=>{"post"=>{"summary"=>"Photos Set Safety Level", "description"=>"Set the safety level of a photo.", "operationId"=>"postRestMethodFlickr.photos.setsafetylevel", "x-api-path-slug"=>"restmethodflickr-photos-setsafetylevel-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"hidden", "description"=>"Whether or not to additionally hide the photo from public searches"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to set the adultness of"}, {"in"=>"query", "name"=>"safety_level", "description"=>"The safety level of the photo"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "SetSafetyLevel"]}}, "/rest/?method=flickr.photos.setTags"=>{"post"=>{"summary"=>"Photos Set Tags", "description"=>"Set the tags for a photo.", "operationId"=>"postRestMethodFlickr.photos.settags", "x-api-path-slug"=>"restmethodflickr-photos-settags-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to set the tags for"}, {"in"=>"query", "name"=>"tags", "description"=>"All tags for the photo (as a single space-delimited string)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "SetTags"]}}, "/rest/?method=flickr.photos.comments.addComment"=>{"post"=>{"summary"=>"Photos Comments Add Comment", "description"=>"Add comment to a photo as the currently authenticated user.", "operationId"=>"postRestMethodFlickr.photos.comments.addcomment", "x-api-path-slug"=>"restmethodflickr-photos-comments-addcomment-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"comment_text", "description"=>"Text of the comment"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to add a comment to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Comments", "AddComment"]}}, "/rest/?method=flickr.photos.comments.deleteComment"=>{"post"=>{"summary"=>"Photos Comments Delete Comment", "description"=>"Delete comment as the currently authenticated user.", "operationId"=>"postRestMethodFlickr.photos.comments.deletecomment", "x-api-path-slug"=>"restmethodflickr-photos-comments-deletecomment-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to delete a comment from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Comments", "DeleteComment"]}}, "/rest/?method=flickr.photos.comments.editComment"=>{"post"=>{"summary"=>"Photos Comments Edit Comment", "description"=>"Edit the text of a comment as the currently authenticated user.", "operationId"=>"postRestMethodFlickr.photos.comments.editcomment", "x-api-path-slug"=>"restmethodflickr-photos-comments-editcomment-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"comment_id", "description"=>"The id of the comment to edit"}, {"in"=>"query", "name"=>"comment_text", "description"=>"Update the comment to this text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Comments", "EditComment"]}}, "/rest/?method=flickr.photos.comments.getList"=>{"get"=>{"summary"=>"Photos Comments Get List", "description"=>"Returns the comments for a photo.", "operationId"=>"getRestMethodFlickr.photos.comments.getlist", "x-api-path-slug"=>"restmethodflickr-photos-comments-getlist-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"max_comment_date", "description"=>"Maximum date that a comment was added"}, {"in"=>"query", "name"=>"min_comment_date", "description"=>"Minimum date that a comment was added"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to fetch comments for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Comments", "GetList"]}}, "/rest/?method=flickr.photos.comments.getRecentForContacts"=>{"get"=>{"summary"=>"Photos Comments Get Recent For Contacts", "description"=>"Return the list of photos belonging to your contacts that have been commented on recently.", "operationId"=>"getRestMethodFlickr.photos.comments.getrecentforcontacts", "x-api-path-slug"=>"restmethodflickr-photos-comments-getrecentforcontacts-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"contacts_filter", "description"=>"A comma-separated list of contact NSIDs to limit the scope of the query to"}, {"in"=>"query", "name"=>"date_lastcomment", "description"=>"Limits the resultset to photos that have been commented on since this date"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Comments", "GetRecentForContacts"]}}, "/rest/?method=flickr.photos.geo.batchCorrectLocation"=>{"post"=>{"summary"=>"Photos Geo Batch Correct Location", "description"=>"Correct the places hierarchy for all the photos for a user at a given latitude, longitude and accuracy. Batch corrections are processed in a delayed queue so it may take a few minutes before the changes are reflected in a user's photos.", "operationId"=>"postRestMethodFlickr.photos.geo.batchcorrectlocation", "x-api-path-slug"=>"restmethodflickr-photos-geo-batchcorrectlocation-post", "parameters"=>[{"in"=>"query", "name"=>"accuracy", "description"=>"Recorded accuracy level of the photos to be updated"}, {"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"lat", "description"=>"The latitude of the photos to be updated whose valid range is -90 to 90"}, {"in"=>"query", "name"=>"lon", "description"=>"The longitude of the photos to be updated whose valid range is -180 to 180"}, {"in"=>"query", "name"=>"place_id", "description"=>"A Flickr Places ID"}, {"in"=>"query", "name"=>"woe_id", "description"=>"A Where on Earch (WOE) ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Geo", "BatchCorrectLocation"]}}, "/rest/?method=flickr.photos.geo.correctLocation"=>{"post"=>{"summary"=>"Photos Geo Correct Location", "description"=>"Corrects a photo's location.", "operationId"=>"postRestMethodFlickr.photos.geo.correctlocation", "x-api-path-slug"=>"restmethodflickr-photos-geo-correctlocation-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The ID of the photo whose WOE location is being corrected"}, {"in"=>"query", "name"=>"place_id", "description"=>"A Flickr Places ID"}, {"in"=>"query", "name"=>"woe_id", "description"=>"A Where on Earch (WOE) ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Geo", "CorrectLocation"]}}, "/rest/?method=flickr.photos.geo.getLocation"=>{"get"=>{"summary"=>"Photos Geo Get Location", "description"=>"Get the geo data (latitude and longitude and the accuracy level) for a photo.", "operationId"=>"getRestMethodFlickr.photos.geo.getlocation", "x-api-path-slug"=>"restmethodflickr-photos-geo-getlocation-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo you want to retrieve location data for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Geo", "GetLocation"]}}, "/rest/?method=flickr.photos.geo.getPerms"=>{"get"=>{"summary"=>"Photos Geo Get Perms", "description"=>"Get permissions for who may view geo data for a photo.", "operationId"=>"getRestMethodFlickr.photos.geo.getperms", "x-api-path-slug"=>"restmethodflickr-photos-geo-getperms-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo you want to get permissions for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Geo", "GetPerms"]}}, "/rest/?method=flickr.photos.geo.photosForLocation"=>{"get"=>{"summary"=>"Photos Geo Photos For Location", "description"=>"Return a list of photos for the calling user at a specific latitude, longitude and accuracy", "operationId"=>"getRestMethodFlickr.photos.geo.photosforlocation", "x-api-path-slug"=>"restmethodflickr-photos-geo-photosforlocation-get", "parameters"=>[{"in"=>"query", "name"=>"accuracy", "description"=>"Recorded accuracy level of the location information"}, {"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"lat", "description"=>"The latitude whose valid range is -90 to 90"}, {"in"=>"query", "name"=>"lon", "description"=>"The longitude whose valid range is -180 to 180"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Geo", "PhotosForLocation"]}}, "/rest/?method=flickr.photos.geo.removeLocation"=>{"post"=>{"summary"=>"Photos Geo Remove Location", "description"=>"Removes the geo data associated with a photo.", "operationId"=>"postRestMethodFlickr.photos.geo.removelocation", "x-api-path-slug"=>"restmethodflickr-photos-geo-removelocation-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The ID of the photo you want to remove location data from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Geo", "RemoveLocation"]}}, "/rest/?method=flickr.photos.geo.setContext"=>{"post"=>{"summary"=>"Photos Geo Set Context", "description"=>"Indicate the state of a photo's geotagginess beyond latitude and longitude. Note : photos passed to this method must already be geotagged (using the flickr.photos.geo.setLocation method).", "operationId"=>"postRestMethodFlickr.photos.geo.setcontext", "x-api-path-slug"=>"restmethodflickr-photos-geo-setcontext-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"context", "description"=>"Context is a numeric value representing the photos geotagginess beyond latitude and longitude"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The ID of the photo you want to set context data for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Geo", "SetContext"]}}, "/rest/?method=flickr.photos.geo.setLocation"=>{"post"=>{"summary"=>"Photos Geo Set Location", "description"=>"Sets the geo data (latitude and longitude and, optionally, the accuracy level) for a photo. Before users may assign location data to a photo they must define who, by default, may view that information. Users can edit this preference at http://www.flickr.com/account/geo/privacy/. If a user has not set this preference, the API method will return an error.", "operationId"=>"postRestMethodFlickr.photos.geo.setlocation", "x-api-path-slug"=>"restmethodflickr-photos-geo-setlocation-post", "parameters"=>[{"in"=>"query", "name"=>"accuracy", "description"=>"Recorded accuracy level of the location information"}, {"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"context", "description"=>"Context is a numeric value representing the photos geotagginess beyond latitude and longitude"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"lat", "description"=>"The latitude whose valid range is -90 to 90"}, {"in"=>"query", "name"=>"lon", "description"=>"The longitude whose valid range is -180 to 180"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo you want to retrieve location data for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Geo", "SetLocation"]}}, "/rest/?method=flickr.photos.geo.setPerms"=>{"get"=>{"summary"=>"Photos Geo Set Perms", "description"=>"Set the permission for who may view the geo data associated with a photo.", "operationId"=>"getRestMethodFlickr.photos.geo.setperms", "x-api-path-slug"=>"restmethodflickr-photos-geo-setperms-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"is_contact", "description"=>"1 to set viewing permissions for the photos location data to contacts, 0 to set it to private"}, {"in"=>"query", "name"=>"is_family", "description"=>"1 to set viewing permissions for the photos location data to family, 0 to set it to private"}, {"in"=>"query", "name"=>"is_friend", "description"=>"1 to set viewing permissions for the photos location data to friends, 0 to set it to private"}, {"in"=>"query", "name"=>"is_public", "description"=>"1 to set viewing permissions for the photos location data to public, 0 to set it to private"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to get permissions for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Geo", "SetPerms"]}}, "/rest/?method=flickr.photos.licenses.getInfo"=>{"get"=>{"summary"=>"Photos Licenses Get Info", "description"=>"Fetches a list of available photo licenses for Flickr.", "operationId"=>"getRestMethodFlickr.photos.licenses.getinfo", "x-api-path-slug"=>"restmethodflickr-photos-licenses-getinfo-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Licenses", "GetInfo"]}}, "/rest/?method=flickr.photos.licenses.setInfo"=>{"post"=>{"summary"=>"Photos Licenses Set Info", "description"=>"Sets the license for a photo.", "operationId"=>"postRestMethodFlickr.photos.licenses.setinfo", "x-api-path-slug"=>"restmethodflickr-photos-licenses-setinfo-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"license_id", "description"=>"The license to apply, or 0 (zero) to remove the current license"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo you want to update the license for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Licenses", "SetInfo"]}}, "/rest/?method=flickr.photos.notes.add"=>{"post"=>{"summary"=>"Photos Notes Add", "description"=>"Add a note to a photo. Coordinates and sizes are in pixels, based on the 500px image size shown on individual photo pages.", "operationId"=>"postRestMethodFlickr.photos.notes.add", "x-api-path-slug"=>"restmethodflickr-photos-notes-add-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"note_h", "description"=>"The height of the note"}, {"in"=>"query", "name"=>"note_text", "description"=>"The description of the note"}, {"in"=>"query", "name"=>"note_w", "description"=>"The width of the note"}, {"in"=>"query", "name"=>"note_x", "description"=>"The left coordinate of the note"}, {"in"=>"query", "name"=>"note_y", "description"=>"The top coordinate of the note"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to add a note to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Notes", "Add"]}}, "/rest/?method=flickr.photos.notes.delete"=>{"post"=>{"summary"=>"Photos Notes Delete", "description"=>"Delete a note from a photo.", "operationId"=>"postRestMethodFlickr.photos.notes.delete", "x-api-path-slug"=>"restmethodflickr-photos-notes-delete-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"note_id", "description"=>"The id of the note to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Notes", "Delete"]}}, "/rest/?method=flickr.photos.notes.edit"=>{"post"=>{"summary"=>"Photos Notes Edit", "description"=>"Edit a note on a photo. Coordinates and sizes are in pixels, based on the 500px image size shown on individual photo pages.", "operationId"=>"postRestMethodFlickr.photos.notes.edit", "x-api-path-slug"=>"restmethodflickr-photos-notes-edit-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"note_h", "description"=>"The height of the note"}, {"in"=>"query", "name"=>"note_id", "description"=>"The id of the note to edit"}, {"in"=>"query", "name"=>"note_text", "description"=>"The description of the note"}, {"in"=>"query", "name"=>"note_w", "description"=>"The width of the note"}, {"in"=>"query", "name"=>"note_x", "description"=>"The left coordinate of the note"}, {"in"=>"query", "name"=>"note_y", "description"=>"The top coordinate of the note"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Notes", "Edit"]}}, "/rest/?method=flickr.photos.people.add"=>{"post"=>{"summary"=>"Photos People Add", "description"=>"Add a person to a photo. Coordinates and sizes are in pixels, based on the 500px image size shown on individual photo pages.", "operationId"=>"postRestMethodFlickr.photos.people.add", "x-api-path-slug"=>"restmethodflickr-photos-people-add-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"person_h", "description"=>"The height (in pixels) of the box around the person"}, {"in"=>"query", "name"=>"person_w", "description"=>"The width (in pixels) of the box around the person"}, {"in"=>"query", "name"=>"person_x", "description"=>"The left-most pixel co-ordinate of the box around the person"}, {"in"=>"query", "name"=>"person_y", "description"=>"The top-most pixel co-ordinate of the box around the person"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to add a person to"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user to add to the photo"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "People", "Add"]}}, "/rest/?method=flickr.photos.people.delete"=>{"post"=>{"summary"=>"Photos People Delete", "description"=>"Remove a person from a photo.", "operationId"=>"postRestMethodFlickr.photos.people.delete", "x-api-path-slug"=>"restmethodflickr-photos-people-delete-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to remove a person from"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user to remove from the photo"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "People", "Delete"]}}, "/rest/?method=flickr.photos.people.deleteCoords"=>{"post"=>{"summary"=>"Photos People Delete Coords", "description"=>"Remove the bounding box from a person in a photo", "operationId"=>"postRestMethodFlickr.photos.people.deletecoords", "x-api-path-slug"=>"restmethodflickr-photos-people-deletecoords-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to edit a person in"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user whose bounding box you want to remove"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "People", "DeleteCoords"]}}, "/rest/?method=flickr.photos.people.editCoords"=>{"post"=>{"summary"=>"Photos People Edit Coords", "description"=>"Edit the bounding box of an existing person on a photo.", "operationId"=>"postRestMethodFlickr.photos.people.editcoords", "x-api-path-slug"=>"restmethodflickr-photos-people-editcoords-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"person_h", "description"=>"The height (in pixels) of the box around the person"}, {"in"=>"query", "name"=>"person_w", "description"=>"The width (in pixels) of the box around the person"}, {"in"=>"query", "name"=>"person_x", "description"=>"The left-most pixel co-ordinate of the box around the person"}, {"in"=>"query", "name"=>"person_y", "description"=>"The top-most pixel co-ordinate of the box around the person"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to edit a person in"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user to edit in the photo"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "People", "EditCoords"]}}, "/rest/?method=flickr.photos.people.getList"=>{"get"=>{"summary"=>"Photos People Get List", "description"=>"Get a list of people in a given photo.", "operationId"=>"getRestMethodFlickr.photos.people.getlist", "x-api-path-slug"=>"restmethodflickr-photos-people-getlist-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to get a list of people for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "People", "GetList"]}}, "/rest/?method=flickr.photos.transform.rotate"=>{"post"=>{"summary"=>"Photos Transform Rotate", "description"=>"Rotate a photo.", "operationId"=>"postRestMethodFlickr.photos.transform.rotate", "x-api-path-slug"=>"restmethodflickr-photos-transform-rotate-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"degrees", "description"=>"The amount of degrees by which to rotate the photo (clockwise) from its current orientation"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to rotate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Transform", "Rotate"]}}, "/rest/?method=flickr.photos.upload.checkTickets"=>{"get"=>{"summary"=>"Photos Upload Check Tickets", "description"=>"Checks the status of one or more asynchronous photo upload tickets.", "operationId"=>"getRestMethodFlickr.photos.upload.checktickets", "x-api-path-slug"=>"restmethodflickr-photos-upload-checktickets-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"tickets", "description"=>"A comma-delimited list of ticket ids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Upload", "CheckTickets"]}}, "/rest/?method=flickr.photosets.addPhoto"=>{"post"=>{"summary"=>"Photosets Add Photo", "description"=>"Add a photo to the end of an existing photoset.", "operationId"=>"postRestMethodFlickr.photosets.addphoto", "x-api-path-slug"=>"restmethodflickr-photosets-addphoto-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photoset_id", "description"=>"The id of the photoset to add a photo to"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to add to the set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "AddPhoto"]}}, "/rest/?method=flickr.photosets.create"=>{"post"=>{"summary"=>"Photosets Create", "description"=>"Create a new photoset for the calling user.", "operationId"=>"postRestMethodFlickr.photosets.create", "x-api-path-slug"=>"restmethodflickr-photosets-create-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"description", "description"=>"A description of the photoset"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"primary_photo_id", "description"=>"The id of the photo to represent this set"}, {"in"=>"query", "name"=>"title", "description"=>"A title for the photoset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "Create"]}}, "/rest/?method=flickr.photosets.delete"=>{"post"=>{"summary"=>"Photosets Delete", "description"=>"Delete a new photoset.", "operationId"=>"postRestMethodFlickr.photosets.delete", "x-api-path-slug"=>"restmethodflickr-photosets-delete-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photoset_id", "description"=>"The id of the photoset to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "Delete"]}}, "/rest/?method=flickr.photosets.editMeta"=>{"post"=>{"summary"=>"Photosets Edit Meta", "description"=>"Modify the meta-data for a photoset.", "operationId"=>"postRestMethodFlickr.photosets.editmeta", "x-api-path-slug"=>"restmethodflickr-photosets-editmeta-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"description", "description"=>"A description of the photoset"}, {"in"=>"query", "name"=>"photoset_id", "description"=>"The id of the photoset to modify"}, {"in"=>"query", "name"=>"title", "description"=>"The new title for the photoset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "EditMeta"]}}, "/rest/?method=flickr.photosets.editPhotos"=>{"post"=>{"summary"=>"Photosets Edit Photos", "description"=>"Modify the photos in a photoset. Use this method to add, remove and re-order photos.", "operationId"=>"postRestMethodFlickr.photosets.editphotos", "x-api-path-slug"=>"restmethodflickr-photosets-editphotos-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photoset_id", "description"=>"The id of the photoset to modify"}, {"in"=>"query", "name"=>"photo_ids", "description"=>"A comma-delimited list of photo ids to include in the set"}, {"in"=>"query", "name"=>"primary_photo_id", "description"=>"The id of the photo to use as the primary photo for the set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "EditPhotos"]}}, "/rest/?method=flickr.photosets.getContext"=>{"get"=>{"summary"=>"Photosets Get Context", "description"=>"Returns next and previous photos for a photo in a set.", "operationId"=>"getRestMethodFlickr.photosets.getcontext", "x-api-path-slug"=>"restmethodflickr-photosets-getcontext-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photoset_id", "description"=>"The id of the photoset for which to fetch the photos context"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to fetch the context for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "GetContext"]}}, "/rest/?method=flickr.photosets.getInfo"=>{"get"=>{"summary"=>"Photosets Get Info", "description"=>"Gets information about a photoset.", "operationId"=>"getRestMethodFlickr.photosets.getinfo", "x-api-path-slug"=>"restmethodflickr-photosets-getinfo-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photoset_id", "description"=>"The ID of the photoset to fetch information for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "GetInfo"]}}, "/rest/?method=flickr.photosets.getList"=>{"get"=>{"summary"=>"Photosets Get List", "description"=>"Returns the photosets belonging to the specified user.", "operationId"=>"getRestMethodFlickr.photosets.getlist", "x-api-path-slug"=>"restmethodflickr-photosets-getlist-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user to get a photoset list for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "GetList"]}}, "/rest/?method=flickr.photosets.getPhotos"=>{"get"=>{"summary"=>"Photosets Get Photos", "description"=>"Get the list of photos in a set.", "operationId"=>"getRestMethodFlickr.photosets.getphotos", "x-api-path-slug"=>"restmethodflickr-photosets-getphotos-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"extras", "description"=>"A comma-delimited list of extra information to fetch for each returned record"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"media", "description"=>"Filter results by media type"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of photos to return per page"}, {"in"=>"query", "name"=>"photoset_id", "description"=>"The id of the photoset to return the photos for"}, {"in"=>"query", "name"=>"privacy_filter", "description"=>"Return photos only matching a certain privacy level"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "GetPhotos"]}}, "/rest/?method=flickr.photosets.orderSets"=>{"post"=>{"summary"=>"Photosets Order Sets", "description"=>"Set the order of photosets for the calling user.", "operationId"=>"postRestMethodFlickr.photosets.ordersets", "x-api-path-slug"=>"restmethodflickr-photosets-ordersets-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photoset_ids", "description"=>"A comma delimited list of photoset IDs, ordered with the set to show first, first in the list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "OrderSets"]}}, "/rest/?method=flickr.photosets.removePhoto"=>{"post"=>{"summary"=>"Photosets Remove Photo", "description"=>"Remove a photo from a photoset.", "operationId"=>"postRestMethodFlickr.photosets.removephoto", "x-api-path-slug"=>"restmethodflickr-photosets-removephoto-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photoset_id", "description"=>"The id of the photoset to remove a photo from"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to remove to the set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "RemovePhoto"]}}, "/rest/?method=flickr.photosets.removePhotos"=>{"post"=>{"summary"=>"Photosets Remove Photos", "description"=>"Remove multiple photos from a photoset.", "operationId"=>"postRestMethodFlickr.photosets.removephotos", "x-api-path-slug"=>"restmethodflickr-photosets-removephotos-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photoset_id", "description"=>"The id of the photoset to remove photos from"}, {"in"=>"query", "name"=>"photo_ids", "description"=>"Comma-delimited list of photo ids to remove from the photoset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "RemovePhotos"]}}, "/rest/?method=flickr.photosets.reorderPhotos"=>{"post"=>{"summary"=>"Photosets Reorder Photos", "description"=>"Update the order of photos in a photoset.", "operationId"=>"postRestMethodFlickr.photosets.reorderphotos", "x-api-path-slug"=>"restmethodflickr-photosets-reorderphotos-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photoset_id", "description"=>"The id of the photoset to reorder"}, {"in"=>"query", "name"=>"photo_ids", "description"=>"Ordered, comma-delimited list of photo ids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "ReorderPhotos"]}}, "/rest/?method=flickr.photosets.setPrimaryPhoto"=>{"post"=>{"summary"=>"Photosets Set Primary Photo", "description"=>"Set photoset primary photo", "operationId"=>"postRestMethodFlickr.photosets.setprimaryphoto", "x-api-path-slug"=>"restmethodflickr-photosets-setprimaryphoto-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"photoset_id", "description"=>"The id of the photoset to set primary photo of"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to set as primary"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "SetPrimaryPhoto"]}}, "/rest/?method=flickr.photosets.comments.addComment"=>{"post"=>{"summary"=>"Photosets Comments Add Comment", "description"=>"Add a comment to a photoset.", "operationId"=>"postRestMethodFlickr.photosets.comments.addcomment", "x-api-path-slug"=>"restmethodflickr-photosets-comments-addcomment-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"comment_text", "description"=>"Text of the comment"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photoset_id", "description"=>"The id of the photoset to add a comment to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "Comments", "AddComment"]}}, "/rest/?method=flickr.photosets.comments.deleteComment"=>{"post"=>{"summary"=>"Photosets Comments Delete Comment", "description"=>"Delete a photoset comment as the currently authenticated user.", "operationId"=>"postRestMethodFlickr.photosets.comments.deletecomment", "x-api-path-slug"=>"restmethodflickr-photosets-comments-deletecomment-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"comment_id", "description"=>"The id of the comment to delete from a photoset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "Comments", "DeleteComment"]}}, "/rest/?method=flickr.photosets.comments.editComment"=>{"post"=>{"summary"=>"Photosets Comments Edit Comment", "description"=>"Edit the text of a comment as the currently authenticated user.", "operationId"=>"postRestMethodFlickr.photosets.comments.editcomment", "x-api-path-slug"=>"restmethodflickr-photosets-comments-editcomment-post", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"comment_id", "description"=>"The id of the comment to edit"}, {"in"=>"query", "name"=>"comment_text", "description"=>"Update the comment to this text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "Comments", "EditComment"]}}, "/rest/?method=flickr.photosets.comments.getList"=>{"get"=>{"summary"=>"Photosets Comments Get List", "description"=>"Returns the comments for a photoset.", "operationId"=>"getRestMethodFlickr.photosets.comments.getlist", "x-api-path-slug"=>"restmethodflickr-photosets-comments-getlist-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photoset_id", "description"=>"The id of the photoset to fetch comments for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photosets", "Comments", "GetList"]}}, "/rest/?method=flickr.places.find"=>{"get"=>{"summary"=>"Places Find", "description"=>"Return a list of place IDs for a query string.", "operationId"=>"getRestMethodFlickr.places.find", "x-api-path-slug"=>"restmethodflickr-places-find-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"query", "description"=>"The query string to use for place ID lookups"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "Find"]}}, "/rest/?method=flickr.places.findByLatLon"=>{"get"=>{"summary"=>"Places Find By Lat Lon", "description"=>"Return a place ID for a latitude, longitude and accuracy triple.", "operationId"=>"getRestMethodFlickr.places.findbylatlon", "x-api-path-slug"=>"restmethodflickr-places-findbylatlon-get", "parameters"=>[{"in"=>"query", "name"=>"accuracy", "description"=>"Recorded accuracy level of the location information"}, {"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"lat", "description"=>"The latitude whose valid range is -90 to 90"}, {"in"=>"query", "name"=>"lon", "description"=>"The longitude whose valid range is -180 to 180"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "FindByLatLon"]}}, "/rest/?method=flickr.places.getChildrenWithPhotosPublic"=>{"get"=>{"summary"=>"Places Get Children With Photos Public", "description"=>"Return a list of locations with public photos that are parented by a Where on Earth (WOE) or Places ID.", "operationId"=>"getRestMethodFlickr.places.getchildrenwithphotospublic", "x-api-path-slug"=>"restmethodflickr-places-getchildrenwithphotospublic-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"place_id", "description"=>"A Flickr Places ID"}, {"in"=>"query", "name"=>"woe_id", "description"=>"A Where On Earth (WOE) ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "GetChildrenWithPhotosPublic"]}}, "/rest/?method=flickr.places.getInfo"=>{"get"=>{"summary"=>"Places Get Info", "description"=>"Get information about a place.", "operationId"=>"getRestMethodFlickr.places.getinfo", "x-api-path-slug"=>"restmethodflickr-places-getinfo-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"place_id", "description"=>"A Flickr Places ID"}, {"in"=>"query", "name"=>"woe_id", "description"=>"A Where On Earth (WOE) ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "GetInfo"]}}, "/rest/?method=flickr.places.getInfoByUrl"=>{"get"=>{"summary"=>"Places Get Info By Url", "description"=>"Lookup information about a place, by its flickr.com/places URL.", "operationId"=>"getRestMethodFlickr.places.getinfobyurl", "x-api-path-slug"=>"restmethodflickr-places-getinfobyurl-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"url", "description"=>"A flickr"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "GetInfoByUrl"]}}, "/rest/?method=flickr.places.getPlaceTypes"=>{"get"=>{"summary"=>"Places Get Place Types", "description"=>"Fetches a list of available place types for Flickr.", "operationId"=>"getRestMethodFlickr.places.getplacetypes", "x-api-path-slug"=>"restmethodflickr-places-getplacetypes-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "GetPlaceTypes"]}}, "/rest/?method=flickr.places.getShapeHistory"=>{"get"=>{"summary"=>"Places Get Shape History", "description"=>"Return an historical list of all the shape data generated for a Places or Where on Earth (WOE) ID.", "operationId"=>"getRestMethodFlickr.places.getshapehistory", "x-api-path-slug"=>"restmethodflickr-places-getshapehistory-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"place_id", "description"=>"A Flickr Places ID"}, {"in"=>"query", "name"=>"woe_id", "description"=>"A Where On Earth (WOE) ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "GetShapeHistory"]}}, "/rest/?method=flickr.places.getTopPlacesList"=>{"get"=>{"summary"=>"Places Get Top Places List", "description"=>"Return the top 100 most geotagged places for a day.", "operationId"=>"getRestMethodFlickr.places.gettopplaceslist", "x-api-path-slug"=>"restmethodflickr-places-gettopplaceslist-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"date", "description"=>"A valid date in YYYY-MM-DD format"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"place_id", "description"=>"Limit your query to only those top places belonging to a specific Flickr Places identifier"}, {"in"=>"query", "name"=>"place_type_id", "description"=>"The numeric ID for a specific place type to cluster photos by"}, {"in"=>"query", "name"=>"woe_id", "description"=>"Limit your query to only those top places belonging to a specific Where on Earth (WOE) identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "GetTopPlacesList"]}}, "/rest/?method=flickr.places.placesForBoundingBox"=>{"get"=>{"summary"=>"Places Places For Bounding Box", "description"=>"Return all the locations of a matching place type for a bounding box.", "operationId"=>"getRestMethodFlickr.places.placesforboundingbox", "x-api-path-slug"=>"restmethodflickr-places-placesforboundingbox-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"bbox", "description"=>"A comma-delimited list of 4 values defining the Bounding Box of the area that will be searched"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"place_type", "description"=>"Deprecated in favor of place_type_id"}, {"in"=>"query", "name"=>"place_type_id", "description"=>"The numeric ID for a specific place type to cluster photos by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "PlacesForBoundingBox"]}}, "/rest/?method=flickr.places.placesForContacts"=>{"get"=>{"summary"=>"Places Places For Contacts", "description"=>"Return a list of the top 100 unique places clustered by a given placetype for a user's contacts.", "operationId"=>"getRestMethodFlickr.places.placesforcontacts", "x-api-path-slug"=>"restmethodflickr-places-placesforcontacts-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"contacts", "description"=>"Search your contacts"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"max_taken_date", "description"=>"Maximum taken date"}, {"in"=>"query", "name"=>"max_upload_date", "description"=>"Maximum upload date"}, {"in"=>"query", "name"=>"min_taken_date", "description"=>"Minimum taken date"}, {"in"=>"query", "name"=>"min_upload_date", "description"=>"Minimum upload date"}, {"in"=>"query", "name"=>"place_id", "description"=>"A Flickr Places identifier to use to filter photo clusters"}, {"in"=>"query", "name"=>"place_type", "description"=>"Deprecated in favor of place_type_id"}, {"in"=>"query", "name"=>"place_type_id", "description"=>"The numeric ID for a specific place type to cluster photos by"}, {"in"=>"query", "name"=>"threshold", "description"=>"The minimum number of photos that a place type must have to be included"}, {"in"=>"query", "name"=>"woe_id", "description"=>"A Where on Earth (WOE) identifier to use to filter photo clusters"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "PlacesForContacts"]}}, "/rest/?method=flickr.places.placesForTags"=>{"get"=>{"summary"=>"Places Places For Tags", "description"=>"Return a list of the top 100 unique places clustered by a given placetype for set of tags or machine tags.", "operationId"=>"getRestMethodFlickr.places.placesfortags", "x-api-path-slug"=>"restmethodflickr-places-placesfortags-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"machine_tags", "description"=>"Machine tags"}, {"in"=>"query", "name"=>"machine_tag_mode", "description"=>"Either any for an OR combination of tags, or all for an AND combination"}, {"in"=>"query", "name"=>"max_taken_date", "description"=>"Maximum taken date"}, {"in"=>"query", "name"=>"max_upload_date", "description"=>"Maximum upload date"}, {"in"=>"query", "name"=>"min_taken_date", "description"=>"Minimum taken date"}, {"in"=>"query", "name"=>"min_upload_date", "description"=>"Minimum upload date"}, {"in"=>"query", "name"=>"place_id", "description"=>"A Flickr Places identifier to use to filter photo clusters"}, {"in"=>"query", "name"=>"place_type_id", "description"=>"The numeric ID for a specific place type to cluster photos by"}, {"in"=>"query", "name"=>"tags", "description"=>"A comma-delimited list of tags"}, {"in"=>"query", "name"=>"tag_mode", "description"=>"Either any for an OR combination of tags, or all for an AND combination"}, {"in"=>"query", "name"=>"threshold", "description"=>"The minimum number of photos that a place type must have to be included"}, {"in"=>"query", "name"=>"woe_id", "description"=>"A Where on Earth (WOE) identifier to use to filter photo clusters"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "PlacesForTags"]}}, "/rest/?method=flickr.places.placesForUser"=>{"get"=>{"summary"=>"Places Places For User", "description"=>"Return a list of the top 100 unique places clustered by a given placetype for a user.", "operationId"=>"getRestMethodFlickr.places.placesforuser", "x-api-path-slug"=>"restmethodflickr-places-placesforuser-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"max_taken_date", "description"=>"Maximum taken date"}, {"in"=>"query", "name"=>"max_upload_date", "description"=>"Maximum upload date"}, {"in"=>"query", "name"=>"min_taken_date", "description"=>"Minimum taken date"}, {"in"=>"query", "name"=>"min_upload_date", "description"=>"Minimum upload date"}, {"in"=>"query", "name"=>"place_id", "description"=>"A Flickr Places identifier to use to filter photo clusters"}, {"in"=>"query", "name"=>"place_type", "description"=>"Deprecated in favor of place_type_id"}, {"in"=>"query", "name"=>"place_type_id", "description"=>"The numeric ID for a specific place type to cluster photos by"}, {"in"=>"query", "name"=>"threshold", "description"=>"The minimum number of photos that a place type must have to be included"}, {"in"=>"query", "name"=>"woe_id", "description"=>"A Where on Earth (WOE) identifier to use to filter photo clusters"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "PlacesForUser"]}}, "/rest/?method=flickr.places.resolvePlaceId"=>{"get"=>{"summary"=>"Places Resolve Place Id", "description"=>"Find Flickr Places information by Place ID. This method has been deprecated. It won't be removed but you should use flickr.places.getInfo instead.", "operationId"=>"getRestMethodFlickr.places.resolveplace", "x-api-path-slug"=>"restmethodflickr-places-resolveplaceid-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"place_id", "description"=>"A Flickr Places ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "ResolvePlaceId"]}}, "/rest/?method=flickr.places.resolvePlaceURL"=>{"get"=>{"summary"=>"Places Resolve Place U R L", "description"=>"Find Flickr Places information by Place URL. This method has been deprecated. It won't be removed but you should use flickr.places.getInfo instead.", "operationId"=>"getRestMethodFlickr.places.resolveplaceurl", "x-api-path-slug"=>"restmethodflickr-places-resolveplaceurl-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"url", "description"=>"A Flickr Places URL"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "ResolvePlaceURL"]}}, "/rest/?method=flickr.places.tagsForPlace"=>{"get"=>{"summary"=>"Places Tags For Place", "description"=>"Return a list of the top 100 unique tags for a Flickr Places or Where on Earth (WOE) ID.", "operationId"=>"getRestMethodFlickr.places.tagsforplace", "x-api-path-slug"=>"restmethodflickr-places-tagsforplace-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"max_taken_date", "description"=>"Maximum taken date"}, {"in"=>"query", "name"=>"max_upload_date", "description"=>"Maximum upload date"}, {"in"=>"query", "name"=>"min_taken_date", "description"=>"Minimum taken date"}, {"in"=>"query", "name"=>"min_upload_date", "description"=>"Minimum upload date"}, {"in"=>"query", "name"=>"place_id", "description"=>"A Flickr Places identifier to use to filter photo clusters"}, {"in"=>"query", "name"=>"woe_id", "description"=>"A Where on Earth (WOE) identifier to use to filter photo clusters"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "TagsForPlace"]}}, "/rest/?method=flickr.prefs.getContentType"=>{"get"=>{"summary"=>"Prefs Get Content Type", "description"=>"Returns the default content type preference for the user.", "operationId"=>"getRestMethodFlickr.prefs.getcontenttype", "x-api-path-slug"=>"restmethodflickr-prefs-getcontenttype-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Prefs", "GetContentType"]}}, "/rest/?method=flickr.prefs.getGeoPerms"=>{"get"=>{"summary"=>"Prefs Get Geo Perms", "description"=>"Returns the default privacy level for geographic information attached to the user's photos and whether or not the user has chosen to use geo-related EXIF information to automatically geotag their photos.", "operationId"=>"getRestMethodFlickr.prefs.getgeoperms", "x-api-path-slug"=>"restmethodflickr-prefs-getgeoperms-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Prefs", "GetGeoPerms"]}}, "/rest/?method=flickr.prefs.getHidden"=>{"get"=>{"summary"=>"Prefs Get Hden", "description"=>"Returns the default hidden preference for the user.", "operationId"=>"getRestMethodFlickr.prefs.gethden", "x-api-path-slug"=>"restmethodflickr-prefs-gethidden-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Prefs", "GetHidden"]}}, "/rest/?method=flickr.prefs.getPrivacy"=>{"get"=>{"summary"=>"Prefs Get Privacy", "description"=>"Returns the default privacy level preference for the user.", "operationId"=>"getRestMethodFlickr.prefs.getprivacy", "x-api-path-slug"=>"restmethodflickr-prefs-getprivacy-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Prefs", "GetPrivacy"]}}, "/rest/?method=flickr.prefs.getSafetyLevel"=>{"get"=>{"summary"=>"Prefs Get Safety Level", "description"=>"Returns the default safety level preference for the user.", "operationId"=>"getRestMethodFlickr.prefs.getsafetylevel", "x-api-path-slug"=>"restmethodflickr-prefs-getsafetylevel-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Prefs", "GetSafetyLevel"]}}, "/rest/?method=flickr.reflection.getMethodInfo"=>{"get"=>{"summary"=>"Reflection Get Method Info", "description"=>"Returns information for a given Flickr API method.", "operationId"=>"getRestMethodFlickr.reflection.getmethodinfo", "x-api-path-slug"=>"restmethodflickr-reflection-getmethodinfo-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"method_name", "description"=>"The name of the method to fetch information for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reflection", "GetMethodInfo"]}}, "/rest/?method=flickr.reflection.getMethods"=>{"get"=>{"summary"=>"Reflection Get Methods", "description"=>"Returns a list of available Flickr API methods.", "operationId"=>"getRestMethodFlickr.reflection.getmethods", "x-api-path-slug"=>"restmethodflickr-reflection-getmethods-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reflection", "GetMethods"]}}, "/rest/?method=flickr.stats.getCollectionDomains"=>{"get"=>{"summary"=>"Stats Get Collection Domains", "description"=>"Get a list of referring domains for a collection", "operationId"=>"getRestMethodFlickr.stats.getcollectiondomains", "x-api-path-slug"=>"restmethodflickr-stats-getcollectiondomains-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"collection_id", "description"=>"The id of the collection to get stats for"}, {"in"=>"query", "name"=>"date", "description"=>"Stats will be returned for this date"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of domains to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "GetCollectionDomains"]}}, "/rest/?method=flickr.stats.getCollectionReferrers"=>{"get"=>{"summary"=>"Stats Get Collection Referrers", "description"=>"Get a list of referrers from a given domain to a collection", "operationId"=>"getRestMethodFlickr.stats.getcollectionreferrers", "x-api-path-slug"=>"restmethodflickr-stats-getcollectionreferrers-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"collection_id", "description"=>"The id of the collection to get stats for"}, {"in"=>"query", "name"=>"date", "description"=>"Stats will be returned for this date"}, {"in"=>"query", "name"=>"domain", "description"=>"The domain to return referrers for"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of domains to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "GetCollectionReferrers"]}}, "/rest/?method=flickr.stats.getCollectionStats"=>{"get"=>{"summary"=>"Stats Get Collection Stats", "description"=>"Get the number of views on a collection for a given date.", "operationId"=>"getRestMethodFlickr.stats.getcollectionstats", "x-api-path-slug"=>"restmethodflickr-stats-getcollectionstats-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"collection_id", "description"=>"The id of the collection to get stats for"}, {"in"=>"query", "name"=>"date", "description"=>"Stats will be returned for this date"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "GetCollectionStats"]}}, "/rest/?method=flickr.stats.getPhotoDomains"=>{"get"=>{"summary"=>"Stats Get Photo Domains", "description"=>"Get a list of referring domains for a photo.", "operationId"=>"getRestMethodFlickr.stats.getphotodomains", "x-api-path-slug"=>"restmethodflickr-stats-getphotodomains-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"date", "description"=>"Stats will be returned for this date"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of domains to return per page"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to get stats for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "GetPhotoDomains"]}}, "/rest/?method=flickr.stats.getPhotoReferrers"=>{"get"=>{"summary"=>"Stats Get Photo Referrers", "description"=>"Get a list of referring domains for a photo.", "operationId"=>"getRestMethodFlickr.stats.getphotoreferrers", "x-api-path-slug"=>"restmethodflickr-stats-getphotoreferrers-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"domain", "description"=>"The domain to return referrers for"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of domains to return per page"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to get stats for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "GetPhotoReferrers"]}}, "/rest/?method=flickr.stats.getPhotoStats"=>{"get"=>{"summary"=>"Stats Get Photo Stats", "description"=>"Get the number of views, comments and favorites on a photo for a given date.", "operationId"=>"getRestMethodFlickr.stats.getphotostats", "x-api-path-slug"=>"restmethodflickr-stats-getphotostats-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"date", "description"=>"Stats will be returned for this date"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to get stats for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "GetPhotoStats"]}}, "/rest/?method=flickr.stats.getPhotosetDomains"=>{"get"=>{"summary"=>"Stats Get Photoset Domains", "description"=>"Get a list of referring domains for a photoset.", "operationId"=>"getRestMethodFlickr.stats.getphotosetdomains", "x-api-path-slug"=>"restmethodflickr-stats-getphotosetdomains-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"date", "description"=>"Stats will be returned for this date"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of domains to return per page"}, {"in"=>"query", "name"=>"photoset_id", "description"=>"The id of the photoset to get stats for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "GetPhotosetDomains"]}}, "/rest/?method=flickr.stats.getPhotosetReferrers"=>{"get"=>{"summary"=>"Stats Get Photoset Referrers", "description"=>"Get a list of referring domains for a photoset.", "operationId"=>"getRestMethodFlickr.stats.getphotosetreferrers", "x-api-path-slug"=>"restmethodflickr-stats-getphotosetreferrers-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"domain", "description"=>"The domain to return referrers for"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of domains to return per page"}, {"in"=>"query", "name"=>"photoset_id", "description"=>"The id of the photoset to get stats for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "GetPhotosetReferrers"]}}, "/rest/?method=flickr.stats.getPhotosetStats"=>{"get"=>{"summary"=>"Stats Get Photoset Stats", "description"=>"Get the number of views on a photoset for a given date.", "operationId"=>"getRestMethodFlickr.stats.getphotosetstats", "x-api-path-slug"=>"restmethodflickr-stats-getphotosetstats-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"date", "description"=>"Stats will be returned for this date"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photoset_id", "description"=>"The id of the photoset to get stats for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "GetPhotosetStats"]}}, "/rest/?method=flickr.stats.getPhotostreamDomains"=>{"get"=>{"summary"=>"Stats Get Photostream Domains", "description"=>"Get a list of referring domains for a photostream.", "operationId"=>"getRestMethodFlickr.stats.getphotostreamdomains", "x-api-path-slug"=>"restmethodflickr-stats-getphotostreamdomains-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"date", "description"=>"Stats will be returned for this date"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of domains to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "GetPhotostreamDomains"]}}, "/rest/?method=flickr.stats.getPhotostreamReferrers"=>{"get"=>{"summary"=>"Stats Get Photostream Referrers", "description"=>"Get a list of referrers from a given domain to a user's photostream", "operationId"=>"getRestMethodFlickr.stats.getphotostreamreferrers", "x-api-path-slug"=>"restmethodflickr-stats-getphotostreamreferrers-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"domain", "description"=>"The domain to return referrers for"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of domains to return per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "GetPhotostreamReferrers"]}}, "/rest/?method=flickr.stats.getPhotostreamStats"=>{"get"=>{"summary"=>"Stats Get Photostream Stats", "description"=>"Get the number of views on a user's photostream for a given date.", "operationId"=>"getRestMethodFlickr.stats.getphotostreamstats", "x-api-path-slug"=>"restmethodflickr-stats-getphotostreamstats-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"date", "description"=>"Stats will be returned for this date"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "GetPhotostreamStats"]}}, "/rest/?method=flickr.stats.getPopularPhotos"=>{"get"=>{"summary"=>"Stats Get Popular Photos", "description"=>"List the photos with the most views, comments or favorites.", "operationId"=>"getRestMethodFlickr.stats.getpopularphotos", "x-api-path-slug"=>"restmethodflickr-stats-getpopularphotos-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"date", "description"=>"Stats will be returned for this date"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"page", "description"=>"The page of results to return"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of domains to return per page"}, {"in"=>"query", "name"=>"sort", "description"=>"The order in which to sort returned photos"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "GetPopularPhotos"]}}, "/rest/?method=flickr.stats.getTotalViews"=>{"get"=>{"summary"=>"Stats Get Total Views", "description"=>"Get the overall view counts for an account.", "operationId"=>"getRestMethodFlickr.stats.gettotalviews", "x-api-path-slug"=>"restmethodflickr-stats-gettotalviews-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"date", "description"=>"Stats will be returned for this date"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "GetTotalViews"]}}, "/rest/?method=flickr.tags.getClusterPhotos"=>{"get"=>{"summary"=>"Tags Get Cluster Photos", "description"=>"Returns the first 24 photos for a given tag cluster.", "operationId"=>"getRestMethodFlickr.tags.getclusterphotos", "x-api-path-slug"=>"restmethodflickr-tags-getclusterphotos-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"cluster_id", "description"=>"The top three tags for the cluster, separated by dashes (just like the url)"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"tag", "description"=>"The tag that this cluster belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "GetClusterPhotos"]}}, "/rest/?method=flickr.tags.getClusters"=>{"get"=>{"summary"=>"Tags Get Clusters", "description"=>"Returns a list of tag clusters for the given tag.", "operationId"=>"getRestMethodFlickr.tags.getclusters", "x-api-path-slug"=>"restmethodflickr-tags-getclusters-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"tag", "description"=>"The tag to fetch clusters for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "GetClusters"]}}, "/rest/?method=flickr.tags.getHotList"=>{"get"=>{"summary"=>"Tags Get Hot List", "description"=>"Returns a list of hot tags for the given period.", "operationId"=>"getRestMethodFlickr.tags.gethotlist", "x-api-path-slug"=>"restmethodflickr-tags-gethotlist-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"count", "description"=>"The number of tags to return"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"period", "description"=>"The period for which to fetch hot tags"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "GetHotList"]}}, "/rest/?method=flickr.tags.getListPhoto"=>{"get"=>{"summary"=>"Tags Get List Photo", "description"=>"Get the tag list for a given photo.", "operationId"=>"getRestMethodFlickr.tags.getlistphoto", "x-api-path-slug"=>"restmethodflickr-tags-getlistphoto-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The id of the photo to return tags for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "GetListPhoto"]}}, "/rest/?method=flickr.tags.getListUser"=>{"get"=>{"summary"=>"Tags Get List User", "description"=>"Get the tag list for a given user (or the currently logged in user).", "operationId"=>"getRestMethodFlickr.tags.getlistuser", "x-api-path-slug"=>"restmethodflickr-tags-getlistuser-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user to fetch the tag list for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "GetListUser"]}}, "/rest/?method=flickr.tags.getListUserPopular"=>{"get"=>{"summary"=>"Tags Get List User Popular", "description"=>"Get the popular tags for a given user (or the currently logged in user).", "operationId"=>"getRestMethodFlickr.tags.getlistuserpopular", "x-api-path-slug"=>"restmethodflickr-tags-getlistuserpopular-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"count", "description"=>"Number of popular tags to return"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user to fetch the tag list for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "GetListUserPopular"]}}, "/rest/?method=flickr.tags.getListUserRaw"=>{"get"=>{"summary"=>"Tags Get List User Raw", "description"=>"Get the raw versions of a given tag (or all tags) for the currently logged-in user.", "operationId"=>"getRestMethodFlickr.tags.getlistuserraw", "x-api-path-slug"=>"restmethodflickr-tags-getlistuserraw-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"tag", "description"=>"The tag you want to retrieve all raw versions for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "GetListUserRaw"]}}, "/rest/?method=flickr.tags.getRelated"=>{"get"=>{"summary"=>"Tags Get Related", "description"=>"Returns a list of tags 'related' to the given tag, based on clustered usage analysis.", "operationId"=>"getRestMethodFlickr.tags.getrelated", "x-api-path-slug"=>"restmethodflickr-tags-getrelated-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"tag", "description"=>"The tag to fetch related tags for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "GetRelated"]}}, "/rest/?method=flickr.test.echo"=>{"get"=>{"summary"=>"Test Echo", "description"=>"A testing method which echoes all parameters back in the response.", "operationId"=>"getRestMethodFlickr.test.echo", "x-api-path-slug"=>"restmethodflickr-test-echo-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "Echo"]}}, "/rest/?method=flickr.test.login"=>{"get"=>{"summary"=>"Test Login", "description"=>"A testing method which checks if the caller is logged in then returns their username.", "operationId"=>"getRestMethodFlickr.test.login", "x-api-path-slug"=>"restmethodflickr-test-login-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "Login"]}}, "/rest/?method=flickr.test.null"=>{"get"=>{"summary"=>"Test Null", "description"=>"This method doesn't do anything.", "operationId"=>"getRestMethodFlickr.test.null", "x-api-path-slug"=>"restmethodflickr-test-null-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "Null"]}}, "/rest/?method=flickr.urls.getGroup"=>{"get"=>{"summary"=>"Urls Get Group", "description"=>"Returns the url to a group's page.", "operationId"=>"getRestMethodFlickr.urls.getgroup", "x-api-path-slug"=>"restmethodflickr-urls-getgroup-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"group_id", "description"=>"The NSID of the group to fetch the url for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Urls", "GetGroup"]}}, "/rest/?method=flickr.urls.getUserPhotos"=>{"get"=>{"summary"=>"Urls Get User Photos", "description"=>"Returns the url to a user's photos.", "operationId"=>"getRestMethodFlickr.urls.getuserphotos", "x-api-path-slug"=>"restmethodflickr-urls-getuserphotos-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user to fetch the url for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Urls", "GetUserPhotos"]}}, "/rest/?method=flickr.urls.getUserProfile"=>{"get"=>{"summary"=>"Urls Get User Profile", "description"=>"Returns the url to a user's profile.", "operationId"=>"getRestMethodFlickr.urls.getuserprofile", "x-api-path-slug"=>"restmethodflickr-urls-getuserprofile-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"user_id", "description"=>"The NSID of the user to fetch the url for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Urls", "GetUserProfile"]}}, "/rest/?method=flickr.urls.lookupGallery"=>{"get"=>{"summary"=>"Urls Lookup Gallery", "description"=>"Returns gallery info, by url.", "operationId"=>"getRestMethodFlickr.urls.lookupgallery", "x-api-path-slug"=>"restmethodflickr-urls-lookupgallery-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"url", "description"=>"The gallerys URL"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Urls", "LookupGallery"]}}, "/rest/?method=flickr.urls.lookupGroup"=>{"get"=>{"summary"=>"Urls Lookup Group", "description"=>"Returns a group NSID, given the url to a group's page or photo pool.", "operationId"=>"getRestMethodFlickr.urls.lookupgroup", "x-api-path-slug"=>"restmethodflickr-urls-lookupgroup-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"url", "description"=>"The url to the groups page or photo pool"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Urls", "LookupGroup"]}}, "/rest/?method=flickr.urls.lookupUser"=>{"get"=>{"summary"=>"Urls Lookup User", "description"=>"Returns a user NSID, given the url to a user's photos or profile.", "operationId"=>"getRestMethodFlickr.urls.lookupuser", "x-api-path-slug"=>"restmethodflickr-urls-lookupuser-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API application key"}, {"in"=>"query", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"url", "description"=>"The url to the users profile or photos page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Urls", "LookupUser"]}}}}, "apis"=>{"name"=>"Flickr", "x-slug"=>"flickr", "description"=>"Flickr (pronounced flicker) is an image hosting and video hosting website, and web services suite that was created by Ludicorp in 2004 and acquired by Yahoo in 2005. In addition to being a popular website for users to share and embed personal photographs, and effectively an online community, the service is widely used by photo researchers and by bloggers to host images that they embed in blogs and social media.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/flickr-logo.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,General Data,Getting Started Example,Historical Data API,Images,Imports,Media,My API Stack,Pedestal,Photos,Photos,Photos,Profiles,Relative Data,Stack,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"flickr/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Flickr", "x-api-slug"=>"flickr", "description"=>"The Flickr API consists of a set of callable methods, and some API endpoints. To perform an action using the Flickr API, you need to select a calling convention, send a request to its endpoint specifying a method and some arguments, and will receive a formatted response.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/flickr-logo.jpg", "humanURL"=>"http://www.flickr.com/", "baseURL"=>"https://api.flickr.com//services/", "tags"=>"API Provider,General Data,Getting Started Example,Historical Data API,Images,Imports,Media,My API Stack,Pedestal,Photos,Photos,Photos,Profiles,Relative Data,Stack,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/flickr/restmethodflickr-urls-lookupuser-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/flickr/flickr-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://www.flickr.com/services/api/auth.oauth.html"}, {"type"=>"x-base", "url"=>"https://api.flickr.com/services/"}, {"type"=>"x-developer", "url"=>"https://www.flickr.com/services/api/"}, {"type"=>"x-getting-started", "url"=>"https://www.flickr.com/services/developer/"}, {"type"=>"x-privacy", "url"=>"https://info.yahoo.com/privacy/us/yahoo/flickr/details.html"}, {"type"=>"x-support", "url"=>"https://help.yahoo.com/kb/flickr-for-desktop"}, {"type"=>"x-terms-of-service", "url"=>"https://www.flickr.com/services/api/tos/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/flickr"}, {"type"=>"x-website", "url"=>"http://www.flickr.com/"}, {"type"=>"x-website", "url"=>"http://flickr.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-consumer-surveys{"google-surveys-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Consumer Surveys", "x-complete"=>1, "info"=>{"title"=>"Consumer Surveys", "description"=>"creates-and-conducts-surveys-lists-the-surveys-that-an-authenticated-user-owns-and-retrieves-survey-results-and-information-about-specified-surveys-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v2"}, "host"=>"www.googleapis.com", "basePath"=>"/consumersurveys/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/mobileAppPanels"=>{"get"=>{"summary"=>"Get Mobile App Panels", "description"=>"Lists the MobileAppPanels available to the authenticated user.", "operationId"=>"consumersurveys.mobileapppanels.list", "x-api-path-slug"=>"mobileapppanels-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults"}, {"in"=>"query", "name"=>"startIndex"}, {"in"=>"query", "name"=>"token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mobile Application"]}}, "/mobileAppPanels/{panelId}"=>{"get"=>{"summary"=>"Get Mobile App Panel", "description"=>"Retrieves a MobileAppPanel that is available to the authenticated user.", "operationId"=>"consumersurveys.mobileapppanels.get", "x-api-path-slug"=>"mobileapppanelspanelid-get", "parameters"=>[{"in"=>"path", "name"=>"panelId", "description"=>"External URL ID for the panel"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mobile Application"]}, "put"=>{"summary"=>"Update Mobile App Panel", "description"=>"Updates a MobileAppPanel. Currently the only property that can be updated is the owners property.", "operationId"=>"consumersurveys.mobileapppanels.update", "x-api-path-slug"=>"mobileapppanelspanelid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"panelId", "description"=>"External URL ID for the panel"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mobile Application"]}}, "/surveys"=>{"get"=>{"summary"=>"Get Surveys", "description"=>"Lists the surveys owned by the authenticated user.", "operationId"=>"consumersurveys.surveys.list", "x-api-path-slug"=>"surveys-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults"}, {"in"=>"query", "name"=>"startIndex"}, {"in"=>"query", "name"=>"token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Survey"]}, "post"=>{"summary"=>"Create Survey", "description"=>"Creates a survey.", "operationId"=>"consumersurveys.surveys.insert", "x-api-path-slug"=>"surveys-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Survey"]}}, "/surveys/{resourceId}/start"=>{"post"=>{"summary"=>"Begin Survey", "description"=>"Begins running a survey.", "operationId"=>"consumersurveys.surveys.start", "x-api-path-slug"=>"surveysresourceidstart-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Survey"]}}, "/surveys/{resourceId}/stop"=>{"post"=>{"summary"=>"Stop Survey", "description"=>"Stops a running survey.", "operationId"=>"consumersurveys.surveys.stop", "x-api-path-slug"=>"surveysresourceidstop-post", "parameters"=>[{"in"=>"path", "name"=>"resourceId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Survey"]}}, "/surveys/{surveyUrlId}"=>{"delete"=>{"summary"=>"Remove Survey", "description"=>"Removes a survey from view in all user GET requests.", "operationId"=>"consumersurveys.surveys.delete", "x-api-path-slug"=>"surveyssurveyurlid-delete", "parameters"=>[{"in"=>"path", "name"=>"surveyUrlId", "description"=>"External URL ID for the survey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Survey"]}, "get"=>{"summary"=>"Get Survey", "description"=>"Retrieves information about the specified survey.", "operationId"=>"consumersurveys.surveys.get", "x-api-path-slug"=>"surveyssurveyurlid-get", "parameters"=>[{"in"=>"path", "name"=>"surveyUrlId", "description"=>"External URL ID for the survey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Survey"]}, "put"=>{"summary"=>"Update Survey", "description"=>"Updates a survey. Currently the only property that can be updated is the owners property.", "operationId"=>"consumersurveys.surveys.update", "x-api-path-slug"=>"surveyssurveyurlid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"surveyUrlId", "description"=>"External URL ID for the survey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Survey"]}}, "/surveys/{surveyUrlId}/results"=>{"get"=>{"summary"=>"Get Survey Results", "description"=>"Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add \"?alt=media\" to the URL as an argument to get results.", "operationId"=>"consumersurveys.results.get", "x-api-path-slug"=>"surveyssurveyurlidresults-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"surveyUrlId", "description"=>"External URL ID for the survey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Survey"]}}}}, "apis"=>{"name"=>"Google Consumer Surveys", "x-slug"=>"google-consumer-surveys", "description"=>"Google Consumer Surveys brings journalists the latest data on elections and political opinions. Create your own surveys for custom insights specific to your audience for free. Faster and more accurate online polling. Imagine surveying public opinion with a tool so precise, it could predict the nation’s next president. That tool is Google Consumer Surveys.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Google-Consumer-Surveys-earn-money-payment.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Service API,Stack Network,Surveys", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-consumer-surveys/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Surveys API", "x-api-slug"=>"google-surveys-api", "description"=>"Google Consumer Surveys brings journalists the latest data on elections and political opinions. Create your own surveys for custom insights specific to your audience for free. Faster and more accurate online polling. Imagine surveying public opinion with a tool so precise, it could predict the nation’s next president. That tool is Google Consumer Surveys.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Google-Consumer-Surveys-earn-money-payment.jpg", "humanURL"=>"https://surveys.withgoogle.com/", "baseURL"=>"://www.googleapis.com//consumersurveys/v2", "tags"=>"API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Service API,Stack Network,Surveys", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-consumer-surveys/google-surveys-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"https://developers.google.com/surveys/"}, {"type"=>"x-getting-started", "url"=>"https://developers.google.com/surveys/v2/guides/getting-started-guide"}, {"type"=>"x-pricing", "url"=>"https://developers.google.com/surveys/v2/guides/incidence-pricing"}, {"type"=>"x-rate-limits", "url"=>"https://developers.google.com/surveys/v2/limits"}, {"type"=>"x-samples", "url"=>"https://github.com/google/surveys"}, {"type"=>"x-terms-of-service", "url"=>"https://developers.google.com/surveys/terms"}, {"type"=>"x-website", "url"=>"https://surveys.withgoogle.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
xero{"clarity-accounting-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xero", "x-complete"=>1, "info"=>{"title"=>"Accounting", "description"=>"-introductionthe-xero-accounting-api-is-a-restful-web-service-and-uses-the-oauth-v1-0a-protocol-to-authenticate-3rd-party-applications--the-accounting-api-exposes-accounting-and-related-functions-of-the-main-xero-application-and-can-be-used-for-a-variety-of-purposes-such-as-creating-transactions-like-invoices-and-credit-notes-right-through-to-extracting-accounting-data-via-our-reports-endpoint-", "contact"=>{"name"=>"Xero Developer Team", "url"=>"https://developer.xero.com"}, "version"=>"2.0"}, "host"=>"api.xero.com", "basePath"=>"/api.xro/2.0", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/Accounts"=>{"get"=>{"summary"=>"Get Accounts", "description"=>"Retrieve the chart of accounts", "operationId"=>"getAccounts", "x-api-path-slug"=>"accounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}, "post"=>{"summary"=>"Post Accounts", "description"=>"Post accounts.", "operationId"=>"postAccounts", "x-api-path-slug"=>"accounts-post", "parameters"=>[{"in"=>"body", "name"=>"Accounts", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}, "put"=>{"summary"=>"Put Accounts", "description"=>"Put accounts.", "operationId"=>"putAccounts", "x-api-path-slug"=>"accounts-put", "parameters"=>[{"in"=>"body", "name"=>"Accounts", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}, "x-related-model"=>{"summary"=>"X-related-model Accounts", "description"=>"X-related-model accounts.", "operationId"=>"x-related-modelAccounts", "x-api-path-slug"=>"accounts-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/Accounts/{AccountID}"=>{"delete"=>{"summary"=>"Delete Accounts", "description"=>"Delete accounts account.", "operationId"=>"deleteAccountsAccount", "x-api-path-slug"=>"accountsaccountid-delete", "parameters"=>[{"in"=>"path", "name"=>"AccountID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "AccountID"]}, "get"=>{"summary"=>"Get Accounts", "description"=>"Get accounts account.", "operationId"=>"getAccountsAccount", "x-api-path-slug"=>"accountsaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"AccountID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "AccountID"]}, "post"=>{"summary"=>"Post Accounts", "description"=>"Post accounts account.", "operationId"=>"postAccountsAccount", "x-api-path-slug"=>"accountsaccountid-post", "parameters"=>[{"in"=>"path", "name"=>"AccountID"}, {"in"=>"body", "name"=>"Accounts", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "AccountID"]}, "x-related-model"=>{"summary"=>"X-related-model Accounts", "description"=>"X-related-model accounts account.", "operationId"=>"x-related-modelAccountsAccount", "x-api-path-slug"=>"accountsaccountid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "AccountID"]}}, "/Accounts/{AccountID}/Attachments"=>{"get"=>{"summary"=>"Get Accounts Attachments", "description"=>"Get accounts account attachments.", "operationId"=>"getAccountsAccountAttachments", "x-api-path-slug"=>"accountsaccountidattachments-get", "parameters"=>[{"in"=>"path", "name"=>"AccountID", "description"=>"The Xero generated unique identifier for an account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "AccountID", "Attachments"]}}, "/Accounts/{AccountID}/Attachments/{FileName}"=>{"get"=>{"summary"=>"Get Accounts Attachments Filename", "description"=>"Get accounts account attachments filename.", "operationId"=>"getAccountsAccountAttachmentsFilename", "x-api-path-slug"=>"accountsaccountidattachmentsfilename-get", "parameters"=>[{"in"=>"path", "name"=>"AccountID", "description"=>"The Xero generated unique identifier for an account"}, {"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment to be downloaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "AccountID", "Attachments", "FileName"]}, "post"=>{"summary"=>"Post Accounts Attachments Filename", "description"=>"Post accounts account attachments filename.", "operationId"=>"postAccountsAccountAttachmentsFilename", "x-api-path-slug"=>"accountsaccountidattachmentsfilename-post", "parameters"=>[{"in"=>"path", "name"=>"AccountID", "description"=>"The Xero generated unique identifier for an account"}, {"in"=>"body", "name"=>"Content", "description"=>"The raw content of the file to be uploaded", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment being uploaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "AccountID", "Attachments", "FileName"]}}, "/BankTransactions"=>{"get"=>{"summary"=>"Get Bank Transactions", "description"=>"Get banktransactions.", "operationId"=>"getBanktransactions", "x-api-path-slug"=>"banktransactions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransactions"]}, "post"=>{"summary"=>"Post Bank Transactions", "description"=>"Post banktransactions.", "operationId"=>"postBanktransactions", "x-api-path-slug"=>"banktransactions-post", "parameters"=>[{"in"=>"body", "name"=>"BankTransactions", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransactions"]}, "put"=>{"summary"=>"Put Bank Transactions", "description"=>"Put banktransactions.", "operationId"=>"putBanktransactions", "x-api-path-slug"=>"banktransactions-put", "parameters"=>[{"in"=>"body", "name"=>"BankTransactions", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransactions"]}, "x-related-model"=>{"summary"=>"X-related-model Bank Transactions", "description"=>"X-related-model banktransactions.", "operationId"=>"x-related-modelBanktransactions", "x-api-path-slug"=>"banktransactions-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransactions"]}}, "/BankTransactions/{BankTransactionID}"=>{"get"=>{"summary"=>"Get Bank Transactions Banktransaction", "description"=>"Get banktransactions banktransaction.", "operationId"=>"getBanktransactionsBanktransaction", "x-api-path-slug"=>"banktransactionsbanktransactionid-get", "parameters"=>[{"in"=>"path", "name"=>"BankTransactionID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransactions", "BankTransactionID"]}, "post"=>{"summary"=>"Post Bank Transactions Banktransaction", "description"=>"Post banktransactions banktransaction.", "operationId"=>"postBanktransactionsBanktransaction", "x-api-path-slug"=>"banktransactionsbanktransactionid-post", "parameters"=>[{"in"=>"path", "name"=>"BankTransactionID"}, {"in"=>"body", "name"=>"BankTransactions", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransactions", "BankTransactionID"]}, "x-related-model"=>{"summary"=>"X-related-model Bank Transactions Banktransaction", "description"=>"X-related-model banktransactions banktransaction.", "operationId"=>"x-related-modelBanktransactionsBanktransaction", "x-api-path-slug"=>"banktransactionsbanktransactionid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransactions", "BankTransactionID"]}}, "/BankTransactions/{BankTransactionID}/Attachments"=>{"get"=>{"summary"=>"Get Bank Transactions Banktransaction Attachments", "description"=>"Get banktransactions banktransaction attachments.", "operationId"=>"getBanktransactionsBanktransactionAttachments", "x-api-path-slug"=>"banktransactionsbanktransactionidattachments-get", "parameters"=>[{"in"=>"path", "name"=>"BankTransactionID", "description"=>"The Xero generated unique identifier for an bank transaction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransactions", "BankTransactionID", "Attachments"]}}, "/BankTransactions/{BankTransactionID}/Attachments/{FileName}"=>{"get"=>{"summary"=>"Get Bank Transactions Banktransaction Attachments Filename", "description"=>"Get banktransactions banktransaction attachments filename.", "operationId"=>"getBanktransactionsBanktransactionAttachmentsFilename", "x-api-path-slug"=>"banktransactionsbanktransactionidattachmentsfilename-get", "parameters"=>[{"in"=>"path", "name"=>"BankTransactionID", "description"=>"The Xero generated unique identifier for an bank transaction"}, {"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment to be downloaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransactions", "BankTransactionID", "Attachments", "FileName"]}, "post"=>{"summary"=>"Post Bank Transactions Banktransaction Attachments Filename", "description"=>"Post banktransactions banktransaction attachments filename.", "operationId"=>"postBanktransactionsBanktransactionAttachmentsFilename", "x-api-path-slug"=>"banktransactionsbanktransactionidattachmentsfilename-post", "parameters"=>[{"in"=>"path", "name"=>"BankTransactionID", "description"=>"The Xero generated unique identifier for an bank transaction"}, {"in"=>"body", "name"=>"Content", "description"=>"The raw content of the file to be uploaded", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment being uploaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransactions", "BankTransactionID", "Attachments", "FileName"]}}, "/BankTransfers"=>{"get"=>{"summary"=>"Get Banks Transfers", "description"=>"Get banktransfers.", "operationId"=>"getBanktransfers", "x-api-path-slug"=>"banktransfers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransfers"]}, "put"=>{"summary"=>"Put Banks Transfers", "description"=>"Put banktransfers.", "operationId"=>"putBanktransfers", "x-api-path-slug"=>"banktransfers-put", "parameters"=>[{"in"=>"body", "name"=>"BankTransfers", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransfers"]}, "x-related-model"=>{"summary"=>"X-related-model Banks Transfers", "description"=>"X-related-model banktransfers.", "operationId"=>"x-related-modelBanktransfers", "x-api-path-slug"=>"banktransfers-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransfers"]}}, "/BankTransfers/{BankTransferID}"=>{"get"=>{"summary"=>"Get Banks Transfers", "description"=>"Get banktransfers banktransfer.", "operationId"=>"getBanktransfersBanktransfer", "x-api-path-slug"=>"banktransfersbanktransferid-get", "parameters"=>[{"in"=>"path", "name"=>"BankTransferID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransfers", "BankTransferID"]}, "x-related-model"=>{"summary"=>"X-related-model Banks Transfers", "description"=>"X-related-model banktransfers banktransfer.", "operationId"=>"x-related-modelBanktransfersBanktransfer", "x-api-path-slug"=>"banktransfersbanktransferid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransfers", "BankTransferID"]}}, "/BankTransfers/{BankTransferID}/Attachments/{FileName}"=>{"get"=>{"summary"=>"Get Banks Transfers Attachments Filename", "description"=>"Get banktransfers banktransfer attachments filename.", "operationId"=>"getBanktransfersBanktransferAttachmentsFilename", "x-api-path-slug"=>"banktransfersbanktransferidattachmentsfilename-get", "parameters"=>[{"in"=>"path", "name"=>"BankTransferID", "description"=>"The Xero generated unique identifier for an BankTransfer"}, {"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment to be downloaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransfers", "BankTransferID", "Attachments", "FileName"]}, "post"=>{"summary"=>"Post Banks Transfers Attachments Filename", "description"=>"Post banktransfers banktransfer attachments filename.", "operationId"=>"postBanktransfersBanktransferAttachmentsFilename", "x-api-path-slug"=>"banktransfersbanktransferidattachmentsfilename-post", "parameters"=>[{"in"=>"path", "name"=>"BankTransferID", "description"=>"The Xero generated unique identifier for a BankTransfer"}, {"in"=>"body", "name"=>"Content", "description"=>"The raw content of the file to be uploaded", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment being uploaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BankTransfers", "BankTransferID", "Attachments", "FileName"]}}, "/BrandingThemes"=>{"get"=>{"summary"=>"Get Brandingthemes", "description"=>"Get brandingthemes.", "operationId"=>"getBrandingthemes", "x-api-path-slug"=>"brandingthemes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BrandingThemes"]}, "x-related-model"=>{"summary"=>"X-related-model Brandingthemes", "description"=>"X-related-model brandingthemes.", "operationId"=>"x-related-modelBrandingthemes", "x-api-path-slug"=>"brandingthemes-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BrandingThemes"]}}, "/BrandingThemes/{BrandingThemeID}"=>{"get"=>{"summary"=>"Get Brandingthemes Brandingtheme", "description"=>"Get brandingthemes brandingtheme.", "operationId"=>"getBrandingthemesBrandingtheme", "x-api-path-slug"=>"brandingthemesbrandingthemeid-get", "parameters"=>[{"in"=>"path", "name"=>"BrandingThemeID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BrandingThemes", "BrandingThemeID"]}, "x-related-model"=>{"summary"=>"X-related-model Brandingthemes Brandingtheme", "description"=>"X-related-model brandingthemes brandingtheme.", "operationId"=>"x-related-modelBrandingthemesBrandingtheme", "x-api-path-slug"=>"brandingthemesbrandingthemeid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BrandingThemes", "BrandingThemeID"]}}, "/ContactGroups"=>{"get"=>{"summary"=>"Get Contactgroups", "description"=>"Get contactgroups.", "operationId"=>"getContactgroups", "x-api-path-slug"=>"contactgroups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ContactGroups"]}, "post"=>{"summary"=>"Post Contactgroups", "description"=>"Post contactgroups.", "operationId"=>"postContactgroups", "x-api-path-slug"=>"contactgroups-post", "parameters"=>[{"in"=>"body", "name"=>"ContactGroups", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ContactGroups"]}, "put"=>{"summary"=>"Put Contactgroups", "description"=>"Put contactgroups.", "operationId"=>"putContactgroups", "x-api-path-slug"=>"contactgroups-put", "parameters"=>[{"in"=>"body", "name"=>"ContactGroups", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ContactGroups"]}, "x-related-model"=>{"summary"=>"X-related-model Contactgroups", "description"=>"X-related-model contactgroups.", "operationId"=>"x-related-modelContactgroups", "x-api-path-slug"=>"contactgroups-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ContactGroups"]}}, "/ContactGroups/{ContactGroupID}"=>{"delete"=>{"summary"=>"Delete Contact Groups", "description"=>"Delete contactgroups contactgroup.", "operationId"=>"deleteContactgroupsContactgroup", "x-api-path-slug"=>"contactgroupscontactgroupid-delete", "parameters"=>[{"in"=>"path", "name"=>"ContactGroupID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ContactGroups", "ContactGroupID"]}, "get"=>{"summary"=>"Get Contact Groups", "description"=>"Get contactgroups contactgroup.", "operationId"=>"getContactgroupsContactgroup", "x-api-path-slug"=>"contactgroupscontactgroupid-get", "parameters"=>[{"in"=>"path", "name"=>"ContactGroupID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ContactGroups", "ContactGroupID"]}, "post"=>{"summary"=>"Post Contact Groups", "description"=>"Post contactgroups contactgroup.", "operationId"=>"postContactgroupsContactgroup", "x-api-path-slug"=>"contactgroupscontactgroupid-post", "parameters"=>[{"in"=>"path", "name"=>"ContactGroupID"}, {"in"=>"body", "name"=>"ContactGroups", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ContactGroups", "ContactGroupID"]}, "x-related-model"=>{"summary"=>"X-related-model Contact Groups", "description"=>"X-related-model contactgroups contactgroup.", "operationId"=>"x-related-modelContactgroupsContactgroup", "x-api-path-slug"=>"contactgroupscontactgroupid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ContactGroups", "ContactGroupID"]}}, "/ContactGroups/{ContactGroupID}/Contacts"=>{"delete"=>{"summary"=>"Delete Contact Groups Contacts", "description"=>"Delete contactgroups contactgroup contacts.", "operationId"=>"deleteContactgroupsContactgroupContacts", "x-api-path-slug"=>"contactgroupscontactgroupidcontacts-delete", "parameters"=>[{"in"=>"path", "name"=>"ContactGroupID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ContactGroups", "ContactGroupID", "Contacts"]}, "put"=>{"summary"=>"Put Contact Groups Contacts", "description"=>"Put contactgroups contactgroup contacts.", "operationId"=>"putContactgroupsContactgroupContacts", "x-api-path-slug"=>"contactgroupscontactgroupidcontacts-put", "parameters"=>[{"in"=>"path", "name"=>"ContactGroupID"}, {"in"=>"body", "name"=>"Contacts", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ContactGroups", "ContactGroupID", "Contacts"]}, "x-related-model"=>{"summary"=>"X-related-model Contact Groups Contacts", "description"=>"X-related-model contactgroups contactgroup contacts.", "operationId"=>"x-related-modelContactgroupsContactgroupContacts", "x-api-path-slug"=>"contactgroupscontactgroupidcontacts-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ContactGroups", "ContactGroupID", "Contacts"]}}, "/ContactGroups/{ContactGroupID}/Contacts/{ContactID}"=>{"delete"=>{"summary"=>"Delete Contact Groups Contacts Contact", "description"=>"Delete contactgroups contactgroup contacts contact.", "operationId"=>"deleteContactgroupsContactgroupContactsContact", "x-api-path-slug"=>"contactgroupscontactgroupidcontactscontactid-delete", "parameters"=>[{"in"=>"path", "name"=>"ContactGroupID"}, {"in"=>"path", "name"=>"ContactID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ContactGroups", "ContactGroupID", "Contacts", "ContactID"]}, "x-related-model"=>{"summary"=>"X-related-model Contact Groups Contacts Contact", "description"=>"X-related-model contactgroups contactgroup contacts contact.", "operationId"=>"x-related-modelContactgroupsContactgroupContactsContact", "x-api-path-slug"=>"contactgroupscontactgroupidcontactscontactid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ContactGroups", "ContactGroupID", "Contacts", "ContactID"]}}, "/Contacts"=>{"get"=>{"summary"=>"Get Contacts", "description"=>"Get contacts.", "operationId"=>"getContacts", "x-api-path-slug"=>"contacts-get", "parameters"=>[{"in"=>"query", "name"=>"IDs", "description"=>"Filter by a comma-separated list of ContactIDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}, "post"=>{"summary"=>"Post Contacts", "description"=>"Post contacts.", "operationId"=>"postContacts", "x-api-path-slug"=>"contacts-post", "parameters"=>[{"in"=>"body", "name"=>"Contacts", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}, "put"=>{"summary"=>"Put Contacts", "description"=>"Put contacts.", "operationId"=>"putContacts", "x-api-path-slug"=>"contacts-put", "parameters"=>[{"in"=>"body", "name"=>"Contacts", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}, "x-related-model"=>{"summary"=>"X-related-model Contacts", "description"=>"X-related-model contacts.", "operationId"=>"x-related-modelContacts", "x-api-path-slug"=>"contacts-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}}, "/Contacts/{ContactID}"=>{"get"=>{"summary"=>"Get Contacts Contact", "description"=>"Get contacts contact.", "operationId"=>"getContactsContact", "x-api-path-slug"=>"contactscontactid-get", "parameters"=>[{"in"=>"path", "name"=>"ContactID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "ContactID"]}, "post"=>{"summary"=>"Post Contacts Contact", "description"=>"Post contacts contact.", "operationId"=>"postContactsContact", "x-api-path-slug"=>"contactscontactid-post", "parameters"=>[{"in"=>"path", "name"=>"ContactID"}, {"in"=>"body", "name"=>"Contacts", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "ContactID"]}, "x-related-model"=>{"summary"=>"X-related-model Contacts Contact", "description"=>"X-related-model contacts contact.", "operationId"=>"x-related-modelContactsContact", "x-api-path-slug"=>"contactscontactid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "ContactID"]}}, "/Contacts/{ContactID}/Attachments"=>{"get"=>{"summary"=>"Get Contacts Contact Attachments", "description"=>"Get contacts contact attachments.", "operationId"=>"getContactsContactAttachments", "x-api-path-slug"=>"contactscontactidattachments-get", "parameters"=>[{"in"=>"path", "name"=>"ContactID", "description"=>"The Xero generated unique identifier for a Contact"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "ContactID", "Attachments"]}}, "/Contacts/{ContactID}/Attachments/{FileName}"=>{"get"=>{"summary"=>"Get Contacts Contact Attachments Filename", "description"=>"Get contacts contact attachments filename.", "operationId"=>"getContactsContactAttachmentsFilename", "x-api-path-slug"=>"contactscontactidattachmentsfilename-get", "parameters"=>[{"in"=>"path", "name"=>"ContactID", "description"=>"The Xero generated unique identifier for a Contact"}, {"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment to be downloaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "ContactID", "Attachments", "FileName"]}, "post"=>{"summary"=>"Post Contacts Contact Attachments Filename", "description"=>"Post contacts contact attachments filename.", "operationId"=>"postContactsContactAttachmentsFilename", "x-api-path-slug"=>"contactscontactidattachmentsfilename-post", "parameters"=>[{"in"=>"path", "name"=>"ContactID", "description"=>"The Xero generated unique identifier for a Contact"}, {"in"=>"body", "name"=>"Content", "description"=>"The raw content of the file to be uploaded", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment being uploaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "ContactID", "Attachments", "FileName"]}}, "/CreditNotes"=>{"get"=>{"summary"=>"Get Creditnotes", "description"=>"Get creditnotes.", "operationId"=>"getCreditnotes", "x-api-path-slug"=>"creditnotes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreditNotes"]}, "post"=>{"summary"=>"Post Creditnotes", "description"=>"Post creditnotes.", "operationId"=>"postCreditnotes", "x-api-path-slug"=>"creditnotes-post", "parameters"=>[{"in"=>"body", "name"=>"CreditNotes", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreditNotes"]}, "put"=>{"summary"=>"Put Creditnotes", "description"=>"Put creditnotes.", "operationId"=>"putCreditnotes", "x-api-path-slug"=>"creditnotes-put", "parameters"=>[{"in"=>"body", "name"=>"CreditNotes", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreditNotes"]}, "x-related-model"=>{"summary"=>"X-related-model Creditnotes", "description"=>"X-related-model creditnotes.", "operationId"=>"x-related-modelCreditnotes", "x-api-path-slug"=>"creditnotes-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreditNotes"]}}, "/CreditNotes/{CreditNoteID}"=>{"get"=>{"summary"=>"Get Creditnotes Creditnote", "description"=>"Get creditnotes creditnote.", "operationId"=>"getCreditnotesCreditnote", "x-api-path-slug"=>"creditnotescreditnoteid-get", "parameters"=>[{"in"=>"path", "name"=>"CreditNoteID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreditNotes", "CreditNoteID"]}, "post"=>{"summary"=>"Post Creditnotes Creditnote", "description"=>"Post creditnotes creditnote.", "operationId"=>"postCreditnotesCreditnote", "x-api-path-slug"=>"creditnotescreditnoteid-post", "parameters"=>[{"in"=>"path", "name"=>"CreditNoteID"}, {"in"=>"body", "name"=>"CreditNotes", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreditNotes", "CreditNoteID"]}, "x-related-model"=>{"summary"=>"X-related-model Creditnotes Creditnote", "description"=>"X-related-model creditnotes creditnote.", "operationId"=>"x-related-modelCreditnotesCreditnote", "x-api-path-slug"=>"creditnotescreditnoteid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreditNotes", "CreditNoteID"]}}, "/CreditNotes/{CreditNoteID}/Allocations"=>{"put"=>{"summary"=>"Put Creditnotes Creditnote Allocations", "description"=>"Put creditnotes creditnote allocations.", "operationId"=>"putCreditnotesCreditnoteAllocations", "x-api-path-slug"=>"creditnotescreditnoteidallocations-put", "parameters"=>[{"in"=>"body", "name"=>"Allocations", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"CreditNoteID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreditNotes", "CreditNoteID", "Ocations"]}, "x-related-model"=>{"summary"=>"X-related-model Creditnotes Creditnote Allocations", "description"=>"X-related-model creditnotes creditnote allocations.", "operationId"=>"x-related-modelCreditnotesCreditnoteAllocations", "x-api-path-slug"=>"creditnotescreditnoteidallocations-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreditNotes", "CreditNoteID", "Ocations"]}}, "/CreditNotes/{CreditNoteID}/Attachments"=>{"get"=>{"summary"=>"Get Creditnotes Creditnote Attachments", "description"=>"Get creditnotes creditnote attachments.", "operationId"=>"getCreditnotesCreditnoteAttachments", "x-api-path-slug"=>"creditnotescreditnoteidattachments-get", "parameters"=>[{"in"=>"path", "name"=>"CreditNoteID", "description"=>"The Xero generated unique identifier for a CreditNote"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreditNotes", "CreditNoteID", "Attachments"]}}, "/CreditNotes/{CreditNoteID}/Attachments/{FileName}"=>{"get"=>{"summary"=>"Get Creditnotes Creditnote Attachments Filename", "description"=>"Get creditnotes creditnote attachments filename.", "operationId"=>"getCreditnotesCreditnoteAttachmentsFilename", "x-api-path-slug"=>"creditnotescreditnoteidattachmentsfilename-get", "parameters"=>[{"in"=>"path", "name"=>"CreditNoteID", "description"=>"The Xero generated unique identifier for a CreditNote"}, {"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment to be downloaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreditNotes", "CreditNoteID", "Attachments", "FileName"]}, "post"=>{"summary"=>"Post Creditnotes Creditnote Attachments Filename", "description"=>"Post creditnotes creditnote attachments filename.", "operationId"=>"postCreditnotesCreditnoteAttachmentsFilename", "x-api-path-slug"=>"creditnotescreditnoteidattachmentsfilename-post", "parameters"=>[{"in"=>"body", "name"=>"Content", "description"=>"The raw content of the file to be uploaded", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"CreditNoteID", "description"=>"The Xero generated unique identifier for a CreditNote"}, {"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment being uploaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreditNotes", "CreditNoteID", "Attachments", "FileName"]}}, "/Currencies"=>{"get"=>{"summary"=>"Get Currencies", "description"=>"Get currencies.", "operationId"=>"getCurrencies", "x-api-path-slug"=>"currencies-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Currencies"]}, "put"=>{"summary"=>"Put Currencies", "description"=>"Put currencies.", "operationId"=>"putCurrencies", "x-api-path-slug"=>"currencies-put", "parameters"=>[{"in"=>"body", "name"=>"Currencies", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Currencies"]}, "x-related-model"=>{"summary"=>"X-related-model Currencies", "description"=>"X-related-model currencies.", "operationId"=>"x-related-modelCurrencies", "x-api-path-slug"=>"currencies-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Currencies"]}}, "/Employees"=>{"get"=>{"summary"=>"Get Employees", "description"=>"Get employees.", "operationId"=>"getEmployees", "x-api-path-slug"=>"employees-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employees"]}, "post"=>{"summary"=>"Post Employees", "description"=>"Post employees.", "operationId"=>"postEmployees", "x-api-path-slug"=>"employees-post", "parameters"=>[{"in"=>"body", "name"=>"Employees", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employees"]}, "put"=>{"summary"=>"Put Employees", "description"=>"Put employees.", "operationId"=>"putEmployees", "x-api-path-slug"=>"employees-put", "parameters"=>[{"in"=>"body", "name"=>"Employees", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employees"]}, "x-related-model"=>{"summary"=>"X-related-model Employees", "description"=>"X-related-model employees.", "operationId"=>"x-related-modelEmployees", "x-api-path-slug"=>"employees-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employees"]}}, "/Employees/{EmployeeID}"=>{"get"=>{"summary"=>"Get Employees Employee", "description"=>"Get employees employee.", "operationId"=>"getEmployeesEmployee", "x-api-path-slug"=>"employeesemployeeid-get", "parameters"=>[{"in"=>"path", "name"=>"EmployeeID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employees", "EmployeeID"]}, "post"=>{"summary"=>"Post Employees Employee", "description"=>"Post employees employee.", "operationId"=>"postEmployeesEmployee", "x-api-path-slug"=>"employeesemployeeid-post", "parameters"=>[{"in"=>"path", "name"=>"EmployeeID"}, {"in"=>"body", "name"=>"Employees", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employees", "EmployeeID"]}, "x-related-model"=>{"summary"=>"X-related-model Employees Employee", "description"=>"X-related-model employees employee.", "operationId"=>"x-related-modelEmployeesEmployee", "x-api-path-slug"=>"employeesemployeeid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employees", "EmployeeID"]}}, "/ExpenseClaims"=>{"get"=>{"summary"=>"Get Expenseclaims", "description"=>"Get expenseclaims.", "operationId"=>"getExpenseclaims", "x-api-path-slug"=>"expenseclaims-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ExpenseClaims"]}, "post"=>{"summary"=>"Post Expenseclaims", "description"=>"Post expenseclaims.", "operationId"=>"postExpenseclaims", "x-api-path-slug"=>"expenseclaims-post", "parameters"=>[{"in"=>"body", "name"=>"ExpenseClaims", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ExpenseClaims"]}, "put"=>{"summary"=>"Put Expenseclaims", "description"=>"Put expenseclaims.", "operationId"=>"putExpenseclaims", "x-api-path-slug"=>"expenseclaims-put", "parameters"=>[{"in"=>"body", "name"=>"ExpenseClaims", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ExpenseClaims"]}, "x-related-model"=>{"summary"=>"X-related-model Expenseclaims", "description"=>"X-related-model expenseclaims.", "operationId"=>"x-related-modelExpenseclaims", "x-api-path-slug"=>"expenseclaims-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ExpenseClaims"]}}, "/ExpenseClaims/{ExpenseClaimID}"=>{"get"=>{"summary"=>"Get Expenseclaims Expenseclaim", "description"=>"Get expenseclaims expenseclaim.", "operationId"=>"getExpenseclaimsExpenseclaim", "x-api-path-slug"=>"expenseclaimsexpenseclaimid-get", "parameters"=>[{"in"=>"path", "name"=>"ExpenseClaimID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ExpenseClaims", "ExpenseClaimID"]}, "post"=>{"summary"=>"Post Expenseclaims Expenseclaim", "description"=>"Post expenseclaims expenseclaim.", "operationId"=>"postExpenseclaimsExpenseclaim", "x-api-path-slug"=>"expenseclaimsexpenseclaimid-post", "parameters"=>[{"in"=>"path", "name"=>"ExpenseClaimID"}, {"in"=>"body", "name"=>"ExpenseClaims", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ExpenseClaims", "ExpenseClaimID"]}, "x-related-model"=>{"summary"=>"X-related-model Expenseclaims Expenseclaim", "description"=>"X-related-model expenseclaims expenseclaim.", "operationId"=>"x-related-modelExpenseclaimsExpenseclaim", "x-api-path-slug"=>"expenseclaimsexpenseclaimid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ExpenseClaims", "ExpenseClaimID"]}}, "/Invoices"=>{"get"=>{"summary"=>"Get Invoices", "description"=>"Get invoices.", "operationId"=>"getInvoices", "x-api-path-slug"=>"invoices-get", "parameters"=>[{"in"=>"query", "name"=>"ContactIDs", "description"=>"Filter by a comma-separated list of ContactIDs"}, {"in"=>"query", "name"=>"IDs", "description"=>"Filter by a comma-separated list of InvoiceIDs"}, {"in"=>"query", "name"=>"InvoiceNumbers", "description"=>"Filter by a comma-separated list of InvoiceNumbers"}, {"in"=>"query", "name"=>"Statuses", "description"=>"Filter by a comma-separated list of Statuses"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoices"]}, "post"=>{"summary"=>"Post Invoices", "description"=>"Post invoices.", "operationId"=>"postInvoices", "x-api-path-slug"=>"invoices-post", "parameters"=>[{"in"=>"body", "name"=>"Invoices", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoices"]}, "put"=>{"summary"=>"Put Invoices", "description"=>"Put invoices.", "operationId"=>"putInvoices", "x-api-path-slug"=>"invoices-put", "parameters"=>[{"in"=>"body", "name"=>"Invoices", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoices"]}, "x-related-model"=>{"summary"=>"X-related-model Invoices", "description"=>"X-related-model invoices.", "operationId"=>"x-related-modelInvoices", "x-api-path-slug"=>"invoices-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoices"]}}, "/Invoices/{InvoiceID}"=>{"get"=>{"summary"=>"Get Invoices Invoice", "description"=>"Get invoices invoice.", "operationId"=>"getInvoicesInvoice", "x-api-path-slug"=>"invoicesinvoiceid-get", "parameters"=>[{"in"=>"path", "name"=>"InvoiceID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoices", "InvoiceID"]}, "post"=>{"summary"=>"Post Invoices Invoice", "description"=>"Post invoices invoice.", "operationId"=>"postInvoicesInvoice", "x-api-path-slug"=>"invoicesinvoiceid-post", "parameters"=>[{"in"=>"path", "name"=>"InvoiceID"}, {"in"=>"body", "name"=>"Invoices", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoices", "InvoiceID"]}, "x-related-model"=>{"summary"=>"X-related-model Invoices Invoice", "description"=>"X-related-model invoices invoice.", "operationId"=>"x-related-modelInvoicesInvoice", "x-api-path-slug"=>"invoicesinvoiceid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoices", "InvoiceID"]}}, "/Invoices/{InvoiceID}/Attachments"=>{"get"=>{"summary"=>"Get Invoices Invoice Attachments", "description"=>"Get invoices invoice attachments.", "operationId"=>"getInvoicesInvoiceAttachments", "x-api-path-slug"=>"invoicesinvoiceidattachments-get", "parameters"=>[{"in"=>"path", "name"=>"InvoiceID", "description"=>"The Xero generated unique identifier for an Invoice"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoices", "InvoiceID", "Attachments"]}}, "/Invoices/{InvoiceID}/Attachments/{FileName}"=>{"get"=>{"summary"=>"Get Invoices Invoice Attachments Filename", "description"=>"Get invoices invoice attachments filename.", "operationId"=>"getInvoicesInvoiceAttachmentsFilename", "x-api-path-slug"=>"invoicesinvoiceidattachmentsfilename-get", "parameters"=>[{"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment to be downloaded"}, {"in"=>"path", "name"=>"InvoiceID", "description"=>"The Xero generated unique identifier for an Invoice"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoices", "InvoiceID", "Attachments", "FileName"]}, "post"=>{"summary"=>"Post Invoices Invoice Attachments Filename", "description"=>"Post invoices invoice attachments filename.", "operationId"=>"postInvoicesInvoiceAttachmentsFilename", "x-api-path-slug"=>"invoicesinvoiceidattachmentsfilename-post", "parameters"=>[{"in"=>"body", "name"=>"Content", "description"=>"The raw content of the file to be uploaded", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment being uploaded"}, {"in"=>"path", "name"=>"InvoiceID", "description"=>"The Xero generated unique identifier for an Invoice"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoices", "InvoiceID", "Attachments", "FileName"]}}, "/Invoices/{InvoiceID}/OnlineInvoice"=>{"get"=>{"summary"=>"Get Invoices Invoice Onlineinvoice", "description"=>"Get invoices invoice onlineinvoice.", "operationId"=>"getInvoicesInvoiceOnlineinvoice", "x-api-path-slug"=>"invoicesinvoiceidonlineinvoice-get", "parameters"=>[{"in"=>"path", "name"=>"InvoiceID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoices", "InvoiceID", "OnlineInvoice"]}, "x-related-model"=>{"summary"=>"X-related-model Invoices Invoice Onlineinvoice", "description"=>"X-related-model invoices invoice onlineinvoice.", "operationId"=>"x-related-modelInvoicesInvoiceOnlineinvoice", "x-api-path-slug"=>"invoicesinvoiceidonlineinvoice-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoices", "InvoiceID", "OnlineInvoice"]}}, "/Items"=>{"get"=>{"summary"=>"Get Items", "description"=>"Get items.", "operationId"=>"getItems", "x-api-path-slug"=>"items-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Items"]}, "post"=>{"summary"=>"Post Items", "description"=>"Post items.", "operationId"=>"postItems", "x-api-path-slug"=>"items-post", "parameters"=>[{"in"=>"body", "name"=>"Items", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Items"]}, "put"=>{"summary"=>"Put Items", "description"=>"Put items.", "operationId"=>"putItems", "x-api-path-slug"=>"items-put", "parameters"=>[{"in"=>"body", "name"=>"Items", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Items"]}, "x-related-model"=>{"summary"=>"X-related-model Items", "description"=>"X-related-model items.", "operationId"=>"x-related-modelItems", "x-api-path-slug"=>"items-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Items"]}}, "/Items/{ItemID}"=>{"delete"=>{"summary"=>"Delete Items", "description"=>"Delete items item.", "operationId"=>"deleteItemsItem", "x-api-path-slug"=>"itemsitemid-delete", "parameters"=>[{"in"=>"path", "name"=>"ItemID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Items", "ItemID"]}, "get"=>{"summary"=>"Get Items", "description"=>"Get items item.", "operationId"=>"getItemsItem", "x-api-path-slug"=>"itemsitemid-get", "parameters"=>[{"in"=>"path", "name"=>"ItemID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Items", "ItemID"]}, "post"=>{"summary"=>"Post Items", "description"=>"Post items item.", "operationId"=>"postItemsItem", "x-api-path-slug"=>"itemsitemid-post", "parameters"=>[{"in"=>"path", "name"=>"ItemID"}, {"in"=>"body", "name"=>"Items", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Items", "ItemID"]}, "x-related-model"=>{"summary"=>"X-related-model Items", "description"=>"X-related-model items item.", "operationId"=>"x-related-modelItemsItem", "x-api-path-slug"=>"itemsitemid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Items", "ItemID"]}}, "/Journals"=>{"get"=>{"summary"=>"Get Journals", "description"=>"Get journals.", "operationId"=>"getJournals", "x-api-path-slug"=>"journals-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Journals"]}, "x-related-model"=>{"summary"=>"X-related-model Journals", "description"=>"X-related-model journals.", "operationId"=>"x-related-modelJournals", "x-api-path-slug"=>"journals-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Journals"]}}, "/Journals/{JournalID}"=>{"get"=>{"summary"=>"Get Journals Journal", "description"=>"Get journals journal.", "operationId"=>"getJournalsJournal", "x-api-path-slug"=>"journalsjournalid-get", "parameters"=>[{"in"=>"path", "name"=>"JournalID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Journals", "JournalID"]}, "x-related-model"=>{"summary"=>"X-related-model Journals Journal", "description"=>"X-related-model journals journal.", "operationId"=>"x-related-modelJournalsJournal", "x-api-path-slug"=>"journalsjournalid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Journals", "JournalID"]}}, "/LinkedTransactions"=>{"get"=>{"summary"=>"Get Linkedtransactions", "description"=>"Get linkedtransactions.", "operationId"=>"getLinkedtransactions", "x-api-path-slug"=>"linkedtransactions-get", "parameters"=>[{"in"=>"query", "name"=>"ContactID", "description"=>"Filter by the ContactID"}, {"in"=>"query", "name"=>"SourceTransactionID", "description"=>"Filter by the SourceTransactionID"}, {"in"=>"query", "name"=>"Status", "description"=>"Filter by the combination of ContactID and Status"}, {"in"=>"query", "name"=>"TargetTransactionID", "description"=>"Filter by the TargetTransactionID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["LinkedTransactions"]}, "post"=>{"summary"=>"Post Linkedtransactions", "description"=>"Post linkedtransactions.", "operationId"=>"postLinkedtransactions", "x-api-path-slug"=>"linkedtransactions-post", "parameters"=>[{"in"=>"body", "name"=>"LinkedTransactions", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["LinkedTransactions"]}, "put"=>{"summary"=>"Put Linkedtransactions", "description"=>"Put linkedtransactions.", "operationId"=>"putLinkedtransactions", "x-api-path-slug"=>"linkedtransactions-put", "parameters"=>[{"in"=>"body", "name"=>"LinkedTransactions", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["LinkedTransactions"]}, "x-related-model"=>{"summary"=>"X-related-model Linkedtransactions", "description"=>"X-related-model linkedtransactions.", "operationId"=>"x-related-modelLinkedtransactions", "x-api-path-slug"=>"linkedtransactions-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["LinkedTransactions"]}}, "/LinkedTransactions/{LinkedTransactionID}"=>{"delete"=>{"summary"=>"Delete Linkedtransactions Linkedtransaction", "description"=>"Delete linkedtransactions linkedtransaction.", "operationId"=>"deleteLinkedtransactionsLinkedtransaction", "x-api-path-slug"=>"linkedtransactionslinkedtransactionid-delete", "parameters"=>[{"in"=>"path", "name"=>"LinkedTransactionID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["LinkedTransactions", "LinkedTransactionID"]}, "get"=>{"summary"=>"Get Linkedtransactions Linkedtransaction", "description"=>"Get linkedtransactions linkedtransaction.", "operationId"=>"getLinkedtransactionsLinkedtransaction", "x-api-path-slug"=>"linkedtransactionslinkedtransactionid-get", "parameters"=>[{"in"=>"path", "name"=>"LinkedTransactionID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["LinkedTransactions", "LinkedTransactionID"]}, "post"=>{"summary"=>"Post Linkedtransactions Linkedtransaction", "description"=>"Post linkedtransactions linkedtransaction.", "operationId"=>"postLinkedtransactionsLinkedtransaction", "x-api-path-slug"=>"linkedtransactionslinkedtransactionid-post", "parameters"=>[{"in"=>"path", "name"=>"LinkedTransactionID"}, {"in"=>"body", "name"=>"LinkedTransactions", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["LinkedTransactions", "LinkedTransactionID"]}, "x-related-model"=>{"summary"=>"X-related-model Linkedtransactions Linkedtransaction", "description"=>"X-related-model linkedtransactions linkedtransaction.", "operationId"=>"x-related-modelLinkedtransactionsLinkedtransaction", "x-api-path-slug"=>"linkedtransactionslinkedtransactionid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["LinkedTransactions", "LinkedTransactionID"]}}, "/ManualJournals"=>{"get"=>{"summary"=>"Get Manualjournals", "description"=>"Get manualjournals.", "operationId"=>"getManualjournals", "x-api-path-slug"=>"manualjournals-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ManualJournals"]}, "post"=>{"summary"=>"Post Manualjournals", "description"=>"Post manualjournals.", "operationId"=>"postManualjournals", "x-api-path-slug"=>"manualjournals-post", "parameters"=>[{"in"=>"body", "name"=>"ManualJournals", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ManualJournals"]}, "put"=>{"summary"=>"Put Manualjournals", "description"=>"Put manualjournals.", "operationId"=>"putManualjournals", "x-api-path-slug"=>"manualjournals-put", "parameters"=>[{"in"=>"body", "name"=>"ManualJournals", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ManualJournals"]}, "x-related-model"=>{"summary"=>"X-related-model Manualjournals", "description"=>"X-related-model manualjournals.", "operationId"=>"x-related-modelManualjournals", "x-api-path-slug"=>"manualjournals-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ManualJournals"]}}, "/ManualJournals/{ManualJournalID}"=>{"get"=>{"summary"=>"Get Manualjournals Manualjournal", "description"=>"Get manualjournals manualjournal.", "operationId"=>"getManualjournalsManualjournal", "x-api-path-slug"=>"manualjournalsmanualjournalid-get", "parameters"=>[{"in"=>"path", "name"=>"ManualJournalID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ManualJournals", "ManualJournalID"]}, "post"=>{"summary"=>"Post Manualjournals Manualjournal", "description"=>"Post manualjournals manualjournal.", "operationId"=>"postManualjournalsManualjournal", "x-api-path-slug"=>"manualjournalsmanualjournalid-post", "parameters"=>[{"in"=>"path", "name"=>"ManualJournalID"}, {"in"=>"body", "name"=>"ManualJournals", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ManualJournals", "ManualJournalID"]}, "x-related-model"=>{"summary"=>"X-related-model Manualjournals Manualjournal", "description"=>"X-related-model manualjournals manualjournal.", "operationId"=>"x-related-modelManualjournalsManualjournal", "x-api-path-slug"=>"manualjournalsmanualjournalid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ManualJournals", "ManualJournalID"]}}, "/ManualJournals/{ManualJournalID}/Attachments"=>{"get"=>{"summary"=>"Get Manualjournals Manualjournal Attachments", "description"=>"Get manualjournals manualjournal attachments.", "operationId"=>"getManualjournalsManualjournalAttachments", "x-api-path-slug"=>"manualjournalsmanualjournalidattachments-get", "parameters"=>[{"in"=>"path", "name"=>"ManualJournalID", "description"=>"The Xero generated unique identifier for a Manual Journal"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ManualJournals", "ManualJournalID", "Attachments"]}}, "/ManualJournals/{ManualJournalID}/Attachments/{FileName}"=>{"get"=>{"summary"=>"Get Manualjournals Manualjournal Attachments Filename", "description"=>"Get manualjournals manualjournal attachments filename.", "operationId"=>"getManualjournalsManualjournalAttachmentsFilename", "x-api-path-slug"=>"manualjournalsmanualjournalidattachmentsfilename-get", "parameters"=>[{"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment to be downloaded"}, {"in"=>"path", "name"=>"ManualJournalID", "description"=>"The Xero generated unique identifier for a Manual Journal"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ManualJournals", "ManualJournalID", "Attachments", "FileName"]}, "post"=>{"summary"=>"Post Manualjournals Manualjournal Attachments Filename", "description"=>"Post manualjournals manualjournal attachments filename.", "operationId"=>"postManualjournalsManualjournalAttachmentsFilename", "x-api-path-slug"=>"manualjournalsmanualjournalidattachmentsfilename-post", "parameters"=>[{"in"=>"body", "name"=>"Content", "description"=>"The raw content of the file to be uploaded", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment being uploaded"}, {"in"=>"path", "name"=>"ManualJournalID", "description"=>"The Xero generated unique identifier for a Manual Journal"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ManualJournals", "ManualJournalID", "Attachments", "FileName"]}}, "/Organisation"=>{"get"=>{"summary"=>"Get Organisation", "description"=>"Get organisation.", "operationId"=>"getOrganisation", "x-api-path-slug"=>"organisation-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organisation"]}, "x-related-model"=>{"summary"=>"X-related-model Organisation", "description"=>"X-related-model organisation.", "operationId"=>"x-related-modelOrganisation", "x-api-path-slug"=>"organisation-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organisation"]}}, "/Organisation/{ShortCode}"=>{"get"=>{"summary"=>"Get Organisation Shortcode", "description"=>"Get organisation shortcode.", "operationId"=>"getOrganisationShortcode", "x-api-path-slug"=>"organisationshortcode-get", "parameters"=>[{"in"=>"path", "name"=>"ShortCode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organisation", "ShortCode"]}, "x-related-model"=>{"summary"=>"X-related-model Organisation Shortcode", "description"=>"X-related-model organisation shortcode.", "operationId"=>"x-related-modelOrganisationShortcode", "x-api-path-slug"=>"organisationshortcode-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organisation", "ShortCode"]}}, "/Overpayments"=>{"get"=>{"summary"=>"Get Overpayments", "description"=>"Get overpayments.", "operationId"=>"getOverpayments", "x-api-path-slug"=>"overpayments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Overpayments"]}, "x-related-model"=>{"summary"=>"X-related-model Overpayments", "description"=>"X-related-model overpayments.", "operationId"=>"x-related-modelOverpayments", "x-api-path-slug"=>"overpayments-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Overpayments"]}}, "/Overpayments/{OverpaymentID}"=>{"get"=>{"summary"=>"Get Overpayments Overpayment", "description"=>"Get overpayments overpayment.", "operationId"=>"getOverpaymentsOverpayment", "x-api-path-slug"=>"overpaymentsoverpaymentid-get", "parameters"=>[{"in"=>"path", "name"=>"OverpaymentID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Overpayments", "OverpaymentID"]}, "x-related-model"=>{"summary"=>"X-related-model Overpayments Overpayment", "description"=>"X-related-model overpayments overpayment.", "operationId"=>"x-related-modelOverpaymentsOverpayment", "x-api-path-slug"=>"overpaymentsoverpaymentid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Overpayments", "OverpaymentID"]}}, "/Overpayments/{OverpaymentID}/Allocations"=>{"put"=>{"summary"=>"Put Overpayments Overpayment Allocations", "description"=>"Put overpayments overpayment allocations.", "operationId"=>"putOverpaymentsOverpaymentAllocations", "x-api-path-slug"=>"overpaymentsoverpaymentidallocations-put", "parameters"=>[{"in"=>"body", "name"=>"Allocations", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"OverpaymentID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Overpayments", "OverpaymentID", "Ocations"]}, "x-related-model"=>{"summary"=>"X-related-model Overpayments Overpayment Allocations", "description"=>"X-related-model overpayments overpayment allocations.", "operationId"=>"x-related-modelOverpaymentsOverpaymentAllocations", "x-api-path-slug"=>"overpaymentsoverpaymentidallocations-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Overpayments", "OverpaymentID", "Ocations"]}}, "/Payments"=>{"get"=>{"summary"=>"Get Payments", "description"=>"Get payments.", "operationId"=>"getPayments", "x-api-path-slug"=>"payments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}, "post"=>{"summary"=>"Post Payments", "description"=>"Post payments.", "operationId"=>"postPayments", "x-api-path-slug"=>"payments-post", "parameters"=>[{"in"=>"body", "name"=>"Payments", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}, "put"=>{"summary"=>"Put Payments", "description"=>"Put payments.", "operationId"=>"putPayments", "x-api-path-slug"=>"payments-put", "parameters"=>[{"in"=>"body", "name"=>"Payments", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}, "x-related-model"=>{"summary"=>"X-related-model Payments", "description"=>"X-related-model payments.", "operationId"=>"x-related-modelPayments", "x-api-path-slug"=>"payments-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}}, "/Payments/{PaymentID}"=>{"get"=>{"summary"=>"Get Payments Payment", "description"=>"Get payments payment.", "operationId"=>"getPaymentsPayment", "x-api-path-slug"=>"paymentspaymentid-get", "parameters"=>[{"in"=>"path", "name"=>"PaymentID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "PaymentID"]}, "post"=>{"summary"=>"Post Payments Payment", "description"=>"Post payments payment.", "operationId"=>"postPaymentsPayment", "x-api-path-slug"=>"paymentspaymentid-post", "parameters"=>[{"in"=>"path", "name"=>"PaymentID"}, {"in"=>"body", "name"=>"Payments", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "PaymentID"]}, "x-related-model"=>{"summary"=>"X-related-model Payments Payment", "description"=>"X-related-model payments payment.", "operationId"=>"x-related-modelPaymentsPayment", "x-api-path-slug"=>"paymentspaymentid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "PaymentID"]}}, "/Prepayments"=>{"get"=>{"summary"=>"Get Prepayments", "description"=>"Get prepayments.", "operationId"=>"getPrepayments", "x-api-path-slug"=>"prepayments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Prepayments"]}, "x-related-model"=>{"summary"=>"X-related-model Prepayments", "description"=>"X-related-model prepayments.", "operationId"=>"x-related-modelPrepayments", "x-api-path-slug"=>"prepayments-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Prepayments"]}}, "/Prepayments/{PrepaymentID}"=>{"get"=>{"summary"=>"Get Prepayments Prepayment", "description"=>"Get prepayments prepayment.", "operationId"=>"getPrepaymentsPrepayment", "x-api-path-slug"=>"prepaymentsprepaymentid-get", "parameters"=>[{"in"=>"path", "name"=>"PrepaymentID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Prepayments", "PrepaymentID"]}, "x-related-model"=>{"summary"=>"X-related-model Prepayments Prepayment", "description"=>"X-related-model prepayments prepayment.", "operationId"=>"x-related-modelPrepaymentsPrepayment", "x-api-path-slug"=>"prepaymentsprepaymentid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Prepayments", "PrepaymentID"]}}, "/Prepayments/{PrepaymentID}/Allocations"=>{"put"=>{"summary"=>"Put Prepayments Prepayment Allocations", "description"=>"Put prepayments prepayment allocations.", "operationId"=>"putPrepaymentsPrepaymentAllocations", "x-api-path-slug"=>"prepaymentsprepaymentidallocations-put", "parameters"=>[{"in"=>"body", "name"=>"Allocations", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"PrepaymentID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Prepayments", "PrepaymentID", "Ocations"]}, "x-related-model"=>{"summary"=>"X-related-model Prepayments Prepayment Allocations", "description"=>"X-related-model prepayments prepayment allocations.", "operationId"=>"x-related-modelPrepaymentsPrepaymentAllocations", "x-api-path-slug"=>"prepaymentsprepaymentidallocations-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Prepayments", "PrepaymentID", "Ocations"]}}, "/PurchaseOrders"=>{"get"=>{"summary"=>"Get Purchaseorders", "description"=>"Get purchaseorders.", "operationId"=>"getPurchaseorders", "x-api-path-slug"=>"purchaseorders-get", "parameters"=>[{"in"=>"query", "name"=>"DateFrom"}, {"in"=>"query", "name"=>"DateTo"}, {"in"=>"query", "name"=>"Status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PurchaseOrders"]}, "post"=>{"summary"=>"Post Purchaseorders", "description"=>"Post purchaseorders.", "operationId"=>"postPurchaseorders", "x-api-path-slug"=>"purchaseorders-post", "parameters"=>[{"in"=>"body", "name"=>"PurchaseOrders", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PurchaseOrders"]}, "put"=>{"summary"=>"Put Purchaseorders", "description"=>"Put purchaseorders.", "operationId"=>"putPurchaseorders", "x-api-path-slug"=>"purchaseorders-put", "parameters"=>[{"in"=>"body", "name"=>"PurchaseOrders", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PurchaseOrders"]}, "x-related-model"=>{"summary"=>"X-related-model Purchaseorders", "description"=>"X-related-model purchaseorders.", "operationId"=>"x-related-modelPurchaseorders", "x-api-path-slug"=>"purchaseorders-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PurchaseOrders"]}}, "/PurchaseOrders/{PurchaseOrderID}"=>{"get"=>{"summary"=>"Get Purchaseorders Purchaseorder", "description"=>"Get purchaseorders purchaseorder.", "operationId"=>"getPurchaseordersPurchaseorder", "x-api-path-slug"=>"purchaseorderspurchaseorderid-get", "parameters"=>[{"in"=>"path", "name"=>"PurchaseOrderID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PurchaseOrders", "PurchaseOrderID"]}, "post"=>{"summary"=>"Post Purchaseorders Purchaseorder", "description"=>"Post purchaseorders purchaseorder.", "operationId"=>"postPurchaseordersPurchaseorder", "x-api-path-slug"=>"purchaseorderspurchaseorderid-post", "parameters"=>[{"in"=>"path", "name"=>"PurchaseOrderID"}, {"in"=>"body", "name"=>"PurchaseOrders", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PurchaseOrders", "PurchaseOrderID"]}, "x-related-model"=>{"summary"=>"X-related-model Purchaseorders Purchaseorder", "description"=>"X-related-model purchaseorders purchaseorder.", "operationId"=>"x-related-modelPurchaseordersPurchaseorder", "x-api-path-slug"=>"purchaseorderspurchaseorderid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PurchaseOrders", "PurchaseOrderID"]}}, "/PurchaseOrders/{PurchaseOrderID}/Attachments"=>{"get"=>{"summary"=>"Get Purchaseorders Purchaseorder Attachments", "description"=>"Get purchaseorders purchaseorder attachments.", "operationId"=>"getPurchaseordersPurchaseorderAttachments", "x-api-path-slug"=>"purchaseorderspurchaseorderidattachments-get", "parameters"=>[{"in"=>"path", "name"=>"PurchaseOrderID", "description"=>"The Xero generated unique identifier for a purchase order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PurchaseOrders", "PurchaseOrderID", "Attachments"]}}, "/PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}"=>{"get"=>{"summary"=>"Get Purchaseorders Purchaseorder Attachments Filename", "description"=>"Get purchaseorders purchaseorder attachments filename.", "operationId"=>"getPurchaseordersPurchaseorderAttachmentsFilename", "x-api-path-slug"=>"purchaseorderspurchaseorderidattachmentsfilename-get", "parameters"=>[{"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment to be downloaded"}, {"in"=>"path", "name"=>"PurchaseOrderID", "description"=>"The Xero generated unique identifier for a purchase order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PurchaseOrders", "PurchaseOrderID", "Attachments", "FileName"]}, "post"=>{"summary"=>"Post Purchaseorders Purchaseorder Attachments Filename", "description"=>"Post purchaseorders purchaseorder attachments filename.", "operationId"=>"postPurchaseordersPurchaseorderAttachmentsFilename", "x-api-path-slug"=>"purchaseorderspurchaseorderidattachmentsfilename-post", "parameters"=>[{"in"=>"body", "name"=>"Content", "description"=>"The raw content of the file to be uploaded", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment being uploaded"}, {"in"=>"path", "name"=>"PurchaseOrderID", "description"=>"The Xero generated unique identifier for a purchase order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PurchaseOrders", "PurchaseOrderID", "Attachments", "FileName"]}}, "/Receipts"=>{"get"=>{"summary"=>"Get Receipts", "description"=>"Get receipts.", "operationId"=>"getReceipts", "x-api-path-slug"=>"receipts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipts"]}, "post"=>{"summary"=>"Post Receipts", "description"=>"Post receipts.", "operationId"=>"postReceipts", "x-api-path-slug"=>"receipts-post", "parameters"=>[{"in"=>"body", "name"=>"Receipts", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipts"]}, "put"=>{"summary"=>"Put Receipts", "description"=>"Put receipts.", "operationId"=>"putReceipts", "x-api-path-slug"=>"receipts-put", "parameters"=>[{"in"=>"body", "name"=>"Receipts", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipts"]}, "x-related-model"=>{"summary"=>"X-related-model Receipts", "description"=>"X-related-model receipts.", "operationId"=>"x-related-modelReceipts", "x-api-path-slug"=>"receipts-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipts"]}}, "/Receipts/{ReceiptID}"=>{"get"=>{"summary"=>"Get Receipts Receipt", "description"=>"Get receipts receipt.", "operationId"=>"getReceiptsReceipt", "x-api-path-slug"=>"receiptsreceiptid-get", "parameters"=>[{"in"=>"path", "name"=>"ReceiptID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipts", "ReceiptID"]}, "post"=>{"summary"=>"Post Receipts Receipt", "description"=>"Post receipts receipt.", "operationId"=>"postReceiptsReceipt", "x-api-path-slug"=>"receiptsreceiptid-post", "parameters"=>[{"in"=>"path", "name"=>"ReceiptID"}, {"in"=>"body", "name"=>"Receipts", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipts", "ReceiptID"]}, "x-related-model"=>{"summary"=>"X-related-model Receipts Receipt", "description"=>"X-related-model receipts receipt.", "operationId"=>"x-related-modelReceiptsReceipt", "x-api-path-slug"=>"receiptsreceiptid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipts", "ReceiptID"]}}, "/Receipts/{ReceiptID}/Attachments"=>{"get"=>{"summary"=>"Get Receipts Receipt Attachments", "description"=>"Get receipts receipt attachments.", "operationId"=>"getReceiptsReceiptAttachments", "x-api-path-slug"=>"receiptsreceiptidattachments-get", "parameters"=>[{"in"=>"path", "name"=>"ReceiptID", "description"=>"The Xero generated unique identifier for a Receipt"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipts", "ReceiptID", "Attachments"]}}, "/Receipts/{ReceiptID}/Attachments/{FileName}"=>{"get"=>{"summary"=>"Get Receipts Receipt Attachments Filename", "description"=>"Get receipts receipt attachments filename.", "operationId"=>"getReceiptsReceiptAttachmentsFilename", "x-api-path-slug"=>"receiptsreceiptidattachmentsfilename-get", "parameters"=>[{"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment to be downloaded"}, {"in"=>"path", "name"=>"ReceiptID", "description"=>"The Xero generated unique identifier for a Receipt"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipts", "ReceiptID", "Attachments", "FileName"]}, "post"=>{"summary"=>"Post Receipts Receipt Attachments Filename", "description"=>"Post receipts receipt attachments filename.", "operationId"=>"postReceiptsReceiptAttachmentsFilename", "x-api-path-slug"=>"receiptsreceiptidattachmentsfilename-post", "parameters"=>[{"in"=>"body", "name"=>"Content", "description"=>"The raw content of the file to be uploaded", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment being uploaded"}, {"in"=>"path", "name"=>"ReceiptID", "description"=>"The Xero generated unique identifier for a Receipt"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipts", "ReceiptID", "Attachments", "FileName"]}}, "/RepeatingInvoices"=>{"get"=>{"summary"=>"Get Repeatinginvoices", "description"=>"Get repeatinginvoices.", "operationId"=>"getRepeatinginvoices", "x-api-path-slug"=>"repeatinginvoices-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RepeatingInvoices"]}, "x-related-model"=>{"summary"=>"X-related-model Repeatinginvoices", "description"=>"X-related-model repeatinginvoices.", "operationId"=>"x-related-modelRepeatinginvoices", "x-api-path-slug"=>"repeatinginvoices-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RepeatingInvoices"]}}, "/RepeatingInvoices/{RepeatingInvoiceID}"=>{"get"=>{"summary"=>"Get Repeatinginvoices Repeatinginvoice", "description"=>"Get repeatinginvoices repeatinginvoice.", "operationId"=>"getRepeatinginvoicesRepeatinginvoice", "x-api-path-slug"=>"repeatinginvoicesrepeatinginvoiceid-get", "parameters"=>[{"in"=>"path", "name"=>"RepeatingInvoiceID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RepeatingInvoices", "RepeatingInvoiceID"]}, "x-related-model"=>{"summary"=>"X-related-model Repeatinginvoices Repeatinginvoice", "description"=>"X-related-model repeatinginvoices repeatinginvoice.", "operationId"=>"x-related-modelRepeatinginvoicesRepeatinginvoice", "x-api-path-slug"=>"repeatinginvoicesrepeatinginvoiceid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RepeatingInvoices", "RepeatingInvoiceID"]}}, "/RepeatingInvoices/{RepeatingInvoiceID}/Attachments"=>{"get"=>{"summary"=>"Get Repeatinginvoices Repeatinginvoice Attachments", "description"=>"Get repeatinginvoices repeatinginvoice attachments.", "operationId"=>"getRepeatinginvoicesRepeatinginvoiceAttachments", "x-api-path-slug"=>"repeatinginvoicesrepeatinginvoiceidattachments-get", "parameters"=>[{"in"=>"path", "name"=>"RepeatingInvoiceID", "description"=>"The Xero generated unique identifier for a RepeatingInvoice"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RepeatingInvoices", "RepeatingInvoiceID", "Attachments"]}}, "/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}"=>{"get"=>{"summary"=>"Get Repeatinginvoices Repeatinginvoice Attachments Filename", "description"=>"Get repeatinginvoices repeatinginvoice attachments filename.", "operationId"=>"getRepeatinginvoicesRepeatinginvoiceAttachmentsFilename", "x-api-path-slug"=>"repeatinginvoicesrepeatinginvoiceidattachmentsfilename-get", "parameters"=>[{"in"=>"path", "name"=>"FileName", "description"=>"The filename of the attachment to be downloaded"}, {"in"=>"path", "name"=>"RepeatingInvoiceID", "description"=>"The Xero generated unique identifier for a RepeatingInvoice"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RepeatingInvoices", "RepeatingInvoiceID", "Attachments", "FileName"]}}, "/Reports"=>{"get"=>{"summary"=>"Get Reports", "description"=>"Get reports.", "operationId"=>"getReports", "x-api-path-slug"=>"reports-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports"]}, "x-related-model"=>{"summary"=>"X-related-model Reports", "description"=>"X-related-model reports.", "operationId"=>"x-related-modelReports", "x-api-path-slug"=>"reports-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports"]}}, "/Reports/AgedPayablesByContact"=>{"get"=>{"summary"=>"Get Reports Agedpayablesbycontact", "description"=>"Get reports agedpayablesbycontact.", "operationId"=>"getReportsAgedpayablesbycontact", "x-api-path-slug"=>"reportsagedpayablesbycontact-get", "parameters"=>[{"in"=>"query", "name"=>"contactID", "description"=>"ContactID for the contact youre running the report for"}, {"in"=>"query", "name"=>"date", "description"=>"Shows payments up to this date e"}, {"in"=>"query", "name"=>"fromDate", "description"=>"Show all payable invoices from this date for contact"}, {"in"=>"query", "name"=>"toDate", "description"=>"Show all payable invoices to this date for the contact"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "AgedPayablesByContact"]}, "x-related-model"=>{"summary"=>"X-related-model Reports Agedpayablesbycontact", "description"=>"X-related-model reports agedpayablesbycontact.", "operationId"=>"x-related-modelReportsAgedpayablesbycontact", "x-api-path-slug"=>"reportsagedpayablesbycontact-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "AgedPayablesByContact"]}}, "/Reports/AgedReceivablesByContact"=>{"get"=>{"summary"=>"Get Reports Agedreceivablesbycontact", "description"=>"Get reports agedreceivablesbycontact.", "operationId"=>"getReportsAgedreceivablesbycontact", "x-api-path-slug"=>"reportsagedreceivablesbycontact-get", "parameters"=>[{"in"=>"query", "name"=>"contactID", "description"=>"ContactID for the contact youre running the report for"}, {"in"=>"query", "name"=>"date", "description"=>"Shows payments up to this date e"}, {"in"=>"query", "name"=>"fromDate", "description"=>"Show all receivable invoices from this date for contact"}, {"in"=>"query", "name"=>"toDate", "description"=>"Show all receivable invoices to this date for the contact"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "AgedReceivablesByContact"]}, "x-related-model"=>{"summary"=>"X-related-model Reports Agedreceivablesbycontact", "description"=>"X-related-model reports agedreceivablesbycontact.", "operationId"=>"x-related-modelReportsAgedreceivablesbycontact", "x-api-path-slug"=>"reportsagedreceivablesbycontact-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "AgedReceivablesByContact"]}}, "/Reports/BalanceSheet"=>{"get"=>{"summary"=>"Get Reports Balancesheet", "description"=>"Get reports balancesheet.", "operationId"=>"getReportsBalancesheet", "x-api-path-slug"=>"reportsbalancesheet-get", "parameters"=>[{"in"=>"query", "name"=>"date", "description"=>"YYYY-MM-DD"}, {"in"=>"query", "name"=>"paymentsOnly", "description"=>"Set this to true to get cash transactions only"}, {"in"=>"query", "name"=>"standardLayout", "description"=>"If set to true no custom report layouts will be applied to response"}, {"in"=>"query", "name"=>"trackingOptionID1", "description"=>"Run the balance sheet for a specific tracking option"}, {"in"=>"query", "name"=>"trackingOptionID2", "description"=>"Run the balance sheet for a combination of two tracking options"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "BalanceSheet"]}, "x-related-model"=>{"summary"=>"X-related-model Reports Balancesheet", "description"=>"X-related-model reports balancesheet.", "operationId"=>"x-related-modelReportsBalancesheet", "x-api-path-slug"=>"reportsbalancesheet-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "BalanceSheet"]}}, "/Reports/BankStatement"=>{"get"=>{"summary"=>"Get Reports Bankstatement", "description"=>"Get reports bankstatement.", "operationId"=>"getReportsBankstatement", "x-api-path-slug"=>"reportsbankstatement-get", "parameters"=>[{"in"=>"query", "name"=>"bankAccountID", "description"=>"bankAccountID e"}, {"in"=>"query", "name"=>"fromDate", "description"=>"YYYY-MM-DD"}, {"in"=>"query", "name"=>"toDate", "description"=>"YYYY-MM-DD"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "BankStatement"]}, "x-related-model"=>{"summary"=>"X-related-model Reports Bankstatement", "description"=>"X-related-model reports bankstatement.", "operationId"=>"x-related-modelReportsBankstatement", "x-api-path-slug"=>"reportsbankstatement-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "BankStatement"]}}, "/Reports/BankSummary"=>{"get"=>{"summary"=>"Get Reports Banksummary", "description"=>"Get reports banksummary.", "operationId"=>"getReportsBanksummary", "x-api-path-slug"=>"reportsbanksummary-get", "parameters"=>[{"in"=>"query", "name"=>"fromDate", "description"=>"YYYY-MM-DD"}, {"in"=>"query", "name"=>"toDate", "description"=>"YYYY-MM-DD"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "BankSummary"]}, "x-related-model"=>{"summary"=>"X-related-model Reports Banksummary", "description"=>"X-related-model reports banksummary.", "operationId"=>"x-related-modelReportsBanksummary", "x-api-path-slug"=>"reportsbanksummary-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "BankSummary"]}}, "/Reports/BudgetSummary"=>{"get"=>{"summary"=>"Get Reports Budgetsummary", "description"=>"Get reports budgetsummary.", "operationId"=>"getReportsBudgetsummary", "x-api-path-slug"=>"reportsbudgetsummary-get", "parameters"=>[{"in"=>"query", "name"=>"date", "description"=>"YYYY-MM-DD"}, {"in"=>"query", "name"=>"periods", "description"=>"The number of periods to compare (integer between 1 and 12)"}, {"in"=>"query", "name"=>"timeframe", "description"=>"The period size to compare to (1=month, 3=quarter, 12=year)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "BudgetSummary"]}, "x-related-model"=>{"summary"=>"X-related-model Reports Budgetsummary", "description"=>"X-related-model reports budgetsummary.", "operationId"=>"x-related-modelReportsBudgetsummary", "x-api-path-slug"=>"reportsbudgetsummary-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "BudgetSummary"]}}, "/Reports/ExecutiveSummary"=>{"get"=>{"summary"=>"Get Reports Executivesummary", "description"=>"Get reports executivesummary.", "operationId"=>"getReportsExecutivesummary", "x-api-path-slug"=>"reportsexecutivesummary-get", "parameters"=>[{"in"=>"query", "name"=>"date", "description"=>"YYYY-MM-DD"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "ExecutiveSummary"]}, "x-related-model"=>{"summary"=>"X-related-model Reports Executivesummary", "description"=>"X-related-model reports executivesummary.", "operationId"=>"x-related-modelReportsExecutivesummary", "x-api-path-slug"=>"reportsexecutivesummary-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "ExecutiveSummary"]}}, "/Reports/ProfitAndLoss"=>{"get"=>{"summary"=>"Get Reports Profitandloss", "description"=>"Get reports profitandloss.", "operationId"=>"getReportsProfitandloss", "x-api-path-slug"=>"reportsprofitandloss-get", "parameters"=>[{"in"=>"query", "name"=>"fromDate", "description"=>"YYYY-MM-DD"}, {"in"=>"query", "name"=>"paymentsOnly", "description"=>"Set this to true to get cash transactions only"}, {"in"=>"query", "name"=>"standardLayout", "description"=>"If you set this parameter to true then no custom report layouts will be applied to response"}, {"in"=>"query", "name"=>"toDate", "description"=>"YYYY-MM-DD"}, {"in"=>"query", "name"=>"trackingCategoryID", "description"=>"If you specify the trackingCategoryID parameter then the Profit and Loss Report will show figures for each of the options in the category as separate columns"}, {"in"=>"query", "name"=>"trackingCategoryID2", "description"=>"If you specify a second trackingCategoryID parameter then the Profit and Loss Report will show figures for each combination of options from the two categories as separate columns"}, {"in"=>"query", "name"=>"trackingOptionID", "description"=>"If you specify this parameter in addition to the trackingCategoryID then just one option will be returned (i"}, {"in"=>"query", "name"=>"trackingOptionID2", "description"=>"If you specify this parameter in addition to a second trackingCategoryID then just one option will be returned combined with the option/s from the first tracking category"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "ProfitAndLoss"]}, "x-related-model"=>{"summary"=>"X-related-model Reports Profitandloss", "description"=>"X-related-model reports profitandloss.", "operationId"=>"x-related-modelReportsProfitandloss", "x-api-path-slug"=>"reportsprofitandloss-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "ProfitAndLoss"]}}, "/Reports/TenNinetyNine"=>{"get"=>{"summary"=>"Get Reports Tenninetynine", "description"=>"Get reports tenninetynine.", "operationId"=>"getReportsTenninetynine", "x-api-path-slug"=>"reportstenninetynine-get", "parameters"=>[{"in"=>"query", "name"=>"reportYear", "description"=>"Year of the report e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "TenNinetyNine"]}, "x-related-model"=>{"summary"=>"X-related-model Reports Tenninetynine", "description"=>"X-related-model reports tenninetynine.", "operationId"=>"x-related-modelReportsTenninetynine", "x-api-path-slug"=>"reportstenninetynine-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "TenNinetyNine"]}}, "/Reports/TrialBalance"=>{"get"=>{"summary"=>"Get Reports Trialbalance", "description"=>"Get reports trialbalance.", "operationId"=>"getReportsTrialbalance", "x-api-path-slug"=>"reportstrialbalance-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"YYYY-MM-DD"}, {"in"=>"query", "name"=>"paymentsOnly", "description"=>"Set this to true to get cash transactions only"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "TrialBalance"]}, "x-related-model"=>{"summary"=>"X-related-model Reports Trialbalance", "description"=>"X-related-model reports trialbalance.", "operationId"=>"x-related-modelReportsTrialbalance", "x-api-path-slug"=>"reportstrialbalance-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "TrialBalance"]}}, "/Reports/{ReportID}"=>{"get"=>{"summary"=>"Get Reports Report", "description"=>"Get reports report.", "operationId"=>"getReportsReport", "x-api-path-slug"=>"reportsreportid-get", "parameters"=>[{"in"=>"path", "name"=>"ReportID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "ReportID"]}, "x-related-model"=>{"summary"=>"X-related-model Reports Report", "description"=>"X-related-model reports report.", "operationId"=>"x-related-modelReportsReport", "x-api-path-slug"=>"reportsreportid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "ReportID"]}}, "/TaxRates"=>{"get"=>{"summary"=>"Get Taxrates", "description"=>"Get taxrates.", "operationId"=>"getTaxrates", "x-api-path-slug"=>"taxrates-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TaxRates"]}, "post"=>{"summary"=>"Post Taxrates", "description"=>"Post taxrates.", "operationId"=>"postTaxrates", "x-api-path-slug"=>"taxrates-post", "parameters"=>[{"in"=>"body", "name"=>"TaxRates", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TaxRates"]}, "put"=>{"summary"=>"Put Taxrates", "description"=>"Put taxrates.", "operationId"=>"putTaxrates", "x-api-path-slug"=>"taxrates-put", "parameters"=>[{"in"=>"body", "name"=>"TaxRates", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TaxRates"]}, "x-related-model"=>{"summary"=>"X-related-model Taxrates", "description"=>"X-related-model taxrates.", "operationId"=>"x-related-modelTaxrates", "x-api-path-slug"=>"taxrates-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TaxRates"]}}, "/TrackingCategories"=>{"get"=>{"summary"=>"Get Tracking Categories", "description"=>"Get trackingcategories.", "operationId"=>"getTrackingcategories", "x-api-path-slug"=>"trackingcategories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TrackingCategories"]}, "post"=>{"summary"=>"Post Tracking Categories", "description"=>"Post trackingcategories.", "operationId"=>"postTrackingcategories", "x-api-path-slug"=>"trackingcategories-post", "parameters"=>[{"in"=>"body", "name"=>"TrackingCategories", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TrackingCategories"]}, "put"=>{"summary"=>"Put Tracking Categories", "description"=>"Put trackingcategories.", "operationId"=>"putTrackingcategories", "x-api-path-slug"=>"trackingcategories-put", "parameters"=>[{"in"=>"body", "name"=>"TrackingCategories", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TrackingCategories"]}, "x-related-model"=>{"summary"=>"X-related-model Tracking Categories", "description"=>"X-related-model trackingcategories.", "operationId"=>"x-related-modelTrackingcategories", "x-api-path-slug"=>"trackingcategories-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TrackingCategories"]}}, "/TrackingCategories/{TrackingCategoryID}"=>{"delete"=>{"summary"=>"Delete Tracking Categories Trackingcategory", "description"=>"Delete trackingcategories trackingcategory.", "operationId"=>"deleteTrackingcategoriesTrackingcategory", "x-api-path-slug"=>"trackingcategoriestrackingcategoryid-delete", "parameters"=>[{"in"=>"path", "name"=>"TrackingCategoryID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TrackingCategories", "TrackingCategoryID"]}, "get"=>{"summary"=>"Get Tracking Categories Trackingcategory", "description"=>"Get trackingcategories trackingcategory.", "operationId"=>"getTrackingcategoriesTrackingcategory", "x-api-path-slug"=>"trackingcategoriestrackingcategoryid-get", "parameters"=>[{"in"=>"path", "name"=>"TrackingCategoryID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TrackingCategories", "TrackingCategoryID"]}, "post"=>{"summary"=>"Post Tracking Categories Trackingcategory", "description"=>"Post trackingcategories trackingcategory.", "operationId"=>"postTrackingcategoriesTrackingcategory", "x-api-path-slug"=>"trackingcategoriestrackingcategoryid-post", "parameters"=>[{"in"=>"body", "name"=>"TrackingCategories", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"TrackingCategoryID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TrackingCategories", "TrackingCategoryID"]}, "x-related-model"=>{"summary"=>"X-related-model Tracking Categories Trackingcategory", "description"=>"X-related-model trackingcategories trackingcategory.", "operationId"=>"x-related-modelTrackingcategoriesTrackingcategory", "x-api-path-slug"=>"trackingcategoriestrackingcategoryid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TrackingCategories", "TrackingCategoryID"]}}, "/TrackingCategories/{TrackingCategoryID}/Options"=>{"put"=>{"summary"=>"Put Tracking Categories Trackingcategory Options", "description"=>"Put trackingcategories trackingcategory options.", "operationId"=>"putTrackingcategoriesTrackingcategoryOptions", "x-api-path-slug"=>"trackingcategoriestrackingcategoryidoptions-put", "parameters"=>[{"in"=>"path", "name"=>"TrackingCategoryID"}, {"in"=>"body", "name"=>"TrackingOptions", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TrackingCategories", "TrackingCategoryID", "Options"]}, "x-related-model"=>{"summary"=>"X-related-model Tracking Categories Trackingcategory Options", "description"=>"X-related-model trackingcategories trackingcategory options.", "operationId"=>"x-related-modelTrackingcategoriesTrackingcategoryOptions", "x-api-path-slug"=>"trackingcategoriestrackingcategoryidoptions-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TrackingCategories", "TrackingCategoryID", "Options"]}}, "/TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}"=>{"delete"=>{"summary"=>"Delete Tracking Categories Trackingcategory Options Trackingoption", "description"=>"Delete trackingcategories trackingcategory options trackingoption.", "operationId"=>"deleteTrackingcategoriesTrackingcategoryOptionsTrackingoption", "x-api-path-slug"=>"trackingcategoriestrackingcategoryidoptionstrackingoptionid-delete", "parameters"=>[{"in"=>"path", "name"=>"TrackingCategoryID"}, {"in"=>"path", "name"=>"TrackingOptionID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TrackingCategories", "TrackingCategoryID", "Options", "TrackingOptionID"]}, "x-related-model"=>{"summary"=>"X-related-model Tracking Categories Trackingcategory Options Trackingoption", "description"=>"X-related-model trackingcategories trackingcategory options trackingoption.", "operationId"=>"x-related-modelTrackingcategoriesTrackingcategoryOptionsTrackingoption", "x-api-path-slug"=>"trackingcategoriestrackingcategoryidoptionstrackingoptionid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TrackingCategories", "TrackingCategoryID", "Options", "TrackingOptionID"]}}, "/Users"=>{"get"=>{"summary"=>"Get Users", "description"=>"Get users.", "operationId"=>"getUsers", "x-api-path-slug"=>"users-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "x-related-model"=>{"summary"=>"X-related-model Users", "description"=>"X-related-model users.", "operationId"=>"x-related-modelUsers", "x-api-path-slug"=>"users-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/Users/{UserID}"=>{"get"=>{"summary"=>"Get Users User", "description"=>"Get users user.", "operationId"=>"getUsersUser", "x-api-path-slug"=>"usersuserid-get", "parameters"=>[{"in"=>"path", "name"=>"UserID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "UserID"]}, "x-related-model"=>{"summary"=>"X-related-model Users User", "description"=>"X-related-model users user.", "operationId"=>"x-related-modelUsersUser", "x-api-path-slug"=>"usersuserid-xrelatedmodel", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "UserID"]}}}}, "xero-oauth-1a-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xero", "x-complete"=>1, "info"=>{"title"=>"Xero oAuth 1a", "description"=>"a-collection-to-authenticate-to-the-xero-api-using-oauth1-0a", "version"=>"1.0.0"}, "host"=>"api.xero.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/oauth/RequestToken"=>{"get"=>{"summary"=>"Request Token", "description"=>"TODO: Add Description", "operationId"=>"OauthRequestTokenGet", "x-api-path-slug"=>"oauthrequesttoken-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/oauth/AccessToken"=>{"get"=>{"summary"=>"Access Token", "description"=>"TODO: Add Description", "operationId"=>"OauthAccessTokenGet", "x-api-path-slug"=>"oauthaccesstoken-get", "parameters"=>[{"in"=>"query", "name"=>"oauth_verifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/api.xro/2.0/Organisation"=>{"get"=>{"summary"=>"Organisation", "description"=>"TODO: Add Description", "operationId"=>"ApiXro20OrganisationGet", "x-api-path-slug"=>"api-xro2-0organisation-get", "parameters"=>[{"in"=>"header", "name"=>"accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"Xero", "x-slug"=>"xero", "description"=>"Xero is the QuickBooks alternative. Use Xero accounting software to manage invoicing, bank reconciliation, bookkeeping & more. Start a free trial today!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/279-xero.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"2158", "tags"=>"Accounting,Accounting,Finance,Finance,Invoices,Relative Data,SaaS,Service API,Stack Network,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"xero/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Clarity Accounting", "x-api-slug"=>"clarity-accounting", "description"=>"Xero is the QuickBooks alternative. Use Xero accounting software to manage invoicing, bank reconciliation, bookkeeping & more. Start a free trial today!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/279-xero.jpg", "humanURL"=>"http://www.xero.com/", "baseURL"=>"https://api.xero.com//api.xro/2.0", "tags"=>"Accounting,Accounting,Finance,Finance,Invoices,Relative Data,SaaS,Service API,Stack Network,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xero/clarity-accounting-openapi.yaml"}]}, {"name"=>"Xero oAuth 1a", "x-api-slug"=>"xero-oauth-1a", "description"=>"Xero is the QuickBooks alternative. Use Xero accounting software to manage invoicing, bank reconciliation, bookkeeping & more. Start a free trial today!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/279-xero.jpg", "humanURL"=>"http://www.xero.com/", "baseURL"=>"https://api.xero.com//", "tags"=>"Users,UserID", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/xero/api-xro2-0organisation-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/xero/xero-oauth-1a-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.xero.com"}, {"type"=>"x-blog", "url"=>"http://blog.xero.com"}, {"type"=>"x-blog", "url"=>"https://devblog.xero.com/"}, {"type"=>"x-blog-rss", "url"=>"https://devblog.xero.com/feed"}, {"type"=>"x-blog-rss", "url"=>"http://feeds.feedburner.com/xerolive"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/xero"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/xero"}, {"type"=>"x-developer", "url"=>"http://developer.xero.com/"}, {"type"=>"x-email", "url"=>"support@xero.com"}, {"type"=>"x-email", "url"=>"sales@xero.com"}, {"type"=>"x-email", "url"=>"careers@xero.com"}, {"type"=>"x-email", "url"=>"privacy@xero.com"}, {"type"=>"x-email", "url"=>"phishing@xero.com"}, {"type"=>"x-email", "url"=>"press@xero.com"}, {"type"=>"x-email", "url"=>"AUpress@xero.com"}, {"type"=>"x-email", "url"=>"UKpress@xero.com"}, {"type"=>"x-email", "url"=>"USpress@xero.com"}, {"type"=>"x-github", "url"=>"https://github.com/XeroAPI"}, {"type"=>"x-partners", "url"=>"http://developer.xero.com/partner/"}, {"type"=>"x-pricing", "url"=>"https://www.xero.com/us/pricing/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/xero"}, {"type"=>"x-webhook", "url"=>"https://developer.xero.com/documentation/webhooks/overview"}, {"type"=>"x-website", "url"=>"http://www.xero.com/"}, {"type"=>"x-website", "url"=>"http://xero.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-cloudsearch{"aws-cloudsearch-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS CloudSearch", "x-complete"=>1, "info"=>{"title"=>"AWS CloudSearch", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddTags"=>{"get"=>{"summary"=>"Add Tags", "description"=>"Attaches resource tags to an\n Amazon CloudSearch domain.", "operationId"=>"AddTags", "x-api-path-slug"=>"actionaddtags-get", "parameters"=>[{"in"=>"query", "name"=>"Base", "description"=>"An error occurred while processing the request", "type"=>"string"}, {"in"=>"query", "name"=>"InternalException", "description"=>"The processing of the request failed because of an internal service error", "type"=>"string"}, {"in"=>"query", "name"=>"LimitExceededException", "description"=>"The request contains more than the allowed number and type of Amazon CloudSearch domain resources", "type"=>"string"}, {"in"=>"query", "name"=>"ValidationException", "description"=>"The request contains invalid input or is missing required input", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=BuildSuggesters"=>{"get"=>{"summary"=>"Build Suggesters", "description"=>"Indexes the search suggestions.", "operationId"=>"BuildSuggesters", "x-api-path-slug"=>"actionbuildsuggesters-get", "parameters"=>[{"in"=>"query", "name"=>"DomainName", "description"=>"A string that represents the name of a domain", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suggesters"]}}, "/?Action=CreateDomain"=>{"get"=>{"summary"=>"Create Domain", "description"=>"Creates a new search domain.", "operationId"=>"CreateDomain", "x-api-path-slug"=>"actioncreatedomain-get", "parameters"=>[{"in"=>"query", "name"=>"DomainName", "description"=>"A name for the domain you are creating", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/?Action=DefineAnalysisScheme"=>{"get"=>{"summary"=>"Define Analysis Scheme", "description"=>"Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options.", "operationId"=>"DefineAnalysisScheme", "x-api-path-slug"=>"actiondefineanalysisscheme-get", "parameters"=>[{"in"=>"query", "name"=>"AnalysisScheme", "description"=>"Configuration information for an analysis scheme", "type"=>"string"}, {"in"=>"query", "name"=>"DomainName", "description"=>"A string that represents the name of a domain", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analysis Scheme"]}}, "/?Action=DefineExpression"=>{"get"=>{"summary"=>"Define Expression", "description"=>"Configures an Expression for the search domain.", "operationId"=>"DefineExpression", "x-api-path-slug"=>"actiondefineexpression-get", "parameters"=>[{"in"=>"query", "name"=>"DomainName", "description"=>"A string that represents the name of a domain", "type"=>"string"}, {"in"=>"query", "name"=>"Expression", "description"=>"A named expression that can be evaluated at search time", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Expressions"]}}, "/?Action=DefineIndexField"=>{"get"=>{"summary"=>"Define Index Field", "description"=>"Configures an ndexField for the search domain.", "operationId"=>"DefineIndexField", "x-api-path-slug"=>"actiondefineindexfield-get", "parameters"=>[{"in"=>"query", "name"=>"DomainName", "description"=>"A string that represents the name of a domain", "type"=>"string"}, {"in"=>"query", "name"=>"IndexField", "description"=>"The index field and field options you want to configure", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Index Fields"]}}, "/?Action=DefineSuggester"=>{"get"=>{"summary"=>"Define Suggester", "description"=>"Configures a suggester for a domain.", "operationId"=>"DefineSuggester", "x-api-path-slug"=>"actiondefinesuggester-get", "parameters"=>[{"in"=>"query", "name"=>"DomainName", "description"=>"A string that represents the name of a domain", "type"=>"string"}, {"in"=>"query", "name"=>"Suggester", "description"=>"Configuration information for a search suggester", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suggesters"]}}, "/?Action=DeleteAnalysisScheme"=>{"get"=>{"summary"=>"Delete Analysis Scheme", "description"=>"Deletes an analysis scheme.", "operationId"=>"DeleteAnalysisScheme", "x-api-path-slug"=>"actiondeleteanalysisscheme-get", "parameters"=>[{"in"=>"query", "name"=>"AnalysisSchemeName", "description"=>"The name of the analysis scheme you want to delete", "type"=>"string"}, {"in"=>"query", "name"=>"DomainName", "description"=>"A string that represents the name of a domain", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analysis Scheme"]}}, "/?Action=DeleteDomain"=>{"get"=>{"summary"=>"Delete Domain", "description"=>"Permanently deletes a search domain and all of its data.", "operationId"=>"DeleteDomain", "x-api-path-slug"=>"actiondeletedomain-get", "parameters"=>[{"in"=>"query", "name"=>"DomainName", "description"=>"The name of the domain you want to permanently delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/?Action=DeleteExpression"=>{"get"=>{"summary"=>"Delete Expression", "description"=>"Removes an \n Expression\n from the search domain.", "operationId"=>"DeleteExpression", "x-api-path-slug"=>"actiondeleteexpression-get", "parameters"=>[{"in"=>"query", "name"=>"DomainName", "description"=>"A string that represents the name of a domain", "type"=>"string"}, {"in"=>"query", "name"=>"ExpressionName", "description"=>"The name of the Expression to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Expressions"]}}, "/?Action=DeleteIndexField"=>{"get"=>{"summary"=>"Delete Index Field", "description"=>"Removes an \n IndexField\n from the search domain.", "operationId"=>"DeleteIndexField", "x-api-path-slug"=>"actiondeleteindexfield-get", "parameters"=>[{"in"=>"query", "name"=>"DomainName", "description"=>"A string that represents the name of a domain", "type"=>"string"}, {"in"=>"query", "name"=>"IndexFieldName", "description"=>"The name of the index field your want to remove from the domains indexing options", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Index Fields"]}}, "/?Action=DeleteSuggester"=>{"get"=>{"summary"=>"Delete Suggester", "description"=>"Deletes a suggester.", "operationId"=>"DeleteSuggester", "x-api-path-slug"=>"actiondeletesuggester-get", "parameters"=>[{"in"=>"query", "name"=>"DomainName", "description"=>"A string that represents the name of a domain", "type"=>"string"}, {"in"=>"query", "name"=>"SuggesterName", "description"=>"Specifies the name of the suggester you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suggesters"]}}, "/?Action=DescribeAnalysisSchemes"=>{"get"=>{"summary"=>"Describe Analysis Schemes", "description"=>"Gets the analysis schemes configured for a domain.", "operationId"=>"DescribeAnalysisSchemes", "x-api-path-slug"=>"actiondescribeanalysisschemes-get", "parameters"=>[{"in"=>"query", "name"=>"AnalysisSchemeNames.member.N", "description"=>"The analysis schemes you want to describe", "type"=>"string"}, {"in"=>"query", "name"=>"Deployed", "description"=>"Whether to display the deployed configuration (true) or include any pending changes (false)", "type"=>"string"}, {"in"=>"query", "name"=>"DomainName", "description"=>"The name of the domain you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analysis Scheme"]}}, "/?Action=DescribeAvailabilityOptions"=>{"get"=>{"summary"=>"Describe Availability Options", "description"=>"Gets the availability options configured for a domain.", "operationId"=>"DescribeAvailabilityOptions", "x-api-path-slug"=>"actiondescribeavailabilityoptions-get", "parameters"=>[{"in"=>"query", "name"=>"Deployed", "description"=>"Whether to display the deployed configuration (true) or include any pending changes (false)", "type"=>"string"}, {"in"=>"query", "name"=>"DomainName", "description"=>"The name of the domain you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availability Options"]}}, "/?Action=DescribeDomains"=>{"get"=>{"summary"=>"Describe Domains", "description"=>"Gets information about the search domains owned by this account.", "operationId"=>"DescribeDomains", "x-api-path-slug"=>"actiondescribedomains-get", "parameters"=>[{"in"=>"query", "name"=>"DomainNames.member.N", "description"=>"The names of the domains you want to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/?Action=DescribeExpressions"=>{"get"=>{"summary"=>"Describe Expressions", "description"=>"Gets the expressions configured for the search domain.", "operationId"=>"DescribeExpressions", "x-api-path-slug"=>"actiondescribeexpressions-get", "parameters"=>[{"in"=>"query", "name"=>"Deployed", "description"=>"Whether to display the deployed configuration (true) or include any pending changes (false)", "type"=>"string"}, {"in"=>"query", "name"=>"DomainName", "description"=>"The name of the domain you want to describe", "type"=>"string"}, {"in"=>"query", "name"=>"ExpressionNames.member.N", "description"=>"Limits the DescribeExpressions response to the specified expressions", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Expressions"]}}, "/?Action=DescribeIndexFields"=>{"get"=>{"summary"=>"Describe Index Fields", "description"=>"Gets information about the index fields configured for the search domain.", "operationId"=>"DescribeIndexFields", "x-api-path-slug"=>"actiondescribeindexfields-get", "parameters"=>[{"in"=>"query", "name"=>"Deployed", "description"=>"Whether to display the deployed configuration (true) or include any pending changes (false)", "type"=>"string"}, {"in"=>"query", "name"=>"DomainName", "description"=>"The name of the domain you want to describe", "type"=>"string"}, {"in"=>"query", "name"=>"FieldNames.member.N", "description"=>"A list of the index fields you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Index Fields"]}}, "/?Action=DescribeScalingParameters"=>{"get"=>{"summary"=>"Describe Scaling Parameters", "description"=>"Gets the scaling parameters configured for a domain.", "operationId"=>"DescribeScalingParameters", "x-api-path-slug"=>"actiondescribescalingparameters-get", "parameters"=>[{"in"=>"query", "name"=>"DomainName", "description"=>"A string that represents the name of a domain", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scaling Parameters"]}}, "/?Action=DescribeServiceAccessPolicies"=>{"get"=>{"summary"=>"Describe Service Access Policies", "description"=>"Gets information about the access policies that control access to the domain's document and search endpoints.", "operationId"=>"DescribeServiceAccessPolicies", "x-api-path-slug"=>"actiondescribeserviceaccesspolicies-get", "parameters"=>[{"in"=>"query", "name"=>"Deployed", "description"=>"Whether to display the deployed configuration (true) or include any pending changes (false)", "type"=>"string"}, {"in"=>"query", "name"=>"DomainName", "description"=>"The name of the domain you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Access Policies"]}}, "/?Action=DescribeSuggesters"=>{"get"=>{"summary"=>"Describe Suggesters", "description"=>"Gets the suggesters configured for a domain.", "operationId"=>"DescribeSuggesters", "x-api-path-slug"=>"actiondescribesuggesters-get", "parameters"=>[{"in"=>"query", "name"=>"Deployed", "description"=>"Whether to display the deployed configuration (true) or include any pending changes (false)", "type"=>"string"}, {"in"=>"query", "name"=>"DomainName", "description"=>"The name of the domain you want to describe", "type"=>"string"}, {"in"=>"query", "name"=>"SuggesterNames.member.N", "description"=>"The suggesters you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suggesters"]}}, "/?Action=IndexDocuments"=>{"get"=>{"summary"=>"Index Documents", "description"=>"Tells the search domain to start indexing its documents using the latest indexing options.", "operationId"=>"IndexDocuments", "x-api-path-slug"=>"actionindexdocuments-get", "parameters"=>[{"in"=>"query", "name"=>"DomainName", "description"=>"A string that represents the name of a domain", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Index Documents"]}}, "/?Action=ListDomainNames"=>{"get"=>{"summary"=>"List Domain Names", "description"=>"Lists all search domains owned by an account.", "operationId"=>"ListDomainNames", "x-api-path-slug"=>"actionlistdomainnames-get", "parameters"=>[{"in"=>"query", "name"=>"DomainNames", "description"=>"The names of the search domains owned by an account", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/?Action=ListTags"=>{"get"=>{"summary"=>"List Tags", "description"=>"Displays all of the resource\n tags for an Amazon CloudSearch domain.", "operationId"=>"ListTags", "x-api-path-slug"=>"actionlisttags-get", "parameters"=>[{"in"=>"query", "name"=>"Base", "description"=>"An error occurred while processing the request", "type"=>"string"}, {"in"=>"query", "name"=>"InternalException", "description"=>"The processing of the request failed because of an internal service error", "type"=>"string"}, {"in"=>"query", "name"=>"LimitExceededException", "description"=>"The request contains more than the allowed number and type of Amazon CloudSearch domain resources", "type"=>"string"}, {"in"=>"query", "name"=>"ValidationException", "description"=>"The request contains invalid input or is missing required input", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=RemoveTags"=>{"get"=>{"summary"=>"Remove Tags", "description"=>"Removes the specified resource tags\n from an Amazon ES domain.", "operationId"=>"RemoveTags", "x-api-path-slug"=>"actionremovetags-get", "parameters"=>[{"in"=>"query", "name"=>"Base", "description"=>"An error occurred while processing the request", "type"=>"string"}, {"in"=>"query", "name"=>"InternalException", "description"=>"The processing of the request failed because of an internal service error", "type"=>"string"}, {"in"=>"query", "name"=>"ValidationException", "description"=>"The request contains invalid input or is missing required input", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=UpdateAvailabilityOptions"=>{"get"=>{"summary"=>"Update Availability Options", "description"=>"Configures the availability options for a domain.", "operationId"=>"UpdateAvailabilityOptions", "x-api-path-slug"=>"actionupdateavailabilityoptions-get", "parameters"=>[{"in"=>"query", "name"=>"DomainName", "description"=>"A string that represents the name of a domain", "type"=>"string"}, {"in"=>"query", "name"=>"MultiAZ", "description"=>"You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availability Options"]}}, "/?Action=UpdateScalingParameters"=>{"get"=>{"summary"=>"Update Scaling Parameters", "description"=>"Configures scaling parameters for a domain.", "operationId"=>"UpdateScalingParameters", "x-api-path-slug"=>"actionupdatescalingparameters-get", "parameters"=>[{"in"=>"query", "name"=>"DomainName", "description"=>"A string that represents the name of a domain", "type"=>"string"}, {"in"=>"query", "name"=>"ScalingParameters", "description"=>"The desired instance type and desired number of replicas of each index partition", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scaling Parameters"]}}, "/?Action=UpdateServiceAccessPolicies"=>{"get"=>{"summary"=>"Update Service Access Policies", "description"=>"Configures the access rules that control access to the domain's document and search endpoints.", "operationId"=>"UpdateServiceAccessPolicies", "x-api-path-slug"=>"actionupdateserviceaccesspolicies-get", "parameters"=>[{"in"=>"query", "name"=>"AccessPolicies", "description"=>"The access rules you want to configure", "type"=>"string"}, {"in"=>"query", "name"=>"DomainName", "description"=>"A string that represents the name of a domain", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Access Policies"]}}, "/2013-01-01/documents/batch"=>{"get"=>{"summary"=>"Search Documents", "description"=>"You use the document service API to add, replace, or delete documents in your Amazon CloudSearch domain. For more information managing the documents in your search domain, see Uploading Data to an Amazon CloudSearch Domain.", "operationId"=>"search", "x-api-path-slug"=>"20130101documentsbatch-get", "parameters"=>[{"in"=>"body", "name"=>"fields", "description"=>"A collection of one or more field_name properties that define the fields the document contains", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"field_name", "description"=>"Specifies a field within the document being added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"id", "description"=>"An alphanumeric string", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"type", "description"=>"The operation type, add or delete", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}}}, "apis"=>{"name"=>"AWS CloudSearch", "x-slug"=>"aws-cloudsearch", "description"=>"Amazon CloudSearch is a managed service in the AWS Cloud that makes it simple and cost-effective to set up, manage, and scale a search solution for your website or application.Amazon CloudSearch supports 34 languages and popular search features such as highlighting, autocomplete, and geospatial search. For more information, see Benefits.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Application-Services_AmazonCloudSearch.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Documents,Profiles,Relative Data,Search,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-cloudsearch/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS CloudSearch", "x-api-slug"=>"aws-cloudsearch", "description"=>"Amazon CloudSearch is a managed service in the AWS Cloud that makes it simple and cost-effective to set up, manage, and scale a search solution for your website or application.Amazon CloudSearch supports 34 languages and popular search features such as highlighting, autocomplete, and geospatial search. For more information, see Benefits.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Application-Services_AmazonCloudSearch.png", "humanURL"=>"https://aws.amazon.com/cloudsearch/", "baseURL"=>"https:///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Documents,Profiles,Relative Data,Search,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-cloudsearch/aws-cloudsearch-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/cloudsearch-command-line-tools.html"}, {"type"=>"x-console", "url"=>"https://console.aws.amazon.com/cloudsearch"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/api-ref.html * hard to find"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/cloudsearch/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/cloudsearch/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/cloudsearch/pricing/"}, {"type"=>"x-testimonials", "url"=>"https://aws.amazon.com/cloudsearch/testimonials/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/cloudsearch/"}, {"type"=>"x-whats-new", "url"=>"https://aws.amazon.com/cloudsearch/whats-new/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-security-token-service{"aws-security-token-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Security Token Service", "x-complete"=>1, "info"=>{"title"=>"AWS Security Token Service API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AssumeRole"=>{"get"=>{"summary"=>"Assume Role", "description"=>"Returns a set of temporary security credentials (consisting of an access key ID, a\n secret access key, and a security token) that you can use to access AWS resources that you\n might not normally have access to.", "operationId"=>"assumeRole", "x-api-path-slug"=>"actionassumerole-get", "parameters"=>[{"in"=>"query", "name"=>"DurationSeconds", "description"=>"The duration, in seconds, of the role session", "type"=>"string"}, {"in"=>"query", "name"=>"ExternalId", "description"=>"A unique identifier that is used by third parties when assuming roles in their customers accounts", "type"=>"string"}, {"in"=>"query", "name"=>"Policy", "description"=>"An IAM policy in JSON format", "type"=>"string"}, {"in"=>"query", "name"=>"RoleArn", "description"=>"The Amazon Resource Name (ARN) of the role to assume", "type"=>"string"}, {"in"=>"query", "name"=>"RoleSessionName", "description"=>"An identifier for the assumed role session", "type"=>"string"}, {"in"=>"query", "name"=>"SerialNumber", "description"=>"The identification number of the MFA device that is associated with the user who is making the AssumeRole call", "type"=>"string"}, {"in"=>"query", "name"=>"TokenCode", "description"=>"The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles"]}}, "/?Action=AssumeRoleWithSAML"=>{"get"=>{"summary"=>"Assume Role With S A M L", "description"=>"Returns a set of temporary security credentials for users who have been authenticated\n via a SAML authentication response.", "operationId"=>"assumeRoleWithSAML", "x-api-path-slug"=>"actionassumerolewithsaml-get", "parameters"=>[{"in"=>"query", "name"=>"DurationSeconds", "description"=>"The duration, in seconds, of the role session", "type"=>"string"}, {"in"=>"query", "name"=>"Policy", "description"=>"An IAM policy in JSON format", "type"=>"string"}, {"in"=>"query", "name"=>"PrincipalArn", "description"=>"The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP", "type"=>"string"}, {"in"=>"query", "name"=>"RoleArn", "description"=>"The Amazon Resource Name (ARN) of the role that the caller is assuming", "type"=>"string"}, {"in"=>"query", "name"=>"SAMLAssertion", "description"=>"The base-64 encoded SAML authentication response provided by the IdP", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles"]}}, "/?Action=AssumeRoleWithWebIdentity"=>{"get"=>{"summary"=>"Assume Role With Web Identity", "description"=>"Returns a set of temporary security credentials for users who have been authenticated\n in a mobile or web application with a web identity provider, such as Amazon Cognito, Login with Amazon,\n Facebook, Google, or any OpenID Connect-compatible identity provider.", "operationId"=>"assumeRoleWithWebIdentity", "x-api-path-slug"=>"actionassumerolewithwebidentity-get", "parameters"=>[{"in"=>"query", "name"=>"DurationSeconds", "description"=>"The duration, in seconds, of the role session", "type"=>"string"}, {"in"=>"query", "name"=>"Policy", "description"=>"An IAM policy in JSON format", "type"=>"string"}, {"in"=>"query", "name"=>"ProviderId", "description"=>"The fully qualified host component of the domain name of the identity provider", "type"=>"string"}, {"in"=>"query", "name"=>"RoleArn", "description"=>"The Amazon Resource Name (ARN) of the role that the caller is assuming", "type"=>"string"}, {"in"=>"query", "name"=>"RoleSessionName", "description"=>"An identifier for the assumed role session", "type"=>"string"}, {"in"=>"query", "name"=>"WebIdentityToken", "description"=>"The OAuth 2", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles"]}}, "/?Action=DecodeAuthorizationMessage"=>{"get"=>{"summary"=>"Decode Authorization Message", "description"=>"Decodes additional information about the authorization status of a request from an\n encoded message returned in response to an AWS request.", "operationId"=>"decodeAuthorizationMessage", "x-api-path-slug"=>"actiondecodeauthorizationmessage-get", "parameters"=>[{"in"=>"query", "name"=>"EncodedMessage", "description"=>"The encoded message that was returned with the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles"]}}, "/?Action=GetCallerIdentity"=>{"get"=>{"summary"=>"Get Caller Identity", "description"=>"Returns details about the IAM identity whose credentials are used to call the\n API.", "operationId"=>"getCallerIdentity", "x-api-path-slug"=>"actiongetcalleridentity-get", "parameters"=>[{"in"=>"query", "name"=>"Account", "description"=>"The AWS account ID number of the account that owns or contains the calling entity", "type"=>"string"}, {"in"=>"query", "name"=>"Arn", "description"=>"The AWS ARN associated with the calling entity", "type"=>"string"}, {"in"=>"query", "name"=>"UserId", "description"=>"The unique identifier of the calling entity", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity"]}}, "/?Action=GetFederationToken"=>{"get"=>{"summary"=>"Get Federation Token", "description"=>"Returns a set of temporary security credentials (consisting of an access key ID, a\n secret access key, and a security token) for a federated user.", "operationId"=>"getFederationToken", "x-api-path-slug"=>"actiongetfederationtoken-get", "parameters"=>[{"in"=>"query", "name"=>"DurationSeconds", "description"=>"The duration, in seconds, that the session should last", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the federated user", "type"=>"string"}, {"in"=>"query", "name"=>"Policy", "description"=>"An IAM policy in JSON format that is passed with the GetFederationToken call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to call GetFederationToken", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Federation Token"]}}, "/?Action=GetSessionToken"=>{"get"=>{"summary"=>"Get Session Token", "description"=>"Returns a set of temporary credentials for an AWS account or IAM user.", "operationId"=>"getSessionToken", "x-api-path-slug"=>"actiongetsessiontoken-get", "parameters"=>[{"in"=>"query", "name"=>"DurationSeconds", "description"=>"The duration, in seconds, that the credentials should remain valid", "type"=>"string"}, {"in"=>"query", "name"=>"SerialNumber", "description"=>"The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call", "type"=>"string"}, {"in"=>"query", "name"=>"TokenCode", "description"=>"The value provided by the MFA device, if MFA is required", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session Token"]}}}}, "apis"=>{"name"=>"AWS Security Token Service", "x-slug"=>"aws-security-token-service", "description"=>"The AWS Security Token Service (STS) is a web service that enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users).", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Security-Identity_AWSIAM_AWSSTS.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Authentication,Profiles,Relative Data,Security,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-security-token-service/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Security Token Service API", "x-api-slug"=>"aws-security-token-service-api", "description"=>"The AWS Security Token Service (STS) is a web service that enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users).", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Security-Identity_AWSIAM_AWSSTS.png", "humanURL"=>"http://docs.aws.amazon.com/STS/latest/APIReference/Welcome.html", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Authentication,Profiles,Relative Data,Security,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-security-token-service/actiongetsessiontoken-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-security-token-service/aws-security-token-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/STS/latest/APIReference/"}, {"type"=>"x-errors", "url"=>"http://docs.aws.amazon.com/STS/latest/APIReference/CommonErrors.html"}, {"type"=>"x-website", "url"=>"http://docs.aws.amazon.com/STS/latest/APIReference/Welcome.html"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-api-discovery-service{"google-api-discovery-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google API Discovery Service", "x-complete"=>1, "info"=>{"title"=>"APIs Discovery Service", "description"=>"provides-information-about-other-google-apis-such-as-what-apis-are-available-the-resource-and-method-details-for-each-api-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"www.googleapis.com", "basePath"=>"/discovery/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/apis"=>{"get"=>{"summary"=>"Get APIs", "description"=>"Retrieve the list of APIs supported at this endpoint.", "operationId"=>"discovery.apis.list", "x-api-path-slug"=>"apis-get", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"Only include APIs with the given name"}, {"in"=>"query", "name"=>"preferred", "description"=>"Return only the preferred version of an API"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API"]}}, "/apis/{api}/{version}/rest"=>{"get"=>{"summary"=>"Get API Description", "description"=>"Retrieve the description of a particular version of an api.", "operationId"=>"discovery.apis.getRest", "x-api-path-slug"=>"apisapiversionrest-get", "parameters"=>[{"in"=>"path", "name"=>"api", "description"=>"The name of the API"}, {"in"=>"path", "name"=>"version", "description"=>"The version of the API"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API"]}}}}, "apis"=>{"name"=>"Google API Discovery Service", "x-slug"=>"google-api-discovery-service", "description"=>"You can use the Google API Discovery Service to build client libraries, IDE plugins, and other tools that interact with Google APIs. It provides a lightweight, JSON-based API that exposes machine-readable metadata about Google APIs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2017-03-16 at 9.06.47 PM.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Definitions,Discovery,Google APIs,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-api-discovery-service/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google API Discovery Service API", "x-api-slug"=>"google-api-discovery-service-api", "description"=>"You can use the Google API Discovery Service to build client libraries, IDE plugins, and other tools that interact with Google APIs. It provides a lightweight, JSON-based API that exposes machine-readable metadata about Google APIs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2017-03-16 at 9.06.47 PM.png", "humanURL"=>"https://developers.google.com/discovery/", "baseURL"=>"://www.googleapis.com//discovery/v1", "tags"=>"API Provider,API Service Provider,Definitions,Discovery,Google APIs,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/google-api-discovery-service/apisapiversionrest-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/google-api-discovery-service/google-api-discovery-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://developers.google.com/discovery/v1/using#discovery-doc-auth"}, {"type"=>"x-code", "url"=>"https://developers.google.com/discovery/libraries"}, {"type"=>"x-getting-started", "url"=>"https://developers.google.com/discovery/v1/getting_started"}, {"type"=>"x-performance", "url"=>"https://developers.google.com/discovery/v1/performance"}, {"type"=>"x-website", "url"=>"https://developers.google.com/discovery/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-step-functions{"aws-step-functions-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Step Functions", "x-complete"=>1, "info"=>{"title"=>"AWS Step Functions API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=CreateActivity"=>{"get"=>{"summary"=>"Create Activity", "description"=>"Creates an activity.", "operationId"=>"createActivity", "x-api-path-slug"=>"actioncreateactivity-get", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"The name of the activity to create", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity"]}}, "/?Action=CreateStateMachine"=>{"get"=>{"summary"=>"Create State Machine", "description"=>"Creates a state machine.", "operationId"=>"createStateMachine", "x-api-path-slug"=>"actioncreatestatemachine-get", "parameters"=>[{"in"=>"query", "name"=>"definition", "description"=>"The Amazon States Language definition of the state machine", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the state machine", "type"=>"string"}, {"in"=>"query", "name"=>"roleArn", "description"=>"The Amazon Resource Name (ARN) of the IAM role to use for this state machine", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["State Machine"]}}, "/?Action=DeleteActivity"=>{"get"=>{"summary"=>"Delete Activity", "description"=>"Deletes an activity.", "operationId"=>"deleteActivity", "x-api-path-slug"=>"actiondeleteactivity-get", "parameters"=>[{"in"=>"query", "name"=>"activityArn", "description"=>"The Amazon Resource Name (ARN) of the activity to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity"]}}, "/?Action=DeleteStateMachine"=>{"get"=>{"summary"=>"Delete State Machine", "description"=>"Deletes a state machine.", "operationId"=>"deleteStateMachine", "x-api-path-slug"=>"actiondeletestatemachine-get", "parameters"=>[{"in"=>"query", "name"=>"stateMachineArn", "description"=>"The Amazon Resource Name (ARN) of the state machine to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["State Machine"]}}, "/?Action=DescribeActivity"=>{"get"=>{"summary"=>"Describe Activity", "description"=>"Describes an activity.", "operationId"=>"describeActivity", "x-api-path-slug"=>"actiondescribeactivity-get", "parameters"=>[{"in"=>"query", "name"=>"activityArn", "description"=>"The Amazon Resource Name (ARN) of the activity to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity"]}}, "/?Action=DescribeExecution"=>{"get"=>{"summary"=>"Describe Execution", "description"=>"Describes an execution.", "operationId"=>"describeExecution", "x-api-path-slug"=>"actiondescribeexecution-get", "parameters"=>[{"in"=>"query", "name"=>"executionArn", "description"=>"The Amazon Resource Name (ARN) of the execution to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execution"]}}, "/?Action=DescribeStateMachine"=>{"get"=>{"summary"=>"Describe State Machine", "description"=>"Describes a state machine.", "operationId"=>"describeStateMachine", "x-api-path-slug"=>"actiondescribestatemachine-get", "parameters"=>[{"in"=>"query", "name"=>"stateMachineArn", "description"=>"The Amazon Resource Name (ARN) of the state machine to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["State Machine"]}}, "/?Action=GetActivityTask"=>{"get"=>{"summary"=>"Get Activity Task", "description"=>"Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled \n for execution by a running state machine.", "operationId"=>"getActivityTask", "x-api-path-slug"=>"actiongetactivitytask-get", "parameters"=>[{"in"=>"query", "name"=>"activityArn", "description"=>"The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity", "type"=>"string"}, {"in"=>"query", "name"=>"workerName", "description"=>"You can provide an arbitrary name in order to identify the worker that the task is assigned to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity Task"]}}, "/?Action=GetExecutionHistory"=>{"get"=>{"summary"=>"Get Execution History", "description"=>"Returns the history of the specified execution as a list of events.", "operationId"=>"getExecutionHistory", "x-api-path-slug"=>"actiongetexecutionhistory-get", "parameters"=>[{"in"=>"query", "name"=>"executionArn", "description"=>"The Amazon Resource Name (ARN) of the execution", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results that will be returned per call", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"If a nextToken was returned by a previous call, there are more results available", "type"=>"string"}, {"in"=>"query", "name"=>"reverseOrder", "description"=>"Lists events in descending order of their timeStamp", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execution"]}}, "/?Action=ListActivities"=>{"get"=>{"summary"=>"List Activities", "description"=>"Lists the existing activities.", "operationId"=>"listActivities", "x-api-path-slug"=>"actionlistactivities-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results that will be returned per call", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"If a nextToken was returned by a previous call, there are more results available", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity"]}}, "/?Action=ListExecutions"=>{"get"=>{"summary"=>"List Executions", "description"=>"Lists the executions of a state machine that meet the filtering criteria.", "operationId"=>"listExecutions", "x-api-path-slug"=>"actionlistexecutions-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results that will be returned per call", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"If a nextToken was returned by a previous call, there are more results available", "type"=>"string"}, {"in"=>"query", "name"=>"stateMachineArn", "description"=>"The Amazon Resource Name (ARN) of the state machine whose executions will be listed", "type"=>"string"}, {"in"=>"query", "name"=>"statusFilter", "description"=>"If specified, only list the executions whose current execution status matches the given filter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["State Machine"]}}, "/?Action=ListStateMachines"=>{"get"=>{"summary"=>"List State Machines", "description"=>"Lists the existing state machines.", "operationId"=>"listStateMachines", "x-api-path-slug"=>"actionliststatemachines-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results that will be returned per call", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"If a nextToken was returned by a previous call, there are more results available", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["State Machine"]}}, "/?Action=SendTaskFailure"=>{"get"=>{"summary"=>"Send Task Failure", "description"=>"Used by workers to report that the task identified by the taskToken failed.", "operationId"=>"sendTaskFailure", "x-api-path-slug"=>"actionsendtaskfailure-get", "parameters"=>[{"in"=>"query", "name"=>"cause", "description"=>"A more detailed explanation of the cause of the failure", "type"=>"string"}, {"in"=>"query", "name"=>"error", "description"=>"An arbitrary error code that identifies the cause of the failure", "type"=>"string"}, {"in"=>"query", "name"=>"taskToken", "description"=>"The token that represents this task", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks"]}}, "/?Action=SendTaskHeartbeat"=>{"get"=>{"summary"=>"Send Task Heartbeat", "description"=>"Used by workers to report to the service that the task represented by the specified taskToken \n is still making progress.", "operationId"=>"sendTaskHeartbeat", "x-api-path-slug"=>"actionsendtaskheartbeat-get", "parameters"=>[{"in"=>"query", "name"=>"taskToken", "description"=>"The token that represents this task", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks"]}}, "/?Action=SendTaskSuccess"=>{"get"=>{"summary"=>"Send Task Success", "description"=>"Used by workers to report that the task identified by the taskToken completed successfully.", "operationId"=>"sendTaskSuccess", "x-api-path-slug"=>"actionsendtasksuccess-get", "parameters"=>[{"in"=>"query", "name"=>"output", "description"=>"The JSON output of the task", "type"=>"string"}, {"in"=>"query", "name"=>"taskToken", "description"=>"The token that represents this task", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks"]}}, "/?Action=StartExecution"=>{"get"=>{"summary"=>"Start Execution", "description"=>"Starts a state machine execution.", "operationId"=>"startExecution", "x-api-path-slug"=>"actionstartexecution-get", "parameters"=>[{"in"=>"query", "name"=>"input", "description"=>"The JSON input data for the execution", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the execution", "type"=>"string"}, {"in"=>"query", "name"=>"stateMachineArn", "description"=>"The Amazon Resource Name (ARN) of the state machine to execute", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["State Machine"]}}, "/?Action=StopExecution"=>{"get"=>{"summary"=>"Stop Execution", "description"=>"Stops an execution.", "operationId"=>"stopExecution", "x-api-path-slug"=>"actionstopexecution-get", "parameters"=>[{"in"=>"query", "name"=>"cause", "description"=>"A more detailed explanation of the cause of the termination", "type"=>"string"}, {"in"=>"query", "name"=>"error", "description"=>"An arbitrary error code that identifies the cause of the termination", "type"=>"string"}, {"in"=>"query", "name"=>"executionArn", "description"=>"The Amazon Resource Name (ARN) of the execution to stop", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execution"]}}}}, "apis"=>{"name"=>"AWS Step Functions", "x-slug"=>"aws-step-functions", "description"=>"AWS Step Functions makes it easy to coordinate the components of distributed applications and microservices using visual workflows. Building applications from individual components that each perform a discrete function lets you scale and change applications quickly. Step Functions is a reliable way to coordinate components and step through the functions of your application. Step Functions provides a graphical console to arrange and visualize the components of your application as a series of steps. This makes it simple to build and run multi-step applications. Step Functions automatically triggers and tracks each step, and retries when there are errors, so your application executes in order and as expected. Step Functions logs the state of each step, so when things do go wrong, you can diagnose and debug problems quickly. You can change and add steps without even writing code, so you can easily evolve your application and innovate faster.AWS Step Functions manages the operations and underlying infrastructure for you to help ensure your application is available at any scale.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-step-functions.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Automation,Etl,iPaaS,Orchestration,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-step-functions/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Step Functions API", "x-api-slug"=>"aws-step-functions-api", "description"=>"AWS Step Functions makes it easy to coordinate the components of distributed applications and microservices using visual workflows. Building applications from individual components that each perform a discrete function lets you scale and change applications quickly. Step Functions is a reliable way to coordinate components and step through the functions of your application. Step Functions provides a graphical console to arrange and visualize the components of your application as a series of steps. This makes it simple to build and run multi-step applications. Step Functions automatically triggers and tracks each step, and retries when there are errors, so your application executes in order and as expected. Step Functions logs the state of each step, so when things do go wrong, you can diagnose and debug problems quickly. You can change and add steps without even writing code, so you can easily evolve your application and innovate faster.AWS Step Functions manages the operations and underlying infrastructure for you to help ensure your application is available at any scale.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-step-functions.png", "humanURL"=>"https://aws.amazon.com/step-functions/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Automation,Etl,iPaaS,Orchestration,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-step-functions/actionstopexecution-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-step-functions/aws-step-functions-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/step-functions/latest/apireference/Welcome.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/step-functions/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/step-functions/getting-started/"}, {"type"=>"x-how-it-works", "url"=>"https://aws.amazon.com/step-functions/#howitworks"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/step-functions/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/step-functions/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
launchdarkly{"launch-darkly-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"LaunchDarkly", "x-complete"=>1, "info"=>{"title"=>"Launch Darkly", "description"=>"build-custom-integrations-with-the-launchdarkly-rest-api", "termsOfService"=>"https://launchdarkly.com/terms", "contact"=>{"name"=>"LaunchDarkly Support", "url"=>"https://support.launchdarkly.com", "email"=>"support@launchdarkly.com"}, "version"=>"2.0.0"}, "host"=>"app.launchdarkly.com", "basePath"=>"/api/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/"=>{"get"=>{"summary"=>"Get the root resource", "description"=>"Get the root resource.", "operationId"=>"getRoot", "x-api-path-slug"=>"get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/auditlog"=>{"get"=>{"summary"=>"Fetch a list of all webhooks", "description"=>"Fetch a list of all webhooks.", "operationId"=>"getAuditLogEntries", "x-api-path-slug"=>"auditlog-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auditlog"]}}, "/auditlog/{resourceId}"=>{"get"=>{"summary"=>"Get a webhook by ID", "description"=>"Get a webhook by id.", "operationId"=>"getAuditLogEntry", "x-api-path-slug"=>"auditlogresourceid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auditlog", "ResourceId"]}}, "/environments/{projectKey}"=>{"post"=>{"summary"=>"Create an environment", "description"=>"Create an environment.", "operationId"=>"postEnvironment", "x-api-path-slug"=>"environmentsprojectkey-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "Projects", "Keys"]}}, "/environments/{projectKey}/{environmentKey}"=>{"delete"=>{"summary"=>"Delete an environment by ID", "description"=>"Delete an environment by id.", "operationId"=>"deleteEnvironment", "x-api-path-slug"=>"environmentsprojectkeyenvironmentkey-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "Projects", "Keys", "EnvironmentKey"]}, "get"=>{"summary"=>"Get an environment by key.", "description"=>"Get an environment by key..", "operationId"=>"getEnvironment", "x-api-path-slug"=>"environmentsprojectkeyenvironmentkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "Projects", "Keys", "EnvironmentKey"]}, "patch"=>{"summary"=>"Modify an environment by ID", "description"=>"Modify an environment by id.", "operationId"=>"patchEnvironment", "x-api-path-slug"=>"environmentsprojectkeyenvironmentkey-patch", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "Projects", "Keys", "EnvironmentKey"]}}, "/flag-statuses/{projectKey}/{environmentKey}"=>{"get"=>{"summary"=>"Get a list of statuses for all feature flags", "description"=>"Get a list of statuses for all feature flags.", "operationId"=>"getFeatureFlagStatus", "x-api-path-slug"=>"flagstatusesprojectkeyenvironmentkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Flag-statuses", "Projects", "Keys", "EnvironmentKey"]}}, "/flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey}"=>{"get"=>{"summary"=>"Get a list of statuses for all feature flags", "description"=>"Get a list of statuses for all feature flags.", "operationId"=>"getFeatureFlagStatuses", "x-api-path-slug"=>"flagstatusesprojectkeyenvironmentkeyfeatureflagkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Flag-statuses", "Projects", "Keys", "EnvironmentKey", "FeatureFlagKey"]}}, "/flags/{projectKey}"=>{"get"=>{"summary"=>"Get a list of all features in the given project.", "description"=>"Get a list of all features in the given project..", "operationId"=>"getFeatureFlags", "x-api-path-slug"=>"flagsprojectkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Flags", "Projects", "Keys"]}, "post"=>{"summary"=>"Create a feature flag", "description"=>"Create a feature flag.", "operationId"=>"postFeatureFlag", "x-api-path-slug"=>"flagsprojectkey-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Flags", "Projects", "Keys"]}}, "/flags/{projectKey}/{featureFlagKey}"=>{"delete"=>{"summary"=>"Delete a feature flag by ID", "description"=>"Delete a feature flag by id.", "operationId"=>"deleteFeatureFlag", "x-api-path-slug"=>"flagsprojectkeyfeatureflagkey-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Flags", "Projects", "Keys", "FeatureFlagKey"]}, "get"=>{"summary"=>"Get a single feature flag by key.", "description"=>"Get a single feature flag by key..", "operationId"=>"getFeatureFlag", "x-api-path-slug"=>"flagsprojectkeyfeatureflagkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Flags", "Projects", "Keys", "FeatureFlagKey"]}, "patch"=>{"summary"=>"Modify a feature flag by ID", "description"=>"Modify a feature flag by id.", "operationId"=>"patchFeatureFlag", "x-api-path-slug"=>"flagsprojectkeyfeatureflagkey-patch", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Flags", "Projects", "Keys", "FeatureFlagKey"]}}, "/projects"=>{"get"=>{"summary"=>"Returns a list of all projects in the account.", "description"=>"Returns a list of all projects in the account..", "operationId"=>"getProjects", "x-api-path-slug"=>"projects-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}, "post"=>{"summary"=>"Create a project", "description"=>"Create a project.", "operationId"=>"postProject", "x-api-path-slug"=>"projects-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/projects/{projectKey}"=>{"delete"=>{"summary"=>"Delete a project by ID", "description"=>"Delete a project by id.", "operationId"=>"deleteProject", "x-api-path-slug"=>"projectsprojectkey-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Projects", "Keys"]}, "get"=>{"summary"=>"Get a project by key.", "description"=>"Get a project by key..", "operationId"=>"getProject", "x-api-path-slug"=>"projectsprojectkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Projects", "Keys"]}, "patch"=>{"summary"=>"Modify a project by ID", "description"=>"Modify a project by id.", "operationId"=>"patchProject", "x-api-path-slug"=>"projectsprojectkey-patch", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Projects", "Keys"]}}, "/user-search/{projectKey}/{environmentKey}"=>{"get"=>{"summary"=>"Search users in LaunchDarkly based on their last active date, or a search query.", "description"=>"Search users in launchdarkly based on their last active date, or a search query..", "operationId"=>"getSearchUsers", "x-api-path-slug"=>"usersearchprojectkeyenvironmentkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User-search", "Projects", "Keys", "EnvironmentKey"]}}, "/users/{projectKey}/{environmentKey}"=>{"get"=>{"summary"=>"List all users in the environment.", "description"=>"List all users in the environment..", "operationId"=>"getUsers", "x-api-path-slug"=>"usersprojectkeyenvironmentkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Projects", "Keys", "EnvironmentKey"]}}, "/users/{projectKey}/{environmentKey}/{userKey}"=>{"delete"=>{"summary"=>"Delete a user by ID", "description"=>"Delete a user by id.", "operationId"=>"deleteUser", "x-api-path-slug"=>"usersprojectkeyenvironmentkeyuserkey-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Projects", "Keys", "EnvironmentKey", "UserKey"]}, "get"=>{"summary"=>"Get a user by key.", "description"=>"Get a user by key..", "operationId"=>"getUser", "x-api-path-slug"=>"usersprojectkeyenvironmentkeyuserkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Projects", "Keys", "EnvironmentKey", "UserKey"]}}, "/users/{projectKey}/{environmentKey}/{userKey}/flags"=>{"get"=>{"summary"=>"Lists the current flag settings for a given user.", "description"=>"Lists the current flag settings for a given user..", "operationId"=>"getUserFlagSettings", "x-api-path-slug"=>"usersprojectkeyenvironmentkeyuserkeyflags-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Projects", "Keys", "EnvironmentKey", "UserKey", "Flags"]}}, "/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey}"=>{"get"=>{"summary"=>"Get a user by key.", "description"=>"Get a user by key..", "operationId"=>"getUserFlagSetting", "x-api-path-slug"=>"usersprojectkeyenvironmentkeyuserkeyflagsfeatureflagkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Projects", "Keys", "EnvironmentKey", "UserKey", "Flags", "FeatureFlagKey"]}, "put"=>{"summary"=>"Specifically enable or disable a feature flag for a user based on their key.", "description"=>"Specifically enable or disable a feature flag for a user based on their key..", "operationId"=>"putFlagSetting", "x-api-path-slug"=>"usersprojectkeyenvironmentkeyuserkeyflagsfeatureflagkey-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Projects", "Keys", "EnvironmentKey", "UserKey", "Flags", "FeatureFlagKey"]}}, "/webhooks"=>{"get"=>{"summary"=>"Fetch a list of all webhooks", "description"=>"Fetch a list of all webhooks.", "operationId"=>"getWebhooks", "x-api-path-slug"=>"webhooks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}, "post"=>{"summary"=>"Create a webhook", "description"=>"Create a webhook.", "operationId"=>"postWebhook", "x-api-path-slug"=>"webhooks-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}}, "/webhooks/{resourceId}"=>{"delete"=>{"summary"=>"Delete a webhook by ID", "description"=>"Delete a webhook by id.", "operationId"=>"deleteWebhook", "x-api-path-slug"=>"webhooksresourceid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "ResourceId"]}, "get"=>{"summary"=>"Get a webhook by ID", "description"=>"Get a webhook by id.", "operationId"=>"getWebhook", "x-api-path-slug"=>"webhooksresourceid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "ResourceId"]}, "patch"=>{"summary"=>"Modify a webhook by ID", "description"=>"Modify a webhook by id.", "operationId"=>"patchWebhook", "x-api-path-slug"=>"webhooksresourceid-patch", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "ResourceId"]}}}}, "apis"=>{"name"=>"LaunchDarkly", "x-slug"=>"launchdarkly", "description"=>"Our vision is to eliminate risk for developers and operations teams from the software development cycle. As companies transition to a world built on software, there is an increasing requirement to move quickly—but that often comes with the desire to maintain control. LaunchDarkly is the feature management platform that enables dev and ops teams to control the whole feature lifecycle, from concept to launch to value.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/21652-launchdarkly-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"187776", "tags"=>"API Provider,API Service Provider,Containers,Enterprise,Orchestration,Profiles,Relative Data,SaaS,Service API,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"launchdarkly/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Launch Darkly", "x-api-slug"=>"launch-darkly", "description"=>"Our vision is to eliminate risk for developers and operations teams from the software development cycle. As companies transition to a world built on software, there is an increasing requirement to move quickly—but that often comes with the desire to maintain control. LaunchDarkly is the feature management platform that enables dev and ops teams to control the whole feature lifecycle, from concept to launch to value.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/21652-launchdarkly-com.jpg", "humanURL"=>"http://www.launchdarkly.com", "baseURL"=>"https://app.launchdarkly.com//api/v2", "tags"=>"API Provider,API Service Provider,Containers,Enterprise,Orchestration,Profiles,Relative Data,SaaS,Service API,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/launchdarkly/webhooksresourceid-patch-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/launchdarkly/launch-darkly-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://www.launchdarkly.com"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/launchdarkly"}, {"type"=>"x-email", "url"=>"sales@launchdarkly.com"}, {"type"=>"x-email", "url"=>"privacy@launchdarkly.com"}, {"type"=>"x-email", "url"=>"security@launchdarkly.com"}, {"type"=>"x-github", "url"=>"https://github.com/launchdarkly"}, {"type"=>"x-curated-source", "url"=>"http://launchdarkly.com/blog/stripe-webhook-event-processing-best-practices/"}, {"type"=>"x-website", "url"=>"http://launchdarkly.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/LaunchDarkly"}, {"type"=>"x-webhook", "url"=>"https://apidocs.launchdarkly.com/docs/webhooks-overview"}, {"type"=>"x-webhook", "url"=>"https://docs.launchdarkly.com/docs/webhooks"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
chicago-illinois-311{"chicago-illinois-311-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Chicago Illinois 311", "x-complete"=>1, "info"=>{"title"=>"Chicago Open311 GeoReport API", "description"=>"open311-allows-you-to-getpost-civic-information-of-cities-via-a-unified-interface--the-georeport-part-allows-you-to-submit-and-view-issues-at-the-public-local-space", "termsOfService"=>"(depends on server instance for example NYC http://dev.cityofchicago.org/docs/api/tos)", "contact"=>{"name"=>"Open311 community", "url"=>"http://wiki.open311.org/GeoReport_v2/", "email"=>"discuss@lists.open311.org"}, "version"=>"1.0.0"}, "host"=>"311api.cityofchicago.org", "basePath"=>"/open311/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/requests.{response_format}"=>{"get"=>{"summary"=>"Requests", "description"=>"Query the current status of multiple requests.", "operationId"=>"query-the-current-status-of-multiple-requests", "x-api-path-slug"=>"requests-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"Latest datetime to include in search"}, {"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON format", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"service_code", "description"=>"Specify the service type by calling the unique ID of the service_code"}, {"in"=>"query", "name"=>"service_request_id", "description"=>"To call multiple Service Requests at once, multiple service_request_id can be declared; comma delimited"}, {"in"=>"query", "name"=>"start_date", "description"=>"Earliest datetime to include in search"}, {"in"=>"query", "name"=>"status", "description"=>"Allows one to search for requests which have a specific status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Requests"]}, "post"=>{"summary"=>"Create Service Request", "description"=>"Submit a new request for with specific details of a single service. Must provide a location via lat/long or address_string or address_id", "operationId"=>"submit-a-new-request-for-with-specific-details-of-a-single-service-must-provide-a-location-via-latlo", "x-api-path-slug"=>"requests-response-format-post", "parameters"=>[{"in"=>"query", "name"=>"address_id"}, {"in"=>"query", "name"=>"address_string"}, {"in"=>"query", "name"=>"attribute", "description"=>"array of key/value responses based on Service Definitions"}, {"in"=>"query", "name"=>"lat", "description"=>"WGS-84 latitude"}, {"in"=>"query", "name"=>"long", "description"=>"WGS-84 longitude"}, {"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON format", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"service_code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Service", "Request"]}}, "/request/{service_request_id}.{response_format}"=>{"get"=>{"summary"=>"Current Status", "description"=>"Query the current status of an individual request", "operationId"=>"query-the-current-status-of-an-individual-request", "x-api-path-slug"=>"requestservice-request-id-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"service_request_id", "description"=>"Is specified in the main URL path rather than an added query string parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Current", "Status"]}}, "/services.{response_format}"=>{"get"=>{"summary"=>"Service Types", "description"=>"List acceptable service request types and their associated service codes. These request types can be unique to the city/jurisdiction.", "operationId"=>"list-acceptable-service-request-types-and-their-associated-service-codes-these-request-types-can-be-", "x-api-path-slug"=>"services-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON format", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Service", "Types"]}}, "/services/{service_code}.{response_format}"=>{"get"=>{"summary"=>"(extended) Definition Of A Service Type", "description"=>"Define attributes associated with a service code. These attributes can be unique to the city/jurisdiction.", "operationId"=>"define-attributes-associated-with-a-service-code-these-attributes-can-be-unique-to-the-cityjurisdict", "x-api-path-slug"=>"servicesservice-code-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"service_code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "(extended)", "Definition", "Service", "Type"]}}, "/tokens/{token_id}.{response_format}"=>{"get"=>{"summary"=>"Id Of Service_request Via Token", "description"=>"Get the service_request_id from a temporary token. This is unnecessary if the response from creating a service request does not contain a token.", "operationId"=>"get-the-service-request-id-from-a-temporary-token-this-is-unnecessary-if-the-response-from-creating-", "x-api-path-slug"=>"tokenstoken-id-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"token_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Id", "Service", "Request", "Via", "Token"]}}}}, "apis"=>{"name"=>"Chicago Illinois 311", "x-slug"=>"chicago-illinois-311", "description"=>"Call 311 for assistance with non-emergency City Services and for information on events, programs and agencies within the City of Chicago.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/6A231614-652B-4334-852C-54261F4B13BD", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"311,Open311,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"chicago-illinois-311/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Chicago Illinois 311", "x-api-slug"=>"chicago-illinois-311", "description"=>"Call 311 for assistance with non-emergency City Services and for information on events, programs and agencies within the City of Chicago.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/6A231614-652B-4334-852C-54261F4B13BD", "humanURL"=>"http://cityofchicago.org/311", "baseURL"=>"http://311api.cityofchicago.org//open311/v2/", "tags"=>"311,Open311,Streams,Streams", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/chicago-illinois-311/tokenstoken-id-response-format-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/chicago-illinois-311/chicago-illinois-311-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://cityofchicago.org/311"}, {"type"=>"x-open-311-feed", "url"=>"http://311api.cityofchicago.org/open311/v2/services.xml?jurisdiction_id=cityofchicago.org"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Chicago311"}, {"type"=>"x-website", "url"=>"https://www.cityofchicago.org/city/en/depts/311.html"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google{"firebase-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google", "x-complete"=>1, "info"=>{"title"=>"Firebase", "description"=>"you-can-use-any-firebase-database-url-as-a-rest-endpoint--all-you-need-to-do-is-append--json-to-the-end-of-the-url-and-send-a-request-from-your-favorite-https-client-", "version"=>"1.0.0"}, "host"=>"{project_id].firebaseio.co}", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/shortLinks"=>{"post"=>{"summary"=>"Create Link", "description"=>"Creates a short Dynamic Link given either a valid long Dynamic Link or\ndetails such as Dynamic Link domain, Android and iOS app information.\nThe created short Dynamic Link will not expire.\n\nRepeated calls with the same long Dynamic Link or Dynamic Link information\nwill produce the same short Dynamic Link.\n\nThe Dynamic Link domain in the request must be owned by requester's\nFirebase project.", "operationId"=>"firebasedynamiclinks.shortLinks.create", "x-api-path-slug"=>"v1shortlinks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shortened Link"]}}, "/v1/{name}"=>{"delete"=>{"summary"=>"Delete Release", "description"=>"Delete a `Release` by resource name.", "operationId"=>"firebaserules.projects.releases.delete", "x-api-path-slug"=>"v1name-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Resource name for the `Release` to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Release"]}, "get"=>{"summary"=>"Get Release", "description"=>"Get a `Release` by name.", "operationId"=>"firebaserules.projects.releases.get", "x-api-path-slug"=>"v1name-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Resource name of the `Release`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Release"]}, "put"=>{"summary"=>"Update Release", "description"=>"Update a `Release`.\n\nOnly updates to the `ruleset_name` field will be honored. `Release` rename\nis not supported. To create a `Release` use the CreateRelease method\ninstead.", "operationId"=>"firebaserules.projects.releases.update", "x-api-path-slug"=>"v1name-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"Resource name for the `Release`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Release"]}}, "/v1/{name}/releases"=>{"get"=>{"summary"=>"List Releases", "description"=>"List the `Release` values for a project. This list may optionally be\nfiltered by `Release` name or `Ruleset` id or both.", "operationId"=>"firebaserules.projects.releases.list", "x-api-path-slug"=>"v1namereleases-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"`Release` filter"}, {"in"=>"path", "name"=>"name", "description"=>"Resource name for the project"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Page size to load"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Next page token for the next batch of `Release` instances"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Release"]}, "post"=>{"summary"=>"Create Releases", "description"=>"Create a `Release`.\n\nRelease names should reflect the developer's deployment practices. For\nexample, the release name may include the environment name, application\nname, application version, or any other name meaningful to the developer.\nOnce a `Release` refers to a `Ruleset`, the rules can be enforced by\nFirebase Rules-enabled services.\n\nMore than one `Release` may be 'live' concurrently. Consider the following\nthree `Release` names for `projects/foo` and the `Ruleset` to which they\nrefer.\n\nRelease Name | Ruleset Name\n--------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/beta | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456\n\nThe table reflects the `Ruleset` rollout in progress. The `prod` and\n`prod/beta` releases refer to the same `Ruleset`. However, `prod/v23`\nrefers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be\nupdated using the UpdateRelease method, and the custom `Release` name\nmay be referenced by specifying the `X-Firebase-Rules-Release-Name` header.", "operationId"=>"firebaserules.projects.releases.create", "x-api-path-slug"=>"v1namereleases-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"Resource name for the project which owns this `Release`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Release"]}}, "/v1/{name}/rulesets"=>{"get"=>{"summary"=>"List Rules", "description"=>"List `Ruleset` metadata only and optionally filter the results by Ruleset\nname.\n\nThe full `Source` contents of a `Ruleset` may be retrieved with\nGetRuleset.", "operationId"=>"firebaserules.projects.rulesets.list", "x-api-path-slug"=>"v1namerulesets-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Resource name for the project"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Page size to load"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Next page token for loading the next batch of `Ruleset` instances"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rules"]}, "post"=>{"summary"=>"Create Rules", "description"=>"Create a `Ruleset` from `Source`.\n\nThe `Ruleset` is given a unique generated name which is returned to the\ncaller. `Source` containing syntactic or semantics errors will result in an\nerror response indicating the first error encountered. For a detailed view\nof `Source` issues, use TestRuleset.", "operationId"=>"firebaserules.projects.rulesets.create", "x-api-path-slug"=>"v1namerulesets-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"Resource name for Project which owns this `Ruleset`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rules"]}}, "/v1/{name}:test"=>{"post"=>{"summary"=>"Test Rule", "description"=>"Test `Source` for syntactic and semantic correctness. Issues present in the\nrules, if any, will be returned to the caller with a description, severity,\nand source location.\n\nThe test method will typically be executed with a developer provided\n`Source`, but if regression testing is desired, this method may be\nexecuted against a `Ruleset` resource name and the `Source` will be\nretrieved from the persisted `Ruleset`.\n\nThe following is an example of `Source` that permits users to upload images\nto a bucket bearing their user id and matching the correct metadata:\n\n_*Example*_\n\n // Users are allowed to subscribe and unsubscribe to the blog.\n service firebase.storage {\n match /users/{userId}/images/{imageName} {\n allow write: if userId == request.userId\n && (imageName.endsWith('.png') || imageName.endsWith('.jpg'))\n && resource.mimeType.startsWith('image/')\n }\n }", "operationId"=>"firebaserules.projects.test", "x-api-path-slug"=>"v1nametest-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"Name of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rules"]}}, "/{projectId}/histories"=>{"get"=>{"summary"=>"List HIstories", "description"=>"Lists Histories for a given Project.\n\nThe histories are sorted by modification time in descending order. The history_id key will be used to order the history with the same modification time.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist", "operationId"=>"toolresults.projects.histories.list", "x-api-path-slug"=>"projectidhistories-get", "parameters"=>[{"in"=>"query", "name"=>"filterByName", "description"=>"If set, only return histories with the given name"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of Histories to fetch"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A continuation token to resume the query at the next item"}, {"in"=>"path", "name"=>"projectId", "description"=>"A Project id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["History"]}, "post"=>{"summary"=>"Create History", "description"=>"Creates a History.\n\nThe returned History will have the id set.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing project does not exist", "operationId"=>"toolresults.projects.histories.create", "x-api-path-slug"=>"projectidhistories-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"A Project id"}, {"in"=>"query", "name"=>"requestId", "description"=>"A unique request ID for server to detect duplicated requests"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["History"]}}, "/{projectId}/histories/{historyId}"=>{"get"=>{"summary"=>"Get History", "description"=>"Gets a History.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist", "operationId"=>"toolresults.projects.histories.get", "x-api-path-slug"=>"projectidhistorieshistoryid-get", "parameters"=>[{"in"=>"path", "name"=>"historyId", "description"=>"A History id"}, {"in"=>"path", "name"=>"projectId", "description"=>"A Project id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["History"]}}, "/{projectId}/histories/{historyId}/executions"=>{"get"=>{"summary"=>"Get Executions", "description"=>"Lists Histories for a given Project.\n\nThe executions are sorted by creation_time in descending order. The execution_id key will be used to order the executions with the same creation_time.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist", "operationId"=>"toolresults.projects.histories.executions.list", "x-api-path-slug"=>"projectidhistorieshistoryidexecutions-get", "parameters"=>[{"in"=>"path", "name"=>"historyId", "description"=>"A History id"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of Executions to fetch"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A continuation token to resume the query at the next item"}, {"in"=>"path", "name"=>"projectId", "description"=>"A Project id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["History"]}, "post"=>{"summary"=>"Create Execution", "description"=>"Creates an Execution.\n\nThe returned Execution will have the id set.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist", "operationId"=>"toolresults.projects.histories.executions.create", "x-api-path-slug"=>"projectidhistorieshistoryidexecutions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"historyId", "description"=>"A History id"}, {"in"=>"path", "name"=>"projectId", "description"=>"A Project id"}, {"in"=>"query", "name"=>"requestId", "description"=>"A unique request ID for server to detect duplicated requests"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execution"]}}, "/{projectId}/histories/{historyId}/executions/{executionId}"=>{"get"=>{"summary"=>"Get Execution", "description"=>"Gets an Execution.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Execution does not exist", "operationId"=>"toolresults.projects.histories.executions.get", "x-api-path-slug"=>"projectidhistorieshistoryidexecutionsexecutionid-get", "parameters"=>[{"in"=>"path", "name"=>"executionId", "description"=>"An Execution id"}, {"in"=>"path", "name"=>"historyId", "description"=>"A History id"}, {"in"=>"path", "name"=>"projectId", "description"=>"A Project id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execution"]}, "patch"=>{"summary"=>"Update Execution", "description"=>"Updates an existing Execution with the supplied partial entity.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal - NOT_FOUND - if the containing History does not exist", "operationId"=>"toolresults.projects.histories.executions.patch", "x-api-path-slug"=>"projectidhistorieshistoryidexecutionsexecutionid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"executionId", "description"=>"Required"}, {"in"=>"path", "name"=>"historyId", "description"=>"Required"}, {"in"=>"path", "name"=>"projectId", "description"=>"A Project id"}, {"in"=>"query", "name"=>"requestId", "description"=>"A unique request ID for server to detect duplicated requests"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execution"]}}, "/{projectId}/histories/{historyId}/executions/{executionId}/steps"=>{"get"=>{"summary"=>"Get Execution Steps", "description"=>"Lists Steps for a given Execution.\n\nThe steps are sorted by creation_time in descending order. The step_id key will be used to order the steps with the same creation_time.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if an attempt is made to list the children of a nonexistent Step - NOT_FOUND - if the containing Execution does not exist", "operationId"=>"toolresults.projects.histories.executions.steps.list", "x-api-path-slug"=>"projectidhistorieshistoryidexecutionsexecutionidsteps-get", "parameters"=>[{"in"=>"path", "name"=>"executionId", "description"=>"A Execution id"}, {"in"=>"path", "name"=>"historyId", "description"=>"A History id"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of Steps to fetch"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A continuation token to resume the query at the next item"}, {"in"=>"path", "name"=>"projectId", "description"=>"A Project id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execution Step"]}, "post"=>{"summary"=>"Create Execution Steps", "description"=>"Creates a Step.\n\nThe returned Step will have the id set.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist", "operationId"=>"toolresults.projects.histories.executions.steps.create", "x-api-path-slug"=>"projectidhistorieshistoryidexecutionsexecutionidsteps-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"executionId", "description"=>"A Execution id"}, {"in"=>"path", "name"=>"historyId", "description"=>"A History id"}, {"in"=>"path", "name"=>"projectId", "description"=>"A Project id"}, {"in"=>"query", "name"=>"requestId", "description"=>"A unique request ID for server to detect duplicated requests"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execution Step"]}}, "/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}"=>{"get"=>{"summary"=>"Get Execution Step", "description"=>"Gets a Step.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Step does not exist", "operationId"=>"toolresults.projects.histories.executions.steps.get", "x-api-path-slug"=>"projectidhistorieshistoryidexecutionsexecutionidstepsstepid-get", "parameters"=>[{"in"=>"path", "name"=>"executionId", "description"=>"A Execution id"}, {"in"=>"path", "name"=>"historyId", "description"=>"A History id"}, {"in"=>"path", "name"=>"projectId", "description"=>"A Project id"}, {"in"=>"path", "name"=>"stepId", "description"=>"A Step id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execution Step"]}, "patch"=>{"summary"=>"Update Execution Step", "description"=>"Updates an existing Step with the supplied partial entity.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal (e.g try to upload a duplicate xml file), if the updated step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist", "operationId"=>"toolresults.projects.histories.executions.steps.patch", "x-api-path-slug"=>"projectidhistorieshistoryidexecutionsexecutionidstepsstepid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"executionId", "description"=>"A Execution id"}, {"in"=>"path", "name"=>"historyId", "description"=>"A History id"}, {"in"=>"path", "name"=>"projectId", "description"=>"A Project id"}, {"in"=>"query", "name"=>"requestId", "description"=>"A unique request ID for server to detect duplicated requests"}, {"in"=>"path", "name"=>"stepId", "description"=>"A Step id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execution Step"]}}, "/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary"=>{"get"=>{"summary"=>"Get Metrics Summary", "description"=>"Retrieves a PerfMetricsSummary.\n\nMay return any of the following error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not exist", "operationId"=>"toolresults.projects.histories.executions.steps.getPerfMetricsSummary", "x-api-path-slug"=>"projectidhistorieshistoryidexecutionsexecutionidstepsstepidperfmetricssummary-get", "parameters"=>[{"in"=>"path", "name"=>"executionId", "description"=>"A tool results execution ID"}, {"in"=>"path", "name"=>"historyId", "description"=>"A tool results history ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"The cloud project"}, {"in"=>"path", "name"=>"stepId", "description"=>"A tool results step ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}, "post"=>{"summary"=>"Create Metric Summary", "description"=>"Creates a PerfMetricsSummary resource.\n\nMay return any of the following error code(s): - ALREADY_EXISTS - A PerfMetricSummary already exists for the given Step - NOT_FOUND - The containing Step does not exist", "operationId"=>"toolresults.projects.histories.executions.steps.perfMetricsSummary.create", "x-api-path-slug"=>"projectidhistorieshistoryidexecutionsexecutionidstepsstepidperfmetricssummary-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"executionId", "description"=>"A tool results execution ID"}, {"in"=>"path", "name"=>"historyId", "description"=>"A tool results history ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"The cloud project"}, {"in"=>"path", "name"=>"stepId", "description"=>"A tool results step ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}}, "/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries"=>{"get"=>{"summary"=>"Get Sample Series", "description"=>"Lists PerfSampleSeries for a given Step.\n\nThe request provides an optional filter which specifies one or more PerfMetricsType to include in the result; if none returns all. The resulting PerfSampleSeries are sorted by ids.\n\nMay return any of the following canonical error codes: - NOT_FOUND - The containing Step does not exist", "operationId"=>"toolresults.projects.histories.executions.steps.perfSampleSeries.list", "x-api-path-slug"=>"projectidhistorieshistoryidexecutionsexecutionidstepsstepidperfsampleseries-get", "parameters"=>[{"in"=>"path", "name"=>"executionId", "description"=>"A tool results execution ID"}, {"in"=>"query", "name"=>"filter", "description"=>"Specify one or more PerfMetricType values such as CPU to filter the result"}, {"in"=>"path", "name"=>"historyId", "description"=>"A tool results history ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"The cloud project"}, {"in"=>"path", "name"=>"stepId", "description"=>"A tool results step ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sample Series"]}, "post"=>{"summary"=>"Create Sample Series", "description"=>"Creates a PerfSampleSeries.\n\nMay return any of the following error code(s): - ALREADY_EXISTS - PerfMetricSummary already exists for the given Step - NOT_FOUND - The containing Step does not exist", "operationId"=>"toolresults.projects.histories.executions.steps.perfSampleSeries.create", "x-api-path-slug"=>"projectidhistorieshistoryidexecutionsexecutionidstepsstepidperfsampleseries-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"executionId", "description"=>"A tool results execution ID"}, {"in"=>"path", "name"=>"historyId", "description"=>"A tool results history ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"The cloud project"}, {"in"=>"path", "name"=>"stepId", "description"=>"A tool results step ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sample Series"]}}, "/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}"=>{"get"=>{"summary"=>"Get Sample Series", "description"=>"Gets a PerfSampleSeries.\n\nMay return any of the following error code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist", "operationId"=>"toolresults.projects.histories.executions.steps.perfSampleSeries.get", "x-api-path-slug"=>"projectidhistorieshistoryidexecutionsexecutionidstepsstepidperfsampleseriessampleseriesid-get", "parameters"=>[{"in"=>"path", "name"=>"executionId", "description"=>"A tool results execution ID"}, {"in"=>"path", "name"=>"historyId", "description"=>"A tool results history ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"The cloud project"}, {"in"=>"path", "name"=>"sampleSeriesId", "description"=>"A sample series id"}, {"in"=>"path", "name"=>"stepId", "description"=>"A tool results step ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sample Series"]}}, "/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples"=>{"get"=>{"summary"=>"Get Sample Series", "description"=>"Lists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and maximum size allowed 5000 - The response token indicates the last returned PerfSample timestamp - When the results size exceeds the page size, submit a subsequent request including the page token to return the rest of the samples up to the page limit\n\nMay return any of the following canonical error codes: - OUT_OF_RANGE - The specified request page_token is out of valid range - NOT_FOUND - The containing PerfSampleSeries does not exist", "operationId"=>"toolresults.projects.histories.executions.steps.perfSampleSeries.samples.list", "x-api-path-slug"=>"projectidhistorieshistoryidexecutionsexecutionidstepsstepidperfsampleseriessampleseriesidsamples-get", "parameters"=>[{"in"=>"path", "name"=>"executionId", "description"=>"A tool results execution ID"}, {"in"=>"path", "name"=>"historyId", "description"=>"A tool results history ID"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The default page size is 500 samples, and the maximum size is 5000"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Optional, the next_page_token returned in the previous response"}, {"in"=>"path", "name"=>"projectId", "description"=>"The cloud project"}, {"in"=>"path", "name"=>"sampleSeriesId", "description"=>"A sample series id"}, {"in"=>"path", "name"=>"stepId", "description"=>"A tool results step ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sample Series"]}}, "/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples:batchCreate"=>{"post"=>{"summary"=>"Create Sample", "description"=>"Creates a batch of PerfSamples - a client can submit multiple batches of Perf Samples through repeated calls to this method in order to split up a large request payload - duplicates and existing timestamp entries will be ignored. - the batch operation may partially succeed - the set of elements successfully inserted is returned in the response (omits items which already existed in the database).\n\nMay return any of the following canonical error codes: - NOT_FOUND - The containing PerfSampleSeries does not exist", "operationId"=>"toolresults.projects.histories.executions.steps.perfSampleSeries.samples.batchCreate", "x-api-path-slug"=>"projectidhistorieshistoryidexecutionsexecutionidstepsstepidperfsampleseriessampleseriesidsamplesbatchcreate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"executionId", "description"=>"A tool results execution ID"}, {"in"=>"path", "name"=>"historyId", "description"=>"A tool results history ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"The cloud project"}, {"in"=>"path", "name"=>"sampleSeriesId", "description"=>"A sample series id"}, {"in"=>"path", "name"=>"stepId", "description"=>"A tool results step ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sample Series"]}}, "/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails"=>{"get"=>{"summary"=>"Get Thumbnails", "description"=>"Lists thumbnails of images attached to a step.\n\nMay return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read from the project, or from any of the images - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the step does not exist, or if any of the images do not exist", "operationId"=>"toolresults.projects.histories.executions.steps.thumbnails.list", "x-api-path-slug"=>"projectidhistorieshistoryidexecutionsexecutionidstepsstepidthumbnails-get", "parameters"=>[{"in"=>"path", "name"=>"executionId", "description"=>"An Execution id"}, {"in"=>"path", "name"=>"historyId", "description"=>"A History id"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of thumbnails to fetch"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A continuation token to resume the query at the next item"}, {"in"=>"path", "name"=>"projectId", "description"=>"A Project id"}, {"in"=>"path", "name"=>"stepId", "description"=>"A Step id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thumbnail"]}}, "/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}:publishXunitXmlFiles"=>{"post"=>{"summary"=>"Publish XML Files", "description"=>"Publish xml files to an existing Step.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal, e.g try to upload a duplicate xml file or a file too large. - NOT_FOUND - if the containing Execution does not exist", "operationId"=>"toolresults.projects.histories.executions.steps.publishXunitXmlFiles", "x-api-path-slug"=>"projectidhistorieshistoryidexecutionsexecutionidstepsstepidpublishxunitxmlfiles-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"executionId", "description"=>"A Execution id"}, {"in"=>"path", "name"=>"historyId", "description"=>"A History id"}, {"in"=>"path", "name"=>"projectId", "description"=>"A Project id"}, {"in"=>"path", "name"=>"stepId", "description"=>"A Step id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["XML File"]}}, "/{projectId}/settings"=>{"get"=>{"summary"=>"Get Project Settings", "description"=>"Gets the Tool Results settings for a project.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read from project", "operationId"=>"toolresults.projects.getSettings", "x-api-path-slug"=>"projectidsettings-get", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"A Project id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project"]}}, "/{projectId}:initializeSettings"=>{"post"=>{"summary"=>"Initialize Settings", "description"=>"Creates resources for settings which have not yet been set.\n\nCurrently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in the name of the user calling. Except in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days.\n\nThe bucket is created with the project-private ACL: All project team members are given permissions to the bucket and objects created within it according to their roles. Project owners have owners rights, and so on. The default ACL on objects created in the bucket is project-private as well. See Google Cloud Storage documentation for more details.\n\nIf there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deteleted, a new bucket will be created.\n\nMay return any canonical error codes, including the following:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage", "operationId"=>"toolresults.projects.initializeSettings", "x-api-path-slug"=>"projectidinitializesettings-post", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"A Project id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project"]}}}}, "apis"=>{"name"=>"Google", "x-slug"=>"google", "description"=>"Google LLC is an American multinational technology company that specializes in Internet-related services and products, which include online advertising technologies, search engine, cloud computing, software, and hardware.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/43-google.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"1", "tags"=>"API Provider,API Service Provider,Data,Databases,internet,Mobile,New,Profiles,Real Time,Relative Data,SaaS,SDIO Competition,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Firebase", "x-api-slug"=>"firebase", "description"=>"Google LLC is an American multinational technology company that specializes in Internet-related services and products, which include online advertising technologies, search engine, cloud computing, software, and hardware.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/43-google.jpg", "humanURL"=>"https://Firebase.google.com", "baseURL"=>"https://{project_id].firebaseio.co}//", "tags"=>"API Provider,API Service Provider,Data,Databases,internet,Mobile,New,Profiles,Real Time,Relative Data,SaaS,SDIO Competition,Service API,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google/firebase-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-google-firebase", "url"=>"Hacker News Search"}, {"type"=>"x-stack-exchange-search", "url"=>"Google Firebase"}, {"type"=>"x-website", "url"=>"https://Firebase.google.com"}, {"type"=>"x-blog", "url"=>"https://firebase.googleblog.com/"}, {"type"=>"x-blog-rss", "url"=>"http://firebase.googleblog.com/feeds/posts/default?alt=rss"}, {"type"=>"x-case-studies", "url"=>"https://firebase.google.com/customers/"}, {"type"=>"x-change-log", "url"=>"https://firebase.google.com/support/releases"}, {"type"=>"x-code", "url"=>"https://firebase.google.com/docs/libraries/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/google"}, {"type"=>"x-documentation", "url"=>"https://firebase.google.com/docs/"}, {"type"=>"x-faq", "url"=>"https://firebase.google.com/support/faq/"}, {"type"=>"x-forum", "url"=>"https://groups.google.com/forum/#!forum/firebase-talk"}, {"type"=>"x-github", "url"=>"https://github.com/firebase"}, {"type"=>"x-pricing", "url"=>"https://firebase.google.com/pricing/"}, {"type"=>"x-pricing", "url"=>"https://adwords.google.com/home/pricing/"}, {"type"=>"x-slack", "url"=>"https://firebase.community/"}, {"type"=>"x-submit-bug", "url"=>"https://firebase.google.com/support/contact/bugs-features"}, {"type"=>"x-support", "url"=>"https://firebase.google.com/support/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Google"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/firebase"}, {"type"=>"x-website", "url"=>"http://google.com"}, {"type"=>"x-website", "url"=>"https://firebase.google.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
pagerduty{"pagerduty-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"PagerDuty", "x-complete"=>1, "info"=>{"title"=>"PagerDuty", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/teams/{teamId}/people"=>{"get"=>{"summary"=>"Teams Resource", "description"=>"List people and integrations associated with a given team.", "operationId"=>"list-people-and-integrations-associated-with-a-given-team", "x-api-path-slug"=>"teamsteamidpeople-get", "parameters"=>[{"in"=>"path", "name"=>"teamId", "description"=>"Unique identifier for team"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/users/{user_guid} "=>{" get "=>{"summary"=>"Users {user_guid}", "description"=>"Returns customer's user by user GUID.", "operationId"=>"", "x-api-path-slug"=>"usersuser-guid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, " delete "=>{"summary"=>"Users {user_guid}", "description"=>"DELETE users user gu", "operationId"=>"", "x-api-path-slug"=>"usersuser-guid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users "=>{" get "=>{"summary"=>"Users", "description"=>"Returns all customer's users.", "operationId"=>"", "x-api-path-slug"=>"users-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, " post "=>{"summary"=>"Users", "description"=>"Creates a new user.", "operationId"=>"", "x-api-path-slug"=>"users-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, " put "=>{"summary"=>"Users", "description"=>"Updates a user.", "operationId"=>"", "x-api-path-slug"=>"users-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/api_reference"=>{"get"=>{"summary"=>"REST API Reference", "description"=>"REST API Reference.", "operationId"=>"rest-api-reference", "x-api-path-slug"=>"api-reference-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APIs"]}}, "/abilities"=>{"get"=>{"summary"=>"List abilities", "description"=>"List all of your account's abilities, by name.", "operationId"=>"list-all-of-your-accounts-abilities-by-name", "x-api-path-slug"=>"abilities-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Abilities"]}}, "/abilities/{id}"=>{"get"=>{"summary"=>"Test an ability", "description"=>"Test whether your account has a given ability.", "operationId"=>"test-whether-your-account-has-a-given-ability", "x-api-path-slug"=>"abilitiesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Abilities"]}}, "/addons"=>{"get"=>{"summary"=>"List installed add-ons", "description"=>"List all of the add-ons installed on your account.", "operationId"=>"list-all-of-the-addons-installed-on-your-account", "x-api-path-slug"=>"addons-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filters the results, showing only add-ons of the given type"}, {"in"=>"query", "name"=>"service_ids[]", "description"=>"Filters the results, showing only add-ons for the given services"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AddOns"]}, "post"=>{"summary"=>"Install an add-on", "description"=>"Install an add-on for your account.", "operationId"=>"install-an-addon-for-your-account", "x-api-path-slug"=>"addons-post", "parameters"=>[{"in"=>"body", "name"=>"addon", "description"=>"The add-on to be installed", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AddOns"]}}, "/addons/{id}"=>{"get"=>{"summary"=>"Get an add-on", "description"=>"Get details about an existing add-on.", "operationId"=>"get-details-about-an-existing-addon", "x-api-path-slug"=>"addonsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AddOns"]}, "delete"=>{"summary"=>"Delete an add-on", "description"=>"Remove an existing add-on.", "operationId"=>"remove-an-existing-addon", "x-api-path-slug"=>"addonsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AddOns"]}, "put"=>{"summary"=>"Update an add-on", "description"=>"Update an existing add-on.", "operationId"=>"update-an-existing-addon", "x-api-path-slug"=>"addonsid-put", "parameters"=>[{"in"=>"body", "name"=>"addon", "description"=>"The add-on to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AddOns"]}}, "/escalation_policies"=>{"get"=>{"summary"=>"List escalation policies", "description"=>"List all of the existing escalation policies.", "operationId"=>"list-all-of-the-existing-escalation-policies", "x-api-path-slug"=>"escalation-policies-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"Filters the results, showing only the escalation policies whose names contain the query"}, {"in"=>"query", "name"=>"user_ids[]", "description"=>"Filters the results, showing only escalation policies on which any of the users is a target"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Escalation Policies"]}, "post"=>{"summary"=>"Create an escalation policy", "description"=>"Creates a new escalation policy. There must be at least one existing escalation rule added to create a new escalation policy.", "operationId"=>"creates-a-new-escalation-policy-there-must-be-at-least-one-existing-escalation-rule-added-to-create-", "x-api-path-slug"=>"escalation-policies-post", "parameters"=>[{"in"=>"body", "name"=>"escalation_policy", "description"=>"The escalation policy to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Escalation Policies"]}}, "/escalation_policies/{id}"=>{"get"=>{"summary"=>"Get an escalation policy", "description"=>"Get information about an existing escalation policy and its rules.", "operationId"=>"get-information-about-an-existing-escalation-policy-and-its-rules", "x-api-path-slug"=>"escalation-policiesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Escalation Policies"]}, "delete"=>{"summary"=>"Delete an escalation policy", "description"=>"Deletes an existing escalation policy and rules. The escalation policy must not be in use by any services.", "operationId"=>"deletes-an-existing-escalation-policy-and-rules-the-escalation-policy-must-not-be-in-use-by-any-serv", "x-api-path-slug"=>"escalation-policiesid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Escalation Policies"]}, "put"=>{"summary"=>"Update an escalation policy", "description"=>"Updates an existing escalation policy and rules.", "operationId"=>"updates-an-existing-escalation-policy-and-rules", "x-api-path-slug"=>"escalation-policiesid-put", "parameters"=>[{"in"=>"body", "name"=>"escalation_policy", "description"=>"The escalation policy to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Escalation Policies"]}}, "/incidents"=>{"get"=>{"summary"=>"List incidents", "description"=>"List existing incidents.", "operationId"=>"list-existing-incidents", "x-api-path-slug"=>"incidents-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Array of additional details to include"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Used to specify both the field you wish to sort the results on (incident_number/created_on/resolved_on/urgency), as well as the direction (asc/desc) of the results"}, {"in"=>"query", "name"=>"statuses[]", "description"=>"Return only incidents with the given statuses"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents"]}, "put"=>{"summary"=>"Manage incidents", "description"=>"Acknowledge, resolve, escalate or reassign one or more incidents.", "operationId"=>"acknowledge-resolve-escalate-or-reassign-one-or-more-incidents", "x-api-path-slug"=>"incidents-put", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents"]}}, "/incidents/{id}"=>{"get"=>{"summary"=>"Get an incident", "description"=>"Show detailed information about an incident. Accepts either an incident id, or an incident number.", "operationId"=>"show-detailed-information-about-an-incident-accepts-either-an-incident-id-or-an-incident-number", "x-api-path-slug"=>"incidentsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Either the id or number of the incident to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents"]}, "put"=>{"summary"=>"Update an incident", "description"=>"Acknowledge, resolve, escalate or reassign an incident.", "operationId"=>"acknowledge-resolve-escalate-or-reassign-an-incident", "x-api-path-slug"=>"incidentsid-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the incident to update"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents"]}}, "/incidents/{id}/log_entries"=>{"get"=>{"summary"=>"List log entries for the incident", "description"=>"List log entries for the specified incident.", "operationId"=>"list-log-entries-for-the-specified-incident", "x-api-path-slug"=>"incidentsidlog-entries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents Log Entries"]}}, "/incidents/{id}/notes"=>{"get"=>{"summary"=>"List existing notes for the specified incident", "description"=>"List existing notes for the specified incident.", "operationId"=>"list-existing-notes-for-the-specified-incident", "x-api-path-slug"=>"incidentsidnotes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incident Notes"]}, "post"=>{"summary"=>"Create a new note for the specified incident", "description"=>"Create a new note for the specified incident.", "operationId"=>"create-a-new-note-for-the-specified-incident", "x-api-path-slug"=>"incidentsidnotes-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incident Notes"]}}, "/incidents/{id}/snooze"=>{"post"=>{"summary"=>"Snooze an incident", "description"=>"Post incents snooze", "operationId"=>"snooze-an-incident", "x-api-path-slug"=>"incidentsidsnooze-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incident Snooze"]}}, "/log_entries"=>{"get"=>{"summary"=>"List log entries", "description"=>"List all of the incident log entries across the entire account.", "operationId"=>"list-all-of-the-incident-log-entries-across-the-entire-account", "x-api-path-slug"=>"log-entries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Log Entries"]}}, "/log_entries/{id}"=>{"get"=>{"summary"=>"Get a log entry", "description"=>"Get details for a specific incident log entry. This method provides additional information you can use to get at raw event data.", "operationId"=>"get-details-for-a-specific-incident-log-entry-this-method-provides-additional-information-you-can-us", "x-api-path-slug"=>"log-entriesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Log Entries"]}}, "/maintenance_windows"=>{"get"=>{"summary"=>"List maintenance windows", "description"=>"List existing maintenance windows, optionally filtered by service and/or team, or whether they are from the past, present or future.", "operationId"=>"list-existing-maintenance-windows-optionally-filtered-by-service-andor-team-or-whether-they-are-from", "x-api-path-slug"=>"maintenance-windows-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Only return maintenance windows in a given state"}, {"in"=>"query", "name"=>"query", "description"=>"Filters the results, showing only the maintenance windows whose descriptions contain the query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance Windows"]}, "post"=>{"summary"=>"Create a maintenance window", "description"=>"Create a new maintenance window for the specified services. No new incidents will be created for a service that is in maintenance.", "operationId"=>"create-a-new-maintenance-window-for-the-specified-services-no-new-incidents-will-be-created-for-a-se", "x-api-path-slug"=>"maintenance-windows-post", "parameters"=>[{"in"=>"body", "name"=>"maintenance_window", "description"=>"The maintenance window object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance Windows"]}}, "/maintenance_windows/{id}"=>{"get"=>{"summary"=>"Get a maintenance window", "description"=>"Get an existing maintenance window.", "operationId"=>"get-an-existing-maintenance-window", "x-api-path-slug"=>"maintenance-windowsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance Windows"]}, "delete"=>{"summary"=>"Delete or end a maintenance window", "description"=>"Delete an existing maintenance window if it's in the future, or end it if it's currently on-going. If the maintenance window has already ended it cannot be deleted.", "operationId"=>"delete-an-existing-maintenance-window-if-its-in-the-future-or-end-it-if-its-currently-ongoing-if-the", "x-api-path-slug"=>"maintenance-windowsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance Windows"]}, "put"=>{"summary"=>"Update a maintenance window", "description"=>"Update an existing maintenance window.", "operationId"=>"update-an-existing-maintenance-window", "x-api-path-slug"=>"maintenance-windowsid-put", "parameters"=>[{"in"=>"body", "name"=>"maintenance_window", "description"=>"The maintenance window to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance Windows"]}}, "/notifications"=>{"get"=>{"summary"=>"List notifications", "description"=>"List notifications for a given time range, optionally filtered by type (sms_notification, email_notification, phone_notification, or push_notification).", "operationId"=>"list-notifications-for-a-given-time-range-optionally-filtered-by-type-sms-notification-email-notific", "x-api-path-slug"=>"notifications-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Return notification of this type only"}, {"in"=>"query", "name"=>"include[]", "description"=>"Array of additional details to include"}, {"in"=>"query", "name"=>"since", "description"=>"The start of the date range over which you want to search"}, {"in"=>"query", "name"=>"until", "description"=>"The end of the date range over which you want to search"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications"]}}, "/oncalls"=>{"get"=>{"summary"=>"List all of the on-calls", "description"=>"List the on-call entries during a given time range.", "operationId"=>"list-the-oncall-entries-during-a-given-time-range", "x-api-path-slug"=>"oncalls-get", "parameters"=>[{"in"=>"query", "name"=>"earliest", "description"=>"This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned"}, {"in"=>"query", "name"=>"escalation_policy_ids[]", "description"=>"Filters the results, showing only on-calls for the specified escalation policy IDs"}, {"in"=>"query", "name"=>"include[]", "description"=>"Array of additional details to include"}, {"in"=>"query", "name"=>"schedule_ids[]", "description"=>"Filters the results, showing only on-calls for the specified schedule IDs"}, {"in"=>"query", "name"=>"since", "description"=>"The start of the time range over which you want to search"}, {"in"=>"query", "name"=>"until", "description"=>"The end of the time range over which you want to search"}, {"in"=>"query", "name"=>"user_ids[]", "description"=>"Filters the results, showing only on-calls for the specified user IDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Oncalls"]}}, "/services"=>{"get"=>{"summary"=>"List services", "description"=>"List existing services.", "operationId"=>"list-existing-services", "x-api-path-slug"=>"services-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Array of additional details to include"}, {"in"=>"query", "name"=>"query", "description"=>"Filters the result, showing only the services whose name or service_key matches the query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}, "post"=>{"summary"=>"Create a service", "description"=>"Create a new service.", "operationId"=>"create-a-new-service", "x-api-path-slug"=>"services-post", "parameters"=>[{"in"=>"body", "name"=>"service", "description"=>"The service to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/services/{id}"=>{"get"=>{"summary"=>"Get a service", "description"=>"Get details about an existing service.", "operationId"=>"get-details-about-an-existing-service", "x-api-path-slug"=>"servicesid-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Array of additional details to include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}, "delete"=>{"summary"=>"Delete a service", "description"=>"Delete an existing service. Once the service is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this service.", "operationId"=>"delete-an-existing-service-once-the-service-is-deleted-it-will-not-be-accessible-from-the-web-ui-and", "x-api-path-slug"=>"servicesid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}, "put"=>{"summary"=>"Update a service", "description"=>"Update an existing service.", "operationId"=>"update-an-existing-service", "x-api-path-slug"=>"servicesid-put", "parameters"=>[{"in"=>"body", "name"=>"service", "description"=>"The service to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/services/{id}/integrations"=>{"post"=>{"summary"=>"Create a new integration", "description"=>"Create a new integration belonging to a service.", "operationId"=>"create-a-new-integration-belonging-to-a-service", "x-api-path-slug"=>"servicesidintegrations-post", "parameters"=>[{"in"=>"body", "name"=>"integration", "description"=>"The integration to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Integrations"]}}, "/services/{id}/integrations/{integration_id}"=>{"put"=>{"summary"=>"Update an existing integration", "description"=>"Update an integration belonging to a service.", "operationId"=>"update-an-integration-belonging-to-a-service", "x-api-path-slug"=>"servicesidintegrationsintegration-id-put", "parameters"=>[{"in"=>"body", "name"=>"integration", "description"=>"The integration to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Integrations"]}, "get"=>{"summary"=>"View an integration", "description"=>"Get details about an integration belonging to a service.", "operationId"=>"get-details-about-an-integration-belonging-to-a-service", "x-api-path-slug"=>"servicesidintegrationsintegration-id-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Array of additional details to include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Integrations"]}}, "/teams"=>{"post"=>{"summary"=>"Create a team", "description"=>"Create a new team.", "operationId"=>"create-a-new-team", "x-api-path-slug"=>"teams-post", "parameters"=>[{"in"=>"body", "name"=>"team", "description"=>"The team to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams"]}, "get"=>{"summary"=>"List teams", "description"=>"List teams of your PagerDuty account, optionally filtered by a search query.", "operationId"=>"list-teams-of-your-pagerduty-account-optionally-filtered-by-a-search-query", "x-api-path-slug"=>"teams-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"Filters the result, showing only the teams whose names or email addresses match the query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams"]}}, "/teams/{id}"=>{"get"=>{"summary"=>"Get a team", "description"=>"Get details about an existing team.", "operationId"=>"get-details-about-an-existing-team", "x-api-path-slug"=>"teamsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams"]}, "delete"=>{"summary"=>"Delete a team", "description"=>"Remove an existing team.", "operationId"=>"remove-an-existing-team", "x-api-path-slug"=>"teamsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams"]}, "put"=>{"summary"=>"Update a team", "description"=>"Update an existing team.", "operationId"=>"update-an-existing-team", "x-api-path-slug"=>"teamsid-put", "parameters"=>[{"in"=>"body", "name"=>"team", "description"=>"The team to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams"]}}, "/teams/{id}/escalation_policies/{escalation_policy_id}"=>{"delete"=>{"summary"=>"Remove an escalation policy from a team", "description"=>"Delete teams escalation policies escalation policy", "operationId"=>"remove-an-escalation-policy-from-a-team", "x-api-path-slug"=>"teamsidescalation-policiesescalation-policy-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team Escalation Policies"]}, "put"=>{"summary"=>"Add an escalation policy to a team", "description"=>"Put teams escalation policies escalation policy", "operationId"=>"add-an-escalation-policy-to-a-team", "x-api-path-slug"=>"teamsidescalation-policiesescalation-policy-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team Escalation Policies"]}}, "/teams/{id}/users/{user_id}"=>{"delete"=>{"summary"=>"Remove a user from a team", "description"=>"Remove a user from a team.", "operationId"=>"remove-a-user-from-a-team", "x-api-path-slug"=>"teamsidusersuser-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team Users"]}, "put"=>{"summary"=>"Add a user to a team", "description"=>"Add a user to a team.", "operationId"=>"add-a-user-to-a-team", "x-api-path-slug"=>"teamsidusersuser-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team Users"]}}, "/users"=>{"get"=>{"summary"=>"List users", "description"=>"List users of your PagerDuty account, optionally filtered by a search query.", "operationId"=>"list-users-of-your-pagerduty-account-optionally-filtered-by-a-search-query", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"Filters the result, showing only the users whose names or email addresses match the query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "post"=>{"summary"=>"Create a user", "description"=>"Create a new user. Note that you must also supply a `password` property to create a user--it will not be returned by any API.", "operationId"=>"create-a-new-user-note-that-you-must-also-supply-a-password-property-to-create-a-userit-will-not-be-", "x-api-path-slug"=>"users-post", "parameters"=>[{"in"=>"body", "name"=>"user", "description"=>"The user to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/{id}"=>{"get"=>{"summary"=>"Get a user", "description"=>"Get details about an existing user.", "operationId"=>"get-details-about-an-existing-user", "x-api-path-slug"=>"usersid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "delete"=>{"summary"=>"Delete a user", "description"=>"Remove an existing user.", "operationId"=>"remove-an-existing-user", "x-api-path-slug"=>"usersid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "put"=>{"summary"=>"Update a user", "description"=>"Update an existing user. Note that you may also supply a `password` property--it will not be returned by any API.", "operationId"=>"update-an-existing-user-note-that-you-may-also-supply-a-password-propertyit-will-not-be-returned-by-", "x-api-path-slug"=>"usersid-put", "parameters"=>[{"in"=>"body", "name"=>"user", "description"=>"The user to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/{id}/contact_methods"=>{"get"=>{"summary"=>"List a user's contact methods", "description"=>"List contact methods of your PagerDuty user.", "operationId"=>"list-contact-methods-of-your-pagerduty-user", "x-api-path-slug"=>"usersidcontact-methods-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Contact Methods"]}, "post"=>{"summary"=>"Create a user contact method", "description"=>"Create a new contact method.", "operationId"=>"create-a-new-contact-method", "x-api-path-slug"=>"usersidcontact-methods-post", "parameters"=>[{"in"=>"body", "name"=>"contact_method", "description"=>"The contact method to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Contact Methods"]}}, "/users/{id}/contact_methods/{contact_method_id}"=>{"get"=>{"summary"=>"Get a user's contact method", "description"=>"Get details about a user's contact method.", "operationId"=>"get-details-about-a-users-contact-method", "x-api-path-slug"=>"usersidcontact-methodscontact-method-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Contact Methods"]}, "delete"=>{"summary"=>"Delete a user's contact method", "description"=>"Delete users contact methods contact method", "operationId"=>"remove-a-users-contact-method", "x-api-path-slug"=>"usersidcontact-methodscontact-method-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Contact Methods"]}, "put"=>{"summary"=>"Update a user's contact method", "description"=>"Put users contact methods contact method", "operationId"=>"update-a-users-contact-method", "x-api-path-slug"=>"usersidcontact-methodscontact-method-id-put", "parameters"=>[{"in"=>"body", "name"=>"user", "description"=>"The users contact method to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Contact Methods"]}}, "/users/{id}/notification_rules"=>{"get"=>{"summary"=>"List a user's notification rules", "description"=>"List notification rules of your PagerDuty user.", "operationId"=>"list-notification-rules-of-your-pagerduty-user", "x-api-path-slug"=>"usersidnotification-rules-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Array of additional details to include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Notification Rules"]}, "post"=>{"summary"=>"Create a user notification rule", "description"=>"Create a new notification rule.", "operationId"=>"create-a-new-notification-rule", "x-api-path-slug"=>"usersidnotification-rules-post", "parameters"=>[{"in"=>"body", "name"=>"notification_rule", "description"=>"The notification rule to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Notification Rules"]}}, "/users/{id}/notification_rules/{notification_rule_id}"=>{"get"=>{"summary"=>"Get a user's notification rule", "description"=>"Get users notification rules notification rule", "operationId"=>"get-details-about-a-users-notification-rule", "x-api-path-slug"=>"usersidnotification-rulesnotification-rule-id-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Array of additional details to include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Notification Rules"]}, "delete"=>{"summary"=>"Delete a user's notification rule", "description"=>"Delete users notification rules notification rule", "operationId"=>"remove-a-users-notification-rule", "x-api-path-slug"=>"usersidnotification-rulesnotification-rule-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Notification Rules"]}, "put"=>{"summary"=>"Update a user's notification rule", "description"=>"Put users notification rules notification rule", "operationId"=>"update-a-users-notification-rule", "x-api-path-slug"=>"usersidnotification-rulesnotification-rule-id-put", "parameters"=>[{"in"=>"body", "name"=>"notification_rule", "description"=>"The users notification rule to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Notification Rules"]}}, "/vendors"=>{"get"=>{"summary"=>"List vendors", "description"=>"List all vendors.", "operationId"=>"list-all-vendors", "x-api-path-slug"=>"vendors-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vendors"]}}, "/vendors/{id}"=>{"get"=>{"summary"=>"Get a vendor", "description"=>"Get details about one specific vendor.", "operationId"=>"get-details-about-one-specific-vendor", "x-api-path-slug"=>"vendorsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vendors"]}}, "/inventory/services"=>{""=>{"summary"=>"Creating a service", "description"=>"inventory services", "operationId"=>"creating-a-service", "x-api-path-slug"=>"inventoryservices-", "parameters"=>[{"in"=>"body", "name"=>"auth", "description"=>"Basic HTTP auth username and password", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"body", "description"=>"HTTP Check - Content of the HTTP requestbody", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"checkLocations", "description"=>"A JSON list of locations to check from e", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"checkMethod", "description"=>"HTTP Check - The HTTP method used to issue the check: either GET, POST, PUT or DELETE", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"checkType", "description"=>"The type of check: either http or tcp", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"checkUrl", "description"=>"HTTP Check - The URL to issue the request to", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"data", "description"=>"TCP Check - The content to send when opening the TCP socket", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"group", "description"=>"The group the service belongs to", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"headers", "description"=>"HTTP Check - headers to include e", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"host", "description"=>"TCP Check - The hostname or IP address to issue the TCP check to", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"name", "description"=>"The display name for the service", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"port", "description"=>"TCP Check - The port number to issue the TCP check to", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"slowThreshold", "description"=>"HTTP Check - Request time millisecond threshold after which service is deemed slow", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"tags", "description"=>"A JSON list of tag IDs", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"timeout", "description"=>"How many seconds to wait until timing out", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"token", "description"=>"Your API token", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"body", "name"=>"validateCert", "description"=>"HTTP Check - Whether to validate the SSL certificate or not", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/inventory/services/serviceId"=>{""=>{"summary"=>"Updating a service", "description"=>"inventory services service", "operationId"=>"updating-a-service", "x-api-path-slug"=>"inventoryservicesserviceid-", "parameters"=>[{"in"=>"path", "name"=>"auth", "description"=>"Basic HTTP auth username and password", "type"=>"string"}, {"in"=>"body", "name"=>"auth", "description"=>"Basic HTTP auth username and password", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"body", "description"=>"HTTP Check - Content of the HTTP request body", "type"=>"string"}, {"in"=>"body", "name"=>"body", "description"=>"HTTP Check - Content of the HTTP request body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"checkLocations", "description"=>"A JSON list of locations to check from e", "type"=>"string"}, {"in"=>"body", "name"=>"checkLocations", "description"=>"A JSON list of locations to check from e", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"checkMethod", "description"=>"HTTP Check - The HTTP method used to issue the check: either GET or POST", "type"=>"string"}, {"in"=>"body", "name"=>"checkMethod", "description"=>"HTTP Check - The HTTP method used to issue the check: either GET or POST", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"checkType", "description"=>"The type of check: either http or tcp", "type"=>"string"}, {"in"=>"body", "name"=>"checkType", "description"=>"The type of check: either http or tcp", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"checkUrl", "description"=>"HTTP Check - The URL to issue the request to", "type"=>"string"}, {"in"=>"body", "name"=>"checkUrl", "description"=>"HTTP Check - The URL to issue the request to", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"data", "description"=>"TCP Check - The content to send when opening the TCP socket", "type"=>"string"}, {"in"=>"body", "name"=>"data", "description"=>"TCP Check - The content to send when opening the TCP socket", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"group", "description"=>"The group the service belongs to", "type"=>"string"}, {"in"=>"body", "name"=>"group", "description"=>"The group the service belongs to", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"headers", "description"=>"HTTP headers to include e", "type"=>"string"}, {"in"=>"body", "name"=>"headers", "description"=>"HTTP headers to include e", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"host", "description"=>"TCP Check - The hostname or IP address to issue the TCP check to", "type"=>"string"}, {"in"=>"body", "name"=>"host", "description"=>"TCP Check - The hostname or IP address to issue the TCP check to", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The display name for the service", "type"=>"string"}, {"in"=>"body", "name"=>"name", "description"=>"The display name for the service", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"port", "description"=>"TCP Check - The port number to issue the TCP check to", "type"=>"string"}, {"in"=>"body", "name"=>"port", "description"=>"TCP Check - The port number to issue the TCP check to", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"serviceId", "description"=>"The ID of your service", "type"=>"string"}, {"in"=>"path", "name"=>"slowThreshold", "description"=>"HTTP Check - Request time millisecond threshold after which service is deemed slow", "type"=>"string"}, {"in"=>"body", "name"=>"slowThreshold", "description"=>"HTTP Check - Request time millisecond threshold after which service is deemed slow", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tags", "description"=>"A JSON list of tag IDs", "type"=>"string"}, {"in"=>"body", "name"=>"tags", "description"=>"A JSON list of tag IDs", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"timeout", "description"=>"How many seconds to wait until timing out", "type"=>"string"}, {"in"=>"body", "name"=>"timeout", "description"=>"How many seconds to wait until timing out", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"body", "name"=>"token", "description"=>"Your API token", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"validateCert", "description"=>"Whether to validate the SSL certificate or not", "type"=>"string"}, {"in"=>"body", "name"=>"validateCert", "description"=>"Whether to validate the SSL certificate or not", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/inventory/services/groups/?token=token"=>{""=>{"summary"=>"Listing service groups", "description"=>"inventory services groups token token", "operationId"=>"listing-service-groups", "x-api-path-slug"=>"inventoryservicesgroupstokentoken-", "parameters"=>[{"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/notifications/recipients"=>{"get"=>{"summary"=>"Creating a recipient", "description"=>"Create recipients for your alert notifications", "operationId"=>"creating-a-recipient", "x-api-path-slug"=>"notificationsrecipients-get", "parameters"=>[{"in"=>"body", "name"=>"channel", "description"=>"Channel name for chat integrations", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"name", "description"=>"The name of your notification integration", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"token", "description"=>"Your integration API token", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"type", "description"=>"The type of notification integration", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"url", "description"=>"URL for webhook integrations", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}}, "/users/users/userId"=>{""=>{"summary"=>"Deleting a user", "description"=>"users users user", "operationId"=>"deleting-a-user", "x-api-path-slug"=>"usersusersuserid-", "parameters"=>[{"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"body", "name"=>"token", "description"=>"Your API token", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}}}, "apis"=>{"name"=>"PagerDuty", "x-slug"=>"pagerduty", "description"=>"See how PagerDuty Digital Operations Management Platform integrates machine data & human intelligence to improve visibility & agility across organizations.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/632-pagerduty.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"18918", "tags"=>"Enterprise,Incident,Monitoring,Notifications,Relative Data,Relative StreamRank,SaaS,Service API,Stack Network,Streams,Streams,Streams,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"pagerduty/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"PagerDuty", "x-api-slug"=>"pagerduty", "description"=>"See how PagerDuty Digital Operations Management Platform integrates machine data & human intelligence to improve visibility & agility across organizations.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/632-pagerduty.jpg", "humanURL"=>"http://www.pagerduty.com/", "baseURL"=>"https:///", "tags"=>"Enterprise,Incident,Monitoring,Notifications,Relative Data,Relative StreamRank,SaaS,Service API,Stack Network,Streams,Streams,Streams,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/pagerduty/pagerduty-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://www.pagerduty.com/"}, {"type"=>"x-base", "url"=>"https://acme.pagerduty.com/api/"}, {"type"=>"x-blog", "url"=>"http://blog.pagerduty.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.pagerduty.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/pagerduty"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/pagerduty"}, {"type"=>"x-developer", "url"=>"http://developer.pagerduty.com/"}, {"type"=>"x-email", "url"=>"info@pagerduty.com"}, {"type"=>"x-email", "url"=>"sales@pagerduty.com"}, {"type"=>"x-email", "url"=>"support@pagerduty.com"}, {"type"=>"x-email", "url"=>"legal@pagerduty.com"}, {"type"=>"x-email", "url"=>"privacy@pagerduty.com"}, {"type"=>"x-github", "url"=>"https://github.com/PagerDuty"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/pagerduty"}, {"type"=>"x-openapi-spec--authoritative", "url"=>"https://api-reference.pagerduty.com/output.json"}, {"type"=>"x-pricing", "url"=>"https://www.pagerduty.com/pricing/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/pagerduty"}, {"type"=>"x-webhook", "url"=>"https://support.pagerduty.com/docs/webhooks"}, {"type"=>"x-website", "url"=>"http://www.pagerduty.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
halifax-bank{"halifax-bank-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Halifax Bank", "x-complete"=>1, "info"=>{"title"=>"Halifax Bank", "description"=>"this-is-an-openapi-definition-for-the-standard-set-of-open-banking-httpopenbankingapis-io-apis-for-halifax-bank-", "termsOfService"=>"https://www.openbanking.org.uk/open-licence/", "contact"=>{"name"=>"API Evangelist", "url"=>"https://apievangelist.com", "email"=>"info@apievangelist.com"}, "version"=>"1.0.0"}, "host"=>"api.halifax.co.uk", "basePath"=>"open-banking/v2.1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"atms/"=>{"get"=>{"summary"=>"Get ATMs", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can provide multiple ATMs.", "operationId"=>"getATMS", "x-api-path-slug"=>"atms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Atms"]}}, "branches/"=>{"get"=>{"summary"=>"Get Branches", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple branches.", "operationId"=>"getBranches", "x-api-path-slug"=>"branches-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branches"]}}, "personal-current-accounts/"=>{"get"=>{"summary"=>"Get Current Personal Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple PCA products.", "operationId"=>"getCurrentPersonalAccounts", "x-api-path-slug"=>"personalcurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Personal", "Current", "Accounts"]}}}}, "apis"=>{"name"=>"Halifax Bank", "x-slug"=>"halifax-bank", "description"=>"Halifax is a British bank operating as a trading division of Bank of Scotland, itself a wholly owned subsidiary of Lloyds Banking Group. It is named after the town of Halifax, West Yorkshire where it was founded as a building society in 1853", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Halifax_Logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Provider,ATMs,Banking,General Data,Profiles,Relative Data,UK Banks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"halifax-bank/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Halifax Bank", "x-api-slug"=>"halifax-bank", "description"=>"Halifax is a British bank operating as a trading division of Bank of Scotland, itself a wholly owned subsidiary of Lloyds Banking Group. It is named after the town of Halifax, West Yorkshire where it was founded as a building society in 1853", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Halifax_Logo.png", "humanURL"=>"https://www.halifax.co.uk/", "baseURL"=>"https://api.halifax.co.uk/open-banking/v2.1/", "tags"=>"API Provider,ATMs,Banking,General Data,Profiles,Relative Data,UK Banks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/halifax-bank/personalcurrentaccounts-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/halifax-bank/halifax-bank-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"http://openbankingapis.io/uk/halifax"}, {"type"=>"x-documentation", "url"=>"https://openbanking.atlassian.net/wiki/spaces/DZ/pages/54919225/Open+Data+API+Dashboard#"}, {"type"=>"x-website", "url"=>"https://www.halifax.co.uk/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bigoven{"big-oven-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"BigOven", "x-complete"=>1, "info"=>{"title"=>"Big Oven", "description"=>"documentationthis-is-the-documentation-for-the-partner-endpoint-of-the-bigoven-recipe-and-grocery-list-api-the-update-brings-with-it-swaggerbased-documentation--swaggerhttpswagger-io-is-an-emerging-standard-for-describing-restbased-apis-and-with-this-swaggercompliant-endpoint-above-you-can-make-readytogo-interface-libraries-for-your-code-via-swaggercodegenhttpsgithub-comswaggerapiswaggercodegen--for-instance-its-easy-to-generate-libraries-for-node-js-java-ruby-asp-net-mvc-jquery-php-and-moreyou-can-also-try-out-the-endpoint-calls-with-your-own-api-key-right-here-on-this-page--be-sure-to-enter-your-api-key-above-to-use-the-try-it-out-buttons-on-this-page-start-heredevelopers-new-to-the-bigoven-api-should-start-with-this-version-not-with-the-legacy-api--well-be-making-improvements-to-this-api-over-time-and-doing-only-bug-fixes-on-the-v1-api-to-pretend-youre-a-bigoven-user-for-instance-to-get-your-recently-viewed-recipes-or-your-grocery-list-you-need-to-pass-in-basic-authentication-information-in-the-header-just-as-with-the-v1-api--we-do-now-require-that-you-make-all-calls-via-https--you-need-to-pass-your-api-key-in-with-every-call-though-this-can-now-be-done-on-the-header-send-a-request-header-xbigovenapikey-set-to-your-api-key-value-e-g--requestxbigovenapikeyyourkeyhere-migration-notesfor-existing-partners-we-encourage-you-to-migratehttpapi2-bigoven-com-and-while-at-this-writing-we-have-no-hardandfast-termination-date-for-the-v1-api-we-strongly-prefer-that-you-migrate-by-january-1-2017--while-the-changes-arent-overly-complex-there-are-several-breaking-changes-including-refactoring-of-recipe-search-and-results-and-removal-of-support-for-xml--this-is-not-a-simply-plugandplay-replacement-to-the-v1-api--with-respect-to-an-exclusive-focus-on-json-the-world-has-spoken-and-it-prefers-json-for-restbased-apis--weve-taken-numerous-steps-to-refactor-the-api-to-make-it-more-restcompliant--note-that-this-v2-api-will-be-the-preferred-api-from-this-point-onward-so-we-encourage-developers-to-migrate-to-this-new-format--we-have-put-together-some-migration-noteswebdocumentationmigrationtov2-that-we-encourage-you-to-read-carefully-photossee-our-photos-documentationhttpapi2-bigoven-comwebdocumentationrecipeimages--for-more-information-on-usage-of-this-api-including-features-pricing-rate-limits-terms-and-conditions-please-visit-the-bigoven-api-websitehttpapi2-bigoven-com-", "termsOfService"=>"Please see our [terms of service](http://api2.bigoven.com/web/documentation/termsofuse", "version"=>"partner"}, "host"=>"api2.bigoven.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/collection/{id}"=>{"get"=>{"summary"=>"Gets a recipe collection. A recipe collection is a curated set of recipes.", "description"=>"Gets a recipe collection. a recipe collection is a curated set of recipes..", "operationId"=>"Collection_GetCollection", "x-api-path-slug"=>"collectionid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"the collection identifier"}, {"in"=>"query", "name"=>"pg", "description"=>"page number (starting with 1)"}, {"in"=>"query", "name"=>"rpp", "description"=>"results per page"}, {"in"=>"query", "name"=>"sessionForLogging"}, {"in"=>"query", "name"=>"test"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Collection"]}}, "/collection/{id}/meta"=>{"get"=>{"summary"=>"Gets a recipe collection metadata. A recipe collection is a curated set of recipes.", "description"=>"Gets a recipe collection metadata. a recipe collection is a curated set of recipes..", "operationId"=>"Collection_GetCollectionMeta", "x-api-path-slug"=>"collectionidmeta-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"the collection identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Collection", "Meta"]}}, "/collections"=>{"get"=>{"summary"=>"Get the list of current, seasonal recipe collections. From here, you can use the /collection/{id} endpoint to retrieve the recipes in those collections.", "description"=>"Get the list of current, seasonal recipe collections. from here, you can use the /collection/{id} endpoint to retrieve the recipes in those collections..", "operationId"=>"Collection_Collections", "x-api-path-slug"=>"collections-get", "parameters"=>[{"in"=>"query", "name"=>"test"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Collections"]}}, "/glossary/byterm/{term}"=>{"get"=>{"summary"=>"Get food glossary article by term (e.g., asparagus). This editorial is (c) BigOven and MUST carry attribution and a link back to the glossary entry on BigOven.com.", "description"=>"Get food glossary article by term (e.g., asparagus). this editorial is (c) bigoven and must carry attribution and a link back to the glossary entry on bigoven.com..", "operationId"=>"Glossary_ByTerm", "x-api-path-slug"=>"glossarybytermterm-get", "parameters"=>[{"in"=>"path", "name"=>"term", "description"=>"Keyword used to look up article, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Glossary", "Byterm", "Term"]}}, "/glossary/{id}"=>{"get"=>{"summary"=>"Get food glossary article", "description"=>"Get food glossary article.", "operationId"=>"Glossary_Get", "x-api-path-slug"=>"glossaryid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"identifier of article to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Glossary"]}}, "/grocerylist"=>{"delete"=>{"summary"=>"Delete all the items on a grocery list; faster operation than a sync with deleted items.", "description"=>"Delete all the items on a grocery list; faster operation than a sync with deleted items..", "operationId"=>"GroceryList_Delete", "x-api-path-slug"=>"grocerylist-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Grocerylist"]}, "get"=>{"summary"=>"Get the user's grocery list. User is determined by Basic Authentication.", "description"=>"Get the user's grocery list. user is determined by basic authentication..", "operationId"=>"GroceryList_Get", "x-api-path-slug"=>"grocerylist-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Grocerylist"]}}, "/grocerylist/department"=>{"post"=>{"summary"=>"Departmentalize a list of strings -- used for ad-hoc grocery list item addition", "description"=>"Departmentalize a list of strings -- used for ad-hoc grocery list item addition.", "operationId"=>"GroceryList_Department", "x-api-path-slug"=>"grocerylistdepartment-post", "parameters"=>[{"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Grocerylist", "Department"]}}, "/grocerylist/item"=>{"post"=>{"summary"=>"Add a single line item to the grocery list", "description"=>"Add a single line item to the grocery list.", "operationId"=>"GroceryList_Post", "x-api-path-slug"=>"grocerylistitem-post", "parameters"=>[{"in"=>"body", "name"=>"newItem", "description"=>"name, quantity, unit, notes, department", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Grocerylist", "Item"]}}, "/grocerylist/item/{guid}"=>{"delete"=>{"summary"=>"/grocerylist/item/{guid} DELETE will delete this item assuming you own it.", "description"=>"/grocerylist/item/{guid} delete will delete this item assuming you own it..", "operationId"=>"GroceryList_DeleteItemByGuid", "x-api-path-slug"=>"grocerylistitemguid-delete", "parameters"=>[{"in"=>"path", "name"=>"guid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Grocerylist", "Item", "Guid"]}, "put"=>{"summary"=>"Update a grocery item by GUID", "description"=>"Update a grocery item by guid.", "operationId"=>"GroceryList_GroceryListItemGuid", "x-api-path-slug"=>"grocerylistitemguid-put", "parameters"=>[{"in"=>"path", "name"=>"guid"}, {"in"=>"body", "name"=>"req", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Grocerylist", "Item", "Guid"]}}, "/grocerylist/recipe"=>{"post"=>{"summary"=>"Add a Recipe to the grocery list. In the request data, pass in recipeId, scale (scale=1.0 says to keep the recipe the same size as originally posted), markAsPending (true/false) to indicate that\r\n the lines in the recipe should be marked", "description"=>"Add a recipe to the grocery list. in the request data, pass in recipeid, scale (scale=1.0 says to keep the recipe the same size as originally posted), markaspending (true/false) to indicate that\r\n the lines in the recipe should be marked .", "operationId"=>"GroceryList_AddRecipe", "x-api-path-slug"=>"grocerylistrecipe-post", "parameters"=>[{"in"=>"body", "name"=>"data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Grocerylist", "Recipe"]}}, "/grocerylist/sync"=>{"post"=>{"summary"=>"Synchronize the grocery list. Call this with a POST to /grocerylist/sync", "description"=>"Synchronize the grocery list. call this with a post to /grocerylist/sync.", "operationId"=>"GroceryList_PostGroceryListSync", "x-api-path-slug"=>"grocerylistsync-post", "parameters"=>[{"in"=>"body", "name"=>"req", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Grocerylist", "Sync"]}}, "/recipe"=>{"post"=>{"summary"=>"Add a new recipe", "description"=>"Add a new recipe.", "operationId"=>"Recipe_Post", "x-api-path-slug"=>"recipe-post", "parameters"=>[{"in"=>"body", "name"=>"recipe", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe"]}, "put"=>{"summary"=>"Update a recipe", "description"=>"Update a recipe.", "operationId"=>"Recipe_Put", "x-api-path-slug"=>"recipe-put", "parameters"=>[{"in"=>"body", "name"=>"recipe", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe"]}}, "/recipe/autocomplete"=>{"get"=>{"summary"=>"Given a query, return recipe titles starting with query. Query must be at least 3 chars in length.", "description"=>"Given a query, return recipe titles starting with query. query must be at least 3 chars in length..", "operationId"=>"Recipe_AutoComplete", "x-api-path-slug"=>"recipeautocomplete-get", "parameters"=>[{"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "Autocomplete"]}}, "/recipe/categories"=>{"get"=>{"summary"=>"Get a list of recipe categories (the ID field can be used for include_cat in search parameters)", "description"=>"Get a list of recipe categories (the id field can be used for include_cat in search parameters).", "operationId"=>"Recipe_Categories", "x-api-path-slug"=>"recipecategories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "Categories"]}}, "/recipe/review/replies/{replyId}"=>{"delete"=>{"summary"=>"DELETE a reply to a given review. Authenticated user must be the one who originally posted the reply.", "description"=>"Delete a reply to a given review. authenticated user must be the one who originally posted the reply..", "operationId"=>"Review_DeleteReply", "x-api-path-slug"=>"recipereviewrepliesreplyid-delete", "parameters"=>[{"in"=>"path", "name"=>"replyId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "Review", "Replies", "ReplyId"]}, "put"=>{"summary"=>"Update (PUT) a reply to a given review. Authenticated user must be the original one that posted the reply.", "description"=>"Update (put) a reply to a given review. authenticated user must be the original one that posted the reply..", "operationId"=>"Review_PutReply", "x-api-path-slug"=>"recipereviewrepliesreplyid-put", "parameters"=>[{"in"=>"body", "name"=>"data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"replyId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "Review", "Replies", "ReplyId"]}}, "/recipe/review/{reviewId}"=>{"get"=>{"summary"=>"Get a given review by string-style ID. This will return a payload with FeaturedReply, ReplyCount.\r\n Recommended display is to list top-level reviews with one featured reply underneath. \r\n Currently, the FeaturedReply is the most", "description"=>"Get a given review by string-style id. this will return a payload with featuredreply, replycount.\r\n recommended display is to list top-level reviews with one featured reply underneath. \r\n currently, the featuredreply is the most.", "operationId"=>"", "x-api-path-slug"=>"recipereviewreviewid-get", "parameters"=>[{"in"=>"path", "name"=>"reviewId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "Review", "ReviewId"]}, "put"=>{"summary"=>"Update a given top-level review.", "description"=>"Update a given top-level review..", "operationId"=>"Review_Put", "x-api-path-slug"=>"recipereviewreviewid-put", "parameters"=>[{"in"=>"body", "name"=>"review", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"reviewId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "Review", "ReviewId"]}}, "/recipe/review/{reviewId}/replies"=>{"get"=>{"summary"=>"Get a paged list of replies for a given review.", "description"=>"Get a paged list of replies for a given review..", "operationId"=>"Review_GetReplies", "x-api-path-slug"=>"recipereviewreviewidreplies-get", "parameters"=>[{"in"=>"query", "name"=>"pg", "description"=>"the page (int), starting with 1"}, {"in"=>"path", "name"=>"reviewId"}, {"in"=>"query", "name"=>"rpp", "description"=>"results per page (int)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "Review", "ReviewId", "Replies"]}, "post"=>{"summary"=>"POST a reply to a given review. The date will be set by server. Note that replies no longer have star ratings, only top-level reviews do.", "description"=>"Post a reply to a given review. the date will be set by server. note that replies no longer have star ratings, only top-level reviews do..", "operationId"=>"Review_PostReply", "x-api-path-slug"=>"recipereviewreviewidreplies-post", "parameters"=>[{"in"=>"body", "name"=>"data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"reviewId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "Review", "ReviewId", "Replies"]}}, "/recipe/scan"=>{"post"=>{"summary"=>"POST an image as a new RecipeScan request\r\n 1) Fetch the filename -- DONE\r\n 2) Copy it to the pics/scan folder - ENSURE NO NAMING COLLISIONS -- DONE\r\n 3) Create 120 thumbnail size in pics/scan/120 -- D", "description"=>"Post an image as a new recipescan request\r\n 1) fetch the filename -- done\r\n 2) copy it to the pics/scan folder - ensure no naming collisions -- done\r\n 3) create 120 thumbnail size in pics/scan/120 -- d.", "operationId"=>"Recipe_Scan", "x-api-path-slug"=>"recipescan-post", "parameters"=>[{"in"=>"query", "name"=>"devicetype"}, {"in"=>"query", "name"=>"lat"}, {"in"=>"query", "name"=>"lng"}, {"in"=>"query", "name"=>"test"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "Scan"]}}, "/recipe/{id}"=>{"delete"=>{"summary"=>"Delete a Recipe (you must be authenticated as an owner of the recipe)", "description"=>"Delete a recipe (you must be authenticated as an owner of the recipe).", "operationId"=>"Recipe_Delete", "x-api-path-slug"=>"recipeid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe"]}, "get"=>{"summary"=>"Return full Recipe detail. Returns 403 if the recipe is owned by someone else.", "description"=>"Return full recipe detail. returns 403 if the recipe is owned by someone else..", "operationId"=>"Recipe_Get", "x-api-path-slug"=>"recipeid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"the Recipe ID to retrieve"}, {"in"=>"query", "name"=>"prefetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe"]}}, "/recipe/{recipeId}/feedback"=>{"post"=>{"summary"=>"Feedback on a Recipe -- for internal BigOven editors", "description"=>"Feedback on a recipe -- for internal bigoven editors.", "operationId"=>"Recipe_Feedback", "x-api-path-slug"=>"reciperecipeidfeedback-post", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"The payload for feedback, which includes the field feedback", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"recipeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Feedback"]}}, "/recipe/{recipeId}/image"=>{"post"=>{"summary"=>"POST: /recipe/{recipeId}/image?lat=42&lng=21&caption=this%20is%20my%20caption\r\n \r\n Note that caption, lng and lat are all optional, but must go on the request URI as params because this endpoint\r\n needs a m", "description"=>"Post: /recipe/{recipeid}/image?lat=42&lng=21&caption=this%20is%20my%20caption\r\n \r\n note that caption, lng and lat are all optional, but must go on the request uri as params because this endpoint\r\n needs a m.", "operationId"=>"Images_UploadRecipeImage", "x-api-path-slug"=>"reciperecipeidimage-post", "parameters"=>[{"in"=>"query", "name"=>"caption"}, {"in"=>"query", "name"=>"lat"}, {"in"=>"query", "name"=>"lng"}, {"in"=>"path", "name"=>"recipeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Image"]}}, "/recipe/{recipeId}/images"=>{"get"=>{"summary"=>"Get all the images for a recipe. DEPRECATED. Please use /recipe/{recipeId}/photos.", "description"=>"Get all the images for a recipe. deprecated. please use /recipe/{recipeid}/photos..", "operationId"=>"Images_Get", "x-api-path-slug"=>"reciperecipeidimages-get", "parameters"=>[{"in"=>"path", "name"=>"recipeId", "description"=>"Recipe ID (required)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Images"]}}, "/recipe/{recipeId}/note"=>{"post"=>{"summary"=>"HTTP POST a new note into the system.", "description"=>"Http post a new note into the system..", "operationId"=>"Note_Post", "x-api-path-slug"=>"reciperecipeidnote-post", "parameters"=>[{"in"=>"body", "name"=>"note", "description"=>"a recipe note, with fields: Date (YYYY-MM-DD string), Notes (string), People (string), Variations (string), RecipeID (int?)", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"recipeId", "description"=>"recipeId (int)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Note"]}}, "/recipe/{recipeId}/note/{noteId}"=>{"delete"=>{"summary"=>"Delete a review\r\n do a DELETE Http request of /note/{ID}", "description"=>"Delete a review\r\n do a delete http request of /note/{id}.", "operationId"=>"Note_Delete", "x-api-path-slug"=>"reciperecipeidnotenoteid-delete", "parameters"=>[{"in"=>"path", "name"=>"noteId", "description"=>"noteId (int)"}, {"in"=>"path", "name"=>"recipeId", "description"=>"recipeId (int)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Note", "NoteId"]}, "get"=>{"summary"=>"Get a given note. Make sure you're passing authentication information in the header for the user who owns the note.", "description"=>"Get a given note. make sure you're passing authentication information in the header for the user who owns the note..", "operationId"=>"Note_Get", "x-api-path-slug"=>"reciperecipeidnotenoteid-get", "parameters"=>[{"in"=>"path", "name"=>"noteId", "description"=>"The note ID (note -- its not the RecipeID)"}, {"in"=>"path", "name"=>"recipeId", "description"=>"recipe identifier (integer)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Note", "NoteId"]}, "put"=>{"summary"=>"HTTP PUT (update) a Recipe note (RecipeNote).", "description"=>"Http put (update) a recipe note (recipenote)..", "operationId"=>"Note_Put", "x-api-path-slug"=>"reciperecipeidnotenoteid-put", "parameters"=>[{"in"=>"path", "name"=>"noteId"}, {"in"=>"path", "name"=>"recipeId"}, {"in"=>"body", "name"=>"recipeNote", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Note", "NoteId"]}}, "/recipe/{recipeId}/notes"=>{"get"=>{"summary"=>"recipe/100/notes", "description"=>"Recipe/100/notes.", "operationId"=>"Note_GetNotes", "x-api-path-slug"=>"reciperecipeidnotes-get", "parameters"=>[{"in"=>"query", "name"=>"pg", "description"=>"page (int, starting from 1)"}, {"in"=>"path", "name"=>"recipeId", "description"=>"recipeId (int)"}, {"in"=>"query", "name"=>"rpp", "description"=>"recipeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Notes"]}}, "/recipe/{recipeId}/photos"=>{"get"=>{"summary"=>"Get all the photos for a recipe", "description"=>"Get all the photos for a recipe.", "operationId"=>"Images_GetRecipePhotos", "x-api-path-slug"=>"reciperecipeidphotos-get", "parameters"=>[{"in"=>"query", "name"=>"pg"}, {"in"=>"path", "name"=>"recipeId", "description"=>"Recipe ID (required)"}, {"in"=>"query", "name"=>"rpp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Photos"]}}, "/recipe/{recipeId}/related"=>{"get"=>{"summary"=>"Get recipes related to the given recipeId", "description"=>"Get recipes related to the given recipeid.", "operationId"=>"Recipe_Related", "x-api-path-slug"=>"reciperecipeidrelated-get", "parameters"=>[{"in"=>"query", "name"=>"pg"}, {"in"=>"path", "name"=>"recipeId"}, {"in"=>"query", "name"=>"rpp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Related"]}}, "/recipe/{recipeId}/review"=>{"get"=>{"summary"=>"Get *my* review for the recipe {recipeId}, where \"me\" is determined by standard authentication headers", "description"=>"Get *my* review for the recipe {recipeid}, where \"me\" is determined by standard authentication headers.", "operationId"=>"", "x-api-path-slug"=>"reciperecipeidreview-get", "parameters"=>[{"in"=>"path", "name"=>"recipeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Review"]}, "post"=>{"summary"=>"Add a new review. Only one review can be provided per {userId, recipeId} pair. Otherwise your review will be updated.", "description"=>"Add a new review. only one review can be provided per {userid, recipeid} pair. otherwise your review will be updated..", "operationId"=>"Review_Post", "x-api-path-slug"=>"reciperecipeidreview-post", "parameters"=>[{"in"=>"body", "name"=>"data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"recipeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Review"]}}, "/recipe/{recipeId}/review/{reviewId}"=>{"delete"=>{"summary"=>"Delete a review by recipeId and reviewId. DEPRECATED. Please see recipe/review/{reviewId} for the preferred method.\r\n (We are moving from an integer-based ID system to a GUID-style string-based ID system for reviews and replies.)", "description"=>"Delete a review by recipeid and reviewid. deprecated. please see recipe/review/{reviewid} for the preferred method.\r\n (we are moving from an integer-based id system to a guid-style string-based id system for reviews and replies.).", "operationId"=>"Review_Delete", "x-api-path-slug"=>"reciperecipeidreviewreviewid-delete", "parameters"=>[{"in"=>"path", "name"=>"recipeId"}, {"in"=>"path", "name"=>"reviewId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Review", "ReviewId"]}, "get"=>{"summary"=>"Get a given review - DEPRECATED. See recipe/review/{reviewId} for the current usage.\r\n Beginning in January 2017, BigOven moded from an integer-based ID system to a GUID-style string-based ID system for reviews and replies.\r\n We", "description"=>"Get a given review - deprecated. see recipe/review/{reviewid} for the current usage.\r\n beginning in january 2017, bigoven moded from an integer-based id system to a guid-style string-based id system for reviews and replies.\r\n we.", "operationId"=>"", "x-api-path-slug"=>"reciperecipeidreviewreviewid-get", "parameters"=>[{"in"=>"path", "name"=>"recipeId", "description"=>"int"}, {"in"=>"path", "name"=>"reviewId", "description"=>"int"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Review", "ReviewId"]}, "put"=>{"summary"=>"HTTP PUT (update) a recipe review. DEPRECATED. Please see recipe/review/{reviewId} PUT for the new endpoint.\r\n We are moving to a string-based primary key system, no longer integers, for reviews and replies.", "description"=>"Http put (update) a recipe review. deprecated. please see recipe/review/{reviewid} put for the new endpoint.\r\n we are moving to a string-based primary key system, no longer integers, for reviews and replies..", "operationId"=>"Review_PutLegacy", "x-api-path-slug"=>"reciperecipeidreviewreviewid-put", "parameters"=>[{"in"=>"path", "name"=>"recipeId", "description"=>"recipeId (int)"}, {"in"=>"body", "name"=>"review", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"reviewId", "description"=>"reviewId (int)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Review", "ReviewId"]}}, "/recipe/{recipeId}/reviews"=>{"get"=>{"summary"=>"Get paged list of reviews for a recipe. Each review will have at most one FeaturedReply, as well as a ReplyCount.", "description"=>"Get paged list of reviews for a recipe. each review will have at most one featuredreply, as well as a replycount..", "operationId"=>"Review_GetReviews", "x-api-path-slug"=>"reciperecipeidreviews-get", "parameters"=>[{"in"=>"query", "name"=>"pg", "description"=>"the page (int), starting with 1"}, {"in"=>"path", "name"=>"recipeId", "description"=>"recipe id (int)"}, {"in"=>"query", "name"=>"rpp", "description"=>"results per page (int)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Reviews"]}}, "/recipe/{recipeId}/scans"=>{"get"=>{"summary"=>"Gets a list of RecipeScan images for the recipe. There will be at most 3 per recipe.", "description"=>"Gets a list of recipescan images for the recipe. there will be at most 3 per recipe..", "operationId"=>"Images_GetScanImages", "x-api-path-slug"=>"reciperecipeidscans-get", "parameters"=>[{"in"=>"path", "name"=>"recipeId", "description"=>"the recipe identifier (int)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipe", "RecipeId", "Scans"]}}, "/recipes"=>{"get"=>{"summary"=>"Search for recipes. There are many parameters that you can apply. Starting with the most common, use title_kw to search within a title.\r\n Use any_kw to search across the entire recipe.\r\n If you'd like to limit by course, set the", "description"=>"Search for recipes. there are many parameters that you can apply. starting with the most common, use title_kw to search within a title.\r\n use any_kw to search across the entire recipe.\r\n if you'd like to limit by course, set the.", "operationId"=>"Recipe_RecipeSearch", "x-api-path-slug"=>"recipes-get", "parameters"=>[{"in"=>"query", "name"=>"any_kw", "description"=>"Search anywhere in the recipe for the keyword"}, {"in"=>"query", "name"=>"boostmine", "description"=>"if set to true, boost my own recipes in my folders so they show up high in the list (at the expense of other sort orders)"}, {"in"=>"query", "name"=>"champion", "description"=>"optional"}, {"in"=>"query", "name"=>"chs", "description"=>"when set to 1, limit to contains-cheese (Powersearch-capable plan required)"}, {"in"=>"query", "name"=>"coll", "description"=>"Limit to a collection ID number"}, {"in"=>"query", "name"=>"cps", "description"=>"when set to 1, recipe contains pasta, set to 0 means contains no pasta (Powersearch-capable plan required)"}, {"in"=>"query", "name"=>"cuisine", "description"=>"Limit to a specific cuisine"}, {"in"=>"query", "name"=>"db"}, {"in"=>"query", "name"=>"dyf", "description"=>"when set to 1, limit to dairy-free (Powersearch-capable plan required)"}, {"in"=>"query", "name"=>"exclude_cat", "description"=>"like include_cat, set this to an integer to exclude a specific category"}, {"in"=>"query", "name"=>"exclude_ing", "description"=>"A CSV representing up to 3 ingredients to exclude (Powersearch-capable plan required)"}, {"in"=>"query", "name"=>"filter", "description"=>"optionally set to either myrecipes, try, favorites,added to filter to just the authenticated users recipe set"}, {"in"=>"query", "name"=>"folder", "description"=>"Search in a specific folder name for the authenticated user"}, {"in"=>"query", "name"=>"glf", "description"=>"when set to 1, limit to gluten-free (Powersearch-capable plan required)"}, {"in"=>"query", "name"=>"include_cat", "description"=>"integer of the subcategory youd like to limit searches to (see the /recipe/categories endpoint for available id numbers)"}, {"in"=>"query", "name"=>"include_ing", "description"=>"A CSV representing up to 3 ingredients to include, e"}, {"in"=>"query", "name"=>"include_primarycat", "description"=>"csv indicating up to three top-level categories -- valid values are [appetizers,bread,breakfast,desserts,drinks,maindish,salads,sidedish,soups,marinades,other]"}, {"in"=>"query", "name"=>"ntf", "description"=>"when set to 1, limit to nut-free (Powersearch-capable plan required)"}, {"in"=>"query", "name"=>"pg", "description"=>"integer: the page number"}, {"in"=>"query", "name"=>"photos", "description"=>"if set to true, limit search results to photos only"}, {"in"=>"query", "name"=>"rmf", "description"=>"when set to 1, limit to red-meat free (Powersearch-capable plan required)"}, {"in"=>"query", "name"=>"rpp", "description"=>"integer; results per page"}, {"in"=>"query", "name"=>"sff", "description"=>"when set to 1, limit to seafood-free (Powersearch-capable plan required)"}, {"in"=>"query", "name"=>"slf", "description"=>"when set to 1, limit to shellfish-free (Powersearch-capable plan required)"}, {"in"=>"query", "name"=>"title_kw", "description"=>"Search just in the recipe title for the keyword"}, {"in"=>"query", "name"=>"tnf", "description"=>"when set to 1, limit to tree-nut free (Powersearch-capable plan required)"}, {"in"=>"query", "name"=>"token"}, {"in"=>"query", "name"=>"userId", "description"=>"Set the target userid to search their public recipes"}, {"in"=>"query", "name"=>"username", "description"=>"Set the target username to search their public recipes"}, {"in"=>"query", "name"=>"userset", "description"=>"If set to a given username, itll force the search to filter to just that username"}, {"in"=>"query", "name"=>"vgn", "description"=>"when set to 1, limit to vegan (Powersearch-capable plan required)"}, {"in"=>"query", "name"=>"vtn", "description"=>"when set to 1, limit to vegetarian (Powersearch-capable plan required)"}, {"in"=>"query", "name"=>"wmf", "description"=>"when set to 1, limit to white-meat free (Powersearch-capable plan required)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipes"]}}, "/recipes/random"=>{"get"=>{"summary"=>"Get a random, home-page-quality Recipe.", "description"=>"Get a random, home-page-quality recipe..", "operationId"=>"Recipe_GetRandomRecipe", "x-api-path-slug"=>"recipesrandom-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipes", "Random"]}}, "/recipes/raves"=>{"get"=>{"summary"=>"Get the recipe/comment tuples for those recipes with 4 or 5 star ratings", "description"=>"Get the recipe/comment tuples for those recipes with 4 or 5 star ratings.", "operationId"=>"Recipe_Raves", "x-api-path-slug"=>"recipesraves-get", "parameters"=>[{"in"=>"query", "name"=>"pg", "description"=>"page, starting with 1"}, {"in"=>"query", "name"=>"rpp", "description"=>"results per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipes", "Raves"]}}, "/recipes/recentviews"=>{"get"=>{"summary"=>"Get a list of recipes that the authenticated user has most recently viewed", "description"=>"Get a list of recipes that the authenticated user has most recently viewed.", "operationId"=>"Recipe_RecentViews", "x-api-path-slug"=>"recipesrecentviews-get", "parameters"=>[{"in"=>"query", "name"=>"pg", "description"=>"Page number starting with 1"}, {"in"=>"query", "name"=>"rpp", "description"=>"results per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recipes", "Recipes", "Recentviews"]}}}}, "apis"=>{"name"=>"BigOven", "x-slug"=>"bigoven", "description"=>"Free recipe app for home cooks. Create a meal plan, grocery list and more from your favorite recipes. Organize your recipe collection and take it anywhere.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/379-bigoven.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"117577", "tags"=>",API Provider,Cooking,Food,Food,General Data,internet,Mobile,Nutrition,Profiles,Recipes,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bigoven/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Big Oven", "x-api-slug"=>"big-oven", "description"=>"Free recipe app for home cooks. Create a meal plan, grocery list and more from your favorite recipes. Organize your recipe collection and take it anywhere.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/379-bigoven.jpg", "humanURL"=>"http://www.bigoven.com", "baseURL"=>"https://api2.bigoven.com//", "tags"=>",API Provider,Cooking,Food,Food,General Data,internet,Mobile,Nutrition,Profiles,Recipes,Stack Network,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/bigoven/big-oven-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://www.bigoven.com"}, {"type"=>"x-base", "url"=>"http://api.bigoven.com/"}, {"type"=>"x-blog", "url"=>"http://blog.bigoven.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.bigoven.com/index.php/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/bigoven"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/bigoven"}, {"type"=>"x-developer", "url"=>"http://api.bigoven.com"}, {"type"=>"x-documentation", "url"=>"http://api2.bigoven.com/"}, {"type"=>"x-email", "url"=>"support@bigoven.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/bigoven"}, {"type"=>"x-website", "url"=>"http://bigoven.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
visage-cloud{"visage-cloud-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Visage Cloud", "x-complete"=>1, "info"=>{"title"=>"Visage Cloud", "description"=>"face-search-recognition-classification-api--just-make-a-call-to-our-rest-api-each-time-your-app-needs-to-access-face-recognition-and-classification-capabilities-", "termsOfService"=>"https://visagecloud.com/terms-of-use", "contact"=>{"name"=>"VisageCloud", "url"=>"https://visagecloud.com", "email"=>"office@visagecloud.com"}, "version"=>"1.1"}, "host"=>"visagecloud.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/rest/v1.1/account/account"=>{"get"=>{"summary"=>"Get account information by accessKey and secretKey", "description"=>"", "operationId"=>"getAccountByAccessKeyUsingGET", "x-api-path-slug"=>"restv1-1accountaccount-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"accessKey"}, {"in"=>"query", "name"=>"secretKey", "description"=>"secretKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/account/billing"=>{"get"=>{"summary"=>"Get billing information by accessKey and secretKey", "description"=>"", "operationId"=>"getBillingPerAccountUsingGET", "x-api-path-slug"=>"restv1-1accountbilling-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"accessKey"}, {"in"=>"query", "name"=>"dateTemplate", "description"=>"dateTemplate"}, {"in"=>"query", "name"=>"endDateTime", "description"=>"endDateTime"}, {"in"=>"query", "name"=>"secretKey", "description"=>"secretKey"}, {"in"=>"query", "name"=>"startDateTime", "description"=>"startDateTime"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/account/changePassword"=>{"post"=>{"summary"=>"Change password for an account using old password", "description"=>"", "operationId"=>"changePasswordUsingPOST", "x-api-path-slug"=>"restv1-1accountchangepassword-post", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"email"}, {"in"=>"query", "name"=>"newPassword", "description"=>"newPassword"}, {"in"=>"query", "name"=>"oldPassword", "description"=>"oldPassword"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/account/login"=>{"post"=>{"summary"=>"Get account information including accessKey and secretKey by email and password", "description"=>"", "operationId"=>"loginWithEmailUsingPOST", "x-api-path-slug"=>"restv1-1accountlogin-post", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"email"}, {"in"=>"query", "name"=>"password", "description"=>"password"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/analysis/compare"=>{"get"=>{"summary"=>"Compare several faces identified by faceHash, without depending on mapping faces to profiles", "description"=>"", "operationId"=>"compareFacesUsingGET", "x-api-path-slug"=>"restv1-1analysiscompare-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"faceHashes", "description"=>"The IDs of the faces which you want compared, comma-separated"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}, {"in"=>"query", "name"=>"showDetails", "description"=>"Show details"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/analysis/detection"=>{"post"=>{"summary"=>"Perform detection on a given picture or picture URL", "description"=>"", "operationId"=>"performAnalysisUsingPOST", "x-api-path-slug"=>"restv1-1analysisdetection-post", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"algorithmVersion", "description"=>"Algorithm version (V2 is more performant but not backward compatible)"}, {"in"=>"query", "name"=>"filters", "description"=>"[For advanced users only] Change feature filters for robustness of feature extraction"}, {"in"=>"query", "name"=>"options", "description"=>"[For advanced users only] Options for preprocessing of image"}, {"in"=>"formData", "name"=>"picture", "description"=>"The multipart/form-data version of the image, in case a direct upload is used"}, {"in"=>"query", "name"=>"pictureURL", "description"=>"The URL of the picture, assuming it is served by a third party server"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}, {"in"=>"query", "name"=>"skipEXIF", "description"=>"Skip EXIF rotation procesing"}, {"in"=>"query", "name"=>"storeAnalysisPicture", "description"=>"Boolean value indicating whether you want the picture of the analysis to be stored for later retrieval"}, {"in"=>"query", "name"=>"storeFacePictures", "description"=>"Boolean value indicating whether you want the faces inside the picture to be stored for later retrieval"}, {"in"=>"query", "name"=>"storePicture", "description"=>"Boolean value indicating whether you want the original picture to be stored for later retrieval"}, {"in"=>"query", "name"=>"storeResult", "description"=>"Boolean value indicating whether you want the result of the analysis to be stored"}, {"in"=>"query", "name"=>"waitForPictureUpload", "description"=>"Waits until the picture is successfully uploaded, before returning the response back the the client"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/analysis/listLatest"=>{"get"=>{"summary"=>"Retrieve the last *count* operations per current account", "description"=>"", "operationId"=>"retriveLatestUsingGET", "x-api-path-slug"=>"restv1-1analysislistlatest-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"count", "description"=>"How many records to retrieve at a time"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/analysis/recognition"=>{"post"=>{"summary"=>"Perform labeled recognition on a given picture or picture URL", "description"=>"", "operationId"=>"performRecognitionUsingPOST", "x-api-path-slug"=>"restv1-1analysisrecognition-post", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"algorithmVersion", "description"=>"Algorithm version (V2 is more performant but not backward compatible)"}, {"in"=>"query", "name"=>"attributeFilters", "description"=>"Filters that will be applied on the recognition operation"}, {"in"=>"query", "name"=>"collectionId", "description"=>"Uniquely identified collection that can store multiple profiles"}, {"in"=>"query", "name"=>"filters", "description"=>"[For advanced users only] Change feature filters for robustness of feature extraction"}, {"in"=>"query", "name"=>"labels", "description"=>"Labels associated with the given picture or picture URL"}, {"in"=>"query", "name"=>"options", "description"=>"[For advanced users only] Options for preprocessing of image"}, {"in"=>"formData", "name"=>"picture", "description"=>"The picture itself"}, {"in"=>"query", "name"=>"pictureURL", "description"=>"The URL of the picture"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}, {"in"=>"query", "name"=>"skipEXIF rotation processing", "description"=>"Skip EXIF rotation procesing"}, {"in"=>"query", "name"=>"storeAnalysisPicture", "description"=>"Boolean value indicating whether you want the picture of the analysis to be stored for later retrieval"}, {"in"=>"query", "name"=>"storeFacePictures", "description"=>"Boolean value indicating whether you want the faces inside the picture to be stored for later retrieval"}, {"in"=>"query", "name"=>"storePicture", "description"=>"Boolean value indicating whether you want the original picture to be stored for later retrieval"}, {"in"=>"query", "name"=>"storeResult", "description"=>"Boolean value indicating whether you want the result of the analysis to be stored"}, {"in"=>"query", "name"=>"waitForPictureUpload", "description"=>"Waits until the picture is successfully uploaded, before returning the response back the the client"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/analysis/retrieve"=>{"get"=>{"summary"=>"Retrieve a complete analysis object including both detection and recognition information", "description"=>"", "operationId"=>"retrieveAnalysisUsingGET", "x-api-path-slug"=>"restv1-1analysisretrieve-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"analysisId", "description"=>"The ID of the analysis for which the data will be retrieved"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/analytics/counting"=>{"post"=>{"summary"=>"Count individuals in streams or collections", "description"=>"", "operationId"=>"counterUsingPOST", "x-api-path-slug"=>"restv1-1analyticscounting-post", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"collectionIds", "description"=>"Collection ids"}, {"in"=>"query", "name"=>"endDateTime", "description"=>"endDateTime"}, {"in"=>"query", "name"=>"maxBatchIterations", "description"=>"maxBatchIterations"}, {"in"=>"query", "name"=>"maxIterations", "description"=>"maxIterations"}, {"in"=>"query", "name"=>"mergingStep", "description"=>"mergingStep"}, {"in"=>"query", "name"=>"minNeighborsMergedPerIteration", "description"=>"minNeighborsMergedPerIteration"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}, {"in"=>"query", "name"=>"shuffling", "description"=>"shuffling"}, {"in"=>"query", "name"=>"startDateTime", "description"=>"startDateTime"}, {"in"=>"query", "name"=>"streamIds", "description"=>"Stream Ids"}, {"in"=>"query", "name"=>"visitDuration", "description"=>"visitDuration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/analytics/presence/timeseries"=>{"post"=>{"summary"=>"Show audience (based on number of occurrences of each person) breakdown per declared attribute (age, gender).", "description"=>"", "operationId"=>"presenceTimeseriesUsingPOST", "x-api-path-slug"=>"restv1-1analyticspresencetimeseries-post", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"attributes", "description"=>"attributes"}, {"in"=>"query", "name"=>"endDateTime", "description"=>"endDateTime"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}, {"in"=>"query", "name"=>"startDateTime", "description"=>"startDateTime"}, {"in"=>"query", "name"=>"step", "description"=>"step"}, {"in"=>"query", "name"=>"streamIds", "description"=>"Stream Ids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/analytics/presence/total"=>{"post"=>{"summary"=>"Show presence (based on number of occurences of each face) breakdown per declared attribute (age, gender)", "description"=>"", "operationId"=>"presenceTotalUsingPOST", "x-api-path-slug"=>"restv1-1analyticspresencetotal-post", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"attributes", "description"=>"attributes"}, {"in"=>"query", "name"=>"endDateTime", "description"=>"endDateTime"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}, {"in"=>"query", "name"=>"startDateTime", "description"=>"startDateTime"}, {"in"=>"query", "name"=>"streamIds", "description"=>"Stream Ids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/classifier/svm"=>{"delete"=>{"summary"=>"Delete existing classifier", "description"=>"", "operationId"=>"removeClassiferUsingDELETE", "x-api-path-slug"=>"restv1-1classifiersvm-delete", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"id", "description"=>"The id of the classifier that will be removed"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "get"=>{"summary"=>"Get classifier full", "description"=>"", "operationId"=>"getClassiferFullUsingGET", "x-api-path-slug"=>"restv1-1classifiersvm-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"id", "description"=>"The id of the classifier that you want the status for"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"Create new SVM classifier with given name", "description"=>"", "operationId"=>"addSVMClassifierUsingPOST", "x-api-path-slug"=>"restv1-1classifiersvm-post", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"cacheSizeParameter", "description"=>"Cache size parameter"}, {"in"=>"query", "name"=>"classificationAttributeName", "description"=>"Classification attribute name"}, {"in"=>"query", "name"=>"collectionIds", "description"=>"Collection ids"}, {"in"=>"query", "name"=>"considerViewPoints", "description"=>"Consider view point"}, {"in"=>"query", "name"=>"cParameter", "description"=>"c parameter"}, {"in"=>"query", "name"=>"epsParameter", "description"=>"Eps parameter"}, {"in"=>"query", "name"=>"gammaParameter", "description"=>"Gamma parameter"}, {"in"=>"query", "name"=>"kernelTypeParameter", "description"=>"Kernel type parameter"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the SVM classifier that will be created"}, {"in"=>"query", "name"=>"nuParameter", "description"=>"Nu parameter"}, {"in"=>"query", "name"=>"preprocessor", "description"=>"Preprocessor"}, {"in"=>"query", "name"=>"probabilityParameter", "description"=>"Probability parameter"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}, {"in"=>"query", "name"=>"seed", "description"=>"Seed for divididing training and evaluation sets"}, {"in"=>"query", "name"=>"svmTypeParameter", "description"=>"SVM type parameter"}, {"in"=>"query", "name"=>"trainingRatio", "description"=>"Training ratio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/classifier/svm/status"=>{"get"=>{"summary"=>"Get classifer status", "description"=>"", "operationId"=>"getClassiferStatusUsingGET", "x-api-path-slug"=>"restv1-1classifiersvmstatus-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"id", "description"=>"The id of the classifier that you want the status for"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/collection/"=>{"get"=>{"summary"=>"Retrieve all collections", "description"=>"", "operationId"=>"getAllCollectionsUsingGET", "x-api-path-slug"=>"restv1-1collection-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"Create new empty collection with given name", "description"=>"", "operationId"=>"addCollectionUsingPOST", "x-api-path-slug"=>"restv1-1collection-post", "parameters"=>[{"in"=>"formData", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"formData", "name"=>"evictable", "description"=>"Defined whether the collection can be evicted"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the collection that will be created"}, {"in"=>"formData", "name"=>"preload", "description"=>"Defined whether to preload collection"}, {"in"=>"formData", "name"=>"purposes", "description"=>"The newly declared purposes of the collection"}, {"in"=>"formData", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/collection/all"=>{"get"=>{"summary"=>"Retrieve all collections", "description"=>"", "operationId"=>"getAllCollections2UsingGET", "x-api-path-slug"=>"restv1-1collectionall-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/collection/collection"=>{"delete"=>{"summary"=>"Delete existing collection with associated profiles and faces.", "description"=>"", "operationId"=>"deleteCollection2UsingDELETE", "x-api-path-slug"=>"restv1-1collectioncollection-delete", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"collectionId", "description"=>"The id of the collection that will be removed"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "get"=>{"summary"=>"Retrieve existing collection content", "description"=>"", "operationId"=>"getCollection2UsingGET", "x-api-path-slug"=>"restv1-1collectioncollection-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"collectionId", "description"=>"The id of the collection for which the data will be retrieved"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"Create new empty collection with given name", "description"=>"", "operationId"=>"addCollection2UsingPOST", "x-api-path-slug"=>"restv1-1collectioncollection-post", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"collectionName", "description"=>"The name of the collection that will be created"}, {"in"=>"query", "name"=>"evictable", "description"=>"Defined whether the collection can be evicted"}, {"in"=>"query", "name"=>"preload", "description"=>"Defined whether to preload collection"}, {"in"=>"query", "name"=>"purposes", "description"=>"The newly declared purposes of the collection"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/collection/export/csv"=>{"get"=>{"summary"=>"Retrieve collection content for data analysis.", "description"=>"", "operationId"=>"exportCSVUsingGET", "x-api-path-slug"=>"restv1-1collectionexportcsv-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"collectionId", "description"=>"The id of the collection for which the data will be retrieved"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/collection/purpose"=>{"put"=>{"summary"=>"Change purpose of existing collection", "description"=>"", "operationId"=>"repurposeCollectionUsingPUT", "x-api-path-slug"=>"restv1-1collectionpurpose-put", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"collectionId", "description"=>"The id of the collection for which the data will be retrieved"}, {"in"=>"query", "name"=>"purposes", "description"=>"The newly declared purposes of the collection"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/collection/{id}"=>{"delete"=>{"summary"=>"Delete existing collection with associated profiles and faces.", "description"=>"", "operationId"=>"deleteCollectionUsingDELETE", "x-api-path-slug"=>"restv1-1collectionid-delete", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"path", "name"=>"id", "description"=>"The id of the collection that will be removed"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "get"=>{"summary"=>"Retrieve existing collection content", "description"=>"", "operationId"=>"getCollectionUsingGET", "x-api-path-slug"=>"restv1-1collectionid-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"path", "name"=>"id", "description"=>"The id of the collection for which the data will be retrieved"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "patch"=>{"summary"=>"Update an existing collection with a given id", "description"=>"", "operationId"=>"updateCollectionUsingPATCH", "x-api-path-slug"=>"restv1-1collectionid-patch", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"path", "name"=>"id", "description"=>"The id of the collection that will be updated"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the collection that will be updated"}, {"in"=>"query", "name"=>"purposes", "description"=>"The newly declared purposes of the collection"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"Update an existing collection with a given id", "description"=>"", "operationId"=>"updateCollection2UsingPOST", "x-api-path-slug"=>"restv1-1collectionid-post", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"path", "name"=>"id", "description"=>"The id of the collection that will be updated"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the collection that will be updated"}, {"in"=>"query", "name"=>"purposes", "description"=>"The newly declared purposes of the collection"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/collection/{id}/profile"=>{"get"=>{"summary"=>"Gets all the profiles associated to a collection", "description"=>"", "operationId"=>"getAllCollectionProfilesUsingGET", "x-api-path-slug"=>"restv1-1collectionidprofile-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"path", "name"=>"id", "description"=>"The collection that contains the profile"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/profile/classificationAttributes"=>{"delete"=>{"summary"=>"Removes classification attributes from a profile", "description"=>"", "operationId"=>"removeClassificationAttributesFromProfileUsingDELETE", "x-api-path-slug"=>"restv1-1profileclassificationattributes-delete", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"collectionId", "description"=>"The collection that contains the profile"}, {"in"=>"query", "name"=>"profileId", "description"=>"The profile associated with the classification attributes"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "get"=>{"summary"=>"Gets classification attributes from a profile", "description"=>"", "operationId"=>"getClassificationAttributesFromProfileUsingGET", "x-api-path-slug"=>"restv1-1profileclassificationattributes-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"collectionId", "description"=>"The collection that contains the profile"}, {"in"=>"query", "name"=>"profileId", "description"=>"The profile associated with the classification attributes"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "put"=>{"summary"=>"Maps classification attributes to a profile", "description"=>"", "operationId"=>"mapClassificationAttributesToProfileUsingPUT", "x-api-path-slug"=>"restv1-1profileclassificationattributes-put", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"classificationAttributes", "description"=>"Comma separated key:value classification attributes"}, {"in"=>"query", "name"=>"collectionId", "description"=>"The collection that contains the profile"}, {"in"=>"query", "name"=>"profileId", "description"=>"The profile associated with the classification attributes"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/profile/enrollmentStatus"=>{"get"=>{"summary"=>"Gets the enrollment status of a profile: information on whether it is suitable for authentication.", "description"=>"", "operationId"=>"getProfileEnrollmentStatusUsingGET", "x-api-path-slug"=>"restv1-1profileenrollmentstatus-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"collectionId", "description"=>"The collection that contains the profile"}, {"in"=>"query", "name"=>"profileId", "description"=>"The profile that contains the faces"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/profile/map"=>{"delete"=>{"summary"=>"Removes (unmaps) a list of faces, identified by faceHashes, from a profile, identified by profileId", "description"=>"", "operationId"=>"removeFacesFromProfileUsingDELETE", "x-api-path-slug"=>"restv1-1profilemap-delete", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"collectionId", "description"=>"The collection that contains the profile"}, {"in"=>"query", "name"=>"faceHash", "description"=>"The face that will be removed from a profile"}, {"in"=>"query", "name"=>"faceHashes", "description"=>"Comma separated face hashes, that will be removed from a profile"}, {"in"=>"query", "name"=>"profileId", "description"=>"The profile that contains the face"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "get"=>{"summary"=>"Gets all the faceHashes associated to a profile", "description"=>"", "operationId"=>"getFacesFromProfileUsingGET", "x-api-path-slug"=>"restv1-1profilemap-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"collectionId", "description"=>"The collection that contains the profile"}, {"in"=>"query", "name"=>"profileId", "description"=>"The profile that contains the faces"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"Adds (maps) a list of faces, identified by faceHashes, to a profile, identified by profileId", "description"=>"", "operationId"=>"mapFacesToProfileUsingPOST", "x-api-path-slug"=>"restv1-1profilemap-post", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"collectionId", "description"=>"The collection that contains the profile"}, {"in"=>"query", "name"=>"faceHash", "description"=>"The face that will be added to a profile"}, {"in"=>"query", "name"=>"faceHashes", "description"=>"Comma separated face hashes, that will be associated to a profile"}, {"in"=>"query", "name"=>"profileId", "description"=>"The profile that will store the face"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/profile/profile"=>{"delete"=>{"summary"=>"Deletes a profile and unmaps all its faces", "description"=>"", "operationId"=>"deleteProfile2UsingDELETE", "x-api-path-slug"=>"restv1-1profileprofile-delete", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"collectionId", "description"=>"Uniquely identified collection that can store multiple profiles"}, {"in"=>"query", "name"=>"profileId", "description"=>"The profile id (provide this if you dont have the externalId"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"Creates a new profile with no faces associated to it (empty profile)", "description"=>"", "operationId"=>"addProfileUsingPOST", "x-api-path-slug"=>"restv1-1profileprofile-post", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"classificationAttributes", "description"=>"Comma separated key:value classification attributes"}, {"in"=>"query", "name"=>"collectionId", "description"=>"Uniquely identified collection that can store multiple profiles"}, {"in"=>"query", "name"=>"details", "description"=>"Comma separated key:value details of profile"}, {"in"=>"query", "name"=>"externalId", "description"=>"External reference to additional information you don???t want to share with VisageCloud"}, {"in"=>"query", "name"=>"labels", "description"=>"Allows you to do finer filtering in face recognition"}, {"in"=>"query", "name"=>"screenName", "description"=>"Human-readable label for the profile"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/profile/{id}"=>{"delete"=>{"summary"=>"Deletes a profile and unmaps all its faces", "description"=>"", "operationId"=>"deleteProfileUsingDELETE", "x-api-path-slug"=>"restv1-1profileid-delete", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"collectionId", "description"=>"Uniquely identified collection that can store multiple profiles"}, {"in"=>"path", "name"=>"id", "description"=>"The profile id (provide this if you dont have the externalId"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "get"=>{"summary"=>"Retrieves a profile", "description"=>"", "operationId"=>"getProfileUsingGET", "x-api-path-slug"=>"restv1-1profileid-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"collectionId", "description"=>"Uniquely identified collection that can store multiple profiles"}, {"in"=>"path", "name"=>"id", "description"=>"The profile id (provide this if you dont have the externalId"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}, {"in"=>"query", "name"=>"withFaces", "description"=>"Retrieves the profile with all its associated faces"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "patch"=>{"summary"=>"Update an existing profile with a given id", "description"=>"", "operationId"=>"updateProfileUsingPATCH", "x-api-path-slug"=>"restv1-1profileid-patch", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"classificationAttributes", "description"=>"Comma separated key:value classification attributes"}, {"in"=>"query", "name"=>"collectionId", "description"=>"Uniquely identified collection that can store multiple profiles"}, {"in"=>"query", "name"=>"details", "description"=>"Comma separated key:value details of profile"}, {"in"=>"query", "name"=>"externalId", "description"=>"External reference to additional information you don???t want to share with VisageCloud"}, {"in"=>"path", "name"=>"id", "description"=>"The id of the profile that will be updated"}, {"in"=>"query", "name"=>"labels", "description"=>"Allows you to do finer filtering in face recognition"}, {"in"=>"query", "name"=>"screenName", "description"=>"Human-readable label for the profile"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/stream/all"=>{"get"=>{"summary"=>"Show status of all streams from account", "description"=>"", "operationId"=>"streamsByAccountUsingGET", "x-api-path-slug"=>"restv1-1streamall-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/stream/attendance"=>{"get"=>{"summary"=>"Get last N recognized individuals from stream", "description"=>"", "operationId"=>"getLastNAttedanceUsingGET", "x-api-path-slug"=>"restv1-1streamattendance-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"count", "description"=>"How many frames to retrieve at a time"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}, {"in"=>"query", "name"=>"streamIds", "description"=>"The id of the stream for which the frames will be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/stream/cleanup"=>{"patch"=>{"summary"=>"Cleanup frames older than specified timeframe", "description"=>"", "operationId"=>"cleanupStreamUsingPATCH", "x-api-path-slug"=>"restv1-1streamcleanup-patch", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"interval", "description"=>"Frames older than interval (seconds) will be cleaned up"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}, {"in"=>"query", "name"=>"streamId", "description"=>"The id of the stream that will be stopped"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/stream/frameImage"=>{"get"=>{"summary"=>"Get individual frame image", "description"=>"", "operationId"=>"getFrameImageUsingGET", "x-api-path-slug"=>"restv1-1streamframeimage-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}, {"in"=>"query", "name"=>"streamId", "description"=>"The id of the stream for which the frames will be retrieved"}, {"in"=>"query", "name"=>"timestamp", "description"=>"Timestamp of frame to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/stream/frames"=>{"get"=>{"summary"=>"Get last processed N frames from stream", "description"=>"", "operationId"=>"getLastNFramesUsingGET", "x-api-path-slug"=>"restv1-1streamframes-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"attributeFilters", "description"=>"Filters that will be applied on the recognition operation"}, {"in"=>"query", "name"=>"collectionId", "description"=>"The collection id you want to run recognition against"}, {"in"=>"query", "name"=>"count", "description"=>"How many frames to retrieve at a time"}, {"in"=>"query", "name"=>"labels", "description"=>"Labels associated with the given picture or picture URL"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}, {"in"=>"query", "name"=>"streamId", "description"=>"The id of the stream for which the frames will be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/stream/start"=>{"patch"=>{"summary"=>"Start existing stream", "description"=>"", "operationId"=>"startStreamUsingPATCH", "x-api-path-slug"=>"restv1-1streamstart-patch", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"id", "description"=>"The id of the stream that will be started"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}, {"in"=>"query", "name"=>"streamId", "description"=>"The id of the stream that will be started"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/stream/stop"=>{"patch"=>{"summary"=>"Stop existing stream", "description"=>"", "operationId"=>"stopStreamUsingPATCH", "x-api-path-slug"=>"restv1-1streamstop-patch", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"id", "description"=>"The id of the stream that will be stopped"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}, {"in"=>"query", "name"=>"streamId", "description"=>"The id of the stream that will be stopped"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/stream/stream"=>{"post"=>{"summary"=>"Create new stream with given name", "description"=>"", "operationId"=>"addStreamUsingPOST", "x-api-path-slug"=>"restv1-1streamstream-post", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"associatedCollections", "description"=>"List of collection ids which will be used to measure attendance"}, {"in"=>"query", "name"=>"attributes", "description"=>"Attributes of the stream"}, {"in"=>"query", "name"=>"isActive", "description"=>"Boolean value indicating whether the stream is currently active or not"}, {"in"=>"query", "name"=>"method", "description"=>"Streaming method"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the stream that will be created"}, {"in"=>"query", "name"=>"password", "description"=>"Password"}, {"in"=>"query", "name"=>"retentionTime", "description"=>"Number of seconds for frames to be kept"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}, {"in"=>"query", "name"=>"skipFramesWithNoFaces", "description"=>"Boolean value indicating whether you want the original picture to be stored for later retrieval"}, {"in"=>"query", "name"=>"storeAttendanceFaces", "description"=>"Boolean value indicating whether you want to store permanently store faces clippings of the recognized faces"}, {"in"=>"query", "name"=>"storeAttendanceFrames", "description"=>"Boolean value indicating whether you want to store permanently store frames with a recognized face in them"}, {"in"=>"query", "name"=>"storeOriginalFrames", "description"=>"Boolean value indicating whether you want the original picture to be stored for later retrieval"}, {"in"=>"query", "name"=>"url", "description"=>"The url of the stream"}, {"in"=>"query", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "delete"=>{"summary"=>"Delete existing stream", "description"=>"", "operationId"=>"removeStreamUsingDELETE", "x-api-path-slug"=>"restv1-1streamstream-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id of the stream that will be removed"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey or readOnlyKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/stream/{id}"=>{"delete"=>{"summary"=>"Delete existing stream", "description"=>"", "operationId"=>"removeStreamUsingDELETE", "x-api-path-slug"=>"restv1-1streamid-delete", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"path", "name"=>"id", "description"=>"The id of the stream that will be removed"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/rest/v1.1/stream/{streamId}"=>{"get"=>{"summary"=>"Get an existing stream with a given ID", "description"=>"", "operationId"=>"getStreamUsingGET", "x-api-path-slug"=>"restv1-1streamstreamid-get", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}, {"in"=>"path", "name"=>"streamId", "description"=>"The id of the stream for which the data will be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "patch"=>{"summary"=>"Update an existing stream with a given ID", "description"=>"", "operationId"=>"updateStreamUsingPATCH", "x-api-path-slug"=>"restv1-1streamstreamid-patch", "parameters"=>[{"in"=>"query", "name"=>"accessKey", "description"=>"The accessKey provided by VisageCloud"}, {"in"=>"query", "name"=>"associatedCollections", "description"=>"List of collection ids which will be used to measure attendance"}, {"in"=>"query", "name"=>"attributes", "description"=>"Attributes of the stream"}, {"in"=>"query", "name"=>"retentionTime", "description"=>"Number of seconds for frames to be kept"}, {"in"=>"query", "name"=>"secretKey", "description"=>"The secretKey provided by VisageCloud"}, {"in"=>"query", "name"=>"storeAttendanceFaces", "description"=>"Boolean value indicating whether you want to store permanently store faces clippings of the recognized faces"}, {"in"=>"query", "name"=>"storeAttendanceFrames", "description"=>"Boolean value indicating whether you want to store permanently store frames with a recognized face in them"}, {"in"=>"query", "name"=>"storeOriginalFrames", "description"=>"Boolean value indicating whether you want the original picture to be stored for later retrieval"}, {"in"=>"path", "name"=>"streamId", "description"=>"The id of the stream that will be updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"Visage Cloud", "x-slug"=>"visage-cloud", "description"=>"We employ a wide range of state-of-the-art techniques ranging from deep learning and neural networks to conventional machine learning algorithms and big data management to ensure a smooth experience for your face recognition and classification needs", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/25683970.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Not Found,Facial Recognition,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"visage-cloud/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Visage Cloud", "x-api-slug"=>"visage-cloud", "description"=>"We employ a wide range of state-of-the-art techniques ranging from deep learning and neural networks to conventional machine learning algorithms and big data management to ensure a smooth experience for your face recognition and classification needs", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/25683970.png", "humanURL"=>"http://visagecloud.com", "baseURL"=>"https://visagecloud.com//", "tags"=>"API Not Found,Facial Recognition,Relative Data,Service API", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/visage-cloud/restv1-1streamstream-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/visage-cloud/visage-cloud-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://visagecloud.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
apis-guru{"apis-guru-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"APIs.Guru", "x-complete"=>1, "info"=>{"title"=>"APIs.guru", "description"=>"wikipedia-for-web-apis--repository-of-api-specs-in-openapifka-swagger-2-0-format-warning-if-you-want-to-be-notified-about-changes-in-advance-please-subscribe-to-our-gitter-channelhttpsgitter-imapisguruapimodels-client-sample-demohttpsapis-gurusimpleui-repohttpsgithub-comapisgurusimpleui", "contact"=>{"name"=>"APIs.guru", "url"=>"http://APIs.guru", "email"=>"founders@apis.guru"}, "version"=>"2.0.1"}, "host"=>"api.apis.guru", "basePath"=>"/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/list.json"=>{"get"=>{"summary"=>"List all APIs", "description"=>"List all APIs in the directory.\nReturns links to OpenAPI specification for each API in the directory.\nIf API exist in multiple versions `preferred` one is explicitly marked.\n\nSome basic info from OpenAPI spec is cached inside each object.\nThis allows to generate some simple views without need to fetch OpenAPI spec for each API.", "operationId"=>"listAPIs", "x-api-path-slug"=>"list-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APIs", "Definitions", "Discovery"]}}, "/metrics.json"=>{"get"=>{"summary"=>"Get basic metrics", "description"=>"Some basic metrics for the entire directory.\nJust stunning numbers to put on a front page and are intended purely for WoW effect :)", "operationId"=>"getMetrics", "x-api-path-slug"=>"metrics-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APIs", "Definitions", "Discovery"]}}}}, "apis"=>{"name"=>"APIs.Guru", "x-slug"=>"apis-guru", "description"=>"Our goal is to create a machine-readable Wikipedia for REST APIs with the following principal: Open source, community driven project. Only publicly available APIs (free or paid). Anyone can add or change an API, not only API owners. All data can be accessed through a REST API", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2018-05-21 at 3.08.45 PM.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Service Provider,API Tool,Discovery,General Data,Profiles", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"apis-guru/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"APIs.guru", "x-api-slug"=>"apis-guru", "description"=>"Our goal is to create a machine-readable Wikipedia for REST APIs with the following principal: Open source, community driven project. Only publicly available APIs (free or paid). Anyone can add or change an API, not only API owners. All data can be accessed through a REST API", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2018-05-21 at 3.08.45 PM.png", "humanURL"=>"http://apis.guru", "baseURL"=>"https://api.apis.guru//v2/", "tags"=>"API Service Provider,API Tool,Discovery,General Data,Profiles", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/apis-guru/metrics-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/apis-guru/apis-guru-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://apis.guru"}, {"type"=>"x-website", "url"=>"https://apis.guru/openapi-directory/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-scheduler{"azure-scheduler-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Scheduler", "x-complete"=>1, "info"=>{"title"=>"SchedulerManagementClient", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/providers/Microsoft.Scheduler/jobCollections"=>{"get"=>{"summary"=>"Job Collections List By Subscription", "description"=>"Gets all job collections under specified subscription.", "operationId"=>"JobCollections_ListBySubscription", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-schedulerjobcollections-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Collections Subscription"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections"=>{"get"=>{"summary"=>"Job Collections List By Resource Group", "description"=>"Gets all job collections under specified resource group.", "operationId"=>"JobCollections_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-schedulerjobcollections-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Collections Resource Group"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}"=>{"get"=>{"summary"=>"Job Collections Get", "description"=>"Gets a job collection.", "operationId"=>"JobCollections_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-schedulerjobcollectionsjobcollectionname-get", "parameters"=>[{"in"=>"path", "name"=>"jobCollectionName", "description"=>"The job collection name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Collections"]}, "put"=>{"summary"=>"Job Collections Create Or Update", "description"=>"Provisions a new job collection or updates an existing job collection.", "operationId"=>"JobCollections_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-schedulerjobcollectionsjobcollectionname-put", "parameters"=>[{"in"=>"body", "name"=>"jobCollection", "description"=>"The job collection definition", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"jobCollectionName", "description"=>"The job collection name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Collections"]}, "patch"=>{"summary"=>"Job Collections Patch", "description"=>"Patches an existing job collection.", "operationId"=>"JobCollections_Patch", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-schedulerjobcollectionsjobcollectionname-patch", "parameters"=>[{"in"=>"body", "name"=>"jobCollection", "description"=>"The job collection definition", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"jobCollectionName", "description"=>"The job collection name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Collections"]}, "delete"=>{"summary"=>"Job Collections Delete", "description"=>"Deletes a job collection.", "operationId"=>"JobCollections_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-schedulerjobcollectionsjobcollectionname-delete", "parameters"=>[{"in"=>"path", "name"=>"jobCollectionName", "description"=>"The job collection name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Collections"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/enable"=>{"post"=>{"summary"=>"Job Collections Enable", "description"=>"Enables all of the jobs in the job collection.", "operationId"=>"JobCollections_Enable", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-schedulerjobcollectionsjobcollectionnameenable-post", "parameters"=>[{"in"=>"path", "name"=>"jobCollectionName", "description"=>"The job collection name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Collections"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/disable"=>{"post"=>{"summary"=>"Job Collections Disable", "description"=>"Disables all of the jobs in the job collection.", "operationId"=>"JobCollections_Disable", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-schedulerjobcollectionsjobcollectionnamedisable-post", "parameters"=>[{"in"=>"path", "name"=>"jobCollectionName", "description"=>"The job collection name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Collections"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}"=>{"get"=>{"summary"=>"Jobs Get", "description"=>"Gets a job.", "operationId"=>"Jobs_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-schedulerjobcollectionsjobcollectionnamejobsjobname-get", "parameters"=>[{"in"=>"path", "name"=>"jobCollectionName", "description"=>"The job collection name"}, {"in"=>"path", "name"=>"jobName", "description"=>"The job name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}, "put"=>{"summary"=>"Jobs Create Or Update", "description"=>"Provisions a new job or updates an existing job.", "operationId"=>"Jobs_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-schedulerjobcollectionsjobcollectionnamejobsjobname-put", "parameters"=>[{"in"=>"body", "name"=>"job", "description"=>"The job definition", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"jobCollectionName", "description"=>"The job collection name"}, {"in"=>"path", "name"=>"jobName", "description"=>"The job name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}, "patch"=>{"summary"=>"Jobs Patch", "description"=>"Patches an existing job.", "operationId"=>"Jobs_Patch", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-schedulerjobcollectionsjobcollectionnamejobsjobname-patch", "parameters"=>[{"in"=>"body", "name"=>"job", "description"=>"The job definition", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"jobCollectionName", "description"=>"The job collection name"}, {"in"=>"path", "name"=>"jobName", "description"=>"The job name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}, "delete"=>{"summary"=>"Jobs Delete", "description"=>"Deletes a job.", "operationId"=>"Jobs_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-schedulerjobcollectionsjobcollectionnamejobsjobname-delete", "parameters"=>[{"in"=>"path", "name"=>"jobCollectionName", "description"=>"The job collection name"}, {"in"=>"path", "name"=>"jobName", "description"=>"The job name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/run"=>{"post"=>{"summary"=>"Jobs Run", "description"=>"Runs a job.", "operationId"=>"Jobs_Run", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-schedulerjobcollectionsjobcollectionnamejobsjobnamerun-post", "parameters"=>[{"in"=>"path", "name"=>"jobCollectionName", "description"=>"The job collection name"}, {"in"=>"path", "name"=>"jobName", "description"=>"The job name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs"=>{"get"=>{"summary"=>"Jobs List", "description"=>"Lists all jobs under the specified job collection.", "operationId"=>"Jobs_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-schedulerjobcollectionsjobcollectionnamejobs-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the job state"}, {"in"=>"query", "name"=>"$skip", "description"=>"The (0-based) index of the job history list from which to begin requesting entries"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of jobs to request, in the of range of [1"}, {"in"=>"path", "name"=>"jobCollectionName", "description"=>"The job collection name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/history"=>{"get"=>{"summary"=>"Jobs List Job History", "description"=>"Lists job history.", "operationId"=>"Jobs_ListJobHistory", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-schedulerjobcollectionsjobcollectionnamejobsjobnamehistory-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the job state"}, {"in"=>"query", "name"=>"$skip", "description"=>"The (0-based) index of the job history list from which to begin requesting entries"}, {"in"=>"query", "name"=>"$top", "description"=>"the number of job history to request, in the of range of [1"}, {"in"=>"path", "name"=>"jobCollectionName", "description"=>"The job collection name"}, {"in"=>"path", "name"=>"jobName", "description"=>"The job name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}}}, "apis"=>{"name"=>"Azure Scheduler", "x-slug"=>"azure-scheduler", "description"=>"Azure Scheduler lets you create jobs in the cloud that invoke services inside and outside of Azure—such as calling HTTP/S endpoints or posting messages to Azure Storage queues, or Azure Service Bus queues or topics. Run jobs right away, on a recurring schedule, or at some point in the future.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-scheduler-create.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Jobs,Microsoft,Orchestration,Profiles,Relative Data,Schedules,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-scheduler/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Scheduler API", "x-api-slug"=>"azure-scheduler-api", "description"=>"Azure Scheduler lets you create jobs in the cloud that invoke services inside and outside of Azure—such as calling HTTP/S endpoints or posting messages to Azure Storage queues, or Azure Service Bus queues or topics. Run jobs right away, on a recurring schedule, or at some point in the future.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-scheduler-create.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/scheduler/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Jobs,Microsoft,Orchestration,Profiles,Relative Data,Schedules,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-scheduler/subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-schedulerjobcollectionsjobcollectionnamejobsjobnamehistory-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-scheduler/azure-scheduler-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/scheduler/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/scheduler/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/scheduler/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/scheduler/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-workdocs{"aws-workdocs-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS WorkDocs", "x-complete"=>1, "info"=>{"title"=>"AWS WorkDocs API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AbortDocumentVersionUpload"=>{"get"=>{"summary"=>"Abort Document Version Upload", "description"=>"Aborts the upload of the specified document version that was previously initiated by.", "operationId"=>"abortDocumentVersionUpload", "x-api-path-slug"=>"actionabortdocumentversionupload-get", "parameters"=>[{"in"=>"query", "name"=>"DocumentId", "description"=>"The ID of the document", "type"=>"string"}, {"in"=>"query", "name"=>"VersionId", "description"=>"The ID of the version", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents"]}}, "/?Action=ActivateUser"=>{"get"=>{"summary"=>"Activate User", "description"=>"Activates the specified user.", "operationId"=>"activateUser", "x-api-path-slug"=>"actionactivateuser-get", "parameters"=>[{"in"=>"query", "name"=>"UserId", "description"=>"The ID of the user", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=AddResourcePermissions"=>{"get"=>{"summary"=>"Add Resource Permissions", "description"=>"Creates a set of permissions for the specified folder or document.", "operationId"=>"addResourcePermissions", "x-api-path-slug"=>"actionaddresourcepermissions-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceId", "description"=>"The ID of the resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permissions"]}}, "/?Action=CreateFolder"=>{"get"=>{"summary"=>"Create Folder", "description"=>"Creates a folder with the specified name and parent folder.", "operationId"=>"createFolder", "x-api-path-slug"=>"actioncreatefolder-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"The name of the new folder", "type"=>"string"}, {"in"=>"query", "name"=>"ParentFolderId", "description"=>"The ID of the parent folder", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folders"]}}, "/?Action=CreateNotificationSubscription"=>{"get"=>{"summary"=>"Create Notification Subscription", "description"=>"Configure WorkDocs to use Amazon SNS notifications.", "operationId"=>"createNotificationSubscription", "x-api-path-slug"=>"actioncreatenotificationsubscription-get", "parameters"=>[{"in"=>"query", "name"=>"OrganizationId", "description"=>"The ID of the organization", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications"]}}, "/?Action=CreateUser"=>{"get"=>{"summary"=>"Create User", "description"=>"Creates a user in a Simple AD or Microsoft AD directory.", "operationId"=>"createUser", "x-api-path-slug"=>"actioncreateuser-get", "parameters"=>[{"in"=>"query", "name"=>"GivenName", "description"=>"The given name of the user", "type"=>"string"}, {"in"=>"query", "name"=>"OrganizationId", "description"=>"The ID of the organization", "type"=>"string"}, {"in"=>"query", "name"=>"Password", "description"=>"The password of the user", "type"=>"string"}, {"in"=>"query", "name"=>"StorageRule", "description"=>"The amount of storage for the user", "type"=>"string"}, {"in"=>"query", "name"=>"Surname", "description"=>"The surname of the user", "type"=>"string"}, {"in"=>"query", "name"=>"TimeZoneId", "description"=>"The time zone ID of the user", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The login name of the user", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=DeactivateUser"=>{"get"=>{"summary"=>"Deactivate User", "description"=>"Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.", "operationId"=>"deactivateUser", "x-api-path-slug"=>"actiondeactivateuser-get", "parameters"=>[{"in"=>"query", "name"=>"UserId", "description"=>"The ID of the user", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=DeleteDocument"=>{"get"=>{"summary"=>"Delete Document", "description"=>"Permanently deletes the specified document and its associated metadata.", "operationId"=>"deleteDocument", "x-api-path-slug"=>"actiondeletedocument-get", "parameters"=>[{"in"=>"query", "name"=>"DocumentId", "description"=>"The ID of the document", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents"]}}, "/?Action=DeleteFolder"=>{"get"=>{"summary"=>"Delete Folder", "description"=>"Permanently deletes the specified folder and its contents.", "operationId"=>"deleteFolder", "x-api-path-slug"=>"actiondeletefolder-get", "parameters"=>[{"in"=>"query", "name"=>"FolderId", "description"=>"The ID of the folder", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folders"]}}, "/?Action=DeleteFolderContents"=>{"get"=>{"summary"=>"Delete Folder Contents", "description"=>"Deletes the contents of the specified folder.", "operationId"=>"deleteFolderContents", "x-api-path-slug"=>"actiondeletefoldercontents-get", "parameters"=>[{"in"=>"query", "name"=>"FolderId", "description"=>"The ID of the folder", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folders"]}}, "/?Action=DeleteNotificationSubscription"=>{"get"=>{"summary"=>"Delete Notification Subscription", "description"=>"Deletes the specified subscription from the specified organization.", "operationId"=>"deleteNotificationSubscription", "x-api-path-slug"=>"actiondeletenotificationsubscription-get", "parameters"=>[{"in"=>"query", "name"=>"OrganizationId", "description"=>"The ID of the organization", "type"=>"string"}, {"in"=>"query", "name"=>"SubscriptionId", "description"=>"The ID of the subscription", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications"]}}, "/?Action=DeleteUser"=>{"get"=>{"summary"=>"Delete User", "description"=>"Deletes the specified user from a Simple AD or Microsoft AD directory.", "operationId"=>"deleteUser", "x-api-path-slug"=>"actiondeleteuser-get", "parameters"=>[{"in"=>"query", "name"=>"UserId", "description"=>"The ID of the user", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=DescribeDocumentVersions"=>{"get"=>{"summary"=>"Describe Document Versions", "description"=>"Retrieves the document versions for the specified document.", "operationId"=>"describeDocumentVersions", "x-api-path-slug"=>"actiondescribedocumentversions-get", "parameters"=>[{"in"=>"query", "name"=>"DocumentId", "description"=>"The ID of the document", "type"=>"string"}, {"in"=>"query", "name"=>"Fields", "description"=>"Specify SOURCE to include initialized versions and a URL for the source document", "type"=>"string"}, {"in"=>"query", "name"=>"Include", "description"=>"A comma-separated list of values", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of versions to return with this call", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"The marker for the next set of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents"]}}, "/?Action=DescribeFolderContents"=>{"get"=>{"summary"=>"Describe Folder Contents", "description"=>"Describes the contents of the specified folder, including its documents and sub-folders.", "operationId"=>"describeFolderContents", "x-api-path-slug"=>"actiondescribefoldercontents-get", "parameters"=>[{"in"=>"query", "name"=>"FolderId", "description"=>"The ID of the folder", "type"=>"string"}, {"in"=>"query", "name"=>"Include", "description"=>"The contents to include", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of items to return with this call", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"The marker for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"Order", "description"=>"The order for the contents of the folder", "type"=>"string"}, {"in"=>"query", "name"=>"Sort", "description"=>"The sorting criteria", "type"=>"string"}, {"in"=>"query", "name"=>"Type", "description"=>"The type of items", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folders"]}}, "/?Action=DescribeNotificationSubscriptions"=>{"get"=>{"summary"=>"Describe Notification Subscriptions", "description"=>"Lists the specified notification subscriptions.", "operationId"=>"describeNotificationSubscriptions", "x-api-path-slug"=>"actiondescribenotificationsubscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of items to return with this call", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"The marker for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"OrganizationId", "description"=>"The ID of the organization", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications"]}}, "/?Action=DescribeResourcePermissions"=>{"get"=>{"summary"=>"Describe Resource Permissions", "description"=>"Describes the permissions of a specified resource.", "operationId"=>"describeResourcePermissions", "x-api-path-slug"=>"actiondescriberesourcepermissions-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceId", "description"=>"The ID of the resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permissions"]}}, "/?Action=DescribeUsers"=>{"get"=>{"summary"=>"Describe Users", "description"=>"Describes the specified users.", "operationId"=>"describeUsers", "x-api-path-slug"=>"actiondescribeusers-get", "parameters"=>[{"in"=>"query", "name"=>"Fields", "description"=>"A comma-separated list of values", "type"=>"string"}, {"in"=>"query", "name"=>"Include", "description"=>"The state of the users", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"The marker for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"Order", "description"=>"The order for the results", "type"=>"string"}, {"in"=>"query", "name"=>"OrganizationId", "description"=>"The ID of the organization", "type"=>"string"}, {"in"=>"query", "name"=>"Query", "description"=>"A query to filter users by user name", "type"=>"string"}, {"in"=>"query", "name"=>"Sort", "description"=>"The sorting criteria", "type"=>"string"}, {"in"=>"query", "name"=>"UserIds", "description"=>"The IDs of the users", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=GetDocument"=>{"get"=>{"summary"=>"Get Document", "description"=>"Retrieves the specified document object.", "operationId"=>"getDocument", "x-api-path-slug"=>"actiongetdocument-get", "parameters"=>[{"in"=>"query", "name"=>"DocumentId", "description"=>"The ID of the document object", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents"]}}, "/?Action=GetDocumentPath"=>{"get"=>{"summary"=>"Get Document Path", "description"=>"Retrieves the path information (the hierarchy from the root folder) for the requested document.", "operationId"=>"getDocumentPath", "x-api-path-slug"=>"actiongetdocumentpath-get", "parameters"=>[{"in"=>"query", "name"=>"DocumentId", "description"=>"The ID of the document", "type"=>"string"}, {"in"=>"query", "name"=>"Fields", "description"=>"A comma-separated list of values", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of levels in the hierarchy to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents"]}}, "/?Action=GetDocumentVersion"=>{"get"=>{"summary"=>"Get Document Version", "description"=>"Retrieves version metadata for the specified document.", "operationId"=>"getDocumentVersion", "x-api-path-slug"=>"actiongetdocumentversion-get", "parameters"=>[{"in"=>"query", "name"=>"DocumentId", "description"=>"The ID of the document", "type"=>"string"}, {"in"=>"query", "name"=>"Fields", "description"=>"A comma-separated list of values", "type"=>"string"}, {"in"=>"query", "name"=>"VersionId", "description"=>"The version ID of the document", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents"]}}, "/?Action=GetFolder"=>{"get"=>{"summary"=>"Get Folder", "description"=>"Retrieves the metadata of the specified folder.", "operationId"=>"getFolder", "x-api-path-slug"=>"actiongetfolder-get", "parameters"=>[{"in"=>"query", "name"=>"FolderId", "description"=>"The ID of the folder", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folders"]}}, "/?Action=GetFolderPath"=>{"get"=>{"summary"=>"Get Folder Path", "description"=>"Retrieves the path information (the hierarchy from the root folder) for the specified folder.", "operationId"=>"getFolderPath", "x-api-path-slug"=>"actiongetfolderpath-get", "parameters"=>[{"in"=>"query", "name"=>"Fields", "description"=>"A comma-separated list of values", "type"=>"string"}, {"in"=>"query", "name"=>"FolderId", "description"=>"The ID of the folder", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of levels in the hierarchy to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folders"]}}, "/?Action=InitiateDocumentVersionUpload"=>{"get"=>{"summary"=>"Initiate Document Version Upload", "description"=>"Creates a new document object and version object.", "operationId"=>"initiateDocumentVersionUpload", "x-api-path-slug"=>"actioninitiatedocumentversionupload-get", "parameters"=>[{"in"=>"query", "name"=>"ContentType", "description"=>"The content type of the document", "type"=>"string"}, {"in"=>"query", "name"=>"DocumentSizeInBytes", "description"=>"The size of the document, in bytes", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The ID of the document", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the document", "type"=>"string"}, {"in"=>"query", "name"=>"ParentFolderId", "description"=>"The ID of the parent folder", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents"]}}, "/?Action=RemoveAllResourcePermissions"=>{"get"=>{"summary"=>"Remove All Resource Permissions", "description"=>"Removes all the permissions from the specified resource.", "operationId"=>"removeAllResourcePermissions", "x-api-path-slug"=>"actionremoveallresourcepermissions-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceId", "description"=>"The ID of the resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permissions"]}}, "/?Action=RemoveResourcePermission"=>{"get"=>{"summary"=>"Remove Resource Permission", "description"=>"Removes the permission for the specified principal from the specified resource.", "operationId"=>"removeResourcePermission", "x-api-path-slug"=>"actionremoveresourcepermission-get", "parameters"=>[{"in"=>"query", "name"=>"PrincipalId", "description"=>"The principal ID of the resource", "type"=>"string"}, {"in"=>"query", "name"=>"PrincipalType", "description"=>"The principal type of the resource", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceId", "description"=>"The ID of the resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permissions"]}}, "/?Action=UpdateDocument"=>{"get"=>{"summary"=>"Update Document", "description"=>"Updates the specified attributes of the specified document.", "operationId"=>"updateDocument", "x-api-path-slug"=>"actionupdatedocument-get", "parameters"=>[{"in"=>"query", "name"=>"DocumentId", "description"=>"The ID of the document", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents"]}}, "/?Action=UpdateDocumentVersion"=>{"get"=>{"summary"=>"Update Document Version", "description"=>"Changes the status of the document version to ACTIVE.", "operationId"=>"updateDocumentVersion", "x-api-path-slug"=>"actionupdatedocumentversion-get", "parameters"=>[{"in"=>"query", "name"=>"DocumentId", "description"=>"The ID of the document", "type"=>"string"}, {"in"=>"query", "name"=>"VersionId", "description"=>"The version ID of the document", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents"]}}, "/?Action=UpdateFolder"=>{"get"=>{"summary"=>"Update Folder", "description"=>"Updates the specified attributes of the specified folder.", "operationId"=>"updateFolder", "x-api-path-slug"=>"actionupdatefolder-get", "parameters"=>[{"in"=>"query", "name"=>"FolderId", "description"=>"The ID of the folder", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folders"]}}, "/?Action=UpdateUser"=>{"get"=>{"summary"=>"Update User", "description"=>"Updates the specified attributes of the specified user, and grants or revokes \n administrative privileges to the Amazon WorkDocs site.", "operationId"=>"updateUser", "x-api-path-slug"=>"actionupdateuser-get", "parameters"=>[{"in"=>"query", "name"=>"UserId", "description"=>"The ID of the user", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}}}, "apis"=>{"name"=>"AWS WorkDocs", "x-slug"=>"aws-workdocs", "description"=>"Amazon WorkDocs is a fully managed, secure enterprise storage and sharing service with strong administrative controls and feedback capabilities that improve user productivity.Users can comment on files, send them to others for feedback, and upload new versions without having to resort to emailing multiple versions of their files as attachments. Users can take advantage of these capabilities wherever they are, using the device of their choice, including PCs, Macs, tablets and phones. Amazon WorkDocs offers IT administrators the option of integrating with existing corporate directories, flexible sharing policies and control of the location where data is stored. Customers can get started using Amazon WorkDocs with a 30-day free trial providing 1 TB of storage per user for up to 50 users.Amazon WorkDocs offers an Administrative SDK, currently in public preview. The Administrative SDK allows you to integrate your applications with Amazon WorkDocs by performing content and permissions updates, and managing users, programmatically. You can sign-up for the public preview here.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Enterprise-Applications_AmazonWorkDocs.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Documents,Profiles,Relative Data,Service API,Stack Network,Storage", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-workdocs/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS WorkDocs API", "x-api-slug"=>"aws-workdocs-api", "description"=>"Amazon WorkDocs is a fully managed, secure enterprise storage and sharing service with strong administrative controls and feedback capabilities that improve user productivity.Users can comment on files, send them to others for feedback, and upload new versions without having to resort to emailing multiple versions of their files as attachments. Users can take advantage of these capabilities wherever they are, using the device of their choice, including PCs, Macs, tablets and phones. Amazon WorkDocs offers IT administrators the option of integrating with existing corporate directories, flexible sharing policies and control of the location where data is stored. Customers can get started using Amazon WorkDocs with a 30-day free trial providing 1 TB of storage per user for up to 50 users.Amazon WorkDocs offers an Administrative SDK, currently in public preview. The Administrative SDK allows you to integrate your applications with Amazon WorkDocs by performing content and permissions updates, and managing users, programmatically. You can sign-up for the public preview here.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Enterprise-Applications_AmazonWorkDocs.png", "humanURL"=>"https://aws.amazon.com/workdocs/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Documents,Profiles,Relative Data,Service API,Stack Network,Storage", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-workdocs/aws-workdocs-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/workdocs/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/workdocs/faqs/"}, {"type"=>"x-forum", "url"=>"https://aws.amazon.com/workdocs/resources/#forum"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/workdocs/pricing/"}, {"type"=>"x-sdk", "url"=>"https://aws.amazon.com/workdocs/developers/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/workdocs/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
circleci{"circleci-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"CircleCI", "x-complete"=>1, "info"=>{"title"=>"CircleCI", "description"=>"the-circleci-api-is-a-restful-fullyfeatured-api-that-allows-you-to-do-almost-anything-in-circleci--you-can-access-all-information-and-trigger-all-actions--the-only-thing-we-dont-provide-access-to-is-billing-functions-which-must-be-done-from-the-circleci-web-ui-", "version"=>"1.0.0"}, "host"=>"circleci.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/me"=>{"get"=>{"summary"=>"Get Me", "description"=>"Provides information about the signed in user.", "operationId"=>"getMe", "x-api-path-slug"=>"me-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me"]}}, "/project/{username}/{project}"=>{"get"=>{"summary"=>"Get Project Username Project", "description"=>"Build summary for each of the last 30 builds for a single git repo.", "operationId"=>"getProjectUsernameProject", "x-api-path-slug"=>"projectusernameproject-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project"]}, "parameters"=>{"summary"=>"Parameters Project Username Project", "description"=>"Parameters project username project.", "operationId"=>"parametersProjectUsernameProject", "x-api-path-slug"=>"projectusernameproject-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Project", "Username", "Project"]}, "post"=>{"summary"=>"Add Project Username Project", "description"=>"Triggers a new build, returns a summary of the build.", "operationId"=>"postProjectUsernameProject", "x-api-path-slug"=>"projectusernameproject-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project"]}}, "/project/{username}/{project}/build-cache"=>{"delete"=>{"summary"=>"Delete Project Username Project Build Cache", "description"=>"Delete project username project build cache.", "operationId"=>"deleteProjectUsernameProjectBuildCache", "x-api-path-slug"=>"projectusernameprojectbuildcache-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project", "Build", "Cache"]}, "parameters"=>{"summary"=>"Parameters Project Username Project Build Cache", "description"=>"Parameters project username project build cache.", "operationId"=>"parametersProjectUsernameProjectBuildCache", "x-api-path-slug"=>"projectusernameprojectbuildcache-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Project", "Username", "Project", "Build", "Cache"]}}, "/project/{username}/{project}/checkout-key"=>{"get"=>{"summary"=>"Get Project Username Project Checkout Key", "description"=>"Get project username project checkout key.", "operationId"=>"getProjectUsernameProjectCheckoutKey", "x-api-path-slug"=>"projectusernameprojectcheckoutkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project", "Checkout", "Key"]}, "parameters"=>{"summary"=>"Parameters Project Username Project Checkout Key", "description"=>"Parameters project username project checkout key.", "operationId"=>"parametersProjectUsernameProjectCheckoutKey", "x-api-path-slug"=>"projectusernameprojectcheckoutkey-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Project", "Username", "Project", "Checkout", "Key"]}, "post"=>{"summary"=>"Add Project Username Project Checkout Key", "description"=>"Creates a new checkout key.\nOnly usable with a user API token.", "operationId"=>"postProjectUsernameProjectCheckoutKey", "x-api-path-slug"=>"projectusernameprojectcheckoutkey-post", "parameters"=>[{"in"=>"body", "name"=>"type", "description"=>"The type of key to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project", "Checkout", "Key"]}}, "/project/{username}/{project}/checkout-key/{fingerprint}"=>{"delete"=>{"summary"=>"Delete Project Username Project Checkout Key Fingerprint", "description"=>"Delete project username project checkout key fingerprint.", "operationId"=>"deleteProjectUsernameProjectCheckoutKeyFingerprint", "x-api-path-slug"=>"projectusernameprojectcheckoutkeyfingerprint-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project", "Checkout", "Key", "Fingerprint"]}, "get"=>{"summary"=>"Get Project Username Project Checkout Key Fingerprint", "description"=>"Get project username project checkout key fingerprint.", "operationId"=>"getProjectUsernameProjectCheckoutKeyFingerprint", "x-api-path-slug"=>"projectusernameprojectcheckoutkeyfingerprint-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project", "Checkout", "Key", "Fingerprint"]}, "parameters"=>{"summary"=>"Parameters Project Username Project Checkout Key Fingerprint", "description"=>"Parameters project username project checkout key fingerprint.", "operationId"=>"parametersProjectUsernameProjectCheckoutKeyFingerprint", "x-api-path-slug"=>"projectusernameprojectcheckoutkeyfingerprint-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Project", "Username", "Project", "Checkout", "Key", "Fingerprint"]}}, "/project/{username}/{project}/envvar"=>{"get"=>{"summary"=>"Get Project Username Project Envvar", "description"=>"Lists the environment variables for :project", "operationId"=>"getProjectUsernameProjectEnvvar", "x-api-path-slug"=>"projectusernameprojectenvvar-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project", "Envvar"]}, "parameters"=>{"summary"=>"Parameters Project Username Project Envvar", "description"=>"Parameters project username project envvar.", "operationId"=>"parametersProjectUsernameProjectEnvvar", "x-api-path-slug"=>"projectusernameprojectenvvar-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Project", "Username", "Project", "Envvar"]}, "post"=>{"summary"=>"Add Project Username Project Envvar", "description"=>"Add project username project envvar.", "operationId"=>"postProjectUsernameProjectEnvvar", "x-api-path-slug"=>"projectusernameprojectenvvar-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project", "Envvar"]}}, "/project/{username}/{project}/envvar/{name}"=>{"delete"=>{"summary"=>"Delete Project Username Project Envvar Name", "description"=>"Deletes the environment variable named ':name'", "operationId"=>"deleteProjectUsernameProjectEnvvarName", "x-api-path-slug"=>"projectusernameprojectenvvarname-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project", "Envvar", "Name"]}, "get"=>{"summary"=>"Get Project Username Project Envvar Name", "description"=>"Gets the hidden value of environment variable :name", "operationId"=>"getProjectUsernameProjectEnvvarName", "x-api-path-slug"=>"projectusernameprojectenvvarname-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project", "Envvar", "Name"]}, "parameters"=>{"summary"=>"Parameters Project Username Project Envvar Name", "description"=>"Parameters project username project envvar name.", "operationId"=>"parametersProjectUsernameProjectEnvvarName", "x-api-path-slug"=>"projectusernameprojectenvvarname-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Project", "Username", "Project", "Envvar", "Name"]}}, "/project/{username}/{project}/ssh-key"=>{"parameters"=>{"summary"=>"Parameters Project Username Project Ssh Key", "description"=>"Parameters project username project ssh key.", "operationId"=>"parametersProjectUsernameProjectSshKey", "x-api-path-slug"=>"projectusernameprojectsshkey-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Project", "Username", "Project", "Ssh", "Key"]}, "post"=>{"summary"=>"Add Project Username Project Ssh Key", "description"=>"Create an ssh key used to access external systems that require SSH key-based authentication", "operationId"=>"postProjectUsernameProjectSshKey", "x-api-path-slug"=>"projectusernameprojectsshkey-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project", "Ssh", "Key"]}}, "/project/{username}/{project}/tree/{branch}"=>{"parameters"=>{"summary"=>"Parameters Project Username Project Tree Branch", "description"=>"Parameters project username project tree branch.", "operationId"=>"parametersProjectUsernameProjectTreeBranch", "x-api-path-slug"=>"projectusernameprojecttreebranch-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Project", "Username", "Project", "Tree", "Branch"]}, "post"=>{"summary"=>"Add Project Username Project Tree Branch", "description"=>"Triggers a new build, returns a summary of the build.\nOptional build parameters can be set using an experimental API.\n\nNote: For more about build parameters, read about [using parameterized builds](https://circleci.com/docs/parameterized-builds/)", "operationId"=>"postProjectUsernameProjectTreeBranch", "x-api-path-slug"=>"projectusernameprojecttreebranch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project", "Tree", "Branch"]}}, "/project/{username}/{project}/{build_num}"=>{"get"=>{"summary"=>"Get Project Username Project Build Num", "description"=>"Full details for a single build. The response includes all of the fields from the build summary.\nThis is also the payload for the [notification webhooks](/docs/configuration/#notify), in which case this object is the value to a key named 'payload'.", "operationId"=>"getProjectUsernameProjectBuildNum", "x-api-path-slug"=>"projectusernameprojectbuild-num-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project", "Build", "Num"]}, "parameters"=>{"summary"=>"Parameters Project Username Project Build Num", "description"=>"Parameters project username project build num.", "operationId"=>"parametersProjectUsernameProjectBuildNum", "x-api-path-slug"=>"projectusernameprojectbuild-num-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Project", "Username", "Project", "Build", "Num"]}}, "/project/{username}/{project}/{build_num}/artifacts"=>{"get"=>{"summary"=>"Get Project Username Project Build Num Artifacts", "description"=>"Get project username project build num artifacts.", "operationId"=>"getProjectUsernameProjectBuildNumArtifacts", "x-api-path-slug"=>"projectusernameprojectbuild-numartifacts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project", "Build", "Num", "Artifacts"]}, "parameters"=>{"summary"=>"Parameters Project Username Project Build Num Artifacts", "description"=>"Parameters project username project build num artifacts.", "operationId"=>"parametersProjectUsernameProjectBuildNumArtifacts", "x-api-path-slug"=>"projectusernameprojectbuild-numartifacts-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Project", "Username", "Project", "Build", "Num", "Artifacts"]}}, "/project/{username}/{project}/{build_num}/cancel"=>{"parameters"=>{"summary"=>"Parameters Project Username Project Build Num Cancel", "description"=>"Parameters project username project build num cancel.", "operationId"=>"parametersProjectUsernameProjectBuildNumCancel", "x-api-path-slug"=>"projectusernameprojectbuild-numcancel-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Project", "Username", "Project", "Build", "Num", "Cancel"]}, "post"=>{"summary"=>"Add Project Username Project Build Num Cancel", "description"=>"Cancels the build, returns a summary of the build.", "operationId"=>"postProjectUsernameProjectBuildNumCancel", "x-api-path-slug"=>"projectusernameprojectbuild-numcancel-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project", "Build", "Num", "Cancel"]}}, "/project/{username}/{project}/{build_num}/retry"=>{"parameters"=>{"summary"=>"Parameters Project Username Project Build Num Retry", "description"=>"Parameters project username project build num retry.", "operationId"=>"parametersProjectUsernameProjectBuildNumRetry", "x-api-path-slug"=>"projectusernameprojectbuild-numretry-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Project", "Username", "Project", "Build", "Num", "Retry"]}, "post"=>{"summary"=>"Add Project Username Project Build Num Retry", "description"=>"Retries the build, returns a summary of the new build.", "operationId"=>"postProjectUsernameProjectBuildNumRetry", "x-api-path-slug"=>"projectusernameprojectbuild-numretry-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project", "Build", "Num", "Retry"]}}, "/project/{username}/{project}/{build_num}/tests"=>{"get"=>{"summary"=>"Get Project Username Project Build Num Tests", "description"=>"Provides test metadata for a build\nNote: [Learn how to set up your builds to collect test metadata](https://circleci.com/docs/test-metadata/)", "operationId"=>"getProjectUsernameProjectBuildNumTests", "x-api-path-slug"=>"projectusernameprojectbuild-numtests-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Username", "Project", "Build", "Num", "Tests"]}, "parameters"=>{"summary"=>"Parameters Project Username Project Build Num Tests", "description"=>"Parameters project username project build num tests.", "operationId"=>"parametersProjectUsernameProjectBuildNumTests", "x-api-path-slug"=>"projectusernameprojectbuild-numtests-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Project", "Username", "Project", "Build", "Num", "Tests"]}}, "/projects"=>{"get"=>{"summary"=>"Get Projects", "description"=>"List of all the projects you're following on CircleCI, with build information organized by branch.", "operationId"=>"getProjects", "x-api-path-slug"=>"projects-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/recent-builds"=>{"get"=>{"summary"=>"Get Recent Builds", "description"=>"Build summary for each of the last 30 recent builds, ordered by build_num.", "operationId"=>"getRecentBuilds", "x-api-path-slug"=>"recentbuilds-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recent", "Builds"]}}, "/user/heroku-key"=>{"post"=>{"summary"=>"Add User Heroku Key", "description"=>"Adds your Heroku API key to CircleCI, takes apikey as form param name.", "operationId"=>"postUserHerokuKey", "x-api-path-slug"=>"userherokukey-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Heroku", "Key"]}}}}, "apis"=>{"name"=>"CircleCI", "x-slug"=>"circleci", "description"=>"CircleCI???s continuous integration and delivery platform makes it easy for teams of all sizes to rapidly build and release quality software at scale. Build for Linux, macOS, and Android, in the cloud or behind your firewall.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28120-circleci.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"15983", "tags"=>"API Service Provider,Continuous Deployment,Continuous Integration,Developers,Enterprise,Orchestration,Profiles,Relative Data,SaaS,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"circleci/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"CircleCI", "x-api-slug"=>"circleci", "description"=>"CircleCI???s continuous integration and delivery platform makes it easy for teams of all sizes to rapidly build and release quality software at scale. Build for Linux, macOS, and Android, in the cloud or behind your firewall.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28120-circleci.jpg", "humanURL"=>"http://circleci.com", "baseURL"=>"https://circleci.com//api/v1", "tags"=>"API Service Provider,Continuous Deployment,Continuous Integration,Developers,Enterprise,Orchestration,Profiles,Relative Data,SaaS,Service API,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/circleci/circleci-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://circleci.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"https://circleci.com/blog/feed.xml"}, {"type"=>"x-case-studies", "url"=>"https://circleci.com/customers/"}, {"type"=>"x-change-log", "url"=>"https://circleci.com/changelog/"}, {"type"=>"x-contact-form", "url"=>"https://circleci.com/contact/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/circle-ci"}, {"type"=>"x-documentation", "url"=>"https://circleci.com/docs/"}, {"type"=>"x-email", "url"=>"press@circleci.com"}, {"type"=>"x-email", "url"=>"billing@circleci.com"}, {"type"=>"x-email", "url"=>"privacy@circleci.com"}, {"type"=>"x-email", "url"=>"sayhi@circleci.com"}, {"type"=>"x-github", "url"=>"https://github.com/circleci"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/circleci"}, {"type"=>"x-pricing", "url"=>"https://circleci.com/pricing/"}, {"type"=>"x-privacy-policy", "url"=>"https://circleci.com/privacy/"}, {"type"=>"x-selfservice-registration", "url"=>"https://circleci.com/signup/"}, {"type"=>"x-status", "url"=>"https://status.circleci.com/"}, {"type"=>"x-support", "url"=>"https://support.circleci.com/hc/en-us"}, {"type"=>"x-terms-of-service", "url"=>"https://circleci.com/terms-of-service/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/circleci"}, {"type"=>"x-website", "url"=>"http://circleci.com"}, {"type"=>"x-website", "url"=>"https://circleci.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
lyft{"lyft-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Lyft", "x-complete"=>1, "info"=>{"title"=>"Lyft", "description"=>"drive-your-app-to-success-with-lyfts-api", "contact"=>{"name"=>"Lyft", "url"=>"http://developer.lyft.com", "email"=>"api-support@lyft.com"}, "version"=>"1.0.0"}, "host"=>"api.lyft.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/cost"=>{"get"=>{"summary"=>"Cost estimates", "description"=>"Estimate the cost of taking a Lyft between two points.", "operationId"=>"GetCost", "x-api-path-slug"=>"cost-get", "parameters"=>[{"in"=>"query", "name"=>"end_lat", "description"=>"Latitude of the ending location"}, {"in"=>"query", "name"=>"end_lng", "description"=>"Longitude of the ending location"}, {"in"=>"query", "name"=>"start_lat", "description"=>"Latitude of the starting location"}, {"in"=>"query", "name"=>"start_lng", "description"=>"Longitude of the starting location"}], "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transportation"]}}, "/drivers"=>{"get"=>{"summary"=>"Available drivers nearby", "description"=>"The drivers endpoint returns a list of nearby drivers' lat and lng at a given location.", "operationId"=>"GetDrivers", "x-api-path-slug"=>"drivers-get", "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transportation"]}}, "/eta"=>{"get"=>{"summary"=>"Pickup ETAs", "description"=>"The ETA endpoint lets you know how quickly a Lyft driver can come get you", "operationId"=>"GetETA", "x-api-path-slug"=>"eta-get", "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transportation"]}}, "/profile"=>{"get"=>{"summary"=>"The user's general info", "description"=>"The v1 of this endpoint returns the user's ID, v2 will return more general info about the user. We require authentication for this endpoint, so we extract the user ID from the access token.", "operationId"=>"GetProfile", "x-api-path-slug"=>"profile-get", "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transportation"]}}, "/rides"=>{"get"=>{"summary"=>"List rides", "description"=>"Get a list of past & current rides for this passenger.", "operationId"=>"GetRides", "x-api-path-slug"=>"rides-get", "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transportation"]}, "post"=>{"summary"=>"Request a Lyft", "description"=>"Request a Lyft come pick you up at the given location.", "operationId"=>"NewRide", "x-api-path-slug"=>"rides-post", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"Ride request information", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transportation"]}}, "/rides/{id}"=>{"get"=>{"summary"=>"Get the ride detail of a given ride ID", "description"=>"Get the status of a ride along with information about the driver, vehicle and price of a given ride ID", "operationId"=>"GetRide", "x-api-path-slug"=>"ridesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the ride"}], "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transportation"]}}, "/rides/{id}/cancel"=>{"post"=>{"summary"=>"Cancel a ongoing requested ride", "description"=>"Cancel a ongoing ride which was requested earlier by providing the ride id.", "operationId"=>"CancelRide", "x-api-path-slug"=>"ridesidcancel-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the ride"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transportation"]}}, "/rides/{id}/destination"=>{"put"=>{"summary"=>"Update the destination of the ride", "description"=>"Add or update the ride's destination. Note that the ride must still be active (not droppedOff or canceled), and that destinations on Lyft Line rides can not be changed.", "operationId"=>"SetRideDestination", "x-api-path-slug"=>"ridesiddestination-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the ride"}, {"in"=>"body", "name"=>"request", "description"=>"The coordinates and optional address of the destination", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transportation"]}}, "/rides/{id}/rating"=>{"put"=>{"summary"=>"Add the passenger's rating, feedback, and tip", "description"=>"Add the passenger's 1 to 5 star rating of the ride, optional written feedback, and optional tip amount in minor units and currency. The ride must already be dropped off, and ratings must be given within 24 hours of drop off. For purposes of display, 5 is considered the default rating. When this endpoint is successfully called, payment processing will begin.", "operationId"=>"SetRideRating", "x-api-path-slug"=>"ridesidrating-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the ride"}, {"in"=>"body", "name"=>"request", "description"=>"The rating and optional feedback", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transportation"]}}, "/rides/{id}/receipt"=>{"get"=>{"summary"=>"Get the receipt of the rides.", "description"=>"Get the receipt information of a processed ride by providing the ride id. Receipts will only be available to view once the payment has been processed. In the case of canceled ride, cancellation penalty is included if applicable.", "operationId"=>"GetRideReceipt", "x-api-path-slug"=>"ridesidreceipt-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the ride"}], "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transportation"]}}, "/ridetypes"=>{"get"=>{"summary"=>"Types of rides", "description"=>"The ride types endpoint returns information about what kinds of Lyft rides you can request at a given location.", "operationId"=>"GetRideTypes", "x-api-path-slug"=>"ridetypes-get", "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transportation"]}}, "/sandbox/primetime"=>{"put"=>{"summary"=>"Preset Prime Time percentage", "description"=>"Preset a Prime Time percentage in the region surrounding the specified location. This Prime Time percentage will be applied when requesting cost, or when requesting a ride in sandbox mode.", "operationId"=>"SetPrimeTime", "x-api-path-slug"=>"sandboxprimetime-put", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"Prime Time to be preset in the region surrounding the lat, lng", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transportation"]}}, "/sandbox/rides/{id}"=>{"put"=>{"summary"=>"Propagate ride through ride status", "description"=>"Propagate a sandbox-ride through various ride status", "operationId"=>"SetRideStatus", "x-api-path-slug"=>"sandboxridesid-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the ride"}, {"in"=>"body", "name"=>"request", "description"=>"status to propagate the ride into", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transportation"]}}, "/sandbox/ridetypes"=>{"put"=>{"summary"=>"Preset types of rides for sandbox", "description"=>"The sandbox-ridetypes endpoint allows you to preset the ridetypes in the region surrounding the specified latitude and longitude to allow testing different scenarios", "operationId"=>"SetRideTypes", "x-api-path-slug"=>"sandboxridetypes-put", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"Ridetypes to be preset in the region surrounding the lat, lng", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transportation"]}}, "/sandbox/ridetypes/{ride_type}"=>{"put"=>{"summary"=>"Driver availability for processing ride request", "description"=>"Set driver availability for the provided ride_type in the city/region surrounding the specified location", "operationId"=>"SetRideTypeAvailability", "x-api-path-slug"=>"sandboxridetypesride-type-put", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"Driver availability to be preset in the region surrounding the lat, lng", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transportation"]}}}}, "apis"=>{"name"=>"Lyft", "x-slug"=>"lyft", "description"=>"Lyft is an on-demand transportation company based in San Francisco, California.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19028-lyft.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"6522", "tags"=>"API Provider,Imports,Marketplace,Mobile,New,Profiles,Relative Data,Service API,Services,Stack,Stack Network,Transportation", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"lyft/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Lyft", "x-api-slug"=>"lyft", "description"=>"Lyft is an on-demand transportation company based in San Francisco, California.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19028-lyft.jpg", "humanURL"=>"https://www.lyft.com/", "baseURL"=>"https://api.lyft.com//v1", "tags"=>"API Provider,Imports,Marketplace,Mobile,New,Profiles,Relative Data,Service API,Services,Stack,Stack Network,Transportation", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/lyft/lyft-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://developer.lyft.com/docs/authentication"}, {"type"=>"x-blog", "url"=>"http://blog.lyft.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.lyft.com/posts?format=RSS"}, {"type"=>"x-branding", "url"=>"https://developer.lyft.com/docs/brand-guidelines"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/lyft"}, {"type"=>"x-developer", "url"=>"https://www.lyft.com/developers"}, {"type"=>"x-documentation", "url"=>"http://petstore.swagger.io/?url=https://api.lyft.com/v1/spec"}, {"type"=>"x-github", "url"=>"https://github.com/lyft"}, {"type"=>"x-manage-applications", "url"=>"https://www.lyft.com/developers/manage"}, {"type"=>"x-openapi-spec", "url"=>"https://api.lyft.com/v1/spec"}, {"type"=>"x-partners", "url"=>"https://www.lyft.com/partnerships"}, {"type"=>"x-rate-limits", "url"=>"https://developer.lyft.com/docs/rate-limits"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/lyft"}, {"type"=>"x-website", "url"=>"https://www.lyft.com/"}, {"type"=>"x-website", "url"=>"http://lyft.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
nationwide-building-society{"nationwide-building-society-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Nationwide Building Society", "x-complete"=>1, "info"=>{"title"=>"Nationwide Building Society", "description"=>"this-is-an-openapi-definition-for-the-standard-set-of-open-banking-httpopenbankingapis-io-apis-from-nationwide-building-society-", "termsOfService"=>"https://www.openbanking.org.uk/open-licence/", "contact"=>{"name"=>"API Evangelist", "url"=>"https://apievangelist.com", "email"=>"info@apievangelist.com"}, "version"=>"1.0.0"}, "host"=>"openapi.nationwide.co.uk", "basePath"=>"open-banking/v2.1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"atms/"=>{"get"=>{"summary"=>"Get ATMs", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can provide multiple ATMs.", "operationId"=>"getATMS", "x-api-path-slug"=>"atms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ATMs"]}}, "branches/"=>{"get"=>{"summary"=>"Get Branches", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple branches.", "operationId"=>"getBranches", "x-api-path-slug"=>"branches-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branches"]}}, "personal-current-accounts/"=>{"get"=>{"summary"=>"Get Current Personal Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple PCA products.", "operationId"=>"getCurrentPersonalAccounts", "x-api-path-slug"=>"personalcurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "Personal", "Accounts"]}}, "business-current-accounts/"=>{"get"=>{"summary"=>"Get Current Business Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple BCA products.", "operationId"=>"getCurentBusinessAccounts", "x-api-path-slug"=>"businesscurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "Business", "Accounts"]}}, "unsecured-sme-loans/"=>{"get"=>{"summary"=>"Get Unsecured SME Loans", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Unsecured Loan products.", "operationId"=>"pathOperation", "x-api-path-slug"=>"unsecuredsmeloans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsecured", "SME", "Loans"]}}, "commercial-credit-cards/"=>{"get"=>{"summary"=>"Get Commercial Credit Cards", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Commercial Credit Card products.", "operationId"=>"getCommercialCreditCards", "x-api-path-slug"=>"commercialcreditcards-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commercial", "Credit", "Cards"]}}}}, "apis"=>{"name"=>"Nationwide Building Society", "x-slug"=>"nationwide-building-society", "description"=>"Nationwide Building Society is a British mutual financial institution and the largest building society in the world with over 15 million members. It has its headquarters in Swindon, with an office in Threadneedle Street, London, and administration centres based in Bournemouth, Northampton and Dunfermline. Made up of over a hundred mergers — most notably its merger with Anglia Building Society in 1987 and Portman Building Society in 2007 — Nationwide is now the second largest provider of household savings and mortgages in the UK.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/nationwide-building-society.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Provider,ATMs,Banking,General Data,Profiles,Relative Data,UK Banks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"nationwide-building-society/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Nationwide Building Society", "x-api-slug"=>"nationwide-building-society", "description"=>"Nationwide Building Society is a British mutual financial institution and the largest building society in the world with over 15 million members. It has its headquarters in Swindon, with an office in Threadneedle Street, London, and administration centres based in Bournemouth, Northampton and Dunfermline. Made up of over a hundred mergers — most notably its merger with Anglia Building Society in 1987 and Portman Building Society in 2007 — Nationwide is now the second largest provider of household savings and mortgages in the UK.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/nationwide-building-society.png", "humanURL"=>"https://www.nationwide.co.uk/", "baseURL"=>"https://openapi.nationwide.co.uk/open-banking/v2.1/", "tags"=>"API Provider,ATMs,Banking,General Data,Profiles,Relative Data,UK Banks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/nationwide-building-society/commercialcreditcards-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/nationwide-building-society/nationwide-building-society-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"http://openbankingapis.io/uk/nationwide-building-society"}, {"type"=>"x-website", "url"=>"https://www.nationwide.co.uk/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
uebermaps{"uebermaps-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"uebermaps", "x-complete"=>1, "info"=>{"title"=>"uebermaps", "description"=>"enable-people-to-store-spots-on-public-and-private-maps", "termsOfService"=>"https://uebermaps.com/terms/", "contact"=>{"name"=>"uebermaps API Team"}, "version"=>"2.0"}, "host"=>"uebermaps.com", "basePath"=>"/api/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/account"=>{"patch"=>{"summary"=>"Update account", "description"=>"Update account. Wrap map parameters in [user].", "operationId"=>"account.patch", "x-api-path-slug"=>"account-patch", "parameters"=>[{"in"=>"body", "name"=>"user", "description"=>"user attributes", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Account"]}}, "/attachments/{id}"=>{"delete"=>{"summary"=>"Delete attachment", "description"=>"Delete attachment.", "operationId"=>"attachments.id.delete", "x-api-path-slug"=>"attachmentsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Attachment id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Attachment"]}}, "/authentication"=>{"post"=>{"summary"=>"Sign in user", "description"=>"Sign in user. Wrap authentication parameters in [user].", "operationId"=>"authentication.post", "x-api-path-slug"=>"authentication-post", "parameters"=>[{"in"=>"body", "name"=>"user", "description"=>"user authentication attributes", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Sign", "In", "User"]}}, "/collaborator_invitations"=>{"get"=>{"summary"=>"List your collaborator invitations", "description"=>"List your collaborator invitations.", "operationId"=>"collaborator_invitations.get", "x-api-path-slug"=>"collaborator-invitations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Your", "Collaborator", "Invitations"]}, "post"=>{"summary"=>"Invite user to collaborate on map", "description"=>"Invite user to collaborate on map.", "operationId"=>"collaborator_invitations.post", "x-api-path-slug"=>"collaborator-invitations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Supply map_id and either a comma separated list of user_ids or emails", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Invite", "User", "To", "Collaborate", "On", "Map"]}}, "/collaborator_invitations/{id}"=>{"delete"=>{"summary"=>"Delete collaborator invitation", "description"=>"Delete collaborator invitation.", "operationId"=>"collaborator_invitations.id.delete", "x-api-path-slug"=>"collaborator-invitationsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Collaborator invitation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Collaborator", "Invitation"]}, "get"=>{"summary"=>"Show collaborator invitation", "description"=>"Show collaborator invitation", "operationId"=>"collaborator_invitations.id.get", "x-api-path-slug"=>"collaborator-invitationsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Collaborator invitation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Show", "Collaborator", "Invitation"]}, "patch"=>{"summary"=>"Accept collaborator invitation.", "description"=>"Accept collaborator invitation.", "operationId"=>"collaborator_invitations.id.patch", "x-api-path-slug"=>"collaborator-invitationsid-patch", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Collaborator invitation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Accept", "Collaborator", "Invitation"]}}, "/comments/{id}"=>{"delete"=>{"summary"=>"Delete comment", "description"=>"Delete comment.", "operationId"=>"comments.id.delete", "x-api-path-slug"=>"commentsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Comment id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Comment"]}, "patch"=>{"summary"=>"Update comment", "description"=>"Update comment. Wrap comment parameters in [comment].", "operationId"=>"comments.id.patch", "x-api-path-slug"=>"commentsid-patch", "parameters"=>[{"in"=>"body", "name"=>"comment", "description"=>"Comment attributes", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Comment id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Comment"]}}, "/events"=>{"get"=>{"summary"=>"List your own events", "description"=>"List your own events.", "operationId"=>"events.get", "x-api-path-slug"=>"events-get", "parameters"=>[{"in"=>"query", "name"=>"bounds", "description"=>"To refine your event index request to contain only events within a geographical box pass the followng bounds parameters"}, {"in"=>"query", "name"=>"timeframe_end", "description"=>"End of time range of event (ISO 8601 date format)"}, {"in"=>"query", "name"=>"timeframe_start", "description"=>"Begin of time range of event (ISO 8601 date format)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Your", "Own", "Events"]}}, "/events/{id}"=>{"delete"=>{"summary"=>"Delete event", "description"=>"Delete event.", "operationId"=>"events.id.delete", "x-api-path-slug"=>"eventsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Event id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Event"]}, "get"=>{"summary"=>"Get event", "description"=>"Get basic information about an event", "operationId"=>"events.id.get", "x-api-path-slug"=>"eventsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of event"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Event"]}, "patch"=>{"summary"=>"Update event", "description"=>"Update event. Wrap event parameters in [event].", "operationId"=>"events.id.patch", "x-api-path-slug"=>"eventsid-patch", "parameters"=>[{"in"=>"body", "name"=>"event", "description"=>"Event attributes", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Event id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Event"]}}, "/maps"=>{"get"=>{"summary"=>"List your own maps", "description"=>"List your own maps.", "operationId"=>"maps.get", "x-api-path-slug"=>"maps-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Your", "Own", "Maps"]}, "post"=>{"summary"=>"Create map", "description"=>"Create map. Wrap map parameters in [map]. To add a map header picture pass a base64 encoded string to [map][picture].", "operationId"=>"maps.post", "x-api-path-slug"=>"maps-post", "parameters"=>[{"in"=>"body", "name"=>"map", "description"=>"map attributes", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Map"]}}, "/maps/search"=>{"get"=>{"summary"=>"Search maps", "description"=>"Search maps", "operationId"=>"maps.search.get", "x-api-path-slug"=>"mapssearch-get", "parameters"=>[{"in"=>"query", "name"=>"d", "description"=>"Distance"}, {"in"=>"query", "name"=>"lat", "description"=>"Latitude for search radius (default distance: 2000 meter)"}, {"in"=>"query", "name"=>"lon", "description"=>"Longitude for search radius (default distance: 2000 meter)"}, {"in"=>"query", "name"=>"q", "description"=>"Query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Search", "Maps"]}}, "/maps/{id}"=>{"delete"=>{"summary"=>"Delete map", "description"=>"Delete map.", "operationId"=>"maps.id.delete", "x-api-path-slug"=>"mapsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"map id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Map"]}, "get"=>{"summary"=>"Get map", "description"=>"Get basic information about a map", "operationId"=>"maps.id.get", "x-api-path-slug"=>"mapsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of map"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Map"]}, "patch"=>{"summary"=>"Update map", "description"=>"Update map. Wrap map parameters in [map]. To update the map header picture pass a base64 encoded string to [map][picture].", "operationId"=>"maps.id.patch", "x-api-path-slug"=>"mapsid-patch", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"map id"}, {"in"=>"body", "name"=>"map", "description"=>"map settings attributes", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Map"]}}, "/maps/{id}/attachments"=>{"get"=>{"summary"=>"List attachments for a given map", "description"=>"List attachments for a given map.", "operationId"=>"maps.id.attachments.get", "x-api-path-slug"=>"mapsidattachments-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Map id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Attachmentsa", "Given", "Map"]}, "post"=>{"summary"=>"Upload map attachment", "description"=>"Upload map attachment. Wrap attachment parameters in [attachment]", "operationId"=>"maps.id.attachments.post", "x-api-path-slug"=>"mapsidattachments-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Map id"}, {"in"=>"body", "name"=>"image", "description"=>"Base64 encoded image", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Upload", "Map", "Attachment"]}}, "/maps/{id}/collaborators/"=>{"get"=>{"summary"=>"List collaborators of a map", "description"=>"List collaborators of a map.", "operationId"=>"maps.id.collaborators.get", "x-api-path-slug"=>"mapsidcollaborators-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Map id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Collaborators", "Of", "Map"]}}, "/maps/{id}/collaborators/{user_id}"=>{"delete"=>{"summary"=>"Delete collaboration", "description"=>"Delete collaboration.", "operationId"=>"maps.id.collaborators.user_id.delete", "x-api-path-slug"=>"mapsidcollaboratorsuser-id-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"map id"}, {"in"=>"path", "name"=>"user_id", "description"=>"user id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Collaboration"]}, "patch"=>{"summary"=>"Update collaborator", "description"=>"Update collaborator. Wrap collaborator parameters in [collaborator]", "operationId"=>"maps.id.collaborators.user_id.patch", "x-api-path-slug"=>"mapsidcollaboratorsuser-id-patch", "parameters"=>[{"in"=>"body", "name"=>"collaborator", "description"=>"collaborator attributes", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"map id"}, {"in"=>"path", "name"=>"user_id", "description"=>"user id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Collaborator"]}}, "/maps/{id}/comments"=>{"get"=>{"summary"=>"List comments for a given map", "description"=>"List comments for a given map.", "operationId"=>"maps.id.comments.get", "x-api-path-slug"=>"mapsidcomments-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of map"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Commentsa", "Given", "Map"]}, "post"=>{"summary"=>"Create map comment", "description"=>"Create map comment. Wrap comment parameters in [comment].", "operationId"=>"maps.id.comments.post", "x-api-path-slug"=>"mapsidcomments-post", "parameters"=>[{"in"=>"body", "name"=>"comment", "description"=>"comment attributes", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"map id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Map", "Comment"]}}, "/maps/{id}/respots"=>{"get"=>{"summary"=>"List respots of a map", "description"=>"List respots of a map.", "operationId"=>"maps.id.respots.get", "x-api-path-slug"=>"mapsidrespots-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Map Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Respots", "Of", "Map"]}}, "/maps/{id}/spots"=>{"get"=>{"summary"=>"List spots for a given map", "description"=>"List spots for a given map.", "operationId"=>"maps.id.spots.get", "x-api-path-slug"=>"mapsidspots-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of map"}, {"in"=>"query", "name"=>"order", "description"=>"Order of spots"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Spotsa", "Given", "Map"]}, "post"=>{"summary"=>"Create spot", "description"=>"Create spot. Wrap parameters in [spot]. To add a spot picture pass a base64 encoded string to [spot][picture].", "operationId"=>"maps.id.spots.post", "x-api-path-slug"=>"mapsidspots-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of map"}, {"in"=>"body", "name"=>"spot", "description"=>"spot attributes", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Spot"]}}, "/maps/{id}/subscriptions"=>{"delete"=>{"summary"=>"Unsubscribe from map", "description"=>"Unsubscribe from map.", "operationId"=>"maps.id.subscriptions.delete", "x-api-path-slug"=>"mapsidsubscriptions-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"map id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Unsubscribe", "From", "Map"]}, "get"=>{"summary"=>"List subscriptions for a given map", "description"=>"List subscriptions for a given map.", "operationId"=>"maps.id.subscriptions.get", "x-api-path-slug"=>"mapsidsubscriptions-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of map"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Subscriptionsa", "Given", "Map"]}}, "/maps/{map_id}/spots/{id}"=>{"get"=>{"summary"=>"Get spot", "description"=>"Get basic information about a spot", "operationId"=>"maps.map_id.spots.id.get", "x-api-path-slug"=>"mapsmap-idspotsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of spot"}, {"in"=>"path", "name"=>"map_id", "description"=>"Id of map"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Spot"]}}, "/maps/{map_id}/spots/{spot_id}/respot"=>{"delete"=>{"summary"=>"Delete respot from map by spot id", "description"=>"Delete respot from map by spot id.", "operationId"=>"maps.map_id.spots.spot_id.respot.delete", "x-api-path-slug"=>"mapsmap-idspotsspot-idrespot-delete", "parameters"=>[{"in"=>"path", "name"=>"map_id", "description"=>"Map Id"}, {"in"=>"path", "name"=>"spot_id", "description"=>"Spot Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Respot", "From", "Map", "By", "Spot", "Id"]}}, "/respot_maps"=>{"get"=>{"summary"=>"List maps that user can respot to", "description"=>"List maps that user can respot to.", "operationId"=>"respot_maps.get", "x-api-path-slug"=>"respot-maps-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Maps", "That", "User", "Can", "Respot", "To"]}}, "/respots/{id}"=>{"delete"=>{"summary"=>"Delete respot", "description"=>"Delete respot.", "operationId"=>"respots.id.delete", "x-api-path-slug"=>"respotsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Respot Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Respot"]}, "get"=>{"summary"=>"Get respot", "description"=>"Get basic information about a respot", "operationId"=>"respots.id.get", "x-api-path-slug"=>"respotsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of respot"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Respot"]}}, "/share/map/{id}"=>{"get"=>{"summary"=>"Get secret access token to share map", "description"=>"Get secret access token of an uebermap with access set to 'Secret link'. Pass the 'token' on every request you make to access this uebermap and its resources. F.e. token=1-x_gqu7eLBe3uKoAGAGXy", "operationId"=>"share.map.id.get", "x-api-path-slug"=>"sharemapid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of map"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Secret", "Access", "Token", "To", "Share", "Map"]}}, "/spots"=>{"get"=>{"summary"=>"List your own spots", "description"=>"List your own spots.", "operationId"=>"spots.get", "x-api-path-slug"=>"spots-get", "parameters"=>[{"in"=>"query", "name"=>"order", "description"=>"Order of spots"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Your", "Own", "Spots"]}}, "/spots/search"=>{"get"=>{"summary"=>"Search spots", "description"=>"Search spots", "operationId"=>"spots.search.get", "x-api-path-slug"=>"spotssearch-get", "parameters"=>[{"in"=>"query", "name"=>"d", "description"=>"Distance"}, {"in"=>"query", "name"=>"lat", "description"=>"Latitude for search radius (2 km)"}, {"in"=>"query", "name"=>"lon", "description"=>"Longitude for search radius (2 km)"}, {"in"=>"query", "name"=>"q", "description"=>"Query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Search", "Spots"]}}, "/spots/{id}"=>{"delete"=>{"summary"=>"Delete spot", "description"=>"Delete spot.", "operationId"=>"spots.id.delete", "x-api-path-slug"=>"spotsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"spot id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Spot"]}, "patch"=>{"summary"=>"Update spot", "description"=>"Update spot. Wrap parameters in [spot]. To update the spot picture pass a base64 encoded string to [spot][picture].", "operationId"=>"spots.id.patch", "x-api-path-slug"=>"spotsid-patch", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"spot id"}, {"in"=>"body", "name"=>"spot", "description"=>"spot attributes", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Spot"]}}, "/spots/{id}/attachments"=>{"get"=>{"summary"=>"List attachments for a given spot", "description"=>"List attachments for a given spot.", "operationId"=>"spots.id.attachments.get", "x-api-path-slug"=>"spotsidattachments-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Spot id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Attachmentsa", "Given", "Spot"]}, "post"=>{"summary"=>"Upload spot attachment", "description"=>"Upload spot attachment. Wrap attachment parameters in [attachment]", "operationId"=>"spots.id.attachments.post", "x-api-path-slug"=>"spotsidattachments-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Spot id"}, {"in"=>"body", "name"=>"image", "description"=>"Base64 encoded image", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Upload", "Spot", "Attachment"]}}, "/spots/{id}/comments"=>{"get"=>{"summary"=>"List comments for a given spot", "description"=>"List comments for a given spot.", "operationId"=>"spots.id.comments.get", "x-api-path-slug"=>"spotsidcomments-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of spot"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Commentsa", "Given", "Spot"]}, "post"=>{"summary"=>"Create spot comment", "description"=>"Create spot comment. Wrap comment parameters in [comment].", "operationId"=>"spots.id.comments.post", "x-api-path-slug"=>"spotsidcomments-post", "parameters"=>[{"in"=>"body", "name"=>"comment", "description"=>"comment attributes", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"spot id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Spot", "Comment"]}}, "/spots/{id}/events"=>{"get"=>{"summary"=>"List events for a given spot", "description"=>"List maps for a given spot.", "operationId"=>"spots.id.events.get", "x-api-path-slug"=>"spotsidevents-get", "parameters"=>[{"in"=>"query", "name"=>"bounds", "description"=>"To refine your event index request to contain only events within a geographical box pass the followng bounds parameters"}, {"in"=>"path", "name"=>"id", "description"=>"Id of spot"}, {"in"=>"query", "name"=>"timeframe_end", "description"=>"End of time range of event (ISO 8601 date format)"}, {"in"=>"query", "name"=>"timeframe_start", "description"=>"Begin of time range of event (ISO 8601 date format)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Eventsa", "Given", "Spot"]}, "post"=>{"summary"=>"Create event", "description"=>"Create event. Wrap map parameters in [event].", "operationId"=>"spots.id.events.post", "x-api-path-slug"=>"spotsidevents-post", "parameters"=>[{"in"=>"body", "name"=>"event", "description"=>"Event attributes", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Spot id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Event"]}}, "/spots/{id}/respots"=>{"post"=>{"summary"=>"Respot a spot onto a map", "description"=>"Respot a spot onto a map.", "operationId"=>"spots.id.respots.post", "x-api-path-slug"=>"spotsidrespots-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Spot Id"}, {"in"=>"body", "name"=>"map_id", "description"=>"Map Id", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Respot", "Spot", "Onto", "Map"]}}, "/subscriptions"=>{"get"=>{"summary"=>"List subscriptions. Pass no parameters to get own subscriptions", "description"=>"List subscriptions.", "operationId"=>"subscriptions.get", "x-api-path-slug"=>"subscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"map_id", "description"=>"Id of map"}, {"in"=>"query", "name"=>"user_id", "description"=>"Id of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Subscriptions", "", "Pass", "No", "Parameters", "To", "Get", "Own", "Subscriptions"]}, "post"=>{"summary"=>"Create map subscription", "description"=>"Create map subscription.", "operationId"=>"subscriptions.post", "x-api-path-slug"=>"subscriptions-post", "parameters"=>[{"in"=>"body", "name"=>"map_id", "description"=>"map id", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Map", "Subscription"]}}, "/trends/latest"=>{"get"=>{"summary"=>"List latest maps", "description"=>"List latest maps.", "operationId"=>"trends.latest.get", "x-api-path-slug"=>"trendslatest-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Latest", "Maps"]}}, "/trends/recommended"=>{"get"=>{"summary"=>"List recommended maps", "description"=>"List recommended maps.", "operationId"=>"trends.recommended.get", "x-api-path-slug"=>"trendsrecommended-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Recommended", "Maps"]}}, "/users/search"=>{"get"=>{"summary"=>"Search users", "description"=>"Search users", "operationId"=>"users.search.get", "x-api-path-slug"=>"userssearch-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"Query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Search", "Users"]}}, "/users/{id}"=>{"get"=>{"summary"=>"Get user profile", "description"=>"Get profile a user", "operationId"=>"users.id.get", "x-api-path-slug"=>"usersid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "User", "Profile"]}}, "/users/{user_id}/maps"=>{"get"=>{"summary"=>"List maps for a given user", "description"=>"List maps for a given user.", "operationId"=>"users.user_id.maps.get", "x-api-path-slug"=>"usersuser-idmaps-get", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"Id of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Mapsa", "Given", "User"]}}}}, "apis"=>{"name"=>"uebermaps", "x-slug"=>"uebermaps", "description"=>"uebermaps is a platform for everyone to create and share maps with your favorite spots. uebermaps are interactive maps that enable people to collect interesting places, collaborate, upload photos and share your public or private maps with your friends and family. If you use uebermaps for your mapping community, as a tour guide for friends or as your unlimited geo storage is up to you.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/uebermaps.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"General Data,Maps", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"uebermaps/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"uebermaps", "x-api-slug"=>"uebermaps", "description"=>"uebermaps is a platform for everyone to create and share maps with your favorite spots. uebermaps are interactive maps that enable people to collect interesting places, collaborate, upload photos and share your public or private maps with your friends and family. If you use uebermaps for your mapping community, as a tour guide for friends or as your unlimited geo storage is up to you.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/uebermaps.png", "humanURL"=>"http://uebermaps.com", "baseURL"=>"https://uebermaps.com//api/v2", "tags"=>"General Data,Maps", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/uebermaps/uebermaps-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://uebermaps.com/api/v2#preface_authentication"}, {"type"=>"x-developer", "url"=>"https://uebermaps.com/api/v2"}, {"type"=>"x-support", "url"=>"https://uebermaps.com/contact"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/uebermaps"}, {"type"=>"x-website", "url"=>"http://uebermaps.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
cryptagio{"cryptagio-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Cryptagio", "x-complete"=>1, "info"=>{"title"=>"Cryptagio API", "description"=>"-public-private-methodstable--thead--tr-----td-bpublic-methodsb-td----td-bprivate-methodsb-td--tr--thead--tr-----td-no-authorization-required-td----td-authorization-required-td--trtable-authorization--to-use-private-methods-you-need-to-get-your-accesssecret-key-first-on-cryptagio-comhttpscryptagio-com--after-signed-up-and-verified-visit-api-tokens-page-to-get-your-keys----p-all-requests-to-the-private-methods-require-these-headershr--table--tr-----td-bxpublickeyb-td----td-your-access-key-td--tr--tr-----td-bxtonceb-td----td-tonce-is-a-timestamp-in-integer-stands-for-microseconds-elapsed-since-unix-epoch--tonce-must-be-within-30-seconds-of-servers-current-time--each-tonce-can-only-be-used-once-td--tr--tr-----td-bxsignatureb-td----td-signature-of-the-api-request-generated-by-you-use-your-secret-key-td--tr--table--hr----signaturefor-signature-use-ed25519httped25519-cr-yp-to--sign-the-message-using-your-secret-key-and-return-a-signed-message-----signature--signmessage-secret-key-message-is-a-combination-of-requestbody-uri-and-tonce-string----message--requestbodyuritonce--table--tr-----td-irequestbodyi-td----td-requestbody-in-the-json-format--required-only-for-post-methods-td--tr--tr-----td-iurii-td----td-request-path-like-ordersmylimit50orderdesc-td--tr--tr-----td-itonce-i-td----td-timestamp-in-integer-stands-for-microseconds-elapsed-since-unix-epoch-td--tr--tablemessage-examples-p-post-message-marketethbtcsidebidamount1price0-07typelimitorders1531816217872000000-p-get-message-ordersmylimit50orderdesc1531816217872000000hr--examplesp-curl-x-post-httpsapi-cryptagio-comorders-h-accept-applicationjson-h-xtonce-1531816217872000000-h-xsignature-signature-h-xpublickey-your-access-key-h-contenttype-applicationjson-d-marketbtcethsidebidamount1price0-07typelimit-p-curl-x-get-httpsapi-cryptagio-comordersmylimit50orderdesc-h-accept-applicationjson-h-xtonce-1531816217872000000-h-xsignature-signature-h-xpublickey-your-access-key", "version"=>"1.0.0"}, "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/info"=>{"get"=>{"summary"=>"Get Info", "description"=>"Get information..", "operationId"=>"getInfo", "x-api-path-slug"=>"info-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Info"]}}, "/ticker"=>{"get"=>{"summary"=>"Get Ticker", "description"=>"Get ticker of all markets..", "operationId"=>"getTicker", "x-api-path-slug"=>"ticker-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Ticker"]}}, "/trades"=>{"get"=>{"summary"=>"Get Trades", "description"=>"Get recent trades on market, each trade is included only once. Trades are sorted in reverse creation order.", "operationId"=>"getTrades", "x-api-path-slug"=>"trades-get", "parameters"=>[{"in"=>"query", "name"=>"from_time", "description"=>"Filter trades by time"}, {"in"=>"query", "name"=>"from_uuid", "description"=>"Filter trades by id"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit the number of returned trades"}, {"in"=>"query", "name"=>"market", "description"=>"Filter trades by market"}, {"in"=>"query", "name"=>"order", "description"=>"If set, returned orders will be sorted in specific order"}, {"in"=>"query", "name"=>"side"}, {"in"=>"query", "name"=>"to_time", "description"=>"Filter trades by time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Trades"]}}, "/trades/my"=>{"get"=>{"summary"=>"Get My Trades", "description"=>"Trades are sorted in reverse creation order.", "operationId"=>"getTradesMy", "x-api-path-slug"=>"tradesmy-get", "parameters"=>[{"in"=>"query", "name"=>"from_time", "description"=>"Filter trades by time"}, {"in"=>"query", "name"=>"from_uuid", "description"=>"Filter trades by id"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit the number of returned trades"}, {"in"=>"query", "name"=>"market", "description"=>"Filter trades by market"}, {"in"=>"query", "name"=>"order", "description"=>"If set, returned orders will be sorted in specific order"}, {"in"=>"query", "name"=>"side"}, {"in"=>"query", "name"=>"to_time", "description"=>"Filter trades by time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Trades", "My"]}}, "/balances"=>{"get"=>{"summary"=>"Get Balances", "description"=>"Get user balances..", "operationId"=>"getBalances", "x-api-path-slug"=>"balances-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Balances"]}}, "/orders/my"=>{"get"=>{"summary"=>"GetMy Orders", "description"=>"Trades are sorted in reverse creation order.", "operationId"=>"getOrdersMy", "x-api-path-slug"=>"ordersmy-get", "parameters"=>[{"in"=>"query", "name"=>"from_time", "description"=>"Filter trades by time"}, {"in"=>"query", "name"=>"from_uuid", "description"=>"Filter orders by id"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit the number of returned trades"}, {"in"=>"query", "name"=>"market", "description"=>"Filter orders by market"}, {"in"=>"query", "name"=>"order", "description"=>"If set, returned orders will be sorted in specific order"}, {"in"=>"query", "name"=>"side", "description"=>"Filter orders by side"}, {"in"=>"query", "name"=>"status", "description"=>"Filter orders by status"}, {"in"=>"query", "name"=>"to_time", "description"=>"Filter trades by time"}, {"in"=>"query", "name"=>"type", "description"=>"Filter orders by type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Orders", "My"]}}, "/orders"=>{"post"=>{"summary"=>"Post Orders", "description"=>"Accepts an array of JSON objects.", "operationId"=>"postOrders", "x-api-path-slug"=>"orders-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Orders"]}}, "/orders/cancel"=>{"post"=>{"summary"=>"Post Orders Cancel", "description"=>"Accepts JSON object. Cancels all orders if no parameters are passed.", "operationId"=>"postOrdersCancel", "x-api-path-slug"=>"orderscancel-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Orders", "Cancel"]}}, "/orders/{uuid}"=>{"delete"=>{"summary"=>"Delete Orders", "description"=>"Cancel order by uuid..", "operationId"=>"deleteOrdersUu", "x-api-path-slug"=>"ordersuuid-delete", "parameters"=>[{"in"=>"path", "name"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Orders", "Uuid"]}}}}, "apis"=>{"name"=>"Cryptagio", "x-slug"=>"cryptagio", "description"=>"Cryptagio is a global crypto exchange, providing a simple, fast and secure way to buy, sell or trade the world’s most eminent digital assets.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28851-api-cryptagio-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"892881", "tags"=>"Blockchain,Cryptocurrency,General Data", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"cryptagio/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Cryptagio", "x-api-slug"=>"cryptagio", "description"=>"Cryptagio is a global crypto exchange, providing a simple, fast and secure way to buy, sell or trade the world’s most eminent digital assets.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28851-api-cryptagio-com.jpg", "humanURL"=>"http://www.cryptagio.com", "baseURL"=>"https:////", "tags"=>"Blockchain,Cryptocurrency,General Data", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/cryptagio/ordersuuid-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/cryptagio/cryptagio-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://medium.com/@cryptagio"}, {"type"=>"x-blog-rss", "url"=>"view-source:https://medium.com/feed/@cryptagio"}, {"type"=>"x-openapi", "url"=>"https://api.cryptagio.com/docs/CryptagioAPI.json"}, {"type"=>"x-website", "url"=>"http://www.cryptagio.com"}, {"type"=>"x-documentation", "url"=>"https://api.cryptagio.com/docs/"}, {"type"=>"x-security", "url"=>"https://cryptagio.com/about"}, {"type"=>"x-support", "url"=>"https://support.cryptagio.com/hc/en-us"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/cryptagio"}, {"type"=>"x-website", "url"=>"https://api.cryptagio.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-blockchain-workbench{"azure-blockchain-workbench-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Blockchain Workbench", "x-complete"=>1, "info"=>{"title"=>"Azure Blockchain Workbench REST API", "description"=>"the-azure-blockchain-workbench-rest-api-is-a-workbench-extensibility-point-which-allows-developers-to-create-and-manage-blockchain-applications-manage-users-and-organizations-within-a-consortium-integrate-blockchain-applications-into-services-and-platforms-perform-transactions-on-a-blockchain-and-retrieve-transactional-and-contract-data-from-a-blockchain-", "version"=>"1.0.0"}, "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/v1/applications"=>{"get"=>{"summary"=>"Get Applications", "description"=>"Lists all blockchain applications to which a user has access in Workbench. Users who are Workbench administrators get\n all blockchain applications. Non-Workbench administrators get all blockchain applications for which they have at least one\n associated application role or an associated smart contract instance role.", "operationId"=>"ApplicationsGet", "x-api-path-slug"=>"apiv1applications-get", "parameters"=>[{"in"=>"query", "name"=>"enabled", "description"=>"A Boolean for whether to filter the result set to only enabled applications"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of entries to skip in the result set"}, {"in"=>"query", "name"=>"sortBy", "description"=>"The field to sort"}, {"in"=>"query", "name"=>"top", "description"=>"The maximum number of entries to return in the result set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}, "post"=>{"summary"=>"Post Applications", "description"=>"Creates a new blockchain application. This method can only be performed by users who are\n Workbench administrators.", "operationId"=>"ApplicationsPost", "x-api-path-slug"=>"apiv1applications-post", "parameters"=>[{"in"=>"formData", "name"=>"appFile", "description"=>"Upload Application File"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/api/v1/applications/{applicationId}"=>{"get"=>{"summary"=>"Get Applications", "description"=>"Gets the blockchain application matching a specific application ID. Users who are Workbench administrators get\n the blockchain application. Non-Workbench administrators get the blockchain application if they have at least one associated\n application role or is associated with a smart contract instance role.", "operationId"=>"ApplicationGet", "x-api-path-slug"=>"apiv1applicationsapplicationid-get", "parameters"=>[{"in"=>"path", "name"=>"applicationId", "description"=>"The id of the application"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}, "delete"=>{"summary"=>"Delete Applications", "description"=>"Deletes the specified blockchain application. This method can only be performed by users who are\n Workbench administrators. NOTE: Currently not implemented.", "operationId"=>"ApplicationDelete", "x-api-path-slug"=>"apiv1applicationsapplicationid-delete", "parameters"=>[{"in"=>"path", "name"=>"applicationId", "description"=>"The id of the application"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/api/v1/applications/{applicationId}/enable"=>{"patch"=>{"summary"=>"Patch Applications Enable", "description"=>"Enables the specified blockchain application. This method can only be performed by users who are\n Workbench administrators.", "operationId"=>"ApplicationEnable", "x-api-path-slug"=>"apiv1applicationsapplicationidenable-patch", "parameters"=>[{"in"=>"path", "name"=>"applicationId", "description"=>"The id of the application"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "Enable"]}}, "/api/v1/applications/{applicationId}/disable"=>{"patch"=>{"summary"=>"Patch Applications Disable", "description"=>"Disables the specified blockchain application. This method can only be performed by users who are\n Workbench administrators.", "operationId"=>"ApplicationDisable", "x-api-path-slug"=>"apiv1applicationsapplicationiddisable-patch", "parameters"=>[{"in"=>"path", "name"=>"applicationId", "description"=>"The id of the application"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "Disable"]}}, "/api/v1/applications/{applicationId}/roleAssignments"=>{"get"=>{"summary"=>"Get Applications Roleassignments", "description"=>"List all role assignments of the specified blockchain application. Users who are Workbench administrators\n get all role assignments. Non-Workbench administrators get all their role assignments. Roles are specified\n in the Workbench application configuration and can be retrieved from GET /applications/{applicationID}.\n Also, user information can be retrieved from GET /users/{userID}.", "operationId"=>"RoleAssignmentsGet", "x-api-path-slug"=>"apiv1applicationsapplicationidroleassignments-get", "parameters"=>[{"in"=>"path", "name"=>"applicationId", "description"=>"The id of the configuration"}, {"in"=>"query", "name"=>"applicationRoleId", "description"=>"The id of the application role"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of entries to skip in the result set"}, {"in"=>"query", "name"=>"sortBy", "description"=>"The field to sort"}, {"in"=>"query", "name"=>"top", "description"=>"The maximum number of entries to return in the result set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "Roleassignments"]}, "post"=>{"summary"=>"Post Applications Roleassignments", "description"=>"Creates a user-to-role mapping in the specified blockchain application. This method can only be performed by\n users who are Workbench administrators.", "operationId"=>"RoleAssignmentsPost", "x-api-path-slug"=>"apiv1applicationsapplicationidroleassignments-post", "parameters"=>[{"in"=>"path", "name"=>"applicationId", "description"=>"The id of the configuration"}, {"in"=>"body", "name"=>"roleAssignment", "description"=>"New user-to-role mapping", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "Roleassignments"]}}, "/api/v1/applications/{applicationId}/roleAssignments/{roleAssignmentId}"=>{"get"=>{"summary"=>"Get Applications Roleassignments Roleassignmentid", "description"=>"Get a role assignment of the specified blockchain application matching a specific user role assignment ID.\n Users who are Workbench administrators get the role assignment. Non-Workbench administrators get the role assignment\n if they are associated in the application.", "operationId"=>"RoleAssignmentGet", "x-api-path-slug"=>"apiv1applicationsapplicationidroleassignmentsroleassignmentid-get", "parameters"=>[{"in"=>"path", "name"=>"applicationId", "description"=>"The id of the configuration"}, {"in"=>"path", "name"=>"roleAssignmentId", "description"=>"The id of the role assignment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "Roleassignments", "Roleassignmentid"]}, "put"=>{"summary"=>"Put Applications Roleassignments Roleassignmentid", "description"=>"Updates the specified role assignment. This method can only be performed by users who are Workbench administrators.", "operationId"=>"RoleAssignmentPut", "x-api-path-slug"=>"apiv1applicationsapplicationidroleassignmentsroleassignmentid-put", "parameters"=>[{"in"=>"path", "name"=>"applicationId", "description"=>"The id of the application"}, {"in"=>"body", "name"=>"roleAssignment", "description"=>"New user-to-role mapping parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"roleAssignmentId", "description"=>"The id of the user-to-role mapping"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "Roleassignments", "Roleassignmentid"]}, "delete"=>{"summary"=>"Delete Applications Roleassignments Roleassignmentid", "description"=>"Deletes the specified role assignment. This method can only be performed by users who are\n Workbench administrators.", "operationId"=>"RoleAssignmentDelete", "x-api-path-slug"=>"apiv1applicationsapplicationidroleassignmentsroleassignmentid-delete", "parameters"=>[{"in"=>"path", "name"=>"applicationId", "description"=>"The id of the application"}, {"in"=>"path", "name"=>"roleAssignmentId", "description"=>"The id of the role assignment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "Roleassignments", "Roleassignmentid"]}}, "/api/v1/applications/{applicationId}/workflows"=>{"get"=>{"summary"=>"Get Applications Workflows", "description"=>"List all workflows of the specified blockchain application. Users who are Workbench administrators get all\n workflows. Non-Workbench administrators get all workflows for which they have at least one associated application role\n or are associated with a smart contract instance role.", "operationId"=>"WorkflowsGet", "x-api-path-slug"=>"apiv1applicationsapplicationidworkflows-get", "parameters"=>[{"in"=>"path", "name"=>"applicationId", "description"=>"The id of the application"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of items to skip before returning"}, {"in"=>"query", "name"=>"top", "description"=>"The maximum number of items to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "Workflows"]}}, "/api/v1/applications/workflows/{workflowId}"=>{"get"=>{"summary"=>"Get Applications Workflows", "description"=>"Get a workflow matching a specific workflow ID.\n Users who are Workbench administrators get the workflow. Non-Workbench administrators get the workflow if they\n have at least one associated application role or is associated with a smart contract instance role.", "operationId"=>"WorkflowGet", "x-api-path-slug"=>"apiv1applicationsworkflowsworkflowid-get", "parameters"=>[{"in"=>"path", "name"=>"workflowId", "description"=>"The id of the workflow"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "Workflows"]}}, "/api/v1/applications/{applicationId}/contractCode"=>{"get"=>{"summary"=>"Get Applications Contract Code", "description"=>"List all blockchain smart contract implementations of the specified blockchain application.\n Users who are Workbench administrators get all smart contract implementations. Non-Workbench administrators get all\n smart contract implementations for which they have at least one associated application role or is associated with a\n smart contract instance role.", "operationId"=>"ContractCodesGet", "x-api-path-slug"=>"apiv1applicationsapplicationidcontractcode-get", "parameters"=>[{"in"=>"path", "name"=>"applicationId", "description"=>"The id of the application"}, {"in"=>"query", "name"=>"ledgerId", "description"=>"The index of the chain type"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of items to skip before returning"}, {"in"=>"query", "name"=>"top", "description"=>"The maximum number of items to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "Contract", "Code"]}, "post"=>{"summary"=>"Post Applications Contract Code", "description"=>"Uploads one or more smart contracts (ex. .sol or .zip), representing the implementation of the specified blockchain\n application. This method can only be performed by users who are Workbench administrators.", "operationId"=>"ContractCodePost", "x-api-path-slug"=>"apiv1applicationsapplicationidcontractcode-post", "parameters"=>[{"in"=>"path", "name"=>"applicationId", "description"=>"The id of the application"}, {"in"=>"formData", "name"=>"contractFile", "description"=>"Upload ContractCode File"}, {"in"=>"query", "name"=>"ledgerId", "description"=>"The index of the ledger"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "Contract", "Code"]}}, "/api/v1/applications/contractCode/{contractCodeId}"=>{"get"=>{"summary"=>"Get Applications Contract Code", "description"=>"Get the blockchain smart contract implementation matching a specific\n contract code id. Users who are Workbench administrators get the specified smart contract implementation.\n Non-Workbench administrators get the smart contract implementation if they have at least one associated application\n role or is associated with a smart contract instance role.", "operationId"=>"ContractCodeGet", "x-api-path-slug"=>"apiv1applicationscontractcodecontractcodeid-get", "parameters"=>[{"in"=>"path", "name"=>"contractCodeId", "description"=>"The id of the contract code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "Contract", "Code"]}, "delete"=>{"summary"=>"Delete Applications Contract Code", "description"=>"Deletes the specified blockchain smart contract implementation of a specific blockchain application.\n This method can only be performed by users who are Workbench administrators.\n NOTE: not currently implemented", "operationId"=>"ContractCodeDelete", "x-api-path-slug"=>"apiv1applicationscontractcodecontractcodeid-delete", "parameters"=>[{"in"=>"path", "name"=>"contractCodeId", "description"=>"The id of the contract code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "Contract", "Code"]}}, "/api/v1/capabilities"=>{"get"=>{"summary"=>"Get Capabilities", "description"=>"List all capabilities the user can perform within Workbench.\n Checked capabilities include ability to add blockchain applications, add smart contract implementations,\n add or edit user role assignments, and add new users.", "operationId"=>"CapabilitiesGet", "x-api-path-slug"=>"apiv1capabilities-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Capabilities"]}}, "/api/v1/capabilities/canCreateContract/{workflowId}"=>{"get"=>{"summary"=>"Get Capabilities Can Create Contract", "description"=>"Checks if user has capability to create new smart contract instance for a specific workflow ID.", "operationId"=>"CanCreateContract", "x-api-path-slug"=>"apiv1capabilitiescancreatecontractworkflowid-get", "parameters"=>[{"in"=>"path", "name"=>"workflowId", "description"=>"The id of the workflow"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Capabilities", "Can", "Contract"]}}, "/api/v1/checkers/checkApplication"=>{"post"=>{"summary"=>"Post Checkers Check Application", "description"=>"Checks if the supplied application configuration file is valid for Workbench.", "operationId"=>"CheckApplicationPost", "x-api-path-slug"=>"apiv1checkerscheckapplication-post", "parameters"=>[{"in"=>"formData", "name"=>"appFile", "description"=>"Upload Application File"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkers", "Check", "Application"]}}, "/api/v1/checkers/checkContractCode"=>{"post"=>{"summary"=>"Post Checkers Check Contract Node", "description"=>"Check if the application smart contract implementation file is valid for Workbench.", "operationId"=>"CheckContractCodePost", "x-api-path-slug"=>"apiv1checkerscheckcontractcode-post", "parameters"=>[{"in"=>"formData", "name"=>"appFile", "description"=>"Upload Application File"}, {"in"=>"formData", "name"=>"contractFile", "description"=>"Upload Contract Code File"}, {"in"=>"query", "name"=>"ledgerId", "description"=>"The index of the chain type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkers", "Check", "Contract", "Node"]}}, "/api/v1/ledgers/connections"=>{"get"=>{"summary"=>"Get Ledgers Connections", "description"=>"Lists the connected blockchain networks.", "operationId"=>"ConnectionsGet", "x-api-path-slug"=>"apiv1ledgersconnections-get", "parameters"=>[{"in"=>"query", "name"=>"skip", "description"=>"The number of items to skip before returning"}, {"in"=>"query", "name"=>"top", "description"=>"The maximum number of items to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ledgers", "Connections"]}}, "/api/v1/ledgers/connections/{connectionId}"=>{"get"=>{"summary"=>"Get Ledgers Connections", "description"=>"Gets the connected blockchain network matching a specific connection ID.", "operationId"=>"ConnectionGet", "x-api-path-slug"=>"apiv1ledgersconnectionsconnectionid-get", "parameters"=>[{"in"=>"path", "name"=>"connectionId", "description"=>"The id of the connection"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ledgers", "Connections"]}}, "/api/v1/ledgers/connections/{connectionId}/blocks"=>{"get"=>{"summary"=>"Get Ledgers Connections Blocks", "description"=>"Lists the blocks for a connected blockchain network.", "operationId"=>"BlocksGet", "x-api-path-slug"=>"apiv1ledgersconnectionsconnectionidblocks-get", "parameters"=>[{"in"=>"path", "name"=>"connectionId", "description"=>"The id of the connection"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of items to skip before returning"}, {"in"=>"query", "name"=>"top", "description"=>"The maximum number of items to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ledgers", "Connections", "Blocks"]}}, "/api/v1/ledgers/connections/{connectionId}/blocks/{blockId}"=>{"get"=>{"summary"=>"Get Ledgers Connections Blocks Blockid", "description"=>"Gets the block matching a specific block ID.", "operationId"=>"BlockGet", "x-api-path-slug"=>"apiv1ledgersconnectionsconnectionidblocksblockid-get", "parameters"=>[{"in"=>"path", "name"=>"blockId", "description"=>"The id of the block"}, {"in"=>"path", "name"=>"connectionId", "description"=>"The connectionId of the block"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ledgers", "Connections", "Blocks", "Blockid"]}}, "/api/v1/ledgers/connections/{connectionId}/transactions"=>{"get"=>{"summary"=>"Get Ledgers Connections Transactions", "description"=>"Lists the transactions for a connected blockchain network.", "operationId"=>"TransactionsGet", "x-api-path-slug"=>"apiv1ledgersconnectionsconnectionidtransactions-get", "parameters"=>[{"in"=>"path", "name"=>"connectionId", "description"=>"The id of the connection"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of items to skip before returning"}, {"in"=>"query", "name"=>"top", "description"=>"The maximum number of items to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ledgers", "Connections", "Transactions"]}}, "/api/v1/ledgers/connections/{connectionId}/transactions/{transactionId}"=>{"get"=>{"summary"=>"Get Ledgers Connections Transactions Transactionid", "description"=>"Gets the transaction matching a specific transaction ID.", "operationId"=>"TransactionGet", "x-api-path-slug"=>"apiv1ledgersconnectionsconnectionidtransactionstransactionid-get", "parameters"=>[{"in"=>"path", "name"=>"connectionId", "description"=>"The connectionId of the transaction"}, {"in"=>"path", "name"=>"transactionId", "description"=>"The id of the transaction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ledgers", "Connections", "Transactions", "Transactionid"]}}, "/api/v1/contracts"=>{"get"=>{"summary"=>"Get Contracts", "description"=>"Lists the smart contract instances of the specified workflow. Users who are Workbench administrators get all\n smart contract instances. Non-Workbench administrators get all smart contract instances for which they have at least\n one associated application role or is associated with a smart contract instance role.", "operationId"=>"ContractsGet", "x-api-path-slug"=>"apiv1contracts-get", "parameters"=>[{"in"=>"query", "name"=>"skip", "description"=>"The number of items to skip before returning"}, {"in"=>"query", "name"=>"sortBy", "description"=>"The field to sort"}, {"in"=>"query", "name"=>"top", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"workflowId", "description"=>"The ID of the associated workflow"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contracts"]}, "post"=>{"summary"=>"Post Contracts", "description"=>"Creates a new smart contract instance for the specified workflow ID.\n Users are only able to create a new smart contract instance if the user is associated with an application role,\n which can initiate a smart contract instance for the workflow.", "operationId"=>"ContractPost", "x-api-path-slug"=>"apiv1contracts-post", "parameters"=>[{"in"=>"query", "name"=>"connectionId", "description"=>"The id of the blockchain connection"}, {"in"=>"query", "name"=>"contractCodeId", "description"=>"The id of the smart contract implementation"}, {"in"=>"body", "name"=>"workflowActionInput", "description"=>"The set of all contract action parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"workflowId", "description"=>"The id of the workflow"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contracts"]}}, "/api/v1/contracts/{contractId}"=>{"get"=>{"summary"=>"Get Contracts", "description"=>"Gets the smart contract instance matching a specific contract ID. Users who are Workbench\n administrators get the smart contract instance. Non-Workbench administrators get the smart contract instance\n if they have at least one associated application role or is associated with the smart contract instance.", "operationId"=>"ContractGet", "x-api-path-slug"=>"apiv1contractscontractid-get", "parameters"=>[{"in"=>"path", "name"=>"contractId", "description"=>"The id of the contract"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contracts"]}}, "/api/v1/contracts/{contractId}/actions"=>{"get"=>{"summary"=>"Get Contracts Actions", "description"=>"Lists all actions, which can be taken by the given user and current state of the specified smart contract\n instance. Users get all applicable actions if the user has an associated application role or is associated with a smart\n contract instance role for the current state of the specified smart contract instance.", "operationId"=>"ContractActionsGet", "x-api-path-slug"=>"apiv1contractscontractidactions-get", "parameters"=>[{"in"=>"path", "name"=>"contractId", "description"=>"The id of the contract"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of items to skip before returning"}, {"in"=>"query", "name"=>"top", "description"=>"The maximum number of items to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contracts", "Actions"]}, "post"=>{"summary"=>"Post Contracts Actions", "description"=>"Executes an action for the specified smart contract instance and action ID. Users are only able to execute\n the action given the current state of the specified smart contract instance and the user's associated application role\n or smart contract instance role.", "operationId"=>"ContractActionPost", "x-api-path-slug"=>"apiv1contractscontractidactions-post", "parameters"=>[{"in"=>"body", "name"=>"actionInformation", "description"=>"Parameters for a particular action", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"contractId", "description"=>"The id of the contract"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contracts", "Actions"]}}, "/api/v1/contracts/{contractId}/actions/{actionId}"=>{"get"=>{"summary"=>"Get Contracts Actions", "description"=>"Gets the action matching the specified action ID. Users get the action if the user can take the action\n given the current state of the specified smart contract instance and the user's associated application role or smart\n contract instance role.", "operationId"=>"ContractActionGet", "x-api-path-slug"=>"apiv1contractscontractidactionsactionid-get", "parameters"=>[{"in"=>"path", "name"=>"actionId", "description"=>"The id of the action"}, {"in"=>"path", "name"=>"contractId", "description"=>"The id of the contract"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contracts", "Actions"]}}, "/api/v1/graphProxy/{version}/users"=>{"get"=>{"summary"=>"Get Graph Proxy Version Users", "description"=>"Represents a proxy method to the Azure Active Directory Graph API for users.\n See https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/api/user_list for more details.", "operationId"=>"GraphProxy-UsersGet", "x-api-path-slug"=>"apiv1graphproxyversionusers-get", "parameters"=>[{"in"=>"path", "name"=>"version", "description"=>"The version for the graph api endpoint"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Graph", "Proxy", "Version", "Users"]}}, "/api/health"=>{"get"=>{"summary"=>"Get Api Health", "description"=>"Returns the health of the system. See https://docs.microsoft.com/en-us/azure/architecture/patterns/health-endpoint-monitoring\n for more details.", "operationId"=>"Health", "x-api-path-slug"=>"apihealth-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api", "Health"]}}, "/api/v1/ledgers"=>{"get"=>{"summary"=>"Get Ledgers", "description"=>"Lists the supported blockchain types, such as Ethereum or Hyperledger Fabric.", "operationId"=>"LedgersGet", "x-api-path-slug"=>"apiv1ledgers-get", "parameters"=>[{"in"=>"query", "name"=>"skip", "description"=>"The number of items to skip before returning"}, {"in"=>"query", "name"=>"top", "description"=>"The maximum number of items to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ledgers"]}}, "/api/v1/users"=>{"get"=>{"summary"=>"Get Users", "description"=>"Lists all users within the connected blockchain consortium.", "operationId"=>"UsersGet", "x-api-path-slug"=>"apiv1users-get", "parameters"=>[{"in"=>"query", "name"=>"externalId", "description"=>"The external ID of the user to query for"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of items to skip before returning"}, {"in"=>"query", "name"=>"sortBy", "description"=>"The field to sort"}, {"in"=>"query", "name"=>"top", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"userChainIdentifier", "description"=>"The on-chain address of the user to query for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "post"=>{"summary"=>"Post Users", "description"=>"Adds a user to the blockchain consortium. This method can only be performed by users who are\n Workbench administrators.", "operationId"=>"UsersPost", "x-api-path-slug"=>"apiv1users-post", "parameters"=>[{"in"=>"body", "name"=>"userInput", "description"=>"New user to add", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/api/v1/users/{userId}"=>{"get"=>{"summary"=>"Get Users Userid", "description"=>"Gets the user matching a specific user ID.", "operationId"=>"UserGet", "x-api-path-slug"=>"apiv1usersuserid-get", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"The id of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Userid"]}, "delete"=>{"summary"=>"Delete Users Userid", "description"=>"Deletes the specified user. This method can only be performed by users who are Workbench administrators.\n NOTE: Not currently implemented.", "operationId"=>"UserDelete", "x-api-path-slug"=>"apiv1usersuserid-delete", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"The id of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Userid"]}}, "/api/v1/users/me"=>{"get"=>{"summary"=>"Get Users Me", "description"=>"Returns the current user.", "operationId"=>"MeGet", "x-api-path-slug"=>"apiv1usersme-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Me"]}}}}, "apis"=>{"name"=>"Azure Blockchain Workbench", "x-slug"=>"azure-blockchain-workbench", "description"=>"Azure Blockchain Workbench helps organizations build rich, integrated multi-party blockchain applications quickly and easily. Azure Blockchain Workbench REST API provides developers and information workers a way to integrate to blockchain applications. For example, a developer can use the REST API to enable IoT devices to send data to a blockchain application. Or, an information worker can use the REST API and Power BI to create visualization of blockchain data.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-blockchain.png", "x-kinRank"=>"7", "x-alexaRank"=>"", "tags"=>"Blockchain,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-blockchain-workbench/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Blockchain Workbench", "x-api-slug"=>"azure-blockchain-workbench", "description"=>"Azure Blockchain Workbench helps organizations build rich, integrated multi-party blockchain applications quickly and easily. Azure Blockchain Workbench REST API provides developers and information workers a way to integrate to blockchain applications. For example, a developer can use the REST API to enable IoT devices to send data to a blockchain application. Or, an information worker can use the REST API and Power BI to create visualization of blockchain data.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-blockchain.png", "humanURL"=>"https://docs.microsoft.com/en-us/rest/api/azure-blockchain-workbench/", "baseURL"=>"https:////", "tags"=>"Blockchain,Relative Data,Service API", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/azure-blockchain-workbench/azure-blockchain-workbench-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://azure.microsoft.com/en-us/blog/topics/blockchain/"}, {"type"=>"x-blog-rss", "url"=>"https://azurecomcdn.azureedge.net/en-us/blog/topics/blockchain/feed/"}, {"type"=>"x-openapi", "url"=>"https://raw.githubusercontent.com/Azure-Samples/blockchain/master/blockchain-workbench/rest-api-samples/swagger/swagger.json"}, {"type"=>"x-website", "url"=>"https://docs.microsoft.com/en-us/rest/api/azure-blockchain-workbench/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
square{"apis"=>{"name"=>"Square", "x-slug"=>"square", "description"=>"Square, Inc. is a financial services, merchant services aggregator, and mobile payment company based in San Francisco, California.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2176-square.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"2002", "tags"=>"Commerce,Credit Cards,Financial Services,internet,Mobile,New,Payments,Payments,Relative Data,Relative StreamRank,Service API,Stack Network,Streams,Streams,Streams,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"square/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Square Connect API", "x-api-slug"=>"square-connect-api", "description"=>"Square, Inc. is a financial services, merchant services aggregator, and mobile payment company based in San Francisco, California.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2176-square.jpg", "humanURL"=>"http://square.com", "baseURL"=>"https://connect.squareup.com//", "tags"=>"Commerce,Credit Cards,Financial Services,internet,Mobile,New,Payments,Payments,Relative Data,Relative StreamRank,Service API,Stack Network,Streams,Streams,Streams,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/square/square-connect-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://square.com"}, {"type"=>"x-base", "url"=>"https://connect.squareup.com"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/square"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/square"}, {"type"=>"x-developer", "url"=>"https://connect.squareup.com/"}, {"type"=>"x-email", "url"=>"press@squareup.com"}, {"type"=>"x-email", "url"=>"security@squareup.com"}, {"type"=>"x-email", "url"=>"lawenforcement@squareup.com"}, {"type"=>"x-email", "url"=>"redemption@squareup.com"}, {"type"=>"x-email", "url"=>"privacy@squareup.com"}, {"type"=>"x-email", "url"=>"community@squareup.com"}, {"type"=>"x-email", "url"=>"noreply@messaging.squareup.com"}, {"type"=>"x-email", "url"=>"ir@squareup.com"}, {"type"=>"x-email", "url"=>"takedowns@squareup.com"}, {"type"=>"x-github", "url"=>"https://github.com/square"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/square--/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Square"}, {"type"=>"x-webhook", "url"=>"https://docs.connect.squareup.com/basics/api101/webhooks"}, {"type"=>"x-website", "url"=>"http://squareup.com"}, {"type"=>"x-website", "url"=>"https://squareup.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "square-connect-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Square", "x-complete"=>1, "info"=>{"title"=>"Square Connect", "description"=>"client-library-for-accessing-the-square-connect-apis", "termsOfService"=>"https://connect.squareup.com/tos", "contact"=>{"name"=>"Square Developer Platform", "url"=>"https://squareup.com/developers", "email"=>"developers@squareup.com"}, "version"=>"2.0"}, "host"=>"connect.squareup.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/me"=>{"get"=>{"summary"=>"Get a business's information.", "description"=>"Get a business's information.", "operationId"=>"RetrieveBusiness", "x-api-path-slug"=>"v1me-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesss", "Information"]}}, "/v1/me/employees"=>{"get"=>{"summary"=>"Provides summary information for all of a business's employees.", "description"=>"Provides summary information for all of a business's employees.", "operationId"=>"ListEmployees", "x-api-path-slug"=>"v1meemployees-get", "parameters"=>[{"in"=>"query", "name"=>"batch_token", "description"=>"A pagination cursor to retrieve the next set of results for youroriginal query to the endpoint"}, {"in"=>"query", "name"=>"begin_created_at", "description"=>"If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"begin_updated_at", "description"=>"If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"end_created_at", "description"=>"If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"end_updated_at", "description"=>"If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"external_id", "description"=>"If provided, the endpoint returns only employee entities with the specified external_id"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum integer number of employee entities to return in a single response"}, {"in"=>"query", "name"=>"order", "description"=>"The order in which employees are listed in the response, based on their created_at field"}, {"in"=>"query", "name"=>"status", "description"=>"If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Summary", "Information", "Of", "Businesss", "Employees"]}, "post"=>{"summary"=>"Creates an employee for a business.", "description"=>"Creates an employee for a business.", "operationId"=>"CreateEmployee", "x-api-path-slug"=>"v1meemployees-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Employeea", "Business"]}}, "/v1/me/employees/{employee_id}"=>{"get"=>{"summary"=>"Provides the details for a single employee.", "description"=>"Provides the details for a single employee.", "operationId"=>"RetrieveEmployee", "x-api-path-slug"=>"v1meemployeesemployee-id-get", "parameters"=>[{"in"=>"path", "name"=>"employee_id", "description"=>"The employees ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Detailsa", "Single", "Employee"]}, "put"=>{"summary"=>"Update Employee", "description"=>"Update Employee", "operationId"=>"UpdateEmployee", "x-api-path-slug"=>"v1meemployeesemployee-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"employee_id", "description"=>"The ID of the role to modify"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Employee"]}}, "/v1/me/locations"=>{"get"=>{"summary"=>"Provides details for a business's locations, including their IDs.", "description"=>"Provides details for a business's locations, including their IDs.", "operationId"=>"v1.me.locations.get", "x-api-path-slug"=>"v1melocations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Detailsa", "Businesss", "Locations", "", "Including", "Their", "IDs"]}}, "/v1/me/roles"=>{"get"=>{"summary"=>"Provides summary information for all of a business's employee roles.", "description"=>"Provides summary information for all of a business's employee roles.", "operationId"=>"ListEmployeeRoles", "x-api-path-slug"=>"v1meroles-get", "parameters"=>[{"in"=>"query", "name"=>"batch_token", "description"=>"A pagination cursor to retrieve the next set of results for youroriginal query to the endpoint"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum integer number of employee entities to return in a single response"}, {"in"=>"query", "name"=>"order", "description"=>"The order in which employees are listed in the response, based on their created_at field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Summary", "Information", "Of", "Businesss", "Employee", "Roles"]}, "post"=>{"summary"=>"Creates an employee role you can then assign to employees.", "description"=>"Creates an employee role you can then assign to employees.", "operationId"=>"CreateEmployeeRole", "x-api-path-slug"=>"v1meroles-post", "parameters"=>[{"in"=>"body", "name"=>"EmployeeRole", "description"=>"An EmployeeRole object with a name and permissions, and an optional owner flag", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Employee", "Role", "You", "Can", "Then", "Assign", "To", "Employees"]}}, "/v1/me/roles/{role_id}"=>{"get"=>{"summary"=>"Provides the details for a single employee role.", "description"=>"Provides the details for a single employee role.", "operationId"=>"RetrieveEmployeeRole", "x-api-path-slug"=>"v1merolesrole-id-get", "parameters"=>[{"in"=>"path", "name"=>"role_id", "description"=>"The roles ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Detailsa", "Single", "Employee", "Role"]}, "put"=>{"summary"=>"Modifies the details of an employee role.", "description"=>"Modifies the details of an employee role.", "operationId"=>"UpdateEmployeeRole", "x-api-path-slug"=>"v1merolesrole-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"role_id", "description"=>"The ID of the role to modify"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Modifies", "Details", "Of", "Employee", "Role"]}}, "/v1/me/timecards"=>{"get"=>{"summary"=>"Provides summary information for all of a business's employee timecards.", "description"=>"Provides summary information for all of a business's employee timecards.", "operationId"=>"ListTimecards", "x-api-path-slug"=>"v1metimecards-get", "parameters"=>[{"in"=>"query", "name"=>"batch_token", "description"=>"A pagination cursor to retrieve the next set of results for youroriginal query to the endpoint"}, {"in"=>"query", "name"=>"begin_clockin_time", "description"=>"If filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"begin_clockout_time", "description"=>"If filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"begin_updated_at", "description"=>"If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"deleted", "description"=>"If true, only deleted timecards are returned"}, {"in"=>"query", "name"=>"employee_id", "description"=>"If provided, the endpoint returns only timecards for the employee with the specified ID"}, {"in"=>"query", "name"=>"end_clockin_time", "description"=>"If filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"end_clockout_time", "description"=>"If filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"end_updated_at", "description"=>"If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum integer number of employee entities to return in a single response"}, {"in"=>"query", "name"=>"order", "description"=>"The order in which timecards are listed in the response, based on their created_at field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Summary", "Information", "Of", "Businesss", "Employee", "Timecards"]}, "post"=>{"summary"=>"Creates a timecard for an employee. Each timecard corresponds to a single shift.", "description"=>"Creates a timecard for an employee. Each timecard corresponds to a single shift.", "operationId"=>"CreateTimecard", "x-api-path-slug"=>"v1metimecards-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Timecardan", "Employee", "", "Each", "Timecard", "Corresponds", "To", "Single", "Shift"]}}, "/v1/me/timecards/{timecard_id}"=>{"delete"=>{"summary"=>"Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.", "description"=>"Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.", "operationId"=>"DeleteTimecard", "x-api-path-slug"=>"v1metimecardstimecard-id-delete", "parameters"=>[{"in"=>"path", "name"=>"timecard_id", "description"=>"The ID of the timecard to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Timecard", "", "D", "Timecards", "Are", "Still", "Accessible", "From", "Connect", "Endpoints", "", "But", "Value", "Of", "Their", "Deleted", "Field", "Is", "Set", "To", "True", "", "See", "Handling", "Deleted", "Timecardsmore", "Information"]}, "get"=>{"summary"=>"Provides the details for a single timecard.", "description"=>"Provides the details for a single timecard.", "operationId"=>"RetrieveTimecard", "x-api-path-slug"=>"v1metimecardstimecard-id-get", "parameters"=>[{"in"=>"path", "name"=>"timecard_id", "description"=>"The timecards ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Detailsa", "Single", "Timecard"]}, "put"=>{"summary"=>"Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.", "description"=>"Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.", "operationId"=>"UpdateTimecard", "x-api-path-slug"=>"v1metimecardstimecard-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"timecard_id", "description"=>"TThe ID of the timecard to modify"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Modifies", "Timecards", "Details", "", "This", "Creates", "EDIT", "Eventthe", "Timecard", "", "You", "Can", "View", "Timecards", "Event", "History", "List", "Timecard", "Events", "Endpoint"]}}, "/v1/me/timecards/{timecard_id}/events"=>{"get"=>{"summary"=>"Provides summary information for all events associated with a particular timecard.", "description"=>"Provides summary information for all events associated with a particular timecard.", "operationId"=>"ListTimecardEvents", "x-api-path-slug"=>"v1metimecardstimecard-idevents-get", "parameters"=>[{"in"=>"path", "name"=>"timecard_id", "description"=>"The ID of the timecard to list events for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Summary", "Information", "Events", "Associated", "Particular", "Timecard"]}}, "/v1/{location_id}/bank-accounts"=>{"get"=>{"summary"=>"Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.", "description"=>"Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.", "operationId"=>"ListBankAccounts", "x-api-path-slug"=>"v1location-idbankaccounts-get", "parameters"=>[{"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to list bank accounts for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Non-confidential", "Details", "Of", "Locations", "Associated", "Bank", "Accounts", "", "This", "Endpoint", "Does", "Not", "Provide", "Full", "Bank", "Account", "Numbers", "", "There", "Is", "No", "Way", "To", "Obtain", "Full", "Bank", "Account", "Number", "Connect"]}}, "/v1/{location_id}/bank-accounts/{bank_account_id}"=>{"get"=>{"summary"=>"Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.", "description"=>"Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.", "operationId"=>"RetrieveBankAccount", "x-api-path-slug"=>"v1location-idbankaccountsbank-account-id-get", "parameters"=>[{"in"=>"path", "name"=>"bank_account_id", "description"=>"The bank accounts Square-issued ID"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the bank accounts associated location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Non-confidential", "Detailsa", "Merchants", "Associated", "Bank", "Account", "", "This", "Endpoint", "Does", "Not", "Provide", "Full", "Bank", "Account", "Numbers", "", "There", "Is", "No", "Way", "To", "Obtain", "Full", "Bank", "Account", "Number", "Connect"]}}, "/v1/{location_id}/cash-drawer-shifts"=>{"get"=>{"summary"=>"Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.", "description"=>"Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.", "operationId"=>"ListCashDrawerShifts", "x-api-path-slug"=>"v1location-idcashdrawershifts-get", "parameters"=>[{"in"=>"query", "name"=>"begin_time", "description"=>"The beginning of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"end_time", "description"=>"The beginning of the requested reporting period, in ISO 8601 format"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to list cash drawer shifts for"}, {"in"=>"query", "name"=>"order", "description"=>"The order in which cash drawer shifts are listed in the response, based on their created_at field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Details", "Of", "Locations", "Cash", "Drawer", "Shifts", "During", "Date", "Range", "", "Date", "Range", "You", "Specify", "Cannot", "Exceed", "90", "Days"]}}, "/v1/{location_id}/cash-drawer-shifts/{shift_id}"=>{"get"=>{"summary"=>"Provides the details for a single cash drawer shift, including all events that occurred during the shift.", "description"=>"Provides the details for a single cash drawer shift, including all events that occurred during the shift.", "operationId"=>"RetrieveCashDrawerShift", "x-api-path-slug"=>"v1location-idcashdrawershiftsshift-id-get", "parameters"=>[{"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to list cash drawer shifts for"}, {"in"=>"path", "name"=>"shift_id", "description"=>"The shifts ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Detailsa", "Single", "Cash", "Drawer", "Shift", "", "Including", "", "Events", "That", "Occurred", "During", "Shift"]}}, "/v1/{location_id}/categories"=>{"get"=>{"summary"=>"Lists all of a location's item categories.", "description"=>"Lists all of a location's item categories.", "operationId"=>"ListCategories", "x-api-path-slug"=>"v1location-idcategories-get", "parameters"=>[{"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to list categories for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "", "Of", "Locations", "Item", "Categories"]}, "post"=>{"summary"=>"Creates an item category.", "description"=>"Creates an item category.", "operationId"=>"CreateCategory", "x-api-path-slug"=>"v1location-idcategories-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to create an item for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Item", "Category"]}}, "/v1/{location_id}/categories/{category_id}"=>{"delete"=>{"summary"=>"Deletes an existing item category.", "description"=>"Deletes an existing item category.", "operationId"=>"DeleteCategory", "x-api-path-slug"=>"v1location-idcategoriescategory-id-delete", "parameters"=>[{"in"=>"path", "name"=>"category_id", "description"=>"The ID of the category to delete"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Existing", "Item", "Category"]}, "put"=>{"summary"=>"Modifies the details of an existing item category.", "description"=>"Modifies the details of an existing item category.", "operationId"=>"UpdateCategory", "x-api-path-slug"=>"v1location-idcategoriescategory-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"category_id", "description"=>"The ID of the category to edit"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the categorys associated location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Modifies", "Details", "Of", "Existing", "Item", "Category"]}}, "/v1/{location_id}/discounts"=>{"get"=>{"summary"=>"Lists all of a location's discounts.", "description"=>"Lists all of a location's discounts.", "operationId"=>"ListDiscounts", "x-api-path-slug"=>"v1location-iddiscounts-get", "parameters"=>[{"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to list categories for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "", "Of", "Locations", "Discounts"]}, "post"=>{"summary"=>"Creates a discount.", "description"=>"Creates a discount.", "operationId"=>"CreateDiscount", "x-api-path-slug"=>"v1location-iddiscounts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to create an item for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Discount"]}}, "/v1/{location_id}/discounts/{discount_id}"=>{"delete"=>{"summary"=>"Deletes an existing discount.", "description"=>"Deletes an existing discount.", "operationId"=>"DeleteDiscount", "x-api-path-slug"=>"v1location-iddiscountsdiscount-id-delete", "parameters"=>[{"in"=>"path", "name"=>"discount_id", "description"=>"The ID of the discount to delete"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Existing", "Discount"]}, "put"=>{"summary"=>"Modifies the details of an existing discount.", "description"=>"Modifies the details of an existing discount.", "operationId"=>"UpdateDiscount", "x-api-path-slug"=>"v1location-iddiscountsdiscount-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"discount_id", "description"=>"The ID of the discount to edit"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the categorys associated location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Modifies", "Details", "Of", "Existing", "Discount"]}}, "/v1/{location_id}/fees"=>{"get"=>{"summary"=>"Lists all of a location's fees (taxes).", "description"=>"Lists all of a location's fees (taxes).", "operationId"=>"ListFees", "x-api-path-slug"=>"v1location-idfees-get", "parameters"=>[{"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to list fees for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "", "Of", "Locations", "Fees", "(taxes)"]}, "post"=>{"summary"=>"Creates a fee (tax).", "description"=>"Creates a fee (tax).", "operationId"=>"CreateFee", "x-api-path-slug"=>"v1location-idfees-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to create a fee for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Fee", "(tax)"]}}, "/v1/{location_id}/fees/{fee_id}"=>{"delete"=>{"summary"=>"Deletes an existing fee (tax).", "description"=>"Deletes an existing fee (tax).", "operationId"=>"DeleteFee", "x-api-path-slug"=>"v1location-idfeesfee-id-delete", "parameters"=>[{"in"=>"path", "name"=>"fee_id", "description"=>"The ID of the fee to delete"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the fees associated location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Existing", "Fee", "(tax)"]}, "put"=>{"summary"=>"Modifies the details of an existing fee (tax).", "description"=>"Modifies the details of an existing fee (tax).", "operationId"=>"UpdateFee", "x-api-path-slug"=>"v1location-idfeesfee-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"fee_id", "description"=>"The ID of the fee to edit"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the fees associated location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Modifies", "Details", "Of", "Existing", "Fee", "(tax)"]}}, "/v1/{location_id}/inventory"=>{"get"=>{"summary"=>"Provides inventory information for all of a merchant's inventory-enabled item variations.", "description"=>"Provides inventory information for all of a merchant's inventory-enabled item variations.", "operationId"=>"ListInventory", "x-api-path-slug"=>"v1location-idinventory-get", "parameters"=>[{"in"=>"query", "name"=>"batch_token", "description"=>"A pagination cursor to retrieve the next set of results for youroriginal query to the endpoint"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of inventory entries to return in a single response"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Inventory", "Information", "Of", "Merchants", "Inventory-enabled", "Item", "Variations"]}}, "/v1/{location_id}/inventory/{variation_id}"=>{"post"=>{"summary"=>"Adjusts an item variation's current available inventory.", "description"=>"Adjusts an item variation's current available inventory.", "operationId"=>"AdjustInventory", "x-api-path-slug"=>"v1location-idinventoryvariation-id-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}, {"in"=>"path", "name"=>"variation_id", "description"=>"The ID of the variation to adjust inventory information for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Adjusts", "Item", "Variations", "Current", "Available", "Inventory"]}}, "/v1/{location_id}/items"=>{"get"=>{"summary"=>"Provides summary information for all of a location's items.", "description"=>"Provides summary information for all of a location's items.", "operationId"=>"ListItems", "x-api-path-slug"=>"v1location-iditems-get", "parameters"=>[{"in"=>"query", "name"=>"batch_token", "description"=>"A pagination cursor to retrieve the next set of results for youroriginal query to the endpoint"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to list items for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Summary", "Information", "Of", "Locations", "Items"]}, "post"=>{"summary"=>"Creates an item and at least one variation for it.", "description"=>"Creates an item and at least one variation for it.", "operationId"=>"CreateItem", "x-api-path-slug"=>"v1location-iditems-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to create an item for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Item", "At", "Least", "Variationit"]}}, "/v1/{location_id}/items/{item_id}"=>{"delete"=>{"summary"=>"Deletes an existing item and all item variations associated with it.", "description"=>"Deletes an existing item and all item variations associated with it.", "operationId"=>"DeleteItem", "x-api-path-slug"=>"v1location-iditemsitem-id-delete", "parameters"=>[{"in"=>"path", "name"=>"item_id", "description"=>"The ID of the item to modify"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Existing", "Item", "", "Item", "Variations", "Associated", "It"]}, "get"=>{"summary"=>"Provides the details for a single item, including associated modifier lists and fees.", "description"=>"Provides the details for a single item, including associated modifier lists and fees.", "operationId"=>"RetrieveItem", "x-api-path-slug"=>"v1location-iditemsitem-id-get", "parameters"=>[{"in"=>"path", "name"=>"item_id", "description"=>"The items ID"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Detailsa", "Single", "Item", "", "Including", "Associated", "Modifier", "Lists", "Fees"]}, "put"=>{"summary"=>"Modifies the core details of an existing item.", "description"=>"Modifies the core details of an existing item.", "operationId"=>"UpdateItem", "x-api-path-slug"=>"v1location-iditemsitem-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"item_id", "description"=>"The ID of the item to modify"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Modifies", "Core", "Details", "Of", "Existing", "Item"]}}, "/v1/{location_id}/items/{item_id}/fees/{fee_id}"=>{"delete"=>{"summary"=>"Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register.", "description"=>"Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register.", "operationId"=>"RemoveFee", "x-api-path-slug"=>"v1location-iditemsitem-idfeesfee-id-delete", "parameters"=>[{"in"=>"path", "name"=>"fee_id", "description"=>"The ID of the fee to apply"}, {"in"=>"path", "name"=>"item_id", "description"=>"The ID of the item to add the fee to"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the fees associated location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Removes", "Fee", "Assocation", "From", "Item", "", "Meaning", "Fee", "Is", "No", "Longer", "Automatically", "Applied", "To", "Item", "In", "Square", "Register"]}, "put"=>{"summary"=>"Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register.", "description"=>"Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register.", "operationId"=>"ApplyFee", "x-api-path-slug"=>"v1location-iditemsitem-idfeesfee-id-put", "parameters"=>[{"in"=>"path", "name"=>"fee_id", "description"=>"The ID of the fee to apply"}, {"in"=>"path", "name"=>"item_id", "description"=>"The ID of the item to add the fee to"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the fees associated location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Associates", "Fee", "Item", "", "Meaning", "Fee", "Is", "Automatically", "Applied", "To", "Item", "In", "Square", "Register"]}}, "/v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id}"=>{"delete"=>{"summary"=>"Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item.", "description"=>"Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item.", "operationId"=>"RemoveModifierList", "x-api-path-slug"=>"v1location-iditemsitem-idmodifierlistsmodifier-list-id-delete", "parameters"=>[{"in"=>"path", "name"=>"item_id", "description"=>"The ID of the item to remove the modifier list from"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}, {"in"=>"path", "name"=>"modifier_list_id", "description"=>"The ID of the modifier list to remove"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Removes", "Modifier", "List", "Association", "From", "Item", "", "Meaning", "Modifier", "Options", "From", "List", "Can", "No", "Longer", "Be", "Applied", "To", "Item"]}, "put"=>{"summary"=>"Associates a modifier list with an item, meaning modifier options from the list can be applied to the item.", "description"=>"Associates a modifier list with an item, meaning modifier options from the list can be applied to the item.", "operationId"=>"ApplyModifierList", "x-api-path-slug"=>"v1location-iditemsitem-idmodifierlistsmodifier-list-id-put", "parameters"=>[{"in"=>"path", "name"=>"item_id", "description"=>"The ID of the item to add the modifier list to"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}, {"in"=>"path", "name"=>"modifier_list_id", "description"=>"The ID of the modifier list to apply"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Associates", "Modifier", "List", "Item", "", "Meaning", "Modifier", "Options", "From", "List", "Can", "Be", "Applied", "To", "Item"]}}, "/v1/{location_id}/items/{item_id}/variations"=>{"post"=>{"summary"=>"Creates an item variation for an existing item.", "description"=>"Creates an item variation for an existing item.", "operationId"=>"CreateVariation", "x-api-path-slug"=>"v1location-iditemsitem-idvariations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"item_id", "description"=>"The items ID"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Item", "Variationan", "Existing", "Item"]}}, "/v1/{location_id}/items/{item_id}/variations/{variation_id}"=>{"delete"=>{"summary"=>"Deletes an existing item variation from an item.", "description"=>"Deletes an existing item variation from an item.", "operationId"=>"DeleteVariation", "x-api-path-slug"=>"v1location-iditemsitem-idvariationsvariation-id-delete", "parameters"=>[{"in"=>"path", "name"=>"item_id", "description"=>"The ID of the item to delete"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}, {"in"=>"path", "name"=>"variation_id", "description"=>"The ID of the variation to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Existing", "Item", "Variation", "From", "Item"]}, "put"=>{"summary"=>"Modifies the details of an existing item variation.", "description"=>"Modifies the details of an existing item variation.", "operationId"=>"UpdateVariation", "x-api-path-slug"=>"v1location-iditemsitem-idvariationsvariation-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"item_id", "description"=>"The ID of the item to modify"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}, {"in"=>"path", "name"=>"variation_id", "description"=>"The ID of the variation to modify"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Modifies", "Details", "Of", "Existing", "Item", "Variation"]}}, "/v1/{location_id}/modifier-lists"=>{"get"=>{"summary"=>"Lists all of a location's modifier lists.", "description"=>"Lists all of a location's modifier lists.", "operationId"=>"ListModifierLists", "x-api-path-slug"=>"v1location-idmodifierlists-get", "parameters"=>[{"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to list modifier lists for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "", "Of", "Locations", "Modifier", "Lists"]}, "post"=>{"summary"=>"Creates an item modifier list and at least one modifier option for it.", "description"=>"Creates an item modifier list and at least one modifier option for it.", "operationId"=>"CreateModifierList", "x-api-path-slug"=>"v1location-idmodifierlists-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to create a modifier list for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Item", "Modifier", "List", "At", "Least", "Modifier", "Optionit"]}}, "/v1/{location_id}/modifier-lists/{modifier_list_id}"=>{"delete"=>{"summary"=>"Deletes an existing item modifier list and all modifier options associated with it.", "description"=>"Deletes an existing item modifier list and all modifier options associated with it.", "operationId"=>"DeleteModifierList", "x-api-path-slug"=>"v1location-idmodifierlistsmodifier-list-id-delete", "parameters"=>[{"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}, {"in"=>"path", "name"=>"modifier_list_id", "description"=>"The ID of the modifier list to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Existing", "Item", "Modifier", "List", "", "Modifier", "Options", "Associated", "It"]}, "get"=>{"summary"=>"Provides the details for a single modifier list.", "description"=>"Provides the details for a single modifier list.", "operationId"=>"RetrieveModifierList", "x-api-path-slug"=>"v1location-idmodifierlistsmodifier-list-id-get", "parameters"=>[{"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}, {"in"=>"path", "name"=>"modifier_list_id", "description"=>"The modifier lists ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Detailsa", "Single", "Modifier", "List"]}, "put"=>{"summary"=>"Modifies the details of an existing item modifier list.", "description"=>"Modifies the details of an existing item modifier list.", "operationId"=>"UpdateModifierList", "x-api-path-slug"=>"v1location-idmodifierlistsmodifier-list-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}, {"in"=>"path", "name"=>"modifier_list_id", "description"=>"The ID of the modifier list to edit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Modifies", "Details", "Of", "Existing", "Item", "Modifier", "List"]}}, "/v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options"=>{"post"=>{"summary"=>"Creates an item modifier option and adds it to a modifier list.", "description"=>"Creates an item modifier option and adds it to a modifier list.", "operationId"=>"CreateModifierOption", "x-api-path-slug"=>"v1location-idmodifierlistsmodifier-list-idmodifieroptions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}, {"in"=>"path", "name"=>"modifier_list_id", "description"=>"The ID of the modifier list to edit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Item", "Modifier", "Option", "Adds", "It", "To", "Modifier", "List"]}}, "/v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id}"=>{"delete"=>{"summary"=>"Deletes an existing item modifier option from a modifier list.", "description"=>"Deletes an existing item modifier option from a modifier list.", "operationId"=>"DeleteModifierOption", "x-api-path-slug"=>"v1location-idmodifierlistsmodifier-list-idmodifieroptionsmodifier-option-id-delete", "parameters"=>[{"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}, {"in"=>"path", "name"=>"modifier_list_id", "description"=>"The ID of the modifier list to delete"}, {"in"=>"path", "name"=>"modifier_option_id", "description"=>"The ID of the modifier list to edit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Existing", "Item", "Modifier", "Option", "From", "Modifier", "List"]}, "put"=>{"summary"=>"Modifies the details of an existing item modifier option.", "description"=>"Modifies the details of an existing item modifier option.", "operationId"=>"UpdateModifierOption", "x-api-path-slug"=>"v1location-idmodifierlistsmodifier-list-idmodifieroptionsmodifier-option-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the items associated location"}, {"in"=>"path", "name"=>"modifier_list_id", "description"=>"The ID of the modifier list to edit"}, {"in"=>"path", "name"=>"modifier_option_id", "description"=>"The ID of the modifier list to edit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Modifies", "Details", "Of", "Existing", "Item", "Modifier", "Option"]}}, "/v1/{location_id}/orders"=>{"get"=>{"summary"=>"Provides summary information for a merchant's online store orders.", "description"=>"Provides summary information for a merchant's online store orders.", "operationId"=>"ListOrders", "x-api-path-slug"=>"v1location-idorders-get", "parameters"=>[{"in"=>"query", "name"=>"batch_token", "description"=>"A pagination cursor to retrieve the next set of results for youroriginal query to the endpoint"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of payments to return in a single response"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to list online store orders for"}, {"in"=>"query", "name"=>"order", "description"=>"TThe order in which payments are listed in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Summary", "Informationa", "Merchants", "Online", "Store", "Orders"]}}, "/v1/{location_id}/orders/{order_id}"=>{"get"=>{"summary"=>"Provides comprehensive information for a single online store order, including the order's history.", "description"=>"Provides comprehensive information for a single online store order, including the order's history.", "operationId"=>"RetrieveOrder", "x-api-path-slug"=>"v1location-idordersorder-id-get", "parameters"=>[{"in"=>"path", "name"=>"location_id", "description"=>"The ID of the orders associated location"}, {"in"=>"path", "name"=>"order_id", "description"=>"The orders Square-issued ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Comprehensive", "Informationa", "Single", "Online", "Store", "Order", "", "Including", "Orders", "History"]}, "put"=>{"summary"=>"Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:", "description"=>"Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:", "operationId"=>"UpdateOrder", "x-api-path-slug"=>"v1location-idordersorder-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the orders associated location"}, {"in"=>"path", "name"=>"order_id", "description"=>"The orders Square-issued ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Details", "Of", "Online", "Store", "Order", "", "Every", "Update", "You", "Perform", "On", "Order", "Corresponds", "To", "Of", "Three", "Actions:"]}}, "/v1/{location_id}/pages"=>{"get"=>{"summary"=>"Lists all of a location's Favorites pages in Square Register.", "description"=>"Lists all of a location's Favorites pages in Square Register.", "operationId"=>"ListPages", "x-api-path-slug"=>"v1location-idpages-get", "parameters"=>[{"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to list Favorites pages for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "", "Of", "Locations", "Favorites", "Pages", "In", "Square", "Register"]}, "post"=>{"summary"=>"Creates a Favorites page in Square Register.", "description"=>"Creates a Favorites page in Square Register.", "operationId"=>"CreatePage", "x-api-path-slug"=>"v1location-idpages-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to create an item for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Favorites", "Page", "In", "Square", "Register"]}}, "/v1/{location_id}/pages/{page_id}"=>{"delete"=>{"summary"=>"Deletes an existing Favorites page and all of its cells.", "description"=>"Deletes an existing Favorites page and all of its cells.", "operationId"=>"DeletePage", "x-api-path-slug"=>"v1location-idpagespage-id-delete", "parameters"=>[{"in"=>"path", "name"=>"location_id", "description"=>"The ID of the Favorites pages associated location"}, {"in"=>"path", "name"=>"page_id", "description"=>"The ID of the page to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Existing", "Favorites", "Page", "", "Of", "Its", "Cells"]}, "put"=>{"summary"=>"Modifies the details of a Favorites page in Square Register.", "description"=>"Modifies the details of a Favorites page in Square Register.", "operationId"=>"UpdatePage", "x-api-path-slug"=>"v1location-idpagespage-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the Favorites pages associated location"}, {"in"=>"path", "name"=>"page_id", "description"=>"The ID of the page to modify"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Modifies", "Details", "Of", "Favorites", "Page", "In", "Square", "Register"]}}, "/v1/{location_id}/pages/{page_id}/cells"=>{"delete"=>{"summary"=>"Deletes a cell from a Favorites page in Square Register.", "description"=>"Deletes a cell from a Favorites page in Square Register.", "operationId"=>"DeletePageCell", "x-api-path-slug"=>"v1location-idpagespage-idcells-delete", "parameters"=>[{"in"=>"query", "name"=>"column", "description"=>"The column of the cell to clear"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the Favorites pages associated location"}, {"in"=>"path", "name"=>"page_id", "description"=>"The ID of the page to delete"}, {"in"=>"query", "name"=>"row", "description"=>"The row of the cell to clear"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Cell", "From", "Favorites", "Page", "In", "Square", "Register"]}, "put"=>{"summary"=>"Modifies a cell of a Favorites page in Square Register.", "description"=>"Modifies a cell of a Favorites page in Square Register.", "operationId"=>"UpdatePageCell", "x-api-path-slug"=>"v1location-idpagespage-idcells-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the Favorites pages associated location"}, {"in"=>"path", "name"=>"page_id", "description"=>"The ID of the page the cell belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Modifies", "Cell", "Of", "Favorites", "Page", "In", "Square", "Register"]}}, "/v1/{location_id}/payments"=>{"get"=>{"summary"=>"Provides summary information for all payments taken by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. See Date ranges for details of inclusive and exclusive dates.", "description"=>"Provides summary information for all payments taken by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. See Date ranges for details of inclusive and exclusive dates.", "operationId"=>"ListPayments", "x-api-path-slug"=>"v1location-idpayments-get", "parameters"=>[{"in"=>"query", "name"=>"batch_token", "description"=>"A pagination cursor to retrieve the next set of results for youroriginal query to the endpoint"}, {"in"=>"query", "name"=>"begin_time", "description"=>"The beginning of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"end_time", "description"=>"The end of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of payments to return in a single response"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to list payments for"}, {"in"=>"query", "name"=>"order", "description"=>"The order in which payments are listed in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Summary", "Information", "Payments", "Taken", "By", "Merchant", "Any", "Of", "Merchants", "Mobile", "Staff", "During", "Date", "Range", "", "Date", "Ranges", "Cannot", "Exceed", "Year", "In", "Length", "", "See", "Date", "Rangesdetails", "Of", "Inclusive", "Exclusive", "Dates"]}}, "/v1/{location_id}/payments/{payment_id}"=>{"get"=>{"summary"=>"Provides comprehensive information for a single payment.", "description"=>"Provides comprehensive information for a single payment.", "operationId"=>"RetrievePayment", "x-api-path-slug"=>"v1location-idpaymentspayment-id-get", "parameters"=>[{"in"=>"path", "name"=>"location_id", "description"=>"The ID of the payments associated location"}, {"in"=>"path", "name"=>"payment_id", "description"=>"The payments Square-issued ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Comprehensive", "Informationa", "Single", "Payment"]}}, "/v1/{location_id}/refunds"=>{"get"=>{"summary"=>"Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length.", "description"=>"Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length.", "operationId"=>"v1.location_id.refunds.get", "x-api-path-slug"=>"v1location-idrefunds-get", "parameters"=>[{"in"=>"query", "name"=>"batch_token", "description"=>"A pagination cursor to retrieve the next set of results for youroriginal query to the endpoint"}, {"in"=>"query", "name"=>"begin_time", "description"=>"The beginning of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"end_time", "description"=>"The end of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of payments to return in a single response"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to list refunds for"}, {"in"=>"query", "name"=>"order", "description"=>"TThe order in which payments are listed in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Details", "Refunds", "Initiated", "By", "Merchant", "Any", "Of", "Merchants", "Mobile", "Staff", "During", "Date", "Range", "", "Date", "Ranges", "Cannot", "Exceed", "Year", "In", "Length"]}, "post"=>{"summary"=>"Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment.", "description"=>"Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment.", "operationId"=>"v1.location_id.refunds.post", "x-api-path-slug"=>"v1location-idrefunds-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the original payments associated location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Issues", "Refunda", "Previously", "Processed", "Payment", "", "You", "Must", "Issue", "Refund", "Within", "60", "Days", "Of", "Associated", "Payment"]}}, "/v1/{location_id}/settlements"=>{"get"=>{"summary"=>"Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length.", "description"=>"Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length.", "operationId"=>"ListSettlements", "x-api-path-slug"=>"v1location-idsettlements-get", "parameters"=>[{"in"=>"query", "name"=>"batch_token", "description"=>"A pagination cursor to retrieve the next set of results for youroriginal query to the endpoint"}, {"in"=>"query", "name"=>"begin_time", "description"=>"The beginning of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"end_time", "description"=>"The end of the requested reporting period, in ISO 8601 format"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of payments to return in a single response"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to list settlements for"}, {"in"=>"query", "name"=>"order", "description"=>"TThe order in which payments are listed in the response"}, {"in"=>"query", "name"=>"status", "description"=>"Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Summary", "Information", "Deposits", "Withdrawals", "Initiated", "By", "Square", "To", "Merchants", "Bank", "Account", "During", "Date", "Range", "", "Date", "Ranges", "Cannot", "Exceed", "Year", "In", "Length"]}}, "/v1/{location_id}/settlements/{settlement_id}"=>{"get"=>{"summary"=>"Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total.", "description"=>"Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total.", "operationId"=>"RetrieveSettlement", "x-api-path-slug"=>"v1location-idsettlementssettlement-id-get", "parameters"=>[{"in"=>"path", "name"=>"location_id", "description"=>"The ID of the settlementss associated location"}, {"in"=>"path", "name"=>"settlement_id", "description"=>"The settlements Square-issued ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provides", "Comprehensive", "Informationa", "Single", "Settlement", "", "Including", "Entries", "That", "Contribute", "To", "Settlements", "Total"]}}, "/v2/catalog/batch-delete"=>{"post"=>{"summary"=>"BatchDeleteCatalogObjects", "description"=>"Deletes a set of [CatalogItem](#type-catalogitem)s based on the\nprovided list of target IDs and returns a set of successfully deleted IDs in\nthe response. Deletion is a cascading event such that all children of the\ntargeted object are also deleted. For example, deleting a CatalogItem will\nalso delete all of its [CatalogItemVariation](#type-catalogitemvariation)\nchildren.\n\n`BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted\nIDs can be deleted. The response will only include IDs that were\nactually deleted.", "operationId"=>"BatchDeleteCatalogObjects", "x-api-path-slug"=>"v2catalogbatchdelete-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BatchCatalogObjects"]}}, "/v2/catalog/batch-retrieve"=>{"post"=>{"summary"=>"BatchRetrieveCatalogObjects", "description"=>"Returns a set of objects based on the provided ID.\nEach [CatalogItem](#type-catalogitem) returned in the set includes all of its\nchild information including: all of its\n[CatalogItemVariation](#type-catalogitemvariation) objects, references to\nits [CatalogModifierList](#type-catalogmodifierlist) objects, and the ids of\nany [CatalogTax](#type-catalogtax) objects that apply to it.", "operationId"=>"BatchRetrieveCatalogObjects", "x-api-path-slug"=>"v2catalogbatchretrieve-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BatchRetrieveCatalogObjects"]}}, "/v2/catalog/batch-upsert"=>{"post"=>{"summary"=>"BatchUpsertCatalogObjects", "description"=>"Creates or updates up to 10,000 target objects based on the provided\nlist of objects. The target objects are grouped into batches and each batch is\ninserted/updated in an all-or-nothing manner. If an object within a batch is\nmalformed in some way, or violates a database constraint, the entire batch\ncontaining that item will be disregarded. However, other batches in the same\nrequest may still succeed. Each batch may contain up to 1,000 objects, and\nbatches will be processed in order as long as the total object count for the\nrequest (items, variations, modifier lists, discounts, and taxes) is no more\nthan 10,000.", "operationId"=>"BatchUpsertCatalogObjects", "x-api-path-slug"=>"v2catalogbatchupsert-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BatchUpsertCatalogObjects"]}}, "/v2/catalog/info"=>{"get"=>{"summary"=>"CatalogInfo", "description"=>"Returns information about the Square Catalog API, such as batch size\nlimits for `BatchUpsertCatalogObjects`.", "operationId"=>"CatalogInfo", "x-api-path-slug"=>"v2cataloginfo-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CatalogInfo"]}}, "/v2/catalog/list"=>{"get"=>{"summary"=>"ListCatalog", "description"=>"Returns a list of [CatalogObject](#type-catalogobject)s that includes\nall objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem)\nand [CatalogTax](#type-catalogtax) objects) in the catalog. The types parameter\nis specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types:\n`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`.", "operationId"=>"ListCatalog", "x-api-path-slug"=>"v2cataloglist-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"The pagination cursor returned in the previous response"}, {"in"=>"query", "name"=>"types", "description"=>"An optional case-insensitive, comma-separated list of object types to retrieve, for example`ITEM,ITEM_VARIATION,CATEGORY`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ListCatalog"]}}, "/v2/catalog/object"=>{"post"=>{"summary"=>"UpsertCatalogObject", "description"=>"Creates or updates the target [CatalogObject](#type-catalogobject).", "operationId"=>"UpsertCatalogObject", "x-api-path-slug"=>"v2catalogobject-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["UpsertCatalogObject"]}}, "/v2/catalog/object/{object_id}"=>{"delete"=>{"summary"=>"DeleteCatalogObject", "description"=>"Deletes a single [CatalogObject](#type-catalogobject) based on the\nprovided ID and returns the set of successfully deleted IDs in the response.\nDeletion is a cascading event such that all children of the targeted object\nare also deleted. For example, deleting a [CatalogItem](#type-catalogitem)\nwill also delete all of its\n[CatalogItemVariation](#type-catalogitemvariation) children.", "operationId"=>"DeleteCatalogObject", "x-api-path-slug"=>"v2catalogobjectobject-id-delete", "parameters"=>[{"in"=>"path", "name"=>"object_id", "description"=>"The ID of the [CatalogObject](#type-catalogobject) to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CatalogObject"]}, "get"=>{"summary"=>"RetrieveCatalogObject", "description"=>"Returns a single [CatalogItem](#type-catalogitem) as a\n[CatalogObject](#type-catalogobject) based on the provided ID. The returned\nobject includes all of the relevant [CatalogItem](#type-catalogitem)\ninformation including: [CatalogItemVariation](#type-catalogitemvariation)\nchildren, references to its\n[CatalogModifierList](#type-catalogmodifierlist) objects, and the ids of\nany [CatalogTax](#type-catalogtax) objects that apply to it.", "operationId"=>"RetrieveCatalogObject", "x-api-path-slug"=>"v2catalogobjectobject-id-get", "parameters"=>[{"in"=>"query", "name"=>"include_related_objects", "description"=>"If `true`, the response will include additional objects that are related to therequested object, as follows:If the `object` field of the response contains a [CatalogItem](#type-catalogitem),its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and[CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of theresponse"}, {"in"=>"path", "name"=>"object_id", "description"=>"The object ID of any type of [CatalogObject](#type-catalogobject)s to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RetrieveCatalogObject"]}}, "/v2/catalog/search"=>{"post"=>{"summary"=>"SearchCatalogObjects", "description"=>"Queries the targeted catalog using a variety of query types\n([CatalogQuerySortedAttribute](#type-catalogquerysortedattribute),\n([CatalogQueryExact](#type-catalogqueryexact),\n([CatalogQueryRange](#type-catalogqueryrange),\n([CatalogQueryText](#type-catalogquerytext),\n([CatalogQueryItemsForTax](#type-catalogqueryitemsfortax),\n([CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist)).", "operationId"=>"SearchCatalogObjects", "x-api-path-slug"=>"v2catalogsearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SearchCatalogObjects"]}}, "/v2/catalog/update-item-modifier-lists"=>{"post"=>{"summary"=>"UpdateItemModifierLists", "description"=>"Updates the [CatalogModifierList](#type-catalogmodifierlist) objects\nthat apply to the targeted [CatalogItem](#type-catalogitem) without having\nto perform an upsert on the entire item.", "operationId"=>"UpdateItemModifierLists", "x-api-path-slug"=>"v2catalogupdateitemmodifierlists-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ItemModifierLists"]}}, "/v2/catalog/update-item-taxes"=>{"post"=>{"summary"=>"UpdateItemTaxes", "description"=>"Updates the [CatalogTax](#type-catalogtax) objects that apply to the\ntargeted [CatalogItem](#type-catalogitem) without having to perform an\nupsert on the entire item.", "operationId"=>"UpdateItemTaxes", "x-api-path-slug"=>"v2catalogupdateitemtaxes-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ItemTaxes"]}}, "/v2/customers"=>{"get"=>{"summary"=>"ListCustomers", "description"=>"Lists a business's customers.", "operationId"=>"ListCustomers", "x-api-path-slug"=>"v2customers-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The value to provide in the Authorization header ofyour request"}, {"in"=>"query", "name"=>"cursor", "description"=>"A pagination cursor returned by a previous call to this endpoint"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ListCustomers"]}, "post"=>{"summary"=>"CreateCustomer", "description"=>"Creates a new customer for a business, which can have associated cards on file.\n\nYou must provide __at least one__ of the following values in your request to this\nendpoint:\n\n- `given_name`\n- `family_name`\n- `company_name`\n- `email_address`\n- `phone_number`\n\nThis endpoint does not accept an idempotency key. If you accidentally create\na duplicate customer, you can delete it with the\n[DeleteCustomer](#endpoint-deletecustomer) endpoint.", "operationId"=>"CreateCustomer", "x-api-path-slug"=>"v2customers-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The value to provide in the Authorization header ofyour request"}, {"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreateCustomer"]}}, "/v2/customers/{customer_id}"=>{"delete"=>{"summary"=>"DeleteCustomer", "description"=>"Deletes a customer from a business, along with any linked cards on file.", "operationId"=>"DeleteCustomer", "x-api-path-slug"=>"v2customerscustomer-id-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The value to provide in the Authorization header ofyour request"}, {"in"=>"path", "name"=>"customer_id", "description"=>"The ID of the customer to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer"]}, "get"=>{"summary"=>"RetrieveCustomer", "description"=>"Returns details for a single customer.", "operationId"=>"RetrieveCustomer", "x-api-path-slug"=>"v2customerscustomer-id-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The value to provide in the Authorization header ofyour request"}, {"in"=>"path", "name"=>"customer_id", "description"=>"The ID of the customer to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RetrieveCustomer"]}, "put"=>{"summary"=>"UpdateCustomer", "description"=>"Updates the details of an existing customer.\nThe ID of the customer may change if the customer has been merged into another customer.\n\nYou cannot edit a customer's cards on file with this endpoint. To make changes\nto a card on file, you must delete the existing card on file with the\n[DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the\n[CreateCustomerCard](#endpoint-createcustomercard) endpoint.", "operationId"=>"UpdateCustomer", "x-api-path-slug"=>"v2customerscustomer-id-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The value to provide in the Authorization header ofyour request"}, {"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customer_id", "description"=>"The ID of the customer to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer"]}}, "/v2/customers/{customer_id}/cards"=>{"post"=>{"summary"=>"CreateCustomerCard", "description"=>"Adds a card on file to an existing customer. In the United States\nSquare takes care of automatically updating any cards on file that might\nhave expired since you first attached them to a customer.", "operationId"=>"CreateCustomerCard", "x-api-path-slug"=>"v2customerscustomer-idcards-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The value to provide in the Authorization header ofyour request"}, {"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customer_id", "description"=>"The ID of the customer to link the card on file to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreateCustomerCard"]}}, "/v2/customers/{customer_id}/cards/{card_id}"=>{"delete"=>{"summary"=>"DeleteCustomerCard", "description"=>"Removes a card on file from a customer.", "operationId"=>"DeleteCustomerCard", "x-api-path-slug"=>"v2customerscustomer-idcardscard-id-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The value to provide in the Authorization header ofyour request"}, {"in"=>"path", "name"=>"card_id", "description"=>"The ID of the card on file to delete"}, {"in"=>"path", "name"=>"customer_id", "description"=>"The ID of the customer that the card on file belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CustomerCard"]}}, "/v2/locations"=>{"get"=>{"summary"=>"ListLocations", "description"=>"Provides the details for all of a business's locations.\n\nMost other Connect API endpoints have a required `location_id` path parameter.\nThe `id` field of the [`Location`](#type-location) objects returned by this\nendpoint correspond to that `location_id` parameter.", "operationId"=>"v2.locations.get", "x-api-path-slug"=>"v2locations-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The value to provide in the Authorization header ofyour request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ListLocations"]}}, "/v2/locations/{location_id}/checkouts"=>{"post"=>{"summary"=>"CreateCheckout", "description"=>"Creates a [Checkout](#type-checkout) response that links a\n`checkoutId` and `checkout_page_url` that customers can be directed to in\norder to provide their payment information using a payment processing\nworkflow hosted on connect.squareup.com.", "operationId"=>"CreateCheckout", "x-api-path-slug"=>"v2locationslocation-idcheckouts-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The value to provide in the Authorization header ofyour request"}, {"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the business location to associate the checkout with"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreateCheckout"]}}, "/v2/locations/{location_id}/refunds"=>{"get"=>{"summary"=>"ListRefunds", "description"=>"Lists refunds for one of a business's locations.\n\nRefunds with a `status` of `PENDING` are not currently included in this\nendpoint's response.\n\nMax results per [page](#paginatingresults): 50", "operationId"=>"v2.locations.location_id.refunds.get", "x-api-path-slug"=>"v2locationslocation-idrefunds-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The value to provide in the Authorization header ofyour request"}, {"in"=>"query", "name"=>"begin_time", "description"=>"The beginning of the requested reporting period, in RFC 3339 format"}, {"in"=>"query", "name"=>"cursor", "description"=>"A pagination cursor returned by a previous call to this endpoint"}, {"in"=>"query", "name"=>"end_time", "description"=>"The end of the requested reporting period, in RFC 3339 format"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to list refunds for"}, {"in"=>"query", "name"=>"sort_order", "description"=>"The order in which results are listed in the response (`ASC` foroldest first, `DESC` for newest first)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ListRefunds"]}}, "/v2/locations/{location_id}/transactions"=>{"get"=>{"summary"=>"ListTransactions", "description"=>"Lists transactions for a particular location.\n\nMax results per [page](#paginatingresults): 50", "operationId"=>"ListTransactions", "x-api-path-slug"=>"v2locationslocation-idtransactions-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The value to provide in the Authorization header ofyour request"}, {"in"=>"query", "name"=>"begin_time", "description"=>"The beginning of the requested reporting period, in RFC 3339 format"}, {"in"=>"query", "name"=>"cursor", "description"=>"A pagination cursor returned by a previous call to this endpoint"}, {"in"=>"query", "name"=>"end_time", "description"=>"The end of the requested reporting period, in RFC 3339 format"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to list transactions for"}, {"in"=>"query", "name"=>"sort_order", "description"=>"The order in which results are listed in the response (`ASC` foroldest first, `DESC` for newest first)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ListTransactions"]}, "post"=>{"summary"=>"Charge", "description"=>"Charges a card represented by a card nonce or a customer's card on file.\n\nYour request to this endpoint must include _either_:\n\n- A value for the `card_nonce` parameter (to charge a card nonce generated\nwith the `SqPaymentForm`)\n- Values for the `customer_card_id` and `customer_id` parameters (to charge\na customer's card on file)\n\nIn order for an e-commerce payment to potentially qualify for\n[Square chargeback protection](https://squareup.com/help/article/5394), you\n_must_ provide values for the following parameters in your request:\n\n- `buyer_email_address`\n- At least one of `billing_address` or `shipping_address`\n\nWhen this response is returned, the amount of Square's processing fee might not yet be\ncalculated. To obtain the processing fee, wait about ten seconds and call\n[RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money`\nfield of each [Tender included](#type-tender) in the transaction.", "operationId"=>"Charge", "x-api-path-slug"=>"v2locationslocation-idtransactions-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The value to provide in the Authorization header ofyour request"}, {"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the location to associate the created transaction with"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Charge"]}}, "/v2/locations/{location_id}/transactions/{transaction_id}"=>{"get"=>{"summary"=>"RetrieveTransaction", "description"=>"Retrieves details for a single transaction.", "operationId"=>"RetrieveTransaction", "x-api-path-slug"=>"v2locationslocation-idtransactionstransaction-id-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The value to provide in the Authorization header ofyour request"}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the transactions associated location"}, {"in"=>"path", "name"=>"transaction_id", "description"=>"The ID of the transaction to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RetrieveTransaction"]}}, "/v2/locations/{location_id}/transactions/{transaction_id}/capture"=>{"post"=>{"summary"=>"CaptureTransaction", "description"=>"Captures a transaction that was created with the [Charge](#endpoint-charge)\nendpoint with a `delay_capture` value of `true`.\n\nSee [Delayed capture transactions](/articles/delayed-capture-transactions/)\nfor more information.", "operationId"=>"CaptureTransaction", "x-api-path-slug"=>"v2locationslocation-idtransactionstransaction-idcapture-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The value to provide in the Authorization header ofyour request"}, {"in"=>"path", "name"=>"location_id"}, {"in"=>"path", "name"=>"transaction_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CaptureTransaction"]}}, "/v2/locations/{location_id}/transactions/{transaction_id}/refund"=>{"post"=>{"summary"=>"CreateRefund", "description"=>"Initiates a refund for a previously charged tender.\n\nYou must issue a refund within 120 days of the associated payment. See\n(this article)[https://squareup.com/help/us/en/article/5060] for more information\non refund behavior.", "operationId"=>"v2.locations.location_id.transactions.transaction_id.refund.post", "x-api-path-slug"=>"v2locationslocation-idtransactionstransaction-idrefund-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The value to provide in the Authorization header ofyour request"}, {"in"=>"body", "name"=>"body", "description"=>"An object containing the fields to POST for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location_id", "description"=>"The ID of the original transactions associated location"}, {"in"=>"path", "name"=>"transaction_id", "description"=>"The ID of the original transaction that includes the tender to refund"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreateRefund"]}}, "/v2/locations/{location_id}/transactions/{transaction_id}/void"=>{"post"=>{"summary"=>"VoidTransaction", "description"=>"Cancels a transaction that was created with the [Charge](#endpoint-charge)\nendpoint with a `delay_capture` value of `true`.\n\nSee [Delayed capture transactions](/articles/delayed-capture-transactions/)\nfor more information.", "operationId"=>"VoidTransaction", "x-api-path-slug"=>"v2locationslocation-idtransactionstransaction-idvoid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The value to provide in the Authorization header ofyour request"}, {"in"=>"path", "name"=>"location_id"}, {"in"=>"path", "name"=>"transaction_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VoidTransaction"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
steem{"steem-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Steem", "x-complete"=>1, "info"=>{"title"=>"Interactive Steem API", "description"=>"interactive-steem-api-lets-you-interact-with-steem-blockchain-and-make-a-request-get-output-and-start-implementing-new-apps-apis-have-default-parameters-set-to-get-you-started-and-see-how-request-works--api-list-is-compiled-from-steem-githubhttpsgithub-comsteemitsteem-1httpsgithub-comsteemitsteemtreemasterlibrariesappincludesteemitappapi-hpp-and-2httpsgithub-comsteemitsteemtreemasterlibrariesappincludesteemitappdatabase-api-hpp--if-you-want-to-contribute-documenting-detail-of-properties-and-output-contact-goodkarmahttpssteemit-chatdirectgoodkarma--you-can-also-check-full-list-here-steem-jshttpssteemjs-com", "version"=>"1.0.0"}, "host"=>"api.steemjs.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/get_version"=>{"get"=>{"summary"=>"get version of Steem", "description"=>"Returns version information of connected Steem node/websocket.", "operationId"=>"returns-version-information-of-connected-steem-nodewebsocket", "x-api-path-slug"=>"get-version-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Version", "Of", "Steem"]}}, "/get_account_count"=>{"get"=>{"summary"=>"number of accounts", "description"=>"Get Number of Accounts from Steem", "operationId"=>"get-number-of-accounts-from-steem", "x-api-path-slug"=>"get-account-count-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Number", "Of", "Accounts"]}}, "/get_chain_properties"=>{"get"=>{"summary"=>"get chain properties", "description"=>"get chain properties", "operationId"=>"get-chain-properties", "x-api-path-slug"=>"get-chain-properties-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Chain", "Properties"]}}, "/get_config"=>{"get"=>{"summary"=>"get config", "description"=>"get config", "operationId"=>"get-config", "x-api-path-slug"=>"get-config-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Config"]}}, "/get_dynamic_global_properties"=>{"get"=>{"summary"=>"get_dynamic_global_properties", "description"=>"get_dynamic_global_properties", "operationId"=>"get-dynamic-global-properties", "x-api-path-slug"=>"get-dynamic-global-properties-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Dynamic", "Global", "Properties"]}}, "/get_feed_history"=>{"get"=>{"summary"=>"get_feed_history", "description"=>"get_feed_history", "operationId"=>"get-feed-history", "x-api-path-slug"=>"get-feed-history-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Feed", "History"]}}, "/get_current_median_history_price"=>{"get"=>{"summary"=>"get_current_median_history_price", "description"=>"get_current_median_history_price", "operationId"=>"get-current-median-history-price", "x-api-path-slug"=>"get-current-median-history-price-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Current", "Median", "History", "Price"]}}, "/get_hardfork_version"=>{"get"=>{"summary"=>"get_hardfork_version", "description"=>"get_hardfork_version", "operationId"=>"get-hardfork-version", "x-api-path-slug"=>"get-hardfork-version-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Hardfork", "Version"]}}, "/get_next_scheduled_hardfork"=>{"get"=>{"summary"=>"get_next_scheduled_hardfork", "description"=>"get_next_scheduled_hardfork", "operationId"=>"get-next-scheduled-hardfork", "x-api-path-slug"=>"get-next-scheduled-hardfork-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Next", "Scheduled", "Hardfork"]}}, "/get_witness_count"=>{"get"=>{"summary"=>"get_witness_count", "description"=>"get_witness_count", "operationId"=>"get-witness-count", "x-api-path-slug"=>"get-witness-count-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Witness", "Count"]}}, "/lookup_witness_accounts"=>{"get"=>{"summary"=>"lookup_witness_accounts", "description"=>"lookup_witness_accounts regex search", "operationId"=>"lookup-witness-accounts-regex-search", "x-api-path-slug"=>"lookup-witness-accounts-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"limit"}, {"in"=>"query", "name"=>"lowerBoundName", "description"=>"lowerBoundName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lookup", "Witness", "Accounts"]}}, "/get_witness_schedule"=>{"get"=>{"summary"=>"get_witness_schedule", "description"=>"get_witness_schedule", "operationId"=>"get-witness-schedule", "x-api-path-slug"=>"get-witness-schedule-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Witness", "Schedule"]}}, "/get_witnesses"=>{"get"=>{"summary"=>"get_witnesses", "description"=>"get_witnesses", "operationId"=>"get-witnesses", "x-api-path-slug"=>"get-witnesses-get", "parameters"=>[{"in"=>"query", "name"=>"witnessIds", "description"=>"witnessIds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Witnesses"]}}, "/get_witness_by_account"=>{"get"=>{"summary"=>"get_witness_by_account", "description"=>"get_witness_by_account", "operationId"=>"get-witness-by-account", "x-api-path-slug"=>"get-witness-by-account-get", "parameters"=>[{"in"=>"query", "name"=>"accountName", "description"=>"witness account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Witness", "By", "Account"]}}, "/get_witnesses_by_vote"=>{"get"=>{"summary"=>"get_witnesses_by_vote", "description"=>"get_witnesses_by_vote", "operationId"=>"get-witnesses-by-vote", "x-api-path-slug"=>"get-witnesses-by-vote-get", "parameters"=>[{"in"=>"query", "name"=>"from", "description"=>"from witness"}, {"in"=>"query", "name"=>"limit", "description"=>"limit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Witnesses", "By", "Vote"]}}, "/get_active_witnesses"=>{"get"=>{"summary"=>"get_active_witnesses", "description"=>"get_active_witnesses", "operationId"=>"get-active-witnesses", "x-api-path-slug"=>"get-active-witnesses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Active", "Witnesses"]}}, "/witness_update"=>{"get"=>{"summary"=>"witness_update", "description"=>"witness_update", "operationId"=>"witness-update", "x-api-path-slug"=>"witness-update-get", "parameters"=>[{"in"=>"query", "name"=>"block_signing_key", "description"=>"block_signing_key"}, {"in"=>"query", "name"=>"fee", "description"=>"fee"}, {"in"=>"query", "name"=>"owner", "description"=>"witness name"}, {"in"=>"query", "name"=>"props", "description"=>"props"}, {"in"=>"query", "name"=>"url", "description"=>"url"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Witness", "Update"]}}, "/get_miner_queue"=>{"get"=>{"summary"=>"get_miner_queue", "description"=>"get_miner_queue", "operationId"=>"get-miner-queue", "x-api-path-slug"=>"get-miner-queue-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Miner", "Queue"]}}, "/get_liquidity_queue"=>{"get"=>{"summary"=>"get_liquidity_queue", "description"=>"get_liquidity_queue", "operationId"=>"get-liquidity-queue", "x-api-path-slug"=>"get-liquidity-queue-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"limit"}, {"in"=>"query", "name"=>"startAccount", "description"=>"account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Liquidity", "Queue"]}}, "/get_open_orders"=>{"get"=>{"summary"=>"get_open_orders", "description"=>"get_open_orders", "operationId"=>"get-open-orders", "x-api-path-slug"=>"get-open-orders-get", "parameters"=>[{"in"=>"query", "name"=>"owner", "description"=>"account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Open", "Orders"]}}, "/get_order_book"=>{"get"=>{"summary"=>"get_order_book", "description"=>"get_order_book", "operationId"=>"get-order-book", "x-api-path-slug"=>"get-order-book-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"limit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Order", "Book"]}}, "/get_active_categories"=>{"get"=>{"summary"=>"get active categories", "description"=>"get tags", "operationId"=>"get-tags", "x-api-path-slug"=>"get-active-categories-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"after string"}, {"in"=>"query", "name"=>"limit", "description"=>"limit size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Active", "Categories"]}}, "/get_best_categories"=>{"get"=>{"summary"=>"get best categories", "description"=>"get tags", "operationId"=>"get-tags", "x-api-path-slug"=>"get-best-categories-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"after"}, {"in"=>"query", "name"=>"limit", "description"=>"limits"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Best", "Categories"]}}, "/get_recent_categories"=>{"get"=>{"summary"=>"get recent categories", "description"=>"get tags", "operationId"=>"get-tags", "x-api-path-slug"=>"get-recent-categories-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"after"}, {"in"=>"query", "name"=>"limit", "description"=>"limit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Recent", "Categories"]}}, "/get_trending_categories"=>{"get"=>{"summary"=>"get trending categories", "description"=>"get tags", "operationId"=>"get-tags", "x-api-path-slug"=>"get-trending-categories-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"after"}, {"in"=>"query", "name"=>"limit", "description"=>"limits"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Trending", "Categories"]}}, "/get_trending_tags"=>{"get"=>{"summary"=>"get trending categories", "description"=>"get tags", "operationId"=>"get-tags", "x-api-path-slug"=>"get-trending-tags-get", "parameters"=>[{"in"=>"query", "name"=>"afterTag", "description"=>"category"}, {"in"=>"query", "name"=>"limit", "description"=>"limits"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Trending", "Categories"]}}, "/get_content"=>{"get"=>{"summary"=>"get content", "description"=>"get content", "operationId"=>"get-content", "x-api-path-slug"=>"get-content-get", "parameters"=>[{"in"=>"query", "name"=>"author", "description"=>"author"}, {"in"=>"query", "name"=>"permlink", "description"=>"permlink"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Content"]}}, "/get_content_replies"=>{"get"=>{"summary"=>"get content replies", "description"=>"get content replies", "operationId"=>"get-content-replies", "x-api-path-slug"=>"get-content-replies-get", "parameters"=>[{"in"=>"query", "name"=>"author", "description"=>"author"}, {"in"=>"query", "name"=>"permlink", "description"=>"permlink"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Content", "Replies"]}}, "/get_discussions_by_trending"=>{"get"=>{"summary"=>"get discussions", "description"=>"get discussions, | query example {\"limit\":\"10\", \"tag\":\"steem\"} OR {\"start_author\":\"author\", \"permlink\":\"permlink\"} for pagination", "operationId"=>"get-discussions--query-example-limit10-tagsteem-or-start-authorauthor-permlinkpermlink-for-paginatio", "x-api-path-slug"=>"get-discussions-by-trending-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"query object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Discussions"]}}, "/get_discussions_by_trending30"=>{"get"=>{"summary"=>"get discussions", "description"=>"get discussions, | query example {\"limit\":\"10\", \"tag\":\"steem\"} OR {\"start_author\":\"author\", \"permlink\":\"permlink\"} for pagination", "operationId"=>"get-discussions--query-example-limit10-tagsteem-or-start-authorauthor-permlinkpermlink-for-paginatio", "x-api-path-slug"=>"get-discussions-by-trending30-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"query object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Discussions"]}}, "/get_discussions_by_created"=>{"get"=>{"summary"=>"get discussions", "description"=>"get discussions, | query example {\"limit\":\"10\", \"tag\":\"steem\"} OR {\"start_author\":\"author\", \"permlink\":\"permlink\"} for pagination", "operationId"=>"get-discussions--query-example-limit10-tagsteem-or-start-authorauthor-permlinkpermlink-for-paginatio", "x-api-path-slug"=>"get-discussions-by-created-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"query object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Discussions"]}}, "/get_discussions_by_active"=>{"get"=>{"summary"=>"get discussions", "description"=>"get discussions, | query example {\"limit\":\"10\", \"tag\":\"steem\"} OR {\"start_author\":\"author\", \"permlink\":\"permlink\"} for pagination", "operationId"=>"get-discussions--query-example-limit10-tagsteem-or-start-authorauthor-permlinkpermlink-for-paginatio", "x-api-path-slug"=>"get-discussions-by-active-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"query object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Discussions"]}}, "/get_discussions_by_promoted"=>{"get"=>{"summary"=>"get discussions", "description"=>"get discussions, | query example {\"limit\":\"10\", \"tag\":\"steem\"} OR {\"start_author\":\"author\", \"permlink\":\"permlink\"} for pagination", "operationId"=>"get-discussions--query-example-limit10-tagsteem-or-start-authorauthor-permlinkpermlink-for-paginatio", "x-api-path-slug"=>"get-discussions-by-promoted-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"query object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Discussions"]}}, "/get_discussions_by_cashout"=>{"get"=>{"summary"=>"get discussions", "description"=>"get discussions, | query example {\"limit\":\"10\", \"tag\":\"steem\"} OR {\"start_author\":\"author\", \"permlink\":\"permlink\"} for pagination", "operationId"=>"get-discussions--query-example-limit10-tagsteem-or-start-authorauthor-permlinkpermlink-for-paginatio", "x-api-path-slug"=>"get-discussions-by-cashout-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"query object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Discussions"]}}, "/get_discussions_by_payout"=>{"get"=>{"summary"=>"get discussions", "description"=>"get discussions, | query example {\"limit\":\"10\", \"tag\":\"steem\"} OR {\"start_author\":\"author\", \"permlink\":\"permlink\"} for pagination", "operationId"=>"get-discussions--query-example-limit10-tagsteem-or-start-authorauthor-permlinkpermlink-for-paginatio", "x-api-path-slug"=>"get-discussions-by-payout-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"query object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Discussions"]}}, "/get_discussions_by_votes"=>{"get"=>{"summary"=>"get discussions", "description"=>"get discussions, | query example {\"limit\":\"10\", \"tag\":\"steem\"} OR {\"start_author\":\"author\", \"permlink\":\"permlink\"} for pagination", "operationId"=>"get-discussions--query-example-limit10-tagsteem-or-start-authorauthor-permlinkpermlink-for-paginatio", "x-api-path-slug"=>"get-discussions-by-votes-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"query object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Discussions"]}}, "/get_discussions_by_children"=>{"get"=>{"summary"=>"get discussions", "description"=>"get discussions, | query example {\"limit\":\"10\", \"tag\":\"steem\"} OR {\"start_author\":\"author\", \"permlink\":\"permlink\"} for pagination", "operationId"=>"get-discussions--query-example-limit10-tagsteem-or-start-authorauthor-permlinkpermlink-for-paginatio", "x-api-path-slug"=>"get-discussions-by-children-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"query object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Discussions"]}}, "/get_discussions_by_hot"=>{"get"=>{"summary"=>"get discussions", "description"=>"get discussions, | query example {\"limit\":\"10\", \"tag\":\"steem\"} OR {\"start_author\":\"author\", \"permlink\":\"permlink\"} for pagination", "operationId"=>"get-discussions--query-example-limit10-tagsteem-or-start-authorauthor-permlinkpermlink-for-paginatio", "x-api-path-slug"=>"get-discussions-by-hot-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"query object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Discussions"]}}, "/get_discussions_by_feed"=>{"get"=>{"summary"=>"get discussions", "description"=>"get discussions, | query example {\"limit\":\"10\", \"tags\":\"good-karma\"} OR {\"start_author\":\"author\", \"permlink\":\"permlink\"} for pagination", "operationId"=>"get-discussions--query-example-limit10-tagsgoodkarma-or-start-authorauthor-permlinkpermlink-for-pagi", "x-api-path-slug"=>"get-discussions-by-feed-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"query object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Discussions"]}}, "/get_discussions_by_blog"=>{"get"=>{"summary"=>"get discussions", "description"=>"get discussions, | query example {\"limit\":\"10\", \"tag\":\"good-karma\"} OR {\"start_author\":\"author\", \"permlink\":\"permlink\"} for pagination", "operationId"=>"get-discussions--query-example-limit10-taggoodkarma-or-start-authorauthor-permlinkpermlink-for-pagin", "x-api-path-slug"=>"get-discussions-by-blog-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"query object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Discussions"]}}, "/get_discussions_by_comments"=>{"get"=>{"summary"=>"get discussions", "description"=>"get discussions, | query example {\"start_author\":\"author\", \"start_permlink\":\"permlink\", \"limi\":\"10\"}", "operationId"=>"get-discussions--query-example-start-authorauthor-start-permlinkpermlink-limi10", "x-api-path-slug"=>"get-discussions-by-comments-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"query object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Discussions"]}}, "/get_discussions_by_author_before_date"=>{"get"=>{"summary"=>"get_discussions_by_author_before_date", "description"=>"get_discussions_by_author_before_date", "operationId"=>"get-discussions-by-author-before-date", "x-api-path-slug"=>"get-discussions-by-author-before-date-get", "parameters"=>[{"in"=>"query", "name"=>"author", "description"=>"account name"}, {"in"=>"query", "name"=>"beforeDate", "description"=>"date and time"}, {"in"=>"query", "name"=>"limit", "description"=>"limit query"}, {"in"=>"query", "name"=>"startPermlink", "description"=>"permlink of post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Discussions", "By", "Author", "Before", "Date"]}}, "/get_replies_by_last_update"=>{"get"=>{"summary"=>"get_replies_by_last_update", "description"=>"get_replies_by_last_update", "operationId"=>"get-replies-by-last-update", "x-api-path-slug"=>"get-replies-by-last-update-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"limit query"}, {"in"=>"query", "name"=>"startAuthor", "description"=>"account name"}, {"in"=>"query", "name"=>"startPermlink", "description"=>"permlink of post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Replies", "By", "Last", "Update"]}}, "/get_state"=>{"get"=>{"summary"=>"get_state", "description"=>"get_state", "operationId"=>"get-state", "x-api-path-slug"=>"get-state-get", "parameters"=>[{"in"=>"query", "name"=>"path", "description"=>"account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "State"]}}, "/get_active_votes"=>{"get"=>{"summary"=>"get_active_votes", "description"=>"get_active_votes", "operationId"=>"get-active-votes", "x-api-path-slug"=>"get-active-votes-get", "parameters"=>[{"in"=>"query", "name"=>"author", "description"=>"account name"}, {"in"=>"query", "name"=>"permlink", "description"=>"permlink of post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Active", "Votes"]}}, "/get_account_votes"=>{"get"=>{"summary"=>"get_account_votes", "description"=>"get_account_votes", "operationId"=>"get-account-votes", "x-api-path-slug"=>"get-account-votes-get", "parameters"=>[{"in"=>"query", "name"=>"voter", "description"=>"account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Account", "Votes"]}}, "/get_account_history"=>{"get"=>{"summary"=>"Account history", "description"=>"Account history", "operationId"=>"account-history", "x-api-path-slug"=>"get-account-history-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"name of account"}, {"in"=>"query", "name"=>"from", "description"=>"from"}, {"in"=>"query", "name"=>"limit", "description"=>"limit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "History"]}}, "/get_owner_history"=>{"get"=>{"summary"=>"get_owner_history", "description"=>"get_owner_history", "operationId"=>"get-owner-history", "x-api-path-slug"=>"get-owner-history-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Owner", "History"]}}, "/get_accounts"=>{"get"=>{"summary"=>"Account", "description"=>"Get Accounts from Steem", "operationId"=>"get-accounts-from-steem", "x-api-path-slug"=>"get-accounts-get", "parameters"=>[{"in"=>"query", "name"=>"names[]", "description"=>"name of account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/get_conversion_requests"=>{"get"=>{"summary"=>"get conversation", "description"=>"get conversation requests of account", "operationId"=>"get-conversation-requests-of-account", "x-api-path-slug"=>"get-conversion-requests-get", "parameters"=>[{"in"=>"query", "name"=>"accountName", "description"=>"account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Conversation"]}}, "/get_recovery_request"=>{"get"=>{"summary"=>"get_recovery_request", "description"=>"get_recovery_request", "operationId"=>"get-recovery-request", "x-api-path-slug"=>"get-recovery-request-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Recovery", "Request"]}}, "/lookup_account_names"=>{"get"=>{"summary"=>"lookup_account_names", "description"=>"lookup_account_names example of accountNames [\"good-karma\", \"fabien\"]", "operationId"=>"lookup-account-names-example-of-accountnames-goodkarma-fabien", "x-api-path-slug"=>"lookup-account-names-get", "parameters"=>[{"in"=>"query", "name"=>"accountNames", "description"=>"accountNames [good-karma, fabien]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lookup", "Account", "Names"]}}, "/lookup_accounts"=>{"get"=>{"summary"=>"lookup_accounts", "description"=>"lookup_accounts regex search", "operationId"=>"lookup-accounts-regex-search", "x-api-path-slug"=>"lookup-accounts-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"limit"}, {"in"=>"query", "name"=>"lowerBoundName", "description"=>"lowerBoundName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lookup", "Accounts"]}}, "/get_follow_count"=>{"get"=>{"summary"=>"get_follow_count", "description"=>"get_follow_count", "operationId"=>"get-follow-count", "x-api-path-slug"=>"get-follow-count-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Follow", "Count"]}}, "/get_followers"=>{"get"=>{"summary"=>"get_followers", "description"=>"get_followers", "operationId"=>"get-followers", "x-api-path-slug"=>"get-followers-get", "parameters"=>[{"in"=>"query", "name"=>"following", "description"=>"account name"}, {"in"=>"query", "name"=>"followType", "description"=>"follow type blog, etc"}, {"in"=>"query", "name"=>"limit", "description"=>"size of array for pagination"}, {"in"=>"query", "name"=>"startFollower", "description"=>"account name from followers for pagination"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Followers"]}}, "/get_following"=>{"get"=>{"summary"=>"get_following", "description"=>"get_following", "operationId"=>"get-following", "x-api-path-slug"=>"get-following-get", "parameters"=>[{"in"=>"query", "name"=>"follower", "description"=>"account name"}, {"in"=>"query", "name"=>"followType", "description"=>"follow type blog, etc"}, {"in"=>"query", "name"=>"limit", "description"=>"size of array for pagination"}, {"in"=>"query", "name"=>"startFollowing", "description"=>"account name from followings for pagination"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Following"]}}, "/get_escrow"=>{"get"=>{"summary"=>"get_escrow", "description"=>"get_escrow", "operationId"=>"get-escrow", "x-api-path-slug"=>"get-escrow-get", "parameters"=>[{"in"=>"query", "name"=>"escrowId", "description"=>"id"}, {"in"=>"query", "name"=>"from", "description"=>"account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Escrow"]}}, "/get_withdraw_routes"=>{"get"=>{"summary"=>"get_withdraw_routes", "description"=>"get_withdraw_routes", "operationId"=>"get-withdraw-routes", "x-api-path-slug"=>"get-withdraw-routes-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"account name"}, {"in"=>"query", "name"=>"withdrawRouteType", "description"=>"withdrawRouteType"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Withdraw", "Routes"]}}, "/get_account_bandwidth"=>{"get"=>{"summary"=>"get_account_bandwidth", "description"=>"get_account_bandwidth", "operationId"=>"get-account-bandwidth", "x-api-path-slug"=>"get-account-bandwidth-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"account name"}, {"in"=>"query", "name"=>"bandwidthType", "description"=>"bandwidthType"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Account", "Bandwidth"]}}, "/get_savings_withdraw_from"=>{"get"=>{"summary"=>"get_savings_withdraw_from", "description"=>"get_savings_withdraw_from", "operationId"=>"get-savings-withdraw-from", "x-api-path-slug"=>"get-savings-withdraw-from-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Savings", "Withdraw", "From"]}}, "/get_savings_withdraw_to"=>{"get"=>{"summary"=>"get_savings_withdraw_to", "description"=>"get_savings_withdraw_to", "operationId"=>"get-savings-withdraw-to", "x-api-path-slug"=>"get-savings-withdraw-to-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Savings", "Withdraw", "To"]}}, "/get_block"=>{"get"=>{"summary"=>"get block", "description"=>"get block", "operationId"=>"get-block", "x-api-path-slug"=>"get-block-get", "parameters"=>[{"in"=>"query", "name"=>"blockNum", "description"=>"get block content/transactions"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Block"]}}, "/get_block_header"=>{"get"=>{"summary"=>"get block header", "description"=>"get block header", "operationId"=>"get-block-header", "x-api-path-slug"=>"get-block-header-get", "parameters"=>[{"in"=>"query", "name"=>"blockNum", "description"=>"get block header, witness, timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Block", "Header"]}}, "/get_ops_in_block"=>{"get"=>{"summary"=>"get_ops_in_block", "description"=>"get_ops_in_block", "operationId"=>"get-ops-in-block", "x-api-path-slug"=>"get-ops-in-block-get", "parameters"=>[{"in"=>"query", "name"=>"blockNum", "description"=>"block number"}, {"in"=>"query", "name"=>"onlyVirtual", "description"=>"onlyVirtual"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Ops", "In", "Block"]}}, "/get_transaction_hex"=>{"get"=>{"summary"=>"get_transaction_hex", "description"=>"get_transaction_hex", "operationId"=>"get-transaction-hex", "x-api-path-slug"=>"get-transaction-hex-get", "parameters"=>[{"in"=>"query", "name"=>"trx", "description"=>"transaction hex"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Transaction", "Hex"]}}, "/get_transaction"=>{"get"=>{"summary"=>"get_transaction", "description"=>"get_transaction", "operationId"=>"get-transaction", "x-api-path-slug"=>"get-transaction-get", "parameters"=>[{"in"=>"query", "name"=>"trxId", "description"=>"transaction id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Transaction"]}}, "/get_required_signatures"=>{"get"=>{"summary"=>"get_required_signatures", "description"=>"get_required_signatures", "operationId"=>"get-required-signatures", "x-api-path-slug"=>"get-required-signatures-get", "parameters"=>[{"in"=>"query", "name"=>"availableKeys", "description"=>"availableKeys"}, {"in"=>"query", "name"=>"trx", "description"=>"transaction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Required", "Signatures"]}}, "/get_potential_signatures"=>{"get"=>{"summary"=>"get_potential_signatures", "description"=>"get_potential_signatures", "operationId"=>"get-potential-signatures", "x-api-path-slug"=>"get-potential-signatures-get", "parameters"=>[{"in"=>"query", "name"=>"trx", "description"=>"transaction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Potential", "Signatures"]}}, "/verify_authority"=>{"get"=>{"summary"=>"verify_authority", "description"=>"verify_authority", "operationId"=>"verify-authority", "x-api-path-slug"=>"verify-authority-get", "parameters"=>[{"in"=>"query", "name"=>"trx", "description"=>"transaction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Verify", "Authority"]}}, "/verify_account_authority"=>{"get"=>{"summary"=>"verify_account_authority", "description"=>"verify_account_authority", "operationId"=>"verify-account-authority", "x-api-path-slug"=>"verify-account-authority-get", "parameters"=>[{"in"=>"query", "name"=>"nameOrId", "description"=>"nameOrId"}, {"in"=>"query", "name"=>"signers", "description"=>"signers"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Verify", "Account", "Authority"]}}, "/get_key_references"=>{"get"=>{"summary"=>"get_key_references", "description"=>"get_key_references", "operationId"=>"get-key-references", "x-api-path-slug"=>"get-key-references-get", "parameters"=>[{"in"=>"query", "name"=>"key", "description"=>"key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Key", "References"]}}, "/broadcast_transaction"=>{"get"=>{"summary"=>"broadcast_transaction", "description"=>"broadcast_transaction", "operationId"=>"broadcast-transaction", "x-api-path-slug"=>"broadcast-transaction-get", "parameters"=>[{"in"=>"query", "name"=>"trx", "description"=>"transaction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Broadcast", "Transaction"]}}, "/broadcast_transaction_synchronous"=>{"get"=>{"summary"=>"broadcast_transaction_synchronous", "description"=>"broadcast_transaction_synchronous", "operationId"=>"broadcast-transaction-synchronous", "x-api-path-slug"=>"broadcast-transaction-synchronous-get", "parameters"=>[{"in"=>"query", "name"=>"trx", "description"=>"transaction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Broadcast", "Transaction", "Synchronous"]}}, "/broadcast_block"=>{"get"=>{"summary"=>"broadcast_block", "description"=>"broadcast_block", "operationId"=>"broadcast-block", "x-api-path-slug"=>"broadcast-block-get", "parameters"=>[{"in"=>"query", "name"=>"b", "description"=>"block"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Broadcast", "Block"]}}, "/broadcast_transaction_with_callback"=>{"get"=>{"summary"=>"WARNING: can only be used in Steem node or in scripts broadcast_transaction_with_callback", "description"=>"broadcast_transaction_with_callback", "operationId"=>"broadcast-transaction-with-callback", "x-api-path-slug"=>"broadcast-transaction-with-callback-get", "parameters"=>[{"in"=>"query", "name"=>"confirmationCallback", "description"=>"confirmationCallback function"}, {"in"=>"query", "name"=>"trx", "description"=>"transaction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WARNING:", "Can", "Only", "Be", "Used", "In", "Steem", "Node", "In", "Scripts", "Broadcast", "Transaction", "Callback"]}}, "/set_max_block_age"=>{"get"=>{"summary"=>"WARNING: can only be used in Steem node or in scripts set_max_block_age", "description"=>"set_max_block_age", "operationId"=>"set-max-block-age", "x-api-path-slug"=>"set-max-block-age-get", "parameters"=>[{"in"=>"query", "name"=>"maxBlockAge", "description"=>"maxBlockAge"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WARNING:", "Can", "Only", "Be", "Used", "In", "Steem", "Node", "In", "Scripts", "Set", "Max", "Block", "Age"]}}, "/set_subscribe_callback"=>{"get"=>{"summary"=>"WARNING: can only be used in Steem node or in scripts set_subscribe_callback", "description"=>"set_subscribe_callback", "operationId"=>"set-subscribe-callback-", "x-api-path-slug"=>"set-subscribe-callback-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"callback function"}, {"in"=>"query", "name"=>"clearFilter", "description"=>"clearFilter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WARNING:", "Can", "Only", "Be", "Used", "In", "Steem", "Node", "In", "Scripts", "Set", "Subscribe", "Callback"]}}, "/set_pending_transaction_callback"=>{"get"=>{"summary"=>"WARNING: can only be used in Steem node or in scripts set_pending_transaction_callback", "description"=>"set_pending_transaction_callback", "operationId"=>"set-pending-transaction-callback-", "x-api-path-slug"=>"set-pending-transaction-callback-get", "parameters"=>[{"in"=>"query", "name"=>"cb", "description"=>"callback function"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WARNING:", "Can", "Only", "Be", "Used", "In", "Steem", "Node", "In", "Scripts", "Set", "Pending", "Transaction", "Callback"]}}, "/set_block_applied_callback"=>{"get"=>{"summary"=>"WARNING: can only be used in Steem node or in scripts set_block_applied_callback", "description"=>"set_block_applied_callback", "operationId"=>"set-block-applied-callback-", "x-api-path-slug"=>"set-block-applied-callback-get", "parameters"=>[{"in"=>"query", "name"=>"cb", "description"=>"callback function"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WARNING:", "Can", "Only", "Be", "Used", "In", "Steem", "Node", "In", "Scripts", "Set", "Block", "Applied", "Callback"]}}, "/cancel_all_subscriptions"=>{"get"=>{"summary"=>"WARNING: can only be used in Steem node or in scripts cancel_all_subscriptions", "description"=>"cancel_all_subscriptions", "operationId"=>"cancel-all-subscriptions-", "x-api-path-slug"=>"cancel-all-subscriptions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WARNING:", "Can", "Only", "Be", "Used", "In", "Steem", "Node", "In", "Scripts", "Cancel", "", "Subscriptions"]}}, "/get_api_by_name"=>{"get"=>{"summary"=>"get_api_by_name", "description"=>"get_api_by_name", "operationId"=>"get-api-by-name", "x-api-path-slug"=>"get-api-by-name-get", "parameters"=>[{"in"=>"query", "name"=>"apiName", "description"=>"apiName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Api", "By", "Name"]}}, "/swagger"=>{"x-swagger-pipe"=>{"summary"=>"", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"swagger-xswaggerpipe", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"Steem", "x-slug"=>"steem", "description"=>"A new way for publishers to monetize their online content and community, based on battle-tested blockchain technology.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/26649-steemit.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"138048", "tags"=>"Blockchain,Content,SaaS,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"steem/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Steem", "x-api-slug"=>"steem", "description"=>"A new way for publishers to monetize their online content and community, based on battle-tested blockchain technology.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/26649-steemit.jpg", "humanURL"=>"http://steemit.com", "baseURL"=>"https://api.steemjs.com//", "tags"=>"Blockchain,Content,SaaS,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/steem/swagger-xswaggerpipe-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/steem/steem-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-openapi", "url"=>"https://steem.esteem.ws/swagger.json"}, {"type"=>"x-website", "url"=>"http://steemit.com"}, {"type"=>"x-blog", "url"=>"https://steemit.com/@ripaex"}, {"type"=>"x-developer", "url"=>"https://developers.steem.io/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/steemit"}, {"type"=>"x-website", "url"=>"https://steem.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-notification-hubs{"apis"=>{"name"=>"Azure Notification Hubs", "x-slug"=>"azure-notification-hubs", "description"=>"Azure Notification Hubs provide an easy-to-use, multi-platform, scaled-out push engine. With a single cross-platform API call, you can easily send targeted and personalized push notifications to any mobile platform from any cloud or on-premises backend.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-notification-hubs.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Microsoft,Notifications,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-notification-hubs/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Notification Hubs API", "x-api-slug"=>"azure-notification-hubs-api", "description"=>"Azure Notification Hubs provide an easy-to-use, multi-platform, scaled-out push engine. With a single cross-platform API call, you can easily send targeted and personalized push notifications to any mobile platform from any cloud or on-premises backend.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-notification-hubs.png", "humanURL"=>"https://docs.microsoft.com/en-us/azure/notification-hubs/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Microsoft,Notifications,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/azure-notification-hubs/azure-notification-hubs-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/rest/api/notificationhubs"}, {"type"=>"x-website", "url"=>"https://docs.microsoft.com/en-us/azure/notification-hubs/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "azure-notification-hubs-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Notification Hubs", "x-complete"=>1, "info"=>{"title"=>"NotificationHubsManagementClient", "description"=>"azure-notificationhub-client", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/checkNamespaceAvailability"=>{"post"=>{"summary"=>"Namespaces Check Availability", "description"=>"Checks the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name.", "operationId"=>"Namespaces_CheckAvailability", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-notificationhubschecknamespaceavailability-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The namespace name", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Availability"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}"=>{"put"=>{"summary"=>"Namespaces Create Or Update", "description"=>"Creates/Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "operationId"=>"Namespaces_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacename-put", "parameters"=>[{"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to create a Namespace Resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces"]}, "patch"=>{"summary"=>"Namespaces Patch", "description"=>"Patches the existing namespace", "operationId"=>"Namespaces_Patch", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacename-patch", "parameters"=>[{"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to patch a Namespace Resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces"]}, "delete"=>{"summary"=>"Namespaces Delete", "description"=>"Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.", "operationId"=>"Namespaces_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacename-delete", "parameters"=>[{"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces"]}, "get"=>{"summary"=>"Namespaces Get", "description"=>"Returns the description for the specified namespace.", "operationId"=>"Namespaces_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacename-get", "parameters"=>[{"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}"=>{"put"=>{"summary"=>"Namespaces Create Or Update Authorization Rule", "description"=>"Creates an authorization rule for a namespace", "operationId"=>"Namespaces_CreateOrUpdateAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenameauthorizationrulesauthorizationrulename-put", "parameters"=>[{"in"=>"path", "name"=>"authorizationRuleName", "description"=>"Aauthorization Rule Name"}, {"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The shared access authorization rule", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Authorization Rule"]}, "delete"=>{"summary"=>"Namespaces Delete Authorization Rule", "description"=>"Deletes a namespace authorization rule", "operationId"=>"Namespaces_DeleteAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenameauthorizationrulesauthorizationrulename-delete", "parameters"=>[{"in"=>"path", "name"=>"authorizationRuleName", "description"=>"Authorization Rule Name"}, {"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Authorization Rule"]}, "get"=>{"summary"=>"Namespaces Get Authorization Rule", "description"=>"Gets an authorization rule for a namespace by name.", "operationId"=>"Namespaces_GetAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenameauthorizationrulesauthorizationrulename-get", "parameters"=>[{"in"=>"path", "name"=>"authorizationRuleName", "description"=>"Authorization rule name"}, {"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Authorization Rule"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces"=>{"get"=>{"summary"=>"Namespaces List", "description"=>"Lists the available namespaces within a resourceGroup.", "operationId"=>"Namespaces_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespaces-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/namespaces"=>{"get"=>{"summary"=>"Namespaces List All", "description"=>"Lists all the available namespaces within the subscription irrespective of the resourceGroups.", "operationId"=>"Namespaces_ListAll", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-notificationhubsnamespaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces All"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules"=>{"get"=>{"summary"=>"Namespaces List Authorization Rules", "description"=>"Gets the authorization rules for a namespace.", "operationId"=>"Namespaces_ListAuthorizationRules", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenameauthorizationrules-get", "parameters"=>[{"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Authorization Rules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys"=>{"post"=>{"summary"=>"Namespaces List Keys", "description"=>"Gets the Primary and Secondary ConnectionStrings to the namespace", "operationId"=>"Namespaces_ListKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenameauthorizationrulesauthorizationrulenamelistkeys-post", "parameters"=>[{"in"=>"path", "name"=>"authorizationRuleName", "description"=>"The connection string of the namespace for the specified authorizationRule"}, {"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys"=>{"post"=>{"summary"=>"Namespaces Regenerate Keys", "description"=>"Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule", "operationId"=>"Namespaces_RegenerateKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenameauthorizationrulesauthorizationrulenameregeneratekeys-post", "parameters"=>[{"in"=>"path", "name"=>"authorizationRuleName", "description"=>"The connection string of the namespace for the specified authorizationRule"}, {"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to regenerate the Namespace Authorization Rule Key", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces Regenerate Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/checkNotificationHubAvailability"=>{"post"=>{"summary"=>"Notification Hubs Check Availability", "description"=>"Checks the availability of the given notificationHub in a namespace.", "operationId"=>"NotificationHubs_CheckAvailability", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenamechecknotificationhubavailability-post", "parameters"=>[{"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The notificationHub name", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Hubs Availability"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}"=>{"put"=>{"summary"=>"Notification Hubs Create Or Update", "description"=>"Creates/Update a NotificationHub in a namespace.", "operationId"=>"NotificationHubs_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenamenotificationhubsnotificationhubname-put", "parameters"=>[{"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"notificationHubName", "description"=>"The notification hub name"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the create/update a NotificationHub Resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Hubs"]}, "delete"=>{"summary"=>"Notification Hubs Delete", "description"=>"Deletes a notification hub associated with a namespace.", "operationId"=>"NotificationHubs_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenamenotificationhubsnotificationhubname-delete", "parameters"=>[{"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"notificationHubName", "description"=>"The notification hub name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Hubs"]}, "get"=>{"summary"=>"Notification Hubs Get", "description"=>"Lists the notification hubs associated with a namespace.", "operationId"=>"NotificationHubs_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenamenotificationhubsnotificationhubname-get", "parameters"=>[{"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"notificationHubName", "description"=>"The notification hub name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Hubs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}"=>{"put"=>{"summary"=>"Notification Hubs Create Or Update Authorization Rule", "description"=>"Creates/Updates an authorization rule for a NotificationHub", "operationId"=>"NotificationHubs_CreateOrUpdateAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenamenotificationhubsnotificationhubnameauthorizationrulesauthorizationrulename-put", "parameters"=>[{"in"=>"path", "name"=>"authorizationRuleName", "description"=>"Authorization Rule Name"}, {"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"notificationHubName", "description"=>"The notification hub name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The shared access authorization rule", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Hubs Authorization Rule"]}, "delete"=>{"summary"=>"Notification Hubs Delete Authorization Rule", "description"=>"Deletes a notificationHub authorization rule", "operationId"=>"NotificationHubs_DeleteAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenamenotificationhubsnotificationhubnameauthorizationrulesauthorizationrulename-delete", "parameters"=>[{"in"=>"path", "name"=>"authorizationRuleName", "description"=>"Authorization Rule Name"}, {"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"notificationHubName", "description"=>"The notification hub name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Hubs Authorization Rule"]}, "get"=>{"summary"=>"Notification Hubs Get Authorization Rule", "description"=>"Gets an authorization rule for a NotificationHub by name.", "operationId"=>"NotificationHubs_GetAuthorizationRule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenamenotificationhubsnotificationhubnameauthorizationrulesauthorizationrulename-get", "parameters"=>[{"in"=>"path", "name"=>"authorizationRuleName", "description"=>"authorization rule name"}, {"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"notificationHubName", "description"=>"The notification hub name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Hubs Authorization Rule"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs"=>{"get"=>{"summary"=>"Notification Hubs List", "description"=>"Lists the notification hubs associated with a namespace.", "operationId"=>"NotificationHubs_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenamenotificationhubs-get", "parameters"=>[{"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Hubs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules"=>{"get"=>{"summary"=>"Notification Hubs List Authorization Rules", "description"=>"Gets the authorization rules for a NotificationHub.", "operationId"=>"NotificationHubs_ListAuthorizationRules", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenamenotificationhubsnotificationhubnameauthorizationrules-get", "parameters"=>[{"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"notificationHubName", "description"=>"The notification hub name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Hubs Authorization Rules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}/listKeys"=>{"post"=>{"summary"=>"Notification Hubs List Keys", "description"=>"Gets the Primary and Secondary ConnectionStrings to the NotificationHub", "operationId"=>"NotificationHubs_ListKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenamenotificationhubsnotificationhubnameauthorizationrulesauthorizationrulenamelistkeys-post", "parameters"=>[{"in"=>"path", "name"=>"authorizationRuleName", "description"=>"The connection string of the NotificationHub for the specified authorizationRule"}, {"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"notificationHubName", "description"=>"The notification hub name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Hubs Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys"=>{"post"=>{"summary"=>"Notification Hubs Regenerate Keys", "description"=>"Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule", "operationId"=>"NotificationHubs_RegenerateKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenamenotificationhubsnotificationhubnameauthorizationrulesauthorizationrulenameregeneratekeys-post", "parameters"=>[{"in"=>"path", "name"=>"authorizationRuleName", "description"=>"The connection string of the NotificationHub for the specified authorizationRule"}, {"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"notificationHubName", "description"=>"The notification hub name"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to regenerate the NotificationHub Authorization Rule Key", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Hubs Regenerate Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/pnsCredentials"=>{"post"=>{"summary"=>"Notification Hubs Get Pns Credentials", "description"=>"Lists the PNS Credentials associated with a notification hub .", "operationId"=>"NotificationHubs_GetPnsCredentials", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-notificationhubsnamespacesnamespacenamenotificationhubsnotificationhubnamepnscredentials-post", "parameters"=>[{"in"=>"path", "name"=>"namespaceName", "description"=>"The namespace name"}, {"in"=>"path", "name"=>"notificationHubName", "description"=>"The notification hub name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Hubs Pns Credentials"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
neblio{"neblio-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Neblio", "x-complete"=>1, "info"=>{"title"=>"Neblio REST API Suite", "description"=>"apis-for-interacting-with-ntp1-tokens-the-neblio-blockchain", "version"=>"1.0.0"}, "host"=>"ntp1node.nebl.io", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/ntp1/tokenid/{tokensymbol}"=>{"get"=>{"summary"=>"Returns the tokenId representing a token", "description"=>"Translates a token symbol to a tokenId if a token exists with that symbol on the network", "operationId"=>"getTokenId", "x-api-path-slug"=>"ntp1tokenidtokensymbol-get", "parameters"=>[{"in"=>"path", "name"=>"tokensymbol", "description"=>"Token symbol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "TokenId", "Representing", "Token"]}}, "/ntp1/broadcast"=>{"post"=>{"summary"=>"Broadcasts a signed raw transaction to the network", "description"=>"Broadcasts a signed raw transaction to the network. If successful returns the txid of the broadcast trasnaction.", "operationId"=>"broadcastTx", "x-api-path-slug"=>"ntp1broadcast-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Object representing a transaction to broadcast", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Broadcasts", "Signed", "Raw", "Transaction", "To", "Network"]}}, "/ntp1/addressinfo/{address}"=>{"get"=>{"summary"=>"Information On a Neblio Address", "description"=>"Returns both NEBL and NTP1 token UTXOs held at the given address.", "operationId"=>"getAddressInfo", "x-api-path-slug"=>"ntp1addressinfoaddress-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Neblio Address to get information on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Information", "On", "Neblio", "Ress"]}}, "/ntp1/transactioninfo/{txid}"=>{"get"=>{"summary"=>"Information On an NTP1 Transaction", "description"=>"Returns detailed information regarding an NTP1 transaction.", "operationId"=>"getTransactionInfo", "x-api-path-slug"=>"ntp1transactioninfotxid-get", "parameters"=>[{"in"=>"path", "name"=>"txid", "description"=>"Neblio txid to get information on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Information", "On", "NTP1", "Transaction"]}}, "/ntp1/tokenmetadata/{tokenid}"=>{"get"=>{"summary"=>"Get Issuance Metadata of Token", "description"=>"Returns the metadata associated with a token at time of issuance.", "operationId"=>"getTokenMetadataOfIssuance", "x-api-path-slug"=>"ntp1tokenmetadatatokenid-get", "parameters"=>[{"in"=>"path", "name"=>"tokenid", "description"=>"TokenId to request metadata for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Issuance", "Metadata", "Of", "Token"]}}, "/ntp1/tokenmetadata/{tokenid}/{utxo}"=>{"get"=>{"summary"=>"Get UTXO Metadata of Token", "description"=>"Returns the metadata associated with a token for that specific utxo instead of the issuance transaction.", "operationId"=>"getTokenMetadataOfUtxo", "x-api-path-slug"=>"ntp1tokenmetadatatokenidutxo-get", "parameters"=>[{"in"=>"path", "name"=>"tokenid", "description"=>"TokenId to request metadata for"}, {"in"=>"path", "name"=>"utxo", "description"=>"Specific UTXO to request metadata for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "UTXO", "Metadata", "Of", "Token"]}}, "/ntp1/stakeholders/{tokenid}"=>{"get"=>{"summary"=>"Get Addresses Holding a Token", "description"=>"Returns the the the addresses holding a token and how many tokens are held", "operationId"=>"getTokenHolders", "x-api-path-slug"=>"ntp1stakeholderstokenid-get", "parameters"=>[{"in"=>"path", "name"=>"tokenid", "description"=>"TokenId to request metadata for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Resses", "Holding", "Token"]}}, "/ntp1/issue"=>{"post"=>{"summary"=>"Builds a transaction that issues a new NTP1 Token", "description"=>"Builds an unsigned raw transaction that issues a new NTP1 token on the Neblio blockchain.", "operationId"=>"issueToken", "x-api-path-slug"=>"ntp1issue-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Object representing the token to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Builds", "Transaction", "That", "Issues", "New", "NTP1", "Token"]}}, "/ntp1/sendtoken"=>{"post"=>{"summary"=>"Builds a transaction that sends an NTP1 Token", "description"=>"Builds an unsigned raw transaction that sends an NTP1 token on the Neblio blockchain.", "operationId"=>"sendToken", "x-api-path-slug"=>"ntp1sendtoken-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Object representing the token to be sent", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Builds", "Transaction", "That", "Sends", "NTP1", "Token"]}}, "/ntp1/burntoken"=>{"post"=>{"summary"=>"Builds a transaction that burns an NTP1 Token", "description"=>"Builds an unsigned raw transaction that burns an NTP1 token on the Neblio blockchain.", "operationId"=>"burnToken", "x-api-path-slug"=>"ntp1burntoken-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Object representing the token to be burned", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Builds", "Transaction", "That", "Burns", "NTP1", "Token"]}}, "/ins/tx/send"=>{"post"=>{"summary"=>"Broadcasts a signed raw transaction to the network (not NTP1 specific)", "description"=>"Broadcasts a signed raw transaction to the network. If successful returns the txid of the broadcast trasnaction.", "operationId"=>"sendTx", "x-api-path-slug"=>"instxsend-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Object representing a transaction to broadcast", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Broadcasts", "Signed", "Raw", "Transaction", "To", "Network", "(not", "NTP1", "Specific)"]}}, "/ins/block/{blockhash}"=>{"get"=>{"summary"=>"Returns information regarding a Neblio block", "description"=>"Returns blockchain data for a given block based upon the block hash", "operationId"=>"getBlock", "x-api-path-slug"=>"insblockblockhash-get", "parameters"=>[{"in"=>"path", "name"=>"blockhash", "description"=>"Block Hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Information", "Regarding", "Neblio", "Block"]}}, "/ins/block-index/{blockindex}"=>{"get"=>{"summary"=>"Returns block hash of block", "description"=>"Returns the block hash of a block at a given block index", "operationId"=>"getBlockIndex", "x-api-path-slug"=>"insblockindexblockindex-get", "parameters"=>[{"in"=>"path", "name"=>"blockindex", "description"=>"Block Index"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Block", "Hash", "Of", "Block"]}}, "/ins/tx/{txid}"=>{"get"=>{"summary"=>"Returns transaction object", "description"=>"Returns NEBL transaction object representing a NEBL transaction", "operationId"=>"getTx", "x-api-path-slug"=>"instxtxid-get", "parameters"=>[{"in"=>"path", "name"=>"txid", "description"=>"Transaction ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Transaction", "Object"]}}, "/ins/rawtx/{txid}"=>{"get"=>{"summary"=>"Returns raw transaction hex", "description"=>"Returns raw transaction hex representing a NEBL transaction", "operationId"=>"getRawTx", "x-api-path-slug"=>"insrawtxtxid-get", "parameters"=>[{"in"=>"path", "name"=>"txid", "description"=>"Transaction ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Raw", "Transaction", "Hex"]}}, "/ins/addr/{address}"=>{"get"=>{"summary"=>"Returns address object", "description"=>"Returns NEBL address object containing information on a specific address", "operationId"=>"getAddress", "x-api-path-slug"=>"insaddraddress-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Address", "Object"]}}, "/ins/addr/{address}/balance"=>{"get"=>{"summary"=>"Returns address balance in sats", "description"=>"Returns NEBL address balance in satoshis", "operationId"=>"getAddressBalance", "x-api-path-slug"=>"insaddraddressbalance-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Address", "Balance", "In", "Sats"]}}, "/ins/addr/{address}/unconfirmedBalance"=>{"get"=>{"summary"=>"Returns address unconfirmed balance in sats", "description"=>"Returns NEBL address unconfirmed balance in satoshis", "operationId"=>"getAddressUnconfirmedBalance", "x-api-path-slug"=>"insaddraddressunconfirmedbalance-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Address", "Unconfirmed", "Balance", "In", "Sats"]}}, "/ins/addr/{address}/totalReceived"=>{"get"=>{"summary"=>"Returns total received by address in sats", "description"=>"Returns total NEBL received by address in satoshis", "operationId"=>"getAddressTotalReceived", "x-api-path-slug"=>"insaddraddresstotalreceived-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Total", "Received", "By", "Address", "In", "Sats"]}}, "/ins/addr/{address}/utxo"=>{"get"=>{"summary"=>"Returns all UTXOs at a given address", "description"=>"Returns information on each Unspent Transaction Output contained at an address", "operationId"=>"getAddressUtxos", "x-api-path-slug"=>"insaddraddressutxo-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "", "UTXOs", "At", "Given", "Address"]}}, "/ins/addr/{address}/totalSent"=>{"get"=>{"summary"=>"Returns total sent by address in sats", "description"=>"Returns total NEBL sent by address in satoshis", "operationId"=>"getAddressTotalSent", "x-api-path-slug"=>"insaddraddresstotalsent-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Total", "Sent", "By", "Address", "In", "Sats"]}}, "/ins/txs"=>{"get"=>{"summary"=>"Get transactions by block or address", "description"=>"Returns all transactions by block or address", "operationId"=>"getTxs", "x-api-path-slug"=>"instxs-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Address"}, {"in"=>"query", "name"=>"block", "description"=>"Block Hash"}, {"in"=>"query", "name"=>"pageNum", "description"=>"Page number to display"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Transactions", "By", "Block", "Address"]}}, "/ins/sync"=>{"get"=>{"summary"=>"Get node sync status", "description"=>"Returns information on the node's sync progress", "operationId"=>"getSync", "x-api-path-slug"=>"inssync-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Node", "Sync", "Status"]}}, "/ins/status"=>{"get"=>{"summary"=>"Utility API for calling several blockchain node functions", "description"=>"Utility API for calling several blockchain node functions - getInfo, getDifficulty, getBestBlockHash, getLastBlockHash", "operationId"=>"getStatus", "x-api-path-slug"=>"insstatus-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"Function to call, getInfo, getDifficulty, getBestBlockHash, or getLastBlockHash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Utility", "APIcalling", "Several", "Blockchain", "Node", "Functions"]}}, "/testnet/ins/tx/send"=>{"post"=>{"summary"=>"Broadcasts a signed raw transaction to the network (not NTP1 specific)", "description"=>"Broadcasts a signed raw transaction to the network. If successful returns the txid of the broadcast trasnaction.", "operationId"=>"testnet_sendTx", "x-api-path-slug"=>"testnetinstxsend-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Object representing a transaction to broadcast", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Broadcasts", "Signed", "Raw", "Transaction", "To", "Network", "(not", "NTP1", "Specific)"]}}, "/testnet/ins/block/{blockhash}"=>{"get"=>{"summary"=>"Returns information regarding a Neblio block", "description"=>"Returns blockchain data for a given block based upon the block hash", "operationId"=>"testnet_getBlock", "x-api-path-slug"=>"testnetinsblockblockhash-get", "parameters"=>[{"in"=>"path", "name"=>"blockhash", "description"=>"Block Hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Information", "Regarding", "Neblio", "Block"]}}, "/testnet/ins/block-index/{blockindex}"=>{"get"=>{"summary"=>"Returns block hash of block", "description"=>"Returns the block hash of a block at a given block index", "operationId"=>"testnet_getBlockIndex", "x-api-path-slug"=>"testnetinsblockindexblockindex-get", "parameters"=>[{"in"=>"path", "name"=>"blockindex", "description"=>"Block Index"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Block", "Hash", "Of", "Block"]}}, "/testnet/ins/tx/{txid}"=>{"get"=>{"summary"=>"Returns transaction object", "description"=>"Returns NEBL transaction object representing a NEBL transaction", "operationId"=>"testnet_getTx", "x-api-path-slug"=>"testnetinstxtxid-get", "parameters"=>[{"in"=>"path", "name"=>"txid", "description"=>"Transaction ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Transaction", "Object"]}}, "/testnet/ins/rawtx/{txid}"=>{"get"=>{"summary"=>"Returns raw transaction hex", "description"=>"Returns raw transaction hex representing a NEBL transaction", "operationId"=>"testnet_getRawTx", "x-api-path-slug"=>"testnetinsrawtxtxid-get", "parameters"=>[{"in"=>"path", "name"=>"txid", "description"=>"Transaction ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Raw", "Transaction", "Hex"]}}, "/testnet/ins/addr/{address}"=>{"get"=>{"summary"=>"Returns address object", "description"=>"Returns NEBL address object containing information on a specific address", "operationId"=>"testnet_getAddress", "x-api-path-slug"=>"testnetinsaddraddress-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Address", "Object"]}}, "/testnet/ins/addr/{address}/balance"=>{"get"=>{"summary"=>"Returns address balance in sats", "description"=>"Returns NEBL address balance in satoshis", "operationId"=>"testnet_getAddressBalance", "x-api-path-slug"=>"testnetinsaddraddressbalance-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Address", "Balance", "In", "Sats"]}}, "/testnet/ins/addr/{address}/unconfirmedBalance"=>{"get"=>{"summary"=>"Returns address unconfirmed balance in sats", "description"=>"Returns NEBL address unconfirmed balance in satoshis", "operationId"=>"testnet_getAddressUnconfirmedBalance", "x-api-path-slug"=>"testnetinsaddraddressunconfirmedbalance-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Address", "Unconfirmed", "Balance", "In", "Sats"]}}, "/testnet/ins/addr/{address}/totalReceived"=>{"get"=>{"summary"=>"Returns total received by address in sats", "description"=>"Returns total NEBL received by address in satoshis", "operationId"=>"testnet_getAddressTotalReceived", "x-api-path-slug"=>"testnetinsaddraddresstotalreceived-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Total", "Received", "By", "Address", "In", "Sats"]}}, "/testnet/ins/addr/{address}/utxo"=>{"get"=>{"summary"=>"Returns all UTXOs at a given address", "description"=>"Returns information on each Unspent Transaction Output contained at an address", "operationId"=>"testnet_getAddressUtxos", "x-api-path-slug"=>"testnetinsaddraddressutxo-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "", "UTXOs", "At", "Given", "Address"]}}, "/testnet/ins/addr/{address}/totalSent"=>{"get"=>{"summary"=>"Returns total sent by address in sats", "description"=>"Returns total NEBL sent by address in satoshis", "operationId"=>"testnet_getAddressTotalSent", "x-api-path-slug"=>"testnetinsaddraddresstotalsent-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "Total", "Sent", "By", "Address", "In", "Sats"]}}, "/testnet/ins/txs"=>{"get"=>{"summary"=>"Get transactions by block or address", "description"=>"Returns all transactions by block or address", "operationId"=>"testnet_getTxs", "x-api-path-slug"=>"testnetinstxs-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Address"}, {"in"=>"query", "name"=>"block", "description"=>"Block Hash"}, {"in"=>"query", "name"=>"pageNum", "description"=>"Page number to display"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Transactions", "By", "Block", "Address"]}}, "/testnet/ins/sync"=>{"get"=>{"summary"=>"Get node sync status", "description"=>"Returns information on the node's sync progress", "operationId"=>"testnet_getSync", "x-api-path-slug"=>"testnetinssync-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Node", "Sync", "Status"]}}, "/testnet/ins/status"=>{"get"=>{"summary"=>"Utility API for calling several blockchain node functions", "description"=>"Utility API for calling several blockchain node functions - getInfo, getDifficulty, getBestBlockHash, getLastBlockHash", "operationId"=>"testnet_getStatus", "x-api-path-slug"=>"testnetinsstatus-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"Function to call, getInfo, getDifficulty, getBestBlockHash, or getLastBlockHash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Utility", "APIcalling", "Several", "Blockchain", "Node", "Functions"]}}, "/testnet/ntp1/tokenid/{tokensymbol}"=>{"get"=>{"summary"=>"Returns the tokenId representing a token", "description"=>"Translates a token symbol to a tokenId if a token exists with that symbol on the network", "operationId"=>"testnet_getTokenId", "x-api-path-slug"=>"testnetntp1tokenidtokensymbol-get", "parameters"=>[{"in"=>"path", "name"=>"tokensymbol", "description"=>"Token symbol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Returns", "TokenId", "Representing", "Token"]}}, "/testnet/ntp1/broadcast"=>{"post"=>{"summary"=>"Broadcasts a signed raw transaction to the network", "description"=>"Broadcasts a signed raw transaction to the network. If successful returns the txid of the broadcast trasnaction.", "operationId"=>"testnet_broadcastTx", "x-api-path-slug"=>"testnetntp1broadcast-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Object representing a transaction to broadcast", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Broadcasts", "Signed", "Raw", "Transaction", "To", "Network"]}}, "/testnet/ntp1/addressinfo/{address}"=>{"get"=>{"summary"=>"Information On a Neblio Address", "description"=>"Returns both NEBL and NTP1 token UTXOs held at the given address.", "operationId"=>"testnet_getAddressInfo", "x-api-path-slug"=>"testnetntp1addressinfoaddress-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Neblio Address to get information on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Information", "On", "Neblio", "Ress"]}}, "/testnet/ntp1/transactioninfo/{txid}"=>{"get"=>{"summary"=>"Information On an NTP1 Transaction", "description"=>"Returns detailed information regarding an NTP1 transaction.", "operationId"=>"testnet_getTransactionInfo", "x-api-path-slug"=>"testnetntp1transactioninfotxid-get", "parameters"=>[{"in"=>"path", "name"=>"txid", "description"=>"Neblio txid to get information on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Information", "On", "NTP1", "Transaction"]}}, "/testnet/ntp1/tokenmetadata/{tokenid}"=>{"get"=>{"summary"=>"Get Issuance Metadata of Token", "description"=>"Returns the metadata associated with a token at time of issuance.", "operationId"=>"testnet_getTokenMetadataOfIssuance", "x-api-path-slug"=>"testnetntp1tokenmetadatatokenid-get", "parameters"=>[{"in"=>"path", "name"=>"tokenid", "description"=>"TokenId to request metadata for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Issuance", "Metadata", "Of", "Token"]}}, "/testnet/ntp1/tokenmetadata/{tokenid}/{utxo}"=>{"get"=>{"summary"=>"Get UTXO Metadata of Token", "description"=>"Returns the metadata associated with a token for that specific utxo instead of the issuance transaction.", "operationId"=>"testnet_getTokenMetadataOfUtxo", "x-api-path-slug"=>"testnetntp1tokenmetadatatokenidutxo-get", "parameters"=>[{"in"=>"path", "name"=>"tokenid", "description"=>"TokenId to request metadata for"}, {"in"=>"path", "name"=>"utxo", "description"=>"Specific UTXO to request metadata for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "UTXO", "Metadata", "Of", "Token"]}}, "/testnet/ntp1/stakeholders/{tokenid}"=>{"get"=>{"summary"=>"Get Addresses Holding a Token", "description"=>"Returns the the the addresses holding a token and how many tokens are held", "operationId"=>"testnet_getTokenHolders", "x-api-path-slug"=>"testnetntp1stakeholderstokenid-get", "parameters"=>[{"in"=>"path", "name"=>"tokenid", "description"=>"TokenId to request metadata for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Resses", "Holding", "Token"]}}, "/testnet/ntp1/issue"=>{"post"=>{"summary"=>"Builds a transaction that issues a new NTP1 Token", "description"=>"Builds an unsigned raw transaction that issues a new NTP1 token on the Neblio blockchain.", "operationId"=>"testnet_issueToken", "x-api-path-slug"=>"testnetntp1issue-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Object representing the token to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Builds", "Transaction", "That", "Issues", "New", "NTP1", "Token"]}}, "/testnet/ntp1/sendtoken"=>{"post"=>{"summary"=>"Builds a transaction that sends an NTP1 Token", "description"=>"Builds an unsigned raw transaction that sends an NTP1 token on the Neblio blockchain.", "operationId"=>"testnet_sendToken", "x-api-path-slug"=>"testnetntp1sendtoken-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Object representing the token to be sent", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Builds", "Transaction", "That", "Sends", "NTP1", "Token"]}}, "/testnet/ntp1/burntoken"=>{"post"=>{"summary"=>"Builds a transaction that burns an NTP1 Token", "description"=>"Builds an unsigned raw transaction that burns an NTP1 token on the Neblio blockchain.", "operationId"=>"testnet_burnToken", "x-api-path-slug"=>"testnetntp1burntoken-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Object representing the token to be burned", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Builds", "Transaction", "That", "Burns", "NTP1", "Token"]}}, "/testnet/faucet"=>{"get"=>{"summary"=>"Withdraws testnet NEBL to the specified address", "description"=>"Withdraw testnet NEBL to your Neblio Testnet address. By default amount is 1500000000 or 15 NEBL and has a max of 50 NEBL. Only 2 withdrawals allowed per 24 hour period.", "operationId"=>"testnet_getFaucet", "x-api-path-slug"=>"testnetfaucet-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Your Neblio Testnet Address"}, {"in"=>"query", "name"=>"amount", "description"=>"Amount of NEBL to withdrawal in satoshis"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Withdraws", "Testnet", "NEBL", "To", "Specified", "Address"]}}}}, "apis"=>{"name"=>"Neblio", "x-slug"=>"neblio", "description"=>"Neblio was born out of the need for simple and intuitive tools and solutions to drive the adoption of blockchain technology in the enterprise space. We are working on tools, services, and APIs that will simplify and revolutionize the way that businesses deploy next-generation applications on the Neblio Blockchain Platform.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/26754-neblio.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"350300", "tags"=>"Blockchain,Enterprise,Networks,Profiles,SaaS,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"neblio/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Neblio", "x-api-slug"=>"neblio", "description"=>"Neblio was born out of the need for simple and intuitive tools and solutions to drive the adoption of blockchain technology in the enterprise space. We are working on tools, services, and APIs that will simplify and revolutionize the way that businesses deploy next-generation applications on the Neblio Blockchain Platform.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/26754-neblio.jpg", "humanURL"=>"https://nebl.io", "baseURL"=>"https://ntp1node.nebl.io//", "tags"=>"Blockchain,Enterprise,Networks,Profiles,SaaS,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/neblio/neblio-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog-rss", "url"=>"https://nebl.io/feed/"}, {"type"=>"x-documentation", "url"=>"https://nebl.io/apidocs/index.html"}, {"type"=>"x-github", "url"=>"http://github.com/NeblioTeam"}, {"type"=>"x-openapi", "url"=>"https://raw.githubusercontent.com/NeblioTeam/neblio-api-swagger-docs/master/swagger.json"}, {"type"=>"x-blog", "url"=>"https://nebl.io/blog/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/NeblioTeam"}, {"type"=>"x-website", "url"=>"https://nebl.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
spotify{"spotify-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Spotify", "x-complete"=>1, "info"=>{"title"=>"Spotify", "description"=>"our-web-api-lets-your-applications-fetch-data-from-the-spotify-music-catalog-and-manage-users-playlists-and-saved-music--based-on-simple-rest-principles-our-web-api-endpoints-return-metadata-in-json-format-about-artists-albums-and-tracks-directly-from-the-spotify-catalogue--the-api-also-provides-access-to-userrelated-data-such-as-playlists-and-music-saved-in-a-your-music-library-subject-to-users-authorization-", "version"=>"v1"}, "host"=>"api.spotify.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/albums"=>{"get"=>{"summary"=>"Get Albums", "description"=>"[Get Several Albums](https://developer.spotify.com/web-api/get-several-albums/)", "operationId"=>"get-several-albumshttpsdeveloperspotifycomwebapigetseveralalbums", "x-api-path-slug"=>"albums-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"A comma-separated list of IDs"}, {"in"=>"query", "name"=>"market", "description"=>"The market (an ISO 3166-1 alpha-2 country code)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Albums"]}}, "/albums/{id}"=>{"get"=>{"summary"=>"Get Album", "description"=>"[Get an Album](https://developer.spotify.com/web-api/get-album/)", "operationId"=>"get-an-albumhttpsdeveloperspotifycomwebapigetalbum", "x-api-path-slug"=>"albumsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The Spotify ID for the album"}, {"in"=>"query", "name"=>"market", "description"=>"The market (an ISO 3166-1 alpha-2 country code)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Albums"]}}, "/albums/{id}/tracks"=>{"get"=>{"summary"=>"Get Album Tracks", "description"=>"[Get an Album's Tracks](https://developer.spotify.com/web-api/get-albums-tracks/)", "operationId"=>"get-an-albums-trackshttpsdeveloperspotifycomwebapigetalbumstracks", "x-api-path-slug"=>"albumsidtracks-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The Spotify ID for the album"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"market", "description"=>"The market (an ISO 3166-1 alpha-2 country code)"}, {"in"=>"query", "name"=>"offset", "description"=>"The index of the first item to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Album", "Tracks"]}}, "/artists"=>{"get"=>{"summary"=>"Get Artists", "description"=>"[Get Several Artists](https://developer.spotify.com/web-api/get-several-artists/)", "operationId"=>"get-several-artistshttpsdeveloperspotifycomwebapigetseveralartists", "x-api-path-slug"=>"artists-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"A comma-separated list of IDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Artists"]}}, "/artists/{id}"=>{"get"=>{"summary"=>"Get Artist", "description"=>"[Get an Artist](https://developer.spotify.com/web-api/get-artist/)", "operationId"=>"get-an-artisthttpsdeveloperspotifycomwebapigetartist", "x-api-path-slug"=>"artistsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The Spotify ID for the artist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Artists"]}}, "/artists/{id}/albums"=>{"get"=>{"summary"=>"Get Artist Albums", "description"=>"[Get an Artist's Albums](https://developer.spotify.com/web-api/get-artists-albums/)", "operationId"=>"get-an-artists-albumshttpsdeveloperspotifycomwebapigetartistsalbums", "x-api-path-slug"=>"artistsidalbums-get", "parameters"=>[{"in"=>"query", "name"=>"album_type", "description"=>"Filter by album types"}, {"in"=>"path", "name"=>"id", "description"=>"The Spotify ID for the artist"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"market", "description"=>"The market (an ISO 3166-1 alpha-2 country code)"}, {"in"=>"query", "name"=>"offset", "description"=>"The index of the first item to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Artists", "Albums"]}}, "/artists/{id}/related-artists"=>{"get"=>{"summary"=>"Get Artist Related ARtists", "description"=>"[Get an Artist's Related Artists](https://developer.spotify.com/web-api/get-related-artists/)", "operationId"=>"get-an-artists-related-artistshttpsdeveloperspotifycomwebapigetrelatedartists", "x-api-path-slug"=>"artistsidrelatedartists-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The Spotify ID for the artist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Artists"]}}, "/artists/{id}/top-tracks"=>{"get"=>{"summary"=>"Get Artist Top Tracks", "description"=>"[Get an Artist's Top Tracks](https://developer.spotify.com/web-api/get-artists-top-tracks/)", "operationId"=>"get-an-artists-top-trackshttpsdeveloperspotifycomwebapigetartiststoptracks", "x-api-path-slug"=>"artistsidtoptracks-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"The country (an ISO 3166-1 alpha-2 country code)"}, {"in"=>"path", "name"=>"id", "description"=>"The Spotify ID for the artist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Artists", "Tracks"]}}, "/browse/categories"=>{"get"=>{"summary"=>"Browse Categories", "description"=>"[Get a List of Browse Categories](https://developer.spotify.com/web-api/get-list-categories/)", "operationId"=>"get-a-list-of-browse-categorieshttpsdeveloperspotifycomwebapigetlistcategories", "x-api-path-slug"=>"browsecategories-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"It is used to set specified media type"}, {"in"=>"query", "name"=>"country", "description"=>"The country (an ISO 3166-1 alpha-2 country code)"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"locale", "description"=>"The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore"}, {"in"=>"query", "name"=>"offset", "description"=>"The index of the first item to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Categories"]}}, "/browse/categories/{category_id}"=>{"get"=>{"summary"=>"Browse Category", "description"=>"[Get a Single Browse Category](https://developer.spotify.com/web-api/get-category/)", "operationId"=>"get-a-single-browse-categoryhttpsdeveloperspotifycomwebapigetcategory", "x-api-path-slug"=>"browsecategoriescategory-id-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"It is used to set specified media type"}, {"in"=>"path", "name"=>"category_id", "description"=>"The Spotify ID of the category you wish to fetch"}, {"in"=>"query", "name"=>"country", "description"=>"The country (an ISO 3166-1 alpha-2 country code)"}, {"in"=>"query", "name"=>"locale", "description"=>"The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Categories", "Playlists"]}}, "/browse/categories/{category_id}/playlists"=>{"get"=>{"summary"=>"Browse Category Playlists", "description"=>"[Get a Category's playlists](https://developer.spotify.com/web-api/get-categorys-playlists/)", "operationId"=>"get-a-categorys-playlistshttpsdeveloperspotifycomwebapigetcategorysplaylists", "x-api-path-slug"=>"browsecategoriescategory-idplaylists-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"It is used to set specified media type"}, {"in"=>"path", "name"=>"category_id", "description"=>"The Spotify ID of the category you wish to fetch"}, {"in"=>"query", "name"=>"country", "description"=>"The country (an ISO 3166-1 alpha-2 country code)"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"offset", "description"=>"The index of the first item to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Playlists"]}}, "/browse/featured-playlists"=>{"get"=>{"summary"=>"Browse Featured Playlists", "description"=>"[Get a List of Featured Playlists](https://developer.spotify.com/web-api/get-list-featured-playlists/)", "operationId"=>"get-a-list-of-featured-playlistshttpsdeveloperspotifycomwebapigetlistfeaturedplaylists", "x-api-path-slug"=>"browsefeaturedplaylists-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"It is used to set specified media type"}, {"in"=>"query", "name"=>"country", "description"=>"The country (an ISO 3166-1 alpha-2 country code)"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"locale", "description"=>"The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore"}, {"in"=>"query", "name"=>"offset", "description"=>"The index of the first item to return"}, {"in"=>"query", "name"=>"timestamp", "description"=>"A timestamp in ISO 8601 format (yyyy-MM-ddTHH:mm:ss) with the users local time to get results tailored to a specific date and time in the day"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Playlists"]}}, "/browse/new-releases"=>{"get"=>{"summary"=>"Browse New Releases", "description"=>"[Get a List of New Releases](https://developer.spotify.com/web-api/get-list-new-releases/)", "operationId"=>"get-a-list-of-new-releaseshttpsdeveloperspotifycomwebapigetlistnewreleases", "x-api-path-slug"=>"browsenewreleases-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"It is used to set specified media type"}, {"in"=>"query", "name"=>"country", "description"=>"The country (an ISO 3166-1 alpha-2 country code)"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"offset", "description"=>"The index of the first item to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "New Releases"]}}, "/me"=>{"get"=>{"summary"=>"Get Me", "description"=>"[Get Current User's Profile](https://developer.spotify.com/web-api/get-current-users-profile/)", "operationId"=>"get-current-users-profilehttpsdeveloperspotifycomwebapigetcurrentusersprofile", "x-api-path-slug"=>"me-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Me"]}}, "/me/following"=>{"delete"=>{"summary"=>"Delete Following", "description"=>"[Unfollow Artists or Users](https://developer.spotify.com/web-api/unfollow-artists-users/)", "operationId"=>"unfollow-artists-or-usershttpsdeveloperspotifycomwebapiunfollowartistsusers", "x-api-path-slug"=>"mefollowing-delete", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"A comma-separated list of the artists or users ids"}, {"in"=>"query", "name"=>"type", "description"=>"The type to unfollow"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Me", "Following"]}, "get"=>{"summary"=>"Get Following", "description"=>"[Get User's Followed Artists](https://developer.spotify.com/web-api/get-followed-artists/)", "operationId"=>"get-users-followed-artistshttpsdeveloperspotifycomwebapigetfollowedartists", "x-api-path-slug"=>"mefollowing-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"The last artist ID retrieved from the previous request"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"type", "description"=>"The ID type, currently only artist is supported"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Me", "Following"]}, "put"=>{"summary"=>"Update Following", "description"=>"[Follow Artists or Users](https://developer.spotify.com/web-api/follow-artists-users/)", "operationId"=>"follow-artists-or-usershttpsdeveloperspotifycomwebapifollowartistsusers", "x-api-path-slug"=>"mefollowing-put", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"A comma-separated list of the artists or users ids"}, {"in"=>"query", "name"=>"type", "description"=>"The type to follow"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Me", "Following"]}}, "/me/following/contains"=>{"get"=>{"summary"=>"Get Following contains", "description"=>"[Check if Current User Follows Artists or Users](https://developer.spotify.com/web-api/check-current-user-follows/)", "operationId"=>"check-if-current-user-follows-artists-or-usershttpsdeveloperspotifycomwebapicheckcurrentuserfollows", "x-api-path-slug"=>"mefollowingcontains-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"A comma-separated string of the artists or users ids"}, {"in"=>"query", "name"=>"type", "description"=>"The type to follow"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Me", "Following"]}}, "/me/tracks"=>{"delete"=>{"summary"=>"Delete My Tracks", "description"=>"[Remove Tracks for Current User](https://developer.spotify.com/web-api/remove-tracks-user/)", "operationId"=>"remove-tracks-for-current-userhttpsdeveloperspotifycomwebapiremovetracksuser", "x-api-path-slug"=>"metracks-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"It is used to set specified media type"}, {"in"=>"query", "name"=>"ids", "description"=>"A comma-separated list of IDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Me", "Tracks"]}, "get"=>{"summary"=>"Get My Tracks", "description"=>"[Get Current User's Saved Tracks](https://developer.spotify.com/web-api/get-users-saved-tracks/)", "operationId"=>"get-current-users-saved-trackshttpsdeveloperspotifycomwebapigetuserssavedtracks", "x-api-path-slug"=>"metracks-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"It is used to set specified media type"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"market", "description"=>"The market (an ISO 3166-1 alpha-2 country code)"}, {"in"=>"query", "name"=>"offset", "description"=>"The index of the first item to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Me", "Tracks"]}, "put"=>{"summary"=>"Update My Tracks", "description"=>"[Save Tracks for Current User](https://developer.spotify.com/web-api/save-tracks-user/)", "operationId"=>"save-tracks-for-current-userhttpsdeveloperspotifycomwebapisavetracksuser", "x-api-path-slug"=>"metracks-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"It is used to set specified media type"}, {"in"=>"query", "name"=>"ids", "description"=>"A comma-separated list of IDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Me", "Tracks"]}}, "/me/tracks/contains"=>{"get"=>{"summary"=>"Get My Track Contains", "description"=>"[Check Current User's Saved Tracks](https://developer.spotify.com/web-api/check-users-saved-tracks/)", "operationId"=>"check-current-users-saved-trackshttpsdeveloperspotifycomwebapicheckuserssavedtracks", "x-api-path-slug"=>"metrackscontains-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"A comma-separated list of IDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Me", "Tracks"]}}, "/search"=>{"get"=>{"summary"=>"Search", "description"=>"[Search for an Item](https://developer.spotify.com/web-api/search-item/)", "operationId"=>"search-for-an-itemhttpsdeveloperspotifycomwebapisearchitem", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"market", "description"=>"The market (an ISO 3166-1 alpha-2 country code)"}, {"in"=>"query", "name"=>"offset", "description"=>"The index of the first item to return"}, {"in"=>"query", "name"=>"q", "description"=>"The search querys keywords (and optional field filters)"}, {"in"=>"query", "name"=>"type", "description"=>"A comma-separated list of item types to search across"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Search"]}}, "/tracks"=>{"get"=>{"summary"=>"Get Tracks", "description"=>"[Get Several Tracks](https://developer.spotify.com/web-api/get-several-tracks/)", "operationId"=>"get-several-trackshttpsdeveloperspotifycomwebapigetseveraltracks", "x-api-path-slug"=>"tracks-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"A comma-separated list of IDs"}, {"in"=>"query", "name"=>"market", "description"=>"The market (an ISO 3166-1 alpha-2 country code)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Tracks"]}}, "/tracks/{id}"=>{"get"=>{"summary"=>"Get Track", "description"=>"[Get a Track](https://developer.spotify.com/web-api/get-track/)", "operationId"=>"get-a-trackhttpsdeveloperspotifycomwebapigettrack", "x-api-path-slug"=>"tracksid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"market", "description"=>"The market (an ISO 3166-1 alpha-2 country code)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "Tracks"]}}, "/users/{user_id}"=>{"get"=>{"summary"=>"Get User", "description"=>"[Get a User's Profile](https://developer.spotify.com/web-api/get-users-profile/)", "operationId"=>"get-a-users-profilehttpsdeveloperspotifycomwebapigetusersprofile", "x-api-path-slug"=>"usersuser-id-get", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"The users Spotify user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "User"]}}, "/users/{user_id}/playlists"=>{"get"=>{"summary"=>"Get User Playlists", "description"=>"[Get a List of a User's Playlists](https://developer.spotify.com/web-api/get-list-users-playlists/)", "operationId"=>"get-a-list-of-a-users-playlistshttpsdeveloperspotifycomwebapigetlistusersplaylists", "x-api-path-slug"=>"usersuser-idplaylists-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"It is used to set specified media type"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"offset", "description"=>"The index of the first item to return"}, {"in"=>"path", "name"=>"user_id", "description"=>"The users Spotify user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "User", "Playlists"]}, "post"=>{"summary"=>"Add User Playlists", "description"=>"[Create a Playlist](https://developer.spotify.com/web-api/create-playlist/)", "operationId"=>"create-a-playlisthttpsdeveloperspotifycomwebapicreateplaylist", "x-api-path-slug"=>"usersuser-idplaylists-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"It is used to set specified media type"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"The users Spotify user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "User", "Playlists"]}}, "/users/{user_id}/playlists/{playlist_id}"=>{"get"=>{"summary"=>"Get User Playlist", "description"=>"[Get a Playlist](https://developer.spotify.com/web-api/get-playlist/)", "operationId"=>"get-a-playlisthttpsdeveloperspotifycomwebapigetplaylist", "x-api-path-slug"=>"usersuser-idplaylistsplaylist-id-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"It is used to set specified media type"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma-separated list of fields to filter query"}, {"in"=>"query", "name"=>"market", "description"=>"The market (an ISO 3166-1 alpha-2 country code)"}, {"in"=>"path", "name"=>"playlist_id", "description"=>"The Spotify playlist ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The users Spotify user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "User", "Playlists"]}, "put"=>{"summary"=>"Update User Playlist", "description"=>"[Change a Playlist's Details](https://developer.spotify.com/web-api/change-playlist-details/)", "operationId"=>"change-a-playlists-detailshttpsdeveloperspotifycomwebapichangeplaylistdetails", "x-api-path-slug"=>"usersuser-idplaylistsplaylist-id-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"It is used to set specified media type"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"playlist_id", "description"=>"The Spotify playlist ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The users Spotify user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "User", "Playlists"]}}, "/users/{user_id}/playlists/{playlist_id}/followers"=>{"delete"=>{"summary"=>"Delete User Playlist Followers", "description"=>"[Unfollow a Playlist](https://developer.spotify.com/web-api/unfollow-playlist/)", "operationId"=>"unfollow-a-playlisthttpsdeveloperspotifycomwebapiunfollowplaylist", "x-api-path-slug"=>"usersuser-idplaylistsplaylist-idfollowers-delete", "parameters"=>[{"in"=>"path", "name"=>"playlist_id", "description"=>"The Spotify playlist ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The users Spotify user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "User", "Playlists", "Followers"]}, "put"=>{"summary"=>"Update User Playlist Followers", "description"=>"[Follow a Playlist](https://developer.spotify.com/web-api/follow-playlist/)", "operationId"=>"follow-a-playlisthttpsdeveloperspotifycomwebapifollowplaylist", "x-api-path-slug"=>"usersuser-idplaylistsplaylist-idfollowers-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"playlist_id", "description"=>"The Spotify playlist ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The users Spotify user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "User", "Playlists", "Followers"]}}, "/users/{user_id}/playlists/{playlist_id}/followers/contains"=>{"get"=>{"summary"=>"Get User Playlist Followers Contains", "description"=>"[Check if Users Follow a Playlist](https://developer.spotify.com/web-api/check-user-following-playlist/)", "operationId"=>"check-if-users-follow-a-playlisthttpsdeveloperspotifycomwebapicheckuserfollowingplaylist", "x-api-path-slug"=>"usersuser-idplaylistsplaylist-idfollowerscontains-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"A comma-separated list of users ids"}, {"in"=>"path", "name"=>"playlist_id", "description"=>"The Spotify playlist ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The users Spotify user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "User", "Playlists", "Followers"]}}, "/users/{user_id}/playlists/{playlist_id}/tracks"=>{"delete"=>{"summary"=>"Delete User Playlist Tracks", "description"=>"[Remove Tracks from a Playlist](https://developer.spotify.com/web-api/remove-tracks-playlist/)", "operationId"=>"remove-tracks-from-a-playlisthttpsdeveloperspotifycomwebapiremovetracksplaylist", "x-api-path-slug"=>"usersuser-idplaylistsplaylist-idtracks-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"It is used to set specified media type"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"playlist_id", "description"=>"The Spotify playlist ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The users Spotify user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "User", "Playlists", "Tracks"]}, "get"=>{"summary"=>"Get User Playlist Tracks", "description"=>"[Get a Playlist's Tracks](https://developer.spotify.com/web-api/get-playlists-tracks/)", "operationId"=>"get-a-playlists-trackshttpsdeveloperspotifycomwebapigetplayliststracks", "x-api-path-slug"=>"usersuser-idplaylistsplaylist-idtracks-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"It is used to set specified media type"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma-separated list of fields to filter query"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"market", "description"=>"The market (an ISO 3166-1 alpha-2 country code)"}, {"in"=>"query", "name"=>"offset", "description"=>"The index of the first item to return"}, {"in"=>"path", "name"=>"playlist_id", "description"=>"The Spotify playlist ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The users Spotify user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "User", "Playlists", "Tracks"]}, "post"=>{"summary"=>"Add User Playlist Track", "description"=>"[Add Tracks to a Playlist](https://developer.spotify.com/web-api/add-tracks-to-playlist/)", "operationId"=>"add-tracks-to-a-playlisthttpsdeveloperspotifycomwebapiaddtrackstoplaylist", "x-api-path-slug"=>"usersuser-idplaylistsplaylist-idtracks-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"It is used to set specified media type"}, {"in"=>"path", "name"=>"playlist_id", "description"=>"The Spotify playlist ID"}, {"in"=>"query", "name"=>"position", "description"=>"The position to insert the tracks, a zero-based index"}, {"in"=>"query", "name"=>"uris", "description"=>"A comma-separated list of Spotify track URIs to add"}, {"in"=>"path", "name"=>"user_id", "description"=>"The users Spotify user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "User", "Playlists", "Tracks"]}, "put"=>{"summary"=>"Update User Playlist Track", "description"=>"[Reorder or replace a Playlist's Tracks](https://developer.spotify.com/web-api/reorder-playlists-tracks/)", "operationId"=>"reorder-or-replace-a-playlists-trackshttpsdeveloperspotifycomwebapireorderplayliststracks", "x-api-path-slug"=>"usersuser-idplaylistsplaylist-idtracks-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"It is used to set specified media type"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"playlist_id", "description"=>"The Spotify playlist ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"The users Spotify user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Music", "User", "Playlists", "Tracks"]}}}}, "apis"=>{"name"=>"Spotify", "x-slug"=>"spotify", "description"=>"Spotify is a digital music service that gives you access to millions of songs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1165-spotify.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"132", "tags"=>"Change Log Example,General Data,Indie EdTech Data Jam,internet,Issues Example,Mobile,Music,Pedestal,Relative Data,Relative StreamRank,Service API,Stack,Stack Network,Streaming,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"spotify/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Spotify", "x-api-slug"=>"spotify", "description"=>"Spotify is a digital music service that gives you access to millions of songs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1165-spotify.jpg", "humanURL"=>"http://www.spotify.com", "baseURL"=>"https://api.spotify.com//v1", "tags"=>"Change Log Example,General Data,Indie EdTech Data Jam,internet,Issues Example,Mobile,Music,Pedestal,Relative Data,Relative StreamRank,Service API,Stack,Stack Network,Streaming,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/spotify/spotify-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-api-json--authoritative", "url"=>"https://developer.spotify.com/wp-content/uploads/apis.json"}, {"type"=>"x-android-sdk", "url"=>"https://developer.spotify.com/technologies/spotify-android-sdk/"}, {"type"=>"x-application-gallery", "url"=>"https://developer.spotify.com/my-applications/"}, {"type"=>"x-application-gallery", "url"=>"https://developer.spotify.com/showcase/"}, {"type"=>"x-base-url", "url"=>"https://api.spotify.com"}, {"type"=>"x-blog", "url"=>"http://www.spotify.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"http://www.spotify.com/blog/feed"}, {"type"=>"x-change-log", "url"=>"https://developer.spotify.com/web-api/change-log/"}, {"type"=>"x-console", "url"=>"https://developer.spotify.com/web-api/console/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/spotify"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/spotify"}, {"type"=>"x-developer", "url"=>"https://developer.spotify.com/"}, {"type"=>"x-email", "url"=>"office@spotify.com"}, {"type"=>"x-ios-sdk", "url"=>"https://developer.spotify.com/technologies/spotify-ios-sdk/"}, {"type"=>"x-issues", "url"=>"https://github.com/spotify/web-api/issues"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/spotify/"}, {"type"=>"x-stack-overflow", "url"=>"http://stackoverflow.com/questions/tagged/spotify"}, {"type"=>"x-terms-of-service", "url"=>"https://developer.spotify.com/developer-terms-of-use/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/SpotifyPlatform"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/spotify"}, {"type"=>"x-github", "url"=>"https://github.com/spotify"}, {"type"=>"x-website", "url"=>"http://www.spotify.com"}, {"type"=>"x-website", "url"=>"http://spotify.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
donorschoose{"donors-choose-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DonorsChoose", "x-complete"=>1, "info"=>{"title"=>"Donors Choose", "description"=>"our-api-serves-up-project-titles-descriptions-classroom-photos-geotags-full-teacherwritten-essays-and-more--", "termsOfService"=>"http://www.donorschoose.org/help/user_agreement.html", "version"=>"1"}, "host"=>"api.donorschoose.org", "basePath"=>"common/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/json_api.html"=>{"post"=>{"summary"=>"Generate Gift Code", "description"=>"Generate Gift Code", "operationId"=>"generate-gift-code", "x-api-path-slug"=>"json-api-html-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generate", "Gift", "Code"]}}, "/json_challenge.html"=>{"get"=>{"summary"=>"Get Giving Page", "description"=>"Get Giving Page", "operationId"=>"get-giving-page", "x-api-path-slug"=>"json-challenge-html-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Giving", "Page"]}}, "/json_feed.html"=>{"get"=>{"summary"=>"Search", "description"=>"Search", "operationId"=>"search", "x-api-path-slug"=>"json-feed-html-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}}}, "apis"=>{"name"=>"DonorsChoose", "x-slug"=>"donorschoose", "description"=>"DonorsChoose.org connects teachers in high-need communities with donors who want to help.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/394-donorschoose.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"23784", "tags"=>"API LIfeyclessss,API Provider,Charities,Classroom,Donate,Donation,Education,Education,General Data,internet,K 12,Marketplace,Nonprofit,Profiles,Teachers,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"donorschoose/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Donors Choose", "x-api-slug"=>"donors-choose", "description"=>"DonorsChoose.org connects teachers in high-need communities with donors who want to help.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/394-donorschoose.jpg", "humanURL"=>"http://donorschoose.org", "baseURL"=>"https://api.donorschoose.org/common/", "tags"=>"API LIfeyclessss,API Provider,Charities,Classroom,Donate,Donation,Education,Education,General Data,internet,K 12,Marketplace,Nonprofit,Profiles,Teachers,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/donorschoose/json-feed-html-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/donorschoose/donors-choose-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api.donorschoose.org"}, {"type"=>"x-blog", "url"=>"http://data.donorschoose.org/"}, {"type"=>"x-blog-rss", "url"=>"http://feeds.feedburner.com/HackingEducationData"}, {"type"=>"x-contact-form", "url"=>"http://www.donorschoose.org/common/contact_landing.html"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/donorschoose-org"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/donorschoose-org"}, {"type"=>"x-developer", "url"=>"http://data.donorschoose.org/docs/overview"}, {"type"=>"x-github", "url"=>"https://github.com/DonorsChoose"}, {"type"=>"x-privacy", "url"=>"http://www.donorschoose.org/help/privacy_policy.html"}, {"type"=>"x-terms-of-service", "url"=>"http://www.donorschoose.org/help/user_agreement.html"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/DonorsChoose"}, {"type"=>"x-website", "url"=>"http://donorschoose.org"}, {"type"=>"x-website", "url"=>"http://www.donorschoose.org/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
infermedica{"infermedica-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Infermedica", "x-complete"=>1, "info"=>{"title"=>"Infermedica", "description"=>"empower-your-healthcare-services-with-intelligent-diagnostic-insights-of-infermedica-api-", "version"=>"v2"}, "host"=>"api.infermedica.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/conditions"=>{"get"=>{"summary"=>"Get Conditions", "description"=>"Returns a list of all available conditions.", "operationId"=>"getConditions", "x-api-path-slug"=>"conditions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Healthcare", "Conditions"]}}, "/conditions/{id}"=>{"get"=>{"summary"=>"Get Conditions", "description"=>"Returns details of a single condition specified by id parameter.", "operationId"=>"getConditions", "x-api-path-slug"=>"conditionsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"condition id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Healthcare", "Conditions", "Id"]}}, "/diagnosis"=>{"post"=>{"summary"=>"Post Diagnosis", "description"=>"Suggests possible diagnoses and relevant observations based on provided patient information.", "operationId"=>"postDiagnosis", "x-api-path-slug"=>"diagnosis-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Healthcare", "Diagnosis"]}}, "/explain"=>{"post"=>{"summary"=>"Post Explain", "description"=>"Explains which evidence impact probability of selected condition.", "operationId"=>"postExplain", "x-api-path-slug"=>"explain-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Healthcare", "Explain"]}}, "/info"=>{"get"=>{"summary"=>"Get Info", "description"=>"Returns information about data used by diagnostic engine.", "operationId"=>"getInfo", "x-api-path-slug"=>"info-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Healthcare", "Info"]}}, "/lab_tests"=>{"get"=>{"summary"=>"Get Lab Tests", "description"=>"Returns a list of all available lab tests.", "operationId"=>"getLabTests", "x-api-path-slug"=>"lab-tests-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Healthcare", "Lab", "Tests"]}}, "/lab_tests/{id}"=>{"get"=>{"summary"=>"Get Lab Tests", "description"=>"Returns details of a single lab test specified by id parameter.", "operationId"=>"getLabTests", "x-api-path-slug"=>"lab-testsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"lab test id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Healthcare", "Lab", "Tests"]}}, "/lookup"=>{"get"=>{"summary"=>"Get Lookup", "description"=>"Returns a single observation matching given phrase.", "operationId"=>"getLookup", "x-api-path-slug"=>"lookup-get", "parameters"=>[{"in"=>"query", "name"=>"phrase", "description"=>"phrase to match"}, {"in"=>"query", "name"=>"sex", "description"=>"sex filter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Healthcare", "Lookup"]}}, "/parse"=>{"post"=>{"summary"=>"Post Parse", "description"=>"Returns list of mentions of observation found in given text.", "operationId"=>"postParse", "x-api-path-slug"=>"parse-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Healthcare", "Parse"]}}, "/risk_factors"=>{"get"=>{"summary"=>"Get Risk Factors", "description"=>"Returns a list of all available risk factors.", "operationId"=>"getRiskFactors", "x-api-path-slug"=>"risk-factors-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Healthcare", "Risk", "Factors"]}}, "/risk_factors/{id}"=>{"get"=>{"summary"=>"Get Risk Factors", "description"=>"Returns details of a single risk factor specified by id parameter.", "operationId"=>"getRiskFactors", "x-api-path-slug"=>"risk-factorsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"risk factor id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Healthcare", "Risk", "Factors"]}}, "/search"=>{"get"=>{"summary"=>"Get Search", "description"=>"Returns list of observations matching the given phrase.", "operationId"=>"getSearch", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"max_results", "description"=>"maximum number of results"}, {"in"=>"query", "name"=>"phrase", "description"=>"phrase to match"}, {"in"=>"query", "name"=>"sex", "description"=>"sex filter"}, {"in"=>"query", "name"=>"type", "description"=>"type of results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Healthcare", "Search"]}}, "/suggest"=>{"post"=>{"summary"=>"Post Suggest", "description"=>"Suggests possible symptoms based on provided patient information.", "operationId"=>"postSuggest", "x-api-path-slug"=>"suggest-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"max_results", "description"=>"maximum number of results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Healthcare", "Suggest"]}}, "/symptoms"=>{"get"=>{"summary"=>"Get Symptoms", "description"=>"Returns a list of all available symptoms.", "operationId"=>"getSymptoms", "x-api-path-slug"=>"symptoms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Healthcare", "Symptoms"]}}, "/symptoms/{id}"=>{"get"=>{"summary"=>"Get Symptoms", "description"=>"Returns details of a single symptom specified by id parameter.", "operationId"=>"getSymptoms", "x-api-path-slug"=>"symptomsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"symptoms id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Healthcare", "Symptoms"]}}, "/triage"=>{"post"=>{"summary"=>"Post Triage", "description"=>"Estimates triage level based on provided patient information.", "operationId"=>"postTriage", "x-api-path-slug"=>"triage-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Healthcare", "Triage"]}}, "/observations"=>{"get"=>{"summary"=>"List all observations", "description"=>"Returns a list of all available observations.", "operationId"=>"getAllObservations", "x-api-path-slug"=>"observations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Observations"]}}, "/observations/{id}"=>{"get"=>{"summary"=>"Get observation by id", "description"=>"Returns details of a single observation specified by id parameter.", "operationId"=>"getObservation", "x-api-path-slug"=>"observationsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"observation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Observations"]}}}}, "apis"=>{"name"=>"Infermedica", "x-slug"=>"infermedica", "description"=>"At Infermedica we believe in people. Every team member brings unique skills, talent and knowledge. Together we solve the most complex healthcare problems. Infermedica improves the diagnostic process using the most advanced reasoning technology for preliminary medical diagnosis.White-labelled enterprise platform (web, mobile, chatbot or voice-enabled applications) for symptom checking, patient triage and clinical decision support. Open developer portal that allows to easily integrate our diagnostic engine into 3rd party software.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/infermedica-logo.jpeg", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,Artificial Intelligence,Healthcare,Profiles,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"infermedica/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Infermedica", "x-api-slug"=>"infermedica", "description"=>"At Infermedica we believe in people. Every team member brings unique skills, talent and knowledge. Together we solve the most complex healthcare problems. Infermedica improves the diagnostic process using the most advanced reasoning technology for preliminary medical diagnosis.White-labelled enterprise platform (web, mobile, chatbot or voice-enabled applications) for symptom checking, patient triage and clinical decision support. Open developer portal that allows to easily integrate our diagnostic engine into 3rd party software.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/infermedica-logo.jpeg", "humanURL"=>"http://infermedica.com", "baseURL"=>"https://api.infermedica.com//v1", "tags"=>"API Provider,Artificial Intelligence,Healthcare,Profiles,Relative Data,Service API", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/infermedica/infermedica-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://blog.infermedica.com/"}, {"type"=>"x-blog-rss", "url"=>"https://blog.infermedica.com/rss/"}, {"type"=>"x-curated-source", "url"=>"https://developer.infermedica.com/"}, {"type"=>"x-developer", "url"=>"http://developer.infermedica.com"}, {"type"=>"x-github", "url"=>"https://github.com/infermedica"}, {"type"=>"x-status", "url"=>"http://status.infermedica.com/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/infermedica"}, {"type"=>"x-website", "url"=>"http://infermedica.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
coutts{"coutts-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Coutts", "x-complete"=>1, "info"=>{"title"=>"Coutts", "description"=>"this-is-an-openapi-definition-for-the-standard-set-of-open-banking-httpopenbankingapis-io-apis-froms-coutts-", "termsOfService"=>"https://www.openbanking.org.uk/open-licence/", "contact"=>{"name"=>"API Evangelist", "url"=>"https://apievangelist.com", "email"=>"info@apievangelist.com"}, "version"=>"1.0.0"}, "host"=>"openapi.coutts.com", "basePath"=>"open-banking/v2.1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"business-current-accounts/"=>{"get"=>{"summary"=>"Get Current Business Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple BCA products.", "operationId"=>"getCurentBusinessAccounts", "x-api-path-slug"=>"businesscurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts"]}}}}, "apis"=>{"name"=>"Coutts", "x-slug"=>"coutts", "description"=>"Coutts /??ku?ts/ is a private bank and wealth manager, founded in 1692. It is the seventh oldest bank in the world and its international arm was sold to Union Bancaire Privée in March 2015. It has been owned by the Royal Bank of Scotland Group (RBS) since 2000, when RBS purchased its parent, NatWest. Coutts formed part of RBSs private banking division. During its time with RBS, it acquired Zürich-based Bank von Ernst & Cie and in 2008, Coutts Bank von Ernst and other Coutts International subsidiaries became RBS Coutts Bank. These traded as RBS Coutts International to align them with the parent RBS Group until 2011, when RBS Coutts was renamed Coutts & Co. Limited.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Coutts-logo.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Provider,ATMs,Banking,General Data,Profiles,Relative Data,UK Banks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"coutts/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Coutts", "x-api-slug"=>"coutts", "description"=>"Coutts /??ku?ts/ is a private bank and wealth manager, founded in 1692. It is the seventh oldest bank in the world and its international arm was sold to Union Bancaire Privée in March 2015. It has been owned by the Royal Bank of Scotland Group (RBS) since 2000, when RBS purchased its parent, NatWest. Coutts formed part of RBSs private banking division. During its time with RBS, it acquired Zürich-based Bank von Ernst & Cie and in 2008, Coutts Bank von Ernst and other Coutts International subsidiaries became RBS Coutts Bank. These traded as RBS Coutts International to align them with the parent RBS Group until 2011, when RBS Coutts was renamed Coutts & Co. Limited.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Coutts-logo.jpg", "humanURL"=>"https://www.coutts.com/", "baseURL"=>"https://openapi.coutts.com/open-banking/v2.1/", "tags"=>"API Provider,ATMs,Banking,General Data,Profiles,Relative Data,UK Banks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/coutts/businesscurrentaccounts-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/coutts/coutts-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://www.coutts.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-certificate-manager{"aws-certificate-manager-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Certificate Manager", "x-complete"=>1, "info"=>{"title"=>"AWS Certificate Manager API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddTagsToCertificate"=>{"get"=>{"summary"=>"Add Tags To Certificate", "description"=>"Adds one or more tags to an ACM Certificate.", "operationId"=>"AddTagsToCertificate", "x-api-path-slug"=>"actionaddtagstocertificate-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateArn", "description"=>"String that contains the ARN of the ACM Certificate to which the tag is to be applied", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"The key-value pair that defines the tag", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate Tags"]}}, "/?Action=DeleteCertificate"=>{"get"=>{"summary"=>"Delete Certificate", "description"=>"Deletes an ACM Certificate and its associated private key.", "operationId"=>"DeleteCertificate", "x-api-path-slug"=>"actiondeletecertificate-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateArn", "description"=>"String that contains the ARN of the ACM Certificate to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=DescribeCertificate"=>{"get"=>{"summary"=>"Describe Certificate", "description"=>"Returns a list of the fields contained in the specified ACM Certificate.", "operationId"=>"DescribeCertificate", "x-api-path-slug"=>"actiondescribecertificate-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateArn", "description"=>"String that contains an ACM Certificate ARN", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=GetCertificate"=>{"get"=>{"summary"=>"Get Certificate", "description"=>"Retrieves an ACM Certificate and certificate chain for the certificate specified by an\n ARN.", "operationId"=>"GetCertificate", "x-api-path-slug"=>"actiongetcertificate-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateArn", "description"=>"String that contains a certificate ARN in the following format:", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=ImportCertificate"=>{"get"=>{"summary"=>"Import Certificate", "description"=>"Imports an SSL/TLS certificate into AWS Certificate Manager (ACM) to use with.", "operationId"=>"ImportCertificate", "x-api-path-slug"=>"actionimportcertificate-get", "parameters"=>[{"in"=>"query", "name"=>"Certificate", "description"=>"The certificate to import", "type"=>"string"}, {"in"=>"query", "name"=>"CertificateArn", "description"=>"The Amazon Resource Name (ARN) of an imported certificate to replace", "type"=>"string"}, {"in"=>"query", "name"=>"CertificateChain", "description"=>"The certificate chain", "type"=>"string"}, {"in"=>"query", "name"=>"PrivateKey", "description"=>"The private key that matches the public key in the certificate", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=ListCertificates"=>{"get"=>{"summary"=>"List Certificates", "description"=>"Retrieves a list of ACM Certificates and the domain name for each.", "operationId"=>"ListCertificates", "x-api-path-slug"=>"actionlistcertificates-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateStatuses", "description"=>"The status or statuses on which to filter the list of ACM Certificates", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"Use this parameter when paginating results to specify the maximum number of items to return in the response", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=ListTagsForCertificate"=>{"get"=>{"summary"=>"List Tags For Certificate", "description"=>"Lists the tags that have been applied to the ACM Certificate.", "operationId"=>"ListTagsForCertificate", "x-api-path-slug"=>"actionlisttagsforcertificate-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateArn", "description"=>"String that contains the ARN of the ACM Certificate for which you want to list the tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate Tags"]}}, "/?Action=RemoveTagsFromCertificate"=>{"get"=>{"summary"=>"Remove Tags From Certificate", "description"=>"Remove one or more tags from an ACM Certificate.", "operationId"=>"RemoveTagsFromCertificate", "x-api-path-slug"=>"actionremovetagsfromcertificate-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateArn", "description"=>"String that contains the ARN of the ACM Certificate with one or more tags that you want to remove", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"The key-value pair that defines the tag to remove", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate Tags"]}}, "/?Action=RequestCertificate"=>{"get"=>{"summary"=>"Request Certificate", "description"=>"Requests an ACM Certificate for use with other AWS services.", "operationId"=>"RequestCertificate", "x-api-path-slug"=>"actionrequestcertificate-get", "parameters"=>[{"in"=>"query", "name"=>"DomainName", "description"=>"Fully qualified domain name (FQDN), such as www", "type"=>"string"}, {"in"=>"query", "name"=>"DomainValidationOptions", "description"=>"The base validation domain that will act as the suffix of the email addresses that are used to send the emails", "type"=>"string"}, {"in"=>"query", "name"=>"IdempotencyToken", "description"=>"Customer chosen string that can be used to distinguish between calls to RequestCertificate", "type"=>"string"}, {"in"=>"query", "name"=>"SubjectAlternativeNames", "description"=>"Additional FQDNs to be included in the Subject Alternative Name extension of the ACM Certificate", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=ResendValidationEmail"=>{"get"=>{"summary"=>"Resend Validation Email", "description"=>"Resends the email that requests domain ownership validation.", "operationId"=>"ResendValidationEmail", "x-api-path-slug"=>"actionresendvalidationemail-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateArn", "description"=>"String that contains the ARN of the requested certificate", "type"=>"string"}, {"in"=>"query", "name"=>"Domain", "description"=>"The Fully Qualified Domain Name (FQDN) of the certificate that needs to be validated", "type"=>"string"}, {"in"=>"query", "name"=>"ValidationDomain", "description"=>"The base validation domain that will act as the suffix of the email addresses that are used to send the emails", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Validation Email"]}}}}, "apis"=>{"name"=>"AWS Certificate Manager", "x-slug"=>"aws-certificate-manager", "description"=>"AWS Certificate Manager is a service that lets you easily provision, manage, and deploy Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificates for use with AWS services. SSL/TLS certificates are used to secure network communications and establish the identity of websites over the Internet. AWS Certificate Manager removes the time-consuming manual process of purchasing, uploading, and renewing SSL/TLS certificates. With AWS Certificate Manager, you can quickly request a certificate, deploy it on AWS resources such as Elastic Load Balancers or Amazon CloudFront distributions, and let AWS Certificate Manager handle certificate renewals. SSL/TLS certificates provisioned through AWS Certificate Manager are free. You pay only for the AWS resources you create to run your application.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Security-Identity_ACM_certificate-manager.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Certificates,Encryption,Profiles,Relative Data,Security,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-certificate-manager/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Certificate Manager API", "x-api-slug"=>"aws-certificate-manager-api", "description"=>"AWS Certificate Manager is a service that lets you easily provision, manage, and deploy Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificates for use with AWS services. SSL/TLS certificates are used to secure network communications and establish the identity of websites over the Internet. AWS Certificate Manager removes the time-consuming manual process of purchasing, uploading, and renewing SSL/TLS certificates. With AWS Certificate Manager, you can quickly request a certificate, deploy it on AWS resources such as Elastic Load Balancers or Amazon CloudFront distributions, and let AWS Certificate Manager handle certificate renewals. SSL/TLS certificates provisioned through AWS Certificate Manager are free. You pay only for the AWS resources you create to run your application.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Security-Identity_ACM_certificate-manager.png", "humanURL"=>"https://aws.amazon.com/certificate-manager/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Certificates,Encryption,Profiles,Relative Data,Security,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-certificate-manager/aws-certificate-manager-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/cli/latest/reference/acm/index.html"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/acm/latest/APIReference/Welcome.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/certificate-manager/faqs/"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=206"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/certificate-manager/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/certificate-manager/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/certificate-manager/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bigcommerce{"bigcommerce-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"BigCommerce", "x-complete"=>1, "info"=>{"title"=>"BigCommerce API V3", "description"=>"collection-of-requests-for-interacting-with-bigcommerces-v3-api", "version"=>"1.0.0"}, "host"=>"api.bigcommerce.com", "basePath"=>"/stores", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{store-hash}/v3/catalog/products/{id}/images"=>{"get"=>{"summary"=>"Retrieve images for a single product", "description"=>"GET request for retrieving images associated with a product", "operationId"=>"V3CatalogProductsImagesByStoreHashAndIdGet", "x-api-path-slug"=>"storehashv3catalogproductsidimages-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store-hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Imagesa", "Single", "Product"]}, "post"=>{"summary"=>"Upload a new product image to a single product", "description"=>"Adds a new product image from a publicly accessible URL. May fail if the hosting website is forcing HTTPS connections with TLS 1.0 (as this has been deprecated).", "operationId"=>"V3CatalogProductsImagesByStoreHashAndIdPost", "x-api-path-slug"=>"storehashv3catalogproductsidimages-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store-hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Upload", "New", "Product", "Image", "To", "Single", "Product"]}}, "/{store-hash}/v3/catalog/products/{id}"=>{"get"=>{"summary"=>"Retrieve a single product with expanded sub-resources", "description"=>"Request a single product with expanded variant information", "operationId"=>"V3CatalogProductsByStoreHashAndIdGet", "x-api-path-slug"=>"storehashv3catalogproductsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"include"}, {"in"=>"path", "name"=>"store-hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Single", "Product", "Expanded", "Sub-resources"]}, "put"=>{"summary"=>"Update a product in the catalog", "description"=>"Updates a single product's information in the catalog", "operationId"=>"V3CatalogProductsByStoreHashAndIdPut", "x-api-path-slug"=>"storehashv3catalogproductsid-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store-hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Product", "In", "Catalog"]}, "delete"=>{"summary"=>"Delete a single product by ID", "description"=>"Deleting a single product from the catalog by product ID", "operationId"=>"V3CatalogProductsByStoreHashAndIdDelete", "x-api-path-slug"=>"storehashv3catalogproductsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store-hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Product", "By", "ID"]}}, "/{store_hash}/v3/catalog/products/{id}/videos/{id}"=>{"get"=>{"summary"=>"Retrieve a video on a product", "description"=>"", "operationId"=>"V3CatalogProductsVideosIdByStoreHashAndIdGet", "x-api-path-slug"=>"store-hashv3catalogproductsidvideosid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Video", "On", "Product"]}, "put"=>{"summary"=>"Updates an video on a product", "description"=>"", "operationId"=>"V3CatalogProductsVideosIdByStoreHashAndIdPut", "x-api-path-slug"=>"store-hashv3catalogproductsidvideosid-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "S", "Video", "On", "Product"]}, "delete"=>{"summary"=>"Delete a video on a product", "description"=>"", "operationId"=>"V3CatalogProductsVideosIdByStoreHashAndIdDelete", "x-api-path-slug"=>"store-hashv3catalogproductsidvideosid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Video", "On", "Product"]}}, "/{store_hash}/v3/catalog/products/variants"=>{"get"=>{"summary"=>"Retrieve variant with parameters", "description"=>"Returns a `Variant` object list from the BigCommerce Catalog.", "operationId"=>"V3CatalogProductsVariantsByStoreHashGet", "x-api-path-slug"=>"store-hashv3catalogproductsvariants-get", "parameters"=>[{"in"=>"query", "name"=>"sku"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Variant", "Parameters"]}}, "/{store_hash}/v3/catalog/products/{id}/videos"=>{"get"=>{"summary"=>"Retrieve all videos for a single product", "description"=>"", "operationId"=>"V3CatalogProductsVideosByStoreHashAndIdGet", "x-api-path-slug"=>"store-hashv3catalogproductsidvideos-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "", "Videosa", "Single", "Product"]}, "post"=>{"summary"=>"Add a video to a product using a video ID from Youtube", "description"=>"Creates an video on a product using a video ID from Youtube", "operationId"=>"V3CatalogProductsVideosByStoreHashAndIdPost", "x-api-path-slug"=>"store-hashv3catalogproductsidvideos-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Video", "To", "Product", "Using", "Video", "ID", "From", "Youtube"]}}, "/{store_hash}/v3/catalog/categories/{id}"=>{"get"=>{"summary"=>"Retrieve a single category", "description"=>"", "operationId"=>"V3CatalogCategoriesByStoreHashAndIdGet", "x-api-path-slug"=>"store-hashv3catalogcategoriesid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Single", "Category"]}, "put"=>{"summary"=>"Update a category", "description"=>"Update a `Category` in the BigCommerce Catalog", "operationId"=>"V3CatalogCategoriesByStoreHashAndIdPut", "x-api-path-slug"=>"store-hashv3catalogcategoriesid-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Category"]}, "delete"=>{"summary"=>"Delete a single category", "description"=>"", "operationId"=>"V3CatalogCategoriesByStoreHashAndIdDelete", "x-api-path-slug"=>"store-hashv3catalogcategoriesid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Category"]}}, "/{store_hash}/v3/catalog/brands/{id}/image"=>{"post"=>{"summary"=>"Upload an image for a brand", "description"=>"", "operationId"=>"V3CatalogBrandsImageByStoreHashAndIdPost", "x-api-path-slug"=>"store-hashv3catalogbrandsidimage-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"image_file"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Upload", "Imagea", "Brand"]}, "delete"=>{"summary"=>"Delete a brand image", "description"=>"Delete a `Brand` image the BigCommerce Catalog", "operationId"=>"V3CatalogBrandsImageByStoreHashAndIdDelete", "x-api-path-slug"=>"store-hashv3catalogbrandsidimage-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Brand", "Image"]}}, "/{store-hash}/v3/catalog/products"=>{"get"=>{"summary"=>"Retrieve all products with expanded sub-resources", "description"=>"Shows full product data with a single GET request", "operationId"=>"V3CatalogProductsByStoreHashGet", "x-api-path-slug"=>"storehashv3catalogproducts-get", "parameters"=>[{"in"=>"query", "name"=>"include"}, {"in"=>"path", "name"=>"store-hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "", "Products", "Expanded", "Sub-resources"]}, "post"=>{"summary"=>"Create a new product with variants", "description"=>"Sample request for creating a new product with variants through V3 Catalog API", "operationId"=>"V3CatalogProductsByStoreHashPost", "x-api-path-slug"=>"storehashv3catalogproducts-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"store-hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Product", "Variants"]}, "delete"=>{"summary"=>"Delete multiple products", "description"=>"Deletes products that aren't marked as visible using a filter parameter", "operationId"=>"V3CatalogProductsByStoreHashDelete", "x-api-path-slug"=>"storehashv3catalogproducts-delete", "parameters"=>[{"in"=>"query", "name"=>"is_visible"}, {"in"=>"path", "name"=>"store-hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Multiple", "Products"]}}, "/{store_hash}/v3/catalog/summary"=>{"get"=>{"summary"=>"Returns a lightweight inventory summary", "description"=>"Returns a lightweight inventory summary from the BigCommerce Catalog.", "operationId"=>"V3CatalogSummaryByStoreHashGet", "x-api-path-slug"=>"store-hashv3catalogsummary-get", "parameters"=>[{"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Returns", "Lightweight", "Inventory", "Summary"]}}, "/{store_hash}/v3/catalog/products/{id}/options"=>{"get"=>{"summary"=>"Retrieve an array of product options", "description"=>"", "operationId"=>"V3CatalogProductsOptionsByStoreHashAndIdGet", "x-api-path-slug"=>"store-hashv3catalogproductsidoptions-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Array", "Of", "Product", "Options"]}, "post"=>{"summary"=>"Create a product option", "description"=>"", "operationId"=>"V3CatalogProductsOptionsByStoreHashAndIdPost", "x-api-path-slug"=>"store-hashv3catalogproductsidoptions-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Product", "Option"]}}, "/{store_hash}/v3/catalog/categories/{id}/image"=>{"post"=>{"summary"=>"Create an image for a category", "description"=>"", "operationId"=>"V3CatalogCategoriesImageByStoreHashAndIdPost", "x-api-path-slug"=>"store-hashv3catalogcategoriesidimage-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Imagea", "Category"]}, "delete"=>{"summary"=>"Delete a category image", "description"=>"", "operationId"=>"V3CatalogCategoriesImageByStoreHashAndIdDelete", "x-api-path-slug"=>"store-hashv3catalogcategoriesidimage-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Category", "Image"]}}, "/{store_hash}/v3/catalog/products/{id}/modifiers"=>{"get"=>{"summary"=>"Retrieve an array of product modifiers", "description"=>"", "operationId"=>"V3CatalogProductsModifiersByStoreHashAndIdGet", "x-api-path-slug"=>"store-hashv3catalogproductsidmodifiers-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Array", "Of", "Product", "Modifiers"]}, "post"=>{"summary"=>"Create a product modifier", "description"=>"", "operationId"=>"V3CatalogProductsModifiersByStoreHashAndIdPost", "x-api-path-slug"=>"store-hashv3catalogproductsidmodifiers-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Product", "Modifier"]}}, "/{store-hash}/v3/catalog/products/{id}/images/{id}"=>{"get"=>{"summary"=>"Retrieve a single product image's data", "description"=>"GET request for a specific product image by ID", "operationId"=>"V3CatalogProductsImagesIdByStoreHashAndIdGet", "x-api-path-slug"=>"storehashv3catalogproductsidimagesid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store-hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Single", "Product", "Images", "Data"]}, "put"=>{"summary"=>"Update product image information", "description"=>"This is used to update the information for an existing product image", "operationId"=>"V3CatalogProductsImagesIdByStoreHashAndIdPut", "x-api-path-slug"=>"storehashv3catalogproductsidimagesid-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store-hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Product", "Image", "Information"]}, "delete"=>{"summary"=>"Delete a single product image", "description"=>"Delete a product image and it's description", "operationId"=>"V3CatalogProductsImagesIdByStoreHashAndIdDelete", "x-api-path-slug"=>"storehashv3catalogproductsidimagesid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store-hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Product", "Image"]}}, "/{store_hash}/v3/catalog/brands"=>{"get"=>{"summary"=>"Retrieve brands", "description"=>"", "operationId"=>"V3CatalogBrandsByStoreHashGet", "x-api-path-slug"=>"store-hashv3catalogbrands-get", "parameters"=>[{"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"page"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Brands"]}, "post"=>{"summary"=>"Create a new brand", "description"=>"", "operationId"=>"V3CatalogBrandsByStoreHashPost", "x-api-path-slug"=>"store-hashv3catalogbrands-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Brand"]}, "delete"=>{"summary"=>"Delete a brand or brands", "description"=>"Delete one or more `Brand` objects from the BigCommerce Catalog", "operationId"=>"V3CatalogBrandsByStoreHashDelete", "x-api-path-slug"=>"store-hashv3catalogbrands-delete", "parameters"=>[{"in"=>"query", "name"=>"page_title"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Brand", "Brands"]}}, "/{store_hash}/v3/customers/subscribers"=>{"get"=>{"summary"=>"Returns all newsletter subscribers", "description"=>"Returns a paginated Subscribers collection.", "operationId"=>"V3CustomersSubscribersByStoreHashGet", "x-api-path-slug"=>"store-hashv3customerssubscribers-get", "parameters"=>[{"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Returns", "", "Newsletter", "Subscribers"]}, "post"=>{"summary"=>"Create a new subscriber", "description"=>"", "operationId"=>"V3CustomersSubscribersByStoreHashPost", "x-api-path-slug"=>"store-hashv3customerssubscribers-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Subscriber"]}, "delete"=>{"summary"=>"Delete a group of subscribers by parameter", "description"=>"", "operationId"=>"V3CustomersSubscribersByStoreHashDelete", "x-api-path-slug"=>"store-hashv3customerssubscribers-delete", "parameters"=>[{"in"=>"query", "name"=>"date_created"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Group", "Of", "Subscribers", "By", "Parameter"]}}, "/{store_hash}/v3/catalog/categories"=>{"get"=>{"summary"=>"Retrieve categories", "description"=>"Returns a paginated categories collection from the BigCommerce Catalog", "operationId"=>"V3CatalogCategoriesByStoreHashGet", "x-api-path-slug"=>"store-hashv3catalogcategories-get", "parameters"=>[{"in"=>"query", "name"=>"is_visible"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Categories"]}, "post"=>{"summary"=>"Create a new category", "description"=>"", "operationId"=>"V3CatalogCategoriesByStoreHashPost", "x-api-path-slug"=>"store-hashv3catalogcategories-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Category"]}, "delete"=>{"summary"=>"Delete a category or categories", "description"=>"", "operationId"=>"V3CatalogCategoriesByStoreHashDelete", "x-api-path-slug"=>"store-hashv3catalogcategories-delete", "parameters"=>[{"in"=>"query", "name"=>"is_visible"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Category", "Categories"]}}, "/{store_hash}/v3/catalog/categories/tree"=>{"get"=>{"summary"=>"Retrieve category structure/tree", "description"=>"", "operationId"=>"V3CatalogCategoriesTreeByStoreHashGet", "x-api-path-slug"=>"store-hashv3catalogcategoriestree-get", "parameters"=>[{"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Category", "Structure", "Tree"]}}, "/{store_hash}/v3/catalog/products/{id}/variants/{id}"=>{"get"=>{"summary"=>"Retrieve a single variant", "description"=>"Get a `Variant` object.", "operationId"=>"V3CatalogProductsVariantsIdByStoreHashAndIdGet", "x-api-path-slug"=>"store-hashv3catalogproductsidvariantsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Single", "Variant"]}, "put"=>{"summary"=>"Update a variant", "description"=>"Update a `Variant` object.", "operationId"=>"V3CatalogProductsVariantsIdByStoreHashAndIdPut", "x-api-path-slug"=>"store-hashv3catalogproductsidvariantsid-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Variant"]}, "delete"=>{"summary"=>"Delete a variant", "description"=>"Delete a `Variant`", "operationId"=>"V3CatalogProductsVariantsIdByStoreHashAndIdDelete", "x-api-path-slug"=>"store-hashv3catalogproductsidvariantsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Variant"]}}, "/{store_hash}/v3/catalog/products/{id}/modifiers/{id}"=>{"get"=>{"summary"=>"Retrieve a product modifier", "description"=>"", "operationId"=>"V3CatalogProductsModifiersIdByStoreHashAndIdGet", "x-api-path-slug"=>"store-hashv3catalogproductsidmodifiersid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Product", "Modifier"]}, "put"=>{"summary"=>"Update a product modifier", "description"=>"", "operationId"=>"V3CatalogProductsModifiersIdByStoreHashAndIdPut", "x-api-path-slug"=>"store-hashv3catalogproductsidmodifiersid-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Product", "Modifier"]}, "delete"=>{"summary"=>"Delete a product's modifier", "description"=>"", "operationId"=>"V3CatalogProductsModifiersIdByStoreHashAndIdDelete", "x-api-path-slug"=>"store-hashv3catalogproductsidmodifiersid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Products", "Modifier"]}}, "/{store_hash}/v3/customers/subscribers/{id}"=>{"get"=>{"summary"=>"Return a single subscriber by ID", "description"=>"", "operationId"=>"V3CustomersSubscribersByStoreHashAndIdGet", "x-api-path-slug"=>"store-hashv3customerssubscribersid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Return", "Single", "Subscriber", "By", "ID"]}, "put"=>{"summary"=>"Update a single subscriber", "description"=>"", "operationId"=>"V3CustomersSubscribersByStoreHashAndIdPut", "x-api-path-slug"=>"store-hashv3customerssubscribersid-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Subscriber"]}, "delete"=>{"summary"=>"Delete a single subscriber by ID", "description"=>"", "operationId"=>"V3CustomersSubscribersByStoreHashAndIdDelete", "x-api-path-slug"=>"store-hashv3customerssubscribersid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Subscriber", "By", "ID"]}}, "/{store_id}/v3/catalog/products/{id}/options/{id}"=>{"put"=>{"summary"=>"Update a product option", "description"=>"", "operationId"=>"V3CatalogProductsOptionsIdByStoreIdAndIdPut", "x-api-path-slug"=>"store-idv3catalogproductsidoptionsid-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Product", "Option"]}}, "/{store_hash}/v3/catalog/brands/{id}"=>{"get"=>{"summary"=>"Retrieve a brand", "description"=>"", "operationId"=>"V3CatalogBrandsByStoreHashAndIdGet", "x-api-path-slug"=>"store-hashv3catalogbrandsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Brand"]}, "put"=>{"summary"=>"Update a brand", "description"=>"", "operationId"=>"V3CatalogBrandsByStoreHashAndIdPut", "x-api-path-slug"=>"store-hashv3catalogbrandsid-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Brand"]}, "delete"=>{"summary"=>"Delete a brand", "description"=>"", "operationId"=>"V3CatalogBrandsByStoreHashAndIdDelete", "x-api-path-slug"=>"store-hashv3catalogbrandsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Brand"]}}, "/{store_hash}/v3/catalog/products/{id}/options/{id}"=>{"get"=>{"summary"=>"Retrieve a product option", "description"=>"Gets `Option` object by product id and option id.", "operationId"=>"V3CatalogProductsOptionsIdByStoreHashAndIdGet", "x-api-path-slug"=>"store-hashv3catalogproductsidoptionsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Product", "Option"]}, "delete"=>{"summary"=>"Delete a product option", "description"=>"", "operationId"=>"V3CatalogProductsOptionsIdByStoreHashAndIdDelete", "x-api-path-slug"=>"store-hashv3catalogproductsidoptionsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Product", "Option"]}}, "/{store_hash}/v3/catalog/products/{id}/modifiers/{id}/values/{id}/image"=>{"post"=>{"summary"=>"Add an image to a modifier value", "description"=>"Add an image to a modifier value that will show on the storefront when it’s selected", "operationId"=>"V3CatalogProductsModifiersIdValuesIdImageByStoreHashAndIdPost", "x-api-path-slug"=>"store-hashv3catalogproductsidmodifiersidvaluesidimage-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"image_file"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Image", "To", "Modifier", "Value"]}, "delete"=>{"summary"=>"Delete the image associated with a modifier", "description"=>"Delete the image applied to show when the modifier value is selected", "operationId"=>"V3CatalogProductsModifiersIdValuesIdImageByStoreHashAndIdDelete", "x-api-path-slug"=>"store-hashv3catalogproductsidmodifiersidvaluesidimage-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Image", "Associated", "Modifier"]}}, "/{store_hash}/v3/catalog/products/{id}/variants/{id}/image"=>{"post"=>{"summary"=>"Upload a variant image", "description"=>"", "operationId"=>"V3CatalogProductsVariantsIdImageByStoreHashAndIdPost", "x-api-path-slug"=>"store-hashv3catalogproductsidvariantsidimage-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"formData", "name"=>"image_file"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Upload", "Variant", "Image"]}}, "/{store_hash}/v3/catalog/products/{id}/variants"=>{"get"=>{"summary"=>"Retrieve a list of variants", "description"=>"Returns a `Variant` object list from the BigCommerce Catalog.", "operationId"=>"V3CatalogProductsVariantsByStoreHashAndIdGet", "x-api-path-slug"=>"store-hashv3catalogproductsidvariants-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "List", "Of", "Variants"]}, "post"=>{"summary"=>"Create a variant", "description"=>"", "operationId"=>"V3CatalogProductsVariantsByStoreHashAndIdPost", "x-api-path-slug"=>"store-hashv3catalogproductsidvariants-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"store_hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Variant"]}}}}, "apis"=>{"name"=>"BigCommerce", "x-slug"=>"bigcommerce", "description"=>"BigCommerce is the world’s leading cloud ecommerce platform for established and rapidly-growing businesses. Combining enterprise functionality, an open architecture and app ecosystem, and market-leading performance, BigCommerce enables businesses to grow online sales with 80% less cost, time and complexity than on-premise software.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/BigCommerce-logo-dark.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Relative Data,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bigcommerce/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"BigCommerce", "x-api-slug"=>"bigcommerce", "description"=>"BigCommerce is the world’s leading cloud ecommerce platform for established and rapidly-growing businesses. Combining enterprise functionality, an open architecture and app ecosystem, and market-leading performance, BigCommerce enables businesses to grow online sales with 80% less cost, time and complexity than on-premise software.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/BigCommerce-logo-dark.png", "humanURL"=>"http://bigcommerce.com", "baseURL"=>"https://api.bigcommerce.com//stores", "tags"=>"Relative Data,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/bigcommerce/bigcommerce-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-twitter", "url"=>"https://twitter.com/Bigcommerce"}, {"type"=>"x-curated-source", "url"=>"http://www.bigcommerce.com/blog/saas-solution-for-enterprise-brands/"}, {"type"=>"x-website", "url"=>"http://bigcommerce.com"}, {"type"=>"x-blog", "url"=>"https://www.bigeng.io/"}, {"type"=>"x-blog-rss", "url"=>"view-source:https://www.bigeng.io/rss/"}, {"type"=>"x-change-log", "url"=>"https://developer.bigcommerce.com/changelog/"}, {"type"=>"x-developer", "url"=>"https://developer.bigcommerce.com/"}, {"type"=>"x-documentation", "url"=>"https://developer.bigcommerce.com/api/v3/"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/bigcommerce"}, {"type"=>"x-postman-collection", "url"=>"https://app.getpostman.com/run-collection/0911a7fefbc14ed2e4cb"}, {"type"=>"x-pricing", "url"=>"https://www.bigcommerce.com/pricing/"}, {"type"=>"x-support", "url"=>"https://developer.bigcommerce.com/support/"}, {"type"=>"x-webhook", "url"=>"https://developer.bigcommerce.com/api/#webhooks-overview"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
stride{"stride-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Stride", "x-complete"=>1, "info"=>{"title"=>"Stride", "description"=>"this-service-provides-public-api-for-the-stride-", "version"=>"1.0.0"}, "host"=>"api.atlassian.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/app/module/chat/conversation/chat:configuration/{key}/state"=>{"post"=>{"summary"=>"Send app configuration updates", "description"=>"Post app configuration updates telling the.\n\nAuthentication required.", "operationId"=>"AppModuleChatConversationChatConfigurationStateByKeyPost", "x-api-path-slug"=>"appmodulechatconversationchatconfigurationkeystate-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "App", "Module", "Chat", "Conversation", "Chat", "Configuration", "Key", "State"]}}, "/app/module/chat/conversation/chat:glance/{key}/state"=>{"post"=>{"summary"=>"Send glance updates", "description"=>"Post glance updates which will be pushed for all users within the specified context.\n\nAuthentication required.", "operationId"=>"AppModuleChatConversationChatGlanceStateByKeyPost", "x-api-path-slug"=>"appmodulechatconversationchatglancekeystate-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "App", "Module", "Chat", "Conversation", "Chat", "Glance", "Key", "State"]}}, "/site/{cloudId}/conversation"=>{"get"=>{"summary"=>"Get conversation list for site", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"SiteConversationByCloudIdGet", "x-api-path-slug"=>"sitecloudidconversation-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"cloudId"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"cursor"}, {"in"=>"query", "name"=>"include-archived"}, {"in"=>"query", "name"=>"include-private"}, {"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"query"}, {"in"=>"query", "name"=>"sort"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Site", "Cloud", "Conversation"]}, "post"=>{"summary"=>"Create conversation", "description"=>"Authentication required, with scope manage:conversation", "operationId"=>"SiteConversationByCloudIdPost", "x-api-path-slug"=>"sitecloudidconversation-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"cloudId"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Site", "Cloud", "Conversation"]}}, "/site/{cloudId}/conversation/user/{userId}/message"=>{"post"=>{"summary"=>"Send message to user", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"SiteConversationUserMessageByCloudIdAndUserIdPost", "x-api-path-slug"=>"sitecloudidconversationuseruseridmessage-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"cloudId"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Site", "Cloud", "Conversation", "User", "User", "Message"]}}, "/site/{cloudId}/conversation/{conversationId}"=>{"get"=>{"summary"=>"Get conversation details", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"SiteConversationByCloudIdAndConversationIdGet", "x-api-path-slug"=>"sitecloudidconversationconversationid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"cloudId"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"conversationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Site", "Cloud", "Conversation", "Conversation"]}, "patch"=>{"summary"=>"Update conversation", "description"=>"Authentication required, with scope manage:conversation", "operationId"=>"SiteConversationByCloudIdAndConversationIdPatch", "x-api-path-slug"=>"sitecloudidconversationconversationid-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"cloudId"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"conversationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Site", "Cloud", "Conversation", "Conversation"]}}, "/site/{cloudId}/conversation/{conversationId}/archive"=>{"put"=>{"summary"=>"Archive conversation", "description"=>"Authentication required, with scope manage:conversation", "operationId"=>"SiteConversationArchiveByCloudIdAndConversationIdPut", "x-api-path-slug"=>"sitecloudidconversationconversationidarchive-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"cloudId"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"conversationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Site", "Cloud", "Conversation", "Conversation", "Archives"]}}, "/site/{cloudId}/conversation/{conversationId}/media"=>{"post"=>{"summary"=>"Upload a file", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"SiteConversationMediaByCloudIdAndConversationIdPost", "x-api-path-slug"=>"sitecloudidconversationconversationidmedia-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"cloudId"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"conversationId"}, {"in"=>"query", "name"=>"name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Site", "Cloud", "Conversation", "Conversation", "Media"]}}, "/site/{cloudId}/conversation/{conversationId}/media/{mediaId}"=>{"get"=>{"summary"=>"Get a file", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"SiteConversationMediaMediaIdByCloudIdAndConversationIdGet", "x-api-path-slug"=>"sitecloudidconversationconversationidmediamediaid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"cloudId"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"conversationId"}, {"in"=>"path", "name"=>"mediaId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Site", "Cloud", "Conversation", "Conversation", "Media", "Media"]}}, "/site/{cloudId}/conversation/{conversationId}/message"=>{"get"=>{"summary"=>"Get conversation history", "description"=>"Authentication required, with scope participate:conversation\n\nThis method returns messages after/before a given messageIDs or/and timestamps.\nIf these parameters are omitted the method returns conversation???s latest messages.", "operationId"=>"SiteConversationMessageByCloudIdAndConversationIdGet", "x-api-path-slug"=>"sitecloudidconversationconversationidmessage-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"afterMessage"}, {"in"=>"query", "name"=>"afterTimestamp"}, {"in"=>"query", "name"=>"beforeMessage"}, {"in"=>"query", "name"=>"beforeTimestamp"}, {"in"=>"path", "name"=>"cloudId"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"conversationId"}, {"in"=>"query", "name"=>"limit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Site", "Cloud", "Conversation", "Conversation", "Message"]}, "post"=>{"summary"=>"Send a message to a conversation", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"SiteConversationMessageByCloudIdAndConversationIdPost", "x-api-path-slug"=>"sitecloudidconversationconversationidmessage-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"cloudId"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"conversationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Site", "Cloud", "Conversation", "Conversation", "Message"]}}, "/site/{cloudId}/conversation/{conversationId}/message/recent"=>{"get"=>{"summary"=>"Get latest messages for conversation", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"SiteConversationMessageRecentByCloudIdAndConversationIdGet", "x-api-path-slug"=>"sitecloudidconversationconversationidmessagerecent-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"cloudId"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"conversationId"}, {"in"=>"query", "name"=>"limit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Site", "Cloud", "Conversation", "Conversation", "Message", "Recent"]}}, "/site/{cloudId}/conversation/{conversationId}/message/{messageId}"=>{"get"=>{"summary"=>"Get message by id", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"SiteConversationMessageMessageIdByCloudIdAndConversationIdGet", "x-api-path-slug"=>"sitecloudidconversationconversationidmessagemessageid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"cloudId"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"conversationId"}, {"in"=>"path", "name"=>"messageId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Site", "Cloud", "Conversation", "Conversation", "Message", "Message"]}}, "/site/{cloudId}/conversation/{conversationId}/message/{messageId}/context"=>{"get"=>{"summary"=>"Get conversation history contextually", "description"=>"Authentication required, with scope participate:conversation\n\nThis method returns messages after and/or before a given messageID including the message itself.\nDefault value for 'after' and 'before' query parameters is 0.", "operationId"=>"SiteConversationMessageMessageIdContextByCloudIdAndConversationIdGet", "x-api-path-slug"=>"sitecloudidconversationconversationidmessagemessageidcontext-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"after"}, {"in"=>"query", "name"=>"before"}, {"in"=>"path", "name"=>"cloudId"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"conversationId"}, {"in"=>"path", "name"=>"messageId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Site", "Cloud", "Conversation", "Conversation", "Message", "Message", "Context"]}}, "/site/{cloudId}/conversation/{conversationId}/roster"=>{"get"=>{"summary"=>"Get conversation roster", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"SiteConversationRosterByCloudIdAndConversationIdGet", "x-api-path-slug"=>"sitecloudidconversationconversationidroster-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"cloudId"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"conversationId"}, {"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"start"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Site", "Cloud", "Conversation", "Conversation", "Roster"]}}, "/site/{cloudId}/conversation/{conversationId}/unarchive"=>{"put"=>{"summary"=>"Unarchive conversation", "description"=>"Authentication required, with scope manage:conversation", "operationId"=>"SiteConversationUnarchiveByCloudIdAndConversationIdPut", "x-api-path-slug"=>"sitecloudidconversationconversationidunarchive-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"cloudId"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"conversationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Site", "Cloud", "Conversation", "Conversation", "Unarchive", "Archives"]}}}}, "apis"=>{"name"=>"Stride", "x-slug"=>"stride", "description"=>"Stride is a cloud-based team business communication and collaboration tool, launched by Atlassian to replace the cloud-based version of HipChat. Stride software is available to download onto computers running Windows, Mac or Linux, as well as Android, iOS smartphones, and tablets", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28142-stride.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"40723", "tags"=>"Chats,Messages,Mobile,Networks,Relative Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"stride/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Stride", "x-api-slug"=>"stride", "description"=>"Stride is a cloud-based team business communication and collaboration tool, launched by Atlassian to replace the cloud-based version of HipChat. Stride software is available to download onto computers running Windows, Mac or Linux, as well as Android, iOS smartphones, and tablets", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28142-stride.jpg", "humanURL"=>"https://www.stride.com/", "baseURL"=>"https://api.atlassian.com//", "tags"=>"Chats,Messages,Mobile,Networks,Relative Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/stride/stride-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://developer.atlassian.com/cloud/stride/security/authentication/"}, {"type"=>"x-blog", "url"=>"https://blog.stride.com/"}, {"type"=>"x-buttons", "url"=>"https://developer.atlassian.com/cloud/stride/blocks/stride-button/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/stride"}, {"type"=>"x-developer", "url"=>"https://developer.atlassian.com/cloud/stride/"}, {"type"=>"x-getting-started", "url"=>"https://developer.atlassian.com/cloud/stride/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://www.stride.com/pricing"}, {"type"=>"x-security", "url"=>"https://developer.atlassian.com/cloud/stride/security/security-overview/"}, {"type"=>"x-support", "url"=>"https://www.stride.com/help-center"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/atlassianstride"}, {"type"=>"x-website", "url"=>"https://www.stride.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
allied-irish-bank{"allied-irish-bank-account-apis-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Allied Irish Bank", "x-complete"=>1, "info"=>{"title"=>"Account and Transaction API Specification", "description"=>"swagger-for-account-and-transaction-api-specification", "termsOfService"=>"https://www.openbanking.org.uk/terms", "contact"=>{"name"=>"Service Desk", "email"=>"ServiceDesk@openbanking.org.uk"}, "version"=>"1.0.0"}, "basePath"=>"/open-banking/v1.1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/account-requests"=>{"post"=>{"summary"=>"Create an account request", "description"=>"Create an account request", "operationId"=>"CreateAccountRequest", "x-api-path-slug"=>"accountrequests-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"body", "name"=>"body", "description"=>"Create an Account Request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}, {"in"=>"header", "name"=>"x-jws-signature", "description"=>"DO NOT USE"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "CreateAccounts", "Requests"]}}, "/account-requests/{AccountRequestId}"=>{"get"=>{"summary"=>"Get an account request", "description"=>"Get an account request", "operationId"=>"GetAccountRequest", "x-api-path-slug"=>"accountrequestsaccountrequestid-get", "parameters"=>[{"in"=>"path", "name"=>"AccountRequestId", "description"=>"Unique identification as assigned by the ASPSP to uniquely identify the account request resource"}, {"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Accounts", "Requests"]}, "delete"=>{"summary"=>"Delete an account request", "description"=>"Delete an account request", "operationId"=>"DeleteAccountRequest", "x-api-path-slug"=>"accountrequestsaccountrequestid-delete", "parameters"=>[{"in"=>"path", "name"=>"AccountRequestId", "description"=>"Unique identification as assigned by the ASPSP to uniquely identify the account request resource"}, {"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Accounts", "Requests"]}}, "/accounts"=>{"get"=>{"summary"=>"Get Accounts", "description"=>"Get a list of accounts", "operationId"=>"GetAccounts", "x-api-path-slug"=>"accounts-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Accounts"]}}, "/accounts/{AccountId}"=>{"get"=>{"summary"=>"Get Account", "description"=>"Get an account", "operationId"=>"GetAccount", "x-api-path-slug"=>"accountsaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"AccountId", "description"=>"A unique identifier used to identify the account resource"}, {"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Account"]}}, "/accounts/{AccountId}/transactions"=>{"get"=>{"summary"=>"Get Account Transactions", "description"=>"Get transactions related to an account", "operationId"=>"GetAccountTransactions", "x-api-path-slug"=>"accountsaccountidtransactions-get", "parameters"=>[{"in"=>"path", "name"=>"AccountId", "description"=>"A unique identifier used to identify the account resource"}, {"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"query", "name"=>"fromBookingDateTime", "description"=>"The UTC ISO 8601 Date Time to filter transactions FROM NB Time component is optional - set to 00:00:00 for just Date"}, {"in"=>"query", "name"=>"toBookingDateTime", "description"=>"The UTC ISO 8601 Date Time to filter transactions TO NB Time component is optional - set to 00:00:00 for just Date"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Account", "Transactions"]}}, "/accounts/{AccountId}/beneficiaries"=>{"get"=>{"summary"=>"Get Account Beneficiaries", "description"=>"Get Beneficiaries related to an account", "operationId"=>"GetAccountBeneficiaries", "x-api-path-slug"=>"accountsaccountidbeneficiaries-get", "parameters"=>[{"in"=>"path", "name"=>"AccountId", "description"=>"A unique identifier used to identify the account resource"}, {"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Account", "Beneficiaries"]}}, "/accounts/{AccountId}/balances"=>{"get"=>{"summary"=>"Get Account Balances", "description"=>"Get Balances related to an account", "operationId"=>"GetAccountBalances", "x-api-path-slug"=>"accountsaccountidbalances-get", "parameters"=>[{"in"=>"path", "name"=>"AccountId", "description"=>"A unique identifier used to identify the account resource"}, {"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Account", "Balances"]}}, "/accounts/{AccountId}/direct-debits"=>{"get"=>{"summary"=>"Get Account Direct Debits", "description"=>"Get Direct Debits related to an account", "operationId"=>"GetAccountDirectDebits", "x-api-path-slug"=>"accountsaccountiddirectdebits-get", "parameters"=>[{"in"=>"path", "name"=>"AccountId", "description"=>"A unique identifier used to identify the account resource"}, {"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Account", "Direct", "Debits"]}}, "/accounts/{AccountId}/standing-orders"=>{"get"=>{"summary"=>"Get Account Standing Orders", "description"=>"Get Standing Orders related to an account", "operationId"=>"GetAccountStandingOrders", "x-api-path-slug"=>"accountsaccountidstandingorders-get", "parameters"=>[{"in"=>"path", "name"=>"AccountId", "description"=>"A unique identifier used to identify the account resource"}, {"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Account", "Standing", "Orders"]}}, "/accounts/{AccountId}/product"=>{"get"=>{"summary"=>"Get Account Product", "description"=>"Get Product related to an account", "operationId"=>"GetAccountProduct", "x-api-path-slug"=>"accountsaccountidproduct-get", "parameters"=>[{"in"=>"path", "name"=>"AccountId", "description"=>"A unique identifier used to identify the account resource"}, {"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Account", "Product"]}}, "/standing-orders"=>{"get"=>{"summary"=>"Get Standing Orders", "description"=>"Get Standing Orders", "operationId"=>"GetStandingOrders", "x-api-path-slug"=>"standingorders-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Standing", "Orders"]}}, "/direct-debits"=>{"get"=>{"summary"=>"Get Direct Debits", "description"=>"Get Direct Debits", "operationId"=>"GetDirectDebits", "x-api-path-slug"=>"directdebits-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Direct", "Debits"]}}, "/beneficiaries"=>{"get"=>{"summary"=>"Get Beneficiaries", "description"=>"Get Beneficiaries", "operationId"=>"GetBeneficiaries", "x-api-path-slug"=>"beneficiaries-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Beneficiaries"]}}, "/transactions"=>{"get"=>{"summary"=>"Get Transactions", "description"=>"Get Transactions", "operationId"=>"GetTransactions", "x-api-path-slug"=>"transactions-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"query", "name"=>"fromBookingDateTime", "description"=>"The UTC ISO 8601 Date Time to filter transactions FROM NB Time component is optional - set to 00:00:00 for just Date"}, {"in"=>"query", "name"=>"toBookingDateTime", "description"=>"The UTC ISO 8601 Date Time to filter transactions TO NB Time component is optional - set to 00:00:00 for just Date"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Transactions"]}}, "/balances"=>{"get"=>{"summary"=>"Get Balances", "description"=>"Get Balances", "operationId"=>"GetBalances", "x-api-path-slug"=>"balances-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Balances"]}}, "/products"=>{"get"=>{"summary"=>"Get Products", "description"=>"Get Products", "operationId"=>"GetProducts", "x-api-path-slug"=>"products-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Products"]}}}}, "allied-irish-bank-payment-apis-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Allied Irish Bank", "x-complete"=>1, "info"=>{"title"=>"Payment Initiation API Specification", "description"=>"swagger-for-payment-initiation-api-specification", "termsOfService"=>"https://www.openbanking.org.uk/terms", "contact"=>{"name"=>"Service Desk", "email"=>"ServiceDesk@openbanking.org.uk"}, "version"=>"1.0.0"}, "basePath"=>"/open-banking/v1.1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/payments"=>{"post"=>{"summary"=>"Create a single immediate payment", "description"=>"Create a single immediate payment", "operationId"=>"CreateSingleImmediatePayment", "x-api-path-slug"=>"payments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"body", "name"=>"body", "description"=>"Setup a single immediate payment", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}, {"in"=>"header", "name"=>"x-idempotency-key", "description"=>"Every request will be processed only once per x-idempotency-key"}, {"in"=>"header", "name"=>"x-jws-signature", "description"=>"DO NOT USE"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Payments"]}}, "/payments/{PaymentId}"=>{"get"=>{"summary"=>"Get a single immediate payment", "description"=>"Get a single immediate payment", "operationId"=>"GetSingleImmediatePayment", "x-api-path-slug"=>"paymentspaymentid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"path", "name"=>"PaymentId", "description"=>"Unique identification as assigned by the ASPSP to uniquely identify the payment setup resource"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Payments"]}}, "/payment-submissions"=>{"post"=>{"summary"=>"Create a payment submission", "description"=>"Submit a previously setup payment", "operationId"=>"CreatePaymentSubmission", "x-api-path-slug"=>"paymentsubmissions-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"body", "name"=>"body", "description"=>"Setup a single immediate payment", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}, {"in"=>"header", "name"=>"x-idempotency-key", "description"=>"Every request will be processed only once per x-idempotency-key"}, {"in"=>"header", "name"=>"x-jws-signature", "description"=>"DO NOT USE"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Payments", "Submissions"]}}, "/payment-submissions/{PaymentSubmissionId}"=>{"get"=>{"summary"=>"Get a payment submission", "description"=>"Get payment submission", "operationId"=>"GetPaymentSubmission", "x-api-path-slug"=>"paymentsubmissionspaymentsubmissionid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"An Authorisation Token as per https://tools"}, {"in"=>"path", "name"=>"PaymentSubmissionId", "description"=>"Unique identification as assigned by the ASPSP to uniquely identify the payment submission resource"}, {"in"=>"header", "name"=>"x-fapi-customer-ip-address", "description"=>"The PSUs IP address if the PSU is currently logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-customer-last-logged-time", "description"=>"The time when the PSU last logged in with the TPP"}, {"in"=>"header", "name"=>"x-fapi-financial-id", "description"=>"The unique id of the ASPSP to which the request is issued"}, {"in"=>"header", "name"=>"x-fapi-interaction-id", "description"=>"An RFC4122 UID used as a correlation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Payments", "Submissions"]}}}}, "apis"=>{"name"=>"Allied Irish Bank", "x-slug"=>"allied-irish-bank", "description"=>"Allied Irish Banks (AIB) is one of the so-called Big Four commercial banks in Ireland. AIB offers a full range of personal and corporate banking services. AIB Capital Markets is the division of the company that offers international banking and treasury operations. The bank also offers a range of general insurance products such as home, travel, and health insurance. It offers life assurance and pensions through its tied agency with Irish Life Assurance plc.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/allied-irish-bank.jpeg", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"Accounts,API Provider,ATMs,Banking,General Data,Loans,Profiles,Relative Data,UK Banks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"allied-irish-bank/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Allied Irish Bank Account APIs", "x-api-slug"=>"allied-irish-bank-account-apis", "description"=>"Allied Irish Banks (AIB) is one of the so-called Big Four commercial banks in Ireland. AIB offers a full range of personal and corporate banking services. AIB Capital Markets is the division of the company that offers international banking and treasury operations. The bank also offers a range of general insurance products such as home, travel, and health insurance. It offers life assurance and pensions through its tied agency with Irish Life Assurance plc.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/allied-irish-bank.jpeg", "humanURL"=>"https://aibgb.co.uk/", "baseURL"=>"https:////open-banking/v1.1", "tags"=>"Accounts,API Provider,ATMs,Banking,General Data,Loans,Profiles,Relative Data,UK Banks", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/allied-irish-bank/allied-irish-bank-account-apis-openapi.yaml"}]}, {"name"=>"Allied Irish Bank Payment APIs", "x-api-slug"=>"allied-irish-bank-payment-apis", "description"=>"Allied Irish Banks (AIB) is one of the so-called Big Four commercial banks in Ireland. AIB offers a full range of personal and corporate banking services. AIB Capital Markets is the division of the company that offers international banking and treasury operations. The bank also offers a range of general insurance products such as home, travel, and health insurance. It offers life assurance and pensions through its tied agency with Irish Life Assurance plc.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/allied-irish-bank.jpeg", "humanURL"=>"https://aibgb.co.uk/", "baseURL"=>"https:////open-banking/v1.1", "tags"=>"Banking,Products", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/allied-irish-bank/allied-irish-bank-payment-apis-openapi.yaml"}]}, {"name"=>"Allied Irish Bank Public APIs", "x-api-slug"=>"allied-irish-bank-public-apis", "description"=>"Allied Irish Banks (AIB) is one of the so-called Big Four commercial banks in Ireland. AIB offers a full range of personal and corporate banking services. AIB Capital Markets is the division of the company that offers international banking and treasury operations. The bank also offers a range of general insurance products such as home, travel, and health insurance. It offers life assurance and pensions through its tied agency with Irish Life Assurance plc.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/allied-irish-bank.jpeg", "humanURL"=>"https://aibgb.co.uk/", "baseURL"=>"https://openapi.aibgb.co.uk/open-banking/v2.1/", "tags"=>"Banking, Payments, Submissions", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/allied-irish-bank/unsecuredsmeloans-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/allied-irish-bank/allied-irish-bank-public-apis-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"http://openbankingapis.io/Allied-Irish-Bank"}, {"type"=>"x-documentation", "url"=>"https://openbanking.atlassian.net/wiki/spaces/DZ/pages/54919225/Open+Data+API+Dashboard#"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/AIBGB"}, {"type"=>"x-website", "url"=>"https://aibgb.co.uk/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "allied-irish-bank-public-apis-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Allied Irish Bank", "x-complete"=>1, "info"=>{"title"=>"Allied Irish Bank", "description"=>"this-is-an-openapi-definition-for-the-standard-set-of-open-banking-httpopenbankingapis-io-apis-covering-the-allied-irish-bank-apis-", "termsOfService"=>"https://www.openbanking.org.uk/open-licence/", "contact"=>{"name"=>"API Evangelist", "url"=>"https://apievangelist.com", "email"=>"info@apievangelist.com"}, "version"=>"1.0.0"}, "host"=>"openapi.aibgb.co.uk", "basePath"=>"open-banking/v2.1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"business-current-accounts/"=>{"get"=>{"summary"=>"Get Current Business Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple BCA products.", "operationId"=>"getCurentBusinessAccounts", "x-api-path-slug"=>"businesscurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "Business", "Accounts"]}}, "unsecured-sme-loans/"=>{"get"=>{"summary"=>"Get Unsecured SME Loans", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Unsecured Loan products.", "operationId"=>"pathOperation", "x-api-path-slug"=>"unsecuredsmeloans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsecured", "SME", "Loans"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
digitalocean{"digital-ocean-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DigitalOcean", "x-complete"=>1, "info"=>{"title"=>"DigitalOcean API-V2", "description"=>"-api-v2-introductionwelcome-to-the-digitalocean-api-documentation-the-digitalocean-api-allows-you-to-manage-droplets-and-resources-within-the-digitalocean-cloud-in-a-simple-programmatic-way-using-conventional-http-requests--the-endpoints-are-intuitive-and-powerful-allowing-you-to-easily-make-calls-to-retrieve-information-or-to-execute-actions-all-of-the-functionality-that-you-are-familiar-with-in-the-digitalocean-control-panel-is-also-available-through-the-api-allowing-you-to-script-the-complex-actions-that-your-situation-requires-the-api-documentation-will-start-with-a-general-overview-about-the-design-and-technology-that-has-been-implemented-followed-by-reference-information-about-specific-endpoints-requestsany-tool-that-is-fluent-in-http-can-communicate-with-the-api-simply-by-requesting-the-correct-uri--requests-should-be-made-using-the-https-protocol-so-that-traffic-is-encrypted--the-interface-responds-to-different-methods-depending-on-the-action-required-methodusagegetfor-simple-retrieval-of-information-about-your-account-droplets-or-environment-you-should-use-the-get-method--the-information-you-request-will-be-returned-to-you-as-a-json-object-the-attributes-defined-by-the-json-object-can-be-used-to-form-additional-requests--any-request-using-the-get-method-is-readonly-and-will-not-affect-any-of-the-objects-you-are-querying-deleteto-destroy-a-resource-and-remove-it-from-your-account-and-environment-the-delete-method-should-be-used--this-will-remove-the-specified-object-if-it-is-found--if-it-is-not-found-the-operation-will-return-a-response-indicating-that-the-object-was-not-found-this-idempotency-means-that-you-do-not-have-to-check-for-a-resources-availability-prior-to-issuing-a-delete-command-the-final-state-will-be-the-same-regardless-of-its-existence-putto-update-the-information-about-a-resource-in-your-account-the-put-method-is-available-like-the-delete-method-the-put-method-is-idempotent--it-sets-the-state-of-the-target-using-the-provided-values-regardless-of-their-current-values--requests-using-the-put-method-do-not-need-to-check-the-current-attributes-of-the-object-postto-create-a-new-object-your-request-should-specify-the-post-method-the-post-request-includes-all-of-the-attributes-necessary-to-create-a-new-object--when-you-wish-to-create-a-new-object-send-a-post-request-to-the-target-endpoint-headfinally-to-retrieve-metadata-information-you-should-use-the-head-method-to-get-the-headers--this-returns-only-the-header-of-what-would-be-returned-with-an-associated-get-request-response-headers-contain-some-useful-information-about-your-api-access-and-the-results-that-are-available-for-your-request-for-instance-the-headers-contain-your-current-ratelimit-value-and-the-amount-of-time-available-until-the-limit-resets--it-also-contains-metrics-about-the-total-number-of-objects-found-pagination-information-and-the-total-content-length-", "version"=>"1.0.0"}, "host"=>"example.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/account"=>{"get"=>{"summary"=>"Get User Information", "description"=>"Get [DigitalOcean](https://www.digitalocean.com/) account", "operationId"=>"AccountGet", "x-api-path-slug"=>"account-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Information"]}}, "/certificates"=>{"get"=>{"summary"=>"List all certificates", "description"=>"To list all of the certificates available on your account, send a GET request to /v2/certificates.\r\n\r\nThe result will be a JSON object with a certificates key. This will be set to an array of certificate objects, each of which will contain the standard certificate attributes:", "operationId"=>"CertificatesGet", "x-api-path-slug"=>"certificates-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Certificates"]}, "post"=>{"summary"=>"Create a new certificate", "description"=>"To upload or create a new SSL certificate, send a POST request to /v2/certificates. When uploading a user-generated certificate, the private_key, leaf_certificate, and optionally the certificate_chain attributes should be provided. The type should be set to \"custom\". When generating a certificate using Let's Encrypt, the dns_names attribute must be provided, and the type should be set to \"lets_encrypt\".", "operationId"=>"CertificatesPost", "x-api-path-slug"=>"certificates-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Certificate"]}}, "/certificates/892071a0-bb95-49bc-8021-3afd67a210bf"=>{"get"=>{"summary"=>"Retrieve an existing certificate", "description"=>"To show information about an existing certificate, send a GET request to /v2/certificates/$CERTIFICATE_ID.\r\n\r\nThe response will be a JSON object with a certificate key.", "operationId"=>"Certificates892071a0Bb9549bc80213afd67a210bfGet", "x-api-path-slug"=>"certificates892071a0bb9549bc80213afd67a210bf-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Existing", "Certificate"]}, "delete"=>{"summary"=>"Delete a certificate", "description"=>"To delete a specific certificate, send a DELETE request to /v2/certificates/$CERTIFICATE_ID.\r\n\r\nA status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.", "operationId"=>"Certificates892071a0Bb9549bc80213afd67a210bfDelete", "x-api-path-slug"=>"certificates892071a0bb9549bc80213afd67a210bf-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate"]}}, "/domains"=>{"get"=>{"summary"=>"List all Domains", "description"=>"To retrieve a list of all of the domains in your account, send a GET request to /v2/domains.\r\n\r\nThe response will be a JSON object with a key called domains.", "operationId"=>"DomainsGet", "x-api-path-slug"=>"domains-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Domains"]}}, "/droplets"=>{"get"=>{"summary"=>"Listing Droplets by Tag", "description"=>"To list Droplets by a tag, send a GET request to /v2/droplets?tag_name=$TAG_NAME.\r\n\r\nThe response will match that of regular droplet listing request but will be filtered to only include the tagged Droplets.", "operationId"=>"DropletsGet2", "x-api-path-slug"=>"droplets-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"tag_name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listing", "Droplets", "By", "Tag"]}, "post"=>{"summary"=>"Create a new Droplet", "description"=>"To create a new Droplet, send a POST request to /v2/droplets.", "operationId"=>"DropletsPost", "x-api-path-slug"=>"droplets-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Droplet"]}}, "/images/63261821"=>{"get"=>{"summary"=>"Retrieve an existing Image by id", "description"=>"To retrieve information about an image (public or private), send a GET request to /v2/images/$IMAGE_ID.\r\n\r\nThe response will be a JSON object with a key called image. The value of this will be an image object containing the standard image attributes:", "operationId"=>"Images63261821Get", "x-api-path-slug"=>"images63261821-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Existing", "Image", "By", "Id"]}, "delete"=>{"summary"=>"Delete an Image", "description"=>"To delete an image, send a DELETE request to /v2/images/$IMAGE_ID.\r\n\r\nA status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed", "operationId"=>"Images63261821Delete", "x-api-path-slug"=>"images63261821-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image"]}}, "/regions"=>{"get"=>{"summary"=>"List all Regions", "description"=>"To list all of the regions that are available, send a GET request to /v2/regions.\r\n\r\nThe response will be a JSON object with a key called _regions_.", "operationId"=>"RegionsGet", "x-api-path-slug"=>"regions-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Regions"]}}, "/snapshots"=>{"get"=>{"summary"=>"List all Volume snapshots", "description"=>"To retrieve only snapshots based on volumes, include the resource_type query paramter set to volume, /v2/snapshots?resource_type=volume.", "operationId"=>"SnapshotsGet3", "x-api-path-slug"=>"snapshots-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}, {"in"=>"query", "name"=>"resource_type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Volume", "Snapshots"]}}, "/sizes"=>{"get"=>{"summary"=>"List all Sizes", "description"=>"To list all of the sizes, send a GET request to /v2/sizes.\r\n\r\nThe response will be a JSON object with a key called _sizes_.", "operationId"=>"SizesGet", "x-api-path-slug"=>"sizes-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Sizes"]}}, "/account/keys"=>{"get"=>{"summary"=>"List all Keys", "description"=>"To list all of the keys in your account, send a GET request to /v2/account/keys.\r\n\r\nThe response will be a JSON object with a key set to _ssh_keys_.", "operationId"=>"AccountKeysGet", "x-api-path-slug"=>"accountkeys-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Keys"]}, "post"=>{"summary"=>"Create a new Key", "description"=>"To add a new SSH public key to your DigitalOcean account, send a POST request to /v2/account/keys. Set the \"name\" attribute to the name you wish to use and the \"public_key\" attribute to a string of the full public key you are adding.\n\nThe response body will be a JSON object with a key set to ssh_key. The value will be the complete generated key object. This will have the standard key attributes:\n\nName\tType\tDescription\nid\tinteger\tThis is a unique identification number for the key. This can be used to reference a specific SSH key when you wish to embed a key into a Droplet.\nfingerprint\tstring\tThis attribute contains the fingerprint value that is generated from the public key. This is a unique identifier that will differentiate it from other keys using a format that SSH recognizes.\npublic_key\tstring\tThis attribute contains the entire public key string that was uploaded. This is what is embedded into the root user's authorized_keys file if you choose to include this SSH key during Droplet creation.\nname\tstring\tThis is the human-readable display name for the given SSH key. This is used to easily identify the SSH keys when they are displayed.", "operationId"=>"AccountKeysPost", "x-api-path-slug"=>"accountkeys-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Key"]}}, "/account/keys/22162952"=>{"get"=>{"summary"=>"Retrieve an existing Key", "description"=>"To show information about a key, send a GET request to /v2/account/keys/$KEY_ID or /v2/account/keys/$KEY_FINGERPRINT.\r\n\r\nThe response will be a JSON object with a key called _ssh_key_.", "operationId"=>"AccountKeys22162952Get", "x-api-path-slug"=>"accountkeys22162952-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Existing", "Key"]}, "put"=>{"summary"=>"Update a Key", "description"=>"To update the name of an SSH key, send a PUT request to either /v2/account/keys/$SSH_KEY_ID or /v2/account/keys/$SSH_KEY_FINGERPRINT. Set the \"name\" attribute to the new name you want to use.", "operationId"=>"AccountKeys22162952Put", "x-api-path-slug"=>"accountkeys22162952-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key"]}, "delete"=>{"summary"=>"Destroy a Key", "description"=>"To destroy a public SSH key that you have in your account, send a DELETE request to /v2/account/keys/$KEY_ID or /v2/account/keys/$KEY_FINGERPRINT.\r\n\r\nA 204 status will be returned, indicating that the action was successful and that the response body is empty.", "operationId"=>"AccountKeys22162952Delete", "x-api-path-slug"=>"accountkeys22162952-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Destroy", "Key"]}}, "/tags"=>{"get"=>{"summary"=>"List all Tags", "description"=>"To list all of your tags, you can send a GET request to /v2/tags.\r\n\r\nThe response will be a JSON object with a key called _tags_.", "operationId"=>"TagsGet", "x-api-path-slug"=>"tags-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Tags"]}, "post"=>{"summary"=>"Create a new Tag", "description"=>"To create a Tag you can send a POST request to /v2/tags with a name attribute.\r\n\r\nThe response will be a JSON object with a key called _tag_.", "operationId"=>"TagsPost", "x-api-path-slug"=>"tags-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Tag"]}}, "/tags/postman-do-tag/resources"=>{"post"=>{"summary"=>"Tag a Resource", "description"=>"Resources can be tagged by sending a POST request to /v2/tags/$TAG_NAME/resources with an array of json objects containing resource_id and resource_type attributes.\r\n\r\nCurrently only tagging of Droplets is supported. resource_id is expected to be the Droplet's id attribute as a string, and resource_type is expected to be the string droplet.", "operationId"=>"TagsPostmanDoTagResourcesPost", "x-api-path-slug"=>"tagspostmandotagresources-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tag", "Resource"]}}}}, "apis"=>{"name"=>"DigitalOcean", "x-slug"=>"digitalocean", "description"=>"DigitalOcean is a simple and fast cloud hosting service built for developers. Customers can create a cloud server in 55 seconds, and pricing plans start at only $5 per month for 512MB of RAM, 20GB SSD, 1 CPU, and 1TB Transfer. Featuring a 99.99% Uptime SLA, DigitalOcean has servers located in New York, San Francisco, and Amsterdam. The DigitalOcean control panel interface is simple and intuitive, which power users can replicate on a larger scale with the company’s API. DigitalOcean uses KVM virtualization and additionally hosts a library of helpful walkthroughs and tutorials that cover server configuration and optimization.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/DO_Logo_Horizontal_Black-3500c326.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Cloud,Compute,Hosting,Profiles,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"digitalocean/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Digital Ocean", "x-api-slug"=>"digital-ocean", "description"=>"Digital Ocean is a cloud server and cloud hosting service. Digital Ocean offers developers a service to manage and control their virtual servers and SSD cloud servers in the cloud. The Digital Ocean API allows developers to access and integrate the functionality of Digital Ocean with other applications. Some example API methods include managing domains, managing files, and managing account and server information.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/DO_Logo_Horizontal_Black-3500c326.png", "humanURL"=>"https://www.digitalocean.com", "baseURL"=>"https://example.com//", "tags"=>"API Provider,API Service Provider,Cloud,Compute,Hosting,Profiles,Relative Data,Service API", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/digitalocean/digital-ocean-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.digitalocean.com/"}, {"type"=>"x-blog", "url"=>"https://www.digitalocean.com/company/blog/"}, {"type"=>"x-blog-rss", "url"=>"https://www.digitalocean.com/company/blog/feed.xml"}, {"type"=>"x-command-line-interface", "url"=>"https://github.com/digitalocean/doctl"}, {"type"=>"x-developer", "url"=>"https://developers.digitalocean.com/"}, {"type"=>"x-github", "url"=>"https://github.com/digitalocean"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/digitalocean"}, {"type"=>"x-website", "url"=>"https://www.digitalocean.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-batch{"azure-batch-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Batch", "x-complete"=>1, "info"=>{"title"=>"BatchManagement", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}"=>{"put"=>{"summary"=>"Batch Account Create", "description"=>"Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.", "operationId"=>"BatchAccount_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccountsaccountname-put", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"A name for the Batch account which must be unique within the region"}, {"in"=>"body", "name"=>"parameters", "description"=>"Additional parameters for account creation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the new Batch account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch Account"]}, "patch"=>{"summary"=>"Batch Account Update", "description"=>"Updates the properties of an existing Batch account.", "operationId"=>"BatchAccount_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccountsaccountname-patch", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the account"}, {"in"=>"body", "name"=>"parameters", "description"=>"Additional parameters for account update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the Batch account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch Account"]}, "delete"=>{"summary"=>"Batch Account Delete", "description"=>"Deletes the specified Batch account.", "operationId"=>"BatchAccount_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccountsaccountname-delete", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the account to be deleted"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the Batch account to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch Account"]}, "get"=>{"summary"=>"Batch Account Get", "description"=>"Gets information about the specified Batch account.", "operationId"=>"BatchAccount_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccountsaccountname-get", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the account"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the Batch account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch Account"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts"=>{"get"=>{"summary"=>"Batch Account List", "description"=>"Gets information about the Batch accounts associated with the subscription.", "operationId"=>"BatchAccount_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-batchbatchaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts"=>{"get"=>{"summary"=>"Batch Account List By Resource Group", "description"=>"Gets information about the Batch accounts associated within the specified resource group.", "operationId"=>"BatchAccount_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccounts-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group whose Batch accounts to list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/syncAutoStorageKeys"=>{"post"=>{"summary"=>"Batch Account Synchronize Auto Storage Keys", "description"=>"Synchronizes access keys for the auto storage account configured for the specified Batch account.", "operationId"=>"BatchAccount_SynchronizeAutoStorageKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccountsaccountnamesyncautostoragekeys-post", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Batch account"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the Batch account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys"=>{"post"=>{"summary"=>"Batch Account Regenerate Key", "description"=>"Regenerates the specified account key for the Batch account.", "operationId"=>"BatchAccount_RegenerateKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccountsaccountnameregeneratekeys-post", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the account"}, {"in"=>"body", "name"=>"parameters", "description"=>"The type of key to regenerate", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the Batch account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/listKeys"=>{"post"=>{"summary"=>"Gets the account keys for the specified Batch account.", "description"=>"This operation applies only to Batch accounts created with a poolAllocationMode of 'BatchService'. If the Batch account was created with a poolAllocationMode of 'UserSubscription', clients cannot use access to keys to authenticate, and must use Azure Active Directory instead. In this case, getting the keys will fail.", "operationId"=>"BatchAccount_GetKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccountsaccountnamelistkeys-post", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the account"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the Batch account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account Key"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationId}/versions/{version}/activate"=>{"post"=>{"summary"=>"Application Package Activate", "description"=>"Activates the specified application package.", "operationId"=>"ApplicationPackage_Activate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccountsaccountnameapplicationsapplicationidversionsversionactivate-post", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Batch account"}, {"in"=>"path", "name"=>"applicationId", "description"=>"The ID of the application"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the Batch account"}, {"in"=>"path", "name"=>"version", "description"=>"The version of the application to activate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Package"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationId}"=>{"put"=>{"summary"=>"Application Create", "description"=>"Adds an application to the specified Batch account.", "operationId"=>"Application_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccountsaccountnameapplicationsapplicationid-put", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Batch account"}, {"in"=>"path", "name"=>"applicationId", "description"=>"The ID of the application"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the Batch account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}, "delete"=>{"summary"=>"Application Delete", "description"=>"Deletes an application.", "operationId"=>"Application_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccountsaccountnameapplicationsapplicationid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Batch account"}, {"in"=>"path", "name"=>"applicationId", "description"=>"The ID of the application"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the Batch account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}, "get"=>{"summary"=>"Application Get", "description"=>"Gets information about the specified application.", "operationId"=>"Application_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccountsaccountnameapplicationsapplicationid-get", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Batch account"}, {"in"=>"path", "name"=>"applicationId", "description"=>"The ID of the application"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the Batch account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}, "patch"=>{"summary"=>"Application Update", "description"=>"Updates settings for the specified application.", "operationId"=>"Application_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccountsaccountnameapplicationsapplicationid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Batch account"}, {"in"=>"path", "name"=>"applicationId", "description"=>"The ID of the application"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the Batch account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationId}/versions/{version}"=>{"put"=>{"summary"=>"Application Package Create", "description"=>"Creates an application package record.", "operationId"=>"ApplicationPackage_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccountsaccountnameapplicationsapplicationidversionsversion-put", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Batch account"}, {"in"=>"path", "name"=>"applicationId", "description"=>"The ID of the application"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the Batch account"}, {"in"=>"path", "name"=>"version", "description"=>"The version of the application"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Package"]}, "delete"=>{"summary"=>"Application Package Delete", "description"=>"Deletes an application package record and its associated binary file.", "operationId"=>"ApplicationPackage_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccountsaccountnameapplicationsapplicationidversionsversion-delete", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Batch account"}, {"in"=>"path", "name"=>"applicationId", "description"=>"The ID of the application"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the Batch account"}, {"in"=>"path", "name"=>"version", "description"=>"The version of the application to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Package"]}, "get"=>{"summary"=>"Application Package Get", "description"=>"Gets information about the specified application package.", "operationId"=>"ApplicationPackage_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccountsaccountnameapplicationsapplicationidversionsversion-get", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Batch account"}, {"in"=>"path", "name"=>"applicationId", "description"=>"The ID of the application"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the Batch account"}, {"in"=>"path", "name"=>"version", "description"=>"The version of the application"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Package"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications"=>{"get"=>{"summary"=>"Application List", "description"=>"Lists all of the applications in the specified account.", "operationId"=>"Application_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-batchbatchaccountsaccountnameapplications-get", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Batch account"}, {"in"=>"query", "name"=>"maxresults", "description"=>"The maximum number of items to return in the response"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the Batch account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/quotas"=>{"get"=>{"summary"=>"Location Get Quotas", "description"=>"Gets the Batch service quotas for the specified subscription at the given location.", "operationId"=>"Location_GetQuotas", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-batchlocationslocationnamequotas-get", "parameters"=>[{"in"=>"path", "name"=>"locationName", "description"=>"The desired region for the quotas"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Location Quotas"]}}}}, "apis"=>{"name"=>"Azure Batch", "x-slug"=>"azure-batch", "description"=>"Batch processing began with mainframe computers and punch cards. Today, it still plays a central role in business, engineering, science, and other areas that require running lots of automated tasks—processing bills and payroll, calculating portfolio risk, designing new products, rendering animated films, testing software, searching for energy, predicting the weather, and finding new cures for disease. Previously, few people had access to the computing power for these scenarios. With Azure Batch, that power is available to you when you need it, without any capital investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-batch-100x-scale.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Batch,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-batch/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Batch API", "x-api-slug"=>"azure-batch-api", "description"=>"Batch processing began with mainframe computers and punch cards. Today, it still plays a central role in business, engineering, science, and other areas that require running lots of automated tasks—processing bills and payroll, calculating portfolio risk, designing new products, rendering animated films, testing software, searching for energy, predicting the weather, and finding new cures for disease. Previously, few people had access to the computing power for these scenarios. With Azure Batch, that power is available to you when you need it, without any capital investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-batch-100x-scale.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/batch/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Batch,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-batch/subscriptionssubscriptionidprovidersmicrosoft-batchlocationslocationnamequotas-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-batch/azure-batch-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/batch/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/batch/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/batch/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/batch/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-cloudhsm{"aws-cloudhsm-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS CloudHSM", "x-complete"=>1, "info"=>{"title"=>"AWS CloudHSM API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddTagsToResource"=>{"get"=>{"summary"=>"Add Tags To Resource", "description"=>"Adds or overwrites one or more tags for the specified AWS CloudHSM resource.", "operationId"=>"addTagsToResource", "x-api-path-slug"=>"actionaddtagstoresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceArn", "description"=>"The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag", "type"=>"string"}, {"in"=>"query", "name"=>"TagList", "description"=>"One or more tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=CreateHapg"=>{"get"=>{"summary"=>"Create Hapg", "description"=>"Creates a high-availability partition group.", "operationId"=>"createHapg", "x-api-path-slug"=>"actioncreatehapg-get", "parameters"=>[{"in"=>"query", "name"=>"Label", "description"=>"The label of the new high-availability partition group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["High-Availability Partition Group"]}}, "/?Action=CreateHsm"=>{"get"=>{"summary"=>"Create HSM", "description"=>"Creates an uninitialized HSM instance.", "operationId"=>"createHsm", "x-api-path-slug"=>"actioncreatehsm-get", "parameters"=>[{"in"=>"query", "name"=>"ClientToken", "description"=>"A user-defined token to ensure idempotence", "type"=>"string"}, {"in"=>"query", "name"=>"EniIp", "description"=>"The IP address to assign to the HSMs ENI", "type"=>"string"}, {"in"=>"query", "name"=>"ExternalId", "description"=>"The external ID from IamRoleArn, if present", "type"=>"string"}, {"in"=>"query", "name"=>"IamRoleArn", "description"=>"The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf", "type"=>"string"}, {"in"=>"query", "name"=>"SshKey", "description"=>"The SSH public key to install on the HSM", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetId", "description"=>"The identifier of the subnet in your VPC in which to place the HSM", "type"=>"string"}, {"in"=>"query", "name"=>"SubscriptionType", "description"=>"Specifies the type of subscription for the HSM", "type"=>"string"}, {"in"=>"query", "name"=>"SyslogIp", "description"=>"The IP address for the syslog monitoring server", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["HSM Instances"]}}, "/?Action=CreateLunaClient"=>{"get"=>{"summary"=>"Create Luna Client", "description"=>"Creates an HSM client.", "operationId"=>"createLunaClient", "x-api-path-slug"=>"actioncreatelunaclient-get", "parameters"=>[{"in"=>"query", "name"=>"Certificate", "description"=>"The contents of a Base64-Encoded X", "type"=>"string"}, {"in"=>"query", "name"=>"Label", "description"=>"The label for the client", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Luna Clients"]}}, "/?Action=DeleteHapg"=>{"get"=>{"summary"=>"Delete HAPG", "description"=>"Deletes a high-availability partition group.", "operationId"=>"deleteHapg", "x-api-path-slug"=>"actiondeletehapg-get", "parameters"=>[{"in"=>"query", "name"=>"HapgArn", "description"=>"The ARN of the high-availability partition group to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["High-Availability Partition Group"]}}, "/?Action=DeleteHsm"=>{"get"=>{"summary"=>"Delete HSM", "description"=>"Deletes an HSM.", "operationId"=>"deleteHsm", "x-api-path-slug"=>"actiondeletehsm-get", "parameters"=>[{"in"=>"query", "name"=>"HsmArn", "description"=>"The ARN of the HSM to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["HSM Instances"]}}, "/?Action=DeleteLunaClient"=>{"get"=>{"summary"=>"Delete Luna Client", "description"=>"Deletes a client.", "operationId"=>"deleteLunaClient", "x-api-path-slug"=>"actiondeletelunaclient-get", "parameters"=>[{"in"=>"query", "name"=>"ClientArn", "description"=>"The ARN of the client to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Luna Clients"]}}, "/?Action=DescribeHapg"=>{"get"=>{"summary"=>"Describe HAPG", "description"=>"Retrieves information about a high-availability partition group.", "operationId"=>"describeHapg", "x-api-path-slug"=>"actiondescribehapg-get", "parameters"=>[{"in"=>"query", "name"=>"HapgArn", "description"=>"The ARN of the high-availability partition group to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["High-Availability Partition Group"]}}, "/?Action=DescribeHsm"=>{"get"=>{"summary"=>"Describe HSM", "description"=>"Retrieves information about an HSM.", "operationId"=>"describeHsm", "x-api-path-slug"=>"actiondescribehsm-get", "parameters"=>[{"in"=>"query", "name"=>"HsmArn", "description"=>"The ARN of the HSM", "type"=>"string"}, {"in"=>"query", "name"=>"HsmSerialNumber", "description"=>"The serial number of the HSM", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["HSM Instances"]}}, "/?Action=DescribeLunaClient"=>{"get"=>{"summary"=>"Describe Luna Client", "description"=>"Retrieves information about an HSM client.", "operationId"=>"describeLunaClient", "x-api-path-slug"=>"actiondescribelunaclient-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateFingerprint", "description"=>"The certificate fingerprint", "type"=>"string"}, {"in"=>"query", "name"=>"ClientArn", "description"=>"The ARN of the client", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Luna Clients"]}}, "/?Action=GetConfig"=>{"get"=>{"summary"=>"Get Config", "description"=>"Gets the configuration files necessary to connect to all high availability partition\n groups the client is associated with.", "operationId"=>"getConfig", "x-api-path-slug"=>"actiongetconfig-get", "parameters"=>[{"in"=>"query", "name"=>"ClientArn", "description"=>"The ARN of the client", "type"=>"string"}, {"in"=>"query", "name"=>"ClientVersion", "description"=>"The client version", "type"=>"string"}, {"in"=>"query", "name"=>"HapgList", "description"=>"A list of ARNs that identify the high-availability partition groups that are associated with the client", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Config"]}}, "/?Action=ListAvailableZones"=>{"get"=>{"summary"=>"List Available Zones", "description"=>"Lists the Availability Zones that have available AWS CloudHSM capacity.", "operationId"=>"listAvailableZones", "x-api-path-slug"=>"actionlistavailablezones-get", "parameters"=>[{"in"=>"query", "name"=>"AZList", "description"=>"The list of Availability Zones that have available AWS CloudHSM capacity", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones"]}}, "/?Action=ListHapgs"=>{"get"=>{"summary"=>"List HAPG", "description"=>"Lists the high-availability partition groups for the account.", "operationId"=>"listHapgs", "x-api-path-slug"=>"actionlisthapgs-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"The NextToken value from a previous call to ListHapgs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["High-Availability Partition Group"]}}, "/?Action=ListHsms"=>{"get"=>{"summary"=>"List HSM", "description"=>"Retrieves the identifiers of all of the HSMs provisioned for the current\n customer.", "operationId"=>"listHsms", "x-api-path-slug"=>"actionlisthsms-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"The NextToken value from a previous call to ListHsms", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["HSM Instances"]}}, "/?Action=ListLunaClients"=>{"get"=>{"summary"=>"List Luna Clients", "description"=>"Lists all of the clients.", "operationId"=>"listLunaClients", "x-api-path-slug"=>"actionlistlunaclients-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"The NextToken value from a previous call to ListLunaClients", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Luna Clients"]}}, "/?Action=ListTagsForResource"=>{"get"=>{"summary"=>"List Tags For Resource", "description"=>"Returns a list of all tags for the specified AWS CloudHSM resource.", "operationId"=>"listTagsForResource", "x-api-path-slug"=>"actionlisttagsforresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceArn", "description"=>"The Amazon Resource Name (ARN) of the AWS CloudHSM resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=ModifyHapg"=>{"get"=>{"summary"=>"Modify HAPG", "description"=>"Modifies an existing high-availability partition group.", "operationId"=>"modifyHapg", "x-api-path-slug"=>"actionmodifyhapg-get", "parameters"=>[{"in"=>"query", "name"=>"HapgArn", "description"=>"The ARN of the high-availability partition group to modify", "type"=>"string"}, {"in"=>"query", "name"=>"Label", "description"=>"The new label for the high-availability partition group", "type"=>"string"}, {"in"=>"query", "name"=>"PartitionSerialList", "description"=>"The list of partition serial numbers to make members of the high-availability partition group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["High-Availability Partition Group"]}}, "/?Action=ModifyHsm"=>{"get"=>{"summary"=>"Modify HSM", "description"=>"Modifies an HSM.", "operationId"=>"modifyHsm", "x-api-path-slug"=>"actionmodifyhsm-get", "parameters"=>[{"in"=>"query", "name"=>"EniIp", "description"=>"The new IP address for the elastic network interface (ENI) attached to the HSM", "type"=>"string"}, {"in"=>"query", "name"=>"ExternalId", "description"=>"The new external ID", "type"=>"string"}, {"in"=>"query", "name"=>"HsmArn", "description"=>"The ARN of the HSM to modify", "type"=>"string"}, {"in"=>"query", "name"=>"IamRoleArn", "description"=>"The new IAM role ARN", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetId", "description"=>"The new identifier of the subnet that the HSM is in", "type"=>"string"}, {"in"=>"query", "name"=>"SyslogIp", "description"=>"The new IP address for the syslog monitoring server", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["HSM Instances"]}}, "/?Action=ModifyLunaClient"=>{"get"=>{"summary"=>"Modify Luna Client", "description"=>"Modifies the certificate used by the client.", "operationId"=>"modifyLunaClient", "x-api-path-slug"=>"actionmodifylunaclient-get", "parameters"=>[{"in"=>"query", "name"=>"Certificate", "description"=>"The new certificate for the client", "type"=>"string"}, {"in"=>"query", "name"=>"ClientArn", "description"=>"The ARN of the client", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Luna Clients"]}}, "/?Action=RemoveTagsFromResource"=>{"get"=>{"summary"=>"Remove Tags From Resource", "description"=>"Removes one or more tags from the specified AWS CloudHSM resource.", "operationId"=>"removeTagsFromResource", "x-api-path-slug"=>"actionremovetagsfromresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceArn", "description"=>"The Amazon Resource Name (ARN) of the AWS CloudHSM resource", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeyList", "description"=>"The tag key or keys to remove", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}}}, "apis"=>{"name"=>"AWS CloudHSM", "x-slug"=>"aws-cloudhsm", "description"=>"The AWS CloudHSM service helps you meet corporate, contractual and regulatory compliance requirements for data security by using dedicated Hardware Security Module (HSM) appliances within the AWS cloud. With CloudHSM, you control the encryption keys and cryptographic operations performed by the HSM.AWS and AWS Marketplace partners offer a variety of solutions for protecting sensitive data within the AWS platform, but for applications and data subject to rigorous contractual or regulatory requirements for managing cryptographic keys, additional protection is sometimes necessary. Until now, your only option was to store the sensitive data (or the encryption keys protecting the sensitive data) in your on-premises datacenters. Unfortunately, this either prevented you from migrating these applications to the cloud or significantly slowed their performance. The AWS CloudHSM service allows you to protect your encryption keys within HSMs designed and validated to government standards for secure key management. You can securely generate, store, and manage the cryptographic keys used for data encryption such that they are accessible only by you. AWS CloudHSM helps you comply with strict key management requirements without sacrificing application performance.The AWS CloudHSM service works with Amazon Virtual Private Cloud (VPC). CloudHSM instances are provisioned inside your VPC with an IP address that you specify, providing simple and private network connectivity to your Amazon Elastic Compute Cloud (EC2) instances. Placing CloudHSM instances near your EC2 instances decreases network latency, which can improve application performance. AWS provides dedicated and exclusive (single tenant) access to CloudHSM instances, isolated from other AWS customers. Available in multiple Regions and Availability Zones (AZs), AWS CloudHSM allows you to add secure and durable key storage to your applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Security-Identity_AWSCloudHSM.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Contracts,Encryption,Management,Profiles,Regulations,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-cloudhsm/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS CloudHSM API", "x-api-slug"=>"aws-cloudhsm-api", "description"=>"The AWS CloudHSM service helps you meet corporate, contractual and regulatory compliance requirements for data security by using dedicated Hardware Security Module (HSM) appliances within the AWS cloud. With CloudHSM, you control the encryption keys and cryptographic operations performed by the HSM.AWS and AWS Marketplace partners offer a variety of solutions for protecting sensitive data within the AWS platform, but for applications and data subject to rigorous contractual or regulatory requirements for managing cryptographic keys, additional protection is sometimes necessary. Until now, your only option was to store the sensitive data (or the encryption keys protecting the sensitive data) in your on-premises datacenters. Unfortunately, this either prevented you from migrating these applications to the cloud or significantly slowed their performance. The AWS CloudHSM service allows you to protect your encryption keys within HSMs designed and validated to government standards for secure key management. You can securely generate, store, and manage the cryptographic keys used for data encryption such that they are accessible only by you. AWS CloudHSM helps you comply with strict key management requirements without sacrificing application performance.The AWS CloudHSM service works with Amazon Virtual Private Cloud (VPC). CloudHSM instances are provisioned inside your VPC with an IP address that you specify, providing simple and private network connectivity to your Amazon Elastic Compute Cloud (EC2) instances. Placing CloudHSM instances near your EC2 instances decreases network latency, which can improve application performance. AWS provides dedicated and exclusive (single tenant) access to CloudHSM instances, isolated from other AWS customers. Available in multiple Regions and Availability Zones (AZs), AWS CloudHSM allows you to add secure and durable key storage to your applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Security-Identity_AWSCloudHSM.png", "humanURL"=>"https://aws.amazon.com/cloudhsm/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Contracts,Encryption,Management,Profiles,Regulations,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-cloudhsm/aws-cloudhsm-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/cloudhsm/latest/dg/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/cloudhsm/faqs/"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=156"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/cloudhsm/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/cloudhsm/pricing/"}, {"type"=>"x-release-notes", "url"=>"http://aws.amazon.com/releasenotes/AWS-CloudHSM/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/cloudhsm/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
getty-images{"getty-images-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Getty Images", "x-complete"=>1, "info"=>{"title"=>"Getty Images", "description"=>"build-applications-using-the-worlds-most-powerful-imagery", "version"=>"1.0.0"}, "host"=>"api.gettyimages.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v3/artists/images"=>{"get"=>{"summary"=>"Search Artist Images", "description"=>"Search for images by a photographer", "operationId"=>"Artists_GetImagesByArtist", "x-api-path-slug"=>"v3artistsimages-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"query", "name"=>"artist_name", "description"=>"Name of artist for desired images"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"Comma separated list of fields"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Artists"]}}, "/v3/artists/videos"=>{"get"=>{"summary"=>"Search Artist ImaVideosges", "description"=>"Search for videos by a photographer", "operationId"=>"Artists_GetVideosByArtist", "x-api-path-slug"=>"v3artistsvideos-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"query", "name"=>"artist_name", "description"=>"Name of artist for desired images"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"Comma separated list of fields"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Artists", "Videos"]}}, "/v3/asset-changes/change-sets"=>{"put"=>{"summary"=>"Get Asset Change Notifications", "description"=>"# Asset Changes\r\n\r\nGet notifications about new, updated or deleted assets.\r\n\r\n## Quickstart\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource.\r\nPlease see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n\r\n \r\nPartner channels that have not been checked within the last 120 days will be removed and that partner will no longer be able \r\nto get change notifications from that channel.\r\nPartners who would like to start using the Asset Changes API again after a period of dormancy should contact their sales\r\nrepresentative to be set up again.", "operationId"=>"AssetChanges_PutAssetChanges", "x-api-path-slug"=>"v3assetchangeschangesets-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"batch_size", "description"=>"Specifies the number of assets to return"}, {"in"=>"query", "name"=>"channel_id", "description"=>"Specifies the id of the channel for the asset data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Changes"]}}, "/v3/asset-changes/change-sets/{change-set-id}"=>{"delete"=>{"summary"=>"Get Asset Change Notification", "description"=>"# Delete Asset Changes\r\n\r\nConfirm asset changes acknowledges receipt of asset changes (from the PUT asset changes endpoint).\r\n\r\n## Quickstart\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource.\r\nPlease see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.", "operationId"=>"AssetChanges_DeleteAssetChanges", "x-api-path-slug"=>"v3assetchangeschangesetschangesetid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"change-set-id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Changes"]}}, "/v3/asset-changes/channels"=>{"get"=>{"summary"=>"Get Asset Change Channels", "description"=>"# Get Partner Channels\r\n\r\nRetrieves the channel data for the partner. This data can be used to populate the channel_id parameter in the Put Asset Changes query.\r\n\r\n## Quickstart\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource.\r\nPlease see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n\r\nOnly channels that have been queried in the last 120 days will be included in the list of channels.\r\nPartners who have a channel that has been removed should contact their sales representative to be set up again.", "operationId"=>"AssetChanges_GetPartnerChannel", "x-api-path-slug"=>"v3assetchangeschannels-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Changes"]}}, "/v3/asset-registrations"=>{"post"=>{"summary"=>"Register Assets", "description"=>"# Register Assets\r\n\r\nRegisters a list of assets that a customer has stored in their system.\r\n\r\n## Quickstart\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource.\r\nPlease see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n\r\n_Note_: In the event of a successful query (response code 200) there will be nothing in the response body.", "operationId"=>"AssetRegistration_Register", "x-api-path-slug"=>"v3assetregistrations-post", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"Specify JSON containing an array of asset ids to register", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Registrations"]}}, "/v3/boards"=>{"get"=>{"summary"=>"Get All Boards", "description"=>"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to retrieve all Boards available for a user.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.", "operationId"=>"Boards_GetAllBoards", "x-api-path-slug"=>"v3boards-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"board_relationship", "description"=>"Search for boards the user owns or has been invited to as an editor"}, {"in"=>"query", "name"=>"page", "description"=>"Request results starting at a page number (default is 1)"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Request number of boards to return in each page"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Sort the list of boards by last update date or name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Boards"]}, "post"=>{"summary"=>"Create Board", "description"=>"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to create a Board by a specific id.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.\r\n\r\n**NOTE:** *The input to this endpoint is not sanitized in any way, so it is the responsibility of the client to ensure that it is properly formatted and guards against malicious data (for example cross-site scripting attacks or HTML injection) when accessing the data.*", "operationId"=>"Boards_CreateBoard", "x-api-path-slug"=>"v3boards-post", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"body", "name"=>"new_board", "description"=>"Specify a name and description of the board to create (name is required)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Boards"]}}, "/v3/boards/{board_id}"=>{"delete"=>{"summary"=>"Delete Board", "description"=>"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to delete a Board by a specific id.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.", "operationId"=>"Boards_DeleteBoard", "x-api-path-slug"=>"v3boardsboard-id-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Boards"]}, "get"=>{"summary"=>"Get Board Assets", "description"=>"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to retrieve a Board by a specific id.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.", "operationId"=>"Boards_GetBoard", "x-api-path-slug"=>"v3boardsboard-id-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Boards"]}, "put"=>{"summary"=>"Update Board", "description"=>"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to update a Board by a specific id.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.\r\n\r\n**NOTE:** *The input to this endpoint is not sanitized in any way, so it is the responsibility of the client to ensure that it is properly formatted and guards against malicious data (for example cross-site scripting attacks or HTML injection) when accessing the data.*", "operationId"=>"Boards_UpdateBoard", "x-api-path-slug"=>"v3boardsboard-id-put", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id"}, {"in"=>"body", "name"=>"board_info", "description"=>"Specify a new name and description for the board (name is required)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Boards"]}}, "/v3/boards/{board_id}/assets"=>{"delete"=>{"summary"=>"Remove Assets From Board", "description"=>"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq).\r\nUse this endpoint to remove a set of assets from a board.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.", "operationId"=>"Boards_RemoveAssets", "x-api-path-slug"=>"v3boardsboard-idassets-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"query", "name"=>"asset_ids", "description"=>"List the assets to be removed from the board"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Boards"]}, "put"=>{"summary"=>"Add Assets to a Board", "description"=>"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq).\r\nUse this endpoint to add a set of assets to a board.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.", "operationId"=>"Boards_AddAssets", "x-api-path-slug"=>"v3boardsboard-idassets-put", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"body", "name"=>"board_assets", "description"=>"List assets to add to the board", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"board_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Boards"]}}, "/v3/boards/{board_id}/assets/{asset_id}"=>{"delete"=>{"summary"=>"Remove an asset from a board", "description"=>"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to remove an asset from a board.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.", "operationId"=>"Boards_RemoveAsset", "x-api-path-slug"=>"v3boardsboard-idassetsasset-id-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"path", "name"=>"asset_id"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Boards"]}, "put"=>{"summary"=>"Add an asset to a board", "description"=>"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place.\r\nMore information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to add an asset to a board.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource.\r\nPlease see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.", "operationId"=>"Boards_AddAsset", "x-api-path-slug"=>"v3boardsboard-idassetsasset-id-put", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"path", "name"=>"asset_id"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Boards"]}}, "/v3/boards/{board_id}/comments"=>{"get"=>{"summary"=>"Get comments from a board", "description"=>"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to retrieve all comments for a specific board.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.", "operationId"=>"Boards_GetComments", "x-api-path-slug"=>"v3boardsboard-idcomments-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Boards", "Comments"]}, "post"=>{"summary"=>"Add a comment to a board", "description"=>"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq).\r\nUse this endpoint to add a comment to a board.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.", "operationId"=>"Boards_AddComment", "x-api-path-slug"=>"v3boardsboard-idcomments-post", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id"}, {"in"=>"body", "name"=>"comment", "description"=>"Comment to be added to the board", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Boards", "Comments"]}}, "/v3/boards/{board_id}/comments/{comment_id}"=>{"delete"=>{"summary"=>"Delete a comment from a board", "description"=>"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq).\r\nUse this endpoint to delete a comment from a board.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.", "operationId"=>"Boards_DeleteComment", "x-api-path-slug"=>"v3boardsboard-idcommentscomment-id-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id"}, {"in"=>"path", "name"=>"comment_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Boards", "Comments"]}}, "/v3/collections"=>{"get"=>{"summary"=>"Get Collections", "description"=>"Use this endpoint to retrieve collections associated with your Getty Images account. To browse available collections see our [Image collections page]( http://www.gettyimages.com/creative-images/collections).\r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.", "operationId"=>"Collections_GetCollections", "x-api-path-slug"=>"v3collections-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Collections"]}}, "/v3/countries"=>{"get"=>{"summary"=>"Get Countries", "description"=>"Returns a list of country objects that contains country name, two letter ISO abbreviation and three letter ISO abbreviation.\r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.", "operationId"=>"Countries_GetCountries", "x-api-path-slug"=>"v3countries-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Countries"]}}, "/v3/downloads"=>{"get"=>{"summary"=>"Get Downloads", "description"=>"Returns information about a customer's previously downloaded assets.\r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n \r\n\t\r\nThis endpoint requires being a Getty Images customer to limit your results to only assets that you have a license to use, \r\nyou need to also include an authorization token in the header of your request. \r\nPlease consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens.", "operationId"=>"Downloads_GetDownloads", "x-api-path-slug"=>"v3downloads-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"company_downloads", "description"=>"If specified, returns the list of previously downloaded images for all users in your company"}, {"in"=>"query", "name"=>"end_date", "description"=>"If specified, select assets downloaded on or before this date"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}, {"in"=>"query", "name"=>"product_type", "description"=>"Specifies product type to be included in the previous download results"}, {"in"=>"query", "name"=>"start_date", "description"=>"If specified, select assets downloaded on or after this date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Downloads"]}}, "/v3/downloads/images/{id}"=>{"post"=>{"summary"=>"Download an image", "description"=>"Use this endpoint to generate download URLs and related data for images you are authorized to download.\r\n\r\nMost product offerings have enforced periodic download limits such as monthly, weekly, and daily. When this operation executes, the count of allowed downloads is decremented by one for the product offering. Once the download limit is reached for a given product offering, no further downloads may be requested for that product offering until the next download period.\r\n\r\nThe download limit for a given download period is covered in your product agreement established with Getty Images.\r\n\r\nYou'll need an API key and a [Resource Owner Grant or Implicit Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n\r\n## Auto Downloads\r\nThe `auto_download` request query parameter specifies whether to automatically download the image.\r\n\r\nIf the `auto_download` request query parameter is set to _true_, the API will return an HTTP status code 303 *See Other*.???Your client code will need to process this response and redirect to the URI specified in the *Location* header to enable you to automatically download the file. The redirection workflow follows the [HTTP 1.1 protocol](https://tools.ietf.org/html/rfc7231#section-6.4.4).\r\n\r\nClient Request:\r\n\r\n```\r\nhttps://api.gettyimages.com/v3/downloads/images/[asset_id]?auto_download=true\r\n```\r\n\r\nServer Response:\r\n\r\n```\r\nHTTP/1.1 303 See Other\r\nLocation: https://delivery.gettyimages.com/...\r\n```\r\n\r\nIf the `auto_download` request query parameter is set to false, the API will return a HTTP status code 200, along with the URI in the response body which can be used to download the image. \r\n\r\nClient Request:\r\n\r\n```\r\nhttps://api.gettyimages.com/v3/downloads/images/[asset_id]?auto_download=false\r\n```\r\n\r\nServer Response:\r\n\r\n```\r\nHTTP/1.1 200 OK\r\n{\r\n\t\"uri\": \"https://delivery.gettyimages.com/...\"\r\n}\r\n```", "operationId"=>"Downloads_PostDownloads", "x-api-path-slug"=>"v3downloadsimagesid-post", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"auto_download", "description"=>"Specifies whether to auto-download the image"}, {"in"=>"body", "name"=>"download_details", "description"=>"Additional information required from specific customers when downloading", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"file_type", "description"=>"File Type expressed with three character file extension"}, {"in"=>"query", "name"=>"height", "description"=>"Specifies the pixel height of the particular image to download"}, {"in"=>"path", "name"=>"id", "description"=>"Id of image to download"}, {"in"=>"query", "name"=>"product_id", "description"=>"Identifier of the instance for the selected product offering type"}, {"in"=>"query", "name"=>"product_type", "description"=>"Product type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Downloads"]}}, "/v3/downloads/videos/{id}"=>{"post"=>{"summary"=>"Download a video", "description"=>"Use this endpoint to generate download URLs and related data for videos you are authorized to download.\r\n\r\nMost product offerings have enforced periodic download limits such as monthly, weekly, and daily. When this operation executes, the count of allowed downloads is decremented by one for the product offering. Once the download limit is reached for a given product offering, no further downloads may be requested for that product offering until the next download period.\r\n\r\nThe download limit for a given download period is covered in your product agreement established with Getty Images.\r\n\r\nYou'll need an API key and a [Resource Owner Grant or Implicit Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n\r\n## Auto Downloads\r\nThe `auto_download` request query parameter specifies whether to automatically download the video.\r\n\r\nIf the `auto_download` request query parameter is set to _true_, the API will return an HTTP status code 303 *See Other*.???Your client code will need to process this response and redirect to the URI specified in the *Location* header to enable you to automatically download the file. The redirection workflow follows the [HTTP 1.1 protocol](https://tools.ietf.org/html/rfc7231#section-6.4.4).\r\n\r\nClient Request:\r\n\r\n```\r\nhttps://api.gettyimages.com/v3/downloads/videos/[asset_id]?auto_download=true\r\n```\r\n\r\nServer Response:\r\n\r\n```\r\nHTTP/1.1 303 See Other\r\nLocation: https://delivery.gettyimages.com/...\r\n```\r\n\r\nIf the `auto_download` request query parameter is set to false, the API will return a HTTP status code 200, along with the URI in the response body which can be used to download the video. \r\n\r\nClient Request:\r\n\r\n```\r\nhttps://api.gettyimages.com/v3/downloads/videos/[asset_id]?auto_download=false\r\n```\r\n\r\nServer Response:\r\n\r\n```\r\nHTTP/1.1 200 OK\r\n{\r\n\t\"uri\": \"https://delivery.gettyimages.com/...\"\r\n}\r\n```", "operationId"=>"Downloads_PostVideoDownloads", "x-api-path-slug"=>"v3downloadsvideosid-post", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"auto_download", "description"=>"Specifies whether to auto-download the video"}, {"in"=>"body", "name"=>"download_details", "description"=>"Additional information required from specific customers when downloading", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Id of video to download"}, {"in"=>"query", "name"=>"product_id", "description"=>"Identifier of the instance for the selected product offering type"}, {"in"=>"query", "name"=>"size", "description"=>"Specifies the size to be downloaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Downloads", "Videos"]}}, "/v3/events"=>{"get"=>{"summary"=>"Get metadata for multiple events", "description"=>"This endpoint returns the detailed event metadata for all specified events. Getty Images news, sports and entertainment photographers and\r\nvideographers cover editorially relevant events occurring around the world. All images or video clips produced in association with \r\nan event, are assigned the same EventID. EventIDs are part of the meta-data returned in SearchForImages Results. Only content \r\nproduced under a Getty Images brand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) \r\nwill be consistently assigned an EventID. The Event framework may also be used to group similar content, such as \r\n\"Hats from the Royal Wedding\" or \"Odd-ballOffbeat images of the week\". \r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.", "operationId"=>"Events_GetBatch", "x-api-path-slug"=>"v3events-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma separated list of fields to return in the response"}, {"in"=>"query", "name"=>"ids", "description"=>"A comma separated list of event ids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Events"]}}, "/v3/events/{id}"=>{"get"=>{"summary"=>"Get metadata for a single event", "description"=>"This endpoint returns the detailed event metadata for a specified event. Getty Images news, sports and entertainment \r\nphotographers and videographers cover editorially relevant events occurring around the world. \r\nAll images or video clips produced in association with an event, are assigned the same EventID. \r\nEventIDs are part of the meta-data returned in SearchForImages Results. Only content produced under a Getty Images \r\nbrand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) will be \r\nconsistently assigned an EventID. The Event framework may also be used to group similar content, such as \r\n\"Hats from the Royal Wedding\" or \"Odd-ballOffbeat images of the week\". \r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html)\r\npage for more information on how to sign up for an API key.", "operationId"=>"Events_Get", "x-api-path-slug"=>"v3eventsid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma separated list of fields to return in the response"}, {"in"=>"path", "name"=>"id", "description"=>"An event id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Events"]}}, "/v3/images"=>{"get"=>{"summary"=>"Get Images", "description"=>"This endpoint returns the detailed image metadata for all specified images. Due to a wide variety of available image resolutions,\r\nthe images are grouped into a handful of size categories for simplicity. \r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) \r\npage for more information on how to sign up for an API key. \r\n\r\n## Working with Fields Sets\r\n\r\nFields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:\r\n\r\n#### Summary Fields Set\r\n\r\nThe **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build \r\nsearch response results. The following fields are provided for every image in your result set when you include **summary_set** in your request.\r\n\r\n```\r\n{\r\n \"images\":\r\n [\r\n \"artist\",\r\n \"asset_family\",\r\n \"caption\",\r\n \"collection_code\",\r\n \"collection_id\",\r\n \"collection_name\",\r\n \"license_model\",\r\n \"max_dimensions\",\r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Detail Fields Set\r\n\r\nThe **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a \r\ndetailed view of images. The following fields are provided for every image in your result set when you include **detail_set** in your request.\r\n\r\n```\r\n{\r\n \"images\":\r\n [\r\n \"allowed_use\",\r\n \"artist\", \r\n \"artist_title\", \r\n \"asset_family\",\r\n \"call_for_image\",\r\n \"caption\", \r\n \"city\",\r\n \"collection_code\",\r\n \"collection_id\", \r\n \"collection_name\",\r\n \"color_type\", \r\n \"copyright\", \r\n \"country\", \r\n \"credit_line\", \r\n \"date_created\", \r\n \"date_submitted\",\r\n \"download_sizes\", \r\n \"editorial_segments\",\r\n \"event_ids\",\r\n \"graphical_style\",\r\n \"license_model\",\r\n \"max_dimensions\",\r\n \"orientation\",\r\n \"prestige\",\r\n \"product_types\",\r\n \"quality_rank\",\r\n \"referral_destinations\",\r\n \"state_province\", \r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Display Fields Set\r\n\r\nThe **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution\r\nfiles that are most frequently used to build a UI displaying search results. The following fields are provided for every image \r\nin your result set when you include **display_set** in your request.\r\n\r\n```\r\n{\r\n \"images\":\r\n [\r\n \"display_sizes\": \r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ]\r\n ]\r\n}\r\n```\r\n\r\n## Request Usage Considerations\r\n\r\n- Specifying the \"entity_details\" response field can have significant performance implications. The field should be used only when necessary.", "operationId"=>"Images_GetBatch", "x-api-path-slug"=>"v3images-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"ids", "description"=>"Specifies one or more image ids to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images"]}}, "/v3/images/{id}"=>{"get"=>{"summary"=>"Get Image", "description"=>"This endpoint returns the detailed image metadata for a specified image. Due to a wide variety of available image resolutions, \r\nthe images are grouped into a handful of size categories for simplicity. \r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) \r\npage for more information on how to sign up for an API key. \r\n \r\n## Working with Fields Sets\r\n\r\nFields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:\r\n\r\n#### Summary Fields Set\r\n\r\nThe **summary_set** query string parameter fields value represents a small batch of metadata fields that\r\nare often used to build search response results. The following fields are provided for every image in your\r\nresult set when you include **summary_set** in your request.\r\n\r\n```\r\n{\r\n \"images\":\r\n [\r\n \"artist\",\r\n \"asset_family\",\r\n \"caption\",\r\n \"collection_code\",\r\n \"collection_id\",\r\n \"collection_name\",\r\n \"license_model\",\r\n \"max_dimensions\",\r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Detail Fields Set\r\n\r\nThe **detail_set** query string parameter fields value represents a large batch of metadata fields that are \r\noften used to build a detailed view of images. The following fields are provided for every image in your \r\nresult set when you include **detail_set** in your request.\r\n\r\n```\r\n{\r\n \"images\":\r\n [\r\n \"allowed_use\",\r\n \"artist\", \r\n \"artist_title\", \r\n \"asset_family\",\r\n \"call_for_image\",\r\n \"caption\", \r\n \"city\",\r\n \"collection_code\",\r\n \"collection_id\", \r\n \"collection_name\",\r\n \"color_type\", \r\n \"copyright\", \r\n \"country\", \r\n \"credit_line\", \r\n \"date_created\", \r\n \"date_submitted\",\r\n \"download_sizes\", \r\n \"editorial_segments\",\r\n \"event_ids\",\r\n \"graphical_style\",\r\n \"license_model\",\r\n \"max_dimensions\",\r\n \"orientation\",\r\n \"prestige\",\r\n \"product_types\",\r\n \"quality_rank\",\r\n \"referral_destinations\",\r\n \"state_province\", \r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Display Fields Set\r\n\r\nThe **display_set** query string parameter fields value represents the fields that provide you with URLs for the low\r\nresolution files that are most frequently used to build a UI displaying search results. The following fields are provided \r\nfor every image in your result set when you include **display_set** in your request.\r\n\r\n```\r\n{\r\n \"images\":\r\n [\r\n \"display_sizes\": \r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ]\r\n ]\r\n}\r\n```\r\n\r\n## Request Usage Considerations\r\n\r\n- Specifying the \"entity_details\" response field can have significant performance implications. The field should be used only when necessary.", "operationId"=>"Images_Get", "x-api-path-slug"=>"v3imagesid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"path", "name"=>"id", "description"=>"An image id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images"]}}, "/v3/images/{id}/similar"=>{"get"=>{"summary"=>"Search Similar Images", "description"=>"This endpoint will search our asset database for images similar to the specified asset id. Due to a wide variety of available \r\nimage resolutions, the images are grouped into a handful of size categories for simplicity. \r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) \r\npage for more information on how to sign up for an API key. \r\n\r\n## Working with Fields Sets\r\n\r\nFields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:\r\n\r\n#### Summary Fields Set\r\n\r\nThe **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build\r\nsearch response results. The following fields are provided for every image in your result set when you include **summary_set** in your request.\r\n\r\n```\r\n{\r\n \"images\":\r\n [\r\n \"asset_family\",\r\n \"caption\",\r\n \"collection_code\",\r\n \"collection_id\",\r\n \"collection_name\",\r\n \"display_sizes\": \r\n [\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ]\r\n \"license_model\",\r\n \"max_dimensions\",\r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Detail Fields Set\r\n\r\nThe **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a \r\ndetailed view of images. The following fields are provided for every image in your result set when you include **detail_set** in your request.\r\n\r\n```\r\n{\r\n \"images\":\r\n [\r\n \"allowed_use\",\r\n \"artist\",\r\n \"asset_family\",\r\n \"call_for_image\",\r\n \"caption\",\r\n \"collection_code\",\r\n \"collection_id\",\r\n \"collection_name\",\r\n \"copyright\",\r\n \"date_created\",\r\n \"display_sizes\": \r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ],\r\n \"editorial_segments\",\r\n \"event_ids\",\r\n \"graphical_style\",\r\n \"license_model\",\r\n \"max_dimensions\",\r\n \"orientation\",\r\n \"product_types\",\r\n \"quality_rank\",\r\n \"referral_destinations\",\r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Display Fields Set\r\n\r\nThe **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files \r\nthat are most frequently used to build a UI displaying search results. The following fields are provided for every image in your result\r\nset when you include **display_set** in your request.\r\n\r\n```\r\n{\r\n \"images\":\r\n [\r\n \"display_sizes\": \r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ]\r\n ]\r\n}\r\n```", "operationId"=>"Images_GetSimilarImages", "x-api-path-slug"=>"v3imagesidsimilar-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"path", "name"=>"id", "description"=>"Identifies an existing image"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Similar"]}}, "/v3/products"=>{"get"=>{"summary"=>"Get Products", "description"=>"This endpoint returns all products available to the username used during authentication. As such, this endpoint requires the use of\r\na fully authorized access_token. The product data can then be used as search filters, restricting results to images from a specific product.\r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html)\r\npage for more information on how to sign up for an API key.", "operationId"=>"Products_GetProducts", "x-api-path-slug"=>"v3products-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"Comma separated list of fields"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Products"]}}, "/v3/purchased-assets"=>{"get"=>{"summary"=>"Get Purchased Images", "description"=>"This endpoint returns a list of all assets purchased on gettyimages.com by the username used for authentication. \r\nUse of this endpoint requires configuration changes to your API key. \r\nPlease contact [developersupport@gettyimages.com](mailto:developersupport@gettyimages.com) to learn more.\r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html)\r\npage for more information on how to sign up for an API key.", "operationId"=>"Purchases_GetPreviousAssetPurchases", "x-api-path-slug"=>"v3purchasedassets-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"end_date", "description"=>"If specified, retrieves previous purchases on or before this date"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}, {"in"=>"query", "name"=>"start_date", "description"=>"If specified, retrieves previous purchases on or after this date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Purchases"]}}, "/v3/purchased-images"=>{"get"=>{"summary"=>"Get Previously Purchased Images", "description"=>"This endpoint returns a list of all images purchased on gettyimages.com by the username used for authentication.\r\nUse of this endpoint requires configuration changes to your API key. Please contact [developersupport@gettyimages.com](mailto:developersupport@gettyimages.com)\r\nto learn more.\r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html)\r\npage for more information on how to sign up for an API key.", "operationId"=>"Purchases_GetPreviousPurchases", "x-api-path-slug"=>"v3purchasedimages-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"end_date", "description"=>"If specified, retrieves previous purchases on or before this date"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}, {"in"=>"query", "name"=>"start_date", "description"=>"If specified, retrieves previous purchases on or after this date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Purchases"]}}, "/v3/search/events"=>{"get"=>{"summary"=>"Search for events", "description"=>"Use this endpoint to search Getty Images news, sports and entertainment events. Getty Images photographers and videographers cover editorially relevant events occurring around the world. All images or video clips produced in association with an event, are assigned the same EventID. EventIDs are part of the meta-data returned in Search Results. Only content produced under a Getty Images brand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) will be consistently assigned an EventID. The Event framework may also be used to group similar content, such as \"Hats from the Royal Wedding\" or \"Odd-ballOffbeat images of the week\". \r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.\r\n\r\n\r\nYou can show different information in the response by specifying values on the \"fields\" parameter (see details below).\r\nYou can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token.", "operationId"=>"Search_GetEvents", "x-api-path-slug"=>"v3searchevents-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"date_from", "description"=>"Filters to events that start on or after this date"}, {"in"=>"query", "name"=>"date_to", "description"=>"Filters to events that start on or before this date"}, {"in"=>"query", "name"=>"editorial_segment", "description"=>"Filters to events with a matching editorial segment"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"page", "description"=>"Request results starting at a page number (default is 1, maximum is 50)"}, {"in"=>"query", "name"=>"page_size", "description"=>"Request number of images to return in each page"}, {"in"=>"query", "name"=>"phrase", "description"=>"Filters to events related to this phrase"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Search"]}}, "/v3/search/images"=>{"get"=>{"summary"=>"Search Images", "description"=>"Use this endpoint to search over a blend of our contemporary stock photos, illustrations, archival images, editorial photos, illustrations and archival images.", "operationId"=>"Search_GetImagesByPhrase", "x-api-path-slug"=>"v3searchimages-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"query", "name"=>"age_of_people", "description"=>"Filter based on the age of individuals in an image"}, {"in"=>"query", "name"=>"artists", "description"=>"Search for images by specific artists (free-text, comma-separated list of artists)"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"collections_filter_type", "description"=>"Provides searching based on specified collection(s)"}, {"in"=>"query", "name"=>"collection_codes", "description"=>"Filter by collection codes (comma-separated list)"}, {"in"=>"query", "name"=>"color", "description"=>"Filter based on predominant color in an image"}, {"in"=>"query", "name"=>"compositions", "description"=>"Filter based on image composition"}, {"in"=>"query", "name"=>"embed_content_only", "description"=>"Restrict search results to embeddable images"}, {"in"=>"query", "name"=>"ethnicity", "description"=>"Filter search results based on the ethnicity of individuals in an image"}, {"in"=>"query", "name"=>"event_ids", "description"=>"Filter based on specific events"}, {"in"=>"query", "name"=>"exclude_nudity", "description"=>"Excludes images containing nudity"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"file_types", "description"=>"Return only images having a specific file type"}, {"in"=>"query", "name"=>"graphical_styles", "description"=>"Filter based on graphical style of the image"}, {"in"=>"query", "name"=>"keyword_ids", "description"=>"Return only images tagged with specific keyword(s)"}, {"in"=>"query", "name"=>"license_models", "description"=>"Specifies the image licensing model(s)"}, {"in"=>"query", "name"=>"minimum_size", "description"=>"Filter based on minimum size requested"}, {"in"=>"query", "name"=>"number_of_people", "description"=>"Filter based on the number of people in the image"}, {"in"=>"query", "name"=>"orientations", "description"=>"Return only images with selected aspect ratios"}, {"in"=>"query", "name"=>"page", "description"=>"Request results starting at a page number (default is 1)"}, {"in"=>"query", "name"=>"page_size", "description"=>"Request number of images to return in each page"}, {"in"=>"query", "name"=>"phrase", "description"=>"Search images using a search phrase"}, {"in"=>"query", "name"=>"prestige_content_only", "description"=>"Restrict search results to prestige images"}, {"in"=>"query", "name"=>"product_types", "description"=>"Filter images to those from one of your product types"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Select sort order of results"}, {"in"=>"query", "name"=>"specific_people", "description"=>"Return only images associated with specific people (using a comma-delimited list)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Search"]}}, "/v3/search/images/creative"=>{"get"=>{"summary"=>"Search for creative images only", "description"=>"Use this endpoint to search our contemporary stock photos, illustrations and archival images.\r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) \r\npage for more information on how to sign up for an API key. \r\n \r\nYou can show different information in the response by specifying values on the \"fields\" parameter (see details below).\r\nYou can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token.\r\n\r\n## Working with Fields Sets\r\n\r\nFields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:\r\n\r\n#### Summary Fields Set\r\n\r\nThe **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to \r\nbuild search response results. The following fields are provided for every image in your result set when you include **summary_set** in your request.\r\n\r\n```\r\n{\r\n \"images\": \r\n [\r\n \"asset_family\",\r\n \"caption\",\r\n \"collection_code\",\r\n \"collection_id\",\r\n \"collection_name\",\r\n \"display_sizes\": \r\n [\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ],\r\n \"license_model\",\r\n \"max_dimensions\",\r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Detail Fields Set\r\n\r\nThe **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to \r\nbuild a detailed view of images. The following fields are provided for every image in your result set when you include **detail_set** in your request.\r\n\r\n```\r\n{\r\n \"images\": \r\n [\r\n \"allowed_use\",\r\n \"artist\",\r\n \"asset_family\",\r\n \"call_for_image\",\r\n \"caption\",\r\n \"collection_code\",\r\n \"collection_id\",\r\n \"collection_name\",\r\n \"copyright\",\r\n \"date_created\",\r\n \"display_sizes\": \r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ],\r\n \"editorial_segments\",\r\n \"event_ids\",\r\n \"graphical_style\",\r\n \"license_model\",\r\n \"max_dimensions\",\r\n \"orientation\",\r\n \"product_types\",\r\n \"quality_rank\",\r\n \"referral_destinations\",\r\n \"title\"\r\n ]\r\n]\r\n```\r\n\r\n#### Display Fields Set\r\n\r\nThe **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution\r\nfiles that are most frequently used to build a UI displaying search results. The following fields are provided for every image \r\nin your result set when you include **display_set** in your request.\r\n\r\n```Go\r\n{\r\n \"images\": \r\n [\r\n \"display_sizes\": \r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ]\r\n ]\r\n}\r\n```", "operationId"=>"Search_GetCreativeImagesByPhrase", "x-api-path-slug"=>"v3searchimagescreative-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"query", "name"=>"age_of_people", "description"=>"Filter based on the age of individuals in an image"}, {"in"=>"query", "name"=>"artists", "description"=>"Search for images by specific artists (free-text, comma-separated list of artists)"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"collections_filter_type", "description"=>"Use to include or exclude collections from search"}, {"in"=>"query", "name"=>"collection_codes", "description"=>"Filter by collection codes (comma-separated list)"}, {"in"=>"query", "name"=>"color", "description"=>"Filter based on predominant color in an image"}, {"in"=>"query", "name"=>"compositions", "description"=>"Filter based on image composition"}, {"in"=>"query", "name"=>"embed_content_only", "description"=>"Restrict search results to embeddable images"}, {"in"=>"query", "name"=>"ethnicity", "description"=>"Filter search results based on the ethnicity of individuals in an image"}, {"in"=>"query", "name"=>"exclude_nudity", "description"=>"Excludes images containing nudity"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"file_types", "description"=>"Return only images having a specific file type"}, {"in"=>"query", "name"=>"graphical_styles", "description"=>"Filter based on graphical style of the image"}, {"in"=>"query", "name"=>"keyword_ids", "description"=>"Return only images tagged with specific keyword(s)"}, {"in"=>"query", "name"=>"license_models", "description"=>"Specifies the image licensing model(s)"}, {"in"=>"query", "name"=>"minimum_size", "description"=>"Filter based on minimum size requested"}, {"in"=>"query", "name"=>"number_of_people", "description"=>"Filter based on the number of people in the image"}, {"in"=>"query", "name"=>"orientations", "description"=>"Return only images with selected aspect ratios"}, {"in"=>"query", "name"=>"page", "description"=>"Request results starting at a page number (default is 1)"}, {"in"=>"query", "name"=>"page_size", "description"=>"Request number of images to return in each page"}, {"in"=>"query", "name"=>"phrase", "description"=>"Search images using a search phrase"}, {"in"=>"query", "name"=>"prestige_content_only", "description"=>"Restrict search results to prestige images"}, {"in"=>"query", "name"=>"product_types", "description"=>"Filter images to those from one of your product types"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Select sort order of results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Search"]}}, "/v3/search/images/creative/by-image"=>{"get"=>{"summary"=>"Search Images by Image", "description"=>"Allows searching for similar creative images by passing the URL to an existing image.\r\n\r\nBefore calling the search by image endpoint, an image must be uploaded to a specific AWS S3 bucket. The bucket name is `search-by-image.s3.amazonaws.com`.\r\nFor example, using cURL:\r\n```sh\r\ncurl -i -X PUT https://search-by-image.s3.amazonaws.com/my-test-image.jpg -H \"Content-Type: image/jpeg\" --data-binary \"@testimage.jpg\"\r\n```\r\n\r\nUploads can be overwritten if the names are the same, so using a prefix like the API Key, application name or company name would help keep that\r\nfrom happening.\r\n\r\nOnce the image has been uploaded, use the full URL in the `image_url` parameter, e.g. `image_url=https://search-by-image.s3.amazonaws.com/my-test-image.jpg`.\r\n\r\nSubsequent searches for the same image can be executed using the `image_fingerprint` that is returned by the inital search.", "operationId"=>"Search_GetCreativeImagesByUrl", "x-api-path-slug"=>"v3searchimagescreativebyimage-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"image_fingerprint", "description"=>"Specifies the fingerprint of the image to use in the search"}, {"in"=>"query", "name"=>"image_url", "description"=>"Specifies the location of the image to use in the search"}, {"in"=>"query", "name"=>"page", "description"=>"Request results starting at a page number (default is 1)"}, {"in"=>"query", "name"=>"page_size", "description"=>"Request number of images to return in each page"}, {"in"=>"query", "name"=>"product_types", "description"=>"Filter images to those from one of your product types"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Search"]}}, "/v3/search/images/editorial"=>{"get"=>{"summary"=>"Search Editorial Images", "description"=>"Use this endpoint to search our editorial stock photos, illustrations and archival images. Editorial images represent newsworthy events or illustrate matters of general interest, such as news, sport and entertainment and are generally intended for editorial use.", "operationId"=>"Search_GetEditorialImagesByPhrase", "x-api-path-slug"=>"v3searchimageseditorial-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"query", "name"=>"age_of_people", "description"=>"Filter based on the age of individuals in an image"}, {"in"=>"query", "name"=>"artists", "description"=>"Search for images by specific artists (free-text, comma-separated list of artists)"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"collections_filter_type", "description"=>"Use to include or exclude collections from search"}, {"in"=>"query", "name"=>"collection_codes", "description"=>"Filter by collections (comma-separated list of collection codes)"}, {"in"=>"query", "name"=>"compositions", "description"=>"Filter based on image composition"}, {"in"=>"query", "name"=>"editorial_segments", "description"=>"Return only events with a matching editorial segment"}, {"in"=>"query", "name"=>"embed_content_only", "description"=>"Restrict search results to embeddable images"}, {"in"=>"query", "name"=>"end_date", "description"=>"Return only images that are created on or before this date"}, {"in"=>"query", "name"=>"entity_uris", "description"=>"specify linked data entity uri"}, {"in"=>"query", "name"=>"ethnicity", "description"=>"Filter search results based on the ethnicity of individuals in an image"}, {"in"=>"query", "name"=>"event_ids", "description"=>"Filter based on specific events"}, {"in"=>"query", "name"=>"exclude_nudity", "description"=>"Excludes images containing nudity"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"file_types", "description"=>"Return only images having a specific file type"}, {"in"=>"query", "name"=>"graphical_styles", "description"=>"Filter based on graphical style of the image"}, {"in"=>"query", "name"=>"keyword_ids", "description"=>"Return only images tagged with specific keyword(s)"}, {"in"=>"query", "name"=>"minimum_quality_rank", "description"=>"Filter search results based on minimum quality ranking"}, {"in"=>"query", "name"=>"minimum_size", "description"=>"Filter based on minimum size requested"}, {"in"=>"query", "name"=>"number_of_people", "description"=>"Filter based on the number of people in the image"}, {"in"=>"query", "name"=>"orientations", "description"=>"Return only images with selected aspect ratios"}, {"in"=>"query", "name"=>"page", "description"=>"Request results starting at a page number (default is 1)"}, {"in"=>"query", "name"=>"page_size", "description"=>"Request number of images to return in each page"}, {"in"=>"query", "name"=>"phrase", "description"=>"Search images using a search phrase"}, {"in"=>"query", "name"=>"product_types", "description"=>"Filter images to those from one of your product types"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Select sort order of results"}, {"in"=>"query", "name"=>"specific_people", "description"=>"Return only images associated with specific people (using a comma-delimited list)"}, {"in"=>"query", "name"=>"start_date", "description"=>"Return only images that are created on or after this date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Search", "Editorial"]}}, "/v3/search/videos"=>{"get"=>{"summary"=>"Search Editorial Videos", "description"=>"Use this endpoint to search over a blend of our premium stock, contemporary 4K and HD footage, celebrities, news, newsmakers, entertainment, events and archival videos.\r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.\r\n\r\n\r\nYou can show different information in the response by specifying values on the \"fields\" parameter (see details below).\r\nYou can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token.\r\n\r\n## Working with Fields Sets\r\n\r\nFields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:\r\n\r\n#### Summary Fields Set\r\n\r\nThe **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every video in your result set when you include **summary_set** in your request.\r\n\r\n```\r\n{\r\n \"videos\":\r\n [\r\n \"asset_family\",\r\n \"caption\",\r\n \"collection_code\",\r\n \"collection_name\",\r\n \"display_sizes\":\r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ],\r\n \"license_model\",\r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Detail Fields Set\r\n\r\nThe **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of videos. The following fields are provided for every video in your result set when you include **detail_set** in your request.\r\n\r\n```\r\n{\r\n \"videos\":\r\n [\r\n \"allowed_use\",\r\n \"artist\",\r\n \"asset_family\",\r\n \"caption\",\r\n \"clip_length\",\r\n \"collection_code\",\r\n \"collection_id\",\r\n \"collection_name\",\r\n \"color_type\",\r\n \"copyright\",\r\n \"date_created\",\r\n \"display_sizes\":\r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ],\r\n \"era\",\r\n \"license_model\",\r\n \"mastered_to\",\r\n \"originally_shot_on\",\r\n \"product_types\",\r\n \"shot_speed\",\r\n \"source\",\r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Display Fields Set\r\n\r\nThe **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every video in your result set when you include **display_set** in your request.\r\n\r\n```\r\n{\r\n \"videos\":\r\n [\r\n \"display_sizes\":\r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ]\r\n ]\r\n}\r\n```\r\n\r\n## Request Usage Considerations\r\n\r\n- Specifying the \"entity_details\" response field can have significant performance implications. The field should be used only when necessary.", "operationId"=>"Search_GetVideosByPhrase", "x-api-path-slug"=>"v3searchvideos-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"query", "name"=>"age_of_people", "description"=>"Provides filtering according to the age of individuals in a video"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"collections_filter_type", "description"=>"Provides searching based on specified collection(s)"}, {"in"=>"query", "name"=>"collection_codes", "description"=>"Provides filtering by collection code"}, {"in"=>"query", "name"=>"editorial_video_types", "description"=>"Allows filtering by types of video"}, {"in"=>"query", "name"=>"exclude_nudity", "description"=>"Excludes images containing nudity"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"format_available", "description"=>"Filters according to the digital video format available on a film asset"}, {"in"=>"query", "name"=>"frame_rates", "description"=>"Provides filtering by video frame rate (frames/second)"}, {"in"=>"query", "name"=>"keyword_ids", "description"=>"Return only images tagged with specific keyword(s)"}, {"in"=>"query", "name"=>"license_models", "description"=>"Specifies the video licensing model(s)"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}, {"in"=>"query", "name"=>"phrase", "description"=>"Free-text search query"}, {"in"=>"query", "name"=>"product_types", "description"=>"Filter images to those from one of your product types"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Allows sorting of results"}, {"in"=>"query", "name"=>"specific_people", "description"=>"Provides filtering by specific peoples names"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Search", "Videos"]}}, "/v3/search/videos/creative"=>{"get"=>{"summary"=>"Search for creative videos", "description"=>"Use this endpoint to search premium stock video, from archival film to contemporary 4K and HD footage.\r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html)\r\npage for more information on how to sign up for an API key.\r\n\r\nYou can show different information in the response by specifying values on the \"fields\" parameter (see details below).\r\nYou can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without\r\nbeing logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only \r\nassets that you have a license to use, you need to also include an authorization token in the header of your request.\r\nPlease consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens.\r\n\r\n## Working with Fields Sets\r\n\r\nFields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:\r\n\r\n#### Summary Fields Set\r\n\r\nThe **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search\r\nresponse results. The following fields are provided for every video in your result set when you include **summary_set** in your request.\r\n\r\n```\r\n{\r\n \"videos\": \r\n [\r\n \"asset_family\", \r\n \"caption\",\r\n \"collection_code\",\r\n \"collection_name\",\r\n \"display_sizes\":\r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ],\r\n \"license_model\",\r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Detail Fields Set\r\n\r\nThe **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a \r\ndetailed view of videos. The following fields are provided for every video in your result set when you include **detail_set** in your request.\r\n\r\n```\r\n{\r\n \"videos\": \r\n [\r\n \"allowed_use\",\r\n \"artist\",\r\n \"asset_family\", \r\n \"caption\", \r\n \"clip_length\",\r\n \"collection_code\",\r\n \"collection_id\",\r\n \"collection_name\", \r\n \"color_type\",\r\n \"copyright\",\r\n \"date_created\",\r\n \"display_sizes\":\r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ],\r\n \"era\",\r\n \"license_model\",\r\n \"mastered_to\",\r\n \"originally_shot_on\",\r\n \"product_types\",\r\n \"shot_speed\",\r\n \"source\",\r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Display Fields Set\r\n\r\nThe **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files \r\nthat are most frequently used to build a UI displaying search results. The following fields are provided for every video in your result \r\nset when you include **display_set** in your request.\r\n\r\n```\r\n{\r\n \"videos\":\r\n [\r\n \"display_sizes\":\r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ]\r\n ]\r\n}\r\n```", "operationId"=>"Search_GetCreativeVideosByPhrase", "x-api-path-slug"=>"v3searchvideoscreative-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"query", "name"=>"age_of_people", "description"=>"Provides filtering according to the age of individuals in a video"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"collections_filter_type", "description"=>"Provides searching based on specified collection(s)"}, {"in"=>"query", "name"=>"collection_codes", "description"=>"Provides filtering by collection code"}, {"in"=>"query", "name"=>"exclude_nudity", "description"=>"Excludes images containing nudity"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"format_available", "description"=>"Filters according to the digital video format available on a film asset"}, {"in"=>"query", "name"=>"frame_rates", "description"=>"Provides filtering by video frame rate (frames/second)"}, {"in"=>"query", "name"=>"keyword_ids", "description"=>"Return only images tagged with specific keyword(s)"}, {"in"=>"query", "name"=>"license_models", "description"=>"Specifies the video licensing model(s)"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}, {"in"=>"query", "name"=>"phrase", "description"=>"Free-text search query"}, {"in"=>"query", "name"=>"product_types", "description"=>"Filter images to those from one of your product types"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Allows sorting of results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Search", "Videos"]}}, "/v3/search/videos/editorial"=>{"get"=>{"summary"=>"Search for editorial videos", "description"=>"Use this endpoint to search current and archival video clips of celebrities, newsmakers, and events.\r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.\r\n\r\nYou can show different information in the response by specifying values on the \"fields\" parameter (see details below).\r\nYou can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token.\r\n\r\n## Working with Fields Sets\r\n\r\nFields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:\r\n\r\n#### Summary Fields Set\r\n\r\nThe **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every video in your result set when you include **summary_set** in your request.\r\n\r\n```\r\n{\r\n \"videos\": \r\n [\r\n \"asset_family\", \r\n \"caption\",\r\n \"collection_code\",\r\n \"collection_name\",\r\n \"display_sizes\":\r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ],\r\n \"license_model\",\r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Detail Fields Set\r\n\r\nThe **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of videos. The following fields are provided for every video in your result set when you include **detail_set** in your request.\r\n\r\n```\r\n{\r\n \"videos\": \r\n [\r\n \"allowed_use\",\r\n \"artist\",\r\n \"asset_family\", \r\n \"caption\", \r\n \"clip_length\",\r\n \"collection_code\",\r\n \"collection_id\",\r\n \"collection_name\", \r\n \"color_type\",\r\n \"copyright\",\r\n \"date_created\",\r\n \"display_sizes\":\r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ],\r\n \"era\",\r\n \"license_model\",\r\n \"mastered_to\",\r\n \"originally_shot_on\",\r\n \"product_types\",\r\n \"shot_speed\",\r\n \"source\",\r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Display Fields Set\r\n\r\nThe **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every video in your result set when you include **display_set** in your request.\r\n\r\n```\r\n{\r\n \"videos\":\r\n [\r\n \"display_sizes\":\r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ]\r\n ]\r\n}\r\n```\r\n\r\n## Request Usage Considerations\r\n\r\n- Specifying the \"entity_details\" response field can have significant performance implications. The field should be used only when necessary.", "operationId"=>"Search_GetEditorialVideosByPhrase", "x-api-path-slug"=>"v3searchvideoseditorial-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"query", "name"=>"age_of_people", "description"=>"Provides filtering according to the age of individuals in a video"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"collections_filter_type", "description"=>"Provides searching based on specified collection(s)"}, {"in"=>"query", "name"=>"collection_codes", "description"=>"Provides filtering by collection code"}, {"in"=>"query", "name"=>"editorial_video_types", "description"=>"Allows filtering by types of video"}, {"in"=>"query", "name"=>"entity_uris", "description"=>"specify link data entity uri"}, {"in"=>"query", "name"=>"exclude_nudity", "description"=>"Excludes images containing nudity"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"format_available", "description"=>"Filters according to the digital video format available on a film asset"}, {"in"=>"query", "name"=>"frame_rates", "description"=>"Provides filtering by video frame rate (frames/second)"}, {"in"=>"query", "name"=>"keyword_ids", "description"=>"Return only images tagged with specific keyword(s)"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}, {"in"=>"query", "name"=>"phrase", "description"=>"Free-text search query"}, {"in"=>"query", "name"=>"product_types", "description"=>"Filter images to those from one of your product types"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Allows sorting of results"}, {"in"=>"query", "name"=>"specific_people", "description"=>"Allows filtering by specific peoples names"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Search", "Videos", "Editoria"]}}, "/v3/usage-batches/{id}"=>{"put"=>{"summary"=>"Reports Usage Batches", "description"=>"# Report Usage\r\n\r\nUse this endpoint to report the usages of a set of assets. The count of assets submitted in a single batch to this endpoint is limited to 1000. Note that all asset Ids specified must be valid or the operation will fail causing no usages to be recorded. In this case, you will need to remove the invalid asset Ids from the query request and re-submit the query.\r\n\r\n## Quickstart\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource.\r\nPlease see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n\r\n\r\n_Note_: Date of use can be in any unambiguous date format.", "operationId"=>"Usage_Put", "x-api-path-slug"=>"v3usagebatchesid-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"id", "description"=>"Specifies a unique batch transaction id to identify the report"}, {"in"=>"body", "name"=>"request", "description"=>"Specifies up to 1000 sets of asset Id, usage count, and date of use to submit usages for", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Batches"]}}, "/v3/videos"=>{"get"=>{"summary"=>"Get Videos Metadatata", "description"=>"Use this endpoint to return detailed video metadata for all the specified video ids.\r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.\r\n\r\nYou can show different information in the response by specifying values on the \"fields\" parameter (see details below).\r\nYou can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token.\r\n\r\n## Working with Fields Sets\r\n\r\nFields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:\r\n\r\n#### Summary Fields Set\r\n\r\nThe **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every video in your result set when you include **summary_set** in your request.\r\n\r\n```\r\n{\r\n \"videos\": \r\n [\r\n \"asset_family\",\r\n \"caption\",\r\n \"collection_code\",\r\n \"collection_name\",\r\n \"display_sizes\":\r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ],\r\n \"license_model\",\r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Detail Fields Set\r\n\r\nThe **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of videos. The following fields are provided for every video in your result set when you include **detail_set** in your request.\r\n\r\n```\r\n{\r\n \"videos\": \r\n [\r\n \"allowed_use\",\r\n \"artist\",\r\n \"asset_family\",\r\n \"caption\",\r\n \"clip_length\",\r\n \"collection_code\",\r\n \"collection_id\",\r\n \"collection_name\",\r\n \"color_type\",\r\n \"copyright\",\r\n \"date_created\",\r\n \"display_sizes\":\r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ],\r\n \"download_sizes\",\r\n \"era\",\r\n \"license_model\",\r\n \"mastered_to\",\r\n \"originally_shot_on\",\r\n \"product_types\",\r\n \"shot_speed\",\r\n \"source\",\r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Display Fields Set\r\n\r\nThe **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every video in your result set when you include **display_set** in your request.\r\n\r\n```\r\n{\r\n \"videos\":\r\n [\r\n \"display_sizes\": \r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ]\r\n ]\r\n}\r\n```\r\n\r\n## Request Usage Considerations\r\n\r\n- Specifying the \"entity_details\" response field can have significant performance implications. The field should be used only when necessary.", "operationId"=>"Videos_GetBatch", "x-api-path-slug"=>"v3videos-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"ids", "description"=>"Specifies one or more video ids to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Videos"]}}, "/v3/videos/{id}"=>{"get"=>{"summary"=>"Get Video Metadatata", "description"=>"Use this endpoint to return detailed video metadata for the specified video id.\r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.\r\n\r\nYou can show different information in the response by specifying values on the \"fields\" parameter (see details below).\r\nYou can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token.\r\n\r\n## Working with Fields Sets\r\n\r\nFields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:\r\n\r\n#### Summary Fields Set\r\n\r\nThe **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every video in your result set when you include **summary_set** in your request.\r\n\r\n```\r\n{\r\n \"videos\":\r\n [\r\n \"asset_family\",\r\n \"caption\",\r\n \"collection_code\",\r\n \"collection_name\",\r\n \"display_sizes\":\r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ],\r\n \"license_model\",\r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Detail Fields Set\r\n\r\nThe **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of videos. The following fields are provided for every video in your result set when you include **detail_set** in your request.\r\n\r\n```\r\n{\r\n \"videos\":\r\n [\r\n \"allowed_use\",\r\n \"artist\",\r\n \"asset_family\",\r\n \"caption\",\r\n \"clip_length\",\r\n \"collection_code\",\r\n \"collection_id\",\r\n \"collection_name\",\r\n \"color_type\",\r\n \"copyright\",\r\n \"date_created\",\r\n \"display_sizes\":\r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ],\r\n \"download_sizes\",\r\n \"era\",\r\n \"license_model\",\r\n \"mastered_to\",\r\n \"originally_shot_on\",\r\n \"product_types\",\r\n \"shot_speed\",\r\n \"source\",\r\n \"title\"\r\n ]\r\n}\r\n```\r\n\r\n#### Display Fields Set\r\n\r\nThe **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every video in your result set when you include **display_set** in your request.\r\n\r\n```\r\n{\r\n \"videos\":\r\n [\r\n \"display_sizes\":\r\n [\r\n {\r\n \"name\": \"comp\"\r\n },\r\n {\r\n \"name\": \"preview\"\r\n },\r\n {\r\n \"name\": \"thumb\"\r\n }\r\n ]\r\n ]\r\n}\r\n```\r\n\r\n## Request Usage Considerations\r\n\r\n- Specifying the \"entity_details\" response field can have significant performance implications. The field should be used only when necessary.", "operationId"=>"Videos_Get", "x-api-path-slug"=>"v3videosid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"comma delimited list of fields to retrive for the video"}, {"in"=>"path", "name"=>"id", "description"=>"A video id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Videos"]}}, "/v3/videos/{id}/similar"=>{"get"=>{"summary"=>"Get Similar Videos", "description"=>"Get videos similar to a video by supplying one video id", "operationId"=>"Videos_GetSimilarVideos", "x-api-path-slug"=>"v3videosidsimilar-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"comma delimited list of fields to retrive for the videos"}, {"in"=>"path", "name"=>"id", "description"=>"A video id"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Videos", "Similiar"]}}}}, "apis"=>{"name"=>"Getty Images", "x-slug"=>"getty-images", "description"=>"Find high resolution royalty-free images, editorial stock photos, vector art, video footage clips and stock music licensing at the richest image search photo library online.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1013-getty-images.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"1939", "tags"=>"API Provider,General Data,Getting Started Example,Images,internet,Marketplace,Media,Photos,Photos,Photos,Photos,Profiles,Publish,Relative Data,Service API,Stack Network,Stocks,Technology,Videos", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"getty-images/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Getty Images", "x-api-slug"=>"getty-images", "description"=>"Find high resolution royalty-free images, editorial stock photos, vector art, video footage clips and stock music licensing at the richest image search photo library online.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1013-getty-images.jpg", "humanURL"=>"http://www.gettyimages.com/", "baseURL"=>"https://api.gettyimages.com//", "tags"=>"API Provider,General Data,Getting Started Example,Images,internet,Marketplace,Media,Photos,Photos,Photos,Photos,Profiles,Publish,Relative Data,Service API,Stack Network,Stocks,Technology,Videos", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/getty-images/v3videosidsimilar-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/getty-images/getty-images-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://github.com/gettyimages/connect#authentication"}, {"type"=>"x-base", "url"=>"https://connect.gettyimages.com/"}, {"type"=>"x--net-sdk", "url"=>"https://github.com/gettyimages/connect_sdk_csharp"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/gettyimages"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/ge-tt"}, {"type"=>"x-developer", "url"=>"http://api.gettyimages.com/"}, {"type"=>"x-documentation", "url"=>"https://api.gettyimages.com/swagger/ui/index.html"}, {"type"=>"x-email", "url"=>"privacy@gettyimages.com"}, {"type"=>"x-email", "url"=>"sales@gettyimages.com"}, {"type"=>"x-email", "url"=>"copyright@gettyimages.com"}, {"type"=>"x-embeddable", "url"=>"https://github.com/gettyimages/connect#oembed"}, {"type"=>"x-forum", "url"=>"http://api.gettyimages.com/forum"}, {"type"=>"x-getting-started", "url"=>"https://github.com/gettyimages/connect#getting-started"}, {"type"=>"x-github", "url"=>"https://github.com/gettyimages"}, {"type"=>"x-java-sdk", "url"=>"https://github.com/gettyimages/connect_sdk_java"}, {"type"=>"x-node-js-sdk", "url"=>"https://github.com/gettyimages/connect_sdk_nodejs"}, {"type"=>"x-objectivec-sdk", "url"=>"https://github.com/gettyimages/connect_sdk_objective-c"}, {"type"=>"x-php-sdk", "url"=>"https://github.com/gettyimages/connect_sdk_php"}, {"type"=>"x-pricing", "url"=>"http://www.gettyimages.com/subscribe"}, {"type"=>"x-ruby-sdk", "url"=>"https://github.com/gettyimages/connect_sdk_ruby"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/GettyImages"}, {"type"=>"x-website", "url"=>"http://www.gettyimages.com/"}, {"type"=>"x-website", "url"=>"http://gettyimages.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
mailjet{"mailjet-messages-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Mailjet", "x-complete"=>1, "info"=>{"title"=>"Mailjet Messages API", "description"=>"allows-you-to-list-and-view-the-details-of-a-message-an-email-processed-by-mailjet", "version"=>"v3"}, "host"=>"api.mailjet.com", "basePath"=>"v3/REST/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"message/"=>{"get"=>{"summary"=>"Message List", "description"=>"Allows you to list messages.", "operationId"=>"getMessage", "x-api-path-slug"=>"message-get", "parameters"=>[{"in"=>"query", "name"=>"Campaign", "description"=>"Only retrieve message resources for which Campaign ID equals the specified value"}, {"in"=>"query", "name"=>"Contact", "description"=>"Only retrieve message resources for which Contact ID equals the specified value"}, {"in"=>"query", "name"=>"MessageState", "description"=>"Only show messages with this state"}, {"in"=>"query", "name"=>"PlanSubscription", "description"=>"Only retrieve message resources for which PlanSubscription ID equals the specified value"}, {"in"=>"query", "name"=>"Sender", "description"=>"Only show messages from this sender"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "List"]}}, "messagehistory/"=>{"get"=>{"summary"=>"Message History", "description"=>"List message history resources", "operationId"=>"getMessagehistory", "x-api-path-slug"=>"messagehistory-get", "parameters"=>[{"in"=>"path", "name"=>"Message", "description"=>"ID of message for which to show the history"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "History"]}}, "messagehistory/{id}"=>{"get"=>{"summary"=>"Message History", "description"=>"Get the history of a message.", "operationId"=>"getMessagehistory", "x-api-path-slug"=>"messagehistoryid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the message history"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "History"]}}, "messageinformation/"=>{"get"=>{"summary"=>"Message Information", "description"=>"Lists the information about a message.", "operationId"=>"getMessageinformation", "x-api-path-slug"=>"messageinformation-get", "parameters"=>[{"in"=>"query", "name"=>"CampaignID", "description"=>"Unique numerical ID for this object"}, {"in"=>"query", "name"=>"CampaignStatus", "description"=>"Only retrieve campaigns with status equal to specified value"}, {"in"=>"query", "name"=>"ContactsList", "description"=>"Only retrieve campaigns sent to specified Contacts list"}, {"in"=>"query", "name"=>"CustomCampaign", "description"=>"Only retrieve campaigns with given Custom Value"}, {"in"=>"query", "name"=>"From", "description"=>"Only retrieve campaigns with given From header"}, {"in"=>"query", "name"=>"FromDomain", "description"=>"Only retrieve campaigns with given domain in From header"}, {"in"=>"query", "name"=>"FromID", "description"=>"Only retrieve campaigns with this sender ID"}, {"in"=>"query", "name"=>"FromTS", "description"=>"Only retrieve campaigns with SendStartAt after this timestamp"}, {"in"=>"query", "name"=>"FromType", "description"=>"Only retrieve campaigns with FromType equal to specified value"}, {"in"=>"query", "name"=>"IsDeleted", "description"=>"Only retrieve campaigns where isDeleted matches the specified value"}, {"in"=>"query", "name"=>"IsNewsletterTool", "description"=>"Only retrieve campaigns which were started by the newsletter tool"}, {"in"=>"query", "name"=>"IsStarred", "description"=>"Only retrieve campaigns which were marked as starred"}, {"in"=>"query", "name"=>"MessageStatus", "description"=>"Only retrieve messages with status equal to specified value"}, {"in"=>"query", "name"=>"Period", "description"=>"Set FromTS and ToTS timestamps to beginning of indicated period and current timestamp, respectively"}, {"in"=>"query", "name"=>"ToTS", "description"=>"Only retrieve campaigns with SendStartAt timestamp less than the specified value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Information"]}}, "messageinformation/{id}"=>{"get"=>{"summary"=>"Message Information", "description"=>"Lists a message informaiton.", "operationId"=>"getMessageinformation", "x-api-path-slug"=>"messageinformationid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Information"]}}, "messagesentstatistics/"=>{"get"=>{"summary"=>"Message Statistics", "description"=>"Lists the message statistics.", "operationId"=>"getMessagesentstatistics", "x-api-path-slug"=>"messagesentstatistics-get", "parameters"=>[{"in"=>"query", "name"=>"AllMessages", "description"=>"Retrieve all messages"}, {"in"=>"query", "name"=>"CampaignID", "description"=>"Unique numerical ID for this object"}, {"in"=>"query", "name"=>"CampaignStatus", "description"=>"Only retrieve campaigns with Status equal to specified value"}, {"in"=>"query", "name"=>"Contact", "description"=>"Only retrieve messagesentstatistics resources for which Contact equals the specified value"}, {"in"=>"query", "name"=>"ContactsList", "description"=>"Only retrieve campaigns sent to specified Contacts list"}, {"in"=>"query", "name"=>"CustomCampaign", "description"=>"Only retrieve campaigns with given Custom Value"}, {"in"=>"query", "name"=>"From", "description"=>"Only retrieve campaigns with given From header"}, {"in"=>"query", "name"=>"FromDomain", "description"=>"Only retrieve campaigns with given domain in From header"}, {"in"=>"query", "name"=>"FromID", "description"=>"Only retrieve campaigns with this sender ID"}, {"in"=>"query", "name"=>"FromTS", "description"=>"Only retrieve campaigns with SendStartAt after this timestamp"}, {"in"=>"query", "name"=>"FromType", "description"=>"Only retrieve campaigns with FromType equal to specified value"}, {"in"=>"query", "name"=>"IsDeleted", "description"=>"Only retrieve campaigns where isDeleted matches the specified value"}, {"in"=>"query", "name"=>"IsNewsletterTool", "description"=>"Only retrieve campaigns which were started by the newsletter tool"}, {"in"=>"query", "name"=>"IsStarred", "description"=>"Only retrieve campaigns which were marked as starred"}, {"in"=>"query", "name"=>"MessageStatus", "description"=>"Only retrieve messages with Status equal to specified value"}, {"in"=>"query", "name"=>"Period", "description"=>"Set FromTS and ToTS timestamps to beginning of indicated period and current timestamp, respectively"}, {"in"=>"query", "name"=>"ShowExtraData", "description"=>"[ Type TBooleanFilter ]"}, {"in"=>"query", "name"=>"ToTS", "description"=>"Only retrieve campaigns with SendStartAt timestamp less than the specified value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Statistics"]}}, "messagesentstatistics/{id}"=>{"get"=>{"summary"=>"Message Statistics", "description"=>"List message statistics.", "operationId"=>"getMessagesentstatistics", "x-api-path-slug"=>"messagesentstatisticsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Statistics"]}}, "messagestate/{id}"=>{"get"=>{"summary"=>"Message State", "description"=>"Returns message state.", "operationId"=>"getMessagestate", "x-api-path-slug"=>"messagestateid-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"Id of the message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "State"]}}, "messagestatistics/"=>{"get"=>{"summary"=>"Message Statistics", "description"=>"Message Statistics", "operationId"=>"getMessagestatistics", "x-api-path-slug"=>"messagestatistics-get", "parameters"=>[{"in"=>"query", "name"=>"CampaignID", "description"=>"Unique numerical ID for this object"}, {"in"=>"query", "name"=>"CampaignStatus", "description"=>"Only retrieve campaigns with status equal to specified value"}, {"in"=>"query", "name"=>"ContactEmail", "description"=>"Only retrieve message statistics for this contact email address"}, {"in"=>"query", "name"=>"ContactID", "description"=>"Unique numerical ID for this object"}, {"in"=>"query", "name"=>"ContactListID", "description"=>"[ Type Int64 ]"}, {"in"=>"query", "name"=>"CustomCampaign", "description"=>"Only retrieve campaigns with given Custom Value"}, {"in"=>"query", "name"=>"From", "description"=>"Only retrieve campaigns with given From header"}, {"in"=>"query", "name"=>"FromDomain", "description"=>"Only retrieve campaigns with given domain in From header"}, {"in"=>"query", "name"=>"FromID", "description"=>"Only retrieve campaigns with this sender ID"}, {"in"=>"query", "name"=>"FromTS", "description"=>"Only retrieve campaigns with SendStartAt after this timestamp"}, {"in"=>"query", "name"=>"FromType", "description"=>"Only retrieve campaigns with FromType equal to specified value"}, {"in"=>"query", "name"=>"IsDeleted", "description"=>"Only retrieve campaigns where isDeleted matches the specified value"}, {"in"=>"query", "name"=>"IsNewsletterTool", "description"=>"Only retrieve campaigns which were started by the newsletter tool"}, {"in"=>"query", "name"=>"IsStarred", "description"=>"Only retrieve campaigns which were marked as starred"}, {"in"=>"query", "name"=>"MessageStatus", "description"=>"Only retrieve messages with status equal to specified value"}, {"in"=>"query", "name"=>"Period", "description"=>"Set FromTS and ToTS timestamps to beginning of indicated period and current timestamp, respectively"}, {"in"=>"query", "name"=>"ToTS", "description"=>"Only retrieve campaigns with SendStartAt timestamp less than the specified value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Statistics"]}}, "messagestatistics/{id}"=>{"get"=>{"summary"=>"Message Statistics", "description"=>"Message Statistics", "operationId"=>"getMessagestatistics", "x-api-path-slug"=>"messagestatisticsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Statistics"]}}, "message{id}"=>{"get"=>{"summary"=>"Message Detail", "description"=>"View the details of a message.", "operationId"=>"getMessage", "x-api-path-slug"=>"messageid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Message ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Detail"]}}}}, "apis"=>{"name"=>"Mailjet", "x-slug"=>"mailjet", "description"=>"Streamline your emailing and boost your sales with Mailjet. We serve all your email and SMS needs with one simple and powerful solution. You can try it now with 6000 emails/mo absolutely free. Sign up now, or read more about how we can help your busine...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/843-mailjet.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"20242", "tags"=>"API Provider,Campaign,Cloud,Emails,Emails,Getting Started Example,internet,Marketing,Messages,Metrics,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"mailjet/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Mailjet Messages API", "x-api-slug"=>"mailjet-messages-api", "description"=>"Mailjet is a real-time Cloud Emailing platform: scalable, agile and flexible! Our unique algorithm boosts your deliverability and our platform provides in-depth insight so you can optimize more than ever. Because 20% of emails never reach the inbox Mailjet is a logical choice! Communication to and from our API is done through HTTP(S) GET and POST queries. We support different formats to choose from depending on your affinities : JSON, XML, serialized PHP, and CSV for some export functions. You can access our API from almost any programming language, and in just a few minutes with our plug and play libraries.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/843-mailjet.jpg", "humanURL"=>"http://mailjet.com", "baseURL"=>"https://api.mailjet.com/v3/REST/", "tags"=>"API Provider,Campaign,Cloud,Emails,Emails,Getting Started Example,internet,Marketing,Messages,Metrics,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/mailjet/messageid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/mailjet/mailjet-messages-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.mailjet.com/"}, {"type"=>"x-blog", "url"=>"http://blog.mailjet.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.mailjet.com/rss"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/mailjet"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/mailjet"}, {"type"=>"x-developer", "url"=>"http://dev.mailjet.com/"}, {"type"=>"x-documentation", "url"=>"http://www.mailjet.com/support"}, {"type"=>"x-email", "url"=>"abuse@mailjet.com"}, {"type"=>"x-email", "url"=>"privacy@mailjet.com"}, {"type"=>"x-email", "url"=>"dfayed@mailjet.com"}, {"type"=>"x-getting-started", "url"=>"http://www.mailjet.com/signup"}, {"type"=>"x-github", "url"=>"https://github.com/mailjet"}, {"type"=>"x-java-sdk", "url"=>"https://github.com/mailjet/mailjet-apiv3-java"}, {"type"=>"x-joomla-pdk", "url"=>"https://github.com/mailjet/joomla-mailjet-plugin-apiv3"}, {"type"=>"x-logos", "url"=>"http://www.mailjet.com/assets"}, {"type"=>"x-magento-pdk", "url"=>"https://github.com/mailjet/magento-mailjet-plugin-apiv3"}, {"type"=>"x-node-js-sdk", "url"=>"https://github.com/mailjet/node-mailjet"}, {"type"=>"x-partners", "url"=>"http://www.mailjet.com/partners"}, {"type"=>"x-php-sdk", "url"=>"https://github.com/mailjet/mailjet-apiv3-php-simple"}, {"type"=>"x-pricing", "url"=>"http://www.mailjet.com/pricing_v3"}, {"type"=>"x-python-sdk", "url"=>"https://github.com/mailjet/python-mailjet"}, {"type"=>"x-ruby-sdk", "url"=>"https://github.com/mailjet/mailjet-gem"}, {"type"=>"x-status", "url"=>"https://mailjet.statuspage.io/"}, {"type"=>"x-terms-of-service", "url"=>"http://dev.mailjet.com/terms_of_service"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/mailjet"}, {"type"=>"x-website", "url"=>"http://mailjet.com"}, {"type"=>"x-website", "url"=>"http://www.mailjet.com"}, {"type"=>"x-white-papers", "url"=>"http://www.mailjet.com/white-paper"}, {"type"=>"x-wordpress-pdk", "url"=>"https://github.com/mailjet/wordpress-mailjet-plugin-apiv3"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
flowroute{"flowroute-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Flowroute", "x-complete"=>1, "info"=>{"title"=>"Flowroute APIs", "description"=>"the-flowroute-apis-are-organized-around-rest--our-apis-have-resourceoriented-urls-support-http-verbs-and-respond-with-http-status-codes--all-api-requests-and-responses-including-errors-will-be-represented-as-json-objects--you-can-use-the-flowroute-apis-to-manage-your-flowroute-phone-numbers-including-setting-primary-and-failover-routes-for-inbound-calls-and-sending-text-messages-sms-and-mms-using-longcode-or-tollfree-numbers-in-your-account-", "version"=>"1.0.0"}, "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v2.1/messages"=>{"post"=>{"summary"=>"Send a Message", "description"=>"Sends an SMS or MMS from a Flowroute long code or toll-free phone number to another valid phone number.", "operationId"=>"sends-an-sms-or-mms-from-a-flowroute-long-code-or-tollfree-phone-number-to-another-valid-phone-numbe", "x-api-path-slug"=>"v2-1messages-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Send", "Message"]}, "get"=>{"summary"=>"Look Up a Set of Messages", "description"=>"Retrieves a list of Message Detail Records (MDRs) within a specified date range. Date and time is based on Coordinated Universal Time (UTC).", "operationId"=>"retrieves-a-list-of-message-detail-records-mdrs-within-a-specified-date-range-date-and-time-is-based", "x-api-path-slug"=>"v2-1messages-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"The ending date and time, in UTC, on which to perform an MDR search"}, {"in"=>"query", "name"=>"limit", "description"=>"The number of MDRs to retrieve at one time"}, {"in"=>"query", "name"=>"offset", "description"=>"The number of MDRs to skip when performing a query"}, {"in"=>"query", "name"=>"start_date", "description"=>"The beginning date and time, in UTC, on which to perform an MDR search"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Look", "Up", "Set", "Of", "Messages"]}}, "/v2.1/messages/{id}"=>{"get"=>{"summary"=>"Look Up a Message Detail Record", "description"=>"Searches for a specific message record ID and returns a Message Detail Record (in MDR2 format).", "operationId"=>"searches-for-a-specific-message-record-id-and-returns-a-message-detail-record-in-mdr2-format", "x-api-path-slug"=>"v2-1messagesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The unique message detail record identifier (MDR ID) of any message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Look", "Up", "Message", "Detail", "Record"]}}, "/v2/numbers"=>{"get"=>{"summary"=>"Account Phone Numbers", "description"=>"Returns a list of all phone numbers currently on your Flowroute account. The response includes details such as the phone number's rate center, state, number type, and whether CNAM Lookup is enabled for that number.", "operationId"=>"returns-a-list-of-all-phone-numbers-currently-on-your-flowroute-account-the-response-includes-detail", "x-api-path-slug"=>"v2numbers-get", "parameters"=>[{"in"=>"query", "name"=>"contains", "description"=>"Retrieves phone numbers containing the specified value"}, {"in"=>"query", "name"=>"ends_with", "description"=>"Retrieves phone numbers that end with the specified value"}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of items to retrieve"}, {"in"=>"query", "name"=>"offset", "description"=>"Offsets the list of phone numbers by your specified value"}, {"in"=>"query", "name"=>"starts_with", "description"=>"Retrieves phone numbers that start with the specified value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Account", "Phone", "Numbers"]}}, "/v2/numbers/{id}"=>{"get"=>{"summary"=>"Phone Number Details", "description"=>"Lists all of the information associated with any of the phone numbers in your account, including billing method, primary voice route, and failover voice route.", "operationId"=>"lists-all-of-the-information-associated-with-any-of-the-phone-numbers-in-your-account-including-bill", "x-api-path-slug"=>"v2numbersid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Phone number to search for which must be a number that you own"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Phone", "Number", "Details"]}, "post"=>{"summary"=>"Purchase a Phone Number", "description"=>"Lets you purchase a phone number from available Flowroute inventory.", "operationId"=>"lets-you-purchase-a-phone-number-from-available-flowroute-inventory", "x-api-path-slug"=>"v2numbersid-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Phone number to purchase"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Purchase", "Phone", "Number"]}}, "/v2/numbers/available"=>{"get"=>{"summary"=>"Search for Purchasable Phone Numbers", "description"=>"This endpoint lets you search for phone numbers by state or rate center, or by your specified search value.", "operationId"=>"this-endpoint-lets-you-search-for-phone-numbers-by-state-or-rate-center-or-by-your-specified-search-", "x-api-path-slug"=>"v2numbersavailable-get", "parameters"=>[{"in"=>"query", "name"=>"contains", "description"=>"Retrieve phone numbers containing the specified value"}, {"in"=>"query", "name"=>"ends_with", "description"=>"Retrieve phone numbers that end with the specified value"}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of items to retrieve"}, {"in"=>"query", "name"=>"offset", "description"=>"Offsets the list of phone numbers by your specified value"}, {"in"=>"query", "name"=>"rate_center", "description"=>"Filters by and displays phone numbers in the specified case-insensitive abbreviated rat e center, not the full name as differentiated in the NPA Rate Center Reports"}, {"in"=>"query", "name"=>"starts_with", "description"=>"Retrieve phone numbers that start with the specified value"}, {"in"=>"query", "name"=>"state", "description"=>"Filters by and displays phone numbers in the specified case-insensitive abbreviated rat e center, not the full name as differentiated in the NPA Rate Center Reports"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "SearchPurchasable", "Phone", "Numbers"]}}, "/v2/numbers/available/areacodes"=>{"get"=>{"summary"=>"List Available Area Codes", "description"=>"Returns a list of all Numbering Plan Area (NPA) codes containing purchasable phone numbers.", "operationId"=>"returns-a-list-of-all-numbering-plan-area-npa-codes-containing-purchasable-phone-numbers", "x-api-path-slug"=>"v2numbersavailableareacodes-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limits the number of items to retrieve"}, {"in"=>"query", "name"=>"max_setup_cost", "description"=>"Restricts the results to area codes that include at least one telephone number with a setup fee below or equal to the specified max_setup_cost"}, {"in"=>"query", "name"=>"offset", "description"=>"Offsets the list of phone numbers by your specified value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "List", "Available", "Area", "Codes"]}}, "/v2/numbers/available/exchanges"=>{"get"=>{"summary"=>"List Available Exchange Codes", "description"=>"Returns a list of all Central Office (exchange) codes containing purchasable phone numbers.", "operationId"=>"returns-a-list-of-all-central-office-exchange-codes-containing-purchasable-phone-numbers", "x-api-path-slug"=>"v2numbersavailableexchanges-get", "parameters"=>[{"in"=>"query", "name"=>"areacode", "description"=>"Restricts the results to the specified area code"}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of items to retrieve"}, {"in"=>"query", "name"=>"max_setup_cost", "description"=>"Restricts the results to exchanges that include at least one telephone number with a setup fee below or equal to the specified max_setup_cost"}, {"in"=>"query", "name"=>"offset", "description"=>"Offsets the list of phone numbers by your specified value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "List", "Available", "Exchange", "Codes"]}}, "/v2/numbers/{number_id}/relationships/primary_route"=>{"patch"=>{"summary"=>"Update Primary Voice Route for a Phone Number", "description"=>"Use this endpoint to update the primary voice route for a phone number. You must create the route first by following \"Create an Inbound Route\". You can then assign the created route by specifying its value in a PATCH request.", "operationId"=>"use-this-endpoint-to-update-the-primary-voice-route-for-a-phone-number-you-must-create-the-route-fir", "x-api-path-slug"=>"v2numbersnumber-idrelationshipsprimary-route-patch", "parameters"=>[{"in"=>"path", "name"=>"number_id", "description"=>"The phone number in E"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Primary", "Voice", "Routea", "Phone", "Number"]}}, "/v2/numbers/{number_id}/relationships/failover_route"=>{"patch"=>{"summary"=>"Update Failover Voice Route for a Phone Number", "description"=>"Use this endpoint to update the failover voice route for a phone number. You must create the route first by following \"Create an Inbound Route\". You can then assign the created route by specifying its value in a PATCH request.", "operationId"=>"use-this-endpoint-to-update-the-failover-voice-route-for-a-phone-number-you-must-create-the-route-fi", "x-api-path-slug"=>"v2numbersnumber-idrelationshipsfailover-route-patch", "parameters"=>[{"in"=>"path", "name"=>"number_id", "description"=>"The phone number in E"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Failover", "Voice", "Routea", "Phone", "Number"]}}, "/v2/routes"=>{"post"=>{"summary"=>"Create an Inbound Route", "description"=>"Creates a new inbound route which can then be associated with phone numbers. Please see \"List Inbound Routes\" to review the route values that you can associate with your Flowroute phone numbers.", "operationId"=>"creates-a-new-inbound-route-which-can-then-be-associated-with-phone-numbers-please-see-list-inbound-", "x-api-path-slug"=>"v2routes-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Inbound", "Route"]}, "get"=>{"summary"=>"List Inbound Routes", "description"=>"Returns a list of your inbound routes. From the list, you can then select routes to use as the primary and failover routes for a phone number, which you can do via \"Update Primary Voice Route for a Phone Number\" and \"Update Failover Voice Route for a Phone Number\".", "operationId"=>"returns-a-list-of-your-inbound-routes-from-the-list-you-can-then-select-routes-to-use-as-the-primary", "x-api-path-slug"=>"v2routes-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limits the number of routes to retrieve"}, {"in"=>"query", "name"=>"offset", "description"=>"Offsets the list of routes by your specified value"}, {"in"=>"query", "name"=>"route_type", "description"=>"Restricts the results to inbound routes with your specified route type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "List", "Inbound", "Routes"]}}}}, "apis"=>{"name"=>"Flowroute", "x-slug"=>"flowroute", "description"=>"Flowroute is the leading provider of cloud-based communications and is based in Seattle, Washington.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28795-developer-flowroute-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"235018", "tags"=>"ISP,Messages,Technology,Telecommunications", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"flowroute/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"FlowRoute API", "x-api-slug"=>"flowroute-api", "description"=>"Flowroute is the leading provider of cloud-based communications and is based in Seattle, Washington.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28795-developer-flowroute-com.jpg", "humanURL"=>"http://developer.flowroute.com", "baseURL"=>"https:////", "tags"=>"ISP,Messages,Technology,Telecommunications", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/flowroute/v2routes-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/flowroute/flowroute-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-github", "url"=>"https://github.com/flowroute"}, {"type"=>"x-openapi", "url"=>"https://raw.githubusercontent.com/flowroute/flowroute-sdk-v3-dot-net/master/swagger_specs/Flowroute_API_01172018.json"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/flowroute"}, {"type"=>"x-email", "url"=>"legal@flowroute.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/flowroute"}, {"type"=>"x-website", "url"=>"http://developer.flowroute.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-key-management-service{"google-cloud-key-management-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Key Management Service", "x-complete"=>1, "info"=>{"title"=>"Google Cloud Key Management Service (KMS)", "description"=>"manages-encryption-for-your-cloud-services-the-same-way-you-do-onpremise--you-can-generate-use-rotate-and-destroy-aes256-encryption-keys-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"cloudkms.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/{name}"=>{"get"=>{"summary"=>"Get Key", "description"=>"Returns metadata for a given CryptoKeyVersion.", "operationId"=>"cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get", "x-api-path-slug"=>"v1name-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the CryptoKeyVersion to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key"]}, "patch"=>{"summary"=>"Update Key", "description"=>"Update a CryptoKeyVersion's metadata.\n\nstate may be changed between\nENABLED and\nDISABLED using this\nmethod. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to\nmove between other states.", "operationId"=>"cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch", "x-api-path-slug"=>"v1name-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"Output only"}, {"in"=>"query", "name"=>"updateMask", "description"=>"Required list of fields to be updated in this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key"]}}, "/v1/{name}/locations"=>{"get"=>{"summary"=>"Get Locations", "description"=>"Lists information about the supported locations for this service.", "operationId"=>"cloudkms.projects.locations.list", "x-api-path-slug"=>"v1namelocations-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"The standard list filter"}, {"in"=>"path", "name"=>"name", "description"=>"The resource that owns the locations collection, if applicable"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The standard list page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The standard list page token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Location"]}}, "/v1/{name}:decrypt"=>{"post"=>{"summary"=>"Decrypt Data", "description"=>"Decrypt data that was protected by Encrypt.", "operationId"=>"cloudkms.projects.locations.keyRings.cryptoKeys.decrypt", "x-api-path-slug"=>"v1namedecrypt-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Location"]}}, "/v1/{name}:destroy"=>{"post"=>{"summary"=>"Destroy Key", "description"=>"Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process.", "operationId"=>"cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy", "x-api-path-slug"=>"v1namedestroy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The resource name of the CryptoKeyVersion to destroy"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key"]}}, "/v1/{name}:encrypt"=>{"post"=>{"summary"=>"Encrypt Data", "description"=>"Encrypt data, so that it can only be recovered by a call to Decrypt.", "operationId"=>"cloudkms.projects.locations.keyRings.cryptoKeys.encrypt", "x-api-path-slug"=>"v1nameencrypt-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Encryption"]}}, "/v1/{name}:restore"=>{"post"=>{"summary"=>"Restore Key", "description"=>"Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared.", "operationId"=>"cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore", "x-api-path-slug"=>"v1namerestore-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The resource name of the CryptoKeyVersion to restore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key"]}}, "/v1/{name}:updatePrimaryVersion"=>{"post"=>{"summary"=>"Update Version", "description"=>"Update the version of a CryptoKey that will be used in Encrypt", "operationId"=>"cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion", "x-api-path-slug"=>"v1nameupdateprimaryversion-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The resource name of the CryptoKey to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version"]}}, "/v1/{parent}/cryptoKeyVersions"=>{"get"=>{"summary"=>"List Key Versions", "description"=>"Lists CryptoKeyVersions.", "operationId"=>"cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list", "x-api-path-slug"=>"v1parentcryptokeyversions-get", "parameters"=>[{"in"=>"query", "name"=>"pageSize", "description"=>"Optional limit on the number of CryptoKeyVersions toinclude in the response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Optional pagination token, returned earlier viaListCryptoKeyVersionsResponse"}, {"in"=>"path", "name"=>"parent", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key Version"]}, "post"=>{"summary"=>"Create Key Version", "description"=>"Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.", "operationId"=>"cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create", "x-api-path-slug"=>"v1parentcryptokeyversions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"parent", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key Version"]}}, "/v1/{parent}/cryptoKeys"=>{"get"=>{"summary"=>"List Keys", "description"=>"Lists CryptoKeys.", "operationId"=>"cloudkms.projects.locations.keyRings.cryptoKeys.list", "x-api-path-slug"=>"v1parentcryptokeys-get", "parameters"=>[{"in"=>"query", "name"=>"pageSize", "description"=>"Optional limit on the number of CryptoKeys to include in theresponse"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Optional pagination token, returned earlier viaListCryptoKeysResponse"}, {"in"=>"path", "name"=>"parent", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key"]}, "post"=>{"summary"=>"Create Key", "description"=>"Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required.", "operationId"=>"cloudkms.projects.locations.keyRings.cryptoKeys.create", "x-api-path-slug"=>"v1parentcryptokeys-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"cryptoKeyId", "description"=>"Required"}, {"in"=>"path", "name"=>"parent", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key"]}}, "/v1/{parent}/keyRings"=>{"get"=>{"summary"=>"List Key Rings", "description"=>"Lists KeyRings.", "operationId"=>"cloudkms.projects.locations.keyRings.list", "x-api-path-slug"=>"v1parentkeyrings-get", "parameters"=>[{"in"=>"query", "name"=>"pageSize", "description"=>"Optional limit on the number of KeyRings to include in theresponse"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Optional pagination token, returned earlier viaListKeyRingsResponse"}, {"in"=>"path", "name"=>"parent", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key Ring"]}, "post"=>{"summary"=>"Create Key Ring", "description"=>"Create a new KeyRing in a given Project and Location.", "operationId"=>"cloudkms.projects.locations.keyRings.create", "x-api-path-slug"=>"v1parentkeyrings-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"keyRingId", "description"=>"Required"}, {"in"=>"path", "name"=>"parent", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key Ring"]}}, "/v1/{resource}:getIamPolicy"=>{"get"=>{"summary"=>"Get IAM Policy", "description"=>"Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", "operationId"=>"cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy", "x-api-path-slug"=>"v1resourcegetiampolicy-get", "parameters"=>[{"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM Policy"]}}, "/v1/{resource}:setIamPolicy"=>{"post"=>{"summary"=>"Set IAM Policy", "description"=>"Sets the access control policy on the specified resource. Replaces any\nexisting policy.", "operationId"=>"cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy", "x-api-path-slug"=>"v1resourcesetiampolicy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy is being specified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM Policy"]}}, "/v1/{resource}:testIamPermissions"=>{"post"=>{"summary"=>"Test IAM Permissions", "description"=>"Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "operationId"=>"cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions", "x-api-path-slug"=>"v1resourcetestiampermissions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy detail is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM Permission"]}}}}, "apis"=>{"name"=>"Google Cloud Key Management Service", "x-slug"=>"google-cloud-key-management-service", "description"=>"Cloud KMS is a cloud-hosted key management service that lets you manage encryption for your cloud services the same way you do on-premises. You can generate, use, rotate and destroy AES256 encryption keys. Cloud KMS is integrated with IAM and Cloud Audit Logging so that you can manage permissions on individual keys, and monitor how these are used. Use Cloud KMS to protect secrets and other sensitive data which you need to store in Google Cloud Platform.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/kms-lead.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Authentication,Google APIs,Management,Profiles,Relative Data,Security,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-key-management-service/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Key Management Service API", "x-api-slug"=>"google-cloud-key-management-service-api", "description"=>"Cloud KMS is a cloud-hosted key management service that lets you manage encryption for your cloud services the same way you do on-premises. You can generate, use, rotate and destroy AES256 encryption keys. Cloud KMS is integrated with IAM and Cloud Audit Logging so that you can manage permissions on individual keys, and monitor how these are used. Use Cloud KMS to protect secrets and other sensitive data which you need to store in Google Cloud Platform.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/kms-lead.png", "humanURL"=>"https://cloud.google.com/kms/", "baseURL"=>"://cloudkms.googleapis.com//", "tags"=>"API Provider,API Service Provider,Authentication,Google APIs,Management,Profiles,Relative Data,Security,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-key-management-service/google-cloud-key-management-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-log", "url"=>"https://cloud.google.com/kms/docs/release-notes"}, {"type"=>"x-code", "url"=>"https://cloud.google.com/kms/docs/reference/libraries"}, {"type"=>"x-concepts", "url"=>"https://cloud.google.com/kms/docs/concepts"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/kms/docs/quickstart"}, {"type"=>"x-how-to-guides", "url"=>"https://cloud.google.com/kms/docs/how-tos"}, {"type"=>"x-issues", "url"=>"https://cloud.google.com/kms/known-issues"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/kms/pricing"}, {"type"=>"x-rate-limits", "url"=>"https://cloud.google.com/kms/quota"}, {"type"=>"x-service-level-agreement", "url"=>"https://cloud.google.com/kms/sla"}, {"type"=>"x-support", "url"=>"https://cloud.google.com/kms/docs/support"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/kms/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
motaword{"mota-word-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"MotaWord", "x-complete"=>1, "info"=>{"title"=>"Mota Word", "description"=>"use-motaword-api-to-post-and-track-your-translation-projects-", "version"=>"alpha-0.1.0"}, "host"=>"api.motaword.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/"=>{"get"=>{"summary"=>"Available endpoints", "description"=>"The root endpoint will provide you a JSON Swagger definition.", "operationId"=>"getEndpoints", "x-api-path-slug"=>"get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/formats"=>{"get"=>{"summary"=>"Get a list of supported formats", "description"=>"Get a list of supported formats for documents, style guides and extensions.", "operationId"=>"getFormats", "x-api-path-slug"=>"formats-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Formats"]}}, "/glossary"=>{"get"=>{"summary"=>"Download the global glossary.", "description"=>"Download your corporate account's global glossary. This endpoint is available only for corporate account customers.", "operationId"=>"downloadGlobalGlossary", "x-api-path-slug"=>"glossary-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Glossary"]}, "post"=>{"summary"=>"Create or update the global glossary.", "description"=>"Update your corporate account's global glossary. This endpoint is available only for corporate account customers.", "operationId"=>"updateGlobalGlossary", "x-api-path-slug"=>"glossary-post", "parameters"=>[{"in"=>"formData", "name"=>"glossary", "description"=>"Glossary file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Glossary"]}}, "/languages"=>{"get"=>{"summary"=>"Get a list of supported languages", "description"=>"Get a list of supported languages.", "operationId"=>"getLanguages", "x-api-path-slug"=>"languages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Languages"]}}, "/me"=>{"get"=>{"summary"=>"Get your account information and summary.", "description"=>"Get your account information and summary..", "operationId"=>"getAccount", "x-api-path-slug"=>"me-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me"]}}, "/projects"=>{"get"=>{"summary"=>"Get a list of your projects", "description"=>"Get a list of your projects.", "operationId"=>"getProjects", "x-api-path-slug"=>"projects-get", "parameters"=>[{"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}, "post"=>{"summary"=>"Get a new quote", "description"=>"Create a new project", "operationId"=>"createProject", "x-api-path-slug"=>"projects-post", "parameters"=>[{"in"=>"formData", "name"=>"callback_url", "description"=>"Optional"}, {"in"=>"formData", "name"=>"custom", "description"=>"Optional"}, {"in"=>"formData", "name"=>"documents[]", "description"=>"Optional"}, {"in"=>"formData", "name"=>"glossaries[]", "description"=>"Optional"}, {"in"=>"formData", "name"=>"source_language"}, {"in"=>"formData", "name"=>"styleguides[]", "description"=>"Optional"}, {"in"=>"formData", "name"=>"target_languages[]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/projects/{id}"=>{"delete"=>{"summary"=>"Delete a project", "description"=>"Delete(cancel) a project.", "operationId"=>"deleteProject", "x-api-path-slug"=>"projectsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}, "get"=>{"summary"=>"Get single project", "description"=>"Get single project.", "operationId"=>"getProject", "x-api-path-slug"=>"projectsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}, "put"=>{"summary"=>"Update project language pairs", "description"=>"Update project language pairs.", "operationId"=>"updateProject", "x-api-path-slug"=>"projectsid-put", "parameters"=>[{"in"=>"formData", "name"=>"callback_url", "description"=>"Optional"}, {"in"=>"formData", "name"=>"custom", "description"=>"Optional"}, {"in"=>"path", "name"=>"id", "description"=>"Project ID"}, {"in"=>"formData", "name"=>"source_language"}, {"in"=>"formData", "name"=>"target_languages[]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/projects/{id}/callback/{actionType}"=>{"get"=>{"summary"=>"Trigger a call to your callback URL related to this project.", "description"=>"Trigger a call to your callback url related to this project..", "operationId"=>"triggerCallback", "x-api-path-slug"=>"projectsidcallbackactiontype-get", "parameters"=>[{"in"=>"path", "name"=>"actionType", "description"=>"Callback type"}, {"in"=>"path", "name"=>"id", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Callback", "ActionType"]}}, "/projects/{id}/cancel"=>{"post"=>{"summary"=>"Cancel your translation project", "description"=>"Cancel your translation project.", "operationId"=>"cancelProject", "x-api-path-slug"=>"projectsidcancel-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Project ID"}, {"in"=>"formData", "name"=>"reason", "description"=>"Cancellation reason"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Cancel"]}}, "/projects/{id}/download"=>{"post"=>{"summary"=>"Download the latest translation package.", "description"=>"Download the latest translation package. You must have given a /package call beforehand and wait until the packaging status is 'completed'.", "operationId"=>"download", "x-api-path-slug"=>"projectsiddownload-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Download"]}}, "/projects/{id}/download/{language}"=>{"post"=>{"summary"=>"Download the latest translation package.", "description"=>"Download only the translation package of this language. You must have given a /package call beforehand and wait until the packaging status is 'completed'.", "operationId"=>"downloadLanguage", "x-api-path-slug"=>"projectsiddownloadlanguage-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Project ID"}, {"in"=>"path", "name"=>"language", "description"=>"Language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Download", "Language"]}}, "/projects/{id}/launch"=>{"post"=>{"summary"=>"Launch your translation project", "description"=>"Launch your translation project.", "operationId"=>"launchProject", "x-api-path-slug"=>"projectsidlaunch-post", "parameters"=>[{"in"=>"formData", "name"=>"budget_code", "description"=>"Optional with corporate accounts"}, {"in"=>"path", "name"=>"id", "description"=>"Project ID"}, {"in"=>"formData", "name"=>"payment_code", "description"=>"Optional"}, {"in"=>"formData", "name"=>"payment_method", "description"=>"Optional"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Launch"]}}, "/projects/{id}/package"=>{"post"=>{"summary"=>"Package the translation of all languages to be downloaded.", "description"=>"Package the translation project, make it ready to be downloaded.", "operationId"=>"package", "x-api-path-slug"=>"projectsidpackage-post", "parameters"=>[{"in"=>"query", "name"=>"async", "description"=>"If you want to package and download the translation synchronously, mark this parameter as 0"}, {"in"=>"path", "name"=>"id", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Package"]}}, "/projects/{id}/package/check"=>{"get"=>{"summary"=>"Track the status of translation packaging.", "description"=>"This request will tell you the current progress of the translation packaging. You will use the 'key' provided by the /package call.", "operationId"=>"trackPackage", "x-api-path-slug"=>"projectsidpackagecheck-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Project ID"}, {"in"=>"query", "name"=>"key", "description"=>"This is the package tracking key provided in the response of a /package call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Package", "Check"]}}, "/projects/{id}/package/{language}"=>{"post"=>{"summary"=>"Package the translation of a specific target language to be downloaded.", "description"=>"Package the translation of a specific target language to be downloaded..", "operationId"=>"packageLanguage", "x-api-path-slug"=>"projectsidpackagelanguage-post", "parameters"=>[{"in"=>"query", "name"=>"async", "description"=>"If you want to package and download the translation synchronously, mark this parameter as 0"}, {"in"=>"path", "name"=>"id", "description"=>"Project ID"}, {"in"=>"path", "name"=>"language", "description"=>"Language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Package", "Language"]}}, "/projects/{id}/progress"=>{"get"=>{"summary"=>"Get project progress", "description"=>"Get the progress of an already launched project.", "operationId"=>"getProgress", "x-api-path-slug"=>"projectsidprogress-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Progress"]}}, "/projects/{id}/reports"=>{"post"=>{"summary"=>"Submit reports for a project", "description"=>"Submit reports for a project.", "operationId"=>"submitProjectReports", "x-api-path-slug"=>"projectsidreports-post", "parameters"=>[{"in"=>"formData", "name"=>"activity_type", "description"=>"Activity Type"}, {"in"=>"path", "name"=>"id", "description"=>"Project ID"}, {"in"=>"formData", "name"=>"message", "description"=>"Report Message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Reports"]}}, "/projects/{projectId}/activities"=>{"get"=>{"summary"=>"Get a list of realtime activities.", "description"=>"Get a list of realtime activities on the project, such as translation suggestion and translation approval.", "operationId"=>"getActivities", "x-api-path-slug"=>"projectsprojectidactivities-get", "parameters"=>[{"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Activities"]}}, "/projects/{projectId}/activities/{activityId}"=>{"get"=>{"summary"=>"Get a single realtime activity.", "description"=>"Get a single realtime activity..", "operationId"=>"getActivity", "x-api-path-slug"=>"projectsprojectidactivitiesactivityid-get", "parameters"=>[{"in"=>"path", "name"=>"activityId", "description"=>"Activity ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Activities", "ActivityId"]}, "post"=>{"summary"=>"Submit a comment to an activity.", "description"=>"Submit a comment to an activity..", "operationId"=>"submitComment", "x-api-path-slug"=>"projectsprojectidactivitiesactivityid-post", "parameters"=>[{"in"=>"path", "name"=>"activityId", "description"=>"Activity ID"}, {"in"=>"formData", "name"=>"comment", "description"=>"Comment text"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Activities", "ActivityId"]}}, "/projects/{projectId}/activities/{activityId}/comments"=>{"get"=>{"summary"=>"Get a list of comments belonging to this activity.", "description"=>"Get a list of comments belonging to this activity..", "operationId"=>"getActivityComments", "x-api-path-slug"=>"projectsprojectidactivitiesactivityidcomments-get", "parameters"=>[{"in"=>"path", "name"=>"activityId", "description"=>"Activity ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Activities", "ActivityId", "Comments"]}}, "/projects/{projectId}/comments"=>{"get"=>{"summary"=>"Get a list of activity comments throughout the whole project.", "description"=>"Get a list of activity comments throughout the whole project..", "operationId"=>"getComments", "x-api-path-slug"=>"projectsprojectidcomments-get", "parameters"=>[{"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Comments"]}}, "/projects/{projectId}/documents"=>{"get"=>{"summary"=>"Get a list of documents", "description"=>"Get a list of documents.", "operationId"=>"getDocuments", "x-api-path-slug"=>"projectsprojectiddocuments-get", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Documents"]}, "post"=>{"summary"=>"Upload a new document", "description"=>"Upload a new document.", "operationId"=>"createDocument", "x-api-path-slug"=>"projectsprojectiddocuments-post", "parameters"=>[{"in"=>"formData", "name"=>"documents[]", "description"=>"You can add as many files as you want in documents[] parameter"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}, {"in"=>"formData", "name"=>"schemes[]", "description"=>"JSON string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Documents"]}}, "/projects/{projectId}/documents/{documentId}"=>{"delete"=>{"summary"=>"Delete the document", "description"=>"Delete the document.", "operationId"=>"deleteDocument", "x-api-path-slug"=>"projectsprojectiddocumentsdocumentid-delete", "parameters"=>[{"in"=>"path", "name"=>"documentId", "description"=>"Document ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Documents", "DocumentId"]}, "get"=>{"summary"=>"Get single document", "description"=>"Get single document.", "operationId"=>"getDocument", "x-api-path-slug"=>"projectsprojectiddocumentsdocumentid-get", "parameters"=>[{"in"=>"path", "name"=>"documentId", "description"=>"Document ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Documents", "DocumentId"]}, "put"=>{"summary"=>"Update the document.", "description"=>"Update the document. File name and contents will replaced with the new one.", "operationId"=>"updateDocument", "x-api-path-slug"=>"projectsprojectiddocumentsdocumentid-put", "parameters"=>[{"in"=>"path", "name"=>"documentId", "description"=>"Document ID"}, {"in"=>"formData", "name"=>"documents", "description"=>"Single file data"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}, {"in"=>"formData", "name"=>"schemes", "description"=>"JSON string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Documents", "DocumentId"]}}, "/projects/{projectId}/documents/{documentId}/download"=>{"get"=>{"summary"=>"Download a document", "description"=>"Download a document.", "operationId"=>"downloadDocument", "x-api-path-slug"=>"projectsprojectiddocumentsdocumentiddownload-get", "parameters"=>[{"in"=>"path", "name"=>"documentId", "description"=>"Document ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Documents", "DocumentId", "Download"]}}, "/projects/{projectId}/glossaries"=>{"get"=>{"summary"=>"Get a list of glossaries", "description"=>"Get a list of glossaries.", "operationId"=>"getGlossaries", "x-api-path-slug"=>"projectsprojectidglossaries-get", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Glossaries"]}, "post"=>{"summary"=>"Upload a new glossary", "description"=>"Upload a new glossary.", "operationId"=>"createGlossary", "x-api-path-slug"=>"projectsprojectidglossaries-post", "parameters"=>[{"in"=>"formData", "name"=>"glossaries", "description"=>"You can only add one glossary, even though the name suggests multiple glossaries"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Glossaries"]}}, "/projects/{projectId}/glossaries/{glossaryId}"=>{"delete"=>{"summary"=>"Delete the glossary", "description"=>"Delete the glossary.", "operationId"=>"deleteGlossary", "x-api-path-slug"=>"projectsprojectidglossariesglossaryid-delete", "parameters"=>[{"in"=>"path", "name"=>"glossaryId", "description"=>"Glossary ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Glossaries", "GlossaryId"]}, "get"=>{"summary"=>"Get single glossary", "description"=>"Get single glossary.", "operationId"=>"getGlossary", "x-api-path-slug"=>"projectsprojectidglossariesglossaryid-get", "parameters"=>[{"in"=>"path", "name"=>"glossaryId", "description"=>"Glossary ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Glossaries", "GlossaryId"]}, "put"=>{"summary"=>"Update the glossary.", "description"=>"Update the glossary. File name and contents will replaced with the new one.", "operationId"=>"updateGlossary", "x-api-path-slug"=>"projectsprojectidglossariesglossaryid-put", "parameters"=>[{"in"=>"formData", "name"=>"glossaries", "description"=>"Single file data"}, {"in"=>"path", "name"=>"glossaryId", "description"=>"Glossary ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Glossaries", "GlossaryId"]}}, "/projects/{projectId}/glossaries/{glossaryId}/download"=>{"get"=>{"summary"=>"Download a glossary", "description"=>"Download a glossary.", "operationId"=>"downloadGlossary", "x-api-path-slug"=>"projectsprojectidglossariesglossaryiddownload-get", "parameters"=>[{"in"=>"path", "name"=>"glossaryId", "description"=>"Glossary ID"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Glossaries", "GlossaryId", "Download"]}}, "/projects/{projectId}/styleguides"=>{"get"=>{"summary"=>"Get a list of style guides", "description"=>"Get a list of style guides.", "operationId"=>"getStyleGuides", "x-api-path-slug"=>"projectsprojectidstyleguides-get", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Styleguides"]}, "post"=>{"summary"=>"Upload a new style guide", "description"=>"Upload a new style guide.", "operationId"=>"createStyleGuide", "x-api-path-slug"=>"projectsprojectidstyleguides-post", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}, {"in"=>"formData", "name"=>"styleguides[]", "description"=>"You can add as many files as you want in styleguides[] parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Styleguides"]}}, "/projects/{projectId}/styleguides/{styleGuideId}"=>{"delete"=>{"summary"=>"Delete the style guide", "description"=>"Delete the style guide.", "operationId"=>"deleteStyleGuide", "x-api-path-slug"=>"projectsprojectidstyleguidesstyleguideid-delete", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}, {"in"=>"path", "name"=>"styleGuideId", "description"=>"Style Guide ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Styleguides", "StyleGuideId"]}, "get"=>{"summary"=>"Get single style guide", "description"=>"Get single style guide.", "operationId"=>"getStyleGuide", "x-api-path-slug"=>"projectsprojectidstyleguidesstyleguideid-get", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}, {"in"=>"path", "name"=>"styleGuideId", "description"=>"Style Guide ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Styleguides", "StyleGuideId"]}, "put"=>{"summary"=>"Update the style guide.", "description"=>"Update the style guide. File name and contents will replaced with the new one.", "operationId"=>"updateStyleGuide", "x-api-path-slug"=>"projectsprojectidstyleguidesstyleguideid-put", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}, {"in"=>"path", "name"=>"styleGuideId", "description"=>"Style guide ID"}, {"in"=>"formData", "name"=>"styleguides", "description"=>"Single file data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Styleguides", "StyleGuideId"]}}, "/projects/{projectId}/styleguides/{styleGuideId}/download"=>{"get"=>{"summary"=>"Download a style guide", "description"=>"Download a style guide.", "operationId"=>"downloadStyleGuide", "x-api-path-slug"=>"projectsprojectidstyleguidesstyleguideiddownload-get", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"Project ID"}, {"in"=>"path", "name"=>"styleGuideId", "description"=>"Style Guide ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "ProjectId", "Styleguides", "StyleGuideId", "Download"]}}, "/styleguide"=>{"get"=>{"summary"=>"Download the global style guide.", "description"=>"Download your corporate account's global style guide. This endpoint is available only for corporate account customers.", "operationId"=>"downloadGlobalStyleGuide", "x-api-path-slug"=>"styleguide-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Styleguide"]}, "post"=>{"summary"=>"Create or update the global style guide.", "description"=>"Update your corporate account's global style guide. This endpoint is available only for corporate account customers.", "operationId"=>"updateGlobalStyleGuide", "x-api-path-slug"=>"styleguide-post", "parameters"=>[{"in"=>"formData", "name"=>"styleguide", "description"=>"Style guide file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Styleguide"]}}, "/token"=>{"post"=>{"summary"=>"Retrieve an access token to interact with the API.", "description"=>"MotaWord API is using OAuth2 procedures when authenticating or authorizing your API call. Currently, we only allow Client Credential type flow.", "operationId"=>"getAccessToken", "x-api-path-slug"=>"token-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"HTTP Basic Authorization header"}, {"in"=>"formData", "name"=>"grant_type", "description"=>"OAuth2 grant type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token"]}}}}, "apis"=>{"name"=>"MotaWord", "x-slug"=>"motaword", "description"=>"MotaWord is the world’s fastest, lowest cost, cloud-based, collaborative business translation platform.MotaWord combines the efforts of talented human translators through the use of a cloud based translation platform. Our translators are able to login simultaneously into projects that fit their language combination and provide translation service collaboratively - while also seeing the whole content for contextual purposes. This ability to simultaneously utilize multiple translators makes MotaWord exceptionally fast and highly accurate.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/motaword-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,Profiles,Relative Data,Service API,Translations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"motaword/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Mota Word", "x-api-slug"=>"mota-word", "description"=>"MotaWord is the world’s fastest, lowest cost, cloud-based, collaborative business translation platform.MotaWord combines the efforts of talented human translators through the use of a cloud based translation platform. Our translators are able to login simultaneously into projects that fit their language combination and provide translation service collaboratively - while also seeing the whole content for contextual purposes. This ability to simultaneously utilize multiple translators makes MotaWord exceptionally fast and highly accurate.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/motaword-logo.png", "humanURL"=>"http://www.motaword.com", "baseURL"=>"https://api.motaword.com//", "tags"=>"API Provider,Profiles,Relative Data,Service API,Translations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/motaword/token-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/motaword/mota-word-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://www.motaword.com"}, {"type"=>"x-blog", "url"=>"https://www.motaword.com/developer/blog"}, {"type"=>"x-developer", "url"=>"https://www.motaword.com/developer"}, {"type"=>"x-github", "url"=>"https://github.com/motaword"}, {"type"=>"x-pricing", "url"=>"https://www.motaword.com/pricing"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/motaword"}, {"type"=>"x-website", "url"=>"http://motaword.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
here{"here-custom-location-extension-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"HERE", "x-complete"=>1, "info"=>{"title"=>"Custom Location Extension API", "description"=>"the-here-custom-location-extension-is-a-service-that-stores-and-retrieves-custom-locations-locations-can-be-uploaded-as-csv-files-or-shapefile-standard-compliant-shapes-via-an-administration-website-or-as-xml-files-via-http-post-requests-to-the-restful-api--locations-can-be-retrieved-by-making-an-http-get-requests-to-the-restful-api--the-custom-location-extension-api-provides-solutions-for-the-following-high-level-use-cases-store-custom-sets-of-locations-and-polygons-for-use-with-other-here-apis--perform-a-proximity-search-for-custom-points-of-interest-and-polygons-around-a-specified-location--retrieve-a-set-of-custom-points-of-interest-pois-andor-polygons-within-a-specified-bounding-box--find-all-custom-locations-and-polygons-within-an-isoline-route-result--find-all-custom-locations-and-polygons-within-a-specified-radius-of-a-defined-route--search-custom-indices-generated-from-multiple-fields-from-one-or-more-layers-this-example-set-works-with-version-1-7-7-or-higheradditional-information-can-be-found-on-developer-here-comhttpsdeveloper-here-complatformextensionsdocumentationcustomlocation", "version"=>"1.0.0"}, "host"=>"customlocation.cit.api.here.com", "basePath"=>"/v1/search", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/bbox"=>{"get"=>{"summary"=>"Find Locations within a Bounding Box", "description"=>"*Request a list of user-defined locations within a defined area*\n\nThe request uses the `bbox` endpoint, and the bounding box is specified by adding the `bbox` parameter to the request URL.\n\n\n\n* **layerId** `text`\n \\- Unique indicator used to retrieve a dataset\n\n* **bbox** `bbox`\n \\- Restricts results to be found within this bounding box\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"BboxGet2", "x-api-path-slug"=>"bbox-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"bbox"}, {"in"=>"query", "name"=>"layerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Locations", "Within", "Bounding", "Box"]}}, "/attribute"=>{"get"=>{"summary"=>"Filtering by Custom Attributes", "description"=>"*Request a list of user-defined locations based on their attribute values*\n\nAn attribute-based search is requested using the `attribute` endpoint and by adding the `query` parameter to the request URL.\n\n\n\n* **layerId** `text`\n \\- Unique indicator used to retrieve a dataset\n\n* **query** `text`\n \\- The query to retrieve\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"AttributeGet", "x-api-path-slug"=>"attribute-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"layerId"}, {"in"=>"query", "name"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filtering", "By", "Custom", "Attributes"]}}, "/proximity"=>{"get"=>{"summary"=>"Find the Five Nearest Locations", "description"=>"*Request a list of user-defined locations within a circle around a fixed point*\n\nThe search uses the `proximity` endpoint. The definition of the location and limit of the search is specified using `coord` and `radius` parameters, and the number of results returned limited by adding the `limit` parameter to the request URL.\n\n\n\n* **layerId** `text`\n \\- Unique indicator used to retrieve a dataset\n\n* **coord** `latlng`\n \\- Center of the proximity search\n\n* **radius** `number`\n \\- width of the search corridor\n\n* **limit** `number`\n \\- The limit of the number of items contained in the response.\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"ProximityGet2", "x-api-path-slug"=>"proximity-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"coord"}, {"in"=>"query", "name"=>"layerId"}, {"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"radius"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Five", "Nearest", "Locations"]}}, "/route/corridor"=>{"get"=>{"summary"=>"Find Locations along a pre-defined Route", "description"=>"*Request a list of user-defined locations along a pre-defined route*\n\nThe route has been pre-calculated and the `routeid` has already been acquired from a previous routing request. A route-based corridor search is requested using the `corridor` endpoint and by adding the `routeid` parameter to the request URL, along with a corridor `width`.\n\n\n\n* **layerId** `text`\n \\- Unique indicator used to retrieve a dataset\n\n* **routeId** `text`\n \\- A previously calculated routeId\n\n* **radius** `number`\n \\- Width of the search corridor\n\n* **limit** `number`\n \\- The limit of the number of items contained in the response.\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"RouteCorridorGet", "x-api-path-slug"=>"routecorridor-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"layerId"}, {"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"radius"}, {"in"=>"query", "name"=>"routeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Locations", "Along", "Pre-defined", "Route"]}}, "/corridor"=>{"get"=>{"summary"=>"Find Locations using Corridor", "description"=>"*Request a list of user-defined locations near to a given corridor*\n\nThe route corridor consists of a series of latitude, longitude pairs defining the waypoints of a route, along with a defined width. A corridor search is requested using the `corridor` endpoint and by adding a series of comma delimited latitude, longitude waypoints to the `route` parameter of the request URL, along with a `radius` for the search.\n\n\n\n* **layerId** `text`\n \\- Unique indicator used to retrieve a dataset\n\n* **route** `text`\n \\- A type of spatial filter. The corridor is defined by its path and width. The path is a line along the center of the corridor represented by a series of latitude/longitude pairs. Corridor width is given in meters.\n\n* **radius** `number`\n \\- width of the search corridor\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"CorridorGet", "x-api-path-slug"=>"corridor-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"layerId"}, {"in"=>"query", "name"=>"radius"}, {"in"=>"query", "name"=>"route"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Locations", "Using", "Corridor"]}}}}, "here-map-image-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"HERE", "x-complete"=>1, "info"=>{"title"=>"Map Image API", "description"=>"the-here-map-image-api-is-a-web-service-api-that-offers-easy-and-fast-access-to-static-map-images-for-all-regions-of-the-world--you-can-also-display-points-of-interest-and-enhance-maps-with-routes-turning-points-and-junction-views-or-additional-information-such-as-statistics-or-heat-maps-in-addition-the-api-offers-a-variety-of-supplementary-services-for-displaying-location-based-data--for-example-it-is-possible-to-present-roadsigns-this-example-set-works-with-version-1-6-36-1-or-higheradditional-information-can-be-found-on-developer-here-comhttpsdeveloper-here-comrestapisdocumentationenterprisemapimage", "version"=>"1.0.0"}, "host"=>"image.maps.cit.api.here.com", "basePath"=>"/mia/1.6", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/mapview"=>{"get"=>{"summary"=>"Map Image using Bounding Box", "description"=>"*Request an image of a map based around a given area*\n\nTo specify a bounding box, add the `bbox` parameter to the request URL. On desktop browsers, redirection to `here.com` will occur automatically unless the `nord` parameter is also added to URL.\n\n\n\n* **bbox** `text`\n \\- Bounding box of the map specifying the top-right and bottom left corners. e.g. `52.515,13.377,52.134,13.978`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"MapviewGet15", "x-api-path-slug"=>"mapview-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"bbox"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Map", "Image", "Using", "Bounding", "Box"]}}, "/route"=>{"get"=>{"summary"=>"Map Image with Polylines", "description"=>"*Request an image of a map including a polyline*\n\nIt supports also different map schemes, image sizes; image formats as \r\nwell as zooming out from automatically calculated zoom level.\n \n\n\n\n* **r0** `text`\n \\- List of coordinates describing the first route\n\n* **r1** `text`\n \\- List of coordinates describing the second route\n\n* **m0** `text`\n \\- First route marker on the map\n\n* **m1** `text`\n \\- Second route marker on the map\n\n* **lc0** `text`\n \\- Color of the first route line displayed on the map\n\n* **sc0** `text`\n \\- Shadow color of the first route line displayed on the map\n\n* **lw0** `number`\n \\- Width of the first route line displayed on the map\n\n* **lc1** `text`\n \\- Color of the second route line displayed on the map\n\n* **sc1** `text`\n \\- Shadow color of the second route line displayed on the map\n\n* **lw1** `number`\n \\- Width of the second route line displayed on the map\n\n* **w** `number`\n \\- Image width in pixels, maximum 2048.\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"RouteGet", "x-api-path-slug"=>"route-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"lc0"}, {"in"=>"query", "name"=>"lc1"}, {"in"=>"query", "name"=>"lw0"}, {"in"=>"query", "name"=>"lw1"}, {"in"=>"query", "name"=>"m0"}, {"in"=>"query", "name"=>"m1"}, {"in"=>"query", "name"=>"r0"}, {"in"=>"query", "name"=>"r1"}, {"in"=>"query", "name"=>"sc0"}, {"in"=>"query", "name"=>"sc1"}, {"in"=>"query", "name"=>"w"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Map", "Image", "Polylines"]}}}}, "here-traffic-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"HERE", "x-complete"=>1, "info"=>{"title"=>"Traffic API", "description"=>"the-here-traffic-api-is-a-restful-api-that-provides-traffic-flow-information-and-traffic-map-tiles-traffic-incident-datathe-api-provides-aggregated-information-about-traffic-incidents-in-xml-or-json-including-the-type-and-location-of-each-traffic-incident-status-whether-it-is-still-active-start-and-end-time-and-other-relevant-data-traffic-map-tile-overlays-traffic-tilesthe-traffic-api-delivers-prerendered-map-tile-overlays-with-traffic-information-ready-to-be-displayed-by-mapping-applications--you-can-request-map-tiles-that-show-traffic-data-for-a-specific-area-traffic-flow-datathe-service-offers-access-to-realtime-traffic-flow-data-in-xml-or-json-including-information-on-speed-and-congestion-for-the-regions-defined-in-each-request-and-can-deliver-additional-data-such-as-the-geometry-of-the-road-segments-to-which-the-flow-data-relate-traffic-flow-availabilitythe-service-allows-client-applications-to-access-the-general-traffic-information-either-specified-by-a-map-segment-defined-as-a-map-view-or-in-general-for-the-whole-world-without-the-map-view-this-example-set-works-with-version-6-0-41-1-or-higheradditional-information-can-be-found-on-developer-here-comhttpsdeveloper-here-comrestapisdocumentationtraffic", "version"=>"1.0.0"}, "host"=>"tiles.traffic.cit.api.here.com", "basePath"=>"/traffic/6.0/tiles/8/133/86/256", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/6.1/flow.json"=>{"get"=>{"summary"=>"Flow using Proximity returning Additional Attributes", "description"=>"*Request traffic flow information using proximity, returning shape and functional class*\n\nThe request is made through combining the `prox` parameter and the `responseattributes` in the request URL. The server also supports an XML response.\n\n\n\n* **prox** `prox`\n \\- A type of spatial filter. Proximity specifies a circle to search using a latitude, a longitude, and a radius in meters. e.g. `52.515,13.377,100`\n\n* **responseattributes** `multi-enum`\n \\- A list indicating optional information to be included in the traffic flow data response\n\n Valid values are : `fc` - functionalClass, `sh` - shape\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"61FlowJsonGet7", "x-api-path-slug"=>"6-1flow-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"prox"}, {"in"=>"query", "name"=>"responseattributes"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Flow", "Using", "Proximity", "Returning", "Itional", "Attributes"]}}, "/flowtile/newest/normal.day/15/16358/10898/256/png8"=>{"get"=>{"summary"=>"Transparent Traffic Map", "description"=>"*Request a transparent tile with traffic flow information*\n\nTo obtain a transparent map tile displaying traffic flow, use the `flowtile` parameter in the path of the request URL.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"FlowtileNewestNormalDay151635810898256Png8Get", "x-api-path-slug"=>"flowtilenewestnormal-day151635810898256png8-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transparent", "Traffic", "Map"]}}, "/png32"=>{"get"=>{"summary"=>"Transparent Traffic Map via TDA (to be deprecated)", "description"=>"*Request a transparent tile with traffic flow information*\n\nSupports custom coloring, functional class filters, DLR rendering, sub-segment traffic rendering.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"Png32Get", "x-api-path-slug"=>"png32-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transparent", "Traffic", "Map", "Via", "TDA", "(to", "Be", "Deprecated)"]}}, "/6.0/flowavailability.json"=>{"get"=>{"summary"=>"Traffic Flow Availability Data", "description"=>"*Flow availability requests allow you to see what traffic flow coverage exists in the current Traffic API.*\n\nThe Server also supports an XML response.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"60FlowavailabilityJsonGet", "x-api-path-slug"=>"6-0flowavailability-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic", "Flow", "Availability", "Data"]}}, "/traffictile/newest/normal.day/15/16358/10898/256/png8"=>{"get"=>{"summary"=>"Traffic Map", "description"=>"*Request a map tile with traffic flow information*\n\nTo obtain a traffic map tile, use the `traffictile` parameter in the path of the request URL.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"TraffictileNewestNormalDay151635810898256Png8Get", "x-api-path-slug"=>"traffictilenewestnormal-day151635810898256png8-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic", "Map"]}}, "/6.0/incidents.json"=>{"get"=>{"summary"=>"Traffic Incidents via Proximity", "description"=>"*Request traffic incident information within specified area*\n\nTraffic incidents can be retrieved through several different request types, based on the addressing schemes that they use to specify their geography. Traffic requests can be output to either XML or JSON format. API also supports filters to limit the amount of information provided in the response. Filters are based on on status, criticality, TMC table IDs, profiles, or start and end times, etc.\n\n\n\n* **prox** `prox`\n \\- A type of spatial filter. Proximity specifies a circle to search using a latitude, a longitude, and a radius in meters. e.g. `52.515,13.377,100`\n\n* **criticality** `multi-enum`\n \\- A filter that selects incident reports according to criticality, `0`=critical, `1`=major, `2`=minor, `3`=lowImpact\n\n Valid values are : `0` - critical, `1` - major, `2` - minor, `3` - lowImpact\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"60IncidentsJsonGet3", "x-api-path-slug"=>"6-0incidents-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"criticality"}, {"in"=>"query", "name"=>"prox"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic", "Incidents", "Via", "Proximity"]}}}}, "here-public-transit-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"HERE", "x-complete"=>1, "info"=>{"title"=>"Public Transport API", "description"=>"examples-for-public-transit-nlp-2-1-6-or-higher", "version"=>"1.0.0"}, "host"=>"cit.transit.api.here.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/search/by_name.json"=>{"get"=>{"summary"=>"Find Stations by Name", "description"=>"*Request a list of public transit stations based on name*\n\nA station search request can be made using the `search/by_name.json` endpoint and adding the `name` parameter. The focal point of the search is defined using the `x` and `y` parameters. The number of results can be further restricted by `max `and the `radius `parameters.\n \n\n\n\n* **x** `number`\n \\- The longitude of the center point of your search. e.g. `13.377`\n\n* **y** `number`\n \\- The latitude of the center point of your search. e.g. `52.515`\n\n* **name** `text`\n \\- Specifies the name or a part of the name of the station to search for and can be one word, multiple words or partial word separated by either comma or space.\n\n* **app_id** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **app_code** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **max** `number`\n \\- Specifies the maximum number of stations/stops included in the response.\n The minimum value is 1 and the maximum value is not limited.\n The default value is 5. \n\n* **method** `enum`\n \\- Specifies if the matching method is *fuzzy* or *strict*.\n The default value is *fuzzy*.\n * fuzzy - search for stations with the name having similar sounding and/or similar spelling to the names requested\n * strict - search for stations with the name exactly matching the names requested or contains it as its part.\n\n Valid values are : `fuzzy`, `strict`\n\n* **radius** `number`\n \\- Specifies a radius in meters when combined with a center point defines the area of the search. The minimum value is 0 and the maximum value is not limited.\n The default value is 20000km.", "operationId"=>"SearchByNameJsonGet", "x-api-path-slug"=>"searchby-name-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"max"}, {"in"=>"query", "name"=>"method"}, {"in"=>"query", "name"=>"name"}, {"in"=>"query", "name"=>"radius"}, {"in"=>"query", "name"=>"x"}, {"in"=>"query", "name"=>"y"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Stations", "By", "Name"]}}, "/metarouter/rest/routeservice/v2/route.json"=>{"get"=>{"summary"=>"Avoid Transit Routes Involving Transfers", "description"=>"*Request a direct public transit route excluding changes and transfers*\n\nPublic transit routes can be requested using the `metarouter/rest/routeservice/v2/route.json` endpoint. The `changes `parameter is used to indicate the number of changes or transfers desired. \n\n\n\n* **startX** `number`\n \\- The longitude of the start point of your journey. e.g. `13.377`\n\n* **startY** `number`\n \\- The latitude of the start point of your journey. e.g. `52.515`\n\n* **destX** `number`\n \\- The longitude of the destination point of your journey. e.g. `13.377`\n\n* **destY** `number`\n \\- The latitude of the destination point of your journey. e.g. `52.515`\n\n* **time** `text`\n \\- Time in format `yyyy-mm-ddThh:mm:ss`.\n\n* **app_id** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **app_code** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **routing** `enum`\n \\- Type of routing response required. tt: time-table routing, i.e. route response will show scheduled arrival/departure times of the transit at the stations. sr: simple (or estimated) routing, i.e. route response will only show \nthe transit journey but without scheduled arrival/departure times. all: for both estimated and time-table routing. Default: tt \n\n Valid values are : `tt`, `sr`, `all`\n\n* **changes** `enum`\n \\- Maximum number of changes or transfers. \n Valid values: 0-6 or -1. Default: -1 (any number of transfers permitted).\n\n >**NOTE:** In areas where this parameter is not supported the route response will show an attribute `sup_changes=0` in the `Connections` node.\n\n Valid values are : `-1`, `0`, `1`, `2`, `3`, `4`, `5`, `6`", "operationId"=>"MetarouterRestRouteserviceV2RouteJsonGet8", "x-api-path-slug"=>"metarouterrestrouteservicev2route-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"changes"}, {"in"=>"query", "name"=>"destX"}, {"in"=>"query", "name"=>"destY"}, {"in"=>"query", "name"=>"routing"}, {"in"=>"query", "name"=>"startX"}, {"in"=>"query", "name"=>"startY"}, {"in"=>"query", "name"=>"time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Avoid", "Transit", "Routes", "Involving", "Transfers"]}}, "/isochrone/v1/search.json"=>{"get"=>{"summary"=>"Reachability of an Area Within a Specific Time", "description"=>"*Request a list of the public transit stations that can be reached in a given time*\n\nTo find the stations reachable in a specified time use the `isochrone/v1/search.json` endpoint specifying a center point using the `x` and `y` parameters and a maximum total duration in minutes using the `max_dur `parameter.\n \n\n\n\n* **max_dur** `number`\n \\- Maximum duration of the journeys, in minutes. Minimum = 5, Maximum = 90. The default duration is 15 minutes. \n\n* **y** `number`\n \\- The latitude of the start point of your journey. e.g. `52.515` \n\n* **x** `number`\n \\- The longitude of the start point of your journey. e.g. `13.377` \n\n* **time** `text`\n \\- Specifies the time in ISO 8601 (for example, 2015-10-18T06:36:40)\n format. \n\n* **app_id** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **app_code** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.", "operationId"=>"IsochroneV1SearchJsonGet2", "x-api-path-slug"=>"isochronev1search-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"max_dur"}, {"in"=>"query", "name"=>"time"}, {"in"=>"query", "name"=>"x"}, {"in"=>"query", "name"=>"y"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reachability", "Of", "Area", "Within", "Specific", "Time"]}}, "/metarouter/rest/boardservice/v1/multiboard.json"=>{"get"=>{"summary"=>"All Next Departures (deprecated)", "description"=>"*Request a list of all next departure times and destinations from a location.*\n\nAll next departures information can be requested using the `metarouter/rest/boardservice/v1/multiboard.json` and specifying a `time` and `coordinates. `The maximum numbers of nearby stations and number of departures per station can be restricted by using the `max_stn` and `max` parameters, respectively.\n \n NOTE: This API has been deprecated and replaced with 2 new endpoints. Please see \n All Next Departures from a Location and All Next Departures for a list of Stations for more details.\n \n \n\n\n\n* **lang** `text`\n \\- Language of the response\n\n* **startX** `number`\n \\- The longitude of the center point of your search. e.g. `13.377`\n\n* **startY** `number`\n \\- The latitude of the center point of your search. e.g. `52.515`\n\n* **time** `text`\n \\- Time in format `yyyy-mm-ddThh:mm:ss`.\n\n* **app_id** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **app_code** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **max** `text`\n \\- The maximum number of next departures per station to be included in the response. The default value is 40. \n\n* **max_stn** `text`\n \\- The maximum number of stations for which departures are required. The default value is 40. \n\n* **prod** `text`\n \\- A 16-bit binary number, where each bit represents one type of transit. \n 0: High-speed Trains \n 1: Intercity/EuroCity Trains \n 2: Inter-regional and fast trains \n 3: Regional and other trains \n 4: City trains \n 5: Buses \n 6: Boat/Ferries \n 7: Metro/Subway \n 8: Tram \n 9: Ordered services/Taxi \n 10: Inclined/Funicular \n 11: Aerial/Cable Car \n 12: Rapid Bus \n 13: Monorail \n 14: Air plane \n 15: Not yet defined \n The default is 1111111111111111, meaning all supported transit types are permitted.", "operationId"=>"MetarouterRestBoardserviceV1MultiboardJsonGet", "x-api-path-slug"=>"metarouterrestboardservicev1multiboard-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"lang"}, {"in"=>"query", "name"=>"max"}, {"in"=>"query", "name"=>"max_stn"}, {"in"=>"query", "name"=>"prod"}, {"in"=>"query", "name"=>"startX"}, {"in"=>"query", "name"=>"startY"}, {"in"=>"query", "name"=>"time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["All", "Next", "Departures", "(deprecated)"]}}, "/coverage/v1/nearby.json"=>{"get"=>{"summary"=>"Transit Coverage Nearby", "description"=>"*Request a list of transit operators and station coverage nearby*\n\nOperator coverage is requested using the `coverage/v1/nearby.json` endpoint specifying the location using the `x` and `y` parameters.\n\n\n\n* **details** `enum`\n \\- Don't show line info in Explored Coverage\n\n Valid values are : `0` - disabled, `1` - enabled\n\n* **y** `number`\n \\- The latitude of the center point of your search. e.g. `52.515`\n\n* **x** `number`\n \\- The longitude of the center point of your search. e.g. `13.377`\n\n* **chinaconfig** `enum`\n \\- A switch that allows grouping results from Taiwan\ntogether with results from China. When enabled, Taiwan will appear as part of China. \n\n Valid values are : `0` - disabled, `1` - enabled\n\n* **app_id** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **app_code** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.", "operationId"=>"CoverageV1NearbyJsonGet", "x-api-path-slug"=>"coveragev1nearby-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"chinaconfig"}, {"in"=>"query", "name"=>"details"}, {"in"=>"query", "name"=>"x"}, {"in"=>"query", "name"=>"y"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Coverage", "Nearby"]}}, "/coverage/v1/search.json"=>{"get"=>{"summary"=>"Transit Coverage Within a City", "description"=>"*Request a list of transit operator coverage within a specified city*\n\nA list of operators working within a city is requested using the `coverage/v1/search.json` endpoint. The city is specified using the `q` parameter.\n\n\n\n* **q** `text`\n \\- The name or a part of the name of the city to search.\n\n* **app_id** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **app_code** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **max** `number`\n \\- Maximum number of results to be returned. Default is null.\n\n* **details** `enum`\n \\- With this value set to 1, the list of supported operators and population of the city is returned. When the value is set to 0, only the list of matching city names will be returned. Default value = 1\n\n Valid values are : `0` - disabled, `1` - enabled\n\n* **chinaconfig** `enum`\n \\- A switch that allows grouping results from Taiwan\ntogether with results from China. \n\n Valid values are : `0` - disabled, `1` - enabled\n\n* **lang** `text`\n \\- The language of the response. The value complies with the ISO 639-1 standard and defaults to en.", "operationId"=>"CoverageV1SearchJsonGet", "x-api-path-slug"=>"coveragev1search-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"chinaconfig"}, {"in"=>"query", "name"=>"details"}, {"in"=>"query", "name"=>"lang"}, {"in"=>"query", "name"=>"max"}, {"in"=>"query", "name"=>"q"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Coverage", "Within", "City"]}}, "/search/by_stopids.json"=>{"get"=>{"summary"=>"Find Stations by ID", "description"=>"*Request details of a specific transit station based on a previous request*\n\nStation details are requested using the `search/by_stopids.json` endpoint and appending a comma delimited list of `stop-ids` to the request URL. Usually, the request to this endpoint will be called after making a station search request, to obtain a list of stations Ids.\n \n\n\n\n* **stopIds** `text`\n \\- Specifies a list of stopIds separated by comma. Each stopId must contain at least 6 characters and must not exceed a maximum of 1000 characters. The format of a station Id is 123456789#100. Only the first 9-digits are mandatory and if the full Id is to be used, the `#` character must be encoded as `%23`. \n\n* **lang** `text`\n \\- A language of the response. \n\n* **app_id** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **app_code** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.", "operationId"=>"SearchByStopidsJsonGet", "x-api-path-slug"=>"searchby-stopids-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"lang"}, {"in"=>"query", "name"=>"stopIds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Stations", "By", "ID"]}}, "/search/by_geocoord.json"=>{"get"=>{"summary"=>"Find Stations Nearby", "description"=>"*Request a list of public transit stations within a given geo-location.*\n\nTo find the nearest stations use the `search/by_geocoord.json` endpoint specifying a center point using the `x` and `y` parameters and a search radius in meters using the `radius` parameter. `Max` value can also be used to restrict the number of results shown in the response.\n\n\n\n* **y** `number`\n \\- The latitude of the center point of your search. e.g. `52.515`\n\n* **x** `number`\n \\- The longitude of the center point of your search. e.g. `13.377`\n\n* **radius** `number`\n \\- Specifies a radius in meters when combined with the geo-coordinates defines the area of the search. The default value is 500m.\n\n* **app_id** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **app_code** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **max** `number`\n \\- Specifies the maximum number of stations/stops included in the response. \n The default value is 5. The minimum value is 1 and the maximum value is not limited.", "operationId"=>"SearchByGeocoordJsonGet", "x-api-path-slug"=>"searchby-geocoord-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"max"}, {"in"=>"query", "name"=>"radius"}, {"in"=>"query", "name"=>"x"}, {"in"=>"query", "name"=>"y"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Stations", "Nearby"]}}, "/coverage/v1/city.json"=>{"get"=>{"summary"=>"Find Transit Coverage in Cities Nearby", "description"=>"*Request a list of transit operators available in cities nearby*\n\nCity coverage can be found using the `coverage/v1/city.json` endpoint. The `x` and `y` parameters specify the location of the search.\n The response also includes the number of transit lines and transit stops available for each city.\n \n\n\n\n* **x** `number`\n \\- The longitude of the center point of your search. e.g. `13.377`\n\n* **y** `number`\n \\- The latitude of the center point of your search. e.g. `52.515`\n\n* **chinaconfig** `enum`\n \\- A switch that allows grouping results from Taiwan\ntogether with results from China. When enabled, Taiwan will appear as part of China. \n\n Valid values are : `0` - disabled, `1` - enabled\n\n* **radius** `number`\n \\- Specifies a radius in meters when combined with a center point defines the area of the search.\n\n* **app_id** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **app_code** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.", "operationId"=>"CoverageV1CityJsonGet", "x-api-path-slug"=>"coveragev1city-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"chinaconfig"}, {"in"=>"query", "name"=>"radius"}, {"in"=>"query", "name"=>"x"}, {"in"=>"query", "name"=>"y"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Transit", "Coverage", "In", "Cities", "Nearby"]}}, "/metarouter/rest/boardservice/v2/stationboard.json"=>{"get"=>{"summary"=>"Next Nearby Departures from a Station", "description"=>"*Request a list of next departure times and destinations of a particular station*\n\nNext nearby departures can be requested using the `metarouter/rest/boardservice/v2/stationboard.json` and specifying a `time` and `stnId`.\n \n The station ID (stnId) can be obtained from making a prior call to one of the station search (by name or by geo-coordinates) endpoints.\n\n\n\n* **lang** `text`\n \\- Language of the response\n\n* **stnId** `number`\n \\- Station Id. The format of a station Id is 123456789#100. Only the first 9-digits are mandatory and if the full Id is to be used, the `#` character must be encoded as `%23`. \n\n* **time** `text`\n \\- Time in format `yyyy-mm-ddThh:mm:ss`.\n\n* **strict** `enum`\n \\- When `strict=1` the board will include only departures from the given station id.\n\n Valid values are : `0` - disabled, `1` - enabled\n\n* **app_id** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **app_code** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.", "operationId"=>"MetarouterRestBoardserviceV2StationboardJsonGet", "x-api-path-slug"=>"metarouterrestboardservicev2stationboard-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"lang"}, {"in"=>"query", "name"=>"stnId"}, {"in"=>"query", "name"=>"strict"}, {"in"=>"query", "name"=>"time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Next", "Nearby", "Departures", "From", "Station"]}}, "/metarouter/rest/boardservice/v1/multiboard/by_stopids.json"=>{"get"=>{"summary"=>"All Next Departures for a list of Stations", "description"=>"*Request a list of all next departure times and destinations for a give list of stations.*\n\nAll next departures for a list of stations can be requested using the `metarouter/rest/boardservice/v1/multiboard/by_stopIds.json` and specifying a `time` and `stopIds.` \nThe maximum numbers of nearby stations and number of departures per station can be restricted by using the `max_stn` and `max` parameters, respectively.\n \n\n\n\n* **lang** `text`\n \\- Language of the response\n\n* **time** `text`\n \\- Time in format `yyyy-mm-ddThh:mm:ss`.\n\n* **app_id** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **app_code** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **max** `text`\n \\- The maximum number of next departures per station to be included in the response. The default value is 40. \n\n* **max_stn** `text`\n \\- The maximum number of stations for which departures are required. The default value is 40. \n\n* **stopIds** `text`\n \\- Specifies a list of stopIds separated by comma. Each stopId must contain\n at least 6 characters and must not exceed a maximum of 1000 characters.", "operationId"=>"MetarouterRestBoardserviceV1MultiboardByStopidsJsonGet", "x-api-path-slug"=>"metarouterrestboardservicev1multiboardby-stopids-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"lang"}, {"in"=>"query", "name"=>"max"}, {"in"=>"query", "name"=>"max_stn"}, {"in"=>"query", "name"=>"stopIds"}, {"in"=>"query", "name"=>"time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["All", "Next", "Departuresa", "List", "Of", "Stations"]}}, "/metarouter/rest/boardservice/v1/multiboard/by_geocoord.json"=>{"get"=>{"summary"=>"All Next Departures from a Location", "description"=>"*Request a list of all next departure times and destinations from a given location.*\n\nAll next departures from a given location can be requested using the `metarouter/rest/boardservice/v1/multiboard/by_geocoord.json` and specifying a `time` and `coordinates. `The maximum numbers of nearby stations and number of departures per station can be restricted by using the `max_stn` and `max` parameters, respectively.\n \n\n\n\n* **lang** `text`\n \\- Language of the response\n\n* **startX** `number`\n \\- The longitude of the center point of your search. e.g. `13.377`\n\n* **startY** `number`\n \\- The latitude of the center point of your search. e.g. `52.515`\n\n* **time** `text`\n \\- Time in format `yyyy-mm-ddThh:mm:ss`.\n\n* **app_id** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **app_code** `text`\n \\- A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code and app_code with every request.\n\n* **max** `text`\n \\- The maximum number of next departures per station to be included in the response. The default value is 40. \n\n* **max_stn** `text`\n \\- The maximum number of stations for which departures are required. The default value is 40. \n\n* **prod** `text`\n \\- A 16-bit binary number, where each bit represents one type of transit. \n 0: High-speed Trains \n 1: Intercity/EuroCity Trains \n 2: Inter-regional and fast trains \n 3: Regional and other trains \n 4: City trains \n 5: Buses \n 6: Boat/Ferries \n 7: Metro/Subway \n 8: Tram \n 9: Ordered services/Taxi \n 10: Inclined/Funicular \n 11: Aerial/Cable Car \n 12: Rapid Bus \n 13: Monorail \n 14: Air plane \n 15: Not yet defined \n The default is 1111111111111111, meaning all supported transit types are permitted.", "operationId"=>"MetarouterRestBoardserviceV1MultiboardByGeocoordJsonGet", "x-api-path-slug"=>"metarouterrestboardservicev1multiboardby-geocoord-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"lang"}, {"in"=>"query", "name"=>"max"}, {"in"=>"query", "name"=>"max_stn"}, {"in"=>"query", "name"=>"prod"}, {"in"=>"query", "name"=>"startX"}, {"in"=>"query", "name"=>"startY"}, {"in"=>"query", "name"=>"time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["All", "Next", "Departures", "From", "Location"]}}}}, "here-map-tile-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"HERE", "x-complete"=>1, "info"=>{"title"=>"Map Tile API", "description"=>"the-here-map-tile-api-is-a-restful-api-that-retrieves-map-tiles-for-all-regions-of-the-world-the-map-tile-api-addresses-the-following-high-level-use-cases-get-a-map-tile-image-specify-the-viewing-scheme-of-a-map-tile-image-specify-the-zoom-level-of-a-map-tile-image-specify-the-resolution-of-a-map-tile-image-identify-different-map-versions-retrieve-map-copyright-information-retrieve-metadata-information-for-a-specific-locationthis-example-set-works-with-version-2-1-64-0-or-higheradditional-information-can-be-found-on-developer-here-comhttpsdeveloper-here-comrestapisdocumentationenterprisemaptile", "version"=>"1.0.0"}, "host"=>"1.aerial.maps.cit.api.here.com", "basePath"=>"/maptile/2.1/maptile/newest", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/terrain.day/7/66/45/256/png8"=>{"get"=>{"summary"=>"Terrain Map", "description"=>"*Request a terrain map tile*\n\nTerrain map tile are available by passing `terrain.day` in the path of the request URL.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"TerrainDay76645256Png8Get", "x-api-path-slug"=>"terrain-day76645256png8-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Terrain", "Map"]}}, "/maptile/newest/normal.day/6/30/24/256/png8"=>{"get"=>{"summary"=>"Multiple Base64 Encoded Map Tiles", "description"=>"*Request multiple base64 encoded map tiles*\n\nA square consisting of multiple base64 encoded tiles is requested by adding the parameters `output=base64` and `range=NxN` to the request URL. The `column` and `row` in the path of the URL, defining the top left-hand corner of the tile group must be divisible by the value of the `range` parameter.\n \n Click on the response to decode the tiles returned.\n\n\n\n* **output** `text`\n \\- Indicates whether to return the tile as base64 encoded text.\n\n* **range** `enum`\n \\- Indicates the size of the array of tiles returned. Valid values are `2x2`, `3x3` or `4x4`\n\n Valid values are : `2x2`, `3x3`, `4x4`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"MaptileNewestNormalDay63024256Png8Get", "x-api-path-slug"=>"maptilenewestnormal-day63024256png8-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"output"}, {"in"=>"query", "name"=>"range"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multiple", "Base64", "Encoded", "Map", "Tiles"]}}, "/maptile/newest/normal.day.transit/12/2074/1409/256/png8"=>{"get"=>{"summary"=>"Color-reduced Transit Map", "description"=>"*Request a color-reduced map tile with public transport*\n\nColor-reduced street map tiles with full-color transit overlays are requested by passing `normal.day.transit` in the path of the request URL.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"MaptileNewestNormalDayTransit1220741409256Png8Get", "x-api-path-slug"=>"maptilenewestnormal-day-transit1220741409256png8-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Color-reduced", "Transit", "Map"]}}, "/maptile/newest/normal.day/16/18743/25072/256/png8"=>{"get"=>{"summary"=>"Filtering Points of Interest", "description"=>"*Request a map tile including selected points of interest*\n\nPoints of interest are displayed by passing the `pois` parameter in the request URL. The type of points of interest to be displayed can be filtered by using a hexadecimal bitmask.\n \n\n\n\n* **pois** `text`\n \\- Displays points of interest if present \n\n Valid values are : `default`, `alps`, `fleet`, `wings`, `dreamworks`, `flame`, `mini`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"MaptileNewestNormalDay161874325072256Png8Get3", "x-api-path-slug"=>"maptilenewestnormal-day161874325072256png8-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"pois"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filtering", "Points", "Of", "Interest"]}}, "/hybrid.day/4/8/5/256/png8"=>{"get"=>{"summary"=>"Hybrid Map", "description"=>"*Request a hybrid map tile - satellite imagery with labels*\n\nHybrid map tile are available by passing `hybrid.day` in the path of the request URL. The map tiles will display using the default language of the server unless the `lg` query parameter is used to change the map tile language. Consult the Map Tile API Reference for a full list of available languages.\n\n\n\n* **lg** `enum`\n \\- Alters the language of the labels displayed on the map. Three letter MARC code, for example `rus` for Russian language.\n\n Valid values are : `ara` - Arabic, `chi` - Chinese, `cht` - Chinese (Trad), `dut` - Dutch, `eng` - English, `fre` - French, `ger` - German, `gle` - Gaelic, `gre` - Greek, `heb` - Hebrew, `hin` - Hindi, `ind` - Indonesian, `ita` - Italian, `per` - Persian, `pol` - Polish, `por` - Portuguese, `rus` - Russian, `sin` - Sinhalese, `spa` - Spanish, `tha` - Thai, `tur` - Turkish, `ukr` - Ukranian, `urd` - Urdu, `vie` - Vietnamese, `wel` - Welsh\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"HybridDay485256Png8Get", "x-api-path-slug"=>"hybrid-day485256png8-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"lg"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hybrid", "Map"]}}, "/trucktile/newest/normal.day/12/2199/1342/256/png8"=>{"get"=>{"summary"=>"Truck Restrictions Map", "description"=>"*Request a street map tile showing restrictions for heavy vehicles*\n\nTo obtain a map tile displaying route restrictions for trucks, use the `trucktile` parameter in the path of the request URL.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"TrucktileNewestNormalDay1221991342256Png8Get", "x-api-path-slug"=>"trucktilenewestnormal-day1221991342256png8-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Truck", "Restrictions", "Map"]}}, "/maptile/newest/normal.day/9/255/170/256/png8"=>{"get"=>{"summary"=>"Toll Zone Map", "description"=>"*Request a street map tile highlighting congestion and environmental toll zones*\n\nTo highlight such toll zones, add the `congestion` parameter to the request URL.\n\n\n\n* **congestion** `null`\n \\- Flag to indicate if congestion zones are to be shown on the map.\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"MaptileNewestNormalDay9255170256Png8Get", "x-api-path-slug"=>"maptilenewestnormal-day9255170256png8-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"congestion"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Toll", "Zone", "Map"]}}, "/meta/pois"=>{"get"=>{"summary"=>"Point of Interest Categories", "description"=>"*Request point of interest category information*\n\nTo make a request for point-of-interest information, use `meta/pois` in the path of the request URL.\n \n\n\n\n* **output** `enum`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n Valid values are : `json`, `text`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.. \n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"MetaPoisGet", "x-api-path-slug"=>"metapois-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Point", "Of", "Interest", "Categories"]}}, "/copyright/newest"=>{"get"=>{"summary"=>"Copyright Information", "description"=>"*Request map tile copyright information*\n\nTo make a request for copyright information, use the `copyright` parameter in the path of the request URL.\n \n Note that the client-side process formatting the JSON response may take some time in older browsers.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"CopyrightNewestGet", "x-api-path-slug"=>"copyrightnewest-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Copyright", "Information"]}}, "/satellite.day/5/15/12/256/png8"=>{"get"=>{"summary"=>"Satellite Map", "description"=>"*Request a satellite map tile*\n\nSatellite map tiles do not display labels and are available by passing `satellite.day` in the path of the request URL.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"SatelliteDay51512256Png8Get", "x-api-path-slug"=>"satellite-day51512256png8-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Satellite", "Map"]}}, "/maptile/newest/normal.day/11/1196/595/256/png8"=>{"get"=>{"summary"=>"Foreign Language Support", "description"=>"*Request a map tile with labels in a foreign language*\n\nThe `lg` query parameter is used to define the language used on the map tiles. Consult the Map Tile API Reference for a full list of available languages.\n\n\n\n* **lg** `enum`\n \\- Alters the language of the labels displayed on the map. Three letter MARC code, for example `rus` for Russian language.\n\n Valid values are : `ara` - Arabic, `chi` - Chinese, `cht` - Chinese (Trad), `dut` - Dutch, `eng` - English, `fre` - French, `ger` - German, `gle` - Gaelic, `gre` - Greek, `heb` - Hebrew, `hin` - Hindi, `ind` - Indonesian, `ita` - Italian, `per` - Persian, `pol` - Polish, `por` - Portuguese, `rus` - Russian, `sin` - Sinhalese, `spa` - Spanish, `tha` - Thai, `tur` - Turkish, `ukr` - Ukranian, `urd` - Urdu, `vie` - Vietnamese, `wel` - Welsh\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"MaptileNewestNormalDay111196595256Png8Get", "x-api-path-slug"=>"maptilenewestnormal-day111196595256png8-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"lg"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Foreign", "Language", "Support"]}}, "/maptile/newest/normal.day/13/4093/2723/256/png8"=>{"get"=>{"summary"=>"Fleet Vehicle Map", "description"=>"*Request a street map tile using the fleet vehicle color scheme*\n\nFleet color scheme map tiles are available by passing `style=fleet` as a parameter of the request URL.\n\n\n\n* **style** `enum`\n \\- If present, selects the style to use to render the tile.\n\n Valid values are : `default`, `alps`, `fleet`, `wings`, `dreamworks`, `flame`, `mini`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"MaptileNewestNormalDay1340932723256Png8Get", "x-api-path-slug"=>"maptilenewestnormal-day1340932723256png8-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"style"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fleet", "Vehicle", "Map"]}}, "/maptile/newest/normal.day/13/6693/3575/256/png8"=>{"get"=>{"summary"=>"Support for Multiple Languages", "description"=>"*Request a map tile with labels in two languages*\n\nThe `lg` query parameter is used to define the first language used on the map tiles. The `lg2` query parameter is used to define a supplementary second language. Consult the Map Tile API Reference for a full list of available languages.\n\n\n\n* **lg** `enum`\n \\- Alters the language of the labels displayed on the map. Three letter MARC code, for example `rus` for Russian language.\n\n Valid values are : `ara` - Arabic, `chi` - Chinese, `cht` - Chinese (Trad), `dut` - Dutch, `eng` - English, `fre` - French, `ger` - German, `gle` - Gaelic, `gre` - Greek, `heb` - Hebrew, `hin` - Hindi, `ind` - Indonesian, `ita` - Italian, `per` - Persian, `pol` - Polish, `por` - Portuguese, `rus` - Russian, `sin` - Sinhalese, `spa` - Spanish, `tha` - Thai, `tur` - Turkish, `ukr` - Ukranian, `urd` - Urdu, `vie` - Vietnamese, `wel` - Welsh\n\n* **lg2** `enum`\n \\- Alters the second language of the labels displayed on the map. Three letter MARC code, for example `rus` for Russian language.\n\n Valid values are : `ara` - Arabic, `chi` - Chinese, `cht` - Chinese (Trad), `dut` - Dutch, `eng` - English, `fre` - French, `ger` - German, `gle` - Gaelic, `gre` - Greek, `heb` - Hebrew, `hin` - Hindi, `ind` - Indonesian, `ita` - Italian, `per` - Persian, `pol` - Polish, `por` - Portuguese, `rus` - Russian, `sin` - Sinhalese, `spa` - Spanish, `tha` - Thai, `tur` - Turkish, `ukr` - Ukranian, `urd` - Urdu, `vie` - Vietnamese, `wel` - Welsh\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"MaptileNewestNormalDay1366933575256Png8Get", "x-api-path-slug"=>"maptilenewestnormal-day1366933575256png8-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"lg"}, {"in"=>"query", "name"=>"lg2"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SupportMultiple", "Languages"]}}, "/maptile/newest/normal.day/11/525/761/256/png8"=>{"get"=>{"summary"=>"Base64 Encoded Map Tile", "description"=>"*Request a base64 encoded map tile*\n\nBase64 encoded tiles are requested by adding the parameter `output=base64` to the request URL.\n \n Click on the response to decode the tile returned.\n\n\n\n* **output** `text`\n \\- Indicates whether to return the tile as base64 encoded text.\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"MaptileNewestNormalDay11525761256Png8Get4", "x-api-path-slug"=>"maptilenewestnormal-day11525761256png8-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Base64", "Encoded", "Map", "Tile"]}}, "/maptile/newest/normal.day.grey/11/525/761/256/png8"=>{"get"=>{"summary"=>"Color-reduced Street Map", "description"=>"*Request a greyed out street map tile*\n\nMaps using a reduced color palette can be requested by passing `normal.day.grey` in the path of the request URL.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"MaptileNewestNormalDayGrey11525761256Png8Get", "x-api-path-slug"=>"maptilenewestnormal-day-grey11525761256png8-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Color-reduced", "Street", "Map"]}}, "/info"=>{"get"=>{"summary"=>"Map Tile Type Information", "description"=>"*Request information about the types of map tiles available on a server*\n\nTo make a request for metadata information, use the `info` parameter in the path of the request URL.\n\n\n\n* **output** `enum`\n \\- Indicates whether to return the information in XML format, JSON format or as an XML schema (XSD) of the API metadata\n\n Valid values are : `json`, `xml`, `xsd`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"InfoGet", "x-api-path-slug"=>"info-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Map", "Tile", "Type", "Information"]}}, "/truckonlytile/newest/normal.day/12/2199/1342/256/png8"=>{"get"=>{"summary"=>"Transparent Truck Restrictions Map", "description"=>"*Request a transparent tile showing restrictions for heavy vehicles only*\n\nTo obtain a transparent map tile displaying route restrictions for trucks, use the `truckonlytile` parameter in the path of the request URL.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"TruckonlytileNewestNormalDay1221991342256Png8Get", "x-api-path-slug"=>"truckonlytilenewestnormal-day1221991342256png8-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transparent", "Truck", "Restrictions", "Map"]}}}}, "here-waypoint-sequence-extension-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"HERE", "x-complete"=>1, "info"=>{"title"=>"Waypoint Sequence Extension API", "description"=>"the-here-waypoints-sequence-extension-api-calculates-the-optimal-sequence-of-any-given-waypoints-along-a-route-while-minimizing-the-time-or-distance-traveled--often-referred-as-the-travelling-salesman-problem-the-service-takes-into-account-the-here-road-network-restrictions-as-well-as-traffic-pattern-data-to-provide-accurate-travel-times-and-distances-between-subsequent-waypoints--mode-of-travel-by-car-or-truck-as-well-as-route-preference-like-fastest-or-shortest-can-also-be-considered-when-applying-for-specific-use-cases-this-example-set-works-with-version-2-0-or-higheradditional-information-can-be-found-on-developer-here-comhttpsdeveloper-here-complatformextensionsdocumentationroutingwaypoints", "version"=>"1.0.0"}, "host"=>"wse.cit.api.here.com", "basePath"=>"/2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/findsequence.json"=>{"get"=>{"summary"=>"Waypoint Sequence for Hazardous Materials", "description"=>"*Request an ordered list of destinations for a truck carrying hazardous materials*\n\nWaypoint sequence calcuations are made using the `findsequence` endpoint and appending `start` and `end` parameters and consecutively numbered `destination` parameters are used to add intermediate points to the request. Hazardous material types are added as a comma-delimited list to the `shippedHazardousGoods` parameter. The list of values is defined in the Enterprise Routing API\n\n\n\n* **start** `latlng`\n \\- Start point for the route calculations. e.g. `52.515,13.377`\n\n* **destination1** `latlng`\n \\- A point through which the route must pass. e.g. `52.6172,13.3833`\n\n* **destination2** `latlng`\n \\- A point through which the route must pass. e.g. `52.6172,13.3833`\n\n* **destination3** `latlng`\n \\- A point through which the route must pass. e.g. `52.6172,13.3833`\n\n* **destination4** `latlng`\n \\- A point through which the route must pass. e.g. `52.6172,13.3833`\n\n* **end** `latlng`\n \\- End point for the route calculations. e.g. `50.121,8.925`\n\n* **improveFor** `enum`\n \\- Whether to improve for time or distance\n\n Valid values are : `time`, `distance`\n\n* **mode** `text`\n \\- Routing mode determines how the route is calculated. e.g. `fastest;car;traffic:disabled`\n\n* **shippedHazardousGoods** `multi-enum`\n \\- Truck routing only, list of hazardous materials in the vehicle.\n\n Valid values are : `combustible`, `corrosive`, `explosive`, `flammable`, `gas`, `harmfulToWater`, `organic`, `other`, `poison`, `poisonousInhalation`, `radioActive`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"FindsequenceJsonGet4", "x-api-path-slug"=>"findsequence-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"destination1"}, {"in"=>"query", "name"=>"destination2"}, {"in"=>"query", "name"=>"destination3"}, {"in"=>"query", "name"=>"destination4"}, {"in"=>"query", "name"=>"end"}, {"in"=>"query", "name"=>"improveFor"}, {"in"=>"query", "name"=>"mode"}, {"in"=>"query", "name"=>"shippedHazardousGoods"}, {"in"=>"query", "name"=>"start"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Waypoint", "SequenceHazardous", "Materials"]}}}}, "here-route-match-extension-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"HERE", "x-complete"=>1, "info"=>{"title"=>"Platform Data Extension API", "description"=>"the-here-platform-data-extension-is-an-api-that-provides-here-content-which-is-not-accessible-through-other-here-platform-apis--pde-groups-here-core-map-data-into-thematic-layers--each-layer-contains-geographical-tiles--each-tile-contains-a-list-of-data-records--each-data-record-contains-attributes--content-is-delivered-per-tile-as-json-or-plain-text-file-each-thematic-data-layer-serves-a-specific-use-case-e-g--driver-warnings-junction-view-guidance-fuel-efficient-driving-behavior-safety-related-driving-behavior-or-polygons-of-a-certain-admin-level--each-layer-contains-only-the-data-required-for-its-use-case-this-example-set-works-with-version-1-4-0-or-higheradditional-information-can-be-found-on-developer-here-comhttpsdeveloper-here-complatformextensionsdocumentationplatformdata", "version"=>"1.0.0"}, "host"=>"pde.cit.api.here.com", "basePath"=>"/1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/static.json"=>{"get"=>{"summary"=>"Platform Static Data", "description"=>"*Request enumerated content from a static data table*\n\nTo request static data use the static.json endpoint and provide the name of the data table using the `content` parameter\n\n\n\n* **region** `text`\n \\- Map Coverage Region. e.g. `APAC`, `NA`, `EU`\n\n* **release** `text`\n \\- Map release quarter e.g. `2014Q4` or `LATEST`\n\n* **content** `text`\n \\- The name of the static content table requested\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"StaticJsonGet", "x-api-path-slug"=>"static-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"content"}, {"in"=>"query", "name"=>"region"}, {"in"=>"query", "name"=>"release"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Platform", "Static", "Data"]}}, "/doc/layers.json"=>{"get"=>{"summary"=>"Available Map Data Layers", "description"=>"*Request which data layers can be accessed within a specified map region and release*\n\nTo make a request for data layer availability information, use the `layers.json` endpoint, supplying the `release` and `region` parameters.\n\n\n\n* **region** `text`\n \\- Map Coverage Region. e.g. `APAC`, `NA`, `EU`\n\n* **release** `text`\n \\- Map release quarter e.g. `2014Q4` or `LATEST`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"DocLayersJsonGet", "x-api-path-slug"=>"doclayers-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"region"}, {"in"=>"query", "name"=>"release"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Available", "Map", "Data", "Layers"]}}, "/tile.json"=>{"get"=>{"summary"=>"Platform Data", "description"=>"*Request data from a specific data layer about a specified location*\n\nTo request data from a specified data layer, use the t`ile.json` endpoint, and include the `region`, `release` and `layer` parameters. The area covered is specified by the `level`, `tilex` and `tiley` parameters\n\n\n\n* **region** `text`\n \\- Map Coverage Region. e.g. `APAC`, `NA`, `EU`\n\n* **release** `text`\n \\- Map release quarter e.g. `2014Q4` or `LATEST`\n\n* **layer** `text`\n \\- Thematic layer\n\n* **level** `text`\n \\- Specifies the size of the requested tile\n\n* **tilex** `text`\n \\- Specifies the tile number in West-East direction. This depends on the level.\n\n* **tiley** `text`\n \\- Specifies the tile number in South-North direction. This depends on the level.\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"TileJsonGet", "x-api-path-slug"=>"tile-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"layer"}, {"in"=>"query", "name"=>"level"}, {"in"=>"query", "name"=>"region"}, {"in"=>"query", "name"=>"release"}, {"in"=>"query", "name"=>"tilex"}, {"in"=>"query", "name"=>"tiley"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Platform", "Data"]}}, "/doc/attributes.json"=>{"get"=>{"summary"=>"Available Attributes", "description"=>"*Request which map data layers contain which attributes*\n\nTo make a request for map data layer information, use the `attributes``.json` endpoint, supplying the `release` and `region` parameters.\n \n\n\n\n* **region** `text`\n \\- Map Coverage Region. e.g. `APAC`, `NA`, `EU`\n\n* **release** `text`\n \\- Map release quarter e.g. `2014Q4` or `LATEST`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"DocAttributesJsonGet", "x-api-path-slug"=>"docattributes-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"region"}, {"in"=>"query", "name"=>"release"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Available", "Attributes"]}}, "/doc/maps.json"=>{"get"=>{"summary"=>"Map Data Availability and Freshness", "description"=>"*Request the release date and area covered by each available map region*\n\nTo make a request for release date information, use the `maps.json` endpoint.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"DocMapsJsonGet", "x-api-path-slug"=>"docmaps-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Map", "Data", "Availability", "Freshness"]}}, "/doc/layer.json"=>{"get"=>{"summary"=>"Available Attributes within a Map Data Layer", "description"=>"*Request which attributes are available within a specified map data layer*\n\nTo make a request for map data layer information, use the `layer``.json` endpoint, supplying the `release`, `layer` and `region` parameters.\n\n\n\n* **region** `text`\n \\- Map Coverage Region. e.g. `APAC`, `NA`, `EU`\n\n* **release** `text`\n \\- Map release quarter e.g. `2014Q4` or `LATEST`\n\n* **layer** `text`\n \\- Thematic layer\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"DocLayerJsonGet", "x-api-path-slug"=>"doclayer-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"layer"}, {"in"=>"query", "name"=>"region"}, {"in"=>"query", "name"=>"release"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Available", "Attributes", "Within", "Map", "Data", "Layer"]}}}}, "here-routing-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"HERE", "x-complete"=>1, "info"=>{"title"=>"Routing API", "description"=>"examples-for-routing-nlp-7-2-72-or-higher", "version"=>"1.0.0"}, "host"=>"route.cit.api.here.com", "basePath"=>"/routing/7.2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/calculateroute.json"=>{"get"=>{"summary"=>"Avoid motorways", "description"=>"*Request a route preferring or avoiding specific types of road*\n\nRouting preferences can be added by extending the `mode` parameter of the request URL by adding a semi-colon delimited list of route link flags. In this case the addition of `motorway:-3` to the `mode` parameter indicates a strict exclusion of motorways. Consult the Routing API Reference for a full description of `mode` parameter and different feature weights.\n\n\n\n* **waypoint0** `latlng`\n \\- Start point of the route. e.g. `52.515,13.377`\n\n* **waypoint1** `latlng`\n \\- Second point through which the route must pass. e.g. `52.6172,13.3833`\n\n* **mode** `text`\n \\- Routing mode determines how the route is calculated. e.g. `fastest;car;traffic:disabled.`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"CalculaterouteJsonGet22", "x-api-path-slug"=>"calculateroute-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"mode"}, {"in"=>"query", "name"=>"waypoint0"}, {"in"=>"query", "name"=>"waypoint1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Avoid", "Motorways"]}}, "/calculatematrix.json"=>{"get"=>{"summary"=>"Many to many matrix routing", "description"=>"*Matrix routing request with three start points and five destinations*\n\nMatrix calculations are made using the `calculatematrix` endpoint and appending a three start parameters (`start0, ``start1, ``start2)` and multiple consecutively numbered `destination` parameters to the request.\n \n\n\n\n* **start0** `latlng`\n \\- First start point for the route calculations. e.g. `52.515,13.377` \n\n* **start1** `latlng`\n \\- Second start point for the route calculations. e.g. `52.515,13.377` \n\n* **start2** `latlng`\n \\- Third start point for the route calculations. e.g. `52.515,13.377` \n\n* **destination0** `latlng`\n \\- First destination point for the route calculations. e.g. `52.4,13.5` \n\n* **destination1** `latlng`\n \\- Second destination point for the route calculations. e.g. `52.4,13.5` \n\n* **destination2** `latlng`\n \\- Third destination point for the route calculations. e.g. `52.4,13.5` \n\n* **destination3** `latlng`\n \\- Fourth destination point for the route calculations. e.g. `52.4,13.5` \n\n* **destination4** `latlng`\n \\- Fifth destination point for the route calculations. e.g. `52.4,13.5` \n\n* **mode** `text`\n \\- Routing mode determines how the route is calculated. e.g. `fastest;car;traffic:disabled.` \n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_id with every request. \n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an app_code with every request.", "operationId"=>"CalculatematrixJsonGet2", "x-api-path-slug"=>"calculatematrix-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"destination0"}, {"in"=>"query", "name"=>"destination1"}, {"in"=>"query", "name"=>"destination2"}, {"in"=>"query", "name"=>"destination3"}, {"in"=>"query", "name"=>"destination4"}, {"in"=>"query", "name"=>"mode"}, {"in"=>"query", "name"=>"start0"}, {"in"=>"query", "name"=>"start1"}, {"in"=>"query", "name"=>"start2"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Many", "To", "Many", "Matrix", "Routing"]}}, "/calculateisoline.json"=>{"get"=>{"summary"=>"Time-based isoline with destination as center", "description"=>"*Request an isoline that will reach a destination within a given time*\n\nTime-based reverse flow requests are made using the `calculateisoline` endpoint and specifying the `destination` and `rangetype=time` parameters.\n\n\n\n* **mode** `text`\n \\- Routing mode determines how the route is calculated. e.g. `fastest;car;traffic:disabled.`\n\n* **destination** `latlng`\n \\- Destination of the reverse flow calculation. e.g. `52.515,13.377`\n\n* **rangetype** `text`\n \\- Specifies type of range. Possible values are distance, time. For distance the unit is meters. For time the unit is seconds. rangetype=distance rangetype=time \n\n* **range** `number`\n \\- Range of isoline. Several comma separated values can be specified. The unit is defined by parameter rangetype range=1000 range=1000,2000,3000 \n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request. \n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"CalculateisolineJsonGet4", "x-api-path-slug"=>"calculateisoline-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"destination"}, {"in"=>"query", "name"=>"mode"}, {"in"=>"query", "name"=>"range"}, {"in"=>"query", "name"=>"rangetype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Time-based", "Isoline", "Destination", "As", "Center"]}}, "/getlinkinfo.json"=>{"get"=>{"summary"=>"Link Information using linkId", "description"=>"*Request detailed information about a path segment in the routing network given a linkid*\n\nLink information can be retrieved using the `getlinkinfo` endpoint, by specifying one or more comma separated linkIds using the `linkids` parameter. The `linkids` have been generated from a previous request. Note that positive direction '+' in link Ids has to be URL encoded.\n \n \n\n\n\n* **linkids** `text`\n \\- Link identifiers for which the detailed information is being requested.\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"GetlinkinfoJsonGet2", "x-api-path-slug"=>"getlinkinfo-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"linkids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Information", "Using", "LinkId"]}}, "/getroute.json"=>{"get"=>{"summary"=>"Previously calculated route information", "description"=>"*Request information about a previously calculated route*\n\nPrevious routes can be retrieved using the `getroute` endpoint and appending a `routeid` to the request. The `routeid` in question has been generated from a previous request. Note that server map updates usually invalidates `routeid` value computed on previous map versions. If it is the case, the `routeid` computation should be requested again on the map in current use.\n \n\n\n\n* **mode** `text`\n \\- Routing mode determines how the route is calculated. e.g. `fastest;car;traffic:disabled.` \n\n* **routeid** `text`\n \\- Route identifier for which the detailed route information is being requested. \n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request. \n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"GetrouteJsonGet", "x-api-path-slug"=>"getroute-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"mode"}, {"in"=>"query", "name"=>"routeid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Previously", "Calculated", "Route", "Information"]}}}}, "here-venue-maps-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"HERE", "x-complete"=>1, "info"=>{"title"=>"Venue Maps", "description"=>"the-here-venue-maps-api-returns-detailed-uptodate-information-on-geometry-metadata-points-of-interest-poi-and-indoor-routing-for-more-than-12-000-venues-around-the-world--the-venue-maps-api-provides-solutions-for-the-following-high-level-use-cases-discover-venues-in-a-certain-area-of-the-world-get-a-venue-map-image-tile-get-a-venue-map-json-tile-get-full-information-of-a-venue-and-customize-your-experiencethis-example-set-works-with-version-1-1-or-higheradditional-information-can-be-found-on-developer-here-comhttpsdeveloper-here-comrestapisdocumentationvenuemaps", "version"=>"1.0.0"}, "host"=>"signature.venue.maps.cit.api.here.com", "basePath"=>"/venues/signature", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1"=>{"get"=>{"summary"=>"Venue Clusters within a Bounding Box", "description"=>"*Request an overview of the number venues across a large area*\n\nA bounding box is specified using the `bbox` parameter in the request URL.\n\n\n\n* **bbox** `bbox`\n \\- A type of spatial filter. A bounding box specifies the top-right and bottom left corners of an area to search. e.g. `52.515,13.377;52.134,13.978`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"V1Get3", "x-api-path-slug"=>"v1-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"bbox"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venue", "Clusters", "Within", "Bounding", "Box"]}}, "/1/models-full/DM_12321.js"=>{"get"=>{"summary"=>"Full Venue Model", "description"=>"*Request extended details of places found within a venue*\n\nA full model of a venue can be obtained by passing `models-full` in the path of the request URL and appending the `id` of the venue in question along with associated authentication credentials. \n \n Note that the client-side process formatting the JSON response may take some time in older browsers.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.\n\n* **Signature** `text`\n \\- Signature\n\n* **Policy** `text`\n \\- Policy\n\n* **Key-Pair-Id** `text`\n \\- Key-Pair-Id", "operationId"=>"1ModelsFullDM12321JsGet", "x-api-path-slug"=>"1modelsfulldm-12321-js-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"Key-Pair-Id"}, {"in"=>"query", "name"=>"Policy"}, {"in"=>"query", "name"=>"Signature"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Full", "Venue", "Model"]}}, "/0/tiles-png/L1/12022001101210030210.png"=>{"get"=>{"summary"=>"Venue Map Tile", "description"=>"*Request an individual venue map tile*\n\nIn addition to the usual `app_id` and `app_code`, three additional parameters are required for authentication purposes. The `Signature`, `Policy` and `Key-Pair-Id` parameters have been obtained from a prior request to the `Signature` endpoint.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.\n\n* **Signature** `text`\n \\- Signature\n\n* **Policy** `text`\n \\- Policy\n\n* **Key-Pair-Id** `text`\n \\- Key-Pair-Id", "operationId"=>"0TilesPngL112022001101210030210PngGet", "x-api-path-slug"=>"0tilespngl112022001101210030210-png-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"Key-Pair-Id"}, {"in"=>"query", "name"=>"Policy"}, {"in"=>"query", "name"=>"Signature"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venue", "Map", "Tile"]}}, "/0/tiles-ia/L1/12022001101210030210.js"=>{"get"=>{"summary"=>"Room Definitions", "description"=>"*Request a list of the name and shape of rooms found within a single venue map tile*\n\nRoom data associated with a map tile is requested by passing `tiles-ia` in the path of the request URL, along with a known `floor` and `quadkey` and associated authentication credentials.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.\n\n* **Signature** `text`\n \\- Signature\n\n* **Policy** `text`\n \\- Policy\n\n* **Key-Pair-Id** `text`\n \\- Key-Pair-Id", "operationId"=>"0TilesIaL112022001101210030210JsGet", "x-api-path-slug"=>"0tilesial112022001101210030210-js-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"Key-Pair-Id"}, {"in"=>"query", "name"=>"Policy"}, {"in"=>"query", "name"=>"Signature"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Room", "Definitions"]}}, "/1/models-poi/DM_7205.js"=>{"get"=>{"summary"=>"Places within a Venue", "description"=>"*Request a list of the places within a venue*\n\nDetails of the individual places to be found within a venue can be obtained by passing `models-poi` in the path of the request URL and appending the `id` of the venue in question along with associated authentication credentials.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.\n\n* **Signature** `text`\n \\- Signature\n\n* **Policy** `text`\n \\- Policy\n\n* **Key-Pair-Id** `text`\n \\- Key-Pair-Id", "operationId"=>"1ModelsPoiDM7205JsGet", "x-api-path-slug"=>"1modelspoidm-7205-js-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"Key-Pair-Id"}, {"in"=>"query", "name"=>"Policy"}, {"in"=>"query", "name"=>"Signature"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places", "Within", "Venue"]}}, "/0/tiles-ia-b64/L1/12022001101210030210.js"=>{"get"=>{"summary"=>"Base64 Encoded Map Tiles", "description"=>"*Request a base64 encoded map tile and associated room definitions with a single request*\n\nA base64 encoded map tile together with the room definitions, is requested by passing `tiles-ia-b64` in the path of the request URL, along with a known `floor` and `quadkey` and associated authentication credentials.\n\n\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.\n\n* **Signature** `text`\n \\- Signature\n\n* **Policy** `text`\n \\- Policy\n\n* **Key-Pair-Id** `text`\n \\- Key-Pair-Id", "operationId"=>"0TilesIaB64L112022001101210030210JsGet", "x-api-path-slug"=>"0tilesiab64l112022001101210030210-js-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"Key-Pair-Id"}, {"in"=>"query", "name"=>"Policy"}, {"in"=>"query", "name"=>"Signature"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Base64", "Encoded", "Map", "Tiles"]}}}}, "here-places-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"HERE", "x-complete"=>1, "info"=>{"title"=>"Places API", "description"=>"the-here-places-search-api-is-a-web-service-which-allows-users-to-search-and-explore-locations-buildings-and-other-points-of-interest-the-places-search-api-has-a-number-of-endpoints-that-center-around-two-major-features-place-discovery--search-for-places-near-your-users-place-description--get-detailed-information-about-the-places-your-users-are-interested-inwithin-place-discovery-the-api-has-endpoints-supporting-a-number-of-use-cases-from-which-you-can-select-according-to-the-needs-of-your-application-search--locationaware-search-for-places-based-on-userprovided-search-terms-explore--find-interesting-places-in-an-area-either-near-the-user-or-selected-by-the-user-here--identify-what-place-is-at-a-given-location-around--similar-to-explore-but-optimised-for-augmented-reality-visual-exploration-applications-such-as-livesight-this-example-set-works-with-version-1-0-or-higheradditional-information-can-be-found-on-developer-here-comhttpsdeveloper-here-comrestapisdocumentationplaces", "version"=>"1.0.0"}, "host"=>"places.demo.api.here.com", "basePath"=>"/places/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/suggest"=>{"get"=>{"summary"=>"Search Suggestions", "description"=>"*Request a list of suggestions based on a partial query string*\n\nA suggestions request can be made using the `suggest` endpoint in the request URL and adding the `q` parameter with the partial query string. The focal point for the suggestion service is defined using the `at` parameter.\n\n\n\n* **at** `latlng`\n \\- Location of the central point for the places search. e.g. `52.515,13.377`\n\n* **q** `text`\n \\- Free-form text containing the search term. e.g. `restaurant` or `Brandenburger Tor`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.\n\n* **Accept** `header`\n\n Format to request from the server", "operationId"=>"SuggestGet", "x-api-path-slug"=>"suggest-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"at"}, {"in"=>"query", "name"=>"q"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Suggestions"]}}, "/categories/places"=>{"get"=>{"summary"=>"Place Categories", "description"=>"*Request a list of place categories available for a given location*\n\nA place category request can be made using the `categories/places` endpoint in the request URL and specifying the focal point using the `at` parameter.\n\n\n\n* **at** `latlng`\n \\- Location of the central point for the places search. e.g. `52.515,13.377`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.\n\n* **Accept** `header`\n\n Format to request from the server", "operationId"=>"CategoriesPlacesGet", "x-api-path-slug"=>"categoriesplaces-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"at"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "Categories"]}}, "/discover/explore"=>{"get"=>{"summary"=>"Explore Popular Places", "description"=>"*Request a list of popular places around a location*\n\nThe `explore` location context can either be an explicitly given location using the `at` parameter, or implicitly defined by a user's current position or the currently visible map.\n\n\n\n* **at** `latlng`\n \\- Location of the central point for the places search. e.g. `52.515,13.377`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.\n\n* **Accept** `header`\n\n Format to request from the server", "operationId"=>"DiscoverExploreGet5", "x-api-path-slug"=>"discoverexplore-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"at"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Explore", "Popular", "Places"]}}, "/discover/here"=>{"get"=>{"summary"=>"Explore Nearby Places", "description"=>"*Request a list of places close to a location *\n\nThe `discover/here` endpoint allow users to request a list of places near to a given point, based on a location precision parameter (in this case the `at` parameter) which must be provided. If the precision is high, the places around that point are returned in order of proximity. Otherwise a set of recommended places in the area is returned.\n\n\n\n* **at** `latlng`\n \\- Location of the central point for the places search. e.g. `52.515,13.377`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.\n\n* **Accept** `header`\n\n Format to request from the server", "operationId"=>"DiscoverHereGet", "x-api-path-slug"=>"discoverhere-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"at"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Explore", "Nearby", "Places"]}}, "/discover/search"=>{"get"=>{"summary"=>"One-Box Search", "description"=>"*Request a list of nearby places based on a query string*\n\nA free-text places search can be made using the `discover/search` endpoint in the request URL and adding the `q` parameter with the query string. The focal point of the search is defined using the `at` parameter.\n\n\n\n* **at** `latlng`\n \\- Location of the central point for the places search. e.g. `52.515,13.377`\n\n* **q** `text`\n \\- Free-form text containing the search term. e.g. `restaurant` or `Brandenburger Tor`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.\n\n* **Accept** `header`\n\n Format to request from the server", "operationId"=>"DiscoverSearchGet", "x-api-path-slug"=>"discoversearch-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"at"}, {"in"=>"query", "name"=>"q"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["One-Box", "Search"]}}}}, "here-weather-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"HERE", "x-complete"=>1, "info"=>{"title"=>"Weather API", "description"=>"the-here-weather-api-provides-weather-forecasts-and-reports-on-current-weather-conditions-provides-information-on-severe-weather-alerts-provides-information-about-when-the-sun-and-moon-rise-and-set-and-the-phase-of-the-moonthis-example-set-works-with-version-1-2-4-or-higheradditional-information-can-be-found-on-developer-here-comhttpsdeveloper-here-comrestapisdocumentationweather", "version"=>"1.0.0"}, "host"=>"weather.cit.api.here.com", "basePath"=>"/weather/1.0", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/report.json"=>{"get"=>{"summary"=>"Multi-Language Support", "description"=>"*Request current weather conditions in a foreign language*\n\nThe language of the weather report is altered by adding the `language` parameter to the request URL.\n\n\n\n* **product** `enum`\n \\- The type of information to request\n\n Valid values are : `observation`, `forecast_7days`, `forecast_7days_simple`, `forecast_hourly`, `forecast_astronomy`, `alerts`, `nws_alerts`\n\n* **latitude** `number`\n \\- Latitude of the weather forecast. e.g. `52.5159`\n\n* **longitude** `number`\n \\- Longitude of the weather forecast. e.g. `13.3777`\n\n* **oneobservation** `enum`\n \\- A flag to indicate only one observation is required.\n\n Valid values are : `true`, `false`\n\n* **language** `enum`\n \\- The language for the observations within the forecast.\n\n Valid values are : `af-ZA` - Afrikaans, `sq` - Albanian, `am-ET` - Amharic, `ar` - Arabic, `as-IN` - Assamese, `az-AZ` - Azerbaijani, `eu` - Basque, `be` - Belarusian, `bn-BD` - Bengali-bd, `bn` - Bengali, `bs-BA` - Bosnian, `bg-BG` - Bulgarian, `ca` - Catalan, `zh-CN` - Chinese (PRC), `zh-HK` - Chinese (HK), `zh-TW` - Chinese (TW), `hr-HR` - Croatian, `cs-CZ` - Czech, `da-DK` - Danish, `nl-NL` - Dutch, `en` - English, `en-US` - English (US), `et-EE` - Estonian, `fa` - Farsi, `fa-AF` - Farsi-af, `fi-FI` - Finnish, `fr-CA` - French (CA), `fr` - French, `gl` - Galician, `ka-GE` - Georgian, `de` - German, `el-GR` - Greek, `gu-IN` - Gujarati, `ha` - Hausa, `he-IL` - Hebrew, `hi-IN` - Hindi, `hu-HU` - Hungarian, `is-IS` - Icelandic, `ig-NG` - Igbo, `id-ID` - Indonesian, `it` - Italian, `ja-JP` - Japanese, `kn-IN` - Kannada, `ks-IN` - Kashmiri, `kk-KZ` - Kazakh, `km-KH` - Khmer, `ky-KG` - Kirghiz, `ko-KR` - Korean, `lo-LA` - Lao, `lv-LV` - Latvian, `ln` - Lingala, `lt-LT` - Lithuanian, `mk-MK` - Macedonian, `mg-MG` - Malagasy, `ms-MY` - Malay, `ml-IN` - Malayalam, `mr-IN` - Marathi, `mn-MN` - Mongolian, `no-NO` - Norwegian, `or-IN` - Oriya, `pl-PL` - Polish, `pt-BR` - Portuguese (BR), `pt-PT` - Portuguese (PT), `pa` - Punjabi, `ps` - Pushto, `ro-RO` - Romanian, `ru-RU` - Russian, `sr-YU` - Serbian, `st` - Sesotho, `si-LK` - Sinhala, `sk-SK` - Slovak, `sl-SL` - Slovene, `es-ES` - Spanish, `es-US` - Spanish (US), `sw` - Swahili, `sv` - Swedish, `tl-PH` - Tagalog, `ta` - Tamil, `te-IN` - Telugu, `th-TH` - Thai, `tg-TJ` - Tajik, `tr-TR` - Turkish, `tk` - Turkmen, `uk-UA` - Ukrainian, `ur` - Urdu, `uz-UZ` - Uzbek, `vi-VN` - Vietnamese, `xh` - Xhosa, `yo` - Yoruba, `zu` - Zulu\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"ReportJsonGet10", "x-api-path-slug"=>"report-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"language"}, {"in"=>"query", "name"=>"latitude"}, {"in"=>"query", "name"=>"longitude"}, {"in"=>"query", "name"=>"oneobservation"}, {"in"=>"query", "name"=>"product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-Language", "Support"]}}}}, "here-batch-geocoder-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"HERE", "x-complete"=>1, "info"=>{"title"=>"Batch Geocoder API", "description"=>"the-here-batch-geocoder-api-is-a-web-service-that-allows-users-to-geocode-large-data-sets-hundreds-of-thousands--users-upload-a-single-input-file-the-service-processes-the-data-asynchronously-and-returns-a-single-file-with-the-results-this-example-set-works-with-version-6-2-34-or-higheradditional-information-can-be-found-on-developer-here-comhttpsdeveloper-here-comrestapisdocumentationbatchgeocoder", "version"=>"1.0.0"}, "host"=>"batch.geocoder.cit.api.here.com", "basePath"=>"/6.2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/jobs/puwWrv32YOU24y8MNoUr793chFAI36aC"=>{"get"=>{"summary"=>"Get Job", "description"=>"*Request the status of a batch geocoder job*\n\nTo check the status, make a request to the `jobs` endpoint appending the `requestId` and using the parameter `action=status `\n \n\n\n\n* **action** `enum`\n \\- Type of request \n\n Valid values are : `cancel`, `runs`, `status`\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request. \n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.", "operationId"=>"getJob", "x-api-path-slug"=>"jobspuwwrv32you24y8mnour793chfai36ac-get", "parameters"=>[{"in"=>"query", "name"=>"action"}, {"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/jobs"=>{"post"=>{"summary"=>"Add Jobs", "description"=>"* Start asynchronously geocoding a large set of addresses in one batch*\n\nSubmit an HTTP POST request with `action=run` and attach the input data to the body. \n \n\n\n\n* **gen** `number`\n \\- Enables/disables backward incompatible behavior in the API\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.\n\n* **action** `enum`\n \\- Type of request\n\n Valid values are : `cancel`, `run`, `status`\n\n* **mailto** `text`\n \\- Email address where completion notification is sent.\n\n* **header** `enum`\n \\- If `true`, a header row is included before the results in the output. \n\n Valid values are : `false`, `true`\n\n* **indelim** `text`\n \\- \n\n* **outdelim** `text`\n \\- \n\n* **outcols** `text`\n \\- \n\n* **outputCombined** `enum`\n \\- \n\n Valid values are : `true`, `false`", "operationId"=>"addJob", "x-api-path-slug"=>"jobs-post", "parameters"=>[{"in"=>"query", "name"=>"action"}, {"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"gen"}, {"in"=>"query", "name"=>"header"}, {"in"=>"query", "name"=>"indelim"}, {"in"=>"query", "name"=>"mailto"}, {"in"=>"query", "name"=>"outcols"}, {"in"=>"query", "name"=>"outdelim"}, {"in"=>"query", "name"=>"outputCombined"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}}}, "here-geocoder-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"HERE", "x-complete"=>1, "info"=>{"title"=>"Geocoder API", "description"=>"the-here-geocoder-api-is-a-web-api-that-offers-geocoding-reverse-geocoding-and-landmark-geocoding-services-geocodinggeocoding-matches-an-address-to-its-correct-location-on-the-map--applications-submit-addresses-or-a-search-string-containing-partial-address-information--the-result-is-either-a-single-record-exactly-matching-the-input-or-a-set-of-records-ranked-by-relevance-when-the-input-is-ambiguous-or-the-input-cannot-be-found-on-the-map-in-the-requested-detail-reverse-geocodingreverse-geocoding-retrieves-a-street-address-or-administrative-area-information-corresponding-to-a-given-geocoordinate-landmark-geocodinglandmark-geocoding-is-a-combination-of-geocoding-landmark-search-and-reverse-geocoding--it-supports-search-for-airports-well-known-landmarks-such-as-the-eiffel-tower-or-landmarks-classified-as-nationally-important--the-result-is-a-list-of-ranked-locations-including-street-addresses-administrative-areas-or-landmarks-this-example-set-works-with-version-6-2-80-or-higheradditional-information-can-be-found-on-developer-here-comhttpsdeveloper-here-comrestapisdocumentationgeocoder", "version"=>"1.0.0"}, "host"=>"geocoder.cit.api.here.com", "basePath"=>"/6.2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/geocode.json"=>{"get"=>{"summary"=>"Geocode using partial address information", "description"=>"*Request the latitude, longitude and details of an address based on partial address information*\n\nThis example shows a structured (qualified) geocoding request using the `geocode` endpoint. In this structured request the data is provided in `country`, `city`, `street` and `housenumber` parameters in the request URL. Note that the street name misses the directional (\"W\") and also the street type. The omitted directional makes the query ambiguous and the response contains therefore two results: One address on West Randolph St and one on East Randolph St.\n \n\n\n\n* **housenumber** `text`\n \\- The house number or house name\n\n* **street** `text`\n \\- The street name can include suite, apt and floor information.\n\n* **city** `text`\n \\- City name\n\n* **country** `text`\n \\- Specify the country or list of countries using the country code (3 bytes, ISO 3166-1-alpha-3) or the country name\n\n* **gen** `number`\n \\- Enables/disables backward incompatible behavior in the API\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.", "operationId"=>"GeocodeJsonGet5", "x-api-path-slug"=>"geocode-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"city"}, {"in"=>"query", "name"=>"country"}, {"in"=>"query", "name"=>"gen"}, {"in"=>"query", "name"=>"housenumber"}, {"in"=>"query", "name"=>"street"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Geocode", "Using", "Partial", "Address", "Information"]}}, "/reversegeocode.json"=>{"get"=>{"summary"=>"Reverse Geocode Landmarks", "description"=>"*Request details of landmarks near to a given latitude and longitude*\n\nLandmark reverse geocoding requests can be made using the `reversegeocode` endpoint, specifying the parameter `mode=retrieveLandmarks`, and adding the `prox` parameter to the request URL. Consult the Geocoder API Reference for a full list of available landmark types.\n\n\n\n* **prox** `prox`\n \\- A type of spatial filter. Proximity specifies a circle to search using a latitude, a longitude, and a radius in meters. e.g. `52.515,13.377,100`\n\n* **mode** `enum`\n \\- Type of search invoked. Search for streets, administrative areas or landmarks, or a combination of all three\n\n Valid values are : `retrieveAddresses`, `retrieveAreas`, `retrieveLandmarks`, `retrieveAll`, `trackPosition`\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.\n\n* **gen** `number`\n \\- Enables/disables backward incompatible behavior in the API", "operationId"=>"ReversegeocodeJsonGet4", "x-api-path-slug"=>"reversegeocode-json-get", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"query", "name"=>"gen"}, {"in"=>"query", "name"=>"mode"}, {"in"=>"query", "name"=>"prox"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reverse", "Geocode", "Landmarks"]}}, "/multi-reversegeocode.json"=>{"post"=>{"summary"=>"Multi-reverse Geocode Addresses", "description"=>"*Request the addresses of up to one hundred locations with one multi-reverse geocoding request*\n\nThe body of the HTTP POST request contains the coordinates and optional radius in the `prox` parameter and an optional numeric identifier in the `id` parameter as plain text, one line per pair of coordinates. The identifier associates each result with the corresponding input. If no id is provided the system creates one starting with 0.\n \n\n\n\n* **mode** `enum`\n \\- Search for prominent landmarks nearby \n\n Valid values are : `retrieveAddresses`, `retrieveAreas`, `retrieveLandmarks`, `retrieveAll`, `trackPosition`\n\n* **gen** `number`\n \\- Enables/disables backward incompatible behavior in the API\n\n* **app_id** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_id` with every request.\n\n* **app_code** `text`\n \\- A 20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an `app_code` with every request.\n\n* **Content-Type** `header`\n\n Accept any content in return\n\n* **Cache-Control** `header`\n\n Ensure that the request is always passed to server so that latest response is retrieved", "operationId"=>"MultiReversegeocodeJsonPost2", "x-api-path-slug"=>"multireversegeocode-json-post", "parameters"=>[{"in"=>"query", "name"=>"app_code"}, {"in"=>"query", "name"=>"app_id"}, {"in"=>"header", "name"=>"Cache-Control"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"gen"}, {"in"=>"query", "name"=>"mode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-reverse", "Geocode", "Resses"]}}}}, "apis"=>{"name"=>"HERE", "x-slug"=>"here", "description"=>"HERE Technologies enables people, enterprises and cities around the world to harness the power of location and create innovative solutions that make our lives safer and more efficient. We transform information from devices, vehicles, infrastructure and...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20089-here-maps.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"3011", "tags"=>"API Provider,General Data,internet,Maps,Mobile,Profiles,Relative Data,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"here/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"HERE Batch Geocoder API", "x-api-slug"=>"here-batch-geocoder-api", "description"=>"HERE Technologies enables people, enterprises and cities around the world to harness the power of location and create innovative solutions that make our lives safer and more efficient. We transform information from devices, vehicles, infrastructure and...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20089-here-maps.jpg", "humanURL"=>"https://developer.here.com", "baseURL"=>"https://batch.geocoder.cit.api.here.com//6.2", "tags"=>"API Provider,General Data,internet,Maps,Mobile,Profiles,Relative Data,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/here/jobs-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/here/here-batch-geocoder-api-openapi.yaml"}]}, {"name"=>"HERE Custom Location Extension API", "x-api-slug"=>"here-custom-location-extension-api", "description"=>"HERE Technologies enables people, enterprises and cities around the world to harness the power of location and create innovative solutions that make our lives safer and more efficient. We transform information from devices, vehicles, infrastructure and...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20089-here-maps.jpg", "humanURL"=>"https://developer.here.com", "baseURL"=>"https://customlocation.cit.api.here.com//v1/search", "tags"=>"Job", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/here/corridor-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/here/here-custom-location-extension-api-openapi.yaml"}]}, {"name"=>"HERE Geocoder API", "x-api-slug"=>"here-geocoder-api", "description"=>"HERE Technologies enables people, enterprises and cities around the world to harness the power of location and create innovative solutions that make our lives safer and more efficient. We transform information from devices, vehicles, infrastructure and...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20089-here-maps.jpg", "humanURL"=>"https://developer.here.com", "baseURL"=>"https://geocoder.cit.api.here.com//6.2", "tags"=>"Find,Locations,Using,Corridor", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/here/multireversegeocode-json-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/here/here-geocoder-api-openapi.yaml"}]}, {"name"=>"HERE Map Image API", "x-api-slug"=>"here-map-image-api", "description"=>"HERE Technologies enables people, enterprises and cities around the world to harness the power of location and create innovative solutions that make our lives safer and more efficient. We transform information from devices, vehicles, infrastructure and...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20089-here-maps.jpg", "humanURL"=>"https://developer.here.com", "baseURL"=>"https://image.maps.cit.api.here.com//mia/1.6", "tags"=>"Multi-reverse,Geocode,Resses", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/here/route-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/here/here-map-image-api-openapi.yaml"}]}, {"name"=>"HERE Map Tile API", "x-api-slug"=>"here-map-tile-api", "description"=>"HERE Technologies enables people, enterprises and cities around the world to harness the power of location and create innovative solutions that make our lives safer and more efficient. We transform information from devices, vehicles, infrastructure and...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20089-here-maps.jpg", "humanURL"=>"https://developer.here.com", "baseURL"=>"https://1.aerial.maps.cit.api.here.com//maptile/2.1/maptile/newest", "tags"=>"Map,Image,Polylines", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/here/truckonlytilenewestnormal-day1221991342256png8-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/here/here-map-tile-api-openapi.yaml"}]}, {"name"=>"HERE Places API", "x-api-slug"=>"here-places-api", "description"=>"HERE Technologies enables people, enterprises and cities around the world to harness the power of location and create innovative solutions that make our lives safer and more efficient. We transform information from devices, vehicles, infrastructure and...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20089-here-maps.jpg", "humanURL"=>"https://developer.here.com", "baseURL"=>"https://places.demo.api.here.com//places/v1", "tags"=>"Transparent,Truck,Restrictions,Map", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/here/discoversearch-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/here/here-places-api-openapi.yaml"}]}, {"name"=>"HERE Public Transit API", "x-api-slug"=>"here-public-transit-api", "description"=>"HERE Technologies enables people, enterprises and cities around the world to harness the power of location and create innovative solutions that make our lives safer and more efficient. We transform information from devices, vehicles, infrastructure and...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20089-here-maps.jpg", "humanURL"=>"https://developer.here.com", "baseURL"=>"https://cit.transit.api.here.com//", "tags"=>"One-Box,Search", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/here/metarouterrestboardservicev1multiboardby-geocoord-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/here/here-public-transit-api-openapi.yaml"}]}, {"name"=>"HERE Route Match Extension API", "x-api-slug"=>"here-route-match-extension-api", "description"=>"HERE Technologies enables people, enterprises and cities around the world to harness the power of location and create innovative solutions that make our lives safer and more efficient. We transform information from devices, vehicles, infrastructure and...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20089-here-maps.jpg", "humanURL"=>"https://developer.here.com", "baseURL"=>"https://pde.cit.api.here.com//1", "tags"=>"All,Next,Departures,From,Location", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/here/doclayer-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/here/here-route-match-extension-api-openapi.yaml"}]}, {"name"=>"HERE Routing API", "x-api-slug"=>"here-routing-api", "description"=>"HERE Technologies enables people, enterprises and cities around the world to harness the power of location and create innovative solutions that make our lives safer and more efficient. We transform information from devices, vehicles, infrastructure and...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20089-here-maps.jpg", "humanURL"=>"https://developer.here.com", "baseURL"=>"https://route.cit.api.here.com//routing/7.2", "tags"=>"Available,Attributes,Within,Map,Data,Layer", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/here/getroute-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/here/here-routing-api-openapi.yaml"}]}, {"name"=>"HERE Traffic API", "x-api-slug"=>"here-traffic-api", "description"=>"HERE Technologies enables people, enterprises and cities around the world to harness the power of location and create innovative solutions that make our lives safer and more efficient. We transform information from devices, vehicles, infrastructure and...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20089-here-maps.jpg", "humanURL"=>"https://developer.here.com", "baseURL"=>"https://tiles.traffic.cit.api.here.com//traffic/6.0/tiles/8/133/86/256", "tags"=>"Previously,Calculated,Route,Information", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/here/6-0incidents-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/here/here-traffic-api-openapi.yaml"}]}, {"name"=>"HERE Venue Maps", "x-api-slug"=>"here-venue-maps", "description"=>"HERE Technologies enables people, enterprises and cities around the world to harness the power of location and create innovative solutions that make our lives safer and more efficient. We transform information from devices, vehicles, infrastructure and...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20089-here-maps.jpg", "humanURL"=>"https://developer.here.com", "baseURL"=>"https://signature.venue.maps.cit.api.here.com//venues/signature", "tags"=>"Traffic,Incidents,Via,Proximity", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/here/0tilesiab64l112022001101210030210-js-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/here/here-venue-maps-openapi.yaml"}]}, {"name"=>"HERE Waypoint Sequence Extension API", "x-api-slug"=>"here-waypoint-sequence-extension-api", "description"=>"HERE Technologies enables people, enterprises and cities around the world to harness the power of location and create innovative solutions that make our lives safer and more efficient. We transform information from devices, vehicles, infrastructure and...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20089-here-maps.jpg", "humanURL"=>"https://developer.here.com", "baseURL"=>"https://wse.cit.api.here.com//2", "tags"=>"Base64,Encoded,Map,Tiles", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/here/findsequence-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/here/here-waypoint-sequence-extension-api-openapi.yaml"}]}, {"name"=>"HERE Weather API", "x-api-slug"=>"here-weather-api", "description"=>"HERE Technologies enables people, enterprises and cities around the world to harness the power of location and create innovative solutions that make our lives safer and more efficient. We transform information from devices, vehicles, infrastructure and...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20089-here-maps.jpg", "humanURL"=>"https://developer.here.com", "baseURL"=>"https://weather.cit.api.here.com//weather/1.0", "tags"=>"Waypoint,SequenceHazardous,Materials", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/here/report-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/here/here-weather-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog-rss", "url"=>"https://developer.here.com/blog/feed"}, {"type"=>"x-github", "url"=>"https://github.com/heremaps"}, {"type"=>"x-postman-collection", "url"=>"https://github.com/heremaps/postman-collections"}, {"type"=>"x-blog", "url"=>"https://developer.here.com/blog"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/here-inc"}, {"type"=>"x-developer", "url"=>"https://developer.here.com"}, {"type"=>"x-email", "url"=>"dirk.popp@here.com"}, {"type"=>"x-email", "url"=>"sebastian.kurme@here.com"}, {"type"=>"x-email", "url"=>"jordan.stark@here.com"}, {"type"=>"x-email", "url"=>"amy.stupavsky@here.com"}, {"type"=>"x-email", "url"=>"minna.laub@here.com"}, {"type"=>"x-email", "url"=>"stefanie.sirc@here.com"}, {"type"=>"x-email", "url"=>"rachel.kuta@here.com"}, {"type"=>"x-email", "url"=>"laurel.davis-lyons@here.com"}, {"type"=>"x-email", "url"=>"linda.bradley@here.com"}, {"type"=>"x-email", "url"=>"press@here.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/here"}, {"type"=>"x-website", "url"=>"https://here.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-elasticsearch-service{"amazon-elasticsearch-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Elasticsearch Service", "x-complete"=>1, "info"=>{"title"=>"AWS Elasticsearch Service API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/2015-01-01/tags"=>{"post"=>{"summary"=>"Add Tags", "description"=>"Attaches resource tags to an Amazon ES domain. Use the POST HTTP method\n with this operation. For more information, see Tagging Amazon ES\n Domains.", "operationId"=>"addTags", "x-api-path-slug"=>"20150101tags-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/2015-01-01/es/domain"=>{"post"=>{"summary"=>"Create Elasticsearch Domain", "description"=>"Creates a new Amazon ES domain. Use the HTTP POST method with this\n operation. For more information, see Creating Amazon ES Domains.", "operationId"=>"createElasticsearchDomain", "x-api-path-slug"=>"20150101esdomain-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/2015-01-01/es/domain/{domain_name}"=>{"delete"=>{"summary"=>"Delete Elasticsearch Domain", "description"=>"Deletes an Amazon ES domain and all of its data. A domain cannot be recovered after it\n is deleted. Use the DELETE HTTP method with this operation.", "operationId"=>"deleteElasticsearchDomain", "x-api-path-slug"=>"20150101esdomaindomain-name-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}, "get"=>{"summary"=>"Describe Elasticsearch Domain", "description"=>"Describes the domain configuration for the specified Amazon ES domain, including the\n domain ID, domain service endpoint, and domain ARN. Use the HTTP GET\n method with this operation.", "operationId"=>"describeElasticsearchDomain", "x-api-path-slug"=>"20150101esdomaindomain-name-get", "parameters"=>[{"in"=>"query", "name"=>"DomainName", "description"=>"Name of the Amazon ES domain that you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/2015-01-01/es/domain-info"=>{"post"=>{"summary"=>"Describe Elasticsearch Domains", "description"=>"Describes the domain configuration for up to five specified Amazon ES domains.\n Information includes the domain ID, domain service endpoint, and domain ARN. Use the\n HTTP POST method with this operation.", "operationId"=>"describeElasticsearchDomains", "x-api-path-slug"=>"20150101esdomaininfo-post", "parameters"=>[{"in"=>"body", "name"=>"DomainNames", "description"=>"Array of Amazon ES domains in the following format:{DomainNames:[<Domain_Name>,<Domain_Name>", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/2015-01-01/domain"=>{"get"=>{"summary"=>"List Domain Names", "description"=>"Displays the names of all Amazon ES domains owned by the current user.", "operationId"=>"listDomainNames", "x-api-path-slug"=>"20150101domain-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/2015-01-01/es/domain/{domain_name}/config"=>{"get"=>{"summary"=>"Describe Elasticsearch Domain Config", "description"=>"Displays the configuration of an Amazon ES domain. Use the HTTP GET method\n with this operation.", "operationId"=>"describeElasticsearchDomainConfig", "x-api-path-slug"=>"20150101esdomaindomain-nameconfig-get", "parameters"=>[{"in"=>"query", "name"=>"DomainName", "description"=>"Name of the Amazon ES domain", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}, "post"=>{"summary"=>"Update Elasticsearch Domain Config", "description"=>"Modifies the configuration of an Amazon ES domain, such as the instance type and the\n number of instances. Use the POST HTTP method with this\n operation.", "operationId"=>"updateElasticsearchDomainConfig", "x-api-path-slug"=>"20150101esdomaindomain-nameconfig-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/2015-01-01/tags?arn={domain_arn}"=>{"get"=>{"summary"=>"List Tags", "description"=>"Displays all of the tags for an Amazon ES domain. Use the GET HTTP method\n with this operation.", "operationId"=>"listTags", "x-api-path-slug"=>"20150101tagsarndomain-arn-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "es.{aws_region}.amazonaws.com/2015-01-01/tags-removal"=>{"post"=>{"summary"=>"Remove Tags", "description"=>"Removes the specified resource tags from an Amazon ES domain. Use the POST\n HTTP method with this operation.", "operationId"=>"removeTags", "x-api-path-slug"=>"es-aws-region-amazonaws-com20150101tagsremoval-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}}}, "apis"=>{"name"=>"AWS Elasticsearch Service", "x-slug"=>"aws-elasticsearch-service", "description"=>"Amazon Elasticsearch Service makes it easy to deploy, operate, and scale Elasticsearch for log analytics, full text search, application monitoring, and more. Amazon Elasticsearch Service is a fully managed service that delivers Elasticsearch’s easy-to-use APIs and real-time capabilities along with the availability, scalability, and security required by production workloads. The service offers built-in integrations with Kibana, Logstash, and AWS services including Amazon Kinesis Firehose, AWS Lambda, and Amazon CloudWatch so that you can go from raw data to actionable insights quickly.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Analytics_AmazonElasticsearchService.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Documents,Logging,Profiles,Relative Data,Search,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-elasticsearch-service/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Amazon Elasticsearch Service API", "x-api-slug"=>"amazon-elasticsearch-service-api", "description"=>"Amazon Elasticsearch Service makes it easy to deploy, operate, and scale Elasticsearch for log analytics, full text search, application monitoring, and more. Amazon Elasticsearch Service is a fully managed service that delivers Elasticsearch’s easy-to-use APIs and real-time capabilities along with the availability, scalability, and security required by production workloads. The service offers built-in integrations with Kibana, Logstash, and AWS services including Amazon Kinesis Firehose, AWS Lambda, and Amazon CloudWatch so that you can go from raw data to actionable insights quickly.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Analytics_AmazonElasticsearchService.png", "humanURL"=>"https://aws.amazon.com/elasticsearch-service/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Documents,Logging,Profiles,Relative Data,Search,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-elasticsearch-service/amazon-elasticsearch-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-console", "url"=>"https://console.aws.amazon.com/es/home?region=us-east-1"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/elasticsearch-service/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/elasticsearch-service/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/elasticsearch-service/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/elasticsearch-service/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
logmein{"gotowebinar-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"LogMeIn", "x-complete"=>1, "info"=>{"title"=>"GoToWebinar API", "description"=>"todo-add-description", "version"=>"1.0.0"}, "host"=>"api.getgo.com", "basePath"=>"/G2W/rest/organizers", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{organizerKey}/webinars/{webinarKey}/panelists"=>{"get"=>{"summary"=>"Get webinar panelists", "description"=>"Get webinar panelists.", "operationId"=>"WebinarsPanelistsByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeypanelists-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webinar", "Panelists"]}, "post"=>{"summary"=>"Create Panelists", "description"=>"Create panelists.", "operationId"=>"WebinarsPanelistsByOrganizerKeyAndWebinarKeyPost", "x-api-path-slug"=>"organizerkeywebinarswebinarkeypanelists-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Panelists"]}}, "/{organizerkey}/webinars"=>{"post"=>{"summary"=>"Create Webinar", "description"=>"Create webinar.", "operationId"=>"WebinarsByOrganizerkeyPost", "x-api-path-slug"=>"organizerkeywebinars-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerkey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webinar"]}}, "/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees/{registrantKey}"=>{"get"=>{"summary"=>"Get attendee", "description"=>"Get attendee.", "operationId"=>"WebinarsSessionsSessionKeyAttendeesRegistrantKeyByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeysessionssessionkeyattendeesregistrantkey-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"registrantKey"}, {"in"=>"path", "name"=>"sessionKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attendee"]}}, "/{organizerKey}/webinars/{webinarKey}"=>{"get"=>{"summary"=>"Get Webinar", "description"=>"Get webinar.", "operationId"=>"WebinarsByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkey-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webinar"]}, "put"=>{"summary"=>"Update webinar", "description"=>"Update webinar.", "operationId"=>"WebinarsByOrganizerKeyAndWebinarKeyPut", "x-api-path-slug"=>"organizerkeywebinarswebinarkey-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webinar"]}, "delete"=>{"summary"=>"Cancel Webinar", "description"=>"Cancel webinar.", "operationId"=>"WebinarsByOrganizerKeyAndWebinarKeyDelete", "x-api-path-slug"=>"organizerkeywebinarswebinarkey-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"query", "name"=>"sendCancellationEmails"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Webinar"]}}, "/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees/{registrantKey}/questions"=>{"get"=>{"summary"=>"Get attendee questions", "description"=>"Get attendee questions.", "operationId"=>"WebinarsSessionsSessionKeyAttendeesRegistrantKeyQuestionsByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeysessionssessionkeyattendeesregistrantkeyquestions-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"registrantKey"}, {"in"=>"path", "name"=>"sessionKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attendee", "Questions"]}}, "/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/surveys"=>{"get"=>{"summary"=>"Get session surveys", "description"=>"Get session surveys.", "operationId"=>"WebinarsSessionsSessionKeySurveysByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeysessionssessionkeysurveys-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"sessionKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session", "Surveys"]}}, "/{organizerKey}/webinars/{webinarKey}/registrants/{registrantKey}"=>{"get"=>{"summary"=>"Get Registrant", "description"=>"Get registrant.", "operationId"=>"WebinarsRegistrantsRegistrantKeyByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeyregistrantsregistrantkey-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"registrantKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registrant"]}, "delete"=>{"summary"=>"Delete Registrant", "description"=>"Delete registrant.", "operationId"=>"WebinarsRegistrantsRegistrantKeyByOrganizerKeyAndWebinarKeyDelete", "x-api-path-slug"=>"organizerkeywebinarswebinarkeyregistrantsregistrantkey-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"registrantKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registrant"]}}, "/{organizerKey}/webinars/{webinarKey}/meetingtimes"=>{"get"=>{"summary"=>"Get webinar meeting times", "description"=>"Get webinar meeting times.", "operationId"=>"WebinarsMeetingtimesByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeymeetingtimes-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webinar", "Meeting", "Times"]}}, "/{organizerKey}/historicalWebinars"=>{"get"=>{"summary"=>"Historical Webinars", "description"=>"Returns details for completed webinars for the specified organizer and completed webinars of other organizers where the specified organizer is a co-organizer.\n\nParameters:\n- organizerkey \n- fromTime\n- toTime", "operationId"=>"HistoricalWebinarsByOrganizerKeyGet", "x-api-path-slug"=>"organizerkeyhistoricalwebinars-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"fromTime"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"query", "name"=>"toTime"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Webinars"]}}, "/{organizerKey}/webinars/{webinarKey}/audio"=>{"get"=>{"summary"=>"Get audio information", "description"=>"Get audio information.", "operationId"=>"WebinarsAudioByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeyaudio-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audio", "Information"]}, "post"=>{"summary"=>"Update audio information", "description"=>"Update audio information.", "operationId"=>"WebinarsAudioByOrganizerKeyAndWebinarKeyPost", "x-api-path-slug"=>"organizerkeywebinarswebinarkeyaudio-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audio", "Information"]}}, "/{organizerKey}/webinars/{webinarKey}/registrants"=>{"get"=>{"summary"=>"Get registrants", "description"=>"Get registrants.", "operationId"=>"WebinarsRegistrantsByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeyregistrants-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registrants"]}, "post"=>{"summary"=>"Create Registrant (Version 2)", "description"=>"Create registrant (version 2).", "operationId"=>"WebinarsRegistrantsByOrganizerKeyAndWebinarKeyPost2", "x-api-path-slug"=>"organizerkeywebinarswebinarkeyregistrants-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registrant", "(Version", "2)"]}}, "/{organizerKey}/webinars/{webinarKey}/panelists/{panelistKey}/resendInvitation"=>{"post"=>{"summary"=>"Resend panelist invitation", "description"=>"Resend panelist invitation.", "operationId"=>"WebinarsPanelistsPanelistKeyResendInvitationByOrganizerKeyAndWebinarKeyPost", "x-api-path-slug"=>"organizerkeywebinarswebinarkeypanelistspanelistkeyresendinvitation-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"panelistKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resend", "Panelist", "Invitation"]}}, "/{organizerKey}/webinars/{webinarKey}/performance"=>{"get"=>{"summary"=>"Get performance for all webinar sessions", "description"=>"Get performance for all webinar sessions.", "operationId"=>"WebinarsPerformanceByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeyperformance-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Performance", "Webinar", "Sessions"]}}, "/{organizerKey}/webinars/{webinarKey}/coorganizers/{coorganizerkey}/resendInvitation"=>{"post"=>{"summary"=>"Resend invitation", "description"=>"Resend invitation.", "operationId"=>"WebinarsCoorganizersCoorganizerkeyResendInvitationByOrganizerKeyAndWebinarKeyPost", "x-api-path-slug"=>"organizerkeywebinarswebinarkeycoorganizerscoorganizerkeyresendinvitation-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"coorganizerkey"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resend", "Invitation"]}}, "/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/polls"=>{"get"=>{"summary"=>"Get session polls", "description"=>"Get session polls.", "operationId"=>"WebinarsSessionsSessionKeyPollsByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeysessionssessionkeypolls-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"sessionKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session", "Polls"]}}, "/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/questions"=>{"get"=>{"summary"=>"Get session questions", "description"=>"Get session questions.", "operationId"=>"WebinarsSessionsSessionKeyQuestionsByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeysessionssessionkeyquestions-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"sessionKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session", "Questions"]}}, "/{organizerKey}/webinars/{webinarKey}/sessions"=>{"get"=>{"summary"=>"Get webinar sessions", "description"=>"Get webinar sessions.", "operationId"=>"WebinarsSessionsByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeysessions-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webinar", "Sessions"]}}, "/{organizerKey}/webinars/{webinarKey}/registrants/fields"=>{"get"=>{"summary"=>"Get registration fields", "description"=>"Get registration fields.", "operationId"=>"WebinarsRegistrantsFieldsByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeyregistrantsfields-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registration", "Fields"]}}, "/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees"=>{"get"=>{"summary"=>"Get session attendees", "description"=>"Get session attendees.", "operationId"=>"WebinarsSessionsSessionKeyAttendeesByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeysessionssessionkeyattendees-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"sessionKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session", "Attendees"]}}, "/{organizerKey}/webinars/{webinarKey}/attendees"=>{"get"=>{"summary"=>"Get attendees for all webinar sessions", "description"=>"Get attendees for all webinar sessions.", "operationId"=>"WebinarsAttendeesByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeyattendees-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attendees", "Webinar", "Sessions"]}}, "/{organizerKey}/webinars"=>{"get"=>{"summary"=>"Get All Webinars", "description"=>"Returns webinars scheduled for the future for a specified organizer.", "operationId"=>"WebinarsByOrganizerKeyGet", "x-api-path-slug"=>"organizerkeywebinars-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webinars"]}}, "/{organizerKey}/webinars/{webinarKey}/coorganizers"=>{"get"=>{"summary"=>"Get co-organizers", "description"=>"Get co-organizers.", "operationId"=>"WebinarsCoorganizersByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeycoorganizers-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Co-organizers"]}, "post"=>{"summary"=>"Create co-organizers", "description"=>"Create co-organizers.", "operationId"=>"WebinarsCoorganizersByOrganizerKeyAndWebinarKeyPost", "x-api-path-slug"=>"organizerkeywebinarswebinarkeycoorganizers-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Co-organizers"]}}, "/{organizerKey}/upcomingWebinars"=>{"get"=>{"summary"=>"Upcoming Webinars", "description"=>"Returns webinars scheduled for the future for the specified organizer and webinars of other organizers where the specified organizer is a co-organizer.", "operationId"=>"UpcomingWebinarsByOrganizerKeyGet", "x-api-path-slug"=>"organizerkeyupcomingwebinars-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upcoming", "Webinars"]}}, "/{organizerKey}/sessions"=>{"get"=>{"summary"=>"Get organizer sessions", "description"=>"Get organizer sessions.", "operationId"=>"SessionsByOrganizerKeyGet", "x-api-path-slug"=>"organizerkeysessions-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"fromTime"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"query", "name"=>"toTime"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizer", "Sessions"]}}, "/{organizerKey}/webinars/{webinarKey}/coorganizers/{coorganizerkey}"=>{"delete"=>{"summary"=>"Delete co-organizers", "description"=>"Delete co-organizers.", "operationId"=>"WebinarsCoorganizersCoorganizerkeyByOrganizerKeyAndWebinarKeyDelete", "x-api-path-slug"=>"organizerkeywebinarswebinarkeycoorganizerscoorganizerkey-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"coorganizerkey"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Co-organizers"]}}, "/{organizerKey}/webinars/{webinarKey}/panelists/{panelistKey}"=>{"delete"=>{"summary"=>"Delete webinar panelist", "description"=>"Delete webinar panelist.", "operationId"=>"WebinarsPanelistsPanelistKeyByOrganizerKeyAndWebinarKeyDelete", "x-api-path-slug"=>"organizerkeywebinarswebinarkeypanelistspanelistkey-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"panelistKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webinar", "Panelist"]}}, "/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}"=>{"get"=>{"summary"=>"Get webinar session", "description"=>"Get webinar session.", "operationId"=>"WebinarsSessionsSessionKeyByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeysessionssessionkey-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"sessionKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webinar", "Session"]}}, "/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/performance"=>{"get"=>{"summary"=>"Get session performance", "description"=>"Get session performance.", "operationId"=>"WebinarsSessionsSessionKeyPerformanceByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeysessionssessionkeyperformance-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"sessionKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session", "Performance"]}}, "/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees/{registrantKey}/surveys"=>{"get"=>{"summary"=>"Get attendee survey answers", "description"=>"Get attendee survey answers.", "operationId"=>"WebinarsSessionsSessionKeyAttendeesRegistrantKeySurveysByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeysessionssessionkeyattendeesregistrantkeysurveys-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"registrantKey"}, {"in"=>"path", "name"=>"sessionKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attendee", "Survey", "Answers"]}}, "/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees/{registrantKey}/polls"=>{"get"=>{"summary"=>"Get attendee poll answers", "description"=>"Get attendee poll answers.", "operationId"=>"WebinarsSessionsSessionKeyAttendeesRegistrantKeyPollsByOrganizerKeyAndWebinarKeyGet", "x-api-path-slug"=>"organizerkeywebinarswebinarkeysessionssessionkeyattendeesregistrantkeypolls-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"registrantKey"}, {"in"=>"path", "name"=>"sessionKey"}, {"in"=>"path", "name"=>"webinarKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attendee", "Poll", "Answers"]}}}}, "gotomeeting-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"LogMeIn", "x-complete"=>1, "info"=>{"title"=>"GoToMeeting", "description"=>"httpsgotodeveloper-logmeininc-comhowgetaccesstokenandorganizerkey", "version"=>"1.0.0"}, "host"=>"api.getgo.com", "basePath"=>"/G2M/rest", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/groups/{groupKey}/upcomingMeetings"=>{"get"=>{"summary"=>"Upcoming meetings by group", "description"=>"Get upcoming meetings for a specified group. This API call is only available to users with the admin role. This API call can be used only for groups with maximum 50 organizers.", "operationId"=>"GroupsUpcomingMeetingsByGroupKeyGet", "x-api-path-slug"=>"groupsgroupkeyupcomingmeetings-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"groupKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upcoming", "Meetings", "By", "Group"]}}, "/organizers/{organizerKey}"=>{"get"=>{"summary"=>"Organizer", "description"=>"Gets the individual organizer specified by the organizer's email address. If an email address is not specified, all organizers are returned. This API call is only available to users with the admin role.", "operationId"=>"OrganizersByOrganizerKeyGet", "x-api-path-slug"=>"organizersorganizerkey-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizer"]}, "put"=>{"summary"=>"Organizer", "description"=>"Updates the products of the specified organizer. To add a product (G2M, G2W, G2T, OPENVOICE) for the organizer, the call must be sent once for each product you want to add. To remove all products for the organizer, set status to 'suspended'. The call is limited to users with the admin role.\r\n\t\t\t\t\t\t\t\t\t\t\r\n\t\tfield\t\t\tvalue\t\t\tdescription\t\t\r\n\t\t\"firstName\"\t\t\t\"First\"\t\t\tString - max 25 characters\t\t\r\n\t\t\"lastName\"\t\t\t\"Last\"\t\t\tString - max 25 characters\t\t\r\n\t\t\"organizerEmail\"\t\t\t\"valid.org@email.com\"\t\t\tString with valid email syntax\t\t\r\n\t\t\"productType\"\t\t\t\"G2M\"\t\t\tMust be: G2M, G2W, G2T, OV\t\t\r\n\t\t\"status\"\t\t\t\"suspended\"\t\t\tMust be: blank or suspended", "operationId"=>"OrganizersByOrganizerKeyPut", "x-api-path-slug"=>"organizersorganizerkey-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizer"]}, "delete"=>{"summary"=>"Organizer", "description"=>"Deletes the individual organizer specified by the organizer key. This API call is only available to users with the admin role.", "operationId"=>"OrganizersByOrganizerKeyDelete", "x-api-path-slug"=>"organizersorganizerkey-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizer"]}}, "/meetings"=>{"post"=>{"summary"=>"Meeting", "description"=>"Create a new meeting based on the parameters specified.\r\n\r\n\t\t\t\t\t\t\t\t\t\t\r\n\t\tfield\t\t\tvalue\t\t\tdescription\t\t\r\n\t\t\"subject\"\t\t\t\"subject\"\t\t\tString - max 100 char.\t\t\r\n\t\t\"starttime\"\t\t\t\"2019-05-10T12:00:00Z\"\t\t\t{YYYY}-{MM}-{DD}T{HH}:{MM}:{SS}Z format, UTC only\t\t\r\n\t\t\"endtime\"\t\t\t\"2019-05-10T13:00:00Z\"\t\t\t{YYYY}-{MM}-{DD}T{HH}:{MM}:{SS}Z format, UTC only\t\t\r\n\t\t\"passwordRequired\"\t\t\tFALSE\t\t\tBoolean: true, false\t\t\r\n\t\t\"conferencecallinfo\"\t\t\t\"hybrid\"\t\t\tMust be one of: Hybrid, PTSN, Free, Private, VoIP.\t\t\r\n\t\t\"timezonekey\"\t\t\t\t\t\tAll times default to UTC\t\t\r\n\t\t\"meetingtype\"\t\t\t\"scheduled\"\t\t\tMust be one of: scheduled, recurring, immediate", "operationId"=>"MeetingsPost", "x-api-path-slug"=>"meetings-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meeting"]}}, "/groups"=>{"get"=>{"summary"=>"Groups", "description"=>"List all groups for an account. This API call is only available to users with the admin role.", "operationId"=>"GroupsGet", "x-api-path-slug"=>"groups-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/organizers"=>{"get"=>{"summary"=>"Organizer by email", "description"=>"Gets the individual organizer specified by the organizer's email address. If an email address is not specified, all organizers are returned. This API call is only available to users with the admin role.", "operationId"=>"OrganizersGet", "x-api-path-slug"=>"organizers-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizer", "By", "Email"]}, "post"=>{"summary"=>"Organizer", "description"=>"Creates a new organizer and sends an email to the email address defined in the request. This API call is only available to users with the admin role. You may also pass 'G2W' or 'G2T' or 'OPENVOICE' as productType, to create organizers for those products. A G2W or G2T organizer will also have access to G2M.\r\n\r\n\t\t\t\t\t\t\t\t\t\t\r\n\t\tfield\t\t\tvalue\t\t\tdescription\t\t\r\n\t\t\"firstName\"\t\t\t\"First\"\t\t\tString - max 25 characters\t\t\r\n\t\t\"lastName\"\t\t\t\"Last\"\t\t\tString - max 25 characters\t\t\r\n\t\t\"organizerEmail\"\t\t\t\"valid.org@email.com\"\t\t\tString with valid email syntax\t\t\r\n\t\t\"productType\"\t\t\t\"G2M\"\t\t\tMust be: G2M, G2W, G2T, OV", "operationId"=>"OrganizersPost", "x-api-path-slug"=>"organizers-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizer"]}, "delete"=>{"summary"=>"Organizer by email", "description"=>"Deletes the individual organizer specified by the email address. This API call is only available to users with the admin role.", "operationId"=>"OrganizersDelete", "x-api-path-slug"=>"organizers-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizer", "By", "Email"]}}, "/historicalMeetings"=>{"get"=>{"summary"=>"Historical meetings", "description"=>"Get historical meetings for the currently authenticated organizer that started within the specified date/time range. Remark: Meetings which are still ongoing at the time of the request are NOT contained in the result array.", "operationId"=>"HistoricalMeetingsGet", "x-api-path-slug"=>"historicalmeetings-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"endDate"}, {"in"=>"query", "name"=>"startDate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Meetings"]}}, "/meetings/{meetingInstanceKey}/attendees"=>{"get"=>{"summary"=>"Attendees by meeting", "description"=>"List all attendees for specified meetingId of historical meeting. The historical meetings can be fetched using 'Get historical meetings', 'Get historical meetings by organizer', and 'Get historical meetings by group'. For users with the admin role this call returns attendees for any meeting. For any other user the call will return attendees for meetings on which the user is a valid organizer.", "operationId"=>"MeetingsAttendeesByMeetingInstanceKeyGet", "x-api-path-slug"=>"meetingsmeetinginstancekeyattendees-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"meetingInstanceKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attendees", "By", "Meeting"]}}, "/meetings/{meetingId}/start"=>{"get"=>{"summary"=>"Meeting link", "description"=>"Returns a host URL that can be used to start a meeting. When this URL is opened in a web browser, the GoToMeeting client will be downloaded and launched and the meeting will start. The end user is not required to login to a client.", "operationId"=>"MeetingsStartByMeetingIdGet", "x-api-path-slug"=>"meetingsmeetingidstart-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"meetingId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meeting", "Link"]}}, "/organizers/{organizerKey}/attendees"=>{"get"=>{"summary"=>"Attendees by organizer", "description"=>"Lists all attendees for all meetings within a specified date range for a specified organizer. This API call is only available to users with the admin role.", "operationId"=>"OrganizersAttendeesByOrganizerKeyGet", "x-api-path-slug"=>"organizersorganizerkeyattendees-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"endDate"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"query", "name"=>"starttime"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attendees", "By", "Organizer"]}}, "/groups/{groupkey}/organizers"=>{"get"=>{"summary"=>"Organizers by group", "description"=>"Returns all the organizers within a specific group. This API call is only available to users with the admin role.", "operationId"=>"GroupsOrganizersByGroupkeyGet", "x-api-path-slug"=>"groupsgroupkeyorganizers-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"groupkey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "By", "Group"]}}, "/meetings/{meetingId}"=>{"get"=>{"summary"=>"Meeting", "description"=>"Returns the meeting details for the specified meeting.", "operationId"=>"MeetingsByMeetingIdGet", "x-api-path-slug"=>"meetingsmeetingid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"meetingId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meeting"]}, "put"=>{"summary"=>"Meeting", "description"=>"Updates an existing meeting specified by meetingId.\r\n\r\n\t\t\t\t\t\t\t\t\t\t\r\n\t\tfield\t\t\tvalue\t\t\tdescription\t\t\r\n\t\t\"subject\"\t\t\t\"subject\"\t\t\tString - max 100 char.\t\t\r\n\t\t\"starttime\"\t\t\t\"2019-05-10T12:00:00Z\"\t\t\t{YYYY}-{MM}-{DD}T{HH}:{MM}:{SS}Z format, UTC only\t\t\r\n\t\t\"endtime\"\t\t\t\"2019-05-10T13:00:00Z\"\t\t\t{YYYY}-{MM}-{DD}T{HH}:{MM}:{SS}Z format, UTC only\t\t\r\n\t\t\"passwordRequired\"\t\t\tFALSE\t\t\tBoolean: true, false\t\t\r\n\t\t\"conferencecallinfo\"\t\t\t\"hybrid\"\t\t\tMust be one of: Hybrid, PTSN, Free, Private, VoIP.\t\t\r\n\t\t\"timezonekey\"\t\t\t\t\t\tAll times default to UTC\t\t\r\n\t\t\"meetingtype\"\t\t\t\"scheduled\"\t\t\tMust be one of: scheduled, recurring, immediate", "operationId"=>"MeetingsByMeetingIdPut", "x-api-path-slug"=>"meetingsmeetingid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"meetingId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meeting"]}, "delete"=>{"summary"=>"Meeting", "description"=>"Deletes the meeting identified by the meetingId.", "operationId"=>"MeetingsByMeetingIdDelete", "x-api-path-slug"=>"meetingsmeetingid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"meetingId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meeting"]}}, "/groups/{groupkey}/attendees"=>{"get"=>{"summary"=>"Attendees by group", "description"=>"Returns all attendees for all meetings within specified date range held by organizers within the specified group. This API call is only available to users with the admin role. This API call can be used only for groups with maximum 50 organizers.", "operationId"=>"GroupsAttendeesByGroupkeyGet", "x-api-path-slug"=>"groupsgroupkeyattendees-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"endDate"}, {"in"=>"path", "name"=>"groupkey"}, {"in"=>"query", "name"=>"startDate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attendees", "By", "Group"]}}, "/upcomingMeetings"=>{"get"=>{"summary"=>"Upcoming meetings", "description"=>"Gets upcoming meetings for the current authenticated organizer.", "operationId"=>"UpcomingMeetingsGet", "x-api-path-slug"=>"upcomingmeetings-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upcoming", "Meetings"]}}, "/groups/{groupKey}/organizers"=>{"post"=>{"summary"=>"Organizer in group", "description"=>"Creates a new organizer and sends an email to the email address defined in request. This API call is only available to users with the admin role. You may also pass 'G2W' or 'G2T' or 'OPENVOICE' as productType variables, creating organizers for those products. A G2W or G2T organizer will also have access to G2M.\r\n\t\t\t\t\t\t\t\t\t\t\r\n\t\tfield\t\t\tvalue\t\t\tdescription\t\t\r\n\t\t\"organizerEmail\"\t\t\t\"valid.org@email.com\"\t\t\tString with valid email syntax\t\t\r\n\t\t\"firstName\"\t\t\t\"First\"\t\t\tString - max 25 characters\t\t\r\n\t\t\"lastName\"\t\t\t\"Last\"\t\t\tString - max 25 characters\t\t\r\n\t\t\"productType\"\t\t\t\"G2M\"\t\t\tMust be: G2M, G2W, G2T, OV", "operationId"=>"GroupsOrganizersByGroupKeyPost", "x-api-path-slug"=>"groupsgroupkeyorganizers-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"groupKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizer", "In", "Group"]}}, "/organizers/{organizerKey}/historicalMeetings"=>{"get"=>{"summary"=>"Historical meetings by organizer", "description"=>"Get historical meetings for the specified organizer that started within the specified date/time range. Meetings which are still ongoing at the time of the request are not included in the result.", "operationId"=>"OrganizersHistoricalMeetingsByOrganizerKeyGet", "x-api-path-slug"=>"organizersorganizerkeyhistoricalmeetings-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"endDate"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"query", "name"=>"startDate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Meetings", "By", "Organizer"]}}, "/groups/{groupkey}/historicalMeetings"=>{"get"=>{"summary"=>"Historical meetings by group", "description"=>"Get historical meetings for the specified group that started within the specified date/time range. This API call is only available to users with the admin role. This API call is restricted to groups with a maximum of 50 organizers. Remark: Meetings which are still ongoing at the time of the request are NOT contained in the result array.", "operationId"=>"GroupsHistoricalMeetingsByGroupkeyGet", "x-api-path-slug"=>"groupsgroupkeyhistoricalmeetings-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"endDate"}, {"in"=>"path", "name"=>"groupkey"}, {"in"=>"query", "name"=>"startDate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Meetings", "By", "Group"]}}}}, "gototraining-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"LogMeIn", "x-complete"=>1, "info"=>{"title"=>"GoToTraining API", "description"=>"todo-add-description", "version"=>"1.0.0"}, "host"=>"api.getgo.com", "basePath"=>"/G2T/rest", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/trainings/{trainingKey}/start"=>{"get"=>{"summary"=>"Start Training", "description"=>"Start training.", "operationId"=>"TrainingsStartByTrainingKeyGet", "x-api-path-slug"=>"trainingstrainingkeystart-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"trainingKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Start", "Training"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}/startUrl"=>{"get"=>{"summary"=>"Get Start Url", "description"=>"Get start url.", "operationId"=>"OrganizersTrainingsStartUrlByOrganizerKeyAndTrainingKeyGet", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeystarturl-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"trainingKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Start", "Url"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}/organizers"=>{"put"=>{"summary"=>"Update Training Organizers", "description"=>"Update training organizers.", "operationId"=>"OrganizersTrainingsOrganizersByOrganizerKeyAndTrainingKeyPut2", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeyorganizers-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"trainingKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Training", "Organizers"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}/registrants/{registrantKey}"=>{"get"=>{"summary"=>"Get Registrant", "description"=>"Get registrant.", "operationId"=>"OrganizersTrainingsRegistrantsRegistrantKeyByOrganizerKeyAndTrainingKeyGet", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeyregistrantsregistrantkey-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"registrantKey"}, {"in"=>"path", "name"=>"trainingKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registrant"]}, "delete"=>{"summary"=>"Cancel Registration", "description"=>"Cancel registration.", "operationId"=>"OrganizersTrainingsRegistrantsRegistrantKeyByOrganizerKeyAndTrainingKeyDelete", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeyregistrantsregistrantkey-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"registrantKey"}, {"in"=>"path", "name"=>"trainingKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Registration"]}}, "/reports/organizers/{organizerKey}/trainings/{trainingKey}"=>{"get"=>{"summary"=>"Get Sessions by Training", "description"=>"Get sessions by training.", "operationId"=>"ReportsOrganizersTrainingsByOrganizerKeyAndTrainingKeyGet", "x-api-path-slug"=>"reportsorganizersorganizerkeytrainingstrainingkey-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"trainingKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions", "By", "Training"]}}, "/organizers/{organizerKey}/trainings"=>{"get"=>{"summary"=>"Get Trainings", "description"=>"Get trainings.", "operationId"=>"OrganizersTrainingsByOrganizerKeyGet", "x-api-path-slug"=>"organizersorganizerkeytrainings-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trainings"]}, "post"=>{"summary"=>"Create Training", "description"=>"Create training.", "operationId"=>"OrganizersTrainingsByOrganizerKeyPost", "x-api-path-slug"=>"organizersorganizerkeytrainings-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Training"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}/registrationSettings"=>{"put"=>{"summary"=>"Update Training Registration Settings", "description"=>"Update training registration settings.", "operationId"=>"OrganizersTrainingsRegistrationSettingsByOrganizerKeyAndTrainingKeyPut", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeyregistrationsettings-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"trainingKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Training", "Registration", "Settings"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}"=>{"get"=>{"summary"=>"Get Training", "description"=>"Get training.", "operationId"=>"OrganizersTrainingsByOrganizerKeyAndTrainingKeyGet", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkey-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"trainingKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Training"]}, "delete"=>{"summary"=>"Delete Training", "description"=>"Delete training.", "operationId"=>"OrganizersTrainingsByOrganizerKeyAndTrainingKeyDelete", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkey-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"trainingKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Training"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}/registrants "=>{"get"=>{"summary"=>"Get Training Registrants", "description"=>"Get training registrants.", "operationId"=>"OrganizersTrainingsRegistrantsByOrganizerKeyAndTrainingKeyGet", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeyregistrants-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"trainingKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Training", "Registrants"]}, "post"=>{"summary"=>"Register for Training", "description"=>"Register for training.", "operationId"=>"OrganizersTrainingsRegistrantsByOrganizerKeyAndTrainingKeyPost", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeyregistrants-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"trainingKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RegisterTraining"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}/manageUrl"=>{"get"=>{"summary"=>"Get Management URL for Training", "description"=>"Get management url for training.", "operationId"=>"OrganizersTrainingsManageUrlByOrganizerKeyAndTrainingKeyGet", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeymanageurl-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"trainingKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Management", "URLTraining"]}}, "/trainings/{trainingKey}/recordings"=>{"get"=>{"summary"=>"Get Online Recordings for Training", "description"=>"Get online recordings for training.", "operationId"=>"TrainingsRecordingsByTrainingKeyGet", "x-api-path-slug"=>"trainingstrainingkeyrecordings-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"trainingKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Online", "RecordingsTraining"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}/times"=>{"put"=>{"summary"=>"Update Training Times", "description"=>"Update training times.", "operationId"=>"OrganizersTrainingsTimesByOrganizerKeyAndTrainingKeyPut", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeytimes-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"trainingKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Training", "Times"]}}, "/organizers/{organizerKey}/trainings/{trainingKey}/nameDescription"=>{"put"=>{"summary"=>"Update Training Name and Description", "description"=>"Update training name and description.", "operationId"=>"OrganizersTrainingsNameDescriptionByOrganizerKeyAndTrainingKeyPut", "x-api-path-slug"=>"organizersorganizerkeytrainingstrainingkeynamedescription-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"trainingKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Training", "Name", "Description"]}}, "/trainings/{trainingKey}/recordings/{recordingId}"=>{"get"=>{"summary"=>"Get Download for Online Recordings", "description"=>"Get download for online recordings.", "operationId"=>"TrainingsRecordingsByTrainingKeyAndRecordingIdGet", "x-api-path-slug"=>"trainingstrainingkeyrecordingsrecordingid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"recordingId"}, {"in"=>"path", "name"=>"trainingKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DownloadOnline", "Recordings"]}}, "/reports/organizers/{organizerKey}/sessions "=>{"post"=>{"summary"=>"Get Sessions by Date Range", "description"=>"Get sessions by date range.", "operationId"=>"ReportsOrganizersSessionsByOrganizerKeyPost", "x-api-path-slug"=>"reportsorganizersorganizerkeysessions-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions", "By", "Date", "Range"]}}, "/reports/organizers/{organizerKey}/sessions/{sessionKey}/attendees"=>{"get"=>{"summary"=>"Get Attendance Details", "description"=>"Get attendance details.", "operationId"=>"ReportsOrganizersSessionsAttendeesByOrganizerKeyAndSessionKeyGet", "x-api-path-slug"=>"reportsorganizersorganizerkeysessionssessionkeyattendees-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"organizerKey"}, {"in"=>"path", "name"=>"sessionKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attendance", "Details"]}}}}, "gotoassist-remote-support-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"LogMeIn", "x-complete"=>1, "info"=>{"title"=>"GoToAssist Remote Support", "description"=>"-setup-instructionsgotoassist-remote-support-api-documentationhttpsgotodeveloper-logmeininc-comapigotoassistrsapi-environment-template1--choose-the-gotoassist-rs-template-on-the-environment-dropdown-menu-top-right-corner-of-the-window2--click-on-the-eye-icon-quick-look-right-next-to-the-environment-dropdown-box-then-click-on-edit-right-next-to-the-environments-name3--fill-the-environment-variables-client-id-and-client-secret-from-your-account--you-can-retrieve-these-by-creating-a-new-app-on-the-developer-centerhttpsgotodeveloper-logmeininc-comusermeapps--oauth-2-01--make-sure-the-gotoassist-rs-environment-is-selected-on-the-dropdown-box-on-top-right-of-the-main-screen-2--rightclick-the-collection-on-the-left-bar3--click-on-edit4--click-on-authorization-tab5--click-on-get-new-access-token6--fill-the-form-with-the-variables-below--they-will-be-pulled-automatically-from-the-environment-template-you-just-loaded---callback-url-callback-url---auth-url-auth-url---access-token-url-access-token-url---client-id-client-id---client-secret-client-secret---client-authentication-send-as-basic-auth-header7--click-on-request-token--you-should-see-a-gotoassist-login-screen-now-8--login-with-your-gotoassist-credentials-9--allow-the-permission-request-to-access-data-from-your-account-10--if-you-had-success-you-should-see-your-newly-generated-access-token--scroll-to-the-bottom-11--copy-your-organizerkey--youll-need-to-save-it-later-as-environment-variable-12--click-on-use-token-13--now-just-make-sure-you-paste-the-organizerkey-on-the-organizerkey-variable-in-your-environment-disclaimer-gotoassist-access-tokens-expire-in-just-1h-so-you-might-need-to-repeat-steps-112-of-the-oauth-2-0-process-every-hour-you-are-working-with-the-api-", "version"=>"1.0.0"}, "host"=>"api.getgo.com", "basePath"=>"/G2A/rest/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/systemLinks"=>{"get"=>{"summary"=>"Partner-System Link Info", "description"=>"This method retrieves all partner-system links that are registered for a given domain. These links are used by GoToAssist to make calls back to the partner system to enable the creation of tickets during support sessions.\n\n Request Parameters \n \n field data type description \n systemDomain string The domain name of the partner system. \n \n\n\n Response Parameters: (* Optional) \n \n field data type description \n systemName string The human-readable name of the partner system (may be displayed to the user in the GoToAssist web application); it is used to uniquely identify partner systems, along with the systemDomain for a particular user \n systemDomain string The domain name of the partner system; it is used to uniquely identify partner systems, along with the systemName for a particular user \n userEmail string The email address of the user these links are for \n userToken string A unique identifier generated by the partner system that will be used to authenticate requests made by GoToAssist on behalf of this user \n callbackURL string The callback URL into the partner system \n \n\nStatus Codes \n \n Staus Code description \n 200 OK The information was successfully retrieved \n 400 Bad Request An error occurred due to a missing systemDomain parameter \n 401 Unauthorized An authentication parameter was passed, but either it was invalid or the technician is not entitled with a Remote Support seat \n 500 Internal Server Error An unhandled error occurred", "operationId"=>"SystemLinksGet", "x-api-path-slug"=>"systemlinks-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"systemDomain"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partner-System", "Link", "Info"]}, "post"=>{"summary"=>"Partner-System Links", "description"=>"This method creates system links, which allows the partner system to enable the creation of objects during attended support sessions by providing certain information to GoToAssist. If the partner system does not call this method, then the corresponding functionality in GoToAssist will be disabled automatically. Note: The partner system should call this method after a user has authenticated via OAuth.\r\n \r\n field value description \r\n \"systemName\" \"The Company\" String - The human-readable name of the partner system (may be displayed to the user in the GoToAssist web application); it is used to uniquely identify partner systems, along with the systemDomain for a particular user. \r\n \"systemDomain\" \"theCompany.com\" String - The domain name of the partner system; it is used to uniquely identify partner systems, along with the systemName for a particular user (NOTE: If a Create partner-system link call is received for the same user, systemName and systemDomain, then the previous links will be overwritten). \r\n \"userEmail\" \"valid.org@email.com\" String with valid email syntax and address of the user these links are for. \r\n \"userToken\" \"F5EE645AAA87462523475FFF8576348574\" String - A unique identifier generated by the partner system that will be used to authenticate requests made by GoToAssist on behalf of this user. \r\n \"callbackURL\" \"https://api.theCompany.com/g2a_prefix\" The callback URL into the partner system. \r\n \"supportedCallbacks\" \"n/a\" The hash of callbacks that the partner system will support (corresponding to the APIs below); possible keys are as follows: \r\n \"createObject\" \"true\" \"Boolean - \" \r\n \"searchObjects\" \"true\" \"Boolean - \" \r\n \"associateObject\" \"true\" \"Boolean - \" \r\n\r\n\r\nStatus Codes\r\n \r\n Status Code Description \r\n 200 OK The callback links have been registered \r\n 400 Bad Request An error occurred due to invalid callback URL \r\n 401 Unauthorized An authentication parameter was passed, but either it was invalid or the technician is not entitled with a Remote Support seat \r\n 500 Internal Server Error An unhandled error occurred", "operationId"=>"SystemLinksPost", "x-api-path-slug"=>"systemlinks-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partner-System", "Links"]}}, "/"=>{"get"=>{"summary"=>"Get Tickets", "description"=>"Retrieves a query-able set of tickets for a specific partner system.\n\n \nRequest Parameters\n \n field data type description \n userToken string The token identifying and authenticating the user in the partner system that this object is being created on behalf of this user. \n\n\nQuery Parameters (* Optional)\n\n field data type description \n q * string A query string used to search for objects in the partner system. (It is up to the partner system to determine how the query string is matched. Match against fields like: ticket title, ticket body, requester name, ticket ID, ticket comments, tags, etc. Ideally the matching should be performed using a ‘contains’ type operation and in a case-insensitive way.) \n limit * integer The maximum number of records to be fetched. Default value is 10. Suggested value is less than or equal to 10 for optimal performance. \n offset * number Zero based offset for the first record to return. Default value is 0.", "operationId"=>"UnnammedEndpointGet", "x-api-path-slug"=>"get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"q"}, {"in"=>"query", "name"=>"userToken"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tickets"]}, "put"=>{"summary"=>"Associate Ticket", "description"=>"Associates a ticket for a particular partner with a current session.\n\n Request Parameters: \n \n field data type description \n sessionId string The unique ID of the session to associate with the new partner object. \n userToken string The token identifying and authenticating the user in the partner system that this object is being created on behalf of this user. \n partnerObject string The partner object to associate with the session.", "operationId"=>"UnnammedEndpointPut", "x-api-path-slug"=>"put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Associate", "Ticket"]}, "post"=>{"summary"=>"Create Ticket", "description"=>"Creates a new ticket connecting the agent's system with the partner system for a specific issue.\n\n Request Parameters: (* Optional) \n \n field data type description \n sessionId string The unique ID of the session to associate with the new partner object. \n userToken string The token identifying and authenticating the user in the partner system that this object is being created on behalf of this user. \n title string A string entered by the technician that should be the title of the new object. \n body string A string entered by the technician that should become the body of the new object.", "operationId"=>"UnnammedEndpointPost", "x-api-path-slug"=>"post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket"]}}, "/archive/recordings/urls[&{attribute}={readyForDownloadRecordingId}]"=>{"get"=>{"summary"=>"Download Recordings", "description"=>"This method retrieves download links for a list of recordings. Each recording returns a link to the MP4 file, the .events file and the thumbnail. If a recording is not available for download then it will be omitted from the returned list. The archiving script may use the returned URLs to download each resource for the recording. The URLs will be valid for at least 48 hours. The URL contains a large random number so that the URL for recordings cannot be guessed. The response includes the recording start time to make it easier for the archiving script to place recordings in directories based on date. No more than 500 recordings can be requested at once.\n\nNote: Session recording must be enabled on the account in order to use this API method. To enable session recording, log in at https://app.gotoassist.com (link is external) and go to Configure > GoToAssist Settings > Enable Session Recording check box.\n\n Response Parameters \n \n field data type description \n recordingId number The recordingId of the session recording to be downloaded \n recordingUrl string The URL of MP4 recording file \n recordingStartTime ISO 8601 format* The start time of recording \n eventsUrl string The URL of the events recording file \n thumbnailUrl string The URL of the thumbnail of recording file \n recordingSize string The size of the .mp4 file in bytes \n\n* ISO 8601 format reference\n \nStatus Codes \n \n Staus Code description \n 200 OK A list of URLs has been returned \n 400 Bad Request Request may be malformed or property may be missing or invalid \n 403 Forbidden Invalid authorization header or invalid recording Ids \n 500 Internal Server Error Unexpected server error", "operationId"=>"ArchiveRecordingsUrlsAPIGet", "x-api-path-slug"=>"archiverecordingsurlsattributereadyfordownloadrecordingid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"attribute"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"readyForDownloadRecordingId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Download", "Recordings"]}}, "/companies"=>{"get"=>{"summary"=>"Get Companies", "description"=>"This method retrieves information about the companies that the authenticated user has access to.\n\n \n Query Parameters (all are optional) \n q string A search query to filter the returned records. Performs a contains check on companyName \n limit integer The maximum number of records to be fetched. Default limit is 50. Valid range is 1 to 50. Greater than 50 results in bad request. \n offset number Zero based offset for the first record to return. Default value is 0. \n sortField string Name of the field to sort by, can be one of companyId, companyName. \n sortOrder Sort order can be specified explicitly. Allowed values are “asc” for ascending order and “desc” for descending order. \n\n\nStatus Codes \n \n Staus Code description \n 200 OK The information was successfully retrieved \n 401 Unauthorized An authentication parameter was passed, but either it was invalid or the technician is not entitled with a Remote Support seat; \n 403 Forbidden Access denied. User doesn’t have required roles \n 404 Not Found No companies found \n 405 Method Not Allowed The method was entered incorrectly (i.e., the technician tried to use POST, PUT etc. instead of GET) \n 500 Internal Server Error An unhandled error occurred", "operationId"=>"CompaniesGet", "x-api-path-slug"=>"companies-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies"]}}, "/sessions"=>{"get"=>{"summary"=>"Get All Sessions", "description"=>"This method retrieves detailed information about all current or previous support sessions (either attended or unattended) for a specified date range. Information about sessions that are complete may only be available for a limited period of time after the end of the session (currently, the information is available for at least 30 days). The session must have been hosted from an account or company that the authenticated user has access to.\n\n Request Parameters \n \n field data type description \n sessionType string The type of the session. Must be set to SCREEN_SHARING. \n\n\n Response Parameters \n \n field data type description \n totalNumSessions number The number of sessions returned. \n For Each Session \n sessionStartToken number A numeric value used to start the session. \n customerJoinUrl string A URL that can be sent to a customer to join the session. \n sessionId number The unique ID of this session. \n sessionType string For these sessions, always screen_sharing. \n partnerObject number The ID of the object in the partner system that is associated with this session. \n partnerObjectUrl string The URL for the expert to view the associated partnerObject. \n status string The current state of the session; it can be: \n\nwaiting = Waiting for the customer to join the session.\nactive = Customer has joined and session is currently active.\ncomplete = Session has ended after the customer joined.\nabandoned = Session has ended without any customer joining.\nnotStarted = Session was created but never started by the expert.\n \n startedAt ISO 8061 format* The time that the session started. \n customerJoinedAt ISO 8061 format* The time that the customer joined the session. \n endedAt ISO 8061 format* The time that the session ended. \n expertName string The human-readable name of the first technician in the support session. \n expertEmail string Email id of the first expert in the session. \n expertUserKey string Unique ID of the first expert in the session in the G2A system. \n customerName string The human-readable name of the customer in the support session. \n customerEmail string The email address of the customer in the support session. \n accountKey number The unique GoToAssist system ID of the account the support session was hosted from. \n sessionRecordingUrl number The URL where the technician can view a recording of the session within the GoToAssist web application (only available if the technician has opted to record support sessions (link is external)) \n \n* ISO 8601 format reference", "operationId"=>"SessionsGet", "x-api-path-slug"=>"sessions-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"fromTime"}, {"in"=>"query", "name"=>"sessionType"}, {"in"=>"query", "name"=>"toTime"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions"]}, "post"=>{"summary"=>"Start Screen Sharing Session", "description"=>"This method creates a new screen sharing support session (either attended or unattended) by generating a URL that automatically launches technicians into a new session when clicked. If a machineUuid request parameter is specified, an unattended support session will be created; if it is not specified, then an attended session will be created. See \"Request Parameters\" for more information. Note: The locale of the session start dialog will be based upon the technician’s locale setting within GoToAssist.\n\nNote: This method was formerly named \"Create Attended Session,\" but has been renamed to address the fact that it now includes unattended support sessions as well.\n\n Request Parameters \n \n field data type description \n sessionStatusCallbackUrl* string The URL that will receive a POST when the session status changes. A POST will also be made to the sessionStatusCallbackUrl when a customer joins the session and when the session ends (whether or not a customer joined). The contents of the POST will be similar as the GET /v1/sessions/ API. Note: The ID of the session is not known until the session is actually started on the endpoint. If the URL is not specified or the session is never started (e.g., if the customer cancels the installation of the GoToAssist Customer desktop application), then the callback will not be made. \n sessionType string The type of session to create (only \"SCREEN_SHARING\" can be used at this time). \n partnerObject* string The ID of object in the partner system that this session will be associated with. \n partnerObjectUrl* string The URL that may be used in the GoToAssist Expert desktop application if the technician wants to view the partner object. Note: The URL can be used in a popup window or iframe that is 600 pixels wide and 500 pixels wide. For example, a popup window could be created with HTML code as follows: \"Start Remote Support \" \n customerName* string The name of the customer that the session is being started for. \n customerEmail* string The email address of the customer that the session is being started for (if available) \n machineUuid* string The machineUuid is only necessary for unattended support sessions. If the machineUuid is present when a screen sharing session is started, then the endpoint will connect to the specified unattended machine and an unattended support session will be started. If no machineUuid is specified, then an attended support session will be created. A list of machineUuid parameters associated with the user and company will be available through a /machines API in future. \n \n* Optional parameters\n\nStatus Codes \n \n Staus Code description \n 200 OK The response contains the URL to start the session \n 400 Bad Request An error occurred due to missing required parameters or portal not being created \n 401 Unauthorized An authentication parameter was passed, but either it was invalid or the technician is not entitled with a Remote Support seat \n 403 Forbidden Access denied. User doesn’t have required roles \n 404 Not Found A machineUuid was specified, but the specified machine was not found in an account the user has access to \n 405 Method Not Allowed The method was entered incorrectly (i.e., the technician tried to use POST, PUT etc. instead of GET) \n 500 Internal Server Error An unhandled error occurred", "operationId"=>"SessionsPost2", "x-api-path-slug"=>"sessions-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Start", "Screen", "Sharing", "Session"]}}, "/archive/recordings"=>{"get"=>{"summary"=>"Available Recordings", "description"=>"This method retrieves a list of all available recordings on the account. Only recordings which are available for transcoding or downloading will be returned. The recording IDs are always returned in the order in which the recordings were started (i.e., startTime order). The request must contain one or more of the following: accountKey, userKey or companyId. The list of recordings can be filtered by the request parameters listed below.\n\nNote: Session recording must be enabled on the account in order to use this API method. To enable session recording, log in at https://app.gotoassist.com (link is external) and go to Configure > GoToAssist Settings > Enable Session Recording check box.\n\n Request Parameters \n Each request must contain one or more of the following: accountKey, userKey or companyId. \n \n field data type description \n accountKey number The account key associated with the recording ( available in the Get Screen Sharing Session Info (link is external) method response ) \n userKey number The user key of the technician who started the recorded session (available in the Authentication (link is external) API method response) \n companyId number The companyId associated with the recording for unattended support sessions only ( available in the Get Companies (link is external) API method response ) \n sessionType * number The type of session: attended (0) or unattended (1) \n fromTime * ISO 8601 format ** The oldest sessions that should be retrieved (startTime must be greater than or equal to fromTime) \n toTime * ISO 8601 format ** The most recent sessions that should be retrieved (startTime must be greater than or equal to fromTime) \n timePeriod * number The recordings within a Time Period, starting from currentDate (ex: ”timePeriod=30” would retrieve the last 30 days’ recordings) \n archived * number The option to include only archived recordings, as follows: include only archived recordings (1) or include only non-archived recordings (0 or omit) \n \n* Optional \n** ISO 8601 format reference \n \n Response Parameters \n No more than 500 recordings at a time will be returned for readyForTranscode or readyForDownload. \n \n field data type description \n readyForTranscode array A list of recordingIds for recordings that are ready to be transcoded \n readyForDownload array A list of recordingIds for recordings that are ready to be downloaded \n \n \nStatus Codes \n \n Staus Code description \n 200 OK Recordings retrieved successfully \n 400 Bad Request Request may be malformed or property may be missing or invalid \n 403 Forbidden Invalid authorization header or invalid userKey, accountKey or companyId \n 500 Internal Server Error Unexpected server error", "operationId"=>"ArchiveRecordingsGet", "x-api-path-slug"=>"archiverecordings-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"userKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Available", "Recordings"]}}, "/session"=>{"get"=>{"summary"=>"Start Attended Session in Browser", "description"=>"This method allows a partner system to launch an attended support session within a browser window. This API does not require authentication, so the technician will be prompted to enter their credentials when they run the GoToAssist Expert desktop application for the first time. Since the technician is not required to navigate to a URL, no API is implemented to create the session. Note: This method was formerly named \"Create Attended Session in browser,\" but has been renamed.\n\n Request Parameters \n \n field data type description \n sessionType string The type of session to create (only \"SCREEN_SHARING\" can be used at this time). \n layout* string The style of HTML that will be displayed when starting the session (e.g., \"iFrame\"). If this parameter is not present, then the HTML will fill the entire browser window. \n partnerObject* string The ID of object in the partner system that this session will be associated with. \n partnerObjectUrl* string The URL that may be used in the GoToAssist Expert desktop application if the technician wants to view the partner object. Note: The URL can be used in a popup window or iframe that is 600 pixels wide and 500 pixels wide. For example, a popup window could be created with HTML code as follows: Start Remote Support \n sessionStatusCallbackUrl* string The URL that will receive a POST when the session status changes. A POST will also be made to the sessionStatusCallbackUrl when a customer joins the session and when the session ends (whether or not a customer joined). The contents of the POST will be similar as the GET /v1/sessions/ API. Note: The ID of the session is not known until the session is actually started on the endpoint. If the URL is not specified or the session is never started (e.g., if the customer cancels the installation of the GoToAssist Customer desktop application), then the callback will not be made. \n \n* Optional parameters", "operationId"=>"SessionGet", "x-api-path-slug"=>"session-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"sessionType"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Start", "Attended", "Session", "In", "Browser"]}}, "/sessions/{sessionId}"=>{"get"=>{"summary"=>"Get Screen Sharing Session Info", "description"=>"This method retrieves detailed information about a current or previous support session (either attended or unattended) based on the sessionID or sessionToken. “sessionToken” is returned in response of create screen-sharing session API. Information about sessions that are complete may only be available for a limited period of time after the end of the session (currently, the information is available for at least 30 days). The session must have been hosted from an account or company that the authenticated user has access to.\r\n\r\nNote: This method was formerly named \"Get Attended Session Info,\" but has been renamed to address the fact that it now includes unattended support sessions as well.\r\n\r\n Response Parameters \r\n \r\n field data type description \r\n sessionId string The unique ID of this session. \r\n sessionType string The type of the session; this determines what other attributes the response may contain. \r\n status string \"The current state of the session; it can be: \r\nwaiting = Waiting for the customer to join the session.\r\nactive = Customer has joined and session is currently active.\r\ncomplete = Session has ended after the customer joined.\r\nabandoned = Session has ended without any customer joining.\r\nnotStarted = Session was created but never started by the expert.\" \r\n accountKey number The unique GoToAssist system ID of the account the support session was hosted from. \r\n expertName string The human-readable name of the first technician in the support session. \r\n expertEmail string Email id of the first expert in the session. \r\n expertUserKey string Unique ID of the first expert in the session in the G2A system. \r\n partnerObject number The ID of the object in the partner system that is associated with this session. \r\n partnerObjectUrl string The URL for the expert to view the associated partnerObject. \r\n startedAt* ISO 8061 format* The time that the session started. \r\n customerJoinedAt* ISO 8061 format* The time that the customer joined the session. \r\n endedAt* ISO 8061 format* The time that the session ended. \r\n unattendedMachineName* string Name of the unattended machine the session is with if this is an unattended session. \r\n unattendedMachineUuid* string ID of the unattended machine the session is with if this is an unattended session. \r\n accountName* string The human-readable name of the account the support session was hosted from (unattended sessions only) \r\n customerName* string The human-readable name of the customer in the support session. \r\n customerEmail* string The email address of the customer in the support session. \r\n customerJoinUrl string A URL that can be sent to a customer to join the session. \r\n notes* string All notes that were entered by the technician in the Viewer during the support session \r\n sessionRecordingUrl* string The URL where the technician can view a recording of the session within the GoToAssist web application (only available if the technician has opted to record support sessions (link is external)) \r\n collaborators* array A list of other users who collaborated on the support session (i.e., other technicians who joined the session) \r\n \r\n* Parameters only listed if available/applicable\r\n\r\nStatus Codes \r\n \r\n Staus Code description \r\n 200 OK The information was successfully retrieved \r\n 401 Unauthorized An authentication parameter was passed, but either it was invalid or the technician is not entitled with a Remote Support seat \r\n 404 Not Found The sessionID is not valid for the authorized user and the session could not be found \r\n 405 Method Not Allowed The method was entered incorrectly (i.e., the technician tried to use POST, PUT etc. instead of GET) \r\n 500 Internal Server Error An unhandled error occurred", "operationId"=>"SessionsBySessionIdGet2", "x-api-path-slug"=>"sessionssessionid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"sessionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Screen", "Sharing", "Session", "Info"]}}, "/archive/recordings/transcode/{readyForTranscodeRecordingIds}"=>{"post"=>{"summary"=>"Transcode Recordings", "description"=>"This method requests that a list of recordings be transcoded; once the API passes successfully, transcoding will be initiated for each of the recordings in the list. A result of “204” will be returned, regardless of the current state of the recordings (i.e., even if they are already transcoded). No more than 500 recordings can be transcoded at once.\n\nNote: Session recording must be enabled on the account in order to use this API method. To enable session recording, log in at https://app.gotoassist.com (link is external) and go to Configure > GoToAssist Settings > Enable Session Recording check box.\n\n Request Parameters \n \n field data type description \n recordingIds array A list of RecordingIds for the recordings to be transcoded \n \n\nStatus Codes \n \n Staus Code description \n 204 No Content Transcoding initiated \n 400 Bad Request Request may be malformed or property may be missing or invalid \n 403 Forbidden Invalid authorization header or invalid recordingIDs \n 500 Internal Server Error Unexpected server error", "operationId"=>"ArchiveRecordingsTranscodeByReadyForTranscodeRecordingIdsPost", "x-api-path-slug"=>"archiverecordingstranscodereadyfortranscoderecordingids-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"readyForTranscodeRecordingIds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transcode", "Recordings"]}}, "/sessions/{sessionId}/events"=>{"get"=>{"summary"=>"Get WebChat Transcript Info", "description"=>"Get information about a current or previous web-chat session based upon the sessionID. The session must have been run within an account or company that the authenticated user has access to.\n\n Response Parameters \n \n field data type description \n sessionId string The unique ID of this session \n startTime ISO 8601 format* The start time of web-chat session \n endTime ISO 8601 format* The endTime of the session \n timeStamp ISO 8601 format* Time when the event occurred \n content string Details of the event. It could be a question/answer asked by customer/expert or could indicate joining or ending of session by expert \n participantName string Name of the customer or expert \n \n* ISO 8601 format reference\n\nStatus Codes \n \n Staus Code description \n 200 OK WebChat transcripts info successfully fetched \n 400 Bad Request An error occurred due to missing required parameters or portal not being created \n 401 Unauthorized An authentication parameter was passed, but either it was invalid or the technician is not entitled with a Remote Support seat \n 403 Forbidden Access denied. User doesn’t have required roles \n 404 Not Found No web-chat transcript found for the specified session-id \n 405 Method Not Allowed The method was entered incorrectly (i.e., the technician tried to use POST, PUT etc. instead of GET) \n 500 Internal Server Error An unhandled error occurred", "operationId"=>"SessionsEventsBySessionIdGet", "x-api-path-slug"=>"sessionssessionidevents-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"sessionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WebChat", "Transcript", "Info"]}}, "/companies/{companyId}/machines"=>{"get"=>{"summary"=>"Get Machines", "description"=>"This method retrieves information about the unattended machines associated with a specified company.\n\n Response Parameters \n \n field data type description \n totalNumMachines integer Number of machines returned. \n machines map Map of machines matching the search criteria. \n machineUuid string Un-attended machine uuid. \n machineName string Name of the un-attended machine. \n dnsName string DNS name of the un-attended machine \n ipAddresses string IP Addresses associated with the un-attended machine. \n machineStatus string The current state of the session; it can be one of the following:ONLINE = un-attended machine is online\nOFFLINE = un-attended machine is offline\nBLOCKED = access to un-attended machine has been blocked\nREMOVED = un-attended machine setup has been removed \n companyId string Id of the company with which the un-attended machine has been associated. \n \n\nStatus Codes \n \n Staus Code description \n 200 OK The information was successfully retrieved \n 401 Unauthorized An authentication parameter was passed, but either it was invalid or the technician is not entitled with a Remote Support seat \n 403 Forbidden Access denied. User doesn’t have required roles \n 404 Not Found No machines found \n 405 Method Not Allowed The method was entered incorrectly (i.e., the technician tried to use POST, PUT etc. instead of GET) \n 500 Internal Server Error An unhandled error occurred", "operationId"=>"CompaniesMachinesByCompanyIdGet", "x-api-path-slug"=>"companiescompanyidmachines-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"companyId"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machines"]}}, "/archive/recordings/archived/{recordingIDs}"=>{"put"=>{"summary"=>"Mark Recordings as Archived", "description"=>"This method marks a list of recordings as archived by setting their archived flag to “true.” No more than 500 recordings can be marked as archived once.\n\nNote: Session recording must be enabled on the account in order to use this API method. To enable session recording, log in at https://app.gotoassist.com (link is external) and go to Configure > GoToAssist Settings > Enable Session Recording check box.\n\n Request Parameters \n \n field data type description \n recordingIds array A list of recordingIDs for the recordings to be archived \n\n\nStatus Codes \n \n Staus Code description \n 204 No Content Recordings have been archived \n 400 Bad Request Request may be malformed or property may be missing or invalid \n 403 Forbidden Invalid authorization header or invalid recordingIDs \n 500 Internal Server Error Unexpected server error", "operationId"=>"ArchiveRecordingsArchivedByRecordingIDsPut", "x-api-path-slug"=>"archiverecordingsarchivedrecordingids-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"recordingIDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mark", "Recordings", "As", "Archived"]}}}}, "apis"=>{"name"=>"LogMeIn", "x-slug"=>"logmein", "description"=>"LogMeIn, Inc. is a provider of software as a service and cloud-based remote connectivity services for collaboration, IT management and customer engagement, founded in 2003 and based in Boston, Massachusetts.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28873-www-logmeininc-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"7271", "tags"=>"Audio,Enterprise,Relative Data,SaaS,Service API,Technology,Videoconferencing,Voice,Webinars", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"logmein/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"GoToAssist Remote Support", "x-api-slug"=>"gotoassist-remote-support", "description"=>"LogMeIn, Inc. is a provider of software as a service and cloud-based remote connectivity services for collaboration, IT management and customer engagement, founded in 2003 and based in Boston, Massachusetts.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28873-www-logmeininc-com.jpg", "humanURL"=>"http://www.LogMeInInc.com", "baseURL"=>"https://api.getgo.com//G2A/rest/v1", "tags"=>"Audio,Enterprise,Relative Data,SaaS,Service API,Technology,Videoconferencing,Voice,Webinars", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/logmein/archiverecordingsarchivedrecordingids-put-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/logmein/gotoassist-remote-support-openapi.yaml"}]}, {"name"=>"GoToMeeting", "x-api-slug"=>"gotomeeting", "description"=>"LogMeIn, Inc. is a provider of software as a service and cloud-based remote connectivity services for collaboration, IT management and customer engagement, founded in 2003 and based in Boston, Massachusetts.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28873-www-logmeininc-com.jpg", "humanURL"=>"http://www.LogMeInInc.com", "baseURL"=>"https://api.getgo.com//G2M/rest", "tags"=>"Mark,Recordings,As,Archived", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/logmein/groupsgroupkeyhistoricalmeetings-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/logmein/gotomeeting-openapi.yaml"}]}, {"name"=>"GoToTraining", "x-api-slug"=>"gototraining", "description"=>"LogMeIn, Inc. is a provider of software as a service and cloud-based remote connectivity services for collaboration, IT management and customer engagement, founded in 2003 and based in Boston, Massachusetts.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28873-www-logmeininc-com.jpg", "humanURL"=>"http://www.LogMeInInc.com", "baseURL"=>"https://api.getgo.com//G2T/rest", "tags"=>"Historical,Meetings,By,Group", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/logmein/reportsorganizersorganizerkeysessionssessionkeyattendees-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/logmein/gototraining-openapi.yaml"}]}, {"name"=>"GoToWebinar", "x-api-slug"=>"gotowebinar", "description"=>"LogMeIn, Inc. is a provider of software as a service and cloud-based remote connectivity services for collaboration, IT management and customer engagement, founded in 2003 and based in Boston, Massachusetts.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28873-www-logmeininc-com.jpg", "humanURL"=>"http://www.LogMeInInc.com", "baseURL"=>"https://api.getgo.com//G2W/rest/organizers", "tags"=>"Attendance,Details", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/logmein/organizerkeywebinarswebinarkeysessionssessionkeyattendeesregistrantkeypolls-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/logmein/gotowebinar-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-github", "url"=>"https://github.com/logmein"}, {"type"=>"x-openapi", "url"=>"https://www.getpostman.com/collections/94ad52bdc3d954bad52a"}, {"type"=>"x-postman-collection", "url"=>"https://www.getpostman.com/collections/00bf4391e993c3afa7b7"}, {"type"=>"x-postman-collection", "url"=>"https://www.getpostman.com/collections/c35d614484f21e581775"}, {"type"=>"x-postman-collection", "url"=>"https://www.getpostman.com/collections/9c6e067461f45f7faa6b"}, {"type"=>"x-postman-collection", "url"=>"https://drive.google.com/open?id=16WZlBkS1i8cWSfZ3mMKOwlNP-qsE7AWy"}, {"type"=>"x-postman-collection", "url"=>"https://drive.google.com/file/d/1vI11FNCKpv6WJ_70hoqPNMmPAkASiOU_/view?usp=sharing"}, {"type"=>"x-website", "url"=>"http://www.LogMeInInc.com"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/logmein"}, {"type"=>"x-developer", "url"=>"https://goto-developer.logmeininc.com/"}, {"type"=>"x-documentation", "url"=>"https://goto-developer.logmeininc.com/apis/apis-overview"}, {"type"=>"x-faq", "url"=>"https://goto-developer.logmeininc.com/faq-page"}, {"type"=>"x-support", "url"=>"https://goto-developer.logmeininc.com/api-support-request-template"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/LogMeIn"}, {"type"=>"x-website", "url"=>"https://www.logmeininc.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
intuit{"quickbooks-online-v3-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Intuit", "x-complete"=>1, "info"=>{"title"=>"QuickBooks Online V3 API", "description"=>"the-quickbooks-online-accounting-api-is-a-restful-api-that-is-used-to-access-quickbooks-companies-docs-", "version"=>"1.0.0"}, "host"=>"DefaultParameterValue", "basePath"=>"/v3/company/DefaultParameterValue", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/cdc"=>{"get"=>{"summary"=>"Get CDC", "description"=>"Retrive changed Bill and invoice objects since Aug10,2016\nMethod - GET", "operationId"=>"getCdc", "x-api-path-slug"=>"cdc-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"changedSince"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"entities"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "CDC"]}}, "/query"=>{"post"=>{"summary"=>"Post Query", "description"=>"Read all transfer objects using the 'Query' endpoint\nMethod : POST", "operationId"=>"postQuery", "x-api-path-slug"=>"query-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Query"]}}, "/estimate/163"=>{"get"=>{"summary"=>"Get Estimate", "description"=>"Read an Estimate object by Id\nMethod : POST", "operationId"=>"getEstimate163", "x-api-path-slug"=>"estimate163-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Estimate"]}}, "/invoice"=>{"post"=>{"summary"=>"Post Invoice", "description"=>"Create an invoice object\nMethod : POST", "operationId"=>"postInvoice", "x-api-path-slug"=>"invoice-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Invoice"]}}, "/term"=>{"post"=>{"summary"=>"Post Term", "description"=>"Update a term object\nMethod : POST\n\nTerm object can't be deleted parmanently. It can only be deactived by setting the 'Active' attribute to false.", "operationId"=>"postTerm", "x-api-path-slug"=>"term-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Term"]}}, "/preferences"=>{"get"=>{"summary"=>"Get Preferences", "description"=>"Read the preference object\nMethod : POST", "operationId"=>"getPreferences", "x-api-path-slug"=>"preferences-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Preferences"]}, "post"=>{"summary"=>"Post Preferences", "description"=>"Update the preference object endpoint\nMethod : POST", "operationId"=>"postPreferences", "x-api-path-slug"=>"preferences-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Preferences"]}}, "/reports/InventoryValuationSummary"=>{"get"=>{"summary"=>"Get Reports Inventory Valuation Summary", "description"=>"Report - Inventory Valuation Summary\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/inventory%20valuation", "operationId"=>"getReportsInventoryvaluationsummary", "x-api-path-slug"=>"reportsinventoryvaluationsummary-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Inventory", "Valuation", "Summary"]}}, "/purchase"=>{"post"=>{"summary"=>"Post Purchase", "description"=>"Create a puchase object\nMethod : POST", "operationId"=>"postPurchase", "x-api-path-slug"=>"purchase-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Purchase"]}}, "/salesreceipt/181"=>{"get"=>{"summary"=>"Get SaleS Receipt", "description"=>"Create an salesreceipt object\nMethod : POST", "operationId"=>"getSalesreceipt181", "x-api-path-slug"=>"salesreceipt181-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "SaleS", "Receipt"]}}, "/deposit"=>{"post"=>{"summary"=>"Post Deposit", "description"=>"Update a deposit object\nMethod : POST", "operationId"=>"postDeposit", "x-api-path-slug"=>"deposit-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Deposit"]}}, "/transfer"=>{"post"=>{"summary"=>"Post Transfer", "description"=>"Create a transfer object\nMethod : POST", "operationId"=>"postTransfer", "x-api-path-slug"=>"transfer-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Transfer"]}}, "/bill"=>{"post"=>{"summary"=>"Post Bill", "description"=>"Create a bill\nContent-Type:application/json\nMethod - POST", "operationId"=>"postBill", "x-api-path-slug"=>"bill-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Bill"]}}, "/account/1"=>{"get"=>{"summary"=>"Get Account", "description"=>"Get the Account which has accountId as 1", "operationId"=>"getAccount1", "x-api-path-slug"=>"account1-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Account"]}}, "/invoice/147"=>{"get"=>{"summary"=>"Get Invoice", "description"=>"Read an invoice object by Id\nMethod : POST", "operationId"=>"getInvoice147", "x-api-path-slug"=>"invoice147-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Invoice"]}}, "/reports/CustomerBalanceDetail"=>{"get"=>{"summary"=>"Get Reports Customer Balance Detail", "description"=>"Report - CustomerBalance Detail\nMethod : GET\n\nThe information below provides a reference on how to access the Customer Balance Detail report from the QuickBooks Online Report Service.", "operationId"=>"getReportsCustomerbalancedetail", "x-api-path-slug"=>"reportscustomerbalancedetail-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Customer", "Balance", "Detail"]}}, "/payment"=>{"post"=>{"summary"=>"Post Payment", "description"=>"Create an payment object\nMethod : POST", "operationId"=>"postPayment", "x-api-path-slug"=>"payment-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Payment"]}}, "/reports/ProfitAndLossDetail"=>{"get"=>{"summary"=>"Get Reports Profit and Loss DETAIL", "description"=>"Report - Profit and Loss Detail\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/profit%20and%20loss%20detail", "operationId"=>"getReportsProfitandlossdetail", "x-api-path-slug"=>"reportsprofitandlossdetail-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Profit", "Loss", "DETAIL"]}}, "/salesreceipt"=>{"post"=>{"summary"=>"Post Sales Receipt", "description"=>"Create an salesreceipt object\nMethod : POST", "operationId"=>"postSalesreceipt", "x-api-path-slug"=>"salesreceipt-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Sales", "Receipt"]}}, "/upload"=>{"post"=>{"summary"=>"Post Upload", "description"=>"Uploading and linking new attachments\n\nhttps://developer.intuit.com/docs/0100_quickbooks_online/0200_dev_guides/accounting/attachments#Uploading_and_linking_new_attachments\n\nIf the attachment is not in the Attachment list already, it's possible to upload it and link it to the object in one multipart operation.\n\nOperation: POST https://quickbooks.api.intuit.com/v3/company/companyID/upload\nContent type: multipart/form-data\n\nRequest body\n\nThe following sample code shows the multipart request body for uploading a file and its supporting Attachable metatdata object, with the result of it being both added to the Attachment list and added to the object.\n\nThe Attachable object accompanying this request supplies metadata and object information to which the attachment is linked. \nEach part of the multipart request is separated by a boundary. In the sample below, the string --YOjcLaTlykb6OxfYJx4O07j1MweeMFem is used. You can use any random and unique string.\nThe file to be uploaded and its Attachable object are paired together via the name parameter in the part header for each one.\nThe name parameter for the file part is of the form file_content_nn, where nn is a unique index number among the set of files being uploaded.\nThe name parameter for the Attachable object is of the form file_metadata_nn, where nn corresponds to the file index number used with the content .\nThe file or files are stored in the Attachment list with the name specified by the filename parameter.\nIf the data supplied with the Attachable object cannot be validated, an error is returned and the file is not uploaded.", "operationId"=>"postUpload", "x-api-path-slug"=>"upload-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Upload"]}}, "/customer"=>{"post"=>{"summary"=>"Post Customer", "description"=>"Create a customer\nMethod : POST", "operationId"=>"postCustomer", "x-api-path-slug"=>"customer-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Customer"]}}, "/department"=>{"post"=>{"summary"=>"Post Department", "description"=>"Create a department object\nMethod : POST", "operationId"=>"postDepartment", "x-api-path-slug"=>"department-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Department"]}}, "/reports/GeneralLedger"=>{"get"=>{"summary"=>"Get Reports General Ledger", "description"=>"Report - General Ledger\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/general%20ledger", "operationId"=>"getReportsGeneralledger", "x-api-path-slug"=>"reportsgeneralledger-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "General", "Ledger"]}}, "/reports/VendorBalance"=>{"get"=>{"summary"=>"Get Reports Vendor Balance", "description"=>"Report - Vendor Balance \nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/vendor%20balance", "operationId"=>"getReportsVendorbalance", "x-api-path-slug"=>"reportsvendorbalance-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Vendor", "Balance"]}}, "/purchaseorder/178"=>{"get"=>{"summary"=>"Get Purchase Order", "description"=>"Read a puchase-order object\nMethod : POST", "operationId"=>"getPurchaseorder178", "x-api-path-slug"=>"purchaseorder178-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Purchase", "Order"]}}, "/item"=>{"post"=>{"summary"=>"Post Item", "description"=>"Create an item object\nMethod : POST", "operationId"=>"postItem", "x-api-path-slug"=>"item-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Item"]}}, "/journalentry"=>{"post"=>{"summary"=>"Post Journal Entry", "description"=>"Create an journalentry object\nMethod : POST", "operationId"=>"postJournalentry", "x-api-path-slug"=>"journalentry-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Journal", "Entry"]}}, "/taxservice/taxcode"=>{"post"=>{"summary"=>"Post Tax Service Tax Code", "description"=>"Use TaxService to create taxcode and corresponding taxrates\nMethod : POST", "operationId"=>"postTaxserviceTaxcode", "x-api-path-slug"=>"taxservicetaxcode-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Tax", "Service", "Tax", "Code"]}}, "/creditmemo"=>{"post"=>{"summary"=>"Post Credit Memo", "description"=>"Update a credit memo\nMethod : POST", "operationId"=>"postCreditmemo", "x-api-path-slug"=>"creditmemo-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Credit", "Memo"]}}, "/companyinfo/{companyid}"=>{"get"=>{"summary"=>"Get Company", "description"=>"Method : GET", "operationId"=>"getCompanyinfoCompany", "x-api-path-slug"=>"companyinfocompanyid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"companyid"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Company"]}}, "/journalentry/8"=>{"get"=>{"summary"=>"Get Journal Entry", "description"=>"Read an journalentry object by Id\nMethod : POST", "operationId"=>"getJournalentry8", "x-api-path-slug"=>"journalentry8-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Journal", "Entry"]}}, "/paymentmethod"=>{"post"=>{"summary"=>"Post Payment Method", "description"=>"Update a payment method\nMethod : POST", "operationId"=>"postPaymentmethod", "x-api-path-slug"=>"paymentmethod-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Payment", "Method"]}}, "/transfer/184"=>{"get"=>{"summary"=>"Get TransfeR", "description"=>"Read a transfer object by Id\nMethod : GET", "operationId"=>"getTransfer184", "x-api-path-slug"=>"transfer184-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "TransfeR"]}}, "/reports/ItemSales"=>{"get"=>{"summary"=>"Get Reports Item Sales", "description"=>"Report - Item Sales\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/sales%20by%20product", "operationId"=>"getReportsItemsales", "x-api-path-slug"=>"reportsitemsales-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Item", "Sales"]}}, "/account"=>{"post"=>{"summary"=>"Post Account", "description"=>"Create a new Account", "operationId"=>"postAccount", "x-api-path-slug"=>"account-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Account"]}}, "/employee"=>{"post"=>{"summary"=>"Post Employee", "description"=>"Delete an employee object\nMethod : POST\n\nDelete via deactivation (active=false)", "operationId"=>"postEmployee", "x-api-path-slug"=>"employee-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Employee"]}}, "/term/8"=>{"get"=>{"summary"=>"Get Term", "description"=>"Read a term object by Id\nMethod : Get", "operationId"=>"getTerm8", "x-api-path-slug"=>"term8-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Term"]}}, "/estimate"=>{"post"=>{"summary"=>"Post Estimate", "description"=>"Update an Estimate object\nMethod : POST", "operationId"=>"postEstimate", "x-api-path-slug"=>"estimate-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Estimate"]}}, "/timeactivity"=>{"post"=>{"summary"=>"Post Time Activity", "description"=>"Create a term object\nMethod : POST", "operationId"=>"postTimeactivity", "x-api-path-slug"=>"timeactivity-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Time", "Activity"]}}, "/vendor"=>{"post"=>{"summary"=>"Post Vendor", "description"=>"Update a vendor object\nMethod : POST", "operationId"=>"postVendor", "x-api-path-slug"=>"vendor-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Vendor"]}}, "/refundreceipt"=>{"post"=>{"summary"=>"Post Refund Receipt", "description"=>"Update a refund-receipt object\nMethod : POST", "operationId"=>"postRefundreceipt", "x-api-path-slug"=>"refundreceipt-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Refund", "Receipt"]}}, "/vendorcredit"=>{"post"=>{"summary"=>"Post Vendor Credit", "description"=>"Delete a vendorcredit object by Id\nMethod : POST\n\nSample response body \n\n{\n \"VendorCredit\": {\n \"domain\": \"QBO\",\n \"status\": \"Deleted\",\n \"Id\": \"185\"\n },\n \"time\": \"2016-09-02T03:14:13.909-07:00\"\n}", "operationId"=>"postVendorcredit", "x-api-path-slug"=>"vendorcredit-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"operation"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Vendor", "Credit"]}}, "/paymentmethod/8"=>{"get"=>{"summary"=>"Get Payment Method", "description"=>"Read a payment method\nMethod : GET", "operationId"=>"getPaymentmethod8", "x-api-path-slug"=>"paymentmethod8-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Payment", "Method"]}}, "/creditmemo/160"=>{"get"=>{"summary"=>"Get Credit Memo", "description"=>"Read a credit memo by Id\nMethod : GET", "operationId"=>"getCreditmemo160", "x-api-path-slug"=>"creditmemo160-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Credit", "Memo"]}}, "/reports/VendorExpenses"=>{"get"=>{"summary"=>"Get Reports Vendorexpenses", "description"=>"Report - Vendor Expense\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/expenses%20by%20vendor", "operationId"=>"getReportsVendorexpenses", "x-api-path-slug"=>"reportsvendorexpenses-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Vendorexpenses"]}}, "/vendor/70"=>{"get"=>{"summary"=>"Get Vendor", "description"=>"Read a vendor object by Id\nMethod : GET", "operationId"=>"getVendor70", "x-api-path-slug"=>"vendor70-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Vendor"]}}, "/class"=>{"post"=>{"summary"=>"Post Class", "description"=>"Create a Class object\nMethod - POST", "operationId"=>"postClass", "x-api-path-slug"=>"class-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Class"]}}, "/purchase/175"=>{"get"=>{"summary"=>"Get Purchase", "description"=>"Read a puchase object by Id\nMethod : POST", "operationId"=>"getPurchase175", "x-api-path-slug"=>"purchase175-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Purchase"]}}, "/billpayment/118"=>{"get"=>{"summary"=>"Get BillpaymenT", "description"=>"Retrieve BillPayment by Id\nMethod - GET", "operationId"=>"getBillpayment", "x-api-path-slug"=>"billpayment118-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "BillpaymenT"]}}, "/purchaseorder"=>{"post"=>{"summary"=>"Post Purchase Order", "description"=>"Create a puchase-order object\nMethod : POST", "operationId"=>"postPurchaseorder", "x-api-path-slug"=>"purchaseorder-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Purchase", "Order"]}}, "/reports/DepartmentSales"=>{"get"=>{"summary"=>"Get Reports Department Sales", "description"=>"Report - Department Sales\nMethod : GET", "operationId"=>"getReportsDepartmentsales", "x-api-path-slug"=>"reportsdepartmentsales-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Department", "Sales"]}}, "/taxagency/3"=>{"get"=>{"summary"=>"Get Tax Agency", "description"=>"Get a tax-agency object by ID\nMethod : GET", "operationId"=>"getTaxagency3", "x-api-path-slug"=>"taxagency3-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Tax", "Agency"]}}, "/deposit/162"=>{"get"=>{"summary"=>"Get Deposit", "description"=>"Read a deposit object by Id\nMethod : POST", "operationId"=>"getDeposit162", "x-api-path-slug"=>"deposit162-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Deposit"]}}, "/reports/AgedPayables"=>{"get"=>{"summary"=>"Get Reports Agedpayables", "description"=>"Report - AgedPayable aging summary\nMethod : GET\n\nThe information below provides a reference on how to access the AP Aging summary report from the QuickBooks Online Report Service.", "operationId"=>"getReportsAgedpayables", "x-api-path-slug"=>"reportsagedpayables-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Agedpayables"]}}, "/bill/1"=>{"get"=>{"summary"=>"Get Bill", "description"=>"Retrieve a bill by Id\nAccept:application/json\nMethod - GET", "operationId"=>"getBill1", "x-api-path-slug"=>"bill1-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Bill"]}}, "/attachable"=>{"post"=>{"summary"=>"Post Attachable", "description"=>"Create an attachable object\nConent-Type:application/json\nMethod - POST", "operationId"=>"postAttachable", "x-api-path-slug"=>"attachable-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Attachable"]}}, "/taxrate/1"=>{"get"=>{"summary"=>"Get Tax Rate", "description"=>"Read a taxRate by Id\nMethod : POST", "operationId"=>"getTaxrate1", "x-api-path-slug"=>"taxrate1-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Tax", "Rate"]}}, "/vendorcredit/185"=>{"get"=>{"summary"=>"Get Vendor Credit", "description"=>"Read a vendorcredit object by Id\nMethod : GET\n\nPlease change the VendorCredit it from 165 to a valid VendorCredit objectId which exists in your QBO account", "operationId"=>"getVendorcredit185", "x-api-path-slug"=>"vendorcredit185-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Vendor", "Credit"]}}, "/class/5000000000000018727"=>{"get"=>{"summary"=>"Get Class", "description"=>"Read a Class object by Id\nMethod - GET", "operationId"=>"getClass", "x-api-path-slug"=>"class5000000000000018727-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Class"]}}, "/taxcode/2"=>{"get"=>{"summary"=>"Get Tax Code", "description"=>"Read a taxcode by Id\nMethod : POST", "operationId"=>"getTaxcode2", "x-api-path-slug"=>"taxcode2-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Tax", "Code"]}}, "/customer/63"=>{"get"=>{"summary"=>"Get Customer", "description"=>"Read a customer entry by Id\nMethod : GET", "operationId"=>"getCustomer63", "x-api-path-slug"=>"customer63-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Customer"]}}, "/batch"=>{"post"=>{"summary"=>"Post Batch", "description"=>"Multiple operations using batch query\nContent-Type:application/json\nMethod - POST", "operationId"=>"postBatch", "x-api-path-slug"=>"batch-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Batch"]}}, "/reports/AccountList"=>{"get"=>{"summary"=>"Get Reports Account List", "description"=>"Report - Account list detail\nMethod : GET\n\nThe information below provides a reference on how to access the account list detail report from the QuickBooks Online Report Service.", "operationId"=>"getReportsAccountlist", "x-api-path-slug"=>"reportsaccountlist-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Account", "List"]}}, "/reports/AgedReceivables"=>{"get"=>{"summary"=>"Get Reports Agedreceivables", "description"=>"Report - AgedReceivable aging summary\nMethod : GET\n\nThe information below provides a reference on how to access the AR Aging Summary report from the QuickBooks Online Report Service.", "operationId"=>"getReportsAgedreceivables", "x-api-path-slug"=>"reportsagedreceivables-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Agedreceivables"]}}, "/reports/CashFlow"=>{"get"=>{"summary"=>"Get Reports Cashflow", "description"=>"Report - CashFlow\nMethod : GET\n\nThe information below provides a reference on how to access the cash flow report from the QuickBooks Online Report Service.", "operationId"=>"getReportsCashflow", "x-api-path-slug"=>"reportscashflow-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Cashflow"]}}, "/reports/BalanceSheet"=>{"get"=>{"summary"=>"Get Reports Balancesheet", "description"=>"Report - BalanceSheet\nMethod : GET\n\nThe information below provides a reference on how to query the Balance Sheet report from the QuickBooks Online Report Service.", "operationId"=>"getReportsBalancesheet", "x-api-path-slug"=>"reportsbalancesheet-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Balancesheet"]}}, "/reports/CustomerIncome"=>{"get"=>{"summary"=>"Get Reports Customer Income", "description"=>"Report - Customer Income\nMethod : GET", "operationId"=>"getReportsCustomerincome", "x-api-path-slug"=>"reportscustomerincome-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Customer", "Income"]}}, "/reports/AgedReceivableDetail"=>{"get"=>{"summary"=>"Get Reports Agedreceivabledetail", "description"=>"Report - AgedReceivableDetail aging detail\nMethod : GET\n\nThe information below provides a reference on how to access the AR Aging Detail report from the QuickBooks Online Report Service.", "operationId"=>"getReportsAgedreceivabledetail", "x-api-path-slug"=>"reportsagedreceivabledetail-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Agedreceivabledetail"]}}, "/refundreceipt/66"=>{"get"=>{"summary"=>"Get Refund Receipt", "description"=>"Read a refund-receipt object\nMethod : GET", "operationId"=>"getRefundreceipt66", "x-api-path-slug"=>"refundreceipt66-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Refund", "Receipt"]}}, "/reports/CustomerBalance"=>{"get"=>{"summary"=>"Get Reports Customer Balance", "description"=>"Report - CustomerBalance\nMethod : GET", "operationId"=>"getReportsCustomerbalance", "x-api-path-slug"=>"reportscustomerbalance-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Customer", "Balance"]}}, "/billpayment"=>{"post"=>{"summary"=>"Post BilL Payment", "description"=>"Update a BillPayment\nContent-Type:application/json\nMethod - POST", "operationId"=>"postBillpayment", "x-api-path-slug"=>"billpayment-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "BilL", "Payment"]}}, "/exchangerate"=>{"get"=>{"summary"=>"Get Exchangerate", "description"=>"Get ExchangeRate\nMethod : GET", "operationId"=>"getExchangerate", "x-api-path-slug"=>"exchangerate-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"asofdate"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"query", "name"=>"sourcecurrencycode"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Exchangerate"]}}, "/reports/TransactionList"=>{"get"=>{"summary"=>"Get Reports Transaction LIST", "description"=>"Report - Trial List \nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/transaction%20list", "operationId"=>"getReportsTransactionlist", "x-api-path-slug"=>"reportstransactionlist-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Transaction", "LIST"]}}, "/department/1"=>{"get"=>{"summary"=>"Get Department", "description"=>"Read a department object\nMethod : GET", "operationId"=>"getDepartment1", "x-api-path-slug"=>"department1-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Department"]}}, "/employee/68"=>{"get"=>{"summary"=>"Get Employee", "description"=>"Retrive an employee object by ID\nMethod : GET", "operationId"=>"getEmployee68", "x-api-path-slug"=>"employee68-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Employee"]}}, "/reports/TrialBalance"=>{"get"=>{"summary"=>"Get Reports Trial Balance", "description"=>"Report - Trial Balance \nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/trial%20balance", "operationId"=>"getReportsTrialbalance", "x-api-path-slug"=>"reportstrialbalance-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"minorversion"}, {"in"=>"header", "name"=>"User-Agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounting", "Accounting", "Reports", "Trial", "Balance"]}}, "/item/ |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
cloudflare{"cloudflare-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"CloudFlare", "x-complete"=>1, "info"=>{"title"=>"CloudFlare", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/user/billing/subscriptions/apps"=>{"get"=>{"summary"=>"List all of your app subscriptions", "description"=>"List all of your app subscriptions", "operationId"=>"cloudflare-app-subscription-api", "x-api-path-slug"=>"userbillingsubscriptionsapps-get", "parameters"=>[{"in"=>"query", "name"=>"activated_on", "description"=>"When the subscription was activated2014-03-01T12:20:00Z"}, {"in"=>"query", "name"=>"cancelled_on", "description"=>"When the subscription was cancelled2014-04-01T12:20:00Z"}, {"in"=>"query", "name"=>"direction", "description"=>"Direction to order subscriptionsdesc"}, {"in"=>"query", "name"=>"expired_on", "description"=>"When the subscription expired2014-04-02T12:20:00Z"}, {"in"=>"query", "name"=>"expires_on", "description"=>"When the subscription will expire2014-03-31T12:20:00Z"}, {"in"=>"query", "name"=>"match", "description"=>"Whether to match all search requirements or at least one (any)all"}, {"in"=>"query", "name"=>"order", "description"=>"Field to order subscriptions bystatus"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of paginated results1"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page20"}, {"in"=>"query", "name"=>"price", "description"=>"The price of the subscription that will be billed, in US dollars20"}, {"in"=>"query", "name"=>"renewed_on", "description"=>"When the subscription was renewed2014-05-11T12:20:00Z"}, {"in"=>"query", "name"=>"status", "description"=>"The state of the subscriptionactive"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/user/billing/subscriptions/apps/:identifier"=>{"get"=>{"summary"=>"Billing subscription details", "description"=>"Billing subscription details", "operationId"=>"cloudflare-app-subscription-api", "x-api-path-slug"=>"userbillingsubscriptionsappsidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/zones/:zone_identifier/custom_pages"=>{"get"=>{"summary"=>"A list of available Custom Pages the zone can use", "description"=>"A list of available Custom Pages the zone can use", "operationId"=>"cloudflare-custom-pages-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifiercustom-pages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones"]}}, "/zones/:zone_identifier/custom_pages/:identifier"=>{"get"=>{"summary"=>"Details about a specific Custom page details", "description"=>"Details about a specific Custom page details", "operationId"=>"cloudflare-custom-pages-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifiercustom-pagesidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones"]}, "put"=>{"summary"=>"Update Custom page URL", "description"=>"Update Custom page URL", "operationId"=>"cloudflare-custom-pages-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifiercustom-pagesidentifier-put", "parameters"=>[{"in"=>"query", "name"=>"state", "description"=>"The Custom Page statettttttttttttttdefault"}, {"in"=>"query", "name"=>"url", "description"=>"A URL that is associated with the Custom Page"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones"]}}, "/zones/:zone_identifier/custom_certificates"=>{"get"=>{"summary"=>"List, search, sort, and filter all of your custom SSL certificates", "description"=>"List, search, sort, and filter all of your custom SSL certificates", "operationId"=>"cloudflare-custom-ssl-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifiercustom-certificates-get", "parameters"=>[{"in"=>"query", "name"=>"direction", "description"=>"Direction to order zonesttttttttttttttdesc"}, {"in"=>"query", "name"=>"match", "description"=>"Whether to match all search requirements or at least one (any)ttttttttttttttall"}, {"in"=>"query", "name"=>"order", "description"=>"Field to order certificates byttttttttttttttstatus"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of paginated resultstttttttttttttt1"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of zones per pagetttttttttttttt20"}, {"in"=>"query", "name"=>"status", "description"=>"Status of the zones custom SSLttttttttttttttactive"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}, "post"=>{"summary"=>"Upload a new SSL certificate for a zone", "description"=>"Upload a new SSL certificate for a zone", "operationId"=>"cloudflare-custom-ssl-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifiercustom-certificates-post", "parameters"=>[{"in"=>"query", "name"=>"certificate", "description"=>"The zones SSL certificate or certificate and the intermediate(s)tttttttttttttt-----BEGIN CERTIFICATE----- MIIDtTCCAp2gAwIBAgIJAM15n7fdxhRtMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV BAYTAlVTMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTQwMzExMTkyMTU5WhcNMTQwNDEwMTkyMTU5WjBF MQswCQYDVQQGEwJVUzETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAvq3sKsHpeduJHimOK+fvQdKsI8z8A05MZyyLp2/R/GE8FjNv+hkVY1WQ LIyTNNQH7CJecE1nbTfo8Y56S7x/rhxC6/DJ8MIulapFPnorq46KU6yRxiM0MQ3N nTJHlHA2ozZta6YBBfVfhHWl1F0IfNbXCLKvGwWWMbCx43OfW6KTkbRnE6gFWKuO fSO5h2u5TaWVuSIzBvYs7Vza6m+gtYAvKAJV2nSZ+eSEFPDo29corOy8+huEOUL8 5FAw4BFPsr1TlrlGPFitduQUHGrSL7skk1ESGza0to3bOtrodKei2s9bk5MXm7lZ qI+WZJX4Zu9+mzZhc9pCVi8r/qlXuQIDAQABo4GnMIGkMB0GA1UdDgQWBBRvavf+ sWM4IwKiH9X9w1vl6nUVRDB1BgNVHSMEbjBsgBRvavf+sWM4IwKiH9X9w1vl6nUV RKFJpEcwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAM15n7fdxhRtMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQEFBQADggEBABY2ZzBaW0dMsAAT7tPJzrVWVzQx6KU4 UEBLudIlWPlkAwTnINCWR/8eNjCCmGA4heUdHmazdpPa8RzwOmc0NT1NQqzSyktt vTqb4iHD7+8f9MqJ9/FssCfTtqr/Qst/hGH4Wmdf1EJ/6FqYAAb5iRlPgshFZxU8 uXtA8hWn6fK6eISD9HBdcAFToUvKNZ1BIDPvh9f95Ine8ar6yGd56TUNrHR8eHBs ESxz5ddVR/oWRysNJ+aGAyYqHS8S/ttmC7r4XCAHqXptkHPCGRqkAhsterYhd4I8 /cBzejUobNCjjHFbtkAL/SjxZOLW+pNkZwfeYdM8iPkD54Uua1v2tdw= -----END CERTIFICATE-----"}, {"in"=>"query", "name"=>"private_key", "description"=>"The zones private keytttttttttttttt-----BEGIN RSA PRIVATE KEY-----MIIEowIBAAKCAQEAl 1cSc0vfcJLI4ZdWjiZZqy86Eof4czCwilyjXdvHqbdgDjz9H6K/0FX78EzVdfyExESptPCDl5YYjvcZyAWlgNfYEpFpGeoh/pTFW3hlyKImh4EgBXbDrR251J Ew2Nf56X3duibI6X20gKZA6cvdmWeKh MOOXuh1bSPU3dkb4YOF/fng5iGrx0q3txdMQXTPMZ1uXHFcBH7idgViYesXUBhdll3GP1N Y8laq0yrqh 8HMsZK m27MebqonbNmjOqE218lVEvjCdRO6xvNXrO6vNJBoGn2eGwZ8BVd0mTA3Tj43/2cmxQFY9FLq56cCXqYI1fbRRib ZLrjSNkwIDAQABAoIBABfAjjsjjxc0NxcYvKOMUb9Rpj8Sx6U/o/tDC5u XmsGX37aaJmC5yw9BQiAxgvXtQryEl5uoNoqOdsxzKV6yM0vPcwKEJVBd4G6yx6AjVJZnc2qf72erR7BbA2CQh scMDRBKE041HhgTBRNP6roim0SOgYP5JZIrGAQXNIkyE0fZc5gZNUt388ne/mjWM6Xi08BDGurLC68nsdt7Nd UYqeBVxo2EqChp5vKYZYEcG8h9XBj4u4NIwg1Mty2JqX30uBjoHvF5w/pMs8lG uvj6JR9I 19wtCuccbAJl 4cUq03UQoIDmwejea oC8A8WJr3vVpODDWrvAsjllGPBECgYEAyQRa6edYO6bsSvgbM13qXW9OQTn9YmgzfN24Ux1D66TQU6sBSLdfSHshDhTCi Ax 698aJNRWujAakA2DDgspSx98aRnHbF zvY7i7iWGesN6uN0zL 6/MK5uWoieGZRjgk230fLk00l4/FK1mJIp0apr0Lis9xmDjP5AaUPTUUCgYEAwXuhTHZWPT6v8YwOksjbuK UDkIIvyMux53kb73vrkgMboS4DB1zMLNyG 9EghS414CFROUwGl4ZUKboH1Jo5G34y8VgDuHjirTqL2H6 zNpML iMrWCXjpFKkxwPbeQnEAZ 5Rud4d PTyXAt71blZHE9tZ4KHy8cU1iKc9APcCgYAIqKZd4vg7AZK2G//X85iv06aUSrIudfyZyVcyRVVyphPPNtOEVVnGXn9rAtvqeIrOo52BR68 cj4vlXp hkDuEH QVBuY/NdQhOzFtPrKPQTJdGjIlQ2x65Vidj7r3sRukNkLPyV2v D885zcpTkp83JFuWTYiIrg275DIuAI3QKBgAglM0IrzS g3vlVQxvM1ussgRgkkYeybHq82 wUW 3DXLqeXb0s1DedplUkuoabZriz0Wh4GZFSmtA5ZpZC uV697lkYsndmp2xRhaekllW7bu pY5q88URwO2p8CO5AZ6CWFWuBwSDML5VOapGRqDRgwaD oGpb7fb7IgHOls7AoGBAJnL6Q8t35uYJ8J8hY7wso88IE04z6VaT8WganxcndesWER9eFQDHDDy//ZYeyt6M41uIY CL Vkm9Kwl/bHLJKdnOE1a9NdE6mtfah0Bk2u/YOuzyu5mmcgZiX X/OZuEbGmmbZOR1FCuIyrNYfwYohhcZP7/r0Ia/1GpkHc3Bi-----END RSA PRIVATE KEY-----"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/zones/:zone_identifier/custom_certificates/:identifier"=>{"delete"=>{"summary"=>"Delete an SSL certificate permission needed: #ssl:edit", "description"=>"Delete an SSL certificate permission needed: #ssl:editntt", "operationId"=>"cloudflare-custom-ssl-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifiercustom-certificatesidentifier-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}, "get"=>{"summary"=>"SSL configuration details permission needed: #ssl:read", "description"=>"SSL configuration details permission needed: #ssl:readntt", "operationId"=>"cloudflare-custom-ssl-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifiercustom-certificatesidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}, "patch"=>{"summary"=>"Upload a new private key and/or PEM/CRT for the SSL certificate", "description"=>"Upload a new private key and/or PEM/CRT for the SSL certificate", "operationId"=>"cloudflare-custom-ssl-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifiercustom-certificatesidentifier-patch", "parameters"=>[{"in"=>"query", "name"=>"certificate", "description"=>"The zones SSL certificate or certificate and the intermediate(s)tttttttttttttt-----BEGIN CERTIFICATE----- MIIDtTCCAp2gAwIBAgIJAM15n7fdxhRtMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV BAYTAlVTMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTQwMzExMTkyMTU5WhcNMTQwNDEwMTkyMTU5WjBF MQswCQYDVQQGEwJVUzETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAvq3sKsHpeduJHimOK+fvQdKsI8z8A05MZyyLp2/R/GE8FjNv+hkVY1WQ LIyTNNQH7CJecE1nbTfo8Y56S7x/rhxC6/DJ8MIulapFPnorq46KU6yRxiM0MQ3N nTJHlHA2ozZta6YBBfVfhHWl1F0IfNbXCLKvGwWWMbCx43OfW6KTkbRnE6gFWKuO fSO5h2u5TaWVuSIzBvYs7Vza6m+gtYAvKAJV2nSZ+eSEFPDo29corOy8+huEOUL8 5FAw4BFPsr1TlrlGPFitduQUHGrSL7skk1ESGza0to3bOtrodKei2s9bk5MXm7lZ qI+WZJX4Zu9+mzZhc9pCVi8r/qlXuQIDAQABo4GnMIGkMB0GA1UdDgQWBBRvavf+ sWM4IwKiH9X9w1vl6nUVRDB1BgNVHSMEbjBsgBRvavf+sWM4IwKiH9X9w1vl6nUV RKFJpEcwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAM15n7fdxhRtMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQEFBQADggEBABY2ZzBaW0dMsAAT7tPJzrVWVzQx6KU4 UEBLudIlWPlkAwTnINCWR/8eNjCCmGA4heUdHmazdpPa8RzwOmc0NT1NQqzSyktt vTqb4iHD7+8f9MqJ9/FssCfTtqr/Qst/hGH4Wmdf1EJ/6FqYAAb5iRlPgshFZxU8 uXtA8hWn6fK6eISD9HBdcAFToUvKNZ1BIDPvh9f95Ine8ar6yGd56TUNrHR8eHBs ESxz5ddVR/oWRysNJ+aGAyYqHS8S/ttmC7r4XCAHqXptkHPCGRqkAhsterYhd4I8 /cBzejUobNCjjHFbtkAL/SjxZOLW+pNkZwfeYdM8iPkD54Uua1v2tdw= -----END CERTIFICATE-----"}, {"in"=>"query", "name"=>"private_key", "description"=>"The zones private keytttttttttttttt-----BEGIN RSA PRIVATE KEY-----MIIEowIBAAKCAQEAl 1cSc0vfcJLI4ZdWjiZZqy86Eof4czCwilyjXdvHqbdgDjz9H6K/0FX78EzVdfyExESptPCDl5YYjvcZyAWlgNfYEpFpGeoh/pTFW3hlyKImh4EgBXbDrR251J Ew2Nf56X3duibI6X20gKZA6cvdmWeKh MOOXuh1bSPU3dkb4YOF/fng5iGrx0q3txdMQXTPMZ1uXHFcBH7idgViYesXUBhdll3GP1N Y8laq0yrqh 8HMsZK m27MebqonbNmjOqE218lVEvjCdRO6xvNXrO6vNJBoGn2eGwZ8BVd0mTA3Tj43/2cmxQFY9FLq56cCXqYI1fbRRib ZLrjSNkwIDAQABAoIBABfAjjsjjxc0NxcYvKOMUb9Rpj8Sx6U/o/tDC5u XmsGX37aaJmC5yw9BQiAxgvXtQryEl5uoNoqOdsxzKV6yM0vPcwKEJVBd4G6yx6AjVJZnc2qf72erR7BbA2CQh scMDRBKE041HhgTBRNP6roim0SOgYP5JZIrGAQXNIkyE0fZc5gZNUt388ne/mjWM6Xi08BDGurLC68nsdt7Nd UYqeBVxo2EqChp5vKYZYEcG8h9XBj4u4NIwg1Mty2JqX30uBjoHvF5w/pMs8lG uvj6JR9I 19wtCuccbAJl 4cUq03UQoIDmwejea oC8A8WJr3vVpODDWrvAsjllGPBECgYEAyQRa6edYO6bsSvgbM13qXW9OQTn9YmgzfN24Ux1D66TQU6sBSLdfSHshDhTCi Ax 698aJNRWujAakA2DDgspSx98aRnHbF zvY7i7iWGesN6uN0zL 6/MK5uWoieGZRjgk230fLk00l4/FK1mJIp0apr0Lis9xmDjP5AaUPTUUCgYEAwXuhTHZWPT6v8YwOksjbuK UDkIIvyMux53kb73vrkgMboS4DB1zMLNyG 9EghS414CFROUwGl4ZUKboH1Jo5G34y8VgDuHjirTqL2H6 zNpML iMrWCXjpFKkxwPbeQnEAZ 5Rud4d PTyXAt71blZHE9tZ4KHy8cU1iKc9APcCgYAIqKZd4vg7AZK2G//X85iv06aUSrIudfyZyVcyRVVyphPPNtOEVVnGXn9rAtvqeIrOo52BR68 cj4vlXp hkDuEH QVBuY/NdQhOzFtPrKPQTJdGjIlQ2x65Vidj7r3sRukNkLPyV2v D885zcpTkp83JFuWTYiIrg275DIuAI3QKBgAglM0IrzS g3vlVQxvM1ussgRgkkYeybHq82 wUW 3DXLqeXb0s1DedplUkuoabZriz0Wh4GZFSmtA5ZpZC uV697lkYsndmp2xRhaekllW7bu pY5q88URwO2p8CO5AZ6CWFWuBwSDML5VOapGRqDRgwaD oGpb7fb7IgHOls7AoGBAJnL6Q8t35uYJ8J8hY7wso88IE04z6VaT8WganxcndesWER9eFQDHDDy//ZYeyt6M41uIY CL Vkm9Kwl/bHLJKdnOE1a9NdE6mtfah0Bk2u/YOuzyu5mmcgZiX X/OZuEbGmmbZOR1FCuIyrNYfwYohhcZP7/r0Ia/1GpkHc3Bi-----END RSA PRIVATE KEY-----"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/zones/:zone_identifier/custom_certificates/prioritize"=>{"put"=>{"summary"=>"If a zone has multiple SSL certificates, you can set the order in which they should be used during a request", "description"=>"If a zone has multiple SSL certificates, you can set the order in which they should be used during a request", "operationId"=>"cloudflare-custom-ssl-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifiercustom-certificatesprioritize-put", "parameters"=>[{"in"=>"query", "name"=>"certificates", "description"=>"Array of ordered certificates"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/zones/:zone_identifier/dns_records"=>{"get"=>{"summary"=>"List, search, sort, and filter a zones' DNS records", "description"=>"List, search, sort, and filter a zones' DNS records", "operationId"=>"cloudflare-dns-records-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifierdns-records-get", "parameters"=>[{"in"=>"query", "name"=>"content", "description"=>"DNS record contenttttttttttttttt127"}, {"in"=>"query", "name"=>"direction", "description"=>"Direction to order domainsttttttttttttttdesc"}, {"in"=>"query", "name"=>"match", "description"=>"Whether to match all search requirements or at least one (any)ttttttttttttttall"}, {"in"=>"query", "name"=>"name", "description"=>"DNS record namettttttttttttttexample"}, {"in"=>"query", "name"=>"order", "description"=>"Field to order records bytttttttttttttttype"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of paginated resultstttttttttttttt1"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of DNS records per pagetttttttttttttt20"}, {"in"=>"query", "name"=>"type", "description"=>"DNS record typettttttttttttttA"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Records"]}, "post"=>{"summary"=>"Create a new DNS record for a zone", "description"=>"Create a new DNS record for a zone", "operationId"=>"cloudflare-dns-records-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifierdns-records-post", "parameters"=>[{"in"=>"query", "name"=>"content", "description"=>"DNS record contenttttttttttttttt127"}, {"in"=>"query", "name"=>"name", "description"=>"DNS record namettttttttttttttexample"}, {"in"=>"query", "name"=>"type", "description"=>"DNS record typettttttttttttttA"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Records"]}}, "/zones/:zone_identifier/dns_records/:identifier"=>{"delete"=>{"summary"=>"Delete DNS record permission needed: #dns_records:edit", "description"=>"Delete DNS record permission needed: #dns_records:editntt", "operationId"=>"cloudflare-dns-records-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifierdns-recordsidentifier-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Records"]}, "get"=>{"summary"=>"DNS record details permission needed: #dns_records:read", "description"=>"DNS record details permission needed: #dns_records:readntt", "operationId"=>"cloudflare-dns-records-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifierdns-recordsidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Records"]}, "put"=>{"summary"=>"Update DNS record permission needed: #dns_records:edit", "description"=>"Update DNS record permission needed: #dns_records:editntt", "operationId"=>"cloudflare-dns-records-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifierdns-recordsidentifier-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Records"]}}, "/zones/:zone_id/firewall/access_rules/rules"=>{"get"=>{"summary"=>"Search, sort, and filter IP/country access rules", "description"=>"Search, sort, and filter IP/country access rules", "operationId"=>"cloudflare-firewall-access-rule-for-a-zone-api", "x-api-path-slug"=>"zoneszone-idfirewallaccess-rulesrules-get", "parameters"=>[{"in"=>"query", "name"=>"configuration_target", "description"=>"The rule configuration targetttttttttttttttip"}, {"in"=>"query", "name"=>"configuration_value", "description"=>"Search by IP, range, or country codetttttttttttttt1"}, {"in"=>"query", "name"=>"direction", "description"=>"Direction to order rulesttttttttttttttdesc"}, {"in"=>"query", "name"=>"match", "description"=>"Whether to match all search requirements or at least one (any)ttttttttttttttall"}, {"in"=>"query", "name"=>"mode", "description"=>"The action to apply to a matched requestttttttttttttttchallenge"}, {"in"=>"query", "name"=>"order", "description"=>"Field to order rules byttttttttttttttscope_type"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of paginated resultstttttttttttttt1"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of rules per pagetttttttttttttt50"}, {"in"=>"query", "name"=>"scope_type", "description"=>"The scope of the rulesttttttttttttttzone"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall Access Rule"]}, "post"=>{"summary"=>"Make a new IP, IP range, or country access rule for the zone", "description"=>"Make a new IP, IP range, or country access rule for the zone", "operationId"=>"cloudflare-firewall-access-rule-for-a-zone-api", "x-api-path-slug"=>"zoneszone-idfirewallaccess-rulesrules-post", "parameters"=>[{"in"=>"query", "name"=>"configuration", "description"=>"Rule configurationtttttttttttttttttttttOne of the following:tttttttttttttttttttttttttttttShow definition »ttttttttttttttttttttttttttttttttttttttName /typetttttttttttDescription /exampletttttttttttConstraintstttttttttttttttttttttttttttttttttttttttttttttttttttttttttargettttttttttttttstring"}, {"in"=>"query", "name"=>"mode", "description"=>"The action to apply to a matched requestttttttttttttttchallenge"}, {"in"=>"query", "name"=>"value", "description"=>"The IP address to target in requeststtttttttttttttttttttttttttttttttttt1"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall Access Rule"]}}, "/zones/:zone_id/firewall/access_rules/rules/:identifier"=>{"delete"=>{"summary"=>"Remove an access rule so it is no longer evaluated during requests", "description"=>"Remove an access rule so it is no longer evaluated during requests", "operationId"=>"cloudflare-firewall-access-rule-for-a-zone-api", "x-api-path-slug"=>"zoneszone-idfirewallaccess-rulesrulesidentifier-delete", "parameters"=>[{"in"=>"query", "name"=>"cascade", "description"=>"The level to attempt to delete rules defined on other zones that are similar to this rulettttttttttttttnone"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall Access Rule"]}, "patch"=>{"summary"=>"Update rule state and/or configuration for the zone", "description"=>"Update rule state and/or configuration for the zone", "operationId"=>"cloudflare-firewall-access-rule-for-a-zone-api", "x-api-path-slug"=>"zoneszone-idfirewallaccess-rulesrulesidentifier-patch", "parameters"=>[{"in"=>"query", "name"=>"mode", "description"=>"The action to apply to a matched requestttttttttttttttchallenge"}, {"in"=>"query", "name"=>"notes", "description"=>"A personal note about the rule"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall Access Rule"]}}, "/zones/:zone_identifier/keyless_certificates"=>{"get"=>{"summary"=>"List all Keyless SSL configurations for a given zone", "description"=>"List all Keyless SSL configurations for a given zone", "operationId"=>"cloudflare-keyless-ssl-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifierkeyless-certificates-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keyless Certificates"]}, "post"=>{"summary"=>"The keyless SSL name", "description"=>"The keyless SSL name", "operationId"=>"cloudflare-keyless-ssl-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifierkeyless-certificates-post", "parameters"=>[{"in"=>"query", "name"=>"certificate", "description"=>"The zones SSL certificate or SSL certificate and intermediate(s)tttttttttttttt-----BEGIN CERTIFICATE----- MIIDtTCCAp2gAwIBAgIJAM15n7fdxhRtMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV BAYTAlVTMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTQwMzExMTkyMTU5WhcNMTQwNDEwMTkyMTU5WjBF MQswCQYDVQQGEwJVUzETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAvq3sKsHpeduJHimOK+fvQdKsI8z8A05MZyyLp2/R/GE8FjNv+hkVY1WQ LIyTNNQH7CJecE1nbTfo8Y56S7x/rhxC6/DJ8MIulapFPnorq46KU6yRxiM0MQ3N nTJHlHA2ozZta6YBBfVfhHWl1F0IfNbXCLKvGwWWMbCx43OfW6KTkbRnE6gFWKuO fSO5h2u5TaWVuSIzBvYs7Vza6m+gtYAvKAJV2nSZ+eSEFPDo29corOy8+huEOUL8 5FAw4BFPsr1TlrlGPFitduQUHGrSL7skk1ESGza0to3bOtrodKei2s9bk5MXm7lZ qI+WZJX4Zu9+mzZhc9pCVi8r/qlXuQIDAQABo4GnMIGkMB0GA1UdDgQWBBRvavf+ sWM4IwKiH9X9w1vl6nUVRDB1BgNVHSMEbjBsgBRvavf+sWM4IwKiH9X9w1vl6nUV RKFJpEcwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAM15n7fdxhRtMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQEFBQADggEBABY2ZzBaW0dMsAAT7tPJzrVWVzQx6KU4 UEBLudIlWPlkAwTnINCWR/8eNjCCmGA4heUdHmazdpPa8RzwOmc0NT1NQqzSyktt vTqb4iHD7+8f9MqJ9/FssCfTtqr/Qst/hGH4Wmdf1EJ/6FqYAAb5iRlPgshFZxU8 uXtA8hWn6fK6eISD9HBdcAFToUvKNZ1BIDPvh9f95Ine8ar6yGd56TUNrHR8eHBs ESxz5ddVR/oWRysNJ+aGAyYqHS8S/ttmC7r4XCAHqXptkHPCGRqkAhsterYhd4I8 /cBzejUobNCjjHFbtkAL/SjxZOLW+pNkZwfeYdM8iPkD54Uua1v2tdw= -----END CERTIFICATE-----"}, {"in"=>"query", "name"=>"host", "description"=>"The keyless SSL namettttttttttttttexample"}, {"in"=>"query", "name"=>"name", "description"=>"The keyless SSL namettttttttttttttexample"}, {"in"=>"query", "name"=>"port", "description"=>"The keyless SSL port used to commmunicate between CloudFlare and the clients Keyless SSL servertttttttttttttt24008"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keyless Certificates"]}}, "/zones/:zone_identifier/keyless_certificates/:identifier"=>{"delete"=>{"summary"=>"Delete Keyless configuration permission needed: #ssl:edit", "description"=>"Delete Keyless configuration permission needed: #ssl:editntt", "operationId"=>"cloudflare-keyless-ssl-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifierkeyless-certificatesidentifier-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keyless Certificates"]}, "get"=>{"summary"=>"Details for one Keyless SSL configuration", "description"=>"Details for one Keyless SSL configuration", "operationId"=>"cloudflare-keyless-ssl-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifierkeyless-certificatesidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keyless Certificates"]}, "patch"=>{"summary"=>"This will update attributes of a Keyless SSL", "description"=>"This will update attributes of a Keyless SSL", "operationId"=>"cloudflare-keyless-ssl-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifierkeyless-certificatesidentifier-patch", "parameters"=>[{"in"=>"query", "name"=>"host", "description"=>"The keyless SSL namettttttttttttttexample"}, {"in"=>"query", "name"=>"name", "description"=>"The keyless SSL namettttttttttttttexample"}, {"in"=>"query", "name"=>"port", "description"=>"The keyless SSL port used to commmunicate between CloudFlare and the clients Keyless SSL servertttttttttttttt24008"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keyless Certificates"]}}, "/organizations/:organization_identifier/invite/:identifier"=>{"patch"=>{"summary"=>"Change the Roles of a Pending Invite", "description"=>"Change the Roles of a Pending Invite", "operationId"=>"cloudflare-organization-invites-api", "x-api-path-slug"=>"organizationsorganization-identifierinviteidentifier-patch", "parameters"=>[{"in"=>"query", "name"=>"roles", "description"=>"Array of Roles associated with the invited usertttttttttttttt[3536bcfad5faccb999b47003c79917fb]"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization Invites"]}}, "/organizations/:organization_identifier/invites"=>{"get"=>{"summary"=>"List all invitations associated with an organization", "description"=>"List all invitations associated with an organization", "operationId"=>"cloudflare-organization-invites-api", "x-api-path-slug"=>"organizationsorganization-identifierinvites-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization Invites"]}, "post"=>{"summary"=>"Invite a User to become a Member of an Organization", "description"=>"Invite a User to become a Member of an Organization", "operationId"=>"cloudflare-organization-invites-api", "x-api-path-slug"=>"organizationsorganization-identifierinvites-post", "parameters"=>[{"in"=>"query", "name"=>"invited_member_email", "description"=>"Email address of the user to be added to the Organizationttttttttttttttuser@example"}, {"in"=>"query", "name"=>"roles", "description"=>"Array of Roles associated with the invited usertttttttttttttt[{id:5a7805061c76ada191ed06f989cc3dac},{id:9a7806061c88ada191ed06f989cc3dac}]"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization Invites"]}}, "/organizations/:organization_identifier/invites/:identifier"=>{"delete"=>{"summary"=>"Cancel an existing invitation", "description"=>"Cancel an existing invitation", "operationId"=>"cloudflare-organization-invites-api", "x-api-path-slug"=>"organizationsorganization-identifierinvitesidentifier-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization Invites"]}, "get"=>{"summary"=>"Get the details of an invitation", "description"=>"Get the details of an invitation", "operationId"=>"cloudflare-organization-invites-api", "x-api-path-slug"=>"organizationsorganization-identifierinvitesidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization Invites"]}}, "/organizations/:organization_identifier/members"=>{"get"=>{"summary"=>"List all members of a organization", "description"=>"List all members of a organization", "operationId"=>"cloudflare-organization-members-api", "x-api-path-slug"=>"organizationsorganization-identifiermembers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization Members"]}}, "/organizations/:organization_identifier/members/:identifier"=>{"delete"=>{"summary"=>"Remove a member from an organization", "description"=>"Remove a member from an organization", "operationId"=>"cloudflare-organization-members-api", "x-api-path-slug"=>"organizationsorganization-identifiermembersidentifier-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization Members"]}, "get"=>{"summary"=>"Get information about a specific member of an organization", "description"=>"Get information about a specific member of an organization", "operationId"=>"cloudflare-organization-members-api", "x-api-path-slug"=>"organizationsorganization-identifiermembersidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization Members"]}, "patch"=>{"summary"=>"Change the Roles of an Organization's Member", "description"=>"Change the Roles of an Organization's Member", "operationId"=>"cloudflare-organization-members-api", "x-api-path-slug"=>"organizationsorganization-identifiermembersidentifier-patch", "parameters"=>[{"in"=>"query", "name"=>"roles", "description"=>"Array of Roles associated with this Membertttttttttttttt[3536bcfad5faccb999b47003c79917fb]"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization Members"]}}, "/organizations/:organization_identifier/roles"=>{"get"=>{"summary"=>"Get all available roles for an organization", "description"=>"Get all available roles for an organization", "operationId"=>"cloudflare-organization-roles-api", "x-api-path-slug"=>"organizationsorganization-identifierroles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization Roles"]}}, "/organizations/:organization_identifier/roles/:identifier"=>{"get"=>{"summary"=>"Get information about a specific role for an organization", "description"=>"Get information about a specific role for an organization", "operationId"=>"cloudflare-organization-roles-api", "x-api-path-slug"=>"organizationsorganization-identifierrolesidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization Roles"]}}, "/organizations/:organization_id/firewall/access_rules/rules"=>{"get"=>{"summary"=>"Search, sort, and filter IP/country access rules", "description"=>"Search, sort, and filter IP/country access rules", "operationId"=>"cloudflare-organizationlevel-firewall-access-rule-api", "x-api-path-slug"=>"organizationsorganization-idfirewallaccess-rulesrules-get", "parameters"=>[{"in"=>"query", "name"=>"configuration_target", "description"=>"The rule configuration targetttttttttttttttip"}, {"in"=>"query", "name"=>"configuration_value", "description"=>"Search by IP, range, or country codetttttttttttttt1"}, {"in"=>"query", "name"=>"direction", "description"=>"Direction to order rulesttttttttttttttdesc"}, {"in"=>"query", "name"=>"match", "description"=>"Whether to match all search requirements or at least one (any)ttttttttttttttall"}, {"in"=>"query", "name"=>"mode", "description"=>"The action to apply to a matched requestttttttttttttttchallenge"}, {"in"=>"query", "name"=>"order", "description"=>"Field to order rules byttttttttttttttmode"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of paginated resultstttttttttttttt1"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of rules per pagetttttttttttttt50"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization Firewall Access Rules"]}, "post"=>{"summary"=>"Make a new IP, IP range, or country access rule for all zones owned by the organization", "description"=>"Make a new IP, IP range, or country access rule for all zones owned by the organization", "operationId"=>"cloudflare-organizationlevel-firewall-access-rule-api", "x-api-path-slug"=>"organizationsorganization-idfirewallaccess-rulesrules-post", "parameters"=>[{"in"=>"query", "name"=>"configuration", "description"=>"Rule configurationtttttttttttttttttttttOne of the following:tttttttttttttttttttttttttttttShow definition »ttttttttttttttttttttttttttttttttttttttName /typetttttttttttDescription /exampletttttttttttConstraintstttttttttttttttttttttttttttttttttttttttttttttttttttttttttargettttttttttttttstring"}, {"in"=>"query", "name"=>"mode", "description"=>"The action to apply to a matched requestttttttttttttttchallenge"}, {"in"=>"query", "name"=>"value", "description"=>"The IP address to target in requeststtttttttttttttttttttttttttttttttttt1"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization Firewall Access Rules"]}}, "/organizations/:organization_id/firewall/access_rules/rules/:identifier"=>{"delete"=>{"summary"=>"Remove an access rule so it is no longer evaluated during requests", "description"=>"Remove an access rule so it is no longer evaluated during requests", "operationId"=>"cloudflare-organizationlevel-firewall-access-rule-api", "x-api-path-slug"=>"organizationsorganization-idfirewallaccess-rulesrulesidentifier-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization Firewall Access Rules"]}, "patch"=>{"summary"=>"Update rule state and/or configuration", "description"=>"Update rule state and/or configuration", "operationId"=>"cloudflare-organizationlevel-firewall-access-rule-api", "x-api-path-slug"=>"organizationsorganization-idfirewallaccess-rulesrulesidentifier-patch", "parameters"=>[{"in"=>"query", "name"=>"configuration", "description"=>"Rule configurationtttttttttttttttttttttOne of the following:tttttttttttttttttttttttttttttShow definition »ttttttttttttttttttttttttttttttttttttttName /typetttttttttttDescription /exampletttttttttttConstraintstttttttttttttttttttttttttttttttttttttttttttttttttttttttttargettttttttttttttstring"}, {"in"=>"query", "name"=>"mode", "description"=>"The action to apply to a matched requestttttttttttttttchallenge"}, {"in"=>"query", "name"=>"value", "description"=>"The IP address to target in requeststtttttttttttttttttttttttttttttttttt1"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization Firewall Access Rules"]}}, "/organizations/:identifier"=>{"get"=>{"summary"=>"Get information about a specific organization that you are a member of", "description"=>"Get information about a specific organization that you are a member of", "operationId"=>"cloudflare-organizations-api", "x-api-path-slug"=>"organizationsidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}, "patch"=>{"summary"=>"Update an existing Organization", "description"=>"Update an existing Organization", "operationId"=>"cloudflare-organizations-api", "x-api-path-slug"=>"organizationsidentifier-patch", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"Organization NamettttttttttttttCloudFlare, Inc"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}, "/railguns"=>{"get"=>{"summary"=>"List, search, sort and filter your Railguns", "description"=>"List, search, sort and filter your Railguns", "operationId"=>"cloudflare-railgun-api", "x-api-path-slug"=>"railguns-get", "parameters"=>[{"in"=>"query", "name"=>"direction", "description"=>"Direction to order Railgunsttttttttttttttdesc"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of paginated resultstttttttttttttt1"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per pagetttttttttttttt20"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Performance"]}, "post"=>{"summary"=>"Readable identifier of the railgun", "description"=>"Readable identifier of the railgun", "operationId"=>"cloudflare-railgun-api", "x-api-path-slug"=>"railguns-post", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"Readable identifier of the railgunttttttttttttttMy Railgun"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Performance"]}}, "/railguns/:identifier"=>{"delete"=>{"summary"=>"Disable and delete a Railgun", "description"=>"Disable and delete a Railgun", "operationId"=>"cloudflare-railgun-api", "x-api-path-slug"=>"railgunsidentifier-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Performance"]}, "get"=>{"summary"=>"Railgun details", "description"=>"Railgun detailsntt", "operationId"=>"cloudflare-railgun-api", "x-api-path-slug"=>"railgunsidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Performance"]}, "patch"=>{"summary"=>"Enable or disable a Railgun for all zones connected to it", "description"=>"Enable or disable a Railgun for all zones connected to it", "operationId"=>"cloudflare-railgun-api", "x-api-path-slug"=>"railgunsidentifier-patch", "parameters"=>[{"in"=>"query", "name"=>"enabled", "description"=>"Flag to determine if the Railgun is accepting connectionstttttttttttttttrue"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Performance"]}}, "/railguns/:identifier/zones"=>{"get"=>{"summary"=>"The zones that are currently using this Railgun", "description"=>"The zones that are currently using this Railgun", "operationId"=>"cloudflare-railgun-api", "x-api-path-slug"=>"railgunsidentifierzones-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Performance"]}}, "/zones/:zone_identifier/railguns"=>{"get"=>{"summary"=>"A list of available Railguns the zone can use", "description"=>"A list of available Railguns the zone can use", "operationId"=>"cloudflare-railgun-connections-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifierrailguns-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Performance"]}}, "/zones/:zone_identifier/railguns/:identifier"=>{"get"=>{"summary"=>"Details about a specific Railgun", "description"=>"Details about a specific Railgun", "operationId"=>"cloudflare-railgun-connections-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifierrailgunsidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Performance"]}, "patch"=>{"summary"=>"Connect or disconnect a Railgun", "description"=>"Connect or disconnect a Railgun", "operationId"=>"cloudflare-railgun-connections-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifierrailgunsidentifier-patch", "parameters"=>[{"in"=>"query", "name"=>"connected", "description"=>"A flag indicating whether the given zone is connected to the Railguntttttttttttttttrue"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Performance"]}}, "/zones/:zone_identifier/railguns/:identifier/diagnose"=>{"get"=>{"summary"=>"Test Railgun connection to the Zone", "description"=>"Test Railgun connection to the Zone", "operationId"=>"cloudflare-railgun-connections-for-a-zone-api", "x-api-path-slug"=>"zoneszone-identifierrailgunsidentifierdiagnose-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Performance"]}}, "/user"=>{"get"=>{"summary"=>"User details", "description"=>"User detailsn", "operationId"=>"cloudflare-user-api", "x-api-path-slug"=>"user-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "patch"=>{"summary"=>"Update part of your user details", "description"=>"Update part of your user details", "operationId"=>"cloudflare-user-api", "x-api-path-slug"=>"user-patch", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"The country in which the user lives"}, {"in"=>"query", "name"=>"first_name", "description"=>"Users first nameJohn"}, {"in"=>"query", "name"=>"last_name", "description"=>"Users last nameAppleseed"}, {"in"=>"query", "name"=>"telephone", "description"=>"Users telephone number+1 123-123-1234"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}, {"in"=>"query", "name"=>"zipcode", "description"=>"The zipcode or postal code where the user lives"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/user/billing/history"=>{"get"=>{"summary"=>"Access your billing history object", "description"=>"Access your billing history object", "operationId"=>"cloudflare-user-billing-history-api", "x-api-path-slug"=>"userbillinghistory-get", "parameters"=>[{"in"=>"query", "name"=>"action", "description"=>"The billing item actionsubscription"}, {"in"=>"query", "name"=>"occured_at", "description"=>"When the billing item was created2014-03-01T12:21:59"}, {"in"=>"query", "name"=>"order", "description"=>"Field to order billing history byoccured_at"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of paginated results1"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page20"}, {"in"=>"query", "name"=>"type", "description"=>"The billing item typecharge"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Billing History"]}}, "/user/billing/profile"=>{"get"=>{"summary"=>"Access your billing profile object", "description"=>"Access your billing profile object", "operationId"=>"cloudflare-user-billing-profile-api", "x-api-path-slug"=>"userbillingprofile-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Billing Profile"]}}, "/user/firewall/access_rules/rules"=>{"get"=>{"summary"=>"Search, sort, and filter IP/country access rules", "description"=>"Search, sort, and filter IP/country access rules", "operationId"=>"cloudflare-userlevel-firewall-access-rule-api", "x-api-path-slug"=>"userfirewallaccess-rulesrules-get", "parameters"=>[{"in"=>"query", "name"=>"configuration_target", "description"=>"The rule configuration targetip"}, {"in"=>"query", "name"=>"configuration_value", "description"=>"Search by IP, range, or country code1"}, {"in"=>"query", "name"=>"direction", "description"=>"Direction to order rulesdesc"}, {"in"=>"query", "name"=>"match", "description"=>"Whether to match all search requirements or at least one (any)all"}, {"in"=>"query", "name"=>"mode", "description"=>"The action to apply to a matched requestchallenge"}, {"in"=>"query", "name"=>"order", "description"=>"Field to order rules bymode"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of paginated results1"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of rules per page50"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Level Firewall Access Rule"]}, "post"=>{"summary"=>"Make a new IP, IP range, or country access rule for all zones owned by the user", "description"=>"Make a new IP, IP range, or country access rule for all zones owned by the user", "operationId"=>"cloudflare-userlevel-firewall-access-rule-api", "x-api-path-slug"=>"userfirewallaccess-rulesrules-post", "parameters"=>[{"in"=>"query", "name"=>"configuration", "description"=>"Rule configurationOne of the following:Show definition »Name /typeDescription /exampleConstraintstargetstring"}, {"in"=>"query", "name"=>"mode", "description"=>"The action to apply to a matched requestchallenge"}, {"in"=>"query", "name"=>"value", "description"=>"The IP address to target in requests1"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Level Firewall Access Rule"]}}, "/user/firewall/access_rules/rules/:identifier"=>{"delete"=>{"summary"=>"Remove an access rule so it is no longer evaluated during requests", "description"=>"Remove an access rule so it is no longer evaluated during requests", "operationId"=>"cloudflare-userlevel-firewall-access-rule-api", "x-api-path-slug"=>"userfirewallaccess-rulesrulesidentifier-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Level Firewall Access Rule"]}, "patch"=>{"summary"=>"Update rule state and/or configuration", "description"=>"Update rule state and/or configuration", "operationId"=>"cloudflare-userlevel-firewall-access-rule-api", "x-api-path-slug"=>"userfirewallaccess-rulesrulesidentifier-patch", "parameters"=>[{"in"=>"query", "name"=>"configuration", "description"=>"Rule configurationOne of the following:Show definition »Name /typeDescription /exampleConstraintstargetstring"}, {"in"=>"query", "name"=>"mode", "description"=>"The action to apply to a matched requestchallenge"}, {"in"=>"query", "name"=>"value", "description"=>"The IP address to target in requests1"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Level Firewall Access Rule"]}}, "/user/invites"=>{"get"=>{"summary"=>"List all invitations associated with my user", "description"=>"List all invitations associated with my user", "operationId"=>"cloudflare-userx27s-invites-api", "x-api-path-slug"=>"userinvites-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Invites"]}}, "/user/invites/:identifier"=>{"get"=>{"summary"=>"Get the details of an invitation", "description"=>"Get the details of an invitation", "operationId"=>"cloudflare-userx27s-invites-api", "x-api-path-slug"=>"userinvitesidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Invites"]}, "patch"=>{"summary"=>"Respond to an invitation", "description"=>"Respond to an invitation", "operationId"=>"cloudflare-userx27s-invites-api", "x-api-path-slug"=>"userinvitesidentifier-patch", "parameters"=>[{"in"=>"query", "name"=>"status", "description"=>"Status of your response to the invitation (rejected or accepted)accepted"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Invites"]}}, "/user/organizations"=>{"get"=>{"summary"=>"List organizations the user is associated with", "description"=>"List organizations the user is associated with", "operationId"=>"cloudflare-userx27s-organizations-api", "x-api-path-slug"=>"userorganizations-get", "parameters"=>[{"in"=>"query", "name"=>"direction", "description"=>"Direction to order organizationsdesc"}, {"in"=>"query", "name"=>"match", "description"=>"Whether to match all search requirements or at least one (any)all"}, {"in"=>"query", "name"=>"name", "description"=>"Organization NameCloudFlare, Inc"}, {"in"=>"query", "name"=>"order", "description"=>"Field to order organizations bystatus"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of paginated results1"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of organizations per page20"}, {"in"=>"query", "name"=>"status", "description"=>"Whether or not the user is a member of the organization or has an inivitation pendingmember"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Organizations"]}}, "/user/organizations/:identifier"=>{"delete"=>{"summary"=>"Remove association to an organization", "description"=>"Remove association to an organization", "operationId"=>"cloudflare-userx27s-organizations-api", "x-api-path-slug"=>"userorganizationsidentifier-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Organizations"]}, "get"=>{"summary"=>"Get a specific organization the user is associated with", "description"=>"Get a specific organization the user is associated with", "operationId"=>"cloudflare-userx27s-organizations-api", "x-api-path-slug"=>"userorganizationsidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Organizations"]}}, "/zones/:zone_identifier/firewall/waf/packages/:package_identifier/groups"=>{"get"=>{"summary"=>"Search, list, and sort rule groups contained within a package", "description"=>"Search, list, and sort rule groups contained within a package", "operationId"=>"cloudflare-waf-rule-groups-api", "x-api-path-slug"=>"zoneszone-identifierfirewallwafpackagespackage-identifiergroups-get", "parameters"=>[{"in"=>"query", "name"=>"direction", "description"=>"Direction to order groupsttttttttttttttdesc"}, {"in"=>"query", "name"=>"match", "description"=>"Whether to match all search requirements or at least one (any)ttttttttttttttall"}, {"in"=>"query", "name"=>"mode", "description"=>"Whether or not the rules contained within this group are configurable/usabletttttttttttttton"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the firewall rule groupttttttttttttttProject Honey Pot"}, {"in"=>"query", "name"=>"order", "description"=>"Field to order groups byttttttttttttttmode"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of paginated resultstttttttttttttt1"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of groups per pagetttttttttttttt50"}, {"in"=>"query", "name"=>"rules_count", "description"=>"How many rules are contained within this grouptttttttttttttt10"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WAF Rule Groups"]}}, "/zones/:zone_identifier/firewall/waf/packages/:package_identifier/groups/:identifier"=>{"get"=>{"summary"=>"Get a single rule group", "description"=>"Get a single rule group", "operationId"=>"cloudflare-waf-rule-groups-api", "x-api-path-slug"=>"zoneszone-identifierfirewallwafpackagespackage-identifiergroupsidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WAF Rule Groups"]}, "patch"=>{"summary"=>"Update the state of a rule group", "description"=>"Update the state of a rule group", "operationId"=>"cloudflare-waf-rule-groups-api", "x-api-path-slug"=>"zoneszone-identifierfirewallwafpackagespackage-identifiergroupsidentifier-patch", "parameters"=>[{"in"=>"query", "name"=>"mode", "description"=>"Whether or not the rules contained within this group are configurable/usabletttttttttttttton"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WAF Rule Groups"]}}, "/zones/:zone_identifier/firewall/waf/packages"=>{"get"=>{"summary"=>"Retrieve firewall packages for a zone", "description"=>"Retrieve firewall packages for a zone", "operationId"=>"cloudflare-waf-rule-packages-api", "x-api-path-slug"=>"zoneszone-identifierfirewallwafpackages-get", "parameters"=>[{"in"=>"query", "name"=>"direction", "description"=>"Direction to order packagesttttttttttttttdesc"}, {"in"=>"query", "name"=>"match", "description"=>"Whether to match all search requirements or at least one (any)ttttttttttttttall"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the firewall packagettttttttttttttWordPress rules"}, {"in"=>"query", "name"=>"order", "description"=>"Field to order packages byttttttttttttttstatus"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of paginated resultstttttttttttttt1"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of packages per pagetttttttttttttt50"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WAF Rule Packages"]}}, "/zones/:zone_identifier/firewall/waf/packages/:identifier"=>{"get"=>{"summary"=>"Get information about a single firewall package", "description"=>"Get information about a single firewall package", "operationId"=>"cloudflare-waf-rule-packages-api", "x-api-path-slug"=>"zoneszone-identifierfirewallwafpackagesidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WAF Rule Packages"]}, "patch"=>{"summary"=>"Change the sensitivity and action for an anomaly detection type WAF rule package", "description"=>"Change the sensitivity and action for an anomaly detection type WAF rule package", "operationId"=>"cloudflare-waf-rule-packages-api", "x-api-path-slug"=>"zoneszone-identifierfirewallwafpackagesidentifier-patch", "parameters"=>[{"in"=>"query", "name"=>"action_mode", "description"=>"The default action that will be taken for rules under the firewall package"}, {"in"=>"query", "name"=>"sensitivity", "description"=>"The sensitivity of the firewall package"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WAF Rule Packages"]}}, "/zones/:zone_id/firewall/waf/packages/:package_id/rules"=>{"get"=>{"summary"=>"Search, sort, and filter rules within a package", "description"=>"Search, sort, and filter rules within a package", "operationId"=>"cloudflare-waf-rules-api", "x-api-path-slug"=>"zoneszone-idfirewallwafpackagespackage-idrules-get", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"Public description of the rulettttttttttttttSQL injection prevention for SELECT statements"}, {"in"=>"query", "name"=>"direction", "description"=>"Direction to order rulesttttttttttttttdesc"}, {"in"=>"query", "name"=>"group_id", "description"=>"WAF group identifier tagttttttttttttttde677e5818985db1285d0e80225f06e5"}, {"in"=>"query", "name"=>"match", "description"=>"Whether to match all search requirements or at least one (any)ttttttttttttttall"}, {"in"=>"query", "name"=>"mode", "description"=>"The rule modetttttttttttttttttttttOne of the following:ttttttttttttttttttttttWhether or not the anomaly-based rule will be used when evaluating the request"}, {"in"=>"query", "name"=>"order", "description"=>"Field to order rules byttttttttttttttstatus"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of paginated resultstttttttttttttt1"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of rules per pagetttttttttttttt50"}, {"in"=>"query", "name"=>"priority", "description"=>"The order in which the individual rule is executed within the related grouptttttttttttttt5"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WAF Rules"]}}, "/zones/:zone_id/firewall/waf/packages/:package_id/rules/:identifier"=>{"get"=>{"summary"=>"Individual information about a rule", "description"=>"Individual information about a rule", "operationId"=>"cloudflare-waf-rules-api", "x-api-path-slug"=>"zoneszone-idfirewallwafpackagespackage-idrulesidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WAF Rules"]}, "patch"=>{"summary"=>"Update the action the rule will perform if triggered on the zone", "description"=>"Update the action the rule will perform if triggered on the zone", "operationId"=>"cloudflare-waf-rules-api", "x-api-path-slug"=>"zoneszone-idfirewallwafpackagespackage-idrulesidentifier-patch", "parameters"=>[{"in"=>"query", "name"=>"mode", "description"=>"The mode to use when the rule is triggered"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WAF Rules"]}}, "/zones/:zone_identifier/analytics/colos"=>{"get"=>{"summary"=>"This view provides a breakdown of analytics data by datacenter", "description"=>"This view provides a breakdown of analytics data by datacenter", "operationId"=>"cloudflare-zone-analytics-api", "x-api-path-slug"=>"zoneszone-identifieranalyticscolos-get", "parameters"=>[{"in"=>"query", "name"=>"continuous", "description"=>"When set to true, the range returned by the response acts like a sliding window to provide a contiguous time-window"}, {"in"=>"query", "name"=>"since", "description"=>"The (inclusive) beginning of the requested time frame"}, {"in"=>"query", "name"=>"until", "description"=>"The (exclusive) end of the requested time frame"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones", "Analytics"]}}, "/zones/:zone_identifier/analytics/dashboard"=>{"get"=>{"summary"=>"The dashboard view provides both totals and timeseries data for the given zone and time period across the entire CloudFlare network", "description"=>"The dashboard view provides both totals and timeseries data for the given zone and time period across the entire CloudFlare network", "operationId"=>"cloudflare-zone-analytics-api", "x-api-path-slug"=>"zoneszone-identifieranalyticsdashboard-get", "parameters"=>[{"in"=>"query", "name"=>"continuous", "description"=>"When set to true, the range returned by the response acts like a sliding window to provide a contiguous time-window"}, {"in"=>"query", "name"=>"since", "description"=>"The (inclusive) beginning of the requested time frame"}, {"in"=>"query", "name"=>"until", "description"=>"The (exclusive) end of the requested time frame"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones", "Analytics"]}}, "/zones"=>{"get"=>{"summary"=>"List, search, sort, and filter your zones", "description"=>"List, search, sort, and filter your zones", "operationId"=>"cloudflare-zone-api", "x-api-path-slug"=>"zones-get", "parameters"=>[{"in"=>"query", "name"=>"direction", "description"=>"Direction to order zonesttttttttttttttdesc"}, {"in"=>"query", "name"=>"match", "description"=>"Whether to match all search requirements or at least one (any)ttttttttttttttall"}, {"in"=>"query", "name"=>"name", "description"=>"A domain namettttttttttttttexample"}, {"in"=>"query", "name"=>"order", "description"=>"Field to order zones byttttttttttttttstatus"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of paginated resultstttttttttttttt1"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of zones per pagetttttttttttttt20"}, {"in"=>"query", "name"=>"status", "description"=>"Status of the zonettttttttttttttactive"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones"]}, "post"=>{"summary"=>"The domain name", "description"=>"The domain name", "operationId"=>"cloudflare-zone-api", "x-api-path-slug"=>"zones-post", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"The domain namettttttttttttttexample"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones"]}}, "/zones/:identifier"=>{"delete"=>{"summary"=>"Delete an existing zone", "description"=>"Delete an existing zone", "operationId"=>"cloudflare-zone-api", "x-api-path-slug"=>"zonesidentifier-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones"]}, "get"=>{"summary"=>"Zone details permission needed: #zone:read", "description"=>"Zone details permission needed: #zone:readntt", "operationId"=>"cloudflare-zone-api", "x-api-path-slug"=>"zonesidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones"]}, "patch"=>{"summary"=>"Only one zone property can be changed at a time", "description"=>"Only one zone property can be changed at a time", "operationId"=>"cloudflare-zone-api", "x-api-path-slug"=>"zonesidentifier-patch", "parameters"=>[{"in"=>"query", "name"=>"paused", "description"=>"Indicates if the zone is only using CloudFlare DNS services"}, {"in"=>"query", "name"=>"plan", "description"=>"The desired plan for the zone"}, {"in"=>"query", "name"=>"vanity_name_servers", "description"=>"An array of domains used for custom name servers"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones"]}}, "/zones/:identifier/activation_check"=>{"put"=>{"summary"=>"Initiate another zone activation check permission needed: #zone:edit", "description"=>"Initiate another zone activation check permission needed: #zone:editntt", "operationId"=>"cloudflare-zone-api", "x-api-path-slug"=>"zonesidentifieractivation-check-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones"]}}, "/zones/:identifier/purge_cache"=>{"delete"=>{"summary"=>"Remove ALL files from CloudFlare's cache", "description"=>"Remove ALL files from CloudFlare's cache", "operationId"=>"cloudflare-zone-api", "x-api-path-slug"=>"zonesidentifierpurge-cache-delete", "parameters"=>[{"in"=>"query", "name"=>"files", "description"=>"An array of URLs that should be removed from cachetttttttttttttt[http://www"}, {"in"=>"query", "name"=>"purge_everything", "description"=>"A flag that indicates all resources in CloudFlares cache should be removed"}, {"in"=>"query", "name"=>"tags", "description"=>"Any assets served with a Cache-Tag header that matches one of the provided values will be purged from the CloudFlare cachetttttttttttttt[some-tag,another-tag]"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones"]}}, "/user/billing/subscriptions/zones"=>{"get"=>{"summary"=>"List all of your zone plan subscriptions", "description"=>"List all of your zone plan subscriptions", "operationId"=>"cloudflare-zone-subscription-api", "x-api-path-slug"=>"userbillingsubscriptionszones-get", "parameters"=>[{"in"=>"query", "name"=>"activated_on", "description"=>"When the subscription was activated2014-03-01T12:20:00Z"}, {"in"=>"query", "name"=>"cancelled_on", "description"=>"When the subscription was cancelled2014-04-01T12:20:00Z"}, {"in"=>"query", "name"=>"direction", "description"=>"Direction to order subscriptionsdesc"}, {"in"=>"query", "name"=>"expired_on", "description"=>"When the subscription expired2014-04-02T12:20:00Z"}, {"in"=>"query", "name"=>"expires_on", "description"=>"When the subscription will expire2014-03-31T12:20:00Z"}, {"in"=>"query", "name"=>"match", "description"=>"Whether to match all search requirements or at least one (any)all"}, {"in"=>"query", "name"=>"order", "description"=>"Field to order subscriptions bystatus"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of paginated results1"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of items per page20"}, {"in"=>"query", "name"=>"price", "description"=>"The price of the subscription that will be billed, in US dollars20"}, {"in"=>"query", "name"=>"renewed_on", "description"=>"When the subscription was renewed2014-05-11T12:20:00Z"}, {"in"=>"query", "name"=>"status", "description"=>"The state of the subscriptionactive"}, {"in"=>"header", "name"=>"X-AUTH-EMAIL", "description"=>"Email address associated with your account"}, {"in"=>"header", "name"=>"X-AUTH-KEY", "description"=>"API key generated on the My Account page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zone Subscriptions"]}}, "/user/billing/subscriptions/zones/:identifier"=>{"get"=>{"summary"=>"Billing subscription details", "description"=>"Billing subscription details", "operationId"=>"cloudflare-zone-subscription-api", "x-api-path-slug"=>"userbillingsubscriptionszonesidentifier-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zone Subscriptions"]}}}}, "apis"=>{"name"=>"CloudFlare", "x-slug"=>"cloudflare", "description"=>"Here at Cloudflare, we make the Internet work the way it should. Offering CDN, DNS, DDoS protection and security, find out how we can help your site.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/18929-cloudflare.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"1685", "tags"=>"API Provider,API Service Provider,CDN,DNS,DNS New,Encryption,Enterprise,internet,My API Stack,Networks,Profiles,Relative Data,SaaS,Security,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"cloudflare/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"CloudFlare", "x-api-slug"=>"cloudflare", "description"=>"Here at Cloudflare, we make the Internet work the way it should. Offering CDN, DNS, DDoS protection and security, find out how we can help your site.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/18929-cloudflare.jpg", "humanURL"=>"https://www.cloudflare.com", "baseURL"=>"https:///", "tags"=>"API Provider,API Service Provider,CDN,DNS,DNS New,Encryption,Enterprise,internet,My API Stack,Networks,Profiles,Relative Data,SaaS,Security,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/cloudflare/userbillingsubscriptionszonesidentifier-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/cloudflare/cloudflare-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://blog.cloudflare.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.cloudflare.com/rss/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/cloudflare"}, {"type"=>"x-developer", "url"=>"https://www.cloudflare.com/docs/client-api.html"}, {"type"=>"x-github", "url"=>"https://github.com/cloudflare"}, {"type"=>"x-partners", "url"=>"https://www.cloudflare.com/partners/"}, {"type"=>"x-pricing", "url"=>"https://www.cloudflare.com/plans/"}, {"type"=>"x-privacy", "url"=>"https://www.cloudflare.com/security-policy"}, {"type"=>"x-security", "url"=>"https://www.cloudflare.com/security-policy/"}, {"type"=>"x-terms-of-service", "url"=>"https://www.cloudflare.com/terms/"}, {"type"=>"x-transparency-report", "url"=>"https://www.cloudflare.com/transparency/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/CloudFlare"}, {"type"=>"x-website", "url"=>"https://www.cloudflare.com"}, {"type"=>"x-website", "url"=>"http://cloudflare.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
watchful{"watchful-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Watchful", "x-complete"=>1, "info"=>{"title"=>"Watchful", "description"=>"watchful-resulted-from-the-need-for-a-single-unified-dashboard-to-easily-monitor-all-of-the-web-sites-in-our-portfolios--after-years-of-evolution-our-solution-has-matured-into-a-simple-complete-and-professional-service--", "version"=>"1.0.0"}, "host"=>"watchful.li", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/audits"=>{"get"=>{"summary"=>"Get A List Of Audits", "description"=>"Returns a list of audits", "operationId"=>"getAudits", "x-api-path-slug"=>"audits-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Number of object to return (max 100, default 25)"}, {"in"=>"query", "name"=>"limitstart", "description"=>"Start of the return (default 0)"}, {"in"=>"query", "name"=>"order", "description"=>"ORDER by this field separete by comas"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audits"]}, "post"=>{"summary"=>"Create A Audit", "description"=>"Create a audit.", "operationId"=>"CreateAudits", "x-api-path-slug"=>"audits-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON object Audit", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audits"]}}, "/audits/metadata"=>{"get"=>{"summary"=>"Get The List Of Fields", "description"=>"Returns a list of fields", "operationId"=>"getFieldsAudits", "x-api-path-slug"=>"auditsmetadata-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audits", "Metadata"]}}, "/audits/{id}"=>{"delete"=>{"summary"=>"Delete A Specific Audit", "description"=>"Delete a specific audit.", "operationId"=>"deleteAuditById", "x-api-path-slug"=>"auditsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of audit that needs to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audits", "Id"]}, "get"=>{"summary"=>"Find Audit By ID", "description"=>"Returns a audit based on ID", "operationId"=>"getAuditById", "x-api-path-slug"=>"auditsid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Fields to return separate by comas: name,id"}, {"in"=>"path", "name"=>"id", "description"=>"ID of audit that needs to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audits", "Id"]}}, "/extensions"=>{"get"=>{"summary"=>"Get A List Extensions", "description"=>"Returns a list Extensions", "operationId"=>"getExtensions", "x-api-path-slug"=>"extensions-get", "parameters"=>[{"in"=>"query", "name"=>"ext_name", "description"=>"Do a LIKE search, you can also use %"}, {"in"=>"query", "name"=>"ext_prefix", "description"=>"Do a LIKE search, you can also use %"}, {"in"=>"query", "name"=>"fields", "description"=>"Fields to return separate by comas: name,id"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of object to return (max 100, default 25)"}, {"in"=>"query", "name"=>"limitstart", "description"=>"Start of the return (default 0)"}, {"in"=>"query", "name"=>"order", "description"=>"ORDER by this field separete by comas"}, {"in"=>"query", "name"=>"siteids", "description"=>"List of sites id separated by comma"}, {"in"=>"query", "name"=>"version", "description"=>"Do a LIKE search, you can also use %"}, {"in"=>"query", "name"=>"vUpdate", "description"=>"update available for this extension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extensions"]}}, "/extensions/metadata"=>{"get"=>{"summary"=>"Get The List Of Fields", "description"=>"Returns a list of fields", "operationId"=>"getFieldsExtensions", "x-api-path-slug"=>"extensionsmetadata-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extensions", "Metadata"]}}, "/extensions/{id}/ignore"=>{"post"=>{"summary"=>"Set 'ignore Updates' For A Given Extension / Site_id", "description"=>"Set 'ignore updates' for a given extension / site_id", "operationId"=>"ignoreExtensionUpdate", "x-api-path-slug"=>"extensionsidignore-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the extension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extensions", "Id", "Ignore"]}}, "/extensions/{id}/unignore"=>{"post"=>{"summary"=>"Remove 'ignore Updates' For A Given Extension", "description"=>"Remove 'ignore updates' for a given extension", "operationId"=>"unignoreExtensionUpdate", "x-api-path-slug"=>"extensionsidunignore-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the extension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extensions", "Id", "Unignore"]}}, "/extensions/{id}/update"=>{"post"=>{"summary"=>"Update The Extension On The Remote Site", "description"=>"Update the extension on the remote site", "operationId"=>"updateExtension", "x-api-path-slug"=>"extensionsidupdate-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the extension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extensions", "Id", "Update"]}}, "/feedbacks"=>{"get"=>{"summary"=>"Get Feedbacks", "description"=>"Returns a list of feedbacks", "operationId"=>"getFeedbacks", "x-api-path-slug"=>"feedbacks-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Fields to return separate by comas (es"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feedbacks"]}, "post"=>{"summary"=>"Create A Feedback", "description"=>"Create a feedback", "operationId"=>"createFeedbacks", "x-api-path-slug"=>"feedbacks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON object Feedback", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feedbacks"]}}, "/feedbacks/metadata"=>{"get"=>{"summary"=>"Get The List Of Fields", "description"=>"Returns a list of fields", "operationId"=>"getFieldsFeedbacks", "x-api-path-slug"=>"feedbacksmetadata-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feedbacks", "Metadata"]}}, "/logs"=>{"get"=>{"summary"=>"Get A List Of Logs", "description"=>"Returns a list of logs", "operationId"=>"logs.get", "x-api-path-slug"=>"logs-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Fields to return separate by comas: name,id"}, {"in"=>"query", "name"=>"from", "description"=>"Logs after this date, format YYYY-MM-DD HH:MM:SS"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of object to return (max 100, default 25)"}, {"in"=>"query", "name"=>"limitstart", "description"=>"Start of the return (default 0)"}, {"in"=>"query", "name"=>"log_entry", "description"=>"Do a LIKE search, you can also use %"}, {"in"=>"query", "name"=>"log_type", "description"=>"Type of the log"}, {"in"=>"query", "name"=>"order", "description"=>"ORDER by this field separete by comas"}, {"in"=>"query", "name"=>"to", "description"=>"Logs before this date, format YYYY-MM-DD HH:MM:SS"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logs"]}}, "/logs/export"=>{"get"=>{"summary"=>"Get A CSV Or PDF File Contain The List Of Logs", "description"=>"Returns a file contain the list of logs", "operationId"=>"getExportLogs", "x-api-path-slug"=>"logsexport-get", "parameters"=>[{"in"=>"query", "name"=>"enddate", "description"=>"Logs before this date, format YYYY-MM-DD HH:MM:SS"}, {"in"=>"query", "name"=>"filter_type", "description"=>"Type of the log"}, {"in"=>"query", "name"=>"format", "description"=>"Format of exported file (PDF or CSV)"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of object to return (max 100, default 25)"}, {"in"=>"query", "name"=>"search", "description"=>"Do a LIKE search, you can also use %"}, {"in"=>"query", "name"=>"site", "description"=>"Site id of the log"}, {"in"=>"query", "name"=>"startdate", "description"=>"Logs after this date, format YYYY-MM-DD HH:MM:SS"}, {"in"=>"query", "name"=>"startid", "description"=>"Start of the return (default 0)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logs", "Export"]}}, "/logs/metadata"=>{"get"=>{"summary"=>"Get The List Of Fields", "description"=>"Returns a list of fields", "operationId"=>"getFieldsLogs", "x-api-path-slug"=>"logsmetadata-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logs", "Metadata"]}}, "/logs/types"=>{"get"=>{"summary"=>"Get The List Of Log Types", "description"=>"Returns a list of log types", "operationId"=>"getTypesLogs", "x-api-path-slug"=>"logstypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logs", "Types"]}}, "/logs/{id}"=>{"delete"=>{"summary"=>"Delete A Specific Log", "description"=>"Delete a specific log", "operationId"=>"deleteLogById", "x-api-path-slug"=>"logsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of log that needs to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logs", "Id"]}}, "/packages"=>{"post"=>{"summary"=>"", "description"=>"", "operationId"=>"packages.post", "x-api-path-slug"=>"packages-post", "parameters"=>[{"in"=>"formData", "name"=>"file", "description"=>"ZIP package"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Packages"]}}, "/reports/sites/{id}"=>{"get"=>{"summary"=>"Returns A PDF Report For A Specific Site", "description"=>"Returns a PDF report based on a site ID", "operationId"=>"reports.sites.id.get", "x-api-path-slug"=>"reportssitesid-get", "parameters"=>[{"in"=>"query", "name"=>"compare", "description"=>"Define if you want show previous values in Google Analytics graph"}, {"in"=>"query", "name"=>"from", "description"=>"Start of the report, format YYYY-MM-DD, default today-30day"}, {"in"=>"path", "name"=>"id", "description"=>"ID that needs to be fetched"}, {"in"=>"query", "name"=>"log_type", "description"=>"Type of the log to show in the report"}, {"in"=>"query", "name"=>"reports", "description"=>"Type of reports separate by comas: Ga,Logs,Uptime"}, {"in"=>"query", "name"=>"to", "description"=>"End of the report, format YYYY-MM-DD, default today"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "Sites", "Id"]}}, "/reports/tags/{id}"=>{"get"=>{"summary"=>"Find Sites By ID", "description"=>"Returns a report based on a site ID", "operationId"=>"reports.tags.id.get", "x-api-path-slug"=>"reportstagsid-get", "parameters"=>[{"in"=>"query", "name"=>"compare", "description"=>"Define if you want show previous values in Google Analytics graph"}, {"in"=>"query", "name"=>"from", "description"=>"Start of the report, format YYYY-MM-DD, default today-30day"}, {"in"=>"path", "name"=>"id", "description"=>"ID that needs to be fetched"}, {"in"=>"query", "name"=>"log_type", "description"=>"Type of the log to show in the report"}, {"in"=>"query", "name"=>"reports", "description"=>"Type of reports separate by comas: Ga,Logs,Uptime"}, {"in"=>"query", "name"=>"to", "description"=>"End of the report, format YYYY-MM-DD, default today"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "Tags", "Id"]}}, "/sites"=>{"get"=>{"summary"=>"Get A List Of Sites", "description"=>"Returns a list of Sites", "operationId"=>"getSites", "x-api-path-slug"=>"sites-get", "parameters"=>[{"in"=>"query", "name"=>"access_url", "description"=>"Access URL"}, {"in"=>"query", "name"=>"canUpdate", "description"=>"canUpdate"}, {"in"=>"query", "name"=>"error", "description"=>"Has errors"}, {"in"=>"query", "name"=>"fields", "description"=>"Fields to return separated by commas (e"}, {"in"=>"query", "name"=>"ip", "description"=>"Ip address"}, {"in"=>"query", "name"=>"jUpdate", "description"=>"Joomla core update status (1: update required, 0: update not required)"}, {"in"=>"query", "name"=>"j_version", "description"=>"Joomla version"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of objects to return (max 100, default 25)"}, {"in"=>"query", "name"=>"limitstart", "description"=>"Start of the return (default 0)"}, {"in"=>"query", "name"=>"name", "description"=>"Site name"}, {"in"=>"query", "name"=>"nbUpdates"}, {"in"=>"query", "name"=>"order", "description"=>"ORDER by this field separete by comas"}, {"in"=>"query", "name"=>"published", "description"=>"Is published"}, {"in"=>"query", "name"=>"siteids", "description"=>"List of sites id separated by comma"}, {"in"=>"query", "name"=>"up", "description"=>"Is online"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites"]}, "post"=>{"summary"=>"Create A Site", "description"=>"Create a site", "operationId"=>"createSite", "x-api-path-slug"=>"sites-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON object Site", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites"]}}, "/sites/metadata"=>{"get"=>{"summary"=>"Get The List Of Fields", "description"=>"Returns a list of fields", "operationId"=>"sites.metadata.get", "x-api-path-slug"=>"sitesmetadata-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Metadata"]}}, "/sites/{id}"=>{"delete"=>{"summary"=>"Delete A Specific Site", "description"=>"Delete a specific Site", "operationId"=>"sites.id.delete", "x-api-path-slug"=>"sitesid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of Site that needs to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id"]}, "get"=>{"summary"=>"Find Sites By ID", "description"=>"Return a site based on ID", "operationId"=>"getSiteById", "x-api-path-slug"=>"sitesid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Fields to return separate by comas: name,id"}, {"in"=>"path", "name"=>"id", "description"=>"ID that needs to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id"]}, "put"=>{"summary"=>"Update A Site", "description"=>"Update a site", "operationId"=>"sites.id.put", "x-api-path-slug"=>"sitesid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON object Site", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of the website that needs to be update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id"]}}, "/sites/{id}/audits"=>{"get"=>{"summary"=>"Return Audits For A Specific Website", "description"=>"Return audits for a specific website", "operationId"=>"getSiteAudits", "x-api-path-slug"=>"sitesidaudits-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Fields to return separate by comas: name,id"}, {"in"=>"path", "name"=>"id", "description"=>"ID of the website"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of object to return (max 100, default 25)"}, {"in"=>"query", "name"=>"limitstart", "description"=>"Start of the return (default 0)"}, {"in"=>"query", "name"=>"order", "description"=>"ORDER by this field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Audits"]}, "post"=>{"summary"=>"Create An Audit For The Site", "description"=>"Create an audit for the site", "operationId"=>"createAudits", "x-api-path-slug"=>"sitesidaudits-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Audits"]}}, "/sites/{id}/backupnow"=>{"post"=>{"summary"=>"Add The Site To The Backup Queue", "description"=>"Add the site to the backup queue", "operationId"=>"addSiteToBackupQueue", "x-api-path-slug"=>"sitesidbackupnow-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Backupnow"]}}, "/sites/{id}/backupprofiles"=>{"get"=>{"summary"=>"Return Backup Profile", "description"=>"Return backup profile", "operationId"=>"getBackupProfiles", "x-api-path-slug"=>"sitesidbackupprofiles-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Backupprofiles"]}}, "/sites/{id}/backups"=>{"get"=>{"summary"=>"List Of Latest Backups", "description"=>"List of latest backups", "operationId"=>"getListBackups", "x-api-path-slug"=>"sitesidbackups-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Backups"]}}, "/sites/{id}/backupstart"=>{"post"=>{"summary"=>"Start A Remote Backup For The Site", "description"=>"Start a remote backup for the site", "operationId"=>"startSiteBackup", "x-api-path-slug"=>"sitesidbackupstart-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Backupstart"]}}, "/sites/{id}/backupstep"=>{"post"=>{"summary"=>"Step (continue) A Remote Backup For The Site", "description"=>"Step (continue) a remote backup for the site", "operationId"=>"stepSiteBackup", "x-api-path-slug"=>"sitesidbackupstep-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Backupstep"]}}, "/sites/{id}/extensions"=>{"get"=>{"summary"=>"Get Extensions For A Site", "description"=>"Get extensions for a site", "operationId"=>"sites.id.extensions.get", "x-api-path-slug"=>"sitesidextensions-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Fields to return separate by comas: name,id"}, {"in"=>"path", "name"=>"id", "description"=>"ID of the website"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of object to return (max 100, default 25)"}, {"in"=>"query", "name"=>"limitstart", "description"=>"Start of the return (default 0)"}, {"in"=>"query", "name"=>"order", "description"=>"ORDER by this field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Extensions"]}, "post"=>{"summary"=>"Install Extension", "description"=>"", "operationId"=>"installExtension", "x-api-path-slug"=>"sitesidextensions-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the website"}, {"in"=>"query", "name"=>"url", "description"=>"URL to install the extension from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Extensions"]}}, "/sites/{id}/logs"=>{"get"=>{"summary"=>"Return Logs For A Specific Website", "description"=>"Return logs for a specific website", "operationId"=>"sites.id.logs.get", "x-api-path-slug"=>"sitesidlogs-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Fields to return separate by comas: name,id"}, {"in"=>"query", "name"=>"from", "description"=>"Logs after this date, format YYYY-MM-DD HH:MM:SS"}, {"in"=>"path", "name"=>"id", "description"=>"ID of the website"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of object to return (max 100, default 25)"}, {"in"=>"query", "name"=>"limitstart", "description"=>"Start of the return (default 0)"}, {"in"=>"query", "name"=>"log_entry", "description"=>"Do a LIKE search, you can also use %"}, {"in"=>"query", "name"=>"log_type", "description"=>"Type of the log"}, {"in"=>"query", "name"=>"order", "description"=>"ORDER by this field separete by comas"}, {"in"=>"query", "name"=>"to", "description"=>"Logs before this date, format YYYY-MM-DD HH:MM:SS"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Logs"]}, "post"=>{"summary"=>"Create A Custom Log For A Specific Website", "description"=>"Create a custom log for a specific website", "operationId"=>"CreateLog", "x-api-path-slug"=>"sitesidlogs-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON object Log (only type custom)", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of the website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Logs"]}}, "/sites/{id}/monitor"=>{"delete"=>{"summary"=>"Delete Uptime Monitor", "description"=>"Return boolean", "operationId"=>"deleteMonitor", "x-api-path-slug"=>"sitesidmonitor-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Monitor"]}, "post"=>{"summary"=>"Post Uptime Monitor", "description"=>"Return boolean", "operationId"=>"postMonitor", "x-api-path-slug"=>"sitesidmonitor-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Monitor"]}}, "/sites/{id}/scanner"=>{"get"=>{"summary"=>"Scan The Site For Malware", "description"=>"Scan the site for malware", "operationId"=>"scanner", "x-api-path-slug"=>"sitesidscanner-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Scanner"]}}, "/sites/{id}/seo"=>{"get"=>{"summary"=>"SEO Analyze For A Page", "description"=>"SEO analyze for a page", "operationId"=>"seoAnalyze", "x-api-path-slug"=>"sitesidseo-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Seo"]}}, "/sites/{id}/tags"=>{"get"=>{"summary"=>"Return Tags For A Specific Website", "description"=>"Return tags for a specific website", "operationId"=>"sites.id.tags.get", "x-api-path-slug"=>"sitesidtags-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Fields to return separate by comas: name,id"}, {"in"=>"path", "name"=>"id", "description"=>"ID of the website"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of object to return (max 100, default 25)"}, {"in"=>"query", "name"=>"limitstart", "description"=>"Start of the return (default 0)"}, {"in"=>"query", "name"=>"name", "description"=>"Do a LIKE search, you can also use %"}, {"in"=>"query", "name"=>"order", "description"=>"ORDER by this field"}, {"in"=>"query", "name"=>"type", "description"=>"Bootstrap color of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Tags"]}, "post"=>{"summary"=>"Add Tags For A Specific Website", "description"=>"Add tags for a specific website", "operationId"=>"postTags", "x-api-path-slug"=>"sitesidtags-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON object Tag", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of the website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Tags"]}}, "/sites/{id}/updatejoomla"=>{"post"=>{"summary"=>"Update Joomla Core On The Remote Site", "description"=>"Update Joomla core on the remote site", "operationId"=>"updateJoomla", "x-api-path-slug"=>"sitesidupdatejoomla-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Updatejoomla"]}}, "/sites/{id}/uptime"=>{"get"=>{"summary"=>"Return Uptime Data", "description"=>"Return uptime data", "operationId"=>"getUptime", "x-api-path-slug"=>"sitesiduptime-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Uptime"]}}, "/sites/{id}/validate"=>{"get"=>{"summary"=>"Validate The Site, Return The New Logs", "description"=>"validate the site", "operationId"=>"validateSite", "x-api-path-slug"=>"sitesidvalidate-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Validate"]}}, "/sites/{id}/validatedebug"=>{"get"=>{"summary"=>"Validate The Site, Return The Debug Information", "description"=>"", "operationId"=>"validateDebugSite", "x-api-path-slug"=>"sitesidvalidatedebug-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites", "Id", "Validatedebug"]}}, "/ssousers"=>{"get"=>{"summary"=>"Get A List Of SSO Users", "description"=>"Returns a list of SSO Users", "operationId"=>"getSsoUsers", "x-api-path-slug"=>"ssousers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ssousers"]}, "post"=>{"summary"=>"Create A SSO User", "description"=>"Create a SSO User", "operationId"=>"CreateSsoUsers", "x-api-path-slug"=>"ssousers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON object SsoUsers", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ssousers"]}}, "/ssousers/{id}"=>{"delete"=>{"summary"=>"Delete A Specific SSO User", "description"=>"Delete a specific SSO User", "operationId"=>"deleteSsoUserById", "x-api-path-slug"=>"ssousersid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of SSO User that needs to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ssousers", "Id"]}, "get"=>{"summary"=>"Find SSO User By ID", "description"=>"Returns a SSO User based on ID", "operationId"=>"getSsoUsersById", "x-api-path-slug"=>"ssousersid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Fields to return separate by comas: name,id"}, {"in"=>"path", "name"=>"id", "description"=>"ID of SSO User that needs to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ssousers", "Id"]}, "put"=>{"summary"=>"Update A SSO User", "description"=>"Update a SSO User", "operationId"=>"UpdateSsoUsers", "x-api-path-slug"=>"ssousersid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON object SsoUsers", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of SSO User that needs to be updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ssousers", "Id"]}}, "/tags"=>{"get"=>{"summary"=>"Get A List Of Tags", "description"=>"Returns a list of tags", "operationId"=>"tags.get", "x-api-path-slug"=>"tags-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Fields to return separate by comas: name,id"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of object to return (max 100, default 25)"}, {"in"=>"query", "name"=>"limitstart", "description"=>"Start of the return (default 0)"}, {"in"=>"query", "name"=>"name", "description"=>"Do a LIKE search, you can also use %"}, {"in"=>"query", "name"=>"order", "description"=>"ORDER by this field separete by comas"}, {"in"=>"query", "name"=>"type", "description"=>"Bootstrap color of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}, "post"=>{"summary"=>"Create A Tag", "description"=>"Create a tag", "operationId"=>"CreateTags", "x-api-path-slug"=>"tags-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON object Tag", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/tags/metadata"=>{"get"=>{"summary"=>"Get The List Of Fields", "description"=>"Returns a list of fields", "operationId"=>"tags.metadata.get", "x-api-path-slug"=>"tagsmetadata-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Metadata"]}}, "/tags/{id}"=>{"delete"=>{"summary"=>"Delete A Specific Tag", "description"=>"Delete a specific tag", "operationId"=>"tags.id.delete", "x-api-path-slug"=>"tagsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of tag that needs to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Id"]}, "get"=>{"summary"=>"Find Tag By ID", "description"=>"Returns a tag based on ID", "operationId"=>"getTagById", "x-api-path-slug"=>"tagsid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Fields to return separate by comas: name,id"}, {"in"=>"path", "name"=>"id", "description"=>"ID of tag that needs to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Id"]}, "put"=>{"summary"=>"Update A Tag", "description"=>"Update a tag", "operationId"=>"UpdateTag", "x-api-path-slug"=>"tagsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON object of the updated tag", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Id"]}}, "/tags/{id}/sites"=>{"get"=>{"summary"=>"Find Sites By Tag ID", "description"=>"Returns a list of sites based with a specific tag id", "operationId"=>"getSitesByTags", "x-api-path-slug"=>"tagsidsites-get", "parameters"=>[{"in"=>"query", "name"=>"access_url", "description"=>"Do a LIKE search, you can also use %"}, {"in"=>"query", "name"=>"error", "description"=>"have errors"}, {"in"=>"query", "name"=>"fields", "description"=>"Fields to return separate by comas: name,id"}, {"in"=>"path", "name"=>"id", "description"=>"ID of tag that needs to be fetched"}, {"in"=>"query", "name"=>"ip", "description"=>"Do a LIKE search, you can also use %"}, {"in"=>"query", "name"=>"jUpdate", "description"=>"Joomla core update"}, {"in"=>"query", "name"=>"j_version", "description"=>"Do a LIKE search, you can also use %"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of object to return (max 100, default 25)"}, {"in"=>"query", "name"=>"limitstart", "description"=>"Start of the return (default 0)"}, {"in"=>"query", "name"=>"name", "description"=>"Do a LIKE search, you can also use %"}, {"in"=>"query", "name"=>"nbUpdates"}, {"in"=>"query", "name"=>"order", "description"=>"ORDER by this field separete by comas"}, {"in"=>"query", "name"=>"published", "description"=>"is published"}, {"in"=>"query", "name"=>"up", "description"=>"is the website online"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Id", "Sites"]}}, "/versions"=>{"get"=>{"summary"=>"Get List Of Versions", "description"=>"", "operationId"=>"getVersions", "x-api-path-slug"=>"versions-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Fields to return separate by comas: name,id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Versions"]}}, "/versions/{id}"=>{"get"=>{"summary"=>"Find A Version By ID", "description"=>"", "operationId"=>"getVersion", "x-api-path-slug"=>"versionsid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Fields to return separate by commas: name,id"}, {"in"=>"path", "name"=>"id", "description"=>"ID of version that needs to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Versions", "Id"]}}}}, "apis"=>{"name"=>"Watchful", "x-slug"=>"watchful", "description"=>"Watchful resulted from the need for a single, unified dashboard to easily monitor all of the web sites in our portfolios. After years of evolution, our solution has matured into a simple, complete and professional service.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/watchful-li-logo.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"Monitoring,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"watchful/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Watchful", "x-api-slug"=>"watchful", "description"=>"Watchful resulted from the need for a single, unified dashboard to easily monitor all of the web sites in our portfolios. After years of evolution, our solution has matured into a simple, complete and professional service.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/watchful-li-logo.jpg", "humanURL"=>"http://watchful.li", "baseURL"=>"https://watchful.li//api/v1", "tags"=>"Monitoring,Relative Data,Service API", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/watchful/watchful-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-application-gallery", "url"=>"https://watchful.li/apps/"}, {"type"=>"x-blog", "url"=>"https://watchful.li/news/"}, {"type"=>"x-blog-rss", "url"=>"https://watchful.li/news/feed/rss.html"}, {"type"=>"x-developer", "url"=>"https://watchful.li/support-services/kb/article/watchful-rest-api"}, {"type"=>"x-facebook", "url"=>"https://www.facebook.com/watchfulli"}, {"type"=>"x-faq", "url"=>"https://watchful.li/support-services/faq.html"}, {"type"=>"x-google-plus", "url"=>"https://plus.google.com/+WatchfulLi"}, {"type"=>"x-knowledgebase", "url"=>"https://watchful.li/support-services/kb.html"}, {"type"=>"x-pricing", "url"=>"https://watchful.li/pricing"}, {"type"=>"x-privacy", "url"=>"https://watchful.li/privacy-policy.html"}, {"type"=>"x-terms-of-service", "url"=>"https://watchful.li/terms-of-service.html"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/watchfulli"}, {"type"=>"x-website", "url"=>"http://watchful.li"}, {"type"=>"x-website", "url"=>"https://watchful.li/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
lykke{"lykke-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Lykke", "x-complete"=>1, "info"=>{"title"=>"Wallet_Api", "version"=>"1.0.0"}, "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/AccountExist"=>{"get"=>{"summary"=>"Get API Account Exist", "description"=>"Get api account exist.", "operationId"=>"ApiAccountExistGet", "x-api-path-slug"=>"apiaccountexist-get", "parameters"=>[{"in"=>"query", "name"=>"email"}, {"in"=>"query", "name"=>"partnerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Exist"]}}, "/api/AllAssetDescription/{id}"=>{"get"=>{"summary"=>"Get API All Asset Description", "description"=>"Get api all asset description.", "operationId"=>"ApiAllAssetDescriptionByIdGet", "x-api-path-slug"=>"apiallassetdescriptionid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Description"]}}, "/api/AllAssetPairRates"=>{"get"=>{"summary"=>"Get API All Asset Pair Rates", "description"=>"Get api all asset pair rates.", "operationId"=>"ApiAllAssetPairRatesGet", "x-api-path-slug"=>"apiallassetpairrates-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Pair", "Rates"]}}, "/api/AllAssetPairRates/{id}"=>{"get"=>{"summary"=>"Get API All Asset Pair Rates", "description"=>"Get api all asset pair rates.", "operationId"=>"ApiAllAssetPairRatesByIdGet", "x-api-path-slug"=>"apiallassetpairratesid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Pair", "Rates"]}}, "/api/AllAssetPairs"=>{"get"=>{"summary"=>"Get API All Asset Pairs", "description"=>"Get api all asset pairs.", "operationId"=>"ApiAllAssetPairsGet", "x-api-path-slug"=>"apiallassetpairs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Pairs"]}}, "/api/AllAssetPairs/{id}"=>{"get"=>{"summary"=>"Get API All Asset Pairs", "description"=>"Get api all asset pairs.", "operationId"=>"ApiAllAssetPairsByIdGet", "x-api-path-slug"=>"apiallassetpairsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Pairs"]}}, "/api/ApplicationInfo"=>{"get"=>{"summary"=>"Get API Application Information", "description"=>"Get api application information.", "operationId"=>"ApiApplicationInfoGet", "x-api-path-slug"=>"apiapplicationinfo-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Information"]}}, "/api/AppSettings"=>{"get"=>{"summary"=>"Get API Application Settings", "description"=>"Get api application settings.", "operationId"=>"ApiAppSettingsGet", "x-api-path-slug"=>"apiappsettings-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Settings"]}}, "/api/assetcategories"=>{"get"=>{"summary"=>"Get API Asset Categories", "description"=>"Get api asset categories.", "operationId"=>"ApiAssetcategoriesGet", "x-api-path-slug"=>"apiassetcategories-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Categories"]}}, "/api/AssetDescription/{id}"=>{"get"=>{"summary"=>"Get API Assetdescription", "description"=>"Get api assetdescription.", "operationId"=>"ApiAssetDescriptionByIdGet", "x-api-path-slug"=>"apiassetdescriptionid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assetdescription"]}}, "/api/AssetDisclaimers"=>{"get"=>{"summary"=>"Get API Asset Dsclaimers", "description"=>"Get api asset dsclaimers.", "operationId"=>"AssetDisclaimersGet", "x-api-path-slug"=>"apiassetdisclaimers-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Dsclaimers"]}}, "/api/AssetDisclaimers/{disclaimerId}/approve"=>{"post"=>{"summary"=>"Add API Asset Dsclaimers Disclaimer Approve", "description"=>"Add api asset dsclaimers disclaimer approve.", "operationId"=>"AssetDisclaimersApprove", "x-api-path-slug"=>"apiassetdisclaimersdisclaimeridapprove-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"disclaimerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Dsclaimers", "Disclaimer", "Approve"]}}, "/api/AssetDisclaimers/{disclaimerId}/decline"=>{"post"=>{"summary"=>"Add API Asset Dsclaimers Disclaimer Decline", "description"=>"Add api asset dsclaimers disclaimer decline.", "operationId"=>"AssetDisclaimersDecline", "x-api-path-slug"=>"apiassetdisclaimersdisclaimeriddecline-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"disclaimerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Dsclaimers", "Disclaimer", "Decline"]}}, "/api/AssetPair/{id}"=>{"get"=>{"summary"=>"Get API Assetpair", "description"=>"Get api assetpair.", "operationId"=>"ApiAssetPairByIdGet", "x-api-path-slug"=>"apiassetpairid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assetpair"]}}, "/api/AssetPairDetailedRates"=>{"get"=>{"summary"=>"Get API Assetpairdetailedrates", "description"=>"Get api assetpairdetailedrates.", "operationId"=>"ApiAssetPairDetailedRatesGet", "x-api-path-slug"=>"apiassetpairdetailedrates-get", "parameters"=>[{"in"=>"query", "name"=>"assetId"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"period"}, {"in"=>"query", "name"=>"points"}, {"in"=>"query", "name"=>"withBid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assetpairdetailedrates"]}}, "/api/AssetPairRates"=>{"get"=>{"summary"=>"Get API Assetpairrates", "description"=>"Get api assetpairrates.", "operationId"=>"ApiAssetPairRatesGet", "x-api-path-slug"=>"apiassetpairrates-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"ignoreBase"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assetpairrates"]}}, "/api/AssetPairRates/{id}"=>{"get"=>{"summary"=>"Get API Assetpairrates", "description"=>"Get api assetpairrates.", "operationId"=>"ApiAssetPairRatesByIdGet", "x-api-path-slug"=>"apiassetpairratesid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assetpairrates"]}}, "/api/AssetPairs"=>{"get"=>{"summary"=>"Get API Assetpairs", "description"=>"Get api assetpairs.", "operationId"=>"ApiAssetPairsGet", "x-api-path-slug"=>"apiassetpairs-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assetpairs"]}}, "/api/Assets"=>{"get"=>{"summary"=>"Get API Assets", "description"=>"Get api assets.", "operationId"=>"ApiAssetsGet", "x-api-path-slug"=>"apiassets-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assets"]}}, "/api/Assets/{id}"=>{"get"=>{"summary"=>"Get API Assets", "description"=>"Get api assets.", "operationId"=>"ApiAssetsByIdGet", "x-api-path-slug"=>"apiassetsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assets"]}}, "/api/Assets/description/list"=>{"post"=>{"summary"=>"Add API Assets Description List", "description"=>"Add api assets description list.", "operationId"=>"ApiAssetsDescriptionListPost", "x-api-path-slug"=>"apiassetsdescriptionlist-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assets", "Description", "List"]}}, "/api/Assets/{assetId}/attributes"=>{"get"=>{"summary"=>"Get API Assets Asset Attributes", "description"=>"Get api assets asset attributes.", "operationId"=>"ApiAssetsByAssetIdAttributesGet", "x-api-path-slug"=>"apiassetsassetidattributes-get", "parameters"=>[{"in"=>"path", "name"=>"assetId"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assets", "Asset", "Attributes"]}}, "/api/Assets/{assetId}/attributes/{key}"=>{"get"=>{"summary"=>"Get API Assets Asset Attributes Key", "description"=>"Get api assets asset attributes key.", "operationId"=>"ApiAssetsByAssetIdAttributesByKeyGet", "x-api-path-slug"=>"apiassetsassetidattributeskey-get", "parameters"=>[{"in"=>"path", "name"=>"assetId"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assets", "Asset", "Attributes", "Key"]}}, "/api/Auth"=>{"post"=>{"summary"=>"Add API Auth", "description"=>"Add api auth.", "operationId"=>"ApiAuthPost", "x-api-path-slug"=>"apiauth-post", "parameters"=>[{"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auth"]}}, "/api/Auth/LogOut"=>{"post"=>{"summary"=>"Add API Auth Logout", "description"=>"Add api auth logout.", "operationId"=>"ApiAuthLogOutPost", "x-api-path-slug"=>"apiauthlogout-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auth", "Logout"]}}, "/api/BackupCompleted"=>{"post"=>{"summary"=>"Add API Backup Completed", "description"=>"Add api backup completed.", "operationId"=>"ApiBackupCompletedPost", "x-api-path-slug"=>"apibackupcompleted-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backup", "Completed"]}}, "/api/BankCardPaymentUrl"=>{"post"=>{"summary"=>"Add API Bankcardpaymenturl", "description"=>"Add api bankcardpaymenturl.", "operationId"=>"ApiBankCardPaymentUrlPost", "x-api-path-slug"=>"apibankcardpaymenturl-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"input", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bankcardpaymenturl"]}}, "/api/BankCardPaymentUrlFormValues"=>{"get"=>{"summary"=>"Get API Bankcardpaymenturlformvalues", "description"=>"Get api bankcardpaymenturlformvalues.", "operationId"=>"ApiBankCardPaymentUrlFormValuesGet", "x-api-path-slug"=>"apibankcardpaymenturlformvalues-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bankcardpaymenturlformvalues"]}}, "/api/BankTransferRequest"=>{"post"=>{"summary"=>"Add API Banktransferrequest", "description"=>"Add api banktransferrequest.", "operationId"=>"ApiBankTransferRequestPost", "x-api-path-slug"=>"apibanktransferrequest-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"transferReq", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banktransferrequest"]}}, "/api/BaseAsset"=>{"get"=>{"summary"=>"Get API Baseasset", "description"=>"Get api baseasset.", "operationId"=>"ApiBaseAssetGet", "x-api-path-slug"=>"apibaseasset-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Baseasset"]}, "post"=>{"summary"=>"Add API Baseasset", "description"=>"Add api baseasset.", "operationId"=>"ApiBaseAssetPost", "x-api-path-slug"=>"apibaseasset-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Baseasset"]}}, "/api/BaseAssets"=>{"get"=>{"summary"=>"Get API Baseassets", "description"=>"Get api baseassets.", "operationId"=>"ApiBaseAssetsGet", "x-api-path-slug"=>"apibaseassets-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Baseassets"]}}, "/api/BcnTransaction"=>{"get"=>{"summary"=>"Get API Bcntransaction", "description"=>"Get api bcntransaction.", "operationId"=>"ApiBcnTransactionGet", "x-api-path-slug"=>"apibcntransaction-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bcntransaction"]}}, "/api/BcnTransaction/offchain-trade"=>{"get"=>{"summary"=>"Get API Bcntransaction Offchain Trade", "description"=>"Get api bcntransaction offchain trade.", "operationId"=>"ApiBcnTransactionOffchain-tradeGet", "x-api-path-slug"=>"apibcntransactionoffchaintrade-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bcntransaction", "Offchain", "Trade"]}}, "/api/BcnTransactionByCashOperation/{id}"=>{"get"=>{"summary"=>"Get API Bcntransactionbycashoperation", "description"=>"Get api bcntransactionbycashoperation.", "operationId"=>"ApiBcnTransactionByCashOperationByIdGet", "x-api-path-slug"=>"apibcntransactionbycashoperationid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bcntransactionbycashoperation"]}}, "/api/BcnTransactionByExchange/{id}"=>{"get"=>{"summary"=>"Get API Bcntransactionbyexchange", "description"=>"Get api bcntransactionbyexchange.", "operationId"=>"ApiBcnTransactionByExchangeByIdGet", "x-api-path-slug"=>"apibcntransactionbyexchangeid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bcntransactionbyexchange"]}}, "/api/BcnTransactionByTransfer/{id}"=>{"get"=>{"summary"=>"Get API Bcntransactionbytransfer", "description"=>"Get api bcntransactionbytransfer.", "operationId"=>"ApiBcnTransactionByTransferByIdGet", "x-api-path-slug"=>"apibcntransactionbytransferid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bcntransactionbytransfer"]}}, "/api/BitcoinCash/multisig/balance"=>{"get"=>{"summary"=>"Get API Bitcoincash Multisig Balance", "description"=>"Get api bitcoincash multisig balance.", "operationId"=>"ApiBitcoinCashMultisigBalanceGet", "x-api-path-slug"=>"apibitcoincashmultisigbalance-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bitcoincash", "Multisig", "Balance"]}}, "/api/BitcoinCash/multisig/transaction"=>{"get"=>{"summary"=>"Get API Bitcoincash Multisig Transaction", "description"=>"Get api bitcoincash multisig transaction.", "operationId"=>"ApiBitcoinCashMultisigTransactionGet", "x-api-path-slug"=>"apibitcoincashmultisigtransaction-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"destinationAddress"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bitcoincash", "Multisig", "Transaction"]}}, "/api/BitcoinCash/private/balance"=>{"get"=>{"summary"=>"Get API Bitcoincash Private Balance", "description"=>"Get api bitcoincash private balance.", "operationId"=>"ApiBitcoinCashPrivateBalanceGet", "x-api-path-slug"=>"apibitcoincashprivatebalance-get", "parameters"=>[{"in"=>"query", "name"=>"address"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bitcoincash", "Private", "Balance"]}}, "/api/BitcoinCash/private/transaction"=>{"get"=>{"summary"=>"Get API Bitcoincash Private Transaction", "description"=>"Get api bitcoincash private transaction.", "operationId"=>"ApiBitcoinCashPrivateTransactionGet", "x-api-path-slug"=>"apibitcoincashprivatetransaction-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"destinationAddress"}, {"in"=>"query", "name"=>"fee"}, {"in"=>"query", "name"=>"sourceAddress"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bitcoincash", "Private", "Transaction"]}}, "/api/BitcoinCash/broadcast"=>{"post"=>{"summary"=>"Add API Bitcoincash Broadcast", "description"=>"Add api bitcoincash broadcast.", "operationId"=>"ApiBitcoinCashBroadcastPost", "x-api-path-slug"=>"apibitcoincashbroadcast-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bitcoincash", "Broadcast"]}}, "/api/BlockchainTransaction"=>{"get"=>{"summary"=>"Get API Blockchaintransaction", "description"=>"Get api blockchaintransaction.", "operationId"=>"ApiBlockchainTransactionGet", "x-api-path-slug"=>"apiblockchaintransaction-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"blockChainHash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchaintransaction"]}}, "/api/BroadcastTransaction"=>{"post"=>{"summary"=>"Add API Broadcasttransaction", "description"=>"Add api broadcasttransaction.", "operationId"=>"ApiBroadcastTransactionPost", "x-api-path-slug"=>"apibroadcasttransaction-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"transaction", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Broadcasttransaction"]}}, "/api/CashOut"=>{"post"=>{"summary"=>"Add API Cashout", "description"=>"Add api cashout.", "operationId"=>"ApiCashOutPost", "x-api-path-slug"=>"apicashout-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cashout"]}}, "/api/CashOutSwiftRequest"=>{"post"=>{"summary"=>"Add API Cashout Swift Request", "description"=>"Add api cashout swift request.", "operationId"=>"ApiCashOutSwiftRequestPost", "x-api-path-slug"=>"apicashoutswiftrequest-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cashout", "Swift", "Request"]}}, "/api/ChangePinAndPassword"=>{"post"=>{"summary"=>"Add API Changepinandpassword", "description"=>"Add api changepinandpassword.", "operationId"=>"ApiChangePinAndPasswordPost", "x-api-path-slug"=>"apichangepinandpassword-post", "parameters"=>[{"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Changepinandpassword"]}}, "/api/CheckDocumentsToUpload"=>{"get"=>{"summary"=>"Get API Checkdocumentstoupload", "description"=>"Get api checkdocumentstoupload.", "operationId"=>"ApiCheckDocumentsToUploadGet", "x-api-path-slug"=>"apicheckdocumentstoupload-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkdocumentstoupload"]}}, "/api/CheckMobilePhone"=>{"get"=>{"summary"=>"Get API Checkmobilephone", "description"=>"Get api checkmobilephone.", "operationId"=>"ApiCheckMobilePhoneGet", "x-api-path-slug"=>"apicheckmobilephone-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"code"}, {"in"=>"query", "name"=>"phoneNumber"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkmobilephone"]}, "post"=>{"summary"=>"Add API Checkmobilephone", "description"=>"Add api checkmobilephone.", "operationId"=>"ApiCheckMobilePhonePost", "x-api-path-slug"=>"apicheckmobilephone-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"phoneModel", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkmobilephone"]}}, "/api/Client/codes"=>{"get"=>{"summary"=>"Get API Client Codes", "description"=>"Get api client codes.", "operationId"=>"ApiClientCodesGet", "x-api-path-slug"=>"apiclientcodes-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Client", "Codes"]}, "post"=>{"summary"=>"Add API Client Codes", "description"=>"Add api client codes.", "operationId"=>"ApiClientCodesPost", "x-api-path-slug"=>"apiclientcodes-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Client", "Codes"]}}, "/api/Client/keys/encodedmainkey"=>{"post"=>{"summary"=>"Add API Client Keys Encodedmainkey", "description"=>"Add api client keys encodedmainkey.", "operationId"=>"ApiClientKeysEncodedmainkeyPost", "x-api-path-slug"=>"apiclientkeysencodedmainkey-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Client", "Keys", "Encodedmainkey"]}}, "/api/Client/balances/{baseAsset}"=>{"get"=>{"summary"=>"Get API Client Balances Baseasset", "description"=>"Get api client balances baseasset.", "operationId"=>"ApiClientBalancesByBaseAssetGet", "x-api-path-slug"=>"apiclientbalancesbaseasset-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"baseAsset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Client", "Balances", "Baseasset"]}}, "/api/Client/pushTxDialogOk"=>{"post"=>{"summary"=>"Add API Client Pushtxdialogok", "description"=>"Add api client pushtxdialogok.", "operationId"=>"ApiClientPushTxDialogOkPost", "x-api-path-slug"=>"apiclientpushtxdialogok-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Client", "Pushtxdialogok"]}}, "/api/Client/dictionary/{key}"=>{"get"=>{"summary"=>"Get API Client Dictionary Key", "description"=>"Get api client dictionary key.", "operationId"=>"ApiClientDictionaryByKeyGet", "x-api-path-slug"=>"apiclientdictionarykey-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Client", "Dictionary", "Key"]}, "delete"=>{"summary"=>"Delete API Client Dictionary Key", "description"=>"Delete api client dictionary key.", "operationId"=>"ApiClientDictionaryByKeyDelete", "x-api-path-slug"=>"apiclientdictionarykey-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Client", "Dictionary", "Key"]}}, "/api/Client/dictionary"=>{"put"=>{"summary"=>"Put API Client Dictionary", "description"=>"Put api client dictionary.", "operationId"=>"ApiClientDictionaryPut", "x-api-path-slug"=>"apiclientdictionary-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"keyValue", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Client", "Dictionary"]}, "post"=>{"summary"=>"Add API Client Dictionary", "description"=>"Add api client dictionary.", "operationId"=>"ApiClientDictionaryPost", "x-api-path-slug"=>"apiclientdictionary-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"keyValue", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Client", "Dictionary"]}}, "/api/Client/properties/isUserFromUS"=>{"get"=>{"summary"=>"Get API Client Properties Isuserfromus", "description"=>"Get api client properties isuserfromus.", "operationId"=>"ApiClientPropertiesIsUserFromUSGet", "x-api-path-slug"=>"apiclientpropertiesisuserfromus-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Client", "Properties", "Isuserfromus"]}, "post"=>{"summary"=>"Add API Client Properties Isuserfromus", "description"=>"Add api client properties isuserfromus.", "operationId"=>"ApiClientPropertiesIsUserFromUSPost", "x-api-path-slug"=>"apiclientpropertiesisuserfromus-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Client", "Properties", "Isuserfromus"]}}, "/api/Client/pendingActions"=>{"get"=>{"summary"=>"Get API Client Pendingactions", "description"=>"Get api client pendingactions.", "operationId"=>"ApiClientPendingActionsGet", "x-api-path-slug"=>"apiclientpendingactions-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Client", "Pendingactions"]}}, "/api/ClientFirstNameLastName"=>{"post"=>{"summary"=>"Add API Clientfirstnamelastname", "description"=>"Add api clientfirstnamelastname.", "operationId"=>"ApiClientFirstNameLastNamePost", "x-api-path-slug"=>"apiclientfirstnamelastname-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clientfirstnamelastname"]}}, "/api/ClientFullName"=>{"post"=>{"summary"=>"Add API Clientfullname", "description"=>"Add api clientfullname.", "operationId"=>"ApiClientFullNamePost", "x-api-path-slug"=>"apiclientfullname-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"fullNameModel", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clientfullname"]}}, "/api/ClientKeys"=>{"post"=>{"summary"=>"Add API Clientkeys", "description"=>"Add api clientkeys.", "operationId"=>"ApiClientKeysPost", "x-api-path-slug"=>"apiclientkeys-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clientkeys"]}}, "/api/ClientLog"=>{"post"=>{"summary"=>"Add API Clientlog", "description"=>"Add api clientlog.", "operationId"=>"ApiClientLogPost", "x-api-path-slug"=>"apiclientlog-post", "parameters"=>[{"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clientlog"]}}, "/api/ClientPhone"=>{"post"=>{"summary"=>"Add API Clientphone", "description"=>"Add api clientphone.", "operationId"=>"ApiClientPhonePost", "x-api-path-slug"=>"apiclientphone-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"phoneModel", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clientphone"]}}, "/api/ClientState"=>{"get"=>{"summary"=>"Get API Clientstate", "description"=>"Get api clientstate.", "operationId"=>"ApiClientStateGet", "x-api-path-slug"=>"apiclientstate-get", "parameters"=>[{"in"=>"query", "name"=>"email"}, {"in"=>"query", "name"=>"partnerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clientstate"]}}, "/api/ClientTrading/termsOfUse"=>{"get"=>{"summary"=>"Get API Clienttrading Termsofuse", "description"=>"Get api clienttrading termsofuse.", "operationId"=>"ApiClientTradingTermsOfUseGet", "x-api-path-slug"=>"apiclienttradingtermsofuse-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clienttrading", "Termsofuse"]}}, "/api/ClientTrading/termsOfUse/margin/agree"=>{"post"=>{"summary"=>"Add API Clienttrading Termsofuse Margin Agree", "description"=>"Add api clienttrading termsofuse margin agree.", "operationId"=>"ApiClientTradingTermsOfUseMarginAgreePost", "x-api-path-slug"=>"apiclienttradingtermsofusemarginagree-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clienttrading", "Termsofuse", "Margin", "Agree"]}}, "/api/CountryPhoneCodes"=>{"get"=>{"summary"=>"Get API Countryphonecodes", "description"=>"Get api countryphonecodes.", "operationId"=>"ApiCountryPhoneCodesGet", "x-api-path-slug"=>"apicountryphonecodes-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countryphonecodes"]}}, "/api/client/Dialogs"=>{"get"=>{"summary"=>"Get API Client Dialogs", "description"=>"Get api client dialogs.", "operationId"=>"ApiClientDialogsGet", "x-api-path-slug"=>"apiclientdialogs-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Client", "Dialogs"]}, "post"=>{"summary"=>"Add API Client Dialogs", "description"=>"Add api client dialogs.", "operationId"=>"ApiClientDialogsPost", "x-api-path-slug"=>"apiclientdialogs-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Client", "Dialogs"]}}, "/api/Dictionary/{key}"=>{"get"=>{"summary"=>"Get API Dictionary Key", "description"=>"Get api dictionary key.", "operationId"=>"ApiDictionaryByKeyGet", "x-api-path-slug"=>"apidictionarykey-get", "parameters"=>[{"in"=>"path", "name"=>"key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dictionary", "Key"]}}, "/api/Dictionary"=>{"get"=>{"summary"=>"Get API Dictionary", "description"=>"Get api dictionary.", "operationId"=>"ApiDictionaryGet", "x-api-path-slug"=>"apidictionary-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dictionary"]}}, "/api/Dicts"=>{"get"=>{"summary"=>"Get API Dicts", "description"=>"Get api dicts.", "operationId"=>"ApiDictsGet", "x-api-path-slug"=>"apidicts-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dicts"]}}, "/api/Dicts/assets"=>{"get"=>{"summary"=>"Get API Dicts Assets", "description"=>"Get api dicts assets.", "operationId"=>"ApiDictsAssetsGet", "x-api-path-slug"=>"apidictsassets-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dicts", "Assets"]}}, "/api/Dicts/updates"=>{"get"=>{"summary"=>"Get API Dicts Updates", "description"=>"Get api dicts updates.", "operationId"=>"ApiDictsUpdatesGet", "x-api-path-slug"=>"apidictsupdates-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dicts", "S"]}}, "/api/Email/PrivateWalletAddress"=>{"post"=>{"summary"=>"Add API Email Privatewalletaddress", "description"=>"Add api email privatewalletaddress.", "operationId"=>"ApiEmailPrivateWalletAddressPost", "x-api-path-slug"=>"apiemailprivatewalletaddress-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Privatewalletaddress"]}}, "/api/EmailMeWalletAddress"=>{"post"=>{"summary"=>"Add API Emailmewalletaddress", "description"=>"Add api emailmewalletaddress.", "operationId"=>"ApiEmailMeWalletAddressPost", "x-api-path-slug"=>"apiemailmewalletaddress-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"reqModel", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Emailmewalletaddress"]}}, "/api/EmailVerification"=>{"get"=>{"summary"=>"Get API Emailverification", "description"=>"Get api emailverification.", "operationId"=>"ApiEmailVerificationGet", "x-api-path-slug"=>"apiemailverification-get", "parameters"=>[{"in"=>"query", "name"=>"code"}, {"in"=>"query", "name"=>"email"}, {"in"=>"query", "name"=>"partnerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Emailverification"]}, "post"=>{"summary"=>"Add API Emailverification", "description"=>"Add api emailverification.", "operationId"=>"ApiEmailVerificationPost", "x-api-path-slug"=>"apiemailverification-post", "parameters"=>[{"in"=>"body", "name"=>"email", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Emailverification"]}}, "/api/EncodedPrivateKey"=>{"post"=>{"summary"=>"Add API Encodedprivatekey", "description"=>"Add api encodedprivatekey.", "operationId"=>"ApiEncodedPrivateKeyPost", "x-api-path-slug"=>"apiencodedprivatekey-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Encodedprivatekey"]}}, "/api/Ethereum/{operationId}/transfer"=>{"post"=>{"summary"=>"Add API Ethereum Operation Transfer", "description"=>"Add api ethereum operation transfer.", "operationId"=>"ApiEthereumByOperationIdTransferPost", "x-api-path-slug"=>"apiethereumoperationidtransfer-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"operationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ethereum", "Operation", "Transfer"]}}, "/api/Ethereum/trade"=>{"post"=>{"summary"=>"Add API Ethereum Trade", "description"=>"Add api ethereum trade.", "operationId"=>"ApiEthereumTradePost", "x-api-path-slug"=>"apiethereumtrade-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ethereum", "Trade"]}}, "/api/Ethereum/cashout"=>{"post"=>{"summary"=>"Add API Ethereum Cashout", "description"=>"Add api ethereum cashout.", "operationId"=>"ApiEthereumCashoutPost", "x-api-path-slug"=>"apiethereumcashout-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ethereum", "Cashout"]}}, "/api/Ethereum/{operationId}/hash"=>{"post"=>{"summary"=>"Add API Ethereum Operation Hash", "description"=>"Add api ethereum operation hash.", "operationId"=>"ApiEthereumByOperationIdHashPost", "x-api-path-slug"=>"apiethereumoperationidhash-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"operationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ethereum", "Operation", "Hash"]}}, "/api/Ethereum/transfers"=>{"get"=>{"summary"=>"Get API Ethereum Transfers", "description"=>"Get api ethereum transfers.", "operationId"=>"ApiEthereumTransfersGet", "x-api-path-slug"=>"apiethereumtransfers-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ethereum", "Transfers"]}, "post"=>{"summary"=>"Add API Ethereum Transfers", "description"=>"Add api ethereum transfers.", "operationId"=>"ApiEthereumTransfersPost", "x-api-path-slug"=>"apiethereumtransfers-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"operations", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ethereum", "Transfers"]}}, "/api/Ethereum/hash"=>{"post"=>{"summary"=>"Add API Ethereum Hash", "description"=>"Add api ethereum hash.", "operationId"=>"ApiEthereumHashPost", "x-api-path-slug"=>"apiethereumhash-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ethereum", "Hash"]}}, "/api/Ethereum/privateWallet/generateTransaction"=>{"post"=>{"summary"=>"Add API Ethereum Privatewallet Generatetransaction", "description"=>"Add api ethereum privatewallet generatetransaction.", "operationId"=>"ApiEthereumPrivateWalletGenerateTransactionPost", "x-api-path-slug"=>"apiethereumprivatewalletgeneratetransaction-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ethereum", "Privatewallet", "Generatetransaction"]}}, "/api/Ethereum/privateWallet/broadcastTransaction"=>{"post"=>{"summary"=>"Add API Ethereum Privatewallet Broadcasttransaction", "description"=>"Add api ethereum privatewallet broadcasttransaction.", "operationId"=>"ApiEthereumPrivateWalletBroadcastTransactionPost", "x-api-path-slug"=>"apiethereumprivatewalletbroadcasttransaction-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"transaction", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ethereum", "Privatewallet", "Broadcasttransaction"]}}, "/api/Ethereum/privateWallet/estimateTransaction"=>{"post"=>{"summary"=>"Add API Ethereum Privatewallet Estimatetransaction", "description"=>"Add api ethereum privatewallet estimatetransaction.", "operationId"=>"ApiEthereumPrivateWalletEstimateTransactionPost", "x-api-path-slug"=>"apiethereumprivatewalletestimatetransaction-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"transaction", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ethereum", "Privatewallet", "Estimatetransaction"]}}, "/api/Ethereum/getCurrentNetworkGas"=>{"get"=>{"summary"=>"Get API Ethereum Getcurrentnetworkgas", "description"=>"Get api ethereum getcurrentnetworkgas.", "operationId"=>"ApiEthereumGetCurrentNetworkGasGet", "x-api-path-slug"=>"apiethereumgetcurrentnetworkgas-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ethereum", "Currentnetworkgas"]}}, "/api/Ethereum/tx/{transactionHash}"=>{"get"=>{"summary"=>"Get API Ethereum Tx Transactionhash", "description"=>"Get api ethereum tx transactionhash.", "operationId"=>"ApiEthereumTxByTransactionHashGet", "x-api-path-slug"=>"apiethereumtxtransactionhash-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"transactionHash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ethereum", "Tx", "Transactionhash"]}}, "/api/Ethereum/history/{address}"=>{"get"=>{"summary"=>"Get API Ethereum History Address", "description"=>"Get api ethereum history address.", "operationId"=>"ApiEthereumHistoryByAddressGet", "x-api-path-slug"=>"apiethereumhistoryaddress-get", "parameters"=>[{"in"=>"path", "name"=>"address"}, {"in"=>"query", "name"=>"assetId"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"count"}, {"in"=>"query", "name"=>"start"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ethereum", "History", "Ress"]}}, "/api/Ethereum/settings"=>{"get"=>{"summary"=>"Get API Ethereum Settings", "description"=>"Get api ethereum settings.", "operationId"=>"ApiEthereumSettingsGet", "x-api-path-slug"=>"apiethereumsettings-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ethereum", "Settings"]}}, "/api/ExchangeInfo"=>{"get"=>{"summary"=>"Get API Exchangeinfo", "description"=>"Get api exchangeinfo.", "operationId"=>"ApiExchangeInfoGet", "x-api-path-slug"=>"apiexchangeinfo-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"exchangeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Exchangeinfo"]}}, "/api/FormatCreditVouchersContent"=>{"post"=>{"summary"=>"Add API Formatcreditvoucherscontent", "description"=>"Add api formatcreditvoucherscontent.", "operationId"=>"ApiFormatCreditVouchersContentPost", "x-api-path-slug"=>"apiformatcreditvoucherscontent-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Formatcreditvoucherscontent"]}}, "/api/operations/ForwardWithdrawal"=>{"post"=>{"summary"=>"Add API Operations Forwardwithdrawal", "description"=>"Add api operations forwardwithdrawal.", "operationId"=>"ApiOperationsForwardWithdrawalPost", "x-api-path-slug"=>"apioperationsforwardwithdrawal-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations", "Forwardwithdrawal"]}}, "/api/GenerateTransferTransaction"=>{"post"=>{"summary"=>"Add API Generatetransfertransaction", "description"=>"Add api generatetransfertransaction.", "operationId"=>"ApiGenerateTransferTransactionPost", "x-api-path-slug"=>"apigeneratetransfertransaction-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generatetransfertransaction"]}}, "/api/GraphPeriods"=>{"get"=>{"summary"=>"Get API Graphperiods", "description"=>"Get api graphperiods.", "operationId"=>"ApiGraphPeriodsGet", "x-api-path-slug"=>"apigraphperiods-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Graphperiods"]}}, "/api/HashedPwd"=>{"post"=>{"summary"=>"Add API Hashedpwd", "description"=>"Add api hashedpwd.", "operationId"=>"ApiHashedPwdPost", "x-api-path-slug"=>"apihashedpwd-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hashedpwd"]}}, "/api/History"=>{"get"=>{"summary"=>"Get API History", "description"=>"Get api history.", "operationId"=>"ApiHistoryGet", "x-api-path-slug"=>"apihistory-get", "parameters"=>[{"in"=>"query", "name"=>"assetId"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["History"]}}, "/api/History/limit/trades"=>{"get"=>{"summary"=>"Get API History Limit Trades", "description"=>"Get api history limit trades.", "operationId"=>"ApiHistoryLimitTradesGet", "x-api-path-slug"=>"apihistorylimittrades-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"orderId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["History", "Limit", "Trades"]}}, "/api/History/limit/order"=>{"get"=>{"summary"=>"Get API History Limit Order", "description"=>"Get api history limit order.", "operationId"=>"ApiHistoryLimitOrderGet", "x-api-path-slug"=>"apihistorylimitorder-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"orderId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["History", "Limit", "Order"]}}, "/api/History/limit/history"=>{"get"=>{"summary"=>"Get API History Limit History", "description"=>"Get api history limit history.", "operationId"=>"ApiHistoryLimitHistoryGet", "x-api-path-slug"=>"apihistorylimithistory-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"orderId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["History", "Limit", "History"]}}, "/api/HotWallet/marketOrder"=>{"post"=>{"summary"=>"Add API Hotwallet Marketorder", "description"=>"Add api hotwallet marketorder.", "operationId"=>"MarketOrder", "x-api-path-slug"=>"apihotwalletmarketorder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"SignatureVerificationToken", "description"=>"signature verification token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hotwallet", "Marketorder"]}}, "/api/HotWallet/limitOrder"=>{"post"=>{"summary"=>"Add API Hotwallet Limitorder", "description"=>"Add api hotwallet limitorder.", "operationId"=>"LimitOrder", "x-api-path-slug"=>"apihotwalletlimitorder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"SignatureVerificationToken", "description"=>"signature verification token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hotwallet", "Limitorder"]}}, "/api/HotWallet/cashout"=>{"post"=>{"summary"=>"Add API Hotwallet Cashout", "description"=>"Add api hotwallet cashout.", "operationId"=>"Cashout", "x-api-path-slug"=>"apihotwalletcashout-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"SignatureVerificationToken", "description"=>"signature verification token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hotwallet", "Cashout"]}}, "/api/HotWallet/addresses/{destinationAddress}/{assetId}/validity"=>{"get"=>{"summary"=>"Get API Hotwallet Addresses Destinationaddress Asset Vality", "description"=>"Get api hotwallet addresses destinationaddress asset vality.", "operationId"=>"AddressValidity", "x-api-path-slug"=>"apihotwalletaddressesdestinationaddressassetidvalidity-get", "parameters"=>[{"in"=>"path", "name"=>"assetId"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"destinationAddress"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hotwallet", "Resses", "Destinationaddress", "Asset", "Vality"]}}, "/api/IcoCoinsSold"=>{"get"=>{"summary"=>"Get API Icocoinssold", "description"=>"Get api icocoinssold.", "operationId"=>"ApiIcoCoinsSoldGet", "x-api-path-slug"=>"apiicocoinssold-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Icocoinssold"]}}, "/api/InvertedAssetPairs"=>{"post"=>{"summary"=>"Add API Invertedassetpairs", "description"=>"Add api invertedassetpairs.", "operationId"=>"ApiInvertedAssetPairsPost", "x-api-path-slug"=>"apiinvertedassetpairs-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invertedassetpairs"]}}, "/api/IsAlive"=>{"get"=>{"summary"=>"Get API Isalive", "description"=>"Get api isalive.", "operationId"=>"ApiIsAliveGet", "x-api-path-slug"=>"apiisalive-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Isalive"]}}, "/api/IsPinEntered"=>{"get"=>{"summary"=>"Get API Ispinentered", "description"=>"Get api ispinentered.", "operationId"=>"ApiIsPinEnteredGet", "x-api-path-slug"=>"apiispinentered-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ispinentered"]}}, "/api/Issuers"=>{"get"=>{"summary"=>"Get API Issuers", "description"=>"Get api issuers.", "operationId"=>"ApiIssuersGet", "x-api-path-slug"=>"apiissuers-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Issuers"]}}, "/api/Issuers/{id}"=>{"get"=>{"summary"=>"Get API Issuers", "description"=>"Get api issuers.", "operationId"=>"ApiIssuersByIdGet", "x-api-path-slug"=>"apiissuersid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Issuers"]}}, "/api/KycDocuments"=>{"get"=>{"summary"=>"Get API Kycdocuments", "description"=>"Get api kycdocuments.", "operationId"=>"ApiKycDocumentsGet", "x-api-path-slug"=>"apikycdocuments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Kycdocuments"]}, "post"=>{"summary"=>"Add API Kycdocuments", "description"=>"Add api kycdocuments.", "operationId"=>"ApiKycDocumentsPost", "x-api-path-slug"=>"apikycdocuments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Kycdocuments"]}}, "/api/KycDocumentsBin/{id}"=>{"get"=>{"summary"=>"Get API Kycdocumentsbin", "description"=>"Get api kycdocumentsbin.", "operationId"=>"ApiKycDocumentsBinByIdGet", "x-api-path-slug"=>"apikycdocumentsbinid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"height"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"width"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Kycdocumentsbin"]}}, "/api/KycDocumentsBin"=>{"post"=>{"summary"=>"Add API Kycdocumentsbin", "description"=>"Add api kycdocumentsbin.", "operationId"=>"ApiKycDocumentsBinPost", "x-api-path-slug"=>"apikycdocumentsbin-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"ext"}, {"in"=>"query", "name"=>"idType"}, {"in"=>"query", "name"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Kycdocumentsbin"]}}, "/api/KycDocumentUpload"=>{"post"=>{"summary"=>"Add API Kycdocumentupload", "description"=>"Add api kycdocumentupload.", "operationId"=>"ApiKycDocumentUploadPost", "x-api-path-slug"=>"apikycdocumentupload-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"idType"}, {"in"=>"formfile", "name"=>"photo"}, {"in"=>"query", "name"=>"type"}, {"in"=>"formfile", "name"=>"userFile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Kycdocumentupload"]}}, "/api/KycForAsset/{id}"=>{"get"=>{"summary"=>"Get API Kycforasset", "description"=>"Get api kycforasset.", "operationId"=>"ApiKycForAssetByIdGet", "x-api-path-slug"=>"apikycforassetid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Kycforasset"]}}, "/api/KycStatus"=>{"get"=>{"summary"=>"Get API Kycstatus", "description"=>"Get api kycstatus.", "operationId"=>"ApiKycStatusGet", "x-api-path-slug"=>"apikycstatus-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Kycstatus"]}, "post"=>{"summary"=>"Add API Kycstatus", "description"=>"Add api kycstatus.", "operationId"=>"ApiKycStatusPost", "x-api-path-slug"=>"apikycstatus-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Kycstatus"]}}, "/api/LastBaseAssets"=>{"get"=>{"summary"=>"Get API Lastbaseassets", "description"=>"Get api lastbaseassets.", "operationId"=>"ApiLastBaseAssetsGet", "x-api-path-slug"=>"apilastbaseassets-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"n"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lastbaseassets"]}}, "/api/offchain/limit/list"=>{"get"=>{"summary"=>"Get API Offchain Limit List", "description"=>"Get api offchain limit list.", "operationId"=>"ApiOffchainLimitListGet", "x-api-path-slug"=>"apioffchainlimitlist-get", "parameters"=>[{"in"=>"query", "name"=>"assetPair"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offchain", "Limit", "List"]}}, "/api/offchain/limit/count"=>{"get"=>{"summary"=>"Get API Offchain Limit Count", "description"=>"Get api offchain limit count.", "operationId"=>"ApiOffchainLimitCountGet", "x-api-path-slug"=>"apioffchainlimitcount-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offchain", "Limit", "Count"]}}, "/api/LykkeNews"=>{"get"=>{"summary"=>"Get API Lykkenews", "description"=>"Get api lykkenews.", "operationId"=>"ApiLykkeNewsGet", "x-api-path-slug"=>"apilykkenews-get", "parameters"=>[{"in"=>"query", "name"=>"skip"}, {"in"=>"query", "name"=>"take"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lykkenews"]}}, "/api/MarginTrading/account/balance"=>{"post"=>{"summary"=>"Add API Margintrading Account Balance", "description"=>"Add api margintrading account balance.", "operationId"=>"ApiMarginTradingAccountBalancePost", "x-api-path-slug"=>"apimargintradingaccountbalance-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Margintrading", "Account", "Balance"]}}, "/api/MarginTrading/account/reset/{accountId}"=>{"delete"=>{"summary"=>"Delete API Margintrading Account Reset Account", "description"=>"Delete api margintrading account reset account.", "operationId"=>"ApiMarginTradingAccountResetByAccountIdDelete", "x-api-path-slug"=>"apimargintradingaccountresetaccountid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Margintrading", "Account", "Reset", "Account"]}}, "/api/MarginTrading/cashOutSwift"=>{"post"=>{"summary"=>"Add API Margintrading Cashoutswift", "description"=>"Add api margintrading cashoutswift.", "operationId"=>"ApiMarginTradingCashOutSwiftPost", "x-api-path-slug"=>"apimargintradingcashoutswift-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Margintrading", "Cashoutswift"]}}, "/api/Market/converter/tobase"=>{"post"=>{"summary"=>"Add API Market Converter Tobase", "description"=>"Add api market converter tobase.", "operationId"=>"ApiMarketConverterTobasePost", "x-api-path-slug"=>"apimarketconvertertobase-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market", "Converter", "Tobase"]}}, "/api/MyLykkeCashInEmail"=>{"post"=>{"summary"=>"Add API Mylykkecashinemail", "description"=>"Add api mylykkecashinemail.", "operationId"=>"ApiMyLykkeCashInEmailPost", "x-api-path-slug"=>"apimylykkecashinemail-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"reqModel", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mylykkecashinemail"]}}, "/api/MyLykkeInfo"=>{"get"=>{"summary"=>"Get API Mylykkeinfo", "description"=>"Get api mylykkeinfo.", "operationId"=>"ApiMyLykkeInfoGet", "x-api-path-slug"=>"apimylykkeinfo-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mylykkeinfo"]}}, "/api/MyLykkeSettings"=>{"get"=>{"summary"=>"Get API Mylykkesettings", "description"=>"Get api mylykkesettings.", "operationId"=>"ApiMyLykkeSettingsGet", "x-api-path-slug"=>"apimylykkesettings-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mylykkesettings"]}}, "/api/offchain/requests"=>{"get"=>{"summary"=>"Get API Offchain Requests", "description"=>"Get api offchain requests.", "operationId"=>"ApiOffchainRequestsGet", "x-api-path-slug"=>"apioffchainrequests-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offchain", "Requests"]}}, "/api/offchain/trade"=>{"post"=>{"summary"=>"Add API Offchain Trade", "description"=>"Add api offchain trade.", "operationId"=>"ApiOffchainTradePost", "x-api-path-slug"=>"apioffchaintrade-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offchain", "Trade"]}}, "/api/offchain/limit/trade"=>{"post"=>{"summary"=>"Add API Offchain Limit Trade", "description"=>"Add api offchain limit trade.", "operationId"=>"ApiOffchainLimitTradePost", "x-api-path-slug"=>"apioffchainlimittrade-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offchain", "Limit", "Trade"]}}, "/api/offchain/limit/cancel"=>{"post"=>{"summary"=>"Add API Offchain Limit Cancel", "description"=>"Add api offchain limit cancel.", "operationId"=>"ApiOffchainLimitCancelPost", "x-api-path-slug"=>"apioffchainlimitcancel-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offchain", "Limit", "Cancel"]}}, "/api/offchain/processchannel"=>{"post"=>{"summary"=>"Add API Offchain Processchannel", "description"=>"Add api offchain processchannel.", "operationId"=>"ApiOffchainProcesschannelPost", "x-api-path-slug"=>"apioffchainprocesschannel-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offchain", "Processchannel"]}}, "/api/offchain/finalizetransfer"=>{"post"=>{"summary"=>"Add API Offchain Finalizetransfer", "description"=>"Add api offchain finalizetransfer.", "operationId"=>"ApiOffchainFinalizetransferPost", "x-api-path-slug"=>"apioffchainfinalizetransfer-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offchain", "Finalizetransfer"]}}, "/api/offchain/requestTransfer"=>{"post"=>{"summary"=>"Add API Offchain Requesttransfer", "description"=>"Add api offchain requesttransfer.", "operationId"=>"ApiOffchainRequestTransferPost", "x-api-path-slug"=>"apioffchainrequesttransfer-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offchain", "Requesttransfer"]}}, "/api/offchain/channelkey"=>{"get"=>{"summary"=>"Get API Offchain Channelkey", "description"=>"Get api offchain channelkey.", "operationId"=>"ApiOffchainChannelkeyGet", "x-api-path-slug"=>"apioffchainchannelkey-get", "parameters"=>[{"in"=>"query", "name"=>"asset"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offchain", "Channelkey"]}}, "/api/offchain/transferToMargin"=>{"post"=>{"summary"=>"Add API Offchain Transfertomargin", "description"=>"Add api offchain transfertomargin.", "operationId"=>"ApiOffchainTransferToMarginPost", "x-api-path-slug"=>"apioffchaintransfertomargin-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offchain", "Transfertomargin"]}}, "/api/offchain/{operationId}/transferToTrusted"=>{"post"=>{"summary"=>"Add API Offchain Operation Transfertotrusted", "description"=>"Add api offchain operation transfertotrusted.", "operationId"=>"ApiOffchainByOperationIdTransferToTrustedPost", "x-api-path-slug"=>"apioffchainoperationidtransfertotrusted-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"operationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offchain", "Operation", "Transfertotrusted"]}}, "/api/offchain/cashout"=>{"post"=>{"summary"=>"Add API Offchain Cashout", "description"=>"Add api offchain cashout.", "operationId"=>"ApiOffchainCashoutPost", "x-api-path-slug"=>"apioffchaincashout-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offchain", "Cashout"]}}, "/api/offchain/cashout/swift"=>{"get"=>{"summary"=>"Get API Offchain Cashout Swift", "description"=>"Get api offchain cashout swift.", "operationId"=>"ApiOffchainCashoutSwiftGet", "x-api-path-slug"=>"apioffchaincashoutswift-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offchain", "Cashout", "Swift"]}, "post"=>{"summary"=>"Add API Offchain Cashout Swift", "description"=>"Add api offchain cashout swift.", "operationId"=>"ApiOffchainCashoutSwiftPost", "x-api-path-slug"=>"apioffchaincashoutswift-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offchain", "Cashout", "Swift"]}}, "/api/offchain/cashout/forward"=>{"post"=>{"summary"=>"Add API Offchain Cashout Forward", "description"=>"Add api offchain cashout forward.", "operationId"=>"ApiOffchainCashoutForwardPost", "x-api-path-slug"=>"apioffchaincashoutforward-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offchain", "Cashout", "Forward"]}}, "/api/Operations/unsignedTransactions"=>{"get"=>{"summary"=>"Get API Operations Unsignedtransactions", "description"=>"Get api operations unsignedtransactions.", "operationId"=>"ApiOperationsUnsignedTransactionsGet", "x-api-path-slug"=>"apioperationsunsignedtransactions-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations", "Unsignedtransactions"]}, "post"=>{"summary"=>"Add API Operations Unsignedtransactions", "description"=>"Add api operations unsignedtransactions.", "operationId"=>"ApiOperationsUnsignedTransactionsPost", "x-api-path-slug"=>"apioperationsunsignedtransactions-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations", "Unsignedtransactions"]}}, "/api/Operations/list/{status}"=>{"get"=>{"summary"=>"Get API Operations List Status", "description"=>"Get api operations list status.", "operationId"=>"ApiOperationsListByStatusGet", "x-api-path-slug"=>"apioperationsliststatus-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations", "List", "Status"]}}, "/api/Operations/{id}"=>{"get"=>{"summary"=>"Get API Operations", "description"=>"Get api operations.", "operationId"=>"ApiOperationsByIdGet", "x-api-path-slug"=>"apioperationsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations"]}}, "/api/Operations/{id}/cancel"=>{"post"=>{"summary"=>"Add API Operations Cancel", "description"=>"Add api operations cancel.", "operationId"=>"ApiOperationsByIdCancelPost", "x-api-path-slug"=>"apioperationsidcancel-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations", "", "Cancel"]}}, "/api/Operations/cancel"=>{"post"=>{"summary"=>"Add API Operations Cancel", "description"=>"Add api operations cancel.", "operationId"=>"ApiOperationsCancelPost", "x-api-path-slug"=>"apioperationscancel-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations", "Cancel"]}}, "/api/OrderBook/{id}"=>{"get"=>{"summary"=>"Get API Orderbook", "description"=>"Get api orderbook.", "operationId"=>"ApiOrderBookByIdGet", "x-api-path-slug"=>"apiorderbookid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orderbook"]}}, "/api/PersonalData"=>{"get"=>{"summary"=>"Get API Personaldata", "description"=>"Get api personaldata.", "operationId"=>"ApiPersonalDataGet", "x-api-path-slug"=>"apipersonaldata-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Personaldata"]}}, "/api/PinSecurity"=>{"get"=>{"summary"=>"Get API Pinsecurity", "description"=>"Get api pinsecurity.", "operationId"=>"ApiPinSecurityGet", "x-api-path-slug"=>"apipinsecurity-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"pin"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pinsecurity"]}, "post"=>{"summary"=>"Add API Pinsecurity", "description"=>"Add api pinsecurity.", "operationId"=>"ApiPinSecurityPost", "x-api-path-slug"=>"apipinsecurity-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pinsecurity"]}}, "/api/PrivateKeyOwnershipMsg"=>{"get"=>{"summary"=>"Get API Privatekeyownershipmsg", "description"=>"Get api privatekeyownershipmsg.", "operationId"=>"ApiPrivateKeyOwnershipMsgGet", "x-api-path-slug"=>"apiprivatekeyownershipmsg-get", "parameters"=>[{"in"=>"query", "name"=>"email"}, {"in"=>"query", "name"=>"partnerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privatekeyownershipmsg"]}, "post"=>{"summary"=>"Add API Privatekeyownershipmsg", "description"=>"Add api privatekeyownershipmsg.", "operationId"=>"ApiPrivateKeyOwnershipMsgPost", "x-api-path-slug"=>"apiprivatekeyownershipmsg-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privatekeyownershipmsg"]}}, "/api/PrivateWallet"=>{"get"=>{"summary"=>"Get API Privatewallet", "description"=>"Get api privatewallet.", "operationId"=>"ApiPrivateWalletGet", "x-api-path-slug"=>"apiprivatewallet-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privatewallet"]}, "put"=>{"summary"=>"Put API Privatewallet", "description"=>"Put api privatewallet.", "operationId"=>"ApiPrivateWalletPut", "x-api-path-slug"=>"apiprivatewallet-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"editModel", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privatewallet"]}, "post"=>{"summary"=>"Add API Privatewallet", "description"=>"Add api privatewallet.", "operationId"=>"ApiPrivateWalletPost", "x-api-path-slug"=>"apiprivatewallet-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"createWalletModel", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privatewallet"]}, "delete"=>{"summary"=>"Delete API Privatewallet", "description"=>"Delete api privatewallet.", "operationId"=>"ApiPrivateWalletDelete", "x-api-path-slug"=>"apiprivatewallet-delete", "parameters"=>[{"in"=>"query", "name"=>"address"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privatewallet"]}}, "/api/PrivateWallet/{id}"=>{"get"=>{"summary"=>"Get API Privatewallet", "description"=>"Get api privatewallet.", "operationId"=>"ApiPrivateWalletByIdGet", "x-api-path-slug"=>"apiprivatewalletid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privatewallet"]}}, "/api/PrivateWallet/key"=>{"post"=>{"summary"=>"Add API Privatewallet Key", "description"=>"Add api privatewallet key.", "operationId"=>"ApiPrivateWalletKeyPost", "x-api-path-slug"=>"apiprivatewalletkey-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privatewallet", "Key"]}}, "/api/PrivateWalletBackup"=>{"post"=>{"summary"=>"Add API Privatewalletbackup", "description"=>"Add api privatewalletbackup.", "operationId"=>"ApiPrivateWalletBackupPost", "x-api-path-slug"=>"apiprivatewalletbackup-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"backupModel", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privatewalletbackup"]}}, "/api/PrivateWalletBalance"=>{"get"=>{"summary"=>"Get API Privatewalletbalance", "description"=>"Get api privatewalletbalance.", "operationId"=>"ApiPrivateWalletBalanceGet", "x-api-path-slug"=>"apiprivatewalletbalance-get", "parameters"=>[{"in"=>"query", "name"=>"address"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privatewalletbalance"]}}, "/api/PrivateWalletHistory"=>{"get"=>{"summary"=>"Get API Privatewallethistory", "description"=>"Get api privatewallethistory.", "operationId"=>"ApiPrivateWalletHistoryGet", "x-api-path-slug"=>"apiprivatewallethistory-get", "parameters"=>[{"in"=>"query", "name"=>"address"}, {"in"=>"query", "name"=>"assetId"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privatewallethistory"]}}, "/api/PubkeyAddressValidation"=>{"get"=>{"summary"=>"Get API Pubkeyaddressvalation", "description"=>"Get api pubkeyaddressvalation.", "operationId"=>"ApiPubkeyAddressValidationGet", "x-api-path-slug"=>"apipubkeyaddressvalidation-get", "parameters"=>[{"in"=>"query", "name"=>"pubkeyAddress"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pubkeyaddressvalation"]}}, "/api/PurchaseAsset"=>{"post"=>{"summary"=>"Add API Purchaseasset", "description"=>"Add api purchaseasset.", "operationId"=>"ApiPurchaseAssetPost", "x-api-path-slug"=>"apipurchaseasset-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Purchaseasset"]}}, "/api/PushSettings"=>{"get"=>{"summary"=>"Get API Pushsettings", "description"=>"Get api pushsettings.", "operationId"=>"ApiPushSettingsGet", "x-api-path-slug"=>"apipushsettings-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pushsettings"]}, "post"=>{"summary"=>"Add API Pushsettings", "description"=>"Add api pushsettings.", "operationId"=>"ApiPushSettingsPost", "x-api-path-slug"=>"apipushsettings-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pushsettings"]}}, "/api/RecoverySmsConfirmation"=>{"post"=>{"summary"=>"Add API Recoverysmsconfirmation", "description"=>"Add api recoverysmsconfirmation.", "operationId"=>"ApiRecoverySmsConfirmationPost", "x-api-path-slug"=>"apirecoverysmsconfirmation-post", "parameters"=>[{"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recoverysmsconfirmation"]}}, "/api/RefundAddress"=>{"get"=>{"summary"=>"Get API Refundaddress", "description"=>"Get api refundaddress.", "operationId"=>"ApiRefundAddressGet", "x-api-path-slug"=>"apirefundaddress-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Refundaddress"]}, "post"=>{"summary"=>"Add API Refundaddress", "description"=>"Add api refundaddress.", "operationId"=>"ApiRefundAddressPost", "x-api-path-slug"=>"apirefundaddress-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"refundAddressModel", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Refundaddress"]}}, "/api/RefundSettings"=>{"get"=>{"summary"=>"Get API Refundsettings", "description"=>"Get api refundsettings.", "operationId"=>"ApiRefundSettingsGet", "x-api-path-slug"=>"apirefundsettings-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Refundsettings"]}, "post"=>{"summary"=>"Add API Refundsettings", "description"=>"Add api refundsettings.", "operationId"=>"ApiRefundSettingsPost", "x-api-path-slug"=>"apirefundsettings-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"refundAddressModel", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Refundsettings"]}}, "/api/Registration"=>{"get"=>{"summary"=>"Get API Registration", "description"=>"Get api registration.", "operationId"=>"ApiRegistrationGet", "x-api-path-slug"=>"apiregistration-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registration"]}, "post"=>{"summary"=>"Add API Registration", "description"=>"Add api registration.", "operationId"=>"ApiRegistrationPost", "x-api-path-slug"=>"apiregistration-post", "parameters"=>[{"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registration"]}}, "/api/RemindPasswordEmail"=>{"post"=>{"summary"=>"Add API Remindpasswordemail", "description"=>"Add api remindpasswordemail.", "operationId"=>"ApiRemindPasswordEmailPost", "x-api-path-slug"=>"apiremindpasswordemail-post", "parameters"=>[{"in"=>"body", "name"=>"reqModel", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remindpasswordemail"]}}, "/api/RequestVoiceCall"=>{"post"=>{"summary"=>"Add API Requestvoicecall", "description"=>"Add api requestvoicecall.", "operationId"=>"ApiRequestVoiceCallPost", "x-api-path-slug"=>"apirequestvoicecall-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Requestvoicecall"]}}, "/api/RestrictedCountries"=>{"get"=>{"summary"=>"Get API Restrictedcountries", "description"=>"Get api restrictedcountries.", "operationId"=>"ApiRestrictedCountriesGet", "x-api-path-slug"=>"apirestrictedcountries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Restrictedcountries"]}}, "/api/SendBlockchainEmail"=>{"post"=>{"summary"=>"Add API Sendblockchainemail", "description"=>"Add api sendblockchainemail.", "operationId"=>"ApiSendBlockchainEmailPost", "x-api-path-slug"=>"apisendblockchainemail-post", "parameters"=>[{"in"=>"query", "name"=>"assetId"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sendblockchainemail"]}}, "/api/ServerTime"=>{"get"=>{"summary"=>"Get API Servertime", "description"=>"Get api servertime.", "operationId"=>"ApiServerTimeGet", "x-api-path-slug"=>"apiservertime-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servertime"]}}, "/api/SettingSignOrder"=>{"post"=>{"summary"=>"Add API Settingsignorder", "description"=>"Add api settingsignorder.", "operationId"=>"ApiSettingSignOrderPost", "x-api-path-slug"=>"apisettingsignorder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settingsignorder"]}}, "/api/signatureVerificationToken/KeyConfirmation"=>{"get"=>{"summary"=>"Get API Signatureverificationtoken Keyconfirmation", "description"=>"Get api signatureverificationtoken keyconfirmation.", "operationId"=>"ApiSignatureVerificationTokenKeyConfirmationGet", "x-api-path-slug"=>"apisignatureverificationtokenkeyconfirmation-get", "parameters"=>[{"in"=>"query", "name"=>"email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signatureverificationtoken", "Keyconfirmation"]}, "post"=>{"summary"=>"Add API Signatureverificationtoken Keyconfirmation", "description"=>"Add api signatureverificationtoken keyconfirmation.", "operationId"=>"ApiSignatureVerificationTokenKeyConfirmationPost", "x-api-path-slug"=>"apisignatureverificationtokenkeyconfirmation-post", "parameters"=>[{"in"=>"body", "name"=>"response", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signatureverificationtoken", "Keyconfirmation"]}}, "/api/SignRequest"=>{"get"=>{"summary"=>"Get API Signrequest", "description"=>"Get api signrequest.", "operationId"=>"ApiSignRequestGet", "x-api-path-slug"=>"apisignrequest-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signrequest"]}, "post"=>{"summary"=>"Add API Signrequest", "description"=>"Add api signrequest.", "operationId"=>"ApiSignRequestPost", "x-api-path-slug"=>"apisignrequest-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signrequest"]}}, "/api/SwiftCredentials/{assetId}"=>{"get"=>{"summary"=>"Get API Swiftcredentials Asset", "description"=>"Get api swiftcredentials asset.", "operationId"=>"ApiSwiftCredentialsByAssetIdGet", "x-api-path-slug"=>"apiswiftcredentialsassetid-get", "parameters"=>[{"in"=>"path", "name"=>"assetId"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Swiftcredentials", "Asset"]}}, "/api/SwiftCredentials"=>{"get"=>{"summary"=>"Get API Swiftcredentials", "description"=>"Get api swiftcredentials.", "operationId"=>"ApiSwiftCredentialsGet", "x-api-path-slug"=>"apiswiftcredentials-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Swiftcredentials"]}}, "/api/Transactions"=>{"get"=>{"summary"=>"Get API Transactions", "description"=>"Get api transactions.", "operationId"=>"ApiTransactionsGet", "x-api-path-slug"=>"apitransactions-get", "parameters"=>[{"in"=>"query", "name"=>"assetId"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions"]}}, "/api/TransferInfo"=>{"get"=>{"summary"=>"Get API Transferinfo", "description"=>"Get api transferinfo.", "operationId"=>"ApiTransferInfoGet", "x-api-path-slug"=>"apitransferinfo-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"query", "name"=>"transferId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transferinfo"]}}, "/api/TrustedWallets/{operationId}/transfer"=>{"post"=>{"summary"=>"Add API Trustedwallets Operation Transfer", "description"=>"Add api trustedwallets operation transfer.", "operationId"=>"Transfer", "x-api-path-slug"=>"apitrustedwalletsoperationidtransfer-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"operationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trustedwallets", "Operation", "Transfer"]}}, "/api/Utils/isUSorCanadaNumber/{phoneNumber}"=>{"get"=>{"summary"=>"Get API Utils Isusorcanadanumber Phonenumber", "description"=>"Get api utils isusorcanadanumber phonenumber.", "operationId"=>"ApiUtilsIsUSorCanadaNumberByPhoneNumberGet", "x-api-path-slug"=>"apiutilsisusorcanadanumberphonenumber-get", "parameters"=>[{"in"=>"path", "name"=>"phoneNumber"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Utils", "Isusorcanadanumber", "Phonenumber"]}}, "/home/Version"=>{"get"=>{"summary"=>"Get Home Version", "description"=>"Get home version.", "operationId"=>"HomeVersionGet", "x-api-path-slug"=>"homeversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Home", "Version"]}}, "/api/WalletMigration"=>{"post"=>{"summary"=>"Add API Walletmigration", "description"=>"Add api walletmigration.", "operationId"=>"ApiWalletMigrationPost", "x-api-path-slug"=>"apiwalletmigration-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Walletmigration"]}}, "/api/Wallets"=>{"get"=>{"summary"=>"Get API Wallets", "description"=>"Get api wallets.", "operationId"=>"ApiWalletsGet", "x-api-path-slug"=>"apiwallets-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wallets"]}, "post"=>{"summary"=>"Add API Wallets", "description"=>"Add api wallets.", "operationId"=>"ApiWalletsPost", "x-api-path-slug"=>"apiwallets-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wallets"]}}, "/api/Wallets/{id}"=>{"get"=>{"summary"=>"Get API Wallets", "description"=>"Get api wallets.", "operationId"=>"ApiWalletsByIdGet", "x-api-path-slug"=>"apiwalletsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wallets"]}}, "/api/Wallets/depositaddress/{assetId}"=>{"post"=>{"summary"=>"Add API Wallets Depositaddress Asset", "description"=>"Add api wallets depositaddress asset.", "operationId"=>"ApiWalletsDepositaddressByAssetIdPost", "x-api-path-slug"=>"apiwalletsdepositaddressassetid-post", "parameters"=>[{"in"=>"path", "name"=>"assetId"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wallets", "Depositaddress", "Asset"]}}, "/api/WatchLists"=>{"get"=>{"summary"=>"Get API Watchlists", "description"=>"Get api watchlists.", "operationId"=>"ApiWatchListsGet", "x-api-path-slug"=>"apiwatchlists-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watchlists"]}, "post"=>{"summary"=>"Add API Watchlists", "description"=>"Add api watchlists.", "operationId"=>"ApiWatchListsPost", "x-api-path-slug"=>"apiwatchlists-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watchlists"]}}, "/api/WatchLists/{id}"=>{"get"=>{"summary"=>"Get API Watchlists", "description"=>"Get api watchlists.", "operationId"=>"ApiWatchListsByIdGet", "x-api-path-slug"=>"apiwatchlistsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watchlists"]}, "put"=>{"summary"=>"Put API Watchlists", "description"=>"Put api watchlists.", "operationId"=>"ApiWatchListsByIdPut", "x-api-path-slug"=>"apiwatchlistsid-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"id"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watchlists"]}, "delete"=>{"summary"=>"Delete API Watchlists", "description"=>"Delete api watchlists.", "operationId"=>"ApiWatchListsByIdDelete", "x-api-path-slug"=>"apiwatchlistsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watchlists"]}}}}, "apis"=>{"name"=>"Lykke", "x-slug"=>"lykke", "description"=>"Lykke is a movement to build one global marketplace that is a level playing field where everyone has access.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/26564-lykke.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"152167", "tags"=>"API Provider,Blockchain,General Data,Marketplace,Profiles,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"lykke/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Lykke", "x-api-slug"=>"lykke", "description"=>"Lykke is a movement to build one global marketplace that is a level playing field where everyone has access.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/26564-lykke.jpg", "humanURL"=>"https://lykke.com", "baseURL"=>"https:////", "tags"=>"API Provider,Blockchain,General Data,Marketplace,Profiles,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/lykke/lykke-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/lykke-ag"}, {"type"=>"x-email", "url"=>"support@lykke.com"}, {"type"=>"x-email", "url"=>"lykke@lykke.com"}, {"type"=>"x-email", "url"=>"pr@lykke.com"}, {"type"=>"x-email", "url"=>"support@lykkex.com"}, {"type"=>"x-email", "url"=>"compliance@lykke.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/lykke"}, {"type"=>"x-website", "url"=>"https://lykke.com"}, {"type"=>"x-website", "url"=>"https://www.lykke.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
yelp{"yelp-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Yelp", "x-complete"=>1, "info"=>{"title"=>"Yelp V3", "description"=>"yelps-fusion-api-allows-you-to-get-the-best-local-business-information-and-user-reviews-of-over-million-businesses-in-32-countries", "version"=>"1.0.0"}, "host"=>"api.yelp.com", "basePath"=>"/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/businesses/search"=>{"get"=>{"summary"=>"Get Businesses Search", "description"=>"Get businesses search.", "operationId"=>"getBusinessesSearch", "x-api-path-slug"=>"businessessearch-get", "parameters"=>[{"in"=>"query", "name"=>"term"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Search"]}}, "/businesses/{id}"=>{"get"=>{"summary"=>"Get Businesses", "description"=>"Get businesses.", "operationId"=>"getBusinesses", "x-api-path-slug"=>"businessesid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses"]}}, "/businesses/{id}/reviews"=>{"get"=>{"summary"=>"Get Businesses Reviews", "description"=>"Get businesses reviews.", "operationId"=>"getBusinessesReviews", "x-api-path-slug"=>"businessesidreviews-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Reviews"]}}, "/autocomplete"=>{"get"=>{"summary"=>"Get Autocomplete", "description"=>"Get autocomplete.", "operationId"=>"getAutocomplete", "x-api-path-slug"=>"autocomplete-get", "parameters"=>[{"in"=>"query", "name"=>"text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autocomplete"]}}, "/businesses/search/phone"=>{"get"=>{"summary"=>"Get Businesses Search Phone", "description"=>"Get businesses search phone.", "operationId"=>"getBusinessesSearchPhone", "x-api-path-slug"=>"businessessearchphone-get", "parameters"=>[{"in"=>"query", "name"=>"phone"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Search", "Phone"]}}, "/transactions/delivery/search"=>{"get"=>{"summary"=>"Get Transactions Delivery Search", "description"=>"Get transactions delivery search.", "operationId"=>"getTransactionsDeliverySearch", "x-api-path-slug"=>"transactionsdeliverysearch-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Delivery", "Search"]}}}}, "apis"=>{"name"=>"Yelp", "x-slug"=>"yelp", "description"=>"User Reviews and Recommendations of Best Restaurants, Shopping, Nightlife, Food, Entertainment, Things to Do, Services and More at Yelp", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/536-yelp.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"194", "tags"=>"Business,General Data,internet,Local,Marketplace,Mobile,Pedestal,Places,Publish,Relative Data,Service API,Stack,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"yelp/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Yelp", "x-api-slug"=>"yelp", "description"=>"Yelps API program enables you to access trusted Yelp information in real time, such as business listing info, overall business ratings and review counts, deals and recent review excerpts.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/536-yelp.jpg", "humanURL"=>"http://yelp.com/engineering", "baseURL"=>"https://api.yelp.com//v3", "tags"=>"Business,General Data,internet,Local,Marketplace,Mobile,Pedestal,Places,Publish,Relative Data,Service API,Stack,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/yelp/transactionsdeliverysearch-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/yelp/yelp-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://yelp.com/engineering"}, {"type"=>"x-base", "url"=>"http://api.yelp.com"}, {"type"=>"x-blog", "url"=>"https://engineeringblog.yelp.com/"}, {"type"=>"x-blog-rss", "url"=>"https://engineeringblog.yelp.com/feed.xml"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/yelp"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/yelp"}, {"type"=>"x-developer", "url"=>"http://www.yelp.com/developers"}, {"type"=>"x-github", "url"=>"https://github.com/Yelp"}, {"type"=>"x-openapi", "url"=>"https://github.com/APIs-guru/unofficial_openapi_specs/blob/master/yelp.com/v3/swagger.yaml"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Yelp"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/yelpengineering"}, {"type"=>"x-website", "url"=>"http://www.yelp.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
eu-vat-api{"eu-vat-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EU VAT API", "x-complete"=>1, "info"=>{"title"=>"VAT API", "description"=>"a-developer-friendly-api-to-help-your-business-achieve-vat-compliance", "version"=>"1"}, "host"=>"vatapi.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/country-code-check"=>{"get"=>{"summary"=>"Retrieve a countries VAT rates by its 2 digit country code", "description"=>"Retrieve a countries vat rates by its 2 digit country code.", "operationId"=>"country_code_check", "x-api-path-slug"=>"countrycodecheck-get", "parameters"=>[{"in"=>"query", "name"=>"code", "description"=>"The 2 digit country code"}, {"in"=>"header", "name"=>"Response-Type", "description"=>"The default response type is application/json if you would like to receive an XML response then set this to XML"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Countries", "VAT", "Rates", "By", "Its", "2", "Digit", "Country", "Code"]}}, "/currency-conversion"=>{"get"=>{"summary"=>"Convert a currency", "description"=>"Convert a currency.", "operationId"=>"currency_conversion", "x-api-path-slug"=>"currencyconversion-get", "parameters"=>[{"in"=>"query", "name"=>"amount", "description"=>"Optional, an amount you are wanting to convert"}, {"in"=>"query", "name"=>"currency_from", "description"=>"The currency code you are converting from"}, {"in"=>"query", "name"=>"currency_to", "description"=>"The currency code you are converting to"}, {"in"=>"header", "name"=>"Response-Type", "description"=>"The default response type is application/json if you would like to receive an XML response then set this to XML"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Convert", "Currency"]}}, "/invoice"=>{"post"=>{"summary"=>"Create a VAT invoice", "description"=>"Create a vat invoice.", "operationId"=>"create_invoice", "x-api-path-slug"=>"invoice-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Enter invoice data as JSON", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Response-Type", "description"=>"The default response type is application/json if you would like to receive an XML response then set this to XML"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VAT", "Invoice"]}}, "/invoice/{id}"=>{"delete"=>{"summary"=>"Delete an invoice", "description"=>"Delete an invoice.", "operationId"=>"invoice_delete", "x-api-path-slug"=>"invoiceid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Enter an invoice id"}, {"in"=>"header", "name"=>"Response-Type", "description"=>"The default response type is application/json if you would like to receive an XML response then set this to XML"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice"]}, "get"=>{"summary"=>"Retrieve an invoice", "description"=>"Retrieve an invoice.", "operationId"=>"get_invoice", "x-api-path-slug"=>"invoiceid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Enter the invoice id"}, {"in"=>"header", "name"=>"Response-Type", "description"=>"The default response type is application/json if you would like to receive an XML response then set this to XML"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Invoice"]}, "put"=>{"summary"=>"Update an existing invoice", "description"=>"Update an existing invoice.", "operationId"=>"invoice_update", "x-api-path-slug"=>"invoiceid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Enter invoice data as JSON", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Enter an invoice id"}, {"in"=>"header", "name"=>"Response-Type", "description"=>"The default response type is application/json if you would like to receive an XML response then set this to XML"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Existing", "Invoice"]}}, "/ip-check"=>{"get"=>{"summary"=>"Retrieve a countries VAT rates from an IP address", "description"=>"Retrieve a countries vat rates from an ip address.", "operationId"=>"ip_check", "x-api-path-slug"=>"ipcheck-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"The IP address to search against"}, {"in"=>"header", "name"=>"Response-Type", "description"=>"The default response type is application/json if you would like to receive an XML response then set this to XML"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Countries", "VAT", "Rates", "From", "IP", "Address"]}}, "/usage-check"=>{"get"=>{"summary"=>"Check api requests remaining on current subscription plan", "description"=>"Check api requests remaining on current subscription plan.", "operationId"=>"api_usage", "x-api-path-slug"=>"usagecheck-get", "parameters"=>[{"in"=>"header", "name"=>"Response-Type", "description"=>"The default response type is application/json if you would like to receive an XML response then set this to XML"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Check", "Api", "Requests", "Remaining", "On", "Current", "Subscription", "Plan"]}}, "/vat-number-check"=>{"get"=>{"summary"=>"Validate a VAT number", "description"=>"Validate a vat number.", "operationId"=>"vat_number_validate", "x-api-path-slug"=>"vatnumbercheck-get", "parameters"=>[{"in"=>"header", "name"=>"Response-Type", "description"=>"The default response type is application/json if you would like to receive an XML response then set this to XML"}, {"in"=>"query", "name"=>"vatid", "description"=>"The VAT number to validate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Validate", "VAT", "Number"]}}, "/vat-price"=>{"get"=>{"summary"=>"Convert a price to or from VAT price.", "description"=>"Convert a price to or from vat price..", "operationId"=>"convert_price", "x-api-path-slug"=>"vatprice-get", "parameters"=>[{"in"=>"query", "name"=>"code", "description"=>"The 2 digit country code"}, {"in"=>"query", "name"=>"country_rate", "description"=>"The VAT rate to get the price for"}, {"in"=>"query", "name"=>"price", "description"=>"The price you want converting"}, {"in"=>"header", "name"=>"Response-Type", "description"=>"The default response type is application/json if you would like to receive an XML response then set this to XML"}, {"in"=>"query", "name"=>"type", "description"=>"Optional, if the price is including VAT set the type to incl"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Convert", "Price", "To", "From", "VAT", "Price"]}}, "/vat-rates"=>{"get"=>{"summary"=>"Retrieve all current EU VAT rates", "description"=>"Retrieve all current eu vat rates.", "operationId"=>"vat_rates", "x-api-path-slug"=>"vatrates-get", "parameters"=>[{"in"=>"header", "name"=>"Response-Type", "description"=>"The default response type is application/json if you would like to receive an XML response then set this to XML"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "", "Current", "EU", "VAT", "Rates"]}}}}, "apis"=>{"name"=>"EU VAT API", "x-slug"=>"eu-vat-api", "description"=>"A developer friendly API to help your business achieve VAT compliance. Are you selling digital services to other EU countries? From Jan 1st 2015 changes to the VAT place of supply are coming into effect. One acceptable way to prove where your customer resides is their IP address. We have removed the headache and cost of you having to geo locate your customers IP address, and workout what VAT rate they should be charged. Simply pass your customers IP address from your application to our API and well return a JSON or XML object of all the current EU VAT rates for that country, or if you already know their country you can lookup the rates from the 2 digit country code.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/vatapi-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"EU,Relative Data,Service API,Taxes,VAT", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"eu-vat-api/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"EU VAT API", "x-api-slug"=>"eu-vat-api", "description"=>"A developer friendly API to help your business achieve VAT compliance. Are you selling digital services to other EU countries? From Jan 1st 2015 changes to the VAT place of supply are coming into effect. One acceptable way to prove where your customer resides is their IP address. We have removed the headache and cost of you having to geo locate your customers IP address, and workout what VAT rate they should be charged. Simply pass your customers IP address from your application to our API and well return a JSON or XML object of all the current EU VAT rates for that country, or if you already know their country you can lookup the rates from the 2 digit country code.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/vatapi-logo.png", "humanURL"=>"http://vatapi.com", "baseURL"=>"https://vatapi.com//v1", "tags"=>"EU,Relative Data,Service API,Taxes,VAT", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/eu-vat-api/eu-vat-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://vatapi.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-code-pipeline{"apis"=>{"name"=>"AWS Code Pipeline", "x-slug"=>"aws-code-pipeline", "description"=>"AWS Data Pipeline is a web service that helps you reliably process and move data between different AWS compute and storage services, as well as on-premise data sources, at specified intervals. With AWS Data Pipeline, you can regularly access your data where it’s stored, transform and process it at scale, and efficiently transfer the results to AWS services such as Amazon S3, Amazon RDS, Amazon DynamoDB, and Amazon EMR.AWS Data Pipeline helps you easily create complex data processing workloads that are fault tolerant, repeatable, and highly available. You don’t have to worry about ensuring resource availability, managing inter-task dependencies, retrying transient failures or timeouts in individual tasks, or creating a failure notification system. AWS Data Pipeline also allows you to move and process data that was previously locked up in on-premise data silos.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Developer-Tools_AWSCodePipeline.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Data,Migrations,Orchestration,Profiles,Relative Data,SDK,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-code-pipeline/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Code Pipeline API", "x-api-slug"=>"aws-code-pipeline-api", "description"=>"AWS Data Pipeline is a web service that helps you reliably process and move data between different AWS compute and storage services, as well as on-premise data sources, at specified intervals. With AWS Data Pipeline, you can regularly access your data where it’s stored, transform and process it at scale, and efficiently transfer the results to AWS services such as Amazon S3, Amazon RDS, Amazon DynamoDB, and Amazon EMR.AWS Data Pipeline helps you easily create complex data processing workloads that are fault tolerant, repeatable, and highly available. You don’t have to worry about ensuring resource availability, managing inter-task dependencies, retrying transient failures or timeouts in individual tasks, or creating a failure notification system. AWS Data Pipeline also allows you to move and process data that was previously locked up in on-premise data silos.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Developer-Tools_AWSCodePipeline.png", "humanURL"=>"https://aws.amazon.com/datapipeline/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Data,Migrations,Orchestration,Profiles,Relative Data,SDK,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-code-pipeline/actionupdatepipeline-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-code-pipeline/aws-code-pipeline-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://blogs.aws.amazon.com/bigdata"}, {"type"=>"x-change-log", "url"=>"http://aws.amazon.com/releasenotes/AWS-Data-Pipeline/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/datapipeline/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/datapipeline/faqs/"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=151"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/datapipeline/pricing/"}, {"type"=>"x-tools", "url"=>"http://aws.amazon.com/developertools/AWS-Data-Pipeline/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/datapipeline/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "aws-code-pipeline-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Code Pipeline", "x-complete"=>1, "info"=>{"title"=>"AWS Code Pipeline API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AcknowledgeJob"=>{"get"=>{"summary"=>"Acknowledge Job", "description"=>"Returns information about a specified job and whether that job has been received by\n the job worker.", "operationId"=>"acknowledgeJob", "x-api-path-slug"=>"actionacknowledgejob-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"jobId", "description"=>"The unique system-generated ID of the job for which you want to confirm receipt", "type"=>"string"}, {"in"=>"query", "name"=>"nonce", "description"=>"A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotId", "description"=>"The ID of the EBS snapshot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Acknowledge", "Job"]}}, "/?Action=AcknowledgeThirdPartyJob"=>{"get"=>{"summary"=>"Acknowledge Third Party Job", "description"=>"Confirms a job worker has received the specified job.", "operationId"=>"acknowledgeThirdPartyJob", "x-api-path-slug"=>"actionacknowledgethirdpartyjob-get", "parameters"=>[{"in"=>"query", "name"=>"clientToken", "description"=>"The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"jobId", "description"=>"The unique system-generated ID of the job", "type"=>"string"}, {"in"=>"query", "name"=>"nonce", "description"=>"A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId", "description"=>"The ID of the volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Acknowledge", "Third", "Party", "Job"]}}, "/?Action=CreateCustomActionType"=>{"get"=>{"summary"=>"Create Custom Action Type", "description"=>"Creates a new custom action that can be used in all pipelines associated with the\n AWS account.", "operationId"=>"createCustomActionType", "x-api-path-slug"=>"actioncreatecustomactiontype-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The snapshot attribute you would like to view", "type"=>"string"}, {"in"=>"query", "name"=>"category", "description"=>"The category of the custom action, such as a build action or a test action", "type"=>"string"}, {"in"=>"query", "name"=>"configurationProperties", "description"=>"The configuration properties for the custom action", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"inputArtifactDetails", "description"=>"Returns information about the details of an artifact", "type"=>"string"}, {"in"=>"query", "name"=>"outputArtifactDetails", "description"=>"Returns information about the details of an artifact", "type"=>"string"}, {"in"=>"query", "name"=>"provider", "description"=>"The provider of the service used in the custom action, such as AWS CodeDeploy", "type"=>"string"}, {"in"=>"query", "name"=>"settings", "description"=>"Returns information about the settings for an action type", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotId", "description"=>"The ID of the EBS snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"version", "description"=>"The version identifier of the custom action", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Action", "Type"]}}, "/?Action=CreatePipeline"=>{"get"=>{"summary"=>"Create Pipeline", "description"=>"Creates a pipeline.", "operationId"=>"createPipeline", "x-api-path-slug"=>"actioncreatepipeline-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of snapshot results returned by DescribeSnapshots in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter", "type"=>"string"}, {"in"=>"query", "name"=>"Owner.N", "description"=>"Returns the snapshots owned by the specified owner", "type"=>"string"}, {"in"=>"query", "name"=>"pipeline", "description"=>"Represents the structure of actions and stages to be performed in the pipeline", "type"=>"string"}, {"in"=>"query", "name"=>"RestorableBy.N", "description"=>"One or more AWS accounts IDs that can create volumes from the snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotId.N", "description"=>"One or more snapshot IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipeline"]}}, "/?Action=DeleteCustomActionType"=>{"get"=>{"summary"=>"Delete Custom Action Type", "description"=>"Marks a custom action as deleted.", "operationId"=>"deleteCustomActionType", "x-api-path-slug"=>"actiondeletecustomactiontype-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The instance attribute", "type"=>"string"}, {"in"=>"query", "name"=>"category", "description"=>"The category of the custom action that you want to delete, such as source or deploy", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"provider", "description"=>"The provider of the service used in the custom action, such as AWS CodeDeploy", "type"=>"string"}, {"in"=>"query", "name"=>"version", "description"=>"The version of the custom action to delete", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId", "description"=>"The ID of the volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Action", "Type"]}}, "/?Action=DeletePipeline"=>{"get"=>{"summary"=>"Delete Pipeline", "description"=>"Deletes the specified pipeline.", "operationId"=>"deletePipeline", "x-api-path-slug"=>"actiondeletepipeline-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of volume results returned by DescribeVolumes in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the pipeline to be deleted", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId.N", "description"=>"One or more volume IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipeline"]}}, "/?Action=DisableStageTransition"=>{"get"=>{"summary"=>"Disable Stage Transition", "description"=>"Prevents artifacts in a pipeline from transitioning to the next stage in the\n pipeline.", "operationId"=>"disableStageTransition", "x-api-path-slug"=>"actiondisablestagetransition-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of volume results returned by DescribeVolumeStatus in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The NextToken value to include in a future DescribeVolumeStatus request", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineName", "description"=>"The name of the pipeline in which you want to disable the flow of artifacts from one stage to another", "type"=>"string"}, {"in"=>"query", "name"=>"reason", "description"=>"The reason given to the user why a stage is disabled, such as waiting for manual approval or manual tests", "type"=>"string"}, {"in"=>"query", "name"=>"stageName", "description"=>"The name of the stage where you want to disable the inbound or outbound transition of artifacts", "type"=>"string"}, {"in"=>"query", "name"=>"transitionType", "description"=>"Specifies whether artifacts will be prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound)", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId.N", "description"=>"One or more volume IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disable", "Stage", "Transition"]}}, "/?Action=EnableStageTransition"=>{"get"=>{"summary"=>"Enable Stage Transition", "description"=>"Enables artifacts in a pipeline to transition to a stage in a pipeline.", "operationId"=>"enableStageTransition", "x-api-path-slug"=>"actionenablestagetransition-get", "parameters"=>[{"in"=>"query", "name"=>"Device", "description"=>"The device name", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Force", "description"=>"Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally)", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineName", "description"=>"The name of the pipeline in which you want to enable the flow of artifacts from one stage to another", "type"=>"string"}, {"in"=>"query", "name"=>"stageName", "description"=>"The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound)", "type"=>"string"}, {"in"=>"query", "name"=>"transitionType", "description"=>"Specifies whether artifacts will be allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already-processed artifacts will be allowed to transition to the next stage (outbound)", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId", "description"=>"The ID of the volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Enable", "Stage", "Transition"]}}, "/?Action=GetJobDetails"=>{"get"=>{"summary"=>"Get Job Details", "description"=>"Returns information about a job.", "operationId"=>"getJobDetails", "x-api-path-slug"=>"actiongetjobdetails-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"jobId", "description"=>"The unique system-generated ID for the job", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId", "description"=>"The ID of the volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "Details"]}}, "/?Action=GetPipeline"=>{"get"=>{"summary"=>"Get Pipeline", "description"=>"Returns the metadata, structure, stages, and actions of a pipeline.", "operationId"=>"getPipeline", "x-api-path-slug"=>"actiongetpipeline-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The snapshot attribute to modify", "type"=>"string"}, {"in"=>"query", "name"=>"CreateVolumePermission", "description"=>"A JSON representation of the snapshot attribute modification", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the pipeline for which you want to get information", "type"=>"string"}, {"in"=>"query", "name"=>"OperationType", "description"=>"The type of operation to perform to the attribute", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotId", "description"=>"The ID of the snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"UserGroup.N", "description"=>"The group to modify for the snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"UserId.N", "description"=>"The account ID to modify for the snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"version", "description"=>"The version number of the pipeline", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipeline"]}}, "/?Action=GetPipelineExecution"=>{"get"=>{"summary"=>"Get Pipeline Execution", "description"=>"Returns information about an execution of a pipeline, including details about\n artifacts, the pipeline execution ID, and the name, version, and status of the\n pipeline.", "operationId"=>"getPipelineExecution", "x-api-path-slug"=>"actiongetpipelineexecution-get", "parameters"=>[{"in"=>"query", "name"=>"AutoEnableIO", "description"=>"Indicates whether the volume should be auto-enabled for I/O operations", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineExecutionId", "description"=>"The ID of the pipeline execution about which you want to get execution details", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineName", "description"=>"The name of the pipeline about which you want to get execution details", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId", "description"=>"The ID of the volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipeline", "Execution"]}}, "/?Action=GetPipelineState"=>{"get"=>{"summary"=>"Get Pipeline State", "description"=>"Returns information about the state of a pipeline, including the stages and\n actions.", "operationId"=>"getPipelineState", "x-api-path-slug"=>"actiongetpipelinestate-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The attribute to reset", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the pipeline about which you want to get information", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotId", "description"=>"The ID of the snapshot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipeline", "State"]}}, "/?Action=GetThirdPartyJobDetails"=>{"get"=>{"summary"=>"Get Third Party Job Details", "description"=>"Requests the details of a job for a third party action.", "operationId"=>"getThirdPartyJobDetails", "x-api-path-slug"=>"actiongetthirdpartyjobdetails-get", "parameters"=>[{"in"=>"query", "name"=>"clientToken", "description"=>"The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details", "type"=>"string"}, {"in"=>"query", "name"=>"Domain", "description"=>"Set to vpc to allocate the address for use with instances in a VPC", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"jobId", "description"=>"The unique system-generated ID used for identifying the job", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Third", "Party", "Job", "Details"]}}, "/?Action=ListActionTypes"=>{"get"=>{"summary"=>"List Action Types", "description"=>"Gets a summary of all AWS CodePipeline action types associated with your\n account.", "operationId"=>"listActionTypes", "x-api-path-slug"=>"actionlistactiontypes-get", "parameters"=>[{"in"=>"query", "name"=>"actionOwnerFilter", "description"=>"Filters the list of action types to those created by a specified entity", "type"=>"string"}, {"in"=>"query", "name"=>"AllocationId", "description"=>"[EC2-VPC] The allocation ID", "type"=>"string"}, {"in"=>"query", "name"=>"AllowReassociation", "description"=>"[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"[EC2-VPC] The ID of the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list", "type"=>"string"}, {"in"=>"query", "name"=>"PrivateIpAddress", "description"=>"[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address", "type"=>"string"}, {"in"=>"query", "name"=>"PublicIp", "description"=>"The Elastic IP address", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Action", "Types"]}}, "/?Action=ListPipelines"=>{"get"=>{"summary"=>"List Pipelines", "description"=>"Gets a summary of all of the pipelines associated with your account.", "operationId"=>"listPipelines", "x-api-path-slug"=>"actionlistpipelines-get", "parameters"=>[{"in"=>"query", "name"=>"AllocationId.N", "description"=>"[EC2-VPC] One or more allocation IDs", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous list pipelines call, which can be used to return the next set of pipelines in the list", "type"=>"string"}, {"in"=>"query", "name"=>"PublicIp.N", "description"=>"[EC2-Classic] One or more Elastic IP addresses", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Pipelines"]}}, "/?Action=PollForJobs"=>{"get"=>{"summary"=>"Poll For Jobs", "description"=>"Returns information about any jobs for AWS CodePipeline to act upon.", "operationId"=>"pollForJobs", "x-api-path-slug"=>"actionpollforjobs-get", "parameters"=>[{"in"=>"query", "name"=>"actionTypeId", "description"=>"Represents information about an action type", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Filter.N", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"maxBatchSize", "description"=>"The maximum number of jobs to return in a poll for jobs call", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of results to return for the request in a single page", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token to use to retrieve the next page of results", "type"=>"string"}, {"in"=>"query", "name"=>"PublicIp.N", "description"=>"One or more Elastic IP addresses", "type"=>"string"}, {"in"=>"query", "name"=>"queryParam", "description"=>"A map of property names and values", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PollJobs"]}}, "/?Action=PollForThirdPartyJobs"=>{"get"=>{"summary"=>"Poll For Third Party Jobs", "description"=>"Determines whether there are any third party jobs for a job worker to act on.", "operationId"=>"pollForThirdPartyJobs", "x-api-path-slug"=>"actionpollforthirdpartyjobs-get", "parameters"=>[{"in"=>"query", "name"=>"actionTypeId", "description"=>"Represents information about an action type", "type"=>"string"}, {"in"=>"query", "name"=>"AssociationId", "description"=>"[EC2-VPC] The association ID", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"maxBatchSize", "description"=>"The maximum number of jobs to return in a poll for jobs call", "type"=>"string"}, {"in"=>"query", "name"=>"PublicIp", "description"=>"[EC2-Classic] The Elastic IP address", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PollThird", "Party", "Jobs"]}}, "/?Action=PutActionRevision"=>{"get"=>{"summary"=>"Put Action Revision", "description"=>"Provides information to AWS CodePipeline about new revisions to a source.", "operationId"=>"putActionRevision", "x-api-path-slug"=>"actionputactionrevision-get", "parameters"=>[{"in"=>"query", "name"=>"actionName", "description"=>"The name of the action that will process the revision", "type"=>"string"}, {"in"=>"query", "name"=>"actionRevision", "description"=>"Represents information about the version (or revision) of an action", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineName", "description"=>"The name of the pipeline that will start processing the revision to the source", "type"=>"string"}, {"in"=>"query", "name"=>"PublicIp", "description"=>"The Elastic IP address", "type"=>"string"}, {"in"=>"query", "name"=>"stageName", "description"=>"The name of the stage that contains the action that will act upon the revision", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Put", "Action", "Revision"]}}, "/?Action=PutApprovalResult"=>{"get"=>{"summary"=>"Put Approval Result", "description"=>"Provides the response to a manual approval request to AWS CodePipeline.", "operationId"=>"putApprovalResult", "x-api-path-slug"=>"actionputapprovalresult-get", "parameters"=>[{"in"=>"query", "name"=>"actionName", "description"=>"The name of the action for which approval is requested", "type"=>"string"}, {"in"=>"query", "name"=>"AllocationId", "description"=>"[EC2-VPC] The allocation ID", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineName", "description"=>"The name of the pipeline that contains the action", "type"=>"string"}, {"in"=>"query", "name"=>"PublicIp", "description"=>"[EC2-Classic] The Elastic IP address", "type"=>"string"}, {"in"=>"query", "name"=>"result", "description"=>"Represents information about the result of the approval request", "type"=>"string"}, {"in"=>"query", "name"=>"stageName", "description"=>"The name of the stage that contains the action", "type"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"The system-generated token used to identify a unique approval request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Put", "Approval", "Result"]}}, "/?Action=PutJobFailureResult"=>{"get"=>{"summary"=>"Put Job Failure Result", "description"=>"Represents the failure of a job as returned to the pipeline by a job worker.", "operationId"=>"putJobFailureResult", "x-api-path-slug"=>"actionputjobfailureresult-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"failureDetails", "description"=>"The details about the failure of a job", "type"=>"string"}, {"in"=>"query", "name"=>"jobId", "description"=>"The unique system-generated ID of the job that failed", "type"=>"string"}, {"in"=>"query", "name"=>"PublicIp", "description"=>"The Elastic IP address", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Put", "Job", "Failure", "Result"]}}, "/?Action=PutJobSuccessResult"=>{"get"=>{"summary"=>"Put Job Success Result", "description"=>"Represents the success of a job as returned to the pipeline by a job worker.", "operationId"=>"putJobSuccessResult", "x-api-path-slug"=>"actionputjobsuccessresult-get", "parameters"=>[{"in"=>"query", "name"=>"continuationToken", "description"=>"A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress", "type"=>"string"}, {"in"=>"query", "name"=>"currentRevision", "description"=>"The ID of the current revision of the artifact successfully worked upon by the job", "type"=>"string"}, {"in"=>"query", "name"=>"executionDetails", "description"=>"The execution details of the successful job, such as the actions taken by the job worker", "type"=>"string"}, {"in"=>"query", "name"=>"Ipv6AddressCount", "description"=>"The number of IPv6 addresses to assign to the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"Ipv6Addresses.N", "description"=>"One or more specific IPv6 addresses to be assigned to the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"jobId", "description"=>"The unique system-generated ID of the job that succeeded", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The ID of the network interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Put", "Job", "Success", "Result"]}}, "/?Action=PutThirdPartyJobFailureResult"=>{"get"=>{"summary"=>"Put Third Party Job Failure Result", "description"=>"Represents the failure of a third party job as returned to the pipeline by a job\n worker.", "operationId"=>"putThirdPartyJobFailureResult", "x-api-path-slug"=>"actionputthirdpartyjobfailureresult-get", "parameters"=>[{"in"=>"query", "name"=>"AllowReassignment", "description"=>"Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface", "type"=>"string"}, {"in"=>"query", "name"=>"clientToken", "description"=>"The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details", "type"=>"string"}, {"in"=>"query", "name"=>"failureDetails", "description"=>"Represents information about failure details", "type"=>"string"}, {"in"=>"query", "name"=>"jobId", "description"=>"The ID of the job that failed", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The ID of the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"PrivateIpAddress.N", "description"=>"One or more IP addresses to be assigned as a secondary private IP address to the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"SecondaryPrivateIpAddressCount", "description"=>"The number of secondary IP addresses to assign to the network interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Put", "Third", "Party", "Job", "Failure", "Result"]}}, "/?Action=PutThirdPartyJobSuccessResult"=>{"get"=>{"summary"=>"Put Third Party Job Success Result", "description"=>"Represents the success of a third party job as returned to the pipeline by a job\n worker.", "operationId"=>"putThirdPartyJobSuccessResult", "x-api-path-slug"=>"actionputthirdpartyjobsuccessresult-get", "parameters"=>[{"in"=>"query", "name"=>"clientToken", "description"=>"The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details", "type"=>"string"}, {"in"=>"query", "name"=>"continuationToken", "description"=>"A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress", "type"=>"string"}, {"in"=>"query", "name"=>"currentRevision", "description"=>"Represents information about a current revision", "type"=>"string"}, {"in"=>"query", "name"=>"DeviceIndex", "description"=>"The index of the device for the network interface attachment", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"executionDetails", "description"=>"The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"jobId", "description"=>"The ID of the job that successfully completed", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The ID of the network interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Put", "Third", "Party", "Job", "Success", "Result"]}}, "/?Action=RetryStageExecution"=>{"get"=>{"summary"=>"Retry Stage Execution", "description"=>"Resumes the pipeline execution by retrying the last failed actions in a\n stage.", "operationId"=>"retryStageExecution", "x-api-path-slug"=>"actionretrystageexecution-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"A description for the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"Ipv6AddressCount", "description"=>"The number of IPv6 addresses to assign to a network interface", "type"=>"string"}, {"in"=>"query", "name"=>"Ipv6Addresses.N", "description"=>"One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineExecutionId", "description"=>"The ID of the pipeline execution in the failed stage to be retried", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineName", "description"=>"The name of the pipeline that contains the failed stage", "type"=>"string"}, {"in"=>"query", "name"=>"PrivateIpAddress", "description"=>"The primary private IPv4 address of the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"PrivateIpAddresses.N", "description"=>"One or more private IPv4 addresses", "type"=>"string"}, {"in"=>"query", "name"=>"retryMode", "description"=>"The scope of the retry attempt", "type"=>"string"}, {"in"=>"query", "name"=>"SecondaryPrivateIpAddressCount", "description"=>"The number of secondary private IPv4 addresses to assign to a network interface", "type"=>"string"}, {"in"=>"query", "name"=>"SecurityGroupId.N", "description"=>"The IDs of one or more security groups", "type"=>"string"}, {"in"=>"query", "name"=>"stageName", "description"=>"The name of the failed stage to be retried", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetId", "description"=>"The ID of the subnet to associate with the network interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retry", "Stage", "Execution"]}}, "/?Action=StartPipelineExecution"=>{"get"=>{"summary"=>"Start Pipeline Execution", "description"=>"Starts the specified pipeline.", "operationId"=>"startPipelineExecution", "x-api-path-slug"=>"actionstartpipelineexecution-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the pipeline to start", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The ID of the network interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Start", "Pipeline", "Execution"]}}, "/?Action=UpdatePipeline"=>{"get"=>{"summary"=>"Update Pipeline", "description"=>"Updates a specified pipeline with edits or changes to its structure.", "operationId"=>"updatePipeline", "x-api-path-slug"=>"actionupdatepipeline-get", "parameters"=>[{"in"=>"query", "name"=>"Attribute", "description"=>"The attribute of the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The ID of the network interface", "type"=>"string"}, {"in"=>"query", "name"=>"pipeline", "description"=>"The name of the pipeline to be updated", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipeline"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
boxcar{"box-car-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Boxcar", "x-complete"=>1, "info"=>{"title"=>"Box Car", "description"=>"add-boxcar-services-to-your-app-so-users-can-get-messages-and-update-all-their-favorite-social-services-", "version"=>"1.0.0"}, "host"=>"boxcar.io", "basePath"=>"/devices/providers/%7Bprovider_key%7D/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/notifications/subscribe"=>{"post"=>{"summary"=>"Subscribe to Provider", "description"=>"This sends the user with the matching e-mail address a push notification which requests that they add your service. This will ease integration with your website, as you will have already registered them on your system and can identify whom they are based on their Boxcar e-mail address. Please note, this API call is an exception and will return an HTTP status code of 404 if we are unable to find the registered user by e-mail in our system. If the email address is not found in our system, we'll send an email to it letting the user know where they can download Boxcar. If the user has already added your service, we'll return an HTTP status code of 401.", "operationId"=>"Create_subscribeToProvider_", "x-api-path-slug"=>"notificationssubscribe-post", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"The users e-mail address"}, {"in"=>"query", "name"=>"provider_key", "description"=>"The API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Subscriptions"]}}}}, "apis"=>{"name"=>"Boxcar", "x-slug"=>"boxcar", "description"=>"For Developers: a push platform with SDKs, APIs and admin console.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/714-boxcar.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"1280273", "tags"=>"API Provider,internet,Mobile,Notifications,Notifications,Profiles,Relative Data,SaaS,Service API,Social,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"boxcar/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Box Car", "x-api-slug"=>"box-car", "description"=>"For Developers: a push platform with SDKs, APIs and admin console.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/714-boxcar.jpg", "humanURL"=>"http://boxcar.io", "baseURL"=>"https://boxcar.io//devices/providers/%7Bprovider_key%7D/", "tags"=>"API Provider,internet,Mobile,Notifications,Notifications,Profiles,Relative Data,SaaS,Service API,Social,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/boxcar/notificationssubscribe-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/boxcar/box-car-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://blog.boxcar.io"}, {"type"=>"x-blog-rss", "url"=>"http://blog.boxcar.io/rss"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/boxcar"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/boxcar"}, {"type"=>"x-developer", "url"=>"https://boxcar.io/developer"}, {"type"=>"x-email", "url"=>"help@boxcar.io"}, {"type"=>"x-github", "url"=>"https://github.com/boxcar"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/boxcar"}, {"type"=>"x-website", "url"=>"http://boxcar.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
giphy{"giphy-gif-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Giphy", "x-complete"=>1, "info"=>{"title"=>"Giphy", "description"=>"natively-embed-all-the-best-features-of-the-worlds-largest-and-most-powerful-gif-library-into-your-app-", "termsOfService"=>"https://developers.giphy.com/", "version"=>"v1"}, "host"=>"api.giphy.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/gifs"=>{"get"=>{"summary"=>"Get GIFs by ID", "description"=>"A multiget version of the get GIF by ID endpoint.", "operationId"=>"getGifsById", "x-api-path-slug"=>"gifs-get", "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Gifs"]}}, "/gifs/random"=>{"get"=>{"summary"=>"Random GIF", "description"=>"Returns a random GIF, limited by tag. Excluding the tag parameter will return a random GIF from the GIPHY catalog.", "operationId"=>"randomGif", "x-api-path-slug"=>"gifsrandom-get", "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Gifs", "Random"]}}, "/gifs/search"=>{"get"=>{"summary"=>"Search GIFs", "description"=>"Search all GIPHY GIFs for a word or phrase. Punctuation will be stripped and ignored. Use a plus or url encode for phrases. Example paul+rudd, ryan+gosling or american+psycho.", "operationId"=>"searchGifs", "x-api-path-slug"=>"gifssearch-get", "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Gifs", "Search"]}}, "/gifs/translate"=>{"get"=>{"summary"=>"Translate phrase to GIF", "description"=>"The translate API draws on search, but uses the GIPHY `special sauce` to handle translating from one vocabulary to another. In this case, words and phrases to GIF", "operationId"=>"translateGif", "x-api-path-slug"=>"gifstranslate-get", "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Gifs", "Translate"]}}, "/gifs/trending"=>{"get"=>{"summary"=>"Trending GIFs", "description"=>"Fetch GIFs currently trending online. Hand curated by the GIPHY editorial team. The data returned mirrors the GIFs showcased on the GIPHY homepage. Returns 25 results by default.", "operationId"=>"trendingGifs", "x-api-path-slug"=>"gifstrending-get", "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Gifs", "Trending"]}}, "/gifs/{gifId}"=>{"get"=>{"summary"=>"Get GIF by Id", "description"=>"Returns a GIF given that GIF's unique ID", "operationId"=>"getGifById", "x-api-path-slug"=>"gifsgifid-get", "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Gifs", "Gif"]}}, "/stickers/random"=>{"get"=>{"summary"=>"Random Sticker", "description"=>"Returns a random GIF, limited by tag. Excluding the tag parameter will return a random GIF from the GIPHY catalog.", "operationId"=>"randomSticker", "x-api-path-slug"=>"stickersrandom-get", "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Stickers", "Random"]}}, "/stickers/search"=>{"get"=>{"summary"=>"Search Stickers", "description"=>"Replicates the functionality and requirements of the classic GIPHY search, but returns animated stickers rather than GIFs.", "operationId"=>"searchStickers", "x-api-path-slug"=>"stickerssearch-get", "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Stickers", "Search"]}}, "/stickers/translate"=>{"get"=>{"summary"=>"Translate phrase to Sticker", "description"=>"The translate API draws on search, but uses the GIPHY `special sauce` to handle translating from one vocabulary to another. In this case, words and phrases to GIFs.", "operationId"=>"translateSticker", "x-api-path-slug"=>"stickerstranslate-get", "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Stickers", "Translate"]}}, "/stickers/trending"=>{"get"=>{"summary"=>"Trending Stickers", "description"=>"Fetch Stickers currently trending online. Hand curated by the GIPHY editorial team. Returns 25 results by default.", "operationId"=>"trendingStickers", "x-api-path-slug"=>"stickerstrending-get", "responses"=>{1=>{"description"=>"User not found"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Stickers", "Trending"]}}}}, "apis"=>{"name"=>"Giphy", "x-slug"=>"giphy", "description"=>"Giphy is a search engine for GIFs. Animated GIFs have existed for decades, but there was still no good way to browse and discover the best the web had to offer. And the vision for Giphy isn’t really just about finding GIFs. It’s a search engine today but soon you’ll see it grow into a community, a platform with a host of features targeted at gif artists, enthusiasts, bloggers, and anyone generally looking to discover or create that next big meme.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/giphy-logo.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,General Data,Gifs,Images,Indie EdTech Data Jam,Profiles,Relative Data,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"giphy/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Giphy Gif API", "x-api-slug"=>"giphy-gif-api", "description"=>"Giphy is an animated search engine for discovering and sharing GIF images. Giphy exposes its search capabilities through a RESTlike API. The API is comprised of nine JSON endpoints, allowing developers to search for GIFs using a variety of filters and search parameters.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/giphy-logo.png", "humanURL"=>"https://giphy.com", "baseURL"=>"http://api.giphy.com//v1", "tags"=>"API Provider,General Data,Gifs,Images,Indie EdTech Data Jam,Profiles,Relative Data,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/giphy/stickerstrending-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/giphy/giphy-gif-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://blog.giphy.com/"}, {"type"=>"x-developer", "url"=>"https://api.giphy.com/"}, {"type"=>"x-github", "url"=>"https://github.com/Giphy"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/giphy"}, {"type"=>"x-website", "url"=>"https://giphy.com"}, {"type"=>"x-website", "url"=>"http://giphy.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-tasks{"google-tasks-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Tasks", "x-complete"=>1, "info"=>{"title"=>"Tasks", "description"=>"lets-you-manage-your-tasks-and-task-lists-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"www.googleapis.com", "basePath"=>"/tasks/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/lists/{tasklist}/clear"=>{"post"=>{"summary"=>"Add Lists Task List Clear", "description"=>"Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list.", "operationId"=>"tasks.tasks.clear", "x-api-path-slug"=>"liststasklistclear-post", "parameters"=>[{"in"=>"path", "name"=>"tasklist", "description"=>"Task list identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Task", "List", "Clear"]}}, "/lists/{tasklist}/tasks"=>{"get"=>{"summary"=>"Get Lists Task List Tasks", "description"=>"Returns all tasks in the specified task list.", "operationId"=>"tasks.tasks.list", "x-api-path-slug"=>"liststasklisttasks-get", "parameters"=>[{"in"=>"query", "name"=>"completedMax", "description"=>"Upper bound for a tasks completion date (as a RFC 3339 timestamp) to filter by"}, {"in"=>"query", "name"=>"completedMin", "description"=>"Lower bound for a tasks completion date (as a RFC 3339 timestamp) to filter by"}, {"in"=>"query", "name"=>"dueMax", "description"=>"Upper bound for a tasks due date (as a RFC 3339 timestamp) to filter by"}, {"in"=>"query", "name"=>"dueMin", "description"=>"Lower bound for a tasks due date (as a RFC 3339 timestamp) to filter by"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of task lists returned on one page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token specifying the result page to return"}, {"in"=>"query", "name"=>"showCompleted", "description"=>"Flag indicating whether completed tasks are returned in the result"}, {"in"=>"query", "name"=>"showDeleted", "description"=>"Flag indicating whether deleted tasks are returned in the result"}, {"in"=>"query", "name"=>"showHidden", "description"=>"Flag indicating whether hidden tasks are returned in the result"}, {"in"=>"path", "name"=>"tasklist", "description"=>"Task list identifier"}, {"in"=>"query", "name"=>"updatedMin", "description"=>"Lower bound for a tasks last modification time (as a RFC 3339 timestamp) to filter by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Task", "List", "Tasks"]}, "post"=>{"summary"=>"Add Lists Task List Tasks", "description"=>"Creates a new task on the specified task list.", "operationId"=>"tasks.tasks.insert", "x-api-path-slug"=>"liststasklisttasks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"parent", "description"=>"Parent task identifier"}, {"in"=>"query", "name"=>"previous", "description"=>"Previous sibling task identifier"}, {"in"=>"path", "name"=>"tasklist", "description"=>"Task list identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Task", "List", "Tasks"]}}, "/lists/{tasklist}/tasks/{task}"=>{"delete"=>{"summary"=>"Delete Lists Task List Tasks Task", "description"=>"Deletes the specified task from the task list.", "operationId"=>"tasks.tasks.delete", "x-api-path-slug"=>"liststasklisttaskstask-delete", "parameters"=>[{"in"=>"path", "name"=>"task", "description"=>"Task identifier"}, {"in"=>"path", "name"=>"tasklist", "description"=>"Task list identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Task", "List", "Tasks", "Task"]}, "get"=>{"summary"=>"Get Lists Task List Tasks Task", "description"=>"Returns the specified task.", "operationId"=>"tasks.tasks.get", "x-api-path-slug"=>"liststasklisttaskstask-get", "parameters"=>[{"in"=>"path", "name"=>"task", "description"=>"Task identifier"}, {"in"=>"path", "name"=>"tasklist", "description"=>"Task list identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Task", "List", "Tasks", "Task"]}, "patch"=>{"summary"=>"Patch Lists Task List Tasks Task", "description"=>"Updates the specified task. This method supports patch semantics.", "operationId"=>"tasks.tasks.patch", "x-api-path-slug"=>"liststasklisttaskstask-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"task", "description"=>"Task identifier"}, {"in"=>"path", "name"=>"tasklist", "description"=>"Task list identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Task", "List", "Tasks", "Task"]}, "put"=>{"summary"=>"Put Lists Task List Tasks Task", "description"=>"Updates the specified task.", "operationId"=>"tasks.tasks.update", "x-api-path-slug"=>"liststasklisttaskstask-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"task", "description"=>"Task identifier"}, {"in"=>"path", "name"=>"tasklist", "description"=>"Task list identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Task", "List", "Tasks", "Task"]}}, "/lists/{tasklist}/tasks/{task}/move"=>{"post"=>{"summary"=>"Add Lists Task List Tasks Task Move", "description"=>"Moves the specified task to another position in the task list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks.", "operationId"=>"tasks.tasks.move", "x-api-path-slug"=>"liststasklisttaskstaskmove-post", "parameters"=>[{"in"=>"query", "name"=>"parent", "description"=>"New parent task identifier"}, {"in"=>"query", "name"=>"previous", "description"=>"New previous sibling task identifier"}, {"in"=>"path", "name"=>"task", "description"=>"Task identifier"}, {"in"=>"path", "name"=>"tasklist", "description"=>"Task list identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Task", "List", "Tasks", "Task", "Move"]}}, "/users/@me/lists"=>{"get"=>{"summary"=>"Get Users @me Lists", "description"=>"Returns all the authenticated user's task lists.", "operationId"=>"tasks.tasklists.list", "x-api-path-slug"=>"usersmelists-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of task lists returned on one page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token specifying the result page to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "@me", "Lists"]}, "post"=>{"summary"=>"Add Users @me Lists", "description"=>"Creates a new task list and adds it to the authenticated user's task lists.", "operationId"=>"tasks.tasklists.insert", "x-api-path-slug"=>"usersmelists-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "@me", "Lists"]}}, "/users/@me/lists/{tasklist}"=>{"delete"=>{"summary"=>"Delete Users Task List", "description"=>"Deletes the authenticated user's specified task list.", "operationId"=>"tasks.tasklists.delete", "x-api-path-slug"=>"usersmeliststasklist-delete", "parameters"=>[{"in"=>"path", "name"=>"tasklist", "description"=>"Task list identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Task", "List"]}, "get"=>{"summary"=>"Get Users Task List", "description"=>"Returns the authenticated user's specified task list.", "operationId"=>"tasks.tasklists.get", "x-api-path-slug"=>"usersmeliststasklist-get", "parameters"=>[{"in"=>"path", "name"=>"tasklist", "description"=>"Task list identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Task", "List"]}, "patch"=>{"summary"=>"Patch Users Task List", "description"=>"Updates the authenticated user's specified task list. This method supports patch semantics.", "operationId"=>"tasks.tasklists.patch", "x-api-path-slug"=>"usersmeliststasklist-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tasklist", "description"=>"Task list identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Task", "List"]}, "put"=>{"summary"=>"Put Users Task List", "description"=>"Updates the authenticated user's specified task list.", "operationId"=>"tasks.tasklists.update", "x-api-path-slug"=>"usersmeliststasklist-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tasklist", "description"=>"Task list identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Task", "List"]}}}}, "apis"=>{"name"=>"Google Tasks", "x-slug"=>"google-tasks", "description"=>"The Google Tasks API lets you search, read, and update Google Tasks content and metadata. This document describes how to use a RESTful calling style and client libraries for various programming languages (currently Java, Python, and PHP) to access and edit Google Tasks data.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-tasks-icon.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Service API,Stack Network,Tasks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-tasks/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Tasks API", "x-api-slug"=>"google-tasks-api", "description"=>"The Google Tasks API lets you search, read, and update Google Tasks content and metadata. This document describes how to use a RESTful calling style and client libraries for various programming languages (currently Java, Python, and PHP) to access and edit Google Tasks data.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-tasks-icon.png", "humanURL"=>"https://developers.google.com/google-apps/tasks/", "baseURL"=>"://www.googleapis.com//tasks/v1", "tags"=>"API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Service API,Stack Network,Tasks", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-tasks/google-tasks-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-code", "url"=>"https://developers.google.com/google-apps/tasks/setup"}, {"type"=>"x-concepts", "url"=>"https://developers.google.com/google-apps/tasks/concepts"}, {"type"=>"x-documentation", "url"=>"https://developers.google.com/google-apps/tasks/v1/reference/"}, {"type"=>"x-website", "url"=>"https://developers.google.com/google-apps/tasks/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
weatherbit-io{"apis"=>{"name"=>"Weatherbit.io", "x-slug"=>"weatherbit-io", "description"=>"Our Weather API is the most powerful Weather data API on the web. Sign up for our free Weather API, and upgrade as your weather data needs grow!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28119-weatherbit.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"1016253", "tags"=>"Broadcasts,General Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Weather", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"weatherbit-io/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Weatherbit", "x-api-slug"=>"weatherbit", "description"=>"Our Weather API is the most powerful Weather data API on the web. Sign up for our free Weather API, and upgrade as your weather data needs grow!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28119-weatherbit.jpg", "humanURL"=>"http://weatherbit.io", "baseURL"=>"https://api.weatherbit.io//v2.0", "tags"=>"Broadcasts,General Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Weather", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/weatherbit-io/ipipip-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/weatherbit-io/weatherbit-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://www.weatherbit.io/blog"}, {"type"=>"x-contact-form", "url"=>"https://www.weatherbit.io/contact"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/product/weather-it-"}, {"type"=>"x-documentation", "url"=>"https://www.weatherbit.io/api"}, {"type"=>"x-email", "url"=>"support@weatherbit.io"}, {"type"=>"x-github", "url"=>"https://github.com/weatherbit"}, {"type"=>"x-pricing", "url"=>"https://www.weatherbit.io/pricing"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/weatherbitio"}, {"type"=>"x-website", "url"=>"http://weatherbit.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "weatherbit-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Weatherbit.io", "x-complete"=>1, "info"=>{"title"=>"Weatherbit", "description"=>"this-is-the-documentation-for-the-weatherbit-api---the-base-url-for-the-api-is-httpapi-weatherbit-iov2-0httpapi-weatherbit-iov2-0-or-httpsapi-weatherbit-iov2-0httpapi-weatherbit-iov2-0--below-is-the-swagger-ui-documentation-for-the-api--all-api-requests-require-the-key-parameter---------an-example-for-a-5-day-forecast-for-london-uk-would-be-httpapi-weatherbit-iov2-0forecast3hourlycitylondoncountryuk", "version"=>"2.0.0"}, "host"=>"api.weatherbit.io", "basePath"=>"/v2.0", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/bulk/history/daily?city={city}&country={country}"=>{"get"=>{"summary"=>"Get Bulk History Daily City Country", "description"=>"Returns Historical Observations - Given a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate.", "operationId"=>"returns-historical-observations--given-a-city-in-the-format-of-cityst-or-city-the-state-and-country-", "x-api-path-slug"=>"bulkhistorydailycitycitycountrycountry-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"path", "name"=>"city", "description"=>"City search"}, {"in"=>"path", "name"=>"country", "description"=>"Country Code (2 letter)"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"state", "description"=>"Full name of state"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Bulk", "History", "Daily", "City", "City", "&country", "Country"]}}, "/bulk/history/daily?city_id={city_id}"=>{"get"=>{"summary"=>"Get Bulk History Daily City", "description"=>"Returns Historical Observations - Given a City ID.", "operationId"=>"returns-historical-observations--given-a-city-id", "x-api-path-slug"=>"bulkhistorydailycity-idcity-id-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"path", "name"=>"city_id", "description"=>"City ID"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Bulk", "History", "Daily", "City", "", "City"]}}, "/bulk/history/daily?ip={ip}"=>{"get"=>{"summary"=>"Get Bulk History Daily IP", "description"=>"Returns Historical Observations - Given IP Address, or auto.", "operationId"=>"returns-historical-observations--given-ip-address-or-auto", "x-api-path-slug"=>"bulkhistorydailyipip-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"path", "name"=>"ip", "description"=>"IP Address, or auto"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Bulk", "History", "Daily", "Ip", "Ip"]}}, "/bulk/history/daily?lat={lat}&lon={lon}"=>{"get"=>{"summary"=>"Get Bulk History Daily Lat Lon", "description"=>"Returns Historical Observations - Given a lat, and lon.", "operationId"=>"returns-historical-observations--given-a-lat-and-lon", "x-api-path-slug"=>"bulkhistorydailylatlatlonlon-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"lat", "description"=>"Latitude component of location"}, {"in"=>"path", "name"=>"lon", "description"=>"Longitude component of location"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Bulk", "History", "Daily", "Lat", "Lat", "&lon", "Lon"]}}, "/bulk/history/daily?postal_code={postal_code}"=>{"get"=>{"summary"=>"Get Bulk History Daily Postal Code", "description"=>"Returns Historical Observations - Given a Postal Code.", "operationId"=>"returns-historical-observations--given-a-postal-code", "x-api-path-slug"=>"bulkhistorydailypostal-codepostal-code-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"country", "description"=>"Country Code (2 letter)"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"postal_code", "description"=>"Postal Code"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Bulk", "History", "Daily", "Postal", "Code", "Postal", "Code"]}}, "/bulk/history/daily?station={station}"=>{"get"=>{"summary"=>"Get Bulk History Daily Station", "description"=>"Returns Historical Observations - Given a station ID.", "operationId"=>"returns-historical-observations--given-a-station-id", "x-api-path-slug"=>"bulkhistorydailystationstation-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"path", "name"=>"station", "description"=>"Station ID"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Bulk", "History", "Daily", "Station", "Station"]}}, "/bulk/history/hourly?city={city}&country={country}"=>{"get"=>{"summary"=>"Get Bulk History Hourly City & Country", "description"=>"Returns Historical Observations - Given a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate.", "operationId"=>"returns-historical-observations--given-a-city-in-the-format-of-cityst-or-city-the-state-and-country-", "x-api-path-slug"=>"bulkhistoryhourlycitycitycountrycountry-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"path", "name"=>"city", "description"=>"City search"}, {"in"=>"path", "name"=>"country", "description"=>"Country Code (2 letter)"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"state", "description"=>"Full name of state"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Bulk", "History", "Hourly", "City", "City", "&country", "Country"]}}, "/bulk/history/hourly?city_id={city_id}"=>{"get"=>{"summary"=>"Get Bulk History Hourly City", "description"=>"Returns Historical Observations - Given a City ID.", "operationId"=>"returns-historical-observations--given-a-city-id", "x-api-path-slug"=>"bulkhistoryhourlycity-idcity-id-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"path", "name"=>"city_id", "description"=>"City ID"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Bulk", "History", "Hourly", "City", "", "City"]}}, "/bulk/history/hourly?ip={ip}"=>{"get"=>{"summary"=>"Get Bulk History Hourly IP", "description"=>"Returns Historical Observations - Given IP Address, or auto.", "operationId"=>"returns-historical-observations--given-ip-address-or-auto", "x-api-path-slug"=>"bulkhistoryhourlyipip-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"path", "name"=>"ip", "description"=>"IP Address, or auto"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Bulk", "History", "Hourly", "Ip", "Ip"]}}, "/bulk/history/hourly?lat={lat}&lon={lon}"=>{"get"=>{"summary"=>"Get Bulk History Hourly Lat & Lon", "description"=>"Returns Historical Observations - Given a lat, and lon.", "operationId"=>"returns-historical-observations--given-a-lat-and-lon", "x-api-path-slug"=>"bulkhistoryhourlylatlatlonlon-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"lat", "description"=>"Latitude component of location"}, {"in"=>"path", "name"=>"lon", "description"=>"Longitude component of location"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Bulk", "History", "Hourly", "Lat", "Lat", "&lon", "Lon"]}}, "/bulk/history/hourly?postal_code={postal_code}"=>{"get"=>{"summary"=>"Get Bulk History Hourly Postal Code", "description"=>"Returns Historical Observations - Given a Postal Code.", "operationId"=>"returns-historical-observations--given-a-postal-code-", "x-api-path-slug"=>"bulkhistoryhourlypostal-codepostal-code-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"country", "description"=>"Country Code (2 letter)"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"postal_code", "description"=>"Postal Code"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Bulk", "History", "Hourly", "Postal", "Code", "Postal", "Code"]}}, "/bulk/history/hourly?station={station}"=>{"get"=>{"summary"=>"Get Bulk History Hourly Station", "description"=>"Returns Historical Observations - Given a station ID.", "operationId"=>"returns-historical-observations--given-a-station-id", "x-api-path-slug"=>"bulkhistoryhourlystationstation-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"path", "name"=>"station", "description"=>"Station ID"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Bulk", "History", "Hourly", "Station", "Station"]}}, "/bulk/{file}"=>{"get"=>{"summary"=>"Get Bulk File", "description"=>"**(Advanced/Advanced+/Enterprise plans only)** Downloads bulk data files - OPTIONS: (forecast16d.json.gz - 16 day forecasts for cities > 1000 population, current.json.gz - Current observations for cities > 1000 population).", "operationId"=>"advancedadvancedenterprise-plans-only-downloads-bulk-data-files--options-forecast16djsongz--16-day-f", "x-api-path-slug"=>"bulkfile-get", "parameters"=>[{"in"=>"path", "name"=>"file", "description"=>"Filename (ie"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Bulk", "File"]}}, "/current?city={city}"=>{"get"=>{"summary"=>"Get Current Cities", "description"=>"**(Advanced/Advanced+/Enterprise plans only)** Returns a group of Current Observations - Given a list of City IDs.", "operationId"=>"advancedadvancedenterprise-plans-only-returns-a-group-of-current-observations--given-a-list-of-city-", "x-api-path-slug"=>"currentcitycity-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback - Example - callback=func"}, {"in"=>"query", "name"=>"cities", "description"=>"Comma separated list of City IDs"}, {"in"=>"query", "name"=>"city", "description"=>"A city name", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"marine", "description"=>"Marine stations only (buoys, oil platforms, etc)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Current", "Cities", "Cities"]}}, "/current?ip={ip}"=>{"get"=>{"summary"=>"Get Current IP", "description"=>"Returns a Current Observation - Given an IP address, or auto.", "operationId"=>"returns-a-current-observation--given-an-ip-address-or-auto", "x-api-path-slug"=>"currentipip-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback - Example - callback=func"}, {"in"=>"path", "name"=>"ip", "description"=>"IP Address, or auto"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"marine", "description"=>"Marine stations only (buoys, oil platforms, etc)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Current", "Ip", "Ip"]}}, "/current?lat={lat}&lon={lon}"=>{"get"=>{"summary"=>"Get Current Lat & Lon", "description"=>"Returns a Current Observation - given a lat, and a lon.", "operationId"=>"returns-a-current-observation--given-a-lat-and-a-lon", "x-api-path-slug"=>"currentlatlatlonlon-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback - Example - callback=func"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"lat", "description"=>"Latitude component of location"}, {"in"=>"path", "name"=>"lon", "description"=>"Longitude component of location"}, {"in"=>"query", "name"=>"marine", "description"=>"Marine stations only (buoys, oil platforms, etc)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Current", "Lat", "Lat", "&lon", "Lon"]}}, "/current?postal_code={postal_code}"=>{"get"=>{"summary"=>"Get Current Postla Code Code", "description"=>"Returns current weather observation - Given a Postal Code.", "operationId"=>"returns-current-weather-observation--given-a-postal-code-", "x-api-path-slug"=>"currentpostal-codepostal-code-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback - Example - callback=func"}, {"in"=>"query", "name"=>"country", "description"=>"Country Code (2 letter)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"marine", "description"=>"Marine stations only (buoys, oil platforms, etc)"}, {"in"=>"path", "name"=>"postal_code", "description"=>"Postal Code"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Current", "Postal", "Code", "Postal", "Code"]}}, "/current?station={station}"=>{"get"=>{"summary"=>"Get Current Station Station", "description"=>"Returns a Current Observation - Given a station ID.", "operationId"=>"returns-a-current-observation--given-a-station-id", "x-api-path-slug"=>"currentstationstation-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"station", "description"=>"Station Call ID"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Current", "Station", "Station"]}}, "/current?stations={stations}"=>{"get"=>{"summary"=>"Get Current Stations Stations", "description"=>"**(Advanced/Advanced+/Enterprise plans only)** Returns a group of Current Observations - Given a list of Station Call IDs.", "operationId"=>"advancedadvancedenterprise-plans-only-returns-a-group-of-current-observations--given-a-list-of-stati", "x-api-path-slug"=>"currentstationsstations-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"stations", "description"=>"Comma separated list of Station Call IDs"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Current", "Stations", "Stations"]}}, "/forecast/3hourly?city={city}&country={country}"=>{"get"=>{"summary"=>"Get Forecast 3hourly City & Country", "description"=>"Returns a 3-hourly forecast, where each point represents a three hour period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC.", "operationId"=>"returns-a-3hourly-forecast-where-each-point-represents-a-three-hour---period-every-point-has-a-datet", "x-api-path-slug"=>"forecast3hourlycitycitycountrycountry-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"path", "name"=>"city", "description"=>"City search"}, {"in"=>"path", "name"=>"country", "description"=>"Country Code (2 letter)"}, {"in"=>"query", "name"=>"days", "description"=>"Number of days to return"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"state", "description"=>"Full name of state"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Forecast", "3hourly", "City", "City", "&country", "Country"]}}, "/forecast/3hourly?city_id={city_id}"=>{"get"=>{"summary"=>"Get Forecast 3hourly City", "description"=>"Returns a 3-hourly forecast, where each point represents a three hour period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC.", "operationId"=>"returns-a-3hourly-forecast-where-each-point-represents-a-three-hour---period-every-point-has-a-datet", "x-api-path-slug"=>"forecast3hourlycity-idcity-id-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"path", "name"=>"city_id", "description"=>"City ID"}, {"in"=>"query", "name"=>"days", "description"=>"Number of days to return"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Forecast", "3hourly", "City", "", "City"]}}, "/forecast/3hourly?ip={ip}"=>{"get"=>{"summary"=>"Get Forecast 3hourly IP", "description"=>"Returns a 3-hourly forecast, where each point represents a three hour period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC.", "operationId"=>"returns-a-3hourly-forecast-where-each-point-represents-a-three-hour---period-every-point-has-a-datet", "x-api-path-slug"=>"forecast3hourlyipip-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"days", "description"=>"Number of days to return"}, {"in"=>"path", "name"=>"ip", "description"=>"IP address, or auto"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Forecast", "3hourly", "Ip", "Ip"]}}, "/forecast/3hourly?lat={lat}&lon={lon}"=>{"get"=>{"summary"=>"Get Forecast 3hourly Lat & Lon", "description"=>"Returns a 3-hourly forecast, where each point represents a three hour period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC.", "operationId"=>"returns-a-3hourly-forecast-where-each-point-represents-a-three-hour---period-every-point-has-a-datet", "x-api-path-slug"=>"forecast3hourlylatlatlonlon-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"days", "description"=>"Number of days to return"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"lat", "description"=>"Latitude component of location"}, {"in"=>"path", "name"=>"lon", "description"=>"Longitude component of location"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Forecast", "3hourly", "Lat", "Lat", "&lon", "Lon"]}}, "/forecast/3hourly?postal_code={postal_code}"=>{"get"=>{"summary"=>"Get Forecast 3hourly Postla Code Code", "description"=>"Returns a 3-hourly forecast, where each point represents a three hour period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC.", "operationId"=>"returns-a-3hourly-forecast-where-each-point-represents-a-three-hour-period-every-point-has-a-datetim", "x-api-path-slug"=>"forecast3hourlypostal-codepostal-code-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"country", "description"=>"Country Code (2 letter)"}, {"in"=>"query", "name"=>"days", "description"=>"Number of days to return"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"postal_code", "description"=>"Postal Code"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Forecast", "3hourly", "Postal", "Code", "Postal", "Code"]}}, "/forecast/daily?city={city}&country={country}"=>{"get"=>{"summary"=>"Get Forecast Daily City & Country", "description"=>"**(REQUIRED: Basic Plan or Higher)** Returns a daily forecast, where each point represents one day (24hr) period. Every point has a datetime string in the format \"YYYY-MM-DD\". One day begins at 00:00 UTC, and ends at 23:59 UTC. Accepts a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate.", "operationId"=>"required-basic-plan-or-higher-returns-a-daily-forecast-where-each-point-represents-one-day-24hr-peri", "x-api-path-slug"=>"forecastdailycitycitycountrycountry-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"path", "name"=>"city", "description"=>"City search"}, {"in"=>"path", "name"=>"country", "description"=>"Country Code (2 letter)"}, {"in"=>"query", "name"=>"days", "description"=>"Number of days to return"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"state", "description"=>"Full name of state"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Forecast", "Daily", "City", "City", "&country", "Country"]}}, "/forecast/daily?city_id={city_id}"=>{"get"=>{"summary"=>"Get Forecast Daily City", "description"=>"**(REQUIRED: Basic Plan or Higher)** Returns a daily forecast, where each point represents one day (24hr) period. Every point has a datetime string in the format \"YYYY-MM-DD\". One day begins at 00:00 UTC, and ends at 23:59 UTC.", "operationId"=>"required-basic-plan-or-higher-returns-a-daily-forecast-where-each-point-represents-one-day-24hr-peri", "x-api-path-slug"=>"forecastdailycity-idcity-id-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"path", "name"=>"city_id", "description"=>"City ID"}, {"in"=>"query", "name"=>"days", "description"=>"Number of days to return"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Forecast", "Daily", "City", "", "City"]}}, "/forecast/daily?ip={ip}"=>{"get"=>{"summary"=>"Get Forecast Daily IP", "description"=>"**(REQUIRED: Basic Plan or Higher)** Returns a daily forecast, where each point represents one day (24hr) period. Every point has a datetime string in the format \"YYYY-MM-DD\". One day begins at 00:00 UTC, and ends at 23:59 UTC.", "operationId"=>"required-basic-plan-or-higher-returns-a-daily-forecast-where-each-point-represents-one-day-24hr-peri", "x-api-path-slug"=>"forecastdailyipip-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"days", "description"=>"Number of days to return"}, {"in"=>"path", "name"=>"ip", "description"=>"IP address, or auto"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Forecast", "Daily", "Ip", "Ip"]}}, "/forecast/daily?lat={lat}&lon={lon}"=>{"get"=>{"summary"=>"Get Forecast Daily Lat & Lon", "description"=>"**(REQUIRED: Basic Plan or Higher)** Returns a daily forecast, where each point represents one day (24hr) period. Every point has a datetime string in the format \"YYYY-MM-DD\". One day begins at 00:00 UTC, and ends at 23:59 UTC.", "operationId"=>"required-basic-plan-or-higher-returns-a-daily-forecast-where-each-point-represents-one-day-24hr-peri", "x-api-path-slug"=>"forecastdailylatlatlonlon-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"days", "description"=>"Number of days to return"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"lat", "description"=>"Latitude component of location"}, {"in"=>"path", "name"=>"lon", "description"=>"Longitude component of location"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Forecast", "Daily", "Lat", "Lat", "&lon", "Lon"]}}, "/forecast/daily?postal_code={postal_code}"=>{"get"=>{"summary"=>"Get Forecast Daily Postla Code Code", "description"=>"**(REQUIRED: Basic Plan or Higher)** Returns a daily forecast, where each point represents one day (24hr) period. Every point has a datetime string in the format \"YYYY-MM-DD\". One day begins at 00:00 UTC, and ends at 23:59 UTC.", "operationId"=>"required-basic-plan-or-higher-returns-a-daily-forecast-where-each-point-represents-one-day-24hr-peri", "x-api-path-slug"=>"forecastdailypostal-codepostal-code-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"country", "description"=>"Country Code (2 letter)"}, {"in"=>"query", "name"=>"days", "description"=>"Number of days to return"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"postal_code", "description"=>"Postal Code"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Forecast", "Daily", "Postal", "Code", "Postal", "Code"]}}, "/forecast/hourly?city={city}&country={country}"=>{"get"=>{"summary"=>"Get Forecast Hourly City & Country", "description"=>"**(REQUIRED: Developer Plan or Higher)** Returns an hourly forecast, where each point represents a one hour period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC. Accepts a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate.", "operationId"=>"required-developer-plan-or-higher-returns-an-hourly-forecast-where-each-point-represents-a-one-hour-", "x-api-path-slug"=>"forecasthourlycitycitycountrycountry-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"path", "name"=>"city", "description"=>"City search"}, {"in"=>"path", "name"=>"country", "description"=>"Country Code (2 letter)"}, {"in"=>"query", "name"=>"hours", "description"=>"Number of hours to return"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"state", "description"=>"Full name of state"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Forecast", "Hourly", "City", "City", "&country", "Country"]}}, "/forecast/hourly?city_id={city_id}"=>{"get"=>{"summary"=>"Get Forecast Hourly City", "description"=>"**(REQUIRED: Developer Plan or Higher)** Returns an hourly forecast, where each point represents a one hour period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC.", "operationId"=>"required-developer-plan-or-higher-returns-an-hourly-forecast-where-each-point-represents-a-one-hour-", "x-api-path-slug"=>"forecasthourlycity-idcity-id-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"path", "name"=>"city_id", "description"=>"City ID"}, {"in"=>"query", "name"=>"hours", "description"=>"Number of hours to return"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Forecast", "Hourly", "City", "", "City"]}}, "/forecast/hourly?ip={ip}"=>{"get"=>{"summary"=>"Get Forecast Hourly IP", "description"=>"**(REQUIRED: Developer Plan or Higher)** Returns an hourly forecast, where each point represents a one hour period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC.", "operationId"=>"required-developer-plan-or-higher-returns-an-hourly-forecast-where-each-point-represents-a-one-hour-", "x-api-path-slug"=>"forecasthourlyipip-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"days", "description"=>"Number of days to return"}, {"in"=>"query", "name"=>"hours", "description"=>"Number of hours to return"}, {"in"=>"path", "name"=>"ip", "description"=>"IP address, or auto"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Forecast", "Hourly", "Ip", "Ip"]}}, "/forecast/hourly?lat={lat}&lon={lon}"=>{"get"=>{"summary"=>"Get Forecast Hourly Lat & Lon", "description"=>"**(REQUIRED: Developer Plan or Higher)** Returns an hourly forecast, where each point represents a one hour period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC.", "operationId"=>"required-developer-plan-or-higher-returns-an-hourly-forecast-where-each-point-represents-a-one-hour-", "x-api-path-slug"=>"forecasthourlylatlatlonlon-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"hours", "description"=>"Number of hours to return"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"lat", "description"=>"Latitude component of location"}, {"in"=>"path", "name"=>"lon", "description"=>"Longitude component of location"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Forecast", "Hourly", "Lat", "Lat", "&lon", "Lon"]}}, "/forecast/hourly?postal_code={postal_code}"=>{"get"=>{"summary"=>"Get Forecast Hourly Postla Code Code", "description"=>"**(REQUIRED: Developer Plan or Higher)** Returns an hourly forecast, where each point represents a one hour period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC.", "operationId"=>"required-developer-plan-or-higher-returns-an-hourly-forecast-where-each-point-represents-a-one-hour-", "x-api-path-slug"=>"forecasthourlypostal-codepostal-code-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"country", "description"=>"Country Code (2 letter)"}, {"in"=>"query", "name"=>"hours", "description"=>"Number of hours to return"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"postal_code", "description"=>"Postal Code"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Forecast", "Hourly", "Postal", "Code", "Postal", "Code"]}}, "/history/daily?city={city}&country={country}"=>{"get"=>{"summary"=>"Get History Daily City & Country", "description"=>"Returns Historical Observations - Given a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate. **(LIMIT 1 day for Low Volume plans. LIMIT 7 days for Basic/Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)**", "operationId"=>"returns-historical-observations--given-a-city-in-the-format-of-cityst-or-city-the-state-and-country-", "x-api-path-slug"=>"historydailycitycitycountrycountry-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"path", "name"=>"city", "description"=>"City search"}, {"in"=>"path", "name"=>"country", "description"=>"Country Code (2 letter)"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"state", "description"=>"Full name of state"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "History", "Daily", "City", "City", "&country", "Country"]}}, "/history/daily?city_id={city_id}"=>{"get"=>{"summary"=>"Get History Daily City", "description"=>"Returns Historical Observations - Given a City ID. **(LIMIT 1 day for Low Volume plans. LIMIT 7 days for Basic/Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)**", "operationId"=>"returns-historical-observations--given-a-city-id-limit-1-day-for-low-volume-plans-limit-7-days-for-b", "x-api-path-slug"=>"historydailycity-idcity-id-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"path", "name"=>"city_id", "description"=>"City ID"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "History", "Daily", "City", "", "City"]}}, "/history/daily?ip={ip}"=>{"get"=>{"summary"=>"Get History Daily IP", "description"=>"Returns Historical Observations - Given IP Address, or auto. **(LIMIT 1 day for Low Volume plans. LIMIT 7 days for Basic/Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)**", "operationId"=>"returns-historical-observations--given-ip-address-or-auto-limit-1-day-for-low-volume-plans-limit-7-d", "x-api-path-slug"=>"historydailyipip-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"path", "name"=>"ip", "description"=>"IP Address, or auto"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "History", "Daily", "Ip", "Ip"]}}, "/history/daily?lat={lat}&lon={lon}"=>{"get"=>{"summary"=>"Get History Daily Lat & Lon", "description"=>"Returns Historical Observations - Given a lat, and lon. **(LIMIT 1 day for Low Volume plans. LIMIT 7 days for Basic/Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)**", "operationId"=>"returns-historical-observations--given-a-lat-and-lon-limit-1-day-for-low-volume-plans-limit-7-days-f", "x-api-path-slug"=>"historydailylatlatlonlon-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"lat", "description"=>"Latitude component of location"}, {"in"=>"path", "name"=>"lon", "description"=>"Longitude component of location"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "History", "Daily", "Lat", "Lat", "&lon", "Lon"]}}, "/history/daily?postal_code={postal_code}"=>{"get"=>{"summary"=>"Get History Daily Postla Code Code", "description"=>"Returns Historical Observations - Given a Postal Code. **(LIMIT 1 day for Low Volume plans. LIMIT 7 days for Basic/Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)**", "operationId"=>"returns-historical-observations--given-a-postal-code-limit-1-day-for-low-volume-plans-limit-7-days-f", "x-api-path-slug"=>"historydailypostal-codepostal-code-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"country", "description"=>"Country Code (2 letter)"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"postal_code", "description"=>"Postal Code"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "History", "Daily", "Postal", "Code", "Postal", "Code"]}}, "/history/daily?station={station}"=>{"get"=>{"summary"=>"Get History Daily Station Station", "description"=>"Returns Historical Observations - Given a station ID. **(LIMIT 1 day for Low Volume plans. LIMIT 7 days for Basic/Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)**", "operationId"=>"returns-historical-observations--given-a-station-id-limit-1-day-for-low-volume-plans-limit-7-days-fo", "x-api-path-slug"=>"historydailystationstation-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"path", "name"=>"station", "description"=>"Station ID"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "History", "Daily", "Station", "Station"]}}, "/history/energy/bbox?lat1={lat1}&lon1={lon1}&lat2={lat2}&lon2={lon2}"=>{"get"=>{"summary"=>"Get History Energy Bbox Lat1 Lat1 &lon1 Lon1 &lat2 Lat2 &lon2 Lon2", "description"=>"Returns aggregate energy specific historical weather fields, over a specified time period. Supply a bounding box ex: lat1=40&lon1=-78&lat2=38&lon2=-80. This API will return UP TO 150 stations, aggregated by the specified time period start_date to end_date.", "operationId"=>"returns-aggregate-energy-specific-historical-weather-fields-over-a-specified-time-period-supply-a-bo", "x-api-path-slug"=>"historyenergybboxlat1lat1lon1lon1lat2lat2lon2lon2-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"path", "name"=>"lat1", "description"=>"Latitude of upper left corner"}, {"in"=>"path", "name"=>"lat2", "description"=>"Latitude of lower right corner"}, {"in"=>"path", "name"=>"lon1", "description"=>"Longitude of upper left corner"}, {"in"=>"path", "name"=>"lon2", "description"=>"Longitude of lower right corner"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "History", "Energy", "Bbox", "Lat1", "Lat1", "&lon1", "Lon1", "&lat2", "Lat2", "&lon2", "Lon2"]}}, "/history/energy?lat={lat}&lon={lon}"=>{"get"=>{"summary"=>"Get History Energy Lat & Lon", "description"=>"Returns aggregate energy specific historical weather fields, over a specified time period.", "operationId"=>"returns-aggregate-energy-specific-historical-weather-fields-over-a-specified-time-period", "x-api-path-slug"=>"historyenergylatlatlonlon-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"path", "name"=>"lat", "description"=>"Latitude component of location"}, {"in"=>"path", "name"=>"lon", "description"=>"Longitude component of location"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "History", "Energy", "Lat", "Lat", "&lon", "Lon"]}}, "/history/hourly?city={city}&country={country}"=>{"get"=>{"summary"=>"Get History Hourly City & Country", "description"=>"Returns Historical Observations - Given a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate. **(LIMIT 1 day for Low Volume plans. LIMIT 7 days for Basic/Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)**", "operationId"=>"returns-historical-observations--given-a-city-in-the-format-of-cityst-or-city-the-state-and-country-", "x-api-path-slug"=>"historyhourlycitycitycountrycountry-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"path", "name"=>"city", "description"=>"City search"}, {"in"=>"path", "name"=>"country", "description"=>"Country Code (2 letter)"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"state", "description"=>"Full name of state"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "History", "Hourly", "City", "City", "&country", "Country"]}}, "/history/hourly?city_id={city_id}"=>{"get"=>{"summary"=>"Get History Hourly City", "description"=>"Returns Historical Observations - Given a City ID. **(LIMIT 1 day for Low Volume plans. LIMIT 7 days for Basic/Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)**", "operationId"=>"returns-historical-observations--given-a-city-id-limit-1-day-for-low-volume-plans-limit-7-days-for-b", "x-api-path-slug"=>"historyhourlycity-idcity-id-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"path", "name"=>"city_id", "description"=>"City ID"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "History", "Hourly", "City", "", "City"]}}, "/history/hourly?ip={ip}"=>{"get"=>{"summary"=>"Get History Hourly IP", "description"=>"Returns Historical Observations - Given IP Address, or auto. **(LIMIT 1 day for Low Volume plans. LIMIT 7 days for Basic/Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)**", "operationId"=>"returns-historical-observations--given-ip-address-or-auto-limit-1-day-for-low-volume-plans-limit-7-d", "x-api-path-slug"=>"historyhourlyipip-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"path", "name"=>"ip", "description"=>"IP Address, or auto"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "History", "Hourly", "Ip", "Ip"]}}, "/history/hourly?lat={lat}&lon={lon}"=>{"get"=>{"summary"=>"Get History Hourly Lat & Lon", "description"=>"Returns Historical Observations - Given a lat, and lon. **(LIMIT 1 day for Low Volume plans. LIMIT 7 days for Basic/Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)**", "operationId"=>"returns-historical-observations--given-a-lat-and-lon-limit-1-day-for-low-volume-plans-limit-7-days-f", "x-api-path-slug"=>"historyhourlylatlatlonlon-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"lat", "description"=>"Latitude component of location"}, {"in"=>"path", "name"=>"lon", "description"=>"Longitude component of location"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "History", "Hourly", "Lat", "Lat", "&lon", "Lon"]}}, "/history/hourly?postal_code={postal_code}"=>{"get"=>{"summary"=>"Get History Hourly Postal Code", "description"=>"Returns Historical Observations - Given a Postal Code. **(LIMIT 1 day for Low Volume plans. LIMIT 7 days for Basic/Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)**", "operationId"=>"returns-historical-observations--given-a-postal-code-limit-1-day-for-low-volume-plans-limit-7-days-f", "x-api-path-slug"=>"historyhourlypostal-codepostal-code-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"country", "description"=>"Country Code (2 letter)"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"path", "name"=>"postal_code", "description"=>"Postal Code"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "History", "Hourly", "Postal", "Code", "Postal", "Code"]}}, "/history/hourly?station={station}"=>{"get"=>{"summary"=>"Get History Hourly Station Station", "description"=>"Returns Historical Observations - Given a station ID. **(LIMIT 1 day for Low Volume plans. LIMIT 7 days for Basic/Developer. LIMIT 30 days for Advanced/Advanced+/Enterprise)**", "operationId"=>"returns-historical-observations--given-a-station-id-limit-1-day-for-low-volume-plans-limit-7-days-fo", "x-api-path-slug"=>"historyhourlystationstation-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"end_date", "description"=>"End Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}, {"in"=>"query", "name"=>"lang", "description"=>"Language (Default: English) See language field description"}, {"in"=>"query", "name"=>"start_date", "description"=>"Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)"}, {"in"=>"path", "name"=>"station", "description"=>"Station ID"}, {"in"=>"query", "name"=>"units", "description"=>"Convert to units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "History", "Hourly", "Station", "Station"]}}, "/ip?ip={ip}"=>{"get"=>{"summary"=>"Get IP", "description"=>"Returns a geolocation object. Given an IP address. If no IP supplied, will use request IP address.", "operationId"=>"returns-a-geolocation-object-given-an-ip-address-if-no-ip-supplied-will-use-request-ip-address", "x-api-path-slug"=>"ipipip-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"Wraps return in jsonp callback"}, {"in"=>"query", "name"=>"exclude", "description"=>"exclude=all => return IP address only"}, {"in"=>"query", "name"=>"format", "description"=>"&format=none => return IP address as string"}, {"in"=>"path", "name"=>"ip", "description"=>"IP address"}, {"in"=>"query", "name"=>"key", "description"=>"Your registered API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Ip", "Ip", "Ip"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
runscope{"runscope-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Runscope", "x-complete"=>1, "info"=>{"title"=>"Runscope", "description"=>"manage-runscope-programmatically-", "version"=>"1.0.0"}, "host"=>"api.runscope.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/account"=>{"get"=>{"summary"=>"Get Account", "description"=>"Account Resource", "operationId"=>"account.get", "x-api-path-slug"=>"account-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/buckets"=>{"get"=>{"summary"=>"Get Buckets", "description"=>"Returns a list of buckets.", "operationId"=>"buckets.get", "x-api-path-slug"=>"buckets-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets"]}, "post"=>{"summary"=>"Add Buckets", "description"=>"Create a new bucket", "operationId"=>"buckets.post", "x-api-path-slug"=>"buckets-post", "parameters"=>[{"in"=>"body", "name"=>"NewBucket", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets"]}}, "/buckets/{bucketKey}"=>{"delete"=>{"summary"=>"Delete Buckets Bucketkey", "description"=>"Delete a single bucket resource.", "operationId"=>"buckets.bucketKey.delete", "x-api-path-slug"=>"bucketsbucketkey-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Bucketkey"]}, "get"=>{"summary"=>"Get Buckets Bucketkey", "description"=>"Returns a single bucket resource.", "operationId"=>"buckets.bucketKey.get", "x-api-path-slug"=>"bucketsbucketkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Bucketkey"]}}, "/buckets/{bucketKey}/environments"=>{"get"=>{"summary"=>"Get Buckets Environments", "description"=>"Returns list of shared environments for a specified bucket.", "operationId"=>"buckets.bucketKey.environments.get", "x-api-path-slug"=>"bucketsbucketkeyenvironments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Environments"]}, "post"=>{"summary"=>"Add Buckets Environments", "description"=>"Create new shared environment.", "operationId"=>"buckets.bucketKey.environments.post", "x-api-path-slug"=>"bucketsbucketkeyenvironments-post", "parameters"=>[{"in"=>"body", "name"=>"NewEnvironment", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Environments"]}}, "/buckets/{bucketKey}/environments/{environmentId}"=>{"put"=>{"summary"=>"Put Buckets Environments", "description"=>"Update the details of a shared environment.", "operationId"=>"buckets.bucketKey.environments.environmentId.put", "x-api-path-slug"=>"bucketsbucketkeyenvironmentsenvironmentid-put", "parameters"=>[{"in"=>"body", "name"=>"ModifiedEnvironment", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Environments"]}}, "/buckets/{bucketKey}/errors"=>{"get"=>{"summary"=>"Get Buckets Errors", "description"=>"Retrieve a list of error messages in a bucket", "operationId"=>"buckets.bucketKey.errors.get", "x-api-path-slug"=>"bucketsbucketkeyerrors-get", "parameters"=>[{"in"=>"query", "name"=>"before", "description"=>"Only return messages before the given Unix timestamp"}, {"in"=>"query", "name"=>"count", "description"=>"Maxiumum number of messages to return"}, {"in"=>"query", "name"=>"since", "description"=>"Only return messages after the given Unix timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Errors"]}}, "/buckets/{bucketKey}/messages"=>{"delete"=>{"summary"=>"Delete Buckets Messages", "description"=>"Clear a bucket (remove all messages).", "operationId"=>"buckets.bucketKey.messages.delete", "x-api-path-slug"=>"bucketsbucketkeymessages-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Messages"]}, "get"=>{"summary"=>"Get Buckets Messages", "description"=>"Retrieve a list of messages in a bucket", "operationId"=>"buckets.bucketKey.messages.get", "x-api-path-slug"=>"bucketsbucketkeymessages-get", "parameters"=>[{"in"=>"query", "name"=>"before", "description"=>"Only return messages before the given Unix timestamp"}, {"in"=>"query", "name"=>"count", "description"=>"Maxiumum number of messages to return"}, {"in"=>"query", "name"=>"since", "description"=>"Only return messages after the given Unix timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Messages"]}, "post"=>{"summary"=>"Add Buckets Messages", "description"=>"Create a message", "operationId"=>"buckets.bucketKey.messages.post", "x-api-path-slug"=>"bucketsbucketkeymessages-post", "parameters"=>[{"in"=>"body", "name"=>"NewMessage", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Messages"]}}, "/buckets/{bucketKey}/messages/{messageId}"=>{"get"=>{"summary"=>"Get Buckets Messages Message", "description"=>"Retrieve the details for a single message.", "operationId"=>"buckets.bucketKey.messages.messageId.get", "x-api-path-slug"=>"bucketsbucketkeymessagesmessageid-get", "parameters"=>[{"in"=>"path", "name"=>"messageId", "description"=>"The unique identifier for this message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Messages", "Message"]}}, "/buckets/{bucketKey}/tests"=>{"get"=>{"summary"=>"Get Buckets Tests", "description"=>"Returns a list of tests.", "operationId"=>"buckets.bucketKey.tests.get", "x-api-path-slug"=>"bucketsbucketkeytests-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Tests"]}, "post"=>{"summary"=>"Add Buckets Tests", "description"=>"Create a test.", "operationId"=>"buckets.bucketKey.tests.post", "x-api-path-slug"=>"bucketsbucketkeytests-post", "parameters"=>[{"in"=>"body", "name"=>"NewTest", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Tests"]}}, "/buckets/{bucketKey}/tests/{testId}"=>{"delete"=>{"summary"=>"Delete Buckets Tests", "description"=>"Delete a test, including all steps, schedules, test-specific environments and results.", "operationId"=>"buckets.bucketKey.tests.testId.delete", "x-api-path-slug"=>"bucketsbucketkeyteststestid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Tests"]}, "get"=>{"summary"=>"Get Buckets Tests", "description"=>"Retrieve the details of a given test by ID.", "operationId"=>"buckets.bucketKey.tests.testId.get", "x-api-path-slug"=>"bucketsbucketkeyteststestid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Tests"]}, "put"=>{"summary"=>"Put Buckets Tests", "description"=>"Modify a test's name, description, default environment and its steps. To modify other individual properties of a test, make requests to the steps, environments, and schedules subresources of the test.", "operationId"=>"buckets.bucketKey.tests.testId.put", "x-api-path-slug"=>"bucketsbucketkeyteststestid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Tests"]}}, "/buckets/{bucketKey}/tests/{testId}/environments"=>{"get"=>{"summary"=>"Get Buckets Tests Environments", "description"=>"Return details of the test's environments (only those that belong to the specified test)", "operationId"=>"buckets.bucketKey.tests.testId.environments.get", "x-api-path-slug"=>"bucketsbucketkeyteststestidenvironments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Tests", "Environments"]}, "post"=>{"summary"=>"Add Buckets Tests Environments", "description"=>"Create new test environment.", "operationId"=>"buckets.bucketKey.tests.testId.environments.post", "x-api-path-slug"=>"bucketsbucketkeyteststestidenvironments-post", "parameters"=>[{"in"=>"body", "name"=>"NewEnvironment", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Tests", "Environments"]}}, "/buckets/{bucketKey}/tests/{testId}/environments/{environmentId}"=>{"put"=>{"summary"=>"Put Buckets Tests Environments", "description"=>"Update the details of a test environment.", "operationId"=>"buckets.bucketKey.tests.testId.environments.environmentId.put", "x-api-path-slug"=>"bucketsbucketkeyteststestidenvironmentsenvironmentid-put", "parameters"=>[{"in"=>"body", "name"=>"ModifiedEnvironment", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Tests", "Environments"]}}, "/buckets/{bucketKey}/tests/{testId}/metrics"=>{"get"=>{"summary"=>"Get Buckets Tests Metrics", "description"=>"Return details of the test metrics for the specified timeframe.", "operationId"=>"buckets.bucketKey.tests.testId.metrics.get", "x-api-path-slug"=>"bucketsbucketkeyteststestidmetrics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Tests", "Metrics"]}}, "/buckets/{bucketKey}/tests/{testId}/steps"=>{"get"=>{"summary"=>"Get Buckets Tests Steps", "description"=>"List test steps for a test.", "operationId"=>"buckets.bucketKey.tests.testId.steps.get", "x-api-path-slug"=>"bucketsbucketkeyteststestidsteps-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Tests", "Steps"]}, "post"=>{"summary"=>"Add Buckets Tests Steps", "description"=>"Add new test step.", "operationId"=>"buckets.bucketKey.tests.testId.steps.post", "x-api-path-slug"=>"bucketsbucketkeyteststestidsteps-post", "parameters"=>[{"in"=>"body", "name"=>"TestStep", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Tests", "Steps"]}}, "/buckets/{bucketKey}/tests/{testId}/steps/{stepId}"=>{"delete"=>{"summary"=>"Delete Buckets Tests Steps", "description"=>"Delete a step from a test.", "operationId"=>"buckets.bucketKey.tests.testId.steps.stepId.delete", "x-api-path-slug"=>"bucketsbucketkeyteststestidstepsstepid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Tests", "Steps"]}, "put"=>{"summary"=>"Put Buckets Tests Steps", "description"=>"Update the details of a single test step.", "operationId"=>"buckets.bucketKey.tests.testId.steps.stepId.put", "x-api-path-slug"=>"bucketsbucketkeyteststestidstepsstepid-put", "parameters"=>[{"in"=>"body", "name"=>"TestStep", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "Tests", "Steps"]}}, "/teams/{teamId}/agents"=>{"get"=>{"summary"=>"Get Teams Agents", "description"=>"Team agents list", "operationId"=>"teams.teamId.agents.get", "x-api-path-slug"=>"teamsteamidagents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Agents"]}}, "/teams/{teamId}/integrations"=>{"get"=>{"summary"=>"Get Teams Integrations", "description"=>"Team integrations list", "operationId"=>"teams.teamId.integrations.get", "x-api-path-slug"=>"teamsteamidintegrations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Integrations"]}}, "/teams/{teamId}/people"=>{"get"=>{"summary"=>"Get Teams People", "description"=>"Teams Resource", "operationId"=>"teams.teamId.people.get", "x-api-path-slug"=>"teamsteamidpeople-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "People"]}}}}, "apis"=>{"name"=>"Runscope", "x-slug"=>"runscope", "description"=>"API performance monitoring. Everything is going to be 200 OK", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1752-runscope.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"125183", "tags"=>"API LIfeyclessss,Monitoring,Monitoring,My API Stack,Relative Data,SaaS,Service API,Stack Network,Technology,Testing,Testing", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"runscope/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Runscope", "x-api-slug"=>"runscope", "description"=>"API performance monitoring. Everything is going to be 200 OK", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1752-runscope.jpg", "humanURL"=>"http://runscope.com", "baseURL"=>"https://api.runscope.com//", "tags"=>"API LIfeyclessss,Monitoring,Monitoring,My API Stack,Relative Data,SaaS,Service API,Stack Network,Technology,Testing,Testing", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/runscope/teamsteamidpeople-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/runscope/runscope-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base-url", "url"=>"https://api.runscope.com"}, {"type"=>"x-blog", "url"=>"http://blog.runscope.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.runscope.com/posts?format=rss"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/runscope"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/runscope"}, {"type"=>"x-developer", "url"=>"https://www.runscope.com/docs/api"}, {"type"=>"x-email", "url"=>"sales@runscope.com"}, {"type"=>"x-email", "url"=>"press@runscope.com"}, {"type"=>"x-email", "url"=>"help@runscope.com"}, {"type"=>"x-email", "url"=>"dmca@runscope.com"}, {"type"=>"x-github", "url"=>"https://github.com/Runscope"}, {"type"=>"x-openapi-spec--authoritative", "url"=>"https://raw.githubusercontent.com/Runscope/runscope-api-examples/master/schemas/runscope-swagger.json"}, {"type"=>"x-pricing", "url"=>"https://www.runscope.com/pricing-and-plans"}, {"type"=>"x-privacy", "url"=>"https://www.runscope.com/privacy"}, {"type"=>"x-status", "url"=>"http://status.runscope.com/"}, {"type"=>"x-support", "url"=>"https://www.runscope.com/support"}, {"type"=>"x-terms-of-service", "url"=>"https://www.runscope.com/terms"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Runscope"}, {"type"=>"x-website", "url"=>"http://runscope.com"}, {"type"=>"x-website", "url"=>"https://www.runscope.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
shopify{"shopify-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Shopify", "x-complete"=>1, "info"=>{"title"=>"Shopify API", "description"=>"todo-add-description", "version"=>"1.0.0"}, "host"=>"DefaultParameterValue:DefaultParameterValue@DefaultParameterValue.myshopify.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/admin/custom_collections.json"=>{"get"=>{"summary"=>"Get a list of all custom collections", "description"=>"Get a list of all custom collections.", "operationId"=>"getAdminCustomCollections.json", "x-api-path-slug"=>"admincustom-collections-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Custom", "Collections"]}, "post"=>{"summary"=>"Create a new custom collection", "description"=>"Create a new custom collection.", "operationId"=>"postAdminCustomCollections.json", "x-api-path-slug"=>"admincustom-collections-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Custom", "Collection"]}}, "/admin/script_tags/373484.json"=>{"get"=>{"summary"=>"Get a single script tag", "description"=>"Get a single script tag.", "operationId"=>"getAdminScriptTags373484.json", "x-api-path-slug"=>"adminscript-tags373484-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Script", "Tag"]}}, "/admin/comments/2941387470.json"=>{"put"=>{"summary"=>"Update a comment", "description"=>"Update a comment.", "operationId"=>"putAdminComments2941387470.json", "x-api-path-slug"=>"admincomments2941387470-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Comment"]}}, "/admin/smart_collections/401912846.json"=>{"get"=>{"summary"=>"Get a single collection", "description"=>"Get a single collection.", "operationId"=>"getAdminSmartCollections401912846.json", "x-api-path-slug"=>"adminsmart-collections401912846-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Collection"]}, "put"=>{"summary"=>"Update a single collection", "description"=>"Update a single collection.", "operationId"=>"putAdminSmartCollections401912846.json", "x-api-path-slug"=>"adminsmart-collections401912846-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Collection"]}}, "/admin/products/9579007950.json"=>{"put"=>{"summary"=>"Update a product and one of its variants", "description"=>"Update a product and one of its variants.", "operationId"=>"putAdminProducts9579007950.json", "x-api-path-slug"=>"adminproducts9579007950-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Product", "Its", "Variants"]}, "delete"=>{"summary"=>"Remove a product from the shop", "description"=>"Remove a product from the shop.", "operationId"=>"deleteAdminProducts9579007950.json", "x-api-path-slug"=>"adminproducts9579007950-json-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Remove", "Product", "From", "Shop"]}}, "/admin/orders/4554953422/refunds/calculate.json"=>{"post"=>{"summary"=>"Calculate a refund for a line item and shipping", "description"=>"Calculate a refund for a line item and shipping.", "operationId"=>"postAdminOrders4554953422RefundsCalculate.json", "x-api-path-slug"=>"adminorders4554953422refundscalculate-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Calculate", "Refunda", "Line", "Item", "Shipping"]}}, "/admin/collects.json"=>{"get"=>{"summary"=>"List all collects", "description"=>"List all collects.", "operationId"=>"getAdminCollects.json", "x-api-path-slug"=>"admincollects-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Collects"]}}, "/admin/blogs/62581763/articles.json"=>{"get"=>{"summary"=>"Get a list of all articles from a certain blog", "description"=>"Get a list of all articles from a certain blog.", "operationId"=>"getAdminBlogs62581763Articles.json", "x-api-path-slug"=>"adminblogs62581763articles-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Articles", "From", "Certain", "Blog"]}, "post"=>{"summary"=>"Create a new article for a blog", "description"=>"Create a new article for a blog.", "operationId"=>"postAdminBlogs62581763Articles.json", "x-api-path-slug"=>"adminblogs62581763articles-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Articlea", "Blog"]}}, "/admin/metafields.json"=>{"get"=>{"summary"=>"Get all metafields that belong to a store", "description"=>"Get all metafields that belong to a store.", "operationId"=>"getAdminMetafields.json", "x-api-path-slug"=>"adminmetafields-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Metafields", "That", "Belong", "To", "Store"]}, "post"=>{"summary"=>"Create a new metafield for a store.", "description"=>"Create a new metafield for a store..", "operationId"=>"postAdminMetafields.json", "x-api-path-slug"=>"adminmetafields-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Metafielda", "Store"]}}, "/admin/gift_cards/61810574/disable.json"=>{"post"=>{"summary"=>"Disable a gift card", "description"=>"Disable a gift card.", "operationId"=>"postAdminGiftCards61810574Disable.json", "x-api-path-slug"=>"admingift-cards61810574disable-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Disable", "Gift", "Card"]}}, "/admin/webhooks/503738446.json"=>{"put"=>{"summary"=>"Update a Webhook", "description"=>"Update a webhook.", "operationId"=>"putAdminWebhooks503738446.json", "x-api-path-slug"=>"adminwebhooks503738446-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Webhook"]}, "delete"=>{"summary"=>"Delete a Webhook", "description"=>"Delete a webhook.", "operationId"=>"deleteAdminWebhooks503738446.json", "x-api-path-slug"=>"adminwebhooks503738446-json-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Webhook"]}}, "/admin/blogs/62581763/articles/196805774.json"=>{"get"=>{"summary"=>"Get a single article by its ID and the ID of the parent blog", "description"=>"Get a single article by its id and the id of the parent blog.", "operationId"=>"getAdminBlogs62581763Articles196805774.json", "x-api-path-slug"=>"adminblogs62581763articles196805774-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Article", "By", "Its", "ID", "ID", "Parent", "Blog"]}, "put"=>{"summary"=>"Update an article", "description"=>"Update an article.", "operationId"=>"putAdminBlogs62581763Articles196805774.json", "x-api-path-slug"=>"adminblogs62581763articles196805774-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Article"]}}, "/admin/metafields/33145232974.json"=>{"get"=>{"summary"=>"Get a single store metafield by ID", "description"=>"Get a single store metafield by id.", "operationId"=>"getAdminMetafields33145232974.json", "x-api-path-slug"=>"adminmetafields33145232974-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Store", "Metafield", "By", "ID"]}, "put"=>{"summary"=>"Update an existing store metafield.", "description"=>"Update an existing store metafield..", "operationId"=>"putAdminMetafields33145232974.json", "x-api-path-slug"=>"adminmetafields33145232974-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Existing", "Store", "Metafield"]}, "delete"=>{"summary"=>"Delete a store metafield", "description"=>"Delete a store metafield.", "operationId"=>"deleteAdminMetafields33145232974.json", "x-api-path-slug"=>"adminmetafields33145232974-json-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Store", "Metafield"]}}, "/admin/orders/4554953422/cancel.json"=>{"post"=>{"summary"=>"Canceling an Order", "description"=>"Canceling an order.", "operationId"=>"postAdminOrders4554953422Cancel.json", "x-api-path-slug"=>"adminorders4554953422cancel-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Canceling", "Order"]}}, "/admin/gift_cards/61466894.json"=>{"get"=>{"summary"=>"Show a specific gift card's details", "description"=>"Show a specific gift card's details.", "operationId"=>"getAdminGiftCards61466894.json", "x-api-path-slug"=>"admingift-cards61466894-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Show", "Specific", "Gift", "Cards", "Details"]}}, "/admin/orders/4554953422/close.json"=>{"post"=>{"summary"=>"Close a processed order", "description"=>"Close a processed order.", "operationId"=>"postAdminOrders4554953422Close.json", "x-api-path-slug"=>"adminorders4554953422close-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Close", "Processed", "Order"]}}, "/admin/orders/4602125518/risks.json"=>{"get"=>{"summary"=>"Get all Order Risks for an Order", "description"=>"Get all order risks for an order.", "operationId"=>"getAdminOrders4602125518Risks.json", "x-api-path-slug"=>"adminorders4602125518risks-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Order", "Risksan", "Order"]}, "post"=>{"summary"=>"Add a fraud risk for Proxy detection", "description"=>"Add a fraud risk for proxy detection.", "operationId"=>"postAdminOrders4602125518Risks.json", "x-api-path-slug"=>"adminorders4602125518risks-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Fraud", "RiskProxy", "Detection"]}}, "/admin/blogs.json"=>{"get"=>{"summary"=>"Get a list of all blogs", "description"=>"Get a list of all blogs.", "operationId"=>"getAdminBlogs.json", "x-api-path-slug"=>"adminblogs-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Blogs"]}, "post"=>{"summary"=>"Create a new blog", "description"=>"Create a new blog.", "operationId"=>"postAdminBlogs.json", "x-api-path-slug"=>"adminblogs-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Blog"]}}, "/admin/policies.json"=>{"get"=>{"summary"=>"getting the shops policies", "description"=>"Getting the shops policies.", "operationId"=>"getAdminPolicies.json", "x-api-path-slug"=>"adminpolicies-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Getting", "Shops", "Policies"]}}, "/admin/orders/4554953422/events.json"=>{"get"=>{"summary"=>"Get all the events from a particular order", "description"=>"Get all the events from a particular order.", "operationId"=>"getAdminOrders4554953422Events.json", "x-api-path-slug"=>"adminorders4554953422events-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Events", "From", "Particular", "Order"]}}, "/admin/pages/count.json"=>{"get"=>{"summary"=>"Count all pages for a shop", "description"=>"Count all pages for a shop.", "operationId"=>"getAdminPagesCount.json", "x-api-path-slug"=>"adminpagescount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Pagesa", "Shop"]}}, "/admin/orders/4554953422/transactions/count.json"=>{"get"=>{"summary"=>"Get a count of transactions for an order", "description"=>"Get a count of transactions for an order.", "operationId"=>"getAdminOrders4554953422TransactionsCount.json", "x-api-path-slug"=>"adminorders4554953422transactionscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Transactionsan", "Order"]}}, "/admin/gift_cards/count.json"=>{"get"=>{"summary"=>"Retrieve a count of all gift cards", "description"=>"Retrieve a count of all gift cards.", "operationId"=>"getAdminGiftCardsCount.json", "x-api-path-slug"=>"admingift-cardscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Count", "Gift", "Cards"]}}, "/admin/countries.json"=>{"get"=>{"summary"=>"Get a list of all countries", "description"=>"Get a list of all countries.", "operationId"=>"getAdminCountries.json", "x-api-path-slug"=>"admincountries-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Countries"]}, "post"=>{"summary"=>"Create a country", "description"=>"Create a country.", "operationId"=>"postAdminCountries.json", "x-api-path-slug"=>"admincountries-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Country"]}}, "/admin/fulfillment_services.json"=>{"get"=>{"summary"=>"List your app's fulfillment services", "description"=>"List your app's fulfillment services.", "operationId"=>"getAdminFulfillmentServices.json", "x-api-path-slug"=>"adminfulfillment-services-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Your", "Apps", "Fulfillment", "Services"]}, "post"=>{"summary"=>"Create a fulfillment service", "description"=>"Create a fulfillment service.", "operationId"=>"postAdminFulfillmentServices.json", "x-api-path-slug"=>"adminfulfillment-services-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Fulfillment", "Service"]}}, "/admin/pages/216307854.json"=>{"put"=>{"summary"=>"update a page", "description"=>"Update a page.", "operationId"=>"putAdminPages216307854.json", "x-api-path-slug"=>"adminpages216307854-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Update", "Page"]}, "delete"=>{"summary"=>"Delete a page", "description"=>"Delete a page.", "operationId"=>"deleteAdminPages216307854.json", "x-api-path-slug"=>"adminpages216307854-json-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Page"]}}, "/admin/customers/3989659651/addresses/5484465742.json"=>{"put"=>{"summary"=>"Updating a customers postal code", "description"=>"Updating a customers postal code.", "operationId"=>"putAdminCustomers3989659651Addresses5484465742.json", "x-api-path-slug"=>"admincustomers3989659651addresses5484465742-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Updating", "Customers", "Postal", "Code"]}, "delete"=>{"summary"=>"Removing a customers address", "description"=>"Removing a customers address.", "operationId"=>"deleteAdminCustomers3989659651Addresses5484465742.json", "x-api-path-slug"=>"admincustomers3989659651addresses5484465742-json-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Removing", "Customers", "Address"]}}, "/admin/customers/search.json"=>{"get"=>{"summary"=>"Get all customers with an address in the Brazil", "description"=>"Get all customers with an address in the brazil.", "operationId"=>"getAdminCustomersSearch.json", "x-api-path-slug"=>"admincustomerssearch-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Customers", "Address", "In", "Brazil"]}}, "/admin/application_charges.json"=>{"get"=>{"summary"=>"Retrieving all one-time charges since a specified ID", "description"=>"Retrieving all one-time charges since a specified id.", "operationId"=>"getAdminApplicationCharges.json", "x-api-path-slug"=>"adminapplication-charges-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"since_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieving", "One-time", "Charges", "Since", "Specified", "ID"]}, "post"=>{"summary"=>"Create a new one-time application charge.", "description"=>"Create a new one-time application charge..", "operationId"=>"postAdminApplicationCharges.json", "x-api-path-slug"=>"adminapplication-charges-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "One-time", "Application", "Charge"]}}, "/admin/blogs/62581763/articles/count.json"=>{"get"=>{"summary"=>"Get a count of all articles from a certain blog", "description"=>"Get a count of all articles from a certain blog.", "operationId"=>"getAdminBlogs62581763ArticlesCount.json", "x-api-path-slug"=>"adminblogs62581763articlescount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Articles", "From", "Certain", "Blog"]}}, "/admin/metafields/count.json"=>{"get"=>{"summary"=>"Get a count of all metafields for a store", "description"=>"Get a count of all metafields for a store.", "operationId"=>"getAdminMetafieldsCount.json", "x-api-path-slug"=>"adminmetafieldscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Metafieldsa", "Store"]}}, "/admin/custom_collections/246409795.json"=>{"get"=>{"summary"=>"Get a single custom collections", "description"=>"Get a single custom collections.", "operationId"=>"getAdminCustomCollections246409795.json", "x-api-path-slug"=>"admincustom-collections246409795-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Custom", "Collections"]}, "put"=>{"summary"=>"update a custom collection", "description"=>"Update a custom collection.", "operationId"=>"putAdminCustomCollections246409795.json", "x-api-path-slug"=>"admincustom-collections246409795-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Update", "Custom", "Collection"]}, "delete"=>{"summary"=>"delete a custom collection", "description"=>"Delete a custom collection.", "operationId"=>"deleteAdminCustomCollections246409795.json", "x-api-path-slug"=>"admincustom-collections246409795-json-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Delete", "Custom", "Collection"]}}, "//admin/comments.json"=>{"post"=>{"summary"=>"Create a new comment for an article", "description"=>"Create a new comment for an article.", "operationId"=>"postAdminComments.json", "x-api-path-slug"=>"admincomments-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Commentan", "Article"]}}, "/admin/customers/3989659651/addresses.json"=>{"get"=>{"summary"=>"Get all of a customer's addresses", "description"=>"Get all of a customer's addresses.", "operationId"=>"getAdminCustomers3989659651Addresses.json", "x-api-path-slug"=>"admincustomers3989659651addresses-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Customers", "Addresses"]}, "post"=>{"summary"=>"Creating a new address for a customer", "description"=>"Creating a new address for a customer.", "operationId"=>"postAdminCustomers3989659651Addresses.json", "x-api-path-slug"=>"admincustomers3989659651addresses-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Creating", "New", "Addressa", "Customer"]}}, "/admin/comments/\#{id}.json"=>{"get"=>{"summary"=>"Get a single comment", "description"=>"Get a single comment.", "operationId"=>"getAdminComments#.json", "x-api-path-slug"=>"admincommentsid-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Comment"]}}, "/admin/gift_cards.json"=>{"get"=>{"summary"=>"Get a list of all gift cards", "description"=>"Get a list of all gift cards.", "operationId"=>"getAdminGiftCards.json", "x-api-path-slug"=>"admingift-cards-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Gift", "Cards"]}, "post"=>{"summary"=>"Create a new gift card with an automatically generated code", "description"=>"Create a new gift card with an automatically generated code.", "operationId"=>"postAdminGiftCards.json", "x-api-path-slug"=>"admingift-cards-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Gift", "Card", "Automatically", "Generated", "Code"]}}, "/admin/articles/tags.json"=>{"get"=>{"summary"=>"Get a list of all the tags of articles", "description"=>"Get a list of all the tags of articles.", "operationId"=>"getAdminArticlesTags.json", "x-api-path-slug"=>"adminarticlestags-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Tags", "Articles"]}}, "/admin/orders/4602125518/risks/8609858574.json"=>{"get"=>{"summary"=>"Get a single Order Risk", "description"=>"Get a single order risk.", "operationId"=>"getAdminOrders4602125518Risks8609858574.json", "x-api-path-slug"=>"adminorders4602125518risks8609858574-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Order", "Risk"]}, "put"=>{"summary"=>"Update an existing risk detail line on an order", "description"=>"Update an existing risk detail line on an order.", "operationId"=>"putAdminOrders4602125518Risks8609858574.json", "x-api-path-slug"=>"adminorders4602125518risks8609858574-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Existing", "Risk", "Detail", "Line", "On", "Order"]}, "delete"=>{"summary"=>"Delete an erroneous risk entry", "description"=>"Delete an erroneous risk entry.", "operationId"=>"deleteAdminOrders4602125518Risks8609858574.json", "x-api-path-slug"=>"adminorders4602125518risks8609858574-json-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Erroneous", "Risk", "Entry"]}}, "/admin/orders/4495703502/fulfillments.json"=>{"get"=>{"summary"=>"Get a list of all fulfillments for an order.", "description"=>"Get a list of all fulfillments for an order..", "operationId"=>"getAdminOrders4495703502Fulfillments.json", "x-api-path-slug"=>"adminorders4495703502fulfillments-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Fulfillmentsan", "Order"]}}, "/admin/variants/34705478094.json"=>{"put"=>{"summary"=>"Update an existing product variant", "description"=>"Update an existing product variant.", "operationId"=>"putAdminVariants34705478094.json", "x-api-path-slug"=>"adminvariants34705478094-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Existing", "Product", "Variant"]}}, "/admin/customer_saved_searches/1189248515/customers.json"=>{"get"=>{"summary"=>"Get all customers who match the criteria", "description"=>"Get all customers who match the criteria.", "operationId"=>"getAdminCustomerSavedSearches1189248515Customers.json", "x-api-path-slug"=>"admincustomer-saved-searches1189248515customers-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Customers", "Who", "Match", "Criteria"]}}, "/admin/orders/4554953422/refunds.json"=>{"get"=>{"summary"=>"Get all refunds from a specific order", "description"=>"Get all refunds from a specific order.", "operationId"=>"getAdminOrders4554953422Refunds.json", "x-api-path-slug"=>"adminorders4554953422refunds-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Refunds", "From", "Specific", "Order"]}, "post"=>{"summary"=>"Create a new refund for an order", "description"=>"Create a new refund for an order.", "operationId"=>"postAdminOrders4554953422Refunds.json", "x-api-path-slug"=>"adminorders4554953422refunds-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Refundan", "Order"]}}, "/admin/orders/4528049998/fulfillments/3770145678/cancel.json"=>{"post"=>{"summary"=>"Cancel a fulfillment.", "description"=>"Cancel a fulfillment..", "operationId"=>"postAdminOrders4528049998Fulfillments3770145678Cancel.json", "x-api-path-slug"=>"adminorders4528049998fulfillments3770145678cancel-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Cancel", "Fulfillment"]}}, "/admin/orders/4554953422.json"=>{"get"=>{"summary"=>"Get a representation of a single order", "description"=>"Get a representation of a single order.", "operationId"=>"getAdminOrders4554953422.json", "x-api-path-slug"=>"adminorders4554953422-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Representation", "Single", "Order"]}, "put"=>{"summary"=>"Update an order", "description"=>"Update an order.", "operationId"=>"putAdminOrders4554953422.json", "x-api-path-slug"=>"adminorders4554953422-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Order"]}, "delete"=>{"summary"=>"Delete an order.", "description"=>"Delete an order..", "operationId"=>"deleteAdminOrders4554953422.json", "x-api-path-slug"=>"adminorders4554953422-json-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Order"]}}, "/admin/orders/4554953422/open.json"=>{"post"=>{"summary"=>"Re-opening a closed Order", "description"=>"Re-opening a closed order.", "operationId"=>"postAdminOrders4554953422Open.json", "x-api-path-slug"=>"adminorders4554953422open-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Re-opening", "Closed", "Order"]}}, "/admin/orders/4528049998/fulfillments/3770145678/complete.json"=>{"post"=>{"summary"=>"Complete a fulfillment.", "description"=>"Complete a fulfillment..", "operationId"=>"postAdminOrders4528049998Fulfillments3770145678Complete.json", "x-api-path-slug"=>"adminorders4528049998fulfillments3770145678complete-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Complete", "Fulfillment"]}}, "/admin/smart_collections.json"=>{"get"=>{"summary"=>"Get all collection", "description"=>"Get all collection.", "operationId"=>"getAdminSmartCollections.json", "x-api-path-slug"=>"adminsmart-collections-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Collection"]}, "post"=>{"summary"=>"Create a new collection", "description"=>"Create a new collection.", "operationId"=>"postAdminSmartCollections.json", "x-api-path-slug"=>"adminsmart-collections-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Collection"]}}, "/admin/orders/4495703502/fulfillments/3763917198/events/9519874062.json"=>{"delete"=>{"summary"=>"Delete a fulfillment event.", "description"=>"Delete a fulfillment event..", "operationId"=>"deleteAdminOrders4495703502Fulfillments3763917198Events9519874062.json", "x-api-path-slug"=>"adminorders4495703502fulfillments3763917198events9519874062-json-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Fulfillment", "Event"]}}, "/admin/events/58706658318.json"=>{"get"=>{"summary"=>"Shows the same fields as the list action.", "description"=>"Shows the same fields as the list action..", "operationId"=>"getAdminEvents58706658318.json", "x-api-path-slug"=>"adminevents58706658318-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Shows", "Same", "Fields", "As", "List", "Action"]}}, "/admin/locations/8790723.json"=>{"get"=>{"summary"=>"Get a single location", "description"=>"Get a single location.", "operationId"=>"getAdminLocations8790723.json", "x-api-path-slug"=>"adminlocations8790723-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Location"]}}, "/admin/products/7990943555/images.json"=>{"get"=>{"summary"=>"Get all product images", "description"=>"Get all product images.", "operationId"=>"getAdminProducts7990943555Images.json", "x-api-path-slug"=>"adminproducts7990943555images-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Product", "Images"]}, "post"=>{"summary"=>"Create a new product image", "description"=>"Create a new product image.", "operationId"=>"postAdminProducts7990943555Images.json", "x-api-path-slug"=>"adminproducts7990943555images-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Product", "Image"]}}, "/admin/webhooks.json"=>{"get"=>{"summary"=>"Get a list of all webhooks for your shop.", "description"=>"Get a list of all webhooks for your shop..", "operationId"=>"getAdminWebhooks.json", "x-api-path-slug"=>"adminwebhooks-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Webhooksyour", "Shop"]}, "post"=>{"summary"=>"Create a webhook", "description"=>"Create a webhook.", "operationId"=>"postAdminWebhooks.json", "x-api-path-slug"=>"adminwebhooks-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Webhook"]}}, "/admin/products/7990943555/metafields/count.json"=>{"get"=>{"summary"=>"Get a count of all metafields that belong to a product", "description"=>"Get a count of all metafields that belong to a product.", "operationId"=>"getAdminProducts7990943555MetafieldsCount.json", "x-api-path-slug"=>"adminproducts7990943555metafieldscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Metafields", "That", "Belong", "To", "Product"]}}, "/admin/orders.json"=>{"get"=>{"summary"=>"Get all orders from a customer", "description"=>"Get all orders from a customer.", "operationId"=>"getAdminOrders.json", "x-api-path-slug"=>"adminorders-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"customer_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Orders", "From", "Customer"]}, "post"=>{"summary"=>"Create a pending order with an existing customer", "description"=>"Create a pending order with an existing customer.", "operationId"=>"postAdminOrders.json", "x-api-path-slug"=>"adminorders-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Pending", "Order", "Existing", "Customer"]}}, "/admin/webhooks/count.json"=>{"get"=>{"summary"=>"Get a count of all webhooks for your shop.", "description"=>"Get a count of all webhooks for your shop..", "operationId"=>"getAdminWebhooksCount.json", "x-api-path-slug"=>"adminwebhookscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Webhooksyour", "Shop"]}}, "/admin/countries/444574734.json"=>{"put"=>{"summary"=>"update a country", "description"=>"Update a country.", "operationId"=>"putAdminCountries444574734.json", "x-api-path-slug"=>"admincountries444574734-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Update", "Country"]}, "delete"=>{"summary"=>"delete a country", "description"=>"Delete a country.", "operationId"=>"deleteAdminCountries444574734.json", "x-api-path-slug"=>"admincountries444574734-json-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Delete", "Country"]}}, "/admin/carrier_services.json"=>{"get"=>{"summary"=>"List carrier services", "description"=>"List carrier services.", "operationId"=>"getAdminCarrierServices.json", "x-api-path-slug"=>"admincarrier-services-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Carrier", "Services"]}, "post"=>{"summary"=>"Create a carrier service", "description"=>"Create a carrier service.", "operationId"=>"postAdminCarrierServices.json", "x-api-path-slug"=>"admincarrier-services-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Carrier", "Service"]}}, "/admin/collects/20713233987.json"=>{"get"=>{"summary"=>"Return a collect with a certain id", "description"=>"Return a collect with a certain id.", "operationId"=>"getAdminCollects20713233987.json", "x-api-path-slug"=>"admincollects20713233987-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Return", "Collect", "Certain", "Id"]}}, "/admin/discounts/2951196163.json"=>{"get"=>{"summary"=>"Retrieve a discount", "description"=>"Retrieve a discount.", "operationId"=>"getAdminDiscounts2951196163.json", "x-api-path-slug"=>"admindiscounts2951196163-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Discount"]}, "delete"=>{"summary"=>"Delete a discount", "description"=>"Delete a discount.", "operationId"=>"deleteAdminDiscounts2951196163.json", "x-api-path-slug"=>"admindiscounts2951196163-json-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Discount"]}}, "/admin/fulfillment_services/1357646.json"=>{"get"=>{"summary"=>"Get a single fulfillment service by its ID", "description"=>"Get a single fulfillment service by its id.", "operationId"=>"getAdminFulfillmentServices1357646.json", "x-api-path-slug"=>"adminfulfillment-services1357646-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Fulfillment", "Service", "By", "Its", "ID"]}, "put"=>{"summary"=>"Update a fulfillment service", "description"=>"Update a fulfillment service.", "operationId"=>"putAdminFulfillmentServices1357646.json", "x-api-path-slug"=>"adminfulfillment-services1357646-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Fulfillment", "Service"]}, "delete"=>{"summary"=>"Destroy a fulfillment service", "description"=>"Destroy a fulfillment service.", "operationId"=>"deleteAdminFulfillmentServices1357646.json", "x-api-path-slug"=>"adminfulfillment-services1357646-json-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Destroy", "Fulfillment", "Service"]}}, "/admin/customers/3989659651/addresses/5436816654/default.json"=>{"put"=>{"summary"=>"assigning a new default address to a customer", "description"=>"Assigning a new default address to a customer.", "operationId"=>"putAdminCustomers3989659651Addresses5436816654Default.json", "x-api-path-slug"=>"admincustomers3989659651addresses5436816654default-json-put", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Assigning", "New", "Default", "Address", "To", "Customer"]}}, "/admin/products/7990943555/variants/count.json"=>{"get"=>{"summary"=>"Get a count of variants for a product", "description"=>"Get a count of variants for a product.", "operationId"=>"getAdminProducts7990943555VariantsCount.json", "x-api-path-slug"=>"adminproducts7990943555variantscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Variantsa", "Product"]}}, "/admin/pages.json"=>{"get"=>{"summary"=>"Get a list of all pages", "description"=>"Get a list of all pages.", "operationId"=>"getAdminPages.json", "x-api-path-slug"=>"adminpages-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Pages"]}, "post"=>{"summary"=>"Create a new page", "description"=>"Create a new page.", "operationId"=>"postAdminPages.json", "x-api-path-slug"=>"adminpages-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Page"]}}, "/admin/comments/2941387470/spam.json"=>{"post"=>{"summary"=>"Mark a comment as Spam", "description"=>"Mark a comment as spam.", "operationId"=>"postAdminComments2941387470Spam.json", "x-api-path-slug"=>"admincomments2941387470spam-json-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Mark", "Comment", "As", "Spam"]}}, "/admin/customers/3989659651/addresses/set.json"=>{"put"=>{"summary"=>"destroying multiple customer addresses", "description"=>"Destroying multiple customer addresses.", "operationId"=>"putAdminCustomers3989659651AddressesSet.json", "x-api-path-slug"=>"admincustomers3989659651addressesset-json-put", "parameters"=>[{"in"=>"query", "name"=>"address_ids[]"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Destroying", "Multiple", "Customer", "Addresses"]}}, "/admin//variants/25831837123.json"=>{"get"=>{"summary"=>"Get a product variant by id", "description"=>"Get a product variant by id.", "operationId"=>"getAdminVariants25831837123.json", "x-api-path-slug"=>"adminvariants25831837123-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Product", "Variant", "By", "Id"]}}, "/admin/themes/110163843/assets.json"=>{"get"=>{"summary"=>"Get a list of all theme assets", "description"=>"Get a list of all theme assets.", "operationId"=>"getAdminThemes110163843Assets.json", "x-api-path-slug"=>"adminthemes110163843assets-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Theme", "Assets"]}, "put"=>{"summary"=>"Change an existing liquid template's value", "description"=>"Change an existing liquid template's value.", "operationId"=>"putAdminThemes110163843Assets.json", "x-api-path-slug"=>"adminthemes110163843assets-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Change", "Existing", "Liquid", "Templates", "Value"]}, "delete"=>{"summary"=>"Remove assets from your shop", "description"=>"Remove assets from your shop.", "operationId"=>"deleteAdminThemes110163843Assets.json", "x-api-path-slug"=>"adminthemes110163843assets-json-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Remove", "Assets", "From", "Your", "Shop"]}}, "/admin/redirects/count.json"=>{"get"=>{"summary"=>"Get a countt of all URL redirect", "description"=>"Get a countt of all url redirect.", "operationId"=>"getAdminRedirectsCount.json", "x-api-path-slug"=>"adminredirectscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Countt", "URL", "Redirect"]}}, "/account/login"=>{"post"=>{"summary"=>"Hack Authentication", "description"=>"Hack authentication.", "operationId"=>"postAccountLogin", "x-api-path-slug"=>"accountlogin-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"formData", "name"=>"customer[email]"}, {"in"=>"formData", "name"=>"customer[{{password}}]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Hack", "Authentication"]}}, "/admin/comments.json"=>{"get"=>{"summary"=>"Get a list of all comments", "description"=>"Get a list of all comments.", "operationId"=>"getAdminComments.json", "x-api-path-slug"=>"admincomments-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Comments"]}}, "/admin/products/7990943555/images/19489404942.json"=>{"get"=>{"summary"=>"Get a single product image by id", "description"=>"Get a single product image by id.", "operationId"=>"getAdminProducts7990943555Images19489404942.json", "x-api-path-slug"=>"adminproducts7990943555images19489404942-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Product", "Image", "By", "Id"]}, "put"=>{"summary"=>"Modify an existing product image", "description"=>"Modify an existing product image.", "operationId"=>"putAdminProducts7990943555Images19489404942.json", "x-api-path-slug"=>"adminproducts7990943555images19489404942-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Modify", "Existing", "Product", "Image"]}, "delete"=>{"summary"=>"Delete a product image", "description"=>"Delete a product image.", "operationId"=>"deleteAdminProducts7990943555Images19489404942.json", "x-api-path-slug"=>"adminproducts7990943555images19489404942-json-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Product", "Image"]}}, "/admin/comments/2941387470/remove.json"=>{"post"=>{"summary"=>"Remove a comment", "description"=>"Remove a comment.", "operationId"=>"postAdminComments2941387470Remove.json", "x-api-path-slug"=>"admincomments2941387470remove-json-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Remove", "Comment"]}}, "/admin/countries/261414723/provinces/count.json"=>{"get"=>{"summary"=>"Get a count of all provinces", "description"=>"Get a count of all provinces.", "operationId"=>"getAdminCountries261414723ProvincesCount.json", "x-api-path-slug"=>"admincountries261414723provincescount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Provinces"]}}, "/admin/products/7990943555/variants.json"=>{"get"=>{"summary"=>"Get all variants for a product", "description"=>"Get all variants for a product.", "operationId"=>"getAdminProducts7990943555Variants.json", "x-api-path-slug"=>"adminproducts7990943555variants-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Variantsa", "Product"]}, "post"=>{"summary"=>"Create a new product variant", "description"=>"Create a new product variant.", "operationId"=>"postAdminProducts7990943555Variants.json", "x-api-path-slug"=>"adminproducts7990943555variants-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Product", "Variant"]}}, "/admin/themes/110163843.json"=>{"get"=>{"summary"=>"Get a single theme", "description"=>"Get a single theme.", "operationId"=>"getAdminThemes110163843.json", "x-api-path-slug"=>"adminthemes110163843-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Theme"]}}, "/admin/customers/5438892686.json"=>{"put"=>{"summary"=>"Add metafield to an existing customer", "description"=>"Add metafield to an existing customer.", "operationId"=>"putAdminCustomers5438892686.json", "x-api-path-slug"=>"admincustomers5438892686-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Metafield", "To", "Existing", "Customer"]}, "delete"=>{"summary"=>"Remove an existing customer", "description"=>"Remove an existing customer.", "operationId"=>"deleteAdminCustomers5438892686.json", "x-api-path-slug"=>"admincustomers5438892686-json-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Remove", "Existing", "Customer"]}}, "/admin/customer_saved_searches/count.json"=>{"get"=>{"summary"=>"Get a count of all customer saved searches", "description"=>"Get a count of all customer saved searches.", "operationId"=>"getAdminCustomerSavedSearchesCount.json", "x-api-path-slug"=>"admincustomer-saved-searchescount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Customer", "Saved", "Searches"]}}, "/admin/gift_cards/61810574.json"=>{"put"=>{"summary"=>"Update the expiry date of a gift card", "description"=>"Update the expiry date of a gift card.", "operationId"=>"putAdminGiftCards61810574.json", "x-api-path-slug"=>"admingift-cards61810574-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Expiry", "Date", "Gift", "Card"]}}, "/admin/discounts.json"=>{"get"=>{"summary"=>"List all discounts", "description"=>"List all discounts.", "operationId"=>"getAdminDiscounts.json", "x-api-path-slug"=>"admindiscounts-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Discounts"]}, "post"=>{"summary"=>"Create a discount", "description"=>"Create a discount.", "operationId"=>"postAdminDiscounts.json", "x-api-path-slug"=>"admindiscounts-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Discount"]}}, "/admin/orders/4528049998/fulfillments/3770145678.json"=>{"get"=>{"summary"=>"Get the Representation of a specific fulfillment.", "description"=>"Get the representation of a specific fulfillment..", "operationId"=>"getAdminOrders4528049998Fulfillments3770145678.json", "x-api-path-slug"=>"adminorders4528049998fulfillments3770145678-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Representation", "Specific", "Fulfillment"]}, "put"=>{"summary"=>"Update tracking number for a fulfillment.", "description"=>"Update tracking number for a fulfillment..", "operationId"=>"putAdminOrders4528049998Fulfillments3770145678.json", "x-api-path-slug"=>"adminorders4528049998fulfillments3770145678-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Tracking", "Numbera", "Fulfillment"]}}, "/admin/blogs/92408974.json"=>{"put"=>{"summary"=>"Update a blog", "description"=>"Update a blog.", "operationId"=>"putAdminBlogs92408974.json", "x-api-path-slug"=>"adminblogs92408974-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Blog"]}, "delete"=>{"summary"=>"Delete a blog", "description"=>"Delete a blog.", "operationId"=>"deleteAdminBlogs92408974.json", "x-api-path-slug"=>"adminblogs92408974-json-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Blog"]}}, "/admin/locations.json"=>{"get"=>{"summary"=>"Get a list of all locations for a shop", "description"=>"Get a list of all locations for a shop.", "operationId"=>"getAdminLocations.json", "x-api-path-slug"=>"adminlocations-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Locationsa", "Shop"]}}, "/admin/orders/4528049998/fulfillments/3770145678/events/\#{event_id}.json"=>{"get"=>{"summary"=>"Fetch a fulfillment event.", "description"=>"Fetch a fulfillment event..", "operationId"=>"getAdminOrders4528049998Fulfillments3770145678Events#Event.json", "x-api-path-slug"=>"adminorders4528049998fulfillments3770145678eventsevent-id-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"event_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Fetch", "Fulfillment", "Event"]}}, "/admin/carrier_services/13841038.json"=>{"get"=>{"summary"=>"Update a carrier service", "description"=>"Update a carrier service.", "operationId"=>"getAdminCarrierServices13841038.json", "x-api-path-slug"=>"admincarrier-services13841038-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Carrier", "Service"]}, "delete"=>{"summary"=>"Destroy a carrier service", "description"=>"Destroy a carrier service.", "operationId"=>"deleteAdminCarrierServices13841038.json", "x-api-path-slug"=>"admincarrier-services13841038-json-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Destroy", "Carrier", "Service"]}}, "/admin/orders/4554953422/transactions.json"=>{"get"=>{"summary"=>"Get all transactions for an order", "description"=>"Get all transactions for an order.", "operationId"=>"getAdminOrders4554953422Transactions.json", "x-api-path-slug"=>"adminorders4554953422transactions-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Transactionsan", "Order"]}, "post"=>{"summary"=>"Capture a previously authorized order for the full amount", "description"=>"Capture a previously authorized order for the full amount.", "operationId"=>"postAdminOrders4554953422Transactions.json", "x-api-path-slug"=>"adminorders4554953422transactions-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Capture", "Previously", "Authorized", "Orderthe", "Full", "Amount"]}}, "/admin/orders/4528049998/fulfillments/3770145678/open.json"=>{"post"=>{"summary"=>"Transition a fulfillment from pending to open.", "description"=>"Transition a fulfillment from pending to open..", "operationId"=>"postAdminOrders4528049998Fulfillments3770145678Open.json", "x-api-path-slug"=>"adminorders4528049998fulfillments3770145678open-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Transition", "Fulfillment", "From", "Pending", "To", "Open"]}}, "/admin/blogs/62581763/articles/197247246.json"=>{"delete"=>{"summary"=>"Delete an article of a blog tags of articles", "description"=>"Delete an article of a blog tags of articles.", "operationId"=>"deleteAdminBlogs62581763Articles197247246.json", "x-api-path-slug"=>"adminblogs62581763articles197247246-json-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Article", "Blog", "Tags", "Articles"]}}, "/admin/comments/2941387470/approve.json"=>{"post"=>{"summary"=>"Approve a comment", "description"=>"Approve a comment.", "operationId"=>"postAdminComments2941387470Approve.json", "x-api-path-slug"=>"admincomments2941387470approve-json-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Approve", "Comment"]}}, "/admin/checkouts.json"=>{"get"=>{"summary"=>"List all abandoned checkouts", "description"=>"List all abandoned checkouts.", "operationId"=>"getAdminCheckouts.json", "x-api-path-slug"=>"admincheckouts-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Abandoned", "Checkouts"]}}, "/admin/redirects/293743566.json"=>{"put"=>{"summary"=>"Update a redirect", "description"=>"Update a redirect.", "operationId"=>"putAdminRedirects293743566.json", "x-api-path-slug"=>"adminredirects293743566-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Redirect"]}, "delete"=>{"summary"=>"delete a redirect", "description"=>"Delete a redirect.", "operationId"=>"deleteAdminRedirects293743566.json", "x-api-path-slug"=>"adminredirects293743566-json-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Delete", "Redirect"]}}, "/admin/gift_cards/search.json"=>{"get"=>{"summary"=>"Get all gift cards that matches the query", "description"=>"Get all gift cards that matches the query.", "operationId"=>"getAdminGiftCardsSearch.json", "x-api-path-slug"=>"admingift-cardssearch-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Gift", "Cards", "That", "Matches", "Query"]}}, "/admin/customer_saved_searches.json"=>{"get"=>{"summary"=>"Get all customer saved searches for a shop", "description"=>"Get all customer saved searches for a shop.", "operationId"=>"getAdminCustomerSavedSearches.json", "x-api-path-slug"=>"admincustomer-saved-searches-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Customer", "Saved", "Searchesa", "Shop"]}, "post"=>{"summary"=>"Create a new Customer Saved Search", "description"=>"Create a new customer saved search.", "operationId"=>"postAdminCustomerSavedSearches.json", "x-api-path-slug"=>"admincustomer-saved-searches-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Customer", "Saved", "Search"]}}, "/admin/customers/3989659651.json"=>{"get"=>{"summary"=>"Get a single customer by ID", "description"=>"Get a single customer by id.", "operationId"=>"getAdminCustomers3989659651.json", "x-api-path-slug"=>"admincustomers3989659651-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Customer", "By", "ID"]}}, "/admin/products/count.json"=>{"get"=>{"summary"=>"Count all products", "description"=>"Count all products.", "operationId"=>"getAdminProductsCount.json", "x-api-path-slug"=>"adminproductscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Products"]}}, "/admin/redirects.json"=>{"get"=>{"summary"=>"Get a list of all URL redirect", "description"=>"Get a list of all url redirect.", "operationId"=>"getAdminRedirects.json", "x-api-path-slug"=>"adminredirects-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "URL", "Redirect"]}, "post"=>{"summary"=>"Create a new redirect.", "description"=>"Create a new redirect..", "operationId"=>"postAdminRedirects.json", "x-api-path-slug"=>"adminredirects-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Redirect"]}}, "/admin/orders/count.json"=>{"get"=>{"summary"=>"Count all orders", "description"=>"Count all orders.", "operationId"=>"getAdminOrdersCount.json", "x-api-path-slug"=>"adminorderscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Orders"]}}, "/admin/collects/921728736.json"=>{"delete"=>{"summary"=>"Remove a product from a collection", "description"=>"Remove a product from a collection.", "operationId"=>"deleteAdminCollects921728736.json", "x-api-path-slug"=>"admincollects921728736-json-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Remove", "Product", "From", "Collection"]}}, "/admin/orders/4528049998/fulfillments/3770145678/events.json"=>{"get"=>{"summary"=>"Get a list of all fulfillment events for a fulfillment", "description"=>"Get a list of all fulfillment events for a fulfillment.", "operationId"=>"getAdminOrders4528049998Fulfillments3770145678Events.json", "x-api-path-slug"=>"adminorders4528049998fulfillments3770145678events-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Fulfillment", "Eventsa", "Fulfillment"]}}, "/admin/comments/2941387470/not_spam.json"=>{"post"=>{"summary"=>"Mark a comment as not spam", "description"=>"Mark a comment as not spam.", "operationId"=>"postAdminComments2941387470NotSpam.json", "x-api-path-slug"=>"admincomments2941387470not-spam-json-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Mark", "Comment", "As", "Not", "Spam"]}}, "/admin/products/7990943555/images/count.json"=>{"get"=>{"summary"=>"Get a count of all product images", "description"=>"Get a count of all product images.", "operationId"=>"getAdminProducts7990943555ImagesCount.json", "x-api-path-slug"=>"adminproducts7990943555imagescount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Product", "Images"]}}, "/admin/script_tags.json"=>{"get"=>{"summary"=>"Get a list of all script tags", "description"=>"Get a list of all script tags.", "operationId"=>"getAdminScriptTags.json", "x-api-path-slug"=>"adminscript-tags-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Script", "Tags"]}, "post"=>{"summary"=>"create a new script tag", "description"=>"Create a new script tag.", "operationId"=>"postAdminScriptTags.json", "x-api-path-slug"=>"adminscript-tags-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Create", "New", "Script", "Tag"]}}, "/admin/orders/4495703502/fulfillments/3763917198/events.json"=>{"post"=>{"summary"=>"Create a fulfillment event.", "description"=>"Create a fulfillment event..", "operationId"=>"postAdminOrders4495703502Fulfillments3763917198Events.json", "x-api-path-slug"=>"adminorders4495703502fulfillments3763917198events-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Fulfillment", "Event"]}}, "/admin/customers/count.json"=>{"get"=>{"summary"=>"Get a count of all customers", "description"=>"Get a count of all customers.", "operationId"=>"getAdminCustomersCount.json", "x-api-path-slug"=>"admincustomerscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Customers"]}}, "/admin/orders/4554953422/transactions/5016037966.json"=>{"get"=>{"summary"=>"Get a specific transaction", "description"=>"Get a specific transaction.", "operationId"=>"getAdminOrders4554953422Transactions5016037966.json", "x-api-path-slug"=>"adminorders4554953422transactions5016037966-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Specific", "Transaction"]}}, "/admin/application_charges/1.json"=>{"get"=>{"summary"=>"Retrieve one-time application charge", "description"=>"Retrieve one-time application charge.", "operationId"=>"getAdminApplicationCharges1.json", "x-api-path-slug"=>"adminapplication-charges1-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "One-time", "Application", "Charge"]}}, "/admin/orders/4528049998/fulfillments/count.json"=>{"get"=>{"summary"=>"Count all the total number of fulfillments for an order.", "description"=>"Count all the total number of fulfillments for an order..", "operationId"=>"getAdminOrders4528049998FulfillmentsCount.json", "x-api-path-slug"=>"adminorders4528049998fulfillmentscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Total", "Number", "Fulfillmentsan", "Order"]}}, "/admin/application_charges/675931192/activate.json"=>{"post"=>{"summary"=>"Activate a one-time charge", "description"=>"Activate a one-time charge.", "operationId"=>"postAdminApplicationCharges675931192Activate.json", "x-api-path-slug"=>"adminapplication-charges675931192activate-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Activate", "One-time", "Charge"]}}, "/admin/shop.json"=>{"get"=>{"summary"=>"Get the configuration of the shop account", "description"=>"Get the configuration of the shop account.", "operationId"=>"getAdminShop.json", "x-api-path-slug"=>"adminshop-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Configuration", "Shop", "Account"]}}, "/admin/blogs/62581763.json"=>{"get"=>{"summary"=>"Get a single blog by its ID", "description"=>"Get a single blog by its id.", "operationId"=>"getAdminBlogs62581763.json", "x-api-path-slug"=>"adminblogs62581763-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Blog", "By", "Its", "ID"]}}, "/admin/products/7990943555/metafields/33058305934.json"=>{"get"=>{"summary"=>"Get a single product metafield using the metafield's nested resource path", "description"=>"Get a single product metafield using the metafield's nested resource path.", "operationId"=>"getAdminProducts7990943555Metafields33058305934.json", "x-api-path-slug"=>"adminproducts7990943555metafields33058305934-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Product", "Metafield", "Using", "Metafields", "Nested", "Resource", "Path"]}, "put"=>{"summary"=>"Update an existing metafield belonging to a product", "description"=>"Update an existing metafield belonging to a product.", "operationId"=>"putAdminProducts7990943555Metafields33058305934.json", "x-api-path-slug"=>"adminproducts7990943555metafields33058305934-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Existing", "Metafield", "Belonging", "To", "Product"]}, "delete"=>{"summary"=>"Delete a product metafield", "description"=>"Delete a product metafield.", "operationId"=>"deleteAdminProducts7990943555Metafields33058305934.json", "x-api-path-slug"=>"adminproducts7990943555metafields33058305934-json-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Product", "Metafield"]}}, "/admin/countries/261414723/provinces.json"=>{"get"=>{"summary"=>"Get all provinces", "description"=>"Get all provinces.", "operationId"=>"getAdminCountries261414723Provinces.json", "x-api-path-slug"=>"admincountries261414723provinces-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Provinces"]}}, "/admin/discounts/2951196163/disable.json"=>{"post"=>{"summary"=>"Disable a discount", "description"=>"Disable a discount.", "operationId"=>"postAdminDiscounts2951196163Disable.json", "x-api-path-slug"=>"admindiscounts2951196163disable-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Disable", "Discount"]}}, "/admin/redirects/count/7376372.json"=>{"get"=>{"summary"=>"Get a single URL redirect", "description"=>"Get a single url redirect.", "operationId"=>"getAdminRedirectsCount7376372.json", "x-api-path-slug"=>"adminredirectscount7376372-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "URL", "Redirect"]}}, "/admin/smart_collections/count.json"=>{"get"=>{"summary"=>"Get a count of all collections", "description"=>"Get a count of all collections.", "operationId"=>"getAdminSmartCollectionsCount.json", "x-api-path-slug"=>"adminsmart-collectionscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Collections"]}}, "/admin/products/7990943555/metafields.json"=>{"get"=>{"summary"=>"Get all metafields that belong to a product", "description"=>"Get all metafields that belong to a product.", "operationId"=>"getAdminProducts7990943555Metafields.json", "x-api-path-slug"=>"adminproducts7990943555metafields-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Metafields", "That", "Belong", "To", "Product"]}, "post"=>{"summary"=>"Create a new metafield for a product.", "description"=>"Create a new metafield for a product..", "operationId"=>"postAdminProducts7990943555Metafields.json", "x-api-path-slug"=>"adminproducts7990943555metafields-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Metafielda", "Product"]}}, "/admin/products.json"=>{"get"=>{"summary"=>"Get all products", "description"=>"Get all products.", "operationId"=>"getAdminProducts.json", "x-api-path-slug"=>"adminproducts-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Products"]}, "post"=>{"summary"=>"Create a new product with multiple product variants", "description"=>"Create a new product with multiple product variants.", "operationId"=>"postAdminProducts.json", "x-api-path-slug"=>"adminproducts-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Product", "Multiple", "Product", "Variants"]}}, "/admin/customer_saved_searches/2029905294.json"=>{"put"=>{"summary"=>"Update an existing Customer Saved Search", "description"=>"Update an existing customer saved search.", "operationId"=>"putAdminCustomerSavedSearches2029905294.json", "x-api-path-slug"=>"admincustomer-saved-searches2029905294-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Existing", "Customer", "Saved", "Search"]}, "delete"=>{"summary"=>"Delete an existing Customer Saved Search", "description"=>"Delete an existing customer saved search.", "operationId"=>"deleteAdminCustomerSavedSearches2029905294.json", "x-api-path-slug"=>"admincustomer-saved-searches2029905294-json-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Existing", "Customer", "Saved", "Search"]}}, "/admin/customer_saved_searches/1189248515.json"=>{"get"=>{"summary"=>"Get one customer saved search by ID", "description"=>"Get one customer saved search by id.", "operationId"=>"getAdminCustomerSavedSearches1189248515.json", "x-api-path-slug"=>"admincustomer-saved-searches1189248515-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Customer", "Saved", "Search", "By", "ID"]}}, "/admin/custom_collections/count.json"=>{"get"=>{"summary"=>"Get a count of all custom collections", "description"=>"Get a count of all custom collections.", "operationId"=>"getAdminCustomCollectionsCount.json", "x-api-path-slug"=>"admincustom-collectionscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Custom", "Collections"]}}, "/admin/script_tags/108074126.json"=>{"put"=>{"summary"=>"update a script tag", "description"=>"Update a script tag.", "operationId"=>"putAdminScriptTags108074126.json", "x-api-path-slug"=>"adminscript-tags108074126-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Update", "Script", "Tag"]}, "delete"=>{"summary"=>"remove a script tag", "description"=>"Remove a script tag.", "operationId"=>"deleteAdminScriptTags108074126.json", "x-api-path-slug"=>"adminscript-tags108074126-json-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Remove", "Script", "Tag"]}}, "/admin/products/7990943555/events.json"=>{"get"=>{"summary"=>"Get all the events from a particular product", "description"=>"Get all the events from a particular product.", "operationId"=>"getAdminProducts7990943555Events.json", "x-api-path-slug"=>"adminproducts7990943555events-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Events", "From", "Particular", "Product"]}}, "/admin/themes/164593742.json"=>{"put"=>{"summary"=>"Update a theme's attributes", "description"=>"Update a theme's attributes.", "operationId"=>"putAdminThemes164593742.json", "x-api-path-slug"=>"adminthemes164593742-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Themes", "Attributes"]}, "delete"=>{"summary"=>"Delete a theme", "description"=>"Delete a theme.", "operationId"=>"deleteAdminThemes164593742.json", "x-api-path-slug"=>"adminthemes164593742-json-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Theme"]}}, "/admin/orders/4554953422/refunds/646546.json"=>{"get"=>{"summary"=>"Get a representation of a single refund", "description"=>"Get a representation of a single refund.", "operationId"=>"getAdminOrders4554953422Refunds646546.json", "x-api-path-slug"=>"adminorders4554953422refunds646546-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Representation", "Single", "Refund"]}}, "/admin/events/count.json"=>{"get"=>{"summary"=>"Count all the events", "description"=>"Count all the events.", "operationId"=>"getAdminEventsCount.json", "x-api-path-slug"=>"admineventscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Events"]}}, "/admin/recurring_application_charges.json"=>{"post"=>{"summary"=>"Create a new charge", "description"=>"Create a new charge.", "operationId"=>"postAdminRecurringApplicationCharges.json", "x-api-path-slug"=>"adminrecurring-application-charges-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Charge"]}}, "/admin/products/7990943555/variants/34705478094.json"=>{"delete"=>{"summary"=>"Delete a product variant", "description"=>"Delete a product variant.", "operationId"=>"deleteAdminProducts7990943555Variants34705478094.json", "x-api-path-slug"=>"adminproducts7990943555variants34705478094-json-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Product", "Variant"]}}, "/admin/comments/count.json"=>{"get"=>{"summary"=>"Get a count of all comments", "description"=>"Get a count of all comments.", "operationId"=>"getAdminCommentsCount.json", "x-api-path-slug"=>"admincommentscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Comments"]}}, "/admin/script_tags/count.json"=>{"get"=>{"summary"=>"Get a count of all script tags", "description"=>"Get a count of all script tags.", "operationId"=>"getAdminScriptTagsCount.json", "x-api-path-slug"=>"adminscript-tagscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Script", "Tags"]}}, "/admin/collects/count.json"=>{"get"=>{"summary"=>"Get a count of all collects", "description"=>"Get a count of all collects.", "operationId"=>"getAdminCollectsCount.json", "x-api-path-slug"=>"admincollectscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Collects"]}}, "/admin/customers.json"=>{"get"=>{"summary"=>"Retrieve all customers", "description"=>"Retrieve all customers.", "operationId"=>"getAdminCustomers.json", "x-api-path-slug"=>"admincustomers-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Retrieve", "Customers"]}, "post"=>{"summary"=>"Create a new customer record", "description"=>"Create a new customer record.", "operationId"=>"postAdminCustomers.json", "x-api-path-slug"=>"admincustomers-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Customer", "Record"]}}, "/admin/countries/261414723/provinces/4003640003.json"=>{"get"=>{"summary"=>"get a single province", "description"=>"Get a single province.", "operationId"=>"getAdminCountries261414723Provinces4003640003.json", "x-api-path-slug"=>"admincountries261414723provinces4003640003-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Get", "Single", "Province"]}, "put"=>{"summary"=>"Update a province's tax rate", "description"=>"Update a province's tax rate.", "operationId"=>"putAdminCountries261414723Provinces4003640003.json", "x-api-path-slug"=>"admincountries261414723provinces4003640003-json-put", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Provinces", "Tax", "Rate"]}}, "/admin/smart_collections/408154574.json"=>{"delete"=>{"summary"=>"Delete a single collection", "description"=>"Delete a single collection.", "operationId"=>"deleteAdminSmartCollections408154574.json", "x-api-path-slug"=>"adminsmart-collections408154574-json-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Collection"]}}, "/admin/countries/261414723.json"=>{"get"=>{"summary"=>"Show Country", "description"=>"Show country.", "operationId"=>"getAdminCountries261414723.json", "x-api-path-slug"=>"admincountries261414723-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Show", "Country"]}}, "/admin/comments/2941387470/restore.json"=>{"post"=>{"summary"=>"restore a comment", "description"=>"Restore a comment.", "operationId"=>"postAdminComments2941387470Restore.json", "x-api-path-slug"=>"admincomments2941387470restore-json-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Restore", "Comment"]}}, "//admin/collects.json"=>{"post"=>{"summary"=>"Add a product to a collection", "description"=>"Add a product to a collection.", "operationId"=>"postAdminCollects.json", "x-api-path-slug"=>"admincollects-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Product", "To", "Collection"]}}, "/admin/blogs/count.json"=>{"get"=>{"summary"=>"Get a count of all blogs", "description"=>"Get a count of all blogs.", "operationId"=>"getAdminBlogsCount.json", "x-api-path-slug"=>"adminblogscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Blogs"]}}, "/admin/countries/count.json"=>{"get"=>{"summary"=>"Get a count of all countries", "description"=>"Get a count of all countries.", "operationId"=>"getAdminCountriesCount.json", "x-api-path-slug"=>"admincountriescount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Countries"]}}, "/admin/products/7990943555.json"=>{"get"=>{"summary"=>"Get a single product", "description"=>"Get a single product.", "operationId"=>"getAdminProducts7990943555.json", "x-api-path-slug"=>"adminproducts7990943555-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Product"]}}, "/admin/webhooks/93838927.json"=>{"get"=>{"summary"=>"Get a single webhook by its id.", "description"=>"Get a single webhook by its id..", "operationId"=>"getAdminWebhooks93838927.json", "x-api-path-slug"=>"adminwebhooks93838927-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Webhook", "By", "Its", "Id"]}}, "/admin/customers/3989659651/addresses/5436816654.json"=>{"get"=>{"summary"=>"Get a single customers address", "description"=>"Get a single customers address.", "operationId"=>"getAdminCustomers3989659651Addresses5436816654.json", "x-api-path-slug"=>"admincustomers3989659651addresses5436816654-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Customers", "Address"]}}, "/admin/articles/authors.json"=>{"get"=>{"summary"=>"Get a list of all the authors of articles", "description"=>"Get a list of all the authors of articles.", "operationId"=>"getAdminArticlesAuthors.json", "x-api-path-slug"=>"adminarticlesauthors-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "List", "Authors", "Articles"]}}, "/admin/themes.json"=>{"get"=>{"summary"=>"Get all shop themes", "description"=>"Get all shop themes.", "operationId"=>"getAdminThemes.json", "x-api-path-slug"=>"adminthemes-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Shop", "Themes"]}, "post"=>{"summary"=>"Create a new theme", "description"=>"Create a new theme.", "operationId"=>"postAdminThemes.json", "x-api-path-slug"=>"adminthemes-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "New", "Theme"]}}, "/admin/shipping_zones.json"=>{"get"=>{"summary"=>"Show list of shipping zones", "description"=>"Show list of shipping zones.", "operationId"=>"getAdminShippingZones.json", "x-api-path-slug"=>"adminshipping-zones-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Show", "List", "Shipping", "Zones"]}}, "/admin/checkouts/count.json"=>{"get"=>{"summary"=>"Get a count of checkouts", "description"=>"Get a count of checkouts.", "operationId"=>"getAdminCheckoutsCount.json", "x-api-path-slug"=>"admincheckoutscount-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Count", "Checkouts"]}}, "/admin/pages/169722563.json"=>{"get"=>{"summary"=>"Get a single page by its ID", "description"=>"Get a single page by its id.", "operationId"=>"getAdminPages169722563.json", "x-api-path-slug"=>"adminpages169722563-json-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Single", "Page", "By", "Its", "ID"]}}, "/admin/discounts/2951196163/enable.json"=>{"post"=>{"summary"=>"Enable a discount", "description"=>"Enable a discount.", "operationId"=>"postAdminDiscounts2951196163Enable.json", "x-api-path-slug"=>"admindiscounts2951196163enable-json-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commerce", "Enable", "Discount"]}}}}, "apis"=>{"name"=>"Shopify", "x-slug"=>"shopify", "description"=>"Shopify is a commerce platform that allows anyone to easily sell online at a retail location and everywhere in between. It offers a professional online storefront, a payment solution to accept credit cards, and the Shopify POS application to power retail sales.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Shopify-logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"Commerce,Commerce,Relative Data,Service API,Stack Network,Target", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"shopify/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Shopify", "x-api-slug"=>"shopify", "description"=>"Shopify is a commerce platform that allows anyone to easily sell online at a retail location and everywhere in between. It offers a professional online storefront, a payment solution to accept credit cards, and the Shopify POS application to power retail sales.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Shopify-logo.png", "humanURL"=>"https://www.shopify.com/", "baseURL"=>"https://DefaultParameterValue:DefaultParameterValue@DefaultParameterValue.myshopify.com//", "tags"=>"Commerce,Commerce,Relative Data,Service API,Stack Network,Target", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/shopify/shopify-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog-rss", "url"=>"http://feeds.feedburner.com/Pixelsoup"}, {"type"=>"x-documentation", "url"=>"https://docs.shopify.com/api"}, {"type"=>"x-forum", "url"=>"https://ecommerce.shopify.com/forums"}, {"type"=>"x-github", "url"=>"https://github.com/Shopify"}, {"type"=>"x-partners", "url"=>"https://www.shopify.com/partners"}, {"type"=>"x-postman-collection", "url"=>"https://app.getpostman.com/run-collection/85379f45579be9cd306c"}, {"type"=>"x-pricing", "url"=>"https://www.shopify.com/pricing"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/shopify"}, {"type"=>"x-website", "url"=>"https://www.shopify.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-source-repositories{"cloud-source-repositories-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Source Repositories", "x-complete"=>1, "info"=>{"title"=>"Cloud Source Repositories", "description"=>"access-source-code-repositories-hosted-by-google-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"sourcerepo.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/{name}"=>{"delete"=>{"summary"=>"Delete Repo", "description"=>"Deletes a repo.", "operationId"=>"sourcerepo.projects.repos.delete", "x-api-path-slug"=>"v1name-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the repo to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repository"]}, "get"=>{"summary"=>"Get Repo", "description"=>"Returns information about a repo.", "operationId"=>"sourcerepo.projects.repos.get", "x-api-path-slug"=>"v1name-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the requested repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repository"]}}, "/v1/{name}/repos"=>{"get"=>{"summary"=>"Get Repos", "description"=>"Returns all repos belonging to a project.", "operationId"=>"sourcerepo.projects.repos.list", "x-api-path-slug"=>"v1namerepos-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The project ID whose repos should be listed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repository"]}}, "/v1/{parent}/repos"=>{"post"=>{"summary"=>"Create Repo", "description"=>"Creates a repo in the given project with the given name..\n\nIf the named repository already exists, `CreateRepo` returns\n`ALREADY_EXISTS`.", "operationId"=>"sourcerepo.projects.repos.create", "x-api-path-slug"=>"v1parentrepos-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"parent", "description"=>"The project in which to create the repo"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repository"]}}, "/v1/{resource}:getIamPolicy"=>{"get"=>{"summary"=>"Get Access Control Policy", "description"=>"Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", "operationId"=>"sourcerepo.projects.repos.getIamPolicy", "x-api-path-slug"=>"v1resourcegetiampolicy-get", "parameters"=>[{"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repository Policy"]}}, "/v1/{resource}:setIamPolicy"=>{"post"=>{"summary"=>"Set Access Control Policy", "description"=>"Sets the access control policy on the specified resource. Replaces any\nexisting policy.", "operationId"=>"sourcerepo.projects.repos.setIamPolicy", "x-api-path-slug"=>"v1resourcesetiampolicy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy is being specified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repository Policy"]}}, "/v1/{resource}:testIamPermissions"=>{"post"=>{"summary"=>"Return Permissions", "description"=>"Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.", "operationId"=>"sourcerepo.projects.repos.testIamPermissions", "x-api-path-slug"=>"v1resourcetestiampermissions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy detail is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repository Policy"]}}}}, "apis"=>{"name"=>"Google Cloud Source Repositories", "x-slug"=>"google-cloud-source-repositories", "description"=>"Google Cloud Source Repositories provides Git version control to support collaborative development of any application or service, including those that run on Google App Engine and Google Compute Engine. If you are using the Stackdriver Debugger, you can use Cloud Source Repositories and related tools to view debugging information alongside your code during application runtime. Cloud Source Repositories also provides a source browser that you can use to view your repository files from within the Cloud Console.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-cloud-repositories.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Code,GitHub,Google APIs,Orchestration,Profiles,Relative Data,SDK,SDKs,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-source-repositories/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Cloud Source Repositories API", "x-api-slug"=>"cloud-source-repositories-api", "description"=>"Google Cloud Source Repositories provides Git version control to support collaborative development of any application or service, including those that run on Google App Engine and Google Compute Engine. If you are using the Stackdriver Debugger, you can use Cloud Source Repositories and related tools to view debugging information alongside your code during application runtime. Cloud Source Repositories also provides a source browser that you can use to view your repository files from within the Cloud Console.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-cloud-repositories.png", "humanURL"=>"https://cloud.google.com/source-repositories/", "baseURL"=>"://sourcerepo.googleapis.com//", "tags"=>"API Provider,API Service Provider,Code,GitHub,Google APIs,Orchestration,Profiles,Relative Data,SDK,SDKs,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-source-repositories/cloud-source-repositories-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-concepts", "url"=>"https://cloud.google.com/source-repositories/docs/concepts"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/source-repositories/docs/"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/source-repositories/docs/quickstart"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/source-repositories/docs/how-to"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/source-repositories/pricing"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/source-repositories/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
danske-bank{"danske-bank-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Danske Bank", "x-complete"=>1, "info"=>{"title"=>"Danske Bank", "description"=>"this-is-an-openapi-definition-for-the-standard-set-of-open-banking-httpopenbankingapis-io-apis-for-danske-bank-", "termsOfService"=>"https://www.openbanking.org.uk/open-licence/", "contact"=>{"name"=>"API Evangelist", "url"=>"https://apievangelist.com", "email"=>"info@apievangelist.com"}, "version"=>"1.0.0"}, "host"=>"obp-data.danskebank.com", "basePath"=>"open-banking/v2.1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"atms/"=>{"get"=>{"summary"=>"Get ATMs", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can provide multiple ATMs.", "operationId"=>"getATMS", "x-api-path-slug"=>"atms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Atms"]}}, "branches/"=>{"get"=>{"summary"=>"Get Branches", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple branches.", "operationId"=>"getBranches", "x-api-path-slug"=>"branches-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branches"]}}, "personal-current-accounts/"=>{"get"=>{"summary"=>"Get Current Personal Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple PCA products.", "operationId"=>"getCurrentPersonalAccounts", "x-api-path-slug"=>"personalcurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Personal", "Current", "Accounts"]}}, "business-current-accounts/"=>{"get"=>{"summary"=>"Get Current Business Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple BCA products.", "operationId"=>"getCurentBusinessAccounts", "x-api-path-slug"=>"businesscurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Business", "Current", "Accounts"]}}, "unsecured-sme-loans/"=>{"get"=>{"summary"=>"Get Unsecured SME Loans", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Unsecured Loan products.", "operationId"=>"pathOperation", "x-api-path-slug"=>"unsecuredsmeloans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsecured", "Sme", "Loans"]}}}}, "apis"=>{"name"=>"Danske Bank", "x-slug"=>"danske-bank", "description"=>"Danske Bank is a Danish bank whose name also literally translates into Danish Bank. It was founded 5 October 1871 as Den Danske Landmandsbank, Hypothek- og Vexelbank i Kjbenhavn (The Danish Farmers Bank, Mortgage and Exchange Bank of Copenhagen). Headquartered in Copenhagen, it is the largest bank in Denmark and a major retail bank in the northern European region with over 5 million retail customers. Danske Bank was number 454 on the Fortune Global 500 list for 2011.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28107-danske-bank.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"55813", "tags"=>"API Provider,Banking,Danish Bank,Financial Services,General Data,Insurance,Profiles,Relative Data,UK Banks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"danske-bank/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Danske Bank", "x-api-slug"=>"danske-bank", "description"=>"Danske Bank is a Danish bank whose name also literally translates into Danish Bank. It was founded 5 October 1871 as Den Danske Landmandsbank, Hypothek- og Vexelbank i Kjbenhavn (The Danish Farmers Bank, Mortgage and Exchange Bank of Copenhagen). Headquartered in Copenhagen, it is the largest bank in Denmark and a major retail bank in the northern European region with over 5 million retail customers. Danske Bank was number 454 on the Fortune Global 500 list for 2011.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28107-danske-bank.jpg", "humanURL"=>"https://danskebank.com", "baseURL"=>"https://obp-data.danskebank.com/open-banking/v2.1/", "tags"=>"API Provider,Banking,Danish Bank,Financial Services,General Data,Insurance,Profiles,Relative Data,UK Banks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/danske-bank/unsecuredsmeloans-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/danske-bank/danske-bank-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/danske-bank"}, {"type"=>"x-developer", "url"=>"http://openbankingapis.io/denmark/danske-bank"}, {"type"=>"x-documentation", "url"=>"https://openbanking.atlassian.net/wiki/spaces/DZ/pages/54919225/Open+Data+API+Dashboard#"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Danske_Research"}, {"type"=>"x-website", "url"=>"https://danskebank.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
blizzard{"world-of-warcraft-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Blizzard", "x-complete"=>1, "info"=>{"title"=>"World of Warcraft", "description"=>"welcome-to-the-restful-apis-exposed-through-the-world-of-warcraft-community-site-as-a-service-to-the-world-of-warcraft-community-", "version"=>"1.0.0"}, "host"=>"us.battle.net", "basePath"=>"/api/wow/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/character/{realm}/{characterName}"=>{"get"=>{"summary"=>"Get Character Realm Charactername", "description"=>"Fetches a single character at a time through an HTTP GET request to a URL describing the character profile resource. By default, a basic dataset will be returned and with each request and zero or more additional fields can be retrieved. The core dataset returned includes the character's realm, name, level, last modified timestamp, thumbnail, race id, achievement points value, gender id and class id.", "operationId"=>"getCharacterRealmCharactername", "x-api-path-slug"=>"characterrealmcharactername-get", "parameters"=>[{"in"=>"path", "name"=>"characterName", "description"=>"The character name"}, {"in"=>"query", "name"=>"fields", "description"=>"Indicates that one or more of the optional datasets is to be retrieved"}, {"in"=>"path", "name"=>"realm", "description"=>"The realm name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Character", "Realm", "CharacterName"]}}, "/guild/{realm}/{guildName}"=>{"get"=>{"summary"=>"Get Guild Realm Guildname", "description"=>"Fetches a single guild at a time through an HTTP GET request to a url describing the guild profile resource. By default, a basic dataset will be returned and with each request and zero or more additional fields can be retrieved. The core dataset returned includes the guild's name, level, faction and achievement points.", "operationId"=>"getGuildRealmGuildname", "x-api-path-slug"=>"guildrealmguildname-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Indicates that one or more of the optional datasets is to be retrieved"}, {"in"=>"path", "name"=>"guildName", "description"=>"The guild name"}, {"in"=>"path", "name"=>"realm", "description"=>"The realm name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guild", "Realm", "GuildName"]}}, "/realm/status"=>{"get"=>{"summary"=>"Get Realm Status", "description"=>"Retrieves realms status information. This information is limited to whether or not the realm is up, the type and state of the realm and the current population.", "operationId"=>"getRealmStatus", "x-api-path-slug"=>"realmstatus-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Realm", "Status"]}}, "/auction/data/{realm}"=>{"get"=>{"summary"=>"Get Auction Data Realm", "description"=>"Provides a per-realm list of recently generated auction house data dumps. The current auctions data is represented as JSON structures containing auction data for the tree auctions houses available on each realm.", "operationId"=>"getAuctionDataRealm", "x-api-path-slug"=>"auctiondatarealm-get", "parameters"=>[{"in"=>"path", "name"=>"realm", "description"=>"The realm name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auction", "Data", "Realm"]}}, "/item/{itemId}"=>{"get"=>{"summary"=>"Get Item Itemid", "description"=>"Provides detailed item information.", "operationId"=>"getItemItem", "x-api-path-slug"=>"itemitemid-get", "parameters"=>[{"in"=>"path", "name"=>"itemId", "description"=>"The item ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item", "ItemId"]}}, "/arena/{realm}/{teamSize}/{teamName}"=>{"get"=>{"summary"=>"Get Arena Realm Teamsize Teamname", "description"=>"Provides detailed arena team information.", "operationId"=>"getArenaRealmTeamsizeTeamname", "x-api-path-slug"=>"arenarealmteamsizeteamname-get", "parameters"=>[{"in"=>"path", "name"=>"realm", "description"=>"The realm name"}, {"in"=>"path", "name"=>"teamName", "description"=>"The team name"}, {"in"=>"path", "name"=>"teamSize", "description"=>"The team size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Arena", "Realm", "TeamSize", "TeamName"]}}, "/data/character/races"=>{"get"=>{"summary"=>"Get Data Character Races", "description"=>"Provides a list of character races.", "operationId"=>"getDataCharacterRaces", "x-api-path-slug"=>"datacharacterraces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data", "Character", "Races"]}}, "/data/character/classes"=>{"get"=>{"summary"=>"Get Data Character Classes", "description"=>"Provides a list of character classes.", "operationId"=>"getDataCharacterClasses", "x-api-path-slug"=>"datacharacterclasses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data", "Character", "Classes"]}}, "/data/guild/rewards"=>{"get"=>{"summary"=>"Get Data Guild Rewards", "description"=>"Provides a list of all guild rewards.", "operationId"=>"getDataGuildRewards", "x-api-path-slug"=>"dataguildrewards-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data", "Guild", "Rewards"]}}, "/data/guild/perks"=>{"get"=>{"summary"=>"Get Data Guild Perks", "description"=>"Provides a list of all guild perks.", "operationId"=>"getDataGuildPerks", "x-api-path-slug"=>"dataguildperks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data", "Guild", "Perks"]}}, "/data/item/classes"=>{"get"=>{"summary"=>"Get Data Item Classes", "description"=>"Provides a list of item classes.", "operationId"=>"getDataItemClasses", "x-api-path-slug"=>"dataitemclasses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data", "Item", "Classes"]}}}}, "apis"=>{"name"=>"Blizzard", "x-slug"=>"blizzard", "description"=>"This is the documentation for the RESTful APIs exposed through the World of Warcraft community site as a service to the World of Warcraft community.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Blizzard_Entertainment_Logo.svg.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,APIs.io Import,Gaming,General Data,Profiles,Relative Data,Stack", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"blizzard/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"World of Warcraft", "x-api-slug"=>"world-of-warcraft", "description"=>"Battle.net is a site that aims to unite all Blizzard gamers under the banner of a single, powerful, and advanced online gaming service. Gamers around the world meet up on Battle.net to prove their skill in multiplayer matches or to socialize with their friends. The World of Warcraft specific APIs are available to the Battle.net community, developers and partners to help expose some of the sought after data already served by the World of Warcraft community site. Currently data exposed includes realm status with character, guild and arena team profile pages information to come later. The API uses RESTful calls and responses are formatted in JSON and JSONP.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Blizzard_Entertainment_Logo.svg.png", "humanURL"=>"http://battle.net", "baseURL"=>"https://us.battle.net//api/wow/", "tags"=>"API Provider,APIs.io Import,Gaming,General Data,Profiles,Relative Data,Stack", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/blizzard/dataitemclasses-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/blizzard/world-of-warcraft-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-api-json--authoritative", "url"=>"http://apis.io/apisdef/legacy/blizzard.json"}, {"type"=>"x-developer", "url"=>"https://dev.battle.net/"}, {"type"=>"x-github", "url"=>"https://github.com/Blizzard"}, {"type"=>"x-twitter", "url"=>"Blizzard_Ent"}, {"type"=>"x-website", "url"=>"http://battle.net"}, {"type"=>"x-website", "url"=>"https://www.blizzard.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-key-management-service{"aws-key-management-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Key Management Service", "x-complete"=>1, "info"=>{"title"=>"AWS Key Management Service API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=CancelKeyDeletion"=>{"get"=>{"summary"=>"Cancel Key Deletion", "description"=>"Cancels the deletion of a customer master key (CMK).", "operationId"=>"cancelKeyDeletion", "x-api-path-slug"=>"actioncancelkeydeletion-get", "parameters"=>[{"in"=>"query", "name"=>"KeyId", "description"=>"The unique identifier for the customer master key (CMK) for which to cancel deletion", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/?Action=CreateAlias"=>{"get"=>{"summary"=>"Create Alias", "description"=>"Creates a display name for a customer master key.", "operationId"=>"createAlias", "x-api-path-slug"=>"actioncreatealias-get", "parameters"=>[{"in"=>"query", "name"=>"AliasName", "description"=>"String that contains the display name", "type"=>"string"}, {"in"=>"query", "name"=>"TargetKeyId", "description"=>"An identifier of the key for which you are creating the alias", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Aliases"]}}, "/?Action=CreateGrant"=>{"get"=>{"summary"=>"Create Grant", "description"=>"Adds a grant to a key to specify who can use the key and under what conditions.", "operationId"=>"createGrant", "x-api-path-slug"=>"actioncreategrant-get", "parameters"=>[{"in"=>"query", "name"=>"Constraints", "description"=>"The conditions under which the operations permitted by the grant are allowed", "type"=>"string"}, {"in"=>"query", "name"=>"GranteePrincipal", "description"=>"The principal that is given permission to perform the operations that the grant permits", "type"=>"string"}, {"in"=>"query", "name"=>"GrantTokens", "description"=>"A list of grant tokens", "type"=>"string"}, {"in"=>"query", "name"=>"KeyId", "description"=>"The unique identifier for the customer master key (CMK) that the grant applies to", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"A friendly name for identifying the grant", "type"=>"string"}, {"in"=>"query", "name"=>"Operations", "description"=>"A list of operations that the grant permits", "type"=>"string"}, {"in"=>"query", "name"=>"RetiringPrincipal", "description"=>"The principal that is given permission to retire the grant by using RetireGrant operation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Grants"]}}, "/?Action=CreateKey"=>{"get"=>{"summary"=>"Create Key", "description"=>"Creates a customer master key (CMK).", "operationId"=>"createKey", "x-api-path-slug"=>"actioncreatekey-get", "parameters"=>[{"in"=>"query", "name"=>"BypassPolicyLockoutSafetyCheck", "description"=>"A flag to indicate whether to bypass the key policy lockout safety check", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A description of the CMK", "type"=>"string"}, {"in"=>"query", "name"=>"KeyUsage", "description"=>"The intended use of the CMK", "type"=>"string"}, {"in"=>"query", "name"=>"Origin", "description"=>"The source of the CMKs key material", "type"=>"string"}, {"in"=>"query", "name"=>"Policy", "description"=>"The key policy to attach to the CMK", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/?Action=Decrypt"=>{"get"=>{"summary"=>"Decrypt", "description"=>"Decrypts ciphertext.", "operationId"=>"decrypt", "x-api-path-slug"=>"actiondecrypt-get", "parameters"=>[{"in"=>"query", "name"=>"CiphertextBlob", "description"=>"Ciphertext to be decrypted", "type"=>"string"}, {"in"=>"query", "name"=>"EncryptionContext", "description"=>"The encryption context", "type"=>"string"}, {"in"=>"query", "name"=>"GrantTokens", "description"=>"A list of grant tokens", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Decrypt"]}}, "/?Action=DeleteAlias"=>{"get"=>{"summary"=>"Delete Alias", "description"=>"Deletes the specified alias.", "operationId"=>"deleteAlias", "x-api-path-slug"=>"actiondeletealias-get", "parameters"=>[{"in"=>"query", "name"=>"AliasName", "description"=>"The alias to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Aliases"]}}, "/?Action=DeleteImportedKeyMaterial"=>{"get"=>{"summary"=>"Delete Imported Key Material", "description"=>"Deletes key material that you previously imported and makes the specified customer\n master key (CMK) unusable.", "operationId"=>"deleteImportedKeyMaterial", "x-api-path-slug"=>"actiondeleteimportedkeymaterial-get", "parameters"=>[{"in"=>"query", "name"=>"KeyId", "description"=>"The identifier of the CMK whose key material to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/?Action=DescribeKey"=>{"get"=>{"summary"=>"Describe Key", "description"=>"Provides detailed information about the specified customer master key.", "operationId"=>"describeKey", "x-api-path-slug"=>"actiondescribekey-get", "parameters"=>[{"in"=>"query", "name"=>"GrantTokens", "description"=>"A list of grant tokens", "type"=>"string"}, {"in"=>"query", "name"=>"KeyId", "description"=>"A unique identifier for the customer master key", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/?Action=DisableKey"=>{"get"=>{"summary"=>"Disable Key", "description"=>"Sets the state of a customer master key (CMK) to disabled, thereby preventing its use\n for cryptographic operations.", "operationId"=>"disableKey", "x-api-path-slug"=>"actiondisablekey-get", "parameters"=>[{"in"=>"query", "name"=>"KeyId", "description"=>"A unique identifier for the CMK", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/?Action=DisableKeyRotation"=>{"get"=>{"summary"=>"Disable Key Rotation", "description"=>"Disables rotation of the specified key.", "operationId"=>"disableKeyRotation", "x-api-path-slug"=>"actiondisablekeyrotation-get", "parameters"=>[{"in"=>"query", "name"=>"KeyId", "description"=>"A unique identifier for the customer master key", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/?Action=EnableKey"=>{"get"=>{"summary"=>"Enable Key", "description"=>"Marks a key as enabled, thereby permitting its use.", "operationId"=>"enableKey", "x-api-path-slug"=>"actionenablekey-get", "parameters"=>[{"in"=>"query", "name"=>"KeyId", "description"=>"A unique identifier for the customer master key", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/?Action=EnableKeyRotation"=>{"get"=>{"summary"=>"Enable Key Rotation", "description"=>"Enables rotation of the specified customer master key.", "operationId"=>"enableKeyRotation", "x-api-path-slug"=>"actionenablekeyrotation-get", "parameters"=>[{"in"=>"query", "name"=>"KeyId", "description"=>"A unique identifier for the customer master key", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/?Action=Encrypt"=>{"get"=>{"summary"=>"Encrypt", "description"=>"Encrypts plaintext into ciphertext by using a customer master key.", "operationId"=>"encrypt", "x-api-path-slug"=>"actionencrypt-get", "parameters"=>[{"in"=>"query", "name"=>"EncryptionContext", "description"=>"Name-value pair that specifies the encryption context to be used for authenticated encryption", "type"=>"string"}, {"in"=>"query", "name"=>"GrantTokens", "description"=>"A list of grant tokens", "type"=>"string"}, {"in"=>"query", "name"=>"KeyId", "description"=>"A unique identifier for the customer master key", "type"=>"string"}, {"in"=>"query", "name"=>"Plaintext", "description"=>"Data to be encrypted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Encrypt"]}}, "/?Action=GenerateDataKey"=>{"get"=>{"summary"=>"Generate Data Key", "description"=>"Returns a data encryption key that you can use in your application to encrypt\n data locally.", "operationId"=>"generateDataKey", "x-api-path-slug"=>"actiongeneratedatakey-get", "parameters"=>[{"in"=>"query", "name"=>"EncryptionContext", "description"=>"A set of key-value pairs that represents additional authenticated data", "type"=>"string"}, {"in"=>"query", "name"=>"GrantTokens", "description"=>"A list of grant tokens", "type"=>"string"}, {"in"=>"query", "name"=>"KeyId", "description"=>"The identifier of the CMK under which to generate and encrypt the data encryption key", "type"=>"string"}, {"in"=>"query", "name"=>"KeySpec", "description"=>"The length of the data encryption key", "type"=>"string"}, {"in"=>"query", "name"=>"NumberOfBytes", "description"=>"The length of the data encryption key in bytes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/?Action=GenerateDataKeyWithoutPlaintext"=>{"get"=>{"summary"=>"Generate Data Key Without Plaintext", "description"=>"Returns a data encryption key encrypted under a customer master key (CMK).", "operationId"=>"generateDataKeyWithoutPlaintext", "x-api-path-slug"=>"actiongeneratedatakeywithoutplaintext-get", "parameters"=>[{"in"=>"query", "name"=>"EncryptionContext", "description"=>"A set of key-value pairs that represents additional authenticated data", "type"=>"string"}, {"in"=>"query", "name"=>"GrantTokens", "description"=>"A list of grant tokens", "type"=>"string"}, {"in"=>"query", "name"=>"KeyId", "description"=>"The identifier of the CMK under which to generate and encrypt the data encryption key", "type"=>"string"}, {"in"=>"query", "name"=>"KeySpec", "description"=>"The length of the data encryption key", "type"=>"string"}, {"in"=>"query", "name"=>"NumberOfBytes", "description"=>"The length of the data encryption key in bytes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/?Action=GenerateRandom"=>{"get"=>{"summary"=>"Generate Random", "description"=>"Generates an unpredictable byte string.", "operationId"=>"generateRandom", "x-api-path-slug"=>"actiongeneraterandom-get", "parameters"=>[{"in"=>"query", "name"=>"NumberOfBytes", "description"=>"The length of the byte string", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Randoms"]}}, "/?Action=GetKeyPolicy"=>{"get"=>{"summary"=>"Get Key Policy", "description"=>"Retrieves a policy attached to the specified key.", "operationId"=>"getKeyPolicy", "x-api-path-slug"=>"actiongetkeypolicy-get", "parameters"=>[{"in"=>"query", "name"=>"KeyId", "description"=>"A unique identifier for the customer master key", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyName", "description"=>"String that contains the name of the policy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key Policies"]}}, "/?Action=GetKeyRotationStatus"=>{"get"=>{"summary"=>"Get Key Rotation Status", "description"=>"Retrieves a Boolean value that indicates whether key rotation is enabled for the\n specified key.", "operationId"=>"getKeyRotationStatus", "x-api-path-slug"=>"actiongetkeyrotationstatus-get", "parameters"=>[{"in"=>"query", "name"=>"KeyId", "description"=>"A unique identifier for the customer master key", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/?Action=GetParametersForImport"=>{"get"=>{"summary"=>"Get Parameters For Import", "description"=>"Returns the items you need in order to import key material into AWS KMS from your\n existing key management infrastructure.", "operationId"=>"getParametersForImport", "x-api-path-slug"=>"actiongetparametersforimport-get", "parameters"=>[{"in"=>"query", "name"=>"KeyId", "description"=>"The identifier of the CMK into which you will import key material", "type"=>"string"}, {"in"=>"query", "name"=>"WrappingAlgorithm", "description"=>"The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial", "type"=>"string"}, {"in"=>"query", "name"=>"WrappingKeySpec", "description"=>"The type of wrapping key (public key) to return in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters"]}}, "/?Action=ImportKeyMaterial"=>{"get"=>{"summary"=>"Import Key Material", "description"=>"Imports key material into an AWS KMS customer master key (CMK) from your existing key\n management infrastructure.", "operationId"=>"importKeyMaterial", "x-api-path-slug"=>"actionimportkeymaterial-get", "parameters"=>[{"in"=>"query", "name"=>"EncryptedKeyMaterial", "description"=>"The encrypted key material to import", "type"=>"string"}, {"in"=>"query", "name"=>"ExpirationModel", "description"=>"Specifies whether the key material expires", "type"=>"string"}, {"in"=>"query", "name"=>"ImportToken", "description"=>"The import token that you received in the response to a previous GetParametersForImport request", "type"=>"string"}, {"in"=>"query", "name"=>"KeyId", "description"=>"The identifier of the CMK to import the key material into", "type"=>"string"}, {"in"=>"query", "name"=>"ValidTo", "description"=>"The time at which the imported key material expires", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/?Action=ListAliases"=>{"get"=>{"summary"=>"List Aliases", "description"=>"Lists all of the key aliases in the account.", "operationId"=>"listAliases", "x-api-path-slug"=>"actionlistaliases-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"When paginating results, specify the maximum number of items to return in the response", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Aliases"]}}, "/?Action=ListGrants"=>{"get"=>{"summary"=>"List Grants", "description"=>"List the grants for a specified key.", "operationId"=>"listGrants", "x-api-path-slug"=>"actionlistgrants-get", "parameters"=>[{"in"=>"query", "name"=>"KeyId", "description"=>"A unique identifier for the customer master key", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"When paginating results, specify the maximum number of items to return in the response", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Grants"]}}, "/?Action=ListKeyPolicies"=>{"get"=>{"summary"=>"List Key Policies", "description"=>"Retrieves a list of policies attached to a key.", "operationId"=>"listKeyPolicies", "x-api-path-slug"=>"actionlistkeypolicies-get", "parameters"=>[{"in"=>"query", "name"=>"KeyId", "description"=>"A unique identifier for the customer master key (CMK)", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"When paginating results, specify the maximum number of items to return in the response", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=ListKeys"=>{"get"=>{"summary"=>"List Keys", "description"=>"Lists the customer master keys.", "operationId"=>"listKeys", "x-api-path-slug"=>"actionlistkeys-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"When paginating results, specify the maximum number of items to return in the response", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/?Action=ListRetirableGrants"=>{"get"=>{"summary"=>"List Retirable Grants", "description"=>"Returns a list of all grants for which the grant's RetiringPrincipal\n matches the one specified.", "operationId"=>"listRetirableGrants", "x-api-path-slug"=>"actionlistretirablegrants-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"When paginating results, specify the maximum number of items to return in the response", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results", "type"=>"string"}, {"in"=>"query", "name"=>"RetiringPrincipal", "description"=>"The retiring principal for which to list grants", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Grants"]}}, "/?Action=PutKeyPolicy"=>{"get"=>{"summary"=>"Put Key Policy", "description"=>"Attaches a key policy to the specified customer master key (CMK).", "operationId"=>"putKeyPolicy", "x-api-path-slug"=>"actionputkeypolicy-get", "parameters"=>[{"in"=>"query", "name"=>"BypassPolicyLockoutSafetyCheck", "description"=>"A flag to indicate whether to bypass the key policy lockout safety check", "type"=>"string"}, {"in"=>"query", "name"=>"KeyId", "description"=>"A unique identifier for the CMK", "type"=>"string"}, {"in"=>"query", "name"=>"Policy", "description"=>"The key policy to attach to the CMK", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyName", "description"=>"The name of the key policy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/?Action=ReEncrypt"=>{"get"=>{"summary"=>"Re Encrypt", "description"=>"Encrypts data on the server side with a new customer master key (CMK) without exposing\n the plaintext of the data on the client side.", "operationId"=>"reEncrypt", "x-api-path-slug"=>"actionreencrypt-get", "parameters"=>[{"in"=>"query", "name"=>"CiphertextBlob", "description"=>"Ciphertext of the data to reencrypt", "type"=>"string"}, {"in"=>"query", "name"=>"DestinationEncryptionContext", "description"=>"Encryption context to use when the data is reencrypted", "type"=>"string"}, {"in"=>"query", "name"=>"DestinationKeyId", "description"=>"A unique identifier for the CMK to use to reencrypt the data", "type"=>"string"}, {"in"=>"query", "name"=>"GrantTokens", "description"=>"A list of grant tokens", "type"=>"string"}, {"in"=>"query", "name"=>"SourceEncryptionContext", "description"=>"Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Encrypt"]}}, "/?Action=RetireGrant"=>{"get"=>{"summary"=>"Retire Grant", "description"=>"Retires a grant.", "operationId"=>"retireGrant", "x-api-path-slug"=>"actionretiregrant-get", "parameters"=>[{"in"=>"query", "name"=>"GrantId", "description"=>"Unique identifier of the grant to retire", "type"=>"string"}, {"in"=>"query", "name"=>"GrantToken", "description"=>"Token that identifies the grant to be retired", "type"=>"string"}, {"in"=>"query", "name"=>"KeyId", "description"=>"The Amazon Resource Name of the CMK associated with the grant", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Grants"]}}, "/?Action=RevokeGrant"=>{"get"=>{"summary"=>"Revoke Grant", "description"=>"Revokes a grant.", "operationId"=>"revokeGrant", "x-api-path-slug"=>"actionrevokegrant-get", "parameters"=>[{"in"=>"query", "name"=>"GrantId", "description"=>"Identifier of the grant to be revoked", "type"=>"string"}, {"in"=>"query", "name"=>"KeyId", "description"=>"A unique identifier for the customer master key associated with the grant", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Grants"]}}, "/?Action=ScheduleKeyDeletion"=>{"get"=>{"summary"=>"Schedule Key Deletion", "description"=>"Schedules the deletion of a customer master key (CMK).", "operationId"=>"scheduleKeyDeletion", "x-api-path-slug"=>"actionschedulekeydeletion-get", "parameters"=>[{"in"=>"query", "name"=>"KeyId", "description"=>"The unique identifier for the customer master key (CMK) to delete", "type"=>"string"}, {"in"=>"query", "name"=>"PendingWindowInDays", "description"=>"The waiting period, specified in number of days", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}, "/?Action=UpdateAlias"=>{"get"=>{"summary"=>"Update Alias", "description"=>"Updates an alias to map it to a different key.", "operationId"=>"updateAlias", "x-api-path-slug"=>"actionupdatealias-get", "parameters"=>[{"in"=>"query", "name"=>"AliasName", "description"=>"String that contains the name of the alias to be modified", "type"=>"string"}, {"in"=>"query", "name"=>"TargetKeyId", "description"=>"Unique identifier of the customer master key to be mapped to the alias", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Aliases"]}}, "/?Action=UpdateKeyDescription"=>{"get"=>{"summary"=>"Update Key Description", "description"=>"Updates the description of a customer master key (CMK).", "operationId"=>"updateKeyDescription", "x-api-path-slug"=>"actionupdatekeydescription-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"New description for the CMK", "type"=>"string"}, {"in"=>"query", "name"=>"KeyId", "description"=>"A unique identifier for the CMK", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys"]}}}}, "apis"=>{"name"=>"AWS Key Management Service", "x-slug"=>"aws-key-management-service", "description"=>"AWS Key Management Service (KMS) is a managed service that makes it easy for you to create and control the encryption keys used to encrypt your data, and uses Hardware Security Modules (HSMs) to protect the security of your keys. AWS Key Management Service is integrated with several other AWS services to help you protect the data you store with these services. AWS Key Management Service is also integrated with AWS CloudTrail to provide you with logs of all key usage to help meet your regulatory and compliance needs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-key-management.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Encryption,Profiles,Relative Data,Security,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-key-management-service/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Key Management Service API", "x-api-slug"=>"aws-key-management-service-api", "description"=>"AWS Key Management Service (KMS) is a managed service that makes it easy for you to create and control the encryption keys used to encrypt your data, and uses Hardware Security Modules (HSMs) to protect the security of your keys. AWS Key Management Service is integrated with several other AWS services to help you protect the data you store with these services. AWS Key Management Service is also integrated with AWS CloudTrail to provide you with logs of all key usage to help meet your regulatory and compliance needs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-key-management.jpg", "humanURL"=>"https://aws.amazon.com/kms/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Encryption,Profiles,Relative Data,Security,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-key-management-service/aws-key-management-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/cli/latest/reference/kms/index.html"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/kms/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/kms/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/kms/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/kms/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/kms/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
crypto-compare{"crypto-compare-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Crypto Compare", "x-complete"=>1, "info"=>{"title"=>"Cryptocompare", "description"=>"todo-add-description", "version"=>"1.0.0"}, "host"=>"min-api.cryptocompare.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/"=>{"get"=>{"summary"=>"API Description", "description"=>"Api description.", "operationId"=>"UnnammedEndpointGet", "x-api-path-slug"=>"get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Discovery"]}}, "/data/price"=>{"get"=>{"summary"=>"Get Single Price", "description"=>"Get single price.", "operationId"=>"DataPriceGet", "x-api-path-slug"=>"dataprice-get", "parameters"=>[{"in"=>"query", "name"=>"fsym"}, {"in"=>"query", "name"=>"tsyms"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Single", "Price"]}}, "/data/pricemulti"=>{"get"=>{"summary"=>"Get Multiple Prices", "description"=>"Get multiple prices.", "operationId"=>"DataPricemultiGet", "x-api-path-slug"=>"datapricemulti-get", "parameters"=>[{"in"=>"query", "name"=>"fsyms"}, {"in"=>"query", "name"=>"tsyms"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Multiple", "Prices"]}}, "/data/all/coinlist"=>{"get"=>{"summary"=>"Get Coinlist", "description"=>"Get coinlist.", "operationId"=>"DataAllCoinlistGet", "x-api-path-slug"=>"dataallcoinlist-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Coins"]}}}}, "apis"=>{"name"=>"Crypto Compare", "x-slug"=>"crypto-compare", "description"=>"We bring you all the latest streaming pricing data in the world of cryptocurrencies. Whether you are just interested in the bitcoin price or you want to see the latest ether volume, we have all the data available at your fingertips. Join the discussion...", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/cryptocompare-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"5545", "tags"=>"API Provider,Blockchain,New,SaaS,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"crypto-compare/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Crypto Compare", "x-api-slug"=>"crypto-compare", "description"=>"We bring you all the latest streaming pricing data in the world of cryptocurrencies. Whether you are just interested in the bitcoin price or you want to see the latest ether volume, we have all the data available at your fingertips. Join the discussion...", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/cryptocompare-logo.png", "humanURL"=>"https://www.cryptocompare.com", "baseURL"=>"https://min-api.cryptocompare.com//", "tags"=>"API Provider,Blockchain,New,SaaS,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/crypto-compare/dataallcoinlist-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/crypto-compare/crypto-compare-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-github-topic", "url"=>"https://github.com/topics/cryptocompare"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/crypto-coin-comparison-ltd"}, {"type"=>"x-developer", "url"=>"https://www.cryptocompare.com/api/"}, {"type"=>"x-email", "url"=>"chayter@cryptocompare.com"}, {"type"=>"x-email", "url"=>"vcealicu@cryptocompare.com"}, {"type"=>"x-email", "url"=>"info@CryptoCompare.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/CryptoCompare"}, {"type"=>"x-webhook", "url"=>"https://www.cryptocompare.com/api/#-api-web-socket-"}, {"type"=>"x-website", "url"=>"https://www.cryptocompare.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
medium{"medium-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Medium", "x-complete"=>1, "info"=>{"title"=>"Medium.com", "description"=>"mediums-unofficial-api-documentation-using-openapi-specification--official-apiofficial-api-document-can-also-be-viewed-for-most-up-to-date-api-spec-at-httpsgithub-commediummediumapidocshttpsgithub-commediummediumapidocs-developer-blog--welcome-to-the-medium-apihttpsmedium-comblogwelcometothemediumapi3418f956552", "termsOfService"=>"https://medium.com/@feerst/2b405a832a2f", "contact"=>{"name"=>"Hossain Khan", "url"=>"https://github.com/amardeshbd/medium-api-specification"}, "version"=>"1.0.0"}, "host"=>"api.medium.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/me"=>{"get"=>{"summary"=>"User details", "description"=>"Returns details of the user who has granted permission to the application.", "operationId"=>"me.get", "x-api-path-slug"=>"me-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me"]}}, "/publications/{publicationId}/contributors"=>{"get"=>{"summary"=>"Contributors of Publication", "description"=>"This endpoint returns a list of contributors for a given publication. In other words, a list of Medium users who are allowed to publish under a publication, as well as a description of their exact role in the publication (for now, either an editor or a writer).", "operationId"=>"publications.publicationId.contributors.get", "x-api-path-slug"=>"publicationspublicationidcontributors-get", "parameters"=>[{"in"=>"path", "name"=>"publicationId", "description"=>"A unique identifier for the publication"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Publications", "Publication", "Contributors"]}}, "/publications/{publicationId}/posts"=>{"post"=>{"summary"=>"Create Publication Post", "description"=>"creating a post and associating it with a publication on Medium. The request also shows this association, considering posts a collection of resources under a publication\n\nThere are additional rules around publishing that each request to this API must respect:\n - If the authenticated user is an 'editor' for the publication, they can create posts with any publish status. Posts published as 'public' or 'unlisted' will appear in collection immediately, while posts created as 'draft' will remain in pending state under publication.\n - If the authenticated user is a 'writer' for the chosen publication, they can only create a post as a 'draft'. That post will remain in pending state under publication until an editor for the publication approves it.\n - If the authenticated user is neither a 'writer' nor an 'editor', they are not allowed to create any posts in a publication.", "operationId"=>"publications.publicationId.posts.post", "x-api-path-slug"=>"publicationspublicationidposts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Creates a post for publication", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"publicationId", "description"=>"Here publicationId is the id of the publication the post is being created under"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Publications", "Publication", "Posts"]}}, "/users/{authorId}/posts"=>{"post"=>{"summary"=>"Create User Post", "description"=>"Creates a post on the authenticated user???s profile.", "operationId"=>"users.authorId.posts.post", "x-api-path-slug"=>"usersauthoridposts-post", "parameters"=>[{"in"=>"path", "name"=>"authorId", "description"=>"authorId is the user id of the authenticated user"}, {"in"=>"body", "name"=>"body", "description"=>"Creates a post for user", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Author", "Posts"]}}, "/users/{userId}/publications"=>{"get"=>{"summary"=>"User's publications", "description"=>"Returns a full list of publications that the user is related to in some way. This includes all publications the user is subscribed to, writes to, or edits.", "operationId"=>"users.userId.publications.get", "x-api-path-slug"=>"usersuseridpublications-get", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"A unique identifier for the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Publications"]}}}}, "apis"=>{"name"=>"Medium", "x-slug"=>"medium", "description"=>"Medium is an online publishing platform founded by Twitter co-founder Evan Williams in August 2012. The platform has evolved into a hybrid of non-professional contributions and professional, paid contributions, an example of social journalism.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/medium-logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Blogging,Communications,General Data,Media,Profiles,Relative Data,SDIO Syndication,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"medium/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Medium", "x-api-slug"=>"medium", "description"=>"Medium is an online publishing platform founded by Twitter co-founder Evan Williams in August 2012. The platform has evolved into a hybrid of non-professional contributions and professional, paid contributions, an example of social journalism.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/medium-logo.png", "humanURL"=>"https://medium.com/", "baseURL"=>"https://api.medium.com//v1", "tags"=>"API Provider,API Service Provider,Blogging,Communications,General Data,Media,Profiles,Relative Data,SDIO Syndication,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/medium/usersuseridpublications-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/medium/medium-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-github", "url"=>"https://github.com/Medium"}, {"type"=>"x-transparency-report", "url"=>"https://medium.com/transparency-report"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Medium"}, {"type"=>"x-website", "url"=>"https://medium.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
request-baskets{"request-baskets-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Request Baskets", "x-complete"=>1, "info"=>{"title"=>"Request Baskets", "description"=>"restful-api-of-request-baskets-service", "contact"=>{"name"=>"darklynx", "url"=>"https://github.com/darklynx"}, "version"=>"0.5"}, "host"=>"rbaskets.in", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/baskets"=>{"get"=>{"summary"=>"Get baskets", "description"=>"Fetches a list of basket names managed by service. Require master token.", "operationId"=>"baskets.get", "x-api-path-slug"=>"baskets-get", "parameters"=>[{"in"=>"query", "name"=>"max", "description"=>"Maximum number of basket names to return; default 20"}, {"in"=>"query", "name"=>"q", "description"=>"Query string to filter result, only those basket names that match the query will be included in response"}, {"in"=>"query", "name"=>"skip", "description"=>"Number of basket names to skip; default 0"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/baskets/{name}"=>{"delete"=>{"summary"=>"Delete basket", "description"=>"Permanently deletes this basket and all collected requests.", "operationId"=>"baskets.name.delete", "x-api-path-slug"=>"basketsname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The basket name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "get"=>{"summary"=>"Get basket settings", "description"=>"Retrieves configuration settings of this basket.", "operationId"=>"baskets.name.get", "x-api-path-slug"=>"basketsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The basket name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"Create new basket", "description"=>"Creates a new basket with this name.", "operationId"=>"baskets.name.post", "x-api-path-slug"=>"basketsname-post", "parameters"=>[{"in"=>"body", "name"=>"config", "description"=>"Basket configuration", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The name of new basket"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "put"=>{"summary"=>"Update basket settings", "description"=>"Updates configuration settings of this basket.\n\nSpecial configuration parameters for request forwarding:\n * `insecure_tls` controls certificate verification when forwarding requests. Setting this parameter to `true`\n allows to forward collected HTTP requests via HTTPS protocol even if the forward end-point is configured with\n self-signed TLS/SSL certificate. **Warning:** enabling this feature has known security implications.\n * `expand_path` changes the logic of constructing taget URL when forwarding requests. If this parameter is\n set to `true` the forward URL path will be expanded when original HTTP request contains compound path. For\n example, a basket with name **server1** is configured to forward all requests to `http://server1.intranet:8001/myservice`\n and it has received an HTTP request like `GET http://baskets.example.com/server1/component/123/events?status=OK`\n then depending on `expand_path` settings the request will be forwarded to:\n * `true` => `GET http://server1.intranet:8001/myservice/component/123/events?status=OK`\n * `false` => `GET http://server1.intranet:8001/myservice?status=OK`", "operationId"=>"baskets.name.put", "x-api-path-slug"=>"basketsname-put", "parameters"=>[{"in"=>"body", "name"=>"config", "description"=>"New configuration to apply", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The basket name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/baskets/{name}/requests"=>{"delete"=>{"summary"=>"Delete all requests", "description"=>"Deletes all requests collected by this basket.", "operationId"=>"baskets.name.requests.delete", "x-api-path-slug"=>"basketsnamerequests-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The basket name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "get"=>{"summary"=>"Get collected requests", "description"=>"Fetches collection of requests collected by this basket.", "operationId"=>"baskets.name.requests.get", "x-api-path-slug"=>"basketsnamerequests-get", "parameters"=>[{"in"=>"query", "name"=>"in", "description"=>"Defines what is taken into account when filtering is applied: `body` - search in content body of collected requests,`query` - search among query parameters of collected requests, `headers` - search among request header values,`any` - search anywhere; default `any`"}, {"in"=>"query", "name"=>"max", "description"=>"Maximum number of requests to return; default 20"}, {"in"=>"path", "name"=>"name", "description"=>"The basket name"}, {"in"=>"query", "name"=>"q", "description"=>"Query string to filter result, only requests that match the query will be included in response"}, {"in"=>"query", "name"=>"skip", "description"=>"Number of requests to skip; default 0"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/baskets/{name}/responses/{method}"=>{"get"=>{"summary"=>"Get response settings", "description"=>"Retrieves information about configured response of the basket. Service will reply with this response to any\nHTTP request sent to the basket with appropriate HTTP method.\n\nIf nothing is configured, the default response is HTTP 200 - OK with empty content.", "operationId"=>"baskets.name.responses.method.get", "x-api-path-slug"=>"basketsnameresponsesmethod-get", "parameters"=>[{"in"=>"path", "name"=>"method", "description"=>"The HTTP method this response is configured for"}, {"in"=>"path", "name"=>"name", "description"=>"The basket name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "put"=>{"summary"=>"Update response settings", "description"=>"Allows to configure HTTP response of this basket. The service will reply with configured response to any HTTP\nrequest sent to the basket with appropriate HTTP method.\n\nIf nothing is configured, the default response is HTTP 200 - OK with empty content.", "operationId"=>"baskets.name.responses.method.put", "x-api-path-slug"=>"basketsnameresponsesmethod-put", "parameters"=>[{"in"=>"path", "name"=>"method", "description"=>"The HTTP method this response is configured for"}, {"in"=>"path", "name"=>"name", "description"=>"The basket name"}, {"in"=>"body", "name"=>"response", "description"=>"HTTP response configuration", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"Request Baskets", "x-slug"=>"request-baskets", "description"=>"", "image"=>"", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Cache,Relative Data,Service API,Storage", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"request-baskets/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Request Baskets", "x-api-slug"=>"request-baskets", "description"=>"", "image"=>"", "humanURL"=>"http://rbaskets.in", "baseURL"=>"https://rbaskets.in//", "tags"=>"Cache,Relative Data,Service API,Storage", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/request-baskets/request-baskets-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://rbaskets.in"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fitbit{"apis"=>{"name"=>"Fitbit", "x-slug"=>"fitbit", "description"=>"Find your fit with Fitbits family of fitness products that help you stay motivated and improve your health by tracking your activity, exercise, food, weight and sleep.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/200-fitbit.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"2266", "tags"=>",API Provider,Devices,Excercise,Fitness,Indie EdTech Data Jam,Mobile,Profiles,Relative Data,Service API,Sports,Stack,Technology,Wearables", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"fitbit/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Fitbit", "x-api-slug"=>"fitbit", "description"=>"Find your fit with Fitbits family of fitness products that help you stay motivated and improve your health by tracking your activity, exercise, food, weight and sleep.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/200-fitbit.jpg", "humanURL"=>"http://fitbit.com", "baseURL"=>"https://api.fitbit.com//1", "tags"=>",API Provider,Devices,Excercise,Fitness,Indie EdTech Data Jam,Mobile,Profiles,Relative Data,Service API,Sports,Stack,Technology,Wearables", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/fitbit/useruseridprofile-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/fitbit/fitbit-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-api-json--authoritative", "url"=>"https://www.fitbit.com/apis.json"}, {"type"=>"x-openapi", "url"=>"https://dev.fitbit.com/reference/web-api/explore/fitbit-web-api.swagger.json"}, {"type"=>"x-apigee-console", "url"=>"https://wiki.fitbit.com/display/API/API+Explorer"}, {"type"=>"x-blog", "url"=>"http://blog.fitbit.com"}, {"type"=>"x-blog-rss", "url"=>"http://blog.fitbit.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/fitbit"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/fitbit"}, {"type"=>"x-email", "url"=>"privacy@fitbit.com"}, {"type"=>"x-github", "url"=>"https://github.com/fitbit"}, {"type"=>"x-rate-limits", "url"=>"https://wiki.fitbit.com/display/API/Rate+Limit"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/fitbit"}, {"type"=>"x-website", "url"=>"http://fitbit.com"}, {"type"=>"x-website", "url"=>"http://dev.fitbit.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "fitbit-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Fitbit", "x-complete"=>1, "info"=>{"title"=>"Fitbit", "description"=>"bring-fitbit-health-data-into-your-apps-including-user-activities-sleep-heart-glucose-and-blood-pressure-information-", "version"=>"1.0.0"}, "host"=>"api.fitbit.com", "basePath"=>"/1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/user/-{collection-path}apiSubscriptions.json"=>{"get"=>{"summary"=>"Get User Collection Path Apisubscriptions.json", "description"=>"Get a list of user's subscriptions for your application in the format requested.", "operationId"=>"getUserCollectionPathApisubscriptions.json", "x-api-path-slug"=>"usercollectionpathapisubscriptions-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-collection-pathapiSubscriptions.json"]}}, "/user/-{collection-path}apiSubscriptions/{subscription-id}.json"=>{"delete"=>{"summary"=>"Delete User Collection Path Apisubscriptions Subscription .json", "description"=>"Delete a subscription for the user and get a response in the format requested.", "operationId"=>"deleteUserCollectionPathApisubscriptionsSubscription.json", "x-api-path-slug"=>"usercollectionpathapisubscriptionssubscriptionid-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-collection-pathapiSubscriptions", "Subscription-id.json"]}, "post"=>{"summary"=>"Post User Collection Path Apisubscriptions Subscription .json", "description"=>"Add a subscription for the user to get notifications and get a response in the format requested.", "operationId"=>"postUserCollectionPathApisubscriptionsSubscription.json", "x-api-path-slug"=>"usercollectionpathapisubscriptionssubscriptionid-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-collection-pathapiSubscriptions", "Subscription-id.json"]}}, "/user/-/friends/invitations.json"=>{"get"=>{"summary"=>"Get User Friends Invitations.json", "description"=>"Retrieve the list of invites to become freinds for a user in the format requested.", "operationId"=>"getUserFriendsInvitations.json", "x-api-path-slug"=>"userfriendsinvitations-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Friends", "Invitations.json"]}}, "/foods/units.json"=>{"get"=>{"summary"=>"Get Foods Units.json", "description"=>"Get list of all valid Fitbit food units in the format requested.", "operationId"=>"getFoodsUnits.json", "x-api-path-slug"=>"foodsunits-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Foods", "Units.json"]}}, "/foods/{food-id}.json"=>{"get"=>{"summary"=>"Get Foods Food .json", "description"=>"Get the details of a specific food in Fitbit Food database (or private food for the user) in the format requested. Note, that nutritional values currently included in response only for the private foods.", "operationId"=>"getFoodsFood.json", "x-api-path-slug"=>"foodsfoodid-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Foods", "Food-id.json"]}}, "/activities/{id}.json"=>{"get"=>{"summary"=>"Get Activities .json", "description"=>"Get the details of a specific activity in Fitbit activities database in the format requested. If activity has levels, also get list of activity level details.", "operationId"=>"getActivities.json", "x-api-path-slug"=>"activitiesid-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activities", "Id.json"]}}, "/activities.json"=>{"get"=>{"summary"=>"Get Activities.json", "description"=>"Get a tree of all valid Fitbit public activities from the activities catalog as well as private custom activities the user created in the format requested. If activity has levels, also get a list of activity level details.", "operationId"=>"getActivities.json", "x-api-path-slug"=>"activities-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activities.json"]}}, "/user/-/devices.json"=>{"get"=>{"summary"=>"Get User Devices.json", "description"=>"Retrieve the list of Fitbit devices for a user in the format requested.", "operationId"=>"getUserDevices.json", "x-api-path-slug"=>"userdevices-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Devices.json"]}}, "/user/-/foods/log/goal.json"=>{"post"=>{"summary"=>"Post User Foods Log Goal.json", "description"=>"Update (create) a user's daily calorie consumption goal or Food Plan and get a response in the format requested. Food Plan could not be created unless user already has active goal (Update-Weight-Goal). Depending on the weight goal setup only either MAINTENANCE (in case start weight is close to target weight or smaller) or one of the four other \"lose\" food plans could be created via intensity POST parameter.", "operationId"=>"postUserFoodsLogGoal.json", "x-api-path-slug"=>"userfoodsloggoal-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Foods", "Log", "Goal.json"]}, "get"=>{"summary"=>"Get User Foods Log Goal.json", "description"=>"Get a user's current daily calorie consumption goal and/or Food Plan in the format requested.", "operationId"=>"getUserFoodsLogGoal.json", "x-api-path-slug"=>"userfoodsloggoal-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Foods", "Log", "Goal.json"]}}, "/user/-/meals.json"=>{"get"=>{"summary"=>"Get User Meals.json", "description"=>"Get a list of meals user created in his food log in the format requested.", "operationId"=>"getUserMeals.json", "x-api-path-slug"=>"usermeals-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Meals.json"]}}, "/foods.json"=>{"post"=>{"summary"=>"Post Foods.json", "description"=>"Create new private food for a user and get a response in a format requested. Created private food could be found in results of Search Foods call.", "operationId"=>"postFoods.json", "x-api-path-slug"=>"foods-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Foods.json"]}}, "/user/-/foods/log/water/{water-log-id}.json"=>{"delete"=>{"summary"=>"Delete User Foods Log Water Water Log .json", "description"=>"Delete user's water log entry with the given id.", "operationId"=>"deleteUserFoodsLogWaterWaterLog.json", "x-api-path-slug"=>"userfoodslogwaterwaterlogid-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Foods", "Log", "Water", "Water-log-id.json"]}}, "/user/-/foods/log/water.json"=>{"post"=>{"summary"=>"Post User Foods Log Water.json", "description"=>"Create log entry for a water using units in the unit system that corresponds to the Accept-Language header provided (or waterUnit) and get a response in the format requested.", "operationId"=>"postUserFoodsLogWater.json", "x-api-path-slug"=>"userfoodslogwater-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Foods", "Log", "Water.json"]}}, "/user/-/foods/log/water/date/{date}.json"=>{"get"=>{"summary"=>"Get User Foods Log Water Date Date .json", "description"=>"Get a summary and list of a user's water log entries for a given day in the format requested using units in the unit system which corresponds to the Accept-Language header provided.", "operationId"=>"getUserFoodsLogWaterDateDate.json", "x-api-path-slug"=>"userfoodslogwaterdatedate-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Foods", "Log", "Water", "Date", "Date.json"]}}, "/user/-/foods/log/favorite/{id}.json"=>{"delete"=>{"summary"=>"Delete User Foods Log Favorite .json", "description"=>"Delete the food with the given id from user's list of favorite foods.", "operationId"=>"deleteUserFoodsLogFavorite.json", "x-api-path-slug"=>"userfoodslogfavoriteid-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Foods", "Log", "Favorite", "Id.json"]}, "post"=>{"summary"=>"Post User Foods Log Favorite .json", "description"=>"Add the food with the given id to user's list of favorite foods.", "operationId"=>"postUserFoodsLogFavorite.json", "x-api-path-slug"=>"userfoodslogfavoriteid-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Foods", "Log", "Favorite", "Id.json"]}}, "/user/-/activities/goals/weekly.json"=>{"get"=>{"summary"=>"Get User Activities Goals Weekly.json", "description"=>"Get a user's current weekly activity goals in the format requested using units in the unit system which corresponds to the Accept-Language header provided.", "operationId"=>"getUserActivitiesGoalsWeekly.json", "x-api-path-slug"=>"useractivitiesgoalsweekly-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Activities", "Goals", "Weekly.json"]}}, "/user/-/activities/goals/daily.json"=>{"get"=>{"summary"=>"Get User Activities Goals Daily.json", "description"=>"Get a user's current daily activity goals in the format requested using units in the unit system which corresponds to the Accept-Language header provided.", "operationId"=>"getUserActivitiesGoalsDaily.json", "x-api-path-slug"=>"useractivitiesgoalsdaily-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Activities", "Goals", "Daily.json"]}}, "/user/-/activities/log/favorite/{id}.json"=>{"delete"=>{"summary"=>"Delete User Activities Log Favorite .json", "description"=>"Delete the activity with the given id from user's list of favorite activities.", "operationId"=>"deleteUserActivitiesLogFavorite.json", "x-api-path-slug"=>"useractivitieslogfavoriteid-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Activities", "Log", "Favorite", "Id.json"]}, "post"=>{"summary"=>"Post User Activities Log Favorite .json", "description"=>"Adds the activity with the given id to user's list of favorite activities.", "operationId"=>"postUserActivitiesLogFavorite.json", "x-api-path-slug"=>"useractivitieslogfavoriteid-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Activities", "Log", "Favorite", "Id.json"]}}, "/user/-/foods/log/favorite.json"=>{"get"=>{"summary"=>"Get User Foods Log Favorite.json", "description"=>"Get a list of a user's favorite foods in the format requested. A user marks a food as favorite on the user's Food Tab tab. A favorite food in the list provides a quick way to log the food via the Log Food endpoint.", "operationId"=>"getUserFoodsLogFavorite.json", "x-api-path-slug"=>"userfoodslogfavorite-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Foods", "Log", "Favorite.json"]}}, "/user/-/foods/log/frequent.json"=>{"get"=>{"summary"=>"Get User Foods Log Frequent.json", "description"=>"Get a list of a user's frequent foods in the format requested. A frequent food in the list provides a quick way to log the food via the Log Food endpoint.", "operationId"=>"getUserFoodsLogFrequent.json", "x-api-path-slug"=>"userfoodslogfrequent-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Foods", "Log", "Frequent.json"]}}, "/user/-/foods/log/recent.json"=>{"get"=>{"summary"=>"Get User Foods Log Recent.json", "description"=>"Get a list of a user's recent foods in the format requested. A recent food provides a quick way to log the food via the Log Food endpoint.", "operationId"=>"getUserFoodsLogRecent.json", "x-api-path-slug"=>"userfoodslogrecent-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Foods", "Log", "Recent.json"]}}, "/user/-/activities/favorite.json"=>{"get"=>{"summary"=>"Get User Activities Favorite.json", "description"=>"Get a list of a user's favorite activities in the format requested. A user marks an activity as favorite on the user's Activities Tab. The activity ids in the list can be used to create a new activity log entry via the Log Activity.", "operationId"=>"getUserActivitiesFavorite.json", "x-api-path-slug"=>"useractivitiesfavorite-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Activities", "Favorite.json"]}}, "/user/-/activities/frequent.json"=>{"get"=>{"summary"=>"Get User Activities Frequent.json", "description"=>"Get a list of a user's frequent activities in the format requested using units in the unit system which corresponds to the Accept-Language header provided. A frequent activity record contains the distance and duration values recorded the last time the activity was logged. The record retrieved can therefore be used to log the activity via the Log Activity with the same or adjusted values for distance and duration.", "operationId"=>"getUserActivitiesFrequent.json", "x-api-path-slug"=>"useractivitiesfrequent-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Activities", "Frequent.json"]}}, "/user/-/activities/recent.json"=>{"get"=>{"summary"=>"Get User Activities Recent.json", "description"=>"Get a list of a user's recent activities in the format requested using units in the unit system which corresponds to the Accept-Language header provided. A recent activity record contains the distance and duration values recorded the last time the activity was logged. The record retrieved can therefore be used to log the activity via the Log Activity with the same or adjusted values for distance and duration.", "operationId"=>"getUserActivitiesRecent.json", "x-api-path-slug"=>"useractivitiesrecent-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Activities", "Recent.json"]}}, "/user/{user-id}/sleep/minutesAsleep/date/{start-date-or-end-date}/{end-date-or-period}.json"=>{"get"=>{"summary"=>"Get User User Sleep Minutesasleep Date Start Date Or End Date End Date Or Period .json", "description"=>"Get time series in the specified range for a given resource in the format requested using units in the unit system which corresponds to the Accept-Language header provided.", "operationId"=>"getUserUserSleepMinutesasleepDateStartDateOrEndDateEndDateOrPeriod.json", "x-api-path-slug"=>"useruseridsleepminutesasleepdatestartdateorenddateenddateorperiod-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User-id", "Sleep", "MinutesAsleep", "Date", "Start-date-or-end-date", "End-date-or-period.json"]}}, "/user/{user-id}/foods/log/caloriesIn/date/{start-date-or-end-date}/{end-date-or-period}.json"=>{"get"=>{"summary"=>"Get User User Foods Log Caloriesin Date Start Date Or End Date End Date Or Period .json", "description"=>"Get time series in the specified range for a given resource in the format requested using units in the unit system which corresponds to the Accept-Language header provided.", "operationId"=>"getUserUserFoodsLogCaloriesinDateStartDateOrEndDateEndDateOrPeriod.json", "x-api-path-slug"=>"useruseridfoodslogcaloriesindatestartdateorenddateenddateorperiod-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User-id", "Foods", "Log", "CaloriesIn", "Date", "Start-date-or-end-date", "End-date-or-period.json"]}}, "/user/-/body/log/fat/goal.json"=>{"post"=>{"summary"=>"Post User Body Log Fat Goal.json", "description"=>"Create or updates user's fat goal and get a response in the format requested.", "operationId"=>"postUserBodyLogFatGoal.json", "x-api-path-slug"=>"userbodylogfatgoal-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Body", "Log", "Fat", "Goal.json"]}, "get"=>{"summary"=>"Get User Body Log Fat Goal.json", "description"=>"Get a user's current fat goal in the format requested.", "operationId"=>"getUserBodyLogFatGoal.json", "x-api-path-slug"=>"userbodylogfatgoal-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Body", "Log", "Fat", "Goal.json"]}}, "/user/-/body/log/weight/goal.json"=>{"post"=>{"summary"=>"Post User Body Log Weight Goal.json", "description"=>"Create or update user's weight goal using units in the unit system that corresponds to the Accept-Language header provided and get a response in the format requested.", "operationId"=>"postUserBodyLogWeightGoal.json", "x-api-path-slug"=>"userbodylogweightgoal-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Body", "Log", "Weight", "Goal.json"]}, "get"=>{"summary"=>"Get User Body Log Weight Goal.json", "description"=>"Get a user's current weight goal using units in the unit system that corresponds to the Accept-Language header provided in the format requested.", "operationId"=>"getUserBodyLogWeightGoal.json", "x-api-path-slug"=>"userbodylogweightgoal-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Body", "Log", "Weight", "Goal.json"]}}, "/user/-/body/log/fat/{body-fat-log-id}.json"=>{"delete"=>{"summary"=>"Delete User Body Log Fat Body Fat Log .json", "description"=>"Delete user's body fat log entry with the given id.", "operationId"=>"deleteUserBodyLogFatBodyFatLog.json", "x-api-path-slug"=>"userbodylogfatbodyfatlogid-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Body", "Log", "Fat", "Body-fat-log-id.json"]}}, "/user/-/body/log/fat/{body-weight-log-id}.json"=>{"delete"=>{"summary"=>"Delete User Body Log Fat Body Weight Log .json", "description"=>"Delete user's body weight log entry with the given id.", "operationId"=>"deleteUserBodyLogFatBodyWeightLog.json", "x-api-path-slug"=>"userbodylogfatbodyweightlogid-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Body", "Log", "Fat", "Body-weight-log-id.json"]}}, "/user/-/body/log/fat.json"=>{"post"=>{"summary"=>"Post User Body Log Fat.json", "description"=>"Create log entry for a body fat and get a response in the format requested.", "operationId"=>"postUserBodyLogFat.json", "x-api-path-slug"=>"userbodylogfat-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Body", "Log", "Fat.json"]}}, "/user/-/body/log/weight.json"=>{"post"=>{"summary"=>"Post User Body Log Weight.json", "description"=>"Create log entry for a body weight using units in the unit system that corresponds to the Accept-Language header provided and get a response in the format requested.", "operationId"=>"postUserBodyLogWeight.json", "x-api-path-slug"=>"userbodylogweight-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Body", "Log", "Weight.json"]}}, "/user/-/body.json"=>{"post"=>{"summary"=>"Post User Body.json", "description"=>"Log body measurements using units in the unit system that corresponds to the Accept-Language header provided.", "operationId"=>"postUserBody.json", "x-api-path-slug"=>"userbody-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Body.json"]}}, "/user/{user-id}/body/weight/date/{start-date-or-end-date}/{end-date-or-period}.json"=>{"get"=>{"summary"=>"Get User User Body Weight Date Start Date Or End Date End Date Or Period .json", "description"=>"Get time series in the specified range for a given resource in the format requested using units in the unit system which corresponds to the Accept-Language header provided.", "operationId"=>"getUserUserBodyWeightDateStartDateOrEndDateEndDateOrPeriod.json", "x-api-path-slug"=>"useruseridbodyweightdatestartdateorenddateenddateorperiod-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User-id", "Body", "Weight", "Date", "Start-date-or-end-date", "End-date-or-period.json"]}}, "/user/{user-id}/activities/calories/date/{start-date-or-end-date}/{end-date-or-period}.json"=>{"get"=>{"summary"=>"Get User User Activities Calories Date Start Date Or End Date End Date Or Period .json", "description"=>"Get time series in the specified range for a given resource in the format requested using units in the unit system which corresponds to the Accept-Language header provided.", "operationId"=>"getUserUserActivitiesCaloriesDateStartDateOrEndDateEndDateOrPeriod.json", "x-api-path-slug"=>"useruseridactivitiescaloriesdatestartdateorenddateenddateorperiod-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User-id", "Activities", "Calories", "Date", "Start-date-or-end-date", "End-date-or-period.json"]}}, "/user/-/bp/{bp-log-id}.json"=>{"delete"=>{"summary"=>"Delete User Bp Bp Log .json", "description"=>"Delete user's blood pressure log entry with the given id.", "operationId"=>"deleteUserBpBpLog.json", "x-api-path-slug"=>"userbpbplogid-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Bp", "Bp-log-id.json"]}}, "/user/-/heart/{heart-log-id}.json"=>{"delete"=>{"summary"=>"Delete User Heart Heart Log .json", "description"=>"Delete user's heart rate log entry with the given id.", "operationId"=>"deleteUserHeartHeartLog.json", "x-api-path-slug"=>"userheartheartlogid-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Heart", "Heart-log-id.json"]}}, "/user/-/sleep/{sleep-log-id}.json"=>{"delete"=>{"summary"=>"Delete User Sleep Sleep Log .json", "description"=>"Delete user's sleep log entry with the given id.", "operationId"=>"deleteUserSleepSleepLog.json", "x-api-path-slug"=>"usersleepsleeplogid-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Sleep", "Sleep-log-id.json"]}}, "/user/{user-id}/badges.json"=>{"get"=>{"summary"=>"Get User User Badges.json", "description"=>"Get user's badges in the format requested. Response includes all badges for the user as seen on the Fitbit website badge locker (both activity and weight related). We return weight and distance badges based on the user's unit profile preference as on the website.", "operationId"=>"getUserUserBadges.json", "x-api-path-slug"=>"useruseridbadges-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User-id", "Badges.json"]}}, "/user/-/activities/{activity-log-id}.json"=>{"delete"=>{"summary"=>"Delete User Activities Activity Log .json", "description"=>"Delete user's activity log entry with the given id.", "operationId"=>"deleteUserActivitiesActivityLog.json", "x-api-path-slug"=>"useractivitiesactivitylogid-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Activities", "Activity-log-id.json"]}}, "/user/-/foods/log/{food-log-id}.json"=>{"delete"=>{"summary"=>"Delete User Foods Log Food Log .json", "description"=>"Delete the user's food log entry with the given id.", "operationId"=>"deleteUserFoodsLogFoodLog.json", "x-api-path-slug"=>"userfoodslogfoodlogid-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Foods", "Log", "Food-log-id.json"]}}, "/user/-/glucose.json"=>{"post"=>{"summary"=>"Post User Glucose.json", "description"=>"Create log entry for a blood glucose measurement and/or HbA1c using units in the unit system which corresponds to the Accept-Language header provided and get a response in the format requested.", "operationId"=>"postUserGlucose.json", "x-api-path-slug"=>"userglucose-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Glucose.json"]}}, "/user/-/bp.json"=>{"post"=>{"summary"=>"Post User Bp.json", "description"=>"Create log entry for a blood pressure measurement and get a response in the format requested.", "operationId"=>"postUserBp.json", "x-api-path-slug"=>"userbp-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Bp.json"]}}, "/user/-/heart.json"=>{"post"=>{"summary"=>"Post User Heart.json", "description"=>"Create log entry for a heart rate measurement and get a response in the format requested.", "operationId"=>"postUserHeart.json", "x-api-path-slug"=>"userheart-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Heart.json"]}}, "/user/-/sleep.json"=>{"post"=>{"summary"=>"Post User Sleep.json", "description"=>"Create log entry for a sleep and get a response in the format requested.", "operationId"=>"postUserSleep.json", "x-api-path-slug"=>"usersleep-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Sleep.json"]}}, "/user/-/foods/log.json"=>{"post"=>{"summary"=>"Post User Foods Log.json", "description"=>"Create log entry for a food. You need to select one of the unit ids to create a food log entry. It is possible to fetch unit ids allowed for specific food via previous calls to endpoints that retrieve food lists of the user. Each unit id maps to a unit in the list returned via the Get Food Units API call.", "operationId"=>"postUserFoodsLog.json", "x-api-path-slug"=>"userfoodslog-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Foods", "Log.json"]}}, "/user/-/activities.json"=>{"get"=>{"summary"=>"Get User Activities.json", "description"=>"Get user's activity statistics in the format requested using units in the unit system which corresponds to the Accept-Language header provided. Response contains both lifetime statistics from the tracker device and total numbers including the manual activity log entries as seen on the Fitbit website dashboard.", "operationId"=>"getUserActivities.json", "x-api-path-slug"=>"useractivities-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Activities.json"]}, "post"=>{"summary"=>"Post User Activities.json", "description"=>"Create log entry for an activity using units in the unit system which corresponds to the Accept-Language header provided (or using optional custom distanceUnit).", "operationId"=>"postUserActivities.json", "x-api-path-slug"=>"useractivities-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Activities.json"]}}, "/user/-/friends/leaderboard.json"=>{"get"=>{"summary"=>"Get User Friends Leaderboard.json", "description"=>"Get a leaderboard of user's friends progress in the format requested using units in the unit system which corresponds to the Accept-Language header provided. Authorized user himself is also included in the response.", "operationId"=>"getUserFriendsLeaderboard.json", "x-api-path-slug"=>"userfriendsleaderboard-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Friends", "Leaderboard.json"]}}, "/user/{user-id}/friends.json"=>{"get"=>{"summary"=>"Get User User Friends.json", "description"=>"Get user's friends in the format requested using units in the unit system which corresponds to the Accept-Language header provided.", "operationId"=>"getUserUserFriends.json", "x-api-path-slug"=>"useruseridfriends-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User-id", "Friends.json"]}}, "/user/-/glucose/date/{date}.json"=>{"get"=>{"summary"=>"Get User Glucose Date Date .json", "description"=>"Get a list of user's blood glucose and HbA1C measurements for a given day in the format requested using units in the unit system which corresponds to the Accept-Language header provided. Glucose measurement log entries are available only to authorized user. We always include all glucose trackers in the response body (with zero glucose value for the days with no measurements) to allow to seamlessly fetch a list of all additional user created custom trackers.", "operationId"=>"getUserGlucoseDateDate.json", "x-api-path-slug"=>"userglucosedatedate-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Glucose", "Date", "Date.json"]}}, "/user/-/bp/date/{date}.json"=>{"get"=>{"summary"=>"Get User Bp Date Date .json", "description"=>"Get an average value and a list of user's blood pressure log entries for a given day in the format requested. Blood pressure log entries are available only to authorized user. Blood pressure log entries in response are sorted exactly the same as they are presented on the Fitbit website.", "operationId"=>"getUserBpDateDate.json", "x-api-path-slug"=>"userbpdatedate-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Bp", "Date", "Date.json"]}}, "/user/-/heart/date/{date}.json"=>{"get"=>{"summary"=>"Get User Heart Date Date .json", "description"=>"Get an average values and a list of user's heart rate log entries for a given day in the format requested. Heart rate data available only to the authorized user. Heart rate log entries in response are sorted exactly the same as they are presented on the Fitbit website. We always include all heart rate trackers in the \"average\" section of the response body (with zero average values for the days with no measurements) to allow to seamlessly fetch a list of all additional user created custom trackers.", "operationId"=>"getUserHeartDateDate.json", "x-api-path-slug"=>"userheartdatedate-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Heart", "Date", "Date.json"]}}, "/user/{user-id}/sleep/date/{date}.json"=>{"get"=>{"summary"=>"Get User User Sleep Date Date .json", "description"=>"Get a summary and list of a user's sleep log entries for a given day in the format requested. Endpoint returns summary for all sleep log entries for the given day (including naps). If you need data only for the main sleep you can fetch entry with \"isMainSleep\" = true or use Get-Time-Series calls.", "operationId"=>"getUserUserSleepDateDate.json", "x-api-path-slug"=>"useruseridsleepdatedate-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User-id", "Sleep", "Date", "Date.json"]}}, "/user/{user-id}/foods/log/date/{date}.json"=>{"get"=>{"summary"=>"Get User User Foods Log Date Date .json", "description"=>"Get a summary and list of a user's food log entries for a given day in the format requested.", "operationId"=>"getUserUserFoodsLogDateDate.json", "x-api-path-slug"=>"useruseridfoodslogdatedate-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User-id", "Foods", "Log", "Date", "Date.json"]}}, "/user/{user-id}/activities/date/{date}.json"=>{"get"=>{"summary"=>"Get User User Activities Date Date .json", "description"=>"Get a summary and list of a user's activities and activity log entries for a given day in the format requested using units in the unit system which corresponds to the Accept-Language header provided.", "operationId"=>"getUserUserActivitiesDateDate.json", "x-api-path-slug"=>"useruseridactivitiesdatedate-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User-id", "Activities", "Date", "Date.json"]}}, "/user/-/body/log/fat/date/{date}.json"=>{"get"=>{"summary"=>"Get User Body Log Fat Date Date .json", "description"=>"Get a list of all user's body fat log entries for a given day in the format requested.", "operationId"=>"getUserBodyLogFatDateDate.json", "x-api-path-slug"=>"userbodylogfatdatedate-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Body", "Log", "Fat", "Date", "Date.json"]}}, "/user/-/body/log/weight/date/{date}.json"=>{"get"=>{"summary"=>"Get User Body Log Weight Date Date .json", "description"=>"Get a list of all user's body weight log entries for a given day in the format requested using units in the unit system which corresponds to the Accept-Language header provided.", "operationId"=>"getUserBodyLogWeightDateDate.json", "x-api-path-slug"=>"userbodylogweightdatedate-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Body", "Log", "Weight", "Date", "Date.json"]}}, "/user/{user-id}/body/date/{date}.json"=>{"get"=>{"summary"=>"Get User User Body Date Date .json", "description"=>"Get a summary of a user's body measurements for a given day in the format requested using units in the unit system which corresponds to the Accept-Language header provided.", "operationId"=>"getUserUserBodyDateDate.json", "x-api-path-slug"=>"useruseridbodydatedate-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User-id", "Body", "Date", "Date.json"]}}, "/user/-/profile.json"=>{"post"=>{"summary"=>"Post User Profile.json", "description"=>"Update user's profile using units in the unit system that corresponds to the Accept-Language header provided and get a response in the format requested.", "operationId"=>"postUserProfile.json", "x-api-path-slug"=>"userprofile-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "-", "Profile.json"]}}, "/user/{user-id}/profile.json"=>{"get"=>{"summary"=>"Get User User Profile.json", "description"=>"Get user's profile in the format requested using units in the unit system which corresponds to the Accept-Language header provided.", "operationId"=>"getUserUserProfile.json", "x-api-path-slug"=>"useruseridprofile-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User-id", "Profile.json"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
avaza{} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
3scale{"3scale-analytics-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"3scale", "x-complete"=>1, "info"=>{"title"=>"3Scale Analytics API", "description"=>"the-api-for-managing-3scale-analytics", "termsOfService"=>"http://www.3scale.net/terms-and-conditions/", "contact"=>{"name"=>"3Scale", "url"=>"https://support.3scale.net/"}, "version"=>"1"}, "host"=>"su1.3scale.net", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/stats/applications/{application_id}/usage.{format}"=>{"get"=>{"summary"=>"Application Usage by Metric", "description"=>"Application usage by metric.", "operationId"=>"application_ops", "x-api-path-slug"=>"statsapplicationsapplication-idusage-format-get", "parameters"=>[{"in"=>"path", "name"=>"application_id", "description"=>"id of the application"}, {"in"=>"path", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"granularity", "description"=>"Granularity of the results"}, {"in"=>"query", "name"=>"metric_name", "description"=>"System name of metric for which to get data"}, {"in"=>"query", "name"=>"period", "description"=>"Period, combined with since give the stats for the time range [since "}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale"}, {"in"=>"query", "name"=>"since", "description"=>"Time range start"}, {"in"=>"query", "name"=>"skip_change", "description"=>"Skip period over period calculations (setting this to true will increase the performance of the call)"}, {"in"=>"query", "name"=>"timezone", "description"=>"Timezone to do the calculations in"}, {"in"=>"query", "name"=>"until", "description"=>"Time range end"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Usage", "By", "Metric"]}}, "/stats/services/{service_id}/top_applications.{format}"=>{"get"=>{"summary"=>"Service Top Applications", "description"=>"Service top applications.", "operationId"=>"service_ops", "x-api-path-slug"=>"statsservicesservice-idtop-applications-format-get", "parameters"=>[{"in"=>"path", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"metric_name", "description"=>"System name of metric for which to get data"}, {"in"=>"query", "name"=>"period", "description"=>"Period, combined with since give the stats for the time range [since "}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}, {"in"=>"query", "name"=>"since", "description"=>"Time range start"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Top", "Applications"]}}, "/stats/services/{service_id}/usage.{format}"=>{"get"=>{"summary"=>"Service Usage by Metric", "description"=>"Service usage by metric.", "operationId"=>"service_ops", "x-api-path-slug"=>"statsservicesservice-idusage-format-get", "parameters"=>[{"in"=>"path", "name"=>"format", "description"=>"Response format"}, {"in"=>"query", "name"=>"granularity", "description"=>"Granularity of the results"}, {"in"=>"query", "name"=>"metric_name", "description"=>"System name of metric for which to get data"}, {"in"=>"query", "name"=>"period", "description"=>"Period, combined with since give the stats for the time range [since "}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}, {"in"=>"query", "name"=>"since", "description"=>"Time range start"}, {"in"=>"query", "name"=>"skip_change", "description"=>"Skip period over period calculations (setting this to true will increase the performance of the call)"}, {"in"=>"query", "name"=>"timezone", "description"=>"Timezone to do the calculations in"}, {"in"=>"query", "name"=>"until", "description"=>"Time range end"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Usage", "By", "Metric"]}}}}, "3scale-billing-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"3scale", "x-complete"=>1, "info"=>{"title"=>"3Scale Billing API", "description"=>"the-api-for-managing-3scale-billing", "termsOfService"=>"http://www.3scale.net/terms-and-conditions/", "contact"=>{"name"=>"3Scale", "url"=>"https://support.3scale.net/"}, "version"=>"1"}, "host"=>"su1.3scale.net", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/accounts/{account_id}/invoices.xml"=>{"get"=>{"summary"=>"Invoice List by Account", "description"=>"Invoice list by account.", "operationId"=>"finance", "x-api-path-slug"=>"apiaccountsaccount-idinvoices-xml-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"month", "description"=>"Filter the invoice by month"}, {"in"=>"query", "name"=>"page", "description"=>"Page in the paginated list"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of results per page"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale"}, {"in"=>"query", "name"=>"state", "description"=>"Filter the invoice by state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice", "List", "By", "Account"]}}, "/api/accounts/{account_id}/invoices/{id}.xml"=>{"get"=>{"summary"=>"Invoice by Account", "description"=>"Invoice by account.", "operationId"=>"finance", "x-api-path-slug"=>"apiaccountsaccount-idinvoicesid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"id", "description"=>"id of the invoice"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice", "By", "Account"]}}, "/api/invoices.xml"=>{"get"=>{"summary"=>"Invoice List", "description"=>"Invoice list.", "operationId"=>"finance", "x-api-path-slug"=>"apiinvoices-xml-get", "parameters"=>[{"in"=>"query", "name"=>"month", "description"=>"Filter the invoice by month"}, {"in"=>"query", "name"=>"page", "description"=>"Page in the paginated list"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of results per page"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale"}, {"in"=>"query", "name"=>"state", "description"=>"Filter the invoice by state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice", "List"]}}, "/api/invoices/{id}.xml"=>{"get"=>{"summary"=>"Invoice", "description"=>"Invoice.", "operationId"=>"finance", "x-api-path-slug"=>"apiinvoicesid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the invoice"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice"]}}, "/api/invoices/{id}/state.xml"=>{"put"=>{"summary"=>"Invoice", "description"=>"Invoice.", "operationId"=>"finance", "x-api-path-slug"=>"apiinvoicesidstate-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the invoice"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale"}, {"in"=>"query", "name"=>"state", "description"=>"State of the invoice to set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice"]}}, "/api/invoices/{invoice_id}/line_items.xml"=>{"get"=>{"summary"=>"Invoice Line Items List", "description"=>"Invoice line items list.", "operationId"=>"finance", "x-api-path-slug"=>"apiinvoicesinvoice-idline-items-xml-get", "parameters"=>[{"in"=>"path", "name"=>"invoice_id", "description"=>"id of the invoice"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice", "Line", "Items", "List"]}}, "/api/invoices/{invoice_id}/payment_transactions.xml"=>{"get"=>{"summary"=>"Invoice Payment Transactions List", "description"=>"Invoice payment transactions list.", "operationId"=>"finance", "x-api-path-slug"=>"apiinvoicesinvoice-idpayment-transactions-xml-get", "parameters"=>[{"in"=>"path", "name"=>"invoice_id", "description"=>"id of the invoice"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice", "Payment", "Transactions", "List"]}}}}, "3scale-account-management-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"3scale", "x-complete"=>1, "info"=>{"title"=>"3Scale Account Management API", "description"=>"the-api-for-managing-3scale-accounts-", "termsOfService"=>"http://www.3scale.net/terms-and-conditions/", "contact"=>{"name"=>"3Scale", "url"=>"https://support.3scale.net/"}, "version"=>"1"}, "host"=>"su1.3scale.net", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/admin/api/accounts.xml"=>{"get"=>{"summary"=>"Account List", "description"=>"Account list.", "operationId"=>"account", "x-api-path-slug"=>"adminapiaccounts-xml-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Page in the paginated list"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of results per page"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"state", "description"=>"Account state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "List"]}}, "/admin/api/accounts/find.xml"=>{"get"=>{"summary"=>"Account Find", "description"=>"Account find.", "operationId"=>"account", "x-api-path-slug"=>"adminapiaccountsfind-xml-get", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"email of the user of the account"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"username", "description"=>"username of the user of the account"}, {"in"=>"query", "name"=>"user_id", "description"=>"id of the user of the account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Find"]}}, "/admin/api/accounts/{account_id}/applications.xml"=>{"get"=>{"summary"=>"Application List", "description"=>"Application list.", "operationId"=>"application", "x-api-path-slug"=>"adminapiaccountsaccount-idapplications-xml-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "List"]}, "post"=>{"summary"=>"Application Create", "description"=>"Application create.", "operationId"=>"application", "x-api-path-slug"=>"adminapiaccountsaccount-idapplications-xml-post", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"additional_fields", "description"=>"Additional fields have to be name and value i"}, {"in"=>"query", "name"=>"description", "description"=>"Description of the application to be created"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the application to be created"}, {"in"=>"query", "name"=>"plan_id", "description"=>"id of the application plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Create"]}}, "/admin/api/accounts/{account_id}/applications/{application_id}/keys.xml"=>{"get"=>{"summary"=>"Application Key List", "description"=>"Application key list.", "operationId"=>"application", "x-api-path-slug"=>"adminapiaccountsaccount-idapplicationsapplication-idkeys-xml-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"application_id", "description"=>"id of the application"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Key", "List"]}, "post"=>{"summary"=>"Application key Create", "description"=>"Application key create.", "operationId"=>"application", "x-api-path-slug"=>"adminapiaccountsaccount-idapplicationsapplication-idkeys-xml-post", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"application_id", "description"=>"id of the application"}, {"in"=>"query", "name"=>"key", "description"=>"app_key to be added"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Key", "Create"]}}, "/admin/api/accounts/{account_id}/applications/{application_id}/keys/{key}.xml"=>{"delete"=>{"summary"=>"Application key Delete", "description"=>"Application key delete.", "operationId"=>"application", "x-api-path-slug"=>"adminapiaccountsaccount-idapplicationsapplication-idkeyskey-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"application_id", "description"=>"id of the application"}, {"in"=>"path", "name"=>"key", "description"=>"app_key to be deleted"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Key"]}}, "/admin/api/accounts/{account_id}/applications/{application_id}/referrer_filters.xml"=>{"get"=>{"summary"=>"Application Referrer Filter List", "description"=>"Application referrer filter list.", "operationId"=>"application", "x-api-path-slug"=>"adminapiaccountsaccount-idapplicationsapplication-idreferrer-filters-xml-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"application_id", "description"=>"id of the application"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Referrer", "Filter", "List"]}, "post"=>{"summary"=>"Application referrer filter Create", "description"=>"Application referrer filter create.", "operationId"=>"application", "x-api-path-slug"=>"adminapiaccountsaccount-idapplicationsapplication-idreferrer-filters-xml-post", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"application_id", "description"=>"id of the application"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"referrer_filter", "description"=>"referrer filter to be created"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Referrer", "Filter", "Create"]}}, "/admin/api/accounts/{account_id}/applications/{application_id}/referrer_filters/{id}.xml"=>{"delete"=>{"summary"=>"Application referrer filter Delete", "description"=>"Application referrer filter delete.", "operationId"=>"application", "x-api-path-slug"=>"adminapiaccountsaccount-idapplicationsapplication-idreferrer-filtersid-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"application_id", "description"=>"id of the application"}, {"in"=>"path", "name"=>"id", "description"=>"id of referrer filter to be deleted"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Referrer", "Filter"]}}, "/admin/api/accounts/{account_id}/applications/{id}.xml"=>{"get"=>{"summary"=>"Application Read", "description"=>"Application read.", "operationId"=>"application", "x-api-path-slug"=>"adminapiaccountsaccount-idapplicationsid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"id", "description"=>"id of the application"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Read"]}, "put"=>{"summary"=>"Application Update", "description"=>"Application update.", "operationId"=>"application", "x-api-path-slug"=>"adminapiaccountsaccount-idapplicationsid-xml-put", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"additional_fields", "description"=>"Additional fields have to be name and value i"}, {"in"=>"query", "name"=>"description", "description"=>"Description of the application"}, {"in"=>"path", "name"=>"id", "description"=>"id of the application"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the application"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}}, "/admin/api/accounts/{account_id}/applications/{id}/accept.xml"=>{"put"=>{"summary"=>"Application Accept", "description"=>"Application accept.", "operationId"=>"application", "x-api-path-slug"=>"adminapiaccountsaccount-idapplicationsidaccept-xml-put", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"id", "description"=>"id of the application"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Accept"]}}, "/admin/api/accounts/{account_id}/applications/{id}/change_plan.xml"=>{"put"=>{"summary"=>"Application Change Plan", "description"=>"Application change plan.", "operationId"=>"application", "x-api-path-slug"=>"adminapiaccountsaccount-idapplicationsidchange-plan-xml-put", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"id", "description"=>"id of the application"}, {"in"=>"query", "name"=>"plan_id", "description"=>"id of the new application plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Change", "Plan"]}}, "/admin/api/accounts/{account_id}/applications/{id}/customize_plan.xml"=>{"put"=>{"summary"=>"Application Create Plan Customization", "description"=>"Application create plan customization.", "operationId"=>"application", "x-api-path-slug"=>"adminapiaccountsaccount-idapplicationsidcustomize-plan-xml-put", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"id", "description"=>"id of the application"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Plan", "Customization"]}}, "/admin/api/accounts/{account_id}/applications/{id}/decustomize_plan.xml"=>{"put"=>{"summary"=>"Application Delete Plan Customization", "description"=>"Application delete plan customization.", "operationId"=>"application", "x-api-path-slug"=>"adminapiaccountsaccount-idapplicationsiddecustomize-plan-xml-put", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"id", "description"=>"id of the application"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "", "Plan", "Customization"]}}, "/admin/api/accounts/{account_id}/applications/{id}/resume.xml"=>{"put"=>{"summary"=>"Application Resume", "description"=>"Application resume.", "operationId"=>"application", "x-api-path-slug"=>"adminapiaccountsaccount-idapplicationsidresume-xml-put", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"id", "description"=>"id of the application"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Resume"]}}, "/admin/api/accounts/{account_id}/applications/{id}/suspend.xml"=>{"put"=>{"summary"=>"Application Suspend", "description"=>"Application suspend.", "operationId"=>"application", "x-api-path-slug"=>"adminapiaccountsaccount-idapplicationsidsuspend-xml-put", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"id", "description"=>"id of the application"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Suspend"]}}, "/admin/api/accounts/{account_id}/messages.xml"=>{"post"=>{"summary"=>"Account Message", "description"=>"Account message.", "operationId"=>"account", "x-api-path-slug"=>"adminapiaccountsaccount-idmessages-xml-post", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"body", "description"=>"Text to send"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Message"]}}, "/admin/api/accounts/{account_id}/plan.xml"=>{"get"=>{"summary"=>"Account Fetch Account Plan", "description"=>"Account fetch account plan.", "operationId"=>"account", "x-api-path-slug"=>"adminapiaccountsaccount-idplan-xml-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Fetch", "Account", "Plan"]}}, "/admin/api/accounts/{account_id}/users.xml"=>{"get"=>{"summary"=>"User List", "description"=>"User list.", "operationId"=>"user", "x-api-path-slug"=>"adminapiaccountsaccount-idusers-xml-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"role", "description"=>"Filter users by Role"}, {"in"=>"query", "name"=>"state", "description"=>"Filter users by State"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "List"]}, "post"=>{"summary"=>"User Create", "description"=>"User create.", "operationId"=>"user", "x-api-path-slug"=>"adminapiaccountsaccount-idusers-xml-post", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"additional_fields", "description"=>"Additional fields have to be name and value i"}, {"in"=>"query", "name"=>"email", "description"=>"Email of the user"}, {"in"=>"query", "name"=>"password", "description"=>"Password of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"username", "description"=>"Username of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Create"]}}, "/admin/api/accounts/{account_id}/users/{id}.xml"=>{"delete"=>{"summary"=>"User Delete", "description"=>"User delete.", "operationId"=>"user", "x-api-path-slug"=>"adminapiaccountsaccount-idusersid-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"id", "description"=>"id of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "get"=>{"summary"=>"User Read", "description"=>"User read.", "operationId"=>"user", "x-api-path-slug"=>"adminapiaccountsaccount-idusersid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"id", "description"=>"id of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Read"]}, "put"=>{"summary"=>"User Update", "description"=>"User update.", "operationId"=>"user", "x-api-path-slug"=>"adminapiaccountsaccount-idusersid-xml-put", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"additional_fields", "description"=>"Additional fields have to be name and value i"}, {"in"=>"query", "name"=>"email", "description"=>"Email of the user"}, {"in"=>"path", "name"=>"id", "description"=>"id of the user"}, {"in"=>"query", "name"=>"password", "description"=>"Password of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"username", "description"=>"Username of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/admin/api/accounts/{account_id}/users/{id}/activate.xml"=>{"put"=>{"summary"=>"User Activate", "description"=>"User activate.", "operationId"=>"user", "x-api-path-slug"=>"adminapiaccountsaccount-idusersidactivate-xml-put", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"id", "description"=>"id of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Activate"]}}, "/admin/api/accounts/{account_id}/users/{id}/admin.xml"=>{"put"=>{"summary"=>"User change Role to Admin", "description"=>"User change role to admin.", "operationId"=>"user", "x-api-path-slug"=>"adminapiaccountsaccount-idusersidadmin-xml-put", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"id", "description"=>"id of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Change", "Role", "To", "Admin"]}}, "/admin/api/accounts/{account_id}/users/{id}/member.xml"=>{"put"=>{"summary"=>"User change Role to Member", "description"=>"User change role to member.", "operationId"=>"user", "x-api-path-slug"=>"adminapiaccountsaccount-idusersidmember-xml-put", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"id", "description"=>"id of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Change", "Role", "To", "Member"]}}, "/admin/api/accounts/{account_id}/users/{id}/suspend.xml"=>{"put"=>{"summary"=>"User Suspend", "description"=>"User suspend.", "operationId"=>"user", "x-api-path-slug"=>"adminapiaccountsaccount-idusersidsuspend-xml-put", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"id", "description"=>"id of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Suspend"]}}, "/admin/api/accounts/{account_id}/users/{id}/unsuspend.xml"=>{"put"=>{"summary"=>"User Unsuspend", "description"=>"User unsuspend.", "operationId"=>"user", "x-api-path-slug"=>"adminapiaccountsaccount-idusersidunsuspend-xml-put", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"id of the account"}, {"in"=>"path", "name"=>"id", "description"=>"id of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Unsuspend"]}}, "/admin/api/accounts/{id}.xml"=>{"delete"=>{"summary"=>"Account Delete", "description"=>"Account delete .", "operationId"=>"account", "x-api-path-slug"=>"adminapiaccountsid-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}, "get"=>{"summary"=>"Account Read", "description"=>"Account read.", "operationId"=>"account", "x-api-path-slug"=>"adminapiaccountsid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Read"]}, "put"=>{"summary"=>"Account Update", "description"=>"Account update.", "operationId"=>"account", "x-api-path-slug"=>"adminapiaccountsid-xml-put", "parameters"=>[{"in"=>"query", "name"=>"additional_fields", "description"=>"Additional fields have to be name and value i"}, {"in"=>"path", "name"=>"id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"org_name", "description"=>"Organization name of the account"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/admin/api/accounts/{id}/approve.xml"=>{"put"=>{"summary"=>"Account Approve", "description"=>"Account approve.", "operationId"=>"account", "x-api-path-slug"=>"adminapiaccountsidapprove-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Approve"]}}, "/admin/api/accounts/{id}/change_plan.xml"=>{"put"=>{"summary"=>"Account Change Plan", "description"=>"Account change plan.", "operationId"=>"account", "x-api-path-slug"=>"adminapiaccountsidchange-plan-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"plan_id", "description"=>"id of the target account plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Change", "Plan"]}}, "/admin/api/accounts/{id}/credit_card.xml"=>{"delete"=>{"summary"=>"Account Delete Credit Card", "description"=>"Account delete credit card.", "operationId"=>"account", "x-api-path-slug"=>"adminapiaccountsidcredit-card-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "", "Credit", "Card"]}, "put"=>{"summary"=>"Account Set Credit Card", "description"=>"Account set credit card.", "operationId"=>"account", "x-api-path-slug"=>"adminapiaccountsidcredit-card-xml-put", "parameters"=>[{"in"=>"query", "name"=>"billing_address_address", "description"=>"Address associated to the credit card"}, {"in"=>"query", "name"=>"billing_address_city", "description"=>"Billing address city"}, {"in"=>"query", "name"=>"billing_address_country", "description"=>"Billing address country"}, {"in"=>"query", "name"=>"billing_address_name", "description"=>"Name of the person/company to bill"}, {"in"=>"query", "name"=>"billing_address_phone", "description"=>"Billing address phone"}, {"in"=>"query", "name"=>"billing_address_state", "description"=>"Billing address state"}, {"in"=>"query", "name"=>"billing_address_zip", "description"=>"Billing address ZIP code"}, {"in"=>"query", "name"=>"credit_card_authorize_net_payment_profile_token", "description"=>"Authorize"}, {"in"=>"query", "name"=>"credit_card_expiration_month", "description"=>"Month of expiration of credit card"}, {"in"=>"query", "name"=>"credit_card_expiration_year", "description"=>"Year of expiration of credit card"}, {"in"=>"query", "name"=>"credit_card_partial_number", "description"=>"4 last numbers of the credit card"}, {"in"=>"query", "name"=>"credit_card_token", "description"=>"The token returned by the payment gateway"}, {"in"=>"path", "name"=>"id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Set", "Credit", "Card"]}}, "/admin/api/accounts/{id}/make_pending.xml"=>{"put"=>{"summary"=>"Account Reset to Pending", "description"=>"Account reset to pending.", "operationId"=>"account", "x-api-path-slug"=>"adminapiaccountsidmake-pending-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Reset", "To", "Pending"]}}, "/admin/api/accounts/{id}/reject.xml"=>{"put"=>{"summary"=>"Account Reject", "description"=>"Account reject.", "operationId"=>"account", "x-api-path-slug"=>"adminapiaccountsidreject-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the account"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Reject"]}}, "/admin/api/account_plans.xml"=>{"get"=>{"summary"=>"Account Plan List", "description"=>"Account plan list.", "operationId"=>"account_plan", "x-api-path-slug"=>"adminapiaccount-plans-xml-get", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Plan", "List"]}, "post"=>{"summary"=>"Account Plan Create", "description"=>"Account plan create.", "operationId"=>"account_plan", "x-api-path-slug"=>"adminapiaccount-plans-xml-post", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"Name of the account plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"system_name", "description"=>"System Name of the object to be created"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Plan", "Create"]}}, "/admin/api/account_plans/{account_plan_id}/features.xml"=>{"get"=>{"summary"=>"Account Plan Feature List", "description"=>"Account plan feature list.", "operationId"=>"account_plan_feature", "x-api-path-slug"=>"adminapiaccount-plansaccount-plan-idfeatures-xml-get", "parameters"=>[{"in"=>"path", "name"=>"account_plan_id", "description"=>"id of the account plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Plan", "Feature", "List"]}}, "/admin/api/account_plans/{account_plan_id}/features/{id}.xml"=>{"delete"=>{"summary"=>"Account Plan Features Delete", "description"=>"Account plan features delete.", "operationId"=>"account_plan_feature", "x-api-path-slug"=>"adminapiaccount-plansaccount-plan-idfeaturesid-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"account_plan_id", "description"=>"id of the account plan"}, {"in"=>"path", "name"=>"id", "description"=>"id of the feature"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Plan", "Features"]}, "post"=>{"summary"=>"Account Plan Features Create", "description"=>"Account plan features create.", "operationId"=>"account_plan_feature", "x-api-path-slug"=>"adminapiaccount-plansaccount-plan-idfeaturesid-xml-post", "parameters"=>[{"in"=>"path", "name"=>"account_plan_id", "description"=>"id of the account plan"}, {"in"=>"path", "name"=>"id", "description"=>"id of the feature"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Plan", "Features", "Create"]}}, "/admin/api/account_plans/{id}.xml"=>{"delete"=>{"summary"=>"Account Plan Delete", "description"=>"Account plan delete.", "operationId"=>"account_plan", "x-api-path-slug"=>"adminapiaccount-plansid-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the account plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Plan"]}, "get"=>{"summary"=>"Account Plan Read", "description"=>"Account plan read.", "operationId"=>"account_plan", "x-api-path-slug"=>"adminapiaccount-plansid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the account plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Plan", "Read"]}, "put"=>{"summary"=>"Account Plan Update", "description"=>"Account plan update.", "operationId"=>"account_plan", "x-api-path-slug"=>"adminapiaccount-plansid-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the account plan"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the account plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Plan"]}}, "/admin/api/account_plans/{id}/default.xml"=>{"put"=>{"summary"=>"Account Plan set to Default", "description"=>"Account plan set to default.", "operationId"=>"account_plan", "x-api-path-slug"=>"adminapiaccount-plansiddefault-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the account plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Plan", "Set", "To", "Default"]}}, "/admin/api/active_docs/{id}.xml"=>{"put"=>{"summary"=>"ActiveDocs JSON Spec Update", "description"=>"Activedocs json spec update.", "operationId"=>"active_docs", "x-api-path-slug"=>"adminapiactive-docsid-xml-put", "parameters"=>[{"in"=>"query", "name"=>"body", "description"=>"JSON Spec of the ActiveDocs (based on the spec of Swagger)"}, {"in"=>"path", "name"=>"id", "description"=>"id of the active doc"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ActiveDocs", "JSON", "Spec"]}}, "/admin/api/applications.xml"=>{"get"=>{"summary"=>"Application List (all services)", "description"=>"Application list (all services).", "operationId"=>"application", "x-api-path-slug"=>"adminapiapplications-xml-get", "parameters"=>[{"in"=>"query", "name"=>"active_since", "description"=>"filter date"}, {"in"=>"query", "name"=>"inactive_since", "description"=>"filter date"}, {"in"=>"query", "name"=>"page", "description"=>"Page in the paginated list"}, {"in"=>"query", "name"=>"per_page", "description"=>"Number of results per page"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"service_id", "description"=>"filter by service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "List", "(all", "Services)"]}}, "/admin/api/applications/find.xml"=>{"get"=>{"summary"=>"Application Find", "description"=>"Application find.", "operationId"=>"application", "x-api-path-slug"=>"adminapiapplicationsfind-xml-get", "parameters"=>[{"in"=>"query", "name"=>"application_id", "description"=>"id of the application"}, {"in"=>"query", "name"=>"app_id", "description"=>"app_id of the application (for app_id/app_key and oauth authentication modes)"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"user_key", "description"=>"user_key of the application (for user_key authentication mode)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Find"]}}, "/admin/api/application_plans.xml"=>{"get"=>{"summary"=>"Application Plan List (all services)", "description"=>"Application plan list (all services).", "operationId"=>"application_plan", "x-api-path-slug"=>"adminapiapplication-plans-xml-get", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Plan", "List", "(all", "Services)"]}}, "/admin/api/application_plans/{application_plan_id}/features.xml"=>{"get"=>{"summary"=>"Application Plan Feature List", "description"=>"Application plan feature list.", "operationId"=>"application_plan_feature", "x-api-path-slug"=>"adminapiapplication-plansapplication-plan-idfeatures-xml-get", "parameters"=>[{"in"=>"path", "name"=>"application_plan_id", "description"=>"id of the application plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Plan", "Feature", "List"]}, "post"=>{"summary"=>"Application Plan Feature Create", "description"=>"Application plan feature create.", "operationId"=>"application_plan_feature", "x-api-path-slug"=>"adminapiapplication-plansapplication-plan-idfeatures-xml-post", "parameters"=>[{"in"=>"path", "name"=>"application_plan_id", "description"=>"id of the application plan"}, {"in"=>"query", "name"=>"feature_id", "description"=>"id of the feature"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Plan", "Feature", "Create"]}}, "/admin/api/application_plans/{application_plan_id}/features/{id}.xml"=>{"delete"=>{"summary"=>"Application Plan Feature Delete", "description"=>"Application plan feature delete.", "operationId"=>"application_plan_feature", "x-api-path-slug"=>"adminapiapplication-plansapplication-plan-idfeaturesid-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"application_plan_id", "description"=>"id of the application plan"}, {"in"=>"path", "name"=>"id", "description"=>"id of the feature"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Plan", "Feature"]}}, "/admin/api/application_plans/{application_plan_id}/limits.xml"=>{"get"=>{"summary"=>"Limits List per Application Plan", "description"=>"Limits list per application plan.", "operationId"=>"application_plan_limits", "x-api-path-slug"=>"adminapiapplication-plansapplication-plan-idlimits-xml-get", "parameters"=>[{"in"=>"path", "name"=>"application_plan_id", "description"=>"id of the application plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Limits", "List", "Per", "Application", "Plan"]}}, "/admin/api/application_plans/{application_plan_id}/metrics/{metric_id}/limits.xml"=>{"get"=>{"summary"=>"Limit List per Metric", "description"=>"Limit list per metric.", "operationId"=>"application_plan_limit", "x-api-path-slug"=>"adminapiapplication-plansapplication-plan-idmetricsmetric-idlimits-xml-get", "parameters"=>[{"in"=>"path", "name"=>"application_plan_id", "description"=>"id of the application plan"}, {"in"=>"path", "name"=>"metric_id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Limit", "List", "Per", "Metric"]}, "post"=>{"summary"=>"Limit Create", "description"=>"Limit create.", "operationId"=>"application_plan_limit", "x-api-path-slug"=>"adminapiapplication-plansapplication-plan-idmetricsmetric-idlimits-xml-post", "parameters"=>[{"in"=>"path", "name"=>"application_plan_id", "description"=>"id of the application plan"}, {"in"=>"path", "name"=>"metric_id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"period", "description"=>"period of the limit"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"value", "description"=>"value of the limit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Limit", "Create"]}}, "/admin/api/application_plans/{application_plan_id}/metrics/{metric_id}/limits/{id}.xml"=>{"delete"=>{"summary"=>"Limit Delete", "description"=>"Limit delete.", "operationId"=>"application_plan_limit", "x-api-path-slug"=>"adminapiapplication-plansapplication-plan-idmetricsmetric-idlimitsid-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"application_plan_id", "description"=>"id of the application plan"}, {"in"=>"path", "name"=>"id", "description"=>"id of the limit"}, {"in"=>"path", "name"=>"metric_id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Limit"]}, "get"=>{"summary"=>"Limit Read", "description"=>"Limit read.", "operationId"=>"application_plan_limit", "x-api-path-slug"=>"adminapiapplication-plansapplication-plan-idmetricsmetric-idlimitsid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"application_plan_id", "description"=>"id of the application plan"}, {"in"=>"path", "name"=>"id", "description"=>"id of the limit"}, {"in"=>"path", "name"=>"metric_id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Limit", "Read"]}, "put"=>{"summary"=>"Limit Update", "description"=>"Limit update.", "operationId"=>"application_plan_limit", "x-api-path-slug"=>"adminapiapplication-plansapplication-plan-idmetricsmetric-idlimitsid-xml-put", "parameters"=>[{"in"=>"path", "name"=>"application_plan_id", "description"=>"id of the application plan"}, {"in"=>"path", "name"=>"id", "description"=>"id of the limit"}, {"in"=>"path", "name"=>"metric_id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"period", "description"=>"period of the limit"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"value", "description"=>"value of the limit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Limit"]}}, "/admin/api/application_plans/{application_plan_id}/metrics/{metric_id}/pricing_rules.xml"=>{"get"=>{"summary"=>"Pricing Rules List per Metric", "description"=>"Pricing rules list per metric.", "operationId"=>"application_plan_pricing_rules", "x-api-path-slug"=>"adminapiapplication-plansapplication-plan-idmetricsmetric-idpricing-rules-xml-get", "parameters"=>[{"in"=>"path", "name"=>"application_plan_id", "description"=>"id of the application plan"}, {"in"=>"path", "name"=>"metric_id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pricing", "Rules", "List", "Per", "Metric"]}}, "/admin/api/application_plans/{application_plan_id}/pricing_rules.xml"=>{"get"=>{"summary"=>"Pricing Rules List per Application Plan", "description"=>"Pricing rules list per application plan.", "operationId"=>"application_plan_pricing_rules", "x-api-path-slug"=>"adminapiapplication-plansapplication-plan-idpricing-rules-xml-get", "parameters"=>[{"in"=>"path", "name"=>"application_plan_id", "description"=>"id of the application plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pricing", "Rules", "List", "Per", "Application", "Plan"]}}, "/admin/api/end_user_plans.xml"=>{"get"=>{"summary"=>"End User Plan List (all services)", "description"=>"End user plan list (all services).", "operationId"=>"end_user_plan", "x-api-path-slug"=>"adminapiend-user-plans-xml-get", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["End", "User", "Plan", "List", "(all", "Services)"]}}, "/admin/api/end_user_plans/{end_user_plan_id}/metrics/{metric_id}/limits.xml"=>{"get"=>{"summary"=>"Limit List for End User Plans", "description"=>"Limit list for end user plans .", "operationId"=>"end_user_plan_limit", "x-api-path-slug"=>"adminapiend-user-plansend-user-plan-idmetricsmetric-idlimits-xml-get", "parameters"=>[{"in"=>"path", "name"=>"end_user_plan_id", "description"=>"id of the end user plan"}, {"in"=>"path", "name"=>"metric_id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Limit", "ListEnd", "User", "Plans"]}, "post"=>{"summary"=>"Limit Create for End User Plans", "description"=>"Limit create for end user plans.", "operationId"=>"end_user_plan_limit", "x-api-path-slug"=>"adminapiend-user-plansend-user-plan-idmetricsmetric-idlimits-xml-post", "parameters"=>[{"in"=>"path", "name"=>"end_user_plan_id", "description"=>"id of the end user plan"}, {"in"=>"path", "name"=>"metric_id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"period", "description"=>"period of the limit"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"value", "description"=>"value of the limit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Limit", "CreateEnd", "User", "Plans"]}}, "/admin/api/end_user_plans/{end_user_plan_id}/metrics/{metric_id}/limits/{id}.xml"=>{"delete"=>{"summary"=>"Limit Delete for End User Plans", "description"=>"Limit delete for end user plans.", "operationId"=>"end_user_plan_limit", "x-api-path-slug"=>"adminapiend-user-plansend-user-plan-idmetricsmetric-idlimitsid-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"end_user_plan_id", "description"=>"id of the end user plan"}, {"in"=>"path", "name"=>"id", "description"=>"id of the limit"}, {"in"=>"path", "name"=>"metric_id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Limit", "End", "User", "Plans"]}, "get"=>{"summary"=>"Limit Read for End User Plans", "description"=>"Limit read for end user plans.", "operationId"=>"end_user_plan_limit", "x-api-path-slug"=>"adminapiend-user-plansend-user-plan-idmetricsmetric-idlimitsid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"end_user_plan_id", "description"=>"id of the end user plan"}, {"in"=>"path", "name"=>"id", "description"=>"id of the limit"}, {"in"=>"path", "name"=>"metric_id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Limit", "ReadEnd", "User", "Plans"]}, "put"=>{"summary"=>"Limit Update for End User Plans", "description"=>"Limit update for end user plans.", "operationId"=>"end_user_plan_limit", "x-api-path-slug"=>"adminapiend-user-plansend-user-plan-idmetricsmetric-idlimitsid-xml-put", "parameters"=>[{"in"=>"path", "name"=>"end_user_plan_id", "description"=>"id of the end user plan"}, {"in"=>"path", "name"=>"id", "description"=>"id of the limit"}, {"in"=>"path", "name"=>"metric_id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"period", "description"=>"period of the limit"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"value", "description"=>"value of the limit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Limit", "End", "User", "Plans"]}}, "/admin/api/features.xml"=>{"get"=>{"summary"=>"Account Feature List", "description"=>"Account feature list.", "operationId"=>"account_feature", "x-api-path-slug"=>"adminapifeatures-xml-get", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Feature", "List"]}, "post"=>{"summary"=>"Account Feature Create", "description"=>"Account feature create.", "operationId"=>"account_feature", "x-api-path-slug"=>"adminapifeatures-xml-post", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"Name of the feature"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"system_name", "description"=>"System Name of the object to be created"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Feature", "Create"]}}, "/admin/api/features/{id}.xml"=>{"delete"=>{"summary"=>"Account Feature Delete", "description"=>"Account feature delete.", "operationId"=>"account_feature", "x-api-path-slug"=>"adminapifeaturesid-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the feature"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Feature"]}, "get"=>{"summary"=>"Account Feature Read", "description"=>"Account feature read.", "operationId"=>"account_feature", "x-api-path-slug"=>"adminapifeaturesid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the feature"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Feature", "Read"]}, "put"=>{"summary"=>"Account Feature Update", "description"=>"Account feature update.", "operationId"=>"account_feature", "x-api-path-slug"=>"adminapifeaturesid-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the feature"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the feature"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Feature"]}}, "/admin/api/nginx.zip"=>{"get"=>{"summary"=>"Nginx configuration files", "description"=>"Nginx configuration files.", "operationId"=>"nginx", "x-api-path-slug"=>"adminapinginx-zip-get", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nginx", "Configuration", "Files"]}}, "/admin/api/provider.xml"=>{"get"=>{"summary"=>"Account Read", "description"=>"Account read.", "operationId"=>"account", "x-api-path-slug"=>"adminapiprovider-xml-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Read"]}}, "/admin/api/services.xml"=>{"get"=>{"summary"=>"Service List", "description"=>"Service list.", "operationId"=>"service", "x-api-path-slug"=>"adminapiservices-xml-get", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "List"]}, "post"=>{"summary"=>"Service Create", "description"=>"Service create.", "operationId"=>"service", "x-api-path-slug"=>"adminapiservices-xml-post", "parameters"=>[nil, {"in"=>"query", "name"=>"name", "description"=>"Name of the service to be created"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"system_name", "description"=>"System Name of the object to be created"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Create"]}}, "/admin/api/services/{id}.xml"=>{"get"=>{"summary"=>"Service Read", "description"=>"Service read.", "operationId"=>"service", "x-api-path-slug"=>"adminapiservicesid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the service"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Read"]}, "put"=>{"summary"=>"Service Update", "description"=>"Service update.", "operationId"=>"service", "x-api-path-slug"=>"adminapiservicesid-xml-put", "parameters"=>[nil, {"in"=>"path", "name"=>"id", "description"=>"id of the service"}, {"in"=>"query", "name"=>"name", "description"=>"New name for the service"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service"]}}, "/admin/api/services/{id}/service_plans.xml"=>{"get"=>{"summary"=>"Service Plan List", "description"=>"Service plan list.", "operationId"=>"service_plan", "x-api-path-slug"=>"adminapiservicesidservice-plans-xml-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the service"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Plan", "List"]}, "post"=>{"summary"=>"Service Plan Create", "description"=>"Service plan create.", "operationId"=>"service_plan", "x-api-path-slug"=>"adminapiservicesidservice-plans-xml-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the service"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the service plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"system_name", "description"=>"System Name of the object to be created"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Plan", "Create"]}}, "/admin/api/services/{service_id}/application_plans.xml"=>{"get"=>{"summary"=>"Application Plan List", "description"=>"Application plan list.", "operationId"=>"application_plan", "x-api-path-slug"=>"adminapiservicesservice-idapplication-plans-xml-get", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Plan", "List"]}, "post"=>{"summary"=>"Application Plan Create", "description"=>"Application plan create.", "operationId"=>"application_plan", "x-api-path-slug"=>"adminapiservicesservice-idapplication-plans-xml-post", "parameters"=>[nil, {"in"=>"query", "name"=>"name", "description"=>"Name of the application plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}, {"in"=>"query", "name"=>"system_name", "description"=>"System Name of the object to be created"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Plan", "Create"]}}, "/admin/api/services/{service_id}/application_plans/{id}.xml"=>{"delete"=>{"summary"=>"Application Plan Delete", "description"=>"Application plan delete.", "operationId"=>"application_plan", "x-api-path-slug"=>"adminapiservicesservice-idapplication-plansid-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the application plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Plan"]}, "get"=>{"summary"=>"Application Plan Read", "description"=>"Application plan read.", "operationId"=>"application_plan", "x-api-path-slug"=>"adminapiservicesservice-idapplication-plansid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the application plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Plan", "Read"]}, "put"=>{"summary"=>"Application Plan Update", "description"=>"Application plan update.", "operationId"=>"application_plan", "x-api-path-slug"=>"adminapiservicesservice-idapplication-plansid-xml-put", "parameters"=>[nil, {"in"=>"path", "name"=>"id", "description"=>"id of the application plan"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the application plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Plan"]}}, "/admin/api/services/{service_id}/application_plans/{id}/default.xml"=>{"put"=>{"summary"=>"Application Plan set to Default", "description"=>"Application plan set to default.", "operationId"=>"application_plan", "x-api-path-slug"=>"adminapiservicesservice-idapplication-plansiddefault-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the application plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Plan", "Set", "To", "Default"]}}, "/admin/api/services/{service_id}/end_users.xml"=>{"post"=>{"summary"=>"End User Create", "description"=>"End user create.", "operationId"=>"end_user", "x-api-path-slug"=>"adminapiservicesservice-idend-users-xml-post", "parameters"=>[{"in"=>"query", "name"=>"plan_id", "description"=>"id of the end user plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}, {"in"=>"query", "name"=>"username", "description"=>"username (unique identifier) of the end user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["End", "User", "Create"]}}, "/admin/api/services/{service_id}/end_users/{username}.xml"=>{"delete"=>{"summary"=>"End User Delete", "description"=>"End user delete.", "operationId"=>"end_user", "x-api-path-slug"=>"adminapiservicesservice-idend-usersusername-xml-delete", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}, {"in"=>"path", "name"=>"username", "description"=>"username (unique identifier) of the end user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["End", "User"]}, "get"=>{"summary"=>"End User Read", "description"=>"End user read.", "operationId"=>"end_user", "x-api-path-slug"=>"adminapiservicesservice-idend-usersusername-xml-get", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}, {"in"=>"path", "name"=>"username", "description"=>"username (unique identifier) of the end user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["End", "User", "Read"]}}, "/admin/api/services/{service_id}/end_users/{username}/change_plan.xml"=>{"put"=>{"summary"=>"End User Change Plan", "description"=>"End user change plan.", "operationId"=>"end_user", "x-api-path-slug"=>"adminapiservicesservice-idend-usersusernamechange-plan-xml-put", "parameters"=>[{"in"=>"query", "name"=>"plan_id", "description"=>"id of the new end user plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}, {"in"=>"path", "name"=>"username", "description"=>"username (unique identifier) of the end user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["End", "User", "Change", "Plan"]}}, "/admin/api/services/{service_id}/end_user_plans.xml"=>{"get"=>{"summary"=>"End User Plan List", "description"=>"End user plan list.", "operationId"=>"end_user_plan", "x-api-path-slug"=>"adminapiservicesservice-idend-user-plans-xml-get", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["End", "User", "Plan", "List"]}, "post"=>{"summary"=>"End User Plan Create", "description"=>"End user plan create.", "operationId"=>"end_user_plan", "x-api-path-slug"=>"adminapiservicesservice-idend-user-plans-xml-post", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"Name of the end user plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["End", "User", "Plan", "Create"]}}, "/admin/api/services/{service_id}/end_user_plans/{id}.xml"=>{"get"=>{"summary"=>"End User Plan Read", "description"=>"End user plan read.", "operationId"=>"end_user_plan", "x-api-path-slug"=>"adminapiservicesservice-idend-user-plansid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the end user plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["End", "User", "Plan", "Read"]}, "put"=>{"summary"=>"End User Plan Update", "description"=>"End user plan update.", "operationId"=>"end_user_plan", "x-api-path-slug"=>"adminapiservicesservice-idend-user-plansid-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the end user plan"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the end user plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["End", "User", "Plan"]}}, "/admin/api/services/{service_id}/end_user_plans/{id}/default.xml"=>{"put"=>{"summary"=>"End User Plan set to Default", "description"=>"End user plan set to default.", "operationId"=>"end_user_plan", "x-api-path-slug"=>"adminapiservicesservice-idend-user-plansiddefault-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the end user plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["End", "User", "Plan", "Set", "To", "Default"]}}, "/admin/api/services/{service_id}/features.xml"=>{"get"=>{"summary"=>"Service Feature List", "description"=>"Service feature list.", "operationId"=>"service_feature", "x-api-path-slug"=>"adminapiservicesservice-idfeatures-xml-get", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Feature", "List"]}, "post"=>{"summary"=>"Service Feature Create", "description"=>"Service feature create.", "operationId"=>"service_feature", "x-api-path-slug"=>"adminapiservicesservice-idfeatures-xml-post", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"Name of the feature"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"scope", "description"=>"Type of plan that the feature will be available for"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}, {"in"=>"query", "name"=>"system_name", "description"=>"System Name of the object to be created"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Feature", "Create"]}}, "/admin/api/services/{service_id}/features/{id}.xml"=>{"delete"=>{"summary"=>"Service Feature Delete", "description"=>"Service feature delete.", "operationId"=>"service_feature", "x-api-path-slug"=>"adminapiservicesservice-idfeaturesid-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the feature"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Feature"]}, "get"=>{"summary"=>"Service Feature Read", "description"=>"Service feature read.", "operationId"=>"service_feature", "x-api-path-slug"=>"adminapiservicesservice-idfeaturesid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the feature"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Feature", "Read"]}, "put"=>{"summary"=>"Service Feature Update", "description"=>"Service feature update.", "operationId"=>"service_feature", "x-api-path-slug"=>"adminapiservicesservice-idfeaturesid-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the feature"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the feature"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Feature"]}}, "/admin/api/services/{service_id}/metrics.xml"=>{"get"=>{"summary"=>"Metric List", "description"=>"Metric list.", "operationId"=>"metric", "x-api-path-slug"=>"adminapiservicesservice-idmetrics-xml-get", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metric", "List"]}, "post"=>{"summary"=>"Metric Create", "description"=>"Metric create.", "operationId"=>"metric", "x-api-path-slug"=>"adminapiservicesservice-idmetrics-xml-post", "parameters"=>[{"in"=>"query", "name"=>"friendly_name", "description"=>"Descriptive Name of the metric"}, {"in"=>"query", "name"=>"name", "description"=>"DEPRECATED: Please use system_name parameter"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}, {"in"=>"query", "name"=>"system_name", "description"=>"System Name of the metric"}, {"in"=>"query", "name"=>"unit", "description"=>"Measure unit of the metric"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metric", "Create"]}}, "/admin/api/services/{service_id}/metrics/{id}.xml"=>{"delete"=>{"summary"=>"Metric Delete", "description"=>"Metric delete.", "operationId"=>"metric", "x-api-path-slug"=>"adminapiservicesservice-idmetricsid-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metric"]}, "get"=>{"summary"=>"Metric Read", "description"=>"Metric read.", "operationId"=>"metric", "x-api-path-slug"=>"adminapiservicesservice-idmetricsid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metric", "Read"]}, "put"=>{"summary"=>"Metric Update", "description"=>"Metric update.", "operationId"=>"metric", "x-api-path-slug"=>"adminapiservicesservice-idmetricsid-xml-put", "parameters"=>[{"in"=>"query", "name"=>"friendly_name", "description"=>"Name of the metric"}, {"in"=>"path", "name"=>"id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}, {"in"=>"query", "name"=>"unit", "description"=>"Measure unit of the metric"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metric"]}}, "/admin/api/services/{service_id}/metrics/{metric_id}/methods.xml"=>{"get"=>{"summary"=>"Method List", "description"=>"Method list.", "operationId"=>"metric_method", "x-api-path-slug"=>"adminapiservicesservice-idmetricsmetric-idmethods-xml-get", "parameters"=>[{"in"=>"path", "name"=>"metric_id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Method", "List"]}, "post"=>{"summary"=>"Method Create", "description"=>"Method create.", "operationId"=>"metric_method", "x-api-path-slug"=>"adminapiservicesservice-idmetricsmetric-idmethods-xml-post", "parameters"=>[{"in"=>"query", "name"=>"friendly_name", "description"=>"Name of the method"}, {"in"=>"path", "name"=>"metric_id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}, {"in"=>"query", "name"=>"system_name", "description"=>"System Name of the metric"}, {"in"=>"query", "name"=>"unit", "description"=>"Measure unit of the method"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Method", "Create"]}}, "/admin/api/services/{service_id}/metrics/{metric_id}/methods/{id}.xml"=>{"delete"=>{"summary"=>"Method Delete", "description"=>"Method delete.", "operationId"=>"metric_method", "x-api-path-slug"=>"adminapiservicesservice-idmetricsmetric-idmethodsid-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the method"}, {"in"=>"path", "name"=>"metric_id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Method"]}, "get"=>{"summary"=>"Method Read", "description"=>"Method read.", "operationId"=>"metric_method", "x-api-path-slug"=>"adminapiservicesservice-idmetricsmetric-idmethodsid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the method"}, {"in"=>"path", "name"=>"metric_id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Method", "Read"]}, "put"=>{"summary"=>"Method Update", "description"=>"Method update.", "operationId"=>"metric_method", "x-api-path-slug"=>"adminapiservicesservice-idmetricsmetric-idmethodsid-xml-put", "parameters"=>[{"in"=>"query", "name"=>"friendly_name", "description"=>"Name of the method"}, {"in"=>"path", "name"=>"id", "description"=>"id of the method"}, {"in"=>"path", "name"=>"metric_id", "description"=>"id of the metric"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}, {"in"=>"query", "name"=>"unit", "description"=>"Measure unit of the method"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Method"]}}, "/admin/api/services/{service_id}/service_plans/{id}.xml"=>{"delete"=>{"summary"=>"Service Plan Delete", "description"=>"Service plan delete.", "operationId"=>"service_plan", "x-api-path-slug"=>"adminapiservicesservice-idservice-plansid-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the service plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Plan"]}, "get"=>{"summary"=>"Service Plan Read", "description"=>"Service plan read.", "operationId"=>"service_plan", "x-api-path-slug"=>"adminapiservicesservice-idservice-plansid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the service plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Plan", "Read"]}, "put"=>{"summary"=>"Service Plan Update", "description"=>"Service plan update.", "operationId"=>"service_plan", "x-api-path-slug"=>"adminapiservicesservice-idservice-plansid-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the service plan"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the service plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Plan"]}}, "/admin/api/services/{service_id}/service_plans/{id}/default.xml"=>{"put"=>{"summary"=>"Service Plan set to Default", "description"=>"Service plan set to default.", "operationId"=>"service_plan", "x-api-path-slug"=>"adminapiservicesservice-idservice-plansiddefault-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the service plan"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_id", "description"=>"id of the service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Plan", "Set", "To", "Default"]}}, "/admin/api/service_plans.xml"=>{"get"=>{"summary"=>"Service Plan List (all services)", "description"=>"Service plan list (all services).", "operationId"=>"service_plan", "x-api-path-slug"=>"adminapiservice-plans-xml-get", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Plan", "List", "(all", "Services)"]}}, "/admin/api/service_plans/{service_plan_id}/features.xml"=>{"get"=>{"summary"=>"Service Plan Feature List", "description"=>"Service plan feature list.", "operationId"=>"service_plan_feature", "x-api-path-slug"=>"adminapiservice-plansservice-plan-idfeatures-xml-get", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_plan_id", "description"=>"id of the service plan"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Plan", "Feature", "List"]}, "post"=>{"summary"=>"Service Plan Feature Add", "description"=>"Service plan feature add.", "operationId"=>"service_plan_feature", "x-api-path-slug"=>"adminapiservice-plansservice-plan-idfeatures-xml-post", "parameters"=>[{"in"=>"query", "name"=>"feature_id", "description"=>"id of the feature"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"path", "name"=>"service_plan_id", "description"=>"id of the service plan"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Plan", "Feature"]}}, "/admin/api/signup.xml"=>{"post"=>{"summary"=>"Signup Express", "description"=>"Signup express.", "operationId"=>"signup", "x-api-path-slug"=>"adminapisignup-xml-post", "parameters"=>[{"in"=>"query", "name"=>"account_plan_id", "description"=>"id of the account plan (if not assigned default will be used instead)"}, {"in"=>"query", "name"=>"additional_fields", "description"=>"Additional fields have to be name and value i"}, {"in"=>"query", "name"=>"application_plan_id", "description"=>"id of the application plan (if not assigned default will be used instead)"}, {"in"=>"query", "name"=>"email", "description"=>"Email of the admin user"}, {"in"=>"query", "name"=>"org_name", "description"=>"Organization Name of the buyer account"}, {"in"=>"query", "name"=>"password", "description"=>"Password of the admin user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"service_plan_id", "description"=>"id of the service plan (if not assigned default will be used instead)"}, {"in"=>"query", "name"=>"username", "description"=>"Username of the admin user (on the new buyer account)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signup", "Express"]}}, "/admin/api/users.xml"=>{"get"=>{"summary"=>"User List (provider account)", "description"=>"User list (provider account).", "operationId"=>"user_provider_account", "x-api-path-slug"=>"adminapiusers-xml-get", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"role", "description"=>"Filter users by Role"}, {"in"=>"query", "name"=>"state", "description"=>"Filter users by State"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "List", "(provider", "Account)"]}, "post"=>{"summary"=>"User Create (provider account)", "description"=>"User create (provider account).", "operationId"=>"user_provider_account", "x-api-path-slug"=>"adminapiusers-xml-post", "parameters"=>[{"in"=>"query", "name"=>"additional_fields", "description"=>"Additional fields have to be name and value i"}, {"in"=>"query", "name"=>"email", "description"=>"Email of the user"}, {"in"=>"query", "name"=>"password", "description"=>"Password of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"username", "description"=>"Username of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "(provider", "Account)"]}}, "/admin/api/users/{id}.xml"=>{"delete"=>{"summary"=>"User Delete (provider account)", "description"=>"User delete (provider account).", "operationId"=>"user_provider_account", "x-api-path-slug"=>"adminapiusersid-xml-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "", "(provider", "Account)"]}, "get"=>{"summary"=>"User Read (provider account)", "description"=>"User read (provider account).", "operationId"=>"user_provider_account", "x-api-path-slug"=>"adminapiusersid-xml-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Read", "(provider", "Account)"]}, "put"=>{"summary"=>"User Update (provider account)", "description"=>"User update (provider account).", "operationId"=>"user_provider_account", "x-api-path-slug"=>"adminapiusersid-xml-put", "parameters"=>[{"in"=>"query", "name"=>"additional_fields", "description"=>"Additional fields have to be name and value i"}, {"in"=>"query", "name"=>"email", "description"=>"Email of the user"}, {"in"=>"path", "name"=>"id", "description"=>"id of the user"}, {"in"=>"query", "name"=>"password", "description"=>"Password of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"username", "description"=>"Username of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "", "(provider", "Account)"]}}, "/admin/api/users/{id}/activate.xml"=>{"put"=>{"summary"=>"User Activate (provider account)", "description"=>"User activate (provider account).", "operationId"=>"user_provider_account", "x-api-path-slug"=>"adminapiusersidactivate-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Activate", "(provider", "Account)"]}}, "/admin/api/users/{id}/admin.xml"=>{"put"=>{"summary"=>"User change Role to Admin (provider account)", "description"=>"User change role to admin (provider account).", "operationId"=>"user_provider_account", "x-api-path-slug"=>"adminapiusersidadmin-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Change", "Role", "To", "Admin", "(provider", "Account)"]}}, "/admin/api/users/{id}/member.xml"=>{"put"=>{"summary"=>"User change Role to Member (provider account)", "description"=>"User change role to member (provider account).", "operationId"=>"user_provider_account", "x-api-path-slug"=>"adminapiusersidmember-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Change", "Role", "To", "Member", "(provider", "Account)"]}}, "/admin/api/users/{id}/suspend.xml"=>{"put"=>{"summary"=>"User Suspend (provider account)", "description"=>"User suspend (provider account).", "operationId"=>"user_provider_account", "x-api-path-slug"=>"adminapiusersidsuspend-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Suspend", "(provider", "Account)"]}}, "/admin/api/users/{id}/unsuspend.xml"=>{"put"=>{"summary"=>"User Unsuspend (of provider account)", "description"=>"User unsuspend (of provider account).", "operationId"=>"user_provider_account", "x-api-path-slug"=>"adminapiusersidunsuspend-xml-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id of the user"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Unsuspend", "(of", "Provider", "Account)"]}}, "/admin/api/webhooks/failures.xml"=>{"delete"=>{"summary"=>"Webhooks Delete Failed Deliveries", "description"=>"Webhooks delete failed deliveries.", "operationId"=>"webhooks", "x-api-path-slug"=>"adminapiwebhooksfailures-xml-delete", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"time", "description"=>"Only failed webhook deliveries whose time is less or equal than the passed time are destroyed (if used)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "", "Failed", "Deliveries"]}, "get"=>{"summary"=>"Webhooks List Failed Deliveries", "description"=>"Webhooks list failed deliveries.", "operationId"=>"webhooks", "x-api-path-slug"=>"adminapiwebhooksfailures-xml-get", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "List", "Failed", "Deliveries"]}}}}, "3scale-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"3scale", "x-complete"=>1, "info"=>{"title"=>"Charcoal API", "description"=>"this-project-serves-as-the-jsonrest-api-consumed-by-clients-of-the-charcoal-platform-the-api-itself-relies-heavily-on-userclient-authentication-where-every-request-needs-to-have-the-appropriate-information-to-attribute-it-to-a-client-and-requests-acting-on-behalf-of-a-user-e-g-updating-their-email-needs-to-have-a-userclient-token-created-by-the-user-to-authorize-that-client-to-communicate-for-them-some-endpoints-are-completely-restricted-to-admin-only-which-means-only-users-mapped-to-the-admin-role-who-are-communicating-with-a-system-client-may-continue-", "version"=>"1.0"}, "host"=>"http:", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"//"=>{"get"=>{"summary"=>"Current User", "description"=>"Once a user has authorized a client to communicate on their behalf (via the `auth/authorize` endpoint), the client can use the generated token in their `x-client-bearer-token` header to retreive the user's information from this endpoint.", "operationId"=>"UnnammedEndpointGet", "x-api-path-slug"=>"get", "parameters"=>[{"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{1=>{"description"=>"Brand not found - Unable to find the given brand ID"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}, 200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/auth/tokens"=>{"get"=>{"summary"=>"Available Tokens", "description"=>"In order for a given client to retreive a list of tokens that users have created for the client to communicate with, they can send a request (with the `x-client-auth` header set appropriately) to this endpoint.", "operationId"=>"AuthTokensByHostnameGet", "x-api-path-slug"=>"hostnameauthtokens-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/auth/roles"=>{"get"=>{"summary"=>"Current Roles", "description"=>"", "operationId"=>"AuthRolesByHostnameGet", "x-api-path-slug"=>"hostnameauthroles-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/oauth/google/prompt"=>{"get"=>{"summary"=>"Google Prompt", "description"=>"This endpoint should be used by clients looking to authenticate users with the CAAP api through google.\n\nThe route requires a `client_id` query parameter and will redirect the user to the google oauth flow. Once the user has authenticated with google, caap will handle creating the user record and will redirect the user to the `redirect_uri` associated with the client who initiated the request.\n\nThe `redirect_uri` will receive `token` query parameter, which the client should use to then communicate with the api.", "operationId"=>"OauthGooglePromptByHostnameGet", "x-api-path-slug"=>"hostnameoauthgoogleprompt-get", "parameters"=>[{"in"=>"query", "name"=>"client_id"}, {"in"=>"path", "name"=>"hostname"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/oauth/google/auth"=>{"get"=>{"summary"=>"Google Callback", "description"=>"This endpoint should never be accessed directly by clients, it is only ever used during the google oauth process during oauth.", "operationId"=>"OauthGoogleAuthByHostnameGet", "x-api-path-slug"=>"hostnameoauthgoogleauth-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/auth"=>{"post"=>{"summary"=>"Password Login (System Clients Only)", "description"=>"Once a user has authorized a client to communicate on their behalf (via the `auth/authorize` endpoint), the client can use the generated token in their `x-client-bearer-token` header to retreive the user's information from this endpoint.", "operationId"=>"AuthByHostnamePost", "x-api-path-slug"=>"hostnameauth-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/client-admins"=>{"get"=>{"summary"=>"GET client admins", "description"=>"This endpoint is used to access the user-client mappings that represent a user's ability to edit client information.\n\nUnless the user is a system admin, this list will be filtered by the current client in order to prevent clients from accessing other client's information.", "operationId"=>"ClientAdminsByHostnameGet", "x-api-path-slug"=>"hostnameclientadmins-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"POST client admin", "description"=>"Allows users to add another user to the client's list of admins. It is assumed that when posting to this route that the current client (based on `x-client-auth`) is the client of which the user is adding a client admin.\n\n(unless the user is a system admin)", "operationId"=>"ClientAdminsByHostnamePost", "x-api-path-slug"=>"hostnameclientadmins-post", "parameters"=>[{"in"=>"formData", "name"=>"client"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"formData", "name"=>"user"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/client-admins/5"=>{"delete"=>{"summary"=>"DELETE client admin", "description"=>"Allows users to delete a mapping from user to client that represents the user being a client admin.", "operationId"=>"ClientAdmins5ByHostnameDelete", "x-api-path-slug"=>"hostnameclientadmins5-delete", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"formData", "name"=>"user"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/clients"=>{"get"=>{"summary"=>"GET clients", "description"=>"", "operationId"=>"ClientsByHostnameGet", "x-api-path-slug"=>"hostnameclients-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"POST client", "description"=>"", "operationId"=>"ClientsByHostnamePost", "x-api-path-slug"=>"hostnameclients-post", "parameters"=>[{"in"=>"formData", "name"=>"description"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"formData", "name"=>"name"}, {"in"=>"formData", "name"=>"redirect_uri"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/clients/2"=>{"patch"=>{"summary"=>"UPDATE client", "description"=>"", "operationId"=>"Clients2ByHostnamePatch", "x-api-path-slug"=>"hostnameclients2-patch", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/client-tokens"=>{"get"=>{"summary"=>"GET client tokens (admin only)", "description"=>"", "operationId"=>"ClientTokensByHostnameGet", "x-api-path-slug"=>"hostnameclienttokens-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"POST client token (admin only)", "description"=>"", "operationId"=>"ClientTokensByHostnamePost", "x-api-path-slug"=>"hostnameclienttokens-post", "parameters"=>[{"in"=>"formData", "name"=>"client"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/games"=>{"get"=>{"summary"=>"Find Games", "description"=>"", "operationId"=>"GamesByHostnameGet", "x-api-path-slug"=>"hostnamegames-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"Create Game", "description"=>"", "operationId"=>"GamesByHostnamePost", "x-api-path-slug"=>"hostnamegames-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/games/2"=>{"patch"=>{"summary"=>"End Game", "description"=>"", "operationId"=>"Games2ByHostnamePatch2", "x-api-path-slug"=>"hostnamegames2-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/games/3"=>{"delete"=>{"summary"=>"Delete Game", "description"=>"", "operationId"=>"Games3ByHostnameDelete", "x-api-path-slug"=>"hostnamegames3-delete", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/game-rounds"=>{"get"=>{"summary"=>"Find Game Rounds", "description"=>"", "operationId"=>"GameRoundsByHostnameGet", "x-api-path-slug"=>"hostnamegamerounds-get", "parameters"=>[{"in"=>"query", "name"=>"filter[game_id]"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"Create Game Round", "description"=>"", "operationId"=>"GameRoundsByHostnamePost", "x-api-path-slug"=>"hostnamegamerounds-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/game-rounds/1"=>{"patch"=>{"summary"=>"Update Game Round", "description"=>"This endpoint is used to access the user-client mappings that represent a user's ability to edit client information.\n\nUnless the user is a system admin, this list will be filtered by the current client in order to prevent clients from accessing other client's information.", "operationId"=>"GameRounds1ByHostnamePatch", "x-api-path-slug"=>"hostnamegamerounds1-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/game-rounds/13"=>{"delete"=>{"summary"=>"Delete game Round", "description"=>"This endpoint is used to access the user-client mappings that represent a user's ability to edit client information.\n\nUnless the user is a system admin, this list will be filtered by the current client in order to prevent clients from accessing other client's information.", "operationId"=>"GameRounds13ByHostnameDelete", "x-api-path-slug"=>"hostnamegamerounds13-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/game-memberships"=>{"get"=>{"summary"=>"Find Game Memberships", "description"=>"", "operationId"=>"GameMembershipsByHostnameGet", "x-api-path-slug"=>"hostnamegamememberships-get", "parameters"=>[{"in"=>"query", "name"=>"filter[game_id]"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"Create Game Membership", "description"=>"", "operationId"=>"GameMembershipsByHostnamePost", "x-api-path-slug"=>"hostnamegamememberships-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/game-memberships/4"=>{"patch"=>{"summary"=>"Update Game Membership", "description"=>"", "operationId"=>"GameMemberships4ByHostnamePatch", "x-api-path-slug"=>"hostnamegamememberships4-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/game-memberships/3"=>{"delete"=>{"summary"=>"Delete Game Membership", "description"=>"", "operationId"=>"GameMemberships3ByHostnameDelete", "x-api-path-slug"=>"hostnamegamememberships3-delete", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/game-membership-history"=>{"get"=>{"summary"=>"Game Membership History", "description"=>"", "operationId"=>"GameMembershipHistoryByHostnameGet", "x-api-path-slug"=>"hostnamegamemembershiphistory-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/callbacks/mailgun"=>{"post"=>{"summary"=>"POST callbacks/mailgun BAD", "description"=>"", "operationId"=>"CallbacksMailgunByHostnamePost4", "x-api-path-slug"=>"hostnamecallbacksmailgun-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"formData", "name"=>"message-url"}, {"in"=>"query", "name"=>"secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/photos"=>{"get"=>{"summary"=>"GET photos", "description"=>"", "operationId"=>"PhotosByHostnameGet", "x-api-path-slug"=>"hostnamephotos-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"POST photos", "description"=>"", "operationId"=>"PhotosByHostnamePost", "x-api-path-slug"=>"hostnamephotos-post", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"formData", "name"=>"label"}, {"in"=>"formData", "name"=>"photo"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/photos/11"=>{"delete"=>{"summary"=>"DELETE photos", "description"=>"", "operationId"=>"Photos11ByHostnameDelete", "x-api-path-slug"=>"hostnamephotos11-delete", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//local.api.caap.oiq.io:8080/photos"=>{"post"=>{"summary"=>"POST photos (client-only)", "description"=>"", "operationId"=>"LocalApiCaapOiqIo8080PhotosPost", "x-api-path-slug"=>"local-api-caap-oiq-io8080photos-post", "parameters"=>[{"in"=>"formData", "name"=>"label"}, {"in"=>"formData", "name"=>"photo"}, {"in"=>"header", "name"=>"x-client-auth"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/photos/1/view"=>{"get"=>{"summary"=>"GET photo view", "description"=>"", "operationId"=>"Photos1ViewByHostnameGet", "x-api-path-slug"=>"hostnamephotos1view-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/socket/"=>{"get"=>{"summary"=>"http://{{hostname}}/socket", "description"=>"", "operationId"=>"SocketByHostnameGet", "x-api-path-slug"=>"hostnamesocket-get", "parameters"=>[{"in"=>"header", "name"=>"Connection"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"Sec-Websocket-Key"}, {"in"=>"header", "name"=>"Sec-Websocket-Version"}, {"in"=>"header", "name"=>"Upgrade"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/system"=>{"get"=>{"summary"=>"GET system", "description"=>"", "operationId"=>"SystemByHostnameGet", "x-api-path-slug"=>"hostnamesystem-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "patch"=>{"summary"=>"UPDATE system (admin only)", "description"=>"", "operationId"=>"SystemByHostnamePatch", "x-api-path-slug"=>"hostnamesystem-patch", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"formData", "name"=>"restricted_email_domains"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/system/domains"=>{"get"=>{"summary"=>"GET system email domains (admin only)", "description"=>"", "operationId"=>"SystemDomainsByHostnameGet", "x-api-path-slug"=>"hostnamesystemdomains-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"POST system email domain (admin only)", "description"=>"", "operationId"=>"SystemDomainsByHostnamePost", "x-api-path-slug"=>"hostnamesystemdomains-post", "parameters"=>[{"in"=>"formData", "name"=>"domain"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/system/domains/2"=>{"delete"=>{"summary"=>"DELETE system email domain (admin only)", "description"=>"", "operationId"=>"SystemDomains2ByHostnameDelete", "x-api-path-slug"=>"hostnamesystemdomains2-delete", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/activity"=>{"get"=>{"summary"=>"GET activity", "description"=>"", "operationId"=>"ActivityByHostnameGet", "x-api-path-slug"=>"hostnameactivity-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"query", "name"=>"limit"}, {"in"=>"header", "name"=>"x-client-auth"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/display-schedules"=>{"get"=>{"summary"=>"GET display-schedules", "description"=>"", "operationId"=>"DisplaySchedulesByHostnameGet", "x-api-path-slug"=>"hostnamedisplayschedules-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/display-schedules/1"=>{"patch"=>{"summary"=>"PATCH display-schedule", "description"=>"", "operationId"=>"DisplaySchedules1ByHostnamePatch", "x-api-path-slug"=>"hostnamedisplayschedules1-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/activity/live"=>{"get"=>{"summary"=>"GET feed", "description"=>"", "operationId"=>"ActivityLiveByHostnameGet", "x-api-path-slug"=>"hostnameactivitylive-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/users"=>{"get"=>{"summary"=>"GET users", "description"=>"", "operationId"=>"UsersByHostnameGet", "x-api-path-slug"=>"hostnameusers-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"POST users", "description"=>"", "operationId"=>"UsersByHostnamePost", "x-api-path-slug"=>"hostnameusers-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"content-type"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/users/1"=>{"patch"=>{"summary"=>"PATCH users", "description"=>"", "operationId"=>"Users1ByHostnamePatch", "x-api-path-slug"=>"hostnameusers1-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/user-roles"=>{"get"=>{"summary"=>"GET user roles", "description"=>"", "operationId"=>"UserRolesByHostnameGet", "x-api-path-slug"=>"hostnameuserroles-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/google-accounts"=>{"get"=>{"summary"=>"GET google-accounts", "description"=>"", "operationId"=>"GoogleAccountsByHostnameGet", "x-api-path-slug"=>"hostnamegoogleaccounts-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/user-role-mappings"=>{"get"=>{"summary"=>"GET user-role-mappings", "description"=>"", "operationId"=>"UserRoleMappingsByHostnameGet", "x-api-path-slug"=>"hostnameuserrolemappings-get", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "post"=>{"summary"=>"POST user-role-mappings (admin only)", "description"=>"", "operationId"=>"UserRoleMappingsByHostnamePost", "x-api-path-slug"=>"hostnameuserrolemappings-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"hostname"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "//{hostname}/user-role-mappings/3"=>{"delete"=>{"summary"=>"DELETE user-role-mapping (admin only)", "description"=>"", "operationId"=>"UserRoleMappings3ByHostnameDelete", "x-api-path-slug"=>"hostnameuserrolemappings3-delete", "parameters"=>[{"in"=>"path", "name"=>"hostname"}, {"in"=>"formData", "name"=>"role"}, {"in"=>"formData", "name"=>"user"}, {"in"=>"header", "name"=>"x-client-auth"}, {"in"=>"header", "name"=>"x-client-bearer-token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"3scale", "x-slug"=>"3scale", "description"=>"3scales API Management platform gives you the tools you need to take control of your API. Trusted by more customers than any other vendor.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/4-3scale.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"333433", "tags"=>"API Service Provider,Enterprise,Imports,Management,Management,My API Stack,Portals,Profiles,SaaS,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"3scale/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"3scale", "x-api-slug"=>"3scale", "description"=>"3scales API Management platform gives you the tools you need to take control of your API. Trusted by more customers than any other vendor.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/4-3scale.jpg", "humanURL"=>"http://3scale.net", "baseURL"=>"https://http://", "tags"=>"API Service Provider,Enterprise,Imports,Management,Management,My API Stack,Portals,Profiles,SaaS,Stack Network,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/3scale/3scale-openapi.yaml"}]}, {"name"=>"3Scale Account Management API", "x-api-slug"=>"3scale-account-management-api", "description"=>"3scales API Management platform gives you the tools you need to take control of your API. Trusted by more customers than any other vendor.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/4-3scale.jpg", "humanURL"=>"http://3scale.net", "baseURL"=>"https://su1.3scale.net//", "tags"=>nil, "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/3scale/3scale-account-management-api-openapi.yaml"}]}, {"name"=>"3Scale Analytics API", "x-api-slug"=>"3scale-analytics-api", "description"=>"3scales API Management platform gives you the tools you need to take control of your API. Trusted by more customers than any other vendor.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/4-3scale.jpg", "humanURL"=>"http://3scale.net", "baseURL"=>"https://su1.3scale.net//", "tags"=>"Webhooks,List,Failed,Deliveries", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/3scale/statsservicesservice-idusage-format-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/3scale/3scale-analytics-api-openapi.yaml"}]}, {"name"=>"3Scale Billing API", "x-api-slug"=>"3scale-billing-api", "description"=>"3scales API Management platform gives you the tools you need to take control of your API. Trusted by more customers than any other vendor.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/4-3scale.jpg", "humanURL"=>"http://3scale.net", "baseURL"=>"https://su1.3scale.net//", "tags"=>"Service,Usage,By,Metric", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/3scale/apiinvoicesinvoice-idpayment-transactions-xml-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/3scale/3scale-billing-api-openapi.yaml"}]}, {"name"=>"3scale Service Management API", "x-api-slug"=>"3scale-service-management-api", "description"=>"3scales API Management platform gives you the tools you need to take control of your API. Trusted by more customers than any other vendor.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/4-3scale.jpg", "humanURL"=>"http://3scale.net", "baseURL"=>"https://su1.3scale.net//", "tags"=>"Invoice,Payment,Transactions,List", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/3scale/transactionsoauth-authorize-xml-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/3scale/3scale-service-management-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://www.3scale.net/blog/"}, {"type"=>"x-blog-rss", "url"=>"http://www.3scale.net/feed/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/3scale"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/3scale"}, {"type"=>"x-email", "url"=>"sales@3scale.net"}, {"type"=>"x-email", "url"=>"info@3scale.net"}, {"type"=>"x-github", "url"=>"https://github.com/3scale"}, {"type"=>"x-pricing", "url"=>"https://www.3scale.net/pricing/"}, {"type"=>"x-privacy", "url"=>"https://www.3scale.net/privacy-policy/"}, {"type"=>"x-support", "url"=>"https://support.3scale.net"}, {"type"=>"x-openapi-spec", "url"=>"https://support.3scale.net/reference/active-docs"}, {"type"=>"x-terms-of-service", "url"=>"https://www.3scale.net/terms-and-conditions/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/3scale"}, {"type"=>"x-website", "url"=>"http://3scale.net"}, {"type"=>"x-website", "url"=>"http://"}, {"type"=>"x-website", "url"=>"http://http"}, {"type"=>"x-website", "url"=>"http://www.3scale.net"}, {"type"=>"x-website", "url"=>"://"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "3scale-service-management-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"3scale", "x-complete"=>1, "info"=>{"title"=>"3scale Service Management API", "description"=>"the-api-for-managing-3scale-services-", "termsOfService"=>"http://www.3scale.net/terms-and-conditions/", "contact"=>{"name"=>"3Scale", "url"=>"https://support.3scale.net/"}, "version"=>"1"}, "host"=>"su1.3scale.net", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/transactions.xml"=>{"post"=>{"summary"=>"Report (App Id authentication pattern)", "description"=>"Report (app id authentication pattern).", "operationId"=>"report", "x-api-path-slug"=>"transactions-xml-post", "parameters"=>[{"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"service_id", "description"=>"Service id"}, {"in"=>"query", "name"=>"transactions", "description"=>"Transactions to be reported"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Xml"]}}, "/transactions/authorize.xml"=>{"get"=>{"summary"=>"Authorize (App Id authentication pattern)", "description"=>"Authorize (app id authentication pattern).", "operationId"=>"authorize", "x-api-path-slug"=>"transactionsauthorize-xml-get", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"App Id (identifier of the application if the auth"}, {"in"=>"query", "name"=>"app_key", "description"=>"App Key (shared secret of the application if the authentication pattern is App Id)"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"referrer", "description"=>"Referrer IP Address or Domain"}, {"in"=>"query", "name"=>"service_id", "description"=>"Service id"}, {"in"=>"query", "name"=>"usage", "description"=>"Predicted Usage"}, {"in"=>"query", "name"=>"user_id", "description"=>"User id"}, {"in"=>"query", "name"=>"user_key", "description"=>"User Key (identifier and shared secret of the application if the auth"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Authorize", "Xml"]}}, "/transactions/authrep.xml"=>{"get"=>{"summary"=>"AuthRep (Authorize + Report for the App Id authentication pattern)", "description"=>"Authrep (authorize + report for the app id authentication pattern).", "operationId"=>"authrep", "x-api-path-slug"=>"transactionsauthrep-xml-get", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"App Id (identifier of the application if the auth"}, {"in"=>"query", "name"=>"app_key", "description"=>"App Key (shared secret of the application if the authentication pattern is App Id)"}, {"in"=>"query", "name"=>"log", "description"=>"Request Log allows to log the requests/responses/status_codes of your API back to 3scale to maintain a log of the latest activity on your API"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"referrer", "description"=>"Referrer IP Address or Domain"}, {"in"=>"query", "name"=>"service_id", "description"=>"Service id"}, {"in"=>"query", "name"=>"usage", "description"=>"Usage will increment the metrics with the values passed"}, {"in"=>"query", "name"=>"user_id", "description"=>"User id"}, {"in"=>"query", "name"=>"user_key", "description"=>"User Key (identifier and shared secret of the application if the auth"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Authrep", "Xml"]}}, "/transactions/oauth_authorize.xml"=>{"get"=>{"summary"=>"Authorize (Oauth authentication mode pattern)", "description"=>"Authorize (oauth authentication mode pattern).", "operationId"=>"authorize", "x-api-path-slug"=>"transactionsoauth-authorize-xml-get", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"Client Id (identifier of the application if the auth"}, {"in"=>"query", "name"=>"provider_key", "description"=>"Your api key with 3scale (also known as provider key)"}, {"in"=>"query", "name"=>"redirect_url", "description"=>"Optional redirect URL for OAuth"}, {"in"=>"query", "name"=>"referrer", "description"=>"Referrer IP Address or Domain"}, {"in"=>"query", "name"=>"service_id", "description"=>"Service id"}, {"in"=>"query", "name"=>"usage", "description"=>"Predicted Usage"}, {"in"=>"query", "name"=>"user_id", "description"=>"User id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Oauth", "Authorize", "Xml"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
polygon{"pointinpolygon-census-intersection-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Polygon", "x-complete"=>1, "info"=>{"title"=>"Polygon", "description"=>"the-future-of-fintech-", "version"=>"1.0.0"}, "host"=>"api.polygon.io", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/companies"=>{"get"=>{"summary"=>"Available Companies", "description"=>"Get a list of the traded companies that polygon.io streams. Company includes some details about the company which we hope to add more to soon.", "operationId"=>"v1.companies.get", "x-api-path-slug"=>"v1companies-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Which page of results to return"}, {"in"=>"query", "name"=>"perpage", "description"=>"How many items to be on each page during pagination"}, {"in"=>"query", "name"=>"sort", "description"=>"Which field to sort by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/currencies"=>{"get"=>{"summary"=>"Available Currencies", "description"=>"Get a list of the currencies that polygon.io streams.", "operationId"=>"v1.currencies.get", "x-api-path-slug"=>"v1currencies-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/historic/agg/{size}/{symbol}/{date}"=>{"get"=>{"summary"=>"Historic Aggregates", "description"=>"Get historic aggregations for a symbol.", "operationId"=>"v1.historic.agg.size.symbol.date.get", "x-api-path-slug"=>"v1historicaggsizesymboldate-get", "parameters"=>[{"in"=>"path", "name"=>"date", "description"=>"Date/Day of the historic ticks to retreive"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit the size of response, max: 10000"}, {"in"=>"query", "name"=>"offset", "description"=>"Timestamp offset, used for pagination"}, {"in"=>"path", "name"=>"size", "description"=>"Size of the aggregation"}, {"in"=>"path", "name"=>"symbol", "description"=>"Symbol of the company to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/historic/forex/{from}/{to}/{date}"=>{"get"=>{"summary"=>"Historic Forex Ticks", "description"=>"Get historic ticks for a currency pair. Example for **USD/JPY** the from would be **USD** and to would be **JPY**. The date formatted like **2017-6-22**", "operationId"=>"v1.historic.forex.from.to.date.get", "x-api-path-slug"=>"v1historicforexfromtodate-get", "parameters"=>[{"in"=>"path", "name"=>"date", "description"=>"Date/Day of the historic ticks to retreive"}, {"in"=>"path", "name"=>"from", "description"=>"From Symbol of the currency pair"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit the size of response, max: 10000"}, {"in"=>"query", "name"=>"offset", "description"=>"Timestamp offset, used for pagination"}, {"in"=>"path", "name"=>"to", "description"=>"To Symbol of the currency pair"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/historic/quotes/{symbol}/{date}"=>{"get"=>{"summary"=>"Historic Quotes", "description"=>"Get historic quotes for a symbol.", "operationId"=>"v1.historic.quotes.symbol.date.get", "x-api-path-slug"=>"v1historicquotessymboldate-get", "parameters"=>[{"in"=>"path", "name"=>"date", "description"=>"Date/Day of the historic ticks to retreive"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit the size of response, max: 10000"}, {"in"=>"query", "name"=>"offset", "description"=>"Timestamp offset, used for pagination"}, {"in"=>"path", "name"=>"symbol", "description"=>"Symbol of the company to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/historic/trades/{symbol}/{date}"=>{"get"=>{"summary"=>"Historic Trades", "description"=>"Get historic trades for a symbol.", "operationId"=>"v1.historic.trades.symbol.date.get", "x-api-path-slug"=>"v1historictradessymboldate-get", "parameters"=>[{"in"=>"path", "name"=>"date", "description"=>"Date/Day of the historic ticks to retreive"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit the size of response, max: 10000"}, {"in"=>"query", "name"=>"offset", "description"=>"Timestamp offset, used for pagination"}, {"in"=>"path", "name"=>"symbol", "description"=>"Symbol of the company to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/last/currencies/{from}/{to}"=>{"get"=>{"summary"=>"Last Trade for a Currency Pair", "description"=>"Get Last Trade Tick for a Currency Pair.", "operationId"=>"v1.last.currencies.from.to.get", "x-api-path-slug"=>"v1lastcurrenciesfromto-get", "parameters"=>[{"in"=>"path", "name"=>"from", "description"=>"From Symbol of the pair"}, {"in"=>"path", "name"=>"to", "description"=>"To Symbol of the pair"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/last/stocks/{symbol}"=>{"get"=>{"summary"=>"Last Trade for a Symbol", "description"=>"Get the last trade for a given stock.", "operationId"=>"v1.last.stocks.symbol.get", "x-api-path-slug"=>"v1laststockssymbol-get", "parameters"=>[{"in"=>"path", "name"=>"symbol", "description"=>"Symbol of the stock to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/last_quote/currencies/{from}/{to}"=>{"get"=>{"summary"=>"Last Quote for a Currency Pair", "description"=>"Get Last Quote Tick for a Currency Pair.", "operationId"=>"v1.last_quote.currencies.from.to.get", "x-api-path-slug"=>"v1last-quotecurrenciesfromto-get", "parameters"=>[{"in"=>"path", "name"=>"from", "description"=>"From Symbol of the pair"}, {"in"=>"path", "name"=>"to", "description"=>"To Symbol of the pair"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/last_quote/stocks/{symbol}"=>{"get"=>{"summary"=>"Last Quote for a Symbol", "description"=>"Get the last quote tick for a given stock.", "operationId"=>"v1.last_quote.stocks.symbol.get", "x-api-path-slug"=>"v1last-quotestockssymbol-get", "parameters"=>[{"in"=>"path", "name"=>"symbol", "description"=>"Symbol of the stock to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"Polygon", "x-slug"=>"polygon", "description"=>"Polygon.io offers streaming realtime data for stocks/equities, ETFs, Indecies and Forex/Currencies including crypto currencies. Our Real-Time Stock Data APIs help you build the future on fintech.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/polygon-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"2931123", "tags"=>"Financial,General Data,Market Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"polygon/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Point-In-Polygon Census Intersection", "x-api-slug"=>"pointinpolygon-census-intersection", "description"=>"Polygon.io offers streaming realtime data for stocks/equities, ETFs, Indecies and Forex/Currencies including crypto currencies. Our Real-Time Stock Data APIs help you build the future on fintech.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/polygon-logo.png", "humanURL"=>"http://polygon.io", "baseURL"=>"https://api.polygon.io//", "tags"=>"Financial,General Data,Market Data,Service API", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/polygon/v1last-quotestockssymbol-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/polygon/pointinpolygon-census-intersection-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://polygon.io/blog/"}, {"type"=>"x-blog-rss", "url"=>"https://polygon.io/blog/rss/"}, {"type"=>"x-documentation", "url"=>"https://polygon.io/docs/#getting-started"}, {"type"=>"x-github", "url"=>"https://github.com/polygon-io"}, {"type"=>"x-selfservice-registration", "url"=>"https://polygon.io/signup"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/polygon_io"}, {"type"=>"x-website", "url"=>"http://polygon.io"}, {"type"=>"x-website", "url"=>"https://polygon.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
telapi{"hetras-hotel-api-version-0-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"TelAPI", "x-complete"=>1, "info"=>{"title"=>"hetras Hotel API Version 0", "version"=>"v0"}, "host"=>"api.hetras-certification.net", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/hotel/v0/hotels"=>{"get"=>{"summary"=>"Get a list of all the hotels of a chain your application has access to.", "description"=>"Get a list of all the hotels of a chain your application has access to..", "operationId"=>"Hotels_GetHotels", "x-api-path-slug"=>"apihotelv0hotels-get", "parameters"=>[{"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["", "Hotels", "Of", "Chain", "Your", "Application", "Has", "Access", "To"]}}, "/api/hotel/v0/hotels/{hotelId}"=>{"get"=>{"summary"=>"Get the details of the hotel with the speccified hotel id.", "description"=>"Get the details of the hotel with the speccified hotel id..", "operationId"=>"Hotels_GetHotel", "x-api-path-slug"=>"apihotelv0hotelshotelid-get", "parameters"=>[{"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"path", "name"=>"hotelId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Details", "Of", "Hotel", "Speccified", "Hotel", "Id"]}}, "/api/hotel/v0/hotels/{hotelId}/codes"=>{"get"=>{"summary"=>"Get a list of codes for the specified hotel either filtered by type or code.", "description"=>"With this call you can find codes for a hotel by type or code. By default and without any filter criteria\r\n defined it will return you all available codes.", "operationId"=>"Codes_GetCodes", "x-api-path-slug"=>"apihotelv0hotelshotelidcodes-get", "parameters"=>[{"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"query", "name"=>"code", "description"=>"Return all codes matching the code"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel id you are trying to find codes for"}, {"in"=>"query", "name"=>"type", "description"=>"Return all codes available for the specified type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Codesthe", "Specified", "Hotel", "Either", "Filtered", "By", "Type", "Code"]}}, "/api/hotel/v0/hotels/{hotelId}/codes/{id}"=>{"get"=>{"summary"=>"Get all the details for a specific code available for the hotel.", "description"=>"Read the details about a specific code available for the defined hotel.", "operationId"=>"Codes_GetCode", "x-api-path-slug"=>"apihotelv0hotelshotelidcodesid-get", "parameters"=>[{"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel id the code available for"}, {"in"=>"path", "name"=>"id", "description"=>"The code identifier you want to see details for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Detailsa", "Specific", "Code", "Availablethe", "Hotel"]}}, "/api/hotel/v0/hotels/{hotelId}/rateplans"=>{"get"=>{"summary"=>"Get a list of rateplans for the specified hotel id matching the filter criteria.", "description"=>"With this call you can find rateplans for a hotel by different filters. By default and without any filter criteria\r\n defined it will return you all active rateplans.", "operationId"=>"RatePlans_GetRateplans", "x-api-path-slug"=>"apihotelv0hotelshotelidrateplans-get", "parameters"=>[{"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"query", "name"=>"baseRateplan", "description"=>"Return all rateplans having the specified rateplan as base rateplan"}, {"in"=>"query", "name"=>"channelCode", "description"=>"Return all rateplans sold through the specified channel"}, {"in"=>"query", "name"=>"channelGroup", "description"=>"Return all rateplans that are sold through at least one channel out of the specified channel group"}, {"in"=>"query", "name"=>"commissionable", "description"=>"Return all rateplans having commisionable status"}, {"in"=>"query", "name"=>"group", "description"=>"Return all rateplans belonging to the specified rateplan group"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel id you are trying to find rateplans for"}, {"in"=>"query", "name"=>"includedServices", "description"=>"Return all rateplans having at least one of the specified services included"}, {"in"=>"query", "name"=>"inlinecount", "description"=>"Return total number of items for a given filter criteria"}, {"in"=>"query", "name"=>"marketCodes", "description"=>"Return all rateplans having one of the specified values as a market code"}, {"in"=>"query", "name"=>"roomTypes", "description"=>"Return all rateplans by which at least one of the specified room types are sold"}, {"in"=>"query", "name"=>"sellingStatus", "description"=>"Specify which rateplans to return"}, {"in"=>"query", "name"=>"skip", "description"=>"Amount of items to skip"}, {"in"=>"query", "name"=>"top", "description"=>"Amount of items to select"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rateplansthe", "Specified", "Hotel", "Id", "Matching", "Filter", "Criteria"]}}, "/api/hotel/v0/hotels/{hotelId}/rateplans/$count"=>{"get"=>{"summary"=>"Get the count of all rateplans in the hotel matching the given filter criteria.", "description"=>"Get the count of all rateplans in the hotel matching the given filter criteria..", "operationId"=>"RatePlans_GetRateplansCount", "x-api-path-slug"=>"apihotelv0hotelshotelidrateplanscount-get", "parameters"=>[{"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"query", "name"=>"baseRateplan", "description"=>"Return all rateplans having the specified rateplan as base rateplan"}, {"in"=>"query", "name"=>"channelCode", "description"=>"Return all rateplans sold through the specified channel"}, {"in"=>"query", "name"=>"channelGroup", "description"=>"Return all rateplans that are sold through at least one channel out of the specified channel group"}, {"in"=>"query", "name"=>"commissionable", "description"=>"Return all rateplans having commisionable status"}, {"in"=>"query", "name"=>"group", "description"=>"Return all rateplans belonging to the specified rateplan group"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel you are counting the rateplans for"}, {"in"=>"query", "name"=>"includedServices", "description"=>"Return all rateplans having at least one of the specified services included"}, {"in"=>"query", "name"=>"marketCodes", "description"=>"Return all rateplans having one of the specified values as a market code"}, {"in"=>"query", "name"=>"roomTypes", "description"=>"Return all rateplans by which at least one of the specified room types are sold"}, {"in"=>"query", "name"=>"sellingStatus", "description"=>"Specify which rateplans to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Count", "Of", "", "Rateplans", "In", "Hotel", "Matching", "Given", "Filter", "Criteria"]}}, "/api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}"=>{"get"=>{"summary"=>"Get all the details for a specific rateplan in the hotel.", "description"=>"Read the details about a specific rateplan for the defined hotel.", "operationId"=>"RatePlans_GetRateplan", "x-api-path-slug"=>"apihotelv0hotelshotelidrateplansrateplancode-get", "parameters"=>[{"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel id the rateplan belongs to"}, {"in"=>"path", "name"=>"rateplanCode", "description"=>"The code of the rateplan you want to see details for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Detailsa", "Specific", "Rateplan", "In", "Hotel"]}}, "/api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}/rates"=>{"get"=>{"summary"=>"Get the setup of the daily rates for a specific rateplan and a defined timeperiod.", "description"=>"With this call you can read the daily rates setup including the cancellation policy and minimum guarantee per day for the\r\n specified rateplan. You can specify a timeperiod to read the daily rates for. The rateplan needs to be active for at least\r\n one business day in the defined time period and have rates loaded.", "operationId"=>"RatePlans_GetRates", "x-api-path-slug"=>"apihotelv0hotelshotelidrateplansrateplancoderates-get", "parameters"=>[{"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"query", "name"=>"expand", "description"=>"You can expand the supplements per room type on demand"}, {"in"=>"query", "name"=>"from", "description"=>"Defines the last business day you would like to get rates for"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel id the rateplan belongs to"}, {"in"=>"query", "name"=>"inlinecount", "description"=>"Return total number of items for a given filter criteria"}, {"in"=>"path", "name"=>"rateplanCode", "description"=>"The code of the rateplan you want to see details for"}, {"in"=>"query", "name"=>"skip", "description"=>"Amount of items to skip"}, {"in"=>"query", "name"=>"to", "description"=>"Defines the first business day you would like to get rates for"}, {"in"=>"query", "name"=>"top", "description"=>"Amount of items to select"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Setup", "Of", "Daily", "Ratesa", "Specific", "Rateplan", "Defined", "Timeperiod"]}, "patch"=>{"summary"=>"Partially update a rate of the specified rateplan for the defined time period.", "description"=>"The hetras API is using this Patch Specification\r\n to partially update an existing resource. Currently this call only allows to set the base price for non-derived rateplans if the rateplan\r\n is active and already loaded for the specified time period.\r\n \r\n A request example:\r\n [\r\n {\r\n \"op\": \"replace\", \"path\": \"/base_price\", \"value\": 120.00\r\n }\r\n ]\r\n \r\n For more details on how the API responds to errors please check our documentation on \r\n Error Handling.", "operationId"=>"RatePlans_PatchRates", "x-api-path-slug"=>"apihotelv0hotelshotelidrateplansrateplancoderates-patch", "parameters"=>[{"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"query", "name"=>"from", "description"=>"Defines the last business day you would like to get rates for"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel id the rateplan belongs to"}, {"in"=>"body", "name"=>"patchRequest", "description"=>"A set of JSON Patch operations", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"rateplanCode", "description"=>"The code of the rateplan you want to update the daily rate details for"}, {"in"=>"query", "name"=>"to", "description"=>"Defines the first business day you would like to get rates for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partially", "Update", "Rate", "Of", "Specified", "Rateplanthe", "Defined", "Time", "Period"]}}, "/api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}/rates/$count"=>{"get"=>{"summary"=>"Get the count of all active and loaded daily rates for the defined rateplan in a specified time period.", "description"=>"Get the count of all active and loaded daily rates for the defined rateplan in a specified time period..", "operationId"=>"RatePlans_GetRatesCount", "x-api-path-slug"=>"apihotelv0hotelshotelidrateplansrateplancoderatescount-get", "parameters"=>[{"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"query", "name"=>"from", "description"=>"Defines the last business day you would like to get rates for"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel id the rateplan belongs to"}, {"in"=>"path", "name"=>"rateplanCode", "description"=>"The code of the rateplan you want to count daily rates for"}, {"in"=>"query", "name"=>"to", "description"=>"Defines the first business day you would like to get rates for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Count", "Of", "", "Active", "Loaded", "Daily", "Ratesthe", "Defined", "Rateplan", "In", "Specified", "Time", "Period"]}}, "/api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}/rates/{businessDay}"=>{"get"=>{"summary"=>"Get the setup of a daily rate for a specific business day and rateplan.", "description"=>"Read the setup of the daily rate for the defined rateplan for that specific business day.", "operationId"=>"RatePlans_GetRate", "x-api-path-slug"=>"apihotelv0hotelshotelidrateplansrateplancoderatesbusinessday-get", "parameters"=>[{"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"path", "name"=>"businessDay", "description"=>"The business day you want to get the rate setup for"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel id the rateplan belongs to"}, {"in"=>"path", "name"=>"rateplanCode", "description"=>"The code of the rateplan you want to see details for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Setup", "Of", "Daily", "Ratea", "Specific", "Business", "Day", "Rateplan"]}, "patch"=>{"summary"=>"Partially update a rate of the specified rateplan for a defined business day.", "description"=>"The hetras API is using this Patch Specification\r\n to partially update an existing resource. Currently this call only allows to set the base price for non-derived rateplans if the rateplan\r\n is active and already loaded for the specified business day.\r\n \r\n A request example:\r\n [\r\n {\r\n \"op\": \"replace\", \"path\": \"/base_price\", \"value\": 120.00\r\n }\r\n ]\r\n \r\n For more details on how the API responds to errors please check our documentation on \r\n Error Handling.", "operationId"=>"RatePlans_PatchRate", "x-api-path-slug"=>"apihotelv0hotelshotelidrateplansrateplancoderatesbusinessday-patch", "parameters"=>[{"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"path", "name"=>"businessDay", "description"=>"The business day of the daily rate you want to update"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel id the rateplan belongs to"}, {"in"=>"body", "name"=>"patchRequest", "description"=>"A set of JSON Patch operations", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"rateplanCode", "description"=>"The code of the rateplan you want to update the daily rate details for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partially", "Update", "Rate", "Of", "Specified", "Rateplana", "Defined", "Business", "Day"]}}, "/api/hotel/v0/hotels/{hotelId}/room_types"=>{"get"=>{"summary"=>"Get a list with the details of all room types for for the specified hotel id.", "description"=>"With this call you can load the details about a all available room types for the specified hotel.", "operationId"=>"RoomTypes_GetRoomTypes", "x-api-path-slug"=>"apihotelv0hotelshotelidroom-types-get", "parameters"=>[{"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel id the room type belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Details", "Of", "", "Room", "Typesfor", "Specified", "Hotel", "Id"]}}, "/api/hotel/v0/hotels/{hotelId}/room_types/{code}"=>{"get"=>{"summary"=>"Get all the details for a specific room type in the hotel.", "description"=>"With this call you can load the details about a specific room type in the hotel.", "operationId"=>"RoomTypes_GetRoomType", "x-api-path-slug"=>"apihotelv0hotelshotelidroom-typescode-get", "parameters"=>[{"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"path", "name"=>"code", "description"=>"The code of the room type you want to see details for"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel id the room type belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Detailsa", "Specific", "Room", "Type", "In", "Hotel"]}}, "/api/hotel/v0/hotels/{hotelId}/rooms"=>{"get"=>{"summary"=>"Get a list of rooms using the provided filtering and pagination criteria.", "description"=>"Find all rooms for the hotel that match the specified filter criteria. The filtering will be done based on the current state of\r\n the rooms.", "operationId"=>"Rooms_GetRooms", "x-api-path-slug"=>"apihotelv0hotelshotelidrooms-get", "parameters"=>[{"in"=>"query", "name"=>"amenities", "description"=>"Return result only for rooms having all of the given amenities"}, {"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"query", "name"=>"conditions", "description"=>"Return results only for rooms that have the given room condition status"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel you are trying to find rooms for"}, {"in"=>"query", "name"=>"inlinecount", "description"=>"Return total number of items for a given filter criteria"}, {"in"=>"query", "name"=>"locations", "description"=>"Return result only for rooms having at least one of the specified locations"}, {"in"=>"query", "name"=>"maintenances", "description"=>"Return results only for rooms that have the given maintenance status"}, {"in"=>"query", "name"=>"occupancy", "description"=>"Return results only for rooms that have the given frontdesk ocuppancy status"}, {"in"=>"query", "name"=>"roomTypes", "description"=>"Return result only for rooms for the given room types"}, {"in"=>"query", "name"=>"skip", "description"=>"Amount of items to skip"}, {"in"=>"query", "name"=>"top", "description"=>"Amount of items to select"}, {"in"=>"query", "name"=>"views", "description"=>"Return result only for rooms having at least one of the specified views"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rooms", "Using", "Provided", "Filtering", "Pagination", "Criteria"]}}, "/api/hotel/v0/hotels/{hotelId}/rooms/$count"=>{"get"=>{"summary"=>"Get the count of all rooms in the hotel matching the given filter criteria.", "description"=>"Get the count of all rooms in the hotel matching the given filter criteria..", "operationId"=>"Rooms_GetRoomsCount", "x-api-path-slug"=>"apihotelv0hotelshotelidroomscount-get", "parameters"=>[{"in"=>"query", "name"=>"amenities", "description"=>"Return result only for rooms having all of the given amenities"}, {"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"query", "name"=>"conditions", "description"=>"Return results only for rooms that have the given room condition status"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel you are counting the rooms for"}, {"in"=>"query", "name"=>"locations", "description"=>"Return result only for rooms having at least one of the specified locations"}, {"in"=>"query", "name"=>"maintenances", "description"=>"Return results only for rooms that have the given maintenance status"}, {"in"=>"query", "name"=>"occupancy", "description"=>"Return results only for rooms that have the given frontdesk ocuppancy status"}, {"in"=>"query", "name"=>"roomTypes", "description"=>"Return result only for rooms for the given room types"}, {"in"=>"query", "name"=>"views", "description"=>"Return result only for rooms having at least one of the specified views"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Count", "Of", "", "Rooms", "In", "Hotel", "Matching", "Given", "Filter", "Criteria"]}}, "/api/hotel/v0/hotels/{hotelId}/rooms/available"=>{"get"=>{"summary"=>"Request available rooms using a given criteria.", "description"=>"Request available rooms using a given criteria..", "operationId"=>"Rooms_GetAvailableRooms", "x-api-path-slug"=>"apihotelv0hotelshotelidroomsavailable-get", "parameters"=>[{"in"=>"query", "name"=>"adults", "description"=>"Specifies number of adults the returned rooms will have to be able to house"}, {"in"=>"query", "name"=>"amenities", "description"=>"Return result only for rooms having all of the given amenities"}, {"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"query", "name"=>"from", "description"=>"Rooms returned will not be assigned to a reservation or be under maintenance between this date and the specified to date"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel you are looking for available rooms"}, {"in"=>"query", "name"=>"includeOutOfService", "description"=>"Should rooms that are set OutOfService in the defined time period be returned as available"}, {"in"=>"query", "name"=>"inlinecount", "description"=>"Return total number of items for a given filter criteria"}, {"in"=>"query", "name"=>"locations", "description"=>"Return result only for rooms having at least one of the specified locations"}, {"in"=>"query", "name"=>"roomTypes", "description"=>"Return result only for rooms for the given room types"}, {"in"=>"query", "name"=>"skip", "description"=>"Amount of items to skip"}, {"in"=>"query", "name"=>"to", "description"=>"Rooms returned will not be assigned to a reservation or be under maintenance between the specified from date and this date"}, {"in"=>"query", "name"=>"top", "description"=>"Amount of items to select"}, {"in"=>"query", "name"=>"views", "description"=>"Return result only for rooms having at least one of the specified views"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Available", "Rooms", "Using", "Given", "Criteria"]}}, "/api/hotel/v0/hotels/{hotelId}/rooms/{roomNumber}"=>{"get"=>{"summary"=>"Get all the details for a specific room in the hotel.", "description"=>"With this call you can load the details about a specific room in the hotel. It will show you the current status of the room.", "operationId"=>"Rooms_GetRoom", "x-api-path-slug"=>"apihotelv0hotelshotelidroomsroomnumber-get", "parameters"=>[{"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel id the room belongs to"}, {"in"=>"path", "name"=>"roomNumber", "description"=>"The room number you want to see details for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Detailsa", "Specific", "Room", "In", "Hotel"]}, "patch"=>{"summary"=>"Partially updates a room.", "description"=>"The hetras API is using this Patch Specification\r\n to partially update an existing resource. Currently this call only allows to modify condition and housekeeping occupancy status of the room.\r\n \r\n A request example:\r\n [\r\n {\r\n \"op\": \"replace\", \"path\": \"/status/condition\", \"value\": \"CleanNotInspected\"\r\n }, {\r\n \"op\": \"replace\", \"path\": \"/status/housekeeping_occupancy\", \"value\": \"Vacant\"\r\n }\r\n ]\r\n \r\n For more details on how the API responds to errors please check our documentation on \r\n Error Handling.", "operationId"=>"Rooms_PatchRoom", "x-api-path-slug"=>"apihotelv0hotelshotelidroomsroomnumber-patch", "parameters"=>[{"in"=>"header", "name"=>"App-Id", "description"=>"Application identifier"}, {"in"=>"header", "name"=>"App-Key", "description"=>"Application key"}, {"in"=>"path", "name"=>"hotelId", "description"=>"The hotel id the room belongs to"}, {"in"=>"body", "name"=>"patchRequest", "description"=>"A set of JSON Patch operations", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"roomNumber", "description"=>"The room number of the room you would like to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partially", "Updates", "Room"]}}}}, "apis"=>{"name"=>"TelAPI", "x-slug"=>"telapi", "description"=>"Zang offers business communications tools & voice app development platforms that bring innovation and ease to unified communications & collaboration solutions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1176-telapi.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"1071695", "tags"=>"Messages,Messages,Mobile,Relative Data,SaaS,Service API,SMS,SMS,Stack Network,Target,Technology,Telecommunications,Telecommunications,Voice,Voice", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"telapi/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"hetras Hotel API Version 0", "x-api-slug"=>"hetras-hotel-api-version-0", "description"=>"Zang offers business communications tools & voice app development platforms that bring innovation and ease to unified communications & collaboration solutions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1176-telapi.jpg", "humanURL"=>"http://www.telapi.com", "baseURL"=>"https://api.hetras-certification.net//", "tags"=>"Messages,Messages,Mobile,Relative Data,SaaS,Service API,SMS,SMS,Stack Network,Target,Technology,Telecommunications,Telecommunications,Voice,Voice", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/telapi/hetras-hotel-api-version-0-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.telapi.com"}, {"type"=>"x-blog", "url"=>"http://www.TelAPI.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"http://www.telapi.com/blog/feed/"}, {"type"=>"x-contact-form", "url"=>"http://www.telapi.com/contact"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/telapi"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/zang-io"}, {"type"=>"x-developer", "url"=>"http://www.telapi.com/docs/"}, {"type"=>"x-email", "url"=>"support@telapi.com"}, {"type"=>"x-github", "url"=>"https://github.com/TelAPI"}, {"type"=>"x-pricing", "url"=>"http://www.telapi.com/pricing"}, {"type"=>"x-privacy", "url"=>"https://www.telapi.com/legal/privacy-policy"}, {"type"=>"x-selfservice-registration", "url"=>"https://www.telapi.com/signup"}, {"type"=>"x-status", "url"=>"http://status.telapi.com/"}, {"type"=>"x-terms-of-service", "url"=>"https://www.telapi.com/legal/tos"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/TelAPI"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Zang_io"}, {"type"=>"x-website", "url"=>"http://www.telapi.com"}, {"type"=>"x-website", "url"=>"http://telapi.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-data-pipeline{"aws-data-pipeline-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Data Pipeline", "x-complete"=>1, "info"=>{"title"=>"AWS Data Pipeline API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=ActivatePipeline"=>{"get"=>{"summary"=>"Activate Pipeline", "description"=>"Validates the specified pipeline and starts processing pipeline tasks.", "operationId"=>"activatePipeline", "x-api-path-slug"=>"actionactivatepipeline-get", "parameters"=>[{"in"=>"query", "name"=>"parameterValues", "description"=>"A list of parameter values to pass to the pipeline at activation", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineId", "description"=>"The ID of the pipeline", "type"=>"string"}, {"in"=>"query", "name"=>"startTimestamp", "description"=>"The date and time to resume the pipeline", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipeline"]}}, "/?Action=AddTags"=>{"get"=>{"summary"=>"Add Tags", "description"=>"Adds or modifies tags for the specified pipeline.", "operationId"=>"addTags", "x-api-path-slug"=>"actionaddtags-get", "parameters"=>[{"in"=>"query", "name"=>"pipelineId", "description"=>"The ID of the pipeline", "type"=>"string"}, {"in"=>"query", "name"=>"tags", "description"=>"The tags to add, as key/value pairs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=CreatePipeline"=>{"get"=>{"summary"=>"Create Pipeline", "description"=>"Creates a new, empty pipeline.", "operationId"=>"createPipeline", "x-api-path-slug"=>"actioncreatepipeline-get", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"The description for the pipeline", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"The name for the pipeline", "type"=>"string"}, {"in"=>"query", "name"=>"tags", "description"=>"A list of tags to associate with the pipeline at creation", "type"=>"string"}, {"in"=>"query", "name"=>"uniqueId", "description"=>"A unique identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipeline"]}}, "/?Action=DeactivatePipeline"=>{"get"=>{"summary"=>"Deactivate Pipeline", "description"=>"Deactivates the specified running pipeline.", "operationId"=>"deactivatePipeline", "x-api-path-slug"=>"actiondeactivatepipeline-get", "parameters"=>[{"in"=>"query", "name"=>"cancelActive", "description"=>"Indicates whether to cancel any running objects", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineId", "description"=>"The ID of the pipeline", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipeline"]}}, "/?Action=DeletePipeline"=>{"get"=>{"summary"=>"Delete Pipeline", "description"=>"Deletes a pipeline, its pipeline definition, and its run history.", "operationId"=>"deletePipeline", "x-api-path-slug"=>"actiondeletepipeline-get", "parameters"=>[{"in"=>"query", "name"=>"pipelineId", "description"=>"The ID of the pipeline", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipeline"]}}, "/?Action=DescribeObjects"=>{"get"=>{"summary"=>"Describe Objects", "description"=>"Gets the object definitions for a set of objects associated with the pipeline.", "operationId"=>"describeObjects", "x-api-path-slug"=>"actiondescribeobjects-get", "parameters"=>[{"in"=>"query", "name"=>"evaluateExpressions", "description"=>"Indicates whether any expressions in the object should be evaluated when the object descriptions are returned", "type"=>"string"}, {"in"=>"query", "name"=>"marker", "description"=>"The starting point for the results to be returned", "type"=>"string"}, {"in"=>"query", "name"=>"objectIds", "description"=>"The IDs of the pipeline objects that contain the definitions to be described", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineId", "description"=>"The ID of the pipeline that contains the object definitions", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Objects"]}}, "/?Action=DescribePipelines"=>{"get"=>{"summary"=>"Describe Pipelines", "description"=>"Retrieves metadata about one or more pipelines.", "operationId"=>"describePipelines", "x-api-path-slug"=>"actiondescribepipelines-get", "parameters"=>[{"in"=>"query", "name"=>"pipelineIds", "description"=>"The IDs of the pipelines to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipeline"]}}, "/?Action=EvaluateExpression"=>{"get"=>{"summary"=>"Evaluate Expression", "description"=>"Task runners call EvaluateExpression to evaluate a string in the context of the specified object.", "operationId"=>"evaluateExpression", "x-api-path-slug"=>"actionevaluateexpression-get", "parameters"=>[{"in"=>"query", "name"=>"expression", "description"=>"The expression to evaluate", "type"=>"string"}, {"in"=>"query", "name"=>"objectId", "description"=>"The ID of the object", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineId", "description"=>"The ID of the pipeline", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Expressions"]}}, "/?Action=GetPipelineDefinition"=>{"get"=>{"summary"=>"Get Pipeline Definition", "description"=>"Gets the definition of the specified pipeline.", "operationId"=>"getPipelineDefinition", "x-api-path-slug"=>"actiongetpipelinedefinition-get", "parameters"=>[{"in"=>"query", "name"=>"pipelineId", "description"=>"The ID of the pipeline", "type"=>"string"}, {"in"=>"query", "name"=>"version", "description"=>"The version of the pipeline definition to retrieve", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipeline"]}}, "/?Action=ListPipelines"=>{"get"=>{"summary"=>"List Pipelines", "description"=>"Lists the pipeline identifiers for all active pipelines that you have permission to access.", "operationId"=>"listPipelines", "x-api-path-slug"=>"actionlistpipelines-get", "parameters"=>[{"in"=>"query", "name"=>"marker", "description"=>"The starting point for the results to be returned", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipeline"]}}, "/?Action=PollForTask"=>{"get"=>{"summary"=>"Poll For Task", "description"=>"Task runners call PollForTask to receive a task to perform from AWS Data Pipeline.", "operationId"=>"pollForTask", "x-api-path-slug"=>"actionpollfortask-get", "parameters"=>[{"in"=>"query", "name"=>"hostname", "description"=>"The public DNS name of the calling task runner", "type"=>"string"}, {"in"=>"query", "name"=>"instanceIdentity", "description"=>"Identity information for the EC2 instance that is hosting the task runner", "type"=>"string"}, {"in"=>"query", "name"=>"workerGroup", "description"=>"The type of task the task runner is configured to accept and process", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks"]}}, "/?Action=PutPipelineDefinition"=>{"get"=>{"summary"=>"Put Pipeline Definition", "description"=>"Adds tasks, schedules, and preconditions to the specified pipeline.", "operationId"=>"putPipelineDefinition", "x-api-path-slug"=>"actionputpipelinedefinition-get", "parameters"=>[{"in"=>"query", "name"=>"parameterObjects", "description"=>"The parameter objects used with the pipeline", "type"=>"string"}, {"in"=>"query", "name"=>"parameterValues", "description"=>"The parameter values used with the pipeline", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineId", "description"=>"The ID of the pipeline", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineObjects", "description"=>"The objects that define the pipeline", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipeline"]}}, "/?Action=QueryObjects"=>{"get"=>{"summary"=>"Query Objects", "description"=>"Queries the specified pipeline for the names of objects that match the specified set of conditions.", "operationId"=>"queryObjects", "x-api-path-slug"=>"actionqueryobjects-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"The maximum number of object names that QueryObjects will return in a single call", "type"=>"string"}, {"in"=>"query", "name"=>"marker", "description"=>"The starting point for the results to be returned", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineId", "description"=>"The ID of the pipeline", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"The query that defines the objects to be returned", "type"=>"string"}, {"in"=>"query", "name"=>"sphere", "description"=>"Indicates whether the query applies to components or instances", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Objects"]}}, "/?Action=RemoveTags"=>{"get"=>{"summary"=>"Remove Tags", "description"=>"Removes existing tags from the specified pipeline.", "operationId"=>"removeTags", "x-api-path-slug"=>"actionremovetags-get", "parameters"=>[{"in"=>"query", "name"=>"pipelineId", "description"=>"The ID of the pipeline", "type"=>"string"}, {"in"=>"query", "name"=>"tagKeys", "description"=>"The keys of the tags to remove", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=ReportTaskProgress"=>{"get"=>{"summary"=>"Report Task Progress", "description"=>"Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task.", "operationId"=>"reportTaskProgress", "x-api-path-slug"=>"actionreporttaskprogress-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Key-value pairs that define the properties of the ReportTaskProgressInput object", "type"=>"string"}, {"in"=>"query", "name"=>"taskId", "description"=>"The ID of the task assigned to the task runner", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks"]}}, "/?Action=ReportTaskRunnerHeartbeat"=>{"get"=>{"summary"=>"Report Task Runner Heartbeat", "description"=>"Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational.", "operationId"=>"reportTaskRunnerHeartbeat", "x-api-path-slug"=>"actionreporttaskrunnerheartbeat-get", "parameters"=>[{"in"=>"query", "name"=>"hostname", "description"=>"The public DNS name of the task runner", "type"=>"string"}, {"in"=>"query", "name"=>"taskrunnerId", "description"=>"The ID of the task runner", "type"=>"string"}, {"in"=>"query", "name"=>"workerGroup", "description"=>"The type of task the task runner is configured to accept and process", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task Runner Hearbeat"]}}, "/?Action=SetStatus"=>{"get"=>{"summary"=>"Set Status", "description"=>"Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline.", "operationId"=>"setStatus", "x-api-path-slug"=>"actionsetstatus-get", "parameters"=>[{"in"=>"query", "name"=>"objectIds", "description"=>"The IDs of the objects", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineId", "description"=>"The ID of the pipeline that contains the objects", "type"=>"string"}, {"in"=>"query", "name"=>"status", "description"=>"The status to be set on all the objects specified in objectIds", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Status"]}}, "/?Action=SetTaskStatus"=>{"get"=>{"summary"=>"Set Task Status", "description"=>"Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status.", "operationId"=>"setTaskStatus", "x-api-path-slug"=>"actionsettaskstatus-get", "parameters"=>[{"in"=>"query", "name"=>"errorId", "description"=>"If an error occurred during the task, this value specifies the error code", "type"=>"string"}, {"in"=>"query", "name"=>"errorMessage", "description"=>"If an error occurred during the task, this value specifies a text description of the error", "type"=>"string"}, {"in"=>"query", "name"=>"errorStackTrace", "description"=>"If an error occurred during the task, this value specifies the stack trace associated with the error", "type"=>"string"}, {"in"=>"query", "name"=>"taskId", "description"=>"The ID of the task assigned to the task runner", "type"=>"string"}, {"in"=>"query", "name"=>"taskStatus", "description"=>"If FINISHED, the task successfully completed", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks"]}}, "/?Action=ValidatePipelineDefinition"=>{"get"=>{"summary"=>"Validate Pipeline Definition", "description"=>"Validates the specified pipeline definition to ensure that it is well formed and can be run without error.", "operationId"=>"validatePipelineDefinition", "x-api-path-slug"=>"actionvalidatepipelinedefinition-get", "parameters"=>[{"in"=>"query", "name"=>"parameterObjects", "description"=>"The parameter objects used with the pipeline", "type"=>"string"}, {"in"=>"query", "name"=>"parameterValues", "description"=>"The parameter values used with the pipeline", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineId", "description"=>"The ID of the pipeline", "type"=>"string"}, {"in"=>"query", "name"=>"pipelineObjects", "description"=>"The objects that define the pipeline changes to validate against the pipeline", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipeline"]}}}}, "apis"=>{"name"=>"AWS Data Pipeline", "x-slug"=>"aws-data-pipeline", "description"=>"AWS Data Pipeline is a web service that helps you reliably process and move data between different AWS compute and storage services, as well as on-premise data sources, at specified intervals. With AWS Data Pipeline, you can regularly access your data where it’s stored, transform and process it at scale, and efficiently transfer the results to AWS services such as Amazon S3, Amazon RDS, Amazon DynamoDB, and Amazon EMR.AWS Data Pipeline helps you easily create complex data processing workloads that are fault tolerant, repeatable, and highly available. You don’t have to worry about ensuring resource availability, managing inter-task dependencies, retrying transient failures or timeouts in individual tasks, or creating a failure notification system. AWS Data Pipeline also allows you to move and process data that was previously locked up in on-premise data silos.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Analytics_AWSDataPipeline.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Data,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-data-pipeline/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Data Pipeline API", "x-api-slug"=>"aws-data-pipeline-api", "description"=>"AWS Data Pipeline is a web service that helps you reliably process and move data between different AWS compute and storage services, as well as on-premise data sources, at specified intervals. With AWS Data Pipeline, you can regularly access your data where it’s stored, transform and process it at scale, and efficiently transfer the results to AWS services such as Amazon S3, Amazon RDS, Amazon DynamoDB, and Amazon EMR.AWS Data Pipeline helps you easily create complex data processing workloads that are fault tolerant, repeatable, and highly available. You don’t have to worry about ensuring resource availability, managing inter-task dependencies, retrying transient failures or timeouts in individual tasks, or creating a failure notification system. AWS Data Pipeline also allows you to move and process data that was previously locked up in on-premise data silos.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Analytics_AWSDataPipeline.png", "humanURL"=>"https://aws.amazon.com/datapipeline/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Data,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-data-pipeline/actionvalidatepipelinedefinition-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-data-pipeline/aws-data-pipeline-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://blogs.aws.amazon.com/bigdata"}, {"type"=>"x-change-log", "url"=>"http://aws.amazon.com/releasenotes/AWS-Data-Pipeline/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/datapipeline/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/datapipeline/faqs/"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=151"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/datapipeline/pricing/"}, {"type"=>"x-tools", "url"=>"http://aws.amazon.com/developertools/AWS-Data-Pipeline/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/datapipeline/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-pub-sub{"google-cloud-pubsub-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Pub Sub", "x-complete"=>1, "info"=>{"title"=>"Google Cloud Pub/Sub", "description"=>"provides-reliable-manytomany-asynchronous-messaging-between-applications-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"pubsub.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/{name}"=>{"put"=>{"summary"=>"Create Topic", "description"=>"Creates the given topic with the given name.", "operationId"=>"pubsub.projects.topics.create", "x-api-path-slug"=>"v1name-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The name of the topic"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topic"]}}, "/v1/{project}/subscriptions"=>{"get"=>{"summary"=>"List Matching Subscription", "description"=>"Lists matching subscriptions.", "operationId"=>"pubsub.projects.subscriptions.list", "x-api-path-slug"=>"v1projectsubscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"pageSize", "description"=>"Maximum number of subscriptions to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The value returned by the last `ListSubscriptionsResponse`; indicates thatthis is a continuation of a prior `ListSubscriptions` call, and that thesystem should return the next page of data"}, {"in"=>"path", "name"=>"project", "description"=>"The name of the cloud project that subscriptions belong to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/v1/{project}/topics"=>{"get"=>{"summary"=>"List Matching Topics", "description"=>"Lists matching topics.", "operationId"=>"pubsub.projects.topics.list", "x-api-path-slug"=>"v1projecttopics-get", "parameters"=>[{"in"=>"query", "name"=>"pageSize", "description"=>"Maximum number of topics to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The value returned by the last `ListTopicsResponse`; indicates that this isa continuation of a prior `ListTopics` call, and that the system shouldreturn the next page of data"}, {"in"=>"path", "name"=>"project", "description"=>"The name of the cloud project that topics belong to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topic"]}}, "/v1/{resource}:getIamPolicy"=>{"get"=>{"summary"=>"Get IAM Policy", "description"=>"Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", "operationId"=>"pubsub.projects.topics.getIamPolicy", "x-api-path-slug"=>"v1resourcegetiampolicy-get", "parameters"=>[{"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}, "/v1/{resource}:setIamPolicy"=>{"post"=>{"summary"=>"Set IAM Policy", "description"=>"Sets the access control policy on the specified resource. Replaces any\nexisting policy.", "operationId"=>"pubsub.projects.topics.setIamPolicy", "x-api-path-slug"=>"v1resourcesetiampolicy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy is being specified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}, "/v1/{resource}:testIamPermissions"=>{"post"=>{"summary"=>"Test IAM Permission", "description"=>"Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "operationId"=>"pubsub.projects.topics.testIamPermissions", "x-api-path-slug"=>"v1resourcetestiampermissions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which the policy detail is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}, "/v1/{subscription}"=>{"delete"=>{"summary"=>"Delete Subscription", "description"=>"Deletes an existing subscription. All messages retained in the subscription\nare immediately dropped. Calls to `Pull` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new one may be created with\nthe same name, but the new one has no association with the old\nsubscription or its topic unless the same topic is specified.", "operationId"=>"pubsub.projects.subscriptions.delete", "x-api-path-slug"=>"v1subscription-delete", "parameters"=>[{"in"=>"path", "name"=>"subscription", "description"=>"The subscription to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}, "get"=>{"summary"=>"Get Subscription", "description"=>"Gets the configuration details of a subscription.", "operationId"=>"pubsub.projects.subscriptions.get", "x-api-path-slug"=>"v1subscription-get", "parameters"=>[{"in"=>"path", "name"=>"subscription", "description"=>"The name of the subscription to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/v1/{subscription}:acknowledge"=>{"post"=>{"summary"=>"Acknowledge Subscription", "description"=>"Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error.", "operationId"=>"pubsub.projects.subscriptions.acknowledge", "x-api-path-slug"=>"v1subscriptionacknowledge-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"subscription", "description"=>"The subscription whose message is being acknowledged"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/v1/{subscription}:modifyAckDeadline"=>{"post"=>{"summary"=>"Modify ACK Deadline", "description"=>"Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.", "operationId"=>"pubsub.projects.subscriptions.modifyAckDeadline", "x-api-path-slug"=>"v1subscriptionmodifyackdeadline-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"subscription", "description"=>"The name of the subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ACK Deadline"]}}, "/v1/{subscription}:modifyPushConfig"=>{"post"=>{"summary"=>"Modify Push Configuration", "description"=>"Modifies the `PushConfig` for a specified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for delivery\ncontinuously through the call regardless of changes to the `PushConfig`.", "operationId"=>"pubsub.projects.subscriptions.modifyPushConfig", "x-api-path-slug"=>"v1subscriptionmodifypushconfig-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"subscription", "description"=>"The name of the subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Push Configuration"]}}, "/v1/{subscription}:pull"=>{"post"=>{"summary"=>"Pull Message", "description"=>"Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.", "operationId"=>"pubsub.projects.subscriptions.pull", "x-api-path-slug"=>"v1subscriptionpull-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"subscription", "description"=>"The subscription from which messages should be pulled"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}}, "/v1/{topic}"=>{"delete"=>{"summary"=>"Delete Topic", "description"=>"Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`.", "operationId"=>"pubsub.projects.topics.delete", "x-api-path-slug"=>"v1topic-delete", "parameters"=>[{"in"=>"path", "name"=>"topic", "description"=>"Name of the topic to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topic"]}, "get"=>{"summary"=>"Get Topic Configuration", "description"=>"Gets the configuration of a topic.", "operationId"=>"pubsub.projects.topics.get", "x-api-path-slug"=>"v1topic-get", "parameters"=>[{"in"=>"path", "name"=>"topic", "description"=>"The name of the topic to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topic"]}}, "/v1/{topic}/subscriptions"=>{"get"=>{"summary"=>"Get Topic Subscription", "description"=>"Lists the name of the subscriptions for this topic.", "operationId"=>"pubsub.projects.topics.subscriptions.list", "x-api-path-slug"=>"v1topicsubscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"pageSize", "description"=>"Maximum number of subscription names to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The value returned by the last `ListTopicSubscriptionsResponse`; indicatesthat this is a continuation of a prior `ListTopicSubscriptions` call, andthat the system should return the next page of data"}, {"in"=>"path", "name"=>"topic", "description"=>"The name of the topic that subscriptions are attached to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topic"]}}, "/v1/{topic}:publish"=>{"post"=>{"summary"=>"Publish Topic", "description"=>"Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute.", "operationId"=>"pubsub.projects.topics.publish", "x-api-path-slug"=>"v1topicpublish-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"topic", "description"=>"The messages in the request will be published on this topic"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topic"]}}}}, "apis"=>{"name"=>"Google Cloud Pub Sub", "x-slug"=>"google-cloud-pub-sub", "description"=>"Cloud Pub/Sub is a fully-managed real-time messaging service that allows you to send and receive messages between independent applications. You can leverage Cloud Pub/Sub’s flexibility to decouple systems and components hosted on Google Cloud Platform or elsewhere on the Internet. By building on the same technology Google uses, Cloud Pub/Sub is designed to provide “at least once” delivery at low latency with on-demand scalability to 1 million messages per second (and beyond).", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-pub-sub-middleware.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Event-Driven,Google APIs,Internet of Things,Messages,Profiles,Real Time,Real Time,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-pub-sub/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Pub/Sub API", "x-api-slug"=>"google-cloud-pubsub-api", "description"=>"Google Cloud Pub/Sub is a fully-managed real-time messaging service that allows you to send and receive messages between independent applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-pub-sub-middleware.png", "humanURL"=>"https://cloud.google.com/pubsub/docs/", "baseURL"=>"://pubsub.googleapis.com//", "tags"=>"API Provider,API Service Provider,Event-Driven,Google APIs,Internet of Things,Messages,Profiles,Real Time,Real Time,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-pub-sub/google-cloud-pubsub-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-log", "url"=>"https://cloud.google.com/pubsub/docs/release-notes"}, {"type"=>"x-code", "url"=>"https://cloud.google.com/pubsub/docs/reference/libraries"}, {"type"=>"x-faq", "url"=>"https://cloud.google.com/pubsub/docs/faq"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/pubsub/docs/quickstarts"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/pubsub/docs/how-to"}, {"type"=>"x-issues", "url"=>"https://issuetracker.google.com/issues?q=componentid:187173%20status:open"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/pubsub/pricing"}, {"type"=>"x-rate-limits", "url"=>"https://cloud.google.com/pubsub/quotas"}, {"type"=>"x-service-level-agreement", "url"=>"https://cloud.google.com/pubsub/sla"}, {"type"=>"x-support", "url"=>"https://cloud.google.com/pubsub/docs/support"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/pubsub/docs/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
automox{"automox-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Automox", "x-complete"=>1, "info"=>{"title"=>"Automox API", "description"=>"the-automox-api-is-a-powerful-interface-that-allows-you-to-integrate-automox-reporting-data-into-you-applications-and-control-the-various-settings-of-your-account-all-endpoints-are-only-accessible-via-https-and-are-located-atapi-automox-com--for-instance-you-can-see-events-associated-with-your-account-by-accessing-the-following-url-with-your-idreplace-apikey-with-your-own--httpsconsole-automox-comapieventsapi-keyapikey-limitsbe-nice--if-youre-sending-too-many-requests-too-quickly-well-send-back-a429-error-code-too-many-requests-you-are-limited-to-5000-requests-per-hour-per-api-key-overall--practically-this-means-you-should-when-possible-authenticateusers-so-that-limits-are-well-outside-the-reach-of-a-given-user-", "termsOfService"=>"https://www.automox.com/", "contact"=>{"name"=>"support@automox.com"}, "version"=>"1.0.0"}, "host"=>"console.automox.com", "basePath"=>"/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/events"=>{"get"=>{"summary"=>"Get Events", "description"=>"Gets all `Event` objects for the authenticated user.", "operationId"=>"gets-all-event-objects-for-the-authenticated-user", "x-api-path-slug"=>"events-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/events/{id}"=>{"get"=>{"summary"=>"Get Events", "description"=>"Gets a specific `Event` object for the authenticated user.", "operationId"=>"gets-a-specific-event-object-for-the-authenticated-user", "x-api-path-slug"=>"eventsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"event ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/orgs"=>{"get"=>{"summary"=>"Get Orgs", "description"=>"Gets all organizations for the api key", "operationId"=>"gets-all-organizations-for-the-api-key", "x-api-path-slug"=>"orgs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs"]}}, "/orgs/{id}/packages"=>{"get"=>{"summary"=>"Get Orgs Packages", "description"=>"Returns all software packages discovered on all servers (endpoints) of an organization", "operationId"=>"returns-all-software-packages-discovered-on-all-servers-endpoints-of-an-organization", "x-api-path-slug"=>"orgsidpackages-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs", "Packages"]}}, "/policies"=>{"get"=>{"summary"=>"Get Policies", "description"=>"Gets all `Policy` objects for authenticated user", "operationId"=>"gets-all-policy-objects-for-authenticated-user", "x-api-path-slug"=>"policies-get", "parameters"=>[{"in"=>"query", "name"=>"o", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/policies/{id}"=>{"get"=>{"summary"=>"Get Policies", "description"=>"Gets a specific `Policy` object for the authenticated user.", "operationId"=>"gets-a-specific-policy-object-for-the-authenticated-user", "x-api-path-slug"=>"policiesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Policy ID"}, {"in"=>"query", "name"=>"o", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}, "put"=>{"summary"=>"Put Policies", "description"=>"Updates a `Policy` object", "operationId"=>"updates-a-policy-object", "x-api-path-slug"=>"policiesid-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Policy ID"}, {"in"=>"query", "name"=>"o", "description"=>"Organization ID"}, {"in"=>"body", "name"=>"policy", "description"=>"Updated policy object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/policies/{id}/action"=>{"post"=>{"summary"=>"Post Policies Action", "description"=>"Schedule a policy for immediate remediation", "operationId"=>"schedule-a-policy-for-immediate-remediation", "x-api-path-slug"=>"policiesidaction-post", "parameters"=>[{"in"=>"formData", "name"=>"action", "description"=>"Remediation action type [remediateAll]"}, {"in"=>"path", "name"=>"id", "description"=>"Policy ID"}, {"in"=>"query", "name"=>"o", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies", "Action"]}}, "/policysets"=>{"get"=>{"summary"=>"Get Policysets", "description"=>"Gets all `Policy Set` objects for authenticated user", "operationId"=>"gets-all-policy-set-objects-for-authenticated-user", "x-api-path-slug"=>"policysets-get", "parameters"=>[{"in"=>"query", "name"=>"o", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policysets"]}}, "/policystats"=>{"get"=>{"summary"=>"Get Policystats", "description"=>"Gets all `Policy Stats` objects for authenticated user", "operationId"=>"gets-all-policy-stats-objects-for-authenticated-user", "x-api-path-slug"=>"policystats-get", "parameters"=>[{"in"=>"query", "name"=>"o", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policystats"]}}, "/servers"=>{"get"=>{"summary"=>"Get Servers", "description"=>"Gets all `Server` objects for authenticated user", "operationId"=>"gets-all-server-objects-for-authenticated-user", "x-api-path-slug"=>"servers-get", "parameters"=>[{"in"=>"query", "name"=>"o", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}}, "/servers/{id}"=>{"get"=>{"summary"=>"Get Servers", "description"=>"Gets a specific `Server` object for the authenticated user.", "operationId"=>"gets-a-specific-server-object-for-the-authenticated-user", "x-api-path-slug"=>"serversid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Server (endpoint) ID"}, {"in"=>"query", "name"=>"o", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}, "put"=>{"summary"=>"Put Servers", "description"=>"Updates a `Server` object", "operationId"=>"updates-a-server-object", "x-api-path-slug"=>"serversid-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Server (endpoint) ID"}, {"in"=>"query", "name"=>"o", "description"=>"Organization ID"}, {"in"=>"body", "name"=>"server", "description"=>"Updated server object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}, "delete"=>{"summary"=>"Delete Servers", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"serversid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Server (endpoint) ID"}, {"in"=>"query", "name"=>"o", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}}, "/servers/{id}/packages"=>{"get"=>{"summary"=>"Get Servers Packages", "description"=>"Returns the command queue for the specified server (endpoint)", "operationId"=>"returns-the-command-queue-for-the-specified-server-endpoint", "x-api-path-slug"=>"serversidpackages-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Server (endpoint) ID"}, {"in"=>"query", "name"=>"o", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers", "Packages"]}}, "/servers/{id}/queues"=>{"get"=>{"summary"=>"Get Servers Queues", "description"=>"Returns the command queue for the specified server (endpoint)", "operationId"=>"returns-the-command-queue-for-the-specified-server-endpoint", "x-api-path-slug"=>"serversidqueues-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Server (endpoint) ID"}, {"in"=>"query", "name"=>"o", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers", "Queues"]}, "post"=>{"summary"=>"Post Servers Queues", "description"=>"Issue a command to an endpoint. Can be used to install a specific set of patches or reboot an endpoint", "operationId"=>"issue-a-command-to-an-endpoint-can-be-used-to-install-a-specific-set-of-patches-or-reboot-an-endpoin", "x-api-path-slug"=>"serversidqueues-post", "parameters"=>[{"in"=>"body", "name"=>"command", "description"=>"Command object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Server (endpoint) ID"}, {"in"=>"query", "name"=>"o", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers", "Queues"]}}, "/servergroups"=>{"get"=>{"summary"=>"Get Servergroups", "description"=>"Gets all `Server Group` objects for authenticated user", "operationId"=>"gets-all-server-group-objects-for-authenticated-user", "x-api-path-slug"=>"servergroups-get", "parameters"=>[{"in"=>"query", "name"=>"o", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servergroups"]}, "post"=>{"summary"=>"Post Servergroups", "description"=>"Updates a `Server Group` object", "operationId"=>"updates-a-server-group-object", "x-api-path-slug"=>"servergroups-post", "parameters"=>[{"in"=>"body", "name"=>"servergroup", "description"=>"Updated server object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servergroups"]}}, "/servergroups/{id}"=>{"get"=>{"summary"=>"Get Servergroups", "description"=>"Gets a specific `Server Group` object for the authenticated user.", "operationId"=>"gets-a-specific-server-group-object-for-the-authenticated-user", "x-api-path-slug"=>"servergroupsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Server Group ID"}, {"in"=>"query", "name"=>"o", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servergroups"]}, "put"=>{"summary"=>"Put Servergroups", "description"=>"Updates a `Server Group` object", "operationId"=>"updates-a-server-group-object", "x-api-path-slug"=>"servergroupsid-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Server Group ID"}, {"in"=>"query", "name"=>"o", "description"=>"Organization ID"}, {"in"=>"body", "name"=>"servergroup", "description"=>"Updated server object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servergroups"]}, "delete"=>{"summary"=>"Delete Servergroups", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"servergroupsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Server Group ID"}, {"in"=>"query", "name"=>"o", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servergroups"]}}, "/software_version"=>{"get"=>{"summary"=>"Get Software Version", "description"=>"Retrieves software packages and patches for an organization, specific policy, or just those that need [approval | attention | exceptions | pending update].", "operationId"=>"retrieves-software-packages-and-patches-for-an-organization-specific-policy-or-just-those-that-need-", "x-api-path-slug"=>"software-version-get", "parameters"=>[{"in"=>"query", "name"=>"exceptions", "description"=>"Retrieve software that applies to exception endpoints"}, {"in"=>"query", "name"=>"l", "description"=>"Result Limit"}, {"in"=>"query", "name"=>"needsApproval", "description"=>"Retrieve software that needs approval"}, {"in"=>"query", "name"=>"needsAttention", "description"=>"Retrieve software that needs attention"}, {"in"=>"query", "name"=>"o", "description"=>"Organization ID"}, {"in"=>"query", "name"=>"p", "description"=>"Page Number"}, {"in"=>"query", "name"=>"pendingUpdate", "description"=>"Retrieve software that is pending update"}, {"in"=>"query", "name"=>"policyId", "description"=>"Return results for a specific Policy ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Software", "Version"]}}, "/software"=>{"get"=>{"summary"=>"Get Software", "description"=>"Retrieves software packages and patches for an organization, allows filtering the list of software by name", "operationId"=>"retrieves-software-packages-and-patches-for-an-organization-allows-filtering-the-list-of-software-by", "x-api-path-slug"=>"software-get", "parameters"=>[{"in"=>"query", "name"=>"groupID", "description"=>"Return software for a given group ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit number of results returned"}, {"in"=>"query", "name"=>"name", "description"=>"Name of software package (wildcards ok) i"}, {"in"=>"query", "name"=>"o", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Software"]}}, "/approvals/{id}"=>{"put"=>{"summary"=>"Put Approvals", "description"=>"Update a manual approval record. Set `manual_approval` attribute of `approval` object to `true` to approve a patch; set it to `false` to reject a patch", "operationId"=>"update-a-manual-approval-record-set-manual-approval-attribute-of-approval-object-to-true-to-approve-", "x-api-path-slug"=>"approvalsid-put", "parameters"=>[{"in"=>"body", "name"=>"approval", "description"=>"Approval object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Approval ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Approvals"]}}, "/users"=>{"get"=>{"summary"=>"Get Users", "description"=>"Gets all `User` objects for the authenticated user.", "operationId"=>"gets-all-user-objects-for-the-authenticated-user", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"query", "name"=>"o", "description"=>"Organization ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/{id}/queues"=>{"get"=>{"summary"=>"Get Users Queues", "description"=>"Gets all commands executed for specified user id", "operationId"=>"gets-all-commands-executed-for-specified-user-id", "x-api-path-slug"=>"usersidqueues-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"User ID or `self` for current user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Queues"]}}, "/reports/prepatch"=>{"get"=>{"summary"=>"Get Reports Prepatch", "description"=>"Retrieve the prepatch report", "operationId"=>"retrieve-the-prepatch-report", "x-api-path-slug"=>"reportsprepatch-get", "parameters"=>[{"in"=>"query", "name"=>"startDate", "description"=>"Report Start Date - `YYYY-MM-DD`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "Prepatch"]}}, "/reports/noncompliance"=>{"get"=>{"summary"=>"Get Reports Noncompliance", "description"=>"Retrieve the non compliant devices report", "operationId"=>"retrieve-the-non-compliant-devices-report", "x-api-path-slug"=>"reportsnoncompliance-get", "parameters"=>[{"in"=>"query", "name"=>"startDate", "description"=>"Report Start Date - `YYYY-MM-DD`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "Noncompliance"]}}}}, "apis"=>{"name"=>"Automox", "x-slug"=>"automox", "description"=>"Patch any System, any Software, in Any Location with Automox. Our cloud-based patching management software was built for todays IT professionals.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28761-docs-automox-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"878532", "tags"=>"Enterprise,Operations,Relative Data,SaaS,Security,Servers,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"automox/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Automox", "x-api-slug"=>"automox", "description"=>"Patch any System, any Software, in Any Location with Automox. Our cloud-based patching management software was built for todays IT professionals.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28761-docs-automox-com.jpg", "humanURL"=>"https://automox.com", "baseURL"=>"https://console.automox.com//api", "tags"=>"Enterprise,Operations,Relative Data,SaaS,Security,Servers,Service API,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/automox/automox-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://www.automox.com/blog"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/automox"}, {"type"=>"x-documentation", "url"=>"https://docs.automox.com/"}, {"type"=>"x-documentation", "url"=>"https://docs.automox.com/api/"}, {"type"=>"x-email", "url"=>"info@automox.com"}, {"type"=>"x-openapi", "url"=>"https://docs.automox.com/api/swagger.yaml"}, {"type"=>"x-pricing", "url"=>"https://www.automox.com/pricing"}, {"type"=>"x-support", "url"=>"https://support.automox.com/hc/en-us"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/AutomoxApp"}, {"type"=>"x-website", "url"=>"https://automox.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
foursquare{"foursquare-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Foursquare", "x-complete"=>1, "info"=>{"title"=>"Foursquare", "description"=>"checkin-explore-your-city-and-connect-people-and-places-bapi-v2-b", "version"=>"1.0.0"}, "host"=>"api.foursquare.com", "basePath"=>"/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/campaigns/add"=>{"post"=>{"summary"=>"Post Campaigns Add", "description"=>"/campaigns/{CAMPAIGN_ID}", "operationId"=>"campaignscampaign-id", "x-api-path-slug"=>"campaignsadd-post", "parameters"=>[{"in"=>"query", "name"=>"campaignId", "description"=>"ID of an existing campaign to copy"}, {"in"=>"query", "name"=>"endAt", "description"=>"DateTime when the campaign is to be automatically deactivated (seconds since epoch)"}, {"in"=>"query", "name"=>"groupId", "description"=>"required (unless venueId has been provided)"}, {"in"=>"query", "name"=>"specialId", "description"=>"required (unless campaignId has been provided)"}, {"in"=>"query", "name"=>"startAt", "description"=>"DateTime when the campaign is to be started (seconds since epoch)"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"venueId", "description"=>"required (unless groupId has been provided)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns"]}}, "/campaigns/list"=>{"get"=>{"summary"=>"Get Campaigns List", "description"=>"/campaigns/add", "operationId"=>"campaignsadd", "x-api-path-slug"=>"campaignslist-get", "parameters"=>[{"in"=>"query", "name"=>"groupId", "description"=>"If specified, limits response to campaigns involving the given group"}, {"in"=>"query", "name"=>"specialId", "description"=>"If specified, limits response to campaigns involving the given special"}, {"in"=>"query", "name"=>"status", "description"=>"Which campaigns to return: pending, active, expired, all (default=all)"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns", "List"]}}, "/campaigns/{CAMPAIGN_ID}"=>{"get"=>{"summary"=>"Get Campaigns", "description"=>"/specials/{SPECIAL_ID}/retire", "operationId"=>"specialsspecial-idretire", "x-api-path-slug"=>"campaignscampaign-id-get", "parameters"=>[{"in"=>"query", "name"=>"CAMPAIGN_ID", "description"=>"The ID of the campaign to retrieve additional information for"}, {"in"=>"path", "name"=>"CAMPAIGN_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns"]}}, "/campaigns/{CAMPAIGN_ID}/delete"=>{"post"=>{"summary"=>"Post Campaigns Delete", "description"=>"/campaigns/{CAMPAIGN_ID}/timeseries", "operationId"=>"campaignscampaign-idtimeseries", "x-api-path-slug"=>"campaignscampaign-iddelete-post", "parameters"=>[{"in"=>"query", "name"=>"CAMPAIGN_ID", "description"=>"The ID of the campaign to delete"}, {"in"=>"path", "name"=>"CAMPAIGN_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns"]}}, "/campaigns/{CAMPAIGN_ID}/end"=>{"post"=>{"summary"=>"Post Campaigns End", "description"=>"/campaigns/{CAMPAIGN_ID}/delete", "operationId"=>"campaignscampaign-iddelete", "x-api-path-slug"=>"campaignscampaign-idend-post", "parameters"=>[{"in"=>"query", "name"=>"CAMPAIGN_ID", "description"=>"The ID of the campaign to end"}, {"in"=>"path", "name"=>"CAMPAIGN_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns", "End"]}}, "/campaigns/{CAMPAIGN_ID}/start"=>{"post"=>{"summary"=>"Post Campaigns Start", "description"=>"/campaigns/{CAMPAIGN_ID}/end", "operationId"=>"campaignscampaign-idend", "x-api-path-slug"=>"campaignscampaign-idstart-post", "parameters"=>[{"in"=>"query", "name"=>"CAMPAIGN_ID", "description"=>"The ID of the campaign to start"}, {"in"=>"path", "name"=>"CAMPAIGN_ID"}, {"in"=>"query", "name"=>"startAt", "description"=>"DateTime when the campaign is to be started (seconds since epoch)"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns", "Start"]}}, "/campaigns/{CAMPAIGN_ID}/timeseries"=>{"get"=>{"summary"=>"Get Campaigns Timeseries", "description"=>"/campaigns/list", "operationId"=>"campaignslist", "x-api-path-slug"=>"campaignscampaign-idtimeseries-get", "parameters"=>[{"in"=>"query", "name"=>"CAMPAIGN_ID", "description"=>"The campaign id to retrieve stats for"}, {"in"=>"path", "name"=>"CAMPAIGN_ID"}, {"in"=>"query", "name"=>"endAt", "description"=>"The end of the time range to retrieve stats for (seconds since epoch)"}, {"in"=>"query", "name"=>"startAt", "description"=>"The start of the time range to retrieve stats for (seconds since epoch)"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns", "Timeseries"]}}, "/checkins/add"=>{"post"=>{"summary"=>"Post Checkins Add", "description"=>"/checkins/{CHECKIN_ID}", "operationId"=>"checkinscheckin-id", "x-api-path-slug"=>"checkinsadd-post", "parameters"=>[{"in"=>"query", "name"=>"alt", "description"=>"Altitude of the users location, in meters"}, {"in"=>"query", "name"=>"altAcc", "description"=>"Vertical accuracy of the users location, in meters"}, {"in"=>"query", "name"=>"broadcast", "description"=>"Who to broadcast this check-in to"}, {"in"=>"query", "name"=>"eventId", "description"=>"The event the user is checking in to"}, {"in"=>"query", "name"=>"ll", "description"=>"Latitude and longitude of the users location"}, {"in"=>"query", "name"=>"llAcc", "description"=>"Accuracy of the users latitude and longitude, in meters"}, {"in"=>"query", "name"=>"shout", "description"=>"A message about your check-in"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"venue", "description"=>"If are not shouting, but you dont have a venue ID or would rather prefer a venueless checkin, pass the venue name as a string using this parameter"}, {"in"=>"query", "name"=>"venueId", "description"=>"The venue where the user is checking in"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkins"]}}, "/checkins/recent"=>{"get"=>{"summary"=>"Get Checkins Recent", "description"=>"/checkins/add", "operationId"=>"checkinsadd", "x-api-path-slug"=>"checkinsrecent-get", "parameters"=>[{"in"=>"query", "name"=>"afterTimestamp", "description"=>"Seconds after which to look for checkins, e"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 100"}, {"in"=>"query", "name"=>"ll", "description"=>"Latitude and longitude of the users location, so response can include distance"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkins", "Recent"]}}, "/checkins/{CHECKIN_ID}"=>{"get"=>{"summary"=>"Get Checkins Checkin", "description"=>"/venuegroups/{GROUP_ID}/removevenue", "operationId"=>"venuegroupsgroup-idremovevenue", "x-api-path-slug"=>"checkinscheckin-id-get", "parameters"=>[{"in"=>"query", "name"=>"CHECKIN_ID", "description"=>"The ID of the checkin to retrieve additional information for"}, {"in"=>"path", "name"=>"CHECKIN_ID"}, {"in"=>"query", "name"=>"signature", "description"=>"When checkins are sent to public feeds such as Twitter, foursquare appends a signature (s=XXXXXX) allowing users to bypass the friends-only access check on checkins"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkins", "Checkin"]}}, "/checkins/{CHECKIN_ID}/addcomment"=>{"post"=>{"summary"=>"Post Checkins Checkin Addcomment", "description"=>"/checkins/recent", "operationId"=>"checkinsrecent", "x-api-path-slug"=>"checkinscheckin-idaddcomment-post", "parameters"=>[{"in"=>"query", "name"=>"CHECKIN_ID", "description"=>"The ID of the checkin to add a comment to"}, {"in"=>"path", "name"=>"CHECKIN_ID"}, {"in"=>"query", "name"=>"text", "description"=>"The text of the comment, up to 200 characters"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkins", "Checkin", "Comment"]}}, "/checkins/{CHECKIN_ID}/deletecomment"=>{"post"=>{"summary"=>"Post Checkins Checkin Deletecomment", "description"=>"/checkins/{CHECKIN_ID}/addcomment", "operationId"=>"checkinscheckin-idaddcomment", "x-api-path-slug"=>"checkinscheckin-iddeletecomment-post", "parameters"=>[{"in"=>"query", "name"=>"CHECKIN_ID", "description"=>"The ID of the checkin to remove a comment from"}, {"in"=>"path", "name"=>"CHECKIN_ID"}, {"in"=>"query", "name"=>"commentId", "description"=>"The id of the comment to remove"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkins", "Checkin", "Comment"]}}, "/events/categories"=>{"get"=>{"summary"=>"Get Events Categories", "description"=>"/events/{EVENT_ID}", "operationId"=>"eventsevent-id", "x-api-path-slug"=>"eventscategories-get", "parameters"=>[{"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Categories"]}}, "/events/search"=>{"get"=>{"summary"=>"Get Events Search", "description"=>"/events/categories", "operationId"=>"eventscategories", "x-api-path-slug"=>"eventssearch-get", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"Identifier for a known third-party event provider"}, {"in"=>"query", "name"=>"eventId", "description"=>"Identifier used by third-party specifed in domain, which we will attempt to match against our events listings"}, {"in"=>"query", "name"=>"participantId", "description"=>"Identifier used by third-party specifed in domain, which we will attempt to match against our events listings"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Search"]}}, "/events/{EVENT_ID}"=>{"get"=>{"summary"=>"Get Events Event", "description"=>"/campaigns/{CAMPAIGN_ID}/start", "operationId"=>"campaignscampaign-idstart", "x-api-path-slug"=>"eventsevent-id-get", "parameters"=>[{"in"=>"query", "name"=>"EVENT_ID", "description"=>"The ID of the event to retrieve additional information for"}, {"in"=>"path", "name"=>"EVENT_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Event"]}}, "/lists/add"=>{"post"=>{"summary"=>"Post Lists Add", "description"=>"/lists/{LIST_ID}", "operationId"=>"listslist-id", "x-api-path-slug"=>"listsadd-post", "parameters"=>[{"in"=>"query", "name"=>"collaborative", "description"=>"Indicating if this list can be edited by friends"}, {"in"=>"query", "name"=>"description", "description"=>"The description of the list"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the list"}, {"in"=>"query", "name"=>"photoId", "description"=>"The id of a photo that should be set as the list photo"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists"]}}, "/lists/{LIST_ID}"=>{"get"=>{"summary"=>"Get Lists", "description"=>"/tips/{TIP_ID}/unmark", "operationId"=>"tipstip-idunmark", "x-api-path-slug"=>"listslist-id-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 200"}, {"in"=>"query", "name"=>"LIST_ID", "description"=>"id for a user-created (e"}, {"in"=>"path", "name"=>"LIST_ID"}, {"in"=>"query", "name"=>"offset", "description"=>"The number of results to skip"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists"]}}, "/lists/{LIST_ID}/additem"=>{"post"=>{"summary"=>"Post Lists Additem", "description"=>"/lists/{LIST_ID}/suggestvenues", "operationId"=>"listslist-idsuggestvenues", "x-api-path-slug"=>"listslist-idadditem-post", "parameters"=>[{"in"=>"query", "name"=>"itemId", "description"=>"Used in conjuction with listId, the id of an item on that list that we wish to copy to this list"}, {"in"=>"query", "name"=>"listId", "description"=>"Used in conjuction with itemId, the id for a user created or followed list as well as one of USER_ID/tips, USER_ID/todos, or USER_ID/dones"}, {"in"=>"query", "name"=>"LIST_ID", "description"=>"Id for a user-created or followed list as well as one of USER_ID/tips, USER_ID/todos, or USER_ID/dones"}, {"in"=>"path", "name"=>"LIST_ID"}, {"in"=>"query", "name"=>"text", "description"=>"If the target is a user-created list, this will create a public tip on the venue"}, {"in"=>"query", "name"=>"tipId", "description"=>"Used to add a tip to a list"}, {"in"=>"query", "name"=>"url", "description"=>"If adding a new tip via text, this can associate a url with the tip"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"venueId", "description"=>"A venue to add to the list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Item"]}}, "/lists/{LIST_ID}/deleteitem"=>{"post"=>{"summary"=>"Post Lists Deleteitem", "description"=>"/lists/{LIST_ID}/additem", "operationId"=>"listslist-idadditem", "x-api-path-slug"=>"listslist-iddeleteitem-post", "parameters"=>[{"in"=>"query", "name"=>"itemId", "description"=>"Id of the item to delete"}, {"in"=>"query", "name"=>"LIST_ID", "description"=>"Id for a user-created or followed list or one of USER_ID/tips, USER_ID/todos, or USER_ID/dones"}, {"in"=>"path", "name"=>"LIST_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Item"]}}, "/lists/{LIST_ID}/follow"=>{"post"=>{"summary"=>"Post Lists Follow", "description"=>"/lists/{LIST_ID}/deleteitem", "operationId"=>"listslist-iddeleteitem", "x-api-path-slug"=>"listslist-idfollow-post", "parameters"=>[{"in"=>"query", "name"=>"LIST_ID", "description"=>"Id of a user-created list"}, {"in"=>"path", "name"=>"LIST_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Follow"]}}, "/lists/{LIST_ID}/followers"=>{"get"=>{"summary"=>"Get Lists Followers", "description"=>"/lists/add", "operationId"=>"listsadd", "x-api-path-slug"=>"listslist-idfollowers-get", "parameters"=>[{"in"=>"query", "name"=>"LIST_ID", "description"=>"Id for a user-created list"}, {"in"=>"path", "name"=>"LIST_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Followers"]}}, "/lists/{LIST_ID}/moveitem"=>{"post"=>{"summary"=>"Post Lists Moveitem", "description"=>"/lists/{LIST_ID}/follow", "operationId"=>"listslist-idfollow", "x-api-path-slug"=>"listslist-idmoveitem-post", "parameters"=>[{"in"=>"query", "name"=>"afterId", "description"=>"Move itemId after afterId"}, {"in"=>"query", "name"=>"beforeId", "description"=>"Move itemId before beforeId"}, {"in"=>"query", "name"=>"itemId", "description"=>"Id of the item on this list to move"}, {"in"=>"query", "name"=>"LIST_ID", "description"=>"Id for a user-created or followed list or one of USER_ID/tips, USER_ID/todos, or USER_ID/dones"}, {"in"=>"path", "name"=>"LIST_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Moveitem"]}}, "/lists/{LIST_ID}/share"=>{"post"=>{"summary"=>"Post Lists Share", "description"=>"/lists/{LIST_ID}/moveitem", "operationId"=>"listslist-idmoveitem", "x-api-path-slug"=>"listslist-idshare-post", "parameters"=>[{"in"=>"query", "name"=>"broadcast", "description"=>"Where to broadcast this list"}, {"in"=>"query", "name"=>"LIST_ID", "description"=>"Id for a user-created list"}, {"in"=>"path", "name"=>"LIST_ID"}, {"in"=>"query", "name"=>"message", "description"=>"A personal note to include with the share"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Share"]}}, "/lists/{LIST_ID}/suggestphoto"=>{"get"=>{"summary"=>"Get Lists Suggestphoto", "description"=>"/lists/{LIST_ID}/followers", "operationId"=>"listslist-idfollowers", "x-api-path-slug"=>"listslist-idsuggestphoto-get", "parameters"=>[{"in"=>"query", "name"=>"itemId", "description"=>"Id of item on this list"}, {"in"=>"query", "name"=>"LIST_ID", "description"=>"Id for a user-created list"}, {"in"=>"path", "name"=>"LIST_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Suggestphoto"]}}, "/lists/{LIST_ID}/suggesttip"=>{"get"=>{"summary"=>"Get Lists Suggesttip", "description"=>"/lists/{LIST_ID}/suggestphoto", "operationId"=>"listslist-idsuggestphoto", "x-api-path-slug"=>"listslist-idsuggesttip-get", "parameters"=>[{"in"=>"query", "name"=>"itemId", "description"=>"Id of item on this list"}, {"in"=>"query", "name"=>"LIST_ID", "description"=>"Id for a user-created list"}, {"in"=>"path", "name"=>"LIST_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Suggesttip"]}}, "/lists/{LIST_ID}/suggestvenues"=>{"get"=>{"summary"=>"Get Lists Suggestvenues", "description"=>"/lists/{LIST_ID}/suggesttip", "operationId"=>"listslist-idsuggesttip", "x-api-path-slug"=>"listslist-idsuggestvenues-get", "parameters"=>[{"in"=>"query", "name"=>"LIST_ID", "description"=>"Id for a user-created list"}, {"in"=>"path", "name"=>"LIST_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Suggestvenues"]}}, "/lists/{LIST_ID}/unfollow"=>{"post"=>{"summary"=>"Post Lists Unfollow", "description"=>"/lists/{LIST_ID}/share", "operationId"=>"listslist-idshare", "x-api-path-slug"=>"listslist-idunfollow-post", "parameters"=>[{"in"=>"query", "name"=>"LIST_ID", "description"=>"Id of a user-created list"}, {"in"=>"path", "name"=>"LIST_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Unfollow"]}}, "/lists/{LIST_ID}/update"=>{"post"=>{"summary"=>"Post Lists Update", "description"=>"/lists/{LIST_ID}/unfollow", "operationId"=>"listslist-idunfollow", "x-api-path-slug"=>"listslist-idupdate-post", "parameters"=>[{"in"=>"query", "name"=>"collaborative", "description"=>"Indicating if this list can be edited by friends"}, {"in"=>"query", "name"=>"description", "description"=>"If present and a non-empty value, updates the List description"}, {"in"=>"query", "name"=>"LIST_ID", "description"=>"Id for a user-created list"}, {"in"=>"path", "name"=>"LIST_ID"}, {"in"=>"query", "name"=>"name", "description"=>"If present and a non-empty value, updates the List name"}, {"in"=>"query", "name"=>"photoId", "description"=>"If present and a non-empty value, updates the List photo"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists"]}}, "/lists/{LIST_ID}/updateitem"=>{"post"=>{"summary"=>"Post Lists Updateitem", "description"=>"/lists/{LIST_ID}/update", "operationId"=>"listslist-idupdate", "x-api-path-slug"=>"listslist-idupdateitem-post", "parameters"=>[{"in"=>"query", "name"=>"itemId", "description"=>"The id of an item on this list"}, {"in"=>"query", "name"=>"LIST_ID", "description"=>"Id for a user-created list"}, {"in"=>"path", "name"=>"LIST_ID"}, {"in"=>"query", "name"=>"photoId", "description"=>"If present and a non-empty value, adds a photo to this item"}, {"in"=>"query", "name"=>"text", "description"=>"If present creates a public tip on the venue and replaces any existing tip on the item"}, {"in"=>"query", "name"=>"tipId", "description"=>"If present and a non-empty value, adds or replaces a tip on this item"}, {"in"=>"query", "name"=>"url", "description"=>"If adding a new tip via text, this can associate a url with the tip"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Item"]}}, "/multi"=>{"get"=>{"summary"=>"Get Multi", "description"=>"/pages/{PAGE_ID}/venues", "operationId"=>"pagespage-idvenues", "x-api-path-slug"=>"multi-get", "parameters"=>[{"in"=>"query", "name"=>"requests", "description"=>"A comma-delimited list of API requests"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi"]}}, "/pages/search"=>{"get"=>{"summary"=>"Get Pages Search", "description"=>"/pages/{PAGE_ID}", "operationId"=>"pagespage-id", "x-api-path-slug"=>"pagessearch-get", "parameters"=>[{"in"=>"query", "name"=>"fbid", "description"=>"A comma-delimited list of Facebook IDs to look for"}, {"in"=>"query", "name"=>"name", "description"=>"A search term to be applied against page names"}, {"in"=>"query", "name"=>"twitter", "description"=>"A comma-delimited list of Twitter handles to look for"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages", "Search"]}}, "/pages/{PAGE_ID}"=>{"get"=>{"summary"=>"Get Pages", "description"=>"/events/search", "operationId"=>"eventssearch", "x-api-path-slug"=>"pagespage-id-get", "parameters"=>[{"in"=>"query", "name"=>"PAGE_ID", "description"=>"Identity of the page to get details for"}, {"in"=>"path", "name"=>"PAGE_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages"]}}, "/pages/{PAGE_ID}/venues"=>{"get"=>{"summary"=>"Get Pages Venues", "description"=>"/pages/search", "operationId"=>"pagessearch", "x-api-path-slug"=>"pagespage-idvenues-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"The number of venues to return"}, {"in"=>"query", "name"=>"ll", "description"=>"Not valid with ne or sw"}, {"in"=>"query", "name"=>"ne", "description"=>"See sw"}, {"in"=>"query", "name"=>"offset", "description"=>"The offset of which venues to return"}, {"in"=>"query", "name"=>"PAGE_ID", "description"=>"The page id for which venues are being requested"}, {"in"=>"path", "name"=>"PAGE_ID"}, {"in"=>"query", "name"=>"radius", "description"=>"Can be used when including ll"}, {"in"=>"query", "name"=>"sw", "description"=>"With ne, limits results to the bounding quadrangle defined by the latitude and longitude given by sw as its south-west corner, and ne as its north-east corner"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages", "Venues"]}}, "/photos/add"=>{"post"=>{"summary"=>"Post Photos Add", "description"=>"/photos/{PHOTO_ID}", "operationId"=>"photosphoto-id", "x-api-path-slug"=>"photosadd-post", "parameters"=>[{"in"=>"query", "name"=>"alt", "description"=>"Altitude of the users location, in meters"}, {"in"=>"query", "name"=>"altAcc", "description"=>"Vertical accuracy of the users location, in meters"}, {"in"=>"query", "name"=>"broadcast", "description"=>"Whether to broadcast this photo"}, {"in"=>"query", "name"=>"checkinId", "description"=>"The ID of a checkin owned by the user"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Content-Type"}, {"in"=>"query", "name"=>"image", "description"=>"The image file data"}, {"in"=>"query", "name"=>"ll", "description"=>"Latitude and longitude of the users location"}, {"in"=>"query", "name"=>"llAcc", "description"=>"Accuracy of the users latitude and longitude, in meters"}, {"in"=>"query", "name"=>"public", "description"=>"When the checkinId is also provided (meaning this is a photo attached to a checkin), this parameter allows for making the photo public and viewable at the venue"}, {"in"=>"query", "name"=>"tipId", "description"=>"The ID of a tip owned by the user"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"venueId", "description"=>"The ID of a venue, provided only when adding a public photo of the venue in general, rather than a private checkin or tip photo using the parameters above"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos"]}}, "/photos/{PHOTO_ID}"=>{"get"=>{"summary"=>"Get Photos Photo", "description"=>"/updates/marknotificationsread", "operationId"=>"updatesmarknotificationsread", "x-api-path-slug"=>"photosphoto-id-get", "parameters"=>[{"in"=>"query", "name"=>"PHOTO_ID", "description"=>"The ID of the photo to retrieve additional information for"}, {"in"=>"path", "name"=>"PHOTO_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Photo"]}}, "/settings/all"=>{"get"=>{"summary"=>"Get Settings All", "description"=>"/settings/{SETTING_ID}", "operationId"=>"settingssetting-id", "x-api-path-slug"=>"settingsall-get", "parameters"=>[{"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settings"]}}, "/settings/{SETTING_ID}"=>{"get"=>{"summary"=>"Get Settings Setting", "description"=>"/photos/add", "operationId"=>"photosadd", "x-api-path-slug"=>"settingssetting-id-get", "parameters"=>[{"in"=>"query", "name"=>"SETTING_ID", "description"=>"The name of a setting"}, {"in"=>"path", "name"=>"SETTING_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settings", "Setting"]}}, "/settings/{SETTING_ID}/set"=>{"post"=>{"summary"=>"Post Settings Setting Set", "description"=>"/settings/all", "operationId"=>"settingsall", "x-api-path-slug"=>"settingssetting-idset-post", "parameters"=>[{"in"=>"query", "name"=>"SETTING_ID", "description"=>"Name of setting to change"}, {"in"=>"path", "name"=>"SETTING_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"value", "description"=>"1 for true, and 0 for false"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settings", "Setting", "Set"]}}, "/specials/add"=>{"post"=>{"summary"=>"Post Specials Add", "description"=>"/specials/{SPECIAL_ID}", "operationId"=>"specialsspecial-id", "x-api-path-slug"=>"specialsadd-post", "parameters"=>[{"in"=>"query", "name"=>"cost", "description"=>"The amount of money the user must spend to use this special in dollars and cents"}, {"in"=>"query", "name"=>"count1", "description"=>"Count for frequency, count, regular, swarm, friends, and flash specials"}, {"in"=>"query", "name"=>"count2", "description"=>"Secondary count for regular, flash specials"}, {"in"=>"query", "name"=>"count3", "description"=>"Tertiary count for flash specials"}, {"in"=>"query", "name"=>"finePrint", "description"=>"Maximum length of 200 characters"}, {"in"=>"query", "name"=>"name", "description"=>"A name for the special"}, {"in"=>"query", "name"=>"offerId", "description"=>"Maximum length of 16 characters"}, {"in"=>"query", "name"=>"text", "description"=>"Maximum length of 200 characters"}, {"in"=>"query", "name"=>"type", "description"=>"The type of special"}, {"in"=>"query", "name"=>"unlockedText", "description"=>"Maximum length of 200 characters"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specials"]}}, "/specials/list"=>{"get"=>{"summary"=>"Get Specials List", "description"=>"/specials/add", "operationId"=>"specialsadd", "x-api-path-slug"=>"specialslist-get", "parameters"=>[{"in"=>"query", "name"=>"status", "description"=>"Which specials to return: pending, active, expired, all"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"venueId", "description"=>"Comma-separated list of venue IDs; filters results to the specials assigned to the venue(s)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specials", "List"]}}, "/specials/search"=>{"get"=>{"summary"=>"Get Specials Search", "description"=>"/specials/list", "operationId"=>"specialslist", "x-api-path-slug"=>"specialssearch-get", "parameters"=>[{"in"=>"query", "name"=>"alt", "description"=>"Altitude of the users location, in meters"}, {"in"=>"query", "name"=>"altAcc", "description"=>"Accuracy of the users altitude, in meters"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 50"}, {"in"=>"query", "name"=>"ll", "description"=>"Latitude and longitude to search near"}, {"in"=>"query", "name"=>"llAcc", "description"=>"Accuracy of latitude and longitude, in meters"}, {"in"=>"query", "name"=>"radius", "description"=>"Limit results to venues within this many meters of the specified location"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specials", "Search"]}}, "/specials/{ID}/flag"=>{"post"=>{"summary"=>"Post Specials Flag", "description"=>"/specials/{SPECIAL_ID}/configuration", "operationId"=>"specialsspecial-idconfiguration", "x-api-path-slug"=>"specialsidflag-post", "parameters"=>[{"in"=>"query", "name"=>"ID", "description"=>"The id of the special being flagged"}, {"in"=>"path", "name"=>"ID"}, {"in"=>"query", "name"=>"problem", "description"=>"One of not_redeemable, not_valuable, other"}, {"in"=>"query", "name"=>"text", "description"=>"Additional text about why the user has flagged this special"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"venueId", "description"=>"The id of the venue running the special"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specials", "Flag"]}}, "/specials/{SPECIAL_ID}"=>{"get"=>{"summary"=>"Get Specials", "description"=>"/settings/{SETTING_ID}/set", "operationId"=>"settingssetting-idset", "x-api-path-slug"=>"specialsspecial-id-get", "parameters"=>[{"in"=>"query", "name"=>"SPECIAL_ID", "description"=>"ID of special to retrieve"}, {"in"=>"path", "name"=>"SPECIAL_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"venueId", "description"=>"ID of a venue the special is running at"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specials"]}}, "/specials/{SPECIAL_ID}/configuration"=>{"get"=>{"summary"=>"Get Specials Configuration", "description"=>"/specials/search", "operationId"=>"specialssearch", "x-api-path-slug"=>"specialsspecial-idconfiguration-get", "parameters"=>[{"in"=>"query", "name"=>"SPECIAL_ID", "description"=>"The ID of the special to retrieve configuration details for"}, {"in"=>"path", "name"=>"SPECIAL_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specials", "Configuration"]}}, "/specials/{SPECIAL_ID}/retire"=>{"post"=>{"summary"=>"Post Specials Retire", "description"=>"/specials/{ID}/flag", "operationId"=>"specialsidflag", "x-api-path-slug"=>"specialsspecial-idretire-post", "parameters"=>[{"in"=>"query", "name"=>"SPECIAL_ID", "description"=>"The ID of the special to retire"}, {"in"=>"path", "name"=>"SPECIAL_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specials", "Retire"]}}, "/tips/add"=>{"post"=>{"summary"=>"Post Tips Add", "description"=>"/tips/{TIP_ID}", "operationId"=>"tipstip-id", "x-api-path-slug"=>"tipsadd-post", "parameters"=>[{"in"=>"query", "name"=>"broadcast", "description"=>"Whether to broadcast this tip"}, {"in"=>"query", "name"=>"text", "description"=>"The text of the tip, up to 200 characters"}, {"in"=>"query", "name"=>"url", "description"=>"A URL related to this tip"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"venueId", "description"=>"The venue where you want to add this tip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tips"]}}, "/tips/search"=>{"get"=>{"summary"=>"Get Tips Search", "description"=>"/tips/add", "operationId"=>"tipsadd", "x-api-path-slug"=>"tipssearch-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"If set to friends, only show nearby tips from friends"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 500"}, {"in"=>"query", "name"=>"ll", "description"=>"Latitude and longitude of the users location"}, {"in"=>"query", "name"=>"offset", "description"=>"Used to page through results"}, {"in"=>"query", "name"=>"query", "description"=>"Only find tips matching the given term, cannot be used in conjunction with friends filter"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tips", "Search"]}}, "/tips/{TIP_ID}"=>{"get"=>{"summary"=>"Get Tips", "description"=>"/checkins/{CHECKIN_ID}/deletecomment", "operationId"=>"checkinscheckin-iddeletecomment", "x-api-path-slug"=>"tipstip-id-get", "parameters"=>[{"in"=>"query", "name"=>"TIP_ID", "description"=>"ID of tip to retrieve"}, {"in"=>"path", "name"=>"TIP_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tips"]}}, "/tips/{TIP_ID}/done"=>{"get"=>{"summary"=>"Get Tips Done", "description"=>"/tips/search", "operationId"=>"tipssearch", "x-api-path-slug"=>"tipstip-iddone-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 200"}, {"in"=>"query", "name"=>"offset", "description"=>"Used to page through results"}, {"in"=>"query", "name"=>"TIP_ID", "description"=>"Identity of a tip to get users who have marked the tip as done"}, {"in"=>"path", "name"=>"TIP_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tips", "Done"]}}, "/tips/{TIP_ID}/listed"=>{"get"=>{"summary"=>"Get Tips Listed", "description"=>"/tips/{TIP_ID}/done", "operationId"=>"tipstip-iddone", "x-api-path-slug"=>"tipstip-idlisted-get", "parameters"=>[{"in"=>"query", "name"=>"group", "description"=>"Can be created, edited, followed, friends, other"}, {"in"=>"query", "name"=>"TIP_ID", "description"=>"Identity of a tip to get lists for"}, {"in"=>"path", "name"=>"TIP_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tips", "Listed"]}}, "/tips/{TIP_ID}/markdone"=>{"post"=>{"summary"=>"Post Tips Markdone", "description"=>"/tips/{TIP_ID}/listed", "operationId"=>"tipstip-idlisted", "x-api-path-slug"=>"tipstip-idmarkdone-post", "parameters"=>[{"in"=>"query", "name"=>"TIP_ID", "description"=>"The tip you want to mark done"}, {"in"=>"path", "name"=>"TIP_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tips", "Markdone"]}}, "/tips/{TIP_ID}/marktodo"=>{"post"=>{"summary"=>"Post Tips Marktodo", "description"=>"/tips/{TIP_ID}/markdone", "operationId"=>"tipstip-idmarkdone", "x-api-path-slug"=>"tipstip-idmarktodo-post", "parameters"=>[{"in"=>"query", "name"=>"TIP_ID", "description"=>"The tip you want to mark to-do"}, {"in"=>"path", "name"=>"TIP_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tips", "Marktodo"]}}, "/tips/{TIP_ID}/unmark"=>{"post"=>{"summary"=>"Post Tips Unmark", "description"=>"/tips/{TIP_ID}/marktodo", "operationId"=>"tipstip-idmarktodo", "x-api-path-slug"=>"tipstip-idunmark-post", "parameters"=>[{"in"=>"query", "name"=>"TIP_ID", "description"=>"The tip you want to unmark"}, {"in"=>"path", "name"=>"TIP_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tips", "Unmark"]}}, "/updates/marknotificationsread"=>{"post"=>{"summary"=>"Post Updates Marknotificationsread", "description"=>"/updates/notifications", "operationId"=>"updatesnotifications", "x-api-path-slug"=>"updatesmarknotificationsread-post", "parameters"=>[{"in"=>"query", "name"=>"highWatermark", "description"=>"The timestamp of the most recent notification that the user viewed"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Marknotificationsread"]}}, "/updates/notifications"=>{"get"=>{"summary"=>"Get Updates Notifications", "description"=>"/updates/{UPDATE_ID}", "operationId"=>"updatesupdate-id", "x-api-path-slug"=>"updatesnotifications-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return, up to 99"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Notifications"]}}, "/updates/{UPDATE_ID}"=>{"get"=>{"summary"=>"Get Updates Update", "description"=>"/lists/{LIST_ID}/updateitem", "operationId"=>"listslist-idupdateitem", "x-api-path-slug"=>"updatesupdate-id-get", "parameters"=>[{"in"=>"query", "name"=>"UPDATE_ID", "description"=>"The ID of the update to retrieve"}, {"in"=>"path", "name"=>"UPDATE_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S"]}}, "/users/leaderboard"=>{"get"=>{"summary"=>"Get Users Leaderboard", "description"=>"/users/{USER_ID}", "operationId"=>"usersuser-id", "x-api-path-slug"=>"usersleaderboard-get", "parameters"=>[{"in"=>"query", "name"=>"neighbors", "description"=>"Number of friends scores to return that are adjacent to your score, in ranked order"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Leaderboard"]}}, "/users/requests"=>{"get"=>{"summary"=>"Get Users Requests", "description"=>"/users/leaderboard", "operationId"=>"usersleaderboard", "x-api-path-slug"=>"usersrequests-get", "parameters"=>[{"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Requests"]}}, "/users/search"=>{"get"=>{"summary"=>"Get Users Search", "description"=>"/users/requests", "operationId"=>"usersrequests", "x-api-path-slug"=>"userssearch-get", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"A comma-delimited list of email addresses to look for"}, {"in"=>"query", "name"=>"fbid", "description"=>"A comma-delimited list of Facebook IDs to look for"}, {"in"=>"query", "name"=>"name", "description"=>"A single string to search for in users names"}, {"in"=>"query", "name"=>"phone", "description"=>"A comma-delimited list of phone numbers to look for"}, {"in"=>"query", "name"=>"twitter", "description"=>"A comma-delimited list of Twitter handles to look for"}, {"in"=>"query", "name"=>"twitterSource", "description"=>"A single Twitter handle"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Search"]}, "post"=>{"summary"=>"Post Users Search", "description"=>"users/search (GET)", "operationId"=>"userssearch-get", "x-api-path-slug"=>"userssearch-post", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"A comma-delimited list of email addresses to look for"}, {"in"=>"query", "name"=>"fbid", "description"=>"A comma-delimited list of Facebook IDs to look for"}, {"in"=>"query", "name"=>"name", "description"=>"A single string to search for in users names"}, {"in"=>"query", "name"=>"phone", "description"=>"A comma-delimited list of phone numbers to look for"}, {"in"=>"query", "name"=>"twitter", "description"=>"A comma-delimited list of Twitter handles to look for"}, {"in"=>"query", "name"=>"twitterSource", "description"=>"A single Twitter handle"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Search"]}}, "/users/self/update"=>{"post"=>{"summary"=>"Post Users Self Update", "description"=>"/users/{USER_ID}/unfriend", "operationId"=>"usersuser-idunfriend", "x-api-path-slug"=>"usersselfupdate-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Content type"}, {"in"=>"query", "name"=>"photo", "description"=>"Photo under 100KB in multipart MIME encoding with content type image/jpeg, image/gif, or image/png"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self"]}}, "/users/{USER_ID}"=>{"get"=>{"summary"=>"Get Users", "description"=>"", "operationId"=>"", "x-api-path-slug"=>"usersuser-id-get", "parameters"=>[{"in"=>"query", "name"=>"USER_ID", "description"=>"Identity of the user to get details for"}, {"in"=>"path", "name"=>"USER_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/{USER_ID}/approve"=>{"post"=>{"summary"=>"Post Users Approve", "description"=>"/users/{USER_ID}/venuehistory", "operationId"=>"usersuser-idvenuehistory", "x-api-path-slug"=>"usersuser-idapprove-post", "parameters"=>[{"in"=>"query", "name"=>"USER_ID", "description"=>"The user ID of a pending friend"}, {"in"=>"path", "name"=>"USER_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Approve"]}}, "/users/{USER_ID}/badges"=>{"get"=>{"summary"=>"Get Users Badges", "description"=>"users/search (POST)", "operationId"=>"userssearch-post", "x-api-path-slug"=>"usersuser-idbadges-get", "parameters"=>[{"in"=>"query", "name"=>"USER_ID", "description"=>"ID for user to view badges for"}, {"in"=>"path", "name"=>"USER_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Badges"]}}, "/users/{USER_ID}/checkins"=>{"get"=>{"summary"=>"Get Users Checkins", "description"=>"/users/{USER_ID}/badges", "operationId"=>"usersuser-idbadges", "x-api-path-slug"=>"usersuser-idcheckins-get", "parameters"=>[{"in"=>"query", "name"=>"afterTimestamp", "description"=>"Retrieve the first results to follow these seconds since epoch"}, {"in"=>"query", "name"=>"beforeTimestamp", "description"=>"Retrieve the first results prior to these seconds since epoch"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 250"}, {"in"=>"query", "name"=>"offset", "description"=>"The number of results to skip"}, {"in"=>"query", "name"=>"USER_ID", "description"=>"Identity of the user to get details for"}, {"in"=>"path", "name"=>"USER_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Checkins"]}}, "/users/{USER_ID}/deny"=>{"post"=>{"summary"=>"Post Users Deny", "description"=>"/users/{USER_ID}/approve", "operationId"=>"usersuser-idapprove", "x-api-path-slug"=>"usersuser-iddeny-post", "parameters"=>[{"in"=>"query", "name"=>"USER_ID", "description"=>"The user ID of a pending friend"}, {"in"=>"path", "name"=>"USER_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Deny"]}}, "/users/{USER_ID}/friends"=>{"get"=>{"summary"=>"Get Users Friends", "description"=>"/users/{USER_ID}/checkins", "operationId"=>"usersuser-idcheckins", "x-api-path-slug"=>"usersuser-idfriends-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 500"}, {"in"=>"query", "name"=>"offset", "description"=>"Used to page through results"}, {"in"=>"query", "name"=>"USER_ID", "description"=>"Identity of the user to get friends of"}, {"in"=>"path", "name"=>"USER_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Friends"]}}, "/users/{USER_ID}/lists"=>{"get"=>{"summary"=>"Get Users Lists", "description"=>"/users/{USER_ID}/friends", "operationId"=>"usersuser-idfriends", "x-api-path-slug"=>"usersuser-idlists-get", "parameters"=>[{"in"=>"query", "name"=>"group", "description"=>"Can be created (lists created by this user), edited (other peoples lists this user has edited), followed (lists this user follows), friends (lists from this users friends), and suggested (lists relevant to the users current location)"}, {"in"=>"query", "name"=>"ll", "description"=>"Location of the user, required in order to receive the suggested group"}, {"in"=>"query", "name"=>"USER_ID", "description"=>"Identity of the user to get lists for"}, {"in"=>"path", "name"=>"USER_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Lists"]}}, "/users/{USER_ID}/mayorships"=>{"get"=>{"summary"=>"Get Users Mayorships", "description"=>"/users/{USER_ID}/lists", "operationId"=>"usersuser-idlists", "x-api-path-slug"=>"usersuser-idmayorships-get", "parameters"=>[{"in"=>"query", "name"=>"USER_ID", "description"=>"Identity of the user to get mayorships for"}, {"in"=>"path", "name"=>"USER_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Mayorships"]}}, "/users/{USER_ID}/photos"=>{"get"=>{"summary"=>"Get Users Photos", "description"=>"/users/{USER_ID}/mayorships", "operationId"=>"usersuser-idmayorships", "x-api-path-slug"=>"usersuser-idphotos-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 500"}, {"in"=>"query", "name"=>"offset", "description"=>"Used to page through results"}, {"in"=>"query", "name"=>"USER_ID", "description"=>"Identity of the user to get details for"}, {"in"=>"path", "name"=>"USER_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Photos"]}}, "/users/{USER_ID}/request"=>{"post"=>{"summary"=>"Post Users Request", "description"=>"/users/{USER_ID}/deny", "operationId"=>"usersuser-iddeny", "x-api-path-slug"=>"usersuser-idrequest-post", "parameters"=>[{"in"=>"query", "name"=>"USER_ID", "description"=>"The user ID to which a request will be sent"}, {"in"=>"path", "name"=>"USER_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Request"]}}, "/users/{USER_ID}/setpings"=>{"post"=>{"summary"=>"Post Users Setpings", "description"=>"/users/{USER_ID}/request", "operationId"=>"usersuser-idrequest", "x-api-path-slug"=>"usersuser-idsetpings-post", "parameters"=>[{"in"=>"query", "name"=>"USER_ID", "description"=>"The user ID of a friend"}, {"in"=>"path", "name"=>"USER_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"value", "description"=>"The value to set: true or false"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Setpings"]}}, "/users/{USER_ID}/tips"=>{"get"=>{"summary"=>"Get Users Tips", "description"=>"/users/{USER_ID}/photos", "operationId"=>"usersuser-idphotos", "x-api-path-slug"=>"usersuser-idtips-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 500"}, {"in"=>"query", "name"=>"ll", "description"=>"Latitude and longitude of the users location"}, {"in"=>"query", "name"=>"offset", "description"=>"Used to page through results"}, {"in"=>"query", "name"=>"sort", "description"=>"One of recent, nearby, or popular"}, {"in"=>"query", "name"=>"USER_ID", "description"=>"Identity of the user to get tips from"}, {"in"=>"path", "name"=>"USER_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Tips"]}}, "/users/{USER_ID}/todos"=>{"get"=>{"summary"=>"Get Users Todos", "description"=>"/users/{USER_ID}/tips", "operationId"=>"usersuser-idtips", "x-api-path-slug"=>"usersuser-idtodos-get", "parameters"=>[{"in"=>"query", "name"=>"ll", "description"=>"Latitude and longitude of the users location"}, {"in"=>"query", "name"=>"sort", "description"=>"One of nearby or recent"}, {"in"=>"query", "name"=>"USER_ID", "description"=>"Identity of the user to get todos for"}, {"in"=>"path", "name"=>"USER_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Todos"]}}, "/users/{USER_ID}/unfriend"=>{"post"=>{"summary"=>"Post Users Unfriend", "description"=>"/users/{USER_ID}/setpings", "operationId"=>"usersuser-idsetpings", "x-api-path-slug"=>"usersuser-idunfriend-post", "parameters"=>[{"in"=>"query", "name"=>"USER_ID", "description"=>"Identity of the user to unfriend"}, {"in"=>"path", "name"=>"USER_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Unfriend"]}}, "/users/{USER_ID}/venuehistory"=>{"get"=>{"summary"=>"Get Users Venuehistory", "description"=>"/users/{USER_ID}/todos", "operationId"=>"usersuser-idtodos", "x-api-path-slug"=>"usersuser-idvenuehistory-get", "parameters"=>[{"in"=>"query", "name"=>"afterTimestamp", "description"=>"Seconds after epoch"}, {"in"=>"query", "name"=>"beforeTimestamp", "description"=>"Seconds since epoch"}, {"in"=>"query", "name"=>"categoryId", "description"=>"Limits returned venues to those in this category"}, {"in"=>"query", "name"=>"USER_ID", "description"=>"Identity of the user to get details for"}, {"in"=>"path", "name"=>"USER_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Venuehistory"]}}, "/venuegroups/add"=>{"post"=>{"summary"=>"Post Venuegroups Add", "description"=>"/venuegroups/{GROUP_ID}", "operationId"=>"venuegroupsgroup-id", "x-api-path-slug"=>"venuegroupsadd-post", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"The name to give the group"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venuegroups"]}}, "/venuegroups/list"=>{"get"=>{"summary"=>"Get Venuegroups List", "description"=>"/venuegroups/{GROUP_ID}/delete", "operationId"=>"venuegroupsgroup-iddelete", "x-api-path-slug"=>"venuegroupslist-get", "parameters"=>[{"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venuegroups", "List"]}}, "/venuegroups/{GROUP_ID}"=>{"get"=>{"summary"=>"Get Venuegroups Group", "description"=>"/venues/{VENUE_ID}/proposeedit", "operationId"=>"venuesvenue-idproposeedit", "x-api-path-slug"=>"venuegroupsgroup-id-get", "parameters"=>[{"in"=>"query", "name"=>"GROUP_ID", "description"=>"The ID of the venue group to retrieve additional information for"}, {"in"=>"path", "name"=>"GROUP_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venuegroups", "Group"]}}, "/venuegroups/{GROUP_ID}/addvenue"=>{"post"=>{"summary"=>"Post Venuegroups Group Addvenue", "description"=>"/venuegroups/list", "operationId"=>"venuegroupslist", "x-api-path-slug"=>"venuegroupsgroup-idaddvenue-post", "parameters"=>[{"in"=>"query", "name"=>"GROUP_ID", "description"=>"The ID of the venue group"}, {"in"=>"path", "name"=>"GROUP_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"venueId", "description"=>"Comma-delimited list of venue IDs to add to the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venuegroups", "Group", "Venue"]}}, "/venuegroups/{GROUP_ID}/delete"=>{"post"=>{"summary"=>"Post Venuegroups Group Delete", "description"=>"/venuegroups/add", "operationId"=>"venuegroupsadd", "x-api-path-slug"=>"venuegroupsgroup-iddelete-post", "parameters"=>[{"in"=>"query", "name"=>"GROUP_ID", "description"=>"The ID of the venue group to delete"}, {"in"=>"path", "name"=>"GROUP_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venuegroups", "Group"]}}, "/venuegroups/{GROUP_ID}/removevenue"=>{"post"=>{"summary"=>"Post Venuegroups Group Removevenue", "description"=>"/venuegroups/{GROUP_ID}/addvenue", "operationId"=>"venuegroupsgroup-idaddvenue", "x-api-path-slug"=>"venuegroupsgroup-idremovevenue-post", "parameters"=>[{"in"=>"query", "name"=>"GROUP_ID", "description"=>"The ID of the venue group"}, {"in"=>"path", "name"=>"GROUP_ID"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"venueId", "description"=>"Comma-delimited list of venue IDs to remove from the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venuegroups", "Group", "Removevenue"]}}, "/venues/add"=>{"post"=>{"summary"=>"Post Venues Add", "description"=>"/venues/{VENUE_ID}", "operationId"=>"venuesvenue-id", "x-api-path-slug"=>"venuesadd-post", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"The address of the venue"}, {"in"=>"query", "name"=>"city", "description"=>"The city name where this venue is"}, {"in"=>"query", "name"=>"crossStreet", "description"=>"The nearest intersecting street or streets"}, {"in"=>"query", "name"=>"description", "description"=>"A freeform description of the venue, up to 300 characters"}, {"in"=>"query", "name"=>"ignoreDuplicates", "description"=>"A boolean flag telling the server to ignore duplicates and force the addition of this venue"}, {"in"=>"query", "name"=>"ignoreDuplicatesKey", "description"=>"Required if ignoreDuplicates is true"}, {"in"=>"query", "name"=>"ll", "description"=>"Latitude and longitude of the venue, as accurate as is known"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the venue"}, {"in"=>"query", "name"=>"phone", "description"=>"The phone number of the venue"}, {"in"=>"query", "name"=>"primaryCategoryId", "description"=>"The ID of the category to which you want to assign this venue"}, {"in"=>"query", "name"=>"state", "description"=>"The nearest state or province to the venue"}, {"in"=>"query", "name"=>"twitter", "description"=>"The twitter handle of the venue"}, {"in"=>"query", "name"=>"url", "description"=>"The url of the homepage of the venue"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"zip", "description"=>"The zip or postal code for the venue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues"]}}, "/venues/categories"=>{"get"=>{"summary"=>"Get Venues Categories", "description"=>"/venues/add", "operationId"=>"venuesadd", "x-api-path-slug"=>"venuescategories-get", "parameters"=>[{"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Categories"]}}, "/venues/explore"=>{"get"=>{"summary"=>"Get Venues Explore", "description"=>"/venues/categories", "operationId"=>"venuescategories", "x-api-path-slug"=>"venuesexplore-get", "parameters"=>[{"in"=>"query", "name"=>"alt", "description"=>"Altitude of the users location, in meters"}, {"in"=>"query", "name"=>"altAcc", "description"=>"Accuracy of the users altitude, in meters"}, {"in"=>"query", "name"=>"intent", "description"=>"Limit results to venues with specials"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 50"}, {"in"=>"query", "name"=>"ll", "description"=>"Latitude and longitude of the users location, so response can include distance"}, {"in"=>"query", "name"=>"llAcc", "description"=>"Accuracy of latitude and longitude, in meters"}, {"in"=>"query", "name"=>"novelty", "description"=>"Pass new or old to limit results to places the acting user hasnt been or has been, respectively"}, {"in"=>"query", "name"=>"query", "description"=>"A search term to be applied against tips, category, tips, etc"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius to search within, in meters"}, {"in"=>"query", "name"=>"section", "description"=>"One of food, drinks, coffee, shops, arts, or outdoors"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Explore"]}}, "/venues/managed"=>{"get"=>{"summary"=>"Get Venues Managed", "description"=>"/venues/explore", "operationId"=>"venuesexplore", "x-api-path-slug"=>"venuesmanaged-get", "parameters"=>[{"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Managed"]}}, "/venues/search"=>{"get"=>{"summary"=>"Get Venues Search", "description"=>"/venues/managed", "operationId"=>"venuesmanaged", "x-api-path-slug"=>"venuessearch-get", "parameters"=>[{"in"=>"query", "name"=>"alt", "description"=>"Altitude of the users location, in meters"}, {"in"=>"query", "name"=>"altAcc", "description"=>"Accuracy of the users altitude, in meters"}, {"in"=>"query", "name"=>"categoryId", "description"=>"A comma separated list of categories to limit results to"}, {"in"=>"query", "name"=>"intent", "description"=>"One of the values checkin, browse or match, indicating your intent in performing the search"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 50"}, {"in"=>"query", "name"=>"linkedId", "description"=>"Identifier used by third party specified in providerId, which we will attempt to match against our map of venues to URLs"}, {"in"=>"query", "name"=>"ll", "description"=>"Latitude and longitude of the users location, so response can include distance"}, {"in"=>"query", "name"=>"llAcc", "description"=>"Accuracy of latitude and longitude, in meters"}, {"in"=>"query", "name"=>"ne", "description"=>"See sw"}, {"in"=>"query", "name"=>"providerId", "description"=>"Identifier for a known third party that is part of our map of venues to URLs, used in conjunction with linkedId"}, {"in"=>"query", "name"=>"query", "description"=>"A search term to be applied against venue names"}, {"in"=>"query", "name"=>"radius", "description"=>"Limit results to venues within this many meters of the specified location"}, {"in"=>"query", "name"=>"sw", "description"=>"With ne, limits results to the bounding quadrangle defined by the latitude and longitude given by sw as its south-west corner, and ne as its north-east corner"}, {"in"=>"query", "name"=>"url", "description"=>"A third-party URL which we will attempt to match against our map of venues to URLs"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Search"]}}, "/venues/suggestcompletion"=>{"get"=>{"summary"=>"Get Venues Suggestcompletion", "description"=>"/venues/search", "operationId"=>"venuessearch", "x-api-path-slug"=>"venuessuggestcompletion-get", "parameters"=>[{"in"=>"query", "name"=>"alt", "description"=>"Altitude of the users location, in meters"}, {"in"=>"query", "name"=>"altAcc", "description"=>"Accuracy of the users altitude, in meters"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 100"}, {"in"=>"query", "name"=>"ll", "description"=>"Latitude and longitude of the users location"}, {"in"=>"query", "name"=>"llAcc", "description"=>"Accuracy of latitude and longitude, in meters"}, {"in"=>"query", "name"=>"query", "description"=>"A search term to be applied against titles"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Suggestcompletion"]}}, "/venues/timeseries"=>{"get"=>{"summary"=>"Get Venues Timeseries", "description"=>"/venues/suggestcompletion", "operationId"=>"venuessuggestcompletion", "x-api-path-slug"=>"venuestimeseries-get", "parameters"=>[{"in"=>"query", "name"=>"endAt", "description"=>"The end of the time range to retrieve stats for (seconds since epoch)"}, {"in"=>"query", "name"=>"startAt", "description"=>"The start of the time range to retrieve stats for (seconds since epoch)"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"venueId", "description"=>"A comma-separated list of venue ids to retrieve series data for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Timeseries"]}}, "/venues/trending"=>{"get"=>{"summary"=>"Get Venues Trending", "description"=>"/venues/timeseries", "operationId"=>"venuestimeseries", "x-api-path-slug"=>"venuestrending-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 50"}, {"in"=>"query", "name"=>"ll", "description"=>"Latitude and longitude of the users location"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius in meters, up to approximately 2000 meters"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Trending"]}}, "/venues/{VENUE_ID}"=>{"get"=>{"summary"=>"Get Venues", "description"=>"/users/self/update", "operationId"=>"usersselfupdate", "x-api-path-slug"=>"venuesvenue-id-get", "parameters"=>[{"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"VENUE_ID", "description"=>"ID of venue to retrieve"}, {"in"=>"path", "name"=>"VENUE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues"]}}, "/venues/{VENUE_ID}/edit"=>{"post"=>{"summary"=>"Post Venues Edit", "description"=>"/venues/{VENUE_ID}/tips", "operationId"=>"venuesvenue-idtips", "x-api-path-slug"=>"venuesvenue-idedit-post", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"The address of the venue"}, {"in"=>"query", "name"=>"categoryId", "description"=>"The IDs of the category or categories to which you want to assign this venue (separate multiple IDs with commas)"}, {"in"=>"query", "name"=>"city", "description"=>"The city name where this venue is"}, {"in"=>"query", "name"=>"crossStreet", "description"=>"The nearest intersecting street or streets"}, {"in"=>"query", "name"=>"description", "description"=>"A freeform description of the venue, up to 300 characters"}, {"in"=>"query", "name"=>"ll", "description"=>"Latitude and longitude of the venue"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the venue"}, {"in"=>"query", "name"=>"phone", "description"=>"The phone number of the venue"}, {"in"=>"query", "name"=>"state", "description"=>"The nearest state or province to the venue"}, {"in"=>"query", "name"=>"twitter", "description"=>"The twitter handle of the venue"}, {"in"=>"query", "name"=>"url", "description"=>"The url of the homepage of the venue"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"VENUE_ID", "description"=>"The venue id to edit"}, {"in"=>"path", "name"=>"VENUE_ID"}, {"in"=>"query", "name"=>"zip", "description"=>"The zip or postal code for the venue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Edit"]}}, "/venues/{VENUE_ID}/events"=>{"get"=>{"summary"=>"Get Venues Events", "description"=>"/venues/trending", "operationId"=>"venuestrending", "x-api-path-slug"=>"venuesvenue-idevents-get", "parameters"=>[{"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"VENUE_ID", "description"=>"The venue id for which events are being requested"}, {"in"=>"path", "name"=>"VENUE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Events"]}}, "/venues/{VENUE_ID}/flag"=>{"post"=>{"summary"=>"Post Venues Flag", "description"=>"/venues/{VENUE_ID}/edit", "operationId"=>"venuesvenue-idedit", "x-api-path-slug"=>"venuesvenue-idflag-post", "parameters"=>[{"in"=>"query", "name"=>"problem", "description"=>"One of mislocated, closed, duplicate, inappropriate, doesnt_exist, event_over"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"venueId", "description"=>"ID of the duplicated venue (for problem duplicate)"}, {"in"=>"query", "name"=>"VENUE_ID", "description"=>"The venue id for which an edit is being proposed"}, {"in"=>"path", "name"=>"VENUE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Flag"]}}, "/venues/{VENUE_ID}/herenow"=>{"get"=>{"summary"=>"Get Venues Herenow", "description"=>"/venues/{VENUE_ID}/events", "operationId"=>"venuesvenue-idevents", "x-api-path-slug"=>"venuesvenue-idherenow-get", "parameters"=>[{"in"=>"query", "name"=>"afterTimestamp", "description"=>"Retrieve the first results to follow these seconds since epoch"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 500"}, {"in"=>"query", "name"=>"offset", "description"=>"Used to page through results"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"VENUE_ID", "description"=>"ID of venue to retrieve"}, {"in"=>"path", "name"=>"VENUE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Herenow"]}}, "/venues/{VENUE_ID}/links"=>{"get"=>{"summary"=>"Get Venues Links", "description"=>"/venues/{VENUE_ID}/herenow", "operationId"=>"venuesvenue-idherenow", "x-api-path-slug"=>"venuesvenue-idlinks-get", "parameters"=>[{"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"VENUE_ID", "description"=>"The venue you want annotations for"}, {"in"=>"path", "name"=>"VENUE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Links"]}}, "/venues/{VENUE_ID}/listed"=>{"get"=>{"summary"=>"Get Venues Listed", "description"=>"/venues/{VENUE_ID}/links", "operationId"=>"venuesvenue-idlinks", "x-api-path-slug"=>"venuesvenue-idlisted-get", "parameters"=>[{"in"=>"query", "name"=>"group", "description"=>"Can be created, edited, followed, friends, other"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 200"}, {"in"=>"query", "name"=>"offset", "description"=>"Used to page through results"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"VENUE_ID", "description"=>"Identity of a venue to get lists for"}, {"in"=>"path", "name"=>"VENUE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Listed"]}}, "/venues/{VENUE_ID}/marktodo"=>{"post"=>{"summary"=>"Post Venues Marktodo", "description"=>"/venues/{VENUE_ID}/flag", "operationId"=>"venuesvenue-idflag", "x-api-path-slug"=>"venuesvenue-idmarktodo-post", "parameters"=>[{"in"=>"query", "name"=>"text", "description"=>"The text of the tip"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"VENUE_ID", "description"=>"The venue you want to mark to-do"}, {"in"=>"path", "name"=>"VENUE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Marktodo"]}}, "/venues/{VENUE_ID}/menu"=>{"get"=>{"summary"=>"Get Venues Menu", "description"=>"/venues/{VENUE_ID}/listed", "operationId"=>"venuesvenue-idlisted", "x-api-path-slug"=>"venuesvenue-idmenu-get", "parameters"=>[{"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"VENUE_ID", "description"=>"The venue id for which menu is being requested"}, {"in"=>"path", "name"=>"VENUE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Menu"]}}, "/venues/{VENUE_ID}/photos"=>{"get"=>{"summary"=>"Get Venues Photos", "description"=>"/venues/{VENUE_ID}/menu", "operationId"=>"venuesvenue-idmenu", "x-api-path-slug"=>"venuesvenue-idphotos-get", "parameters"=>[{"in"=>"query", "name"=>"group", "description"=>"Pass checkin for photos added by friends on their recent checkins"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 500"}, {"in"=>"query", "name"=>"offset", "description"=>"Used to page through results"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"VENUE_ID", "description"=>"The venue you want photos for"}, {"in"=>"path", "name"=>"VENUE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Photos"]}}, "/venues/{VENUE_ID}/proposeedit"=>{"post"=>{"summary"=>"Post Venues Proposeedit", "description"=>"/venues/{VENUE_ID}/marktodo", "operationId"=>"venuesvenue-idmarktodo", "x-api-path-slug"=>"venuesvenue-idproposeedit-post", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"The address of the venue"}, {"in"=>"query", "name"=>"city", "description"=>"The city name where this venue is"}, {"in"=>"query", "name"=>"crossStreet", "description"=>"The nearest intersecting street or streets"}, {"in"=>"query", "name"=>"ll", "description"=>"Latitude and longitude of the venue, as accurate as is known"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the venue"}, {"in"=>"query", "name"=>"phone", "description"=>"The phone number of the venue"}, {"in"=>"query", "name"=>"primaryCategoryId", "description"=>"The ID of the category to which you want to assign this venue"}, {"in"=>"query", "name"=>"state", "description"=>"The nearest state or province to the venue"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"VENUE_ID", "description"=>"The venue id for which an edit is being proposed"}, {"in"=>"path", "name"=>"VENUE_ID"}, {"in"=>"query", "name"=>"zip", "description"=>"The zip or postal code for the venue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Proposeedit"]}}, "/venues/{VENUE_ID}/similar"=>{"get"=>{"summary"=>"Get Venues Similar", "description"=>"/venues/{VENUE_ID}/photos", "operationId"=>"venuesvenue-idphotos", "x-api-path-slug"=>"venuesvenue-idsimilar-get", "parameters"=>[{"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"VENUE_ID", "description"=>"The venue you want similar venues for"}, {"in"=>"path", "name"=>"VENUE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Similar"]}}, "/venues/{VENUE_ID}/stats"=>{"get"=>{"summary"=>"Get Venues Stats", "description"=>"/venues/{VENUE_ID}/similar", "operationId"=>"venuesvenue-idsimilar", "x-api-path-slug"=>"venuesvenue-idstats-get", "parameters"=>[{"in"=>"query", "name"=>"endAt", "description"=>"The end of the time range to retrieve stats for (seconds since epoch)"}, {"in"=>"query", "name"=>"startAt", "description"=>"The start of the time range to retrieve stats for (seconds since epoch)"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"VENUE_ID", "description"=>"The venue id to retrieve stats for"}, {"in"=>"path", "name"=>"VENUE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Stats"]}}, "/venues/{VENUE_ID}/tips"=>{"get"=>{"summary"=>"Get Venues Tips", "description"=>"/venues/{VENUE_ID}/stats", "operationId"=>"venuesvenue-idstats", "x-api-path-slug"=>"venuesvenue-idtips-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Number of results to return, up to 500"}, {"in"=>"query", "name"=>"offset", "description"=>"Used to page through results"}, {"in"=>"query", "name"=>"sort", "description"=>"One of friends, recent, or popular"}, {"in"=>"query", "name"=>"v", "description"=>"All requests now accept a v=YYYYMMDD param, which indicates that the client is up to date as of the specified date"}, {"in"=>"query", "name"=>"VENUE_ID", "description"=>"The venue where you want to add this tip"}, {"in"=>"path", "name"=>"VENUE_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Tips"]}}}}, "apis"=>{"name"=>"Foursquare", "x-slug"=>"foursquare", "description"=>"Foursquare helps you find the perfect places to go with friends. Discover the best food, nightlife, and entertainment in your area.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/203-foursquare.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"2544", "tags"=>"API Provider,Checkins,Coupons,Deals,Games,General Data,Getting Started Example,Historical Data API,internet,Local,Locations,Locations,Merchants,Mobile,Pedestal,Places,Profiles,Relative Data,Social,Stack,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"foursquare/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Foursquare", "x-api-slug"=>"foursquare", "description"=>"foursquare makes the real world easier to use. We build tools that help you keep up with friends, discover what???s nearby, save money and unlock deals. Whether you???re setting off on a trip around the world, coordinating a night out with friends, or trying to pick out the best dish at your local restaurant, foursquare is the perfect companion. The foursquare API gives you access to all of the data used by the foursquare mobile applications, and, in some cases, even more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/203-foursquare.jpg", "humanURL"=>"http://blog.foursquare.com", "baseURL"=>"https://api.foursquare.com//v2/", "tags"=>"API Provider,Checkins,Coupons,Deals,Games,General Data,Getting Started Example,Historical Data API,internet,Local,Locations,Locations,Merchants,Mobile,Pedestal,Places,Profiles,Relative Data,Social,Stack,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/foursquare/venuesvenue-idtips-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/foursquare/foursquare-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-api-json--authoritative", "url"=>"http://apis.io/apisdef/legacy/foursquare.json"}, {"type"=>"x-apigee-console", "url"=>"https://api.apigee.com/v1/consoles/foursquare/apidescription?format=internal&ver=1393644831000"}, {"type"=>"x-application-management", "url"=>"https://foursquare.com/developers/apps"}, {"type"=>"x-blog", "url"=>"http://engineering.foursquare.com/"}, {"type"=>"x-blog-rss", "url"=>"http://engineering.foursquare.com/feed/"}, {"type"=>"x-curated-source", "url"=>"http://blog.foursquare.com/2013/09/17/we-put-a-fresh-coat-of-paint-on-foursquare-for-ios-7/"}, {"type"=>"x-website", "url"=>"http://blog.foursquare.com"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/foursquare"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/foursquare"}, {"type"=>"x-email", "url"=>"support@foursquare.com"}, {"type"=>"x-email", "url"=>"ads@foursquare.com"}, {"type"=>"x-email", "url"=>"press@foursquare.com"}, {"type"=>"x-email", "url"=>"security@foursquare.com"}, {"type"=>"x-email", "url"=>"feedback@foursquare.com"}, {"type"=>"x-email", "url"=>"privacy@foursquare.com"}, {"type"=>"x-error-codes", "url"=>"https://developer.foursquare.com/overview/responses"}, {"type"=>"x-foursquare", "url"=>"http://foursquare.com/nasa"}, {"type"=>"x-foursquare", "url"=>"http://foursquare.com/yourcommissary"}, {"type"=>"x-getting-started", "url"=>"https://developer.foursquare.com/start"}, {"type"=>"x-github", "url"=>"https://github.com/foursquare"}, {"type"=>"x-privacy", "url"=>"https://foursquare.com/legal/privacy"}, {"type"=>"x-rate-limits", "url"=>"https://developer.foursquare.com/overview/ratelimits"}, {"type"=>"x-stack-overflow", "url"=>"http://stackoverflow.com/questions/tagged/foursquare"}, {"type"=>"x-terms-of-service", "url"=>"https://developer.foursquare.com/overview/community"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/foursquare"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/foursquareapi"}, {"type"=>"x-website", "url"=>"http://foursquare.com"}, {"type"=>"x-website", "url"=>"https://developer.foursquare.com/"}, {"type"=>"x-website", "url"=>"https://foursquare.com/apps/slack"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-pinpoint{"aws-pinpoint-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Pinpoint", "x-complete"=>1, "info"=>{"title"=>"AWS Pinpoint API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/apps/application-id/campaigns/campaign-id/activities"=>{"get"=>{"summary"=>"Campaign Activities", "description"=>"Returns information about the activity performed by a campaign, such as the time during which the campaign ran and the number of endpoints to which it delivered messages. You can use this resource to look up activity information by app ID and campaign ID.", "operationId"=>"campaignActivities", "x-api-path-slug"=>"appsapplicationidcampaignscampaignidactivities-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"Specify the media type you will accept as a response: application/json ??? A JSON response body", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"page-size", "description"=>"The number of entries you want on each page in the response", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"token", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaign Activities"]}}, "/apps/application-id/campaigns/"=>{"get"=>{"summary"=>"Get Campaigns", "description"=>"Campaigns are messaging initiatives that engage specific segments of end users. The information represented by this resource includes the segment that the campaign reaches out to, the message that it delivers, and the schedule on which it runs. You can use this resource to look up, create, update, or delete campaigns.", "operationId"=>"campaigns", "x-api-path-slug"=>"appsapplicationidcampaigns-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"Specify the media type you will accept as a response: application/json ??? A JSON response body", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"page-size", "description"=>"The number of entries you want on each page in the response", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"An identifier used to retrieve the next page of results", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaign"]}, "put"=>{"summary"=>"Add Campaign", "description"=>"Use the POST method to create or update a campaign.", "operationId"=>"addCampaign", "x-api-path-slug"=>"appsapplicationidcampaigns-put", "parameters"=>[{"schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaign"]}}, "/apps/application-id/campaigns/campaign-id"=>{"get"=>{"summary"=>"Campaign Instance", "description"=>"Use the GET method to request information about a campaign.", "operationId"=>"getCampaign", "x-api-path-slug"=>"appsapplicationidcampaignscampaignid-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"Specify the media type you will accept as a response: application/json ??? A JSON response body", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaign"]}, "put"=>{"summary"=>"Update Campaign Instance", "description"=>"Use the PUT method to update a campaign.", "operationId"=>"updateCampaign", "x-api-path-slug"=>"appsapplicationidcampaignscampaignid-put", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"Specify the media type you will accept as a response: application/json ??? A JSON response body", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaign"]}, "delete"=>{"summary"=>"Delete Campaign Instance", "description"=>"Use the DELETE method to delete a campaign.", "operationId"=>"deleteCampaign", "x-api-path-slug"=>"appsapplicationidcampaignscampaignid-delete", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"Specify the media type you will accept as a response: application/json ??? A JSON response body", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaign"]}}, "/apps/application-id/campaigns/campaign-id/versions"=>{"get"=>{"summary"=>"Campaign Versions List", "description"=>"Use the GET method to request information about your campaign versions.", "operationId"=>"getVersonsList", "x-api-path-slug"=>"appsapplicationidcampaignscampaignidversions-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"Specify the media type you will accept as a response: application/json ??? A JSON response body", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"page-size", "description"=>"The number of entries you want on each page in the response", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"token", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaign Versions"]}}, "/apps/application-id/campaigns/campaign-id/versions/version"=>{"get"=>{"summary"=>"Campaign Version Instance", "description"=>"Use the GET method to request information about a campaign version.", "operationId"=>"campaignVersionInstance", "x-api-path-slug"=>"appsapplicationidcampaignscampaignidversionsversion-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"Specify the media type you will accept as a response: application/json ??? A JSON response body", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaign Version"]}}, "/apps/application-id/endpoints"=>{"put"=>{"summary"=>"Endpoints List", "description"=>"Use the PUT method to update your endpoints.", "operationId"=>"updateEndpointsList", "x-api-path-slug"=>"appsapplicationidendpoints-put", "parameters"=>[{"in"=>"query", "name"=>"accept", "description"=>"Specify the media type you will accept as a response: application/json ??? A JSON response body", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoint"]}}, "/apps/application-id/endpoints/endpoint-id"=>{"get"=>{"summary"=>"Endpoint Instance", "description"=>"Use the GET method to request information about an endpoint.", "operationId"=>"getEndpointInstance", "x-api-path-slug"=>"appsapplicationidendpointsendpointid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoint"]}, "put"=>{"summary"=>"Update Endpoint Instance", "description"=>"Use the PUT method to update an endpoint.", "operationId"=>"updateEndpointInstance", "x-api-path-slug"=>"appsapplicationidendpointsendpointid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoint"]}}, "/apps/application-id/jobs/import"=>{"get"=>{"summary"=>"Import Job List", "description"=>"Use the GET method to request information about your import jobs.", "operationId"=>"importJobList", "x-api-path-slug"=>"appsapplicationidjobsimport-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import Job"]}, "post"=>{"summary"=>"Update Import Job List", "description"=>"Use the POST method to create or update an import job.", "operationId"=>"updateImportJobList", "x-api-path-slug"=>"appsapplicationidjobsimport-post", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"Specify the media type you will accept as a response: application/json ??? A JSON response body", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import Job"]}}, "/apps/application-id/segments/segment-id/jobs/import"=>{"get"=>{"summary"=>"Import Job List by Segment", "description"=>"Use the GET method to request information about the import jobs for a segment.", "operationId"=>"importJobListbySegment", "x-api-path-slug"=>"appsapplicationidsegmentssegmentidjobsimport-get", "parameters"=>[{"in"=>"header", "name"=>"accept", "description"=>"Specify the media type you will accept as a response: application/json ??? A JSON response body", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import Job"]}}, "/apps/application-id/jobs/import/{job-id}"=>{"get"=>{"summary"=>"Import Job Instance", "description"=>"Use the GET method to request information about an import job.", "operationId"=>"importJobInstance", "x-api-path-slug"=>"appsapplicationidjobsimportjobid-get", "parameters"=>[{"in"=>"path", "name"=>"job-id", "description"=>"The job id", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import Job"]}}, "/apps/application-id/segments"=>{"get"=>{"summary"=>"Segments List", "description"=>"Use the GET method to request information about your segments.", "operationId"=>"segmentsList", "x-api-path-slug"=>"appsapplicationidsegments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Segments"]}, "post"=>{"summary"=>"Segments List", "description"=>"Use the POST method to create or update a segment.", "operationId"=>"addSegmentsList", "x-api-path-slug"=>"appsapplicationidsegments-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Segments"]}}, "/apps/application-id/segments/segment-id"=>{"get"=>{"summary"=>"Segment Instance", "description"=>"Use the GET method to request information about a segment.", "operationId"=>"getSegmentInstance", "x-api-path-slug"=>"appsapplicationidsegmentssegmentid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Segments"]}, "put"=>{"summary"=>"Segment Instance", "description"=>"Use the PUT method to update a segment.", "operationId"=>"updateSegmentInstance", "x-api-path-slug"=>"appsapplicationidsegmentssegmentid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Segments"]}, "delete"=>{"summary"=>"Segment Instance", "description"=>"Use the DELETE method to delete a segment.", "operationId"=>"deleteSegmentInstance", "x-api-path-slug"=>"appsapplicationidsegmentssegmentid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Segments"]}}, "/apps/application-id/segment/versions"=>{"get"=>{"summary"=>"Segment Versions List", "description"=>"Use the GET method to request information about your segment versions.", "operationId"=>"getSegmentVersionsList", "x-api-path-slug"=>"appsapplicationidsegmentversions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Segments"]}}, "/apps/application-id/segments/segment-id/versions/version"=>{"get"=>{"summary"=>"Segment Version Instance", "description"=>"Use the GET method to request information about a segment version.", "operationId"=>"getSegmentVersionInstance", "x-api-path-slug"=>"appsapplicationidsegmentssegmentidversionsversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Segments"]}}, "/apps/application-id/settings"=>{"get"=>{"summary"=>"Get URI", "description"=>"Use the GET method to request the settings for an app.", "operationId"=>"getURI", "x-api-path-slug"=>"appsapplicationidsettings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["URI"]}, "put"=>{"summary"=>"Update URI", "description"=>"Use the PUT method to update the settings for an app.", "operationId"=>"updateURI", "x-api-path-slug"=>"appsapplicationidsettings-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["URI"]}}}}, "apis"=>{"name"=>"AWS Pinpoint", "x-slug"=>"aws-pinpoint", "description"=>"Amazon Pinpoint makes it easy to run targeted campaigns to drive user engagement in mobile apps. Amazon Pinpoint helps you understand user behavior, define which users to target, determine which messages to send, schedule the best time to deliver the messages, and then track the results of your campaign.Targeted push notifications based on app usage trends and user behavior have become a popular approach for mobile app user engagement because response rates are often several times higher than tradition email marketing campaigns. By using targeted push notifications, you can increase message relevance and effectiveness, measure engagement, and continually improve your campaigns.Getting started with Amazon Pinpoint is easy. First, AWS Mobile Hub guides you through the process to integrate the AWS Mobile SDK with your app. Next, you define your target segments, campaign message, and specify the delivery schedule. Once your campaign is running, Pinpoint provides metrics so you can run analytics and track the impact of your campaign.With Amazon Pinpoint, there are no upfront setup costs, and no fixed monthly cost. You only pay for the number of users your campaign targets, the messages you send, and the events you collect, so you can start small and scale as your application grows.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-pinpoint.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Marketing,Marketing,Mobile,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-pinpoint/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Pinpoint API", "x-api-slug"=>"aws-pinpoint-api", "description"=>"Amazon Pinpoint makes it easy to run targeted campaigns to drive user engagement in mobile apps. Amazon Pinpoint helps you understand user behavior, define which users to target, determine which messages to send, schedule the best time to deliver the messages, and then track the results of your campaign.Targeted push notifications based on app usage trends and user behavior have become a popular approach for mobile app user engagement because response rates are often several times higher than tradition email marketing campaigns. By using targeted push notifications, you can increase message relevance and effectiveness, measure engagement, and continually improve your campaigns.Getting started with Amazon Pinpoint is easy. First, AWS Mobile Hub guides you through the process to integrate the AWS Mobile SDK with your app. Next, you define your target segments, campaign message, and specify the delivery schedule. Once your campaign is running, Pinpoint provides metrics so you can run analytics and track the impact of your campaign.With Amazon Pinpoint, there are no upfront setup costs, and no fixed monthly cost. You only pay for the number of users your campaign targets, the messages you send, and the events you collect, so you can start small and scale as your application grows.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-pinpoint.jpg", "humanURL"=>"https://aws.amazon.com/pinpoint/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Marketing,Marketing,Mobile,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-pinpoint/aws-pinpoint-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://aws.amazon.com/blogs/aws/amazon-pinpoint-hit-your-targets-with-aws/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/pinpoint/latest/apireference/welcome.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/pinpoint/faqs/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/pinpoint/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/pinpoint/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-lambda{"aws-lambda-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Lambda", "x-complete"=>1, "info"=>{"title"=>"AWS Lambda API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddPermission"=>{"get"=>{"summary"=>"Add Permission", "description"=>"Adds a permission to the resource policy associated with the specified AWS Lambda function.", "operationId"=>"addPermission", "x-api-path-slug"=>"actionaddpermission-get", "parameters"=>[{"in"=>"query", "name"=>"FunctionName", "description"=>"Name of the Lambda function whose resource policy you are updating by adding a new permission", "type"=>"string"}, {"in"=>"query", "name"=>"Qualifier", "description"=>"You can use this optional query parameter to describe a qualified ARN using a function version or an alias name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permissions"]}}, "/?Action=CreateAlias"=>{"get"=>{"summary"=>"Create Alias", "description"=>"Creates an alias that points to the specified Lambda function version.", "operationId"=>"createAlias", "x-api-path-slug"=>"actioncreatealias-get", "parameters"=>[{"in"=>"query", "name"=>"FunctionName", "description"=>"Name of the Lambda function for which you want to create an alias", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Aliases"]}}, "/?Action=CreateEventSourceMapping"=>{"get"=>{"summary"=>"Create Event Source Mapping", "description"=>"Identifies a stream as an event source for a Lambda function.", "operationId"=>"createEventSourceMapping", "x-api-path-slug"=>"actioncreateeventsourcemapping-get", "parameters"=>[{"in"=>"query", "name"=>"BatchSize", "description"=>"The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function", "type"=>"string"}, {"in"=>"query", "name"=>"Enabled", "description"=>"Indicates whether AWS Lambda should begin polling the event source", "type"=>"string"}, {"in"=>"query", "name"=>"EventSourceArn", "description"=>"The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source", "type"=>"string"}, {"in"=>"query", "name"=>"FunctionName", "description"=>"The Lambda function to invoke when AWS Lambda detects an event on the stream", "type"=>"string"}, {"in"=>"query", "name"=>"StartingPosition", "description"=>"The position in the stream where AWS Lambda should start reading", "type"=>"string"}, {"in"=>"query", "name"=>"StartingPositionTimestamp", "description"=>"The timestamp of the data record from which to start reading", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Sources"]}}, "/?Action=CreateFunction"=>{"get"=>{"summary"=>"Create Function", "description"=>"Creates a new Lambda function.", "operationId"=>"createFunction", "x-api-path-slug"=>"actioncreatefunction-get", "parameters"=>[{"in"=>"query", "name"=>"Code", "description"=>"The code for the Lambda function", "type"=>"string"}, {"in"=>"query", "name"=>"DeadLetterConfig", "description"=>"The parent object that contains the target Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A short, user-defined function description", "type"=>"string"}, {"in"=>"query", "name"=>"Environment", "description"=>"The parent object that contains your environments configuration settings", "type"=>"string"}, {"in"=>"query", "name"=>"FunctionName", "description"=>"The name you want to assign to the function you are uploading", "type"=>"string"}, {"in"=>"query", "name"=>"Handler", "description"=>"The function within your code that Lambda calls to begin execution", "type"=>"string"}, {"in"=>"query", "name"=>"KMSKeyArn", "description"=>"The Amazon Resource Name (ARN) of the KMS key used to encrypt your functions environment variables", "type"=>"string"}, {"in"=>"query", "name"=>"MemorySize", "description"=>"The amount of memory, in MB, your Lambda function is given", "type"=>"string"}, {"in"=>"query", "name"=>"Publish", "description"=>"This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation", "type"=>"string"}, {"in"=>"query", "name"=>"Role", "description"=>"The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources", "type"=>"string"}, {"in"=>"query", "name"=>"Runtime", "description"=>"The runtime environment for the Lambda function you are uploading", "type"=>"string"}, {"in"=>"query", "name"=>"Timeout", "description"=>"The function execution time at which Lambda should terminate the function", "type"=>"string"}, {"in"=>"query", "name"=>"VpcConfig", "description"=>"If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Functions"]}}, "/?Action=DeleteAlias"=>{"get"=>{"summary"=>"Delete Alias", "description"=>"Deletes the specified Lambda function alias.", "operationId"=>"deleteAlias", "x-api-path-slug"=>"actiondeletealias-get", "parameters"=>[{"in"=>"query", "name"=>"FunctionName", "description"=>"The Lambda function name for which the alias is created", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"Name of the alias to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Aliases"]}}, "/?Action=DeleteEventSourceMapping"=>{"get"=>{"summary"=>"Delete Event Source Mapping", "description"=>"Removes an event source mapping.", "operationId"=>"deleteEventSourceMapping", "x-api-path-slug"=>"actiondeleteeventsourcemapping-get", "parameters"=>[{"in"=>"query", "name"=>"UUID", "description"=>"The event source mapping ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Sources"]}}, "/?Action=DeleteFunction"=>{"get"=>{"summary"=>"Delete Function", "description"=>"Deletes the specified Lambda function code and configuration.", "operationId"=>"deleteFunction", "x-api-path-slug"=>"actiondeletefunction-get", "parameters"=>[{"in"=>"query", "name"=>"FunctionName", "description"=>"The Lambda function to delete", "type"=>"string"}, {"in"=>"query", "name"=>"Qualifier", "description"=>"Using this optional parameter you can specify a function version (but not the $LATEST version) to direct AWS Lambda to delete a specific function version", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Functions"]}}, "/?Action=GetAccountSettings"=>{"get"=>{"summary"=>"Get Account Settings", "description"=>"Returns a customer's account settings.", "operationId"=>"getAccountSettings", "x-api-path-slug"=>"actiongetaccountsettings-get", "parameters"=>[{"in"=>"query", "name"=>"AccountLimit", "description"=>"Provides limits of code size and concurrency associated with the current account and region", "type"=>"string"}, {"in"=>"query", "name"=>"AccountUsage", "description"=>"Provides code size usage and function count associated with the current account and region", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/?Action=GetAlias"=>{"get"=>{"summary"=>"Get Alias", "description"=>"Returns the specified alias information such as the alias ARN, description, and function version it \n is pointing to.", "operationId"=>"getAlias", "x-api-path-slug"=>"actiongetalias-get", "parameters"=>[{"in"=>"query", "name"=>"FunctionName", "description"=>"Function name for which the alias is created", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"Name of the alias for which you want to retrieve information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Aliases"]}}, "/?Action=GetEventSourceMapping"=>{"get"=>{"summary"=>"Get Event Source Mapping", "description"=>"Returns configuration information for the specified event source mapping (see.", "operationId"=>"getEventSourceMapping", "x-api-path-slug"=>"actiongeteventsourcemapping-get", "parameters"=>[{"in"=>"query", "name"=>"UUID", "description"=>"The AWS Lambda assigned ID of the event source mapping", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Sources"]}}, "/?Action=GetFunction"=>{"get"=>{"summary"=>"Get Function", "description"=>"Returns the configuration information of the Lambda function and a presigned URL \n link to the.", "operationId"=>"getFunction", "x-api-path-slug"=>"actiongetfunction-get", "parameters"=>[{"in"=>"query", "name"=>"FunctionName", "description"=>"The Lambda function name", "type"=>"string"}, {"in"=>"query", "name"=>"Qualifier", "description"=>"Using this optional parameter to specify a function version or an alias name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Functions"]}}, "/?Action=GetFunctionConfiguration"=>{"get"=>{"summary"=>"Get Function Configuration", "description"=>"Returns the configuration information of the Lambda function.", "operationId"=>"getFunctionConfiguration", "x-api-path-slug"=>"actiongetfunctionconfiguration-get", "parameters"=>[{"in"=>"query", "name"=>"FunctionName", "description"=>"The name of the Lambda function for which you want to retrieve the configuration information", "type"=>"string"}, {"in"=>"query", "name"=>"Qualifier", "description"=>"Using this optional parameter you can specify a function version or an alias name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Functions"]}}, "/?Action=GetPolicy"=>{"get"=>{"summary"=>"Get Policy", "description"=>"Returns the resource policy associated with the specified Lambda function.", "operationId"=>"getPolicy", "x-api-path-slug"=>"actiongetpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"FunctionName", "description"=>"Function name whose resource policy you want to retrieve", "type"=>"string"}, {"in"=>"query", "name"=>"Qualifier", "description"=>"You can specify this optional query parameter to specify a function version or an alias name in which case this API will return all permissions associated with the specific qualified ARN", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=Invoke"=>{"get"=>{"summary"=>"Invoke", "description"=>"Invokes a specific Lambda function.", "operationId"=>"invoke", "x-api-path-slug"=>"actioninvoke-get", "parameters"=>[{"in"=>"query", "name"=>"ClientContext", "description"=>"Using the ClientContext you can pass client-specific information to the Lambda function you are invoking", "type"=>"string"}, {"in"=>"query", "name"=>"FunctionName", "description"=>"The Lambda function name", "type"=>"string"}, {"in"=>"query", "name"=>"InvocationType", "description"=>"By default, the Invoke API assumes RequestResponse invocation type", "type"=>"string"}, {"in"=>"query", "name"=>"LogType", "description"=>"You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse", "type"=>"string"}, {"in"=>"query", "name"=>"Qualifier", "description"=>"You can use this optional parameter to specify a Lambda function version or alias name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoke"]}}, "/?Action=InvokeAsync"=>{"get"=>{"summary"=>"Invoke Async", "description"=>"ImportantThis API is deprecated.", "operationId"=>"invokeAsync", "x-api-path-slug"=>"actioninvokeasync-get", "parameters"=>[{"in"=>"query", "name"=>"FunctionName", "description"=>"The Lambda function name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Async"]}}, "/?Action=ListAliases"=>{"get"=>{"summary"=>"List Aliases", "description"=>"Returns list of aliases created for a Lambda function.", "operationId"=>"listAliases", "x-api-path-slug"=>"actionlistaliases-get", "parameters"=>[{"in"=>"query", "name"=>"FunctionName", "description"=>"Lambda function name for which the alias is created", "type"=>"string"}, {"in"=>"query", "name"=>"FunctionVersion", "description"=>"If you specify this optional parameter, the API returns only the aliases that are pointing to the specific Lambda function version, otherwise the API returns all of the aliases created for the Lambda function", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Optional string", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"Optional integer", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Aliases"]}}, "/?Action=ListEventSourceMappings"=>{"get"=>{"summary"=>"List Event Source Mappings", "description"=>"Returns a list of event source mappings you created using the CreateEventSourceMapping \n (see.", "operationId"=>"listEventSourceMappings", "x-api-path-slug"=>"actionlisteventsourcemappings-get", "parameters"=>[{"in"=>"query", "name"=>"EventSourceArn", "description"=>"The Amazon Resource Name (ARN) of the Amazon Kinesis stream", "type"=>"string"}, {"in"=>"query", "name"=>"FunctionName", "description"=>"The name of the Lambda function", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Optional string", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"Optional integer", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Sources"]}}, "/?Action=ListFunctions"=>{"get"=>{"summary"=>"List Functions", "description"=>"Returns a list of your Lambda functions.", "operationId"=>"listFunctions", "x-api-path-slug"=>"actionlistfunctions-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Optional string", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"Optional integer", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Functions"]}}, "/?Action=ListVersionsByFunction"=>{"get"=>{"summary"=>"List Versions By Function", "description"=>"List all versions of a function.", "operationId"=>"listVersionsByFunction", "x-api-path-slug"=>"actionlistversionsbyfunction-get", "parameters"=>[{"in"=>"query", "name"=>"FunctionName", "description"=>"Function name whose versions to list", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Optional string", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"Optional integer", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Functions"]}}, "/?Action=PublishVersion"=>{"get"=>{"summary"=>"Publish Version", "description"=>"Publishes a version of your function from the current snapshot of $LATEST.", "operationId"=>"publishVersion", "x-api-path-slug"=>"actionpublishversion-get", "parameters"=>[{"in"=>"query", "name"=>"FunctionName", "description"=>"The Lambda function name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version"]}}, "/?Action=RemovePermission"=>{"get"=>{"summary"=>"Remove Permission", "description"=>"You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission.", "operationId"=>"removePermission", "x-api-path-slug"=>"actionremovepermission-get", "parameters"=>[{"in"=>"query", "name"=>"FunctionName", "description"=>"Lambda function whose resource policy you want to remove a permission from", "type"=>"string"}, {"in"=>"query", "name"=>"Qualifier", "description"=>"You can specify this optional parameter to remove permission associated with a specific function version or function alias", "type"=>"string"}, {"in"=>"query", "name"=>"StatementId", "description"=>"Statement ID of the permission to remove", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permissions"]}}, "/?Action=UpdateAlias"=>{"get"=>{"summary"=>"Update Alias", "description"=>"Using this API you can update the function version to which the alias points and the alias description.", "operationId"=>"updateAlias", "x-api-path-slug"=>"actionupdatealias-get", "parameters"=>[{"in"=>"query", "name"=>"FunctionName", "description"=>"The function name for which the alias is created", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The alias name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Aliases"]}}, "/?Action=UpdateEventSourceMapping"=>{"get"=>{"summary"=>"Update Event Source Mapping", "description"=>"You can update an event source mapping.", "operationId"=>"updateEventSourceMapping", "x-api-path-slug"=>"actionupdateeventsourcemapping-get", "parameters"=>[{"in"=>"query", "name"=>"UUID", "description"=>"The event source mapping identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Sources"]}}, "/?Action=UpdateFunctionCode"=>{"get"=>{"summary"=>"Update Function Code", "description"=>"Updates the code for the specified Lambda function.", "operationId"=>"updateFunctionCode", "x-api-path-slug"=>"actionupdatefunctioncode-get", "parameters"=>[{"in"=>"query", "name"=>"FunctionName", "description"=>"The existing Lambda function name whose code you want to replace", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Functions"]}}, "/?Action=UpdateFunctionConfiguration"=>{"get"=>{"summary"=>"Update Function Configuration", "description"=>"Updates the configuration parameters for the specified Lambda function by using the values provided in the request.", "operationId"=>"updateFunctionConfiguration", "x-api-path-slug"=>"actionupdatefunctionconfiguration-get", "parameters"=>[{"in"=>"query", "name"=>"FunctionName", "description"=>"The name of the Lambda function", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Functions"]}}}}, "apis"=>{"name"=>"AWS Lambda", "x-slug"=>"aws-lambda", "description"=>"AWS Lambda is a zero-administration compute platform for back-end web developers that runs your code for you in the AWScloudand provides you with a fine-grained pricing structure. AWS Lambda runs your back-end code on its own AWS compute fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances across multiple Availability Zones in a region, which provides the high availability, security, performance, and scalability of the AWS infrastructure.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_AWSLambda.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Deployments,Profiles,Relative Data,Serverless,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-lambda/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Lambda API", "x-api-slug"=>"aws-lambda-api", "description"=>"AWS Lambda is a zero-administration compute platform for back-end web developers that runs your code for you in the AWScloudand provides you with a fine-grained pricing structure. AWS Lambda runs your back-end code on its own AWS compute fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances across multiple Availability Zones in a region, which provides the high availability, security, performance, and scalability of the AWS infrastructure.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_AWSLambda.png", "humanURL"=>"http://docs.aws.amazon.com/lambda/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Deployments,Profiles,Relative Data,Serverless,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-lambda/aws-lambda-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"http://docs.aws.amazon.com/lambda/latest/dg/lambda-auth-and-access-control.html"}, {"type"=>"x-best-practices", "url"=>"http://docs.aws.amazon.com/lambda/latest/dg/best-practices.html"}, {"type"=>"x-console", "url"=>"https://console.aws.amazon.com/lambda"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/lambda/latest/dg/API_Reference.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/lambda/faqs/"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=186"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/lambda/getting-started/"}, {"type"=>"x-logging", "url"=>"http://docs.aws.amazon.com/lambda/latest/dg/logging-using-cloudtrail.html"}, {"type"=>"x-partners", "url"=>"https://aws.amazon.com/lambda/partners/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/lambda/pricing/"}, {"type"=>"x-rate-limits", "url"=>"http://docs.aws.amazon.com/lambda/latest/dg/limits.html"}, {"type"=>"x-road-map", "url"=>"http://aws.amazon.com/releasenotes/"}, {"type"=>"x-use-cases", "url"=>"http://docs.aws.amazon.com/lambda/latest/dg/use-cases.html"}, {"type"=>"x-website", "url"=>"http://docs.aws.amazon.com/lambda/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
pinboard{"pinboard-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Pinboard", "x-complete"=>1, "info"=>{"title"=>"Pinboard", "description"=>"store-manage-and-share-bookmarks-on-pinboard", "version"=>"1.0.0"}, "host"=>"api.pinboard.in", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/posts/update"=>{"get"=>{"summary"=>"Update Tag", "description"=>"Returns the most recent time a bookmark was added, updated or deleted. Use this before calling posts/all to see if the data has changed since the last fetch.", "operationId"=>"posts.update.get", "x-api-path-slug"=>"postsupdate-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts"]}}, "/posts/add"=>{"get"=>{"summary"=>"Add New Bookmark", "description"=>"Add a new bookmark.", "operationId"=>"posts.add.get", "x-api-path-slug"=>"postsadd-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts"]}}, "/posts/delete"=>{"get"=>{"summary"=>"Delete a Post", "description"=>"Delete a bookmark.", "operationId"=>"posts.delete.get", "x-api-path-slug"=>"postsdelete-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts"]}}, "/posts/get"=>{"get"=>{"summary"=>"Get Posts", "description"=>"Returns one or more posts on a single day matching the arguments. If no date or url is given, date of most recent bookmark will be used.", "operationId"=>"posts.get.get", "x-api-path-slug"=>"postsget-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts"]}}, "/posts/dates"=>{"get"=>{"summary"=>"Get Post by Dates", "description"=>"Returns a list of dates with the number of posts at each date.", "operationId"=>"posts.dates.get", "x-api-path-slug"=>"postsdates-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts", "Dates"]}}, "/posts/recent"=>{"get"=>{"summary"=>"Get Recent Posts", "description"=>"Returns a list of the user's most recent posts, filtered by tag.", "operationId"=>"posts.recent.get", "x-api-path-slug"=>"postsrecent-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"number of results to return", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"tag", "description"=>"filter by up to three tags", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts", "Recent"]}}, "/posts/all"=>{"get"=>{"summary"=>"Get All Posts", "description"=>"Returns all bookmarks in the user's account.", "operationId"=>"posts.all.get", "x-api-path-slug"=>"postsall-get", "parameters"=>[{"in"=>"query", "name"=>"fromdt", "description"=>"return only bookmarks created after this time", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"meta", "description"=>"include a change detection signature for each bookmark", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"results", "description"=>"number of results to return", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"start", "description"=>"offset value (default is 0)", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"tag", "description"=>"filter by up to three tags", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"todt", "description"=>"eturn only bookmarks created before this time", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts"]}}, "/posts/suggest"=>{"get"=>{"summary"=>"Get Popular Tags", "description"=>"Returns a list of popular tags and recommended tags for a given URL. Popular tags are tags used site-wide for the url; recommended tags are drawn from the user's own tags.", "operationId"=>"posts.suggest.get", "x-api-path-slug"=>"postssuggest-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"the format to return", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"url", "description"=>"url to suggest from", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts", "Suggest"]}}, "/tags/get"=>{"get"=>{"summary"=>"Get Tags", "description"=>"Returns a full list of the user's tags along with the number of times they were used.", "operationId"=>"tags.get.get", "x-api-path-slug"=>"tagsget-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"the format to return", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/tags/delete"=>{"get"=>{"summary"=>"Deletes Tag", "description"=>"Delete an existing tag.", "operationId"=>"tags.delete.get", "x-api-path-slug"=>"tagsdelete-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/tags/rename"=>{"get"=>{"summary"=>"Rename Tags", "description"=>"Rename an tag, or fold it in to an existing tag.", "operationId"=>"tags.rename.get", "x-api-path-slug"=>"tagsrename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/user/secret"=>{"get"=>{"summary"=>"Get User Secret", "description"=>"Get the secret RSS token (allows viewing user's private RSS feeds).", "operationId"=>"user.secret.get", "x-api-path-slug"=>"usersecret-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Secret"]}}}}, "apis"=>{"name"=>"Pinboard", "x-slug"=>"pinboard", "description"=>"Pinboard is a bookmarking website for introverted people in a hurry. The focus of the site is less on socializing, and more on speed and utility. Pinboard tries to offer useful features without getting in your way. My highest priority is keeping your data safe over the long term.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/240-pinboard.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"45688", "tags"=>"Bookmarks,Indie EdTech Data Jam,internet,Links,My API Stack,Relative Data,Relative StreamRank,Service API,Stack,Stack Network,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"pinboard/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Pinboard", "x-api-slug"=>"pinboard", "description"=>"Pinboard is a bookmarking website for introverted people in a hurry. The focus of the site is less on socializing, and more on speed and utility. Pinboard tries to offer useful features without getting in your way. My highest priority is keeping your data safe over the long term.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/240-pinboard.jpg", "humanURL"=>"http://pinboard.in", "baseURL"=>"https://api.pinboard.in//v1", "tags"=>"Bookmarks,Indie EdTech Data Jam,internet,Links,My API Stack,Relative Data,Relative StreamRank,Service API,Stack,Stack Network,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/pinboard/usersecret-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/pinboard/pinboard-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.pinboard.in"}, {"type"=>"x-blog", "url"=>"http://www.pinboard.in/blog/"}, {"type"=>"x-blog-rss", "url"=>"https://blog.pinboard.in/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/pinboard"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/pinboard"}, {"type"=>"x-developer", "url"=>"https://pinboard.in/api"}, {"type"=>"x-github", "url"=>"https://github.com/pinboard"}, {"type"=>"x-pricing", "url"=>"https://www.pinboard.in/about/"}, {"type"=>"x-privacy", "url"=>"https://www.pinboard.in/privacy/"}, {"type"=>"x-security", "url"=>"https://www.pinboard.in/security/"}, {"type"=>"x-terms-of-service", "url"=>"https://www.pinboard.in/tos/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/pinboard"}, {"type"=>"x-website", "url"=>"http://pinboard.in"}, {"type"=>"x-website", "url"=>"http://www.pinboard.in"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-media-services{"azure-media-services-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Media Services", "x-complete"=>1, "info"=>{"title"=>"MediaServicesManagementClient", "description"=>"media-services-resource-management-apis-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/providers/Microsoft.Media/CheckNameAvailability"=>{"post"=>{"summary"=>"Media Service Check Name Availability", "description"=>"Checks whether the Media Service resource name is available. The name must be globally unique.", "operationId"=>"MediaService_CheckNameAvailability", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-mediachecknameavailability-post", "parameters"=>[{"in"=>"body", "name"=>"CheckNameAvailabilityInput", "description"=>"Properties needed to check the availability of a name", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media Service Name Availability"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices"=>{"get"=>{"summary"=>"Media Service List By Resource Group", "description"=>"Lists all of the Media Services in a resource group.", "operationId"=>"MediaService_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-mediamediaservices-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media Service Resource Group"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}"=>{"get"=>{"summary"=>"Media Service Get", "description"=>"Gets a Media Service.", "operationId"=>"MediaService_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-mediamediaservicesmediaservicename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media Service"]}, "put"=>{"summary"=>"Media Service Create", "description"=>"Creates a Media Service.", "operationId"=>"MediaService_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-mediamediaservicesmediaservicename-put", "parameters"=>[{"in"=>"body", "name"=>"MediaService", "description"=>"Media Service properties needed for creation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media Service"]}, "delete"=>{"summary"=>"Media Service Delete", "description"=>"Deletes a Media Service.", "operationId"=>"MediaService_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-mediamediaservicesmediaservicename-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media Service"]}, "patch"=>{"summary"=>"Media Service Update", "description"=>"Updates a Media Service.", "operationId"=>"MediaService_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-mediamediaservicesmediaservicename-patch", "parameters"=>[{"in"=>"body", "name"=>"MediaService", "description"=>"Media Service properties needed for update", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media Service"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}/regenerateKey"=>{"post"=>{"summary"=>"Media Service Regenerate Key", "description"=>"Regenerates a primary or secondary key for a Media Service.", "operationId"=>"MediaService_RegenerateKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-mediamediaservicesmediaservicenameregeneratekey-post", "parameters"=>[{"in"=>"body", "name"=>"RegenerateKeyInput", "description"=>"Properties needed to regenerate the Media Service key", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media Service Regenerate Key"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}/listKeys"=>{"post"=>{"summary"=>"Media Service List Keys", "description"=>"Lists the keys for a Media Service.", "operationId"=>"MediaService_ListKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-mediamediaservicesmediaservicenamelistkeys-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media Service Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}/syncStorageKeys"=>{"post"=>{"summary"=>"Media Service Sync Storage Keys", "description"=>"Synchronizes storage account keys for a storage account associated with the Media Service account.", "operationId"=>"MediaService_SyncStorageKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-mediamediaservicesmediaservicenamesyncstoragekeys-post", "parameters"=>[{"in"=>"body", "name"=>"SyncStorageKeysInput", "description"=>"Properties needed to synchronize the keys for a storage account to the Media Service", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media Service Sync Storage Keys"]}}}}, "apis"=>{"name"=>"Azure Media Services", "x-slug"=>"azure-media-services", "description"=>"Azure Media Services gives you broadcast-quality video streaming services to reach larger audiences on today’s most popular mobile devices. Media Services enhances accessibility, distribution, and scalability, and makes it easy and cost-effective to stream content to your local and worldwide audiences—all while protecting your content.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/media-services-video-on-demand.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Media,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-media-services/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Media Services API", "x-api-slug"=>"azure-media-services-api", "description"=>"Azure Media Services gives you broadcast-quality video streaming services to reach larger audiences on today’s most popular mobile devices. Media Services enhances accessibility, distribution, and scalability, and makes it easy and cost-effective to stream content to your local and worldwide audiences—all while protecting your content.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/media-services-video-on-demand.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/media-services/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Media,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/azure-media-services/azure-media-services-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/media-services/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/media-services/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/media-services/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/media-services/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
strava{"strava-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Strava", "x-complete"=>1, "info"=>{"title"=>"Strava API v3", "description"=>"strava-api", "version"=>"1.0.0"}, "host"=>"www.strava.com", "basePath"=>"/api/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/athletes/{id}/stats"=>{"get"=>{"summary"=>"Get Athlete Stats", "description"=>"Returns the activity stats of an athlete.", "operationId"=>"getStats", "x-api-path-slug"=>"athletesidstats-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the athlete"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Athlete", "Stats"]}}, "/athlete"=>{"get"=>{"summary"=>"Get Authenticated Athlete", "description"=>"Returns the currently authenticated athlete.", "operationId"=>"getLoggedInAthlete", "x-api-path-slug"=>"athlete-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Authenticated", "Athlete"]}, "put"=>{"summary"=>"Update Athlete", "description"=>"Update the currently authenticated athlete.", "operationId"=>"updateLoggedInAthlete", "x-api-path-slug"=>"athlete-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The athlete entity to update", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Athlete"]}}, "/athlete/zones"=>{"get"=>{"summary"=>"Get Zones", "description"=>"Returns the the authenticated athlete's heart rate and power zones.", "operationId"=>"getLoggedInAthleteZones", "x-api-path-slug"=>"athletezones-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Zones"]}}, "/segments/{id}"=>{"get"=>{"summary"=>"Get Segment", "description"=>"Returns the specified segment.", "operationId"=>"getSegmentById", "x-api-path-slug"=>"segmentsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the segment"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Segment"]}}, "/segments/starred"=>{"get"=>{"summary"=>"List Starred Segments", "description"=>"List of the authenticated athlete's starred segments.", "operationId"=>"getLoggedInAthleteStarredSegments", "x-api-path-slug"=>"segmentsstarred-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "List", "Starred", "Segments"]}}, "/segments/{id}/starred"=>{"put"=>{"summary"=>"Star Segment", "description"=>"Stars/Unstars the given segment for the authenticated athlete.", "operationId"=>"starSegment", "x-api-path-slug"=>"segmentsidstarred-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the segment to star"}, {"in"=>"formData", "name"=>"starred", "description"=>"If true, star the segment; if false, unstar the segment"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Star", "Segment"]}}, "/segments/{id}/leaderboard"=>{"get"=>{"summary"=>"Get Segment Leaderboard", "description"=>"Returns the specified segment leaderboard.", "operationId"=>"getLeaderboardBySegmentId", "x-api-path-slug"=>"segmentsidleaderboard-get", "parameters"=>[{"in"=>"query", "name"=>"age_group", "description"=>"Premium Feature"}, {"in"=>"query", "name"=>"club_id", "description"=>"Filter by club"}, {"in"=>"query", "name"=>"context_entries"}, {"in"=>"query", "name"=>"date_range", "description"=>"Filter by date range"}, {"in"=>"query", "name"=>"following", "description"=>"Filter by friends of the authenticated athlete"}, {"in"=>"query", "name"=>"gender", "description"=>"Filter by gender"}, {"in"=>"path", "name"=>"id", "description"=>"The identifier of the segment leaderboard"}, {"in"=>"query", "name"=>"weight_class", "description"=>"Premium Feature"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Segment", "Leaderboard"]}}, "/segments/{id}/all_efforts"=>{"get"=>{"summary"=>"List Segment Efforts", "description"=>"Returns a set of the authenticated athlete's segment efforts for a given segment.", "operationId"=>"getEffortsBySegmentId", "x-api-path-slug"=>"segmentsidall-efforts-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the segment"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "List", "Segment", "Efforts"]}}, "/segments/explore"=>{"get"=>{"summary"=>"Explore segments", "description"=>"Returns the top 10 segments matching a specified query.", "operationId"=>"exploreSegments", "x-api-path-slug"=>"segmentsexplore-get", "parameters"=>[{"in"=>"query", "name"=>"activity_type", "description"=>"Desired activity type"}, {"in"=>"query", "name"=>"bounds", "description"=>"The latitude and longitude for two points describing a rectangular boundary for the search: [southwest corner latitutde, southwest corner longitude, northeast corner latitude, northeast corner longitude]"}, {"in"=>"query", "name"=>"max_cat", "description"=>"The maximum climbing category"}, {"in"=>"query", "name"=>"min_cat", "description"=>"The minimum climbing category"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Explore", "Segments"]}}, "/segment_efforts/{id}"=>{"get"=>{"summary"=>"Get Segment Effort", "description"=>"Returns a segment effort from an activity that is owned by the authenticated athlete.", "operationId"=>"getSegmentEffortById", "x-api-path-slug"=>"segment-effortsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the segment effort"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Segment", "Effort"]}}, "/running_races/{id}"=>{"get"=>{"summary"=>"Get Running Race", "description"=>"Returns a running race for a given identifier.", "operationId"=>"getRunningRaceById", "x-api-path-slug"=>"running-racesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the running race"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Running", "Race"]}}, "/running_races"=>{"get"=>{"summary"=>"List Running Races", "description"=>"Returns a list running races based on a set of search criteria.", "operationId"=>"getRunningRaces", "x-api-path-slug"=>"running-races-get", "parameters"=>[{"in"=>"query", "name"=>"year", "description"=>"Filters the list by a given year"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "List", "Running", "Races"]}}, "/activities"=>{"post"=>{"summary"=>"Create an Activity", "description"=>"Creates a manual activity for an athlete. Requires write permissions, as requested during the authorization process.", "operationId"=>"createActivity", "x-api-path-slug"=>"activities-post", "parameters"=>[{"in"=>"formData", "name"=>"commute", "description"=>"Set to 1 to mark as commute"}, {"in"=>"formData", "name"=>"description", "description"=>"Description of the activity"}, {"in"=>"formData", "name"=>"distance", "description"=>"In meters"}, {"in"=>"formData", "name"=>"elapsed_time", "description"=>"In seconds"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the activity"}, {"in"=>"formData", "name"=>"photo_ids", "description"=>"List of native photo ids to attach to the activity"}, {"in"=>"formData", "name"=>"private", "description"=>"set to 1 to mark the resulting activity as private, ???view_private??? permissions will be necessary to view the activity"}, {"in"=>"formData", "name"=>"start_date_local", "description"=>"ISO 8601 formatted date time"}, {"in"=>"formData", "name"=>"trainer", "description"=>"Set to 1 to mark as a trainer activity"}, {"in"=>"formData", "name"=>"type", "description"=>"Type of activity"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Activity"]}}, "/activities/{id}"=>{"get"=>{"summary"=>"Get Activity", "description"=>"Returns the given activity that is owned by the authenticated athlete.", "operationId"=>"getActivityById", "x-api-path-slug"=>"activitiesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the activity"}, {"in"=>"query", "name"=>"include_all_efforts", "description"=>"To include all segments efforts"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Activity"]}, "put"=>{"summary"=>"Update Activity", "description"=>"Updates the given activity that is owned by the authenticated athlete.", "operationId"=>"updateActivityById", "x-api-path-slug"=>"activitiesid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The identifier of the activity"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Activity"]}}, "/athlete/activities"=>{"get"=>{"summary"=>"List Athlete Activities", "description"=>"Returns the activities of an athlete for a specific identifier.", "operationId"=>"getLoggedInAthleteActivities", "x-api-path-slug"=>"athleteactivities-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"An epoch timestamp to use for filtering activities that have taken place after a certain time"}, {"in"=>"query", "name"=>"before", "description"=>"An epoch timestamp to use for filtering activities that have taken place before a certain time"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "List", "Athlete", "Activities"]}}, "/activities/{id}/laps"=>{"get"=>{"summary"=>"List Activity Laps", "description"=>"Returns the laps of an activity identified by an identifier.", "operationId"=>"getLapsByActivityId", "x-api-path-slug"=>"activitiesidlaps-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the activity"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "List", "Activity", "Laps"]}}, "/activities/{id}/zones"=>{"get"=>{"summary"=>"Get Activity Zones", "description"=>"Premium Feature. Returns the zones of a given activity.", "operationId"=>"getZonesByActivityId", "x-api-path-slug"=>"activitiesidzones-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the activity"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Activity", "Zones"]}}, "/activities/{id}/comments"=>{"get"=>{"summary"=>"List Activity Comments", "description"=>"Returns the comments on the given activity.", "operationId"=>"getCommentsByActivityId", "x-api-path-slug"=>"activitiesidcomments-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the activity"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "List", "Activity", "Comments"]}}, "/activities/{id}/kudos"=>{"get"=>{"summary"=>"List Activity Kudoers", "description"=>"Returns the athletes who kudoed an activity identified by an identifier.", "operationId"=>"getKudoersByActivityId", "x-api-path-slug"=>"activitiesidkudos-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the activity"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "List", "Activity", "Kudoers"]}}, "/clubs/{id}"=>{"get"=>{"summary"=>"Get Club", "description"=>"Returns a given club using its identifier.", "operationId"=>"getClubById", "x-api-path-slug"=>"clubsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the club"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Club"]}}, "/clubs/{id}/members"=>{"get"=>{"summary"=>"List Club Members", "description"=>"Returns a list of the athletes who are members of a given club.", "operationId"=>"getClubMembersById", "x-api-path-slug"=>"clubsidmembers-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the club"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "List", "Club", "Members"]}}, "/clubs/{id}/admins"=>{"get"=>{"summary"=>"List Club Administrators.", "description"=>"Returns a list of the administrators of a given club.", "operationId"=>"getClubAdminsById", "x-api-path-slug"=>"clubsidadmins-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the club"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "List", "Club", "Administrators"]}}, "/clubs/{id}/activities"=>{"get"=>{"summary"=>"List Club Activities", "description"=>"Retrieve recent activities from members of a specific club. The authenticated athlete must belong to the requested club in order to hit this endpoint. Pagination is supported. Enhanced Privacy Mode is respected for all activities.", "operationId"=>"getClubActivitiesById", "x-api-path-slug"=>"clubsidactivities-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the club"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "List", "Club", "Activities"]}}, "/clubs/{id}/join"=>{"post"=>{"summary"=>"Join Club", "description"=>"Adds the authenticated athlete to the club's membership.", "operationId"=>"joinClubById", "x-api-path-slug"=>"clubsidjoin-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the club"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Join", "Club"]}}, "/clubs/{id}/leave"=>{"post"=>{"summary"=>"Leave Club", "description"=>"Removes the authenticated athlete from the club's membership.", "operationId"=>"leaveClubById", "x-api-path-slug"=>"clubsidleave-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the club"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Leave", "Club"]}}, "/athlete/clubs"=>{"get"=>{"summary"=>"List Athlete Clubs", "description"=>"Returns a list of the clubs whose membership includes the authenticated athlete.", "operationId"=>"getLoggedInAthleteClubs", "x-api-path-slug"=>"athleteclubs-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "List", "Athlete", "Clubs"]}}, "/gear/{id}"=>{"get"=>{"summary"=>"Get Equipment", "description"=>"Returns an equipment using its identifier.", "operationId"=>"getGearById", "x-api-path-slug"=>"gearid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the gear"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Equipment"]}}, "/routes/{id}"=>{"get"=>{"summary"=>"Get Route", "description"=>"Returns a route using its identifier.", "operationId"=>"getRouteById", "x-api-path-slug"=>"routesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the route"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Route"]}}, "/athletes/{id}/routes"=>{"get"=>{"summary"=>"List Athlete Routes", "description"=>"Returns a list of the routes created by the authenticated athlete using their athlete ID.", "operationId"=>"getRoutesByAthleteId", "x-api-path-slug"=>"athletesidroutes-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the athlete"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "List", "Athlete", "Routes"]}}, "/uploads"=>{"post"=>{"summary"=>"Upload Activity", "description"=>"Uploads a new data file to create an activity from.", "operationId"=>"createUpload", "x-api-path-slug"=>"uploads-post", "parameters"=>[{"in"=>"formData", "name"=>"commute", "description"=>"Whether the resulting activity should be tagged as a commute"}, {"in"=>"formData", "name"=>"data_type", "description"=>"The format of the uploaded file"}, {"in"=>"formData", "name"=>"description", "description"=>"The desired description of the resulting activity"}, {"in"=>"formData", "name"=>"external_id", "description"=>"The desired external identifier of the resulting activity"}, {"in"=>"formData", "name"=>"file", "description"=>"The uploaded file"}, {"in"=>"formData", "name"=>"name", "description"=>"The desired name of the resulting activity"}, {"in"=>"formData", "name"=>"private", "description"=>"Whether the resulting activity should be private"}, {"in"=>"formData", "name"=>"trainer", "description"=>"Whether the resulting activity should be marked as having been performed on a trainer"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Upload", "Activity"]}}, "/uploads/{uploadId}"=>{"get"=>{"summary"=>"Get Upload", "description"=>"Returns an upload for a given identifier.", "operationId"=>"getUploadById", "x-api-path-slug"=>"uploadsuploadid-get", "parameters"=>[{"in"=>"path", "name"=>"uploadId", "description"=>"The identifier of the upload"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Upload"]}}, "/activities/{id}/streams"=>{"get"=>{"summary"=>"Get Activity Streams", "description"=>"Returns the given activity's streams.", "operationId"=>"getActivityStreams", "x-api-path-slug"=>"activitiesidstreams-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the activity"}, {"in"=>"query", "name"=>"keys", "description"=>"Desired stream types"}, {"in"=>"query", "name"=>"key_by_type", "description"=>"Must be true"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Activity", "Streams"]}}, "/segment_efforts/{id}/streams"=>{"get"=>{"summary"=>"Get segment effort streams", "description"=>"Returns a set of streams for a segment effort completed by the authenticated athlete.", "operationId"=>"getSegmentEffortStreams", "x-api-path-slug"=>"segment-effortsidstreams-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the segment effort"}, {"in"=>"query", "name"=>"keys", "description"=>"The types of streams to return"}, {"in"=>"query", "name"=>"key_by_type", "description"=>"Must be true"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Segment", "Effort", "Streams"]}}, "/segments/{id}/streams"=>{"get"=>{"summary"=>"Get Segment Streams", "description"=>"Returns the given segment's streams.", "operationId"=>"getSegmentStreams", "x-api-path-slug"=>"segmentsidstreams-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the segment"}, {"in"=>"query", "name"=>"keys", "description"=>"The types of streams to return"}, {"in"=>"query", "name"=>"key_by_type", "description"=>"Must be true"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Sports", "Segment", "Streams"]}}}}, "apis"=>{"name"=>"Strava", "x-slug"=>"strava", "description"=>"Strava is software as a service used to track cycling, running, and swimming activity via GPS.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28739-strava.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"887", "tags"=>"Athletes,internet,Mobile,New,Relative Data,Service API,Sports,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"strava/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Strava", "x-api-slug"=>"strava", "description"=>"Strava is software as a service used to track cycling, running, and swimming activity via GPS.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28739-strava.jpg", "humanURL"=>"https://developers.strava.com", "baseURL"=>"https://www.strava.com//api/v3", "tags"=>"Athletes,internet,Mobile,New,Relative Data,Service API,Sports,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/strava/strava-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-code", "url"=>"https://developers.strava.com/docs/#client-code"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/strava"}, {"type"=>"x-documentation", "url"=>"https://developers.strava.com/docs/reference/"}, {"type"=>"x-email", "url"=>"developers@strava.com"}, {"type"=>"x-email", "url"=>"dpo@strava.com"}, {"type"=>"x-email", "url"=>"ip@strava.com"}, {"type"=>"x-github", "url"=>"https://github.com/strava"}, {"type"=>"x-openapi", "url"=>"https://developers.strava.com/swagger/swagger.json"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Strava"}, {"type"=>"x-webhook", "url"=>"https://developers.strava.com/docs/webhooks/"}, {"type"=>"x-developer", "url"=>"https://developers.strava.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
browshot{"browshot-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Browshot", "x-complete"=>1, "info"=>{"title"=>"Browshot", "description"=>"take-screenshots-of-any-website-in-real-time", "termsOfService"=>"https://browshot.com/terms", "contact"=>{"name"=>"API Support", "url"=>"https://browshot.com/contact", "email"=>"support@browshot.com"}, "version"=>"1.17.0"}, "host"=>"api.browshot.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/account/info"=>{"get"=>{"summary"=>"Get information about your account", "description"=>"Get information about your account.", "operationId"=>"GetAccountInfo", "x-api-path-slug"=>"accountinfo-get", "parameters"=>[{"in"=>"query", "name"=>"details", "description"=>"level of information returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Info"]}}, "/batch/ceate"=>{"post"=>{"summary"=>"Requests thousands of screenshtos at once", "description"=>"Get hundreds or thousands of screenshots from a text file. You can use this API call or the dashboard. Unlike the other API calls, you must issue a POST request with the Content-Type \"multipart/form-data\" in order to upload the text file. The text file must contain the list of URLs to request, 1 URL per line. Failed screenshots will be tried up to 3 times before giving up.", "operationId"=>"CreateBatch", "x-api-path-slug"=>"batchceate-post", "parameters"=>[{"in"=>"formData", "name"=>"cookie", "description"=>"set a cookie for the URL requested (see Custom POST Data, Referer and Cookie) Cookies should be separated by a ; - paid screenshots only"}, {"in"=>"formData", "name"=>"delay", "description"=>"number of seconds to wait after the page has loaded"}, {"in"=>"formData", "name"=>"details", "description"=>"level of information available with screenshot/info"}, {"in"=>"formData", "name"=>"file", "description"=>"text file to use"}, {"in"=>"formData", "name"=>"flash_delay", "description"=>"number of seconds to wait after the page has loaded if Flash elements are present"}, {"in"=>"formData", "name"=>"format", "description"=>"image as PNG or JPEG"}, {"in"=>"formData", "name"=>"headers", "description"=>"any custom HTTP headers"}, {"in"=>"formData", "name"=>"height", "description"=>"thumbnail height"}, {"in"=>"query", "name"=>"hosting", "description"=>"hosting option - s3 or browshot"}, {"in"=>"query", "name"=>"hosting_bucket", "description"=>"S3 bucket to upload the screenshot or thumbnail (required for S3)"}, {"in"=>"query", "name"=>"hosting_file", "description"=>"file name to use (for S3 only)"}, {"in"=>"query", "name"=>"hosting_headers", "description"=>"list of headers to add to the S3 object (for S3 only)"}, {"in"=>"query", "name"=>"hosting_height", "description"=>"maximum height of the thumbnail to host"}, {"in"=>"query", "name"=>"hosting_scale", "description"=>"scale of the thumbnail to host"}, {"in"=>"query", "name"=>"hosting_width", "description"=>"maximum height of the thumbnail to host"}, {"in"=>"formData", "name"=>"html", "description"=>"saves the HTML of the rendered page which can be retrieved by the API call screenshot/html"}, {"in"=>"formData", "name"=>"instance_id", "description"=>"instance ID to use"}, {"in"=>"formData", "name"=>"max_wait", "description"=>"maximum number of seconds to wait before triggering the PageLoad event"}, {"in"=>"formData", "name"=>"name", "description"=>"name of the batch"}, {"in"=>"formData", "name"=>"post_data", "description"=>"send a POST requests with post_data, useful for filling out forms - paid screenshots only"}, {"in"=>"formData", "name"=>"priority", "description"=>"assign priority to the screenshot (for private instances only)"}, {"in"=>"formData", "name"=>"referer", "description"=>"use a custom referrer header - paid screenshots only"}, {"in"=>"formData", "name"=>"screen_height", "description"=>"height of the browser window"}, {"in"=>"formData", "name"=>"screen_width", "description"=>"width of the browser window"}, {"in"=>"formData", "name"=>"script", "description"=>"URL of javascript file to execute after the page load event"}, {"in"=>"formData", "name"=>"size", "description"=>"screenshots size - screen (default) or page"}, {"in"=>"formData", "name"=>"width", "description"=>"thumbnail width"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch", "Ceate"]}}, "/batch/info"=>{"get"=>{"summary"=>"Get the batch status", "description"=>"Get the status of a batch requested through the API or through the dashboard.", "operationId"=>"GetBatchInfo", "x-api-path-slug"=>"batchinfo-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"batch ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch", "Info"]}}, "/browser/info"=>{"get"=>{"summary"=>"Get information about a browser", "description"=>"Get information about a browser.", "operationId"=>"GetBrowserInfo", "x-api-path-slug"=>"browserinfo-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"browser ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Browser", "Info"]}}, "/browser/list"=>{"get"=>{"summary"=>"Get all browsers", "description"=>"Get all browsers.", "operationId"=>"GetBrowsersInfo", "x-api-path-slug"=>"browserlist-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Browser", "List"]}}, "/instance/info"=>{"get"=>{"summary"=>"Get information about an instance", "description"=>"Get information about an instance.", "operationId"=>"GetInstanceInfo", "x-api-path-slug"=>"instanceinfo-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"instance ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance", "Info"]}}, "/instance/list"=>{"get"=>{"summary"=>"Get all instances", "description"=>"Get all instances.", "operationId"=>"GetInstancesInfo", "x-api-path-slug"=>"instancelist-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance", "List"]}}, "/screenshot/create"=>{"get"=>{"summary"=>"Request a screenshot", "description"=>"Screenshots requests to private and shared instances require a positive balance.\n\n*IMPORTANT*: Remember that you can only do 100 free screenshots per month. To used a premium instance, use instance_id=65 for example.", "operationId"=>"CreateScreenshot", "x-api-path-slug"=>"screenshotcreate-get", "parameters"=>[{"in"=>"query", "name"=>"cache", "description"=>"use a previous screenshot (same URL, same instance) if it was done within seconds"}, {"in"=>"query", "name"=>"cookie", "description"=>"set a cookie for the URL requested (see Custom POST Data, Referer and Cookie) Cookies should be separated by a ; - paid screenshots only"}, {"in"=>"query", "name"=>"delay", "description"=>"number of seconds to wait after the page has loaded"}, {"in"=>"query", "name"=>"details", "description"=>"level of information available with screenshot/info"}, {"in"=>"query", "name"=>"flash_delay", "description"=>"number of seconds to wait after the page has loaded if Flash elements are present"}, {"in"=>"query", "name"=>"headers", "description"=>"any custom HTTP headers"}, {"in"=>"query", "name"=>"hosting", "description"=>"hosting option - s3 or browshot"}, {"in"=>"query", "name"=>"hosting_bucket", "description"=>"S3 bucket to upload the screenshot or thumbnail (required for S3)"}, {"in"=>"query", "name"=>"hosting_file", "description"=>"file name to use (for S3 only)"}, {"in"=>"query", "name"=>"hosting_headers", "description"=>"list of headers to add to the S3 object (for S3 only)"}, {"in"=>"query", "name"=>"hosting_height", "description"=>"maximum height of the thumbnail to host"}, {"in"=>"query", "name"=>"hosting_scale", "description"=>"scale of the thumbnail to host"}, {"in"=>"query", "name"=>"hosting_width", "description"=>"maximum height of the thumbnail to host"}, {"in"=>"query", "name"=>"html", "description"=>"saves the HTML of the rendered page which can be retrieved by the API call screenshot/html"}, {"in"=>"query", "name"=>"instance_id", "description"=>"instance ID to use"}, {"in"=>"query", "name"=>"max_wait", "description"=>"maximum number of seconds to wait before triggering the PageLoad event"}, {"in"=>"query", "name"=>"post_data", "description"=>"send a POST requests with post_data, useful for filling out forms - paid screenshots only"}, {"in"=>"query", "name"=>"priority", "description"=>"assign priority to the screenshot (for private instances only)"}, {"in"=>"query", "name"=>"referer", "description"=>"use a custom referrer header - paid screenshots only"}, {"in"=>"query", "name"=>"screen_height", "description"=>"height of the browser window"}, {"in"=>"query", "name"=>"screen_width", "description"=>"width of the browser window"}, {"in"=>"query", "name"=>"script", "description"=>"URL of javascript file to execute after the page load event"}, {"in"=>"query", "name"=>"shots", "description"=>"take multiple screenshots of the same page"}, {"in"=>"query", "name"=>"shot_interval", "description"=>"number of seconds between 2 screenshots"}, {"in"=>"query", "name"=>"size", "description"=>"screenshot size - screen (default) or page"}, {"in"=>"query", "name"=>"url", "description"=>"URL of the page to get a screenshot for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Screenshot", "Create"]}}, "/screenshot/delete"=>{"get"=>{"summary"=>"Delete screenshot data", "description"=>"You can delete details of your screenshots to remove any confidential information.", "operationId"=>"DeleteScreenshot", "x-api-path-slug"=>"screenshotdelete-get", "parameters"=>[{"in"=>"query", "name"=>"data", "description"=>"data to remove"}, {"in"=>"query", "name"=>"id", "description"=>"screenshot ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Screenshot", "Delete"]}}, "/screenshot/host"=>{"get"=>{"summary"=>"Host thumbnails on your own S3 account or on Browshot.", "description"=>"You can host screenshots and thumbnails on your own S3 account or on Browshot.", "operationId"=>"HostScreenshot", "x-api-path-slug"=>"screenshothost-get", "parameters"=>[{"in"=>"query", "name"=>"bucket", "description"=>"S3 bucket to upload the screenshot or thumbnail - required with hosting=s3"}, {"in"=>"query", "name"=>"file", "description"=>"file name to use - optional, used with hosting=s3"}, {"in"=>"query", "name"=>"headers", "description"=>"HTTP headers to add to your S3 object - optional, used with hosting=s3"}, {"in"=>"query", "name"=>"height", "description"=>"height of the thumbnail"}, {"in"=>"query", "name"=>"hosting", "description"=>"hosting option: s3 or browshot"}, {"in"=>"query", "name"=>"id", "description"=>"screenshot ID"}, {"in"=>"query", "name"=>"scale", "description"=>"scale of the thumbnail"}, {"in"=>"query", "name"=>"width", "description"=>"width of the thumbnail"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Screenshot", "Host"]}}, "/screenshot/html"=>{"get"=>{"summary"=>"Get the HTML code", "description"=>"Retrieve the HTML code of the rendered page. This API call should be used when html=1 was specified in the screenshot request.", "operationId"=>"GetHTML", "x-api-path-slug"=>"screenshothtml-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"screenshot ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Screenshot", "Html"]}}, "/screenshot/info"=>{"get"=>{"summary"=>"Query screenshot status", "description"=>"Once a screenshot has been requested, its status must be checked until it is either \"error\" or \"finished\".", "operationId"=>"GetScreenshotInfo", "x-api-path-slug"=>"screenshotinfo-get", "parameters"=>[{"in"=>"query", "name"=>"details", "description"=>"level of details about the screenshot and the page"}, {"in"=>"query", "name"=>"id", "description"=>"screenshot ID received from /api/v1/screenshot/create"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Screenshot", "Info"]}}, "/screenshot/list"=>{"get"=>{"summary"=>"Get information about screenshots", "description"=>"Get information about the last 100 screenshots requested.", "operationId"=>"GetMultipleScreenshotsInfo", "x-api-path-slug"=>"screenshotlist-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"maximum number of screenshots information to return"}, {"in"=>"query", "name"=>"status", "description"=>"get list of screenshot in a given status (error, finished, in_process)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Screenshot", "List"]}}, "/screenshot/multiple"=>{"get"=>{"summary"=>"Request multiple screenshots", "description"=>"Request multiple screenshots in one API call. The API call accepts all the parameters supported by screenshot/create.\nYou can specify up to 10 URLs and 10 instances for a total of 100 screenshots in one API call.", "operationId"=>"CreateMultipleScreenshots", "x-api-path-slug"=>"screenshotmultiple-get", "parameters"=>[{"in"=>"query", "name"=>"cache", "description"=>"use a previous screenshot (same URL, same instance) if it was done within seconds"}, {"in"=>"query", "name"=>"cookie", "description"=>"set a cookie for the URL requested (see Custom POST Data, Referer and Cookie) Cookies should be separated by a ; - paid screenshots only"}, {"in"=>"query", "name"=>"delay", "description"=>"number of seconds to wait after the page has loaded"}, {"in"=>"query", "name"=>"details", "description"=>"level of information available with screenshot/info"}, {"in"=>"query", "name"=>"flash_delay", "description"=>"number of seconds to wait after the page has loaded if Flash elements are present"}, {"in"=>"query", "name"=>"headers", "description"=>"any custom HTTP headers"}, {"in"=>"query", "name"=>"hosting", "description"=>"hosting option - s3 or browshot"}, {"in"=>"query", "name"=>"hosting_bucket", "description"=>"S3 bucket to upload the screenshot or thumbnail (required for S3)"}, {"in"=>"query", "name"=>"hosting_file", "description"=>"file name to use (for S3 only)"}, {"in"=>"query", "name"=>"hosting_headers", "description"=>"list of headers to add to the S3 object (for S3 only)"}, {"in"=>"query", "name"=>"hosting_height", "description"=>"maximum height of the thumbnail to host"}, {"in"=>"query", "name"=>"hosting_scale", "description"=>"scale of the thumbnail to host"}, {"in"=>"query", "name"=>"hosting_width", "description"=>"maximum height of the thumbnail to host"}, {"in"=>"query", "name"=>"html", "description"=>"saves the HTML of the rendered page which can be retrieved by the API call screenshot/html"}, {"in"=>"query", "name"=>"instance_id", "description"=>"instance ID to use"}, {"in"=>"query", "name"=>"max_wait", "description"=>"maximum number of seconds to wait before triggering the PageLoad event"}, {"in"=>"query", "name"=>"post_data", "description"=>"send a POST requests with post_data, useful for filling out forms - paid screenshots only"}, {"in"=>"query", "name"=>"priority", "description"=>"assign priority to the screenshot (for private instances only)"}, {"in"=>"query", "name"=>"referer", "description"=>"use a custom referrer header - paid screenshots only"}, {"in"=>"query", "name"=>"screen_height", "description"=>"height of the browser window"}, {"in"=>"query", "name"=>"screen_width", "description"=>"width of the browser window"}, {"in"=>"query", "name"=>"script", "description"=>"URL of javascript file to execute after the page load event"}, {"in"=>"query", "name"=>"size", "description"=>"screenshot size - screen (default) or page"}, {"in"=>"query", "name"=>"url", "description"=>"URL of the page to get a screenshot for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Screenshot", "Multiple"]}}, "/screenshot/search"=>{"get"=>{"summary"=>"Search for screenshots", "description"=>"Search for screenshots of a specific URL.", "operationId"=>"SearchScreenshot", "x-api-path-slug"=>"screenshotsearch-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"maximum number of screenshots information to return"}, {"in"=>"query", "name"=>"status", "description"=>"get list of screenshot in a given status (error, finished, in_process)"}, {"in"=>"query", "name"=>"url", "description"=>"look for a string matching the URL requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Screenshot", "Search"]}}, "/screenshot/share"=>{"get"=>{"summary"=>"Share a screenshot", "description"=>"You can make your screenshots public, add notes, and share it with your friends and colleagues. Only screenshots which are successfully completed can be shared.n the thumbnail. You can take a 1024x768 screenshot, crop it to 768x768, and get it scaled down to 300x300.", "operationId"=>"ShareScreenshot", "x-api-path-slug"=>"screenshotshare-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"screenshot ID"}, {"in"=>"query", "name"=>"note", "description"=>"note to add on the sharing page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Screenshot", "Share"]}}, "/screenshot/thumbnail"=>{"get"=>{"summary"=>"Retrieve a thumbnail image", "description"=>"Unlike the other API calls, this API sends back the thumbnail as a PNG file, not JSON. The HTTP response code indicates whether the screenshot was successful (200), or incomplete (404) or failed (404). If the screenshot failed or is not finished, a default image \"Not found\" is sent.\n\nYou can crop your screenshots. The crop is done first, then the thumbnail. You can take a 1024x768 screenshot, crop it to 768x768, and get it scaled down to 300x300.", "operationId"=>"GetThumbnail", "x-api-path-slug"=>"screenshotthumbnail-get", "parameters"=>[{"in"=>"query", "name"=>"bottom", "description"=>"bottom edge of the area to be cropped"}, {"in"=>"query", "name"=>"format", "description"=>"image as PNG or JPEG"}, {"in"=>"query", "name"=>"height", "description"=>"height of the thumbnail"}, {"in"=>"query", "name"=>"id", "description"=>"screenshot ID"}, {"in"=>"query", "name"=>"left", "description"=>"left edge of the area to be cropped"}, {"in"=>"query", "name"=>"quality", "description"=>"JPEG quality factor (for JPEG thumbnails only)"}, {"in"=>"query", "name"=>"ratio", "description"=>"Use fit to keep the original page ration, and fill to get a thumbnail for the exact width and height"}, {"in"=>"query", "name"=>"right", "description"=>"right edge of the area to be cropped"}, {"in"=>"query", "name"=>"scale", "description"=>"scale of the thumbnail"}, {"in"=>"query", "name"=>"shot", "description"=>"get the second or third screenshot if multiple screenshots were requested"}, {"in"=>"query", "name"=>"top", "description"=>"top edge of the area to be cropped"}, {"in"=>"query", "name"=>"width", "description"=>"width of the thumbnail"}, {"in"=>"query", "name"=>"zoom", "description"=>"zoom 1 to 100 percent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Screenshot", "Thumbnail"]}}}}, "apis"=>{"name"=>"Browshot", "x-slug"=>"browshot", "description"=>"Browshot is a service to take screenshot of web pages. Use any of our mobile and desktop browsers. We provide a powerful API and libraries.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/717-browshot-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"1714303", "tags"=>"API Provider,Browsers,internet,Mobile,Profiles,SaaS,Screen Capture,Screenshot,Service API,Technology,Utility", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"browshot/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Browshot", "x-api-slug"=>"browshot", "description"=>"A service to easily make screenshots of web pages in any screen size, as any device: iPhone, iPad, Android, Nook, PC, etc. Test your site on different devices in many resolutions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/717-browshot-com.jpg", "humanURL"=>"http://browshot.com/", "baseURL"=>"https://api.browshot.com//api/v1", "tags"=>"API Provider,Browsers,internet,Mobile,Profiles,SaaS,Screen Capture,Screenshot,Service API,Technology,Utility", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/browshot/screenshotthumbnail-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/browshot/browshot-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://browshot.com/"}, {"type"=>"x-base", "url"=>"https://api.browshot.com/api/"}, {"type"=>"x-blog", "url"=>"http://blog.browshot.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.browshot.com/feeds/posts/default"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/browshot"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/browshot"}, {"type"=>"x-developer", "url"=>"http://browshot.com/api/documentation"}, {"type"=>"x-email", "url"=>"feedback@browshot.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/BrowshotCom"}, {"type"=>"x-website", "url"=>"http://browshot.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
product-hunt{"product-hunt-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Product Hunt", "x-complete"=>1, "info"=>{"title"=>"Product Hunt", "version"=>"1.0.0"}, "host"=>"api.producthunt.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/users/{username}"=>{"get"=>{"summary"=>"Get Users", "description"=>"Get users.", "operationId"=>"getUsersUsername", "x-api-path-slug"=>"usersusername-get", "parameters"=>[{"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/categories/{category}/posts"=>{"get"=>{"summary"=>"Get Categories", "description"=>"Get categories.", "operationId"=>"getCategoriesCategoryAdds", "x-api-path-slug"=>"categoriescategoryposts-get", "parameters"=>[{"in"=>"path", "name"=>"category"}, {"in"=>"query", "name"=>"days_ago"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories"]}}}}, "apis"=>{"name"=>"Product Hunt", "x-slug"=>"product-hunt", "description"=>"Product Hunt is a curation of the best new products, every day. Discover the latest mobile apps, websites, and technology products that everyones talking about.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11269-product-hunt.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"4019", "tags"=>"Applications,Curation,Discovery,Evangelism,General Data,internet,Media,Mobile,Products,Relative Data,Relative StreamRank,Service API,Startups,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"product-hunt/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Product Hunt", "x-api-slug"=>"product-hunt", "description"=>"Product Hunt is a curation of the best new products, every day. Discover the latest mobile apps, websites, and technology products that everyones talking about.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11269-product-hunt.jpg", "humanURL"=>"http://producthunt.com", "baseURL"=>"https://api.producthunt.com//v1", "tags"=>"Applications,Curation,Discovery,Evangelism,General Data,internet,Media,Mobile,Products,Relative Data,Relative StreamRank,Service API,Startups,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/product-hunt/categoriescategoryposts-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/product-hunt/product-hunt-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-api-json--authoritative", "url"=>"https://raw.githubusercontent.com/producthunt/producthunt-api/master/manifests/v1/apis.json"}, {"type"=>"x-blog", "url"=>"https://stories.producthunt.com/"}, {"type"=>"x-blog-rss", "url"=>"https://stories.producthunt.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/product-hunt"}, {"type"=>"x-email", "url"=>"hello@producthunt.com"}, {"type"=>"x-email", "url"=>"ship@producthunt.com"}, {"type"=>"x-github", "url"=>"https://github.com/producthunt"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/product-hunt/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/producthunt"}, {"type"=>"x-website", "url"=>"http://producthunt.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-storage{"google-cloud-storage-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Storage", "x-complete"=>1, "info"=>{"title"=>"Google Cloud Storage", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/b"=>{"get"=>{"summary"=>"Get Buckets", "description"=>"Retrieves a list of buckets for a given project.", "operationId"=>"storage.buckets.list", "x-api-path-slug"=>"b-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of buckets to return in a single response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A previously-returned page token representing part of the larger set of results to view"}, {"in"=>"query", "name"=>"prefix", "description"=>"Filter results to buckets whose names begin with this prefix"}, {"in"=>"query", "name"=>"project", "description"=>"A valid API project identifier"}, {"in"=>"query", "name"=>"projection", "description"=>"Set of properties to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket"]}, "post"=>{"summary"=>"Create Bucket", "description"=>"Creates a new bucket.", "operationId"=>"storage.buckets.insert", "x-api-path-slug"=>"b-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"predefinedAcl", "description"=>"Apply a predefined set of access controls to this bucket"}, {"in"=>"query", "name"=>"predefinedDefaultObjectAcl", "description"=>"Apply a predefined set of default object access controls to this bucket"}, {"in"=>"query", "name"=>"project", "description"=>"A valid API project identifier"}, {"in"=>"query", "name"=>"projection", "description"=>"Set of properties to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket"]}}, "/b/{bucket}"=>{"delete"=>{"summary"=>"Delete Bucket", "description"=>"Permanently deletes an empty bucket.", "operationId"=>"storage.buckets.delete", "x-api-path-slug"=>"bbucket-delete", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"query", "name"=>"ifMetagenerationMatch", "description"=>"If set, only deletes the bucket if its metageneration matches this value"}, {"in"=>"query", "name"=>"ifMetagenerationNotMatch", "description"=>"If set, only deletes the bucket if its metageneration does not match this value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket"]}, "get"=>{"summary"=>"Get Bucket", "description"=>"Returns metadata for the specified bucket.", "operationId"=>"storage.buckets.get", "x-api-path-slug"=>"bbucket-get", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"query", "name"=>"ifMetagenerationMatch", "description"=>"Makes the return of the bucket metadata conditional on whether the buckets current metageneration matches the given value"}, {"in"=>"query", "name"=>"ifMetagenerationNotMatch", "description"=>"Makes the return of the bucket metadata conditional on whether the buckets current metageneration does not match the given value"}, {"in"=>"query", "name"=>"projection", "description"=>"Set of properties to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket"]}, "patch"=>{"summary"=>"Update bucket", "description"=>"Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. This method supports patch semantics.", "operationId"=>"storage.buckets.patch", "x-api-path-slug"=>"bbucket-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"query", "name"=>"ifMetagenerationMatch", "description"=>"Makes the return of the bucket metadata conditional on whether the buckets current metageneration matches the given value"}, {"in"=>"query", "name"=>"ifMetagenerationNotMatch", "description"=>"Makes the return of the bucket metadata conditional on whether the buckets current metageneration does not match the given value"}, {"in"=>"query", "name"=>"predefinedAcl", "description"=>"Apply a predefined set of access controls to this bucket"}, {"in"=>"query", "name"=>"predefinedDefaultObjectAcl", "description"=>"Apply a predefined set of default object access controls to this bucket"}, {"in"=>"query", "name"=>"projection", "description"=>"Set of properties to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket"]}, "put"=>{"summary"=>"Update bucket", "description"=>"Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.", "operationId"=>"storage.buckets.update", "x-api-path-slug"=>"bbucket-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"query", "name"=>"ifMetagenerationMatch", "description"=>"Makes the return of the bucket metadata conditional on whether the buckets current metageneration matches the given value"}, {"in"=>"query", "name"=>"ifMetagenerationNotMatch", "description"=>"Makes the return of the bucket metadata conditional on whether the buckets current metageneration does not match the given value"}, {"in"=>"query", "name"=>"predefinedAcl", "description"=>"Apply a predefined set of access controls to this bucket"}, {"in"=>"query", "name"=>"predefinedDefaultObjectAcl", "description"=>"Apply a predefined set of default object access controls to this bucket"}, {"in"=>"query", "name"=>"projection", "description"=>"Set of properties to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket"]}}, "/b/{bucket}/acl"=>{"get"=>{"summary"=>"Get Bucket ACLs", "description"=>"Retrieves ACL entries on the specified bucket.", "operationId"=>"storage.bucketAccessControls.list", "x-api-path-slug"=>"bbucketacl-get", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket ACL"]}, "post"=>{"summary"=>"Create Bucket ACL", "description"=>"Creates a new ACL entry on the specified bucket.", "operationId"=>"storage.bucketAccessControls.insert", "x-api-path-slug"=>"bbucketacl-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket ACL"]}}, "/b/{bucket}/acl/{entity}"=>{"delete"=>{"summary"=>"Delete Bucket ACL", "description"=>"Permanently deletes the ACL entry for the specified entity on the specified bucket.", "operationId"=>"storage.bucketAccessControls.delete", "x-api-path-slug"=>"bbucketaclentity-delete", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"path", "name"=>"entity", "description"=>"The entity holding the permission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket ACL"]}, "get"=>{"summary"=>"Get Bucket ACL", "description"=>"Returns the ACL entry for the specified entity on the specified bucket.", "operationId"=>"storage.bucketAccessControls.get", "x-api-path-slug"=>"bbucketaclentity-get", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"path", "name"=>"entity", "description"=>"The entity holding the permission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket ACL"]}, "patch"=>{"summary"=>"Update Bucket ACL", "description"=>"Updates an ACL entry on the specified bucket. This method supports patch semantics.", "operationId"=>"storage.bucketAccessControls.patch", "x-api-path-slug"=>"bbucketaclentity-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"path", "name"=>"entity", "description"=>"The entity holding the permission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket ACL"]}, "put"=>{"summary"=>"Update Bucket ACL", "description"=>"Updates an ACL entry on the specified bucket.", "operationId"=>"storage.bucketAccessControls.update", "x-api-path-slug"=>"bbucketaclentity-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"path", "name"=>"entity", "description"=>"The entity holding the permission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket ACL"]}}, "/b/{bucket}/defaultObjectAcl"=>{"get"=>{"summary"=>"Get Bucket Default ACL", "description"=>"Retrieves default object ACL entries on the specified bucket.", "operationId"=>"storage.defaultObjectAccessControls.list", "x-api-path-slug"=>"bbucketdefaultobjectacl-get", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"query", "name"=>"ifMetagenerationMatch", "description"=>"If present, only return default ACL listing if the buckets current metageneration matches this value"}, {"in"=>"query", "name"=>"ifMetagenerationNotMatch", "description"=>"If present, only return default ACL listing if the buckets current metageneration does not match the given value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket ACL"]}, "post"=>{"summary"=>"Create Bucket Default ACL", "description"=>"Creates a new default object ACL entry on the specified bucket.", "operationId"=>"storage.defaultObjectAccessControls.insert", "x-api-path-slug"=>"bbucketdefaultobjectacl-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket ACL"]}}, "/b/{bucket}/defaultObjectAcl/{entity}"=>{"delete"=>{"summary"=>"Default Bucket Default ACL", "description"=>"Permanently deletes the default object ACL entry for the specified entity on the specified bucket.", "operationId"=>"storage.defaultObjectAccessControls.delete", "x-api-path-slug"=>"bbucketdefaultobjectaclentity-delete", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"path", "name"=>"entity", "description"=>"The entity holding the permission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket ACL"]}, "get"=>{"summary"=>"Get Bucket Default ACL", "description"=>"Returns the default object ACL entry for the specified entity on the specified bucket.", "operationId"=>"storage.defaultObjectAccessControls.get", "x-api-path-slug"=>"bbucketdefaultobjectaclentity-get", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"path", "name"=>"entity", "description"=>"The entity holding the permission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket ACL"]}, "patch"=>{"summary"=>"Update Bucket Default ACL", "description"=>"Updates a default object ACL entry on the specified bucket. This method supports patch semantics.", "operationId"=>"storage.defaultObjectAccessControls.patch", "x-api-path-slug"=>"bbucketdefaultobjectaclentity-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"path", "name"=>"entity", "description"=>"The entity holding the permission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket ACL"]}, "put"=>{"summary"=>"Update Bucket Default ACL", "description"=>"Updates a default object ACL entry on the specified bucket.", "operationId"=>"storage.defaultObjectAccessControls.update", "x-api-path-slug"=>"bbucketdefaultobjectaclentity-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"path", "name"=>"entity", "description"=>"The entity holding the permission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket ACL"]}}, "/b/{bucket}/iam"=>{"get"=>{"summary"=>"Get Bucket IAM", "description"=>"Returns an IAM policy for the specified bucket.", "operationId"=>"storage.buckets.getIamPolicy", "x-api-path-slug"=>"bbucketiam-get", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket IAM"]}, "put"=>{"summary"=>"Update Bucket IAM", "description"=>"Updates an IAM policy for the specified bucket.", "operationId"=>"storage.buckets.setIamPolicy", "x-api-path-slug"=>"bbucketiam-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket IAM"]}}, "/b/{bucket}/iam/testPermissions"=>{"get"=>{"summary"=>"Test Bucket IAM Permissions", "description"=>"Tests a set of permissions on the given bucket to see which, if any, are held by the caller.", "operationId"=>"storage.buckets.testIamPermissions", "x-api-path-slug"=>"bbucketiamtestpermissions-get", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"query", "name"=>"permissions", "description"=>"Permissions to test"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket IAM"]}}, "/b/{bucket}/o"=>{"get"=>{"summary"=>"Get Objects", "description"=>"Retrieves a list of objects matching the criteria.", "operationId"=>"storage.objects.list", "x-api-path-slug"=>"bbucketo-get", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of the bucket in which to look for objects"}, {"in"=>"query", "name"=>"delimiter", "description"=>"Returns results in a directory-like mode"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of items plus prefixes to return in a single page of responses"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A previously-returned page token representing part of the larger set of results to view"}, {"in"=>"query", "name"=>"prefix", "description"=>"Filter results to objects whose names begin with this prefix"}, {"in"=>"query", "name"=>"projection", "description"=>"Set of properties to return"}, {"in"=>"query", "name"=>"versions", "description"=>"If true, lists all versions of an object as distinct results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object"]}, "post"=>{"summary"=>"Add New Object", "description"=>"Stores a new object and metadata.", "operationId"=>"storage.objects.insert", "x-api-path-slug"=>"bbucketo-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bucket", "description"=>"Name of the bucket in which to store the new object"}, {"in"=>"query", "name"=>"contentEncoding", "description"=>"If set, sets the contentEncoding property of the final object to this value"}, {"in"=>"query", "name"=>"ifGenerationMatch", "description"=>"Makes the operation conditional on whether the objects current generation matches the given value"}, {"in"=>"query", "name"=>"ifGenerationNotMatch", "description"=>"Makes the operation conditional on whether the objects current generation does not match the given value"}, {"in"=>"query", "name"=>"ifMetagenerationMatch", "description"=>"Makes the operation conditional on whether the objects current metageneration matches the given value"}, {"in"=>"query", "name"=>"ifMetagenerationNotMatch", "description"=>"Makes the operation conditional on whether the objects current metageneration does not match the given value"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the object"}, {"in"=>"query", "name"=>"predefinedAcl", "description"=>"Apply a predefined set of access controls to this object"}, {"in"=>"query", "name"=>"projection", "description"=>"Set of properties to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object"]}}, "/b/{bucket}/o/watch"=>{"post"=>{"summary"=>"Update Object", "description"=>"Watch for changes on all objects in a bucket.", "operationId"=>"storage.objects.watchAll", "x-api-path-slug"=>"bbucketowatch-post", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of the bucket in which to look for objects"}, {"in"=>"query", "name"=>"delimiter", "description"=>"Returns results in a directory-like mode"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of items plus prefixes to return in a single page of responses"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A previously-returned page token representing part of the larger set of results to view"}, {"in"=>"query", "name"=>"prefix", "description"=>"Filter results to objects whose names begin with this prefix"}, {"in"=>"query", "name"=>"projection", "description"=>"Set of properties to return"}, {"in"=>"body", "name"=>"resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"versions", "description"=>"If true, lists all versions of an object as distinct results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object"]}}, "/b/{bucket}/o/{object}"=>{"delete"=>{"summary"=>"Delete Object", "description"=>"Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.", "operationId"=>"storage.objects.delete", "x-api-path-slug"=>"bbucketoobject-delete", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of the bucket in which the object resides"}, {"in"=>"query", "name"=>"generation", "description"=>"If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default)"}, {"in"=>"query", "name"=>"ifGenerationMatch", "description"=>"Makes the operation conditional on whether the objects current generation matches the given value"}, {"in"=>"query", "name"=>"ifGenerationNotMatch", "description"=>"Makes the operation conditional on whether the objects current generation does not match the given value"}, {"in"=>"query", "name"=>"ifMetagenerationMatch", "description"=>"Makes the operation conditional on whether the objects current metageneration matches the given value"}, {"in"=>"query", "name"=>"ifMetagenerationNotMatch", "description"=>"Makes the operation conditional on whether the objects current metageneration does not match the given value"}, {"in"=>"path", "name"=>"object", "description"=>"Name of the object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object"]}, "get"=>{"summary"=>"Get Object", "description"=>"Retrieves an object or its metadata.", "operationId"=>"storage.objects.get", "x-api-path-slug"=>"bbucketoobject-get", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of the bucket in which the object resides"}, {"in"=>"query", "name"=>"generation", "description"=>"If present, selects a specific revision of this object (as opposed to the latest version, the default)"}, {"in"=>"query", "name"=>"ifGenerationMatch", "description"=>"Makes the operation conditional on whether the objects generation matches the given value"}, {"in"=>"query", "name"=>"ifGenerationNotMatch", "description"=>"Makes the operation conditional on whether the objects generation does not match the given value"}, {"in"=>"query", "name"=>"ifMetagenerationMatch", "description"=>"Makes the operation conditional on whether the objects current metageneration matches the given value"}, {"in"=>"query", "name"=>"ifMetagenerationNotMatch", "description"=>"Makes the operation conditional on whether the objects current metageneration does not match the given value"}, {"in"=>"path", "name"=>"object", "description"=>"Name of the object"}, {"in"=>"query", "name"=>"projection", "description"=>"Set of properties to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object"]}, "patch"=>{"summary"=>"Update Object", "description"=>"Updates an object's metadata. This method supports patch semantics.", "operationId"=>"storage.objects.patch", "x-api-path-slug"=>"bbucketoobject-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bucket", "description"=>"Name of the bucket in which the object resides"}, {"in"=>"query", "name"=>"generation", "description"=>"If present, selects a specific revision of this object (as opposed to the latest version, the default)"}, {"in"=>"query", "name"=>"ifGenerationMatch", "description"=>"Makes the operation conditional on whether the objects current generation matches the given value"}, {"in"=>"query", "name"=>"ifGenerationNotMatch", "description"=>"Makes the operation conditional on whether the objects current generation does not match the given value"}, {"in"=>"query", "name"=>"ifMetagenerationMatch", "description"=>"Makes the operation conditional on whether the objects current metageneration matches the given value"}, {"in"=>"query", "name"=>"ifMetagenerationNotMatch", "description"=>"Makes the operation conditional on whether the objects current metageneration does not match the given value"}, {"in"=>"path", "name"=>"object", "description"=>"Name of the object"}, {"in"=>"query", "name"=>"predefinedAcl", "description"=>"Apply a predefined set of access controls to this object"}, {"in"=>"query", "name"=>"projection", "description"=>"Set of properties to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object"]}, "put"=>{"summary"=>"Update Object", "description"=>"Updates an object's metadata.", "operationId"=>"storage.objects.update", "x-api-path-slug"=>"bbucketoobject-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bucket", "description"=>"Name of the bucket in which the object resides"}, {"in"=>"query", "name"=>"generation", "description"=>"If present, selects a specific revision of this object (as opposed to the latest version, the default)"}, {"in"=>"query", "name"=>"ifGenerationMatch", "description"=>"Makes the operation conditional on whether the objects current generation matches the given value"}, {"in"=>"query", "name"=>"ifGenerationNotMatch", "description"=>"Makes the operation conditional on whether the objects current generation does not match the given value"}, {"in"=>"query", "name"=>"ifMetagenerationMatch", "description"=>"Makes the operation conditional on whether the objects current metageneration matches the given value"}, {"in"=>"query", "name"=>"ifMetagenerationNotMatch", "description"=>"Makes the operation conditional on whether the objects current metageneration does not match the given value"}, {"in"=>"path", "name"=>"object", "description"=>"Name of the object"}, {"in"=>"query", "name"=>"predefinedAcl", "description"=>"Apply a predefined set of access controls to this object"}, {"in"=>"query", "name"=>"projection", "description"=>"Set of properties to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object"]}}, "/b/{bucket}/o/{object}/acl"=>{"get"=>{"summary"=>"Get Object ACLs", "description"=>"Retrieves ACL entries on the specified object.", "operationId"=>"storage.objectAccessControls.list", "x-api-path-slug"=>"bbucketoobjectacl-get", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"query", "name"=>"generation", "description"=>"If present, selects a specific revision of this object (as opposed to the latest version, the default)"}, {"in"=>"path", "name"=>"object", "description"=>"Name of the object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object ACL"]}, "post"=>{"summary"=>"Create Object ACL", "description"=>"Creates a new ACL entry on the specified object.", "operationId"=>"storage.objectAccessControls.insert", "x-api-path-slug"=>"bbucketoobjectacl-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"query", "name"=>"generation", "description"=>"If present, selects a specific revision of this object (as opposed to the latest version, the default)"}, {"in"=>"path", "name"=>"object", "description"=>"Name of the object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object ACL"]}}, "/b/{bucket}/o/{object}/acl/{entity}"=>{"delete"=>{"summary"=>"Delete Object ACL", "description"=>"Permanently deletes the ACL entry for the specified entity on the specified object.", "operationId"=>"storage.objectAccessControls.delete", "x-api-path-slug"=>"bbucketoobjectaclentity-delete", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"path", "name"=>"entity", "description"=>"The entity holding the permission"}, {"in"=>"query", "name"=>"generation", "description"=>"If present, selects a specific revision of this object (as opposed to the latest version, the default)"}, {"in"=>"path", "name"=>"object", "description"=>"Name of the object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object ACL"]}, "get"=>{"summary"=>"Get Object ACL", "description"=>"Returns the ACL entry for the specified entity on the specified object.", "operationId"=>"storage.objectAccessControls.get", "x-api-path-slug"=>"bbucketoobjectaclentity-get", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"path", "name"=>"entity", "description"=>"The entity holding the permission"}, {"in"=>"query", "name"=>"generation", "description"=>"If present, selects a specific revision of this object (as opposed to the latest version, the default)"}, {"in"=>"path", "name"=>"object", "description"=>"Name of the object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object ACL"]}, "patch"=>{"summary"=>"Update Object ACL", "description"=>"Updates an ACL entry on the specified object. This method supports patch semantics.", "operationId"=>"storage.objectAccessControls.patch", "x-api-path-slug"=>"bbucketoobjectaclentity-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"path", "name"=>"entity", "description"=>"The entity holding the permission"}, {"in"=>"query", "name"=>"generation", "description"=>"If present, selects a specific revision of this object (as opposed to the latest version, the default)"}, {"in"=>"path", "name"=>"object", "description"=>"Name of the object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object ACL"]}, "put"=>{"summary"=>"Update Object ACL", "description"=>"Updates an ACL entry on the specified object.", "operationId"=>"storage.objectAccessControls.update", "x-api-path-slug"=>"bbucketoobjectaclentity-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bucket", "description"=>"Name of a bucket"}, {"in"=>"path", "name"=>"entity", "description"=>"The entity holding the permission"}, {"in"=>"query", "name"=>"generation", "description"=>"If present, selects a specific revision of this object (as opposed to the latest version, the default)"}, {"in"=>"path", "name"=>"object", "description"=>"Name of the object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object ACL"]}}, "/b/{bucket}/o/{object}/iam"=>{"get"=>{"summary"=>"Get Object IAM", "description"=>"Returns an IAM policy for the specified object.", "operationId"=>"storage.objects.getIamPolicy", "x-api-path-slug"=>"bbucketoobjectiam-get", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of the bucket in which the object resides"}, {"in"=>"query", "name"=>"generation", "description"=>"If present, selects a specific revision of this object (as opposed to the latest version, the default)"}, {"in"=>"path", "name"=>"object", "description"=>"Name of the object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object IAM"]}, "put"=>{"summary"=>"Update Object IAM", "description"=>"Updates an IAM policy for the specified object.", "operationId"=>"storage.objects.setIamPolicy", "x-api-path-slug"=>"bbucketoobjectiam-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bucket", "description"=>"Name of the bucket in which the object resides"}, {"in"=>"query", "name"=>"generation", "description"=>"If present, selects a specific revision of this object (as opposed to the latest version, the default)"}, {"in"=>"path", "name"=>"object", "description"=>"Name of the object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object IAM"]}}, "/b/{bucket}/o/{object}/iam/testPermissions"=>{"get"=>{"summary"=>"Test Object IAM Permissions", "description"=>"Tests a set of permissions on the given object to see which, if any, are held by the caller.", "operationId"=>"storage.objects.testIamPermissions", "x-api-path-slug"=>"bbucketoobjectiamtestpermissions-get", "parameters"=>[{"in"=>"path", "name"=>"bucket", "description"=>"Name of the bucket in which the object resides"}, {"in"=>"query", "name"=>"generation", "description"=>"If present, selects a specific revision of this object (as opposed to the latest version, the default)"}, {"in"=>"path", "name"=>"object", "description"=>"Name of the object"}, {"in"=>"query", "name"=>"permissions", "description"=>"Permissions to test"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object IAM"]}}, "/b/{destinationBucket}/o/{destinationObject}/compose"=>{"post"=>{"summary"=>"Concatenate Objects", "description"=>"Concatenates a list of existing objects into a new object in the same bucket.", "operationId"=>"storage.objects.compose", "x-api-path-slug"=>"bdestinationbucketodestinationobjectcompose-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"destinationBucket", "description"=>"Name of the bucket in which to store the new object"}, {"in"=>"path", "name"=>"destinationObject", "description"=>"Name of the new object"}, {"in"=>"query", "name"=>"destinationPredefinedAcl", "description"=>"Apply a predefined set of access controls to the destination object"}, {"in"=>"query", "name"=>"ifGenerationMatch", "description"=>"Makes the operation conditional on whether the objects current generation matches the given value"}, {"in"=>"query", "name"=>"ifMetagenerationMatch", "description"=>"Makes the operation conditional on whether the objects current metageneration matches the given value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object"]}}, "/b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}"=>{"post"=>{"summary"=>"Copy Object", "description"=>"Copies a source object to a destination object. Optionally overrides metadata.", "operationId"=>"storage.objects.copy", "x-api-path-slug"=>"bsourcebucketosourceobjectcopytobdestinationbucketodestinationobject-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"destinationBucket", "description"=>"Name of the bucket in which to store the new object"}, {"in"=>"path", "name"=>"destinationObject", "description"=>"Name of the new object"}, {"in"=>"query", "name"=>"destinationPredefinedAcl", "description"=>"Apply a predefined set of access controls to the destination object"}, {"in"=>"query", "name"=>"ifGenerationMatch", "description"=>"Makes the operation conditional on whether the destination objects current generation matches the given value"}, {"in"=>"query", "name"=>"ifGenerationNotMatch", "description"=>"Makes the operation conditional on whether the destination objects current generation does not match the given value"}, {"in"=>"query", "name"=>"ifMetagenerationMatch", "description"=>"Makes the operation conditional on whether the destination objects current metageneration matches the given value"}, {"in"=>"query", "name"=>"ifMetagenerationNotMatch", "description"=>"Makes the operation conditional on whether the destination objects current metageneration does not match the given value"}, {"in"=>"query", "name"=>"ifSourceGenerationMatch", "description"=>"Makes the operation conditional on whether the source objects generation matches the given value"}, {"in"=>"query", "name"=>"ifSourceGenerationNotMatch", "description"=>"Makes the operation conditional on whether the source objects generation does not match the given value"}, {"in"=>"query", "name"=>"ifSourceMetagenerationMatch", "description"=>"Makes the operation conditional on whether the source objects current metageneration matches the given value"}, {"in"=>"query", "name"=>"ifSourceMetagenerationNotMatch", "description"=>"Makes the operation conditional on whether the source objects current metageneration does not match the given value"}, {"in"=>"query", "name"=>"projection", "description"=>"Set of properties to return"}, {"in"=>"path", "name"=>"sourceBucket", "description"=>"Name of the bucket in which to find the source object"}, {"in"=>"query", "name"=>"sourceGeneration", "description"=>"If present, selects a specific revision of the source object (as opposed to the latest version, the default)"}, {"in"=>"path", "name"=>"sourceObject", "description"=>"Name of the source object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object"]}}, "/b/{sourceBucket}/o/{sourceObject}/rewriteTo/b/{destinationBucket}/o/{destinationObject}"=>{"post"=>{"summary"=>"Rewrite Object", "description"=>"Rewrites a source object to a destination object. Optionally overrides metadata.", "operationId"=>"storage.objects.rewrite", "x-api-path-slug"=>"bsourcebucketosourceobjectrewritetobdestinationbucketodestinationobject-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"destinationBucket", "description"=>"Name of the bucket in which to store the new object"}, {"in"=>"path", "name"=>"destinationObject", "description"=>"Name of the new object"}, {"in"=>"query", "name"=>"destinationPredefinedAcl", "description"=>"Apply a predefined set of access controls to the destination object"}, {"in"=>"query", "name"=>"ifGenerationMatch", "description"=>"Makes the operation conditional on whether the destination objects current generation matches the given value"}, {"in"=>"query", "name"=>"ifGenerationNotMatch", "description"=>"Makes the operation conditional on whether the destination objects current generation does not match the given value"}, {"in"=>"query", "name"=>"ifMetagenerationMatch", "description"=>"Makes the operation conditional on whether the destination objects current metageneration matches the given value"}, {"in"=>"query", "name"=>"ifMetagenerationNotMatch", "description"=>"Makes the operation conditional on whether the destination objects current metageneration does not match the given value"}, {"in"=>"query", "name"=>"ifSourceGenerationMatch", "description"=>"Makes the operation conditional on whether the source objects generation matches the given value"}, {"in"=>"query", "name"=>"ifSourceGenerationNotMatch", "description"=>"Makes the operation conditional on whether the source objects generation does not match the given value"}, {"in"=>"query", "name"=>"ifSourceMetagenerationMatch", "description"=>"Makes the operation conditional on whether the source objects current metageneration matches the given value"}, {"in"=>"query", "name"=>"ifSourceMetagenerationNotMatch", "description"=>"Makes the operation conditional on whether the source objects current metageneration does not match the given value"}, {"in"=>"query", "name"=>"maxBytesRewrittenPerCall", "description"=>"The maximum number of bytes that will be rewritten per rewrite request"}, {"in"=>"query", "name"=>"projection", "description"=>"Set of properties to return"}, {"in"=>"query", "name"=>"rewriteToken", "description"=>"Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response done flag is true"}, {"in"=>"path", "name"=>"sourceBucket", "description"=>"Name of the bucket in which to find the source object"}, {"in"=>"query", "name"=>"sourceGeneration", "description"=>"If present, selects a specific revision of the source object (as opposed to the latest version, the default)"}, {"in"=>"path", "name"=>"sourceObject", "description"=>"Name of the source object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object"]}}, "/channels/stop"=>{"post"=>{"summary"=>"Stop Watching Channel", "description"=>"Stop watching resources through this channel", "operationId"=>"storage.channels.stop", "x-api-path-slug"=>"channelsstop-post", "parameters"=>[{"in"=>"body", "name"=>"resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel"]}}, "/v1/googleServiceAccounts/{projectId}"=>{"get"=>{"summary"=>"Get Account", "description"=>"Returns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each Google service account is associated with one Google Developers Console project. Users should add this service account to the Google Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.", "operationId"=>"storagetransfer.googleServiceAccounts.get", "x-api-path-slug"=>"v1googleserviceaccountsprojectid-get", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"The ID of the Google Developers Console project that the Google service account is associated with"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/v1/transferJobs"=>{"get"=>{"summary"=>"Get Transfer Jobs", "description"=>"Lists transfer jobs.", "operationId"=>"storagetransfer.transferJobs.list", "x-api-path-slug"=>"v1transferjobs-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"A list of query parameters specified as JSON text in the form of {`project_id`:my_project_id, `job_names`:[jobid1,jobid2,"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The list page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The list page token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}, "post"=>{"summary"=>"Create Transfer Jobs", "description"=>"Creates a transfer job that runs periodically.", "operationId"=>"storagetransfer.transferJobs.create", "x-api-path-slug"=>"v1transferjobs-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/v1/{jobName}"=>{"get"=>{"summary"=>"Get Transfer Jobs", "description"=>"Gets a transfer job.", "operationId"=>"storagetransfer.transferJobs.get", "x-api-path-slug"=>"v1jobname-get", "parameters"=>[{"in"=>"path", "name"=>"jobName", "description"=>"The job to get"}, {"in"=>"query", "name"=>"projectId", "description"=>"The ID of the Google Developers Console project that owns the job"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}, "patch"=>{"summary"=>"Update Transfer Jobs", "description"=>"Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating the scheduling of a job is not allowed.", "operationId"=>"storagetransfer.transferJobs.patch", "x-api-path-slug"=>"v1jobname-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"jobName", "description"=>"The name of job to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/v1/{name}"=>{"delete"=>{"summary"=>"Delete Transfer Operations", "description"=>"This method is not supported and the server returns `UNIMPLEMENTED`.", "operationId"=>"storagetransfer.transferOperations.delete", "x-api-path-slug"=>"v1name-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the operation resource to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}, "get"=>{"summary"=>"Get Transfer Operations", "description"=>"Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.", "operationId"=>"storagetransfer.transferOperations.list", "x-api-path-slug"=>"v1name-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"The standard list filter"}, {"in"=>"path", "name"=>"name", "description"=>"The value `transferOperations`"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The standard list page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The standard list page token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1/{name}:cancel"=>{"post"=>{"summary"=>"Cancel Transfer Operation", "description"=>"Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.", "operationId"=>"storagetransfer.transferOperations.cancel", "x-api-path-slug"=>"v1namecancel-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the operation resource to be cancelled"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1/{name}:pause"=>{"post"=>{"summary"=>"Pause Transfer Operation", "description"=>"Pauses a transfer operation.", "operationId"=>"storagetransfer.transferOperations.pause", "x-api-path-slug"=>"v1namepause-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The name of the transfer operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1/{name}:resume"=>{"post"=>{"summary"=>"Resume Transfer Operation", "description"=>"Resumes a transfer operation that is paused.", "operationId"=>"storagetransfer.transferOperations.resume", "x-api-path-slug"=>"v1nameresume-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The name of the transfer operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1:getGoogleServiceAccount"=>{"get"=>{"summary"=>"Get Service Account", "description"=>"Returns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each Google service account is associated with one Google Developers Console project. Users should add this service account to the Google Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.", "operationId"=>"storagetransfer.getGoogleServiceAccount", "x-api-path-slug"=>"v1getgoogleserviceaccount-get", "parameters"=>[{"in"=>"query", "name"=>"projectId", "description"=>"The ID of the Google Developers Console project that the Google service account is associated with"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}}}, "apis"=>{"name"=>"Google Cloud Storage", "x-slug"=>"google-cloud-storage", "description"=>"Google Cloud Storage is unified object storage for developers and enterprises, from live data serving to data analytics/ML to data archiving. Google Cloud Storage allows world-wide storage and retrieval of any amount of data at any time. You can use Google Cloud Storage for a range of scenarios including serving website content, storing data for archival and disaster recovery, or distributing large data objects to users via direct download.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-cloud-storage-unified-object-storage-2x.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Cloud,Google APIs,Profiles,Relative Data,Service API,Stack Network,Storage", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-storage/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Storage", "x-api-slug"=>"google-cloud-storage", "description"=>"Google Cloud Storage is unified object storage for developers and enterprises, from live data serving to data analytics/ML to data archiving. Google Cloud Storage allows world-wide storage and retrieval of any amount of data at any time. You can use Google Cloud Storage for a range of scenarios including serving website content, storing data for archival and disaster recovery, or distributing large data objects to users via direct download.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-cloud-storage-unified-object-storage-2x.png", "humanURL"=>"https://cloud.google.com/storage/", "baseURL"=>"https:///", "tags"=>"API Provider,API Service Provider,Cloud,Google APIs,Profiles,Relative Data,Service API,Stack Network,Storage", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-storage/google-cloud-storage-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://cloud.google.com/storage/docs/authentication"}, {"type"=>"x-best-practices", "url"=>"https://cloud.google.com/storage/docs/best-practices"}, {"type"=>"x-change-log", "url"=>"https://cloud.google.com/storage/release-notes"}, {"type"=>"x-code", "url"=>"https://cloud.google.com/storage/docs/reference/libraries"}, {"type"=>"x-concepts", "url"=>"https://cloud.google.com/storage/docs/concepts"}, {"type"=>"x-dmca-policy", "url"=>"https://cloud.google.com/storage/docs/dmca"}, {"type"=>"x-faq", "url"=>"https://cloud.google.com/storage/docs/faq"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/storage/docs/quickstarts"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/storage/docs/how-to"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/storage/pricing"}, {"type"=>"x-service-level-agreements", "url"=>"https://cloud.google.com/storage/sla"}, {"type"=>"x-support", "url"=>"https://cloud.google.com/storage/docs/resources-support"}, {"type"=>"x-tutorials", "url"=>"https://cloud.google.com/storage/docs/tutorials"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/storage/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
datumbox{"datumbox-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Datumbox", "x-complete"=>1, "info"=>{"title"=>"DatumBox", "description"=>"datumbox-offers-a-machine-learning-platform-composed-of-14-classifiers-and-natural-language-processing-functions--functions-include-sentiment-analysis-topic-classification-readability-assessment-language-detection-and-much-more-", "version"=>"1.0.0"}, "host"=>"api.datumbox.com", "basePath"=>"1.0/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/AdultContentDetection.json"=>{"post"=>{"summary"=>"Classifies the Document as adult or noadult", "description"=>"The Adult Content Detection function classifies the documents as adult or noadult based on their context. It can be used to detect whether a document contains content unsuitable for minors.", "operationId"=>"AdultContentDetection", "x-api-path-slug"=>"adultcontentdetection-json-post", "parameters"=>[{"in"=>"formData", "name"=>"text", "description"=>"The text that you want to analyze"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Adult Content", "Detection"]}}, "/CommercialDetection.json"=>{"post"=>{"summary"=>"Classifies the Document as commercial or nocommercial", "description"=>"The Commercial Detection function labels the documents as commercial or non-commercial based on their keywords and expressions. It can be used to detect whether a website is commercial or not.", "operationId"=>"CommercialDetection", "x-api-path-slug"=>"commercialdetection-json-post", "parameters"=>[{"in"=>"formData", "name"=>"text", "description"=>"The text that you want to analyze"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commercial", "Detection"]}}, "/DocumentSimilarity.json"=>{"post"=>{"summary"=>"Estimates the similarity between 2 Documents", "description"=>"The Document Similarity function estimates the degree of similarity between two documents. It can be used to detect duplicate webpages or detect plagiarism.", "operationId"=>"DocumentSimilarity", "x-api-path-slug"=>"documentsimilarity-json-post", "parameters"=>[{"in"=>"formData", "name"=>"copy", "description"=>"The second text"}, {"in"=>"formData", "name"=>"original", "description"=>"The first text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DocumentsSimilarity"]}}, "/EducationalDetection.json"=>{"post"=>{"summary"=>"Classifies the Document as educational or noeducational", "description"=>"The Educational Detection function classifies the documents as educational or non-educational based on their context. It can be used to detect whether a website is educational or not.", "operationId"=>"EducationalDetection", "x-api-path-slug"=>"educationaldetection-json-post", "parameters"=>[{"in"=>"formData", "name"=>"text", "description"=>"The text that you want to analyze"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Educational", "Detection"]}}, "/GenderDetection.json"=>{"post"=>{"summary"=>"Gender Detection Service", "description"=>"The Gender Detection function identifies if a particular document is written-by or targets-to a man or a woman based on the context, the words and the idioms found in the text.", "operationId"=>"GenderDetection", "x-api-path-slug"=>"genderdetection-json-post", "parameters"=>[{"in"=>"formData", "name"=>"text", "description"=>"The text that you want to analyze"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gender", "Detection"]}}, "/KeywordExtraction.json"=>{"post"=>{"summary"=>"Extracts the Keywords of the Document", "description"=>"The Keyword Extraction function enables you to extract from an arbitrary document all the keywords and word-combinations along with their occurrences in the text.", "operationId"=>"KeywordExtraction", "x-api-path-slug"=>"keywordextraction-json-post", "parameters"=>[{"in"=>"formData", "name"=>"n", "description"=>"The number of keyword combinations (n-grams) that you wish to extract"}, {"in"=>"formData", "name"=>"text", "description"=>"The text that you want to analyze"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keyword", "Extraction"]}}, "/LanguageDetection.json"=>{"post"=>{"summary"=>"Identifies the Language of the Document", "description"=>"The Language Detection function identifies the natural language of the given document based on its words and context. This classifier is able to detect 96 different languages.", "operationId"=>"LanguageDetection", "x-api-path-slug"=>"languagedetection-json-post", "parameters"=>[{"in"=>"formData", "name"=>"text", "description"=>"The text that you want to analyze"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Language", "Detection"]}}, "/ReadabilityAssessment.json"=>{"post"=>{"summary"=>"Evaluates the Readability of the Document", "description"=>"The Readability Assessment function determines the degree of readability of a document based on its terms and idioms. The texts are classified as basic, intermediate and advanced depending their difficulty.", "operationId"=>"ReadabilityAssessment", "x-api-path-slug"=>"readabilityassessment-json-post", "parameters"=>[{"in"=>"formData", "name"=>"text", "description"=>"The text that you want to analyze"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Readability", "Assessment"]}}, "/SentimentAnalysis.json"=>{"post"=>{"summary"=>"Identifies the Sentiment of the Document", "description"=>"The Sentiment Analysis function classifies documents as positive, negative or neutral (lack of sentiment) depending on whether they express a positive, negative or neutral opinion.", "operationId"=>"SentimentAnalysis", "x-api-path-slug"=>"sentimentanalysis-json-post", "parameters"=>[{"in"=>"formData", "name"=>"text", "description"=>"The text that you want to analyze"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sentiment", "Analysis"]}}, "/SpamDetection.json"=>{"post"=>{"summary"=>"Classifies the Document as spam or nospam", "description"=>"The Spam Detection function labels documents as spam or nospam by taking into account their context. It can be used to filter out spam emails and comments.", "operationId"=>"SpamDetection", "x-api-path-slug"=>"spamdetection-json-post", "parameters"=>[{"in"=>"formData", "name"=>"text", "description"=>"The text that you want to analyze"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spam", "Detection"]}}, "/SubjectivityAnalysis.json"=>{"post"=>{"summary"=>"Classifies Document as Subjective or Objective", "description"=>"The Subjectivity Analysis function categorizes documents as subjective or objective based on their writing style. Texts that express personal opinions are labeled as subjective and the others as objective.", "operationId"=>"SubjectivityAnalysis", "x-api-path-slug"=>"subjectivityanalysis-json-post", "parameters"=>[{"in"=>"formData", "name"=>"text", "description"=>"The text that you want to analyze"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subjectivity", "Analysis"]}}, "/TextExtraction.json"=>{"post"=>{"summary"=>"Extracts the clear text from Webpage", "description"=>"The Text Extraction function enables you to extract the important information from a given webpage. Extracting the clear text of the documents is an important step before any other analysis.", "operationId"=>"TextExtraction", "x-api-path-slug"=>"textextraction-json-post", "parameters"=>[{"in"=>"formData", "name"=>"text", "description"=>"The HTML source of the webpage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Text", "Extraction"]}}, "/TopicClassification.json"=>{"post"=>{"summary"=>"Identifies the Topic of the Document", "description"=>"The Topic Classification function assigns documents in 12 thematic categories based on their keywords, idioms and jargon. It can be used to identify the topic of the texts.", "operationId"=>"TopicClassification", "x-api-path-slug"=>"topicclassification-json-post", "parameters"=>[{"in"=>"formData", "name"=>"text", "description"=>"The text that you want to analyze"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topic", "Classification"]}}, "/TwitterSentimentAnalysis.json"=>{"post"=>{"summary"=>"Identifies the Sentiment of Twitter Messages", "description"=>"The Twitter Sentiment Analysis function allows you to perform Sentiment Analysis on Twitter. It classifies the tweets as positive, negative or neutral depending on their context.", "operationId"=>"TwitterSentimentAnalysis", "x-api-path-slug"=>"twittersentimentanalysis-json-post", "parameters"=>[{"in"=>"formData", "name"=>"text", "description"=>"The text of the tweet that we evaluate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Twitter", "Sentiment", "Analysis"]}}}}, "apis"=>{"name"=>"Datumbox", "x-slug"=>"datumbox", "description"=>"Build quickly and easily Intelligent Applications by using the power of Machine Learning!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11516-datumbox.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"514549", "tags"=>"API Provider,API Service Provider,Content,Enterprise,Machine Learning,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"datumbox/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Datumbox", "x-api-slug"=>"datumbox", "description"=>"Build quickly and easily Intelligent Applications by using the power of Machine Learning!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11516-datumbox.jpg", "humanURL"=>"http://datumbox.com", "baseURL"=>"https://api.datumbox.com/1.0/", "tags"=>"API Provider,API Service Provider,Content,Enterprise,Machine Learning,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/datumbox/twittersentimentanalysis-json-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/datumbox/datumbox-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-api-json--authoritative", "url"=>"http://apis.io/apisdef/legacy/datumbox.json"}, {"type"=>"x-blog", "url"=>"http://blog.datumbox.com/"}, {"type"=>"x-blog-rss", "url"=>"http://feeds.feedburner.com/Datumbox"}, {"type"=>"x-contact-form", "url"=>"http://www.datumbox.com/contact/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/datumbox"}, {"type"=>"x-developer", "url"=>"http://www.datumbox.com/machine-learning-api/"}, {"type"=>"x-documentation", "url"=>"http://www.datumbox.com/api-sandbox/"}, {"type"=>"x-email", "url"=>"info@datumbox.com"}, {"type"=>"x-facebook", "url"=>"https://www.facebook.com/Datumbox"}, {"type"=>"x-github", "url"=>"https://github.com/datumbox"}, {"type"=>"x-google-plus", "url"=>"https://plus.google.com/105921437813621882157/posts"}, {"type"=>"x-privacy", "url"=>"http://www.datumbox.com/privacy-policy/"}, {"type"=>"x-terms-of-service", "url"=>"http://www.datumbox.com/terms-of-use/"}, {"type"=>"x-website", "url"=>"http://datumbox.com"}, {"type"=>"x-website", "url"=>"http://www.datumbox.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-storage-gateway-service{"aws-storage-gateway-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Storage Gateway Service", "x-complete"=>1, "info"=>{"title"=>"AWS Storage Gateway Service API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=ActivateGateway"=>{"get"=>{"summary"=>"Activate Gateway", "description"=>"Activates the gateway you previously deployed on your host.", "operationId"=>"activateGateway", "x-api-path-slug"=>"actionactivategateway-get", "parameters"=>[{"in"=>"query", "name"=>"ActivationKey", "description"=>"Your gateway activation key", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayName", "description"=>"The name you configured for your gateway", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayRegion", "description"=>"A value that indicates the region where you want to store the snapshot backups", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayTimezone", "description"=>"A value that indicates the time zone you want to set for the gateway", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayType", "description"=>"A value that defines the type of gateway to activate", "type"=>"string"}, {"in"=>"query", "name"=>"MediumChangerType", "description"=>"The value that indicates the type of medium changer to use for gateway-VTL", "type"=>"string"}, {"in"=>"query", "name"=>"TapeDriveType", "description"=>"The value that indicates the type of tape drive to use for gateway-VTL", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gateway"]}}, "/?Action=AddCache"=>{"get"=>{"summary"=>"Add Cache", "description"=>"Configures one or more gateway local disks as cache for a cached-volume gateway.", "operationId"=>"addCache", "x-api-path-slug"=>"actionaddcache-get", "parameters"=>[{"in"=>"query", "name"=>"DiskIds", "description"=>"Type: array of Strings", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache"]}}, "/?Action=AddTagsToResource"=>{"get"=>{"summary"=>"Add Tags To Resource", "description"=>"Adds one or more tags to the specified resource.", "operationId"=>"addTagsToResource", "x-api-path-slug"=>"actionaddtagstoresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceARN", "description"=>"The Amazon Resource Name (ARN) of the resource you want to add tags to", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"The key-value pair that represents the tag you want to add to the resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=AddUploadBuffer"=>{"get"=>{"summary"=>"Add Upload Buffer", "description"=>"Configures one or more gateway local disks as upload buffer for a specified gateway.", "operationId"=>"addUploadBuffer", "x-api-path-slug"=>"actionadduploadbuffer-get", "parameters"=>[{"in"=>"query", "name"=>"DiskIds", "description"=>"Type: array of Strings", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload Buffer"]}}, "/?Action=AddWorkingStorage"=>{"get"=>{"summary"=>"Add Working Storage", "description"=>"Configures one or more gateway local disks as working storage for a gateway.", "operationId"=>"addWorkingStorage", "x-api-path-slug"=>"actionaddworkingstorage-get", "parameters"=>[{"in"=>"query", "name"=>"DiskIds", "description"=>"An array of strings that identify disks that are to be configured as working storage", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Working Storage"]}}, "/?Action=CancelArchival"=>{"get"=>{"summary"=>"Cancel Archival", "description"=>"Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the\n archiving process is initiated.", "operationId"=>"cancelArchival", "x-api-path-slug"=>"actioncancelarchival-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}, {"in"=>"query", "name"=>"TapeARN", "description"=>"The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Archival"]}}, "/?Action=CancelRetrieval"=>{"get"=>{"summary"=>"Cancel Retrieval", "description"=>"Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway\n after the retrieval process is initiated.", "operationId"=>"cancelRetrieval", "x-api-path-slug"=>"actioncancelretrieval-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}, {"in"=>"query", "name"=>"TapeARN", "description"=>"The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieval"]}}, "/?Action=CreateCachediSCSIVolume"=>{"get"=>{"summary"=>"Create Cached SCSI Volume", "description"=>"Creates a cached volume on a specified cached gateway.", "operationId"=>"createCachediSCSIVolume", "x-api-path-slug"=>"actioncreatecachediscsivolume-get", "parameters"=>[{"in"=>"query", "name"=>"ClientToken", "description"=>"Type: String", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"Type: String", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotId", "description"=>"Type: String", "type"=>"string"}, {"in"=>"query", "name"=>"SourceVolumeARN", "description"=>"The ARN for an existing volume", "type"=>"string"}, {"in"=>"query", "name"=>"TargetName", "description"=>"Type: String", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeSizeInBytes", "description"=>"Type: Long", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cached SCSI Volume"]}}, "/?Action=CreateNFSFileShare"=>{"get"=>{"summary"=>"Create NFS File Share", "description"=>"Creates a file share on an existing file gateway.", "operationId"=>"createNFSFileShare", "x-api-path-slug"=>"actioncreatenfsfileshare-get", "parameters"=>[{"in"=>"query", "name"=>"ClientToken", "description"=>"A unique string value that you supply that is used by file gateway to ensure idempotent file share creation", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultStorageClass", "description"=>"The default storage class for objects put into an Amazon S3 bucket by file gateway", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share", "type"=>"string"}, {"in"=>"query", "name"=>"KMSEncrypted", "description"=>"True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3", "type"=>"string"}, {"in"=>"query", "name"=>"KMSKey", "description"=>"The KMS key used for Amazon S3 server side encryption", "type"=>"string"}, {"in"=>"query", "name"=>"LocationARN", "description"=>"The ARN of the backend storage used for storing file data", "type"=>"string"}, {"in"=>"query", "name"=>"NFSFileShareDefaults", "description"=>"File share default values", "type"=>"string"}, {"in"=>"query", "name"=>"Role", "description"=>"The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["NFS File Share"]}}, "/?Action=CreateSnapshot"=>{"get"=>{"summary"=>"Create Snapshot", "description"=>"Initiates a snapshot of a volume.", "operationId"=>"createSnapshot", "x-api-path-slug"=>"actioncreatesnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"SnapshotDescription", "description"=>"Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeARN", "description"=>"The Amazon Resource Name (ARN) of the volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=CreateSnapshotFromVolumeRecoveryPoint"=>{"get"=>{"summary"=>"Create Snapshot From Volume Recovery Point", "description"=>"Initiates a snapshot of a gateway from a volume recovery point.", "operationId"=>"createSnapshotFromVolumeRecoveryPoint", "x-api-path-slug"=>"actioncreatesnapshotfromvolumerecoverypoint-get", "parameters"=>[{"in"=>"query", "name"=>"SnapshotDescription", "description"=>"Type: String", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeARN", "description"=>"Type: String", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=CreateStorediSCSIVolume"=>{"get"=>{"summary"=>"Create Stored SCSI Volume", "description"=>"Creates a volume on a specified gateway.", "operationId"=>"createStorediSCSIVolume", "x-api-path-slug"=>"actioncreatestorediscsivolume-get", "parameters"=>[{"in"=>"query", "name"=>"DiskId", "description"=>"The unique identifier for the gateway local disk that is configured as a stored volume", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}, {"in"=>"query", "name"=>"NetworkInterfaceId", "description"=>"The network interface of the gateway on which to expose the iSCSI target", "type"=>"string"}, {"in"=>"query", "name"=>"PreserveExistingData", "description"=>"Specify this field as true if you want to preserve the data on the local disk", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotId", "description"=>"The snapshot ID (e", "type"=>"string"}, {"in"=>"query", "name"=>"TargetName", "description"=>"The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stored SCSI Volume"]}}, "/?Action=CreateTapes"=>{"get"=>{"summary"=>"Create Tapes", "description"=>"Creates one or more virtual tapes.", "operationId"=>"createTapes", "x-api-path-slug"=>"actioncreatetapes-get", "parameters"=>[{"in"=>"query", "name"=>"ClientToken", "description"=>"A unique identifier that you use to retry a request", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayARN", "description"=>"The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with", "type"=>"string"}, {"in"=>"query", "name"=>"NumTapesToCreate", "description"=>"The number of virtual tapes that you want to create", "type"=>"string"}, {"in"=>"query", "name"=>"TapeBarcodePrefix", "description"=>"A prefix that you append to the barcode of the virtual tape you are creating", "type"=>"string"}, {"in"=>"query", "name"=>"TapeSizeInBytes", "description"=>"The size, in bytes, of the virtual tapes that you want to create", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tapes"]}}, "/?Action=CreateTapeWithBarcode"=>{"get"=>{"summary"=>"Create Tape With Barcode", "description"=>"Creates a virtual tape by using your own barcode.", "operationId"=>"createTapeWithBarcode", "x-api-path-slug"=>"actioncreatetapewithbarcode-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with", "type"=>"string"}, {"in"=>"query", "name"=>"TapeBarcode", "description"=>"The barcode that you want to assign to the tape", "type"=>"string"}, {"in"=>"query", "name"=>"TapeSizeInBytes", "description"=>"The size, in bytes, of the virtual tape that you want to create", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tape With Barcode"]}}, "/?Action=DeleteBandwidthRateLimit"=>{"get"=>{"summary"=>"Delete Bandwidth Rate Limit", "description"=>"Deletes the bandwidth rate limits of a gateway.", "operationId"=>"deleteBandwidthRateLimit", "x-api-path-slug"=>"actiondeletebandwidthratelimit-get", "parameters"=>[{"in"=>"query", "name"=>"BandwidthType", "description"=>"One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bandwidth Rate Limit"]}}, "/?Action=DeleteChapCredentials"=>{"get"=>{"summary"=>"Delete Chap Credentials", "description"=>"Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a\n specified iSCSI target and initiator pair.", "operationId"=>"deleteChapCredentials", "x-api-path-slug"=>"actiondeletechapcredentials-get", "parameters"=>[{"in"=>"query", "name"=>"InitiatorName", "description"=>"The iSCSI initiator that connects to the target", "type"=>"string"}, {"in"=>"query", "name"=>"TargetARN", "description"=>"The Amazon Resource Name (ARN) of the iSCSI volume target", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chap Credentials"]}}, "/?Action=DeleteFileShare"=>{"get"=>{"summary"=>"Delete File Share", "description"=>"Deletes a file share from a file gateway.", "operationId"=>"deleteFileShare", "x-api-path-slug"=>"actiondeletefileshare-get", "parameters"=>[{"in"=>"query", "name"=>"FileShareARN", "description"=>"The Amazon Resource Name (ARN) of the file share to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File Share"]}}, "/?Action=DeleteGateway"=>{"get"=>{"summary"=>"Delete Gateway", "description"=>"Deletes a gateway.", "operationId"=>"deleteGateway", "x-api-path-slug"=>"actiondeletegateway-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gateway"]}}, "/?Action=DeleteSnapshotSchedule"=>{"get"=>{"summary"=>"Delete Snapshot Schedule", "description"=>"Deletes a snapshot of a volume.", "operationId"=>"deleteSnapshotSchedule", "x-api-path-slug"=>"actiondeletesnapshotschedule-get", "parameters"=>[{"in"=>"query", "name"=>"VolumeARN", "description"=>"Type: String", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=DeleteTape"=>{"get"=>{"summary"=>"Delete Tape", "description"=>"Deletes the specified virtual tape.", "operationId"=>"deleteTape", "x-api-path-slug"=>"actiondeletetape-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with", "type"=>"string"}, {"in"=>"query", "name"=>"TapeARN", "description"=>"The Amazon Resource Name (ARN) of the virtual tape to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tapes"]}}, "/?Action=DeleteTapeArchive"=>{"get"=>{"summary"=>"Delete Tape Archive", "description"=>"Deletes the specified virtual tape from the virtual tape shelf (VTS).", "operationId"=>"deleteTapeArchive", "x-api-path-slug"=>"actiondeletetapearchive-get", "parameters"=>[{"in"=>"query", "name"=>"TapeARN", "description"=>"The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tapes", "Archives"]}}, "/?Action=DeleteVolume"=>{"get"=>{"summary"=>"Delete Volume", "description"=>"Deletes the specified gateway volume that you previously created using the.", "operationId"=>"deleteVolume", "x-api-path-slug"=>"actiondeletevolume-get", "parameters"=>[{"in"=>"query", "name"=>"VolumeARN", "description"=>"The Amazon Resource Name (ARN) of the volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volumes"]}}, "/?Action=DescribeBandwidthRateLimit"=>{"get"=>{"summary"=>"Describe Bandwidth Rate Limit", "description"=>"Returns the bandwidth rate limits of a gateway.", "operationId"=>"describeBandwidthRateLimit", "x-api-path-slug"=>"actiondescribebandwidthratelimit-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bandwidth Rate Limit"]}}, "/?Action=DescribeCache"=>{"get"=>{"summary"=>"Describe Cache", "description"=>"Returns information about the cache of a gateway.", "operationId"=>"describeCache", "x-api-path-slug"=>"actiondescribecache-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache"]}}, "/?Action=DescribeCachediSCSIVolumes"=>{"get"=>{"summary"=>"Describe Cached SCSI Volumes", "description"=>"Returns a description of the gateway volumes specified in the request.", "operationId"=>"describeCachediSCSIVolumes", "x-api-path-slug"=>"actiondescribecachediscsivolumes-get", "parameters"=>[{"in"=>"query", "name"=>"VolumeARNs", "description"=>"Type: array of Strings", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cached SCSI Volumes"]}}, "/?Action=DescribeChapCredentials"=>{"get"=>{"summary"=>"Describe Chap Credentials", "description"=>"Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials\n information for a specified iSCSI target, one for each target-initiator pair.", "operationId"=>"describeChapCredentials", "x-api-path-slug"=>"actiondescribechapcredentials-get", "parameters"=>[{"in"=>"query", "name"=>"TargetARN", "description"=>"The Amazon Resource Name (ARN) of the iSCSI volume target", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chap Credentials"]}}, "/?Action=DescribeGatewayInformation"=>{"get"=>{"summary"=>"Describe Gateway Information", "description"=>"Returns metadata about a gateway such as its name, network interfaces, configured\n time zone, and the state (whether the gateway is running or not).", "operationId"=>"describeGatewayInformation", "x-api-path-slug"=>"actiondescribegatewayinformation-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gateway"]}}, "/?Action=DescribeMaintenanceStartTime"=>{"get"=>{"summary"=>"Describe Maintenance Start Time", "description"=>"Returns your gateway's weekly maintenance start time including the day and time of\n the week.", "operationId"=>"describeMaintenanceStartTime", "x-api-path-slug"=>"actiondescribemaintenancestarttime-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance"]}}, "/?Action=DescribeNFSFileShares"=>{"get"=>{"summary"=>"Describe NFS File Shares", "description"=>"Gets a description for one or more file shares from a file gateway.", "operationId"=>"describeNFSFileShares", "x-api-path-slug"=>"actiondescribenfsfileshares-get", "parameters"=>[{"in"=>"query", "name"=>"FileShareARNList", "description"=>"An array containing the Amazon Resource Name (ARN) of each file share to be described", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["NFS File Shares"]}}, "/?Action=DescribeSnapshotSchedule"=>{"get"=>{"summary"=>"Describe Snapshot Schedule", "description"=>"Describes the snapshot schedule for the specified gateway volume.", "operationId"=>"describeSnapshotSchedule", "x-api-path-slug"=>"actiondescribesnapshotschedule-get", "parameters"=>[{"in"=>"query", "name"=>"VolumeARN", "description"=>"The Amazon Resource Name (ARN) of the volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=DescribeStorediSCSIVolumes"=>{"get"=>{"summary"=>"Describe Stored SCSI Volumes", "description"=>"Returns the description of the gateway volumes specified in the request.", "operationId"=>"describeStorediSCSIVolumes", "x-api-path-slug"=>"actiondescribestorediscsivolumes-get", "parameters"=>[{"in"=>"query", "name"=>"VolumeARNs", "description"=>"An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stored SCSI Volumes"]}}, "/?Action=DescribeTapeArchives"=>{"get"=>{"summary"=>"Describe Tape Archives", "description"=>"Returns a description of specified virtual tapes in the virtual tape shelf\n (VTS).", "operationId"=>"describeTapeArchives", "x-api-path-slug"=>"actiondescribetapearchives-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"Specifies that the number of virtual tapes descried be limited to the specified number", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An opaque string that indicates the position at which to begin describing virtual tapes", "type"=>"string"}, {"in"=>"query", "name"=>"TapeARNs", "description"=>"Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tape Archives"]}}, "/?Action=DescribeTapeRecoveryPoints"=>{"get"=>{"summary"=>"Describe Tape Recovery Points", "description"=>"Returns a list of virtual tape recovery points that are available for the specified\n gateway-VTL.", "operationId"=>"describeTapeRecoveryPoints", "x-api-path-slug"=>"actiondescribetaperecoverypoints-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"Specifies that the number of virtual tape recovery points that are described be limited to the specified number", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An opaque string that indicates the position at which to begin describing the virtual tape recovery points", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tape Recovery Points"]}}, "/?Action=DescribeTapes"=>{"get"=>{"summary"=>"Describe Tapes", "description"=>"Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes.", "operationId"=>"describeTapes", "x-api-path-slug"=>"actiondescribetapes-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"Specifies that the number of virtual tapes described be limited to the specified number", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"A marker value, obtained in a previous call to DescribeTapes", "type"=>"string"}, {"in"=>"query", "name"=>"TapeARNs", "description"=>"Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tapes"]}}, "/?Action=DescribeUploadBuffer"=>{"get"=>{"summary"=>"Describe Upload Buffer", "description"=>"Returns information about the upload buffer of a gateway.", "operationId"=>"describeUploadBuffer", "x-api-path-slug"=>"actiondescribeuploadbuffer-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload Buffer"]}}, "/?Action=DescribeVTLDevices"=>{"get"=>{"summary"=>"Describe VTL Devices", "description"=>"Returns a description of virtual tape library (VTL) devices for the specified\n gateway.", "operationId"=>"describeVTLDevices", "x-api-path-slug"=>"actiondescribevtldevices-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"Specifies that the number of VTL devices described be limited to the specified number", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An opaque string that indicates the position at which to begin describing the VTL devices", "type"=>"string"}, {"in"=>"query", "name"=>"VTLDeviceARNs", "description"=>"An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VTL Devices"]}}, "/?Action=DescribeWorkingStorage"=>{"get"=>{"summary"=>"Describe Working Storage", "description"=>"Returns information about the working storage of a gateway.", "operationId"=>"describeWorkingStorage", "x-api-path-slug"=>"actiondescribeworkingstorage-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Working Storage"]}}, "/?Action=DisableGateway"=>{"get"=>{"summary"=>"Disable Gateway", "description"=>"Disables a gateway when the gateway is no longer functioning.", "operationId"=>"disableGateway", "x-api-path-slug"=>"actiondisablegateway-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gateway"]}}, "/?Action=ListFileShares"=>{"get"=>{"summary"=>"List File Shares", "description"=>"Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account.", "operationId"=>"listFileShares", "x-api-path-slug"=>"actionlistfileshares-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon resource Name (ARN) of the gateway whose file shares you want to list", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of file shares to return in the response", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Opaque pagination token returned from a previous ListFileShares operation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File Shares"]}}, "/?Action=ListGateways"=>{"get"=>{"summary"=>"List Gateways", "description"=>"Lists gateways owned by an AWS account in a region specified in the request.", "operationId"=>"listGateways", "x-api-path-slug"=>"actionlistgateways-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"Specifies that the list of gateways returned be limited to the specified number of items", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An opaque string that indicates the position at which to begin the returned list of gateways", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gateways"]}}, "/?Action=ListLocalDisks"=>{"get"=>{"summary"=>"List Local Disks", "description"=>"Returns a list of the gateway's local disks.", "operationId"=>"listLocalDisks", "x-api-path-slug"=>"actionlistlocaldisks-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Local Disks"]}}, "/?Action=ListTagsForResource"=>{"get"=>{"summary"=>"List Tags For Resource", "description"=>"Lists the tags that have been added to the specified resource.", "operationId"=>"listTagsForResource", "x-api-path-slug"=>"actionlisttagsforresource-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"Specifies that the list of tags returned be limited to the specified number of items", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An opaque string that indicates the position at which to begin returning the list of tags", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceARN", "description"=>"The Amazon Resource Name (ARN) of the resource for which you want to list tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=ListTapes"=>{"get"=>{"summary"=>"List Tapes", "description"=>"Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf\n (VTS).", "operationId"=>"listTapes", "x-api-path-slug"=>"actionlisttapes-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"An optional number limit for the tapes in the list returned by this call", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"A string that indicates the position at which to begin the returned list of tapes", "type"=>"string"}, {"in"=>"query", "name"=>"TapeARNs", "description"=>"The Amazon Resource Name (ARN) of each of the tapes you want to list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tapes"]}}, "/?Action=ListVolumeInitiators"=>{"get"=>{"summary"=>"List Volume Initiators", "description"=>"Lists iSCSI initiators that are connected to a volume.", "operationId"=>"listVolumeInitiators", "x-api-path-slug"=>"actionlistvolumeinitiators-get", "parameters"=>[{"in"=>"query", "name"=>"VolumeARN", "description"=>"The Amazon Resource Name (ARN) of the volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume Initiators"]}}, "/?Action=ListVolumeRecoveryPoints"=>{"get"=>{"summary"=>"List Volume Recovery Points", "description"=>"Lists the recovery points for a specified gateway.", "operationId"=>"listVolumeRecoveryPoints", "x-api-path-slug"=>"actionlistvolumerecoverypoints-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume Recovery"]}}, "/?Action=ListVolumes"=>{"get"=>{"summary"=>"List Volumes", "description"=>"Lists the iSCSI stored volumes of a gateway.", "operationId"=>"listVolumes", "x-api-path-slug"=>"actionlistvolumes-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"Specifies that the list of volumes returned be limited to the specified number of items", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"A string that indicates the position at which to begin the returned list of volumes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volumes"]}}, "/?Action=RemoveTagsFromResource"=>{"get"=>{"summary"=>"Remove Tags From Resource", "description"=>"Removes one or more tags from the specified resource.", "operationId"=>"removeTagsFromResource", "x-api-path-slug"=>"actionremovetagsfromresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceARN", "description"=>"The Amazon Resource Name (ARN) of the resource you want to remove the tags from", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys", "description"=>"The keys of the tags you want to remove from the specified resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=ResetCache"=>{"get"=>{"summary"=>"Reset Cache", "description"=>"Resets all cache disks that have encountered a error and makes the disks available\n for reconfiguration as cache storage.", "operationId"=>"resetCache", "x-api-path-slug"=>"actionresetcache-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache"]}}, "/?Action=RetrieveTapeArchive"=>{"get"=>{"summary"=>"Retrieve Tape Archive", "description"=>"Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a\n gateway-VTL.", "operationId"=>"retrieveTapeArchive", "x-api-path-slug"=>"actionretrievetapearchive-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to", "type"=>"string"}, {"in"=>"query", "name"=>"TapeARN", "description"=>"The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tapes", "Archives"]}}, "/?Action=RetrieveTapeRecoveryPoint"=>{"get"=>{"summary"=>"Retrieve Tape Recovery Point", "description"=>"Retrieves the recovery point for the specified virtual tape.", "operationId"=>"retrieveTapeRecoveryPoint", "x-api-path-slug"=>"actionretrievetaperecoverypoint-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}, {"in"=>"query", "name"=>"TapeARN", "description"=>"The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tape Recovery"]}}, "/?Action=SetLocalConsolePassword"=>{"get"=>{"summary"=>"Set Local Console Password", "description"=>"Sets the password for your VM local console.", "operationId"=>"setLocalConsolePassword", "x-api-path-slug"=>"actionsetlocalconsolepassword-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}, {"in"=>"query", "name"=>"LocalConsolePassword", "description"=>"The password you want to set for your VM local console", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Local Console Password"]}}, "/?Action=ShutdownGateway"=>{"get"=>{"summary"=>"Shutdown Gateway", "description"=>"Shuts down a gateway.", "operationId"=>"shutdownGateway", "x-api-path-slug"=>"actionshutdowngateway-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gateway"]}}, "/?Action=StartGateway"=>{"get"=>{"summary"=>"Start Gateway", "description"=>"Starts a gateway that you previously shut down (see.", "operationId"=>"startGateway", "x-api-path-slug"=>"actionstartgateway-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gateway"]}}, "/?Action=UpdateBandwidthRateLimit"=>{"get"=>{"summary"=>"Update Bandwidth Rate Limit", "description"=>"Updates the bandwidth rate limits of a gateway.", "operationId"=>"updateBandwidthRateLimit", "x-api-path-slug"=>"actionupdatebandwidthratelimit-get", "parameters"=>[{"in"=>"query", "name"=>"AverageDownloadRateLimitInBitsPerSec", "description"=>"The average download bandwidth rate limit in bits per second", "type"=>"string"}, {"in"=>"query", "name"=>"AverageUploadRateLimitInBitsPerSec", "description"=>"The average upload bandwidth rate limit in bits per second", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bandwidth Rate Limit"]}}, "/?Action=UpdateChapCredentials"=>{"get"=>{"summary"=>"Update Chap Credentials", "description"=>"Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a\n specified iSCSI target.", "operationId"=>"updateChapCredentials", "x-api-path-slug"=>"actionupdatechapcredentials-get", "parameters"=>[{"in"=>"query", "name"=>"InitiatorName", "description"=>"The iSCSI initiator that connects to the target", "type"=>"string"}, {"in"=>"query", "name"=>"SecretToAuthenticateInitiator", "description"=>"The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target", "type"=>"string"}, {"in"=>"query", "name"=>"SecretToAuthenticateTarget", "description"=>"The secret key that the target must provide to participate in mutual CHAP with the initiator (e", "type"=>"string"}, {"in"=>"query", "name"=>"TargetARN", "description"=>"The Amazon Resource Name (ARN) of the iSCSI volume target", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chap Credentials"]}}, "/?Action=UpdateGatewayInformation"=>{"get"=>{"summary"=>"Update Gateway Information", "description"=>"Updates a gateway's metadata, which includes the gateway's name and time zone.", "operationId"=>"updateGatewayInformation", "x-api-path-slug"=>"actionupdategatewayinformation-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayName", "description"=>"The name you configured for your gateway", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayTimezone", "description"=>"Type: String", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gateway"]}}, "/?Action=UpdateGatewaySoftwareNow"=>{"get"=>{"summary"=>"Update Gateway Software Now", "description"=>"Updates the gateway virtual machine (VM) software.", "operationId"=>"updateGatewaySoftwareNow", "x-api-path-slug"=>"actionupdategatewaysoftwarenow-get", "parameters"=>[{"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gateway"]}}, "/?Action=UpdateMaintenanceStartTime"=>{"get"=>{"summary"=>"Update Maintenance Start Time", "description"=>"Updates a gateway's weekly maintenance start time information, including day and time\n of the week.", "operationId"=>"updateMaintenanceStartTime", "x-api-path-slug"=>"actionupdatemaintenancestarttime-get", "parameters"=>[{"in"=>"query", "name"=>"DayOfWeek", "description"=>"The maintenance start time day of the week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday", "type"=>"string"}, {"in"=>"query", "name"=>"GatewayARN", "description"=>"The Amazon Resource Name (ARN) of the gateway", "type"=>"string"}, {"in"=>"query", "name"=>"HourOfDay", "description"=>"The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23)", "type"=>"string"}, {"in"=>"query", "name"=>"MinuteOfHour", "description"=>"The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance"]}}, "/?Action=UpdateNFSFileShare"=>{"get"=>{"summary"=>"Update NFS File Share", "description"=>"Updates a file share.", "operationId"=>"updateNFSFileShare", "x-api-path-slug"=>"actionupdatenfsfileshare-get", "parameters"=>[{"in"=>"query", "name"=>"DefaultStorageClass", "description"=>"The default storage class for objects put into an Amazon S3 bucket by a file gateway", "type"=>"string"}, {"in"=>"query", "name"=>"FileShareARN", "description"=>"The Amazon Resource Name (ARN) of the file share to be updated", "type"=>"string"}, {"in"=>"query", "name"=>"KMSEncrypted", "description"=>"True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3", "type"=>"string"}, {"in"=>"query", "name"=>"KMSKey", "description"=>"The KMS key used for Amazon S3 server side encryption", "type"=>"string"}, {"in"=>"query", "name"=>"NFSFileShareDefaults", "description"=>"The default values for the file share", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["NFS File Share"]}}, "/?Action=UpdateSnapshotSchedule"=>{"get"=>{"summary"=>"Update Snapshot Schedule", "description"=>"Updates a snapshot schedule configured for a gateway volume.", "operationId"=>"updateSnapshotSchedule", "x-api-path-slug"=>"actionupdatesnapshotschedule-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"Optional description of the snapshot that overwrites the existing description", "type"=>"string"}, {"in"=>"query", "name"=>"RecurrenceInHours", "description"=>"Frequency of snapshots", "type"=>"string"}, {"in"=>"query", "name"=>"StartAt", "description"=>"The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23)", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeARN", "description"=>"The Amazon Resource Name (ARN) of the volume", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=UpdateVTLDeviceType"=>{"get"=>{"summary"=>"Update VTL Device Type", "description"=>"Updates the type of medium changer in a gateway-VTL.", "operationId"=>"updateVTLDeviceType", "x-api-path-slug"=>"actionupdatevtldevicetype-get", "parameters"=>[{"in"=>"query", "name"=>"DeviceType", "description"=>"The type of medium changer you want to select", "type"=>"string"}, {"in"=>"query", "name"=>"VTLDeviceARN", "description"=>"The Amazon Resource Name (ARN) of the medium changer you want to select", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VTL Device Type"]}}}}, "apis"=>{"name"=>"AWS Storage Gateway Service", "x-slug"=>"aws-storage-gateway-service", "description"=>"The AWS Storage Gateway service seamlessly enables hybrid storage between on-premises storage environments andthe AWS Cloud. It combines a multi-protocol storage appliance with highly efficient network connectivity toAmazon cloud storageservices, delivering local performance with virtually unlimited scale. Customers use it in remote offices and datacenters for hybrid cloud workloads, backup and restore, archive, disaster recovery, and tiered storage.The Storage Gateway virtual appliance connects seamlessly to your local infrastructure as a file server, as a volume, or as a virtual tape library (VTL). This seamless connection makes it simple for organizations to augment existing on-premises storage investments with the high scalability, extreme durability and low cost of cloud storage.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Storage-Content-Delivery_AWSStorageGateway.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Data,Databases,Deployments,Gateway,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-storage-gateway-service/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Storage Gateway Service API", "x-api-slug"=>"aws-storage-gateway-service-api", "description"=>"The AWS Storage Gateway service seamlessly enables hybrid storage between on-premises storage environments andthe AWS Cloud. It combines a multi-protocol storage appliance with highly efficient network connectivity toAmazon cloud storageservices, delivering local performance with virtually unlimited scale. Customers use it in remote offices and datacenters for hybrid cloud workloads, backup and restore, archive, disaster recovery, and tiered storage.The Storage Gateway virtual appliance connects seamlessly to your local infrastructure as a file server, as a volume, or as a virtual tape library (VTL). This seamless connection makes it simple for organizations to augment existing on-premises storage investments with the high scalability, extreme durability and low cost of cloud storage.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Storage-Content-Delivery_AWSStorageGateway.png", "humanURL"=>"https://aws.amazon.com/storagegateway/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Data,Databases,Deployments,Gateway,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-storage-gateway-service/actionupdatevtldevicetype-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-storage-gateway-service/aws-storage-gateway-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/storagegateway/latest/APIReference"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/storagegateway/faqs/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/storagegateway/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/storagegateway/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aylien{"aylien-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Aylien", "x-complete"=>1, "info"=>{"title"=>"AYLIEN News API", "description"=>"the-aylien-news-api-is-the-most-powerful-way-of-sourcing-searching-and-syndicating-analyzed-and-enriched-news-content--it-is-accessed-by-sending-http-requests-to-our-server-which-returns-information-to-your-client-", "termsOfService"=>"https://newsapi.aylien.com/tos", "contact"=>{"name"=>"API support", "url"=>"https://newsapi.aylien.com/", "email"=>"support@aylien.com"}, "version"=>"1.0.0"}, "host"=>"api.newsapi.aylien.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/stories"=>{"get"=>{"summary"=>"List Stories", "description"=>"The stories endpoint is used to return stories based on parameters you set in your query. The News API crawler gathers articles in near real-time and stores information about them, or metadata. Below you can see all of the query parameters, which you can use to narrow down your query.", "operationId"=>"listStories", "x-api-path-slug"=>"stories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "List", "Stories"]}}, "/related_stories"=>{"get"=>{"summary"=>"List related stories", "description"=>"This endpoint is used for finding semantically similar stories based on the parameters you provide as inputs. For example, if you want to find stories similar to a Tweet or any text extract you input, the related stories endpoint will analyze the entities present and the meaning of the text, and find stories with a similar meaning. The maximum number of related stories returned is 100.", "operationId"=>"listRelatedStories", "x-api-path-slug"=>"related-stories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "List", "Related", "Stories"]}, "post"=>{"summary"=>"List related stories", "description"=>"This endpoint is used for finding semantically similar stories based on the parameters you provide as inputs. For example, if you want to find stories similar to a Tweet or any text extract you input, the related stories endpoint will analyze the entities present and the meaning of the text, and find stories with a similar meaning. The maximum number of related stories returned is 100.", "operationId"=>"listRelatedStoriesAsPost", "x-api-path-slug"=>"related-stories-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "List", "Related", "Stories"]}}, "/coverages"=>{"get"=>{"summary"=>"List coverages", "description"=>"The coverages endpoint allows you to understand the reach a document has had. For example, you can track the coverage of a press release or a Tweet based on how many times it has been mentioned in stories.", "operationId"=>"listCoverages", "x-api-path-slug"=>"coverages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "List", "Coverages"]}, "post"=>{"summary"=>"List coverages", "description"=>"The coverages endpoint allows you to understand the reach a document has had. For example, you can track the coverage of a press release or a Tweet based on how many times it has been mentioned in stories.", "operationId"=>"listCoveragesAsPost", "x-api-path-slug"=>"coverages-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "List", "Coverages"]}}, "/autocompletes"=>{"get"=>{"summary"=>"List autocompletes", "description"=>"The autocompletes endpoint a string of characters provided to it, and then returns suggested terms that are the most likely full words or strings. The terms returned by the News API are based on parameters the type parameters you can see below. For example, if you provide the autocompletes endpoint with the term `New York C` and select the type `dbpedia_resources`, the API will return links to the DBpedia resources `New_York_City`, `New_York_City_Subway`, `New_York_City_Police_Department`, and so on.", "operationId"=>"listAutocompletes", "x-api-path-slug"=>"autocompletes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "List", "Autocompletes"]}}, "/time_series"=>{"get"=>{"summary"=>"List time series", "description"=>"The time series endpoint allows you to track information contained in stories over time. This information can be anything from mentions of a topic or entities, sentiment about a topic, or the volume of stories published by a source, to name but a few. The full list of parameters is given below. Using the [Date Math Syntax](https://newsapi.aylien.com/docs/working-with-dates), you can easily set your query to return information from any time period, from the current point in time to when the News API started collecting stories. The returned information can be rounded to a time also specified by you, for example by setting the results into hourly, daily, or weekly data points.", "operationId"=>"listTimeSeries", "x-api-path-slug"=>"time-series-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "List", "Time", "Series"]}}, "/trends"=>{"get"=>{"summary"=>"List trends", "description"=>"The trends endpoint allows you to identify the most-mentioned entities, concepts and keywords relevant to your query. For example, this endpoint allows you to set parameters like a time period, a subject category, or an entity, and your request will return the most mentioned entities or keywords that are mentioned in relation to your query.", "operationId"=>"listTrends", "x-api-path-slug"=>"trends-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "List", "Trends"]}}, "/histograms"=>{"get"=>{"summary"=>"List histograms", "description"=>"For the numerical metadata that the News API gathers (such as word counts or social shares for example), you can use the histograms endpoint to access and display this information. As this endpoint does not return actual stories, the results you are given will not count towards your story allowance provided by your subscription, so you can effectively query this endpoint free of charge.", "operationId"=>"listHistograms", "x-api-path-slug"=>"histograms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "List", "Histograms"]}}}}, "apis"=>{"name"=>"Aylien", "x-slug"=>"aylien", "description"=>"Text Analysis API | Natural Language Processing", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20034-aylien.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"156410", "tags"=>"API Provider,Content,Enterprise,Machine Learning,Machine Learning Scraping,Profiles,SaaS,Scraping,Service Level Agreement,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aylien/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Aylien", "x-api-slug"=>"aylien", "description"=>"Text Analysis API | Natural Language Processing", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20034-aylien.jpg", "humanURL"=>"http://aylien.com/", "baseURL"=>"https://api.newsapi.aylien.com//api/v1", "tags"=>"API Provider,Content,Enterprise,Machine Learning,Machine Learning Scraping,Profiles,SaaS,Scraping,Service Level Agreement,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aylien/histograms-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aylien/aylien-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://blog.aylien.com"}, {"type"=>"x-facebook", "url"=>"https://www.facebook.com/aylieninc"}, {"type"=>"x-openapi", "url"=>"https://newsapi.aylien.com/swagger/spec/news-api.json"}, {"type"=>"x-press", "url"=>"http://aylien.com/press"}, {"type"=>"x-blog", "url"=>"http://blog.aylien.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.aylien.com/rss"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/aylien"}, {"type"=>"x-developer", "url"=>"https://newsapi.aylien.com/"}, {"type"=>"x-email", "url"=>"hello@aylien.com"}, {"type"=>"x-github", "url"=>"https://github.com/AYLIEN"}, {"type"=>"x-pricing", "url"=>"https://newsapi.aylien.com/pricing"}, {"type"=>"x-service-level-agreement", "url"=>"http://aylien.com/text-api-sla"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/_aylien"}, {"type"=>"x-website", "url"=>"http://aylien.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bank-of-scotland{"bank-of-scotland-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bank of Scotland", "x-complete"=>1, "info"=>{"title"=>"Bank of Scotland", "description"=>"this-is-an-openapi-definition-for-the-standard-set-of-open-banking-httpopenbankingapis-io-apis-for-the-bank-of-scotland-", "termsOfService"=>"https://www.openbanking.org.uk/open-licence/", "contact"=>{"name"=>"API Evangelist", "url"=>"https://apievangelist.com", "email"=>"info@apievangelist.com"}, "version"=>"1.0.0"}, "host"=>"api.bankofscotland.co.uk", "basePath"=>"open-banking/v2.1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"atms/"=>{"get"=>{"summary"=>"Get ATMs", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can provide multiple ATMs.", "operationId"=>"getATMS", "x-api-path-slug"=>"atms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Atms"]}}, "branches/"=>{"get"=>{"summary"=>"Get Branches", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple branches.", "operationId"=>"getBranches", "x-api-path-slug"=>"branches-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branches"]}}, "personal-current-accounts/"=>{"get"=>{"summary"=>"Get Current Personal Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple PCA products.", "operationId"=>"getCurrentPersonalAccounts", "x-api-path-slug"=>"personalcurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Personal", "Current", "Accounts"]}}, "business-current-accounts/"=>{"get"=>{"summary"=>"Get Current Business Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple BCA products.", "operationId"=>"getCurentBusinessAccounts", "x-api-path-slug"=>"businesscurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Business", "Current", "Accounts"]}}, "unsecured-sme-loans/"=>{"get"=>{"summary"=>"Get Unsecured SME Loans", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Unsecured Loan products.", "operationId"=>"pathOperation", "x-api-path-slug"=>"unsecuredsmeloans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsecured", "Sme", "Loans"]}}, "commercial-credit-cards/"=>{"get"=>{"summary"=>"Get Commercial Credit Cards", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Commercial Credit Card products.", "operationId"=>"getCommercialCreditCards", "x-api-path-slug"=>"commercialcreditcards-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commercial", "Credit", "Cards"]}}}}, "apis"=>{"name"=>"Bank of Scotland", "x-slug"=>"bank-of-scotland", "description"=>"The Bank of Scotland is a commercial and clearing bank based in Edinburgh, Scotland. With a history dating to the 17th century, it is the fifth-oldest surviving bank in the United Kingdom (the Bank of England having been established one year before), and is the only commercial institution created by the Parliament of Scotland to remain in existence. It was one of the first banks in Europe to print its own banknotes and it continues to print its own sterling banknotes under legal arrangements which allow Scottish banks to issue currency.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/bank-of-scotland-logo.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Provider,ATMs,Banking,General Data,Profiles,Relative Data,UK Banks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bank-of-scotland/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Bank of Scotland", "x-api-slug"=>"bank-of-scotland", "description"=>"The Bank of Scotland is a commercial and clearing bank based in Edinburgh, Scotland. With a history dating to the 17th century, it is the fifth-oldest surviving bank in the United Kingdom (the Bank of England having been established one year before), and is the only commercial institution created by the Parliament of Scotland to remain in existence. It was one of the first banks in Europe to print its own banknotes and it continues to print its own sterling banknotes under legal arrangements which allow Scottish banks to issue currency.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/bank-of-scotland-logo.jpg", "humanURL"=>"https://www.bankofscotland.co.uk/", "baseURL"=>"https://api.bankofscotland.co.uk/open-banking/v2.1/", "tags"=>"API Provider,ATMs,Banking,General Data,Profiles,Relative Data,UK Banks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bank-of-scotland/commercialcreditcards-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bank-of-scotland/bank-of-scotland-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-twitter", "url"=>"https://twitter.com/AskBankOfScot"}, {"type"=>"x-website", "url"=>"https://www.bankofscotland.co.uk/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
cisco{"cisco-psirt-open-vuln-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Cisco", "x-complete"=>1, "info"=>{"title"=>"Cisco PSIRT open Vuln", "description"=>"the-cisco-product-security-incident-response-team-psirt-openvuln-api-is-a-restful-api-that-allows-customers-to-obtain-cisco-security-vulnerability-information-in-different-machineconsumable-formats--apis-are-important-for-customers-because-they-allow-their-technical-staff-and-programmers-to-build-tools-that-help-them-do-their-job-more-effectively-in-this-case-to-keep-up-with-security-vulnerability-information-for-more-information-about-the-cisco-psirt-openvuln-api-visit-httpsdeveloper-cisco-comsitepsirtdiscoveroverviewfor-detail-steps-on-how-to-use-the-api-go-tohttpsdeveloper-cisco-comsitepsirtgetstartedgettingstarted-gspthis-is-a-beta-release-of-a-swagger-yaml-for-the-cisco-psirt-openvuln-apito-access-the-api-sign-in-with-your-cisco-cco-account-at-httpapiconsole-cisco-com-and-register-an-applicationto-recieve-a-client-id-and-a-client-secretyou-can-then-get-your-token-using-curl-or-any-other-method-you-prefer-curl-s-k-h-contenttype-applicationxwwwformurlencoded-x-post-d-client-idyour-client-id-d-client-secretyour-client-secret-d-grant-typeclient-credentials-httpscloudsso-cisco-comastoken-oauth2you-will-receive-an-access-token-as-demonstrated-in-the-following-example-access-tokeni7omwtbdaiesiux3shoxnjfuy4j6token-typebearerexpires-in3599in-swagger-click-on-change-authenticationenter-the-text-i7omwtbdaiesiux3shoxnjfuy4j6-which-is-the-token-you-receivedthen-click-on-try-this-operation", "contact"=>{"name"=>"Omar Santos", "email"=>"os@cisco.com"}, "version"=>"0.0.3"}, "host"=>"api.cisco.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/security/advisories/cvrf/advisory/{advisory_id}"=>{"get"=>{"summary"=>"Get Security Advisories Advisory Advisory", "description"=>"Used to obtain an advisory in CVRF format for a given advisory ID `advisory_id` (i.e., cisco-sa-20150819-pcp)", "operationId"=>"used-to-obtain-an-advisory-in-cvrf-format-for-a-given-advisory-id-advisory-id-i-e--ciscosa20150819pc", "x-api-path-slug"=>"securityadvisoriescvrfadvisoryadvisory-id-get", "parameters"=>[{"in"=>"path", "name"=>"advisory_id", "description"=>"advisory ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Advisory", "Advisory"]}}, "/security/advisories/cvrf/all"=>{"get"=>{"summary"=>"Get Security Advisories All", "description"=>"Used to obtain all advisories in Common Vulnerability Reporting Format (CVRF). For more information about CVRF go to https://communities.cisco.com/docs/DOC-63156 . By default the output is in JSON. To obtain the output in XML use the .xml extension. For example, /advisories/cvrf/all.xml", "operationId"=>"used-to-obtain-all-advisories-in-common-vulnerability-reporting-format-cvrf--for-more-information-ab", "x-api-path-slug"=>"securityadvisoriescvrfall-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories"]}}, "/security/advisories/cvrf/cve/{cve_id}"=>{"get"=>{"summary"=>"Get Security Advisories", "description"=>"Used to obtain an advisory in CVRF format for a given Common Vulnerability Enumerator (CVE). The `cve_id` format is CVE-YYYY-NNNN. For more information about CVE visit http://cve.mitre.org/", "operationId"=>"used-to-obtain-an-advisory-in-cvrf-format-for-a-given-common-vulnerability-enumerator-cve--the-cve-i", "x-api-path-slug"=>"securityadvisoriescvrfcvecve-id-get", "parameters"=>[{"in"=>"path", "name"=>"cve_id", "description"=>"CVE Identifier (i"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories"]}}, "/security/advisories/cvrf/latest/{number}"=>{"get"=>{"summary"=>"Get Security Advisories Latest Number", "description"=>"Used to obtain all the latest security advisories in CVRF format given an absolute number. For instance, the latest 10 or latest 5.", "operationId"=>"used-to-obtain-all-the-latest-security-advisories-in-cvrf-format-given-an-absolute-number--for-insta", "x-api-path-slug"=>"securityadvisoriescvrflatestnumber-get", "parameters"=>[{"in"=>"path", "name"=>"number", "description"=>"An absolute number to obtain the latest security advisories"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Latest", "Number"]}}, "/security/advisories/cvrf/product"=>{"get"=>{"summary"=>"Get Security Advisories Product", "description"=>"Used to obtain all the advisories that affects the given product name.", "operationId"=>"used-to-obtain-all-the-advisories-that-affects-the-given-product-name-", "x-api-path-slug"=>"securityadvisoriescvrfproduct-get", "parameters"=>[{"in"=>"query", "name"=>"product", "description"=>"An product name to obtain security advisories that matches given product name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Product"]}}, "/security/advisories/cvrf/severity/{severity}"=>{"get"=>{"summary"=>"Get Security Advisories Severity Severity", "description"=>"Used to obtain all security advisories for a given security impact rating (critical, high, medium, or low) in CVRF format.", "operationId"=>"used-to-obtain-all-security-advisories-for-a-given-security-impact-rating-critical-high-medium-or-lo", "x-api-path-slug"=>"securityadvisoriescvrfseverityseverity-get", "parameters"=>[{"in"=>"path", "name"=>"severity", "description"=>"Critical, High, Medium, Low"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Severity", "Severity"]}}, "/security/advisories/cvrf/severity/{severity}/firstpublished"=>{"get"=>{"summary"=>"Get Security Advisories Severity Severity Firstpublished", "description"=>"Used to obtain all security advisories for a given security impact rating (critical, high, medium, or low) in CVRF format and additionally filter based of firstpublished start date and enddate", "operationId"=>"used-to-obtain-all-security-advisories-for-a-given-security-impact-rating-critical-high-medium-or-lo", "x-api-path-slug"=>"securityadvisoriescvrfseverityseverityfirstpublished-get", "parameters"=>[{"in"=>"query", "name"=>"endDate"}, {"in"=>"path", "name"=>"severity", "description"=>"Used to obtain all advisories that have a security impact rating of critical"}, {"in"=>"query", "name"=>"startDate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Severity", "Severity", "Firstpublished"]}}, "/security/advisories/cvrf/severity/{severity}/lastpublished"=>{"get"=>{"summary"=>"Get Security Advisories Severity Severity Lastpublished", "description"=>"Used to obtain all security advisories for a given security impact rating (critical, high, medium, or low) in CVRF format.", "operationId"=>"used-to-obtain-all-security-advisories-for-a-given-security-impact-rating-critical-high-medium-or-lo", "x-api-path-slug"=>"securityadvisoriescvrfseverityseveritylastpublished-get", "parameters"=>[{"in"=>"query", "name"=>"endDate"}, {"in"=>"path", "name"=>"severity", "description"=>"Used to obtain all advisories that have a security impact rating of critical"}, {"in"=>"query", "name"=>"startDate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Severity", "Severity", "Lastpublished"]}}, "/security/advisories/cvrf/year/{year}"=>{"get"=>{"summary"=>"Get Security Advisories Year Year", "description"=>"Used to obtain all security advisories that have were orginally published in a specific year `YYYY`.", "operationId"=>"used-to-obtain-all-security-advisories-that-have-were-orginally-published-in-a-specific-year-yyyy-", "x-api-path-slug"=>"securityadvisoriescvrfyearyear-get", "parameters"=>[{"in"=>"path", "name"=>"year", "description"=>"The four digit year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Year", "Year"]}}, "/security/advisories/ios"=>{"get"=>{"summary"=>"Get Security Advisories Ios", "description"=>"Used to obtain all advisories that affects the given ios version", "operationId"=>"used-to-obtain-all-advisories-that-affects-the-given-ios-version", "x-api-path-slug"=>"securityadvisoriesios-get", "parameters"=>[{"in"=>"query", "name"=>"version", "description"=>"IOS version to obtain security advisories"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Ios"]}}, "/security/advisories/iosxe"=>{"get"=>{"summary"=>"Get Security Advisories Iosxe", "description"=>"Used to obtain all advisories that affects the given ios version", "operationId"=>"used-to-obtain-all-advisories-that-affects-the-given-ios-version", "x-api-path-slug"=>"securityadvisoriesiosxe-get", "parameters"=>[{"in"=>"query", "name"=>"version", "description"=>"IOS version to obtain security advisories"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Iosxe"]}}, "/security/advisories/oval/advisory/{advisory_id}"=>{"get"=>{"summary"=>"Get Security Advisories Oval Advisory Advisory", "description"=>"Used to obtain OVAL definitions for a given advisory ID `advisory_id` (i.e., cisco-sa-20150819-pcp)", "operationId"=>"used-to-obtain-oval-definitions-for-a-given-advisory-id-advisory-id-i-e--ciscosa20150819pcp", "x-api-path-slug"=>"securityadvisoriesovaladvisoryadvisory-id-get", "parameters"=>[{"in"=>"path", "name"=>"advisory_id", "description"=>"advisory ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Oval", "Advisory", "Advisory"]}}, "/security/advisories/oval/all"=>{"get"=>{"summary"=>"Get Security Advisories Oval All", "description"=>"Used to obtain all Open Vulnerability and Assessment Language (OVAL) definitions available for Cisco security vulnerabilities. For more information about OVAL go to https://communities.cisco.com/docs/DOC-63158 . By default the output is in JSON. To obtain the output in XML use the .xml extension. For example, /advisories/oval/all.xml", "operationId"=>"used-to-obtain-all-open-vulnerability-and-assessment-language-oval-definitions-available-for-cisco-s", "x-api-path-slug"=>"securityadvisoriesovalall-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Oval"]}}, "/security/advisories/oval/cve/{cve_id}"=>{"get"=>{"summary"=>"Get Security Advisories Oval", "description"=>"Used to obtain OVAL definitions for a given CVE Identifier. The `cve_id` format is CVE-YYYY-NNNN.", "operationId"=>"used-to-obtain-oval-definitions-for-a-given-cve-identifier--the-cve-id-format-is-cveyyyynnnn-", "x-api-path-slug"=>"securityadvisoriesovalcvecve-id-get", "parameters"=>[{"in"=>"path", "name"=>"cve_id", "description"=>"CVE Identifier (i"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Oval"]}}, "/security/advisories/oval/latest/{number}"=>{"get"=>{"summary"=>"Get Security Advisories Oval Latest Number", "description"=>"Used to obtain all the latest OVAL definitions given an absolute number. For instance, the latest 10 or latest 5.", "operationId"=>"used-to-obtain-all-the-latest-oval-definitions-given-an-absolute-number--for-instance-the-latest-10-", "x-api-path-slug"=>"securityadvisoriesovallatestnumber-get", "parameters"=>[{"in"=>"path", "name"=>"number", "description"=>"The latest OVAL definitions (absolute number)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Oval", "Latest", "Number"]}}, "/security/advisories/oval/product"=>{"get"=>{"summary"=>"Get Security Advisories Oval Product", "description"=>"Used to obtain all the oval advisories that affects the given product name.", "operationId"=>"used-to-obtain-all-the-oval-advisories-that-affects-the-given-product-name-", "x-api-path-slug"=>"securityadvisoriesovalproduct-get", "parameters"=>[{"in"=>"query", "name"=>"product", "description"=>"An product name to obtain security advisories that matches given product name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Oval", "Product"]}}, "/security/advisories/oval/severity/{severity}"=>{"get"=>{"summary"=>"Get Security Advisories Oval Severity Severity", "description"=>"Used to obtain all OVAL definitions for a given security impact rating (critical, high, medium, or low).", "operationId"=>"used-to-obtain-all-oval-definitions-for-a-given-security-impact-rating-critical-high-medium-or-low-", "x-api-path-slug"=>"securityadvisoriesovalseverityseverity-get", "parameters"=>[{"in"=>"path", "name"=>"severity", "description"=>"Used to obtain all OVAL definitions for advisories that have a security impact rating of critical"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Oval", "Severity", "Severity"]}}, "/security/advisories/oval/severity/{severity}/firstpublished"=>{"get"=>{"summary"=>"Get Security Advisories Oval Severity Severity Firstpublished", "description"=>"Used to obtain all security advisories for a given security impact rating (critical, high, medium, or low) in OVAL format.", "operationId"=>"used-to-obtain-all-security-advisories-for-a-given-security-impact-rating-critical-high-medium-or-lo", "x-api-path-slug"=>"securityadvisoriesovalseverityseverityfirstpublished-get", "parameters"=>[{"in"=>"query", "name"=>"endDate"}, {"in"=>"path", "name"=>"severity", "description"=>"Critical, High, Medium, Low"}, {"in"=>"query", "name"=>"startDate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Oval", "Severity", "Severity", "Firstpublished"]}}, "/security/advisories/oval/severity/{severity}/lastpublished"=>{"get"=>{"summary"=>"Get Security Advisories Oval Severity Severity Lastpublished", "description"=>"Used to obtain all security advisories for a given security impact rating (critical, high, medium, or low) in OVAL format.", "operationId"=>"used-to-obtain-all-security-advisories-for-a-given-security-impact-rating-critical-high-medium-or-lo", "x-api-path-slug"=>"securityadvisoriesovalseverityseveritylastpublished-get", "parameters"=>[{"in"=>"query", "name"=>"endDate"}, {"in"=>"path", "name"=>"severity", "description"=>"Critical, High, Medium, Low"}, {"in"=>"query", "name"=>"startDate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security", "Advisories", "Oval", "Severity", "Severity", "Lastpublished"]}}}}, "apis"=>{"name"=>"Cisco", "x-slug"=>"cisco", "description"=>"954088 Cisco Systems, Inc. is an American multinational technology conglomerate headquartered in San Jose, California, in the center of Silicon Valley, that develops, manufactures and sells networking hardware, telecommunications equipment and other hi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1515-cisco-unity-connection-messaging-interface.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"788", "tags"=>"Collaboration,Enterprise,ISP,Messages,Networking,Relative Data,SaaS,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"cisco/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Cisco PSIRT open Vuln", "x-api-slug"=>"cisco-psirt-open-vuln", "description"=>"954088 Cisco Systems, Inc. is an American multinational technology conglomerate headquartered in San Jose, California, in the center of Silicon Valley, that develops, manufactures and sells networking hardware, telecommunications equipment and other hi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1515-cisco-unity-connection-messaging-interface.jpg", "humanURL"=>"http://docwiki.cisco.com/wiki/Cisco_Unity_Connection_Messaging_Interface_%28CUMI%29_API", "baseURL"=>"https://api.cisco.com//", "tags"=>"Collaboration,Enterprise,ISP,Messages,Networking,Relative Data,SaaS,Service API", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/cisco/securityadvisoriesovalseverityseveritylastpublished-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/cisco/cisco-psirt-open-vuln-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://docwiki.cisco.com/wiki/Cisco_Unity_Connection_Messaging_Interface_%28CUMI%29_API"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/cisco"}, {"type"=>"x-developer", "url"=>"https://developer.cisco.com/"}, {"type"=>"x-email", "url"=>"info-pt@cisco.com"}, {"type"=>"x-email", "url"=>"info-ru@cisco.com"}, {"type"=>"x-email", "url"=>"ciscoj-newgrad@cisco.com"}, {"type"=>"x-email", "url"=>"recruit-jp@cisco.com"}, {"type"=>"x-email", "url"=>"cin-china@cisco.com"}, {"type"=>"x-email", "url"=>"privacy@cisco.com"}, {"type"=>"x-email", "url"=>"ethics@cisco.com"}, {"type"=>"x-email", "url"=>"web-help@cisco.com"}, {"type"=>"x-email", "url"=>"BusinessInsights@cisco.com"}, {"type"=>"x-email", "url"=>"hk_assistant@cisco.com"}, {"type"=>"x-support", "url"=>"https://developer.cisco.com/site/devnet/support/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Cisco"}, {"type"=>"x-website", "url"=>"http://cisco.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-direct-connect{"aws-direct-connect-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Direct Connect", "x-complete"=>1, "info"=>{"title"=>"AWS Direct Connect API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AllocateConnectionOnInterconnect"=>{"get"=>{"summary"=>"Allocate Connection On Interconnect", "description"=>"Creates a hosted connection on an interconnect.", "operationId"=>"allocateConnectionOnInterconnect", "x-api-path-slug"=>"actionallocateconnectiononinterconnect-get", "parameters"=>[{"in"=>"query", "name"=>"bandwidth", "description"=>"Bandwidth of the connection", "type"=>"string"}, {"in"=>"query", "name"=>"connectionName", "description"=>"Name of the provisioned connection", "type"=>"string"}, {"in"=>"query", "name"=>"interconnectId", "description"=>"ID of the interconnect on which the connection will be provisioned", "type"=>"string"}, {"in"=>"query", "name"=>"ownerAccount", "description"=>"Numeric account Id of the customer for whom the connection will be provisioned", "type"=>"string"}, {"in"=>"query", "name"=>"vlan", "description"=>"The dedicated VLAN provisioned to the connection", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connections"]}}, "/?Action=AllocatePrivateVirtualInterface"=>{"get"=>{"summary"=>"Allocate Private Virtual Interface", "description"=>"Provisions a private virtual interface to be owned by a different customer.", "operationId"=>"allocatePrivateVirtualInterface", "x-api-path-slug"=>"actionallocateprivatevirtualinterface-get", "parameters"=>[{"in"=>"query", "name"=>"connectionId", "description"=>"The connection ID on which the private virtual interface is provisioned", "type"=>"string"}, {"in"=>"query", "name"=>"newPrivateVirtualInterfaceAllocation", "description"=>"Detailed information for the private virtual interface to be provisioned", "type"=>"string"}, {"in"=>"query", "name"=>"ownerAccount", "description"=>"The AWS account that will own the new private virtual interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Private Virtual Interfaces"]}}, "/?Action=AllocatePublicVirtualInterface"=>{"get"=>{"summary"=>"Allocate Public Virtual Interface", "description"=>"Provisions a public virtual interface to be owned by a different customer.", "operationId"=>"allocatePublicVirtualInterface", "x-api-path-slug"=>"actionallocatepublicvirtualinterface-get", "parameters"=>[{"in"=>"query", "name"=>"connectionId", "description"=>"The connection ID on which the public virtual interface is provisioned", "type"=>"string"}, {"in"=>"query", "name"=>"newPublicVirtualInterfaceAllocation", "description"=>"Detailed information for the public virtual interface to be provisioned", "type"=>"string"}, {"in"=>"query", "name"=>"ownerAccount", "description"=>"The AWS account that will own the new public virtual interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Private Virtual Interfaces"]}}, "/?Action=ConfirmConnection"=>{"get"=>{"summary"=>"Confirm Connection", "description"=>"Confirm the creation of a hosted connection on an interconnect.", "operationId"=>"confirmConnection", "x-api-path-slug"=>"actionconfirmconnection-get", "parameters"=>[{"in"=>"query", "name"=>"connectionId", "description"=>"ID of the connection", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connections"]}}, "/?Action=ConfirmPrivateVirtualInterface"=>{"get"=>{"summary"=>"Confirm Private Virtual Interface", "description"=>"Accept ownership of a private virtual interface created by another customer.", "operationId"=>"confirmPrivateVirtualInterface", "x-api-path-slug"=>"actionconfirmprivatevirtualinterface-get", "parameters"=>[{"in"=>"query", "name"=>"virtualGatewayId", "description"=>"ID of the virtual private gateway that will be attached to the virtual interface", "type"=>"string"}, {"in"=>"query", "name"=>"virtualInterfaceId", "description"=>"ID of the virtual interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Private Virtual Interfaces"]}}, "/?Action=ConfirmPublicVirtualInterface"=>{"get"=>{"summary"=>"Confirm Public Virtual Interface", "description"=>"Accept ownership of a public virtual interface created by another customer.", "operationId"=>"confirmPublicVirtualInterface", "x-api-path-slug"=>"actionconfirmpublicvirtualinterface-get", "parameters"=>[{"in"=>"query", "name"=>"virtualInterfaceId", "description"=>"ID of the virtual interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Private Virtual Interfaces"]}}, "/?Action=CreateBGPPeer"=>{"get"=>{"summary"=>"Create B G P Peer", "description"=>"Creates a new BGP peer on a specified virtual interface.", "operationId"=>"createBGPPeer", "x-api-path-slug"=>"actioncreatebgppeer-get", "parameters"=>[{"in"=>"query", "name"=>"newBGPPeer", "description"=>"Detailed information for the BGP peer to be created", "type"=>"string"}, {"in"=>"query", "name"=>"virtualInterfaceId", "description"=>"The ID of the virtual interface on which the BGP peer will be provisioned", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BGP Peer"]}}, "/?Action=CreateConnection"=>{"get"=>{"summary"=>"Create Connection", "description"=>"Creates a new connection between the customer network and a specific AWS Direct Connect location.", "operationId"=>"createConnection", "x-api-path-slug"=>"actioncreateconnection-get", "parameters"=>[{"in"=>"query", "name"=>"bandwidth", "description"=>"Bandwidth of the connection", "type"=>"string"}, {"in"=>"query", "name"=>"connectionName", "description"=>"The name of the connection", "type"=>"string"}, {"in"=>"query", "name"=>"location", "description"=>"Where the connection is located", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connections"]}}, "/?Action=CreateInterconnect"=>{"get"=>{"summary"=>"Create Interconnect", "description"=>"Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.", "operationId"=>"createInterconnect", "x-api-path-slug"=>"actioncreateinterconnect-get", "parameters"=>[{"in"=>"query", "name"=>"bandwidth", "description"=>"The port bandwidth", "type"=>"string"}, {"in"=>"query", "name"=>"interconnectName", "description"=>"The name of the interconnect", "type"=>"string"}, {"in"=>"query", "name"=>"location", "description"=>"Where the interconnect is located", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Interconnects"]}}, "/?Action=CreatePrivateVirtualInterface"=>{"get"=>{"summary"=>"Create Private Virtual Interface", "description"=>"Creates a new private virtual interface.", "operationId"=>"createPrivateVirtualInterface", "x-api-path-slug"=>"actioncreateprivatevirtualinterface-get", "parameters"=>[{"in"=>"query", "name"=>"connectionId", "description"=>"ID of the connection", "type"=>"string"}, {"in"=>"query", "name"=>"newPrivateVirtualInterface", "description"=>"Detailed information for the private virtual interface to be created", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Private Virtual Interfaces"]}}, "/?Action=CreatePublicVirtualInterface"=>{"get"=>{"summary"=>"Create Public Virtual Interface", "description"=>"Creates a new public virtual interface.", "operationId"=>"createPublicVirtualInterface", "x-api-path-slug"=>"actioncreatepublicvirtualinterface-get", "parameters"=>[{"in"=>"query", "name"=>"connectionId", "description"=>"ID of the connection", "type"=>"string"}, {"in"=>"query", "name"=>"newPublicVirtualInterface", "description"=>"Detailed information for the public virtual interface to be created", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Private Virtual Interfaces"]}}, "/?Action=DeleteBGPPeer"=>{"get"=>{"summary"=>"Delete B G P Peer", "description"=>"Deletes a BGP peer on the specified virtual interface that matches the specified customer address and ASN.", "operationId"=>"deleteBGPPeer", "x-api-path-slug"=>"actiondeletebgppeer-get", "parameters"=>[{"in"=>"query", "name"=>"asn", "description"=>"Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration", "type"=>"string"}, {"in"=>"query", "name"=>"customerAddress", "description"=>"IP address assigned to the customer interface", "type"=>"string"}, {"in"=>"query", "name"=>"virtualInterfaceId", "description"=>"The ID of the virtual interface from which the BGP peer will be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BGP Peer"]}}, "/?Action=DeleteConnection"=>{"get"=>{"summary"=>"Delete Connection", "description"=>"Deletes the connection.", "operationId"=>"deleteConnection", "x-api-path-slug"=>"actiondeleteconnection-get", "parameters"=>[{"in"=>"query", "name"=>"connectionId", "description"=>"ID of the connection", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connections"]}}, "/?Action=DeleteInterconnect"=>{"get"=>{"summary"=>"Delete Interconnect", "description"=>"Deletes the specified interconnect.", "operationId"=>"deleteInterconnect", "x-api-path-slug"=>"actiondeleteinterconnect-get", "parameters"=>[{"in"=>"query", "name"=>"interconnectId", "description"=>"The ID of the interconnect", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Interconnects"]}}, "/?Action=DeleteVirtualInterface"=>{"get"=>{"summary"=>"Delete Virtual Interface", "description"=>"Deletes a virtual interface.", "operationId"=>"deleteVirtualInterface", "x-api-path-slug"=>"actiondeletevirtualinterface-get", "parameters"=>[{"in"=>"query", "name"=>"virtualInterfaceId", "description"=>"ID of the virtual interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Interfaces"]}}, "/?Action=DescribeConnectionLoa"=>{"get"=>{"summary"=>"Describe Connection Loa", "description"=>"Returns the LOA-CFA for a Connection.", "operationId"=>"describeConnectionLoa", "x-api-path-slug"=>"actiondescribeconnectionloa-get", "parameters"=>[{"in"=>"query", "name"=>"connectionId", "description"=>"ID of the connection", "type"=>"string"}, {"in"=>"query", "name"=>"loaContentType", "description"=>"A standard media type indicating the content type of the LOA-CFA document", "type"=>"string"}, {"in"=>"query", "name"=>"providerName", "description"=>"The name of the APN partner or service provider who establishes connectivity on your behalf", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connections"]}}, "/?Action=DescribeConnections"=>{"get"=>{"summary"=>"Describe Connections", "description"=>"Displays all connections in this region.", "operationId"=>"describeConnections", "x-api-path-slug"=>"actiondescribeconnections-get", "parameters"=>[{"in"=>"query", "name"=>"connectionId", "description"=>"ID of the connection", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connections"]}}, "/?Action=DescribeConnectionsOnInterconnect"=>{"get"=>{"summary"=>"Describe Connections On Interconnect", "description"=>"Return a list of connections that have been provisioned on the given interconnect.", "operationId"=>"describeConnectionsOnInterconnect", "x-api-path-slug"=>"actiondescribeconnectionsoninterconnect-get", "parameters"=>[{"in"=>"query", "name"=>"interconnectId", "description"=>"ID of the interconnect on which a list of connection is provisioned", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connections"]}}, "/?Action=DescribeInterconnectLoa"=>{"get"=>{"summary"=>"Describe Interconnect Loa", "description"=>"Returns the LOA-CFA for an Interconnect.", "operationId"=>"describeInterconnectLoa", "x-api-path-slug"=>"actiondescribeinterconnectloa-get", "parameters"=>[{"in"=>"query", "name"=>"interconnectId", "description"=>"The ID of the interconnect", "type"=>"string"}, {"in"=>"query", "name"=>"loaContentType", "description"=>"A standard media type indicating the content type of the LOA-CFA document", "type"=>"string"}, {"in"=>"query", "name"=>"providerName", "description"=>"The name of the service provider who establishes connectivity on your behalf", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Interconnects"]}}, "/?Action=DescribeInterconnects"=>{"get"=>{"summary"=>"Describe Interconnects", "description"=>"Returns a list of interconnects owned by the AWS account.", "operationId"=>"describeInterconnects", "x-api-path-slug"=>"actiondescribeinterconnects-get", "parameters"=>[{"in"=>"query", "name"=>"interconnectId", "description"=>"The ID of the interconnect", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Interconnects"]}}, "/?Action=DescribeLocations"=>{"get"=>{"summary"=>"Describe Locations", "description"=>"Returns the list of AWS Direct Connect locations in the current AWS region.", "operationId"=>"describeLocations", "x-api-path-slug"=>"actiondescribelocations-get", "parameters"=>[{"in"=>"query", "name"=>"locations", "description"=>"A list of colocation hubs where network providers have equipment", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Locations"]}}, "/?Action=DescribeTags"=>{"get"=>{"summary"=>"Describe Tags", "description"=>"Describes the tags associated with the specified Direct Connect resources.", "operationId"=>"describeTags", "x-api-path-slug"=>"actiondescribetags-get", "parameters"=>[{"in"=>"query", "name"=>"resourceArns", "description"=>"The Amazon Resource Names (ARNs) of the Direct Connect resources", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=DescribeVirtualGateways"=>{"get"=>{"summary"=>"Describe Virtual Gateways", "description"=>"Returns a list of virtual private gateways owned by the AWS account.", "operationId"=>"describeVirtualGateways", "x-api-path-slug"=>"actiondescribevirtualgateways-get", "parameters"=>[{"in"=>"query", "name"=>"virtualGateways", "description"=>"A list of virtual private gateways", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Gateways"]}}, "/?Action=DescribeVirtualInterfaces"=>{"get"=>{"summary"=>"Describe Virtual Interfaces", "description"=>"Displays all virtual interfaces for an AWS account.", "operationId"=>"describeVirtualInterfaces", "x-api-path-slug"=>"actiondescribevirtualinterfaces-get", "parameters"=>[{"in"=>"query", "name"=>"connectionId", "description"=>"ID of the connection", "type"=>"string"}, {"in"=>"query", "name"=>"virtualInterfaceId", "description"=>"ID of the virtual interface", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Private Virtual Interfaces"]}}, "/?Action=TagResource"=>{"get"=>{"summary"=>"Tag Resource", "description"=>"Adds the specified tags to the specified Direct Connect resource.", "operationId"=>"tagResource", "x-api-path-slug"=>"actiontagresource-get", "parameters"=>[{"in"=>"query", "name"=>"resourceArn", "description"=>"The Amazon Resource Name (ARN) of the Direct Connect resource", "type"=>"string"}, {"in"=>"query", "name"=>"tags", "description"=>"The list of tags to add", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Tags"]}}, "/?Action=UntagResource"=>{"get"=>{"summary"=>"Untag Resource", "description"=>"Removes one or more tags from the specified Direct Connect resource.", "operationId"=>"untagResource", "x-api-path-slug"=>"actionuntagresource-get", "parameters"=>[{"in"=>"query", "name"=>"resourceArn", "description"=>"The Amazon Resource Name (ARN) of the Direct Connect resource", "type"=>"string"}, {"in"=>"query", "name"=>"tagKeys", "description"=>"The list of tag keys to remove", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Tags"]}}}}, "apis"=>{"name"=>"AWS Direct Connect", "x-slug"=>"aws-direct-connect", "description"=>"AWS Direct Connect makes it easy to establish a dedicated network connection from your premises to AWS. Using AWS Direct Connect, you can establish private connectivity between AWS and your datacenter, office, or colocation environment, which in many cases can reduce your network costs, increase bandwidth throughput, and provide a more consistent network experience than Internet-based connections.AWS Direct Connect lets you establish a dedicated network connection between your network and one of the AWS Direct Connect locations. Using industry standard 802.1q VLANs, this dedicated connection can be partitioned into multiple virtual interfaces. This allows you to use the same connection to access public resources such as objects stored in Amazon S3 using public IP address space, and private resources such as Amazon EC2 instances running within anAmazon Virtual Private Cloud (VPC)using private IP space, while maintaining network separation between the public and private environments. Virtual interfaces can be reconfigured at any time to meet your changing needs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Networking_AWSDirectConnect.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Networks,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-direct-connect/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Direct Connect API", "x-api-slug"=>"aws-direct-connect-api", "description"=>"AWS Direct Connect makes it easy to establish a dedicated network connection from your premises to AWS. Using AWS Direct Connect, you can establish private connectivity between AWS and your datacenter, office, or colocation environment, which in many cases can reduce your network costs, increase bandwidth throughput, and provide a more consistent network experience than Internet-based connections.AWS Direct Connect lets you establish a dedicated network connection between your network and one of the AWS Direct Connect locations. Using industry standard 802.1q VLANs, this dedicated connection can be partitioned into multiple virtual interfaces. This allows you to use the same connection to access public resources such as objects stored in Amazon S3 using public IP address space, and private resources such as Amazon EC2 instances running within anAmazon Virtual Private Cloud (VPC)using private IP space, while maintaining network separation between the public and private environments. Virtual interfaces can be reconfigured at any time to meet your changing needs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Networking_AWSDirectConnect.png", "humanURL"=>"https://aws.amazon.com/directconnect/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Networks,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-direct-connect/aws-direct-connect-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-log", "url"=>"http://aws.amazon.com/releasenotes/AWS-Direct-Connect"}, {"type"=>"x-console", "url"=>"https://console.aws.amazon.com/directconnect/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/directconnect/latest/APIReference/Welcome.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/directconnect/faqs/"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=126"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/directconnect/getting-started/"}, {"type"=>"x-partner-bundles", "url"=>"ttps://aws.amazon.com/directconnect/directconnectbundles/"}, {"type"=>"x-partners", "url"=>"https://aws.amazon.com/directconnect/partners/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/directconnect/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/directconnect/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
npr{"npr-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"NPR", "x-complete"=>1, "info"=>{"title"=>"NPR One API Reference", "description"=>"npr-one-is-a-smart-application-that-brings-the-best-of-npr-and-member-station-programming-newscasts-podcasts-and-stories-together-to-create-a-new-experience-for-listening--it-provides-an-editorcurated-and-localized-mobile-listening-experience-based-on-the-content-the-listener-chooses-likes-shares-and-enjoys--the-api-provides-all-of-the-content-and-customization-in-a-simple-structured-way-that-is-easy-for-applicationdevelopers-to-implement-", "termsOfService"=>"http://dev.npr.org/develop/terms-of-use", "contact"=>{"name"=>"NPR One Enterprise Team", "url"=>"http://dev.npr.org", "email"=>"NPROneEnterprise@npr.org"}, "version"=>"1.0.0"}, "host"=>"api.npr.org", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/authorization/v2/authorize"=>{"get"=>{"summary"=>"Show a web-based login/signup form to a user", "description"=>"If the parameters passed to this endpoint are correct, it will redirect to `npr.org/oauth2/login` for the user to complete the sign-in.\n\nCurrently acceptable values for `scope` are any combination of the following:\n- `identity.readonly` - for read-only access to the Identity Service\n- `identity.write` - for write access to the Identity Service\n- `listening.readonly` - for read-only access to the Listening Service\n- `listening.write` - for write access to the Listening Service\n- `localactivation` - for all access to the Local Activation Service\n\nIt is generally suggested that you assume that you will need all of the current scopes in order to successfully implement an NPR One application.\n\nIf the parameters passed in are NOT correct and the client passed in a valid `redirect_uri` parameter, the request will be redirected to `{{YOUR_REDIRECT_URI}}?error={{ERROR_TYPE}}&message={{ERROR_DESCRIPTION}}`.\nIf the parameters passed are NOT correct and the client did not pass in a valid `redirect_uri` parameter, this endpoint will return the errors encoded as JSON objects (along with the corresponding HTTP status code -- usually 400).\nThe latter is intended for development and debugging purposes -- in a real-world situation, errors returned as JSON objects are irretrievable by the client application, and thus passing in a valid `redirect_uri` is critical even for the purpose of capturing errors.\n\nIf the user successfully logs in and authorizes the application, the request will be redirected to `{{YOUR_REDIRECT_URI}}?code={{AUTHORIZATION_CODE}}&state={{CSRF_TOKEN}}`\n\nIf the user DENIES the application, they will be redirected to `{{YOUR_REDIRECT_URI}}?error=denied&message=The%20user%20has%20denied%20the%20login%20and%20access%20request&state={{CSRF_TOKEN}}`.\nThis means that if your application flow requires a user to log in in order to proceed, it is up to you to give them the proper messaging explaining that the sign-in must be authorized in order to continue.\n\nFinally, please do not confuse an authorization code with an access token. Once your app has completed this flow, you will still need to call `POST /authorization/v2/token` in order to swap the code for a valid access token.", "operationId"=>"getAuthorizationPage", "x-api-path-slug"=>"authorizationv2authorize-get", "parameters"=>[{"in"=>"query", "name"=>"client_id", "description"=>"The clients ID"}, {"in"=>"query", "name"=>"redirect_uri", "description"=>"The clients URL to redirect to if the authentication is approved"}, {"in"=>"query", "name"=>"response_type", "description"=>"The type of response; currently, only `code` is supported"}, {"in"=>"query", "name"=>"scope", "description"=>"A space-separated list of scope(s) requested by the application"}, {"in"=>"query", "name"=>"state", "description"=>"A CSRF token generated by the client, to be roundtripped through the request for added security"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Authorization", "Authorize"]}}, "/authorization/v2/device"=>{"post"=>{"summary"=>"Initiate an OAuth2 login flow for limited input devices", "description"=>"This flow should only be used by clients who cannot show a native webview or do not have advanced input controls. It is an alternative to `GET /authorization/v2/authorize`.\n\nThird-party clients will need to use one or the other of these two endpoints, but they will generally not use both.", "operationId"=>"generateDeviceCode", "x-api-path-slug"=>"authorizationv2device-post", "parameters"=>[{"in"=>"formData", "name"=>"client_id", "description"=>"The clients ID"}, {"in"=>"formData", "name"=>"client_secret", "description"=>"The clients secret key"}, {"in"=>"formData", "name"=>"scope", "description"=>"A space-separated list of scope(s) requested by the application"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Authorization", "Device"]}}, "/authorization/v2/token"=>{"post"=>{"summary"=>"Create a new OAuth2 access token", "description"=>"Please be aware that the required parameters are contingent on the `grant_type` that you select.\n\nFor the `authorization_code` grant type, you are **required** to pass in the `code` and `redirect_uri` parameters. `service`, `username` and `password` parameters will be ignored.\n\nFor the `client_credentials` grant type, you do not need to pass in any additional parameters beyond the basic requirements. `code`, `redirect_uri`, `service`, `username` and `password` parameters will be ignored.\n\nFor the `device_code` grant type, you are **required** to pass in the `code` parameter. `redirect_uri`, `service`, `username` and `password` parameters will be ignored.\n\nFor the `password` grant type, you are **required** to pass in the `username` and `password` parameters. If you are logging in via a social service, you should also pass in the `service` parameter. (In this case, the access token you receive from the social service will serve as both your username and password.) The `code` and `redirect_uri` parameters are ignored.\nThird-party developers do not have access to this grant type.\n\nFor the `refresh_token` grant type, you are **required** to pass in the `refresh_token` parameter. The `scope` parameter can optionally be used to request a different set of scopes than were used in the original request, but it **cannot** contain any scopes that were not previously requested. If not specified, then `scope` will be set to whichever scopes were used for the original access token request. If trading in an old non-expiring access token for a refresh-enabled token, set the value of `refresh_token` to the access token value and `token_type_hint` must be set to `access_token`. `code`, `redirect_uri`, `service`, `username` and `password` parameters will be ignored.\n\nThe `temporary_user` and `anonymous_user` grant types are custom grant types created by NPR to suit our needs for functionality such as our "try-before-you-buy" experience. If you are a third-party developer, you will not have access to these grant types unless we have explicitly given you permission within our system.\nFor these grant types, you do not need to pass in any additional parameters beyond the basic requirements. `code`, `redirect_uri`, `service`, `username` and `password` parameters will be ignored.\n\nIf you are unsure of which grant type to select, assume that `authorization_code` is the one you want.\n\nNote that at this time, refresh tokens are an opt-in feature; however, in the future, they will gradually transition to being opt-out, and ultimately required for all clients. Our general guidance at this time is that if this endpoint starts returning refresh tokens for you, you are responsible for implementing the code to handle them appropriately in accordance with the OAuth 2.0 spec. For more information about our gradual rollout of this feature, please contact the NPR One API team.", "operationId"=>"createToken", "x-api-path-slug"=>"authorizationv2token-post", "parameters"=>[{"in"=>"formData", "name"=>"client_id", "description"=>"The clients ID, required for all grant types"}, {"in"=>"formData", "name"=>"client_secret", "description"=>"The clients secret, required for all grant types"}, {"in"=>"formData", "name"=>"code", "description"=>"Required for `authorization_code` and `device_code` grant types"}, {"in"=>"formData", "name"=>"grant_type", "description"=>"The type of grant the client is requesting"}, {"in"=>"formData", "name"=>"password", "description"=>"Required for `password` grant type"}, {"in"=>"formData", "name"=>"redirect_uri", "description"=>"Required for `authorization_code` grant type"}, {"in"=>"formData", "name"=>"refresh_token", "description"=>"Required for `refresh_token` grant type"}, {"in"=>"formData", "name"=>"scope", "description"=>"Optionally used by the `refresh_token` grant type only"}, {"in"=>"formData", "name"=>"service", "description"=>"If logging in via a social service, this parameter should be set"}, {"in"=>"formData", "name"=>"token_type_hint", "description"=>"A hint about the type of the token submitted for a new access and refresh token"}, {"in"=>"formData", "name"=>"username", "description"=>"Required for `password` grant type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Authorization", "Token"]}}, "/authorization/v2/token/revoke"=>{"post"=>{"summary"=>"Revoke an existing OAuth2 access token", "description"=>"Our implementation follows the proposed IETF specification [RFC-7009](https://tools.ietf.org/html/rfc7009).\n\nIf your client application offers the ability to for a logged-in user to log out, and you have access to a long-lived\n`client_credentials` token (i.e. you have generated one that you are storing securely for the lifetime of the entire app\ninstall), we suggest (but do not require) that you call this endpoint and revoke the access token belonging to the\nlogged-in user as part of your logout process. If you do not already have a long-lived `client_credentials` token,\nplease don't generate one just for the purposes of calling this endpoint.\n\nIf you are building a prototype application, we also recommend that you use this endpoint to clean up access tokens\nthat you generate during the testing of your app and do not intend to reuse.\n\nNote that revoking an access token will automatically revoke any refresh tokens associated with it, and vice-versa.", "operationId"=>"revokeToken", "x-api-path-slug"=>"authorizationv2tokenrevoke-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"A `client_credentials` access token from the same client application as the token being revoked"}, {"in"=>"formData", "name"=>"token", "description"=>"The access token or refresh token that the client wants to have revoked"}, {"in"=>"formData", "name"=>"token_type_hint", "description"=>"A hint about the type of the token submitted for revocation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Authorization", "Token", "Revoke"]}}, "/identity/v2/following"=>{"post"=>{"summary"=>"Update the following status of the logged-in user for a particular aggregation", "description"=>"After a successful call, this returns a User document with an updated list of affiliations.", "operationId"=>"postFollowing", "x-api-path-slug"=>"identityv2following-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A JSON-serialized object which contains data about a user affiliation such as the aggregation ID, affiliation rating, aggregation URL, days since last listen, and following status", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Entity", "Following"]}}, "/identity/v2/stations"=>{"put"=>{"summary"=>"Update the logged-in user's favorite station(s)", "description"=>"Right now, only the primary station can be changed. Previously selected stations will not be deleted, but the new station will be moved to first in the array.", "operationId"=>"updateStations", "x-api-path-slug"=>"identityv2stations-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A JSON-serialized array of station IDs", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Entity", "Stations"]}}, "/identity/v2/user"=>{"get"=>{"summary"=>"Get the latest state information about the logged-in user", "description"=>"After a successful login, the client should send a `GET` call approximately once an hour to refresh the user data.", "operationId"=>"getUser", "x-api-path-slug"=>"identityv2user-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Entity", "User"]}}, "/identity/v2/user/inherit"=>{"post"=>{"summary"=>"Copy listening data from a temporary user account to the logged-in user's account", "description"=>"This can and should only be used by clients who have access to the `temporary_user` grant type.\n Third-party developers do not have access to this grant type by default, and will not need this endpoint.", "operationId"=>"inheritFromTempUser", "x-api-path-slug"=>"identityv2userinherit-post", "parameters"=>[{"in"=>"query", "name"=>"temp_user", "description"=>"The temporary users ID before the user registered or logged in"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Entity", "User", "Inherit"]}}, "/listening/v2/aggregation/{aggId}/recommendations"=>{"get"=>{"summary"=>"Get a set of recommendations for an aggregation", "description"=>"This endpoint provides a list of recent audio items associated with the aggregation along with metadata about the aggregation.", "operationId"=>"getAggRecommendations", "x-api-path-slug"=>"listeningv2aggregationaggidrecommendations-get", "parameters"=>[{"in"=>"path", "name"=>"aggId", "description"=>"ID of an aggregation such as a program or podcast"}, {"in"=>"query", "name"=>"startNum", "description"=>"The result to start with"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Listening", "Aggregation", "Agg", "Recommendations"]}}, "/listening/v2/channels"=>{"get"=>{"summary"=>"Get the list of available channels", "description"=>"These channels allow the user to specify a focus for the content returned in the recommendations endpoint.", "operationId"=>"getChannels", "x-api-path-slug"=>"listeningv2channels-get", "parameters"=>[{"in"=>"query", "name"=>"exploreOnly", "description"=>"If set to `true`, this call will return only channels that should be shown in the clients `Explore` view"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Listening", "Channels"]}}, "/listening/v2/history"=>{"get"=>{"summary"=>"Get recent ratings the logged-in user has submitted", "description"=>"This endpoint provides the list of recently-rated audio recommendations that the logged-in user has consumed. Some rated recommendations are filtered, such as sponsorship and donation.", "operationId"=>"getHistory", "x-api-path-slug"=>"listeningv2history-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Listening", "History"]}}, "/listening/v2/organizations/{orgId}/categories/{category}/recommendations"=>{"get"=>{"summary"=>"Get a list of recommendations from a category of content from an organization", "description"=>"This endpoint provides a list of recommendations from a category of content from an organization.", "operationId"=>"getOrganizationCategory", "x-api-path-slug"=>"listeningv2organizationsorgidcategoriescategoryrecommendations-get", "parameters"=>[{"in"=>"path", "name"=>"category", "description"=>"One of the three categories of content - newscast, story, or podcast"}, {"in"=>"path", "name"=>"orgId", "description"=>"ID of an organization, such as an NPR One station"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Listening", "Organizations", "Org", "Categories", "Category", "Recommendations"]}}, "/listening/v2/organizations/{orgId}/recommendations"=>{"get"=>{"summary"=>"Get a variety of details about an organization including various lists of recent audio items", "description"=>"This endpoint provides a variety of details about an organization including various lists of recent audio items.", "operationId"=>"getOrganizationOverview", "x-api-path-slug"=>"listeningv2organizationsorgidrecommendations-get", "parameters"=>[{"in"=>"path", "name"=>"orgId", "description"=>"ID of an organization, such as an NPR One station"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Listening", "Organizations", "Org", "Recommendations"]}}, "/listening/v2/promo/recommendations"=>{"get"=>{"summary"=>"Retrieve the most recent promo audio heard by the logged-in user", "description"=>"Gets the most recently played promo for which the user has neither tapped through the promo or listened to the target story.", "operationId"=>"getPromo", "x-api-path-slug"=>"listeningv2promorecommendations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Listening", "Promo", "Recommendations"]}}, "/listening/v2/ratings"=>{"post"=>{"summary"=>"Collect new ratings for media previously recommended to the logged-in user", "description"=>"This endpoint is the main mechanism for providing feedback from the user to NPR about the recommendations that are obtained from `GET /listening/v2/recommendations`.\n\nA fully-populated link to this endpoint is returned with each individual recommendation and is located in the AudioItemDocument under the `links['recommendations']` object. The query parameters in this link should not be modified.\nBe sure to copy and send back the entire ratings object (RatingData), as new fields may be added to it in the future.\n\nThis endpoint can return a blank JSON.doc or AudioItemDocument depending on the `recommend=true|false` parameter. The `recommend=true` flag allows this endpoint to both receive ratings and send back recommendations in the same call.", "operationId"=>"postRating", "x-api-path-slug"=>"listeningv2ratings-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A list of RatingData objects which contains data about ratings such as the id of the content, the rating value, elapsed time and more", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"recommend", "description"=>"If set to `false`, this call will return a blank document; otherwise it will return a new recommendation object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Listening", "Ratings"]}}, "/listening/v2/recommendations"=>{"get"=>{"summary"=>"Get a list of media for the logged-in user from NPR's recommendation engine", "description"=>"This endpoint returns a list of audio recommendations. It is designed to be used for an initial list of recommendations, and then `GET /listening/v2/ratings?recommend=true` should be used for subsequent requests for recommendations.\n\nA fully-populated link to the ratings endpoint is returned with each individual recommendation and is located in the AudioItemDocument under the `links['recommendations']` object. The query parameters in this link should not be modified.\nBe sure to copy and send back the entire ratings object (RatingData), as new fields may be added to it in the future.", "operationId"=>"getRecommendations", "x-api-path-slug"=>"listeningv2recommendations-get", "parameters"=>[{"in"=>"query", "name"=>"notifiedMediaId", "description"=>"The user received a push notification about this media; if provided, the service will add this recommendation to the top of the list"}, {"in"=>"query", "name"=>"sharedMediaId", "description"=>"This media was shared directly with the user; if provided, the service will add this recommendation to the top of the list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Listening", "Recommendations"]}}, "/listening/v2/search/recommendations"=>{"get"=>{"summary"=>"Get a list of recent audio and aggregation items associated with search terms", "description"=>"In the schema shown below, SearchItemDocument is not an actual type of returned object; the object returned by a search will be either an AggregationAudioItemListDocument or an AudioItemDocument.", "operationId"=>"getSearchRecommendations", "x-api-path-slug"=>"listeningv2searchrecommendations-get", "parameters"=>[{"in"=>"query", "name"=>"searchTerms", "description"=>"Search terms to search on; can include URL-encoded punctuation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Listening", "Search", "Recommendations"]}}, "/localactivation/v2/donate_email"=>{"get"=>{"summary"=>"Send a donation email to the logged-in user (only on request)", "description"=>"This will send a station-specific donation email to the logged-in user.", "operationId"=>"sendDonationEmail", "x-api-path-slug"=>"localactivationv2donate-email-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Localactivation", "Donate", "Email"]}}, "/sponsorship/v2/ads"=>{"get"=>{"summary"=>"Request DAAST sponsorship units", "description"=>"**Not** for use by NPR One clients (for whom sponsorship is already integrated into the Listening Service), this endpoint is designed to be used by our other client applications to request sponsorship on behalf of a user. Sponsorship units are returned in the form of DAAST XML. It is worth noting that this endpoint attempts to always return XML, even in the case of exceptions.\n\nThe default behavior of this endpoint is asynchronous; on an initial request, a call to our external sponsorship provider is placed on a queue, which is typically processed within 3 minutes. Once the sponsorship call is received and processed, the returned sponsorship units are placed in a cache on our server for the current user. Subsequent calls to this endpoint will return DAAST sponsorship units from this cache until tracking information is submitted, which removes the ad from the cache and will automatically request additional ads asynchronously if there are fewer than a certain number remaining in the cache.\n\nFor development purposes, it's worth noting that there is currently no way to clear a user's cache without submitting some form of tracking.", "operationId"=>"getAds", "x-api-path-slug"=>"sponsorshipv2ads-get", "parameters"=>[{"in"=>"query", "name"=>"adCount", "description"=>"How many sponsorship units to request in one call; if left unspecified, the default behavior is to return only 1"}, {"in"=>"query", "name"=>"forceResult", "description"=>"Whether to force a synchronous call to our external sponsorship provider; the default behavior is asynchronous"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Sponsorship", "Advertising"]}, "post"=>{"summary"=>"Record tracking data for DAAST sponsorship units", "description"=>"**Not** for use by NPR One clients (for whom sponsorship is already integrated into the Listening Service), this endpoint is designed to be used by our other client applications to submit tracking information for sponsorship units obtained from the `GET /sponsorship/v2/ads` endpoint.\n\nThe tracking information should be submitted in the body of the request in the form of a JSON object following the Collection.Doc+JSON specification.", "operationId"=>"receiveAdTracking", "x-api-path-slug"=>"sponsorshipv2ads-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A JSON object representing sponsorship tracking data to submit to our external provider", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Sponsorship", "Advertising"]}}, "/stationfinder/v3/stations"=>{"get"=>{"summary"=>"List stations close to you or filter by search criteria", "description"=>"This endpoint has two main use cases:\n\n- If no query parameters passed in, it returns a list of stations that are geographically closest to the calling client (based on GeoIP information)\n- If one or more query parameters are passed in, it performs a search of NPR stations that match those search criteria (not taking into account the client's physical location)\n\nClients wanting to implement a 'Change Station' UI should use this endpoint to power their search. In most cases, you'll want to build a search interface that uses one of the 3 provided schemas: `lat` and `lon` (using e.g. the HTML5 Geolocation API), `city` and `state`, _or_ the generic `q` query which can accept a station name, call letters, network name, or zip code. Technically speaking, `q` can also take in either a city name or a state name, but using the `city` and `state` parameters together will yield more accurate geographic search results than `q={cityName}`.\n\nThe `lat` and `lon` query parameters should always be passed in together (otherwise the API will return a 400 error), and if included in the query, they will take precedence over any other search criteria; that is, `lat` and `lon` will do a purely geographic search and not take into account `q`, `city` or `state`.\n\nSimilarly, `city` and/or `state` will take precedence over (and ignore) `q`.\n\nIf clients want to be able to offer multiple types of searches (e.g. 'Search for a station name, city or zipcode') using a *single* search input form, `q` should be used. But again, be aware that using `city` and `state` together will yield more accurate search results than `q={cityName}`.", "operationId"=>"searchStations", "x-api-path-slug"=>"stationfinderv3stations-get", "parameters"=>[{"in"=>"query", "name"=>"city", "description"=>"A city to look for stations from; intended to be paired with `state`"}, {"in"=>"query", "name"=>"lat", "description"=>"A latitude value from a geographic coordinate system; only works if paired with `lon`"}, {"in"=>"query", "name"=>"lon", "description"=>"A longitude value from a geographic coordinate system; only works if paired with `lat`"}, {"in"=>"query", "name"=>"q", "description"=>"Search terms to search on; can be a station name, network name, call letters, or zipcode"}, {"in"=>"query", "name"=>"state", "description"=>"A state to look for stations from (using the 2-letter abbreviation); intended to be paired with `city`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Stationfinder", "Stations"]}}, "/stationfinder/v3/stations/{stationId}"=>{"get"=>{"summary"=>"Retrieve metadata for the station with the given numeric ID", "description"=>"This endpoint retrieves information about a given station, based on its numeric ID, which is consistent across all of NPR's APIs.\n\nA typical use case for this data is for clients who want to create a dropdown menu, modal/pop-up or dedicated page displaying more information about the station the client is localized to, including, for example, links to the station's homepage and donation (pledge) page.", "operationId"=>"getStationById", "x-api-path-slug"=>"stationfinderv3stationsstationid-get", "parameters"=>[{"in"=>"path", "name"=>"stationId", "description"=>"The numeric ID of a station"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Stationfinder", "Stations", "Station"]}}}}, "apis"=>{"name"=>"NPR", "x-slug"=>"npr", "description"=>"NPR delivers breaking national and world news. Also top stories from business, politics, health, science, technology, music, arts and culture. Subscribe to podcasts and RSS feeds.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/141-npr.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"598", "tags"=>"API Provider,Broadcasts,Federal Government,General Data,Getting Started Example,Media,Mobile,News,Pedestal,Profiles,Publish,Radio,Relative Data,Relative StreamRank,Service API,Stack,Stack Network,Streams,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"npr/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"NPR", "x-api-slug"=>"npr", "description"=>"NPR delivers breaking national and world news. Also top stories from business, politics, health, science, technology, music, arts and culture. Subscribe to podcasts and RSS feeds.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/141-npr.jpg", "humanURL"=>"http://npr.org", "baseURL"=>"https://api.npr.org//", "tags"=>"API Provider,Broadcasts,Federal Government,General Data,Getting Started Example,Media,Mobile,News,Pedestal,Profiles,Publish,Radio,Relative Data,Relative StreamRank,Service API,Stack,Stack Network,Streams,Streams,Streams", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/npr/stationfinderv3stationsstationid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/npr/npr-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api.npr.org/"}, {"type"=>"x-codecademy", "url"=>"http://www.codecademy.com/tracks/npr"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/npr"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/npr"}, {"type"=>"x-developer", "url"=>"http://dev.npr.org/"}, {"type"=>"x-documentation", "url"=>"http://dev.npr.org/#accessing-the-api"}, {"type"=>"x-email", "url"=>"permissions@npr.org"}, {"type"=>"x-email", "url"=>"ogcstaff@npr.org"}, {"type"=>"x-email", "url"=>"employment@npr.org"}, {"type"=>"x-email", "url"=>"careers@npr.org"}, {"type"=>"x-email", "url"=>"kroc@npr.org"}, {"type"=>"x-email", "url"=>"mediarelations@npr.org"}, {"type"=>"x-email", "url"=>"sponsorship@npr.org"}, {"type"=>"x-email", "url"=>"ashamblin@npr.org"}, {"type"=>"x-email", "url"=>"giving@npr.org"}, {"type"=>"x-email", "url"=>"giftplanning@npr.org"}, {"type"=>"x-email", "url"=>"NPRDonorCommunications@npr.org"}, {"type"=>"x-getting-started", "url"=>"http://dev.npr.org/#quick-start"}, {"type"=>"x-github", "url"=>"https://github.com/npr"}, {"type"=>"x-selfservice-registration", "url"=>"http://www.npr.org/templates/reg/"}, {"type"=>"x-terms-of-service", "url"=>"http://www.npr.org/about-npr/179876898/terms-of-use"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/NPR"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/NPRTechTeam"}, {"type"=>"x-website", "url"=>"http://npr.org"}, {"type"=>"x-website", "url"=>"http://www.npr.org"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-identity-and-access-management{"aws-identity-and-access-management-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Identity and Access Management", "x-complete"=>1, "info"=>{"title"=>"AWS Identity and Access Management API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddClientIDToOpenIDConnectProvider"=>{"get"=>{"summary"=>"Add Client I D To Open I D Connect Provider", "description"=>"Adds a new client ID (also known as audience) to the list of client IDs already\n registered for the specified IAM OpenID Connect (OIDC) provider resource.", "operationId"=>"addClientIDToOpenIDConnectProvider", "x-api-path-slug"=>"actionaddclientidtoopenidconnectprovider-get", "parameters"=>[{"in"=>"query", "name"=>"ClientID", "description"=>"The client ID (also known as audience) to add to the IAM OpenID Connect provider resource", "type"=>"string"}, {"in"=>"query", "name"=>"OpenIDConnectProviderArn", "description"=>"The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to add the client ID to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OpenID Connect Providers"]}}, "/?Action=AddRoleToInstanceProfile"=>{"get"=>{"summary"=>"Add Role To Instance Profile", "description"=>"Adds the specified IAM role to the specified instance profile.", "operationId"=>"addRoleToInstanceProfile", "x-api-path-slug"=>"actionaddroletoinstanceprofile-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceProfileName", "description"=>"The name of the instance profile to update", "type"=>"string"}, {"in"=>"query", "name"=>"RoleName", "description"=>"The name of the role to add", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Role Instance"]}}, "/?Action=AddUserToGroup"=>{"get"=>{"summary"=>"Add User To Group", "description"=>"Adds the specified user to the specified group.", "operationId"=>"addUserToGroup", "x-api-path-slug"=>"actionaddusertogroup-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The name of the group to update", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user to add", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Groups"]}}, "/?Action=AttachGroupPolicy"=>{"get"=>{"summary"=>"Attach Group Policy", "description"=>"Attaches the specified managed policy to the specified IAM group.", "operationId"=>"attachGroupPolicy", "x-api-path-slug"=>"actionattachgrouppolicy-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The name (friendly name, not ARN) of the group to attach the policy to", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyArn", "description"=>"The Amazon Resource Name (ARN) of the IAM policy you want to attach", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group Policies"]}}, "/?Action=AttachRolePolicy"=>{"get"=>{"summary"=>"Attach Role Policy", "description"=>"Attaches the specified managed policy to the specified IAM role.", "operationId"=>"attachRolePolicy", "x-api-path-slug"=>"actionattachrolepolicy-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyArn", "description"=>"The Amazon Resource Name (ARN) of the IAM policy you want to attach", "type"=>"string"}, {"in"=>"query", "name"=>"RoleName", "description"=>"The name (friendly name, not ARN) of the role to attach the policy to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Role Policies"]}}, "/?Action=AttachUserPolicy"=>{"get"=>{"summary"=>"Attach User Policy", "description"=>"Attaches the specified managed policy to the specified user.", "operationId"=>"attachUserPolicy", "x-api-path-slug"=>"actionattachuserpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyArn", "description"=>"The Amazon Resource Name (ARN) of the IAM policy you want to attach", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name (friendly name, not ARN) of the IAM user to attach the policy to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Policies"]}}, "/?Action=ChangePassword"=>{"get"=>{"summary"=>"Change Password", "description"=>"Changes the password of the IAM user who is calling this action.", "operationId"=>"changePassword", "x-api-path-slug"=>"actionchangepassword-get", "parameters"=>[{"in"=>"query", "name"=>"NewPassword", "description"=>"The new password", "type"=>"string"}, {"in"=>"query", "name"=>"OldPassword", "description"=>"The IAM users current password", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Passwords"]}}, "/?Action=CreateAccessKey"=>{"get"=>{"summary"=>"Create Access Key", "description"=>"Creates a new AWS secret access key and corresponding AWS access key ID for the\n specified user.", "operationId"=>"createAccessKey", "x-api-path-slug"=>"actioncreateaccesskey-get", "parameters"=>[{"in"=>"query", "name"=>"UserName", "description"=>"The name of the IAM user that the new key will belong to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Access Keys"]}}, "/?Action=CreateAccountAlias"=>{"get"=>{"summary"=>"Create Account Alias", "description"=>"Creates an alias for your AWS account.", "operationId"=>"createAccountAlias", "x-api-path-slug"=>"actioncreateaccountalias-get", "parameters"=>[{"in"=>"query", "name"=>"AccountAlias", "description"=>"The account alias to create", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account Alias"]}}, "/?Action=CreateGroup"=>{"get"=>{"summary"=>"Create Group", "description"=>"Creates a new group.", "operationId"=>"createGroup", "x-api-path-slug"=>"actioncreategroup-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The name of the group to create", "type"=>"string"}, {"in"=>"query", "name"=>"Path", "description"=>"The path to the group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/?Action=CreateInstanceProfile"=>{"get"=>{"summary"=>"Create Instance Profile", "description"=>"Creates a new instance profile.", "operationId"=>"createInstanceProfile", "x-api-path-slug"=>"actioncreateinstanceprofile-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceProfileName", "description"=>"The name of the instance profile to create", "type"=>"string"}, {"in"=>"query", "name"=>"Path", "description"=>"The path to the instance profile", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Profiles"]}}, "/?Action=CreateLoginProfile"=>{"get"=>{"summary"=>"Create Login Profile", "description"=>"Creates a password for the specified user, giving the user the ability to access AWS\n services through the AWS Management Console.", "operationId"=>"createLoginProfile", "x-api-path-slug"=>"actioncreateloginprofile-get", "parameters"=>[{"in"=>"query", "name"=>"Password", "description"=>"The new password for the user", "type"=>"string"}, {"in"=>"query", "name"=>"PasswordResetRequired", "description"=>"Specifies whether the user is required to set a new password on next sign-in", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the IAM user to create a password for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Login Profiles"]}}, "/?Action=CreateOpenIDConnectProvider"=>{"get"=>{"summary"=>"Create Open I D Connect Provider", "description"=>"Creates an IAM entity to describe an identity provider (IdP) that supports.", "operationId"=>"createOpenIDConnectProvider", "x-api-path-slug"=>"actioncreateopenidconnectprovider-get", "parameters"=>[{"in"=>"query", "name"=>"ClientIDList.member.N", "description"=>"A list of client IDs (also known as audiences)", "type"=>"string"}, {"in"=>"query", "name"=>"ThumbprintList.member.N", "description"=>"A list of server certificate thumbprints for the OpenID Connect (OIDC) identity providers server certificate(s)", "type"=>"string"}, {"in"=>"query", "name"=>"Url", "description"=>"The URL of the identity provider", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OpenID Connect Providers"]}}, "/?Action=CreatePolicy"=>{"get"=>{"summary"=>"Create Policy", "description"=>"Creates a new managed policy for your AWS account.", "operationId"=>"createPolicy", "x-api-path-slug"=>"actioncreatepolicy-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"A friendly description of the policy", "type"=>"string"}, {"in"=>"query", "name"=>"Path", "description"=>"The path for the policy", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyDocument", "description"=>"The JSON policy document that you want to use as the content for the new policy", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyName", "description"=>"The friendly name of the policy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=CreatePolicyVersion"=>{"get"=>{"summary"=>"Create Policy Version", "description"=>"Creates a new version of the specified managed policy.", "operationId"=>"createPolicyVersion", "x-api-path-slug"=>"actioncreatepolicyversion-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyArn", "description"=>"The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyDocument", "description"=>"The JSON policy document that you want to use as the content for this new version of the policy", "type"=>"string"}, {"in"=>"query", "name"=>"SetAsDefault", "description"=>"Specifies whether to set this version as the policys default version", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=CreateRole"=>{"get"=>{"summary"=>"Create Role", "description"=>"Creates a new role for your AWS account.", "operationId"=>"createRole", "x-api-path-slug"=>"actioncreaterole-get", "parameters"=>[{"in"=>"query", "name"=>"AssumeRolePolicyDocument", "description"=>"The trust relationship policy document that grants an entity permission to assume the role", "type"=>"string"}, {"in"=>"query", "name"=>"Path", "description"=>"The path to the role", "type"=>"string"}, {"in"=>"query", "name"=>"RoleName", "description"=>"The name of the role to create", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles"]}}, "/?Action=CreateSAMLProvider"=>{"get"=>{"summary"=>"Create S A M L Provider", "description"=>"Creates an IAM resource that describes an identity provider (IdP) that supports SAML\n 2.", "operationId"=>"createSAMLProvider", "x-api-path-slug"=>"actioncreatesamlprovider-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"The name of the provider to create", "type"=>"string"}, {"in"=>"query", "name"=>"SAMLMetadataDocument", "description"=>"An XML document generated by an identity provider (IdP) that supports SAML 2", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SAML Providers"]}}, "/?Action=CreateServiceSpecificCredential"=>{"get"=>{"summary"=>"Create Service Specific Credential", "description"=>"Generates a set of credentials consisting of a user name and password that can be used\n to access the service specified in the request.", "operationId"=>"createServiceSpecificCredential", "x-api-path-slug"=>"actioncreateservicespecificcredential-get", "parameters"=>[{"in"=>"query", "name"=>"ServiceName", "description"=>"The name of the AWS service that is to be associated with the credentials", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the IAM user that is to be associated with the credentials", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Specific Credentials"]}}, "/?Action=CreateUser"=>{"get"=>{"summary"=>"Create User", "description"=>"Creates a new IAM user for your AWS account.", "operationId"=>"createUser", "x-api-path-slug"=>"actioncreateuser-get", "parameters"=>[{"in"=>"query", "name"=>"Path", "description"=>"The path for the user name", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user to create", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=CreateVirtualMFADevice"=>{"get"=>{"summary"=>"Create Virtual M F A Device", "description"=>"Creates a new virtual MFA device for the AWS account.", "operationId"=>"createVirtualMFADevice", "x-api-path-slug"=>"actioncreatevirtualmfadevice-get", "parameters"=>[{"in"=>"query", "name"=>"Path", "description"=>"The path for the virtual MFA device", "type"=>"string"}, {"in"=>"query", "name"=>"VirtualMFADeviceName", "description"=>"The name of the virtual MFA device", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual MFA Device"]}}, "/?Action=DeactivateMFADevice"=>{"get"=>{"summary"=>"Deactivate M F A Device", "description"=>"Deactivates the specified MFA device and removes it from association with the user name\n for which it was originally enabled.", "operationId"=>"deactivateMFADevice", "x-api-path-slug"=>"actiondeactivatemfadevice-get", "parameters"=>[{"in"=>"query", "name"=>"SerialNumber", "description"=>"The serial number that uniquely identifies the MFA device", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user whose MFA device you want to deactivate", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual MFA Device"]}}, "/?Action=DeleteAccessKey"=>{"get"=>{"summary"=>"Delete Access Key", "description"=>"Deletes the access key pair associated with the specified IAM user.", "operationId"=>"deleteAccessKey", "x-api-path-slug"=>"actiondeleteaccesskey-get", "parameters"=>[{"in"=>"query", "name"=>"AccessKeyId", "description"=>"The access key ID for the access key ID and secret access key you want to delete", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user whose access key pair you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Access Keys"]}}, "/?Action=DeleteAccountAlias"=>{"get"=>{"summary"=>"Delete Account Alias", "description"=>"Deletes the specified AWS account alias.", "operationId"=>"deleteAccountAlias", "x-api-path-slug"=>"actiondeleteaccountalias-get", "parameters"=>[{"in"=>"query", "name"=>"AccountAlias", "description"=>"The name of the account alias to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account Alias"]}}, "/?Action=DeleteAccountPasswordPolicy"=>{"get"=>{"summary"=>"Delete Account Password Policy", "description"=>"Deletes the password policy for the AWS account.", "operationId"=>"deleteAccountPasswordPolicy", "x-api-path-slug"=>"actiondeleteaccountpasswordpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"LimitExceeded", "description"=>"The request was rejected because it attempted to create resources beyond the current AWS account limits", "type"=>"string"}, {"in"=>"query", "name"=>"NoSuchEntity", "description"=>"The request was rejected because it referenced an entity that does not exist", "type"=>"string"}, {"in"=>"query", "name"=>"ServiceFailure", "description"=>"The request processing has failed because of an unknown error, exception or failure", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account Password Policies"]}}, "/?Action=DeleteGroup"=>{"get"=>{"summary"=>"Delete Group", "description"=>"Deletes the specified IAM group.", "operationId"=>"deleteGroup", "x-api-path-slug"=>"actiondeletegroup-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The name of the IAM group to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/?Action=DeleteGroupPolicy"=>{"get"=>{"summary"=>"Delete Group Policy", "description"=>"Deletes the specified inline policy that is embedded in the specified IAM\n group.", "operationId"=>"deleteGroupPolicy", "x-api-path-slug"=>"actiondeletegrouppolicy-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The name (friendly name, not ARN) identifying the group that the policy is embedded in", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyName", "description"=>"The name identifying the policy document to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group Policies"]}}, "/?Action=DeleteInstanceProfile"=>{"get"=>{"summary"=>"Delete Instance Profile", "description"=>"Deletes the specified instance profile.", "operationId"=>"deleteInstanceProfile", "x-api-path-slug"=>"actiondeleteinstanceprofile-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceProfileName", "description"=>"The name of the instance profile to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Profiles"]}}, "/?Action=DeleteLoginProfile"=>{"get"=>{"summary"=>"Delete Login Profile", "description"=>"Deletes the password for the specified IAM user, which terminates the user's ability\n to access AWS services through the AWS Management Console.", "operationId"=>"deleteLoginProfile", "x-api-path-slug"=>"actiondeleteloginprofile-get", "parameters"=>[{"in"=>"query", "name"=>"UserName", "description"=>"The name of the user whose password you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Login Profiles"]}}, "/?Action=DeleteOpenIDConnectProvider"=>{"get"=>{"summary"=>"Delete Open I D Connect Provider", "description"=>"Deletes an OpenID Connect identity provider (IdP) resource object in IAM.", "operationId"=>"deleteOpenIDConnectProvider", "x-api-path-slug"=>"actiondeleteopenidconnectprovider-get", "parameters"=>[{"in"=>"query", "name"=>"OpenIDConnectProviderArn", "description"=>"The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource object to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OpenID Connect Providers"]}}, "/?Action=DeletePolicy"=>{"get"=>{"summary"=>"Delete Policy", "description"=>"Deletes the specified managed policy.", "operationId"=>"deletePolicy", "x-api-path-slug"=>"actiondeletepolicy-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyArn", "description"=>"The Amazon Resource Name (ARN) of the IAM policy you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=DeletePolicyVersion"=>{"get"=>{"summary"=>"Delete Policy Version", "description"=>"Deletes the specified version from the specified managed policy.", "operationId"=>"deletePolicyVersion", "x-api-path-slug"=>"actiondeletepolicyversion-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyArn", "description"=>"The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a version", "type"=>"string"}, {"in"=>"query", "name"=>"VersionId", "description"=>"The policy version to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=DeleteRole"=>{"get"=>{"summary"=>"Delete Role", "description"=>"Deletes the specified role.", "operationId"=>"deleteRole", "x-api-path-slug"=>"actiondeleterole-get", "parameters"=>[{"in"=>"query", "name"=>"RoleName", "description"=>"The name of the role to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles"]}}, "/?Action=DeleteRolePolicy"=>{"get"=>{"summary"=>"Delete Role Policy", "description"=>"Deletes the specified inline policy that is embedded in the specified IAM\n role.", "operationId"=>"deleteRolePolicy", "x-api-path-slug"=>"actiondeleterolepolicy-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyName", "description"=>"The name of the inline policy to delete from the specified IAM role", "type"=>"string"}, {"in"=>"query", "name"=>"RoleName", "description"=>"The name (friendly name, not ARN) identifying the role that the policy is embedded in", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Role Policies"]}}, "/?Action=DeleteSAMLProvider"=>{"get"=>{"summary"=>"Delete S A M L Provider", "description"=>"Deletes a SAML provider resource in IAM.", "operationId"=>"deleteSAMLProvider", "x-api-path-slug"=>"actiondeletesamlprovider-get", "parameters"=>[{"in"=>"query", "name"=>"SAMLProviderArn", "description"=>"The Amazon Resource Name (ARN) of the SAML provider to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SAML Providers"]}}, "/?Action=DeleteServerCertificate"=>{"get"=>{"summary"=>"Delete Server Certificate", "description"=>"Deletes the specified server certificate.", "operationId"=>"deleteServerCertificate", "x-api-path-slug"=>"actiondeleteservercertificate-get", "parameters"=>[{"in"=>"query", "name"=>"ServerCertificateName", "description"=>"The name of the server certificate you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Certificates"]}}, "/?Action=DeleteServiceSpecificCredential"=>{"get"=>{"summary"=>"Delete Service Specific Credential", "description"=>"Deletes the specified service-specific credential.", "operationId"=>"deleteServiceSpecificCredential", "x-api-path-slug"=>"actiondeleteservicespecificcredential-get", "parameters"=>[{"in"=>"query", "name"=>"ServiceSpecificCredentialId", "description"=>"The unique identifier of the service-specific credential", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the IAM user associated with the service-specific credential", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Specific Credentials"]}}, "/?Action=DeleteSigningCertificate"=>{"get"=>{"summary"=>"Delete Signing Certificate", "description"=>"Deletes a signing certificate associated with the specified IAM user.", "operationId"=>"deleteSigningCertificate", "x-api-path-slug"=>"actiondeletesigningcertificate-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateId", "description"=>"The ID of the signing certificate to delete", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user the signing certificate belongs to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signing Certificates"]}}, "/?Action=DeleteSSHPublicKey"=>{"get"=>{"summary"=>"Delete S S H Public Key", "description"=>"Deletes the specified SSH public key.", "operationId"=>"deleteSSHPublicKey", "x-api-path-slug"=>"actiondeletesshpublickey-get", "parameters"=>[{"in"=>"query", "name"=>"SSHPublicKeyId", "description"=>"The unique identifier for the SSH public key", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the IAM user associated with the SSH public key", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SSH Public Key"]}}, "/?Action=DeleteUser"=>{"get"=>{"summary"=>"Delete User", "description"=>"Deletes the specified IAM user.", "operationId"=>"deleteUser", "x-api-path-slug"=>"actiondeleteuser-get", "parameters"=>[{"in"=>"query", "name"=>"UserName", "description"=>"The name of the user to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=DeleteUserPolicy"=>{"get"=>{"summary"=>"Delete User Policy", "description"=>"Deletes the specified inline policy that is embedded in the specified IAM\n user.", "operationId"=>"deleteUserPolicy", "x-api-path-slug"=>"actiondeleteuserpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyName", "description"=>"The name identifying the policy document to delete", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name (friendly name, not ARN) identifying the user that the policy is embedded in", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Policies"]}}, "/?Action=DeleteVirtualMFADevice"=>{"get"=>{"summary"=>"Delete Virtual M F A Device", "description"=>"Deletes a virtual MFA device.", "operationId"=>"deleteVirtualMFADevice", "x-api-path-slug"=>"actiondeletevirtualmfadevice-get", "parameters"=>[{"in"=>"query", "name"=>"SerialNumber", "description"=>"The serial number that uniquely identifies the MFA device", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual MFA Devices"]}}, "/?Action=DetachGroupPolicy"=>{"get"=>{"summary"=>"Detach Group Policy", "description"=>"Removes the specified managed policy from the specified IAM group.", "operationId"=>"detachGroupPolicy", "x-api-path-slug"=>"actiondetachgrouppolicy-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The name (friendly name, not ARN) of the IAM group to detach the policy from", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyArn", "description"=>"The Amazon Resource Name (ARN) of the IAM policy you want to detach", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group Policies"]}}, "/?Action=DetachRolePolicy"=>{"get"=>{"summary"=>"Detach Role Policy", "description"=>"Removes the specified managed policy from the specified role.", "operationId"=>"detachRolePolicy", "x-api-path-slug"=>"actiondetachrolepolicy-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyArn", "description"=>"The Amazon Resource Name (ARN) of the IAM policy you want to detach", "type"=>"string"}, {"in"=>"query", "name"=>"RoleName", "description"=>"The name (friendly name, not ARN) of the IAM role to detach the policy from", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Role Policies"]}}, "/?Action=DetachUserPolicy"=>{"get"=>{"summary"=>"Detach User Policy", "description"=>"Removes the specified managed policy from the specified user.", "operationId"=>"detachUserPolicy", "x-api-path-slug"=>"actiondetachuserpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyArn", "description"=>"The Amazon Resource Name (ARN) of the IAM policy you want to detach", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name (friendly name, not ARN) of the IAM user to detach the policy from", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Policies"]}}, "/?Action=EnableMFADevice"=>{"get"=>{"summary"=>"Enable M F A Device", "description"=>"Enables the specified MFA device and associates it with the specified IAM user.", "operationId"=>"enableMFADevice", "x-api-path-slug"=>"actionenablemfadevice-get", "parameters"=>[{"in"=>"query", "name"=>"AuthenticationCode1", "description"=>"An authentication code emitted by the device", "type"=>"string"}, {"in"=>"query", "name"=>"AuthenticationCode2", "description"=>"A subsequent authentication code emitted by the device", "type"=>"string"}, {"in"=>"query", "name"=>"SerialNumber", "description"=>"The serial number that uniquely identifies the MFA device", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the IAM user for whom you want to enable the MFA device", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MFA Devices"]}}, "/?Action=GenerateCredentialReport"=>{"get"=>{"summary"=>"Generate Credential Report", "description"=>"Generates a credential report for the AWS account.", "operationId"=>"generateCredentialReport", "x-api-path-slug"=>"actiongeneratecredentialreport-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"Information about the credential report", "type"=>"string"}, {"in"=>"query", "name"=>"State", "description"=>"Information about the state of the credential report", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Credential Reports"]}}, "/?Action=GetAccessKeyLastUsed"=>{"get"=>{"summary"=>"Get Access Key Last Used", "description"=>"Retrieves information about when the specified access key was last used.", "operationId"=>"getAccessKeyLastUsed", "x-api-path-slug"=>"actiongetaccesskeylastused-get", "parameters"=>[{"in"=>"query", "name"=>"AccessKeyId", "description"=>"The identifier of an access key", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Access Keys"]}}, "/?Action=GetAccountAuthorizationDetails"=>{"get"=>{"summary"=>"Get Account Authorization Details", "description"=>"Retrieves information about all IAM users, groups, roles, and policies in your AWS\n account, including their relationships to one another.", "operationId"=>"getAccountAuthorizationDetails", "x-api-path-slug"=>"actiongetaccountauthorizationdetails-get", "parameters"=>[{"in"=>"query", "name"=>"Filter.member.N", "description"=>"A list of entity types used to filter the results", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/?Action=GetAccountPasswordPolicy"=>{"get"=>{"summary"=>"Get Account Password Policy", "description"=>"Retrieves the password policy for the AWS account.", "operationId"=>"getAccountPasswordPolicy", "x-api-path-slug"=>"actiongetaccountpasswordpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"PasswordPolicy", "description"=>"Contains information about the account password policy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/?Action=GetAccountSummary"=>{"get"=>{"summary"=>"Get Account Summary", "description"=>"Retrieves information about IAM entity usage and IAM quotas in the AWS\n account.", "operationId"=>"getAccountSummary", "x-api-path-slug"=>"actiongetaccountsummary-get", "parameters"=>[{"in"=>"query", "name"=>"SummaryMap\n , SummaryMap.entry.N.key (key), SummaryMapentry.N.value (value)", "description"=>"A set of key value pairs containing information about IAM entity usage and IAM quotas", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/?Action=GetContextKeysForCustomPolicy"=>{"get"=>{"summary"=>"Get Context Keys For Custom Policy", "description"=>"Gets a list of all of the context keys referenced in the input policies.", "operationId"=>"getContextKeysForCustomPolicy", "x-api-path-slug"=>"actiongetcontextkeysforcustompolicy-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyInputList.member.N", "description"=>"A list of policies for which you want the list of context keys referenced in those policies", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Context Keys For Custom Policies"]}}, "/?Action=GetContextKeysForPrincipalPolicy"=>{"get"=>{"summary"=>"Get Context Keys For Principal Policy", "description"=>"Gets a list of all of the context keys referenced in all of the IAM policies attached\n to the specified IAM entity.", "operationId"=>"getContextKeysForPrincipalPolicy", "x-api-path-slug"=>"actiongetcontextkeysforprincipalpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyInputList.member.N", "description"=>"An optional list of additional policies for which you want the list of context keys that are referenced", "type"=>"string"}, {"in"=>"query", "name"=>"PolicySourceArn", "description"=>"The ARN of a user, group, or role whose policies contain the context keys that you want listed", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Context Keys For Principal Policies"]}}, "/?Action=GetCredentialReport"=>{"get"=>{"summary"=>"Get Credential Report", "description"=>"Retrieves a credential report for the AWS account.", "operationId"=>"getCredentialReport", "x-api-path-slug"=>"actiongetcredentialreport-get", "parameters"=>[{"in"=>"query", "name"=>"Content", "description"=>"Contains the credential report", "type"=>"string"}, {"in"=>"query", "name"=>"GeneratedTime", "description"=>"The date and time when the credential report was created, in ISO 8601 date-time format", "type"=>"string"}, {"in"=>"query", "name"=>"ReportFormat", "description"=>"The format (MIME type) of the credential report", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Credential Reports"]}}, "/?Action=GetGroup"=>{"get"=>{"summary"=>"Get Group", "description"=>"Returns a list of IAM users that are in the specified IAM group.", "operationId"=>"getGroup", "x-api-path-slug"=>"actiongetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/?Action=GetGroupPolicy"=>{"get"=>{"summary"=>"Get Group Policy", "description"=>"Retrieves the specified inline policy document that is embedded in the specified IAM\n group.", "operationId"=>"getGroupPolicy", "x-api-path-slug"=>"actiongetgrouppolicy-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The name of the group the policy is associated with", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyName", "description"=>"The name of the policy document to get", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group Policies"]}}, "/?Action=GetInstanceProfile"=>{"get"=>{"summary"=>"Get Instance Profile", "description"=>"Retrieves information about the specified instance profile, including the instance\n profile's path, GUID, ARN, and role.", "operationId"=>"getInstanceProfile", "x-api-path-slug"=>"actiongetinstanceprofile-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceProfileName", "description"=>"The name of the instance profile to get information about", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Profiles"]}}, "/?Action=GetLoginProfile"=>{"get"=>{"summary"=>"Get Login Profile", "description"=>"Retrieves the user name and password-creation date for the specified IAM user.", "operationId"=>"getLoginProfile", "x-api-path-slug"=>"actiongetloginprofile-get", "parameters"=>[{"in"=>"query", "name"=>"UserName", "description"=>"The name of the user whose login profile you want to retrieve", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Login Profiles"]}}, "/?Action=GetOpenIDConnectProvider"=>{"get"=>{"summary"=>"Get Open I D Connect Provider", "description"=>"Returns information about the specified OpenID Connect (OIDC) provider resource object\n in IAM.", "operationId"=>"getOpenIDConnectProvider", "x-api-path-slug"=>"actiongetopenidconnectprovider-get", "parameters"=>[{"in"=>"query", "name"=>"OpenIDConnectProviderArn", "description"=>"The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to get information for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OpenID Connect Providers"]}}, "/?Action=GetPolicy"=>{"get"=>{"summary"=>"Get Policy", "description"=>"Retrieves information about the specified managed policy, including the policy's\n default version and the total number of IAM users, groups, and roles to which the policy is\n attached.", "operationId"=>"getPolicy", "x-api-path-slug"=>"actiongetpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyArn", "description"=>"The Amazon Resource Name (ARN) of the managed policy that you want information about", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=GetPolicyVersion"=>{"get"=>{"summary"=>"Get Policy Version", "description"=>"Retrieves information about the specified version of the specified managed policy,\n including the policy document.", "operationId"=>"getPolicyVersion", "x-api-path-slug"=>"actiongetpolicyversion-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyArn", "description"=>"The Amazon Resource Name (ARN) of the managed policy that you want information about", "type"=>"string"}, {"in"=>"query", "name"=>"VersionId", "description"=>"Identifies the policy version to retrieve", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=GetRole"=>{"get"=>{"summary"=>"Get Role", "description"=>"Retrieves information about the specified role, including the role's path, GUID, ARN,\n and the role's trust policy that grants permission to assume the role.", "operationId"=>"getRole", "x-api-path-slug"=>"actiongetrole-get", "parameters"=>[{"in"=>"query", "name"=>"RoleName", "description"=>"The name of the IAM role to get information about", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles"]}}, "/?Action=GetRolePolicy"=>{"get"=>{"summary"=>"Get Role Policy", "description"=>"Retrieves the specified inline policy document that is embedded with the specified\n IAM role.", "operationId"=>"getRolePolicy", "x-api-path-slug"=>"actiongetrolepolicy-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyName", "description"=>"The name of the policy document to get", "type"=>"string"}, {"in"=>"query", "name"=>"RoleName", "description"=>"The name of the role associated with the policy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Role Policies"]}}, "/?Action=GetSAMLProvider"=>{"get"=>{"summary"=>"Get S A M L Provider", "description"=>"Returns the SAML provider metadocument that was uploaded when the IAM SAML provider\n resource object was created or updated.", "operationId"=>"getSAMLProvider", "x-api-path-slug"=>"actiongetsamlprovider-get", "parameters"=>[{"in"=>"query", "name"=>"SAMLProviderArn", "description"=>"The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SAML Providers"]}}, "/?Action=GetServerCertificate"=>{"get"=>{"summary"=>"Get Server Certificate", "description"=>"Retrieves information about the specified server certificate stored in IAM.", "operationId"=>"getServerCertificate", "x-api-path-slug"=>"actiongetservercertificate-get", "parameters"=>[{"in"=>"query", "name"=>"ServerCertificateName", "description"=>"The name of the server certificate you want to retrieve information about", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Certificates"]}}, "/?Action=GetSSHPublicKey"=>{"get"=>{"summary"=>"Get S S H Public Key", "description"=>"Retrieves the specified SSH public key, including metadata about the key.", "operationId"=>"getSSHPublicKey", "x-api-path-slug"=>"actiongetsshpublickey-get", "parameters"=>[{"in"=>"query", "name"=>"Encoding", "description"=>"Specifies the public key encoding format to use in the response", "type"=>"string"}, {"in"=>"query", "name"=>"SSHPublicKeyId", "description"=>"The unique identifier for the SSH public key", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the IAM user associated with the SSH public key", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SSH Public Key"]}}, "/?Action=GetUser"=>{"get"=>{"summary"=>"Get User", "description"=>"Retrieves information about the specified IAM user, including the user's creation\n date, path, unique ID, and ARN.", "operationId"=>"getUser", "x-api-path-slug"=>"actiongetuser-get", "parameters"=>[{"in"=>"query", "name"=>"UserName", "description"=>"The name of the user to get information about", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=GetUserPolicy"=>{"get"=>{"summary"=>"Get User Policy", "description"=>"Retrieves the specified inline policy document that is embedded in the specified IAM\n user.", "operationId"=>"getUserPolicy", "x-api-path-slug"=>"actiongetuserpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyName", "description"=>"The name of the policy document to get", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user who the policy is associated with", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Policies"]}}, "/?Action=ListAccessKeys"=>{"get"=>{"summary"=>"List Access Keys", "description"=>"Returns information about the access key IDs associated with the specified IAM user.", "operationId"=>"listAccessKeys", "x-api-path-slug"=>"actionlistaccesskeys-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Access Keys"]}}, "/?Action=ListAccountAliases"=>{"get"=>{"summary"=>"List Account Aliases", "description"=>"Lists the account alias associated with the AWS account (Note: you can have only\n one).", "operationId"=>"listAccountAliases", "x-api-path-slug"=>"actionlistaccountaliases-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account Aliases"]}}, "/?Action=ListAttachedGroupPolicies"=>{"get"=>{"summary"=>"List Attached Group Policies", "description"=>"Lists all managed policies that are attached to the specified IAM group.", "operationId"=>"listAttachedGroupPolicies", "x-api-path-slug"=>"actionlistattachedgrouppolicies-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The name (friendly name, not ARN) of the group to list attached policies for", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"PathPrefix", "description"=>"The path prefix for filtering the results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attached Group Policies"]}}, "/?Action=ListAttachedRolePolicies"=>{"get"=>{"summary"=>"List Attached Role Policies", "description"=>"Lists all managed policies that are attached to the specified IAM role.", "operationId"=>"listAttachedRolePolicies", "x-api-path-slug"=>"actionlistattachedrolepolicies-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"PathPrefix", "description"=>"The path prefix for filtering the results", "type"=>"string"}, {"in"=>"query", "name"=>"RoleName", "description"=>"The name (friendly name, not ARN) of the role to list attached policies for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attached Role Policies"]}}, "/?Action=ListAttachedUserPolicies"=>{"get"=>{"summary"=>"List Attached User Policies", "description"=>"Lists all managed policies that are attached to the specified IAM user.", "operationId"=>"listAttachedUserPolicies", "x-api-path-slug"=>"actionlistattacheduserpolicies-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"PathPrefix", "description"=>"The path prefix for filtering the results", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name (friendly name, not ARN) of the user to list attached policies for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attached Use rPolicies"]}}, "/?Action=ListEntitiesForPolicy"=>{"get"=>{"summary"=>"List Entities For Policy", "description"=>"Lists all IAM users, groups, and roles that the specified managed policy is attached\n to.", "operationId"=>"listEntitiesForPolicy", "x-api-path-slug"=>"actionlistentitiesforpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"EntityFilter", "description"=>"The entity type to use for filtering the results", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"PathPrefix", "description"=>"The path prefix for filtering the results", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyArn", "description"=>"The Amazon Resource Name (ARN) of the IAM policy for which you want the versions", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entities For Policies"]}}, "/?Action=ListGroupPolicies"=>{"get"=>{"summary"=>"List Group Policies", "description"=>"Lists the names of the inline policies that are embedded in the specified IAM\n group.", "operationId"=>"listGroupPolicies", "x-api-path-slug"=>"actionlistgrouppolicies-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The name of the group to list policies for", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group Policies"]}}, "/?Action=ListGroups"=>{"get"=>{"summary"=>"List Groups", "description"=>"Lists the IAM groups that have the specified path prefix.", "operationId"=>"listGroups", "x-api-path-slug"=>"actionlistgroups-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"PathPrefix", "description"=>"The path prefix for filtering the results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/?Action=ListGroupsForUser"=>{"get"=>{"summary"=>"List Groups For User", "description"=>"Lists the IAM groups that the specified IAM user belongs to.", "operationId"=>"listGroupsForUser", "x-api-path-slug"=>"actionlistgroupsforuser-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user to list groups for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups For User"]}}, "/?Action=ListInstanceProfiles"=>{"get"=>{"summary"=>"List Instance Profiles", "description"=>"Lists the instance profiles that have the specified path prefix.", "operationId"=>"listInstanceProfiles", "x-api-path-slug"=>"actionlistinstanceprofiles-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"PathPrefix", "description"=>"The path prefix for filtering the results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Profiles"]}}, "/?Action=ListInstanceProfilesForRole"=>{"get"=>{"summary"=>"List Instance Profiles For Role", "description"=>"Lists the instance profiles that have the specified associated IAM role.", "operationId"=>"listInstanceProfilesForRole", "x-api-path-slug"=>"actionlistinstanceprofilesforrole-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"RoleName", "description"=>"The name of the role to list instance profiles for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Profiles For Role"]}}, "/?Action=ListMFADevices"=>{"get"=>{"summary"=>"List M F A Devices", "description"=>"Lists the MFA devices for an IAM user.", "operationId"=>"listMFADevices", "x-api-path-slug"=>"actionlistmfadevices-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user whose MFA devices you want to list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MFA Devices"]}}, "/?Action=ListOpenIDConnectProviders"=>{"get"=>{"summary"=>"List Open I D Connect Providers", "description"=>"Lists information about the IAM OpenID Connect (OIDC) provider resource objects\n defined in the AWS account.", "operationId"=>"listOpenIDConnectProviders", "x-api-path-slug"=>"actionlistopenidconnectproviders-get", "parameters"=>[{"in"=>"query", "name"=>"OpenIDConnectProviderList.member.N", "description"=>"The list of IAM OIDC provider resource objects defined in the AWS account", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OpenID Connect Providers"]}}, "/?Action=ListPolicies"=>{"get"=>{"summary"=>"List Policies", "description"=>"Lists all the managed policies that are available in your AWS account, including your\n own customer-defined managed policies and all AWS managed policies.", "operationId"=>"listPolicies", "x-api-path-slug"=>"actionlistpolicies-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"OnlyAttached", "description"=>"A flag to filter the results to only the attached policies", "type"=>"string"}, {"in"=>"query", "name"=>"PathPrefix", "description"=>"The path prefix for filtering the results", "type"=>"string"}, {"in"=>"query", "name"=>"Scope", "description"=>"The scope to use for filtering the results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["listPolicies"]}}, "/?Action=ListPolicyVersions"=>{"get"=>{"summary"=>"List Policy Versions", "description"=>"Lists information about the versions of the specified managed policy, including the\n version that is currently set as the policy's default version.", "operationId"=>"listPolicyVersions", "x-api-path-slug"=>"actionlistpolicyversions-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyArn", "description"=>"The Amazon Resource Name (ARN) of the IAM policy for which you want the versions", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Versions"]}}, "/?Action=ListRolePolicies"=>{"get"=>{"summary"=>"List Role Policies", "description"=>"Lists the names of the inline policies that are embedded in the specified IAM\n role.", "operationId"=>"listRolePolicies", "x-api-path-slug"=>"actionlistrolepolicies-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"RoleName", "description"=>"The name of the role to list policies for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Role Policies"]}}, "/?Action=ListRoles"=>{"get"=>{"summary"=>"List Roles", "description"=>"Lists the IAM roles that have the specified path prefix.", "operationId"=>"listRoles", "x-api-path-slug"=>"actionlistroles-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"PathPrefix", "description"=>"The path prefix for filtering the results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles"]}}, "/?Action=ListSAMLProviders"=>{"get"=>{"summary"=>"List S A M L Providers", "description"=>"Lists the SAML provider resource objects defined in IAM in the account.", "operationId"=>"listSAMLProviders", "x-api-path-slug"=>"actionlistsamlproviders-get", "parameters"=>[{"in"=>"query", "name"=>"SAMLProviderList.member.N", "description"=>"The list of SAML provider resource objects defined in IAM for this AWS account", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SAML Providers"]}}, "/?Action=ListServerCertificates"=>{"get"=>{"summary"=>"List Server Certificates", "description"=>"Lists the server certificates stored in IAM that have the specified path prefix.", "operationId"=>"listServerCertificates", "x-api-path-slug"=>"actionlistservercertificates-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"PathPrefix", "description"=>"The path prefix for filtering the results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Serve rCertificates"]}}, "/?Action=ListServiceSpecificCredentials"=>{"get"=>{"summary"=>"List Service Specific Credentials", "description"=>"Returns information about the service-specific credentials associated with the\n specified IAM user.", "operationId"=>"listServiceSpecificCredentials", "x-api-path-slug"=>"actionlistservicespecificcredentials-get", "parameters"=>[{"in"=>"query", "name"=>"ServiceName", "description"=>"Filters the returned results to only those for the specified AWS service", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user whose service-specific credentials you want information about", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Specific Credentials"]}}, "/?Action=ListSigningCertificates"=>{"get"=>{"summary"=>"List Signing Certificates", "description"=>"Returns information about the signing certificates associated with the specified IAM\n user.", "operationId"=>"listSigningCertificates", "x-api-path-slug"=>"actionlistsigningcertificates-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the IAM user whose signing certificates you want to examine", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signing Certificates"]}}, "/?Action=ListSSHPublicKeys"=>{"get"=>{"summary"=>"List S S H Public Keys", "description"=>"Returns information about the SSH public keys associated with the specified IAM user.", "operationId"=>"listSSHPublicKeys", "x-api-path-slug"=>"actionlistsshpublickeys-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the IAM user to list SSH public keys for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SSH Public Keys"]}}, "/?Action=ListUserPolicies"=>{"get"=>{"summary"=>"List User Policies", "description"=>"Lists the names of the inline policies embedded in the specified IAM user.", "operationId"=>"listUserPolicies", "x-api-path-slug"=>"actionlistuserpolicies-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user to list policies for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Policies"]}}, "/?Action=ListUsers"=>{"get"=>{"summary"=>"List Users", "description"=>"Lists the IAM users that have the specified path prefix.", "operationId"=>"listUsers", "x-api-path-slug"=>"actionlistusers-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"PathPrefix", "description"=>"The path prefix for filtering the results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=ListVirtualMFADevices"=>{"get"=>{"summary"=>"List Virtual M F A Devices", "description"=>"Lists the virtual MFA devices defined in the AWS account by assignment status.", "operationId"=>"listVirtualMFADevices", "x-api-path-slug"=>"actionlistvirtualmfadevices-get", "parameters"=>[{"in"=>"query", "name"=>"AssignmentStatus", "description"=>"The status (Unassigned or Assigned) of the devices to list", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual MFA Devices"]}}, "/?Action=PutGroupPolicy"=>{"get"=>{"summary"=>"Put Group Policy", "description"=>"Adds or updates an inline policy document that is embedded in the specified IAM\n group.", "operationId"=>"putGroupPolicy", "x-api-path-slug"=>"actionputgrouppolicy-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The name of the group to associate the policy with", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyDocument", "description"=>"The policy document", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyName", "description"=>"The name of the policy document", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group Policies"]}}, "/?Action=PutRolePolicy"=>{"get"=>{"summary"=>"Put Role Policy", "description"=>"Adds or updates an inline policy document that is embedded in the specified IAM\n role.", "operationId"=>"putRolePolicy", "x-api-path-slug"=>"actionputrolepolicy-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyDocument", "description"=>"The policy document", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyName", "description"=>"The name of the policy document", "type"=>"string"}, {"in"=>"query", "name"=>"RoleName", "description"=>"The name of the role to associate the policy with", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Role Policies"]}}, "/?Action=PutUserPolicy"=>{"get"=>{"summary"=>"Put User Policy", "description"=>"Adds or updates an inline policy document that is embedded in the specified IAM\n user.", "operationId"=>"putUserPolicy", "x-api-path-slug"=>"actionputuserpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyDocument", "description"=>"The policy document", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyName", "description"=>"The name of the policy document", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user to associate the policy with", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users Policies"]}}, "/?Action=RemoveClientIDFromOpenIDConnectProvider"=>{"get"=>{"summary"=>"Remove Client I D From Open I D Connect Provider", "description"=>"Removes the specified client ID (also known as audience) from the list of client IDs\n registered for the specified IAM OpenID Connect (OIDC) provider resource object.", "operationId"=>"removeClientIDFromOpenIDConnectProvider", "x-api-path-slug"=>"actionremoveclientidfromopenidconnectprovider-get", "parameters"=>[{"in"=>"query", "name"=>"ClientID", "description"=>"The client ID (also known as audience) to remove from the IAM OIDC provider resource", "type"=>"string"}, {"in"=>"query", "name"=>"OpenIDConnectProviderArn", "description"=>"The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the client ID from", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OpenID Connect Providers"]}}, "/?Action=RemoveRoleFromInstanceProfile"=>{"get"=>{"summary"=>"Remove Role From Instance Profile", "description"=>"Removes the specified IAM role from the specified EC2 instance profile.", "operationId"=>"removeRoleFromInstanceProfile", "x-api-path-slug"=>"actionremoverolefrominstanceprofile-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceProfileName", "description"=>"The name of the instance profile to update", "type"=>"string"}, {"in"=>"query", "name"=>"RoleName", "description"=>"The name of the role to remove", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Role From Instance Profiles"]}}, "/?Action=RemoveUserFromGroup"=>{"get"=>{"summary"=>"Remove User From Group", "description"=>"Removes the specified user from the specified group.", "operationId"=>"removeUserFromGroup", "x-api-path-slug"=>"actionremoveuserfromgroup-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"The name of the group to update", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user to remove", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User From Groups"]}}, "/?Action=ResetServiceSpecificCredential"=>{"get"=>{"summary"=>"Reset Service Specific Credential", "description"=>"Resets the password for a service-specific credential.", "operationId"=>"resetServiceSpecificCredential", "x-api-path-slug"=>"actionresetservicespecificcredential-get", "parameters"=>[{"in"=>"query", "name"=>"ServiceSpecificCredentialId", "description"=>"The unique identifier of the service-specific credential", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the IAM user associated with the service-specific credential", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Specific Credentials"]}}, "/?Action=ResyncMFADevice"=>{"get"=>{"summary"=>"Resync M F A Device", "description"=>"Synchronizes the specified MFA device with its IAM resource object on the AWS\n servers.", "operationId"=>"resyncMFADevice", "x-api-path-slug"=>"actionresyncmfadevice-get", "parameters"=>[{"in"=>"query", "name"=>"AuthenticationCode1", "description"=>"An authentication code emitted by the device", "type"=>"string"}, {"in"=>"query", "name"=>"AuthenticationCode2", "description"=>"A subsequent authentication code emitted by the device", "type"=>"string"}, {"in"=>"query", "name"=>"SerialNumber", "description"=>"Serial number that uniquely identifies the MFA device", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user whose MFA device you want to resynchronize", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MFA Devices"]}}, "/?Action=SetDefaultPolicyVersion"=>{"get"=>{"summary"=>"Set Default Policy Version", "description"=>"Sets the specified version of the specified policy as the policy's default (operative)\n version.", "operationId"=>"setDefaultPolicyVersion", "x-api-path-slug"=>"actionsetdefaultpolicyversion-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyArn", "description"=>"The Amazon Resource Name (ARN) of the IAM policy whose default version you want to set", "type"=>"string"}, {"in"=>"query", "name"=>"VersionId", "description"=>"The version of the policy to set as the default (operative) version", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Default Policy Versions"]}}, "/?Action=SimulateCustomPolicy"=>{"get"=>{"summary"=>"Simulate Custom Policy", "description"=>"Simulate how a set of IAM policies and optionally a resource-based policy works with\n a list of API actions and AWS resources to determine the policies' effective permissions.", "operationId"=>"simulateCustomPolicy", "x-api-path-slug"=>"actionsimulatecustompolicy-get", "parameters"=>[{"in"=>"query", "name"=>"ActionNames.member.N", "description"=>"A list of names of API actions to evaluate in the simulation", "type"=>"string"}, {"in"=>"query", "name"=>"CallerArn", "description"=>"The ARN of the IAM user that you want to use as the simulated caller of the APIs", "type"=>"string"}, {"in"=>"query", "name"=>"ContextEntries.member.N", "description"=>"A list of context keys and corresponding values for the simulation to use", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyInputList.member.N", "description"=>"A list of policy documents to include in the simulation", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceArns.member.N", "description"=>"A list of ARNs of AWS resources to include in the simulation", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceHandlingOption", "description"=>"Specifies the type of simulation to run", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceOwner", "description"=>"An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object", "type"=>"string"}, {"in"=>"query", "name"=>"ResourcePolicy", "description"=>"A resource-based policy to include in the simulation provided as a string", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom Policies"]}}, "/?Action=SimulatePrincipalPolicy"=>{"get"=>{"summary"=>"Simulate Principal Policy", "description"=>"Simulate how a set of IAM policies attached to an IAM entity works with a list of\n API actions and AWS resources to determine the policies' effective permissions.", "operationId"=>"simulatePrincipalPolicy", "x-api-path-slug"=>"actionsimulateprincipalpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"ActionNames.member.N", "description"=>"A list of names of API actions to evaluate in the simulation", "type"=>"string"}, {"in"=>"query", "name"=>"CallerArn", "description"=>"The ARN of the IAM user that you want to specify as the simulated caller of the APIs", "type"=>"string"}, {"in"=>"query", "name"=>"ContextEntries.member.N", "description"=>"A list of context keys and corresponding values for the simulation to use", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"PolicyInputList.member.N", "description"=>"An optional list of additional policy documents to include in the simulation", "type"=>"string"}, {"in"=>"query", "name"=>"PolicySourceArn", "description"=>"The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceArns.member.N", "description"=>"A list of ARNs of AWS resources to include in the simulation", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceHandlingOption", "description"=>"Specifies the type of simulation to run", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceOwner", "description"=>"An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object", "type"=>"string"}, {"in"=>"query", "name"=>"ResourcePolicy", "description"=>"A resource-based policy to include in the simulation provided as a string", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Principal Policies"]}}, "/?Action=UpdateAccessKey"=>{"get"=>{"summary"=>"Update Access Key", "description"=>"Changes the status of the specified access key from Active to Inactive, or vice versa.", "operationId"=>"updateAccessKey", "x-api-path-slug"=>"actionupdateaccesskey-get", "parameters"=>[{"in"=>"query", "name"=>"AccessKeyId", "description"=>"The access key ID of the secret access key you want to update", "type"=>"string"}, {"in"=>"query", "name"=>"Status", "description"=>"The status you want to assign to the secret access key", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user whose key you want to update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Access Keys"]}}, "/?Action=UpdateAccountPasswordPolicy"=>{"get"=>{"summary"=>"Update Account Password Policy", "description"=>"Updates the password policy settings for the AWS account.", "operationId"=>"updateAccountPasswordPolicy", "x-api-path-slug"=>"actionupdateaccountpasswordpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"AllowUsersToChangePassword", "description"=>"Allows all IAM users in your account to use the AWS Management Console to change their own passwords", "type"=>"string"}, {"in"=>"query", "name"=>"HardExpiry", "description"=>"Prevents IAM users from setting a new password after their password has expired", "type"=>"string"}, {"in"=>"query", "name"=>"MaxPasswordAge", "description"=>"The number of days that an IAM user password is valid", "type"=>"string"}, {"in"=>"query", "name"=>"MinimumPasswordLength", "description"=>"The minimum number of characters allowed in an IAM user password", "type"=>"string"}, {"in"=>"query", "name"=>"PasswordReusePrevention", "description"=>"Specifies the number of previous passwords that IAM users are prevented from reusing", "type"=>"string"}, {"in"=>"query", "name"=>"RequireLowercaseCharacters", "description"=>"Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z)", "type"=>"string"}, {"in"=>"query", "name"=>"RequireNumbers", "description"=>"Specifies whether IAM user passwords must contain at least one numeric character (0 to 9)", "type"=>"string"}, {"in"=>"query", "name"=>"RequireSymbols", "description"=>"Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:", "type"=>"string"}, {"in"=>"query", "name"=>"RequireUppercaseCharacters", "description"=>"Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account Password Policy"]}}, "/?Action=UpdateAssumeRolePolicy"=>{"get"=>{"summary"=>"Update Assume Role Policy", "description"=>"Updates the policy that grants an IAM entity permission to assume a role.", "operationId"=>"updateAssumeRolePolicy", "x-api-path-slug"=>"actionupdateassumerolepolicy-get", "parameters"=>[{"in"=>"query", "name"=>"PolicyDocument", "description"=>"The policy that grants an entity permission to assume the role", "type"=>"string"}, {"in"=>"query", "name"=>"RoleName", "description"=>"The name of the role to update with the new policy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assume Role Policy"]}}, "/?Action=UpdateGroup"=>{"get"=>{"summary"=>"Update Group", "description"=>"Updates the name and/or the path of the specified IAM group.", "operationId"=>"updateGroup", "x-api-path-slug"=>"actionupdategroup-get", "parameters"=>[{"in"=>"query", "name"=>"GroupName", "description"=>"Name of the IAM group to update", "type"=>"string"}, {"in"=>"query", "name"=>"NewGroupName", "description"=>"New name for the IAM group", "type"=>"string"}, {"in"=>"query", "name"=>"NewPath", "description"=>"New path for the IAM group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/?Action=UpdateLoginProfile"=>{"get"=>{"summary"=>"Update Login Profile", "description"=>"Changes the password for the specified IAM user.", "operationId"=>"updateLoginProfile", "x-api-path-slug"=>"actionupdateloginprofile-get", "parameters"=>[{"in"=>"query", "name"=>"Password", "description"=>"The new password for the specified IAM user", "type"=>"string"}, {"in"=>"query", "name"=>"PasswordResetRequired", "description"=>"Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user whose password you want to update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Login Profiles"]}}, "/?Action=UpdateOpenIDConnectProviderThumbprint"=>{"get"=>{"summary"=>"Update Open I D Connect Provider Thumbprint", "description"=>"Replaces the existing list of server certificate thumbprints associated with an OpenID\n Connect (OIDC) provider resource object with a new list of thumbprints.", "operationId"=>"updateOpenIDConnectProviderThumbprint", "x-api-path-slug"=>"actionupdateopenidconnectproviderthumbprint-get", "parameters"=>[{"in"=>"query", "name"=>"OpenIDConnectProviderArn", "description"=>"The Amazon Resource Name (ARN) of the IAM OIDC provider resource object for which you want to update the thumbprint", "type"=>"string"}, {"in"=>"query", "name"=>"ThumbprintList.member.N", "description"=>"A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OpenID Connect Providers"]}}, "/?Action=UpdateSAMLProvider"=>{"get"=>{"summary"=>"Update S A M L Provider", "description"=>"Updates the metadata document for an existing SAML provider resource object.", "operationId"=>"updateSAMLProvider", "x-api-path-slug"=>"actionupdatesamlprovider-get", "parameters"=>[{"in"=>"query", "name"=>"SAMLMetadataDocument", "description"=>"An XML document generated by an identity provider (IdP) that supports SAML 2", "type"=>"string"}, {"in"=>"query", "name"=>"SAMLProviderArn", "description"=>"The Amazon Resource Name (ARN) of the SAML provider to update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SAML Provider"]}}, "/?Action=UpdateServerCertificate"=>{"get"=>{"summary"=>"Update Server Certificate", "description"=>"Updates the name and/or the path of the specified server certificate stored in\n IAM.", "operationId"=>"updateServerCertificate", "x-api-path-slug"=>"actionupdateservercertificate-get", "parameters"=>[{"in"=>"query", "name"=>"NewPath", "description"=>"The new path for the server certificate", "type"=>"string"}, {"in"=>"query", "name"=>"NewServerCertificateName", "description"=>"The new name for the server certificate", "type"=>"string"}, {"in"=>"query", "name"=>"ServerCertificateName", "description"=>"The name of the server certificate that you want to update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Certificates"]}}, "/?Action=UpdateServiceSpecificCredential"=>{"get"=>{"summary"=>"Update Service Specific Credential", "description"=>"Sets the status of a service-specific credential to Active or\n Inactive.", "operationId"=>"updateServiceSpecificCredential", "x-api-path-slug"=>"actionupdateservicespecificcredential-get", "parameters"=>[{"in"=>"query", "name"=>"ServiceSpecificCredentialId", "description"=>"The unique identifier of the service-specific credential", "type"=>"string"}, {"in"=>"query", "name"=>"Status", "description"=>"The status to be assigned to the service-specific credential", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the IAM user associated with the service-specific credential", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Specific Credentials"]}}, "/?Action=UpdateSigningCertificate"=>{"get"=>{"summary"=>"Update Signing Certificate", "description"=>"Changes the status of the specified user signing certificate from active to disabled,\n or vice versa.", "operationId"=>"updateSigningCertificate", "x-api-path-slug"=>"actionupdatesigningcertificate-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateId", "description"=>"The ID of the signing certificate you want to update", "type"=>"string"}, {"in"=>"query", "name"=>"Status", "description"=>"The status you want to assign to the certificate", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the IAM user the signing certificate belongs to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signing Certificates"]}}, "/?Action=UpdateSSHPublicKey"=>{"get"=>{"summary"=>"Update S S H Public Key", "description"=>"Sets the status of an IAM user's SSH public key to active or inactive.", "operationId"=>"updateSSHPublicKey", "x-api-path-slug"=>"actionupdatesshpublickey-get", "parameters"=>[{"in"=>"query", "name"=>"SSHPublicKeyId", "description"=>"The unique identifier for the SSH public key", "type"=>"string"}, {"in"=>"query", "name"=>"Status", "description"=>"The status to assign to the SSH public key", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the IAM user associated with the SSH public key", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SSH Public Keys"]}}, "/?Action=UpdateUser"=>{"get"=>{"summary"=>"Update User", "description"=>"Updates the name and/or the path of the specified IAM user.", "operationId"=>"updateUser", "x-api-path-slug"=>"actionupdateuser-get", "parameters"=>[{"in"=>"query", "name"=>"NewPath", "description"=>"New path for the IAM user", "type"=>"string"}, {"in"=>"query", "name"=>"NewUserName", "description"=>"New name for the user", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"Name of the user to update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/?Action=UploadServerCertificate"=>{"get"=>{"summary"=>"Upload Server Certificate", "description"=>"Uploads a server certificate entity for the AWS account.", "operationId"=>"uploadServerCertificate", "x-api-path-slug"=>"actionuploadservercertificate-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateBody", "description"=>"The contents of the public key certificate in PEM-encoded format", "type"=>"string"}, {"in"=>"query", "name"=>"CertificateChain", "description"=>"The contents of the certificate chain", "type"=>"string"}, {"in"=>"query", "name"=>"Path", "description"=>"The path for the server certificate", "type"=>"string"}, {"in"=>"query", "name"=>"PrivateKey", "description"=>"The contents of the private key in PEM-encoded format", "type"=>"string"}, {"in"=>"query", "name"=>"ServerCertificateName", "description"=>"The name for the server certificate", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Certificates"]}}, "/?Action=UploadSigningCertificate"=>{"get"=>{"summary"=>"Upload Signing Certificate", "description"=>"Uploads an X.", "operationId"=>"uploadSigningCertificate", "x-api-path-slug"=>"actionuploadsigningcertificate-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateBody", "description"=>"The contents of the signing certificate", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the user the signing certificate is for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signing Certificates"]}}, "/?Action=UploadSSHPublicKey"=>{"get"=>{"summary"=>"Upload S S H Public Key", "description"=>"Uploads an SSH public key and associates it with the specified IAM user.", "operationId"=>"uploadSSHPublicKey", "x-api-path-slug"=>"actionuploadsshpublickey-get", "parameters"=>[{"in"=>"query", "name"=>"SSHPublicKeyBody", "description"=>"The SSH public key", "type"=>"string"}, {"in"=>"query", "name"=>"UserName", "description"=>"The name of the IAM user to associate the SSH public key with", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SSH Public Key"]}}}}, "apis"=>{"name"=>"AWS Identity and Access Management", "x-slug"=>"aws-identity-and-access-management", "description"=>"AWS Identity and Access Management (IAM) enables you to securely control access to AWS services and resources for your users. Using IAM, you can create and manage AWS users and groups, and use permissions to allow and deny their access to AWS resources.IAM is a feature of your AWS account offered at no additional charge. You will be charged only for use of other AWS services by your users.To get started using IAM, orif you have already registered with AWS, go to theAWS Management Consoleand get started with theseIAM Best Practices.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Security-Identity_AWSIAM.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Authentication,Identities,Profiles,Relative Data,Security,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-identity-and-access-management/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Identity and Access Management API", "x-api-slug"=>"aws-identity-and-access-management-api", "description"=>"AWS Identity and Access Management (IAM) enables you to securely control access to AWS services and resources for your users. Using IAM, you can create and manage AWS users and groups, and use permissions to allow and deny their access to AWS resources.IAM is a feature of your AWS account offered at no additional charge. You will be charged only for use of other AWS services by your users.To get started using IAM, orif you have already registered with AWS, go to theAWS Management Consoleand get started with theseIAM Best Practices.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Security-Identity_AWSIAM.png", "humanURL"=>"https://aws.amazon.com/iam/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Authentication,Identities,Profiles,Relative Data,Security,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-identity-and-access-management/actionuploadsshpublickey-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-identity-and-access-management/aws-identity-and-access-management-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-log", "url"=>"http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=323"}, {"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/cli/latest/reference/sts/index.html"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/IAM/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/iam/faqs/"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=76"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/iam/getting-started/"}, {"type"=>"x-partners", "url"=>"https://aws.amazon.com/iam/partners/"}, {"type"=>"x-tools", "url"=>"http://aws.amazon.com/cli"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/iam/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
gumroad{"gumroad-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Gumroad", "x-complete"=>1, "info"=>{"title"=>"Gumroad", "description"=>"api-for-selling-of-digital-goods-and-media-", "termsOfService"=>"https://gumroad.com/terms", "version"=>"v1"}, "host"=>"api.gumroad.com", "basePath"=>"/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/products"=>{"get"=>{"summary"=>"Get Products", "description"=>"Retrieve all of the existing products for the authenticated user.", "operationId"=>"getProducts", "x-api-path-slug"=>"products-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}, "post"=>{"summary"=>"Post Products", "description"=>"Create a new product for the user.", "operationId"=>"postProducts", "x-api-path-slug"=>"products-post", "parameters"=>[{"in"=>"query", "name"=>"country_available"}, {"in"=>"query", "name"=>"customizable_price"}, {"in"=>"query", "name"=>"custom_filetype"}, {"in"=>"query", "name"=>"custom_permalink"}, {"in"=>"query", "name"=>"custom_product_type"}, {"in"=>"query", "name"=>"custom_receipt"}, {"in"=>"query", "name"=>"custom_summary"}, {"in"=>"query", "name"=>"description"}, {"in"=>"query", "name"=>"max_purchase_count"}, {"in"=>"query", "name"=>"name"}, {"in"=>"query", "name"=>"preview_urlnornpreview"}, {"in"=>"query", "name"=>"price"}, {"in"=>"query", "name"=>"require_shipping"}, {"in"=>"query", "name"=>"shown_on_profile"}, {"in"=>"query", "name"=>"urlnornfile"}, {"in"=>"query", "name"=>"webhook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/products/:id"=>{"delete"=>{"summary"=>"Delete Products", "description"=>"Permanently delete a product.", "operationId"=>"deleteProducts", "x-api-path-slug"=>"productsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}, "get"=>{"summary"=>"Get Products", "description"=>"Retrieve the details of a product.", "operationId"=>"getProducts", "x-api-path-slug"=>"productsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}, "put"=>{"summary"=>"Put Products", "description"=>"Edit an existing product.", "operationId"=>"putProducts", "x-api-path-slug"=>"productsid-put", "parameters"=>[{"in"=>"query", "name"=>"countries_available"}, {"in"=>"query", "name"=>"customizable_price"}, {"in"=>"query", "name"=>"custom_filetype"}, {"in"=>"query", "name"=>"custom_permalink"}, {"in"=>"query", "name"=>"custom_product_type"}, {"in"=>"query", "name"=>"custom_receipt"}, {"in"=>"query", "name"=>"custom_summary"}, {"in"=>"query", "name"=>"description"}, {"in"=>"query", "name"=>"max_purchase_count"}, {"in"=>"query", "name"=>"name"}, {"in"=>"query", "name"=>"preview_urlnornpreview"}, {"in"=>"query", "name"=>"price"}, {"in"=>"query", "name"=>"product"}, {"in"=>"query", "name"=>"require_shipping"}, {"in"=>"query", "name"=>"shown_on_profile"}, {"in"=>"query", "name"=>"subscription_duration"}, {"in"=>"query", "name"=>"urlnornfile"}, {"in"=>"query", "name"=>"webhook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/products/:id/enable"=>{"put"=>{"summary"=>"Put Products Enable", "description"=>"Enable an existing product.", "operationId"=>"putProductsEnable", "x-api-path-slug"=>"productsidenable-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Enable"]}}, "/products/:product_id/custom_fields"=>{"get"=>{"summary"=>"Get Products Custom Fields", "description"=>"Retrieve all of the existing custom fields for a product.", "operationId"=>"getProductsProductCustomFields", "x-api-path-slug"=>"productsproduct-idcustom-fields-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Custom", "Fields"]}, "post"=>{"summary"=>"Post Products Custom Fields", "description"=>"Create a new custom field for a product.", "operationId"=>"postProductsProductCustomFields", "x-api-path-slug"=>"productsproduct-idcustom-fields-post", "parameters"=>[{"in"=>"query", "name"=>"name"}, {"in"=>"query", "name"=>"required"}, {"in"=>"query", "name"=>"variant"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Custom", "Fields"]}}, "/products/:product_id/custom_fields/:name"=>{"put"=>{"summary"=>"Put Products Custom Fields Name", "description"=>"Edit an existing products custom field.", "operationId"=>"putProductsProductCustomFieldsName", "x-api-path-slug"=>"productsproduct-idcustom-fieldsname-put", "parameters"=>[{"in"=>"query", "name"=>"required"}, {"in"=>"query", "name"=>"variant"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Custom", "Fields", ":name"]}}, "/products/:product_id/offer_codes"=>{"get"=>{"summary"=>"Get Products Offer Codes", "description"=>"Retrieve all of the existing offer codes for a product. Either amount_cents or percent_off will be returned depending if the offer code is a fixed amount off or a percentage off. A universal offer code is one that applies to all products.", "operationId"=>"getProductsProductOfferCodes", "x-api-path-slug"=>"productsproduct-idoffer-codes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Offer", "Codes"]}, "post"=>{"summary"=>"Post Products Offer Codes", "description"=>"Create a new offer code for a product. Default offer code is in cents. A universal offer code is one that applies to all products.", "operationId"=>"postProductsProductOfferCodes", "x-api-path-slug"=>"productsproduct-idoffer-codes-post", "parameters"=>[{"in"=>"query", "name"=>"amount_off"}, {"in"=>"query", "name"=>"max_purchase_count"}, {"in"=>"query", "name"=>"name"}, {"in"=>"query", "name"=>"offer_code"}, {"in"=>"query", "name"=>"offer_type"}, {"in"=>"query", "name"=>"universal"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Offer", "Codes"]}}, "/products/:product_id/offer_codes/:id"=>{"get"=>{"summary"=>"Get Products Offer Codes", "description"=>"Retrieve the details of a specific offer code of a product", "operationId"=>"getProductsProductOfferCodes", "x-api-path-slug"=>"productsproduct-idoffer-codesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Offer", "Codes"]}, "put"=>{"summary"=>"Put Products Offer Codes", "description"=>"Edit an existing products offer code.", "operationId"=>"putProductsProductOfferCodes", "x-api-path-slug"=>"productsproduct-idoffer-codesid-put", "parameters"=>[{"in"=>"query", "name"=>"max_purchase_count"}, {"in"=>"query", "name"=>"offer_code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Offer", "Codes"]}}, "/products/:product_id/variant_categories"=>{"get"=>{"summary"=>"Get Products Variant Categories", "description"=>"Retrieve all of the existing variant categories of a product.", "operationId"=>"getProductsProductVariantCategories", "x-api-path-slug"=>"productsproduct-idvariant-categories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Variant", "Categories"]}, "post"=>{"summary"=>"Post Products Variant Categories", "description"=>"Create a new variant category on a product.", "operationId"=>"postProductsProductVariantCategories", "x-api-path-slug"=>"productsproduct-idvariant-categories-post", "parameters"=>[{"in"=>"query", "name"=>"title"}, {"in"=>"query", "name"=>"variant_category"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Variant", "Categories"]}}, "/products/:product_id/variant_categories/:id"=>{"delete"=>{"summary"=>"Delete Products Variant Categories", "description"=>"Permanently delete a variant category of a product.", "operationId"=>"deleteProductsProductVariantCategories", "x-api-path-slug"=>"productsproduct-idvariant-categoriesid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Variant", "Categories"]}, "get"=>{"summary"=>"Get Products Variant Categories", "description"=>"Retrieve the details of a variant category of a product.", "operationId"=>"getProductsProductVariantCategories", "x-api-path-slug"=>"productsproduct-idvariant-categoriesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Variant", "Categories"]}, "put"=>{"summary"=>"Put Products Variant Categories", "description"=>"Edit a variant category of an existing product.", "operationId"=>"putProductsProductVariantCategories", "x-api-path-slug"=>"productsproduct-idvariant-categoriesid-put", "parameters"=>[{"in"=>"query", "name"=>"title"}, {"in"=>"query", "name"=>"variant_category"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Variant", "Categories"]}}, "/products/:product_id/variant_categories/:variant_category_id/variants"=>{"post"=>{"summary"=>"Post Products Variant Categories Variant Category Variants", "description"=>"Create a new variant of a product.", "operationId"=>"postProductsProductVariantCategoriesVariantCategoryVariants", "x-api-path-slug"=>"productsproduct-idvariant-categoriesvariant-category-idvariants-post", "parameters"=>[{"in"=>"query", "name"=>"max_purchase_count"}, {"in"=>"query", "name"=>"name"}, {"in"=>"query", "name"=>"price_difference_cents"}, {"in"=>"query", "name"=>"variant"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Variant", "Categories", ":variant", "Category", "Variants"]}}, "/products/:product_id/variant_categories/:variant_category_id/variants/:id"=>{"delete"=>{"summary"=>"Delete Products Variant Categories Variant Category Variants", "description"=>"Permanently delete a variant of a product.", "operationId"=>"deleteProductsProductVariantCategoriesVariantCategoryVariants", "x-api-path-slug"=>"productsproduct-idvariant-categoriesvariant-category-idvariantsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Variant", "Categories", ":variant", "Category", "Variants"]}, "get"=>{"summary"=>"Get Products Variant Categories Variant Category Variants", "description"=>"Retrieve the details of a variant of a product.", "operationId"=>"getProductsProductVariantCategoriesVariantCategoryVariants", "x-api-path-slug"=>"productsproduct-idvariant-categoriesvariant-category-idvariantsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Variant", "Categories", ":variant", "Category", "Variants"]}, "put"=>{"summary"=>"Put Products Variant Categories Variant Category Variants", "description"=>"Edit a variant of an existing product.", "operationId"=>"putProductsProductVariantCategoriesVariantCategoryVariants", "x-api-path-slug"=>"productsproduct-idvariant-categoriesvariant-category-idvariantsid-put", "parameters"=>[{"in"=>"query", "name"=>"max_purchase_count"}, {"in"=>"query", "name"=>"name"}, {"in"=>"query", "name"=>"price_difference_cents"}, {"in"=>"query", "name"=>"variant"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Variant", "Categories", ":variant", "Category", "Variants"]}}}}, "apis"=>{"name"=>"Gumroad", "x-slug"=>"gumroad", "description"=>"Sell music, comics, software, books, and films directly to your audience.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1067-gumroad.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"4658", "tags"=>"API Provider,Commerce,Documents,General Data,internet,Marketplace,Media,Music,My API Stack,Pedestal,Products,Profiles,Relative Data,Service API,Services,Shopping,Social,Stack Network,Target,Technology,Videos,Videos,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"gumroad/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Gumroad", "x-api-slug"=>"gumroad", "description"=>"Share and sell exclusive videos directly to your followers. Selling stuff has always been a pain. No longer! Get back to creating.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1067-gumroad.jpg", "humanURL"=>"http://gumroad.com", "baseURL"=>"https://api.gumroad.com//v2", "tags"=>"API Provider,Commerce,Documents,General Data,internet,Marketplace,Media,Music,My API Stack,Pedestal,Products,Profiles,Relative Data,Service API,Services,Shopping,Social,Stack Network,Target,Technology,Videos,Videos,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/gumroad/gumroad-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-application-management", "url"=>"https://gumroad.com/settings/developer"}, {"type"=>"x-base", "url"=>"https://api.gumroad.com/"}, {"type"=>"x-blog", "url"=>"http://blog.gumroad.com"}, {"type"=>"x-blog-rss", "url"=>"http://blog.gumroad.com/rss"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/gumroad"}, {"type"=>"x-developer", "url"=>"https://gumroad.com/developers"}, {"type"=>"x-email", "url"=>"partners@gumroad.com"}, {"type"=>"x-email", "url"=>"support@gumroad.com"}, {"type"=>"x-embeddable", "url"=>"https://gumroad.com/embed"}, {"type"=>"x-github", "url"=>"https://github.com/gumroad"}, {"type"=>"x-pricing", "url"=>"https://gumroad.com/features/pricing"}, {"type"=>"x-privacy", "url"=>"https://gumroad.com/privacy"}, {"type"=>"x-terms-of-service", "url"=>"https://gumroad.com/terms"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/gumroad"}, {"type"=>"x-webhooks", "url"=>"https://gumroad.com/webhooks"}, {"type"=>"x-website", "url"=>"http://gumroad.com"}, {"type"=>"x-website", "url"=>"https://gumroad.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
stocktwits{"apis"=>{"name"=>"StockTwits", "x-slug"=>"stocktwits", "description"=>"StockTwits is a real-time social network for investors and traders. Download our app and visit StockTwits.com.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/944-stocktwits.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"6524", "tags"=>"Finance,Financial,Financial Services,General Data,internet,Markets,Mobile,Service API,Social,Stocks,Stocks,StockTwits,Target,Technology,Twitter", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"stocktwits/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Stocktwits", "x-api-slug"=>"stocktwits", "description"=>"StockTwits is a real-time social network for investors and traders. Download our app and visit StockTwits.com.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/944-stocktwits.jpg", "humanURL"=>"http://stocktwits.com", "baseURL"=>":///", "tags"=>"Finance,Financial,Financial Services,General Data,internet,Markets,Mobile,Service API,Social,Stocks,Stocks,StockTwits,Target,Technology,Twitter", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/stocktwits/streamssymbol-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/stocktwits/stocktwits-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://api.stocktwits.com/developers/docs/authentication"}, {"type"=>"x-base", "url"=>"http://api.stocktwits.com"}, {"type"=>"x-blog", "url"=>"http://blog.stocktwits.com"}, {"type"=>"x-blog-rss", "url"=>"http://blog.stocktwits.com/feed/"}, {"type"=>"x-branding", "url"=>"https://api.stocktwits.com/developers/docs/logos"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/stocktwits"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/stocktwits"}, {"type"=>"x-developer", "url"=>"http://stocktwits.com/developers"}, {"type"=>"x-documentation", "url"=>"https://api.stocktwits.com/developers/docs/api"}, {"type"=>"x-email", "url"=>"privacy@stocktwits.com"}, {"type"=>"x-email", "url"=>"parents@stocktwits.com"}, {"type"=>"x-email", "url"=>"support@stocktwits.com"}, {"type"=>"x-email", "url"=>"abuse@stocktwits.com"}, {"type"=>"x-embeddable", "url"=>"https://api.stocktwits.com/developers/docs/stocktwits-for-websites"}, {"type"=>"x-getting-started", "url"=>"https://api.stocktwits.com/developers/docs/start"}, {"type"=>"x-github", "url"=>"https://github.com/stocktwits"}, {"type"=>"x-rate-limits", "url"=>"https://api.stocktwits.com/developers/docs/rate_limiting"}, {"type"=>"x-status", "url"=>"http://api-status.stocktwits.com/"}, {"type"=>"x-terms-of-service", "url"=>"https://api.stocktwits.com/developers/api-terms"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/stocktwits"}, {"type"=>"x-website", "url"=>"http://stocktwits.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "stocktwits-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"StockTwits", "x-complete"=>1, "info"=>{"title"=>"No Title", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"streams/symbol"=>{"get"=>{"summary"=>"Streams by Symbol", "description"=>"Returns the most recent 30 messages for the specified symbol. Includes symbol object in response.", "operationId"=>"", "x-api-path-slug"=>"streamssymbol-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
dun-bradstreet{"db-direct-identity-resolution-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Dun & Bradstreet", "x-complete"=>1, "info"=>{"title"=>"D&B Direct+ Identity Resolution", "description"=>"todo-add-description", "version"=>"1.0.0"}, "host"=>"plus.dnb.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/match/cleanseMatch"=>{"get"=>{"summary"=>"IDR Domain Email", "description"=>"Idr domain email.", "operationId"=>"V1MatchCleanseMatchGet10", "x-api-path-slug"=>"v1matchcleansematch-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"countryISOAlpha2Code"}, {"in"=>"query", "name"=>"email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Domain", "Email"]}}, "/v1/match/extendedMatch"=>{"get"=>{"summary"=>"IDR & Append Domain URL", "description"=>"Idr & append domain url.", "operationId"=>"V1MatchExtendedMatchGet4", "x-api-path-slug"=>"v1matchextendedmatch-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"countryISOAlpha2Code"}, {"in"=>"query", "name"=>"productId"}, {"in"=>"query", "name"=>"url"}, {"in"=>"query", "name"=>"versionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Append", "Domain", "URL"]}}, "/v2/token"=>{"post"=>{"summary"=>"Authentication - Access Token", "description"=>"Authentication - access token.", "operationId"=>"V2TokenPost", "x-api-path-slug"=>"v2token-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Authentication", "Access", "Token"]}}, "/v1/match/cleanseAndStandardize"=>{"get"=>{"summary"=>"Cleanse & Standardize", "description"=>"Cleanse & standardize.", "operationId"=>"V1MatchCleanseAndStandardizeGet", "x-api-path-slug"=>"v1matchcleanseandstandardize-get", "parameters"=>[{"in"=>"query", "name"=>"addressLocality"}, {"in"=>"query", "name"=>"addressRegion"}, {"in"=>"query", "name"=>"countryISOAlpha2Code"}, {"in"=>"query", "name"=>"name"}, {"in"=>"query", "name"=>"streetAddressLine1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Cleanse", "Standardize"]}}}}, "apis"=>{"name"=>"Dun & Bradstreet", "x-slug"=>"dun-bradstreet", "description"=>"Dun & Bradstreet (NYSE: DNB) grows the most valuable relationships in business. We help our customers and partners make better business decisions. Many global companies rely on our data, insights, and analytics for success. Find out how Dun & Bradstree...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/174-dun-&-bradstreet.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"32319", "tags"=>"API Provider,Business,Business Intelligence,Enterprise,Profiles,Risk Management,SaaS,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"dun-bradstreet/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"D&B Direct+ Identity Resolution", "x-api-slug"=>"db-direct-identity-resolution", "description"=>"D&B (NYSE:DNB) is the worlds leading source of commercial information and insight on businesses, enabling companies to Decide with Confidence® for 170 years. D&Bs global commercial database contains more than 195 million business records. The database is enhanced by D&Bs proprietary DUNSRight® Quality Process, which provides our customers with quality business information. This quality information is the foundation of our global solutions that customers rely on to make critical business decisions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/174-dun-&-bradstreet.jpg", "humanURL"=>"http://www.dnb.com", "baseURL"=>"https://plus.dnb.com//", "tags"=>"API Provider,Business,Business Intelligence,Enterprise,Profiles,Risk Management,SaaS,Stack Network,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/dun-bradstreet/db-direct-identity-resolution-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-github", "url"=>"https://github.com/dandb"}, {"type"=>"x-postman-collection", "url"=>"https://app.getpostman.com/run-collection/5f896b56651f25806d07"}, {"type"=>"x-website", "url"=>"http://www.dnb.com"}, {"type"=>"x-base", "url"=>"https://maxcvservices.dnb.com"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/the-dun-bradstreet-corporation"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/DnBUS"}, {"type"=>"x-website", "url"=>"http://developer.dnb.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
code-gov{"code-gov-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Code.gov", "x-complete"=>1, "info"=>{"title"=>"Code.gov API", "description"=>"code-gov-api-documentation--while-using-this-documentation-locally-please-choose-to-", "version"=>"1.0.0"}, "host"=>"api.code.gov", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/repos"=>{"get"=>{"summary"=>"Get a list of repos", "description"=>"Get list of repositories indexed by Code.gov.", "operationId"=>"getRepos", "x-api-path-slug"=>"repos-get", "parameters"=>[{"in"=>"query", "name"=>"agency.acronym", "description"=>"Filters search by the Agencys acronym"}, {"in"=>"query", "name"=>"agency.name", "description"=>"Filters search by the Agencys name"}, {"in"=>"query", "name"=>"agency.website", "description"=>"Filters search by the Agencys website URL"}, {"in"=>"query", "name"=>"contact.email", "description"=>"Filters search by the repositorys contact email"}, {"in"=>"query", "name"=>"contact.name", "description"=>"Filters search by the repositorys contact name"}, {"in"=>"query", "name"=>"date.created", "description"=>"Filters search by the repositorys created date"}, {"in"=>"query", "name"=>"date.lastModified", "description"=>"Filters search by the last date the repository was modified"}, {"in"=>"query", "name"=>"from", "description"=>"Sets the offset from where to paginate"}, {"in"=>"query", "name"=>"laborHours", "description"=>"Filters search by the amount of labor hours dedicated to the project"}, {"in"=>"query", "name"=>"languages", "description"=>"Filters search by programming languages"}, {"in"=>"query", "name"=>"name", "description"=>"Filters search by the repositorys name"}, {"in"=>"query", "name"=>"organization", "description"=>"Filters search by the repositorys organization"}, {"in"=>"query", "name"=>"permissions.licenses.name", "description"=>"Filters search by the repositorys license name"}, {"in"=>"query", "name"=>"permissions.usageType", "description"=>"Filters search by the repositorys usage type"}, {"in"=>"query", "name"=>"q", "description"=>"Text to search for"}, {"in"=>"query", "name"=>"size", "description"=>"Sets the size of the results returned"}, {"in"=>"query", "name"=>"status", "description"=>"Filters search by the repositorys status"}, {"in"=>"query", "name"=>"tags", "description"=>"Filters search by the repositorys tags"}, {"in"=>"query", "name"=>"vcs", "description"=>"Filters search by the version control system for the repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Code", "Repositories"]}}, "/repos/{repoId}"=>{"get"=>{"summary"=>"Get information for specified repoId", "description"=>"Gets the information of a specific repository index with the passed repoId.", "operationId"=>"getReposRepo", "x-api-path-slug"=>"reposrepoid-get", "parameters"=>[{"in"=>"path", "name"=>"repoId", "description"=>"ID of repo to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Code", "Repositories"]}}, "/terms"=>{"get"=>{"summary"=>"Get a list of terms", "description"=>"Get a list of terms that were extracted from the repositories indexed.", "operationId"=>"getTerms", "x-api-path-slug"=>"terms-get", "parameters"=>[{"in"=>"query", "name"=>"from", "description"=>"Sets the offset from where to paginate"}, {"in"=>"query", "name"=>"size", "description"=>"Sets the size of the results returned"}, {"in"=>"query", "name"=>"term", "description"=>"Filters the result set by the term value"}, {"in"=>"query", "name"=>"term_type", "description"=>"Filters the result set by the term type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Code", "Terms of Service"]}}, "/agencies"=>{"get"=>{"summary"=>"Get a list of agencies", "description"=>"Get a list of agencies.", "operationId"=>"getAgencies", "x-api-path-slug"=>"agencies-get", "parameters"=>[{"in"=>"query", "name"=>"from", "description"=>"Specify an offset to return"}, {"in"=>"query", "name"=>"size", "description"=>"Number of agencies to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agencies"]}}, "/languages"=>{"get"=>{"summary"=>"Get a list of programming languages found in our code inventory.", "description"=>"This returns a list of the programming languages that are used in the indexed code inventory. When a repo is index the programming language is extracted written to a file.", "operationId"=>"getLanguages", "x-api-path-slug"=>"languages-get", "parameters"=>[{"in"=>"query", "name"=>"from", "description"=>"Specify an offset to return"}, {"in"=>"query", "name"=>"size", "description"=>"Number of programming languages to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Languages"]}}, "/repo.json"=>{"get"=>{"summary"=>"Get the JSON schema for a repo", "description"=>"Get the json schema for a repo.", "operationId"=>"getRepo", "x-api-path-slug"=>"repo-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Code", "Repositories"]}}, "/status.json"=>{"get"=>{"summary"=>"Get a list of agencies with their compliance status", "description"=>"Get a list of agencies with their Federal Source Code Policy compliance status", "operationId"=>"getStatus.json", "x-api-path-slug"=>"status-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Code", "Status"]}}, "/status"=>{"get"=>{"summary"=>"Get an HTML page rendering the agencies status from status.json", "description"=>"Get an html page rendering the agencies status from status.json.", "operationId"=>"getStatus", "x-api-path-slug"=>"status-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Code", "Status"]}}, "/status/{agencyName}/issues"=>{"get"=>{"summary"=>"Get a list of issues for a particular agency", "description"=>"Get a list of issues for a particular agency. These issues are grouped by software repository.", "operationId"=>"getStatusAgencynameIssues", "x-api-path-slug"=>"statusagencynameissues-get", "parameters"=>[{"in"=>"path", "name"=>"agencyName", "description"=>"Agency name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Code", "Status"]}}, "/status/{agencyName}/fetched"=>{"get"=>{"summary"=>"Get a list of repos by agency", "description"=>"Lists out all repositories that have been indexed for a given agency.", "operationId"=>"getStatusAgencynameFetched", "x-api-path-slug"=>"statusagencynamefetched-get", "parameters"=>[{"in"=>"path", "name"=>"agencyName", "description"=>"Agency name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Code", "Status"]}}, "/status/{agencyName}/discovered"=>{"get"=>{"summary"=>"Get a list of repos by agency", "description"=>"Get a list of repos by agency.", "operationId"=>"getStatusAgencynameDiscovered", "x-api-path-slug"=>"statusagencynamediscovered-get", "parameters"=>[{"in"=>"path", "name"=>"agencyName", "description"=>"Agency name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Code", "Status"]}}, "/version"=>{"get"=>{"summary"=>"Get the version of this API", "description"=>"Get the version of this api.", "operationId"=>"getVersion", "x-api-path-slug"=>"version-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Code", "Version"]}}}}, "apis"=>{"name"=>"Code.gov", "x-slug"=>"code-gov", "description"=>"Code.gov leverages the power of code sharing and collaboration to help the US Government cut down on duplicative software development and save millions of taxpayer dollars for the American people.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/code-gov-logo.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Developers,Federal Government,General Data,GitHub,Profiles", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"code-gov/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Code.gov", "x-api-slug"=>"code-gov", "description"=>"Code.gov leverages the power of code sharing and collaboration to help the US Government cut down on duplicative software development and save millions of taxpayer dollars for the American people.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/code-gov-logo.jpg", "humanURL"=>"https://code.gov/", "baseURL"=>"https://api.code.gov//", "tags"=>"API Provider,API Service Provider,Developers,Federal Government,General Data,GitHub,Profiles", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/code-gov/version-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/code-gov/code-gov-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-applications", "url"=>"https://code.gov/#/explore-code"}, {"type"=>"x-developer", "url"=>"https://api.code.gov/docs/"}, {"type"=>"x-documentation", "url"=>"https://api.code.gov/docs/#"}, {"type"=>"x-road-map", "url"=>"https://code.gov/#/roadmap"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/codedotgov"}, {"type"=>"x-website", "url"=>"https://code.gov/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fluxiom{"fluxiom-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Fluxiom", "x-complete"=>1, "info"=>{"title"=>"Fluxiom API", "description"=>"the-fluxiom-api-allows-you-to-hook-into-fluxiom-and-connect-it-with-other-apps-", "termsOfService"=>"http://www.fluxiom.com/terms", "version"=>"v1"}, "host"=>"{subdomain}.fluxiom.com", "basePath"=>"/api/{format}", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/assets"=>{"get"=>{"summary"=>"Get assets", "description"=>"Get assets", "operationId"=>"get-assets", "x-api-path-slug"=>"apiassets-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"page tt integer tt current page number (defaults to 1)"}, {"in"=>"query", "name"=>"per_page", "description"=>"per_page tt integer tt number of items per page (max"}, {"in"=>"query", "name"=>"query", "description"=>"query tt string tt search term"}, {"in"=>"query", "name"=>"tags", "description"=>"tags tt string tt tag names or IDs, comma separated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assets"]}, "post"=>{"summary"=>"Create asset", "description"=>"Create asset", "operationId"=>"create-asset", "x-api-path-slug"=>"apiassets-post", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"description tt string"}, {"in"=>"query", "name"=>"file", "description"=>"file tt postdata tt (required)"}, {"in"=>"query", "name"=>"tags", "description"=>"tags tt string tt tag names or IDs, comma separated"}, {"in"=>"query", "name"=>"title", "description"=>"title tt string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assets"]}}, "/api/assets/download/{id}"=>{"get"=>{"summary"=>"Download asset", "description"=>"Download asset", "operationId"=>"download-asset", "x-api-path-slug"=>"apiassetsdownloadid-get", "parameters"=>[{"in"=>"path", "name"=>"ID", "description"=>"The unique ID for the asset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assets", "Download", "Id"]}}, "/api/assets/ID"=>{"get"=>{"summary"=>"Get single asset", "description"=>"Get single asset", "operationId"=>"get-single-asset", "x-api-path-slug"=>"apiassetsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assets"]}, "put"=>{"summary"=>"Update asset", "description"=>"Update asset", "operationId"=>"update-asset", "x-api-path-slug"=>"apiassetsid-put", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"description tt string"}, {"in"=>"query", "name"=>"tags", "description"=>"tags tt string tt tag names or IDs, comma separated"}, {"in"=>"query", "name"=>"title", "description"=>"title tt string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assets"]}}, "/api/assets/ID/versions"=>{"get"=>{"summary"=>"Get asset versions", "description"=>"Get asset versions", "operationId"=>"get-asset-versions", "x-api-path-slug"=>"apiassetsidversions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assets", "Versions"]}, "post"=>{"summary"=>"Create asset version", "description"=>"Create asset version", "operationId"=>"create-asset-version", "x-api-path-slug"=>"apiassetsidversions-post", "parameters"=>[{"in"=>"query", "name"=>"comment", "description"=>"comment tt string"}, {"in"=>"query", "name"=>"file", "description"=>"file tt postdata"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assets", "Versions"]}}, "/api/assets/ID/versions/VID"=>{"get"=>{"summary"=>"Get single asset version", "description"=>"Get single asset version", "operationId"=>"get-single-asset-version", "x-api-path-slug"=>"apiassetsidversionsvid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assets", "Versions", "VID"]}}, "/api/assets/{id}"=>{"delete"=>{"summary"=>"Delete asset", "description"=>"Delete asset", "operationId"=>"delete-asset", "x-api-path-slug"=>"apiassetsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of the asset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assets", "Id"]}}, "/api/tags"=>{"get"=>{"summary"=>"Get tags", "description"=>"Get tags", "operationId"=>"get-tags", "x-api-path-slug"=>"apitags-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}, "post"=>{"summary"=>"Create tag", "description"=>"Create tag", "operationId"=>"create-tag", "x-api-path-slug"=>"apitags-post", "parameters"=>[{"in"=>"query", "name"=>"tag", "description"=>"tag tt string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/api/tags/ID"=>{"get"=>{"summary"=>"Get single tag", "description"=>"Get single tag", "operationId"=>"get-single-tag", "x-api-path-slug"=>"apitagsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}, "put"=>{"summary"=>"Update tag", "description"=>"Update tag", "operationId"=>"update-tag", "x-api-path-slug"=>"apitagsid-put", "parameters"=>[{"in"=>"query", "name"=>"tag", "description"=>"tag tt string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/api/tags/{id}"=>{"delete"=>{"summary"=>"Delete tag", "description"=>"Delete tag", "operationId"=>"delete-tag", "x-api-path-slug"=>"apitagsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Id"]}}, "/api/user"=>{"get"=>{"summary"=>"Get current user", "description"=>"Get current user", "operationId"=>"get-current-user", "x-api-path-slug"=>"apiuser-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/api/users"=>{"get"=>{"summary"=>"Get users", "description"=>"Get users", "operationId"=>"get-users", "x-api-path-slug"=>"apiusers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/api/users/{id}"=>{"get"=>{"summary"=>"Get single user", "description"=>"Get single user", "operationId"=>"get-single-user", "x-api-path-slug"=>"apiusersid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Id"]}}}}, "apis"=>{"name"=>"Fluxiom", "x-slug"=>"fluxiom", "description"=>"Fluxiom offers seamless online file management in the cloud. Keep your files private, share them with a select audience or broadcast them to the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/594-fluxiom.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"3532345", "tags"=>"API Provider,File,internet,Photos,Profiles,Relative Data,SaaS,Service API,Storage,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"fluxiom/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Fluxiom API", "x-api-slug"=>"fluxiom-api", "description"=>"The Fluxiom API allows you to hook into Fluxiom and connect it with other apps. It can be used for retrieving and uploading assets, querying metadata, and more. This enables Fluxiom to easily integrate with your workflow and the tools you already use.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/594-fluxiom.jpg", "humanURL"=>"http://fluxiom.com", "baseURL"=>"https://{subdomain}.fluxiom.com//api/{format}", "tags"=>"API Provider,File,internet,Photos,Profiles,Relative Data,SaaS,Service API,Storage,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/fluxiom/apiusersid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/fluxiom/fluxiom-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://fluxiom.com/api/"}, {"type"=>"x-blog", "url"=>"http://blog.fluxiom.com/"}, {"type"=>"x-blog-rss", "url"=>"http://feeds.feedburner.com/fluxiom"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/product/fluxiom/timeline"}, {"type"=>"x-developer", "url"=>"http://www.fluxiom.com/api"}, {"type"=>"x-email", "url"=>"support@fluxiom.com"}, {"type"=>"x-privacy", "url"=>"http://www.fluxiom.com/privacy"}, {"type"=>"x-terms-of-service", "url"=>"http://www.fluxiom.com/terms"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/fluxiom"}, {"type"=>"x-website", "url"=>"http://fluxiom.com"}, {"type"=>"x-website", "url"=>"http://www.fluxiom.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-waf{"aws-waf-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS WAF", "x-complete"=>1, "info"=>{"title"=>"AWS WAF API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AssociateWebACL"=>{"get"=>{"summary"=>"Associate Web ACL", "description"=>"Service: AWS WAF RegionalAssociates a web ACL with a resource.", "operationId"=>"associateWebACL", "x-api-path-slug"=>"actionassociatewebacl-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceArn", "description"=>"The ARN (Amazon Resource Name) of the resource to be protected", "type"=>"string"}, {"in"=>"query", "name"=>"WebACLId", "description"=>"A unique identifier (ID) for the web ACL", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web ACL"]}}, "/?Action=CreateByteMatchSet"=>{"get"=>{"summary"=>"Create Byte Match Set", "description"=>"Service: AWS WAFCreates a ByteMatchSet.", "operationId"=>"createByteMatchSet", "x-api-path-slug"=>"actioncreatebytematchset-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"A friendly name or description of the ByteMatchSet", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Byte Match Set"]}}, "/?Action=CreateIPSet"=>{"get"=>{"summary"=>"Create IP Set", "description"=>"Service: AWS WAFCreates an.", "operationId"=>"createIPSet", "x-api-path-slug"=>"actioncreateipset-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"A friendly name or description of the IPSet", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Sets"]}}, "/?Action=CreateRule"=>{"get"=>{"summary"=>"Create Rule", "description"=>"Service: AWS WAFCreates a Rule, which contains the IPSet objects, ByteMatchSet objects, and \n\t\t\tother predicates that identify the requests that you want to block.", "operationId"=>"createRule", "x-api-path-slug"=>"actioncreaterule-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"MetricName", "description"=>"A friendly name or description for the metrics for this Rule", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"A friendly name or description of the Rule", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rules"]}}, "/?Action=CreateSizeConstraintSet"=>{"get"=>{"summary"=>"Create Size Constraint Set", "description"=>"Service: AWS WAFCreates a SizeConstraintSet.", "operationId"=>"createSizeConstraintSet", "x-api-path-slug"=>"actioncreatesizeconstraintset-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"A friendly name or description of the SizeConstraintSet", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Size Constraint Set"]}}, "/?Action=CreateSqlInjectionMatchSet"=>{"get"=>{"summary"=>"Create Sql Injection Match Set", "description"=>"Service: AWS WAFCreates a.", "operationId"=>"createSqlInjectionMatchSet", "x-api-path-slug"=>"actioncreatesqlinjectionmatchset-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"A friendly name or description for the SqlInjectionMatchSet that youre creating", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SQL Injection Match Set"]}}, "/?Action=CreateWebACL"=>{"get"=>{"summary"=>"Create Web ACL", "description"=>"Service: AWS WAFCreates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count.", "operationId"=>"createWebACL", "x-api-path-slug"=>"actioncreatewebacl-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultAction", "description"=>"The action that you want AWS WAF to take when a request doesnt match the criteria specified in any of the Rule objects that are associated with the WebACL", "type"=>"string"}, {"in"=>"query", "name"=>"MetricName", "description"=>"A friendly name or description for the metrics for this WebACL", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"A friendly name or description of the WebACL", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web ACL"]}}, "/?Action=CreateXssMatchSet"=>{"get"=>{"summary"=>"Create XSS Match Set", "description"=>"Service: AWS WAFCreates an.", "operationId"=>"createXssMatchSet", "x-api-path-slug"=>"actioncreatexssmatchset-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"A friendly name or description for the XssMatchSet that youre creating", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["XSS Match Set"]}}, "/?Action=DeleteByteMatchSet"=>{"get"=>{"summary"=>"Delete Byte Match Set", "description"=>"Service: AWS WAFPermanently deletes a.", "operationId"=>"deleteByteMatchSet", "x-api-path-slug"=>"actiondeletebytematchset-get", "parameters"=>[{"in"=>"query", "name"=>"ByteMatchSetId", "description"=>"The ByteMatchSetId of the ByteMatchSet that you want to delete", "type"=>"string"}, {"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Byte Match Set"]}}, "/?Action=DeleteIPSet"=>{"get"=>{"summary"=>"Delete IP Set", "description"=>"Service: AWS WAFPermanently deletes an.", "operationId"=>"deleteIPSet", "x-api-path-slug"=>"actiondeleteipset-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"IPSetId", "description"=>"The IPSetId of the IPSet that you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Sets"]}}, "/?Action=DeleteRule"=>{"get"=>{"summary"=>"Delete Rule", "description"=>"Service: AWS WAFPermanently deletes a.", "operationId"=>"deleteRule", "x-api-path-slug"=>"actiondeleterule-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"RuleId", "description"=>"The RuleId of the Rule that you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rules"]}}, "/?Action=DeleteSizeConstraintSet"=>{"get"=>{"summary"=>"Delete Size Constraint Set", "description"=>"Service: AWS WAFPermanently deletes a.", "operationId"=>"deleteSizeConstraintSet", "x-api-path-slug"=>"actiondeletesizeconstraintset-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"SizeConstraintSetId", "description"=>"The SizeConstraintSetId of the SizeConstraintSet that you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Size Constraint Set"]}}, "/?Action=DeleteSqlInjectionMatchSet"=>{"get"=>{"summary"=>"Delete Sql Injection Match Set", "description"=>"Service: AWS WAFPermanently deletes a.", "operationId"=>"deleteSqlInjectionMatchSet", "x-api-path-slug"=>"actiondeletesqlinjectionmatchset-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"SqlInjectionMatchSetId", "description"=>"The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SQL Injection Match Set"]}}, "/?Action=DeleteWebACL"=>{"get"=>{"summary"=>"Delete Web ACL", "description"=>"Service: AWS WAFPermanently deletes a.", "operationId"=>"deleteWebACL", "x-api-path-slug"=>"actiondeletewebacl-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"WebACLId", "description"=>"The WebACLId of the WebACL that you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web ACL"]}}, "/?Action=DeleteXssMatchSet"=>{"get"=>{"summary"=>"Delete Xss Match Set", "description"=>"Service: AWS WAFPermanently deletes an.", "operationId"=>"deleteXssMatchSet", "x-api-path-slug"=>"actiondeletexssmatchset-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"XssMatchSetId", "description"=>"The XssMatchSetId of the XssMatchSet that you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["XSS Match Set"]}}, "/?Action=DisassociateWebACL"=>{"get"=>{"summary"=>"Disassociate Web ACL", "description"=>"Service: AWS WAF RegionalRemoves a web ACL from the specified resource.", "operationId"=>"disassociateWebACL", "x-api-path-slug"=>"actiondisassociatewebacl-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceArn", "description"=>"The ARN (Amazon Resource Name) of the resource from which the web ACL is being removed", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web ACL"]}}, "/?Action=GetByteMatchSet"=>{"get"=>{"summary"=>"Get Byte Match Set", "description"=>"Service: AWS WAFReturns the.", "operationId"=>"getByteMatchSet", "x-api-path-slug"=>"actiongetbytematchset-get", "parameters"=>[{"in"=>"query", "name"=>"ByteMatchSetId", "description"=>"The ByteMatchSetId of the ByteMatchSet that you want to get", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Byte Match Set"]}}, "/?Action=GetChangeToken"=>{"get"=>{"summary"=>"Get Change Token", "description"=>"Service: AWS WAFWhen you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request.", "operationId"=>"getChangeToken", "x-api-path-slug"=>"actiongetchangetoken-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The ChangeToken that you used in the request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change Token"]}}, "/?Action=GetChangeTokenStatus"=>{"get"=>{"summary"=>"Get Change Token Status", "description"=>"Service: AWS WAFReturns the status of a ChangeToken that you got by calling.", "operationId"=>"getChangeTokenStatus", "x-api-path-slug"=>"actiongetchangetokenstatus-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The change token for which you want to get the status", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change Token"]}}, "/?Action=GetIPSet"=>{"get"=>{"summary"=>"Get IP Set", "description"=>"Service: AWS WAFReturns the.", "operationId"=>"getIPSet", "x-api-path-slug"=>"actiongetipset-get", "parameters"=>[{"in"=>"query", "name"=>"IPSetId", "description"=>"The IPSetId of the IPSet that you want to get", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Sets"]}}, "/?Action=GetRule"=>{"get"=>{"summary"=>"Get Rule", "description"=>"Service: AWS WAFReturns the.", "operationId"=>"getRule", "x-api-path-slug"=>"actiongetrule-get", "parameters"=>[{"in"=>"query", "name"=>"RuleId", "description"=>"The RuleId of the Rule that you want to get", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rules"]}}, "/?Action=GetSampledRequests"=>{"get"=>{"summary"=>"Get Sampled Requests", "description"=>"Service: AWS WAFGets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose.", "operationId"=>"getSampledRequests", "x-api-path-slug"=>"actiongetsampledrequests-get", "parameters"=>[{"in"=>"query", "name"=>"MaxItems", "description"=>"The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource receivedduring the time range", "type"=>"string"}, {"in"=>"query", "name"=>"RuleId", "description"=>"RuleId is one of two values:", "type"=>"string"}, {"in"=>"query", "name"=>"TimeWindow", "description"=>"The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests", "type"=>"string"}, {"in"=>"query", "name"=>"WebAclId", "description"=>"The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/?Action=GetSizeConstraintSet"=>{"get"=>{"summary"=>"Get Size Constraint Set", "description"=>"Service: AWS WAFReturns the.", "operationId"=>"getSizeConstraintSet", "x-api-path-slug"=>"actiongetsizeconstraintset-get", "parameters"=>[{"in"=>"query", "name"=>"SizeConstraintSetId", "description"=>"The SizeConstraintSetId of the SizeConstraintSet that you want to get", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Size Constraint Set"]}}, "/?Action=GetSqlInjectionMatchSet"=>{"get"=>{"summary"=>"Get Sql Injection Match Set", "description"=>"Service: AWS WAFReturns the.", "operationId"=>"getSqlInjectionMatchSet", "x-api-path-slug"=>"actiongetsqlinjectionmatchset-get", "parameters"=>[{"in"=>"query", "name"=>"SqlInjectionMatchSetId", "description"=>"The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SQL Injection Match Set"]}}, "/?Action=GetWebACL"=>{"get"=>{"summary"=>"Get Web ACL", "description"=>"Service: AWS WAFReturns the.", "operationId"=>"getWebACL", "x-api-path-slug"=>"actiongetwebacl-get", "parameters"=>[{"in"=>"query", "name"=>"WebACLId", "description"=>"The WebACLId of the WebACL that you want to get", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web ACL"]}}, "/?Action=GetWebACLForResource"=>{"get"=>{"summary"=>"Get Web ACLFor Resource", "description"=>"Service: AWS WAF RegionalReturns the web ACL for the specified resource.", "operationId"=>"getWebACLForResource", "x-api-path-slug"=>"actiongetwebaclforresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceArn", "description"=>"The ARN (Amazon Resource Name) of the resource for which to get the web ACL", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web ACL"]}}, "/?Action=GetXssMatchSet"=>{"get"=>{"summary"=>"Get Xss Match Set", "description"=>"Service: AWS WAFReturns the.", "operationId"=>"getXssMatchSet", "x-api-path-slug"=>"actiongetxssmatchset-get", "parameters"=>[{"in"=>"query", "name"=>"XssMatchSetId", "description"=>"The XssMatchSetId of the XssMatchSet that you want to get", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["XSS Match Set"]}}, "/?Action=ListByteMatchSets"=>{"get"=>{"summary"=>"List Byte Match Sets", "description"=>"Service: AWS WAFReturns an array of.", "operationId"=>"listByteMatchSets", "x-api-path-slug"=>"actionlistbytematchsets-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request", "type"=>"string"}, {"in"=>"query", "name"=>"NextMarker", "description"=>"If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Byte Match Sets"]}}, "/?Action=ListIPSets"=>{"get"=>{"summary"=>"List IP Sets", "description"=>"Service: AWS WAFReturns an array of.", "operationId"=>"listIPSets", "x-api-path-slug"=>"actionlistipsets-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"Specifies the number of IPSet objects that you want AWS WAF to return for this request", "type"=>"string"}, {"in"=>"query", "name"=>"NextMarker", "description"=>"If you specify a value for Limit and you have more IPSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of IPSets", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Sets"]}}, "/?Action=ListResourcesForWebACL"=>{"get"=>{"summary"=>"List Resources For Web ACL", "description"=>"Service: AWS WAF RegionalReturns an array of resources associated with the specified web ACL.", "operationId"=>"listResourcesForWebACL", "x-api-path-slug"=>"actionlistresourcesforwebacl-get", "parameters"=>[{"in"=>"query", "name"=>"WebACLId", "description"=>"The unique identifier (ID) of the web ACL for which to list the associated resources", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web ACL"]}}, "/?Action=ListRules"=>{"get"=>{"summary"=>"List Rules", "description"=>"Service: AWS WAFReturns an array of.", "operationId"=>"listRules", "x-api-path-slug"=>"actionlistrules-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"Specifies the number of Rules that you want AWS WAF to return for this request", "type"=>"string"}, {"in"=>"query", "name"=>"NextMarker", "description"=>"If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rules"]}}, "/?Action=ListSizeConstraintSets"=>{"get"=>{"summary"=>"List Size Constraint Sets", "description"=>"Service: AWS WAFReturns an array of.", "operationId"=>"listSizeConstraintSets", "x-api-path-slug"=>"actionlistsizeconstraintsets-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"Specifies the number of SizeConstraintSet objects that you want AWS WAF to return for this request", "type"=>"string"}, {"in"=>"query", "name"=>"NextMarker", "description"=>"If you specify a value for Limit and you have more SizeConstraintSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SizeConstraintSets", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Size Constraint Sets"]}}, "/?Action=ListSqlInjectionMatchSets"=>{"get"=>{"summary"=>"List SQL Injection Match Sets", "description"=>"Service: AWS WAFReturns an array of.", "operationId"=>"listSqlInjectionMatchSets", "x-api-path-slug"=>"actionlistsqlinjectionmatchsets-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request", "type"=>"string"}, {"in"=>"query", "name"=>"NextMarker", "description"=>"If you specify a value for Limit and you have more SqlInjectionMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SqlInjectionMatchSets", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SQL Injection Match Sets"]}}, "/?Action=ListWebACLs"=>{"get"=>{"summary"=>"List Web ACLs", "description"=>"Service: AWS WAFReturns an array of.", "operationId"=>"listWebACLs", "x-api-path-slug"=>"actionlistwebacls-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"Specifies the number of WebACL objects that you want AWS WAF to return for this request", "type"=>"string"}, {"in"=>"query", "name"=>"NextMarker", "description"=>"If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of WebACL objects", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web ACL"]}}, "/?Action=ListXssMatchSets"=>{"get"=>{"summary"=>"List Xss Match Sets", "description"=>"Service: AWS WAFReturns an array of.", "operationId"=>"listXssMatchSets", "x-api-path-slug"=>"actionlistxssmatchsets-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request", "type"=>"string"}, {"in"=>"query", "name"=>"NextMarker", "description"=>"If you specify a value for Limit and you have more XssMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of XssMatchSets", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["XSS Match Set"]}}, "/?Action=UpdateByteMatchSet"=>{"get"=>{"summary"=>"Update Byte Match Set", "description"=>"Service: AWS WAFInserts or deletes.", "operationId"=>"updateByteMatchSet", "x-api-path-slug"=>"actionupdatebytematchset-get", "parameters"=>[{"in"=>"query", "name"=>"ByteMatchSetId", "description"=>"The ByteMatchSetId of the ByteMatchSet that you want to update", "type"=>"string"}, {"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"Updates", "description"=>"An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Byte Match Set"]}}, "/?Action=UpdateIPSet"=>{"get"=>{"summary"=>"Update IP Set", "description"=>"Service: AWS WAFInserts or deletes.", "operationId"=>"updateIPSet", "x-api-path-slug"=>"actionupdateipset-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"IPSetId", "description"=>"The IPSetId of the IPSet that you want to update", "type"=>"string"}, {"in"=>"query", "name"=>"Updates", "description"=>"An array of IPSetUpdate objects that you want to insert into or delete from an IPSet", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Sets"]}}, "/?Action=UpdateRule"=>{"get"=>{"summary"=>"Update Rule", "description"=>"Service: AWS WAFInserts or deletes.", "operationId"=>"updateRule", "x-api-path-slug"=>"actionupdaterule-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"RuleId", "description"=>"The RuleId of the Rule that you want to update", "type"=>"string"}, {"in"=>"query", "name"=>"Updates", "description"=>"An array of RuleUpdate objects that you want to insert into or delete from a Rule", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rules"]}}, "/?Action=UpdateSizeConstraintSet"=>{"get"=>{"summary"=>"Update Size Constraint Set", "description"=>"Service: AWS WAFInserts or deletes.", "operationId"=>"updateSizeConstraintSet", "x-api-path-slug"=>"actionupdatesizeconstraintset-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"SizeConstraintSetId", "description"=>"The SizeConstraintSetId of the SizeConstraintSet that you want to update", "type"=>"string"}, {"in"=>"query", "name"=>"Updates", "description"=>"An array of SizeConstraintSetUpdate objects that you want to insert into or delete from a SizeConstraintSet", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Size Constraint Set"]}}, "/?Action=UpdateSqlInjectionMatchSet"=>{"get"=>{"summary"=>"Update SQL Injection Match Set", "description"=>"Service: AWS WAFInserts or deletes.", "operationId"=>"updateSqlInjectionMatchSet", "x-api-path-slug"=>"actionupdatesqlinjectionmatchset-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"SqlInjectionMatchSetId", "description"=>"The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update", "type"=>"string"}, {"in"=>"query", "name"=>"Updates", "description"=>"An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a SqlInjectionMatchSet", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SQL Injection Match Sets"]}}, "/?Action=UpdateWebACL"=>{"get"=>{"summary"=>"Update Web ACL", "description"=>"Service: AWS WAFInserts or deletes.", "operationId"=>"updateWebACL", "x-api-path-slug"=>"actionupdatewebacl-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultAction", "description"=>"A default action for the web ACL, either ALLOW or BLOCK", "type"=>"string"}, {"in"=>"query", "name"=>"Updates", "description"=>"An array of updates to make to the WebACL", "type"=>"string"}, {"in"=>"query", "name"=>"WebACLId", "description"=>"The WebACLId of the WebACL that you want to update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web ACL"]}}, "/?Action=UpdateXssMatchSet"=>{"get"=>{"summary"=>"Update Xss Match Set", "description"=>"Service: AWS WAFInserts or deletes.", "operationId"=>"updateXssMatchSet", "x-api-path-slug"=>"actionupdatexssmatchset-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeToken", "description"=>"The value returned by the most recent call to GetChangeToken", "type"=>"string"}, {"in"=>"query", "name"=>"Updates", "description"=>"An array of XssMatchSetUpdate objects that you want to insert into or delete from a XssMatchSet", "type"=>"string"}, {"in"=>"query", "name"=>"XssMatchSetId", "description"=>"The XssMatchSetId of the XssMatchSet that you want to update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["XSS Match Set"]}}}}, "apis"=>{"name"=>"AWS WAF", "x-slug"=>"aws-waf", "description"=>"AWS WAF is a web application firewall that helps protect your webapplications from common web exploits that could affect applicationavailability, compromise security, or consume excessive resources. AWSWAF gives you control over which traffic to allow or block to your webapplications by defining customizable web security rules. You can use AWSWAF to create custom rules that block common attack patterns, such as SQLinjection or cross-site scripting, and rules that are designed for your specific application. New rules can be deployed within minutes, letting you respondquickly to changing traffic patterns. Also, AWS WAF includes a full-featuredAPI that you can use to automate the creation, deployment, and maintenanceof web security rules.With AWS WAF you pay only for what you use. AWS WAF pricing is based on how many rules you deploy and how many web requests your web application receives. There are no upfront commitments.You can deploy AWS WAF on either Amazon CloudFront as part of your CDN solution or the Application Load Balancer (ALB) that fronts your web servers or origin servers running on EC2.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Security-Identity_AWSWAF.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Firewall,Profiles,Relative Data,Security,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-waf/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS WAF API", "x-api-slug"=>"aws-waf-api", "description"=>"AWS WAF is a web application firewall that helps protect your webapplications from common web exploits that could affect applicationavailability, compromise security, or consume excessive resources. AWSWAF gives you control over which traffic to allow or block to your webapplications by defining customizable web security rules. You can use AWSWAF to create custom rules that block common attack patterns, such as SQLinjection or cross-site scripting, and rules that are designed for your specific application. New rules can be deployed within minutes, letting you respondquickly to changing traffic patterns. Also, AWS WAF includes a full-featuredAPI that you can use to automate the creation, deployment, and maintenanceof web security rules.With AWS WAF you pay only for what you use. AWS WAF pricing is based on how many rules you deploy and how many web requests your web application receives. There are no upfront commitments.You can deploy AWS WAF on either Amazon CloudFront as part of your CDN solution or the Application Load Balancer (ALB) that fronts your web servers or origin servers running on EC2.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Security-Identity_AWSWAF.png", "humanURL"=>"https://aws.amazon.com/waf/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Firewall,Profiles,Relative Data,Security,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-waf/actionupdatexssmatchset-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-waf/aws-waf-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/waf/latest/APIReference/Welcome.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/waf/faq/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/waf/getting-started/"}, {"type"=>"x-partners", "url"=>"https://aws.amazon.com/waf/partners/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/waf/pricing/"}, {"type"=>"x-tutorials", "url"=>"https://aws.amazon.com/waf/preconfiguredrules/"}, {"type"=>"x-webinars", "url"=>"https://aws.amazon.com/waf/webinars/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/waf/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ibm-cloud{"ibm-containers-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"IBM Cloud", "x-complete"=>1, "info"=>{"title"=>"IBM Containers", "description"=>"containers-are-virtual-software-objects-that-include-all-the-elements-that-an-app-needs-to-run--a-container-has-the-benefits-of-resource-isolation-and-allocation-but-is-more-portable-and-efficient-than-for-example-a-virtual-machine--this-documentation-describes-the-ibm-containers-api-which-is-based-on-the-docker-remote-api--the-api-provides-endpoints-that-you-can-use-to-create-and-manage-your-single-containers-and-container-groups-in-bluemix--endpoints-are-summarized-under-the-following-tags--authentication-retrieve-and-refresh-your-tls-certificates---private-docker-images-registry-create-your-own-private-docker-images-registry-in-bluemix-by-setting-a-namespace-for-your-organization---images-view-build-and-push-your-images-to-your-private-bluemix-registry-so-you-can-use-them-with-ibm-containers--you-can-also-scan-your-container-images-with-the-vulnerability-advisor-against-standard-policies-set-by-the-organization-manager-and-a-database-of-known-ubuntu-issues---single-containers-create-and-manage-single-containers-in-bluemix--use-a-single-container-to-implement-shortlived-processes-or-to-run-simple-tests-as-you-develop-an-app-or-service--to-make-your-single-container-available-from-the-internet-review-the-public-ip-addresses-endpoints---container-groups-create-and-manage-your-container-groups-in-bluemix--a-container-group-consists-of-multiple-single-containers-that-are-all-created-from-the-same-container-image-and-as-a-consequence-are-configured-in-the-same-way--container-groups-offer-further-options-at-no-cost-to-make-your-app-highly-available--these-options-include-inbuilt-load-balancing-autorecovery-of-unhealthy-container-instances-and-autoscaling-of-container-instances-based-on-cpu-and-memory-usage--map-a-public-route-to-your-container-group-to-make-your-app-accessible-from-the-internet----public-ip-addresses-use-these-endpoints-to-request-public-ip-addresses-for-your-space--you-can-bind-this-ip-address-to-your-container-to-make-your-container-accessible-from-the-internet---file-shares-create-list-and-delete-file-shares-in-a-space--a-file-share-is-a-nfs-storage-system-that-hosts-docker-volumes----volumes-create-and-manage-container-volumes-in-your-space-to-persist-the-data-of-your-containers----each-api-request-requires-an-http-header-that-includes-the-xauthtoken-and-xauthprojectid-parameter---xauthtoken-the-json-web-token-jwt-that-you-receive-when-logging-into-the-bluemix-platform--it-allows-you-to-use-the-ibm-containers-rest-api-access-services-and-resources--run-cf-oauthtoken-to-retrieve-your-access-token-information--xauthprojectid-the-unique-id-of-your-organization-space-where-you-want-to-create-or-work-with-your-containers--run-cf-space-space-name-guid-where-space-name-is-the-name-of-your-space-to-retrieve-your-space-id--for-further-information-about-how-containers-work-in-the-ibm-containers-service-review-the-documentation-under-httpsnewconsole-ng-bluemix-netdocscontainerscontainer-index-html--", "version"=>"3.0.0"}, "host"=>"containers-api.ng.bluemix.net", "basePath"=>"/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/build"=>{"post"=>{"summary"=>"Build a Docker image from a Dockerfile", "description"=>"This API builds a new container image from a Dockerfile that is stored on your local machine and pushes the image to the private Bluemix registry (corresponding IBM Containers command: `cf ic build`).\n\n To push an image to your Bluemix registry, a namespace must be set for the organization. Run `cf ic namespace get` or call the `GET /registry/namespaces` API to check if a namespace is already set. If not, run `cf ic namespace set NAMESPACE` or call the `PUT /registry/namespaces/{namespace}` API to set a namespace for your organization.", "operationId"=>"this-api-builds-a-new-container-image-from-a-dockerfile-that-is-stored-on-your-local-machine-and-pus", "x-api-path-slug"=>"build-post", "parameters"=>[{"in"=>"body", "name"=>"file", "description"=>"Must be the content of a tar archive compressed with gzip", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"nocache", "description"=>"If you set the query parameter to `nocache=true`, `nocache=True`, or `nocache=1`, the cache will not be used to build your image"}, {"in"=>"query", "name"=>"pull", "description"=>"If set to pull=true, pull=True, or pull=1, then a newer version of the image is always attempted to be pulled even though an older version of the image exists locally"}, {"in"=>"query", "name"=>"q", "description"=>"You can choose whether or not to show the verbose build output to review every step during the container image build"}, {"in"=>"query", "name"=>"t", "description"=>"Tag the image with the full path to your private Bluemix registry in the following format: `t=registry"}, {"in"=>"header", "name"=>"X-Auth-Project-Id", "description"=>"The unique ID of your organization space where you want to create or work with your containers"}, {"in"=>"header", "name"=>"X-Auth-Token", "description"=>"The Bluemix JSON web token that you receive when logging into Bluemix"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Build"]}}, "/containers/create"=>{"post"=>{"summary"=>"Create and start a single container", "description"=>"This endpoint creates and starts a single container in your space based on the Docker image that is specified in the Image field of the request json. A single container in IBM Containers is similar to a container that you create in your local Docker environment. Single containers are a good way to start with IBM Containers and to learn about how containers work in the IBM Cloud and the features that IBM Containers provides. They are also recommended when you want to run simple app tests or during the development process of an app. \n\n In the Docker API there are two separate APIs to create and start a container. However in IBM Containers a container is created and started in a single API call. Therefore, this API merges parameters from the Docker API to create and start container. \n\n To create a container with IBM Containers, you must at least define the image that the container is based on.\n\n- Image: You must include the full path to the image in your private Bluemix registry in the format: `registry.ng.bluemix.net/ |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
tumblr{"tumblr-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Tumblr", "x-complete"=>1, "info"=>{"title"=>"Tumblr", "description"=>"ntshare-photos-mobile-apps-and-social-network-using-tumblrs-apis-n----", "version"=>"1.0.0"}, "host"=>"api.tumblr.com", "basePath"=>"/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/blog/{base-hostname}/info"=>{"get"=>{"summary"=>"Get Blog Base Hostname Info", "description"=>"This method returns general information about the blog, such as the title, number of posts, and other high-level data.", "operationId"=>"blog.base_hostname.info.get", "x-api-path-slug"=>"blogbasehostnameinfo-get", "parameters"=>[{"in"=>"path", "name"=>"base-hostname", "description"=>"The unique hostname of the blog"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog", "Base", "Hostname", "Info"]}}, "/blog/{base-hostname}/avatar/{size}"=>{"get"=>{"summary"=>"Get Blog Base Hostname Avatar Size", "description"=>"Retrieves a blog's avatar in one of 9 different sizes.", "operationId"=>"blog.base_hostname.avatar.size.get", "x-api-path-slug"=>"blogbasehostnameavatarsize-get", "parameters"=>[{"in"=>"path", "name"=>"base-hostname", "description"=>"The unique hostname of the blog"}, {"in"=>"path", "name"=>"size", "description"=>"The size of the avatar (square, one value for both length and width)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog", "Base", "Hostname", "Avatar", "Size"]}}, "/blog/{base-hostname}/followers"=>{"get"=>{"summary"=>"Get Blog Base Hostname Followers", "description"=>"Retrieves a blog's followers.", "operationId"=>"blog.base_hostname.followers.get", "x-api-path-slug"=>"blogbasehostnamefollowers-get", "parameters"=>[{"in"=>"path", "name"=>"base-hostname", "description"=>"The unique hostname of the blog"}, {"in"=>"query", "name"=>"limit", "description"=>"The number of results to return: 1???20, inclusive"}, {"in"=>"query", "name"=>"offset", "description"=>"Result to start at"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog", "Base", "Hostname", "Followers"]}}, "/blog/{base-hostname}/posts/{type}"=>{"get"=>{"summary"=>"Get Blog Base Hostname Adds Type", "description"=>"Retrieves published posts.", "operationId"=>"blog.base_hostname.posts.type.get", "x-api-path-slug"=>"blogbasehostnamepoststype-get", "parameters"=>[{"in"=>"path", "name"=>"base-hostname", "description"=>"The unique hostname of the blog"}, {"in"=>"query", "name"=>"format", "description"=>"Specifies the post format to return, other than HTML"}, {"in"=>"query", "name"=>"id", "description"=>"A specific post ID"}, {"in"=>"query", "name"=>"limit", "description"=>"The number of posts to return: 1???20, inclusive"}, {"in"=>"query", "name"=>"notes_info", "description"=>"Indicates whether to return notes information (specify true or false)"}, {"in"=>"query", "name"=>"offset", "description"=>"Post number to start at"}, {"in"=>"query", "name"=>"reblog_info", "description"=>"Indicates whether to return reblog information (specify true or false)"}, {"in"=>"query", "name"=>"tag", "description"=>"Limits the response to posts with the specified tag"}, {"in"=>"path", "name"=>"type", "description"=>"The type of post to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog", "Base", "Hostname", "Posts", "Type"]}}, "/blog/{base-hostname}/posts/queue"=>{"get"=>{"summary"=>"Get Blog Base Hostname Adds Queue", "description"=>"Retrieves queued posts.", "operationId"=>"blog.base_hostname.posts.queue.get", "x-api-path-slug"=>"blogbasehostnamepostsqueue-get", "parameters"=>[{"in"=>"path", "name"=>"base-hostname", "description"=>"The unique hostname of the blog"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog", "Base", "Hostname", "Posts", "Queue"]}}, "/blog/{base-hostname}/posts/draft"=>{"get"=>{"summary"=>"Get Blog Base Hostname Adds Draft", "description"=>"Retrieves draft posts.", "operationId"=>"blog.base_hostname.posts.draft.get", "x-api-path-slug"=>"blogbasehostnamepostsdraft-get", "parameters"=>[{"in"=>"path", "name"=>"base-hostname", "description"=>"The unique hostname of the blog"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog", "Base", "Hostname", "Posts", "Draft"]}}, "/blog/{base-hostname}/posts/submission"=>{"get"=>{"summary"=>"Get Blog Base Hostname Adds Submission", "description"=>"Retrieves submission posts.", "operationId"=>"blog.base_hostname.posts.submission.get", "x-api-path-slug"=>"blogbasehostnamepostssubmission-get", "parameters"=>[{"in"=>"path", "name"=>"base-hostname", "description"=>"The unique hostname of the blog"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog", "Base", "Hostname", "Posts", "Submission"]}}, "/blog/{base-hostname}/post"=>{"post"=>{"summary"=>"Add Blog Base Hostname Add", "description"=>"Creates a new video blog post.", "operationId"=>"blog.base_hostname.post.post", "x-api-path-slug"=>"blogbasehostnamepost-post", "parameters"=>[{"in"=>"path", "name"=>"base-hostname", "description"=>"The unique hostname of the blog"}, {"in"=>"query", "name"=>"caption", "description"=>"The user-supplied caption"}, {"in"=>"query", "name"=>"data", "description"=>"A video file, as URL-encoded binary"}, {"in"=>"query", "name"=>"date", "description"=>"The GMT date and time of the post, as a string"}, {"in"=>"query", "name"=>"embed", "description"=>"HTML embed code for the video"}, {"in"=>"query", "name"=>"markdown", "description"=>"Indicates whether the post uses markdown syntax"}, {"in"=>"query", "name"=>"tags", "description"=>"Comma-separated tags for this post"}, {"in"=>"query", "name"=>"tweet", "description"=>"Manages the autotweet (if enabled) for this post: set to off for no tweet, or enter text to override the default tweet"}, {"in"=>"query", "name"=>"type", "description"=>"The type of post to create"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog", "Base", "Hostname", "Post"]}}, "/blog/{base-hostname}/post/edit"=>{"post"=>{"summary"=>"Add Blog Base Hostname Add Edit", "description"=>"Edits a blog post.", "operationId"=>"blog.base_hostname.post.edit.post", "x-api-path-slug"=>"blogbasehostnamepostedit-post", "parameters"=>[{"in"=>"path", "name"=>"base-hostname", "description"=>"The unique hostname of the blog"}, {"in"=>"query", "name"=>"date", "description"=>"The GMT date and time of the post, as a string"}, {"in"=>"query", "name"=>"id", "description"=>"The ID of the post to edit"}, {"in"=>"query", "name"=>"markdown", "description"=>"Indicates whether the post uses markdown syntax"}, {"in"=>"query", "name"=>"tags", "description"=>"Comma-separated tags for this post"}, {"in"=>"query", "name"=>"tweet", "description"=>"Manages the autotweet (if enabled) for this post: set to off for no tweet, or enter text to override the default tweet"}, {"in"=>"query", "name"=>"type", "description"=>"The post type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog", "Base", "Hostname", "Post", "Edit"]}}, "/blog/{base-hostname}/post/reblog"=>{"post"=>{"summary"=>"Add Blog Base Hostname Add Reblog", "description"=>"Reblogs a post.", "operationId"=>"blog.base_hostname.post.reblog.post", "x-api-path-slug"=>"blogbasehostnamepostreblog-post", "parameters"=>[{"in"=>"path", "name"=>"base-hostname", "description"=>"The unique hostname of the blog"}, {"in"=>"query", "name"=>"comment", "description"=>"A comment added to the reblogged post"}, {"in"=>"query", "name"=>"date", "description"=>"The GMT date and time of the post, as a string"}, {"in"=>"query", "name"=>"id", "description"=>"The ID of the reblogged post on tumblelog"}, {"in"=>"query", "name"=>"markdown", "description"=>"Indicates whether the post uses markdown syntax"}, {"in"=>"query", "name"=>"reblog_key", "description"=>"The reblog key for the reblogged post ??? get the reblog key with a /posts request"}, {"in"=>"query", "name"=>"tags", "description"=>"Comma-separated tags for this post"}, {"in"=>"query", "name"=>"tweet", "description"=>"Manages the autotweet (if enabled) for this post: set to off for no tweet, or enter text to override the default tweet"}, {"in"=>"query", "name"=>"type", "description"=>"The post type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog", "Base", "Hostname", "Post", "Reblog"]}}, "/blog/{base-hostname}/post/delete"=>{"post"=>{"summary"=>"Add Blog Base Hostname Add Delete", "description"=>"Deletes a post.", "operationId"=>"blog.base_hostname.post.delete.post", "x-api-path-slug"=>"blogbasehostnamepostdelete-post", "parameters"=>[{"in"=>"path", "name"=>"base-hostname", "description"=>"The unique hostname of the blog"}, {"in"=>"query", "name"=>"id", "description"=>"The ID of the post to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog", "Base", "Hostname", "Post", "Delete"]}}, "/user/dashboard"=>{"get"=>{"summary"=>"Get User Dashboard", "description"=>"Use this method to retrieve the dashboard that matches the OAuth credentials submitted with the request.", "operationId"=>"user.dashboard.get", "x-api-path-slug"=>"userdashboard-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"The number of results to return: 1???20, inclusive"}, {"in"=>"query", "name"=>"offset", "description"=>"Post number to start at"}, {"in"=>"query", "name"=>"since_id", "description"=>"Return posts that have appeared after this ID"}, {"in"=>"query", "name"=>"type", "description"=>"The type of post to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Dashboard"]}}, "/user/likes"=>{"get"=>{"summary"=>"Get User Likes", "description"=>"Use this method to retrieve the liked posts that match the OAuth credentials submitted with the request.", "operationId"=>"user.likes.get", "x-api-path-slug"=>"userlikes-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"The number of results to return: 1???20, inclusive"}, {"in"=>"query", "name"=>"offset", "description"=>"Liked post number to start at"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Likes"]}}, "/user/following"=>{"get"=>{"summary"=>"Get User Following", "description"=>"Use this method to retrieve the blogs followed by the user whose OAuth credentials are submitted with the request.", "operationId"=>"user.following.get", "x-api-path-slug"=>"userfollowing-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"The number of results to return: 1???20, inclusive"}, {"in"=>"query", "name"=>"offset", "description"=>"Result number to start at"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Following"]}}, "/user/follow"=>{"post"=>{"summary"=>"Add User Follow", "description"=>"Follow a blog.", "operationId"=>"user.follow.post", "x-api-path-slug"=>"userfollow-post", "parameters"=>[{"in"=>"query", "name"=>"url", "description"=>"The URL of the blog to follow"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Follow"]}}, "/user/unfollow"=>{"post"=>{"summary"=>"Add User Unfollow", "description"=>"Unfollow a blog.", "operationId"=>"user.unfollow.post", "x-api-path-slug"=>"userunfollow-post", "parameters"=>[{"in"=>"query", "name"=>"url", "description"=>"The URL of the blog to unfollow"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Unfollow"]}}}}, "apis"=>{"name"=>"Tumblr", "x-slug"=>"tumblr", "description"=>"Tumblr is a place to express yourself, discover yourself, and bond over the stuff you love. Its where your interests connect you with your people.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/265-tumblr.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"59", "tags"=>"Blog,Blogging,Communications,Communications,Content,General Data,Historical Data API,internet,Media,Mobile,Pedestal,Relative Data,Relative StreamRank,Service API,Social,Stack,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"tumblr/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Tumblr", "x-api-slug"=>"tumblr", "description"=>"Tumblr, is a microblogging platform, emphasizing ease of use, that allows users to post text, images, videos, links, quotes and audio to their tumblelog, a short-form blog. Users can follow other users, or choose to make their tumblelog private.The Tumblr API is currently in its version 2.0, and provides a RESTful API that takes advantage of a URI structured including version system(such as blog or user), and allows blog owners to use a custom tumblr blog URL or custom domains. The API uses OAuth for user authentication and all responses in JSON, with JSONP also available. The API provides access to Tumblr Blogs in addition to other characteristics like avatars, followers, photos, audio, video and other user related information.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/265-tumblr.jpg", "humanURL"=>"https://www.tumblr.com/", "baseURL"=>"https://api.tumblr.com//v2/", "tags"=>"Blog,Blogging,Communications,Communications,Content,General Data,Historical Data API,internet,Media,Mobile,Pedestal,Relative Data,Relative StreamRank,Service API,Social,Stack,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/tumblr/userunfollow-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/tumblr/tumblr-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-api-json--authoritative", "url"=>"http://apis.io/apisdef/legacy/tumblr.json"}, {"type"=>"x-base", "url"=>"http://api.tumblr.com"}, {"type"=>"x-blog", "url"=>"http://staff.tumblr.com/"}, {"type"=>"x-blog-rss", "url"=>"http://staff.tumblr.com/rss"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/tumblr"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/tumblr"}, {"type"=>"x-developer", "url"=>"https://www.tumblr.com/docs/en/api/v2"}, {"type"=>"x-github", "url"=>"https://github.com/tumblr"}, {"type"=>"x-transparency-report", "url"=>"https://www.tumblr.com/transparency"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/tumblr"}, {"type"=>"x-website", "url"=>"https://www.tumblr.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
etsy{"etsy-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Etsy", "x-complete"=>1, "info"=>{"title"=>"Etsy", "description"=>"bring-etsys-handmade-marketplace-and-community-into-your-apps-", "version"=>"1.0.0"}, "host"=>"openapi.etsy.com", "basePath"=>"/v2/private/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/countries/{country_id}"=>{"get"=>{"summary"=>"Get Countries Country", "description"=>"Retrieves a Country by id.", "operationId"=>"getCountriesCountry", "x-api-path-slug"=>"countriescountry-id-get", "parameters"=>[{"in"=>"path", "name"=>"country_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countries", "Country"]}}, "/countries"=>{"get"=>{"summary"=>"Get Countries", "description"=>"Finds all Country.", "operationId"=>"getCountries", "x-api-path-slug"=>"countries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countries"]}}, "/users/{user_id}/favorites/listings"=>{"get"=>{"summary"=>"Get Users User Favorites Listings", "description"=>"Finds all favorite listings for a user", "operationId"=>"getUsersUserFavoritesListings", "x-api-path-slug"=>"usersuser-idfavoriteslistings-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Favorites", "Listings"]}}, "/users/{user_id}/favorites/listings/{listing_id}"=>{"get"=>{"summary"=>"Get Users User Favorites Listings Listing", "description"=>"Finds a favorite listing for a user", "operationId"=>"getUsersUserFavoritesListingsListing", "x-api-path-slug"=>"usersuser-idfavoriteslistingslisting-id-get", "parameters"=>[{"in"=>"path", "name"=>"listing_id"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Favorites", "Listings"]}, "post"=>{"summary"=>"Post Users User Favorites Listings Listing", "description"=>"Creates a new favorite listing for a user", "operationId"=>"postUsersUserFavoritesListingsListing", "x-api-path-slug"=>"usersuser-idfavoriteslistingslisting-id-post", "parameters"=>[{"in"=>"path", "name"=>"listing_id"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Favorites", "Listings"]}, "delete"=>{"summary"=>"Delete Users User Favorites Listings Listing", "description"=>"Delete a favorite listing for a user", "operationId"=>"deleteUsersUserFavoritesListingsListing", "x-api-path-slug"=>"usersuser-idfavoriteslistingslisting-id-delete", "parameters"=>[{"in"=>"path", "name"=>"listing_id"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Favorites", "Listings"]}}, "/users/{user_id}/favorites/users"=>{"get"=>{"summary"=>"Get Users User Favorites Users", "description"=>"Finds all favorite users for a user", "operationId"=>"getUsersUserFavoritesUsers", "x-api-path-slug"=>"usersuser-idfavoritesusers-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Favorites", "Users"]}}, "/users/{user_id}/favorites/users/{target_user_id}"=>{"get"=>{"summary"=>"Get Users User Favorites Users Target User", "description"=>"Finds a favorite user for a user", "operationId"=>"getUsersUserFavoritesUsersTargetUser", "x-api-path-slug"=>"usersuser-idfavoritesuserstarget-user-id-get", "parameters"=>[{"in"=>"path", "name"=>"target_user_id"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Favorites", "Users", "Target", "User"]}, "post"=>{"summary"=>"Post Users User Favorites Users Target User", "description"=>"Creates a new favorite listing for a user", "operationId"=>"postUsersUserFavoritesUsersTargetUser", "x-api-path-slug"=>"usersuser-idfavoritesuserstarget-user-id-post", "parameters"=>[{"in"=>"path", "name"=>"target_user_id"}, {"in"=>"query", "name"=>"target_user_id"}, {"in"=>"path", "name"=>"user_id"}, {"in"=>"query", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Favorites", "Users", "Target", "User"]}, "delete"=>{"summary"=>"Delete Users User Favorites Users Target User", "description"=>"Delete a favorite listing for a user", "operationId"=>"deleteUsersUserFavoritesUsersTargetUser", "x-api-path-slug"=>"usersuser-idfavoritesuserstarget-user-id-delete", "parameters"=>[{"in"=>"path", "name"=>"target_user_id"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Favorites", "Users", "Target", "User"]}}, "/homepages/pickers/"=>{"get"=>{"summary"=>"Get Homepages Pickers", "description"=>"Finds all FeaturedListingPicker in scope active.", "operationId"=>"getHomepagesPickers", "x-api-path-slug"=>"homepagespickers-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Home Pages", "Pickers"]}}, "/homepages/pickers/{featured_listing_picker_id}"=>{"get"=>{"summary"=>"Get Homepages Pickers Featured Listing Picker", "description"=>"Retrieves a FeaturedListingPicker by id.", "operationId"=>"getHomepagesPickersFeaturedListingPicker", "x-api-path-slug"=>"homepagespickersfeatured-listing-picker-id-get", "parameters"=>[{"in"=>"path", "name"=>"featured_listing_picker_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Home Pages", "Pickers", "Featured", "Listing", "Picker"]}}, "/homepages/pickers/{featured_listing_picker_id}/featured"=>{"get"=>{"summary"=>"Get Homepages Pickers Featured Listing Picker Featured", "description"=>"Retrieves a set of FeaturedListing objects associated to a FeaturedListingPicker.", "operationId"=>"getHomepagesPickersFeaturedListingPickerFeatured", "x-api-path-slug"=>"homepagespickersfeatured-listing-picker-idfeatured-get", "parameters"=>[{"in"=>"path", "name"=>"featured_listing_picker_id"}, {"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Home Pages", "Pickers", "Featured", "Listing", "Picker", "Featured"]}}, "/homepages/pickers/{featured_listing_picker_id}/listings"=>{"get"=>{"summary"=>"Get Homepages Pickers Featured Listing Picker Listings", "description"=>"Retrieves a set of Listing objects associated to a FeaturedListingPicker.", "operationId"=>"getHomepagesPickersFeaturedListingPickerListings", "x-api-path-slug"=>"homepagespickersfeatured-listing-picker-idlistings-get", "parameters"=>[{"in"=>"path", "name"=>"featured_listing_picker_id"}, {"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Home Pages", "Pickers", "Featured", "Listing", "Picker", "Listings"]}}, "/homepages/pickers/{featured_listing_picker_id}/listings/active"=>{"get"=>{"summary"=>"Get Homepages Pickers Featured Listing Picker Listings Active", "description"=>"Retrieves a set of Listing objects associated to a FeaturedListingPicker in scope active.", "operationId"=>"getHomepagesPickersFeaturedListingPickerListingsActive", "x-api-path-slug"=>"homepagespickersfeatured-listing-picker-idlistingsactive-get", "parameters"=>[{"in"=>"path", "name"=>"featured_listing_picker_id"}, {"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Home Pages", "Pickers", "Featured", "Listing", "Picker", "Listings", "Active"]}}, "/homepages/listings/"=>{"get"=>{"summary"=>"Get Homepages Listings", "description"=>"Finds all FeaturedListings regardless of Listing state", "operationId"=>"getHomepagesListings", "x-api-path-slug"=>"homepageslistings-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Home Pages", "Listings"]}}, "/homepages/listings/active"=>{"get"=>{"summary"=>"Get Homepages Listings Active", "description"=>"Finds all FeaturedListings that point to active Listings", "operationId"=>"getHomepagesListingsActive", "x-api-path-slug"=>"homepageslistingsactive-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Home Pages", "Listings", "Active"]}}, "/homepages/listings/{featured_listing_id}"=>{"get"=>{"summary"=>"Get Homepages Listings Featured Listing", "description"=>"Retrieves a FeaturedListing by id.", "operationId"=>"getHomepagesListingsFeaturedListing", "x-api-path-slug"=>"homepageslistingsfeatured-listing-id-get", "parameters"=>[{"in"=>"path", "name"=>"featured_listing_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Home Pages", "Listings", "Featured", "Listing"]}}, "/homepages/listings/{featured_listing_id}/picker"=>{"get"=>{"summary"=>"Get Homepages Listings Featured Listing Picker", "description"=>"Retrieves a set of FeaturedListingPicker objects associated to a FeaturedListing.", "operationId"=>"getHomepagesListingsFeaturedListingPicker", "x-api-path-slug"=>"homepageslistingsfeatured-listing-idpicker-get", "parameters"=>[{"in"=>"path", "name"=>"featured_listing_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Home Pages", "Listings", "Featured", "Listing", "Picker"]}}, "/homepages/listings/{featured_listing_id}/listing"=>{"get"=>{"summary"=>"Get Homepages Listings Featured Listing Listing", "description"=>"Retrieves a set of Listing objects associated to a FeaturedListing.", "operationId"=>"getHomepagesListingsFeaturedListingListing", "x-api-path-slug"=>"homepageslistingsfeatured-listing-idlisting-get", "parameters"=>[{"in"=>"path", "name"=>"featured_listing_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Home Pages", "Listings", "Featured", "Listing", "Listing"]}}, "/listings/{listing_id}/images/{listing_image_id}"=>{"get"=>{"summary"=>"Get Listings Listing Images Listing Image", "description"=>"Retrieves a ListingImage by id.", "operationId"=>"getListingsListingImagesListingImage", "x-api-path-slug"=>"listingslisting-idimageslisting-image-id-get", "parameters"=>[{"in"=>"path", "name"=>"listing_id"}, {"in"=>"path", "name"=>"listing_image_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Images", "Listing", "Image"]}, "delete"=>{"summary"=>"Delete Listings Listing Images Listing Image", "description"=>"Deletes a listing image", "operationId"=>"deleteListingsListingImagesListingImage", "x-api-path-slug"=>"listingslisting-idimageslisting-image-id-delete", "parameters"=>[{"in"=>"path", "name"=>"listing_id"}, {"in"=>"path", "name"=>"listing_image_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Images", "Listing", "Image"]}}, "/listings/{listing_id}/images"=>{"post"=>{"summary"=>"Post Listings Listing Images", "description"=>"Upload a new listing image", "operationId"=>"postListingsListingImages", "x-api-path-slug"=>"listingslisting-idimages-post", "parameters"=>[{"in"=>"query", "name"=>"image"}, {"in"=>"path", "name"=>"listing_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Images"]}, "get"=>{"summary"=>"Get Listings Listing Images", "description"=>"Retrieves a set of ListingImage objects associated to a Listing.", "operationId"=>"getListingsListingImages", "x-api-path-slug"=>"listingslisting-idimages-get", "parameters"=>[{"in"=>"path", "name"=>"listing_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Images"]}}, "/listings/{listing_id}"=>{"get"=>{"summary"=>"Get Listings Listing", "description"=>"Retrieves a Listing by id.", "operationId"=>"getListingsListing", "x-api-path-slug"=>"listingslisting-id-get", "parameters"=>[{"in"=>"path", "name"=>"listing_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings"]}, "put"=>{"summary"=>"Put Listings Listing", "description"=>"Updates a Listing", "operationId"=>"putListingsListing", "x-api-path-slug"=>"listingslisting-id-put", "parameters"=>[{"in"=>"query", "name"=>"description"}, {"in"=>"path", "name"=>"listing_id"}, {"in"=>"query", "name"=>"materials"}, {"in"=>"query", "name"=>"price"}, {"in"=>"query", "name"=>"quantity"}, {"in"=>"query", "name"=>"renew"}, {"in"=>"query", "name"=>"shipping_template_id"}, {"in"=>"query", "name"=>"shop_section_id"}, {"in"=>"query", "name"=>"state"}, {"in"=>"query", "name"=>"tags"}, {"in"=>"query", "name"=>"title"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings"]}, "delete"=>{"summary"=>"Delete Listings Listing", "description"=>"Deletes a Listing", "operationId"=>"deleteListingsListing", "x-api-path-slug"=>"listingslisting-id-delete", "parameters"=>[{"in"=>"path", "name"=>"listing_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings"]}}, "/listings/{listing_id}/favored-by"=>{"get"=>{"summary"=>"Get Listings Listing Favored By", "description"=>"Retrieves a set of FavoriteListing objects associated to a Listing.", "operationId"=>"getListingsListingFavoredBy", "x-api-path-slug"=>"listingslisting-idfavoredby-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"listing_id"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Favored-by"]}}, "/listings/{listing_id}/shipping/info"=>{"get"=>{"summary"=>"Get Listings Listing Shipping Info", "description"=>"Retrieves a set of ShippingInfo objects associated to a Listing.", "operationId"=>"getListingsListingShippingInfo", "x-api-path-slug"=>"listingslisting-idshippinginfo-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"listing_id"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Shipping", "Info"]}, "post"=>{"summary"=>"Post Listings Listing Shipping Info", "description"=>"Creates a new ShippingInfo.", "operationId"=>"postListingsListingShippingInfo", "x-api-path-slug"=>"listingslisting-idshippinginfo-post", "parameters"=>[{"in"=>"query", "name"=>"destination_country_id"}, {"in"=>"path", "name"=>"listing_id"}, {"in"=>"query", "name"=>"origin_country_id"}, {"in"=>"query", "name"=>"primary_cost"}, {"in"=>"query", "name"=>"region_id"}, {"in"=>"query", "name"=>"secondary_cost"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Shipping", "Info"]}}, "/listings/{listing_id}/payments"=>{"get"=>{"summary"=>"Get Listings Listing Payments", "description"=>"Retrieves a set of ListingPayment objects associated to a Listing.", "operationId"=>"getListingsListingPayments", "x-api-path-slug"=>"listingslisting-idpayments-get", "parameters"=>[{"in"=>"path", "name"=>"listing_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Payments"]}}, "/listings/active"=>{"get"=>{"summary"=>"Get Listings Active", "description"=>"Finds all active Listing", "operationId"=>"getListingsActive", "x-api-path-slug"=>"listingsactive-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"color", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"color_accuracy", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"keywords", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"materials", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"max_price", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"min_price", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"sort_on", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"tags", "description"=>"Bring Etsys handmade marketplace and community into your apps"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Active"]}}, "/shops/{shop_id}/listings/active"=>{"get"=>{"summary"=>"Get Shops Shop Listings Active", "description"=>"Finds all active Listings associated with a Shop", "operationId"=>"getShopsShopListingsActive", "x-api-path-slug"=>"shopsshop-idlistingsactive-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"color", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"color_accuracy", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"keywords", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"materials", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"max_price", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"min_price", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"shop_id"}, {"in"=>"query", "name"=>"sort_on", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"tags", "description"=>"Bring Etsys handmade marketplace and community into your apps"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Shop", "Listings", "Active"]}}, "/listings"=>{"post"=>{"summary"=>"Post Listings", "description"=>"Creates a new Listing", "operationId"=>"postListings", "x-api-path-slug"=>"listings-post", "parameters"=>[{"in"=>"query", "name"=>"description"}, {"in"=>"query", "name"=>"materials"}, {"in"=>"query", "name"=>"price"}, {"in"=>"query", "name"=>"quantity"}, {"in"=>"query", "name"=>"shipping_template_id"}, {"in"=>"query", "name"=>"shop_section_id"}, {"in"=>"query", "name"=>"tags"}, {"in"=>"query", "name"=>"title"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings"]}}, "/orders/{order_id}"=>{"get"=>{"summary"=>"Get Orders Order", "description"=>"Retrieves a Order by id.", "operationId"=>"getOrdersOrder", "x-api-path-slug"=>"ordersorder-id-get", "parameters"=>[{"in"=>"path", "name"=>"order_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Order"]}}, "/orders/{order_id}/receipts"=>{"get"=>{"summary"=>"Get Orders Order Receipts", "description"=>"Retrieves a set of Receipt objects associated to a Order.", "operationId"=>"getOrdersOrderReceipts", "x-api-path-slug"=>"ordersorder-idreceipts-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"order_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Order", "Receipts"]}}, "/receipts/{receipt_id}"=>{"get"=>{"summary"=>"Get Receipts Receipt", "description"=>"Retrieves a Receipt by id.", "operationId"=>"getReceiptsReceipt", "x-api-path-slug"=>"receiptsreceipt-id-get", "parameters"=>[{"in"=>"path", "name"=>"receipt_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipts", "Receipt"]}, "put"=>{"summary"=>"Put Receipts Receipt", "description"=>"Updates a Receipt", "operationId"=>"putReceiptsReceipt", "x-api-path-slug"=>"receiptsreceipt-id-put", "parameters"=>[{"in"=>"query", "name"=>"message_from_buyer"}, {"in"=>"query", "name"=>"message_from_seller"}, {"in"=>"query", "name"=>"receipt_id"}, {"in"=>"path", "name"=>"receipt_id"}, {"in"=>"query", "name"=>"was_paid"}, {"in"=>"query", "name"=>"was_shipped"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipts", "Receipt"]}}, "/receipts/{receipt_id}/transactions"=>{"get"=>{"summary"=>"Get Receipts Receipt Transactions", "description"=>"Retrieves a set of Transaction objects associated to a Receipt.", "operationId"=>"getReceiptsReceiptTransactions", "x-api-path-slug"=>"receiptsreceipt-idtransactions-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"receipt_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Receipts", "Receipt", "Transactions"]}}, "/users/{user_id}/recommended_listings"=>{"get"=>{"summary"=>"Get Users User Recommended Listings", "description"=>"Get recommended listings for an authenticated member. The number of listings returned may not match the specified limit if there is no activity from recommended shops.", "operationId"=>"getUsersUserRecommendedListings", "x-api-path-slug"=>"usersuser-idrecommended-listings-get", "parameters"=>[{"in"=>"query", "name"=>"excluded_listing_ids", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Recommended", "Listings"]}}, "/users/{user_id}/recommended_listings/rejects/{listing_ids}"=>{"post"=>{"summary"=>"Post Users User Recommended Listings Rejects Listing S", "description"=>"Registers rejections of recommended listings. Affects future recommended listings.", "operationId"=>"postUsersUserRecommendedListingsRejectsListingS", "x-api-path-slug"=>"usersuser-idrecommended-listingsrejectslisting-ids-post", "parameters"=>[{"in"=>"path", "name"=>"listing_ids"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Recommended", "Listings", "Rejects", "Listings"]}}, "/users/{user_id}/recommended_listings/views/{listing_ids}"=>{"post"=>{"summary"=>"Post Users User Recommended Listings Views Listing S", "description"=>"Register viewings of recommended listings. Affects future recommended listings.", "operationId"=>"postUsersUserRecommendedListingsViewsListingS", "x-api-path-slug"=>"usersuser-idrecommended-listingsviewslisting-ids-post", "parameters"=>[{"in"=>"path", "name"=>"listing_ids"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Recommended", "Listings", "Views", "Listings"]}}, "/regions/{region_id}"=>{"get"=>{"summary"=>"Get Regions Region", "description"=>"Retrieves a Region by id.", "operationId"=>"getRegionsRegion", "x-api-path-slug"=>"regionsregion-id-get", "parameters"=>[{"in"=>"path", "name"=>"region_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions", "Region"]}}, "/regions"=>{"get"=>{"summary"=>"Get Regions", "description"=>"Finds all Region.", "operationId"=>"getRegions", "x-api-path-slug"=>"regions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions"]}}, "/shipping/info/{shipping_info_id}"=>{"get"=>{"summary"=>"Get Shipping Info Shipping Info", "description"=>"Retrieves a ShippingInfo by id.", "operationId"=>"getShippingInfoShippingInfo", "x-api-path-slug"=>"shippinginfoshipping-info-id-get", "parameters"=>[{"in"=>"path", "name"=>"shipping_info_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Info", "Shipping", "Info"]}, "put"=>{"summary"=>"Put Shipping Info Shipping Info", "description"=>"Updates a ShippingInfo with the given id.", "operationId"=>"putShippingInfoShippingInfo", "x-api-path-slug"=>"shippinginfoshipping-info-id-put", "parameters"=>[{"in"=>"query", "name"=>"destination_country_id"}, {"in"=>"query", "name"=>"listing_id"}, {"in"=>"query", "name"=>"origin_country_id"}, {"in"=>"query", "name"=>"primary_cost"}, {"in"=>"query", "name"=>"region_id"}, {"in"=>"query", "name"=>"secondary_cost"}, {"in"=>"path", "name"=>"shipping_info_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Info", "Shipping", "Info"]}, "delete"=>{"summary"=>"Delete Shipping Info Shipping Info", "description"=>"Deletes the ShippingInfo with the given id.", "operationId"=>"deleteShippingInfoShippingInfo", "x-api-path-slug"=>"shippinginfoshipping-info-id-delete", "parameters"=>[{"in"=>"path", "name"=>"shipping_info_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Info", "Shipping", "Info"]}}, "/shipping/templates/entries/{shipping_template_entry_id}"=>{"get"=>{"summary"=>"Get Shipping Templates Entries Shipping Template Entry", "description"=>"Retrieves a ShippingTemplateEntry by id.", "operationId"=>"getShippingTemplatesEntriesShippingTemplateEntry", "x-api-path-slug"=>"shippingtemplatesentriesshipping-template-entry-id-get", "parameters"=>[{"in"=>"path", "name"=>"shipping_template_entry_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Templates", "Entries", "Shipping", "Template", "Entry"]}, "put"=>{"summary"=>"Put Shipping Templates Entries Shipping Template Entry", "description"=>"Updates a ShippingTemplateEntry", "operationId"=>"putShippingTemplatesEntriesShippingTemplateEntry", "x-api-path-slug"=>"shippingtemplatesentriesshipping-template-entry-id-put", "parameters"=>[{"in"=>"query", "name"=>"destination_country_id"}, {"in"=>"query", "name"=>"primary_cost"}, {"in"=>"query", "name"=>"secondary_cost"}, {"in"=>"path", "name"=>"shipping_template_entry_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Templates", "Entries", "Shipping", "Template", "Entry"]}, "delete"=>{"summary"=>"Delete Shipping Templates Entries Shipping Template Entry", "description"=>"Deletes a ShippingTemplateEntry", "operationId"=>"deleteShippingTemplatesEntriesShippingTemplateEntry", "x-api-path-slug"=>"shippingtemplatesentriesshipping-template-entry-id-delete", "parameters"=>[{"in"=>"path", "name"=>"shipping_template_entry_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Templates", "Entries", "Shipping", "Template", "Entry"]}}, "/shipping/templates/entries"=>{"post"=>{"summary"=>"Post Shipping Templates Entries", "description"=>"Creates a new ShippingTemplateEntry", "operationId"=>"postShippingTemplatesEntries", "x-api-path-slug"=>"shippingtemplatesentries-post", "parameters"=>[{"in"=>"query", "name"=>"destination_country_id"}, {"in"=>"query", "name"=>"destination_region_id"}, {"in"=>"query", "name"=>"primary_cost"}, {"in"=>"query", "name"=>"secondary_cost"}, {"in"=>"query", "name"=>"shipping_template_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Templates", "Entries"]}}, "/shipping/templates/{shipping_template_id}"=>{"get"=>{"summary"=>"Get Shipping Templates Shipping Template", "description"=>"Retrieves a ShippingTemplate by id.", "operationId"=>"getShippingTemplatesShippingTemplate", "x-api-path-slug"=>"shippingtemplatesshipping-template-id-get", "parameters"=>[{"in"=>"path", "name"=>"shipping_template_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Templates", "Shipping", "Template"]}, "delete"=>{"summary"=>"Delete Shipping Templates Shipping Template", "description"=>"Deletes the ShippingTemplate with the given id.", "operationId"=>"deleteShippingTemplatesShippingTemplate", "x-api-path-slug"=>"shippingtemplatesshipping-template-id-delete", "parameters"=>[{"in"=>"path", "name"=>"shipping_template_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Templates", "Shipping", "Template"]}, "put"=>{"summary"=>"Put Shipping Templates Shipping Template", "description"=>"Updates a ShippingTemplate", "operationId"=>"putShippingTemplatesShippingTemplate", "x-api-path-slug"=>"shippingtemplatesshipping-template-id-put", "parameters"=>[{"in"=>"query", "name"=>"origin_country_id"}, {"in"=>"path", "name"=>"shipping_template_id"}, {"in"=>"query", "name"=>"title"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Templates", "Shipping", "Template"]}}, "/shipping/templates/{shipping_template_id}/entries"=>{"get"=>{"summary"=>"Get Shipping Templates Shipping Template Entries", "description"=>"Retrieves a set of ShippingTemplateEntry objects associated to a ShippingTemplate.", "operationId"=>"getShippingTemplatesShippingTemplateEntries", "x-api-path-slug"=>"shippingtemplatesshipping-template-identries-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"shipping_template_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Templates", "Shipping", "Template", "Entries"]}}, "/shipping/templates"=>{"post"=>{"summary"=>"Post Shipping Templates", "description"=>"Creates a new ShippingTemplate", "operationId"=>"postShippingTemplates", "x-api-path-slug"=>"shippingtemplates-post", "parameters"=>[{"in"=>"query", "name"=>"destination_country_id"}, {"in"=>"query", "name"=>"destination_region_id"}, {"in"=>"query", "name"=>"origin_country_id"}, {"in"=>"query", "name"=>"primary_cost"}, {"in"=>"query", "name"=>"secondary_cost"}, {"in"=>"query", "name"=>"title"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Templates"]}}, "/shops/{shop_id}"=>{"get"=>{"summary"=>"Get Shops Shop", "description"=>"Retrieves a Shop by id.", "operationId"=>"getShopsShop", "x-api-path-slug"=>"shopsshop-id-get", "parameters"=>[{"in"=>"path", "name"=>"shop_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Shop"]}, "put"=>{"summary"=>"Put Shops Shop", "description"=>"Updates a Shop", "operationId"=>"putShopsShop", "x-api-path-slug"=>"shopsshop-id-put", "parameters"=>[{"in"=>"query", "name"=>"alchemy_message"}, {"in"=>"query", "name"=>"announcement"}, {"in"=>"query", "name"=>"is_refusing_alchemy"}, {"in"=>"query", "name"=>"policy_additional"}, {"in"=>"query", "name"=>"policy_payment"}, {"in"=>"query", "name"=>"policy_refunds"}, {"in"=>"query", "name"=>"policy_shipping"}, {"in"=>"query", "name"=>"policy_welcome"}, {"in"=>"query", "name"=>"sale_message"}, {"in"=>"path", "name"=>"shop_id"}, {"in"=>"query", "name"=>"title"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Shop"]}}, "/shops/{shop_id}/receipts"=>{"get"=>{"summary"=>"Get Shops Shop Receipts", "description"=>"Retrieves a set of Receipt objects associated to a Shop.", "operationId"=>"getShopsShopReceipts", "x-api-path-slug"=>"shopsshop-idreceipts-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"shop_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Shop", "Receipts"]}}, "/shops/{shop_id}/transactions"=>{"get"=>{"summary"=>"Get Shops Shop Transactions", "description"=>"Retrieves a set of Transaction objects associated to a Shop.", "operationId"=>"getShopsShopTransactions", "x-api-path-slug"=>"shopsshop-idtransactions-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"shop_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Shop", "Transactions"]}}, "/shops/{shop_id}/sections"=>{"get"=>{"summary"=>"Get Shops Shop Sections", "description"=>"Retrieves a set of ShopSection objects associated to a Shop.", "operationId"=>"getShopsShopSections", "x-api-path-slug"=>"shopsshop-idsections-get", "parameters"=>[{"in"=>"path", "name"=>"shop_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Shop", "Sections"]}}, "/shops"=>{"get"=>{"summary"=>"Get Shops", "description"=>"Finds all Shops. If there is a keywords parameter, finds shops with shop_name starting with keywords.", "operationId"=>"getShops", "x-api-path-slug"=>"shops-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"shop_name", "description"=>"Bring Etsys handmade marketplace and community into your apps"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops"]}}, "/shops/{shop_id}/listings/featured"=>{"get"=>{"summary"=>"Get Shops Shop Listings Featured", "description"=>"Retrieves Listings associated to a Shop that are featured", "operationId"=>"getShopsShopListingsFeatured", "x-api-path-slug"=>"shopsshop-idlistingsfeatured-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"shop_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Shop", "Listings", "Featured"]}}, "/shops/{shop_id}/listings/inactive"=>{"get"=>{"summary"=>"Get Shops Shop Listings Inactive", "description"=>"Retrieves Listings associated to a Shop that are inactive", "operationId"=>"getShopsShopListingsInactive", "x-api-path-slug"=>"shopsshop-idlistingsinactive-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"shop_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Shop", "Listings", "Inactive"]}}, "/shops/{shop_id}/listings/expired"=>{"get"=>{"summary"=>"Get Shops Shop Listings Expired", "description"=>"Retrieves Listings associated to a Shop that are expired", "operationId"=>"getShopsShopListingsExpired", "x-api-path-slug"=>"shopsshop-idlistingsexpired-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"shop_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Shop", "Listings", "Expired"]}}, "/shops/{shop_id}/listings/inactive/{listing_id}"=>{"get"=>{"summary"=>"Get Shops Shop Listings Inactive Listing", "description"=>"Retrieves a Listing associated to a Shop that is inactive", "operationId"=>"getShopsShopListingsInactiveListing", "x-api-path-slug"=>"shopsshop-idlistingsinactivelisting-id-get", "parameters"=>[{"in"=>"path", "name"=>"listing_id"}, {"in"=>"path", "name"=>"shop_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Shop", "Listings", "Inactive", "Listing"]}}, "/shops/{shop_id}/listings/expired/{listing_id}"=>{"get"=>{"summary"=>"Get Shops Shop Listings Expired Listing", "description"=>"Retrieves a Listing associated to a Shop that is inactive", "operationId"=>"getShopsShopListingsExpiredListing", "x-api-path-slug"=>"shopsshop-idlistingsexpiredlisting-id-get", "parameters"=>[{"in"=>"path", "name"=>"listing_id"}, {"in"=>"path", "name"=>"shop_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Shop", "Listings", "Expired", "Listing"]}}, "/shops/{shop_id}/appearance/banner"=>{"post"=>{"summary"=>"Post Shops Shop Appearance Banner", "description"=>"Upload a new shop banner image", "operationId"=>"postShopsShopAppearanceBanner", "x-api-path-slug"=>"shopsshop-idappearancebanner-post", "parameters"=>[{"in"=>"query", "name"=>"image"}, {"in"=>"path", "name"=>"shop_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Shop", "Appearance", "Banner"]}}, "/shops/{shop_id}/appearance/banner/{shop_banner_id}"=>{"delete"=>{"summary"=>"Delete Shops Shop Appearance Banner Shop Banner", "description"=>"Deletes a shop banner image", "operationId"=>"deleteShopsShopAppearanceBannerShopBanner", "x-api-path-slug"=>"shopsshop-idappearancebannershop-banner-id-delete", "parameters"=>[{"in"=>"path", "name"=>"shop_banner_id"}, {"in"=>"path", "name"=>"shop_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Shop", "Appearance", "Banner", "Shop", "Banner"]}}, "/sections/{shop_section_id}"=>{"get"=>{"summary"=>"Get Sections Shop Section", "description"=>"Retrieves a ShopSection by id.", "operationId"=>"getSectionsShopSection", "x-api-path-slug"=>"sectionsshop-section-id-get", "parameters"=>[{"in"=>"path", "name"=>"shop_section_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Shop", "Section"]}, "put"=>{"summary"=>"Put Sections Shop Section", "description"=>"Updates a ShopSection with the given id.", "operationId"=>"putSectionsShopSection", "x-api-path-slug"=>"sectionsshop-section-id-put", "parameters"=>[{"in"=>"query", "name"=>"rank"}, {"in"=>"path", "name"=>"shop_section_id"}, {"in"=>"query", "name"=>"title"}, {"in"=>"query", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Shop", "Section"]}, "delete"=>{"summary"=>"Delete Sections Shop Section", "description"=>"Deletes the ShopSection with the given id.", "operationId"=>"deleteSectionsShopSection", "x-api-path-slug"=>"sectionsshop-section-id-delete", "parameters"=>[{"in"=>"path", "name"=>"shop_section_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Shop", "Section"]}}, "/sections"=>{"post"=>{"summary"=>"Post Sections", "description"=>"Creates a new ShopSection.", "operationId"=>"postSections", "x-api-path-slug"=>"sections-post", "parameters"=>[{"in"=>"query", "name"=>"title"}, {"in"=>"query", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections"]}}, "/categories/{tag}"=>{"get"=>{"summary"=>"Get Categories Tag", "description"=>"Retrieves a top-level Category by tag.", "operationId"=>"getCategoriesTag", "x-api-path-slug"=>"categoriestag-get", "parameters"=>[{"in"=>"path", "name"=>"tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories", "Tag"]}}, "/categories/{tag}/{subtag}"=>{"get"=>{"summary"=>"Get Categories Tag Subtag", "description"=>"Retrieves a second-level Category by tag and subtag.", "operationId"=>"getCategoriesTagSubtag", "x-api-path-slug"=>"categoriestagsubtag-get", "parameters"=>[{"in"=>"path", "name"=>"subtag"}, {"in"=>"path", "name"=>"tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories", "Tag", "Subtag"]}}, "/categories/{tag}/{subtag}/{subsubtag}"=>{"get"=>{"summary"=>"Get Categories Tag Subtag Subsubtag", "description"=>"Retrieves a third-level Category by tag, subtag and subsubtag.", "operationId"=>"getCategoriesTagSubtagSubsubtag", "x-api-path-slug"=>"categoriestagsubtagsubsubtag-get", "parameters"=>[{"in"=>"path", "name"=>"subsubtag"}, {"in"=>"path", "name"=>"subtag"}, {"in"=>"path", "name"=>"tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories", "Tag", "Subtag", "Subsubtag"]}}, "/taxonomy/categories"=>{"get"=>{"summary"=>"Get Taxonomy Categories", "description"=>"Retrieves all top-level Categories.", "operationId"=>"getTaxonomyCategories", "x-api-path-slug"=>"taxonomycategories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Taxonomy", "Categories"]}}, "/taxonomy/categories/{tag}"=>{"get"=>{"summary"=>"Get Taxonomy Categories Tag", "description"=>"Retrieves children of a top-level Category by tag.", "operationId"=>"getTaxonomyCategoriesTag", "x-api-path-slug"=>"taxonomycategoriestag-get", "parameters"=>[{"in"=>"path", "name"=>"tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Taxonomy", "Categories", "Tag"]}}, "/taxonomy/categories/{tag}/{subtag}"=>{"get"=>{"summary"=>"Get Taxonomy Categories Tag Subtag", "description"=>"Retrieves children of a second-level Category by tag and subtag.", "operationId"=>"getTaxonomyCategoriesTagSubtag", "x-api-path-slug"=>"taxonomycategoriestagsubtag-get", "parameters"=>[{"in"=>"path", "name"=>"subtag"}, {"in"=>"path", "name"=>"tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Taxonomy", "Categories", "Tag", "Subtag"]}}, "/taxonomy/tags"=>{"get"=>{"summary"=>"Get Taxonomy Tags", "description"=>"Retrieves all related tags for the given tag set.", "operationId"=>"getTaxonomyTags", "x-api-path-slug"=>"taxonomytags-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Taxonomy", "Tags"]}}, "/taxonomy/tags/{tags}"=>{"get"=>{"summary"=>"Get Taxonomy Tags Tags", "description"=>"Retrieves all related tags for the given tag set.", "operationId"=>"getTaxonomyTagsTags", "x-api-path-slug"=>"taxonomytagstags-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"tags"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Taxonomy", "Tags", "Tags"]}}, "/transactions/{transaction_id}"=>{"get"=>{"summary"=>"Get Transactions Transaction", "description"=>"Retrieves a Transaction by id.", "operationId"=>"getTransactionsTransaction", "x-api-path-slug"=>"transactionstransaction-id-get", "parameters"=>[{"in"=>"path", "name"=>"transaction_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Transaction"]}}, "/treasuries/{treasury_id}"=>{"get"=>{"summary"=>"Get Treasuries Treasury", "description"=>"Get a Treasury", "operationId"=>"getTreasuriesTreasury", "x-api-path-slug"=>"treasuriestreasury-id-get", "parameters"=>[{"in"=>"path", "name"=>"treasury_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Treasuries"]}}, "/treasuries"=>{"get"=>{"summary"=>"Get Treasuries", "description"=>"Search Treasuries or else List all Treasuries", "operationId"=>"getTreasuries", "x-api-path-slug"=>"treasuries-get", "parameters"=>[{"in"=>"query", "name"=>"detail_level", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"keywords", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"maturity", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"sort_on", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Bring Etsys handmade marketplace and community into your apps"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Treasuries"]}}, "/users/{user_id}/treasuries"=>{"get"=>{"summary"=>"Get Users User Treasuries", "description"=>"Get a user's Treasuries", "operationId"=>"getUsersUserTreasuries", "x-api-path-slug"=>"usersuser-idtreasuries-get", "parameters"=>[{"in"=>"query", "name"=>"detail_level", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"maturity", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"sort_on", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Treasuries"]}}, "/users/{user_id}"=>{"get"=>{"summary"=>"Get Users User", "description"=>"Retrieves a User by id.", "operationId"=>"getUsersUser", "x-api-path-slug"=>"usersuser-id-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/{user_id}/shops"=>{"get"=>{"summary"=>"Get Users User Shops", "description"=>"Retrieves a set of Shop objects associated to a User.", "operationId"=>"getUsersUserShops", "x-api-path-slug"=>"usersuser-idshops-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Shops"]}}, "/users/{user_id}/favored-by"=>{"get"=>{"summary"=>"Get Users User Favored By", "description"=>"Retrieves a set of FavoriteUser objects associated to a User.", "operationId"=>"getUsersUserFavoredBy", "x-api-path-slug"=>"usersuser-idfavoredby-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Favored-by"]}}, "/users/{user_id}/feedback/as-subject"=>{"get"=>{"summary"=>"Get Users User Feedback As Subject", "description"=>"Retrieves a set of Feedback objects associated to a User.", "operationId"=>"getUsersUserFeedbackAsSubject", "x-api-path-slug"=>"usersuser-idfeedbackassubject-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Feedback", "As-subject"]}}, "/users/{user_id}/feedback/as-author"=>{"get"=>{"summary"=>"Get Users User Feedback As Author", "description"=>"Retrieves a set of Feedback objects associated to a User.", "operationId"=>"getUsersUserFeedbackAsAuthor", "x-api-path-slug"=>"usersuser-idfeedbackasauthor-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Feedback", "As-author"]}}, "/users/{user_id}/feedback/as-buyer"=>{"get"=>{"summary"=>"Get Users User Feedback As Buyer", "description"=>"Retrieves a set of Feedback objects associated to a User.", "operationId"=>"getUsersUserFeedbackAsBuyer", "x-api-path-slug"=>"usersuser-idfeedbackasbuyer-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Feedback", "As-buyer"]}}, "/users/{user_id}/feedback/as-seller"=>{"get"=>{"summary"=>"Get Users User Feedback As Seller", "description"=>"Retrieves a set of Feedback objects associated to a User.", "operationId"=>"getUsersUserFeedbackAsSeller", "x-api-path-slug"=>"usersuser-idfeedbackasseller-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Feedback", "As-seller"]}}, "/users/{user_id}/orders"=>{"get"=>{"summary"=>"Get Users User Orders", "description"=>"Retrieves a set of Order objects associated to a User.", "operationId"=>"getUsersUserOrders", "x-api-path-slug"=>"usersuser-idorders-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Orders"]}}, "/users/{user_id}/receipts"=>{"get"=>{"summary"=>"Get Users User Receipts", "description"=>"Retrieves a set of Receipt objects associated to a User.", "operationId"=>"getUsersUserReceipts", "x-api-path-slug"=>"usersuser-idreceipts-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Receipts"]}}, "/users/{user_id}/transactions"=>{"get"=>{"summary"=>"Get Users User Transactions", "description"=>"Retrieves a set of Transaction objects associated to a User.", "operationId"=>"getUsersUserTransactions", "x-api-path-slug"=>"usersuser-idtransactions-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Transactions"]}}, "/users/{user_id}/charges"=>{"get"=>{"summary"=>"Get Users User Charges", "description"=>"Retrieves a set of BillCharge objects associated to a User.", "operationId"=>"getUsersUserCharges", "x-api-path-slug"=>"usersuser-idcharges-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Charges"]}}, "/users/{user_id}/payments"=>{"get"=>{"summary"=>"Get Users User Payments", "description"=>"Retrieves a set of BillPayment objects associated to a User.", "operationId"=>"getUsersUserPayments", "x-api-path-slug"=>"usersuser-idpayments-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Payments"]}}, "/users/{user_id}/shipping/templates"=>{"get"=>{"summary"=>"Get Users User Shipping Templates", "description"=>"Retrieves a set of ShippingTemplate objects associated to a User.", "operationId"=>"getUsersUserShippingTemplates", "x-api-path-slug"=>"usersuser-idshippingtemplates-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Shipping", "Templates"]}}, "/users/{user_id}/payments/templates"=>{"get"=>{"summary"=>"Get Users User Payments Templates", "description"=>"Retrieves a set of PaymentTemplate objects associated to a User.", "operationId"=>"getUsersUserPaymentsTemplates", "x-api-path-slug"=>"usersuser-idpaymentstemplates-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Payments", "Templates"]}}, "/users/{user_id}/addresses"=>{"get"=>{"summary"=>"Get Users User Addresses", "description"=>"Retrieves a set of UserAddress objects associated to a User.", "operationId"=>"getUsersUserAddresses", "x-api-path-slug"=>"usersuser-idaddresses-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Addresses"]}, "post"=>{"summary"=>"Post Users User Addresses", "description"=>"Creates a new UserAddress.", "operationId"=>"postUsersUserAddresses", "x-api-path-slug"=>"usersuser-idaddresses-post", "parameters"=>[{"in"=>"query", "name"=>"city"}, {"in"=>"query", "name"=>"country_id"}, {"in"=>"query", "name"=>"first_line"}, {"in"=>"query", "name"=>"name"}, {"in"=>"query", "name"=>"second_line"}, {"in"=>"query", "name"=>"state"}, {"in"=>"path", "name"=>"user_id"}, {"in"=>"query", "name"=>"zip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Addresses"]}}, "/payments/templates/{payment_template_id}"=>{"get"=>{"summary"=>"Get Payments Templates Payment Template", "description"=>"Retrieves a PaymentTemplate by id.", "operationId"=>"getPaymentsTemplatesPaymentTemplate", "x-api-path-slug"=>"paymentstemplatespayment-template-id-get", "parameters"=>[{"in"=>"path", "name"=>"payment_template_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Templates", "Payment", "Template"]}, "put"=>{"summary"=>"Put Payments Templates Payment Template", "description"=>"Updates a PaymentTemplate", "operationId"=>"putPaymentsTemplatesPaymentTemplate", "x-api-path-slug"=>"paymentstemplatespayment-template-id-put", "parameters"=>[{"in"=>"query", "name"=>"allow_check"}, {"in"=>"query", "name"=>"allow_mo"}, {"in"=>"query", "name"=>"allow_other"}, {"in"=>"query", "name"=>"allow_paypal"}, {"in"=>"query", "name"=>"city"}, {"in"=>"query", "name"=>"country_id"}, {"in"=>"query", "name"=>"first_line"}, {"in"=>"query", "name"=>"name"}, {"in"=>"path", "name"=>"payment_template_id"}, {"in"=>"query", "name"=>"paypal_email"}, {"in"=>"query", "name"=>"second_line"}, {"in"=>"query", "name"=>"state"}, {"in"=>"query", "name"=>"zip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Templates", "Payment", "Template"]}}, "/payments/templates"=>{"post"=>{"summary"=>"Post Payments Templates", "description"=>"Creates a new PaymentTemplate", "operationId"=>"postPaymentsTemplates", "x-api-path-slug"=>"paymentstemplates-post", "parameters"=>[{"in"=>"query", "name"=>"allow_check"}, {"in"=>"query", "name"=>"allow_mo"}, {"in"=>"query", "name"=>"allow_other"}, {"in"=>"query", "name"=>"allow_paypal"}, {"in"=>"query", "name"=>"city"}, {"in"=>"query", "name"=>"country_id"}, {"in"=>"query", "name"=>"first_line"}, {"in"=>"query", "name"=>"name"}, {"in"=>"query", "name"=>"paypal_email"}, {"in"=>"query", "name"=>"second_line"}, {"in"=>"query", "name"=>"state"}, {"in"=>"query", "name"=>"zip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Templates"]}}, "/payments/{listing_payment_id}"=>{"get"=>{"summary"=>"Get Payments Listing Payment", "description"=>"Retrieves a ListingPayment by id.", "operationId"=>"getPaymentsListingPayment", "x-api-path-slug"=>"paymentslisting-payment-id-get", "parameters"=>[{"in"=>"path", "name"=>"listing_payment_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Listing", "Payment"]}}, "/users/{user_id}/avatar"=>{"post"=>{"summary"=>"Post Users User Avatar", "description"=>"Upload a new user avatar image", "operationId"=>"postUsersUserAvatar", "x-api-path-slug"=>"usersuser-idavatar-post", "parameters"=>[{"in"=>"query", "name"=>"image"}, {"in"=>"query", "name"=>"src"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Avatar"]}}, "/users/{user_id}/avatar/src"=>{"get"=>{"summary"=>"Get Users User Avatar Src", "description"=>"Get avatar image source", "operationId"=>"getUsersUserAvatarSrc", "x-api-path-slug"=>"usersuser-idavatarsrc-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Avatar", "Src"]}}, "/users/{user_id}/addresses/{user_address_id}"=>{"get"=>{"summary"=>"Get Users User Addresses User Address", "description"=>"Retrieves a UserAddress by id.", "operationId"=>"getUsersUserAddressesUserAddress", "x-api-path-slug"=>"usersuser-idaddressesuser-address-id-get", "parameters"=>[{"in"=>"path", "name"=>"user_address_id"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Addresses", "User", "Address"]}, "put"=>{"summary"=>"Put Users User Addresses User Address", "description"=>"Updates a UserAddress with the given id.", "operationId"=>"putUsersUserAddressesUserAddress", "x-api-path-slug"=>"usersuser-idaddressesuser-address-id-put", "parameters"=>[{"in"=>"query", "name"=>"city"}, {"in"=>"query", "name"=>"country_id"}, {"in"=>"query", "name"=>"first_line"}, {"in"=>"query", "name"=>"name"}, {"in"=>"query", "name"=>"second_line"}, {"in"=>"query", "name"=>"state"}, {"in"=>"path", "name"=>"user_address_id"}, {"in"=>"path", "name"=>"user_id"}, {"in"=>"query", "name"=>"zip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Addresses", "User", "Address"]}, "delete"=>{"summary"=>"Delete Users User Addresses User Address", "description"=>"Deletes the UserAddress with the given id.", "operationId"=>"deleteUsersUserAddressesUserAddress", "x-api-path-slug"=>"usersuser-idaddressesuser-address-id-delete", "parameters"=>[{"in"=>"path", "name"=>"user_address_id"}, {"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Addresses", "User", "Address"]}}, "/featured/users"=>{"get"=>{"summary"=>"Get Featured Users", "description"=>"Finds all FeaturedUser.", "operationId"=>"getFeaturedUsers", "x-api-path-slug"=>"featuredusers-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Bring Etsys handmade marketplace and community into your apps"}, {"in"=>"query", "name"=>"offset", "description"=>"Bring Etsys handmade marketplace and community into your apps"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Featured", "Users"]}}, "/featured/users/{featured_user_id}"=>{"get"=>{"summary"=>"Get Featured Users Featured User", "description"=>"Retrieves a FeaturedUser by id.", "operationId"=>"getFeaturedUsersFeaturedUser", "x-api-path-slug"=>"featuredusersfeatured-user-id-get", "parameters"=>[{"in"=>"path", "name"=>"featured_user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Featured", "Users", "Featured", "User"]}}, "/"=>{"get"=>{"summary"=>"Get", "description"=>"Get a list of all methods available.", "operationId"=>"get", "x-api-path-slug"=>"get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/server/epoch"=>{"get"=>{"summary"=>"Get Server Epoch", "description"=>"Get server time, in epoch seconds notation.", "operationId"=>"getServerEpoch", "x-api-path-slug"=>"serverepoch-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server", "Epoch"]}}, "/server/ping"=>{"get"=>{"summary"=>"Get Server Ping", "description"=>"Check that the server is alive.", "operationId"=>"getServerPing", "x-api-path-slug"=>"serverping-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server", "Ping"]}}, "/listings/interesting"=>{"get"=>{"summary"=>"Get Interesting Listings", "description"=>"Collects the list of interesting listings", "operationId"=>"getInterestingListings", "x-api-path-slug"=>"listingsinteresting-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Commerce"]}}, "/listings/trending"=>{"get"=>{"summary"=>"Get Trending Listings", "description"=>"Collects the list of listings used to generate the trending listing page.", "operationId"=>"getTrendingListings", "x-api-path-slug"=>"listingstrending-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Commerce", "Trending"]}}}}, "apis"=>{"name"=>"Etsy", "x-slug"=>"etsy", "description"=>"Find handmade, vintage, and unique goods that express who you are.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/192-etsy.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"187", "tags"=>"API LIfeyclessss,API Provider,Children,Clothing,Crafts,Crochet,Dolls and Miniatures,Furniture,Geekery,General Data,Glass,Holidays,Housewares,internet,Jewelry,Knitting,Marketplace,Needlecraft,Paper Goods,Patterns,Pedestal,Pets,Plants and Edibles,Products,Profiles", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"etsy/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Etsy", "x-api-slug"=>"etsy", "description"=>"Etsy is a handmade marketplace. The Etsy API lets developers tap into the Etsy community, building their own Etsy-powered applications for the web, desktop and mobile devices. Applications built on the API will connect buyers with sellers, promote the handmade lifestyle, and support the craftspeople who sell on Etsy.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/192-etsy.jpg", "humanURL"=>"http://etsy.com", "baseURL"=>"https://openapi.etsy.com//v2/private/", "tags"=>"API LIfeyclessss,API Provider,Children,Clothing,Crafts,Crochet,Dolls and Miniatures,Furniture,Geekery,General Data,Glass,Holidays,Housewares,internet,Jewelry,Knitting,Marketplace,Needlecraft,Paper Goods,Patterns,Pedestal,Pets,Plants and Edibles,Products,Profiles", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/etsy/listingstrending-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/etsy/etsy-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-api-json--authoritative", "url"=>"http://apis.io/apisdef/etsy.json"}, {"type"=>"x-application-gallery", "url"=>"https://www.etsy.com/apps/"}, {"type"=>"x-base", "url"=>"https://openapi.etsy.com/"}, {"type"=>"x-blog", "url"=>"http://www.etsy.com/blog/en/"}, {"type"=>"x-blog-rss", "url"=>"https://blog.etsy.com/en/feed/"}, {"type"=>"x-copyright", "url"=>"https://www.etsy.com/help/article/482/?ref=ftr"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/etsy"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/etsy"}, {"type"=>"x-developer", "url"=>"https://www.etsy.com/developers/"}, {"type"=>"x-email", "url"=>"enaffiliates@etsy.com"}, {"type"=>"x-email", "url"=>"selleraffiliate@etsy.com"}, {"type"=>"x-email", "url"=>"developer@etsy.com"}, {"type"=>"x-email", "url"=>"legal@etsy.com"}, {"type"=>"x-email", "url"=>"dpo@etsy.com"}, {"type"=>"x-email", "url"=>"dispute-resolution@etsy.com"}, {"type"=>"x-forum", "url"=>"https://www.etsy.com/developers/discussion"}, {"type"=>"x-github", "url"=>"https://github.com/etsy"}, {"type"=>"x-privacy", "url"=>"https://www.etsy.com/help/article/480/?ref=ftr"}, {"type"=>"x-terms-of-service", "url"=>"https://www.etsy.com/help/article/479/?ref=ftr"}, {"type"=>"x-transparency-report", "url"=>"http://blog.etsy.com/news/files/2015/07/Etsy_TransparencyReport_2014.pdf"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Etsy"}, {"type"=>"x-website", "url"=>"http://etsy.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
open-fintech{"apis"=>{"name"=>"Open FinTech", "x-slug"=>"open-fintech", "description"=>"International standards yield technological, economic and social advantages. Standards speed up the development of new applications and simplify the process of communication between the services. Data and service is available under the Open Database License (ODbL). It is an open standard and open data, every player of FinTech market can contribute to development and enhancement. All data is available through Rest API based on JSON API standard.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/open-fintech-io.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,Banking,Currencies,General Data,Payments,Profiles,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"open-fintech/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Open FinTech", "x-api-slug"=>"open-fintech", "description"=>"International standards yield technological, economic and social advantages. Standards speed up the development of new applications and simplify the process of communication between the services. Data and service is available under the Open Database License (ODbL). It is an open standard and open data, every player of FinTech market can contribute to development and enhancement. All data is available through Rest API based on JSON API standard.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/open-fintech-io.png", "humanURL"=>"http://openfintech.io", "baseURL"=>"https://api.openfintech.io//v1/", "tags"=>"API Provider,Banking,Currencies,General Data,Payments,Profiles,Service API", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/open-fintech/paymentprovidersid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/open-fintech/open-fintech-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"https://docs.openfintech.io/"}, {"type"=>"x-getting-started", "url"=>"https://docs.openfintech.io/#section/Get-Started"}, {"type"=>"x-github", "url"=>"https://github.com/openfintechio"}, {"type"=>"x-website", "url"=>"http://openfintech.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "open-fintech-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Open FinTech", "x-complete"=>1, "info"=>{"title"=>"Open FinTech", "description"=>"openfintech-io-is-an-open-database-that-comprises-of-standardized-primary-data-for-fintech-industry--it-contains-such-information-as-geolocation-data-countries-cities-regions-organizations-currencies-national-digital-virtual-crypto-banks-digital-exchangers-payment-providers-psp-payment-methods-etc-it-is-created-for-communication-of-crossintegrated-microservices-on-one-language--this-is-achieved-through-standardization-of-entity-identifiers-that-are-used-to-exchange-information-among-different-services-", "version"=>"2017-08-24"}, "host"=>"api.openfintech.io", "basePath"=>"/v1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/banks"=>{"get"=>{"summary"=>"List of banks", "description"=>"Returns list of banks. Each object contains general information about bank such as name and status, also information about bank details and related link to main organization.", "operationId"=>"banks.get", "x-api-path-slug"=>"banks-get", "parameters"=>[{"in"=>"query", "name"=>"filter[sort_code]", "description"=>"Filtering by banks code"}, {"in"=>"query", "name"=>"filter[status]", "description"=>"Filtration by status"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort params:| ASC | DESC ||-----|------|| name | -name || code | -code || status | -status || sort_code | -sort_code |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks"]}}, "/banks/{id}"=>{"get"=>{"summary"=>"Bank by ID", "description"=>"Returns bank with specific ID.", "operationId"=>"banks.id.get", "x-api-path-slug"=>"banksid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks"]}}, "/countries"=>{"get"=>{"summary"=>"List of countries", "description"=>"Returns all available countries.", "operationId"=>"countries.get", "x-api-path-slug"=>"countries-get", "parameters"=>[{"in"=>"query", "name"=>"filter[region]", "description"=>"Filtration by region"}, {"in"=>"query", "name"=>"filter[sub_region]", "description"=>"Filtration by sub region"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort params:| ASC | DESC ||-----|------|| name | -name || area | -area || population | -population || region | -region || sub_region | -sub_region |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countries"]}}, "/countries/{id}"=>{"get"=>{"summary"=>"Country by ID", "description"=>"Returns country with specific ID.", "operationId"=>"countries.id.get", "x-api-path-slug"=>"countriesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countries"]}}, "/currencies"=>{"get"=>{"summary"=>"List of currencies", "description"=>"Returns all available currencies.", "operationId"=>"currencies.get", "x-api-path-slug"=>"currencies-get", "parameters"=>[{"in"=>"query", "name"=>"filter[category]", "description"=>"Filtration by category"}, {"in"=>"query", "name"=>"filter[code_estandards_alpha]", "description"=>"Filtering by estandards code"}, {"in"=>"query", "name"=>"filter[code_iso_alpha3]", "description"=>"Filtering by ISO code"}, {"in"=>"query", "name"=>"filter[code_iso_numeric3]", "description"=>"Filtering by ISO number"}, {"in"=>"query", "name"=>"filter[currency_type]", "description"=>"Filtration by currency type"}, {"in"=>"query", "name"=>"filter[search]", "description"=>"Full text search with name, code, type, code_iso_alpha3, code_jsons_alpha, code_estandards_alpha, category"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort params:| ASC | DESC ||-----|------|| name | -name || type | -type || category | -category || code | -code || code_iso_alpha3 | -code_iso_alpha3 || code_iso_numeric3 | -code_iso_numeric3 || code_estandards_alpha | -code_estandards_alpha |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Currencies"]}}, "/currencies/{id}"=>{"get"=>{"summary"=>"Currency by ID", "description"=>"Returns currency with specific ID.", "operationId"=>"currencies.id.get", "x-api-path-slug"=>"currenciesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Currencies"]}}, "/exchangers"=>{"get"=>{"summary"=>"List of exchangers", "description"=>"Returns list of exchange markets. Each object contains general information about exchanger such as name and status, also information about rates export and related link to main organization. \nRates export standards is represented by:\n* [estandards](http://estandards.info)\n* [jsons](http://jsons.info)\n* ratex - our internal standard", "operationId"=>"exchangers.get", "x-api-path-slug"=>"exchangers-get", "parameters"=>[{"in"=>"query", "name"=>"sort", "description"=>"Sort params:| ASC | DESC ||-----|------|| name | -name || status | -status || wmid | -wmid || rate_type | -rate_type || rates_export_standard | -rates_export_standard |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Exchangers"]}}, "/exchangers/{id}"=>{"get"=>{"summary"=>"Exchanger by ID", "description"=>"Returns exchanger with specific ID.", "operationId"=>"exchangers.id.get", "x-api-path-slug"=>"exchangersid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Exchangers"]}}, "/merchant-industries"=>{"get"=>{"summary"=>"List of merchant industries", "description"=>"Returns all available merchant fields of activity.", "operationId"=>"merchant_industries.get", "x-api-path-slug"=>"merchantindustries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchant-industries"]}}, "/merchant-industries/{id}"=>{"get"=>{"summary"=>"Merchant industry by ID", "description"=>"Returns merchant industry with specific ID.", "operationId"=>"merchant_industries.id.get", "x-api-path-slug"=>"merchantindustriesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchant-industries"]}}, "/organizations"=>{"get"=>{"summary"=>"List of organizations", "description"=>"This endpoint retrievs the list of organizations present in the system. The data displays general, public information, without reference to the type of activity (for example - name, address, contacts, etc.).", "operationId"=>"organizations.get", "x-api-path-slug"=>"organizations-get", "parameters"=>[{"in"=>"query", "name"=>"filter[industries]", "description"=>"Filtering by industries"}, {"in"=>"query", "name"=>"filter[search]", "description"=>"Full text search with id, name, code"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort params:| ASC | DESC ||-----|------|| name | -name || code | -code || status | -status || description | -description |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}, "/organizations/{id}"=>{"get"=>{"summary"=>"Organization by ID", "description"=>"Returns organization with specific ID.", "operationId"=>"organizations.id.get", "x-api-path-slug"=>"organizationsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}, "/payment-methods"=>{"get"=>{"summary"=>"List of payment methods", "description"=>"Returns list of payment methods. Each object contains information about payment method such as name and category, also related link to payment method issuer (which processing it).", "operationId"=>"payment_methods.get", "x-api-path-slug"=>"paymentmethods-get", "parameters"=>[{"in"=>"query", "name"=>"filter[category]", "description"=>"Filtering by category"}, {"in"=>"query", "name"=>"filter[processor_name]", "description"=>"Filtering by processor_name"}, {"in"=>"query", "name"=>"filter[search]", "description"=>"Full text search with id, name, code, category"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort params:| ASC | DESC ||-----|------|| name | -name || code | -code || processor_name | -processor_name || category | -category |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment-methods"]}}, "/payment-methods/{id}"=>{"get"=>{"summary"=>"Payment method by ID", "description"=>"Returns payment method with specific ID.", "operationId"=>"payment_methods.id.get", "x-api-path-slug"=>"paymentmethodsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment-methods"]}}, "/payment-providers"=>{"get"=>{"summary"=>"List of payment providers", "description"=>"A payment service provider (PSP) offers shops online services for accepting electronic payments by a variety of payment methods. Endpoint returns list of PSPs. Each object contains: name, type, supported features and sales channels, also related link to available payment methods and main organization.", "operationId"=>"payment_providers.get", "x-api-path-slug"=>"paymentproviders-get", "parameters"=>[{"in"=>"query", "name"=>"filter[features]", "description"=>"Filtering by features"}, {"in"=>"query", "name"=>"filter[sales_channels]", "description"=>"Filtering by sales channels"}, {"in"=>"query", "name"=>"filter[search]", "description"=>"Full text search with id, code, name"}, {"in"=>"query", "name"=>"filter[types]", "description"=>"Filtering by types"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort params:| ASC | DESC ||-----|------|| name | -name || code | -code |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment-providers"]}}, "/payment-providers/{id}"=>{"get"=>{"summary"=>"Payment provider by ID", "description"=>"Returns payment provider with specific ID.", "operationId"=>"payment_providers.id.get", "x-api-path-slug"=>"paymentprovidersid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment-providers"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
speakertext{"speaker-text-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"SpeakerText", "x-complete"=>1, "info"=>{"title"=>"Speaker Text", "description"=>"speakertexts-transcription-services-may-be-accessed-through-a-restful-api--it-is-possible-to-initiate-transcription-and-receive-transcription-results-through-the-api--anyone-with-a-speakertext-account-can-use-the-api-", "termsOfService"=>"http://speakertext.com/tos", "version"=>"v1"}, "host"=>"api.speakertext.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/transcripts"=>{"post"=>{"summary"=>"Iniate Transcript", "description"=>"This method is used to initiate one or more SpeakerText transcriptions.", "operationId"=>"postTranscripts", "x-api-path-slug"=>"transcripts-post", "parameters"=>[{"in"=>"query", "name"=>"pingback_url", "description"=>"If present, we will make a POST request to this URL upon transcript completion"}, {"in"=>"query", "name"=>"sources", "description"=>"(JSON) single source object or array of source objects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transcripts"]}}, "/transcripts/{id}"=>{"get"=>{"summary"=>"Retrieve Transcription", "description"=>"This method is used to retrieve the results of SpeakerText transcriptions.", "operationId"=>"getTranscripts", "x-api-path-slug"=>"transcriptsid-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"dfxp, srt, txt, xml, or html (for CaptionBox)"}, {"in"=>"query", "name"=>"id", "description"=>"Transcript ID returned to you upon transcript creation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transcripts"]}}}}, "apis"=>{"name"=>"SpeakerText", "x-slug"=>"speakertext", "description"=>"cielo24 captions, transcripts, and video intelligence transforms unstructured media into fully searchable structured media data, powering enhanced discovery, reach, engagement, and accessibility compliance. Contact us for a demo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/938-speakertext.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"813304", "tags"=>"Audio,General Data,Indexing,internet,Media,Relative Data,SaaS,Service API,Technology,Transcripts,Voice", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"speakertext/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Speaker Text", "x-api-slug"=>"speaker-text", "description"=>"cielo24 captions, transcripts, and video intelligence transforms unstructured media into fully searchable structured media data, powering enhanced discovery, reach, engagement, and accessibility compliance. Contact us for a demo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/938-speakertext.jpg", "humanURL"=>"http://speakertext.com/", "baseURL"=>"https://api.speakertext.com//v1", "tags"=>"Audio,General Data,Indexing,internet,Media,Relative Data,SaaS,Service API,Technology,Transcripts,Voice", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/speakertext/transcriptsid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/speakertext/speaker-text-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.speakertext.com"}, {"type"=>"x-contact-form", "url"=>"http://speakertext.com/contact"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/speakertext"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/cielo24"}, {"type"=>"x-developer", "url"=>"http://speakertext.com/api"}, {"type"=>"x-faq", "url"=>"http://speakertext.com/faq"}, {"type"=>"x-github", "url"=>"https://github.com/speakertext"}, {"type"=>"x-pricing", "url"=>"http://speakertext.com/pricing"}, {"type"=>"x-privacy", "url"=>"http://speakertext.com/privacy"}, {"type"=>"x-terms-of-service", "url"=>"http://speakertext.com/tos"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/speakertext"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/cielo24"}, {"type"=>"x-website", "url"=>"http://speakertext.com/"}, {"type"=>"x-website", "url"=>"http://speakertext.com"}, {"type"=>"x-wordpress-plugin", "url"=>"http://speakertext.com/captionbox/wordpress"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
youtube{"apis"=>{"name"=>"YouTube", "x-slug"=>"youtube", "description"=>"YouTube is an American video-sharing website headquartered in San Bruno, California.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11515-youtube.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"2", "tags"=>"General Data,Google APIs,Historical Data API,internet,Mobile,New,Pedestal,Relative Data,Relative StreamRank,SaaS,Service API,Stack,Stack Network,Streams,Streams,Streams,Technology,Videos", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"youtube/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Youtube", "x-api-slug"=>"youtube", "description"=>"YouTube is an American video-sharing website headquartered in San Bruno, California.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11515-youtube.jpg", "humanURL"=>"https://www.youtube.com/", "baseURL"=>"https://www.googleapis.com//youtube/v1", "tags"=>"General Data,Google APIs,Historical Data API,internet,Mobile,New,Pedestal,Relative Data,Relative StreamRank,SaaS,Service API,Stack,Stack Network,Streams,Streams,Streams,Technology,Videos", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/youtube/reports-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/youtube/youtube-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-articles", "url"=>"https://developers.google.com/youtube/articles/"}, {"type"=>"x-authentication", "url"=>"https://developers.google.com/youtube/v3/guides/authentication"}, {"type"=>"x-blog", "url"=>"https://youtube-eng.googleblog.com/"}, {"type"=>"x-blog-rss", "url"=>"https://youtube-eng.googleblog.com/feeds/posts/default?alt=rss"}, {"type"=>"x-branding", "url"=>"https://developers.google.com/youtube/branding_guidelines"}, {"type"=>"x-bug-report", "url"=>"https://code.google.com/p/gdata-issues/issues/entry"}, {"type"=>"x-bug-report", "url"=>"https://code.google.com/p/gdata-issues/issues/list?q=label:API-YouTube"}, {"type"=>"x-buttons", "url"=>"https://developers.google.com/youtube/youtube_subscribe_button"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/youtube"}, {"type"=>"x-deprecation-policy", "url"=>"https://developers.google.com/youtube/youtube-api-list"}, {"type"=>"x-developer", "url"=>"https://developers.google.com/youtube/"}, {"type"=>"x-email", "url"=>"copyright@youtube.com"}, {"type"=>"x-getting-started", "url"=>"https://developers.google.com/youtube/v3/getting-started"}, {"type"=>"x-github", "url"=>"https://github.com/youtube"}, {"type"=>"x-github", "url"=>"https://github.com/youtube/"}, {"type"=>"x-terms-of-service", "url"=>"https://developers.google.com/youtube/terms"}, {"type"=>"x-training", "url"=>"https://developers.google.com/youtube/training/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/YouTubeDev"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/YouTube"}, {"type"=>"x-website", "url"=>"https://www.youtube.com/"}, {"type"=>"x-website", "url"=>"https://developers.google.com"}, {"type"=>"x-widgets", "url"=>"https://developers.google.com/youtube/youtube_upload_widget"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "youtube-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"YouTube", "x-complete"=>1, "info"=>{"title"=>"YouTube", "description"=>"youtube-allows-users-to-upload-view-rate-share-add-to-favorites-report-comment-on-videos-and-subscribe-to-other-users--it-offers-a-wide-variety-of-usergenerated-and-corporate-media-videos--available-content-includes-video-clips-tv-show-clips-music-videos-short-and-documentary-films-audio-recordings-movie-trailers-live-streams-and-other-content-such-as-video-blogging-short-original-videos-and-educational-videos--most-of-the-content-on-youtube-is-uploaded-by-individuals-but-media-corporations-including-cbs-the-bbc-vevo-and-hulu-offer-some-of-their-material-via-youtube-as-part-of-the-youtube-partnership-program--unregistered-users-can-only-watch-videos-on-the-site-while-registered-users-are-permitted-to-upload-an-unlimited-number-of-videos-and-add-comments-to-videos-", "termsOfService"=>"https://developers.google.com/terms/", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"1.0.0"}, "host"=>"www.googleapis.com", "basePath"=>"/youtube/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/jobs"=>{"get"=>{"summary"=>"Get Jobs", "description"=>"Lists jobs.", "operationId"=>"getV1Jobs", "x-api-path-slug"=>"v1jobs-get", "parameters"=>[{"in"=>"query", "name"=>"includeSystemManaged", "description"=>"If set to true, also system-managed jobs will be returned; otherwise onlyuser-created jobs will be returned"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"The content owners external ID on which behalf the user is acting on"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Requested page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A token identifying a page of results the server should return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Jobs"]}, "post"=>{"summary"=>"Add Jobs", "description"=>"Creates a job and returns it.", "operationId"=>"postV1Jobs", "x-api-path-slug"=>"v1jobs-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"The content owners external ID on which behalf the user is acting on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Jobs"]}}, "/v1/jobs/{jobId}"=>{"delete"=>{"summary"=>"Delete Jobs Job", "description"=>"Delete v1 jobs job", "operationId"=>"deleteV1JobsJob", "x-api-path-slug"=>"v1jobsjobid-delete", "parameters"=>[{"in"=>"path", "name"=>"jobId", "description"=>"The ID of the job to delete"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"The content owners external ID on which behalf the user is acting on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Jobs", "Job"]}, "get"=>{"summary"=>"Get Jobs Job", "description"=>"Get v1 jobs job", "operationId"=>"getV1JobsJob", "x-api-path-slug"=>"v1jobsjobid-get", "parameters"=>[{"in"=>"path", "name"=>"jobId", "description"=>"The ID of the job to retrieve"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"The content owners external ID on which behalf the user is acting on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Jobs", "Job"]}}, "/v1/jobs/{jobId}/reports"=>{"get"=>{"summary"=>"Get Jobs Job Reports", "description"=>"Lists reports created by a specific job.\nReturns NOT_FOUND if the job does not exist.", "operationId"=>"getV1JobsJobReports", "x-api-path-slug"=>"v1jobsjobidreports-get", "parameters"=>[{"in"=>"query", "name"=>"createdAfter", "description"=>"If set, only reports created after the specified date/time are returned"}, {"in"=>"path", "name"=>"jobId", "description"=>"The ID of the job"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"The content owners external ID on which behalf the user is acting on"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Requested page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A token identifying a page of results the server should return"}, {"in"=>"query", "name"=>"startTimeAtOrAfter", "description"=>"If set, only reports whose start time is greater than or equal thespecified date/time are returned"}, {"in"=>"query", "name"=>"startTimeBefore", "description"=>"If set, only reports whose start time is smaller than the specifieddate/time are returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Jobs", "Job", "Reports"]}}, "/v1/jobs/{jobId}/reports/{reportId}"=>{"get"=>{"summary"=>"Get Jobs Job Reports Report", "description"=>"Gets the metadata of a specific report.", "operationId"=>"getV1JobsJobReportsReport", "x-api-path-slug"=>"v1jobsjobidreportsreportid-get", "parameters"=>[{"in"=>"path", "name"=>"jobId", "description"=>"The ID of the job"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"The content owners external ID on which behalf the user is acting on"}, {"in"=>"path", "name"=>"reportId", "description"=>"The ID of the report to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Jobs", "Job", "Reports", "Report"]}}, "/v1/media/{resourceName}"=>{"get"=>{"summary"=>"Get Media Resource Name", "description"=>"Method for media download. Download is supported\non the URI `/v1/media/{+name}?alt=media`.", "operationId"=>"getV1MediaResourcename", "x-api-path-slug"=>"v1mediaresourcename-get", "parameters"=>[{"in"=>"path", "name"=>"resourceName", "description"=>"Name of the media that is being downloaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Media", "Resourcename"]}}, "/v1/reportTypes"=>{"get"=>{"summary"=>"Get Reporttypes", "description"=>"Lists report types.", "operationId"=>"getV1Reporttypes", "x-api-path-slug"=>"v1reporttypes-get", "parameters"=>[{"in"=>"query", "name"=>"includeSystemManaged", "description"=>"If set to true, also system-managed report types will be returned;otherwise only the report types that can be used to create new reportingjobs will be returned"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"The content owners external ID on which behalf the user is acting on"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Requested page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A token identifying a page of results the server should return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Reporttypes"]}}, "/activities"=>{"get"=>{"summary"=>"Get Activities", "description"=>"Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user.", "operationId"=>"getActivities", "x-api-path-slug"=>"activities-get", "parameters"=>[{"in"=>"query", "name"=>"channelId", "description"=>"The channelId parameter specifies a unique YouTube channel ID"}, {"in"=>"query", "name"=>"home", "description"=>"Set this parameters value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maxResults parameter specifies the maximum number of items that should be returned in the result set"}, {"in"=>"query", "name"=>"mine", "description"=>"Set this parameters value to true to retrieve a feed of the authenticated users activities"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include"}, {"in"=>"query", "name"=>"publishedAfter", "description"=>"The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response"}, {"in"=>"query", "name"=>"publishedBefore", "description"=>"The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response"}, {"in"=>"query", "name"=>"regionCode", "description"=>"The regionCode parameter instructs the API to return results for the specified country"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activities"]}, "post"=>{"summary"=>"Add Activities", "description"=>"Posts a bulletin for a specific channel. (The user submitting the request must be authorized to act on the channel's behalf.)\n\nNote: Even though an activity resource can contain information about actions like a user rating a video or marking a video as a favorite, you need to use other API methods to generate those activity resources. For example, you would use the API's videos.rate() method to rate a video and the playlistItems.insert() method to mark a video as a favorite.", "operationId"=>"postActivities", "x-api-path-slug"=>"activities-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activities"]}}, "/captions"=>{"delete"=>{"summary"=>"Delete Captions", "description"=>"Deletes a specified caption track.", "operationId"=>"deleteCaptions", "x-api-path-slug"=>"captions-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter identifies the caption track that is being deleted"}, {"in"=>"query", "name"=>"onBehalfOf", "description"=>"ID of the Google+ Page for the channel that the request is be on behalf of"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Captions"]}, "get"=>{"summary"=>"Get Captions", "description"=>"Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track.", "operationId"=>"getCaptions", "x-api-path-slug"=>"captions-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of IDs that identify the caption resources that should be retrieved"}, {"in"=>"query", "name"=>"onBehalfOf", "description"=>"ID of the Google+ Page for the channel that the request is on behalf of"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of one or more caption resource parts that the API response will include"}, {"in"=>"query", "name"=>"videoId", "description"=>"The videoId parameter specifies the YouTube video ID of the video for which the API should return caption tracks"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Captions"]}, "post"=>{"summary"=>"Add Captions", "description"=>"Uploads a caption track.", "operationId"=>"postCaptions", "x-api-path-slug"=>"captions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOf", "description"=>"ID of the Google+ Page for the channel that the request is be on behalf of"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies the caption resource parts that the API response will include"}, {"in"=>"query", "name"=>"sync", "description"=>"The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Captions"]}, "put"=>{"summary"=>"Put Captions", "description"=>"Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both.", "operationId"=>"putCaptions", "x-api-path-slug"=>"captions-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOf", "description"=>"ID of the Google+ Page for the channel that the request is be on behalf of"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}, {"in"=>"query", "name"=>"sync", "description"=>"Note: The API server only processes the parameter value if the request contains an updated caption file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Captions"]}}, "/captions/{id}"=>{"get"=>{"summary"=>"Get Captions", "description"=>"Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter.", "operationId"=>"getCaptions", "x-api-path-slug"=>"captionsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id parameter identifies the caption track that is being retrieved"}, {"in"=>"query", "name"=>"onBehalfOf", "description"=>"ID of the Google+ Page for the channel that the request is be on behalf of"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"tfmt", "description"=>"The tfmt parameter specifies that the caption track should be returned in a specific format"}, {"in"=>"query", "name"=>"tlang", "description"=>"The tlang parameter specifies that the API response should return a translation of the specified caption track"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Captions"]}}, "/channelBanners/insert"=>{"post"=>{"summary"=>"Add Channel Banners Insert", "description"=>"Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel:\n\n- Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels.\n- Extract the url property's value from the response that the API returns for step 1.\n- Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2.", "operationId"=>"postChannelbannersInsert", "x-api-path-slug"=>"channelbannersinsert-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"channelId", "description"=>"The channelId parameter identifies the YouTube channel to which the banner is uploaded"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channelbanners", "Insert"]}}, "/channelSections"=>{"delete"=>{"summary"=>"Delete Channel Sections", "description"=>"Deletes a channelSection.", "operationId"=>"deleteChannelsections", "x-api-path-slug"=>"channelsections-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies the YouTube channelSection ID for the resource that is being deleted"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channelsections"]}, "get"=>{"summary"=>"Get Channel Sections", "description"=>"Returns channelSection resources that match the API request criteria.", "operationId"=>"getChannelsections", "x-api-path-slug"=>"channelsections-get", "parameters"=>[{"in"=>"query", "name"=>"channelId", "description"=>"The channelId parameter specifies a YouTube channel ID"}, {"in"=>"query", "name"=>"hl", "description"=>"The hl parameter indicates that the snippet"}, {"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of the YouTube channelSection ID(s) for the resource(s) that are being retrieved"}, {"in"=>"query", "name"=>"mine", "description"=>"Set this parameters value to true to retrieve a feed of the authenticated users channelSections"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of one or more channelSection resource properties that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channelsections"]}, "post"=>{"summary"=>"Add Channel Sections", "description"=>"Adds a channelSection for the authenticated user's channel.", "operationId"=>"postChannelsections", "x-api-path-slug"=>"channelsections-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"onBehalfOfContentOwnerChannel", "description"=>"This parameter can only be used in a properly authorized request"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channelsections"]}, "put"=>{"summary"=>"Put Channel Sections", "description"=>"Update a channelSection.", "operationId"=>"putChannelsections", "x-api-path-slug"=>"channelsections-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channelsections"]}}, "/channels"=>{"get"=>{"summary"=>"Get Channels", "description"=>"Returns a collection of zero or more channel resources that match the request criteria.", "operationId"=>"getChannels", "x-api-path-slug"=>"channels-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId", "description"=>"The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category"}, {"in"=>"query", "name"=>"forUsername", "description"=>"The forUsername parameter specifies a YouTube username, thereby requesting the channel associated with that username"}, {"in"=>"query", "name"=>"hl", "description"=>"The hl parameter should be used for filter out the properties that are not in the given language"}, {"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the resource(s) that are being retrieved"}, {"in"=>"query", "name"=>"managedByMe", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maxResults parameter specifies the maximum number of items that should be returned in the result set"}, {"in"=>"query", "name"=>"mine", "description"=>"Set this parameters value to true to instruct the API to only return channels owned by the authenticated user"}, {"in"=>"query", "name"=>"mySubscribers", "description"=>"Use the subscriptions"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of one or more channel resource properties that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channels"]}, "put"=>{"summary"=>"Put Channels", "description"=>"Updates a channel's metadata. Note that this method currently only supports updates to the channel resource's brandingSettings and invideoPromotion objects and their child properties.", "operationId"=>"putChannels", "x-api-path-slug"=>"channels-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channels"]}}, "/commentThreads"=>{"get"=>{"summary"=>"Get Comment Threads", "description"=>"Returns a list of comment threads that match the API request parameters.", "operationId"=>"getCommentthreads", "x-api-path-slug"=>"commentthreads-get", "parameters"=>[{"in"=>"query", "name"=>"allThreadsRelatedToChannelId", "description"=>"The allThreadsRelatedToChannelId parameter instructs the API to return all comment threads associated with the specified channel"}, {"in"=>"query", "name"=>"channelId", "description"=>"The channelId parameter instructs the API to return comment threads containing comments about the specified channel"}, {"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of comment thread IDs for the resources that should be retrieved"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maxResults parameter specifies the maximum number of items that should be returned in the result set"}, {"in"=>"query", "name"=>"moderationStatus", "description"=>"Set this parameter to limit the returned comment threads to a particular moderation state"}, {"in"=>"query", "name"=>"order", "description"=>"The order parameter specifies the order in which the API response should list comment threads"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include"}, {"in"=>"query", "name"=>"searchTerms", "description"=>"The searchTerms parameter instructs the API to limit the API response to only contain comments that contain the specified search terms"}, {"in"=>"query", "name"=>"textFormat", "description"=>"Set this parameters value to html or plainText to instruct the API to return the comments left by users in html formatted or in plain text"}, {"in"=>"query", "name"=>"videoId", "description"=>"The videoId parameter instructs the API to return comment threads associated with the specified video ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commentthreads"]}, "post"=>{"summary"=>"Add Comment Threads", "description"=>"Creates a new top-level comment. To add a reply to an existing comment, use the comments.insert method instead.", "operationId"=>"postCommentthreads", "x-api-path-slug"=>"commentthreads-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter identifies the properties that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commentthreads"]}, "put"=>{"summary"=>"Put Comment Threads", "description"=>"Modifies the top-level comment in a comment thread.", "operationId"=>"putCommentthreads", "x-api-path-slug"=>"commentthreads-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of commentThread resource properties that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commentthreads"]}}, "/comments"=>{"delete"=>{"summary"=>"Delete Comments", "description"=>"Deletes a comment.", "operationId"=>"deleteComments", "x-api-path-slug"=>"comments-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies the comment ID for the resource that is being deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}, "get"=>{"summary"=>"Get Comments", "description"=>"Returns a list of comments that match the API request parameters.", "operationId"=>"getComments", "x-api-path-slug"=>"comments-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of comment IDs for the resources that are being retrieved"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maxResults parameter specifies the maximum number of items that should be returned in the result set"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}, {"in"=>"query", "name"=>"parentId", "description"=>"The parentId parameter specifies the ID of the comment for which replies should be retrieved"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of one or more comment resource properties that the API response will include"}, {"in"=>"query", "name"=>"textFormat", "description"=>"This parameter indicates whether the API should return comments formatted as HTML or as plain text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}, "post"=>{"summary"=>"Add Comments", "description"=>"Creates a reply to an existing comment. Note: To create a top-level comment, use the commentThreads.insert method.", "operationId"=>"postComments", "x-api-path-slug"=>"comments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter identifies the properties that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}, "put"=>{"summary"=>"Put Comments", "description"=>"Modifies a comment.", "operationId"=>"putComments", "x-api-path-slug"=>"comments-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter identifies the properties that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}}, "/comments/markAsSpam"=>{"post"=>{"summary"=>"Add Comments Mark as SPAM", "description"=>"Expresses the caller's opinion that one or more comments should be flagged as spam.", "operationId"=>"postCommentsMarkasspam", "x-api-path-slug"=>"commentsmarkasspam-post", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of IDs of comments that the caller believes should be classified as spam"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Markasspam"]}}, "/comments/setModerationStatus"=>{"post"=>{"summary"=>"Add Comments Set Moderation Status", "description"=>"Sets the moderation status of one or more comments. The API request must be authorized by the owner of the channel or video associated with the comments.", "operationId"=>"postCommentsSetmoderationstatus", "x-api-path-slug"=>"commentssetmoderationstatus-post", "parameters"=>[{"in"=>"query", "name"=>"banAuthor", "description"=>"The banAuthor parameter lets you indicate that you want to automatically reject any additional comments written by the comments author"}, {"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of IDs that identify the comments for which you are updating the moderation status"}, {"in"=>"query", "name"=>"moderationStatus", "description"=>"Identifies the new moderation status of the specified comments"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Setmoderationstatus"]}}, "/fanFundingEvents"=>{"get"=>{"summary"=>"Get Fanfundingevents", "description"=>"Lists fan funding events for a channel.", "operationId"=>"getFanfundingevents", "x-api-path-slug"=>"fanfundingevents-get", "parameters"=>[{"in"=>"query", "name"=>"hl", "description"=>"The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maxResults parameter specifies the maximum number of items that should be returned in the result set"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies the fanFundingEvent resource parts that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fanfundingevents"]}}, "/guideCategories"=>{"get"=>{"summary"=>"Get Guecategories", "description"=>"Returns a list of categories that can be associated with YouTube channels.", "operationId"=>"getGuecategories", "x-api-path-slug"=>"guidecategories-get", "parameters"=>[{"in"=>"query", "name"=>"hl", "description"=>"The hl parameter specifies the language that will be used for text values in the API response"}, {"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of the YouTube channel category ID(s) for the resource(s) that are being retrieved"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies the guideCategory resource properties that the API response will include"}, {"in"=>"query", "name"=>"regionCode", "description"=>"The regionCode parameter instructs the API to return the list of guide categories available in the specified country"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guecategories"]}}, "/i18nLanguages"=>{"get"=>{"summary"=>"Get Languages", "description"=>"Returns a list of application languages that the YouTube website supports.", "operationId"=>"getI18nlanguages", "x-api-path-slug"=>"i18nlanguages-get", "parameters"=>[{"in"=>"query", "name"=>"hl", "description"=>"The hl parameter specifies the language that should be used for text values in the API response"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies the i18nLanguage resource properties that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Languages"]}}, "/i18nRegions"=>{"get"=>{"summary"=>"Get Regions", "description"=>"Returns a list of content regions that the YouTube website supports.", "operationId"=>"getI18nregions", "x-api-path-slug"=>"i18nregions-get", "parameters"=>[{"in"=>"query", "name"=>"hl", "description"=>"The hl parameter specifies the language that should be used for text values in the API response"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies the i18nRegion resource properties that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions"]}}, "/liveBroadcasts"=>{"delete"=>{"summary"=>"Delete Live Broadcasts", "description"=>"Delete livebroadcasts", "operationId"=>"deleteLivebroadcasts", "x-api-path-slug"=>"livebroadcasts-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies the YouTube live broadcast ID for the resource that is being deleted"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"onBehalfOfContentOwnerChannel", "description"=>"This parameter can only be used in a properly authorized request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Livebroadcasts"]}, "get"=>{"summary"=>"Get Live Broadcasts", "description"=>"Returns a list of YouTube broadcasts that match the API request parameters.", "operationId"=>"getLivebroadcasts", "x-api-path-slug"=>"livebroadcasts-get", "parameters"=>[{"in"=>"query", "name"=>"broadcastStatus", "description"=>"The broadcastStatus parameter filters the API response to only include broadcasts with the specified status"}, {"in"=>"query", "name"=>"broadcastType", "description"=>"The broadcastType parameter filters the API response to only include broadcasts with the specified type"}, {"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of YouTube broadcast IDs that identify the broadcasts being retrieved"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maxResults parameter specifies the maximum number of items that should be returned in the result set"}, {"in"=>"query", "name"=>"mine", "description"=>"The mine parameter can be used to instruct the API to only return broadcasts owned by the authenticated user"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"onBehalfOfContentOwnerChannel", "description"=>"This parameter can only be used in a properly authorized request"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Livebroadcasts"]}, "post"=>{"summary"=>"Add Live Broadcasts", "description"=>"Creates a broadcast.", "operationId"=>"postLivebroadcasts", "x-api-path-slug"=>"livebroadcasts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"onBehalfOfContentOwnerChannel", "description"=>"This parameter can only be used in a properly authorized request"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Livebroadcasts"]}, "put"=>{"summary"=>"Put Live Broadcasts", "description"=>"Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object.", "operationId"=>"putLivebroadcasts", "x-api-path-slug"=>"livebroadcasts-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"onBehalfOfContentOwnerChannel", "description"=>"This parameter can only be used in a properly authorized request"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Livebroadcasts"]}}, "/liveBroadcasts/bind"=>{"post"=>{"summary"=>"Add Live Broadcasts Bind", "description"=>"Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast.", "operationId"=>"postLivebroadcastsBind", "x-api-path-slug"=>"livebroadcastsbind-post", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies the unique ID of the broadcast that is being bound to a video stream"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"onBehalfOfContentOwnerChannel", "description"=>"This parameter can only be used in a properly authorized request"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include"}, {"in"=>"query", "name"=>"streamId", "description"=>"The streamId parameter specifies the unique ID of the video stream that is being bound to a broadcast"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Livebroadcasts", "Bind"]}}, "/liveBroadcasts/control"=>{"post"=>{"summary"=>"Add Live Broadcasts Control", "description"=>"Controls the settings for a slate that can be displayed in the broadcast stream.", "operationId"=>"postLivebroadcastsControl", "x-api-path-slug"=>"livebroadcastscontrol-post", "parameters"=>[{"in"=>"query", "name"=>"displaySlate", "description"=>"The displaySlate parameter specifies whether the slate is being enabled or disabled"}, {"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies the YouTube live broadcast ID that uniquely identifies the broadcast in which the slate is being updated"}, {"in"=>"query", "name"=>"offsetTimeMs", "description"=>"The offsetTimeMs parameter specifies a positive time offset when the specified slate change will occur"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"onBehalfOfContentOwnerChannel", "description"=>"This parameter can only be used in a properly authorized request"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include"}, {"in"=>"query", "name"=>"walltime", "description"=>"The walltime parameter specifies the wall clock time at which the specified slate change will occur"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Livebroadcasts", "Control"]}}, "/liveBroadcasts/transition"=>{"post"=>{"summary"=>"Add Live Broadcasts Transition", "description"=>"Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream. Before calling this method, you should confirm that the value of the status.streamStatus property for the stream bound to your broadcast is active.", "operationId"=>"postLivebroadcastsTransition", "x-api-path-slug"=>"livebroadcaststransition-post", "parameters"=>[{"in"=>"query", "name"=>"broadcastStatus", "description"=>"The broadcastStatus parameter identifies the state to which the broadcast is changing"}, {"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies the unique ID of the broadcast that is transitioning to another status"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"onBehalfOfContentOwnerChannel", "description"=>"This parameter can only be used in a properly authorized request"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Livebroadcasts", "Transition"]}}, "/liveChat/bans"=>{"delete"=>{"summary"=>"Delete Live Chat Bans", "description"=>"Delete livechat bans", "operationId"=>"deleteLivechatBans", "x-api-path-slug"=>"livechatbans-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter identifies the chat ban to remove"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat", "Bans"]}, "post"=>{"summary"=>"Add Live Chat Bans", "description"=>"Adds a new ban to the chat.", "operationId"=>"postLivechatBans", "x-api-path-slug"=>"livechatbans-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat", "Bans"]}}, "/liveChat/messages"=>{"delete"=>{"summary"=>"Delete Live Chat Messages", "description"=>"Delete livechat messages", "operationId"=>"deleteLivechatMessages", "x-api-path-slug"=>"livechatmessages-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies the YouTube chat message ID of the resource that is being deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat", "Messages"]}, "get"=>{"summary"=>"Get Live Chat Messages", "description"=>"Lists live chat messages for a specific chat.", "operationId"=>"getLivechatMessages", "x-api-path-slug"=>"livechatmessages-get", "parameters"=>[{"in"=>"query", "name"=>"hl", "description"=>"The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports"}, {"in"=>"query", "name"=>"liveChatId", "description"=>"The liveChatId parameter specifies the ID of the chat whose messages will be returned"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maxResults parameter specifies the maximum number of messages that should be returned in the result set"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies the liveChatComment resource parts that the API response will include"}, {"in"=>"query", "name"=>"profileImageSize", "description"=>"The profileImageSize parameter specifies the size of the user profile pictures that should be returned in the result set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat", "Messages"]}, "post"=>{"summary"=>"Add Live Chat Messages", "description"=>"Adds a message to a live chat.", "operationId"=>"postLivechatMessages", "x-api-path-slug"=>"livechatmessages-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat", "Messages"]}}, "/liveChat/moderators"=>{"delete"=>{"summary"=>"Delete Live Chat Moderators", "description"=>"Delete livechat moderators", "operationId"=>"deleteLivechatModerators", "x-api-path-slug"=>"livechatmoderators-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter identifies the chat moderator to remove"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat", "Moderators"]}, "get"=>{"summary"=>"Get Live Chat Moderators", "description"=>"Lists moderators for a live chat.", "operationId"=>"getLivechatModerators", "x-api-path-slug"=>"livechatmoderators-get", "parameters"=>[{"in"=>"query", "name"=>"liveChatId", "description"=>"The liveChatId parameter specifies the YouTube live chat for which the API should return moderators"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maxResults parameter specifies the maximum number of items that should be returned in the result set"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies the liveChatModerator resource parts that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat", "Moderators"]}, "post"=>{"summary"=>"Add Live Chat Moderators", "description"=>"Adds a new moderator for the chat.", "operationId"=>"postLivechatModerators", "x-api-path-slug"=>"livechatmoderators-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat", "Moderators"]}}, "/liveStreams"=>{"delete"=>{"summary"=>"Delete Livestreams", "description"=>"Deletes a video stream.", "operationId"=>"deleteLivestreams", "x-api-path-slug"=>"livestreams-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies the YouTube live stream ID for the resource that is being deleted"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"onBehalfOfContentOwnerChannel", "description"=>"This parameter can only be used in a properly authorized request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Livestreams"]}, "get"=>{"summary"=>"Get Livestreams", "description"=>"Returns a list of video streams that match the API request parameters.", "operationId"=>"getLivestreams", "x-api-path-slug"=>"livestreams-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of YouTube stream IDs that identify the streams being retrieved"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maxResults parameter specifies the maximum number of items that should be returned in the result set"}, {"in"=>"query", "name"=>"mine", "description"=>"The mine parameter can be used to instruct the API to only return streams owned by the authenticated user"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"onBehalfOfContentOwnerChannel", "description"=>"This parameter can only be used in a properly authorized request"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of one or more liveStream resource properties that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Livestreams"]}, "post"=>{"summary"=>"Add Livestreams", "description"=>"Creates a video stream. The stream enables you to send your video to YouTube, which can then broadcast the video to your audience.", "operationId"=>"postLivestreams", "x-api-path-slug"=>"livestreams-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"onBehalfOfContentOwnerChannel", "description"=>"This parameter can only be used in a properly authorized request"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Livestreams"]}, "put"=>{"summary"=>"Put Livestreams", "description"=>"Updates a video stream. If the properties that you want to change cannot be updated, then you need to create a new stream with the proper settings.", "operationId"=>"putLivestreams", "x-api-path-slug"=>"livestreams-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"onBehalfOfContentOwnerChannel", "description"=>"This parameter can only be used in a properly authorized request"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Livestreams"]}}, "/playlistItems"=>{"delete"=>{"summary"=>"Delete Play List Items", "description"=>"Deletes a playlist item.", "operationId"=>"deletePlaylistitems", "x-api-path-slug"=>"playlistitems-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies the YouTube playlist item ID for the playlist item that is being deleted"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlistitems"]}, "get"=>{"summary"=>"Get Play List Items", "description"=>"Returns a collection of playlist items that match the API request parameters. You can retrieve all of the playlist items in a specified playlist or retrieve one or more playlist items by their unique IDs.", "operationId"=>"getPlaylistitems", "x-api-path-slug"=>"playlistitems-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of one or more unique playlist item IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maxResults parameter specifies the maximum number of items that should be returned in the result set"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of one or more playlistItem resource properties that the API response will include"}, {"in"=>"query", "name"=>"playlistId", "description"=>"The playlistId parameter specifies the unique ID of the playlist for which you want to retrieve playlist items"}, {"in"=>"query", "name"=>"videoId", "description"=>"The videoId parameter specifies that the request should return only the playlist items that contain the specified video"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlistitems"]}, "post"=>{"summary"=>"Add Play List Items", "description"=>"Adds a resource to a playlist.", "operationId"=>"postPlaylistitems", "x-api-path-slug"=>"playlistitems-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlistitems"]}, "put"=>{"summary"=>"Put Play List Items", "description"=>"Modifies a playlist item. For example, you could update the item's position in the playlist.", "operationId"=>"putPlaylistitems", "x-api-path-slug"=>"playlistitems-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlistitems"]}}, "/playlists"=>{"delete"=>{"summary"=>"Delete Playlists", "description"=>"Deletes a playlist.", "operationId"=>"deletePlaylists", "x-api-path-slug"=>"playlists-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies the YouTube playlist ID for the playlist that is being deleted"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists"]}, "get"=>{"summary"=>"Get Playlists", "description"=>"Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs.", "operationId"=>"getPlaylists", "x-api-path-slug"=>"playlists-get", "parameters"=>[{"in"=>"query", "name"=>"channelId", "description"=>"This value indicates that the API should only return the specified channels playlists"}, {"in"=>"query", "name"=>"hl", "description"=>"The hl parameter should be used for filter out the properties that are not in the given language"}, {"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of the YouTube playlist ID(s) for the resource(s) that are being retrieved"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maxResults parameter specifies the maximum number of items that should be returned in the result set"}, {"in"=>"query", "name"=>"mine", "description"=>"Set this parameters value to true to instruct the API to only return playlists owned by the authenticated user"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"onBehalfOfContentOwnerChannel", "description"=>"This parameter can only be used in a properly authorized request"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists"]}, "post"=>{"summary"=>"Add Playlists", "description"=>"Creates a playlist.", "operationId"=>"postPlaylists", "x-api-path-slug"=>"playlists-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"onBehalfOfContentOwnerChannel", "description"=>"This parameter can only be used in a properly authorized request"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists"]}, "put"=>{"summary"=>"Put Playlists", "description"=>"Modifies a playlist. For example, you could change a playlist's title, description, or privacy status.", "operationId"=>"putPlaylists", "x-api-path-slug"=>"playlists-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists"]}}, "/search"=>{"get"=>{"summary"=>"Get Search", "description"=>"Returns a collection of search results that match the query parameters specified in the API request. By default, a search result set identifies matching video, channel, and playlist resources, but you can also configure queries to only retrieve a specific type of resource.", "operationId"=>"getSearch", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"channelId", "description"=>"The channelId parameter indicates that the API response should only contain resources created by the channel"}, {"in"=>"query", "name"=>"channelType", "description"=>"The channelType parameter lets you restrict a search to a particular type of channel"}, {"in"=>"query", "name"=>"eventType", "description"=>"The eventType parameter restricts a search to broadcast events"}, {"in"=>"query", "name"=>"forContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"forDeveloper", "description"=>"The forDeveloper parameter restricts the search to only retrieve videos uploaded via the developers application or website"}, {"in"=>"query", "name"=>"forMine", "description"=>"The forMine parameter restricts the search to only retrieve videos owned by the authenticated user"}, {"in"=>"query", "name"=>"location", "description"=>"The location parameter, in conjunction with the locationRadius parameter, defines a circular geographic area and also restricts a search to videos that specify, in their metadata, a geographic location that falls within that area"}, {"in"=>"query", "name"=>"locationRadius", "description"=>"The locationRadius parameter, in conjunction with the location parameter, defines a circular geographic area"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maxResults parameter specifies the maximum number of items that should be returned in the result set"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"order", "description"=>"The order parameter specifies the method that will be used to order resources in the API response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include"}, {"in"=>"query", "name"=>"publishedAfter", "description"=>"The publishedAfter parameter indicates that the API response should only contain resources created after the specified time"}, {"in"=>"query", "name"=>"publishedBefore", "description"=>"The publishedBefore parameter indicates that the API response should only contain resources created before the specified time"}, {"in"=>"query", "name"=>"q", "description"=>"The q parameter specifies the query term to search for"}, {"in"=>"query", "name"=>"regionCode", "description"=>"The regionCode parameter instructs the API to return search results for the specified country"}, {"in"=>"query", "name"=>"relatedToVideoId", "description"=>"The relatedToVideoId parameter retrieves a list of videos that are related to the video that the parameter value identifies"}, {"in"=>"query", "name"=>"relevanceLanguage", "description"=>"The relevanceLanguage parameter instructs the API to return search results that are most relevant to the specified language"}, {"in"=>"query", "name"=>"safeSearch", "description"=>"The safeSearch parameter indicates whether the search results should include restricted content as well as standard content"}, {"in"=>"query", "name"=>"topicId", "description"=>"The topicId parameter indicates that the API response should only contain resources associated with the specified topic"}, {"in"=>"query", "name"=>"type", "description"=>"The type parameter restricts a search query to only retrieve a particular type of resource"}, {"in"=>"query", "name"=>"videoCaption", "description"=>"The videoCaption parameter indicates whether the API should filter video search results based on whether they have captions"}, {"in"=>"query", "name"=>"videoCategoryId", "description"=>"The videoCategoryId parameter filters video search results based on their category"}, {"in"=>"query", "name"=>"videoDefinition", "description"=>"The videoDefinition parameter lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos"}, {"in"=>"query", "name"=>"videoDimension", "description"=>"The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos"}, {"in"=>"query", "name"=>"videoDuration", "description"=>"The videoDuration parameter filters video search results based on their duration"}, {"in"=>"query", "name"=>"videoEmbeddable", "description"=>"The videoEmbeddable parameter lets you to restrict a search to only videos that can be embedded into a webpage"}, {"in"=>"query", "name"=>"videoLicense", "description"=>"The videoLicense parameter filters search results to only include videos with a particular license"}, {"in"=>"query", "name"=>"videoSyndicated", "description"=>"The videoSyndicated parameter lets you to restrict a search to only videos that can be played outside youtube"}, {"in"=>"query", "name"=>"videoType", "description"=>"The videoType parameter lets you restrict a search to a particular type of videos"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}, "/sponsors"=>{"get"=>{"summary"=>"Get Sponsors", "description"=>"Lists sponsors for a channel.", "operationId"=>"getSponsors", "x-api-path-slug"=>"sponsors-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"The filter parameter specifies which channel sponsors to return"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maxResults parameter specifies the maximum number of items that should be returned in the result set"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies the sponsor resource parts that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sponsors"]}}, "/subscriptions"=>{"delete"=>{"summary"=>"Delete Subscriptions", "description"=>"Deletes a subscription.", "operationId"=>"deleteSubscriptions", "x-api-path-slug"=>"subscriptions-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies the YouTube subscription ID for the resource that is being deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}, "get"=>{"summary"=>"Get Subscriptions", "description"=>"Returns subscription resources that match the API request criteria.", "operationId"=>"getSubscriptions", "x-api-path-slug"=>"subscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"channelId", "description"=>"The channelId parameter specifies a YouTube channel ID"}, {"in"=>"query", "name"=>"forChannelId", "description"=>"The forChannelId parameter specifies a comma-separated list of channel IDs"}, {"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of the YouTube subscription ID(s) for the resource(s) that are being retrieved"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maxResults parameter specifies the maximum number of items that should be returned in the result set"}, {"in"=>"query", "name"=>"mine", "description"=>"Set this parameters value to true to retrieve a feed of the authenticated users subscriptions"}, {"in"=>"query", "name"=>"myRecentSubscribers", "description"=>"Set this parameters value to true to retrieve a feed of the subscribers of the authenticated user in reverse chronological order (newest first)"}, {"in"=>"query", "name"=>"mySubscribers", "description"=>"Set this parameters value to true to retrieve a feed of the subscribers of the authenticated user in no particular order"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"onBehalfOfContentOwnerChannel", "description"=>"This parameter can only be used in a properly authorized request"}, {"in"=>"query", "name"=>"order", "description"=>"The order parameter specifies the method that will be used to sort resources in the API response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of one or more subscription resource properties that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}, "post"=>{"summary"=>"Add Subscriptions", "description"=>"Adds a subscription for the authenticated user's channel.", "operationId"=>"postSubscriptions", "x-api-path-slug"=>"subscriptions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/superChatEvents"=>{"get"=>{"summary"=>"Get Superchatevents", "description"=>"Lists Super Chat events for a channel.", "operationId"=>"getSuperchatevents", "x-api-path-slug"=>"superchatevents-get", "parameters"=>[{"in"=>"query", "name"=>"hl", "description"=>"The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maxResults parameter specifies the maximum number of items that should be returned in the result set"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies the superChatEvent resource parts that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat"]}}, "/thumbnails/set"=>{"post"=>{"summary"=>"Add Thumbnails Set", "description"=>"Uploads a custom video thumbnail to YouTube and sets it for a video.", "operationId"=>"postThumbnailsSet", "x-api-path-slug"=>"thumbnailsset-post", "parameters"=>[{"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"videoId", "description"=>"The videoId parameter specifies a YouTube video ID for which the custom video thumbnail is being provided"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thumbnails", "Set"]}}, "/videoAbuseReportReasons"=>{"get"=>{"summary"=>"Get Video Abuse Report Reasons", "description"=>"Returns a list of abuse reasons that can be used for reporting abusive videos.", "operationId"=>"getVeoabusereportreasons", "x-api-path-slug"=>"videoabusereportreasons-get", "parameters"=>[{"in"=>"query", "name"=>"hl", "description"=>"The hl parameter specifies the language that should be used for text values in the API response"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies the videoCategory resource parts that the API response will include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Veoabusereportreasons"]}}, "/videoCategories"=>{"get"=>{"summary"=>"Get Veocategories", "description"=>"Returns a list of categories that can be associated with YouTube videos.", "operationId"=>"getVeocategories", "x-api-path-slug"=>"videocategories-get", "parameters"=>[{"in"=>"query", "name"=>"hl", "description"=>"The hl parameter specifies the language that should be used for text values in the API response"}, {"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of video category IDs for the resources that you are retrieving"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies the videoCategory resource properties that the API response will include"}, {"in"=>"query", "name"=>"regionCode", "description"=>"The regionCode parameter instructs the API to return the list of video categories available in the specified country"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Veocategories"]}}, "/videos"=>{"delete"=>{"summary"=>"Delete Videos", "description"=>"Deletes a YouTube video.", "operationId"=>"deleteVeos", "x-api-path-slug"=>"videos-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies the YouTube video ID for the resource that is being deleted"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Veos"]}, "get"=>{"summary"=>"Get Videos", "description"=>"Returns a list of videos that match the API request parameters.", "operationId"=>"getVeos", "x-api-path-slug"=>"videos-get", "parameters"=>[{"in"=>"query", "name"=>"chart", "description"=>"The chart parameter identifies the chart that you want to retrieve"}, {"in"=>"query", "name"=>"hl", "description"=>"The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports"}, {"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved"}, {"in"=>"query", "name"=>"locale", "description"=>"DEPRECATED"}, {"in"=>"query", "name"=>"maxHeight", "description"=>"The maxHeight parameter specifies a maximum height of the embedded player"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maxResults parameter specifies the maximum number of items that should be returned in the result set"}, {"in"=>"query", "name"=>"maxWidth", "description"=>"The maxWidth parameter specifies a maximum width of the embedded player"}, {"in"=>"query", "name"=>"myRating", "description"=>"Set this parameters value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter specifies a comma-separated list of one or more video resource properties that the API response will include"}, {"in"=>"query", "name"=>"regionCode", "description"=>"The regionCode parameter instructs the API to select a video chart available in the specified region"}, {"in"=>"query", "name"=>"videoCategoryId", "description"=>"The videoCategoryId parameter identifies the video category for which the chart should be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Veos"]}, "post"=>{"summary"=>"Add Videos", "description"=>"Uploads a video to YouTube and optionally sets the video's metadata.", "operationId"=>"postVeos", "x-api-path-slug"=>"videos-post", "parameters"=>[{"in"=>"query", "name"=>"autoLevels", "description"=>"The autoLevels parameter indicates whether YouTube should automatically enhance the videos lighting and color"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"notifySubscribers", "description"=>"The notifySubscribers parameter indicates whether YouTube should send a notification about the new video to users who subscribe to the videos channel"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"onBehalfOfContentOwnerChannel", "description"=>"This parameter can only be used in a properly authorized request"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}, {"in"=>"query", "name"=>"stabilize", "description"=>"The stabilize parameter indicates whether YouTube should adjust the video to remove shaky camera motions"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Veos"]}, "put"=>{"summary"=>"Put Videos", "description"=>"Updates a video's metadata.", "operationId"=>"putVeos", "x-api-path-slug"=>"videos-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"part", "description"=>"The part parameter serves two purposes in this operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Veos"]}}, "/videos/getRating"=>{"get"=>{"summary"=>"Get Videos Get Rating", "description"=>"Retrieves the ratings that the authorized user gave to a list of specified videos.", "operationId"=>"getVeosGetrating", "x-api-path-slug"=>"videosgetrating-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) for which you are retrieving rating data"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Veos", "Getrating"]}}, "/videos/rate"=>{"post"=>{"summary"=>"Add Videos Rate", "description"=>"Add a like or dislike rating to a video or remove a rating from a video.", "operationId"=>"postVeosRate", "x-api-path-slug"=>"videosrate-post", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies the YouTube video ID of the video that is being rated or having its rating removed"}, {"in"=>"query", "name"=>"rating", "description"=>"Specifies the rating to record"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Veos", "Rate"]}}, "/videos/reportAbuse"=>{"post"=>{"summary"=>"Add Videos Report Abuse", "description"=>"Report abuse for a video.", "operationId"=>"postVeosReportabuse", "x-api-path-slug"=>"videosreportabuse-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Veos", "Reportabuse"]}}, "/watermarks/set"=>{"post"=>{"summary"=>"Add Watermarks Set", "description"=>"Uploads a watermark image to YouTube and sets it for a channel.", "operationId"=>"postWatermarksSet", "x-api-path-slug"=>"watermarksset-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"channelId", "description"=>"The channelId parameter specifies the YouTube channel ID for which the watermark is being provided"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watermarks", "Set"]}}, "/watermarks/unset"=>{"post"=>{"summary"=>"Add Watermarks Unset", "description"=>"Deletes a channel's watermark image.", "operationId"=>"postWatermarksUnset", "x-api-path-slug"=>"watermarksunset-post", "parameters"=>[{"in"=>"query", "name"=>"channelId", "description"=>"The channelId parameter specifies the YouTube channel ID for which the watermark is being unset"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watermarks", "Unset"]}}, "/groupItems"=>{"delete"=>{"summary"=>"Delete Groupitems", "description"=>"Removes an item from a group.", "operationId"=>"deleteGroupitems", "x-api-path-slug"=>"groupitems-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies the YouTube group item ID for the group that is being deleted"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groupitems"]}, "get"=>{"summary"=>"Get Groupitems", "description"=>"Returns a collection of group items that match the API request parameters.", "operationId"=>"getGroupitems", "x-api-path-slug"=>"groupitems-get", "parameters"=>[{"in"=>"query", "name"=>"groupId", "description"=>"The id parameter specifies the unique ID of the group for which you want to retrieve group items"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groupitems"]}, "post"=>{"summary"=>"Add Groupitems", "description"=>"Creates a group item.", "operationId"=>"postGroupitems", "x-api-path-slug"=>"groupitems-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groupitems"]}}, "/groups"=>{"delete"=>{"summary"=>"Delete Groups", "description"=>"Deletes a group.", "operationId"=>"deleteGroups", "x-api-path-slug"=>"groups-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies the YouTube group ID for the group that is being deleted"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, "get"=>{"summary"=>"Get Groups", "description"=>"Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.", "operationId"=>"getGroups", "x-api-path-slug"=>"groups-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved"}, {"in"=>"query", "name"=>"mine", "description"=>"Set this parameters value to true to instruct the API to only return groups owned by the authenticated user"}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pageToken parameter identifies a specific page in the result set that should be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, "post"=>{"summary"=>"Add Groups", "description"=>"Creates a group.", "operationId"=>"postGroups", "x-api-path-slug"=>"groups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, "put"=>{"summary"=>"Put Groups", "description"=>"Modifies a group. For example, you could change a group's title.", "operationId"=>"putGroups", "x-api-path-slug"=>"groups-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"onBehalfOfContentOwner", "description"=>"Note: This parameter is intended exclusively for YouTube content partners"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/reports"=>{"get"=>{"summary"=>"Get Reports", "description"=>"Retrieve your YouTube Analytics reports.", "operationId"=>"getReports", "x-api-path-slug"=>"reports-get", "parameters"=>[{"in"=>"query", "name"=>"currency", "description"=>"The currency to which financial metrics should be converted"}, {"in"=>"query", "name"=>"dimensions", "description"=>"A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender"}, {"in"=>"query", "name"=>"end-date", "description"=>"The end date for fetching YouTube Analytics data"}, {"in"=>"query", "name"=>"filters", "description"=>"A list of filters that should be applied when retrieving YouTube Analytics data"}, {"in"=>"query", "name"=>"ids", "description"=>"Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data"}, {"in"=>"query", "name"=>"include-historical-channel-data", "description"=>"If set to true historical data (i"}, {"in"=>"query", "name"=>"max-results", "description"=>"The maximum number of rows to include in the response"}, {"in"=>"query", "name"=>"metrics", "description"=>"A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes"}, {"in"=>"query", "name"=>"sort", "description"=>"A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data"}, {"in"=>"query", "name"=>"start-date", "description"=>"The start date for fetching YouTube Analytics data"}, {"in"=>"query", "name"=>"start-index", "description"=>"An index of the first entity to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
7digital{"7digital-playlist-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"7digital", "x-complete"=>1, "info"=>{"title"=>"7digital Playlist API", "description"=>"the-playlist-api-provides-access-to-playlists-created-by-7digital-users--users-can-see-a-list-of-their-own-playlists-and-public-playlists-of-other-users-create-a-new-playlist-replace-an-existing-one-and-add-or-delete-indvidual-tracks", "version"=>"1.2"}, "host"=>"api.7digital.com", "basePath"=>"1.2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"playlists"=>{"get "=>{"summary"=>"playlists", "description"=>"Returns a list of all public playlists. If an oauth_token is provided then also given users private playlists will be included in the response.", "operationId"=>"playlists", "x-api-path-slug"=>"playlists-get", "parameters"=>[nil, {"in"=>"query", "name"=>"oauth_token", "description"=>"Users OAuth access token - allows user to view Private playlist if it belongs to them"}, {"in"=>"query", "name"=>"page", "description"=>"nttttttPage number of the result set"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of items to be returned per page"}, {"in"=>"query", "name"=>"user", "description"=>"This allows you to pass the id of a user you wish to view the playlists of a specific user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists"]}}, "playlists/{playlistId}"=>{"delete "=>{"summary"=>"playlists/{playlistId}", "description"=>"Deletes the playlist at {playlistId}. The playlist can only be deleted by its owner, i.e. oauth_token representing the user has to be provided.", "operationId"=>"playlistsplaylistid", "x-api-path-slug"=>"playlistsplaylistid-delete", "parameters"=>[nil, {"in"=>"query", "name"=>"oauth_token", "description"=>"Users OAuth access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists"]}, "get "=>{"summary"=>"playlists/{playlistId}", "description"=>"Returns playlist details and track listing. Access to private playlists is only allowed when an oauth_token of the playlist owner is provided.", "operationId"=>"playlistsplaylistid", "x-api-path-slug"=>"playlistsplaylistid-get", "parameters"=>[nil, {"in"=>"query", "name"=>"oauth_token", "description"=>"Users OAuth access token - allows user to view private playlist if it belongs to them"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists"]}}, "playlists/{playlistId}/details"=>{"post "=>{"summary"=>"playlists/{playlistId}/details", "description"=>"Updates playlist details at {playlistId} with the supplied playlist details. It does not affect playlist tracks. Use this method e.g. for changing visibility of the playlist from private to public. The playlist details can only be updated by the playlist owner, i.e. oauth_token representing the user has to be provided.", "operationId"=>"playlistsplaylistiddetails", "x-api-path-slug"=>"playlistsplaylistiddetails-post", "parameters"=>[nil, {"in"=>"query", "name"=>"oauth_token", "description"=>"Users OAuth access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists", "Details"]}}, "playlists/{playlistId}/tracks/{playlisttrackid}"=>{"delete "=>{"summary"=>"playlists/{playlistId}/tracks/{playlisttrackid}", "description"=>"Removes the specified track {playlisttrackid} from the specified playlist at {playlistId}. Tracks can only be removed by the playlist owner, i.e. oauth_token representing the user has to be provided.", "operationId"=>"playlistsplaylistidtracksplaylisttrackid", "x-api-path-slug"=>"playlistsplaylistidtracksplaylisttrackid-delete", "parameters"=>[nil, {"in"=>"query", "name"=>"oauth_token", "description"=>"Users OAuth access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists", "Tracks", "Playlisttrackid"]}}}}, "7digital-catalogue-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"7digital", "x-complete"=>1, "info"=>{"title"=>"7digital Catalogue API", "description"=>"access-to-the-7digital-catalogue-api", "termsOfService"=>"http://developer.7digital.com/db/Attachments/Legal/Terms_of_Use/7digital%20Public%20API%20Terms.pdf", "version"=>"1.2"}, "host"=>"api.7digital.com", "basePath"=>"1.2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"artist/browse"=>{"get "=>{"summary"=>"artist/browse", "description"=>"This method returns a list of artists from the 7digital catalogue whose names match the start letter(s) supplied.", "operationId"=>"artistbrowse", "x-api-path-slug"=>"artistbrowse-get", "parameters"=>[nil, {"in"=>"query", "name"=>"artistId", "description"=>"unique identifier of the artist"}, {"in"=>"query", "name"=>"country", "description"=>"nttttttt 2 letter ISO country code of the country whose releases you would like to searchntttttt"}, {"in"=>"query", "name"=>"imageSize", "description"=>"nttttttt The requested width of the image in pixelsntttttt"}, {"in"=>"query", "name"=>"letter", "description"=>"The first letter(s) of the artist name to browse"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of the result set"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of items to be returned per page"}, {"in"=>"query", "name"=>"period", "description"=>"The time period for which the chart is generated"}, {"in"=>"query", "name"=>"streamable", "description"=>"If provided search results will contain only releases that can/cannot be streamed"}, {"in"=>"query", "name"=>"toDate", "description"=>"The last day the chart should include data for"}, {"in"=>"query", "name"=>"type", "description"=>"Releases can be of type album, single or video"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Artist", "Browse"]}}, "release/chart"=>{"get "=>{"summary"=>"release/chart", "description"=>"This endpoint returns a chart of the most purchased releases for given week. Only albums are included in this chart. To retrieve the most recent charts as published on 7digital.com the toDate parameter should be omitted.", "operationId"=>"releasechart", "x-api-path-slug"=>"releasechart-get", "parameters"=>[nil, {"in"=>"query", "name"=>"country", "description"=>"nttttttt 2 letter ISO country code of the country whose releases you would like to viewntttttt"}, {"in"=>"query", "name"=>"imageSize", "description"=>"nttttttt The requested width of the image in pixelsntttttt"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of the result set"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of items to be returned per page"}, {"in"=>"query", "name"=>"streamable", "description"=>"If provided search results will contain only releases that can/cannot be streamed"}, {"in"=>"query", "name"=>"toDate", "description"=>"The last day the chart should include data for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Release", "Chart"]}}, "tag"=>{"get "=>{"summary"=>"tag", "description"=>"This method returns a list of all available tags.", "operationId"=>"tag", "x-api-path-slug"=>"tag-get", "parameters"=>[nil, {"in"=>"query", "name"=>"artistId", "description"=>"The unique identifier of the artist"}, {"in"=>"query", "name"=>"country", "description"=>"nttttttt2 letter ISO country code of the country whose artists you would like to searchntttttt"}, {"in"=>"query", "name"=>"imageSize", "description"=>"ntttttttThe requested width of the image in pixelsntttttt"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of the result set"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of items to be returned per page"}, {"in"=>"query", "name"=>"streamable", "description"=>"If provided search results will contain only artists that can/cannot be streamed"}, {"in"=>"query", "name"=>"tags", "description"=>"A single or comma separated list of tags"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tag"]}}, "track/chart"=>{"get "=>{"summary"=>"track/chart", "description"=>"This endpoint returns a chart of the most purchased tracks for given week. To retrieve the most recent charts as published on 7digital.com the toDate parameter should be omitted.", "operationId"=>"trackchart", "x-api-path-slug"=>"trackchart-get", "parameters"=>[nil, {"in"=>"query", "name"=>"country", "description"=>"2 letter ISO country code of the country whose tracks you would like to search"}, {"in"=>"query", "name"=>"imageSize", "description"=>"The requested width of the image in pixels"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of the result set"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of items to be returned per page"}, {"in"=>"query", "name"=>"streamable", "description"=>"If provided search results will contain only tracks that can/cannot be streamed"}, {"in"=>"query", "name"=>"toDate", "description"=>"The last day the chart should include data for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Track", "Chart"]}}}}, "7digital-purchasing-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"7digital", "x-complete"=>1, "info"=>{"title"=>"7digital Purchasing API", "description"=>"the-purchasing-api-allows-3rd-parties-to-deliver-digital-content-to-individual-users-", "version"=>"1.2"}, "host"=>"api.7digital.com", "basePath"=>"1.2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"artist/browse"=>{"get "=>{"summary"=>"artist/browse", "description"=>"This method returns a list of artists from the 7digital catalogue whose names match the start letter(s) supplied.", "operationId"=>"artistbrowse", "x-api-path-slug"=>"artistbrowse-get", "parameters"=>[nil, {"in"=>"query", "name"=>"artistId", "description"=>"unique identifier of the artist"}, {"in"=>"query", "name"=>"country", "description"=>"nttttttt 2 letter ISO country code of the country whose releases you would like to searchntttttt"}, {"in"=>"query", "name"=>"imageSize", "description"=>"nttttttt The requested width of the image in pixelsntttttt"}, {"in"=>"query", "name"=>"letter", "description"=>"The first letter(s) of the artist name to browse"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of the result set"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of items to be returned per page"}, {"in"=>"query", "name"=>"period", "description"=>"The time period for which the chart is generated"}, {"in"=>"query", "name"=>"streamable", "description"=>"If provided search results will contain only releases that can/cannot be streamed"}, {"in"=>"query", "name"=>"toDate", "description"=>"The last day the chart should include data for"}, {"in"=>"query", "name"=>"type", "description"=>"Releases can be of type album, single or video"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Artist", "Browse"]}}, "basket"=>{"{"summary"=>"basket", "description"=>"Basket.", "operationId"=>"basket", "x-api-path-slug"=>"basket-h4", "parameters"=>[nil, {"in"=>"query", "name"=>"amountDue"}, {"in"=>"query", "name"=>"artistName"}, {"in"=>"query", "name"=>"basket id"}, {"in"=>"query", "name"=>"basketId", "description"=>"nttttttttThe unique identifier of the basket as acquired by basket/create methodnttttttt"}, {"in"=>"query", "name"=>"basketItem id"}, {"in"=>"query", "name"=>"basketItems"}, {"in"=>"query", "name"=>"country", "description"=>"The code of the country the end user resides in"}, {"in"=>"query", "name"=>"discount"}, {"in"=>"query", "name"=>"itemCount"}, {"in"=>"query", "name"=>"itemName"}, {"in"=>"query", "name"=>"package"}, {"in"=>"query", "name"=>"price"}, {"in"=>"query", "name"=>"releaseId"}, {"in"=>"query", "name"=>"trackId"}, {"in"=>"query", "name"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Basket"]}}, "basket/addpriceditem"=>{"get "=>{"summary"=>"basket/addpriceditem", "description"=>"This method allows an item to be added to a basket with a specified price. The specified price can be higher or lower than the 7digital catalogue price, including a price of 0.00 to make an item free.", "operationId"=>"basketaddpriceditem", "x-api-path-slug"=>"basketaddpriceditem-get", "parameters"=>[nil, {"in"=>"query", "name"=>"basketId", "description"=>"The unique identifier of the basket generated by the basket/create method"}, {"in"=>"query", "name"=>"country", "description"=>"nttttttttThe country that all basket items were selected from"}, {"in"=>"query", "name"=>"country/shopId", "description"=>"nttttttttA Country Code needs to be provided if you are delivering content from a 7digital international shop"}, {"in"=>"query", "name"=>"emailAddress", "description"=>"The email address of the User"}, {"in"=>"query", "name"=>"oauth_token", "description"=>"users OAuth accesstoken"}, {"in"=>"query", "name"=>"price", "description"=>"nttttttttThe custom price for the item to add to the basket e"}, {"in"=>"query", "name"=>"purchaseid", "description"=>"purchase id identifying the transaction at 7digitals end that the refunded item belongs to"}, {"in"=>"query", "name"=>"releaseId", "description"=>"The unique identifier of the release"}, {"in"=>"query", "name"=>"retailPrice", "description"=>"Compulsory if you are charging your users different prices than 7digital RRP"}, {"in"=>"query", "name"=>"shopid", "description"=>"nttttttttThe shop ID that all basket items were selected from"}, {"in"=>"query", "name"=>"trackId", "description"=>"The unique identifier of the track"}, {"in"=>"query", "name"=>"transactionId", "description"=>"The transaction ID provided will be stored along with a 7digital purchase ID in the 7digital transactions log"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Basket", "Addpriceditem"]}}, "playlists"=>{"get "=>{"summary"=>"playlists", "description"=>"Returns a list of all public playlists. If an oauth_token is provided then also given users private playlists will be included in the response.", "operationId"=>"playlists", "x-api-path-slug"=>"playlists-get", "parameters"=>[nil, {"in"=>"query", "name"=>"oauth_token", "description"=>"Users OAuth access token - allows user to view Private playlist if it belongs to them"}, {"in"=>"query", "name"=>"page", "description"=>"nttttttPage number of the result set"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of items to be returned per page"}, {"in"=>"query", "name"=>"user", "description"=>"This allows you to pass the id of a user you wish to view the playlists of a specific user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists"]}}, "playlists/{playlistId}"=>{"get "=>{"summary"=>"playlists/{playlistId}", "description"=>"Returns playlist details and track listing. Access to private playlists is only allowed when an oauth_token of the playlist owner is provided.", "operationId"=>"playlistsplaylistid", "x-api-path-slug"=>"playlistsplaylistid-get", "parameters"=>[nil, {"in"=>"query", "name"=>"oauth_token", "description"=>"Users OAuth access token - allows user to view private playlist if it belongs to them"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists"]}}, "playlists/{playlistId}/details"=>{"post "=>{"summary"=>"playlists/{playlistId}/details", "description"=>"Updates playlist details at {playlistId} with the supplied playlist details. It does not affect playlist tracks. Use this method e.g. for changing visibility of the playlist from private to public. The playlist details can only be updated by the playlist owner, i.e. oauth_token representing the user has to be provided.", "operationId"=>"playlistsplaylistiddetails", "x-api-path-slug"=>"playlistsplaylistiddetails-post", "parameters"=>[nil, {"in"=>"query", "name"=>"oauth_token", "description"=>"Users OAuth access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists", "Details"]}}, "playlists/{playlistId}/tracks/{playlisttrackid}"=>{"delete "=>{"summary"=>"playlists/{playlistId}/tracks/{playlisttrackid}", "description"=>"Removes the specified track {playlisttrackid} from the specified playlist at {playlistId}. Tracks can only be removed by the playlist owner, i.e. oauth_token representing the user has to be provided.", "operationId"=>"playlistsplaylistidtracksplaylisttrackid", "x-api-path-slug"=>"playlistsplaylistidtracksplaylisttrackid-delete", "parameters"=>[nil, {"in"=>"query", "name"=>"oauth_token", "description"=>"Users OAuth access token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists", "Tracks", "Playlisttrackid"]}}, "release/chart"=>{"get "=>{"summary"=>"release/chart", "description"=>"This endpoint returns a chart of the most purchased releases for given week. Only albums are included in this chart. To retrieve the most recent charts as published on 7digital.com the toDate parameter should be omitted.", "operationId"=>"releasechart", "x-api-path-slug"=>"releasechart-get", "parameters"=>[nil, {"in"=>"query", "name"=>"country", "description"=>"nttttttt 2 letter ISO country code of the country whose releases you would like to viewntttttt"}, {"in"=>"query", "name"=>"imageSize", "description"=>"nttttttt The requested width of the image in pixelsntttttt"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of the result set"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of items to be returned per page"}, {"in"=>"query", "name"=>"streamable", "description"=>"If provided search results will contain only releases that can/cannot be streamed"}, {"in"=>"query", "name"=>"toDate", "description"=>"The last day the chart should include data for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Release", "Chart"]}}, "tag"=>{"get "=>{"summary"=>"tag", "description"=>"This method returns a list of all available tags.", "operationId"=>"tag", "x-api-path-slug"=>"tag-get", "parameters"=>[nil, {"in"=>"query", "name"=>"artistId", "description"=>"The unique identifier of the artist"}, {"in"=>"query", "name"=>"country", "description"=>"nttttttt2 letter ISO country code of the country whose artists you would like to searchntttttt"}, {"in"=>"query", "name"=>"imageSize", "description"=>"ntttttttThe requested width of the image in pixelsntttttt"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of the result set"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of items to be returned per page"}, {"in"=>"query", "name"=>"streamable", "description"=>"If provided search results will contain only artists that can/cannot be streamed"}, {"in"=>"query", "name"=>"tags", "description"=>"A single or comma separated list of tags"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tag"]}}, "track/chart"=>{"get "=>{"summary"=>"track/chart", "description"=>"This endpoint returns a chart of the most purchased tracks for given week. To retrieve the most recent charts as published on 7digital.com the toDate parameter should be omitted.", "operationId"=>"trackchart", "x-api-path-slug"=>"trackchart-get", "parameters"=>[nil, {"in"=>"query", "name"=>"country", "description"=>"2 letter ISO country code of the country whose tracks you would like to search"}, {"in"=>"query", "name"=>"imageSize", "description"=>"The requested width of the image in pixels"}, {"in"=>"query", "name"=>"page", "description"=>"Page number of the result set"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of items to be returned per page"}, {"in"=>"query", "name"=>"streamable", "description"=>"If provided search results will contain only tracks that can/cannot be streamed"}, {"in"=>"query", "name"=>"toDate", "description"=>"The last day the chart should include data for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Track", "Chart"]}}, "user/locker"=>{"get "=>{"summary"=>"user/locker", "description"=>"Returns a paged list of releases and tracks for a users locker (collection of all purchased tracks). This method must be OAuth signed.", "operationId"=>"userlocker", "x-api-path-slug"=>"userlocker-get", "parameters"=>[nil, {"in"=>"query", "name"=>"country", "description"=>"The code of the country the end user resides in"}, {"in"=>"query", "name"=>"oauth_token", "description"=>"users OAuth accesstoken"}, {"in"=>"query", "name"=>"page", "description"=>"sets the page to be returned in paged list of the customers releases and tracks, by default this is the first page"}, {"in"=>"query", "name"=>"pagesize", "description"=>"sets the number of releases that will be returned per page, the default is 10, the maximum is 50"}, {"in"=>"query", "name"=>"purchaseId", "description"=>"nttttt If supplied will return only the releases and tracks for that basket"}, {"in"=>"query", "name"=>"releaseId", "description"=>"The 7digital ID of the release to be that we are interested in"}, {"in"=>"query", "name"=>"sort", "description"=>"nttttttOrders the returned results"}, {"in"=>"query", "name"=>"trackId", "description"=>"nttttttIf supplied together with the releaseId, will returned only that specific track (provided it exists in user locker)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Locker"]}}, "user/purchase/basket"=>{"get "=>{"summary"=>"user/purchase/basket", "description"=>"This method allows a user to purchase a basket with items that have been added via basket/additem or basket/addpriceditem. It will return the download URL of each item purchased. For example, if a release consisting of multiple tracks was purchased, then the download URL of each item constituting the release will be returned.", "operationId"=>"userpurchasebasket", "x-api-path-slug"=>"userpurchasebasket-get", "parameters"=>[nil, {"in"=>"query", "name"=>"basketid", "description"=>"This is the session ID for the basket that contains the items to purchase"}, {"in"=>"query", "name"=>"country", "description"=>"nttttttttThe country that all basket items were selected from"}, {"in"=>"query", "name"=>"oauth_token", "description"=>"users OAuth accesstoken"}, {"in"=>"query", "name"=>"shopid", "description"=>"nttttttttThe shop ID that all basket items were selected from"}, {"in"=>"query", "name"=>"tag_*key*", "description"=>"nttttttttAdditional data to be stored with successful transactions, for the purposes such as tagging affiliated or marketing information"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Purchase", "Basket"]}}, "user/purchase/item"=>{"get "=>{"summary"=>"user/purchase/item", "description"=>"This method allows a user to purchase an item at the price as advertised on 7digital.com. It will return the download URL of each item purchased. For example, if a release consisting of multiple tracks was purchased, then the download URL of each item constituting the release will be returned.nttttttFor a user purchase to be processed, the user should already have a default debit or credit card set up for payments.ntttThis method allows users to take advantage of 7digital.com promotional offers and is only available to selected partners building 7digital branded integrations. For white-label integrations please use user/purchase/rrpItem or user/purchase/pricedItem.", "operationId"=>"userpurchaseitem", "x-api-path-slug"=>"userpurchaseitem-get", "parameters"=>[nil, {"in"=>"query", "name"=>"country", "description"=>"The code of the country the end user resides in"}, {"in"=>"query", "name"=>"oauth_token", "description"=>"users OAuth accesstoken"}, {"in"=>"query", "name"=>"price", "description"=>"nttttttttThe price that has been displayed to the user prior to purchase"}, {"in"=>"query", "name"=>"releaseId", "description"=>"The unique ID of the release being purchased"}, {"in"=>"query", "name"=>"shopid", "description"=>"nttttttttThe shop ID that all basket items were selected from"}, {"in"=>"query", "name"=>"tag_*key*", "description"=>"nttttttttAdditional data to be stored with successful transactions, for the purposes such as tagging affiliated or marketing information"}, {"in"=>"query", "name"=>"trackId", "description"=>"The unique ID of the track being purchased"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Purchase", "Item"]}}, "user/purchase/rrpItem"=>{"get "=>{"summary"=>"user/purchase/rrpItem", "description"=>"This method allows a user to purchase an item at 7digital recommended retail price (RRP). It will return the download URL of each item purchased. For example, if a release consisting of multiple tracks was purchased, then the download URL of each item constituting the release will be returned.nttttttFor a user purchase to be processed, the user should already have a default debit or credit card set up for payments.", "operationId"=>"userpurchaserrpitem", "x-api-path-slug"=>"userpurchaserrpitem-get", "parameters"=>[nil, {"in"=>"query", "name"=>"country", "description"=>"nttttttttThe country that all basket items were selected from"}, {"in"=>"query", "name"=>"oauth_token", "description"=>"users OAuth accesstoken"}, {"in"=>"query", "name"=>"price", "description"=>"nttttttttThe price that has been displayed to the user prior to purchase"}, {"in"=>"query", "name"=>"releaseId", "description"=>"The unique ID of the release being purchased"}, {"in"=>"query", "name"=>"shopid", "description"=>"nttttttttThe shop ID that all basket items were selected from"}, {"in"=>"query", "name"=>"tag_*key*", "description"=>"nttttttttAdditional data to be stored with successful transactions, for the purposes such as tagging affiliated or marketing information"}, {"in"=>"query", "name"=>"trackId", "description"=>"The unique ID of the track being purchased"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Purchase", "RrpItem"]}}, "user/purchase/{purchaseid}/track/{trackid}"=>{"delete "=>{"summary"=>"user/purchase/{purchaseid}/track/{trackid}", "description"=>"This method allows a user to remove a purchase of a track from the sales report when the purchase has been refunded.", "operationId"=>"userpurchasepurchaseidtracktrackid", "x-api-path-slug"=>"userpurchasepurchaseidtracktrackid-delete", "parameters"=>[nil, {"in"=>"query", "name"=>"purchaseid", "description"=>"purchase id identifying the transaction at 7digitals end that the refunded item belongs to"}, {"in"=>"query", "name"=>"trackid", "description"=>"nttttttttThe 7digital id of the track being refundednnttttttt"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Purchase", "Purchaseid", "Track", "Trackid"]}}}}, "7digital-basket-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"7digital", "x-complete"=>1, "info"=>{"title"=>"7digital Basket API", "description"=>"the-basket-api-allows-creation-of-7digital-hosted-baskets-which-can-be-populated-with-items-tracks-and-releases-from-the-7digital-catalogue-", "termsOfService"=>"http://developer.7digital.com/db/Attachments/Legal/Terms_of_Use/7digital%20Public%20API%20Terms.pdf", "version"=>"1.2"}, "host"=>"api.7digital.com", "basePath"=>"1.2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"basket"=>{" |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
clearbit{"clearbit-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Clearbit", "x-complete"=>1, "info"=>{"title"=>"Clearbit", "description"=>"welcome-to-clearbits-api-you-can-use-this-api-to-access-all-our-api-endpoints-such-as-the-person-api-to-look-up-email-addresses-or-the-company-api-to-look-up-company-information-related-to-a-domain-name-", "version"=>"1.0.0"}, "host"=>"discovery.clearbit.com", "basePath"=>"/v1/companies", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/search"=>{"get"=>{"summary"=>"Find Contacts - Job Title", "description"=>"TODO: Add Description", "operationId"=>"SearchGet3", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"domain"}, {"in"=>"query", "name"=>"email"}, {"in"=>"query", "name"=>"title"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}, "/v2/companies/find"=>{"get"=>{"summary"=>"Domain Lookup", "description"=>"TODO: Add Description", "operationId"=>"V2CompaniesFindGet", "x-api-path-slug"=>"v2companiesfind-get", "parameters"=>[{"in"=>"query", "name"=>"domain"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "Find"]}}, "/find"=>{"get"=>{"summary"=>"Find Company by IP Address", "description"=>"TODO: Add Description", "operationId"=>"FindGet2", "x-api-path-slug"=>"find-get", "parameters"=>[{"in"=>"query", "name"=>"ip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find"]}}, "/v1/domains/find"=>{"get"=>{"summary"=>"Company Name to Domain", "description"=>"TODO: Add Description", "operationId"=>"V1DomainsFindGet", "x-api-path-slug"=>"v1domainsfind-get", "parameters"=>[{"in"=>"query", "name"=>"name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains", "Find"]}}, "/entities"=>{"get"=>{"summary"=>"By Name", "description"=>"TODO: Add Description", "operationId"=>"EntitiesGet", "x-api-path-slug"=>"entities-get", "parameters"=>[{"in"=>"query", "name"=>"name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entities"]}}}}, "apis"=>{"name"=>"Clearbit", "x-slug"=>"clearbit", "description"=>"Clearbit provides powerful products and data APIs to help your business grow. Contact enrichment, lead generation, financial compliance, and more...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11319-clearbit.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"46525", "tags"=>"API Provider,Business,Business Intelligence,General Data,Profiles,SaaS,Service API,Stack Network,Target,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"clearbit/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Clearbit", "x-api-slug"=>"clearbit", "description"=>"Clearbit provides powerful products and data APIs to help your business grow. Contact enrichment, lead generation, financial compliance, and more...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11319-clearbit.jpg", "humanURL"=>"http://blog.clearbit.com", "baseURL"=>"https://discovery.clearbit.com//v1/companies", "tags"=>"API Provider,Business,Business Intelligence,General Data,Profiles,SaaS,Service API,Stack Network,Target,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/clearbit/entities-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/clearbit/clearbit-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://blog.clearbit.co/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.clearbit.co/feed"}, {"type"=>"x-curated-source", "url"=>"http://blog.clearbit.com/segment-integration/"}, {"type"=>"x-website", "url"=>"http://blog.clearbit.com"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/clearbit"}, {"type"=>"x-email", "url"=>"success@clearbit.com"}, {"type"=>"x-email", "url"=>"support@clearbit.com"}, {"type"=>"x-github", "url"=>"https://github.com/clearbit"}, {"type"=>"x-pricing", "url"=>"https://clearbit.com/pricing"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/clearbit"}, {"type"=>"x-website", "url"=>"http://clearbit.com"}, {"type"=>"x-website", "url"=>"https://clearbit.com"}, {"type"=>"x-website", "url"=>"https://clearbit.co"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bank-of-ireland{"bank-of-ireland-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bank of Ireland", "x-complete"=>1, "info"=>{"title"=>"Bank of Ireland", "description"=>"this-is-an-openapi-definition-for-the-standard-set-of-open-banking-httpopenbankingapis-io-apis-for-the-bank-of-ireland-", "termsOfService"=>"https://www.openbanking.org.uk/open-licence/", "contact"=>{"name"=>"API Evangelist", "url"=>"https://apievangelist.com", "email"=>"info@apievangelist.com"}, "version"=>"1.0.0"}, "host"=>"openapi.bankofireland.com", "basePath"=>"open-banking/v2.1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"atms/"=>{"get"=>{"summary"=>"Get Atms", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can provide multiple ATMs.", "operationId"=>"getATMS", "x-api-path-slug"=>"atms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Atms"]}}, "branches/"=>{"get"=>{"summary"=>"Get Branches", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple branches.", "operationId"=>"getBranches", "x-api-path-slug"=>"branches-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branches"]}}, "personal-current-accounts/"=>{"get"=>{"summary"=>"Get Personal Current Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple PCA products.", "operationId"=>"getCurrentPersonalAccounts", "x-api-path-slug"=>"personalcurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Personal", "Current", "Accounts"]}}, "business-current-accounts/"=>{"get"=>{"summary"=>"Get Business Current Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple BCA products.", "operationId"=>"getCurentBusinessAccounts", "x-api-path-slug"=>"businesscurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Business", "Current", "Accounts"]}}, "unsecured-sme-loans/"=>{"get"=>{"summary"=>"Get Unsecured Sme Loans", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Unsecured Loan products.", "operationId"=>"pathOperation", "x-api-path-slug"=>"unsecuredsmeloans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsecured", "Sme", "Loans"]}}, "commercial-credit-cards/"=>{"get"=>{"summary"=>"Get Commercial Credit Cards", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Commercial Credit Card products.", "operationId"=>"getCommercialCreditCards", "x-api-path-slug"=>"commercialcreditcards-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commercial", "Credit", "Cards"]}}}}, "apis"=>{"name"=>"Bank of Ireland", "x-slug"=>"bank-of-ireland", "description"=>"Bank of Ireland Group plc is a public limited company incorporated in Ireland, with its registered office at 40 Mespil Road, Dublin 4 and registered number 593672. Bank of Ireland Group plc, whose shares are listed on the main markets of the Irish Stock Exchange plc and the London Stock Exchange plc , is the holding company of Bank of Ireland.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/bank-of-ireland.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Provider,ATMs,Banking,General Data,Profiles,Relative Data,UK Banks,UK Banks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bank-of-ireland/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Bank of Ireland", "x-api-slug"=>"bank-of-ireland", "description"=>"Bank of Ireland Group plc is a public limited company incorporated in Ireland, with its registered office at 40 Mespil Road, Dublin 4 and registered number 593672. Bank of Ireland Group plc, whose shares are listed on the main markets of the Irish Stock Exchange plc and the London Stock Exchange plc , is the holding company of Bank of Ireland.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/bank-of-ireland.jpg", "humanURL"=>"https://www.bankofireland.com/", "baseURL"=>"https://openapi.bankofireland.com/open-banking/v2.1/", "tags"=>"API Provider,ATMs,Banking,General Data,Profiles,Relative Data,UK Banks,UK Banks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bank-of-ireland/commercialcreditcards-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bank-of-ireland/bank-of-ireland-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"http://openbankingapis.io/ireland/bank-of-ireland"}, {"type"=>"x-documentation", "url"=>"https://openbanking.atlassian.net/wiki/spaces/DZ/pages/54919225/Open+Data+API+Dashboard#"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/talktoBOI"}, {"type"=>"x-website", "url"=>"https://www.bankofireland.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-fit{"google-fit-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Fit", "x-complete"=>1, "info"=>{"title"=>"Fitness", "description"=>"stores-and-accesses-user-data-in-the-fitness-store-from-apps-on-any-platform-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"www.googleapis.com", "basePath"=>"/fitness/v1/users", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{userId}/dataSources"=>{"get"=>{"summary"=>"Get Data Sources", "description"=>"Lists all data sources that are visible to the developer, using the OAuth scopes provided. The list is not exhaustive; the user may have private data sources that are only visible to other developers, or calls using other scopes.", "operationId"=>"fitness.users.dataSources.list", "x-api-path-slug"=>"useriddatasources-get", "parameters"=>[{"in"=>"query", "name"=>"dataTypeName", "description"=>"The names of data types to include in the list"}, {"in"=>"path", "name"=>"userId", "description"=>"List data sources for the person identified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data Source"]}, "post"=>{"summary"=>"Create Data Source", "description"=>"Creates a new data source that is unique across all data sources belonging to this user. The data stream ID field can be omitted and will be generated by the server with the correct format. The data stream ID is an ordered combination of some fields from the data source. In addition to the data source fields reflected into the data source ID, the developer project number that is authenticated when creating the data source is included. This developer project number is obfuscated when read by any other developer reading public data types.", "operationId"=>"fitness.users.dataSources.create", "x-api-path-slug"=>"useriddatasources-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"Create the data source for the person identified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data Source"]}}, "/{userId}/dataSources/{dataSourceId}"=>{"delete"=>{"summary"=>"Delete Data Source", "description"=>"Deletes the specified data source. The request will fail if the data source contains any data points.", "operationId"=>"fitness.users.dataSources.delete", "x-api-path-slug"=>"useriddatasourcesdatasourceid-delete", "parameters"=>[{"in"=>"path", "name"=>"dataSourceId", "description"=>"The data stream ID of the data source to delete"}, {"in"=>"path", "name"=>"userId", "description"=>"Retrieve a data source for the person identified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data Source"]}, "get"=>{"summary"=>"Get Data Source", "description"=>"Returns the specified data source.", "operationId"=>"fitness.users.dataSources.get", "x-api-path-slug"=>"useriddatasourcesdatasourceid-get", "parameters"=>[{"in"=>"path", "name"=>"dataSourceId", "description"=>"The data stream ID of the data source to retrieve"}, {"in"=>"path", "name"=>"userId", "description"=>"Retrieve a data source for the person identified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data Source"]}, "patch"=>{"summary"=>"Update Data Source", "description"=>"Updates the specified data source. The dataStreamId, dataType, type, dataStreamName, and device properties with the exception of version, cannot be modified.\n\nData sources are identified by their dataStreamId. This method supports patch semantics.", "operationId"=>"fitness.users.dataSources.patch", "x-api-path-slug"=>"useriddatasourcesdatasourceid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"dataSourceId", "description"=>"The data stream ID of the data source to update"}, {"in"=>"path", "name"=>"userId", "description"=>"Update the data source for the person identified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data Source"]}, "put"=>{"summary"=>"Update Data Source", "description"=>"Updates the specified data source. The dataStreamId, dataType, type, dataStreamName, and device properties with the exception of version, cannot be modified.\n\nData sources are identified by their dataStreamId.", "operationId"=>"fitness.users.dataSources.update", "x-api-path-slug"=>"useriddatasourcesdatasourceid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"dataSourceId", "description"=>"The data stream ID of the data source to update"}, {"in"=>"path", "name"=>"userId", "description"=>"Update the data source for the person identified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data Source"]}}, "/{userId}/dataSources/{dataSourceId}/datasets/{datasetId}"=>{"delete"=>{"summary"=>"Delete All Data Source Datasets", "description"=>"Performs an inclusive delete of all data points whose start and end times have any overlap with the time range specified by the dataset ID. For most data types, the entire data point will be deleted. For data types where the time span represents a consistent value (such as com.google.activity.segment), and a data point straddles either end point of the dataset, only the overlapping portion of the data point will be deleted.", "operationId"=>"fitness.users.dataSources.datasets.delete", "x-api-path-slug"=>"useriddatasourcesdatasourceiddatasetsdatasetid-delete", "parameters"=>[{"in"=>"query", "name"=>"currentTimeMillis", "description"=>"The clients current time in milliseconds since epoch"}, {"in"=>"path", "name"=>"datasetId", "description"=>"Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch"}, {"in"=>"path", "name"=>"dataSourceId", "description"=>"The data stream ID of the data source that created the dataset"}, {"in"=>"query", "name"=>"modifiedTimeMillis", "description"=>"When the operation was performed on the client"}, {"in"=>"path", "name"=>"userId", "description"=>"Delete a dataset for the person identified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}, "get"=>{"summary"=>"Get All Data Source Datasets", "description"=>"Returns a dataset containing all data points whose start and end times overlap with the specified range of the dataset minimum start time and maximum end time. Specifically, any data point whose start time is less than or equal to the dataset end time and whose end time is greater than or equal to the dataset start time.", "operationId"=>"fitness.users.dataSources.datasets.get", "x-api-path-slug"=>"useriddatasourcesdatasourceiddatasetsdatasetid-get", "parameters"=>[{"in"=>"path", "name"=>"datasetId", "description"=>"Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch"}, {"in"=>"path", "name"=>"dataSourceId", "description"=>"The data stream ID of the data source that created the dataset"}, {"in"=>"query", "name"=>"limit", "description"=>"If specified, no more than this many data points will be included in the dataset"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The continuation token, which is used to page through large datasets"}, {"in"=>"path", "name"=>"userId", "description"=>"Retrieve a dataset for the person identified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}, "patch"=>{"summary"=>"Add Data Point To Data Source Datasets", "description"=>"Adds data points to a dataset. The dataset need not be previously created. All points within the given dataset will be returned with subsquent calls to retrieve this dataset. Data points can belong to more than one dataset. This method does not use patch semantics.", "operationId"=>"fitness.users.dataSources.datasets.patch", "x-api-path-slug"=>"useriddatasourcesdatasourceiddatasetsdatasetid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"currentTimeMillis", "description"=>"The clients current time in milliseconds since epoch"}, {"in"=>"path", "name"=>"datasetId", "description"=>"Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch"}, {"in"=>"path", "name"=>"dataSourceId", "description"=>"The data stream ID of the data source that created the dataset"}, {"in"=>"path", "name"=>"userId", "description"=>"Patch a dataset for the person identified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}}, "/{userId}/dataset:aggregate"=>{"post"=>{"summary"=>"Get Aggregate Data", "description"=>"Aggregates data of a certain type or stream into buckets divided by a given type of boundary. Multiple data sets of multiple types and from multiple sources can be aggreated into exactly one bucket type per request.", "operationId"=>"fitness.users.dataset.aggregate", "x-api-path-slug"=>"useriddatasetaggregate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"Aggregate data for the person identified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Aggregation"]}}, "/{userId}/sessions"=>{"get"=>{"summary"=>"Get Sessions", "description"=>"Lists sessions previously created.", "operationId"=>"fitness.users.sessions.list", "x-api-path-slug"=>"useridsessions-get", "parameters"=>[{"in"=>"query", "name"=>"endTime", "description"=>"An RFC3339 timestamp"}, {"in"=>"query", "name"=>"includeDeleted", "description"=>"If true, deleted sessions will be returned"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The continuation token, which is used to page through large result sets"}, {"in"=>"query", "name"=>"startTime", "description"=>"An RFC3339 timestamp"}, {"in"=>"path", "name"=>"userId", "description"=>"List sessions for the person identified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session"]}}, "/{userId}/sessions/{sessionId}"=>{"delete"=>{"summary"=>"Delete Session", "description"=>"Deletes a session specified by the given session ID.", "operationId"=>"fitness.users.sessions.delete", "x-api-path-slug"=>"useridsessionssessionid-delete", "parameters"=>[{"in"=>"query", "name"=>"currentTimeMillis", "description"=>"The clients current time in milliseconds since epoch"}, {"in"=>"path", "name"=>"sessionId", "description"=>"The ID of the session to be deleted"}, {"in"=>"path", "name"=>"userId", "description"=>"Delete a session for the person identified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session"]}, "put"=>{"summary"=>"Update Session", "description"=>"Updates or insert a given session.", "operationId"=>"fitness.users.sessions.update", "x-api-path-slug"=>"useridsessionssessionid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"currentTimeMillis", "description"=>"The clients current time in milliseconds since epoch"}, {"in"=>"path", "name"=>"sessionId", "description"=>"The ID of the session to be created"}, {"in"=>"path", "name"=>"userId", "description"=>"Create sessions for the person identified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session"]}}}}, "apis"=>{"name"=>"Google Fit", "x-slug"=>"google-fit", "description"=>"Google Fit is an open ecosystem that allows developers to upload fitness data to a central repository where users can access their data from different devices and apps in one location. Fitness apps can store data from any wearable or sensor. Fitness apps can access data created by any app. Users fitness data is persisted when they upgrade their fitness devices.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-fit.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Fitness,Google APIs,Profiles,Relative Data,Service API,Stack Network,Wearables", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-fit/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Fit API", "x-api-slug"=>"google-fit-api", "description"=>"Google Fit is an open ecosystem that allows developers to upload fitness data to a central repository where users can access their data from different devices and apps in one location. Fitness apps can store data from any wearable or sensor. Fitness apps can access data created by any app. Users fitness data is persisted when they upgrade their fitness devices.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-fit.jpg", "humanURL"=>"https://developers.google.com/fit/overview", "baseURL"=>"://www.googleapis.com//fitness/v1/users", "tags"=>"API Provider,API Service Provider,Fitness,Google APIs,Profiles,Relative Data,Service API,Stack Network,Wearables", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-fit/google-fit-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://developers.google.com/fit/android/get-api-key"}, {"type"=>"x-getting-started", "url"=>"https://developers.google.com/fit/rest/v1/get-started"}, {"type"=>"x-website", "url"=>"https://developers.google.com/fit/overview"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-documentdb{"azure-documentdb-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure DocumentDB", "x-complete"=>1, "info"=>{"title"=>"DocumentDB", "description"=>"azure-documentdb-database-service-resource-provider-rest-api", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}"=>{"get"=>{"summary"=>"Database Accounts Get", "description"=>"Retrieves the properties of an existing Azure DocumentDB database account.", "operationId"=>"DatabaseAccounts_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-documentdbdatabaseaccountsaccountname-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Database", "Accounts"]}, "patch"=>{"summary"=>"Database Accounts Patch", "description"=>"Patches the properties of an existing Azure DocumentDB database account.", "operationId"=>"DatabaseAccounts_Patch", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-documentdbdatabaseaccountsaccountname-patch", "parameters"=>[{"in"=>"body", "name"=>"updateParameters", "description"=>"The tags parameter to patch for the current database account", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Database", "Accounts", "Patch"]}, "put"=>{"summary"=>"Database Accounts Create Or Update", "description"=>"Creates or updates an Azure DocumentDB database account.", "operationId"=>"DatabaseAccounts_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-documentdbdatabaseaccountsaccountname-put", "parameters"=>[{"in"=>"body", "name"=>"createUpdateParameters", "description"=>"The parameters to provide for the current database account", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Database", "Accounts", "Or"]}, "delete"=>{"summary"=>"Database Accounts Delete", "description"=>"Deletes an existing Azure DocumentDB database account.", "operationId"=>"DatabaseAccounts_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-documentdbdatabaseaccountsaccountname-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Database", "Accounts"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/failoverPriorityChange"=>{"post"=>{"summary"=>"Database Accounts Failover Priority Change", "description"=>"Changes the failover priority for the Azure DocumentDB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.", "operationId"=>"DatabaseAccounts_FailoverPriorityChange", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-documentdbdatabaseaccountsaccountnamefailoverprioritychange-post", "parameters"=>[{"in"=>"body", "name"=>"failoverParameters", "description"=>"The new failover policies for the database account", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Database", "Accounts", "Failover", "Priority", "Change"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/databaseAccounts"=>{"get"=>{"summary"=>"Database Accounts List", "description"=>"Lists all the Azure DocumentDB database accounts available under the subscription.", "operationId"=>"DatabaseAccounts_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-documentdbdatabaseaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Database", "Accounts", "List"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts"=>{"get"=>{"summary"=>"Database Accounts List By Resource Group", "description"=>"Lists all the Azure DocumentDB database accounts available under the given resource group.", "operationId"=>"DatabaseAccounts_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-documentdbdatabaseaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Database", "Accounts", "ListResource", "Group"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listKeys"=>{"post"=>{"summary"=>"Database Accounts List Keys", "description"=>"Lists the access keys for the specified Azure DocumentDB database account.", "operationId"=>"DatabaseAccounts_ListKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-documentdbdatabaseaccountsaccountnamelistkeys-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Database", "Accounts", "List", "Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listConnectionStrings"=>{"post"=>{"summary"=>"Database Accounts List Connection Strings", "description"=>"Lists the connection strings for the specified Azure DocumentDB database account.", "operationId"=>"DatabaseAccounts_ListConnectionStrings", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-documentdbdatabaseaccountsaccountnamelistconnectionstrings-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Database", "Accounts", "List", "Connection", "Strings"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys"=>{"get"=>{"summary"=>"Database Accounts List Read Only Keys", "description"=>"Lists the read-only access keys for the specified Azure DocumentDB database account.", "operationId"=>"DatabaseAccounts_ListReadOnlyKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-documentdbdatabaseaccountsaccountnamereadonlykeys-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Database", "Accounts", "List", "Read", "Only", "Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/regenerateKey"=>{"post"=>{"summary"=>"Database Accounts Regenerate Key", "description"=>"Regenerates an access key for the specified Azure DocumentDB database account.", "operationId"=>"DatabaseAccounts_RegenerateKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-documentdbdatabaseaccountsaccountnameregeneratekey-post", "parameters"=>[{"in"=>"body", "name"=>"keyToRegenerate", "description"=>"The name of the key to regenerate", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Database", "Accounts", "Regenerate", "Key"]}}, "/providers/Microsoft.DocumentDB/databaseAccountNames/{accountName}"=>{"head"=>{"summary"=>"Database Accounts Check Name Exists", "description"=>"Checks that the Azure DocumentDB account name already exists. A valid account name may contain only lowercase letters, numbers, and the '-' character, and must be between 3 and 50 characters.", "operationId"=>"DatabaseAccounts_CheckNameExists", "x-api-path-slug"=>"providersmicrosoft-documentdbdatabaseaccountnamesaccountname-head", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Database", "Accounts", "Checks", "Name", "Exists"]}}}}, "apis"=>{"name"=>"Azure DocumentDB", "x-slug"=>"azure-documentdb", "description"=>"Azure DocumentDB is a fully-managed NoSQL document database service that offers querying and transaction-processing over schema-free data, predictable and reliable performance, and rapid development.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-document-db-03-replicate.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Databases,Documents,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-documentdb/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure DocumentDB API", "x-api-slug"=>"azure-documentdb-api", "description"=>"Azure DocumentDB is a fully-managed NoSQL document database service that offers querying and transaction-processing over schema-free data, predictable and reliable performance, and rapid development.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-document-db-03-replicate.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/documentdb/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Databases,Documents,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-documentdb/providersmicrosoft-documentdbdatabaseaccountnamesaccountname-head-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-documentdb/azure-documentdb-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/documentdb/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/documentdb/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/documentdb/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/documentdb/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
tropo{"tropo-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Tropo", "x-complete"=>1, "info"=>{"title"=>"Tropo", "description"=>"tropo-is-a-cloud-communications-api-and-platform-for-building-scalable-voice-and-sms-applications-", "version"=>"v1"}, "host"=>"api.tropo.com", "basePath"=>"/v1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/applications"=>{"delete"=>{"summary"=>"Delete Applications", "description"=>"Delete applications.", "operationId"=>"deleteApplications", "x-api-path-slug"=>"applications-delete", "parameters"=>[{"in"=>"query", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}, "get"=>{"summary"=>"Get Applications", "description"=>"Get applications.", "operationId"=>"getApplications", "x-api-path-slug"=>"applications-get", "parameters"=>[{"in"=>"query", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}, "post"=>{"summary"=>"Post Applications", "description"=>"Post applications.", "operationId"=>"postApplications", "x-api-path-slug"=>"applications-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}, "put"=>{"summary"=>"Put Applications", "description"=>"Put applications.", "operationId"=>"putApplications", "x-api-path-slug"=>"applications-put", "parameters"=>[{"in"=>"query", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/applications/{AppId}/addresses"=>{"delete"=>{"summary"=>"Delete Applications Appid Addresses", "description"=>"Delete applications appid addresses.", "operationId"=>"deleteApplicationsAppAddresses", "x-api-path-slug"=>"applicationsappidaddresses-delete", "parameters"=>[{"in"=>"path", "name"=>"AppId"}, {"in"=>"query", "name"=>"applicationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "AppId", "Addresses"]}, "get"=>{"summary"=>"Get Applications Appid Addresses", "description"=>"Get applications appid addresses.", "operationId"=>"getApplicationsAppAddresses", "x-api-path-slug"=>"applicationsappidaddresses-get", "parameters"=>[{"in"=>"path", "name"=>"AppId"}, {"in"=>"query", "name"=>"applicationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "AppId", "Addresses"]}, "post"=>{"summary"=>"Post Applications Appid Addresses", "description"=>"Post applications appid addresses.", "operationId"=>"postApplicationsAppAddresses", "x-api-path-slug"=>"applicationsappidaddresses-post", "parameters"=>[{"in"=>"path", "name"=>"AppId"}, {"in"=>"query", "name"=>"applicationId"}, {"in"=>"query", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "AppId", "Addresses"]}}, "/exchanges"=>{"get"=>{"summary"=>"Get Exchanges", "description"=>"Get exchanges.", "operationId"=>"getExchanges", "x-api-path-slug"=>"exchanges-get", "parameters"=>[{"in"=>"query", "name"=>"applicationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Exchanges"]}}, "/sessions"=>{"post"=>{"summary"=>"Post Sessions", "description"=>"Post sessions.", "operationId"=>"postSessions", "x-api-path-slug"=>"sessions-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions"]}}}}, "apis"=>{"name"=>"Tropo", "x-slug"=>"tropo", "description"=>"Hosted Voice and SMS API", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/264-tropo.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"641468", "tags"=>"Instant Message,Messages,Mobile,Relative Data,SaaS,Service API,SMS,Speech,Technology,Telecommunications,Telecommunications,Telephony,Voice,Voice,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"tropo/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Tropo", "x-api-slug"=>"tropo", "description"=>"Add Voice, SMS, Twitter, and IM to Your Applications. Tropo is a powerful yet simple API that adds Voice, SMS, Twitter, and IM support to the programming languages you already know.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/264-tropo.jpg", "humanURL"=>"https://www.tropo.com/", "baseURL"=>"https://api.tropo.com//v1/", "tags"=>"Instant Message,Messages,Mobile,Relative Data,SaaS,Service API,SMS,Speech,Technology,Telecommunications,Telecommunications,Telephony,Voice,Voice,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/tropo/sessions-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/tropo/tropo-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.tropo.com"}, {"type"=>"x-blog", "url"=>"https://www.tropo.com/category/blog/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/tropo"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/tropo"}, {"type"=>"x-developer", "url"=>"https://www.tropo.com/docs/"}, {"type"=>"x-email", "url"=>"support@tropo.com"}, {"type"=>"x-faq", "url"=>"https://www.tropo.com/docs/tropo-faq/"}, {"type"=>"x-forum", "url"=>"https://www.tropo.com/get-help/forums"}, {"type"=>"x-github", "url"=>"https://github.com/tropo"}, {"type"=>"x-pricing", "url"=>"https://www.tropo.com/pricing/"}, {"type"=>"x-privacy", "url"=>"https://www.tropo.com/privacy-policy/"}, {"type"=>"x-status", "url"=>"http://status.tropo.com/"}, {"type"=>"x-terms-of-service", "url"=>"https://www.tropo.com/terms-policies/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/tropo"}, {"type"=>"x-webhook", "url"=>"https://www.tropo.com/docs/webhooks"}, {"type"=>"x-website", "url"=>"https://www.tropo.com/"}, {"type"=>"x-website", "url"=>"http://tropo.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
venmo{"venmo-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Venmo", "x-complete"=>1, "info"=>{"title"=>"Venmo API", "description"=>"the-venmo-api-provides-developers-a-straightforward-way-to-integrate-venmo-into-their-applications--", "version"=>"1.0.0"}, "host"=>"api.venmo.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/me"=>{"get"=>{"summary"=>"Get Me", "description"=>"Get me.", "operationId"=>"getMe", "x-api-path-slug"=>"me-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me"]}}, "/payments"=>{"get"=>{"summary"=>"Get Payments", "description"=>"Get payments.", "operationId"=>"getPayments", "x-api-path-slug"=>"payments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}, "post"=>{"summary"=>"Post Payments", "description"=>"Post payments.", "operationId"=>"postPayments", "x-api-path-slug"=>"payments-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}}, "/payments/{id}"=>{"get"=>{"summary"=>"Get Payments", "description"=>"Get payments.", "operationId"=>"getPayments", "x-api-path-slug"=>"paymentsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Id"]}}, "/users/{user_id}"=>{"get"=>{"summary"=>"Get Users User", "description"=>"Get users user.", "operationId"=>"getUsersUser", "x-api-path-slug"=>"usersuser-id-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id"]}}, "/users/{user_id}/friends"=>{"get"=>{"summary"=>"Get Users User Friends", "description"=>"Get users user friends.", "operationId"=>"getUsersUserFriends", "x-api-path-slug"=>"usersuser-idfriends-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Friends"]}}}}, "apis"=>{"name"=>"Venmo", "x-slug"=>"venmo", "description"=>"Venmo is a free digital wallet that lets you make and share payments with friends. You can easily split the bill, cab fare, or much more. Download the iOS or Android app or sign up on Venmo.com today.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2177-venmo.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"3421", "tags"=>"API LIfeyclessss,Financial Services,Getting Started Example,internet,Mobile,Payments,Payments,Relative Data,Service API,Social,Stack Network,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"venmo/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Venmo API", "x-api-slug"=>"venmo-api", "description"=>"The Venmo API provides developers a straightforward way to integrate Venmo into their applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2177-venmo.jpg", "humanURL"=>"https://venmo.com/", "baseURL"=>"https://api.venmo.com//v1", "tags"=>"API LIfeyclessss,Financial Services,Getting Started Example,internet,Mobile,Payments,Payments,Relative Data,Service API,Social,Stack Network,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/venmo/usersuser-idfriends-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/venmo/venmo-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-android-sdk", "url"=>"https://github.com/venmo/app-switch-android"}, {"type"=>"x-authentication", "url"=>"https://developer.venmo.com/docs/authentication"}, {"type"=>"x-blog", "url"=>"http://blog.venmo.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.venmo.com/rss"}, {"type"=>"x-branding", "url"=>"http://brand.venmo.com/styleguide"}, {"type"=>"x-buttons", "url"=>"https://developer.venmo.com/docs/widgets/venmo-button"}, {"type"=>"x-console", "url"=>"https://developer.venmo.com/docs/api-console"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/venmo"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/venmo"}, {"type"=>"x-developer", "url"=>"https://developer.venmo.com/"}, {"type"=>"x-email", "url"=>"press@venmo.com"}, {"type"=>"x-email", "url"=>"cardsupport@venmo.com"}, {"type"=>"x-email", "url"=>"venmo@venmo.com"}, {"type"=>"x-email", "url"=>"Support@venmo.com"}, {"type"=>"x-email", "url"=>"privacy@venmo.com"}, {"type"=>"x-email", "url"=>"legal+useragreement@venmo.com"}, {"type"=>"x-error-codes", "url"=>"https://developer.venmo.com/docs/errors"}, {"type"=>"x-faq", "url"=>"https://developer.venmo.com/docs/faq"}, {"type"=>"x-getting-started", "url"=>"https://developer.venmo.com/docs/quickstart"}, {"type"=>"x-github", "url"=>"https://github.com/venmo"}, {"type"=>"x-ios-sdk", "url"=>"https://github.com/venmo/venmo-ios-sdk"}, {"type"=>"x-sandbox-environment", "url"=>"https://developer.venmo.com/docs/sandbox"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/venmo"}, {"type"=>"x-webhooks", "url"=>"https://developer.venmo.com/docs/webhooks"}, {"type"=>"x-website", "url"=>"https://venmo.com/"}, {"type"=>"x-website", "url"=>"http://venmo.com"}, {"type"=>"x-widgets", "url"=>"https://developer.venmo.com/docs/widgets/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
regulations-gov{"regulations-gov-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Regulations.gov", "x-complete"=>1, "info"=>{"title"=>"Regulations.gov", "description"=>"provides-public-users-access-to-federal-regulatory-content-", "version"=>"1.0.0"}, "host"=>"api.data.gov", "basePath"=>"/regulations/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/docket.{response_format}"=>{"get"=>{"summary"=>"Returns Docket information", "description"=>"Returns Docket information", "operationId"=>"getDocket.ResponseFormat", "x-api-path-slug"=>"docket-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"docketId", "description"=>"Docket ID"}, {"in"=>"path", "name"=>"response_format", "description"=>"Format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regulations", "Dockets"]}}, "/document.{response_format}"=>{"get"=>{"summary"=>"Returns Document information", "description"=>"Returns Document information", "operationId"=>"getDocument.ResponseFormat", "x-api-path-slug"=>"document-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"documentId", "description"=>"FDMS Document ID"}, {"in"=>"query", "name"=>"federalRegisterNumber", "description"=>"Federal Register Document Number"}, {"in"=>"path", "name"=>"response_format", "description"=>"Format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regulations", "Documents"]}}, "/documents.{response_format}"=>{"get"=>{"summary"=>"Search for Documents", "description"=>"This API allows users to build a query based on any of the parameters below. If you have trouble building queries, you may wish to try them through the Advanced Search page on the Regulations.gov website.", "operationId"=>"getDocuments.ResponseFormat", "x-api-path-slug"=>"documents-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"a", "description"=>"Federal Agency: List of accepted Federal Agency values"}, {"in"=>"query", "name"=>"cat", "description"=>"Document Category: AD (Aerospace and Transportation) AEP (Agriculture, Environment, and Public Lands) BFS (Banking and Financial) CT (Commerce and International) LES (Defense, Law Enforcement, and Security) EELS (Education, Labor, Presidential, and Government Services) EUMM (Energy, Natural Resources, and Utilities) HCFP (Food Safety, Health, and Pharmaceutical) PRE (Housing, Development, and Real Estate) ITT (Technology and Telecommunications)"}, {"in"=>"query", "name"=>"cmd", "description"=>"Comment Period End Date: Enter a date in the form of MM/DD/YY"}, {"in"=>"query", "name"=>"cmsd", "description"=>"Comment Period Start Date: Enter a date in the form of MM/DD/YY"}, {"in"=>"query", "name"=>"countsOnly", "description"=>"Counts Only: 1 (will return only the document count for a search query)0 (will return documents as well)"}, {"in"=>"query", "name"=>"cp", "description"=>"Comment Period: O: OpenC: Closed"}, {"in"=>"query", "name"=>"crd", "description"=>"Creation Date: Enter a date in the form of MM/DD/YY"}, {"in"=>"query", "name"=>"cs", "description"=>"Comment Period Closing Soon: 0 (closing today)3 (closing within 3 days)15 (closing within 15 days)30 (closing within 30 days)90 (closing within 90 days)"}, {"in"=>"query", "name"=>"dct", "description"=>"Document Type: N: NoticePR: Proposed RuleFR: RuleO: OtherSR: Supporting & Related MaterialPS: Public Submission"}, {"in"=>"query", "name"=>"dkt", "description"=>"Docket Type: R: RulemakingN: NonrulemakingA Docket Type is either Rulemaking or Nonrulemaking"}, {"in"=>"query", "name"=>"dktid", "description"=>"Valid Docket ID (ex"}, {"in"=>"query", "name"=>"dktst", "description"=>"Docket Subtype: Only one docket subtype at a time may be selected"}, {"in"=>"query", "name"=>"dktst2", "description"=>"Docket Sub-subtype: Only one docket sub-subtype at a time may be selected"}, {"in"=>"query", "name"=>"docst", "description"=>"Document Subtype: Single or multiple document subtypes may be included"}, {"in"=>"query", "name"=>"encoded", "description"=>"Encoded: 1 (will accept Regulations"}, {"in"=>"query", "name"=>"np", "description"=>"Newly Posted: 0 (posted today)3 (posted within last 3 days)15 (posted within last 15 days)30 (posted within last 30 days)90 (posted within last 90 days) For periods of time beyond 90-days, please use a date range with the Posted Date parameter"}, {"in"=>"query", "name"=>"pd", "description"=>"Posted Date: Enter a date in the form of MM/DD/YY"}, {"in"=>"query", "name"=>"po", "description"=>"Enter the page offset (always starts with 0)"}, {"in"=>"query", "name"=>"rd", "description"=>"Received Date: Enter a date in the form of MM/DD/YY"}, {"in"=>"path", "name"=>"response_format", "description"=>"Format"}, {"in"=>"query", "name"=>"rpp", "description"=>"Results Per Page 10, 25, 100, 500, 1,000"}, {"in"=>"query", "name"=>"s", "description"=>"Keyword(s)"}, {"in"=>"query", "name"=>"sb", "description"=>"Sort By: docketId (Docket ID)docId (Document ID)title (Title)postedDate (Posted Date)agency (Agency)documentType (Document Type)submitterName (Submitter Name)organization (Organization) Sort Order is REQUIRED if this parameter is included"}, {"in"=>"query", "name"=>"so", "description"=>"Sort Order: ASC: AscendingDESC: Descending"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regulations", "Documents"]}}}}, "apis"=>{"name"=>"Regulations.gov", "x-slug"=>"regulations-gov", "description"=>"Regulations.gov is a multi-agency website where citizens can view and comment on federal regulations and other agency actions that affect their daily lives. More than 35 federal departments and agencies participate in Regulations.gov, which is designed to encourage public involvement and citizen input.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/regulations-gov-logo.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"General Data,Pedestal,Relative StreamRank,Stack Network,Streams,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"regulations-gov/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Regulations.gov", "x-api-slug"=>"regulations-gov", "description"=>"Regulations.gov is a multi-agency website where citizens can view and comment on federal regulations and other agency actions that affect their daily lives. More than 35 federal departments and agencies participate in Regulations.gov, which is designed to encourage public involvement and citizen input.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/regulations-gov-logo.png", "humanURL"=>"https://www.regulations.gov/", "baseURL"=>"https://api.data.gov//regulations/v3", "tags"=>"General Data,Pedestal,Relative StreamRank,Stack Network,Streams,Streams,Streams", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/regulations-gov/documents-response-format-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/regulations-gov/regulations-gov-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://regulationsgov.github.io/developers/blog/"}, {"type"=>"x-developer", "url"=>"https://regulationsgov.github.io/developers/"}, {"type"=>"x-github", "url"=>"https://github.com/regulationsgov"}, {"type"=>"x-terms-of-service", "url"=>"https://regulationsgov.github.io/developers/terms/"}, {"type"=>"x-website", "url"=>"https://www.regulations.gov/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
callfire{"callfire-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"CallFire", "x-complete"=>1, "info"=>{"title"=>"CallFire", "description"=>"callfire", "termsOfService"=>"https://www.callfire.com/legal/terms", "contact"=>{"name"=>"CallFire", "url"=>"https://www.callfire.com", "email"=>"support@callfire.com"}, "version"=>"1.0.0"}, "host"=>"www.callfire.com", "basePath"=>"/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/calls"=>{"get"=>{"summary"=>"Find calls", "description"=>"To search for all calls sent or received by the user. Use \"id=0\" for the campaignId parameter to query for all calls sent through the POST /calls API. See [call states and results](https://developers.callfire.com/results-responses-errors.html)", "operationId"=>"findCalls", "x-api-path-slug"=>"calls-get", "parameters"=>[{"in"=>"query", "name"=>"batchId", "description"=>"An id of a contact batch, queries for calls of a particular contact batch"}, {"in"=>"query", "name"=>"campaignId", "description"=>"An id of a campaign, queries for calls included to a particular campaign"}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"fromNumber", "description"=>"Phone number in E"}, {"in"=>"query", "name"=>"id", "description"=>"Lists the Call ids to search for"}, {"in"=>"query", "name"=>"inbound", "description"=>"Filters inbound calls for true value and outbound calls for false value"}, {"in"=>"query", "name"=>"intervalBegin", "description"=>"Start of the find time interval, formatted in unix time milliseconds"}, {"in"=>"query", "name"=>"intervalEnd", "description"=>"End of the find time interval, formatted in unix time milliseconds"}, {"in"=>"query", "name"=>"label", "description"=>"A label for a specific call"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}, {"in"=>"query", "name"=>"results", "description"=>"Searches for all calls with statuses listed in a comma separated string"}, {"in"=>"query", "name"=>"states", "description"=>"Searches for all calls which correspond to statuses listed in a comma separated string"}, {"in"=>"query", "name"=>"toNumber", "description"=>"Phone number in E"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls"]}, "post"=>{"summary"=>"Send calls", "description"=>"Use the /calls API to send individual calls quickly. A verified Caller ID and sufficient credits are required to make a call. CallRecipient represents a single recipient identified by phone number or contact id in CallFire system. You can attach user-defined attributes to a Call action via CallRecipient.attributes property, attributes are available in Call action response", "operationId"=>"sendCalls", "x-api-path-slug"=>"calls-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An array of CallRecipient objects", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"campaignId", "description"=>"Specifies a campaignId to send calls quickly on a previously created campaign"}, {"in"=>"query", "name"=>"defaultLiveMessage", "description"=>"Text to be turned into a sound, this text will be played when the phone is answered"}, {"in"=>"query", "name"=>"defaultLiveMessageSoundId", "description"=>"Id of sound file to play if phone is answered"}, {"in"=>"query", "name"=>"defaultMachineMessage", "description"=>"Text to be turned into a sound, this text will be played when answering machine is detected"}, {"in"=>"query", "name"=>"defaultMachineMessageSoundId", "description"=>"An id of a sound file to play if answering machine is detected"}, {"in"=>"query", "name"=>"defaultVoice", "description"=>"The voice set by default for all text-to-speech messages defined in CallRecipient objects or as default *Message properties"}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"strictValidation", "description"=>"Turns on strict validation for recipients"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls"]}}, "/calls/broadcasts"=>{"get"=>{"summary"=>"Find call broadcasts", "description"=>"Searches for all voice broadcasts created by user. Can query on label, name, and the current running status of the campaign. Returns a paged list of voice broadcasts", "operationId"=>"findCallBroadcasts", "x-api-path-slug"=>"callsbroadcasts-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"label", "description"=>"A label of a voice broadcast"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"name", "description"=>"A name of voice broadcast"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}, {"in"=>"query", "name"=>"running", "description"=>"Specify whether the campaigns should be running or not"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Broadcasts"]}, "post"=>{"summary"=>"Create a call broadcast", "description"=>"Creates a call broadcast campaign using the Call Broadcast API. Send a CallBroadcast in the message body to add details in a voice broadcast campaign. The campaign can be created without contacts and bare minimum configuration, but contacts will have to be added further on to use the campaign", "operationId"=>"createCallBroadcast", "x-api-path-slug"=>"callsbroadcasts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A CallBroadcast object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"start", "description"=>"Specify whether to immediately start this campaign (not required)"}, {"in"=>"query", "name"=>"strictValidation", "description"=>"Turns on strict validation for recipients"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Broadcasts"]}}, "/calls/broadcasts/{id}"=>{"get"=>{"summary"=>"Find a specific call broadcast", "description"=>"Returns a single CallBroadcast instance for a given call broadcast campaign id", "operationId"=>"getCallBroadcast", "x-api-path-slug"=>"callsbroadcastsid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a CallBroadcast"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Broadcasts"]}, "put"=>{"summary"=>"Update a call broadcast", "description"=>"This operation lets the user modify the configuration of a voice broadcast campaign after call broadcast campaign is created. See CallBroadcast for more information on what can/can't be updated on this API", "operationId"=>"updateCallBroadcast", "x-api-path-slug"=>"callsbroadcastsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A CallBroadcast object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"An id of a voice broadcast"}, {"in"=>"query", "name"=>"strictValidation", "description"=>"Turns on strict validation for recipients"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Broadcasts"]}}, "/calls/broadcasts/{id}/archive"=>{"post"=>{"summary"=>"Archive voice broadcast", "description"=>"Archives a voice broadcast (voice broadcast will be hidden in search results)", "operationId"=>"archiveVoiceBroadcast", "x-api-path-slug"=>"callsbroadcastsidarchive-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An id of a voice broadcast to archive"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Broadcasts", "Archive"]}}, "/calls/broadcasts/{id}/batches"=>{"get"=>{"summary"=>"Find batches in a call broadcast", "description"=>"This endpoint will enable the user to page through all of the batches for a particular voice broadcast campaign", "operationId"=>"getCallBroadcastBatches", "x-api-path-slug"=>"callsbroadcastsidbatches-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a call broadcast"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Broadcasts", "Batches"]}, "post"=>{"summary"=>"Add batches to a call broadcast", "description"=>"The 'add batch' API allows user to add additional batches to an already created voice broadcast campaign. The added batch will go through the CallFire validation process, unlike in the recipients version of this API. That is why you can use the scrubDuplicates flag to remove duplicates from your batch. Batches may be added as a contact list id, a list of contact ids, or a list of numbers", "operationId"=>"addCallBroadcastBatch", "x-api-path-slug"=>"callsbroadcastsidbatches-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A request object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"An id of a call broadcast"}, {"in"=>"query", "name"=>"strictValidation", "description"=>"Turns on strict validation for recipients"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Broadcasts", "Batches"]}}, "/calls/broadcasts/{id}/calls"=>{"get"=>{"summary"=>"Find calls in a call broadcast", "description"=>"This endpoint will enable the user to page through all calls for a particular call broadcast campaign", "operationId"=>"getCallBroadcastCalls", "x-api-path-slug"=>"callsbroadcastsidcalls-get", "parameters"=>[{"in"=>"query", "name"=>"batchId", "description"=>"An id of a particular batch associated with broadcast"}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An Id of a call broadcast"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Broadcasts", "Calls"]}}, "/calls/broadcasts/{id}/recipients"=>{"post"=>{"summary"=>"Add recipients to a call broadcast", "description"=>"Use this API to add the recipients to an existing voice broadcast. Post a list of Recipient objects to be added to the voice broadcast campaign. These contacts will not go through validation process, and will be acted upon as they are added. Recipients may be added as a list of contact ids, or list of numbers", "operationId"=>"addCallBroadcastRecipients", "x-api-path-slug"=>"callsbroadcastsidrecipients-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A list of CallRecipient objects", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a call broadcast"}, {"in"=>"query", "name"=>"strictValidation", "description"=>"Turns on strict validation for recipients"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Broadcasts", "Recipients"]}}, "/calls/broadcasts/{id}/start"=>{"post"=>{"summary"=>"Start voice broadcast", "description"=>"Start a voice broadcast", "operationId"=>"startVoiceBroadcast", "x-api-path-slug"=>"callsbroadcastsidstart-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An id of voice broadcast to start"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Broadcasts", "Start"]}}, "/calls/broadcasts/{id}/stats"=>{"get"=>{"summary"=>"Get statistics on call broadcast", "description"=>"Returns broadcast statistics like total number of sent/received actions, total cost, number of remaining outbound actions, error count, etc", "operationId"=>"getCallBroadcastStats", "x-api-path-slug"=>"callsbroadcastsidstats-get", "parameters"=>[{"in"=>"query", "name"=>"begin", "description"=>"Start of the search time interval, formatted in unix time milliseconds"}, {"in"=>"query", "name"=>"end", "description"=>"End of the search time interval, formatted in unix time milliseconds"}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a call broadcast"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Broadcasts", "Stats"]}}, "/calls/broadcasts/{id}/stop"=>{"post"=>{"summary"=>"Stop voice broadcast", "description"=>"Stop a voice broadcast", "operationId"=>"stopVoiceBroadcast", "x-api-path-slug"=>"callsbroadcastsidstop-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An id of voice broadcast to stop"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Broadcasts", "Stop"]}}, "/calls/recordings/{id}"=>{"get"=>{"summary"=>"Get call recording by id", "description"=>"Returns metadata of recording of a particular call. Metadata contains a link to a MP3 recording", "operationId"=>"getCallRecording", "x-api-path-slug"=>"callsrecordingsid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"~"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Recordings"]}}, "/calls/recordings/{id}.mp3"=>{"get"=>{"summary"=>"Get call recording in mp3 format", "description"=>"Returns an MP3 recording of particular call, response contains binary data, content type is 'audio/mpeg'", "operationId"=>"getCallRecordingMp3", "x-api-path-slug"=>"callsrecordingsid-mp3-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An id of a call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Recordings.mp3"]}}, "/calls/{id}"=>{"get"=>{"summary"=>"Find a specific call", "description"=>"Returns a single Call instance for a given call id.", "operationId"=>"getCall", "x-api-path-slug"=>"callsid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls"]}}, "/calls/{id}/recordings"=>{"get"=>{"summary"=>"Get call recordings for a call", "description"=>"Returns a list of recordings metadata of particular call. Metadata contains link to a MP3 recording", "operationId"=>"getCallRecordings", "x-api-path-slug"=>"callsidrecordings-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Recordings"]}}, "/calls/{id}/recordings/{name}"=>{"get"=>{"summary"=>"Get call recording by name", "description"=>"Returns recording metadata of particular call. Metadata contains link to a MP3 recording", "operationId"=>"getCallRecordingByName", "x-api-path-slug"=>"callsidrecordingsname-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a call"}, {"in"=>"path", "name"=>"name", "description"=>"A name of a recording"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Recordings", "Name"]}}, "/calls/{id}/recordings/{name}.mp3"=>{"get"=>{"summary"=>"Get call mp3 recording by name", "description"=>"Returns a MP3 recording of a particular call, response contains binary data, content type is 'audio/mpeg'", "operationId"=>"getCallRecordingMp3ByName", "x-api-path-slug"=>"callsidrecordingsname-mp3-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An id of a call"}, {"in"=>"path", "name"=>"name", "description"=>"A name of a recording"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Recordings", "Name.mp3"]}}, "/campaigns/batches/{id}"=>{"get"=>{"summary"=>"Find a specific batch", "description"=>"Returns a single Batch instance for a given batch id. This API is useful for determining the state of a validating batch", "operationId"=>"getCampaignBatch", "x-api-path-slug"=>"campaignsbatchesid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a batch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns", "Batches"]}, "put"=>{"summary"=>"Update a batch", "description"=>"Updates a single Batch instance, currently batch can only be turned \"on/off\"", "operationId"=>"updateCampaignBatch", "x-api-path-slug"=>"campaignsbatchesid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A batch instance", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"An id of a batch to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns", "Batches"]}}, "/campaigns/sounds"=>{"get"=>{"summary"=>"Find sounds", "description"=>"To find all campaign sounds which were created by user. Returns all sounds available to be used in campaigns", "operationId"=>"findCampaignSounds", "x-api-path-slug"=>"campaignssounds-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"filter", "description"=>"Name of a file to search for"}, {"in"=>"query", "name"=>"includeArchived", "description"=>"Includes ARCHIVED sounds for true value"}, {"in"=>"query", "name"=>"includePending", "description"=>"Includes UPLOAD/RECORDING sounds for true value"}, {"in"=>"query", "name"=>"includeScrubbed", "description"=>"Includes SCRUBBED sounds for true value"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns", "Sounds"]}}, "/campaigns/sounds/calls"=>{"post"=>{"summary"=>"Add sound via call", "description"=>"Use this API to create a sound via a phone call. Provide the required phone number in the CallCreateSound object inside the request, and user will receive a call shortly after with instructions on how to record a sound over the phone.", "operationId"=>"postCallCampaignSound", "x-api-path-slug"=>"campaignssoundscalls-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Request object containing the name of a new campaign sound and phone number to call up", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns", "Sounds", "Calls"]}}, "/campaigns/sounds/files"=>{"post"=>{"summary"=>"Add sound via file", "description"=>"Create a campaign sound file via a supplied .mp3 or .wav file", "operationId"=>"postFileCampaignSound", "x-api-path-slug"=>"campaignssoundsfiles-post", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"formData", "name"=>"file", "description"=>"A sound file encoded in binary form"}, {"in"=>"formData", "name"=>"name", "description"=>"Optional name of a sound file, if the name is empty than it will be taken from a file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns", "Sounds", "Files"]}}, "/campaigns/sounds/tts"=>{"post"=>{"summary"=>"Add sound via text-to-speech", "description"=>"Use this API to create a sound file via a supplied string of text. Add a text in the TextToSpeech.message field, and pick a voice in the TextToSpeech.voice field. Available voices are: MALE1, FEMALE1, FEMALE2, SPANISH1, FRENCHCANADIAN1", "operationId"=>"postTTSCampaignSound", "x-api-path-slug"=>"campaignssoundstts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"textToSpeech", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns", "Sounds", "Tts"]}}, "/campaigns/sounds/{id}"=>{"delete"=>{"summary"=>"Delete a specific sound", "description"=>"Deletes a single campaign sound instance for a specific campaign sound id, this operation does not delete sound completely, it sets sound status to ARCHIVED which means that sound will no longer appear in 'find' operation results, but still accessible via 'get' operation", "operationId"=>"deleteCampaignSound", "x-api-path-slug"=>"campaignssoundsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An id of a campaign sound"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns", "Sounds"]}, "get"=>{"summary"=>"Find a specific sound", "description"=>"Returns a single CampaignSound instance for a given sound id in campaign. This is a meta data to the sounds. No audio data is returned from this API", "operationId"=>"getCampaignSound", "x-api-path-slug"=>"campaignssoundsid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a sound campaign"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns", "Sounds"]}}, "/campaigns/sounds/{id}.mp3"=>{"get"=>{"summary"=>"Download a MP3 sound", "description"=>"Download the MP3 version of a hosted file. This is an audio data endpoint. Returns binary response of the 'audio/mpeg' content type", "operationId"=>"getCampaignSoundDataMp3", "x-api-path-slug"=>"campaignssoundsid-mp3-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An id of a campaign sound"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns", "Sounds.mp3"]}}, "/campaigns/sounds/{id}.wav"=>{"get"=>{"summary"=>"Download a WAV sound", "description"=>"Download the WAV version of the hosted file. This is an audio data endpoint. Returns binary response of the 'audio/mpeg' content type", "operationId"=>"getCampaignSoundDataWav", "x-api-path-slug"=>"campaignssoundsid-wav-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An id of a campaign sound"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaigns", "Sounds.wav"]}}, "/contacts"=>{"get"=>{"summary"=>"Find contacts", "description"=>"Find user's contacts by id, contact list, or on any property name. Returns a paged list of contacts", "operationId"=>"findContacts", "x-api-path-slug"=>"contacts-get", "parameters"=>[{"in"=>"query", "name"=>"contactListId", "description"=>"Filters contacts by a particular contact list"}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"id", "description"=>"A list of contact IDs"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"number", "description"=>"Multiple contact numbers can be specified"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}, {"in"=>"query", "name"=>"propertyName", "description"=>"Name of a contact property to search by"}, {"in"=>"query", "name"=>"propertyValue", "description"=>"Value of a contact property to search by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}, "post"=>{"summary"=>"Create contacts", "description"=>"Creates contacts in CallFire system. These contacts are not validated on creation. They will be validated upon being added to a campaign", "operationId"=>"createContacts", "x-api-path-slug"=>"contacts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A list of a contact objects", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}}, "/contacts/dncs"=>{"get"=>{"summary"=>"Find do not contact (dnc) items", "description"=>"Searches for all Do Not Contact (DNC) objects created by user. These DoNotContact entries only affect calls/texts/campaigns on this account. Returns a paged list of DoNotContact objects", "operationId"=>"findDoNotContacts", "x-api-path-slug"=>"contactsdncs-get", "parameters"=>[{"in"=>"query", "name"=>"call", "description"=>"Show only Do-Not-Call numbers"}, {"in"=>"query", "name"=>"campaignId", "description"=>"A campaign id which was used to send a message to a DNC number"}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"number", "description"=>"~"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}, {"in"=>"query", "name"=>"prefix", "description"=>"Prefix (1-10 digits) of phone numbers"}, {"in"=>"query", "name"=>"source", "description"=>"A DNC source name to search for DNCs"}, {"in"=>"query", "name"=>"text", "description"=>"Show only Do-Not-Text numbers"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Dncs"]}, "post"=>{"summary"=>"Add or update do not contact (dnc) numbers", "description"=>"Add or update a list of Do Not Contact (DNC) contact entries. Can toggle whether the DNCs are enabled for calls/texts.", "operationId"=>"addDoNotContacts", "x-api-path-slug"=>"contactsdncs-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"AddDoNotContactsRequest object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Dncs"]}}, "/contacts/dncs/sources/{source}"=>{"delete"=>{"summary"=>"Delete do not contact (dnc) numbers contained in source.", "description"=>"Delete Do Not Contact (DNC) contact entries contained in source.", "operationId"=>"deleteDoNotContactsBySource", "x-api-path-slug"=>"contactsdncssourcessource-delete", "parameters"=>[{"in"=>"path", "name"=>"source", "description"=>"Source associated with Do Not Contact (DNC) entry"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Dncs", "Sources", "Source"]}}, "/contacts/dncs/universals/{toNumber}"=>{"get"=>{"summary"=>"Find universal do not contacts (udnc) associated with toNumber", "description"=>"Searches for a UniversalDoNotContact object for a given phone number. Shows whether inbound/outbound actions are allowed for a given number", "operationId"=>"getUniversalDoNotContacts", "x-api-path-slug"=>"contactsdncsuniversalstonumber-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"fromNumber", "description"=>"An optional destination/source number for DNC, specified in E"}, {"in"=>"path", "name"=>"toNumber", "description"=>"A required destination phone number in E"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Dncs", "Universals", "ToNumber"]}}, "/contacts/dncs/{number}"=>{"delete"=>{"summary"=>"Delete do not contact (dnc) number. If number contains commas treat as list of numbers", "description"=>"Delete a Do Not Contact (DNC) contact entry.", "operationId"=>"deleteDoNotContact", "x-api-path-slug"=>"contactsdncsnumber-delete", "parameters"=>[{"in"=>"path", "name"=>"number", "description"=>"Number associated with Do Not Contact (DNC) entry"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Dncs", "Number"]}, "get"=>{"summary"=>"Get do not contact (dnc)", "description"=>"Get Do Not Contact (DNC) object create by user. This DoNotContact entry only affects calls/texts/campaigns on this account.", "operationId"=>"getDoNotContact", "x-api-path-slug"=>"contactsdncsnumber-get", "parameters"=>[{"in"=>"path", "name"=>"number", "description"=>"Number associated with Do Not Contact (DNC) entry"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Dncs", "Number"]}, "put"=>{"summary"=>"Update an individual do not contact (dnc) number", "description"=>"Update a Do Not Contact (DNC) contact entry. Can toggle whether the DNC is enabled for calls/texts.", "operationId"=>"updateDoNotContact", "x-api-path-slug"=>"contactsdncsnumber-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"DoNotContact object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"number", "description"=>"~"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Dncs", "Number"]}}, "/contacts/lists"=>{"get"=>{"summary"=>"Find contact lists", "description"=>"Searches for all contact lists which are available for the current user. Returns a paged list of contact lists", "operationId"=>"findContactLists", "x-api-path-slug"=>"contactslists-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"name", "description"=>"A name or a partial name of a contact list"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Lists"]}, "post"=>{"summary"=>"Create contact lists", "description"=>"Creates a contact list for use with campaigns using 1 of 3 inputs. A List of Contact objects, a list of String E.164 numbers, or a list of CallFire contactIds can be used as the data source for the created contact list. After contact list is added into the CallFire system, contact lists goes through seven system safeguards that check the accuracy and consistency of the data. For example, our system checks that contact number is formatted correctly, is valid, is not duplicated in another contact list, or is not added on a specific DNC list. You can configure to keep/merge or remove contacts which do not complies these rules. If contacts were not added to a contact list after the validation, this means the data needs to be properly formatted and corrected before calling this API", "operationId"=>"createContactList", "x-api-path-slug"=>"contactslists-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A request object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Lists"]}}, "/contacts/lists/upload"=>{"post"=>{"summary"=>"Create contact list from file", "description"=>"Creates a contact list to be used with campaigns through uploading a .csv file. Returns the id of created list", "operationId"=>"createContactListFromFile", "x-api-path-slug"=>"contactslistsupload-post", "parameters"=>[{"in"=>"formData", "name"=>"file", "description"=>"CSV file to be uploaded"}, {"in"=>"formData", "name"=>"name", "description"=>"A name of a contact list"}, {"in"=>"formData", "name"=>"useCustomFields", "description"=>"A flag to indicate how to define property names for contacts"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Lists", "Upload"]}}, "/contacts/lists/{id}"=>{"delete"=>{"summary"=>"Delete a contact list", "description"=>"Deletes a contact list, included contacts will not be deleted.", "operationId"=>"deleteContactList", "x-api-path-slug"=>"contactslistsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An id of the contact list to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Lists"]}, "get"=>{"summary"=>"Find a specific contact list", "description"=>"Returns a single ContactList instance for a given contact list id", "operationId"=>"getContactList", "x-api-path-slug"=>"contactslistsid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a contact list to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Lists"]}, "put"=>{"summary"=>"Update a contact list", "description"=>"Updates contact list instance.", "operationId"=>"updateContactList", "x-api-path-slug"=>"contactslistsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A request object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"An id of contact list to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Lists"]}}, "/contacts/lists/{id}/items"=>{"delete"=>{"summary"=>"Delete contacts from a contact list", "description"=>"Deletes contacts from a contact list. List the contact ids in request to delete multiple contacts with one request.", "operationId"=>"removeContactListItems", "x-api-path-slug"=>"contactslistsiditems-delete", "parameters"=>[{"in"=>"query", "name"=>"contactId", "description"=>"An id of a contact entity in the CallFire system"}, {"in"=>"path", "name"=>"id", "description"=>"A id of a contact list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Lists", "Items"]}, "get"=>{"summary"=>"Find contacts in a contact list", "description"=>"Searches for all entries in a contact list with specified id. Returns a paged list of contact entries", "operationId"=>"getContactListItems", "x-api-path-slug"=>"contactslistsiditems-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a contact list"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Lists", "Items"]}, "post"=>{"summary"=>"Add contacts to a contact list", "description"=>"Adds contacts to a contact list. Available contact sources are: list of the contact entities, list of ids of existing contacts in user's account, list of phone numbers in E.164 format (11-digits)", "operationId"=>"addContactListItems", "x-api-path-slug"=>"contactslistsiditems-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A request object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"An id of a contact list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Lists", "Items"]}}, "/contacts/lists/{id}/items/{contactId}"=>{"delete"=>{"summary"=>"Delete a contact from a contact list", "description"=>"Deletes a single contact from a contact list", "operationId"=>"removeContactListItem", "x-api-path-slug"=>"contactslistsiditemscontactid-delete", "parameters"=>[{"in"=>"path", "name"=>"contactId", "description"=>"An id of a contact"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a contact list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Lists", "Items", "ContactId"]}}, "/contacts/{id}"=>{"delete"=>{"summary"=>"Delete a contact", "description"=>"Deletes a contact instance from account", "operationId"=>"deleteContact", "x-api-path-slug"=>"contactsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An Id of a contact"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}, "get"=>{"summary"=>"Find a specific contact", "description"=>"Returns a Contact instance for a given contact id. Deleted contacts can be still retrieved but will be marked as deleted. Deleted contacts will not be shown in search request.", "operationId"=>"getContact", "x-api-path-slug"=>"contactsid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a contact"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}, "put"=>{"summary"=>"Update a contact", "description"=>"Updates a single contact instance with id specified", "operationId"=>"updateContact", "x-api-path-slug"=>"contactsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A contact object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"An id of a contact"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}}, "/contacts/{id}/history"=>{"get"=>{"summary"=>"Find a contact's history", "description"=>"Searches for all texts and calls attributed to a contact. Returns a list of calls and texts a contact has been involved with", "operationId"=>"getContactHistory", "x-api-path-slug"=>"contactsidhistory-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An Id of a contact"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "History"]}}, "/keywords"=>{"get"=>{"summary"=>"Find keywords", "description"=>"Searches for all keywords available for purchase on the CallFire platform. If a keyword appears in the response, it is available for purchase. List the 'keywords' in a query parameter to search for multiple keywords (at least one keyword should be sent in request)", "operationId"=>"findKeywords", "x-api-path-slug"=>"keywords-get", "parameters"=>[{"in"=>"query", "name"=>"keywords", "description"=>"A keyword to search for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keywords"]}}, "/keywords/leases"=>{"get"=>{"summary"=>"Find keyword leases", "description"=>"Searches for all keywords owned by user. A keyword lease is the ownership information involving a keyword", "operationId"=>"findKeywordLeases", "x-api-path-slug"=>"keywordsleases-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keywords", "Leases"]}}, "/keywords/leases/{keyword}"=>{"get"=>{"summary"=>"Find a specific lease", "description"=>"Searches for all keywords owned by user", "operationId"=>"getKeywordLease", "x-api-path-slug"=>"keywordsleaseskeyword-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"keyword", "description"=>"Keyword text that a lease is desired for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keywords", "Leases", "Keyword"]}, "put"=>{"summary"=>"Update a lease", "description"=>"Updates a keyword lease. Turns the autoRenew on/off.", "operationId"=>"updateKeywordLease", "x-api-path-slug"=>"keywordsleaseskeyword-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A keyword lease object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"keyword", "description"=>"To update a keyword lease"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keywords", "Leases", "Keyword"]}}, "/keywords/{keyword}/available"=>{"get"=>{"summary"=>"Check for a specific keyword", "description"=>"Searches for the specific keyword to purchase on the CallFire platform. Returns 'true' if keyword is available.", "operationId"=>"isKeywordAvailable", "x-api-path-slug"=>"keywordskeywordavailable-get", "parameters"=>[{"in"=>"path", "name"=>"keyword", "description"=>"To specify a keyword to search for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keywords", "Keyword", "Available"]}}, "/me/account"=>{"get"=>{"summary"=>"Find account details", "description"=>"Searches for the user account details. Details include name, email, and basic account permissions", "operationId"=>"getAccount", "x-api-path-slug"=>"meaccount-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Account"]}}, "/me/api/credentials"=>{"get"=>{"summary"=>"Find api credentials", "description"=>"Searches for all credentials generated by user. Returns a paged list of the API credentials. Only ACCOUNT_HOLDER can invoke this API", "operationId"=>"findApiCredentials", "x-api-path-slug"=>"meapicredentials-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Api", "Credentials"]}, "post"=>{"summary"=>"Create api credentials", "description"=>"Creates an API credentials for the CallFire API. This endpoint requires full CallFire account credentials to be used, authenticated using Basic Authentication. At the moment user provides only the name for the credentials. The generated credentials can be used to access any CallFire APIs", "operationId"=>"createApiCredential", "x-api-path-slug"=>"meapicredentials-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"To create the API credentials", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Api", "Credentials"]}}, "/me/api/credentials/{id}"=>{"delete"=>{"summary"=>"Delete api credentials", "description"=>"Deletes a specified API credential. Currently, removes the ability to access the API. Only ACCOUNT_HOLDER can invoke this API", "operationId"=>"deleteApiCredential", "x-api-path-slug"=>"meapicredentialsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An id of an API credential"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Api", "Credentials"]}, "get"=>{"summary"=>"Find a specific api credential", "description"=>"Returns an API credential instance for a given api credential id. Only ACCOUNT_HOLDER can invoke this API", "operationId"=>"getApiCredential", "x-api-path-slug"=>"meapicredentialsid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of an API credential"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Api", "Credentials"]}}, "/me/billing/credit-usage"=>{"get"=>{"summary"=>"Find credit usage", "description"=>"Find credit usage for the user. Returns credits usage for time period specified or if unspecified then total for all time.", "operationId"=>"getCreditUsage", "x-api-path-slug"=>"mebillingcreditusage-get", "parameters"=>[{"in"=>"query", "name"=>"intervalBegin", "description"=>"Beginning of usage period formatted in unix time milliseconds"}, {"in"=>"query", "name"=>"intervalEnd", "description"=>"End of usage period formatted in unix time milliseconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Billing", "Credit-usage"]}}, "/me/billing/plan-usage"=>{"get"=>{"summary"=>"Find plan usage", "description"=>"Searches for the data of a billing plan usage for the user. Returns the data of a billing plan usage for the current month", "operationId"=>"getBillingPlanUsage", "x-api-path-slug"=>"mebillingplanusage-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Billing", "Plan-usage"]}}, "/me/callerids"=>{"get"=>{"summary"=>"Find caller ids", "description"=>"Returns a list of verified caller ids. If the number is not shown in the list, then it is not verified. In this case sending of a verification code is required.", "operationId"=>"getCallerIds", "x-api-path-slug"=>"mecallerids-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Callerids"]}}, "/me/callerids/{callerid}"=>{"post"=>{"summary"=>"Create a caller id", "description"=>"Generates and sends a verification code to the phone number provided in the path. The verification code is delivered via a phone call. This code needs to be submitted to the verify caller id API endpoint to complete verification.", "operationId"=>"sendVerificationCodeToCallerId", "x-api-path-slug"=>"mecalleridscallerid-post", "parameters"=>[{"in"=>"path", "name"=>"callerid", "description"=>"A phone number in E"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Callerids", "Callerid"]}}, "/me/callerids/{callerid}/verification-code"=>{"post"=>{"summary"=>"Verify a caller id", "description"=>"With the verification code received from the Create caller id endpoint, a call to this endpoint is required to finish verification", "operationId"=>"verifyCallerId", "x-api-path-slug"=>"mecalleridscalleridverificationcode-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"callerid", "description"=>"A phone number in E"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Callerids", "Callerid", "Verification-code"]}}, "/media"=>{"post"=>{"summary"=>"Create media", "description"=>"Uploads media file to account, acceptable media formats: bmp, gif, jpg, m4a, mp3, mp4, png, wav", "operationId"=>"createMedia", "x-api-path-slug"=>"media-post", "parameters"=>[{"in"=>"formData", "name"=>"file", "description"=>"Binary media file"}, {"in"=>"formData", "name"=>"name", "description"=>"A name of a media file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media"]}}, "/media/public/{key}.{extension}"=>{"get"=>{"summary"=>"Download media by extension", "description"=>"Download a media file. Available types of files: bmp, gif, jpg, m4a, mp3, mp4, png, wav. Content type in response depends on 'extension' parameter, e.g. image/jpeg, image/png, audio/mp3, etc", "operationId"=>"getMediaDataByKey", "x-api-path-slug"=>"mediapublickey-extension-get", "parameters"=>[{"in"=>"path", "name"=>"extension", "description"=>"Media file type, available types: bmp, gif, jpg, m4a, mp3, mp4, png, wav"}, {"in"=>"path", "name"=>"key", "description"=>"A hash-key of a media resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media", "Public", "Key.extension"]}}, "/media/{id}"=>{"get"=>{"summary"=>"Get a specific media", "description"=>"Get media resource by id", "operationId"=>"getMedia", "x-api-path-slug"=>"mediaid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a media resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media"]}}, "/media/{id}.{extension}"=>{"get"=>{"summary"=>"Download media by extension", "description"=>"Download a media file. Available types of files: bmp, gif, jpg, m4a, mp3, mp4, png, wav. Content type in response depends on 'extension' parameter, e.g. image/jpeg, image/png, audio/mp3, etc", "operationId"=>"getMediaData", "x-api-path-slug"=>"mediaid-extension-get", "parameters"=>[{"in"=>"path", "name"=>"extension", "description"=>"Media file type"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a media resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media", "Extensions"]}}, "/media/{id}/file"=>{"get"=>{"summary"=>"Download a MP3 media", "description"=>"Download a MP3 media, endpoint returns application/binary content-type", "operationId"=>"getMediaDataBinary", "x-api-path-slug"=>"mediaidfile-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An id of a media resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media", "File"]}}, "/numbers/leases"=>{"get"=>{"summary"=>"Find leases", "description"=>"Searches for all numbers leased by account user. This API is useful for finding all numbers currently owned by the user. Returns a paged list of number leases.", "operationId"=>"findNumberLeases", "x-api-path-slug"=>"numbersleases-get", "parameters"=>[{"in"=>"query", "name"=>"city", "description"=>"A city name"}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"labelName", "description"=>"A label name"}, {"in"=>"query", "name"=>"lata", "description"=>"A local access and transport area (LATA)"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}, {"in"=>"query", "name"=>"prefix", "description"=>"A 4-7 digit prefix"}, {"in"=>"query", "name"=>"rateCenter", "description"=>"A rate center"}, {"in"=>"query", "name"=>"state", "description"=>"A two-letter state code"}, {"in"=>"query", "name"=>"zipcode", "description"=>"A five-digit Zipcode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Numbers", "Leases"]}}, "/numbers/leases/configs"=>{"get"=>{"summary"=>"Find lease configs", "description"=>"Searches for all number lease configs for the user. Returns a paged list of NumberConfig", "operationId"=>"findNumberLeaseConfigs", "x-api-path-slug"=>"numbersleasesconfigs-get", "parameters"=>[{"in"=>"query", "name"=>"city", "description"=>"A city name"}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"labelName", "description"=>"A label name"}, {"in"=>"query", "name"=>"lata", "description"=>"A local access and transport area (LATA)"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}, {"in"=>"query", "name"=>"prefix", "description"=>"A 4-7 digit prefix"}, {"in"=>"query", "name"=>"rateCenter", "description"=>"A rate center"}, {"in"=>"query", "name"=>"state", "description"=>"A two-letter state code"}, {"in"=>"query", "name"=>"zipcode", "description"=>"A five-digit Zipcode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Numbers", "Leases", "Configs"]}}, "/numbers/leases/configs/{number}"=>{"get"=>{"summary"=>"Find a specific lease config", "description"=>"Returns a single NumberConfig instance for a given number lease", "operationId"=>"getNumberLeaseConfig", "x-api-path-slug"=>"numbersleasesconfigsnumber-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"number", "description"=>"A phone number in E"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Numbers", "Leases", "Configs", "Number"]}, "put"=>{"summary"=>"Update a lease config", "description"=>"Updates a phone number lease configuration. Use this API endpoint to add an Inbound IVR or Call Tracking feature to a CallFire phone number. Call tracking configuration allows you to track the incoming calls, to analyze and to respond customers using sms or voice replies. For more information see [call tracking page](https://www.callfire.com/products/call-tracking)", "operationId"=>"updateNumberLeaseConfig", "x-api-path-slug"=>"numbersleasesconfigsnumber-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The configuration of a number lease object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"number", "description"=>"A phone number in E"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Numbers", "Leases", "Configs", "Number"]}}, "/numbers/leases/{number}"=>{"get"=>{"summary"=>"Find a specific lease", "description"=>"Returns a single NumberLease instance for a given number", "operationId"=>"getNumberLease", "x-api-path-slug"=>"numbersleasesnumber-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"number", "description"=>"A phone number in E"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Numbers", "Leases", "Number"]}, "put"=>{"summary"=>"Update a lease", "description"=>"Updates a number lease instance. Ability to turn on/off autoRenew and toggle call/text features for a particular number", "operationId"=>"updateNumberLease", "x-api-path-slug"=>"numbersleasesnumber-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A NumberLease object to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"number", "description"=>"A phone number in E"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Numbers", "Leases", "Number"]}}, "/numbers/local"=>{"get"=>{"summary"=>"Find local numbers", "description"=>"Searches for numbers available for purchase in CallFire local numbers catalog . At least one additional parameter is required. User may filter local numbers by their region information.", "operationId"=>"findNumbersLocal", "x-api-path-slug"=>"numberslocal-get", "parameters"=>[{"in"=>"query", "name"=>"city", "description"=>"A city name"}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"lata", "description"=>"A local access and transport area (LATA)"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"prefix", "description"=>"A 4-7 digit prefix"}, {"in"=>"query", "name"=>"rateCenter", "description"=>"A rate center"}, {"in"=>"query", "name"=>"state", "description"=>"A two-letter state code"}, {"in"=>"query", "name"=>"zipcode", "description"=>"A five-digit Zipcode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Numbers", "Local"]}}, "/numbers/regions"=>{"get"=>{"summary"=>"Find number regions", "description"=>"Searches for region information. Use this API to obtain detailed region information that can be used to query for more specific phone numbers than a general query.", "operationId"=>"findNumberRegions", "x-api-path-slug"=>"numbersregions-get", "parameters"=>[{"in"=>"query", "name"=>"city", "description"=>"A city name"}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"lata", "description"=>"A local access and transport area (LATA)"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}, {"in"=>"query", "name"=>"prefix", "description"=>"A 4-7 digit prefix"}, {"in"=>"query", "name"=>"rateCenter", "description"=>"A rate center"}, {"in"=>"query", "name"=>"state", "description"=>"A two-letter state code"}, {"in"=>"query", "name"=>"zipcode", "description"=>"A five-digit Zipcode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Numbers", "Regions"]}}, "/numbers/tollfree"=>{"get"=>{"summary"=>"Find tollfree numbers", "description"=>"Searches for the toll free numbers which are available for purchase in the CallFire catalog", "operationId"=>"findNumbersTollfree", "x-api-path-slug"=>"numberstollfree-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"pattern", "description"=>"Filter toll free numbers by prefix, pattern must be 3 char long and should end with *"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Numbers", "Tollfree"]}}, "/orders/keywords"=>{"post"=>{"summary"=>"Purchase keywords", "description"=>"Purchase keywords. Send a list of available keywords into this API to purchase them using CallFire credits. Make sure the account has enough credits before trying to purchase the keywords", "operationId"=>"orderKeywords", "x-api-path-slug"=>"orderskeywords-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Request object which contains a list of keywords to buy", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Keywords"]}}, "/orders/numbers"=>{"post"=>{"summary"=>"Purchase numbers", "description"=>"Purchase numbers. There are many ways to purchase a number. Set either 'tollFreeCount' or 'localCount' along with some querying fields to purchase numbers by bulk query. Set the list of numbers to purchase by list. Available numbers will be purchased using CallFire credits owned by the user. Make sure the account has enough credits before trying to purchase", "operationId"=>"orderNumbers", "x-api-path-slug"=>"ordersnumbers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Request object contains a list of numbers to buy, you can filter the numbers by their region information: city, state, zipcode, LATA, etc", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Numbers"]}}, "/orders/{id}"=>{"get"=>{"summary"=>"Find a specific order", "description"=>"Returns a single NumberOrder instance for a given order id. Order contains information about purchased keywords, local, toll-free numbers", "operationId"=>"getOrder", "x-api-path-slug"=>"ordersid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of an order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders"]}}, "/texts"=>{"get"=>{"summary"=>"Find texts", "description"=>"Searches for texts sent or received by user. Use \"campaignId=0\" parameter to query for all texts sent through the POST /texts API. See [call states and results](https://developers.callfire.com/results-responses-errors.html)", "operationId"=>"findTexts", "x-api-path-slug"=>"texts-get", "parameters"=>[{"in"=>"query", "name"=>"batchId", "description"=>"An Id of a contact batch, queries for texts which are used in the particular contact batch"}, {"in"=>"query", "name"=>"campaignId", "description"=>"An id of a campaign, queries for texts inside a particular campaign"}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"fromNumber", "description"=>"A phone number in E"}, {"in"=>"query", "name"=>"id", "description"=>"List of Text ids to search for, if ids specified other query params ignored"}, {"in"=>"query", "name"=>"inbound", "description"=>"Specify true for inbound or false for outbounds"}, {"in"=>"query", "name"=>"intervalBegin", "description"=>"Start of the find time interval, formatted in unix time milliseconds"}, {"in"=>"query", "name"=>"intervalEnd", "description"=>"End of the find time interval, formatted in unix time milliseconds"}, {"in"=>"query", "name"=>"label", "description"=>"A label of a text message"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}, {"in"=>"query", "name"=>"results", "description"=>"Expected text results in comma separated string, available values: SENT, RECEIVED, DNT, TOO_BIG, INTERNAL_ERROR, CARRIER_ERROR, CARRIER_TEMP_ERROR, UNDIALED"}, {"in"=>"query", "name"=>"states", "description"=>"Expected text statuses in comma separated string, available values: READY, SELECTED, CALLBACK, FINISHED, DISABLED, DNC, DUP, INVALID, TIMEOUT, PERIOD_LIMIT"}, {"in"=>"query", "name"=>"toNumber", "description"=>"A phone number in E"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts"]}, "post"=>{"summary"=>"Send texts", "description"=>"Use the /texts API to send individual texts quickly. By default all texts are going out from CallFire's dedicated short code 67076", "operationId"=>"sendTexts", "x-api-path-slug"=>"texts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"List of TextRecipient objects", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"campaignId", "description"=>"Specifies a campaignId to send texts through a previously created campaign"}, {"in"=>"query", "name"=>"defaultMessage", "description"=>"Text message can be overridden by TextRecipient"}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"strictValidation", "description"=>"Turns on strict validation for recipients"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts"]}}, "/texts/auto-replys"=>{"get"=>{"summary"=>"Find auto replies", "description"=>"Find all text autoreplies created by user. Returns a paged list of TextAutoReply", "operationId"=>"findTextAutoReplys", "x-api-path-slug"=>"textsautoreplys-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"number", "description"=>"Phone number in E"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts", "Auto-replys"]}, "post"=>{"summary"=>"Create an auto reply", "description"=>"CallFire gives you possibility to set up auto reply messages for your numbers and keywords. You can set a general auto reply for anyone who texts your number, keyword, and/or include a text to match, so that the auto reply would be sent only to those who text the matched text", "operationId"=>"createTextAutoReply", "x-api-path-slug"=>"textsautoreplys-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"TextAutoReply object, keyword or number should be specified with response message and text to match if needed", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts", "Auto-replys"]}}, "/texts/auto-replys/{id}"=>{"delete"=>{"summary"=>"Delete an auto reply", "description"=>"Deletes a text auto reply and removes the configuration. Can not delete a TextAutoReply which is currently active for a campaign", "operationId"=>"deleteTextAutoReply", "x-api-path-slug"=>"textsautoreplysid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An id of a text auto reply"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts", "Auto-replys"]}, "get"=>{"summary"=>"Find a specific auto reply", "description"=>"Returns a single TextAutoReply instance for a given text auto reply id", "operationId"=>"getTextAutoReply", "x-api-path-slug"=>"textsautoreplysid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a text auto reply"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts", "Auto-replys"]}}, "/texts/broadcasts"=>{"get"=>{"summary"=>"Find text broadcasts", "description"=>"Searches for all text broadcasts created by user. Can query on label, name, and the current running status of the campaign. Returns a paged list of text broadcasts", "operationId"=>"findTextBroadcasts", "x-api-path-slug"=>"textsbroadcasts-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"label", "description"=>"A label of a text broadcast"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"name", "description"=>"A name of text broadcast"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}, {"in"=>"query", "name"=>"running", "description"=>"Returns broadcasts only in running state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts", "Broadcasts"]}, "post"=>{"summary"=>"Create a text broadcast", "description"=>"Creates a text broadcast campaign using the Text Broadcast API. Send a TextBroadcast object in the message body to detail a text broadcast campaign. A campaign can be created without contacts and with bare minimum configuration, but contacts have to be added further on to use the campaign. It supports scheduling, retry logic, pattern-based messages.", "operationId"=>"createTextBroadcast", "x-api-path-slug"=>"textsbroadcasts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A TextBroadcast object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"start", "description"=>"If true then starts the campaign immediately (not required)"}, {"in"=>"query", "name"=>"strictValidation", "description"=>"Turns on strict validation for recipients"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts", "Broadcasts"]}}, "/texts/broadcasts/{id}"=>{"get"=>{"summary"=>"Find a specific text broadcast", "description"=>"Returns a single TextBroadcast instance for a given text broadcast id", "operationId"=>"getTextBroadcast", "x-api-path-slug"=>"textsbroadcastsid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a text broadcast"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts", "Broadcasts"]}, "put"=>{"summary"=>"Update a text broadcast", "description"=>"Allows modifying the configuration of existing text broadcast campaign. See TextBroadcast for more information on what can/can't be updated on this API", "operationId"=>"updateTextBroadcast", "x-api-path-slug"=>"textsbroadcastsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A TextBroadcast object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"An id of a text broadcast"}, {"in"=>"query", "name"=>"strictValidation", "description"=>"Turns on strict validation for recipients"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts", "Broadcasts"]}}, "/texts/broadcasts/{id}/archive"=>{"post"=>{"summary"=>"Archive text broadcast", "description"=>"Archives a text broadcast (and hides it in the search results)", "operationId"=>"archiveTextBroadcast", "x-api-path-slug"=>"textsbroadcastsidarchive-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An id of a text broadcast to archive"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts", "Broadcasts", "Archive"]}}, "/texts/broadcasts/{id}/batches"=>{"get"=>{"summary"=>"Find batches in a text broadcast", "description"=>"This endpoint will enable the user to page through all of the batches for a particular text broadcast campaign", "operationId"=>"getTextBroadcastBatches", "x-api-path-slug"=>"textsbroadcastsidbatches-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a text broadcast"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts", "Broadcasts", "Batches"]}, "post"=>{"summary"=>"Add batches to a text broadcast", "description"=>"Allows adding an extra batches to an already created text broadcast campaign. The batches which being added pass the CallFire validation process (unlike in the recipients version of this API). That is why using of a scrubDuplicates flag remove duplicates from your batch. Batches may be added as a contact list id, a list of contact ids, or a list of numbers", "operationId"=>"addTextBroadcastBatch", "x-api-path-slug"=>"textsbroadcastsidbatches-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A request object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"An id of a text broadcast"}, {"in"=>"query", "name"=>"strictValidation", "description"=>"Turns on strict validation for recipients"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts", "Broadcasts", "Batches"]}}, "/texts/broadcasts/{id}/recipients"=>{"post"=>{"summary"=>"Add recipients to a text broadcast", "description"=>"Use this API to add recipients to a text broadcast which is already created. Post a list of Recipient objects to be immediately added to the text broadcast campaign. These contacts will not go through validation process, and will be acted upon as they are added. Recipients may be added as a list of contact ids, or list of numbers", "operationId"=>"addTextBroadcastRecipients", "x-api-path-slug"=>"textsbroadcastsidrecipients-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A list of the TextRecipient objects", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a text broadcast"}, {"in"=>"query", "name"=>"strictValidation", "description"=>"Turns on strict validation for recipients"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts", "Broadcasts", "Recipients"]}}, "/texts/broadcasts/{id}/start"=>{"post"=>{"summary"=>"Start text broadcast", "description"=>"Starts a text broadcast", "operationId"=>"startTextBroadcast", "x-api-path-slug"=>"textsbroadcastsidstart-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An id of a text broadcast to start"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts", "Broadcasts", "Start"]}}, "/texts/broadcasts/{id}/stats"=>{"get"=>{"summary"=>"Get statistics on text broadcast", "description"=>"Returns the broadcast statistics. Example: total number of the sent/received actions, total cost, number of remaining outbound actions, error count, etc", "operationId"=>"getTextBroadcastStats", "x-api-path-slug"=>"textsbroadcastsidstats-get", "parameters"=>[{"in"=>"query", "name"=>"begin", "description"=>"Start of a search find time interval, formatted in unix time milliseconds"}, {"in"=>"query", "name"=>"end", "description"=>"End of a search time interval, formatted in unix time milliseconds"}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a text broadcast"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts", "Broadcasts", "Stats"]}}, "/texts/broadcasts/{id}/stop"=>{"post"=>{"summary"=>"Stop text broadcast", "description"=>"Stops a text broadcast", "operationId"=>"stopTextBroadcast", "x-api-path-slug"=>"textsbroadcastsidstop-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An Id of a text broadcast"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts", "Broadcasts", "Stop"]}}, "/texts/broadcasts/{id}/texts"=>{"get"=>{"summary"=>"Find texts in a text broadcast", "description"=>"This endpoint will enable the user to page through all of the texts for a particular text broadcast campaign", "operationId"=>"getTextBroadcastTexts", "x-api-path-slug"=>"textsbroadcastsidtexts-get", "parameters"=>[{"in"=>"query", "name"=>"batchId", "description"=>"~"}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a text broadcast"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts", "Broadcasts", "Texts"]}}, "/texts/{id}"=>{"get"=>{"summary"=>"Find a specific text", "description"=>"Returns a single Text instance for a given text id", "operationId"=>"getText", "x-api-path-slug"=>"textsid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Texts"]}}, "/webhooks"=>{"get"=>{"summary"=>"Find webhooks", "description"=>"Searches all webhooks available for a current user. Searches by name, resource, event, callback URL, or whether they are enabled. Returns a paged list of Webhooks", "operationId"=>"findWebhooks", "x-api-path-slug"=>"webhooks-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"A callback URL"}, {"in"=>"query", "name"=>"enabled", "description"=>"Specifies whether webhook is enabled"}, {"in"=>"query", "name"=>"event", "description"=>"A name of event, available values: started, stopped, finished"}, {"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"query", "name"=>"limit", "description"=>"To set the maximum number of records to return in a paged list response"}, {"in"=>"query", "name"=>"name", "description"=>"A name of a webhook"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset to the start of a given page"}, {"in"=>"query", "name"=>"resource", "description"=>"A name of a resource, available values: CccCampaign, CallBroadcast, TextBroadcast, OutboundCall, OutboundText, InboundCall, InboundText, ContactList"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}, "post"=>{"summary"=>"Create a webhook", "description"=>"Create a Webhook for notification in the CallFire system. Use the webhooks API to receive notifications of important CallFire events. Select the resource to listen to, and then choose the resource events to receive notifications on. When an event triggers, a POST will be made to the callback URL with a payload of notification information. Available resources and their events include 'CccCampaign': ['started', 'stopped', 'finished'], 'CallBroadcast': ['started', 'stopped', 'finished'], 'TextBroadcast': ['started', 'stopped', 'finished'], 'OutboundCall': ['finished'], 'InboundCall': ['finished'], 'OutboundText': ['finished'], 'InboundText': ['finished'], 'ContactList': ['validationFinished', 'validationFailed']. Webhooks support secret token which is used as signing key to HmacSHA1 hash of json payload which is returned in 'X-CallFire-Signature' header. This header can be used to verify callback POST is coming from CallFire. See [security guide](https://developers.callfire.com/security-guide.html)", "operationId"=>"createWebhook", "x-api-path-slug"=>"webhooks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A webhook object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}}, "/webhooks/resources"=>{"get"=>{"summary"=>"Find webhook resources", "description"=>"Searches for webhook resources. Available resources include 'CccCampaign': ['started', 'stopped', 'finished'], 'CallBroadcast': ['started', 'stopped', 'finished'], 'TextBroadcast': ['started', 'stopped', 'finished'], 'OutboundCall': ['finished'], 'InboundCall': ['finished'], 'OutboundText': ['finished'], 'InboundText': ['finished'], 'ContactList': ['validationFinished', 'validationFailed']", "operationId"=>"findWebhookResources", "x-api-path-slug"=>"webhooksresources-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "Resources"]}}, "/webhooks/resources/{resource}"=>{"get"=>{"summary"=>"Find specific webhook resource", "description"=>"Returns information about supported events for a given webhook resource", "operationId"=>"getWebhookResource", "x-api-path-slug"=>"webhooksresourcesresource-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"resource", "description"=>"A name of a webhook resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "Resources", "Resource"]}}, "/webhooks/{id}"=>{"delete"=>{"summary"=>"Delete a webhook", "description"=>"Deletes a webhook instance. Will be removed permanently", "operationId"=>"deleteWebhook", "x-api-path-slug"=>"webhooksid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An Id of a webhook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}, "get"=>{"summary"=>"Find a specific webhook", "description"=>"Returns a single Webhook instance for a given webhook id", "operationId"=>"getWebhook", "x-api-path-slug"=>"webhooksid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Limit fields received in response"}, {"in"=>"path", "name"=>"id", "description"=>"An id of a webhook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}, "put"=>{"summary"=>"Update a webhook", "description"=>"Updates the information in existing webhook", "operationId"=>"updateWebhook", "x-api-path-slug"=>"webhooksid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A webhook object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"An id of a webhook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}}}}, "apis"=>{"name"=>"CallFire", "x-slug"=>"callfire", "description"=>"Grow your business with virtual phone numbers, IVR, voice broadcasting, mass text messaging services and power dialing. Try CallFire for FREE!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11768-callfire.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"129466", "tags"=>"API Provider,Getting Started Example,Messages,Profiles,Relative Data,SaaS,Service API,SMS,Stack Network,Technology,Telecommunications,Telecommunications,Voice", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"callfire/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Callfire", "x-api-slug"=>"callfire", "description"=>"Grow your business with virtual phone numbers, IVR, voice broadcasting, mass text messaging services and power dialing. Try CallFire for FREE!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11768-callfire.jpg", "humanURL"=>"http://www.callfire.com", "baseURL"=>"https://www.callfire.com//v2", "tags"=>"API Provider,Getting Started Example,Messages,Profiles,Relative Data,SaaS,Service API,SMS,Stack Network,Technology,Telecommunications,Telecommunications,Voice", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/callfire/callfire-openapi.yaml"}]}], "x-common"=>[{"type"=>"x--net-sdk", "url"=>"https://github.com/CallFire/CallFire-CSharp-SDK"}, {"type"=>"x-account-billing", "url"=>"https://answers.callfire.com/hc/en-us/sections/200166268-Billing"}, {"type"=>"x-account-settings", "url"=>"https://answers.callfire.com/hc/en-us/sections/200187056-Account-Settings"}, {"type"=>"x-authentication", "url"=>"https://www.callfire.com/api-documentation/how-do-i-enable-api-on-my-account"}, {"type"=>"x-blog", "url"=>"https://www.callfire.com/blog"}, {"type"=>"x-blog-rss", "url"=>"https://www.callfire.com/blog/feed"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/CallFire"}, {"type"=>"x-case-studies", "url"=>"https://www.callfire.com/case-studies"}, {"type"=>"x-compliance", "url"=>"https://www.callfire.com/legal/compliance"}, {"type"=>"x-contact-form", "url"=>"https://www.callfire.com/contact"}, {"type"=>"x-crunchbase", "url"=>"https://www.crunchbase.com/organization/callfire"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/callfire"}, {"type"=>"x-developer", "url"=>"https://www.callfire.com/api-documentation"}, {"type"=>"x-documentation", "url"=>"https://www.callfire.com/api-documentation/rest/version/1.1"}, {"type"=>"x-drupal-plugin", "url"=>"https://github.com/CallFire/CallFire-Drupal-Integration"}, {"type"=>"x-email", "url"=>"answers@callfire.com"}, {"type"=>"x-email", "url"=>"support@callfire.com"}, {"type"=>"x-facebook", "url"=>"https://www.facebook.com/callfire"}, {"type"=>"x-faq", "url"=>"https://answers.callfire.com/hc/en-us/sections/200193833-FAQs"}, {"type"=>"x-getting-started", "url"=>"https://www.callfire.com/help/docs/getting-started"}, {"type"=>"x-github", "url"=>"https://github.com/callfire"}, {"type"=>"x-glossary", "url"=>"https://www.callfire.com/help/glossary/communications"}, {"type"=>"x-google-plus", "url"=>"https://plus.google.com/100142045997033051154"}, {"type"=>"x-messages", "url"=>"https://www.callfire.com/ui/number/messages?6"}, {"type"=>"x-partners", "url"=>"https://www.callfire.com/partners"}, {"type"=>"x-phone", "url"=>"1.877.897.3473"}, {"type"=>"x-php-sdk", "url"=>"https://github.com/CallFire/CallFire-PHP-SDK"}, {"type"=>"x-pricing", "url"=>"https://www.callfire.com/pricing"}, {"type"=>"x-privacy", "url"=>"https://www.callfire.com/legal/privacy"}, {"type"=>"x-selfservice-registration", "url"=>"https://www.callfire.com/ui/register?1"}, {"type"=>"x-terms-of-service", "url"=>"https://www.callfire.com/legal/terms"}, {"type"=>"x-tickets", "url"=>"https://answers.callfire.com/hc/en-us/requests/new"}, {"type"=>"x-tour", "url"=>"javascript:;"}, {"type"=>"x-videos", "url"=>"https://answers.callfire.com/hc/en-us/articles/200849247-Videos"}, {"type"=>"x-webinars", "url"=>"https://answers.callfire.com/hc/en-us/articles/202174798-Webinars"}, {"type"=>"x-website", "url"=>"http://www.callfire.com"}, {"type"=>"x-wordpress-plugin", "url"=>"https://github.com/CallFire/CallFire-WordPress-Integration"}, {"type"=>"x-youtube", "url"=>"https://www.youtube.com/user/CallFireTelephony"}, {"type"=>"x-zapier", "url"=>"https://zapier.com/zapbook/callfire/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
freesound{"freesound-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Freesound", "x-complete"=>1, "info"=>{"title"=>"Freesound", "description"=>"with-the-freesound-apiv2-you-can-browse-search-and-retrieve-information-about-freesound-users-packs-and-the-sounds-themselves-of-course--you-can-find-similar-sounds-to-a-given-target-based-on-content-analysis-and-retrieve-automatically-extracted-features-from-audio-files-as-well-as-perform-advanced-queries-combining-content-analysis-features-and-other-metadata-tags-etc-----with-the-freesound-apiv2-you-can-also-upload-comment-rate-and-bookmark-sounds", "termsOfService"=>"http://freesound.org/help/tos_api/", "version"=>"1.0.0"}, "host"=>"www.freesound.org", "basePath"=>"/apiv2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/search/text"=>{"get"=>{"summary"=>"Search sounds", "description"=>"This resource allows searching sounds in Freesound by matching their tags and other kinds of metadata.", "operationId"=>"searchText", "x-api-path-slug"=>"searchtext-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Allows filtering query results"}, {"in"=>"query", "name"=>"group_by_pack", "description"=>"This parameter represents a boolean option to indicate whether to collapse results belonging to sounds of the same pack into single entries in the results list"}, {"in"=>"query", "name"=>"page", "description"=>"Query results are paginated, this parameter indicates what page should be returned"}, {"in"=>"query", "name"=>"page_size", "description"=>"Indicates the number of sounds per page to include in the result"}, {"in"=>"query", "name"=>"query", "description"=>"The query! The query is the main parameter used to define a query"}, {"in"=>"query", "name"=>"sort", "description"=>"Indicates how query results should be sorted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Sounds"]}}, "/sounds/{soundId}"=>{"get"=>{"summary"=>"Details of a sound", "description"=>"This resource allows the retrieval of detailed information about a sound.", "operationId"=>"getSoundById", "x-api-path-slug"=>"soundssoundid-get", "parameters"=>[{"in"=>"path", "name"=>"soundId", "description"=>"ID of the sound that needs to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sounds"]}}}}, "apis"=>{"name"=>"Freesound", "x-slug"=>"freesound", "description"=>"Freesound aims to create a huge collaborative database of audio snippets, samples, recordings, bleeps, ... released under Creative Commons licenses that allow their reuse. Freesound provides new and interesting ways of accessing these samples, allowing users to browse the sounds in new ways using keywords, a sounds-like type of browsing and more--upload and download sounds to and from the database, under the same creative commons license, and interact with fellow sound-artists!", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Freesound_project_website_logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"6485", "tags"=>"API Provider,Audio,General Data,internet,Music,Profiles,Sounds,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"freesound/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Freesound", "x-api-slug"=>"freesound", "description"=>"Freesound aims to create a huge collaborative database of audio snippets, samples, recordings, bleeps, ... released under Creative Commons licenses that allow their reuse. Freesound provides new and interesting ways of accessing these samples, allowing users to browse the sounds in new ways using keywords, a sounds-like type of browsing and more--upload and download sounds to and from the database, under the same creative commons license, and interact with fellow sound-artists!", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Freesound_project_website_logo.png", "humanURL"=>"https://freesound.org", "baseURL"=>"https://www.freesound.org//apiv2", "tags"=>"API Provider,Audio,General Data,internet,Music,Profiles,Sounds,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/freesound/soundssoundid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/freesound/freesound-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://blog.freesound.org/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/freesound"}, {"type"=>"x-developer", "url"=>"https://freesound.org/help/developers/"}, {"type"=>"x-documentation", "url"=>"https://freesound.org/docs/api/"}, {"type"=>"x-forum", "url"=>"https://freesound.org/forum/"}, {"type"=>"x-login", "url"=>"https://freesound.org/home/login/?next=/apiv2/apply/"}, {"type"=>"x-terms-of-service", "url"=>"https://freesound.org/help/tos_web/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/freesounddev?lang=en"}, {"type"=>"x-website", "url"=>"https://freesound.org"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
opencorporates{"opencorporates-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"OpenCorporates", "x-complete"=>1, "info"=>{"title"=>"OpenCorporates", "description"=>"the-api-for-managing-opencorporates-data-", "termsOfService"=>"https://opencorporates.com/info/licence", "version"=>"v.04"}, "host"=>"api.opencorporates.com", "basePath"=>"v0.4/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/account_status"=>{"get"=>{"summary"=>"Account Status", "description"=>"nThis returns the status of your API Account (this information may also be retrieved at https://OpenCorporates", "operationId"=>"account-status", "x-api-path-slug"=>"account-status-get", "parameters"=>[{"in"=>"query", "name"=>"calls_remaining", "description"=>"this has two subvalues - today and this_month"}, {"in"=>"query", "name"=>"expiry_date", "description"=>"when the api_plan runs out"}, {"in"=>"query", "name"=>"plan", "description"=>"the type of plan that you are on"}, {"in"=>"query", "name"=>"status", "description"=>"status of the API account"}, {"in"=>"query", "name"=>"usage", "description"=>"this has two subvalues - today and this_month"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Account", "Status"]}}, "/companies/:jurisdiction_code/:company_number/data"=>{"get"=>{"summary"=>"Companies Jurisdiction Code Company Number Data", "description"=>"nThis returns the data held for the given company", "operationId"=>"companies--jurisdiction-code--company-number-data", "x-api-path-slug"=>"companiesjurisdiction-codecompany-numberdata-get", "parameters"=>[{"in"=>"query", "name"=>"data_type", "description"=>"this is a string value denoting the type of data, e"}, {"in"=>"query", "name"=>"description", "description"=>"the given description of the datum as displayed on OpenCorporates"}, {"in"=>"query", "name"=>"id", "description"=>"the id given to the filing by the company registry"}, {"in"=>"query", "name"=>"title", "description"=>"this is the title of the datum as displayed on OpenCorporates"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Companies", ":jurisdiction", "Code", ":company", "Number", "Data"]}}, "/companies/:jurisdiction_code/:company_number/network"=>{"get"=>{"summary"=>"Companies Jurisdiction Code Company Number Network", "description"=>"nThis returns the immediate 'computed corporate network' for the given company as a set of control relationships (i", "operationId"=>"companies--jurisdiction-code--company-number-network", "x-api-path-slug"=>"companiesjurisdiction-codecompany-numbernetwork-get", "parameters"=>[{"in"=>"query", "name"=>"child_name", "description"=>"the name of the child entity"}, {"in"=>"query", "name"=>"child_opencorporates_url", "description"=>"the OpenCorporates URL of the child entity"}, {"in"=>"query", "name"=>"child_type", "description"=>"the type of entity the child is"}, {"in"=>"query", "name"=>"confidence", "description"=>"a computed confidence in the relationship based on the underlying statements"}, {"in"=>"query", "name"=>"parent_name", "description"=>"the name of the parent entity"}, {"in"=>"query", "name"=>"parent_opencorporates_url", "description"=>"the OpenCorporates URL of the parent entity"}, {"in"=>"query", "name"=>"parent_type", "description"=>"the type of entity the parent is"}, {"in"=>"query", "name"=>"relationship_properties", "description"=>"any additional properties of the relationship, e"}, {"in"=>"query", "name"=>"relationship_type", "description"=>"the type of relationship, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Companies", ":jurisdiction", "Code", ":company", "Number", "Network"]}}, "/companies/search"=>{"get"=>{"summary"=>"Companies Search", "description"=>"nThis returns a collection of companies whose name matches the given search term (submitted as :q in the query parameters)", "operationId"=>"companies-search", "x-api-path-slug"=>"companiessearch-get", "parameters"=>[{"in"=>"query", "name"=>"branch", "description"=>"Filter by branch status (boolean)"}, {"in"=>"query", "name"=>"company_type", "description"=>"The type of the company, as defined by the company register"}, {"in"=>"query", "name"=>"country_code", "description"=>"NEWThe companies searched for can be restricted to a given country by passing a country_code query parameter"}, {"in"=>"query", "name"=>"created_since", "description"=>"companies added to OpenCorporates after the given date"}, {"in"=>"query", "name"=>"current_status", "description"=>"The current status of the company, as defined by the company register"}, {"in"=>"query", "name"=>"dissolution_date", "description"=>"NEWas with all date fields, dissolution_date can be supplied either as a specific date or as a span of dates"}, {"in"=>"query", "name"=>"dissolved_before", "description"=>"DeprecatedRestrict to companies with a dissolution_date before the given date"}, {"in"=>"query", "name"=>"dissolved_since", "description"=>"DeprecatedRestrict to companies with a dissolution_date after the given date"}, {"in"=>"query", "name"=>"exclude_inactive", "description"=>"DeprecatedRestrict to companies that are active/inactive"}, {"in"=>"query", "name"=>"fields", "description"=>"NEWBy default when searching with a term (e"}, {"in"=>"query", "name"=>"inactive", "description"=>"Filter by inactive status (boolean)"}, {"in"=>"query", "name"=>"incorporated_before", "description"=>"DeprecatedRestrict to companies with an incorporation_date before the given date"}, {"in"=>"query", "name"=>"incorporated_since", "description"=>"DeprecatedRestrict to companies with an incorporation_date after the given date"}, {"in"=>"query", "name"=>"incorporation_date", "description"=>"NEWAs with all date fields, incorporation_date can be supplied either as a specific date or as a span of dates"}, {"in"=>"query", "name"=>"industry_codes", "description"=>"NEWOne or more industry codes representing the industries the company operates in"}, {"in"=>"query", "name"=>"jurisdiction_code", "description"=>"The companies searched for can be restricted to a given jurisdiction by passing a jurisdiction_code query parameter"}, {"in"=>"query", "name"=>"nonprofit", "description"=>"NEWFilter by nonprofit company type (boolean)"}, {"in"=>"query", "name"=>"registered_address", "description"=>"NEWThe companies searched for can be restricted by passing in an address or parts of an address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Companies", "Search"]}}, "/corporate_groupings/search"=>{"get"=>{"summary"=>"Corporate Groupings Search", "description"=>"nThis returns a collection of corporate_groupings whose name matches the given search term (submitted as :q in the query parameters)", "operationId"=>"corporate-groupings-search", "x-api-path-slug"=>"corporate-groupingssearch-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Corporate", "Groupings", "Search"]}}, "/data/:id"=>{"get"=>{"summary"=>"Data ID", "description"=>"nThis returns information on a given datum", "operationId"=>"data--id", "x-api-path-slug"=>"dataid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Data"]}}, "/industry_codes/:code_scheme_id"=>{"get"=>{"summary"=>"Industry Codes Code Scheme ID", "description"=>"nThis call returns further details about the code_scheme, together with the list of industry codes associated with it", "operationId"=>"get-industry-codes--code-scheme-id", "x-api-path-slug"=>"industry-codescode-scheme-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Industry", "Codes", ":code", "Scheme", "Id"]}}, "/jurisdictions/match"=>{"get"=>{"summary"=>"Jurisdictions Match", "description"=>"nThis matches the name of a jurisdiction to the jurisdiction", "operationId"=>"get-jurisdictions-match", "x-api-path-slug"=>"jurisdictionsmatch-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Jurisdictions", "Match"]}}, "/officers/:id"=>{"get"=>{"summary"=>"Officers ID", "description"=>"nThis returns information on a particular officer (a director or an agent for a company)", "operationId"=>"officers--id", "x-api-path-slug"=>"officersid-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"NEWthe given address of the officer, if known (only for users with API key)"}, {"in"=>"query", "name"=>"date_of_birth", "description"=>"NEWthe date of birth of the officer, if known (only for users with API key)"}, {"in"=>"query", "name"=>"end_date", "description"=>"this is date on which the officership ended"}, {"in"=>"query", "name"=>"position", "description"=>"the position held (e"}, {"in"=>"query", "name"=>"start_date", "description"=>"this is date on which the officership started"}, {"in"=>"query", "name"=>"uid", "description"=>"the id given to the officer by the company registry"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Officers"]}}, "/placeholder/:id"=>{"get"=>{"summary"=>"Placeholder ID", "description"=>"nA placeholder is we call something we believe is probably a company", "operationId"=>"placeholder--id", "x-api-path-slug"=>"placeholderid-get", "parameters"=>[{"in"=>"query", "name"=>"company", "description"=>"if the placeholder has been matched to a company, the company will be included, together with basic information for the company"}, {"in"=>"query", "name"=>"identifier", "description"=>"an identifier that is associated with the placeholder, for example an SEC CIK code"}, {"in"=>"query", "name"=>"jurisdiction_code", "description"=>"the code for the jurisdiction in which the placeholder is believed to be incorporated (see [GET company](#company))"}, {"in"=>"query", "name"=>"jurisdiction_string", "description"=>"A plain text representation for the jurisdiction in which the placeholder is believed to be incorporated - this may be the name of a jurisdiction, of a country, or possibly an ISO 3166-2 code"}, {"in"=>"query", "name"=>"name", "description"=>"the name of the entity"}, {"in"=>"query", "name"=>"opencorporates_url", "description"=>"the url of the placeholder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Placeholder"]}}, "/placeholders/:id/statements"=>{"get"=>{"summary"=>"Placeholders ID Statements", "description"=>"nThis returns the statements associated with a given placeholder", "operationId"=>"placeholders--id-statements", "x-api-path-slug"=>"placeholdersidstatements-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Placeholders", "Statements"]}}, "/versions"=>{"get"=>{"summary"=>"Versions", "description"=>"nThis returns the current version of the API and supported versions", "operationId"=>"versions", "x-api-path-slug"=>"versions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Businesses", "Versions"]}}}}, "apis"=>{"name"=>"OpenCorporates", "x-slug"=>"opencorporates", "description"=>"Free and Open Company Data on 135 million companies and corporations in over 125 jurisdictions, including US, UK, Switzerland, Panama...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1108-opencorporates.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"53526", "tags"=>"API LIfeyclessss,Business,Business,Business Intelligence,Corporate Data,Enterprise,Finance,General Data,My API Stack,Pedestal,SaaS,Service API,SMS,Stack Network,Target,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"opencorporates/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"OpenCorporates", "x-api-slug"=>"opencorporates", "description"=>"OpenCorporates is a database of corporate data. OpenCorporates offers users the ability to search for information on 30 million corporations from around the world. Users can also search by type of corporation. The OpenCorporates API allows developers to access and integrate the data and functionality of OpenCorporates with other applications. Some example API methods include searching and retrieving information on corporation by type, jurisdiction, and company ID.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1108-opencorporates.jpg", "humanURL"=>"http://opencorporates.com", "baseURL"=>"://api.opencorporates.com/v0.4/", "tags"=>"API LIfeyclessss,Business,Business,Business Intelligence,Corporate Data,Enterprise,Finance,General Data,My API Stack,Pedestal,SaaS,Service API,SMS,Stack Network,Target,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/opencorporates/opencorporates-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.opencorporates.com/"}, {"type"=>"x-blog", "url"=>"http://blog.opencorporates.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.opencorporates.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/opencorporates"}, {"type"=>"x-developer", "url"=>"http://api.opencorporates.com/"}, {"type"=>"x-github", "url"=>"https://github.com/openc"}, {"type"=>"x-pricing", "url"=>"https://opencorporates.com/info/pricing"}, {"type"=>"x-status", "url"=>"http://status.opencorporates.com/"}, {"type"=>"x-terms-of-service", "url"=>"https://opencorporates.com/info/licence"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/opencorporates"}, {"type"=>"x-website", "url"=>"http://opencorporates.com"}, {"type"=>"x-website", "url"=>"https://opencorporates.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-apps-admin-sdk{"google-apps-admin-sdk-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Apps Admin SDK", "x-complete"=>1, "info"=>{"title"=>"Google Apps Admin SDK Merged API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/activity/users/{userKey}/applications/{applicationName}"=>{"get"=>{"summary"=>"Get Activities", "description"=>"Retrieves a list of activities for a specific customer and application.", "operationId"=>"reports.activities.list", "x-api-path-slug"=>"activityusersuserkeyapplicationsapplicationname-get", "parameters"=>[{"in"=>"query", "name"=>"actorIpAddress", "description"=>"IP Address of host where the event was performed"}, {"in"=>"path", "name"=>"applicationName", "description"=>"Application name for which the events are to be retrieved"}, {"in"=>"query", "name"=>"customerId", "description"=>"Represents the customer for which the data is to be fetched"}, {"in"=>"query", "name"=>"endTime", "description"=>"Return events which occured at or before this time"}, {"in"=>"query", "name"=>"eventName", "description"=>"Name of the event being queried"}, {"in"=>"query", "name"=>"filters", "description"=>"Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Number of activity records to be shown in each page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token to specify next page"}, {"in"=>"query", "name"=>"startTime", "description"=>"Return events which occured at or after this time"}, {"in"=>"path", "name"=>"userKey", "description"=>"Represents the profile id or the user email for which the data should be filtered"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activities"]}}, "/activity/users/{userKey}/applications/{applicationName}/watch"=>{"post"=>{"summary"=>"Change Activity", "description"=>"Push changes to activities", "operationId"=>"reports.activities.watch", "x-api-path-slug"=>"activityusersuserkeyapplicationsapplicationnamewatch-post", "parameters"=>[{"in"=>"query", "name"=>"actorIpAddress", "description"=>"IP Address of host where the event was performed"}, {"in"=>"path", "name"=>"applicationName", "description"=>"Application name for which the events are to be retrieved"}, {"in"=>"query", "name"=>"customerId", "description"=>"Represents the customer for which the data is to be fetched"}, {"in"=>"query", "name"=>"endTime", "description"=>"Return events which occured at or before this time"}, {"in"=>"query", "name"=>"eventName", "description"=>"Name of the event being queried"}, {"in"=>"query", "name"=>"filters", "description"=>"Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Number of activity records to be shown in each page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token to specify next page"}, {"in"=>"body", "name"=>"resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"startTime", "description"=>"Return events which occured at or after this time"}, {"in"=>"path", "name"=>"userKey", "description"=>"Represents the profile id or the user email for which the data should be filtered"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activities"]}}, "/admin/reports_v1/channels/stop"=>{"post"=>{"summary"=>"Stop Watching Resource", "description"=>"Stop watching resources through this channel", "operationId"=>"admin.channels.stop", "x-api-path-slug"=>"adminreports-v1channelsstop-post", "parameters"=>[{"in"=>"body", "name"=>"resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel"]}}, "/usage/dates/{date}"=>{"get"=>{"summary"=>"Get Report by Date", "description"=>"Retrieves a report which is a collection of properties / statistics for a specific customer.", "operationId"=>"reports.customerUsageReports.get", "x-api-path-slug"=>"usagedatesdate-get", "parameters"=>[{"in"=>"query", "name"=>"customerId", "description"=>"Represents the customer for which the data is to be fetched"}, {"in"=>"path", "name"=>"date", "description"=>"Represents the date in yyyy-mm-dd format for which the data is to be fetched"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token to specify next page"}, {"in"=>"query", "name"=>"parameters", "description"=>"Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report"]}}, "/usage/users/{userKey}/dates/{date}"=>{"get"=>{"summary"=>"Get User Report by Date", "description"=>"Retrieves a report which is a collection of properties / statistics for a set of users.", "operationId"=>"reports.userUsageReport.get", "x-api-path-slug"=>"usageusersuserkeydatesdate-get", "parameters"=>[{"in"=>"query", "name"=>"customerId", "description"=>"Represents the customer for which the data is to be fetched"}, {"in"=>"path", "name"=>"date", "description"=>"Represents the date in yyyy-mm-dd format for which the data is to be fetched"}, {"in"=>"query", "name"=>"filters", "description"=>"Represents the set of filters including parameter operator value"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token to specify next page"}, {"in"=>"query", "name"=>"parameters", "description"=>"Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2"}, {"in"=>"path", "name"=>"userKey", "description"=>"Represents the profile id or the user email for which the data should be filtered"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report"]}}, "/{groupId}/archive"=>{"post"=>{"summary"=>"Archive Mail", "description"=>"Inserts a new mail into the archive of the Google group.", "operationId"=>"groupsmigration.archive.insert", "x-api-path-slug"=>"groupidarchive-post", "parameters"=>[{"in"=>"path", "name"=>"groupId", "description"=>"The group ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Archives"]}}, "/{productId}/sku/{skuId}/user"=>{"post"=>{"summary"=>"Assign License", "description"=>"Assign License.", "operationId"=>"licensing.licenseAssignments.insert", "x-api-path-slug"=>"productidskuskuiduser-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"productId", "description"=>"Name for product"}, {"in"=>"path", "name"=>"skuId", "description"=>"Name for sku"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License"]}}, "/{productId}/sku/{skuId}/user/{userId}"=>{"delete"=>{"summary"=>"Revoke License", "description"=>"Revoke License.", "operationId"=>"licensing.licenseAssignments.delete", "x-api-path-slug"=>"productidskuskuiduseruserid-delete", "parameters"=>[{"in"=>"path", "name"=>"productId", "description"=>"Name for product"}, {"in"=>"path", "name"=>"skuId", "description"=>"Name for sku"}, {"in"=>"path", "name"=>"userId", "description"=>"email id or unique Id of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License"]}, "get"=>{"summary"=>"Get License", "description"=>"Get license assignment of a particular product and sku for a user", "operationId"=>"licensing.licenseAssignments.get", "x-api-path-slug"=>"productidskuskuiduseruserid-get", "parameters"=>[{"in"=>"path", "name"=>"productId", "description"=>"Name for product"}, {"in"=>"path", "name"=>"skuId", "description"=>"Name for sku"}, {"in"=>"path", "name"=>"userId", "description"=>"email id or unique Id of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License"]}, "patch"=>{"summary"=>"Update License", "description"=>"Assign License. This method supports patch semantics.", "operationId"=>"licensing.licenseAssignments.patch", "x-api-path-slug"=>"productidskuskuiduseruserid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"productId", "description"=>"Name for product"}, {"in"=>"path", "name"=>"skuId", "description"=>"Name for sku for which license would be revoked"}, {"in"=>"path", "name"=>"userId", "description"=>"email id or unique Id of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License"]}, "put"=>{"summary"=>"Update License", "description"=>"Assign License.", "operationId"=>"licensing.licenseAssignments.update", "x-api-path-slug"=>"productidskuskuiduseruserid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"productId", "description"=>"Name for product"}, {"in"=>"path", "name"=>"skuId", "description"=>"Name for sku for which license would be revoked"}, {"in"=>"path", "name"=>"userId", "description"=>"email id or unique Id of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License"]}}, "/{productId}/sku/{skuId}/users"=>{"get"=>{"summary"=>"Get License Assignment For Product", "description"=>"List license assignments for given product and sku of the customer.", "operationId"=>"licensing.licenseAssignments.listForProductAndSku", "x-api-path-slug"=>"productidskuskuidusers-get", "parameters"=>[{"in"=>"query", "name"=>"customerId", "description"=>"CustomerId represents the customer for whom licenseassignments are queried"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of campaigns to return at one time"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token to fetch the next page"}, {"in"=>"path", "name"=>"productId", "description"=>"Name for product"}, {"in"=>"path", "name"=>"skuId", "description"=>"Name for sku"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License"]}}, "/{productId}/users"=>{"get"=>{"summary"=>"Get License Assignment For User", "description"=>"List license assignments for given product of the customer.", "operationId"=>"licensing.licenseAssignments.listForProduct", "x-api-path-slug"=>"productidusers-get", "parameters"=>[{"in"=>"query", "name"=>"customerId", "description"=>"CustomerId represents the customer for whom licenseassignments are queried"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of campaigns to return at one time"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token to fetch the next page"}, {"in"=>"path", "name"=>"productId", "description"=>"Name for product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License"]}}, "/customers"=>{"post"=>{"summary"=>"Create Customer", "description"=>"Order a new customer's account.", "operationId"=>"reseller.customers.insert", "x-api-path-slug"=>"customers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"customerAuthToken", "description"=>"The customerAuthToken query string is required when creating a resold account that transfers a direct customers subscription or transfers another reseller customers subscription to your reseller management"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer"]}}, "/customers/{customerId}"=>{"get"=>{"summary"=>"Get Customer", "description"=>"Get a customer account.", "operationId"=>"reseller.customers.get", "x-api-path-slug"=>"customerscustomerid-get", "parameters"=>[{"in"=>"path", "name"=>"customerId", "description"=>"Either the customers primary domain name or the customers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer"]}, "patch"=>{"summary"=>"Update Customer", "description"=>"Update a customer account's settings. This method supports patch semantics.", "operationId"=>"reseller.customers.patch", "x-api-path-slug"=>"customerscustomerid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerId", "description"=>"Either the customers primary domain name or the customers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer"]}, "put"=>{"summary"=>"Update Customer", "description"=>"Update a customer account's settings.", "operationId"=>"reseller.customers.update", "x-api-path-slug"=>"customerscustomerid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerId", "description"=>"Either the customers primary domain name or the customers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer"]}}, "/customers/{customerId}/subscriptions"=>{"post"=>{"summary"=>"Create Subscription", "description"=>"Create or transfer a subscription.", "operationId"=>"reseller.subscriptions.insert", "x-api-path-slug"=>"customerscustomeridsubscriptions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"customerAuthToken", "description"=>"The customerAuthToken query string is required when creating a resold account that transfers a direct customers subscription or transfers another reseller customers subscription to your reseller management"}, {"in"=>"path", "name"=>"customerId", "description"=>"Either the customers primary domain name or the customers unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/customers/{customerId}/subscriptions/{subscriptionId}"=>{"delete"=>{"summary"=>"Cancel Subscription", "description"=>"Cancel, suspend or transfer a subscription to direct.", "operationId"=>"reseller.subscriptions.delete", "x-api-path-slug"=>"customerscustomeridsubscriptionssubscriptionid-delete", "parameters"=>[{"in"=>"path", "name"=>"customerId", "description"=>"Either the customers primary domain name or the customers unique identifier"}, {"in"=>"query", "name"=>"deletionType", "description"=>"The deletionType query string enables the cancellation, downgrade, or suspension of a subscription"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"This is a required property"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}, "get"=>{"summary"=>"Get Subscription", "description"=>"Get a specific subscription.", "operationId"=>"reseller.subscriptions.get", "x-api-path-slug"=>"customerscustomeridsubscriptionssubscriptionid-get", "parameters"=>[{"in"=>"path", "name"=>"customerId", "description"=>"Either the customers primary domain name or the customers unique identifier"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"This is a required property"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/customers/{customerId}/subscriptions/{subscriptionId}/activate"=>{"post"=>{"summary"=>"Activate Subscription", "description"=>"Activates a subscription previously suspended by the reseller", "operationId"=>"reseller.subscriptions.activate", "x-api-path-slug"=>"customerscustomeridsubscriptionssubscriptionidactivate-post", "parameters"=>[{"in"=>"path", "name"=>"customerId", "description"=>"Either the customers primary domain name or the customers unique identifier"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"This is a required property"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/customers/{customerId}/subscriptions/{subscriptionId}/changePlan"=>{"post"=>{"summary"=>"Update Subscription", "description"=>"Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments.", "operationId"=>"reseller.subscriptions.changePlan", "x-api-path-slug"=>"customerscustomeridsubscriptionssubscriptionidchangeplan-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerId", "description"=>"Either the customers primary domain name or the customers unique identifier"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"This is a required property"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/customers/{customerId}/subscriptions/{subscriptionId}/changeRenewalSettings"=>{"post"=>{"summary"=>"Update User License", "description"=>"Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only.", "operationId"=>"reseller.subscriptions.changeRenewalSettings", "x-api-path-slug"=>"customerscustomeridsubscriptionssubscriptionidchangerenewalsettings-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerId", "description"=>"Either the customers primary domain name or the customers unique identifier"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"This is a required property"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License"]}}, "/customers/{customerId}/subscriptions/{subscriptionId}/changeSeats"=>{"post"=>{"summary"=>"Update Suscription License", "description"=>"Update a subscription's user license settings.", "operationId"=>"reseller.subscriptions.changeSeats", "x-api-path-slug"=>"customerscustomeridsubscriptionssubscriptionidchangeseats-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerId", "description"=>"Either the customers primary domain name or the customers unique identifier"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"This is a required property"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License"]}}, "/customers/{customerId}/subscriptions/{subscriptionId}/startPaidService"=>{"post"=>{"summary"=>"Upgrade Free Trial", "description"=>"Immediately move a 30-day free trial subscription to a paid service subscription.", "operationId"=>"reseller.subscriptions.startPaidService", "x-api-path-slug"=>"customerscustomeridsubscriptionssubscriptionidstartpaidservice-post", "parameters"=>[{"in"=>"path", "name"=>"customerId", "description"=>"Either the customers primary domain name or the customers unique identifier"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"This is a required property"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Free Trial"]}}, "/customers/{customerId}/subscriptions/{subscriptionId}/suspend"=>{"post"=>{"summary"=>"Suspect Subscription", "description"=>"Suspends an active subscription.", "operationId"=>"reseller.subscriptions.suspend", "x-api-path-slug"=>"customerscustomeridsubscriptionssubscriptionidsuspend-post", "parameters"=>[{"in"=>"path", "name"=>"customerId", "description"=>"Either the customers primary domain name or the customers unique identifier"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"This is a required property"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["LicenseSubscription"]}}, "/resellernotify/getwatchdetails"=>{"get"=>{"summary"=>"Get Watch Details", "description"=>"Returns all the details of the watch corresponding to the reseller.", "operationId"=>"reseller.resellernotify.getwatchdetails", "x-api-path-slug"=>"resellernotifygetwatchdetails-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification"]}}, "/resellernotify/register"=>{"post"=>{"summary"=>"Register Reseller", "description"=>"Registers a Reseller for receiving notifications.", "operationId"=>"reseller.resellernotify.register", "x-api-path-slug"=>"resellernotifyregister-post", "parameters"=>[{"in"=>"query", "name"=>"serviceAccountEmailAddress", "description"=>"The service account which will own the created Cloud-PubSub topic"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register"]}}, "/resellernotify/unregister"=>{"post"=>{"summary"=>"Unregister Reseller", "description"=>"Unregisters a Reseller for receiving notifications.", "operationId"=>"reseller.resellernotify.unregister", "x-api-path-slug"=>"resellernotifyunregister-post", "parameters"=>[{"in"=>"query", "name"=>"serviceAccountEmailAddress", "description"=>"The service account which owns the Cloud-PubSub topic"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register"]}}, "/subscriptions"=>{"get"=>{"summary"=>"List Subscriptions", "description"=>"List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions.", "operationId"=>"reseller.subscriptions.list", "x-api-path-slug"=>"subscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"customerAuthToken", "description"=>"The customerAuthToken query string is required when creating a resold account that transfers a direct customers subscription or transfers another reseller customers subscription to your reseller management"}, {"in"=>"query", "name"=>"customerId", "description"=>"Either the customers primary domain name or the customers unique identifier"}, {"in"=>"query", "name"=>"customerNamePrefix", "description"=>"When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name"}, {"in"=>"query", "name"=>"maxResults", "description"=>"When retrieving a large list, the maxResults is the maximum number of results per page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token to specify next page in the list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/{groupUniqueId}"=>{"get"=>{"summary"=>"Get Group", "description"=>"Gets one resource by id.", "operationId"=>"groupsSettings.groups.get", "x-api-path-slug"=>"groupuniqueid-get", "parameters"=>[{"in"=>"path", "name"=>"groupUniqueId", "description"=>"The resource ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}, "patch"=>{"summary"=>"Update Group", "description"=>"Updates an existing resource. This method supports patch semantics.", "operationId"=>"groupsSettings.groups.patch", "x-api-path-slug"=>"groupuniqueid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"groupUniqueId", "description"=>"The resource ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}, "put"=>{"summary"=>"Update Group", "description"=>"Updates an existing resource.", "operationId"=>"groupsSettings.groups.update", "x-api-path-slug"=>"groupuniqueid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"groupUniqueId", "description"=>"The resource ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}}}}, "apis"=>{"name"=>"Google Apps Admin SDK", "x-slug"=>"google-apps-admin-sdk", "description"=>"Administer domain resources, create reports, and manage subscriptions. Use the Directory API to create and manage users and groups for a domain, along with their aliases. Programmatically access the functionality found at the Admin console Organization and users tab. Use the Reports API to gain insights on content management with Google Drive activity reports. Audit administrator actions. Generate customer and user usage reports.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/nexusae0_icon2.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Applications,Documents,Google APIs,Licensing,Monetization,Profiles,Relative Data,Reseller,Resellers,SDK,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-apps-admin-sdk/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Apps Admin SDK API", "x-api-slug"=>"google-apps-admin-sdk-api", "description"=>"Administer domain resources, create reports, and manage subscriptions. Use the Directory API to create and manage users and groups for a domain, along with their aliases. Programmatically access the functionality found at the Admin console Organization and users tab. Use the Reports API to gain insights on content management with Google Drive activity reports. Audit administrator actions. Generate customer and user usage reports.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/nexusae0_icon2.png", "humanURL"=>"https://developers.google.com/admin-sdk/", "baseURL"=>"https:///", "tags"=>"API Provider,API Service Provider,Applications,Documents,Google APIs,Licensing,Monetization,Profiles,Relative Data,Reseller,Resellers,SDK,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-apps-admin-sdk/google-apps-admin-sdk-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://gsuite-developers.googleblog.com/search/label/Admin%20SDK"}, {"type"=>"x-blog-rss", "url"=>"https://gsuite-developers.googleblog.com/feeds/posts/default?alt=rss"}, {"type"=>"x-issues", "url"=>"https://code.google.com/a/google.com/p/apps-api-issues/issues/list?q=label:API-Apps"}, {"type"=>"x-website", "url"=>"https://developers.google.com/admin-sdk/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
taxamo{"apis"=>{"name"=>"Taxamo", "x-slug"=>"taxamo", "description"=>"We make global digital VAT/GST compliance possible. #DigitalTax #DigiTax #TaxTrends", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/18644-taxamo.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"795977", "tags"=>"Relative Data,Relative StreamRank,Service API,Stack Network,Streams,Streams,Streams,Target,Taxes,Taxes,VAT", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"taxamo/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Taxamo", "x-api-slug"=>"taxamo", "description"=>"We make global digital VAT/GST compliance possible. #DigitalTax #DigiTax #TaxTrends", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/18644-taxamo.jpg", "humanURL"=>"https://www.taxamo.com/", "baseURL"=>"https://api.taxamo.com//", "tags"=>"Relative Data,Relative StreamRank,Service API,Stack Network,Streams,Streams,Streams,Target,Taxes,Taxes,VAT", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/taxamo/taxamo-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://www.taxamo.com/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/taxamo-eu-vat-compliance"}, {"type"=>"x-documentation", "url"=>"https://api.taxamo.com/swagger/ui/index.html"}, {"type"=>"x-email", "url"=>"marketing@taxamo.com"}, {"type"=>"x-github", "url"=>"https://github.com/taxamo"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/taxamo"}, {"type"=>"x-pricing", "url"=>"http://www.taxamo.com/pricing/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/taxamo"}, {"type"=>"x-website", "url"=>"http://www.taxamo.com/"}, {"type"=>"x-website", "url"=>"http://taxamo.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "taxamo-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Taxamo", "x-complete"=>1, "info"=>{"title"=>"Taxamo", "description"=>"taxamos-elegant-suite-of-apis-and-comprehensive-reporting-dashboard-enables-digital-merchants-to-easily-comply-with-eu-regulatory-requirements-on-tax-calculation-evidence-collection-tax-return-creation-and-data-storage-", "version"=>"1"}, "host"=>"api.taxamo.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/v1/dictionaries/countries"=>{"get"=>{"summary"=>"Countries", "description"=>"Countries.", "operationId"=>"getCountriesDict", "x-api-path-slug"=>"apiv1dictionariescountries-get", "parameters"=>[{"in"=>"query", "name"=>"tax_supported", "description"=>"Should only countries with tax supported be listed?"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countries"]}}, "/api/v1/dictionaries/currencies"=>{"get"=>{"summary"=>"Currencies", "description"=>"Currencies.", "operationId"=>"getCurrenciesDict", "x-api-path-slug"=>"apiv1dictionariescurrencies-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Currencies"]}}, "/api/v1/dictionaries/product_types"=>{"get"=>{"summary"=>"Product Types", "description"=>"Product types.", "operationId"=>"getProductTypesDict", "x-api-path-slug"=>"apiv1dictionariesproduct-types-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "Types"]}}, "/api/v1/geoip"=>{"get"=>{"summary"=>"Locate IP Address", "description"=>"Locate ip address.", "operationId"=>"locateMyIP", "x-api-path-slug"=>"apiv1geoip-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Locate", "IP", "Ress"]}}, "/api/v1/geoip/{ip}"=>{"get"=>{"summary"=>"Locate Provided IP Address", "description"=>"Locate provided ip address.", "operationId"=>"locateGivenIP", "x-api-path-slug"=>"apiv1geoipip-get", "parameters"=>[{"in"=>"path", "name"=>"ip", "description"=>"IP address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Locate", "Provided", "IP", "Ress"]}}, "/api/v1/reports/domestic/summary"=>{"get"=>{"summary"=>"Calculate Domestic Summary", "description"=>"Calculate domestic summary.", "operationId"=>"getDomesticSummaryReport", "x-api-path-slug"=>"apiv1reportsdomesticsummary-get", "parameters"=>[{"in"=>"query", "name"=>"country_code", "description"=>"ISO 2-letter country code which will be used for determining which country is domestic"}, {"in"=>"query", "name"=>"currency_code", "description"=>"ISO 3-letter currency code, e"}, {"in"=>"query", "name"=>"end_month", "description"=>"Period end month in yyyy-MM format"}, {"in"=>"query", "name"=>"format", "description"=>"Output format"}, {"in"=>"query", "name"=>"fx_date_type", "description"=>"Which date should be used for FX"}, {"in"=>"query", "name"=>"start_month", "description"=>"Period start month in yyyy-MM format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calculate", "Domestic", "Summary"]}}, "/api/v1/reports/eu/vies"=>{"get"=>{"summary"=>"Calculate EU VIES Report", "description"=>"Calculate eu vies report.", "operationId"=>"getEuViesReport", "x-api-path-slug"=>"apiv1reportseuvies-get", "parameters"=>[{"in"=>"query", "name"=>"currency_code", "description"=>"ISO 3-letter currency code, e"}, {"in"=>"query", "name"=>"end_month", "description"=>"Period end month in yyyy-MM format"}, {"in"=>"query", "name"=>"eu_country_code", "description"=>"ISO 2-letter country code which will be used for determining which country is domestic"}, {"in"=>"query", "name"=>"format", "description"=>"Output format"}, {"in"=>"query", "name"=>"fx_date_type", "description"=>"Which date should be used for FX"}, {"in"=>"query", "name"=>"lff_sequence_number", "description"=>"Sequence number used to generate report in Large Filer Format"}, {"in"=>"query", "name"=>"period_length", "description"=>"Length of report period"}, {"in"=>"query", "name"=>"start_month", "description"=>"Period start month in yyyy-MM format"}, {"in"=>"query", "name"=>"tax_id", "description"=>"MOSS-assigned tax ID - if not provided, merchants national tax number will be used"}, {"in"=>"query", "name"=>"transformation", "description"=>"Which transformation should be applied"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calculate", "EU", "VIES", "Report"]}}, "/api/v1/settlement/detailed_refunds"=>{"get"=>{"summary"=>"Detailed Refunds", "description"=>"Detailed refunds.", "operationId"=>"getDetailedRefunds", "x-api-path-slug"=>"apiv1settlementdetailed-refunds-get", "parameters"=>[{"in"=>"query", "name"=>"country_codes", "description"=>"Comma separated list of 2-letter country codes"}, {"in"=>"query", "name"=>"date_from", "description"=>"Take only refunds issued at or after the date"}, {"in"=>"query", "name"=>"date_to", "description"=>"Take only refunds issued at or before the date"}, {"in"=>"query", "name"=>"format", "description"=>"Output format"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit (no more than 1000, defaults to 100)"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Detailed", "Refunds"]}}, "/api/v1/settlement/refunds"=>{"get"=>{"summary"=>"Fetch Refunds", "description"=>"Fetch refunds.", "operationId"=>"getRefunds", "x-api-path-slug"=>"apiv1settlementrefunds-get", "parameters"=>[{"in"=>"query", "name"=>"date_from", "description"=>"Take only refunds issued at or after the date"}, {"in"=>"query", "name"=>"format", "description"=>"Output format"}, {"in"=>"query", "name"=>"moss_country_code", "description"=>"MOSS country code, used to determine currency"}, {"in"=>"query", "name"=>"tax_region", "description"=>"Tax region key, defaults to EU for backwards compatibility"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fetch", "Refunds"]}}, "/api/v1/settlement/summary/{quarter}"=>{"get"=>{"summary"=>"Fetch Summary", "description"=>"Fetch summary.", "operationId"=>"getSettlementSummary", "x-api-path-slug"=>"apiv1settlementsummaryquarter-get", "parameters"=>[{"in"=>"query", "name"=>"end_month", "description"=>"Period end month in yyyy-MM format"}, {"in"=>"query", "name"=>"moss_country_code", "description"=>"MOSS country code, used to determine currency"}, {"in"=>"path", "name"=>"quarter", "description"=>"Quarter in yyyy-MM format"}, {"in"=>"query", "name"=>"start_month", "description"=>"Period start month in yyyy-MM format"}, {"in"=>"query", "name"=>"tax_region", "description"=>"Tax region key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fetch", "Summary"]}}, "/api/v1/settlement/{quarter}"=>{"get"=>{"summary"=>"Fetch Settlement", "description"=>"Fetch settlement.", "operationId"=>"getSettlement", "x-api-path-slug"=>"apiv1settlementquarter-get", "parameters"=>[{"in"=>"query", "name"=>"currency_code", "description"=>"ISO 3-letter currency code, e"}, {"in"=>"query", "name"=>"end_month", "description"=>"Period end month in yyyy-MM format"}, {"in"=>"query", "name"=>"format", "description"=>"Output format"}, {"in"=>"query", "name"=>"moss_country_code", "description"=>"MOSS country code, used to determine currency/region"}, {"in"=>"query", "name"=>"moss_tax_id", "description"=>"MOSS-assigned tax ID - if not provided, merchants national tax number will be used"}, {"in"=>"path", "name"=>"quarter", "description"=>"Quarter in yyyy-MM format"}, {"in"=>"query", "name"=>"refund_date_kind_override", "description"=>"Set to order_date to show only refunds for the transactions in the selected reporting period"}, {"in"=>"query", "name"=>"start_month", "description"=>"Period start month in yyyy-MM format"}, {"in"=>"query", "name"=>"tax_country_code", "description"=>"Tax entity country code, used to determine currency/region"}, {"in"=>"query", "name"=>"tax_id", "description"=>"MOSS-assigned tax ID - if not provided, merchants national tax number will be used"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fetch", "Settlement"]}}, "/api/v1/stats/settlement/by_country"=>{"get"=>{"summary"=>"Settlement By Country", "description"=>"Settlement by country.", "operationId"=>"getSettlementStatsByCountry", "x-api-path-slug"=>"apiv1statssettlementby-country-get", "parameters"=>[{"in"=>"query", "name"=>"date_from", "description"=>"Date from in yyyy-MM format"}, {"in"=>"query", "name"=>"date_to", "description"=>"Date to in yyyy-MM format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settlement", "Country"]}}, "/api/v1/stats/settlement/by_taxation_type"=>{"get"=>{"summary"=>"Settlement By Tax Type", "description"=>"Settlement by tax type.", "operationId"=>"getSettlementStatsByTaxationType", "x-api-path-slug"=>"apiv1statssettlementby-taxation-type-get", "parameters"=>[{"in"=>"query", "name"=>"date_from", "description"=>"Date from in yyyy-MM format"}, {"in"=>"query", "name"=>"date_to", "description"=>"Date to in yyyy-MM format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settlement", "Tax", "Type"]}}, "/api/v1/stats/settlement/daily"=>{"get"=>{"summary"=>"Settlement Stats Over Time", "description"=>"Settlement stats over time.", "operationId"=>"getDailySettlementStats", "x-api-path-slug"=>"apiv1statssettlementdaily-get", "parameters"=>[{"in"=>"query", "name"=>"date_from", "description"=>"Date from in yyyy-MM format"}, {"in"=>"query", "name"=>"date_to", "description"=>"Date to in yyyy-MM format"}, {"in"=>"query", "name"=>"interval", "description"=>"Interval type - day, week, month"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settlement", "Stats", "Over", "Time"]}}, "/api/v1/stats/transactions"=>{"get"=>{"summary"=>"Transaction Stats", "description"=>"Transaction stats.", "operationId"=>"getTransactionsStats", "x-api-path-slug"=>"apiv1statstransactions-get", "parameters"=>[{"in"=>"query", "name"=>"date_from", "description"=>"Date from in yyyy-MM format"}, {"in"=>"query", "name"=>"date_to", "description"=>"Date to in yyyy-MM format"}, {"in"=>"query", "name"=>"interval", "description"=>"Interval"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transaction", "Stats"]}}, "/api/v1/stats/transactions/by_country"=>{"get"=>{"summary"=>"Settlement By Country", "description"=>"Settlement by country.", "operationId"=>"getTransactionsStatsByCountry", "x-api-path-slug"=>"apiv1statstransactionsby-country-get", "parameters"=>[{"in"=>"query", "name"=>"date_from", "description"=>"Date from in yyyy-MM format"}, {"in"=>"query", "name"=>"date_to", "description"=>"Date to in yyyy-MM format"}, {"in"=>"query", "name"=>"global_currency_code", "description"=>"Global currency code to use for conversion - in addition to countrys currency if rate is available"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settlement", "Country"]}}, "/api/v1/tax/calculate"=>{"get"=>{"summary"=>"Simple Tax", "description"=>"Simple tax.", "operationId"=>"calculateSimpleTax", "x-api-path-slug"=>"apiv1taxcalculate-get", "parameters"=>[{"in"=>"query", "name"=>"amount", "description"=>"Amount"}, {"in"=>"query", "name"=>"billing_country_code", "description"=>"Billing two letter ISO country code"}, {"in"=>"query", "name"=>"buyer_credit_card_prefix", "description"=>"First 6 digits of buyers credit card prefix"}, {"in"=>"query", "name"=>"buyer_tax_number", "description"=>"Buyers tax number - EU VAT number for example"}, {"in"=>"query", "name"=>"currency_code", "description"=>"Currency code for transaction - e"}, {"in"=>"query", "name"=>"force_country_code", "description"=>"Two-letter ISO country code, e"}, {"in"=>"query", "name"=>"invoice_address_city", "description"=>"Invoice address/postal_code"}, {"in"=>"query", "name"=>"invoice_address_postal_code", "description"=>"Invoice address/postal_code"}, {"in"=>"query", "name"=>"invoice_address_region", "description"=>"Invoice address/region"}, {"in"=>"query", "name"=>"order_date", "description"=>"Order date in yyyy-MM-dd format, in merchants timezone"}, {"in"=>"query", "name"=>"product_type", "description"=>"Product type, according to dictionary /dictionaries/product_types"}, {"in"=>"query", "name"=>"quantity", "description"=>"Quantity Defaults to 1"}, {"in"=>"query", "name"=>"tax_deducted", "description"=>"If the transaction is in a country supported by Taxamo, but the tax is not calculated due to merchant settings or EU B2B transaction for example"}, {"in"=>"query", "name"=>"total_amount", "description"=>"Total amount"}, {"in"=>"query", "name"=>"unit_price", "description"=>"Unit price"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Simple", "Tax"]}, "post"=>{"summary"=>"Calculate Tax", "description"=>"Calculate tax.", "operationId"=>"calculateTax", "x-api-path-slug"=>"apiv1taxcalculate-post", "parameters"=>[{"in"=>"body", "name"=>"input", "description"=>"Input", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calculate", "Tax"]}}, "/api/v1/tax/location/calculate"=>{"get"=>{"summary"=>"Calculate Location", "description"=>"Calculate location.", "operationId"=>"calculateTaxLocation", "x-api-path-slug"=>"apiv1taxlocationcalculate-get", "parameters"=>[{"in"=>"query", "name"=>"billing_country_code", "description"=>"Billing two letter ISO country code"}, {"in"=>"query", "name"=>"buyer_credit_card_prefix", "description"=>"First 6 digits of buyers credit card prefix"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calculate", "Location"]}}, "/api/v1/tax/vat_numbers/{tax_number}/validate"=>{"get"=>{"summary"=>"Validate VAT Number", "description"=>"Validate vat number.", "operationId"=>"validateTaxNumber", "x-api-path-slug"=>"apiv1taxvat-numberstax-numbervalidate-get", "parameters"=>[{"in"=>"query", "name"=>"country_code", "description"=>"Two-letter ISO country code"}, {"in"=>"path", "name"=>"tax_number", "description"=>"Tax number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Validate", "VAT", "Number"]}}, "/api/v1/transactions"=>{"get"=>{"summary"=>"Browse Transactions", "description"=>"Browse transactions.", "operationId"=>"listTransactions", "x-api-path-slug"=>"apiv1transactions-get", "parameters"=>[{"in"=>"query", "name"=>"currency_code", "description"=>"Three letter ISO currency code"}, {"in"=>"query", "name"=>"filter_text", "description"=>"Filtering expression"}, {"in"=>"query", "name"=>"format", "description"=>"Output format - supports csv value for this operation"}, {"in"=>"query", "name"=>"has_note", "description"=>"Return only transactions with a note field set"}, {"in"=>"query", "name"=>"invoice_number", "description"=>"Transaction invoice number"}, {"in"=>"query", "name"=>"key_or_custom_id", "description"=>"Taxamo provided transaction key or custom id"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit (no more than 1000, defaults to 100)"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset"}, {"in"=>"query", "name"=>"order_date_from", "description"=>"Order date from in yyyy-MM-dd format"}, {"in"=>"query", "name"=>"order_date_to", "description"=>"Order date to in yyyy-MM-dd format"}, {"in"=>"query", "name"=>"original_transaction_key", "description"=>"Taxamo provided original transaction key"}, {"in"=>"query", "name"=>"sort_reverse", "description"=>"If true, results are sorted in descending order"}, {"in"=>"query", "name"=>"statuses", "description"=>"Comma separated list of of transaction statuses"}, {"in"=>"query", "name"=>"tax_country_code", "description"=>"Two letter ISO tax country code"}, {"in"=>"query", "name"=>"tax_country_codes", "description"=>"Comma separated list of two letter ISO tax country codes"}, {"in"=>"query", "name"=>"total_amount_greater_than", "description"=>"Return only transactions with total amount greater than given number"}, {"in"=>"query", "name"=>"total_amount_less_than", "description"=>"Return only transactions with total amount less than a given number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Browse", "Transactions"]}, "post"=>{"summary"=>"Store Transaction", "description"=>"Store transaction.", "operationId"=>"createTransaction", "x-api-path-slug"=>"apiv1transactions-post", "parameters"=>[{"in"=>"body", "name"=>"input", "description"=>"Input", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store", "Transaction"]}}, "/api/v1/transactions/{key}"=>{"delete"=>{"summary"=>"Delete Transaction", "description"=>"Delete transaction.", "operationId"=>"cancelTransaction", "x-api-path-slug"=>"apiv1transactionskey-delete", "parameters"=>[{"in"=>"path", "name"=>"key", "description"=>"Transaction key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transaction"]}, "get"=>{"summary"=>"Retrieve Transaction Data.", "description"=>"Retrieve transaction data..", "operationId"=>"getTransaction", "x-api-path-slug"=>"apiv1transactionskey-get", "parameters"=>[{"in"=>"path", "name"=>"key", "description"=>"Transaction key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Transaction", "Data"]}, "put"=>{"summary"=>"Update Transaction", "description"=>"Update transaction.", "operationId"=>"updateTransaction", "x-api-path-slug"=>"apiv1transactionskey-put", "parameters"=>[{"in"=>"body", "name"=>"input", "description"=>"Input", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"key", "description"=>"Transaction key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transaction"]}}, "/api/v1/transactions/{key}/confirm"=>{"post"=>{"summary"=>"Confirm Transaction", "description"=>"Confirm transaction.", "operationId"=>"confirmTransaction", "x-api-path-slug"=>"apiv1transactionskeyconfirm-post", "parameters"=>[{"in"=>"body", "name"=>"input", "description"=>"Input", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"key", "description"=>"Transaction key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Confirm", "Transaction"]}}, "/api/v1/transactions/{key}/invoice/refunds/{refund_note_number}/send_email"=>{"post"=>{"summary"=>"Email Credit Note", "description"=>"Email credit note.", "operationId"=>"emailRefund", "x-api-path-slug"=>"apiv1transactionskeyinvoicerefundsrefund-note-numbersend-email-post", "parameters"=>[{"in"=>"body", "name"=>"input", "description"=>"Input", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"key", "description"=>"Transaction key"}, {"in"=>"path", "name"=>"refund_note_number", "description"=>"Refund note id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Credit", "Note"]}}, "/api/v1/transactions/{key}/invoice/send_email"=>{"post"=>{"summary"=>"Email Invoice", "description"=>"Email invoice.", "operationId"=>"emailInvoice", "x-api-path-slug"=>"apiv1transactionskeyinvoicesend-email-post", "parameters"=>[{"in"=>"body", "name"=>"input", "description"=>"Input", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"key", "description"=>"Transaction key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Invoice"]}}, "/api/v1/transactions/{key}/payments"=>{"get"=>{"summary"=>"List Payments", "description"=>"List payments.", "operationId"=>"listPayments", "x-api-path-slug"=>"apiv1transactionskeypayments-get", "parameters"=>[{"in"=>"path", "name"=>"key", "description"=>"Transaction key"}, {"in"=>"query", "name"=>"limit", "description"=>"Max record count (no more than 100, defaults to 10)"}, {"in"=>"query", "name"=>"offset", "description"=>"How many records need to be skipped, defaults to 0"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Payments"]}, "post"=>{"summary"=>"Register A Payment", "description"=>"Register a payment.", "operationId"=>"createPayment", "x-api-path-slug"=>"apiv1transactionskeypayments-post", "parameters"=>[{"in"=>"body", "name"=>"input", "description"=>"Input", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"key", "description"=>"Transaction key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "Payment"]}}, "/api/v1/transactions/{key}/payments/capture"=>{"post"=>{"summary"=>"Capture Payment", "description"=>"Capture payment.", "operationId"=>"capturePayment", "x-api-path-slug"=>"apiv1transactionskeypaymentscapture-post", "parameters"=>[{"in"=>"path", "name"=>"key", "description"=>"Transaction key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Capture", "Payment"]}}, "/api/v1/transactions/{key}/refunds"=>{"get"=>{"summary"=>"Get Transaction Refunds", "description"=>"Get transaction refunds.", "operationId"=>"listRefunds", "x-api-path-slug"=>"apiv1transactionskeyrefunds-get", "parameters"=>[{"in"=>"path", "name"=>"key", "description"=>"Transaction key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transaction", "Refunds"]}, "post"=>{"summary"=>"Create A Refund", "description"=>"Create a refund.", "operationId"=>"createRefund", "x-api-path-slug"=>"apiv1transactionskeyrefunds-post", "parameters"=>[{"in"=>"body", "name"=>"input", "description"=>"Input", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"key", "description"=>"Transaction key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Refund"]}}, "/api/v1/transactions/{key}/unconfirm"=>{"post"=>{"summary"=>"Un-confirm The Transaction", "description"=>"Un-confirm the transaction.", "operationId"=>"unconfirmTransaction", "x-api-path-slug"=>"apiv1transactionskeyunconfirm-post", "parameters"=>[{"in"=>"body", "name"=>"input", "description"=>"Input", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"key", "description"=>"Transaction key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Un-confirm", "Transaction"]}}, "/api/v1/verification/sms"=>{"post"=>{"summary"=>"Create SMS Token", "description"=>"Create sms token.", "operationId"=>"createSMSToken", "x-api-path-slug"=>"apiv1verificationsms-post", "parameters"=>[{"in"=>"body", "name"=>"input", "description"=>"Input", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SMS", "Token"]}}, "/api/v1/verification/sms/{token}"=>{"get"=>{"summary"=>"Verify SMS Token", "description"=>"Verify sms token.", "operationId"=>"verifySMSToken", "x-api-path-slug"=>"apiv1verificationsmstoken-get", "parameters"=>[{"in"=>"path", "name"=>"token", "description"=>"Provided token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Verify", "SMS", "Token"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ebay{"ebay-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"eBay", "x-complete"=>1, "info"=>{"title"=>"Ebay", "description"=>"the-ebay-platform-offers-an-unprecedented-opportunity-to-build-a-new-ebay-business-or-expand-your-current-business-reach-new-customers-and-create-a-potential-new-stream-of-revenue--leverage-the-resources-of-the-ebay-developers-program-to-tap-into-the-ebay-marketplace-with-millions-of-active-users-globally-with-tools-and-services-that-meet-the-diverse-needs-of-buyers-and-sellers-", "contact"=>{"name"=>"eBay Inc."}, "version"=>"1.0.0"}, "host"=>"api.ebay.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/item/get_item_by_legacy_id"=>{"get"=>{"summary"=>"Get Item Get Item By Legacy", "description"=>"This call is a bridge between the eBay legacy APIs, such as Trading, Shopping, and Finding and the eBay Buy APIs. There are differences between how legacy APIs and RESTful APIs return the identifier of an "item". There is also a difference in what the item Id represents and in the format of the item Id value returned. This call lets you use the legacy item Ids retrieve the details of a specific item, such as description, price, and other information the buyer needs to make a purchasing decision. It also returns the RESTful item Id, which you can use with all the Buy API calls. For more information about how to use legacy Ids with the Buy APIs, see Legacy API compatibility in the Buying Integration guide. This call returns the item details and requires you to pass in either the item Id of a non-variation item or the item Ids of both the parent and child of a item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc. The fieldgroups URI parameter lets you control what is returned in the response. Setting fieldgroups to PRODUCT, adds additional fields to the default response that return information about the product of the item. For more information, see fieldgroups. Request headers You will want to use the X-EBAY-C-ENDUSERCTX request header with this call. If you are an eBay Network Partner you must use affiliateCampaignId=ePNCampaignId,affiliateReferenceId=referenceId in the header in order to be paid for selling eBay items on your site and it is strongly recommended you use contextualLocation to improved the estimated delivery window information. For details see, Request headers in the Buy APIs Overview. Restrictions For a list of supported sites and other restrictions, see API Restrictions.", "operationId"=>"getItemByLegacyId", "x-api-path-slug"=>"itemget-item-by-legacy-id-get", "parameters"=>[{"in"=>"query", "name"=>"fieldgroups", "description"=>"This field lets you control what is returned in the response"}, {"in"=>"query", "name"=>"legacy_item_id", "description"=>"Specifies either: The legacy item Id of an item that is not part of a group"}, {"in"=>"query", "name"=>"legacy_variation_id", "description"=>"Specifies the legacy item Id of a specific item in an item group, such as the red shirt size L"}, {"in"=>"query", "name"=>"legacy_variation_sku", "description"=>"Specifics the legacy SKU of the item"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Item", "", "Item", "Legacy"]}}, "/item/get_items_by_item_group"=>{"get"=>{"summary"=>"Get Item Get Items By Item Group", "description"=>"This call retrieves the details of the individual items in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. You pass in the item group Id as a URI parameter. You use this call to show the item details of items with multiple aspects, such as color, size, storage capacity, etc. This call returns two main containers; items and commonDescriptions. The items container has an array of containers with the details of each item in the group. The commonDescriptions container has an array of containers for a description and the item Ids of all the items that have this exact description. Because items within an item group often have the same description, this decreases the size of the response. Request headers You will want to use the X-EBAY-C-ENDUSERCTX request header with this call. If you are an eBay Network Partner you must use affiliateCampaignId=ePNCampaignId,affiliateReferenceId=referenceId in the header in order to be paid for selling eBay items on your site and it is strongly recommended you use contextualLocation to improved the estimated delivery window information. For details see, Request headers in the Buy APIs Overview. Restrictions For a list of supported sites and other restrictions, see API Restrictions.", "operationId"=>"getItemsByItemGroup", "x-api-path-slug"=>"itemget-items-by-item-group-get", "parameters"=>[{"in"=>"query", "name"=>"item_group_id", "description"=>"Identifier of the item group to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Item", "", "Items", "Item", "Group"]}}, "/item/{item_id}"=>{"get"=>{"summary"=>"Get Item Item", "description"=>"This call retrieves the details of a specific item, such as description, price, category, all item aspects, condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery, and other information the buyer needs to make a purchasing decision. The Buy APIs are designed to let you create an eBay shopping experience in your app or website. This means you will need to know when something, such as the availability, quantity, etc., has changed in any eBay item you are offering. You can do this easily by setting the fieldgroups URI parameter. This parameter lets you control what is returned in the response. Setting fieldgroups to COMPACT reduces the response to only the five fields that you need in order to check if any item detail has changed. Setting fieldgroups to PRODUCT, adds additional fields to the default response that return information about the product of the item. You can use either COMPACT or PRODUCT but not both. For more information, see fieldgroups. Request headers You will want to use the X-EBAY-C-ENDUSERCTX request header with this call. If you are an eBay Network Partner you must use affiliateCampaignId=ePNCampaignId,affiliateReferenceId=referenceId in the header in order to be paid for selling eBay items on your site and it is strongly recommended you use contextualLocation to improved the estimated delivery window information. For details see, Request headers in the Buy APIs Overview. Restrictions For a list of supported sites and other restrictions, see API Restrictions.", "operationId"=>"getItem", "x-api-path-slug"=>"itemitem-id-get", "parameters"=>[{"in"=>"query", "name"=>"fieldgroups", "description"=>"This parameter lets you control what is returned in the response"}, {"in"=>"path", "name"=>"item_id", "description"=>"The eBay identifier of an item"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Item", "Item"]}}, "/item_summary/search"=>{"get"=>{"summary"=>"Get Item Summary Search", "description"=>"This call performs an advanced search for items. You can search by keyword, category, eBay product Id (EPID), or gtin. Or a combination of these. Encoding Parameters and Headers As with all query parameter values, the fields parameter value and request header values must be URL encoded. For better readability, the examples in this document omit the encoding. Example: search?q=world cup soccer ball&aspect_filter=categoryId:20863,Brand:{Nike|Wilson} Encoded Example: search?q=world cup soccer ball&aspect_filter=categoryId%3A20863%2CBrand%3A%7BNike%7CWilson%7D For more information about encoding, see HTML URL Encoding Reference The following are examples of using filters: The following call returns 4,330,774 items. /buy/browse/v1/item_summary/search?q=phone This call, which limits the results to the category "Cell Phones & Smartphones", returns 142,098 items. /buy/browse/v1/item_summary/search?q=phone&category_ids=9355 These calls, which limit results to a Samsung Galaxy S5, returns 97 items. /buy/browse/v1/item_summary/search?q=phone&category_ids=220&epid=182527490 or /buy/browse/v1/item_summary/search?epid=182527490 Controlling what is returned You can also control what is returned by using the fieldgroups field. In addition to returning items, which is the default, you can return refinements (metadata) about an item that enables you to create aspect histograms. A histogram enables users to drill down in each refinement narrowing the search results. You can return: ASPECT_REFINEMENTS - Lets shoppers refine the result set by variation aspects, such as Brand, Color, etc. BUYING_OPTION_REFINEMENT - Lets shoppers refine the result set by either FIXED_PRICE or AUCTION CATEGORY_REFINEMENTS - Lets shoppers refine the result set by items in a category CONDITION_REFINEMENT - Lets shoppers refine the result set by item condition, such as NEW, USED, etc. MATCHING_ITEMS - The default, which returns the items. When used with one or more of the refinement values above the specified refinements and all the matching items are returned. FULL - This returns all the refinement containers and all the matching items. Filtering by aspects You can use the aspect refinements returned to filter the result set using the aspect_filter field. For example: This call gets a list of the aspects pairs for the item and the dominant category (category most of the items are in). /buy/browse/v1/item_summary/search?q=world cup soccer ball&fieldgroups=ASPECT_REFINEMENTS This call filters the items by one of the aspect pairs returned and the dominant category ( categoryId is required when using aspect_filter) /buy/browse/v1/item_summary/search?q=world cup soccer ball&aspect_filter=categoryId:20863,Brand:{adidas} This call filters the items by multiple aspects /buy/browse/v1/item_summary/search?q=world cup soccer ball&aspect_filter=categoryId:20863,Brand:{adidas},Featured Refinements:{Adidas Match Ball} This call filters the items by multiple aspect values /buy/browse/v1/item_summary/search?q=world cup soccer ball&aspect_filter=categoryId:20863,Brand:{Nike|Wilson} Additional filters There are also multiple filters you can use to refine the result set, such as listing format, item condition, price range, listing end date, location, and more. You can use multiple filters in a single call. For a list and details of the supported filters, see search Call Field Filters. Pagination and sort controls There are pagination controls ( limit and offset fields) and sort query parameter that control/sort the data that is returned. By default, the results are sorted by "Best Match". For more information about Best Match, see the eBay help page Best Match. Request headers You will want to use the X-EBAY-C-ENDUSERCTX request header with this call. If you are an eBay Network Partner you must use affiliateCampaignId=ePNCampaignId,affiliateReferenceId=referenceId in the header in order to be paid for selling eBay items on your site and it is strongly recommended you use contextualLocation to improved the estimated delivery window information. For details see, Request headers in the Buy APIs Overview. Restrictions For a list of supported sites and other restrictions, see API Restrictions. Limitation: This call can return a maximum of 10,000 items.", "operationId"=>"search", "x-api-path-slug"=>"item-summarysearch-get", "parameters"=>[{"in"=>"query", "name"=>"aspect_filter", "description"=>"The aspect name/value pairs and category, which is required, to use to limit the results"}, {"in"=>"query", "name"=>"category_ids", "description"=>"The category Ids to use to limit the results"}, {"in"=>"query", "name"=>"epid", "description"=>"The EPID is the eBay product identifier of a product from the eBay product catalog"}, {"in"=>"query", "name"=>"fieldgroups", "description"=>"This field lets you control what is to be returned in the response"}, {"in"=>"query", "name"=>"filter", "description"=>"This field supports multiple field filters that can be used to use to limit/customize the result set"}, {"in"=>"query", "name"=>"gtin", "description"=>"This field lets you search by the Global Trade Item Number of the item as defined by http://www"}, {"in"=>"query", "name"=>"limit", "description"=>"The number of items in a result set"}, {"in"=>"query", "name"=>"offset", "description"=>"The number of items to skip in the result set"}, {"in"=>"query", "name"=>"q", "description"=>"A string consisting of one or more words that are used for a search of items on eBay"}, {"in"=>"query", "name"=>"sort", "description"=>"Specifies the order and the field name to use to sort the items"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Item", "Summary", "Search"]}}, "/item"=>{"get"=>{"summary"=>"Get Item", "description"=>"The Item feed file is generated each day. This call lets you download a daily TSV_GZIP (tab separated value gzip) Item feed file of all the items that were listed on a specific day in a specific category. For each item, all the item details are returned, except for the item description. The description of each item is excluded because these can be huge and items in an item group (an item with variations, such as size and color) can share the same description. The item descriptions are returned in a separate Descriptions gzip feed file by the getItemDescriptionFeed call. To store the complete item details, you would always run the getItemFeed and getItemDescriptionFeed calls with the same parameters. /item?feed_scope=NEWLY_LISTED&category_id=625&date=20170918 /item_description?feed_scope=NEWLY_LISTED&category_id=625&date=20170918 Items returned in the feed file All items in the file are: In new condition Fixed price (Buy It Now); no auctions From eBay trusted sellers The feed file contains all the items from all the child categories of the specified category. The first line of the file is the header, which indicates the order of the values on each line. Each header is described in the Response fields section on this page. Downloading feed files Item feed files are binary gzip files. If the file is larger than 100 MB, the download must be streamed in chunks. You specify the size of the chunks in bytes using the Range request header. The Content-range response header indicates where in the full resource this partial chunk of data belongs and the total number of bytes in the file. For more information about using these headers, see Retrieving a gzip feed file. Important: The response is always a TSV_GZIP file. But for documentation purposes, the response is shown as JSON fields so that the value returned in each column can be explained. The order of the response fields, shows you the order of the columns in the feed file. Restrictions For a list of supported sites and other restrictions, see API Restrictions.", "operationId"=>"getItemFeed", "x-api-path-slug"=>"item-get", "parameters"=>[{"in"=>"query", "name"=>"category_id", "description"=>"An eBay top-level category ID of the items to be returned in the feed file"}, {"in"=>"query", "name"=>"date", "description"=>"The date of the feed file you want"}, {"in"=>"query", "name"=>"feed_scope", "description"=>"Controls the contents of the feed file"}, {"in"=>"header", "name"=>"Range", "description"=>"This header specifies the range in bytes of the chunks of the gzip file being returned"}, {"in"=>"header", "name"=>"X-EBAY-C-MARKETPLACE-ID", "description"=>"The ID for the eBay marketplace where the items are hosted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Item"]}}, "/item_description"=>{"get"=>{"summary"=>"Get Item Description", "description"=>"The Description feed file is generated each day. This call lets you download a daily TSV_GZIP (tab separated value gzip) Description feed file containing the descriptions of all the items that were listed on a specific day in a specific category. To store the complete item details, you would always run the getItemFeed and getItemDescriptionFeed calls with the same parameters. /item?feed_scope=NEWLY_LISTED&category_id=625&date=20170918 /item_description?feed_scope=NEWLY_LISTED&category_id=625&date=20170918 Combining the Description and Item feed files The Description feed file contains only the itemId, itemGroupId and description columns. The value of the description column is BASE64 encoded. For each row, there will be values in either itemId or itemGroupId. The description column will always contain a value. itemGroupId - The value in this column is the ID of an item group (an item with variations, such as size and color) where the items in the group share the same description. Even though the itemGroupId represents more than one item, the itemGroupId and description are returned only once for the entire group. In this case, there will be values in the itemGroupId and description columns. You match the value of itemGroupId from the Description feed file with the value of primaryItemGroupId from the Item feed file for the same day and category. itemId - The value in this column is the ID of an item that is not part of an item group or (in rare cases) the item is part of an item group but does not share a description with other items in the group. In this case, there will be values in the itemId and description columns. You match the value of itemId from the Description feed file with the value of itemId from the Item feed file for the same day and category. The file will contain the descriptions for all the items or item groups from all the child categories of the category. The first line of the file is the header, which indicates the order of the values on each line. Each column is described in the Response fields section on this page. Downloading feed files Description feed files are very large so the gzip file, which is binary, is streamed in chunks. You specify the size of the chunks in bytes using the Range request header. The Content-range response header indicates where in the full resource this partial chunk of data belongs and the total number of bytes in the file. For more information about using these headers, see Retrieving a gzip feed file. Important: The response is always a TSV_GZIP file. But for documentation purposes, the response is shown as JSON fields so that the value returned in each column can be explained. The order of the response fields, shows you the order of the columns in the feed file. Restrictions For a list of supported sites and other restrictions, see API Restrictions.", "operationId"=>"getItemDescriptionFeed", "x-api-path-slug"=>"item-description-get", "parameters"=>[{"in"=>"query", "name"=>"category_id", "description"=>"An eBay top-level category ID of the items to be returned in the feed file"}, {"in"=>"query", "name"=>"date", "description"=>"The date of the feed file you want"}, {"in"=>"query", "name"=>"feed_scope", "description"=>"Controls the contents of the feed file"}, {"in"=>"header", "name"=>"Range", "description"=>"This header specifies the range in bytes of the chunks of the gzip file being returned"}, {"in"=>"header", "name"=>"X-EBAY-C-MARKETPLACE-ID", "description"=>"The ID for the eBay marketplace where the items are hosted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Item", "Description"]}}, "/merchandised_product"=>{"get"=>{"summary"=>"Get Merchandised Product", "description"=>"This call returns an array of products based on the category and metric specified. This includes details of the product, such as the eBay product Id (EPID), title, and user reviews and ratings for the product. You can use the epid returned by this call in the Browse API search call to retrieve items for this product. Restrictions For a list of supported sites and other restrictions, see API Restrictions.", "operationId"=>"getMerchandisedProducts", "x-api-path-slug"=>"merchandised-product-get", "parameters"=>[{"in"=>"query", "name"=>"aspect_filter", "description"=>"The aspect name/value pairs used to further refine product results"}, {"in"=>"query", "name"=>"category_id", "description"=>"This query parameter limits the products returned to a specific eBay category"}, {"in"=>"query", "name"=>"limit", "description"=>"This value specifies the maximum number of products to return in a result set"}, {"in"=>"query", "name"=>"metric_name", "description"=>"This value filters the result set by the specified metric"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Merchandised", "Product"]}}, "/merchandised_product/get_also_bought_products"=>{"get"=>{"summary"=>"Get Merchandised Product Get Also Bought Products", "description"=>"This call returns products that were also bought when shoppers bought the product specified in the request. Showing 'also bought' products inspires up-selling and cross-selling. You specify the product by one of the following. epid (eBay Product Id) gtin (Global Trade Item Number) brand (brand name such as Nike) plus mpn (Manufacturer's Part Number) Restrictions For a list of supported sites and other restrictions, see API Restrictions. Maximum: A maximum of 12 products are returned. The call will return up to 12 products, but it can be less than 12. If the number of products found is less than 12, the call will return all of the products matching the criteria.", "operationId"=>"getAlsoBoughtByProduct", "x-api-path-slug"=>"merchandised-productget-also-bought-products-get", "parameters"=>[{"in"=>"query", "name"=>"brand", "description"=>"The brand of the product"}, {"in"=>"query", "name"=>"epid", "description"=>"The eBay product identifier of a product"}, {"in"=>"query", "name"=>"gtin", "description"=>"The unique Global Trade Item Number of the item as defined by http://www"}, {"in"=>"query", "name"=>"mpn", "description"=>"The manufacturer part number of the product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Merchandised", "Product", "", "Also", "Bought", "Products"]}}, "/merchandised_product/get_also_viewed_products"=>{"get"=>{"summary"=>"Get Merchandised Product Get Also Viewed Products", "description"=>"This call returns products that were also viewed when shoppers viewed the product specified in the request. Showing 'also viewed' products encourages up-selling and cross-selling. You specify the product by one of the following. epid (eBay Product Id) gtin (Global Trade Item Number) brand (brand name such as Nike) plus mpn (Manufacturer's Part Number) Restrictions For a list of supported sites and other restrictions, see API Restrictions. Maximum: A maximum of 12 products are returned. The call will return up to 12 products, but it can be less than 12. If the number of products found is less than 12, the call will return all of the products matching the criteria.", "operationId"=>"getAlsoViewedByProduct", "x-api-path-slug"=>"merchandised-productget-also-viewed-products-get", "parameters"=>[{"in"=>"query", "name"=>"brand", "description"=>"The brand of the product"}, {"in"=>"query", "name"=>"epid", "description"=>"The eBay product identifier of a product"}, {"in"=>"query", "name"=>"gtin", "description"=>"The unique Global Trade Item Number of the item as defined by http://www"}, {"in"=>"query", "name"=>"mpn", "description"=>"The manufacturer part number of the product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Merchandised", "Product", "", "Also", "Viewed", "Products"]}}, "/category_tree/{category_tree_id}"=>{"get"=>{"summary"=>"Get Category Tree Category Tree", "description"=>"This call retrieves the complete category tree that is identified by the category_tree_id parameter. The value of category_tree_id was returned by the getDefaultCategoryTreeId call in the categoryTreeId field. The response contains details of all nodes of the specified eBay category tree, as well as the eBay marketplaces that use this category tree. Note: This call can return a very large payload, so you are strongly advised to submit the request with the following HTTP header: Accept-Encoding: application/gzip With this header (in addition to the required headers described under HTTP Request Headers), the call returns the response with gzip compression.", "operationId"=>"getCategoryTree", "x-api-path-slug"=>"category-treecategory-tree-id-get", "parameters"=>[{"in"=>"path", "name"=>"category_tree_id", "description"=>"The unique identifier of the eBay category tree being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Category", "Tree", "Category", "Tree"]}}, "/category_tree/{category_tree_id}/get_category_subtree"=>{"get"=>{"summary"=>"Get Category Tree Category Tree Get Category Subtree", "description"=>"This call retrieves the details of all nodes of the category tree hierarchy (the subtree) below a specified category of a category tree. You identify the tree using the category_tree_id parameter, which was returned by the getDefaultCategoryTreeId call in the categoryTreeId field. Note: This call can return a very large payload, so you are strongly advised to submit the request with the following HTTP header: Accept-Encoding: application/gzip With this header (in addition to the required headers described under HTTP Request Headers), the call returns the response with gzip compression.", "operationId"=>"getCategorySubtree", "x-api-path-slug"=>"category-treecategory-tree-idget-category-subtree-get", "parameters"=>[{"in"=>"query", "name"=>"category_id", "description"=>"The unique identifier of the category at the top of the subtree being requested"}, {"in"=>"path", "name"=>"category_tree_id", "description"=>"The unique identifier of the eBay category tree from which a category subtree is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Category", "Tree", "Category", "Tree", "", "", "Category", "Subtree"]}}, "/category_tree/{category_tree_id}/get_category_suggestions"=>{"get"=>{"summary"=>"Get Category Tree Category Tree Get Category Suggestions", "description"=>"This call returns an array of category tree leaf nodes in the specified category tree that are considered by eBay to most closely correspond to the query string q. Returned with each suggested node is a localized name for that category (based on the Accept-Language header specified for the call), and details about each of the category's ancestor nodes, extending from its immediate parent up to the root of the category tree. Note: This call can return a large payload, so you are advised to submit the request with the following HTTP header: Accept-Encoding: application/gzip With this header (in addition to the required headers described under HTTP Request Headers), the call returns the response with gzip compression. You identify the tree using the category_tree_id parameter, which was returned by the getDefaultCategoryTreeId call in the categoryTreeId field. Important: This call is not supported in the Sandbox environment. It will return a response payload in which the categoryName fields contain random or boilerplate text regardless of the query submitted.", "operationId"=>"getCategorySuggestions", "x-api-path-slug"=>"category-treecategory-tree-idget-category-suggestions-get", "parameters"=>[{"in"=>"path", "name"=>"category_tree_id", "description"=>"The unique identifier of the eBay category tree for which suggested nodes are being requested"}, {"in"=>"query", "name"=>"q", "description"=>"A quoted string that describes or characterizes the item being offered for sale"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Category", "Tree", "Category", "Tree", "", "", "Category", "Suggestions"]}}, "/category_tree/{category_tree_id}/get_item_aspects_for_category"=>{"get"=>{"summary"=>"Get Category Tree Category Tree Get Item Aspects For Category", "description"=>"This call returns a list of aspects that are appropriate or necessary for accurately describing items in the specified leaf category. Each aspect identifies an item attribute (for example, color) for which the seller will be required or encouraged to provide a value (or variation values) when offering an item in that category on eBay. For each aspect, getItemAspectsForCategory provides complete metadata, including: The aspect's data type, format, and entry mode Whether the aspect is required in listings Whether the aspect can be used for item variations Whether the aspect accepts multiple values for an item Allowed values for the aspectUse this information to construct an interface through which sellers can enter or select the appropriate values for their items or item variations. Once you collect those values, include them as product aspects when creating inventory items using the Inventory API.", "operationId"=>"getItemAspectsForCategory", "x-api-path-slug"=>"category-treecategory-tree-idget-item-aspects-for-category-get", "parameters"=>[{"in"=>"query", "name"=>"category_id", "description"=>"The unique identifier of the leaf category for which aspects are being requested"}, {"in"=>"path", "name"=>"category_tree_id", "description"=>"The unique identifier of the eBay category tree from which the specified categorys aspects are being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Category", "Tree", "Category", "Tree", "", "", "Item", "Aspects", "Category"]}}, "/get_default_category_tree_id"=>{"get"=>{"summary"=>"Get Get Default Category Tree", "description"=>"A given eBay marketplace might use multiple category trees, but one of those trees is considered to be the default for that marketplace. This call retrieves a reference to the default category tree associated with the specified eBay marketplace ID. The response includes only the tree's unique identifier and version, which you can use to retrieve more details about the tree, its structure, and its individual category nodes.", "operationId"=>"getDefaultCategoryTreeId", "x-api-path-slug"=>"get-default-category-tree-id-get", "parameters"=>[{"in"=>"query", "name"=>"marketplace_id", "description"=>"The ID of the eBay marketplace for which the category tree ID is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Default", "Category", "Tree"]}}, "/order"=>{"get"=>{"summary"=>"Get Order", "description"=>"Use this call to search for and retrieve one or more orders based on their creation date, last modification date, or fulfillment status using the filter parameter. You can alternatively specify a list of orders using the orderIds parameter. The returned Order objects contain information you can use to create and process fulfillments, including: Information about the buyer and seller Information about the order's line items The plans for packaging, addressing and shipping the order The status of payment, packaging, addressing, and shipping the order A summary of monetary amounts specific to the order such as pricing, payments, and shipping costs Important: In this call, the cancelStatus.cancelRequests array is returned but is always empty. Use the getOrder call instead, which returns this array fully populated with information about any cancellation requests.", "operationId"=>"getOrders", "x-api-path-slug"=>"order-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"One or more comma-separated criteria for narrowing down the collection of orders returned by this call"}, {"in"=>"query", "name"=>"limit", "description"=>"The number of orders to return in the current result set"}, {"in"=>"query", "name"=>"offset", "description"=>"The first order to return based on its position in the collection of orders"}, {"in"=>"query", "name"=>"orderIds", "description"=>"A comma-separated list of the unique identifiers of the orders to retrieve (maximum 50)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Order"]}}, "/order/{orderId}"=>{"get"=>{"summary"=>"Get Order Order", "description"=>"Use this call to retrieve the contents of an order based on its unique identifier, orderId. This value was returned in the getOrders call's orders.orderId field when you searched for orders by creation date, modification date, or fulfillment status. The returned Order object contains information you can use to create and process fulfillments, including: Information about the buyer and seller Information about the order's line items The plans for packaging, addressing and shipping the order The status of payment, packaging, addressing, and shipping the order A summary of monetary amounts specific to the order such as pricing, payments, and shipping costs", "operationId"=>"getOrder", "x-api-path-slug"=>"orderorderid-get", "parameters"=>[{"in"=>"path", "name"=>"orderId", "description"=>"The unique identifier of the order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Order", "Order"]}}, "/order/{orderId}/shipping_fulfillment"=>{"get"=>{"summary"=>"Get Order Order Shipping Fulfillment", "description"=>"Use this call to retrieve the contents of all fulfillments currently defined for a specified order based on the order's unique identifier, orderId. This value is returned in the getOrders call's members.orderId field when you search for orders by creation date or shipment status.", "operationId"=>"getShippingFulfillments", "x-api-path-slug"=>"orderorderidshipping-fulfillment-get", "parameters"=>[{"in"=>"path", "name"=>"orderId", "description"=>"The unique identifier of the order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Order", "Order", "Shipping", "Fulfillment"]}, "post"=>{"summary"=>"Add Order Order Shipping Fulfillment", "description"=>"When you group an order's line items into one or more packages, each package requires a corresponding plan for handling, addressing, and shipping; this is a shipping fulfillment. For each package, execute this call once to generate a shipping fulfillment associated with that package. Note: A single line item in an order can consist of multiple units of a purchased item, and one unit can consist of multiple parts or components. Although these components might be provided by the manufacturer in separate packaging, the seller must include all components of a given line item in the same package.Before using this call for a given package, you must determine which line items are in the package. If the package has been shipped, you should provide the date of shipment in the request. If not provided, it will default to the current date and time.", "operationId"=>"createShippingFulfillment", "x-api-path-slug"=>"orderorderidshipping-fulfillment-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"fulfillment payload", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"orderId", "description"=>"The unique identifier of the order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Order", "Order", "Shipping", "Fulfillment"]}}, "/order/{orderId}/shipping_fulfillment/{fulfillmentId}"=>{"get"=>{"summary"=>"Get Order Order Shipping Fulfillment Fulfillment", "description"=>"Use this call to retrieve the contents of a fulfillment based on its unique identifier, fulfillmentId (combined with the associated order's orderId). The fulfillmentId value was originally generated by the createShippingFulfillment call, and is returned by the getShippingFulfillments call in the members.fulfillmentId field.", "operationId"=>"getShippingFulfillment", "x-api-path-slug"=>"orderorderidshipping-fulfillmentfulfillmentid-get", "parameters"=>[{"in"=>"path", "name"=>"fulfillmentId", "description"=>"The unique identifier of the fulfillment"}, {"in"=>"path", "name"=>"orderId", "description"=>"The unique identifier of the order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auctions", "Order", "Order", "Shipping", "Fulfillment", "Fulfillment"]}}}}, "ebay-finding-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"eBay", "x-complete"=>1, "info"=>{"title"=>"EBay Finding API", "description"=>"search-ebay-build-search-and-browse-experiences-", "version"=>"1.0.0"}, "host"=>"svcs.ebay.com", "basePath"=>"/services/search/FindingService/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"?OPERATION-NAME=findItemsByKeywords"=>{"get"=>{"summary"=>"Find Item By Keywords", "description"=>"This call searches for items on eBay by a keyword query (keywords).", "operationId"=>"findItemsByKeywords", "x-api-path-slug"=>"operationnamefinditemsbykeywords-get", "parameters"=>[{"in"=>"query", "name"=>"keywords", "description"=>"The key word or phrase to search by", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"RESPONSE-DATA-FORMAT", "description"=>"Response in either XML or JSON", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"SERVICE-VERSION", "description"=>"The service version", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Products", "Auction", "Commerce"]}}, "?OPERATION-NAME=findItemsByCategory"=>{"get"=>{"summary"=>"Find Item By Category", "description"=>"Returns items in a specific category. Results can be filtered and sorted.", "operationId"=>"findItemsByCategory", "x-api-path-slug"=>"operationnamefinditemsbycategory-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId", "description"=>"The ebay category id", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"RESPONSE-DATA-FORMAT", "description"=>"Response in either XML or JSON", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"SERVICE-VERSION", "description"=>"The service version", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Products", "Auction", "Commerce", "Categories"]}}, "?OPERATION-NAME=findItemsAdvanced"=>{"get"=>{"summary"=>"Find Item By Advanced", "description"=>"Finds items by a keyword query and/or category and allows searching within item descriptions.", "operationId"=>"findItemsAdvanced", "x-api-path-slug"=>"operationnamefinditemsadvanced-get", "parameters"=>[{"in"=>"query", "name"=>"keywords", "description"=>"The keywords or phrase to search", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"RESPONSE-DATA-FORMAT", "description"=>"Response in either XML or JSON", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"SERVICE-VERSION", "description"=>"The service version", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Products", "Auction", "Commerce", "Categories"]}}}}, "apis"=>{"name"=>"eBay", "x-slug"=>"ebay", "description"=>"Buy and sell electronics, cars, fashion apparel, collectibles, sporting goods, digital cameras, baby items, coupons, and everything else on eBay, the worlds online marketplace", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/138-ebay.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"42", "tags"=>"API Provider,Auctions,Commerce,General Data,Historical Data API,internet,Marketplace,Pedestal,Profiles,Relative Data,Service API,Stack,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"ebay/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Ebay", "x-api-slug"=>"ebay", "description"=>"Buy and sell electronics, cars, fashion apparel, collectibles, sporting goods, digital cameras, baby items, coupons, and everything else on eBay, the worlds online marketplace", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/138-ebay.jpg", "humanURL"=>"https://ebay.com", "baseURL"=>"https://api.ebay.com//", "tags"=>"API Provider,Auctions,Commerce,General Data,Historical Data API,internet,Marketplace,Pedestal,Profiles,Relative Data,Service API,Stack,Streams,Streams,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/ebay/orderorderidshipping-fulfillmentfulfillmentid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/ebay/ebay-openapi.yaml"}]}, {"name"=>"Ebay Finding API", "x-api-slug"=>"ebay-finding-api", "description"=>"Buy and sell electronics, cars, fashion apparel, collectibles, sporting goods, digital cameras, baby items, coupons, and everything else on eBay, the worlds online marketplace", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/138-ebay.jpg", "humanURL"=>"https://ebay.com", "baseURL"=>"https://svcs.ebay.com//services/search/FindingService/v1", "tags"=>"Auctions,Order, Order, Shipping, Fulfillment, Fulfillment", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/ebay/operationnamefinditemsadvanced-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/ebay/ebay-finding-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://go.developer.ebay.com/dev-program-blog"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/ebay"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/leah"}, {"type"=>"x-developer", "url"=>"https://go.developer.ebay.com/"}, {"type"=>"x-email", "url"=>"spam@ebay.com"}, {"type"=>"x-email", "url"=>"spoof@ebay.com"}, {"type"=>"x-github", "url"=>"https://github.com/eBayDeveloper"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/eBay"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/ebaydev"}, {"type"=>"x-website", "url"=>"https://ebay.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-inspector{"apis"=>{"name"=>"AWS Inspector", "x-slug"=>"aws-inspector", "description"=>"Amazon Inspector is an automated security assessment service that helps improve the security and compliance of applications deployed on AWS. Amazon Inspector automatically assesses applications for vulnerabilities or deviations from best practices. After performing an assessment, Amazon Inspector produces a detailed list of security findings prioritized by level of severity.To help you get started quickly, Amazon Inspector includes a knowledge base of hundreds of rules mapped to common security best practices and vulnerability definitions. Examples of built-in rules include checking for remote root login being enabled, or vulnerable software versions installed. These rules are regularly updated by AWS security researchers.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Security-Identity_AmazonInspector.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Profiles,Relative Data,Security,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-inspector/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Inspector API", "x-api-slug"=>"aws-inspector-api", "description"=>"Amazon Inspector is an automated security assessment service that helps improve the security and compliance of applications deployed on AWS. Amazon Inspector automatically assesses applications for vulnerabilities or deviations from best practices. After performing an assessment, Amazon Inspector produces a detailed list of security findings prioritized by level of severity.To help you get started quickly, Amazon Inspector includes a knowledge base of hundreds of rules mapped to common security best practices and vulnerability definitions. Examples of built-in rules include checking for remote root login being enabled, or vulnerable software versions installed. These rules are regularly updated by AWS security researchers.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Security-Identity_AmazonInspector.png", "humanURL"=>"https://aws.amazon.com/inspector/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Profiles,Relative Data,Security,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-inspector/aws-inspector-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/inspector/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/inspector/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://docs.aws.amazon.com/inspector/latest/userguide/inspector_quickstart.html"}, {"type"=>"x-partners", "url"=>"https://aws.amazon.com/inspector/partners/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/inspector/pricing/"}, {"type"=>"x-testimonials", "url"=>"https://aws.amazon.com/inspector/customers/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/inspector/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "aws-inspector-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Inspector", "x-complete"=>1, "info"=>{"title"=>"AWS Inspector API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddAttributesToFindings"=>{"get"=>{"summary"=>"Add Attributes To Findings", "description"=>"Assigns attributes (key and value pairs) to the findings that are specified by the\n ARNs of the findings.", "operationId"=>"addAttributesToFindings", "x-api-path-slug"=>"actionaddattributestofindings-get", "parameters"=>[{"in"=>"query", "name"=>"attributes", "description"=>"The array of attributes that you want to assign to specified findings", "type"=>"string"}, {"in"=>"query", "name"=>"findingArns", "description"=>"The ARNs that specify the findings that you want to assign attributes to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attributes To Findings"]}}, "/?Action=CreateAssessmentTarget"=>{"get"=>{"summary"=>"Create Assessment Target", "description"=>"Creates a new assessment target using the ARN of the resource group that is generated\n by.", "operationId"=>"createAssessmentTarget", "x-api-path-slug"=>"actioncreateassessmenttarget-get", "parameters"=>[{"in"=>"query", "name"=>"assessmentTargetName", "description"=>"The user-defined name that identifies the assessment target that you want to create", "type"=>"string"}, {"in"=>"query", "name"=>"resourceGroupArn", "description"=>"The ARN that specifies the resource group that is used to create the assessment target", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assessment Targets"]}}, "/?Action=CreateAssessmentTemplate"=>{"get"=>{"summary"=>"Create Assessment Template", "description"=>"Creates an assessment template for the assessment target that is specified by the ARN\n of the assessment target.", "operationId"=>"createAssessmentTemplate", "x-api-path-slug"=>"actioncreateassessmenttemplate-get", "parameters"=>[{"in"=>"query", "name"=>"assessmentTargetArn", "description"=>"The ARN that specifies the assessment target for which you want to create the assessment template", "type"=>"string"}, {"in"=>"query", "name"=>"assessmentTemplateName", "description"=>"The user-defined name that identifies the assessment template that you want to create", "type"=>"string"}, {"in"=>"query", "name"=>"durationInSeconds", "description"=>"The duration of the assessment run in seconds", "type"=>"string"}, {"in"=>"query", "name"=>"rulesPackageArns", "description"=>"The ARNs that specify the rules packages that you want to attach to the assessment template", "type"=>"string"}, {"in"=>"query", "name"=>"userAttributesForFindings", "description"=>"The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assessment Templates"]}}, "/?Action=CreateResourceGroup"=>{"get"=>{"summary"=>"Create Resource Group", "description"=>"Creates a resource group using the specified set of tags (key and value pairs) that\n are used to select the EC2 instances to be included in an Amazon Inspector assessment\n target.", "operationId"=>"createResourceGroup", "x-api-path-slug"=>"actioncreateresourcegroup-get", "parameters"=>[{"in"=>"query", "name"=>"resourceGroupTags", "description"=>"A collection of keys and an array of possible values, [{key:key1,values:[Value1,Value2]},{key:Key2,values:[Value3]}]", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Groups"]}}, "/?Action=DeleteAssessmentRun"=>{"get"=>{"summary"=>"Delete Assessment Run", "description"=>"Deletes the assessment run that is specified by the ARN of the assessment\n run.", "operationId"=>"deleteAssessmentRun", "x-api-path-slug"=>"actiondeleteassessmentrun-get", "parameters"=>[{"in"=>"query", "name"=>"assessmentRunArn", "description"=>"The ARN that specifies the assessment run that you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assessment Runs"]}}, "/?Action=DeleteAssessmentTarget"=>{"get"=>{"summary"=>"Delete Assessment Target", "description"=>"Deletes the assessment target that is specified by the ARN of the assessment\n target.", "operationId"=>"deleteAssessmentTarget", "x-api-path-slug"=>"actiondeleteassessmenttarget-get", "parameters"=>[{"in"=>"query", "name"=>"assessmentTargetArn", "description"=>"The ARN that specifies the assessment target that you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assessment Targets"]}}, "/?Action=DeleteAssessmentTemplate"=>{"get"=>{"summary"=>"Delete Assessment Template", "description"=>"Deletes the assessment template that is specified by the ARN of the assessment\n template.", "operationId"=>"deleteAssessmentTemplate", "x-api-path-slug"=>"actiondeleteassessmenttemplate-get", "parameters"=>[{"in"=>"query", "name"=>"assessmentTemplateArn", "description"=>"The ARN that specifies the assessment template that you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assessment Templates"]}}, "/?Action=DescribeAssessmentRuns"=>{"get"=>{"summary"=>"Describe Assessment Runs", "description"=>"Describes the assessment runs that are specified by the ARNs of the assessment\n runs.", "operationId"=>"describeAssessmentRuns", "x-api-path-slug"=>"actiondescribeassessmentruns-get", "parameters"=>[{"in"=>"query", "name"=>"assessmentRunArns", "description"=>"The ARN that specifies the assessment run that you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assessment Runs"]}}, "/?Action=DescribeAssessmentTargets"=>{"get"=>{"summary"=>"Describe Assessment Targets", "description"=>"Describes the assessment targets that are specified by the ARNs of the assessment\n targets.", "operationId"=>"describeAssessmentTargets", "x-api-path-slug"=>"actiondescribeassessmenttargets-get", "parameters"=>[{"in"=>"query", "name"=>"assessmentTargetArns", "description"=>"The ARNs that specifies the assessment targets that you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assessment Targets"]}}, "/?Action=DescribeAssessmentTemplates"=>{"get"=>{"summary"=>"Describe Assessment Templates", "description"=>"Describes the assessment templates that are specified by the ARNs of the assessment\n templates.", "operationId"=>"describeAssessmentTemplates", "x-api-path-slug"=>"actiondescribeassessmenttemplates-get", "parameters"=>[{"in"=>"query", "name"=>"assessmentTemplateArns", "description"=>"Type: array of Strings", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assessment Templates"]}}, "/?Action=DescribeCrossAccountAccessRole"=>{"get"=>{"summary"=>"Describe Cross Account Access Role", "description"=>"Describes the IAM role that enables Amazon Inspector to access your AWS\n account.", "operationId"=>"describeCrossAccountAccessRole", "x-api-path-slug"=>"actiondescribecrossaccountaccessrole-get", "parameters"=>[{"in"=>"query", "name"=>"registeredAt", "description"=>"The date when the cross-account access role was registered", "type"=>"string"}, {"in"=>"query", "name"=>"roleArn", "description"=>"The ARN that specifies the IAM role that Amazon Inspector uses to access your AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"valid", "description"=>"A Boolean value that specifies whether the IAM role has the necessary policies attached to enable Amazon Inspector to access your AWS account", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cross Account Access Roles"]}}, "/?Action=DescribeFindings"=>{"get"=>{"summary"=>"Describe Findings", "description"=>"Describes the findings that are specified by the ARNs of the findings.", "operationId"=>"describeFindings", "x-api-path-slug"=>"actiondescribefindings-get", "parameters"=>[{"in"=>"query", "name"=>"findingArns", "description"=>"The ARN that specifies the finding that you want to describe", "type"=>"string"}, {"in"=>"query", "name"=>"locale", "description"=>"The locale into which you want to translate a finding description, recommendation, and the short description that identifies the finding", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Findings"]}}, "/?Action=DescribeResourceGroups"=>{"get"=>{"summary"=>"Describe Resource Groups", "description"=>"Describes the resource groups that are specified by the ARNs of the resource\n groups.", "operationId"=>"describeResourceGroups", "x-api-path-slug"=>"actiondescriberesourcegroups-get", "parameters"=>[{"in"=>"query", "name"=>"resourceGroupArns", "description"=>"The ARN that specifies the resource group that you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Groups"]}}, "/?Action=DescribeRulesPackages"=>{"get"=>{"summary"=>"Describe Rules Packages", "description"=>"Describes the rules packages that are specified by the ARNs of the rules\n packages.", "operationId"=>"describeRulesPackages", "x-api-path-slug"=>"actiondescriberulespackages-get", "parameters"=>[{"in"=>"query", "name"=>"locale", "description"=>"The locale that you want to translate a rules package description into", "type"=>"string"}, {"in"=>"query", "name"=>"rulesPackageArns", "description"=>"The ARN that specifies the rules package that you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rules Packages"]}}, "/?Action=GetTelemetryMetadata"=>{"get"=>{"summary"=>"Get Telemetry Metadata", "description"=>"Information about the data that is collected for the specified assessment\n run.", "operationId"=>"getTelemetryMetadata", "x-api-path-slug"=>"actiongettelemetrymetadata-get", "parameters"=>[{"in"=>"query", "name"=>"assessmentRunArn", "description"=>"The ARN that specifies the assessment run that has the telemetry data that you want to obtain", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Telemetry Metadata"]}}, "/?Action=ListAssessmentRunAgents"=>{"get"=>{"summary"=>"List Assessment Run Agents", "description"=>"Lists the agents of the assessment runs that are specified by the ARNs of the\n assessment runs.", "operationId"=>"listAssessmentRunAgents", "x-api-path-slug"=>"actionlistassessmentrunagents-get", "parameters"=>[{"in"=>"query", "name"=>"assessmentRunArn", "description"=>"The ARN that specifies the assessment run whose agents you want to list", "type"=>"string"}, {"in"=>"query", "name"=>"filter", "description"=>"You can use this parameter to specify a subset of data to be included in the actions response", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"You can use this parameter to indicate the maximum number of items that you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"You can use this parameter when paginating results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assessment Run Agents"]}}, "/?Action=ListAssessmentRuns"=>{"get"=>{"summary"=>"List Assessment Runs", "description"=>"Lists the assessment runs that correspond to the assessment templates that are\n specified by the ARNs of the assessment templates.", "operationId"=>"listAssessmentRuns", "x-api-path-slug"=>"actionlistassessmentruns-get", "parameters"=>[{"in"=>"query", "name"=>"assessmentTemplateArns", "description"=>"The ARNs that specify the assessment templates whose assessment runs you want to list", "type"=>"string"}, {"in"=>"query", "name"=>"filter", "description"=>"You can use this parameter to specify a subset of data to be included in the actions response", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"You can use this parameter to indicate the maximum number of items that you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"You can use this parameter when paginating results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assessment Runs"]}}, "/?Action=ListAssessmentTargets"=>{"get"=>{"summary"=>"List Assessment Targets", "description"=>"Lists the ARNs of the assessment targets within this AWS account.", "operationId"=>"listAssessmentTargets", "x-api-path-slug"=>"actionlistassessmenttargets-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"You can use this parameter to specify a subset of data to be included in the actions response", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"You can use this parameter to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"You can use this parameter when paginating results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assessment Targets"]}}, "/?Action=ListAssessmentTemplates"=>{"get"=>{"summary"=>"List Assessment Templates", "description"=>"Lists the assessment templates that correspond to the assessment targets that are\n specified by the ARNs of the assessment targets.", "operationId"=>"listAssessmentTemplates", "x-api-path-slug"=>"actionlistassessmenttemplates-get", "parameters"=>[{"in"=>"query", "name"=>"assessmentTargetArns", "description"=>"A list of ARNs that specifies the assessment targets whose assessment templates you want to list", "type"=>"string"}, {"in"=>"query", "name"=>"filter", "description"=>"You can use this parameter to specify a subset of data to be included in the actions response", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"You can use this parameter to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"You can use this parameter when paginating results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assessment Templates"]}}, "/?Action=ListEventSubscriptions"=>{"get"=>{"summary"=>"List Event Subscriptions", "description"=>"Lists all the event subscriptions for the assessment template that is specified by\n the ARN of the assessment template.", "operationId"=>"listEventSubscriptions", "x-api-path-slug"=>"actionlisteventsubscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"You can use this parameter to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"You can use this parameter when paginating results", "type"=>"string"}, {"in"=>"query", "name"=>"resourceArn", "description"=>"The ARN of the assessment template for which you want to list the existing event subscriptions", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Subscriptions"]}}, "/?Action=ListFindings"=>{"get"=>{"summary"=>"List Findings", "description"=>"Lists findings that are generated by the assessment runs that are specified by the\n ARNs of the assessment runs.", "operationId"=>"listFindings", "x-api-path-slug"=>"actionlistfindings-get", "parameters"=>[{"in"=>"query", "name"=>"assessmentRunArns", "description"=>"The ARNs of the assessment runs that generate the findings that you want to list", "type"=>"string"}, {"in"=>"query", "name"=>"filter", "description"=>"You can use this parameter to specify a subset of data to be included in the actions response", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"You can use this parameter to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"You can use this parameter when paginating results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Findings"]}}, "/?Action=ListRulesPackages"=>{"get"=>{"summary"=>"List Rules Packages", "description"=>"Lists all available Amazon Inspector rules packages.", "operationId"=>"listRulesPackages", "x-api-path-slug"=>"actionlistrulespackages-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"You can use this parameter to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"You can use this parameter when paginating results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rules Packages"]}}, "/?Action=ListTagsForResource"=>{"get"=>{"summary"=>"List Tags For Resource", "description"=>"Lists all tags associated with an assessment template.", "operationId"=>"listTagsForResource", "x-api-path-slug"=>"actionlisttagsforresource-get", "parameters"=>[{"in"=>"query", "name"=>"resourceArn", "description"=>"The ARN that specifies the assessment template whose tags you want to list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags For Resources"]}}, "/?Action=PreviewAgents"=>{"get"=>{"summary"=>"Preview Agents", "description"=>"Previews the agents installed on the EC2 instances that are part of the specified\n assessment target.", "operationId"=>"previewAgents", "x-api-path-slug"=>"actionpreviewagents-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"You can use this parameter to indicate the maximum number of items you want in the response", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"You can use this parameter when paginating results", "type"=>"string"}, {"in"=>"query", "name"=>"previewAgentsArn", "description"=>"The ARN of the assessment target whose agents you want to preview", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agents"]}}, "/?Action=RegisterCrossAccountAccessRole"=>{"get"=>{"summary"=>"Register Cross Account Access Role", "description"=>"Registers the IAM role that Amazon Inspector uses to list your EC2 instances at the\n start of the assessment run or when you call the.", "operationId"=>"registerCrossAccountAccessRole", "x-api-path-slug"=>"actionregistercrossaccountaccessrole-get", "parameters"=>[{"in"=>"query", "name"=>"roleArn", "description"=>"The ARN of the IAM role that Amazon Inspector uses to list your EC2 instances during the assessment run or when you call the PreviewAgents action", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cross Account Access Roles"]}}, "/?Action=RemoveAttributesFromFindings"=>{"get"=>{"summary"=>"Remove Attributes From Findings", "description"=>"Removes entire attributes (key and value pairs) from the findings that are specified\n by the ARNs of the findings where an attribute with the specified key exists.", "operationId"=>"removeAttributesFromFindings", "x-api-path-slug"=>"actionremoveattributesfromfindings-get", "parameters"=>[{"in"=>"query", "name"=>"attributeKeys", "description"=>"The array of attribute keys that you want to remove from specified findings", "type"=>"string"}, {"in"=>"query", "name"=>"findingArns", "description"=>"The ARNs that specify the findings that you want to remove attributes from", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attributes From Findings"]}}, "/?Action=SetTagsForResource"=>{"get"=>{"summary"=>"Set Tags For Resource", "description"=>"Sets tags (key and value pairs) to the assessment template that is specified by the\n ARN of the assessment template.", "operationId"=>"setTagsForResource", "x-api-path-slug"=>"actionsettagsforresource-get", "parameters"=>[{"in"=>"query", "name"=>"resourceArn", "description"=>"The ARN of the assessment template that you want to set tags to", "type"=>"string"}, {"in"=>"query", "name"=>"tags", "description"=>"A collection of key and value pairs that you want to set to the assessment template", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags For Resources"]}}, "/?Action=StartAssessmentRun"=>{"get"=>{"summary"=>"Start Assessment Run", "description"=>"Starts the assessment run specified by the ARN of the assessment template.", "operationId"=>"startAssessmentRun", "x-api-path-slug"=>"actionstartassessmentrun-get", "parameters"=>[{"in"=>"query", "name"=>"assessmentRunName", "description"=>"You can specify the name for the assessment run", "type"=>"string"}, {"in"=>"query", "name"=>"assessmentTemplateArn", "description"=>"The ARN of the assessment template of the assessment run that you want to start", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assessment Runs"]}}, "/?Action=StopAssessmentRun"=>{"get"=>{"summary"=>"Stop Assessment Run", "description"=>"Stops the assessment run that is specified by the ARN of the assessment\n run.", "operationId"=>"stopAssessmentRun", "x-api-path-slug"=>"actionstopassessmentrun-get", "parameters"=>[{"in"=>"query", "name"=>"assessmentRunArn", "description"=>"The ARN of the assessment run that you want to stop", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assessment Runs"]}}, "/?Action=SubscribeToEvent"=>{"get"=>{"summary"=>"Subscribe To Event", "description"=>"Enables the process of sending Amazon Simple Notification Service (SNS) notifications\n about a specified event to a specified SNS topic.", "operationId"=>"subscribeToEvent", "x-api-path-slug"=>"actionsubscribetoevent-get", "parameters"=>[{"in"=>"query", "name"=>"event", "description"=>"The event for which you want to receive SNS notifications", "type"=>"string"}, {"in"=>"query", "name"=>"resourceArn", "description"=>"The ARN of the assessment template that is used during the event for which you want to receive SNS notifications", "type"=>"string"}, {"in"=>"query", "name"=>"topicArn", "description"=>"The ARN of the SNS topic to which the SNS notifications are sent", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Subscriptions"]}}, "/?Action=UnsubscribeFromEvent"=>{"get"=>{"summary"=>"Unsubscribe From Event", "description"=>"Disables the process of sending Amazon Simple Notification Service (SNS)\n notifications about a specified event to a specified SNS topic.", "operationId"=>"unsubscribeFromEvent", "x-api-path-slug"=>"actionunsubscribefromevent-get", "parameters"=>[{"in"=>"query", "name"=>"event", "description"=>"The event for which you want to stop receiving SNS notifications", "type"=>"string"}, {"in"=>"query", "name"=>"resourceArn", "description"=>"The ARN of the assessment template that is used during the event for which you want to stop receiving SNS notifications", "type"=>"string"}, {"in"=>"query", "name"=>"topicArn", "description"=>"The ARN of the SNS topic to which SNS notifications are sent", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Subscriptions"]}}, "/?Action=UpdateAssessmentTarget"=>{"get"=>{"summary"=>"Update Assessment Target", "description"=>"Updates the assessment target that is specified by the ARN of the assessment\n target.", "operationId"=>"updateAssessmentTarget", "x-api-path-slug"=>"actionupdateassessmenttarget-get", "parameters"=>[{"in"=>"query", "name"=>"assessmentTargetArn", "description"=>"The ARN of the assessment target that you want to update", "type"=>"string"}, {"in"=>"query", "name"=>"assessmentTargetName", "description"=>"The name of the assessment target that you want to update", "type"=>"string"}, {"in"=>"query", "name"=>"resourceGroupArn", "description"=>"The ARN of the resource group that is used to specify the new resource group to associate with the assessment target", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assessment Targets"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-cloudwatch{"amazon-cloudwatch-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS CloudWatch", "x-complete"=>1, "info"=>{"title"=>"AWS CloudWatch API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=DeleteAlarms"=>{""=>{"summary"=>"Delete Alarms", "description"=>"Deletes the specified alarms.", "operationId"=>"deletealarms", "x-api-path-slug"=>"actiondeletealarms-", "parameters"=>[{"in"=>"query", "name"=>"AlarmNames.member.N", "description"=>"The alarms to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarms"]}}, "/?Action=DescribeAlarmHistory"=>{""=>{"summary"=>"Describe Alarm History", "description"=>"Retrieves the history for the specified alarm.", "operationId"=>"describealarmhistory", "x-api-path-slug"=>"actiondescribealarmhistory-", "parameters"=>[{"in"=>"query", "name"=>"AlarmName", "description"=>"The name of the alarm", "type"=>"string"}, {"in"=>"query", "name"=>"EndDate", "description"=>"The ending date to retrieve alarm history", "type"=>"string"}, {"in"=>"query", "name"=>"HistoryItemType", "description"=>"The type of alarm histories to retrieve", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of alarm history records to retrieve", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token returned by a previous call to indicate that there is more dataavailable", "type"=>"string"}, {"in"=>"query", "name"=>"StartDate", "description"=>"The starting date to retrieve alarm history", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarm History"]}}, "/?Action=DescribeAlarms"=>{""=>{"summary"=>"Describe Alarms", "description"=>"Retrieves the specified alarms.", "operationId"=>"describealarms", "x-api-path-slug"=>"actiondescribealarms-", "parameters"=>[{"in"=>"query", "name"=>"ActionPrefix", "description"=>"The action name prefix", "type"=>"string"}, {"in"=>"query", "name"=>"AlarmNamePrefix", "description"=>"The alarm name prefix", "type"=>"string"}, {"in"=>"query", "name"=>"AlarmNames.member.N", "description"=>"The names of the alarms", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of alarm descriptions to retrieve", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token returned by a previous call to indicate that there is more dataavailable", "type"=>"string"}, {"in"=>"query", "name"=>"StateValue", "description"=>"The state value to be used in matching alarms", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarms"]}}, "/?Action=DescribeAlarmsForMetric"=>{""=>{"summary"=>"Describe Alarms For Metric", "description"=>"Retrieves the alarms for the specified metric.", "operationId"=>"describealarmsformetric", "x-api-path-slug"=>"actiondescribealarmsformetric-", "parameters"=>[{"in"=>"query", "name"=>"Dimensions.member.N", "description"=>"The dimensions associated with the metric", "type"=>"string"}, {"in"=>"query", "name"=>"ExtendedStatistic", "description"=>"The percentile statistic for the metric", "type"=>"string"}, {"in"=>"query", "name"=>"MetricName", "description"=>"The name of the metric", "type"=>"string"}, {"in"=>"query", "name"=>"Namespace", "description"=>"The namespace of the metric", "type"=>"string"}, {"in"=>"query", "name"=>"Period", "description"=>"The period, in seconds, over which the statistic is applied", "type"=>"string"}, {"in"=>"query", "name"=>"Statistic", "description"=>"The statistic for the metric, other than percentiles", "type"=>"string"}, {"in"=>"query", "name"=>"Unit", "description"=>"The unit for the metric", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarm Metrics"]}}, "/?Action=DisableAlarmActions"=>{""=>{"summary"=>"Disable Alarm Actions", "description"=>"Disables the actions for the specified alarms.", "operationId"=>"disablealarmactions", "x-api-path-slug"=>"actiondisablealarmactions-", "parameters"=>[{"in"=>"query", "name"=>"AlarmNames.member.N", "description"=>"The names of the alarms", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarm Actions"]}}, "/?Action=EnableAlarmActions"=>{""=>{"summary"=>"Enable Alarm Actions", "description"=>"Enables the actions for the specified alarms.", "operationId"=>"enablealarmactions", "x-api-path-slug"=>"actionenablealarmactions-", "parameters"=>[{"in"=>"query", "name"=>"AlarmNames.member.N", "description"=>"The names of the alarms", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarm Actions"]}}, "/?Action=GetMetricStatistics"=>{""=>{"summary"=>"Get Metric Statistics", "description"=>"Gets statistics for the specified metric.", "operationId"=>"getmetricstatistics", "x-api-path-slug"=>"actiongetmetricstatistics-", "parameters"=>[{"in"=>"query", "name"=>"Dimensions.member.N", "description"=>"The dimensions", "type"=>"string"}, {"in"=>"query", "name"=>"EndTime", "description"=>"The time stamp that determines the last data point to return", "type"=>"string"}, {"in"=>"query", "name"=>"ExtendedStatistics.member.N", "description"=>"The percentile statistics", "type"=>"string"}, {"in"=>"query", "name"=>"MetricName", "description"=>"The name of the metric, with or without spaces", "type"=>"string"}, {"in"=>"query", "name"=>"Namespace", "description"=>"The namespace of the metric, with or without spaces", "type"=>"string"}, {"in"=>"query", "name"=>"Period", "description"=>"The granularity, in seconds, of the returned data points", "type"=>"string"}, {"in"=>"query", "name"=>"StartTime", "description"=>"The time stamp that determines the first data point to return", "type"=>"string"}, {"in"=>"query", "name"=>"Statistics.member.N", "description"=>"The metric statistics, other than percentile", "type"=>"string"}, {"in"=>"query", "name"=>"Unit", "description"=>"The unit for a given metric", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metric Statistics"]}}, "/?Action=ListMetrics"=>{""=>{"summary"=>"List Metrics", "description"=>"List the specified metrics.", "operationId"=>"listmetrics", "x-api-path-slug"=>"actionlistmetrics-", "parameters"=>[{"in"=>"query", "name"=>"Dimensions.member.N", "description"=>"The dimensions to filter against", "type"=>"string"}, {"in"=>"query", "name"=>"MetricName", "description"=>"The name of the metric to filter against", "type"=>"string"}, {"in"=>"query", "name"=>"Namespace", "description"=>"The namespace to filter against", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token returned by a previous call to indicate that there is more dataavailable", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}}, "/?Action=PutMetricAlarm"=>{""=>{"summary"=>"Put Metric Alarm", "description"=>"Creates or updates an alarm and associates it with the specified metric.", "operationId"=>"putmetricalarm", "x-api-path-slug"=>"actionputmetricalarm-", "parameters"=>[{"in"=>"query", "name"=>"ActionsEnabled", "description"=>"Indicates whether actions should be executed during any changes to the alarm state", "type"=>"string"}, {"in"=>"query", "name"=>"AlarmActions.member.N", "description"=>"The actions to execute when this alarm transitions to the ALARM state from any other state", "type"=>"string"}, {"in"=>"query", "name"=>"AlarmDescription", "description"=>"The description for the alarm", "type"=>"string"}, {"in"=>"query", "name"=>"AlarmName", "description"=>"The name for the alarm", "type"=>"string"}, {"in"=>"query", "name"=>"ComparisonOperator", "description"=>"The arithmetic operation to use when comparing the specified statistic andthreshold", "type"=>"string"}, {"in"=>"query", "name"=>"Dimensions.member.N", "description"=>"The dimensions for the metric associated with the alarm", "type"=>"string"}, {"in"=>"query", "name"=>"EvaluationPeriods", "description"=>"The number of periods over which data is compared to the specifiedthreshold", "type"=>"string"}, {"in"=>"query", "name"=>"ExtendedStatistic", "description"=>"The percentile statistic for the metric associated with the alarm", "type"=>"string"}, {"in"=>"query", "name"=>"InsufficientDataActions.member.N", "description"=>"The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state", "type"=>"string"}, {"in"=>"query", "name"=>"MetricName", "description"=>"The name for the metric associated with the alarm", "type"=>"string"}, {"in"=>"query", "name"=>"Namespace", "description"=>"The namespace for the metric associated with the alarm", "type"=>"string"}, {"in"=>"query", "name"=>"OKActions.member.N", "description"=>"The actions to execute when this alarm transitions to an OK statefrom any other state", "type"=>"string"}, {"in"=>"query", "name"=>"Period", "description"=>"The period, in seconds, over which the specified statistic is applied", "type"=>"string"}, {"in"=>"query", "name"=>"Statistic", "description"=>"The statistic for the metric associated with the alarm, other than percentile", "type"=>"string"}, {"in"=>"query", "name"=>"Threshold", "description"=>"The value against which the specified statistic is compared", "type"=>"string"}, {"in"=>"query", "name"=>"Unit", "description"=>"The unit of measure for the statistic", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarm Metric"]}}, "/?Action=PutMetricData"=>{""=>{"summary"=>"Put Metric Data", "description"=>"Publishes metric data points to Amazon CloudWatch.", "operationId"=>"putmetricdata", "x-api-path-slug"=>"actionputmetricdata-", "parameters"=>[{"in"=>"query", "name"=>"MetricData.member.N", "description"=>"The data for the metric", "type"=>"string"}, {"in"=>"query", "name"=>"Namespace", "description"=>"The namespace for the metric data", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data Metric"]}}, "/?Action=SetAlarmState"=>{""=>{"summary"=>"Set Alarm State", "description"=>"Temporarily sets the state of an alarm for testing purposes.", "operationId"=>"setalarmstate", "x-api-path-slug"=>"actionsetalarmstate-", "parameters"=>[{"in"=>"query", "name"=>"AlarmName", "description"=>"The name for the alarm", "type"=>"string"}, {"in"=>"query", "name"=>"StateReason", "description"=>"The reason that this alarm is set to this specific state, in text format", "type"=>"string"}, {"in"=>"query", "name"=>"StateReasonData", "description"=>"The reason that this alarm is set to this specific state, in JSON format", "type"=>"string"}, {"in"=>"query", "name"=>"StateValue", "description"=>"The value of the state", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Aler State"]}}}}, "apis"=>{"name"=>"AWS CloudWatch", "x-slug"=>"aws-cloudwatch", "description"=>"Amazon CloudWatch is a monitoring service for AWS cloud resources and the applications you run on AWS. You can use Amazon CloudWatch to collect and track metrics, collect and monitor log files, set alarms, and automatically react to changes in your AWS resources. Amazon CloudWatch can monitor AWS resources such as Amazon EC2 instances, Amazon DynamoDB tables, and Amazon RDS DB instances, as well as custom metrics generated by your applications and services, and any log files your applications generate. You can use Amazon CloudWatch to gain system-wide visibility into resource utilization, application performance, and operational health. You can use these insights to react and keep your application running smoothly.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Management-Tools_AmazonCloudWatch.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,Analysis,API Provider,API Service Provider,API Service Provider,Logging,Management,Monitoring,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-cloudwatch/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Amazon CloudWatch API", "x-api-slug"=>"amazon-cloudwatch-api", "description"=>"Amazon CloudWatch is a monitoring service for AWS cloud resources and the applications you run on AWS. You can use Amazon CloudWatch to collect and track metrics, collect and monitor log files, set alarms, and automatically react to changes in your AWS resources. Amazon CloudWatch can monitor AWS resources such as Amazon EC2 instances, Amazon DynamoDB tables, and Amazon RDS DB instances, as well as custom metrics generated by your applications and services, and any log files your applications generate. You can use Amazon CloudWatch to gain system-wide visibility into resource utilization, application performance, and operational health. You can use these insights to react and keep your application running smoothly.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Management-Tools_AmazonCloudWatch.png", "humanURL"=>"https://aws.amazon.com/cloudwatch/", "baseURL"=>":///", "tags"=>"Amazon Web Services,Analysis,API Provider,API Service Provider,API Service Provider,Logging,Management,Monitoring,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-cloudwatch/actionsetalarmstate--postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-cloudwatch/amazon-cloudwatch-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-articles", "url"=>"http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=100"}, {"type"=>"x-blog", "url"=>"https://aws.amazon.com/cloudwatch/developer-resources/#BlogPosts"}, {"type"=>"x-change-log", "url"=>"http://aws.amazon.com/releasenotes/Amazon%20EC2?_encoding=UTF8&jiveRedirect=1"}, {"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/AmazonCloudWatch/latest/cli/"}, {"type"=>"x-developer", "url"=>"https://aws.amazon.com/cloudwatch/developer-resources/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/cloudwatch/faqs/"}, {"type"=>"x-forum", "url"=>"http://developer.amazonwebservices.com/connect/forum.jspa?forumID=30"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/cloudwatch/pricing/"}, {"type"=>"x-sdk", "url"=>"http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=85"}, {"type"=>"x-tools", "url"=>"http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=88"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/cloudwatch/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
uc-berkeley{"uc-berkeley-academic-terms-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"UC Berkeley", "x-complete"=>1, "info"=>{"title"=>"UC Berkeley Academic Terms API", "description"=>"this-api-uses-the-current-date-to-calculate-the-current-and-coming-years-academic-terms--for-the-current-term-resource-it-returns-the-term-code-and-term-year--for-the-next-terms-resource-it-returns-a-set-of-terms-that-each-include-a-term-title-the-combined-year-and-code-and-the-code-and-year-separately-", "version"=>"1.0.0"}, "host"=>"apis.berkeley.edu", "basePath"=>"/sisconnect", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetAcademicCalendarNextTerms"=>{"get"=>{"summary"=>"Next Academic Terms", "description"=>"Get a list of academic terms for the coming year.", "operationId"=>"getGetacademiccalendarnextterms", "x-api-path-slug"=>"getacademiccalendarnextterms-get", "parameters"=>[{"in"=>"header", "name"=>"app_id", "description"=>"App ID"}, {"in"=>"header", "name"=>"app_key", "description"=>"App Key"}], "responses"=>{1=>{"description"=>"Brand not found - Unable to find the given brand ID"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Next", "Academic", "Terms"]}}, "/GetAcademicCurrentTerm"=>{"get"=>{"summary"=>"Current Academic Term", "description"=>"Get the current academic term.", "operationId"=>"getGetacademiccurrentterm", "x-api-path-slug"=>"getacademiccurrentterm-get", "parameters"=>[{"in"=>"header", "name"=>"app_id", "description"=>"App ID"}, {"in"=>"header", "name"=>"app_key", "description"=>"App Key"}], "responses"=>{1=>{"description"=>"Brand not found - Unable to find the given brand ID"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Current", "Academic", "Term"]}}}}, "apis"=>{"name"=>"UC Berkeley", "x-slug"=>"uc-berkeley", "description"=>"Founded in 1868, the University of California, Berkeley is one of the worlds preeminent public universities, boasting a distinguished faculty (with 22 Nobel laureates to date), stellar research libraries, and more than 350 academic programs. At the he...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/270-uc-berkeley.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"906", "tags"=>"API LIfeyclessss,Berkeley,California,Education,Relative Data,Service API,Stack Network,Universities,Universities,University Leader,University Portal", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"uc-berkeley/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"UC Berkeley Academic Terms API", "x-api-slug"=>"uc-berkeley-academic-terms-api", "description"=>"This API uses the current date to calculate the current and coming years academic terms. For the current term resource it returns the term code and term year. For the next terms resource it returns a set of terms that each include a term title, the combined year and code, and the code and year separately.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/270-uc-berkeley.jpg", "humanURL"=>"https://api-central.berkeley.edu/", "baseURL"=>"https://apis.berkeley.edu//sisconnect", "tags"=>"API LIfeyclessss,Berkeley,California,Education,Relative Data,Service API,Stack Network,Universities,Universities,University Leader,University Portal", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/uc-berkeley/getacademiccurrentterm-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/uc-berkeley/uc-berkeley-academic-terms-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/university-of-california-berkeley"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/university-of-california-berkeley"}, {"type"=>"x-email", "url"=>"webmaster@berkeley.edu"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/UCBerkeley"}, {"type"=>"x-website", "url"=>"https://api-central.berkeley.edu/"}, {"type"=>"x-website", "url"=>"http://berkeley.edu"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
dyn{"dyn-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Dyn", "x-complete"=>1, "info"=>{"title"=>"Dyn", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"accounts"=>{"get"=>{"summary"=>"Retrieve email sub-accounts", "description"=>"Retrieving a list of up to 25 Email Sub-Accounts", "operationId"=>"getAccounts", "x-api-path-slug"=>"accounts-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"startindex", "description"=>"An integer to indicate the starting index of where to begin the list of sub-accounts"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Email", "Accounts"]}, "post"=>{"summary"=>"Create an Email Sub-Account (API)", "description"=>"Creating an Email Sub-Account using the API requires specific syntax for the REST API.", "operationId"=>"postAccounts", "x-api-path-slug"=>"accounts-post", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Address"}, {"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"bounceurl", "description"=>"Bounce Postback URL"}, {"in"=>"query", "name"=>"city", "description"=>"City"}, {"in"=>"query", "name"=>"companyname", "description"=>"Required"}, {"in"=>"query", "name"=>"country", "description"=>"Two-letter English abbreviation, based on the ISO 3166 standard"}, {"in"=>"query", "name"=>"generatenewapikey", "description"=>"Used to create a new API key for an existing account (1 or 0)"}, {"in"=>"query", "name"=>"password", "description"=>"Required"}, {"in"=>"query", "name"=>"phone", "description"=>"Required"}, {"in"=>"query", "name"=>"spamurl", "description"=>"Spam Postback URL"}, {"in"=>"query", "name"=>"state", "description"=>"State"}, {"in"=>"query", "name"=>"timezone", "description"=>"The timezone of the account, in [+/-]h"}, {"in"=>"query", "name"=>"tracklinks", "description"=>"Toggle click tracking (1 or 0)"}, {"in"=>"query", "name"=>"trackopens", "description"=>"Toggle open tracking (1 or 0)"}, {"in"=>"query", "name"=>"trackunsubscribes", "description"=>"Toggle automatic list-unsubscribe support (1 or 0)"}, {"in"=>"query", "name"=>"username", "description"=>"Required"}, {"in"=>"query", "name"=>"zipcode", "description"=>"Zip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Create.Email", "Accounts", "(API)"]}, "put"=>{"summary"=>"Updating an Email Sub-Account", "description"=>"Updating an Email Sub-Account", "operationId"=>"putAccounts", "x-api-path-slug"=>"accounts-put", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Address"}, {"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"bounceurl", "description"=>"Bounce Postback URL"}, {"in"=>"query", "name"=>"city", "description"=>"City"}, {"in"=>"query", "name"=>"companyname", "description"=>"Required"}, {"in"=>"query", "name"=>"country", "description"=>"Two-letter English abbreviation, based on the ISO 3166 standard"}, {"in"=>"query", "name"=>"generatenewapikey", "description"=>"Used to create a new API key for an existing account (1 or 0)"}, {"in"=>"query", "name"=>"password", "description"=>"Required"}, {"in"=>"query", "name"=>"phone", "description"=>"Required"}, {"in"=>"query", "name"=>"spamurl", "description"=>"Spam Postback URL"}, {"in"=>"query", "name"=>"state", "description"=>"State"}, {"in"=>"query", "name"=>"timezone", "description"=>"The timezone of the account, in [+/-]h"}, {"in"=>"query", "name"=>"tracklinks", "description"=>"Toggle click tracking (1 or 0)"}, {"in"=>"query", "name"=>"trackopens", "description"=>"Toggle open tracking (1 or 0)"}, {"in"=>"query", "name"=>"trackunsubscribes", "description"=>"Toggle automatic list-unsubscribe support"}, {"in"=>"query", "name"=>"unsubscribeurl", "description"=>"Unsubscribe postback URL"}, {"in"=>"query", "name"=>"username", "description"=>"Required"}, {"in"=>"query", "name"=>"zipcode", "description"=>"Zip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Updating.Email", "Accounts"]}}, "accounts/delete"=>{"post"=>{"summary"=>"Deleting an Email Sub-Account", "description"=>"Deleting an Email Sub-Account", "operationId"=>"postAccountsDelete", "x-api-path-slug"=>"accountsdelete-post", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"username", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deleting.Email", "Accounts"]}}, "opens/count"=>{"get"=>{"summary"=>"Email Open Count", "description"=>"Returns total number of opens for the specified account for the specified date range. Including a date range is highly recommended.", "operationId"=>"getOpensCount", "x-api-path-slug"=>"openscount-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"emailaddress", "description"=>"Email address of recipient for filtering"}, {"in"=>"query", "name"=>"endtime", "description"=>"Required"}, {"in"=>"query", "name"=>"sender", "description"=>"u00a0Email address of sender for filtering"}, {"in"=>"query", "name"=>"starttime", "description"=>"Required"}, {"in"=>"query", "name"=>"[X-HeaderName]", "description"=>"Name of searchable custom X-header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[".Email", "Open", "Count"]}}, "recipients/activate"=>{"post"=>{"summary"=>"Activate Recipient(s)", "description"=>"Activating a specified Recipientu2019s status", "operationId"=>"postRecipientsActivate", "x-api-path-slug"=>"recipientsactivate-post", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"emailaddress", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activate", "Recipients"]}}, "recipients/status"=>{"get"=>{"summary"=>"Retrieve Recipient(s) Status", "description"=>"Retrieve Recipient(s) Status", "operationId"=>"getRecipientsStatus", "x-api-path-slug"=>"recipientsstatus-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"emailaddress", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Recipients", "Status"]}}, "reports/bounces"=>{"get"=>{"summary"=>"Retrieve Email Bounces", "description"=>"Retrieving the Email SPAM Complaints", "operationId"=>"getReportsBounces", "x-api-path-slug"=>"reportsbounces-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"bounce_code - Indicates the code associated with the bounced Email."}, {"in"=>"query", "name"=>"bounce_code_id - The numeric code determined by the bounce processor."}, {"in"=>"query", "name"=>"bounce_rule - Indicates the rule that caused this email to bounce."}, {"in"=>"query", "name"=>"bounce_type", "description"=>"Type of bounce for filtering"}, {"in"=>"query", "name"=>"bounce_type_id - Indicates whether the bounce type is a hard or soft bounce.nValid Values:n1 - Hard Bouncen2 - Soft Bounce"}, {"in"=>"query", "name"=>"emailaddress", "description"=>"Email address of recipient for filtering"}, {"in"=>"query", "name"=>"endtime", "description"=>"Required"}, {"in"=>"query", "name"=>"noheaders", "description"=>"Determines whether or not headers are included in the response"}, {"in"=>"query", "name"=>"sender", "description"=>"Email address of sender for filtering"}, {"in"=>"query", "name"=>"sender_id", "description"=>"Identifying number of the sender"}, {"in"=>"query", "name"=>"startindex", "description"=>"Number indicating where to begin reporting results"}, {"in"=>"query", "name"=>"starttime", "description"=>"Required"}, {"in"=>"query", "name"=>"[X-HeaderName]", "description"=>"Name of searchable custom X-header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Email", "Bounces"]}}, "reports/bounces/count"=>{"get"=>{"summary"=>"Retrieve Count of Email Bounces", "description"=>"Retrieving a total count of Email bounces using the API requires specific syntax for the REST API.", "operationId"=>"getReportsBouncesCount", "x-api-path-slug"=>"reportsbouncescount-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"endtime", "description"=>"Required"}, {"in"=>"query", "name"=>"sender", "description"=>"Email address of sender for filtering"}, {"in"=>"query", "name"=>"starttime", "description"=>"Required"}, {"in"=>"query", "name"=>"[X-HeaderName]", "description"=>"Name of searchable custom X-header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Count", "of", "Email", "Bounces"]}}, "reports/clicks"=>{"get"=>{"summary"=>"Reports on Clicks", "description"=>"Returns a list of links clicked for the specified account during the specified date range. Including a date range is highly recommended.", "operationId"=>"getReportsClicks", "x-api-path-slug"=>"reportsclicks-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"emailaddress", "description"=>"Email address of recipient for filtering"}, {"in"=>"query", "name"=>"endtime", "description"=>"Required"}, {"in"=>"query", "name"=>"sender", "description"=>"Email address of sender for filtering"}, {"in"=>"query", "name"=>"startindex", "description"=>"Starting index value (optional)"}, {"in"=>"query", "name"=>"starttime", "description"=>"Required"}, {"in"=>"query", "name"=>"[X-HeaderName]", "description"=>"Name of searchable custom X-header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "Clicks"]}}, "reports/clicks/count"=>{"get"=>{"summary"=>"Retrieve Count of Email Links Clicked", "description"=>"Retrieving a total of Email links clicked", "operationId"=>"getReportsClicksCount", "x-api-path-slug"=>"reportsclickscount-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"domainu00a0", "description"=>"Domain of the recipient, such as “gmail"}, {"in"=>"query", "name"=>"emailaddress", "description"=>"Email address of recipient for filteringu0010"}, {"in"=>"query", "name"=>"endtime", "description"=>"Required"}, {"in"=>"query", "name"=>"sender", "description"=>"Email address of sender for filteringu0010"}, {"in"=>"query", "name"=>"starttime", "description"=>"Required"}, {"in"=>"query", "name"=>"[X-HeaderName]", "description"=>"Name of searchable custom X-header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Count", "of", "Email", "Links", "Clicked"]}}, "reports/clicks/count/unique"=>{"get"=>{"summary"=>"Retrieve Count of Email Links Clicked", "description"=>"Retrieving a total of Email links clicked", "operationId"=>"getReportsClicksCountUnique", "x-api-path-slug"=>"reportsclickscountunique-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"domainu00a0", "description"=>"Domain of the recipient, such as “gmail"}, {"in"=>"query", "name"=>"emailaddress", "description"=>"Email address of recipient for filteringu0010"}, {"in"=>"query", "name"=>"endtime", "description"=>"Required"}, {"in"=>"query", "name"=>"sender", "description"=>"Email address of sender for filteringu0010"}, {"in"=>"query", "name"=>"starttime", "description"=>"Required"}, {"in"=>"query", "name"=>"[X-HeaderName]", "description"=>"Name of searchable custom X-header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Count", "of", "Email", "Links", "Clicked"]}}, "reports/clicks/unique"=>{"get"=>{"summary"=>"Unique Click Report", "description"=>"Returns a list of unique links clicked for the specified account during the specified date range. Including a date range is highly recommended.", "operationId"=>"getReportsClicksUnique", "x-api-path-slug"=>"reportsclicksunique-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"emailaddress", "description"=>"Email address of recipient for filtering"}, {"in"=>"query", "name"=>"endtime", "description"=>"Required"}, {"in"=>"query", "name"=>"sender", "description"=>"Email address of sender for filtering"}, {"in"=>"query", "name"=>"startindex", "description"=>"Starting index value (optional)"}, {"in"=>"query", "name"=>"starttime", "description"=>"Required"}, {"in"=>"query", "name"=>"[X-HeaderName]", "description"=>"Name of searchable custom X-header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unique", "Click", "Report"]}}, "reports/complaints"=>{"get"=>{"summary"=>"Retrieve Email SPAM Complaints", "description"=>"Retrieve Email SPAM Complaints", "operationId"=>"getReportsComplaints", "x-api-path-slug"=>"reportscomplaints-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"endtime", "description"=>"Required"}, {"in"=>"query", "name"=>"sender", "description"=>"Email address of sender for filtering"}, {"in"=>"query", "name"=>"startindex", "description"=>"Number indicating where to begin reporting results"}, {"in"=>"query", "name"=>"starttime", "description"=>"Required"}, {"in"=>"query", "name"=>"[X-HeaderName]", "description"=>"Name of searchable custom X-header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Email", "SPAM", "Complaints"]}}, "reports/complaints/count"=>{"get"=>{"summary"=>"Retrieve Count of Email SPAM Complaints", "description"=>"Retrieving a total count of Email complaints", "operationId"=>"getReportsComplaintsCount", "x-api-path-slug"=>"reportscomplaintscount-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"endtime", "description"=>"Required"}, {"in"=>"query", "name"=>"starttime", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Count", "of", "Email", "SPAM", "Complaints"]}}, "reports/delivered"=>{"get"=>{"summary"=>"Retrieve Emails Delivered", "description"=>"Retrieve Emails Delivered", "operationId"=>"getReportsDelivered", "x-api-path-slug"=>"reportsdelivered-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"endtime", "description"=>"Required"}, {"in"=>"query", "name"=>"sender", "description"=>"Email address of sender for filtering"}, {"in"=>"query", "name"=>"startindex", "description"=>"Number indicating where to begin reporting results"}, {"in"=>"query", "name"=>"starttime", "description"=>"Required"}, {"in"=>"query", "name"=>"[X-HeaderName]", "description"=>"Name of searchable custom X-header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Emails", "Delivered"]}}, "reports/delivered/count"=>{"get"=>{"summary"=>"Retrieve Count of Emails Delivered", "description"=>"Retrieve Count of Emails Delivered", "operationId"=>"getReportsDeliveredCount", "x-api-path-slug"=>"reportsdeliveredcount-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"endtime", "description"=>"Required"}, {"in"=>"query", "name"=>"sender", "description"=>"Email address of sender for filtering"}, {"in"=>"query", "name"=>"starttime", "description"=>"Required"}, {"in"=>"query", "name"=>"[X-HeaderName]", "description"=>"Name of searchable custom X-header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Count", "of", "Emails", "Delivered"]}}, "reports/issues"=>{"get"=>{"summary"=>"Retrieve Email Issues", "description"=>"Retrieve Email Issues", "operationId"=>"getReportsIssues", "x-api-path-slug"=>"reportsissues-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"emailaddress", "description"=>"Email address of recipient for filtering"}, {"in"=>"query", "name"=>"endtime", "description"=>"Required"}, {"in"=>"query", "name"=>"sender", "description"=>"Email address of sender for filtering"}, {"in"=>"query", "name"=>"sender_id", "description"=>"Identifying number of the sender"}, {"in"=>"query", "name"=>"startindex", "description"=>"Number indicating where to begin reporting results"}, {"in"=>"query", "name"=>"starttime", "description"=>"Required"}, {"in"=>"query", "name"=>"[X-HeaderName]", "description"=>"Name of searchable custom X-header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Email", "Issues"]}}, "reports/issues/count"=>{"get"=>{"summary"=>"Retrieve Count of Email Issues", "description"=>"Retrieving a total count of Email issues", "operationId"=>"getReportsIssuesCount", "x-api-path-slug"=>"reportsissuescount-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"endtime", "description"=>"Required"}, {"in"=>"query", "name"=>"starttime", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Count", "of", "Email", "Issues"]}}, "reports/opens/count/unique"=>{"get"=>{"summary"=>"Retrieve Count of Email Opens", "description"=>"Returns total number of unique opens for the specified account for the specified date range. Including a date range is highly recommended.", "operationId"=>"getReportsOpensCountUnique", "x-api-path-slug"=>"reportsopenscountunique-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"emailaddress", "description"=>"Email address of recipient for filtering"}, {"in"=>"query", "name"=>"endtime", "description"=>"Required"}, {"in"=>"query", "name"=>"sender", "description"=>"u00a0Email address of sender for filtering"}, {"in"=>"query", "name"=>"starttime", "description"=>"Required"}, {"in"=>"query", "name"=>"[X-HeaderName]", "description"=>"Name of searchable custom X-header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Count", "of", "Email", "Opens"]}}, "reports/sent"=>{"get"=>{"summary"=>"Retrieve Emails Sent", "description"=>"Retrieve Emails Sent", "operationId"=>"getReportsSent", "x-api-path-slug"=>"reportssent-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"endtime", "description"=>"Required"}, {"in"=>"query", "name"=>"sender", "description"=>"Email address of sender for filtering"}, {"in"=>"query", "name"=>"startindex", "description"=>"Number indicating where to begin reporting results"}, {"in"=>"query", "name"=>"starttime", "description"=>"Required"}, {"in"=>"query", "name"=>"[X-HeaderName]", "description"=>"Name of searchable custom X-header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Emails", "Sent"]}}, "reports/sent/count"=>{"get"=>{"summary"=>"Retrieve Count of Emails Sent", "description"=>"Retrieve Count of Emails Sent", "operationId"=>"getReportsSentCount", "x-api-path-slug"=>"reportssentcount-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"endtime", "description"=>"Required"}, {"in"=>"query", "name"=>"sender", "description"=>"Email address of sender for filtering"}, {"in"=>"query", "name"=>"starttime", "description"=>"Required"}, {"in"=>"query", "name"=>"[X-HeaderName]", "description"=>"Name of searchable custom X-header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Count", "of", "Emails", "Sent"]}}, "send"=>{"post"=>{"summary"=>"Send Email", "description"=>"Sending Email", "operationId"=>"postSend", "x-api-path-slug"=>"send-post", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"bcc", "description"=>"Address(es) to blind copy the email to"}, {"in"=>"query", "name"=>"bodyhtml", "description"=>"The text/html version of the email; this field may be encoded in 7-bit, 8-bit, quoted-printable, or base64"}, {"in"=>"query", "name"=>"bodytext", "description"=>"The plain/text version of the email; this field may be encoded in Base64 (recommended), quoted-printable, 8-bit, or 7-bit"}, {"in"=>"query", "name"=>"cc", "description"=>"Address(es) to copy the email to"}, {"in"=>"query", "name"=>"comments", "description"=>"Additional comments about the message"}, {"in"=>"query", "name"=>"from", "description"=>"Required"}, {"in"=>"query", "name"=>"importance", "description"=>"A hint from the originator on how important the message is"}, {"in"=>"query", "name"=>"inreplyto", "description"=>"One or more message identifier(s) of the original message(s) to which the current message is a reply"}, {"in"=>"query", "name"=>"keywords", "description"=>"A comma-separated list of important words and phrases useful for recipient"}, {"in"=>"query", "name"=>"messageid", "description"=>"A unique message identifier that can be passed in via the api and override the Dyn automatically generated message id"}, {"in"=>"query", "name"=>"priority", "description"=>"Values are either normal, urgent, or non-urgent"}, {"in"=>"query", "name"=>"references", "description"=>"The message identifier(s) of other message(s) to which the current message may be related"}, {"in"=>"query", "name"=>"replyby", "description"=>"The date and time by which a reply is requested"}, {"in"=>"query", "name"=>"replyto", "description"=>"The email address for the recipient to reply to"}, {"in"=>"query", "name"=>"resent-date", "description"=>"The date and time that a message is resent in the same format as replyby"}, {"in"=>"query", "name"=>"resent-from", "description"=>"The email address of the person who has resent the message, or on whose behalf the message has been resent"}, {"in"=>"query", "name"=>"resent-messageid", "description"=>"Contains a message identifier for a resent message"}, {"in"=>"query", "name"=>"resent-replyto", "description"=>"Resent Reply-to in the same format as the replyto header"}, {"in"=>"query", "name"=>"resent-sender", "description"=>"The email address of the person who has resent the message, if this is different from the resent-from value"}, {"in"=>"query", "name"=>"sender", "description"=>"This is the email address of the agent responsible for sending the message"}, {"in"=>"query", "name"=>"sensitivity", "description"=>"How sensitive it is to disclose this message with values that can be either personal, private or company confidential"}, {"in"=>"query", "name"=>"subject", "description"=>"Required"}, {"in"=>"query", "name"=>"to", "description"=>"Required"}, {"in"=>"query", "name"=>"xheaders", "description"=>"Any additional custom X-headers to send in the email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Email"]}}, "suppressions"=>{"get"=>{"summary"=>"Retrieve Suppression Email Addresses", "description"=>"Retrieving a list of Email addresses on the suppression list", "operationId"=>"getSuppressions", "x-api-path-slug"=>"suppressions-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"startdate", "description"=>"Start date/time range in full, ISO 8601 format"}, {"in"=>"query", "name"=>"startindex", "description"=>"Starting index value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Suppression", "Email", "resses"]}, "post"=>{"summary"=>"Add Email Address to Suppression List", "description"=>"Adding one or more recipients to the suppression list", "operationId"=>"postSuppressions", "x-api-path-slug"=>"suppressions-post", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"emailaddress", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[".Email", "ress", "to", "Suppression", "List"]}}, "suppressions/count"=>{"get"=>{"summary"=>"Retrieve Suppression Count", "description"=>"Retrieving the count of Email addresses on the suppression list", "operationId"=>"getSuppressionsCount", "x-api-path-slug"=>"suppressionscount-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}, {"in"=>"query", "name"=>"enddate", "description"=>"End date/time range in full, ISO 8601 format"}, {"in"=>"query", "name"=>"startdate", "description"=>"Start date/time range in full, ISO 8601 format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Suppression", "Count"]}}, "xheaders"=>{"get"=>{"summary"=>"Retrieving a list of custom X-header field names", "description"=>"Retrieving a list of custom X-header field names", "operationId"=>"getXheaders", "x-api-path-slug"=>"xheaders-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrievinglist", "of", "custom", "X-header", "field", "names"]}, "post"=>{"summary"=>"Update Email X-Headers", "description"=>"Updating the custom x-headers of an Email account", "operationId"=>"postXheaders", "x-api-path-slug"=>"xheaders-post", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[".Email", "X-Headers"]}}}}, "apis"=>{"name"=>"Dyn", "x-slug"=>"dyn", "description"=>"Dyn is home to the worlds most trusted DNS product suite and the worlds most reputable Email Deliverability Service.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/582-dyn.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"20789", "tags"=>"API Provider,API Service Provider,DNS,DNS,DNS General,Emails,Emails,Enterprise,Getting Started Example,internet,ISP,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"dyn/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Dyn", "x-api-slug"=>"dyn", "description"=>"Dyn is home to the worlds most trusted DNS product suite and the worlds most reputable Email Deliverability Service.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/582-dyn.jpg", "humanURL"=>"http://dynect.net", "baseURL"=>"https:///", "tags"=>"API Provider,API Service Provider,DNS,DNS,DNS General,Emails,Emails,Enterprise,Getting Started Example,internet,ISP,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/dyn/xheaders-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/dyn/dyn-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.dynect.net"}, {"type"=>"x-blog", "url"=>"http://research.dyn.com/"}, {"type"=>"x-blog", "url"=>"http://dyn.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"http://feeds.feedburner.com/dyn-blog"}, {"type"=>"x-blog-rss", "url"=>"http://research.dyn.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/dyn"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/dyn"}, {"type"=>"x-developer", "url"=>"https://help.dyn.com/developers/"}, {"type"=>"x-email", "url"=>"billing@dyndns.com"}, {"type"=>"x-email", "url"=>"privacy@dyn.com"}, {"type"=>"x-forum", "url"=>"http://www.dyndnscommunity.com/"}, {"type"=>"x-getting-started", "url"=>"http://dyn.com/product-wizard/"}, {"type"=>"x-github", "url"=>"https://github.com/dyninc"}, {"type"=>"x-partners", "url"=>"http://dyn.com/about/partners/"}, {"type"=>"x-php-sdk", "url"=>"https://github.com/dyninc/dyn-php/"}, {"type"=>"x-privacy", "url"=>"http://dyn.com/legal/dyn-privacy-policy/"}, {"type"=>"x-python-sdk", "url"=>"https://github.com/dyninc/dyn-python/"}, {"type"=>"x-selfservice-registration", "url"=>"https://account.dyn.com/entrance/"}, {"type"=>"x-status", "url"=>"http://www.dynstatus.com/"}, {"type"=>"x-terms-of-service", "url"=>"http://dyn.com/legal/dyn-services-agreement/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Dyn"}, {"type"=>"x-website", "url"=>"http://dynect.net"}, {"type"=>"x-website", "url"=>"http://dyn.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
openrouteservice{"ap-breaking-news-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"OpenRouteService", "x-complete"=>1, "info"=>{"title"=>"AP Breaking News API", "description"=>"ap-breaking-news-api-allows-your-organization-to-retrieve-a-list-of-available-breaking-news-categories-and-then-request-content-for-a-specific-category-", "version"=>"v2"}, "host"=>"developerapi.ap.org", "basePath"=>"v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"categories.svc/"=>{"get"=>{"summary"=>"Categories", "description"=>"Returns a list of available AP Breaking News categories, including category IDs.", "operationId"=>"getCategories.svc", "x-api-path-slug"=>"categories-svc-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories"]}}, "categories.svc/{categoryID}/"=>{"get"=>{"summary"=>"Category News", "description"=>"Returns the latest content for a specific category. Depending on the specified parameters, returns either the full story for each headline and/or the headlines linked to web pages with the full stories.", "operationId"=>"getCategories.svcCategory", "x-api-path-slug"=>"categories-svccategoryid-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"API Key"}, {"in"=>"query", "name"=>"categoryID", "description"=>"The ID of the AP Breaking News category"}, {"in"=>"query", "name"=>"contentOption", "description"=>"Specifies whether to return full story content in the response"}, {"in"=>"query", "name"=>"count", "description"=>"The number of content items to be returned"}, {"in"=>"query", "name"=>"mediaOption", "description"=>"Includes related photos in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Category", "News"]}}}}, "ap-content-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"OpenRouteService", "x-complete"=>1, "info"=>{"title"=>"AP Content API", "description"=>"ap-content-api-allows-you-to-search-and-download-ap-images-content-using-your-own-editorial-tools-without-having-to-visit-the-ap-images-website-", "version"=>"v2"}, "host"=>"api.ap.org", "basePath"=>"v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"item/{id}/"=>{"get"=>{"summary"=>"Get Item", "description"=>"Get items.", "operationId"=>"getItem", "x-api-path-slug"=>"itemid-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"API Key"}, {"in"=>"query", "name"=>"format", "description"=>"The format of the returned content item data"}, {"in"=>"query", "name"=>"id", "description"=>"The GUID of a content item (not case-sensitive)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item"]}}, "item/{mediaType}/{id}/{rendition}"=>{"get"=>{"summary"=>"Get Item Mediatype Rendition", "description"=>"Pulls item media", "operationId"=>"getItemMediatypeRendition", "x-api-path-slug"=>"itemmediatypeidrendition-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"API key"}, {"in"=>"query", "name"=>"filename", "description"=>"The filename for the downloaded content item rendition, in the format"}, {"in"=>"query", "name"=>"id", "description"=>"The GUID of a content item (not case-sensitive)"}, {"in"=>"query", "name"=>"mediaType", "description"=>"The content media type"}, {"in"=>"query", "name"=>"rendition", "description"=>"The content item rendition"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Item", "Mediatype", "Rendition"]}}, "search/{mediaType}"=>{"get"=>{"summary"=>"Get Search Mediatype", "description"=>"Search news", "operationId"=>"getSearchMediatype", "x-api-path-slug"=>"searchmediatype-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"API Key"}, {"in"=>"query", "name"=>"arrivalDate", "description"=>"The date when the content item was released, in the format YYYY-MM-DD, YYYY-MM, YYYY or YYYY-MM-DDTHH:mmZ where the value must be in Coordinated Universal Time (UTC)"}, {"in"=>"query", "name"=>"contentSet", "description"=>"The AP Images content set to be searched"}, {"in"=>"query", "name"=>"count", "description"=>"The number of search results per page"}, {"in"=>"query", "name"=>"creationDate", "description"=>"The date when the content item was created, in the format YYYY-MM-DD, YYYY-MM, YYYY or YYYY-MM-DDTHH:mmZ where the value must be in Coordinated Universal Time (UTC)"}, {"in"=>"query", "name"=>"event", "description"=>"One or more words from the title of a specific event"}, {"in"=>"query", "name"=>"imageId", "description"=>"One or more image ID numbers assigned to content items"}, {"in"=>"query", "name"=>"locations", "description"=>"A geographic location in the AP Geography vocabulary"}, {"in"=>"path", "name"=>"mediaType", "description"=>"The content media type (photo, graphic, video)"}, {"in"=>"query", "name"=>"metadataLevel", "description"=>"The level of metadata to be included in search results"}, {"in"=>"query", "name"=>"page", "description"=>"The page number within the set of search results"}, {"in"=>"query", "name"=>"person", "description"=>"The name of a person who is featured in the content item"}, {"in"=>"query", "name"=>"photographer", "description"=>"The photographers first and/or last name"}, {"in"=>"query", "name"=>"q", "description"=>"The search query"}, {"in"=>"query", "name"=>"showParametrics", "description"=>"By default, query facets that allow you to refine the original search are returned for each content item at the entry level only"}, {"in"=>"query", "name"=>"sortby", "description"=>"Specifies how to sort the search results"}, {"in"=>"query", "name"=>"source", "description"=>"One or more content creators"}, {"in"=>"query", "name"=>"subject", "description"=>"Subject category in the AP Subject vocabulary"}, {"in"=>"query", "name"=>"transref", "description"=>"Transmission reference number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Mediatype"]}}}}, "ap-metadata-services-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"OpenRouteService", "x-complete"=>1, "info"=>{"title"=>"AP Metadata Services", "description"=>"add-value-to-your-news-content-with-apu2019s-industryleading-metadata--accurate-comprehensive-richly-detailed-data-designed-specifically-for-use-by-news-publishers--ap-metadata-services-is-a-new-set-of-apis-that-gives-you-direct-access-to-the-same-metadata-system-that-supports-apu2019s-awardwinning-global-news-operation-", "version"=>"v1"}, "host"=>"cv.ap.org", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"api/cm/"=>{"get"=>{"summary"=>"Change Log", "description"=>"Returns a list of changes to the AP vocabulary terms according to the specified criteria.", "operationId"=>"getApiCm", "x-api-path-slug"=>"apicm-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"API Key"}, {"in"=>"query", "name"=>"authority", "description"=>"authority"}, {"in"=>"query", "name"=>"enddate", "description"=>"This parameter can be used in conjunction with the startdate parameter to specify a date range"}, {"in"=>"query", "name"=>"format", "description"=>"Specifies the output format: comma-separated values (CSV) or XML"}, {"in"=>"query", "name"=>"lastversion", "description"=>"Returns all change logs since (but not including) the specified version number, in the format {AuthorityVersion}"}, {"in"=>"query", "name"=>"startdate", "description"=>"eturns all change logs since (and including) the specified date"}, {"in"=>"query", "name"=>"version", "description"=>"Returns the change log for the specified version number, in the format {AuthorityVersion}"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change", "Log"]}}, "c/{class}.{format}"=>{"get"=>{"summary"=>"Ontology Definition", "description"=>"Returns the AP ontology definition for the specified AP property or class and the specified format.", "operationId"=>"getCClass.Format", "x-api-path-slug"=>"cclass-format-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"API Key"}, {"in"=>"path", "name"=>"class", "description"=>"The name of an AP property or class"}, {"in"=>"path", "name"=>"format", "description"=>"The format of the returned AP ontology data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ontology", "Definition"]}}, "d/DeprecatedCompany.{format}"=>{"get"=>{"summary"=>"DeprecatedCompany", "description"=>"Returns a list of deprecated AP vocabulary terms in the specified format for the AP Company authority or for the other four AP authorities.", "operationId"=>"getDDeprecatedcompany.Format", "x-api-path-slug"=>"ddeprecatedcompany-format-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"API Key"}, {"in"=>"path", "name"=>"format", "description"=>"The format of the returned taxonomy data (RDF/XML, RDF/TTL or NewsML-G2)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DeprecatedCompany"]}}, "d/DeprecatedTerm.{format}"=>{"get"=>{"summary"=>"Deprecated Terms", "description"=>"Returns a list of deprecated AP vocabulary terms in the specified format for the AP Company authority or for the other four AP authorities.", "operationId"=>"getDDeprecatedterm.Format", "x-api-path-slug"=>"ddeprecatedterm-format-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"API Key"}, {"in"=>"path", "name"=>"format", "description"=>"The format of the returned taxonomy data (RDF/XML, RDF/TTL or NewsML-G2)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deprecated", "Terms"]}}, "d/{authority}.{format}"=>{"get"=>{"summary"=>"Taxonomy Information", "description"=>"Returns the taxonomy information for the specified authority and the specified format.", "operationId"=>"getDAuthority.Format", "x-api-path-slug"=>"dauthority-format-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"API Key"}, {"in"=>"path", "name"=>"authority", "description"=>"The name of a classification authority (not case-sensitive)"}, {"in"=>"path", "name"=>"format", "description"=>"The format of the returned taxonomy data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Taxonomy", "Information"]}}, "d/{authority}/{GUID}.{format}"=>{"get"=>{"summary"=>"Authority", "description"=>"Returns a document for the specified authority and format with the AP vocabulary data for the specified term GUID and the subset of the vocabulary located below the specified term.", "operationId"=>"getDAuthorityGu.Format", "x-api-path-slug"=>"dauthorityguid-format-get", "parameters"=>[{"in"=>"query", "name"=>"apikey", "description"=>"API Key"}, {"in"=>"path", "name"=>"authority", "description"=>"The name of a classification authority (not case-sensitive)"}, {"in"=>"path", "name"=>"format", "description"=>"The format of the returned taxonomy data"}, {"in"=>"path", "name"=>"GUID", "description"=>"The GUID of an AP term below which the returned taxonomy data subset is located in the AP taxonomy hierarchy"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authority"]}}, "id/{GUID}.{format}"=>{"get"=>{"summary"=>"Taxonomy Information", "description"=>"Returns the taxonomy information for the specified GUID of an AP term and the specified format.", "operationId"=>"getGu.Format", "x-api-path-slug"=>"idguid-format-get", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"API Key"}, {"in"=>"path", "name"=>"format", "description"=>"The format of the returned taxonomy data"}, {"in"=>"path", "name"=>"GUID", "description"=>"The GUID of an AP term (not case-sensitive)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Taxonomy", "Information"]}}, "Tags/"=>{"post"=>{"summary"=>"Tags", "description"=>"Returns the set of AP standardized vocabulary terms that apply to the submitted news content. The output can be limited to one or more authorities specified in the request; for example, you can choose to apply only AP Organization, AP Subject and AP Geography tags to the submitted content, but not AP Person or AP Company.", "operationId"=>"postTags", "x-api-path-slug"=>"tags-post", "parameters"=>[{"in"=>"query", "name"=>"apiKey", "description"=>"API Key"}, {"in"=>"body", "name"=>"story", "description"=>"URL-encoded content submitted for tagging", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}}}, "apis"=>{"name"=>"OpenRouteService", "x-slug"=>"openrouteservice", "description"=>"OpenStreetMap is the free wiki world map.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/882-openrouteservice.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"6266", "tags"=>"Bicycle,Directions,General Data,Locations,Maps,Relative Data,Routes,Routes,Routes,SaaS,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"openrouteservice/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AP Breaking News API", "x-api-slug"=>"ap-breaking-news-api", "description"=>"OpenStreetMap is the free wiki world map.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/882-openrouteservice.jpg", "humanURL"=>"http://wiki.openstreetmap.org/wiki/OpenRouteService#ORS_.22API.22", "baseURL"=>"https://developerapi.ap.org/v2/", "tags"=>"Bicycle,Directions,General Data,Locations,Maps,Relative Data,Routes,Routes,Routes,SaaS,Service API,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/openrouteservice/categories-svccategoryid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/openrouteservice/ap-breaking-news-api-openapi.yaml"}]}, {"name"=>"AP Content API", "x-api-slug"=>"ap-content-api", "description"=>"OpenStreetMap is the free wiki world map.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/882-openrouteservice.jpg", "humanURL"=>"http://wiki.openstreetmap.org/wiki/OpenRouteService#ORS_.22API.22", "baseURL"=>"https://api.ap.org/v2/", "tags"=>"Category,News", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/openrouteservice/searchmediatype-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/openrouteservice/ap-content-api-openapi.yaml"}]}, {"name"=>"AP Metadata Services", "x-api-slug"=>"ap-metadata-services", "description"=>"OpenStreetMap is the free wiki world map.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/882-openrouteservice.jpg", "humanURL"=>"http://wiki.openstreetmap.org/wiki/OpenRouteService#ORS_.22API.22", "baseURL"=>"https://cv.ap.org//", "tags"=>"Search,Mediatype", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/openrouteservice/ap-metadata-services-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://wiki.openstreetmap.org/wiki/OpenRouteService#ORS_.22API.22"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/openstreetmap-3"}, {"type"=>"x-developer", "url"=>"https://developer.ap.org/"}, {"type"=>"x-website", "url"=>"http://ap.org"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-billing-api{"azure-billing-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Billing API", "x-complete"=>1, "info"=>{"title"=>"ConsumptionManagementClient", "description"=>"consumption-management-client-provides-access-to-consumption-resources-for-azure-webdirect-subscriptions--other-subscription-types-which-were-not-purchased-directly-through-the-azure-web-portal-are-not-supported-through-this-preview-api-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods"=>{"get"=>{"summary"=>"Billing Periods List", "description"=>"Lists the available billing periods for a subscription in reverse chronological order.", "operationId"=>"BillingPeriods_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-billingbillingperiods-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"May be used to filter billing periods by billingPeriodEndDate"}, {"in"=>"query", "name"=>"$skiptoken", "description"=>"Skiptoken is only used if a previous operation returned a partial result"}, {"in"=>"query", "name"=>"$top", "description"=>"May be used to limit the number of results to the most recent N billing periods"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Billing Period"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}"=>{"get"=>{"summary"=>"Billing Periods Get", "description"=>"Gets a named billing period.", "operationId"=>"BillingPeriods_Get", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-billingbillingperiodsbillingperiodname-get", "parameters"=>[{"in"=>"path", "name"=>"billingPeriodName", "description"=>"The name of a BillingPeriod resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Billing Period"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices"=>{"get"=>{"summary"=>"Invoices List", "description"=>"Lists the available invoices for a subscription in reverse chronological order beginning with the most recent invoice. In preview, invoices are available via this API only for invoice periods which end December 1, 2016 or later.", "operationId"=>"Invoices_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-billinginvoices-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"May be used to expand the downloadUrl property within a list of invoices"}, {"in"=>"query", "name"=>"$filter", "description"=>"May be used to filter invoices by invoicePeriodEndDate"}, {"in"=>"query", "name"=>"$skiptoken", "description"=>"Skiptoken is only used if a previous operation returned a partial result"}, {"in"=>"query", "name"=>"$top", "description"=>"May be used to limit the number of results to the most recent N invoices"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/{invoiceName}"=>{"get"=>{"summary"=>"Invoices Get", "description"=>"Gets a named invoice resource. When getting a single invoice, the downloadUrl property is expanded automatically.", "operationId"=>"Invoices_Get", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-billinginvoicesinvoicename-get", "parameters"=>[{"in"=>"path", "name"=>"invoiceName", "description"=>"The name of an invoice resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/latest"=>{"get"=>{"summary"=>"Invoices Get Latest", "description"=>"Gets the most recent invoice. When getting a single invoice, the downloadUrl property is expanded automatically.", "operationId"=>"Invoices_GetLatest", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-billinginvoiceslatest-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice"]}}, "/providers/Microsoft.Billing/operations"=>{"get"=>{"summary"=>"Operations List", "description"=>"Lists all of the available billing REST API operations.", "operationId"=>"Operations_List", "x-api-path-slug"=>"providersmicrosoft-billingoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/{scope}/providers/Microsoft.Consumption/usageDetails"=>{"get"=>{"summary"=>"Usage Details List", "description"=>"Lists the usage details for a scope in reverse chronological order by billing period. Usage details are available via this API only for January 1, 2017 or later.", "operationId"=>"UsageDetails_List", "x-api-path-slug"=>"scopeprovidersmicrosoft-consumptionusagedetails-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"May be used to expand the additionalProperties or meterDetails property within a list of usage details"}, {"in"=>"query", "name"=>"$filter", "description"=>"May be used to filter usageDetails by usageEnd (Utc time)"}, {"in"=>"query", "name"=>"$skiptoken", "description"=>"Skiptoken is only used if a previous operation returned a partial result"}, {"in"=>"query", "name"=>"$top", "description"=>"May be used to limit the number of results to the most recent N usageDetails"}, {"in"=>"path", "name"=>"scope", "description"=>"The scope of the usage details"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Usage"]}}, "/providers/Microsoft.Consumption/operations"=>{"get"=>{"summary"=>"Operations List", "description"=>"Lists all of the available consumption REST API operations.", "operationId"=>"Operations_List", "x-api-path-slug"=>"providersmicrosoft-consumptionoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}}}, "apis"=>{"name"=>"Azure Billing API", "x-slug"=>"azure-billing-api", "description"=>"Use Azure Billing APIs to pull usage and resource data into your preferred data analysis tools. The Azure Resource Usage and RateCard APIs can help you accurately predict and manage your costs. The APIs are implemented as a Resource Provider and part of the family of APIs exposed by the Azure Resource Manager.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-billing-api.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Billing,Management,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-billing-api/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Billing API", "x-api-slug"=>"azure-billing-api", "description"=>"Use Azure Billing APIs to pull usage and resource data into your preferred data analysis tools. The Azure Resource Usage and RateCard APIs can help you accurately predict and manage your costs. The APIs are implemented as a Resource Provider and part of the family of APIs exposed by the Azure Resource Manager.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-billing-api.png", "humanURL"=>"https://docs.microsoft.com/en-us/azure/billing/billing-usage-rate-card-overview", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Billing,Management,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-billing-api/providersmicrosoft-consumptionoperations-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-billing-api/azure-billing-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://docs.microsoft.com/en-us/azure/billing/billing-usage-rate-card-overview"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ulster-bank{"ulster-bank-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Ulster Bank", "x-complete"=>1, "info"=>{"title"=>"Ulster Bank", "description"=>"this-is-an-openapi-definition-for-the-standard-set-of-open-banking-httpopenbankingapis-io-apis-for-ulster-bank-", "termsOfService"=>"https://www.openbanking.org.uk/open-licence/", "contact"=>{"name"=>"API Evangelist", "url"=>"https://apievangelist.com", "email"=>"info@apievangelist.com"}, "version"=>"1.0.0"}, "host"=>"openapi.ulsterbank.co.uk", "basePath"=>"open-banking/v2.1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"atms/"=>{"get"=>{"summary"=>"Get ATMs", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can provide multiple ATMs.", "operationId"=>"getATMS", "x-api-path-slug"=>"atms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Banking", "ATMs"]}}, "branches/"=>{"get"=>{"summary"=>"Get Branches", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple branches.", "operationId"=>"getBranches", "x-api-path-slug"=>"branches-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Banking", "Branches"]}}, "personal-current-accounts/"=>{"get"=>{"summary"=>"Get Current Personal Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple PCA products.", "operationId"=>"getCurrentPersonalAccounts", "x-api-path-slug"=>"personalcurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Banking", "Current", "Personal", "Accounts"]}}, "business-current-accounts/"=>{"get"=>{"summary"=>"Get Current Business Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple BCA products.", "operationId"=>"getCurentBusinessAccounts", "x-api-path-slug"=>"businesscurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Banking", "Current", "Business", "Accounts"]}}, "unsecured-sme-loans/"=>{"get"=>{"summary"=>"Get Unsecured SME Loans", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Unsecured Loan products.", "operationId"=>"pathOperation", "x-api-path-slug"=>"unsecuredsmeloans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Banking", "Unsecured", "SME", "Loans"]}}}}, "apis"=>{"name"=>"Ulster Bank", "x-slug"=>"ulster-bank", "description"=>"Ulster Bank is a large commercial bank, and one of the traditional Big Four Irish banks. The Ulster Bank Group is subdivided into two separate legal entities, Ulster Bank Limited (UBL – registered in Northern Ireland) and Ulster Bank Ireland DAC (UBIDAC – registered in the Republic of Ireland). The Groups headquarters (and UBIDACs) is located on Georges Quay, Dublin, in the Republic of Ireland whilst the official headquarters of UBL is in Donegall Square East, Belfast, in Northern Ireland, and it maintains a large sector of the financial services in both the UK and the Republic of Ireland.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Ulster-Bank-Limited-2090.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"ATMs,Banking,General Data,Relative Data,UK Banks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"ulster-bank/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Ulster Bank", "x-api-slug"=>"ulster-bank", "description"=>"Ulster Bank is a large commercial bank, and one of the traditional Big Four Irish banks. The Ulster Bank Group is subdivided into two separate legal entities, Ulster Bank Limited (UBL – registered in Northern Ireland) and Ulster Bank Ireland DAC (UBIDAC – registered in the Republic of Ireland). The Groups headquarters (and UBIDACs) is located on Georges Quay, Dublin, in the Republic of Ireland whilst the official headquarters of UBL is in Donegall Square East, Belfast, in Northern Ireland, and it maintains a large sector of the financial services in both the UK and the Republic of Ireland.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Ulster-Bank-Limited-2090.png", "humanURL"=>"https://digital.ulsterbank.co.uk/", "baseURL"=>"https://openapi.ulsterbank.co.uk/open-banking/v2.1/", "tags"=>"ATMs,Banking,General Data,Relative Data,UK Banks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/ulster-bank/unsecuredsmeloans-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/ulster-bank/ulster-bank-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-twitter", "url"=>"https://twitter.com/ulsterbank_help"}, {"type"=>"x-website", "url"=>"https://digital.ulsterbank.co.uk/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-database-migration-service{"aws-database-migration-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Database Migration Service", "x-complete"=>1, "info"=>{"title"=>"AWS Database Migration Service API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddTagsToResource"=>{"get"=>{"summary"=>"Add Tags To Resource", "description"=>"Adds metadata tags to a DMS resource, including replication instance, endpoint, security group, and migration task.", "operationId"=>"addTagsToResource", "x-api-path-slug"=>"actionaddtagstoresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceArn", "description"=>"The Amazon Resource Name (ARN) of the AWS DMS resource the tag is to be added to", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"The tag to be assigned to the DMS resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Tags"]}}, "/?Action=CreateEndpoint"=>{"get"=>{"summary"=>"Create Endpoint", "description"=>"Creates an endpoint using the provided settings.", "operationId"=>"createEndpoint", "x-api-path-slug"=>"actioncreateendpoint-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateArn", "description"=>"The Amazon Resource Number (ARN) for the certificate", "type"=>"string"}, {"in"=>"query", "name"=>"DatabaseName", "description"=>"The name of the endpoint database", "type"=>"string"}, {"in"=>"query", "name"=>"EndpointIdentifier", "description"=>"The database endpoint identifier", "type"=>"string"}, {"in"=>"query", "name"=>"EndpointType", "description"=>"The type of endpoint", "type"=>"string"}, {"in"=>"query", "name"=>"EngineName", "description"=>"The type of engine for the endpoint", "type"=>"string"}, {"in"=>"query", "name"=>"ExtraConnectionAttributes", "description"=>"Additional attributes associated with the connection", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyId", "description"=>"The KMS key identifier that will be used to encrypt the connection parameters", "type"=>"string"}, {"in"=>"query", "name"=>"Password", "description"=>"The password to be used to login to the endpoint database", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port used by the endpoint database", "type"=>"string"}, {"in"=>"query", "name"=>"ServerName", "description"=>"The name of the server where the endpoint database resides", "type"=>"string"}, {"in"=>"query", "name"=>"SslMode", "description"=>"The SSL mode to use for the SSL connection", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"Tags to be added to the endpoint", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The user name to be used to login to the endpoint database", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoints"]}}, "/?Action=CreateReplicationInstance"=>{"get"=>{"summary"=>"Create Replication Instance", "description"=>"Creates the replication instance using the specified parameters.", "operationId"=>"createReplicationInstance", "x-api-path-slug"=>"actioncreatereplicationinstance-get", "parameters"=>[{"in"=>"query", "name"=>"AllocatedStorage", "description"=>"The amount of storage (in gigabytes) to be initially allocated for the replication instance", "type"=>"string"}, {"in"=>"query", "name"=>"AutoMinorVersionUpgrade", "description"=>"Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window", "type"=>"string"}, {"in"=>"query", "name"=>"AvailabilityZone", "description"=>"The EC2 Availability Zone that the replication instance will be created in", "type"=>"string"}, {"in"=>"query", "name"=>"EngineVersion", "description"=>"The engine version number of the replication instance", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyId", "description"=>"The KMS key identifier that will be used to encrypt the content on the replication instance", "type"=>"string"}, {"in"=>"query", "name"=>"MultiAZ", "description"=>"Specifies if the replication instance is a Multi-AZ deployment", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredMaintenanceWindow", "description"=>"The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC)", "type"=>"string"}, {"in"=>"query", "name"=>"PubliclyAccessible", "description"=>"Specifies the accessibility options for the replication instance", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationInstanceClass", "description"=>"The compute and memory capacity of the replication instance as specified by the replication instance class", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationInstanceIdentifier", "description"=>"The replication instance identifier", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationSubnetGroupIdentifier", "description"=>"A subnet group to associate with the replication instance", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"Tags to be associated with the replication instance", "type"=>"string"}, {"in"=>"query", "name"=>"VpcSecurityGroupIds", "description"=>"Specifies the VPC security group to be used with the replication instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Instances"]}}, "/?Action=CreateReplicationSubnetGroup"=>{"get"=>{"summary"=>"Create Replication Subnet Group", "description"=>"Creates a replication subnet group given a list of the subnet IDs in a VPC.", "operationId"=>"createReplicationSubnetGroup", "x-api-path-slug"=>"actioncreatereplicationsubnetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"ReplicationSubnetGroupDescription", "description"=>"The description for the subnet group", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationSubnetGroupIdentifier", "description"=>"The name for the replication subnet group", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetIds", "description"=>"The EC2 subnet IDs for the subnet group", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"The tag to be assigned to the subnet group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Subnet Group"]}}, "/?Action=CreateReplicationTask"=>{"get"=>{"summary"=>"Create Replication Task", "description"=>"Creates a replication task using the specified parameters.", "operationId"=>"createReplicationTask", "x-api-path-slug"=>"actioncreatereplicationtask-get", "parameters"=>[{"in"=>"query", "name"=>"CdcStartTime", "description"=>"The start time for the Change Data Capture (CDC) operation", "type"=>"string"}, {"in"=>"query", "name"=>"MigrationType", "description"=>"The migration type", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationInstanceArn", "description"=>"The Amazon Resource Name (ARN) of the replication instance", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationTaskIdentifier", "description"=>"The replication task identifier", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationTaskSettings", "description"=>"Settings for the task, such as target metadata settings", "type"=>"string"}, {"in"=>"query", "name"=>"SourceEndpointArn", "description"=>"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint", "type"=>"string"}, {"in"=>"query", "name"=>"TableMappings", "description"=>"The path of the JSON file that contains the table mappings", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"Tags to be added to the replication instance", "type"=>"string"}, {"in"=>"query", "name"=>"TargetEndpointArn", "description"=>"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Tasks"]}}, "/?Action=DeleteCertificate"=>{"get"=>{"summary"=>"Delete Certificate", "description"=>"Deletes the specified certificate.", "operationId"=>"deleteCertificate", "x-api-path-slug"=>"actiondeletecertificate-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateArn", "description"=>"The Amazon Resource Name (ARN) of the deleted certificate", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=DeleteEndpoint"=>{"get"=>{"summary"=>"Delete Endpoint", "description"=>"Deletes the specified endpoint.", "operationId"=>"deleteEndpoint", "x-api-path-slug"=>"actiondeleteendpoint-get", "parameters"=>[{"in"=>"query", "name"=>"EndpointArn", "description"=>"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoints"]}}, "/?Action=DeleteReplicationInstance"=>{"get"=>{"summary"=>"Delete Replication Instance", "description"=>"Deletes the specified replication instance.", "operationId"=>"deleteReplicationInstance", "x-api-path-slug"=>"actiondeletereplicationinstance-get", "parameters"=>[{"in"=>"query", "name"=>"ReplicationInstanceArn", "description"=>"The Amazon Resource Name (ARN) of the replication instance to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Instances"]}}, "/?Action=DeleteReplicationSubnetGroup"=>{"get"=>{"summary"=>"Delete Replication Subnet Group", "description"=>"Deletes a subnet group.", "operationId"=>"deleteReplicationSubnetGroup", "x-api-path-slug"=>"actiondeletereplicationsubnetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"ReplicationSubnetGroupIdentifier", "description"=>"The subnet group name of the replication instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Subnet Group"]}}, "/?Action=DeleteReplicationTask"=>{"get"=>{"summary"=>"Delete Replication Task", "description"=>"Deletes the specified replication task.", "operationId"=>"deleteReplicationTask", "x-api-path-slug"=>"actiondeletereplicationtask-get", "parameters"=>[{"in"=>"query", "name"=>"ReplicationTaskArn", "description"=>"The Amazon Resource Name (ARN) of the replication task to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Tasks"]}}, "/?Action=DescribeAccountAttributes"=>{"get"=>{"summary"=>"Describe Account Attributes", "description"=>"Lists all of the AWS DMS attributes for a customer account.", "operationId"=>"describeAccountAttributes", "x-api-path-slug"=>"actiondescribeaccountattributes-get", "parameters"=>[{"in"=>"query", "name"=>"AccountQuotas", "description"=>"Account quota information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account Attributes"]}}, "/?Action=DescribeCertificates"=>{"get"=>{"summary"=>"Describe Certificates", "description"=>"Provides a description of the certificate.", "operationId"=>"describeCertificates", "x-api-path-slug"=>"actiondescribecertificates-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Filters applied to the certificate described in the form of key-value pairs", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=DescribeConnections"=>{"get"=>{"summary"=>"Describe Connections", "description"=>"Describes the status of the connections that have been made between the replication instance and an endpoint.", "operationId"=>"describeConnections", "x-api-path-slug"=>"actiondescribeconnections-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"The filters applied to the connection", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connections"]}}, "/?Action=DescribeEndpoints"=>{"get"=>{"summary"=>"Describe Endpoints", "description"=>"Returns information about the endpoints for your account in the current region.", "operationId"=>"describeEndpoints", "x-api-path-slug"=>"actiondescribeendpoints-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Filters applied to the describe action", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoints"]}}, "/?Action=DescribeEndpointTypes"=>{"get"=>{"summary"=>"Describe Endpoint Types", "description"=>"Returns information about the type of endpoints available.", "operationId"=>"describeEndpointTypes", "x-api-path-slug"=>"actiondescribeendpointtypes-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Filters applied to the describe action", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoint Types"]}}, "/?Action=DescribeOrderableReplicationInstances"=>{"get"=>{"summary"=>"Describe Orderable Replication Instances", "description"=>"Returns information about the replication instance types that can be created in the specified region.", "operationId"=>"describeOrderableReplicationInstances", "x-api-path-slug"=>"actiondescribeorderablereplicationinstances-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Instances"]}}, "/?Action=DescribeRefreshSchemasStatus"=>{"get"=>{"summary"=>"Describe Refresh Schemas Status", "description"=>"Returns the status of the RefreshSchemas operation.", "operationId"=>"describeRefreshSchemasStatus", "x-api-path-slug"=>"actiondescriberefreshschemasstatus-get", "parameters"=>[{"in"=>"query", "name"=>"EndpointArn", "description"=>"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schemas"]}}, "/?Action=DescribeReplicationInstances"=>{"get"=>{"summary"=>"Describe Replication Instances", "description"=>"Returns information about replication instances for your account in the current region.", "operationId"=>"describeReplicationInstances", "x-api-path-slug"=>"actiondescribereplicationinstances-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Filters applied to the describe action", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Instances"]}}, "/?Action=DescribeReplicationSubnetGroups"=>{"get"=>{"summary"=>"Describe Replication Subnet Groups", "description"=>"Returns information about the replication subnet groups.", "operationId"=>"describeReplicationSubnetGroups", "x-api-path-slug"=>"actiondescribereplicationsubnetgroups-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Filters applied to the describe action", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Instances"]}}, "/?Action=DescribeReplicationTasks"=>{"get"=>{"summary"=>"Describe Replication Tasks", "description"=>"Returns information about replication tasks for your account in the current region.", "operationId"=>"describeReplicationTasks", "x-api-path-slug"=>"actiondescribereplicationtasks-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Filters applied to the describe action", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Tasks"]}}, "/?Action=DescribeSchemas"=>{"get"=>{"summary"=>"Describe Schemas", "description"=>"Returns information about the schema for the specified endpoint.", "operationId"=>"describeSchemas", "x-api-path-slug"=>"actiondescribeschemas-get", "parameters"=>[{"in"=>"query", "name"=>"EndpointArn", "description"=>"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schemas"]}}, "/?Action=DescribeTableStatistics"=>{"get"=>{"summary"=>"Describe Table Statistics", "description"=>"Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.", "operationId"=>"describeTableStatistics", "x-api-path-slug"=>"actiondescribetablestatistics-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationTaskArn", "description"=>"The Amazon Resource Name (ARN) of the replication task", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table Statistics"]}}, "/?Action=ImportCertificate"=>{"get"=>{"summary"=>"Import Certificate", "description"=>"Uploads the specified certificate.", "operationId"=>"importCertificate", "x-api-path-slug"=>"actionimportcertificate-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateIdentifier", "description"=>"The customer-assigned name of the certificate", "type"=>"string"}, {"in"=>"query", "name"=>"CertificatePem", "description"=>"The contents of the ", "type"=>"string"}, {"in"=>"query", "name"=>"CertificateWallet", "description"=>"The location of the imported Oracle Wallet certificate for use with SSL", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=ListTagsForResource"=>{"get"=>{"summary"=>"List Tags For Resource", "description"=>"Lists all tags for an AWS DMS resource.", "operationId"=>"listTagsForResource", "x-api-path-slug"=>"actionlisttagsforresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceArn", "description"=>"The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Tags"]}}, "/?Action=ModifyEndpoint"=>{"get"=>{"summary"=>"Modify Endpoint", "description"=>"Modifies the specified endpoint.", "operationId"=>"modifyEndpoint", "x-api-path-slug"=>"actionmodifyendpoint-get", "parameters"=>[{"in"=>"query", "name"=>"CertificateArn", "description"=>"The Amazon Resource Name (ARN) of the certificate used for SSL connection", "type"=>"string"}, {"in"=>"query", "name"=>"DatabaseName", "description"=>"The name of the endpoint database", "type"=>"string"}, {"in"=>"query", "name"=>"EndpointArn", "description"=>"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint", "type"=>"string"}, {"in"=>"query", "name"=>"EndpointIdentifier", "description"=>"The database endpoint identifier", "type"=>"string"}, {"in"=>"query", "name"=>"EndpointType", "description"=>"The type of endpoint", "type"=>"string"}, {"in"=>"query", "name"=>"EngineName", "description"=>"The type of engine for the endpoint", "type"=>"string"}, {"in"=>"query", "name"=>"ExtraConnectionAttributes", "description"=>"Additional attributes associated with the connection", "type"=>"string"}, {"in"=>"query", "name"=>"Password", "description"=>"The password to be used to login to the endpoint database", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port used by the endpoint database", "type"=>"string"}, {"in"=>"query", "name"=>"ServerName", "description"=>"The name of the server where the endpoint database resides", "type"=>"string"}, {"in"=>"query", "name"=>"SslMode", "description"=>"The SSL mode to be used", "type"=>"string"}, {"in"=>"query", "name"=>"Username", "description"=>"The user name to be used to login to the endpoint database", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoints"]}}, "/?Action=ModifyReplicationInstance"=>{"get"=>{"summary"=>"Modify Replication Instance", "description"=>"Modifies the replication instance to apply new settings.", "operationId"=>"modifyReplicationInstance", "x-api-path-slug"=>"actionmodifyreplicationinstance-get", "parameters"=>[{"in"=>"query", "name"=>"AllocatedStorage", "description"=>"The amount of storage (in gigabytes) to be allocated for the replication instance", "type"=>"string"}, {"in"=>"query", "name"=>"AllowMajorVersionUpgrade", "description"=>"Indicates that major version upgrades are allowed", "type"=>"string"}, {"in"=>"query", "name"=>"ApplyImmediately", "description"=>"Indicates whether the changes should be applied immediately or during the next maintenance window", "type"=>"string"}, {"in"=>"query", "name"=>"AutoMinorVersionUpgrade", "description"=>"Indicates that minor version upgrades will be applied automatically to the replication instance during the maintenance window", "type"=>"string"}, {"in"=>"query", "name"=>"EngineVersion", "description"=>"The engine version number of the replication instance", "type"=>"string"}, {"in"=>"query", "name"=>"MultiAZ", "description"=>"Specifies if the replication instance is a Multi-AZ deployment", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredMaintenanceWindow", "description"=>"The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationInstanceArn", "description"=>"The Amazon Resource Name (ARN) of the replication instance", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationInstanceClass", "description"=>"The compute and memory capacity of the replication instance", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationInstanceIdentifier", "description"=>"The replication instance identifier", "type"=>"string"}, {"in"=>"query", "name"=>"VpcSecurityGroupIds", "description"=>"Specifies the VPC security group to be used with the replication instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Instances"]}}, "/?Action=ModifyReplicationSubnetGroup"=>{"get"=>{"summary"=>"Modify Replication Subnet Group", "description"=>"Modifies the settings for the specified replication subnet group.", "operationId"=>"modifyReplicationSubnetGroup", "x-api-path-slug"=>"actionmodifyreplicationsubnetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"ReplicationSubnetGroupDescription", "description"=>"The description of the replication instance subnet group", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationSubnetGroupIdentifier", "description"=>"The name of the replication instance subnet group", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetIds", "description"=>"A list of subnet IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Subnet Groups"]}}, "/?Action=ModifyReplicationTask"=>{"get"=>{"summary"=>"Modify Replication Task", "description"=>"Modifies the specified replication task.", "operationId"=>"modifyReplicationTask", "x-api-path-slug"=>"actionmodifyreplicationtask-get", "parameters"=>[{"in"=>"query", "name"=>"CdcStartTime", "description"=>"The start time for the Change Data Capture (CDC) operation", "type"=>"string"}, {"in"=>"query", "name"=>"MigrationType", "description"=>"The migration type", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationTaskArn", "description"=>"The Amazon Resource Name (ARN) of the replication task", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationTaskIdentifier", "description"=>"The replication task identifier", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationTaskSettings", "description"=>"JSON file that contains settings for the task, such as target metadata settings", "type"=>"string"}, {"in"=>"query", "name"=>"TableMappings", "description"=>"The path of the JSON file that contains the table mappings", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Tasks"]}}, "/?Action=RefreshSchemas"=>{"get"=>{"summary"=>"Refresh Schemas", "description"=>"Populates the schema for the specified endpoint.", "operationId"=>"refreshSchemas", "x-api-path-slug"=>"actionrefreshschemas-get", "parameters"=>[{"in"=>"query", "name"=>"EndpointArn", "description"=>"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationInstanceArn", "description"=>"The Amazon Resource Name (ARN) of the replication instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schemas"]}}, "/?Action=RemoveTagsFromResource"=>{"get"=>{"summary"=>"Remove Tags From Resource", "description"=>"Removes metadata tags from a DMS resource.", "operationId"=>"removeTagsFromResource", "x-api-path-slug"=>"actionremovetagsfromresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceArn", "description"=>">The Amazon Resource Name (ARN) of the AWS DMS resource the tag is to be removed from", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys", "description"=>"The tag key (name) of the tag to be removed", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Tags"]}}, "/?Action=StartReplicationTask"=>{"get"=>{"summary"=>"Start Replication Task", "description"=>"Starts the replication task.", "operationId"=>"startReplicationTask", "x-api-path-slug"=>"actionstartreplicationtask-get", "parameters"=>[{"in"=>"query", "name"=>"CdcStartTime", "description"=>"The start time for the Change Data Capture (CDC) operation", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationTaskArn", "description"=>"The Amazon Resource Number (ARN) of the replication task to be started", "type"=>"string"}, {"in"=>"query", "name"=>"StartReplicationTaskType", "description"=>"The type of replication task", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Tasks"]}}, "/?Action=StopReplicationTask"=>{"get"=>{"summary"=>"Stop Replication Task", "description"=>"Stops the replication task.", "operationId"=>"stopReplicationTask", "x-api-path-slug"=>"actionstopreplicationtask-get", "parameters"=>[{"in"=>"query", "name"=>"ReplicationTaskArn", "description"=>"The Amazon Resource Number(ARN) of the replication task to be stopped", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Tasks"]}}, "/?Action=TestConnection"=>{"get"=>{"summary"=>"Test Connection", "description"=>"Tests the connection between the replication instance and the endpoint.", "operationId"=>"testConnection", "x-api-path-slug"=>"actiontestconnection-get", "parameters"=>[{"in"=>"query", "name"=>"EndpointArn", "description"=>"The Amazon Resource Name (ARN) string that uniquely identifies the endpoint", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationInstanceArn", "description"=>"The Amazon Resource Name (ARN) of the replication instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connections"]}}}}, "apis"=>{"name"=>"AWS Database Migration Service", "x-slug"=>"aws-database-migration-service", "description"=>"AWS Database Migration Service helps you migrate databases to AWS easily and securely. The source database remains fully operational during the migration, minimizing downtime to applications that rely on the database. The AWS Database Migration Service can migrate your data to and from most widely used commercial and open-source databases. The service supports homogenous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to Amazon Aurora or Microsoft SQL Server to MySQL. It also allows you to stream data to Amazon Redshift from any of the supported sources including Amazon Aurora, PostgreSQL, MySQL, MariaDB, Oracle, SAP ASE and SQL Server, enabling consolidation and easy analysis of data in the petabyte-scale data warehouse. AWS Database Migration Service can also be used for continuous data replication with high-availability.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Database_AWSDatabaseMigrationService.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Databases,Migrations,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-database-migration-service/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Database Migration Service API", "x-api-slug"=>"aws-database-migration-service-api", "description"=>"AWS Database Migration Service helps you migrate databases to AWS easily and securely. The source database remains fully operational during the migration, minimizing downtime to applications that rely on the database. The AWS Database Migration Service can migrate your data to and from most widely used commercial and open-source databases. The service supports homogenous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to Amazon Aurora or Microsoft SQL Server to MySQL. It also allows you to stream data to Amazon Redshift from any of the supported sources including Amazon Aurora, PostgreSQL, MySQL, MariaDB, Oracle, SAP ASE and SQL Server, enabling consolidation and easy analysis of data in the petabyte-scale data warehouse. AWS Database Migration Service can also be used for continuous data replication with high-availability.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Database_AWSDatabaseMigrationService.png", "humanURL"=>"https://aws.amazon.com/dms/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Databases,Migrations,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-database-migration-service/aws-database-migration-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/dms/latest/APIReference/Welcome.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/dms/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/dms/getting-started/"}, {"type"=>"x-partners", "url"=>"https://aws.amazon.com/dms/partners/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/dms/pricing/"}, {"type"=>"x-schema-conversion", "url"=>"https://aws.amazon.com/dms/#sct"}, {"type"=>"x-testimonials", "url"=>"https://aws.amazon.com/dms/testimonials/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/dms/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
paralleldots{"paralleldots-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"ParallelDots", "x-complete"=>1, "info"=>{"title"=>"ParallelDots AI APIs Docs", "description"=>"our-powerful-deep-learning-powered-apis-can-comprehend-a-huge-amount-of-unstructured-text-and-visual-content-to-empower-your-products-", "version"=>"1.0.0"}, "host"=>"apis.paralleldots.com", "basePath"=>"/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/sentiment"=>{"post"=>{"summary"=>"Sentiment", "description"=>"# Introduction\nWhat does your API do?\n\nSentiment API accepts input text, language code and API key to return a JSON response classifying the input text into a sentiment.\n\n# Overview\nThings that the developers should know about\n\nThe API accepts the input parameters as form-data.Languages supported are German (de), French (fr), Dutch (nl), Italian (it), Spanish (es), Chinese (zh), Portuguese (pt), Japanese (ja), Indonesian (id), Thai (th), Danish (da), Finish (fi)\n\nResponse will be in JSON sorted by confidence score as shown below:\n\n```\n{\n \"probabilities\": {\n \"positive\": 0.241,\n \"neutral\": 0.304,\n \"negative\": 0.454\n },\n \"usage\": \"By accessing ParallelDots API or using information generated by ParallelDots API, you are agreeing to be bound by the ParallelDots API Terms of Use: http://www.paralleldots.com/terms-and-conditions\",\n \"sentiment\": \"negative\"\n}\n```\n\n# Authentication\nWhat is the preferred way of using the API?\n\nAn API key is required to be sent as a parameter to authenticate your requests.\n\n\n# Rate limit\nIs there a limit to the number of requests an user can send?\n\nThere is no rate limit as such but too many concurrent requests will throw 504 time-out error from nginx.", "operationId"=>"SentimentPost", "x-api-path-slug"=>"sentiment-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"lang_code"}, {"in"=>"formData", "name"=>"text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Sentiment"]}}, "/emotion"=>{"post"=>{"summary"=>"Emotion", "description"=>"# Introduction\nWhat does your API do?\n\nSometimes the three classes of sentiment (positive, negative and neutral) are not sufficient to understand the nuances regarding the underlying tone of a sentence. Our Emotion Analysis classifier is trained on our proprietary dataset and tells whether the underlying emotion behind a message is: Happy, Sad, Angry, Fearful, Excited, Funny or Indifferent.\n\n# Overview\nThings that the developers should know about\n\nThe API accepts the input parameters as form-data.Languages supported are German (de), French (fr), Dutch (nl), Italian (it), Spanish (es), Chinese (zh), Portuguese (pt), Japanese (ja), Indonesian (id), Thai (th), Danish (da), Finish (fi)\n\nResponse will be in JSON as shown below:\n\n```\n{\n \"emotion\": {\n \"probabilities\": {\n \"angry\": 0.376,\n \"indifferent\": 0.189,\n \"sad\": 0.381,\n \"excited\": 0.014,\n \"happy\": 0.04\n },\n \"emotion\": \"sad\"\n },\n \"usage\": \"By accessing ParallelDots API or using information generated by ParallelDots API, you are agreeing to be bound by the ParallelDots API Terms of Use: http://www.paralleldots.com/terms-and-conditions\"\n}\n\n```\n\n# Authentication\nWhat is the preferred way of using the API?\n\nAn API key is required to be sent as a parameter to authenticate your requests.\n\n\n# Rate limit\nIs there a limit to the number of requests an user can send?\n\nThere is no rate limit as such but too many concurrent requests will throw 504 time-out error from nginx.", "operationId"=>"EmotionPost", "x-api-path-slug"=>"emotion-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"lang_code"}, {"in"=>"formData", "name"=>"text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Emotion", "Analysis"]}}, "/similarity"=>{"post"=>{"summary"=>"Semantic Similarity", "description"=>"# Introduction\nWhat does your API do?\n\nSemantic Analysis API helps users cluster similar articles by understanding the relatedness between different content and streamlines research by eliminating redundant text contents.\n\n# Overview\nThings that the developers should know about\n\nThe API accepts the input parameters as form-data.\n\nResponse will be in JSON as shown below:\n\n```\n{\n \"usage\": \"By accessing ParallelDots API or using information generated by ParallelDots API, you are agreeing to be bound by the ParallelDots API Terms of Use: http://www.paralleldots.com/terms-and-conditions\",\n \"actual_score\": 0.842932,\n \"normalized_score\": 4.931469\n}\n\n```\n\n# Authentication\nWhat is the preferred way of using the API?\n\nAn API key is required to be sent as a parameter to authenticate your requests.\n\n\n# Rate limit\nIs there a limit to the number of requests an user can send?\n\nThere is no rate limit as such but too many concurrent requests will throw 504 time-out error from nginx.", "operationId"=>"SimilarityPost", "x-api-path-slug"=>"similarity-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"text1"}, {"in"=>"formData", "name"=>"text2"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Semantic", "Similarity", "Analysis"]}}, "/ner"=>{"post"=>{"summary"=>"Name Entity Recognition", "description"=>"# Introduction\nWhat does your API do?\n\nNamed-entity recognition(NER) can identify individuals, companies, places, organization, cities and other various type of entities. API can extract this information from any type of text, web page or social media network.\n\n# Overview\nThings that the developers should know about\n\nThe API accepts the input parameters as form-data.\n\nResponse will be in JSON as shown below:\n\n```\n{\n \"usage\": \"By accessing ParallelDots API or using information generated by ParallelDots API, you are agreeing to be bound by the ParallelDots API Terms of Use: http://www.paralleldots.com/terms-and-conditions\",\n \"entities\": [\n {\n \"category\": \"name\",\n \"name\": \"Donald Trump\",\n \"confidence_score\": 0.977811\n },\n {\n \"category\": \"place\",\n \"name\": \"United States\",\n \"confidence_score\": 0.982107\n }\n ]\n}\n\n```\n\n# Authentication\nWhat is the preferred way of using the API?\n\nAn API key is required to be sent as a parameter to authenticate your requests.\n\n\n# Rate limit\nIs there a limit to the number of requests an user can send?\n\nThere is no rate limit as such but too many concurrent requests will throw 504 time-out error from nginx.", "operationId"=>"NerPost", "x-api-path-slug"=>"ner-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Name", "Entity", "Recognition"]}}, "/keywords"=>{"post"=>{"summary"=>"Keywords", "description"=>"# Introduction\nWhat does your API do?\n\nKeyword Generator are powerful tools in text analysis that can be used to index data, generate tag clouds and accelerate the searching time. It generates an extensive list of relevant keywords and phrases to make research more context focussed.\n\n# Overview\nThings that the developers should know about\n\nThe API accepts the input parameters as form-data.\n\nResponse will be in JSON as shown below:\n\n```\n{\n \"keywords\": [\n {\n \"keyword\": \"Cristiano Ronaldo\",\n \"confidence_score\": 0.887065\n },\n {\n \"keyword\": \"Principality Stadium\",\n \"confidence_score\": 0.903289\n },\n {\n \"keyword\": \"Cardiff last\",\n \"confidence_score\": 0.806802\n },\n {\n \"keyword\": \"couple\",\n \"confidence_score\": 0.69036\n },\n {\n \"keyword\": \"hours\",\n \"confidence_score\": 0.984956\n },\n {\n \"keyword\": \"Real Madrid win\",\n \"confidence_score\": 0.812151\n }\n ],\n \"usage\": \"By accessing ParallelDots API or using information generated by ParallelDots API, you are agreeing to be bound by the ParallelDots API Terms of Use: http://www.paralleldots.com/terms-and-conditions\"\n}\n```\n\n# Authentication\nWhat is the preferred way of using the API?\n\nAn API key is required to be sent as a parameter to authenticate your requests.\n\n\n# Rate limit\nIs there a limit to the number of requests an user can send?\n\nThere is no rate limit as such but too many concurrent requests will throw 504 time-out error from nginx.", "operationId"=>"KeywordsPost", "x-api-path-slug"=>"keywords-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Keywords", "Analysis"]}}, "/taxonomy"=>{"post"=>{"summary"=>"Taxonomy", "description"=>"# Introduction\nWhat does your API do?\n\nText Classification can be useful in understanding customer behaviour by categorizing conversations on social networks, feedback and other web sources.\n\n# Overview\nThings that the developers should know about\n\nThe API accepts the input parameters as form-data.\n\nResponse will be in JSON as shown below:\n\n```\n{\n \"usage\": \"By accessing ParallelDots API or using information generated by ParallelDots API, you are agreeing to be bound by the ParallelDots API Terms of Use: http://www.paralleldots.com/terms-and-conditions\",\n \"taxonomy\": [\n {\n \"tag\": \"News and Politics\",\n \"confidence_score\": 0.576461\n },\n {\n \"tag\": \"Religion & Spirituality\",\n \"confidence_score\": 0.473842\n },\n {\n \"tag\": \"Hobbies & Interests\",\n \"confidence_score\": 0.318032\n }\n ]\n}\n```\n\n# Authentication\nWhat is the preferred way of using the API?\n\nAn API key is required to be sent as a parameter to authenticate your requests.\n\n\n# Rate limit\nIs there a limit to the number of requests an user can send?\n\nThere is no rate limit as such but too many concurrent requests will throw 504 time-out error from nginx.", "operationId"=>"TaxonomyPost", "x-api-path-slug"=>"taxonomy-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Taxonomy"]}}, "/intent"=>{"post"=>{"summary"=>"Intent", "description"=>"# Introduction\nWhat does your API do?\n\nThis classifier tells whether the underlying intention behind a sentence is opinion, news, marketing, complaint, suggestion, apprectiation, query. This is trained on our proprietary dataset.\n\n# Overview\nThings that the developers should know about\n\nThe API accepts the input parameters as form-data.\n\nResponse will be in JSON as shown below:\n\n```\n{\n \"probabilities\": {\n \"marketing\": 0.038,\n \"news\": 0.916,\n \"query\": 0.008,\n \"feedback/opinion\": 0.017,\n \"spam/junk\": 0.02\n },\n \"usage\": \"By accessing ParallelDots API or using information generated by ParallelDots API, you are agreeing to be bound by the ParallelDots API Terms of Use: http://www.paralleldots.com/terms-and-conditions\",\n \"intent\": \"news\"\n}\n\n```\n\n# Authentication\nWhat is the preferred way of using the API?\n\nAn API key is required to be sent as a parameter to authenticate your requests.\n\n\n# Rate limit\nIs there a limit to the number of requests an user can send?\n\nThere is no rate limit as such but too many concurrent requests will throw 504 time-out error from nginx.", "operationId"=>"IntentPost", "x-api-path-slug"=>"intent-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Intent"]}}, "/abuse"=>{"post"=>{"summary"=>"Abuse", "description"=>"# Introduction\nWhat does your API do?\n\nAbusive content specifier specifies whether the content is abusive or not.\n\n# Overview\nThings that the developers should know about\n\nThe API accepts the input parameters as form-data.\n\nResponse will be in JSON as shown below:\n\n```\n{\n \"usage\": \"By accessing ParallelDots API or using information generated by ParallelDots API, you are agreeing to be bound by the ParallelDots API Terms of Use: http://www.paralleldots.com/terms-and-conditions\",\n \"sentence_type\": \"Abusive\",\n \"confidence_score\": 0.953125\n}\n\n```\n\n# Authentication\nWhat is the preferred way of using the API?\n\nAn API key is required to be sent as a parameter to authenticate your requests.\n\n\n# Rate limit\nIs there a limit to the number of requests an user can send?\n\nThere is no rate limit as such but too many concurrent requests will throw 504 time-out error from nginx.", "operationId"=>"AbusePost", "x-api-path-slug"=>"abuse-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Abuse"]}}, "/text_parser"=>{"post"=>{"summary"=>"Text Parser", "description"=>"# Introduction\nWhat does your API do?\n\nUnderstand the text entered by using our API.\n\n# Overview\nThings that the developers should know about\n\nThe API accepts the input parameters as form-data.\n\nResponse will be in JSON as shown below:\n\n```\n{\n \"usage\": \"By accessing ParallelDots API or using information generated by ParallelDots API, you are agreeing to be bound by the ParallelDots API Terms of Use: http://www.paralleldots.com/terms-and-conditions\",\n \"output\": [\n {\n \"text\": \"Donald\",\n \"Dependency\": \"compound\",\n \"Tags\": \"noun\"\n },\n {\n \"text\": \"Trump\",\n \"Dependency\": \"nominal subject\",\n \"Tags\": \"noun\"\n },\n {\n \"text\": \"is\",\n \"Dependency\": \"root\",\n \"Tags\": \"verb\"\n },\n {\n \"text\": \"the\",\n \"Dependency\": \"determiner\",\n \"Tags\": \"determiner\"\n },\n {\n \"text\": \"President\",\n \"Dependency\": \"attribute\",\n \"Tags\": \"noun\"\n },\n {\n \"text\": \"of\",\n \"Dependency\": \"prepositional modifier\",\n \"Tags\": \"preposition or conjunction\"\n },\n {\n \"text\": \"the\",\n \"Dependency\": \"determiner\",\n \"Tags\": \"determiner\"\n },\n {\n \"text\": \"United\",\n \"Dependency\": \"compound\",\n \"Tags\": \"noun\"\n },\n {\n \"text\": \"States\",\n \"Dependency\": \"object of a preposition\",\n \"Tags\": \"noun\"\n },\n {\n \"text\": \"of\",\n \"Dependency\": \"prepositional modifier\",\n \"Tags\": \"preposition or conjunction\"\n },\n {\n \"text\": \"America\",\n \"Dependency\": \"object of a preposition\",\n \"Tags\": \"noun\"\n }\n ]\n}\n\n```\n\n# Authentication\nWhat is the preferred way of using the API?\n\nAn API key is required to be sent as a parameter to authenticate your requests.\n\n\n# Rate limit\nIs there a limit to the number of requests an user can send?\n\nThere is no rate limit as such but too many concurrent requests will throw 504 time-out error from nginx.", "operationId"=>"TextParserPost", "x-api-path-slug"=>"text-parser-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Text", "Parser"]}}, "/custom_classifier"=>{"post"=>{"summary"=>"Custom Classifier", "description"=>"# Introduction\nWhat does your API do?\n\nCustom Classifier API accepts input text, categories with a list of sub-categories and API key to return a JSON response classifying the input text into categories provided.\n\n# Overview\nThings that the developers should know about\n\nThe API accepts the input parameters as form-data. Providing sub-categories is optional, send an empty array ('[]') in case you do want to add any sub-categories to your category.\n\nResponse will be in JSON sorted by confidence score as shown below:\n\n```\n{\n \"usage\": \"By accessing ParallelDots API or using information generated by ParallelDots API, you are agreeing to be bound by the ParallelDots API Terms of Use: http://www.paralleldots.com/terms-and-conditions\",\n \"taxonomy\": [\n {\n \"tag\": \"world politics\",\n \"confidence_score\": 0.622804\n },\n {\n \"tag\": \"finance\",\n \"confidence_score\": 0.325811\n }\n ]\n}\n```\n\n# Authentication\nWhat is the preferred way of using the API?\n\nAn API key is required to be sent as a parameter to authenticate your requests.\n\n\n# Rate limit\nIs there a limit to the number of requests an user can send?\n\nThere is no rate limit as such but too many concurrent requests will throw 504 time-out error from nginx.", "operationId"=>"CustomClassifierPost", "x-api-path-slug"=>"custom-classifier-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"category"}, {"in"=>"formData", "name"=>"text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Custom", "Classifier"]}}, "/popularity"=>{"post"=>{"summary"=>"Virality Detection", "description"=>"# Introduction\nWhat does your API do?\n\nGet the virality score of your picture on socail media. \n\n# Overview\nThings that the developers should know about\n\nThe API accepts the input parameters as form-data.\n\nResponse will be in JSON as shown below:\n\n```\n{\n \"Popular\": \"59.8144471645\",\n \"usage\": \"By accessing ParallelDots API or using information generated by ParallelDots API, you are agreeing to be bound by the ParallelDots API Terms of Use: http://www.paralleldots.com/terms-and-conditions\",\n \"Not Popular\": \"40.1855528355\"\n}\n\n```\n\n# Authentication\nWhat is the preferred way of using the API?\n\nAn API key is required to be sent as a parameter to authenticate your requests.\n\n\n# Rate limit\nIs there a limit to the number of requests an user can send?\n\nThere is no rate limit as such but too many concurrent requests will throw 504 time-out error from nginx.", "operationId"=>"PopularityPost", "x-api-path-slug"=>"popularity-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Virality", "Detection"]}}, "/nsfw"=>{"post"=>{"summary"=>"NSFW", "description"=>"# Introduction\nWhat does your API do?\n\nNudity detection classifier is a powerful tool to filter out pornographic and non-pornographic images from social media feeds, forums, messaging apps, etc.. ParallelDots nudity detection classifier can filter such content and help build a safer platform for your community.\n\n# Overview\nThings that the developers should know about\n\nThe API accepts the input parameters as form-data.\n\nResponse will be in JSON as shown below:\n\n```\n{\n \"usage\": \"By accessing ParallelDots API or using information generated by ParallelDots API, you are agreeing to be bound by the ParallelDots API Terms of Use: http://www.paralleldots.com/terms-and-conditions\",\n \"output\": \"safe to open at work\",\n \"prob\": 0.911244809627533\n}\n\n```\n\n# Authentication\nWhat is the preferred way of using the API?\n\nAn API key is required to be sent as a parameter to authenticate your requests.\n\n\n# Rate limit\nIs there a limit to the number of requests an user can send?\n\nThere is no rate limit as such but too many concurrent requests will throw 504 time-out error from nginx.", "operationId"=>"NsfwPost", "x-api-path-slug"=>"nsfw-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "NSFW"]}}, "/phrase_extractor"=>{"post"=>{"summary"=>"Phrase Extractor", "description"=>"# Introduction\nWhat does your API do?\n\nGet phrase keywords from the text in the input.\n\n# Overview\nThings that the developers should know about\n\nThe API accepts the input parameters as form-data.\n\nResponse will be in JSON as shown below:\n\n```\n{\n \"keywords\": [\n {\n \"relevance_score\": 1,\n \"keyword\": \"Ronaldo\"\n },\n {\n \"relevance_score\": 2,\n \"keyword\": \"Principality Stadium\"\n },\n {\n \"relevance_score\": 1,\n \"keyword\": \"Cardiff\"\n },\n {\n \"relevance_score\": 1,\n \"keyword\": \"last\"\n },\n {\n \"relevance_score\": 1,\n \"keyword\": \"June\"\n },\n {\n \"relevance_score\": 2,\n \"keyword\": \"Real Madrid\"\n },\n {\n \"relevance_score\": 1,\n \"keyword\": \"its\"\n },\n {\n \"relevance_score\": 2,\n \"keyword\": \"third champions\"\n },\n {\n \"relevance_score\": 2,\n \"keyword\": \"League trophy\"\n }\n ],\n \"usage\": \"By accessing ParallelDots API or using information generated by ParallelDots API, you are agreeing to be bound by the ParallelDots API Terms of Use: http://www.paralleldots.com/terms-and-conditions\"\n}\n\n```\n\n# Authentication\nWhat is the preferred way of using the API?\n\nAn API key is required to be sent as a parameter to authenticate your requests.\n\n\n# Rate limit\nIs there a limit to the number of requests an user can send?\n\nThere is no rate limit as such but too many concurrent requests will throw 504 time-out error from nginx.", "operationId"=>"PhraseExtractorPost", "x-api-path-slug"=>"phrase-extractor-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Phrase", "Extractor"]}}, "/multilang_keywords"=>{"post"=>{"summary"=>"Multilang_Keywords", "description"=>"# Introduction\nWhat does your API do?\n\nExtract Keywords from different languages using this API.\n\n# Overview\nThings that the developers should know about\n\nThe API accepts the input parameters as form-data.The API works best when input long and multiple sentences.Languages supported are German(de), French(fr), Dutch(nl), Italian(it), Spanish(es), Portuguese(pt), Danish(da), Finish(fi)\nResponse will be in JSON as shown below:\n\n```\n{\n \"keywords\": [\n {\n \"relevance_score\": 4,\n \"keyword\": \"Prime Minister Narendra Modi\"\n },\n {\n \"relevance_score\": 6,\n \"keyword\": \"Human Resource Development Minister Smriti Irani\"\n },\n {\n \"relevance_score\": 2,\n \"keyword\": \"Lok Sabha\"\n },\n {\n \"relevance_score\": 1,\n \"keyword\": \"ongoing\"\n },\n {\n \"relevance_score\": 2,\n \"keyword\": \"JNU row\"\n },\n {\n \"relevance_score\": 2,\n \"keyword\": \"Dalit scholar\"\n },\n {\n \"relevance_score\": 2,\n \"keyword\": \"Rohith Vemula\"\n },\n {\n \"relevance_score\": 3,\n \"keyword\": \"Hyderabad Central University\"\n }\n ],\n \"usage\": \"By accessing ParallelDots API or using information generated by ParallelDots API, you are agreeing to be bound by the ParallelDots API Terms of Use: http://www.paralleldots.com/terms-and-conditions\"\n}\n\n```\n\n# Authentication\nWhat is the preferred way of using the API?\n\nAn API key is required to be sent as a parameter to authenticate your requests.\n\n\n# Rate limit\nIs there a limit to the number of requests an user can send?\n\nThere is no rate limit as such but too many concurrent requests will throw 504 time-out error from nginx.", "operationId"=>"MultilangKeywordsPost", "x-api-path-slug"=>"multilang-keywords-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"lang_code"}, {"in"=>"formData", "name"=>"text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Multilang_Keywords"]}}}}, "apis"=>{"name"=>"ParallelDots", "x-slug"=>"paralleldots", "description"=>"ParallelDots is one of the best applied AI research groups in the world. We work with enterprises globally to tackle challenging business problems and create the winners of tomorrow. We also provide AI consulting services to explore the what, why, how and who about deploying AI in businesses. Try-out our cutting edge text analysis APIs and join the community of 1,000+ global users. Contact us at contact@paralleldots.com and tell us about the challenging business problems that you are facing.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/paralleldots-logo.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"Machine Learning,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"paralleldots/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"ParallelDots", "x-api-slug"=>"paralleldots", "description"=>"ParallelDots is one of the best applied AI research groups in the world. We work with enterprises globally to tackle challenging business problems and create the winners of tomorrow. We also provide AI consulting services to explore the what, why, how and who about deploying AI in businesses. Try-out our cutting edge text analysis APIs and join the community of 1,000+ global users. Contact us at contact@paralleldots.com and tell us about the challenging business problems that you are facing.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/paralleldots-logo.png", "humanURL"=>"https://www.paralleldots.com/", "baseURL"=>"https://apis.paralleldots.com//v3", "tags"=>"Machine Learning,Relative Data,Service API", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/paralleldots/paralleldots-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://blog.paralleldots.com/"}, {"type"=>"x-developer", "url"=>"https://www.paralleldots.com/ai-apis"}, {"type"=>"x-documentation", "url"=>"https://docs.paralleldots.com/"}, {"type"=>"x-faq", "url"=>"https://www.paralleldots.com/frequently-asked-questions"}, {"type"=>"x-github", "url"=>"https://github.com/ParallelDots"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/3572541/"}, {"type"=>"x-openapi-gist", "url"=>"https://gist.githubusercontent.com/kinlane/18095af6f37b04ffada94a3378ad9e8b/raw/8ce934fcf5ac1be679873ad12df8ed00b7c750e6/paralleldots-ai-api-openapi.json"}, {"type"=>"x-pricing", "url"=>"https://www.paralleldots.com/pricing"}, {"type"=>"x-terms-of-service", "url"=>"https://www.paralleldots.com/terms-and-conditions"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/ParallelDots"}, {"type"=>"x-website", "url"=>"https://www.paralleldots.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
groupon{"groupon-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Groupon", "x-complete"=>1, "info"=>{"title"=>"Groupon API2", "description"=>"put-all-those-great-ideas-for-groupon-improvements-extensions-and-multipleplatform-interfaces-to-work-", "version"=>"v2"}, "host"=>"api.groupon.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/status.{format}"=>{"parameters"=>{"summary"=>"Parameters Status. Format", "description"=>"Parameters status. format.", "operationId"=>"parametersStatus.Format", "x-api-path-slug"=>"status-format-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Status", "Format"]}, "get"=>{"summary"=>"Get Status. Format", "description"=>"Returns the status of Groupon's API and all the currently available versions of the API.", "operationId"=>"getStatus.Format", "x-api-path-slug"=>"status-format-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Status", "Format"]}}, "/divisions.{format}"=>{"parameters"=>{"summary"=>"Parameters Divisions. Format", "description"=>"Parameters divisions. format.", "operationId"=>"parametersDivisions.Format", "x-api-path-slug"=>"divisions-format-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Divisions", "Format"]}, "get"=>{"summary"=>"Get Divisions. Format", "description"=>"Returns the list of all launched divisions.", "operationId"=>"getDivisions.Format", "x-api-path-slug"=>"divisions-format-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Divisions", "Format"]}}, "/groupon_says.{format}"=>{"parameters"=>{"summary"=>"Parameters Groupon Says. Format", "description"=>"Parameters groupon says. format.", "operationId"=>"parametersGrouponSays.Format", "x-api-path-slug"=>"groupon-says-format-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groupon", "Says", "Format"]}, "get"=>{"summary"=>"Get Groupon Says. Format", "description"=>"Returns the list of recent (or random) Groupon Says commentaries.", "operationId"=>"getGrouponSays.Format", "x-api-path-slug"=>"groupon-says-format-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groupon", "Says", "Format"]}}, "/deals/{id}.{format}"=>{"parameters"=>{"summary"=>"Parameters Deals . Format", "description"=>"Parameters deals . format.", "operationId"=>"parametersDeals.Format", "x-api-path-slug"=>"dealsid-format-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deals", "Format"]}, "get"=>{"summary"=>"Get Deals . Format", "description"=>"Returns the detailed information about a specified deal.", "operationId"=>"getDeals.Format", "x-api-path-slug"=>"dealsid-format-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deals", "Format"]}}, "/deals.{format}"=>{"parameters"=>{"summary"=>"Parameters Deals. Format", "description"=>"Parameters deals. format.", "operationId"=>"parametersDeals.Format", "x-api-path-slug"=>"deals-format-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deals", "Format"]}, "get"=>{"summary"=>"Get Deals. Format", "description"=>"Returns an ordered list of deals that are currently launched for a specific division.", "operationId"=>"getDeals.Format", "x-api-path-slug"=>"deals-format-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deals", "Format"]}}, "/deals/{deal_id}/posts.{format}"=>{"parameters"=>{"summary"=>"Parameters Deals Deal Adds. Format", "description"=>"Parameters deals deal adds. format.", "operationId"=>"parametersDealsDealAdds.Format", "x-api-path-slug"=>"dealsdeal-idposts-format-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deals", "Deal", "Posts", "Format"]}, "get"=>{"summary"=>"Get Deals Deal Adds. Format", "description"=>"Returns the lists of all the discussion posts for the specified deal.", "operationId"=>"getDealsDealAdds.Format", "x-api-path-slug"=>"dealsdeal-idposts-format-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deals", "Deal", "Posts", "Format"]}}}}, "apis"=>{"name"=>"Groupon", "x-slug"=>"groupon", "description"=>"Register for a Groupon API key (client_id) to develop your own Groupon applications. Now, you can put all those great ideas for Groupon improvements, extensions, and multiple-platform interfaces to work.", "image"=>"http://upload.wikimedia.org/wikipedia/commons/thumb/c/cc/Groupon_logo.png/320px-Groupon_logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Provider,Coupons,Coupons,General Data,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"groupon/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Groupon", "x-api-slug"=>"groupon", "description"=>"Register for a Groupon API key (client_id) to develop your own Groupon applications. Now, you can put all those great ideas for Groupon improvements, extensions, and multiple-platform interfaces to work.", "image"=>"http://upload.wikimedia.org/wikipedia/commons/thumb/c/cc/Groupon_logo.png/320px-Groupon_logo.png", "humanURL"=>"http://www.groupon.com/", "baseURL"=>"https://api.groupon.com//", "tags"=>"API Provider,Coupons,Coupons,General Data,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/groupon/groupon-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-api-json--authoritative", "url"=>"http://apis.io/apisdef/legacy/groupon.json"}, {"type"=>"x-affiliate", "url"=>"https://sites.google.com/site/grouponapiv2/api-usage/commission-junction-link-guide"}, {"type"=>"x-branding", "url"=>"http://www.groupon.com/pages/api-branding-requirements"}, {"type"=>"x-developer", "url"=>"http://www.groupon.com/pages/api"}, {"type"=>"x-error-codes", "url"=>"https://sites.google.com/site/grouponapiv2/error-reporting"}, {"type"=>"x-forum", "url"=>"http://groups.google.com/group/grouponapi?hl=en"}, {"type"=>"x-selfservice-registration", "url"=>"https://www.groupon.com/session/new"}, {"type"=>"x-terms-of-service", "url"=>"http://www.groupon.com/pages/api-terms-of-use"}, {"type"=>"x-website", "url"=>"http://www.groupon.com/"}, {"type"=>"x-website", "url"=>"http://groupon.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
reverb{"reverb-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Reverb", "x-complete"=>1, "info"=>{"title"=>"reverb", "description"=>"reverb", "termsOfService"=>"https://reverb.com/page/terms", "contact"=>{"name"=>"Reverb API", "url"=>"https://dev.reverb.com", "email"=>"integrations@reverb.com"}, "version"=>"3.0"}, "host"=>"api.reverb.com", "basePath"=>"/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/articles"=>{"get"=>{"summary"=>"Get Articles", "description"=>"Get articles.", "operationId"=>"getArticles", "x-api-path-slug"=>"articles-get", "parameters"=>[{"in"=>"query", "name"=>"exclude_featured", "description"=>"Number of featured articles to exclude"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}, {"in"=>"query", "name"=>"query", "description"=>"Whats being searched for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Articles"]}}, "/categories"=>{"get"=>{"summary"=>"Get Categories", "description"=>"List of supported product categories", "operationId"=>"getCategories", "x-api-path-slug"=>"categories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories"]}}, "/categories/flat"=>{"get"=>{"summary"=>"Get Categories Flat", "description"=>"Get categories flat.", "operationId"=>"getCategoriesFlat", "x-api-path-slug"=>"categoriesflat-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories", "Flat"]}}, "/categories/taxonomy"=>{"get"=>{"summary"=>"Get Categories Taxonomy", "description"=>"Full taxonomy tree of categories including middle categories", "operationId"=>"getCategoriesTaxonomy", "x-api-path-slug"=>"categoriestaxonomy-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories", "Taxonomy"]}}, "/categories/{product_type}/{category}"=>{"get"=>{"summary"=>"Get Categories Product Type Category", "description"=>"Get categories product type category.", "operationId"=>"getCategoriesProductTypeCategory", "x-api-path-slug"=>"categoriesproduct-typecategory-get", "parameters"=>[{"in"=>"path", "name"=>"category"}, {"in"=>"path", "name"=>"product_type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories", "Product", "Type", "Category"]}}, "/categories/{uuid}"=>{"get"=>{"summary"=>"Get Categories Uu", "description"=>"Get category details", "operationId"=>"getCategoriesUu", "x-api-path-slug"=>"categoriesuuid-get", "parameters"=>[{"in"=>"path", "name"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories", "Uuid"]}}, "/comparison_shopping_pages"=>{"get"=>{"summary"=>"Get Comparison Shopping Pages", "description"=>"Returns a set of comparison shopping pages based on the current params", "operationId"=>"getComparisonShoppingPages", "x-api-path-slug"=>"comparison-shopping-pages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comparison", "Shopping", "Pages"]}}, "/comparison_shopping_pages/find"=>{"get"=>{"summary"=>"Get Comparison Shopping Pages Find", "description"=>"Get comparison shopping pages find.", "operationId"=>"getComparisonShoppingPagesFind", "x-api-path-slug"=>"comparison-shopping-pagesfind-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"ID of the comparison shopping page"}, {"in"=>"query", "name"=>"slug", "description"=>"Slug of the comparison shopping page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comparison", "Shopping", "Pages", "Find"]}}, "/comparison_shopping_pages/{id}"=>{"get"=>{"summary"=>"Get Comparison Shopping Pages", "description"=>"Get comparison shopping pages.", "operationId"=>"getComparisonShoppingPages", "x-api-path-slug"=>"comparison-shopping-pagesid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comparison", "Shopping", "Pages", "Id"]}}, "/comparison_shopping_pages/{id}/listings"=>{"get"=>{"summary"=>"Get Comparison Shopping Pages Listings", "description"=>"Return new or used listings for a comparison shopping page", "operationId"=>"getComparisonShoppingPagesListings", "x-api-path-slug"=>"comparison-shopping-pagesidlistings-get", "parameters"=>[{"in"=>"query", "name"=>"condition", "description"=>"Condition of the listing"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comparison", "Shopping", "Pages", "Id", "Listings"]}}, "/comparison_shopping_pages/{id}/reviews"=>{"get"=>{"summary"=>"Get Comparison Shopping Pages Reviews", "description"=>"View reviews of a comparison shopping page", "operationId"=>"getComparisonShoppingPagesReviews", "x-api-path-slug"=>"comparison-shopping-pagesidreviews-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comparison", "Shopping", "Pages", "Id", "Reviews"]}}, "/conversations/{conversation_id}/offer"=>{"post"=>{"summary"=>"Post Conversations Conversation Offer", "description"=>"Make an offer to the other participant in the conversation", "operationId"=>"postConversationsConversationOffer", "x-api-path-slug"=>"conversationsconversation-idoffer-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"conversation_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversations", "Conversation", "Id", "Offer"]}}, "/conversations/{id}/offer"=>{"post"=>{"summary"=>"Post Conversations Offer", "description"=>"Make an offer to the other participant in the conversation", "operationId"=>"postConversationsOffer", "x-api-path-slug"=>"conversationsidoffer-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversations", "Id", "Offer"]}}, "/countries"=>{"get"=>{"summary"=>"Get Countries", "description"=>"Retrieve a list of country codes with corresponding subregions", "operationId"=>"getCountries", "x-api-path-slug"=>"countries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countries"]}}, "/csps"=>{"get"=>{"summary"=>"Get Csps", "description"=>"Returns a set of comparison shopping pages based on the current params", "operationId"=>"getCsps", "x-api-path-slug"=>"csps-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Csps"]}}, "/csps/categories"=>{"get"=>{"summary"=>"Get Csps Categories", "description"=>"Get csps categories.", "operationId"=>"getCspsCategories", "x-api-path-slug"=>"cspscategories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Csps", "Categories"]}}, "/curated_sets/{slug}"=>{"get"=>{"summary"=>"Get Curated Sets Slug", "description"=>"Get curated sets slug.", "operationId"=>"getCuratedSetsSlug", "x-api-path-slug"=>"curated-setsslug-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Curated", "Sets", "Slug"]}}, "/currencies/display"=>{"get"=>{"summary"=>"Get Currencies Display", "description"=>"List of supported display currencies for browsing listings", "operationId"=>"getCurrenciesDisplay", "x-api-path-slug"=>"currenciesdisplay-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Currencies", "Display"]}}, "/currencies/listing"=>{"get"=>{"summary"=>"Get Currencies Listing", "description"=>"List of supported listing currencies for shops", "operationId"=>"getCurrenciesListing", "x-api-path-slug"=>"currencieslisting-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Currencies", "Listing"]}}, "/feedback/{feedback_id}"=>{"get"=>{"summary"=>"Get Feedback Feedback", "description"=>"Get feedback feedback.", "operationId"=>"getFeedbackFeedback", "x-api-path-slug"=>"feedbackfeedback-id-get", "parameters"=>[{"in"=>"path", "name"=>"feedback_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feedback", "Feedback", "Id"]}}, "/handpicked/{slug}"=>{"get"=>{"summary"=>"Get Handpicked Slug", "description"=>"Get results from a handpicked collection", "operationId"=>"getHandpickedSlug", "x-api-path-slug"=>"handpickedslug-get", "parameters"=>[{"in"=>"query", "name"=>"accepts_gift_cards", "description"=>"If true, include only items that accept gift cards"}, {"in"=>"query", "name"=>"accepts_payment_plans", "description"=>"If true, only show items that can be purchased with a payment plan"}, {"in"=>"query", "name"=>"auction_price_max", "description"=>"Maximum current auction price"}, {"in"=>"query", "name"=>"category", "description"=>"Category slug from /api/categories"}, {"in"=>"query", "name"=>"conditions", "description"=>"Condition: all,new,b-stock,used,non-functioning"}, {"in"=>"query", "name"=>"currency", "description"=>"The currency to be used for the price filters"}, {"in"=>"query", "name"=>"decade", "description"=>"Decade: e"}, {"in"=>"query", "name"=>"exclude_auctions", "description"=>"If true, exclude auctions"}, {"in"=>"query", "name"=>"finish", "description"=>"Visual finish of the item, common for guitars"}, {"in"=>"query", "name"=>"handmade", "description"=>"Handmade items only"}, {"in"=>"query", "name"=>"item_city", "description"=>"City where item is located"}, {"in"=>"query", "name"=>"item_country", "description"=>"DEPRECATED - Country code where item is located"}, {"in"=>"query", "name"=>"item_region", "description"=>"Country code where item is located"}, {"in"=>"query", "name"=>"item_state", "description"=>"State or region code where item is located"}, {"in"=>"query", "name"=>"listing_type", "description"=>"Type of listing: auctions,offers"}, {"in"=>"query", "name"=>"make", "description"=>"Make(s)/brand of item (e"}, {"in"=>"query", "name"=>"model", "description"=>"Model of item (e"}, {"in"=>"query", "name"=>"must_not", "description"=>"Search term negation"}, {"in"=>"query", "name"=>"not_ids", "description"=>"Listing ID negation"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}, {"in"=>"query", "name"=>"preferred_seller", "description"=>"If true, include only items by Reverb Preferred Sellers"}, {"in"=>"query", "name"=>"price_max", "description"=>"Maximum price of search results (USD)"}, {"in"=>"query", "name"=>"price_min", "description"=>"Minimum price of search results (USD)"}, {"in"=>"query", "name"=>"product_type", "description"=>"Product type slug from /api/categories"}, {"in"=>"query", "name"=>"query", "description"=>"Search query"}, {"in"=>"query", "name"=>"ships_to", "description"=>"Limit search to items that ship to this country code"}, {"in"=>"query", "name"=>"shop", "description"=>"Slug of shop to search"}, {"in"=>"query", "name"=>"shop_id", "description"=>"ID of shop to search"}, {"in"=>"path", "name"=>"slug"}, {"in"=>"query", "name"=>"watchers_count_min", "description"=>"Minimum number of watchers (used to find popular items)"}, {"in"=>"query", "name"=>"year_max", "description"=>"Maximum year of manufacture"}, {"in"=>"query", "name"=>"year_min", "description"=>"Minumum year of manufacture"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Handpicked", "Slug"]}}, "/listing_conditions"=>{"get"=>{"summary"=>"Get Listing Conditions", "description"=>"List of supported product conditions", "operationId"=>"getListingConditions", "x-api-path-slug"=>"listing-conditions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listing", "Conditions"]}}, "/listings"=>{"get"=>{"summary"=>"Get Listings", "description"=>"Default search of listings includes only used & handmade. Add a filter to view all listings or use the /listings/all endpoint.", "operationId"=>"getListings", "x-api-path-slug"=>"listings-get", "parameters"=>[{"in"=>"query", "name"=>"accepts_gift_cards", "description"=>"If true, include only items that accept gift cards"}, {"in"=>"query", "name"=>"accepts_payment_plans", "description"=>"If true, only show items that can be purchased with a payment plan"}, {"in"=>"query", "name"=>"auction_price_max", "description"=>"Maximum current auction price"}, {"in"=>"query", "name"=>"category", "description"=>"Category slug from /api/categories"}, {"in"=>"query", "name"=>"conditions", "description"=>"Condition: all,new,b-stock,used,non-functioning"}, {"in"=>"query", "name"=>"currency", "description"=>"The currency to be used for the price filters"}, {"in"=>"query", "name"=>"decade", "description"=>"Decade: e"}, {"in"=>"query", "name"=>"exclude_auctions", "description"=>"If true, exclude auctions"}, {"in"=>"query", "name"=>"finish", "description"=>"Visual finish of the item, common for guitars"}, {"in"=>"query", "name"=>"handmade", "description"=>"Handmade items only"}, {"in"=>"query", "name"=>"item_city", "description"=>"City where item is located"}, {"in"=>"query", "name"=>"item_country", "description"=>"DEPRECATED - Country code where item is located"}, {"in"=>"query", "name"=>"item_region", "description"=>"Country code where item is located"}, {"in"=>"query", "name"=>"item_state", "description"=>"State or region code where item is located"}, {"in"=>"query", "name"=>"listing_type", "description"=>"Type of listing: auctions,offers"}, {"in"=>"query", "name"=>"make", "description"=>"Make(s)/brand of item (e"}, {"in"=>"query", "name"=>"model", "description"=>"Model of item (e"}, {"in"=>"query", "name"=>"must_not", "description"=>"Search term negation"}, {"in"=>"query", "name"=>"not_ids", "description"=>"Listing ID negation"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}, {"in"=>"query", "name"=>"preferred_seller", "description"=>"If true, include only items by Reverb Preferred Sellers"}, {"in"=>"query", "name"=>"price_max", "description"=>"Maximum price of search results (USD)"}, {"in"=>"query", "name"=>"price_min", "description"=>"Minimum price of search results (USD)"}, {"in"=>"query", "name"=>"product_type", "description"=>"Product type slug from /api/categories"}, {"in"=>"query", "name"=>"query", "description"=>"Search query"}, {"in"=>"query", "name"=>"ships_to", "description"=>"Limit search to items that ship to this country code"}, {"in"=>"query", "name"=>"shop", "description"=>"Slug of shop to search"}, {"in"=>"query", "name"=>"shop_id", "description"=>"ID of shop to search"}, {"in"=>"query", "name"=>"watchers_count_min", "description"=>"Minimum number of watchers (used to find popular items)"}, {"in"=>"query", "name"=>"year_max", "description"=>"Maximum year of manufacture"}, {"in"=>"query", "name"=>"year_min", "description"=>"Minumum year of manufacture"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings"]}, "post"=>{"summary"=>"Post Listings", "description"=>"Create a listing", "operationId"=>"postListings", "x-api-path-slug"=>"listings-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings"]}}, "/listings/all"=>{"get"=>{"summary"=>"Get Listings All", "description"=>"All listings including used, handmade, and brand new", "operationId"=>"getListingsAll", "x-api-path-slug"=>"listingsall-get", "parameters"=>[{"in"=>"query", "name"=>"accepts_gift_cards", "description"=>"If true, include only items that accept gift cards"}, {"in"=>"query", "name"=>"accepts_payment_plans", "description"=>"If true, only show items that can be purchased with a payment plan"}, {"in"=>"query", "name"=>"auction_price_max", "description"=>"Maximum current auction price"}, {"in"=>"query", "name"=>"category", "description"=>"Category slug from /api/categories"}, {"in"=>"query", "name"=>"conditions", "description"=>"Condition: all,new,b-stock,used,non-functioning"}, {"in"=>"query", "name"=>"currency", "description"=>"The currency to be used for the price filters"}, {"in"=>"query", "name"=>"decade", "description"=>"Decade: e"}, {"in"=>"query", "name"=>"exclude_auctions", "description"=>"If true, exclude auctions"}, {"in"=>"query", "name"=>"finish", "description"=>"Visual finish of the item, common for guitars"}, {"in"=>"query", "name"=>"handmade", "description"=>"Handmade items only"}, {"in"=>"query", "name"=>"item_city", "description"=>"City where item is located"}, {"in"=>"query", "name"=>"item_country", "description"=>"DEPRECATED - Country code where item is located"}, {"in"=>"query", "name"=>"item_region", "description"=>"Country code where item is located"}, {"in"=>"query", "name"=>"item_state", "description"=>"State or region code where item is located"}, {"in"=>"query", "name"=>"listing_type", "description"=>"Type of listing: auctions,offers"}, {"in"=>"query", "name"=>"make", "description"=>"Make(s)/brand of item (e"}, {"in"=>"query", "name"=>"model", "description"=>"Model of item (e"}, {"in"=>"query", "name"=>"must_not", "description"=>"Search term negation"}, {"in"=>"query", "name"=>"not_ids", "description"=>"Listing ID negation"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}, {"in"=>"query", "name"=>"preferred_seller", "description"=>"If true, include only items by Reverb Preferred Sellers"}, {"in"=>"query", "name"=>"price_max", "description"=>"Maximum price of search results (USD)"}, {"in"=>"query", "name"=>"price_min", "description"=>"Minimum price of search results (USD)"}, {"in"=>"query", "name"=>"product_type", "description"=>"Product type slug from /api/categories"}, {"in"=>"query", "name"=>"query", "description"=>"Search query"}, {"in"=>"query", "name"=>"ships_to", "description"=>"Limit search to items that ship to this country code"}, {"in"=>"query", "name"=>"shop", "description"=>"Slug of shop to search"}, {"in"=>"query", "name"=>"shop_id", "description"=>"ID of shop to search"}, {"in"=>"query", "name"=>"watchers_count_min", "description"=>"Minimum number of watchers (used to find popular items)"}, {"in"=>"query", "name"=>"year_max", "description"=>"Maximum year of manufacture"}, {"in"=>"query", "name"=>"year_min", "description"=>"Minumum year of manufacture"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings"]}}, "/listings/facets/seller_location"=>{"get"=>{"summary"=>"Get Listings Facets Seller Location", "description"=>"Get listings facets seller location.", "operationId"=>"getListingsFacetsSellerLocation", "x-api-path-slug"=>"listingsfacetsseller-location-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Facets", "Seller", "Location"]}}, "/listings/{id}/negotiation"=>{"get"=>{"summary"=>"Get Listings Negotiation", "description"=>"Returns the latest negotiation for the requesting user given a listing id", "operationId"=>"getListingsNegotiation", "x-api-path-slug"=>"listingsidnegotiation-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Id", "Negotiation"]}}, "/listings/{id}/offer"=>{"post"=>{"summary"=>"Post Listings Offer", "description"=>"Make an offer to the seller of a listing", "operationId"=>"postListingsOffer", "x-api-path-slug"=>"listingsidoffer-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Id", "Offer"]}}, "/listings/{listing_id}/bump"=>{"get"=>{"summary"=>"Get Listings Listing Bump", "description"=>"View available bump tiers and stats for a listing", "operationId"=>"getListingsListingBump", "x-api-path-slug"=>"listingslisting-idbump-get", "parameters"=>[{"in"=>"path", "name"=>"listing_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Listing", "Id", "Bump"]}}, "/listings/{listing_id}/bump/{budget_type}"=>{"post"=>{"summary"=>"Post Listings Listing Bump Budget Type", "description"=>"Post listings listing bump budget type.", "operationId"=>"postListingsListingBumpBudgetType", "x-api-path-slug"=>"listingslisting-idbumpbudget-type-post", "parameters"=>[{"in"=>"path", "name"=>"budget_type"}, {"in"=>"path", "name"=>"listing_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Listing", "Id", "Bump", "Budget", "Type"]}}, "/listings/{listing_id}/conversations"=>{"post"=>{"summary"=>"Post Listings Listing Conversations", "description"=>"Post listings listing conversations.", "operationId"=>"postListingsListingConversations", "x-api-path-slug"=>"listingslisting-idconversations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"listing_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Listing", "Id", "Conversations"]}}, "/listings/{listing_id}/images"=>{"get"=>{"summary"=>"Get Listings Listing Images", "description"=>"View the images associated with a particular listing", "operationId"=>"getListingsListingImages", "x-api-path-slug"=>"listingslisting-idimages-get", "parameters"=>[{"in"=>"path", "name"=>"listing_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Listing", "Id", "Images"]}}, "/listings/{listing_id}/images/{image_id}"=>{"delete"=>{"summary"=>"Delete Listings Listing Images Image", "description"=>"Delete listings listing images image.", "operationId"=>"deleteListingsListingImagesImage", "x-api-path-slug"=>"listingslisting-idimagesimage-id-delete", "parameters"=>[{"in"=>"path", "name"=>"image_id"}, {"in"=>"path", "name"=>"listing_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Listing", "Id", "Images", "Image", "Id"]}}, "/listings/{listing_id}/product_bundle"=>{"get"=>{"summary"=>"Get Listings Listing Product Bundle", "description"=>"Find a product bundle attached to a listing", "operationId"=>"getListingsListingProductBundle", "x-api-path-slug"=>"listingslisting-idproduct-bundle-get", "parameters"=>[{"in"=>"query", "name"=>"for_seller", "description"=>"Pass to see non-live bundles as the seller"}, {"in"=>"path", "name"=>"listing_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Listing", "Id", "Product", "Bundle"]}}, "/listings/{listing_id}/sales"=>{"get"=>{"summary"=>"Get Listings Listing Sales", "description"=>"See all sales that include a listing.", "operationId"=>"getListingsListingSales", "x-api-path-slug"=>"listingslisting-idsales-get", "parameters"=>[{"in"=>"path", "name"=>"listing_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Listing", "Id", "Sales"]}}, "/listings/{slug}"=>{"delete"=>{"summary"=>"Delete Listings Slug", "description"=>"Delete a draft listing. Cannot be used on non-drafts.", "operationId"=>"deleteListingsSlug", "x-api-path-slug"=>"listingsslug-delete", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Slug"]}, "get"=>{"summary"=>"Get Listings Slug", "description"=>"Get listings slug.", "operationId"=>"getListingsSlug", "x-api-path-slug"=>"listingsslug-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Slug"]}, "put"=>{"summary"=>"Put Listings Slug", "description"=>"Put listings slug.", "operationId"=>"putListingsSlug", "x-api-path-slug"=>"listingsslug-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Slug"]}}, "/listings/{slug}/edit"=>{"get"=>{"summary"=>"Get Listings Slug Edit", "description"=>"Get listings slug edit.", "operationId"=>"getListingsSlugEdit", "x-api-path-slug"=>"listingsslugedit-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Slug", "Edit"]}}, "/listings/{slug}/flag"=>{"post"=>{"summary"=>"Post Listings Slug Flag", "description"=>"Flag a listing for inappropriate content or fraud", "operationId"=>"postListingsSlugFlag", "x-api-path-slug"=>"listingsslugflag-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Slug", "Flag"]}}, "/listings/{slug}/reviews"=>{"get"=>{"summary"=>"Get Listings Slug Reviews", "description"=>"Get listings slug reviews.", "operationId"=>"getListingsSlugReviews", "x-api-path-slug"=>"listingsslugreviews-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Slug", "Reviews"]}, "post"=>{"summary"=>"Post Listings Slug Reviews", "description"=>"Create a review for a listing", "operationId"=>"postListingsSlugReviews", "x-api-path-slug"=>"listingsslugreviews-post", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Slug", "Reviews"]}}, "/listings/{slug}/similar_listings"=>{"get"=>{"summary"=>"Get Listings Slug Similar Listings", "description"=>"Get listings slug similar listings.", "operationId"=>"getListingsSlugSimilarListings", "x-api-path-slug"=>"listingsslugsimilar-listings-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listings", "Slug", "Similar", "Listings"]}}, "/my/account"=>{"get"=>{"summary"=>"Get My Account", "description"=>"Get account details", "operationId"=>"getMyAccount", "x-api-path-slug"=>"myaccount-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Account"]}, "put"=>{"summary"=>"Put My Account", "description"=>"Update account details", "operationId"=>"putMyAccount", "x-api-path-slug"=>"myaccount-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Account"]}}, "/my/addresses"=>{"get"=>{"summary"=>"Get My Addresses", "description"=>"See all addresses in your address book", "operationId"=>"getMyAddresses", "x-api-path-slug"=>"myaddresses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Addresses"]}, "post"=>{"summary"=>"Post My Addresses", "description"=>"Create a new address in your address book", "operationId"=>"postMyAddresses", "x-api-path-slug"=>"myaddresses-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Addresses"]}}, "/my/addresses/{address_id}"=>{"delete"=>{"summary"=>"Delete My Addresses Address", "description"=>"Delete an existing address in your address book", "operationId"=>"deleteMyAddressesAddress", "x-api-path-slug"=>"myaddressesaddress-id-delete", "parameters"=>[{"in"=>"path", "name"=>"address_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Addresses", "Address", "Id"]}, "put"=>{"summary"=>"Put My Addresses Address", "description"=>"Update an existing address in your address book", "operationId"=>"putMyAddressesAddress", "x-api-path-slug"=>"myaddressesaddress-id-put", "parameters"=>[{"in"=>"path", "name"=>"address_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Addresses", "Address", "Id"]}}, "/my/conversations"=>{"get"=>{"summary"=>"Get My Conversations", "description"=>"Get a list of your conversations", "operationId"=>"getMyConversations", "x-api-path-slug"=>"myconversations-get", "parameters"=>[{"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}, {"in"=>"query", "name"=>"search", "description"=>"Query string to search conversations by"}, {"in"=>"query", "name"=>"unread_only", "description"=>"Show unread conversations only"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Conversations"]}, "post"=>{"summary"=>"Post My Conversations", "description"=>"Post my conversations.", "operationId"=>"postMyConversations", "x-api-path-slug"=>"myconversations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Conversations"]}}, "/my/conversations/{conversation_id}/messages"=>{"post"=>{"summary"=>"Post My Conversations Conversation Messages", "description"=>"Post my conversations conversation messages.", "operationId"=>"postMyConversationsConversationMessages", "x-api-path-slug"=>"myconversationsconversation-idmessages-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"conversation_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Conversations", "Conversation", "Id", "Messages"]}}, "/my/conversations/{id}"=>{"get"=>{"summary"=>"Get My Conversations", "description"=>"Display conversation details with messages in natural time order (oldest to newest)", "operationId"=>"getMyConversations", "x-api-path-slug"=>"myconversationsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Conversations", "Id"]}, "put"=>{"summary"=>"Put My Conversations", "description"=>"Mark a conversation read/unread", "operationId"=>"putMyConversations", "x-api-path-slug"=>"myconversationsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Conversations", "Id"]}}, "/my/counts"=>{"get"=>{"summary"=>"Get My Counts", "description"=>"Get your actionable status counts", "operationId"=>"getMyCounts", "x-api-path-slug"=>"mycounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Counts"]}}, "/my/curated_set/product/{product_id}"=>{"delete"=>{"summary"=>"Delete My Curated Set Product Product", "description"=>"Delete my curated set product product.", "operationId"=>"deleteMyCuratedSetProductProduct", "x-api-path-slug"=>"mycurated-setproductproduct-id-delete", "parameters"=>[{"in"=>"path", "name"=>"product_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Curated", "Set", "Product", "Product", "Id"]}, "post"=>{"summary"=>"Post My Curated Set Product Product", "description"=>"Post my curated set product product.", "operationId"=>"postMyCuratedSetProductProduct", "x-api-path-slug"=>"mycurated-setproductproduct-id-post", "parameters"=>[{"in"=>"path", "name"=>"product_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Curated", "Set", "Product", "Product", "Id"]}}, "/my/feed"=>{"get"=>{"summary"=>"Get My Feed", "description"=>"Get listings from your feed", "operationId"=>"getMyFeed", "x-api-path-slug"=>"myfeed-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Feed"]}}, "/my/feed/customize"=>{"get"=>{"summary"=>"Get My Feed Customize", "description"=>"get your feed customization options", "operationId"=>"getMyFeedCustomize", "x-api-path-slug"=>"myfeedcustomize-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Feed", "Customize"]}}, "/my/feed/grid"=>{"get"=>{"summary"=>"Get My Feed Gr", "description"=>"Get my feed gr.", "operationId"=>"getMyFeedGr", "x-api-path-slug"=>"myfeedgrid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Feed", "Grid"]}}, "/my/feedback/received"=>{"get"=>{"summary"=>"Get My Feedback Received", "description"=>"List of received feedback", "operationId"=>"getMyFeedbackReceived", "x-api-path-slug"=>"myfeedbackreceived-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Feedback", "Received"]}}, "/my/feedback/sent"=>{"get"=>{"summary"=>"Get My Feedback Sent", "description"=>"List of sent feedback", "operationId"=>"getMyFeedbackSent", "x-api-path-slug"=>"myfeedbacksent-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Feedback", "Sent"]}}, "/my/follows"=>{"get"=>{"summary"=>"Get My Follows", "description"=>"See what the user is following", "operationId"=>"getMyFollows", "x-api-path-slug"=>"myfollows-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows"]}}, "/my/follows/articles"=>{"get"=>{"summary"=>"Get My Follows Articles", "description"=>"Returns a user's ArticleCategoryFollows", "operationId"=>"getMyFollowsArticles", "x-api-path-slug"=>"myfollowsarticles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Articles"]}, "post"=>{"summary"=>"Post My Follows Articles", "description"=>"Set a user's ArticleCategoryFollows", "operationId"=>"postMyFollowsArticles", "x-api-path-slug"=>"myfollowsarticles-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Articles"]}}, "/my/follows/brands/{slug}"=>{"delete"=>{"summary"=>"Delete My Follows Brands Slug", "description"=>"Delete my follows brands slug.", "operationId"=>"deleteMyFollowsBrandsSlug", "x-api-path-slug"=>"myfollowsbrandsslug-delete", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Brands", "Slug"]}, "get"=>{"summary"=>"Get My Follows Brands Slug", "description"=>"Get my follows brands slug.", "operationId"=>"getMyFollowsBrandsSlug", "x-api-path-slug"=>"myfollowsbrandsslug-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Brands", "Slug"]}, "post"=>{"summary"=>"Post My Follows Brands Slug", "description"=>"Post my follows brands slug.", "operationId"=>"postMyFollowsBrandsSlug", "x-api-path-slug"=>"myfollowsbrandsslug-post", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Brands", "Slug"]}}, "/my/follows/categories/{category}/{subcategory}"=>{"delete"=>{"summary"=>"Delete My Follows Categories Category Subcategory", "description"=>"Delete my follows categories category subcategory.", "operationId"=>"deleteMyFollowsCategoriesCategorySubcategory", "x-api-path-slug"=>"myfollowscategoriescategorysubcategory-delete", "parameters"=>[{"in"=>"path", "name"=>"category"}, {"in"=>"path", "name"=>"subcategory"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Categories", "Category", "Subcategory"]}, "get"=>{"summary"=>"Get My Follows Categories Category Subcategory", "description"=>"Get my follows categories category subcategory.", "operationId"=>"getMyFollowsCategoriesCategorySubcategory", "x-api-path-slug"=>"myfollowscategoriescategorysubcategory-get", "parameters"=>[{"in"=>"path", "name"=>"category"}, {"in"=>"path", "name"=>"subcategory"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Categories", "Category", "Subcategory"]}, "post"=>{"summary"=>"Post My Follows Categories Category Subcategory", "description"=>"Post my follows categories category subcategory.", "operationId"=>"postMyFollowsCategoriesCategorySubcategory", "x-api-path-slug"=>"myfollowscategoriescategorysubcategory-post", "parameters"=>[{"in"=>"path", "name"=>"category"}, {"in"=>"path", "name"=>"subcategory"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Categories", "Category", "Subcategory"]}}, "/my/follows/categories/{identifier}"=>{"delete"=>{"summary"=>"Delete My Follows Categories Entifier", "description"=>"Delete my follows categories entifier.", "operationId"=>"deleteMyFollowsCategoriesEntifier", "x-api-path-slug"=>"myfollowscategoriesidentifier-delete", "parameters"=>[{"in"=>"path", "name"=>"identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Categories", "Identifier"]}, "get"=>{"summary"=>"Get My Follows Categories Entifier", "description"=>"Get my follows categories entifier.", "operationId"=>"getMyFollowsCategoriesEntifier", "x-api-path-slug"=>"myfollowscategoriesidentifier-get", "parameters"=>[{"in"=>"path", "name"=>"identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Categories", "Identifier"]}, "post"=>{"summary"=>"Post My Follows Categories Entifier", "description"=>"Post my follows categories entifier.", "operationId"=>"postMyFollowsCategoriesEntifier", "x-api-path-slug"=>"myfollowscategoriesidentifier-post", "parameters"=>[{"in"=>"path", "name"=>"identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Categories", "Identifier"]}}, "/my/follows/collections/{slug}"=>{"delete"=>{"summary"=>"Delete My Follows Collections Slug", "description"=>"Delete my follows collections slug.", "operationId"=>"deleteMyFollowsCollectionsSlug", "x-api-path-slug"=>"myfollowscollectionsslug-delete", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Collections", "Slug"]}, "get"=>{"summary"=>"Get My Follows Collections Slug", "description"=>"Get my follows collections slug.", "operationId"=>"getMyFollowsCollectionsSlug", "x-api-path-slug"=>"myfollowscollectionsslug-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Collections", "Slug"]}, "post"=>{"summary"=>"Post My Follows Collections Slug", "description"=>"Post my follows collections slug.", "operationId"=>"postMyFollowsCollectionsSlug", "x-api-path-slug"=>"myfollowscollectionsslug-post", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Collections", "Slug"]}}, "/my/follows/handpicked/{slug}"=>{"delete"=>{"summary"=>"Delete My Follows Handpicked Slug", "description"=>"Delete my follows handpicked slug.", "operationId"=>"deleteMyFollowsHandpickedSlug", "x-api-path-slug"=>"myfollowshandpickedslug-delete", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Handpicked", "Slug"]}, "get"=>{"summary"=>"Get My Follows Handpicked Slug", "description"=>"Follow status for a handpicked collection", "operationId"=>"getMyFollowsHandpickedSlug", "x-api-path-slug"=>"myfollowshandpickedslug-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Handpicked", "Slug"]}, "post"=>{"summary"=>"Post My Follows Handpicked Slug", "description"=>"Post my follows handpicked slug.", "operationId"=>"postMyFollowsHandpickedSlug", "x-api-path-slug"=>"myfollowshandpickedslug-post", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Handpicked", "Slug"]}}, "/my/follows/search"=>{"get"=>{"summary"=>"Get My Follows Search", "description"=>"Follow status for a search", "operationId"=>"getMyFollowsSearch", "x-api-path-slug"=>"myfollowssearch-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Search"]}, "post"=>{"summary"=>"Post My Follows Search", "description"=>"Post my follows search.", "operationId"=>"postMyFollowsSearch", "x-api-path-slug"=>"myfollowssearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Search"]}}, "/my/follows/shops/{slug}"=>{"delete"=>{"summary"=>"Delete My Follows Shops Slug", "description"=>"Delete my follows shops slug.", "operationId"=>"deleteMyFollowsShopsSlug", "x-api-path-slug"=>"myfollowsshopsslug-delete", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Shops", "Slug"]}, "get"=>{"summary"=>"Get My Follows Shops Slug", "description"=>"Get my follows shops slug.", "operationId"=>"getMyFollowsShopsSlug", "x-api-path-slug"=>"myfollowsshopsslug-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Shops", "Slug"]}, "post"=>{"summary"=>"Post My Follows Shops Slug", "description"=>"Post my follows shops slug.", "operationId"=>"postMyFollowsShopsSlug", "x-api-path-slug"=>"myfollowsshopsslug-post", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Shops", "Slug"]}}, "/my/follows/{follow_id}"=>{"delete"=>{"summary"=>"Delete My Follows Follow", "description"=>"Delete my follows follow.", "operationId"=>"deleteMyFollowsFollow", "x-api-path-slug"=>"myfollowsfollow-id-delete", "parameters"=>[{"in"=>"path", "name"=>"follow_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Follow", "Id"]}}, "/my/follows/{follow_id}/alert"=>{"delete"=>{"summary"=>"Delete My Follows Follow Alert", "description"=>"Delete my follows follow alert.", "operationId"=>"deleteMyFollowsFollowAlert", "x-api-path-slug"=>"myfollowsfollow-idalert-delete", "parameters"=>[{"in"=>"path", "name"=>"follow_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Follow", "Id", "Alert"]}, "post"=>{"summary"=>"Post My Follows Follow Alert", "description"=>"Post my follows follow alert.", "operationId"=>"postMyFollowsFollowAlert", "x-api-path-slug"=>"myfollowsfollow-idalert-post", "parameters"=>[{"in"=>"path", "name"=>"follow_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Follows", "Follow", "Id", "Alert"]}}, "/my/listings"=>{"get"=>{"summary"=>"Get My Listings", "description"=>"Retrieve a list of live listings for the seller. To search all listings specify state=all", "operationId"=>"getMyListings", "x-api-path-slug"=>"mylistings-get", "parameters"=>[{"in"=>"query", "name"=>"accepts_gift_cards", "description"=>"If true, include only items that accept gift cards"}, {"in"=>"query", "name"=>"accepts_payment_plans", "description"=>"If true, only show items that can be purchased with a payment plan"}, {"in"=>"query", "name"=>"auction_price_max", "description"=>"Maximum current auction price"}, {"in"=>"query", "name"=>"category", "description"=>"Category slug from /api/categories"}, {"in"=>"query", "name"=>"conditions", "description"=>"Condition: all,new,b-stock,used,non-functioning"}, {"in"=>"query", "name"=>"currency", "description"=>"The currency to be used for the price filters"}, {"in"=>"query", "name"=>"decade", "description"=>"Decade: e"}, {"in"=>"query", "name"=>"exclude_auctions", "description"=>"If true, exclude auctions"}, {"in"=>"query", "name"=>"finish", "description"=>"Visual finish of the item, common for guitars"}, {"in"=>"query", "name"=>"handmade", "description"=>"Handmade items only"}, {"in"=>"query", "name"=>"item_city", "description"=>"City where item is located"}, {"in"=>"query", "name"=>"item_country", "description"=>"DEPRECATED - Country code where item is located"}, {"in"=>"query", "name"=>"item_region", "description"=>"Country code where item is located"}, {"in"=>"query", "name"=>"item_state", "description"=>"State or region code where item is located"}, {"in"=>"query", "name"=>"listing_type", "description"=>"Type of listing: auctions,offers"}, {"in"=>"query", "name"=>"make", "description"=>"Make(s)/brand of item (e"}, {"in"=>"query", "name"=>"model", "description"=>"Model of item (e"}, {"in"=>"query", "name"=>"must_not", "description"=>"Search term negation"}, {"in"=>"query", "name"=>"not_ids", "description"=>"Listing ID negation"}, {"in"=>"query", "name"=>"preferred_seller", "description"=>"If true, include only items by Reverb Preferred Sellers"}, {"in"=>"query", "name"=>"price_max", "description"=>"Maximum price of search results (USD)"}, {"in"=>"query", "name"=>"price_min", "description"=>"Minimum price of search results (USD)"}, {"in"=>"query", "name"=>"product_type", "description"=>"Product type slug from /api/categories"}, {"in"=>"query", "name"=>"query", "description"=>"Search query"}, {"in"=>"query", "name"=>"ships_to", "description"=>"Limit search to items that ship to this country code"}, {"in"=>"query", "name"=>"shop", "description"=>"Slug of shop to search"}, {"in"=>"query", "name"=>"shop_id", "description"=>"ID of shop to search"}, {"in"=>"query", "name"=>"sku", "description"=>"Find a listing by sku"}, {"in"=>"query", "name"=>"state", "description"=>"Available: [all, draft, ended, live, ordered, sold_out, suspended, seller_unavailable]"}, {"in"=>"query", "name"=>"watchers_count_min", "description"=>"Minimum number of watchers (used to find popular items)"}, {"in"=>"query", "name"=>"year_max", "description"=>"Maximum year of manufacture"}, {"in"=>"query", "name"=>"year_min", "description"=>"Minumum year of manufacture"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Listings"]}}, "/my/listings/drafts"=>{"get"=>{"summary"=>"Get My Listings Drafts", "description"=>"Retrieve a list your draft listings", "operationId"=>"getMyListingsDrafts", "x-api-path-slug"=>"mylistingsdrafts-get", "parameters"=>[{"in"=>"query", "name"=>"accepts_gift_cards", "description"=>"If true, include only items that accept gift cards"}, {"in"=>"query", "name"=>"accepts_payment_plans", "description"=>"If true, only show items that can be purchased with a payment plan"}, {"in"=>"query", "name"=>"auction_price_max", "description"=>"Maximum current auction price"}, {"in"=>"query", "name"=>"category", "description"=>"Category slug from /api/categories"}, {"in"=>"query", "name"=>"conditions", "description"=>"Condition: all,new,b-stock,used,non-functioning"}, {"in"=>"query", "name"=>"currency", "description"=>"The currency to be used for the price filters"}, {"in"=>"query", "name"=>"decade", "description"=>"Decade: e"}, {"in"=>"query", "name"=>"exclude_auctions", "description"=>"If true, exclude auctions"}, {"in"=>"query", "name"=>"finish", "description"=>"Visual finish of the item, common for guitars"}, {"in"=>"query", "name"=>"handmade", "description"=>"Handmade items only"}, {"in"=>"query", "name"=>"item_city", "description"=>"City where item is located"}, {"in"=>"query", "name"=>"item_country", "description"=>"DEPRECATED - Country code where item is located"}, {"in"=>"query", "name"=>"item_region", "description"=>"Country code where item is located"}, {"in"=>"query", "name"=>"item_state", "description"=>"State or region code where item is located"}, {"in"=>"query", "name"=>"listing_type", "description"=>"Type of listing: auctions,offers"}, {"in"=>"query", "name"=>"make", "description"=>"Make(s)/brand of item (e"}, {"in"=>"query", "name"=>"model", "description"=>"Model of item (e"}, {"in"=>"query", "name"=>"must_not", "description"=>"Search term negation"}, {"in"=>"query", "name"=>"not_ids", "description"=>"Listing ID negation"}, {"in"=>"query", "name"=>"preferred_seller", "description"=>"If true, include only items by Reverb Preferred Sellers"}, {"in"=>"query", "name"=>"price_max", "description"=>"Maximum price of search results (USD)"}, {"in"=>"query", "name"=>"price_min", "description"=>"Minimum price of search results (USD)"}, {"in"=>"query", "name"=>"product_type", "description"=>"Product type slug from /api/categories"}, {"in"=>"query", "name"=>"query", "description"=>"Search query"}, {"in"=>"query", "name"=>"ships_to", "description"=>"Limit search to items that ship to this country code"}, {"in"=>"query", "name"=>"shop", "description"=>"Slug of shop to search"}, {"in"=>"query", "name"=>"shop_id", "description"=>"ID of shop to search"}, {"in"=>"query", "name"=>"watchers_count_min", "description"=>"Minimum number of watchers (used to find popular items)"}, {"in"=>"query", "name"=>"year_max", "description"=>"Maximum year of manufacture"}, {"in"=>"query", "name"=>"year_min", "description"=>"Minumum year of manufacture"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Listings", "Drafts"]}}, "/my/listings/negotiations"=>{"get"=>{"summary"=>"Get My Listings Negotiations", "description"=>"Get a list of active negotiations as a seller", "operationId"=>"getMyListingsNegotiations", "x-api-path-slug"=>"mylistingsnegotiations-get", "parameters"=>[{"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Listings", "Negotiations"]}}, "/my/listings/{slug}/state/end"=>{"put"=>{"summary"=>"Put My Listings Slug State End", "description"=>"Put my listings slug state end.", "operationId"=>"putMyListingsSlugStateEnd", "x-api-path-slug"=>"mylistingsslugstateend-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Listings", "Slug", "State", "End"]}}, "/my/lists"=>{"get"=>{"summary"=>"Get My Lists", "description"=>"Get a list of your lists (wishlist, watch list, etc)", "operationId"=>"getMyLists", "x-api-path-slug"=>"mylists-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Lists"]}}, "/my/negotiations/buying"=>{"get"=>{"summary"=>"Get My Negotiations Buying", "description"=>"Get a list of active negotiations as a buyer", "operationId"=>"getMyNegotiationsBuying", "x-api-path-slug"=>"mynegotiationsbuying-get", "parameters"=>[{"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Negotiations", "Buying"]}}, "/my/negotiations/{id}"=>{"get"=>{"summary"=>"Get My Negotiations", "description"=>"Get my negotiations.", "operationId"=>"getMyNegotiations", "x-api-path-slug"=>"mynegotiationsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Negotiations", "Id"]}}, "/my/negotiations/{id}/accept"=>{"post"=>{"summary"=>"Post My Negotiations Accept", "description"=>"Post my negotiations accept.", "operationId"=>"postMyNegotiationsAccept", "x-api-path-slug"=>"mynegotiationsidaccept-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Negotiations", "Id", "Accept"]}}, "/my/negotiations/{id}/counter"=>{"post"=>{"summary"=>"Post My Negotiations Counter", "description"=>"Post my negotiations counter.", "operationId"=>"postMyNegotiationsCounter", "x-api-path-slug"=>"mynegotiationsidcounter-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Negotiations", "Id", "Counter"]}}, "/my/negotiations/{id}/decline"=>{"post"=>{"summary"=>"Post My Negotiations Decline", "description"=>"Post my negotiations decline.", "operationId"=>"postMyNegotiationsDecline", "x-api-path-slug"=>"mynegotiationsiddecline-post", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Negotiations", "Id", "Decline"]}}, "/my/orders/awaiting_feedback"=>{"get"=>{"summary"=>"Get My Orders Awaiting Feedback", "description"=>"List of orders that need feedback", "operationId"=>"getMyOrdersAwaitingFeedback", "x-api-path-slug"=>"myordersawaiting-feedback-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Orders", "Awaiting", "Feedback"]}}, "/my/orders/buying/all"=>{"get"=>{"summary"=>"Get My Orders Buying All", "description"=>"Returns all orders, newest first.", "operationId"=>"getMyOrdersBuyingAll", "x-api-path-slug"=>"myordersbuyingall-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Orders", "Buying"]}}, "/my/orders/buying/unpaid"=>{"get"=>{"summary"=>"Get My Orders Buying Unpa", "description"=>"Returns unpaid orders, newest first.", "operationId"=>"getMyOrdersBuyingUnpa", "x-api-path-slug"=>"myordersbuyingunpaid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Orders", "Buying", "Unpaid"]}}, "/my/orders/buying/{id}"=>{"get"=>{"summary"=>"Get My Orders Buying", "description"=>"Returns order details for a buyer", "operationId"=>"getMyOrdersBuying", "x-api-path-slug"=>"myordersbuyingid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Orders", "Buying", "Id"]}}, "/my/orders/buying/{id}/mark_received"=>{"post"=>{"summary"=>"Post My Orders Buying Mark Received", "description"=>"Marks an order as received by the buyer", "operationId"=>"postMyOrdersBuyingMarkReceived", "x-api-path-slug"=>"myordersbuyingidmark-received-post", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Orders", "Buying", "Id", "Mark", "Received"]}}, "/my/orders/selling/all"=>{"get"=>{"summary"=>"Get My Orders Selling All", "description"=>"Get all seller orders, newest first.", "operationId"=>"getMyOrdersSellingAll", "x-api-path-slug"=>"myorderssellingall-get", "parameters"=>[{"in"=>"query", "name"=>"created_end_date", "description"=>"Filter by date created in ISO8601 format - e"}, {"in"=>"query", "name"=>"created_start_date", "description"=>"Filter by date created in ISO8601 format - e"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}, {"in"=>"query", "name"=>"updated_end_date", "description"=>"Filter by date modified in ISO8601 format - e"}, {"in"=>"query", "name"=>"updated_start_date", "description"=>"Filter by date modified in ISO8601 format - e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Orders", "Selling"]}}, "/my/orders/selling/awaiting_shipment"=>{"get"=>{"summary"=>"Get My Orders Selling Awaiting Shipment", "description"=>"Get seller orders awaiting shipment, newest first.", "operationId"=>"getMyOrdersSellingAwaitingShipment", "x-api-path-slug"=>"myorderssellingawaiting-shipment-get", "parameters"=>[{"in"=>"query", "name"=>"created_end_date", "description"=>"Filter by date created in ISO8601 format - e"}, {"in"=>"query", "name"=>"created_start_date", "description"=>"Filter by date created in ISO8601 format - e"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}, {"in"=>"query", "name"=>"updated_end_date", "description"=>"Filter by date modified in ISO8601 format - e"}, {"in"=>"query", "name"=>"updated_start_date", "description"=>"Filter by date modified in ISO8601 format - e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Orders", "Selling", "Awaiting", "Shipment"]}}, "/my/orders/selling/buyer_history/{buyer_id}"=>{"get"=>{"summary"=>"Get My Orders Selling Buyer History Buyer", "description"=>"Get my orders selling buyer history buyer.", "operationId"=>"getMyOrdersSellingBuyerHistoryBuyer", "x-api-path-slug"=>"myorderssellingbuyer-historybuyer-id-get", "parameters"=>[{"in"=>"path", "name"=>"buyer_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Orders", "Selling", "Buyer", "History", "Buyer", "Id"]}}, "/my/orders/selling/unpaid"=>{"get"=>{"summary"=>"Get My Orders Selling Unpa", "description"=>"Get unpaid seller orders, newest first.", "operationId"=>"getMyOrdersSellingUnpa", "x-api-path-slug"=>"myorderssellingunpaid-get", "parameters"=>[{"in"=>"query", "name"=>"created_end_date", "description"=>"Filter by date created in ISO8601 format - e"}, {"in"=>"query", "name"=>"created_start_date", "description"=>"Filter by date created in ISO8601 format - e"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}, {"in"=>"query", "name"=>"updated_end_date", "description"=>"Filter by date modified in ISO8601 format - e"}, {"in"=>"query", "name"=>"updated_start_date", "description"=>"Filter by date modified in ISO8601 format - e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Orders", "Selling", "Unpaid"]}}, "/my/orders/selling/{id}"=>{"get"=>{"summary"=>"Get My Orders Selling", "description"=>"Returns order details for a seller", "operationId"=>"getMyOrdersSelling", "x-api-path-slug"=>"myorderssellingid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Orders", "Selling", "Id"]}}, "/my/orders/selling/{id}/mark_picked_up"=>{"post"=>{"summary"=>"Post My Orders Selling Mark Picked Up", "description"=>"Post my orders selling mark picked up.", "operationId"=>"postMyOrdersSellingMarkPickedUp", "x-api-path-slug"=>"myorderssellingidmark-picked-up-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Orders", "Selling", "Id", "Mark", "Picked", "Up"]}}, "/my/orders/selling/{id}/ship"=>{"post"=>{"summary"=>"Post My Orders Selling Ship", "description"=>"Post my orders selling ship.", "operationId"=>"postMyOrdersSellingShip", "x-api-path-slug"=>"myorderssellingidship-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Orders", "Selling", "Id", "Ship"]}}, "/my/orders/selling/{order_id}/refund_requests"=>{"post"=>{"summary"=>"Post My Orders Selling Order Refund Requests", "description"=>"Post my orders selling order refund requests.", "operationId"=>"postMyOrdersSellingOrderRefundRequests", "x-api-path-slug"=>"myorderssellingorder-idrefund-requests-post", "parameters"=>[{"in"=>"path", "name"=>"order_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Orders", "Selling", "Order", "Id", "Refund", "Requests"]}}, "/my/payments/selling"=>{"get"=>{"summary"=>"Get My Payments Selling", "description"=>"Get my payments selling.", "operationId"=>"getMyPaymentsSelling", "x-api-path-slug"=>"mypaymentsselling-get", "parameters"=>[{"in"=>"query", "name"=>"created_end_date", "description"=>"Filter by date created in ISO8601 format - e"}, {"in"=>"query", "name"=>"created_start_date", "description"=>"Filter by date created in ISO8601 format - e"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"order_id", "description"=>"Look up payments by order id"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"per_page"}, {"in"=>"query", "name"=>"updated_end_date", "description"=>"Filter by date modified in ISO8601 format - e"}, {"in"=>"query", "name"=>"updated_start_date", "description"=>"Filter by date modified in ISO8601 format - e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Payments", "Selling"]}}, "/my/payments/selling/{id}"=>{"get"=>{"summary"=>"Get My Payments Selling", "description"=>"Get my payments selling.", "operationId"=>"getMyPaymentsSelling", "x-api-path-slug"=>"mypaymentssellingid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Payments", "Selling", "Id"]}}, "/my/payouts"=>{"get"=>{"summary"=>"Get My Payouts", "description"=>"Get a list of payouts", "operationId"=>"getMyPayouts", "x-api-path-slug"=>"mypayouts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Payouts"]}}, "/my/payouts/{id}/line_items"=>{"get"=>{"summary"=>"Get My Payouts Line Items", "description"=>"Read the line items of a payout", "operationId"=>"getMyPayoutsLineItems", "x-api-path-slug"=>"mypayoutsidline-items-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Payouts", "Id", "Line", "Items"]}}, "/my/refund_requests/selling"=>{"get"=>{"summary"=>"Get My Refund Requests Selling", "description"=>"Get a list of refund requests as a seller", "operationId"=>"getMyRefundRequestsSelling", "x-api-path-slug"=>"myrefund-requestsselling-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Refund", "Requests", "Selling"]}}, "/my/refund_requests/selling/{id}"=>{"put"=>{"summary"=>"Put My Refund Requests Selling", "description"=>"Update a refund request for a sold order", "operationId"=>"putMyRefundRequestsSelling", "x-api-path-slug"=>"myrefund-requestssellingid-put", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Refund", "Requests", "Selling", "Id"]}}, "/my/viewed_listings"=>{"get"=>{"summary"=>"Get My Viewed Listings", "description"=>"Get a list of your recently viewed listings.", "operationId"=>"getMyViewedListings", "x-api-path-slug"=>"myviewed-listings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Viewed", "Listings"]}}, "/my/wishlist"=>{"get"=>{"summary"=>"Get My Wishlist", "description"=>"Get a list of wishlisted items", "operationId"=>"getMyWishlist", "x-api-path-slug"=>"mywishlist-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Wishlist"]}}, "/my/wishlist/{id}"=>{"delete"=>{"summary"=>"Delete My Wishlist", "description"=>"Remove a listing from your wishlist", "operationId"=>"deleteMyWishlist", "x-api-path-slug"=>"mywishlistid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Wishlist", "Id"]}, "put"=>{"summary"=>"Put My Wishlist", "description"=>"Add a listing to your wishlist", "operationId"=>"putMyWishlist", "x-api-path-slug"=>"mywishlistid-put", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Wishlist", "Id"]}}, "/orders/{order_id}/feedback/buyer"=>{"get"=>{"summary"=>"Get Orders Order Feedback Buyer", "description"=>"Feedback details for an order's buyer", "operationId"=>"getOrdersOrderFeedbackBuyer", "x-api-path-slug"=>"ordersorder-idfeedbackbuyer-get", "parameters"=>[{"in"=>"path", "name"=>"order_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Order", "Id", "Feedback", "Buyer"]}, "post"=>{"summary"=>"Post Orders Order Feedback Buyer", "description"=>"Add feedback about an order's buyer", "operationId"=>"postOrdersOrderFeedbackBuyer", "x-api-path-slug"=>"ordersorder-idfeedbackbuyer-post", "parameters"=>[{"in"=>"path", "name"=>"order_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Order", "Id", "Feedback", "Buyer"]}}, "/orders/{order_id}/feedback/seller"=>{"get"=>{"summary"=>"Get Orders Order Feedback Seller", "description"=>"Feedback details for an order's seller", "operationId"=>"getOrdersOrderFeedbackSeller", "x-api-path-slug"=>"ordersorder-idfeedbackseller-get", "parameters"=>[{"in"=>"path", "name"=>"order_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Order", "Id", "Feedback", "Seller"]}, "post"=>{"summary"=>"Post Orders Order Feedback Seller", "description"=>"Add feedback about an order's seller", "operationId"=>"postOrdersOrderFeedbackSeller", "x-api-path-slug"=>"ordersorder-idfeedbackseller-post", "parameters"=>[{"in"=>"path", "name"=>"order_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Order", "Id", "Feedback", "Seller"]}}, "/payment_methods"=>{"get"=>{"summary"=>"Get Payment Methods", "description"=>"Get list of payment methods", "operationId"=>"getPaymentMethods", "x-api-path-slug"=>"payment-methods-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment", "Methods"]}}, "/priceguide"=>{"get"=>{"summary"=>"Get Pricegue", "description"=>"Search the Price Guide", "operationId"=>"getPricegue", "x-api-path-slug"=>"priceguide-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"Search query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Priceguide"]}}, "/priceguide/{id}"=>{"get"=>{"summary"=>"Get Pricegue", "description"=>"Retrieve a Price Guide", "operationId"=>"getPricegue", "x-api-path-slug"=>"priceguideid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Priceguide", "Id"]}}, "/priceguide/{id}/transactions"=>{"get"=>{"summary"=>"Get Pricegue Transactions", "description"=>"Get a list of paginated transactions for a price guide.", "operationId"=>"getPricegueTransactions", "x-api-path-slug"=>"priceguideidtransactions-get", "parameters"=>[{"in"=>"query", "name"=>"condition"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Priceguide", "Id", "Transactions"]}}, "/priceguide/{id}/transactions/summary"=>{"get"=>{"summary"=>"Get Pricegue Transactions Summary", "description"=>"Get a summary of transactions for a given price guide", "operationId"=>"getPricegueTransactionsSummary", "x-api-path-slug"=>"priceguideidtransactionssummary-get", "parameters"=>[{"in"=>"query", "name"=>"condition"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"number_of_months"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Priceguide", "Id", "Transactions", "Summary"]}}, "/products/reviews/{id}"=>{"get"=>{"summary"=>"Get Products Reviews", "description"=>"Get products reviews.", "operationId"=>"getProductsReviews", "x-api-path-slug"=>"productsreviewsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Reviews", "Id"]}, "put"=>{"summary"=>"Put Products Reviews", "description"=>"Put products reviews.", "operationId"=>"putProductsReviews", "x-api-path-slug"=>"productsreviewsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Reviews", "Id"]}}, "/products/{slug}/reviews"=>{"get"=>{"summary"=>"Get Products Slug Reviews", "description"=>"View reviews of a comparison shopping page", "operationId"=>"getProductsSlugReviews", "x-api-path-slug"=>"productsslugreviews-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Slug", "Reviews"]}, "post"=>{"summary"=>"Post Products Slug Reviews", "description"=>"Create a review for a product", "operationId"=>"postProductsSlugReviews", "x-api-path-slug"=>"productsslugreviews-post", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Slug", "Reviews"]}}, "/sales/reverb"=>{"get"=>{"summary"=>"Get Sales Reverb", "description"=>"View upcoming and live Reverb official sales.", "operationId"=>"getSalesReverb", "x-api-path-slug"=>"salesreverb-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Reverb"]}}, "/sales/seller"=>{"get"=>{"summary"=>"Get Sales Seller", "description"=>"View your created sales.", "operationId"=>"getSalesSeller", "x-api-path-slug"=>"salesseller-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Seller"]}}, "/sales/{sale_id}/listings"=>{"delete"=>{"summary"=>"Delete Sales Sale Listings", "description"=>"Remove a listing from a sale", "operationId"=>"deleteSalesSaleListings", "x-api-path-slug"=>"salessale-idlistings-delete", "parameters"=>[{"in"=>"path", "name"=>"sale_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Sale", "Id", "Listings"]}, "post"=>{"summary"=>"Post Sales Sale Listings", "description"=>"Post sales sale listings.", "operationId"=>"postSalesSaleListings", "x-api-path-slug"=>"salessale-idlistings-post", "parameters"=>[{"in"=>"path", "name"=>"sale_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Sale", "Id", "Listings"]}}, "/sales/{slug}"=>{"get"=>{"summary"=>"Get Sales Slug", "description"=>"Get sales slug.", "operationId"=>"getSalesSlug", "x-api-path-slug"=>"salesslug-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sales", "Slug"]}}, "/shipping/providers"=>{"get"=>{"summary"=>"Get Shipping Provers", "description"=>"List of supported shipping providers", "operationId"=>"getShippingProvers", "x-api-path-slug"=>"shippingproviders-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Providers"]}}, "/shipping/regions"=>{"get"=>{"summary"=>"Get Shipping Regions", "description"=>"Get shipping regions.", "operationId"=>"getShippingRegions", "x-api-path-slug"=>"shippingregions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Regions"]}}, "/shop"=>{"get"=>{"summary"=>"Get Shop", "description"=>"Get your own shop details", "operationId"=>"getShop", "x-api-path-slug"=>"shop-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop"]}, "put"=>{"summary"=>"Put Shop", "description"=>"Update your shop profile", "operationId"=>"putShop", "x-api-path-slug"=>"shop-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop"]}}, "/shop/listing_conditions"=>{"get"=>{"summary"=>"Get Shop Listing Conditions", "description"=>"List of supported product conditions", "operationId"=>"getShopListingConditions", "x-api-path-slug"=>"shoplisting-conditions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Listing", "Conditions"]}}, "/shop/payment_methods"=>{"get"=>{"summary"=>"Get Shop Payment Methods", "description"=>"Get accepted payment methods", "operationId"=>"getShopPaymentMethods", "x-api-path-slug"=>"shoppayment-methods-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Payment", "Methods"]}}, "/shop/vacation"=>{"delete"=>{"summary"=>"Delete Shop Vacation", "description"=>"Disable vacation mode. All listings will be re-enabled.", "operationId"=>"deleteShopVacation", "x-api-path-slug"=>"shopvacation-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Vacation"]}, "get"=>{"summary"=>"Get Shop Vacation", "description"=>"Returns shop vacation status", "operationId"=>"getShopVacation", "x-api-path-slug"=>"shopvacation-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Vacation"]}, "post"=>{"summary"=>"Post Shop Vacation", "description"=>"Enable vacation mode. All listings will be unavailable until vacation mode is turned off.", "operationId"=>"postShopVacation", "x-api-path-slug"=>"shopvacation-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Vacation"]}}, "/shops/{id}/storefronts"=>{"get"=>{"summary"=>"Get Shops Storefronts", "description"=>"Get storefront details on a shop.", "operationId"=>"getShopsStorefronts", "x-api-path-slug"=>"shopsidstorefronts-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Id", "Storefronts"]}}, "/shops/{shop_id}/shipping_profiles"=>{"get"=>{"summary"=>"Get Shops Shop Shipping Profiles", "description"=>"List of shipping profiles for your shop", "operationId"=>"getShopsShopShippingProfiles", "x-api-path-slug"=>"shopsshop-idshipping-profiles-get", "parameters"=>[{"in"=>"path", "name"=>"shop_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Shop", "Id", "Shipping", "Profiles"]}}, "/shops/{slug}"=>{"get"=>{"summary"=>"Get Shops Slug", "description"=>"Get details on a shop.", "operationId"=>"getShopsSlug", "x-api-path-slug"=>"shopsslug-get", "parameters"=>[{"in"=>"query", "name"=>"include_listing_count", "description"=>"Include the live listing count in the response"}, {"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Slug"]}}, "/shops/{slug}/feedback"=>{"get"=>{"summary"=>"Get Shops Slug Feedback", "description"=>"Get shops slug feedback.", "operationId"=>"getShopsSlugFeedback", "x-api-path-slug"=>"shopsslugfeedback-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Slug", "Feedback"]}}, "/shops/{slug}/feedback/buyer"=>{"get"=>{"summary"=>"Get Shops Slug Feedback Buyer", "description"=>"Get seller's feedback as a buyer", "operationId"=>"getShopsSlugFeedbackBuyer", "x-api-path-slug"=>"shopsslugfeedbackbuyer-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Slug", "Feedback", "Buyer"]}}, "/shops/{slug}/feedback/seller"=>{"get"=>{"summary"=>"Get Shops Slug Feedback Seller", "description"=>"Get seller's feedback as a seller", "operationId"=>"getShopsSlugFeedbackSeller", "x-api-path-slug"=>"shopsslugfeedbackseller-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shops", "Slug", "Feedback", "Seller"]}}, "/wants"=>{"get"=>{"summary"=>"Get Wants", "description"=>"A list of wanted items by the user", "operationId"=>"getWants", "x-api-path-slug"=>"wants-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wants"]}}, "/wants/{id}"=>{"delete"=>{"summary"=>"Delete Wants", "description"=>"Unmark an item wanted.", "operationId"=>"deleteWants", "x-api-path-slug"=>"wantsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wants", "Id"]}, "put"=>{"summary"=>"Put Wants", "description"=>"Mark an item wanted. Returns 200 on success or 422 on failure.", "operationId"=>"putWants", "x-api-path-slug"=>"wantsid-put", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wants", "Id"]}}, "/webhooks/registrations"=>{"get"=>{"summary"=>"Get Webhooks Registrations", "description"=>"Get webhooks registrations.", "operationId"=>"getWebhooksRegistrations", "x-api-path-slug"=>"webhooksregistrations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "Registrations"]}, "post"=>{"summary"=>"Post Webhooks Registrations", "description"=>"Post webhooks registrations.", "operationId"=>"postWebhooksRegistrations", "x-api-path-slug"=>"webhooksregistrations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "Registrations"]}}, "/webhooks/registrations/{id}"=>{"delete"=>{"summary"=>"Delete Webhooks Registrations", "description"=>"Delete webhooks registrations.", "operationId"=>"deleteWebhooksRegistrations", "x-api-path-slug"=>"webhooksregistrationsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "Registrations", "Id"]}, "get"=>{"summary"=>"Get Webhooks Registrations", "description"=>"Get details of a webhook registration", "operationId"=>"getWebhooksRegistrations", "x-api-path-slug"=>"webhooksregistrationsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "Registrations", "Id"]}}, "/accounts"=>{"post"=>{"summary"=>"Post Accounts", "description"=>"Create an account.", "operationId"=>"postAccounts", "x-api-path-slug"=>"accounts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/articles/featured"=>{"get"=>{"summary"=>"Get Articles Featured", "description"=>"See featured Reverb blog posts", "operationId"=>"getArticlesFeatured", "x-api-path-slug"=>"articlesfeatured-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Articles", "Featured"]}}, "/articles/recently_featured"=>{"get"=>{"summary"=>"Get Articles Recently Featured", "description"=>"Get articles recently featured.", "operationId"=>"getArticlesRecentlyFeatured", "x-api-path-slug"=>"articlesrecently-featured-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Articles", "Recently", "Featured"]}}, "/articles/{slug}"=>{"get"=>{"summary"=>"Get Articles Slug", "description"=>"Display a single article", "operationId"=>"getArticlesSlug", "x-api-path-slug"=>"articlesslug-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Articles", "Slug"]}}, "/articles/{slug}/related-listings"=>{"get"=>{"summary"=>"Get Articles Slug Related Listings", "description"=>"Find listings related to an article", "operationId"=>"getArticlesSlugRelatedListings", "x-api-path-slug"=>"articlesslugrelatedlistings-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Articles", "Slug", "Related-listings"]}}, "/auth/forgot_password"=>{"post"=>{"summary"=>"Post Auth Forgot Password", "description"=>"Send a password reset email", "operationId"=>"postAuthForgotPassword", "x-api-path-slug"=>"authforgot-password-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auth", "Forgot", "Password"]}}, "/auth/logout"=>{"put"=>{"summary"=>"Put Auth Logout", "description"=>"Logout (primarily for mobile clients)", "operationId"=>"putAuthLogout", "x-api-path-slug"=>"authlogout-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"the content of the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auth", "Logout"]}}, "/autosuggest"=>{"get"=>{"summary"=>"Get Autosuggest", "description"=>"Autosuggest terms for searches", "operationId"=>"getAutosuggest", "x-api-path-slug"=>"autosuggest-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autosuggest"]}}, "/cart"=>{"get"=>{"summary"=>"Get Cart", "description"=>"Get all cart items", "operationId"=>"getCart", "x-api-path-slug"=>"cart-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart"]}}, "/cart/move_to_watch_list/{cart_item_id}"=>{"post"=>{"summary"=>"Post Cart Move To Watch List Cart Item", "description"=>"Remove a cart item and add it to watch list", "operationId"=>"postCartMoveToWatchListCartItem", "x-api-path-slug"=>"cartmove-to-watch-listcart-item-id-post", "parameters"=>[{"in"=>"path", "name"=>"cart_item_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Move", "To", "Watch", "List", "Cart", "Item", "Id"]}}, "/cart/{id}"=>{"delete"=>{"summary"=>"Delete Cart", "description"=>"Remove a product from the cart", "operationId"=>"deleteCart", "x-api-path-slug"=>"cartid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Id"]}, "post"=>{"summary"=>"Post Cart", "description"=>"Add product to the cart", "operationId"=>"postCart", "x-api-path-slug"=>"cartid-post", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Id"]}, "put"=>{"summary"=>"Put Cart", "description"=>"Update cart item details", "operationId"=>"putCart", "x-api-path-slug"=>"cartid-put", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Id"]}}, "/collections"=>{"get"=>{"summary"=>"Get Collections", "description"=>"List of curated collections", "operationId"=>"getCollections", "x-api-path-slug"=>"collections-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collections"]}}, "/collections/{slug}"=>{"get"=>{"summary"=>"Get Collections Slug", "description"=>"Get collections slug.", "operationId"=>"getCollectionsSlug", "x-api-path-slug"=>"collectionsslug-get", "parameters"=>[{"in"=>"path", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collections", "Slug"]}}, "/my/orders/buying/buying_history/{seller_id}"=>{"get"=>{"summary"=>"Get My Orders Buying Buying History Seller", "description"=>"Get my orders buying buying history seller.", "operationId"=>"getMyOrdersBuyingBuyingHistorySeller", "x-api-path-slug"=>"myordersbuyingbuying-historyseller-id-get", "parameters"=>[{"in"=>"path", "name"=>"seller_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "Orders", "Buying", "Buying", "History", "Seller", "Id"]}}, "/shop/stats"=>{"get"=>{"summary"=>"Get Shop Stats", "description"=>"Get listings stats", "operationId"=>"getShopStats", "x-api-path-slug"=>"shopstats-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Stats"]}}, "/shop/stats/activity"=>{"get"=>{"summary"=>"Get Shop Stats Activity", "description"=>"Get shop activity for a particular time period", "operationId"=>"getShopStatsActivity", "x-api-path-slug"=>"shopstatsactivity-get", "parameters"=>[{"in"=>"query", "name"=>"end_time", "description"=>"Filter by date in ISO8601 format - e"}, {"in"=>"query", "name"=>"start_time", "description"=>"Filter by date in ISO8601 format - e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shop", "Stats", "Activity"]}}, "/vinyl/listings"=>{"get"=>{"summary"=>"Get Vinyl Listings", "description"=>"Get vinyl listings.", "operationId"=>"getVinylListings", "x-api-path-slug"=>"vinyllistings-get", "parameters"=>[{"in"=>"query", "name"=>"merchandising_uuid", "description"=>"Merchandising UUID of the release"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vinyl", "Listings"]}, "post"=>{"summary"=>"Post Vinyl Listings", "description"=>"Post vinyl listings.", "operationId"=>"postVinylListings", "x-api-path-slug"=>"vinyllistings-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vinyl", "Listings"]}}, "/vinyl/listings/{id}"=>{"get"=>{"summary"=>"Get Vinyl Listings", "description"=>"Get vinyl listings.", "operationId"=>"getVinylListings", "x-api-path-slug"=>"vinyllistingsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vinyl", "Listings", "Id"]}}}}, "apis"=>{"name"=>"Reverb", "x-slug"=>"reverb", "description"=>"Reverb’s mission is to connect people with meaningful content.Reverb was created to find and connect the rich associations between words, ideas, content, and people. Through our products, we enhance broader knowledge around favorite topics by surfacing interesting information readers might not uncover on their own. We make tools for content understanding at every level from the single word on up. Wordnik: Get a full view of any word you???re interested in, with definitions, example sentences, related words, tweets from Twitter, pictures from Flickr, and much more.Reverb for Publishers: Reverb for Publishers brings relevant content to web audiences and surfaces additional content for publishers.Reverb for Developers: Reverb is committed to the open-source community and is proudly contributing infrastructure software to power applications and enterprises both small and gigantic. Our involvement with the Wordnik API, Scalatra, Swagger and Atmosphere is detailed on our site.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/145_logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API LIfeyclessss,Commerce,Dictionary,Relative Data,Service API,Spelling,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"reverb/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Reverb", "x-api-slug"=>"reverb", "description"=>"Reverb’s mission is to connect people with meaningful content.Reverb was created to find and connect the rich associations between words, ideas, content, and people. Through our products, we enhance broader knowledge around favorite topics by surfacing interesting information readers might not uncover on their own. We make tools for content understanding at every level from the single word on up. Wordnik: Get a full view of any word you???re interested in, with definitions, example sentences, related words, tweets from Twitter, pictures from Flickr, and much more.Reverb for Publishers: Reverb for Publishers brings relevant content to web audiences and surfaces additional content for publishers.Reverb for Developers: Reverb is committed to the open-source community and is proudly contributing infrastructure software to power applications and enterprises both small and gigantic. Our involvement with the Wordnik API, Scalatra, Swagger and Atmosphere is detailed on our site.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/145_logo.png", "humanURL"=>"https://helloreverb.com/app", "baseURL"=>"https://api.reverb.com//api", "tags"=>"API LIfeyclessss,Commerce,Dictionary,Relative Data,Service API,Spelling,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/reverb/reverb-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://blog.helloreverb.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.helloreverb.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/reverb-technologies"}, {"type"=>"x-github", "url"=>"https://github.com/reverb"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/reverb"}, {"type"=>"x-website", "url"=>"https://helloreverb.com/app"}, {"type"=>"x-website", "url"=>"http://reverb.com"}, {"type"=>"x-website", "url"=>"https://reverb.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
paylocity{"paylocity-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Paylocity", "x-complete"=>1, "info"=>{"title"=>"Paylocity", "description"=>"for-general-questions-and-support-of-the-api-contact-vendorrelationspaylocity-com-overviewpaylocity-web-services-api-is-an-externally-facing-restful-internet-protocol--the-paylocity-api-uses-http-verbs-and-a-restful-endpoint-structure--oauth-2-0-is-used-as-the-api-authorization-framework--request-and-response-payloads-are-formatted-as-json-paylocity-supports-v1-and-v2-versions-of-its-api-endpoints--v1-while-supported-wont-be-enhanced-with-additional-functionality--for-direct-link-to-v1-documentation-please-click-herehttpsdocs-paylocity-comweblinkguidespaylocity-web-services-apiv1paylocity-web-services-api-htm--for-additional-resources-regarding-v1v2-differences-and-conversion-path-please-contact-vendorrelationspaylocity-com--setuppaylocity-will-provide-the-secure-client-credentials-and-set-up-the-scope-type-of-requests-and-allowed-company-numbers--you-will-receive-the-unique-client-id-secret-and-paylocity-public-key-for-the-data-encryption--the-secret-will-expire-in-365-days---paylocity-will-send-you-an-email-10-days-prior-to-the-expiration-date-for-the-current-secret--if-not-renewed-the-second-email-notification-will-be-sent-5-days-prior-to-secrets-expiration--each-email-will-contain-the-code-necessary-to-renew-the-client-secret---you-can-obtain-the-new-secret-by-calling-api-endpoint-using-your-current-not-yet-expired-credentials-and-the-code-that-was-sent-with-the-notification-email--for-details-on-api-endpoint-please-see-client-credentials-section---both-the-current-secret-value-and-the-new-secret-value-will-be-recognized-during-the-transition-period--after-the-current-secret-expires-you-must-use-the-new-secret---if-you-were-unable-to-renew-the-secret-via-api-endpoint-you-can-still-contact-service-and-they-will-email-you-new-secret-via-secure-email-when-validating-the-request-paylocity-api-will-honor-the-defaults-and-required-fields-set-up-for-the-company-default-new-hire-template-as-defined-in-web-pay--authorizationpaylocity-web-services-api-uses-oauth2-0-authentication-with-json-message-format-all-requests-of-the-paylocity-web-services-api-require-a-bearer-token-which-can-be-obtained-by-authenticating-the-client-with-the-paylocity-web-services-api-via-oauth-2-0-the-client-must-request-a-bearer-token-from-the-authorization-endpointauthserver-for-production-httpsapi-paylocity-comidentityserverconnecttokenauthserver-for-testing-httpsapisandbox-paylocity-comidentityserverconnecttoken-authorization-headerthe-request-is-expected-to-be-in-the-form-of-a-basic-authentication-request-with-the-authorization-header-containing-the-clientid-and-clientsecret--this-means-the-standard-base64-encoded-userpassword-prefixed-with-basic-as-the-value-for-the-authorization-header-where-user-is-the-clientid-and-password-is-the-clientsecret--contenttype-headerthe-contenttype-header-is-required-to-be-applicationxwwwformurlencoded--additional-valuesthe-request-must-post-the-following-form-encoded-values-within-the-request-body----grant-type--client-credentials----scope--weblinkapi-responsessuccess-will-return-http-200-ok-with-json-content----------access-token-xxx------expires-in-3600------token-type-bearer-----encryptionpaylocity-uses-a-combination-of-rsa-and-aes-cryptography--as-part-of-the-setup-each-client-is-issued-a-public-rsa-key-paylocity-recommends-the-encryption-of-the-incoming-requests-as-additional-protection-of-the-sensitive-data--clients-can-optout-of-the-encryption-during-the-initial-setup-process--optout-will-allow-paylocity-to-process-unencrypted-requests-the-paylocity-public-key-has-the-following-properties-2048-bit-key-size-pkcs1-key-format-pem-encoding-properties-key-base-64-encoded-the-aes-symmetric-key-encrypted-with-the-paylocity-public-key--it-is-the-key-used-to-encrypt-the-content--paylocity-will-decrypt-the-aes-key-using-rsa-decryption-and-use-it-to-decrypt-the-content--iv-base-64-encoded-the-aes-iv-initialization-vector-used-when-encrypting-the-content--content-base-64-encoded-the-aes-encrypted-request--the-key-and-iv-provided-in-the-securecontent-request-are-used-by-paylocity-for-decryption-of-the-content-we-suggest-using-the-following-for-the-aes-cbc-cipher-mode-pkcs7-padding-128-bit-block-size-256-bit-key-size-sample-example----------securecontent---------key-es3aw6hqzhmj00gsi6gq3xa08dpmazk8bfy96pd99oda--------iv-nlyxmgq9svw0xo5ai9bzww--------content-gaeoiqlto1wlzguoik8fiybu42hug94eassl7nq1w-----------sample-c-code----using-newtonsoft-json----using-system----using-system-io----using-system-security-cryptography----using-system-text----public-class-securedcontent----------jsonpropertykey------public-string-key--get-set-------jsonpropertyiv------public-string-iv--get-set-------jsonpropertycontent------public-string-content--get-set---------public-class-endusersecurerequestexample----------public-string-createsecuredrequestfileinfo-paylocitypublickey-string-unsecuredjsonrequest--------------string-publickeyxml--file-readalltextpaylocitypublickey-fullname-encoding-utf8--------securedcontent-securecontent--this-createsecuredcontentpublickeyxml-unsecuredjsonrequest--------string-securerequest--jsonconvert-serializeobjectnew--securecontent---------return-securerequest------------private-securedcontent-createsecuredcontentstring-publickeyxml-string-request--------------using-aescryptoserviceprovider-aescsp--new-aescryptoserviceprovider------------------aescsp-mode--ciphermode-cbc----------aescsp-padding--paddingmode-pkcs7----------aescsp-blocksize--128----------aescsp-keysize--256----------using-icryptotransform-crt--aescsp-createencryptoraescsp-key-aescsp-iv----------------------using-memorystream-outputstream--new-memorystream--------------------------using-cryptostream-encryptstream--new-cryptostreamoutputstream-crt-cryptostreammode-write------------------------------byte-encodedrequest--encoding-utf8-getbytesrequest----------------encryptstream-writeencodedrequest-0-encodedrequest-length----------------encryptstream-flushfinalblock----------------byte-encryptedrequest--outputstream-toarray----------------using-rsacryptoserviceprovider-crp--new-rsacryptoserviceprovider----------------------------------crp-fromxmlstringpublickeyxml------------------byte-encryptedkey--crp-encryptaescsp-key-false------------------return-new-securedcontent--------------------------------------key--convert-tobase64stringencryptedkey--------------------iv--convert-tobase64stringaescsp-iv--------------------content--convert-tobase64stringencryptedrequest-----------------------------------------------------------------------------------------supportquestions-about-using-the-paylocity-api-please-contact-vendorrelationspaylocity-com--deductions-v1deductions-api-provides-endpoints-to-retrieve-add-update-and-delete-deductions-for-a-companys-employees--for-schema-details-click-a-hrefhttpsdocs-paylocity-comweblinkguidespaylocity-web-services-apiv1paylocity-web-services-api-htm-target-blankherea--onboarding-v1onboarding-api-sends-employee-data-into-paylocity-onboarding-to-help-ensure-an-easy-and-accurate-hiring-process-for-subsequent-completion-into-web-pay--for-schema-details-click-a-hrefhttpsdocs-paylocity-comweblinkguidespaylocity-web-services-apiv1paylocity-web-services-api-htm-target-blankherea-", "termsOfService"=>"WebLink.OpenApiDoc.TermsOfService", "version"=>"2"}, "host"=>"api.paylocity.com", "basePath"=>"/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v2/companies/{companyId}/customfields/{category}"=>{"get"=>{"summary"=>"Get All Custom Fields", "description"=>"Get All Custom Fields for the selected company", "operationId"=>"v2.companies.companyId.customfields.category.get", "x-api-path-slug"=>"v2companiescompanyidcustomfieldscategory-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"category", "description"=>"Custom Fields Category"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Customfields", "Category"]}}, "/v2/companies/{companyId}/employees"=>{"post"=>{"summary"=>"Add new employee", "description"=>"New Employee API sends new employee data directly to Web Pay. Companies who use the New Hire Template in Web Pay may require additional fields when hiring employees. New Employee API Requests will honor these required fields.", "operationId"=>"v2.companies.companyId.employees.post", "x-api-path-slug"=>"v2companiescompanyidemployees-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}, {"in"=>"body", "name"=>"json", "description"=>"Employee Model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Employees"]}}, "/v2/companies/{companyId}/employees/{employeeId}"=>{"get"=>{"summary"=>"Get employee", "description"=>"Get Employee API will return employee data currently available in Web Pay.", "operationId"=>"v2.companies.companyId.employees.employeeId.get", "x-api-path-slug"=>"v2companiescompanyidemployeesemployeeid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}, {"in"=>"path", "name"=>"employeeId", "description"=>"Employee Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Employees", "EmployeeId"]}, "patch"=>{"summary"=>"Update employee", "description"=>"Update Employee API will update existing employee data in WebPay.", "operationId"=>"v2.companies.companyId.employees.employeeId.patch", "x-api-path-slug"=>"v2companiescompanyidemployeesemployeeid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}, {"in"=>"path", "name"=>"employeeId", "description"=>"Employee Id"}, {"in"=>"body", "name"=>"json", "description"=>"Employee Model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Employees", "EmployeeId"]}}, "/v2/companies/{companyId}/employees/{employeeId}/benefitSetup"=>{"put"=>{"summary"=>"Add/update employee's benefit setup", "description"=>"Sends new or updated employee benefit setup information directly to Web Pay.", "operationId"=>"v2.companies.companyId.employees.employeeId.benefitSetup.put", "x-api-path-slug"=>"v2companiescompanyidemployeesemployeeidbenefitsetup-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}, {"in"=>"path", "name"=>"employeeId", "description"=>"Employee Id"}, {"in"=>"body", "name"=>"json", "description"=>"BenefitSetup Model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Employees", "EmployeeId", "BenefitSetup"]}}, "/v2/companies/{companyId}/employees/{employeeId}/earnings"=>{"get"=>{"summary"=>"Get All Earnings", "description"=>"Get All Earnings returns all earnings for the selected employee.", "operationId"=>"v2.companies.companyId.employees.employeeId.earnings.get", "x-api-path-slug"=>"v2companiescompanyidemployeesemployeeidearnings-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}, {"in"=>"path", "name"=>"employeeId", "description"=>"Employee Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Employees", "EmployeeId", "Earnings"]}, "put"=>{"summary"=>"Add/Update Earning", "description"=>"Add/Update Earning API sends new or updated employee earnings information directly to Web Pay.", "operationId"=>"v2.companies.companyId.employees.employeeId.earnings.put", "x-api-path-slug"=>"v2companiescompanyidemployeesemployeeidearnings-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}, {"in"=>"path", "name"=>"employeeId", "description"=>"Employee Id"}, {"in"=>"body", "name"=>"json", "description"=>"Earning Model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Employees", "EmployeeId", "Earnings"]}}, "/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}"=>{"get"=>{"summary"=>"Get Earnings by Earning Code", "description"=>"Get Earnings returns all earnings with the provided earning code for the selected employee.", "operationId"=>"v2.companies.companyId.employees.employeeId.earnings.earningCode.get", "x-api-path-slug"=>"v2companiescompanyidemployeesemployeeidearningsearningcode-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}, {"in"=>"path", "name"=>"earningCode", "description"=>"Earning Code"}, {"in"=>"path", "name"=>"employeeId", "description"=>"Employee Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Employees", "EmployeeId", "Earnings", "EarningCode"]}}, "/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{startDate}"=>{"delete"=>{"summary"=>"Delete Earning by Earning Code and Start Date", "description"=>"Delete Earning by Earning Code and Start Date", "operationId"=>"v2.companies.companyId.employees.employeeId.earnings.earningCode.startDate.delete", "x-api-path-slug"=>"v2companiescompanyidemployeesemployeeidearningsearningcodestartdate-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}, {"in"=>"path", "name"=>"earningCode", "description"=>"Earning Code"}, {"in"=>"path", "name"=>"employeeId", "description"=>"Employee Id"}, {"in"=>"path", "name"=>"startDate", "description"=>"Start Date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Employees", "EmployeeId", "Earnings", "EarningCode", "StartDate"]}, "get"=>{"summary"=>"Get Earning by Earning Code and Start Date", "description"=>"Get Earnings returns the single earning with the provided earning code and start date for the selected employee.", "operationId"=>"v2.companies.companyId.employees.employeeId.earnings.earningCode.startDate.get", "x-api-path-slug"=>"v2companiescompanyidemployeesemployeeidearningsearningcodestartdate-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}, {"in"=>"path", "name"=>"earningCode", "description"=>"Earning Code"}, {"in"=>"path", "name"=>"employeeId", "description"=>"Employee Id"}, {"in"=>"path", "name"=>"startDate", "description"=>"Start Date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Employees", "EmployeeId", "Earnings", "EarningCode", "StartDate"]}}, "/v2/companies/{companyId}/employees/{employeeId}/localTaxes"=>{"get"=>{"summary"=>"Get all local taxes", "description"=>"Returns all local taxes for the selected employee.", "operationId"=>"v2.companies.companyId.employees.employeeId.localTaxes.get", "x-api-path-slug"=>"v2companiescompanyidemployeesemployeeidlocaltaxes-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}, {"in"=>"path", "name"=>"employeeId", "description"=>"Employee Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Employees", "EmployeeId", "LocalTaxes"]}, "post"=>{"summary"=>"Add new local tax", "description"=>"Sends new employee local tax information directly to Web Pay.", "operationId"=>"v2.companies.companyId.employees.employeeId.localTaxes.post", "x-api-path-slug"=>"v2companiescompanyidemployeesemployeeidlocaltaxes-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}, {"in"=>"path", "name"=>"employeeId", "description"=>"Employee Id"}, {"in"=>"body", "name"=>"json", "description"=>"LocalTax Model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Employees", "EmployeeId", "LocalTaxes"]}}, "/v2/companies/{companyId}/employees/{employeeId}/localTaxes/{taxCode}"=>{"delete"=>{"summary"=>"Delete local tax by tax code", "description"=>"Delete local tax by tax code", "operationId"=>"v2.companies.companyId.employees.employeeId.localTaxes.taxCode.delete", "x-api-path-slug"=>"v2companiescompanyidemployeesemployeeidlocaltaxestaxcode-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}, {"in"=>"path", "name"=>"employeeId", "description"=>"Employee Id"}, {"in"=>"path", "name"=>"taxCode", "description"=>"Tax Code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Employees", "EmployeeId", "LocalTaxes", "TaxCode"]}, "get"=>{"summary"=>"Get local taxes by tax code", "description"=>"Returns all local taxes with the provided tax code for the selected employee.", "operationId"=>"v2.companies.companyId.employees.employeeId.localTaxes.taxCode.get", "x-api-path-slug"=>"v2companiescompanyidemployeesemployeeidlocaltaxestaxcode-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}, {"in"=>"path", "name"=>"employeeId", "description"=>"Employee Id"}, {"in"=>"path", "name"=>"taxCode", "description"=>"Tax Code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Employees", "EmployeeId", "LocalTaxes", "TaxCode"]}}, "/v2/companies/{companyId}/employees/{employeeId}/nonprimaryStateTax"=>{"put"=>{"summary"=>"Add/update non-primary state tax", "description"=>"Sends new or updated employee non-primary state tax information directly to Web Pay.", "operationId"=>"v2.companies.companyId.employees.employeeId.nonprimaryStateTax.put", "x-api-path-slug"=>"v2companiescompanyidemployeesemployeeidnonprimarystatetax-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}, {"in"=>"path", "name"=>"employeeId", "description"=>"Employee Id"}, {"in"=>"body", "name"=>"json", "description"=>"Non-Primary State Tax Model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Employees", "EmployeeId", "NonprimaryStateTax"]}}, "/v2/companies/{companyId}/employees/{employeeId}/primaryStateTax"=>{"put"=>{"summary"=>"Add/update primary state tax", "description"=>"Sends new or updated employee primary state tax information directly to Web Pay.", "operationId"=>"v2.companies.companyId.employees.employeeId.primaryStateTax.put", "x-api-path-slug"=>"v2companiescompanyidemployeesemployeeidprimarystatetax-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}, {"in"=>"path", "name"=>"employeeId", "description"=>"Employee Id"}, {"in"=>"body", "name"=>"json", "description"=>"Primary State Tax Model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Employees", "EmployeeId", "PrimaryStateTax"]}}, "/v2/companies/{companyId}/openapi"=>{"get"=>{"summary"=>"Get Company-Specific Open API Documentation", "description"=>"The company-specific Open API endpoint allows the client to GET an Open API document for the Paylocity API that is customized with company-specific resource schemas. These customized resource schemas define certain properties as enumerations of pre-defined values that correspond to the company's setup with Web Pay. The customized schemas also indicate which properties are required by the company within Web Pay. To learn more about Open API, click [here](https://www.openapis.org/)", "operationId"=>"v2.companies.companyId.openapi.get", "x-api-path-slug"=>"v2companiescompanyidopenapi-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Companies", "CompanyId", "Openapi"]}}, "/v2/credentials/secrets"=>{"post"=>{"summary"=>"Obtain new client secret.", "description"=>"Obtain new client secret for Paylocity-issued client id. See Setup section for details.", "operationId"=>"v2.credentials.secrets.post", "x-api-path-slug"=>"v2credentialssecrets-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"body", "name"=>"json", "description"=>"Add Client Secret Model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Credentials", "Secrets"]}}, "/v2/weblinkstaging/companies/{companyId}/employees/newemployees"=>{"post"=>{"summary"=>"Add new employee to Web Link", "description"=>"Add new employee to Web Link will send partially completed or potentially erroneous new hire record to Web Link, where it can be corrected and competed by company administrator or authorized Paylocity Service Bureau employee.", "operationId"=>"v2.weblinkstaging.companies.companyId.employees.newemployees.post", "x-api-path-slug"=>"v2weblinkstagingcompaniescompanyidemployeesnewemployees-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer + JWT"}, {"in"=>"path", "name"=>"companyId", "description"=>"Company Id"}, {"in"=>"body", "name"=>"json", "description"=>"StagedEmployee Model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V2", "Weblinkstaging", "Companies", "CompanyId", "Employees", "Newemployees"]}}}}, "apis"=>{"name"=>"Paylocity", "x-slug"=>"paylocity", "description"=>"Paylocity has delivered industry-leading software and unmatched customer service since our inception. Our mission of elevating payroll and human resources across the backroom and into the boardroom speaks to just that. Today, Paylocity continues to develop innovative solutions that simplify the lives of payroll and HR professionals across the country. Through powerful analytics, robust reporting, intuitive usability, and modern functionality—our clients increase efficiency and manage workforces more effectively.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28482-paylocity.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"6810", "tags"=>"API Provider,Enterprise,Human Resources,Payments,Payroll,Profiles,Relative Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"paylocity/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Paylocity", "x-api-slug"=>"paylocity", "description"=>"Paylocity has delivered industry-leading software and unmatched customer service since our inception. Our mission of elevating payroll and human resources across the backroom and into the boardroom speaks to just that. Today, Paylocity continues to develop innovative solutions that simplify the lives of payroll and HR professionals across the country. Through powerful analytics, robust reporting, intuitive usability, and modern functionality—our clients increase efficiency and manage workforces more effectively.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28482-paylocity.jpg", "humanURL"=>"http://www.paylocity.com", "baseURL"=>"https://api.paylocity.com//api", "tags"=>"API Provider,Enterprise,Human Resources,Payments,Payroll,Profiles,Relative Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/paylocity/paylocity-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://www.paylocity.com"}, {"type"=>"x-blog", "url"=>"https://www.paylocity.com/resources/blog/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/paylocity"}, {"type"=>"x-github", "url"=>"https://github.com/Paylocity"}, {"type"=>"x-integrations", "url"=>"https://www.paylocity.com/partnerships/integrations/"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/paylocity/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Paylocity"}, {"type"=>"x-website", "url"=>"http://paylocity.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
the-tvdb{"the-tvdb-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"The TVDB", "x-complete"=>1, "info"=>{"title"=>"The TVDB API v2", "description"=>"api-v2-targets-v1-functionality-with-a-few-minor-additions--the-api-is-accessible-via-httpsapi-thetvdb-com-and-provides-the-following-rest-endpoints-in-json-format-how-to-use-this-api-documentationyou-may-browse-the-api-routes-without-authentication-but-if-you-wish-to-send-requests-to-the-api-and-see-response-data-then-you-must-authenticate-1--obtain-a-jwt-token-by-posting--to-the-login-route-in-the-authentication-section-with-your-api-key-and-credentials-1--paste-the-jwt-token-from-the-response-into-the-jwt-token-field-at-the-top-of-the-page-and-click-the-add-token-button-you-will-now-be-able-to-use-the-remaining-routes-to-send-requests-to-the-api-and-get-a-response-language-selectionlanguage-selection-is-done-via-the-acceptlanguage-header--at-the-moment-you-may-only-pass-one-language-abbreviation-in-the-header-at-a-time--valid-language-abbreviations-can-be-found-at-the-languages-route--authenticationauthentication-to-use-the-api-is-similar-to-the-howto-section-above--users-must-post-to-the-login-route-with-their-api-key-and-credentials-in-the-following-format-in-order-to-obtain-a-jwt-token-apikeyapikeyusernameusernameuserkeyuserkeynote-that-the-username-and-key-are-only-required-for-the-user-routes--the-users-key-is-labled-account-identifier-in-the-account-section-of-the-main-site-the-token-is-then-used-in-all-subsequent-requests-by-providing-it-in-the-authorization-header--the-header-will-look-like-authorization-bearer-yourjwttoken--currently-the-token-expires-after-24-hours--you-can-get-the-refresh-token-route-to-extend-that-expiration-date-versioningyou-may-request-a-different-version-of-the-api-by-including-an-accept-header-in-your-request-with-the-following-format-acceptapplicationvnd-thetvdb-vversion--this-documentation-automatically-uses-the-version-seen-at-the-top-and-bottom-of-the-page-", "version"=>"2.1.2"}, "host"=>"api-dev.thetvdb.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/episodes/{id}"=>{"get"=>{"summary"=>"Get Episodes", "description"=>"Returns the full information for a given episode id. __Deprecation Warning:__ The _director_ key will be deprecated in favor of the new _directors_ key in a future release.", "operationId"=>"episodes.id.get", "x-api-path-slug"=>"episodesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Episodes"]}}, "/languages"=>{"get"=>{"summary"=>"Get Languages", "description"=>"All available languages. These language abbreviations can be used in the `Accept-Language` header for routes that return translation records.", "operationId"=>"languages.get", "x-api-path-slug"=>"languages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Languages"]}}, "/languages/{id}"=>{"get"=>{"summary"=>"Get Languages", "description"=>"Information about a particular language, given the language ID.", "operationId"=>"languages.id.get", "x-api-path-slug"=>"languagesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Languages"]}}, "/login"=>{"post"=>{"summary"=>"Post Login", "description"=>"Returns a session token to be included in the rest of the requests. Note that API key authentication is required for all subsequent requests and user auth is required for routes in the `User` section", "operationId"=>"login.post", "x-api-path-slug"=>"login-post", "parameters"=>[{"in"=>"body", "name"=>"Authentication string", "description"=>"JSON string containing your authentication details", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Login"]}}, "/refresh_token"=>{"get"=>{"summary"=>"Get Refresh Token", "description"=>"Refreshes your current, valid JWT token and returns a new token. Hit this route so that you do not have to post to `/login` with your API key and credentials once you have already been authenticated.", "operationId"=>"refresh_token.get", "x-api-path-slug"=>"refresh-token-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Refresh", "Token"]}}, "/search/series"=>{"get"=>{"summary"=>"Get Search Series", "description"=>"Allows the user to search for a series based on the following parameters.", "operationId"=>"search.series.get", "x-api-path-slug"=>"searchseries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Search", "Series"]}}, "/search/series/params"=>{"get"=>{"summary"=>"Get Search Series Params", "description"=>"Returns an array of parameters to query by in the `/search/series` route.", "operationId"=>"search.series.params.get", "x-api-path-slug"=>"searchseriesparams-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Search", "Series", "Params"]}}, "/series/{id}"=>{"get"=>{"summary"=>"Get Series", "description"=>"Returns a series records that contains all information known about a particular series id.", "operationId"=>"series.id.get", "x-api-path-slug"=>"seriesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Series"]}, "head"=>{"summary"=>"Head Series", "description"=>"Returns header information only about the given series ID.", "operationId"=>"series.id.head", "x-api-path-slug"=>"seriesid-head", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Series"]}}, "/series/{id}/actors"=>{"get"=>{"summary"=>"Get Series Actors", "description"=>"Returns actors for the given series id", "operationId"=>"series.id.actors.get", "x-api-path-slug"=>"seriesidactors-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Series", "Actors"]}}, "/series/{id}/episodes"=>{"get"=>{"summary"=>"Get Series Episodes", "description"=>"All episodes for a given series. Paginated with 100 results per page.", "operationId"=>"series.id.episodes.get", "x-api-path-slug"=>"seriesidepisodes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Series", "Episodes"]}}, "/series/{id}/episodes/query"=>{"get"=>{"summary"=>"Get Series Episodes Query", "description"=>"This route allows the user to query against episodes for the given series. The response is a paginated array of episode records that have been filtered down to basic information.", "operationId"=>"series.id.episodes.query.get", "x-api-path-slug"=>"seriesidepisodesquery-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Series", "Episodes", "Query"]}}, "/series/{id}/episodes/query/params"=>{"get"=>{"summary"=>"Get Series Episodes Query Params", "description"=>"Returns the allowed query keys for the `/series/{id}/episodes/query` route", "operationId"=>"series.id.episodes.query.params.get", "x-api-path-slug"=>"seriesidepisodesqueryparams-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Series", "Episodes", "Query", "Params"]}}, "/series/{id}/episodes/summary"=>{"get"=>{"summary"=>"Get Series Episodes Summary", "description"=>"Returns a summary of the episodes and seasons available for the series.\n\n__Note__: Season \"0\" is for all episodes that are considered to be specials.", "operationId"=>"series.id.episodes.summary.get", "x-api-path-slug"=>"seriesidepisodessummary-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Series", "Episodes", "Summary"]}}, "/series/{id}/filter"=>{"get"=>{"summary"=>"Get Series Filter", "description"=>"Returns a series records, filtered by the supplied comma-separated list of keys. Query keys can be found at the `/series/{id}/filter/params` route.", "operationId"=>"series.id.filter.get", "x-api-path-slug"=>"seriesidfilter-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Series", "Filter"]}}, "/series/{id}/filter/params"=>{"get"=>{"summary"=>"Get Series Filter Params", "description"=>"Returns the list of keys available for the `/series/{id}/filter` route", "operationId"=>"series.id.filter.params.get", "x-api-path-slug"=>"seriesidfilterparams-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Series", "Filter", "Params"]}}, "/series/{id}/images"=>{"get"=>{"summary"=>"Get Series Images", "description"=>"Returns a summary of the images for a particular series", "operationId"=>"series.id.images.get", "x-api-path-slug"=>"seriesidimages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Series", "Images"]}}, "/series/{id}/images/query"=>{"get"=>{"summary"=>"Get Series Images Query", "description"=>"Query images for the given series ID.", "operationId"=>"series.id.images.query.get", "x-api-path-slug"=>"seriesidimagesquery-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Series", "Images", "Query"]}}, "/series/{id}/images/query/params"=>{"get"=>{"summary"=>"Get Series Images Query Params", "description"=>"Returns the allowed query keys for the `/series/{id}/images/query` route. Contains a parameter record for each unique `keyType`, listing values that will return results.", "operationId"=>"series.id.images.query.params.get", "x-api-path-slug"=>"seriesidimagesqueryparams-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Series", "Images", "Query", "Params"]}}, "/updated/query"=>{"get"=>{"summary"=>"Get Updated Query", "description"=>"Returns an array of series that have changed in a maximum of one week blocks since the provided `fromTime`.\n\n\nThe user may specify a `toTime` to grab results for less than a week. Any timespan larger than a week will be reduced down to one week automatically.", "operationId"=>"updated.query.get", "x-api-path-slug"=>"updatedquery-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Updated", "Query"]}}, "/updated/query/params"=>{"get"=>{"summary"=>"Get Updated Query Params", "description"=>"Returns an array of valid query keys for the `/updated/query/params` route.", "operationId"=>"updated.query.params.get", "x-api-path-slug"=>"updatedqueryparams-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Updated", "Query", "Params"]}}, "/user"=>{"get"=>{"summary"=>"Get User", "description"=>"Returns basic information about the currently authenticated user.", "operationId"=>"user.get", "x-api-path-slug"=>"user-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User"]}}, "/user/favorites"=>{"get"=>{"summary"=>"Get User Favorites", "description"=>"Returns an array of favorite series for a given user, will be a blank array if no favorites exist.", "operationId"=>"user.favorites.get", "x-api-path-slug"=>"userfavorites-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Favorites"]}}, "/user/favorites/{id}"=>{"delete"=>{"summary"=>"Delete User Favorites", "description"=>"Deletes the given series ID from the user???s favorite???s list and returns the updated list.", "operationId"=>"user.favorites.id.delete", "x-api-path-slug"=>"userfavoritesid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Favorites"]}, "put"=>{"summary"=>"Put User Favorites", "description"=>"Adds the supplied series ID to the user???s favorite???s list and returns the updated list.", "operationId"=>"user.favorites.id.put", "x-api-path-slug"=>"userfavoritesid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Favorites"]}}, "/user/ratings"=>{"get"=>{"summary"=>"Get User Ratings", "description"=>"Returns an array of ratings for the given user.", "operationId"=>"user.ratings.get", "x-api-path-slug"=>"userratings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Ratings"]}}, "/user/ratings/query"=>{"get"=>{"summary"=>"Get User Ratings Query", "description"=>"Returns an array of ratings for a given user that match the query.", "operationId"=>"user.ratings.query.get", "x-api-path-slug"=>"userratingsquery-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Ratings", "Query"]}}, "/user/ratings/query/params"=>{"get"=>{"summary"=>"Get User Ratings Query Params", "description"=>"Returns a list of query params for use in the `/user/ratings/query` route.", "operationId"=>"user.ratings.query.params.get", "x-api-path-slug"=>"userratingsqueryparams-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Ratings", "Query", "Params"]}}, "/user/ratings/{itemType}/{itemId}"=>{"delete"=>{"summary"=>"Delete User Ratings Itemtype Itemid", "description"=>"This route deletes a given rating of a given type.", "operationId"=>"user.ratings.itemType.itemId.delete", "x-api-path-slug"=>"userratingsitemtypeitemid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Ratings", "ItemType", "ItemId"]}}, "/user/ratings/{itemType}/{itemId}/{itemRating}"=>{"put"=>{"summary"=>"Put User Ratings Itemtype Itemid Itemrating", "description"=>"This route updates a given rating of a given type.", "operationId"=>"user.ratings.itemType.itemId.itemRating.put", "x-api-path-slug"=>"userratingsitemtypeitemiditemrating-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Ratings", "ItemType", "ItemId", "ItemRating"]}}}}, "apis"=>{"name"=>"The TVDB", "x-slug"=>"the-tvdb", "description"=>"TheTVDB.com is a community driven database of television shows. All content and images on the site have been contributed by the sites users; the site uses moderated editing to maintain its own standards. The database schema and website are open source under the GNU General Public License.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/thetvdb.jpeg", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"General Data,Televisions", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"the-tvdb/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"The TVDB", "x-api-slug"=>"the-tvdb", "description"=>"TheTVDB.com is a community driven database of television shows. All content and images on the site have been contributed by the sites users; the site uses moderated editing to maintain its own standards. The database schema and website are open source under the GNU General Public License.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/thetvdb.jpeg", "humanURL"=>"http://thetvdb.com", "baseURL"=>"https://api-dev.thetvdb.com//", "tags"=>"General Data,Televisions", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/the-tvdb/the-tvdb-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://api.thetvdb.com/swagger"}, {"type"=>"x-website", "url"=>"http://thetvdb.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-logic-apps{"azure-logic-apps-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Logic Apps", "x-complete"=>1, "info"=>{"title"=>"LogicManagementClient", "description"=>"rest-api-for-azure-logic-apps-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/providers/Microsoft.Logic/workflows"=>{"get"=>{"summary"=>"Workflows List By Subscription", "description"=>"Gets a list of workflows by subscription.", "operationId"=>"Workflows_ListBySubscription", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-logicworkflows-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to be included in the result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflows Subscription"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows"=>{"get"=>{"summary"=>"Workflows List By Resource Group", "description"=>"Gets a list of workflows by resource group.", "operationId"=>"Workflows_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflows-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to be included in the result"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflows Resource Group"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}"=>{"get"=>{"summary"=>"Workflows Get", "description"=>"Gets a workflow.", "operationId"=>"Workflows_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflowname-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflows"]}, "put"=>{"summary"=>"Workflows Create Or Update", "description"=>"Creates or updates a workflow.", "operationId"=>"Workflows_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflowname-put", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"body", "name"=>"workflow", "description"=>"The workflow", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflows"]}, "patch"=>{"summary"=>"Workflows Update", "description"=>"Updates a workflow.", "operationId"=>"Workflows_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflowname-patch", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"body", "name"=>"workflow", "description"=>"The workflow", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflows"]}, "delete"=>{"summary"=>"Workflows Delete", "description"=>"Deletes a workflow.", "operationId"=>"Workflows_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflowname-delete", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflows"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/disable"=>{"post"=>{"summary"=>"Workflows Disable", "description"=>"Disables a workflow.", "operationId"=>"Workflows_Disable", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownamedisable-post", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflows Disable"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/enable"=>{"post"=>{"summary"=>"Workflows Enable", "description"=>"Enables a workflow.", "operationId"=>"Workflows_Enable", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownameenable-post", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflows Enable"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/generateUpgradedDefinition"=>{"post"=>{"summary"=>"Workflows Generate Upgraded Definition", "description"=>"Generates the upgraded definition for a workflow.", "operationId"=>"Workflows_GenerateUpgradedDefinition", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownamegenerateupgradeddefinition-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters for generating an upgraded definition", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflows Generate Upgraded Definition"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/listSwagger"=>{"post"=>{"summary"=>"Workflows List Swagger", "description"=>"Gets an OpenAPI definition for the workflow.", "operationId"=>"Workflows_ListSwagger", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownamelistswagger-post", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflows Swagger"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/regenerateAccessKey"=>{"post"=>{"summary"=>"Workflows Regenerate Access Key", "description"=>"Regenerates the callback URL access key for request triggers.", "operationId"=>"Workflows_RegenerateAccessKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownameregenerateaccesskey-post", "parameters"=>[{"in"=>"body", "name"=>"keyType", "description"=>"The access key type", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflows Regenerate Access Key"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions"=>{"get"=>{"summary"=>"Workflow Versions List", "description"=>"Gets a list of workflow versions.", "operationId"=>"WorkflowVersions_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownameversions-get", "parameters"=>[{"in"=>"query", "name"=>"$top", "description"=>"The number of items to be included in the result"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow Versions"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions/{versionId}"=>{"get"=>{"summary"=>"Workflow Versions Get", "description"=>"Gets a workflow version.", "operationId"=>"WorkflowVersions_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownameversionsversionid-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"versionId", "description"=>"The workflow versionId"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow Versions"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/"=>{"get"=>{"summary"=>"Workflow Triggers List", "description"=>"Gets a list of workflow triggers.", "operationId"=>"WorkflowTriggers_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownametriggers-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to be included in the result"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow Triggers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}"=>{"get"=>{"summary"=>"Workflow Triggers Get", "description"=>"Gets a workflow trigger.", "operationId"=>"WorkflowTriggers_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownametriggerstriggername-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"triggerName", "description"=>"The workflow trigger name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow Triggers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/run"=>{"post"=>{"summary"=>"Workflow Triggers Run", "description"=>"Runs a workflow trigger.", "operationId"=>"WorkflowTriggers_Run", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownametriggerstriggernamerun-post", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"triggerName", "description"=>"The workflow trigger name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow Triggers Run"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/listCallbackUrl"=>{"post"=>{"summary"=>"Workflow Triggers List Callback Url", "description"=>"Gets the callback URL for a workflow trigger.", "operationId"=>"WorkflowTriggers_ListCallbackUrl", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownametriggerstriggernamelistcallbackurl-post", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"triggerName", "description"=>"The workflow trigger name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow Triggers Callback Url"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions/{versionId}/triggers/{triggerName}/listCallbackUrl"=>{"post"=>{"summary"=>"Workflow Versions List Callback Url", "description"=>"Lists the callback URL for a trigger of a workflow version.", "operationId"=>"WorkflowVersions_ListCallbackUrl", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownameversionsversionidtriggerstriggernamelistcallbackurl-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The callback URL parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"triggerName", "description"=>"The workflow trigger name"}, {"in"=>"path", "name"=>"versionId", "description"=>"The workflow versionId"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow Versions Callback Url"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories"=>{"get"=>{"summary"=>"Workflow Trigger Histories List", "description"=>"Gets a list of workflow trigger histories.", "operationId"=>"WorkflowTriggerHistories_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownametriggerstriggernamehistories-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to be included in the result"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"triggerName", "description"=>"The workflow trigger name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow Trigger Histories"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}"=>{"get"=>{"summary"=>"Workflow Trigger Histories Get", "description"=>"Gets a workflow trigger history.", "operationId"=>"WorkflowTriggerHistories_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownametriggerstriggernamehistorieshistoryname-get", "parameters"=>[{"in"=>"path", "name"=>"historyName", "description"=>"The workflow trigger history name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"triggerName", "description"=>"The workflow trigger name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow Trigger Histories"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}/resubmit"=>{"post"=>{"summary"=>"Workflow Trigger Histories Resubmit", "description"=>"Resubmits a workflow run based on the trigger history.", "operationId"=>"WorkflowTriggerHistories_Resubmit", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownametriggerstriggernamehistorieshistorynameresubmit-post", "parameters"=>[{"in"=>"path", "name"=>"historyName", "description"=>"The workflow trigger history name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"triggerName", "description"=>"The workflow trigger name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow Trigger Histories Resubmit"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs"=>{"get"=>{"summary"=>"Workflow Runs List", "description"=>"Gets a list of workflow runs.", "operationId"=>"WorkflowRuns_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownameruns-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to be included in the result"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow Runs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}"=>{"get"=>{"summary"=>"Workflow Runs Get", "description"=>"Gets a workflow run.", "operationId"=>"WorkflowRuns_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownamerunsrunname-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"runName", "description"=>"The workflow run name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow Runs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/cancel"=>{"post"=>{"summary"=>"Workflow Runs Cancel", "description"=>"Cancels a workflow run.", "operationId"=>"WorkflowRuns_Cancel", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownamerunsrunnamecancel-post", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"runName", "description"=>"The workflow run name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow Runs Cancel"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions"=>{"get"=>{"summary"=>"Workflow Run Actions List", "description"=>"Gets a list of workflow run actions.", "operationId"=>"WorkflowRunActions_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownamerunsrunnameactions-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to be included in the result"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"runName", "description"=>"The workflow run name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow Run Actions"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}"=>{"get"=>{"summary"=>"Workflow Run Actions Get", "description"=>"Gets a workflow run action.", "operationId"=>"WorkflowRunActions_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicworkflowsworkflownamerunsrunnameactionsactionname-get", "parameters"=>[{"in"=>"path", "name"=>"actionName", "description"=>"The workflow action name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"runName", "description"=>"The workflow run name"}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow Run Actions"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/locations/{location}/workflows/{workflowName}/validate"=>{"post"=>{"summary"=>"Workflows Validate", "description"=>"Validates the workflow definition.", "operationId"=>"Workflows_Validate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logiclocationslocationworkflowsworkflownamevalidate-post", "parameters"=>[{"in"=>"path", "name"=>"location", "description"=>"The workflow location"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"body", "name"=>"workflow", "description"=>"The workflow definition", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"workflowName", "description"=>"The workflow name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflows Validate"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Logic/integrationAccounts"=>{"get"=>{"summary"=>"Integration Accounts List By Subscription", "description"=>"Gets a list of integration accounts by subscription.", "operationId"=>"IntegrationAccounts_ListBySubscription", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-logicintegrationaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"$top", "description"=>"The number of items to be included in the result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integration Accounts Subscription"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts"=>{"get"=>{"summary"=>"Integration Accounts List By Resource Group", "description"=>"Gets a list of integration accounts by resource group.", "operationId"=>"IntegrationAccounts_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"$top", "description"=>"The number of items to be included in the result"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integration Accounts Resource Group"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}"=>{"get"=>{"summary"=>"Integration Accounts Get", "description"=>"Gets an integration account.", "operationId"=>"IntegrationAccounts_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountname-get", "parameters"=>[{"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integration Accounts"]}, "put"=>{"summary"=>"Integration Accounts Create Or Update", "description"=>"Creates or updates an integration account.", "operationId"=>"IntegrationAccounts_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountname-put", "parameters"=>[{"in"=>"body", "name"=>"integrationAccount", "description"=>"The integration account", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integration Accounts"]}, "patch"=>{"summary"=>"Integration Accounts Update", "description"=>"Updates an integration account.", "operationId"=>"IntegrationAccounts_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountname-patch", "parameters"=>[{"in"=>"body", "name"=>"integrationAccount", "description"=>"The integration account", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integration Accounts"]}, "delete"=>{"summary"=>"Integration Accounts Delete", "description"=>"Deletes an integration account.", "operationId"=>"IntegrationAccounts_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountname-delete", "parameters"=>[{"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integration Accounts"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/listCallbackUrl"=>{"post"=>{"summary"=>"Integration Accounts Get Callback Url", "description"=>"Gets the integration account callback URL.", "operationId"=>"IntegrationAccounts_GetCallbackUrl", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamelistcallbackurl-post", "parameters"=>[{"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The callback URL parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integration Accounts Callback Url"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas"=>{"get"=>{"summary"=>"Schemas List By Integration Accounts", "description"=>"Gets a list of integration account schemas.", "operationId"=>"Schemas_ListByIntegrationAccounts", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnameschemas-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to be included in the result"}, {"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schemas Integration Accounts"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas/{schemaName}"=>{"get"=>{"summary"=>"Schemas Get", "description"=>"Gets an integration account schema.", "operationId"=>"Schemas_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnameschemasschemaname-get", "parameters"=>[{"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The integration account schema name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schemas"]}, "put"=>{"summary"=>"Schemas Create Or Update", "description"=>"Creates or updates an integration account schema.", "operationId"=>"Schemas_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnameschemasschemaname-put", "parameters"=>[{"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"body", "name"=>"schema", "description"=>"The integration account schema", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"schemaName", "description"=>"The integration account schema name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schemas"]}, "delete"=>{"summary"=>"Schemas Delete", "description"=>"Deletes an integration account schema.", "operationId"=>"Schemas_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnameschemasschemaname-delete", "parameters"=>[{"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The integration account schema name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schemas"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps"=>{"get"=>{"summary"=>"Maps List By Integration Accounts", "description"=>"Gets a list of integration account maps.", "operationId"=>"Maps_ListByIntegrationAccounts", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamemaps-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to be included in the result"}, {"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maps Integration Accounts"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps/{mapName}"=>{"get"=>{"summary"=>"Maps Get", "description"=>"Gets an integration account map.", "operationId"=>"Maps_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamemapsmapname-get", "parameters"=>[{"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"mapName", "description"=>"The integration account map name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maps"]}, "put"=>{"summary"=>"Maps Create Or Update", "description"=>"Creates or updates an integration account map.", "operationId"=>"Maps_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamemapsmapname-put", "parameters"=>[{"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"body", "name"=>"map", "description"=>"The integration account map", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"mapName", "description"=>"The integration account map name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maps"]}, "delete"=>{"summary"=>"Maps Delete", "description"=>"Deletes an integration account map.", "operationId"=>"Maps_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamemapsmapname-delete", "parameters"=>[{"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"mapName", "description"=>"The integration account map name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maps"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners"=>{"get"=>{"summary"=>"Partners List By Integration Accounts", "description"=>"Gets a list of integration account partners.", "operationId"=>"Partners_ListByIntegrationAccounts", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamepartners-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to be included in the result"}, {"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners Integration Accounts"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners/{partnerName}"=>{"get"=>{"summary"=>"Partners Get", "description"=>"Gets an integration account partner.", "operationId"=>"Partners_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamepartnerspartnername-get", "parameters"=>[{"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"partnerName", "description"=>"The integration account partner name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners"]}, "put"=>{"summary"=>"Partners Create Or Update", "description"=>"Creates or updates an integration account partner.", "operationId"=>"Partners_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamepartnerspartnername-put", "parameters"=>[{"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"body", "name"=>"partner", "description"=>"The integration account partner", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"partnerName", "description"=>"The integration account partner name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners"]}, "delete"=>{"summary"=>"Partners Delete", "description"=>"Deletes an integration account partner.", "operationId"=>"Partners_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamepartnerspartnername-delete", "parameters"=>[{"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"partnerName", "description"=>"The integration account partner name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements"=>{"get"=>{"summary"=>"Agreements List By Integration Accounts", "description"=>"Gets a list of integration account agreements.", "operationId"=>"Agreements_ListByIntegrationAccounts", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnameagreements-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to be included in the result"}, {"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agreements Integration Accounts"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements/{agreementName}"=>{"get"=>{"summary"=>"Agreements Get", "description"=>"Gets an integration account agreement.", "operationId"=>"Agreements_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnameagreementsagreementname-get", "parameters"=>[{"in"=>"path", "name"=>"agreementName", "description"=>"The integration account agreement name"}, {"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agreements"]}, "put"=>{"summary"=>"Agreements Create Or Update", "description"=>"Creates or updates an integration account agreement.", "operationId"=>"Agreements_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnameagreementsagreementname-put", "parameters"=>[{"in"=>"body", "name"=>"agreement", "description"=>"The integration account agreement", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"agreementName", "description"=>"The integration account agreement name"}, {"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agreements"]}, "delete"=>{"summary"=>"Agreements Delete", "description"=>"Deletes an integration account agreement.", "operationId"=>"Agreements_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnameagreementsagreementname-delete", "parameters"=>[{"in"=>"path", "name"=>"agreementName", "description"=>"The integration account agreement name"}, {"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agreements"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/certificates"=>{"get"=>{"summary"=>"Certificates List By Integration Accounts", "description"=>"Gets a list of integration account certificates.", "operationId"=>"Certificates_ListByIntegrationAccounts", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamecertificates-get", "parameters"=>[{"in"=>"query", "name"=>"$top", "description"=>"The number of items to be included in the result"}, {"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates Integration Accounts"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/certificates/{certificateName}"=>{"get"=>{"summary"=>"Certificates Get", "description"=>"Gets an integration account certificate.", "operationId"=>"Certificates_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamecertificatescertificatename-get", "parameters"=>[{"in"=>"path", "name"=>"certificateName", "description"=>"The integration account certificate name"}, {"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}, "put"=>{"summary"=>"Certificates Create Or Update", "description"=>"Creates or updates an integration account certificate.", "operationId"=>"Certificates_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamecertificatescertificatename-put", "parameters"=>[{"in"=>"body", "name"=>"certificate", "description"=>"The integration account certificate", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"certificateName", "description"=>"The integration account certificate name"}, {"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}, "delete"=>{"summary"=>"Certificates Delete", "description"=>"Deletes an integration account certificate.", "operationId"=>"Certificates_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamecertificatescertificatename-delete", "parameters"=>[{"in"=>"path", "name"=>"certificateName", "description"=>"The integration account certificate name"}, {"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/sessions"=>{"get"=>{"summary"=>"Sessions List By Integration Accounts", "description"=>"Gets a list of integration account sessions.", "operationId"=>"Sessions_ListByIntegrationAccounts", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamesessions-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to be included in the result"}, {"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions Integration Accounts"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/sessions/{sessionName}"=>{"get"=>{"summary"=>"Sessions Get", "description"=>"Gets an integration account session.", "operationId"=>"Sessions_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamesessionssessionname-get", "parameters"=>[{"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"sessionName", "description"=>"The integration account session name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions"]}, "put"=>{"summary"=>"Sessions Create Or Update", "description"=>"Creates or updates an integration account session.", "operationId"=>"Sessions_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamesessionssessionname-put", "parameters"=>[{"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"body", "name"=>"session", "description"=>"The integration account session", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"sessionName", "description"=>"The integration account session name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions"]}, "delete"=>{"summary"=>"Sessions Delete", "description"=>"Deletes an integration account session.", "operationId"=>"Sessions_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-logicintegrationaccountsintegrationaccountnamesessionssessionname-delete", "parameters"=>[{"in"=>"path", "name"=>"integrationAccountName", "description"=>"The integration account name"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group name"}, {"in"=>"path", "name"=>"sessionName", "description"=>"The integration account session name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions"]}}, "/providers/Microsoft.Logic/operations"=>{"get"=>{"summary"=>"List Operations", "description"=>"Lists all of the available Logic REST API operations.", "operationId"=>"ListOperations", "x-api-path-slug"=>"providersmicrosoft-logicoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations"]}}}}, "apis"=>{"name"=>"Azure Logic Apps", "x-slug"=>"azure-logic-apps", "description"=>"You can connect apps, data, and devices anywhere—on-premises or in the cloud—with our large ecosystem of software as a service (SaaS) and cloud-based connectors that includes Salesforce, Office 365, Twitter, Dropbox, Google services, and more. Its never been easier to access data and keep your disparate systems up-to-date, in real-time. New connectors are being added to the Azure Marketplace all of the time.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-logic-apps-01-connectors.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,iPaaS,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-logic-apps/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Logic Apps API", "x-api-slug"=>"azure-logic-apps-api", "description"=>"You can connect apps, data, and devices anywhere—on-premises or in the cloud—with our large ecosystem of software as a service (SaaS) and cloud-based connectors that includes Salesforce, Office 365, Twitter, Dropbox, Google services, and more. Its never been easier to access data and keep your disparate systems up-to-date, in real-time. New connectors are being added to the Azure Marketplace all of the time.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-logic-apps-01-connectors.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/logic-apps/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,iPaaS,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-logic-apps/providersmicrosoft-logicoperations-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-logic-apps/azure-logic-apps-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/logic-apps/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/logic-apps/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/logic-apps/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/logic-apps/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
royal-bank-of-scotland{"royal-bank-of-scotland-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Royal Bank of Scotland", "x-complete"=>1, "info"=>{"title"=>"Royal Bank of Scotland", "description"=>"this-is-an-openapi-definition-for-the-standard-set-of-open-banking-httpopenbankingapis-io-apis-for-the-royal-bank-of-scotland-", "termsOfService"=>"https://www.openbanking.org.uk/open-licence/", "contact"=>{"name"=>"API Evangelist", "url"=>"https://apievangelist.com", "email"=>"info@apievangelist.com"}, "version"=>"1.0.0"}, "host"=>"openapi.rbs.co.uk", "basePath"=>"open-banking/v2.1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"atms/"=>{"get"=>{"summary"=>"Get ATMs", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can provide multiple ATMs.", "operationId"=>"getATMS", "x-api-path-slug"=>"atms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ATMs"]}}, "branches/"=>{"get"=>{"summary"=>"Get Branches", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple branches.", "operationId"=>"getBranches", "x-api-path-slug"=>"branches-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branches"]}}, "personal-current-accounts/"=>{"get"=>{"summary"=>"Get Current Personal Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple PCA products.", "operationId"=>"getCurrentPersonalAccounts", "x-api-path-slug"=>"personalcurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "Personal", "Accounts"]}}, "business-current-accounts/"=>{"get"=>{"summary"=>"Get Current Business Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple BCA products.", "operationId"=>"getCurentBusinessAccounts", "x-api-path-slug"=>"businesscurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "Business", "Accounts"]}}, "unsecured-sme-loans/"=>{"get"=>{"summary"=>"Get Unsecured SME Loans", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Unsecured Loan products.", "operationId"=>"pathOperation", "x-api-path-slug"=>"unsecuredsmeloans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsecured", "SME", "Loans"]}}, "commercial-credit-cards/"=>{"get"=>{"summary"=>"Get Commercial Credit Cards", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Commercial Credit Card products.", "operationId"=>"getCommercialCreditCards", "x-api-path-slug"=>"commercialcreditcards-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commercial", "Credit", "Cards"]}}}}, "apis"=>{"name"=>"Royal Bank of Scotland", "x-slug"=>"royal-bank-of-scotland", "description"=>"The Royal Bank of Scotland (Scottish Gaelic: Banca Rìoghail na h-Alba, Scots: Ryal Baunk o Scotland, Welsh: Banc Brenhinol yr Alban), commonly abbreviated as RBS, is one of the retail banking subsidiaries of The Royal Bank of Scotland Group plc, together with NatWest and Ulster Bank. The Royal Bank of Scotland has around 700 branches, mainly in Scotland, though there are branches in many larger towns and cities throughout England and Wales. Both the bank and its parent, The Royal Bank of Scotland Group, are completely separate from the fellow Edinburgh-based bank, the Bank of Scotland, which pre-dates The Royal Bank of Scotland by 32 years.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/royal-bank-of-scotland.png", "x-kinRank"=>"7", "x-alexaRank"=>"52820", "tags"=>"Banking,General Data,Relative Data,SaaS,UK Banks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"royal-bank-of-scotland/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Royal Bank of Scotland", "x-api-slug"=>"royal-bank-of-scotland", "description"=>"The Royal Bank of Scotland (Scottish Gaelic: Banca Rìoghail na h-Alba, Scots: Ryal Baunk o Scotland, Welsh: Banc Brenhinol yr Alban), commonly abbreviated as RBS, is one of the retail banking subsidiaries of The Royal Bank of Scotland Group plc, together with NatWest and Ulster Bank. The Royal Bank of Scotland has around 700 branches, mainly in Scotland, though there are branches in many larger towns and cities throughout England and Wales. Both the bank and its parent, The Royal Bank of Scotland Group, are completely separate from the fellow Edinburgh-based bank, the Bank of Scotland, which pre-dates The Royal Bank of Scotland by 32 years.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/royal-bank-of-scotland.png", "humanURL"=>"https://www.rbs.com", "baseURL"=>"https://openapi.rbs.co.uk/open-banking/v2.1/", "tags"=>"Banking,General Data,Relative Data,SaaS,UK Banks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/royal-bank-of-scotland/commercialcreditcards-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/royal-bank-of-scotland/royal-bank-of-scotland-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-contact-form", "url"=>"http://www.bankofapis.com/Home/Contact"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/royal-bank-of-scotland"}, {"type"=>"x-developer", "url"=>"http://openbankingapis.io/uk/royal-bank-of-scotland"}, {"type"=>"x-documentation", "url"=>"https://openbanking.atlassian.net/wiki/spaces/DZ/pages/54919225/Open+Data+API+Dashboard#"}, {"type"=>"x-faq", "url"=>"http://www.bankofapis.com/Home/FAQ"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/bankofapis"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/RBS"}, {"type"=>"x-hackathon", "url"=>"http://www.bankofapis.com"}, {"type"=>"x-website", "url"=>"https://www.rbs.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-cognitive-services{"azure-cognitive-services-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Cognitive Services", "x-complete"=>1, "info"=>{"title"=>"CognitiveServicesManagementClient", "description"=>"cognitive-services-management-client", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}"=>{"put"=>{"summary"=>"Cognitive Services Accounts Create", "description"=>"Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.", "operationId"=>"CognitiveServicesAccounts_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cognitiveservicesaccountsaccountname-put", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of Cognitive Services account"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters to provide for the created account", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group within the users subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Cognitive Service"]}, "patch"=>{"summary"=>"Cognitive Services Accounts Update", "description"=>"Updates a Cognitive Services account", "operationId"=>"CognitiveServicesAccounts_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cognitiveservicesaccountsaccountname-patch", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of Cognitive Services account"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters to provide for the created account", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group within the users subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Cognitive Service"]}, "delete"=>{"summary"=>"Cognitive Services Accounts Delete", "description"=>"Deletes a Cognitive Services account from the resource group.", "operationId"=>"CognitiveServicesAccounts_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cognitiveservicesaccountsaccountname-delete", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of Cognitive Services account"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group within the users subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Cognitive Service"]}, "get"=>{"summary"=>"Cognitive Services Accounts Get Properties", "description"=>"Returns a Cognitive Services account specified by the parameters.", "operationId"=>"CognitiveServicesAccounts_GetProperties", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cognitiveservicesaccountsaccountname-get", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of Cognitive Services account"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group within the users subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Cognitive Service"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts"=>{"get"=>{"summary"=>"Accounts List By Resource Group", "description"=>"Returns all the resources of a particular type belonging to a resource group", "operationId"=>"Accounts_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cognitiveservicesaccounts-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group within the users subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Account"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/accounts"=>{"get"=>{"summary"=>"Accounts List", "description"=>"Returns all the resources of a particular type belonging to a subscription.", "operationId"=>"Accounts_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-cognitiveservicesaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/listKeys"=>{"post"=>{"summary"=>"Cognitive Services Accounts List Keys", "description"=>"Lists the account keys for the specified Cognitive Services account.", "operationId"=>"CognitiveServicesAccounts_ListKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cognitiveservicesaccountsaccountnamelistkeys-post", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of Cognitive Services account"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group within the users subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Cognitive Service"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/regenerateKey"=>{"post"=>{"summary"=>"Cognitive Services Accounts Regenerate Key", "description"=>"Regenerates the specified account key for the specified Cognitive Services account.", "operationId"=>"CognitiveServicesAccounts_RegenerateKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cognitiveservicesaccountsaccountnameregeneratekey-post", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of Cognitive Services account"}, {"in"=>"body", "name"=>"parameters", "description"=>"regenerate key parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group within the users subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Cognitive Service"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/skus"=>{"get"=>{"summary"=>"Cognitive Services Accounts List Skus", "description"=>"List available SKUs for the requested Cognitive Services account", "operationId"=>"CognitiveServicesAccounts_ListSkus", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cognitiveservicesaccountsaccountnameskus-get", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of Cognitive Services account"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group within the users subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Cognitive Service"]}}, "/providers/Microsoft.CognitiveServices/operations"=>{"get"=>{"summary"=>"Operations List", "description"=>"Lists all the available Cognitive Services account operations.", "operationId"=>"Operations_List", "x-api-path-slug"=>"providersmicrosoft-cognitiveservicesoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Operation"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/checkSkuAvailability"=>{"post"=>{"summary"=>"Check Sku Availability List", "description"=>"Check available SKUs.", "operationId"=>"CheckSkuAvailability_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-cognitiveserviceslocationslocationcheckskuavailability-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Check SKU Availablity POST body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "SKU"]}}}}, "apis"=>{"name"=>"Azure Cognitive Services", "x-slug"=>"azure-cognitive-services", "description"=>"Enable natural and contextual interaction with tools that augment users experiences using the power of machine-based intelligence. Tap into an ever-growing collection of powerful artificial intelligence algorithms for vision, speech, language, and knowledge.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/cognitive-services.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Cognitive,Machine Learning,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-cognitive-services/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Cognitive Services", "x-api-slug"=>"azure-cognitive-services", "description"=>"Enable natural and contextual interaction with tools that augment users experiences using the power of machine-based intelligence. Tap into an ever-growing collection of powerful artificial intelligence algorithms for vision, speech, language, and knowledge.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/cognitive-services.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/cognitive-services/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Cognitive,Machine Learning,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/azure-cognitive-services/azure-cognitive-services-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/cognitive-services/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/cognitive-services/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/cognitive-services/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/cognitive-services/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-calendar{"google-calendar-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Calendar", "x-complete"=>1, "info"=>{"title"=>"Google Calendar", "description"=>"manipulates-events-and-other-calendar-data-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v3/"}, "host"=>"www.googleapis.com", "basePath"=>"/calendar/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/calendars"=>{"post"=>{"summary"=>"Create Calendar", "description"=>"Creates a secondary calendar.", "operationId"=>"calendar.calendars.insert", "x-api-path-slug"=>"calendars-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/calendars/{calendarId}"=>{"delete"=>{"summary"=>"CreaDeletete Calendar", "description"=>"Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.", "operationId"=>"calendar.calendars.delete", "x-api-path-slug"=>"calendarscalendarid-delete", "parameters"=>[{"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "get"=>{"summary"=>"Get Calendar", "description"=>"Returns metadata for a calendar.", "operationId"=>"calendar.calendars.get", "x-api-path-slug"=>"calendarscalendarid-get", "parameters"=>[{"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "patch"=>{"summary"=>"Update Calendar", "description"=>"Updates metadata for a calendar. This method supports patch semantics.", "operationId"=>"calendar.calendars.patch", "x-api-path-slug"=>"calendarscalendarid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "put"=>{"summary"=>"Update Calendar", "description"=>"Updates metadata for a calendar.", "operationId"=>"calendar.calendars.update", "x-api-path-slug"=>"calendarscalendarid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/calendars/{calendarId}/acl"=>{"get"=>{"summary"=>"Get Calendar ACL", "description"=>"Returns the rules in the access control list for the calendar.", "operationId"=>"calendar.acl.list", "x-api-path-slug"=>"calendarscalendaridacl-get", "parameters"=>[{"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of entries returned on one result page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token specifying which result page to return"}, {"in"=>"query", "name"=>"showDeleted", "description"=>"Whether to include deleted ACLs in the result"}, {"in"=>"query", "name"=>"syncToken", "description"=>"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar ACL"]}, "post"=>{"summary"=>"Create Calendar ACL", "description"=>"Creates an access control rule.", "operationId"=>"calendar.acl.insert", "x-api-path-slug"=>"calendarscalendaridacl-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar ACL"]}}, "/calendars/{calendarId}/acl/watch"=>{"post"=>{"summary"=>"Watch Calendar ACL", "description"=>"Watch for changes to ACL resources.", "operationId"=>"calendar.acl.watch", "x-api-path-slug"=>"calendarscalendaridaclwatch-post", "parameters"=>[{"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of entries returned on one result page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token specifying which result page to return"}, {"in"=>"body", "name"=>"resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"showDeleted", "description"=>"Whether to include deleted ACLs in the result"}, {"in"=>"query", "name"=>"syncToken", "description"=>"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar ACL"]}}, "/calendars/{calendarId}/acl/{ruleId}"=>{"delete"=>{"summary"=>"Delete Calendar ACL", "description"=>"Deletes an access control rule.", "operationId"=>"calendar.acl.delete", "x-api-path-slug"=>"calendarscalendaridaclruleid-delete", "parameters"=>[{"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"path", "name"=>"ruleId", "description"=>"ACL rule identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar ACL"]}, "get"=>{"summary"=>"Get Calendar ACL", "description"=>"Returns an access control rule.", "operationId"=>"calendar.acl.get", "x-api-path-slug"=>"calendarscalendaridaclruleid-get", "parameters"=>[{"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"path", "name"=>"ruleId", "description"=>"ACL rule identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar ACL"]}, "patch"=>{"summary"=>"Update Calendar ACL", "description"=>"Updates an access control rule. This method supports patch semantics.", "operationId"=>"calendar.acl.patch", "x-api-path-slug"=>"calendarscalendaridaclruleid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"path", "name"=>"ruleId", "description"=>"ACL rule identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar ACL"]}, "put"=>{"summary"=>"Update Calendar ACL", "description"=>"Updates an access control rule.", "operationId"=>"calendar.acl.update", "x-api-path-slug"=>"calendarscalendaridaclruleid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"path", "name"=>"ruleId", "description"=>"ACL rule identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar ACL"]}}, "/calendars/{calendarId}/clear"=>{"post"=>{"summary"=>"Clear Primary Calendar", "description"=>"Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.", "operationId"=>"calendar.calendars.clear", "x-api-path-slug"=>"calendarscalendaridclear-post", "parameters"=>[{"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/calendars/{calendarId}/events"=>{"get"=>{"summary"=>"Get Events", "description"=>"Returns events on the specified calendar.", "operationId"=>"calendar.events.list", "x-api-path-slug"=>"calendarscalendaridevents-get", "parameters"=>[{"in"=>"query", "name"=>"alwaysIncludeEmail", "description"=>"Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i"}, {"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"query", "name"=>"iCalUID", "description"=>"Specifies event ID in the iCalendar format to be included in the response"}, {"in"=>"query", "name"=>"maxAttendees", "description"=>"The maximum number of attendees to include in the response"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of events returned on one result page"}, {"in"=>"query", "name"=>"orderBy", "description"=>"The order of the events returned in the result"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token specifying which result page to return"}, {"in"=>"query", "name"=>"privateExtendedProperty", "description"=>"Extended properties constraint specified as propertyName=value"}, {"in"=>"query", "name"=>"q", "description"=>"Free text search terms to find events that match these terms in any field, except for extended properties"}, {"in"=>"query", "name"=>"sharedExtendedProperty", "description"=>"Extended properties constraint specified as propertyName=value"}, {"in"=>"query", "name"=>"showDeleted", "description"=>"Whether to include deleted events (with status equals cancelled) in the result"}, {"in"=>"query", "name"=>"showHiddenInvitations", "description"=>"Whether to include hidden invitations in the result"}, {"in"=>"query", "name"=>"singleEvents", "description"=>"Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves"}, {"in"=>"query", "name"=>"syncToken", "description"=>"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request"}, {"in"=>"query", "name"=>"timeMax", "description"=>"Upper bound (exclusive) for an events start time to filter by"}, {"in"=>"query", "name"=>"timeMin", "description"=>"Lower bound (inclusive) for an events end time to filter by"}, {"in"=>"query", "name"=>"timeZone", "description"=>"Time zone used in the response"}, {"in"=>"query", "name"=>"updatedMin", "description"=>"Lower bound for an events last modification time (as a RFC3339 timestamp) to filter by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "post"=>{"summary"=>"Create Event", "description"=>"Creates an event.", "operationId"=>"calendar.events.insert", "x-api-path-slug"=>"calendarscalendaridevents-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"query", "name"=>"maxAttendees", "description"=>"The maximum number of attendees to include in the response"}, {"in"=>"query", "name"=>"sendNotifications", "description"=>"Whether to send notifications about the creation of the new event"}, {"in"=>"query", "name"=>"supportsAttachments", "description"=>"Whether API client performing operation supports event attachments"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/calendars/{calendarId}/events/import"=>{"post"=>{"summary"=>"Import Event", "description"=>"Imports an event. This operation is used to add a private copy of an existing event to a calendar.", "operationId"=>"calendar.events.import", "x-api-path-slug"=>"calendarscalendarideventsimport-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"query", "name"=>"supportsAttachments", "description"=>"Whether API client performing operation supports event attachments"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/calendars/{calendarId}/events/quickAdd"=>{"post"=>{"summary"=>"Create Event", "description"=>"Creates an event based on a simple text string.", "operationId"=>"calendar.events.quickAdd", "x-api-path-slug"=>"calendarscalendarideventsquickadd-post", "parameters"=>[{"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"query", "name"=>"sendNotifications", "description"=>"Whether to send notifications about the creation of the event"}, {"in"=>"query", "name"=>"text", "description"=>"The text describing the event to be created"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/calendars/{calendarId}/events/watch"=>{"post"=>{"summary"=>"Watch Event", "description"=>"Watch for changes to Events resources.", "operationId"=>"calendar.events.watch", "x-api-path-slug"=>"calendarscalendarideventswatch-post", "parameters"=>[{"in"=>"query", "name"=>"alwaysIncludeEmail", "description"=>"Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i"}, {"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"query", "name"=>"iCalUID", "description"=>"Specifies event ID in the iCalendar format to be included in the response"}, {"in"=>"query", "name"=>"maxAttendees", "description"=>"The maximum number of attendees to include in the response"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of events returned on one result page"}, {"in"=>"query", "name"=>"orderBy", "description"=>"The order of the events returned in the result"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token specifying which result page to return"}, {"in"=>"query", "name"=>"privateExtendedProperty", "description"=>"Extended properties constraint specified as propertyName=value"}, {"in"=>"query", "name"=>"q", "description"=>"Free text search terms to find events that match these terms in any field, except for extended properties"}, {"in"=>"body", "name"=>"resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"sharedExtendedProperty", "description"=>"Extended properties constraint specified as propertyName=value"}, {"in"=>"query", "name"=>"showDeleted", "description"=>"Whether to include deleted events (with status equals cancelled) in the result"}, {"in"=>"query", "name"=>"showHiddenInvitations", "description"=>"Whether to include hidden invitations in the result"}, {"in"=>"query", "name"=>"singleEvents", "description"=>"Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves"}, {"in"=>"query", "name"=>"syncToken", "description"=>"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request"}, {"in"=>"query", "name"=>"timeMax", "description"=>"Upper bound (exclusive) for an events start time to filter by"}, {"in"=>"query", "name"=>"timeMin", "description"=>"Lower bound (inclusive) for an events end time to filter by"}, {"in"=>"query", "name"=>"timeZone", "description"=>"Time zone used in the response"}, {"in"=>"query", "name"=>"updatedMin", "description"=>"Lower bound for an events last modification time (as a RFC3339 timestamp) to filter by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/calendars/{calendarId}/events/{eventId}"=>{"delete"=>{"summary"=>"Delete Event", "description"=>"Deletes an event.", "operationId"=>"calendar.events.delete", "x-api-path-slug"=>"calendarscalendarideventseventid-delete", "parameters"=>[{"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"path", "name"=>"eventId", "description"=>"Event identifier"}, {"in"=>"query", "name"=>"sendNotifications", "description"=>"Whether to send notifications about the deletion of the event"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "get"=>{"summary"=>"Get Event", "description"=>"Returns an event.", "operationId"=>"calendar.events.get", "x-api-path-slug"=>"calendarscalendarideventseventid-get", "parameters"=>[{"in"=>"query", "name"=>"alwaysIncludeEmail", "description"=>"Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i"}, {"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"path", "name"=>"eventId", "description"=>"Event identifier"}, {"in"=>"query", "name"=>"maxAttendees", "description"=>"The maximum number of attendees to include in the response"}, {"in"=>"query", "name"=>"timeZone", "description"=>"Time zone used in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "patch"=>{"summary"=>"Update Event", "description"=>"Updates an event. This method supports patch semantics.", "operationId"=>"calendar.events.patch", "x-api-path-slug"=>"calendarscalendarideventseventid-patch", "parameters"=>[{"in"=>"query", "name"=>"alwaysIncludeEmail", "description"=>"Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"path", "name"=>"eventId", "description"=>"Event identifier"}, {"in"=>"query", "name"=>"maxAttendees", "description"=>"The maximum number of attendees to include in the response"}, {"in"=>"query", "name"=>"sendNotifications", "description"=>"Whether to send notifications about the event update (e"}, {"in"=>"query", "name"=>"supportsAttachments", "description"=>"Whether API client performing operation supports event attachments"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "put"=>{"summary"=>"Update Event", "description"=>"Updates an event.", "operationId"=>"calendar.events.update", "x-api-path-slug"=>"calendarscalendarideventseventid-put", "parameters"=>[{"in"=>"query", "name"=>"alwaysIncludeEmail", "description"=>"Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"path", "name"=>"eventId", "description"=>"Event identifier"}, {"in"=>"query", "name"=>"maxAttendees", "description"=>"The maximum number of attendees to include in the response"}, {"in"=>"query", "name"=>"sendNotifications", "description"=>"Whether to send notifications about the event update (e"}, {"in"=>"query", "name"=>"supportsAttachments", "description"=>"Whether API client performing operation supports event attachments"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/calendars/{calendarId}/events/{eventId}/instances"=>{"get"=>{"summary"=>"Get Event Instance", "description"=>"Returns instances of the specified recurring event.", "operationId"=>"calendar.events.instances", "x-api-path-slug"=>"calendarscalendarideventseventidinstances-get", "parameters"=>[{"in"=>"query", "name"=>"alwaysIncludeEmail", "description"=>"Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i"}, {"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"path", "name"=>"eventId", "description"=>"Recurring event identifier"}, {"in"=>"query", "name"=>"maxAttendees", "description"=>"The maximum number of attendees to include in the response"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of events returned on one result page"}, {"in"=>"query", "name"=>"originalStart", "description"=>"The original start time of the instance in the result"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token specifying which result page to return"}, {"in"=>"query", "name"=>"showDeleted", "description"=>"Whether to include deleted events (with status equals cancelled) in the result"}, {"in"=>"query", "name"=>"timeMax", "description"=>"Upper bound (exclusive) for an events start time to filter by"}, {"in"=>"query", "name"=>"timeMin", "description"=>"Lower bound (inclusive) for an events end time to filter by"}, {"in"=>"query", "name"=>"timeZone", "description"=>"Time zone used in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/calendars/{calendarId}/events/{eventId}/move"=>{"post"=>{"summary"=>"Move Event", "description"=>"Moves an event to another calendar, i.e. changes an event's organizer.", "operationId"=>"calendar.events.move", "x-api-path-slug"=>"calendarscalendarideventseventidmove-post", "parameters"=>[{"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier of the source calendar where the event currently is on"}, {"in"=>"query", "name"=>"destination", "description"=>"Calendar identifier of the target calendar where the event is to be moved to"}, {"in"=>"path", "name"=>"eventId", "description"=>"Event identifier"}, {"in"=>"query", "name"=>"sendNotifications", "description"=>"Whether to send notifications about the change of the events organizer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/channels/stop"=>{"post"=>{"summary"=>"Stop Watching Resource", "description"=>"Stop watching resources through this channel", "operationId"=>"calendar.channels.stop", "x-api-path-slug"=>"channelsstop-post", "parameters"=>[{"in"=>"body", "name"=>"resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch"]}}, "/colors"=>{"get"=>{"summary"=>"Get Colors", "description"=>"Returns the color definitions for calendars and events.", "operationId"=>"calendar.colors.get", "x-api-path-slug"=>"colors-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Color"]}}, "/freeBusy"=>{"post"=>{"summary"=>"Return Free/Busy Information", "description"=>"Returns free/busy information for a set of calendars.", "operationId"=>"calendar.freebusy.query", "x-api-path-slug"=>"freebusy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Free/Busy"]}}, "/users/me/calendarList"=>{"get"=>{"summary"=>"Return Entries", "description"=>"Returns entries on the user's calendar list.", "operationId"=>"calendar.calendarList.list", "x-api-path-slug"=>"usersmecalendarlist-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of entries returned on one result page"}, {"in"=>"query", "name"=>"minAccessRole", "description"=>"The minimum access role for the user in the returned entries"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token specifying which result page to return"}, {"in"=>"query", "name"=>"showDeleted", "description"=>"Whether to include deleted calendar list entries in the result"}, {"in"=>"query", "name"=>"showHidden", "description"=>"Whether to show hidden entries"}, {"in"=>"query", "name"=>"syncToken", "description"=>"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "post"=>{"summary"=>"Add Entry", "description"=>"Adds an entry to the user's calendar list.", "operationId"=>"calendar.calendarList.insert", "x-api-path-slug"=>"usersmecalendarlist-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"colorRgbFormat", "description"=>"Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/users/me/calendarList/watch"=>{"post"=>{"summary"=>"Watch Entry", "description"=>"Watch for changes to CalendarList resources.", "operationId"=>"calendar.calendarList.watch", "x-api-path-slug"=>"usersmecalendarlistwatch-post", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of entries returned on one result page"}, {"in"=>"query", "name"=>"minAccessRole", "description"=>"The minimum access role for the user in the returned entries"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token specifying which result page to return"}, {"in"=>"body", "name"=>"resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"showDeleted", "description"=>"Whether to include deleted calendar list entries in the result"}, {"in"=>"query", "name"=>"showHidden", "description"=>"Whether to show hidden entries"}, {"in"=>"query", "name"=>"syncToken", "description"=>"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/users/me/calendarList/{calendarId}"=>{"delete"=>{"summary"=>"Delete Entry", "description"=>"Deletes an entry on the user's calendar list.", "operationId"=>"calendar.calendarList.delete", "x-api-path-slug"=>"usersmecalendarlistcalendarid-delete", "parameters"=>[{"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "get"=>{"summary"=>"Get Entry", "description"=>"Returns an entry on the user's calendar list.", "operationId"=>"calendar.calendarList.get", "x-api-path-slug"=>"usersmecalendarlistcalendarid-get", "parameters"=>[{"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "patch"=>{"summary"=>"Update Entry", "description"=>"Updates an entry on the user's calendar list. This method supports patch semantics.", "operationId"=>"calendar.calendarList.patch", "x-api-path-slug"=>"usersmecalendarlistcalendarid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"query", "name"=>"colorRgbFormat", "description"=>"Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "put"=>{"summary"=>"Update Entry", "description"=>"Updates an entry on the user's calendar list.", "operationId"=>"calendar.calendarList.update", "x-api-path-slug"=>"usersmecalendarlistcalendarid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"calendarId", "description"=>"Calendar identifier"}, {"in"=>"query", "name"=>"colorRgbFormat", "description"=>"Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/users/me/settings"=>{"get"=>{"summary"=>"Get Settings", "description"=>"Returns all user settings for the authenticated user.", "operationId"=>"calendar.settings.list", "x-api-path-slug"=>"usersmesettings-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of entries returned on one result page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token specifying which result page to return"}, {"in"=>"query", "name"=>"syncToken", "description"=>"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Setting"]}}, "/users/me/settings/watch"=>{"post"=>{"summary"=>"Watch Settings", "description"=>"Watch for changes to Settings resources.", "operationId"=>"calendar.settings.watch", "x-api-path-slug"=>"usersmesettingswatch-post", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of entries returned on one result page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token specifying which result page to return"}, {"in"=>"body", "name"=>"resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"syncToken", "description"=>"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Setting"]}}, "/users/me/settings/{setting}"=>{"get"=>{"summary"=>"Get Setting", "description"=>"Returns a single user setting.", "operationId"=>"calendar.settings.get", "x-api-path-slug"=>"usersmesettingssetting-get", "parameters"=>[{"in"=>"path", "name"=>"setting", "description"=>"The id of the user setting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Setting"]}}}}, "apis"=>{"name"=>"Google Calendar", "x-slug"=>"google-calendar", "description"=>"The Calendar API lets you display, create and modify calendar events as well as work with many other calendar-related objects, such as calendars or access controls. This document describes how to use RESTful calls and client libraries for various programming languages (Java, PHP, .NET, JavaScript, NodeJs, Ruby, Python, Go, Android, iOS).", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-calendar-icon-66527.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Calendar,Google APIs,Productivity,Profiles,Relative Data,Service API,Stack,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-calendar/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Calendar", "x-api-slug"=>"google-calendar", "description"=>"The Calendar API lets you display, create and modify calendar events as well as work with many other calendar-related objects, such as calendars or access controls. This document describes how to use RESTful calls and client libraries for various programming languages (Java, PHP, .NET, JavaScript, NodeJs, Ruby, Python, Go, Android, iOS).", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-calendar-icon-66527.png", "humanURL"=>"https://developers.google.com/google-apps/calendar/", "baseURL"=>"https://www.googleapis.com//calendar/v3", "tags"=>"API Provider,API Service Provider,Calendar,Google APIs,Productivity,Profiles,Relative Data,Service API,Stack,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-calendar/google-calendar-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-code", "url"=>"https://developers.google.com/google-apps/calendar/downloads"}, {"type"=>"x-documentation", "url"=>"https://developers.google.com/google-apps/calendar/v3/reference/"}, {"type"=>"x-website", "url"=>"https://developers.google.com/google-apps/calendar/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
qualpay{"qualpay-payment-gateway-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Qualpay", "x-complete"=>1, "info"=>{"title"=>"Qualpay Payment Gateway", "description"=>"this-document-describes-the-qualpay-payment-gateway-api-", "version"=>"1.7"}, "host"=>"api-test.qualpay.com", "basePath"=>"/pg", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/auth"=>{"post"=>{"summary"=>"Authorize transaction", "description"=>"An approved transaction will continue to be open until it expires or a capture message is received. Authorizations are automatically voided if they are not captured within 28 days, although most issuing banks will release the hold after 24 hours in retail environments or 7 days in card not present environments.", "operationId"=>"Authorization", "x-api-path-slug"=>"auth-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment Gateway Authorization Request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/batchClose"=>{"post"=>{"summary"=>"Close batch", "description"=>"This message is used when the timing of the batch close needs to be controlled by the merchant rather than relying on the daily automatic batch close.", "operationId"=>"batchClose.post", "x-api-path-slug"=>"batchclose-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment Gateway Batch Close Request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/capture/{pgIdOrig}"=>{"post"=>{"summary"=>"Capture authorized transaction", "description"=>"A capture message may be completed for any amount up to the originally authorized amount.", "operationId"=>"Capture", "x-api-path-slug"=>"capturepgidorig-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment Gateway Capture Request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"pgIdOrig", "description"=>"pgIdOrig"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/credit"=>{"post"=>{"summary"=>"Issue credit to cardholder", "description"=>"A non-referenced credit requires that the cardholder data be provided in the message. This message is only available during the first 30 days of account production activity - the refund message should generally be used to return money to the cardholder.", "operationId"=>"Credit", "x-api-path-slug"=>"credit-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment Gateway Credit Request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/force"=>{"post"=>{"summary"=>"Force transaction approval", "description"=>"Can be used when an online authorization request received a 'declined' reason code and the merchant received an authorization from a voice or automated response (ARU) system. The required fields are the same as a sale or authorization request, except that the expiration date (exp_date) is not required, and the 6-character authorization code (auth_code) IS required.", "operationId"=>"Force", "x-api-path-slug"=>"force-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment Gateway Force Request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/refund/{pgIdOrig}"=>{"post"=>{"summary"=>"Refund previously captured transaction", "description"=>"Returns money to the cardholder from a previously captured transaction. Multiple refunds are allowed per captured transaction, provided that the sum of all refunds does not exceed the original captured transaction amount. Authorizations that have not been captured are not eligible for refund.", "operationId"=>"Refund", "x-api-path-slug"=>"refundpgidorig-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment Gateway Refund Request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"pgIdOrig", "description"=>"pgIdOrig"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/sale"=>{"post"=>{"summary"=>"Sale (Auth + Capture)", "description"=>"This message will perform an authorization of the transaction, and if approved will immediately capture the transaction to be included in the next batch close. It is used in card present environments, and also card not present environments where no physical goods are being shipped.", "operationId"=>"Sale", "x-api-path-slug"=>"sale-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment Gateway Sale Request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/tokenize"=>{"post"=>{"summary"=>"Tokenize card", "description"=>"Once stored, a unique card identifier is returned for use in future transactions. Optionally, tokenization can be requested in an auth, verify, force, credit, or sale message by sending the tokenize field set to true.", "operationId"=>"Tokenize", "x-api-path-slug"=>"tokenize-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment Gateway Tokenize Request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/verify"=>{"post"=>{"summary"=>"Verify Card", "description"=>"A verify message will return success if the cardholder information was verified by the issuer. If AVS or CVV data is included in the message, then the AVS or CVV result code will be returned in the response message.", "operationId"=>"Verify", "x-api-path-slug"=>"verify-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment Gateway Card Verify Request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/void/{pgIdOrig}"=>{"post"=>{"summary"=>"Void previously authorized transaction", "description"=>"Authorizations can be voided at any time. Captured transactions can be voided until the batch is closed.", "operationId"=>"Void", "x-api-path-slug"=>"voidpgidorig-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Payment Gateway Void Request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"pgIdOrig", "description"=>"pgIdOrig"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"Qualpay", "x-slug"=>"qualpay", "description"=>"We provide an omnichannel payments platform, easily adaptable to individual needs, whether you are a business, a developer or a partner including Independent Sales Organizations (ISO) and Independent Software Vendor (ISV). Our fully-integrated payments platform combines a merchant account with a payment solution and reporting that todays businesses require.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/qualpay.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Payments,Relative Data,Service API,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"qualpay/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Qualpay Payment Gateway", "x-api-slug"=>"qualpay-payment-gateway", "description"=>"We provide an omnichannel payments platform, easily adaptable to individual needs, whether you are a business, a developer or a partner including Independent Sales Organizations (ISO) and Independent Software Vendor (ISV). Our fully-integrated payments platform combines a merchant account with a payment solution and reporting that todays businesses require.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/qualpay.png", "humanURL"=>"http://qualpay.com", "baseURL"=>"https://api-test.qualpay.com//pg", "tags"=>"Payments,Relative Data,Service API,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/qualpay/qualpay-payment-gateway-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"https://www.qualpay.com/developer/"}, {"type"=>"x-webhook", "url"=>"https://www.qualpay.com/developer/api/webhooks/get-events"}, {"type"=>"x-website", "url"=>"http://qualpay.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-codecommit{"apis"=>{"name"=>"AWS CodeCommit", "x-slug"=>"aws-codecommit", "description"=>"AWS CodeCommit is a fully-managed source control service that makes it easy for companies to host secure and highly scalable private Git repositories. CodeCommit eliminates the need to operate your own source control system or worry about scaling its infrastructure. You can use CodeCommit to securely store anything from source code to binaries, and it works seamlessly with your existing Git tools.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Developer-Tools_AWSCodeCommit.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Orchestration,Profiles,Relative Data,SDK,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-codecommit/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS CodeCommit API", "x-api-slug"=>"aws-codecommit-api", "description"=>"AWS CodeCommit is a fully-managed source control service that makes it easy for companies to host secure and highly scalable private Git repositories. CodeCommit eliminates the need to operate your own source control system or worry about scaling its infrastructure. You can use CodeCommit to securely store anything from source code to binaries, and it works seamlessly with your existing Git tools.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Developer-Tools_AWSCodeCommit.png", "humanURL"=>"https://aws.amazon.com/codecommit/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Orchestration,Profiles,Relative Data,SDK,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-codecommit/aws-codecommit-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/cli/latest/reference/codecommit/index.html"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/codecommit/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/codecommit/faqs/"}, {"type"=>"x-getting-started", "url"=>"ttps://aws.amazon.com/codecommit/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/codecommit/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/codecommit/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "aws-codecommit-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS CodeCommit", "x-complete"=>1, "info"=>{"title"=>"AWS CodeCommit API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=BatchGetRepositories"=>{"get"=>{"summary"=>"Batch Get Repositories", "description"=>"Returns information about one or more repositories.", "operationId"=>"batchGetRepositories", "x-api-path-slug"=>"actionbatchgetrepositories-get", "parameters"=>[{"in"=>"query", "name"=>"repositoryNames", "description"=>"The names of the repositories to get information about", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories"]}}, "/?Action=CreateBranch"=>{"get"=>{"summary"=>"Create Branch", "description"=>"Creates a new branch in a repository and points the branch to a commit.", "operationId"=>"createBranch", "x-api-path-slug"=>"actioncreatebranch-get", "parameters"=>[{"in"=>"query", "name"=>"branchName", "description"=>"The name of the new branch to create", "type"=>"string"}, {"in"=>"query", "name"=>"commitId", "description"=>"The ID of the commit to point the new branch to", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository in which you want to create the new branch", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branch"]}}, "/?Action=CreateRepository"=>{"get"=>{"summary"=>"Create Repository", "description"=>"Creates a new, empty repository.", "operationId"=>"createRepository", "x-api-path-slug"=>"actioncreaterepository-get", "parameters"=>[{"in"=>"query", "name"=>"repositoryDescription", "description"=>"A comment or description about the new repository", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the new repository to be created", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories"]}}, "/?Action=DeleteRepository"=>{"get"=>{"summary"=>"Delete Repository", "description"=>"Deletes a repository.", "operationId"=>"deleteRepository", "x-api-path-slug"=>"actiondeleterepository-get", "parameters"=>[{"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories"]}}, "/?Action=GetBranch"=>{"get"=>{"summary"=>"Get Branch", "description"=>"Returns information about a repository branch, including its name and the last commit ID.", "operationId"=>"getBranch", "x-api-path-slug"=>"actiongetbranch-get", "parameters"=>[{"in"=>"query", "name"=>"branchName", "description"=>"The name of the branch for which you want to retrieve information", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository that contains the branch for which you want to retrieve information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branches"]}}, "/?Action=GetCommit"=>{"get"=>{"summary"=>"Get Commit", "description"=>"Returns information about a commit, including commit message and committer information.", "operationId"=>"getCommit", "x-api-path-slug"=>"actiongetcommit-get", "parameters"=>[{"in"=>"query", "name"=>"commitId", "description"=>"The commit ID", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository to which the commit was made", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commits"]}}, "/?Action=GetRepository"=>{"get"=>{"summary"=>"Get Repository", "description"=>"Returns information about a repository.", "operationId"=>"getRepository", "x-api-path-slug"=>"actiongetrepository-get", "parameters"=>[{"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository to get information about", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories"]}}, "/?Action=GetRepositoryTriggers"=>{"get"=>{"summary"=>"Get Repository Triggers", "description"=>"Gets information about triggers configured for a repository.", "operationId"=>"getRepositoryTriggers", "x-api-path-slug"=>"actiongetrepositorytriggers-get", "parameters"=>[{"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository for which the trigger is configured", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repository Triggers"]}}, "/?Action=ListBranches"=>{"get"=>{"summary"=>"List Branches", "description"=>"Gets information about one or more branches in a repository.", "operationId"=>"listBranches", "x-api-path-slug"=>"actionlistbranches-get", "parameters"=>[{"in"=>"query", "name"=>"nextToken", "description"=>"An enumeration token that allows the operation to batch the results", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository that contains the branches", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branches"]}}, "/?Action=ListRepositories"=>{"get"=>{"summary"=>"List Repositories", "description"=>"Gets information about one or more repositories.", "operationId"=>"listRepositories", "x-api-path-slug"=>"actionlistrepositories-get", "parameters"=>[{"in"=>"query", "name"=>"nextToken", "description"=>"An enumeration token that allows the operation to batch the results of the operation", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"The order in which to sort the results of a list repositories operation", "type"=>"string"}, {"in"=>"query", "name"=>"sortBy", "description"=>"The criteria used to sort the results of a list repositories operation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories"]}}, "/?Action=PutRepositoryTriggers"=>{"get"=>{"summary"=>"Put Repository Triggers", "description"=>"Replaces all triggers for a repository.", "operationId"=>"putRepositoryTriggers", "x-api-path-slug"=>"actionputrepositorytriggers-get", "parameters"=>[{"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository where you want to create or update the trigger", "type"=>"string"}, {"in"=>"query", "name"=>"triggers", "description"=>"The JSON block of configuration information for each trigger", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repository Triggers"]}}, "/?Action=TestRepositoryTriggers"=>{"get"=>{"summary"=>"Test Repository Triggers", "description"=>"Tests the functionality of repository triggers by sending information to the trigger target.", "operationId"=>"testRepositoryTriggers", "x-api-path-slug"=>"actiontestrepositorytriggers-get", "parameters"=>[{"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository in which to test the triggers", "type"=>"string"}, {"in"=>"query", "name"=>"triggers", "description"=>"The list of triggers to test", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repository Triggers"]}}, "/?Action=UpdateDefaultBranch"=>{"get"=>{"summary"=>"Update Default Branch", "description"=>"Sets or changes the default branch name for the specified repository.", "operationId"=>"updateDefaultBranch", "x-api-path-slug"=>"actionupdatedefaultbranch-get", "parameters"=>[{"in"=>"query", "name"=>"defaultBranchName", "description"=>"The name of the branch to set as the default", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository to set or change the default branch for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branches"]}}, "/?Action=UpdateRepositoryDescription"=>{"get"=>{"summary"=>"Update Repository Description", "description"=>"Sets or changes the comment or description for a repository.", "operationId"=>"updateRepositoryDescription", "x-api-path-slug"=>"actionupdaterepositorydescription-get", "parameters"=>[{"in"=>"query", "name"=>"repositoryDescription", "description"=>"The new comment or description for the specified repository", "type"=>"string"}, {"in"=>"query", "name"=>"repositoryName", "description"=>"The name of the repository to set or change the comment or description for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories"]}}, "/?Action=UpdateRepositoryName"=>{"get"=>{"summary"=>"Update Repository Name", "description"=>"Renames a repository.", "operationId"=>"updateRepositoryName", "x-api-path-slug"=>"actionupdaterepositoryname-get", "parameters"=>[{"in"=>"query", "name"=>"newName", "description"=>"The new name for the repository", "type"=>"string"}, {"in"=>"query", "name"=>"oldName", "description"=>"The existing name of the repository", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
api-video{"api-video-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"api.video", "x-complete"=>1, "info"=>{"title"=>"api.video", "description"=>"the-simplest-way-to-put-video-on-the-web", "version"=>"1.0.0"}, "host"=>"ws.api.video", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/videos/{id}/thumbnail"=>{"parameters"=>{"summary"=>"Parameters Videos Thumbnail", "description"=>"Parameters videos thumbnail.", "operationId"=>"parametersVeosThumbnail", "x-api-path-slug"=>"videosidthumbnail-parameters", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Parameters", "Videos", "Thumbnail"]}, "patch"=>{"summary"=>"Patch Videos Thumbnail", "description"=>"Pick a thumbnail from the given time code.\n\nIt may take up to 1h before the new thumbnail to be delivered by our CDN.", "operationId"=>"patchVeosThumbnail", "x-api-path-slug"=>"videosidthumbnail-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Videos", "Thumbnail"]}, "post"=>{"summary"=>"Post Videos Thumbnail", "description"=>"It may take up to 1h before the new thumbnail to be delivered by our CDN.", "operationId"=>"postVeosThumbnail", "x-api-path-slug"=>"videosidthumbnail-post", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Videos", "Thumbnail"]}}, "/videos/{videoId}"=>{"parameters"=>{"summary"=>"Parameters Videos Videoid", "description"=>"Parameters videos videoid.", "operationId"=>"parametersVeosVeo", "x-api-path-slug"=>"videosvideoid-parameters", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Parameters", "Videos"]}, "patch"=>{"summary"=>"Patch Videos Videoid", "description"=>"Patch videos videoid.", "operationId"=>"patchVeosVeo", "x-api-path-slug"=>"videosvideoid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Videos"]}}, "/players/{id}"=>{"parameters"=>{"summary"=>"Parameters Players", "description"=>"Parameters players.", "operationId"=>"parametersPlayers", "x-api-path-slug"=>"playersid-parameters", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Parameters", "Players"]}, "patch"=>{"summary"=>"Patch Players", "description"=>"It may take up to 10min before the new player configuration is available from our CDN.", "operationId"=>"patchPlayers", "x-api-path-slug"=>"playersid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Players"]}, "get"=>{"summary"=>"Get Players", "description"=>"Get players.", "operationId"=>"getPlayers", "x-api-path-slug"=>"playersid-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Players"]}}, "/token"=>{"post"=>{"summary"=>"Post Token", "description"=>"Post token.", "operationId"=>"postToken", "x-api-path-slug"=>"token-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Token"]}}, "/videos/{id}"=>{"parameters"=>{"summary"=>"Parameters Videos", "description"=>"Parameters videos.", "operationId"=>"parametersVeos", "x-api-path-slug"=>"videosid-parameters", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Parameters", "Videos"]}, "get"=>{"summary"=>"Get Videos", "description"=>"Get videos.", "operationId"=>"getVeos", "x-api-path-slug"=>"videosid-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Videos"]}, "delete"=>{"summary"=>"Delete Videos", "description"=>"Delete videos.", "operationId"=>"deleteVeos", "x-api-path-slug"=>"videosid-delete", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Videos"]}}, "/videos"=>{"post"=>{"summary"=>"Post Videos", "description"=>"Post videos.", "operationId"=>"postVeos", "x-api-path-slug"=>"videos-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Videos"]}, "get"=>{"summary"=>"Get Videos", "description"=>"Get videos.", "operationId"=>"getVeos", "x-api-path-slug"=>"videos-get", "parameters"=>[{"in"=>"query", "name"=>"keyword"}, {"in"=>"query", "name"=>"metadata"}, {"in"=>"query", "name"=>"tags"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Videos"]}}, "/players"=>{"get"=>{"summary"=>"Get Players", "description"=>"Get players.", "operationId"=>"getPlayers", "x-api-path-slug"=>"players-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Players"]}, "post"=>{"summary"=>"Post Players", "description"=>"Post players.", "operationId"=>"postPlayers", "x-api-path-slug"=>"players-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Players"]}}, "/refresh"=>{"post"=>{"summary"=>"Post Refresh", "description"=>"Post refresh.", "operationId"=>"postRefresh", "x-api-path-slug"=>"refresh-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Refresh"]}}, "/videos/{id}/source"=>{"parameters"=>{"summary"=>"Parameters Videos Source", "description"=>"Parameters videos source.", "operationId"=>"parametersVeosSource", "x-api-path-slug"=>"videosidsource-parameters", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Parameters", "Videos", "Source"]}, "post"=>{"summary"=>"Post Videos Source", "description"=>"Post videos source.", "operationId"=>"postVeosSource", "x-api-path-slug"=>"videosidsource-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Range"}, {"in"=>"header", "name"=>"Expect"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Videos", "Source"]}}}}, "apis"=>{"name"=>"api.video", "x-slug"=>"api-video", "description"=>"api.video is a scalable webservice able to encode on the go to facilitate immediate playback, enhancing viewer experiences across multiple devices and platforms. Start within minutes with a well-documented API.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28779-api-video.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"3033257", "tags"=>"Relative Data,Videos,Videos", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"api-video/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"API.Video", "x-api-slug"=>"api-video", "description"=>"api.video is a scalable webservice able to encode on the go to facilitate immediate playback, enhancing viewer experiences across multiple devices and platforms. Start within minutes with a well-documented API.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28779-api-video.jpg", "humanURL"=>"https://api.video", "baseURL"=>"https://ws.api.video//", "tags"=>"Relative Data,Videos,Videos", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/api-video/api-video-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"https://docs.api.video/5.1/introduction/api-conventions"}, {"type"=>"x-email", "url"=>"hello@api.video"}, {"type"=>"x-email", "url"=>"legal@api.video"}, {"type"=>"x-openapi", "url"=>"https://api.stoplight.io/v1/versions/9SNHChS5XhqPTQJCe/export/oas.json"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/api_video"}, {"type"=>"x-website", "url"=>"https://api.video"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-prediction{"google-cloud-prediction-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Prediction", "x-complete"=>1, "info"=>{"title"=>"Prediction", "description"=>"lets-you-access-a-cloud-hosted-machine-learning-service-that-makes-it-easy-to-build-smart-apps", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1.6"}, "host"=>"www.googleapis.com", "basePath"=>"/prediction/v1.6/projects", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{project}/hostedmodels/{hostedModelName}/predict"=>{"post"=>{"summary"=>"Predict Model", "description"=>"Submit input and request an output against a hosted model.", "operationId"=>"prediction.hostedmodels.predict", "x-api-path-slug"=>"projecthostedmodelshostedmodelnamepredict-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"hostedModelName", "description"=>"The name of a hosted model"}, {"in"=>"path", "name"=>"project", "description"=>"The project associated with the model"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Model"]}}, "/{project}/trainedmodels"=>{"post"=>{"summary"=>"Train Model", "description"=>"Train a Prediction API model.", "operationId"=>"prediction.trainedmodels.insert", "x-api-path-slug"=>"projecttrainedmodels-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"The project associated with the model"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Model"]}}, "/{project}/trainedmodels/list"=>{"get"=>{"summary"=>"List Models", "description"=>"List available models.", "operationId"=>"prediction.trainedmodels.list", "x-api-path-slug"=>"projecttrainedmodelslist-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Pagination token"}, {"in"=>"path", "name"=>"project", "description"=>"The project associated with the model"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Model"]}}, "/{project}/trainedmodels/{id}"=>{"delete"=>{"summary"=>"Delete Model", "description"=>"Delete a trained model.", "operationId"=>"prediction.trainedmodels.delete", "x-api-path-slug"=>"projecttrainedmodelsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The unique name for the predictive model"}, {"in"=>"path", "name"=>"project", "description"=>"The project associated with the model"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Model"]}, "get"=>{"summary"=>"Model Status", "description"=>"Check training status of your model.", "operationId"=>"prediction.trainedmodels.get", "x-api-path-slug"=>"projecttrainedmodelsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The unique name for the predictive model"}, {"in"=>"path", "name"=>"project", "description"=>"The project associated with the model"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Model"]}, "put"=>{"summary"=>"Add New Data", "description"=>"Add new data to a trained model.", "operationId"=>"prediction.trainedmodels.update", "x-api-path-slug"=>"projecttrainedmodelsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The unique name for the predictive model"}, {"in"=>"path", "name"=>"project", "description"=>"The project associated with the model"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Model"]}}, "/{project}/trainedmodels/{id}/analyze"=>{"get"=>{"summary"=>"Analyze", "description"=>"Get analysis of the model and the data the model was trained on.", "operationId"=>"prediction.trainedmodels.analyze", "x-api-path-slug"=>"projecttrainedmodelsidanalyze-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The unique name for the predictive model"}, {"in"=>"path", "name"=>"project", "description"=>"The project associated with the model"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Model", "Analysis"]}}, "/{project}/trainedmodels/{id}/predict"=>{"post"=>{"summary"=>"Predict", "description"=>"Submit model id and request a prediction.", "operationId"=>"prediction.trainedmodels.predict", "x-api-path-slug"=>"projecttrainedmodelsidpredict-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The unique name for the predictive model"}, {"in"=>"path", "name"=>"project", "description"=>"The project associated with the model"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Model"]}}}}, "apis"=>{"name"=>"Google Cloud Prediction", "x-slug"=>"google-cloud-prediction", "description"=>"Google Cloud Prediction API provides a RESTful API to build Machine Learning models. Predictions cloud-based machine learning tools can help analyze your data to add various features to your applications, such as customer sentiment analysis, spam detection, recommendation systems, and more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-prediction-api-500x500.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Machine Learning,Prediction,Predictions,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-prediction/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Prediction API", "x-api-slug"=>"google-cloud-prediction-api", "description"=>"Google Cloud Prediction API provides a RESTful API to build Machine Learning models. Predictions cloud-based machine learning tools can help analyze your data to add various features to your applications, such as customer sentiment analysis, spam detection, recommendation systems, and more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-prediction-api-500x500.jpg", "humanURL"=>"https://cloud.google.com/prediction/docs/developer-guide", "baseURL"=>"://www.googleapis.com//prediction/v1.6/projects", "tags"=>"API Provider,API Service Provider,Google APIs,Machine Learning,Prediction,Predictions,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-prediction/google-cloud-prediction-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-bugs", "url"=>"https://cloud.google.com/prediction/docs/feedback_and_discuss"}, {"type"=>"x-change-log", "url"=>"https://cloud.google.com/prediction/docs/release-notes"}, {"type"=>"x-code", "url"=>"https://cloud.google.com/prediction/docs/libraries"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/prediction/docs/developer-guide"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/prediction/docs/"}, {"type"=>"x-faq", "url"=>"https://cloud.google.com/prediction/docs/faq"}, {"type"=>"x-forum", "url"=>"https://cloud.google.com/prediction/docs/general_discussion_forum"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/prediction/docs/quickstart"}, {"type"=>"x-glossary", "url"=>"https://cloud.google.com/prediction/docs/glossary"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/prediction/pricing"}, {"type"=>"x-sla", "url"=>"https://cloud.google.com/prediction/sla"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
open-bank-project{"open-bank-project-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Open Bank Project", "x-complete"=>1, "info"=>{"title"=>"Account and Transaction API Specification", "description"=>"swagger-for-account-and-transaction-api-specification", "termsOfService"=>"https://www.openbanking.org.uk/terms", "contact"=>{"name"=>"Service Desk", "email"=>"ServiceDesk@openbanking.org.uk"}, "version"=>"1.0.0"}, "basePath"=>"/open-banking/v2.0", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/account-requests"=>{"post"=>{"summary"=>"Create an account request", "description"=>"Create an account request", "operationId"=>"CreateAccountRequest", "x-api-path-slug"=>"accountrequests-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Account", "Request"]}}, "/account-requests/{AccountRequestId}"=>{"get"=>{"summary"=>"Get an account request", "description"=>"Get an account request", "operationId"=>"GetAccountRequest", "x-api-path-slug"=>"accountrequestsaccountrequestid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Account", "Request"]}, "delete"=>{"summary"=>"Delete an account request", "description"=>"Delete an account request", "operationId"=>"DeleteAccountRequest", "x-api-path-slug"=>"accountrequestsaccountrequestid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Account", "Request"]}}, "/accounts"=>{"get"=>{"summary"=>"Get Accounts", "description"=>"Get a list of accounts", "operationId"=>"GetAccounts", "x-api-path-slug"=>"accounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Accounts"]}}, "/accounts/{AccountId}"=>{"get"=>{"summary"=>"Get Account", "description"=>"Get an account", "operationId"=>"GetAccount", "x-api-path-slug"=>"accountsaccountid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Account"]}}, "/accounts/{AccountId}/transactions"=>{"get"=>{"summary"=>"Get Account Transactions", "description"=>"Get transactions related to an account", "operationId"=>"GetAccountTransactions", "x-api-path-slug"=>"accountsaccountidtransactions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Account", "Transactions"]}}, "/accounts/{AccountId}/beneficiaries"=>{"get"=>{"summary"=>"Get Account Beneficiaries", "description"=>"Get Beneficiaries related to an account", "operationId"=>"GetAccountBeneficiaries", "x-api-path-slug"=>"accountsaccountidbeneficiaries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Account", "Beneficiaries"]}}, "/accounts/{AccountId}/balances"=>{"get"=>{"summary"=>"Get Account Balances", "description"=>"Get Balances related to an account", "operationId"=>"GetAccountBalances", "x-api-path-slug"=>"accountsaccountidbalances-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Account", "Balances"]}}, "/accounts/{AccountId}/direct-debits"=>{"get"=>{"summary"=>"Get Account Direct Debits", "description"=>"Get Direct Debits related to an account", "operationId"=>"GetAccountDirectDebits", "x-api-path-slug"=>"accountsaccountiddirectdebits-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Account", "Direct", "Debits"]}}, "/accounts/{AccountId}/standing-orders"=>{"get"=>{"summary"=>"Get Account Standing Orders", "description"=>"Get Standing Orders related to an account", "operationId"=>"GetAccountStandingOrders", "x-api-path-slug"=>"accountsaccountidstandingorders-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Account", "Standing", "Orders"]}}, "/accounts/{AccountId}/product"=>{"get"=>{"summary"=>"Get Account Product", "description"=>"Get Product related to an account", "operationId"=>"GetAccountProduct", "x-api-path-slug"=>"accountsaccountidproduct-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Account", "Product"]}}, "/accounts/{AccountId}/offers"=>{"get"=>{"summary"=>"Get Account Offers", "description"=>"Get Offers related to an account", "operationId"=>"GetAccountOffers", "x-api-path-slug"=>"accountsaccountidoffers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Account", "Offers"]}}, "/accounts/{AccountId}/party"=>{"get"=>{"summary"=>"Get Account Party", "description"=>"Get Party related to an account", "operationId"=>"GetAccountParty", "x-api-path-slug"=>"accountsaccountidparty-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Account", "Party"]}}, "/accounts/{AccountId}/scheduled-payments"=>{"get"=>{"summary"=>"Get Account Scheduled Payments", "description"=>"Get Scheduled Payments related to an account", "operationId"=>"GetAccountScheduledPayments", "x-api-path-slug"=>"accountsaccountidscheduledpayments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Account", "Scheduled", "Payments"]}}, "/accounts/{AccountId}/statements"=>{"get"=>{"summary"=>"Get Account Statements", "description"=>"Get Statements related to an account", "operationId"=>"GetAccountStatements", "x-api-path-slug"=>"accountsaccountidstatements-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Account", "Statements"]}}, "/accounts/{AccountId}/statements/{StatementId}"=>{"get"=>{"summary"=>"Get Statement", "description"=>"Get Statement related to an account", "operationId"=>"GetAccountStatement", "x-api-path-slug"=>"accountsaccountidstatementsstatementid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Statement"]}}, "/accounts/{AccountId}/statements/{StatementId}/file"=>{"get"=>{"summary"=>"Get Statement File", "description"=>"Get Statement File related to an account", "operationId"=>"GetAccountStatementFile", "x-api-path-slug"=>"accountsaccountidstatementsstatementidfile-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Statement", "File"]}}, "/accounts/{AccountId}/statements/{StatementId}/transactions"=>{"get"=>{"summary"=>"Get Statement Transactions", "description"=>"Get Statement Transactions related to an account", "operationId"=>"GetAccountStatementTransactions", "x-api-path-slug"=>"accountsaccountidstatementsstatementidtransactions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Statement", "Transactions"]}}, "/standing-orders"=>{"get"=>{"summary"=>"Get Standing Orders", "description"=>"Get Standing Orders", "operationId"=>"GetStandingOrders", "x-api-path-slug"=>"standingorders-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Standing", "Orders"]}}, "/direct-debits"=>{"get"=>{"summary"=>"Get Direct Debits", "description"=>"Get Direct Debits", "operationId"=>"GetDirectDebits", "x-api-path-slug"=>"directdebits-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Direct", "Debits"]}}, "/beneficiaries"=>{"get"=>{"summary"=>"Get Beneficiaries", "description"=>"Get Beneficiaries", "operationId"=>"GetBeneficiaries", "x-api-path-slug"=>"beneficiaries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Beneficiaries"]}}, "/transactions"=>{"get"=>{"summary"=>"Get Transactions", "description"=>"Get Transactions", "operationId"=>"GetTransactions", "x-api-path-slug"=>"transactions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Transactions"]}}, "/balances"=>{"get"=>{"summary"=>"Get Balances", "description"=>"Get Balances", "operationId"=>"GetBalances", "x-api-path-slug"=>"balances-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Balances"]}}, "/products"=>{"get"=>{"summary"=>"Get Products", "description"=>"Get Products", "operationId"=>"GetProducts", "x-api-path-slug"=>"products-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Products"]}}, "/offers"=>{"get"=>{"summary"=>"Get Offers", "description"=>"Get Offers", "operationId"=>"GetOffers", "x-api-path-slug"=>"offers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Offers"]}}, "/party"=>{"get"=>{"summary"=>"Get Party", "description"=>"Get Party", "operationId"=>"GetParty", "x-api-path-slug"=>"party-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Party"]}}, "/scheduled-payments"=>{"get"=>{"summary"=>"Get Scheduled Payments", "description"=>"Get Scheduled Payments", "operationId"=>"GetScheduledPayments", "x-api-path-slug"=>"scheduledpayments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Scheduled", "Payments"]}}, "/statements"=>{"get"=>{"summary"=>"Get Statements", "description"=>"Get Statements", "operationId"=>"GetStatements", "x-api-path-slug"=>"statements-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banking", "Banks", "Statements"]}}}}, "apis"=>{"name"=>"Open Bank Project", "x-slug"=>"open-bank-project", "description"=>"The Open Bank Project is an open source API and App store for banks that empowers financial institutions to securely and rapidly enhance their digital offerings using an ecosystem of 3rd party applications and services.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/open-bank-project.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"Banking,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"open-bank-project/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Open Bank Project", "x-api-slug"=>"open-bank-project", "description"=>"The Open Bank Project is an open source API and App store for banks that empowers financial institutions to securely and rapidly enhance their digital offerings using an ecosystem of 3rd party applications and services.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/open-bank-project.png", "humanURL"=>"https://openbankproject.com/", "baseURL"=>"https:////open-banking/v2.0", "tags"=>"Banking,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/open-bank-project/statements-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/open-bank-project/open-bank-project-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-github", "url"=>"https://github.com/OpenBankProject"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/openbankproject"}, {"type"=>"x-website", "url"=>"https://openbankproject.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
convertapi{"convert-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"ConvertAPI", "x-complete"=>1, "info"=>{"title"=>"Convert API", "description"=>"the-convertapi-provides-online-api-for-creating-pdf-and-images-from-various-sources-like-word-document-web-pages-or-raw-html-codes--in-just-few-minutes-you-can-integrate-it-into-your-application-and-use-it-easily--return-to-apis-list-", "version"=>"v1"}, "host"=>"do.convertapi.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/Email2Image"=>{"post"=>{"summary"=>"Email to Image", "description"=>"The API for converting E-Mail files to PDF files and Images. These file formats eml, mbx, msg, oft can be converted to png, jpg, tif.", "operationId"=>"email2image", "x-api-path-slug"=>"email2image-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: eml, mbx, msg, oft"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Image"]}}, "/Email2Pdf"=>{"post"=>{"summary"=>"Email to PDF", "description"=>"The API for converting E-Mail files to PDF files and Images. These file formats eml, mbx, msg, oft can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"email2pdf", "x-api-path-slug"=>"email2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: eml, mbx, msg, oft"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "PDF"]}}, "/Excel2Image"=>{"post"=>{"summary"=>"Excel to Image", "description"=>"The API for converting Excel documents to PDF files and Images. These file formats csv, xls, xlsb, xlsx, xlt, xltx can be converted to png, jpg, tif.", "operationId"=>"excel2image", "x-api-path-slug"=>"excel2image-post", "parameters"=>[{"in"=>"query", "name"=>"AlternativeParser", "description"=>"If some objects are missing in converted Pdf files from original source files this option can be enabled to improve conversion"}, {"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: csv, xls, xlsb, xlsx, xlt, xltx"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}, {"in"=>"query", "name"=>"WorksheetActive", "description"=>"Set to convert active worksheet"}, {"in"=>"query", "name"=>"WorksheetIndex", "description"=>"Set worksheet index(number) to convert"}, {"in"=>"query", "name"=>"WorksheetName", "description"=>"Set worksheet name to convert"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Excel", "Image"]}}, "/Excel2Pdf"=>{"post"=>{"summary"=>"Excel to PDF", "description"=>"The API for converting Excel documents to PDF files and Images. These file formats csv, xls, xlsb, xlsx, xlt, xltx can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"excel2pdf", "x-api-path-slug"=>"excel2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"AlternativeParser", "description"=>"If some objects are missing in converted Pdf files from original source files this option can be enabled to improve conversion"}, {"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: csv, xls, xlsb, xlsx, xlt, xltx"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}, {"in"=>"query", "name"=>"WorksheetActive", "description"=>"Set to convert active worksheet"}, {"in"=>"query", "name"=>"WorksheetIndex", "description"=>"Set worksheet index(number) to convert"}, {"in"=>"query", "name"=>"WorksheetName", "description"=>"Set worksheet name to convert"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Excel", "PDF"]}}, "/Image2Image"=>{"post"=>{"summary"=>"Image to Image", "description"=>"The API for converting Image files to PDF files and Images. These file formats avs, bmp, dcx, dib, dpx, fax, fits, fpx, gif, ico, iptc, jbig, jp2, jpeg, jpg, mdi, miff, mng, mpc, mtv, otb, pbm, pcd, pcds, pct, pcx, pgm, pict, png, pnm, ppm, psd, p7, ras, rgba, sun, tga, tiff, tif, vicar, vid, viff, wmf, xbm, xpm, xwd can be converted to png, jpg, tif.", "operationId"=>"image2image", "x-api-path-slug"=>"image2image-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: avs, bmp, dcx, dib, dpx, fax, fits, fpx, gif, ico, iptc, jbig, jp2, jpeg, jpg, mdi, miff, mng, mpc, mtv, otb, pbm, pcd, pcds, pct, pcx, pgm, pict, png, pnm, ppm, psd, p7, ras, rgba, sun, tga, tiff, tif, vicar, vid, viff, wmf, xbm, xpm, xwd"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image", "Image"]}}, "/Image2Pdf"=>{"post"=>{"summary"=>"Image to PDF", "description"=>"The API for converting Image files to PDF files and Images. These file formats avs, bmp, dcx, dib, dpx, fax, fits, fpx, gif, ico, iptc, jbig, jp2, jpeg, jpg, mdi, miff, mng, mpc, mtv, otb, pbm, pcd, pcds, pct, pcx, pgm, pict, png, pnm, ppm, psd, p7, ras, rgba, sun, tga, tiff, tif, vicar, vid, viff, wmf, xbm, xpm, xwd can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"image2pdf", "x-api-path-slug"=>"image2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: avs, bmp, dcx, dib, dpx, fax, fits, fpx, gif, ico, iptc, jbig, jp2, jpeg, jpg, mdi, miff, mng, mpc, mtv, otb, pbm, pcd, pcds, pct, pcx, pgm, pict, png, pnm, ppm, psd, p7, ras, rgba, sun, tga, tiff, tif, vicar, vid, viff, wmf, xbm, xpm, xwd"}, {"in"=>"query", "name"=>"Ocr", "description"=>"Apply optical character recognition (OCR) and convert scanned text images into editable and searchable PDF"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image", "PDF"]}}, "/Journal2Image"=>{"post"=>{"summary"=>"Journal to Image", "description"=>"The API for converting Windows Journal Viewer documents to PDF files and Images. These file formats jnt can be converted to png, jpg, tif.", "operationId"=>"journal2image", "x-api-path-slug"=>"journal2image-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: jnt"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Journal", "Image"]}}, "/Journal2Pdf"=>{"post"=>{"summary"=>"Journal to PDF", "description"=>"The API for converting Windows Journal Viewer documents to PDF files and Images. These file formats jnt can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"journal2pdf", "x-api-path-slug"=>"journal2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: jnt"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Journal", "PDF"]}}, "/Lotus2Image"=>{"post"=>{"summary"=>"Lotus to Image", "description"=>"The API for converting Lotus Smart Suite documents to PDF files and Images. These file formats 123, 12m, wk1, wk2, wk3, lwp, mwp, sam can be converted to png, jpg, tif.", "operationId"=>"lotus2image", "x-api-path-slug"=>"lotus2image-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: 123, 12m, wk1, wk2, wk3, lwp, mwp, sam"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lotus", "Image"]}}, "/Lotus2Pdf"=>{"post"=>{"summary"=>"Lotus to PDF", "description"=>"The API for converting Lotus Smart Suite documents to PDF files and Images. These file formats 123, 12m, wk1, wk2, wk3, lwp, mwp, sam can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"lotus2pdf", "x-api-path-slug"=>"lotus2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: 123, 12m, wk1, wk2, wk3, lwp, mwp, sam"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lotus", "PDF"]}}, "/OpenOffice2Image"=>{"post"=>{"summary"=>"Open Office to Image", "description"=>"The API for converting OpenOffice documents to PDF files and Images. These file formats mml, odc, odf, odg, odi, odm, odp, ods, odt, otg, oth, otp, ots, pxl, sgl, smf, srw, stc, sti, stw, sxc, sxg, sxi, sxm, sxw, vor, wv2 can be converted to png, jpg, tif.", "operationId"=>"openoffice2image", "x-api-path-slug"=>"openoffice2image-post", "parameters"=>[{"in"=>"query", "name"=>"AlternativeParser", "description"=>"If some objects are missing in converted Pdf files from original source files this option can be enabled to improve conversion"}, {"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: mml, odc, odf, odg, odi, odm, odp, ods, odt, otg, oth, otp, ots, pxl, sgl, smf, srw, stc, sti, stw, sxc, sxg, sxi, sxm, sxw, vor, wv2"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Office", "Image"]}}, "/OpenOffice2Pdf"=>{"post"=>{"summary"=>"Open Office to PDF", "description"=>"The API for converting OpenOffice documents to PDF files and Images. These file formats mml, odc, odf, odg, odi, odm, odp, ods, odt, otg, oth, otp, ots, pxl, sgl, smf, srw, stc, sti, stw, sxc, sxg, sxi, sxm, sxw, vor, wv2 can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"openoffice2pdf", "x-api-path-slug"=>"openoffice2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"AlternativeParser", "description"=>"If some objects are missing in converted Pdf files from original source files this option can be enabled to improve conversion"}, {"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: mml, odc, odf, odg, odi, odm, odp, ods, odt, otg, oth, otp, ots, pxl, sgl, smf, srw, stc, sti, stw, sxc, sxg, sxi, sxm, sxw, vor, wv2"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Office", "PDF"]}}, "/Pdf2Image"=>{"post"=>{"summary"=>"PDF to Image", "description"=>"The API for converting PDF documents to Image. These file formats pdf can be converted to png, jpg, tif.", "operationId"=>"pdf2image", "x-api-path-slug"=>"pdf2image-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: pdf"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PDF", "Image"]}}, "/Pdf2Pdf"=>{"post"=>{"summary"=>"PDF to PDF", "description"=>"The API for converting PDF documents to Image. These file formats pdf can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"pdf2pdf", "x-api-path-slug"=>"pdf2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: pdf"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PDF", "PDF"]}}, "/Pdf2PowerPoint"=>{"post"=>{"summary"=>"PDF to Power Point", "description"=>"The API for converting PDF documents to PowerPoint presentation files. These file formats pdf, pdfa can be converted to pptx.", "operationId"=>"pdf2powerpoint", "x-api-path-slug"=>"pdf2powerpoint-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: pdf, pdfa"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["PDF", "Power", "Point"]}}, "/PostScript2Image"=>{"post"=>{"summary"=>"Post Script to Image", "description"=>"The API for converting PostScript files to PDF files and Images. These file formats ps, eps, prn can be converted to png, jpg, tif.", "operationId"=>"postscript2image", "x-api-path-slug"=>"postscript2image-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: ps, eps, prn"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Script", "Image"]}}, "/PostScript2Pdf"=>{"post"=>{"summary"=>"Post Script to PDF", "description"=>"The API for converting PostScript files to PDF files and Images. These file formats ps, eps, prn can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"postscript2pdf", "x-api-path-slug"=>"postscript2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: ps, eps, prn"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Script", "PDF"]}}, "/PowerPoint2Image"=>{"post"=>{"summary"=>"Power Point to Image", "description"=>"The API for converting PowerPoint documents to PDF files and Images. These file formats pot, potx, pps, ppsx, ppt, pptx can be converted to png, jpg, tif.", "operationId"=>"powerpoint2image", "x-api-path-slug"=>"powerpoint2image-post", "parameters"=>[{"in"=>"query", "name"=>"AlternativeParser", "description"=>"If some objects are missing in converted Pdf files from original source files this option can be enabled to improve conversion"}, {"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: pot, potx, pps, ppsx, ppt, pptx"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Power", "Point", "Image"]}}, "/PowerPoint2Pdf"=>{"post"=>{"summary"=>"Power Point to PDF", "description"=>"The API for converting PowerPoint documents to PDF files and Images. These file formats pot, potx, pps, ppsx, ppt, pptx can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"powerpoint2pdf", "x-api-path-slug"=>"powerpoint2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"AlternativeParser", "description"=>"If some objects are missing in converted Pdf files from original source files this option can be enabled to improve conversion"}, {"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: pot, potx, pps, ppsx, ppt, pptx"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Power", "Point", "PDF"]}}, "/Project2Image"=>{"post"=>{"summary"=>"Project to Image", "description"=>"The API for converting Project documents to PDF files and Images. These file formats mpp, mpt can be converted to png, jpg, tif.", "operationId"=>"project2image", "x-api-path-slug"=>"project2image-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: mpp, mpt"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Image"]}}, "/Project2Pdf"=>{"post"=>{"summary"=>"Project to PDF", "description"=>"The API for converting Project documents to PDF files and Images. These file formats mpp, mpt can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"project2pdf", "x-api-path-slug"=>"project2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: mpp, mpt"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "PDF"]}}, "/Publisher2Image"=>{"post"=>{"summary"=>"Publisher to Image", "description"=>"The API for converting Publisher documents to PDF files and Images. These file formats pub can be converted to png, jpg, tif.", "operationId"=>"publisher2image", "x-api-path-slug"=>"publisher2image-post", "parameters"=>[{"in"=>"query", "name"=>"AlternativeParser", "description"=>"If some objects are missing in converted Pdf files from original source files this option can be enabled to improve conversion"}, {"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: pub"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Publisher", "Image"]}}, "/Publisher2Pdf"=>{"post"=>{"summary"=>"Publisher to PDF", "description"=>"The API for converting Publisher documents to PDF files and Images. These file formats pub can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"publisher2pdf", "x-api-path-slug"=>"publisher2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"AlternativeParser", "description"=>"If some objects are missing in converted Pdf files from original source files this option can be enabled to improve conversion"}, {"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: pub"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Publisher", "PDF"]}}, "/RichText2Image"=>{"post"=>{"summary"=>"Rich Text to Image", "description"=>"The API for converting Rich Text documents to PDF files and Images. These file formats rtf can be converted to png, jpg, tif.", "operationId"=>"richtext2image", "x-api-path-slug"=>"richtext2image-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: rtf"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rich", "Text", "Image"]}}, "/RichText2Pdf"=>{"post"=>{"summary"=>"Rich Text to PDF", "description"=>"The API for converting Rich Text documents to PDF files and Images. These file formats rtf can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"richtext2pdf", "x-api-path-slug"=>"richtext2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: rtf"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rich", "Text", "PDF"]}}, "/SnapShot2Image"=>{"post"=>{"summary"=>"Snap Shot to Image", "description"=>"The API for converting Access Report Snapshots documents to PDF files and Images. These file formats snp can be converted to png, jpg, tif.", "operationId"=>"snapshot2image", "x-api-path-slug"=>"snapshot2image-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: snp"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snap", "Shot", "Image"]}}, "/SnapShot2Pdf"=>{"post"=>{"summary"=>"Snap Shot to PDF", "description"=>"The API for converting Access Report Snapshots documents to PDF files and Images. These file formats snp can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"snapshot2pdf", "x-api-path-slug"=>"snapshot2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: snp"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snap", "Shot", "PDF"]}}, "/Text2Image"=>{"post"=>{"summary"=>"Text to Image", "description"=>"The API for converting Textual files to PDF files and Images. These file formats txt, log can be converted to png, jpg, tif.", "operationId"=>"text2image", "x-api-path-slug"=>"text2image-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: txt, log"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Text", "Image"]}}, "/Text2Pdf"=>{"post"=>{"summary"=>"Text to PDF", "description"=>"The API for converting Textual files to PDF files and Images. These file formats txt, log can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"text2pdf", "x-api-path-slug"=>"text2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: txt, log"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Text", "PDF"]}}, "/Visio2Image"=>{"post"=>{"summary"=>"Visio to Image", "description"=>"The API for converting Visio documents to PDF files and Images. These file formats vsd, vst, vsdx, vstx can be converted to png, jpg, tif.", "operationId"=>"visio2image", "x-api-path-slug"=>"visio2image-post", "parameters"=>[{"in"=>"query", "name"=>"AlternativeParser", "description"=>"If some objects are missing in converted Pdf files from original source files this option can be enabled to improve conversion"}, {"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: vsd, vst, vsdx, vstx"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Visio", "Image"]}}, "/Visio2Pdf"=>{"post"=>{"summary"=>"Visio to PDF", "description"=>"The API for converting Visio documents to PDF files and Images. These file formats vsd, vst, vsdx, vstx can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"visio2pdf", "x-api-path-slug"=>"visio2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"AlternativeParser", "description"=>"If some objects are missing in converted Pdf files from original source files this option can be enabled to improve conversion"}, {"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: vsd, vst, vsdx, vstx"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Visio", "PDF"]}}, "/Web2Image"=>{"post"=>{"summary"=>"Web to Image", "description"=>"The API for converting Web Pages to Images.", "operationId"=>"web2image", "x-api-path-slug"=>"web2image-post", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"Set accept language header"}, {"in"=>"query", "name"=>"AlternativeParser", "description"=>"Set alternative parser"}, {"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"AuthPassword", "description"=>"HTTP Authentication password, used if conversion web page is protected with HTTP authentication"}, {"in"=>"query", "name"=>"AuthUsername", "description"=>"HTTP authentication username, used if conversion web page is protected with HTTP authentication"}, {"in"=>"query", "name"=>"ConversionDelay", "description"=>"Delay in seconds before page load and PDF creation"}, {"in"=>"query", "name"=>"CUrl", "description"=>"URI of a web page to convert"}, {"in"=>"query", "name"=>"PageHeight", "description"=>"Set screen height"}, {"in"=>"query", "name"=>"PageWidth", "description"=>"Set screen width"}, {"in"=>"query", "name"=>"Plugins", "description"=>"Enable plugins such as flash"}, {"in"=>"query", "name"=>"Scripts", "description"=>"Allow web pages to run javascript"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}, {"in"=>"query", "name"=>"UserAgent", "description"=>"Set custom user agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web", "Image"]}}, "/Web2Pdf"=>{"post"=>{"summary"=>"Web to PDF", "description"=>"The API for converting Web Pages to PDF files.", "operationId"=>"web2pdf", "x-api-path-slug"=>"web2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"Set accept language header"}, {"in"=>"query", "name"=>"AlternativeParser", "description"=>"Set alternative parser"}, {"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"AuthPassword", "description"=>"HTTP Authentication password, used if conversion web page is protected with HTTP authentication"}, {"in"=>"query", "name"=>"AuthUsername", "description"=>"HTTP authentication username, used if conversion web page is protected with HTTP authentication"}, {"in"=>"query", "name"=>"Background", "description"=>"Print web page background"}, {"in"=>"query", "name"=>"ConversionDelay", "description"=>"Delay in seconds before page load and PDF creation"}, {"in"=>"query", "name"=>"CoverUrl", "description"=>"Use html document as cover"}, {"in"=>"query", "name"=>"CUrl", "description"=>"URI of a web page to convert"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated pdf file"}, {"in"=>"query", "name"=>"FooterLine", "description"=>"Display line above the footer"}, {"in"=>"query", "name"=>"FooterSpacing", "description"=>"Spacing between footer and content"}, {"in"=>"query", "name"=>"FooterTextCenter", "description"=>"Center aligned footer text"}, {"in"=>"query", "name"=>"FooterTextFont", "description"=>"Set footer font name"}, {"in"=>"query", "name"=>"FooterTextLeft", "description"=>"Left aligned footer text"}, {"in"=>"query", "name"=>"FooterTextRight", "description"=>"Right aligned footer text"}, {"in"=>"query", "name"=>"FooterTextSize", "description"=>"Set footer font size"}, {"in"=>"query", "name"=>"FooterUrl", "description"=>"Adds a html footer"}, {"in"=>"query", "name"=>"HeaderLine", "description"=>"Display line below the header"}, {"in"=>"query", "name"=>"HeaderSpacing", "description"=>"Spacing between header and content"}, {"in"=>"query", "name"=>"HeaderTextCenter", "description"=>"Center aligned header text"}, {"in"=>"query", "name"=>"HeaderTextFont", "description"=>"Set header font name"}, {"in"=>"query", "name"=>"HeaderTextLeft", "description"=>"Left aligned header text"}, {"in"=>"query", "name"=>"HeaderTextRight", "description"=>"Right aligned header text"}, {"in"=>"query", "name"=>"HeaderTextSize", "description"=>"Set header font size"}, {"in"=>"query", "name"=>"HeaderUrl", "description"=>"Adds a html header"}, {"in"=>"query", "name"=>"InfoStamp", "description"=>"Show date stamp and conversion url in header"}, {"in"=>"query", "name"=>"LowQuality", "description"=>"Generates lower quality PDF, makes smaller file size"}, {"in"=>"query", "name"=>"MarginBottom", "description"=>"Set the page bottom margin"}, {"in"=>"query", "name"=>"MarginLeft", "description"=>"Set the page left margin"}, {"in"=>"query", "name"=>"MarginRight", "description"=>"Set the page right margin"}, {"in"=>"query", "name"=>"MarginTop", "description"=>"Set the page top margin"}, {"in"=>"query", "name"=>"Outline", "description"=>"Show outline in PDF file"}, {"in"=>"query", "name"=>"PageHeight", "description"=>"Custom page height"}, {"in"=>"query", "name"=>"PageNo", "description"=>"Show page number in footer"}, {"in"=>"query", "name"=>"PageOrientation", "description"=>"PDF page orientation: portrait, landscape"}, {"in"=>"query", "name"=>"PageSize", "description"=>"PDF page paper sizes"}, {"in"=>"query", "name"=>"PageWidth", "description"=>"Custom page width"}, {"in"=>"query", "name"=>"Plugins", "description"=>"Enable plugins such as flash"}, {"in"=>"query", "name"=>"PrintType", "description"=>"Use print media-type(print css sheet) instead of screen"}, {"in"=>"query", "name"=>"Scripts", "description"=>"Allow web pages to run javascript"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}, {"in"=>"query", "name"=>"UserAgent", "description"=>"Set custom user agent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web", "PDF"]}}, "/Word2Image"=>{"post"=>{"summary"=>"Word to Image", "description"=>"The API for converting Word documents to PDF files and Images. These file formats doc, docx, dot, dotx, wpd, wps, wri can be converted to png, jpg, tif.", "operationId"=>"word2image", "x-api-path-slug"=>"word2image-post", "parameters"=>[{"in"=>"query", "name"=>"AlternativeParser", "description"=>"If some objects are missing in converted Pdf files from original source files this option can be enabled to improve conversion"}, {"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: doc, docx, dot, dotx, wpd, wps, wri"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Word", "Image"]}}, "/Word2Pdf"=>{"post"=>{"summary"=>"Word to PDF", "description"=>"The API for converting Word documents to PDF files and Images. These file formats doc, docx, dot, dotx, wpd, wps, wri can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"word2pdf", "x-api-path-slug"=>"word2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"AlternativeParser", "description"=>"If some objects are missing in converted Pdf files from original source files this option can be enabled to improve conversion"}, {"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: doc, docx, dot, dotx, wpd, wps, wri"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Word", "PDF"]}}, "/Xps2Image"=>{"post"=>{"summary"=>"Xps to Image", "description"=>"The API for converting Open XML Paper Specification documents to PDF files. These file formats xps can be converted to png, jpg, tif.", "operationId"=>"xps2image", "x-api-path-slug"=>"xps2image-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: xps"}, {"in"=>"query", "name"=>"ImageResolutionH", "description"=>"Image horizontal resolution (DPI)"}, {"in"=>"query", "name"=>"ImageResolutionV", "description"=>"Image vertical resolution (DPI)"}, {"in"=>"query", "name"=>"JpgQuality", "description"=>"Jpg image quality"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Xps", "Image"]}}, "/Xps2Pdf"=>{"post"=>{"summary"=>"Xps to PDF", "description"=>"The API for converting Open XML Paper Specification documents to PDF files. These file formats xps can be converted to pdf, pdfa, png, jpg, tif.", "operationId"=>"xps2pdf", "x-api-path-slug"=>"xps2pdf-post", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"API Key should be passed if you purchased membership with credits"}, {"in"=>"query", "name"=>"DocumentAuthor", "description"=>"Set the author of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentKeywords", "description"=>"Set the keywords of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentSubject", "description"=>"Set the subject of the generated Pdf file"}, {"in"=>"query", "name"=>"DocumentTitle", "description"=>"Set the title of the generated Pdf file"}, {"in"=>"query", "name"=>"File", "description"=>"Supported source file formats: xps"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"Supported output file formats pdf, pdfa, png, jpg, tif"}, {"in"=>"query", "name"=>"StoreFile", "description"=>"Store file on server and return url to file instead of file stream response"}, {"in"=>"query", "name"=>"Timeout", "description"=>"Conversion timeout in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Xps", "PDF"]}}}}, "apis"=>{"name"=>"ConvertAPI", "x-slug"=>"convertapi", "description"=>"Create PDF easily with our developers API/SDK for Ruby Java .NET C# PHP Shell Delphi.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/357-convertapi.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"717909", "tags"=>"API Provider,Document Conversion,Documents,File Conversion,File Conversion,Images,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"convertapi/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Convert API", "x-api-slug"=>"convert-api", "description"=>"Create PDF easily with our developers API/SDK for Ruby Java .NET C# PHP Shell Delphi.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/357-convertapi.jpg", "humanURL"=>"http://www.convertapi.com/", "baseURL"=>"https://do.convertapi.com//", "tags"=>"API Provider,Document Conversion,Documents,File Conversion,File Conversion,Images,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/convertapi/xps2pdf-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/convertapi/convert-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://www.convertapi.com/api/web-pdf-api"}, {"type"=>"x-base", "url"=>"http://do.convertapi.com/"}, {"type"=>"x-email", "url"=>"support@convertapi.com"}, {"type"=>"x-email", "url"=>"support@baltsoft.com"}, {"type"=>"x-pricing", "url"=>"http://www.convertapi.com/prices"}, {"type"=>"x-selfservice-registration", "url"=>"http://www.convertapi.com/a/si"}, {"type"=>"x-stack-overflow", "url"=>"http://stackoverflow.com/questions/tagged/convertapi"}, {"type"=>"x-terms-of-service", "url"=>"http://www.convertapi.com/terms"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/ConvertAPI_"}, {"type"=>"x-website", "url"=>"http://www.convertapi.com/"}, {"type"=>"x-website", "url"=>"http://convertapi.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
kaltura{"kaltura-vpaas-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Kaltura", "x-complete"=>1, "info"=>{"title"=>"Kaltura VPaaS", "description"=>"building-video-experiences-consists-of-ingesting-media-files-playing-back-videos-and-reviewing-usage-and-engagement-analytics--in-between-there-is-a-world-of-nuances-required-for-your-unique-usecase-and-application--kaltura-vpaas-is-built-on-the-principles-of-atomic-services-sdks-and-tools-that-allow-you-full-control-and-flexibility-over-every-element-and-process-in-your-medias-life-cycle-", "version"=>"3.3.0"}, "host"=>"www.kaltura.com", "basePath"=>"/api_v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/service/accesscontrol/action/add"=>{"get"=>{"summary"=>"Get Service Access Control Action Add", "description"=>"Add new Access Control Profile", "operationId"=>"accessControl.add", "x-api-path-slug"=>"serviceaccesscontrolactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"accessControl[description]", "description"=>"The description of the Access Control Profile"}, {"in"=>"query", "name"=>"accessControl[isDefault]", "description"=>"Enum Type: `KalturaNullableBoolean`True if this Conversion Profile is the default"}, {"in"=>"query", "name"=>"accessControl[name]", "description"=>"The name of the Access Control Profile"}, {"in"=>"query", "name"=>"accessControl[restrictions]"}, {"in"=>"query", "name"=>"accessControl[systemName]", "description"=>"System name of the Access Control Profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Accesscontrol", "Action", "Add"]}}, "/service/accesscontrol/action/delete"=>{"get"=>{"summary"=>"Get Service Access Control Action Delete", "description"=>"Delete Access Control Profile by id", "operationId"=>"accessControl.delete", "x-api-path-slug"=>"serviceaccesscontrolactiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Accesscontrol", "Action", "Delete"]}}, "/service/accesscontrol/action/get"=>{"get"=>{"summary"=>"Get Service Access Control Action Get", "description"=>"Get Access Control Profile by id", "operationId"=>"accessControl.get", "x-api-path-slug"=>"serviceaccesscontrolactionget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Accesscontrol", "Action", "Get"]}}, "/service/accesscontrol/action/list"=>{"get"=>{"summary"=>"Get Service Access Control Action List", "description"=>"List Access Control Profiles by filter and pager", "operationId"=>"accessControl.list", "x-api-path-slug"=>"serviceaccesscontrolactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[systemNameEqual]"}, {"in"=>"query", "name"=>"filter[systemNameIn]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Accesscontrol", "Action", "List"]}}, "/service/accesscontrol/action/update"=>{"get"=>{"summary"=>"Get Service Access Control Action Update", "description"=>"Update Access Control Profile by id", "operationId"=>"accessControl.update", "x-api-path-slug"=>"serviceaccesscontrolactionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"accessControl[description]", "description"=>"The description of the Access Control Profile"}, {"in"=>"query", "name"=>"accessControl[isDefault]", "description"=>"Enum Type: `KalturaNullableBoolean`True if this Conversion Profile is the default"}, {"in"=>"query", "name"=>"accessControl[name]", "description"=>"The name of the Access Control Profile"}, {"in"=>"query", "name"=>"accessControl[restrictions]"}, {"in"=>"query", "name"=>"accessControl[systemName]", "description"=>"System name of the Access Control Profile"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Accesscontrol", "Action", "Update"]}}, "/service/accesscontrolprofile/action/add"=>{"get"=>{"summary"=>"Get Service Access Controlprofile Action Add", "description"=>"Add new access control profile", "operationId"=>"accessControlProfile.add", "x-api-path-slug"=>"serviceaccesscontrolprofileactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"accessControlProfile[description]", "description"=>"The description of the Access Control Profile"}, {"in"=>"query", "name"=>"accessControlProfile[isDefault]", "description"=>"Enum Type: `KalturaNullableBoolean`True if this access control profile is the partner default"}, {"in"=>"query", "name"=>"accessControlProfile[name]", "description"=>"The name of the Access Control Profile"}, {"in"=>"query", "name"=>"accessControlProfile[rules]"}, {"in"=>"query", "name"=>"accessControlProfile[systemName]", "description"=>"System name of the Access Control Profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Accesscontrolprofile", "Action", "Add"]}}, "/service/accesscontrolprofile/action/delete"=>{"get"=>{"summary"=>"Get Service Access Controlprofile Action Delete", "description"=>"Delete access control profile by id", "operationId"=>"accessControlProfile.delete", "x-api-path-slug"=>"serviceaccesscontrolprofileactiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Accesscontrolprofile", "Action", "Delete"]}}, "/service/accesscontrolprofile/action/get"=>{"get"=>{"summary"=>"Get Service Access Controlprofile Action Get", "description"=>"Get access control profile by id", "operationId"=>"accessControlProfile.get", "x-api-path-slug"=>"serviceaccesscontrolprofileactionget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Accesscontrolprofile", "Action", "Get"]}}, "/service/accesscontrolprofile/action/list"=>{"get"=>{"summary"=>"Get Service Access Controlprofile Action List", "description"=>"List access control profiles by filter and pager", "operationId"=>"accessControlProfile.list", "x-api-path-slug"=>"serviceaccesscontrolprofileactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[systemNameEqual]"}, {"in"=>"query", "name"=>"filter[systemNameIn]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Accesscontrolprofile", "Action", "List"]}}, "/service/accesscontrolprofile/action/update"=>{"get"=>{"summary"=>"Get Service Access Controlprofile Action Update", "description"=>"Update access control profile by id", "operationId"=>"accessControlProfile.update", "x-api-path-slug"=>"serviceaccesscontrolprofileactionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"accessControlProfile[description]", "description"=>"The description of the Access Control Profile"}, {"in"=>"query", "name"=>"accessControlProfile[isDefault]", "description"=>"Enum Type: `KalturaNullableBoolean`True if this access control profile is the partner default"}, {"in"=>"query", "name"=>"accessControlProfile[name]", "description"=>"The name of the Access Control Profile"}, {"in"=>"query", "name"=>"accessControlProfile[rules]"}, {"in"=>"query", "name"=>"accessControlProfile[systemName]", "description"=>"System name of the Access Control Profile"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Accesscontrolprofile", "Action", "Update"]}}, "/service/adminuser/action/login"=>{"get"=>{"summary"=>"Get Service Adminuser Action Login", "description"=>"Get an admin session using admin email and password (Used for login to the KMC application)", "operationId"=>"adminUser.login", "x-api-path-slug"=>"serviceadminuseractionlogin-get", "parameters"=>[{"in"=>"query", "name"=>"email"}, {"in"=>"query", "name"=>"partnerId"}, {"in"=>"query", "name"=>"password"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Adminuser", "Action", "Login"]}}, "/service/adminuser/action/resetPassword"=>{"get"=>{"summary"=>"Get Service Adminuser Action Resetpassword", "description"=>"Reset admin user password and send it to the users email address", "operationId"=>"adminUser.resetPassword", "x-api-path-slug"=>"serviceadminuseractionresetpassword-get", "parameters"=>[{"in"=>"query", "name"=>"email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Adminuser", "Action", "ResetPassword"]}}, "/service/adminuser/action/setInitialPassword"=>{"get"=>{"summary"=>"Get Service Adminuser Action Setinitialpassword", "description"=>"Set initial users password", "operationId"=>"adminUser.setInitialPassword", "x-api-path-slug"=>"serviceadminuseractionsetinitialpassword-get", "parameters"=>[{"in"=>"query", "name"=>"hashKey"}, {"in"=>"query", "name"=>"newPassword", "description"=>"new password to set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Adminuser", "Action", "SetInitialPassword"]}}, "/service/adminuser/action/updatePassword"=>{"get"=>{"summary"=>"Get Service Adminuser Action Updatepassword", "description"=>"Update admin user password and email", "operationId"=>"adminUser.updatePassword", "x-api-path-slug"=>"serviceadminuseractionupdatepassword-get", "parameters"=>[{"in"=>"query", "name"=>"email"}, {"in"=>"query", "name"=>"newEmail", "description"=>"Optional, provide only when you want to update the email"}, {"in"=>"query", "name"=>"newPassword"}, {"in"=>"query", "name"=>"password"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Adminuser", "Action", "UpdatePassword"]}}, "/service/analytics/action/query"=>{"get"=>{"summary"=>"Get Service Analytics Action Query", "description"=>"report query action allows to get a analytics data for specific query dimensions, metrics and filters.", "operationId"=>"analytics.query", "x-api-path-slug"=>"serviceanalyticsactionquery-get", "parameters"=>[{"in"=>"query", "name"=>"filter[dimensions]", "description"=>"Comma separated dimensions list"}, {"in"=>"query", "name"=>"filter[filters]"}, {"in"=>"query", "name"=>"filter[from_time]", "description"=>"Query start time (in local time) MM/dd/yyyy HH:mi"}, {"in"=>"query", "name"=>"filter[metrics]", "description"=>"Comma separated metrics list"}, {"in"=>"query", "name"=>"filter[orderBy]", "description"=>"Query order by metric/dimension"}, {"in"=>"query", "name"=>"filter[to_time]", "description"=>"Query end time (in local time) MM/dd/yyyy HH:mi"}, {"in"=>"query", "name"=>"filter[utcOffset]", "description"=>"Timezone offset from UTC (in minutes)"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Analytics", "Action", "Query"]}}, "/service/annotation_annotation/action/add"=>{"get"=>{"summary"=>"Get Service Annotation Annotation Action Add", "description"=>"Allows you to add an annotation object associated with an entry", "operationId"=>"annotation.add", "x-api-path-slug"=>"serviceannotation-annotationactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"annotation[adType]", "description"=>"Enum Type: `KalturaAdType`"}, {"in"=>"query", "name"=>"annotation[answerKey]"}, {"in"=>"query", "name"=>"annotation[assetId]"}, {"in"=>"query", "name"=>"annotation[code]"}, {"in"=>"query", "name"=>"annotation[correctAnswerKeys]"}, {"in"=>"query", "name"=>"annotation[description]"}, {"in"=>"query", "name"=>"annotation[duration]", "description"=>"Duration in milliseconds"}, {"in"=>"query", "name"=>"annotation[endTime]", "description"=>"End time in milliseconds"}, {"in"=>"query", "name"=>"annotation[entryId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"annotation[eventType]", "description"=>"Enum Type: `KalturaEventType`"}, {"in"=>"query", "name"=>"annotation[explanation]"}, {"in"=>"query", "name"=>"annotation[forceStop]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"annotation[hint]"}, {"in"=>"query", "name"=>"annotation[isPublic]", "description"=>"Enum Type: `KalturaNullableBoolean`Is the annotation public"}, {"in"=>"query", "name"=>"annotation[objectType]"}, {"in"=>"query", "name"=>"annotation[optionalAnswers]"}, {"in"=>"query", "name"=>"annotation[parentId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"annotation[partnerData]"}, {"in"=>"query", "name"=>"annotation[partnerSortValue]"}, {"in"=>"query", "name"=>"annotation[protocolType]", "description"=>"`insertOnly`Enum Type: `KalturaAdProtocolType`"}, {"in"=>"query", "name"=>"annotation[question]"}, {"in"=>"query", "name"=>"annotation[quizUserEntryId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"annotation[searchableOnEntry]", "description"=>"Enum Type: `KalturaNullableBoolean`Should the cue point get indexed on the entry"}, {"in"=>"query", "name"=>"annotation[sourceUrl]"}, {"in"=>"query", "name"=>"annotation[startTime]", "description"=>"Start time in milliseconds"}, {"in"=>"query", "name"=>"annotation[subType]", "description"=>"Enum Type: `KalturaThumbCuePointSubType`The sub type of the ThumbCuePoint"}, {"in"=>"query", "name"=>"annotation[systemName]"}, {"in"=>"query", "name"=>"annotation[tags]"}, {"in"=>"query", "name"=>"annotation[text]"}, {"in"=>"query", "name"=>"annotation[thumbOffset]"}, {"in"=>"query", "name"=>"annotation[title]"}, {"in"=>"query", "name"=>"annotation[triggeredAt]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Annotation", "Annotation", "Action", "Add"]}}, "/service/annotation_annotation/action/addFromBulk"=>{"post"=>{"summary"=>"Post Service Annotation Annotation Action Addfrombulk", "description"=>"Allows you to add multiple cue points objects by uploading XML that contains multiple cue point definitions", "operationId"=>"annotation.addFromBulk", "x-api-path-slug"=>"serviceannotation-annotationactionaddfrombulk-post", "parameters"=>[{"in"=>"formData", "name"=>"fileData"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Annotation", "Annotation", "Action", "AddFromBulk"]}}, "/service/annotation_annotation/action/clone"=>{"get"=>{"summary"=>"Get Service Annotation Annotation Action Clone", "description"=>"Clone cuePoint with id to given entry", "operationId"=>"annotation.clone", "x-api-path-slug"=>"serviceannotation-annotationactionclone-get", "parameters"=>[{"in"=>"query", "name"=>"entryId"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Annotation", "Annotation", "Action", "Clone"]}}, "/service/annotation_annotation/action/count"=>{"get"=>{"summary"=>"Get Service Annotation Annotation Action Count", "description"=>"count cue point objects by filter", "operationId"=>"annotation.count", "x-api-path-slug"=>"serviceannotation-annotationactioncount-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[codeEqual]"}, {"in"=>"query", "name"=>"filter[codeIn]"}, {"in"=>"query", "name"=>"filter[codeLike]"}, {"in"=>"query", "name"=>"filter[codeMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[codeMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[cuePointTypeEqual]", "description"=>"Enum Type: `KalturaCuePointType`"}, {"in"=>"query", "name"=>"filter[cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[descriptionLike]"}, {"in"=>"query", "name"=>"filter[descriptionMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[descriptionMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[durationGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[durationLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[entryIdEqual]"}, {"in"=>"query", "name"=>"filter[entryIdIn]"}, {"in"=>"query", "name"=>"filter[eventTypeEqual]", "description"=>"Enum Type: `KalturaEventType`"}, {"in"=>"query", "name"=>"filter[eventTypeIn]"}, {"in"=>"query", "name"=>"filter[forceStopEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[freeText]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[isPublicEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[parentIdEqual]"}, {"in"=>"query", "name"=>"filter[parentIdIn]"}, {"in"=>"query", "name"=>"filter[partnerSortValueEqual]"}, {"in"=>"query", "name"=>"filter[partnerSortValueGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[partnerSortValueIn]"}, {"in"=>"query", "name"=>"filter[partnerSortValueLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[protocolTypeEqual]", "description"=>"Enum Type: `KalturaAdProtocolType`"}, {"in"=>"query", "name"=>"filter[protocolTypeIn]"}, {"in"=>"query", "name"=>"filter[questionLike]"}, {"in"=>"query", "name"=>"filter[questionMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[questionMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[quizUserEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[quizUserEntryIdIn]"}, {"in"=>"query", "name"=>"filter[startTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[startTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaCuePointStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[subTypeEqual]", "description"=>"Enum Type: `KalturaThumbCuePointSubType`"}, {"in"=>"query", "name"=>"filter[subTypeIn]"}, {"in"=>"query", "name"=>"filter[systemNameEqual]"}, {"in"=>"query", "name"=>"filter[systemNameIn]"}, {"in"=>"query", "name"=>"filter[tagsLike]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[textLike]"}, {"in"=>"query", "name"=>"filter[textMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[textMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[titleLike]"}, {"in"=>"query", "name"=>"filter[titleMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[titleMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[triggeredAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[triggeredAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[userIdCurrent]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[userIdEqualCurrent]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[userIdEqual]"}, {"in"=>"query", "name"=>"filter[userIdIn]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Annotation", "Annotation", "Action", "Count"]}}, "/service/annotation_annotation/action/delete"=>{"get"=>{"summary"=>"Get Service Annotation Annotation Action Delete", "description"=>"delete cue point by id, and delete all children cue points", "operationId"=>"annotation.delete", "x-api-path-slug"=>"serviceannotation-annotationactiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Annotation", "Annotation", "Action", "Delete"]}}, "/service/annotation_annotation/action/get"=>{"get"=>{"summary"=>"Get Service Annotation Annotation Action Get", "description"=>"Retrieve an CuePoint object by id", "operationId"=>"annotation.get", "x-api-path-slug"=>"serviceannotation-annotationactionget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Annotation", "Annotation", "Action", "Get"]}}, "/service/annotation_annotation/action/list"=>{"get"=>{"summary"=>"Get Service Annotation Annotation Action List", "description"=>"List annotation objects by filter and pager", "operationId"=>"annotation.list", "x-api-path-slug"=>"serviceannotation-annotationactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[codeEqual]"}, {"in"=>"query", "name"=>"filter[codeIn]"}, {"in"=>"query", "name"=>"filter[codeLike]"}, {"in"=>"query", "name"=>"filter[codeMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[codeMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[cuePointTypeEqual]", "description"=>"Enum Type: `KalturaCuePointType`"}, {"in"=>"query", "name"=>"filter[cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[descriptionLike]"}, {"in"=>"query", "name"=>"filter[descriptionMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[descriptionMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[durationGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[durationLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[entryIdEqual]"}, {"in"=>"query", "name"=>"filter[entryIdIn]"}, {"in"=>"query", "name"=>"filter[eventTypeEqual]", "description"=>"Enum Type: `KalturaEventType`"}, {"in"=>"query", "name"=>"filter[eventTypeIn]"}, {"in"=>"query", "name"=>"filter[forceStopEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[freeText]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[isPublicEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[parentIdEqual]"}, {"in"=>"query", "name"=>"filter[parentIdIn]"}, {"in"=>"query", "name"=>"filter[partnerSortValueEqual]"}, {"in"=>"query", "name"=>"filter[partnerSortValueGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[partnerSortValueIn]"}, {"in"=>"query", "name"=>"filter[partnerSortValueLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[protocolTypeEqual]", "description"=>"Enum Type: `KalturaAdProtocolType`"}, {"in"=>"query", "name"=>"filter[protocolTypeIn]"}, {"in"=>"query", "name"=>"filter[questionLike]"}, {"in"=>"query", "name"=>"filter[questionMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[questionMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[quizUserEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[quizUserEntryIdIn]"}, {"in"=>"query", "name"=>"filter[startTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[startTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaCuePointStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[subTypeEqual]", "description"=>"Enum Type: `KalturaThumbCuePointSubType`"}, {"in"=>"query", "name"=>"filter[subTypeIn]"}, {"in"=>"query", "name"=>"filter[systemNameEqual]"}, {"in"=>"query", "name"=>"filter[systemNameIn]"}, {"in"=>"query", "name"=>"filter[tagsLike]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[textLike]"}, {"in"=>"query", "name"=>"filter[textMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[textMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[titleLike]"}, {"in"=>"query", "name"=>"filter[titleMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[titleMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[triggeredAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[triggeredAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[userIdCurrent]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[userIdEqualCurrent]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[userIdEqual]"}, {"in"=>"query", "name"=>"filter[userIdIn]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Annotation", "Annotation", "Action", "List"]}}, "/service/annotation_annotation/action/serveBulk"=>{"get"=>{"summary"=>"Get Service Annotation Annotation Action Servebulk", "description"=>"Download multiple cue points objects as XML definitions", "operationId"=>"annotation.serveBulk", "x-api-path-slug"=>"serviceannotation-annotationactionservebulk-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[codeEqual]"}, {"in"=>"query", "name"=>"filter[codeIn]"}, {"in"=>"query", "name"=>"filter[codeLike]"}, {"in"=>"query", "name"=>"filter[codeMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[codeMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[cuePointTypeEqual]", "description"=>"Enum Type: `KalturaCuePointType`"}, {"in"=>"query", "name"=>"filter[cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[descriptionLike]"}, {"in"=>"query", "name"=>"filter[descriptionMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[descriptionMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[durationGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[durationLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[entryIdEqual]"}, {"in"=>"query", "name"=>"filter[entryIdIn]"}, {"in"=>"query", "name"=>"filter[eventTypeEqual]", "description"=>"Enum Type: `KalturaEventType`"}, {"in"=>"query", "name"=>"filter[eventTypeIn]"}, {"in"=>"query", "name"=>"filter[forceStopEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[freeText]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[isPublicEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[parentIdEqual]"}, {"in"=>"query", "name"=>"filter[parentIdIn]"}, {"in"=>"query", "name"=>"filter[partnerSortValueEqual]"}, {"in"=>"query", "name"=>"filter[partnerSortValueGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[partnerSortValueIn]"}, {"in"=>"query", "name"=>"filter[partnerSortValueLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[protocolTypeEqual]", "description"=>"Enum Type: `KalturaAdProtocolType`"}, {"in"=>"query", "name"=>"filter[protocolTypeIn]"}, {"in"=>"query", "name"=>"filter[questionLike]"}, {"in"=>"query", "name"=>"filter[questionMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[questionMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[quizUserEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[quizUserEntryIdIn]"}, {"in"=>"query", "name"=>"filter[startTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[startTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaCuePointStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[subTypeEqual]", "description"=>"Enum Type: `KalturaThumbCuePointSubType`"}, {"in"=>"query", "name"=>"filter[subTypeIn]"}, {"in"=>"query", "name"=>"filter[systemNameEqual]"}, {"in"=>"query", "name"=>"filter[systemNameIn]"}, {"in"=>"query", "name"=>"filter[tagsLike]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[textLike]"}, {"in"=>"query", "name"=>"filter[textMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[textMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[titleLike]"}, {"in"=>"query", "name"=>"filter[titleMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[titleMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[triggeredAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[triggeredAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[userIdCurrent]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[userIdEqualCurrent]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[userIdEqual]"}, {"in"=>"query", "name"=>"filter[userIdIn]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Annotation", "Annotation", "Action", "ServeBulk"]}}, "/service/annotation_annotation/action/update"=>{"get"=>{"summary"=>"Get Service Annotation Annotation Action Update", "description"=>"Update annotation by id", "operationId"=>"annotation.update", "x-api-path-slug"=>"serviceannotation-annotationactionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"annotation[adType]", "description"=>"Enum Type: `KalturaAdType`"}, {"in"=>"query", "name"=>"annotation[answerKey]"}, {"in"=>"query", "name"=>"annotation[assetId]"}, {"in"=>"query", "name"=>"annotation[code]"}, {"in"=>"query", "name"=>"annotation[correctAnswerKeys]"}, {"in"=>"query", "name"=>"annotation[description]"}, {"in"=>"query", "name"=>"annotation[duration]", "description"=>"Duration in milliseconds"}, {"in"=>"query", "name"=>"annotation[endTime]", "description"=>"End time in milliseconds"}, {"in"=>"query", "name"=>"annotation[entryId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"annotation[eventType]", "description"=>"Enum Type: `KalturaEventType`"}, {"in"=>"query", "name"=>"annotation[explanation]"}, {"in"=>"query", "name"=>"annotation[forceStop]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"annotation[hint]"}, {"in"=>"query", "name"=>"annotation[isPublic]", "description"=>"Enum Type: `KalturaNullableBoolean`Is the annotation public"}, {"in"=>"query", "name"=>"annotation[objectType]"}, {"in"=>"query", "name"=>"annotation[optionalAnswers]"}, {"in"=>"query", "name"=>"annotation[parentId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"annotation[partnerData]"}, {"in"=>"query", "name"=>"annotation[partnerSortValue]"}, {"in"=>"query", "name"=>"annotation[protocolType]", "description"=>"`insertOnly`Enum Type: `KalturaAdProtocolType`"}, {"in"=>"query", "name"=>"annotation[question]"}, {"in"=>"query", "name"=>"annotation[quizUserEntryId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"annotation[searchableOnEntry]", "description"=>"Enum Type: `KalturaNullableBoolean`Should the cue point get indexed on the entry"}, {"in"=>"query", "name"=>"annotation[sourceUrl]"}, {"in"=>"query", "name"=>"annotation[startTime]", "description"=>"Start time in milliseconds"}, {"in"=>"query", "name"=>"annotation[subType]", "description"=>"Enum Type: `KalturaThumbCuePointSubType`The sub type of the ThumbCuePoint"}, {"in"=>"query", "name"=>"annotation[systemName]"}, {"in"=>"query", "name"=>"annotation[tags]"}, {"in"=>"query", "name"=>"annotation[text]"}, {"in"=>"query", "name"=>"annotation[thumbOffset]"}, {"in"=>"query", "name"=>"annotation[title]"}, {"in"=>"query", "name"=>"annotation[triggeredAt]"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Annotation", "Annotation", "Action", "Update"]}}, "/service/annotation_annotation/action/updateStatus"=>{"get"=>{"summary"=>"Get Service Annotation Annotation Action Updatestatus", "description"=>"Update cuePoint status by id", "operationId"=>"annotation.updateStatus", "x-api-path-slug"=>"serviceannotation-annotationactionupdatestatus-get", "parameters"=>[{"in"=>"query", "name"=>"id"}, {"in"=>"query", "name"=>"status", "description"=>"Enum Type: `KalturaCuePointStatus`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Annotation", "Annotation", "Action", "UpdateStatus"]}}, "/service/apptoken/action/add"=>{"get"=>{"summary"=>"Get Service Apptoken Action Add", "description"=>"Add new application authentication token", "operationId"=>"appToken.add", "x-api-path-slug"=>"serviceapptokenactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"appToken[expiry]", "description"=>"Expiry time of current token (unix timestamp in seconds)"}, {"in"=>"query", "name"=>"appToken[hashType]", "description"=>"Enum Type: `KalturaAppTokenHashType`"}, {"in"=>"query", "name"=>"appToken[sessionDuration]", "description"=>"Expiry duration of KS (Kaltura Session) that created using the current token (in seconds)"}, {"in"=>"query", "name"=>"appToken[sessionPrivileges]", "description"=>"Comma separated privileges to be applied on KS (Kaltura Session) that created using the current token"}, {"in"=>"query", "name"=>"appToken[sessionType]", "description"=>"Enum Type: `KalturaSessionType`Type of KS (Kaltura Session) that created using the current token"}, {"in"=>"query", "name"=>"appToken[sessionUserId]", "description"=>"User id of KS (Kaltura Session) that created using the current token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Apptoken", "Action", "Add"]}}, "/service/apptoken/action/delete"=>{"get"=>{"summary"=>"Get Service Apptoken Action Delete", "description"=>"Delete application authentication token by id", "operationId"=>"appToken.delete", "x-api-path-slug"=>"serviceapptokenactiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Apptoken", "Action", "Delete"]}}, "/service/apptoken/action/get"=>{"get"=>{"summary"=>"Get Service Apptoken Action Get", "description"=>"Get application authentication token by id", "operationId"=>"appToken.get", "x-api-path-slug"=>"serviceapptokenactionget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Apptoken", "Action", "Get"]}}, "/service/apptoken/action/list"=>{"get"=>{"summary"=>"Get Service Apptoken Action List", "description"=>"List application authentication tokens by filter and pager", "operationId"=>"appToken.list", "x-api-path-slug"=>"serviceapptokenactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaAppTokenStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Apptoken", "Action", "List"]}}, "/service/apptoken/action/startSession"=>{"get"=>{"summary"=>"Get Service Apptoken Action Startsession", "description"=>"Starts a new KS (kaltura Session) based on application authentication token id", "operationId"=>"appToken.startSession", "x-api-path-slug"=>"serviceapptokenactionstartsession-get", "parameters"=>[{"in"=>"query", "name"=>"expiry", "description"=>"session expiry (in seconds), could be overwritten by shorter expiry of the application token and the session-expiry that defined on the application token"}, {"in"=>"query", "name"=>"id", "description"=>"application token id"}, {"in"=>"query", "name"=>"tokenHash", "description"=>"hashed token, built of sha1 on current KS concatenated with the application token"}, {"in"=>"query", "name"=>"type", "description"=>"Enum Type: `KalturaSessionType`session type, will be ignored if a different session type already defined on the application token"}, {"in"=>"query", "name"=>"userId", "description"=>"session user id, will be ignored if a different user id already defined on the application token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Apptoken", "Action", "StartSession"]}}, "/service/apptoken/action/update"=>{"get"=>{"summary"=>"Get Service Apptoken Action Update", "description"=>"Update application authentication token by id", "operationId"=>"appToken.update", "x-api-path-slug"=>"serviceapptokenactionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"appToken[expiry]", "description"=>"Expiry time of current token (unix timestamp in seconds)"}, {"in"=>"query", "name"=>"appToken[hashType]", "description"=>"Enum Type: `KalturaAppTokenHashType`"}, {"in"=>"query", "name"=>"appToken[sessionDuration]", "description"=>"Expiry duration of KS (Kaltura Session) that created using the current token (in seconds)"}, {"in"=>"query", "name"=>"appToken[sessionPrivileges]", "description"=>"Comma separated privileges to be applied on KS (Kaltura Session) that created using the current token"}, {"in"=>"query", "name"=>"appToken[sessionType]", "description"=>"Enum Type: `KalturaSessionType`Type of KS (Kaltura Session) that created using the current token"}, {"in"=>"query", "name"=>"appToken[sessionUserId]", "description"=>"User id of KS (Kaltura Session) that created using the current token"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Apptoken", "Action", "Update"]}}, "/service/aspera_aspera/action/getFaspUrl"=>{"get"=>{"summary"=>"Get Service Aspera Aspera Action Getfaspurl", "description"=>"", "operationId"=>"aspera.getFaspUrl", "x-api-path-slug"=>"serviceaspera-asperaactiongetfaspurl-get", "parameters"=>[{"in"=>"query", "name"=>"flavorAssetId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Aspera", "Aspera", "Action", "GetFaspUrl"]}}, "/service/attachment_attachmentasset/action/add"=>{"get"=>{"summary"=>"Get Service Attachment Attachmentasset Action Add", "description"=>"Add attachment asset", "operationId"=>"attachmentAsset.add", "x-api-path-slug"=>"serviceattachment-attachmentassetactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"attachmentAsset[accuracy]", "description"=>"The accuracy of the transcript - values between 0 and 1"}, {"in"=>"query", "name"=>"attachmentAsset[actualSourceAssetParamsIds]", "description"=>"Comma separated list of source flavor params ids"}, {"in"=>"query", "name"=>"attachmentAsset[fileExt]", "description"=>"`insertOnly`The file extension"}, {"in"=>"query", "name"=>"attachmentAsset[filename]", "description"=>"The filename of the attachment asset content"}, {"in"=>"query", "name"=>"attachmentAsset[format]", "description"=>"Enum Type: `KalturaAttachmentType`The attachment format"}, {"in"=>"query", "name"=>"attachmentAsset[humanVerified]", "description"=>"Enum Type: `KalturaNullableBoolean`Was verified by human or machine"}, {"in"=>"query", "name"=>"attachmentAsset[language]", "description"=>"Enum Type: `KalturaLanguage`The language of the transcript"}, {"in"=>"query", "name"=>"attachmentAsset[objectType]"}, {"in"=>"query", "name"=>"attachmentAsset[partnerData]", "description"=>"Partner private data"}, {"in"=>"query", "name"=>"attachmentAsset[partnerDescription]", "description"=>"Partner friendly description"}, {"in"=>"query", "name"=>"attachmentAsset[providerType]", "description"=>"Enum Type: `KalturaTranscriptProviderType`The provider of the transcript"}, {"in"=>"query", "name"=>"attachmentAsset[tags]", "description"=>"Tags used to identify the Flavor Asset in various scenarios"}, {"in"=>"query", "name"=>"attachmentAsset[title]", "description"=>"Attachment asset title"}, {"in"=>"query", "name"=>"entryId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Attachment", "Attachmentasset", "Action", "Add"]}}, "/service/attachment_attachmentasset/action/delete"=>{"get"=>{"summary"=>"Get Service Attachment Attachmentasset Action Delete", "description"=>"", "operationId"=>"attachmentAsset.delete", "x-api-path-slug"=>"serviceattachment-attachmentassetactiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"attachmentAssetId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Attachment", "Attachmentasset", "Action", "Delete"]}}, "/service/attachment_attachmentasset/action/get"=>{"get"=>{"summary"=>"Get Service Attachment Attachmentasset Action Get", "description"=>"", "operationId"=>"attachmentAsset.get", "x-api-path-slug"=>"serviceattachment-attachmentassetactionget-get", "parameters"=>[{"in"=>"query", "name"=>"attachmentAssetId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Attachment", "Attachmentasset", "Action", "Get"]}}, "/service/attachment_attachmentasset/action/getRemotePaths"=>{"get"=>{"summary"=>"Get Service Attachment Attachmentasset Action Getremotepaths", "description"=>"Get remote storage existing paths for the asset", "operationId"=>"attachmentAsset.getRemotePaths", "x-api-path-slug"=>"serviceattachment-attachmentassetactiongetremotepaths-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Attachment", "Attachmentasset", "Action", "GetRemotePaths"]}}, "/service/attachment_attachmentasset/action/getUrl"=>{"get"=>{"summary"=>"Get Service Attachment Attachmentasset Action Geturl", "description"=>"Get download URL for the asset", "operationId"=>"attachmentAsset.getUrl", "x-api-path-slug"=>"serviceattachment-attachmentassetactiongeturl-get", "parameters"=>[{"in"=>"query", "name"=>"id"}, {"in"=>"query", "name"=>"storageId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Attachment", "Attachmentasset", "Action", "GetUrl"]}}, "/service/attachment_attachmentasset/action/list"=>{"get"=>{"summary"=>"Get Service Attachment Attachmentasset Action List", "description"=>"List attachment Assets by filter and pager", "operationId"=>"attachmentAsset.list", "x-api-path-slug"=>"serviceattachment-attachmentassetactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[captionParamsIdEqual]"}, {"in"=>"query", "name"=>"filter[captionParamsIdIn]"}, {"in"=>"query", "name"=>"filter[contentLike]"}, {"in"=>"query", "name"=>"filter[contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[deletedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[deletedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[entryIdEqual]"}, {"in"=>"query", "name"=>"filter[entryIdIn]"}, {"in"=>"query", "name"=>"filter[flavorParamsIdEqual]"}, {"in"=>"query", "name"=>"filter[flavorParamsIdIn]"}, {"in"=>"query", "name"=>"filter[formatEqual]", "description"=>"Enum Type: `KalturaAttachmentType`"}, {"in"=>"query", "name"=>"filter[formatIn]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[labelEqual]"}, {"in"=>"query", "name"=>"filter[labelIn]"}, {"in"=>"query", "name"=>"filter[languageEqual]", "description"=>"Enum Type: `KalturaLanguage`"}, {"in"=>"query", "name"=>"filter[languageIn]"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[partnerDescriptionLike]"}, {"in"=>"query", "name"=>"filter[partnerDescriptionMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[partnerDescriptionMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[partnerIdEqual]"}, {"in"=>"query", "name"=>"filter[partnerIdIn]"}, {"in"=>"query", "name"=>"filter[sizeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[sizeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[startTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[startTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaAttachmentAssetStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[statusNotIn]"}, {"in"=>"query", "name"=>"filter[tagsLike]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[thumbParamsIdEqual]"}, {"in"=>"query", "name"=>"filter[thumbParamsIdIn]"}, {"in"=>"query", "name"=>"filter[typeIn]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Attachment", "Attachmentasset", "Action", "List"]}}, "/service/attachment_attachmentasset/action/serve"=>{"get"=>{"summary"=>"Get Service Attachment Attachmentasset Action Serve", "description"=>"Serves attachment by its id", "operationId"=>"attachmentAsset.serve", "x-api-path-slug"=>"serviceattachment-attachmentassetactionserve-get", "parameters"=>[{"in"=>"query", "name"=>"attachmentAssetId"}, {"in"=>"query", "name"=>"serveOptions[download]"}, {"in"=>"query", "name"=>"serveOptions[referrer]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Attachment", "Attachmentasset", "Action", "Serve"]}}, "/service/attachment_attachmentasset/action/setContent"=>{"post"=>{"summary"=>"Post Service Attachment Attachmentasset Action Setcontent", "description"=>"Update content of attachment asset", "operationId"=>"attachmentAsset.setContent", "x-api-path-slug"=>"serviceattachment-attachmentassetactionsetcontent-post", "parameters"=>[{"in"=>"query", "name"=>"contentResource[assetId]", "description"=>"ID of the source asset"}, {"in"=>"query", "name"=>"contentResource[content]", "description"=>"Textual content"}, {"in"=>"query", "name"=>"contentResource[dropFolderFileId]", "description"=>"Id of the drop folder file object"}, {"in"=>"query", "name"=>"contentResource[entryId]", "description"=>"ID of the source entry"}, {"in"=>"formData", "name"=>"contentResource[fileData]", "description"=>"Represents the $_FILE"}, {"in"=>"query", "name"=>"contentResource[fileSyncObjectType]", "description"=>"The object type of the file sync object"}, {"in"=>"query", "name"=>"contentResource[flavorParamsId]", "description"=>"ID of the source flavor params, set to null to use the source flavor"}, {"in"=>"query", "name"=>"contentResource[forceAsyncDownload]", "description"=>"Force Import Job"}, {"in"=>"query", "name"=>"contentResource[keepOriginalFile]", "description"=>"Should keep original file (false = mv, true = cp)"}, {"in"=>"query", "name"=>"contentResource[keyPassphrase]", "description"=>"Passphrase for SSH keys"}, {"in"=>"query", "name"=>"contentResource[localFilePath]", "description"=>"Full path to the local file"}, {"in"=>"query", "name"=>"contentResource[objectId]", "description"=>"The object id of the file sync object"}, {"in"=>"query", "name"=>"contentResource[objectSubType]", "description"=>"The object sub-type of the file sync object"}, {"in"=>"query", "name"=>"contentResource[objectType]"}, {"in"=>"query", "name"=>"contentResource[privateKey]", "description"=>"SSH private key"}, {"in"=>"query", "name"=>"contentResource[publicKey]", "description"=>"SSH public key"}, {"in"=>"query", "name"=>"contentResource[resources]"}, {"in"=>"query", "name"=>"contentResource[resource][assetId]", "description"=>"ID of the source asset"}, {"in"=>"query", "name"=>"contentResource[resource][content]", "description"=>"Textual content"}, {"in"=>"query", "name"=>"contentResource[resource][dropFolderFileId]", "description"=>"Id of the drop folder file object"}, {"in"=>"query", "name"=>"contentResource[resource][entryId]", "description"=>"ID of the source entry"}, {"in"=>"formData", "name"=>"contentResource[resource][fileData]", "description"=>"Represents the $_FILE"}, {"in"=>"query", "name"=>"contentResource[resource][fileSyncObjectType]", "description"=>"The object type of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][flavorParamsId]", "description"=>"ID of the source flavor params, set to null to use the source flavor"}, {"in"=>"query", "name"=>"contentResource[resource][forceAsyncDownload]", "description"=>"Force Import Job"}, {"in"=>"query", "name"=>"contentResource[resource][keepOriginalFile]", "description"=>"Should keep original file (false = mv, true = cp)"}, {"in"=>"query", "name"=>"contentResource[resource][keyPassphrase]", "description"=>"Passphrase for SSH keys"}, {"in"=>"query", "name"=>"contentResource[resource][localFilePath]", "description"=>"Full path to the local file"}, {"in"=>"query", "name"=>"contentResource[resource][objectId]", "description"=>"The object id of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][objectSubType]", "description"=>"The object sub-type of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][objectType]"}, {"in"=>"query", "name"=>"contentResource[resource][privateKey]", "description"=>"SSH private key"}, {"in"=>"query", "name"=>"contentResource[resource][publicKey]", "description"=>"SSH public key"}, {"in"=>"query", "name"=>"contentResource[resource][resources]"}, {"in"=>"query", "name"=>"contentResource[resource][resource][assetId]", "description"=>"ID of the source asset"}, {"in"=>"query", "name"=>"contentResource[resource][resource][content]", "description"=>"Textual content"}, {"in"=>"query", "name"=>"contentResource[resource][resource][dropFolderFileId]", "description"=>"Id of the drop folder file object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][entryId]", "description"=>"ID of the source entry"}, {"in"=>"formData", "name"=>"contentResource[resource][resource][fileData]", "description"=>"Represents the $_FILE"}, {"in"=>"query", "name"=>"contentResource[resource][resource][fileSyncObjectType]", "description"=>"The object type of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][flavorParamsId]", "description"=>"ID of the source flavor params, set to null to use the source flavor"}, {"in"=>"query", "name"=>"contentResource[resource][resource][forceAsyncDownload]", "description"=>"Force Import Job"}, {"in"=>"query", "name"=>"contentResource[resource][resource][keepOriginalFile]", "description"=>"Should keep original file (false = mv, true = cp)"}, {"in"=>"query", "name"=>"contentResource[resource][resource][keyPassphrase]", "description"=>"Passphrase for SSH keys"}, {"in"=>"query", "name"=>"contentResource[resource][resource][localFilePath]", "description"=>"Full path to the local file"}, {"in"=>"query", "name"=>"contentResource[resource][resource][objectId]", "description"=>"The object id of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][objectSubType]", "description"=>"The object sub-type of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][objectType]"}, {"in"=>"query", "name"=>"contentResource[resource][resource][privateKey]", "description"=>"SSH private key"}, {"in"=>"query", "name"=>"contentResource[resource][resource][publicKey]", "description"=>"SSH public key"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resources]"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][assetId]", "description"=>"ID of the source asset"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][content]", "description"=>"Textual content"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][dropFolderFileId]", "description"=>"Id of the drop folder file object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][entryId]", "description"=>"ID of the source entry"}, {"in"=>"formData", "name"=>"contentResource[resource][resource][resource][fileData]", "description"=>"Represents the $_FILE"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][fileSyncObjectType]", "description"=>"The object type of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][flavorParamsId]", "description"=>"ID of the source flavor params, set to null to use the source flavor"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][forceAsyncDownload]", "description"=>"Force Import Job"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][keepOriginalFile]", "description"=>"Should keep original file (false = mv, true = cp)"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][keyPassphrase]", "description"=>"Passphrase for SSH keys"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][localFilePath]", "description"=>"Full path to the local file"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][objectId]", "description"=>"The object id of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][objectSubType]", "description"=>"The object sub-type of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][objectType]"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][privateKey]", "description"=>"SSH private key"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][publicKey]", "description"=>"SSH public key"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][resources]"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][storageProfileId]", "description"=>"ID of storage profile to be associated with the created file sync, used for file serving URL composing"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][token]", "description"=>"Token that returned from upload"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][url]", "description"=>"Remote URL, FTP, HTTP or HTTPS"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][version]", "description"=>"The version of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][storageProfileId]", "description"=>"ID of storage profile to be associated with the created file sync, used for file serving URL composing"}, {"in"=>"query", "name"=>"contentResource[resource][resource][token]", "description"=>"Token that returned from upload"}, {"in"=>"query", "name"=>"contentResource[resource][resource][url]", "description"=>"Remote URL, FTP, HTTP or HTTPS"}, {"in"=>"query", "name"=>"contentResource[resource][resource][version]", "description"=>"The version of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][storageProfileId]", "description"=>"ID of storage profile to be associated with the created file sync, used for file serving URL composing"}, {"in"=>"query", "name"=>"contentResource[resource][token]", "description"=>"Token that returned from upload"}, {"in"=>"query", "name"=>"contentResource[resource][url]", "description"=>"Remote URL, FTP, HTTP or HTTPS"}, {"in"=>"query", "name"=>"contentResource[resource][version]", "description"=>"The version of the file sync object"}, {"in"=>"query", "name"=>"contentResource[storageProfileId]", "description"=>"ID of storage profile to be associated with the created file sync, used for file serving URL composing"}, {"in"=>"query", "name"=>"contentResource[token]", "description"=>"Token that returned from upload"}, {"in"=>"query", "name"=>"contentResource[url]", "description"=>"Remote URL, FTP, HTTP or HTTPS"}, {"in"=>"query", "name"=>"contentResource[version]", "description"=>"The version of the file sync object"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Attachment", "Attachmentasset", "Action", "SetContent"]}}, "/service/attachment_attachmentasset/action/update"=>{"get"=>{"summary"=>"Get Service Attachment Attachmentasset Action Update", "description"=>"Update attachment asset", "operationId"=>"attachmentAsset.update", "x-api-path-slug"=>"serviceattachment-attachmentassetactionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"attachmentAsset[accuracy]", "description"=>"The accuracy of the transcript - values between 0 and 1"}, {"in"=>"query", "name"=>"attachmentAsset[actualSourceAssetParamsIds]", "description"=>"Comma separated list of source flavor params ids"}, {"in"=>"query", "name"=>"attachmentAsset[fileExt]", "description"=>"`insertOnly`The file extension"}, {"in"=>"query", "name"=>"attachmentAsset[filename]", "description"=>"The filename of the attachment asset content"}, {"in"=>"query", "name"=>"attachmentAsset[format]", "description"=>"Enum Type: `KalturaAttachmentType`The attachment format"}, {"in"=>"query", "name"=>"attachmentAsset[humanVerified]", "description"=>"Enum Type: `KalturaNullableBoolean`Was verified by human or machine"}, {"in"=>"query", "name"=>"attachmentAsset[language]", "description"=>"Enum Type: `KalturaLanguage`The language of the transcript"}, {"in"=>"query", "name"=>"attachmentAsset[objectType]"}, {"in"=>"query", "name"=>"attachmentAsset[partnerData]", "description"=>"Partner private data"}, {"in"=>"query", "name"=>"attachmentAsset[partnerDescription]", "description"=>"Partner friendly description"}, {"in"=>"query", "name"=>"attachmentAsset[providerType]", "description"=>"Enum Type: `KalturaTranscriptProviderType`The provider of the transcript"}, {"in"=>"query", "name"=>"attachmentAsset[tags]", "description"=>"Tags used to identify the Flavor Asset in various scenarios"}, {"in"=>"query", "name"=>"attachmentAsset[title]", "description"=>"Attachment asset title"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Attachment", "Attachmentasset", "Action", "Update"]}}, "/service/attuversedistribution_attuverse/action/getFeed"=>{"get"=>{"summary"=>"Get Service Attuversedistribution Attuverse Action Getfeed", "description"=>"", "operationId"=>"attUverse.getFeed", "x-api-path-slug"=>"serviceattuversedistribution-attuverseactiongetfeed-get", "parameters"=>[{"in"=>"query", "name"=>"distributionProfileId"}, {"in"=>"query", "name"=>"hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Attuversedistribution", "Attuverse", "Action", "GetFeed"]}}, "/service/audit_audittrail/action/add"=>{"get"=>{"summary"=>"Get Service Audit Audittrail Action Add", "description"=>"Allows you to add an audit trail object and audit trail content associated with Kaltura object", "operationId"=>"auditTrail.add", "x-api-path-slug"=>"serviceaudit-audittrailactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"auditTrail[action]", "description"=>"Enum Type: `KalturaAuditTrailAction`"}, {"in"=>"query", "name"=>"auditTrail[auditObjectType]", "description"=>"Enum Type: `KalturaAuditTrailObjectType`"}, {"in"=>"query", "name"=>"auditTrail[data][changedItems]"}, {"in"=>"query", "name"=>"auditTrail[data][dc]"}, {"in"=>"query", "name"=>"auditTrail[data][fileType]", "description"=>"Enum Type: `KalturaAuditTrailFileSyncType`"}, {"in"=>"query", "name"=>"auditTrail[data][info]"}, {"in"=>"query", "name"=>"auditTrail[data][objectSubType]"}, {"in"=>"query", "name"=>"auditTrail[data][objectType]"}, {"in"=>"query", "name"=>"auditTrail[data][original]"}, {"in"=>"query", "name"=>"auditTrail[data][version]"}, {"in"=>"query", "name"=>"auditTrail[entryId]"}, {"in"=>"query", "name"=>"auditTrail[objectId]"}, {"in"=>"query", "name"=>"auditTrail[relatedObjectId]"}, {"in"=>"query", "name"=>"auditTrail[relatedObjectType]", "description"=>"Enum Type: `KalturaAuditTrailObjectType`"}, {"in"=>"query", "name"=>"auditTrail[userId]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Audit", "Audittrail", "Action", "Add"]}}, "/service/audit_audittrail/action/get"=>{"get"=>{"summary"=>"Get Service Audit Audittrail Action Get", "description"=>"Retrieve an audit trail object by id", "operationId"=>"auditTrail.get", "x-api-path-slug"=>"serviceaudit-audittrailactionget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Audit", "Audittrail", "Action", "Get"]}}, "/service/audit_audittrail/action/list"=>{"get"=>{"summary"=>"Get Service Audit Audittrail Action List", "description"=>"List audit trail objects by filter and pager", "operationId"=>"auditTrail.list", "x-api-path-slug"=>"serviceaudit-audittrailactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[actionEqual]", "description"=>"Enum Type: `KalturaAuditTrailAction`"}, {"in"=>"query", "name"=>"filter[actionIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[auditObjectTypeEqual]", "description"=>"Enum Type: `KalturaAuditTrailObjectType`"}, {"in"=>"query", "name"=>"filter[auditObjectTypeIn]"}, {"in"=>"query", "name"=>"filter[clientTagEqual]"}, {"in"=>"query", "name"=>"filter[contextEqual]", "description"=>"Enum Type: `KalturaAuditTrailContext`"}, {"in"=>"query", "name"=>"filter[contextIn]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[entryIdEqual]"}, {"in"=>"query", "name"=>"filter[entryIdIn]"}, {"in"=>"query", "name"=>"filter[entryPointEqual]"}, {"in"=>"query", "name"=>"filter[entryPointIn]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[ipAddressEqual]"}, {"in"=>"query", "name"=>"filter[ipAddressIn]"}, {"in"=>"query", "name"=>"filter[ksEqual]"}, {"in"=>"query", "name"=>"filter[masterPartnerIdEqual]"}, {"in"=>"query", "name"=>"filter[masterPartnerIdIn]"}, {"in"=>"query", "name"=>"filter[objectIdEqual]"}, {"in"=>"query", "name"=>"filter[objectIdIn]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[parsedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[parsedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[partnerIdEqual]"}, {"in"=>"query", "name"=>"filter[partnerIdIn]"}, {"in"=>"query", "name"=>"filter[relatedObjectIdEqual]"}, {"in"=>"query", "name"=>"filter[relatedObjectIdIn]"}, {"in"=>"query", "name"=>"filter[relatedObjectTypeEqual]", "description"=>"Enum Type: `KalturaAuditTrailObjectType`"}, {"in"=>"query", "name"=>"filter[relatedObjectTypeIn]"}, {"in"=>"query", "name"=>"filter[requestIdEqual]"}, {"in"=>"query", "name"=>"filter[requestIdIn]"}, {"in"=>"query", "name"=>"filter[serverNameEqual]"}, {"in"=>"query", "name"=>"filter[serverNameIn]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaAuditTrailStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[userIdEqual]"}, {"in"=>"query", "name"=>"filter[userIdIn]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Audit", "Audittrail", "Action", "List"]}}, "/service/avndistribution_avn/action/getFeed"=>{"get"=>{"summary"=>"Get Service Avndistribution Avn Action Getfeed", "description"=>"", "operationId"=>"avn.getFeed", "x-api-path-slug"=>"serviceavndistribution-avnactiongetfeed-get", "parameters"=>[{"in"=>"query", "name"=>"distributionProfileId"}, {"in"=>"query", "name"=>"hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Avndistribution", "Avn", "Action", "GetFeed"]}}, "/service/baseentry/action/add"=>{"get"=>{"summary"=>"Get Service Baseentry Action Add", "description"=>"Generic add entry, should be used when the uploaded entry type is not known.", "operationId"=>"baseEntry.add", "x-api-path-slug"=>"servicebaseentryactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"entry[accessControlId]", "description"=>"The Access Control ID assigned to this entry (null when not set, send -1 to remove)"}, {"in"=>"query", "name"=>"entry[adminTags]", "description"=>"Entry admin tags can be updated only by administrators"}, {"in"=>"query", "name"=>"entry[bitrates]"}, {"in"=>"query", "name"=>"entry[categoriesIds]", "description"=>"Comma separated list of ids of categories to which this entry belongs"}, {"in"=>"query", "name"=>"entry[categories]", "description"=>"Comma separated list of full names of categories to which this entry belongs"}, {"in"=>"query", "name"=>"entry[conversionProfileId]", "description"=>"Override the default ingestion profile"}, {"in"=>"query", "name"=>"entry[conversionQuality]", "description"=>"`insertOnly`Override the default conversion quality"}, {"in"=>"query", "name"=>"entry[creatorId]", "description"=>"`insertOnly`The ID of the user who created this entry"}, {"in"=>"query", "name"=>"entry[creditUrl]", "description"=>"The URL for credits"}, {"in"=>"query", "name"=>"entry[creditUserName]", "description"=>"The user name used for credits"}, {"in"=>"query", "name"=>"entry[currentBroadcastStartTime]", "description"=>"The time (unix timestamp in milliseconds) in which the entry broadcast started or 0 when the entry is off the air"}, {"in"=>"query", "name"=>"entry[dataContent]", "description"=>"The data of the entry"}, {"in"=>"query", "name"=>"entry[description]", "description"=>"Entry description"}, {"in"=>"query", "name"=>"entry[displayInSearch]", "description"=>"Enum Type: `KalturaEntryDisplayInSearchType`should we display this entry in search"}, {"in"=>"query", "name"=>"entry[documentType]", "description"=>"`insertOnly`Enum Type: `KalturaDocumentType`The type of the document"}, {"in"=>"query", "name"=>"entry[dvrStatus]", "description"=>"Enum Type: `KalturaDVRStatus`DVR Status Enabled/Disabled"}, {"in"=>"query", "name"=>"entry[dvrWindow]", "description"=>"Window of time which the DVR allows for backwards scrubbing (in minutes)"}, {"in"=>"query", "name"=>"entry[editorType]", "description"=>"Enum Type: `KalturaEditorType`The editor type used to edit the metadata"}, {"in"=>"query", "name"=>"entry[encodingIP1]", "description"=>"The broadcast primary ip"}, {"in"=>"query", "name"=>"entry[encodingIP2]", "description"=>"The broadcast secondary ip"}, {"in"=>"query", "name"=>"entry[endDate]", "description"=>"Entry scheduling end date (null when not set, send -1 to remove)"}, {"in"=>"query", "name"=>"entry[entitledUsersEdit]", "description"=>"list of user ids that are entitled to edit the entry (no server enforcement) The difference between entitledUsersEdit and entitledUsersPublish is applicative only"}, {"in"=>"query", "name"=>"entry[entitledUsersPublish]", "description"=>"list of user ids that are entitled to publish the entry (no server enforcement) The difference between entitledUsersEdit and entitledUsersPublish is applicative only"}, {"in"=>"query", "name"=>"entry[externalSourceType]", "description"=>"`insertOnly`Enum Type: `KalturaExternalMediaSourceType`The source type of the external media"}, {"in"=>"query", "name"=>"entry[filters]"}, {"in"=>"query", "name"=>"entry[groupId]"}, {"in"=>"query", "name"=>"entry[hlsStreamUrl]", "description"=>"HLS URL - URL for live stream playback on mobile device"}, {"in"=>"query", "name"=>"entry[lastElapsedRecordingTime]", "description"=>"Elapsed recording time (in msec) up to the point where the live stream was last stopped (unpublished)"}, {"in"=>"query", "name"=>"entry[licenseType]", "description"=>"Enum Type: `KalturaLicenseType`License type used for this entry"}, {"in"=>"query", "name"=>"entry[liveStreamConfigurations]"}, {"in"=>"query", "name"=>"entry[mediaType]", "description"=>"`insertOnly`Enum Type: `KalturaMediaType`The media type of the entry"}, {"in"=>"query", "name"=>"entry[msDuration]", "description"=>"The duration in miliseconds"}, {"in"=>"query", "name"=>"entry[name]", "description"=>"Entry name (Min 1 chars)"}, {"in"=>"query", "name"=>"entry[objectType]"}, {"in"=>"query", "name"=>"entry[offlineMessage]", "description"=>"The message to be presented when the stream is offline"}, {"in"=>"query", "name"=>"entry[operationAttributes]"}, {"in"=>"query", "name"=>"entry[parentEntryId]", "description"=>"ID of source root entry, used for defining entires association"}, {"in"=>"query", "name"=>"entry[partnerData]", "description"=>"Can be used to store various partner related data as a string"}, {"in"=>"query", "name"=>"entry[partnerSortValue]", "description"=>"Can be used to store various partner related data as a numeric value"}, {"in"=>"query", "name"=>"entry[playlistContent]", "description"=>"Content of the playlist - XML if the playlistType is dynamic text if the playlistType is static url if the playlistType is mRss"}, {"in"=>"query", "name"=>"entry[playlistId]", "description"=>"Playlist id to be played"}, {"in"=>"query", "name"=>"entry[playlistType]", "description"=>"Enum Type: `KalturaPlaylistType`Type of playlist"}, {"in"=>"query", "name"=>"entry[primaryBroadcastingUrl]"}, {"in"=>"query", "name"=>"entry[primaryRtspBroadcastingUrl]"}, {"in"=>"query", "name"=>"entry[publishConfigurations]"}, {"in"=>"query", "name"=>"entry[pushPublishEnabled]", "description"=>"Enum Type: `KalturaLivePublishStatus`Flag denoting whether entry should be published by the media server"}, {"in"=>"query", "name"=>"entry[recordedEntryId]", "description"=>"Recorded entry id"}, {"in"=>"query", "name"=>"entry[recordingOptions][shouldCopyEntitlement]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entry[recordingOptions][shouldCopyScheduling]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entry[recordingOptions][shouldCopyThumbnail]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entry[recordingOptions][shouldMakeHidden]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entry[recordStatus]", "description"=>"Enum Type: `KalturaRecordStatus`Recording Status Enabled/Disabled"}, {"in"=>"query", "name"=>"entry[redirectEntryId]", "description"=>"IF not empty, points to an entry ID the should replace this current entrys id"}, {"in"=>"query", "name"=>"entry[referenceId]", "description"=>"Entry external reference id"}, {"in"=>"query", "name"=>"entry[repeat]", "description"=>"Enum Type: `KalturaNullableBoolean`Indicates that the segments should be repeated for ever"}, {"in"=>"query", "name"=>"entry[retrieveDataContentByGet]", "description"=>"`insertOnly`indicator whether to return the object for get action with the dataContent field"}, {"in"=>"query", "name"=>"entry[searchProviderId]", "description"=>"`insertOnly`The ID of the media in the importing site"}, {"in"=>"query", "name"=>"entry[searchProviderType]", "description"=>"`insertOnly`Enum Type: `KalturaSearchProviderType`The search provider type used to import this entry"}, {"in"=>"query", "name"=>"entry[secondaryBroadcastingUrl]"}, {"in"=>"query", "name"=>"entry[secondaryRtspBroadcastingUrl]"}, {"in"=>"query", "name"=>"entry[sourceType]", "description"=>"`insertOnly`Enum Type: `KalturaSourceType`The source type of the entry"}, {"in"=>"query", "name"=>"entry[startDate]", "description"=>"Entry scheduling start date (null when not set, send -1 to remove)"}, {"in"=>"query", "name"=>"entry[streamName]"}, {"in"=>"query", "name"=>"entry[streamPassword]", "description"=>"The broadcast password"}, {"in"=>"query", "name"=>"entry[streams]"}, {"in"=>"query", "name"=>"entry[streamUrl]", "description"=>"The stream url"}, {"in"=>"query", "name"=>"entry[tags]", "description"=>"Entry tags"}, {"in"=>"query", "name"=>"entry[templateEntryId]", "description"=>"`insertOnly`Template entry id"}, {"in"=>"query", "name"=>"entry[totalResults]", "description"=>"Maximum count of results to be returned in playlist execution"}, {"in"=>"query", "name"=>"entry[type]", "description"=>"Enum Type: `KalturaEntryType`The type of the entry, this is auto filled by the derived entry object"}, {"in"=>"query", "name"=>"entry[urlManager]", "description"=>"URL Manager to handle the live stream URL (for instance, add token)"}, {"in"=>"query", "name"=>"entry[userId]", "description"=>"The ID of the user who is the owner of this entry"}, {"in"=>"query", "name"=>"type", "description"=>"Enum Type: `KalturaEntryType`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "Add"]}}, "/service/baseentry/action/addContent"=>{"post"=>{"summary"=>"Post Service Baseentry Action Addcontent", "description"=>"Attach content resource to entry in status NO_MEDIA", "operationId"=>"baseEntry.addContent", "x-api-path-slug"=>"servicebaseentryactionaddcontent-post", "parameters"=>[{"in"=>"query", "name"=>"entryId"}, {"in"=>"query", "name"=>"resource[assetId]", "description"=>"ID of the source asset"}, {"in"=>"query", "name"=>"resource[content]", "description"=>"Textual content"}, {"in"=>"query", "name"=>"resource[dropFolderFileId]", "description"=>"Id of the drop folder file object"}, {"in"=>"query", "name"=>"resource[entryId]", "description"=>"ID of the source entry"}, {"in"=>"formData", "name"=>"resource[fileData]", "description"=>"Represents the $_FILE"}, {"in"=>"query", "name"=>"resource[fileSyncObjectType]", "description"=>"The object type of the file sync object"}, {"in"=>"query", "name"=>"resource[flavorParamsId]", "description"=>"ID of the source flavor params, set to null to use the source flavor"}, {"in"=>"query", "name"=>"resource[forceAsyncDownload]", "description"=>"Force Import Job"}, {"in"=>"query", "name"=>"resource[keepOriginalFile]", "description"=>"Should keep original file (false = mv, true = cp)"}, {"in"=>"query", "name"=>"resource[keyPassphrase]", "description"=>"Passphrase for SSH keys"}, {"in"=>"query", "name"=>"resource[localFilePath]", "description"=>"Full path to the local file"}, {"in"=>"query", "name"=>"resource[objectId]", "description"=>"The object id of the file sync object"}, {"in"=>"query", "name"=>"resource[objectSubType]", "description"=>"The object sub-type of the file sync object"}, {"in"=>"query", "name"=>"resource[objectType]"}, {"in"=>"query", "name"=>"resource[privateKey]", "description"=>"SSH private key"}, {"in"=>"query", "name"=>"resource[publicKey]", "description"=>"SSH public key"}, {"in"=>"query", "name"=>"resource[resources]"}, {"in"=>"query", "name"=>"resource[resource][assetId]", "description"=>"ID of the source asset"}, {"in"=>"query", "name"=>"resource[resource][content]", "description"=>"Textual content"}, {"in"=>"query", "name"=>"resource[resource][dropFolderFileId]", "description"=>"Id of the drop folder file object"}, {"in"=>"query", "name"=>"resource[resource][entryId]", "description"=>"ID of the source entry"}, {"in"=>"formData", "name"=>"resource[resource][fileData]", "description"=>"Represents the $_FILE"}, {"in"=>"query", "name"=>"resource[resource][fileSyncObjectType]", "description"=>"The object type of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][flavorParamsId]", "description"=>"ID of the source flavor params, set to null to use the source flavor"}, {"in"=>"query", "name"=>"resource[resource][forceAsyncDownload]", "description"=>"Force Import Job"}, {"in"=>"query", "name"=>"resource[resource][keepOriginalFile]", "description"=>"Should keep original file (false = mv, true = cp)"}, {"in"=>"query", "name"=>"resource[resource][keyPassphrase]", "description"=>"Passphrase for SSH keys"}, {"in"=>"query", "name"=>"resource[resource][localFilePath]", "description"=>"Full path to the local file"}, {"in"=>"query", "name"=>"resource[resource][objectId]", "description"=>"The object id of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][objectSubType]", "description"=>"The object sub-type of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][objectType]"}, {"in"=>"query", "name"=>"resource[resource][privateKey]", "description"=>"SSH private key"}, {"in"=>"query", "name"=>"resource[resource][publicKey]", "description"=>"SSH public key"}, {"in"=>"query", "name"=>"resource[resource][resources]"}, {"in"=>"query", "name"=>"resource[resource][resource][assetId]", "description"=>"ID of the source asset"}, {"in"=>"query", "name"=>"resource[resource][resource][content]", "description"=>"Textual content"}, {"in"=>"query", "name"=>"resource[resource][resource][dropFolderFileId]", "description"=>"Id of the drop folder file object"}, {"in"=>"query", "name"=>"resource[resource][resource][entryId]", "description"=>"ID of the source entry"}, {"in"=>"formData", "name"=>"resource[resource][resource][fileData]", "description"=>"Represents the $_FILE"}, {"in"=>"query", "name"=>"resource[resource][resource][fileSyncObjectType]", "description"=>"The object type of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][resource][flavorParamsId]", "description"=>"ID of the source flavor params, set to null to use the source flavor"}, {"in"=>"query", "name"=>"resource[resource][resource][forceAsyncDownload]", "description"=>"Force Import Job"}, {"in"=>"query", "name"=>"resource[resource][resource][keepOriginalFile]", "description"=>"Should keep original file (false = mv, true = cp)"}, {"in"=>"query", "name"=>"resource[resource][resource][keyPassphrase]", "description"=>"Passphrase for SSH keys"}, {"in"=>"query", "name"=>"resource[resource][resource][localFilePath]", "description"=>"Full path to the local file"}, {"in"=>"query", "name"=>"resource[resource][resource][objectId]", "description"=>"The object id of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][resource][objectSubType]", "description"=>"The object sub-type of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][resource][objectType]"}, {"in"=>"query", "name"=>"resource[resource][resource][privateKey]", "description"=>"SSH private key"}, {"in"=>"query", "name"=>"resource[resource][resource][publicKey]", "description"=>"SSH public key"}, {"in"=>"query", "name"=>"resource[resource][resource][resources]"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][assetId]", "description"=>"ID of the source asset"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][content]", "description"=>"Textual content"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][dropFolderFileId]", "description"=>"Id of the drop folder file object"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][entryId]", "description"=>"ID of the source entry"}, {"in"=>"formData", "name"=>"resource[resource][resource][resource][fileData]", "description"=>"Represents the $_FILE"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][fileSyncObjectType]", "description"=>"The object type of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][flavorParamsId]", "description"=>"ID of the source flavor params, set to null to use the source flavor"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][forceAsyncDownload]", "description"=>"Force Import Job"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][keepOriginalFile]", "description"=>"Should keep original file (false = mv, true = cp)"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][keyPassphrase]", "description"=>"Passphrase for SSH keys"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][localFilePath]", "description"=>"Full path to the local file"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][objectId]", "description"=>"The object id of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][objectSubType]", "description"=>"The object sub-type of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][objectType]"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][privateKey]", "description"=>"SSH private key"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][publicKey]", "description"=>"SSH public key"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][resources]"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][storageProfileId]", "description"=>"ID of storage profile to be associated with the created file sync, used for file serving URL composing"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][token]", "description"=>"Token that returned from upload"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][url]", "description"=>"Remote URL, FTP, HTTP or HTTPS"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][version]", "description"=>"The version of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][resource][storageProfileId]", "description"=>"ID of storage profile to be associated with the created file sync, used for file serving URL composing"}, {"in"=>"query", "name"=>"resource[resource][resource][token]", "description"=>"Token that returned from upload"}, {"in"=>"query", "name"=>"resource[resource][resource][url]", "description"=>"Remote URL, FTP, HTTP or HTTPS"}, {"in"=>"query", "name"=>"resource[resource][resource][version]", "description"=>"The version of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][storageProfileId]", "description"=>"ID of storage profile to be associated with the created file sync, used for file serving URL composing"}, {"in"=>"query", "name"=>"resource[resource][token]", "description"=>"Token that returned from upload"}, {"in"=>"query", "name"=>"resource[resource][url]", "description"=>"Remote URL, FTP, HTTP or HTTPS"}, {"in"=>"query", "name"=>"resource[resource][version]", "description"=>"The version of the file sync object"}, {"in"=>"query", "name"=>"resource[storageProfileId]", "description"=>"ID of storage profile to be associated with the created file sync, used for file serving URL composing"}, {"in"=>"query", "name"=>"resource[token]", "description"=>"Token that returned from upload"}, {"in"=>"query", "name"=>"resource[url]", "description"=>"Remote URL, FTP, HTTP or HTTPS"}, {"in"=>"query", "name"=>"resource[version]", "description"=>"The version of the file sync object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "AddContent"]}}, "/service/baseentry/action/addFromUploadedFile"=>{"get"=>{"summary"=>"Get Service Baseentry Action Addfromuploadedfile", "description"=>"Generic add entry using an uploaded file, should be used when the uploaded entry type is not known.", "operationId"=>"baseEntry.addFromUploadedFile", "x-api-path-slug"=>"servicebaseentryactionaddfromuploadedfile-get", "parameters"=>[{"in"=>"query", "name"=>"entry[accessControlId]", "description"=>"The Access Control ID assigned to this entry (null when not set, send -1 to remove)"}, {"in"=>"query", "name"=>"entry[adminTags]", "description"=>"Entry admin tags can be updated only by administrators"}, {"in"=>"query", "name"=>"entry[bitrates]"}, {"in"=>"query", "name"=>"entry[categoriesIds]", "description"=>"Comma separated list of ids of categories to which this entry belongs"}, {"in"=>"query", "name"=>"entry[categories]", "description"=>"Comma separated list of full names of categories to which this entry belongs"}, {"in"=>"query", "name"=>"entry[conversionProfileId]", "description"=>"Override the default ingestion profile"}, {"in"=>"query", "name"=>"entry[conversionQuality]", "description"=>"`insertOnly`Override the default conversion quality"}, {"in"=>"query", "name"=>"entry[creatorId]", "description"=>"`insertOnly`The ID of the user who created this entry"}, {"in"=>"query", "name"=>"entry[creditUrl]", "description"=>"The URL for credits"}, {"in"=>"query", "name"=>"entry[creditUserName]", "description"=>"The user name used for credits"}, {"in"=>"query", "name"=>"entry[currentBroadcastStartTime]", "description"=>"The time (unix timestamp in milliseconds) in which the entry broadcast started or 0 when the entry is off the air"}, {"in"=>"query", "name"=>"entry[dataContent]", "description"=>"The data of the entry"}, {"in"=>"query", "name"=>"entry[description]", "description"=>"Entry description"}, {"in"=>"query", "name"=>"entry[displayInSearch]", "description"=>"Enum Type: `KalturaEntryDisplayInSearchType`should we display this entry in search"}, {"in"=>"query", "name"=>"entry[documentType]", "description"=>"`insertOnly`Enum Type: `KalturaDocumentType`The type of the document"}, {"in"=>"query", "name"=>"entry[dvrStatus]", "description"=>"Enum Type: `KalturaDVRStatus`DVR Status Enabled/Disabled"}, {"in"=>"query", "name"=>"entry[dvrWindow]", "description"=>"Window of time which the DVR allows for backwards scrubbing (in minutes)"}, {"in"=>"query", "name"=>"entry[editorType]", "description"=>"Enum Type: `KalturaEditorType`The editor type used to edit the metadata"}, {"in"=>"query", "name"=>"entry[encodingIP1]", "description"=>"The broadcast primary ip"}, {"in"=>"query", "name"=>"entry[encodingIP2]", "description"=>"The broadcast secondary ip"}, {"in"=>"query", "name"=>"entry[endDate]", "description"=>"Entry scheduling end date (null when not set, send -1 to remove)"}, {"in"=>"query", "name"=>"entry[entitledUsersEdit]", "description"=>"list of user ids that are entitled to edit the entry (no server enforcement) The difference between entitledUsersEdit and entitledUsersPublish is applicative only"}, {"in"=>"query", "name"=>"entry[entitledUsersPublish]", "description"=>"list of user ids that are entitled to publish the entry (no server enforcement) The difference between entitledUsersEdit and entitledUsersPublish is applicative only"}, {"in"=>"query", "name"=>"entry[externalSourceType]", "description"=>"`insertOnly`Enum Type: `KalturaExternalMediaSourceType`The source type of the external media"}, {"in"=>"query", "name"=>"entry[filters]"}, {"in"=>"query", "name"=>"entry[groupId]"}, {"in"=>"query", "name"=>"entry[hlsStreamUrl]", "description"=>"HLS URL - URL for live stream playback on mobile device"}, {"in"=>"query", "name"=>"entry[lastElapsedRecordingTime]", "description"=>"Elapsed recording time (in msec) up to the point where the live stream was last stopped (unpublished)"}, {"in"=>"query", "name"=>"entry[licenseType]", "description"=>"Enum Type: `KalturaLicenseType`License type used for this entry"}, {"in"=>"query", "name"=>"entry[liveStreamConfigurations]"}, {"in"=>"query", "name"=>"entry[mediaType]", "description"=>"`insertOnly`Enum Type: `KalturaMediaType`The media type of the entry"}, {"in"=>"query", "name"=>"entry[msDuration]", "description"=>"The duration in miliseconds"}, {"in"=>"query", "name"=>"entry[name]", "description"=>"Entry name (Min 1 chars)"}, {"in"=>"query", "name"=>"entry[objectType]"}, {"in"=>"query", "name"=>"entry[offlineMessage]", "description"=>"The message to be presented when the stream is offline"}, {"in"=>"query", "name"=>"entry[operationAttributes]"}, {"in"=>"query", "name"=>"entry[parentEntryId]", "description"=>"ID of source root entry, used for defining entires association"}, {"in"=>"query", "name"=>"entry[partnerData]", "description"=>"Can be used to store various partner related data as a string"}, {"in"=>"query", "name"=>"entry[partnerSortValue]", "description"=>"Can be used to store various partner related data as a numeric value"}, {"in"=>"query", "name"=>"entry[playlistContent]", "description"=>"Content of the playlist - XML if the playlistType is dynamic text if the playlistType is static url if the playlistType is mRss"}, {"in"=>"query", "name"=>"entry[playlistId]", "description"=>"Playlist id to be played"}, {"in"=>"query", "name"=>"entry[playlistType]", "description"=>"Enum Type: `KalturaPlaylistType`Type of playlist"}, {"in"=>"query", "name"=>"entry[primaryBroadcastingUrl]"}, {"in"=>"query", "name"=>"entry[primaryRtspBroadcastingUrl]"}, {"in"=>"query", "name"=>"entry[publishConfigurations]"}, {"in"=>"query", "name"=>"entry[pushPublishEnabled]", "description"=>"Enum Type: `KalturaLivePublishStatus`Flag denoting whether entry should be published by the media server"}, {"in"=>"query", "name"=>"entry[recordedEntryId]", "description"=>"Recorded entry id"}, {"in"=>"query", "name"=>"entry[recordingOptions][shouldCopyEntitlement]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entry[recordingOptions][shouldCopyScheduling]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entry[recordingOptions][shouldCopyThumbnail]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entry[recordingOptions][shouldMakeHidden]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entry[recordStatus]", "description"=>"Enum Type: `KalturaRecordStatus`Recording Status Enabled/Disabled"}, {"in"=>"query", "name"=>"entry[redirectEntryId]", "description"=>"IF not empty, points to an entry ID the should replace this current entrys id"}, {"in"=>"query", "name"=>"entry[referenceId]", "description"=>"Entry external reference id"}, {"in"=>"query", "name"=>"entry[repeat]", "description"=>"Enum Type: `KalturaNullableBoolean`Indicates that the segments should be repeated for ever"}, {"in"=>"query", "name"=>"entry[retrieveDataContentByGet]", "description"=>"`insertOnly`indicator whether to return the object for get action with the dataContent field"}, {"in"=>"query", "name"=>"entry[searchProviderId]", "description"=>"`insertOnly`The ID of the media in the importing site"}, {"in"=>"query", "name"=>"entry[searchProviderType]", "description"=>"`insertOnly`Enum Type: `KalturaSearchProviderType`The search provider type used to import this entry"}, {"in"=>"query", "name"=>"entry[secondaryBroadcastingUrl]"}, {"in"=>"query", "name"=>"entry[secondaryRtspBroadcastingUrl]"}, {"in"=>"query", "name"=>"entry[sourceType]", "description"=>"`insertOnly`Enum Type: `KalturaSourceType`The source type of the entry"}, {"in"=>"query", "name"=>"entry[startDate]", "description"=>"Entry scheduling start date (null when not set, send -1 to remove)"}, {"in"=>"query", "name"=>"entry[streamName]"}, {"in"=>"query", "name"=>"entry[streamPassword]", "description"=>"The broadcast password"}, {"in"=>"query", "name"=>"entry[streams]"}, {"in"=>"query", "name"=>"entry[streamUrl]", "description"=>"The stream url"}, {"in"=>"query", "name"=>"entry[tags]", "description"=>"Entry tags"}, {"in"=>"query", "name"=>"entry[templateEntryId]", "description"=>"`insertOnly`Template entry id"}, {"in"=>"query", "name"=>"entry[totalResults]", "description"=>"Maximum count of results to be returned in playlist execution"}, {"in"=>"query", "name"=>"entry[type]", "description"=>"Enum Type: `KalturaEntryType`The type of the entry, this is auto filled by the derived entry object"}, {"in"=>"query", "name"=>"entry[urlManager]", "description"=>"URL Manager to handle the live stream URL (for instance, add token)"}, {"in"=>"query", "name"=>"entry[userId]", "description"=>"The ID of the user who is the owner of this entry"}, {"in"=>"query", "name"=>"type", "description"=>"Enum Type: `KalturaEntryType`"}, {"in"=>"query", "name"=>"uploadTokenId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "AddFromUploadedFile"]}}, "/service/baseentry/action/anonymousRank"=>{"get"=>{"summary"=>"Get Service Baseentry Action Anonymousrank", "description"=>"Anonymously rank an entry, no validation is done on duplicate rankings.", "operationId"=>"baseEntry.anonymousRank", "x-api-path-slug"=>"servicebaseentryactionanonymousrank-get", "parameters"=>[{"in"=>"query", "name"=>"entryId"}, {"in"=>"query", "name"=>"rank"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "AnonymousRank"]}}, "/service/baseentry/action/approve"=>{"get"=>{"summary"=>"Get Service Baseentry Action Approve", "description"=>"Approve the entry and mark the pending flags (if any) as moderated (this will make the entry playable).", "operationId"=>"baseEntry.approve", "x-api-path-slug"=>"servicebaseentryactionapprove-get", "parameters"=>[{"in"=>"query", "name"=>"entryId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "Approve"]}}, "/service/baseentry/action/clone"=>{"get"=>{"summary"=>"Get Service Baseentry Action Clone", "description"=>"Clone an entry with optional attributes to apply to the clone", "operationId"=>"baseEntry.clone", "x-api-path-slug"=>"servicebaseentryactionclone-get", "parameters"=>[{"in"=>"query", "name"=>"entryId", "description"=>"Id of entry to clone"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "Clone"]}}, "/service/baseentry/action/count"=>{"get"=>{"summary"=>"Get Service Baseentry Action Count", "description"=>"Count base entries by filter.", "operationId"=>"baseEntry.count", "x-api-path-slug"=>"servicebaseentryactioncount-get", "parameters"=>[{"in"=>"query", "name"=>"filter[accessControlIdEqual]"}, {"in"=>"query", "name"=>"filter[accessControlIdIn]"}, {"in"=>"query", "name"=>"filter[adminTagsLike]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[adminTagsMultiLikeAnd]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[adminTagsMultiLikeOr]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[assetParamsIdsMatchAnd]"}, {"in"=>"query", "name"=>"filter[assetParamsIdsMatchOr]"}, {"in"=>"query", "name"=>"filter[categoriesFullNameIn]"}, {"in"=>"query", "name"=>"filter[categoriesIdsEmpty]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[categoriesIdsMatchAnd]"}, {"in"=>"query", "name"=>"filter[categoriesIdsMatchOr]", "description"=>"All entries of the categories, excluding their child categories"}, {"in"=>"query", "name"=>"filter[categoriesIdsNotContains]"}, {"in"=>"query", "name"=>"filter[categoriesMatchAnd]"}, {"in"=>"query", "name"=>"filter[categoriesMatchOr]", "description"=>"All entries within these categories or their child categories"}, {"in"=>"query", "name"=>"filter[categoriesNotContains]"}, {"in"=>"query", "name"=>"filter[categoryAncestorIdIn]", "description"=>"All entries within this categoy or in child categories"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]", "description"=>"This filter parameter should be in use for retrieving only entries which were created at Kaltura system after a specific time/date (standard timestamp format)"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]", "description"=>"This filter parameter should be in use for retrieving only entries which were created at Kaltura system before a specific time/date (standard timestamp format)"}, {"in"=>"query", "name"=>"filter[creatorIdEqual]"}, {"in"=>"query", "name"=>"filter[documentTypeEqual]", "description"=>"Enum Type: `KalturaDocumentType`"}, {"in"=>"query", "name"=>"filter[documentTypeIn]"}, {"in"=>"query", "name"=>"filter[durationGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[durationGreaterThan]"}, {"in"=>"query", "name"=>"filter[durationLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[durationLessThan]"}, {"in"=>"query", "name"=>"filter[durationTypeMatchOr]"}, {"in"=>"query", "name"=>"filter[endDateGreaterThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"filter[endDateGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endDateLessThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"filter[endDateLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[entitledUsersEditMatchAnd]"}, {"in"=>"query", "name"=>"filter[entitledUsersEditMatchOr]"}, {"in"=>"query", "name"=>"filter[entitledUsersPublishMatchAnd]"}, {"in"=>"query", "name"=>"filter[entitledUsersPublishMatchOr]"}, {"in"=>"query", "name"=>"filter[externalSourceTypeEqual]", "description"=>"Enum Type: `KalturaExternalMediaSourceType`"}, {"in"=>"query", "name"=>"filter[externalSourceTypeIn]"}, {"in"=>"query", "name"=>"filter[flavorParamsIdsMatchAnd]"}, {"in"=>"query", "name"=>"filter[flavorParamsIdsMatchOr]"}, {"in"=>"query", "name"=>"filter[freeText]"}, {"in"=>"query", "name"=>"filter[groupIdEqual]"}, {"in"=>"query", "name"=>"filter[hasMediaServerHostname]"}, {"in"=>"query", "name"=>"filter[idEqual]", "description"=>"This filter should be in use for retrieving only a specific entry (identified by its entryId)"}, {"in"=>"query", "name"=>"filter[idIn]", "description"=>"This filter should be in use for retrieving few specific entries (string should include comma separated list of entryId strings)"}, {"in"=>"query", "name"=>"filter[idNotIn]"}, {"in"=>"query", "name"=>"filter[isLive]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[isRecordedEntryIdEmpty]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[isRoot]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[lastPlayedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[lastPlayedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[limit]"}, {"in"=>"query", "name"=>"filter[mediaDateGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[mediaDateLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[mediaTypeEqual]", "description"=>"Enum Type: `KalturaMediaType`"}, {"in"=>"query", "name"=>"filter[mediaTypeIn]"}, {"in"=>"query", "name"=>"filter[moderationStatusEqual]", "description"=>"Enum Type: `KalturaEntryModerationStatus`"}, {"in"=>"query", "name"=>"filter[moderationStatusIn]"}, {"in"=>"query", "name"=>"filter[moderationStatusNotEqual]", "description"=>"Enum Type: `KalturaEntryModerationStatus`"}, {"in"=>"query", "name"=>"filter[moderationStatusNotIn]"}, {"in"=>"query", "name"=>"filter[nameEqual]", "description"=>"This filter should be in use for retrieving entries with a specific name"}, {"in"=>"query", "name"=>"filter[nameLike]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[nameMultiLikeAnd]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[nameMultiLikeOr]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[parentEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[partnerIdEqual]", "description"=>"This filter should be in use for retrieving only entries which were uploaded by/assigned to users of a specific Kaltura Partner (identified by Partner ID)"}, {"in"=>"query", "name"=>"filter[partnerIdIn]", "description"=>"This filter should be in use for retrieving only entries within Kaltura network which were uploaded by/assigned to users of few Kaltura Partners (string should include comma separated list of PartnerIDs)"}, {"in"=>"query", "name"=>"filter[partnerSortValueGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[partnerSortValueLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[redirectFromEntryId]", "description"=>"The id of the original entry"}, {"in"=>"query", "name"=>"filter[referenceIdEqual]"}, {"in"=>"query", "name"=>"filter[referenceIdIn]"}, {"in"=>"query", "name"=>"filter[replacedEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[replacedEntryIdIn]"}, {"in"=>"query", "name"=>"filter[replacementStatusEqual]", "description"=>"Enum Type: `KalturaEntryReplacementStatus`"}, {"in"=>"query", "name"=>"filter[replacementStatusIn]"}, {"in"=>"query", "name"=>"filter[replacingEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[replacingEntryIdIn]"}, {"in"=>"query", "name"=>"filter[rootEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[rootEntryIdIn]"}, {"in"=>"query", "name"=>"filter[searchTextMatchAnd]", "description"=>"This filter should be in use for retrieving specific entries while search match the input string within all of the following metadata attributes: name, description, tags, adminTags"}, {"in"=>"query", "name"=>"filter[searchTextMatchOr]", "description"=>"This filter should be in use for retrieving specific entries while search match the input string within at least one of the following metadata attributes: name, description, tags, adminTags"}, {"in"=>"query", "name"=>"filter[sourceTypeEqual]", "description"=>"Enum Type: `KalturaSourceType`"}, {"in"=>"query", "name"=>"filter[sourceTypeIn]"}, {"in"=>"query", "name"=>"filter[sourceTypeNotEqual]", "description"=>"Enum Type: `KalturaSourceType`"}, {"in"=>"query", "name"=>"filter[sourceTypeNotIn]"}, {"in"=>"query", "name"=>"filter[startDateGreaterThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"filter[startDateGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[startDateLessThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"filter[startDateLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaEntryStatus`This filter should be in use for retrieving only entries, at a specific {"}, {"in"=>"query", "name"=>"filter[statusIn]", "description"=>"This filter should be in use for retrieving only entries, at few specific {"}, {"in"=>"query", "name"=>"filter[statusNotEqual]", "description"=>"Enum Type: `KalturaEntryStatus`This filter should be in use for retrieving only entries, not at a specific {"}, {"in"=>"query", "name"=>"filter[statusNotIn]", "description"=>"This filter should be in use for retrieving only entries, not at few specific {"}, {"in"=>"query", "name"=>"filter[tagsAdminTagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsAdminTagsMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[tagsAdminTagsNameMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsAdminTagsNameMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[tagsLike]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeAnd]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeOr]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[tagsNameMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsNameMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[totalRankGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[totalRankLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[typeEqual]", "description"=>"Enum Type: `KalturaEntryType`"}, {"in"=>"query", "name"=>"filter[typeIn]", "description"=>"This filter should be in use for retrieving entries of few {"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[userIdEqual]", "description"=>"This filter parameter should be in use for retrieving only entries, uploaded by/assigned to a specific user (identified by user Id)"}, {"in"=>"query", "name"=>"filter[userIdIn]"}, {"in"=>"query", "name"=>"filter[userIdNotIn]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "Count"]}}, "/service/baseentry/action/delete"=>{"get"=>{"summary"=>"Get Service Baseentry Action Delete", "description"=>"Delete an entry.", "operationId"=>"baseEntry.delete", "x-api-path-slug"=>"servicebaseentryactiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"entryId", "description"=>"Entry id to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "Delete"]}}, "/service/baseentry/action/export"=>{"get"=>{"summary"=>"Get Service Baseentry Action Export", "description"=>"", "operationId"=>"baseEntry.export", "x-api-path-slug"=>"servicebaseentryactionexport-get", "parameters"=>[{"in"=>"query", "name"=>"entryId"}, {"in"=>"query", "name"=>"storageProfileId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "Export"]}}, "/service/baseentry/action/flag"=>{"get"=>{"summary"=>"Get Service Baseentry Action Flag", "description"=>"Flag inappropriate entry for moderation.", "operationId"=>"baseEntry.flag", "x-api-path-slug"=>"servicebaseentryactionflag-get", "parameters"=>[{"in"=>"query", "name"=>"moderationFlag[comments]", "description"=>"The comment that was added to the flag"}, {"in"=>"query", "name"=>"moderationFlag[flaggedEntryId]", "description"=>"If moderation flag is set for entry, this is the flagged entry id"}, {"in"=>"query", "name"=>"moderationFlag[flaggedUserId]", "description"=>"If moderation flag is set for user, this is the flagged user id"}, {"in"=>"query", "name"=>"moderationFlag[flagType]", "description"=>"Enum Type: `KalturaModerationFlagType`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "Flag"]}}, "/service/baseentry/action/get"=>{"get"=>{"summary"=>"Get Service Baseentry Action Get", "description"=>"Get base entry by ID.", "operationId"=>"baseEntry.get", "x-api-path-slug"=>"servicebaseentryactionget-get", "parameters"=>[{"in"=>"query", "name"=>"entryId", "description"=>"Entry id"}, {"in"=>"query", "name"=>"version", "description"=>"Desired version of the data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "Get"]}}, "/service/baseentry/action/getByIds"=>{"get"=>{"summary"=>"Get Service Baseentry Action Getbyids", "description"=>"Get an array of KalturaBaseEntry objects by a comma-separated list of ids.", "operationId"=>"baseEntry.getByIds", "x-api-path-slug"=>"servicebaseentryactiongetbyids-get", "parameters"=>[{"in"=>"query", "name"=>"entryIds", "description"=>"Comma separated string of entry ids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "GetByIds"]}}, "/service/baseentry/action/getContextData"=>{"get"=>{"summary"=>"Get Service Baseentry Action Getcontextdata", "description"=>"This action delivers entry-related data, based on the user's context: access control, restriction, playback format and storage information.", "operationId"=>"baseEntry.getContextData", "x-api-path-slug"=>"servicebaseentryactiongetcontextdata-get", "parameters"=>[{"in"=>"query", "name"=>"contextDataParams[contexts]"}, {"in"=>"query", "name"=>"contextDataParams[flavorAssetId]", "description"=>"Id of the current flavor"}, {"in"=>"query", "name"=>"contextDataParams[flavorTags]", "description"=>"The tags of the flavors that should be used for playback"}, {"in"=>"query", "name"=>"contextDataParams[hashes]"}, {"in"=>"query", "name"=>"contextDataParams[ip]", "description"=>"IP to be used to test geographic location conditions"}, {"in"=>"query", "name"=>"contextDataParams[ks]", "description"=>"Kaltura session to be used to test session and user conditions"}, {"in"=>"query", "name"=>"contextDataParams[mediaProtocol]", "description"=>"Protocol of the specific media object"}, {"in"=>"query", "name"=>"contextDataParams[objectType]"}, {"in"=>"query", "name"=>"contextDataParams[referrer]", "description"=>"URL to be used to test domain conditions"}, {"in"=>"query", "name"=>"contextDataParams[streamerType]", "description"=>"Playback streamer type: RTMP, HTTP, appleHttps, rtsp, sl"}, {"in"=>"query", "name"=>"contextDataParams[time]", "description"=>"Unix timestamp (In seconds) to be used to test entry scheduling, keep null to use now"}, {"in"=>"query", "name"=>"contextDataParams[userAgent]", "description"=>"Browser or client application to be used to test agent conditions"}, {"in"=>"query", "name"=>"entryId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "GetContextData"]}}, "/service/baseentry/action/getPlaybackContext"=>{"get"=>{"summary"=>"Get Service Baseentry Action Getplaybackcontext", "description"=>"This action delivers all data relevant for player", "operationId"=>"baseEntry.getPlaybackContext", "x-api-path-slug"=>"servicebaseentryactiongetplaybackcontext-get", "parameters"=>[{"in"=>"query", "name"=>"contextDataParams[contexts]"}, {"in"=>"query", "name"=>"contextDataParams[flavorAssetId]", "description"=>"Id of the current flavor"}, {"in"=>"query", "name"=>"contextDataParams[flavorTags]", "description"=>"The tags of the flavors that should be used for playback"}, {"in"=>"query", "name"=>"contextDataParams[hashes]"}, {"in"=>"query", "name"=>"contextDataParams[ip]", "description"=>"IP to be used to test geographic location conditions"}, {"in"=>"query", "name"=>"contextDataParams[ks]", "description"=>"Kaltura session to be used to test session and user conditions"}, {"in"=>"query", "name"=>"contextDataParams[mediaProtocol]", "description"=>"Protocol of the specific media object"}, {"in"=>"query", "name"=>"contextDataParams[referrer]", "description"=>"URL to be used to test domain conditions"}, {"in"=>"query", "name"=>"contextDataParams[streamerType]", "description"=>"Playback streamer type: RTMP, HTTP, appleHttps, rtsp, sl"}, {"in"=>"query", "name"=>"contextDataParams[time]", "description"=>"Unix timestamp (In seconds) to be used to test entry scheduling, keep null to use now"}, {"in"=>"query", "name"=>"contextDataParams[userAgent]", "description"=>"Browser or client application to be used to test agent conditions"}, {"in"=>"query", "name"=>"entryId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "GetPlaybackContext"]}}, "/service/baseentry/action/getRemotePaths"=>{"get"=>{"summary"=>"Get Service Baseentry Action Getremotepaths", "description"=>"Get remote storage existing paths for the asset.", "operationId"=>"baseEntry.getRemotePaths", "x-api-path-slug"=>"servicebaseentryactiongetremotepaths-get", "parameters"=>[{"in"=>"query", "name"=>"entryId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "GetRemotePaths"]}}, "/service/baseentry/action/index"=>{"get"=>{"summary"=>"Get Service Baseentry Action Index", "description"=>"Index an entry by id.", "operationId"=>"baseEntry.index", "x-api-path-slug"=>"servicebaseentryactionindex-get", "parameters"=>[{"in"=>"query", "name"=>"id"}, {"in"=>"query", "name"=>"shouldUpdate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "Index"]}}, "/service/baseentry/action/list"=>{"get"=>{"summary"=>"Get Service Baseentry Action List", "description"=>"List base entries by filter with paging support.", "operationId"=>"baseEntry.list", "x-api-path-slug"=>"servicebaseentryactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[accessControlIdEqual]"}, {"in"=>"query", "name"=>"filter[accessControlIdIn]"}, {"in"=>"query", "name"=>"filter[adminTagsLike]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[adminTagsMultiLikeAnd]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[adminTagsMultiLikeOr]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[assetParamsIdsMatchAnd]"}, {"in"=>"query", "name"=>"filter[assetParamsIdsMatchOr]"}, {"in"=>"query", "name"=>"filter[categoriesFullNameIn]"}, {"in"=>"query", "name"=>"filter[categoriesIdsEmpty]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[categoriesIdsMatchAnd]"}, {"in"=>"query", "name"=>"filter[categoriesIdsMatchOr]", "description"=>"All entries of the categories, excluding their child categories"}, {"in"=>"query", "name"=>"filter[categoriesIdsNotContains]"}, {"in"=>"query", "name"=>"filter[categoriesMatchAnd]"}, {"in"=>"query", "name"=>"filter[categoriesMatchOr]", "description"=>"All entries within these categories or their child categories"}, {"in"=>"query", "name"=>"filter[categoriesNotContains]"}, {"in"=>"query", "name"=>"filter[categoryAncestorIdIn]", "description"=>"All entries within this categoy or in child categories"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]", "description"=>"This filter parameter should be in use for retrieving only entries which were created at Kaltura system after a specific time/date (standard timestamp format)"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]", "description"=>"This filter parameter should be in use for retrieving only entries which were created at Kaltura system before a specific time/date (standard timestamp format)"}, {"in"=>"query", "name"=>"filter[creatorIdEqual]"}, {"in"=>"query", "name"=>"filter[documentTypeEqual]", "description"=>"Enum Type: `KalturaDocumentType`"}, {"in"=>"query", "name"=>"filter[documentTypeIn]"}, {"in"=>"query", "name"=>"filter[durationGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[durationGreaterThan]"}, {"in"=>"query", "name"=>"filter[durationLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[durationLessThan]"}, {"in"=>"query", "name"=>"filter[durationTypeMatchOr]"}, {"in"=>"query", "name"=>"filter[endDateGreaterThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"filter[endDateGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endDateLessThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"filter[endDateLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[entitledUsersEditMatchAnd]"}, {"in"=>"query", "name"=>"filter[entitledUsersEditMatchOr]"}, {"in"=>"query", "name"=>"filter[entitledUsersPublishMatchAnd]"}, {"in"=>"query", "name"=>"filter[entitledUsersPublishMatchOr]"}, {"in"=>"query", "name"=>"filter[externalSourceTypeEqual]", "description"=>"Enum Type: `KalturaExternalMediaSourceType`"}, {"in"=>"query", "name"=>"filter[externalSourceTypeIn]"}, {"in"=>"query", "name"=>"filter[flavorParamsIdsMatchAnd]"}, {"in"=>"query", "name"=>"filter[flavorParamsIdsMatchOr]"}, {"in"=>"query", "name"=>"filter[freeText]"}, {"in"=>"query", "name"=>"filter[groupIdEqual]"}, {"in"=>"query", "name"=>"filter[hasMediaServerHostname]"}, {"in"=>"query", "name"=>"filter[idEqual]", "description"=>"This filter should be in use for retrieving only a specific entry (identified by its entryId)"}, {"in"=>"query", "name"=>"filter[idIn]", "description"=>"This filter should be in use for retrieving few specific entries (string should include comma separated list of entryId strings)"}, {"in"=>"query", "name"=>"filter[idNotIn]"}, {"in"=>"query", "name"=>"filter[isLive]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[isRecordedEntryIdEmpty]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[isRoot]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[lastPlayedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[lastPlayedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[limit]"}, {"in"=>"query", "name"=>"filter[mediaDateGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[mediaDateLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[mediaTypeEqual]", "description"=>"Enum Type: `KalturaMediaType`"}, {"in"=>"query", "name"=>"filter[mediaTypeIn]"}, {"in"=>"query", "name"=>"filter[moderationStatusEqual]", "description"=>"Enum Type: `KalturaEntryModerationStatus`"}, {"in"=>"query", "name"=>"filter[moderationStatusIn]"}, {"in"=>"query", "name"=>"filter[moderationStatusNotEqual]", "description"=>"Enum Type: `KalturaEntryModerationStatus`"}, {"in"=>"query", "name"=>"filter[moderationStatusNotIn]"}, {"in"=>"query", "name"=>"filter[nameEqual]", "description"=>"This filter should be in use for retrieving entries with a specific name"}, {"in"=>"query", "name"=>"filter[nameLike]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[nameMultiLikeAnd]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[nameMultiLikeOr]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[parentEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[partnerIdEqual]", "description"=>"This filter should be in use for retrieving only entries which were uploaded by/assigned to users of a specific Kaltura Partner (identified by Partner ID)"}, {"in"=>"query", "name"=>"filter[partnerIdIn]", "description"=>"This filter should be in use for retrieving only entries within Kaltura network which were uploaded by/assigned to users of few Kaltura Partners (string should include comma separated list of PartnerIDs)"}, {"in"=>"query", "name"=>"filter[partnerSortValueGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[partnerSortValueLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[redirectFromEntryId]", "description"=>"The id of the original entry"}, {"in"=>"query", "name"=>"filter[referenceIdEqual]"}, {"in"=>"query", "name"=>"filter[referenceIdIn]"}, {"in"=>"query", "name"=>"filter[replacedEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[replacedEntryIdIn]"}, {"in"=>"query", "name"=>"filter[replacementStatusEqual]", "description"=>"Enum Type: `KalturaEntryReplacementStatus`"}, {"in"=>"query", "name"=>"filter[replacementStatusIn]"}, {"in"=>"query", "name"=>"filter[replacingEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[replacingEntryIdIn]"}, {"in"=>"query", "name"=>"filter[rootEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[rootEntryIdIn]"}, {"in"=>"query", "name"=>"filter[searchTextMatchAnd]", "description"=>"This filter should be in use for retrieving specific entries while search match the input string within all of the following metadata attributes: name, description, tags, adminTags"}, {"in"=>"query", "name"=>"filter[searchTextMatchOr]", "description"=>"This filter should be in use for retrieving specific entries while search match the input string within at least one of the following metadata attributes: name, description, tags, adminTags"}, {"in"=>"query", "name"=>"filter[sourceTypeEqual]", "description"=>"Enum Type: `KalturaSourceType`"}, {"in"=>"query", "name"=>"filter[sourceTypeIn]"}, {"in"=>"query", "name"=>"filter[sourceTypeNotEqual]", "description"=>"Enum Type: `KalturaSourceType`"}, {"in"=>"query", "name"=>"filter[sourceTypeNotIn]"}, {"in"=>"query", "name"=>"filter[startDateGreaterThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"filter[startDateGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[startDateLessThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"filter[startDateLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaEntryStatus`This filter should be in use for retrieving only entries, at a specific {"}, {"in"=>"query", "name"=>"filter[statusIn]", "description"=>"This filter should be in use for retrieving only entries, at few specific {"}, {"in"=>"query", "name"=>"filter[statusNotEqual]", "description"=>"Enum Type: `KalturaEntryStatus`This filter should be in use for retrieving only entries, not at a specific {"}, {"in"=>"query", "name"=>"filter[statusNotIn]", "description"=>"This filter should be in use for retrieving only entries, not at few specific {"}, {"in"=>"query", "name"=>"filter[tagsAdminTagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsAdminTagsMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[tagsAdminTagsNameMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsAdminTagsNameMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[tagsLike]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeAnd]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeOr]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[tagsNameMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsNameMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[totalRankGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[totalRankLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[typeEqual]", "description"=>"Enum Type: `KalturaEntryType`"}, {"in"=>"query", "name"=>"filter[typeIn]", "description"=>"This filter should be in use for retrieving entries of few {"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[userIdEqual]", "description"=>"This filter parameter should be in use for retrieving only entries, uploaded by/assigned to a specific user (identified by user Id)"}, {"in"=>"query", "name"=>"filter[userIdIn]"}, {"in"=>"query", "name"=>"filter[userIdNotIn]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "List"]}}, "/service/baseentry/action/listByReferenceId"=>{"get"=>{"summary"=>"Get Service Baseentry Action Listbyreferenceid", "description"=>"List base entries by filter according to reference id", "operationId"=>"baseEntry.listByReferenceId", "x-api-path-slug"=>"servicebaseentryactionlistbyreferenceid-get", "parameters"=>[{"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}, {"in"=>"query", "name"=>"refId", "description"=>"Entry Reference ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "ListByReferenceId"]}}, "/service/baseentry/action/listFlags"=>{"get"=>{"summary"=>"Get Service Baseentry Action Listflags", "description"=>"List all pending flags for the entry.", "operationId"=>"baseEntry.listFlags", "x-api-path-slug"=>"servicebaseentryactionlistflags-get", "parameters"=>[{"in"=>"query", "name"=>"entryId"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "ListFlags"]}}, "/service/baseentry/action/reject"=>{"get"=>{"summary"=>"Get Service Baseentry Action Reject", "description"=>"Reject the entry and mark the pending flags (if any) as moderated (this will make the entry non-playable).", "operationId"=>"baseEntry.reject", "x-api-path-slug"=>"servicebaseentryactionreject-get", "parameters"=>[{"in"=>"query", "name"=>"entryId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "Reject"]}}, "/service/baseentry/action/update"=>{"get"=>{"summary"=>"Get Service Baseentry Action Update", "description"=>"Update base entry. Only the properties that were set will be updated.", "operationId"=>"baseEntry.update", "x-api-path-slug"=>"servicebaseentryactionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"baseEntry[accessControlId]", "description"=>"The Access Control ID assigned to this entry (null when not set, send -1 to remove)"}, {"in"=>"query", "name"=>"baseEntry[adminTags]", "description"=>"Entry admin tags can be updated only by administrators"}, {"in"=>"query", "name"=>"baseEntry[bitrates]"}, {"in"=>"query", "name"=>"baseEntry[categoriesIds]", "description"=>"Comma separated list of ids of categories to which this entry belongs"}, {"in"=>"query", "name"=>"baseEntry[categories]", "description"=>"Comma separated list of full names of categories to which this entry belongs"}, {"in"=>"query", "name"=>"baseEntry[conversionProfileId]", "description"=>"Override the default ingestion profile"}, {"in"=>"query", "name"=>"baseEntry[conversionQuality]", "description"=>"`insertOnly`Override the default conversion quality"}, {"in"=>"query", "name"=>"baseEntry[creatorId]", "description"=>"`insertOnly`The ID of the user who created this entry"}, {"in"=>"query", "name"=>"baseEntry[creditUrl]", "description"=>"The URL for credits"}, {"in"=>"query", "name"=>"baseEntry[creditUserName]", "description"=>"The user name used for credits"}, {"in"=>"query", "name"=>"baseEntry[currentBroadcastStartTime]", "description"=>"The time (unix timestamp in milliseconds) in which the entry broadcast started or 0 when the entry is off the air"}, {"in"=>"query", "name"=>"baseEntry[dataContent]", "description"=>"The data of the entry"}, {"in"=>"query", "name"=>"baseEntry[description]", "description"=>"Entry description"}, {"in"=>"query", "name"=>"baseEntry[displayInSearch]", "description"=>"Enum Type: `KalturaEntryDisplayInSearchType`should we display this entry in search"}, {"in"=>"query", "name"=>"baseEntry[documentType]", "description"=>"`insertOnly`Enum Type: `KalturaDocumentType`The type of the document"}, {"in"=>"query", "name"=>"baseEntry[dvrStatus]", "description"=>"Enum Type: `KalturaDVRStatus`DVR Status Enabled/Disabled"}, {"in"=>"query", "name"=>"baseEntry[dvrWindow]", "description"=>"Window of time which the DVR allows for backwards scrubbing (in minutes)"}, {"in"=>"query", "name"=>"baseEntry[editorType]", "description"=>"Enum Type: `KalturaEditorType`The editor type used to edit the metadata"}, {"in"=>"query", "name"=>"baseEntry[encodingIP1]", "description"=>"The broadcast primary ip"}, {"in"=>"query", "name"=>"baseEntry[encodingIP2]", "description"=>"The broadcast secondary ip"}, {"in"=>"query", "name"=>"baseEntry[endDate]", "description"=>"Entry scheduling end date (null when not set, send -1 to remove)"}, {"in"=>"query", "name"=>"baseEntry[entitledUsersEdit]", "description"=>"list of user ids that are entitled to edit the entry (no server enforcement) The difference between entitledUsersEdit and entitledUsersPublish is applicative only"}, {"in"=>"query", "name"=>"baseEntry[entitledUsersPublish]", "description"=>"list of user ids that are entitled to publish the entry (no server enforcement) The difference between entitledUsersEdit and entitledUsersPublish is applicative only"}, {"in"=>"query", "name"=>"baseEntry[externalSourceType]", "description"=>"`insertOnly`Enum Type: `KalturaExternalMediaSourceType`The source type of the external media"}, {"in"=>"query", "name"=>"baseEntry[filters]"}, {"in"=>"query", "name"=>"baseEntry[groupId]"}, {"in"=>"query", "name"=>"baseEntry[hlsStreamUrl]", "description"=>"HLS URL - URL for live stream playback on mobile device"}, {"in"=>"query", "name"=>"baseEntry[lastElapsedRecordingTime]", "description"=>"Elapsed recording time (in msec) up to the point where the live stream was last stopped (unpublished)"}, {"in"=>"query", "name"=>"baseEntry[licenseType]", "description"=>"Enum Type: `KalturaLicenseType`License type used for this entry"}, {"in"=>"query", "name"=>"baseEntry[liveStreamConfigurations]"}, {"in"=>"query", "name"=>"baseEntry[mediaType]", "description"=>"`insertOnly`Enum Type: `KalturaMediaType`The media type of the entry"}, {"in"=>"query", "name"=>"baseEntry[msDuration]", "description"=>"The duration in miliseconds"}, {"in"=>"query", "name"=>"baseEntry[name]", "description"=>"Entry name (Min 1 chars)"}, {"in"=>"query", "name"=>"baseEntry[objectType]"}, {"in"=>"query", "name"=>"baseEntry[offlineMessage]", "description"=>"The message to be presented when the stream is offline"}, {"in"=>"query", "name"=>"baseEntry[operationAttributes]"}, {"in"=>"query", "name"=>"baseEntry[parentEntryId]", "description"=>"ID of source root entry, used for defining entires association"}, {"in"=>"query", "name"=>"baseEntry[partnerData]", "description"=>"Can be used to store various partner related data as a string"}, {"in"=>"query", "name"=>"baseEntry[partnerSortValue]", "description"=>"Can be used to store various partner related data as a numeric value"}, {"in"=>"query", "name"=>"baseEntry[playlistContent]", "description"=>"Content of the playlist - XML if the playlistType is dynamic text if the playlistType is static url if the playlistType is mRss"}, {"in"=>"query", "name"=>"baseEntry[playlistId]", "description"=>"Playlist id to be played"}, {"in"=>"query", "name"=>"baseEntry[playlistType]", "description"=>"Enum Type: `KalturaPlaylistType`Type of playlist"}, {"in"=>"query", "name"=>"baseEntry[primaryBroadcastingUrl]"}, {"in"=>"query", "name"=>"baseEntry[primaryRtspBroadcastingUrl]"}, {"in"=>"query", "name"=>"baseEntry[publishConfigurations]"}, {"in"=>"query", "name"=>"baseEntry[pushPublishEnabled]", "description"=>"Enum Type: `KalturaLivePublishStatus`Flag denoting whether entry should be published by the media server"}, {"in"=>"query", "name"=>"baseEntry[recordedEntryId]", "description"=>"Recorded entry id"}, {"in"=>"query", "name"=>"baseEntry[recordingOptions][shouldCopyEntitlement]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"baseEntry[recordingOptions][shouldCopyScheduling]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"baseEntry[recordingOptions][shouldCopyThumbnail]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"baseEntry[recordingOptions][shouldMakeHidden]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"baseEntry[recordStatus]", "description"=>"Enum Type: `KalturaRecordStatus`Recording Status Enabled/Disabled"}, {"in"=>"query", "name"=>"baseEntry[redirectEntryId]", "description"=>"IF not empty, points to an entry ID the should replace this current entrys id"}, {"in"=>"query", "name"=>"baseEntry[referenceId]", "description"=>"Entry external reference id"}, {"in"=>"query", "name"=>"baseEntry[repeat]", "description"=>"Enum Type: `KalturaNullableBoolean`Indicates that the segments should be repeated for ever"}, {"in"=>"query", "name"=>"baseEntry[retrieveDataContentByGet]", "description"=>"`insertOnly`indicator whether to return the object for get action with the dataContent field"}, {"in"=>"query", "name"=>"baseEntry[searchProviderId]", "description"=>"`insertOnly`The ID of the media in the importing site"}, {"in"=>"query", "name"=>"baseEntry[searchProviderType]", "description"=>"`insertOnly`Enum Type: `KalturaSearchProviderType`The search provider type used to import this entry"}, {"in"=>"query", "name"=>"baseEntry[secondaryBroadcastingUrl]"}, {"in"=>"query", "name"=>"baseEntry[secondaryRtspBroadcastingUrl]"}, {"in"=>"query", "name"=>"baseEntry[sourceType]", "description"=>"`insertOnly`Enum Type: `KalturaSourceType`The source type of the entry"}, {"in"=>"query", "name"=>"baseEntry[startDate]", "description"=>"Entry scheduling start date (null when not set, send -1 to remove)"}, {"in"=>"query", "name"=>"baseEntry[streamName]"}, {"in"=>"query", "name"=>"baseEntry[streamPassword]", "description"=>"The broadcast password"}, {"in"=>"query", "name"=>"baseEntry[streams]"}, {"in"=>"query", "name"=>"baseEntry[streamUrl]", "description"=>"The stream url"}, {"in"=>"query", "name"=>"baseEntry[tags]", "description"=>"Entry tags"}, {"in"=>"query", "name"=>"baseEntry[templateEntryId]", "description"=>"`insertOnly`Template entry id"}, {"in"=>"query", "name"=>"baseEntry[totalResults]", "description"=>"Maximum count of results to be returned in playlist execution"}, {"in"=>"query", "name"=>"baseEntry[type]", "description"=>"Enum Type: `KalturaEntryType`The type of the entry, this is auto filled by the derived entry object"}, {"in"=>"query", "name"=>"baseEntry[urlManager]", "description"=>"URL Manager to handle the live stream URL (for instance, add token)"}, {"in"=>"query", "name"=>"baseEntry[userId]", "description"=>"The ID of the user who is the owner of this entry"}, {"in"=>"query", "name"=>"entryId", "description"=>"Entry id to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "Update"]}}, "/service/baseentry/action/updateContent"=>{"post"=>{"summary"=>"Post Service Baseentry Action Updatecontent", "description"=>"Update the content resource associated with the entry.", "operationId"=>"baseEntry.updateContent", "x-api-path-slug"=>"servicebaseentryactionupdatecontent-post", "parameters"=>[{"in"=>"query", "name"=>"advancedOptions[keepManualThumbnails]", "description"=>"If true manually created thumbnails will not be deleted on entry replacement"}, {"in"=>"query", "name"=>"advancedOptions[pluginOptionItems]"}, {"in"=>"query", "name"=>"conversionProfileId", "description"=>"The conversion profile id to be used on the entry"}, {"in"=>"query", "name"=>"entryId", "description"=>"Entry id to update"}, {"in"=>"query", "name"=>"resource[assetId]", "description"=>"ID of the source asset"}, {"in"=>"query", "name"=>"resource[content]", "description"=>"Textual content"}, {"in"=>"query", "name"=>"resource[dropFolderFileId]", "description"=>"Id of the drop folder file object"}, {"in"=>"query", "name"=>"resource[entryId]", "description"=>"ID of the source entry"}, {"in"=>"formData", "name"=>"resource[fileData]", "description"=>"Represents the $_FILE"}, {"in"=>"query", "name"=>"resource[fileSyncObjectType]", "description"=>"The object type of the file sync object"}, {"in"=>"query", "name"=>"resource[flavorParamsId]", "description"=>"ID of the source flavor params, set to null to use the source flavor"}, {"in"=>"query", "name"=>"resource[forceAsyncDownload]", "description"=>"Force Import Job"}, {"in"=>"query", "name"=>"resource[keepOriginalFile]", "description"=>"Should keep original file (false = mv, true = cp)"}, {"in"=>"query", "name"=>"resource[keyPassphrase]", "description"=>"Passphrase for SSH keys"}, {"in"=>"query", "name"=>"resource[localFilePath]", "description"=>"Full path to the local file"}, {"in"=>"query", "name"=>"resource[objectId]", "description"=>"The object id of the file sync object"}, {"in"=>"query", "name"=>"resource[objectSubType]", "description"=>"The object sub-type of the file sync object"}, {"in"=>"query", "name"=>"resource[objectType]"}, {"in"=>"query", "name"=>"resource[privateKey]", "description"=>"SSH private key"}, {"in"=>"query", "name"=>"resource[publicKey]", "description"=>"SSH public key"}, {"in"=>"query", "name"=>"resource[resources]"}, {"in"=>"query", "name"=>"resource[resource][assetId]", "description"=>"ID of the source asset"}, {"in"=>"query", "name"=>"resource[resource][content]", "description"=>"Textual content"}, {"in"=>"query", "name"=>"resource[resource][dropFolderFileId]", "description"=>"Id of the drop folder file object"}, {"in"=>"query", "name"=>"resource[resource][entryId]", "description"=>"ID of the source entry"}, {"in"=>"formData", "name"=>"resource[resource][fileData]", "description"=>"Represents the $_FILE"}, {"in"=>"query", "name"=>"resource[resource][fileSyncObjectType]", "description"=>"The object type of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][flavorParamsId]", "description"=>"ID of the source flavor params, set to null to use the source flavor"}, {"in"=>"query", "name"=>"resource[resource][forceAsyncDownload]", "description"=>"Force Import Job"}, {"in"=>"query", "name"=>"resource[resource][keepOriginalFile]", "description"=>"Should keep original file (false = mv, true = cp)"}, {"in"=>"query", "name"=>"resource[resource][keyPassphrase]", "description"=>"Passphrase for SSH keys"}, {"in"=>"query", "name"=>"resource[resource][localFilePath]", "description"=>"Full path to the local file"}, {"in"=>"query", "name"=>"resource[resource][objectId]", "description"=>"The object id of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][objectSubType]", "description"=>"The object sub-type of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][objectType]"}, {"in"=>"query", "name"=>"resource[resource][privateKey]", "description"=>"SSH private key"}, {"in"=>"query", "name"=>"resource[resource][publicKey]", "description"=>"SSH public key"}, {"in"=>"query", "name"=>"resource[resource][resources]"}, {"in"=>"query", "name"=>"resource[resource][resource][assetId]", "description"=>"ID of the source asset"}, {"in"=>"query", "name"=>"resource[resource][resource][content]", "description"=>"Textual content"}, {"in"=>"query", "name"=>"resource[resource][resource][dropFolderFileId]", "description"=>"Id of the drop folder file object"}, {"in"=>"query", "name"=>"resource[resource][resource][entryId]", "description"=>"ID of the source entry"}, {"in"=>"formData", "name"=>"resource[resource][resource][fileData]", "description"=>"Represents the $_FILE"}, {"in"=>"query", "name"=>"resource[resource][resource][fileSyncObjectType]", "description"=>"The object type of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][resource][flavorParamsId]", "description"=>"ID of the source flavor params, set to null to use the source flavor"}, {"in"=>"query", "name"=>"resource[resource][resource][forceAsyncDownload]", "description"=>"Force Import Job"}, {"in"=>"query", "name"=>"resource[resource][resource][keepOriginalFile]", "description"=>"Should keep original file (false = mv, true = cp)"}, {"in"=>"query", "name"=>"resource[resource][resource][keyPassphrase]", "description"=>"Passphrase for SSH keys"}, {"in"=>"query", "name"=>"resource[resource][resource][localFilePath]", "description"=>"Full path to the local file"}, {"in"=>"query", "name"=>"resource[resource][resource][objectId]", "description"=>"The object id of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][resource][objectSubType]", "description"=>"The object sub-type of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][resource][objectType]"}, {"in"=>"query", "name"=>"resource[resource][resource][privateKey]", "description"=>"SSH private key"}, {"in"=>"query", "name"=>"resource[resource][resource][publicKey]", "description"=>"SSH public key"}, {"in"=>"query", "name"=>"resource[resource][resource][resources]"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][assetId]", "description"=>"ID of the source asset"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][content]", "description"=>"Textual content"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][dropFolderFileId]", "description"=>"Id of the drop folder file object"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][entryId]", "description"=>"ID of the source entry"}, {"in"=>"formData", "name"=>"resource[resource][resource][resource][fileData]", "description"=>"Represents the $_FILE"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][fileSyncObjectType]", "description"=>"The object type of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][flavorParamsId]", "description"=>"ID of the source flavor params, set to null to use the source flavor"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][forceAsyncDownload]", "description"=>"Force Import Job"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][keepOriginalFile]", "description"=>"Should keep original file (false = mv, true = cp)"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][keyPassphrase]", "description"=>"Passphrase for SSH keys"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][localFilePath]", "description"=>"Full path to the local file"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][objectId]", "description"=>"The object id of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][objectSubType]", "description"=>"The object sub-type of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][objectType]"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][privateKey]", "description"=>"SSH private key"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][publicKey]", "description"=>"SSH public key"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][resources]"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][storageProfileId]", "description"=>"ID of storage profile to be associated with the created file sync, used for file serving URL composing"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][token]", "description"=>"Token that returned from upload"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][url]", "description"=>"Remote URL, FTP, HTTP or HTTPS"}, {"in"=>"query", "name"=>"resource[resource][resource][resource][version]", "description"=>"The version of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][resource][storageProfileId]", "description"=>"ID of storage profile to be associated with the created file sync, used for file serving URL composing"}, {"in"=>"query", "name"=>"resource[resource][resource][token]", "description"=>"Token that returned from upload"}, {"in"=>"query", "name"=>"resource[resource][resource][url]", "description"=>"Remote URL, FTP, HTTP or HTTPS"}, {"in"=>"query", "name"=>"resource[resource][resource][version]", "description"=>"The version of the file sync object"}, {"in"=>"query", "name"=>"resource[resource][storageProfileId]", "description"=>"ID of storage profile to be associated with the created file sync, used for file serving URL composing"}, {"in"=>"query", "name"=>"resource[resource][token]", "description"=>"Token that returned from upload"}, {"in"=>"query", "name"=>"resource[resource][url]", "description"=>"Remote URL, FTP, HTTP or HTTPS"}, {"in"=>"query", "name"=>"resource[resource][version]", "description"=>"The version of the file sync object"}, {"in"=>"query", "name"=>"resource[storageProfileId]", "description"=>"ID of storage profile to be associated with the created file sync, used for file serving URL composing"}, {"in"=>"query", "name"=>"resource[token]", "description"=>"Token that returned from upload"}, {"in"=>"query", "name"=>"resource[url]", "description"=>"Remote URL, FTP, HTTP or HTTPS"}, {"in"=>"query", "name"=>"resource[version]", "description"=>"The version of the file sync object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "UpdateContent"]}}, "/service/baseentry/action/updateThumbnailFromSourceEntry"=>{"get"=>{"summary"=>"Get Service Baseentry Action Updatethumbnailfromsourceentry", "description"=>"Update entry thumbnail from a different entry by a specified time offset (in seconds).", "operationId"=>"baseEntry.updateThumbnailFromSourceEntry", "x-api-path-slug"=>"servicebaseentryactionupdatethumbnailfromsourceentry-get", "parameters"=>[{"in"=>"query", "name"=>"entryId", "description"=>"Media entry id"}, {"in"=>"query", "name"=>"sourceEntryId", "description"=>"Media entry id"}, {"in"=>"query", "name"=>"timeOffset", "description"=>"Time offset (in seconds)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "UpdateThumbnailFromSourceEntry"]}}, "/service/baseentry/action/updateThumbnailFromUrl"=>{"get"=>{"summary"=>"Get Service Baseentry Action Updatethumbnailfromurl", "description"=>"Update entry thumbnail using url.", "operationId"=>"baseEntry.updateThumbnailFromUrl", "x-api-path-slug"=>"servicebaseentryactionupdatethumbnailfromurl-get", "parameters"=>[{"in"=>"query", "name"=>"entryId", "description"=>"Media entry id"}, {"in"=>"query", "name"=>"url", "description"=>"file url"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "UpdateThumbnailFromUrl"]}}, "/service/baseentry/action/updateThumbnailJpeg"=>{"post"=>{"summary"=>"Post Service Baseentry Action Updatethumbnailjpeg", "description"=>"Update entry thumbnail using a raw jpeg file.", "operationId"=>"baseEntry.updateThumbnailJpeg", "x-api-path-slug"=>"servicebaseentryactionupdatethumbnailjpeg-post", "parameters"=>[{"in"=>"query", "name"=>"entryId", "description"=>"Media entry id"}, {"in"=>"formData", "name"=>"fileData", "description"=>"Jpeg file data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "UpdateThumbnailJpeg"]}}, "/service/baseentry/action/upload"=>{"post"=>{"summary"=>"Post Service Baseentry Action Upload", "description"=>"Upload a file to Kaltura, that can be used to create an entry.", "operationId"=>"baseEntry.upload", "x-api-path-slug"=>"servicebaseentryactionupload-post", "parameters"=>[{"in"=>"formData", "name"=>"fileData", "description"=>"The file data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Baseentry", "Action", "Upload"]}}, "/service/batch/action/addBulkUploadResult"=>{"get"=>{"summary"=>"Get Service Batch Action Addbulkuploadresult", "description"=>"batch addBulkUploadResultAction action adds KalturaBulkUploadResult to the DB", "operationId"=>"batch.addBulkUploadResult", "x-api-path-slug"=>"servicebatchactionaddbulkuploadresult-get", "parameters"=>[{"in"=>"query", "name"=>"bulkUploadResult[accessControlProfileId]"}, {"in"=>"query", "name"=>"bulkUploadResult[action]", "description"=>"Enum Type: `KalturaBulkUploadAction`"}, {"in"=>"query", "name"=>"bulkUploadResult[appearInList]"}, {"in"=>"query", "name"=>"bulkUploadResult[bulkUploadJobId]", "description"=>"The id of the parent job"}, {"in"=>"query", "name"=>"bulkUploadResult[bulkUploadResultObjectType]", "description"=>"Enum Type: `KalturaBulkUploadObjectType`"}, {"in"=>"query", "name"=>"bulkUploadResult[categoryId]"}, {"in"=>"query", "name"=>"bulkUploadResult[categoryReferenceId]"}, {"in"=>"query", "name"=>"bulkUploadResult[category]"}, {"in"=>"query", "name"=>"bulkUploadResult[city]"}, {"in"=>"query", "name"=>"bulkUploadResult[contentType]"}, {"in"=>"query", "name"=>"bulkUploadResult[contributionPolicy]"}, {"in"=>"query", "name"=>"bulkUploadResult[conversionProfileId]"}, {"in"=>"query", "name"=>"bulkUploadResult[country]"}, {"in"=>"query", "name"=>"bulkUploadResult[creatorId]"}, {"in"=>"query", "name"=>"bulkUploadResult[dateOfBirth]"}, {"in"=>"query", "name"=>"bulkUploadResult[defaultPermissionLevel]"}, {"in"=>"query", "name"=>"bulkUploadResult[description]"}, {"in"=>"query", "name"=>"bulkUploadResult[email]"}, {"in"=>"query", "name"=>"bulkUploadResult[entitledUsersEdit]"}, {"in"=>"query", "name"=>"bulkUploadResult[entitledUsersPublish]"}, {"in"=>"query", "name"=>"bulkUploadResult[entryId]"}, {"in"=>"query", "name"=>"bulkUploadResult[entryStatus]"}, {"in"=>"query", "name"=>"bulkUploadResult[errorCode]"}, {"in"=>"query", "name"=>"bulkUploadResult[errorDescription]"}, {"in"=>"query", "name"=>"bulkUploadResult[errorType]"}, {"in"=>"query", "name"=>"bulkUploadResult[firstName]"}, {"in"=>"query", "name"=>"bulkUploadResult[gender]"}, {"in"=>"query", "name"=>"bulkUploadResult[group]"}, {"in"=>"query", "name"=>"bulkUploadResult[inheritanceType]"}, {"in"=>"query", "name"=>"bulkUploadResult[lastName]"}, {"in"=>"query", "name"=>"bulkUploadResult[lineIndex]", "description"=>"The index of the line in the CSV"}, {"in"=>"query", "name"=>"bulkUploadResult[moderation]"}, {"in"=>"query", "name"=>"bulkUploadResult[name]"}, {"in"=>"query", "name"=>"bulkUploadResult[objectErrorDescription]"}, {"in"=>"query", "name"=>"bulkUploadResult[objectId]"}, {"in"=>"query", "name"=>"bulkUploadResult[objectStatus]"}, {"in"=>"query", "name"=>"bulkUploadResult[objectType]"}, {"in"=>"query", "name"=>"bulkUploadResult[ownerId]"}, {"in"=>"query", "name"=>"bulkUploadResult[owner]"}, {"in"=>"query", "name"=>"bulkUploadResult[parentSystemName]"}, {"in"=>"query", "name"=>"bulkUploadResult[parentType]"}, {"in"=>"query", "name"=>"bulkUploadResult[partnerData]"}, {"in"=>"query", "name"=>"bulkUploadResult[partnerId]"}, {"in"=>"query", "name"=>"bulkUploadResult[partnerSortValue]"}, {"in"=>"query", "name"=>"bulkUploadResult[permissionLevel]"}, {"in"=>"query", "name"=>"bulkUploadResult[pluginsData]"}, {"in"=>"query", "name"=>"bulkUploadResult[privacy]"}, {"in"=>"query", "name"=>"bulkUploadResult[referenceId]"}, {"in"=>"query", "name"=>"bulkUploadResult[relativePath]"}, {"in"=>"query", "name"=>"bulkUploadResult[requiredObjectStatus]"}, {"in"=>"query", "name"=>"bulkUploadResult[resourceId]"}, {"in"=>"query", "name"=>"bulkUploadResult[rowData]", "description"=>"The data as recieved in the csv"}, {"in"=>"query", "name"=>"bulkUploadResult[scheduleEndDate]"}, {"in"=>"query", "name"=>"bulkUploadResult[scheduleStartDate]"}, {"in"=>"query", "name"=>"bulkUploadResult[screenName]"}, {"in"=>"query", "name"=>"bulkUploadResult[sshKeyPassphrase]"}, {"in"=>"query", "name"=>"bulkUploadResult[sshPrivateKey]"}, {"in"=>"query", "name"=>"bulkUploadResult[sshPublicKey]"}, {"in"=>"query", "name"=>"bulkUploadResult[state]"}, {"in"=>"query", "name"=>"bulkUploadResult[status]", "description"=>"Enum Type: `KalturaBulkUploadResultStatus`"}, {"in"=>"query", "name"=>"bulkUploadResult[systemName]"}, {"in"=>"query", "name"=>"bulkUploadResult[tags]"}, {"in"=>"query", "name"=>"bulkUploadResult[templateEntryId]"}, {"in"=>"query", "name"=>"bulkUploadResult[thumbnailSaved]"}, {"in"=>"query", "name"=>"bulkUploadResult[thumbnailUrl]"}, {"in"=>"query", "name"=>"bulkUploadResult[title]"}, {"in"=>"query", "name"=>"bulkUploadResult[type]"}, {"in"=>"query", "name"=>"bulkUploadResult[updateMethod]"}, {"in"=>"query", "name"=>"bulkUploadResult[url]"}, {"in"=>"query", "name"=>"bulkUploadResult[userId]"}, {"in"=>"query", "name"=>"bulkUploadResult[userJoinPolicy]"}, {"in"=>"query", "name"=>"bulkUploadResult[zip]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "AddBulkUploadResult"]}}, "/service/batch/action/addMediaInfo"=>{"get"=>{"summary"=>"Get Service Batch Action Addmediainfo", "description"=>"batch addMediaInfoAction action saves a media info object", "operationId"=>"batch.addMediaInfo", "x-api-path-slug"=>"servicebatchactionaddmediainfo-get", "parameters"=>[{"in"=>"query", "name"=>"mediaInfo[audioBitRateMode]", "description"=>"Enum Type: `KalturaBitRateMode`The audio bit rate mode"}, {"in"=>"query", "name"=>"mediaInfo[audioBitRate]", "description"=>"The audio bit rate"}, {"in"=>"query", "name"=>"mediaInfo[audioChannels]", "description"=>"The number of audio channels"}, {"in"=>"query", "name"=>"mediaInfo[audioCodecId]", "description"=>"The audio codec id"}, {"in"=>"query", "name"=>"mediaInfo[audioDuration]", "description"=>"The audio duration"}, {"in"=>"query", "name"=>"mediaInfo[audioFormat]", "description"=>"The audio format"}, {"in"=>"query", "name"=>"mediaInfo[audioResolution]", "description"=>"The audio resolution"}, {"in"=>"query", "name"=>"mediaInfo[audioSamplingRate]", "description"=>"The audio sampling rate"}, {"in"=>"query", "name"=>"mediaInfo[complexityValue]"}, {"in"=>"query", "name"=>"mediaInfo[containerBitRate]", "description"=>"The container bit rate"}, {"in"=>"query", "name"=>"mediaInfo[containerDuration]", "description"=>"The container duration"}, {"in"=>"query", "name"=>"mediaInfo[containerFormat]", "description"=>"The container format"}, {"in"=>"query", "name"=>"mediaInfo[containerId]", "description"=>"The container id"}, {"in"=>"query", "name"=>"mediaInfo[containerProfile]", "description"=>"The container profile"}, {"in"=>"query", "name"=>"mediaInfo[contentStreams]"}, {"in"=>"query", "name"=>"mediaInfo[fileSize]", "description"=>"The file size"}, {"in"=>"query", "name"=>"mediaInfo[flavorAssetId]", "description"=>"The id of the related flavor asset"}, {"in"=>"query", "name"=>"mediaInfo[isFastStart]"}, {"in"=>"query", "name"=>"mediaInfo[maxGOP]"}, {"in"=>"query", "name"=>"mediaInfo[multiStreamInfo]"}, {"in"=>"query", "name"=>"mediaInfo[multiStream]"}, {"in"=>"query", "name"=>"mediaInfo[rawData]", "description"=>"The data as returned by the mediainfo command line"}, {"in"=>"query", "name"=>"mediaInfo[scanType]"}, {"in"=>"query", "name"=>"mediaInfo[videoBitRateMode]", "description"=>"Enum Type: `KalturaBitRateMode`The video bit rate mode"}, {"in"=>"query", "name"=>"mediaInfo[videoBitRate]", "description"=>"The video bit rate"}, {"in"=>"query", "name"=>"mediaInfo[videoCodecId]", "description"=>"The video codec id"}, {"in"=>"query", "name"=>"mediaInfo[videoDar]", "description"=>"The video display aspect ratio (dar)"}, {"in"=>"query", "name"=>"mediaInfo[videoDuration]", "description"=>"The video duration"}, {"in"=>"query", "name"=>"mediaInfo[videoFormat]", "description"=>"The video format"}, {"in"=>"query", "name"=>"mediaInfo[videoFrameRate]", "description"=>"The video frame rate"}, {"in"=>"query", "name"=>"mediaInfo[videoHeight]", "description"=>"The video height"}, {"in"=>"query", "name"=>"mediaInfo[videoRotation]"}, {"in"=>"query", "name"=>"mediaInfo[videoWidth]", "description"=>"The video width"}, {"in"=>"query", "name"=>"mediaInfo[writingLib]", "description"=>"The writing library"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "AddMediaInfo"]}}, "/service/batch/action/checkEntryIsDone"=>{"get"=>{"summary"=>"Get Service Batch Action Checkentryisdone", "description"=>"batch checkEntryIsDone Check weather a specified entry is done converting and changes it to ready.", "operationId"=>"batch.checkEntryIsDone", "x-api-path-slug"=>"servicebatchactioncheckentryisdone-get", "parameters"=>[{"in"=>"query", "name"=>"batchJobId", "description"=>"The entry to check"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "CheckEntryIsDone"]}}, "/service/batch/action/checkFileExists"=>{"get"=>{"summary"=>"Get Service Batch Action Checkfileexists", "description"=>"batch checkFileExists action check if the file exists", "operationId"=>"batch.checkFileExists", "x-api-path-slug"=>"servicebatchactioncheckfileexists-get", "parameters"=>[{"in"=>"query", "name"=>"localPath"}, {"in"=>"query", "name"=>"size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "CheckFileExists"]}}, "/service/batch/action/cleanExclusiveJobs"=>{"get"=>{"summary"=>"Get Service Batch Action Cleanexclusivejobs", "description"=>"batch cleanExclusiveJobs action mark as fatal error all expired jobs", "operationId"=>"batch.cleanExclusiveJobs", "x-api-path-slug"=>"servicebatchactioncleanexclusivejobs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "CleanExclusiveJobs"]}}, "/service/batch/action/countBulkUploadEntries"=>{"get"=>{"summary"=>"Get Service Batch Action Countbulkuploadentries", "description"=>"Returns total created entries count and total error entries count", "operationId"=>"batch.countBulkUploadEntries", "x-api-path-slug"=>"servicebatchactioncountbulkuploadentries-get", "parameters"=>[{"in"=>"query", "name"=>"bulkUploadJobId", "description"=>"The id of the bulk upload job"}, {"in"=>"query", "name"=>"bulkUploadObjectType", "description"=>"Enum Type: `KalturaBulkUploadObjectType`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "CountBulkUploadEntries"]}}, "/service/batch/action/freeExclusiveJob"=>{"get"=>{"summary"=>"Get Service Batch Action Freeexclusivejob", "description"=>"batch freeExclusiveJobAction action allows to get a generic BatchJob", "operationId"=>"batch.freeExclusiveJob", "x-api-path-slug"=>"servicebatchactionfreeexclusivejob-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id of the job"}, {"in"=>"query", "name"=>"jobType", "description"=>"Enum Type: `KalturaBatchJobType`The type of the job"}, {"in"=>"query", "name"=>"lockKey[batchIndex]"}, {"in"=>"query", "name"=>"lockKey[schedulerId]"}, {"in"=>"query", "name"=>"lockKey[workerId]"}, {"in"=>"query", "name"=>"resetExecutionAttempts", "description"=>"Resets the job execution attampts to zero"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "FreeExclusiveJob"]}}, "/service/batch/action/getBulkUploadLastResult"=>{"get"=>{"summary"=>"Get Service Batch Action Getbulkuploadlastresult", "description"=>"batch getBulkUploadLastResultAction action returns the last result of the bulk upload", "operationId"=>"batch.getBulkUploadLastResult", "x-api-path-slug"=>"servicebatchactiongetbulkuploadlastresult-get", "parameters"=>[{"in"=>"query", "name"=>"bulkUploadJobId", "description"=>"The id of the bulk upload job"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "GetBulkUploadLastResult"]}}, "/service/batch/action/getExclusiveAlmostDone"=>{"get"=>{"summary"=>"Get Service Batch Action Getexclusivealmostdone", "description"=>"batch getExclusiveAlmostDone action allows to get a BatchJob that wait for remote closure", "operationId"=>"batch.getExclusiveAlmostDone", "x-api-path-slug"=>"servicebatchactiongetexclusivealmostdone-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[batchVersionEqual]"}, {"in"=>"query", "name"=>"filter[batchVersionGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[batchVersionLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[entryIdEqual]"}, {"in"=>"query", "name"=>"filter[errNumberEqual]"}, {"in"=>"query", "name"=>"filter[errNumberIn]"}, {"in"=>"query", "name"=>"filter[errNumberNotIn]"}, {"in"=>"query", "name"=>"filter[errTypeEqual]", "description"=>"Enum Type: `KalturaBatchJobErrorTypes`"}, {"in"=>"query", "name"=>"filter[errTypeIn]"}, {"in"=>"query", "name"=>"filter[errTypeNotIn]"}, {"in"=>"query", "name"=>"filter[estimatedEffortGreaterThan]"}, {"in"=>"query", "name"=>"filter[estimatedEffortLessThan]"}, {"in"=>"query", "name"=>"filter[executionAttemptsGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[executionAttemptsLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[finishTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[finishTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[jobSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[jobSubTypeIn]"}, {"in"=>"query", "name"=>"filter[jobSubTypeNotIn]"}, {"in"=>"query", "name"=>"filter[jobTypeAndSubTypeIn]"}, {"in"=>"query", "name"=>"filter[jobTypeEqual]", "description"=>"Enum Type: `KalturaBatchJobType`"}, {"in"=>"query", "name"=>"filter[jobTypeIn]"}, {"in"=>"query", "name"=>"filter[jobTypeNotIn]"}, {"in"=>"query", "name"=>"filter[lockVersionGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[lockVersionLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[partnerIdEqual]"}, {"in"=>"query", "name"=>"filter[partnerIdIn]"}, {"in"=>"query", "name"=>"filter[partnerIdNotIn]"}, {"in"=>"query", "name"=>"filter[priorityEqual]"}, {"in"=>"query", "name"=>"filter[priorityGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[priorityIn]"}, {"in"=>"query", "name"=>"filter[priorityLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[priorityNotIn]"}, {"in"=>"query", "name"=>"filter[queueTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[queueTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaBatchJobStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[statusNotIn]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[urgencyGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[urgencyLessThanOrEqual]"}, {"in"=>"query", "name"=>"jobType", "description"=>"Enum Type: `KalturaBatchJobType`The type of the job - could be a custom extended type"}, {"in"=>"query", "name"=>"lockKey[batchIndex]"}, {"in"=>"query", "name"=>"lockKey[schedulerId]"}, {"in"=>"query", "name"=>"lockKey[workerId]"}, {"in"=>"query", "name"=>"maxExecutionTime", "description"=>"The maximum time in seconds the job reguarly take"}, {"in"=>"query", "name"=>"numberOfJobs", "description"=>"The maximum number of jobs to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "GetExclusiveAlmostDone"]}}, "/service/batch/action/getExclusiveJobs"=>{"get"=>{"summary"=>"Get Service Batch Action Getexclusivejobs", "description"=>"batch getExclusiveJobsAction action allows to get a BatchJob", "operationId"=>"batch.getExclusiveJobs", "x-api-path-slug"=>"servicebatchactiongetexclusivejobs-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[batchVersionEqual]"}, {"in"=>"query", "name"=>"filter[batchVersionGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[batchVersionLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[entryIdEqual]"}, {"in"=>"query", "name"=>"filter[errNumberEqual]"}, {"in"=>"query", "name"=>"filter[errNumberIn]"}, {"in"=>"query", "name"=>"filter[errNumberNotIn]"}, {"in"=>"query", "name"=>"filter[errTypeEqual]", "description"=>"Enum Type: `KalturaBatchJobErrorTypes`"}, {"in"=>"query", "name"=>"filter[errTypeIn]"}, {"in"=>"query", "name"=>"filter[errTypeNotIn]"}, {"in"=>"query", "name"=>"filter[estimatedEffortGreaterThan]"}, {"in"=>"query", "name"=>"filter[estimatedEffortLessThan]"}, {"in"=>"query", "name"=>"filter[executionAttemptsGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[executionAttemptsLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[finishTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[finishTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[jobSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[jobSubTypeIn]"}, {"in"=>"query", "name"=>"filter[jobSubTypeNotIn]"}, {"in"=>"query", "name"=>"filter[jobTypeAndSubTypeIn]"}, {"in"=>"query", "name"=>"filter[jobTypeEqual]", "description"=>"Enum Type: `KalturaBatchJobType`"}, {"in"=>"query", "name"=>"filter[jobTypeIn]"}, {"in"=>"query", "name"=>"filter[jobTypeNotIn]"}, {"in"=>"query", "name"=>"filter[lockVersionGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[lockVersionLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[partnerIdEqual]"}, {"in"=>"query", "name"=>"filter[partnerIdIn]"}, {"in"=>"query", "name"=>"filter[partnerIdNotIn]"}, {"in"=>"query", "name"=>"filter[priorityEqual]"}, {"in"=>"query", "name"=>"filter[priorityGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[priorityIn]"}, {"in"=>"query", "name"=>"filter[priorityLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[priorityNotIn]"}, {"in"=>"query", "name"=>"filter[queueTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[queueTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaBatchJobStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[statusNotIn]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[urgencyGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[urgencyLessThanOrEqual]"}, {"in"=>"query", "name"=>"jobType", "description"=>"Enum Type: `KalturaBatchJobType`The type of the job - could be a custom extended type"}, {"in"=>"query", "name"=>"lockKey[batchIndex]"}, {"in"=>"query", "name"=>"lockKey[schedulerId]"}, {"in"=>"query", "name"=>"lockKey[workerId]"}, {"in"=>"query", "name"=>"maxExecutionTime", "description"=>"The maximum time in seconds the job reguarly take"}, {"in"=>"query", "name"=>"maxJobToPullForCache", "description"=>"The number of job to pull to cache"}, {"in"=>"query", "name"=>"numberOfJobs", "description"=>"The maximum number of jobs to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "GetExclusiveJobs"]}}, "/service/batch/action/getExclusiveNotificationJobs"=>{"get"=>{"summary"=>"Get Service Batch Action Getexclusivenotificationjobs", "description"=>"batch getExclusiveNotificationJob action allows to get a BatchJob of type NOTIFICATION", "operationId"=>"batch.getExclusiveNotificationJobs", "x-api-path-slug"=>"servicebatchactiongetexclusivenotificationjobs-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[batchVersionEqual]"}, {"in"=>"query", "name"=>"filter[batchVersionGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[batchVersionLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[entryIdEqual]"}, {"in"=>"query", "name"=>"filter[errNumberEqual]"}, {"in"=>"query", "name"=>"filter[errNumberIn]"}, {"in"=>"query", "name"=>"filter[errNumberNotIn]"}, {"in"=>"query", "name"=>"filter[errTypeEqual]", "description"=>"Enum Type: `KalturaBatchJobErrorTypes`"}, {"in"=>"query", "name"=>"filter[errTypeIn]"}, {"in"=>"query", "name"=>"filter[errTypeNotIn]"}, {"in"=>"query", "name"=>"filter[estimatedEffortGreaterThan]"}, {"in"=>"query", "name"=>"filter[estimatedEffortLessThan]"}, {"in"=>"query", "name"=>"filter[executionAttemptsGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[executionAttemptsLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[finishTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[finishTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[jobSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[jobSubTypeIn]"}, {"in"=>"query", "name"=>"filter[jobSubTypeNotIn]"}, {"in"=>"query", "name"=>"filter[jobTypeAndSubTypeIn]"}, {"in"=>"query", "name"=>"filter[jobTypeEqual]", "description"=>"Enum Type: `KalturaBatchJobType`"}, {"in"=>"query", "name"=>"filter[jobTypeIn]"}, {"in"=>"query", "name"=>"filter[jobTypeNotIn]"}, {"in"=>"query", "name"=>"filter[lockVersionGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[lockVersionLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[partnerIdEqual]"}, {"in"=>"query", "name"=>"filter[partnerIdIn]"}, {"in"=>"query", "name"=>"filter[partnerIdNotIn]"}, {"in"=>"query", "name"=>"filter[priorityEqual]"}, {"in"=>"query", "name"=>"filter[priorityGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[priorityIn]"}, {"in"=>"query", "name"=>"filter[priorityLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[priorityNotIn]"}, {"in"=>"query", "name"=>"filter[queueTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[queueTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaBatchJobStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[statusNotIn]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[urgencyGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[urgencyLessThanOrEqual]"}, {"in"=>"query", "name"=>"lockKey[batchIndex]"}, {"in"=>"query", "name"=>"lockKey[schedulerId]"}, {"in"=>"query", "name"=>"lockKey[workerId]"}, {"in"=>"query", "name"=>"maxExecutionTime", "description"=>"The maximum time in seconds the job reguarly take"}, {"in"=>"query", "name"=>"numberOfJobs", "description"=>"The maximum number of jobs to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "GetExclusiveNotificationJobs"]}}, "/service/batch/action/getQueueSize"=>{"get"=>{"summary"=>"Get Service Batch Action Getqueuesize", "description"=>"batch getQueueSize action get the queue size for job type", "operationId"=>"batch.getQueueSize", "x-api-path-slug"=>"servicebatchactiongetqueuesize-get", "parameters"=>[{"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][field]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][idIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][items]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][not]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][objectType]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][value]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][batchVersionEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][batchVersionGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][batchVersionLessThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][entryIdEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][errNumberEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][errNumberIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][errNumberNotIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][errTypeEqual]", "description"=>"Enum Type: `KalturaBatchJobErrorTypes`"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][errTypeIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][errTypeNotIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][estimatedEffortGreaterThan]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][estimatedEffortLessThan]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][executionAttemptsGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][executionAttemptsLessThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][finishTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][finishTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][idEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][idGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][jobSubTypeEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][jobSubTypeIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][jobSubTypeNotIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][jobTypeAndSubTypeIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][jobTypeEqual]", "description"=>"Enum Type: `KalturaBatchJobType`"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][jobTypeIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][jobTypeNotIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][lockVersionGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][lockVersionLessThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][objectType]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][orderBy]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][partnerIdEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][partnerIdIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][partnerIdNotIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][priorityEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][priorityGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][priorityIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][priorityLessThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][priorityNotIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][queueTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][queueTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][statusEqual]", "description"=>"Enum Type: `KalturaBatchJobStatus`"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][statusIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][statusNotIn]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][urgencyGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[filter][urgencyLessThanOrEqual]"}, {"in"=>"query", "name"=>"workerQueueFilter[jobType]", "description"=>"Enum Type: `KalturaBatchJobType`"}, {"in"=>"query", "name"=>"workerQueueFilter[schedulerId]"}, {"in"=>"query", "name"=>"workerQueueFilter[workerId]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "GetQueueSize"]}}, "/service/batch/action/logConversion"=>{"get"=>{"summary"=>"Get Service Batch Action Logconversion", "description"=>"Add the data to the flavor asset conversion log, creates it if doesn't exists", "operationId"=>"batch.logConversion", "x-api-path-slug"=>"servicebatchactionlogconversion-get", "parameters"=>[{"in"=>"query", "name"=>"data"}, {"in"=>"query", "name"=>"flavorAssetId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "LogConversion"]}}, "/service/batch/action/resetJobExecutionAttempts"=>{"get"=>{"summary"=>"Get Service Batch Action Resetjobexecutionattempts", "description"=>"batch resetJobExecutionAttempts action resets the execution attempts of the job", "operationId"=>"batch.resetJobExecutionAttempts", "x-api-path-slug"=>"servicebatchactionresetjobexecutionattempts-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id of the job"}, {"in"=>"query", "name"=>"jobType", "description"=>"Enum Type: `KalturaBatchJobType`The type of the job"}, {"in"=>"query", "name"=>"lockKey[batchIndex]"}, {"in"=>"query", "name"=>"lockKey[schedulerId]"}, {"in"=>"query", "name"=>"lockKey[workerId]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "ResetJobExecutionAttempts"]}}, "/service/batch/action/suspendJobs"=>{"get"=>{"summary"=>"Get Service Batch Action Suspendjobs", "description"=>"batch suspendJobs action suspends jobs from running.", "operationId"=>"batch.suspendJobs", "x-api-path-slug"=>"servicebatchactionsuspendjobs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "SuspendJobs"]}}, "/service/batch/action/updateBulkUploadResults"=>{"get"=>{"summary"=>"Get Service Batch Action Updatebulkuploadresults", "description"=>"batch updateBulkUploadResults action adds KalturaBulkUploadResult to the DB", "operationId"=>"batch.updateBulkUploadResults", "x-api-path-slug"=>"servicebatchactionupdatebulkuploadresults-get", "parameters"=>[{"in"=>"query", "name"=>"bulkUploadJobId", "description"=>"The id of the bulk upload job"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "UpdateBulkUploadResults"]}}, "/service/batch/action/updateExclusiveConvertCollectionJob"=>{"get"=>{"summary"=>"Get Service Batch Action Updateexclusiveconvertcollectionjob", "description"=>"batch updateExclusiveConvertCollectionJobAction action updates a BatchJob of type CONVERT_PROFILE that was claimed using the getExclusiveConvertJobs", "operationId"=>"batch.updateExclusiveConvertCollectionJob", "x-api-path-slug"=>"servicebatchactionupdateexclusiveconvertcollectionjob-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id of the job to free"}, {"in"=>"query", "name"=>"job[data][actualSrcFileSyncLocalPath]", "description"=>"The translated path as used by the scheduler"}, {"in"=>"query", "name"=>"job[data][addedPrivacyContexts]"}, {"in"=>"query", "name"=>"job[data][amfArray]", "description"=>"amf Array File Path"}, {"in"=>"query", "name"=>"job[data][assetId]"}, {"in"=>"query", "name"=>"job[data][authenticationMethod]", "description"=>"Enum Type: `KalturaHttpNotificationAuthenticationMethod`The HTTP authentication method to use"}, {"in"=>"query", "name"=>"job[data][backupEncoderIP]"}, {"in"=>"query", "name"=>"job[data][backupStreamID]"}, {"in"=>"query", "name"=>"job[data][bodyParams]"}, {"in"=>"query", "name"=>"job[data][cachedObjectType]", "description"=>"Class name"}, {"in"=>"query", "name"=>"job[data][calculateComplexity]"}, {"in"=>"query", "name"=>"job[data][campaignId]"}, {"in"=>"query", "name"=>"job[data][captionAssetId]"}, {"in"=>"query", "name"=>"job[data][categoryId]", "description"=>"category id"}, {"in"=>"query", "name"=>"job[data][changedCategoryId]"}, {"in"=>"query", "name"=>"job[data][columns]"}, {"in"=>"query", "name"=>"job[data][commandLinesStr]"}, {"in"=>"query", "name"=>"job[data][concatenatedDuration]", "description"=>"duration of the concated video"}, {"in"=>"query", "name"=>"job[data][connectTimeout]", "description"=>"The number of seconds to wait while trying to connect"}, {"in"=>"query", "name"=>"job[data][contentMatchPolicy]", "description"=>"Enum Type: `KalturaDropFolderContentFileHandlerMatchPolicy`"}, {"in"=>"query", "name"=>"job[data][contentMoid]", "description"=>"Unique Kontiki MOID for the content uploaded to Kontiki"}, {"in"=>"query", "name"=>"job[data][contentParameters]"}, {"in"=>"query", "name"=>"job[data][conversionProfileId]"}, {"in"=>"query", "name"=>"job[data][cpcode]"}, {"in"=>"query", "name"=>"job[data][createLink]"}, {"in"=>"query", "name"=>"job[data][createThumb]", "description"=>"Indicates if a thumbnail should be created"}, {"in"=>"query", "name"=>"job[data][customData]"}, {"in"=>"query", "name"=>"job[data][customHeaders]"}, {"in"=>"query", "name"=>"job[data][data]"}, {"in"=>"query", "name"=>"job[data][deletedPrivacyContexts]"}, {"in"=>"query", "name"=>"job[data][description]"}, {"in"=>"query", "name"=>"job[data][destCategoryFullIds]", "description"=>"Destination categories fallback ids"}, {"in"=>"query", "name"=>"job[data][destCategoryId]", "description"=>"Destination category id"}, {"in"=>"query", "name"=>"job[data][destDataFilePath]", "description"=>"The data output file"}, {"in"=>"query", "name"=>"job[data][destDirLocalPath]"}, {"in"=>"query", "name"=>"job[data][destDirRemoteUrl]"}, {"in"=>"query", "name"=>"job[data][destFileLocalPath]"}, {"in"=>"query", "name"=>"job[data][destFileName]"}, {"in"=>"query", "name"=>"job[data][destFilePath]", "description"=>"Output file"}, {"in"=>"query", "name"=>"job[data][destFileSyncLocalPath]"}, {"in"=>"query", "name"=>"job[data][destFileSyncRemoteUrl]"}, {"in"=>"query", "name"=>"job[data][destFileSyncStoredPath]"}, {"in"=>"query", "name"=>"job[data][destVersion]"}, {"in"=>"query", "name"=>"job[data][destXsdPath]"}, {"in"=>"query", "name"=>"job[data][detectGOP]"}, {"in"=>"query", "name"=>"job[data][distributionProfileId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][accountId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][adFreeApplicationGuid]", "description"=>"The GUID for the application in which to record metrics and enforce business rules obtained through your Unicorn representative"}, {"in"=>"query", "name"=>"job[data][distributionProfile][adServerPartnerId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowAdsenseForVideo]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowComments]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowDownload]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowEmbedding]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowInvideo]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowMidRollAds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowPostRollAds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowPreRollAds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowRatings]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowResponses]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowStreaming]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowSyndication]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][apiAuthorizeUrl]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][apiHostUrl]", "description"=>"The API host URL that the Upload User should have access to, Used for HTTP content submission"}, {"in"=>"query", "name"=>"job[data][distributionProfile][apikey]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][asperaHost]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][asperaLogin]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][asperaPass]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][asperaPrivateKey]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][asperaPublicKey]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][assetFilenameXslt]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][assumeSuccess]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][autoCreateFlavors]", "description"=>"Comma separated flavor params ids that should be auto converted"}, {"in"=>"query", "name"=>"job[data][distributionProfile][autoCreateThumb]", "description"=>"Comma separated thumbnail params ids that should be auto generated"}, {"in"=>"query", "name"=>"job[data][distributionProfile][backgroundImageStandard]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][backgroundImageWide]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][basePath]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][blockOutsideOwnership]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][bodyXslt]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][captionAutosync]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][categoryId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][certificateKey]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelCopyright]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelDescription]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelGenerator]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelGuid]", "description"=>"The Channel GUID assigned to this Publication Rule"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelImageHeight]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelImageLink]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelImageTitle]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelImageUrl]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelImageWidth]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelLanguage]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelLink]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelManagingEditor]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelRating]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelTitle]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][claimType]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][commercialPolicy]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][contactEmail]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][contactTelephone]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][contentOwner]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][copyright]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][cPlatformTvSeriesField]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][cPlatformTvSeries]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][csId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][cuePointsProvider]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][defaultCategory]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][deleteEnabled]", "description"=>"Enum Type: `KalturaDistributionProfileActionStatus`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][deleteReference]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][disableEpisodeNumberCustomValidation]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][disableMetadata]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][distributeCaptions]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][distributeCuePoints]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][distributeRemoteCaptionAssetContent]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][distributeRemoteFlavorAssetContent]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][distributeRemoteThumbAssetContent]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][domainGuid]", "description"=>"The GUID of the Customer Domain in the Unicorn system obtained by contacting your Unicorn representative"}, {"in"=>"query", "name"=>"job[data][distributionProfile][domainName]", "description"=>"The name of the Domain that the Upload User should have access to, Used for authentication"}, {"in"=>"query", "name"=>"job[data][distributionProfile][domain]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][downloadPriceCode]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][email]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][enableAdServer]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][entitlements]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][entitlement]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedAuthorName]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedCopyright]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedDescription]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedImageHeight]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedImageLink]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedImageTitle]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedImageUrl]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedImageWidth]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedLanguage]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedLastBuildDate]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedLink]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedSpecVersion]", "description"=>"Enum Type: `KalturaYouTubeDistributionFeedSpecVersion`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedSubtitle]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedTitle]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][fieldConfigArray]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][flavorAssetFilenameXslt]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][flvFlavorParamsId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ftpHost]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ftpLogin]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ftpPassword]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ftpPass]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ftpPath]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ftpUsername]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][genericProviderId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][geoBlockingMapping]", "description"=>"Enum Type: `KalturaDailymotionGeoBlockingMapping`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][googleClientId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][googleClientSecret]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][googleTokenData]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][hideViewCount]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][host]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ignoreSchedulingInFeed]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ingestUrl]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][instreamStandard]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][instreamTrueview]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ips]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][itemLink]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][itemMediaRating]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][itemsPerPage]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][itemType]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][itemXpathsToExtend]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][mapAccessControlProfileIds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][mapCaptionParamsIds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][mapConversionProfileIds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][mapFlavorParamsIds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][mapMetadataProfileIds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][mapStorageProfileIds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][mapThumbParamsIds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][metadataFilenameXslt]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][metadataProfileId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][metadataXpathsTriggerUpdate]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][metadataXslt]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][msnvideoCat]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][msnvideoTopCat]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][msnvideoTop]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][name]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][notificationEmail]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][objectType]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][optionalAssetDistributionRules]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][optionalFlavorParamsIds]", "description"=>"Comma separated flavor params ids that should be submitted if ready"}, {"in"=>"query", "name"=>"job[data][distributionProfile][optionalThumbDimensions]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][overrideManualEdits]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ownerName]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][pageAccessToken]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][pageGroup]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][pageId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][passphrase]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][password]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][permissions]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][port]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][priority]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][privacyStatus]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][processFeed]", "description"=>"Enum Type: `KalturaYahooDistributionProcessFeedActionStatus`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][protocol]", "description"=>"`insertOnly`Enum Type: `KalturaDistributionProtocol`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][providerId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][providerName]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][providerType]", "description"=>"`insertOnly`Enum Type: `KalturaDistributionProviderType`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][rating]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][recommendedDcForDownload]", "description"=>"The best Kaltura data center to be used to download the asset files to"}, {"in"=>"query", "name"=>"job[data][distributionProfile][recommendedDcForExecute]", "description"=>"The best Kaltura data center to be used to execute the distribution job"}, {"in"=>"query", "name"=>"job[data][distributionProfile][recommendedStorageProfileForDownload]", "description"=>"The best external storage to be used to download the asset files from"}, {"in"=>"query", "name"=>"job[data][distributionProfile][releaseClaims]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][remoteAssetParamsId]", "description"=>"The flavor-params that will be used for the remote asset"}, {"in"=>"query", "name"=>"job[data][distributionProfile][replaceAirDates]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][replaceGroup]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][reportEnabled]", "description"=>"Enum Type: `KalturaDistributionProfileActionStatus`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][requiredAssetDistributionRules]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][requiredFlavorParamsIds]", "description"=>"Comma separated flavor params ids that required to be ready before submission"}, {"in"=>"query", "name"=>"job[data][distributionProfile][requiredThumbDimensions]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][reRequestPermissions]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][seasonNumber]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][seasonSynopsis]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][seasonTuneInInformation]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sendMetadataAfterAssets]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][seriesAdditionalCategories]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][seriesChannel]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][seriesPrimaryCategory]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sftpBaseDir]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sftpBasePath]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sftpHost]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sftpLogin]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sftpPass]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sftpPort]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sftpPrivateKey]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sftpPublicKey]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][shouldAddThumbExtension]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][shouldIncludeCaptions]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][shouldIncludeCuePoints]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][slFlavorParamsId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][slHdFlavorParamsId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sourceFlavorParamsId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sourceFriendlyName]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][source]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][state]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][status]", "description"=>"Enum Type: `KalturaDistributionProfileStatus`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][storageProfileId]", "description"=>"The remote storage that should be used for the remote asset"}, {"in"=>"query", "name"=>"job[data][distributionProfile][streamingPriceCode]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][strict]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitAction][ftpPassiveMode]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitAction][httpFieldName]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitAction][httpFileName]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitAction][password]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitAction][protocol]", "description"=>"Enum Type: `KalturaDistributionProtocol`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitAction][serverPath]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitAction][serverUrl]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitAction][username]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitEnabled]", "description"=>"Enum Type: `KalturaDistributionProfileActionStatus`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sunriseDefaultOffset]", "description"=>"If entry distribution sunrise not specified that will be the default since entry creation time, in seconds"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sunsetDefaultOffset]", "description"=>"If entry distribution sunset not specified that will be the default since entry creation time, in seconds"}, {"in"=>"query", "name"=>"job[data][distributionProfile][tags]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][targetAccountId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][targetLoginId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][targetLoginPassword]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][targetServiceUrl]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][target]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][thumbnailAssetFilenameXslt]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ugcPolicy]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][updateEnabled]", "description"=>"Enum Type: `KalturaDistributionProfileActionStatus`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][upstreamNetworkId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][upstreamNetworkName]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][upstreamVideoId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][urgentReference]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][useCategoryEntries]", "description"=>"When checking custom XSLT conditions using the fieldConfigArray - address only categories associated with the entry via the categoryEntry object"}, {"in"=>"query", "name"=>"job[data][distributionProfile][userAccessToken]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][username]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][user]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][videoMediaType]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][wmvFlavorParamsId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][xsltFile]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][xsl]"}, {"in"=>"query", "name"=>"job[data][domainName]"}, {"in"=>"query", "name"=>"job[data][dropFolderFileIds]"}, {"in"=>"query", "name"=>"job[data][dropFolderFileId]"}, {"in"=>"query", "name"=>"job[data][dropFolderId]"}, {"in"=>"query", "name"=>"job[data][duration]", "description"=>"Clipping duration in seconds"}, {"in"=>"query", "name"=>"job[data][dvrEnabled]", "description"=>"Enum Type: `KalturaDVRStatus`"}, {"in"=>"query", "name"=>"job[data][dvrWindow]"}, {"in"=>"query", "name"=>"job[data][emailId]"}, {"in"=>"query", "name"=>"job[data][encoderIP]"}, {"in"=>"query", "name"=>"job[data][encoderPassword]"}, {"in"=>"query", "name"=>"job[data][encoderUsername]"}, {"in"=>"query", "name"=>"job[data][endDate]"}, {"in"=>"query", "name"=>"job[data][endObjectKey]"}, {"in"=>"query", "name"=>"job[data][endPoint]"}, {"in"=>"query", "name"=>"job[data][endTime]", "description"=>"Duration of the live entry including all recorded segments including the current"}, {"in"=>"query", "name"=>"job[data][engineMessage]"}, {"in"=>"query", "name"=>"job[data][engineVersion]"}, {"in"=>"query", "name"=>"job[data][entryIds]", "description"=>"Comma separated list of entry ids"}, {"in"=>"query", "name"=>"job[data][entryId]", "description"=>"Live stream entry id"}, {"in"=>"query", "name"=>"job[data][eventsType]", "description"=>"Enum Type: `KalturaScheduleEventType`The type of the events that ill be created by this upload"}, {"in"=>"query", "name"=>"job[data][extractId3Tags]"}, {"in"=>"query", "name"=>"job[data][extraDestFileSyncs]"}, {"in"=>"query", "name"=>"job[data][fileIndex]", "description"=>"The index of the file within the entry"}, {"in"=>"query", "name"=>"job[data][fileLocation]"}, {"in"=>"query", "name"=>"job[data][fileName]", "description"=>"Friendly name of the file, used to be recognized later in the logs"}, {"in"=>"query", "name"=>"job[data][fileSize]"}, {"in"=>"query", "name"=>"job[data][filesPermissionInS3]", "description"=>"Enum Type: `KalturaAmazonS3StorageProfileFilesPermissionLevel`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][field]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][idIn]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][items]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][not]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][objectType]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][value]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"job[data][filter][orderBy]"}, {"in"=>"query", "name"=>"job[data][flavorAssetId]", "description"=>"Flavor asset to be ingested with the output"}, {"in"=>"query", "name"=>"job[data][flavorParamsId]", "description"=>"Flavor params id to use for conversion"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutputId]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][anamorphicPixels]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][aspectRatioProcessingMode]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][audioBitrate]", "description"=>"The audio bitrate (in KBits) of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][audioChannels]", "description"=>"The number of audio channels for downmixing"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][audioCodec]", "description"=>"Enum Type: `KalturaAudioCodec`The audio codec of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][audioSampleRate]", "description"=>"The audio sample rate of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][clipDuration]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][clipOffset]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][commandLinesStr]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][contentAwareness]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][conversionEnginesExtraParams]", "description"=>"The list of conversion engines extra params (separated with |)"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][conversionEngines]", "description"=>"The list of conversion engines (comma separated)"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][deinterlice]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][densityHeight]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][densityWidth]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][depth]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][description]", "description"=>"The description of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][engineVersion]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][flashVersion]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][flavorAssetId]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][flavorAssetVersion]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][flavorParamsId]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][flavorParamsVersion]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][forcedKeyFramesMode]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][forceFrameToMultiplication16]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][format]", "description"=>"Enum Type: `KalturaContainerFormat`The container format of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][frameRate]", "description"=>"The frame rate of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][gopSize]", "description"=>"The gop size of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][height]", "description"=>"The desired height of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][isAvoidForcedKeyFrames]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][isAvoidVideoShrinkBitrateToSource]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][isAvoidVideoShrinkFramesizeToSource]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][isCropIMX]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][isEncrypted]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][isGopInSec]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][isVideoFrameRateForLowBrAppleHls]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][maxFrameRate]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][mediaParserType]", "description"=>"Enum Type: `KalturaMediaParserType`Media parser type to be used for post-conversion validation"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][multiStream]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][name]", "description"=>"The name of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][objectType]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][operators]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][optimizationPolicy]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][partnerId]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][poly2Bitmap]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][readonly]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][readyBehavior]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][remoteStorageProfileIds]", "description"=>"Comma seperated ids of remote storage profiles that the flavor distributed to, the distribution done by the conversion engine"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][requiredPermissions]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][rotate]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][sizeHeight]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][sizeWidth]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][sourceAssetParamsIds]", "description"=>"Comma seperated ids of source flavor params this flavor is created from"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][sourceRemoteStorageProfileId]", "description"=>"Id of remote storage profile that used to get the source, zero indicates Kaltura data center"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][subtitlesData]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][systemName]", "description"=>"System name of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][tags]", "description"=>"The Flavor Params tags are used to identify the flavor for different usage (e"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][twoPass]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][videoBitrateTolerance]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][videoBitrate]", "description"=>"The video bitrate (in KBits) of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][videoCodec]", "description"=>"Enum Type: `KalturaVideoCodec`The video codec of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][videoConstantBitrate]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][watermarkData]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][widevineDistributionEndDate]", "description"=>"License distribution window end date"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][widevineDistributionStartDate]", "description"=>"License distribution window start date"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][width]", "description"=>"The desired width of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavors]"}, {"in"=>"query", "name"=>"job[data][force]"}, {"in"=>"query", "name"=>"job[data][fromEmail]"}, {"in"=>"query", "name"=>"job[data][fromName]"}, {"in"=>"query", "name"=>"job[data][fromPartnerId]", "description"=>"Id of the partner to copy from"}, {"in"=>"query", "name"=>"job[data][ftpPassiveMode]"}, {"in"=>"query", "name"=>"job[data][inputFileSyncLocalPath]"}, {"in"=>"query", "name"=>"job[data][inputXmlLocalPath]"}, {"in"=>"query", "name"=>"job[data][inputXmlRemoteUrl]"}, {"in"=>"query", "name"=>"job[data][isHtml]"}, {"in"=>"query", "name"=>"job[data][keepDistributionItem]", "description"=>"Flag signifying that the associated distribution item should not be moved to removed status"}, {"in"=>"query", "name"=>"job[data][ksType]", "description"=>"Enum Type: `KalturaSessionType`"}, {"in"=>"query", "name"=>"job[data][language]", "description"=>"Enum Type: `KalturaLanguageCode`"}, {"in"=>"query", "name"=>"job[data][lastCuePointSyncTime]", "description"=>"last live to vod sync time"}, {"in"=>"query", "name"=>"job[data][lastMovedCategoryEntryPageIndex]", "description"=>"Saves the last page index of the category entries filter pager In case of crash the batch will restart from that point"}, {"in"=>"query", "name"=>"job[data][lastMovedCategoryId]", "description"=>"Saves the last category id that its entries moved completely In case of crash the batch will restart from that point"}, {"in"=>"query", "name"=>"job[data][lastMovedCategoryPageIndex]", "description"=>"Saves the last page index of the child categories filter pager In case of crash the batch will restart from that point"}, {"in"=>"query", "name"=>"job[data][lastSegmentDrift]", "description"=>"last segment drift"}, {"in"=>"query", "name"=>"job[data][lastSegmentDuration]", "description"=>"last Segment Duration"}, {"in"=>"query", "name"=>"job[data][lastUpdatedCategoryCreatedAt]", "description"=>"Saves the last sub category creation date that was updated In case of crash the batch will restart from that point"}, {"in"=>"query", "name"=>"job[data][lastUpdatedCategoryEntryCreatedAt]", "description"=>"Saves the last category entry creation date that was updated In case of crash the batch will restart from that point"}, {"in"=>"query", "name"=>"job[data][liveEntryId]", "description"=>"live Entry Id"}, {"in"=>"query", "name"=>"job[data][localFileSyncPath]"}, {"in"=>"query", "name"=>"job[data][logFileSyncLocalPath]"}, {"in"=>"query", "name"=>"job[data][logFileSyncRemoteUrl]"}, {"in"=>"query", "name"=>"job[data][mailPriority]"}, {"in"=>"query", "name"=>"job[data][mailType]", "description"=>"Enum Type: `KalturaMailType`"}, {"in"=>"query", "name"=>"job[data][maxResults]"}, {"in"=>"query", "name"=>"job[data][mediaServerIndex]", "description"=>"Enum Type: `KalturaEntryServerNodeType`Primary or secondary media server"}, {"in"=>"query", "name"=>"job[data][mediaType]"}, {"in"=>"query", "name"=>"job[data][metadataId]"}, {"in"=>"query", "name"=>"job[data][metadataProfileId]"}, {"in"=>"query", "name"=>"job[data][method]", "description"=>"Enum Type: `KalturaHttpNotificationMethod`Request method"}, {"in"=>"query", "name"=>"job[data][minSendDate]"}, {"in"=>"query", "name"=>"job[data][modifiedAttributes]"}, {"in"=>"query", "name"=>"job[data][monitorSyncCompletion]"}, {"in"=>"query", "name"=>"job[data][moveFromChildren]", "description"=>"All entries from all child categories will be moved as well"}, {"in"=>"query", "name"=>"job[data][multiLanaguageCaptionAssetId]"}, {"in"=>"query", "name"=>"job[data][notificationEmail]"}, {"in"=>"query", "name"=>"job[data][notificationResult]"}, {"in"=>"query", "name"=>"job[data][numberOfAttempts]"}, {"in"=>"query", "name"=>"job[data][objectData][conversionProfileId]", "description"=>"Selected profile id for all bulk entries"}, {"in"=>"query", "name"=>"job[data][objectData][objectType]"}, {"in"=>"query", "name"=>"job[data][objectId]"}, {"in"=>"query", "name"=>"job[data][objectType]"}, {"in"=>"query", "name"=>"job[data][objType]", "description"=>"Enum Type: `KalturaNotificationObjectType`"}, {"in"=>"query", "name"=>"job[data][offset]", "description"=>"Clipping offset in seconds"}, {"in"=>"query", "name"=>"job[data][outputPath]"}, {"in"=>"query", "name"=>"job[data][parsedSlug]"}, {"in"=>"query", "name"=>"job[data][parsedUserId]"}, {"in"=>"query", "name"=>"job[data][passPhrase]"}, {"in"=>"query", "name"=>"job[data][password]", "description"=>"A password to use for the connection"}, {"in"=>"query", "name"=>"job[data][plays]"}, {"in"=>"query", "name"=>"job[data][primaryBroadcastingUrl]"}, {"in"=>"query", "name"=>"job[data][primaryContact]"}, {"in"=>"query", "name"=>"job[data][privateKey]"}, {"in"=>"query", "name"=>"job[data][protocol]", "description"=>"http / https"}, {"in"=>"query", "name"=>"job[data][providerData][additionalParameters]", "description"=>"additional parameters to send to Cielo24"}, {"in"=>"query", "name"=>"job[data][providerData][captionAssetFormats]", "description"=>"Caption formats"}, {"in"=>"query", "name"=>"job[data][providerData][entryId]", "description"=>"Entry ID"}, {"in"=>"query", "name"=>"job[data][providerData][exampleUrl]", "description"=>"Just an example"}, {"in"=>"query", "name"=>"job[data][providerData][fidelity]", "description"=>"Enum Type: `KalturaCielo24Fidelity`"}, {"in"=>"query", "name"=>"job[data][providerData][flavorAssetId]", "description"=>"Flavor ID"}, {"in"=>"query", "name"=>"job[data][providerData][metadataProfileId]", "description"=>"ID of the metadata profile for the extracted term metadata"}, {"in"=>"query", "name"=>"job[data][providerData][objectType]"}, {"in"=>"query", "name"=>"job[data][providerData][priority]", "description"=>"Enum Type: `KalturaCielo24Priority`"}, {"in"=>"query", "name"=>"job[data][providerData][replaceMediaContent]", "description"=>"should replace remote media content"}, {"in"=>"query", "name"=>"job[data][providerData][spokenLanguage]", "description"=>"Enum Type: `KalturaLanguage`Transcript content language"}, {"in"=>"query", "name"=>"job[data][providerData][transcriptAssetId]", "description"=>"ID of the transcript asset"}, {"in"=>"query", "name"=>"job[data][providerData][transcriptId]", "description"=>"input Transcript-asset ID"}, {"in"=>"query", "name"=>"job[data][providerData][voicebaseApiKey]", "description"=>"Voicebase API key to fetch transcript tokens"}, {"in"=>"query", "name"=>"job[data][providerData][voicebaseApiPassword]", "description"=>"Voicebase API password to fetch transcript tokens"}, {"in"=>"query", "name"=>"job[data][providerType]", "description"=>"Enum Type: `KalturaIntegrationProviderType`"}, {"in"=>"query", "name"=>"job[data][provisioningParams]"}, {"in"=>"query", "name"=>"job[data][publicKey]"}, {"in"=>"query", "name"=>"job[data][puserId]", "description"=>"The id of the requesting user"}, {"in"=>"query", "name"=>"job[data][recipientEmail]"}, {"in"=>"query", "name"=>"job[data][recipientId]", "description"=>"kuserId"}, {"in"=>"query", "name"=>"job[data][recipientName]"}, {"in"=>"query", "name"=>"job[data][referenceTime]"}, {"in"=>"query", "name"=>"job[data][remoteMediaId]"}, {"in"=>"query", "name"=>"job[data][resultsFilePath]"}, {"in"=>"query", "name"=>"job[data][returnVal]"}, {"in"=>"query", "name"=>"job[data][rtmp]"}, {"in"=>"query", "name"=>"job[data][s3Region]"}, {"in"=>"query", "name"=>"job[data][scanResult]", "description"=>"Enum Type: `KalturaVirusScanJobResult`"}, {"in"=>"query", "name"=>"job[data][secondaryBroadcastingUrl]"}, {"in"=>"query", "name"=>"job[data][secondaryContact]"}, {"in"=>"query", "name"=>"job[data][separator]"}, {"in"=>"query", "name"=>"job[data][serverPassPhrase]"}, {"in"=>"query", "name"=>"job[data][serverPassword]"}, {"in"=>"query", "name"=>"job[data][serverPrivateKey]"}, {"in"=>"query", "name"=>"job[data][serverPublicKey]"}, {"in"=>"query", "name"=>"job[data][serverUrl]"}, {"in"=>"query", "name"=>"job[data][serverUsername]"}, {"in"=>"query", "name"=>"job[data][server][dc]", "description"=>"The dc of the server"}, {"in"=>"query", "name"=>"job[data][server][description]"}, {"in"=>"query", "name"=>"job[data][server][host]"}, {"in"=>"query", "name"=>"job[data][server][name]"}, {"in"=>"query", "name"=>"job[data][server][objectType]"}, {"in"=>"query", "name"=>"job[data][server][password]"}, {"in"=>"query", "name"=>"job[data][server][port]"}, {"in"=>"query", "name"=>"job[data][server][protocol]", "description"=>"Enum Type: `KalturaActivitiBusinessProcessServerProtocol`"}, {"in"=>"query", "name"=>"job[data][server][systemName]"}, {"in"=>"query", "name"=>"job[data][server][username]"}, {"in"=>"query", "name"=>"job[data][serviceToken]"}, {"in"=>"query", "name"=>"job[data][signatureType]"}, {"in"=>"query", "name"=>"job[data][signSecret]", "description"=>"The secret to sign the notification with"}, {"in"=>"query", "name"=>"job[data][srcAssetId]"}, {"in"=>"query", "name"=>"job[data][srcAssetType]", "description"=>"Enum Type: `KalturaAssetType`"}, {"in"=>"query", "name"=>"job[data][srcCategoryId]", "description"=>"Source category id"}, {"in"=>"query", "name"=>"job[data][srcFilePath]", "description"=>"The recorded live media"}, {"in"=>"query", "name"=>"job[data][srcFileSyncId]"}, {"in"=>"query", "name"=>"job[data][srcFileSyncLocalPath]"}, {"in"=>"query", "name"=>"job[data][srcFileSyncRemoteUrl]"}, {"in"=>"query", "name"=>"job[data][srcFileSyncs]"}, {"in"=>"query", "name"=>"job[data][srcFiles]"}, {"in"=>"query", "name"=>"job[data][srcFileUrl]"}, {"in"=>"query", "name"=>"job[data][srcVersion]"}, {"in"=>"query", "name"=>"job[data][srcXslPath]"}, {"in"=>"query", "name"=>"job[data][sseKmsKeyId]"}, {"in"=>"query", "name"=>"job[data][sseType]"}, {"in"=>"query", "name"=>"job[data][sslCertificatePassword]", "description"=>"The password required to use the certificate"}, {"in"=>"query", "name"=>"job[data][sslCertificateType]", "description"=>"Enum Type: `KalturaHttpNotificationCertificateType`The format of the certificate"}, {"in"=>"query", "name"=>"job[data][sslCertificate]", "description"=>"SSL certificate to verify the peer with"}, {"in"=>"query", "name"=>"job[data][sslEngineDefault]", "description"=>"The identifier for the crypto engine used for asymmetric crypto operations"}, {"in"=>"query", "name"=>"job[data][sslEngine]", "description"=>"The identifier for the crypto engine of the private SSL key specified in ssl key"}, {"in"=>"query", "name"=>"job[data][sslKeyPassword]", "description"=>"The secret password needed to use the private SSL key specified in ssl key"}, {"in"=>"query", "name"=>"job[data][sslKeyType]", "description"=>"Enum Type: `KalturaHttpNotificationSslKeyType`The key type of the private SSL key specified in ssl key - PEM / DER / ENG"}, {"in"=>"query", "name"=>"job[data][sslKey]", "description"=>"Private SSL key"}, {"in"=>"query", "name"=>"job[data][sslVersion]", "description"=>"Enum Type: `KalturaHttpNotificationSslVersion`The SSL version (2 or 3) to use"}, {"in"=>"query", "name"=>"job[data][startObjectKey]"}, {"in"=>"query", "name"=>"job[data][status]", "description"=>"Enum Type: `KalturaMailJobStatus`"}, {"in"=>"query", "name"=>"job[data][streamID]"}, {"in"=>"query", "name"=>"job[data][streamName]"}, {"in"=>"query", "name"=>"job[data][streamType]", "description"=>"Enum Type: `KalturaAkamaiUniversalStreamType`"}, {"in"=>"query", "name"=>"job[data][subjectParams]"}, {"in"=>"query", "name"=>"job[data][syncMode]", "description"=>"Enum Type: `KalturaWidevineRepositorySyncMode`"}, {"in"=>"query", "name"=>"job[data][systemPassword]"}, {"in"=>"query", "name"=>"job[data][systemUserName]"}, {"in"=>"query", "name"=>"job[data][templateId]"}, {"in"=>"query", "name"=>"job[data][templatePath]"}, {"in"=>"query", "name"=>"job[data][thumbAssetId]"}, {"in"=>"query", "name"=>"job[data][thumbBitrate]", "description"=>"The bit rate of last created thumbnail, will be used to comapare if this thumbnail is the best we can have"}, {"in"=>"query", "name"=>"job[data][thumbHeight]", "description"=>"The height of last created thumbnail, will be used to comapare if this thumbnail is the best we can have"}, {"in"=>"query", "name"=>"job[data][thumbOffset]", "description"=>"The position of the thumbnail in the media file"}, {"in"=>"query", "name"=>"job[data][thumbParamsOutputId]"}, {"in"=>"query", "name"=>"job[data][thumbPath]"}, {"in"=>"query", "name"=>"job[data][timeout]", "description"=>"The maximum number of seconds to allow cURL functions to execute"}, {"in"=>"query", "name"=>"job[data][timeReference]"}, {"in"=>"query", "name"=>"job[data][timeZoneOffset]"}, {"in"=>"query", "name"=>"job[data][toPartnerId]", "description"=>"Id of the partner to copy to"}, {"in"=>"query", "name"=>"job[data][totalVodDuration]", "description"=>"total VOD Duration"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][categoryDirectMembers]", "description"=>"Return the list of categoryUser that are not inherited from parent category - only the direct categoryUsers"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][categoryFullIdsEqual]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][categoryFullIdsStartsWith]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][categoryIdEqual]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][categoryIdIn]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][freeText]", "description"=>"Free text search on user id or screen name"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][orderBy]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][permissionLevelEqual]", "description"=>"Enum Type: `KalturaCategoryUserPermissionLevel`"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][permissionLevelIn]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][permissionNamesMatchAnd]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][permissionNamesMatchOr]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][permissionNamesNotContains]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][relatedGroupsByUserId]", "description"=>"Return a list of categoryUser that related to the userId in this field by groups"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][statusEqual]", "description"=>"Enum Type: `KalturaCategoryUserStatus`"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][statusIn]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][updateMethodEqual]", "description"=>"Enum Type: `KalturaUpdateMethodType`"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][updateMethodIn]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][userIdEqual]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][userIdIn]"}, {"in"=>"query", "name"=>"job[data][to][emailRecipients]"}, {"in"=>"query", "name"=>"job[data][to][filter][createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"job[data][to][filter][createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"job[data][to][filter][emailLike]"}, {"in"=>"query", "name"=>"job[data][to][filter][emailStartsWith]"}, {"in"=>"query", "name"=>"job[data][to][filter][firstNameOrLastNameStartsWith]"}, {"in"=>"query", "name"=>"job[data][to][filter][firstNameStartsWith]"}, {"in"=>"query", "name"=>"job[data][to][filter][idEqual]"}, {"in"=>"query", "name"=>"job[data][to][filter][idIn]"}, {"in"=>"query", "name"=>"job[data][to][filter][idOrScreenNameStartsWith]"}, {"in"=>"query", "name"=>"job[data][to][filter][isAdminEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"job[data][to][filter][lastNameStartsWith]"}, {"in"=>"query", "name"=>"job[data][to][filter][loginEnabledEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"job[data][to][filter][objectType]"}, {"in"=>"query", "name"=>"job[data][to][filter][orderBy]"}, {"in"=>"query", "name"=>"job[data][to][filter][partnerIdEqual]"}, {"in"=>"query", "name"=>"job[data][to][filter][permissionNamesMultiLikeAnd]", "description"=>"Permission names filter expression"}, {"in"=>"query", "name"=>"job[data][to][filter][permissionNamesMultiLikeOr]", "description"=>"Permission names filter expression"}, {"in"=>"query", "name"=>"job[data][to][filter][roleIdEqual]"}, {"in"=>"query", "name"=>"job[data][to][filter][roleIdsEqual]"}, {"in"=>"query", "name"=>"job[data][to][filter][roleIdsIn]"}, {"in"=>"query", "name"=>"job[data][to][filter][screenNameLike]"}, {"in"=>"query", "name"=>"job[data][to][filter][screenNameStartsWith]"}, {"in"=>"query", "name"=>"job[data][to][filter][statusEqual]", "description"=>"Enum Type: `KalturaUserStatus`"}, {"in"=>"query", "name"=>"job[data][to][filter][statusIn]"}, {"in"=>"query", "name"=>"job[data][to][filter][tagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"job[data][to][filter][tagsMultiLikeOr]"}, {"in"=>"query", "name"=>"job[data][to][filter][typeEqual]", "description"=>"Enum Type: `KalturaUserType`"}, {"in"=>"query", "name"=>"job[data][to][filter][typeIn]"}, {"in"=>"query", "name"=>"job[data][to][objectType]"}, {"in"=>"query", "name"=>"job[data][typeAsString]"}, {"in"=>"query", "name"=>"job[data][type]", "description"=>"Enum Type: `KalturaNotificationType`"}, {"in"=>"query", "name"=>"job[data][url]", "description"=>"Remote server URL"}, {"in"=>"query", "name"=>"job[data][userId]"}, {"in"=>"query", "name"=>"job[data][username]", "description"=>"A username to use for the connection"}, {"in"=>"query", "name"=>"job[data][userRoles]"}, {"in"=>"query", "name"=>"job[data][views]"}, {"in"=>"query", "name"=>"job[data][virusFoundAction]", "description"=>"Enum Type: `KalturaVirusFoundAction`"}, {"in"=>"query", "name"=>"job[data][vodEntryId]", "description"=>"$vod Entry Id"}, {"in"=>"query", "name"=>"job[data][webexHostId]"}, {"in"=>"query", "name"=>"job[data][wsdlPassword]"}, {"in"=>"query", "name"=>"job[data][wsdlUsername]"}, {"in"=>"query", "name"=>"job[data][wvAssetIds]"}, {"in"=>"query", "name"=>"job[entryId]"}, {"in"=>"query", "name"=>"job[entryName]"}, {"in"=>"query", "name"=>"job[jobSubType]"}, {"in"=>"query", "name"=>"lockKey[batchIndex]"}, {"in"=>"query", "name"=>"lockKey[schedulerId]"}, {"in"=>"query", "name"=>"lockKey[workerId]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "UpdateExclusiveConvertCollectionJob"]}}, "/service/batch/action/updateExclusiveJob"=>{"get"=>{"summary"=>"Get Service Batch Action Updateexclusivejob", "description"=>"batch updateExclusiveJobAction action updates a BatchJob of extended type that was claimed using the getExclusiveJobs", "operationId"=>"batch.updateExclusiveJob", "x-api-path-slug"=>"servicebatchactionupdateexclusivejob-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The id of the job to free"}, {"in"=>"query", "name"=>"job[data][actualSrcFileSyncLocalPath]", "description"=>"The translated path as used by the scheduler"}, {"in"=>"query", "name"=>"job[data][addedPrivacyContexts]"}, {"in"=>"query", "name"=>"job[data][amfArray]", "description"=>"amf Array File Path"}, {"in"=>"query", "name"=>"job[data][assetId]"}, {"in"=>"query", "name"=>"job[data][authenticationMethod]", "description"=>"Enum Type: `KalturaHttpNotificationAuthenticationMethod`The HTTP authentication method to use"}, {"in"=>"query", "name"=>"job[data][backupEncoderIP]"}, {"in"=>"query", "name"=>"job[data][backupStreamID]"}, {"in"=>"query", "name"=>"job[data][bodyParams]"}, {"in"=>"query", "name"=>"job[data][cachedObjectType]", "description"=>"Class name"}, {"in"=>"query", "name"=>"job[data][calculateComplexity]"}, {"in"=>"query", "name"=>"job[data][campaignId]"}, {"in"=>"query", "name"=>"job[data][captionAssetId]"}, {"in"=>"query", "name"=>"job[data][categoryId]", "description"=>"category id"}, {"in"=>"query", "name"=>"job[data][changedCategoryId]"}, {"in"=>"query", "name"=>"job[data][columns]"}, {"in"=>"query", "name"=>"job[data][commandLinesStr]"}, {"in"=>"query", "name"=>"job[data][concatenatedDuration]", "description"=>"duration of the concated video"}, {"in"=>"query", "name"=>"job[data][connectTimeout]", "description"=>"The number of seconds to wait while trying to connect"}, {"in"=>"query", "name"=>"job[data][contentMatchPolicy]", "description"=>"Enum Type: `KalturaDropFolderContentFileHandlerMatchPolicy`"}, {"in"=>"query", "name"=>"job[data][contentMoid]", "description"=>"Unique Kontiki MOID for the content uploaded to Kontiki"}, {"in"=>"query", "name"=>"job[data][contentParameters]"}, {"in"=>"query", "name"=>"job[data][conversionProfileId]"}, {"in"=>"query", "name"=>"job[data][cpcode]"}, {"in"=>"query", "name"=>"job[data][createLink]"}, {"in"=>"query", "name"=>"job[data][createThumb]", "description"=>"Indicates if a thumbnail should be created"}, {"in"=>"query", "name"=>"job[data][customData]"}, {"in"=>"query", "name"=>"job[data][customHeaders]"}, {"in"=>"query", "name"=>"job[data][data]"}, {"in"=>"query", "name"=>"job[data][deletedPrivacyContexts]"}, {"in"=>"query", "name"=>"job[data][description]"}, {"in"=>"query", "name"=>"job[data][destCategoryFullIds]", "description"=>"Destination categories fallback ids"}, {"in"=>"query", "name"=>"job[data][destCategoryId]", "description"=>"Destination category id"}, {"in"=>"query", "name"=>"job[data][destDataFilePath]", "description"=>"The data output file"}, {"in"=>"query", "name"=>"job[data][destDirLocalPath]"}, {"in"=>"query", "name"=>"job[data][destDirRemoteUrl]"}, {"in"=>"query", "name"=>"job[data][destFileLocalPath]"}, {"in"=>"query", "name"=>"job[data][destFileName]"}, {"in"=>"query", "name"=>"job[data][destFilePath]", "description"=>"Output file"}, {"in"=>"query", "name"=>"job[data][destFileSyncLocalPath]"}, {"in"=>"query", "name"=>"job[data][destFileSyncRemoteUrl]"}, {"in"=>"query", "name"=>"job[data][destFileSyncStoredPath]"}, {"in"=>"query", "name"=>"job[data][destVersion]"}, {"in"=>"query", "name"=>"job[data][destXsdPath]"}, {"in"=>"query", "name"=>"job[data][detectGOP]"}, {"in"=>"query", "name"=>"job[data][distributionProfileId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][accountId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][adFreeApplicationGuid]", "description"=>"The GUID for the application in which to record metrics and enforce business rules obtained through your Unicorn representative"}, {"in"=>"query", "name"=>"job[data][distributionProfile][adServerPartnerId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowAdsenseForVideo]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowComments]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowDownload]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowEmbedding]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowInvideo]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowMidRollAds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowPostRollAds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowPreRollAds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowRatings]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowResponses]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowStreaming]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][allowSyndication]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][apiAuthorizeUrl]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][apiHostUrl]", "description"=>"The API host URL that the Upload User should have access to, Used for HTTP content submission"}, {"in"=>"query", "name"=>"job[data][distributionProfile][apikey]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][asperaHost]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][asperaLogin]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][asperaPass]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][asperaPrivateKey]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][asperaPublicKey]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][assetFilenameXslt]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][assumeSuccess]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][autoCreateFlavors]", "description"=>"Comma separated flavor params ids that should be auto converted"}, {"in"=>"query", "name"=>"job[data][distributionProfile][autoCreateThumb]", "description"=>"Comma separated thumbnail params ids that should be auto generated"}, {"in"=>"query", "name"=>"job[data][distributionProfile][backgroundImageStandard]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][backgroundImageWide]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][basePath]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][blockOutsideOwnership]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][bodyXslt]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][captionAutosync]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][categoryId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][certificateKey]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelCopyright]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelDescription]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelGenerator]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelGuid]", "description"=>"The Channel GUID assigned to this Publication Rule"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelImageHeight]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelImageLink]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelImageTitle]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelImageUrl]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelImageWidth]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelLanguage]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelLink]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelManagingEditor]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelRating]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][channelTitle]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][claimType]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][commercialPolicy]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][contactEmail]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][contactTelephone]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][contentOwner]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][copyright]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][cPlatformTvSeriesField]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][cPlatformTvSeries]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][csId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][cuePointsProvider]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][defaultCategory]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][deleteEnabled]", "description"=>"Enum Type: `KalturaDistributionProfileActionStatus`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][deleteReference]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][disableEpisodeNumberCustomValidation]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][disableMetadata]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][distributeCaptions]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][distributeCuePoints]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][distributeRemoteCaptionAssetContent]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][distributeRemoteFlavorAssetContent]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][distributeRemoteThumbAssetContent]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][domainGuid]", "description"=>"The GUID of the Customer Domain in the Unicorn system obtained by contacting your Unicorn representative"}, {"in"=>"query", "name"=>"job[data][distributionProfile][domainName]", "description"=>"The name of the Domain that the Upload User should have access to, Used for authentication"}, {"in"=>"query", "name"=>"job[data][distributionProfile][domain]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][downloadPriceCode]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][email]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][enableAdServer]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][entitlements]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][entitlement]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedAuthorName]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedCopyright]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedDescription]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedImageHeight]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedImageLink]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedImageTitle]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedImageUrl]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedImageWidth]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedLanguage]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedLastBuildDate]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedLink]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedSpecVersion]", "description"=>"Enum Type: `KalturaYouTubeDistributionFeedSpecVersion`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedSubtitle]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][feedTitle]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][fieldConfigArray]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][flavorAssetFilenameXslt]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][flvFlavorParamsId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ftpHost]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ftpLogin]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ftpPassword]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ftpPass]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ftpPath]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ftpUsername]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][genericProviderId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][geoBlockingMapping]", "description"=>"Enum Type: `KalturaDailymotionGeoBlockingMapping`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][googleClientId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][googleClientSecret]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][googleTokenData]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][hideViewCount]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][host]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ignoreSchedulingInFeed]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ingestUrl]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][instreamStandard]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][instreamTrueview]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ips]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][itemLink]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][itemMediaRating]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][itemsPerPage]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][itemType]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][itemXpathsToExtend]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][mapAccessControlProfileIds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][mapCaptionParamsIds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][mapConversionProfileIds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][mapFlavorParamsIds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][mapMetadataProfileIds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][mapStorageProfileIds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][mapThumbParamsIds]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][metadataFilenameXslt]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][metadataProfileId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][metadataXpathsTriggerUpdate]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][metadataXslt]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][msnvideoCat]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][msnvideoTopCat]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][msnvideoTop]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][name]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][notificationEmail]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][objectType]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][optionalAssetDistributionRules]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][optionalFlavorParamsIds]", "description"=>"Comma separated flavor params ids that should be submitted if ready"}, {"in"=>"query", "name"=>"job[data][distributionProfile][optionalThumbDimensions]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][overrideManualEdits]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ownerName]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][pageAccessToken]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][pageGroup]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][pageId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][passphrase]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][password]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][permissions]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][port]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][priority]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][privacyStatus]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][processFeed]", "description"=>"Enum Type: `KalturaYahooDistributionProcessFeedActionStatus`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][protocol]", "description"=>"`insertOnly`Enum Type: `KalturaDistributionProtocol`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][providerId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][providerName]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][providerType]", "description"=>"`insertOnly`Enum Type: `KalturaDistributionProviderType`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][rating]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][recommendedDcForDownload]", "description"=>"The best Kaltura data center to be used to download the asset files to"}, {"in"=>"query", "name"=>"job[data][distributionProfile][recommendedDcForExecute]", "description"=>"The best Kaltura data center to be used to execute the distribution job"}, {"in"=>"query", "name"=>"job[data][distributionProfile][recommendedStorageProfileForDownload]", "description"=>"The best external storage to be used to download the asset files from"}, {"in"=>"query", "name"=>"job[data][distributionProfile][releaseClaims]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][remoteAssetParamsId]", "description"=>"The flavor-params that will be used for the remote asset"}, {"in"=>"query", "name"=>"job[data][distributionProfile][replaceAirDates]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][replaceGroup]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][reportEnabled]", "description"=>"Enum Type: `KalturaDistributionProfileActionStatus`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][requiredAssetDistributionRules]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][requiredFlavorParamsIds]", "description"=>"Comma separated flavor params ids that required to be ready before submission"}, {"in"=>"query", "name"=>"job[data][distributionProfile][requiredThumbDimensions]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][reRequestPermissions]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][seasonNumber]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][seasonSynopsis]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][seasonTuneInInformation]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sendMetadataAfterAssets]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][seriesAdditionalCategories]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][seriesChannel]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][seriesPrimaryCategory]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sftpBaseDir]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sftpBasePath]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sftpHost]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sftpLogin]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sftpPass]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sftpPort]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sftpPrivateKey]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sftpPublicKey]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][shouldAddThumbExtension]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][shouldIncludeCaptions]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][shouldIncludeCuePoints]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][slFlavorParamsId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][slHdFlavorParamsId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sourceFlavorParamsId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sourceFriendlyName]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][source]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][state]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][status]", "description"=>"Enum Type: `KalturaDistributionProfileStatus`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][storageProfileId]", "description"=>"The remote storage that should be used for the remote asset"}, {"in"=>"query", "name"=>"job[data][distributionProfile][streamingPriceCode]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][strict]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitAction][ftpPassiveMode]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitAction][httpFieldName]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitAction][httpFileName]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitAction][password]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitAction][protocol]", "description"=>"Enum Type: `KalturaDistributionProtocol`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitAction][serverPath]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitAction][serverUrl]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitAction][username]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][submitEnabled]", "description"=>"Enum Type: `KalturaDistributionProfileActionStatus`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sunriseDefaultOffset]", "description"=>"If entry distribution sunrise not specified that will be the default since entry creation time, in seconds"}, {"in"=>"query", "name"=>"job[data][distributionProfile][sunsetDefaultOffset]", "description"=>"If entry distribution sunset not specified that will be the default since entry creation time, in seconds"}, {"in"=>"query", "name"=>"job[data][distributionProfile][tags]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][targetAccountId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][targetLoginId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][targetLoginPassword]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][targetServiceUrl]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][target]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][thumbnailAssetFilenameXslt]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][ugcPolicy]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][updateEnabled]", "description"=>"Enum Type: `KalturaDistributionProfileActionStatus`"}, {"in"=>"query", "name"=>"job[data][distributionProfile][upstreamNetworkId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][upstreamNetworkName]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][upstreamVideoId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][urgentReference]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][useCategoryEntries]", "description"=>"When checking custom XSLT conditions using the fieldConfigArray - address only categories associated with the entry via the categoryEntry object"}, {"in"=>"query", "name"=>"job[data][distributionProfile][userAccessToken]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][username]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][user]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][videoMediaType]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][wmvFlavorParamsId]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][xsltFile]"}, {"in"=>"query", "name"=>"job[data][distributionProfile][xsl]"}, {"in"=>"query", "name"=>"job[data][domainName]"}, {"in"=>"query", "name"=>"job[data][dropFolderFileIds]"}, {"in"=>"query", "name"=>"job[data][dropFolderFileId]"}, {"in"=>"query", "name"=>"job[data][dropFolderId]"}, {"in"=>"query", "name"=>"job[data][duration]", "description"=>"Clipping duration in seconds"}, {"in"=>"query", "name"=>"job[data][dvrEnabled]", "description"=>"Enum Type: `KalturaDVRStatus`"}, {"in"=>"query", "name"=>"job[data][dvrWindow]"}, {"in"=>"query", "name"=>"job[data][emailId]"}, {"in"=>"query", "name"=>"job[data][encoderIP]"}, {"in"=>"query", "name"=>"job[data][encoderPassword]"}, {"in"=>"query", "name"=>"job[data][encoderUsername]"}, {"in"=>"query", "name"=>"job[data][endDate]"}, {"in"=>"query", "name"=>"job[data][endObjectKey]"}, {"in"=>"query", "name"=>"job[data][endPoint]"}, {"in"=>"query", "name"=>"job[data][endTime]", "description"=>"Duration of the live entry including all recorded segments including the current"}, {"in"=>"query", "name"=>"job[data][engineMessage]"}, {"in"=>"query", "name"=>"job[data][engineVersion]"}, {"in"=>"query", "name"=>"job[data][entryIds]", "description"=>"Comma separated list of entry ids"}, {"in"=>"query", "name"=>"job[data][entryId]", "description"=>"Live stream entry id"}, {"in"=>"query", "name"=>"job[data][eventsType]", "description"=>"Enum Type: `KalturaScheduleEventType`The type of the events that ill be created by this upload"}, {"in"=>"query", "name"=>"job[data][extractId3Tags]"}, {"in"=>"query", "name"=>"job[data][extraDestFileSyncs]"}, {"in"=>"query", "name"=>"job[data][fileIndex]", "description"=>"The index of the file within the entry"}, {"in"=>"query", "name"=>"job[data][fileLocation]"}, {"in"=>"query", "name"=>"job[data][fileName]", "description"=>"Friendly name of the file, used to be recognized later in the logs"}, {"in"=>"query", "name"=>"job[data][fileSize]"}, {"in"=>"query", "name"=>"job[data][filesPermissionInS3]", "description"=>"Enum Type: `KalturaAmazonS3StorageProfileFilesPermissionLevel`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][field]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][idIn]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][items]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][not]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][objectType]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][value]"}, {"in"=>"query", "name"=>"job[data][filter][advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"job[data][filter][orderBy]"}, {"in"=>"query", "name"=>"job[data][flavorAssetId]", "description"=>"Flavor asset to be ingested with the output"}, {"in"=>"query", "name"=>"job[data][flavorParamsId]", "description"=>"Flavor params id to use for conversion"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutputId]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][anamorphicPixels]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][aspectRatioProcessingMode]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][audioBitrate]", "description"=>"The audio bitrate (in KBits) of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][audioChannels]", "description"=>"The number of audio channels for downmixing"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][audioCodec]", "description"=>"Enum Type: `KalturaAudioCodec`The audio codec of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][audioSampleRate]", "description"=>"The audio sample rate of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][clipDuration]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][clipOffset]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][commandLinesStr]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][contentAwareness]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][conversionEnginesExtraParams]", "description"=>"The list of conversion engines extra params (separated with |)"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][conversionEngines]", "description"=>"The list of conversion engines (comma separated)"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][deinterlice]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][densityHeight]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][densityWidth]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][depth]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][description]", "description"=>"The description of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][engineVersion]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][flashVersion]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][flavorAssetId]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][flavorAssetVersion]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][flavorParamsId]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][flavorParamsVersion]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][forcedKeyFramesMode]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][forceFrameToMultiplication16]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][format]", "description"=>"Enum Type: `KalturaContainerFormat`The container format of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][frameRate]", "description"=>"The frame rate of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][gopSize]", "description"=>"The gop size of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][height]", "description"=>"The desired height of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][isAvoidForcedKeyFrames]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][isAvoidVideoShrinkBitrateToSource]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][isAvoidVideoShrinkFramesizeToSource]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][isCropIMX]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][isEncrypted]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][isGopInSec]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][isVideoFrameRateForLowBrAppleHls]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][maxFrameRate]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][mediaParserType]", "description"=>"Enum Type: `KalturaMediaParserType`Media parser type to be used for post-conversion validation"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][multiStream]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][name]", "description"=>"The name of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][objectType]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][operators]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][optimizationPolicy]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][partnerId]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][poly2Bitmap]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][readonly]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][readyBehavior]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][remoteStorageProfileIds]", "description"=>"Comma seperated ids of remote storage profiles that the flavor distributed to, the distribution done by the conversion engine"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][requiredPermissions]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][rotate]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][sizeHeight]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][sizeWidth]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][sourceAssetParamsIds]", "description"=>"Comma seperated ids of source flavor params this flavor is created from"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][sourceRemoteStorageProfileId]", "description"=>"Id of remote storage profile that used to get the source, zero indicates Kaltura data center"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][subtitlesData]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][systemName]", "description"=>"System name of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][tags]", "description"=>"The Flavor Params tags are used to identify the flavor for different usage (e"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][twoPass]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][videoBitrateTolerance]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][videoBitrate]", "description"=>"The video bitrate (in KBits) of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][videoCodec]", "description"=>"Enum Type: `KalturaVideoCodec`The video codec of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][videoConstantBitrate]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][watermarkData]"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][widevineDistributionEndDate]", "description"=>"License distribution window end date"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][widevineDistributionStartDate]", "description"=>"License distribution window start date"}, {"in"=>"query", "name"=>"job[data][flavorParamsOutput][width]", "description"=>"The desired width of the Flavor Params"}, {"in"=>"query", "name"=>"job[data][flavors]"}, {"in"=>"query", "name"=>"job[data][force]"}, {"in"=>"query", "name"=>"job[data][fromEmail]"}, {"in"=>"query", "name"=>"job[data][fromName]"}, {"in"=>"query", "name"=>"job[data][fromPartnerId]", "description"=>"Id of the partner to copy from"}, {"in"=>"query", "name"=>"job[data][ftpPassiveMode]"}, {"in"=>"query", "name"=>"job[data][inputFileSyncLocalPath]"}, {"in"=>"query", "name"=>"job[data][inputXmlLocalPath]"}, {"in"=>"query", "name"=>"job[data][inputXmlRemoteUrl]"}, {"in"=>"query", "name"=>"job[data][isHtml]"}, {"in"=>"query", "name"=>"job[data][keepDistributionItem]", "description"=>"Flag signifying that the associated distribution item should not be moved to removed status"}, {"in"=>"query", "name"=>"job[data][ksType]", "description"=>"Enum Type: `KalturaSessionType`"}, {"in"=>"query", "name"=>"job[data][language]", "description"=>"Enum Type: `KalturaLanguageCode`"}, {"in"=>"query", "name"=>"job[data][lastCuePointSyncTime]", "description"=>"last live to vod sync time"}, {"in"=>"query", "name"=>"job[data][lastMovedCategoryEntryPageIndex]", "description"=>"Saves the last page index of the category entries filter pager In case of crash the batch will restart from that point"}, {"in"=>"query", "name"=>"job[data][lastMovedCategoryId]", "description"=>"Saves the last category id that its entries moved completely In case of crash the batch will restart from that point"}, {"in"=>"query", "name"=>"job[data][lastMovedCategoryPageIndex]", "description"=>"Saves the last page index of the child categories filter pager In case of crash the batch will restart from that point"}, {"in"=>"query", "name"=>"job[data][lastSegmentDrift]", "description"=>"last segment drift"}, {"in"=>"query", "name"=>"job[data][lastSegmentDuration]", "description"=>"last Segment Duration"}, {"in"=>"query", "name"=>"job[data][lastUpdatedCategoryCreatedAt]", "description"=>"Saves the last sub category creation date that was updated In case of crash the batch will restart from that point"}, {"in"=>"query", "name"=>"job[data][lastUpdatedCategoryEntryCreatedAt]", "description"=>"Saves the last category entry creation date that was updated In case of crash the batch will restart from that point"}, {"in"=>"query", "name"=>"job[data][liveEntryId]", "description"=>"live Entry Id"}, {"in"=>"query", "name"=>"job[data][localFileSyncPath]"}, {"in"=>"query", "name"=>"job[data][logFileSyncLocalPath]"}, {"in"=>"query", "name"=>"job[data][logFileSyncRemoteUrl]"}, {"in"=>"query", "name"=>"job[data][mailPriority]"}, {"in"=>"query", "name"=>"job[data][mailType]", "description"=>"Enum Type: `KalturaMailType`"}, {"in"=>"query", "name"=>"job[data][maxResults]"}, {"in"=>"query", "name"=>"job[data][mediaServerIndex]", "description"=>"Enum Type: `KalturaEntryServerNodeType`Primary or secondary media server"}, {"in"=>"query", "name"=>"job[data][mediaType]"}, {"in"=>"query", "name"=>"job[data][metadataId]"}, {"in"=>"query", "name"=>"job[data][metadataProfileId]"}, {"in"=>"query", "name"=>"job[data][method]", "description"=>"Enum Type: `KalturaHttpNotificationMethod`Request method"}, {"in"=>"query", "name"=>"job[data][minSendDate]"}, {"in"=>"query", "name"=>"job[data][modifiedAttributes]"}, {"in"=>"query", "name"=>"job[data][monitorSyncCompletion]"}, {"in"=>"query", "name"=>"job[data][moveFromChildren]", "description"=>"All entries from all child categories will be moved as well"}, {"in"=>"query", "name"=>"job[data][multiLanaguageCaptionAssetId]"}, {"in"=>"query", "name"=>"job[data][notificationEmail]"}, {"in"=>"query", "name"=>"job[data][notificationResult]"}, {"in"=>"query", "name"=>"job[data][numberOfAttempts]"}, {"in"=>"query", "name"=>"job[data][objectData][conversionProfileId]", "description"=>"Selected profile id for all bulk entries"}, {"in"=>"query", "name"=>"job[data][objectData][objectType]"}, {"in"=>"query", "name"=>"job[data][objectId]"}, {"in"=>"query", "name"=>"job[data][objectType]"}, {"in"=>"query", "name"=>"job[data][objType]", "description"=>"Enum Type: `KalturaNotificationObjectType`"}, {"in"=>"query", "name"=>"job[data][offset]", "description"=>"Clipping offset in seconds"}, {"in"=>"query", "name"=>"job[data][outputPath]"}, {"in"=>"query", "name"=>"job[data][parsedSlug]"}, {"in"=>"query", "name"=>"job[data][parsedUserId]"}, {"in"=>"query", "name"=>"job[data][passPhrase]"}, {"in"=>"query", "name"=>"job[data][password]", "description"=>"A password to use for the connection"}, {"in"=>"query", "name"=>"job[data][plays]"}, {"in"=>"query", "name"=>"job[data][primaryBroadcastingUrl]"}, {"in"=>"query", "name"=>"job[data][primaryContact]"}, {"in"=>"query", "name"=>"job[data][privateKey]"}, {"in"=>"query", "name"=>"job[data][protocol]", "description"=>"http / https"}, {"in"=>"query", "name"=>"job[data][providerData][additionalParameters]", "description"=>"additional parameters to send to Cielo24"}, {"in"=>"query", "name"=>"job[data][providerData][captionAssetFormats]", "description"=>"Caption formats"}, {"in"=>"query", "name"=>"job[data][providerData][entryId]", "description"=>"Entry ID"}, {"in"=>"query", "name"=>"job[data][providerData][exampleUrl]", "description"=>"Just an example"}, {"in"=>"query", "name"=>"job[data][providerData][fidelity]", "description"=>"Enum Type: `KalturaCielo24Fidelity`"}, {"in"=>"query", "name"=>"job[data][providerData][flavorAssetId]", "description"=>"Flavor ID"}, {"in"=>"query", "name"=>"job[data][providerData][metadataProfileId]", "description"=>"ID of the metadata profile for the extracted term metadata"}, {"in"=>"query", "name"=>"job[data][providerData][objectType]"}, {"in"=>"query", "name"=>"job[data][providerData][priority]", "description"=>"Enum Type: `KalturaCielo24Priority`"}, {"in"=>"query", "name"=>"job[data][providerData][replaceMediaContent]", "description"=>"should replace remote media content"}, {"in"=>"query", "name"=>"job[data][providerData][spokenLanguage]", "description"=>"Enum Type: `KalturaLanguage`Transcript content language"}, {"in"=>"query", "name"=>"job[data][providerData][transcriptAssetId]", "description"=>"ID of the transcript asset"}, {"in"=>"query", "name"=>"job[data][providerData][transcriptId]", "description"=>"input Transcript-asset ID"}, {"in"=>"query", "name"=>"job[data][providerData][voicebaseApiKey]", "description"=>"Voicebase API key to fetch transcript tokens"}, {"in"=>"query", "name"=>"job[data][providerData][voicebaseApiPassword]", "description"=>"Voicebase API password to fetch transcript tokens"}, {"in"=>"query", "name"=>"job[data][providerType]", "description"=>"Enum Type: `KalturaIntegrationProviderType`"}, {"in"=>"query", "name"=>"job[data][provisioningParams]"}, {"in"=>"query", "name"=>"job[data][publicKey]"}, {"in"=>"query", "name"=>"job[data][puserId]", "description"=>"The id of the requesting user"}, {"in"=>"query", "name"=>"job[data][recipientEmail]"}, {"in"=>"query", "name"=>"job[data][recipientId]", "description"=>"kuserId"}, {"in"=>"query", "name"=>"job[data][recipientName]"}, {"in"=>"query", "name"=>"job[data][referenceTime]"}, {"in"=>"query", "name"=>"job[data][remoteMediaId]"}, {"in"=>"query", "name"=>"job[data][resultsFilePath]"}, {"in"=>"query", "name"=>"job[data][returnVal]"}, {"in"=>"query", "name"=>"job[data][rtmp]"}, {"in"=>"query", "name"=>"job[data][s3Region]"}, {"in"=>"query", "name"=>"job[data][scanResult]", "description"=>"Enum Type: `KalturaVirusScanJobResult`"}, {"in"=>"query", "name"=>"job[data][secondaryBroadcastingUrl]"}, {"in"=>"query", "name"=>"job[data][secondaryContact]"}, {"in"=>"query", "name"=>"job[data][separator]"}, {"in"=>"query", "name"=>"job[data][serverPassPhrase]"}, {"in"=>"query", "name"=>"job[data][serverPassword]"}, {"in"=>"query", "name"=>"job[data][serverPrivateKey]"}, {"in"=>"query", "name"=>"job[data][serverPublicKey]"}, {"in"=>"query", "name"=>"job[data][serverUrl]"}, {"in"=>"query", "name"=>"job[data][serverUsername]"}, {"in"=>"query", "name"=>"job[data][server][dc]", "description"=>"The dc of the server"}, {"in"=>"query", "name"=>"job[data][server][description]"}, {"in"=>"query", "name"=>"job[data][server][host]"}, {"in"=>"query", "name"=>"job[data][server][name]"}, {"in"=>"query", "name"=>"job[data][server][objectType]"}, {"in"=>"query", "name"=>"job[data][server][password]"}, {"in"=>"query", "name"=>"job[data][server][port]"}, {"in"=>"query", "name"=>"job[data][server][protocol]", "description"=>"Enum Type: `KalturaActivitiBusinessProcessServerProtocol`"}, {"in"=>"query", "name"=>"job[data][server][systemName]"}, {"in"=>"query", "name"=>"job[data][server][username]"}, {"in"=>"query", "name"=>"job[data][serviceToken]"}, {"in"=>"query", "name"=>"job[data][signatureType]"}, {"in"=>"query", "name"=>"job[data][signSecret]", "description"=>"The secret to sign the notification with"}, {"in"=>"query", "name"=>"job[data][srcAssetId]"}, {"in"=>"query", "name"=>"job[data][srcAssetType]", "description"=>"Enum Type: `KalturaAssetType`"}, {"in"=>"query", "name"=>"job[data][srcCategoryId]", "description"=>"Source category id"}, {"in"=>"query", "name"=>"job[data][srcFilePath]", "description"=>"The recorded live media"}, {"in"=>"query", "name"=>"job[data][srcFileSyncId]"}, {"in"=>"query", "name"=>"job[data][srcFileSyncLocalPath]"}, {"in"=>"query", "name"=>"job[data][srcFileSyncRemoteUrl]"}, {"in"=>"query", "name"=>"job[data][srcFileSyncs]"}, {"in"=>"query", "name"=>"job[data][srcFiles]"}, {"in"=>"query", "name"=>"job[data][srcFileUrl]"}, {"in"=>"query", "name"=>"job[data][srcVersion]"}, {"in"=>"query", "name"=>"job[data][srcXslPath]"}, {"in"=>"query", "name"=>"job[data][sseKmsKeyId]"}, {"in"=>"query", "name"=>"job[data][sseType]"}, {"in"=>"query", "name"=>"job[data][sslCertificatePassword]", "description"=>"The password required to use the certificate"}, {"in"=>"query", "name"=>"job[data][sslCertificateType]", "description"=>"Enum Type: `KalturaHttpNotificationCertificateType`The format of the certificate"}, {"in"=>"query", "name"=>"job[data][sslCertificate]", "description"=>"SSL certificate to verify the peer with"}, {"in"=>"query", "name"=>"job[data][sslEngineDefault]", "description"=>"The identifier for the crypto engine used for asymmetric crypto operations"}, {"in"=>"query", "name"=>"job[data][sslEngine]", "description"=>"The identifier for the crypto engine of the private SSL key specified in ssl key"}, {"in"=>"query", "name"=>"job[data][sslKeyPassword]", "description"=>"The secret password needed to use the private SSL key specified in ssl key"}, {"in"=>"query", "name"=>"job[data][sslKeyType]", "description"=>"Enum Type: `KalturaHttpNotificationSslKeyType`The key type of the private SSL key specified in ssl key - PEM / DER / ENG"}, {"in"=>"query", "name"=>"job[data][sslKey]", "description"=>"Private SSL key"}, {"in"=>"query", "name"=>"job[data][sslVersion]", "description"=>"Enum Type: `KalturaHttpNotificationSslVersion`The SSL version (2 or 3) to use"}, {"in"=>"query", "name"=>"job[data][startObjectKey]"}, {"in"=>"query", "name"=>"job[data][status]", "description"=>"Enum Type: `KalturaMailJobStatus`"}, {"in"=>"query", "name"=>"job[data][streamID]"}, {"in"=>"query", "name"=>"job[data][streamName]"}, {"in"=>"query", "name"=>"job[data][streamType]", "description"=>"Enum Type: `KalturaAkamaiUniversalStreamType`"}, {"in"=>"query", "name"=>"job[data][subjectParams]"}, {"in"=>"query", "name"=>"job[data][syncMode]", "description"=>"Enum Type: `KalturaWidevineRepositorySyncMode`"}, {"in"=>"query", "name"=>"job[data][systemPassword]"}, {"in"=>"query", "name"=>"job[data][systemUserName]"}, {"in"=>"query", "name"=>"job[data][templateId]"}, {"in"=>"query", "name"=>"job[data][templatePath]"}, {"in"=>"query", "name"=>"job[data][thumbAssetId]"}, {"in"=>"query", "name"=>"job[data][thumbBitrate]", "description"=>"The bit rate of last created thumbnail, will be used to comapare if this thumbnail is the best we can have"}, {"in"=>"query", "name"=>"job[data][thumbHeight]", "description"=>"The height of last created thumbnail, will be used to comapare if this thumbnail is the best we can have"}, {"in"=>"query", "name"=>"job[data][thumbOffset]", "description"=>"The position of the thumbnail in the media file"}, {"in"=>"query", "name"=>"job[data][thumbParamsOutputId]"}, {"in"=>"query", "name"=>"job[data][thumbPath]"}, {"in"=>"query", "name"=>"job[data][timeout]", "description"=>"The maximum number of seconds to allow cURL functions to execute"}, {"in"=>"query", "name"=>"job[data][timeReference]"}, {"in"=>"query", "name"=>"job[data][timeZoneOffset]"}, {"in"=>"query", "name"=>"job[data][toPartnerId]", "description"=>"Id of the partner to copy to"}, {"in"=>"query", "name"=>"job[data][totalVodDuration]", "description"=>"total VOD Duration"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][categoryDirectMembers]", "description"=>"Return the list of categoryUser that are not inherited from parent category - only the direct categoryUsers"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][categoryFullIdsEqual]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][categoryFullIdsStartsWith]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][categoryIdEqual]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][categoryIdIn]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][freeText]", "description"=>"Free text search on user id or screen name"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][orderBy]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][permissionLevelEqual]", "description"=>"Enum Type: `KalturaCategoryUserPermissionLevel`"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][permissionLevelIn]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][permissionNamesMatchAnd]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][permissionNamesMatchOr]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][permissionNamesNotContains]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][relatedGroupsByUserId]", "description"=>"Return a list of categoryUser that related to the userId in this field by groups"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][statusEqual]", "description"=>"Enum Type: `KalturaCategoryUserStatus`"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][statusIn]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][updateMethodEqual]", "description"=>"Enum Type: `KalturaUpdateMethodType`"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][updateMethodIn]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][userIdEqual]"}, {"in"=>"query", "name"=>"job[data][to][categoryUserFilter][userIdIn]"}, {"in"=>"query", "name"=>"job[data][to][emailRecipients]"}, {"in"=>"query", "name"=>"job[data][to][filter][createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"job[data][to][filter][createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"job[data][to][filter][emailLike]"}, {"in"=>"query", "name"=>"job[data][to][filter][emailStartsWith]"}, {"in"=>"query", "name"=>"job[data][to][filter][firstNameOrLastNameStartsWith]"}, {"in"=>"query", "name"=>"job[data][to][filter][firstNameStartsWith]"}, {"in"=>"query", "name"=>"job[data][to][filter][idEqual]"}, {"in"=>"query", "name"=>"job[data][to][filter][idIn]"}, {"in"=>"query", "name"=>"job[data][to][filter][idOrScreenNameStartsWith]"}, {"in"=>"query", "name"=>"job[data][to][filter][isAdminEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"job[data][to][filter][lastNameStartsWith]"}, {"in"=>"query", "name"=>"job[data][to][filter][loginEnabledEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"job[data][to][filter][objectType]"}, {"in"=>"query", "name"=>"job[data][to][filter][orderBy]"}, {"in"=>"query", "name"=>"job[data][to][filter][partnerIdEqual]"}, {"in"=>"query", "name"=>"job[data][to][filter][permissionNamesMultiLikeAnd]", "description"=>"Permission names filter expression"}, {"in"=>"query", "name"=>"job[data][to][filter][permissionNamesMultiLikeOr]", "description"=>"Permission names filter expression"}, {"in"=>"query", "name"=>"job[data][to][filter][roleIdEqual]"}, {"in"=>"query", "name"=>"job[data][to][filter][roleIdsEqual]"}, {"in"=>"query", "name"=>"job[data][to][filter][roleIdsIn]"}, {"in"=>"query", "name"=>"job[data][to][filter][screenNameLike]"}, {"in"=>"query", "name"=>"job[data][to][filter][screenNameStartsWith]"}, {"in"=>"query", "name"=>"job[data][to][filter][statusEqual]", "description"=>"Enum Type: `KalturaUserStatus`"}, {"in"=>"query", "name"=>"job[data][to][filter][statusIn]"}, {"in"=>"query", "name"=>"job[data][to][filter][tagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"job[data][to][filter][tagsMultiLikeOr]"}, {"in"=>"query", "name"=>"job[data][to][filter][typeEqual]", "description"=>"Enum Type: `KalturaUserType`"}, {"in"=>"query", "name"=>"job[data][to][filter][typeIn]"}, {"in"=>"query", "name"=>"job[data][to][objectType]"}, {"in"=>"query", "name"=>"job[data][typeAsString]"}, {"in"=>"query", "name"=>"job[data][type]", "description"=>"Enum Type: `KalturaNotificationType`"}, {"in"=>"query", "name"=>"job[data][url]", "description"=>"Remote server URL"}, {"in"=>"query", "name"=>"job[data][userId]"}, {"in"=>"query", "name"=>"job[data][username]", "description"=>"A username to use for the connection"}, {"in"=>"query", "name"=>"job[data][userRoles]"}, {"in"=>"query", "name"=>"job[data][views]"}, {"in"=>"query", "name"=>"job[data][virusFoundAction]", "description"=>"Enum Type: `KalturaVirusFoundAction`"}, {"in"=>"query", "name"=>"job[data][vodEntryId]", "description"=>"$vod Entry Id"}, {"in"=>"query", "name"=>"job[data][webexHostId]"}, {"in"=>"query", "name"=>"job[data][wsdlPassword]"}, {"in"=>"query", "name"=>"job[data][wsdlUsername]"}, {"in"=>"query", "name"=>"job[data][wvAssetIds]"}, {"in"=>"query", "name"=>"job[entryId]"}, {"in"=>"query", "name"=>"job[entryName]"}, {"in"=>"query", "name"=>"job[jobSubType]"}, {"in"=>"query", "name"=>"lockKey[batchIndex]"}, {"in"=>"query", "name"=>"lockKey[schedulerId]"}, {"in"=>"query", "name"=>"lockKey[workerId]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "UpdateExclusiveJob"]}}, "/service/batch/action/updatePartnerLoadTable"=>{"get"=>{"summary"=>"Get Service Batch Action Updatepartnerloadtable", "description"=>"batch updatePartnerLoadTable action cleans the partner load table", "operationId"=>"batch.updatePartnerLoadTable", "x-api-path-slug"=>"servicebatchactionupdatepartnerloadtable-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batch", "Action", "UpdatePartnerLoadTable"]}}, "/service/batchcontrol/action/configLoaded"=>{"get"=>{"summary"=>"Get Service Batchcontrol Action Configloaded", "description"=>"batch configLoaded action saves the configuration as loaded by a remote scheduler", "operationId"=>"batchcontrol.configLoaded", "x-api-path-slug"=>"servicebatchcontrolactionconfigloaded-get", "parameters"=>[{"in"=>"query", "name"=>"configParam", "description"=>"The parameter that was loaded"}, {"in"=>"query", "name"=>"configParamPart", "description"=>"The parameter part that was loaded"}, {"in"=>"query", "name"=>"configValue", "description"=>"The value that was loaded"}, {"in"=>"query", "name"=>"scheduler[configs]"}, {"in"=>"query", "name"=>"scheduler[configuredId]", "description"=>"The id as configured in the batch config"}, {"in"=>"query", "name"=>"scheduler[host]", "description"=>"The host name"}, {"in"=>"query", "name"=>"scheduler[name]", "description"=>"The scheduler name"}, {"in"=>"query", "name"=>"scheduler[statuses]"}, {"in"=>"query", "name"=>"scheduler[workers]"}, {"in"=>"query", "name"=>"workerConfigId", "description"=>"The id of the job that the configuration refers to, not mandatory if the configuration refers to the scheduler"}, {"in"=>"query", "name"=>"workerName", "description"=>"The name of the job that the configuration refers to, not mandatory if the configuration refers to the scheduler"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batchcontrol", "Action", "ConfigLoaded"]}}, "/service/batchcontrol/action/getCommand"=>{"get"=>{"summary"=>"Get Service Batchcontrol Action Getcommand", "description"=>"batch getCommand action returns the command with its current status", "operationId"=>"batchcontrol.getCommand", "x-api-path-slug"=>"servicebatchcontrolactiongetcommand-get", "parameters"=>[{"in"=>"query", "name"=>"commandId", "description"=>"The id of the command"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batchcontrol", "Action", "GetCommand"]}}, "/service/batchcontrol/action/getFullStatus"=>{"get"=>{"summary"=>"Get Service Batchcontrol Action Getfullstatus", "description"=>"batch getFullStatus action returns the status of all schedulers and queues", "operationId"=>"batchcontrol.getFullStatus", "x-api-path-slug"=>"servicebatchcontrolactiongetfullstatus-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batchcontrol", "Action", "GetFullStatus"]}}, "/service/batchcontrol/action/kill"=>{"get"=>{"summary"=>"Get Service Batchcontrol Action Kill", "description"=>"batch kill action forces stop og a batch on a remote scheduler", "operationId"=>"batchcontrol.kill", "x-api-path-slug"=>"servicebatchcontrolactionkill-get", "parameters"=>[{"in"=>"query", "name"=>"adminId", "description"=>"The id of the admin that called the stop"}, {"in"=>"query", "name"=>"batchIndex", "description"=>"The index of the batch job process to be stopped"}, {"in"=>"query", "name"=>"cause", "description"=>"The reason it was stopped"}, {"in"=>"query", "name"=>"workerId", "description"=>"The id of the job to be stopped"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batchcontrol", "Action", "Kill"]}}, "/service/batchcontrol/action/listCommands"=>{"get"=>{"summary"=>"Get Service Batchcontrol Action Listcommands", "description"=>"list batch control commands", "operationId"=>"batchcontrol.listCommands", "x-api-path-slug"=>"servicebatchcontrolactionlistcommands-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdByIdEqual]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaControlPanelCommandStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[targetTypeEqual]", "description"=>"Enum Type: `KalturaControlPanelCommandTargetType`"}, {"in"=>"query", "name"=>"filter[targetTypeIn]"}, {"in"=>"query", "name"=>"filter[typeEqual]", "description"=>"Enum Type: `KalturaControlPanelCommandType`"}, {"in"=>"query", "name"=>"filter[typeIn]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batchcontrol", "Action", "ListCommands"]}}, "/service/batchcontrol/action/listSchedulers"=>{"get"=>{"summary"=>"Get Service Batchcontrol Action Listschedulers", "description"=>"list all Schedulers", "operationId"=>"batchcontrol.listSchedulers", "x-api-path-slug"=>"servicebatchcontrolactionlistschedulers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batchcontrol", "Action", "ListSchedulers"]}}, "/service/batchcontrol/action/listWorkers"=>{"get"=>{"summary"=>"Get Service Batchcontrol Action Listworkers", "description"=>"list all Workers", "operationId"=>"batchcontrol.listWorkers", "x-api-path-slug"=>"servicebatchcontrolactionlistworkers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batchcontrol", "Action", "ListWorkers"]}}, "/service/batchcontrol/action/reportStatus"=>{"get"=>{"summary"=>"Get Service Batchcontrol Action Reportstatus", "description"=>"batch reportStatus action saves the a status attribute from a remote scheduler and returns pending commands for the scheduler", "operationId"=>"batchcontrol.reportStatus", "x-api-path-slug"=>"servicebatchcontrolactionreportstatus-get", "parameters"=>[{"in"=>"query", "name"=>"scheduler[configs]"}, {"in"=>"query", "name"=>"scheduler[configuredId]", "description"=>"The id as configured in the batch config"}, {"in"=>"query", "name"=>"scheduler[host]", "description"=>"The host name"}, {"in"=>"query", "name"=>"scheduler[name]", "description"=>"The scheduler name"}, {"in"=>"query", "name"=>"scheduler[statuses]"}, {"in"=>"query", "name"=>"scheduler[workers]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batchcontrol", "Action", "ReportStatus"]}}, "/service/batchcontrol/action/setCommandResult"=>{"get"=>{"summary"=>"Get Service Batchcontrol Action Setcommandresult", "description"=>"batch setCommandResult action saves the results of a command as recieved from a remote scheduler", "operationId"=>"batchcontrol.setCommandResult", "x-api-path-slug"=>"servicebatchcontrolactionsetcommandresult-get", "parameters"=>[{"in"=>"query", "name"=>"commandId", "description"=>"The id of the command"}, {"in"=>"query", "name"=>"errorDescription", "description"=>"The description, important for failed commands"}, {"in"=>"query", "name"=>"status", "description"=>"Enum Type: `KalturaControlPanelCommandStatus`The status of the command"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batchcontrol", "Action", "SetCommandResult"]}}, "/service/batchcontrol/action/setSchedulerConfig"=>{"get"=>{"summary"=>"Get Service Batchcontrol Action Setschedulerconfig", "description"=>"batch sets a configuration parameter to be loaded by a scheduler", "operationId"=>"batchcontrol.setSchedulerConfig", "x-api-path-slug"=>"servicebatchcontrolactionsetschedulerconfig-get", "parameters"=>[{"in"=>"query", "name"=>"adminId", "description"=>"The id of the admin that called the setConfig"}, {"in"=>"query", "name"=>"cause", "description"=>"The reason it was changed"}, {"in"=>"query", "name"=>"configParam", "description"=>"The parameter to be set"}, {"in"=>"query", "name"=>"configParamPart", "description"=>"The parameter part to be set - for additional params"}, {"in"=>"query", "name"=>"configValue", "description"=>"The value to be set"}, {"in"=>"query", "name"=>"schedulerId", "description"=>"The id of the remote scheduler location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batchcontrol", "Action", "SetSchedulerConfig"]}}, "/service/batchcontrol/action/setWorkerConfig"=>{"get"=>{"summary"=>"Get Service Batchcontrol Action Setworkerconfig", "description"=>"batch sets a configuration parameter to be loaded by a worker", "operationId"=>"batchcontrol.setWorkerConfig", "x-api-path-slug"=>"servicebatchcontrolactionsetworkerconfig-get", "parameters"=>[{"in"=>"query", "name"=>"adminId", "description"=>"The id of the admin that called the setConfig"}, {"in"=>"query", "name"=>"cause", "description"=>"The reason it was changed"}, {"in"=>"query", "name"=>"configParam", "description"=>"The parameter to be set"}, {"in"=>"query", "name"=>"configParamPart", "description"=>"The parameter part to be set - for additional params"}, {"in"=>"query", "name"=>"configValue", "description"=>"The value to be set"}, {"in"=>"query", "name"=>"workerId", "description"=>"The id of the job to be configured"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batchcontrol", "Action", "SetWorkerConfig"]}}, "/service/batchcontrol/action/startWorker"=>{"get"=>{"summary"=>"Get Service Batchcontrol Action Startworker", "description"=>"batch start action starts a job", "operationId"=>"batchcontrol.startWorker", "x-api-path-slug"=>"servicebatchcontrolactionstartworker-get", "parameters"=>[{"in"=>"query", "name"=>"adminId", "description"=>"The id of the admin that called the start"}, {"in"=>"query", "name"=>"cause", "description"=>"The reason it was started"}, {"in"=>"query", "name"=>"workerId", "description"=>"The id of the job to be started"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batchcontrol", "Action", "StartWorker"]}}, "/service/batchcontrol/action/stopScheduler"=>{"get"=>{"summary"=>"Get Service Batchcontrol Action Stopscheduler", "description"=>"batch stop action stops a scheduler", "operationId"=>"batchcontrol.stopScheduler", "x-api-path-slug"=>"servicebatchcontrolactionstopscheduler-get", "parameters"=>[{"in"=>"query", "name"=>"adminId", "description"=>"The id of the admin that called the stop"}, {"in"=>"query", "name"=>"cause", "description"=>"The reason it was stopped"}, {"in"=>"query", "name"=>"schedulerId", "description"=>"The id of the remote scheduler location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batchcontrol", "Action", "StopScheduler"]}}, "/service/batchcontrol/action/stopWorker"=>{"get"=>{"summary"=>"Get Service Batchcontrol Action Stopworker", "description"=>"batch stop action stops a worker", "operationId"=>"batchcontrol.stopWorker", "x-api-path-slug"=>"servicebatchcontrolactionstopworker-get", "parameters"=>[{"in"=>"query", "name"=>"adminId", "description"=>"The id of the admin that called the stop"}, {"in"=>"query", "name"=>"cause", "description"=>"The reason it was stopped"}, {"in"=>"query", "name"=>"workerId", "description"=>"The id of the job to be stopped"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Batchcontrol", "Action", "StopWorker"]}}, "/service/bulkupload/action/abort"=>{"get"=>{"summary"=>"Get Service Bulkupload Action Abort", "description"=>"Aborts the bulk upload and all its child jobs", "operationId"=>"bulkUpload.abort", "x-api-path-slug"=>"servicebulkuploadactionabort-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"job id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Bulkupload", "Action", "Abort"]}}, "/service/bulkupload/action/add"=>{"post"=>{"summary"=>"Post Service Bulkupload Action Add", "description"=>"Add new bulk upload batch job\n\nConversion profile id can be specified in the API or in the CSV file, the one in the CSV file will be stronger.\n\nIf no conversion profile was specified, partner's default will be used", "operationId"=>"bulkUpload.add", "x-api-path-slug"=>"servicebulkuploadactionadd-post", "parameters"=>[{"in"=>"query", "name"=>"bulkUploadType", "description"=>"Enum Type: `KalturaBulkUploadType`"}, {"in"=>"query", "name"=>"conversionProfileId", "description"=>"Convertion profile id to use for converting the current bulk (-1 to use partners default)"}, {"in"=>"formData", "name"=>"csvFileData", "description"=>"bulk upload file"}, {"in"=>"query", "name"=>"fileName", "description"=>"Friendly name of the file, used to be recognized later in the logs"}, {"in"=>"query", "name"=>"uploadedBy"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Bulkupload", "Action", "Add"]}}, "/service/bulkupload/action/get"=>{"get"=>{"summary"=>"Get Service Bulkupload Action Get", "description"=>"Get bulk upload batch job by id", "operationId"=>"bulkUpload.get", "x-api-path-slug"=>"servicebulkuploadactionget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Bulkupload", "Action", "Get"]}}, "/service/bulkupload/action/list"=>{"get"=>{"summary"=>"Get Service Bulkupload Action List", "description"=>"List bulk upload batch jobs", "operationId"=>"bulkUpload.list", "x-api-path-slug"=>"servicebulkuploadactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Bulkupload", "Action", "List"]}}, "/service/bulkupload/action/serve"=>{"get"=>{"summary"=>"Get Service Bulkupload Action Serve", "description"=>"serve action returan the original file.", "operationId"=>"bulkUpload.serve", "x-api-path-slug"=>"servicebulkuploadactionserve-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"job id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Bulkupload", "Action", "Serve"]}}, "/service/bulkupload/action/serveLog"=>{"get"=>{"summary"=>"Get Service Bulkupload Action Servelog", "description"=>"serveLog action returan the original file.", "operationId"=>"bulkUpload.serveLog", "x-api-path-slug"=>"servicebulkuploadactionservelog-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"job id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Bulkupload", "Action", "ServeLog"]}}, "/service/bulkupload_bulk/action/abort"=>{"get"=>{"summary"=>"Get Service Bulkupload Bulk Action Abort", "description"=>"Aborts the bulk upload and all its child jobs", "operationId"=>"bulk.abort", "x-api-path-slug"=>"servicebulkupload-bulkactionabort-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"job id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Bulkupload", "Bulk", "Action", "Abort"]}}, "/service/bulkupload_bulk/action/get"=>{"get"=>{"summary"=>"Get Service Bulkupload Bulk Action Get", "description"=>"Get bulk upload batch job by id", "operationId"=>"bulk.get", "x-api-path-slug"=>"servicebulkupload-bulkactionget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Bulkupload", "Bulk", "Action", "Get"]}}, "/service/bulkupload_bulk/action/list"=>{"get"=>{"summary"=>"Get Service Bulkupload Bulk Action List", "description"=>"List bulk upload batch jobs", "operationId"=>"bulk.list", "x-api-path-slug"=>"servicebulkupload-bulkactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][field]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][items]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][not]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][value]"}, {"in"=>"query", "name"=>"bulkUploadFilter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"bulkUploadFilter[bulkUploadObjectTypeEqual]", "description"=>"Enum Type: `KalturaBulkUploadObjectType`"}, {"in"=>"query", "name"=>"bulkUploadFilter[bulkUploadObjectTypeIn]"}, {"in"=>"query", "name"=>"bulkUploadFilter[orderBy]"}, {"in"=>"query", "name"=>"bulkUploadFilter[statusEqual]", "description"=>"Enum Type: `KalturaBatchJobStatus`"}, {"in"=>"query", "name"=>"bulkUploadFilter[statusIn]"}, {"in"=>"query", "name"=>"bulkUploadFilter[uploadedOnEqual]"}, {"in"=>"query", "name"=>"bulkUploadFilter[uploadedOnGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"bulkUploadFilter[uploadedOnLessThanOrEqual]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Bulkupload", "Bulk", "Action", "List"]}}, "/service/bulkupload_bulk/action/serve"=>{"get"=>{"summary"=>"Get Service Bulkupload Bulk Action Serve", "description"=>"serve action returns the original file.", "operationId"=>"bulk.serve", "x-api-path-slug"=>"servicebulkupload-bulkactionserve-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"job id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Bulkupload", "Bulk", "Action", "Serve"]}}, "/service/bulkupload_bulk/action/serveLog"=>{"get"=>{"summary"=>"Get Service Bulkupload Bulk Action Servelog", "description"=>"serveLog action returns the log file for the bulk-upload job.", "operationId"=>"bulk.serveLog", "x-api-path-slug"=>"servicebulkupload-bulkactionservelog-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"job id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Bulkupload", "Bulk", "Action", "ServeLog"]}}, "/service/businessprocessnotification_businessprocesscase/action/abort"=>{"get"=>{"summary"=>"Get Service Businessprocessnotification Businessprocesscase Action Abort", "description"=>"Abort business-process case", "operationId"=>"businessProcessCase.abort", "x-api-path-slug"=>"servicebusinessprocessnotification-businessprocesscaseactionabort-get", "parameters"=>[{"in"=>"query", "name"=>"businessProcessStartNotificationTemplateId"}, {"in"=>"query", "name"=>"objectId"}, {"in"=>"query", "name"=>"objectType", "description"=>"Enum Type: `KalturaEventNotificationEventObjectType`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Businessprocessnotification", "Businessprocesscase", "Action", "Abort"]}}, "/service/businessprocessnotification_businessprocesscase/action/list"=>{"get"=>{"summary"=>"Get Service Businessprocessnotification Businessprocesscase Action List", "description"=>"list business-process cases", "operationId"=>"businessProcessCase.list", "x-api-path-slug"=>"servicebusinessprocessnotification-businessprocesscaseactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"objectId"}, {"in"=>"query", "name"=>"objectType", "description"=>"Enum Type: `KalturaEventNotificationEventObjectType`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Businessprocessnotification", "Businessprocesscase", "Action", "List"]}}, "/service/businessprocessnotification_businessprocesscase/action/serveDiagram"=>{"get"=>{"summary"=>"Get Service Businessprocessnotification Businessprocesscase Action Servediagram", "description"=>"Server business-process case diagram", "operationId"=>"businessProcessCase.serveDiagram", "x-api-path-slug"=>"servicebusinessprocessnotification-businessprocesscaseactionservediagram-get", "parameters"=>[{"in"=>"query", "name"=>"businessProcessStartNotificationTemplateId"}, {"in"=>"query", "name"=>"objectId"}, {"in"=>"query", "name"=>"objectType", "description"=>"Enum Type: `KalturaEventNotificationEventObjectType`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Businessprocessnotification", "Businessprocesscase", "Action", "ServeDiagram"]}}, "/service/businessprocessnotification_businessprocessserver/action/add"=>{"get"=>{"summary"=>"Get Service Businessprocessnotification Businessprocessserver Action Add", "description"=>"Allows you to add a new Business-Process server object", "operationId"=>"businessProcessServer.add", "x-api-path-slug"=>"servicebusinessprocessnotification-businessprocessserveractionadd-get", "parameters"=>[{"in"=>"query", "name"=>"businessProcessServer[dc]", "description"=>"The dc of the server"}, {"in"=>"query", "name"=>"businessProcessServer[description]"}, {"in"=>"query", "name"=>"businessProcessServer[host]"}, {"in"=>"query", "name"=>"businessProcessServer[name]"}, {"in"=>"query", "name"=>"businessProcessServer[objectType]"}, {"in"=>"query", "name"=>"businessProcessServer[password]"}, {"in"=>"query", "name"=>"businessProcessServer[port]"}, {"in"=>"query", "name"=>"businessProcessServer[protocol]", "description"=>"Enum Type: `KalturaActivitiBusinessProcessServerProtocol`"}, {"in"=>"query", "name"=>"businessProcessServer[systemName]"}, {"in"=>"query", "name"=>"businessProcessServer[username]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Businessprocessnotification", "Businessprocessserver", "Action", "Add"]}}, "/service/businessprocessnotification_businessprocessserver/action/delete"=>{"get"=>{"summary"=>"Get Service Businessprocessnotification Businessprocessserver Action Delete", "description"=>"Delete an Business-Process server object", "operationId"=>"businessProcessServer.delete", "x-api-path-slug"=>"servicebusinessprocessnotification-businessprocessserveractiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Businessprocessnotification", "Businessprocessserver", "Action", "Delete"]}}, "/service/businessprocessnotification_businessprocessserver/action/get"=>{"get"=>{"summary"=>"Get Service Businessprocessnotification Businessprocessserver Action Get", "description"=>"Retrieve an Business-Process server object by id", "operationId"=>"businessProcessServer.get", "x-api-path-slug"=>"servicebusinessprocessnotification-businessprocessserveractionget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Businessprocessnotification", "Businessprocessserver", "Action", "Get"]}}, "/service/businessprocessnotification_businessprocessserver/action/list"=>{"get"=>{"summary"=>"Get Service Businessprocessnotification Businessprocessserver Action List", "description"=>"list Business-Process server objects", "operationId"=>"businessProcessServer.list", "x-api-path-slug"=>"servicebusinessprocessnotification-businessprocessserveractionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[currentDcOrExternal]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[currentDc]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[dcEqOrNull]"}, {"in"=>"query", "name"=>"filter[dcEqual]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[idNotIn]"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[partnerIdEqual]"}, {"in"=>"query", "name"=>"filter[partnerIdIn]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaBusinessProcessServerStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[statusNotEqual]", "description"=>"Enum Type: `KalturaBusinessProcessServerStatus`"}, {"in"=>"query", "name"=>"filter[statusNotIn]"}, {"in"=>"query", "name"=>"filter[typeEqual]", "description"=>"Enum Type: `KalturaBusinessProcessProvider`"}, {"in"=>"query", "name"=>"filter[typeIn]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Businessprocessnotification", "Businessprocessserver", "Action", "List"]}}, "/service/businessprocessnotification_businessprocessserver/action/update"=>{"get"=>{"summary"=>"Get Service Businessprocessnotification Businessprocessserver Action Update", "description"=>"Update an existing Business-Process server object", "operationId"=>"businessProcessServer.update", "x-api-path-slug"=>"servicebusinessprocessnotification-businessprocessserveractionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"businessProcessServer[dc]", "description"=>"The dc of the server"}, {"in"=>"query", "name"=>"businessProcessServer[description]"}, {"in"=>"query", "name"=>"businessProcessServer[host]"}, {"in"=>"query", "name"=>"businessProcessServer[name]"}, {"in"=>"query", "name"=>"businessProcessServer[objectType]"}, {"in"=>"query", "name"=>"businessProcessServer[password]"}, {"in"=>"query", "name"=>"businessProcessServer[port]"}, {"in"=>"query", "name"=>"businessProcessServer[protocol]", "description"=>"Enum Type: `KalturaActivitiBusinessProcessServerProtocol`"}, {"in"=>"query", "name"=>"businessProcessServer[systemName]"}, {"in"=>"query", "name"=>"businessProcessServer[username]"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Businessprocessnotification", "Businessprocessserver", "Action", "Update"]}}, "/service/businessprocessnotification_businessprocessserver/action/updateStatus"=>{"get"=>{"summary"=>"Get Service Businessprocessnotification Businessprocessserver Action Updatestatus", "description"=>"Update Business-Process server status by id", "operationId"=>"businessProcessServer.updateStatus", "x-api-path-slug"=>"servicebusinessprocessnotification-businessprocessserveractionupdatestatus-get", "parameters"=>[{"in"=>"query", "name"=>"id"}, {"in"=>"query", "name"=>"status", "description"=>"Enum Type: `KalturaBusinessProcessServerStatus`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Businessprocessnotification", "Businessprocessserver", "Action", "UpdateStatus"]}}, "/service/caption_captionasset/action/add"=>{"get"=>{"summary"=>"Get Service Caption Captionasset Action Add", "description"=>"Add caption asset", "operationId"=>"captionAsset.add", "x-api-path-slug"=>"servicecaption-captionassetactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"captionAsset[accuracy]", "description"=>"The Accuracy of the caption content"}, {"in"=>"query", "name"=>"captionAsset[actualSourceAssetParamsIds]", "description"=>"Comma separated list of source flavor params ids"}, {"in"=>"query", "name"=>"captionAsset[captionParamsId]", "description"=>"`insertOnly`The Caption Params used to create this Caption Asset"}, {"in"=>"query", "name"=>"captionAsset[fileExt]", "description"=>"`insertOnly`The file extension"}, {"in"=>"query", "name"=>"captionAsset[format]", "description"=>"`insertOnly`Enum Type: `KalturaCaptionType`The caption format"}, {"in"=>"query", "name"=>"captionAsset[isDefault]", "description"=>"Enum Type: `KalturaNullableBoolean`Is default caption asset of the entry"}, {"in"=>"query", "name"=>"captionAsset[label]", "description"=>"Friendly label"}, {"in"=>"query", "name"=>"captionAsset[language]", "description"=>"Enum Type: `KalturaLanguage`The language of the caption asset content"}, {"in"=>"query", "name"=>"captionAsset[parentId]", "description"=>"`insertOnly`The parent id of the asset"}, {"in"=>"query", "name"=>"captionAsset[partnerData]", "description"=>"Partner private data"}, {"in"=>"query", "name"=>"captionAsset[partnerDescription]", "description"=>"Partner friendly description"}, {"in"=>"query", "name"=>"captionAsset[tags]", "description"=>"Tags used to identify the Flavor Asset in various scenarios"}, {"in"=>"query", "name"=>"entryId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionasset", "Action", "Add"]}}, "/service/caption_captionasset/action/delete"=>{"get"=>{"summary"=>"Get Service Caption Captionasset Action Delete", "description"=>"", "operationId"=>"captionAsset.delete", "x-api-path-slug"=>"servicecaption-captionassetactiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"captionAssetId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionasset", "Action", "Delete"]}}, "/service/caption_captionasset/action/get"=>{"get"=>{"summary"=>"Get Service Caption Captionasset Action Get", "description"=>"", "operationId"=>"captionAsset.get", "x-api-path-slug"=>"servicecaption-captionassetactionget-get", "parameters"=>[{"in"=>"query", "name"=>"captionAssetId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionasset", "Action", "Get"]}}, "/service/caption_captionasset/action/getRemotePaths"=>{"get"=>{"summary"=>"Get Service Caption Captionasset Action Getremotepaths", "description"=>"Get remote storage existing paths for the asset", "operationId"=>"captionAsset.getRemotePaths", "x-api-path-slug"=>"servicecaption-captionassetactiongetremotepaths-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionasset", "Action", "GetRemotePaths"]}}, "/service/caption_captionasset/action/getUrl"=>{"get"=>{"summary"=>"Get Service Caption Captionasset Action Geturl", "description"=>"Get download URL for the asset", "operationId"=>"captionAsset.getUrl", "x-api-path-slug"=>"servicecaption-captionassetactiongeturl-get", "parameters"=>[{"in"=>"query", "name"=>"id"}, {"in"=>"query", "name"=>"storageId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionasset", "Action", "GetUrl"]}}, "/service/caption_captionasset/action/list"=>{"get"=>{"summary"=>"Get Service Caption Captionasset Action List", "description"=>"List caption Assets by filter and pager", "operationId"=>"captionAsset.list", "x-api-path-slug"=>"servicecaption-captionassetactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[captionParamsIdEqual]"}, {"in"=>"query", "name"=>"filter[captionParamsIdIn]"}, {"in"=>"query", "name"=>"filter[contentLike]"}, {"in"=>"query", "name"=>"filter[contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[deletedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[deletedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[entryIdEqual]"}, {"in"=>"query", "name"=>"filter[entryIdIn]"}, {"in"=>"query", "name"=>"filter[flavorParamsIdEqual]"}, {"in"=>"query", "name"=>"filter[flavorParamsIdIn]"}, {"in"=>"query", "name"=>"filter[formatEqual]", "description"=>"Enum Type: `KalturaAttachmentType`"}, {"in"=>"query", "name"=>"filter[formatIn]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[labelEqual]"}, {"in"=>"query", "name"=>"filter[labelIn]"}, {"in"=>"query", "name"=>"filter[languageEqual]", "description"=>"Enum Type: `KalturaLanguage`"}, {"in"=>"query", "name"=>"filter[languageIn]"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[partnerDescriptionLike]"}, {"in"=>"query", "name"=>"filter[partnerDescriptionMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[partnerDescriptionMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[partnerIdEqual]"}, {"in"=>"query", "name"=>"filter[partnerIdIn]"}, {"in"=>"query", "name"=>"filter[sizeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[sizeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[startTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[startTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaAttachmentAssetStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[statusNotIn]"}, {"in"=>"query", "name"=>"filter[tagsLike]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[thumbParamsIdEqual]"}, {"in"=>"query", "name"=>"filter[thumbParamsIdIn]"}, {"in"=>"query", "name"=>"filter[typeIn]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionasset", "Action", "List"]}}, "/service/caption_captionasset/action/serve"=>{"get"=>{"summary"=>"Get Service Caption Captionasset Action Serve", "description"=>"Serves caption by its id", "operationId"=>"captionAsset.serve", "x-api-path-slug"=>"servicecaption-captionassetactionserve-get", "parameters"=>[{"in"=>"query", "name"=>"captionAssetId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionasset", "Action", "Serve"]}}, "/service/caption_captionasset/action/serveByEntryId"=>{"get"=>{"summary"=>"Get Service Caption Captionasset Action Servebyentryid", "description"=>"Serves caption by entry id and thumnail params id", "operationId"=>"captionAsset.serveByEntryId", "x-api-path-slug"=>"servicecaption-captionassetactionservebyentryid-get", "parameters"=>[{"in"=>"query", "name"=>"captionParamId", "description"=>"if not set, default caption will be used"}, {"in"=>"query", "name"=>"entryId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionasset", "Action", "ServeByEntryId"]}}, "/service/caption_captionasset/action/serveWebVTT"=>{"get"=>{"summary"=>"Get Service Caption Captionasset Action Servewebvtt", "description"=>"Serves caption by its id converting it to segmented WebVTT", "operationId"=>"captionAsset.serveWebVTT", "x-api-path-slug"=>"servicecaption-captionassetactionservewebvtt-get", "parameters"=>[{"in"=>"query", "name"=>"captionAssetId"}, {"in"=>"query", "name"=>"localTimestamp"}, {"in"=>"query", "name"=>"segmentDuration"}, {"in"=>"query", "name"=>"segmentIndex"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionasset", "Action", "ServeWebVTT"]}}, "/service/caption_captionasset/action/setAsDefault"=>{"get"=>{"summary"=>"Get Service Caption Captionasset Action Setasdefault", "description"=>"Markss the caption as default and removes that mark from all other caption assets of the entry.", "operationId"=>"captionAsset.setAsDefault", "x-api-path-slug"=>"servicecaption-captionassetactionsetasdefault-get", "parameters"=>[{"in"=>"query", "name"=>"captionAssetId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionasset", "Action", "SetAsDefault"]}}, "/service/caption_captionasset/action/setContent"=>{"post"=>{"summary"=>"Post Service Caption Captionasset Action Setcontent", "description"=>"Update content of caption asset", "operationId"=>"captionAsset.setContent", "x-api-path-slug"=>"servicecaption-captionassetactionsetcontent-post", "parameters"=>[{"in"=>"query", "name"=>"contentResource[assetId]", "description"=>"ID of the source asset"}, {"in"=>"query", "name"=>"contentResource[content]", "description"=>"Textual content"}, {"in"=>"query", "name"=>"contentResource[dropFolderFileId]", "description"=>"Id of the drop folder file object"}, {"in"=>"query", "name"=>"contentResource[entryId]", "description"=>"ID of the source entry"}, {"in"=>"formData", "name"=>"contentResource[fileData]", "description"=>"Represents the $_FILE"}, {"in"=>"query", "name"=>"contentResource[fileSyncObjectType]", "description"=>"The object type of the file sync object"}, {"in"=>"query", "name"=>"contentResource[flavorParamsId]", "description"=>"ID of the source flavor params, set to null to use the source flavor"}, {"in"=>"query", "name"=>"contentResource[forceAsyncDownload]", "description"=>"Force Import Job"}, {"in"=>"query", "name"=>"contentResource[keepOriginalFile]", "description"=>"Should keep original file (false = mv, true = cp)"}, {"in"=>"query", "name"=>"contentResource[keyPassphrase]", "description"=>"Passphrase for SSH keys"}, {"in"=>"query", "name"=>"contentResource[localFilePath]", "description"=>"Full path to the local file"}, {"in"=>"query", "name"=>"contentResource[objectId]", "description"=>"The object id of the file sync object"}, {"in"=>"query", "name"=>"contentResource[objectSubType]", "description"=>"The object sub-type of the file sync object"}, {"in"=>"query", "name"=>"contentResource[objectType]"}, {"in"=>"query", "name"=>"contentResource[privateKey]", "description"=>"SSH private key"}, {"in"=>"query", "name"=>"contentResource[publicKey]", "description"=>"SSH public key"}, {"in"=>"query", "name"=>"contentResource[resources]"}, {"in"=>"query", "name"=>"contentResource[resource][assetId]", "description"=>"ID of the source asset"}, {"in"=>"query", "name"=>"contentResource[resource][content]", "description"=>"Textual content"}, {"in"=>"query", "name"=>"contentResource[resource][dropFolderFileId]", "description"=>"Id of the drop folder file object"}, {"in"=>"query", "name"=>"contentResource[resource][entryId]", "description"=>"ID of the source entry"}, {"in"=>"formData", "name"=>"contentResource[resource][fileData]", "description"=>"Represents the $_FILE"}, {"in"=>"query", "name"=>"contentResource[resource][fileSyncObjectType]", "description"=>"The object type of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][flavorParamsId]", "description"=>"ID of the source flavor params, set to null to use the source flavor"}, {"in"=>"query", "name"=>"contentResource[resource][forceAsyncDownload]", "description"=>"Force Import Job"}, {"in"=>"query", "name"=>"contentResource[resource][keepOriginalFile]", "description"=>"Should keep original file (false = mv, true = cp)"}, {"in"=>"query", "name"=>"contentResource[resource][keyPassphrase]", "description"=>"Passphrase for SSH keys"}, {"in"=>"query", "name"=>"contentResource[resource][localFilePath]", "description"=>"Full path to the local file"}, {"in"=>"query", "name"=>"contentResource[resource][objectId]", "description"=>"The object id of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][objectSubType]", "description"=>"The object sub-type of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][objectType]"}, {"in"=>"query", "name"=>"contentResource[resource][privateKey]", "description"=>"SSH private key"}, {"in"=>"query", "name"=>"contentResource[resource][publicKey]", "description"=>"SSH public key"}, {"in"=>"query", "name"=>"contentResource[resource][resources]"}, {"in"=>"query", "name"=>"contentResource[resource][resource][assetId]", "description"=>"ID of the source asset"}, {"in"=>"query", "name"=>"contentResource[resource][resource][content]", "description"=>"Textual content"}, {"in"=>"query", "name"=>"contentResource[resource][resource][dropFolderFileId]", "description"=>"Id of the drop folder file object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][entryId]", "description"=>"ID of the source entry"}, {"in"=>"formData", "name"=>"contentResource[resource][resource][fileData]", "description"=>"Represents the $_FILE"}, {"in"=>"query", "name"=>"contentResource[resource][resource][fileSyncObjectType]", "description"=>"The object type of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][flavorParamsId]", "description"=>"ID of the source flavor params, set to null to use the source flavor"}, {"in"=>"query", "name"=>"contentResource[resource][resource][forceAsyncDownload]", "description"=>"Force Import Job"}, {"in"=>"query", "name"=>"contentResource[resource][resource][keepOriginalFile]", "description"=>"Should keep original file (false = mv, true = cp)"}, {"in"=>"query", "name"=>"contentResource[resource][resource][keyPassphrase]", "description"=>"Passphrase for SSH keys"}, {"in"=>"query", "name"=>"contentResource[resource][resource][localFilePath]", "description"=>"Full path to the local file"}, {"in"=>"query", "name"=>"contentResource[resource][resource][objectId]", "description"=>"The object id of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][objectSubType]", "description"=>"The object sub-type of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][objectType]"}, {"in"=>"query", "name"=>"contentResource[resource][resource][privateKey]", "description"=>"SSH private key"}, {"in"=>"query", "name"=>"contentResource[resource][resource][publicKey]", "description"=>"SSH public key"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resources]"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][assetId]", "description"=>"ID of the source asset"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][content]", "description"=>"Textual content"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][dropFolderFileId]", "description"=>"Id of the drop folder file object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][entryId]", "description"=>"ID of the source entry"}, {"in"=>"formData", "name"=>"contentResource[resource][resource][resource][fileData]", "description"=>"Represents the $_FILE"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][fileSyncObjectType]", "description"=>"The object type of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][flavorParamsId]", "description"=>"ID of the source flavor params, set to null to use the source flavor"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][forceAsyncDownload]", "description"=>"Force Import Job"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][keepOriginalFile]", "description"=>"Should keep original file (false = mv, true = cp)"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][keyPassphrase]", "description"=>"Passphrase for SSH keys"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][localFilePath]", "description"=>"Full path to the local file"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][objectId]", "description"=>"The object id of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][objectSubType]", "description"=>"The object sub-type of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][objectType]"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][privateKey]", "description"=>"SSH private key"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][publicKey]", "description"=>"SSH public key"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][resources]"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][storageProfileId]", "description"=>"ID of storage profile to be associated with the created file sync, used for file serving URL composing"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][token]", "description"=>"Token that returned from upload"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][url]", "description"=>"Remote URL, FTP, HTTP or HTTPS"}, {"in"=>"query", "name"=>"contentResource[resource][resource][resource][version]", "description"=>"The version of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][resource][storageProfileId]", "description"=>"ID of storage profile to be associated with the created file sync, used for file serving URL composing"}, {"in"=>"query", "name"=>"contentResource[resource][resource][token]", "description"=>"Token that returned from upload"}, {"in"=>"query", "name"=>"contentResource[resource][resource][url]", "description"=>"Remote URL, FTP, HTTP or HTTPS"}, {"in"=>"query", "name"=>"contentResource[resource][resource][version]", "description"=>"The version of the file sync object"}, {"in"=>"query", "name"=>"contentResource[resource][storageProfileId]", "description"=>"ID of storage profile to be associated with the created file sync, used for file serving URL composing"}, {"in"=>"query", "name"=>"contentResource[resource][token]", "description"=>"Token that returned from upload"}, {"in"=>"query", "name"=>"contentResource[resource][url]", "description"=>"Remote URL, FTP, HTTP or HTTPS"}, {"in"=>"query", "name"=>"contentResource[resource][version]", "description"=>"The version of the file sync object"}, {"in"=>"query", "name"=>"contentResource[storageProfileId]", "description"=>"ID of storage profile to be associated with the created file sync, used for file serving URL composing"}, {"in"=>"query", "name"=>"contentResource[token]", "description"=>"Token that returned from upload"}, {"in"=>"query", "name"=>"contentResource[url]", "description"=>"Remote URL, FTP, HTTP or HTTPS"}, {"in"=>"query", "name"=>"contentResource[version]", "description"=>"The version of the file sync object"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionasset", "Action", "SetContent"]}}, "/service/caption_captionasset/action/update"=>{"get"=>{"summary"=>"Get Service Caption Captionasset Action Update", "description"=>"Update caption asset", "operationId"=>"captionAsset.update", "x-api-path-slug"=>"servicecaption-captionassetactionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"captionAsset[accuracy]", "description"=>"The Accuracy of the caption content"}, {"in"=>"query", "name"=>"captionAsset[actualSourceAssetParamsIds]", "description"=>"Comma separated list of source flavor params ids"}, {"in"=>"query", "name"=>"captionAsset[captionParamsId]", "description"=>"`insertOnly`The Caption Params used to create this Caption Asset"}, {"in"=>"query", "name"=>"captionAsset[fileExt]", "description"=>"`insertOnly`The file extension"}, {"in"=>"query", "name"=>"captionAsset[format]", "description"=>"`insertOnly`Enum Type: `KalturaCaptionType`The caption format"}, {"in"=>"query", "name"=>"captionAsset[isDefault]", "description"=>"Enum Type: `KalturaNullableBoolean`Is default caption asset of the entry"}, {"in"=>"query", "name"=>"captionAsset[label]", "description"=>"Friendly label"}, {"in"=>"query", "name"=>"captionAsset[language]", "description"=>"Enum Type: `KalturaLanguage`The language of the caption asset content"}, {"in"=>"query", "name"=>"captionAsset[parentId]", "description"=>"`insertOnly`The parent id of the asset"}, {"in"=>"query", "name"=>"captionAsset[partnerData]", "description"=>"Partner private data"}, {"in"=>"query", "name"=>"captionAsset[partnerDescription]", "description"=>"Partner friendly description"}, {"in"=>"query", "name"=>"captionAsset[tags]", "description"=>"Tags used to identify the Flavor Asset in various scenarios"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionasset", "Action", "Update"]}}, "/service/caption_captionparams/action/add"=>{"get"=>{"summary"=>"Get Service Caption Captionparams Action Add", "description"=>"Add new Caption Params", "operationId"=>"captionParams.add", "x-api-path-slug"=>"servicecaption-captionparamsactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"captionParams[description]", "description"=>"The description of the Flavor Params"}, {"in"=>"query", "name"=>"captionParams[format]", "description"=>"`insertOnly`Enum Type: `KalturaCaptionType`The caption format"}, {"in"=>"query", "name"=>"captionParams[isDefault]", "description"=>"Enum Type: `KalturaNullableBoolean`Is default caption asset of the entry"}, {"in"=>"query", "name"=>"captionParams[label]", "description"=>"Friendly label"}, {"in"=>"query", "name"=>"captionParams[language]", "description"=>"`insertOnly`Enum Type: `KalturaLanguage`The language of the caption content"}, {"in"=>"query", "name"=>"captionParams[mediaParserType]", "description"=>"Enum Type: `KalturaMediaParserType`Media parser type to be used for post-conversion validation"}, {"in"=>"query", "name"=>"captionParams[name]", "description"=>"The name of the Flavor Params"}, {"in"=>"query", "name"=>"captionParams[partnerId]"}, {"in"=>"query", "name"=>"captionParams[remoteStorageProfileIds]", "description"=>"Comma seperated ids of remote storage profiles that the flavor distributed to, the distribution done by the conversion engine"}, {"in"=>"query", "name"=>"captionParams[requiredPermissions]"}, {"in"=>"query", "name"=>"captionParams[sourceAssetParamsIds]", "description"=>"Comma seperated ids of source flavor params this flavor is created from"}, {"in"=>"query", "name"=>"captionParams[sourceParamsId]", "description"=>"Id of the caption params or the flavor params to be used as source for the caption creation"}, {"in"=>"query", "name"=>"captionParams[sourceRemoteStorageProfileId]", "description"=>"Id of remote storage profile that used to get the source, zero indicates Kaltura data center"}, {"in"=>"query", "name"=>"captionParams[systemName]", "description"=>"System name of the Flavor Params"}, {"in"=>"query", "name"=>"captionParams[tags]", "description"=>"The Flavor Params tags are used to identify the flavor for different usage (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionparams", "Action", "Add"]}}, "/service/caption_captionparams/action/delete"=>{"get"=>{"summary"=>"Get Service Caption Captionparams Action Delete", "description"=>"Delete Caption Params by ID", "operationId"=>"captionParams.delete", "x-api-path-slug"=>"servicecaption-captionparamsactiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionparams", "Action", "Delete"]}}, "/service/caption_captionparams/action/get"=>{"get"=>{"summary"=>"Get Service Caption Captionparams Action Get", "description"=>"Get Caption Params by ID", "operationId"=>"captionParams.get", "x-api-path-slug"=>"servicecaption-captionparamsactionget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionparams", "Action", "Get"]}}, "/service/caption_captionparams/action/list"=>{"get"=>{"summary"=>"Get Service Caption Captionparams Action List", "description"=>"List Caption Params by filter with paging support (By default - all system default params will be listed too)", "operationId"=>"captionParams.list", "x-api-path-slug"=>"servicecaption-captionparamsactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[formatEqual]", "description"=>"Enum Type: `KalturaCaptionType`"}, {"in"=>"query", "name"=>"filter[formatIn]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[isSystemDefaultEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[systemNameEqual]"}, {"in"=>"query", "name"=>"filter[systemNameIn]"}, {"in"=>"query", "name"=>"filter[tagsEqual]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionparams", "Action", "List"]}}, "/service/caption_captionparams/action/update"=>{"get"=>{"summary"=>"Get Service Caption Captionparams Action Update", "description"=>"Update Caption Params by ID", "operationId"=>"captionParams.update", "x-api-path-slug"=>"servicecaption-captionparamsactionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"captionParams[description]", "description"=>"The description of the Flavor Params"}, {"in"=>"query", "name"=>"captionParams[format]", "description"=>"`insertOnly`Enum Type: `KalturaCaptionType`The caption format"}, {"in"=>"query", "name"=>"captionParams[isDefault]", "description"=>"Enum Type: `KalturaNullableBoolean`Is default caption asset of the entry"}, {"in"=>"query", "name"=>"captionParams[label]", "description"=>"Friendly label"}, {"in"=>"query", "name"=>"captionParams[language]", "description"=>"`insertOnly`Enum Type: `KalturaLanguage`The language of the caption content"}, {"in"=>"query", "name"=>"captionParams[mediaParserType]", "description"=>"Enum Type: `KalturaMediaParserType`Media parser type to be used for post-conversion validation"}, {"in"=>"query", "name"=>"captionParams[name]", "description"=>"The name of the Flavor Params"}, {"in"=>"query", "name"=>"captionParams[partnerId]"}, {"in"=>"query", "name"=>"captionParams[remoteStorageProfileIds]", "description"=>"Comma seperated ids of remote storage profiles that the flavor distributed to, the distribution done by the conversion engine"}, {"in"=>"query", "name"=>"captionParams[requiredPermissions]"}, {"in"=>"query", "name"=>"captionParams[sourceAssetParamsIds]", "description"=>"Comma seperated ids of source flavor params this flavor is created from"}, {"in"=>"query", "name"=>"captionParams[sourceParamsId]", "description"=>"Id of the caption params or the flavor params to be used as source for the caption creation"}, {"in"=>"query", "name"=>"captionParams[sourceRemoteStorageProfileId]", "description"=>"Id of remote storage profile that used to get the source, zero indicates Kaltura data center"}, {"in"=>"query", "name"=>"captionParams[systemName]", "description"=>"System name of the Flavor Params"}, {"in"=>"query", "name"=>"captionParams[tags]", "description"=>"The Flavor Params tags are used to identify the flavor for different usage (e"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Caption", "Captionparams", "Action", "Update"]}}, "/service/captionsearch_captionassetitem/action/parse"=>{"get"=>{"summary"=>"Get Service Captionsearch Captionassetitem Action Parse", "description"=>"Parse content of caption asset and index it", "operationId"=>"captionAssetItem.parse", "x-api-path-slug"=>"servicecaptionsearch-captionassetitemactionparse-get", "parameters"=>[{"in"=>"query", "name"=>"captionAssetId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Captionsearch", "Captionassetitem", "Action", "Parse"]}}, "/service/captionsearch_captionassetitem/action/search"=>{"get"=>{"summary"=>"Get Service Captionsearch Captionassetitem Action Search", "description"=>"Search caption asset items by filter, pager and free text", "operationId"=>"captionAssetItem.search", "x-api-path-slug"=>"servicecaptionsearch-captionassetitemactionsearch-get", "parameters"=>[{"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][field]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][items]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][not]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][value]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[captionParamsIdEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[captionParamsIdIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[contentLike]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[contentMultiLikeOr]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[deletedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[deletedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[endTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[endTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[entryIdEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[entryIdIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[formatEqual]", "description"=>"Enum Type: `KalturaCaptionType`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[formatIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[idEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[idIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[labelEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[labelIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[languageEqual]", "description"=>"Enum Type: `KalturaLanguage`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[languageIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[orderBy]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[partnerDescriptionLike]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[partnerDescriptionMultiLikeAnd]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[partnerDescriptionMultiLikeOr]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[partnerIdEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[partnerIdIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[sizeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[sizeLessThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[startTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[startTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[statusEqual]", "description"=>"Enum Type: `KalturaCaptionAssetStatus`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[statusIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[statusNotIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[tagsLike]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[tagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[tagsMultiLikeOr]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[typeIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemPager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"captionAssetItemPager[pageSize]", "description"=>"The number of objects to retrieve"}, {"in"=>"query", "name"=>"entryFilter[accessControlIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[accessControlIdIn]"}, {"in"=>"query", "name"=>"entryFilter[adminTagsLike]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[adminTagsMultiLikeAnd]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[adminTagsMultiLikeOr]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][field]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][items]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][not]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][value]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"entryFilter[assetParamsIdsMatchAnd]"}, {"in"=>"query", "name"=>"entryFilter[assetParamsIdsMatchOr]"}, {"in"=>"query", "name"=>"entryFilter[categoriesFullNameIn]"}, {"in"=>"query", "name"=>"entryFilter[categoriesIdsEmpty]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entryFilter[categoriesIdsMatchAnd]"}, {"in"=>"query", "name"=>"entryFilter[categoriesIdsMatchOr]", "description"=>"All entries of the categories, excluding their child categories"}, {"in"=>"query", "name"=>"entryFilter[categoriesIdsNotContains]"}, {"in"=>"query", "name"=>"entryFilter[categoriesMatchAnd]"}, {"in"=>"query", "name"=>"entryFilter[categoriesMatchOr]", "description"=>"All entries within these categories or their child categories"}, {"in"=>"query", "name"=>"entryFilter[categoriesNotContains]"}, {"in"=>"query", "name"=>"entryFilter[categoryAncestorIdIn]", "description"=>"All entries within this categoy or in child categories"}, {"in"=>"query", "name"=>"entryFilter[createdAtGreaterThanOrEqual]", "description"=>"This filter parameter should be in use for retrieving only entries which were created at Kaltura system after a specific time/date (standard timestamp format)"}, {"in"=>"query", "name"=>"entryFilter[createdAtLessThanOrEqual]", "description"=>"This filter parameter should be in use for retrieving only entries which were created at Kaltura system before a specific time/date (standard timestamp format)"}, {"in"=>"query", "name"=>"entryFilter[creatorIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[documentTypeEqual]", "description"=>"Enum Type: `KalturaDocumentType`"}, {"in"=>"query", "name"=>"entryFilter[documentTypeIn]"}, {"in"=>"query", "name"=>"entryFilter[durationGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[durationGreaterThan]"}, {"in"=>"query", "name"=>"entryFilter[durationLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[durationLessThan]"}, {"in"=>"query", "name"=>"entryFilter[durationTypeMatchOr]"}, {"in"=>"query", "name"=>"entryFilter[endDateGreaterThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"entryFilter[endDateGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[endDateLessThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"entryFilter[endDateLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[entitledUsersEditMatchAnd]"}, {"in"=>"query", "name"=>"entryFilter[entitledUsersEditMatchOr]"}, {"in"=>"query", "name"=>"entryFilter[entitledUsersPublishMatchAnd]"}, {"in"=>"query", "name"=>"entryFilter[entitledUsersPublishMatchOr]"}, {"in"=>"query", "name"=>"entryFilter[externalSourceTypeEqual]", "description"=>"Enum Type: `KalturaExternalMediaSourceType`"}, {"in"=>"query", "name"=>"entryFilter[externalSourceTypeIn]"}, {"in"=>"query", "name"=>"entryFilter[flavorParamsIdsMatchAnd]"}, {"in"=>"query", "name"=>"entryFilter[flavorParamsIdsMatchOr]"}, {"in"=>"query", "name"=>"entryFilter[freeText]"}, {"in"=>"query", "name"=>"entryFilter[groupIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[hasMediaServerHostname]"}, {"in"=>"query", "name"=>"entryFilter[idEqual]", "description"=>"This filter should be in use for retrieving only a specific entry (identified by its entryId)"}, {"in"=>"query", "name"=>"entryFilter[idIn]", "description"=>"This filter should be in use for retrieving few specific entries (string should include comma separated list of entryId strings)"}, {"in"=>"query", "name"=>"entryFilter[idNotIn]"}, {"in"=>"query", "name"=>"entryFilter[isLive]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entryFilter[isRecordedEntryIdEmpty]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entryFilter[isRoot]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entryFilter[lastPlayedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[lastPlayedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[limit]"}, {"in"=>"query", "name"=>"entryFilter[mediaDateGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[mediaDateLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[mediaTypeEqual]", "description"=>"Enum Type: `KalturaMediaType`"}, {"in"=>"query", "name"=>"entryFilter[mediaTypeIn]"}, {"in"=>"query", "name"=>"entryFilter[moderationStatusEqual]", "description"=>"Enum Type: `KalturaEntryModerationStatus`"}, {"in"=>"query", "name"=>"entryFilter[moderationStatusIn]"}, {"in"=>"query", "name"=>"entryFilter[moderationStatusNotEqual]", "description"=>"Enum Type: `KalturaEntryModerationStatus`"}, {"in"=>"query", "name"=>"entryFilter[moderationStatusNotIn]"}, {"in"=>"query", "name"=>"entryFilter[nameEqual]", "description"=>"This filter should be in use for retrieving entries with a specific name"}, {"in"=>"query", "name"=>"entryFilter[nameLike]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[nameMultiLikeAnd]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[nameMultiLikeOr]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[objectType]"}, {"in"=>"query", "name"=>"entryFilter[orderBy]"}, {"in"=>"query", "name"=>"entryFilter[parentEntryIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[partnerIdEqual]", "description"=>"This filter should be in use for retrieving only entries which were uploaded by/assigned to users of a specific Kaltura Partner (identified by Partner ID)"}, {"in"=>"query", "name"=>"entryFilter[partnerIdIn]", "description"=>"This filter should be in use for retrieving only entries within Kaltura network which were uploaded by/assigned to users of few Kaltura Partners (string should include comma separated list of PartnerIDs)"}, {"in"=>"query", "name"=>"entryFilter[partnerSortValueGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[partnerSortValueLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[redirectFromEntryId]", "description"=>"The id of the original entry"}, {"in"=>"query", "name"=>"entryFilter[referenceIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[referenceIdIn]"}, {"in"=>"query", "name"=>"entryFilter[replacedEntryIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[replacedEntryIdIn]"}, {"in"=>"query", "name"=>"entryFilter[replacementStatusEqual]", "description"=>"Enum Type: `KalturaEntryReplacementStatus`"}, {"in"=>"query", "name"=>"entryFilter[replacementStatusIn]"}, {"in"=>"query", "name"=>"entryFilter[replacingEntryIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[replacingEntryIdIn]"}, {"in"=>"query", "name"=>"entryFilter[rootEntryIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[rootEntryIdIn]"}, {"in"=>"query", "name"=>"entryFilter[searchTextMatchAnd]", "description"=>"This filter should be in use for retrieving specific entries while search match the input string within all of the following metadata attributes: name, description, tags, adminTags"}, {"in"=>"query", "name"=>"entryFilter[searchTextMatchOr]", "description"=>"This filter should be in use for retrieving specific entries while search match the input string within at least one of the following metadata attributes: name, description, tags, adminTags"}, {"in"=>"query", "name"=>"entryFilter[sourceTypeEqual]", "description"=>"Enum Type: `KalturaSourceType`"}, {"in"=>"query", "name"=>"entryFilter[sourceTypeIn]"}, {"in"=>"query", "name"=>"entryFilter[sourceTypeNotEqual]", "description"=>"Enum Type: `KalturaSourceType`"}, {"in"=>"query", "name"=>"entryFilter[sourceTypeNotIn]"}, {"in"=>"query", "name"=>"entryFilter[startDateGreaterThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"entryFilter[startDateGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[startDateLessThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"entryFilter[startDateLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[statusEqual]", "description"=>"Enum Type: `KalturaEntryStatus`This filter should be in use for retrieving only entries, at a specific {"}, {"in"=>"query", "name"=>"entryFilter[statusIn]", "description"=>"This filter should be in use for retrieving only entries, at few specific {"}, {"in"=>"query", "name"=>"entryFilter[statusNotEqual]", "description"=>"Enum Type: `KalturaEntryStatus`This filter should be in use for retrieving only entries, not at a specific {"}, {"in"=>"query", "name"=>"entryFilter[statusNotIn]", "description"=>"This filter should be in use for retrieving only entries, not at few specific {"}, {"in"=>"query", "name"=>"entryFilter[tagsAdminTagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"entryFilter[tagsAdminTagsMultiLikeOr]"}, {"in"=>"query", "name"=>"entryFilter[tagsAdminTagsNameMultiLikeAnd]"}, {"in"=>"query", "name"=>"entryFilter[tagsAdminTagsNameMultiLikeOr]"}, {"in"=>"query", "name"=>"entryFilter[tagsLike]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[tagsMultiLikeAnd]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[tagsMultiLikeOr]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[tagsNameMultiLikeAnd]"}, {"in"=>"query", "name"=>"entryFilter[tagsNameMultiLikeOr]"}, {"in"=>"query", "name"=>"entryFilter[totalRankGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[totalRankLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[typeEqual]", "description"=>"Enum Type: `KalturaEntryType`"}, {"in"=>"query", "name"=>"entryFilter[typeIn]", "description"=>"This filter should be in use for retrieving entries of few {"}, {"in"=>"query", "name"=>"entryFilter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[userIdEqual]", "description"=>"This filter parameter should be in use for retrieving only entries, uploaded by/assigned to a specific user (identified by user Id)"}, {"in"=>"query", "name"=>"entryFilter[userIdIn]"}, {"in"=>"query", "name"=>"entryFilter[userIdNotIn]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Captionsearch", "Captionassetitem", "Action", "Search"]}}, "/service/captionsearch_captionassetitem/action/searchEntries"=>{"get"=>{"summary"=>"Get Service Captionsearch Captionassetitem Action Searchentries", "description"=>"Search caption asset items by filter, pager and free text", "operationId"=>"captionAssetItem.searchEntries", "x-api-path-slug"=>"servicecaptionsearch-captionassetitemactionsearchentries-get", "parameters"=>[{"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][field]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][items]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][not]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][value]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[captionParamsIdEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[captionParamsIdIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[contentLike]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[contentMultiLikeOr]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[deletedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[deletedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[endTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[endTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[entryIdEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[entryIdIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[formatEqual]", "description"=>"Enum Type: `KalturaCaptionType`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[formatIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[idEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[idIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[labelEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[labelIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[languageEqual]", "description"=>"Enum Type: `KalturaLanguage`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[languageIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[orderBy]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[partnerDescriptionLike]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[partnerDescriptionMultiLikeAnd]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[partnerDescriptionMultiLikeOr]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[partnerIdEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[partnerIdIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[sizeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[sizeLessThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[startTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[startTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[statusEqual]", "description"=>"Enum Type: `KalturaCaptionAssetStatus`"}, {"in"=>"query", "name"=>"captionAssetItemFilter[statusIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[statusNotIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[tagsLike]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[tagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[tagsMultiLikeOr]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[typeIn]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemFilter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"captionAssetItemPager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"captionAssetItemPager[pageSize]", "description"=>"The number of objects to retrieve"}, {"in"=>"query", "name"=>"entryFilter[accessControlIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[accessControlIdIn]"}, {"in"=>"query", "name"=>"entryFilter[adminTagsLike]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[adminTagsMultiLikeAnd]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[adminTagsMultiLikeOr]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][field]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][items]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][not]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][value]"}, {"in"=>"query", "name"=>"entryFilter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"entryFilter[assetParamsIdsMatchAnd]"}, {"in"=>"query", "name"=>"entryFilter[assetParamsIdsMatchOr]"}, {"in"=>"query", "name"=>"entryFilter[categoriesFullNameIn]"}, {"in"=>"query", "name"=>"entryFilter[categoriesIdsEmpty]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entryFilter[categoriesIdsMatchAnd]"}, {"in"=>"query", "name"=>"entryFilter[categoriesIdsMatchOr]", "description"=>"All entries of the categories, excluding their child categories"}, {"in"=>"query", "name"=>"entryFilter[categoriesIdsNotContains]"}, {"in"=>"query", "name"=>"entryFilter[categoriesMatchAnd]"}, {"in"=>"query", "name"=>"entryFilter[categoriesMatchOr]", "description"=>"All entries within these categories or their child categories"}, {"in"=>"query", "name"=>"entryFilter[categoriesNotContains]"}, {"in"=>"query", "name"=>"entryFilter[categoryAncestorIdIn]", "description"=>"All entries within this categoy or in child categories"}, {"in"=>"query", "name"=>"entryFilter[createdAtGreaterThanOrEqual]", "description"=>"This filter parameter should be in use for retrieving only entries which were created at Kaltura system after a specific time/date (standard timestamp format)"}, {"in"=>"query", "name"=>"entryFilter[createdAtLessThanOrEqual]", "description"=>"This filter parameter should be in use for retrieving only entries which were created at Kaltura system before a specific time/date (standard timestamp format)"}, {"in"=>"query", "name"=>"entryFilter[creatorIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[documentTypeEqual]", "description"=>"Enum Type: `KalturaDocumentType`"}, {"in"=>"query", "name"=>"entryFilter[documentTypeIn]"}, {"in"=>"query", "name"=>"entryFilter[durationGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[durationGreaterThan]"}, {"in"=>"query", "name"=>"entryFilter[durationLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[durationLessThan]"}, {"in"=>"query", "name"=>"entryFilter[durationTypeMatchOr]"}, {"in"=>"query", "name"=>"entryFilter[endDateGreaterThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"entryFilter[endDateGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[endDateLessThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"entryFilter[endDateLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[entitledUsersEditMatchAnd]"}, {"in"=>"query", "name"=>"entryFilter[entitledUsersEditMatchOr]"}, {"in"=>"query", "name"=>"entryFilter[entitledUsersPublishMatchAnd]"}, {"in"=>"query", "name"=>"entryFilter[entitledUsersPublishMatchOr]"}, {"in"=>"query", "name"=>"entryFilter[externalSourceTypeEqual]", "description"=>"Enum Type: `KalturaExternalMediaSourceType`"}, {"in"=>"query", "name"=>"entryFilter[externalSourceTypeIn]"}, {"in"=>"query", "name"=>"entryFilter[flavorParamsIdsMatchAnd]"}, {"in"=>"query", "name"=>"entryFilter[flavorParamsIdsMatchOr]"}, {"in"=>"query", "name"=>"entryFilter[freeText]"}, {"in"=>"query", "name"=>"entryFilter[groupIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[hasMediaServerHostname]"}, {"in"=>"query", "name"=>"entryFilter[idEqual]", "description"=>"This filter should be in use for retrieving only a specific entry (identified by its entryId)"}, {"in"=>"query", "name"=>"entryFilter[idIn]", "description"=>"This filter should be in use for retrieving few specific entries (string should include comma separated list of entryId strings)"}, {"in"=>"query", "name"=>"entryFilter[idNotIn]"}, {"in"=>"query", "name"=>"entryFilter[isLive]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entryFilter[isRecordedEntryIdEmpty]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entryFilter[isRoot]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"entryFilter[lastPlayedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[lastPlayedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[limit]"}, {"in"=>"query", "name"=>"entryFilter[mediaDateGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[mediaDateLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[mediaTypeEqual]", "description"=>"Enum Type: `KalturaMediaType`"}, {"in"=>"query", "name"=>"entryFilter[mediaTypeIn]"}, {"in"=>"query", "name"=>"entryFilter[moderationStatusEqual]", "description"=>"Enum Type: `KalturaEntryModerationStatus`"}, {"in"=>"query", "name"=>"entryFilter[moderationStatusIn]"}, {"in"=>"query", "name"=>"entryFilter[moderationStatusNotEqual]", "description"=>"Enum Type: `KalturaEntryModerationStatus`"}, {"in"=>"query", "name"=>"entryFilter[moderationStatusNotIn]"}, {"in"=>"query", "name"=>"entryFilter[nameEqual]", "description"=>"This filter should be in use for retrieving entries with a specific name"}, {"in"=>"query", "name"=>"entryFilter[nameLike]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[nameMultiLikeAnd]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[nameMultiLikeOr]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[objectType]"}, {"in"=>"query", "name"=>"entryFilter[orderBy]"}, {"in"=>"query", "name"=>"entryFilter[parentEntryIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[partnerIdEqual]", "description"=>"This filter should be in use for retrieving only entries which were uploaded by/assigned to users of a specific Kaltura Partner (identified by Partner ID)"}, {"in"=>"query", "name"=>"entryFilter[partnerIdIn]", "description"=>"This filter should be in use for retrieving only entries within Kaltura network which were uploaded by/assigned to users of few Kaltura Partners (string should include comma separated list of PartnerIDs)"}, {"in"=>"query", "name"=>"entryFilter[partnerSortValueGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[partnerSortValueLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[redirectFromEntryId]", "description"=>"The id of the original entry"}, {"in"=>"query", "name"=>"entryFilter[referenceIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[referenceIdIn]"}, {"in"=>"query", "name"=>"entryFilter[replacedEntryIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[replacedEntryIdIn]"}, {"in"=>"query", "name"=>"entryFilter[replacementStatusEqual]", "description"=>"Enum Type: `KalturaEntryReplacementStatus`"}, {"in"=>"query", "name"=>"entryFilter[replacementStatusIn]"}, {"in"=>"query", "name"=>"entryFilter[replacingEntryIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[replacingEntryIdIn]"}, {"in"=>"query", "name"=>"entryFilter[rootEntryIdEqual]"}, {"in"=>"query", "name"=>"entryFilter[rootEntryIdIn]"}, {"in"=>"query", "name"=>"entryFilter[searchTextMatchAnd]", "description"=>"This filter should be in use for retrieving specific entries while search match the input string within all of the following metadata attributes: name, description, tags, adminTags"}, {"in"=>"query", "name"=>"entryFilter[searchTextMatchOr]", "description"=>"This filter should be in use for retrieving specific entries while search match the input string within at least one of the following metadata attributes: name, description, tags, adminTags"}, {"in"=>"query", "name"=>"entryFilter[sourceTypeEqual]", "description"=>"Enum Type: `KalturaSourceType`"}, {"in"=>"query", "name"=>"entryFilter[sourceTypeIn]"}, {"in"=>"query", "name"=>"entryFilter[sourceTypeNotEqual]", "description"=>"Enum Type: `KalturaSourceType`"}, {"in"=>"query", "name"=>"entryFilter[sourceTypeNotIn]"}, {"in"=>"query", "name"=>"entryFilter[startDateGreaterThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"entryFilter[startDateGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[startDateLessThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"entryFilter[startDateLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[statusEqual]", "description"=>"Enum Type: `KalturaEntryStatus`This filter should be in use for retrieving only entries, at a specific {"}, {"in"=>"query", "name"=>"entryFilter[statusIn]", "description"=>"This filter should be in use for retrieving only entries, at few specific {"}, {"in"=>"query", "name"=>"entryFilter[statusNotEqual]", "description"=>"Enum Type: `KalturaEntryStatus`This filter should be in use for retrieving only entries, not at a specific {"}, {"in"=>"query", "name"=>"entryFilter[statusNotIn]", "description"=>"This filter should be in use for retrieving only entries, not at few specific {"}, {"in"=>"query", "name"=>"entryFilter[tagsAdminTagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"entryFilter[tagsAdminTagsMultiLikeOr]"}, {"in"=>"query", "name"=>"entryFilter[tagsAdminTagsNameMultiLikeAnd]"}, {"in"=>"query", "name"=>"entryFilter[tagsAdminTagsNameMultiLikeOr]"}, {"in"=>"query", "name"=>"entryFilter[tagsLike]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[tagsMultiLikeAnd]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[tagsMultiLikeOr]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"entryFilter[tagsNameMultiLikeAnd]"}, {"in"=>"query", "name"=>"entryFilter[tagsNameMultiLikeOr]"}, {"in"=>"query", "name"=>"entryFilter[totalRankGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[totalRankLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[typeEqual]", "description"=>"Enum Type: `KalturaEntryType`"}, {"in"=>"query", "name"=>"entryFilter[typeIn]", "description"=>"This filter should be in use for retrieving entries of few {"}, {"in"=>"query", "name"=>"entryFilter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"entryFilter[userIdEqual]", "description"=>"This filter parameter should be in use for retrieving only entries, uploaded by/assigned to a specific user (identified by user Id)"}, {"in"=>"query", "name"=>"entryFilter[userIdIn]"}, {"in"=>"query", "name"=>"entryFilter[userIdNotIn]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Captionsearch", "Captionassetitem", "Action", "SearchEntries"]}}, "/service/capturespace_capturespace/action/clientUpdates"=>{"get"=>{"summary"=>"Get Service Capturespace Capturespace Action Clientupdates", "description"=>"Returns latest version and URL", "operationId"=>"captureSpace.clientUpdates", "x-api-path-slug"=>"servicecapturespace-capturespaceactionclientupdates-get", "parameters"=>[{"in"=>"query", "name"=>"hashAlgorithm", "description"=>"Enum Type: `KalturaCaptureSpaceHashAlgorithm`"}, {"in"=>"query", "name"=>"os"}, {"in"=>"query", "name"=>"version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Capturespace", "Capturespace", "Action", "Clients"]}}, "/service/capturespace_capturespace/action/serveInstall"=>{"get"=>{"summary"=>"Get Service Capturespace Capturespace Action Serveinstall", "description"=>"Serve installation file", "operationId"=>"captureSpace.serveInstall", "x-api-path-slug"=>"servicecapturespace-capturespaceactionserveinstall-get", "parameters"=>[{"in"=>"query", "name"=>"os"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Capturespace", "Capturespace", "Action", "ServeInstall"]}}, "/service/capturespace_capturespace/action/serveUpdate"=>{"get"=>{"summary"=>"Get Service Capturespace Capturespace Action Serveupdate", "description"=>"Serve update file", "operationId"=>"captureSpace.serveUpdate", "x-api-path-slug"=>"servicecapturespace-capturespaceactionserveupdate-get", "parameters"=>[{"in"=>"query", "name"=>"os"}, {"in"=>"query", "name"=>"version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Capturespace", "Capturespace", "Action", "Serve"]}}, "/service/category/action/add"=>{"get"=>{"summary"=>"Get Service Category Action Add", "description"=>"Add new Category", "operationId"=>"category.add", "x-api-path-slug"=>"servicecategoryactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"category[aggregationCategories]", "description"=>"List of aggregation channels the category belongs to"}, {"in"=>"query", "name"=>"category[appearInList]", "description"=>"Enum Type: `KalturaAppearInListType`If category will be returned for list action"}, {"in"=>"query", "name"=>"category[contributionPolicy]", "description"=>"Enum Type: `KalturaContributionPolicyType`who can assign entries to this category"}, {"in"=>"query", "name"=>"category[defaultOrderBy]", "description"=>"Enum Type: `KalturaCategoryOrderBy`Enable client side applications to define how to sort the category child categories"}, {"in"=>"query", "name"=>"category[defaultPermissionLevel]", "description"=>"Enum Type: `KalturaCategoryUserPermissionLevel`Default permissionLevel for new users"}, {"in"=>"query", "name"=>"category[description]", "description"=>"Category description"}, {"in"=>"query", "name"=>"category[inheritanceType]", "description"=>"Enum Type: `KalturaInheritanceType`If Category members are inherited from parent category or set manualy"}, {"in"=>"query", "name"=>"category[isAggregationCategory]", "description"=>"Enum Type: `KalturaNullableBoolean`Flag indicating that the category is an aggregation category"}, {"in"=>"query", "name"=>"category[moderation]", "description"=>"Enum Type: `KalturaNullableBoolean`Moderation to add entries to this category by users that are not of permission level Manager or Moderator"}, {"in"=>"query", "name"=>"category[name]", "description"=>"The name of the Category"}, {"in"=>"query", "name"=>"category[owner]", "description"=>"Category Owner (User id)"}, {"in"=>"query", "name"=>"category[parentId]"}, {"in"=>"query", "name"=>"category[partnerData]", "description"=>"Can be used to store various partner related data as a string"}, {"in"=>"query", "name"=>"category[partnerSortValue]", "description"=>"Can be used to store various partner related data as a numeric value"}, {"in"=>"query", "name"=>"category[privacyContext]", "description"=>"Set privacy context for search entries that assiged to private and public categories"}, {"in"=>"query", "name"=>"category[privacy]", "description"=>"Enum Type: `KalturaPrivacyType`defines the privacy of the entries that assigned to this category"}, {"in"=>"query", "name"=>"category[referenceId]", "description"=>"Category external id, controlled and managed by the partner"}, {"in"=>"query", "name"=>"category[tags]", "description"=>"Category tags"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Category", "Action", "Add"]}}, "/service/category/action/addFromBulkUpload"=>{"post"=>{"summary"=>"Post Service Category Action Addfrombulkupload", "description"=>"", "operationId"=>"category.addFromBulkUpload", "x-api-path-slug"=>"servicecategoryactionaddfrombulkupload-post", "parameters"=>[{"in"=>"query", "name"=>"bulkUploadData[fileName]", "description"=>"Friendly name of the file, used to be recognized later in the logs"}, {"in"=>"query", "name"=>"bulkUploadData[objectData][conversionProfileId]", "description"=>"Selected profile id for all bulk entries"}, {"in"=>"query", "name"=>"bulkUploadData[objectData][objectType]"}, {"in"=>"formData", "name"=>"fileData"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Category", "Action", "AddFromBulkUpload"]}}, "/service/category/action/delete"=>{"get"=>{"summary"=>"Get Service Category Action Delete", "description"=>"Delete a Category", "operationId"=>"category.delete", "x-api-path-slug"=>"servicecategoryactiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"id"}, {"in"=>"query", "name"=>"moveEntriesToParentCategory", "description"=>"Enum Type: `KalturaNullableBoolean`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Category", "Action", "Delete"]}}, "/service/category/action/get"=>{"get"=>{"summary"=>"Get Service Category Action Get", "description"=>"Get Category by id", "operationId"=>"category.get", "x-api-path-slug"=>"servicecategoryactionget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Category", "Action", "Get"]}}, "/service/category/action/index"=>{"get"=>{"summary"=>"Get Service Category Action Index", "description"=>"Index Category by id", "operationId"=>"category.index", "x-api-path-slug"=>"servicecategoryactionindex-get", "parameters"=>[{"in"=>"query", "name"=>"id"}, {"in"=>"query", "name"=>"shouldUpdate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Category", "Action", "Index"]}}, "/service/category/action/list"=>{"get"=>{"summary"=>"Get Service Category Action List", "description"=>"List all categories", "operationId"=>"category.list", "x-api-path-slug"=>"servicecategoryactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[aggregationCategoriesMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[aggregationCategoriesMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[ancestorIdIn]", "description"=>"not includes the category itself (only sub categories)"}, {"in"=>"query", "name"=>"filter[appearInListEqual]", "description"=>"Enum Type: `KalturaAppearInListType`"}, {"in"=>"query", "name"=>"filter[contributionPolicyEqual]", "description"=>"Enum Type: `KalturaContributionPolicyType`"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[depthEqual]"}, {"in"=>"query", "name"=>"filter[freeText]"}, {"in"=>"query", "name"=>"filter[fullIdsEqual]"}, {"in"=>"query", "name"=>"filter[fullIdsMatchOr]"}, {"in"=>"query", "name"=>"filter[fullIdsStartsWith]"}, {"in"=>"query", "name"=>"filter[fullNameEqual]"}, {"in"=>"query", "name"=>"filter[fullNameIn]"}, {"in"=>"query", "name"=>"filter[fullNameStartsWithIn]"}, {"in"=>"query", "name"=>"filter[fullNameStartsWith]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[idNotIn]"}, {"in"=>"query", "name"=>"filter[idOrInheritedParentIdIn]"}, {"in"=>"query", "name"=>"filter[inheritanceTypeEqual]", "description"=>"Enum Type: `KalturaInheritanceType`"}, {"in"=>"query", "name"=>"filter[inheritanceTypeIn]"}, {"in"=>"query", "name"=>"filter[inheritedParentIdEqual]"}, {"in"=>"query", "name"=>"filter[inheritedParentIdIn]"}, {"in"=>"query", "name"=>"filter[managerEqual]"}, {"in"=>"query", "name"=>"filter[memberEqual]"}, {"in"=>"query", "name"=>"filter[membersCountGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[membersCountLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[membersIn]"}, {"in"=>"query", "name"=>"filter[nameOrReferenceIdStartsWith]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[parentIdEqual]"}, {"in"=>"query", "name"=>"filter[parentIdIn]"}, {"in"=>"query", "name"=>"filter[partnerSortValueGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[partnerSortValueLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[pendingMembersCountGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[pendingMembersCountLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[privacyContextEqual]"}, {"in"=>"query", "name"=>"filter[privacyEqual]", "description"=>"Enum Type: `KalturaPrivacyType`"}, {"in"=>"query", "name"=>"filter[privacyIn]"}, {"in"=>"query", "name"=>"filter[referenceIdEmpty]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[referenceIdEqual]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaCategoryStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[tagsLike]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Category", "Action", "List"]}}, "/service/category/action/move"=>{"get"=>{"summary"=>"Get Service Category Action Move", "description"=>"Move categories that belong to the same parent category to a target categroy - enabled only for ks with disable entitlement", "operationId"=>"category.move", "x-api-path-slug"=>"servicecategoryactionmove-get", "parameters"=>[{"in"=>"query", "name"=>"categoryIds"}, {"in"=>"query", "name"=>"targetCategoryParentId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Category", "Action", "Move"]}}, "/service/category/action/unlockCategories"=>{"get"=>{"summary"=>"Get Service Category Action Unlockcategories", "description"=>"Unlock categories", "operationId"=>"category.unlockCategories", "x-api-path-slug"=>"servicecategoryactionunlockcategories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Category", "Action", "UnlockCategories"]}}, "/service/category/action/update"=>{"get"=>{"summary"=>"Get Service Category Action Update", "description"=>"Update Category", "operationId"=>"category.update", "x-api-path-slug"=>"servicecategoryactionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"category[aggregationCategories]", "description"=>"List of aggregation channels the category belongs to"}, {"in"=>"query", "name"=>"category[appearInList]", "description"=>"Enum Type: `KalturaAppearInListType`If category will be returned for list action"}, {"in"=>"query", "name"=>"category[contributionPolicy]", "description"=>"Enum Type: `KalturaContributionPolicyType`who can assign entries to this category"}, {"in"=>"query", "name"=>"category[defaultOrderBy]", "description"=>"Enum Type: `KalturaCategoryOrderBy`Enable client side applications to define how to sort the category child categories"}, {"in"=>"query", "name"=>"category[defaultPermissionLevel]", "description"=>"Enum Type: `KalturaCategoryUserPermissionLevel`Default permissionLevel for new users"}, {"in"=>"query", "name"=>"category[description]", "description"=>"Category description"}, {"in"=>"query", "name"=>"category[inheritanceType]", "description"=>"Enum Type: `KalturaInheritanceType`If Category members are inherited from parent category or set manualy"}, {"in"=>"query", "name"=>"category[isAggregationCategory]", "description"=>"Enum Type: `KalturaNullableBoolean`Flag indicating that the category is an aggregation category"}, {"in"=>"query", "name"=>"category[moderation]", "description"=>"Enum Type: `KalturaNullableBoolean`Moderation to add entries to this category by users that are not of permission level Manager or Moderator"}, {"in"=>"query", "name"=>"category[name]", "description"=>"The name of the Category"}, {"in"=>"query", "name"=>"category[owner]", "description"=>"Category Owner (User id)"}, {"in"=>"query", "name"=>"category[parentId]"}, {"in"=>"query", "name"=>"category[partnerData]", "description"=>"Can be used to store various partner related data as a string"}, {"in"=>"query", "name"=>"category[partnerSortValue]", "description"=>"Can be used to store various partner related data as a numeric value"}, {"in"=>"query", "name"=>"category[privacyContext]", "description"=>"Set privacy context for search entries that assiged to private and public categories"}, {"in"=>"query", "name"=>"category[privacy]", "description"=>"Enum Type: `KalturaPrivacyType`defines the privacy of the entries that assigned to this category"}, {"in"=>"query", "name"=>"category[referenceId]", "description"=>"Category external id, controlled and managed by the partner"}, {"in"=>"query", "name"=>"category[tags]", "description"=>"Category tags"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Category", "Action", "Update"]}}, "/service/categoryentry/action/activate"=>{"get"=>{"summary"=>"Get Service Categoryentry Action Activate", "description"=>"activate CategoryEntry when it is pending moderation", "operationId"=>"categoryEntry.activate", "x-api-path-slug"=>"servicecategoryentryactionactivate-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId"}, {"in"=>"query", "name"=>"entryId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryentry", "Action", "Activate"]}}, "/service/categoryentry/action/add"=>{"get"=>{"summary"=>"Get Service Categoryentry Action Add", "description"=>"Add new CategoryEntry", "operationId"=>"categoryEntry.add", "x-api-path-slug"=>"servicecategoryentryactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"categoryEntry[categoryId]"}, {"in"=>"query", "name"=>"categoryEntry[entryId]", "description"=>"entry id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryentry", "Action", "Add"]}}, "/service/categoryentry/action/addFromBulkUpload"=>{"get"=>{"summary"=>"Get Service Categoryentry Action Addfrombulkupload", "description"=>"", "operationId"=>"categoryEntry.addFromBulkUpload", "x-api-path-slug"=>"servicecategoryentryactionaddfrombulkupload-get", "parameters"=>[{"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][field]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][idIn]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][items]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][not]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][objectType]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][value]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"bulkUploadData[filter][orderBy]"}, {"in"=>"query", "name"=>"bulkUploadData[objectType]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryentry", "Action", "AddFromBulkUpload"]}}, "/service/categoryentry/action/delete"=>{"get"=>{"summary"=>"Get Service Categoryentry Action Delete", "description"=>"Delete CategoryEntry", "operationId"=>"categoryEntry.delete", "x-api-path-slug"=>"servicecategoryentryactiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId"}, {"in"=>"query", "name"=>"entryId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryentry", "Action", "Delete"]}}, "/service/categoryentry/action/index"=>{"get"=>{"summary"=>"Get Service Categoryentry Action Index", "description"=>"Index CategoryEntry by Id", "operationId"=>"categoryEntry.index", "x-api-path-slug"=>"servicecategoryentryactionindex-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId"}, {"in"=>"query", "name"=>"entryId"}, {"in"=>"query", "name"=>"shouldUpdate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryentry", "Action", "Index"]}}, "/service/categoryentry/action/list"=>{"get"=>{"summary"=>"Get Service Categoryentry Action List", "description"=>"List all categoryEntry", "operationId"=>"categoryEntry.list", "x-api-path-slug"=>"servicecategoryentryactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[categoryFullIdsStartsWith]"}, {"in"=>"query", "name"=>"filter[categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[categoryIdIn]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[creatorUserIdEqual]"}, {"in"=>"query", "name"=>"filter[creatorUserIdIn]"}, {"in"=>"query", "name"=>"filter[entryIdEqual]"}, {"in"=>"query", "name"=>"filter[entryIdIn]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaCategoryEntryStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryentry", "Action", "List"]}}, "/service/categoryentry/action/reject"=>{"get"=>{"summary"=>"Get Service Categoryentry Action Reject", "description"=>"activate CategoryEntry when it is pending moderation", "operationId"=>"categoryEntry.reject", "x-api-path-slug"=>"servicecategoryentryactionreject-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId"}, {"in"=>"query", "name"=>"entryId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryentry", "Action", "Reject"]}}, "/service/categoryentry/action/syncPrivacyContext"=>{"get"=>{"summary"=>"Get Service Categoryentry Action Syncprivacycontext", "description"=>"update privacy context from the category", "operationId"=>"categoryEntry.syncPrivacyContext", "x-api-path-slug"=>"servicecategoryentryactionsyncprivacycontext-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId"}, {"in"=>"query", "name"=>"entryId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryentry", "Action", "SyncPrivacyContext"]}}, "/service/categoryuser/action/activate"=>{"get"=>{"summary"=>"Get Service Categoryuser Action Activate", "description"=>"activate CategoryUser", "operationId"=>"categoryUser.activate", "x-api-path-slug"=>"servicecategoryuseractionactivate-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId"}, {"in"=>"query", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryuser", "Action", "Activate"]}}, "/service/categoryuser/action/add"=>{"get"=>{"summary"=>"Get Service Categoryuser Action Add", "description"=>"Add new CategoryUser", "operationId"=>"categoryUser.add", "x-api-path-slug"=>"servicecategoryuseractionadd-get", "parameters"=>[{"in"=>"query", "name"=>"categoryUser[categoryId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"categoryUser[permissionLevel]", "description"=>"Enum Type: `KalturaCategoryUserPermissionLevel`Permission level"}, {"in"=>"query", "name"=>"categoryUser[permissionNames]", "description"=>"Set of category-related permissions for the current category user"}, {"in"=>"query", "name"=>"categoryUser[updateMethod]", "description"=>"Enum Type: `KalturaUpdateMethodType`Update method can be either manual or automatic to distinguish between manual operations (for example in KMC) on automatic - using bulk upload"}, {"in"=>"query", "name"=>"categoryUser[userId]", "description"=>"`insertOnly`User id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryuser", "Action", "Add"]}}, "/service/categoryuser/action/addFromBulkUpload"=>{"post"=>{"summary"=>"Post Service Categoryuser Action Addfrombulkupload", "description"=>"", "operationId"=>"categoryUser.addFromBulkUpload", "x-api-path-slug"=>"servicecategoryuseractionaddfrombulkupload-post", "parameters"=>[{"in"=>"query", "name"=>"bulkUploadData[fileName]", "description"=>"Friendly name of the file, used to be recognized later in the logs"}, {"in"=>"query", "name"=>"bulkUploadData[objectData][conversionProfileId]", "description"=>"Selected profile id for all bulk entries"}, {"in"=>"query", "name"=>"bulkUploadData[objectData][objectType]"}, {"in"=>"formData", "name"=>"fileData"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryuser", "Action", "AddFromBulkUpload"]}}, "/service/categoryuser/action/copyFromCategory"=>{"get"=>{"summary"=>"Get Service Categoryuser Action Copyfromcategory", "description"=>"Copy all memeber from parent category", "operationId"=>"categoryUser.copyFromCategory", "x-api-path-slug"=>"servicecategoryuseractioncopyfromcategory-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryuser", "Action", "CopyFromCategory"]}}, "/service/categoryuser/action/deactivate"=>{"get"=>{"summary"=>"Get Service Categoryuser Action Deactivate", "description"=>"reject CategoryUser", "operationId"=>"categoryUser.deactivate", "x-api-path-slug"=>"servicecategoryuseractiondeactivate-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId"}, {"in"=>"query", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryuser", "Action", "Deactivate"]}}, "/service/categoryuser/action/delete"=>{"get"=>{"summary"=>"Get Service Categoryuser Action Delete", "description"=>"Delete a CategoryUser", "operationId"=>"categoryUser.delete", "x-api-path-slug"=>"servicecategoryuseractiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId"}, {"in"=>"query", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryuser", "Action", "Delete"]}}, "/service/categoryuser/action/get"=>{"get"=>{"summary"=>"Get Service Categoryuser Action Get", "description"=>"Get CategoryUser by id", "operationId"=>"categoryUser.get", "x-api-path-slug"=>"servicecategoryuseractionget-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId"}, {"in"=>"query", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryuser", "Action", "Get"]}}, "/service/categoryuser/action/index"=>{"get"=>{"summary"=>"Get Service Categoryuser Action Index", "description"=>"Index CategoryUser by userid and category id", "operationId"=>"categoryUser.index", "x-api-path-slug"=>"servicecategoryuseractionindex-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId"}, {"in"=>"query", "name"=>"shouldUpdate"}, {"in"=>"query", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryuser", "Action", "Index"]}}, "/service/categoryuser/action/list"=>{"get"=>{"summary"=>"Get Service Categoryuser Action List", "description"=>"List all categories", "operationId"=>"categoryUser.list", "x-api-path-slug"=>"servicecategoryuseractionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[categoryDirectMembers]", "description"=>"Return the list of categoryUser that are not inherited from parent category - only the direct categoryUsers"}, {"in"=>"query", "name"=>"filter[categoryFullIdsEqual]"}, {"in"=>"query", "name"=>"filter[categoryFullIdsStartsWith]"}, {"in"=>"query", "name"=>"filter[categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[categoryIdIn]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[freeText]", "description"=>"Free text search on user id or screen name"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[permissionLevelEqual]", "description"=>"Enum Type: `KalturaCategoryUserPermissionLevel`"}, {"in"=>"query", "name"=>"filter[permissionLevelIn]"}, {"in"=>"query", "name"=>"filter[permissionNamesMatchAnd]"}, {"in"=>"query", "name"=>"filter[permissionNamesMatchOr]"}, {"in"=>"query", "name"=>"filter[permissionNamesNotContains]"}, {"in"=>"query", "name"=>"filter[relatedGroupsByUserId]", "description"=>"Return a list of categoryUser that related to the userId in this field by groups"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaCategoryUserStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updateMethodEqual]", "description"=>"Enum Type: `KalturaUpdateMethodType`"}, {"in"=>"query", "name"=>"filter[updateMethodIn]"}, {"in"=>"query", "name"=>"filter[userIdEqual]"}, {"in"=>"query", "name"=>"filter[userIdIn]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryuser", "Action", "List"]}}, "/service/categoryuser/action/update"=>{"get"=>{"summary"=>"Get Service Categoryuser Action Update", "description"=>"Update CategoryUser by id", "operationId"=>"categoryUser.update", "x-api-path-slug"=>"servicecategoryuseractionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId"}, {"in"=>"query", "name"=>"categoryUser[categoryId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"categoryUser[permissionLevel]", "description"=>"Enum Type: `KalturaCategoryUserPermissionLevel`Permission level"}, {"in"=>"query", "name"=>"categoryUser[permissionNames]", "description"=>"Set of category-related permissions for the current category user"}, {"in"=>"query", "name"=>"categoryUser[updateMethod]", "description"=>"Enum Type: `KalturaUpdateMethodType`Update method can be either manual or automatic to distinguish between manual operations (for example in KMC) on automatic - using bulk upload"}, {"in"=>"query", "name"=>"categoryUser[userId]", "description"=>"`insertOnly`User id"}, {"in"=>"query", "name"=>"override", "description"=>"- to override manual changes"}, {"in"=>"query", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Categoryuser", "Action", "Update"]}}, "/service/comcastmrssdistribution_comcastmrss/action/getFeed"=>{"get"=>{"summary"=>"Get Service Comcastmrssdistribution Comcastmrss Action Getfeed", "description"=>"", "operationId"=>"comcastMrss.getFeed", "x-api-path-slug"=>"servicecomcastmrssdistribution-comcastmrssactiongetfeed-get", "parameters"=>[{"in"=>"query", "name"=>"distributionProfileId"}, {"in"=>"query", "name"=>"hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Comcastmrssdistribution", "Comcastmrss", "Action", "GetFeed"]}}, "/service/contentdistribution_contentdistributionbatch/action/createRequiredJobs"=>{"get"=>{"summary"=>"Get Service Contentdistribution Contentdistributionbatch Action Createrequiredjobs", "description"=>"creates all required jobs according to entry distribution dirty flags", "operationId"=>"contentDistributionBatch.createRequiredJobs", "x-api-path-slug"=>"servicecontentdistribution-contentdistributionbatchactioncreaterequiredjobs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Contentdistributionbatch", "Action", "CreateRequiredJobs"]}}, "/service/contentdistribution_contentdistributionbatch/action/getAssetUrl"=>{"get"=>{"summary"=>"Get Service Contentdistribution Contentdistributionbatch Action Getasseturl", "description"=>"returns absolute valid url for asset file", "operationId"=>"contentDistributionBatch.getAssetUrl", "x-api-path-slug"=>"servicecontentdistribution-contentdistributionbatchactiongetasseturl-get", "parameters"=>[{"in"=>"query", "name"=>"assetId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Contentdistributionbatch", "Action", "GetAssetUrl"]}}, "/service/contentdistribution_contentdistributionbatch/action/updateSunStatus"=>{"get"=>{"summary"=>"Get Service Contentdistribution Contentdistributionbatch Action Updatesunstatus", "description"=>"updates entry distribution sun status in the search engine", "operationId"=>"contentDistributionBatch.updateSunStatus", "x-api-path-slug"=>"servicecontentdistribution-contentdistributionbatchactionupdatesunstatus-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Contentdistributionbatch", "Action", "UpdateSunStatus"]}}, "/service/contentdistribution_distributionprofile/action/add"=>{"get"=>{"summary"=>"Get Service Contentdistribution Distributionprofile Action Add", "description"=>"Add new Distribution Profile", "operationId"=>"distributionProfile.add", "x-api-path-slug"=>"servicecontentdistribution-distributionprofileactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"distributionProfile[accountId]"}, {"in"=>"query", "name"=>"distributionProfile[adFreeApplicationGuid]", "description"=>"The GUID for the application in which to record metrics and enforce business rules obtained through your Unicorn representative"}, {"in"=>"query", "name"=>"distributionProfile[adServerPartnerId]"}, {"in"=>"query", "name"=>"distributionProfile[allowAdsenseForVideo]"}, {"in"=>"query", "name"=>"distributionProfile[allowComments]"}, {"in"=>"query", "name"=>"distributionProfile[allowDownload]"}, {"in"=>"query", "name"=>"distributionProfile[allowEmbedding]"}, {"in"=>"query", "name"=>"distributionProfile[allowInvideo]"}, {"in"=>"query", "name"=>"distributionProfile[allowMidRollAds]"}, {"in"=>"query", "name"=>"distributionProfile[allowPostRollAds]"}, {"in"=>"query", "name"=>"distributionProfile[allowPreRollAds]"}, {"in"=>"query", "name"=>"distributionProfile[allowRatings]"}, {"in"=>"query", "name"=>"distributionProfile[allowResponses]"}, {"in"=>"query", "name"=>"distributionProfile[allowStreaming]"}, {"in"=>"query", "name"=>"distributionProfile[allowSyndication]"}, {"in"=>"query", "name"=>"distributionProfile[apiAuthorizeUrl]"}, {"in"=>"query", "name"=>"distributionProfile[apiHostUrl]", "description"=>"The API host URL that the Upload User should have access to, Used for HTTP content submission"}, {"in"=>"query", "name"=>"distributionProfile[apikey]"}, {"in"=>"query", "name"=>"distributionProfile[asperaHost]"}, {"in"=>"query", "name"=>"distributionProfile[asperaLogin]"}, {"in"=>"query", "name"=>"distributionProfile[asperaPass]"}, {"in"=>"query", "name"=>"distributionProfile[asperaPrivateKey]"}, {"in"=>"query", "name"=>"distributionProfile[asperaPublicKey]"}, {"in"=>"query", "name"=>"distributionProfile[assetFilenameXslt]"}, {"in"=>"query", "name"=>"distributionProfile[assumeSuccess]"}, {"in"=>"query", "name"=>"distributionProfile[autoCreateFlavors]", "description"=>"Comma separated flavor params ids that should be auto converted"}, {"in"=>"query", "name"=>"distributionProfile[autoCreateThumb]", "description"=>"Comma separated thumbnail params ids that should be auto generated"}, {"in"=>"query", "name"=>"distributionProfile[backgroundImageStandard]"}, {"in"=>"query", "name"=>"distributionProfile[backgroundImageWide]"}, {"in"=>"query", "name"=>"distributionProfile[basePath]"}, {"in"=>"query", "name"=>"distributionProfile[blockOutsideOwnership]"}, {"in"=>"query", "name"=>"distributionProfile[bodyXslt]"}, {"in"=>"query", "name"=>"distributionProfile[captionAutosync]"}, {"in"=>"query", "name"=>"distributionProfile[categoryId]"}, {"in"=>"query", "name"=>"distributionProfile[certificateKey]"}, {"in"=>"query", "name"=>"distributionProfile[channelCopyright]"}, {"in"=>"query", "name"=>"distributionProfile[channelDescription]"}, {"in"=>"query", "name"=>"distributionProfile[channelGenerator]"}, {"in"=>"query", "name"=>"distributionProfile[channelGuid]", "description"=>"The Channel GUID assigned to this Publication Rule"}, {"in"=>"query", "name"=>"distributionProfile[channelImageHeight]"}, {"in"=>"query", "name"=>"distributionProfile[channelImageLink]"}, {"in"=>"query", "name"=>"distributionProfile[channelImageTitle]"}, {"in"=>"query", "name"=>"distributionProfile[channelImageUrl]"}, {"in"=>"query", "name"=>"distributionProfile[channelImageWidth]"}, {"in"=>"query", "name"=>"distributionProfile[channelLanguage]"}, {"in"=>"query", "name"=>"distributionProfile[channelLink]"}, {"in"=>"query", "name"=>"distributionProfile[channelManagingEditor]"}, {"in"=>"query", "name"=>"distributionProfile[channelRating]"}, {"in"=>"query", "name"=>"distributionProfile[channelTitle]"}, {"in"=>"query", "name"=>"distributionProfile[claimType]"}, {"in"=>"query", "name"=>"distributionProfile[commercialPolicy]"}, {"in"=>"query", "name"=>"distributionProfile[contactEmail]"}, {"in"=>"query", "name"=>"distributionProfile[contactTelephone]"}, {"in"=>"query", "name"=>"distributionProfile[contentOwner]"}, {"in"=>"query", "name"=>"distributionProfile[copyright]"}, {"in"=>"query", "name"=>"distributionProfile[cPlatformTvSeriesField]"}, {"in"=>"query", "name"=>"distributionProfile[cPlatformTvSeries]"}, {"in"=>"query", "name"=>"distributionProfile[csId]"}, {"in"=>"query", "name"=>"distributionProfile[cuePointsProvider]"}, {"in"=>"query", "name"=>"distributionProfile[defaultCategory]"}, {"in"=>"query", "name"=>"distributionProfile[deleteEnabled]", "description"=>"Enum Type: `KalturaDistributionProfileActionStatus`"}, {"in"=>"query", "name"=>"distributionProfile[deleteReference]"}, {"in"=>"query", "name"=>"distributionProfile[disableEpisodeNumberCustomValidation]"}, {"in"=>"query", "name"=>"distributionProfile[disableMetadata]"}, {"in"=>"query", "name"=>"distributionProfile[distributeCaptions]"}, {"in"=>"query", "name"=>"distributionProfile[distributeCuePoints]"}, {"in"=>"query", "name"=>"distributionProfile[distributeRemoteCaptionAssetContent]"}, {"in"=>"query", "name"=>"distributionProfile[distributeRemoteFlavorAssetContent]"}, {"in"=>"query", "name"=>"distributionProfile[distributeRemoteThumbAssetContent]"}, {"in"=>"query", "name"=>"distributionProfile[domainGuid]", "description"=>"The GUID of the Customer Domain in the Unicorn system obtained by contacting your Unicorn representative"}, {"in"=>"query", "name"=>"distributionProfile[domainName]", "description"=>"The name of the Domain that the Upload User should have access to, Used for authentication"}, {"in"=>"query", "name"=>"distributionProfile[domain]"}, {"in"=>"query", "name"=>"distributionProfile[downloadPriceCode]"}, {"in"=>"query", "name"=>"distributionProfile[email]"}, {"in"=>"query", "name"=>"distributionProfile[enableAdServer]"}, {"in"=>"query", "name"=>"distributionProfile[entitlements]"}, {"in"=>"query", "name"=>"distributionProfile[entitlement]"}, {"in"=>"query", "name"=>"distributionProfile[feedAuthorName]"}, {"in"=>"query", "name"=>"distributionProfile[feedCopyright]"}, {"in"=>"query", "name"=>"distributionProfile[feedDescription]"}, {"in"=>"query", "name"=>"distributionProfile[feedImageHeight]"}, {"in"=>"query", "name"=>"distributionProfile[feedImageLink]"}, {"in"=>"query", "name"=>"distributionProfile[feedImageTitle]"}, {"in"=>"query", "name"=>"distributionProfile[feedImageUrl]"}, {"in"=>"query", "name"=>"distributionProfile[feedImageWidth]"}, {"in"=>"query", "name"=>"distributionProfile[feedLanguage]"}, {"in"=>"query", "name"=>"distributionProfile[feedLastBuildDate]"}, {"in"=>"query", "name"=>"distributionProfile[feedLink]"}, {"in"=>"query", "name"=>"distributionProfile[feedSpecVersion]", "description"=>"Enum Type: `KalturaYouTubeDistributionFeedSpecVersion`"}, {"in"=>"query", "name"=>"distributionProfile[feedSubtitle]"}, {"in"=>"query", "name"=>"distributionProfile[feedTitle]"}, {"in"=>"query", "name"=>"distributionProfile[fieldConfigArray]"}, {"in"=>"query", "name"=>"distributionProfile[flavorAssetFilenameXslt]"}, {"in"=>"query", "name"=>"distributionProfile[flvFlavorParamsId]"}, {"in"=>"query", "name"=>"distributionProfile[ftpHost]"}, {"in"=>"query", "name"=>"distributionProfile[ftpLogin]"}, {"in"=>"query", "name"=>"distributionProfile[ftpPassword]"}, {"in"=>"query", "name"=>"distributionProfile[ftpPass]"}, {"in"=>"query", "name"=>"distributionProfile[ftpPath]"}, {"in"=>"query", "name"=>"distributionProfile[ftpUsername]"}, {"in"=>"query", "name"=>"distributionProfile[genericProviderId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"distributionProfile[geoBlockingMapping]", "description"=>"Enum Type: `KalturaDailymotionGeoBlockingMapping`"}, {"in"=>"query", "name"=>"distributionProfile[googleClientId]"}, {"in"=>"query", "name"=>"distributionProfile[googleClientSecret]"}, {"in"=>"query", "name"=>"distributionProfile[googleTokenData]"}, {"in"=>"query", "name"=>"distributionProfile[hideViewCount]"}, {"in"=>"query", "name"=>"distributionProfile[host]"}, {"in"=>"query", "name"=>"distributionProfile[ignoreSchedulingInFeed]"}, {"in"=>"query", "name"=>"distributionProfile[ingestUrl]"}, {"in"=>"query", "name"=>"distributionProfile[instreamStandard]"}, {"in"=>"query", "name"=>"distributionProfile[instreamTrueview]"}, {"in"=>"query", "name"=>"distributionProfile[ips]"}, {"in"=>"query", "name"=>"distributionProfile[itemLink]"}, {"in"=>"query", "name"=>"distributionProfile[itemMediaRating]"}, {"in"=>"query", "name"=>"distributionProfile[itemsPerPage]"}, {"in"=>"query", "name"=>"distributionProfile[itemType]"}, {"in"=>"query", "name"=>"distributionProfile[itemXpathsToExtend]"}, {"in"=>"query", "name"=>"distributionProfile[mapAccessControlProfileIds]"}, {"in"=>"query", "name"=>"distributionProfile[mapCaptionParamsIds]"}, {"in"=>"query", "name"=>"distributionProfile[mapConversionProfileIds]"}, {"in"=>"query", "name"=>"distributionProfile[mapFlavorParamsIds]"}, {"in"=>"query", "name"=>"distributionProfile[mapMetadataProfileIds]"}, {"in"=>"query", "name"=>"distributionProfile[mapStorageProfileIds]"}, {"in"=>"query", "name"=>"distributionProfile[mapThumbParamsIds]"}, {"in"=>"query", "name"=>"distributionProfile[metadataFilenameXslt]"}, {"in"=>"query", "name"=>"distributionProfile[metadataProfileId]"}, {"in"=>"query", "name"=>"distributionProfile[metadataXpathsTriggerUpdate]"}, {"in"=>"query", "name"=>"distributionProfile[metadataXslt]"}, {"in"=>"query", "name"=>"distributionProfile[msnvideoCat]"}, {"in"=>"query", "name"=>"distributionProfile[msnvideoTopCat]"}, {"in"=>"query", "name"=>"distributionProfile[msnvideoTop]"}, {"in"=>"query", "name"=>"distributionProfile[name]"}, {"in"=>"query", "name"=>"distributionProfile[notificationEmail]"}, {"in"=>"query", "name"=>"distributionProfile[objectType]"}, {"in"=>"query", "name"=>"distributionProfile[optionalAssetDistributionRules]"}, {"in"=>"query", "name"=>"distributionProfile[optionalFlavorParamsIds]", "description"=>"Comma separated flavor params ids that should be submitted if ready"}, {"in"=>"query", "name"=>"distributionProfile[optionalThumbDimensions]"}, {"in"=>"query", "name"=>"distributionProfile[overrideManualEdits]"}, {"in"=>"query", "name"=>"distributionProfile[ownerName]"}, {"in"=>"query", "name"=>"distributionProfile[pageAccessToken]"}, {"in"=>"query", "name"=>"distributionProfile[pageGroup]"}, {"in"=>"query", "name"=>"distributionProfile[pageId]"}, {"in"=>"query", "name"=>"distributionProfile[passphrase]"}, {"in"=>"query", "name"=>"distributionProfile[password]"}, {"in"=>"query", "name"=>"distributionProfile[permissions]"}, {"in"=>"query", "name"=>"distributionProfile[port]"}, {"in"=>"query", "name"=>"distributionProfile[priority]"}, {"in"=>"query", "name"=>"distributionProfile[privacyStatus]"}, {"in"=>"query", "name"=>"distributionProfile[processFeed]", "description"=>"Enum Type: `KalturaYahooDistributionProcessFeedActionStatus`"}, {"in"=>"query", "name"=>"distributionProfile[protocol]", "description"=>"`insertOnly`Enum Type: `KalturaDistributionProtocol`"}, {"in"=>"query", "name"=>"distributionProfile[providerId]"}, {"in"=>"query", "name"=>"distributionProfile[providerName]"}, {"in"=>"query", "name"=>"distributionProfile[providerType]", "description"=>"`insertOnly`Enum Type: `KalturaDistributionProviderType`"}, {"in"=>"query", "name"=>"distributionProfile[rating]"}, {"in"=>"query", "name"=>"distributionProfile[recommendedDcForDownload]", "description"=>"The best Kaltura data center to be used to download the asset files to"}, {"in"=>"query", "name"=>"distributionProfile[recommendedDcForExecute]", "description"=>"The best Kaltura data center to be used to execute the distribution job"}, {"in"=>"query", "name"=>"distributionProfile[recommendedStorageProfileForDownload]", "description"=>"The best external storage to be used to download the asset files from"}, {"in"=>"query", "name"=>"distributionProfile[releaseClaims]"}, {"in"=>"query", "name"=>"distributionProfile[remoteAssetParamsId]", "description"=>"The flavor-params that will be used for the remote asset"}, {"in"=>"query", "name"=>"distributionProfile[replaceAirDates]"}, {"in"=>"query", "name"=>"distributionProfile[replaceGroup]"}, {"in"=>"query", "name"=>"distributionProfile[reportEnabled]", "description"=>"Enum Type: `KalturaDistributionProfileActionStatus`"}, {"in"=>"query", "name"=>"distributionProfile[requiredAssetDistributionRules]"}, {"in"=>"query", "name"=>"distributionProfile[requiredFlavorParamsIds]", "description"=>"Comma separated flavor params ids that required to be ready before submission"}, {"in"=>"query", "name"=>"distributionProfile[requiredThumbDimensions]"}, {"in"=>"query", "name"=>"distributionProfile[reRequestPermissions]"}, {"in"=>"query", "name"=>"distributionProfile[seasonNumber]"}, {"in"=>"query", "name"=>"distributionProfile[seasonSynopsis]"}, {"in"=>"query", "name"=>"distributionProfile[seasonTuneInInformation]"}, {"in"=>"query", "name"=>"distributionProfile[sendMetadataAfterAssets]"}, {"in"=>"query", "name"=>"distributionProfile[seriesAdditionalCategories]"}, {"in"=>"query", "name"=>"distributionProfile[seriesChannel]"}, {"in"=>"query", "name"=>"distributionProfile[seriesPrimaryCategory]"}, {"in"=>"query", "name"=>"distributionProfile[sftpBaseDir]"}, {"in"=>"query", "name"=>"distributionProfile[sftpBasePath]"}, {"in"=>"query", "name"=>"distributionProfile[sftpHost]"}, {"in"=>"query", "name"=>"distributionProfile[sftpLogin]"}, {"in"=>"query", "name"=>"distributionProfile[sftpPass]"}, {"in"=>"query", "name"=>"distributionProfile[sftpPort]"}, {"in"=>"query", "name"=>"distributionProfile[sftpPrivateKey]"}, {"in"=>"query", "name"=>"distributionProfile[sftpPublicKey]"}, {"in"=>"query", "name"=>"distributionProfile[shouldAddThumbExtension]"}, {"in"=>"query", "name"=>"distributionProfile[shouldIncludeCaptions]"}, {"in"=>"query", "name"=>"distributionProfile[shouldIncludeCuePoints]"}, {"in"=>"query", "name"=>"distributionProfile[slFlavorParamsId]"}, {"in"=>"query", "name"=>"distributionProfile[slHdFlavorParamsId]"}, {"in"=>"query", "name"=>"distributionProfile[sourceFlavorParamsId]"}, {"in"=>"query", "name"=>"distributionProfile[sourceFriendlyName]"}, {"in"=>"query", "name"=>"distributionProfile[source]"}, {"in"=>"query", "name"=>"distributionProfile[state]"}, {"in"=>"query", "name"=>"distributionProfile[status]", "description"=>"Enum Type: `KalturaDistributionProfileStatus`"}, {"in"=>"query", "name"=>"distributionProfile[storageProfileId]", "description"=>"The remote storage that should be used for the remote asset"}, {"in"=>"query", "name"=>"distributionProfile[streamingPriceCode]"}, {"in"=>"query", "name"=>"distributionProfile[strict]"}, {"in"=>"query", "name"=>"distributionProfile[submitAction][ftpPassiveMode]"}, {"in"=>"query", "name"=>"distributionProfile[submitAction][httpFieldName]"}, {"in"=>"query", "name"=>"distributionProfile[submitAction][httpFileName]"}, {"in"=>"query", "name"=>"distributionProfile[submitAction][password]"}, {"in"=>"query", "name"=>"distributionProfile[submitAction][protocol]", "description"=>"Enum Type: `KalturaDistributionProtocol`"}, {"in"=>"query", "name"=>"distributionProfile[submitAction][serverPath]"}, {"in"=>"query", "name"=>"distributionProfile[submitAction][serverUrl]"}, {"in"=>"query", "name"=>"distributionProfile[submitAction][username]"}, {"in"=>"query", "name"=>"distributionProfile[submitEnabled]", "description"=>"Enum Type: `KalturaDistributionProfileActionStatus`"}, {"in"=>"query", "name"=>"distributionProfile[sunriseDefaultOffset]", "description"=>"If entry distribution sunrise not specified that will be the default since entry creation time, in seconds"}, {"in"=>"query", "name"=>"distributionProfile[sunsetDefaultOffset]", "description"=>"If entry distribution sunset not specified that will be the default since entry creation time, in seconds"}, {"in"=>"query", "name"=>"distributionProfile[tags]"}, {"in"=>"query", "name"=>"distributionProfile[targetAccountId]"}, {"in"=>"query", "name"=>"distributionProfile[targetLoginId]"}, {"in"=>"query", "name"=>"distributionProfile[targetLoginPassword]"}, {"in"=>"query", "name"=>"distributionProfile[targetServiceUrl]"}, {"in"=>"query", "name"=>"distributionProfile[target]"}, {"in"=>"query", "name"=>"distributionProfile[thumbnailAssetFilenameXslt]"}, {"in"=>"query", "name"=>"distributionProfile[ugcPolicy]"}, {"in"=>"query", "name"=>"distributionProfile[updateEnabled]", "description"=>"Enum Type: `KalturaDistributionProfileActionStatus`"}, {"in"=>"query", "name"=>"distributionProfile[upstreamNetworkId]"}, {"in"=>"query", "name"=>"distributionProfile[upstreamNetworkName]"}, {"in"=>"query", "name"=>"distributionProfile[upstreamVideoId]"}, {"in"=>"query", "name"=>"distributionProfile[urgentReference]"}, {"in"=>"query", "name"=>"distributionProfile[useCategoryEntries]", "description"=>"When checking custom XSLT conditions using the fieldConfigArray - address only categories associated with the entry via the categoryEntry object"}, {"in"=>"query", "name"=>"distributionProfile[userAccessToken]"}, {"in"=>"query", "name"=>"distributionProfile[username]"}, {"in"=>"query", "name"=>"distributionProfile[user]"}, {"in"=>"query", "name"=>"distributionProfile[videoMediaType]"}, {"in"=>"query", "name"=>"distributionProfile[wmvFlavorParamsId]"}, {"in"=>"query", "name"=>"distributionProfile[xsltFile]"}, {"in"=>"query", "name"=>"distributionProfile[xsl]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Distributionprofile", "Action", "Add"]}}, "/service/contentdistribution_distributionprofile/action/delete"=>{"get"=>{"summary"=>"Get Service Contentdistribution Distributionprofile Action Delete", "description"=>"Delete Distribution Profile by id", "operationId"=>"distributionProfile.delete", "x-api-path-slug"=>"servicecontentdistribution-distributionprofileactiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Distributionprofile", "Action", "Delete"]}}, "/service/contentdistribution_distributionprofile/action/get"=>{"get"=>{"summary"=>"Get Service Contentdistribution Distributionprofile Action Get", "description"=>"Get Distribution Profile by id", "operationId"=>"distributionProfile.get", "x-api-path-slug"=>"servicecontentdistribution-distributionprofileactionget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Distributionprofile", "Action", "Get"]}}, "/service/contentdistribution_distributionprofile/action/list"=>{"get"=>{"summary"=>"Get Service Contentdistribution Distributionprofile Action List", "description"=>"List all distribution providers", "operationId"=>"distributionProfile.list", "x-api-path-slug"=>"servicecontentdistribution-distributionprofileactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaDistributionProfileStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Distributionprofile", "Action", "List"]}}, "/service/contentdistribution_distributionprofile/action/listByPartner"=>{"get"=>{"summary"=>"Get Service Contentdistribution Distributionprofile Action Listbypartner", "description"=>"", "operationId"=>"distributionProfile.listByPartner", "x-api-path-slug"=>"servicecontentdistribution-distributionprofileactionlistbypartner-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[groupTypeEq]", "description"=>"Enum Type: `KalturaPartnerGroupType`Eq filter for the partners group type"}, {"in"=>"query", "name"=>"filter[groupTypeIn]", "description"=>"In filter for the partners group type"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[idNotIn]"}, {"in"=>"query", "name"=>"filter[nameEqual]"}, {"in"=>"query", "name"=>"filter[nameLike]"}, {"in"=>"query", "name"=>"filter[nameMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[nameMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[partnerGroupTypeEqual]", "description"=>"Enum Type: `KalturaPartnerGroupType`"}, {"in"=>"query", "name"=>"filter[partnerNameDescriptionWebsiteAdminNameAdminEmailLike]"}, {"in"=>"query", "name"=>"filter[partnerPackageEqual]"}, {"in"=>"query", "name"=>"filter[partnerPackageGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[partnerPackageIn]"}, {"in"=>"query", "name"=>"filter[partnerPackageLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[partnerPermissionsExist]", "description"=>"Filter for partner permissions- filter contains comma-separated string of permission names which the returned partners should have"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaPartnerStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Distributionprofile", "Action", "ListByPartner"]}}, "/service/contentdistribution_distributionprofile/action/update"=>{"get"=>{"summary"=>"Get Service Contentdistribution Distributionprofile Action Update", "description"=>"Update Distribution Profile by id", "operationId"=>"distributionProfile.update", "x-api-path-slug"=>"servicecontentdistribution-distributionprofileactionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"distributionProfile[accountId]"}, {"in"=>"query", "name"=>"distributionProfile[adFreeApplicationGuid]", "description"=>"The GUID for the application in which to record metrics and enforce business rules obtained through your Unicorn representative"}, {"in"=>"query", "name"=>"distributionProfile[adServerPartnerId]"}, {"in"=>"query", "name"=>"distributionProfile[allowAdsenseForVideo]"}, {"in"=>"query", "name"=>"distributionProfile[allowComments]"}, {"in"=>"query", "name"=>"distributionProfile[allowDownload]"}, {"in"=>"query", "name"=>"distributionProfile[allowEmbedding]"}, {"in"=>"query", "name"=>"distributionProfile[allowInvideo]"}, {"in"=>"query", "name"=>"distributionProfile[allowMidRollAds]"}, {"in"=>"query", "name"=>"distributionProfile[allowPostRollAds]"}, {"in"=>"query", "name"=>"distributionProfile[allowPreRollAds]"}, {"in"=>"query", "name"=>"distributionProfile[allowRatings]"}, {"in"=>"query", "name"=>"distributionProfile[allowResponses]"}, {"in"=>"query", "name"=>"distributionProfile[allowStreaming]"}, {"in"=>"query", "name"=>"distributionProfile[allowSyndication]"}, {"in"=>"query", "name"=>"distributionProfile[apiAuthorizeUrl]"}, {"in"=>"query", "name"=>"distributionProfile[apiHostUrl]", "description"=>"The API host URL that the Upload User should have access to, Used for HTTP content submission"}, {"in"=>"query", "name"=>"distributionProfile[apikey]"}, {"in"=>"query", "name"=>"distributionProfile[asperaHost]"}, {"in"=>"query", "name"=>"distributionProfile[asperaLogin]"}, {"in"=>"query", "name"=>"distributionProfile[asperaPass]"}, {"in"=>"query", "name"=>"distributionProfile[asperaPrivateKey]"}, {"in"=>"query", "name"=>"distributionProfile[asperaPublicKey]"}, {"in"=>"query", "name"=>"distributionProfile[assetFilenameXslt]"}, {"in"=>"query", "name"=>"distributionProfile[assumeSuccess]"}, {"in"=>"query", "name"=>"distributionProfile[autoCreateFlavors]", "description"=>"Comma separated flavor params ids that should be auto converted"}, {"in"=>"query", "name"=>"distributionProfile[autoCreateThumb]", "description"=>"Comma separated thumbnail params ids that should be auto generated"}, {"in"=>"query", "name"=>"distributionProfile[backgroundImageStandard]"}, {"in"=>"query", "name"=>"distributionProfile[backgroundImageWide]"}, {"in"=>"query", "name"=>"distributionProfile[basePath]"}, {"in"=>"query", "name"=>"distributionProfile[blockOutsideOwnership]"}, {"in"=>"query", "name"=>"distributionProfile[bodyXslt]"}, {"in"=>"query", "name"=>"distributionProfile[captionAutosync]"}, {"in"=>"query", "name"=>"distributionProfile[categoryId]"}, {"in"=>"query", "name"=>"distributionProfile[certificateKey]"}, {"in"=>"query", "name"=>"distributionProfile[channelCopyright]"}, {"in"=>"query", "name"=>"distributionProfile[channelDescription]"}, {"in"=>"query", "name"=>"distributionProfile[channelGenerator]"}, {"in"=>"query", "name"=>"distributionProfile[channelGuid]", "description"=>"The Channel GUID assigned to this Publication Rule"}, {"in"=>"query", "name"=>"distributionProfile[channelImageHeight]"}, {"in"=>"query", "name"=>"distributionProfile[channelImageLink]"}, {"in"=>"query", "name"=>"distributionProfile[channelImageTitle]"}, {"in"=>"query", "name"=>"distributionProfile[channelImageUrl]"}, {"in"=>"query", "name"=>"distributionProfile[channelImageWidth]"}, {"in"=>"query", "name"=>"distributionProfile[channelLanguage]"}, {"in"=>"query", "name"=>"distributionProfile[channelLink]"}, {"in"=>"query", "name"=>"distributionProfile[channelManagingEditor]"}, {"in"=>"query", "name"=>"distributionProfile[channelRating]"}, {"in"=>"query", "name"=>"distributionProfile[channelTitle]"}, {"in"=>"query", "name"=>"distributionProfile[claimType]"}, {"in"=>"query", "name"=>"distributionProfile[commercialPolicy]"}, {"in"=>"query", "name"=>"distributionProfile[contactEmail]"}, {"in"=>"query", "name"=>"distributionProfile[contactTelephone]"}, {"in"=>"query", "name"=>"distributionProfile[contentOwner]"}, {"in"=>"query", "name"=>"distributionProfile[copyright]"}, {"in"=>"query", "name"=>"distributionProfile[cPlatformTvSeriesField]"}, {"in"=>"query", "name"=>"distributionProfile[cPlatformTvSeries]"}, {"in"=>"query", "name"=>"distributionProfile[csId]"}, {"in"=>"query", "name"=>"distributionProfile[cuePointsProvider]"}, {"in"=>"query", "name"=>"distributionProfile[defaultCategory]"}, {"in"=>"query", "name"=>"distributionProfile[deleteEnabled]", "description"=>"Enum Type: `KalturaDistributionProfileActionStatus`"}, {"in"=>"query", "name"=>"distributionProfile[deleteReference]"}, {"in"=>"query", "name"=>"distributionProfile[disableEpisodeNumberCustomValidation]"}, {"in"=>"query", "name"=>"distributionProfile[disableMetadata]"}, {"in"=>"query", "name"=>"distributionProfile[distributeCaptions]"}, {"in"=>"query", "name"=>"distributionProfile[distributeCuePoints]"}, {"in"=>"query", "name"=>"distributionProfile[distributeRemoteCaptionAssetContent]"}, {"in"=>"query", "name"=>"distributionProfile[distributeRemoteFlavorAssetContent]"}, {"in"=>"query", "name"=>"distributionProfile[distributeRemoteThumbAssetContent]"}, {"in"=>"query", "name"=>"distributionProfile[domainGuid]", "description"=>"The GUID of the Customer Domain in the Unicorn system obtained by contacting your Unicorn representative"}, {"in"=>"query", "name"=>"distributionProfile[domainName]", "description"=>"The name of the Domain that the Upload User should have access to, Used for authentication"}, {"in"=>"query", "name"=>"distributionProfile[domain]"}, {"in"=>"query", "name"=>"distributionProfile[downloadPriceCode]"}, {"in"=>"query", "name"=>"distributionProfile[email]"}, {"in"=>"query", "name"=>"distributionProfile[enableAdServer]"}, {"in"=>"query", "name"=>"distributionProfile[entitlements]"}, {"in"=>"query", "name"=>"distributionProfile[entitlement]"}, {"in"=>"query", "name"=>"distributionProfile[feedAuthorName]"}, {"in"=>"query", "name"=>"distributionProfile[feedCopyright]"}, {"in"=>"query", "name"=>"distributionProfile[feedDescription]"}, {"in"=>"query", "name"=>"distributionProfile[feedImageHeight]"}, {"in"=>"query", "name"=>"distributionProfile[feedImageLink]"}, {"in"=>"query", "name"=>"distributionProfile[feedImageTitle]"}, {"in"=>"query", "name"=>"distributionProfile[feedImageUrl]"}, {"in"=>"query", "name"=>"distributionProfile[feedImageWidth]"}, {"in"=>"query", "name"=>"distributionProfile[feedLanguage]"}, {"in"=>"query", "name"=>"distributionProfile[feedLastBuildDate]"}, {"in"=>"query", "name"=>"distributionProfile[feedLink]"}, {"in"=>"query", "name"=>"distributionProfile[feedSpecVersion]", "description"=>"Enum Type: `KalturaYouTubeDistributionFeedSpecVersion`"}, {"in"=>"query", "name"=>"distributionProfile[feedSubtitle]"}, {"in"=>"query", "name"=>"distributionProfile[feedTitle]"}, {"in"=>"query", "name"=>"distributionProfile[fieldConfigArray]"}, {"in"=>"query", "name"=>"distributionProfile[flavorAssetFilenameXslt]"}, {"in"=>"query", "name"=>"distributionProfile[flvFlavorParamsId]"}, {"in"=>"query", "name"=>"distributionProfile[ftpHost]"}, {"in"=>"query", "name"=>"distributionProfile[ftpLogin]"}, {"in"=>"query", "name"=>"distributionProfile[ftpPassword]"}, {"in"=>"query", "name"=>"distributionProfile[ftpPass]"}, {"in"=>"query", "name"=>"distributionProfile[ftpPath]"}, {"in"=>"query", "name"=>"distributionProfile[ftpUsername]"}, {"in"=>"query", "name"=>"distributionProfile[genericProviderId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"distributionProfile[geoBlockingMapping]", "description"=>"Enum Type: `KalturaDailymotionGeoBlockingMapping`"}, {"in"=>"query", "name"=>"distributionProfile[googleClientId]"}, {"in"=>"query", "name"=>"distributionProfile[googleClientSecret]"}, {"in"=>"query", "name"=>"distributionProfile[googleTokenData]"}, {"in"=>"query", "name"=>"distributionProfile[hideViewCount]"}, {"in"=>"query", "name"=>"distributionProfile[host]"}, {"in"=>"query", "name"=>"distributionProfile[ignoreSchedulingInFeed]"}, {"in"=>"query", "name"=>"distributionProfile[ingestUrl]"}, {"in"=>"query", "name"=>"distributionProfile[instreamStandard]"}, {"in"=>"query", "name"=>"distributionProfile[instreamTrueview]"}, {"in"=>"query", "name"=>"distributionProfile[ips]"}, {"in"=>"query", "name"=>"distributionProfile[itemLink]"}, {"in"=>"query", "name"=>"distributionProfile[itemMediaRating]"}, {"in"=>"query", "name"=>"distributionProfile[itemsPerPage]"}, {"in"=>"query", "name"=>"distributionProfile[itemType]"}, {"in"=>"query", "name"=>"distributionProfile[itemXpathsToExtend]"}, {"in"=>"query", "name"=>"distributionProfile[mapAccessControlProfileIds]"}, {"in"=>"query", "name"=>"distributionProfile[mapCaptionParamsIds]"}, {"in"=>"query", "name"=>"distributionProfile[mapConversionProfileIds]"}, {"in"=>"query", "name"=>"distributionProfile[mapFlavorParamsIds]"}, {"in"=>"query", "name"=>"distributionProfile[mapMetadataProfileIds]"}, {"in"=>"query", "name"=>"distributionProfile[mapStorageProfileIds]"}, {"in"=>"query", "name"=>"distributionProfile[mapThumbParamsIds]"}, {"in"=>"query", "name"=>"distributionProfile[metadataFilenameXslt]"}, {"in"=>"query", "name"=>"distributionProfile[metadataProfileId]"}, {"in"=>"query", "name"=>"distributionProfile[metadataXpathsTriggerUpdate]"}, {"in"=>"query", "name"=>"distributionProfile[metadataXslt]"}, {"in"=>"query", "name"=>"distributionProfile[msnvideoCat]"}, {"in"=>"query", "name"=>"distributionProfile[msnvideoTopCat]"}, {"in"=>"query", "name"=>"distributionProfile[msnvideoTop]"}, {"in"=>"query", "name"=>"distributionProfile[name]"}, {"in"=>"query", "name"=>"distributionProfile[notificationEmail]"}, {"in"=>"query", "name"=>"distributionProfile[objectType]"}, {"in"=>"query", "name"=>"distributionProfile[optionalAssetDistributionRules]"}, {"in"=>"query", "name"=>"distributionProfile[optionalFlavorParamsIds]", "description"=>"Comma separated flavor params ids that should be submitted if ready"}, {"in"=>"query", "name"=>"distributionProfile[optionalThumbDimensions]"}, {"in"=>"query", "name"=>"distributionProfile[overrideManualEdits]"}, {"in"=>"query", "name"=>"distributionProfile[ownerName]"}, {"in"=>"query", "name"=>"distributionProfile[pageAccessToken]"}, {"in"=>"query", "name"=>"distributionProfile[pageGroup]"}, {"in"=>"query", "name"=>"distributionProfile[pageId]"}, {"in"=>"query", "name"=>"distributionProfile[passphrase]"}, {"in"=>"query", "name"=>"distributionProfile[password]"}, {"in"=>"query", "name"=>"distributionProfile[permissions]"}, {"in"=>"query", "name"=>"distributionProfile[port]"}, {"in"=>"query", "name"=>"distributionProfile[priority]"}, {"in"=>"query", "name"=>"distributionProfile[privacyStatus]"}, {"in"=>"query", "name"=>"distributionProfile[processFeed]", "description"=>"Enum Type: `KalturaYahooDistributionProcessFeedActionStatus`"}, {"in"=>"query", "name"=>"distributionProfile[protocol]", "description"=>"`insertOnly`Enum Type: `KalturaDistributionProtocol`"}, {"in"=>"query", "name"=>"distributionProfile[providerId]"}, {"in"=>"query", "name"=>"distributionProfile[providerName]"}, {"in"=>"query", "name"=>"distributionProfile[providerType]", "description"=>"`insertOnly`Enum Type: `KalturaDistributionProviderType`"}, {"in"=>"query", "name"=>"distributionProfile[rating]"}, {"in"=>"query", "name"=>"distributionProfile[recommendedDcForDownload]", "description"=>"The best Kaltura data center to be used to download the asset files to"}, {"in"=>"query", "name"=>"distributionProfile[recommendedDcForExecute]", "description"=>"The best Kaltura data center to be used to execute the distribution job"}, {"in"=>"query", "name"=>"distributionProfile[recommendedStorageProfileForDownload]", "description"=>"The best external storage to be used to download the asset files from"}, {"in"=>"query", "name"=>"distributionProfile[releaseClaims]"}, {"in"=>"query", "name"=>"distributionProfile[remoteAssetParamsId]", "description"=>"The flavor-params that will be used for the remote asset"}, {"in"=>"query", "name"=>"distributionProfile[replaceAirDates]"}, {"in"=>"query", "name"=>"distributionProfile[replaceGroup]"}, {"in"=>"query", "name"=>"distributionProfile[reportEnabled]", "description"=>"Enum Type: `KalturaDistributionProfileActionStatus`"}, {"in"=>"query", "name"=>"distributionProfile[requiredAssetDistributionRules]"}, {"in"=>"query", "name"=>"distributionProfile[requiredFlavorParamsIds]", "description"=>"Comma separated flavor params ids that required to be ready before submission"}, {"in"=>"query", "name"=>"distributionProfile[requiredThumbDimensions]"}, {"in"=>"query", "name"=>"distributionProfile[reRequestPermissions]"}, {"in"=>"query", "name"=>"distributionProfile[seasonNumber]"}, {"in"=>"query", "name"=>"distributionProfile[seasonSynopsis]"}, {"in"=>"query", "name"=>"distributionProfile[seasonTuneInInformation]"}, {"in"=>"query", "name"=>"distributionProfile[sendMetadataAfterAssets]"}, {"in"=>"query", "name"=>"distributionProfile[seriesAdditionalCategories]"}, {"in"=>"query", "name"=>"distributionProfile[seriesChannel]"}, {"in"=>"query", "name"=>"distributionProfile[seriesPrimaryCategory]"}, {"in"=>"query", "name"=>"distributionProfile[sftpBaseDir]"}, {"in"=>"query", "name"=>"distributionProfile[sftpBasePath]"}, {"in"=>"query", "name"=>"distributionProfile[sftpHost]"}, {"in"=>"query", "name"=>"distributionProfile[sftpLogin]"}, {"in"=>"query", "name"=>"distributionProfile[sftpPass]"}, {"in"=>"query", "name"=>"distributionProfile[sftpPort]"}, {"in"=>"query", "name"=>"distributionProfile[sftpPrivateKey]"}, {"in"=>"query", "name"=>"distributionProfile[sftpPublicKey]"}, {"in"=>"query", "name"=>"distributionProfile[shouldAddThumbExtension]"}, {"in"=>"query", "name"=>"distributionProfile[shouldIncludeCaptions]"}, {"in"=>"query", "name"=>"distributionProfile[shouldIncludeCuePoints]"}, {"in"=>"query", "name"=>"distributionProfile[slFlavorParamsId]"}, {"in"=>"query", "name"=>"distributionProfile[slHdFlavorParamsId]"}, {"in"=>"query", "name"=>"distributionProfile[sourceFlavorParamsId]"}, {"in"=>"query", "name"=>"distributionProfile[sourceFriendlyName]"}, {"in"=>"query", "name"=>"distributionProfile[source]"}, {"in"=>"query", "name"=>"distributionProfile[state]"}, {"in"=>"query", "name"=>"distributionProfile[status]", "description"=>"Enum Type: `KalturaDistributionProfileStatus`"}, {"in"=>"query", "name"=>"distributionProfile[storageProfileId]", "description"=>"The remote storage that should be used for the remote asset"}, {"in"=>"query", "name"=>"distributionProfile[streamingPriceCode]"}, {"in"=>"query", "name"=>"distributionProfile[strict]"}, {"in"=>"query", "name"=>"distributionProfile[submitAction][ftpPassiveMode]"}, {"in"=>"query", "name"=>"distributionProfile[submitAction][httpFieldName]"}, {"in"=>"query", "name"=>"distributionProfile[submitAction][httpFileName]"}, {"in"=>"query", "name"=>"distributionProfile[submitAction][password]"}, {"in"=>"query", "name"=>"distributionProfile[submitAction][protocol]", "description"=>"Enum Type: `KalturaDistributionProtocol`"}, {"in"=>"query", "name"=>"distributionProfile[submitAction][serverPath]"}, {"in"=>"query", "name"=>"distributionProfile[submitAction][serverUrl]"}, {"in"=>"query", "name"=>"distributionProfile[submitAction][username]"}, {"in"=>"query", "name"=>"distributionProfile[submitEnabled]", "description"=>"Enum Type: `KalturaDistributionProfileActionStatus`"}, {"in"=>"query", "name"=>"distributionProfile[sunriseDefaultOffset]", "description"=>"If entry distribution sunrise not specified that will be the default since entry creation time, in seconds"}, {"in"=>"query", "name"=>"distributionProfile[sunsetDefaultOffset]", "description"=>"If entry distribution sunset not specified that will be the default since entry creation time, in seconds"}, {"in"=>"query", "name"=>"distributionProfile[tags]"}, {"in"=>"query", "name"=>"distributionProfile[targetAccountId]"}, {"in"=>"query", "name"=>"distributionProfile[targetLoginId]"}, {"in"=>"query", "name"=>"distributionProfile[targetLoginPassword]"}, {"in"=>"query", "name"=>"distributionProfile[targetServiceUrl]"}, {"in"=>"query", "name"=>"distributionProfile[target]"}, {"in"=>"query", "name"=>"distributionProfile[thumbnailAssetFilenameXslt]"}, {"in"=>"query", "name"=>"distributionProfile[ugcPolicy]"}, {"in"=>"query", "name"=>"distributionProfile[updateEnabled]", "description"=>"Enum Type: `KalturaDistributionProfileActionStatus`"}, {"in"=>"query", "name"=>"distributionProfile[upstreamNetworkId]"}, {"in"=>"query", "name"=>"distributionProfile[upstreamNetworkName]"}, {"in"=>"query", "name"=>"distributionProfile[upstreamVideoId]"}, {"in"=>"query", "name"=>"distributionProfile[urgentReference]"}, {"in"=>"query", "name"=>"distributionProfile[useCategoryEntries]", "description"=>"When checking custom XSLT conditions using the fieldConfigArray - address only categories associated with the entry via the categoryEntry object"}, {"in"=>"query", "name"=>"distributionProfile[userAccessToken]"}, {"in"=>"query", "name"=>"distributionProfile[username]"}, {"in"=>"query", "name"=>"distributionProfile[user]"}, {"in"=>"query", "name"=>"distributionProfile[videoMediaType]"}, {"in"=>"query", "name"=>"distributionProfile[wmvFlavorParamsId]"}, {"in"=>"query", "name"=>"distributionProfile[xsltFile]"}, {"in"=>"query", "name"=>"distributionProfile[xsl]"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Distributionprofile", "Action", "Update"]}}, "/service/contentdistribution_distributionprofile/action/updateStatus"=>{"get"=>{"summary"=>"Get Service Contentdistribution Distributionprofile Action Updatestatus", "description"=>"Update Distribution Profile status by id", "operationId"=>"distributionProfile.updateStatus", "x-api-path-slug"=>"servicecontentdistribution-distributionprofileactionupdatestatus-get", "parameters"=>[{"in"=>"query", "name"=>"id"}, {"in"=>"query", "name"=>"status", "description"=>"Enum Type: `KalturaDistributionProfileStatus`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Distributionprofile", "Action", "UpdateStatus"]}}, "/service/contentdistribution_distributionprovider/action/list"=>{"get"=>{"summary"=>"Get Service Contentdistribution Distributionprover Action List", "description"=>"List all distribution providers", "operationId"=>"distributionProvider.list", "x-api-path-slug"=>"servicecontentdistribution-distributionprovideractionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[isDefaultEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[isDefaultIn]"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[partnerIdEqual]"}, {"in"=>"query", "name"=>"filter[partnerIdIn]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaGenericDistributionProviderStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[typeEqual]", "description"=>"Enum Type: `KalturaDistributionProviderType`"}, {"in"=>"query", "name"=>"filter[typeIn]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Distributionprovider", "Action", "List"]}}, "/service/contentdistribution_entrydistribution/action/add"=>{"get"=>{"summary"=>"Get Service Contentdistribution Entrydistribution Action Add", "description"=>"Add new Entry Distribution", "operationId"=>"entryDistribution.add", "x-api-path-slug"=>"servicecontentdistribution-entrydistributionactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"entryDistribution[assetIds]", "description"=>"Comma separated asset ids"}, {"in"=>"query", "name"=>"entryDistribution[distributionProfileId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"entryDistribution[entryId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"entryDistribution[flavorAssetIds]", "description"=>"Comma separated flavor asset ids"}, {"in"=>"query", "name"=>"entryDistribution[sunrise]", "description"=>"Entry distribution publish time as Unix timestamp (In seconds)"}, {"in"=>"query", "name"=>"entryDistribution[sunset]", "description"=>"Entry distribution un-publish time as Unix timestamp (In seconds)"}, {"in"=>"query", "name"=>"entryDistribution[thumbAssetIds]", "description"=>"Comma separated thumbnail asset ids"}, {"in"=>"query", "name"=>"entryDistribution[validationErrors]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Entrydistribution", "Action", "Add"]}}, "/service/contentdistribution_entrydistribution/action/delete"=>{"get"=>{"summary"=>"Get Service Contentdistribution Entrydistribution Action Delete", "description"=>"Delete Entry Distribution by id", "operationId"=>"entryDistribution.delete", "x-api-path-slug"=>"servicecontentdistribution-entrydistributionactiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Entrydistribution", "Action", "Delete"]}}, "/service/contentdistribution_entrydistribution/action/get"=>{"get"=>{"summary"=>"Get Service Contentdistribution Entrydistribution Action Get", "description"=>"Get Entry Distribution by id", "operationId"=>"entryDistribution.get", "x-api-path-slug"=>"servicecontentdistribution-entrydistributionactionget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Entrydistribution", "Action", "Get"]}}, "/service/contentdistribution_entrydistribution/action/list"=>{"get"=>{"summary"=>"Get Service Contentdistribution Entrydistribution Action List", "description"=>"List all distribution providers", "operationId"=>"entryDistribution.list", "x-api-path-slug"=>"servicecontentdistribution-entrydistributionactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[dirtyStatusEqual]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[dirtyStatusIn]"}, {"in"=>"query", "name"=>"filter[distributionProfileIdEqual]"}, {"in"=>"query", "name"=>"filter[distributionProfileIdIn]"}, {"in"=>"query", "name"=>"filter[entryIdEqual]"}, {"in"=>"query", "name"=>"filter[entryIdIn]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[submittedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[submittedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[sunriseGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[sunriseLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[sunsetGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[sunsetLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Entrydistribution", "Action", "List"]}}, "/service/contentdistribution_entrydistribution/action/retrySubmit"=>{"get"=>{"summary"=>"Get Service Contentdistribution Entrydistribution Action Retrysubmit", "description"=>"Retries last submit action", "operationId"=>"entryDistribution.retrySubmit", "x-api-path-slug"=>"servicecontentdistribution-entrydistributionactionretrysubmit-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Entrydistribution", "Action", "RetrySubmit"]}}, "/service/contentdistribution_entrydistribution/action/serveReturnedData"=>{"get"=>{"summary"=>"Get Service Contentdistribution Entrydistribution Action Servereturneddata", "description"=>"Serves entry distribution returned data", "operationId"=>"entryDistribution.serveReturnedData", "x-api-path-slug"=>"servicecontentdistribution-entrydistributionactionservereturneddata-get", "parameters"=>[{"in"=>"query", "name"=>"actionType", "description"=>"Enum Type: `KalturaDistributionAction`"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Entrydistribution", "Action", "ServeReturnedData"]}}, "/service/contentdistribution_entrydistribution/action/serveSentData"=>{"get"=>{"summary"=>"Get Service Contentdistribution Entrydistribution Action Servesentdata", "description"=>"Serves entry distribution sent data", "operationId"=>"entryDistribution.serveSentData", "x-api-path-slug"=>"servicecontentdistribution-entrydistributionactionservesentdata-get", "parameters"=>[{"in"=>"query", "name"=>"actionType", "description"=>"Enum Type: `KalturaDistributionAction`"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Entrydistribution", "Action", "ServeSentData"]}}, "/service/contentdistribution_entrydistribution/action/submitAdd"=>{"get"=>{"summary"=>"Get Service Contentdistribution Entrydistribution Action Submitadd", "description"=>"Submits Entry Distribution to the remote destination", "operationId"=>"entryDistribution.submitAdd", "x-api-path-slug"=>"servicecontentdistribution-entrydistributionactionsubmitadd-get", "parameters"=>[{"in"=>"query", "name"=>"id"}, {"in"=>"query", "name"=>"submitWhenReady"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Entrydistribution", "Action", "Submit"]}}, "/service/contentdistribution_entrydistribution/action/submitDelete"=>{"get"=>{"summary"=>"Get Service Contentdistribution Entrydistribution Action Submitdelete", "description"=>"Deletes Entry Distribution from the remote destination", "operationId"=>"entryDistribution.submitDelete", "x-api-path-slug"=>"servicecontentdistribution-entrydistributionactionsubmitdelete-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Entrydistribution", "Action", "Submit"]}}, "/service/contentdistribution_entrydistribution/action/submitFetchReport"=>{"get"=>{"summary"=>"Get Service Contentdistribution Entrydistribution Action Submitfetchreport", "description"=>"Submits Entry Distribution report request", "operationId"=>"entryDistribution.submitFetchReport", "x-api-path-slug"=>"servicecontentdistribution-entrydistributionactionsubmitfetchreport-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Entrydistribution", "Action", "SubmitFetchReport"]}}, "/service/contentdistribution_entrydistribution/action/submitUpdate"=>{"get"=>{"summary"=>"Get Service Contentdistribution Entrydistribution Action Submitupdate", "description"=>"Submits Entry Distribution changes to the remote destination", "operationId"=>"entryDistribution.submitUpdate", "x-api-path-slug"=>"servicecontentdistribution-entrydistributionactionsubmitupdate-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Entrydistribution", "Action", "Submit"]}}, "/service/contentdistribution_entrydistribution/action/update"=>{"get"=>{"summary"=>"Get Service Contentdistribution Entrydistribution Action Update", "description"=>"Update Entry Distribution by id", "operationId"=>"entryDistribution.update", "x-api-path-slug"=>"servicecontentdistribution-entrydistributionactionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"entryDistribution[assetIds]", "description"=>"Comma separated asset ids"}, {"in"=>"query", "name"=>"entryDistribution[distributionProfileId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"entryDistribution[entryId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"entryDistribution[flavorAssetIds]", "description"=>"Comma separated flavor asset ids"}, {"in"=>"query", "name"=>"entryDistribution[sunrise]", "description"=>"Entry distribution publish time as Unix timestamp (In seconds)"}, {"in"=>"query", "name"=>"entryDistribution[sunset]", "description"=>"Entry distribution un-publish time as Unix timestamp (In seconds)"}, {"in"=>"query", "name"=>"entryDistribution[thumbAssetIds]", "description"=>"Comma separated thumbnail asset ids"}, {"in"=>"query", "name"=>"entryDistribution[validationErrors]"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Entrydistribution", "Action", "Update"]}}, "/service/contentdistribution_entrydistribution/action/validate"=>{"get"=>{"summary"=>"Get Service Contentdistribution Entrydistribution Action Valate", "description"=>"Validates Entry Distribution by id for submission", "operationId"=>"entryDistribution.validate", "x-api-path-slug"=>"servicecontentdistribution-entrydistributionactionvalidate-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Entrydistribution", "Action", "Validate"]}}, "/service/contentdistribution_genericdistributionprovider/action/add"=>{"get"=>{"summary"=>"Get Service Contentdistribution Genericdistributionprover Action Add", "description"=>"Add new Generic Distribution Provider", "operationId"=>"genericDistributionProvider.add", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionadd-get", "parameters"=>[{"in"=>"query", "name"=>"genericDistributionProvider[availabilityUpdateEnabled]"}, {"in"=>"query", "name"=>"genericDistributionProvider[deleteInsteadUpdate]"}, {"in"=>"query", "name"=>"genericDistributionProvider[editableFields]"}, {"in"=>"query", "name"=>"genericDistributionProvider[intervalBeforeSunrise]"}, {"in"=>"query", "name"=>"genericDistributionProvider[intervalBeforeSunset]"}, {"in"=>"query", "name"=>"genericDistributionProvider[isDefault]"}, {"in"=>"query", "name"=>"genericDistributionProvider[mandatoryFields]"}, {"in"=>"query", "name"=>"genericDistributionProvider[name]"}, {"in"=>"query", "name"=>"genericDistributionProvider[optionalFlavorParamsIds]"}, {"in"=>"query", "name"=>"genericDistributionProvider[optionalThumbDimensions]"}, {"in"=>"query", "name"=>"genericDistributionProvider[requiredFlavorParamsIds]"}, {"in"=>"query", "name"=>"genericDistributionProvider[requiredThumbDimensions]"}, {"in"=>"query", "name"=>"genericDistributionProvider[scheduleUpdateEnabled]"}, {"in"=>"query", "name"=>"genericDistributionProvider[updateRequiredEntryFields]"}, {"in"=>"query", "name"=>"genericDistributionProvider[updateRequiredMetadataXPaths]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovider", "Action", "Add"]}}, "/service/contentdistribution_genericdistributionprovider/action/delete"=>{"get"=>{"summary"=>"Get Service Contentdistribution Genericdistributionprover Action Delete", "description"=>"Delete Generic Distribution Provider by id", "operationId"=>"genericDistributionProvider.delete", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovider", "Action", "Delete"]}}, "/service/contentdistribution_genericdistributionprovider/action/get"=>{"get"=>{"summary"=>"Get Service Contentdistribution Genericdistributionprover Action Get", "description"=>"Get Generic Distribution Provider by id", "operationId"=>"genericDistributionProvider.get", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovider", "Action", "Get"]}}, "/service/contentdistribution_genericdistributionprovider/action/list"=>{"get"=>{"summary"=>"Get Service Contentdistribution Genericdistributionprover Action List", "description"=>"List all distribution providers", "operationId"=>"genericDistributionProvider.list", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[isDefaultEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[isDefaultIn]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[partnerIdEqual]"}, {"in"=>"query", "name"=>"filter[partnerIdIn]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaGenericDistributionProviderStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[typeEqual]", "description"=>"Enum Type: `KalturaDistributionProviderType`"}, {"in"=>"query", "name"=>"filter[typeIn]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovider", "Action", "List"]}}, "/service/contentdistribution_genericdistributionprovider/action/update"=>{"get"=>{"summary"=>"Get Service Contentdistribution Genericdistributionprover Action Update", "description"=>"Update Generic Distribution Provider by id", "operationId"=>"genericDistributionProvider.update", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"genericDistributionProvider[availabilityUpdateEnabled]"}, {"in"=>"query", "name"=>"genericDistributionProvider[deleteInsteadUpdate]"}, {"in"=>"query", "name"=>"genericDistributionProvider[editableFields]"}, {"in"=>"query", "name"=>"genericDistributionProvider[intervalBeforeSunrise]"}, {"in"=>"query", "name"=>"genericDistributionProvider[intervalBeforeSunset]"}, {"in"=>"query", "name"=>"genericDistributionProvider[isDefault]"}, {"in"=>"query", "name"=>"genericDistributionProvider[mandatoryFields]"}, {"in"=>"query", "name"=>"genericDistributionProvider[name]"}, {"in"=>"query", "name"=>"genericDistributionProvider[optionalFlavorParamsIds]"}, {"in"=>"query", "name"=>"genericDistributionProvider[optionalThumbDimensions]"}, {"in"=>"query", "name"=>"genericDistributionProvider[requiredFlavorParamsIds]"}, {"in"=>"query", "name"=>"genericDistributionProvider[requiredThumbDimensions]"}, {"in"=>"query", "name"=>"genericDistributionProvider[scheduleUpdateEnabled]"}, {"in"=>"query", "name"=>"genericDistributionProvider[updateRequiredEntryFields]"}, {"in"=>"query", "name"=>"genericDistributionProvider[updateRequiredMetadataXPaths]"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovider", "Action", "Update"]}}, "/service/contentdistribution_genericdistributionprovideraction/action/add"=>{"get"=>{"summary"=>"Get Service Contentdistribution Genericdistributionproveraction Action Add", "description"=>"Add new Generic Distribution Provider Action", "operationId"=>"genericDistributionProviderAction.add", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"genericDistributionProviderAction[action]", "description"=>"`insertOnly`Enum Type: `KalturaDistributionAction`"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[editableFields]"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[genericDistributionProviderId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[mandatoryFields]"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[protocol]", "description"=>"Enum Type: `KalturaDistributionProtocol`"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[remotePassword]"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[remotePath]"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[remoteUsername]"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[resultsParser]", "description"=>"Enum Type: `KalturaGenericDistributionProviderParser`"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[serverAddress]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovideraction", "Action", "Add"]}}, "/service/contentdistribution_genericdistributionprovideraction/action/addMrssTransform"=>{"get"=>{"summary"=>"Get Service Contentdistribution Genericdistributionproveraction Action Addmrsstransform", "description"=>"Add MRSS transform file to generic distribution provider action", "operationId"=>"genericDistributionProviderAction.addMrssTransform", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionactionaddmrsstransform-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"the id of the generic distribution provider action"}, {"in"=>"query", "name"=>"xslData", "description"=>"XSL MRSS transformation data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovideraction", "Action", "AddMrssTransform"]}}, "/service/contentdistribution_genericdistributionprovideraction/action/addMrssTransformFromFile"=>{"post"=>{"summary"=>"Post Service Contentdistribution Genericdistributionproveraction Action Addmrsstransformfromfile", "description"=>"Add MRSS transform file to generic distribution provider action", "operationId"=>"genericDistributionProviderAction.addMrssTransformFromFile", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionactionaddmrsstransformfromfile-post", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"the id of the generic distribution provider action"}, {"in"=>"formData", "name"=>"xslFile", "description"=>"XSL MRSS transformation file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovideraction", "Action", "AddMrssTransformFromFile"]}}, "/service/contentdistribution_genericdistributionprovideraction/action/addMrssValidate"=>{"get"=>{"summary"=>"Get Service Contentdistribution Genericdistributionproveraction Action Addmrssvalate", "description"=>"Add MRSS validate file to generic distribution provider action", "operationId"=>"genericDistributionProviderAction.addMrssValidate", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionactionaddmrssvalidate-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"the id of the generic distribution provider action"}, {"in"=>"query", "name"=>"xsdData", "description"=>"XSD MRSS validatation data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovideraction", "Action", "AddMrssValidate"]}}, "/service/contentdistribution_genericdistributionprovideraction/action/addMrssValidateFromFile"=>{"post"=>{"summary"=>"Post Service Contentdistribution Genericdistributionproveraction Action Addmrssvalatefromfile", "description"=>"Add MRSS validate file to generic distribution provider action", "operationId"=>"genericDistributionProviderAction.addMrssValidateFromFile", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionactionaddmrssvalidatefromfile-post", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"the id of the generic distribution provider action"}, {"in"=>"formData", "name"=>"xsdFile", "description"=>"XSD MRSS validatation file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovideraction", "Action", "AddMrssValidateFromFile"]}}, "/service/contentdistribution_genericdistributionprovideraction/action/addResultsTransform"=>{"get"=>{"summary"=>"Get Service Contentdistribution Genericdistributionproveraction Action Addresultstransform", "description"=>"Add results transform file to generic distribution provider action", "operationId"=>"genericDistributionProviderAction.addResultsTransform", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionactionaddresultstransform-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"the id of the generic distribution provider action"}, {"in"=>"query", "name"=>"transformData", "description"=>"transformation data xsl, xPath or regex"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovideraction", "Action", "AddResultsTransform"]}}, "/service/contentdistribution_genericdistributionprovideraction/action/addResultsTransformFromFile"=>{"post"=>{"summary"=>"Post Service Contentdistribution Genericdistributionproveraction Action Addresultstransformfromfile", "description"=>"Add MRSS transform file to generic distribution provider action", "operationId"=>"genericDistributionProviderAction.addResultsTransformFromFile", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionactionaddresultstransformfromfile-post", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"the id of the generic distribution provider action"}, {"in"=>"formData", "name"=>"transformFile", "description"=>"transformation file xsl, xPath or regex"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovideraction", "Action", "AddResultsTransformFromFile"]}}, "/service/contentdistribution_genericdistributionprovideraction/action/delete"=>{"get"=>{"summary"=>"Get Service Contentdistribution Genericdistributionproveraction Action Delete", "description"=>"Delete Generic Distribution Provider Action by id", "operationId"=>"genericDistributionProviderAction.delete", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionactiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovideraction", "Action", "Delete"]}}, "/service/contentdistribution_genericdistributionprovideraction/action/deleteByProviderId"=>{"get"=>{"summary"=>"Get Service Contentdistribution Genericdistributionproveraction Action Deletebyproverid", "description"=>"Delete Generic Distribution Provider Action by provider id", "operationId"=>"genericDistributionProviderAction.deleteByProviderId", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionactiondeletebyproviderid-get", "parameters"=>[{"in"=>"query", "name"=>"actionType", "description"=>"Enum Type: `KalturaDistributionAction`"}, {"in"=>"query", "name"=>"genericDistributionProviderId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovideraction", "Action", "DeleteByProviderId"]}}, "/service/contentdistribution_genericdistributionprovideraction/action/get"=>{"get"=>{"summary"=>"Get Service Contentdistribution Genericdistributionproveraction Action Get", "description"=>"Get Generic Distribution Provider Action by id", "operationId"=>"genericDistributionProviderAction.get", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionactionget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovideraction", "Action", "Get"]}}, "/service/contentdistribution_genericdistributionprovideraction/action/getByProviderId"=>{"get"=>{"summary"=>"Get Service Contentdistribution Genericdistributionproveraction Action Getbyproverid", "description"=>"Get Generic Distribution Provider Action by provider id", "operationId"=>"genericDistributionProviderAction.getByProviderId", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionactiongetbyproviderid-get", "parameters"=>[{"in"=>"query", "name"=>"actionType", "description"=>"Enum Type: `KalturaDistributionAction`"}, {"in"=>"query", "name"=>"genericDistributionProviderId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovideraction", "Action", "GetByProviderId"]}}, "/service/contentdistribution_genericdistributionprovideraction/action/list"=>{"get"=>{"summary"=>"Get Service Contentdistribution Genericdistributionproveraction Action List", "description"=>"List all distribution providers", "operationId"=>"genericDistributionProviderAction.list", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[actionEqual]", "description"=>"Enum Type: `KalturaDistributionAction`"}, {"in"=>"query", "name"=>"filter[actionIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[genericDistributionProviderIdEqual]"}, {"in"=>"query", "name"=>"filter[genericDistributionProviderIdIn]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovideraction", "Action", "List"]}}, "/service/contentdistribution_genericdistributionprovideraction/action/update"=>{"get"=>{"summary"=>"Get Service Contentdistribution Genericdistributionproveraction Action Update", "description"=>"Update Generic Distribution Provider Action by id", "operationId"=>"genericDistributionProviderAction.update", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionactionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"genericDistributionProviderAction[action]", "description"=>"`insertOnly`Enum Type: `KalturaDistributionAction`"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[editableFields]"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[genericDistributionProviderId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[mandatoryFields]"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[protocol]", "description"=>"Enum Type: `KalturaDistributionProtocol`"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[remotePassword]"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[remotePath]"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[remoteUsername]"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[resultsParser]", "description"=>"Enum Type: `KalturaGenericDistributionProviderParser`"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[serverAddress]"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovideraction", "Action", "Update"]}}, "/service/contentdistribution_genericdistributionprovideraction/action/updateByProviderId"=>{"get"=>{"summary"=>"Get Service Contentdistribution Genericdistributionproveraction Action Updatebyproverid", "description"=>"Update Generic Distribution Provider Action by provider id", "operationId"=>"genericDistributionProviderAction.updateByProviderId", "x-api-path-slug"=>"servicecontentdistribution-genericdistributionprovideractionactionupdatebyproviderid-get", "parameters"=>[{"in"=>"query", "name"=>"actionType", "description"=>"Enum Type: `KalturaDistributionAction`"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[action]", "description"=>"`insertOnly`Enum Type: `KalturaDistributionAction`"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[editableFields]"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[genericDistributionProviderId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[mandatoryFields]"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[protocol]", "description"=>"Enum Type: `KalturaDistributionProtocol`"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[remotePassword]"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[remotePath]"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[remoteUsername]"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[resultsParser]", "description"=>"Enum Type: `KalturaGenericDistributionProviderParser`"}, {"in"=>"query", "name"=>"genericDistributionProviderAction[serverAddress]"}, {"in"=>"query", "name"=>"genericDistributionProviderId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Contentdistribution", "Genericdistributionprovideraction", "Action", "UpdateByProviderId"]}}, "/service/conversionprofile/action/add"=>{"get"=>{"summary"=>"Get Service Conversionprofile Action Add", "description"=>"Add new Conversion Profile", "operationId"=>"conversionProfile.add", "x-api-path-slug"=>"serviceconversionprofileactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"conversionProfile[cropDimensions][height]", "description"=>"Crop height"}, {"in"=>"query", "name"=>"conversionProfile[cropDimensions][left]", "description"=>"Crop left point"}, {"in"=>"query", "name"=>"conversionProfile[cropDimensions][top]", "description"=>"Crop top point"}, {"in"=>"query", "name"=>"conversionProfile[cropDimensions][width]", "description"=>"Crop width"}, {"in"=>"query", "name"=>"conversionProfile[defaultEntryId]", "description"=>"ID of the default entry to be used for template data"}, {"in"=>"query", "name"=>"conversionProfile[description]", "description"=>"The description of the Conversion Profile"}, {"in"=>"query", "name"=>"conversionProfile[flavorParamsIds]", "description"=>"List of included flavor ids (comma separated)"}, {"in"=>"query", "name"=>"conversionProfile[isDefault]", "description"=>"Enum Type: `KalturaNullableBoolean`Indicates that this conversion profile is system default"}, {"in"=>"query", "name"=>"conversionProfile[name]", "description"=>"The name of the Conversion Profile"}, {"in"=>"query", "name"=>"conversionProfile[status]", "description"=>"Enum Type: `KalturaConversionProfileStatus`"}, {"in"=>"query", "name"=>"conversionProfile[systemName]", "description"=>"System name of the Conversion Profile"}, {"in"=>"query", "name"=>"conversionProfile[tags]", "description"=>"Comma separated tags"}, {"in"=>"query", "name"=>"conversionProfile[type]", "description"=>"`insertOnly`Enum Type: `KalturaConversionProfileType`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Conversionprofile", "Action", "Add"]}}, "/service/conversionprofile/action/delete"=>{"get"=>{"summary"=>"Get Service Conversionprofile Action Delete", "description"=>"Delete Conversion Profile by ID", "operationId"=>"conversionProfile.delete", "x-api-path-slug"=>"serviceconversionprofileactiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Conversionprofile", "Action", "Delete"]}}, "/service/conversionprofile/action/get"=>{"get"=>{"summary"=>"Get Service Conversionprofile Action Get", "description"=>"Get Conversion Profile by ID", "operationId"=>"conversionProfile.get", "x-api-path-slug"=>"serviceconversionprofileactionget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Conversionprofile", "Action", "Get"]}}, "/service/conversionprofile/action/getDefault"=>{"get"=>{"summary"=>"Get Service Conversionprofile Action Getdefault", "description"=>"Get the partner's default conversion profile", "operationId"=>"conversionProfile.getDefault", "x-api-path-slug"=>"serviceconversionprofileactiongetdefault-get", "parameters"=>[{"in"=>"query", "name"=>"type", "description"=>"Enum Type: `KalturaConversionProfileType`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Conversionprofile", "Action", "GetDefault"]}}, "/service/conversionprofile/action/list"=>{"get"=>{"summary"=>"Get Service Conversionprofile Action List", "description"=>"List Conversion Profiles by filter with paging support", "operationId"=>"conversionProfile.list", "x-api-path-slug"=>"serviceconversionprofileactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[defaultEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[defaultEntryIdIn]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[nameEqual]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaConversionProfileStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[systemNameEqual]"}, {"in"=>"query", "name"=>"filter[systemNameIn]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[typeEqual]", "description"=>"Enum Type: `KalturaConversionProfileType`"}, {"in"=>"query", "name"=>"filter[typeIn]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Conversionprofile", "Action", "List"]}}, "/service/conversionprofile/action/setAsDefault"=>{"get"=>{"summary"=>"Get Service Conversionprofile Action Setasdefault", "description"=>"Set Conversion Profile to be the partner default", "operationId"=>"conversionProfile.setAsDefault", "x-api-path-slug"=>"serviceconversionprofileactionsetasdefault-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Conversionprofile", "Action", "SetAsDefault"]}}, "/service/conversionprofile/action/update"=>{"get"=>{"summary"=>"Get Service Conversionprofile Action Update", "description"=>"Update Conversion Profile by ID", "operationId"=>"conversionProfile.update", "x-api-path-slug"=>"serviceconversionprofileactionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"conversionProfile[cropDimensions][height]", "description"=>"Crop height"}, {"in"=>"query", "name"=>"conversionProfile[cropDimensions][left]", "description"=>"Crop left point"}, {"in"=>"query", "name"=>"conversionProfile[cropDimensions][top]", "description"=>"Crop top point"}, {"in"=>"query", "name"=>"conversionProfile[cropDimensions][width]", "description"=>"Crop width"}, {"in"=>"query", "name"=>"conversionProfile[defaultEntryId]", "description"=>"ID of the default entry to be used for template data"}, {"in"=>"query", "name"=>"conversionProfile[description]", "description"=>"The description of the Conversion Profile"}, {"in"=>"query", "name"=>"conversionProfile[flavorParamsIds]", "description"=>"List of included flavor ids (comma separated)"}, {"in"=>"query", "name"=>"conversionProfile[isDefault]", "description"=>"Enum Type: `KalturaNullableBoolean`Indicates that this conversion profile is system default"}, {"in"=>"query", "name"=>"conversionProfile[name]", "description"=>"The name of the Conversion Profile"}, {"in"=>"query", "name"=>"conversionProfile[status]", "description"=>"Enum Type: `KalturaConversionProfileStatus`"}, {"in"=>"query", "name"=>"conversionProfile[systemName]", "description"=>"System name of the Conversion Profile"}, {"in"=>"query", "name"=>"conversionProfile[tags]", "description"=>"Comma separated tags"}, {"in"=>"query", "name"=>"conversionProfile[type]", "description"=>"`insertOnly`Enum Type: `KalturaConversionProfileType`"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Conversionprofile", "Action", "Update"]}}, "/service/conversionprofileassetparams/action/list"=>{"get"=>{"summary"=>"Get Service Conversionprofileassetparams Action List", "description"=>"Lists asset parmas of conversion profile by ID", "operationId"=>"conversionProfileAssetParams.list", "x-api-path-slug"=>"serviceconversionprofileassetparamsactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[assetParamsIdEqual]"}, {"in"=>"query", "name"=>"filter[assetParamsIdIn]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdEqual]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][defaultEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][defaultEntryIdIn]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][idEqual]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][idIn]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][nameEqual]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][orderBy]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][statusEqual]", "description"=>"Enum Type: `KalturaConversionProfileStatus`"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][statusIn]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][systemNameEqual]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][systemNameIn]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][tagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][tagsMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][typeEqual]", "description"=>"Enum Type: `KalturaConversionProfileType`"}, {"in"=>"query", "name"=>"filter[conversionProfileIdFilter][typeIn]"}, {"in"=>"query", "name"=>"filter[conversionProfileIdIn]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[originEqual]", "description"=>"Enum Type: `KalturaAssetParamsOrigin`"}, {"in"=>"query", "name"=>"filter[originIn]"}, {"in"=>"query", "name"=>"filter[readyBehaviorEqual]", "description"=>"Enum Type: `KalturaFlavorReadyBehaviorType`"}, {"in"=>"query", "name"=>"filter[readyBehaviorIn]"}, {"in"=>"query", "name"=>"filter[systemNameEqual]"}, {"in"=>"query", "name"=>"filter[systemNameIn]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Conversionprofileassetparams", "Action", "List"]}}, "/service/conversionprofileassetparams/action/update"=>{"get"=>{"summary"=>"Get Service Conversionprofileassetparams Action Update", "description"=>"Update asset parmas of conversion profile by ID", "operationId"=>"conversionProfileAssetParams.update", "x-api-path-slug"=>"serviceconversionprofileassetparamsactionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"assetParamsId"}, {"in"=>"query", "name"=>"conversionProfileAssetParams[contentAwareness]"}, {"in"=>"query", "name"=>"conversionProfileAssetParams[deletePolicy]", "description"=>"Enum Type: `KalturaAssetParamsDeletePolicy`Specifies how to treat the flavor after conversion is finished"}, {"in"=>"query", "name"=>"conversionProfileAssetParams[forceNoneComplied]", "description"=>"Enum Type: `KalturaNullableBoolean`Starts conversion even if the decision layer reduced the configuration to comply with the source"}, {"in"=>"query", "name"=>"conversionProfileAssetParams[isEncrypted]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"conversionProfileAssetParams[origin]", "description"=>"Enum Type: `KalturaAssetParamsOrigin`The ingestion origin of the asset params"}, {"in"=>"query", "name"=>"conversionProfileAssetParams[readyBehavior]", "description"=>"Enum Type: `KalturaFlavorReadyBehaviorType`The ingestion origin of the asset params"}, {"in"=>"query", "name"=>"conversionProfileAssetParams[systemName]", "description"=>"Asset params system name"}, {"in"=>"query", "name"=>"conversionProfileAssetParams[tags]"}, {"in"=>"query", "name"=>"conversionProfileAssetParams[twoPass]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"conversionProfileId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Conversionprofileassetparams", "Action", "Update"]}}, "/service/cuepoint_cuepoint/action/add"=>{"get"=>{"summary"=>"Get Service Cuepoint Cuepoint Action Add", "description"=>"Allows you to add an cue point object associated with an entry", "operationId"=>"cuePoint.add", "x-api-path-slug"=>"servicecuepoint-cuepointactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"cuePoint[adType]", "description"=>"Enum Type: `KalturaAdType`"}, {"in"=>"query", "name"=>"cuePoint[answerKey]"}, {"in"=>"query", "name"=>"cuePoint[assetId]"}, {"in"=>"query", "name"=>"cuePoint[code]"}, {"in"=>"query", "name"=>"cuePoint[correctAnswerKeys]"}, {"in"=>"query", "name"=>"cuePoint[description]"}, {"in"=>"query", "name"=>"cuePoint[duration]", "description"=>"Duration in milliseconds"}, {"in"=>"query", "name"=>"cuePoint[endTime]", "description"=>"End time in milliseconds"}, {"in"=>"query", "name"=>"cuePoint[entryId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"cuePoint[eventType]", "description"=>"Enum Type: `KalturaEventType`"}, {"in"=>"query", "name"=>"cuePoint[explanation]"}, {"in"=>"query", "name"=>"cuePoint[forceStop]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"cuePoint[hint]"}, {"in"=>"query", "name"=>"cuePoint[isPublic]", "description"=>"Enum Type: `KalturaNullableBoolean`Is the annotation public"}, {"in"=>"query", "name"=>"cuePoint[objectType]"}, {"in"=>"query", "name"=>"cuePoint[optionalAnswers]"}, {"in"=>"query", "name"=>"cuePoint[parentId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"cuePoint[partnerData]"}, {"in"=>"query", "name"=>"cuePoint[partnerSortValue]"}, {"in"=>"query", "name"=>"cuePoint[protocolType]", "description"=>"`insertOnly`Enum Type: `KalturaAdProtocolType`"}, {"in"=>"query", "name"=>"cuePoint[question]"}, {"in"=>"query", "name"=>"cuePoint[quizUserEntryId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"cuePoint[searchableOnEntry]", "description"=>"Enum Type: `KalturaNullableBoolean`Should the cue point get indexed on the entry"}, {"in"=>"query", "name"=>"cuePoint[sourceUrl]"}, {"in"=>"query", "name"=>"cuePoint[startTime]", "description"=>"Start time in milliseconds"}, {"in"=>"query", "name"=>"cuePoint[subType]", "description"=>"Enum Type: `KalturaThumbCuePointSubType`The sub type of the ThumbCuePoint"}, {"in"=>"query", "name"=>"cuePoint[systemName]"}, {"in"=>"query", "name"=>"cuePoint[tags]"}, {"in"=>"query", "name"=>"cuePoint[text]"}, {"in"=>"query", "name"=>"cuePoint[thumbOffset]"}, {"in"=>"query", "name"=>"cuePoint[title]"}, {"in"=>"query", "name"=>"cuePoint[triggeredAt]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Cuepoint", "Cuepoint", "Action", "Add"]}}, "/service/cuepoint_cuepoint/action/addFromBulk"=>{"post"=>{"summary"=>"Post Service Cuepoint Cuepoint Action Addfrombulk", "description"=>"Allows you to add multiple cue points objects by uploading XML that contains multiple cue point definitions", "operationId"=>"cuePoint.addFromBulk", "x-api-path-slug"=>"servicecuepoint-cuepointactionaddfrombulk-post", "parameters"=>[{"in"=>"formData", "name"=>"fileData"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Cuepoint", "Cuepoint", "Action", "AddFromBulk"]}}, "/service/cuepoint_cuepoint/action/clone"=>{"get"=>{"summary"=>"Get Service Cuepoint Cuepoint Action Clone", "description"=>"Clone cuePoint with id to given entry", "operationId"=>"cuePoint.clone", "x-api-path-slug"=>"servicecuepoint-cuepointactionclone-get", "parameters"=>[{"in"=>"query", "name"=>"entryId"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Cuepoint", "Cuepoint", "Action", "Clone"]}}, "/service/cuepoint_cuepoint/action/count"=>{"get"=>{"summary"=>"Get Service Cuepoint Cuepoint Action Count", "description"=>"count cue point objects by filter", "operationId"=>"cuePoint.count", "x-api-path-slug"=>"servicecuepoint-cuepointactioncount-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[codeEqual]"}, {"in"=>"query", "name"=>"filter[codeIn]"}, {"in"=>"query", "name"=>"filter[codeLike]"}, {"in"=>"query", "name"=>"filter[codeMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[codeMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[cuePointTypeEqual]", "description"=>"Enum Type: `KalturaCuePointType`"}, {"in"=>"query", "name"=>"filter[cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[descriptionLike]"}, {"in"=>"query", "name"=>"filter[descriptionMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[descriptionMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[durationGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[durationLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[entryIdEqual]"}, {"in"=>"query", "name"=>"filter[entryIdIn]"}, {"in"=>"query", "name"=>"filter[eventTypeEqual]", "description"=>"Enum Type: `KalturaEventType`"}, {"in"=>"query", "name"=>"filter[eventTypeIn]"}, {"in"=>"query", "name"=>"filter[forceStopEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[freeText]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[isPublicEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[parentIdEqual]"}, {"in"=>"query", "name"=>"filter[parentIdIn]"}, {"in"=>"query", "name"=>"filter[partnerSortValueEqual]"}, {"in"=>"query", "name"=>"filter[partnerSortValueGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[partnerSortValueIn]"}, {"in"=>"query", "name"=>"filter[partnerSortValueLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[protocolTypeEqual]", "description"=>"Enum Type: `KalturaAdProtocolType`"}, {"in"=>"query", "name"=>"filter[protocolTypeIn]"}, {"in"=>"query", "name"=>"filter[questionLike]"}, {"in"=>"query", "name"=>"filter[questionMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[questionMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[quizUserEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[quizUserEntryIdIn]"}, {"in"=>"query", "name"=>"filter[startTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[startTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaCuePointStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[subTypeEqual]", "description"=>"Enum Type: `KalturaThumbCuePointSubType`"}, {"in"=>"query", "name"=>"filter[subTypeIn]"}, {"in"=>"query", "name"=>"filter[systemNameEqual]"}, {"in"=>"query", "name"=>"filter[systemNameIn]"}, {"in"=>"query", "name"=>"filter[tagsLike]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[textLike]"}, {"in"=>"query", "name"=>"filter[textMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[textMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[titleLike]"}, {"in"=>"query", "name"=>"filter[titleMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[titleMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[triggeredAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[triggeredAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[userIdCurrent]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[userIdEqualCurrent]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[userIdEqual]"}, {"in"=>"query", "name"=>"filter[userIdIn]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Cuepoint", "Cuepoint", "Action", "Count"]}}, "/service/cuepoint_cuepoint/action/delete"=>{"get"=>{"summary"=>"Get Service Cuepoint Cuepoint Action Delete", "description"=>"delete cue point by id, and delete all children cue points", "operationId"=>"cuePoint.delete", "x-api-path-slug"=>"servicecuepoint-cuepointactiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Cuepoint", "Cuepoint", "Action", "Delete"]}}, "/service/cuepoint_cuepoint/action/get"=>{"get"=>{"summary"=>"Get Service Cuepoint Cuepoint Action Get", "description"=>"Retrieve an CuePoint object by id", "operationId"=>"cuePoint.get", "x-api-path-slug"=>"servicecuepoint-cuepointactionget-get", "parameters"=>[{"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Cuepoint", "Cuepoint", "Action", "Get"]}}, "/service/cuepoint_cuepoint/action/list"=>{"get"=>{"summary"=>"Get Service Cuepoint Cuepoint Action List", "description"=>"List cue point objects by filter and pager", "operationId"=>"cuePoint.list", "x-api-path-slug"=>"servicecuepoint-cuepointactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[codeEqual]"}, {"in"=>"query", "name"=>"filter[codeIn]"}, {"in"=>"query", "name"=>"filter[codeLike]"}, {"in"=>"query", "name"=>"filter[codeMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[codeMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[cuePointTypeEqual]", "description"=>"Enum Type: `KalturaCuePointType`"}, {"in"=>"query", "name"=>"filter[cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[descriptionLike]"}, {"in"=>"query", "name"=>"filter[descriptionMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[descriptionMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[durationGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[durationLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[entryIdEqual]"}, {"in"=>"query", "name"=>"filter[entryIdIn]"}, {"in"=>"query", "name"=>"filter[eventTypeEqual]", "description"=>"Enum Type: `KalturaEventType`"}, {"in"=>"query", "name"=>"filter[eventTypeIn]"}, {"in"=>"query", "name"=>"filter[forceStopEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[freeText]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[isPublicEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[parentIdEqual]"}, {"in"=>"query", "name"=>"filter[parentIdIn]"}, {"in"=>"query", "name"=>"filter[partnerSortValueEqual]"}, {"in"=>"query", "name"=>"filter[partnerSortValueGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[partnerSortValueIn]"}, {"in"=>"query", "name"=>"filter[partnerSortValueLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[protocolTypeEqual]", "description"=>"Enum Type: `KalturaAdProtocolType`"}, {"in"=>"query", "name"=>"filter[protocolTypeIn]"}, {"in"=>"query", "name"=>"filter[questionLike]"}, {"in"=>"query", "name"=>"filter[questionMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[questionMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[quizUserEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[quizUserEntryIdIn]"}, {"in"=>"query", "name"=>"filter[startTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[startTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaCuePointStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[subTypeEqual]", "description"=>"Enum Type: `KalturaThumbCuePointSubType`"}, {"in"=>"query", "name"=>"filter[subTypeIn]"}, {"in"=>"query", "name"=>"filter[systemNameEqual]"}, {"in"=>"query", "name"=>"filter[systemNameIn]"}, {"in"=>"query", "name"=>"filter[tagsLike]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[textLike]"}, {"in"=>"query", "name"=>"filter[textMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[textMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[titleLike]"}, {"in"=>"query", "name"=>"filter[titleMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[titleMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[triggeredAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[triggeredAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[userIdCurrent]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[userIdEqualCurrent]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[userIdEqual]"}, {"in"=>"query", "name"=>"filter[userIdIn]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Cuepoint", "Cuepoint", "Action", "List"]}}, "/service/cuepoint_cuepoint/action/serveBulk"=>{"get"=>{"summary"=>"Get Service Cuepoint Cuepoint Action Servebulk", "description"=>"Download multiple cue points objects as XML definitions", "operationId"=>"cuePoint.serveBulk", "x-api-path-slug"=>"servicecuepoint-cuepointactionservebulk-get", "parameters"=>[{"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[codeEqual]"}, {"in"=>"query", "name"=>"filter[codeIn]"}, {"in"=>"query", "name"=>"filter[codeLike]"}, {"in"=>"query", "name"=>"filter[codeMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[codeMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[cuePointTypeEqual]", "description"=>"Enum Type: `KalturaCuePointType`"}, {"in"=>"query", "name"=>"filter[cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[descriptionLike]"}, {"in"=>"query", "name"=>"filter[descriptionMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[descriptionMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[durationGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[durationLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[entryIdEqual]"}, {"in"=>"query", "name"=>"filter[entryIdIn]"}, {"in"=>"query", "name"=>"filter[eventTypeEqual]", "description"=>"Enum Type: `KalturaEventType`"}, {"in"=>"query", "name"=>"filter[eventTypeIn]"}, {"in"=>"query", "name"=>"filter[forceStopEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[freeText]"}, {"in"=>"query", "name"=>"filter[idEqual]"}, {"in"=>"query", "name"=>"filter[idIn]"}, {"in"=>"query", "name"=>"filter[isPublicEqual]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[objectType]"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[parentIdEqual]"}, {"in"=>"query", "name"=>"filter[parentIdIn]"}, {"in"=>"query", "name"=>"filter[partnerSortValueEqual]"}, {"in"=>"query", "name"=>"filter[partnerSortValueGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[partnerSortValueIn]"}, {"in"=>"query", "name"=>"filter[partnerSortValueLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[protocolTypeEqual]", "description"=>"Enum Type: `KalturaAdProtocolType`"}, {"in"=>"query", "name"=>"filter[protocolTypeIn]"}, {"in"=>"query", "name"=>"filter[questionLike]"}, {"in"=>"query", "name"=>"filter[questionMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[questionMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[quizUserEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[quizUserEntryIdIn]"}, {"in"=>"query", "name"=>"filter[startTimeGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[startTimeLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaCuePointStatus`"}, {"in"=>"query", "name"=>"filter[statusIn]"}, {"in"=>"query", "name"=>"filter[subTypeEqual]", "description"=>"Enum Type: `KalturaThumbCuePointSubType`"}, {"in"=>"query", "name"=>"filter[subTypeIn]"}, {"in"=>"query", "name"=>"filter[systemNameEqual]"}, {"in"=>"query", "name"=>"filter[systemNameIn]"}, {"in"=>"query", "name"=>"filter[tagsLike]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[textLike]"}, {"in"=>"query", "name"=>"filter[textMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[textMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[titleLike]"}, {"in"=>"query", "name"=>"filter[titleMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[titleMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[triggeredAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[triggeredAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[userIdCurrent]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[userIdEqualCurrent]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[userIdEqual]"}, {"in"=>"query", "name"=>"filter[userIdIn]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Cuepoint", "Cuepoint", "Action", "ServeBulk"]}}, "/service/cuepoint_cuepoint/action/update"=>{"get"=>{"summary"=>"Get Service Cuepoint Cuepoint Action Update", "description"=>"Update cue point by id", "operationId"=>"cuePoint.update", "x-api-path-slug"=>"servicecuepoint-cuepointactionupdate-get", "parameters"=>[{"in"=>"query", "name"=>"cuePoint[adType]", "description"=>"Enum Type: `KalturaAdType`"}, {"in"=>"query", "name"=>"cuePoint[answerKey]"}, {"in"=>"query", "name"=>"cuePoint[assetId]"}, {"in"=>"query", "name"=>"cuePoint[code]"}, {"in"=>"query", "name"=>"cuePoint[correctAnswerKeys]"}, {"in"=>"query", "name"=>"cuePoint[description]"}, {"in"=>"query", "name"=>"cuePoint[duration]", "description"=>"Duration in milliseconds"}, {"in"=>"query", "name"=>"cuePoint[endTime]", "description"=>"End time in milliseconds"}, {"in"=>"query", "name"=>"cuePoint[entryId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"cuePoint[eventType]", "description"=>"Enum Type: `KalturaEventType`"}, {"in"=>"query", "name"=>"cuePoint[explanation]"}, {"in"=>"query", "name"=>"cuePoint[forceStop]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"cuePoint[hint]"}, {"in"=>"query", "name"=>"cuePoint[isPublic]", "description"=>"Enum Type: `KalturaNullableBoolean`Is the annotation public"}, {"in"=>"query", "name"=>"cuePoint[objectType]"}, {"in"=>"query", "name"=>"cuePoint[optionalAnswers]"}, {"in"=>"query", "name"=>"cuePoint[parentId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"cuePoint[partnerData]"}, {"in"=>"query", "name"=>"cuePoint[partnerSortValue]"}, {"in"=>"query", "name"=>"cuePoint[protocolType]", "description"=>"`insertOnly`Enum Type: `KalturaAdProtocolType`"}, {"in"=>"query", "name"=>"cuePoint[question]"}, {"in"=>"query", "name"=>"cuePoint[quizUserEntryId]", "description"=>"`insertOnly`"}, {"in"=>"query", "name"=>"cuePoint[searchableOnEntry]", "description"=>"Enum Type: `KalturaNullableBoolean`Should the cue point get indexed on the entry"}, {"in"=>"query", "name"=>"cuePoint[sourceUrl]"}, {"in"=>"query", "name"=>"cuePoint[startTime]", "description"=>"Start time in milliseconds"}, {"in"=>"query", "name"=>"cuePoint[subType]", "description"=>"Enum Type: `KalturaThumbCuePointSubType`The sub type of the ThumbCuePoint"}, {"in"=>"query", "name"=>"cuePoint[systemName]"}, {"in"=>"query", "name"=>"cuePoint[tags]"}, {"in"=>"query", "name"=>"cuePoint[text]"}, {"in"=>"query", "name"=>"cuePoint[thumbOffset]"}, {"in"=>"query", "name"=>"cuePoint[title]"}, {"in"=>"query", "name"=>"cuePoint[triggeredAt]"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Cuepoint", "Cuepoint", "Action", "Update"]}}, "/service/cuepoint_cuepoint/action/updateStatus"=>{"get"=>{"summary"=>"Get Service Cuepoint Cuepoint Action Updatestatus", "description"=>"Update cuePoint status by id", "operationId"=>"cuePoint.updateStatus", "x-api-path-slug"=>"servicecuepoint-cuepointactionupdatestatus-get", "parameters"=>[{"in"=>"query", "name"=>"id"}, {"in"=>"query", "name"=>"status", "description"=>"Enum Type: `KalturaCuePointStatus`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Cuepoint", "Cuepoint", "Action", "UpdateStatus"]}}, "/service/data/action/add"=>{"get"=>{"summary"=>"Get Service Data Action Add", "description"=>"Adds a new data entry", "operationId"=>"data.add", "x-api-path-slug"=>"servicedataactionadd-get", "parameters"=>[{"in"=>"query", "name"=>"dataEntry[accessControlId]", "description"=>"The Access Control ID assigned to this entry (null when not set, send -1 to remove)"}, {"in"=>"query", "name"=>"dataEntry[adminTags]", "description"=>"Entry admin tags can be updated only by administrators"}, {"in"=>"query", "name"=>"dataEntry[categoriesIds]", "description"=>"Comma separated list of ids of categories to which this entry belongs"}, {"in"=>"query", "name"=>"dataEntry[categories]", "description"=>"Comma separated list of full names of categories to which this entry belongs"}, {"in"=>"query", "name"=>"dataEntry[conversionProfileId]", "description"=>"Override the default ingestion profile"}, {"in"=>"query", "name"=>"dataEntry[creatorId]", "description"=>"`insertOnly`The ID of the user who created this entry"}, {"in"=>"query", "name"=>"dataEntry[dataContent]", "description"=>"The data of the entry"}, {"in"=>"query", "name"=>"dataEntry[description]", "description"=>"Entry description"}, {"in"=>"query", "name"=>"dataEntry[displayInSearch]", "description"=>"Enum Type: `KalturaEntryDisplayInSearchType`should we display this entry in search"}, {"in"=>"query", "name"=>"dataEntry[endDate]", "description"=>"Entry scheduling end date (null when not set, send -1 to remove)"}, {"in"=>"query", "name"=>"dataEntry[entitledUsersEdit]", "description"=>"list of user ids that are entitled to edit the entry (no server enforcement) The difference between entitledUsersEdit and entitledUsersPublish is applicative only"}, {"in"=>"query", "name"=>"dataEntry[entitledUsersPublish]", "description"=>"list of user ids that are entitled to publish the entry (no server enforcement) The difference between entitledUsersEdit and entitledUsersPublish is applicative only"}, {"in"=>"query", "name"=>"dataEntry[groupId]"}, {"in"=>"query", "name"=>"dataEntry[licenseType]", "description"=>"Enum Type: `KalturaLicenseType`License type used for this entry"}, {"in"=>"query", "name"=>"dataEntry[name]", "description"=>"Entry name (Min 1 chars)"}, {"in"=>"query", "name"=>"dataEntry[operationAttributes]"}, {"in"=>"query", "name"=>"dataEntry[parentEntryId]", "description"=>"ID of source root entry, used for defining entires association"}, {"in"=>"query", "name"=>"dataEntry[partnerData]", "description"=>"Can be used to store various partner related data as a string"}, {"in"=>"query", "name"=>"dataEntry[partnerSortValue]", "description"=>"Can be used to store various partner related data as a numeric value"}, {"in"=>"query", "name"=>"dataEntry[redirectEntryId]", "description"=>"IF not empty, points to an entry ID the should replace this current entrys id"}, {"in"=>"query", "name"=>"dataEntry[referenceId]", "description"=>"Entry external reference id"}, {"in"=>"query", "name"=>"dataEntry[retrieveDataContentByGet]", "description"=>"`insertOnly`indicator whether to return the object for get action with the dataContent field"}, {"in"=>"query", "name"=>"dataEntry[startDate]", "description"=>"Entry scheduling start date (null when not set, send -1 to remove)"}, {"in"=>"query", "name"=>"dataEntry[tags]", "description"=>"Entry tags"}, {"in"=>"query", "name"=>"dataEntry[templateEntryId]", "description"=>"`insertOnly`Template entry id"}, {"in"=>"query", "name"=>"dataEntry[type]", "description"=>"Enum Type: `KalturaEntryType`The type of the entry, this is auto filled by the derived entry object"}, {"in"=>"query", "name"=>"dataEntry[userId]", "description"=>"The ID of the user who is the owner of this entry"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Data", "Action", "Add"]}}, "/service/data/action/delete"=>{"get"=>{"summary"=>"Get Service Data Action Delete", "description"=>"Delete a data entry.", "operationId"=>"data.delete", "x-api-path-slug"=>"servicedataactiondelete-get", "parameters"=>[{"in"=>"query", "name"=>"entryId", "description"=>"Data entry id to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Data", "Action", "Delete"]}}, "/service/data/action/get"=>{"get"=>{"summary"=>"Get Service Data Action Get", "description"=>"Get data entry by ID.", "operationId"=>"data.get", "x-api-path-slug"=>"servicedataactionget-get", "parameters"=>[{"in"=>"query", "name"=>"entryId", "description"=>"Data entry id"}, {"in"=>"query", "name"=>"version", "description"=>"Desired version of the data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Data", "Action", "Get"]}}, "/service/data/action/list"=>{"get"=>{"summary"=>"Get Service Data Action List", "description"=>"List data entries by filter with paging support.", "operationId"=>"data.list", "x-api-path-slug"=>"servicedataactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"filter[accessControlIdEqual]"}, {"in"=>"query", "name"=>"filter[accessControlIdIn]"}, {"in"=>"query", "name"=>"filter[adminTagsLike]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[adminTagsMultiLikeAnd]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[adminTagsMultiLikeOr]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[advancedSearch][attribute]", "description"=>"Enum Type: `KalturaBaseEntryCompareAttribute`"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoriesMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryEntryStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][categoryIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][comparison]", "description"=>"Enum Type: `KalturaSearchConditionComparison`"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentLike]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][contentMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointsFreeText]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointSubTypeEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][cuePointTypeIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][depthGreaterThanEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][distributionSunStatus]", "description"=>"Enum Type: `KalturaEntryDistributionSunStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionFlag]", "description"=>"Enum Type: `KalturaEntryDistributionFlag`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionStatus]", "description"=>"Enum Type: `KalturaEntryDistributionStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][entryDistributionValidationErrors]", "description"=>"Comma seperated validation error types"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusEqual]", "description"=>"Enum Type: `KalturaUserEntryExtendedStatus`"}, {"in"=>"query", "name"=>"filter[advancedSearch][extendedStatusIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][field]"}, {"in"=>"query", "name"=>"filter[advancedSearch][hasEntryDistributionValidationErrors]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][idIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][indexIdGreaterThan]"}, {"in"=>"query", "name"=>"filter[advancedSearch][isQuiz]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[advancedSearch][items]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdEq]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchAnd]"}, {"in"=>"query", "name"=>"filter[advancedSearch][memberPermissionsMatchOr]"}, {"in"=>"query", "name"=>"filter[advancedSearch][metadataProfileId]"}, {"in"=>"query", "name"=>"filter[advancedSearch][noDistributionProfiles]"}, {"in"=>"query", "name"=>"filter[advancedSearch][not]"}, {"in"=>"query", "name"=>"filter[advancedSearch][objectType]"}, {"in"=>"query", "name"=>"filter[advancedSearch][orderBy]", "description"=>"Enum Type: `KalturaCategoryEntryAdvancedOrderBy`"}, {"in"=>"query", "name"=>"filter[advancedSearch][type]", "description"=>"Enum Type: `KalturaSearchOperatorType`"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdEqual]"}, {"in"=>"query", "name"=>"filter[advancedSearch][userIdIn]"}, {"in"=>"query", "name"=>"filter[advancedSearch][value]"}, {"in"=>"query", "name"=>"filter[advancedSearch][watermarkId]"}, {"in"=>"query", "name"=>"filter[categoriesFullNameIn]"}, {"in"=>"query", "name"=>"filter[categoriesIdsEmpty]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[categoriesIdsMatchAnd]"}, {"in"=>"query", "name"=>"filter[categoriesIdsMatchOr]", "description"=>"All entries of the categories, excluding their child categories"}, {"in"=>"query", "name"=>"filter[categoriesIdsNotContains]"}, {"in"=>"query", "name"=>"filter[categoriesMatchAnd]"}, {"in"=>"query", "name"=>"filter[categoriesMatchOr]", "description"=>"All entries within these categories or their child categories"}, {"in"=>"query", "name"=>"filter[categoriesNotContains]"}, {"in"=>"query", "name"=>"filter[categoryAncestorIdIn]", "description"=>"All entries within this categoy or in child categories"}, {"in"=>"query", "name"=>"filter[createdAtGreaterThanOrEqual]", "description"=>"This filter parameter should be in use for retrieving only entries which were created at Kaltura system after a specific time/date (standard timestamp format)"}, {"in"=>"query", "name"=>"filter[createdAtLessThanOrEqual]", "description"=>"This filter parameter should be in use for retrieving only entries which were created at Kaltura system before a specific time/date (standard timestamp format)"}, {"in"=>"query", "name"=>"filter[creatorIdEqual]"}, {"in"=>"query", "name"=>"filter[endDateGreaterThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"filter[endDateGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[endDateLessThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"filter[endDateLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[entitledUsersEditMatchAnd]"}, {"in"=>"query", "name"=>"filter[entitledUsersEditMatchOr]"}, {"in"=>"query", "name"=>"filter[entitledUsersPublishMatchAnd]"}, {"in"=>"query", "name"=>"filter[entitledUsersPublishMatchOr]"}, {"in"=>"query", "name"=>"filter[freeText]"}, {"in"=>"query", "name"=>"filter[groupIdEqual]"}, {"in"=>"query", "name"=>"filter[idEqual]", "description"=>"This filter should be in use for retrieving only a specific entry (identified by its entryId)"}, {"in"=>"query", "name"=>"filter[idIn]", "description"=>"This filter should be in use for retrieving few specific entries (string should include comma separated list of entryId strings)"}, {"in"=>"query", "name"=>"filter[idNotIn]"}, {"in"=>"query", "name"=>"filter[isRoot]", "description"=>"Enum Type: `KalturaNullableBoolean`"}, {"in"=>"query", "name"=>"filter[moderationStatusEqual]", "description"=>"Enum Type: `KalturaEntryModerationStatus`"}, {"in"=>"query", "name"=>"filter[moderationStatusIn]"}, {"in"=>"query", "name"=>"filter[moderationStatusNotEqual]", "description"=>"Enum Type: `KalturaEntryModerationStatus`"}, {"in"=>"query", "name"=>"filter[moderationStatusNotIn]"}, {"in"=>"query", "name"=>"filter[nameEqual]", "description"=>"This filter should be in use for retrieving entries with a specific name"}, {"in"=>"query", "name"=>"filter[nameLike]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[nameMultiLikeAnd]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[nameMultiLikeOr]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[orderBy]"}, {"in"=>"query", "name"=>"filter[parentEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[partnerIdEqual]", "description"=>"This filter should be in use for retrieving only entries which were uploaded by/assigned to users of a specific Kaltura Partner (identified by Partner ID)"}, {"in"=>"query", "name"=>"filter[partnerIdIn]", "description"=>"This filter should be in use for retrieving only entries within Kaltura network which were uploaded by/assigned to users of few Kaltura Partners (string should include comma separated list of PartnerIDs)"}, {"in"=>"query", "name"=>"filter[partnerSortValueGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[partnerSortValueLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[redirectFromEntryId]", "description"=>"The id of the original entry"}, {"in"=>"query", "name"=>"filter[referenceIdEqual]"}, {"in"=>"query", "name"=>"filter[referenceIdIn]"}, {"in"=>"query", "name"=>"filter[replacedEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[replacedEntryIdIn]"}, {"in"=>"query", "name"=>"filter[replacementStatusEqual]", "description"=>"Enum Type: `KalturaEntryReplacementStatus`"}, {"in"=>"query", "name"=>"filter[replacementStatusIn]"}, {"in"=>"query", "name"=>"filter[replacingEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[replacingEntryIdIn]"}, {"in"=>"query", "name"=>"filter[rootEntryIdEqual]"}, {"in"=>"query", "name"=>"filter[rootEntryIdIn]"}, {"in"=>"query", "name"=>"filter[searchTextMatchAnd]", "description"=>"This filter should be in use for retrieving specific entries while search match the input string within all of the following metadata attributes: name, description, tags, adminTags"}, {"in"=>"query", "name"=>"filter[searchTextMatchOr]", "description"=>"This filter should be in use for retrieving specific entries while search match the input string within at least one of the following metadata attributes: name, description, tags, adminTags"}, {"in"=>"query", "name"=>"filter[startDateGreaterThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"filter[startDateGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[startDateLessThanOrEqualOrNull]"}, {"in"=>"query", "name"=>"filter[startDateLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[statusEqual]", "description"=>"Enum Type: `KalturaEntryStatus`This filter should be in use for retrieving only entries, at a specific {"}, {"in"=>"query", "name"=>"filter[statusIn]", "description"=>"This filter should be in use for retrieving only entries, at few specific {"}, {"in"=>"query", "name"=>"filter[statusNotEqual]", "description"=>"Enum Type: `KalturaEntryStatus`This filter should be in use for retrieving only entries, not at a specific {"}, {"in"=>"query", "name"=>"filter[statusNotIn]", "description"=>"This filter should be in use for retrieving only entries, not at few specific {"}, {"in"=>"query", "name"=>"filter[tagsAdminTagsMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsAdminTagsMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[tagsAdminTagsNameMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsAdminTagsNameMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[tagsLike]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeAnd]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[tagsMultiLikeOr]", "description"=>"This filter should be in use for retrieving specific entries"}, {"in"=>"query", "name"=>"filter[tagsNameMultiLikeAnd]"}, {"in"=>"query", "name"=>"filter[tagsNameMultiLikeOr]"}, {"in"=>"query", "name"=>"filter[totalRankGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[totalRankLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[typeEqual]", "description"=>"Enum Type: `KalturaEntryType`"}, {"in"=>"query", "name"=>"filter[typeIn]", "description"=>"This filter should be in use for retrieving entries of few {"}, {"in"=>"query", "name"=>"filter[updatedAtGreaterThanOrEqual]"}, {"in"=>"query", "name"=>"filter[updatedAtLessThanOrEqual]"}, {"in"=>"query", "name"=>"filter[userIdEqual]", "description"=>"This filter parameter should be in use for retrieving only entries, uploaded by/assigned to a specific user (identified by user Id)"}, {"in"=>"query", "name"=>"filter[userIdIn]"}, {"in"=>"query", "name"=>"filter[userIdNotIn]"}, {"in"=>"query", "name"=>"pager[pageIndex]", "description"=>"The page number for which {pageSize} of objects should be retrieved (Default is 1)"}, {"in"=>"query", "name"=>"pager[pageSize]", "description"=>"The number of objects to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Data", "Action", "List"]}}}}, "apis"=>{"name"=>"Kaltura", "x-slug"=>"kaltura", "description"=>"A recognized leader in the OTT TV (Over the Top TV), OVP (Online Video Platform), EdVP (Education Video Platform) and EVP (Enterprise Video Platform) markets, Kaltura has emerged as the fastest growing video platform, and as the one with the widest use-case and appeal. Kaltura is deployed globally in thousands of enterprises, media companies, service providers and educational institutions and engages hundreds of millions of viewers at home, in work, and at school. The company is committed to its core values of openness, flexibility, and collaboration, and is the initiator and backer of the worlds leading open-source video-management project, which is home to more than 100,000 community members.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28437-kaltura-vpaa-s.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"23496", "tags"=>"API Provider,Enterprise,Profiles,Relative Data,SaaS,Service API,Technology,Videos", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"kaltura/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Kaltura VPaaS", "x-api-slug"=>"kaltura-vpaas", "description"=>"A recognized leader in the OTT TV (Over the Top TV), OVP (Online Video Platform), EdVP (Education Video Platform) and EVP (Enterprise Video Platform) markets, Kaltura has emerged as the fastest growing video platform, and as the one with the widest use-case and appeal. Kaltura is deployed globally in thousands of enterprises, media companies, service providers and educational institutions and engages hundreds of millions of viewers at home, in work, and at school. The company is committed to its core values of openness, flexibility, and collaboration, and is the initiator and backer of the worlds leading open-source video-management project, which is home to more than 100,000 community members.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28437-kaltura-vpaa-s.jpg", "humanURL"=>"http://kaltura.com", "baseURL"=>"https://www.kaltura.com//api_v3", "tags"=>"API Provider,Enterprise,Profiles,Relative Data,SaaS,Service API,Technology,Videos", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/kaltura/servicedataactionlist-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/kaltura/kaltura-vpaas-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://blog.kaltura.com/"}, {"type"=>"x-code", "url"=>"https://developer.kaltura.com/api-docs/Client_Libraries"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/kaltura"}, {"type"=>"x-developer", "url"=>"https://developer.kaltura.com/api-docs/Overview"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Kaltura"}, {"type"=>"x-website", "url"=>"http://kaltura.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
axa-assistance{"axa-assistance-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AXA Assistance", "x-complete"=>1, "info"=>{"title"=>"AXA Assistance", "description"=>"axa-assistance-is-a-worldwide-specialist-for-car-insurance-travel-health-and-home-services--trust-in-axa-assistance-for-your-insurance", "version"=>"1.0.0"}, "host"=>"sandbox.api.axa-assistance.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/assistance/version"=>{"get"=>{"summary"=>"Provide basic details about the current deployed version of the assistance API", "description"=>"Provide basic details about the current deployed version of the assistance API", "operationId"=>"getAssistanceVersion", "x-api-path-slug"=>"assistanceversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Provide", "basic", "detailAssistance", "about", "the", "current", "deployed", "version", "of", "the", "assistance", "API"]}}, "/information/version"=>{"get"=>{"summary"=>"Provide basic details about the current deployed version of the information API", "description"=>"Provide basic details about the current deployed version of the information API", "operationId"=>"getInformationVersion", "x-api-path-slug"=>"informationversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Provide", "basic", "detailAssistance", "about", "the", "current", "deployed", "version", "of", "the", "information", "API"]}}, "/insurance/version"=>{"get"=>{"summary"=>"Provide basic details about the current deployed version of the insurance API", "description"=>"Provide basic details about the current deployed version of the insurance API", "operationId"=>"getInsuranceVersion", "x-api-path-slug"=>"insuranceversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Provide", "basic", "detailAssistance", "about", "the", "current", "deployed", "version", "of", "the", "insurance", "API"]}}, "/network/version"=>{"get"=>{"summary"=>"Provide basic details about the current deployed version of the network API", "description"=>"Provide basic details about the current deployed version of the network API", "operationId"=>"getNetworkVersion", "x-api-path-slug"=>"networkversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Provide", "basic", "detailAssistance", "about", "the", "current", "deployed", "version", "of", "the", "network", "API"]}}, "/ondemand/version"=>{"get"=>{"summary"=>"Provide basic details about the current deployed version of the on demand API", "description"=>"Provide basic details about the current deployed version of the on demand API", "operationId"=>"getOndemandVersion", "x-api-path-slug"=>"ondemandversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Provide", "basic", "detailAssistance", "about", "the", "current", "deployed", "version", "of", "the", "on", "demand", "API"]}}, "/sales/version"=>{"get"=>{"summary"=>"Provide basic details about the current deployed version of the sales API", "description"=>"Provide basic details about the current deployed version of the sales API", "operationId"=>"getSalesVersion", "x-api-path-slug"=>"salesversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Provide", "basic", "detailAssistance", "about", "the", "current", "deployed", "version", "of", "the", "saleAssistance", "API"]}}, "/service/version"=>{"get"=>{"summary"=>"Provide basic details about the current deployed version of the service API", "description"=>"Provide basic details about the current deployed version of the service API", "operationId"=>"getServiceVersion", "x-api-path-slug"=>"serviceversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Provide", "basic", "detailAssistance", "about", "the", "current", "deployed", "version", "of", "the", "service", "API"]}}, "/user/version"=>{"get"=>{"summary"=>"Provide basic details about the current deployed version of the User API", "description"=>"Provide basic details about the current deployed version of the User API", "operationId"=>"getUserVersion", "x-api-path-slug"=>"userversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Provide", "basic", "detailAssistance", "about", "the", "current", "deployed", "version", "of", "the", "User", "API"]}}, "/information/v1/countries"=>{"get"=>{"summary"=>"Retrieve all countries", "description"=>"Retrieve all countries", "operationId"=>"getInformationV1Countries", "x-api-path-slug"=>"informationv1countries-get", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Language/Country"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Retrieve", "all", "countries"]}}, "/assistance/v1/home/cases"=>{"get"=>{"summary"=>"Gets details of cases", "description"=>"Gets details of cases", "operationId"=>"getAssistanceV1HomeCases", "x-api-path-slug"=>"assistancev1homecases-get", "parameters"=>[{"in"=>"query", "name"=>"declaration_id", "description"=>"ID of the declaration which has trigger the cases"}, {"in"=>"query", "name"=>"lastname", "description"=>"Lastname of the person associated to the case"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "detailAssistance", "of", "cases"]}}, "/information/v1/countries/alerts"=>{"get"=>{"summary"=>"Retrieve the latest alerts worldwide", "description"=>"Retrieve the latest alerts worldwide", "operationId"=>"getInformationV1CountriesAlerts", "x-api-path-slug"=>"informationv1countriesalerts-get", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Language/Country"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Retrieve", "the", "latest", "alertAssistance", "worldwide"]}}, "/information/v1/countries/{country_id}"=>{"get"=>{"summary"=>"Retrieve a country detail", "description"=>"Retrieve a country detail", "operationId"=>"getInformationV1CountriesCountry_id", "x-api-path-slug"=>"informationv1countriescountry-id-get", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Language/Country"}, {"in"=>"path", "name"=>"country_id", "description"=>"country id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Retrievecountry", "detail"]}}, "/information/vexp/roadside/workshops"=>{"get"=>{"summary"=>"Gets list of nearest workshops.", "description"=>"Gets list of nearest workshops.", "operationId"=>"getInformationVexpRoadsideWorkshops", "x-api-path-slug"=>"informationvexproadsideworkshops-get", "parameters"=>[{"in"=>"query", "name"=>"latitude", "description"=>"Latitude of the location around which to search, latitude to be provided in WGS84 format"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude of the location around which to search, longitude to be provided in WGS84 format"}, {"in"=>"query", "name"=>"radius", "description"=>"Maximum distance around"}, {"in"=>"query", "name"=>"radius_unit", "description"=>"Unit of radius, ISO-20022 Unit Of Measure 2 Code (required if radius is provided)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "list", "of", "nearest", "workshops."]}}, "/network/v1/medical_providers/availabilities"=>{"get"=>{"summary"=>"Gets the availabilities of medical providers.", "description"=>"Gets the availabilities of medical providers.", "operationId"=>"getNetworkV1Medical_providersAvailabilities", "x-api-path-slug"=>"networkv1medical-providersavailabilities-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"End date and time of the availability search - UTC datetime, RFC3339 format (YYYY-MM-DDTHH:mmZ)"}, {"in"=>"query", "name"=>"start_date", "description"=>"Beginning date and time of the availability search - UTC datetime, RFC3339 format (YYYY-MM-DDTHH:mmZ)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "the", "availabilitieAssistance", "of", "medical", "providers."]}}, "/network/vexp/roadside_providers/{provider_id}"=>{"get"=>{"summary"=>"Gets information of roadside provider.", "description"=>"Gets information of roadside provider.", "operationId"=>"getNetworkVexpRoadside_providersProvider_id", "x-api-path-slug"=>"networkvexproadside-providersprovider-id-get", "parameters"=>[{"in"=>"path", "name"=>"provider_id", "description"=>"Provider unique id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "information", "of", "roadside", "provider."]}}, "/ondemand/v1/medical_providers/kinds"=>{"get"=>{"summary"=>"Retrieve all medical provider kinds available for search (Ex: pharmacy, hospital ...)", "description"=>"Retrieve all medical provider kinds available for search (Ex: pharmacy, hospital ...)", "operationId"=>"getOndemandV1Medical_providersKinds", "x-api-path-slug"=>"ondemandv1medical-providerskinds-get", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Language/Country"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Retrieve", "all", "medical", "provider", "kindAssistance", "availablesearch", "(Ex:", "pharmacy", "", "hospital", "...)"]}}, "/ondemand/v1/medical_providers/search"=>{"get"=>{"summary"=>"Search for medical providers", "description"=>"Search for medical providers", "operationId"=>"getOndemandV1Medical_providersSearch", "x-api-path-slug"=>"ondemandv1medical-providerssearch-get", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Language/Country"}, {"in"=>"query", "name"=>"kind", "description"=>"Provider kind"}, {"in"=>"query", "name"=>"lat", "description"=>"Latitude"}, {"in"=>"query", "name"=>"lng", "description"=>"Longitude"}, {"in"=>"query", "name"=>"speciality", "description"=>"Speciality"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Searchmedical", "providers"]}}, "/ondemand/v1/medical_providers/specialities"=>{"get"=>{"summary"=>"Retrieve all medical provider specialities available for search (Ex: cardiology, dentist ...)", "description"=>"Retrieve all medical provider specialities available for search (Ex: cardiology, dentist ...)", "operationId"=>"getOndemandV1Medical_providersSpecialities", "x-api-path-slug"=>"ondemandv1medical-providersspecialities-get", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Language/Country"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Retrieve", "all", "medical", "provider", "specialitieAssistance", "availablesearch", "(Ex:", "cardiology", "", "dentist", "...)"]}}, "/service/v1/medical_consultations/{medical_consultation_id}"=>{"get"=>{"summary"=>"Provides detail of a medical consultation", "description"=>"Provides detail of a medical consultation", "operationId"=>"getServiceV1Medical_consultationsMedical_consultation_id", "x-api-path-slug"=>"servicev1medical-consultationsmedical-consultation-id-get", "parameters"=>[{"in"=>"path", "name"=>"medical_consultation_id", "description"=>"ID of the medical consultation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "ProvideAssistance", "detail", "ofmedical", "consultation"]}, "patch"=>{"summary"=>"Updates a medical consultation", "description"=>"Updates a medical consultation", "operationId"=>"patchServiceV1Medical_consultationsMedical_consultation_id", "x-api-path-slug"=>"servicev1medical-consultationsmedical-consultation-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"medical_consultation_id", "description"=>"ID of the medical consultation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "smedical", "consultation"]}}, "/information/v1/countries/{country_id}/security_cards"=>{"get"=>{"summary"=>"Retrieve security information for a country", "description"=>"Retrieve security information for a country", "operationId"=>"getInformationV1CountriesCountry_idSecurity_cards", "x-api-path-slug"=>"informationv1countriescountry-idsecurity-cards-get", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Language/Country"}, {"in"=>"path", "name"=>"country_id", "description"=>"country id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Retrieve", "security", "informationa", "country"]}}, "/information/v1/countries/{country_id}/health_cards"=>{"get"=>{"summary"=>"Retrieve health information for a country", "description"=>"Retrieve health information for a country", "operationId"=>"getInformationV1CountriesCountry_idHealth_cards", "x-api-path-slug"=>"informationv1countriescountry-idhealth-cards-get", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Language/Country"}, {"in"=>"path", "name"=>"country_id", "description"=>"country id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Retrieve", "health", "informationa", "country"]}}, "/information/v1/countries/{country_id}/alerts"=>{"get"=>{"summary"=>"Retrieve the latest alerts for a specified country", "description"=>"Retrieve the latest alerts for a specified country", "operationId"=>"getInformationV1CountriesCountry_idAlerts", "x-api-path-slug"=>"informationv1countriescountry-idalerts-get", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Language/Country"}, {"in"=>"path", "name"=>"country_id", "description"=>"country id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Retrieve", "the", "latest", "alertsa", "specified", "country"]}}, "/service/vexp/roadside/assignments/{assignment_id}"=>{"get"=>{"summary"=>"Gets assignment information.", "description"=>"Gets assignment information.", "operationId"=>"getServiceVexpRoadsideAssignmentsAssignment_id", "x-api-path-slug"=>"servicevexproadsideassignmentsassignment-id-get", "parameters"=>[{"in"=>"path", "name"=>"assignment_id", "description"=>"Assignment unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "assignment", "information."]}}, "/sales/v1/individual/appliance/certificates/{certificate_id}"=>{"get"=>{"summary"=>"Get appliance (Extended warranty, purchase insurance ) certificate details.", "description"=>"Get appliance (Extended warranty, purchase insurance ) certificate details.", "operationId"=>"getSalesV1IndividualApplianceCertificatesCertificate_id", "x-api-path-slug"=>"salesv1individualappliancecertificatescertificate-id-get", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"path", "name"=>"certificate_id", "description"=>"Certificate unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "appliance", "(Extended", "warranty", "", "purchase", "insurance", ")", "certificate", "details."]}}, "/sales/v1/individual/car_rental/certificates/{certificate_id}"=>{"get"=>{"summary"=>"Gets the car rental certificate details.", "description"=>"Gets the car rental certificate details.", "operationId"=>"getSalesV1IndividualCar_rentalCertificatesCertificate_id", "x-api-path-slug"=>"salesv1individualcar-rentalcertificatescertificate-id-get", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"path", "name"=>"certificate_id", "description"=>"Certificate unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "the", "car", "rental", "certificate", "details."]}}, "/sales/v1/individual/travel/certificates/{certificate_id}"=>{"get"=>{"summary"=>"Gets the travel certificate details.", "description"=>"Gets the travel certificate details.", "operationId"=>"getSalesV1IndividualTravelCertificatesCertificate_id", "x-api-path-slug"=>"salesv1individualtravelcertificatescertificate-id-get", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"path", "name"=>"certificate_id", "description"=>"Certificate unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "the", "travel", "certificate", "details."]}}, "/service/v1/medical_consultations/{medical_consultation_id}/prescriptions/{prescription_id}"=>{"get"=>{"summary"=>"Provides detail of a prescription", "description"=>"Provides detail of a prescription", "operationId"=>"getServiceV1Medical_consultationsMedical_consultation_idPrescriptionsPrescription_id", "x-api-path-slug"=>"servicev1medical-consultationsmedical-consultation-idprescriptionsprescription-id-get", "parameters"=>[{"in"=>"path", "name"=>"medical_consultation_id", "description"=>"ID of the medical consultation"}, {"in"=>"path", "name"=>"prescription_id", "description"=>"ID of the prescription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "ProvideAssistance", "detail", "ofprescription"]}, "patch"=>{"summary"=>"Updates a prescription", "description"=>"Updates a prescription", "operationId"=>"patchServiceV1Medical_consultationsMedical_consultation_idPrescriptionsPrescription_id", "x-api-path-slug"=>"servicev1medical-consultationsmedical-consultation-idprescriptionsprescription-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"medical_consultation_id", "description"=>"ID of the medical consultation"}, {"in"=>"path", "name"=>"prescription_id", "description"=>"ID of the prescription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "sprescription"]}}, "/user/v1/identities/{identity_id}/channels/sms"=>{"get"=>{"summary"=>"Get channel", "description"=>"Get channel", "operationId"=>"getUserV1IdentitiesIdentity_idChannelsSms", "x-api-path-slug"=>"userv1identitiesidentity-idchannelssms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "channel"]}, "put"=>{"summary"=>"Update channel", "description"=>"Update channel", "operationId"=>"putUserV1IdentitiesIdentity_idChannelsSms", "x-api-path-slug"=>"userv1identitiesidentity-idchannelssms-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"identity_id", "description"=>"ID of the identity"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "channel"]}}, "/assistance/v1/home/electric_damage/declarations/{declaration_id}/policy_holders"=>{"get"=>{"summary"=>"Gets the policy holders details for the electric damage", "description"=>"Gets the policy holders details for the electric damage", "operationId"=>"getAssistanceV1HomeElectric_damageDeclarationsDeclaration_idPolicy_holders", "x-api-path-slug"=>"assistancev1homeelectric-damagedeclarationsdeclaration-idpolicy-holders-get", "parameters"=>[{"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "the", "policy", "holderAssistance", "detailsthe", "electric", "damage"]}}, "/assistance/v1/home/gas_damage/declarations/{declaration_id}/policy_holders"=>{"get"=>{"summary"=>"Gets the policy holders details for the gas damage", "description"=>"Gets the policy holders details for the gas damage", "operationId"=>"getAssistanceV1HomeGas_damageDeclarationsDeclaration_idPolicy_holders", "x-api-path-slug"=>"assistancev1homegas-damagedeclarationsdeclaration-idpolicy-holders-get", "parameters"=>[{"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "the", "policy", "holderAssistance", "detailsthe", "gaAssistance", "damage"]}}, "/assistance/v1/home/glaziery_damage/declarations/{declaration_id}/policy_holders"=>{"get"=>{"summary"=>"Gets the information linked to the policy holder of the glaziery damage declaration", "description"=>"Gets the information linked to the policy holder of the glaziery damage declaration", "operationId"=>"getAssistanceV1HomeGlaziery_damageDeclarationsDeclaration_idPolicy_holders", "x-api-path-slug"=>"assistancev1homeglaziery-damagedeclarationsdeclaration-idpolicy-holders-get", "parameters"=>[{"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "the", "information", "linked", "to", "the", "policy", "holder", "of", "the", "glaziery", "damage", "Declarations"]}}, "/assistance/v1/home/home_appliance_damage/declarations/{declaration_id}/policy_holders"=>{"get"=>{"summary"=>"Gets the information linked to the policy holder of the home appliance damage declaration", "description"=>"Gets the information linked to the policy holder of the home appliance damage declaration", "operationId"=>"getAssistanceV1HomeHome_appliance_damageDeclarationsDeclaration_idPolicy_holders", "x-api-path-slug"=>"assistancev1homehome-appliance-damagedeclarationsdeclaration-idpolicy-holders-get", "parameters"=>[{"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "the", "information", "linked", "to", "the", "policy", "holder", "of", "the", "home", "appliance", "damage", "Declarations"]}}, "/assistance/v1/home/locksmithing_damage/declarations/{declaration_id}/policy_holders"=>{"get"=>{"summary"=>"Gets the information linked to the policy holder of the locksmithing damage declaration", "description"=>"Gets the information linked to the policy holder of the locksmithing damage declaration", "operationId"=>"getAssistanceV1HomeLocksmithing_damageDeclarationsDeclaration_idPolicy_holders", "x-api-path-slug"=>"assistancev1homelocksmithing-damagedeclarationsdeclaration-idpolicy-holders-get", "parameters"=>[{"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "the", "information", "linked", "to", "the", "policy", "holder", "of", "the", "locksmithing", "damage", "Declarations"]}}, "/assistance/v1/home/water_damage/declarations/{declaration_id}/policy_holders"=>{"get"=>{"summary"=>"Gets the information related to each the policy holder of the water damage declaration", "description"=>"Gets the information related to each the policy holder of the water damage declaration", "operationId"=>"getAssistanceV1HomeWater_damageDeclarationsDeclaration_idPolicy_holders", "x-api-path-slug"=>"assistancev1homewater-damagedeclarationsdeclaration-idpolicy-holders-get", "parameters"=>[{"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "the", "information", "related", "to", "each", "the", "policy", "holder", "of", "the", "water", "damage", "Declarations"]}}, "/service/v1/medical_consultations/{medical_consultation_id}/prescriptions/{prescription_id}/attachments/{attachment_id}"=>{"get"=>{"summary"=>"Retrieve an attachment", "description"=>"Retrieve an attachment", "operationId"=>"getServiceV1Medical_consultationsMedical_consultation_idPrescriptionsPrescription_idAttachmentsAttac", "x-api-path-slug"=>"servicev1medical-consultationsmedical-consultation-idprescriptionsprescription-idattachmentsattachment-id-get", "parameters"=>[{"in"=>"path", "name"=>"attachment_id", "description"=>"ID of the attachment"}, {"in"=>"path", "name"=>"medical_consultation_id", "description"=>"ID of the medical consultation"}, {"in"=>"path", "name"=>"prescription_id", "description"=>"ID of the prescription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Retrieveattachment"]}}, "/service/v1/medical_consultations"=>{"post"=>{"summary"=>"Creates a medical consultation.", "description"=>"Creates a medical consultation.", "operationId"=>"postServiceV1Medical_consultations", "x-api-path-slug"=>"servicev1medical-consultations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Createsmedical", "consultation."]}}, "/insurance/vexp/appliance/claims"=>{"post"=>{"summary"=>"Requests to create a claim related to an appliance.", "description"=>"Requests to create a claim related to an appliance.", "operationId"=>"postInsuranceVexpApplianceClaims", "x-api-path-slug"=>"insurancevexpapplianceclaims-post", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "RequestAssistance", "to", "createclaim", "related", "toappliance."]}}, "/insurance/vexp/car_rental/claims"=>{"post"=>{"summary"=>"Requests to create a claim related to a car rental.", "description"=>"Requests to create a claim related to a car rental.", "operationId"=>"postInsuranceVexpCar_rentalClaims", "x-api-path-slug"=>"insurancevexpcar-rentalclaims-post", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "RequestAssistance", "to", "createclaim", "related", "tocar", "rental."]}}, "/insurance/vexp/corporate_liability/claims"=>{"post"=>{"summary"=>"Requests to create a claim related to a corporate liability.", "description"=>"Requests to create a claim related to a corporate liability.", "operationId"=>"postInsuranceVexpCorporate_liabilityClaims", "x-api-path-slug"=>"insurancevexpcorporate-liabilityclaims-post", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "RequestAssistance", "to", "createclaim", "related", "tocorporate", "liability."]}}, "/insurance/vexp/delayed_luggage/claims"=>{"post"=>{"summary"=>"Requests to create a claim related to a delayed luggage.", "description"=>"Requests to create a claim related to a delayed luggage.", "operationId"=>"postInsuranceVexpDelayed_luggageClaims", "x-api-path-slug"=>"insurancevexpdelayed-luggageclaims-post", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "RequestAssistance", "to", "createclaim", "related", "todelayed", "luggage."]}}, "/insurance/vexp/delayed_trip/claims"=>{"post"=>{"summary"=>"Requests to create a claim related to a delayed trip.", "description"=>"Requests to create a claim related to a delayed trip.", "operationId"=>"postInsuranceVexpDelayed_tripClaims", "x-api-path-slug"=>"insurancevexpdelayed-tripclaims-post", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "RequestAssistance", "to", "createclaim", "related", "todelayed", "trip."]}}, "/insurance/vexp/lost_baggage/claims"=>{"post"=>{"summary"=>"Requests to create a claim related to a lost baggage.", "description"=>"Requests to create a claim related to a lost baggage.", "operationId"=>"postInsuranceVexpLost_baggageClaims", "x-api-path-slug"=>"insurancevexplost-baggageclaims-post", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "RequestAssistance", "to", "createclaim", "related", "tolost", "baggage."]}}, "/insurance/vexp/missed_flight/claims"=>{"post"=>{"summary"=>"Requests to create a claim related to a missed flight.", "description"=>"Requests to create a claim related to a missed flight.", "operationId"=>"postInsuranceVexpMissed_flightClaims", "x-api-path-slug"=>"insurancevexpmissed-flightclaims-post", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "RequestAssistance", "to", "createclaim", "related", "tomissed", "flight."]}}, "/insurance/vexp/price_protection/claims"=>{"post"=>{"summary"=>"Requests to create a claim related to a price protection.", "description"=>"Requests to create a claim related to a price protection.", "operationId"=>"postInsuranceVexpPrice_protectionClaims", "x-api-path-slug"=>"insurancevexpprice-protectionclaims-post", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "RequestAssistance", "to", "createclaim", "related", "toprice", "protection."]}}, "/insurance/vexp/stolen_cash/claims"=>{"post"=>{"summary"=>"Requests to create a claim related to a stolen cash.", "description"=>"Requests to create a claim related to a stolen cash.", "operationId"=>"postInsuranceVexpStolen_cashClaims", "x-api-path-slug"=>"insurancevexpstolen-cashclaims-post", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "RequestAssistance", "to", "createclaim", "related", "tostolen", "cash."]}}, "/insurance/vexp/travel_accident/claims"=>{"post"=>{"summary"=>"Requests to create a claim related to a travel accident.", "description"=>"Requests to create a claim related to a travel accident.", "operationId"=>"postInsuranceVexpTravel_accidentClaims", "x-api-path-slug"=>"insurancevexptravel-accidentclaims-post", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "RequestAssistance", "to", "createclaim", "related", "totravel", "accident."]}}, "/insurance/vexp/trip/claims"=>{"post"=>{"summary"=>"Requests to create a claim related to a trip.", "description"=>"Requests to create a claim related to a trip.", "operationId"=>"postInsuranceVexpTripClaims", "x-api-path-slug"=>"insurancevexptripclaims-post", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "RequestAssistance", "to", "createclaim", "related", "totrip."]}}, "/insurance/vexp/trip_cancellation/claims"=>{"post"=>{"summary"=>"Requests to create a claim related to a trip cancellation.", "description"=>"Requests to create a claim related to a trip cancellation.", "operationId"=>"postInsuranceVexpTrip_cancellationClaims", "x-api-path-slug"=>"insurancevexptrip-cancellationclaims-post", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "RequestAssistance", "to", "createclaim", "related", "totrip", "cancellation."]}}, "/service/vexp/roadside/assignments"=>{"post"=>{"summary"=>"Creates new assignment.", "description"=>"Creates new assignment.", "operationId"=>"postServiceVexpRoadsideAssignments", "x-api-path-slug"=>"servicevexproadsideassignments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "CreateAssistance", "new", "assignment."]}}, "/user/v1/identities/forgot_password"=>{"post"=>{"summary"=>"Forgot identity password", "description"=>"Forgot identity password", "operationId"=>"postUserV1IdentitiesForgot_password", "x-api-path-slug"=>"userv1identitiesforgot-password-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Forgot", "identity", "password"]}}, "/user/v1/identities/register"=>{"post"=>{"summary"=>"Register identity", "description"=>"Register identity", "operationId"=>"postUserV1IdentitiesRegister", "x-api-path-slug"=>"userv1identitiesregister-post", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Language/Country"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Register", "identity"]}}, "/assistance/v1/home/electric_damage/declarations"=>{"post"=>{"summary"=>"Create a declaration for an electric damage", "description"=>"Create a declaration for an electric damage", "operationId"=>"postAssistanceV1HomeElectric_damageDeclarations", "x-api-path-slug"=>"assistancev1homeelectric-damagedeclarations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "CreateDeclarationsan", "electric", "damage"]}}, "/assistance/v1/home/gas_damage/declarations"=>{"post"=>{"summary"=>"Creates a declaration for a gas damage", "description"=>"Creates a declaration for a gas damage", "operationId"=>"postAssistanceV1HomeGas_damageDeclarations", "x-api-path-slug"=>"assistancev1homegas-damagedeclarations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "CreatesDeclarationsa", "gaAssistance", "damage"]}}, "/assistance/v1/home/glaziery_damage/declarations"=>{"post"=>{"summary"=>"Creates a declaration for a glaziery damage", "description"=>"Creates a declaration for a glaziery damage", "operationId"=>"postAssistanceV1HomeGlaziery_damageDeclarations", "x-api-path-slug"=>"assistancev1homeglaziery-damagedeclarations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "CreatesDeclarationsa", "glaziery", "damage"]}}, "/assistance/v1/home/home_appliance_damage/declarations"=>{"post"=>{"summary"=>"Creates a declaration for a home appliance damage", "description"=>"Creates a declaration for a home appliance damage", "operationId"=>"postAssistanceV1HomeHome_appliance_damageDeclarations", "x-api-path-slug"=>"assistancev1homehome-appliance-damagedeclarations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "CreatesDeclarationsa", "home", "appliance", "damage"]}}, "/assistance/v1/home/locksmithing_damage/declarations"=>{"post"=>{"summary"=>"Creates a declaration for a locksmithing damage", "description"=>"Creates a declaration for a locksmithing damage", "operationId"=>"postAssistanceV1HomeLocksmithing_damageDeclarations", "x-api-path-slug"=>"assistancev1homelocksmithing-damagedeclarations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "CreatesDeclarationsa", "locksmithing", "damage"]}}, "/assistance/v1/home/water_damage/declarations"=>{"post"=>{"summary"=>"Creates a declaration for a water damage", "description"=>"Creates a declaration for a water damage", "operationId"=>"postAssistanceV1HomeWater_damageDeclarations", "x-api-path-slug"=>"assistancev1homewater-damagedeclarations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "CreatesDeclarationsa", "water", "damage"]}}, "/sales/v1/individual/appliance/certificates"=>{"post"=>{"summary"=>"Requests the activation of a certificate either to cover an appliance purchased or to extend the warranty period of an appliance purchased. At least one product_criteria has to be specified to identify the product to which to subscribe. This endpoint", "description"=>"Requests the activation of a certificate either to cover an appliance purchased or to extend the warranty period of an appliance purchased. At least one product_criteria has to be specified to identify the product to which to subscribe. This endpoint", "operationId"=>"postSalesV1IndividualApplianceCertificates", "x-api-path-slug"=>"salesv1individualappliancecertificates-post", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "RequestAssistance", "the", "activation", "ofcertificate", "either", "to", "coverappliance", "purchasedto", "extend", "the", "warranty", "period", "ofappliance", "purchased.", "At", "leastproduct_criteria", "haAssistance", "to", "be", "specified", "to", "identify", "the", "product", "to", "which", "to", "subscribe.", "ThiAssistance", "endpoint"]}}, "/sales/v1/individual/car_rental/certificates"=>{"post"=>{"summary"=>"Requests the activation of a car rental certificate linked to a product. At least one product_criteria has to be specified to identify the product to which to subscribe. If the user already holds a certificate, this api will update its personal infor", "description"=>"Requests the activation of a car rental certificate linked to a product. At least one product_criteria has to be specified to identify the product to which to subscribe. If the user already holds a certificate, this api will update its personal infor", "operationId"=>"postSalesV1IndividualCar_rentalCertificates", "x-api-path-slug"=>"salesv1individualcar-rentalcertificates-post", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "RequestAssistance", "the", "activation", "ofcar", "rental", "certificate", "linked", "toproduct.", "At", "leastproduct_criteria", "haAssistance", "to", "be", "specified", "to", "identify", "the", "product", "to", "which", "to", "subscribe.", "If", "the", "user", "already", "holdscertificate", "", "thiAssistance", "api", "will", "update", "itAssistance", "personal", "infor"]}}, "/sales/v1/individual/travel/certificates"=>{"post"=>{"summary"=>"Requests the activation of a travel certificate linked to a product. At least one product_criteria has to be specified to identify the product to which to subscribe. If the user already holds a certificate, this api will update its personal informati", "description"=>"Requests the activation of a travel certificate linked to a product. At least one product_criteria has to be specified to identify the product to which to subscribe. If the user already holds a certificate, this api will update its personal informati", "operationId"=>"postSalesV1IndividualTravelCertificates", "x-api-path-slug"=>"salesv1individualtravelcertificates-post", "parameters"=>[{"in"=>"header", "name"=>"accept-language", "description"=>"Accepted language, IANA language codification"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "RequestAssistance", "the", "activation", "oftravel", "certificate", "linked", "toproduct.", "At", "leastproduct_criteria", "haAssistance", "to", "be", "specified", "to", "identify", "the", "product", "to", "which", "to", "subscribe.", "If", "the", "user", "already", "holdscertificate", "", "thiAssistance", "api", "will", "update", "itAssistance", "personal", "informati"]}}, "/sales/v1/individual/travel/policies"=>{"post"=>{"summary"=>"Create new individual travel policy for sales", "description"=>"Create new individual travel policy for sales", "operationId"=>"postSalesV1IndividualTravelPolicies", "x-api-path-slug"=>"salesv1individualtravelpolicies-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "new", "individual", "travel", "policysales"]}}, "/sales/v1/individual/travel/quotes"=>{"post"=>{"summary"=>"Create new individual travel quote for sales", "description"=>"Create new individual travel quote for sales", "operationId"=>"postSalesV1IndividualTravelQuotes", "x-api-path-slug"=>"salesv1individualtravelquotes-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "new", "individual", "travel", "quotesales"]}}, "/service/v1/medical_consultations/{medical_consultation_id}/rate"=>{"post"=>{"summary"=>"Rates a medical consultation", "description"=>"Rates a medical consultation", "operationId"=>"postServiceV1Medical_consultationsMedical_consultation_idRate", "x-api-path-slug"=>"servicev1medical-consultationsmedical-consultation-idrate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"medical_consultation_id", "description"=>"ID of the medical consultation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Ratesmedical", "consultation"]}}, "/service/v1/medical_consultations/{medical_consultation_id}/cancel"=>{"post"=>{"summary"=>"Cancels a medical consultation", "description"=>"Cancels a medical consultation", "operationId"=>"postServiceV1Medical_consultationsMedical_consultation_idCancel", "x-api-path-slug"=>"servicev1medical-consultationsmedical-consultation-idcancel-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"medical_consultation_id", "description"=>"ID of the medical consultation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Cancelsmedical", "consultation"]}}, "/service/vexp/roadside/quotes/search"=>{"post"=>{"summary"=>"Search quotes for a roadside service.", "description"=>"Search quotes for a roadside service.", "operationId"=>"postServiceVexpRoadsideQuotesSearch", "x-api-path-slug"=>"servicevexproadsidequotessearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Search", "quotesa", "roadside", "service."]}}, "/user/v1/identities/forgot_password/confirm"=>{"post"=>{"summary"=>"Confirm identity password change", "description"=>"Confirm identity password change", "operationId"=>"postUserV1IdentitiesForgot_passwordConfirm", "x-api-path-slug"=>"userv1identitiesforgot-passwordconfirm-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Confirm", "identity", "password", "change"]}}, "/user/v1/identities/register/confirm"=>{"post"=>{"summary"=>"Confirm identity registration", "description"=>"Confirm identity registration", "operationId"=>"postUserV1IdentitiesRegisterConfirm", "x-api-path-slug"=>"userv1identitiesregisterconfirm-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Confirm", "identity", "registration"]}}, "/user/v1/identities/register/sendOTP"=>{"post"=>{"summary"=>"SendOTP on registration", "description"=>"SendOTP on registration", "operationId"=>"postUserV1IdentitiesRegisterSendotp", "x-api-path-slug"=>"userv1identitiesregistersendotp-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "SendOTP", "on", "registration"]}}, "/user/v1/identities/{identity_id}/change_password"=>{"post"=>{"summary"=>"Change identity password", "description"=>"Change identity password", "operationId"=>"postUserV1IdentitiesIdentity_idChange_password", "x-api-path-slug"=>"userv1identitiesidentity-idchange-password-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"identity_id", "description"=>"ID of the identity"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Change", "identity", "password"]}}, "/service/vexp/roadside/assignments/{assignment_id}/rate"=>{"post"=>{"summary"=>"Rates an assignment.", "description"=>"Rates an assignment.", "operationId"=>"postServiceVexpRoadsideAssignmentsAssignment_idRate", "x-api-path-slug"=>"servicevexproadsideassignmentsassignment-idrate-post", "parameters"=>[{"in"=>"path", "name"=>"assignment_id", "description"=>"Assignment unique identifier"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Ratesassignment."]}}, "/service/vexp/roadside/assignments/{assignment_id}/confirm"=>{"post"=>{"summary"=>"Confirms an assignment.", "description"=>"Confirms an assignment.", "operationId"=>"postServiceVexpRoadsideAssignmentsAssignment_idConfirm", "x-api-path-slug"=>"servicevexproadsideassignmentsassignment-idconfirm-post", "parameters"=>[{"in"=>"path", "name"=>"assignment_id", "description"=>"Assignment unique identifier"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Confirmsassignment."]}}, "/service/vexp/roadside/assignments/{assignment_id}/cancel"=>{"post"=>{"summary"=>"Cancels an existing assignment.", "description"=>"Cancels an existing assignment.", "operationId"=>"postServiceVexpRoadsideAssignmentsAssignment_idCancel", "x-api-path-slug"=>"servicevexproadsideassignmentsassignment-idcancel-post", "parameters"=>[{"in"=>"path", "name"=>"assignment_id", "description"=>"Assignment unique identifier"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Cancelsexisting", "assignment."]}}, "/user/v1/identities/register/confirm/resend"=>{"post"=>{"summary"=>"Resends the confirmation email to an identity account", "description"=>"Resends the confirmation email to an identity account", "operationId"=>"postUserV1IdentitiesRegisterConfirmResend", "x-api-path-slug"=>"userv1identitiesregisterconfirmresend-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "ResendAssistance", "the", "confirmation", "email", "toidentity", "account"]}}, "/user/v1/identities/{identity_id}/channels/confirm"=>{"post"=>{"summary"=>"Confirm channels", "description"=>"Confirm channels", "operationId"=>"postUserV1IdentitiesIdentity_idChannelsConfirm", "x-api-path-slug"=>"userv1identitiesidentity-idchannelsconfirm-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"identity_id", "description"=>"ID of the identity"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Confirm", "channels"]}}, "/assistance/v1/home/electric_damage/declarations/{declaration_id}/confirm"=>{"post"=>{"summary"=>"Electric declaration confirmation", "description"=>"Electric declaration confirmation", "operationId"=>"postAssistanceV1HomeElectric_damageDeclarationsDeclaration_idConfirm", "x-api-path-slug"=>"assistancev1homeelectric-damagedeclarationsdeclaration-idconfirm-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Electric", "Declarations", "confirmation"]}}, "/assistance/v1/home/electric_damage/declarations/{declaration_id}/contacts"=>{"post"=>{"summary"=>"Adds contact information of the electric damage declaration", "description"=>"Adds contact information of the electric damage declaration", "operationId"=>"postAssistanceV1HomeElectric_damageDeclarationsDeclaration_idContacts", "x-api-path-slug"=>"assistancev1homeelectric-damagedeclarationsdeclaration-idcontacts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "contact", "information", "of", "the", "electric", "damage", "Declarations"]}}, "/assistance/v1/home/electric_damage/declarations/{declaration_id}/close"=>{"post"=>{"summary"=>"Electric declaration closure", "description"=>"Electric declaration closure", "operationId"=>"postAssistanceV1HomeElectric_damageDeclarationsDeclaration_idClose", "x-api-path-slug"=>"assistancev1homeelectric-damagedeclarationsdeclaration-idclose-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Electric", "Declarations", "closure"]}}, "/assistance/v1/home/gas_damage/declarations/{declaration_id}/contacts"=>{"post"=>{"summary"=>"Adds contact information of the gas damage declaration", "description"=>"Adds contact information of the gas damage declaration", "operationId"=>"postAssistanceV1HomeGas_damageDeclarationsDeclaration_idContacts", "x-api-path-slug"=>"assistancev1homegas-damagedeclarationsdeclaration-idcontacts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "contact", "information", "of", "the", "gaAssistance", "damage", "Declarations"]}}, "/assistance/v1/home/gas_damage/declarations/{declaration_id}/confirm"=>{"post"=>{"summary"=>"Gas declaration confirmation", "description"=>"Gas declaration confirmation", "operationId"=>"postAssistanceV1HomeGas_damageDeclarationsDeclaration_idConfirm", "x-api-path-slug"=>"assistancev1homegas-damagedeclarationsdeclaration-idconfirm-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "Declarations", "confirmation"]}}, "/assistance/v1/home/gas_damage/declarations/{declaration_id}/close"=>{"post"=>{"summary"=>"Gas declaration closure", "description"=>"Gas declaration closure", "operationId"=>"postAssistanceV1HomeGas_damageDeclarationsDeclaration_idClose", "x-api-path-slug"=>"assistancev1homegas-damagedeclarationsdeclaration-idclose-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "Declarations", "closure"]}}, "/assistance/v1/home/glaziery_damage/declarations/{declaration_id}/confirm"=>{"post"=>{"summary"=>"Confirms the need for assistance", "description"=>"Confirms the need for assistance", "operationId"=>"postAssistanceV1HomeGlaziery_damageDeclarationsDeclaration_idConfirm", "x-api-path-slug"=>"assistancev1homeglaziery-damagedeclarationsdeclaration-idconfirm-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "ConfirmAssistance", "the", "needassistance"]}}, "/assistance/v1/home/glaziery_damage/declarations/{declaration_id}/close"=>{"post"=>{"summary"=>"Closes the declaration after an other fixing solution", "description"=>"Closes the declaration after an other fixing solution", "operationId"=>"postAssistanceV1HomeGlaziery_damageDeclarationsDeclaration_idClose", "x-api-path-slug"=>"assistancev1homeglaziery-damagedeclarationsdeclaration-idclose-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "CloseAssistance", "the", "Declarations", "afterother", "fixing", "solution"]}}, "/assistance/v1/home/glaziery_damage/declarations/{declaration_id}/contacts"=>{"post"=>{"summary"=>"Adds contact information of the glaziery damage declaration", "description"=>"Adds contact information of the glaziery damage declaration", "operationId"=>"postAssistanceV1HomeGlaziery_damageDeclarationsDeclaration_idContacts", "x-api-path-slug"=>"assistancev1homeglaziery-damagedeclarationsdeclaration-idcontacts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "contact", "information", "of", "the", "glaziery", "damage", "Declarations"]}}, "/assistance/v1/home/home_appliance_damage/declarations/{declaration_id}/confirm"=>{"post"=>{"summary"=>"Confirms the need for assistance", "description"=>"Confirms the need for assistance", "operationId"=>"postAssistanceV1HomeHome_appliance_damageDeclarationsDeclaration_idConfirm", "x-api-path-slug"=>"assistancev1homehome-appliance-damagedeclarationsdeclaration-idconfirm-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "ConfirmAssistance", "the", "needassistance"]}}, "/assistance/v1/home/home_appliance_damage/declarations/{declaration_id}/contacts"=>{"post"=>{"summary"=>"Adds contact information of the home appliance damage declaration", "description"=>"Adds contact information of the home appliance damage declaration", "operationId"=>"postAssistanceV1HomeHome_appliance_damageDeclarationsDeclaration_idContacts", "x-api-path-slug"=>"assistancev1homehome-appliance-damagedeclarationsdeclaration-idcontacts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "contact", "information", "of", "the", "home", "appliance", "damage", "Declarations"]}}, "/assistance/v1/home/home_appliance_damage/declarations/{declaration_id}/close"=>{"post"=>{"summary"=>"Closes the declaration after an other fixing solution", "description"=>"Closes the declaration after an other fixing solution", "operationId"=>"postAssistanceV1HomeHome_appliance_damageDeclarationsDeclaration_idClose", "x-api-path-slug"=>"assistancev1homehome-appliance-damagedeclarationsdeclaration-idclose-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "CloseAssistance", "the", "Declarations", "afterother", "fixing", "solution"]}}, "/assistance/v1/home/locksmithing_damage/declarations/{declaration_id}/close"=>{"post"=>{"summary"=>"Closes the declaration after an other fixing solution", "description"=>"Closes the declaration after an other fixing solution", "operationId"=>"postAssistanceV1HomeLocksmithing_damageDeclarationsDeclaration_idClose", "x-api-path-slug"=>"assistancev1homelocksmithing-damagedeclarationsdeclaration-idclose-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "CloseAssistance", "the", "Declarations", "afterother", "fixing", "solution"]}}, "/assistance/v1/home/locksmithing_damage/declarations/{declaration_id}/confirm"=>{"post"=>{"summary"=>"Confirms the need for assistance", "description"=>"Confirms the need for assistance", "operationId"=>"postAssistanceV1HomeLocksmithing_damageDeclarationsDeclaration_idConfirm", "x-api-path-slug"=>"assistancev1homelocksmithing-damagedeclarationsdeclaration-idconfirm-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "ConfirmAssistance", "the", "needassistance"]}}, "/assistance/v1/home/locksmithing_damage/declarations/{declaration_id}/contacts"=>{"post"=>{"summary"=>"Adds contact information of the locksmithing damage declaration", "description"=>"Adds contact information of the locksmithing damage declaration", "operationId"=>"postAssistanceV1HomeLocksmithing_damageDeclarationsDeclaration_idContacts", "x-api-path-slug"=>"assistancev1homelocksmithing-damagedeclarationsdeclaration-idcontacts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "contact", "information", "of", "the", "locksmithing", "damage", "Declarations"]}}, "/assistance/v1/home/water_damage/declarations/{declaration_id}/contacts"=>{"post"=>{"summary"=>"Adds contact information of the water damage declaration", "description"=>"Adds contact information of the water damage declaration", "operationId"=>"postAssistanceV1HomeWater_damageDeclarationsDeclaration_idContacts", "x-api-path-slug"=>"assistancev1homewater-damagedeclarationsdeclaration-idcontacts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "contact", "information", "of", "the", "water", "damage", "Declarations"]}}, "/assistance/v1/home/water_damage/declarations/{declaration_id}/close"=>{"post"=>{"summary"=>"Closes the declaration after an other fixing solution", "description"=>"Closes the declaration after an other fixing solution", "operationId"=>"postAssistanceV1HomeWater_damageDeclarationsDeclaration_idClose", "x-api-path-slug"=>"assistancev1homewater-damagedeclarationsdeclaration-idclose-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "CloseAssistance", "the", "Declarations", "afterother", "fixing", "solution"]}}, "/assistance/v1/home/water_damage/declarations/{declaration_id}/confirm"=>{"post"=>{"summary"=>"Confirms the need for assistance", "description"=>"Confirms the need for assistance", "operationId"=>"postAssistanceV1HomeWater_damageDeclarationsDeclaration_idConfirm", "x-api-path-slug"=>"assistancev1homewater-damagedeclarationsdeclaration-idconfirm-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "ConfirmAssistance", "the", "needassistance"]}}, "/sales/vexp/individual/travel/policies/{policy_id}/cancel"=>{"post"=>{"summary"=>"Cancel an existing policy", "description"=>"Cancel an existing policy", "operationId"=>"postSalesVexpIndividualTravelPoliciesPolicy_idCancel", "x-api-path-slug"=>"salesvexpindividualtravelpoliciespolicy-idcancel-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"policy_id", "description"=>"ID of the policy"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Cancelexisting", "policy"]}}, "/service/v1/medical_consultations/{medical_consultation_id}/prescriptions/{prescription_id}/send"=>{"post"=>{"summary"=>"Sends a prescription to its recipient", "description"=>"Sends a prescription to its recipient", "operationId"=>"postServiceV1Medical_consultationsMedical_consultation_idPrescriptionsPrescription_idSend", "x-api-path-slug"=>"servicev1medical-consultationsmedical-consultation-idprescriptionsprescription-idsend-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"medical_consultation_id", "description"=>"ID of the medical consultation"}, {"in"=>"path", "name"=>"prescription_id", "description"=>"ID of the prescription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Sendsprescription", "to", "itAssistance", "recipient"]}}, "/user/v1/identities/{identity_id}/channels/email"=>{"put"=>{"summary"=>"Update channel", "description"=>"Update channel", "operationId"=>"putUserV1IdentitiesIdentity_idChannelsEmail", "x-api-path-slug"=>"userv1identitiesidentity-idchannelsemail-put", "parameters"=>[{"in"=>"path", "name"=>"identity_id", "description"=>"ID of the identity"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "channel"]}}, "/user/v1/identities/{identity_id}"=>{"patch"=>{"summary"=>"Update identity", "description"=>"Update identity", "operationId"=>"patchUserV1IdentitiesIdentity_id", "x-api-path-slug"=>"userv1identitiesidentity-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"identity_id", "description"=>"ID of the identity"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "identity"]}}, "/assistance/v1/home/electric_damage/declarations/{declaration_id}"=>{"patch"=>{"summary"=>"Updates information related to the electric damage declaration", "description"=>"Updates information related to the electric damage declaration", "operationId"=>"patchAssistanceV1HomeElectric_damageDeclarationsDeclaration_id", "x-api-path-slug"=>"assistancev1homeelectric-damagedeclarationsdeclaration-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "information", "related", "to", "the", "electric", "damage", "Declarations"]}}, "/assistance/v1/home/gas_damage/declarations/{declaration_id}"=>{"patch"=>{"summary"=>"Updates information related to the gas damage declaration", "description"=>"Updates information related to the gas damage declaration", "operationId"=>"patchAssistanceV1HomeGas_damageDeclarationsDeclaration_id", "x-api-path-slug"=>"assistancev1homegas-damagedeclarationsdeclaration-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "information", "related", "to", "the", "gaAssistance", "damage", "Declarations"]}}, "/assistance/v1/home/glaziery_damage/declarations/{declaration_id}"=>{"patch"=>{"summary"=>"Updates information related to the glaziery damage declaration", "description"=>"Updates information related to the glaziery damage declaration", "operationId"=>"patchAssistanceV1HomeGlaziery_damageDeclarationsDeclaration_id", "x-api-path-slug"=>"assistancev1homeglaziery-damagedeclarationsdeclaration-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "information", "related", "to", "the", "glaziery", "damage", "Declarations"]}}, "/assistance/v1/home/home_appliance_damage/declarations/{declaration_id}"=>{"patch"=>{"summary"=>"Updates information related to the home appliance damage declaration", "description"=>"Updates information related to the home appliance damage declaration", "operationId"=>"patchAssistanceV1HomeHome_appliance_damageDeclarationsDeclaration_id", "x-api-path-slug"=>"assistancev1homehome-appliance-damagedeclarationsdeclaration-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "information", "related", "to", "the", "home", "appliance", "damage", "Declarations"]}}, "/assistance/v1/home/locksmithing_damage/declarations/{declaration_id}"=>{"patch"=>{"summary"=>"Updates information related to the locksmithing damage declaration", "description"=>"Updates information related to the locksmithing damage declaration", "operationId"=>"patchAssistanceV1HomeLocksmithing_damageDeclarationsDeclaration_id", "x-api-path-slug"=>"assistancev1homelocksmithing-damagedeclarationsdeclaration-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "information", "related", "to", "the", "locksmithing", "damage", "Declarations"]}}, "/assistance/v1/home/water_damage/declarations/{declaration_id}"=>{"patch"=>{"summary"=>"Updates information related to the water damage declaration", "description"=>"Updates information related to the water damage declaration", "operationId"=>"patchAssistanceV1HomeWater_damageDeclarationsDeclaration_id", "x-api-path-slug"=>"assistancev1homewater-damagedeclarationsdeclaration-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "information", "related", "to", "the", "water", "damage", "Declarations"]}}, "/assistance/v1/home/electric_damage/declarations/{declaration_id}/policy_holders/{policy_holder_id}"=>{"patch"=>{"summary"=>"Updates the policy holder information of the electric damage declaration", "description"=>"Updates the policy holder information of the electric damage declaration", "operationId"=>"patchAssistanceV1HomeElectric_damageDeclarationsDeclaration_idPolicy_holdersPolicy_holder_id", "x-api-path-slug"=>"assistancev1homeelectric-damagedeclarationsdeclaration-idpolicy-holderspolicy-holder-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}, {"in"=>"path", "name"=>"policy_holder_id", "description"=>"ID of the policy holder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "the", "policy", "holder", "information", "of", "the", "electric", "damage", "Declarations"]}}, "/assistance/v1/home/gas_damage/declarations/{declaration_id}/policy_holders/{policy_holder_id}"=>{"patch"=>{"summary"=>"Updates the policy holder information of the gas damage declaration", "description"=>"Updates the policy holder information of the gas damage declaration", "operationId"=>"patchAssistanceV1HomeGas_damageDeclarationsDeclaration_idPolicy_holdersPolicy_holder_id", "x-api-path-slug"=>"assistancev1homegas-damagedeclarationsdeclaration-idpolicy-holderspolicy-holder-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}, {"in"=>"path", "name"=>"policy_holder_id", "description"=>"ID of the policy holder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "the", "policy", "holder", "information", "of", "the", "gaAssistance", "damage", "Declarations"]}}, "/assistance/v1/home/glaziery_damage/declarations/{declaration_id}/policy_holders/{policy_holder_id}"=>{"patch"=>{"summary"=>"Updates the policy holder information of the glaziery damage declaration", "description"=>"Updates the policy holder information of the glaziery damage declaration", "operationId"=>"patchAssistanceV1HomeGlaziery_damageDeclarationsDeclaration_idPolicy_holdersPolicy_holder_id", "x-api-path-slug"=>"assistancev1homeglaziery-damagedeclarationsdeclaration-idpolicy-holderspolicy-holder-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}, {"in"=>"path", "name"=>"policy_holder_id", "description"=>"ID of the policy holder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "the", "policy", "holder", "information", "of", "the", "glaziery", "damage", "Declarations"]}}, "/assistance/v1/home/home_appliance_damage/declarations/{declaration_id}/policy_holders/{policy_holder_id}"=>{"patch"=>{"summary"=>"Update the policy holder information of the home appliance damage declaration", "description"=>"Update the policy holder information of the home appliance damage declaration", "operationId"=>"patchAssistanceV1HomeHome_appliance_damageDeclarationsDeclaration_idPolicy_holdersPolicy_holder_id", "x-api-path-slug"=>"assistancev1homehome-appliance-damagedeclarationsdeclaration-idpolicy-holderspolicy-holder-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}, {"in"=>"path", "name"=>"policy_holder_id", "description"=>"ID of the policy holder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "the", "policy", "holder", "information", "of", "the", "home", "appliance", "damage", "Declarations"]}}, "/assistance/v1/home/locksmithing_damage/declarations/{declaration_id}/policy_holders/{policy_holder_id}"=>{"patch"=>{"summary"=>"Updates the policy holder information of the locksmithing damage declaration", "description"=>"Updates the policy holder information of the locksmithing damage declaration", "operationId"=>"patchAssistanceV1HomeLocksmithing_damageDeclarationsDeclaration_idPolicy_holdersPolicy_holder_id", "x-api-path-slug"=>"assistancev1homelocksmithing-damagedeclarationsdeclaration-idpolicy-holderspolicy-holder-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}, {"in"=>"path", "name"=>"policy_holder_id", "description"=>"ID of the policy holder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "the", "policy", "holder", "information", "of", "the", "locksmithing", "damage", "Declarations"]}}, "/assistance/v1/home/water_damage/declarations/{declaration_id}/policy_holders/{policy_holder_id}"=>{"patch"=>{"summary"=>"Updates the policy holder information of the water damage declaration", "description"=>"Updates the policy holder information of the water damage declaration", "operationId"=>"patchAssistanceV1HomeWater_damageDeclarationsDeclaration_idPolicy_holdersPolicy_holder_id", "x-api-path-slug"=>"assistancev1homewater-damagedeclarationsdeclaration-idpolicy-holderspolicy-holder-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"declaration_id", "description"=>"ID of the declaration"}, {"in"=>"path", "name"=>"policy_holder_id", "description"=>"ID of the policy holder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insurance", "Assistance", "the", "policy", "holder", "information", "of", "the", "water", "damage", "Declarations"]}}}}, "apis"=>{"name"=>"AXA Assistance", "x-slug"=>"axa-assistance", "description"=>"AXA Assistance is a worldwide specialist for car insurance, travel, health and home services. Trust in Axa Assistance for your insurance!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28187-www-axa-assistance-com.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"2107685", "tags"=>"API Provider,General Data,Insurance,internet,Profiles,Relative Data,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"axa-assistance/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AXA Assistance", "x-api-slug"=>"axa-assistance", "description"=>"AXA Assistance is a worldwide specialist for car insurance, travel, health and home services. Trust in Axa Assistance for your insurance!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28187-www-axa-assistance-com.jpg", "humanURL"=>"https://www.axa-assistance.com", "baseURL"=>"https://sandbox.api.axa-assistance.com//", "tags"=>"API Provider,General Data,Insurance,internet,Profiles,Relative Data,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/axa-assistance/assistancev1homewater-damagedeclarationsdeclaration-idpolicy-holderspolicy-holder-id-patch-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/axa-assistance/axa-assistance-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/axa-assitance"}, {"type"=>"x-developer", "url"=>"https://developers.axa-assistance.com/"}, {"type"=>"x-documentation", "url"=>"https://developers.axa-assistance.com/docs"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/AXA_Assistance"}, {"type"=>"x-website", "url"=>"https://www.axa-assistance.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-sql-database{"azure-sql-database-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure SQL Database", "x-complete"=>1, "info"=>{"title"=>"Azure SQL Database", "description"=>"provides-create-read-update-and-delete-functionality-for-azure-sql-database-resources-including-servers-databases-elastic-pools-recommendations-operations-and-usage-metrics-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/restorePoints"=>{"get"=>{"summary"=>"Databases List Restore Points", "description"=>"Returns a list of database restore points.", "operationId"=>"Databases_ListRestorePoints", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenamerestorepoints-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database from which to retrieve available restore points"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Restore Points"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationId}/capabilities"=>{"get"=>{"summary"=>"Capabilities List By Location", "description"=>"Gets the capabilities available for the specified location.", "operationId"=>"Capabilities_ListByLocation", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-sqllocationslocationidcapabilities-get", "parameters"=>[{"in"=>"path", "name"=>"locationId", "description"=>"The location id whose capabilities are retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Capabilities Location"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/securityAlertPolicies/default"=>{"get"=>{"summary"=>"Databases Get Threat Detection Policy", "description"=>"Gets a database's threat detection policy.", "operationId"=>"Databases_GetThreatDetectionPolicy", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenamesecurityalertpoliciesdefault-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database for which database Threat Detection policy is defined"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Threat Detection Policy"]}, "put"=>{"summary"=>"Databases Create Or Update Threat Detection Policy", "description"=>"Creates or updates a database's threat detection policy.", "operationId"=>"Databases_CreateOrUpdateThreatDetectionPolicy", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenamesecurityalertpoliciesdefault-put", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database for which database Threat Detection policy is defined"}, {"in"=>"body", "name"=>"parameters", "description"=>"The database Threat Detection policy", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Threat Detection Policy"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules/{firewallRuleName}"=>{"put"=>{"summary"=>"Firewall Rules Create Or Update", "description"=>"Creates or updates a firewall rule.", "operationId"=>"FirewallRules_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamefirewallrulesfirewallrulename-put", "parameters"=>[{"in"=>"path", "name"=>"firewallRuleName", "description"=>"The name of the firewall rule"}, {"in"=>"body", "name"=>"parameters", "description"=>"The required parameters for creating or updating a firewall rule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall Rules"]}, "delete"=>{"summary"=>"Firewall Rules Delete", "description"=>"Deletes a firewall rule.", "operationId"=>"FirewallRules_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamefirewallrulesfirewallrulename-delete", "parameters"=>[{"in"=>"path", "name"=>"firewallRuleName", "description"=>"The name of the firewall rule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall Rules"]}, "get"=>{"summary"=>"Firewall Rules Get", "description"=>"Gets a firewall rule.", "operationId"=>"FirewallRules_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamefirewallrulesfirewallrulename-get", "parameters"=>[{"in"=>"path", "name"=>"firewallRuleName", "description"=>"The name of the firewall rule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall Rules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules"=>{"get"=>{"summary"=>"Firewall Rules List By Server", "description"=>"Returns a list of firewall rules.", "operationId"=>"FirewallRules_ListByServer", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamefirewallrules-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall Rules Server"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/import"=>{"post"=>{"summary"=>"Databases Import", "description"=>"Imports a bacpac into a new database.", "operationId"=>"Databases_Import", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernameimport-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The required parameters for importing a Bacpac into a database", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Import"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extensions/import"=>{"put"=>{"summary"=>"Databases Create Import Operation", "description"=>"Creates an import operation that imports a bacpac into an existing database. The existing database must be empty.", "operationId"=>"Databases_CreateImportOperation", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenameextensionsimport-put", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database to import into"}, {"in"=>"body", "name"=>"parameters", "description"=>"The required parameters for importing a Bacpac into a database", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Import Operation"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/export"=>{"post"=>{"summary"=>"Databases Export", "description"=>"Exports a database to a bacpac.", "operationId"=>"Databases_Export", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenameexport-post", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database to be exported"}, {"in"=>"body", "name"=>"parameters", "description"=>"The required parameters for exporting a database", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Export"]}}, "/providers/Microsoft.Sql/operations"=>{"get"=>{"summary"=>"Operations List", "description"=>"Lists all of the available SQL Rest API operations.", "operationId"=>"Operations_List", "x-api-path-slug"=>"providersmicrosoft-sqloperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}"=>{"delete"=>{"summary"=>"Databases Delete Replication Link", "description"=>"Deletes a database replication link. Cannot be done during failover.", "operationId"=>"Databases_DeleteReplicationLink", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenamereplicationlinkslinkid-delete", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database that has the replication link to be dropped"}, {"in"=>"path", "name"=>"linkId", "description"=>"The ID of the replication link to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Replication Link"]}, "get"=>{"summary"=>"Databases Get Replication Link", "description"=>"Gets a database replication link.", "operationId"=>"Databases_GetReplicationLink", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenamereplicationlinkslinkid-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database to get the link for"}, {"in"=>"path", "name"=>"linkId", "description"=>"The replication link ID to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Replication Link"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}/failover"=>{"post"=>{"summary"=>"Databases Failover Replication Link", "description"=>"Sets which replica database is primary by failing over from the current primary replica database.", "operationId"=>"Databases_FailoverReplicationLink", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenamereplicationlinkslinkidfailover-post", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database that has the replication link to be failed over"}, {"in"=>"path", "name"=>"linkId", "description"=>"The ID of the replication link to be failed over"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Failover Replication Link"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}/forceFailoverAllowDataLoss"=>{"post"=>{"summary"=>"Databases Failover Replication Link Allow Data Loss", "description"=>"Sets which replica database is primary by failing over from the current primary replica database. This operation might result in data loss.", "operationId"=>"Databases_FailoverReplicationLinkAllowDataLoss", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenamereplicationlinkslinkidforcefailoverallowdataloss-post", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database that has the replication link to be failed over"}, {"in"=>"path", "name"=>"linkId", "description"=>"The ID of the replication link to be failed over"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Failover Replication Link Allow Data Loss"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks"=>{"get"=>{"summary"=>"Databases List Replication Links", "description"=>"Lists a database's replication links.", "operationId"=>"Databases_ListReplicationLinks", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenamereplicationlinks-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database to retrieve links for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Replication Links"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Sql/servers"=>{"get"=>{"summary"=>"Servers List", "description"=>"Returns a list of servers.", "operationId"=>"Servers_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-sqlservers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}"=>{"put"=>{"summary"=>"Servers Create Or Update", "description"=>"Creates or updates a new server.", "operationId"=>"Servers_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservername-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The required parameters for creating or updating a server", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}, "delete"=>{"summary"=>"Servers Delete", "description"=>"Deletes a SQL server.", "operationId"=>"Servers_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservername-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}, "get"=>{"summary"=>"Servers Get", "description"=>"Gets a server.", "operationId"=>"Servers_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservername-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers"=>{"get"=>{"summary"=>"Servers List By Resource Group", "description"=>"Returns a list of servers in a resource group.", "operationId"=>"Servers_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlservers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers Resource Group"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/usages"=>{"get"=>{"summary"=>"Servers List Usages", "description"=>"Returns server usages.", "operationId"=>"Servers_ListUsages", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernameusages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers Usages"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/pause"=>{"post"=>{"summary"=>"Databases Pause", "description"=>"Pauses a data warehouse.", "operationId"=>"Databases_Pause", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenamepause-post", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the data warehouse to pause"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Pause"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/resume"=>{"post"=>{"summary"=>"Databases Resume", "description"=>"Resumes a data warehouse.", "operationId"=>"Databases_Resume", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenameresume-post", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the data warehouse to resume"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Resume"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}"=>{"put"=>{"summary"=>"Databases Create Or Update", "description"=>"Creates a new database or updates an existing database. Location is a required property in the request body, and it must be the same as the location of the SQL server.", "operationId"=>"Databases_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasename-put", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database to be operated on (updated or created)"}, {"in"=>"body", "name"=>"parameters", "description"=>"The required parameters for creating or updating a database", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases"]}, "delete"=>{"summary"=>"Databases Delete", "description"=>"Deletes a database.", "operationId"=>"Databases_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasename-delete", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases"]}, "get"=>{"summary"=>"Databases Get", "description"=>"Gets a database.", "operationId"=>"Databases_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasename-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases"=>{"get"=>{"summary"=>"Databases List By Server", "description"=>"Returns a list of databases in a server.", "operationId"=>"Databases_ListByServer", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabases-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"An OData filter expression that describes a subset of databases to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Server"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/usages"=>{"get"=>{"summary"=>"Databases List Usages", "description"=>"Returns database usages.", "operationId"=>"Databases_ListUsages", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenameusages-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Usages"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}"=>{"put"=>{"summary"=>"Elastic Pools Create Or Update", "description"=>"Creates a new elastic pool or updates an existing elastic pool.", "operationId"=>"ElasticPools_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernameelasticpoolselasticpoolname-put", "parameters"=>[{"in"=>"path", "name"=>"elasticPoolName", "description"=>"The name of the elastic pool to be operated on (updated or created)"}, {"in"=>"body", "name"=>"parameters", "description"=>"The required parameters for creating or updating an elastic pool", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Elastic Pools"]}, "delete"=>{"summary"=>"Elastic Pools Delete", "description"=>"Deletes the elastic pool.", "operationId"=>"ElasticPools_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernameelasticpoolselasticpoolname-delete", "parameters"=>[{"in"=>"path", "name"=>"elasticPoolName", "description"=>"The name of the elastic pool to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Elastic Pools"]}, "get"=>{"summary"=>"Elastic Pools Get", "description"=>"Gets an elastic pool.", "operationId"=>"ElasticPools_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernameelasticpoolselasticpoolname-get", "parameters"=>[{"in"=>"path", "name"=>"elasticPoolName", "description"=>"The name of the elastic pool to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Elastic Pools"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools"=>{"get"=>{"summary"=>"Elastic Pools List By Server", "description"=>"Returns a list of elastic pools in a server.", "operationId"=>"ElasticPools_ListByServer", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernameelasticpools-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Elastic Pools Server"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}/elasticPoolActivity"=>{"get"=>{"summary"=>"Elastic Pools List Activity", "description"=>"Returns elastic pool activities.", "operationId"=>"ElasticPools_ListActivity", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernameelasticpoolselasticpoolnameelasticpoolactivity-get", "parameters"=>[{"in"=>"path", "name"=>"elasticPoolName", "description"=>"The name of the elastic pool for which to get the current activity"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Elastic Pools Activity"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}/elasticPoolDatabaseActivity"=>{"get"=>{"summary"=>"Elastic Pools List Database Activity", "description"=>"Returns activity on databases inside of an elastic pool.", "operationId"=>"ElasticPools_ListDatabaseActivity", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernameelasticpoolselasticpoolnameelasticpooldatabaseactivity-get", "parameters"=>[{"in"=>"path", "name"=>"elasticPoolName", "description"=>"The name of the elastic pool"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Elastic Pools Database Activity"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}/databases/{databaseName}"=>{"get"=>{"summary"=>"Elastic Pools Get Database", "description"=>"Gets a database inside of an elastic pool.", "operationId"=>"ElasticPools_GetDatabase", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernameelasticpoolselasticpoolnamedatabasesdatabasename-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database to be retrieved"}, {"in"=>"path", "name"=>"elasticPoolName", "description"=>"The name of the elastic pool to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Elastic Pools Database"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}/databases"=>{"get"=>{"summary"=>"Elastic Pools List Databases", "description"=>"Returns a list of databases in an elastic pool.", "operationId"=>"ElasticPools_ListDatabases", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernameelasticpoolselasticpoolnamedatabases-get", "parameters"=>[{"in"=>"path", "name"=>"elasticPoolName", "description"=>"The name of the elastic pool to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Elastic Pools Databases"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/recommendedElasticPools/{recommendedElasticPoolName}"=>{"get"=>{"summary"=>"Recommended Elastic Pools Get", "description"=>"Gets a recommented elastic pool.", "operationId"=>"RecommendedElasticPools_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamerecommendedelasticpoolsrecommendedelasticpoolname-get", "parameters"=>[{"in"=>"path", "name"=>"recommendedElasticPoolName", "description"=>"The name of the recommended elastic pool to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recommended Elastic Pools"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/recommendedElasticPools/{recommendedElasticPoolName}/databases/{databaseName}"=>{"get"=>{"summary"=>"Recommended Elastic Pools Get Databases", "description"=>"Gets a database inside of a recommented elastic pool.", "operationId"=>"RecommendedElasticPools_GetDatabases", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamerecommendedelasticpoolsrecommendedelasticpoolnamedatabasesdatabasename-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database to be retrieved"}, {"in"=>"path", "name"=>"recommendedElasticPoolName", "description"=>"The name of the elastic pool to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recommended Elastic Pools Databases"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/recommendedElasticPools"=>{"get"=>{"summary"=>"Recommended Elastic Pools List By Server", "description"=>"Returns recommended elastic pools.", "operationId"=>"RecommendedElasticPools_ListByServer", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamerecommendedelasticpools-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recommended Elastic Pools Server"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/recommendedElasticPools/{recommendedElasticPoolName}/databases"=>{"get"=>{"summary"=>"Recommended Elastic Pools List Databases", "description"=>"Returns a list of databases inside a recommented elastic pool.", "operationId"=>"RecommendedElasticPools_ListDatabases", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamerecommendedelasticpoolsrecommendedelasticpoolnamedatabases-get", "parameters"=>[{"in"=>"path", "name"=>"recommendedElasticPoolName", "description"=>"The name of the recommended elastic pool to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recommended Elastic Pools Databases"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/recommendedElasticPools/{recommendedElasticPoolName}/metrics"=>{"get"=>{"summary"=>"Recommended Elastic Pools List Metrics", "description"=>"Returns a recommented elastic pool metrics.", "operationId"=>"RecommendedElasticPools_ListMetrics", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamerecommendedelasticpoolsrecommendedelasticpoolnamemetrics-get", "parameters"=>[{"in"=>"path", "name"=>"recommendedElasticPoolName", "description"=>"The name of the recommended elastic pool to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recommended Elastic Pools Metrics"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/serviceTierAdvisors/{serviceTierAdvisorName}"=>{"get"=>{"summary"=>"Databases Get Service Tier Advisor", "description"=>"Gets a service tier advisor.", "operationId"=>"Databases_GetServiceTierAdvisor", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenameservicetieradvisorsservicetieradvisorname-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of database"}, {"in"=>"path", "name"=>"serviceTierAdvisorName", "description"=>"The name of service tier advisor"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Service Tier Advisor"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/serviceTierAdvisors"=>{"get"=>{"summary"=>"Databases List Service Tier Advisors", "description"=>"Returns service tier advisors for specified database.", "operationId"=>"Databases_ListServiceTierAdvisors", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenameservicetieradvisors-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of database"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Service Tier Advisors"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/serviceObjectives/{serviceObjectiveName}"=>{"get"=>{"summary"=>"Servers Get Service Objective", "description"=>"Gets a database service objective.", "operationId"=>"Servers_GetServiceObjective", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernameserviceobjectivesserviceobjectivename-get", "parameters"=>[{"in"=>"path", "name"=>"serviceObjectiveName", "description"=>"The name of the service objective to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers Service Objective"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/serviceObjectives"=>{"get"=>{"summary"=>"Servers List Service Objectives", "description"=>"Returns database service objectives.", "operationId"=>"Servers_ListServiceObjectives", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernameserviceobjectives-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers Service Objectives"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/transparentDataEncryption/current"=>{"put"=>{"summary"=>"Databases Create Or Update Transparent Data Encryption Configuration", "description"=>"Creates or updates a database's transparent data encryption configuration.", "operationId"=>"Databases_CreateOrUpdateTransparentDataEncryptionConfiguration", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenametransparentdataencryptioncurrent-put", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database for which setting the transparent data encryption applies"}, {"in"=>"body", "name"=>"parameters", "description"=>"The required parameters for creating or updating transparent data encryption", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Transparent Data Encryption Configuration"]}, "get"=>{"summary"=>"Databases Get Transparent Data Encryption Configuration", "description"=>"Gets a database's transparent data encryption configuration.", "operationId"=>"Databases_GetTransparentDataEncryptionConfiguration", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenametransparentdataencryptioncurrent-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database for which the transparent data encryption applies"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Transparent Data Encryption Configuration"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/transparentDataEncryption/current/operationResults"=>{"get"=>{"summary"=>"Databases List Transparent Data Encryption Activity", "description"=>"Returns a database's transparent data encryption operation result.", "operationId"=>"Databases_ListTransparentDataEncryptionActivity", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenametransparentdataencryptioncurrentoperationresults-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database for which the transparent data encryption applies"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Databases Transparent Data Encryption Activity"]}}}}, "apis"=>{"name"=>"Azure SQL Database", "x-slug"=>"azure-sql-database", "description"=>"Make building and maintaining applications easier and more productive. With built-in intelligence that learns app patterns and adapts to maximize performance, reliability, and data protection, SQL Database is a cloud database built for developers.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-sql-01-stop-worrying.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Databases,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-sql-database/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure SQL Database API", "x-api-slug"=>"azure-sql-database-api", "description"=>"Make building and maintaining applications easier and more productive. With built-in intelligence that learns app patterns and adapts to maximize performance, reliability, and data protection, SQL Database is a cloud database built for developers.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-sql-01-stop-worrying.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/sql-database/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Databases,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-sql-database/subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-sqlserversservernamedatabasesdatabasenametransparentdataencryptioncurrentoperationresults-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-sql-database/azure-sql-database-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/sql-database/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/sql-database/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/sql-database/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/sql-database/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
newswhip{"apis"=>{"name"=>"NewsWhip", "x-slug"=>"newswhip", "description"=>"Understand what social media content resonates with audiences. Centralize your social media monitoring and analytics to discover whats driving engagement.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11443-newswhip.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"97323", "tags"=>"API Provider,General Data,internet,Mobile,News,News,News API,Profiles,Publish,Relative Data,SaaS,Stack Network,Target,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"newswhip/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"News Whip API", "x-api-slug"=>"news-whip-api", "description"=>"Understand what social media content resonates with audiences. Centralize your social media monitoring and analytics to discover whats driving engagement.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11443-newswhip.jpg", "humanURL"=>"https://www.newswhip.com/", "baseURL"=>"https://api.newswhip.com/v1/", "tags"=>"API Provider,General Data,internet,Mobile,News,News,News API,Profiles,Publish,Relative Data,SaaS,Stack Network,Target,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/newswhip/regionregioncategorytime-period-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/newswhip/news-whip-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"http://www.newswhip.com/api-widgets#authentication"}, {"type"=>"x-base", "url"=>"https://api.newswhip.com"}, {"type"=>"x-blog", "url"=>"http://blog.newswhip.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.newswhip.com/index.php/feed"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/newswhip"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/organization/newswhip"}, {"type"=>"x-email", "url"=>"contact@newswhip.com"}, {"type"=>"x-faq", "url"=>"https://spike.newswhip.com/faq"}, {"type"=>"x-pricing", "url"=>"https://spike.newswhip.com/pricing/team"}, {"type"=>"x-terms-of-service", "url"=>"http://www.newswhip.com/PrivacyAndLegal"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/NewsWhip"}, {"type"=>"x-website", "url"=>"https://www.newswhip.com/"}, {"type"=>"x-website", "url"=>"http://newswhip.com"}, {"type"=>"x-widgets", "url"=>"http://www.newswhip.com/widgetabout#widget"}, {"type"=>"x-wikipedia-", "url"=>"http://en.wikipedia.org/wiki/NewsWhip"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "news-whip-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"NewsWhip", "x-complete"=>1, "info"=>{"title"=>"News Whip API", "description"=>"our-api-partners-get-complete-access-to-our-rankings-in-a-machinereadable-format-json-rss-with-the-option-of-using-country-city-topic-and-time-filters-for-a-deeper-dive-into-the-200000-new-pieces-of-content-we-track-every-day-", "termsOfService"=>"http://www.newswhip.com/PrivacyAndLegal", "version"=>"v1"}, "host"=>"api.newswhip.com", "basePath"=>"v1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"local/"=>{"get"=>{"summary"=>"Local", "description"=>"Pull list of localities.", "operationId"=>"getLocal", "x-api-path-slug"=>"local-get", "parameters"=>[{"in"=>"query", "name"=>"key", "description"=>"API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Local"]}}, "local/{city}/All/{time_period}"=>{"get"=>{"summary"=>"Local", "description"=>"Search local news.", "operationId"=>"getLocalCityAllTimePeriod", "x-api-path-slug"=>"localcityalltime-period-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"Filters articles published in that city"}, {"in"=>"query", "name"=>"key", "description"=>"API Key"}, {"in"=>"query", "name"=>"sort_by", "description"=>"One of the following: [default, fb_likes, fb_shares, fb_comments, fb_total, twitter, linkedin, fb_tw_and_li, nw_score, nw_max_score]"}, {"in"=>"path", "name"=>"time_period", "description"=>"Filters articles published within the last X hours"}, {"in"=>"query", "name"=>"video_only", "description"=>"true or false"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Local", "City", "Time", "Period"]}}, "publisher/"=>{"get"=>{"summary"=>"Publisher", "description"=>"Pull publishers.", "operationId"=>"getPublisher", "x-api-path-slug"=>"publisher-get", "parameters"=>[{"in"=>"query", "name"=>"key", "description"=>"API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Publisher"]}}, "publisher/{publisher}/{time_period}"=>{"get"=>{"summary"=>"Publisher", "description"=>"Search news by publisiher.", "operationId"=>"getPublisherPublisherTimePeriod", "x-api-path-slug"=>"publisherpublishertime-period-get", "parameters"=>[{"in"=>"query", "name"=>"key", "description"=>"API Key"}, {"in"=>"path", "name"=>"publisher", "description"=>"Returns all articles published within that domain or subdomain"}, {"in"=>"query", "name"=>"sort_by", "description"=>"One of the following: [default, fb_likes, fb_shares, fb_comments, fb_total, twitter, linkedin, fb_tw_and_li, nw_score, nw_max_score]"}, {"in"=>"path", "name"=>"time_period", "description"=>"Filters articles published within the last X hours"}, {"in"=>"query", "name"=>"video_only", "description"=>"true or false"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Publisher", "Publisher", "Time", "Period"]}}, "region/"=>{"get"=>{"summary"=>"Region", "description"=>"Retrieve list of regions", "operationId"=>"getRegion", "x-api-path-slug"=>"region-get", "parameters"=>[{"in"=>"query", "name"=>"key", "description"=>"API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Region"]}}, "region/{region}/{category}/{time_period}"=>{"get"=>{"summary"=>"Region", "description"=>"Search news by region", "operationId"=>"getRegionRegionCategoryTimePeriod", "x-api-path-slug"=>"regionregioncategorytime-period-get", "parameters"=>[{"in"=>"path", "name"=>"category", "description"=>"Filters articles by {category}"}, {"in"=>"query", "name"=>"key", "description"=>"API key"}, {"in"=>"path", "name"=>"region", "description"=>"Filters articles published in that {region}"}, {"in"=>"query", "name"=>"sort_by", "description"=>"One of the following: [default, fb_likes, fb_shares, fb_comments, fb_total, twitter, linkedin, fb_tw_and_li, nw_score, nw_max_score]"}, {"in"=>"path", "name"=>"time_period", "description"=>"Filters articles published within the last X hours"}, {"in"=>"query", "name"=>"video_only", "description"=>"true or false"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Region", "Region", "Category", "Time", "Period"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
next-caller{"next-caller-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Next Caller", "x-complete"=>1, "info"=>{"title"=>"Next Caller", "description"=>"advanced-caller-id--obtain-name-address-and-email-of-your-inbound-callers-", "version"=>"1.0.0"}, "host"=>"api.sandbox.nextcaller.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{version}/records/"=>{"parameters"=>{"summary"=>"Parameters Version Records", "description"=>"Parameters version records.", "operationId"=>"parametersVersionRecords", "x-api-path-slug"=>"versionrecords-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Records"]}, "get"=>{"summary"=>"Get Version Records", "description"=>"Returns Nextcaller member detailed info.", "operationId"=>"getVersionRecords", "x-api-path-slug"=>"versionrecords-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Specifies a format of response: JSON or XML"}, {"in"=>"query", "name"=>"phone", "description"=>"Specifies the callers phone number"}, {"in"=>"path", "name"=>"version", "description"=>"Specifies a api version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Records"]}}, "/{version}/users/{nextcaller_id}/?format={format}"=>{"parameters"=>{"summary"=>"Parameters Version Users Nextcaller Format Format", "description"=>"Parameters version users nextcaller format format.", "operationId"=>"parametersVersionUsersNextcallerFormatFormat", "x-api-path-slug"=>"versionusersnextcaller-idformatformat-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Users", "Nextcaller", "Id", "?format=format"]}, "post"=>{"summary"=>"Post Version Users Nextcaller Format Format", "description"=>"Allows you to update caller's info on Nextcaller.", "operationId"=>"postVersionUsersNextcallerFormatFormat", "x-api-path-slug"=>"versionusersnextcaller-idformatformat-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Advanced Caller ID"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"format", "description"=>"Specifies a format of response: JSON or XML"}, {"in"=>"path", "name"=>"nextcaller_id", "description"=>"The ID of the user whose profile you wish to edit"}, {"in"=>"path", "name"=>"version", "description"=>"Specifies a api version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Users", "Nextcaller", "Id", "?format=format"]}}}}, "apis"=>{"name"=>"Next Caller", "x-slug"=>"next-caller", "description"=>"Identify inbound phone numbers and increase sales conversion with accurate real-time caller data. Accurately detect phone spoofing fraud before you pickup the phone and route your inbound calls intelligently", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2468-next-caller.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"3612031", "tags"=>"API Provider,Caller ID,Enterprise,Messages,Networks,Profiles,Relative Data,SaaS,Service API,Stack Network,Target,Technology,Telecommunications,Telecommunications,Telephony", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"next-caller/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Next Caller", "x-api-slug"=>"next-caller", "description"=>"Next Caller’s RESTful API is designed to allow your business the ability to identify unknown callers with our Advanced Caller ID™ service.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2468-next-caller.jpg", "humanURL"=>"https://nextcaller.com", "baseURL"=>"https://api.sandbox.nextcaller.com//", "tags"=>"API Provider,Caller ID,Enterprise,Messages,Networks,Profiles,Relative Data,SaaS,Service API,Stack Network,Target,Technology,Telecommunications,Telecommunications,Telephony", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/next-caller/versionusersnextcaller-idformatformat-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/next-caller/next-caller-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://nextcaller.com/documentation/#/authentication/curl"}, {"type"=>"x-blog", "url"=>"https://nextcaller.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"https://nextcaller.com/blog/blog?format=RSS"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/next-caller"}, {"type"=>"x-developer", "url"=>"https://dev.nextcaller.com/"}, {"type"=>"x-email", "url"=>"privacy@nextcaller.com"}, {"type"=>"x-email", "url"=>"info@nextcaller.com"}, {"type"=>"x-error-codes", "url"=>"https://nextcaller.com/documentation/#/errors/curl"}, {"type"=>"x-facebook", "url"=>"https://www.facebook.com/Next.Caller1"}, {"type"=>"x-faq", "url"=>"https://nextcaller.com/faq/"}, {"type"=>"x-google-plus", "url"=>"https://plus.google.com/+Nextcaller/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/NextCallerAPI"}, {"type"=>"x-pricing", "url"=>"https://nextcaller.com/pricing/"}, {"type"=>"x-status", "url"=>"http://status.nextcaller.com/"}, {"type"=>"x-terms-of-service", "url"=>"https://dev.nextcaller.com/terms/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/nextcaller"}, {"type"=>"x-website", "url"=>"https://nextcaller.com"}, {"type"=>"x-website", "url"=>"http://nextcaller.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
synq-video{"synq-video-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"SYNQ Video", "x-complete"=>1, "info"=>{"title"=>"SYNQ Video", "description"=>"-sign-up-for-a-developer-api-keyhttpswww-synq-fmregister-synq-api-guide", "version"=>"1.9.1"}, "host"=>"api.synq.fm", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/video/create"=>{"post"=>{"summary"=>"Create a new video, optionally setting some metadata fields.", "description"=>"Create a new video, optionally setting some metadata fields. You may optionally set some of the metadata associated with the video. Only fields inside the \"userdata\" field can be set.", "operationId"=>"create", "x-api-path-slug"=>"videocreate-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"userdata", "description"=>"Additional metadata that will be associated with the video"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video", "Create"]}}, "/video/details"=>{"post"=>{"summary"=>"Return details about a video.", "description"=>"Return details about a video. You may optionally request that only some of the metadata fields are returned.", "operationId"=>"details", "x-api-path-slug"=>"videodetails-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"video_id", "description"=>"ID of the video to retrieve the metadata from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video", "Details"]}}, "/video/query"=>{"post"=>{"summary"=>"Perform a JavaScript query to return video objects matching any desired criteria.", "description"=>"Find videos matching any criteria, by running a JavaScript function over each video object. A detailed tutorial on how to use this functionality is available on the [documentation page](https://www.synq.fm/queries-video-api/).", "operationId"=>"query", "x-api-path-slug"=>"videoquery-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"filter", "description"=>"JavaScript code to be run over each video object, to determine what should be returend"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video", "Query"]}}, "/video/stream"=>{"post"=>{"summary"=>"Returns urls for streaming.", "description"=>"Returns a stream url that you can stream to from your broadcasting software, and a playback url people can use to watch the stream.", "operationId"=>"stream", "x-api-path-slug"=>"videostream-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"video_id", "description"=>"The ID of the video you want to stream to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video", "Stream"]}}, "/video/update"=>{"post"=>{"summary"=>"Update a video's metadata.", "description"=>"Update a video's metadata through JavaScript code. Only fields inside the \"userdata\" object can be set.", "operationId"=>"update", "x-api-path-slug"=>"videoupdate-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"source", "description"=>"JavaScript code to execute on the video object"}, {"in"=>"formData", "name"=>"video_id", "description"=>"The ID of the video whose metadata will be updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video", "Update"]}}, "/video/upload"=>{"post"=>{"summary"=>"Return parameters needed for uploading a video file.", "description"=>"Return parameters needed for uploading a video file to Amazon Simple Storage Service. See http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-post-example.html as well as the language-specific code-examples.\n#### *Example request*\n```shell\ncurl -s https://api.synq.fm/v1/video/upload \\\n -F api_key=${SYNQ_API_KEY} \\\n -F video_id=2d81c30ce62f4dfdb501dbca96c7ae56\n```\n\n#### *Example response*\n```json\n{\n \"action\": \"https://synqfm.s3.amazonaws.com/\",\n \"AWSAccessKeyId\": \"AKIAIP77Y7MMX3ITZMFA\",\n \"Content-Type\": \"video/mp4\",\n \"Policy\": \"eyJleHBpcmF0aW9uIiA6ICIyMDE2LTA0LTIyVDE5OjAyOjI2LjE3MloiLCAiY29uZGl0aW9ucyIgOiBbeyJidWNrZXQiIDogInN5bnFmbSJ9LCB7ImFjbCIgOiAicHVibGljLXJlYWQifSwgWyJzdGFydHMtd2l0aCIsICIka2V5IiwgInByb2plY3RzLzZlLzYzLzZlNjNiNzUyYTE4NTRkZGU4ODViNWNjNDcyZWRmNTY5L3VwbG9hZHMvdmlkZW9zLzJkLzgxLzJkODFjMzBjZTYyZjRkZmRiNTAxZGJjYTk2YzdhZTU2Lm1wNCJdLCBbInN0YXJ0cy13aXRoIiwgIiRDb250ZW50LVR5cGUiLCAidmlkZW8vbXA0Il0sIFsiY29udGVudC1sZW5ndGgtcmFuZ2UiLCAwLCAxMDk5NTExNjI3Nzc2XV19\",\n \"Signature\": \"ysqDemlKXKr6hKzVFP0hCGgf/cs=\",\n \"acl\": \"public-read\",\n \"key\": \"projects/6e/63/6e63b752a1854dde885b5cc472edf569/uploads/videos/2d/81/2d81c30ce62f4dfdb501dbca96c7ae56.mp4\"\n}\n```\n\nTo upload the file, you can then make a multipart POST request to the URL in `action`, and for all the other parameters returned, set them as form parameters.\n\nGiven the parameters above, you would upload a file `test.mp4` using cURL like this:\n\n```shell\ncurl -s https://synqfm.s3.amazonaws.com/ \\\n -F AWSAccessKeyId=\"AKIAIP77Y7MMX3ITZMFA\" \\\n -F Content-Type=\"video/mp4\" \\\n -F Policy=\"eyJleHBpcmF0aW9uIiA6ICIyMDE2LTA0LTIyVDE5OjAyOjI2LjE3MloiLCAiY29uZGl0aW9ucyIgOiBbeyJidWNrZXQiIDogInN5bnFmbSJ9LCB7ImFjbCIgOiAicHVibGljLXJlYWQifSwgWyJzdGFydHMtd2l0aCIsICIka2V5IiwgInByb2plY3RzLzZlLzYzLzZlNjNiNzUyYTE4NTRkZGU4ODViNWNjNDcyZWRmNTY5L3VwbG9hZHMvdmlkZW9zLzJkLzgxLzJkODFjMzBjZTYyZjRkZmRiNTAxZGJjYTk2YzdhZTU2Lm1wNCJdLCBbInN0YXJ0cy13aXRoIiwgIiRDb250ZW50LVR5cGUiLCAidmlkZW8vbXA0Il0sIFsiY29udGVudC1sZW5ndGgtcmFuZ2UiLCAwLCAxMDk5NTExNjI3Nzc2XV19\" \\\n -F Signature=\"ysqDemlKXKr6hKzVFP0hCGgf/cs=\" \\\n -F acl=\"public-read\" \\\n -F key=\"projects/6e/63/6e63b752a1854dde885b5cc472edf569/uploads/videos/2d/81/2d81c30ce62f4dfdb501dbca96c7ae56.mp4\" \\\n -F file=\"@my_video_file.mp4\"\n```", "operationId"=>"upload", "x-api-path-slug"=>"videoupload-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"video_id", "description"=>"The ID of the video you are going to upload into"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video", "Upload"]}}, "/video/uploader"=>{"post"=>{"summary"=>"Return embeddable url to an uploader widget", "description"=>"Returns an embeddable url, that contains an uploader widget that allows you to easily upload any mp4. Great way to simplify the uploading process for end users.", "operationId"=>"uploader", "x-api-path-slug"=>"videouploader-post", "parameters"=>[{"in"=>"formData", "name"=>"api_key"}, {"in"=>"formData", "name"=>"timeout", "description"=>"How long the uploader widget works for"}, {"in"=>"formData", "name"=>"video_id", "description"=>"The ID of the video you are going to upload into"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video", "Uploader"]}}}}, "apis"=>{"name"=>"SYNQ Video", "x-slug"=>"synq-video", "description"=>"White glove ingest service for VOD and Cable operators. Say goodbye to infinite mail threads on metadata outputs, file transfer solutions and debugging. We take care of video ingestion with our central repository for VOD content. Assets are easily accessible for distributors through our API with the outputs you expect.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/synq-video-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Relative Data,Service API,Videos", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"synq-video/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"SYNQ Video", "x-api-slug"=>"synq-video", "description"=>"White glove ingest service for VOD and Cable operators. Say goodbye to infinite mail threads on metadata outputs, file transfer solutions and debugging. We take care of video ingestion with our central repository for VOD content. Assets are easily accessible for distributors through our API with the outputs you expect.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/synq-video-logo.png", "humanURL"=>"https://www.synq.fm", "baseURL"=>"https://api.synq.fm//v1", "tags"=>"Relative Data,Service API,Videos", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/synq-video/videouploader-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/synq-video/synq-video-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://www.synq.fm"}, {"type"=>"x-blog", "url"=>"https://blog.synq.fm/"}, {"type"=>"x-github", "url"=>"https://github.com/SYNQfm"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/synqfm"}, {"type"=>"x-website", "url"=>"http://synq.fm"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-data-lake-analytics{"azure-data-lake-analytics-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Data Lake Analytics", "x-complete"=>1, "info"=>{"title"=>"DataLakeAnalyticsJobManagementClient", "description"=>"creates-an-azure-data-lake-analytics-job-client-", "version"=>"1.0.0"}, "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/firewallRules/{firewallRuleName}"=>{"put"=>{"summary"=>"Firewall Rules Create Or Update", "description"=>"Creates or updates the specified firewall rule. During update, the firewall rule with the specified name will be replaced with this new firewall rule.", "operationId"=>"FirewallRules_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamefirewallrulesfirewallrulename-put", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account to add or replace the firewall rule"}, {"in"=>"path", "name"=>"firewallRuleName", "description"=>"The name of the firewall rule to create or update"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to create or update the firewall rule", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall Rule"]}, "patch"=>{"summary"=>"Firewall Rules Update", "description"=>"Updates the specified firewall rule.", "operationId"=>"FirewallRules_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamefirewallrulesfirewallrulename-patch", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account to which to update the firewall rule"}, {"in"=>"path", "name"=>"firewallRuleName", "description"=>"The name of the firewall rule to update"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to update the firewall rule", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall Rule"]}, "delete"=>{"summary"=>"Firewall Rules Delete", "description"=>"Deletes the specified firewall rule from the specified Data Lake Analytics account", "operationId"=>"FirewallRules_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamefirewallrulesfirewallrulename-delete", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account from which to delete the firewall rule"}, {"in"=>"path", "name"=>"firewallRuleName", "description"=>"The name of the firewall rule to delete"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall Rule"]}, "get"=>{"summary"=>"Firewall Rules Get", "description"=>"Gets the specified Data Lake Analytics firewall rule.", "operationId"=>"FirewallRules_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamefirewallrulesfirewallrulename-get", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account from which to get the firewall rule"}, {"in"=>"path", "name"=>"firewallRuleName", "description"=>"The name of the firewall rule to retrieve"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall Rule"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/firewallRules"=>{"get"=>{"summary"=>"Firewall Rules List By Account", "description"=>"Lists the Data Lake Analytics firewall rules within the specified Data Lake Analytics account.", "operationId"=>"FirewallRules_ListByAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamefirewallrules-get", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account from which to get the firewall rules"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall Rule Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/StorageAccounts/{storageAccountName}"=>{"get"=>{"summary"=>"Storage Accounts Get", "description"=>"Gets the specified Azure Storage account linked to the given Data Lake Analytics account.", "operationId"=>"StorageAccounts_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamestorageaccountsstorageaccountname-get", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account from which to retrieve Azure storage account details"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}, {"in"=>"path", "name"=>"storageAccountName", "description"=>"The name of the Azure Storage account for which to retrieve the details"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stage Account"]}, "delete"=>{"summary"=>"Storage Accounts Delete", "description"=>"Updates the specified Data Lake Analytics account to remove an Azure Storage account.", "operationId"=>"StorageAccounts_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamestorageaccountsstorageaccountname-delete", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account from which to remove the Azure Storage account"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}, {"in"=>"path", "name"=>"storageAccountName", "description"=>"The name of the Azure Storage account to remove"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stage Account"]}, "patch"=>{"summary"=>"Storage Accounts Update", "description"=>"Updates the Data Lake Analytics account to replace Azure Storage blob account details, such as the access key and/or suffix.", "operationId"=>"StorageAccounts_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamestorageaccountsstorageaccountname-patch", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account to modify storage accounts in"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters containing the access key and suffix to update the storage account with, if any", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}, {"in"=>"path", "name"=>"storageAccountName", "description"=>"The Azure Storage account to modify"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stage Account"]}, "put"=>{"summary"=>"Storage Accounts Add", "description"=>"Updates the specified Data Lake Analytics account to add an Azure Storage account.", "operationId"=>"StorageAccounts_Add", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamestorageaccountsstorageaccountname-put", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account to which to add the Azure Storage account"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters containing the access key and optional suffix for the Azure Storage Account", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}, {"in"=>"path", "name"=>"storageAccountName", "description"=>"The name of the Azure Storage account to add"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stage Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/StorageAccounts/{storageAccountName}/Containers/{containerName}"=>{"get"=>{"summary"=>"Storage Accounts Get Storage Container", "description"=>"Gets the specified Azure Storage container associated with the given Data Lake Analytics and Azure Storage accounts.", "operationId"=>"StorageAccounts_GetStorageContainer", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamestorageaccountsstorageaccountnamecontainerscontainername-get", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account for which to retrieve blob container"}, {"in"=>"path", "name"=>"containerName", "description"=>"The name of the Azure storage container to retrieve"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}, {"in"=>"path", "name"=>"storageAccountName", "description"=>"The name of the Azure storage account from which to retrieve the blob container"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/StorageAccounts/{storageAccountName}/Containers"=>{"get"=>{"summary"=>"Storage Accounts List Storage Containers", "description"=>"Lists the Azure Storage containers, if any, associated with the specified Data Lake Analytics and Azure Storage account combination. The response includes a link to the next page of results, if any.", "operationId"=>"StorageAccounts_ListStorageContainers", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamestorageaccountsstorageaccountnamecontainers-get", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account for which to list Azure Storage blob containers"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}, {"in"=>"path", "name"=>"storageAccountName", "description"=>"The name of the Azure storage account from which to list blob containers"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stage Account Stage Containers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/StorageAccounts/{storageAccountName}/Containers/{containerName}/listSasTokens"=>{"post"=>{"summary"=>"Storage Accounts List Sas Tokens", "description"=>"Gets the SAS token associated with the specified Data Lake Analytics and Azure Storage account and container combination.", "operationId"=>"StorageAccounts_ListSasTokens", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamestorageaccountsstorageaccountnamecontainerscontainernamelistsastokens-post", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account from which an Azure Storage accounts SAS token is being requested"}, {"in"=>"path", "name"=>"containerName", "description"=>"The name of the Azure storage container for which the SAS token is being requested"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}, {"in"=>"path", "name"=>"storageAccountName", "description"=>"The name of the Azure storage account for which the SAS token is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stage Account Satokens"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/DataLakeStoreAccounts/{dataLakeStoreAccountName}"=>{"get"=>{"summary"=>"Data Lake Store Accounts Get", "description"=>"Gets the specified Data Lake Store account details in the specified Data Lake Analytics account.", "operationId"=>"DataLakeStoreAccounts_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamedatalakestoreaccountsdatalakestoreaccountname-get", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account from which to retrieve the Data Lake Store account details"}, {"in"=>"path", "name"=>"dataLakeStoreAccountName", "description"=>"The name of the Data Lake Store account to retrieve"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data Lake Ste Account"]}, "delete"=>{"summary"=>"Data Lake Store Accounts Delete", "description"=>"Updates the Data Lake Analytics account specified to remove the specified Data Lake Store account.", "operationId"=>"DataLakeStoreAccounts_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamedatalakestoreaccountsdatalakestoreaccountname-delete", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account from which to remove the Data Lake Store account"}, {"in"=>"path", "name"=>"dataLakeStoreAccountName", "description"=>"The name of the Data Lake Store account to remove"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data Lake Ste Account"]}, "put"=>{"summary"=>"Data Lake Store Accounts Add", "description"=>"Updates the specified Data Lake Analytics account to include the additional Data Lake Store account.", "operationId"=>"DataLakeStoreAccounts_Add", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamedatalakestoreaccountsdatalakestoreaccountname-put", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account to which to add the Data Lake Store account"}, {"in"=>"path", "name"=>"dataLakeStoreAccountName", "description"=>"The name of the Data Lake Store account to add"}, {"in"=>"body", "name"=>"parameters", "description"=>"The details of the Data Lake Store account", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data Lake Ste Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/StorageAccounts/"=>{"get"=>{"summary"=>"Storage Accounts List By Account", "description"=>"Gets the first page of Azure Storage accounts, if any, linked to the specified Data Lake Analytics account. The response includes a link to the next page, if any.", "operationId"=>"StorageAccounts_ListByAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamestorageaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"The OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account for which to list Azure Storage accounts"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stage Account Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/DataLakeStoreAccounts/"=>{"get"=>{"summary"=>"Data Lake Store Accounts List By Account", "description"=>"Gets the first page of Data Lake Store accounts linked to the specified Data Lake Analytics account. The response includes a link to the next page, if any.", "operationId"=>"DataLakeStoreAccounts_ListByAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountnamedatalakestoreaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account for which to list Data Lake Store accounts"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data Lake Ste Account Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts"=>{"get"=>{"summary"=>"Account List By Resource Group", "description"=>"Gets the first page of Data Lake Analytics accounts, if any, within a specific resource group. This includes a link to the next page, if any.", "operationId"=>"Account_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account Resource Group"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.DataLakeAnalytics/accounts"=>{"get"=>{"summary"=>"Account List", "description"=>"Gets the first page of Data Lake Analytics accounts, if any, within the current subscription. This includes a link to the next page, if any.", "operationId"=>"Account_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-datalakeanalyticsaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}"=>{"get"=>{"summary"=>"Account Get", "description"=>"Gets details of the specified Data Lake Analytics account.", "operationId"=>"Account_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountname-get", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account to retrieve"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}, "delete"=>{"summary"=>"Account Delete", "description"=>"Begins the delete delete process for the Data Lake Analytics account object specified by the account name.", "operationId"=>"Account_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountname-delete", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account to delete"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}, "put"=>{"summary"=>"Account Create", "description"=>"Creates the specified Data Lake Analytics account. This supplies the user with computation services for Data Lake Analytics workloads", "operationId"=>"Account_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountname-put", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account to create"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the create Data Lake Analytics account operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}, "patch"=>{"summary"=>"Account Update", "description"=>"Updates the Data Lake Analytics account object specified by the accountName with the contents of the account object.", "operationId"=>"Account_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-datalakeanalyticsaccountsaccountname-patch", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the Data Lake Analytics account to update"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the update Data Lake Analytics account operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the Azure resource group that contains the Data Lake Analytics account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/catalog/usql/databases/{databaseName}/secrets/{secretName}"=>{"put"=>{"summary"=>"Catalog Create Secret", "description"=>"Creates the specified secret for use with external data sources in the specified database. This is deprecated and will be removed in the next release. Please use CreateCredential instead.", "operationId"=>"Catalog_CreateSecret", "x-api-path-slug"=>"catalogusqldatabasesdatabasenamesecretssecretname-put", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database in which to create the secret"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters required to create the secret (name and password)", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"secretName", "description"=>"The name of the secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Secret"]}, "patch"=>{"summary"=>"Catalog Update Secret", "description"=>"Modifies the specified secret for use with external data sources in the specified database. This is deprecated and will be removed in the next release. Please use UpdateCredential instead.", "operationId"=>"Catalog_UpdateSecret", "x-api-path-slug"=>"catalogusqldatabasesdatabasenamesecretssecretname-patch", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the secret"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters required to modify the secret (name and password)", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"secretName", "description"=>"The name of the secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Secret"]}, "get"=>{"summary"=>"Catalog Get Secret", "description"=>"Gets the specified secret in the specified database. This is deprecated and will be removed in the next release. Please use GetCredential instead.", "operationId"=>"Catalog_GetSecret", "x-api-path-slug"=>"catalogusqldatabasesdatabasenamesecretssecretname-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the secret"}, {"in"=>"path", "name"=>"secretName", "description"=>"The name of the secret to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Secret"]}, "delete"=>{"summary"=>"Catalog Delete Secret", "description"=>"Deletes the specified secret in the specified database. This is deprecated and will be removed in the next release. Please use DeleteCredential instead.", "operationId"=>"Catalog_DeleteSecret", "x-api-path-slug"=>"catalogusqldatabasesdatabasenamesecretssecretname-delete", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the secret"}, {"in"=>"path", "name"=>"secretName", "description"=>"The name of the secret to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Secret"]}}, "/catalog/usql/databases/{databaseName}/secrets"=>{"delete"=>{"summary"=>"Catalog Delete All Secrets", "description"=>"Deletes all secrets in the specified database. This is deprecated and will be removed in the next release. In the future, please only drop individual credentials using DeleteCredential", "operationId"=>"Catalog_DeleteAllSecrets", "x-api-path-slug"=>"catalogusqldatabasesdatabasenamesecrets-delete", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the secret"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog All Secrets"]}}, "/catalog/usql/databases/{databaseName}/credentials/{credentialName}"=>{"put"=>{"summary"=>"Catalog Create Credential", "description"=>"Creates the specified credential for use with external data sources in the specified database.", "operationId"=>"Catalog_CreateCredential", "x-api-path-slug"=>"catalogusqldatabasesdatabasenamecredentialscredentialname-put", "parameters"=>[{"in"=>"path", "name"=>"credentialName", "description"=>"The name of the credential"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database in which to create the credential"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters required to create the credential (name and password)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Credential"]}, "patch"=>{"summary"=>"Catalog Update Credential", "description"=>"Modifies the specified credential for use with external data sources in the specified database", "operationId"=>"Catalog_UpdateCredential", "x-api-path-slug"=>"catalogusqldatabasesdatabasenamecredentialscredentialname-patch", "parameters"=>[{"in"=>"path", "name"=>"credentialName", "description"=>"The name of the credential"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the credential"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters required to modify the credential (name and password)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Credential"]}, "get"=>{"summary"=>"Catalog Get Credential", "description"=>"Retrieves the specified credential from the Data Lake Analytics catalog.", "operationId"=>"Catalog_GetCredential", "x-api-path-slug"=>"catalogusqldatabasesdatabasenamecredentialscredentialname-get", "parameters"=>[{"in"=>"path", "name"=>"credentialName", "description"=>"The name of the credential"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the schema"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Credential"]}, "post"=>{"summary"=>"Catalog Delete Credential", "description"=>"Deletes the specified credential in the specified database", "operationId"=>"Catalog_DeleteCredential", "x-api-path-slug"=>"catalogusqldatabasesdatabasenamecredentialscredentialname-post", "parameters"=>[{"in"=>"query", "name"=>"cascade", "description"=>"Indicates if the delete should be a cascading delete (which deletes all resources dependent on the credential as well as the credential) or not"}, {"in"=>"path", "name"=>"credentialName", "description"=>"The name of the credential to delete"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the credential"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters to delete a credential if the current user is not the account owner", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Credential"]}}, "/catalog/usql/databases/{databaseName}/credentials"=>{"get"=>{"summary"=>"Catalog List Credentials", "description"=>"Retrieves the list of credentials from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListCredentials", "x-api-path-slug"=>"catalogusqldatabasesdatabasenamecredentials-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the schema"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Credentials"]}}, "/catalog/usql/databases/{databaseName}/externaldatasources/{externalDataSourceName}"=>{"get"=>{"summary"=>"Catalog Get External Data Source", "description"=>"Retrieves the specified external data source from the Data Lake Analytics catalog.", "operationId"=>"Catalog_GetExternalDataSource", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameexternaldatasourcesexternaldatasourcename-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the external data source"}, {"in"=>"path", "name"=>"externalDataSourceName", "description"=>"The name of the external data source"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog External Data Source"]}}, "/catalog/usql/databases/{databaseName}/externaldatasources"=>{"get"=>{"summary"=>"Catalog List External Data Sources", "description"=>"Retrieves the list of external data sources from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListExternalDataSources", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameexternaldatasources-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the external data sources"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog External Data Sources"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/procedures/{procedureName}"=>{"get"=>{"summary"=>"Catalog Get Procedure", "description"=>"Retrieves the specified procedure from the Data Lake Analytics catalog.", "operationId"=>"Catalog_GetProcedure", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanameproceduresprocedurename-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the procedure"}, {"in"=>"path", "name"=>"procedureName", "description"=>"The name of the procedure"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the procedure"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Procedure"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/procedures"=>{"get"=>{"summary"=>"Catalog List Procedures", "description"=>"Retrieves the list of procedures from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListProcedures", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanameprocedures-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the procedures"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the procedures"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Procedures"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}"=>{"get"=>{"summary"=>"Catalog Get Table", "description"=>"Retrieves the specified table from the Data Lake Analytics catalog.", "operationId"=>"Catalog_GetTable", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanametablestablename-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the table"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the table"}, {"in"=>"path", "name"=>"tableName", "description"=>"The name of the table"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Table"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables"=>{"get"=>{"summary"=>"Catalog List Tables", "description"=>"Retrieves the list of tables from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListTables", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanametables-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the tables"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the tables"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Tables"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/statistics"=>{"get"=>{"summary"=>"Catalog List Table Statistics By Database And Schema", "description"=>"Retrieves the list of all table statistics within the specified schema from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListTableStatisticsByDatabaseAndSchema", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanamestatistics-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the statistics"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the statistics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Table Statistic Database Schema"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tabletypes/{tableTypeName}"=>{"get"=>{"summary"=>"Catalog Get Table Type", "description"=>"Retrieves the specified table type from the Data Lake Analytics catalog.", "operationId"=>"Catalog_GetTableType", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanametabletypestabletypename-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the table type"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the table type"}, {"in"=>"path", "name"=>"tableTypeName", "description"=>"The name of the table type to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Table Type"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tabletypes"=>{"get"=>{"summary"=>"Catalog List Table Types", "description"=>"Retrieves the list of table types from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListTableTypes", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanametabletypes-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the table types"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the table types"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Table Types"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/packages/{packageName}"=>{"get"=>{"summary"=>"Catalog Get Package", "description"=>"Retrieves the specified package from the Data Lake Analytics catalog.", "operationId"=>"Catalog_GetPackage", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanamepackagespackagename-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the package"}, {"in"=>"path", "name"=>"packageName", "description"=>"The name of the package"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the package"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Package"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/packages"=>{"get"=>{"summary"=>"Catalog List Packages", "description"=>"Retrieves the list of packages from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListPackages", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanamepackages-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the packages"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the packages"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Packages"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/views/{viewName}"=>{"get"=>{"summary"=>"Catalog Get View", "description"=>"Retrieves the specified view from the Data Lake Analytics catalog.", "operationId"=>"Catalog_GetView", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanameviewsviewname-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the view"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the view"}, {"in"=>"path", "name"=>"viewName", "description"=>"The name of the view"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog View"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/views"=>{"get"=>{"summary"=>"Catalog List Views", "description"=>"Retrieves the list of views from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListViews", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanameviews-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the views"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the views"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Views"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/statistics/{statisticsName}"=>{"get"=>{"summary"=>"Catalog Get Table Statistic", "description"=>"Retrieves the specified table statistics from the Data Lake Analytics catalog.", "operationId"=>"Catalog_GetTableStatistic", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanametablestablenamestatisticsstatisticsname-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the statistics"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the statistics"}, {"in"=>"path", "name"=>"statisticsName", "description"=>"The name of the table statistics"}, {"in"=>"path", "name"=>"tableName", "description"=>"The name of the table containing the statistics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Table Statistic"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/statistics"=>{"get"=>{"summary"=>"Catalog List Table Statistics", "description"=>"Retrieves the list of table statistics from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListTableStatistics", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanametablestablenamestatistics-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the statistics"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the statistics"}, {"in"=>"path", "name"=>"tableName", "description"=>"The name of the table containing the statistics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Table Statistics"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions/{partitionName}"=>{"get"=>{"summary"=>"Catalog Get Table Partition", "description"=>"Retrieves the specified table partition from the Data Lake Analytics catalog.", "operationId"=>"Catalog_GetTablePartition", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanametablestablenamepartitionspartitionname-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the partition"}, {"in"=>"path", "name"=>"partitionName", "description"=>"The name of the table partition"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the partition"}, {"in"=>"path", "name"=>"tableName", "description"=>"The name of the table containing the partition"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Table Partition"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions"=>{"get"=>{"summary"=>"Catalog List Table Partitions", "description"=>"Retrieves the list of table partitions from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListTablePartitions", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanametablestablenamepartitions-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the partitions"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the partitions"}, {"in"=>"path", "name"=>"tableName", "description"=>"The name of the table containing the partitions"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Table Partitions"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/types"=>{"get"=>{"summary"=>"Catalog List Types", "description"=>"Retrieves the list of types within the specified database and schema from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListTypes", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanametypes-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the types"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the types"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Types"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tablevaluedfunctions/{tableValuedFunctionName}"=>{"get"=>{"summary"=>"Catalog Get Table Valued Function", "description"=>"Retrieves the specified table valued function from the Data Lake Analytics catalog.", "operationId"=>"Catalog_GetTableValuedFunction", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanametablevaluedfunctionstablevaluedfunctionname-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the table valued function"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the table valued function"}, {"in"=>"path", "name"=>"tableValuedFunctionName", "description"=>"The name of the tableValuedFunction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Table Valued Function"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tablevaluedfunctions"=>{"get"=>{"summary"=>"Catalog List Table Valued Functions", "description"=>"Retrieves the list of table valued functions from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListTableValuedFunctions", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemanametablevaluedfunctions-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the table valued functions"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema containing the table valued functions"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Table Valued Functions"]}}, "/catalog/usql/databases/{databaseName}/assemblies/{assemblyName}"=>{"get"=>{"summary"=>"Catalog Get Assembly", "description"=>"Retrieves the specified assembly from the Data Lake Analytics catalog.", "operationId"=>"Catalog_GetAssembly", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameassembliesassemblyname-get", "parameters"=>[{"in"=>"path", "name"=>"assemblyName", "description"=>"The name of the assembly"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the assembly"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Assembly"]}}, "/catalog/usql/databases/{databaseName}/assemblies"=>{"get"=>{"summary"=>"Catalog List Assemblies", "description"=>"Retrieves the list of assemblies from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListAssemblies", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameassemblies-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the assembly"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Assemblies"]}}, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}"=>{"get"=>{"summary"=>"Catalog Get Schema", "description"=>"Retrieves the specified schema from the Data Lake Analytics catalog.", "operationId"=>"Catalog_GetSchema", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemasschemaname-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the schema"}, {"in"=>"path", "name"=>"schemaName", "description"=>"The name of the schema"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Schema"]}}, "/catalog/usql/databases/{databaseName}/schemas"=>{"get"=>{"summary"=>"Catalog List Schemas", "description"=>"Retrieves the list of schemas from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListSchemas", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameschemas-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the schema"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Schemas"]}}, "/catalog/usql/databases/{databaseName}/statistics"=>{"get"=>{"summary"=>"Catalog List Table Statistics By Database", "description"=>"Retrieves the list of all statistics in a database from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListTableStatisticsByDatabase", "x-api-path-slug"=>"catalogusqldatabasesdatabasenamestatistics-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the table statistics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Table Statistic Database"]}}, "/catalog/usql/databases/{databaseName}/tables"=>{"get"=>{"summary"=>"Catalog List Tables By Database", "description"=>"Retrieves the list of all tables in a database from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListTablesByDatabase", "x-api-path-slug"=>"catalogusqldatabasesdatabasenametables-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the tables"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Table Database"]}}, "/catalog/usql/databases/{databaseName}/tablevaluedfunctions"=>{"get"=>{"summary"=>"Catalog List Table Valued Functions By Database", "description"=>"Retrieves the list of all table valued functions in a database from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListTableValuedFunctionsByDatabase", "x-api-path-slug"=>"catalogusqldatabasesdatabasenametablevaluedfunctions-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the table valued functions"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Table Valued Function Database"]}}, "/catalog/usql/databases/{databaseName}/views"=>{"get"=>{"summary"=>"Catalog List Views By Database", "description"=>"Retrieves the list of all views in a database from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListViewsByDatabase", "x-api-path-slug"=>"catalogusqldatabasesdatabasenameviews-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}, {"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database containing the views"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog View Database"]}}, "/catalog/usql/databases/{databaseName}"=>{"get"=>{"summary"=>"Catalog Get Database", "description"=>"Retrieves the specified database from the Data Lake Analytics catalog.", "operationId"=>"Catalog_GetDatabase", "x-api-path-slug"=>"catalogusqldatabasesdatabasename-get", "parameters"=>[{"in"=>"path", "name"=>"databaseName", "description"=>"The name of the database"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Database"]}}, "/catalog/usql/databases"=>{"get"=>{"summary"=>"Catalog List Databases", "description"=>"Retrieves the list of databases from the Data Lake Analytics catalog.", "operationId"=>"Catalog_ListDatabases", "x-api-path-slug"=>"catalogusqldatabases-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog Databases"]}}, "/Jobs/{jobIdentity}/GetStatistics"=>{"get"=>{"summary"=>"Job Get Statistics", "description"=>"Gets statistics of the specified job.", "operationId"=>"Job_GetStatistics", "x-api-path-slug"=>"jobsjobidentitygetstatistics-get", "parameters"=>[{"in"=>"path", "name"=>"jobIdentity", "description"=>"Job Information ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Statistics"]}}, "/Jobs/{jobIdentity}/GetDebugDataPath"=>{"get"=>{"summary"=>"Job Get Debug Data Path", "description"=>"Gets the job debug data information specified by the job ID.", "operationId"=>"Job_GetDebugDataPath", "x-api-path-slug"=>"jobsjobidentitygetdebugdatapath-get", "parameters"=>[{"in"=>"path", "name"=>"jobIdentity", "description"=>"JobInfo ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Debug Data Path"]}}, "/BuildJob"=>{"post"=>{"summary"=>"Job Build", "description"=>"Builds (compiles) the specified job in the specified Data Lake Analytics account for job correctness and validation.", "operationId"=>"Job_Build", "x-api-path-slug"=>"buildjob-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The parameters to build a job", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Build"]}}, "/Jobs/{jobIdentity}/CancelJob"=>{"post"=>{"summary"=>"Job Cancel", "description"=>"Cancels the running job specified by the job ID.", "operationId"=>"Job_Cancel", "x-api-path-slug"=>"jobsjobidentitycanceljob-post", "parameters"=>[{"in"=>"path", "name"=>"jobIdentity", "description"=>"JobInfo ID to cancel"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Cancel"]}}, "/Jobs/{jobIdentity}"=>{"get"=>{"summary"=>"Job Get", "description"=>"Gets the job information for the specified job ID.", "operationId"=>"Job_Get", "x-api-path-slug"=>"jobsjobidentity-get", "parameters"=>[{"in"=>"path", "name"=>"jobIdentity", "description"=>"JobInfo ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}, "put"=>{"summary"=>"Job Create", "description"=>"Submits a job to the specified Data Lake Analytics account.", "operationId"=>"Job_Create", "x-api-path-slug"=>"jobsjobidentity-put", "parameters"=>[{"in"=>"path", "name"=>"jobIdentity", "description"=>"The job ID (a GUID) for the job being submitted"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters to submit a job", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/Jobs"=>{"get"=>{"summary"=>"Job List", "description"=>"Lists the jobs, if any, associated with the specified Data Lake Analytics account. The response includes a link to the next page of results, if any.", "operationId"=>"Job_List", "x-api-path-slug"=>"jobs-get", "parameters"=>[{"in"=>"query", "name"=>"$count", "description"=>"The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e"}, {"in"=>"query", "name"=>"$filter", "description"=>"OData filter"}, {"in"=>"query", "name"=>"$orderby", "description"=>"OrderBy clause"}, {"in"=>"query", "name"=>"$select", "description"=>"OData Select statement"}, {"in"=>"query", "name"=>"$skip", "description"=>"The number of items to skip over before returning elements"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of items to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}}}, "apis"=>{"name"=>"Azure Data Lake Analytics", "x-slug"=>"azure-data-lake-analytics", "description"=>"The Data Lake analytics service is a new distributed analytics service built on Apache YARN that dynamically scales so you can focus on your business goals, not on distributed infrastructure. Instead of deploying, configuring and tuning hardware, you write queries to transform your data and extract valuable insights. The analytics service can handle jobs of any scale instantly by simply setting the dial for how much power you need. You only pay for your job when it is running making it cost-effective. The analytics service supports Azure Active Directory letting you simply manage access and roles, integrated with your on-premises identity system. It also includes U-SQL, a language that unifies the benefits of SQL with the expressive power of user code. U-SQL’s scalable distributed runtime enables you to efficiently analyze data in the store and across SQL Servers in Azure, Azure SQL Database and Azure SQL Data Warehouse.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/data-lake-analytics-05.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Analysis,API Provider,API Service Provider,Data,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-data-lake-analytics/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Data Lake Analytics API", "x-api-slug"=>"azure-data-lake-analytics-api", "description"=>"The Data Lake analytics service is a new distributed analytics service built on Apache YARN that dynamically scales so you can focus on your business goals, not on distributed infrastructure. Instead of deploying, configuring and tuning hardware, you write queries to transform your data and extract valuable insights. The analytics service can handle jobs of any scale instantly by simply setting the dial for how much power you need. You only pay for your job when it is running making it cost-effective. The analytics service supports Azure Active Directory letting you simply manage access and roles, integrated with your on-premises identity system. It also includes U-SQL, a language that unifies the benefits of SQL with the expressive power of user code. U-SQL’s scalable distributed runtime enables you to efficiently analyze data in the store and across SQL Servers in Azure, Azure SQL Database and Azure SQL Data Warehouse.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/data-lake-analytics-05.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/data-lake-analytics/", "baseURL"=>":////", "tags"=>"Analysis,API Provider,API Service Provider,Data,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/azure-data-lake-analytics/azure-data-lake-analytics-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/data-lake-analytics/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/data-lake-analytics/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/data-lake-analytics/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/data-lake-analytics/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
charity-navigator{"charity-navigator-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Charity Navigator", "x-complete"=>1, "info"=>{"title"=>"CharityNavigatorDataAPI", "description"=>"the-charity-navigator-data-api-provides-access-to-charity-navigatorsratings-research-content-and-charitable-organization-profiles-", "version"=>"1.0.0"}, "host"=>"api.data.charitynavigator.org", "basePath"=>"/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/Organizations"=>{"get"=>{"summary"=>"Get Organizations", "description"=>"Retrieve a list of the organizations available in the Charity Navigator Data\nStore. Allows paged retrieval, simple and advanced searching.", "operationId"=>"searchOrganizations", "x-api-path-slug"=>"organizations-get", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"3Scale App ID: unique identifier for an application registered in theCharity Navigator developer portal"}, {"in"=>"query", "name"=>"app_key", "description"=>"3Scale App Key: a secret key to authenticate the assigned App ID"}, {"in"=>"query", "name"=>"categoryID", "description"=>"ID of a Category"}, {"in"=>"query", "name"=>"causeID", "description"=>"ID of a Cause"}, {"in"=>"query", "name"=>"cfcCharities", "description"=>"Specifies whether to include or exclude organizations that are included inthe Combined Federal Campaign, the largest workplace giving campaign in USA"}, {"in"=>"query", "name"=>"city", "description"=>"Filters search results to include only organizations in cities whose namesmatch the specified string"}, {"in"=>"query", "name"=>"donorPrivacy", "description"=>"Specifies whether to include or exclude organizations that have a donorprivacy policy"}, {"in"=>"query", "name"=>"fundraisingOrgs", "description"=>"Specifies whether to include or exclude organizations flagged by CharityNavigator as fundraising organizations"}, {"in"=>"query", "name"=>"maxRating", "description"=>"Filters search results to include only organizations with a rating less thanor equal to the specified value"}, {"in"=>"query", "name"=>"minRating", "description"=>"Filters search results to include only organizations with a rating greaterthan or equal to the specified value"}, {"in"=>"query", "name"=>"noGovSupport", "description"=>"Specifies whether to include or exclude organizations that do not receivegovernment support"}, {"in"=>"query", "name"=>"pageNum", "description"=>"Page number to return, in case the number of available objects in the resultset is greater than the specified or default `pageSize`"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of organizations to return in a single response message"}, {"in"=>"query", "name"=>"rated", "description"=>"Specifies whether to include only rated charities or unrated charities"}, {"in"=>"query", "name"=>"scopeOfWork", "description"=>"Filters search results to include only organizations with a given scope ofwork"}, {"in"=>"query", "name"=>"search", "description"=>"A simple search string that narrows the results to organizations matchingthe specified search terms"}, {"in"=>"query", "name"=>"searchType", "description"=>"Used in combination with the `search` parameter, specifies the type ofsearch to be performed"}, {"in"=>"query", "name"=>"sizeRange", "description"=>"Filters search results to include only organizations within a given sizebracket, as measured in annual Total Expenses"}, {"in"=>"query", "name"=>"sort", "description"=>"Specifies how results should be sorted"}, {"in"=>"query", "name"=>"state", "description"=>"If set to a valid 2-letter state code (not case-sensitive), filters searchresults to include only organizations in the specified state"}, {"in"=>"query", "name"=>"zip", "description"=>"Filters search results to include only organizations in the specified zipcode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}, "/Organizations/{ein}"=>{"get"=>{"summary"=>"Get Organizations Ein", "description"=>"Retrieve full detail of a single Organization. This is a composite set of\ninformation describing an organization that may engage in charitable work.\nNormally the Organization data structure includes a single legal entity, though\nlegal entity information may be excluded in exceptional cases.", "operationId"=>"getOrganization", "x-api-path-slug"=>"organizationsein-get", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"3Scale App ID: unique identifier for an application registered in theCharity Navigator developer portal"}, {"in"=>"query", "name"=>"app_key", "description"=>"3Scale App Key: a secret key to authenticate the assigned App ID"}, {"in"=>"path", "name"=>"ein"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Ein"]}}, "/Organizations/{ein}/Ratings"=>{"get"=>{"summary"=>"Get Organizations Ein Ratings", "description"=>"Retrieve all Charity Navigator ratings for a single organization. \n![Content\nSubscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png\n\"Included with the paid Content Subscription.\")", "operationId"=>"getRatings", "x-api-path-slug"=>"organizationseinratings-get", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"3Scale App ID: unique identifier for an application registered in theCharity Navigator developer portal"}, {"in"=>"query", "name"=>"app_key", "description"=>"3Scale App Key: a secret key to authenticate the assigned App ID"}, {"in"=>"path", "name"=>"ein"}, {"in"=>"query", "name"=>"pageNum", "description"=>"Page number to return, in case the number of available objects in the resultset is greater than the specified or default `pageSize`"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of objects to return in a single response message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Ein", "Ratings"]}}, "/Organizations/{ein}/Ratings/{RatingID}"=>{"get"=>{"summary"=>"Get Organizations Ein Ratings Rating", "description"=>"Retrieve a single Rating object for an Organization. Each rating is listed\nonce, under its primary `referenceOrganization`. Note that the rating may apply\nto other organizations, and this is represented by `includedOrganizations`,\nwhich is a collection of hyperlinks to all of the organizations to which the\nrating applies.\nThe rating is a point-in-time assessment provided by Charity Navigator, along\nwith related metrics and ratios taken from financial statements for a fiscal\nyear, on which the rating is based. ![Content\nSubscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png\n\"Included with the paid Content Subscription.\")", "operationId"=>"getRating", "x-api-path-slug"=>"organizationseinratingsratingid-get", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"3Scale App ID: unique identifier for an application registered in theCharity Navigator developer portal"}, {"in"=>"query", "name"=>"app_key", "description"=>"3Scale App Key: a secret key to authenticate the assigned App ID"}, {"in"=>"path", "name"=>"ein"}, {"in"=>"path", "name"=>"RatingID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Ein", "Ratings", "Rating"]}}, "/Organizations/{ein}/Advisories"=>{"get"=>{"summary"=>"Get Organizations Ein Advisories", "description"=>"Retrieve the full set of Charity Navigator advisories for a specified\norganization. An advisory is a cautionary communication from Charity Navigator,\nadvising of unusual events or behavior related to a known organization.", "operationId"=>"getAdvisories", "x-api-path-slug"=>"organizationseinadvisories-get", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"3Scale App ID: unique identifier for an application registered in theCharity Navigator developer portal"}, {"in"=>"query", "name"=>"app_key", "description"=>"3Scale App Key: a secret key to authenticate the assigned App ID"}, {"in"=>"path", "name"=>"ein"}, {"in"=>"query", "name"=>"pageNum", "description"=>"Page number to return, in case the number of available objects in the resultset is greater than the specified or default `pageSize`"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of objects to return in a single response message"}, {"in"=>"query", "name"=>"status", "description"=>"An optional filter parameter to limit the Advisories returned, based onstatus:| Status Value | Advisories Included || ------------ | --------------------------------------------------- || ALL | All advisories included, regardless of status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Ein", "Advisories"]}}, "/Organizations/{ein}/Advisories/{AdvisoryID}"=>{"get"=>{"summary"=>"Get Organizations Ein Advisories Advisory", "description"=>"Retrieve full details of a single Advisory, under a given organization. An\nadvisory is a cautionary communication from Charity Navigator, advising of\nunusual events or behavior related to a known organization.", "operationId"=>"getAdvisory", "x-api-path-slug"=>"organizationseinadvisoriesadvisoryid-get", "parameters"=>[{"in"=>"path", "name"=>"AdvisoryID"}, {"in"=>"query", "name"=>"app_id", "description"=>"3Scale App ID: unique identifier for an application registered in theCharity Navigator developer portal"}, {"in"=>"query", "name"=>"app_key", "description"=>"3Scale App Key: a secret key to authenticate the assigned App ID"}, {"in"=>"path", "name"=>"ein"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Ein", "Advisories", "Advisory"]}}, "/Lists"=>{"get"=>{"summary"=>"Get Lists", "description"=>"Retrieve a set of Lists defined in Charity Navigator. Each entry in this\ncollection is a curated or generated list of organizations, published by Charity\nNavigator. ![Content\nSubscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png\n\"Included with the paid Content Subscription.\")", "operationId"=>"getLists", "x-api-path-slug"=>"lists-get", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"3Scale App ID: unique identifier for an application registered in theCharity Navigator developer portal"}, {"in"=>"query", "name"=>"app_key", "description"=>"3Scale App Key: a secret key to authenticate the assigned App ID"}, {"in"=>"query", "name"=>"pageNum", "description"=>"Page number to return, in case the number of available objects in the resultset is greater than the specified or default `pageSize`"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of objects to return in a single response message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists"]}}, "/Lists/{ListID}"=>{"get"=>{"summary"=>"Get Lists List", "description"=>"Retrieve a curated or generated list of organizations, published by Charity\nNavigator. ![Content\nSubscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png\n\"Included with the paid Content Subscription.\")", "operationId"=>"getList", "x-api-path-slug"=>"listslistid-get", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"3Scale App ID: unique identifier for an application registered in theCharity Navigator developer portal"}, {"in"=>"query", "name"=>"app_key", "description"=>"3Scale App Key: a secret key to authenticate the assigned App ID"}, {"in"=>"path", "name"=>"ListID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List"]}}, "/Categories"=>{"get"=>{"summary"=>"Get Categories", "description"=>"Returns metadata for Charity Navigator's classification hierarchy for\ncharitable Organizations. Category is the top-level classifier, and each\ncategory may contain a number of Causes. ![Content\nSubscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png\n\"Included with the paid Content Subscription.\")", "operationId"=>"getCategories", "x-api-path-slug"=>"categories-get", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"3Scale App ID: unique identifier for an application registered in theCharity Navigator developer portal"}, {"in"=>"query", "name"=>"app_key", "description"=>"3Scale App Key: a secret key to authenticate the assigned App ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories"]}}, "/Advisory"=>{"get"=>{"summary"=>"Get Advisory", "description"=>"Retrieve the full set of Charity Navigator advisories for a specified\norganization. An advisory is a cautionary communication from Charity Navigator,\nadvising of unusual events or behavior related to a known organization.", "operationId"=>"getAllActiveAdvisories", "x-api-path-slug"=>"advisory-get", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"3Scale App ID: unique identifier for an application registered in theCharity Navigator developer portal"}, {"in"=>"query", "name"=>"app_key", "description"=>"3Scale App Key: a secret key to authenticate the assigned App ID"}, {"in"=>"query", "name"=>"pageNum", "description"=>"Page number to return, in case the number of available objects in the resultset is greater than the specified or default `pageSize`"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of organizations to return in a single response message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advisory"]}}}}, "apis"=>{"name"=>"Charity Navigator", "x-slug"=>"charity-navigator", "description"=>"Charity Navigator is an American independent charity watchdog organization that evaluates charitable organizations in the United States.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28893-www-charitynavigator-org.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"49197", "tags"=>"Charities,General Data,Giving", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"charity-navigator/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Charity Navigator", "x-api-slug"=>"charity-navigator", "description"=>"Charity Navigator is an American independent charity watchdog organization that evaluates charitable organizations in the United States.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28893-www-charitynavigator-org.jpg", "humanURL"=>"http://www.charitynavigator.org", "baseURL"=>"https://api.data.charitynavigator.org//v2", "tags"=>"Charities,General Data,Giving", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/charity-navigator/advisory-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/charity-navigator/charity-navigator-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog-rss", "url"=>"http://blog.charitynavigator.org/feeds/posts/default?alt=rss"}, {"type"=>"x-developer", "url"=>"https://charity.3scale.net/"}, {"type"=>"x-documentation", "url"=>"https://charity.3scale.net/docs/data-api/reference"}, {"type"=>"x-github", "url"=>"https://github.com/CharityNavigator"}, {"type"=>"x-support", "url"=>"https://charity.3scale.net/support"}, {"type"=>"x-website", "url"=>"http://www.charitynavigator.org"}, {"type"=>"x-blog", "url"=>"http://blog.charitynavigator.org/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/charity-navigator"}, {"type"=>"x-email", "url"=>"helpandsupport@charitynavigator.org"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/CharityNav"}, {"type"=>"x-website", "url"=>"https://www.charitynavigator.org"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
learnifier{"learnifier-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Learnifier", "x-complete"=>1, "info"=>{"title"=>"Learnifier", "version"=>"1.1.0"}, "host"=>"learnifier.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/coursedesigns"=>{"get"=>{"summary"=>"Lists all global course design templates", "description"=>"Lists all global course design templates. Only api callers that have full access can call this method.", "operationId"=>"coursedesigns.get", "x-api-path-slug"=>"coursedesigns-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses"]}}, "/extorgunit"=>{"get"=>{"summary"=>"Get Organization Unit with External Id", "description"=>"Returns information about the organization unit with the specified external id.", "operationId"=>"extorgunit.get", "x-api-path-slug"=>"extorgunit-get", "parameters"=>[{"in"=>"query", "name"=>"extid", "description"=>"The external id of the organization unit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}, "/extparticipation"=>{"get"=>{"summary"=>"Gets a participation by external id", "description"=>"Gets a participation by external id.", "operationId"=>"extparticipation.get", "x-api-path-slug"=>"extparticipation-get", "parameters"=>[{"in"=>"query", "name"=>"extid", "description"=>"The external id of the participation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Participation"]}}, "/extproject"=>{"get"=>{"summary"=>"Gets Organization Unit by external id", "description"=>"Gets an Organization Unit by external id", "operationId"=>"extproject.get", "x-api-path-slug"=>"extproject-get", "parameters"=>[{"in"=>"query", "name"=>"extid", "description"=>"The external id of the organization unit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/extuser"=>{"get"=>{"summary"=>"Gets a user by external id", "description"=>"Gets a user by external id.", "operationId"=>"extuser.get", "x-api-path-slug"=>"extuser-get", "parameters"=>[{"in"=>"query", "name"=>"extid", "description"=>"The external id of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/globalusergroups"=>{"get"=>{"summary"=>"List Global User Groups.", "description"=>"Returns a list of Global User Groups. Global User Groups are set up for the realm, and will generate groups that can be used on the client level.", "operationId"=>"globalusergroups.get", "x-api-path-slug"=>"globalusergroups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Groups"]}}, "/globalusergroups/{groupid}/members"=>{"get"=>{"summary"=>"List of all users in group.", "description"=>"Returns a list of all members in User Groups that are based on the Global Group with this groupid.", "operationId"=>"globalusergroups.groupid.members.get", "x-api-path-slug"=>"globalusergroupsgroupidmembers-get", "parameters"=>[{"in"=>"path", "name"=>"groupid", "description"=>"ID of group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Groups"]}}, "/orgunits"=>{"get"=>{"summary"=>"Organization Units", "description"=>"The orgunits endpoint returns information about the available organization units (orgunits).\nThe response includes the display name, internal and external id and client number.", "operationId"=>"orgunits.get", "x-api-path-slug"=>"orgunits-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}, "post"=>{"summary"=>"Adds an Organization Unit", "description"=>"Adds an Organization Unit", "operationId"=>"orgunits.post", "x-api-path-slug"=>"orgunits-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}, "/orgunits/{orgid}"=>{"get"=>{"summary"=>"Get Organization Unit", "description"=>"Returns information about the specified organization unit.\nThe response includes the display name, internal and external id and client number.", "operationId"=>"orgunits.orgid.get", "x-api-path-slug"=>"orgunitsorgid-get", "parameters"=>[{"in"=>"path", "name"=>"orgid", "description"=>"Id of the organization unit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}, "patch"=>{"summary"=>"Updates an Organization Unit", "description"=>"Adds an Organization Unit", "operationId"=>"orgunits.orgid.patch", "x-api-path-slug"=>"orgunitsorgid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"orgid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}, "/orgunits/{orgid}/projects"=>{"get"=>{"summary"=>"Organization Unit Projects", "description"=>"Returns the available projects for the organization unit", "operationId"=>"orgunits.orgid.projects.get", "x-api-path-slug"=>"orgunitsorgidprojects-get", "parameters"=>[{"in"=>"path", "name"=>"orgid", "description"=>"Id of the organization unit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Projects"]}, "post"=>{"summary"=>"Create project", "description"=>"Creates a new project", "operationId"=>"orgunits.orgid.projects.post", "x-api-path-slug"=>"orgunitsorgidprojects-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"orgid", "description"=>"Id of the organization unit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Projects"]}}, "/orgunits/{orgid}/projects/{projectid}"=>{"delete"=>{"summary"=>"Deletes the project", "description"=>"Deletes the project. The project can only be deleted if the project do not contain any participants.", "operationId"=>"orgunits.orgid.projects.projectid.delete", "x-api-path-slug"=>"orgunitsorgidprojectsprojectid-delete", "parameters"=>[{"in"=>"path", "name"=>"orgid", "description"=>"Id of the organization unit"}, {"in"=>"path", "name"=>"projectid", "description"=>"Id of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Projects", "Projectid"]}, "get"=>{"summary"=>"Project information", "description"=>"Returns project information", "operationId"=>"orgunits.orgid.projects.projectid.get", "x-api-path-slug"=>"orgunitsorgidprojectsprojectid-get", "parameters"=>[{"in"=>"path", "name"=>"orgid", "description"=>"Id of the organization unit"}, {"in"=>"path", "name"=>"projectid", "description"=>"Id of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Projects", "Projectid"]}, "patch"=>{"summary"=>"Update project information", "description"=>"Updates information about a project. Values are only updated if the fields are specified in the input", "operationId"=>"orgunits.orgid.projects.projectid.patch", "x-api-path-slug"=>"orgunitsorgidprojectsprojectid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"orgid", "description"=>"Id of the organization unit"}, {"in"=>"path", "name"=>"projectid", "description"=>"Id of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Projects", "Projectid"]}}, "/orgunits/{orgid}/projects/{projectid}/participants"=>{"get"=>{"summary"=>"Project participants", "description"=>"Returns project participants", "operationId"=>"orgunits.orgid.projects.projectid.participants.get", "x-api-path-slug"=>"orgunitsorgidprojectsprojectidparticipants-get", "parameters"=>[{"in"=>"path", "name"=>"orgid", "description"=>"Id of the organization unit"}, {"in"=>"path", "name"=>"projectid", "description"=>"Id of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Projects", "Projectid", "Participants"]}, "post"=>{"summary"=>"Add participant", "description"=>"Add a user to the project. Participant information is created for the user. In the body object, only one of either email or userid must be specified. The participant needs to be activated before it the user can access it.", "operationId"=>"orgunits.orgid.projects.projectid.participants.post", "x-api-path-slug"=>"orgunitsorgidprojectsprojectidparticipants-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"orgid", "description"=>"Id of the organization unit"}, {"in"=>"path", "name"=>"projectid", "description"=>"Id of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Projects", "Projectid", "Participants"]}}, "/orgunits/{orgid}/projects/{projectid}/participants/${participantId}"=>{"delete"=>{"summary"=>"Deletes a participant", "description"=>"Deletes a participant. The user itself will still remain but any state related to the project will be deleted. \nIt might not be possible due to constraints from the products in the project to delete the participant. However\nthis can only be determined at the time of the delete. If a delete fails the participant will have their inError\nflag set.", "operationId"=>"orgunits.orgid.projects.projectid.participants._participantId.delete", "x-api-path-slug"=>"orgunitsorgidprojectsprojectidparticipantsparticipantid-delete", "parameters"=>[{"in"=>"path", "name"=>"orgid", "description"=>"Id of the organization unit"}, {"in"=>"path", "name"=>"participantId", "description"=>"Participant id"}, {"in"=>"path", "name"=>"projectid", "description"=>"Id of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Projects", "Projectid", "Participants", "$participantId"]}}, "/orgunits/{orgid}/projects/{projectid}/participants/${participantId}/activate"=>{"post"=>{"summary"=>"Activate participant", "description"=>"Activates a participant so that it can be used", "operationId"=>"orgunits.orgid.projects.projectid.participants._participantId.activate.post", "x-api-path-slug"=>"orgunitsorgidprojectsprojectidparticipantsparticipantidactivate-post", "parameters"=>[{"in"=>"path", "name"=>"orgid", "description"=>"Id of the organization unit"}, {"in"=>"path", "name"=>"participantId", "description"=>"Id of the participant"}, {"in"=>"path", "name"=>"projectid", "description"=>"Id of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Projects", "Projectid", "Participants", "$participantId", "Activate"]}}, "/orgunits/{orgid}/projects/{projectid}/participants/${participantId}/loginlink"=>{"post"=>{"summary"=>"Participant login link", "description"=>"Returns a single sign on link for the participant. The link is only usable once and should be used directly. The link expires after a few minutes.\n\nThis operation requires the *login link* permission.", "operationId"=>"orgunits.orgid.projects.projectid.participants._participantId.loginlink.post", "x-api-path-slug"=>"orgunitsorgidprojectsprojectidparticipantsparticipantidloginlink-post", "parameters"=>[{"in"=>"path", "name"=>"orgid", "description"=>"Id of the organization unit"}, {"in"=>"path", "name"=>"participantId", "description"=>"Id of the participant"}, {"in"=>"path", "name"=>"projectid", "description"=>"Id of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Projects", "Projectid", "Participants", "$participantId", "Loginlink"]}}, "/orgunits/{orgid}/projects/{projectid}/teammembers"=>{"get"=>{"summary"=>"Project team members", "description"=>"Returns the project team members. A team member is a ....", "operationId"=>"orgunits.orgid.projects.projectid.teammembers.get", "x-api-path-slug"=>"orgunitsorgidprojectsprojectidteammembers-get", "parameters"=>[{"in"=>"path", "name"=>"orgid", "description"=>"Id of the organization unit"}, {"in"=>"path", "name"=>"projectid", "description"=>"Id of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Projects", "Projectid", "Team", "Members"]}}, "/orgunits/{orgid}/usergroups"=>{"get"=>{"summary"=>"List User Groups.", "description"=>"Returns a list of User Groups for the org unit.", "operationId"=>"orgunits.orgid.usergroups.get", "x-api-path-slug"=>"orgunitsorgidusergroups-get", "parameters"=>[{"in"=>"path", "name"=>"orgid", "description"=>"ID of organization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Users", "Groups"]}, "post"=>{"summary"=>"Create a User Group.", "description"=>"Create a User Group.", "operationId"=>"orgunits.orgid.usergroups.post", "x-api-path-slug"=>"orgunitsorgidusergroups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"orgid", "description"=>"ID of organization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Users", "Groups"]}}, "/orgunits/{orgid}/usergroups/{groupid}"=>{"get"=>{"summary"=>"Get user group", "description"=>"Returns single User Group.", "operationId"=>"orgunits.orgid.usergroups.groupid.get", "x-api-path-slug"=>"orgunitsorgidusergroupsgroupid-get", "parameters"=>[{"in"=>"path", "name"=>"groupid", "description"=>"ID of group"}, {"in"=>"path", "name"=>"orgid", "description"=>"ID of organization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Users", "Groups", "Groupid"]}}, "/orgunits/{orgid}/usergroups/{groupid}/members"=>{"get"=>{"summary"=>"List of all users in group.", "description"=>"Returns a list of all members in User Groups that are based on the Global Group with this groupid.", "operationId"=>"orgunits.orgid.usergroups.groupid.members.get", "x-api-path-slug"=>"orgunitsorgidusergroupsgroupidmembers-get", "parameters"=>[{"in"=>"path", "name"=>"groupid", "description"=>"ID of group"}, {"in"=>"path", "name"=>"orgid", "description"=>"ID of organization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Uses", "Groups", "Members"]}, "post"=>{"summary"=>"Add user group member.", "description"=>"Adds a user to user group.", "operationId"=>"orgunits.orgid.usergroups.groupid.members.post", "x-api-path-slug"=>"orgunitsorgidusergroupsgroupidmembers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"groupid", "description"=>"ID of group"}, {"in"=>"path", "name"=>"orgid", "description"=>"ID of organization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Uses", "Groups", "Members"]}}, "/orgunits/{orgid}/usergroups/{groupid}/members/{uuid}"=>{"delete"=>{"summary"=>"Remove user group member.", "description"=>"Removes a user from a user group.", "operationId"=>"orgunits.orgid.usergroups.groupid.members.uuid.delete", "x-api-path-slug"=>"orgunitsorgidusergroupsgroupidmembersuuid-delete", "parameters"=>[{"in"=>"path", "name"=>"groupid", "description"=>"ID of group"}, {"in"=>"path", "name"=>"orgid", "description"=>"ID of organization"}, {"in"=>"path", "name"=>"uuid", "description"=>"UUID of user to remove from group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Uses", "Groups", "Members"]}}, "/users"=>{"get"=>{"summary"=>"Lists all users", "description"=>"Lists all users. Only api callers that have full access can call this method.", "operationId"=>"users.get", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"The maximum number of users to return"}, {"in"=>"query", "name"=>"offset", "description"=>"The offset to start listing users from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "post"=>{"summary"=>"Adds a user", "description"=>"Adds a user. No two users can have the same email address. Email is saved WITH case but compared regardless of case. Email can be changed for a user assuming it doesn't cause a conflict.", "operationId"=>"users.post", "x-api-path-slug"=>"users-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/{userid}"=>{"get"=>{"summary"=>"User information", "description"=>"Returns information about a user", "operationId"=>"users.userid.get", "x-api-path-slug"=>"usersuserid-get", "parameters"=>[{"in"=>"path", "name"=>"userid", "description"=>"A user id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "patch"=>{"summary"=>"Updates user information", "description"=>"Updates a user. All values that have a key defined in the input will be set. So if a value should not be updated omit it totally from the input, otherwise it will be unset.", "operationId"=>"users.userid.patch", "x-api-path-slug"=>"usersuserid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userid", "description"=>"The user id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/{userid}/pic?key={APIKEY}"=>{"get"=>{"summary"=>"User profile picture", "description"=>"Returns a thumbnail picture of the user. This can either be a selected picture or an auto generated image. This method doesn't require a full sign in. The api key is sufficient.\nThe image is square and is likely, but not necessary, to be in 128x128 PNG format. However the format will always be either PNG, JPEG or GIF.", "operationId"=>"users.userid.pic_key_APIKEY.get", "x-api-path-slug"=>"usersuseridpickeyapikey-get", "parameters"=>[{"in"=>"path", "name"=>"APIKEY"}, {"in"=>"path", "name"=>"userid", "description"=>"The user id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/{userid}/projectParticipations"=>{"get"=>{"summary"=>"Returns information about the projects the user is a participant in.", "description"=>"Returns information about the projects the user is a participant in. Only the projects that the current token have access to will be listed.", "operationId"=>"users.userid.projectParticipations.get", "x-api-path-slug"=>"usersuseridprojectparticipations-get", "parameters"=>[{"in"=>"path", "name"=>"userid", "description"=>"A user id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}}}, "apis"=>{"name"=>"Learnifier", "x-slug"=>"learnifier", "description"=>"Create your online courses in minutes. Learnifier is the fast and easy tool for creating and sharing great courses that work on your mobile, tablet and desktop. Book a DEMO or test it out with our FREE TRIAL.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28448-learnifier.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"5836977", "tags"=>"API Provider,API Service Provider,Courses,Education,Marketplace,Profiles,Relative Data,Service API,Technology,Trainings", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"learnifier/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Learnifier", "x-api-slug"=>"learnifier", "description"=>"Create your online courses in minutes. Learnifier is the fast and easy tool for creating and sharing great courses that work on your mobile, tablet and desktop. Book a DEMO or test it out with our FREE TRIAL.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28448-learnifier.jpg", "humanURL"=>"http://learnifier.com", "baseURL"=>"https://learnifier.com//", "tags"=>"API Provider,API Service Provider,Courses,Education,Marketplace,Profiles,Relative Data,Service API,Technology,Trainings", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/learnifier/learnifier-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/learnifier"}, {"type"=>"x-developer", "url"=>"https://learnifier.com/api/"}, {"type"=>"x-email", "url"=>"sales@learnifier.com"}, {"type"=>"x-email", "url"=>"Abdalla.Mohamed@learnifier.com"}, {"type"=>"x-email", "url"=>"support@learnifier.com"}, {"type"=>"x-email", "url"=>"jerker.klang@learnifier.com"}, {"type"=>"x-email", "url"=>"mattias.borg@learnifier.com"}, {"type"=>"x-email", "url"=>"lars.peterstrand@learnifier.com"}, {"type"=>"x-email", "url"=>"hello@learnifier.com"}, {"type"=>"x-email", "url"=>"unsubscribe@learnifier.com"}, {"type"=>"x-email", "url"=>"privacy@learnifier.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Learnifier"}, {"type"=>"x-website", "url"=>"http://learnifier.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
arlington-national-cemetery{"arlington-national-cemetery-burial-record-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Arlington National Cemetery", "x-complete"=>1, "info"=>{"title"=>"Arlington National Cemetery Burial Record", "description"=>"the-arlington-national-cemetery-anc-interment-scheduling-system-iss-provides-a-jsonp-responder-for-searching-the-anc-burial-record-dataset-", "version"=>"v1"}, "host"=>"wspublic.iss.army.mil", "basePath"=>"/IssRetrieveServices.svc/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/search/"=>{"get"=>{"summary"=>"Searches Burial Records", "description"=>"Searches Burial Records", "operationId"=>"searchRecords", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"This is the maximum number of records to return at one time"}, {"in"=>"query", "name"=>"method", "description"=>"This should be a valid JavaScript identifier that corresponds to the method on the page for processing the returned information"}, {"in"=>"query", "name"=>"q", "description"=>"A comma separated list of query parameters"}, {"in"=>"query", "name"=>"sortColumn", "description"=>"A comma separated list of column used to sort"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"ASC/DESC ascending or descending, values not in this set will be automatically set to ascending"}, {"in"=>"query", "name"=>"start", "description"=>"This is the number of the first record to return from the result set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cemeteries", "Burials", "Records"]}}}}, "apis"=>{"name"=>"Arlington National Cemetery", "x-slug"=>"arlington-national-cemetery", "description"=>"Welcome to Arlington National Cemeterys official Facebook page. Arlington National Cemetery is our nations most hallowed ground. More than 400,000 people are buried here, to include veterans from all our nations wars. Arlington has been the final...", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/ArlingtonNationalCemetery_Logo@2x.png", "x-kinRank"=>"9", "x-alexaRank"=>"268709", "tags"=>"API Provider,Federal Government,Federal Government,General Data,Historical Data API,Profiles,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"arlington-national-cemetery/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Arlington National Cemetery Burial Record API", "x-api-slug"=>"arlington-national-cemetery-burial-record-api", "description"=>"Welcome to Arlington National Cemeterys official Facebook page. Arlington National Cemetery is our nations most hallowed ground. More than 400,000 people are buried here, to include veterans from all our nations wars. Arlington has been the final...", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/ArlingtonNationalCemetery_Logo@2x.png", "humanURL"=>"http://wspublic.iss.army.mil", "baseURL"=>"http://wspublic.iss.army.mil//IssRetrieveServices.svc/", "tags"=>"API Provider,Federal Government,Federal Government,General Data,Historical Data API,Profiles,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/arlington-national-cemetery/search-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/arlington-national-cemetery/arlington-national-cemetery-burial-record-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://wspublic.iss.army.mil/"}, {"type"=>"x-developer", "url"=>"http://www.arlingtoncemetery.mil/Developers"}, {"type"=>"x-website", "url"=>"http://wspublic.iss.army.mil"}, {"type"=>"x-website", "url"=>"http://www.arlingtoncemetery.mil/"}, {"type"=>"x-wikipedia", "url"=>"http://en.wikipedia.org/wiki/Arlington_National_Cemetary"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-hdinsight{"azure-hdinsight-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure HDInsight", "x-complete"=>1, "info"=>{"title"=>"HDInsightManagementClient", "description"=>"the-hdinsight-management-client-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications"=>{"get"=>{"summary"=>"Applications List", "description"=>"Lists all of the applications HDInsight cluster.", "operationId"=>"Applications_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternameapplications-get", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications/{applicationName}"=>{"get"=>{"summary"=>"Applications Get", "description"=>"Lists properties of the application.", "operationId"=>"Applications_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternameapplicationsapplicationname-get", "parameters"=>[{"in"=>"path", "name"=>"applicationName", "description"=>"The constant value for the applicationName"}, {"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}, "put"=>{"summary"=>"Applications Create", "description"=>"The operation creates applications for the HDInsight cluster.", "operationId"=>"Applications_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternameapplicationsapplicationname-put", "parameters"=>[{"in"=>"path", "name"=>"applicationName", "description"=>"The constant value for the applicationName"}, {"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"body", "name"=>"parameters", "description"=>"The application create request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}, "delete"=>{"summary"=>"Applications Delete", "description"=>"Lists all of the applications HDInsight cluster.", "operationId"=>"Applications_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternameapplicationsapplicationname-delete", "parameters"=>[{"in"=>"path", "name"=>"applicationName", "description"=>"The constant value for the applicationName"}, {"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/capabilities"=>{"get"=>{"summary"=>"Location Get Capabilities", "description"=>"Gets the capabilities for the specified location.", "operationId"=>"Location_GetCapabilities", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-hdinsightlocationslocationcapabilities-get", "parameters"=>[{"in"=>"path", "name"=>"location", "description"=>"The location to get capabilities for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Location Capabilities"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}"=>{"put"=>{"summary"=>"Clusters Create", "description"=>"Begins creating a new HDInsight cluster with the specified parameters.", "operationId"=>"Clusters_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclustername-put", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"body", "name"=>"parameters", "description"=>"The cluster create request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}, "patch"=>{"summary"=>"Clusters Update", "description"=>"Patch HDInsight cluster with the specified parameters.", "operationId"=>"Clusters_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclustername-patch", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"body", "name"=>"parameters", "description"=>"The cluster patch request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}, "delete"=>{"summary"=>"Clusters Delete", "description"=>"Begins deleting the specified HDInsight cluster.", "operationId"=>"Clusters_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclustername-delete", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}, "get"=>{"summary"=>"Clusters Get", "description"=>"Gets the specified cluster.", "operationId"=>"Clusters_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclustername-get", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters"=>{"get"=>{"summary"=>"Clusters List By Resource Group", "description"=>"List the HDInsight clusters in a resource group.", "operationId"=>"Clusters_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclusters-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters Resource Group"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/roles/{roleName}/resize"=>{"post"=>{"summary"=>"Clusters Resize", "description"=>"Begins a resize operation on the specified HDInsight cluster.", "operationId"=>"Clusters_Resize", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternamerolesrolenameresize-post", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters for the resize operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"roleName", "description"=>"The constant value for the roleName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters Resize"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/clusters"=>{"get"=>{"summary"=>"Clusters List", "description"=>"Lists HDInsight clusters under the subscription.", "operationId"=>"Clusters_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-hdinsightclusters-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/changerdpsetting"=>{"post"=>{"summary"=>"Clusters Change Rdp Settings", "description"=>"Begins changing the RDP settings on the specified cluster.", "operationId"=>"Clusters_ChangeRdpSettings", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternamechangerdpsetting-post", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"body", "name"=>"parameters", "description"=>"The OS profile for RDP", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters Change Rdptings"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}"=>{"post"=>{"summary"=>"Configurations Update HTTPSettings", "description"=>"Begins configuring the HTTP settings on the specified cluster.", "operationId"=>"Configurations_UpdateHTTPSettings", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternameconfigurationsconfigurationname-post", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"configurationName", "description"=>"The constant for configuration type of gateway"}, {"in"=>"body", "name"=>"parameters", "description"=>"The name of the resource group", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configurations Httpsettings"]}, "get"=>{"summary"=>"Configurations Get", "description"=>"The configuration object for the specified cluster.", "operationId"=>"Configurations_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternameconfigurationsconfigurationname-get", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"configurationName", "description"=>"The constant for configuration type of gateway"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configurations"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}"=>{"put"=>{"summary"=>"Extension Create", "description"=>"Create HDInsight cluster extension.", "operationId"=>"Extension_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternameextensionsextensionname-put", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"extensionName", "description"=>"The name of the cluster extension"}, {"in"=>"body", "name"=>"parameters", "description"=>"The cluster extensions create request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extension"]}, "get"=>{"summary"=>"Extension Get", "description"=>"Get extension properties for HDInsight cluster extension.", "operationId"=>"Extension_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternameextensionsextensionname-get", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"extensionName", "description"=>"The name of the cluster extension"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extension"]}, "delete"=>{"summary"=>"Extension Delete", "description"=>"Delete extension for HDInsight cluster.", "operationId"=>"Extension_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternameextensionsextensionname-delete", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"extensionName", "description"=>"The name of the cluster extension"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extension"]}}, "/providers/Microsoft.HDInsight/operations"=>{"get"=>{"summary"=>"Operations List", "description"=>"Lists all of the available HDInsight REST API operations.", "operationId"=>"Operations_List", "x-api-path-slug"=>"providersmicrosoft-hdinsightoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions/{scriptName}"=>{"delete"=>{"summary"=>"Script Actions Delete", "description"=>"Deletes a given persisted script action of the cluster.", "operationId"=>"ScriptActions_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternamescriptactionsscriptname-delete", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"scriptName", "description"=>"The name of the script"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Script Actions"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/executeScriptActions"=>{"post"=>{"summary"=>"Clusters Execute Script Actions", "description"=>"Begins executing script actions on the specified HDInsight cluster.", "operationId"=>"Clusters_ExecuteScriptActions", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternameexecutescriptactions-post", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters for executing script actions", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters Execute Script Actions"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions"=>{"get"=>{"summary"=>"Script Actions List", "description"=>"Lists all persisted script actions for the given cluster.", "operationId"=>"ScriptActions_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternamescriptactions-get", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Script Actions"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}"=>{"get"=>{"summary"=>"Script Execution History Get", "description"=>"Gets the script execution detail for the given script execution id.", "operationId"=>"ScriptExecutionHistory_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternamescriptexecutionhistoryscriptexecutionid-get", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"scriptExecutionId", "description"=>"The script execution Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Script Execution History"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory"=>{"get"=>{"summary"=>"Script Execution History List", "description"=>"Lists all scripts execution history for the given cluster.", "operationId"=>"ScriptExecutionHistory_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternamescriptexecutionhistory-get", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Script Execution History"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}/promote"=>{"post"=>{"summary"=>"Script Execution History Promote", "description"=>"Promote ad-hoc script execution to a persisted script.", "operationId"=>"ScriptExecutionHistory_Promote", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-hdinsightclustersclusternamescriptexecutionhistoryscriptexecutionidpromote-post", "parameters"=>[{"in"=>"path", "name"=>"clusterName", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"scriptExecutionId", "description"=>"The script execution Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Script Execution History Promote"]}}}}, "apis"=>{"name"=>"Azure HDInsight", "x-slug"=>"azure-hdinsight", "description"=>"Azure HDInsight is a Hadoop-based service that brings an Apache Hadoop solution to the cloud. Gain the full value of big data with a cloud-based data platform that manages data of any type and size.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-hdinsights-open-source-analytics.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Analysis,API Provider,API Service Provider,Data,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-hdinsight/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure HDInsight API", "x-api-slug"=>"azure-hdinsight-api", "description"=>"Azure HDInsight is a Hadoop-based service that brings an Apache Hadoop solution to the cloud. Gain the full value of big data with a cloud-based data platform that manages data of any type and size.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-hdinsights-open-source-analytics.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/hdinsight/", "baseURL"=>"://management.azure.com//", "tags"=>"Analysis,API Provider,API Service Provider,Data,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/azure-hdinsight/azure-hdinsight-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/hdinsight/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/hdinsight/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/hdinsight/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/hdinsight/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
national-renewable-energy-laboratory{"transportation-laws-and-incentives-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"National Renewable Energy Laboratory", "x-complete"=>1, "info"=>{"title"=>"Transportation Laws and Incentives", "description"=>"query-our-database-of-state-and-federal-laws-and-incentives-for-alternative-fuels", "version"=>"0.1.0"}, "host"=>"developer.nrel.gov", "basePath"=>"/api/transportation-incentives-laws", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1.{output_format}"=>{"get"=>{"summary"=>"Return a full list of laws and incentives that match your query.", "description"=>"Return a full list of laws and incentives that match your query..", "operationId"=>"v1.output_format.get", "x-api-path-slug"=>"v1-output-format-get", "parameters"=>[{"in"=>"query", "name"=>"expired", "description"=>"Show only expired, repealed or archived laws and incentives"}, {"in"=>"query", "name"=>"incentive_type", "description"=>"Search by the incentive type"}, {"in"=>"query", "name"=>"jurisdiction", "description"=>"Return laws for the given Jurisdiction"}, {"in"=>"query", "name"=>"keyword", "description"=>"Search laws by keyword in title or text"}, {"in"=>"query", "name"=>"law_type", "description"=>"Search by the law type"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit the number of laws returned"}, {"in"=>"query", "name"=>"local", "description"=>"Show only local examples of laws and incentives"}, {"in"=>"path", "name"=>"output_format", "description"=>"Response format"}, {"in"=>"query", "name"=>"poc", "description"=>"Include points of contacts in the return value"}, {"in"=>"query", "name"=>"recent", "description"=>"Return only recently added or updated laws and incentives"}, {"in"=>"query", "name"=>"regulation_type", "description"=>"Search by the regulation type"}, {"in"=>"query", "name"=>"technology", "description"=>"Search by the technology type"}, {"in"=>"query", "name"=>"user_type", "description"=>"Search by the user type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "Full", "List", "Of", "Laws", "Incentives", "That", "Match", "Your", "Query"]}}, "/v1/category-list.{output_format}"=>{"get"=>{"summary"=>"Return the law categories for a given category type.", "description"=>"Return the law categories for a given category type..", "operationId"=>"v1.category_list.output_format.get", "x-api-path-slug"=>"v1categorylist-output-format-get", "parameters"=>[{"in"=>"path", "name"=>"output_format", "description"=>"Response format"}, {"in"=>"query", "name"=>"type", "description"=>"Search by the category type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "Law", "Categoriesa", "Given", "Category", "Type"]}}, "/v1/pocs.{output_format}"=>{"get"=>{"summary"=>"Get the points of contact for a given jurisdiction.", "description"=>"Get the points of contact for a given jurisdiction..", "operationId"=>"v1.pocs.output_format.get", "x-api-path-slug"=>"v1pocs-output-format-get", "parameters"=>[{"in"=>"query", "name"=>"jurisdiction", "description"=>"Return the points of contact for the given Jurisdiction"}, {"in"=>"path", "name"=>"output_format", "description"=>"Response format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Points", "Of", "Contacta", "Given", "Jurisdiction"]}}, "/v1/{id}.{output_format}"=>{"get"=>{"summary"=>"Fetch the details of a specific law given the law's ID.", "description"=>"Fetch the details of a specific law given the law's id..", "operationId"=>"v1.id.output_format.get", "x-api-path-slug"=>"v1id-output-format-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the law that you are searching"}, {"in"=>"path", "name"=>"output_format", "description"=>"Response format"}, {"in"=>"query", "name"=>"poc", "description"=>"Include points of contacts in the return value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fetch", "Details", "Of", "Specific", "Law", "Given", "Laws", "ID"]}}}}, "apis"=>{"name"=>"National Renewable Energy Laboratory", "x-slug"=>"national-renewable-energy-laboratory", "description"=>"The National Renewable Energy Laboratory (NREL) is the nations primary laboratory for renewable energy and energy efficiency research and development (R&D).", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1097-national-renewable-energy-laboratory.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"31023", "tags"=>"API Provider,Data Provider,Energy,Energy,Enterprise,Environment,General Data,Jobs,Profiles,SMS", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"national-renewable-energy-laboratory/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"High Performance Building Database", "x-api-slug"=>"high-performance-building-database", "description"=>"The National Renewable Energy Laboratory (NREL) is the nations primary laboratory for renewable energy and energy efficiency research and development (R&D).", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1097-national-renewable-energy-laboratory.jpg", "humanURL"=>"http://nrel.gov", "baseURL"=>"https://developer.nrel.gov//api/building-case-studies", "tags"=>"API Provider,Data Provider,Energy,Energy,Enterprise,Environment,General Data,Jobs,Profiles,SMS", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/national-renewable-energy-laboratory/projectproject-id-output-format-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/national-renewable-energy-laboratory/high-performance-building-database-openapi.yaml"}]}, {"name"=>"Transportation Laws and Incentives", "x-api-slug"=>"transportation-laws-and-incentives", "description"=>"The National Renewable Energy Laboratory (NREL) is the nations primary laboratory for renewable energy and energy efficiency research and development (R&D).", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1097-national-renewable-energy-laboratory.jpg", "humanURL"=>"http://nrel.gov", "baseURL"=>"https://developer.nrel.gov//api/transportation-incentives-laws", "tags"=>"Projects", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/national-renewable-energy-laboratory/v1id-output-format-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/national-renewable-energy-laboratory/transportation-laws-and-incentives-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://developer.nrel.gov/api/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/national-renewable-energy-laboratory"}, {"type"=>"x-developer", "url"=>"http://developer.nrel.gov/"}, {"type"=>"x-email", "url"=>"public.affairs@nrel.gov"}, {"type"=>"x-email", "url"=>"Kaitlyn.Wingfield@nrel.gov"}, {"type"=>"x-email", "url"=>"education.center@nrel.gov"}, {"type"=>"x-email", "url"=>"ASER@nrel.gov"}, {"type"=>"x-email", "url"=>"service.center@nrel.gov"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/#!/NRELdev"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/NREL"}, {"type"=>"x-website", "url"=>"http://nrel.gov"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "high-performance-building-database-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"National Renewable Energy Laboratory", "x-complete"=>1, "info"=>{"title"=>"High Performance Building Database", "description"=>"the-buildings-database-is-a-shared-resource-for-the-building-industry--the-database-developed-by-the-u-s--department-of-energy-and-the-national-renewable-energy-laboratory-nrel-is-a-unique-central-repository-of-indepth-information-and-data-on-highperformance-green-building-projects-across-the-united-states-and-abroad---", "version"=>"1.0"}, "host"=>"developer.nrel.gov", "basePath"=>"/api/building-case-studies", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/project.{output_format}"=>{"get"=>{"summary"=>"Get Projects", "description"=>"Get Projects", "operationId"=>"getProject", "x-api-path-slug"=>"project-output-format-get", "parameters"=>[{"in"=>"query", "name"=>"city", "description"=>"City"}, {"in"=>"path", "name"=>"output_format", "description"=>"Response Format"}, {"in"=>"query", "name"=>"page", "description"=>"Page Number"}, {"in"=>"query", "name"=>"portal", "description"=>"Portal ID"}, {"in"=>"query", "name"=>"province", "description"=>"State or Province (ex: CO, AZ)"}, {"in"=>"query", "name"=>"region", "description"=>"Climate Region"}, {"in"=>"query", "name"=>"search", "description"=>"Search Text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/project/{project_id}.{output_format}"=>{"get"=>{"summary"=>"Get Project Details", "description"=>"This API allows users to request metadata associated with the specific Document.", "operationId"=>"document", "x-api-path-slug"=>"projectproject-id-output-format-get", "parameters"=>[{"in"=>"path", "name"=>"output_format", "description"=>"Response Format"}, {"in"=>"path", "name"=>"project_id", "description"=>"Project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
factual{"factual-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Factual", "x-complete"=>1, "info"=>{"title"=>"Factual", "description"=>"access-to-the-places-and-business-data-available-at-factual-", "version"=>"1.0.0"}, "host"=>"api.v3.factual.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/t/{table_name}/boost"=>{"post"=>{"summary"=>"Post Table Name Boost", "description"=>"Post table name boost.", "operationId"=>"postTTableNameBoost", "x-api-path-slug"=>"ttable-nameboost-post", "parameters"=>[{"in"=>"path", "name"=>"table_name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Name", "Boost"]}}, "/t/{table_name}/facets"=>{"get"=>{"summary"=>"Get Table Name Facets", "description"=>"Get table name facets.", "operationId"=>"getTTableNameFacets", "x-api-path-slug"=>"ttable-namefacets-get", "parameters"=>[{"in"=>"path", "name"=>"table_name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Name", "Facets"]}}, "/t/{table_name}/match"=>{"get"=>{"summary"=>"Get Table Name Match", "description"=>"Get table name match.", "operationId"=>"getTTableNameMatch", "x-api-path-slug"=>"ttable-namematch-get", "parameters"=>[{"in"=>"path", "name"=>"table_name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Name", "Match"]}}, "/t/{table_name}/resolve"=>{"get"=>{"summary"=>"Get Table Name Resolve", "description"=>"Get table name resolve.", "operationId"=>"getTTableNameResolve", "x-api-path-slug"=>"ttable-nameresolve-get", "parameters"=>[{"in"=>"path", "name"=>"table_name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Name", "Resolve"]}}, "/t/{table_name}/schema"=>{"get"=>{"summary"=>"Get Table Name Schema", "description"=>"Get table name schema.", "operationId"=>"getTTableNameSchema", "x-api-path-slug"=>"ttable-nameschema-get", "parameters"=>[{"in"=>"path", "name"=>"table_name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Name", "Schema"]}}, "/t/{table_name}/submit"=>{"post"=>{"summary"=>"Post Table Name Submit", "description"=>"Post table name submit.", "operationId"=>"postTTableNameSubmit", "x-api-path-slug"=>"ttable-namesubmit-post", "parameters"=>[{"in"=>"path", "name"=>"table_name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Name", "Submit"]}}, "/t/{table_name}/{factual_id}"=>{"get"=>{"summary"=>"Get Table Name Factual", "description"=>"Get table name factual.", "operationId"=>"getTTableNameFactual", "x-api-path-slug"=>"ttable-namefactual-id-get", "parameters"=>[{"in"=>"path", "name"=>"factual_id"}, {"in"=>"path", "name"=>"table_name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Name", "Factual", "Id"]}}, "/t/{table_name}/{factual_id}/clear"=>{"post"=>{"summary"=>"Post Table Name Factual Clear", "description"=>"Post table name factual clear.", "operationId"=>"postTTableNameFactualClear", "x-api-path-slug"=>"ttable-namefactual-idclear-post", "parameters"=>[{"in"=>"path", "name"=>"factual_id"}, {"in"=>"path", "name"=>"table_name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Name", "Factual", "Id", "Clear"]}}, "/t/{table_name}/{factual_id}/flag"=>{"post"=>{"summary"=>"Post Table Name Factual Flag", "description"=>"Post table name factual flag.", "operationId"=>"postTTableNameFactualFlag", "x-api-path-slug"=>"ttable-namefactual-idflag-post", "parameters"=>[{"in"=>"path", "name"=>"factual_id"}, {"in"=>"path", "name"=>"table_name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Name", "Factual", "Id", "Flag"]}}}}, "apis"=>{"name"=>"Factual", "x-slug"=>"factual", "description"=>"Factual is pioneering how the world uses data to power mobile marketing, digital consumer products, mobile applications and real world analytics.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/139-factual.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"147251", "tags"=>"API Provider,Business,Data,Data Provider,Enterprise,General Data,Geo,internet,Locations,Places,Profiles,SaaS,Stack Network,Target,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"factual/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Factual", "x-api-slug"=>"factual", "description"=>"Factual is pioneering how the world uses data to power mobile marketing, digital consumer products, mobile applications and real world analytics.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/139-factual.jpg", "humanURL"=>"http://www.factual.com/", "baseURL"=>"https://api.v3.factual.com//", "tags"=>"API Provider,Business,Data,Data Provider,Enterprise,General Data,Geo,internet,Locations,Places,Profiles,SaaS,Stack Network,Target,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/factual/ttable-namefactual-idflag-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/factual/factual-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://www.factual.com/"}, {"type"=>"x-base", "url"=>"http://api.v3.factual.com"}, {"type"=>"x-blog", "url"=>"http://blog.factual.com"}, {"type"=>"x-blog-rss", "url"=>"http://feeds.feedburner.com/FactualBlog"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/factual"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/factual"}, {"type"=>"x-email", "url"=>"media@factual.com"}, {"type"=>"x-email", "url"=>"privacy@factual.com"}, {"type"=>"x-github", "url"=>"https://github.com/Factual"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/factual"}, {"type"=>"x-website", "url"=>"https://www.factual.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
dns-check{"dns-record-group-monitoring-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DNS Check", "x-complete"=>1, "info"=>{"title"=>"DNS Record Group Monitoring API", "description"=>"a-dns-record-group-is-a-logical-collection-of-dns-records--dns-record-groups-can-have-a-onetoone-correlation-with-zone-files-but-other-types-of-groupings-are-possible-as-well-such-as-grouping-by-service-or-customer--see-the-dns-record-groups-page-for-more-details--the-dns-check-api-is-used-to-request-data-for-either-a-specific-record-group-or-all-dns-record-groups-owned-by-your-account-", "version"=>"v1"}, "host"=>"www.dnscheck.co", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/groups/:group_uuid"=>{"get"=>{"summary"=>"Check Group", "description"=>"The DNS Check API is used to request data for either a specific record group, or all DNS record groups owned by your account.", "operationId"=>"getGroups", "x-api-path-slug"=>"groupsgroup-uuid-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"The secret key thats used to authenticate the connecting application", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"group_uuid", "description"=>"The UUID of the DNS record group", "type"=>"string", "format"=>"string"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, 200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}}}, "apis"=>{"name"=>"DNS Check", "x-slug"=>"dns-check", "description"=>"Monitor DNS records. Request DNS updates by sharing reports that show the pass/fail status of each record. Troubleshoot DNS issues. DNS records are automatically re-checked, and reports updated. DNS records can be imported from a zone file, or added in...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/18972-dns-check.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"3315601", "tags"=>"API Provider,API Service Provider,DNS,dns check,DNS General,dns monitor,Monitoring,mx record check,Profiles,Relative Data,SaaS,Service API,spf record check,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"dns-check/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"DNS Record Group Monitoring API", "x-api-slug"=>"dns-record-group-monitoring-api", "description"=>"A DNS record group is a logical collection of DNS records. DNS record groups can have a one-to-one correlation with zone files, but other types of groupings are possible as well, such as grouping by service or customer. See the DNS record groups page for more details. The DNS Check API is used to request data for either a specific record group, or all DNS record groups owned by your account.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/18972-dns-check.jpg", "humanURL"=>"https://www.dnscheck.co/", "baseURL"=>"https://www.dnscheck.co//api/v1", "tags"=>"API Provider,API Service Provider,DNS,dns check,DNS General,dns monitor,Monitoring,mx record check,Profiles,Relative Data,SaaS,Service API,spf record check,Stack Network,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/dns-check/dns-record-group-monitoring-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"https://www.dnscheck.co/documentation"}, {"type"=>"x-pricing", "url"=>"https://www.dnscheck.co/pricing"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/dns_check"}, {"type"=>"x-website", "url"=>"https://www.dnscheck.co/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
esme{"esme-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Esme", "x-complete"=>1, "info"=>{"title"=>"Esme", "description"=>"this-is-an-openapi-definition-for-the-standard-set-of-open-banking-httpopenbankingapis-io-apis-from-esme-", "termsOfService"=>"https://www.openbanking.org.uk/open-licence/", "contact"=>{"name"=>"API Evangelist", "url"=>"https://apievangelist.com", "email"=>"info@apievangelist.com"}, "version"=>"1.0.0"}, "host"=>"openapi.esmeloans.com", "basePath"=>"open-banking/v2.1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"unsecured-sme-loans/"=>{"get"=>{"summary"=>"Get Unsecured SME Loans", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Unsecured Loan products.", "operationId"=>"pathOperation", "x-api-path-slug"=>"unsecuredsmeloans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"Esme", "x-slug"=>"esme", "description"=>"At Esme, our aim is to provide the money your business needs quickly and with the minimum of fuss. By quickly verifying your details and analysing your credit profile, we waste no time seeing if we can make you an offer. You can relax knowing our security technology ensures the confidentiality and safety of your information.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/esmeloans-logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Not Found,Banking,Profiles,Relative Data,Service API,UK Banks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"esme/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Esme", "x-api-slug"=>"esme", "description"=>"At Esme, our aim is to provide the money your business needs quickly and with the minimum of fuss. By quickly verifying your details and analysing your credit profile, we waste no time seeing if we can make you an offer. You can relax knowing our security technology ensures the confidentiality and safety of your information.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/esmeloans-logo.png", "humanURL"=>"http://openbankingapis.io/uk/esme", "baseURL"=>"https://openapi.esmeloans.com/open-banking/v2.1/", "tags"=>"API Not Found,Banking,Profiles,Relative Data,Service API,UK Banks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/esme/unsecuredsmeloans-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/esme/esme-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developers", "url"=>"http://openbankingapis.io/uk/esme"}, {"type"=>"x-documentation", "url"=>"https://openbanking.atlassian.net/wiki/spaces/DZ/pages/54919225/Open+Data+API+Dashboard#"}, {"type"=>"x-website", "url"=>"https://www.esmeloans.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
public-transport-victoria-timetable{"ptv-timetable-api--version-3-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Public Transport Victoria Timetable", "x-complete"=>1, "info"=>{"title"=>"Public Transport Victoria Timetable", "description"=>"the-ptv-timetable-api-provides-direct-access-to-public-transport-victorias-public-transport-timetable-data--the-api-returns-scheduled-timetable-route-and-stop-data-for-all-metropolitan-and-regional-train-tram-and-bus-services-in-victoria-including-night-networknight-train-and-night-tram-data-are-included-in-metropolitan-train-and-tram-services-data-respectively-whereas-night-bus-is-a-separate-route-type--the-api-also-returns-realtime-data-for-metropolitan-train-tram-and-bus-services-where-this-data-is-made-available-to-ptv-as-well-as-disruption-information-stop-facility-information-and-access-to-myki-ticket-outlet-data-", "termsOfService"=>"http://ptv.vic.gov.au/ptv-timetable-api/", "contact"=>{"name"=>"Public Transport Victoria", "url"=>"http://ptv.vic.gov.au/digital"}, "version"=>"v3"}, "host"=>"timetableapi.ptv.vic.gov.au", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v3/departures/route_type/{route_type}/stop/{stop_id}"=>{"get"=>{"summary"=>"Get V3 Departures Route Type Route Type Stop Stop", "description"=>"View departures for all routes from a stop.", "operationId"=>"Departures_GetForStop", "x-api-path-slug"=>"v3departuresroute-typeroute-typestopstop-id-get", "parameters"=>[{"in"=>"query", "name"=>"date_utc", "description"=>"Filter by the date and time of the request (ISO 8601 UTC format)"}, {"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"query", "name"=>"direction_id", "description"=>"Filter by identifier of direction of travel; values returned by Directions API - /v3/directions/route/{route_id}"}, {"in"=>"query", "name"=>"expand", "description"=>"List objects to be returned in full (i"}, {"in"=>"query", "name"=>"gtfs", "description"=>"Indicates that stop_id parameter will accept GTFS stop_id data"}, {"in"=>"query", "name"=>"include_cancelled", "description"=>"Indicates if cancelled services (if they exist) are returned (default = false) - metropolitan train only"}, {"in"=>"query", "name"=>"max_results", "description"=>"Maximum number of results returned"}, {"in"=>"query", "name"=>"platform_numbers", "description"=>"Filter by platform number at stop"}, {"in"=>"path", "name"=>"route_type", "description"=>"Number identifying transport mode; values returned via RouteTypes API"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"path", "name"=>"stop_id", "description"=>"Identifier of stop; values returned by Stops API"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Departures", "Route", "Type", "Route", "Type", "Stop", "Stop", "Id"]}}, "/v3/departures/route_type/{route_type}/stop/{stop_id}/route/{route_id}"=>{"get"=>{"summary"=>"Get V3 Departures Route Type Route Type Stop Stop Route Route", "description"=>"View departures for a specific route from a stop.", "operationId"=>"Departures_GetForStopAndRoute", "x-api-path-slug"=>"v3departuresroute-typeroute-typestopstop-idrouteroute-id-get", "parameters"=>[{"in"=>"query", "name"=>"date_utc", "description"=>"Filter by the date and time of the request (ISO 8601 UTC format)"}, {"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"query", "name"=>"direction_id", "description"=>"Filter by identifier of direction of travel; values returned by Directions API - /v3/directions/route/{route_id}"}, {"in"=>"query", "name"=>"expand", "description"=>"List objects to be returned in full (i"}, {"in"=>"query", "name"=>"gtfs", "description"=>"Indicates that stop_id parameter will accept GTFS stop_id data"}, {"in"=>"query", "name"=>"include_cancelled", "description"=>"Indicates if cancelled services (if they exist) are returned (default = false) - metropolitan train only"}, {"in"=>"query", "name"=>"max_results", "description"=>"Maximum number of results returned"}, {"in"=>"path", "name"=>"route_id", "description"=>"Identifier of route; values returned by Routes API - v3/routes"}, {"in"=>"path", "name"=>"route_type", "description"=>"Number identifying transport mode; values returned via RouteTypes API"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"path", "name"=>"stop_id", "description"=>"Identifier of stop; values returned by Stops API"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Departures", "Route", "Type", "Route", "Type", "Stop", "Stop", "Id", "Route", "Route", "Id"]}}, "/v3/directions/route/{route_id}"=>{"get"=>{"summary"=>"Get V3 Directions Route Route", "description"=>"View directions that a route travels in.", "operationId"=>"Directions_ForRoute", "x-api-path-slug"=>"v3directionsrouteroute-id-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"path", "name"=>"route_id", "description"=>"Identifier of route; values returned by Routes API - v3/routes"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Directions", "Route", "Route", "Id"]}}, "/v3/directions/{direction_id}"=>{"get"=>{"summary"=>"Get V3 Directions Direction", "description"=>"View all routes for a direction of travel.", "operationId"=>"Directions_ForDirection", "x-api-path-slug"=>"v3directionsdirection-id-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"path", "name"=>"direction_id", "description"=>"Identifier of direction of travel; values returned by Directions API - /v3/directions/route/{route_id}"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Directions", "Direction", "Id"]}}, "/v3/directions/{direction_id}/route_type/{route_type}"=>{"get"=>{"summary"=>"Get V3 Directions Direction Route Type Route Type", "description"=>"View all routes of a particular type for a direction of travel.", "operationId"=>"Directions_ForDirectionAndType", "x-api-path-slug"=>"v3directionsdirection-idroute-typeroute-type-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"path", "name"=>"direction_id", "description"=>"Identifier of direction of travel; values returned by Directions API - /v3/directions/route/{route_id}"}, {"in"=>"path", "name"=>"route_type", "description"=>"Number identifying transport mode; values returned via RouteTypes API"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Directions", "Direction", "Id", "Route", "Type", "Route", "Type"]}}, "/v3/disruptions"=>{"get"=>{"summary"=>"Get V3 Disruptions", "description"=>"View all disruptions for all route types.", "operationId"=>"Disruptions_GetAllDisruptions", "x-api-path-slug"=>"v3disruptions-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"query", "name"=>"disruption_status", "description"=>"Filter by status of disruption"}, {"in"=>"query", "name"=>"route_types", "description"=>"Filter by route_type; values returned via RouteTypes API"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disruptions"]}}, "/v3/disruptions/route/{route_id}"=>{"get"=>{"summary"=>"Get V3 Disruptions Route Route", "description"=>"View all disruptions for a particular route.", "operationId"=>"Disruptions_GetDisruptionsByRoute", "x-api-path-slug"=>"v3disruptionsrouteroute-id-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"query", "name"=>"disruption_status", "description"=>"Filter by status of disruption"}, {"in"=>"path", "name"=>"route_id", "description"=>"Identifier of route; values returned by Routes API - v3/routes"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disruptions", "Route", "Route", "Id"]}}, "/v3/disruptions/{disruption_id}"=>{"get"=>{"summary"=>"Get V3 Disruptions Disruption", "description"=>"View a specific disruption.", "operationId"=>"Disruptions_GetDisruptionById", "x-api-path-slug"=>"v3disruptionsdisruption-id-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"path", "name"=>"disruption_id", "description"=>"Identifier of disruption; values returned by Disruptions API - /v3/disruptions OR /v3/disruptions/route/{route_id}"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disruptions", "Disruption", "Id"]}}, "/v3/pattern/run/{run_id}/route_type/{route_type}"=>{"get"=>{"summary"=>"Get V3 Pattern Run Run Route Type Route Type", "description"=>"View the stopping pattern for a specific trip/service run.", "operationId"=>"Patterns_GetPatternByRun", "x-api-path-slug"=>"v3patternrunrun-idroute-typeroute-type-get", "parameters"=>[{"in"=>"query", "name"=>"date_utc", "description"=>"Filter by the date and time of the request (ISO 8601 UTC format)"}, {"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"path", "name"=>"route_type", "description"=>"Number identifying transport mode; values returned via RouteTypes API"}, {"in"=>"path", "name"=>"run_id", "description"=>"Identifier of a trip/service run; values returned by Runs API - /v3/route/{route_id} and Departures API"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"stop_id", "description"=>"Filter by stop_id; values returned by Stops API"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pattern", "Run", "Run", "Id", "Route", "Type", "Route", "Type"]}}, "/v3/route_types"=>{"get"=>{"summary"=>"Get V3 Route Types", "description"=>"View all route types and their names.", "operationId"=>"RouteTypes_GetRouteTypes", "x-api-path-slug"=>"v3route-types-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route", "Types"]}}, "/v3/routes"=>{"get"=>{"summary"=>"Get V3 Routes", "description"=>"View route names and numbers for all routes.", "operationId"=>"Routes_OneOrMoreRoutes", "x-api-path-slug"=>"v3routes-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"query", "name"=>"route_name", "description"=>"Filter by name of route (accepts partial route name matches)"}, {"in"=>"query", "name"=>"route_types", "description"=>"Filter by route_type; values returned via RouteTypes API"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Routes"]}}, "/v3/routes/{route_id}"=>{"get"=>{"summary"=>"Get V3 Routes Route", "description"=>"View route name and number for specific route id.", "operationId"=>"Routes_RouteFromId", "x-api-path-slug"=>"v3routesroute-id-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"path", "name"=>"route_id", "description"=>"Identifier of route; values returned by Departures, Directions and Disruptions APIs"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Routes", "Route", "Id"]}}, "/v3/runs/route/{route_id}"=>{"get"=>{"summary"=>"Get V3 Runs Route Route", "description"=>"View all trip/service runs for a specific route id.", "operationId"=>"Runs_ForRoute", "x-api-path-slug"=>"v3runsrouteroute-id-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"path", "name"=>"route_id", "description"=>"Identifier of route; values returned by Routes API - v3/routes"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs", "Route", "Route", "Id"]}}, "/v3/runs/route/{route_id}/route_type/{route_type}"=>{"get"=>{"summary"=>"Get V3 Runs Route Route Route Type Route Type", "description"=>"View all trip/service runs for a specific route id and route type.", "operationId"=>"Runs_ForRouteAndRouteType", "x-api-path-slug"=>"v3runsrouteroute-idroute-typeroute-type-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"path", "name"=>"route_id", "description"=>"Identifier of route; values returned by Routes API - v3/routes"}, {"in"=>"path", "name"=>"route_type", "description"=>"Number identifying transport mode; values returned via RouteTypes API"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs", "Route", "Route", "Id", "Route", "Type", "Route", "Type"]}}, "/v3/runs/{run_id}"=>{"get"=>{"summary"=>"Get V3 Runs Run", "description"=>"View all trip/service runs for a specific run id.", "operationId"=>"Runs_ForRun", "x-api-path-slug"=>"v3runsrun-id-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"path", "name"=>"run_id", "description"=>"Identifier of a trip/service run; values returned by Runs API - /v3/route/{route_id} and Departures API"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs", "Run", "Id"]}}, "/v3/runs/{run_id}/route_type/{route_type}"=>{"get"=>{"summary"=>"Get V3 Runs Run Route Type Route Type", "description"=>"View the trip/service run for a specific run id and route type.", "operationId"=>"Runs_ForRunAndRouteType", "x-api-path-slug"=>"v3runsrun-idroute-typeroute-type-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"path", "name"=>"route_type", "description"=>"Number identifying transport mode; values returned via RouteTypes API"}, {"in"=>"path", "name"=>"run_id", "description"=>"Identifier of a trip/service run; values returned by Runs API - /v3/route/{route_id} and Departures API"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs", "Run", "Id", "Route", "Type", "Route", "Type"]}}, "/v3/search/{search_term}"=>{"get"=>{"summary"=>"Get V3 Search Search Term", "description"=>"View stops, routes and myki ticket outlets that match the search term.", "operationId"=>"Search_Search", "x-api-path-slug"=>"v3searchsearch-term-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"query", "name"=>"include_addresses", "description"=>"Placeholder for future development; currently unavailable"}, {"in"=>"query", "name"=>"include_outlets", "description"=>"Indicates if outlets will be returned in response (default = true)"}, {"in"=>"query", "name"=>"latitude", "description"=>"Filter by geographic coordinate of latitude"}, {"in"=>"query", "name"=>"longitude", "description"=>"Filter by geographic coordinate of longitude"}, {"in"=>"query", "name"=>"max_distance", "description"=>"Filter by maximum distance (in metres) from location specified via latitude and longitude parameters"}, {"in"=>"query", "name"=>"route_types", "description"=>"Filter by route_type; values returned via RouteTypes API (note: stops and routes are ordered by route_types specified)"}, {"in"=>"path", "name"=>"search_term", "description"=>"Search text (note: if search text is numeric and/or less than 3 characters, the API will only return routes)"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Search", "Term"]}}, "/v3/stops/location/{latitude},{longitude}"=>{"get"=>{"summary"=>"Get V3 Stops Location Latitude , Longitude", "description"=>"View all stops near a specific location.", "operationId"=>"Stops_StopsByGeolocation", "x-api-path-slug"=>"v3stopslocationlatitudelongitude-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"path", "name"=>"latitude", "description"=>"Geographic coordinate of latitude"}, {"in"=>"path", "name"=>"longitude", "description"=>"Geographic coordinate of longitude"}, {"in"=>"query", "name"=>"max_distance", "description"=>"Filter by maximum distance (in metres) from location specified via latitude and longitude parameters (default = 300)"}, {"in"=>"query", "name"=>"max_results", "description"=>"Maximum number of results returned (default = 30)"}, {"in"=>"query", "name"=>"route_types", "description"=>"Filter by route_type; values returned via RouteTypes API"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stops", "Location", "Latitude", "Longitude"]}}, "/v3/stops/route/{route_id}/route_type/{route_type}"=>{"get"=>{"summary"=>"Get V3 Stops Route Route Route Type Route Type", "description"=>"View all stops on a specific route.", "operationId"=>"Stops_StopsForRoute", "x-api-path-slug"=>"v3stopsrouteroute-idroute-typeroute-type-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"path", "name"=>"route_id", "description"=>"Identifier of route; values returned by Routes API - v3/routes"}, {"in"=>"path", "name"=>"route_type", "description"=>"Number identifying transport mode; values returned via RouteTypes API"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stops", "Route", "Route", "Id", "Route", "Type", "Route", "Type"]}}, "/v3/stops/{stop_id}/route_type/{route_type}"=>{"get"=>{"summary"=>"Get V3 Stops Stop Route Type Route Type", "description"=>"View facilities at a specific stop (metro and v/line stations only).", "operationId"=>"Stops_StopDetails", "x-api-path-slug"=>"v3stopsstop-idroute-typeroute-type-get", "parameters"=>[{"in"=>"query", "name"=>"devid", "description"=>"Your developer id"}, {"in"=>"query", "name"=>"gtfs", "description"=>"Incdicates whether the stop_id is a GTFS ID or not"}, {"in"=>"path", "name"=>"route_type", "description"=>"Number identifying transport mode; values returned via RouteTypes API"}, {"in"=>"query", "name"=>"signature", "description"=>"Authentication signature for request"}, {"in"=>"query", "name"=>"stop_accessibility", "description"=>"Indicates if stop accessibility information will be returned (default = false)"}, {"in"=>"query", "name"=>"stop_amenities", "description"=>"Indicates if stop amenity information will be returned (default = false)"}, {"in"=>"query", "name"=>"stop_contact", "description"=>"Placeholder for future development; currently unavailable"}, {"in"=>"path", "name"=>"stop_id", "description"=>"Identifier of stop; values returned by Stops API"}, {"in"=>"query", "name"=>"stop_location", "description"=>"Indicates if stop location information will be returned (default = false)"}, {"in"=>"query", "name"=>"stop_ticket", "description"=>"Placeholder for future development; currently unavailable"}, {"in"=>"query", "name"=>"token", "description"=>"Please ignore"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stops", "Stop", "Id", "Route", "Type", "Route", "Type"]}}}}, "apis"=>{"name"=>"Public Transport Victoria Timetable", "x-slug"=>"public-transport-victoria-timetable", "description"=>"The PTV Timetable API provides direct access to Public Transport Victoria’s public transport timetable data. The API returns scheduled timetable, route and stop data for all metropolitan and regional train, tram and bus services in Victoria, including Night Network(Night Train and Night Tram data are included in metropolitan train and tram services data, respectively, whereas Night Bus is a separate route type). The API also returns real-time data for metropolitan train, tram and bus services (where this data is made available to PTV), as well as disruption information, stop facility information, and access to myki ticket outlet data.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/public-transport-victoria.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,Cities,General Data,Profiles,Transit,Transportation", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"public-transport-victoria-timetable/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"PTV Timetable API - Version 3", "x-api-slug"=>"ptv-timetable-api--version-3", "description"=>"The PTV Timetable API provides direct access to Public Transport Victoria’s public transport timetable data. The API returns scheduled timetable, route and stop data for all metropolitan and regional train, tram and bus services in Victoria, including Night Network(Night Train and Night Tram data are included in metropolitan train and tram services data, respectively, whereas Night Bus is a separate route type). The API also returns real-time data for metropolitan train, tram and bus services (where this data is made available to PTV), as well as disruption information, stop facility information, and access to myki ticket outlet data.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/public-transport-victoria.png", "humanURL"=>"https://www.ptv.vic.gov.au/about-ptv/data-and-reports/datasets/ptv-timetable-api/", "baseURL"=>"https://timetableapi.ptv.vic.gov.au//", "tags"=>"API Provider,Cities,General Data,Profiles,Transit,Transportation", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/public-transport-victoria-timetable/v3stopsstop-idroute-typeroute-type-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/public-transport-victoria-timetable/ptv-timetable-api--version-3-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://www.ptv.vic.gov.au/about-ptv/data-and-reports/datasets/ptv-timetable-api/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
starred{"starred-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Starred", "x-complete"=>1, "info"=>{"title"=>"Starred API", "description"=>"starred-apistarredapiintrostarred-provides-rest-apis-to-help-our-clients-automate-feedback-process--with-starred-api-organizations-can-send-survey-invites-generate-survey-links-or-get-the-summary-of-survey-forms--starred-webhook-allows-your-to-subscribe-to-feedback-notifications-in-real-time-with-feedback-data-the-easiest-way-to-start-using-the-starred-api-is-by-clicking-the-run-in-postman-button-above--postman-is-a-free-tool-which-helps-developers-run-and-debug-api-requests--every-endpoint-you-see-documented-here-is-readily-available-by-running-our-postman-collection--tls-1-0-deprecatedstarred-has-deprecated-support-for-transport-layer-security-tls-1-0-because-of-the-security-issues--this-means-we-only-support-transport-layer-security-tls-1-1-and-tls-1-2if-your-programming-language-requires-you-to-define-security-protocol-then-please-use-tls-1-1-or-above--need-helpthe-starred-team-is-always-around-to-answer-your-questions--send-your-questions-to-apistarred-commailtoapistarred-com-restfulthe-only-thing-you-need-to-get-going-is-an-active-account-with-the-api-enabled--each-request-requires-the-two-parameters-stated-to-the-right--you-can-find-those-in-your-settings-page-the-starred-api-is-organized-around-rest--json-is-returned-by-all-api-responses-including-errors-although-our-api-libraries-convert-responses-to-appropriate-languagespecific-objects--api-endpointthis-shows-a-basic-api-endpoint--all-endpoints-are-relative-to-this-path-javascripthttpsapi-starred-commost-endpoints-have-their-own-set-of-additional-parameters--those-can-either-be-added-to-the-endpoint-url-or-be-set-as-http-post-parameters--authenticationthe-starred-uses-basic-authentication--authenticate-your-requests-when-using-the-api-by-including-your-secret-api-key-and-company-id-in-the-request--your-api-key-carry-many-privileges-so-be-sure-to-keep-them-secret-do-not-share-your-secret-api-keys-in-publicly-accessible-areas-such-github-clientside-code-etc--all-api-requests-must-be-made-over-https--calls-made-over-plain-http-will-fail--api-requests-without-authentication-will-also-fail-mandatory-parameters-parameter--description------company--the-company-key-which-is-available-from-your-company-settings-page--auth--the-api-key-which-is-available-from-your-company-settings-page-your-api-request-will-look-like-this-after-adding-authentication-parameters-javascripthttpsapi-starred-comsomeendpointmethodcompanycompanykeyauthapikeystarred-api-keystarredapikey-responseevery-request-gets-back-a-response-which-contains-response-headers-and-response-body--response-headersyou-will-receive-following-response-headers-with-every-response---response-header--description------contentlength--the-length-of-response-body--contenttype--the-type-of-this-content--date--the-time-when-the-request-was-sent--expires--the-date-and-time-after-which-the-response-is-considered-slate--contentencoding--the-type-of-encoding-used-on-data-response-bodyresponses-are-always-json--success-responsejson----status-ok----message-invitations-queued-for-delivery-error-responsejson----status-fail----errorcode-404----message-not-found-response-codesstarred-uses-http-response-codes-to-indicate-the-success-or-failure-of-an-api-request--in-general-codes-in-the-2xx-range-indicate-success-codes-in-the-4xx-range-indicate-an-error-that-failed-given-the-information-provided-and-codes-in-the-5xx-range-indicate-an-error-with-the-starred-server-this-happens-rarely--response-code--description------200--request-successful---403--access-is-denied-because-you-have-not-used-the-proper-access-token-for-the-request---404--endpoint-url-is-invalid---400--invalid-request---500--internal-server-error---feedbackwe-love-feedback-please-give-us-feedback-on-this-api-at-apistarred-commailtoapistarred-com-starred-jobsstarredjobsdo-you-want-to-be-the-part-of-our-journey-to-create-the-best-and-simplest-api-for-feedback-take-a-look-at-starred-jobshttpsjobs-starred-comutm-sourceapidocsutm-mediumkhizar--api-referencestarredapikey-httpwww-starred-comwpcontentuploads201805starredapi-pngstarredapiintro-httpwww-starred-comwpcontentuploads201805apiheader-pngstarredjobs-httpwww-starred-comwpcontentuploads201805jobstarredcom-png", "version"=>"1.0.0"}, "host"=>"example.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/InvitationLinks/anonymous"=>{"post"=>{"summary"=>"Anonymous Invitation Link", "description"=>"Generate a link to a Starred survey form of your choice. \nGenerate from 1 up to, and including 100 anonymous links. (Anonymous is for when the recipient's email is not known)\n\n**Request Parameters**\n\n| Parameter | Required | Description |\n| ------ | ------ | ------ |\n| `form` | Required | ID of the form that will be sent out |\n| `fromUserEmail` | Required | Email address of the sender |\n| `amount` | Optional | Amount of invitation links desired. (Defaults to 1) |\n| `tags` | Optional | Any number of invitation tags can be listed. It is in key - value format, e.g. tag1=tag1 |", "operationId"=>"InvitationLinksAnonymousPost", "x-api-path-slug"=>"invitationlinksanonymous-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Anonymous", "Invitation", "Link"]}}, "/"=>{"post"=>{"summary"=>"Webhook v1.0", "description"=>"Webhook v1.0 is our standard webhook response. This version will be deprecated soon. We highly recommend migrating to Webhook v1.1\n\nPlease get in touch with our support to migrate your account to Webhook v1.1", "operationId"=>"UnnammedEndpointPost2", "x-api-path-slug"=>"post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook", "V1", "0"]}}, "/InvitationLinks/single"=>{"post"=>{"summary"=>"Single Invitation Link", "description"=>"It is possible to generate a link to a Starred survey form of your choice. \n\n**Request Parameters**\n\n| Parameter | Required | Description |\n| ------ | ------ | ------ |\n| `form` | Required | ID of the form that will be sent out |\n| `fromUserEmail` | Required | Email address of the sender |\n| `recipient` | Required | Email address of the recipient |\n| `firstName` | Optional | First name to address the recipient with |\n| `lastName` | Optional | Surname to address the recipient with |\n| `tags` | Optional | Any number of invitation tags can be listed. It is in key - value format, e.g. tag1=tag1 |", "operationId"=>"InvitationLinksSinglePost", "x-api-path-slug"=>"invitationlinkssingle-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Invitation", "Link"]}}, "/sendinvitations/csv"=>{"post"=>{"summary"=>"Send Invitation CSV", "description"=>"With the /sendinvitations call you can link your CRM system to Starred so invitations are sent automatically. This will no longer require any manual action. \n\nYou can also import additional characteristics directly from your CRM so you can start analyzing results for different client groups. \n\nThe parameters on the right are mandatory to make the request succeed.\n\n### Request Parameters\n\n| Parameter | Required | Description |\n| ------ | ------ | ------ |\n| `form` | Required | ID of the form that will be sent out |\n| `from` | Required | Email address of the sender, must be a registered email |\n| `template` | Required | Template ID |\n| `language` | Required | The language of the template. For example: nl, en or fr |\n| `file` | Required | A CSV file formatted as a regular invitation CSV added as a HTTP POST file. |\n| `reminder` | Optional | Whether or not to send a reminder (1 means On, 0 means Off). Defaults to 1 |\n\n### Example curl request\n```\ncurl -F \"file=@testCSV.csv\" https://api.starred.com/sendinvitations\\?company\\={{companyID}}\\&auth\\={{auth}}\\&form\\={{formId}}\\&from\\={{sender}}\\&template\\={{templateId}}\\&language\\={{language}}\n```", "operationId"=>"SendinvitationsCsvPost", "x-api-path-slug"=>"sendinvitationscsv-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Invitation", "CSV"]}}, "/InvitationLinks/csv"=>{"post"=>{"summary"=>"Invitation Link CSV", "description"=>"Generate links for users from a CSV file.\n\n**Request Parameters**\n\n| Parameter | Required | Description |\n| ------ | ------ | ------ |\n| `form` | Required | ID of the form that will be sent out |\n| `fromUserEmail` | Required | Email address of the sender |\n| `file` | Required | A CSV file formatted as a regular invitation CSV added as a HTTP POST file. |", "operationId"=>"InvitationLinksCsvPost", "x-api-path-slug"=>"invitationlinkscsv-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invitation", "Link", "CSV"]}}, "/sendinvitations"=>{"post"=>{"summary"=>"Send Single Invitation", "description"=>"Instead of uploading a CSV file, you can also set one recipient per API call by using the following parameters to the URL.\n\n### Request Parameters\n\n| Parameter | Required | Description |\n| ------ | ------ | ------ |\n| `form` | Required | ID of the form that will be sent out |\n| `from` | Required | Email address of the sender, must be a registered email |\n| `recipient` | Required | Email address of the recipient |\n| `firstName` | Required | First name to address the recipient with |\n| `lastName` | Required | Surname to address the recipient with |\n| `template` | Required | Template ID |\n| `language` | Required | The language of the template. For example: nl, en or fr |\n| `reminder` | Optional | Whether or not to send a reminder (1 or 0). Defaults to 1 |", "operationId"=>"SendinvitationsPost", "x-api-path-slug"=>"sendinvitations-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Single", "Invitation"]}}, "/segment/summary"=>{"get"=>{"summary"=>"Dashboard Summary", "description"=>"Retrieve segment summary from your account. This summary includes your NPS score and detailed breakdown.\n\n**Request Parameters**\n\n| Parameter | Required | Description |\n| ------ | ------ | ------ |\n| `form` | Required | ID of the form that will be sent out |\n| `segment` | Optional | Group ID to get summary data for (defaults to 0) |\n\nNote: Segment is an alias for Groups in Starred Platform. You can retrieve Segment ID on Groups page in Starred Platform. [Groups in Starred](https://app.starred.com/segments/overview)\n\n#### Steps to retrieve Segment ID\n1. Login to Starred Platform\n2. Go to Clients tab\n3. Click on a Group you want to get data for. \n4. In Group detail view copy the Segment ID from URL\n\n![Starred API Key][starred-segment-id]\n[See Full Image](http://www.starred.com/wp-content/uploads/2018/05/starred-segment-id.png)\n[starred-segment-id]: http://www.starred.com/wp-content/uploads/2018/05/starred-segment-id.png", "operationId"=>"SegmentSummaryGet", "x-api-path-slug"=>"segmentsummary-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dashboard", "Summary"]}}}}, "apis"=>{"name"=>"Starred", "x-slug"=>"starred", "description"=>"Better feedback for everyone, on a human scale. At Starred we like to work smart: working smarter to build great software, and working with smart companies who listen. As the feedback solution which puts the respondent first, we’re empowering conversations between companies and their customers and employees. What’s more, we equip them with the actionable insights they need to make better decisions and boost loyalty. With leading lights like Deliveroo, Heineken and Spotify already working with us to bring feedback to life, the road ahead for better feedback is looking good.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/starred-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"916588", "tags"=>"Feedback,internet,Relative Data,SaaS,Service API,Stars,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"starred/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Starred", "x-api-slug"=>"starred", "description"=>"Better feedback for everyone, on a human scale. At Starred we like to work smart: working smarter to build great software, and working with smart companies who listen. As the feedback solution which puts the respondent first, we’re empowering conversations between companies and their customers and employees. What’s more, we equip them with the actionable insights they need to make better decisions and boost loyalty. With leading lights like Deliveroo, Heineken and Spotify already working with us to bring feedback to life, the road ahead for better feedback is looking good.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/starred-logo.png", "humanURL"=>"https://www.starred.com", "baseURL"=>"https://example.com//", "tags"=>"Feedback,internet,Relative Data,SaaS,Service API,Stars,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/starred/segmentsummary-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/starred/starred-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-github", "url"=>"https://github.com/starred-com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/starred_com"}, {"type"=>"x-blog", "url"=>"https://www.starred.com/blog/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/starred"}, {"type"=>"x-email", "url"=>"support@starred.com"}, {"type"=>"x-email", "url"=>"legal@starred.com"}, {"type"=>"x-integrations", "url"=>"https://www.starred.com/integrations/"}, {"type"=>"x-pricing", "url"=>"https://www.starred.com/#"}, {"type"=>"x-website", "url"=>"https://www.starred.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
the-guardian{"the-guardian-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"The Guardian", "x-complete"=>1, "info"=>{"title"=>"The Guardian", "description"=>"the-guardian-content-api-is-a-public-service-for-accessing-all-the-content-the-guardian-creates-and-the-collections-we-have-of-that-content-tags-and-sections--there-are-over-one-and-a-half-million-items-available-published-as-far-back-as-1999--this-overview-will-give-you-some-idea-of-what-data-is-available-how-to-find-what-you-need-and-what-you-will-see-when-you-make-a-request-to-us-", "version"=>"v1"}, "host"=>"content.guardianapis.com", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/search"=>{"get"=>{"summary"=>"Search", "description"=>"Searches news content across the Guardian news platform.", "operationId"=>"search", "x-api-path-slug"=>"search-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News"]}}, "/tags"=>{"get"=>{"summary"=>"Tags", "description"=>"Retrieves the tags used across the Guardian news platform.", "operationId"=>"tags", "x-api-path-slug"=>"tags-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/sections"=>{"get"=>{"summary"=>"Sections", "description"=>"Retrieves the sections used across the Guardian news platform.", "operationId"=>"sections", "x-api-path-slug"=>"sections-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News"]}}, "/editions"=>{"get"=>{"summary"=>"Editions", "description"=>"Retrieves the editions of the Guardian news platform.", "operationId"=>"editions", "x-api-path-slug"=>"editions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News"]}}}}, "apis"=>{"name"=>"The Guardian", "x-slug"=>"the-guardian", "description"=>"The Guardian is a British national daily newspaper which has grown into a national paper associated with a complex organisational structure and an international multimedia and web presence. The Guardian provides API access to articles accessible by tag and section, and a suite of open source data and tools. The Guardian makes content accessible to increase traffic, brand awareness, and as a marketing vehicle, including partnership opportunities via platform program.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/the-guardian-logo.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API United Kingdom,Data,General Data,Media,News,Pedestal,Relative Data,Relative StreamRank,Service API,Streams,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"the-guardian/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"The Guardian", "x-api-slug"=>"the-guardian", "description"=>"The Content API is a public service for accessing all the content the Guardian creates and the collections we have of that content (tags and sections). There are over one and a half million items available published as far back as 1999. This overview will give you some idea of what data is available, how to find what you need, and what you will see when you make a request to us.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/the-guardian-logo.png", "humanURL"=>"http://www.guardian.co.uk/open-platform", "baseURL"=>"https://content.guardianapis.com/", "tags"=>"API United Kingdom,Data,General Data,Media,News,Pedestal,Relative Data,Relative StreamRank,Service API,Streams,Streams,Streams", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/the-guardian/the-guardian-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-access-tiers", "url"=>"http://open-platform.theguardian.com/access/"}, {"type"=>"x-base", "url"=>"http://content.guardianapis.com/"}, {"type"=>"x-blog", "url"=>"http://www.theguardian.com/open-platform/blog"}, {"type"=>"x-blog-rss", "url"=>"http://www.theguardian.com/open-platform/blog/rss"}, {"type"=>"x-chrome-extension", "url"=>"http://www.theguardian.com/open-platform/blog/idio-guardian-chrome-extension"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/organization/the-guardian"}, {"type"=>"x-documentation", "url"=>"http://open-platform.theguardian.com/documentation/"}, {"type"=>"x-email", "url"=>"openplatform@guardian.co.uk"}, {"type"=>"x-events", "url"=>"http://developers.theguardian.com/events-&-talks.html"}, {"type"=>"x-explorer", "url"=>"http://open-platform.theguardian.com/explore/"}, {"type"=>"x-faq", "url"=>"http://www.theguardian.com/open-platform/faq"}, {"type"=>"x-forum", "url"=>"http://groups.google.com/group/guardian-api-talk/"}, {"type"=>"x-getting-started", "url"=>"http://www.theguardian.com/open-platform/getting-started"}, {"type"=>"x-github", "url"=>"https://github.com/guardian"}, {"type"=>"x-java-library", "url"=>"http://code.google.com/p/openplatform-java/w/list"}, {"type"=>"x-partners", "url"=>"http://www.theguardian.com/open-platform/partner-programs"}, {"type"=>"x-php-library", "url"=>"http://code.google.com/p/openplatform-php/"}, {"type"=>"x-python-library", "url"=>"http://code.google.com/p/openplatform-python/"}, {"type"=>"x-selfservice-registration", "url"=>"http://guardian.mashery.com/member/register"}, {"type"=>"x-slideshare", "url"=>"http://www.slideshare.net/openplatform"}, {"type"=>"x-terms-of-service", "url"=>"http://www.theguardian.com/open-platform/terms-and-conditions"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/gdndevelopers"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/GuardianData"}, {"type"=>"x-website", "url"=>"http://www.guardian.co.uk/open-platform"}, {"type"=>"x-wikipedia-", "url"=>"http://en.wikipedia.org/wiki/The_Guardian"}, {"type"=>"x-wordpress-plugin", "url"=>"http://www.theguardian.com/open-platform/news-feed-wordpress-plugin"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
blockchain{"blockchain-info-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Blockchain", "x-complete"=>1, "info"=>{"title"=>"Blockchain Info", "description"=>"use-blockchains-apis-at-no-cost-to-help-you-start-building-bitcoin-apps-", "version"=>"1.0.0"}, "host"=>"blockchain.info", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/ticker"=>{"get"=>{"summary"=>"Ticker", "description"=>"Returns a JSON object with the currency codes as keys. \"15m\" is the 15 minutes delayed market price, \"last\" is the most recent market price, \"symbol\" is the currency symbol.", "operationId"=>"getTicker", "x-api-path-slug"=>"ticker-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Ticker"]}}, "/tobtc"=>{"get"=>{"summary"=>"Convert", "description"=>"Convert x value in the provided currency to btc.", "operationId"=>"convertToBTC", "x-api-path-slug"=>"tobtc-get", "parameters"=>[{"in"=>"query", "name"=>"currency", "description"=>"A currency code", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"value", "description"=>"Value to convert", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Conversion"]}}, "/stats"=>{"get"=>{"summary"=>"Stats", "description"=>"This method can be used to get the data behind Blockchain.info's stats.", "operationId"=>"getStats", "x-api-path-slug"=>"stats-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The format to return (json,html)", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Statistics"]}}, "/pools"=>{"get"=>{"summary"=>"Pools", "description"=>"This method can be used to get the data behind Blockchain.info's pools information.", "operationId"=>"getPools", "x-api-path-slug"=>"pools-get", "parameters"=>[{"in"=>"query", "name"=>"timespan", "description"=>"Duration over which the data is computed, maximum 10 days, default is 4 days (ie", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Pools"]}}, "/rawblock/{block_hash}"=>{"get"=>{"summary"=>"Raw Block", "description"=>"Returns a single raw block.", "operationId"=>"getRawBlock", "x-api-path-slug"=>"rawblockblock-hash-get", "parameters"=>[{"in"=>"path", "name"=>"block_hash", "description"=>"The block hash", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Blocks"]}}, "/rawtx/{tx_hash}"=>{"get"=>{"summary"=>"Raw Transaction", "description"=>"Returns a raw trasaction.", "operationId"=>"getRawTransaction", "x-api-path-slug"=>"rawtxtx-hash-get", "parameters"=>[{"in"=>"query", "name"=>"tx_hash", "description"=>"The hash", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Transactions"]}}, "Blockchain,s"=>{"get"=>{"summary"=>"Chart Type", "description"=>"Returns chart types.", "operationId"=>"getChartType", "x-api-path-slug"=>"blockchains-get", "parameters"=>[{"in"=>"path", "name"=>"chart-type", "description"=>"The chart type", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Charts"]}}, "/block-height/{block_height}"=>{"get"=>{"summary"=>"Block Height", "description"=>"Returns the height of block.", "operationId"=>"getBlockHeight", "x-api-path-slug"=>"blockheightblock-height-get", "parameters"=>[{"in"=>"path", "name"=>"block_height", "description"=>"The block height", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Height"]}}, "/rawaddr/{bitcoin_address}"=>{"get"=>{"summary"=>"Raw Address", "description"=>"Returns a single blockchain address.", "operationId"=>"getRawAddress", "x-api-path-slug"=>"rawaddrbitcoin-address-get", "parameters"=>[{"in"=>"path", "name"=>"bitcoin_address", "description"=>"The bitcoin address", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Addresses"]}}, "/multiaddr"=>{"get"=>{"summary"=>"Multi Adress", "description"=>"Returns multiple addresses", "operationId"=>"getMultipleAddresses", "x-api-path-slug"=>"multiaddr-get", "parameters"=>[{"in"=>"query", "name"=>"active", "description"=>"Multiple addresses divided by | Address can be base58 or xpub", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Addresses"]}}, "/unspent"=>{"get"=>{"summary"=>"Unspent", "description"=>"Unspent output.", "operationId"=>"getUnspentOutput", "x-api-path-slug"=>"unspent-get", "parameters"=>[{"in"=>"query", "name"=>"active", "description"=>"Multiple addresses divided by | Address can be base58 or xpub", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Output"]}}, "/balance"=>{"get"=>{"summary"=>"Balance", "description"=>"Returns current balance", "operationId"=>"getBalance", "x-api-path-slug"=>"balance-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Balance"]}}, "/latestblock"=>{"get"=>{"summary"=>"Latest Block", "description"=>"Gets the latest block.", "operationId"=>"getLatestBlock", "x-api-path-slug"=>"latestblock-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The format to return (json,html)", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Latest"]}}, "/unconfirmed-transactions"=>{"get"=>{"summary"=>"Unconfirmed Transactions", "description"=>"Returns unconfirmed transactions.", "operationId"=>"getUnconfirmedTransactions", "x-api-path-slug"=>"unconfirmedtransactions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Transactions"]}}, "/blocks/{time_in_milliseconds}"=>{"get"=>{"summary"=>"Blocks for One Day", "description"=>"Returns the blocks for one day by the millisecond", "operationId"=>"getBlocksOneDay", "x-api-path-slug"=>"blockstime-in-milliseconds-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The format to return (json,html)", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"time_in_milliseconds", "description"=>"The time in milliseconds (ie", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain"]}}, "/blocks/{pool_name}"=>{"get"=>{"summary"=>"Blocks by Pool", "description"=>"Returns the blocks for one pool.", "operationId"=>"getPoolBlocks", "x-api-path-slug"=>"blockspool-name-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The format to return (json,html)", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"pool_name", "description"=>"The pool name", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Pools"]}}}}, "apis"=>{"name"=>"Blockchain", "x-slug"=>"blockchain", "description"=>"With the largest bitcoin wallet platform in the world, Blockchains software has powered over 100M transactions and empowered users in 130 countries across the globe to transact quickly and without costly intermediaries. We also offers tools for develo...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28138-blockchain-info.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"3499", "tags"=>"API Provider,Blockchains,General Data,internet,Marketplace,Profiles,Relative Data,Relative StreamRank,SaaS,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"blockchain/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Blockchain Info", "x-api-slug"=>"blockchain-info", "description"=>"With the largest bitcoin wallet platform in the world, Blockchains software has powered over 100M transactions and empowered users in 130 countries across the globe to transact quickly and without costly intermediaries. We also offers tools for develo...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28138-blockchain-info.jpg", "humanURL"=>"https://blockchain.info", "baseURL"=>"https://blockchain.info/", "tags"=>"API Provider,Blockchains,General Data,internet,Marketplace,Profiles,Relative Data,Relative StreamRank,SaaS,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/blockchain/blockchain-info-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/blockchain-info"}, {"type"=>"x-documentation", "url"=>"https://blockchain.info/api"}, {"type"=>"x-github", "url"=>"https://github.com/blockchain"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/blockchain"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/blockchain"}, {"type"=>"x-website", "url"=>"https://blockchain.info"}, {"type"=>"x-websockets", "url"=>"https://blockchain.info/api/api_websocket"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-classroom{"google-classroom-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Classroom", "x-complete"=>1, "info"=>{"title"=>"Google Classroom", "description"=>"manages-classes-rosters-and-invitations-in-google-classroom-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"classroom.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/courses"=>{"get"=>{"summary"=>"Get Courses", "description"=>"Returns a list of courses that the requesting user is permitted to view,\nrestricted to those that match the request.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND` if any users specified in the query arguments do not exist.", "operationId"=>"classroom.courses.list", "x-api-path-slug"=>"v1courses-get", "parameters"=>[{"in"=>"query", "name"=>"courseStates", "description"=>"Restricts returned courses to those in one of the specified statesThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Maximum number of items to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"nextPageTokenvalue returned from a previouslist call,indicating that the subsequent page of results should be returned"}, {"in"=>"query", "name"=>"studentId", "description"=>"Restricts returned courses to those having a student with the specifiedidentifier"}, {"in"=>"query", "name"=>"teacherId", "description"=>"Restricts returned courses to those having a teacher with the specifiedidentifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Course"]}, "post"=>{"summary"=>"Create Course", "description"=>"Creates a course.\n\nThe user specified in `ownerId` is the owner of the created course\nand added as a teacher.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the course owner's account is disabled or for\nthe following request errors:\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in the `id` and\nalready exists.", "operationId"=>"classroom.courses.create", "x-api-path-slug"=>"v1courses-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Course"]}}, "/v1/courses/{courseId}/aliases"=>{"get"=>{"summary"=>"Get Aliases", "description"=>"Returns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\ncourse or for access errors.\n* `NOT_FOUND` if the course does not exist.", "operationId"=>"classroom.courses.aliases.list", "x-api-path-slug"=>"v1coursescourseidaliases-get", "parameters"=>[{"in"=>"path", "name"=>"courseId", "description"=>"The identifier of the course"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Maximum number of items to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"nextPageTokenvalue returned from a previouslist call,indicating that the subsequent page of results should be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alias"]}, "post"=>{"summary"=>"Create Alias", "description"=>"Creates an alias for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create the\nalias or for access errors.\n* `NOT_FOUND` if the course does not exist.\n* `ALREADY_EXISTS` if the alias already exists.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to access a domain-scoped alias).", "operationId"=>"classroom.courses.aliases.create", "x-api-path-slug"=>"v1coursescourseidaliases-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course to alias"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alias"]}}, "/v1/courses/{courseId}/aliases/{alias}"=>{"delete"=>{"summary"=>"Delete Alias", "description"=>"Deletes an alias of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to remove the\nalias or for access errors.\n* `NOT_FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to delete a domain-scoped alias).", "operationId"=>"classroom.courses.aliases.delete", "x-api-path-slug"=>"v1coursescourseidaliasesalias-delete", "parameters"=>[{"in"=>"path", "name"=>"alias", "description"=>"Alias to delete"}, {"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course whose alias should be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alias"]}}, "/v1/courses/{courseId}/courseWork"=>{"get"=>{"summary"=>"Get Course Work", "description"=>"Returns a list of course work that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers\nand domain administrators may view all course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.", "operationId"=>"classroom.courses.courseWork.list", "x-api-path-slug"=>"v1coursescourseidcoursework-get", "parameters"=>[{"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"query", "name"=>"courseWorkStates", "description"=>"Restriction on the work status to return"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Optional sort ordering for results"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Maximum number of items to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"nextPageTokenvalue returned from a previouslist call,indicating that the subsequent page of results should be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alias"]}, "post"=>{"summary"=>"Create Course Work", "description"=>"Creates course work.\n\nThe resulting course work (and corresponding student submissions) are\nassociated with the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\nmake the request. Classroom API requests to modify course work and student\nsubmissions must be made with an OAuth client ID from the associated\nDeveloper Console project.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create course work in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible", "operationId"=>"classroom.courses.courseWork.create", "x-api-path-slug"=>"v1coursescourseidcoursework-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Course Work"]}}, "/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions"=>{"get"=>{"summary"=>"Get Student Submissions", "description"=>"Returns a list of student submissions that the requester is permitted to\nview, factoring in the OAuth scopes of the request.\n`-` may be specified as the `course_work_id` to include student\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.", "operationId"=>"classroom.courses.courseWork.studentSubmissions.list", "x-api-path-slug"=>"v1coursescourseidcourseworkcourseworkidstudentsubmissions-get", "parameters"=>[{"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"path", "name"=>"courseWorkId", "description"=>"Identifer of the student work to request"}, {"in"=>"query", "name"=>"late", "description"=>"Requested lateness value"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Maximum number of items to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"nextPageTokenvalue returned from a previouslist call,indicating that the subsequent page of results should be returned"}, {"in"=>"query", "name"=>"states", "description"=>"Requested submission states"}, {"in"=>"query", "name"=>"userId", "description"=>"Optional argument to restrict returned student work to those owned by thestudent with the specified identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Student Submission"]}}, "/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}"=>{"get"=>{"summary"=>"Get Student Submission", "description"=>"Returns a student submission.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", "operationId"=>"classroom.courses.courseWork.studentSubmissions.get", "x-api-path-slug"=>"v1coursescourseidcourseworkcourseworkidstudentsubmissionsid-get", "parameters"=>[{"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"path", "name"=>"courseWorkId", "description"=>"Identifier of the course work"}, {"in"=>"path", "name"=>"id", "description"=>"Identifier of the student submission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Student Submission"]}, "patch"=>{"summary"=>"Update Fields", "description"=>"Updates one or more fields of a student submission.\n\nSee google.classroom.v1.StudentSubmission for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", "operationId"=>"classroom.courses.courseWork.studentSubmissions.patch", "x-api-path-slug"=>"v1coursescourseidcourseworkcourseworkidstudentsubmissionsid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"path", "name"=>"courseWorkId", "description"=>"Identifier of the course work"}, {"in"=>"path", "name"=>"id", "description"=>"Identifier of the student submission"}, {"in"=>"query", "name"=>"updateMask", "description"=>"Mask that identifies which fields on the student submission to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Field"]}}, "/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments"=>{"post"=>{"summary"=>"Modify Attachments", "description"=>"Modifies attachments of student submission.\n\nAttachments may only be added to student submissions belonging to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, if the user is not permitted to modify\nattachments on the requested student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", "operationId"=>"classroom.courses.courseWork.studentSubmissions.modifyAttachments", "x-api-path-slug"=>"v1coursescourseidcourseworkcourseworkidstudentsubmissionsidmodifyattachments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"path", "name"=>"courseWorkId", "description"=>"Identifier of the course work"}, {"in"=>"path", "name"=>"id", "description"=>"Identifier of the student submission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim"=>{"post"=>{"summary"=>"Reclaim Student Submission", "description"=>"Reclaims a student submission on behalf of the student that owns it.\n\nReclaiming a student submission transfers ownership of attached Drive\nfiles to the student and update the submission state.\n\nOnly the student that owns the requested student submission may call this\nmethod, and only for a student submission that has been turned in.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, unsubmit the requested student submission,\nor for access errors.\n* `FAILED_PRECONDITION` if the student submission has not been turned in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", "operationId"=>"classroom.courses.courseWork.studentSubmissions.reclaim", "x-api-path-slug"=>"v1coursescourseidcourseworkcourseworkidstudentsubmissionsidreclaim-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"path", "name"=>"courseWorkId", "description"=>"Identifier of the course work"}, {"in"=>"path", "name"=>"id", "description"=>"Identifier of the student submission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Student Submission"]}}, "/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return"=>{"post"=>{"summary"=>"Get Student Submission", "description"=>"Returns a student submission.\n\nReturning a student submission transfers ownership of attached Drive\nfiles to the student and may also update the submission state.\nUnlike the Classroom application, returning a student submission does not\nset assignedGrade to the draftGrade value.\n\nOnly a teacher of the course that contains the requested student submission\nmay call this method.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, return the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", "operationId"=>"classroom.courses.courseWork.studentSubmissions.return", "x-api-path-slug"=>"v1coursescourseidcourseworkcourseworkidstudentsubmissionsidreturn-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"path", "name"=>"courseWorkId", "description"=>"Identifier of the course work"}, {"in"=>"path", "name"=>"id", "description"=>"Identifier of the student submission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Student Submission"]}}, "/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn"=>{"post"=>{"summary"=>"Turn in Student Submission", "description"=>"Turns in a student submission.\n\nTurning in a student submission transfers ownership of attached Drive\nfiles to the teacher and may also update the submission state.\n\nThis may only be called by the student that owns the specified student\nsubmission.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, turn in the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", "operationId"=>"classroom.courses.courseWork.studentSubmissions.turnIn", "x-api-path-slug"=>"v1coursescourseidcourseworkcourseworkidstudentsubmissionsidturnin-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"path", "name"=>"courseWorkId", "description"=>"Identifier of the course work"}, {"in"=>"path", "name"=>"id", "description"=>"Identifier of the student submission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Student Submission"]}}, "/v1/courses/{courseId}/courseWork/{id}"=>{"delete"=>{"summary"=>"Delete Course Work", "description"=>"Deletes a course work.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID.", "operationId"=>"classroom.courses.courseWork.delete", "x-api-path-slug"=>"v1coursescourseidcourseworkid-delete", "parameters"=>[{"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"path", "name"=>"id", "description"=>"Identifier of the course work to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Course Work"]}, "get"=>{"summary"=>"Get Course Work", "description"=>"Returns course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.", "operationId"=>"classroom.courses.courseWork.get", "x-api-path-slug"=>"v1coursescourseidcourseworkid-get", "parameters"=>[{"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"path", "name"=>"id", "description"=>"Identifier of the course work"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Course Work"]}, "patch"=>{"summary"=>"Update Fields", "description"=>"Updates one or more fields of a course work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", "operationId"=>"classroom.courses.courseWork.patch", "x-api-path-slug"=>"v1coursescourseidcourseworkid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"path", "name"=>"id", "description"=>"Identifier of the course work"}, {"in"=>"query", "name"=>"updateMask", "description"=>"Mask that identifies which fields on the course work to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Field"]}}, "/v1/courses/{courseId}/students"=>{"get"=>{"summary"=>"Get Students", "description"=>"Returns a list of students of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.", "operationId"=>"classroom.courses.students.list", "x-api-path-slug"=>"v1coursescourseidstudents-get", "parameters"=>[{"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Maximum number of items to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"nextPageTokenvalue returned from a previouslist call, indicating thatthe subsequent page of results should be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Student"]}, "post"=>{"summary"=>"Add Student", "description"=>"Adds a user as a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nstudents in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a student or teacher in the\ncourse.", "operationId"=>"classroom.courses.students.create", "x-api-path-slug"=>"v1coursescourseidstudents-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course to create the student in"}, {"in"=>"query", "name"=>"enrollmentCode", "description"=>"Enrollment code of the course to create the student in"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Student"]}}, "/v1/courses/{courseId}/students/{userId}"=>{"delete"=>{"summary"=>"Delete Student", "description"=>"Deletes a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.", "operationId"=>"classroom.courses.students.delete", "x-api-path-slug"=>"v1coursescourseidstudentsuserid-delete", "parameters"=>[{"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"path", "name"=>"userId", "description"=>"Identifier of the student to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Student"]}, "get"=>{"summary"=>"Get Student", "description"=>"Returns a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.", "operationId"=>"classroom.courses.students.get", "x-api-path-slug"=>"v1coursescourseidstudentsuserid-get", "parameters"=>[{"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"path", "name"=>"userId", "description"=>"Identifier of the student to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Student"]}}, "/v1/courses/{courseId}/teachers"=>{"get"=>{"summary"=>"Get Teachers", "description"=>"Returns a list of teachers of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.", "operationId"=>"classroom.courses.teachers.list", "x-api-path-slug"=>"v1coursescourseidteachers-get", "parameters"=>[{"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Maximum number of items to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"nextPageTokenvalue returned from a previouslist call, indicating thatthe subsequent page of results should be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teacher"]}, "post"=>{"summary"=>"Create Teacher", "description"=>"Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse.", "operationId"=>"classroom.courses.teachers.create", "x-api-path-slug"=>"v1coursescourseidteachers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teacher"]}}, "/v1/courses/{courseId}/teachers/{userId}"=>{"delete"=>{"summary"=>"Delete Teacher", "description"=>"Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course.", "operationId"=>"classroom.courses.teachers.delete", "x-api-path-slug"=>"v1coursescourseidteachersuserid-delete", "parameters"=>[{"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"path", "name"=>"userId", "description"=>"Identifier of the teacher to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teacher"]}, "get"=>{"summary"=>"Get Teacher", "description"=>"Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.", "operationId"=>"classroom.courses.teachers.get", "x-api-path-slug"=>"v1coursescourseidteachersuserid-get", "parameters"=>[{"in"=>"path", "name"=>"courseId", "description"=>"Identifier of the course"}, {"in"=>"path", "name"=>"userId", "description"=>"Identifier of the teacher to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teacher"]}}, "/v1/courses/{id}"=>{"delete"=>{"summary"=>"Delete Course", "description"=>"Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.", "operationId"=>"classroom.courses.delete", "x-api-path-slug"=>"v1coursesid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Identifier of the course to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Course"]}, "get"=>{"summary"=>"Get Course", "description"=>"Returns a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.", "operationId"=>"classroom.courses.get", "x-api-path-slug"=>"v1coursesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Identifier of the course to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Course"]}, "patch"=>{"summary"=>"Update Fields", "description"=>"Updates one or more fields in a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable", "operationId"=>"classroom.courses.patch", "x-api-path-slug"=>"v1coursesid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Identifier of the course to update"}, {"in"=>"query", "name"=>"updateMask", "description"=>"Mask that identifies which fields on the course to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Field"]}, "put"=>{"summary"=>"Update Course", "description"=>"Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable", "operationId"=>"classroom.courses.update", "x-api-path-slug"=>"v1coursesid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Identifier of the course to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Course"]}}, "/v1/invitations"=>{"get"=>{"summary"=>"Get Invitations", "description"=>"Returns a list of invitations that the requesting user is permitted to\nview, restricted to those that match the list request.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nfields can be supplied.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.", "operationId"=>"classroom.invitations.list", "x-api-path-slug"=>"v1invitations-get", "parameters"=>[{"in"=>"query", "name"=>"courseId", "description"=>"Restricts returned invitations to those for a course with the specifiedidentifier"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Maximum number of items to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"nextPageTokenvalue returned from a previouslist call, indicatingthat the subsequent page of results should be returned"}, {"in"=>"query", "name"=>"userId", "description"=>"Restricts returned invitations to those for a specific user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invitation"]}, "post"=>{"summary"=>"Create Invitation", "description"=>"Creates an invitation. Only one invitation for a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ninvitations for this course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREADY_EXISTS` if an invitation for the specified user and course\nalready exists.", "operationId"=>"classroom.invitations.create", "x-api-path-slug"=>"v1invitations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invitation"]}}, "/v1/invitations/{id}"=>{"delete"=>{"summary"=>"Delete Invitation", "description"=>"Deletes an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.", "operationId"=>"classroom.invitations.delete", "x-api-path-slug"=>"v1invitationsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Identifier of the invitation to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invitation"]}, "get"=>{"summary"=>"Get Invitation", "description"=>"Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.", "operationId"=>"classroom.invitations.get", "x-api-path-slug"=>"v1invitationsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Identifier of the invitation to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invitation"]}}, "/v1/invitations/{id}:accept"=>{"post"=>{"summary"=>"Accept Invitation", "description"=>"Accepts an invitation, removing it and adding the invited user to the\nteachers or students (as appropriate) of the specified course. Only the\ninvited user may accept an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to accept the\nrequested invitation or for access errors.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested ID.", "operationId"=>"classroom.invitations.accept", "x-api-path-slug"=>"v1invitationsidaccept-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Identifier of the invitation to accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invitation"]}}, "/v1/userProfiles/{studentId}/guardianInvitations"=>{"get"=>{"summary"=>"Get Guardian Invitations", "description"=>"Returns a list of guardian invitations that the requesting user is\npermitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.", "operationId"=>"classroom.userProfiles.guardianInvitations.list", "x-api-path-slug"=>"v1userprofilesstudentidguardianinvitations-get", "parameters"=>[{"in"=>"query", "name"=>"invitedEmailAddress", "description"=>"If specified, only results with the specified `invited_email_address`will be returned"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Maximum number of items to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"nextPageTokenvalue returned from a previouslist call,indicating that the subsequent page of results should be returned"}, {"in"=>"query", "name"=>"states", "description"=>"If specified, only results with the specified `state` values will bereturned"}, {"in"=>"path", "name"=>"studentId", "description"=>"The ID of the student whose guardian invitations are to be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guardian Invitation"]}, "post"=>{"summary"=>"Create Guardian Invitation", "description"=>"Creates a guardian invitation, and sends an email to the guardian asking\nthem to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to\n`COMPLETED` and they will start receiving guardian notifications. A\n`Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `student_id` and\n`invited_email_address` fields set. Failing to set these fields, or\nsetting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if the guardian in question has already rejected\n too many requests for that student, if guardians are not enabled for the\n domain in question, or for other access errors.\n* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian\n link limit.\n* `INVALID_ARGUMENT` if the guardian email address is not valid (for\n example, if it is too long), or if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API). This error will also be returned if read-only fields are set,\n or if the `state` field is set to to a value other than `PENDING`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student.\n* `ALREADY_EXISTS` if there is already a pending guardian invitation for\n the student and `invited_email_address` provided, or if the provided\n `invited_email_address` matches the Google account of an existing\n `Guardian` for this user.", "operationId"=>"classroom.userProfiles.guardianInvitations.create", "x-api-path-slug"=>"v1userprofilesstudentidguardianinvitations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"studentId", "description"=>"ID of the student (in standard format)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guardian Invitation"]}}, "/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}"=>{"get"=>{"summary"=>"Get Guardian Invitation", "description"=>"Returns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\n guardian invitations for the student identified by the `student_id`, if\n guardians are not enabled for the domain in question, or for other\n access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if Classroom cannot find any record of the given student or\n `invitation_id`. May also be returned if the student exists, but the\n requesting user does not have access to see that student.", "operationId"=>"classroom.userProfiles.guardianInvitations.get", "x-api-path-slug"=>"v1userprofilesstudentidguardianinvitationsinvitationid-get", "parameters"=>[{"in"=>"path", "name"=>"invitationId", "description"=>"The `id` field of the `GuardianInvitation` being requested"}, {"in"=>"path", "name"=>"studentId", "description"=>"The ID of the student whose guardian invitation is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guardian Invitation"]}, "patch"=>{"summary"=>"Update Guardian Invitations", "description"=>"Modifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from\n`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled for the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `state`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student, or if the `id` field does not\n refer to a guardian invitation known to Classroom.", "operationId"=>"classroom.userProfiles.guardianInvitations.patch", "x-api-path-slug"=>"v1userprofilesstudentidguardianinvitationsinvitationid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"invitationId", "description"=>"The `id` field of the `GuardianInvitation` to be modified"}, {"in"=>"path", "name"=>"studentId", "description"=>"The ID of the student whose guardian invitation is to be modified"}, {"in"=>"query", "name"=>"updateMask", "description"=>"Mask that identifies which fields on the course to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guardian Invitation"]}}, "/v1/userProfiles/{studentId}/guardians"=>{"get"=>{"summary"=>"Get Guardians", "description"=>"Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view\nguardians for, use the literal character `-` for the student ID.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian information for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n if the `invited_email_address` filter is set by a user who is not a\n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.", "operationId"=>"classroom.userProfiles.guardians.list", "x-api-path-slug"=>"v1userprofilesstudentidguardians-get", "parameters"=>[{"in"=>"query", "name"=>"invitedEmailAddress", "description"=>"Filter results by the email address that the original invitation was sentto, resulting in this guardian link"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Maximum number of items to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"nextPageTokenvalue returned from a previouslist call,indicating that the subsequent page of results should be returned"}, {"in"=>"path", "name"=>"studentId", "description"=>"Filter results by the student who the guardian is linked to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guardian"]}}, "/v1/userProfiles/{studentId}/guardians/{guardianId}"=>{"delete"=>{"summary"=>"Delete Guardian", "description"=>"Deletes a guardian.\n\nThe guardian will no longer receive guardian notifications and the guardian\nwill no longer be accessible via the API.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to manage guardians for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API).\n* `NOT_FOUND` if the requesting user is permitted to modify guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student with the provided `guardian_id`.", "operationId"=>"classroom.userProfiles.guardians.delete", "x-api-path-slug"=>"v1userprofilesstudentidguardiansguardianid-delete", "parameters"=>[{"in"=>"path", "name"=>"guardianId", "description"=>"The `id` field from a `Guardian`"}, {"in"=>"path", "name"=>"studentId", "description"=>"The student whose guardian is to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guardian"]}, "get"=>{"summary"=>"Get Guardian", "description"=>"Returns a specific guardian.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to view guardian information for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if the requesting user is permitted to view guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student that matches the provided `guardian_id`.", "operationId"=>"classroom.userProfiles.guardians.get", "x-api-path-slug"=>"v1userprofilesstudentidguardiansguardianid-get", "parameters"=>[{"in"=>"path", "name"=>"guardianId", "description"=>"The `id` field from a `Guardian`"}, {"in"=>"path", "name"=>"studentId", "description"=>"The student whose guardian is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guardian"]}}, "/v1/userProfiles/{userId}"=>{"get"=>{"summary"=>"Get User", "description"=>"Returns a user profile.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthis user profile, if no profile exists with the requested ID, or for\naccess errors.", "operationId"=>"classroom.userProfiles.get", "x-api-path-slug"=>"v1userprofilesuserid-get", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"Identifier of the profile to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}}}, "apis"=>{"name"=>"Google Classroom", "x-slug"=>"google-classroom", "description"=>"Google Classroom is mission control for your classes. As a free service for teachers and students, you can create classes, distribute assignments, send feedback, and see everything in one place. Instant. Paperless. Easy.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-classroom.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Education,Google APIs,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-classroom/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Classroom API", "x-api-slug"=>"google-classroom-api", "description"=>"Google Classroom is mission control for your classes. As a free service for teachers and students, you can create classes, distribute assignments, send feedback, and see everything in one place. Instant. Paperless. Easy.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-classroom.png", "humanURL"=>"https://classroom.google.com/", "baseURL"=>"://classroom.googleapis.com//", "tags"=>"API Provider,API Service Provider,Education,Google APIs,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-classroom/google-classroom-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-button", "url"=>"https://developers.google.com/classroom/guides/sharebutton"}, {"type"=>"x-developer", "url"=>"https://developers.google.com/classroom/"}, {"type"=>"x-getting-started", "url"=>""}, {"type"=>"x-issues", "url"=>"https://code.google.com/a/google.com/p/apps-api-issues/issues/list?can=2&q=label%3AAPI-Classroom"}, {"type"=>"x-website", "url"=>"https://classroom.google.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-genomics{"google-genomics-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Genomics", "x-complete"=>1, "info"=>{"title"=>"Genomics", "description"=>"upload-process-query-and-search-genomics-data-in-the-cloud-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"genomics.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/annotations"=>{"post"=>{"summary"=>"Create Annotation", "description"=>"Creates a new annotation. Caller must have WRITE permission\nfor the associated annotation set.\n\nThe following fields are required:\n\n* annotationSetId\n* referenceName or\n referenceId\n\n### Transcripts\n\nFor annotations of type TRANSCRIPT, the following fields of\ntranscript must be provided:\n\n* exons.start\n* exons.end\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field). The annotated\nrange must be no longer than 100Mbp (mega base pairs). See the\nAnnotation resource\nfor additional restrictions on each field.", "operationId"=>"genomics.annotations.create", "x-api-path-slug"=>"v1annotations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation"]}}, "/v1/annotations/search"=>{"post"=>{"summary"=>"Search Annotations", "description"=>"Searches for annotations that match the given criteria. Results are\nordered by genomic coordinate (by reference sequence, then position).\nAnnotations with equivalent genomic coordinates are returned in an\nunspecified order. This order is consistent, such that two queries for the\nsame content (regardless of page size) yield annotations in the same order\nacross their respective streams of paginated responses. Caller must have\nREAD permission for the queried annotation sets.", "operationId"=>"genomics.annotations.search", "x-api-path-slug"=>"v1annotationssearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation"]}}, "/v1/annotations/{annotationId}"=>{"delete"=>{"summary"=>"Delete Annotation", "description"=>"Deletes an annotation. Caller must have WRITE permission for\nthe associated annotation set.", "operationId"=>"genomics.annotations.delete", "x-api-path-slug"=>"v1annotationsannotationid-delete", "parameters"=>[{"in"=>"path", "name"=>"annotationId", "description"=>"The ID of the annotation to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation"]}, "get"=>{"summary"=>"Get Annotation", "description"=>"Gets an annotation. Caller must have READ permission\nfor the associated annotation set.", "operationId"=>"genomics.annotations.get", "x-api-path-slug"=>"v1annotationsannotationid-get", "parameters"=>[{"in"=>"path", "name"=>"annotationId", "description"=>"The ID of the annotation to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation"]}, "put"=>{"summary"=>"Update Annotation", "description"=>"Updates an annotation. Caller must have\nWRITE permission for the associated dataset.", "operationId"=>"genomics.annotations.update", "x-api-path-slug"=>"v1annotationsannotationid-put", "parameters"=>[{"in"=>"path", "name"=>"annotationId", "description"=>"The ID of the annotation to be updated"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"updateMask", "description"=>"An optional mask specifying which fields to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation"]}}, "/v1/annotations:batchCreate"=>{"post"=>{"summary"=>"Create Batch Annotation", "description"=>"Creates one or more new annotations atomically. All annotations must\nbelong to the same annotation set. Caller must have WRITE\npermission for this annotation set. For optimal performance, batch\npositionally adjacent annotations together.\n\nIf the request has a systemic issue, such as an attempt to write to\nan inaccessible annotation set, the entire RPC will fail accordingly. For\nlesser data issues, when possible an error will be isolated to the\ncorresponding batch entry in the response; the remaining well formed\nannotations will be created normally.\n\nFor details on the requirements for each individual annotation resource,\nsee\nCreateAnnotation.", "operationId"=>"genomics.annotations.batchCreate", "x-api-path-slug"=>"v1annotationsbatchcreate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation"]}}, "/v1/annotationsets"=>{"post"=>{"summary"=>"Create Annotation Set", "description"=>"Creates a new annotation set. Caller must have WRITE permission for the\nassociated dataset.\n\nThe following fields are required:\n\n * datasetId\n * referenceSetId\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field).", "operationId"=>"genomics.annotationsets.create", "x-api-path-slug"=>"v1annotationsets-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation Set"]}}, "/v1/annotationsets/search"=>{"post"=>{"summary"=>"Search Annotation Sets", "description"=>"Searches for annotation sets that match the given criteria. Annotation sets\nare returned in an unspecified order. This order is consistent, such that\ntwo queries for the same content (regardless of page size) yield annotation\nsets in the same order across their respective streams of paginated\nresponses. Caller must have READ permission for the queried datasets.", "operationId"=>"genomics.annotationsets.search", "x-api-path-slug"=>"v1annotationsetssearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation Set"]}}, "/v1/annotationsets/{annotationSetId}"=>{"delete"=>{"summary"=>"Delete Annotation Set", "description"=>"Deletes an annotation set. Caller must have WRITE permission\nfor the associated annotation set.", "operationId"=>"genomics.annotationsets.delete", "x-api-path-slug"=>"v1annotationsetsannotationsetid-delete", "parameters"=>[{"in"=>"path", "name"=>"annotationSetId", "description"=>"The ID of the annotation set to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation Set"]}, "get"=>{"summary"=>"Get Annotation Set", "description"=>"Gets an annotation set. Caller must have READ permission for\nthe associated dataset.", "operationId"=>"genomics.annotationsets.get", "x-api-path-slug"=>"v1annotationsetsannotationsetid-get", "parameters"=>[{"in"=>"path", "name"=>"annotationSetId", "description"=>"The ID of the annotation set to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation Set"]}, "put"=>{"summary"=>"Update Annotation Set", "description"=>"Updates an annotation set. The update must respect all mutability\nrestrictions and other invariants described on the annotation set resource.\nCaller must have WRITE permission for the associated dataset.", "operationId"=>"genomics.annotationsets.update", "x-api-path-slug"=>"v1annotationsetsannotationsetid-put", "parameters"=>[{"in"=>"path", "name"=>"annotationSetId", "description"=>"The ID of the annotation set to be updated"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"updateMask", "description"=>"An optional mask specifying which fields to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Annotation Set"]}}, "/v1/callsets"=>{"post"=>{"summary"=>"Create Call Set", "description"=>"Creates a new call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.callsets.create", "x-api-path-slug"=>"v1callsets-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call Set"]}}, "/v1/callsets/search"=>{"post"=>{"summary"=>"Search Call Sets", "description"=>"Gets a list of call sets matching the criteria.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178).", "operationId"=>"genomics.callsets.search", "x-api-path-slug"=>"v1callsetssearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call Set"]}}, "/v1/callsets/{callSetId}"=>{"delete"=>{"summary"=>"Delete Call Set", "description"=>"Deletes a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.callsets.delete", "x-api-path-slug"=>"v1callsetscallsetid-delete", "parameters"=>[{"in"=>"path", "name"=>"callSetId", "description"=>"The ID of the call set to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call Set"]}, "get"=>{"summary"=>"Get Call Set", "description"=>"Gets a call set by ID.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.callsets.get", "x-api-path-slug"=>"v1callsetscallsetid-get", "parameters"=>[{"in"=>"path", "name"=>"callSetId", "description"=>"The ID of the call set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call Set"]}, "patch"=>{"summary"=>"Update Call Set", "description"=>"Updates a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.", "operationId"=>"genomics.callsets.patch", "x-api-path-slug"=>"v1callsetscallsetid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"callSetId", "description"=>"The ID of the call set to be updated"}, {"in"=>"query", "name"=>"updateMask", "description"=>"An optional mask specifying which fields to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call Set"]}}, "/v1/datasets"=>{"get"=>{"summary"=>"Get Datasets", "description"=>"Lists datasets within a project.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.datasets.list", "x-api-path-slug"=>"v1datasets-get", "parameters"=>[{"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of results to return in a single page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The continuation token, which is used to page through large result sets"}, {"in"=>"query", "name"=>"projectId", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}, "post"=>{"summary"=>"Create Dataset", "description"=>"Creates a new dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.datasets.create", "x-api-path-slug"=>"v1datasets-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}}, "/v1/datasets/{datasetId}"=>{"delete"=>{"summary"=>"Delete Dataset", "description"=>"Deletes a dataset and all of its contents (all read group sets,\nreference sets, variant sets, call sets, annotation sets, etc.)\nThis is reversible (up to one week after the deletion) via\nthe\ndatasets.undelete\noperation.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.datasets.delete", "x-api-path-slug"=>"v1datasetsdatasetid-delete", "parameters"=>[{"in"=>"path", "name"=>"datasetId", "description"=>"The ID of the dataset to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}, "get"=>{"summary"=>"Get Dataset", "description"=>"Gets a dataset by ID.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.datasets.get", "x-api-path-slug"=>"v1datasetsdatasetid-get", "parameters"=>[{"in"=>"path", "name"=>"datasetId", "description"=>"The ID of the dataset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}, "patch"=>{"summary"=>"Update Dataset", "description"=>"Updates a dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.", "operationId"=>"genomics.datasets.patch", "x-api-path-slug"=>"v1datasetsdatasetid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"datasetId", "description"=>"The ID of the dataset to be updated"}, {"in"=>"query", "name"=>"updateMask", "description"=>"An optional mask specifying which fields to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}}, "/v1/datasets/{datasetId}:undelete"=>{"post"=>{"summary"=>"Restore Dataset", "description"=>"Undeletes a dataset by restoring a dataset which was deleted via this API.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis operation is only possible for a week after the deletion occurred.", "operationId"=>"genomics.datasets.undelete", "x-api-path-slug"=>"v1datasetsdatasetidundelete-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"datasetId", "description"=>"The ID of the dataset to be undeleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataset"]}}, "/v1/readgroupsets/search"=>{"post"=>{"summary"=>"Search Read Group Sets", "description"=>"Searches for read group sets matching the criteria.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135).", "operationId"=>"genomics.readgroupsets.search", "x-api-path-slug"=>"v1readgroupsetssearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Read Group Set"]}}, "/v1/readgroupsets/{readGroupSetId}"=>{"delete"=>{"summary"=>"Delete Read Group Set", "description"=>"Deletes a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.readgroupsets.delete", "x-api-path-slug"=>"v1readgroupsetsreadgroupsetid-delete", "parameters"=>[{"in"=>"path", "name"=>"readGroupSetId", "description"=>"The ID of the read group set to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Read Group Set"]}, "get"=>{"summary"=>"Get Read Group Set", "description"=>"Gets a read group set by ID.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.readgroupsets.get", "x-api-path-slug"=>"v1readgroupsetsreadgroupsetid-get", "parameters"=>[{"in"=>"path", "name"=>"readGroupSetId", "description"=>"The ID of the read group set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Read Group Set"]}, "patch"=>{"summary"=>"Update Read Group Set", "description"=>"Updates a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.", "operationId"=>"genomics.readgroupsets.patch", "x-api-path-slug"=>"v1readgroupsetsreadgroupsetid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"readGroupSetId", "description"=>"The ID of the read group set to be updated"}, {"in"=>"query", "name"=>"updateMask", "description"=>"An optional mask specifying which fields to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Read Group Set"]}}, "/v1/readgroupsets/{readGroupSetId}/coveragebuckets"=>{"get"=>{"summary"=>"Get Coverage Buckets for Read Group Set", "description"=>"Lists fixed width coverage buckets for a read group set, each of which\ncorrespond to a range of a reference sequence. Each bucket summarizes\ncoverage information across its corresponding genomic range.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nCoverage is defined as the number of reads which are aligned to a given\nbase in the reference sequence. Coverage buckets are available at several\nprecomputed bucket widths, enabling retrieval of various coverage 'zoom\nlevels'. The caller must have READ permissions for the target read group\nset.", "operationId"=>"genomics.readgroupsets.coveragebuckets.list", "x-api-path-slug"=>"v1readgroupsetsreadgroupsetidcoveragebuckets-get", "parameters"=>[{"in"=>"query", "name"=>"end", "description"=>"The end position of the range on the reference, 0-based exclusive"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of results to return in a single page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The continuation token, which is used to page through large result sets"}, {"in"=>"path", "name"=>"readGroupSetId", "description"=>"Required"}, {"in"=>"query", "name"=>"referenceName", "description"=>"The name of the reference to query, within the reference set associatedwith this query"}, {"in"=>"query", "name"=>"start", "description"=>"The start position of the range on the reference, 0-based inclusive"}, {"in"=>"query", "name"=>"targetBucketWidth", "description"=>"The desired width of each reported coverage bucket in base pairs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Read Group Set"]}}, "/v1/readgroupsets/{readGroupSetId}:export"=>{"post"=>{"summary"=>"Export Read Group Set", "description"=>"Exports a read group set to a BAM file in Google Cloud Storage.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nNote that currently there may be some differences between exported BAM\nfiles and the original BAM file at the time of import. See\nImportReadGroupSets\nfor caveats.", "operationId"=>"genomics.readgroupsets.export", "x-api-path-slug"=>"v1readgroupsetsreadgroupsetidexport-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"readGroupSetId", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Read Group Set"]}}, "/v1/readgroupsets:import"=>{"post"=>{"summary"=>"Create Read Group Set", "description"=>"Creates read group sets by asynchronously importing the provided\ninformation.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe caller must have WRITE permissions to the dataset.\n\n## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import\n\n- Tags will be converted to strings - tag types are not preserved\n- Comments (`@CO`) in the input file header will not be preserved\n- Original header order of references (`@SQ`) will not be preserved\n- Any reverse stranded unmapped reads will be reverse complemented, and\ntheir qualities (also the \"BQ\" and \"OQ\" tags, if any) will be reversed\n- Unmapped reads will be stripped of positional information (reference name\nand position)", "operationId"=>"genomics.readgroupsets.import", "x-api-path-slug"=>"v1readgroupsetsimport-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Read Group Set"]}}, "/v1/reads/search"=>{"post"=>{"summary"=>"Search Reads", "description"=>"Gets a list of reads for one or more read group sets.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nReads search operates over a genomic coordinate space of reference sequence\n& position defined over the reference sequences to which the requested\nread group sets are aligned.\n\nIf a target positional range is specified, search returns all reads whose\nalignment to the reference genome overlap the range. A query which\nspecifies only read group set IDs yields all reads in those read group\nsets, including unmapped reads.\n\nAll reads returned (including reads on subsequent pages) are ordered by\ngenomic coordinate (by reference sequence, then position). Reads with\nequivalent genomic coordinates are returned in an unspecified order. This\norder is consistent, such that two queries for the same content (regardless\nof page size) yield reads in the same order across their respective streams\nof paginated responses.\n\nImplements\n[GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85).", "operationId"=>"genomics.reads.search", "x-api-path-slug"=>"v1readssearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reads"]}}, "/v1/references/search"=>{"post"=>{"summary"=>"Search References", "description"=>"Searches for references which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).", "operationId"=>"genomics.references.search", "x-api-path-slug"=>"v1referencessearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reference"]}}, "/v1/references/{referenceId}"=>{"get"=>{"summary"=>"Get Reference", "description"=>"Gets a reference.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L158).", "operationId"=>"genomics.references.get", "x-api-path-slug"=>"v1referencesreferenceid-get", "parameters"=>[{"in"=>"path", "name"=>"referenceId", "description"=>"The ID of the reference"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reference"]}}, "/v1/references/{referenceId}/bases"=>{"get"=>{"summary"=>"Get Reference Base", "description"=>"Lists the bases in a reference, optionally restricted to a range.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221).", "operationId"=>"genomics.references.bases.list", "x-api-path-slug"=>"v1referencesreferenceidbases-get", "parameters"=>[{"in"=>"query", "name"=>"end", "description"=>"The end position (0-based, exclusive) of this query"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of bases to return in a single page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The continuation token, which is used to page through large result sets"}, {"in"=>"path", "name"=>"referenceId", "description"=>"The ID of the reference"}, {"in"=>"query", "name"=>"start", "description"=>"The start position (0-based) of this query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reference"]}}, "/v1/referencesets/search"=>{"post"=>{"summary"=>"Search Reference Set", "description"=>"Searches for reference sets which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)", "operationId"=>"genomics.referencesets.search", "x-api-path-slug"=>"v1referencesetssearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reference Set"]}}, "/v1/referencesets/{referenceSetId}"=>{"get"=>{"summary"=>"Get Reference Set", "description"=>"Gets a reference set.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).", "operationId"=>"genomics.referencesets.get", "x-api-path-slug"=>"v1referencesetsreferencesetid-get", "parameters"=>[{"in"=>"path", "name"=>"referenceSetId", "description"=>"The ID of the reference set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reference Set"]}}, "/v1/variants"=>{"post"=>{"summary"=>"Create Variant", "description"=>"Creates a new variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.variants.create", "x-api-path-slug"=>"v1variants-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variant"]}}, "/v1/variants/search"=>{"post"=>{"summary"=>"Get Variants", "description"=>"Gets a list of variants matching the criteria.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).", "operationId"=>"genomics.variants.search", "x-api-path-slug"=>"v1variantssearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variant"]}}, "/v1/variants/{variantId}"=>{"delete"=>{"summary"=>"Delete Variant", "description"=>"Deletes a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.variants.delete", "x-api-path-slug"=>"v1variantsvariantid-delete", "parameters"=>[{"in"=>"path", "name"=>"variantId", "description"=>"The ID of the variant to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variant"]}, "get"=>{"summary"=>"Get Variant", "description"=>"Gets a variant by ID.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.variants.get", "x-api-path-slug"=>"v1variantsvariantid-get", "parameters"=>[{"in"=>"path", "name"=>"variantId", "description"=>"The ID of the variant"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variant"]}, "patch"=>{"summary"=>"Update Variant", "description"=>"Updates a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics. Returns the modified variant without\nits calls.", "operationId"=>"genomics.variants.patch", "x-api-path-slug"=>"v1variantsvariantid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"updateMask", "description"=>"An optional mask specifying which fields to update"}, {"in"=>"path", "name"=>"variantId", "description"=>"The ID of the variant to be updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variant"]}}, "/v1/variants:import"=>{"post"=>{"summary"=>"Create Variant", "description"=>"Creates variant data by asynchronously importing the provided information.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe variants for import will be merged with any existing variant that\nmatches its reference sequence, start, end, reference bases, and\nalternative bases. If no such variant exists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant, and Variant info fields are merged\nas specified in\ninfoMergeConfig.\nAs a special case, for single-sample VCF files, QUAL and FILTER fields will\nbe moved to the call level; these are sometimes interpreted in a\ncall-specific context.\nImported VCF headers are appended to the metadata already in a variant set.", "operationId"=>"genomics.variants.import", "x-api-path-slug"=>"v1variantsimport-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variant"]}}, "/v1/variants:merge"=>{"post"=>{"summary"=>"Merge Variants", "description"=>"Merges the given variants with existing variants.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach variant will be\nmerged with an existing variant that matches its reference sequence,\nstart, end, reference bases, and alternative bases. If no such variant\nexists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant. Variant info fields are merged as\nspecified in the\ninfoMergeConfig\nfield of the MergeVariantsRequest.\n\nPlease exercise caution when using this method! It is easy to introduce\nmistakes in existing variants and difficult to back out of them. For\nexample,\nsuppose you were trying to merge a new variant with an existing one and\nboth\nvariants contain calls that belong to callsets with the same callset ID.\n\n // Existing variant - irrelevant fields trimmed for clarity\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 0,\n 1\n ],\n }\n ]\n }\n\n // New variant with conflicting call information\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThe resulting merged variant would overwrite the existing calls with those\nfrom the new variant:\n\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThis may be the desired outcome, but it is up to the user to determine if\nif that is indeed the case.", "operationId"=>"genomics.variants.merge", "x-api-path-slug"=>"v1variantsmerge-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variant"]}}, "/v1/variantsets"=>{"post"=>{"summary"=>"Create Variant Set", "description"=>"Creates a new variant set.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe provided variant set must have a valid `datasetId` set - all other\nfields are optional. Note that the `id` field will be ignored, as this is\nassigned by the server.", "operationId"=>"genomics.variantsets.create", "x-api-path-slug"=>"v1variantsets-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variant Set"]}}, "/v1/variantsets/search"=>{"post"=>{"summary"=>"Get Variant Sets", "description"=>"Returns a list of all variant sets matching search criteria.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49).", "operationId"=>"genomics.variantsets.search", "x-api-path-slug"=>"v1variantsetssearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variant Set"]}}, "/v1/variantsets/{variantSetId}"=>{"delete"=>{"summary"=>"Delete Variant Set", "description"=>"Deletes a variant set including all variants, call sets, and calls within.\nThis is not reversible.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.variantsets.delete", "x-api-path-slug"=>"v1variantsetsvariantsetid-delete", "parameters"=>[{"in"=>"path", "name"=>"variantSetId", "description"=>"The ID of the variant set to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variant Set"]}, "get"=>{"summary"=>"Get Variant Set", "description"=>"Gets a variant set by ID.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.variantsets.get", "x-api-path-slug"=>"v1variantsetsvariantsetid-get", "parameters"=>[{"in"=>"path", "name"=>"variantSetId", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variant Set"]}, "patch"=>{"summary"=>"Update Variant Set", "description"=>"Updates a variant set using patch semantics.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.variantsets.patch", "x-api-path-slug"=>"v1variantsetsvariantsetid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"updateMask", "description"=>"An optional mask specifying which fields to update"}, {"in"=>"path", "name"=>"variantSetId", "description"=>"The ID of the variant to be updated (must already exist)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variant Set"]}}, "/v1/variantsets/{variantSetId}:export"=>{"post"=>{"summary"=>"Export Variant Set", "description"=>"Exports variant set data to an external destination.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.variantsets.export", "x-api-path-slug"=>"v1variantsetsvariantsetidexport-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"variantSetId", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variant Set"]}}, "/v1/{name}"=>{"get"=>{"summary"=>"Get Operation", "description"=>"Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", "operationId"=>"genomics.operations.get", "x-api-path-slug"=>"v1name-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the operation resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1/{name}:cancel"=>{"post"=>{"summary"=>"Cancel Operation", "description"=>"Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.", "operationId"=>"genomics.operations.cancel", "x-api-path-slug"=>"v1namecancel-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The name of the operation resource to be cancelled"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1/{resource}:getIamPolicy"=>{"post"=>{"summary"=>"Get IAM Policy", "description"=>"Gets the access control policy for the dataset. This is empty if the\npolicy or resource does not exist.\n\nSee Getting a\nPolicy for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.datasets.getIamPolicy", "x-api-path-slug"=>"v1resourcegetiampolicy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which policy is being specified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}, "/v1/{resource}:setIamPolicy"=>{"post"=>{"summary"=>"Set IAM Policy", "description"=>"Sets the access control policy on the specified dataset. Replaces any\nexisting policy.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nSee Setting a\nPolicy for more information.", "operationId"=>"genomics.datasets.setIamPolicy", "x-api-path-slug"=>"v1resourcesetiampolicy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which policy is being specified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}, "/v1/{resource}:testIamPermissions"=>{"post"=>{"summary"=>"Test IAM Permissions", "description"=>"Returns permissions that a caller has on the specified resource.\nSee Testing\nPermissions for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "operationId"=>"genomics.datasets.testIamPermissions", "x-api-path-slug"=>"v1resourcetestiampermissions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resource", "description"=>"REQUIRED: The resource for which policy is being specified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IAM"]}}}}, "apis"=>{"name"=>"Google Genomics", "x-slug"=>"google-genomics", "description"=>"Google Genomics helps the life science community organize the world’s genomic information and make it accessible and useful. Big genomic data is here today, with petabytes rapidly growing toward exabytes. Through our extensions to Google Cloud Platform, you can apply the same technologies that power Google Search and Maps to securely store, process, explore, and share large, complex datasets.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/power-your-science.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Genome,Google APIs,Profiles,Relative Data,Science,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-genomics/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Genomics API", "x-api-slug"=>"google-genomics-api", "description"=>"Google Genomics helps the life science community organize the world’s genomic information and make it accessible and useful. Big genomic data is here today, with petabytes rapidly growing toward exabytes. Through our extensions to Google Cloud Platform, you can apply the same technologies that power Google Search and Maps to securely store, process, explore, and share large, complex datasets.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/power-your-science.png", "humanURL"=>"https://cloud.google.com/genomics/", "baseURL"=>"://genomics.googleapis.com//", "tags"=>"API Provider,API Service Provider,Genome,Google APIs,Profiles,Relative Data,Science,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-genomics/google-genomics-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://cloud.google.com/genomics/overview"}, {"type"=>"x-forum", "url"=>"https://groups.google.com/forum/#!forum/google-genomics-discuss/join"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/genomics/pricing"}, {"type"=>"x-rate-limits", "url"=>"https://cloud.google.com/genomics/quotas"}, {"type"=>"x-support", "url"=>"https://cloud.google.com/genomics/support"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/genomics/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
plivo{"plivo-sms-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Plivo", "x-complete"=>1, "info"=>{"title"=>"Plivo SMS", "version"=>"v1"}, "host"=>"api.plivo.com", "basePath"=>"v1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"{auth_id}/Message/"=>{"get"=>{"summary"=>"Message", "description"=>"Get details of a message.", "operationId"=>"getAuthMessage", "x-api-path-slug"=>"auth-idmessage-get", "parameters"=>[{"in"=>"path", "name"=>"auth_id", "description"=>"AUTH TOKEN Your Plivo AUTH ID and AUTH TOKEN can be found when you login to your dashboard"}, {"in"=>"query", "name"=>"limit", "description"=>"Used to display the number of results per page"}, {"in"=>"query", "name"=>"offset", "description"=>"Denotes the number of value items by which the results should be offset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}, "post"=>{"summary"=>"Send Message", "description"=>"This API enables you to send messages via Plivou2019s SMS service.", "operationId"=>"postAuthMessage", "x-api-path-slug"=>"auth-idmessage-post", "parameters"=>[{"in"=>"query", "name"=>"dst", "description"=>"The number to which the message needs to be sent"}, {"in"=>"query", "name"=>"log", "description"=>"If set to false, the content of this message will not be logged on the Plivo infrastructure and the dst value will be masked"}, {"in"=>"query", "name"=>"method", "description"=>"The method used to call the url"}, {"in"=>"query", "name"=>"src", "description"=>"The phone number to be used as the caller id (with the country code)"}, {"in"=>"query", "name"=>"text", "description"=>"The text to send encoded in Unicode UTF-8"}, {"in"=>"path", "name"=>"This API enables you to send messages via Plivou2019s SMS service.", "description"=>"AUTH TOKEN Your Plivo AUTH ID and AUTH TOKEN can be found when you login to your dashboard"}, {"in"=>"query", "name"=>"type", "description"=>"The type of message"}, {"in"=>"query", "name"=>"url", "description"=>"The URL to which with the status of the message is sent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Message"]}}, "{auth_id}/Message/{message_uuid}/"=>{"get"=>{"summary"=>"Message", "description"=>"Get details of a single message.", "operationId"=>"getAuthMessageMessageUu", "x-api-path-slug"=>"auth-idmessagemessage-uuid-get", "parameters"=>[{"in"=>"query", "name"=>"auth_id", "description"=>"AUTH TOKEN Your Plivo AUTH ID and AUTH TOKEN can be found when you login to your dashboard"}, {"in"=>"path", "name"=>"message_uuid", "description"=>"The message unique id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}}}}, "codenvy-account-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Plivo", "x-complete"=>1, "info"=>{"title"=>"Codenvy Account API", "description"=>"this-is-the-api-for-managing-codenvy-account-", "version"=>"1.0.0"}, "host"=>"/account", "basePath"=>"https://codenvy.com/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/account"=>{"get"=>{"summary"=>"Get Account", "description"=>"This API call returns a JSON with all user membership in a single or multiple accounts", "operationId"=>"getMemberships", "x-api-path-slug"=>"account-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}, "post"=>{"summary"=>"Post Account", "description"=>"Create a new account", "operationId"=>"create", "x-api-path-slug"=>"account-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/account/find"=>{"get"=>{"summary"=>"Get Account Find", "description"=>"Get account information by its name. JSON with account details is returned. This API call requires system/admin or system/manager role.", "operationId"=>"getByName", "x-api-path-slug"=>"accountfind-get", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"Account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Find"]}}, "/account/memberships"=>{"get"=>{"summary"=>"Get Account Memberships", "description"=>"ID of a user should be specified as a query parameter. JSON with membership details is returned. For this API call system/admin or system/manager role is required", "operationId"=>"getMembershipsOfSpecificUser", "x-api-path-slug"=>"accountmemberships-get", "parameters"=>[{"in"=>"query", "name"=>"userid", "description"=>"User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Memberships"]}}, "/account/subscriptions"=>{"post"=>{"summary"=>"Post Account Subscriptions", "description"=>"Add a new subscription to an account. JSON with subscription details is sent. Roles: account/owner, system/admin.", "operationId"=>"addSubscription", "x-api-path-slug"=>"accountsubscriptions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Subscription details", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Subscriptions"]}}, "/account/subscriptions/{subscriptionId}"=>{"delete"=>{"summary"=>"Delete Account Subscriptions Subscriptionid", "description"=>"Remove subscription from account. Roles: account/owner, system/admin.", "operationId"=>"removeSubscription", "x-api-path-slug"=>"accountsubscriptionssubscriptionid-delete", "parameters"=>[{"in"=>"path", "name"=>"subscriptionId", "description"=>"Subscription ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Subscriptions", "SubscriptionId"]}, "get"=>{"summary"=>"Get Account Subscriptions Subscriptionid", "description"=>"Get information on a particular subscription by its unique ID.", "operationId"=>"getSubscriptionById", "x-api-path-slug"=>"accountsubscriptionssubscriptionid-get", "parameters"=>[{"in"=>"path", "name"=>"subscriptionId", "description"=>"Subscription ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Subscriptions", "SubscriptionId"]}}, "/account/{accountId}/subscriptions"=>{"get"=>{"summary"=>"Get Account Accountid Subscriptions", "description"=>"Get information on account subscriptions. This API call requires account/owner, account/member, system/admin or system/manager role.", "operationId"=>"getSubscriptions", "x-api-path-slug"=>"accountaccountidsubscriptions-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account ID"}, {"in"=>"query", "name"=>"service", "description"=>"Service ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "AccountId", "Subscriptions"]}}, "/account/{id}"=>{"delete"=>{"summary"=>"Delete Account", "description"=>"Remove subscription from account. JSON with subscription details is sent. Can be performed only by system/admin.", "operationId"=>"remove", "x-api-path-slug"=>"accountid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Account ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Id"]}, "get"=>{"summary"=>"Get Account", "description"=>"Get account information by its ID. JSON with account details is returned. This API call requires account/owner, system/admin or system/manager role.", "operationId"=>"getById", "x-api-path-slug"=>"accountid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Account ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Id"]}, "post"=>{"summary"=>"Post Account", "description"=>"Update account. This API call requires account/owner role.", "operationId"=>"update", "x-api-path-slug"=>"accountid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Account ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Id"]}}, "/account/{id}/attribute"=>{"delete"=>{"summary"=>"Delete Account Attribute", "description"=>"Remove attribute from an account. Attribute name is used as a quary parameter. For this API request account/owner, system/admin or system/manager role is required", "operationId"=>"removeAttribute", "x-api-path-slug"=>"accountidattribute-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Account ID"}, {"in"=>"query", "name"=>"name", "description"=>"Attribute name to be removed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Id", "Attribute"]}}, "/account/{id}/members"=>{"get"=>{"summary"=>"Get Account Members", "description"=>"Get all members for a specific account. This API call requires account/owner, system/admin or system/manager role.", "operationId"=>"getMembers", "x-api-path-slug"=>"accountidmembers-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Account ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Id", "Members"]}, "post"=>{"summary"=>"Post Account Members", "description"=>"Add a new user to an account. This user will have account/member role. This API call requires account/owner, system/admin or system/manager role.", "operationId"=>"addMember", "x-api-path-slug"=>"accountidmembers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"New membership", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Account ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Id", "Members"]}}, "/account/{id}/members/{userid}"=>{"delete"=>{"summary"=>"Delete Account Members User", "description"=>"Remove user from a specific account. This API call requires account/owner, system/admin or system/manager role.", "operationId"=>"removeMember", "x-api-path-slug"=>"accountidmembersuserid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Account ID"}, {"in"=>"path", "name"=>"userid", "description"=>"User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Id", "Members", "Userid"]}}, "/account/{id}/resources"=>{"get"=>{"summary"=>"Get Account Resources", "description"=>"Returns used resources, provided by subscriptions. Roles: account/owner, account/member, system/manager, system/admin.", "operationId"=>"getResources", "x-api-path-slug"=>"accountidresources-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Account ID"}, {"in"=>"query", "name"=>"serviceId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Id", "Resources"]}, "post"=>{"summary"=>"Post Account Resources", "description"=>"Redistributes resources between workspaces. Roles: account/owner, system/manager, system/admin.", "operationId"=>"redistributeResources", "x-api-path-slug"=>"accountidresources-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Resources description", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Account ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Id", "Resources"]}}, "/blogs/"=>{"post"=>{"summary"=>"Post Blogs", "description"=>"Creates a new Story.", "operationId"=>"creates-a-new-story", "x-api-path-slug"=>"blogs-post", "parameters"=>[{"in"=>"query", "name"=>"body (required)", "description"=>"Content of the blog post"}, {"in"=>"query", "name"=>"latitude", "description"=>"Latitude for the blog post"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude for the blog post"}, {"in"=>"query", "name"=>"photo_ids", "description"=>"Comma separated list of Photo ID values to post with the blog"}, {"in"=>"query", "name"=>"tags", "description"=>"Comma separated list of tags"}, {"in"=>"query", "name"=>"title (required)", "description"=>"Title for the blog post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blogs"]}}, "/blogs/:id"=>{"put"=>{"summary"=>"Put Blogs", "description"=>"Updates the Story.", "operationId"=>"updates-the-story", "x-api-path-slug"=>"blogsid-put", "parameters"=>[{"in"=>"query", "name"=>"body", "description"=>"Content of the blog post"}, {"in"=>"query", "name"=>"id (required)", "description"=>"The Blog Post ID to update"}, {"in"=>"query", "name"=>"latitude", "description"=>"Latitude for the blog post"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude for the blog post"}, {"in"=>"query", "name"=>"photo_ids", "description"=>"Comma separated list of Photo IDs for photos that are in the blog post"}, {"in"=>"query", "name"=>"tags", "description"=>"Comma separated list of tags"}, {"in"=>"query", "name"=>"title", "description"=>"Title for the blog post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blogs", ":id"]}}, "/blogs/:id/comments"=>{"post"=>{"summary"=>"Post Blogs Comments", "description"=>"Creates a comment for the Story.", "operationId"=>"creates-a-comment-for-the-story", "x-api-path-slug"=>"blogsidcomments-post", "parameters"=>[{"in"=>"query", "name"=>"body (required)", "description"=>"Content of the comment"}, {"in"=>"query", "name"=>"id (required)", "description"=>"The Story ID to create a comment for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blogs", ":id", "Comments"]}}, "/collections"=>{"post"=>{"summary"=>"Post Collections", "description"=>"Creates new a collection.", "operationId"=>"creates-new-a-collection", "x-api-path-slug"=>"collections-post", "parameters"=>[{"in"=>"query", "name"=>"kind", "description"=>"Kind of the Collection to be created Recognized values: 1 - Portfolio Set (default), 2 - Profile Set"}, {"in"=>"query", "name"=>"path (required)", "description"=>"Path where the collection will be accessible at 500px"}, {"in"=>"query", "name"=>"photo_ids", "description"=>"Comma separated list of Photo ID values to post with the blog"}, {"in"=>"query", "name"=>"position", "description"=>"Position of the collection in the list of collections"}, {"in"=>"query", "name"=>"title (required)", "description"=>"Title for the collection"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collections"]}}, "/collections/:id"=>{"put"=>{"summary"=>"Put Collections", "description"=>"Updates collection.", "operationId"=>"updates-collection", "x-api-path-slug"=>"collectionsid-put", "parameters"=>[{"in"=>"query", "name"=>"id (required)", "description"=>"Collection ID"}, {"in"=>"query", "name"=>"kind", "description"=>"Change kind of the Collection"}, {"in"=>"query", "name"=>"path", "description"=>"Path where the collection will be accessible at 500px"}, {"in"=>"query", "name"=>"photo_ids", "description"=>"Comma separated list of Photo ID values that are in this collection"}, {"in"=>"query", "name"=>"position", "description"=>"Position of the collection in the list of collections"}, {"in"=>"query", "name"=>"title", "description"=>"Title for the collection"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collections", ":id"]}}, "/comments/:id/comments"=>{"post"=>{"summary"=>"Post Comments Comments", "description"=>"Creates a reply to an existing comment. Comments can only be nested one level deep, you cannot reply to a reply of a comment. If a comment has a non-null parent_id value then it cannot be replied to.", "operationId"=>"creates-a-reply-to-an-existing-comment-comments-can-only-be-nested-one-level-deep-you-cannot-reply-t", "x-api-path-slug"=>"commentsidcomments-post", "parameters"=>[{"in"=>"query", "name"=>"body (required)", "description"=>"Content of the comment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", ":id", "Comments"]}}, "/photos"=>{"post"=>{"summary"=>"Post Photos", "description"=>"Create a new photo on behalf of the user, and receive an upload key in exchange.", "operationId"=>"create-a-new-photo-on-behalf-of-the-user-and-receive-an-upload-key-in-exchange", "x-api-path-slug"=>"photos-post", "parameters"=>[{"in"=>"query", "name"=>"aperture", "description"=>"Aperture value"}, {"in"=>"query", "name"=>"camera", "description"=>"Make and model of the camera"}, {"in"=>"query", "name"=>"category", "description"=>"A numerical ID for the Category of the photo"}, {"in"=>"query", "name"=>"description", "description"=>"Description for the photo"}, {"in"=>"query", "name"=>"focal_length", "description"=>"Focal length in millimetres, a string representing an integer value"}, {"in"=>"query", "name"=>"iso", "description"=>"ISO value"}, {"in"=>"query", "name"=>"latitude", "description"=>"Latitude, in decimal format"}, {"in"=>"query", "name"=>"lens", "description"=>"Lens used to make this photo"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude, in decimal format"}, {"in"=>"query", "name"=>"name", "description"=>"Title of the photo"}, {"in"=>"query", "name"=>"privacy", "description"=>"Whether to hide the photo from the user profile on the website"}, {"in"=>"query", "name"=>"shutter_speed", "description"=>"Shutter speed in seconds, represented by string containing a rational expression if the value is 1sec"}, {"in"=>"query", "name"=>"tags", "description"=>"Comma-separated list of tags to apply to the photo"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos"]}}, "/photos/:id"=>{"put"=>{"summary"=>"Put Photos", "description"=>"Allows the client application to update user-editable information on a photo.nnnResource URLnnhttps://api.500px.com/v1/photos/:idnnnnAuthenticationnnRequired; OAuth. The client application must use the OAuth access token issued for the owner of the photo to access this resouce.nnnParametersnnThe application must provide the ID of the photo to update in the URL of the request. The following parameters are recognized when included in the query string or POST body:nnnnname: Title of the photo, up to 255 characters in length.nndescription: Text description of the photo, up to 65535 characters in length.nncategory: Integer number of the category of the photo. See category mapping for exact values.nntags: Comma-separated list of tags applicable to this photo.nnadd_tags: Comma-separated list of tags to add to this photos existing tags.nnremove_tags: Comma-separated list of tags to remove from this photos existing tags.nnshutter_speed: Shutter speed value for the photo, internally stored as string.nnfocal_length: Focal length value for the photo, internally stored as string.nnaperture: Aperture value value for the photo, internally stored as string.nniso: Integer ISO value for the photo.nncamera: Make and model of the camera used to take this photo.nnlens: Information about the lens used to take this photo.nnlatitude: Latitude of the location this photo was taken at represented by a decimal number.nnlongitude: Longitude of the location this photo was taken at represented by a decimal number.nnnsfw: Boolean value indicating that the photo may contain not-safe-for-work content or content not suitable for minors.nnlicense_type: Integer number of the license type chosen for this photo. See license type mapping for exact values.nnprivacy: Integer value indicating that the photo should be shown (0) or hidden (1) on the users profile.nncrop: A hash containing keys x, x2, y, y2 and representing coordinates within which the thumbnail must be cropped. The crop is made using the top left corner as the origin. The points must be given relative to image size 4, an image of at most 900px on the larger side. The client application may skip this if the user does not wish to change photo thumbnail.nnnnImplementation detailsnnA parameter missing from the request will not be updated. A parameter set to an empty string or null value will be interpreted as the user wishing to reset the value of the field to its default value.nnYou can use the add_tags and remove_tags parameters to manupulate a photos tags without having to send the complete list of tags in the request.nnnReturn formatnnA JSON object containing key photo, where photo is a Photo object in full format.nnnErrorsnnAll known errors cause the resource to return HTTP error code header together with a JSON array containing at least status and error keys describing the source of error.nnnn401: Invalid OAuth request: The request was refused because the OAuth signature is incorrect.nn404: Photo with ID not found: The photo ID provided is not known to the system.nn404: Photo with ID has been deleted: The photo has been deleted and can not be edited.nn404: Photo with ID belongs to a deactivated user: The photo belongs to a user that is no longer active and can not be edited.nn400: Bad photo category: An unrecognized photo category value has been provided.nn400: Bad license type: An unrecognized license type value has been provided.", "operationId"=>"allows-the-client-application-to-update-usereditable-information-on-a-photoresource-urlhttpsapi500px", "x-api-path-slug"=>"photosid-put", "parameters"=>[{"in"=>"query", "name"=>"add_tags: Comma-separated list of tags to add to this photos existing tags."}, {"in"=>"query", "name"=>"aperture: Aperture value value for the photo, internally stored as string."}, {"in"=>"query", "name"=>"camera: Make and model of the camera used to take this photo."}, {"in"=>"query", "name"=>"category: Integer number of the category of the photo. See category mapping for exact values."}, {"in"=>"query", "name"=>"crop: A hash containing keys x, x2, y, y2 and representing coordinates within which the thumbnail must be cropped. The crop is made using the top left corner as the origin. The points must be given relative to image size 4, an image of at most 900px"}, {"in"=>"query", "name"=>"description: Text description of the photo, up to 65535 characters in length."}, {"in"=>"query", "name"=>"focal_length: Focal length value for the photo, internally stored as string."}, {"in"=>"query", "name"=>"iso: Integer ISO value for the photo."}, {"in"=>"query", "name"=>"latitude: Latitude of the location this photo was taken at represented by a decimal number."}, {"in"=>"query", "name"=>"lens: Information about the lens used to take this photo."}, {"in"=>"query", "name"=>"license_type: Integer number of the license type chosen for this photo. See license type mapping for exact values."}, {"in"=>"query", "name"=>"longitude: Longitude of the location this photo was taken at represented by a decimal number."}, {"in"=>"query", "name"=>"name: Title of the photo, up to 255 characters in length."}, {"in"=>"query", "name"=>"nsfw: Boolean value indicating that the photo may contain not-safe-for-work content or content not suitable for minors."}, {"in"=>"query", "name"=>"privacy: Integer value indicating that the photo should be shown (0) or hidden (1) on the users profile."}, {"in"=>"query", "name"=>"remove_tags: Comma-separated list of tags to remove from this photos existing tags."}, {"in"=>"query", "name"=>"shutter_speed: Shutter speed value for the photo, internally stored as string."}, {"in"=>"query", "name"=>"tags: Comma-separated list of tags applicable to this photo."}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", ":id"]}}, "/photos/:id/comments"=>{"post"=>{"summary"=>"Post Photos Comments", "description"=>"Creates a new comment for the photo.", "operationId"=>"creates-a-new-comment-for-the-photo", "x-api-path-slug"=>"photosidcomments-post", "parameters"=>[{"in"=>"query", "name"=>"body (required)", "description"=>"Content of the comment"}, {"in"=>"query", "name"=>"id (required)", "description"=>"The Photo ID to post comments for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", ":id", "Comments"]}}, "/photos/:id/favorite"=>{"post"=>{"summary"=>"Post Photos Favorite", "description"=>"Adds the photo to users list of favorites.", "operationId"=>"adds-the-photo-to-users-list-of-favorites", "x-api-path-slug"=>"photosidfavorite-post", "parameters"=>[{"in"=>"query", "name"=>"id (required)", "description"=>"ID of the photo the favorite is cast upon"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", ":id", "Favorite"]}}, "/photos/:id/favorites"=>{"get"=>{"summary"=>"Get Photos Favorites", "description"=>"Returns all users that had favorite that photo.", "operationId"=>"returns-all-users-that-had-favorite-that-photo", "x-api-path-slug"=>"photosidfavorites-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Return a specific page in the photo stream"}, {"in"=>"query", "name"=>"rpp", "description"=>"The number of results to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", ":id", "Favorites"]}}, "/photos/:id/report"=>{"post"=>{"summary"=>"Post Photos Report", "description"=>"Allows to report a photo.", "operationId"=>"allows-to-report-a-photo", "x-api-path-slug"=>"photosidreport-post", "parameters"=>[{"in"=>"query", "name"=>"id (required)", "description"=>"ID of the photo to report"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", ":id", "Report"]}}, "/photos/:id/tags"=>{"post"=>{"summary"=>"Post Photos Tags", "description"=>"Adds tags to the photo. Accepts one or multiple coma separated tags.", "operationId"=>"adds-tags-to-the-photo-accepts-one-or-multiple-coma-separated-tags", "x-api-path-slug"=>"photosidtags-post", "parameters"=>[{"in"=>"query", "name"=>"id (required)", "description"=>"The Photo ID to add tags for"}, {"in"=>"query", "name"=>"tags (required)", "description"=>"Coma separated tags"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", ":id", "Tags"]}}, "/photos/:id/vote"=>{"post"=>{"summary"=>"Post Photos Vote", "description"=>"Allows the user to vote for a photo.", "operationId"=>"allows-the-user-to-vote-for-a-photo", "x-api-path-slug"=>"photosidvote-post", "parameters"=>[{"in"=>"query", "name"=>"id (required)", "description"=>"ID of the photo the vote is cast upon"}, {"in"=>"query", "name"=>"vote (required)", "description"=>"vote, values: 0 for dislike or 1 for like"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", ":id", "Vote"]}}, "/photos/:id/votes"=>{"get"=>{"summary"=>"Get Photos Votes", "description"=>"Returns all users that had liked this photo.", "operationId"=>"returns-all-users-that-had-liked-this-photo", "x-api-path-slug"=>"photosidvotes-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Return a specific page in the photo stream"}, {"in"=>"query", "name"=>"rpp", "description"=>"The number of results to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", ":id", "Votes"]}}, "/photos/search"=>{"get"=>{"summary"=>"Get Photos Search", "description"=>"Returns a listing of twenty (up to one hundred) photos from search results for a specified tag, keyword, or location.", "operationId"=>"returns-a-listing-of-twenty-up-to-one-hundred-photos-from-search-results-for-a-specified-tag-keyword", "x-api-path-slug"=>"photossearch-get", "parameters"=>[{"in"=>"query", "name"=>"comments_count u2014u00a0Sort by the number of comments, most commented first."}, {"in"=>"query", "name"=>"created_at", "description"=>"Default: sort by time of upload, most recent first"}, {"in"=>"query", "name"=>"exclude", "description"=>"String name of the category to exclude from the results"}, {"in"=>"query", "name"=>"favorites_count", "description"=>"Sort by the number of favorites, most favorited first"}, {"in"=>"query", "name"=>"geo", "description"=>"A geo-location point of the format latitude,longitude,radius<units>"}, {"in"=>"query", "name"=>"highest_rating", "description"=>"Sort by highest rating achieved, highest rated first"}, {"in"=>"query", "name"=>"image_size", "description"=>"The photo size to be returned"}, {"in"=>"query", "name"=>"license_type -- Restrict the results to one or more license types. Multiple types can be separated with a comma: license_type=1,4."}, {"in"=>"query", "name"=>"only", "description"=>"String name of the category to return photos from"}, {"in"=>"query", "name"=>"page", "description"=>"Return a specific page"}, {"in"=>"query", "name"=>"rating", "description"=>"Sort by current rating, highest rated first"}, {"in"=>"query", "name"=>"rpp", "description"=>"The number of results to return"}, {"in"=>"query", "name"=>"sort u2014u00a0Sort photos in the specified order. The following values are recognized:nnnn_score", "description"=>"Sort by query score, best match first"}, {"in"=>"query", "name"=>"tag", "description"=>"A complete tag string to search for"}, {"in"=>"query", "name"=>"tags", "description"=>"Returns an array of tags for each photo"}, {"in"=>"query", "name"=>"taken_at u2014u00a0Sort by the original date of the image extracted from metadata, most recent first (might not be available for all images)."}, {"in"=>"query", "name"=>"term", "description"=>"A keyword to search for"}, {"in"=>"query", "name"=>"times_viewed u2014u00a0Sort by the number of views, most viewed first."}, {"in"=>"query", "name"=>"votes_count u2013 Sort by the number of votes, most voted on first."}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Search"]}}, "/photos/upload"=>{"post"=>{"summary"=>"Post Photos Upload", "description"=>"This is a new photo upload endpoint. It is currently in beta.nCreate a new photo on behalf of the user and upload a file.nfile parameter is passed in multipart/form-data, other parameters are passed as query parametrs or multipart/form-data.", "operationId"=>"this-is-a-new-photo-upload-endpoint-it-is-currently-in-betacreate-a-new-photo-on-behalf-of-the-user-", "x-api-path-slug"=>"photosupload-post", "parameters"=>[{"in"=>"query", "name"=>"aperture", "description"=>"Aperture value"}, {"in"=>"query", "name"=>"camera", "description"=>"Make and model of the camera"}, {"in"=>"query", "name"=>"category", "description"=>"A numerical ID for the Category of the photo"}, {"in"=>"query", "name"=>"description", "description"=>"Description for the photo"}, {"in"=>"query", "name"=>"file (required) - Photo filename in JPG/JPEG, passed along with multipart/form-data."}, {"in"=>"query", "name"=>"focal_length", "description"=>"Focal length in millimetres, a string representing an integer value"}, {"in"=>"query", "name"=>"iso", "description"=>"ISO value"}, {"in"=>"query", "name"=>"latitude", "description"=>"Latitude, in decimal format"}, {"in"=>"query", "name"=>"lens", "description"=>"Lens used to make this photo"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude, in decimal format"}, {"in"=>"query", "name"=>"name", "description"=>"Title of the photo"}, {"in"=>"query", "name"=>"privacy", "description"=>"Whether to hide the photo from the user profile on the website"}, {"in"=>"query", "name"=>"shutter_speed", "description"=>"Shutter speed in seconds, represented by string containing a rational expression if the value is 1sec"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photos", "Upload"]}}, "/upload"=>{"post"=>{"summary"=>"Post Upload", "description"=>"Allows an application to upload the photo file.nnNote that this endpoint is at the upload.500px.com domain, not the api.500px.com domain.", "operationId"=>"allows-an-application-to-upload-the-photo-filenote-that-this-endpoint-is-at-the-upload500pxcom-domai", "x-api-path-slug"=>"upload-post", "parameters"=>[{"in"=>"query", "name"=>"file", "description"=>"The multipart HTTP upload"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The ID of the photo the file is being uploaded for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload"]}}, "/users"=>{"get"=>{"summary"=>"Get Users", "description"=>"Returns the profile information for the current user.", "operationId"=>"returns-the-profile-information-for-the-current-user", "x-api-path-slug"=>"users-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/:id/followers"=>{"get"=>{"summary"=>"Get Users Followers", "description"=>"Returns a list of users who follow the specified user.", "operationId"=>"returns-a-list-of-users-who-follow-the-specified-user", "x-api-path-slug"=>"usersidfollowers-get", "parameters"=>[{"in"=>"query", "name"=>"id (required)", "description"=>"ID of the user"}, {"in"=>"query", "name"=>"page", "description"=>"Return the specified page of the resource"}, {"in"=>"query", "name"=>"rpp", "description"=>"Results Per Page, default 20, max 100"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", ":id", "Followers"]}}, "/users/:id/friends"=>{"post"=>{"summary"=>"Post Users Friends", "description"=>"Add the user to the list of followers.", "operationId"=>"add-the-user-to-the-list-of-followers", "x-api-path-slug"=>"usersidfriends-post", "parameters"=>[{"in"=>"query", "name"=>"id (required)", "description"=>"ID of the User to add to the followers list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", ":id", "Friends"]}}, "/users/search"=>{"get"=>{"summary"=>"Get Users Search", "description"=>"Return listing of ten (up to one hundred) users from search results for a specified search term.", "operationId"=>"return-listing-of-ten-up-to-one-hundred-users-from-search-results-for-a-specified-search-term", "x-api-path-slug"=>"userssearch-get", "parameters"=>[{"in"=>"query", "name"=>"term (required)", "description"=>"A keyword to search for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Search"]}}, "/users/show"=>{"get"=>{"summary"=>"Get Users Show", "description"=>"Returns the profile information for a specified user.", "operationId"=>"returns-the-profile-information-for-a-specified-user", "x-api-path-slug"=>"usersshow-get", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"Return information for the user with the specified email address"}, {"in"=>"query", "name"=>"id", "description"=>"Return information for the specified user ID"}, {"in"=>"query", "name"=>"username", "description"=>"Return information for the user with the specified username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Show"]}}}}, "apis"=>{"name"=>"Plivo", "x-slug"=>"plivo", "description"=>"Voice & SMS API Platform: Plivo enables businesses and developers to tap into powerful Voice and SMS capabilities without carrier lock-in.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1113-plivo.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"130970", "tags"=>"Imports,Messages,Relative Data,Relative StreamRank,Service API,SMS,Stack Network,Streams,Streams,Streams,Target,Technology,Telecommunications,Telecommunications,Voice", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"plivo/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Codenvy Account API", "x-api-slug"=>"codenvy-account-api", "description"=>"Voice & SMS API Platform: Plivo enables businesses and developers to tap into powerful Voice and SMS capabilities without carrier lock-in.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1113-plivo.jpg", "humanURL"=>"http:///account", "baseURL"=>":///account/https://codenvy.com/api", "tags"=>"Imports,Messages,Relative Data,Relative StreamRank,Service API,SMS,Stack Network,Streams,Streams,Streams,Target,Technology,Telecommunications,Telecommunications,Voice", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/plivo/codenvy-account-api-openapi.yaml"}]}, {"name"=>"Plivo SMS", "x-api-slug"=>"plivo-sms", "description"=>"Plivo provides web developers with basic building blocks in the form of Plivo XML and HTTP API, to create telephony apps, so developers can completely do away with learning the nitty-gritty of the telephony plumbing.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1113-plivo.jpg", "humanURL"=>"http:///account", "baseURL"=>"https://api.plivo.com/v1/", "tags"=>"Users,Show", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/plivo/auth-idmessagemessage-uuid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/plivo/plivo-sms-openapi.yaml"}]}], "x-common"=>[{"type"=>"x--net-library", "url"=>"https://www.plivo.com/docs/helpers/dotnet/"}, {"type"=>"x-android-sdk", "url"=>"https://www.plivo.com/docs/sdk/android/"}, {"type"=>"x-base", "url"=>"https://api.plivo.com"}, {"type"=>"x-blog", "url"=>"http://blog.plivo.com"}, {"type"=>"x-blog-rss", "url"=>"http://blog.plivo.com/rss"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/plivo"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/plivo"}, {"type"=>"x-documentation", "url"=>"https://plivo.com/docs/"}, {"type"=>"x-email", "url"=>"marketing@plivo.com"}, {"type"=>"x-email", "url"=>"legalrequests@plivo.com"}, {"type"=>"x-email", "url"=>"privacy@plivo.com"}, {"type"=>"x-faq", "url"=>"https://plivo.com/faq/"}, {"type"=>"x-github", "url"=>"https://github.com/plivo"}, {"type"=>"x-ios-sdk", "url"=>"https://www.plivo.com/docs/sdk/ios/"}, {"type"=>"x-java-sdk", "url"=>"https://www.plivo.com/docs/helpers/java/"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/plivo-inc/"}, {"type"=>"x-node-js-library", "url"=>"https://www.plivo.com/docs/helpers/node/"}, {"type"=>"x-php-sdk", "url"=>"https://www.plivo.com/docs/helpers/php/"}, {"type"=>"x-pricing", "url"=>"https://plivo.com/pricing/"}, {"type"=>"x-privacy", "url"=>"https://plivo.com/privacy/"}, {"type"=>"x-ruby-library", "url"=>"https://www.plivo.com/docs/helpers/python"}, {"type"=>"x-selfservice-registration", "url"=>"https://manage.plivo.com/accounts/register/"}, {"type"=>"x-status", "url"=>"https://status.plivo.com/"}, {"type"=>"x-terms-of-service", "url"=>"https://plivo.com/terms/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/plivo"}, {"type"=>"x-website", "url"=>"http:///account"}, {"type"=>"x-website", "url"=>"http://plivo.com"}, {"type"=>"x-website", "url"=>"https://www.plivo.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-vision{"google-cloud-vision-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Vision", "x-complete"=>1, "info"=>{"title"=>"Google Cloud Vision", "description"=>"integrates-google-vision-features-including-image-labeling-face-logo-and-landmark-detection-optical-character-recognition-ocr-and-detection-of-explicit-content-into-applications-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"vision.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/images:annotate"=>{"post"=>{"summary"=>"Run Image Detection", "description"=>"Run image detection and annotation for a batch of images.", "operationId"=>"vision.images.annotate", "x-api-path-slug"=>"v1imagesannotate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image Detection"]}}}}, "apis"=>{"name"=>"Google Cloud Vision", "x-slug"=>"google-cloud-vision", "description"=>"Google Cloud Vision API enables developers to understand the content of an image by encapsulating powerful machine learning models in an easy to use REST API. It quickly classifies images into thousands of categories (e.g., sailboat, lion, Eiffel Tower), detects individual objects and faces within images, and finds and reads printed words contained within images. You can build metadata on your image catalog, moderate offensive content, or enable new marketing scenarios through image sentiment analysis. Analyze images uploaded in the request or integrate with your image storage on Google Cloud Storage.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-cloud-vision-what-is-it.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Facial Recognition,Google APIs,Object Recognition,Profiles,Relative Data,Service API,Stack Network,Text Recognition", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-vision/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Vision API", "x-api-slug"=>"google-cloud-vision-api", "description"=>"Google Cloud Vision API enables developers to understand the content of an image by encapsulating powerful machine learning models in an easy to use REST API. It quickly classifies images into thousands of categories (e.g., sailboat, lion, Eiffel Tower), detects individual objects and faces within images, and finds and reads printed words contained within images. You can build metadata on your image catalog, moderate offensive content, or enable new marketing scenarios through image sentiment analysis. Analyze images uploaded in the request or integrate with your image storage on Google Cloud Storage.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-cloud-vision-what-is-it.png", "humanURL"=>"https://cloud.google.com/vision/", "baseURL"=>"://vision.googleapis.com//", "tags"=>"API Provider,API Service Provider,Facial Recognition,Google APIs,Object Recognition,Profiles,Relative Data,Service API,Stack Network,Text Recognition", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-vision/google-cloud-vision-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-best-practices", "url"=>"https://cloud.google.com/vision/docs/best-practices"}, {"type"=>"x-code", "url"=>"https://cloud.google.com/vision/docs/reference/libraries"}, {"type"=>"x-concepts", "url"=>"https://cloud.google.com/vision/docs/concepts"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/vision/docs/"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/vision/docs/quickstart"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/vision/docs/how-to"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/vision/docs/pricing"}, {"type"=>"x-rate-limits", "url"=>"https://cloud.google.com/vision/docs/limits"}, {"type"=>"x-support", "url"=>"https://cloud.google.com/vision/docs/support"}, {"type"=>"x-tutorials", "url"=>"https://cloud.google.com/vision/docs/tutorials"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/vision/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-dns{"azure-dns-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure DNS", "x-complete"=>1, "info"=>{"title"=>"DnsManagementClient", "description"=>"the-dns-management-client-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}/{relativeRecordSetName}"=>{"patch"=>{"summary"=>"Record Sets Update", "description"=>"Updates a record set within a DNS zone.", "operationId"=>"RecordSets_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkdnszoneszonenamerecordtyperelativerecordsetname-patch", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The etag of the record set"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the Update operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"recordType", "description"=>"The type of DNS record in this record set"}, {"in"=>"path", "name"=>"relativeRecordSetName", "description"=>"The name of the record set, relative to the name of the zone"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"zoneName", "description"=>"The name of the DNS zone (without a terminating dot)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Record Sets"]}, "put"=>{"summary"=>"Record Sets Create Or Update", "description"=>"Creates or updates a record set within a DNS zone.", "operationId"=>"RecordSets_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkdnszoneszonenamerecordtyperelativerecordsetname-put", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The etag of the record set"}, {"in"=>"header", "name"=>"If-None-Match", "description"=>"Set to * to allow a new record set to be created, but to prevent updating an existing record set"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the CreateOrUpdate operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"recordType", "description"=>"The type of DNS record in this record set"}, {"in"=>"path", "name"=>"relativeRecordSetName", "description"=>"The name of the record set, relative to the name of the zone"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"zoneName", "description"=>"The name of the DNS zone (without a terminating dot)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Record Sets"]}, "delete"=>{"summary"=>"Record Sets Delete", "description"=>"Deletes a record set from a DNS zone. This operation cannot be undone.", "operationId"=>"RecordSets_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkdnszoneszonenamerecordtyperelativerecordsetname-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The etag of the record set"}, {"in"=>"path", "name"=>"recordType", "description"=>"The type of DNS record in this record set"}, {"in"=>"path", "name"=>"relativeRecordSetName", "description"=>"The name of the record set, relative to the name of the zone"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"zoneName", "description"=>"The name of the DNS zone (without a terminating dot)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Record Sets"]}, "get"=>{"summary"=>"Record Sets Get", "description"=>"Gets a record set.", "operationId"=>"RecordSets_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkdnszoneszonenamerecordtyperelativerecordsetname-get", "parameters"=>[{"in"=>"path", "name"=>"recordType", "description"=>"The type of DNS record in this record set"}, {"in"=>"path", "name"=>"relativeRecordSetName", "description"=>"The name of the record set, relative to the name of the zone"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"zoneName", "description"=>"The name of the DNS zone (without a terminating dot)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Record Sets"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}"=>{"get"=>{"summary"=>"Record Sets List By Type", "description"=>"Lists the record sets of a specified type in a DNS zone.", "operationId"=>"RecordSets_ListByType", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkdnszoneszonenamerecordtype-get", "parameters"=>[{"in"=>"query", "name"=>"$top", "description"=>"The maximum number of record sets to return"}, {"in"=>"path", "name"=>"recordType", "description"=>"The type of record sets to enumerate"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"zoneName", "description"=>"The name of the DNS zone (without a terminating dot)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Record Sets"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/recordsets"=>{"get"=>{"summary"=>"Record Sets List By Dns Zone", "description"=>"Lists all record sets in a DNS zone.", "operationId"=>"RecordSets_ListByDnsZone", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkdnszoneszonenamerecordsets-get", "parameters"=>[{"in"=>"query", "name"=>"$top", "description"=>"The maximum number of record sets to return"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"zoneName", "description"=>"The name of the DNS zone (without a terminating dot)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Record Sets DNS Zone"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}"=>{"put"=>{"summary"=>"Zones Create Or Update", "description"=>"Creates or updates a DNS zone. Does not modify DNS records within the zone.", "operationId"=>"Zones_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkdnszoneszonename-put", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The etag of the DNS zone"}, {"in"=>"header", "name"=>"If-None-Match", "description"=>"Set to * to allow a new DNS zone to be created, but to prevent updating an existing zone"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the CreateOrUpdate operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"zoneName", "description"=>"The name of the DNS zone (without a terminating dot)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones"]}, "delete"=>{"summary"=>"Zones Delete", "description"=>"Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.", "operationId"=>"Zones_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkdnszoneszonename-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The etag of the DNS zone"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"zoneName", "description"=>"The name of the DNS zone (without a terminating dot)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones"]}, "get"=>{"summary"=>"Zones Get", "description"=>"Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.", "operationId"=>"Zones_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkdnszoneszonename-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"zoneName", "description"=>"The name of the DNS zone (without a terminating dot)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones"=>{"get"=>{"summary"=>"Zones List By Resource Group", "description"=>"Lists the DNS zones within a resource group.", "operationId"=>"Zones_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-networkdnszones-get", "parameters"=>[{"in"=>"query", "name"=>"$top", "description"=>"The maximum number of record sets to return"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones Resource Group"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnszones"=>{"get"=>{"summary"=>"Zones List", "description"=>"Lists the DNS zones in all resource groups in a subscription.", "operationId"=>"Zones_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-networkdnszones-get", "parameters"=>[{"in"=>"query", "name"=>"$top", "description"=>"The maximum number of DNS zones to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zones"]}}}}, "apis"=>{"name"=>"Azure DNS", "x-slug"=>"azure-dns", "description"=>"Azure DNS lets you host your DNS domains alongside your Azure apps and manage DNS records by using your existing Azure subscription. Microsoft’s global network of name servers has the reach, scale, and redundancy to ensure ultra-fast DNS responses and ultra-high availability for your domains. With Azure DNS, you can be sure your DNS will always be fast and available.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-dns-01-host.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,DNS,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-dns/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure DNS API", "x-api-slug"=>"azure-dns-api", "description"=>"Azure DNS lets you host your DNS domains alongside your Azure apps and manage DNS records by using your existing Azure subscription. Microsoft’s global network of name servers has the reach, scale, and redundancy to ensure ultra-fast DNS responses and ultra-high availability for your domains. With Azure DNS, you can be sure your DNS will always be fast and available.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-dns-01-host.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/dns/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,DNS,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-dns/subscriptionssubscriptionidprovidersmicrosoft-networkdnszones-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-dns/azure-dns-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/dns/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/dns/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/dns/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/dns/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
brookline-massachusetts-311{"brookline-massachusetts-311-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Brookline Massachusetts 311", "x-complete"=>1, "info"=>{"title"=>"Brookline MA Open311 GeoReport API", "description"=>"open311-allows-you-to-getpost-civic-information-of-cities-via-a-unified-interface--the-georeport-part-allows-you-to-submit-and-view-issues-at-the-public-local-space", "termsOfService"=>"(depends on server instance for example NYC http://dev.cityofchicago.org/docs/api/tos)", "contact"=>{"name"=>"Open311 community", "url"=>"http://wiki.open311.org/GeoReport_v2/", "email"=>"discuss@lists.open311.org"}, "license"=>{"name"=>"d", "url"=>nil}, "version"=>"1.0.0"}, "host"=>"spot.brooklinema.gov", "basePath"=>"/open311/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/requests.{response_format}"=>{"get"=>{"summary"=>"Requests", "description"=>"Query the current status of multiple requests.", "operationId"=>"query-the-current-status-of-multiple-requests", "x-api-path-slug"=>"requests-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"Latest datetime to include in search"}, {"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON format", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"service_code", "description"=>"Specify the service type by calling the unique ID of the service_code"}, {"in"=>"query", "name"=>"service_request_id", "description"=>"To call multiple Service Requests at once, multiple service_request_id can be declared; comma delimited"}, {"in"=>"query", "name"=>"start_date", "description"=>"Earliest datetime to include in search"}, {"in"=>"query", "name"=>"status", "description"=>"Allows one to search for requests which have a specific status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Requests"]}, "post"=>{"summary"=>"Create Service Request", "description"=>"Submit a new request for with specific details of a single service. Must provide a location via lat/long or address_string or address_id", "operationId"=>"submit-a-new-request-for-with-specific-details-of-a-single-service-must-provide-a-location-via-latlo", "x-api-path-slug"=>"requests-response-format-post", "parameters"=>[{"in"=>"query", "name"=>"address_id"}, {"in"=>"query", "name"=>"address_string"}, {"in"=>"query", "name"=>"attribute", "description"=>"array of key/value responses based on Service Definitions"}, {"in"=>"query", "name"=>"lat", "description"=>"WGS-84 latitude"}, {"in"=>"query", "name"=>"long", "description"=>"WGS-84 longitude"}, {"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON format", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"service_code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Service", "Request"]}}, "/request/{service_request_id}.{response_format}d"=>{"get"=>{"summary"=>"Current Status", "description"=>"Query the current status of an individual request", "operationId"=>"query-the-current-status-of-an-individual-request", "x-api-path-slug"=>"requestservice-request-id-response-formatd-get", "parameters"=>[{"in"=>"path", "name"=>"service_request_id", "description"=>"Is specified in the main URL path rather than an added query string parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Current", "Status"]}}, "/services.{response_format}"=>{"get"=>{"summary"=>"Service Types", "description"=>"List acceptable service request types and their associated service codes. These request types can be unique to the city/jurisdiction.", "operationId"=>"list-acceptable-service-request-types-and-their-associated-service-codes-these-request-types-can-be-", "x-api-path-slug"=>"services-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON format", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Service", "Types"]}}, "/services/{service_code}.{response_format}"=>{"get"=>{"summary"=>"(extended) Definition Of A Service Type", "description"=>"Define attributes associated with a service code. These attributes can be unique to the city/jurisdiction.", "operationId"=>"define-attributes-associated-with-a-service-code-these-attributes-can-be-unique-to-the-cityjurisdict", "x-api-path-slug"=>"servicesservice-code-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"service_code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "(extended)", "Definition", "Service", "Type"]}}, "/tokens/{token_id}.{response_format}"=>{"get"=>{"summary"=>"Id Of Service_request Via Token", "description"=>"Get the service_request_id from a temporary token. This is unnecessary if the response from creating a service request does not contain a token.", "operationId"=>"get-the-service-request-id-from-a-temporary-token-this-is-unnecessary-if-the-response-from-creating-", "x-api-path-slug"=>"tokenstoken-id-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"token_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Id", "Service", "Request", "Via", "Token"]}}}}, "apis"=>{"name"=>"Brookline Massachusetts 311", "x-slug"=>"brookline-massachusetts-311", "description"=>"The 311 website for Brookline Massachusetts.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2017-12-26 at 9.54.50 PM.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"311,Open311,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"brookline-massachusetts-311/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Brookline Massachusetts 311", "x-api-slug"=>"brookline-massachusetts-311", "description"=>"The 311 website for Brookline Massachusetts.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2017-12-26 at 9.54.50 PM.png", "humanURL"=>"http://spot.brooklinema.gov/open311", "baseURL"=>"http://spot.brooklinema.gov//open311/v2/", "tags"=>"311,Open311,Streams,Streams", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/brookline-massachusetts-311/tokenstoken-id-response-format-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/brookline-massachusetts-311/brookline-massachusetts-311-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-open-311-feed", "url"=>"http://spot.brooklinema.gov/open311/v2/services.xml?jurisdiction_id=brooklinema.gov"}, {"type"=>"x-website", "url"=>"http://spot.brooklinema.gov/open311"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
docsmore{"docsmore-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Docsmore", "x-complete"=>1, "info"=>{"title"=>"Docsmore API 2.1", "description"=>"alt-texthttpswww-docsmore-comwpcontentuploads201802docsmoreapi-png-titleh3create-a-developer-account-at-docsmore-io-and-start-unleashing-the-power-of-docsmore-into-your-own-applications--to-make-it-easier-we-have-provided-client-libraries-and-sdk-in-several-languages-for-you-to-get-started-and-hit-the-ground-running-in-no-time-h3brbrh4note-if-you-dont-see-api-setting-under-top-right-menu-that-means-you-will-need-to-be-a-developer-account--please-contact-supportdocsmore-com-and-a-customer-service-expert-will-switch-your-account-to-developer-account--h4brbrh5just-head-over-to-httpsdocsmore-io-and-sign-up-for-your-30-days-trial-h5", "version"=>"1.0"}, "host"=>"api.docsmore.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/getwebhooks"=>{"get"=>{"summary"=>"List all Webhooks", "description"=>"List Webhooks that are both active and inactive. Inactive webhooks with webhook type of 'static' will be automatically removed during the nightly job process.", "operationId"=>"ApiGetwebhooksGet", "x-api-path-slug"=>"apigetwebhooks-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Webhooks"]}}, "/api/getwebhooks/{id}"=>{"get"=>{"summary"=>"Get Details of Single Webhook", "description"=>"Details of Single Webhook.", "operationId"=>"ApiGetwebhooksByIdGet", "x-api-path-slug"=>"apigetwebhooksid-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Details", "Of", "Single", "Webhook"]}}, "/api/webhook/subscribe"=>{"post"=>{"summary"=>"Subscribe To Webhook", "description"=>"Make sure you have a unique payload URL every time you use this api call to register your webhook. Unable to do so will result in webhook registration denial.\n\n\nFor multiple events subscription, just use it comma separated values. Here are the available list of register events.\n\n\n\ndocumentUploadComplete\nworkflowProgressEvent\nworkflowCompleteEvent\ndocumentflowProgressEvent\ndocumentflowCompleteEvent\ndocumentSelfSigninCompleteEvent", "operationId"=>"ApiWebhookSubscribePost", "x-api-path-slug"=>"apiwebhooksubscribe-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscribe", "Webhook"]}}, "/api/webhook/unsubscribe/{id}"=>{"delete"=>{"summary"=>"Unsubscribe Webhook", "description"=>"It is important that you call this event to unsubscribe otherwise it will automatically be removed in 10 minutes. If not unsubscribed manually, it can also lead to the problem of duplication and create further issues.", "operationId"=>"ApiWebhookUnsubscribeByIdDelete", "x-api-path-slug"=>"apiwebhookunsubscribeid-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsubscribe", "Webhook"]}}, "/oauth/token"=>{"post"=>{"summary"=>"Get OAuth TOKEN", "description"=>"Obtaining an Auth Token is the first thing in the process. The lifetime of Auth token is configurable in the developer portal depending upon your need. Once auth token is obtained, all the follow up API calls will need to include auth token in the header. FaIlure to do so would result in response with 401 Unauthorized Access.\n\nUnder Your Developer Account - Go to Api Setting and you will screen similar to below.\n\n\nMake sure you call this in server side code. Exposing apiKey and clientSecret is a not a good idea on front end and can lead up to security vulnerabilities.", "operationId"=>"OauthTokenPost", "x-api-path-slug"=>"oauthtoken-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OAuth", "TOKEN"]}}, "/api/dmcatalogue"=>{"post"=>{"summary"=>"Fetch All Documents from Your Team Catalogue", "description"=>"By design, the authenticated user can only view the files that are either created by them or shared with them. Make sure user has at least read permission to view the catalogue.", "operationId"=>"ApiDmcataloguePost", "x-api-path-slug"=>"apidmcatalogue-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"items"}, {"in"=>"query", "name"=>"page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fetch", "", "Documents", "From", "Your", "Team", "Catalogue"]}}, "/api/dmcatalogue/:id"=>{"post"=>{"summary"=>"Fetch Single Document", "description"=>"Fetch single document.", "operationId"=>"ApiDmcatalogueIdPost", "x-api-path-slug"=>"apidmcatalogueid-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fetch", "Single", "Document"]}}, "/api/docflow/getdocflows"=>{"get"=>{"summary"=>"Get All Document Flows", "description"=>"Get all document flows.", "operationId"=>"ApiDocflowGetdocflowsGet", "x-api-path-slug"=>"apidocflowgetdocflows-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Document", "Flows"]}}, "/api/clientdocs/getrawdata/:authToken/:documentKey"=>{"get"=>{"summary"=>"Get Raw Data For A Given Document", "description"=>"This API call gets you underlying raw data of the document. All you need to do is supply Auth token and Document Key as part of the call.\n\nDocument Key can be obtained from \"Document Gallery\" Page and Clicking on the sub-menu of the desired document.\n\nAs a response object, jsondata and metadata information is passed. Jsondata is basically raw data and metadata is data columns information.", "operationId"=>"ApiClientdocsGetrawdataAuthTokenDocumentKeyGet", "x-api-path-slug"=>"apiclientdocsgetrawdataauthtokendocumentkey-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"authToken"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"documentKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Raw", "Data", "Given", "Document"]}}, "/api/getworkflowlink"=>{"post"=>{"summary"=>"Get Workflow Link", "description"=>"This is the most popular use of Docsmore API. From your connected app, you can launch workflow and obtain the unique link for immediate launch or later on. You can also supply data in flat json format that can be used inside the document for pre-fill purpose saving your customer time.\n\nPlease make sure you pay close attention to the requirement for this API call as there are several aspects of it as required parameters.", "operationId"=>"ApiGetworkflowlinkPost", "x-api-path-slug"=>"apigetworkflowlink-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow", "Link"]}}, "/api/docflowtracks/flowtrackviaapi"=>{"post"=>{"summary"=>"Get Workflow Link For Flow Track", "description"=>"In Docsmore space, Flow Track means all the client documents generated using one of the Document Flow. In other words, it is an instance of Document FLow. The other thing to notice here is payload information is remarkably similar to general \"Workflow\" of a Single Document.\n\nWhen you initiate this API call, you are basically setting up a new instance of Workflow and in turn getting workflow link of the starting document in the workflow.\n\nIf \"flowtrackid\" value is \"new\", then new flowtrack will be created. If flowtrackid has a value of actual flowtrackid then link will be provided to access read-only view of document flowtrack", "operationId"=>"ApiDocflowtracksFlowtrackviaapiPost", "x-api-path-slug"=>"apidocflowtracksflowtrackviaapi-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow", "Link", "Flow", "Track"]}}, "/rawdata"=>{"post"=>{"summary"=>"Returns raw data response as json FOR SINGLE CLIENT DOC", "description"=>"This API call gets you underlying raw data of the document. All you need to do is supply Auth token and Document Key as part of the call", "operationId"=>"RawdataPost", "x-api-path-slug"=>"rawdata-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Raw", "Data", "Response", "As", "Json", "FOR", "SINGLE", "CLIENT", "DOC"]}}, "/getclientdocs"=>{"post"=>{"summary"=>"Get List of Client Documents By Document ID", "description"=>"In order to export as PDf, you will need to have client document ID available for that specific document you are looking to download.", "operationId"=>"GetclientdocsPost", "x-api-path-slug"=>"getclientdocs-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Client", "Documents", "Document", "ID"]}}, "/clientdocs/exportpdf/{id}"=>{"get"=>{"summary"=>"Export As PDF", "description"=>"In order to export as PDf, you will need to have client document ID available for that specific document you are looking to download.", "operationId"=>"ClientdocsExportpdfByIdGet", "x-api-path-slug"=>"clientdocsexportpdfid-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Export", "As", "PDF"]}}}}, "apis"=>{"name"=>"Docsmore", "x-slug"=>"docsmore", "description"=>"FORM.FILL.SIGN - With Docsmore, the process of setting up a form and sending to users to complete or sign is simplified. Use our platform to easily upload a document, specify form fields/signage, and send to users for completion. Present forms to you...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28946-api-docsmore-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"7238418", "tags"=>"Documents,Forms,SaaS,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"docsmore/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Docsmore", "x-api-slug"=>"docsmore", "description"=>"FORM.FILL.SIGN - With Docsmore, the process of setting up a form and sending to users to complete or sign is simplified. Use our platform to easily upload a document, specify form fields/signage, and send to users for completion. Present forms to you...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28946-api-docsmore-com.jpg", "humanURL"=>"http://api.docsmore.com", "baseURL"=>"https://api.docsmore.com//", "tags"=>"Documents,Forms,SaaS,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/docsmore/docsmore-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-email", "url"=>"contact@docsmore.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/docsmore"}, {"type"=>"x-website", "url"=>"http://api.docsmore.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
codefresh{"codefresh-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Codefresh", "x-complete"=>1, "info"=>{"title"=>"Codefresh API", "description"=>"codefresh-api-swagger2-0-specification", "termsOfService"=>"http://www.codefresh.io", "contact"=>{"name"=>"Codefresh api team", "url"=>"http://www.codefresh.io"}, "version"=>"1.0.0"}, "host"=>"g.codefresh.io", "basePath"=>"/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/user"=>{"get"=>{"summary"=>"Get User", "description"=>"Get user.", "operationId"=>"getUser", "x-api-path-slug"=>"user-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/user/changeaccount/{accountId}"=>{"post"=>{"summary"=>"Post User Changeaccount Accountid", "description"=>"Post user changeaccount accountid.", "operationId"=>"postUserChangeaccountAccount", "x-api-path-slug"=>"userchangeaccountaccountid-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"id of an object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Changeaccount", "Accountid"]}}, "/progress/{id}"=>{"get"=>{"summary"=>"Get Progress", "description"=>"Get progress.", "operationId"=>"getProgress", "x-api-path-slug"=>"progressid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Progress"]}}, "/progress/download/{id}"=>{"get"=>{"summary"=>"Get Progress Download", "description"=>"Get progress download.", "operationId"=>"getProgressDownload", "x-api-path-slug"=>"progressdownloadid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Progress", "Download"]}}, "/repos/settings/{repoOwner}/{repoName}"=>{"get"=>{"summary"=>"Get Repos Settings Repoowner Reponame", "description"=>"Get repos settings repoowner reponame.", "operationId"=>"getReposSettingsRepoownerReponame", "x-api-path-slug"=>"repossettingsrepoownerreponame-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Settings", "Repoowner", "Reponame"]}}, "/repos/settings"=>{"post"=>{"summary"=>"Post Repos Settings", "description"=>"Post repos settings.", "operationId"=>"postReposSettings", "x-api-path-slug"=>"repossettings-post", "parameters"=>[{"in"=>"body", "name"=>"settings", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Settings"]}}, "/images"=>{"get"=>{"summary"=>"Get Images", "description"=>"Get images.", "operationId"=>"getImages", "x-api-path-slug"=>"images-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images"]}}, "/images/external"=>{"post"=>{"summary"=>"Post Images External", "description"=>"Post images external.", "operationId"=>"postImagesExternal", "x-api-path-slug"=>"imagesexternal-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "External"]}, "parameters"=>{"summary"=>"Parameters Images External", "description"=>"Parameters images external.", "operationId"=>"parametersImagesExternal", "x-api-path-slug"=>"imagesexternal-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Images", "External"]}}, "/images/{imageId}"=>{"get"=>{"summary"=>"Get Images Imageid", "description"=>"Get images imageid.", "operationId"=>"getImagesImage", "x-api-path-slug"=>"imagesimageid-get", "parameters"=>[{"in"=>"path", "name"=>"imageId", "description"=>"id of the Image"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Imageid"]}}, "/images/{imageName}/tags"=>{"get"=>{"summary"=>"Get Images Imagename Tags", "description"=>"Get images imagename tags.", "operationId"=>"getImagesImagenameTags", "x-api-path-slug"=>"imagesimagenametags-get", "parameters"=>[{"in"=>"path", "name"=>"imageName", "description"=>"name of the image"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Imagename", "Tags"]}}, "/images/{internalImageId}/metadata"=>{"get"=>{"summary"=>"Get Images Internalimageid Metadata", "description"=>"Get images internalimageid metadata.", "operationId"=>"getImagesInternalimageMetadata", "x-api-path-slug"=>"imagesinternalimageidmetadata-get", "parameters"=>[{"in"=>"path", "name"=>"internalImageId", "description"=>"id of the Image (from docker inspect)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Internalimageid", "Metadata"]}, "post"=>{"summary"=>"Post Images Internalimageid Metadata", "description"=>"Post images internalimageid metadata.", "operationId"=>"postImagesInternalimageMetadata", "x-api-path-slug"=>"imagesinternalimageidmetadata-post", "parameters"=>[{"in"=>"body", "name"=>"data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"internalImageId", "description"=>"id of the Image (from docker inspect)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Internalimageid", "Metadata"]}}, "/images/{internalImageId}/metadata/{keyName}"=>{"delete"=>{"summary"=>"Delete Images Internalimageid Metadata Keyname", "description"=>"Delete images internalimageid metadata keyname.", "operationId"=>"deleteImagesInternalimageMetadataKeyname", "x-api-path-slug"=>"imagesinternalimageidmetadatakeyname-delete", "parameters"=>[{"in"=>"path", "name"=>"internalImageId", "description"=>"id of the Image from docker inspect"}, {"in"=>"path", "name"=>"keyName", "description"=>"name of the metadata key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Internalimageid", "Metadata", "Keyname"]}}, "/runtime/testit"=>{"post"=>{"summary"=>"Post Runtime Testit", "description"=>"Post runtime testit.", "operationId"=>"postRuntimeTestit", "x-api-path-slug"=>"runtimetestit-post", "parameters"=>[{"in"=>"body", "name"=>"options", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runtime", "Testit"]}}, "/pipelines"=>{"get"=>{"summary"=>"Get Pipelines", "description"=>"Get pipelines.", "operationId"=>"getPipelines", "x-api-path-slug"=>"pipelines-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipelines"]}, "post"=>{"summary"=>"Post Pipelines", "description"=>"Post pipelines.", "operationId"=>"postPipelines", "x-api-path-slug"=>"pipelines-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipelines"]}}, "/pipelines/{name}"=>{"get"=>{"summary"=>"Get Pipelines Name", "description"=>"Get pipelines name.", "operationId"=>"getPipelinesName", "x-api-path-slug"=>"pipelinesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Name of pipeline"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipelines", "Name"]}, "put"=>{"summary"=>"Put Pipelines Name", "description"=>"Put pipelines name.", "operationId"=>"putPipelinesName", "x-api-path-slug"=>"pipelinesname-put", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Name of pipeline"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipelines", "Name"]}, "delete"=>{"summary"=>"Delete Pipelines Name", "description"=>"Delete pipelines name.", "operationId"=>"deletePipelinesName", "x-api-path-slug"=>"pipelinesname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Name of pipeline"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pipelines", "Name"]}}, "/admin/accounts"=>{"get"=>{"summary"=>"Get Admin Accounts", "description"=>"Get admin accounts.", "operationId"=>"getAdminAccounts", "x-api-path-slug"=>"adminaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Accounts"]}, "post"=>{"summary"=>"Post Admin Accounts", "description"=>"Post admin accounts.", "operationId"=>"postAdminAccounts", "x-api-path-slug"=>"adminaccounts-post", "parameters"=>[{"in"=>"body", "name"=>"account", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Accounts"]}}, "/admin/accounts/{id}"=>{"get"=>{"summary"=>"Get Admin Accounts", "description"=>"Get admin accounts.", "operationId"=>"getAdminAccounts", "x-api-path-slug"=>"adminaccountsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Accounts"]}, "delete"=>{"summary"=>"Delete Admin Accounts", "description"=>"Delete admin accounts.", "operationId"=>"deleteAdminAccounts", "x-api-path-slug"=>"adminaccountsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Accounts"]}}, "/admin/accounts/{id}/update"=>{"post"=>{"summary"=>"Post Admin Accounts Update", "description"=>"Post admin accounts update.", "operationId"=>"postAdminAccountsUpdate", "x-api-path-slug"=>"adminaccountsidupdate-post", "parameters"=>[{"in"=>"body", "name"=>"accountDetails", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Accounts"]}}, "/admin/accounts/addpendinguser"=>{"post"=>{"summary"=>"Post Admin Accounts Addpendinguser", "description"=>"Post admin accounts addpendinguser.", "operationId"=>"postAdminAccountsAddpendinguser", "x-api-path-slug"=>"adminaccountsaddpendinguser-post", "parameters"=>[{"in"=>"body", "name"=>"newUser", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Accounts", "Pendinguser"]}}, "/accounts/{id}/users"=>{"get"=>{"summary"=>"Get Accounts Users", "description"=>"Get accounts users.", "operationId"=>"getAccountsUsers", "x-api-path-slug"=>"accountsidusers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Users"]}}, "/accounts/{id}/update"=>{"post"=>{"summary"=>"Post Accounts Update", "description"=>"Post accounts update.", "operationId"=>"postAccountsUpdate", "x-api-path-slug"=>"accountsidupdate-post", "parameters"=>[{"in"=>"body", "name"=>"updateData", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/accounts/{id}/adduser"=>{"post"=>{"summary"=>"Post Accounts Adduser", "description"=>"Post accounts adduser.", "operationId"=>"postAccountsAdduser", "x-api-path-slug"=>"accountsidadduser-post", "parameters"=>[{"in"=>"body", "name"=>"newUser", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "User"]}}, "/accounts/{accountId}/{userId}/adduser"=>{"post"=>{"summary"=>"Post Accounts Adduser", "description"=>"Post accounts adduser.", "operationId"=>"postAccountsAccountUserAdduser", "x-api-path-slug"=>"accountsaccountiduseridadduser-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"id of an object"}, {"in"=>"path", "name"=>"userId", "description"=>"id of an object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "User"]}}, "/accounts/{accountId}/{userId}"=>{"delete"=>{"summary"=>"Delete Accounts", "description"=>"Delete accounts.", "operationId"=>"deleteAccountsAccountUser", "x-api-path-slug"=>"accountsaccountiduserid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"id of an object"}, {"in"=>"path", "name"=>"userId", "description"=>"id of an object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/accounts/{id}/updateuser"=>{"post"=>{"summary"=>"Post Accounts Updateuser", "description"=>"Post accounts updateuser.", "operationId"=>"postAccountsUpdateuser", "x-api-path-slug"=>"accountsidupdateuser-post", "parameters"=>[{"in"=>"body", "name"=>"userDetails", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "User"]}}, "/accounts/{accountId}/{userId}/admin"=>{"post"=>{"summary"=>"Post Accounts Admin", "description"=>"Post accounts admin.", "operationId"=>"postAccountsAccountUserAdmin", "x-api-path-slug"=>"accountsaccountiduseridadmin-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"id of an object"}, {"in"=>"path", "name"=>"userId", "description"=>"id of an object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Admin"]}, "delete"=>{"summary"=>"Delete Accounts Admin", "description"=>"Delete accounts admin.", "operationId"=>"deleteAccountsAccountUserAdmin", "x-api-path-slug"=>"accountsaccountiduseridadmin-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"id of an object"}, {"in"=>"path", "name"=>"userId", "description"=>"id of an object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Admin"]}}, "/providers/github/hook"=>{"post"=>{"summary"=>"Post Provers Github Hook", "description"=>"Post provers github hook.", "operationId"=>"postProversGithubHook", "x-api-path-slug"=>"providersgithubhook-post", "parameters"=>[{"in"=>"body", "name"=>"after", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"commits", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"head_commit", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"ref", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"repository", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"send-mail-and-update-github", "description"=>"will this hook send notification to related users"}, {"in"=>"body", "name"=>"sender", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"x-github-delivery", "description"=>"the id from github"}, {"in"=>"header", "name"=>"x-github-event", "description"=>"event type of this hook"}, {"in"=>"header", "name"=>"x-github-signature", "description"=>"the signature from github"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provers", "Github", "Hook"]}}, "/builds/{buildId}"=>{"get"=>{"summary"=>"Get Builds Buildid", "description"=>"Get builds buildid.", "operationId"=>"getBuildsBuild", "x-api-path-slug"=>"buildsbuildid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds", "Buildid"]}}, "/builds/{serviceId}"=>{"post"=>{"summary"=>"Post Builds Serviceid", "description"=>"Post builds serviceid.", "operationId"=>"postBuildsService", "x-api-path-slug"=>"buildsserviceid-post", "parameters"=>[{"in"=>"body", "name"=>"options", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds", "Serviceid"]}}, "/builds/{buildId}/update"=>{"post"=>{"summary"=>"Post Builds Buildid Update", "description"=>"Post builds buildid update.", "operationId"=>"postBuildsBuildUpdate", "x-api-path-slug"=>"buildsbuildidupdate-post", "parameters"=>[{"in"=>"body", "name"=>"options", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds", "Buildid"]}}, "/builds"=>{"get"=>{"summary"=>"Get Builds", "description"=>"Get builds.", "operationId"=>"getBuilds", "x-api-path-slug"=>"builds-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"account name"}, {"in"=>"query", "name"=>"repoName", "description"=>"repo name"}, {"in"=>"query", "name"=>"repoOwner", "description"=>"repo owner"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds"]}}, "/environments"=>{"get"=>{"summary"=>"Get Environments", "description"=>"Get environments.", "operationId"=>"getEnvironments", "x-api-path-slug"=>"environments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/environments/{id}/status"=>{"get"=>{"summary"=>"Get Environments Status", "description"=>"Get environments status.", "operationId"=>"getEnvironmentsStatus", "x-api-path-slug"=>"environmentsidstatus-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "Status"]}}, "/environments/{id}/stop"=>{"get"=>{"summary"=>"Get Environments Stop", "description"=>"Get environments stop.", "operationId"=>"getEnvironmentsStop", "x-api-path-slug"=>"environmentsidstop-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "Stop"]}}, "/environments/{id}/start"=>{"get"=>{"summary"=>"Get Environments Start", "description"=>"Get environments start.", "operationId"=>"getEnvironmentsStart", "x-api-path-slug"=>"environmentsidstart-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "Start"]}}, "/environments/{id}/pause"=>{"get"=>{"summary"=>"Get Environments Pause", "description"=>"Get environments pause.", "operationId"=>"getEnvironmentsPause", "x-api-path-slug"=>"environmentsidpause-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "Pause"]}}, "/environments/{id}/unpause"=>{"get"=>{"summary"=>"Get Environments Unpause", "description"=>"Get environments unpause.", "operationId"=>"getEnvironmentsUnpause", "x-api-path-slug"=>"environmentsidunpause-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "Unpause"]}}, "/environments/{id}/terminate"=>{"get"=>{"summary"=>"Get Environments Terminate", "description"=>"Get environments terminate.", "operationId"=>"getEnvironmentsTerminate", "x-api-path-slug"=>"environmentsidterminate-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "Terminate"]}}, "/environments/all/terminate"=>{"get"=>{"summary"=>"Get Environments All Terminate", "description"=>"Get environments all terminate.", "operationId"=>"getEnvironmentsAllTerminate", "x-api-path-slug"=>"environmentsallterminate-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "", "Terminate"]}}, "/environments/{id}/rename/{newName}"=>{"get"=>{"summary"=>"Get Environments Rename Newname", "description"=>"Get environments rename newname.", "operationId"=>"getEnvironmentsRenameNewname", "x-api-path-slug"=>"environmentsidrenamenewname-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the environment to rename"}, {"in"=>"path", "name"=>"newName", "description"=>"The new name to assign to the environment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "Rename", "Newname"]}}, "/payments/plans"=>{"get"=>{"summary"=>"Get Payments Plans", "description"=>"Get payments plans.", "operationId"=>"getPaymentsPlans", "x-api-path-slug"=>"paymentsplans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Plans"]}}, "/payments"=>{"get"=>{"summary"=>"Get Payments", "description"=>"Get payments.", "operationId"=>"getPayments", "x-api-path-slug"=>"payments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}, "post"=>{"summary"=>"Post Payments", "description"=>"Post payments.", "operationId"=>"postPayments", "x-api-path-slug"=>"payments-post", "parameters"=>[{"in"=>"body", "name"=>"data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}}, "/compositions"=>{"get"=>{"summary"=>"Get Compositions", "description"=>"Get compositions.", "operationId"=>"getCompositions", "x-api-path-slug"=>"compositions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compositions"]}, "post"=>{"summary"=>"Post Compositions", "description"=>"Post compositions.", "operationId"=>"postCompositions", "x-api-path-slug"=>"compositions-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compositions"]}}, "/compositions/{identifier}"=>{"get"=>{"summary"=>"Get Compositions Entifier", "description"=>"Get compositions entifier.", "operationId"=>"getCompositionsEntifier", "x-api-path-slug"=>"compositionsidentifier-get", "parameters"=>[{"in"=>"path", "name"=>"identifier", "description"=>"id or name of a composition"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compositions", "Entifier"]}}, "/compositions/{id}/duplicate"=>{"post"=>{"summary"=>"Post Compositions Duplicate", "description"=>"Post compositions duplicate.", "operationId"=>"postCompositionsDuplicate", "x-api-path-slug"=>"compositionsidduplicate-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compositions", "Duplicate"]}}, "/compositions/{id}"=>{"put"=>{"summary"=>"Put Compositions", "description"=>"Put compositions.", "operationId"=>"putCompositions", "x-api-path-slug"=>"compositionsid-put", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Update the name/variables/body of the composition with the id inserted", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compositions"]}, "delete"=>{"summary"=>"Delete Compositions", "description"=>"Delete compositions.", "operationId"=>"deleteCompositions", "x-api-path-slug"=>"compositionsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compositions"]}}, "/compositions/{identifier}/run"=>{"post"=>{"summary"=>"Post Compositions Entifier Run", "description"=>"Post compositions entifier run.", "operationId"=>"postCompositionsEntifierRun", "x-api-path-slug"=>"compositionsidentifierrun-post", "parameters"=>[{"in"=>"path", "name"=>"identifier", "description"=>"id or name of a composition"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compositions", "Entifier", "Run"]}}, "/workflow/{repoOwner}/{repoName}/file"=>{"post"=>{"summary"=>"Post Workflow Repoowner Reponame File", "description"=>"Post workflow repoowner reponame file.", "operationId"=>"postWorkflowRepoownerReponameFile", "x-api-path-slug"=>"workflowrepoownerreponamefile-post", "parameters"=>[{"in"=>"body", "name"=>"options", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"repoName", "description"=>"The name of the repo"}, {"in"=>"path", "name"=>"repoOwner", "description"=>"The name of the repo owner"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow", "Repoowner", "Reponame", "File"]}}, "/workflow"=>{"get"=>{"summary"=>"Get Workflow", "description"=>"Get workflow.", "operationId"=>"getWorkflow", "x-api-path-slug"=>"workflow-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"Fields to search by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workflow"]}}, "/features/{accountId}"=>{"get"=>{"summary"=>"Get Features Accountid", "description"=>"Get features accountid.", "operationId"=>"getFeaturesAccount", "x-api-path-slug"=>"featuresaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The ID of the account to query for feature availability"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Features", "Accountid"]}}, "/registry/auth/token"=>{"post"=>{"summary"=>"Post Registry Auth Token", "description"=>"Post registry auth token.", "operationId"=>"postRegistryAuthToken", "x-api-path-slug"=>"registryauthtoken-post", "parameters"=>[{"in"=>"body", "name"=>"options", "description"=>"Description of the token", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registry", "Auth", "Token"]}}}}, "apis"=>{"name"=>"Codefresh", "x-slug"=>"codefresh", "description"=>"Docker Automation and Collaboration for Agile Teams. Codefresh lets dev, QA and product work together on Docker compositions, including CI/CD, manual testing and feature previews.Codefresh enables you to instantly leverage all the benefits of Docker, w...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28738-codefresh-io.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"240033", "tags"=>"Enterprise,Orchestration,Relative Data,SaaS,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"codefresh/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Codefresh", "x-api-slug"=>"codefresh", "description"=>"Docker Automation and Collaboration for Agile Teams. Codefresh lets dev, QA and product work together on Docker compositions, including CI/CD, manual testing and feature previews.Codefresh enables you to instantly leverage all the benefits of Docker, w...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28738-codefresh-io.jpg", "humanURL"=>"https://codefresh.io", "baseURL"=>"https://g.codefresh.io//api", "tags"=>"Enterprise,Orchestration,Relative Data,SaaS,Service API,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/codefresh/codefresh-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://codefresh.io/blog/"}, {"type"=>"x-command-line-interface", "url"=>"https://codefresh-io.github.io/cli/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/code-fresh"}, {"type"=>"x-documentation", "url"=>"https://codefresh.io/docs/"}, {"type"=>"x-github", "url"=>"https://github.com/codefresh-io"}, {"type"=>"x-openapi", "url"=>"https://g.codefresh.io/api/swagger.json"}, {"type"=>"x-plugins", "url"=>"https://github.com/codefresh-io/plugins"}, {"type"=>"x-pricing", "url"=>"https://codefresh.io/pricing/"}, {"type"=>"x-privacy-policy", "url"=>"https://codefresh.io/docs/docs/terms-and-privacy-policy/privacy-policy/"}, {"type"=>"x-status", "url"=>"http://status.codefresh.io/"}, {"type"=>"x-terms-of-service", "url"=>"https://codefresh.io/docs/docs/terms-and-privacy-policy/terms-of-service/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/codefresh"}, {"type"=>"x-website", "url"=>"https://codefresh.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
microsoft-office-365{"microsoft-office-365-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Microsoft Office 365", "x-complete"=>1, "info"=>{"title"=>"Microsoft Office 365", "description"=>"office-365-is-the-brand-name-used-by-microsoft-for-a-group-of-software-plus-services-subscriptions-that-provides-productivity-software-and-related-services-to-its-subscribers-", "version"=>"1.0.0"}, "host"=>"outlook.office365.com", "basePath"=>"/ews/odata/Me", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/AllServices"=>{"get"=>{"summary"=>"Get All Services", "description"=>"Get all services.", "operationId"=>"getAllservices", "x-api-path-slug"=>"allservices-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Allservices"]}}, "/Calendar"=>{"get"=>{"summary"=>"Get Calendar", "description"=>"Retrieve information about the default calendar by using the...", "operationId"=>"getCalendar", "x-api-path-slug"=>"calendar-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/CalendarGroups"=>{"get"=>{"summary"=>"Get Calendar Groups", "description"=>"You can request all the calendar groups in a mailbox (or a f...", "operationId"=>"getCalendargroups", "x-api-path-slug"=>"calendargroups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendargroups"]}, "post"=>{"summary"=>"Add Calendar Groups", "description"=>"You can create a calendar group by sending a POST request wi...", "operationId"=>"postCalendargroups", "x-api-path-slug"=>"calendargroups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendargroups"]}}, "/CalendarGroups{calendargroup_id}"=>{"get"=>{"summary"=>"Get Calendar Groups", "description"=>"Get calendargroups calendargroup", "operationId"=>"getCalendargroupsCalendargroup", "x-api-path-slug"=>"calendargroupscalendargroup-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendargroups", "Calendargroup"]}, "post"=>{"summary"=>"Add Calendar Groups", "description"=>"Post calendargroups calendargroup", "operationId"=>"postCalendargroupsCalendargroup", "x-api-path-slug"=>"calendargroupscalendargroup-id-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendargroups", "Calendargroup"]}, "delete"=>{"summary"=>"Delete Calendar Groups", "description"=>"Deleting a calendar group is as simple as sending a DELETE r...", "operationId"=>"deleteCalendargroupsCalendargroup", "x-api-path-slug"=>"calendargroupscalendargroup-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendargroups", "Calendargroup"]}, "patch"=>{"summary"=>"Patch Calendar Groups", "description"=>"You can update a calendar group by sending a PATCH request w...", "operationId"=>"patchCalendargroupsCalendargroup", "x-api-path-slug"=>"calendargroupscalendargroup-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendargroups", "Calendargroup"]}, "parameters"=>{"summary"=>"Parameters Calendar Groups", "description"=>"Parameters calendargroups calendargroup", "operationId"=>"parametersCalendargroupsCalendargroup", "x-api-path-slug"=>"calendargroupscalendargroup-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendargroups", "Calendargroup"]}}, "/CalendarGroups{calendargroup_id}/Calendars"=>{"get"=>{"summary"=>"Get Calendar Groups Calendars", "description"=>"You can request all the user's calendars (or a filtered list...", "operationId"=>"getCalendargroupsCalendargroupCalendars", "x-api-path-slug"=>"calendargroupscalendargroup-idcalendars-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendargroups", "Calendargroup", "", "Calendars"]}, "post"=>{"summary"=>"Add Calendar Groups Calendars", "description"=>"You can create a calendar by sending a POST request with a J...", "operationId"=>"postCalendargroupsCalendargroupCalendars", "x-api-path-slug"=>"calendargroupscalendargroup-idcalendars-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendargroups", "Calendargroup", "", "Calendars"]}, "parameters"=>{"summary"=>"Parameters Calendar Groups Calendars", "description"=>"Parameters calendargroups calendargroup calendars", "operationId"=>"parametersCalendargroupsCalendargroupCalendars", "x-api-path-slug"=>"calendargroupscalendargroup-idcalendars-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendargroups", "Calendargroup", "", "Calendars"]}}, "/Calendars{calendar_id}"=>{"get"=>{"summary"=>"Get Calendars Calendar", "description"=>"You can also retrieve information about a specific calendar ...", "operationId"=>"getCalendarsCalendar", "x-api-path-slug"=>"calendarscalendar-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendars", "Calendar"]}, "delete"=>{"summary"=>"Delete Calendars Calendar", "description"=>"Deleting a calendar is as simple as sending a DELETE request...", "operationId"=>"deleteCalendarsCalendar", "x-api-path-slug"=>"calendarscalendar-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendars", "Calendar"]}, "patch"=>{"summary"=>"Patch Calendars Calendar", "description"=>"You can update a calendar by sending a PATCH request with a ...", "operationId"=>"patchCalendarsCalendar", "x-api-path-slug"=>"calendarscalendar-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendars", "Calendar"]}, "parameters"=>{"summary"=>"Parameters Calendars Calendar", "description"=>"Parameters calendars calendar", "operationId"=>"parametersCalendarsCalendar", "x-api-path-slug"=>"calendarscalendar-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendars", "Calendar"]}}, "/Calendars{calendar_id}/Events"=>{"get"=>{"summary"=>"Get Calendars Calendar Events", "description"=>"You can request all the events across all calendars (or a fi...", "operationId"=>"getCalendarsCalendarEvents", "x-api-path-slug"=>"calendarscalendar-idevents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendars", "Calendar", "", "Events"]}, "post"=>{"summary"=>"Add Calendars Calendar Events", "description"=>"Post calendars calendar events", "operationId"=>"postCalendarsCalendarEvents", "x-api-path-slug"=>"calendarscalendar-idevents-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendars", "Calendar", "", "Events"]}, "parameters"=>{"summary"=>"Parameters Calendars Calendar Events", "description"=>"Parameters calendars calendar events", "operationId"=>"parametersCalendarsCalendarEvents", "x-api-path-slug"=>"calendarscalendar-idevents-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendars", "Calendar", "", "Events"]}}, "/ContactFolders{contact_folder_id}"=>{"get"=>{"summary"=>"Get Contact Folders Contact Folder", "description"=>"You can access the default contact folder by using the const...", "operationId"=>"getContactfoldersContactFolder", "x-api-path-slug"=>"contactfolderscontact-folder-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contactfolders", "Contact", "Folder"]}, "parameters"=>{"summary"=>"Parameters Contact Folders Contact Folder", "description"=>"Parameters contactfolders contact folder", "operationId"=>"parametersContactfoldersContactFolder", "x-api-path-slug"=>"contactfolderscontact-folder-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contactfolders", "Contact", "Folder"]}}, "/ContactFolders{contact_folder_id}/ChildFolders"=>{"get"=>{"summary"=>"Get Contact Folders Contact Folder Childfolders", "description"=>"All non-default contact folders are stored as children of th...", "operationId"=>"getContactfoldersContactFolderChildfolders", "x-api-path-slug"=>"contactfolderscontact-folder-idchildfolders-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contactfolders", "Contact", "Folder", "", "Childfolders"]}, "parameters"=>{"summary"=>"Parameters Contact Folders Contact Folder Childfolders", "description"=>"Parameters contactfolders contact folder childfolders", "operationId"=>"parametersContactfoldersContactFolderChildfolders", "x-api-path-slug"=>"contactfolderscontact-folder-idchildfolders-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contactfolders", "Contact", "Folder", "", "Childfolders"]}}, "/ContactFolders{contact_folder_id}/Contacts"=>{"get"=>{"summary"=>"Get Contact Folders Contact Folder Contacts", "description"=>"You can request all contacts (or a filtered set by using the...", "operationId"=>"getContactfoldersContactFolderContacts", "x-api-path-slug"=>"contactfolderscontact-folder-idcontacts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contactfolders", "Contact", "Folder", "", "Contacts"]}, "post"=>{"summary"=>"Add Contact Folders Contact Folder Contacts", "description"=>"You can create a contact by sending a POST request with a JS...", "operationId"=>"postContactfoldersContactFolderContacts", "x-api-path-slug"=>"contactfolderscontact-folder-idcontacts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contactfolders", "Contact", "Folder", "", "Contacts"]}, "parameters"=>{"summary"=>"Parameters Contact Folders Contact Folder Contacts", "description"=>"Parameters contactfolders contact folder contacts", "operationId"=>"parametersContactfoldersContactFolderContacts", "x-api-path-slug"=>"contactfolderscontact-folder-idcontacts-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contactfolders", "Contact", "Folder", "", "Contacts"]}}, "/Contacts{contact_id}"=>{"get"=>{"summary"=>"Get Contacts Contact", "description"=>"You can retrieve information about a specific contact by usi...", "operationId"=>"getContactsContact", "x-api-path-slug"=>"contactscontact-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Contact"]}, "post"=>{"summary"=>"Add Contacts Contact", "description"=>"You can create a contact by sending a POST request with a JS...", "operationId"=>"postContactsContact", "x-api-path-slug"=>"contactscontact-id-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Contact"]}, "delete"=>{"summary"=>"Delete Contacts Contact", "description"=>"You can delete a contact by simply sending a DELETE request ...", "operationId"=>"deleteContactsContact", "x-api-path-slug"=>"contactscontact-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Contact"]}, "patch"=>{"summary"=>"Patch Contacts Contact", "description"=>"To update a contact, send a PATCH request to the URL of the ...", "operationId"=>"patchContactsContact", "x-api-path-slug"=>"contactscontact-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Contact"]}, "parameters"=>{"summary"=>"Parameters Contacts Contact", "description"=>"Parameters contacts contact", "operationId"=>"parametersContactsContact", "x-api-path-slug"=>"contactscontact-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Contact"]}}, "/Contacts{contact_id}/Attachments"=>{"get"=>{"summary"=>"Get Contacts Contact Attachments", "description"=>"To get attachments, send a GET request to the Attachments pr...", "operationId"=>"getContactsContactAttachments", "x-api-path-slug"=>"contactscontact-idattachments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Contact", "", "Attachments"]}, "post"=>{"summary"=>"Add Contacts Contact Attachments", "description"=>"To add an attachment to an item, send a POST request to the ...", "operationId"=>"postContactsContactAttachments", "x-api-path-slug"=>"contactscontact-idattachments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Contact", "", "Attachments"]}, "delete"=>{"summary"=>"Delete Contacts Contact Attachments", "description"=>"To delete an attachment, send a DELETE request to the URL of...", "operationId"=>"deleteContactsContactAttachments", "x-api-path-slug"=>"contactscontact-idattachments-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Contact", "", "Attachments"]}, "parameters"=>{"summary"=>"Parameters Contacts Contact Attachments", "description"=>"Parameters contacts contact attachments", "operationId"=>"parametersContactsContactAttachments", "x-api-path-slug"=>"contactscontact-idattachments-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Contact", "", "Attachments"]}}, "/Events{event_id}"=>{"get"=>{"summary"=>"Get Events Event", "description"=>"You can also retrieve information about a specific event by ...", "operationId"=>"getEventsEvent", "x-api-path-slug"=>"eventsevent-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Event"]}, "delete"=>{"summary"=>"Delete Events Event", "description"=>"Upon success, the appointment is moved to the user's Deleted...", "operationId"=>"deleteEventsEvent", "x-api-path-slug"=>"eventsevent-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Event"]}, "patch"=>{"summary"=>"Patch Events Event", "description"=>"To update an event, send a PATCH request to the URL of the e...", "operationId"=>"patchEventsEvent", "x-api-path-slug"=>"eventsevent-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Event"]}, "parameters"=>{"summary"=>"Parameters Events Event", "description"=>"Parameters events event", "operationId"=>"parametersEventsEvent", "x-api-path-slug"=>"eventsevent-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Event"]}}, "/Events{event_id}/Accept"=>{"post"=>{"summary"=>"Add Events Event Accept", "description"=>"Post events event accept", "operationId"=>"postEventsEventAccept", "x-api-path-slug"=>"eventsevent-idaccept-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Event", "", "Accept"]}, "parameters"=>{"summary"=>"Parameters Events Event Accept", "description"=>"Parameters events event accept", "operationId"=>"parametersEventsEventAccept", "x-api-path-slug"=>"eventsevent-idaccept-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Event", "", "Accept"]}}, "/Events{event_id}/Decline"=>{"post"=>{"summary"=>"Add Events Event Decline", "description"=>"Post events event decline", "operationId"=>"postEventsEventDecline", "x-api-path-slug"=>"eventsevent-iddecline-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Event", "", "Decline"]}, "parameters"=>{"summary"=>"Parameters Events Event Decline", "description"=>"Parameters events event decline", "operationId"=>"parametersEventsEventDecline", "x-api-path-slug"=>"eventsevent-iddecline-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Event", "", "Decline"]}}, "/Events{event_id}/TentativelyAccept"=>{"post"=>{"summary"=>"Add Events Event Tentatively Accept", "description"=>"Post events event tentativelyaccept", "operationId"=>"postEventsEventTentativelyaccept", "x-api-path-slug"=>"eventsevent-idtentativelyaccept-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Event", "", "Tentativelyaccept"]}, "parameters"=>{"summary"=>"Parameters Events Event Tentatively Accept", "description"=>"Parameters events event tentativelyaccept", "operationId"=>"parametersEventsEventTentativelyaccept", "x-api-path-slug"=>"eventsevent-idtentativelyaccept-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Event", "", "Tentativelyaccept"]}}, "/FirstSignIn"=>{"get"=>{"summary"=>"Get Firstsignin", "description"=>"Get firstsignin", "operationId"=>"getFirstsignin", "x-api-path-slug"=>"firstsignin-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firstsignin"]}}, "/Folders{folder_id}"=>{"get"=>{"summary"=>"Get Folders Folder", "description"=>"You can retrieve information about other folders by using th...", "operationId"=>"getFoldersFolder", "x-api-path-slug"=>"foldersfolder-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folders", "Folder"]}, "post"=>{"summary"=>"Add Folders Folder", "description"=>"You can create a folder by sending a POST request with a JSO...", "operationId"=>"postFoldersFolder", "x-api-path-slug"=>"foldersfolder-id-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folders", "Folder"]}, "delete"=>{"summary"=>"Delete Folders Folder", "description"=>"To delete a folder, send a DELETE request to the URL of the ...", "operationId"=>"deleteFoldersFolder", "x-api-path-slug"=>"foldersfolder-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folders", "Folder"]}, "patch"=>{"summary"=>"Patch Folders Folder", "description"=>"You can update a folder by sending a PATCH request with a JS...", "operationId"=>"patchFoldersFolder", "x-api-path-slug"=>"foldersfolder-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folders", "Folder"]}, "parameters"=>{"summary"=>"Parameters Folders Folder", "description"=>"Parameters folders folder", "operationId"=>"parametersFoldersFolder", "x-api-path-slug"=>"foldersfolder-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folders", "Folder"]}}, "/Folders{folder_id}/Messages"=>{"get"=>{"summary"=>"Get Folders Folder Messages", "description"=>"You can request all the emails and meeting requests in a fol...", "operationId"=>"getFoldersFolderMessages", "x-api-path-slug"=>"foldersfolder-idmessages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folders", "Folder", "", "Messages"]}, "post"=>{"summary"=>"Add Folders Folder Messages", "description"=>"You can create an email by sending a POST request with a JSO...", "operationId"=>"postFoldersFolderMessages", "x-api-path-slug"=>"foldersfolder-idmessages-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"MessageDisposition", "description"=>"When sending a POST request to create an email, there is an optional MessageDisposition query parameter that controls what happens to the message as it is created"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folders", "Folder", "", "Messages"]}, "parameters"=>{"summary"=>"Parameters Folders Folder Messages", "description"=>"Parameters folders folder messages", "operationId"=>"parametersFoldersFolderMessages", "x-api-path-slug"=>"foldersfolder-idmessages-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folders", "Folder", "", "Messages"]}}, "/Messages{event_id}/Send"=>{"post"=>{"summary"=>"Add Messages Event Send", "description"=>"You can send an existing email that has the IsDraft property...", "operationId"=>"postMessagesEventSend", "x-api-path-slug"=>"messagesevent-idsend-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Event", "", "Send"]}, "parameters"=>{"summary"=>"Parameters Messages Event Send", "description"=>"Parameters messages event send", "operationId"=>"parametersMessagesEventSend", "x-api-path-slug"=>"messagesevent-idsend-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Event", "", "Send"]}}, "/Messages{message_id}"=>{"get"=>{"summary"=>"Get Messages Message", "description"=>"You can request information about a specific email or meetin...", "operationId"=>"getMessagesMessage", "x-api-path-slug"=>"messagesmessage-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message"]}, "delete"=>{"summary"=>"Delete Messages Message", "description"=>"You can delete email by simply sending a DELETE request to t...", "operationId"=>"deleteMessagesMessage", "x-api-path-slug"=>"messagesmessage-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message"]}, "patch"=>{"summary"=>"Patch Messages Message", "description"=>"You can update an existing email by sending a PATCH request ...", "operationId"=>"patchMessagesMessage", "x-api-path-slug"=>"messagesmessage-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message"]}, "parameters"=>{"summary"=>"Parameters Messages Message", "description"=>"Parameters messages message", "operationId"=>"parametersMessagesMessage", "x-api-path-slug"=>"messagesmessage-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message"]}}, "/Messages{message_id}/Copy"=>{"post"=>{"summary"=>"Add Messages Message Copy", "description"=>"Post messages message copy", "operationId"=>"postMessagesMessageCopy", "x-api-path-slug"=>"messagesmessage-idcopy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message", "", "Copy"]}, "parameters"=>{"summary"=>"Parameters Messages Message Copy", "description"=>"Parameters messages message copy", "operationId"=>"parametersMessagesMessageCopy", "x-api-path-slug"=>"messagesmessage-idcopy-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message", "", "Copy"]}}, "/Messages{message_id}/CreateForward"=>{"post"=>{"summary"=>"Add Messages Message Createforward", "description"=>"Post messages message createforward", "operationId"=>"postMessagesMessageCreateforward", "x-api-path-slug"=>"messagesmessage-idcreateforward-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message", "", "Createforward"]}, "parameters"=>{"summary"=>"Parameters Messages Message Createforward", "description"=>"Parameters messages message createforward", "operationId"=>"parametersMessagesMessageCreateforward", "x-api-path-slug"=>"messagesmessage-idcreateforward-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message", "", "Createforward"]}}, "/Messages{message_id}/CreateReply"=>{"post"=>{"summary"=>"Add Messages Message Createreply", "description"=>"Post messages message createreply", "operationId"=>"postMessagesMessageCreatereply", "x-api-path-slug"=>"messagesmessage-idcreatereply-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message", "", "Createreply"]}, "parameters"=>{"summary"=>"Parameters Messages Message Createreply", "description"=>"Parameters messages message createreply", "operationId"=>"parametersMessagesMessageCreatereply", "x-api-path-slug"=>"messagesmessage-idcreatereply-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message", "", "Createreply"]}}, "/Messages{message_id}/CreateReplyAll"=>{"post"=>{"summary"=>"Add Messages Message Create Reply All", "description"=>"Post messages message createreplyall", "operationId"=>"postMessagesMessageCreatereplyall", "x-api-path-slug"=>"messagesmessage-idcreatereplyall-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message", "", "Createreplyall"]}, "parameters"=>{"summary"=>"Parameters Messages Message Create Reply All", "description"=>"Parameters messages message createreplyall", "operationId"=>"parametersMessagesMessageCreatereplyall", "x-api-path-slug"=>"messagesmessage-idcreatereplyall-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message", "", "Createreplyall"]}}, "/Messages{message_id}/Forward"=>{"post"=>{"summary"=>"Add Messages Message Forward", "description"=>"You can forward an email by using the Forward action on the ...", "operationId"=>"postMessagesMessageForward", "x-api-path-slug"=>"messagesmessage-idforward-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message", "", "Forward"]}, "parameters"=>{"summary"=>"Parameters Messages Message Forward", "description"=>"Parameters messages message forward", "operationId"=>"parametersMessagesMessageForward", "x-api-path-slug"=>"messagesmessage-idforward-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message", "", "Forward"]}}, "/Messages{message_id}/Move"=>{"post"=>{"summary"=>"Add Messages Message Move", "description"=>"Post messages message move", "operationId"=>"postMessagesMessageMove", "x-api-path-slug"=>"messagesmessage-idmove-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message", "", "Move"]}, "parameters"=>{"summary"=>"Parameters Messages Message Move", "description"=>"Parameters messages message move", "operationId"=>"parametersMessagesMessageMove", "x-api-path-slug"=>"messagesmessage-idmove-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message", "", "Move"]}}, "/Messages{message_id}/Reply"=>{"post"=>{"summary"=>"Add Messages Message Reply", "description"=>"Post messages message reply", "operationId"=>"postMessagesMessageReply", "x-api-path-slug"=>"messagesmessage-idreply-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message", "", "Reply"]}, "parameters"=>{"summary"=>"Parameters Messages Message Reply", "description"=>"Parameters messages message reply", "operationId"=>"parametersMessagesMessageReply", "x-api-path-slug"=>"messagesmessage-idreply-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message", "", "Reply"]}}, "/Messages{message_id}/ReplyAll"=>{"post"=>{"summary"=>"Add Messages Message Replyall", "description"=>"Post messages message replyall", "operationId"=>"postMessagesMessageReplyall", "x-api-path-slug"=>"messagesmessage-idreplyall-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"(Untitled)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message", "", "Replyall"]}, "parameters"=>{"summary"=>"Parameters Messages Message Replyall", "description"=>"Parameters messages message replyall", "operationId"=>"parametersMessagesMessageReplyall", "x-api-path-slug"=>"messagesmessage-idreplyall-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Message", "", "Replyall"]}}, "/Services"=>{"get"=>{"summary"=>"Get Services", "description"=>"Get services", "operationId"=>"getServices", "x-api-path-slug"=>"services-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}}}, "apis"=>{"name"=>"Microsoft Office 365", "x-slug"=>"microsoft-office-365", "description"=>"Integrate Office 365 REST APIs powered by Microsoft Graph into your own app to connect to files, calendars, mail and more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/microsoft-office.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Provider,Documents,Productivity,Profiles,Relative Data,Service API,Spreadsheets,Stack,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"microsoft-office-365/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Microsoft Office 365", "x-api-slug"=>"microsoft-office-365", "description"=>"Integrate Office 365 REST APIs powered by Microsoft Graph into your own app to connect to files, calendars, mail and more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/microsoft-office.png", "humanURL"=>"http://office.com", "baseURL"=>"https://outlook.office365.com//ews/odata/Me", "tags"=>"API Provider,Documents,Productivity,Profiles,Relative Data,Service API,Spreadsheets,Stack,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/microsoft-office-365/services-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/microsoft-office-365/microsoft-office-365-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"http://dev.office.com"}, {"type"=>"x-github", "url"=>"https://github.com/OfficeDev"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/OfficeDev"}, {"type"=>"x-website", "url"=>"http://office.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
dataatwork{"open-skills-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DataAtWork", "x-complete"=>1, "info"=>{"title"=>"Open Skills API", "description"=>"a-complete-and-standard-data-store-for-canonical-and-emerging-skills-knowledge-abilities-tools-technolgies-and-how-they-relate-to-jobs-", "contact"=>{"name"=>"Work Data Initiative", "url"=>"http://www.dataatwork.org"}, "version"=>"1.0"}, "host"=>"api.dataatwork.org", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/jobs"=>{"get"=>{"summary"=>"Job Titles and Descriptions", "description"=>"Retrieves the names, descriptions, and UUIDs of all job titles.", "operationId"=>"retrieves-the-names-descriptions-and-uuids-of-all-job-titles", "x-api-path-slug"=>"jobs-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items per page"}, {"in"=>"query", "name"=>"offset", "description"=>"Pagination offset"}], "responses"=>{"400: for badly-formed requests, e.g. missing or invalid parameters"=>{"description"=>""}, "403: for authentication issues"=>{"description"=>""}, "409: for issues where the request is well-formed but cannot be completed"=>{"description"=>""}, 200=>{"description"=>"OK"}}, "tags"=>["Job", "Titles", "Descriptions"]}}, "/jobs/{id}"=>{"get"=>{"summary"=>"Job Title and Description", "description"=>"Retrieves the name, description, and UUID of a job by specifying its O*NET SOC Code or UUID.", "operationId"=>"retrieves-the-name-description-and-uuid-of-a-job-by-specifying-its-onet-soc-code-or-uuid", "x-api-path-slug"=>"jobsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The O*NET SOC Code or UUID of the job title to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "Title", "Description"]}}, "/jobs/{id}/related_skills"=>{"get"=>{"summary"=>"Skills Associated with a Job", "description"=>"Retrieves a collection of skills associated with a specified job.", "operationId"=>"retrieves-a-collection-of-skills-associated-with-a-specified-job", "x-api-path-slug"=>"jobsidrelated-skills-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The UUID of the job to retrieve skills for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Skills", "Associated", "Job"]}}, "/jobs/{id}/related_jobs"=>{"get"=>{"summary"=>"Jobs Associated with a Job", "description"=>"Retrieves a collection of jobs associated with a specified job.", "operationId"=>"retrieves-a-collection-of-jobs-associated-with-a-specified-job", "x-api-path-slug"=>"jobsidrelated-jobs-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The UUID of the job to retrieve related jobs for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs", "Associated", "Job"]}}, "/jobs/autocomplete"=>{"get"=>{"summary"=>"Job Title Autocomplete", "description"=>"Retrieves the names, descriptions, and UUIDs of all job titles matching a given search criteria.", "operationId"=>"retrieves-the-names-descriptions-and-uuids-of-all-job-titles-matching-a-given-search-criteria", "x-api-path-slug"=>"jobsautocomplete-get", "parameters"=>[{"in"=>"query", "name"=>"begins_with", "description"=>"Find job titles beginning with the given text fragment"}, {"in"=>"query", "name"=>"contains", "description"=>"Find job titles containing the given text fragment"}, {"in"=>"query", "name"=>"ends_with", "description"=>"Find job titles ending with the given text fragment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "Title", "Autocomplete"]}}, "/jobs/normalize"=>{"get"=>{"summary"=>"Job Title Normalization", "description"=>"Retrieves the canonical job title for a synonymous job title", "operationId"=>"retrieves-the-canonical-job-title-for-a-synonymous-job-title", "x-api-path-slug"=>"jobsnormalize-get", "parameters"=>[{"in"=>"query", "name"=>"job_title", "description"=>"Find the canonical job title(s) for jobs matching the given text fragment"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximumn number of job title synonyms to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "Title", "Normalization"]}}, "/jobs/unusual_titles"=>{"get"=>{"summary"=>"Unusual Job Titles", "description"=>"Retrieves a list of unusual job titles and the UUIDs of their canonical jobs.", "operationId"=>"retrieves-a-list-of-unusual-job-titles-and-the-uuids-of-their-canonical-jobs", "x-api-path-slug"=>"jobsunusual-titles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unusual", "Job", "Titles"]}}, "/skills"=>{"get"=>{"summary"=>"Skill Names and Descriptions", "description"=>"Retrieve the names, descriptions, and UUIDs of all skills.", "operationId"=>"retrieve-the-names-descriptions-and-uuids-of-all-skills", "x-api-path-slug"=>"skills-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of items per page"}, {"in"=>"query", "name"=>"offset", "description"=>"Pagination offset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Skill", "Names", "Descriptions"]}}, "/skills/{id}"=>{"get"=>{"summary"=>"Skill Name and Description", "description"=>"Retrieves the name, description, and UUID of a job by specifying its UUID.", "operationId"=>"retrieves-the-name-description-and-uuid-of-a-job-by-specifying-its-uuid", "x-api-path-slug"=>"skillsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The UUID of the skill name to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Skill", "Name", "Description"]}}, "/skills/{id}/related_jobs"=>{"get"=>{"summary"=>"Jobs Associated with a Skill", "description"=>"Retrieves a collection of jobs associated with a specified skill.", "operationId"=>"retrieves-a-collection-of-jobs-associated-with-a-specified-skill", "x-api-path-slug"=>"skillsidrelated-jobs-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The UUID of the skill to retrieve jobs for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs", "Associated", "Skill"]}}, "/skills/{id}/related_skills"=>{"get"=>{"summary"=>"Skills Associated with a Skill", "description"=>"Retrieves a collection of skills associated with a specified skill.", "operationId"=>"retrieves-a-collection-of-skills-associated-with-a-specified-skill", "x-api-path-slug"=>"skillsidrelated-skills-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The UUID of the skill to retrieve related skills for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Skills", "Associated", "Skill"]}}, "/skills/autocomplete"=>{"get"=>{"summary"=>"Skill Name Autocomplete", "description"=>"Retrieves the names, descriptions, and UUIDs of all skills matching a given search criteria.", "operationId"=>"retrieves-the-names-descriptions-and-uuids-of-all-skills-matching-a-given-search-criteria", "x-api-path-slug"=>"skillsautocomplete-get", "parameters"=>[{"in"=>"query", "name"=>"begins_with", "description"=>"Find skill names beginning with the given text fragment"}, {"in"=>"query", "name"=>"contains", "description"=>"Find skill names containing the given text fragment"}, {"in"=>"query", "name"=>"ends_with", "description"=>"Find skill names ending with the given text fragment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Skill", "Name", "Autocomplete"]}}, "/skills/normalize"=>{"get"=>{"summary"=>"Skill Name Normalization", "description"=>"Retrieves the canonical skill name for a synonymous skill name", "operationId"=>"retrieves-the-canonical-skill-name-for-a-synonymous-skill-name", "x-api-path-slug"=>"skillsnormalize-get", "parameters"=>[{"in"=>"query", "name"=>"skill_name", "description"=>"Find the canonical skill name(s) for skills matching the given text fragment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Skill", "Name", "Normalization"]}}}}, "apis"=>{"name"=>"DataAtWork", "x-slug"=>"dataatwork", "description"=>"", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2016-10-12 at 11.19.25 PM.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Service Provider,Careers,Federal Government,General Data,Profiles,Skills", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"dataatwork/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Open Skills API", "x-api-slug"=>"open-skills-api", "description"=>"", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2016-10-12 at 11.19.25 PM.png", "humanURL"=>"http://www.dataatwork.org/", "baseURL"=>"://api.dataatwork.org//v1", "tags"=>"API Service Provider,Careers,Federal Government,General Data,Profiles,Skills", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/dataatwork/skillsnormalize-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/dataatwork/open-skills-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"http://api.dataatwork.org/v1/spec/"}, {"type"=>"x-website", "url"=>"http://www.dataatwork.org/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google-beacons{"google-proximity-beacon-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Beacons", "x-complete"=>1, "info"=>{"title"=>"Google Proximity Beacon", "description"=>"registers-manages-indexes-and-searches-beacons-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1beta1"}, "host"=>"proximitybeacon.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1beta1/beaconinfo:getforobserved"=>{"post"=>{"summary"=>"Get Observed Beacon Info", "description"=>"Given one or more beacon observations, returns any beacon information\nand attachments accessible to your application. Authorize by using the\n[API key](https://developers.google.com/beacons/proximity/how-tos/authorizing#APIKey)\nfor the application.", "operationId"=>"proximitybeacon.beaconinfo.getforobserved", "x-api-path-slug"=>"v1beta1beaconinfogetforobserved-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Beacon"]}}, "/v1beta1/beacons"=>{"get"=>{"summary"=>"Search Beacons", "description"=>"Searches the beacon registry for beacons that match the given search\ncriteria. Only those beacons that the client has permission to list\nwill be returned.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.", "operationId"=>"proximitybeacon.beacons.list", "x-api-path-slug"=>"v1beta1beacons-get", "parameters"=>[{"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of records to return for this request, up to aserver-defined upper limit"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A pagination token obtained from a previous request to list beacons"}, {"in"=>"query", "name"=>"projectId", "description"=>"The project id to list beacons under"}, {"in"=>"query", "name"=>"q", "description"=>"Filter query string that supports the following field filters:* **description:``** For example: **description:Room 3** Returns beacons whose description matches tokens in the string Room 3 (not necessarily that exact string)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Beacon"]}}, "/v1beta1/beacons:register"=>{"post"=>{"summary"=>"Register Beacon", "description"=>"Registers a previously unregistered beacon given its `advertisedId`.\nThese IDs are unique within the system. An ID can be registered only once.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", "operationId"=>"proximitybeacon.beacons.register", "x-api-path-slug"=>"v1beta1beaconsregister-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"projectId", "description"=>"The project id of the project the beacon will be registered to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Beacon"]}}, "/v1beta1/eidparams"=>{"get"=>{"summary"=>"Get Beacon Parameters", "description"=>"Gets the Proximity Beacon API's current public key and associated\nparameters used to initiate the Diffie-Hellman key exchange required to\nregister a beacon that broadcasts the Eddystone-EID format. This key\nchanges periodically; clients may cache it and re-use the same public key\nto provision and register multiple beacons. However, clients should be\nprepared to refresh this key when they encounter an error registering an\nEddystone-EID beacon.", "operationId"=>"proximitybeacon.getEidparams", "x-api-path-slug"=>"v1beta1eidparams-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Beacon"]}}, "/v1beta1/namespaces"=>{"get"=>{"summary"=>"Get Namespace", "description"=>"Lists all attachment namespaces owned by your Google Developers Console\nproject. Attachment data associated with a beacon must include a\nnamespaced type, and the namespace must be owned by your project.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.", "operationId"=>"proximitybeacon.namespaces.list", "x-api-path-slug"=>"v1beta1namespaces-get", "parameters"=>[{"in"=>"query", "name"=>"projectId", "description"=>"The project id to list namespaces under"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespace"]}}, "/v1beta1/{attachmentName}"=>{"delete"=>{"summary"=>"Delete Attachment", "description"=>"Deletes the specified attachment for the given beacon. Each attachment has\na unique attachment name (`attachmentName`) which is returned when you\nfetch the attachment data via this API. You specify this with the delete\nrequest to control which attachment is removed. This operation cannot be\nundone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", "operationId"=>"proximitybeacon.beacons.attachments.delete", "x-api-path-slug"=>"v1beta1attachmentname-delete", "parameters"=>[{"in"=>"path", "name"=>"attachmentName", "description"=>"The attachment name (`attachmentName`) ofthe attachment to remove"}, {"in"=>"query", "name"=>"projectId", "description"=>"The project id of the attachment to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/v1beta1/{beaconName}"=>{"delete"=>{"summary"=>"Delete Beacon", "description"=>"Deletes the specified beacon including all diagnostics data for the beacon\nas well as any attachments on the beacon (including those belonging to\nother projects). This operation cannot be undone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", "operationId"=>"proximitybeacon.beacons.delete", "x-api-path-slug"=>"v1beta1beaconname-delete", "parameters"=>[{"in"=>"path", "name"=>"beaconName", "description"=>"Beacon that should be deleted"}, {"in"=>"query", "name"=>"projectId", "description"=>"The project id of the beacon to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Beacon"]}, "get"=>{"summary"=>"Get Beacon", "description"=>"Returns detailed information about the specified beacon.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.\n\nRequests may supply an Eddystone-EID beacon name in the form:\n`beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID\nbroadcast by the beacon. The returned `Beacon` object will contain the\nbeacon's stable Eddystone-UID. Clients not authorized to resolve the\nbeacon's ephemeral Eddystone-EID broadcast will receive an error.", "operationId"=>"proximitybeacon.beacons.get", "x-api-path-slug"=>"v1beta1beaconname-get", "parameters"=>[{"in"=>"path", "name"=>"beaconName", "description"=>"Resource name of this beacon"}, {"in"=>"query", "name"=>"projectId", "description"=>"The project id of the beacon to request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Beacon"]}, "put"=>{"summary"=>"Update Beacon", "description"=>"Updates the information about the specified beacon. **Any field that you do\nnot populate in the submitted beacon will be permanently erased**, so you\nshould follow the \"read, modify, write\" pattern to avoid inadvertently\ndestroying data.\n\nChanges to the beacon status via this method will be silently ignored.\nTo update beacon status, use the separate methods on this API for\nactivation, deactivation, and decommissioning.\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", "operationId"=>"proximitybeacon.beacons.update", "x-api-path-slug"=>"v1beta1beaconname-put", "parameters"=>[{"in"=>"path", "name"=>"beaconName", "description"=>"Resource name of this beacon"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"projectId", "description"=>"The project id of the beacon to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Beacon"]}}, "/v1beta1/{beaconName}/attachments"=>{"get"=>{"summary"=>"Get Attachments", "description"=>"Returns the attachments for the specified beacon that match the specified\nnamespaced-type pattern.\n\nTo control which namespaced types are returned, you add the\n`namespacedType` query parameter to the request. You must either use\n`*/*`, to return all attachments, or the namespace must be one of\nthe ones returned from the `namespaces` endpoint.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.", "operationId"=>"proximitybeacon.beacons.attachments.list", "x-api-path-slug"=>"v1beta1beaconnameattachments-get", "parameters"=>[{"in"=>"path", "name"=>"beaconName", "description"=>"Beacon whose attachments should be fetched"}, {"in"=>"query", "name"=>"namespacedType", "description"=>"Specifies the namespace and type of attachment to include in response innamespace/type format"}, {"in"=>"query", "name"=>"projectId", "description"=>"The project id to list beacon attachments under"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Associates the given data with the specified beacon. Attachment data must\ncontain two parts:\n
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
context-io{"context-io-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Context.IO", "x-complete"=>1, "info"=>{"title"=>"Context.IO", "description"=>"context-io-is-the-missing-email-api-that-makes-it-easy-and-fast-to-integrate-your-users-email-data-in-your-application-", "version"=>"1.0.0"}, "host"=>"api.context.io", "basePath"=>"/2.0/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/oauth_providers"=>{"get"=>{"summary"=>"Get Oauth Provers", "description"=>"List configured OAuth providers.", "operationId"=>"listOauthProviders_", "x-api-path-slug"=>"oauth-providers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Oauth", "Providers"]}, "post"=>{"summary"=>"Post Oauth Provers", "description"=>"Adds a new OAuth provider.", "operationId"=>"addOauthProviders_", "x-api-path-slug"=>"oauth-providers-post", "parameters"=>[{"in"=>"query", "name"=>"provider_consumer_key", "description"=>"The OAuth consumer key"}, {"in"=>"query", "name"=>"provider_consumer_secret", "description"=>"The OAuth consumer secret"}, {"in"=>"query", "name"=>"type", "description"=>"Identification of the OAuth provider"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Oauth", "Providers"]}}, "/oauth_providers/{key}"=>{"get"=>{"summary"=>"Get Oauth Provers Key", "description"=>"Gets information about a given OAuth provider.", "operationId"=>"getOauthProvider_", "x-api-path-slug"=>"oauth-providerskey-get", "parameters"=>[{"in"=>"path", "name"=>"key", "description"=>"The consumer key for this external OAuth provider"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Oauth", "Providers", "Key"]}, "delete"=>{"summary"=>"Delete Oauth Provers Key", "description"=>"Removes a given OAuth provider.", "operationId"=>"removeOauthProvider_", "x-api-path-slug"=>"oauth-providerskey-delete", "parameters"=>[{"in"=>"path", "name"=>"key", "description"=>"The consumer key for this external OAuth provider"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Oauth", "Providers", "Key"]}}, "/discovery"=>{"get"=>{"summary"=>"Get Discovery", "description"=>"Attempts to discover IMAP settings for a given email address.", "operationId"=>"Get_discoverEmailImapSettings_", "x-api-path-slug"=>"discovery-get", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"An email address you want to discover IMAP settings for"}, {"in"=>"query", "name"=>"source_type", "description"=>"The type of source you want to discover settings for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Discovery"]}}, "/connect_tokens"=>{"get"=>{"summary"=>"Get Connect Tokens", "description"=>"Lists connect tokens created with your API key.", "operationId"=>"listConnectTokens_", "x-api-path-slug"=>"connect-tokens-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connect", "Tokens"]}, "post"=>{"summary"=>"Post Connect Tokens", "description"=>"Obtains a new connect_token.", "operationId"=>"Create_obtainNewConnectToken_", "x-api-path-slug"=>"connect-tokens-post", "parameters"=>[{"in"=>"query", "name"=>"callback_url", "description"=>"When the users mailbox is connected to your API key, the browser will call this url (GET)"}, {"in"=>"query", "name"=>"email", "description"=>"The email address of the account to be added"}, {"in"=>"query", "name"=>"first_name", "description"=>"First name of the account holder"}, {"in"=>"query", "name"=>"last_name", "description"=>"Last name of the account holder"}, {"in"=>"query", "name"=>"service_level", "description"=>"Sets the service level of the accounts source to be created"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connect", "Tokens"]}}, "/connect_tokens/{token}"=>{"get"=>{"summary"=>"Get Connect Tokens Token", "description"=>"Gets information about a given connect token.", "operationId"=>"getConnectToken_", "x-api-path-slug"=>"connect-tokenstoken-get", "parameters"=>[{"in"=>"path", "name"=>"token", "description"=>"The unique random token used for the graphical account creation process"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connect", "Tokens", "Token"]}, "delete"=>{"summary"=>"Delete Connect Tokens Token", "description"=>"Removes a given connect token.", "operationId"=>"removeConnectToken_", "x-api-path-slug"=>"connect-tokenstoken-delete", "parameters"=>[{"in"=>"path", "name"=>"token", "description"=>"The unique random token used for the graphical account creation process"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connect", "Tokens", "Token"]}}, "/accounts"=>{"get"=>{"summary"=>"Get Accounts", "description"=>"Lists accounts.", "operationId"=>"listAccounts_", "x-api-path-slug"=>"accounts-get", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"Only return account associated to this email address"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of results to return"}, {"in"=>"query", "name"=>"offset", "description"=>"Start the list at this offset (zero-based)"}, {"in"=>"query", "name"=>"status", "description"=>"Only return accounts with sources whose status is of a specific value"}, {"in"=>"query", "name"=>"status_ok", "description"=>"Set to 0 to get all accounts with sources that are not working correctly"}, {"in"=>"query", "name"=>"token", "description"=>"The unique random token used for the graphical account creation process"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}, "post"=>{"summary"=>"Post Accounts", "description"=>"Adds a new account.", "operationId"=>"addAccount_", "x-api-path-slug"=>"accounts-post", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"The primary email address of the account holder"}, {"in"=>"query", "name"=>"first_name", "description"=>"First name of the account holder"}, {"in"=>"query", "name"=>"last_name", "description"=>"Last name of the account holder"}, {"in"=>"query", "name"=>"token", "description"=>"The unique random token used for the graphical account creation process"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/accounts/{id}"=>{"get"=>{"summary"=>"Get Accounts", "description"=>"Gets details about a given account.", "operationId"=>"getAccount_", "x-api-path-slug"=>"accountsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}, "put"=>{"summary"=>"Put Accounts", "description"=>"Modifies a given account.", "operationId"=>"modifyAccount_", "x-api-path-slug"=>"accountsid-put", "parameters"=>[{"in"=>"query", "name"=>"first_name", "description"=>"First name of the account holder"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"query", "name"=>"last_name", "description"=>"Last name of the account holder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}, "delete"=>{"summary"=>"Delete Accounts", "description"=>"Removes a given account.", "operationId"=>"removeAccount_", "x-api-path-slug"=>"accountsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/accounts/{id}/connect_tokens"=>{"get"=>{"summary"=>"Get Accounts Connect Tokens", "description"=>"Lists connect tokens created for an account.", "operationId"=>"listAccountConnectTokens_", "x-api-path-slug"=>"accountsidconnect-tokens-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Connect", "Tokens"]}, "post"=>{"summary"=>"Post Accounts Connect Tokens", "description"=>"Obtains a new connect_token for a specific account.", "operationId"=>"Create_obtainNewAccountConnectToken_", "x-api-path-slug"=>"accountsidconnect-tokens-post", "parameters"=>[{"in"=>"query", "name"=>"callback_url", "description"=>"When the users mailbox is connected to your API key, the browser will call this url (GET)"}, {"in"=>"query", "name"=>"email", "description"=>"The email address of the account to be added"}, {"in"=>"query", "name"=>"first_name", "description"=>"First name of the account holder"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"query", "name"=>"last_name", "description"=>"Last name of the account holder"}, {"in"=>"query", "name"=>"service_level", "description"=>"Sets the service level of the accounts source to be created"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Connect", "Tokens"]}}, "/accounts/{id}/connect_tokens/{token}"=>{"get"=>{"summary"=>"Get Accounts Connect Tokens Token", "description"=>"Gets information about a given connect token.", "operationId"=>"getAccountConnectToken_", "x-api-path-slug"=>"accountsidconnect-tokenstoken-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"path", "name"=>"token", "description"=>"The unique random token used to add a second source to an existing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Connect", "Tokens", "Token"]}, "delete"=>{"summary"=>"Delete Accounts Connect Tokens Token", "description"=>"Remove a given connect token.", "operationId"=>"removeAccountConnectToken_", "x-api-path-slug"=>"accountsidconnect-tokenstoken-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"path", "name"=>"token", "description"=>"The unique random token used to add a second source to an existing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Connect", "Tokens", "Token"]}}, "/accounts/{id}/contacts"=>{"get"=>{"summary"=>"Get Accounts Contacts", "description"=>"Lists contacts in an account.", "operationId"=>"listAccountContacts_", "x-api-path-slug"=>"accountsidcontacts-get", "parameters"=>[{"in"=>"query", "name"=>"active_after", "description"=>"Only include contacts included in at least one email dated after a given time"}, {"in"=>"query", "name"=>"active_before", "description"=>"Only include contacts included in at least one email dated before a given time"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of results to return"}, {"in"=>"query", "name"=>"offset", "description"=>"Start the list at this offset (zero-based)"}, {"in"=>"query", "name"=>"search", "description"=>"String identifying the name or the email address of the contact(s) you are looking for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Contacts"]}}, "/accounts/{id}/contacts/{email}"=>{"get"=>{"summary"=>"Get Accounts Contacts Email", "description"=>"Gets information about a given contact.", "operationId"=>"getAccountContact_", "x-api-path-slug"=>"accountsidcontactsemail-get", "parameters"=>[{"in"=>"path", "name"=>"email", "description"=>"Email address of a contact"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Contacts", "Email"]}}, "/accounts/{id}/contacts/{email}/files"=>{"get"=>{"summary"=>"Get Accounts Contacts Email Files", "description"=>"Lists files exchanged with a contact. Returns the latest attachments exchanged with one or more email addresses. By \"exchanged with Mr. X\" we mean any file attached to an email received from Mr. X, sent to Mr. X or sent by anyone to both Mr. X and the mailbox owner.", "operationId"=>"listAccountContactFiles_", "x-api-path-slug"=>"accountsidcontactsemailfiles-get", "parameters"=>[{"in"=>"path", "name"=>"email", "description"=>"Email address of a contact"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of results to return"}, {"in"=>"query", "name"=>"offset", "description"=>"Start the list at this offset (zero-based)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Contacts", "Email", "Files"]}}, "/accounts/{id}/contacts/{email}/messages"=>{"get"=>{"summary"=>"Get Accounts Contacts Email Messages", "description"=>"Lists messages where a contact is present. Returns the latest email messages exchanged with one or more email addresses. By \"exchanged with Mr. X\" we mean any email received from Mr. X, sent to Mr. X or sent by anyone to both Mr. X and the mailbox owner.", "operationId"=>"listAccountContactMessages_", "x-api-path-slug"=>"accountsidcontactsemailmessages-get", "parameters"=>[{"in"=>"path", "name"=>"email", "description"=>"Email address of a contact"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of results to return"}, {"in"=>"query", "name"=>"offset", "description"=>"Start the list at this offset (zero-based)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Contacts", "Email", "Messages"]}}, "/accounts/{id}/contacts/{email}/threads"=>{"get"=>{"summary"=>"Get Accounts Contacts Email Threads", "description"=>"Lists threads where a contact is present. Returns the latest email threads exchanged with one or more email addresses. By \"exchanged with Mr. X\" we mean any email received from Mr. X, sent to Mr. X or sent by anyone to both Mr. X and the mailbox owner.", "operationId"=>"listAccountContactThreads_", "x-api-path-slug"=>"accountsidcontactsemailthreads-get", "parameters"=>[{"in"=>"path", "name"=>"email", "description"=>"Email address of a contact"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of results to return"}, {"in"=>"query", "name"=>"offset", "description"=>"Start the list at this offset (zero-based)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Contacts", "Email", "Threads"]}}, "/accounts/{id}/email_addresses"=>{"get"=>{"summary"=>"Get Accounts Email Addresses", "description"=>"Lists email addresses used by an account.", "operationId"=>"listAccountEmailAddresses_", "x-api-path-slug"=>"accountsidemail-addresses-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Email", "Addresses"]}, "post"=>{"summary"=>"Post Accounts Email Addresses", "description"=>"Adds a new email address as an alias for an account.", "operationId"=>"addAccountEmailAddress_", "x-api-path-slug"=>"accountsidemail-addresses-post", "parameters"=>[{"in"=>"query", "name"=>"email_address", "description"=>"An email address"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Email", "Addresses"]}}, "/accounts/{id}/email_addresses/{email}"=>{"post"=>{"summary"=>"Post Accounts Email Addresses Email", "description"=>"Makes this email address the primary one for the account.", "operationId"=>"Create_setAccountEmailAddressAsPrimary_", "x-api-path-slug"=>"accountsidemail-addressesemail-post", "parameters"=>[{"in"=>"path", "name"=>"email", "description"=>"One of the email addresses associated to the account"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"query", "name"=>"primary", "description"=>"Set to 1 to make this email address the primary one for the account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Email", "Addresses", "Email"]}, "delete"=>{"summary"=>"Delete Accounts Email Addresses Email", "description"=>"Removes an email address form the aliases of an account.", "operationId"=>"removeAccountEmailAddress_", "x-api-path-slug"=>"accountsidemail-addressesemail-delete", "parameters"=>[{"in"=>"path", "name"=>"email", "description"=>"One of the email addresses associated to the account"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Email", "Addresses", "Email"]}}, "/accounts/{id}/files"=>{"get"=>{"summary"=>"Get Accounts Files", "description"=>"Lists files found as email attachments. List filters: each of the email, to, from, cc and bcc parameters can be set to a comma-separated list of email addresses. These multiple addresses are treated as an OR combination. You can set more than one parameter when doing this call. Multiple parameters are treated as an AND combination.", "operationId"=>"listAccountFiles_", "x-api-path-slug"=>"accountsidfiles-get", "parameters"=>[{"in"=>"query", "name"=>"bcc", "description"=>"Email address of a contact BCCed on the messages"}, {"in"=>"query", "name"=>"cc", "description"=>"Email address of a contact CCed on the messages"}, {"in"=>"query", "name"=>"date_after", "description"=>"Only include files attached to messages sent after a given timestamp"}, {"in"=>"query", "name"=>"date_before", "description"=>"Only include files attached to messages sent before a given timestamp"}, {"in"=>"query", "name"=>"email", "description"=>"Email address of the contact for whom you want the latest files exchanged with"}, {"in"=>"query", "name"=>"file_name", "description"=>"Search for files based on their name"}, {"in"=>"query", "name"=>"from", "description"=>"Email address of a contact files have been received from"}, {"in"=>"query", "name"=>"group_by_revisions", "description"=>"If set to 1, the list will do an intelligent grouping of files to reflect occurrences of the same document"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"query", "name"=>"indexed_after", "description"=>"Only include files attached to messages indexed after a given timestamp"}, {"in"=>"query", "name"=>"indexed_before", "description"=>"Only include files attached to messages indexed before a given timestamp"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of results to return"}, {"in"=>"query", "name"=>"offset", "description"=>"Start the list at this offset (zero-based)"}, {"in"=>"query", "name"=>"to", "description"=>"Email address of a contact files have been sent to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Files"]}}, "/accounts/{id}/files/{fileId}"=>{"get"=>{"summary"=>"Get Accounts Files Fileid", "description"=>"Gets information about a given file.", "operationId"=>"getAccountFile_", "x-api-path-slug"=>"accountsidfilesfileid-get", "parameters"=>[{"in"=>"path", "name"=>"fileId", "description"=>"Unique id of a file"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Files", "FileId"]}}, "/accounts/{id}/files/{fileId}/changes"=>{"get"=>{"summary"=>"Get Accounts Files Fileid Changes", "description"=>"Lists files that can be compared with a given file.", "operationId"=>"listComparableAccountFiles_", "x-api-path-slug"=>"accountsidfilesfileidchanges-get", "parameters"=>[{"in"=>"path", "name"=>"fileId", "description"=>"Unique id of a file"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Files", "FileId", "Changes"]}}, "/accounts/{id}/files/{fileId}/content"=>{"get"=>{"summary"=>"Get Accounts Files Fileid Content", "description"=>"Downloads a given file. Returns the content a given attachment. On-demand data retrieval: since we do not keep full copies of attachments on our servers, the file has to be retrieved from the IMAP server when this call is made. If the IMAP server is unreachable at the time the call is made, this call will return an error.", "operationId"=>"getAccountFileContent_", "x-api-path-slug"=>"accountsidfilesfileidcontent-get", "parameters"=>[{"in"=>"path", "name"=>"fileId", "description"=>"Unique id of a file"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Files", "FileId", "Content"]}}, "/accounts/{id}/files/{fileId}/related"=>{"get"=>{"summary"=>"Get Accounts Files Fileid Related", "description"=>"Lists other files related to a given file. Returns a list of files that are related to the given file. Currently, relation between files is based on how similar their names are.", "operationId"=>"listAccountFileRelatedFiles_", "x-api-path-slug"=>"accountsidfilesfileidrelated-get", "parameters"=>[{"in"=>"path", "name"=>"fileId", "description"=>"Unique id of a file"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Files", "FileId", "Related"]}}, "/accounts/{id}/files/{fileId}/revisions"=>{"get"=>{"summary"=>"Get Accounts Files Fileid Revisions", "description"=>"Lists other revisions of a given file. Returns a list of revisions attached to other emails in the mailbox for a given file. Two files are considered revisions of the same document if their file names are identical outside of revision indicators such as dates, author initials, version numbers and keywords like \"final\" or \"draft\".", "operationId"=>"listAccountFileRevisions_", "x-api-path-slug"=>"accountsidfilesfileidrevisions-get", "parameters"=>[{"in"=>"path", "name"=>"fileId", "description"=>"Unique id of a file"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Files", "FileId", "Revisions"]}}, "/accounts/{id}/messages"=>{"get"=>{"summary"=>"Get Accounts Messages", "description"=>"Lists email messages for an account. List filters: each of the email, to, from, cc and bcc parameters can be set to a comma-separated list of email addresses. These multiple addresses are treated as an OR combination. You can set more than one parameter when doing this call. Multiple parameters are treated as an AND combination.", "operationId"=>"listAccountMessages_", "x-api-path-slug"=>"accountsidmessages-get", "parameters"=>[{"in"=>"query", "name"=>"bcc", "description"=>"Email address of a contact BCCed on the messages"}, {"in"=>"query", "name"=>"body_type", "description"=>"Used when include_body is set to get only body parts of a given MIME-type (i"}, {"in"=>"query", "name"=>"cc", "description"=>"Email address of a contact CCed on the messages"}, {"in"=>"query", "name"=>"date_after", "description"=>"Only include messages after a given timestamp"}, {"in"=>"query", "name"=>"date_before", "description"=>"Only include messages before a given timestamp"}, {"in"=>"query", "name"=>"email", "description"=>"Email address of the contact for whom you want the latest messages exchanged with"}, {"in"=>"query", "name"=>"folder", "description"=>"Filter messages by the folder (or Gmail label)"}, {"in"=>"query", "name"=>"from", "description"=>"Email address of a contact messages have been received from"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"query", "name"=>"include_body", "description"=>"Set to 1 to include message bodies in the result"}, {"in"=>"query", "name"=>"include_flags", "description"=>"Set to 1 to include IMAP flags for this message in the result"}, {"in"=>"query", "name"=>"include_headers", "description"=>"Can be set to 0 (default), 1 or raw"}, {"in"=>"query", "name"=>"indexed_after", "description"=>"Only include messages indexed after a given timestamp"}, {"in"=>"query", "name"=>"indexed_before", "description"=>"Only include messages indexed before a given timestamp"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of results to return"}, {"in"=>"query", "name"=>"offset", "description"=>"Start the list at this offset (zero-based)"}, {"in"=>"query", "name"=>"subject", "description"=>"Get messages whose subject matches this search string"}, {"in"=>"query", "name"=>"to", "description"=>"Email address of a contact messages have been sent to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Messages"]}}, "/accounts/{id}/messages/{message_id}"=>{"get"=>{"summary"=>"Get Accounts Messages Message", "description"=>"Gets the file, contact and other information about a given email message. As specified in the RFC822, the < and > at the beginning and end of the Message-ID are part of the value and should be included if you're putting an email_message_id in the url.", "operationId"=>"getAccountMessage_", "x-api-path-slug"=>"accountsidmessagesmessage-id-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"path", "name"=>"message_id", "description"=>"Unique id of a message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Messages", "Message"]}, "post"=>{"summary"=>"Post Accounts Messages Message", "description"=>"Copies or moves a message. Allows you to copy or move a message between folders. If there are more than one sources on the account, you can use this call to copy/move the message between these sources. In this case, the dst_label parameter must identify the source you want to message to be copied/moved to.", "operationId"=>"Create_copyMoveAccountMessage_", "x-api-path-slug"=>"accountsidmessagesmessage-id-post", "parameters"=>[{"in"=>"query", "name"=>"dst_folder", "description"=>"The folder within dst_source the message should be copied to"}, {"in"=>"query", "name"=>"dst_source", "description"=>"Label of the source you want the message copied to"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"path", "name"=>"message_id", "description"=>"Unique id of a message"}, {"in"=>"query", "name"=>"move", "description"=>"By default, this calls copies the original message in the destination"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Messages", "Message"]}}, "/accounts/{id}/messages/{message_id}/body"=>{"get"=>{"summary"=>"Get Accounts Messages Message Body", "description"=>"Fetches the message body of a given email. On-demand data retrieval: since we do not keep full copies of emails on our servers, this call triggers a connection to the IMAP server to fetch the message. One thing to point out is we do fetch messages in such a way that large files attached to a message won't make any difference in the response time. This call only returns text portions of messages, attachments aren't included. To get a list of attachments on the message, look for the files property in the response of a message instance. To download the content of these attachments, use the files/content call.", "operationId"=>"getAccountMessageBody_", "x-api-path-slug"=>"accountsidmessagesmessage-idbody-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"path", "name"=>"message_id", "description"=>"Unique id of a message"}, {"in"=>"query", "name"=>"type", "description"=>"Many emails are sent with both rich text and plain text versions in the message body and by default, the response of this call will include both"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Messages", "Message", "Body"]}}, "/accounts/{id}/messages/{message_id}/source"=>{"get"=>{"summary"=>"Get Accounts Messages Message Source", "description"=>"Fetches the message source. Returns the raw RFC-822 message source for the message (including attachments) with no parsing or decoding to any portions of the message. On-demand data retrieval: since we do not keep full copies of emails on our servers, this call triggers a connection to the IMAP server to fetch the message. Attachments are part of the message source so they will impact how fast this call responds.", "operationId"=>"getAccountMessageSource_", "x-api-path-slug"=>"accountsidmessagesmessage-idsource-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"path", "name"=>"message_id", "description"=>"Unique id of a message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Messages", "Message", "Source"]}}, "/accounts/{id}/messages/{message_id}/flags"=>{"get"=>{"summary"=>"Get Accounts Messages Message Flags", "description"=>"Lists message flags for an account. On-demand data retrieval: to ensure up-to-date values, flags are not cached by Context.IO. This call triggers a connection to the IMAP server to fetch the current message flags before it returns.", "operationId"=>"listAccountMessageFlags_", "x-api-path-slug"=>"accountsidmessagesmessage-idflags-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"path", "name"=>"message_id", "description"=>"Unique id of a message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Messages", "Message", "Flags"]}, "post"=>{"summary"=>"Post Accounts Messages Message Flags", "description"=>"Sets message flags for a given email.", "operationId"=>"Create_setAccountMessageFlags_", "x-api-path-slug"=>"accountsidmessagesmessage-idflags-post", "parameters"=>[{"in"=>"query", "name"=>"answered", "description"=>"Message has been answered"}, {"in"=>"query", "name"=>"deleted", "description"=>"Message is deleted for later removal"}, {"in"=>"query", "name"=>"draft", "description"=>"Message has not completed composition (marked as a draft)"}, {"in"=>"query", "name"=>"flagged", "description"=>"Message is flagged for urgent/special attention"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"path", "name"=>"message_id", "description"=>"Unique id of a message"}, {"in"=>"query", "name"=>"seen", "description"=>"Message has been read"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Messages", "Message", "Flags"]}}, "/accounts/{id}/messages/{message_id}/headers"=>{"get"=>{"summary"=>"Get Accounts Messages Message Headers", "description"=>"Lists complete headers of a given email message. On-demand data retrieval: since we do not keep full copies of emails on our servers, this call triggers a connection to the IMAP server to fetch the message headers.", "operationId"=>"listAccountMessageHeaders_", "x-api-path-slug"=>"accountsidmessagesmessage-idheaders-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"path", "name"=>"message_id", "description"=>"Unique id of a message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Messages", "Message", "Headers"]}}, "/accounts/{id}/messages/{message_id}/thread"=>{"get"=>{"summary"=>"Get Accounts Messages Message Thread", "description"=>"Gets information about all messages of the thread a given message is in. This returns an array with the same structure as getting information on a single message for every message in the thread.", "operationId"=>"getAccountMessageThread_", "x-api-path-slug"=>"accountsidmessagesmessage-idthread-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"path", "name"=>"message_id", "description"=>"Unique id of a message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Messages", "Message", "Thread"]}}, "/accounts/{id}/sources"=>{"get"=>{"summary"=>"Get Accounts Sources", "description"=>"Lists IMAP sources assigned for an account.", "operationId"=>"listAccountSources_", "x-api-path-slug"=>"accountsidsources-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"query", "name"=>"status", "description"=>"Only return sources whose status is of a specific value"}, {"in"=>"query", "name"=>"status_ok", "description"=>"Set to 0 to get sources that are not working correctly"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Sources"]}, "post"=>{"summary"=>"Post Accounts Sources", "description"=>"Adds an IMAP account to a given account.", "operationId"=>"addAccountSource_", "x-api-path-slug"=>"accountsidsources-post", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"The primary email address used to receive emails in this account"}, {"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"query", "name"=>"password", "description"=>"Password for authentication on the IMAP server"}, {"in"=>"query", "name"=>"port", "description"=>"Port number to connect to on the server"}, {"in"=>"query", "name"=>"provider_consumer_key", "description"=>"The OAuth consumer key used to obtain the the token and token secret above for that account"}, {"in"=>"query", "name"=>"provider_token", "description"=>"An OAuth token obtained from the IMAP account provider to be used to authentify on this email account"}, {"in"=>"query", "name"=>"provider_token_secret", "description"=>"An OAuth token secret obtained from the IMAP account provider to be used to authentify on this email account"}, {"in"=>"query", "name"=>"server", "description"=>"Name of IP of the IMAP server, eg"}, {"in"=>"query", "name"=>"service_level", "description"=>"Sets the service level for the source to be created"}, {"in"=>"query", "name"=>"sync_period", "description"=>"Sets the period at which the Context"}, {"in"=>"query", "name"=>"type", "description"=>"Currently, the only supported type is IMAP"}, {"in"=>"query", "name"=>"username", "description"=>"The username used to authentify an IMAP connection"}, {"in"=>"query", "name"=>"use_ssl", "description"=>"Set to 1 if you want SSL encryption to be used when opening connections to the IMAP server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Sources"]}}, "/accounts/{id}/sources/{label}"=>{"get"=>{"summary"=>"Get Accounts Sources Label", "description"=>"Gets parameters and status for an IMAP source.", "operationId"=>"getAccountSource_", "x-api-path-slug"=>"accountsidsourceslabel-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"path", "name"=>"label", "description"=>"The label property of the source instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Sources", "Label"]}, "put"=>{"summary"=>"Put Accounts Sources Label", "description"=>"Modifies a data source on a given account.", "operationId"=>"modifyAccountSource_", "x-api-path-slug"=>"accountsidsourceslabel-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"path", "name"=>"label", "description"=>"The label property of the source instance"}, {"in"=>"query", "name"=>"password", "description"=>"New password for this source"}, {"in"=>"query", "name"=>"provider_consumer_key", "description"=>"The OAuth consumer key used to obtain the the token and token secret above for that account"}, {"in"=>"query", "name"=>"provider_token", "description"=>"An OAuth token obtained from the IMAP account provider to be used to authentify on this email account"}, {"in"=>"query", "name"=>"provider_token_secret", "description"=>"An OAuth token secret obtained from the IMAP account provider to be used to authentify on this email account"}, {"in"=>"query", "name"=>"service_level", "description"=>"Changes the service level for the source"}, {"in"=>"query", "name"=>"status", "description"=>"If the status of the source is TEMP_DISABLED or DISABLED"}, {"in"=>"query", "name"=>"sync_period", "description"=>"Changes the period at which the Context"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Sources", "Label"]}, "delete"=>{"summary"=>"Delete Accounts Sources Label", "description"=>"Removes a data source of an account.", "operationId"=>"removeAccountSource_", "x-api-path-slug"=>"accountsidsourceslabel-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"path", "name"=>"label", "description"=>"The label property of the source instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Sources", "Label"]}}, "/accounts/{id}/sources/{label}/folders"=>{"get"=>{"summary"=>"Get Accounts Sources Label Folders", "description"=>"Lists folders in an IMAP source. Returns folders existing in a given IMAP account.", "operationId"=>"listAccountSourceFolders_", "x-api-path-slug"=>"accountsidsourceslabelfolders-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Unique id of an account accessible through your API key"}, {"in"=>"path", "name"=>"label", "description"=>"The label property of the source instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Sources", "Label", "Folders"]}}, "/accounts/{id}/sources/{label}/folders/{folder}"=>{"put"=>{"summary"=>"Put Accounts Sources Label Folders Folder", "description"=>"Creates a folder on an IMAP source. A new folder can be added to an IMAP source by PUTting the desired path under the sources/folders resource.\nWorking with server-specific hierarchy delimiters:\nIMAP servers are free to use the character they want as the folder hierarchy delimiter. The bad news is they don't use the same. The good news is you don't need to know this, we take care of it.\n\nThen what is that delim parameter for?\nGood question. By default, we expect you to specify the folder hierarchy using / as the hierarchy delimiter. For example, to create a folder called my folder under the folder base folder, you would call:\nPUT /2.0/accounts/ |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| api-science{"api-science-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"API Science", "x-complete"=>1, "info"=>{"title"=>"API Science", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/contacts.json"=>{"get"=>{"summary"=>"Get All Contacts", "description"=>"Get All Contacts", "operationId"=>"getAllContacts", "x-api-path-slug"=>"contacts-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}, "post"=>{"summary"=>"Create a Contact", "description"=>"Create a Contact", "operationId"=>"createContact", "x-api-path-slug"=>"contacts-json-post", "parameters"=>[{"in"=>"formData", "name"=>"label", "description"=>"User-defined label for this contact"}, {"in"=>"formData", "name"=>"type", "description"=>"Type of contact, options are: email, url, pagerduty"}, {"in"=>"formData", "name"=>"value", "description"=>"Contents of value vary based on the type of contact being created: an email address, a URL or your PagerDuty API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}}, "/contacts/{id}.json"=>{"delete"=>{"summary"=>"Delete a Contact", "description"=>"Delete a Contact", "operationId"=>"deleteContact", "x-api-path-slug"=>"contactsid-json-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id for the contact"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}, "get"=>{"summary"=>"Get a Specific Contact", "description"=>"Get a Specific Contact", "operationId"=>"getContact", "x-api-path-slug"=>"contactsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the contact to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}, "patch"=>{"summary"=>"Update a Contact", "description"=>"Update a Contact", "operationId"=>"updateContact", "x-api-path-slug"=>"contactsid-json-patch", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID for the contact"}, {"in"=>"formData", "name"=>"label", "description"=>"User-defined label for this contact"}, {"in"=>"formData", "name"=>"type", "description"=>"Type of contact, options are: email, url, pagerduty"}, {"in"=>"query", "name"=>"value", "description"=>"Contents of value vary based on the type of contact being created: an email address, a URL or your PagerDuty API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}}, "/monitors"=>{"get"=>{"summary"=>"Get All Monitors", "description"=>"Marks message as read.", "operationId"=>"getAllMonitors", "x-api-path-slug"=>"monitors-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Your API key must be included in all API requests to the server in an Authorization HTTP header"}, {"in"=>"query", "name"=>"tags", "description"=>"Optionally filter monitors by tags"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitors"]}, "post"=>{"summary"=>"Create Monitor", "description"=>"Create a new monitor.", "operationId"=>"create-monitor", "x-api-path-slug"=>"monitors-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitors"]}, "put"=>{"summary"=>"Apply Actions to Multiple Monitors", "description"=>"Apply Actions to Multiple Monitors", "operationId"=>"applyActionsToMultipleMonitors", "x-api-path-slug"=>"monitors-put", "parameters"=>[{"in"=>"path", "name"=>"tags", "description"=>"Optionally filter monitors by tags"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitors"]}}, "/monitors/{id}"=>{"get"=>{"summary"=>"Get a Specific Monitor", "description"=>"Get a Specific Monitor", "operationId"=>"getMonitor", "x-api-path-slug"=>"monitorsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the monitor to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitors"]}}, "/monitors/{id}/checks.json"=>{"get"=>{"summary"=>"Get Checks For A Monitor", "description"=>"Get Checks For A Monitor", "operationId"=>"getChecksForAMonitor", "x-api-path-slug"=>"monitorsidchecks-json-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"The number of checks to return"}, {"in"=>"path", "name"=>"id", "description"=>"id for the monitors"}, {"in"=>"query", "name"=>"start", "description"=>"The start number represents which ID is the maximum check that could be found"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}, "/monitors/{id}/performance"=>{"get"=>{"summary"=>"Performance Report", "description"=>"Performance Report", "operationId"=>"performanceReport", "x-api-path-slug"=>"monitorsidperformance-get", "parameters"=>[{"in"=>"query", "name"=>"end", "description"=>"The end point you want to build a performance report from"}, {"in"=>"path", "name"=>"id", "description"=>"The id for the monitor"}, {"in"=>"query", "name"=>"preset", "description"=>"Present for commonly requested reports"}, {"in"=>"query", "name"=>"resolution", "description"=>"The resolution is the time unit for aggregating data, with allowable values of hour, day, and week"}, {"in"=>"query", "name"=>"start", "description"=>"The start point you want to build a performance report from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Performance"]}}, "/monitors/{id}/templates"=>{"get"=>{"summary"=>"Show a Monitors Templates", "description"=>"Show a Monitors Templates", "operationId"=>"showMonitorsTemplates", "x-api-path-slug"=>"monitorsidtemplates-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id for the monitor"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates"]}}, "/monitors/{id}/templates/{templates]"=>{"get"=>{"summary"=>"Get a Template", "description"=>"Get a Template", "operationId"=>"getTemplate", "x-api-path-slug"=>"monitorsidtemplatestemplates-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates"]}, "post"=>{"summary"=>"Create a Template", "description"=>"Create a Template", "operationId"=>"createTemplate", "x-api-path-slug"=>"monitorsidtemplatestemplates-post", "parameters"=>[{"in"=>"formData", "name"=>"body", "description"=>"Raw body to be send with the request"}, {"in"=>"formData", "name"=>"followRedirects", "description"=>"True if this call should automatically follow HTTP redirects (default is False)"}, {"in"=>"formData", "name"=>"headers", "description"=>"An array of key/value pairs to send as URL parameters"}, {"in"=>"formData", "name"=>"method", "description"=>"The HTTP action to access the given URL"}, {"in"=>"formData", "name"=>"name", "description"=>"The name of the template"}, {"in"=>"formData", "name"=>"preProcessScript", "description"=>"JavaScript to be executed prior to running this template"}, {"in"=>"formData", "name"=>"url", "description"=>"The URL to be accessed"}, {"in"=>"formData", "name"=>"validations", "description"=>"An array of validation objects to be run on the results of this template"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates"]}}, "/monitors/{id}/test"=>{"get"=>{"summary"=>"Testing your Monitor", "description"=>"Testing your Monitor", "operationId"=>"testMonitor", "x-api-path-slug"=>"monitorsidtest-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitors"]}}, "/monitors/{id}/uptime.json"=>{"get"=>{"summary"=>"Uptime Report", "description"=>"Uptime Report", "operationId"=>"uptimeReport", "x-api-path-slug"=>"monitorsiduptime-json-get", "parameters"=>[{"in"=>"query", "name"=>"end", "description"=>"The end point you want to build a performance report from"}, {"in"=>"path", "name"=>"id", "description"=>"Id for the monitor"}, {"in"=>"query", "name"=>"preset", "description"=>"Present for commonly requested reports"}, {"in"=>"query", "name"=>"resolution", "description"=>"The resolution is the time unit for aggregating data, with allowable values of hourly, daily, and weekly"}, {"in"=>"query", "name"=>"start", "description"=>"The start point you want to build a performance report from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Uptime"]}}, "/tags"=>{"get"=>{"summary"=>"List All Tags", "description"=>"List All Tags", "operationId"=>"listAllTags", "x-api-path-slug"=>"tags-get", "parameters"=>[{"in"=>"query", "name"=>"detailed", "description"=>"Detailed List All Tags"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "\n /api/{version}/contacts"=>{"\n get"=>{"summary"=>"Get Contacts List", "description"=>"Returns a list of all contacts.", "operationId"=>"get-contacts-list", "x-api-path-slug"=>"apiversioncontacts-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limits the number of returned contacts to the specified quantity", "type"=>" | integer | "}, {"in"=>"query", "name"=>"offset", "description"=>"Offset for listing", "type"=>"integer | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}}, "/inventory/tags"=>{""=>{"summary"=>"Deleting a tag", "description"=>"", "operationId"=>"deleting-a-tag", "x-api-path-slug"=>"inventorytags-", "parameters"=>[{"in"=>"body", "name"=>"color", "description"=>"The color of the tag in hexcode", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"name", "description"=>"Name of the tag", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"token", "description"=>"Your API token", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/monitors/{monitor_id}"=>{"put"=>{"summary"=>"Update Monitor", "description"=>"Update an existing monitor", "operationId"=>"update-monitor", "x-api-path-slug"=>"monitorsmonitor-id-put", "parameters"=>[{"in"=>"path", "name"=>"monitor_id", "description"=>"MandatoryUnique ID of the monitor", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitors"]}}, "/monitors/activate/{monitor_id}"=>{"put"=>{"summary"=>"Activate Monitor", "description"=>"Activate a suspended monitor", "operationId"=>"activate-monitor", "x-api-path-slug"=>"monitorsactivatemonitor-id-put", "parameters"=>[{"in"=>"path", "name"=>"monitor_id", "description"=>"MandatoryUnique ID of the monitor", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitors"]}}, "/monitor/poll_now/{monitor_id}"=>{"get"=>{"summary"=>"Poll Monitor", "description"=>"Poll a monitor.", "operationId"=>"poll-monitor", "x-api-path-slug"=>"monitorpoll-nowmonitor-id-get", "parameters"=>[{"in"=>"path", "name"=>"monitor_id", "description"=>"MandatoryUnique ID of the monitor", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitors"]}}}}, "apis"=>{"name"=>"API Science", "x-slug"=>"api-science", "description"=>"Traditional monitoring services were designed long before APIs became core to modern applications. API Science is designed specifically for monitoring APIs. Sure, we understand REST, JSON, OAuth, XML. No problem.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/api-science-logo.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API LIfeyclessss,API Service Provider,Monitoring,My API Stack,Profiles,Relative Data,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"api-science/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"API Science", "x-api-slug"=>"api-science", "description"=>"Traditional monitoring services were designed long before APIs became core to modern applications. API Science is designed specifically for monitoring APIs. Sure, we understand REST, JSON, OAuth, XML. No problem.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/api-science-logo.png", "humanURL"=>"http://apiscience.com", "baseURL"=>"https:///", "tags"=>"API LIfeyclessss,API Service Provider,Monitoring,My API Stack,Profiles,Relative Data,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/api-science/monitorpoll-nowmonitor-id-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/api-science/api-science-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base-url", "url"=>"http://api.apiscience.com"}, {"type"=>"x-blog", "url"=>"https://www.apiscience.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"https://www.apiscience.com/blog/feed/"}, {"type"=>"x-developer", "url"=>"https://www.apiscience.com/docs/api"}, {"type"=>"x-pricing", "url"=>"https://www.apiscience.com/pricing"}, {"type"=>"x-privacy", "url"=>"https://www.apiscience.com/privacy"}, {"type"=>"x-terms-of-service", "url"=>"https://www.apiscience.com/terms"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/APIScience"}, {"type"=>"x-website", "url"=>"http://apiscience.com"}, {"type"=>"x-website", "url"=>"http://www.apiscience.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}}||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-lightsale{"amazon-lightsale-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Lightsale", "x-complete"=>1, "info"=>{"title"=>"AWS Lightsale API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AllocateStaticIp"=>{"get"=>{"summary"=>"Allocate Static Ip", "description"=>"Allocates a static IP address.", "operationId"=>"allocateStaticIp", "x-api-path-slug"=>"actionallocatestaticip-get", "parameters"=>[{"in"=>"query", "name"=>"staticIpName", "description"=>"The name of the static IP address", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Addresses"]}}, "/?Action=AttachStaticIp"=>{"get"=>{"summary"=>"Attach Static Ip", "description"=>"Attaches a static IP address to a specific Amazon Lightsail instance.", "operationId"=>"attachStaticIp", "x-api-path-slug"=>"actionattachstaticip-get", "parameters"=>[{"in"=>"query", "name"=>"instanceName", "description"=>"The instance name to which you want to attach the static IP address", "type"=>"string"}, {"in"=>"query", "name"=>"staticIpName", "description"=>"The name of the static IP", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Addresses"]}}, "/?Action=CloseInstancePublicPorts"=>{"get"=>{"summary"=>"Close Instance Public Ports", "description"=>"Closes the public ports on a specific Amazon Lightsail instance.", "operationId"=>"closeInstancePublicPorts", "x-api-path-slug"=>"actioncloseinstancepublicports-get", "parameters"=>[{"in"=>"query", "name"=>"instanceName", "description"=>"The name of the instance on which youre attempting to close the public ports", "type"=>"string"}, {"in"=>"query", "name"=>"portInfo", "description"=>"Information about the public port you are trying to close", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=CreateDomain"=>{"get"=>{"summary"=>"Create Domain", "description"=>"Creates a domain resource for the specified domain (e.", "operationId"=>"createDomain", "x-api-path-slug"=>"actioncreatedomain-get", "parameters"=>[{"in"=>"query", "name"=>"domainName", "description"=>"The domain name to manage (e", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/?Action=CreateDomainEntry"=>{"get"=>{"summary"=>"Create Domain Entry", "description"=>"Creates one of the following entry records associated with the domain: A record, CNAME\n record, TXT record, or MX record.", "operationId"=>"createDomainEntry", "x-api-path-slug"=>"actioncreatedomainentry-get", "parameters"=>[{"in"=>"query", "name"=>"domainEntry", "description"=>"An array of key-value pairs containing information about the domain entry request", "type"=>"string"}, {"in"=>"query", "name"=>"domainName", "description"=>"The domain name (e", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/?Action=CreateInstances"=>{"get"=>{"summary"=>"Create Instances", "description"=>"Creates one or more Amazon Lightsail virtual private servers, or\n instances.", "operationId"=>"createInstances", "x-api-path-slug"=>"actioncreateinstances-get", "parameters"=>[{"in"=>"query", "name"=>"availabilityZone", "description"=>"The Availability Zone in which to create your instance", "type"=>"string"}, {"in"=>"query", "name"=>"blueprintId", "description"=>"The ID for a virtual private server image (e", "type"=>"string"}, {"in"=>"query", "name"=>"bundleId", "description"=>"The bundle of specification information for your virtual private server (or instance), including the pricing plan (e", "type"=>"string"}, {"in"=>"query", "name"=>"customImageName", "description"=>"The name for your custom image", "type"=>"string"}, {"in"=>"query", "name"=>"instanceNames", "description"=>"The names to use for your new Lightsail instances", "type"=>"string"}, {"in"=>"query", "name"=>"keyPairName", "description"=>"The name of your key pair", "type"=>"string"}, {"in"=>"query", "name"=>"userData", "description"=>"A launch script you can create that configures a server with additional user data", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=CreateInstancesFromSnapshot"=>{"get"=>{"summary"=>"Create Instances From Snapshot", "description"=>"Uses a specific snapshot as a blueprint for creating one or more new instances that are\n based on that identical configuration.", "operationId"=>"createInstancesFromSnapshot", "x-api-path-slug"=>"actioncreateinstancesfromsnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"availabilityZone", "description"=>"The Availability Zone where you want to create your instances", "type"=>"string"}, {"in"=>"query", "name"=>"bundleId", "description"=>"The bundle of specification information for your virtual private server (or instance), including the pricing plan (e", "type"=>"string"}, {"in"=>"query", "name"=>"instanceNames", "description"=>"The names for your new instances", "type"=>"string"}, {"in"=>"query", "name"=>"instanceSnapshotName", "description"=>"The name of the instance snapshot on which you are basing your new instances", "type"=>"string"}, {"in"=>"query", "name"=>"keyPairName", "description"=>"The name for your key pair", "type"=>"string"}, {"in"=>"query", "name"=>"userData", "description"=>"You can create a launch script that configures a server with additional user data", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=CreateInstanceSnapshot"=>{"get"=>{"summary"=>"Create Instance Snapshot", "description"=>"Creates a snapshot of a specific virtual private server, or\n instance.", "operationId"=>"createInstanceSnapshot", "x-api-path-slug"=>"actioncreateinstancesnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"instanceName", "description"=>"The Lightsail instance on which to base your snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"instanceSnapshotName", "description"=>"The name for your new snapshot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=CreateKeyPair"=>{"get"=>{"summary"=>"Create Key Pair", "description"=>"Creates sn SSH key pair.", "operationId"=>"createKeyPair", "x-api-path-slug"=>"actioncreatekeypair-get", "parameters"=>[{"in"=>"query", "name"=>"keyPairName", "description"=>"The name for your new key pair", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key Pairs"]}}, "/?Action=DeleteDomain"=>{"get"=>{"summary"=>"Delete Domain", "description"=>"Deletes the specified domain recordset and all of its domain records.", "operationId"=>"deleteDomain", "x-api-path-slug"=>"actiondeletedomain-get", "parameters"=>[{"in"=>"query", "name"=>"domainName", "description"=>"The specific domain name to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/?Action=DeleteDomainEntry"=>{"get"=>{"summary"=>"Delete Domain Entry", "description"=>"Deletes a specific domain entry.", "operationId"=>"deleteDomainEntry", "x-api-path-slug"=>"actiondeletedomainentry-get", "parameters"=>[{"in"=>"query", "name"=>"domainEntry", "description"=>"An array of key-value pairs containing information about your domain entries", "type"=>"string"}, {"in"=>"query", "name"=>"domainName", "description"=>"The name of the domain entry to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/?Action=DeleteInstance"=>{"get"=>{"summary"=>"Delete Instance", "description"=>"Deletes a specific Amazon Lightsail virtual private server, or\n instance.", "operationId"=>"deleteInstance", "x-api-path-slug"=>"actiondeleteinstance-get", "parameters"=>[{"in"=>"query", "name"=>"instanceName", "description"=>"The name of the instance to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=DeleteInstanceSnapshot"=>{"get"=>{"summary"=>"Delete Instance Snapshot", "description"=>"Deletes a specific snapshot of a virtual private server (or\n instance).", "operationId"=>"deleteInstanceSnapshot", "x-api-path-slug"=>"actiondeleteinstancesnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"instanceSnapshotName", "description"=>"The name of the snapshot to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=DeleteKeyPair"=>{"get"=>{"summary"=>"Delete Key Pair", "description"=>"Deletes a specific SSH key pair.", "operationId"=>"deleteKeyPair", "x-api-path-slug"=>"actiondeletekeypair-get", "parameters"=>[{"in"=>"query", "name"=>"keyPairName", "description"=>"The name of the key pair to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key Pairs"]}}, "/?Action=DetachStaticIp"=>{"get"=>{"summary"=>"Detach Static Ip", "description"=>"Detaches a static IP from the Amazon Lightsail instance to which it is\n attached.", "operationId"=>"detachStaticIp", "x-api-path-slug"=>"actiondetachstaticip-get", "parameters"=>[{"in"=>"query", "name"=>"staticIpName", "description"=>"The name of the static IP to detach from the instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Addresses"]}}, "/?Action=DownloadDefaultKeyPair"=>{"get"=>{"summary"=>"Download Default Key Pair", "description"=>"Downloads the default SSH key pair from the user's account.", "operationId"=>"downloadDefaultKeyPair", "x-api-path-slug"=>"actiondownloaddefaultkeypair-get", "parameters"=>[{"in"=>"query", "name"=>"privateKeyBase64", "description"=>"A base64-encoded RSA private key", "type"=>"string"}, {"in"=>"query", "name"=>"publicKeyBase64", "description"=>"A base64-encoded public key of the ssh-rsa type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key Pairs"]}}, "/?Action=GetActiveNames"=>{"get"=>{"summary"=>"Get Active Names", "description"=>"Returns the names of all active (not deleted) resources.", "operationId"=>"getActiveNames", "x-api-path-slug"=>"actiongetactivenames-get", "parameters"=>[{"in"=>"query", "name"=>"pageToken", "description"=>"A token used for paginating results from your get active names request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Names"]}}, "/?Action=GetBlueprints"=>{"get"=>{"summary"=>"Get Blueprints", "description"=>"Returns the list of available instance images, or blueprints.", "operationId"=>"getBlueprints", "x-api-path-slug"=>"actiongetblueprints-get", "parameters"=>[{"in"=>"query", "name"=>"includeInactive", "description"=>"A Boolean value indicating whether to include inactive results in your request", "type"=>"string"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A token used for advancing to the next page of results from your get blueprints request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=GetBundles"=>{"get"=>{"summary"=>"Get Bundles", "description"=>"Returns the list of bundles that are available for purchase.", "operationId"=>"getBundles", "x-api-path-slug"=>"actiongetbundles-get", "parameters"=>[{"in"=>"query", "name"=>"includeInactive", "description"=>"A Boolean value that indicates whether to include inactive bundle results in your request", "type"=>"string"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A token used for advancing to the next page of results from your get bundles request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bundles"]}}, "/?Action=GetDomain"=>{"get"=>{"summary"=>"Get Domain", "description"=>"Returns information about a specific domain recordset.", "operationId"=>"getDomain", "x-api-path-slug"=>"actiongetdomain-get", "parameters"=>[{"in"=>"query", "name"=>"domainName", "description"=>"The domain name for which your want to return information about", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/?Action=GetDomains"=>{"get"=>{"summary"=>"Get Domains", "description"=>"Returns a list of all domains in the user's account.", "operationId"=>"getDomains", "x-api-path-slug"=>"actiongetdomains-get", "parameters"=>[{"in"=>"query", "name"=>"pageToken", "description"=>"A token used for advancing to the next page of results from your get domains request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}, "/?Action=GetInstance"=>{"get"=>{"summary"=>"Get Instance", "description"=>"Returns information about a specific Amazon Lightsail instance, which is a virtual\n private server.", "operationId"=>"getInstance", "x-api-path-slug"=>"actiongetinstance-get", "parameters"=>[{"in"=>"query", "name"=>"instanceName", "description"=>"The name of the instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=GetInstanceAccessDetails"=>{"get"=>{"summary"=>"Get Instance Access Details", "description"=>"Returns temporary SSH keys you can use to connect to a specific virtual private server,\n or instance.", "operationId"=>"getInstanceAccessDetails", "x-api-path-slug"=>"actiongetinstanceaccessdetails-get", "parameters"=>[{"in"=>"query", "name"=>"instanceName", "description"=>"The name of the instance to access", "type"=>"string"}, {"in"=>"query", "name"=>"protocol", "description"=>"The protocol to use to connect to your instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=GetInstanceMetricData"=>{"get"=>{"summary"=>"Get Instance Metric Data", "description"=>"Returns the data points for the specified Amazon Lightsail instance metric, given an\n instance name.", "operationId"=>"getInstanceMetricData", "x-api-path-slug"=>"actiongetinstancemetricdata-get", "parameters"=>[{"in"=>"query", "name"=>"endTime", "description"=>"The end time of the time period", "type"=>"string"}, {"in"=>"query", "name"=>"instanceName", "description"=>"The name of the instance for which you want to get metrics data", "type"=>"string"}, {"in"=>"query", "name"=>"metricName", "description"=>"The metric name to get data about", "type"=>"string"}, {"in"=>"query", "name"=>"period", "description"=>"The time period for which you are requesting data", "type"=>"string"}, {"in"=>"query", "name"=>"startTime", "description"=>"The start time of the time period", "type"=>"string"}, {"in"=>"query", "name"=>"statistics", "description"=>"The instance statistics", "type"=>"string"}, {"in"=>"query", "name"=>"unit", "description"=>"The unit", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=GetInstancePortStates"=>{"get"=>{"summary"=>"Get Instance Port States", "description"=>"Returns the port states for a specific virtual private server, or\n instance.", "operationId"=>"getInstancePortStates", "x-api-path-slug"=>"actiongetinstanceportstates-get", "parameters"=>[{"in"=>"query", "name"=>"instanceName", "description"=>"The name of the instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=GetInstances"=>{"get"=>{"summary"=>"Get Instances", "description"=>"Returns information about all Amazon Lightsail virtual private servers, or\n instances.", "operationId"=>"getInstances", "x-api-path-slug"=>"actiongetinstances-get", "parameters"=>[{"in"=>"query", "name"=>"pageToken", "description"=>"A token used for advancing to the next page of results from your get instances request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=GetInstanceSnapshot"=>{"get"=>{"summary"=>"Get Instance Snapshot", "description"=>"Returns information about a specific instance snapshot.", "operationId"=>"getInstanceSnapshot", "x-api-path-slug"=>"actiongetinstancesnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"instanceSnapshotName", "description"=>"The name of the snapshot for which you are requesting information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=GetInstanceSnapshots"=>{"get"=>{"summary"=>"Get Instance Snapshots", "description"=>"Returns all instance snapshots for the user's account.", "operationId"=>"getInstanceSnapshots", "x-api-path-slug"=>"actiongetinstancesnapshots-get", "parameters"=>[{"in"=>"query", "name"=>"pageToken", "description"=>"A token used for advancing to the next page of results from your get instance snapshots request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=GetInstanceState"=>{"get"=>{"summary"=>"Get Instance State", "description"=>"Returns the state of a specific instance.", "operationId"=>"getInstanceState", "x-api-path-slug"=>"actiongetinstancestate-get", "parameters"=>[{"in"=>"query", "name"=>"instanceName", "description"=>"The name of the instance to get state information about", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=GetKeyPair"=>{"get"=>{"summary"=>"Get Key Pair", "description"=>"Returns information about a specific key pair.", "operationId"=>"getKeyPair", "x-api-path-slug"=>"actiongetkeypair-get", "parameters"=>[{"in"=>"query", "name"=>"keyPairName", "description"=>"The name of the key pair for which you are requesting information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key Pairs"]}}, "/?Action=GetKeyPairs"=>{"get"=>{"summary"=>"Get Key Pairs", "description"=>"Returns information about all key pairs in the user's account.", "operationId"=>"getKeyPairs", "x-api-path-slug"=>"actiongetkeypairs-get", "parameters"=>[{"in"=>"query", "name"=>"pageToken", "description"=>"A token used for advancing to the next page of results from your get key pairs request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key Pairs"]}}, "/?Action=GetOperation"=>{"get"=>{"summary"=>"Get Operation", "description"=>"Returns information about a specific operation.", "operationId"=>"getOperation", "x-api-path-slug"=>"actiongetoperation-get", "parameters"=>[{"in"=>"query", "name"=>"operationId", "description"=>"A GUID used to identify the operation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations"]}}, "/?Action=GetOperations"=>{"get"=>{"summary"=>"Get Operations", "description"=>"Returns information about all operations.", "operationId"=>"getOperations", "x-api-path-slug"=>"actiongetoperations-get", "parameters"=>[{"in"=>"query", "name"=>"pageToken", "description"=>"A token used for advancing to the next page of results from your get operations request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations"]}}, "/?Action=GetOperationsForResource"=>{"get"=>{"summary"=>"Get Operations For Resource", "description"=>"Gets operations for a specific resource (e.", "operationId"=>"getOperationsForResource", "x-api-path-slug"=>"actiongetoperationsforresource-get", "parameters"=>[{"in"=>"query", "name"=>"pageToken", "description"=>"A token used for advancing to the next page of results from your get operations for resource request", "type"=>"string"}, {"in"=>"query", "name"=>"resourceName", "description"=>"The name of the resource for which you are requesting information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations"]}}, "/?Action=GetRegions"=>{"get"=>{"summary"=>"Get Regions", "description"=>"Returns a list of all valid regions for Amazon Lightsail.", "operationId"=>"getRegions", "x-api-path-slug"=>"actiongetregions-get", "parameters"=>[{"in"=>"query", "name"=>"includeAvailabilityZones", "description"=>"A Boolean value indicating whether to also include Availability Zones in your get regions request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions"]}}, "/?Action=GetStaticIp"=>{"get"=>{"summary"=>"Get Static Ip", "description"=>"Returns information about a specific static IP.", "operationId"=>"getStaticIp", "x-api-path-slug"=>"actiongetstaticip-get", "parameters"=>[{"in"=>"query", "name"=>"staticIpName", "description"=>"The name of the static IP in Lightsail", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Addresses"]}}, "/?Action=GetStaticIps"=>{"get"=>{"summary"=>"Get Static Ips", "description"=>"Returns information about all static IPs in the user's account.", "operationId"=>"getStaticIps", "x-api-path-slug"=>"actiongetstaticips-get", "parameters"=>[{"in"=>"query", "name"=>"pageToken", "description"=>"A token used for advancing to the next page of results from your get static IPs request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Addresses"]}}, "/?Action=ImportKeyPair"=>{"get"=>{"summary"=>"Import Key Pair", "description"=>"Imports a public SSH key from a specific key pair.", "operationId"=>"importKeyPair", "x-api-path-slug"=>"actionimportkeypair-get", "parameters"=>[{"in"=>"query", "name"=>"keyPairName", "description"=>"The name of the key pair for which you want to import the public key", "type"=>"string"}, {"in"=>"query", "name"=>"publicKeyBase64", "description"=>"A base64-encoded public key of the ssh-rsa type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Key Pairs"]}}, "/?Action=IsVpcPeered"=>{"get"=>{"summary"=>"Is Vpc Peered", "description"=>"Returns a Boolean value indicating whether your Lightsail VPC is peered.", "operationId"=>"isVpcPeered", "x-api-path-slug"=>"actionisvpcpeered-get", "parameters"=>[{"in"=>"query", "name"=>"isPeered", "description"=>"Returns true if the Lightsail VPC is peered; otherwise, false", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/?Action=OpenInstancePublicPorts"=>{"get"=>{"summary"=>"Open Instance Public Ports", "description"=>"Adds public ports to an Amazon Lightsail instance.", "operationId"=>"openInstancePublicPorts", "x-api-path-slug"=>"actionopeninstancepublicports-get", "parameters"=>[{"in"=>"query", "name"=>"instanceName", "description"=>"The name of the instance for which you want to open the public ports", "type"=>"string"}, {"in"=>"query", "name"=>"portInfo", "description"=>"An array of key-value pairs containing information about the port mappings", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=PeerVpc"=>{"get"=>{"summary"=>"Peer Vpc", "description"=>"Tries to peer the Lightsail VPC with the user's default VPC.", "operationId"=>"peerVpc", "x-api-path-slug"=>"actionpeervpc-get", "parameters"=>[{"in"=>"query", "name"=>"operation", "description"=>"An array of key-value pairs containing information about the request operation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/?Action=RebootInstance"=>{"get"=>{"summary"=>"Reboot Instance", "description"=>"Restarts a specific instance.", "operationId"=>"rebootInstance", "x-api-path-slug"=>"actionrebootinstance-get", "parameters"=>[{"in"=>"query", "name"=>"instanceName", "description"=>"The name of the instance to reboot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=ReleaseStaticIp"=>{"get"=>{"summary"=>"Release Static Ip", "description"=>"Deletes a specific static IP from your account.", "operationId"=>"releaseStaticIp", "x-api-path-slug"=>"actionreleasestaticip-get", "parameters"=>[{"in"=>"query", "name"=>"staticIpName", "description"=>"The name of the static IP to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Addresses"]}}, "/?Action=StartInstance"=>{"get"=>{"summary"=>"Start Instance", "description"=>"Starts a specific Amazon Lightsail instance from a stopped state.", "operationId"=>"startInstance", "x-api-path-slug"=>"actionstartinstance-get", "parameters"=>[{"in"=>"query", "name"=>"instanceName", "description"=>"The name of the instance (a virtual private server) to start", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=StopInstance"=>{"get"=>{"summary"=>"Stop Instance", "description"=>"Stops a specific Amazon Lightsail instance that is currently running.", "operationId"=>"stopInstance", "x-api-path-slug"=>"actionstopinstance-get", "parameters"=>[{"in"=>"query", "name"=>"instanceName", "description"=>"The name of the instance (a virtual private server) to stop", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=UnpeerVpc"=>{"get"=>{"summary"=>"Unpeer Vpc", "description"=>"Attempts to unpeer the Lightsail VPC from the user's default VPC.", "operationId"=>"unpeerVpc", "x-api-path-slug"=>"actionunpeervpc-get", "parameters"=>[{"in"=>"query", "name"=>"operation", "description"=>"An array of key-value pairs containing information about the request operation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/?Action=UpdateDomainEntry"=>{"get"=>{"summary"=>"Update Domain Entry", "description"=>"Updates a domain recordset after it is created.", "operationId"=>"updateDomainEntry", "x-api-path-slug"=>"actionupdatedomainentry-get", "parameters"=>[{"in"=>"query", "name"=>"domainEntry", "description"=>"An array of key-value pairs containing information about the domain entry", "type"=>"string"}, {"in"=>"query", "name"=>"domainName", "description"=>"The name of the domain recordset to update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}}}, "apis"=>{"name"=>"AWS Lightsale", "x-slug"=>"aws-lightsale", "description"=>"Amazon Lightsail is the easiest way to get started with AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-lightsail.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,DNS,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-lightsale/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Amazon Lightsale API", "x-api-slug"=>"amazon-lightsale-api", "description"=>"Amazon Lightsail is the easiest way to get started with AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-lightsail.png", "humanURL"=>"https://amazonlightsail.com/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,DNS,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-lightsale/amazon-lightsale-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/Welcome.html?fid=6DDA37DF97F08F8B-23761D4A79F7B1E"}, {"type"=>"x-pricing", "url"=>"https://amazonlightsail.com/pricing/"}, {"type"=>"x-website", "url"=>"https://amazonlightsail.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
soundcloud{"sound-cloud-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"SoundCloud", "x-complete"=>1, "info"=>{"title"=>"Sound Cloud", "description"=>"access-host-upload-and-comment-on-audio-", "version"=>"1.0.0"}, "host"=>"api.soundcloud.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/tracks.json"=>{"get"=>{"summary"=>"Get Tracks", "description"=>"Returns a collection of tracks", "operationId"=>"getTracks.json", "x-api-path-slug"=>"tracks-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks"]}, "post"=>{"summary"=>"Post Tracks", "description"=>"Uploads a track", "operationId"=>"postTracks.json", "x-api-path-slug"=>"tracks-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks"]}}, "/tracks/{track_id}.json"=>{"get"=>{"summary"=>"Get Tracks Track", "description"=>"Returns a track by track id", "operationId"=>"getTracksTrack.json", "x-api-path-slug"=>"trackstrack-id-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track"]}, "put"=>{"summary"=>"Put Tracks Track", "description"=>"Updates a given track", "operationId"=>"putTracksTrack.json", "x-api-path-slug"=>"trackstrack-id-json-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track"]}, "delete"=>{"summary"=>"Delete Tracks Track", "description"=>"Deletes a given track", "operationId"=>"deleteTracksTrack.json", "x-api-path-slug"=>"trackstrack-id-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track"]}}, "/tracks/{track_id}/comments.json"=>{"get"=>{"summary"=>"Get Tracks Track Comments", "description"=>"Returns comments of a track by track id", "operationId"=>"getTracksTrackComments.json", "x-api-path-slug"=>"trackstrack-idcomments-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track", "Comments"]}, "post"=>{"summary"=>"Post Tracks Track Comments", "description"=>"Posts a comments to a track by track id", "operationId"=>"postTracksTrackComments.json", "x-api-path-slug"=>"trackstrack-idcomments-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track", "Comments"]}}, "/tracks/{track_id}/permissions.json"=>{"get"=>{"summary"=>"Get Tracks Track Permissions", "description"=>"Returns all users with permission for a track by track id", "operationId"=>"getTracksTrackPermissions.json", "x-api-path-slug"=>"trackstrack-idpermissions-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track", "Permissions"]}, "put"=>{"summary"=>"Put Tracks Track Permissions", "description"=>"Updates the list of permitted users for a track by track id", "operationId"=>"putTracksTrackPermissions.json", "x-api-path-slug"=>"trackstrack-idpermissions-json-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track", "Permissions"]}}, "/tracks/{track_id}/secret-token.json"=>{"get"=>{"summary"=>"Get Tracks Track Secret Token", "description"=>"Returns the secret token for a track by track id. This resource can only be used by the track owner.", "operationId"=>"getTracksTrackSecretToken.json", "x-api-path-slug"=>"trackstrack-idsecrettoken-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track", "Secret", "Token"]}, "put"=>{"summary"=>"Put Tracks Track Secret Token", "description"=>"Resets the secret token for a track by track id. The secret token can not be specified but will be randomly chosen on\n the server and returned. This resource can only be used by the track owner.", "operationId"=>"putTracksTrackSecretToken.json", "x-api-path-slug"=>"trackstrack-idsecrettoken-json-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track", "Secret", "Token"]}}, "/users.json"=>{"get"=>{"summary"=>"Get Users", "description"=>"Returns a collection of users", "operationId"=>"getUsers.json", "x-api-path-slug"=>"users-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/{user_id}.json"=>{"get"=>{"summary"=>"Get Users", "description"=>"Returns a user by user id", "operationId"=>"getUsersUser.json", "x-api-path-slug"=>"usersuser-id-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/{user_id}/tracks.json"=>{"get"=>{"summary"=>"Get Users Tracks", "description"=>"Returns a collection of tracks uploaded by user id", "operationId"=>"getUsersUserTracks.json", "x-api-path-slug"=>"usersuser-idtracks-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Tracks"]}}, "/users/{user_id}/comments.json"=>{"get"=>{"summary"=>"Get Users Comments", "description"=>"Returns a collection of comments made by user id", "operationId"=>"getUsersUserComments.json", "x-api-path-slug"=>"usersuser-idcomments-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Comments"]}}, "/users/{user_id}/followings.json"=>{"get"=>{"summary"=>"Get Users Followings", "description"=>"Returns a collection of users the user with user id is following", "operationId"=>"getUsersUserFollowings.json", "x-api-path-slug"=>"usersuser-idfollowings-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Followings"]}}, "/users/{user_id}/followings/{contact_id}.json"=>{"get"=>{"summary"=>"Get Users Followings Contact", "description"=>"Checks if the user with the id contact_id is in the givens user's list of contacts.", "operationId"=>"getUsersUserFollowingsContact.json", "x-api-path-slug"=>"usersuser-idfollowingscontact-id-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Followings", "Contact"]}, "put"=>{"summary"=>"Put Users Followings Contact", "description"=>"Adds the user with the id contact_id to the givens user's list of contacts.", "operationId"=>"putUsersUserFollowingsContact.json", "x-api-path-slug"=>"usersuser-idfollowingscontact-id-json-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Followings", "Contact"]}, "delete"=>{"summary"=>"Delete Users Followings Contact", "description"=>"Removes the user with the id contact_id from the givens user's list of contacts.", "operationId"=>"deleteUsersUserFollowingsContact.json", "x-api-path-slug"=>"usersuser-idfollowingscontact-id-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Followings", "Contact"]}}, "/users/{user_id}/followers.json"=>{"get"=>{"summary"=>"Get Users Followers", "description"=>"Returns a collection of users who follow the user with user id", "operationId"=>"getUsersUserFollowers.json", "x-api-path-slug"=>"usersuser-idfollowers-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Followers"]}}, "/users/{user_id}/followers/{contact_id}.json"=>{"get"=>{"summary"=>"Get Users Followers Contact", "description"=>"Checks if the user with contact_id is a follower of the given user.", "operationId"=>"getUsersUserFollowersContact.json", "x-api-path-slug"=>"usersuser-idfollowerscontact-id-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Followers", "Contact"]}}, "/users/{user_id}/favorites.json"=>{"get"=>{"summary"=>"Get Users Favorites", "description"=>"Returns a collection of tracks favorited by the user with user id", "operationId"=>"getUsersUserFavorites.json", "x-api-path-slug"=>"usersuser-idfavorites-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Favorites"]}}, "/users/{user_id}/favorites/{track_id}.json"=>{"put"=>{"summary"=>"Put Users Favorites Track", "description"=>"Adds the given track to the given user's list of favorites.", "operationId"=>"putUsersUserFavoritesTrack.json", "x-api-path-slug"=>"usersuser-idfavoritestrack-id-json-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Favorites", "Track"]}, "delete"=>{"summary"=>"Delete Users Favorites Track", "description"=>"Deletes the given track from the given user's list of favorites.", "operationId"=>"deleteUsersUserFavoritesTrack.json", "x-api-path-slug"=>"usersuser-idfavoritestrack-id-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Favorites", "Track"]}}, "/users/{user_id}/groups.json"=>{"get"=>{"summary"=>"Get Users Groups", "description"=>"Returns a collection of groups joined by user with user id", "operationId"=>"getUsersUserGroups.json", "x-api-path-slug"=>"usersuser-idgroups-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Groups"]}}, "/users/{user_id}/playlists.json"=>{"get"=>{"summary"=>"Get Users Playlists", "description"=>"Returns a collection of playlists created by user with user id", "operationId"=>"getUsersUserPlaylists.json", "x-api-path-slug"=>"usersuser-idplaylists-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Playlists"]}}, "/me.json"=>{"get"=>{"summary"=>"Get Me", "description"=>"Returns the logged-in user", "operationId"=>"getMe.json", "x-api-path-slug"=>"me-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me"]}, "put"=>{"summary"=>"Put Me", "description"=>"Updates the logged-in user", "operationId"=>"putMe.json", "x-api-path-slug"=>"me-json-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me"]}}, "/me/tracks.json"=>{"get"=>{"summary"=>"Get Me Tracks", "description"=>"Returns a collection of tracks uploaded by logged-in user", "operationId"=>"getMeTracks.json", "x-api-path-slug"=>"metracks-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Tracks"]}}, "/me/comments.json"=>{"get"=>{"summary"=>"Get Me Comments", "description"=>"Returns a collection of comments made by logged-in user", "operationId"=>"getMeComments.json", "x-api-path-slug"=>"mecomments-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Comments"]}}, "/me/followings.json"=>{"get"=>{"summary"=>"Get Me Followings", "description"=>"Returns a collection of users the logged-in user is following", "operationId"=>"getMeFollowings.json", "x-api-path-slug"=>"mefollowings-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Followings"]}}, "/me/followings/{contact_id}.json"=>{"get"=>{"summary"=>"Get Me Followings Contact", "description"=>"Checks if the user with the id contact_id is in the logged-in user's list of contacts.", "operationId"=>"getMeFollowingsContact.json", "x-api-path-slug"=>"mefollowingscontact-id-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Followings", "Contact"]}, "put"=>{"summary"=>"Put Me Followings Contact", "description"=>"Adds the user with the id contact_id to the logged-in user's list of contacts.", "operationId"=>"putMeFollowingsContact.json", "x-api-path-slug"=>"mefollowingscontact-id-json-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Followings", "Contact"]}, "delete"=>{"summary"=>"Delete Me Followings Contact", "description"=>"Deletes the user with the id contact_id from the logged-in user's list of contacts.", "operationId"=>"deleteMeFollowingsContact.json", "x-api-path-slug"=>"mefollowingscontact-id-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Followings", "Contact"]}}, "/me/followers.json"=>{"get"=>{"summary"=>"Get Me Followers", "description"=>"Returns a collection of users who follow the logged-in user", "operationId"=>"getMeFollowers.json", "x-api-path-slug"=>"mefollowers-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Followers"]}}, "/me/followers/{contact_id}.json"=>{"get"=>{"summary"=>"Get Me Followers Contact", "description"=>"Checks if the user with the id contact_id is a follower of the logged-in user", "operationId"=>"getMeFollowersContact.json", "x-api-path-slug"=>"mefollowerscontact-id-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Followers", "Contact"]}}, "/me/favorites.json"=>{"get"=>{"summary"=>"Get Me Favorites", "description"=>"Returns a collection of tracks favorited by the logged-in user", "operationId"=>"getMeFavorites.json", "x-api-path-slug"=>"mefavorites-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Favorites"]}}, "/me/favorites/{track_id}.json"=>{"put"=>{"summary"=>"Put Me Favorites Track", "description"=>"Adds the given track to the logged-in user's list of favorites.", "operationId"=>"putMeFavoritesTrack.json", "x-api-path-slug"=>"mefavoritestrack-id-json-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Favorites", "Track"]}, "delete"=>{"summary"=>"Delete Me Favorites Track", "description"=>"Deletes the given track from the logged-in user's list of favorites.", "operationId"=>"deleteMeFavoritesTrack.json", "x-api-path-slug"=>"mefavoritestrack-id-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Favorites", "Track"]}}, "/me/groups.json"=>{"get"=>{"summary"=>"Get Me Groups", "description"=>"Returns a collection of groups joined by logged-in user", "operationId"=>"getMeGroups.json", "x-api-path-slug"=>"megroups-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Groups"]}}, "/me/playlists.json"=>{"get"=>{"summary"=>"Get Me Playlists", "description"=>"Returns a collection of playlists created by the logged-in user", "operationId"=>"getMePlaylists.json", "x-api-path-slug"=>"meplaylists-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Playlists"]}}, "/playlists.json"=>{"get"=>{"summary"=>"Get Playlists", "description"=>"Returns a collection of playlists", "operationId"=>"getPlaylists.json", "x-api-path-slug"=>"playlists-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists"]}}, "/playlists/{playlist_id}.json"=>{"get"=>{"summary"=>"Get Playlists Playlist", "description"=>"Returns a playlist by playlist id", "operationId"=>"getPlaylistsPlaylist.json", "x-api-path-slug"=>"playlistsplaylist-id-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists", "Playlist"]}}, "/groups.json"=>{"get"=>{"summary"=>"Get Groups", "description"=>"Returns a collection of groups", "operationId"=>"getGroups.json", "x-api-path-slug"=>"groups-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/groups/{group_id}.json"=>{"get"=>{"summary"=>"Get Groups", "description"=>"Returns a group by group id", "operationId"=>"getGroupsGroup.json", "x-api-path-slug"=>"groupsgroup-id-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/groups/{group_id}/users.json"=>{"get"=>{"summary"=>"Get Groups Users", "description"=>"Returns a combined collection of moderators, members and contributors of the group with group id", "operationId"=>"getGroupsGroupUsers.json", "x-api-path-slug"=>"groupsgroup-idusers-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Users"]}}, "/groups/{group_id}/moderators.json"=>{"get"=>{"summary"=>"Get Groups Moderators", "description"=>"Returns a collection of moderators of the group with group id", "operationId"=>"getGroupsGroupModerators.json", "x-api-path-slug"=>"groupsgroup-idmoderators-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Moderators"]}}, "/groups/{group_id}/members.json"=>{"get"=>{"summary"=>"Get Groups Members", "description"=>"Returns a collection of members of the group with group id", "operationId"=>"getGroupsGroupMembers.json", "x-api-path-slug"=>"groupsgroup-idmembers-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Members"]}}, "/groups/{group_id}/contributors.json"=>{"get"=>{"summary"=>"Get Groups Contributors", "description"=>"Returns a collection of contributors of the group with group id", "operationId"=>"getGroupsGroupContributors.json", "x-api-path-slug"=>"groupsgroup-idcontributors-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Contributors"]}}, "/groups/{group_id}/tracks.json"=>{"get"=>{"summary"=>"Get Groups Tracks", "description"=>"Returns a collection of tracks contributed to the group with group id", "operationId"=>"getGroupsGroupTracks.json", "x-api-path-slug"=>"groupsgroup-idtracks-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Tracks"]}}, "/comments/{comment_id}.json"=>{"get"=>{"summary"=>"Get Comments", "description"=>"Returns a comment by comment id", "operationId"=>"getCommentsComment.json", "x-api-path-slug"=>"commentscomment-id-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}}, "/resolve.json"=>{"get"=>{"summary"=>"Get Resolve", "description"=>"Translates a website URI into an API URI", "operationId"=>"getResolve.json", "x-api-path-slug"=>"resolve-json-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resolve"]}}, "/tracks.{format}"=>{"get"=>{"summary"=>"Get Tracks. Format", "description"=>"Returns a collection of tracks", "operationId"=>"getTracks.Format", "x-api-path-slug"=>"tracks-format-get", "parameters"=>[{"in"=>"query", "name"=>"bpm-from", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"bpm-to", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"created_at-from", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"created_at-to", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"duration-from", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"duration-to", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"filter", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"ids", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"order", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"q", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"tags", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "", "Format"]}, "post"=>{"summary"=>"Post Tracks. Format", "description"=>"Post tracks. format.", "operationId"=>"postTracks.Format", "x-api-path-slug"=>"tracks-format-post", "parameters"=>[{"in"=>"query", "name"=>"asset_data", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"title", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "", "Format"]}}, "/tracks/{track_id}.{format}"=>{"get"=>{"summary"=>"Get Tracks Track . Format", "description"=>"Returns a track by track id", "operationId"=>"getTracksTrack.Format", "x-api-path-slug"=>"trackstrack-id-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"track_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track", "", "", "Format"]}, "put"=>{"summary"=>"Put Tracks Track . Format", "description"=>"Put tracks track . format.", "operationId"=>"putTracksTrack.Format", "x-api-path-slug"=>"trackstrack-id-format-put", "parameters"=>[{"in"=>"query", "name"=>"asset_data", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"title", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track", "", "", "Format"]}, "delete"=>{"summary"=>"Delete Tracks Track . Format", "description"=>"Delete tracks track . format.", "operationId"=>"deleteTracksTrack.Format", "x-api-path-slug"=>"trackstrack-id-format-delete", "parameters"=>[{"in"=>"path", "name"=>"track_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track", "", "", "Format"]}}, "/tracks/{track_id}/comments.{format}"=>{"get"=>{"summary"=>"Get Tracks Track Comments. Format", "description"=>"Returns comments of a track by track id", "operationId"=>"getTracksTrackComments.Format", "x-api-path-slug"=>"trackstrack-idcomments-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"track_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track", "Comments", "", "Format"]}, "post"=>{"summary"=>"Post Tracks Track Comments. Format", "description"=>"Posts a comments to a track by track id", "operationId"=>"postTracksTrackComments.Format", "x-api-path-slug"=>"trackstrack-idcomments-format-post", "parameters"=>[{"in"=>"path", "name"=>"track_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track", "Comments", "", "Format"]}}, "/tracks/{track_id}/permissions.{format}"=>{"get"=>{"summary"=>"Get Tracks Track Permissions. Format", "description"=>"Returns all users with permission for a track by track id", "operationId"=>"getTracksTrackPermissions.Format", "x-api-path-slug"=>"trackstrack-idpermissions-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"track_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track", "Permissions", "", "Format"]}, "put"=>{"summary"=>"Put Tracks Track Permissions. Format", "description"=>"Updates the list of permitted users for a track by track id", "operationId"=>"putTracksTrackPermissions.Format", "x-api-path-slug"=>"trackstrack-idpermissions-format-put", "parameters"=>[{"in"=>"path", "name"=>"track_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track", "Permissions", "", "Format"]}}, "/tracks/{track_id}/secret-token.{format}"=>{"get"=>{"summary"=>"Get Tracks Track Secret Token. Format", "description"=>"Returns the secret token for a track by track id. This resource can only be used by the track owner.", "operationId"=>"getTracksTrackSecretToken.Format", "x-api-path-slug"=>"trackstrack-idsecrettoken-format-get", "parameters"=>[{"in"=>"path", "name"=>"track_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track", "Secret", "Token", "", "Format"]}, "put"=>{"summary"=>"Put Tracks Track Secret Token. Format", "description"=>"Resets the secret token for a track by track id. The secret token can not be specified but will be randomly chosen on\n the server and returned. This resource can only be used by the track owner.", "operationId"=>"putTracksTrackSecretToken.Format", "x-api-path-slug"=>"trackstrack-idsecrettoken-format-put", "parameters"=>[{"in"=>"path", "name"=>"track_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracks", "Track", "Secret", "Token", "", "Format"]}}, "/users.{format}"=>{"get"=>{"summary"=>"Get Users. Format", "description"=>"Returns a collection of users", "operationId"=>"getUsers.Format", "x-api-path-slug"=>"users-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"q", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "", "Format"]}}, "/users/{user_id}.{format}"=>{"get"=>{"summary"=>"Get Users . Format", "description"=>"Returns a user by user id", "operationId"=>"getUsersUser.Format", "x-api-path-slug"=>"usersuser-id-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"user_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "", "", "Format"]}}, "/users/{user_id}/tracks.{format}"=>{"get"=>{"summary"=>"Get Users Tracks. Format", "description"=>"Returns a collection of tracks uploaded by user id", "operationId"=>"getUsersUserTracks.Format", "x-api-path-slug"=>"usersuser-idtracks-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"user_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Tracks", "", "Format"]}}, "/users/{user_id}/comments.{format}"=>{"get"=>{"summary"=>"Get Users Comments. Format", "description"=>"Returns a collection of comments made by user id", "operationId"=>"getUsersUserComments.Format", "x-api-path-slug"=>"usersuser-idcomments-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"user_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Comments", "", "Format"]}}, "/users/{user_id}/followings.{format}"=>{"get"=>{"summary"=>"Get Users Followings. Format", "description"=>"Returns a collection of users the user with user id is following", "operationId"=>"getUsersUserFollowings.Format", "x-api-path-slug"=>"usersuser-idfollowings-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"user_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Followings", "", "Format"]}}, "/users/{user_id}/followings/{contact_id}.{format}"=>{"get"=>{"summary"=>"Get Users Followings Contact . Format", "description"=>"Checks if the user with the id contact_id is in the givens user's list of contacts.", "operationId"=>"getUsersUserFollowingsContact.Format", "x-api-path-slug"=>"usersuser-idfollowingscontact-id-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"contact_id", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"user_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Followings", "Contact", "", "", "Format"]}, "put"=>{"summary"=>"Put Users Followings Contact . Format", "description"=>"Adds the user with the id contact_id to the givens user's list of contacts.", "operationId"=>"putUsersUserFollowingsContact.Format", "x-api-path-slug"=>"usersuser-idfollowingscontact-id-format-put", "parameters"=>[{"in"=>"path", "name"=>"contact_id", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"user_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Followings", "Contact", "", "", "Format"]}, "delete"=>{"summary"=>"Delete Users Followings Contact . Format", "description"=>"Removes the user with the id contact_id from the givens user's list of contacts.", "operationId"=>"deleteUsersUserFollowingsContact.Format", "x-api-path-slug"=>"usersuser-idfollowingscontact-id-format-delete", "parameters"=>[{"in"=>"path", "name"=>"contact_id", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"user_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Followings", "Contact", "", "", "Format"]}}, "/users/{user_id}/followers.{format}"=>{"get"=>{"summary"=>"Get Users Followers. Format", "description"=>"Returns a collection of users who follow the user with user id", "operationId"=>"getUsersUserFollowers.Format", "x-api-path-slug"=>"usersuser-idfollowers-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"user_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Followers", "", "Format"]}}, "/users/{user_id}/followers/{contact_id}.{format}"=>{"get"=>{"summary"=>"Get Users Followers Contact . Format", "description"=>"Checks if the user with contact_id is a follower of the given user.", "operationId"=>"getUsersUserFollowersContact.Format", "x-api-path-slug"=>"usersuser-idfollowerscontact-id-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"contact_id", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"user_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Followers", "Contact", "", "", "Format"]}}, "/users/{user_id}/favorites.{format}"=>{"get"=>{"summary"=>"Get Users Favorites. Format", "description"=>"Returns a collection of tracks favorited by the user with user id", "operationId"=>"getUsersUserFavorites.Format", "x-api-path-slug"=>"usersuser-idfavorites-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"user_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Favorites", "", "Format"]}}, "/users/{user_id}/favorites/{track_id}.{format}"=>{"put"=>{"summary"=>"Put Users Favorites Track . Format", "description"=>"Adds the given track to the given user's list of favorites.", "operationId"=>"putUsersUserFavoritesTrack.Format", "x-api-path-slug"=>"usersuser-idfavoritestrack-id-format-put", "parameters"=>[{"in"=>"path", "name"=>"track_id", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"user_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Favorites", "Track", "", "", "Format"]}, "delete"=>{"summary"=>"Delete Users Favorites Track . Format", "description"=>"Deletes the given track from the given user's list of favorites.", "operationId"=>"deleteUsersUserFavoritesTrack.Format", "x-api-path-slug"=>"usersuser-idfavoritestrack-id-format-delete", "parameters"=>[{"in"=>"path", "name"=>"track_id", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"user_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Favorites", "Track", "", "", "Format"]}}, "/users/{user_id}/groups.{format}"=>{"get"=>{"summary"=>"Get Users Groups. Format", "description"=>"Returns a collection of groups joined by user with user id", "operationId"=>"getUsersUserGroups.Format", "x-api-path-slug"=>"usersuser-idgroups-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"user_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Groups", "", "Format"]}}, "/users/{user_id}/playlists.{format}"=>{"get"=>{"summary"=>"Get Users Playlists. Format", "description"=>"Returns a collection of playlists created by user with user id", "operationId"=>"getUsersUserPlaylists.Format", "x-api-path-slug"=>"usersuser-idplaylists-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"user_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Playlists", "", "Format"]}}, "/me.{format}"=>{"get"=>{"summary"=>"Get Me. Format", "description"=>"Returns the logged-in user", "operationId"=>"getMe.Format", "x-api-path-slug"=>"me-format-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "", "Format"]}, "put"=>{"summary"=>"Put Me. Format", "description"=>"Updates the logged-in user", "operationId"=>"putMe.Format", "x-api-path-slug"=>"me-format-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "", "Format"]}}, "/me/tracks.{format}"=>{"get"=>{"summary"=>"Get Me Tracks. Format", "description"=>"Returns a collection of tracks uploaded by logged-in user", "operationId"=>"getMeTracks.Format", "x-api-path-slug"=>"metracks-format-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Tracks", "", "Format"]}}, "/me/comments.{format}"=>{"get"=>{"summary"=>"Get Me Comments. Format", "description"=>"Returns a collection of comments made by logged-in user", "operationId"=>"getMeComments.Format", "x-api-path-slug"=>"mecomments-format-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Comments", "", "Format"]}}, "/me/followings.{format}"=>{"get"=>{"summary"=>"Get Me Followings. Format", "description"=>"Returns a collection of users the logged-in user is following", "operationId"=>"getMeFollowings.Format", "x-api-path-slug"=>"mefollowings-format-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Followings", "", "Format"]}}, "/me/followings/{contact_id}.{format}"=>{"get"=>{"summary"=>"Get Me Followings Contact . Format", "description"=>"Checks if the user with the id contact_id is in the logged-in user's list of contacts.", "operationId"=>"getMeFollowingsContact.Format", "x-api-path-slug"=>"mefollowingscontact-id-format-get", "parameters"=>[{"in"=>"path", "name"=>"contact_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Followings", "Contact", "", "", "Format"]}, "put"=>{"summary"=>"Put Me Followings Contact . Format", "description"=>"Adds the user with the id contact_id to the logged-in user's list of contacts.", "operationId"=>"putMeFollowingsContact.Format", "x-api-path-slug"=>"mefollowingscontact-id-format-put", "parameters"=>[{"in"=>"path", "name"=>"contact_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Followings", "Contact", "", "", "Format"]}, "delete"=>{"summary"=>"Delete Me Followings Contact . Format", "description"=>"Deletes the user with the id contact_id from the logged-in user's list of contacts.", "operationId"=>"deleteMeFollowingsContact.Format", "x-api-path-slug"=>"mefollowingscontact-id-format-delete", "parameters"=>[{"in"=>"path", "name"=>"contact_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Followings", "Contact", "", "", "Format"]}}, "/me/followers.{format}"=>{"get"=>{"summary"=>"Get Me Followers. Format", "description"=>"Returns a collection of users who follow the logged-in user", "operationId"=>"getMeFollowers.Format", "x-api-path-slug"=>"mefollowers-format-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Followers", "", "Format"]}}, "/me/followers/{contact_id}.{format}"=>{"get"=>{"summary"=>"Get Me Followers Contact . Format", "description"=>"Checks if the user with the id contact_id is a follower of the logged-in user", "operationId"=>"getMeFollowersContact.Format", "x-api-path-slug"=>"mefollowerscontact-id-format-get", "parameters"=>[{"in"=>"path", "name"=>"contact_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Followers", "Contact", "", "", "Format"]}}, "/me/favorites.{format}"=>{"get"=>{"summary"=>"Get Me Favorites. Format", "description"=>"Returns a collection of tracks favorited by the logged-in user", "operationId"=>"getMeFavorites.Format", "x-api-path-slug"=>"mefavorites-format-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Favorites", "", "Format"]}}, "/me/favorites/{track_id}.{format}"=>{"put"=>{"summary"=>"Put Me Favorites Track . Format", "description"=>"Adds the given track to the logged-in user's list of favorites.", "operationId"=>"putMeFavoritesTrack.Format", "x-api-path-slug"=>"mefavoritestrack-id-format-put", "parameters"=>[{"in"=>"path", "name"=>"track_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Favorites", "Track", "", "", "Format"]}, "delete"=>{"summary"=>"Delete Me Favorites Track . Format", "description"=>"Deletes the given track from the logged-in user's list of favorites.", "operationId"=>"deleteMeFavoritesTrack.Format", "x-api-path-slug"=>"mefavoritestrack-id-format-delete", "parameters"=>[{"in"=>"path", "name"=>"track_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Favorites", "Track", "", "", "Format"]}}, "/me/groups.{format}"=>{"get"=>{"summary"=>"Get Me Groups. Format", "description"=>"Returns a collection of groups joined by logged-in user", "operationId"=>"getMeGroups.Format", "x-api-path-slug"=>"megroups-format-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Groups", "", "Format"]}}, "/me/playlists.{format}"=>{"get"=>{"summary"=>"Get Me Playlists. Format", "description"=>"Returns a collection of playlists created by the logged-in user", "operationId"=>"getMePlaylists.Format", "x-api-path-slug"=>"meplaylists-format-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Playlists", "", "Format"]}}, "/playlists.{format}"=>{"get"=>{"summary"=>"Get Playlists. Format", "description"=>"Returns a collection of playlists", "operationId"=>"getPlaylists.Format", "x-api-path-slug"=>"playlists-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"filter", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"q", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists", "", "Format"]}}, "/playlists/{playlist_id}.{format}"=>{"get"=>{"summary"=>"Get Playlists Playlist . Format", "description"=>"Returns a playlist by playlist id", "operationId"=>"getPlaylistsPlaylist.Format", "x-api-path-slug"=>"playlistsplaylist-id-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"path", "name"=>"playlist_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Playlists", "Playlist", "", "", "Format"]}}, "/groups.{format}"=>{"get"=>{"summary"=>"Get Groups. Format", "description"=>"Returns a collection of groups", "operationId"=>"getGroups.Format", "x-api-path-slug"=>"groups-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "", "Format"]}}, "/groups/{group_id}.{format}"=>{"get"=>{"summary"=>"Get Groups . Format", "description"=>"Returns a group by group id", "operationId"=>"getGroupsGroup.Format", "x-api-path-slug"=>"groupsgroup-id-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"playlist_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "", "", "Format"]}}, "/groups/{group_id}/users.{format}"=>{"get"=>{"summary"=>"Get Groups Users. Format", "description"=>"Returns a combined collection of moderators, members and contributors of the group with group id", "operationId"=>"getGroupsGroupUsers.Format", "x-api-path-slug"=>"groupsgroup-idusers-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"playlist_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Users", "", "Format"]}}, "/groups/{group_id}/moderators.{format}"=>{"get"=>{"summary"=>"Get Groups Moderators. Format", "description"=>"Returns a collection of moderators of the group with group id", "operationId"=>"getGroupsGroupModerators.Format", "x-api-path-slug"=>"groupsgroup-idmoderators-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"playlist_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Moderators", "", "Format"]}}, "/groups/{group_id}/members.{format}"=>{"get"=>{"summary"=>"Get Groups Members. Format", "description"=>"Returns a collection of members of the group with group id", "operationId"=>"getGroupsGroupMembers.Format", "x-api-path-slug"=>"groupsgroup-idmembers-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"playlist_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Members", "", "Format"]}}, "/groups/{group_id}/contributors.{format}"=>{"get"=>{"summary"=>"Get Groups Contributors. Format", "description"=>"Returns a collection of contributors of the group with group id", "operationId"=>"getGroupsGroupContributors.Format", "x-api-path-slug"=>"groupsgroup-idcontributors-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"playlist_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Contributors", "", "Format"]}}, "/groups/{group_id}/tracks.{format}"=>{"get"=>{"summary"=>"Get Groups Tracks. Format", "description"=>"Returns a collection of tracks contributed to the group with group id", "operationId"=>"getGroupsGroupTracks.Format", "x-api-path-slug"=>"groupsgroup-idtracks-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"playlist_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Tracks", "", "Format"]}}, "/comments/{comment_id}.{format}"=>{"get"=>{"summary"=>"Get Comments . Format", "description"=>"Returns a comment by comment id", "operationId"=>"getCommentsComment.Format", "x-api-path-slug"=>"commentscomment-id-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"playlist_id", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "", "", "Format"]}}, "/resolve.{format}"=>{"get"=>{"summary"=>"Get Resolve. Format", "description"=>"Translates a website URI into an API URI", "operationId"=>"getResolve.Format", "x-api-path-slug"=>"resolve-format-get", "parameters"=>[{"in"=>"query", "name"=>"consumer_key", "description"=>"Access, host, upload, and comment on audio"}, {"in"=>"query", "name"=>"url", "description"=>"Access, host, upload, and comment on audio"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resolve", "", "Format"]}}}}, "apis"=>{"name"=>"SoundCloud", "x-slug"=>"soundcloud", "description"=>"SoundCloud is a music and podcast streaming platform that lets you listen to millions of songs from around the world, or upload your own. Start listening now!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/252-soundcloud.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"112", "tags"=>"API LIfeyclessss,Audio,Audiossssssss,General Data,internet,Mobile,Music,My API Stack,Pedestal,Relative StreamRank,Service API,Social,Sound,Stack,Stack Network,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"soundcloud/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Sound Cloud", "x-api-slug"=>"sound-cloud", "description"=>"SoundCloud is a music and podcast streaming platform that lets you listen to millions of songs from around the world, or upload your own. Start listening now!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/252-soundcloud.jpg", "humanURL"=>"http://soundcloud.com", "baseURL"=>"https://api.soundcloud.com//", "tags"=>"API LIfeyclessss,Audio,Audiossssssss,General Data,internet,Mobile,Music,My API Stack,Pedestal,Relative StreamRank,Service API,Social,Sound,Stack,Stack Network,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/soundcloud/resolve-format-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/soundcloud/sound-cloud-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.soundcloud.com"}, {"type"=>"x-blog", "url"=>"http://blog.soundcloud.com"}, {"type"=>"x-blog-rss", "url"=>"http://blog.soundcloud.com/feed/"}, {"type"=>"x-console", "url"=>"https://developers.soundcloud.com/console"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/soundcloud"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/soundcloud"}, {"type"=>"x-developer", "url"=>"http://developers.soundcloud.com"}, {"type"=>"x-github", "url"=>"https://github.com/soundcloud"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/soundcloud/"}, {"type"=>"x-pricing", "url"=>"https://on.soundcloud.com/"}, {"type"=>"x-privacy", "url"=>"https://soundcloud.com/pages/privacy"}, {"type"=>"x-support", "url"=>"https://soundcloud.com/imprint"}, {"type"=>"x-terms-of-service", "url"=>"https://soundcloud.com/terms-of-use"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/soundcloudapi"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/SoundCloud"}, {"type"=>"x-website", "url"=>"http://soundcloud.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
smartbear-software{"testserver-rest-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"SmartBear Software", "x-complete"=>1, "info"=>{"title"=>"Ready! API TestServer API", "description"=>"a-rest-api-based-api-testing-framework-submit-json-test-recipes-using-your-favorite-http-client-or-one-of-the-existing-opensource-clientstools-on-github--to-run-api-tests-either-asynchronously-or-synchronously-java-client-httpsgithub-comsmartbearreadyapitestserverclient-maven-plugin-httpsgithub-comolensmarreadyapitestservermavenplugin---nodejs-cli-httpsgithub-comolensmarreadyapitestservercli-testrecipe-from-swagger-generator-httpsgithub-comolensmartestserverswaggercodegen-cucumber-integration-httpsgithub-comolensmartestservercucumbercheck-out-samples-at-httpsgithub-comsmartbearreadyapitestserversamples-and-the-documentation-at-httpreadyapi-smartbear-comtestserverstart--try-it-outa-useatyourownrisk-sandbox-is-provided-at-httptestserver-readyapi-io8080--feel-free-to-try-it-out-using-swaggerui-or-any-other-tool-of-your-liking-use-demouserdemopassword-as-your-basic-authentication-credentials--the-sandbox-is-currently-configured-to-support-only-rest-requests-and-propertytransfers--if-you-want-to-try-datasourcesdatasinksscripts-in-your-api-tests-you-will-need-to-install-and-run-your-own-instance-of-the-testserver--download-it-from-httpssmartbear-comproductreadyapitestserveroverview", "contact"=>{"name"=>"SmartBear Software", "url"=>"http://smartbear.com/testserver"}, "version"=>"1.2.1"}, "host"=>"testserver.readyapi.io:8080", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/readyapi/executions"=>{"get"=>{"summary"=>"Returns test run results stored on the TestServer.", "description"=>"Use this operation to get results of the latest test runs stored on the TestServer. The number of stored results is [configurable](http://readyapi.smartbear.com/testserver/reference/server_properties).", "operationId"=>"getExecutions", "x-api-path-slug"=>"readyapiexecutions-get", "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Executions"]}, "post"=>{"summary"=>"Runs a test recipe.", "description"=>"Use this operation to send a test recipe to the TestServer. The recipe contents is passed in the request body (should be valid JSON contents).", "operationId"=>"postRecipe", "x-api-path-slug"=>"readyapiexecutions-post", "parameters"=>[{"in"=>"query", "name"=>"async", "description"=>"Specifies when the TestServer replies:`true` - Immediately"}, {"in"=>"body", "name"=>"body", "description"=>"JSON-based test recipe contents", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"callback", "description"=>"The URL, to which the results will be posted"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Executions"]}}, "/readyapi/executions/xml"=>{"post"=>{"summary"=>"Executes a Ready! API project.", "description"=>"Use this operation to send a Ready! API test project to the TestServer. You command the TestServer to execute the entire project, or an individual test suite or test case in it. The recipe request should have a Ready! API project file (.xml) attached to it.", "operationId"=>"postProjectExecution", "x-api-path-slug"=>"readyapiexecutionsxml-post", "parameters"=>[{"in"=>"query", "name"=>"async", "description"=>"Specifies when TestServer replies:`true` - Immediately"}, {"in"=>"body", "name"=>"body", "description"=>"Ready! API XML project", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"callback", "description"=>"The URL, to which the results will be posted"}, {"in"=>"query", "name"=>"clientCertFileName", "description"=>"The name of the separately provided client certificate file"}, {"in"=>"query", "name"=>"clientCertPassword", "description"=>"The password for the separately provided client certificate file"}, {"in"=>"query", "name"=>"environment", "description"=>"The target environment for tests execution"}, {"in"=>"query", "name"=>"testCaseName", "description"=>"The name of the test case to run"}, {"in"=>"query", "name"=>"testSuiteName", "description"=>"The name of the test suite to run"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Executions"]}}, "/readyapi/executions/composite"=>{"post"=>{"summary"=>"Executes a zipped Ready! API composite project.", "description"=>"Use this operation to send a zipped Ready! API composite project to the TestServer. You command the TestServer to execute the entire project, or an individual test suite or test case in it. The recipe request should have a Ready! API project file (.xml) attached to it.", "operationId"=>"postCompositeProjectExecution", "x-api-path-slug"=>"readyapiexecutionscomposite-post", "parameters"=>[{"in"=>"query", "name"=>"async", "description"=>"Specifies when TestServer replies:`true` - Immediately"}, {"in"=>"body", "name"=>"body", "description"=>"Ready! API XML project", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"callback", "description"=>"The URL, to which the results will be posted"}, {"in"=>"query", "name"=>"clientCertFileName", "description"=>"The name of the separately provided client certificate file"}, {"in"=>"query", "name"=>"clientCertPassword", "description"=>"The password for the separately provided client certificate file"}, {"in"=>"query", "name"=>"environment", "description"=>"The target environment for tests execution"}, {"in"=>"query", "name"=>"testCaseName", "description"=>"The name of the test case to run"}, {"in"=>"query", "name"=>"testSuiteName", "description"=>"The name of the test suite to run"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Executions"]}}, "/readyapi/executions/{executionID}"=>{"delete"=>{"summary"=>"Cancels the specified recipe execution", "description"=>"Use this operation to stop the run specified by executionID. You can find in the response to your execution request ([see how](http://readyapi.smartbear.com/testserver/tutorials/your_first_recipe/results)), or you can send a GET /readyapi/executions request to the TestServer.", "operationId"=>"cancelExecution", "x-api-path-slug"=>"readyapiexecutionsexecutionid-delete", "parameters"=>[{"in"=>"path", "name"=>"executionID", "description"=>"The id of the test run to stop"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Executions"]}}, "/readyapi/executions/{executionID}/status"=>{"get"=>{"summary"=>"Returns the status of the specified recipe execution.", "description"=>"Use this operation to get information on the recipe execution specified by executionID. You can find in the response to your execution request ([see how](http://readyapi.smartbear.com/testserver/tutorials/your_first_recipe/results)), or you can send a GET /readyapi/executions request to the TestServer.", "operationId"=>"getExecutionStatus", "x-api-path-slug"=>"readyapiexecutionsexecutionidstatus-get", "parameters"=>[{"in"=>"path", "name"=>"executionID", "description"=>"The id of the desired test run"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Executions"]}}, "/readyapi/executions/{executionID}/logs"=>{"get"=>{"summary"=>"Returns the transaction logs for the specified recipe execution.", "description"=>"Use this operation to get transaction logs (individual request and recponse of executed test steps) of the recipe execution specified by executionID. You can find it in the response of your execution request ([see how](http://readyapi.smartbear.com/testserver/tutorials/your_first_recipe/results)), or you can send a GET /readyapi/executions/{executionID}/logs request to the TestServer.", "operationId"=>"getMessageExchanges", "x-api-path-slug"=>"readyapiexecutionsexecutionidlogs-get", "parameters"=>[{"in"=>"path", "name"=>"executionID", "description"=>"The id of the desired test run"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Executions"]}}, "/readyapi/executions/{executionId}/files"=>{"post"=>{"summary"=>"Posts a file for the specified test run", "description"=>"Use this operation to send additional files required by the executed test recipes. For example, you may need to send an Excel file for your test recipe that uses an Excel data source. The test recipe will be in the \"PENDING\" status until it receives the required file. Use the multipart/form-data media type for this request.", "operationId"=>"addFile", "x-api-path-slug"=>"readyapiexecutionsexecutionidfiles-post", "parameters"=>[{"in"=>"query", "name"=>"async", "description"=>"Specifies when the TestServer replies:`true` - Immediately"}, {"in"=>"body", "name"=>"body", "description"=>"Required file as `form-data`", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"executionId", "description"=>"The id of the test run that waits for the files"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Executions"]}}, "/readyapi/executions/{executionID}/transactions/{transactionId}"=>{"get"=>{"summary"=>"Gets message exchange for a test step execution transaction", "description"=>"A particular execution of a test step is referred as transaction. Use this operation to get the request and response for a transaction in HAR format.", "operationId"=>"getMessageExchange", "x-api-path-slug"=>"readyapiexecutionsexecutionidtransactionstransactionid-get", "parameters"=>[{"in"=>"path", "name"=>"executionID", "description"=>"The id of the test run to get the logs for"}, {"in"=>"path", "name"=>"transactionId", "description"=>"The id of the transaction (test step execution) to get the message exchange (request and response) for"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Executions"]}}}}, "apis"=>{"name"=>"SmartBear Software", "x-slug"=>"smartbear-software", "description"=>"Testing and Development teams around the world use SmartBears automation, development and monitoring tools to build better software and applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1157-smartbear-software.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"35193", "tags"=>"API LIfeyclessss,Enterprise,Monitoring,Performance,Relative Data,SaaS,Security,Service API,Stack Network,Technology,Testing,Virtualizations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"smartbear-software/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"TestServer REST API", "x-api-slug"=>"testserver-rest-api", "description"=>"Testing and Development teams around the world use SmartBears automation, development and monitoring tools to build better software and applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1157-smartbear-software.jpg", "humanURL"=>"http://smartbear.com/", "baseURL"=>"://testserver.readyapi.io:8080//v1", "tags"=>"API LIfeyclessss,Enterprise,Monitoring,Performance,Relative Data,SaaS,Security,Service API,Stack Network,Technology,Testing,Virtualizations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/smartbear-software/readyapiexecutionsexecutionidtransactionstransactionid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/smartbear-software/testserver-rest-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://blog.smartbear.com/"}, {"type"=>"x-blog-rss", "url"=>"http://feeds.feedburner.com/smartbear"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/smart-bear-software"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/smart-bear-software"}, {"type"=>"x-github", "url"=>"https://github.com/SmartBear"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/smartbear"}, {"type"=>"x-website", "url"=>"http://smartbear.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
livechat{"livechat-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"LiveChat", "x-complete"=>1, "info"=>{"title"=>"LiveChat REST API", "description"=>"-introductionwelcome-to-the-livechat-api-documentationour-api-provides-a-set-of-flexible-tools-which-you-can-use-to-create-new-outstanding-projects--we-smile-a-bit-more-each-time-we-see-skilled-developers-unleash-their-creativityplease-note-that-this-documentation-refers-to-the-latest-api-version-2-0--if-you-are-looking-for-the-previous-version-check-out-the-deprecated-api-1-0-documentation--basic-api-usageall-livechat-api-requests-start-with--httpsapi-livechatinc-com-please-note-that-all-livechat-api-requests-must-use-https-protocol-the-next-segment-of-the-url-path-depends-on-the-type-of-your-request--for-example-use--httpsapi-livechatinc-comagents--to-get-or-modify-the-agents-data-all-requests-must-have-xapiversion-header-set-to-the-number-of-the-version-that-youd-like-to-use--the-most-recent-version-is-2--authenticationtwo-common-authentication-methods-are-supported--oauth-2-0--and--api-key--oauth-2-0oauth-2-0-authentication-is-the-recommended-way-of-authenticating-to-livechat-api-it-is-the-most-secure-way-of-making-api-calls--with-this-flow-you-will-get-access-only-to-some-parts-of-livechat-account-such-as-reading-agents-list--this-is-more-secure-than--api-key-flowhttpsdocs-livechatinc-comrestapiapikey--which-has-always-access-to-all-livechat-account-data-to-start-using-oauth-2-0-please-read-a-dedicated--authorizationhttpsdocs-livechatinc-comauthorization--guide--api-keyif-you-want-to-build-a-private-app-that-will-run-on-your-own-server-you-can-skip-the-oauth-2-0-flow-and-use-the-api-key--please-note-this-flow-of-making-api-calls-is-less-secure-because-the-api-key-gives-access-to-all-livechat-account-data-with-this-authorization-method-you-will-need-to-include-your-livechat-login-and--api-key--for-each-method-call--youll-find-the-api-key-in--your-livechat-profilehttpsmy-livechatinc-comagentsapikey-authentication-to-the-api-occurs-via--http-basic-authhttpen-wikipedia-orgwikibasic-access-authentication--provide-your--login--as-the-basic-auth-username-and-the--api-key--as-the-password--you-must-authenticate-for-all-requests-all-api-requests-must-be-made-over-https--data-formatthe-livechat-api-returns-the-data-in-the--jsonhttpen-wikipedia-orgwikijson--format--check-out-the-following-example--jsonpall-requests-made-with-http-get-are--jsonphttpen-wikipedia-orgwikijsonpenabled--to-use-jsonp-append--callback--and-the-name-of-your-callback-function-to-the-request--error-handlingthe-errors-are-returned-using-the-standard-http-error-code-syntax--in-general-the-codes-in-the-2xx-range-indicate-success-the-codes-in-the-4xx-range-indicate-an-error-incorrect-or-missing-parameters-not-authenticated-etc--and-the-codes-in-the-5xx-range-indicate-an-error-with-the-livechat-servers--any-additional-info-is-included-in-the-body-of-the-return-call-jsonformatted--http-status-codes-summary---400---the-request-is-incorrect-please-make-sure-that-the-passed-arguments-are-matching-the-format-in-the-methods-documentation----401---unauthorized--you-attempt-to-authenticate-with-an-invalid-username-or-api-key----404---not-found--you-attempt-to-request-a-resource-which-doesnt-exist----500---internal-server-error--something-unexpected-happened-on-our-end--please-try-again-or-contact-our-support--crossdomainall-crossdomain-api-requests-made-by-a-web-browser-are-denied-for-security-reasons--it-means-that-the-browserbased-requests-are-not-allowed-from-3rd-party-domains-including--localhost--livechat-api-librariesall-api-calls-include-an-api-key-that-can-be-easily-stolen-when-making-a-request-using-a-web-browser--it-means-you-should-use-backend-languages-for-api-requests--here-is-a-list-of-the-readytouse-libraries---php-library-for-livechat-apihttpsgithub-comlivechatapiclientphp-hosted-on-github----node-js-library-for-livechat-apihttpsgithub-comlivechatapiclientnodejs-hosted-on-github----ruby-library-for-livechat-apihttpsgithub-comcxzlivechat-client-hosted-on-github----c-library-for-livechat-apihttpsgithub-comlivechatapiclientcsharp-hosted-on-github--external-livechat-api-libraries---r-library-for-livechat-apihttpsgithub-comlawwulivechatr-hosted-on-github-did-you-write-your-own-library-and-want-it-listed-here-let-us-know", "version"=>"1.0.0"}, "host"=>"api.livechatinc.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/webhooks/12345"=>{"delete"=>{"summary"=>"Delete a webhook", "description"=>"Deletes a webhook with the given ID.", "operationId"=>"Webhooks12345Delete", "x-api-path-slug"=>"webhooks12345-delete", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook"]}}, "/reports/chats/ratings"=>{"get"=>{"summary"=>"Chat ratings report", "description"=>"Shows how many chats have been rated and how they have been rated during a specified period.", "operationId"=>"ReportsChatsRatingsGet", "x-api-path-slug"=>"reportschatsratings-get", "parameters"=>[{"in"=>"query", "name"=>"date_from"}, {"in"=>"query", "name"=>"date_to"}, {"in"=>"query", "name"=>"group"}, {"in"=>"query", "name"=>"group_by"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat", "Ratings", "Report"]}}, "/canned_responses/ABC123"=>{"get"=>{"summary"=>"List all canned responses1", "description"=>"Returns the list of all currently set canned responses.", "operationId"=>"CannedResponsesABC123Get", "x-api-path-slug"=>"canned-responsesabc123-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Canned", "Responses1"]}, "put"=>{"summary"=>"Update a canned response", "description"=>"Updates the specified canned response by setting the values of the parameters passed. Any parameters not provided will be left unchanged.", "operationId"=>"CannedResponsesABC123Put", "x-api-path-slug"=>"canned-responsesabc123-put", "parameters"=>[{"in"=>"formData", "name"=>"tags[0]"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Canned", "Response"]}, "delete"=>{"summary"=>"Remove a canned response", "description"=>"Removes a canned response with the given CANNED_RESPONSE_ID.", "operationId"=>"CannedResponsesABC123Delete", "x-api-path-slug"=>"canned-responsesabc123-delete", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Canned", "Response"]}}, "/groups/ABC123"=>{"put"=>{"summary"=>"Update a group", "description"=>"Updates the specified group by setting the values of the parameters passed. Any parameters not provided will be left unchanged.", "operationId"=>"GroupsABC123Put", "x-api-path-slug"=>"groupsabc123-put", "parameters"=>[{"in"=>"formData", "name"=>"agents[0]"}, {"in"=>"formData", "name"=>"agents[1]"}, {"in"=>"formData", "name"=>"name"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}, "delete"=>{"summary"=>"Remove a group", "description"=>"Removes a group with the given GROUP_ID.", "operationId"=>"GroupsABC123Delete2", "x-api-path-slug"=>"groupsabc123-delete", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Group"]}}, "/reports/chats/engagement"=>{"get"=>{"summary"=>"Chat engagement", "description"=>"This report shows you where you get your chats from. They can come from i.e. automatic invitations, manual invitations or the visitors can start the chats by themselves.", "operationId"=>"ReportsChatsEngagementGet", "x-api-path-slug"=>"reportschatsengagement-get", "parameters"=>[{"in"=>"query", "name"=>"agent"}, {"in"=>"query", "name"=>"date_from"}, {"in"=>"query", "name"=>"date_to"}, {"in"=>"query", "name"=>"group_by"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat", "Engagement"]}}, "/greetings"=>{"get"=>{"summary"=>"List all greetings", "description"=>"Returns the list of all greetings.", "operationId"=>"GreetingsGet", "x-api-path-slug"=>"greetings-get", "parameters"=>[{"in"=>"query", "name"=>"groups"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Greetings"]}, "post"=>{"summary"=>"Create a new greeting", "description"=>"Use this function to create a new greeting.", "operationId"=>"GreetingsPost", "x-api-path-slug"=>"greetings-post", "parameters"=>[{"in"=>"formData", "name"=>"name"}, {"in"=>"formData", "name"=>"rules[0][operator]"}, {"in"=>"formData", "name"=>"rules[0][type]"}, {"in"=>"formData", "name"=>"rules[0][value]"}, {"in"=>"formData", "name"=>"rules[1][operator]"}, {"in"=>"formData", "name"=>"rules[1][type]"}, {"in"=>"formData", "name"=>"rules[1][value]"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Greeting"]}}, "/webhooks"=>{"get"=>{"summary"=>"Display configured webhooks", "description"=>"Returns a list of webhooks that have been created in a LiveChat account.", "operationId"=>"WebhooksGet", "x-api-path-slug"=>"webhooks-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Display", "Configured", "Webhooks"]}, "post"=>{"summary"=>"Create a new webhook", "description"=>"Creates a new webhook.", "operationId"=>"WebhooksPost", "x-api-path-slug"=>"webhooks-post", "parameters"=>[{"in"=>"formData", "name"=>"data_types[]"}, {"in"=>"formData", "name"=>"event_type"}, {"in"=>"formData", "name"=>"url"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Webhook"]}}, "/reports/chats/greetings"=>{"get"=>{"summary"=>"Greetings", "description"=>"Returns the “greetings to chats to goals” conversion rates report.\n\ndisplayed is the number of displayed greetings. accepted tells you how many chats resulted from these greetings. goals tells you how many goals resulted from these greetings.", "operationId"=>"ReportsChatsGreetingsGet", "x-api-path-slug"=>"reportschatsgreetings-get", "parameters"=>[{"in"=>"query", "name"=>"date_from"}, {"in"=>"query", "name"=>"date_to"}, {"in"=>"query", "name"=>"group_by"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Greetings"]}}, "/tags"=>{"get"=>{"summary"=>"List all tags", "description"=>"Returns tags from all groups.", "operationId"=>"TagsGet", "x-api-path-slug"=>"tags-get", "parameters"=>[{"in"=>"query", "name"=>"group"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Tags"]}, "post"=>{"summary"=>"Add a tag", "description"=>"Adds a new tag. Note that only the owner and the admins are authorized to use this.", "operationId"=>"TagsPost", "x-api-path-slug"=>"tags-post", "parameters"=>[{"in"=>"formData", "name"=>"author"}, {"in"=>"formData", "name"=>"group"}, {"in"=>"formData", "name"=>"tag"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tag"]}}, "/agents/john@public.com"=>{"get"=>{"summary"=>"Get a single agent details", "description"=>"Returns complete details of the agent for the given LOGIN.", "operationId"=>"AgentsJohnPublicComGet", "x-api-path-slug"=>"agentsjohnpublic-com-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Agent", "Details"]}, "put"=>{"summary"=>"Get a single agent details", "description"=>"Returns complete details of the agent for the given LOGIN.", "operationId"=>"AgentsJohnPublicComPut", "x-api-path-slug"=>"agentsjohnpublic-com-put", "parameters"=>[{"in"=>"formData", "name"=>"job_title"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Agent", "Details"]}, "delete"=>{"summary"=>"Remove an agent", "description"=>"Removes an agent.", "operationId"=>"AgentsJohnPublicComDelete", "x-api-path-slug"=>"agentsjohnpublic-com-delete", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Agent"]}}, "/tickets"=>{"get"=>{"summary"=>"Get list of tickets", "description"=>"Returns all tickets.", "operationId"=>"TicketsGet", "x-api-path-slug"=>"tickets-get", "parameters"=>[{"in"=>"query", "name"=>"date_from"}, {"in"=>"query", "name"=>"status"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Tickets"]}, "post"=>{"summary"=>"Create a ticket", "description"=>"Creates a new ticket.", "operationId"=>"TicketsPost", "x-api-path-slug"=>"tickets-post", "parameters"=>[{"in"=>"formData", "name"=>"message"}, {"in"=>"formData", "name"=>"requester[mail]"}, {"in"=>"formData", "name"=>"requester[name]"}, {"in"=>"formData", "name"=>"subject"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket"]}}, "/reports/tickets/solved_tickets"=>{"get"=>{"summary"=>"Solved tickets", "description"=>"Shows the number of the tickets solved during the specified period.", "operationId"=>"ReportsTicketsSolvedTicketsGet", "x-api-path-slug"=>"reportsticketssolved-tickets-get", "parameters"=>[{"in"=>"query", "name"=>"date_from"}, {"in"=>"query", "name"=>"date_to"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Solved", "Tickets"]}}, "/reports/chats/first_response_time"=>{"get"=>{"summary"=>"Chats first response time", "description"=>"The average amount of time it takes the agents to respond to a new chat over a specified period of time.", "operationId"=>"ReportsChatsFirstResponseTimeGet", "x-api-path-slug"=>"reportschatsfirst-response-time-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chats", "First", "Response", "Time"]}}, "/canned_responses"=>{"get"=>{"summary"=>"List all canned responses", "description"=>"Returns the list of all currently set canned responses.", "operationId"=>"CannedResponsesGet", "x-api-path-slug"=>"canned-responses-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Canned", "Responses"]}, "post"=>{"summary"=>"Create a new canned response", "description"=>"Creates a new canned response.", "operationId"=>"CannedResponsesPost", "x-api-path-slug"=>"canned-responses-post", "parameters"=>[{"in"=>"formData", "name"=>"tags[0]"}, {"in"=>"formData", "name"=>"tags[1]"}, {"in"=>"formData", "name"=>"text"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Canned", "Response"]}}, "/reports/chats/ratings/ranking"=>{"get"=>{"summary"=>"Chat Ranking", "description"=>"Shows the ratio of good to bad ratings for each operator.", "operationId"=>"ReportsChatsRatingsRankingGet", "x-api-path-slug"=>"reportschatsratingsranking-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat", "Ranking"]}}, "/groups"=>{"get"=>{"summary"=>"List all groups", "description"=>"Returns all created groups.", "operationId"=>"GroupsGet", "x-api-path-slug"=>"groups-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Groups"]}, "post"=>{"summary"=>"Create a new group", "description"=>"Creates a new group in your license.", "operationId"=>"GroupsPost", "x-api-path-slug"=>"groups-post", "parameters"=>[{"in"=>"formData", "name"=>"agents[0]"}, {"in"=>"formData", "name"=>"agents[1]"}, {"in"=>"formData", "name"=>"name"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Group"]}}, "/chats/ABC123"=>{"get"=>{"summary"=>"Get single chat", "description"=>"Returns a single chat item for the given CHAT_ID.", "operationId"=>"ChatsABC123Get", "x-api-path-slug"=>"chatsabc123-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Chat"]}}, "/reports/tickets/ticket_sources"=>{"get"=>{"summary"=>"Ticket sources", "description"=>"Shows the distribution of the tickets between various channels.", "operationId"=>"ReportsTicketsTicketSourcesGet", "x-api-path-slug"=>"reportsticketsticket-sources-get", "parameters"=>[{"in"=>"query", "name"=>"date_from"}, {"in"=>"query", "name"=>"date_to"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket", "Sources"]}}, "/greetings/ABC123"=>{"get"=>{"summary"=>"Get a single greeting", "description"=>"Returns the specified greeting.", "operationId"=>"GreetingsABC123Get", "x-api-path-slug"=>"greetingsabc123-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Greeting"]}, "delete"=>{"summary"=>"Remove a greeting", "description"=>"Removes a greeting.", "operationId"=>"GreetingsABC123Delete", "x-api-path-slug"=>"greetingsabc123-delete", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Greeting"]}}, "/groups/{group_id}"=>{"get"=>{"summary"=>"Get a single group details", "description"=>"Returns group details for the given GROUP_ID.", "operationId"=>"GroupsByGroupIdGet", "x-api-path-slug"=>"groupsgroup-id-get", "parameters"=>[{"in"=>"path", "name"=>"group_id"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Group", "Details"]}}, "/reports/chats/total_chats"=>{"get"=>{"summary"=>"Total chats", "description"=>"Shows how many chats occurred during the specified period.", "operationId"=>"ReportsChatsTotalChatsGet", "x-api-path-slug"=>"reportschatstotal-chats-get", "parameters"=>[{"in"=>"query", "name"=>"agent"}, {"in"=>"query", "name"=>"date_from"}, {"in"=>"query", "name"=>"date_to"}, {"in"=>"query", "name"=>"group_by"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Total", "Chats"]}}, "/goals"=>{"get"=>{"summary"=>"List all goals", "description"=>"Returns all currently set goals. The active parameter indicates whether a goal is enabled or not.", "operationId"=>"GoalsGet", "x-api-path-slug"=>"goals-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Goals"]}, "post"=>{"summary"=>"Add a new goal", "description"=>"Creates a new goal.", "operationId"=>"GoalsPost", "x-api-path-slug"=>"goals-post", "parameters"=>[{"in"=>"formData", "name"=>"match_type"}, {"in"=>"formData", "name"=>"name"}, {"in"=>"formData", "name"=>"type"}, {"in"=>"formData", "name"=>"url"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Goal"]}}, "/chats"=>{"get"=>{"summary"=>"Get list of chats", "description"=>"Returns all ended chats.", "operationId"=>"ChatsGet", "x-api-path-slug"=>"chats-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Chats"]}}, "/agents"=>{"get"=>{"summary"=>"List all agents", "description"=>"Returns all LiveChat agents list", "operationId"=>"AgentsGet", "x-api-path-slug"=>"agents-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Agents"]}, "post"=>{"summary"=>"Create a new agent", "description"=>"Creates a new agent in your license.", "operationId"=>"AgentsPost", "x-api-path-slug"=>"agents-post", "parameters"=>[{"in"=>"formData", "name"=>"login"}, {"in"=>"formData", "name"=>"name"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Agent"]}}, "/goals/ABC123"=>{"get"=>{"summary"=>"Get a single goal details", "description"=>"Returns the goal details for the given GOAL_ID.", "operationId"=>"GoalsABC123Get", "x-api-path-slug"=>"goalsabc123-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Goal", "Details"]}, "put"=>{"summary"=>"Update a goal", "description"=>"Updates the specified goal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.\n\nThe GOAL_ID is obtained from the goals list.", "operationId"=>"GoalsABC123Put", "x-api-path-slug"=>"goalsabc123-put", "parameters"=>[{"in"=>"formData", "name"=>"active"}, {"in"=>"formData", "name"=>"name"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Goal"]}, "delete"=>{"summary"=>"Remove a goal", "description"=>"Removes a goal with the given GOAL_ID.", "operationId"=>"GoalsABC123Delete", "x-api-path-slug"=>"goalsabc123-delete", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Goal"]}}, "/reports/tickets/ratings"=>{"get"=>{"summary"=>"Ticket ratings report", "description"=>"Shows the tickets that were rated during the specified period.", "operationId"=>"ReportsTicketsRatingsGet", "x-api-path-slug"=>"reportsticketsratings-get", "parameters"=>[{"in"=>"query", "name"=>"date_from"}, {"in"=>"query", "name"=>"date_to"}, {"in"=>"query", "name"=>"group"}, {"in"=>"query", "name"=>"group_by"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket", "Ratings", "Report"]}}, "/tickets/5FUED/tags"=>{"put"=>{"summary"=>"Update ticket tags", "description"=>"Updates tags associated with the ticket.", "operationId"=>"Tickets5FUEDTagsPut", "x-api-path-slug"=>"tickets5fuedtags-put", "parameters"=>[{"in"=>"formData", "name"=>"tag[]"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket", "Tags"]}}, "/reports/tickets/ratings/ranking"=>{"get"=>{"summary"=>"Ticket Ranking", "description"=>"Shows the ratio of good to bad ratings for each operator.", "operationId"=>"ReportsTicketsRatingsRankingGet", "x-api-path-slug"=>"reportsticketsratingsranking-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket", "Ranking"]}}, "/reports/chats/response_time"=>{"get"=>{"summary"=>"Chats response time", "description"=>"The average amount of time it takes the agents to respond to a new message in a chat during a specified period.", "operationId"=>"ReportsChatsResponseTimeGet", "x-api-path-slug"=>"reportschatsresponse-time-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chats", "Response", "Time"]}}, "/reports/availability"=>{"get"=>{"summary"=>"Availability", "description"=>"Shows how long an agent (or a group or the whole account) was available for chatting during a specified period. When querying for one day, the results are shown in minutes per every hour, otherwise in hours for each day.", "operationId"=>"ReportsAvailabilityGet", "x-api-path-slug"=>"reportsavailability-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availability"]}}, "/chats/ABC123/tags"=>{"put"=>{"summary"=>"Update chat tags", "description"=>"This method updates the tags assigned to a chat.", "operationId"=>"ChatsABC123TagsPut", "x-api-path-slug"=>"chatsabc123tags-put", "parameters"=>[{"in"=>"formData", "name"=>"tag[0]"}, {"in"=>"formData", "name"=>"tag[1]"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat", "Tags"]}}, "/visitors"=>{"get"=>{"summary"=>"List all visitors", "description"=>"Returns a list of the visitors on the pages with the tracking code installed.", "operationId"=>"VisitorsGet", "x-api-path-slug"=>"visitors-get", "parameters"=>[{"in"=>"query", "name"=>"group[]"}, {"in"=>"query", "name"=>"state"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Visitors"]}}, "/reports/tickets/resolution_time"=>{"get"=>{"summary"=>"Tickets resolution time", "description"=>"Shows the resolution time of the tickets that were solved during the specified period.", "operationId"=>"ReportsTicketsResolutionTimeGet", "x-api-path-slug"=>"reportsticketsresolution-time-get", "parameters"=>[{"in"=>"query", "name"=>"date_from"}, {"in"=>"query", "name"=>"date_to"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tickets", "Resolution", "Time"]}}, "/tags/support"=>{"delete"=>{"summary"=>"Delete a tag", "description"=>"Deletes a tag from the chosen group. The agents will no longer be able to tag chats and tickets using this tag.\n\nDeleting a tag will not remove it from the archived chats and tickets.", "operationId"=>"TagsSupportDelete", "x-api-path-slug"=>"tagssupport-delete", "parameters"=>[{"in"=>"formData", "name"=>"group"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tag"]}}, "/reports/chats/goals"=>{"get"=>{"summary"=>"Goals", "description"=>"Shows the number of reached goals.", "operationId"=>"ReportsChatsGoalsGet", "x-api-path-slug"=>"reportschatsgoals-get", "parameters"=>[{"in"=>"query", "name"=>"date_from"}, {"in"=>"query", "name"=>"goal"}, {"in"=>"query", "name"=>"group_by"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Goals"]}}, "/reports/chats/queued_visitors"=>{"get"=>{"summary"=>"Queued visitors", "description"=>"Shows how many visitors waited in the queue and how many abandoned the queue or proceeded to chats", "operationId"=>"ReportsChatsQueuedVisitorsGet", "x-api-path-slug"=>"reportschatsqueued-visitors-get", "parameters"=>[{"in"=>"query", "name"=>"date_from"}, {"in"=>"query", "name"=>"group"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queued", "Visitors"]}}, "/reports/chats/queued_visitors/waiting_times"=>{"get"=>{"summary"=>"Queue waiting times", "description"=>"Shows the Minimum, Average and Maximum waiting time.", "operationId"=>"ReportsChatsQueuedVisitorsWaitingTimesGet", "x-api-path-slug"=>"reportschatsqueued-visitorswaiting-times-get", "parameters"=>[{"in"=>"query", "name"=>"date_from"}, {"in"=>"query", "name"=>"group"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queue", "Waiting", "Times"]}}, "/reports/chats/chatting_time"=>{"get"=>{"summary"=>"Chatting time", "description"=>"Shows how much time an agent (or a group) spent on chatting during a specified period. When querying for one day, the results are shown in minutes per every hour, otherwise in hours for each day.", "operationId"=>"ReportsChatsChattingTimeGet", "x-api-path-slug"=>"reportschatschatting-time-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chatting", "Time"]}}, "/goals/ABC123/mark_as_successful"=>{"post"=>{"summary"=>"Mark a goal as successful", "description"=>"The GOAL_ID is obtained from the goals list.", "operationId"=>"GoalsABC123MarkAsSuccessfulPost", "x-api-path-slug"=>"goalsabc123mark-as-successful-post", "parameters"=>[{"in"=>"formData", "name"=>"visitor_id"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mark", "Goal", "As", "Successful"]}}, "/status"=>{"get"=>{"summary"=>"Get status", "description"=>"Returns the current LiveChat status. Available return values: online, offline.", "operationId"=>"StatusGet", "x-api-path-slug"=>"status-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Status"]}}, "/greetings/2491"=>{"put"=>{"summary"=>"Update greeting", "description"=>"Use this request to change the name or message of a greeting.", "operationId"=>"Greetings2491Put", "x-api-path-slug"=>"greetings2491-put", "parameters"=>[{"in"=>"formData", "name"=>"name"}, {"in"=>"formData", "name"=>"properties[greeting-message_text]"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Greeting"]}}, "/reports/tickets/first_response_time"=>{"get"=>{"summary"=>"Tickets first response time", "description"=>"Shows the time of the first response to the tickets that were responded to for the first time during the specified period.", "operationId"=>"ReportsTicketsFirstResponseTimeGet", "x-api-path-slug"=>"reportsticketsfirst-response-time-get", "parameters"=>[{"in"=>"query", "name"=>"agent"}, {"in"=>"query", "name"=>"date_from"}, {"in"=>"query", "name"=>"date_to"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tickets", "First", "Response", "Time"]}}, "/chats/ABC123/send_transcript"=>{"post"=>{"summary"=>"Send chat transcript to e-mail", "description"=>"", "operationId"=>"ChatsABC123SendTranscriptPost", "x-api-path-slug"=>"chatsabc123send-transcript-post", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Chat", "Transcript", "To", "E-mail"]}}, "/reports/chats/agents_occupancy"=>{"get"=>{"summary"=>"Number of simultaneous chats", "description"=>"This request shows the maximum number of concurrent chats that happened at the same hour on a particular day.", "operationId"=>"ReportsChatsAgentsOccupancyGet", "x-api-path-slug"=>"reportschatsagents-occupancy-get", "parameters"=>[{"in"=>"query", "name"=>"weekday"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Number", "Of", "Simultaneous", "Chats"]}}, "/visitors/S1352647457.ac951bfe2e/details"=>{"post"=>{"summary"=>"Add custom visitor details", "description"=>"Displays additional information about a visitor in LiveChat apps.", "operationId"=>"VisitorsS1352647457Ac951bfe2eDetailsPost", "x-api-path-slug"=>"visitorss1352647457-ac951bfe2edetails-post", "parameters"=>[{"in"=>"formData", "name"=>"fields[0][name]"}, {"in"=>"formData", "name"=>"fields[0][value]"}, {"in"=>"formData", "name"=>"id"}, {"in"=>"formData", "name"=>"license_id"}, {"in"=>"formData", "name"=>"token"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Visitor", "Details"]}}, "/tickets/5FUED"=>{"get"=>{"summary"=>"Get single ticket", "description"=>"Returns a single ticket item for the given TICKET_ID", "operationId"=>"Tickets5FUEDGet", "x-api-path-slug"=>"tickets5fued-get", "parameters"=>[{"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Ticket"]}}, "/reports/tickets/new_tickets"=>{"get"=>{"summary"=>"New tickets", "description"=>"Shows the number of the tickets created during the specified period.", "operationId"=>"ReportsTicketsNewTicketsGet", "x-api-path-slug"=>"reportsticketsnew-tickets-get", "parameters"=>[{"in"=>"query", "name"=>"date_from"}, {"in"=>"query", "name"=>"date_to"}, {"in"=>"query", "name"=>"group_by"}, {"in"=>"header", "name"=>"X-API-Version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Tickets"]}}}}, "apis"=>{"name"=>"LiveChat", "x-slug"=>"livechat", "description"=>"LiveChat is an offline customer service software with live support, help desk software, and web analytics capabilities.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28877-developers-livechatinc-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"4371", "tags"=>"Chats,SaaS,Support,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"livechat/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"LiveChat", "x-api-slug"=>"livechat", "description"=>"LiveChat is an offline customer service software with live support, help desk software, and web analytics capabilities.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28877-developers-livechatinc-com.jpg", "humanURL"=>"https://www.livechatinc.com/", "baseURL"=>"https://api.livechatinc.com//", "tags"=>"Chats,SaaS,Support,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/livechat/reportsticketsnew-tickets-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/livechat/livechat-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://www.livechatinc.com/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/livechatsoftware"}, {"type"=>"x-email", "url"=>"support@livechatinc.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/LiveChat"}, {"type"=>"x-developer", "url"=>"https://developers.livechatinc.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| bmc-software{"bmc-software-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"BMC Software", "x-complete"=>1, "info"=>{"title"=>"BMC Software Merged API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/account"=>{"get"=>{"summary"=>"Account Resource", "description"=>"Information about the authorized account.", "operationId"=>"information-about-the-authorized-account", "x-api-path-slug"=>"account-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/events?message={message}&severity={severity}×tamp_utc_from={timestamp_utc_from}×tamp_utc_to={timestamp_utc_to} "=>{" get "=>{"summary"=>"Events?message={message}&severity={severity}×tamp_utc_from={timestamp_utc_from}×tamp_utc_to={timestamp_utc_to}", "description"=>"Gets a list of events for the current user.", "operationId"=>"-eventsmessagemessageampseverityseverityamptimestamp-utc-fromtimestamp-utc-fromamptimestamp-utc-toti", "x-api-path-slug"=>"eventsmessagemessageampseverityseverityamptimestamp-utc-fromtimestamp-utc-fromamptimestamp-utc-totimestamp-utc-to-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom Events"]}}, "/custom_events "=>{" post "=>{"summary"=>"Custom Events", "description"=>"Creates new custom event.", "operationId"=>"-custom-events-", "x-api-path-slug"=>"custom-events-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom Events"]}}, "/custom_events/all?fromUtc={fromUtc}&toUtc={toUtc} "=>{" get "=>{"summary"=>"Custom Events", "description"=>"Gets all custom events using optional filter.", "operationId"=>"-custom-events-allfromutcfromutcamptoutctoutc-", "x-api-path-slug"=>"custom-eventsallfromutcfromutcamptoutctoutc-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom Events"]}}, "/custom_events/{id} "=>{" get "=>{"summary"=>"Custom_events {id}", "description"=>"Gets custom event by Id.", "operationId"=>"-custom-events-id-", "x-api-path-slug"=>"custom-eventsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom Events"]}, " put "=>{"summary"=>"Custom_events {id}", "description"=>"Updates custom event.", "operationId"=>"-custom-events-id-", "x-api-path-slug"=>"custom-eventsid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom Events"]}, " delete "=>{"summary"=>"Custom_events {id}", "description"=>"Deletes custom event.", "operationId"=>"-custom-events-id-", "x-api-path-slug"=>"custom-eventsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom Events"]}}, "/v1/account/aws/status"=>{"get"=>{"summary"=>"Get AWS Integration Status", "description"=>"Gets AWS status", "operationId"=>"get-aws-integration-status", "x-api-path-slug"=>"v1accountawsstatus-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/v1/actions"=>{"get"=>{"summary"=>"Get all available action types", "description"=>"Gets all known action types", "operationId"=>"get-all-available-action-types", "x-api-path-slug"=>"v1actions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions"]}}, "/v1/actions/installed"=>{"get"=>{"summary"=>"Get all installed actions", "description"=>"Gets all actions that are installed for the project", "operationId"=>"get-all-installed-actions", "x-api-path-slug"=>"v1actionsinstalled-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions"]}, "put"=>{"summary"=>"Install action", "description"=>"Installs an action", "operationId"=>"install-action", "x-api-path-slug"=>"v1actionsinstalled-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions"]}}, "/v1/actions/installed/:actionId"=>{"get"=>{"summary"=>"Get details of an installed action", "description"=>"Gets a single action definition", "operationId"=>"get-details-of-an-installed-action", "x-api-path-slug"=>"v1actionsinstalledactionid-get", "parameters"=>[{"in"=>"query", "name"=>"actionId\nName of plugin", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions"]}, "delete"=>{"summary"=>"Uninstall action", "description"=>"Uninstalls an action and remove it from the associated alarms(s).", "operationId"=>"uninstall-action", "x-api-path-slug"=>"v1actionsinstalledactionid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions"]}}, "/v1/actions/installed/:actionId/alarms"=>{"get"=>{"summary"=>"Get all alarms using an action", "description"=>"Get alarms that are using this action installed for the project", "operationId"=>"get-all-alarms-using-an-action", "x-api-path-slug"=>"v1actionsinstalledactionidalarms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions"]}}, "/v1/actions/:action"=>{"get"=>{"summary"=>"Get action", "description"=>"Gets a single action type", "operationId"=>"get-action", "x-api-path-slug"=>"v1actionsaction-get", "parameters"=>[{"in"=>"query", "name"=>"action\nName of plugin", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions"]}}, "/v1/alarms"=>{"get"=>{"summary"=>"Get All Alarms", "description"=>"Get all of the Alarms", "operationId"=>"get-all-alarms", "x-api-path-slug"=>"v1alarms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarms"]}, "post"=>{"summary"=>"Create Alarm", "description"=>"Create an Alarm", "operationId"=>"create-alarm", "x-api-path-slug"=>"v1alarms-post", "parameters"=>[{"in"=>"formData", "name"=>"name", "description"=>"The name of the alarm", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarms"]}}, "/v1/alarm/:alarmId"=>{"get"=>{"summary"=>"Get Alarm by Id", "description"=>"Retrieves a single alarm", "operationId"=>"get-alarm-by-id", "x-api-path-slug"=>"v1alarmalarmid-get", "parameters"=>[{"in"=>"query", "name"=>"alarmId", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarms"]}, "put"=>{"summary"=>"Update Alarm", "description"=>"Update an Alarm", "operationId"=>"update-alarm", "x-api-path-slug"=>"v1alarmalarmid-put", "parameters"=>[{"in"=>"formData", "name"=>"name", "description"=>"The name of the alarm", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarms"]}, "delete"=>{"summary"=>"Delete Alarm", "description"=>"Deletes an alarm", "operationId"=>"delete-alarm", "x-api-path-slug"=>"v1alarmalarmid-delete", "parameters"=>[{"in"=>"query", "name"=>"alarmId\nThe alarm to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarms"]}}, "/v1/alarms/search"=>{"get"=>{"summary"=>"Get Alarms by Name", "description"=>"Retrieves alarms by name", "operationId"=>"get-alarms-by-name", "x-api-path-slug"=>"v1alarmssearch-get", "parameters"=>[{"in"=>"query", "name"=>"alarmName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarms"]}}, "/v2/alarms"=>{"post"=>{"summary"=>"Create Alarm", "description"=>"Create an Alarm", "operationId"=>"create-alarm", "x-api-path-slug"=>"v2alarms-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarms"]}, "get"=>{"summary"=>"Get All Alarms", "description"=>"Get all of the Alarms", "operationId"=>"get-all-alarms", "x-api-path-slug"=>"v2alarms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarms"]}}, "/v2/alarms/:alarmId"=>{"put"=>{"summary"=>"Update Alarm", "description"=>"Updates an alarm", "operationId"=>"update-alarm", "x-api-path-slug"=>"v2alarmsalarmid-put", "parameters"=>[{"in"=>"query", "name"=>"alarmId integer\nThe alarm to update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarms"]}, "get"=>{"summary"=>"Get Alarm by Id", "description"=>"Retrieves a single alarm", "operationId"=>"get-alarm-by-id", "x-api-path-slug"=>"v2alarmsalarmid-get", "parameters"=>[{"in"=>"query", "name"=>"alarmId", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarms"]}, "delete"=>{"summary"=>"Delete Alarm", "description"=>"Deletes an alarm", "operationId"=>"delete-alarm", "x-api-path-slug"=>"v2alarmsalarmid-delete", "parameters"=>[{"in"=>"query", "name"=>"alarmId\nThe alarm to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alarms"]}}, "/v1/batch"=>{"post"=>{"summary"=>"Perform batch", "description"=>"Allows making an arbitrary set of API calls. All calls are made in parallel.\nThe query string parameter ?series can be used to override this behavior and call the API in series stopping at the first error.", "operationId"=>"perform-batch", "x-api-path-slug"=>"v1batch-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch"]}}, "/v1/mobile-devices/:userDeviceId"=>{"delete"=>{"summary"=>"Delete Mobile Device", "description"=>"Deletes a device from a user", "operationId"=>"delete-mobile-device", "x-api-path-slug"=>"v1mobiledevicesuserdeviceid-delete", "parameters"=>[{"in"=>"query", "name"=>"userDeviceId\nThe user device ID to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}}, "/v1/account/mobile-devices/:accountDeviceId"=>{"delete"=>{"summary"=>"Delete Account Mobile Device", "description"=>"Deletes a device from an account", "operationId"=>"delete-account-mobile-device", "x-api-path-slug"=>"v1accountmobiledevicesaccountdeviceid-delete", "parameters"=>[{"in"=>"query", "name"=>"accountDeviceId\nThe account device ID to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/v1/account/mobile-devices"=>{"get"=>{"summary"=>"Get All Account Mobile Devices", "description"=>"Gets all of the devices for an account", "operationId"=>"get-all-account-mobile-devices", "x-api-path-slug"=>"v1accountmobiledevices-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/v1/datasets/*"=>{"get"=>{"summary"=>"List dataset", "description"=>"*", "operationId"=>"list-dataset", "x-api-path-slug"=>"v1datasets-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets"]}}, "/v1/events"=>{"post"=>{"summary"=>"Create event", "description"=>"Creates an event. Every event occurrence is persisted to the database as a RawEvent. Based on the EventFingerprint, a new Event will be created or an existing one will be de-duplicated.", "operationId"=>"create-event", "x-api-path-slug"=>"v1events-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}, "get"=>{"summary"=>"List events", "description"=>"Searches for events in the specified organization.", "operationId"=>"list-events", "x-api-path-slug"=>"v1events-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/v1/events/raw"=>{"get"=>{"summary"=>"List raw events", "description"=>"Queries all event occurrences (raw events) for the specified organization.", "operationId"=>"list-raw-events", "x-api-path-slug"=>"v1eventsraw-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/v1/events/:event_id"=>{"get"=>{"summary"=>"Get event", "description"=>"Returns the event with the specified event id from the database.", "operationId"=>"get-event", "x-api-path-slug"=>"v1eventsevent-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/v1/events/:event_id/raw"=>{"get"=>{"summary"=>"Get raw events", "description"=>"Returns all of the event occurrences (raw events) for the specified event.", "operationId"=>"get-raw-events", "x-api-path-slug"=>"v1eventsevent-idraw-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/v1/hostgroups"=>{"get"=>{"summary"=>"Get All Hostgroups", "description"=>"Get all of the Hostgroups in your account", "operationId"=>"get-all-hostgroups", "x-api-path-slug"=>"v1hostgroups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hostgroups"]}, "post"=>{"summary"=>"Create Hostgroup", "description"=>"Create a Hostgroup", "operationId"=>"create-hostgroup", "x-api-path-slug"=>"v1hostgroups-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hostgroups"]}}, "/v1/hostgroups/search"=>{"get"=>{"summary"=>"Search Hostgroups", "description"=>"Searches the hostgroups in your account", "operationId"=>"search-hostgroups", "x-api-path-slug"=>"v1hostgroupssearch-get", "parameters"=>[{"in"=>"query", "name"=>"name\nThe hostgroup name to search for. Currently supported search parameters:\n\nname - search by the name of the hostgroup", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hostgroups"]}}, "/v1/hostgroups/:hostgroupId"=>{"get"=>{"summary"=>"Get Hostgroup by Id", "description"=>"Retrieves a single hostgroup by its id", "operationId"=>"get-hostgroup-by-id", "x-api-path-slug"=>"v1hostgroupshostgroupid-get", "parameters"=>[{"in"=>"query", "name"=>"hostgroupId\nThe Id of the hostgroup you are requesting", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hostgroups"]}, "put"=>{"summary"=>"Update Hostgroup", "description"=>"Update a Hostgroup", "operationId"=>"update-hostgroup", "x-api-path-slug"=>"v1hostgroupshostgroupid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hostgroups"]}, "delete"=>{"summary"=>"Delete Hostgroup", "description"=>"Delete an hostgroup", "operationId"=>"delete-hostgroup", "x-api-path-slug"=>"v1hostgroupshostgroupid-delete", "parameters"=>[{"in"=>"query", "name"=>"hostgroupId\nThe hostgroup to delete\nforceRemove\nRemove the hostgroup, even if it's being used by a dashboard or alarm", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hostgroups"]}}, "/v1/meter/:meterName/registration"=>{"post"=>{"summary"=>"Registration", "description"=>"Register a Meter with TrueSight Pulse", "operationId"=>"registration", "x-api-path-slug"=>"v1metermeternameregistration-post", "parameters"=>[{"in"=>"formData", "name"=>"meterVersion", "description"=>"What version of the Meter is running, ex", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meters"]}}, "/v1/measurements"=>{"post"=>{"summary"=>"Add measures", "description"=>"Adds measurement readings to the data store.", "operationId"=>"add-measures", "x-api-path-slug"=>"v1measurements-post", "parameters"=>[{"in"=>"formData", "name"=>"source", "description"=>"The source of the metric", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Measurements"]}}, "/v1/metrics"=>{"post"=>{"summary"=>"Create metric", "description"=>"Creates a new metric", "operationId"=>"create-metric", "x-api-path-slug"=>"v1metrics-post", "parameters"=>[{"in"=>"formData", "name"=>"name\nName of the metric, must be globally unique, recommended that you add your own namespace", "description"=>"typeType of metric, could be a device metric, a plugin metric or any arbitrary type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}, "get"=>{"summary"=>"Get Metrics", "description"=>"Retrieves the list of metrics in a project.", "operationId"=>"get-metrics", "x-api-path-slug"=>"v1metrics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}}, "/v1/batch/metrics"=>{"post"=>{"summary"=>"Create metrics batch", "description"=>"Creates metrics, but in a batch", "operationId"=>"create-metrics-batch", "x-api-path-slug"=>"v1batchmetrics-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch"]}, "put"=>{"summary"=>"Update metrics batch", "description"=>"Updates a batch of metrics", "operationId"=>"update-metrics-batch", "x-api-path-slug"=>"v1batchmetrics-put", "parameters"=>[{"in"=>"formData", "name"=>"type\nType of metric, could be a device metric, a plugin metric or any arbitrary type", "description"=>"descriptionDescription of the metric", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch"]}}, "/v1/measurements/:metric"=>{"get"=>{"summary"=>"Get measures", "description"=>"Retrieves measurement readings.", "operationId"=>"get-measures", "x-api-path-slug"=>"v1measurementsmetric-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Measurements"]}}, "/v1/measurementsBatch"=>{"post"=>{"summary"=>"Get measures batch", "description"=>"Same as /v1/measurements/:metric except that an array of query objects are passed in the body.", "operationId"=>"get-measures-batch", "x-api-path-slug"=>"v1measurementsbatch-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Measurements"]}}, "/v1/metrics/:metric"=>{"delete"=>{"summary"=>"Remove metric", "description"=>"Removes a metric from the account.\n Note that a metric will not deleted if it has been alarmed unless that removeAlarms\n flag is added.", "operationId"=>"remove-metric", "x-api-path-slug"=>"v1metricsmetric-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}}, "/v1/metrics/dashactions/:dashboardSetId"=>{"get"=>{"summary"=>"Get actions for a dashboard", "description"=>"Retrieves the needed configuration changes for a dashboard\n Returns an an array of objects, each has the following properties:", "operationId"=>"get-actions-for-a-dashboard", "x-api-path-slug"=>"v1metricsdashactionsdashboardsetid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}, "post"=>{"summary"=>"Perform dashboard actions", "description"=>"Performs necessary actions for a dashboard.\n Only enables or adds metrics at this time.", "operationId"=>"perform-dashboard-actions", "x-api-path-slug"=>"v1metricsdashactionsdashboardsetid-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}}, "/v1/metrics/:metricName"=>{"put"=>{"summary"=>"Update metric", "description"=>"Updates a metric", "operationId"=>"update-metric", "x-api-path-slug"=>"v1metricsmetricname-put", "parameters"=>[{"in"=>"formData", "name"=>"type\nType of metric, could be a device metric, a plugin metric or any arbitrary type", "description"=>"descriptionDescription of the metric", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}}, "/v1/plugins"=>{"get"=>{"summary"=>"Get all plugins", "description"=>"Gets all known plugin definitions", "operationId"=>"get-all-plugins", "x-api-path-slug"=>"v1plugins-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Plugins"]}}, "/v1/plugins/:plugin/components"=>{"get"=>{"summary"=>"Get plugin components", "description"=>"Finds the components associated with an installed plugin including metrics and dashboards", "operationId"=>"get-plugin-components", "x-api-path-slug"=>"v1pluginsplugincomponents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Plugins"]}}, "/v1/plugins/installed"=>{"get"=>{"summary"=>"Get installed plugins", "description"=>"Gets plugins that are installed for the project", "operationId"=>"get-installed-plugins", "x-api-path-slug"=>"v1pluginsinstalled-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Plugins"]}}, "/v1/plugins/installed/:plugin"=>{"put"=>{"summary"=>"Install or update plugin", "description"=>"Installs a plugin", "operationId"=>"install-or-update-plugin", "x-api-path-slug"=>"v1pluginsinstalledplugin-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Plugins"]}, "delete"=>{"summary"=>"Uninstall plugin", "description"=>"Uninstalls a plugin and optionally removes related dashboard(s) and metric(s).", "operationId"=>"uninstall-plugin", "x-api-path-slug"=>"v1pluginsinstalledplugin-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Plugins"]}}, "/v1/plugins/private/:plugin/:org/:repo"=>{"put"=>{"summary"=>"Add private plugin", "description"=>"Adds or updates a private plugin.\nA plugin exists as a repository in Github.\nBy adding a private plugin the plugin will appear on your settings -> plugins tab just like any other plugin which\ncan then be installed and/or added to a relay.\nIf a private plugin has the same name as an existing plugin it will override the existing plugin within your account.", "operationId"=>"add-private-plugin", "x-api-path-slug"=>"v1pluginsprivatepluginorgrepo-put", "parameters"=>[{"in"=>"query", "name"=>"plugin\nName of the plugin\norg\nGithub organization or user owning the plugin\nrepo\nGithub repository name for plugin", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Plugins"]}}, "/v1/plugins/private/:plugin"=>{"delete"=>{"summary"=>"Remove private plugin", "description"=>"Removes a private plugin from your account. Use this function after adding a private plugin to make your private\nplugin disappear from available plugins in your settings.", "operationId"=>"remove-private-plugin", "x-api-path-slug"=>"v1pluginsprivateplugin-delete", "parameters"=>[{"in"=>"query", "name"=>"plugin\nName of plugin to remove", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Plugins"]}}, "/v1/plugins/:plugin"=>{"get"=>{"summary"=>"Get plugin", "description"=>"Gets a single plugin definition", "operationId"=>"get-plugin", "x-api-path-slug"=>"v1pluginsplugin-get", "parameters"=>[{"in"=>"query", "name"=>"plugin\nName of plugin", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Plugins"]}}, "/v1/relays/heartbeat"=>{"post"=>{"summary"=>"Set Relay Heartbeat", "description"=>"Updates the 'lastHeardFrom' field of the relay configuration\nReturns the current system time in UNIX epoch of server.", "operationId"=>"set-relay-heartbeat", "x-api-path-slug"=>"v1relaysheartbeat-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Relays"]}}, "/v1/relays"=>{"get"=>{"summary"=>"Get All Relay Configurations", "description"=>"Gets the configurations for all visible relays", "operationId"=>"get-all-relay-configurations", "x-api-path-slug"=>"v1relays-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Relays"]}}, "/v1/relays/:relay/config"=>{"get"=>{"summary"=>"Get Relay Configuration", "description"=>"Retrieves config for a relay host if changed\nIf no timestamp specified, configuration data is always returned\nIf config has not changed the string 'not-modified' is returned", "operationId"=>"get-relay-configuration", "x-api-path-slug"=>"v1relaysrelayconfig-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Relays"]}, "put"=>{"summary"=>"Set Relay Configuration", "description"=>"Stores configuration for a relay.\n The relay will gather the configuration on the next poll and reconfigure itself as needed.", "operationId"=>"set-relay-configuration", "x-api-path-slug"=>"v1relaysrelayconfig-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Relays"]}}, "/v1/relays/:relay/toggle"=>{"post"=>{"summary"=>"Toggle relay", "description"=>"Set a relay to be disabled or enabled", "operationId"=>"toggle-relay", "x-api-path-slug"=>"v1relaysrelaytoggle-post", "parameters"=>[{"in"=>"formData", "name"=>"disabled", "description"=>"true or false", "type"=>"string"}, {"in"=>"query", "name"=>"relay\nName of relay to toggle", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Relays"]}}, "/v1/relays/:relay/togglePlugin"=>{"post"=>{"summary"=>"Toggle relay plugin", "description"=>"Sets a relay plugin to be disabled or enabled", "operationId"=>"toggle-relay-plugin", "x-api-path-slug"=>"v1relaysrelaytoggleplugin-post", "parameters"=>[{"in"=>"formData", "name"=>"plugin", "description"=>"Name of plugin", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Relays"]}}, "/v1/relays/:relay/output"=>{"post"=>{"summary"=>"Add relay output", "description"=>"Adds output messages to the relay.\nUsed by the relay to communicate output from execution and commands", "operationId"=>"add-relay-output", "x-api-path-slug"=>"v1relaysrelayoutput-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Relays"]}, "delete"=>{"summary"=>"Clear relay output", "description"=>"Wipes the logged output from the relay up to present.", "operationId"=>"clear-relay-output", "x-api-path-slug"=>"v1relaysrelayoutput-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Relays"]}}, "/v1/relays/:relay/output/:since"=>{"get"=>{"summary"=>"Get relay output", "description"=>"Queries for relay output messages.", "operationId"=>"get-relay-output", "x-api-path-slug"=>"v1relaysrelayoutputsince-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Relays"]}}, "/v1/sources/byName"=>{"delete"=>{"summary"=>"Remove Old Sources By Name", "description"=>"Remove Old Sources from your account by using a list of names", "operationId"=>"remove-old-sources-by-name", "x-api-path-slug"=>"v1sourcesbyname-delete", "parameters"=>[{"in"=>"formData", "name"=>"names", "description"=>"An array of source names to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sources"]}}, "/v1/account/sources/:lastModified?"=>{"get"=>{"summary"=>"Get all source information", "description"=>"Gets all source (host + data stream) information", "operationId"=>"get-all-source-information", "x-api-path-slug"=>"v1accountsourceslastmodified-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/v1/account/sources"=>{"put"=>{"summary"=>"Set source metadata", "description"=>"Sets one or more source metadata", "operationId"=>"set-source-metadata", "x-api-path-slug"=>"v1accountsources-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/metrics"=>{"get"=>{"summary"=>"Get list of active metrics", "description"=>"Get the list of actively reporting metrics from a given time until now. This endpoint is not available in the Python and Ruby libraries.", "operationId"=>"get-list-of-active-metrics", "x-api-path-slug"=>"metrics-get", "parameters"=>[{"in"=>"query", "name"=>"[[POSIX_timestamp, numeric_value], ...]", "description"=>"Note that the timestamp should be in seconds, must be current, and the numeric value is a 32bit float gauge-type value", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/api/v1/events"=>{"post"=>{"summary"=>"Post an Event", "description"=>"This end point allows you to post events to the stream. You can tag them, set priority and event aggregate them with other events.", "operationId"=>"post-an-event", "x-api-path-slug"=>"apiv1events-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "\n /api/{version}/actions"=>{"\n get"=>{"summary"=>"Get Actions (Alerts) List", "description"=>"Returns a list of actions (alerts) that have been generated for your account.", "operationId"=>"get-actions-alerts-list", "x-api-path-slug"=>"apiversionactions-get", "parameters"=>[{"in"=>"query", "name"=>"checkids", "description"=>"Comma-separated list of check identifiers", "type"=>" | string | "}, {"in"=>"query", "name"=>"contactids", "description"=>"Comma-separated list of contact identifiers", "type"=>"string | "}, {"in"=>"query", "name"=>"from", "description"=>"Only include actions generated later than this timestamp", "type"=>"integer | "}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of returned results to the specified quantity", "type"=>"integer (max 300) | "}, {"in"=>"query", "name"=>"offset", "description"=>"Offset for listing", "type"=>"integer | "}, {"in"=>"query", "name"=>"status", "description"=>"Comma-separated list of statuses", "type"=>"string (sent, delivered, error, not_deliv"}, {"in"=>"query", "name"=>"to", "description"=>"Only include actions generated prior to this timestamp", "type"=>" | integer | "}, {"in"=>"query", "name"=>"via", "description"=>"Comma-separated list of via mediums", "type"=>"string (email, sms, twitter, iphone, andr"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions"]}}, "/metrics/definitions"=>{""=>{"summary"=>"Available metrics", "description"=>"Determine which metrics are available to return historical data for, for a specific subject (device or service) over a specific time range.", "operationId"=>"available-metrics", "x-api-path-slug"=>"metricsdefinitions-", "parameters"=>[{"in"=>"query", "name"=>"end", "description"=>"The UTC date string for the end time range in format YYYY-MM-DDTHH:mm:SSZ e", "type"=>"string"}, {"in"=>"query", "name"=>"start", "description"=>"The UTC date string for the start time range in format YYYY-MM-DDTHH:mm:SSZ e", "type"=>"string"}, {"in"=>"query", "name"=>"subjectId", "description"=>"The ID of the subject to get the definitions for, e", "type"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}}, "/metrics/dynamicgraphs/"=>{""=>{"summary"=>"Dynamic metrics", "description"=>"Return historical metrics data, for a devices and/or services that match a search or regex style inventory filter search over a specific time range.", "operationId"=>"dynamic-metrics", "x-api-path-slug"=>"metricsdynamicgraphs-", "parameters"=>[{"in"=>"query", "name"=>"end", "description"=>"The UTC date string for the end time range in format YYYY-MM-DDTHH:mm:SSZ e", "type"=>"string"}, {"in"=>"query", "name"=>"ids", "description"=>"List of inventory IDs", "type"=>"string"}, {"in"=>"query", "name"=>"inventoryFilter", "description"=>"A regular expression that will return all devices or services that match the pattern", "type"=>"string"}, {"in"=>"query", "name"=>"names", "description"=>"Human-readable names of a device or service", "type"=>"string"}, {"in"=>"query", "name"=>"start", "description"=>"The UTC date string for the start time range in format YYYY-MM-DDTHH:mm:SSZ e", "type"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"Specify whether to return only devices, services or all", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}}, "/actions"=>{"post"=>{"summary"=>"Create Action", "description"=>"Create a new Action.", "operationId"=>"create-action", "x-api-path-slug"=>"actions-post", "parameters"=>[{"in"=>"path", "name"=>"action_name\n \n \n required\n Display name for the Action.\n \n \n \n \n action_url\n \n \n required\n URL to be invoked for action execution."}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions"]}, "get"=>{"summary"=>"List Actions", "description"=>"List of all Actions.", "operationId"=>"list-actions", "x-api-path-slug"=>"actions-get", "parameters"=>[{"in"=>"path", "name"=>"maintenance_id\n \n \n string\n Unique ID generated by the server. This can be used as an identifier.\n \n \n \n \n display_name\n \n \n string\n Displa"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions"]}}, "/actions/{action_id}"=>{"put"=>{"summary"=>"Update Action", "description"=>"Update an existing Action.", "operationId"=>"update-action", "x-api-path-slug"=>"actionsaction-id-put", "parameters"=>[{"in"=>"path", "name"=>"action_name\n \n \n required\n Display name for the Action.\n \n \n \n \n action_url\n \n \n required\n URL to be invoked for action execution."}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions"]}}}}, "apis"=>{"name"=>"BMC Software", "x-slug"=>"bmc-software", "description"=>"Transform your digital enterprise with BMC IT solutions. From mainframe to cloud to mobile, we???ll help you drive innovation and industrial efficiency.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/713-bmc-software.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"27308", "tags"=>"API Provider,API Service Provider,Applications,Devops,Enterprise,ISP,Monitoring,Profiles,SaaS,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bmc-software/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"BMC Software API", "x-api-slug"=>"bmc-software-api", "description"=>"Transform your digital enterprise with BMC IT solutions. From mainframe to cloud to mobile, we???ll help you drive innovation and industrial efficiency.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/713-bmc-software.jpg", "humanURL"=>"http://www.bmc.com", "baseURL"=>"https:///", "tags"=>"API Provider,API Service Provider,Applications,Devops,Enterprise,ISP,Monitoring,Profiles,SaaS,Service API,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bmc-software/actions-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bmc-software/bmc-software-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://www.bmc.com/blogs"}, {"type"=>"x-blog-rss", "url"=>"http://feeds.feedburner.com/BmcBlogs"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/bmc"}, {"type"=>"x-documentation", "url"=>"https://docs.bmc.com/docs/dashboard.action"}, {"type"=>"x-email", "url"=>"customer_support@bmc.com"}, {"type"=>"x-email", "url"=>"NA_Accounts_Payable@bmc.com"}, {"type"=>"x-email", "url"=>"Collections_NA@bmc.com"}, {"type"=>"x-email", "url"=>"education@bmc.com"}, {"type"=>"x-email", "url"=>"investor@bmc.com"}, {"type"=>"x-email", "url"=>"global_security@bmc.com"}, {"type"=>"x-email", "url"=>"Compliance_EthicsOffice@bmc.com"}, {"type"=>"x-email", "url"=>"26Ethics@bmc.com"}, {"type"=>"x-email", "url"=>"Community_Relations@bmc.com"}, {"type"=>"x-github", "url"=>"https://github.com/bmcsoftware"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/bmcsoftware"}, {"type"=>"x-website", "url"=>"http://www.bmc.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
payjunction{"payjunction-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"PayJunction", "x-complete"=>1, "info"=>{"title"=>"PayJunction API Basic", "description"=>"todo-add-description", "version"=>"1.0.0"}, "host"=>"example.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/customers"=>{"get"=>{"summary"=>"Get Customers", "description"=>"Gets a list of 15 customers", "operationId"=>"CustomersGet", "x-api-path-slug"=>"customers-get", "parameters"=>[{"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}}, "/customers/{customerId}"=>{"get"=>{"summary"=>"Get Customers", "description"=>"/customers/{customerid}.", "operationId"=>"CustomersByCustomerIdGet", "x-api-path-slug"=>"customerscustomerid-get", "parameters"=>[{"in"=>"path", "name"=>"customerId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}, "put"=>{"summary"=>"Put Customers", "description"=>"/customers/{customerid}.", "operationId"=>"CustomersByCustomerIdPut", "x-api-path-slug"=>"customerscustomerid-put", "parameters"=>[{"in"=>"formData", "name"=>"companyName"}, {"in"=>"formData", "name"=>"custom1"}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"formData", "name"=>"defaultAddressId"}, {"in"=>"formData", "name"=>"email"}, {"in"=>"formData", "name"=>"firstName"}, {"in"=>"formData", "name"=>"identifier"}, {"in"=>"formData", "name"=>"jobTitle"}, {"in"=>"formData", "name"=>"lastName"}, {"in"=>"formData", "name"=>"middleName"}, {"in"=>"formData", "name"=>"phone"}, {"in"=>"formData", "name"=>"phone2"}, {"in"=>"formData", "name"=>"website"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}, "delete"=>{"summary"=>"Delete Customers", "description"=>"/customers/{customerid}.", "operationId"=>"CustomersByCustomerIdDelete", "x-api-path-slug"=>"customerscustomerid-delete", "parameters"=>[{"in"=>"path", "name"=>"customerId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}}, "/customers/"=>{"post"=>{"summary"=>"Post Customers", "description"=>"Add a new customer", "operationId"=>"CustomersPost", "x-api-path-slug"=>"customers-post", "parameters"=>[{"in"=>"formData", "name"=>"companyName", "description"=>"Text, Max Length 64"}, {"in"=>"formData", "name"=>"custom1", "description"=>"Text, Max Length 32"}, {"in"=>"formData", "name"=>"email", "description"=>"Email (1), Max Length 128"}, {"in"=>"formData", "name"=>"firstName", "description"=>"Text, Max Length 16"}, {"in"=>"formData", "name"=>"identifier", "description"=>"Text, Max Length 64"}, {"in"=>"formData", "name"=>"jobTitle", "description"=>"Text, Max Length 32"}, {"in"=>"formData", "name"=>"lastName", "description"=>"Text, Max Length 32"}, {"in"=>"formData", "name"=>"middleName", "description"=>"Text, Max Length 32"}, {"in"=>"formData", "name"=>"phone", "description"=>"Phone Number, Max Length 24, Must contain at least 10 digits"}, {"in"=>"formData", "name"=>"phone2", "description"=>"Phone Number, Max Length 24, Must contain at least 10 digits"}, {"in"=>"formData", "name"=>"website", "description"=>"Text, Max Length 128"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}}, "/customers/{customerId}/notes"=>{"get"=>{"summary"=>"Get Customers Notes", "description"=>"/customers/{customerid}/notes.", "operationId"=>"CustomersNotesByCustomerIdGet", "x-api-path-slug"=>"customerscustomeridnotes-get", "parameters"=>[{"in"=>"path", "name"=>"customerId"}, {"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Notes"]}, "post"=>{"summary"=>"Post Customers Notes", "description"=>"/customers/{customerid}/notes.", "operationId"=>"CustomersNotesByCustomerIdPost", "x-api-path-slug"=>"customerscustomeridnotes-post", "parameters"=>[{"in"=>"path", "name"=>"customerId"}, {"in"=>"formData", "name"=>"note", "description"=>"Max Length 2048"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Notes"]}}, "/customers/{customerId}/notes/{noteId}"=>{"get"=>{"summary"=>"Get Customers Notes", "description"=>"/customers/{customerid}/notes/{noteid}.", "operationId"=>"CustomersNotesByCustomerIdAndNoteIdGet", "x-api-path-slug"=>"customerscustomeridnotesnoteid-get", "parameters"=>[{"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"noteId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Notes"]}, "put"=>{"summary"=>"Put Customers Notes", "description"=>"/customers/{customerid}/notes/{noteid}.", "operationId"=>"CustomersNotesByCustomerIdAndNoteIdPut", "x-api-path-slug"=>"customerscustomeridnotesnoteid-put", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"formData", "name"=>"note", "description"=>"Max Length 2048"}, {"in"=>"path", "name"=>"noteId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Notes"]}, "delete"=>{"summary"=>"Delete Customers Notes", "description"=>"/customers/{customerid}/notes/{noteid}.", "operationId"=>"CustomersNotesByCustomerIdAndNoteIdDelete", "x-api-path-slug"=>"customerscustomeridnotesnoteid-delete", "parameters"=>[{"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"noteId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Notes"]}}, "/customers/{customerId}/vaults/"=>{"get"=>{"summary"=>"Get Customers Vaults", "description"=>"Retrieve customer's payment vaults", "operationId"=>"CustomersVaultsByCustomerIdGet", "x-api-path-slug"=>"customerscustomeridvaults-get", "parameters"=>[{"in"=>"path", "name"=>"customerId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Vaults"]}}, "/customers/{customerId}/vaults/{vaultId}"=>{"get"=>{"summary"=>"Get Customers Vaults", "description"=>"/customers/{customerid}/vaults/{vaultid}.", "operationId"=>"CustomersVaultsByCustomerIdAndVaultIdGet", "x-api-path-slug"=>"customerscustomeridvaultsvaultid-get", "parameters"=>[{"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"vaultId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Vaults"]}, "delete"=>{"summary"=>"Delete Customers Vaults", "description"=>"/customers/{customerid}/vaults/{vaultid}.", "operationId"=>"CustomersVaultsByCustomerIdAndVaultIdDelete", "x-api-path-slug"=>"customerscustomeridvaultsvaultid-delete", "parameters"=>[{"in"=>"path", "name"=>"customerId"}, {"in"=>"path", "name"=>"vaultId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Vaults"]}}, "/customers/{customerId}/vaults"=>{"post"=>{"summary"=>"Post Customers Vaults", "description"=>"/customers/{customerid}/vaults (card).", "operationId"=>"CustomersVaultsByCustomerIdPost2", "x-api-path-slug"=>"customerscustomeridvaults-post", "parameters"=>[{"in"=>"formData", "name"=>"address"}, {"in"=>"formData", "name"=>"addressId"}, {"in"=>"formData", "name"=>"cardExpMonth", "description"=>"1-12"}, {"in"=>"formData", "name"=>"cardExpYear", "description"=>"YYYY, YY"}, {"in"=>"formData", "name"=>"cardNumber", "description"=>"5105105105105100,5105-1051-0510-5100,5105 1051 0510 5100"}, {"in"=>"formData", "name"=>"city"}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"formData", "name"=>"state"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}, {"in"=>"formData", "name"=>"zip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Vaults"]}}, "/customers/{customerId}/vaults/{achVault}"=>{"put"=>{"summary"=>"Put Customers Vaults ACH Vault", "description"=>"/customers/{customerid}/vaults/{vaultid} (ach).", "operationId"=>"CustomersVaultsByCustomerIdAndAchVaultPut", "x-api-path-slug"=>"customerscustomeridvaultsachvault-put", "parameters"=>[{"in"=>"formData", "name"=>"achAccountType", "description"=>"CHECKING, SAVINGS"}, {"in"=>"formData", "name"=>"achType", "description"=>"CCD, PPD, TEL, WEB"}, {"in"=>"path", "name"=>"achVault"}, {"in"=>"formData", "name"=>"address"}, {"in"=>"formData", "name"=>"addressId"}, {"in"=>"formData", "name"=>"city"}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"formData", "name"=>"state"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}, {"in"=>"formData", "name"=>"zip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Vaults", "ACH", "Vault"]}}, "/customers/{customerId}/vaults/{cardVault}"=>{"put"=>{"summary"=>"Put Customers Vaults Card Vault", "description"=>"/customers/{customerid}/vaults/{vaultid} (card).", "operationId"=>"CustomersVaultsByCustomerIdAndCardVaultPut", "x-api-path-slug"=>"customerscustomeridvaultscardvault-put", "parameters"=>[{"in"=>"formData", "name"=>"address"}, {"in"=>"formData", "name"=>"addressId"}, {"in"=>"formData", "name"=>"cardExpMonth", "description"=>"1-12"}, {"in"=>"formData", "name"=>"cardExpYear", "description"=>"YYYY, YY"}, {"in"=>"path", "name"=>"cardVault"}, {"in"=>"formData", "name"=>"city"}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"formData", "name"=>"state"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}, {"in"=>"formData", "name"=>"zip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Vaults", "Card", "Vault"]}}, "/customers/{customerId}/addresses"=>{"get"=>{"summary"=>"Get Customers Addresses", "description"=>"Gets a list of a customer's addresses.", "operationId"=>"CustomersAddressesByCustomerIdGet", "x-api-path-slug"=>"customerscustomeridaddresses-get", "parameters"=>[{"in"=>"path", "name"=>"customerId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Resses"]}, "post"=>{"summary"=>"Post Customers Addresses", "description"=>"/customers/{customerid}/addresses/.", "operationId"=>"CustomersAddressesByCustomerIdPost", "x-api-path-slug"=>"customerscustomeridaddresses-post", "parameters"=>[{"in"=>"formData", "name"=>"address", "description"=>"Text, Max Length 128"}, {"in"=>"formData", "name"=>"city", "description"=>"Text, Max Length 32"}, {"in"=>"formData", "name"=>"country", "description"=>"Text, Max Length 32"}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"formData", "name"=>"state", "description"=>"Text, Max Length 32"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}, {"in"=>"formData", "name"=>"zip", "description"=>"Text, Max Length 16"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Resses"]}}, "/customers/{customerId}/addresses/{addressId}"=>{"get"=>{"summary"=>"Get Customers Addresses", "description"=>"/customers/{customerid}/addresses/{addressid}.", "operationId"=>"CustomersAddressesByCustomerIdAndAddressIdGet", "x-api-path-slug"=>"customerscustomeridaddressesaddressid-get", "parameters"=>[{"in"=>"path", "name"=>"addressId"}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Resses"]}, "put"=>{"summary"=>"Put Customers Addresses", "description"=>"/customers/{customerid}/addresses/{addressid}.", "operationId"=>"CustomersAddressesByCustomerIdAndAddressIdPut", "x-api-path-slug"=>"customerscustomeridaddressesaddressid-put", "parameters"=>[{"in"=>"formData", "name"=>"address"}, {"in"=>"path", "name"=>"addressId"}, {"in"=>"formData", "name"=>"city"}, {"in"=>"formData", "name"=>"country"}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"formData", "name"=>"state"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}, {"in"=>"formData", "name"=>"zip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Resses"]}, "delete"=>{"summary"=>"Delete Customers Addresses", "description"=>"/customers/{customerid}/addresses/{addressid}.", "operationId"=>"CustomersAddressesByCustomerIdAndAddressIdDelete", "x-api-path-slug"=>"customerscustomeridaddressesaddressid-delete", "parameters"=>[{"in"=>"path", "name"=>"addressId"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"customerId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Resses"]}}, "/transactions"=>{"post"=>{"summary"=>"Post Transactions", "description"=>"/transactions/ (swiped cc).", "operationId"=>"TransactionsPost6", "x-api-path-slug"=>"transactions-post", "parameters"=>[{"in"=>"formData", "name"=>"action"}, {"in"=>"formData", "name"=>"amountBase"}, {"in"=>"formData", "name"=>"billingCompanyName"}, {"in"=>"formData", "name"=>"billingFirstName"}, {"in"=>"formData", "name"=>"billingLastName"}, {"in"=>"formData", "name"=>"cardTrack"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions"]}}, "/transactions/"=>{"get"=>{"summary"=>"Get Transactions", "description"=>"Not Available At Time at Time of Publishing this collection: Get a list of transactions", "operationId"=>"TransactionsGet", "x-api-path-slug"=>"transactions-get", "parameters"=>[{"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions"]}}, "/transactions/{transactionId}"=>{"get"=>{"summary"=>"Get Transactions", "description"=>"/transactions/{transactionid}.", "operationId"=>"TransactionsByTransactionIdGet", "x-api-path-slug"=>"transactionstransactionid-get", "parameters"=>[{"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions"]}, "put"=>{"summary"=>"Put Transactions", "description"=>"Update an unsettled transaction", "operationId"=>"TransactionsByTransactionIdPut", "x-api-path-slug"=>"transactionstransactionid-put", "parameters"=>[{"in"=>"formData", "name"=>"amountBase"}, {"in"=>"formData", "name"=>"amountReject"}, {"in"=>"formData", "name"=>"amountShipping"}, {"in"=>"formData", "name"=>"amountTax"}, {"in"=>"formData", "name"=>"amountTip"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"formData", "name"=>"status"}, {"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions"]}}, "/transactions/{transactionId}/notes"=>{"get"=>{"summary"=>"Get Transactions Notes", "description"=>"Get a list of notes for a transaction", "operationId"=>"TransactionsNotesByTransactionIdGet", "x-api-path-slug"=>"transactionstransactionidnotes-get", "parameters"=>[{"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Notes"]}, "post"=>{"summary"=>"Post Transactions Notes", "description"=>"/transactions/{transactionid}/notes/.", "operationId"=>"TransactionsNotesByTransactionIdPost", "x-api-path-slug"=>"transactionstransactionidnotes-post", "parameters"=>[{"in"=>"formData", "name"=>"note"}, {"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Notes"]}}, "/transactions/{transactionId}/notes/{noteId}"=>{"get"=>{"summary"=>"Get Transactions Notes", "description"=>"/transactions/{transactionid}/notes/{noteid}.", "operationId"=>"TransactionsNotesByTransactionIdAndNoteIdGet", "x-api-path-slug"=>"transactionstransactionidnotesnoteid-get", "parameters"=>[{"in"=>"path", "name"=>"noteId"}, {"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Notes"]}, "put"=>{"summary"=>"Put Transactions Notes", "description"=>"/transactions/{transactionid}/notes/{noteid}.", "operationId"=>"TransactionsNotesByTransactionIdAndNoteIdPut", "x-api-path-slug"=>"transactionstransactionidnotesnoteid-put", "parameters"=>[{"in"=>"formData", "name"=>"note"}, {"in"=>"path", "name"=>"noteId"}, {"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Notes"]}, "delete"=>{"summary"=>"Delete Transactions Notes", "description"=>"/transactions/{transactionid}/notes/{noteid}.", "operationId"=>"TransactionsNotesByTransactionIdAndNoteIdDelete", "x-api-path-slug"=>"transactionstransactionidnotesnoteid-delete", "parameters"=>[{"in"=>"path", "name"=>"noteId"}, {"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Notes"]}}, "/transactions/{transactionId}/signature/capture"=>{"post"=>{"summary"=>"Post Transactions Signature Capture", "description"=>"Capture a signature using the scriptel signature capture", "operationId"=>"TransactionsSignatureCaptureByTransactionIdPost", "x-api-path-slug"=>"transactionstransactionidsignaturecapture-post", "parameters"=>[{"in"=>"formData", "name"=>"signature"}, {"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Signature", "Capture"]}}, "/transactions/{transactionId}/receipts/latest/email"=>{"post"=>{"summary"=>"Post Transactions Receipts Latest Email", "description"=>"/transactions/{transactionid}/receipts/latest/email.", "operationId"=>"TransactionsReceiptsLatestEmailByTransactionIdPost", "x-api-path-slug"=>"transactionstransactionidreceiptslatestemail-post", "parameters"=>[{"in"=>"formData", "name"=>"replyTo"}, {"in"=>"formData", "name"=>"requestSignature"}, {"in"=>"formData", "name"=>"to"}, {"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Receipts", "Latest", "Email"]}}, "/transactions/{transactionId}/receipts"=>{"get"=>{"summary"=>"Get Transactions Receipts", "description"=>"Get all of the signed receipts for a transaction.", "operationId"=>"TransactionsReceiptsByTransactionIdGet", "x-api-path-slug"=>"transactionstransactionidreceipts-get", "parameters"=>[{"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Receipts"]}}, "/transactions/{transactionId}/receipts/latest"=>{"get"=>{"summary"=>"Get Transactions Receipts Latest", "description"=>"Retrieve the most recent version of the receipt.", "operationId"=>"TransactionsReceiptsLatestByTransactionIdGet", "x-api-path-slug"=>"transactionstransactionidreceiptslatest-get", "parameters"=>[{"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Receipts", "Latest"]}}, "/transactions/{transactionId}/receipts/latest/thermal"=>{"get"=>{"summary"=>"Get Transactions Receipts Latest Thermal", "description"=>"Get the most recent version of the thermal receipt HTML Document", "operationId"=>"TransactionsReceiptsLatestThermalByTransactionIdGet", "x-api-path-slug"=>"transactionstransactionidreceiptslatestthermal-get", "parameters"=>[{"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Receipts", "Latest", "Thermal"]}}, "/transactions/{transactionId}/receipts/latest/fullpage"=>{"get"=>{"summary"=>"Get Transactions Receipts Latest Fullpage", "description"=>"Get the most recent version of the full page (8.5x11) receipt HTML document", "operationId"=>"TransactionsReceiptsLatestFullpageByTransactionIdGet", "x-api-path-slug"=>"transactionstransactionidreceiptslatestfullpage-get", "parameters"=>[{"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Receipts", "Latest", "Fullpage"]}}, "/transactions/{transactionId}/receipts/unsigned"=>{"get"=>{"summary"=>"Get Transactions Receipts Unsigned", "description"=>"/transactions/{transactionid}/receipts/unsigned.", "operationId"=>"TransactionsReceiptsUnsignedByTransactionIdGet", "x-api-path-slug"=>"transactionstransactionidreceiptsunsigned-get", "parameters"=>[{"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Receipts", "Unsigned"]}}, "/transactions/{transactionId}/receipts/unsigned/thermal"=>{"get"=>{"summary"=>"Get Transactions Receipts Unsigned Thermal", "description"=>"/transactions/{transactionid}/receipts/unsigned/thermal.", "operationId"=>"TransactionsReceiptsUnsignedThermalByTransactionIdGet", "x-api-path-slug"=>"transactionstransactionidreceiptsunsignedthermal-get", "parameters"=>[{"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Receipts", "Unsigned", "Thermal"]}}, "/transactions/{transactionId}/receipts/unsigned/fullpage"=>{"get"=>{"summary"=>"Get Transactions Receipts Unsigned Fullpage", "description"=>"/transactions/{transactionid}/receipts/unsigned/fullpage.", "operationId"=>"TransactionsReceiptsUnsignedFullpageByTransactionIdGet", "x-api-path-slug"=>"transactionstransactionidreceiptsunsignedfullpage-get", "parameters"=>[{"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Receipts", "Unsigned", "Fullpage"]}}, "/transactions/{transactionId}/receipt/{receiptId}"=>{"get"=>{"summary"=>"Get Transactions Receipt Receiptid", "description"=>"/transactions/{transactionid}/receipts/{receiptid}.", "operationId"=>"TransactionsReceiptByTransactionIdAndReceiptIdGet", "x-api-path-slug"=>"transactionstransactionidreceiptreceiptid-get", "parameters"=>[{"in"=>"path", "name"=>"receiptId"}, {"in"=>"path", "name"=>"transactionId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions", "Receipt", "Receiptid"]}}, "/webhooks"=>{"get"=>{"summary"=>"Get Webhooks", "description"=>"Gets a list of webhooks", "operationId"=>"WebhooksGet", "x-api-path-slug"=>"webhooks-get", "parameters"=>[{"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}, "post"=>{"summary"=>"Post Webhooks", "description"=>"/webhooks/{webhooks}.", "operationId"=>"WebhooksPost", "x-api-path-slug"=>"webhooks-post", "parameters"=>[{"in"=>"query", "name"=>"event"}, {"in"=>"formData", "name"=>"secret", "description"=>"Text, max length 255"}, {"in"=>"formData", "name"=>"url", "description"=>"Text, URL with max length 255"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}}, "/webhooks/{webhookId}"=>{"put"=>{"summary"=>"Put Webhooks", "description"=>"/webhooks/{webhookid}.", "operationId"=>"WebhooksByWebhookIdPut", "x-api-path-slug"=>"webhookswebhookid-put", "parameters"=>[{"in"=>"formData", "name"=>"secret", "description"=>"Text, max length 255"}, {"in"=>"formData", "name"=>"url", "description"=>"Text, URL with max length 255"}, {"in"=>"path", "name"=>"webhookId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}, "delete"=>{"summary"=>"Delete Webhooks", "description"=>"/webhooks/{webhookid}.", "operationId"=>"WebhooksByWebhookIdDelete", "x-api-path-slug"=>"webhookswebhookid-delete", "parameters"=>[{"in"=>"path", "name"=>"webhookId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}}, "/terminals"=>{"get"=>{"summary"=>"Get Terminals", "description"=>"Get a list of Terminal Id's for an account.", "operationId"=>"TerminalsGet", "x-api-path-slug"=>"terminals-get", "parameters"=>[{"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Terminals"]}}, "/smartterminals/{smartTerminaIId}/request-payment"=>{"post"=>{"summary"=>"Post Smart Trminals Request Payment", "description"=>"/smartterminals/{smartterminald}/request-payment.", "operationId"=>"SmartterminalsRequestPaymentBySmartTerminaIIdPost", "x-api-path-slug"=>"smartterminalssmartterminaiidrequestpayment-post", "parameters"=>[{"in"=>"query", "name"=>"amountBase"}, {"in"=>"formData", "name"=>"invoiceNumber", "description"=>"NumericAn invoice number to include in the transaction details"}, {"in"=>"formData", "name"=>"showReceiptPrompt", "description"=>"true | falsetrue - Displays the receipt prompt"}, {"in"=>"path", "name"=>"smartTerminaIId"}, {"in"=>"query", "name"=>"terminalId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Smart", "Trminals", "Request", "Payment"]}}, "/smartterminals/{smartTerminaIId}/main"=>{"post"=>{"summary"=>"Post Smart Terminals Main", "description"=>"Returns the Smart Terminal to the main \"Smart Terminal by PayJunction\" screen to await a new transaction request. \n\nFor instance, this request can be used when a user decides to cancel a Smart Terminal payment request. When this request is sent, the Smart Terminal will return to the main screen that reads \"Smart Terminal by PayJunction\", preventing the customer from making a payment.\n\nNote: If the customer has already inserted the chip card, or swiped the card, then the transaction is already processed and it is too late to cancel the payment request. In this case, the transaction should be voided instead.", "operationId"=>"SmartterminalsMainBySmartTerminaIIdPost", "x-api-path-slug"=>"smartterminalssmartterminaiidmain-post", "parameters"=>[{"in"=>"path", "name"=>"smartTerminaIId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Smart", "Terminals", "Main"]}}, "/smartterminals"=>{"get"=>{"summary"=>"Get Smart Terminals", "description"=>"Get a list of Smart Terminals for an account", "operationId"=>"SmartterminalsGet", "x-api-path-slug"=>"smartterminals-get", "parameters"=>[{"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Smart", "Terminals"]}}, "/smartterminals/requests/{requestPaymentId}"=>{"get"=>{"summary"=>"Get Smart Terminals Requests", "description"=>"Gets the status of a Smart Terminal payment request by querying the requestPaymentId returned by POST /smartterminals/{smartterminalId}/request-payment\n\nThe status of a payment request can be queried up to 1 day after the Smart Terminal payment request has been completed. After this cut off the requestPaymentId is purged and will return a 404 Not Found when queried. \n\nIn order to discourage busy polling, requests to this endpoint are rate limited to 1 request every 2 seconds per request.", "operationId"=>"SmartterminalsRequestsByRequestPaymentIdGet", "x-api-path-slug"=>"smartterminalsrequestsrequestpaymentid-get", "parameters"=>[{"in"=>"path", "name"=>"requestPaymentId"}, {"in"=>"header", "name"=>"X-PJ-Application-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Smart", "Terminals", "Requests"]}}}}, "apis"=>{"name"=>"PayJunction", "x-slug"=>"payjunction", "description"=>"PayJunction is a Level 1 PCI Compliant Service Provider that services thousands of businesses in every state in the United States. Since 2000, PayJunction has rapidly become a leading developer and provider of cutting edge merchant technology. PayJunction has also formed strategic alliances with leading financial institutions and technology partners to deliver the most comprehensive services in the industry.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/payjunction-logo.png", "x-kinRank"=>"9", "x-alexaRank"=>"147448", "tags"=>"Commerce,Credit,Payments,Payments,Pos,Relative Data,Retail,Service API,Syndication,Target", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"payjunction/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"PayJunction", "x-api-slug"=>"payjunction", "description"=>"PayJunction is a Level 1 PCI Compliant Service Provider that services thousands of businesses in every state in the United States. Since 2000, PayJunction has rapidly become a leading developer and provider of cutting edge merchant technology. PayJunction has also formed strategic alliances with leading financial institutions and technology partners to deliver the most comprehensive services in the industry.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/payjunction-logo.png", "humanURL"=>"http://payjunction.com/", "baseURL"=>"https://example.com//", "tags"=>"Commerce,Credit,Payments,Payments,Pos,Relative Data,Retail,Service API,Syndication,Target", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/payjunction/smartterminalsrequestsrequestpaymentid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/payjunction/payjunction-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-postman-collection", "url"=>"https://developer.payjunction.com/hc/article_attachments/360005001354/PayJunction%20API%20Basic.postman_collection.json"}, {"type"=>"x-base", "url"=>"https://api.payjunction.com"}, {"type"=>"x-blog", "url"=>"http://www.pathable.com/category/blog/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.pathable.com/feeds/posts/default?alt=rss"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/payjunction"}, {"type"=>"x-developer", "url"=>"http://developer.payjunction.com/"}, {"type"=>"x-github", "url"=>"https://github.com/PayJunction"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/PayJunction"}, {"type"=>"x-website", "url"=>"http://payjunction.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
uk-national-archives{"getty-images-search-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"UK National Archives", "x-complete"=>1, "info"=>{"title"=>"Getty Images", "description"=>"build-applications-using-the-worlds-most-powerful-imagery", "version"=>"3.0"}, "host"=>"api.gettyimages.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v3/asset-changes/change-sets"=>{"put"=>{"summary"=>"Put Asset Changes Change Sets", "description"=>"Generates asset changes..", "operationId"=>"putV3AssetChangesChangeSets", "x-api-path-slug"=>"v3assetchangeschangesets-put", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Accept-Language parameter optional"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Authorization token required"}, {"in"=>"query", "name"=>"batch_size", "description"=>"Specifies the number of assets to return"}, {"in"=>"query", "name"=>"channel_id", "description"=>"Specifies the id of the channel for the asset data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Changes", "Change", "Sets"]}}, "/v3/asset-changes/change-sets/{change-set-id}"=>{"delete"=>{"summary"=>"Delete Asset Changes Change Sets Change Set", "description"=>"Confirm asset changes acknowledges receipt of asset changes..", "operationId"=>"deleteV3AssetChangesChangeSetsChangeSet", "x-api-path-slug"=>"v3assetchangeschangesetschangesetid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Accept-Language parameter optional"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Authorization token required"}, {"in"=>"path", "name"=>"change-set-id", "description"=>"Specify the change-set-id associated with a transaction resource whose receipt you want to confirm"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Changes", "Change", "Sets", "Change", "Set"]}}, "/v3/asset-changes/channels"=>{"get"=>{"summary"=>"Get Asset Changes Channels", "description"=>"Retrieves the channel data for the partner. this data can be used to populate the channel_id parameter in the put asset changes query..", "operationId"=>"getV3AssetChangesChannels", "x-api-path-slug"=>"v3assetchangeschannels-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Accept-Language parameter optional"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Authorization token required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Changes", "Channels"]}}, "/v3/asset-registrations"=>{"post"=>{"summary"=>"Post Asset Registrations", "description"=>"Register a list of customer assets..", "operationId"=>"postV3AssetRegistrations", "x-api-path-slug"=>"v3assetregistrations-post", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Accept-Language parameter optional"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Authorization token required"}, {"in"=>"body", "name"=>"request", "description"=>"Specify JSON containing an array of asset ids to register", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Registrations"]}}, "/v3/boards"=>{"get"=>{"summary"=>"Get Boards", "description"=>"***beta*** get all boards that the user participates in.", "operationId"=>"getV3Boards", "x-api-path-slug"=>"v3boards-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"board_relationship", "description"=>"Search for boards the user owns or has been invited to as an editor"}, {"in"=>"query", "name"=>"page", "description"=>"Request results starting at a page number (default is 1)"}, {"in"=>"query", "name"=>"page_size", "description"=>"Request number of boards to return in each page"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Sort the list of boards by last update date or name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards"]}, "post"=>{"summary"=>"Post Boards", "description"=>"***beta*** create a new board.", "operationId"=>"postV3Boards", "x-api-path-slug"=>"v3boards-post", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"body", "name"=>"new_board", "description"=>"Specify a name and description of the board to create (name is required)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards"]}}, "/v3/boards/{board_id}"=>{"delete"=>{"summary"=>"Delete Boards Board", "description"=>"***beta*** delete a board.", "operationId"=>"deleteV3BoardsBoard", "x-api-path-slug"=>"v3boardsboard-id-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id", "description"=>"Specify the board to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Board"]}, "get"=>{"summary"=>"Get Boards Board", "description"=>"***beta*** get assets and metadata for a specific board.", "operationId"=>"getV3BoardsBoard", "x-api-path-slug"=>"v3boardsboard-id-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id", "description"=>"Retrieve details for a specific board"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Board"]}, "put"=>{"summary"=>"Put Boards Board", "description"=>"***beta*** update a board.", "operationId"=>"putV3BoardsBoard", "x-api-path-slug"=>"v3boardsboard-id-put", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id", "description"=>"Specify the board to update"}, {"in"=>"body", "name"=>"board_info", "description"=>"Specify a new name and description for the board (name is required)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Board"]}}, "/v3/boards/{board_id}/assets"=>{"delete"=>{"summary"=>"Delete Boards Board Assets", "description"=>"***beta*** remove assets from a board.", "operationId"=>"deleteV3BoardsBoardAssets", "x-api-path-slug"=>"v3boardsboard-idassets-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"query", "name"=>"asset_ids", "description"=>"List the assets to be removed from the board"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id", "description"=>"Specify the board to remove assets from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Board", "Assets"]}, "put"=>{"summary"=>"Put Boards Board Assets", "description"=>"***beta*** add assets to a board.", "operationId"=>"putV3BoardsBoardAssets", "x-api-path-slug"=>"v3boardsboard-idassets-put", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"body", "name"=>"board_assets", "description"=>"List assets to add to the board", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"board_id", "description"=>"Specify the board to add assets to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Board", "Assets"]}}, "/v3/boards/{board_id}/assets/{asset_id}"=>{"delete"=>{"summary"=>"Delete Boards Board Assets Asset", "description"=>"***beta*** remove an asset from a board.", "operationId"=>"deleteV3BoardsBoardAssetsAsset", "x-api-path-slug"=>"v3boardsboard-idassetsasset-id-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"path", "name"=>"asset_id", "description"=>"Specify the asset to remove from the board"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id", "description"=>"Specify the board to remove an asset from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Board", "Assets", "Asset"]}, "put"=>{"summary"=>"Put Boards Board Assets Asset", "description"=>"***beta*** add an asset to a board.", "operationId"=>"putV3BoardsBoardAssetsAsset", "x-api-path-slug"=>"v3boardsboard-idassetsasset-id-put", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"path", "name"=>"asset_id", "description"=>"Specify the asset to add to the board"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id", "description"=>"Specify the board to add an asset to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Board", "Assets", "Asset"]}}, "/v3/boards/{board_id}/comments"=>{"get"=>{"summary"=>"Get Boards Board Comments", "description"=>"***beta*** get comments from a board.", "operationId"=>"getV3BoardsBoardComments", "x-api-path-slug"=>"v3boardsboard-idcomments-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id", "description"=>"Specify the board to retrieve comments from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Board", "Comments"]}, "post"=>{"summary"=>"Post Boards Board Comments", "description"=>"***beta*** add a comment to a board.", "operationId"=>"postV3BoardsBoardComments", "x-api-path-slug"=>"v3boardsboard-idcomments-post", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id", "description"=>"Specify the board to add a comment to"}, {"in"=>"body", "name"=>"comment", "description"=>"Comment to be added to the board", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Board", "Comments"]}}, "/v3/boards/{board_id}/comments/{comment_id}"=>{"delete"=>{"summary"=>"Delete Boards Board Comments Comment", "description"=>"***beta*** delete a comment from a board.", "operationId"=>"deleteV3BoardsBoardCommentsComment", "x-api-path-slug"=>"v3boardsboard-idcommentscomment-id-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Provide a header to specify the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"path", "name"=>"board_id", "description"=>"Specify the board containing the comment to delete"}, {"in"=>"path", "name"=>"comment_id", "description"=>"Specify the comment to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Board", "Comments", "Comment"]}}, "/v3/collections"=>{"get"=>{"summary"=>"Get Collections", "description"=>"Gets collections applicable for the customer..", "operationId"=>"getV3Collections", "x-api-path-slug"=>"v3collections-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collections"]}}, "/v3/countries"=>{"get"=>{"summary"=>"Get Countries", "description"=>"Gets countries codes and names..", "operationId"=>"getV3Countries", "x-api-path-slug"=>"v3countries-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countries"]}}, "/v3/downloads"=>{"get"=>{"summary"=>"Get Downloads", "description"=>"Returns information about a customer's downloaded assets..", "operationId"=>"getV3Downloads", "x-api-path-slug"=>"v3downloads-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"company_downloads", "description"=>"If specified, returns the list of previously downloaded images for all users in your company"}, {"in"=>"query", "name"=>"date_from", "description"=>"If specified, select assets downloaded on or after this date"}, {"in"=>"query", "name"=>"date_to", "description"=>"If specified, select assets downloaded on or before this date"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}, {"in"=>"query", "name"=>"product_type", "description"=>"Specifies product type to be included in the previous download results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Downloads"]}}, "/v3/downloads/images/{id}"=>{"post"=>{"summary"=>"Post Downloads Images", "description"=>"Download an image.", "operationId"=>"postV3DownloadsImages", "x-api-path-slug"=>"v3downloadsimagesid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"auto_download", "description"=>"Specifies whether to auto-download the image"}, {"in"=>"body", "name"=>"download_details", "description"=>"Additional information required from specific customers when downloading", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"file_type", "description"=>"File Type expressed with three character file extension"}, {"in"=>"query", "name"=>"height", "description"=>"Specifies the pixel height of the particular image to download"}, {"in"=>"path", "name"=>"id", "description"=>"Id of image to download"}, {"in"=>"query", "name"=>"product_id", "description"=>"Identifier of the instance for the selected product offering type"}, {"in"=>"query", "name"=>"product_type", "description"=>"Product type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Downloads", "Images"]}}, "/v3/downloads/videos/{id}"=>{"post"=>{"summary"=>"Post Downloads Veos", "description"=>"Download a video.", "operationId"=>"postV3DownloadsVeos", "x-api-path-slug"=>"v3downloadsvideosid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"auto_download", "description"=>"Specifies whether to auto-download the video"}, {"in"=>"path", "name"=>"id", "description"=>"Id of video to download"}, {"in"=>"query", "name"=>"product_id", "description"=>"Identifier of the instance for the selected product offering type"}, {"in"=>"query", "name"=>"size", "description"=>"Specifies the size to be downloaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Downloads", "Veos"]}}, "/v3/downloads/{id}"=>{"post"=>{"summary"=>"Post Downloads", "description"=>"Download an image.", "operationId"=>"postV3Downloads", "x-api-path-slug"=>"v3downloadsid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"auto_download", "description"=>"Specifies whether to auto-download the image"}, {"in"=>"body", "name"=>"download_details", "description"=>"Additional information required from specific customers when downloading", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"file_type", "description"=>"File Type expressed with three character file extension"}, {"in"=>"query", "name"=>"height", "description"=>"Specifies the pixel height of the particular image to download"}, {"in"=>"path", "name"=>"id", "description"=>"Id of image to download"}, {"in"=>"query", "name"=>"product_id", "description"=>"Identifier of the instance for the selected product offering type"}, {"in"=>"query", "name"=>"product_type", "description"=>"Product type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Downloads"]}}, "/v3/events"=>{"get"=>{"summary"=>"Get Events", "description"=>"Get metadata for multiple events.", "operationId"=>"getV3Events", "x-api-path-slug"=>"v3events-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma separated list of fields to return in the response"}, {"in"=>"query", "name"=>"ids", "description"=>"A comma separated list of event ids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/v3/events/{id}"=>{"get"=>{"summary"=>"Get Events", "description"=>"Get metadata for a single event.", "operationId"=>"getV3Events", "x-api-path-slug"=>"v3eventsid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma separated list of fields to return in the response"}, {"in"=>"path", "name"=>"id", "description"=>"An event id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/v3/images"=>{"get"=>{"summary"=>"Get Images", "description"=>"Get metadata for multiple images by supplying multiple image ids.", "operationId"=>"getV3Images", "x-api-path-slug"=>"v3images-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"ids", "description"=>"Specifies one or more image ids to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images"]}}, "/v3/images/{id}"=>{"get"=>{"summary"=>"Get Images", "description"=>"Get metadata for a single image by supplying one image id.", "operationId"=>"getV3Images", "x-api-path-slug"=>"v3imagesid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"path", "name"=>"id", "description"=>"An image id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images"]}}, "/v3/images/{id}/similar"=>{"get"=>{"summary"=>"Get Images Similar", "description"=>"Search for images similar to an image.", "operationId"=>"getV3ImagesSimilar", "x-api-path-slug"=>"v3imagesidsimilar-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"path", "name"=>"id", "description"=>"Identifies an existing image"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Similar"]}}, "/v3/products"=>{"get"=>{"summary"=>"Get Products", "description"=>"Get products.", "operationId"=>"getV3Products", "x-api-path-slug"=>"v3products-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"Comma separated list of fields"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/v3/purchased-assets"=>{"get"=>{"summary"=>"Get Purchased Assets", "description"=>"Get previously purchased images and video.", "operationId"=>"getV3PurchasedAssets", "x-api-path-slug"=>"v3purchasedassets-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"date_from", "description"=>"If specified, retrieves previous purchases on or after this date"}, {"in"=>"query", "name"=>"date_to", "description"=>"If specified, retrieves previous purchases on or before this date"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Purchased", "Assets"]}}, "/v3/purchased-images"=>{"get"=>{"summary"=>"Get Purchased Images", "description"=>"Get previously purchased images.", "operationId"=>"getV3PurchasedImages", "x-api-path-slug"=>"v3purchasedimages-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"date_from", "description"=>"If specified, retrieves previous purchases on or after this date"}, {"in"=>"query", "name"=>"date_to", "description"=>"If specified, retrieves previous purchases on or before this date"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Purchased", "Images"]}}, "/v3/search/events"=>{"get"=>{"summary"=>"Get Search Events", "description"=>"Search for events.", "operationId"=>"getV3SearchEvents", "x-api-path-slug"=>"v3searchevents-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"date_from", "description"=>"Filters to events that start on or after this date"}, {"in"=>"query", "name"=>"date_to", "description"=>"Filters to events that start on or before this date"}, {"in"=>"query", "name"=>"editorial_segment", "description"=>"Filters to events with a matching editorial segment"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"page", "description"=>"Request results starting at a page number (default is 1)"}, {"in"=>"query", "name"=>"page_size", "description"=>"Request number of images to return in each page"}, {"in"=>"query", "name"=>"phrase", "description"=>"Filters to events related to this phrase"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Events"]}}, "/v3/search/images"=>{"get"=>{"summary"=>"Get Search Images", "description"=>"Search for both creative and editorial images.", "operationId"=>"getV3SearchImages", "x-api-path-slug"=>"v3searchimages-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"query", "name"=>"age_of_people", "description"=>"Filter based on the age of individuals in an image"}, {"in"=>"query", "name"=>"artists", "description"=>"Search for images by specific artists (free-text, comma-separated list of artists)"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"collections_filter_type", "description"=>"Provides searching based on specified collection(s)"}, {"in"=>"query", "name"=>"collection_codes", "description"=>"Filter by collection codes (comma-separated list)"}, {"in"=>"query", "name"=>"color", "description"=>"Filter based on predominant color in an image"}, {"in"=>"query", "name"=>"compositions", "description"=>"Filter based on image composition"}, {"in"=>"query", "name"=>"embed_content_only", "description"=>"Restrict search results to embeddable images"}, {"in"=>"query", "name"=>"ethnicity", "description"=>"Filter search results based on the ethnicity of individuals in an image"}, {"in"=>"query", "name"=>"event_ids", "description"=>"Filter based on specific events"}, {"in"=>"query", "name"=>"exclude_nudity", "description"=>"Excludes images containing nudity"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"file_types", "description"=>"Return only images having a specific file type"}, {"in"=>"query", "name"=>"graphical_styles", "description"=>"Filter based on graphical style of the image"}, {"in"=>"query", "name"=>"keyword_ids", "description"=>"Return only images tagged with specific keyword(s)"}, {"in"=>"query", "name"=>"license_models", "description"=>"Specifies the image licensing model(s)"}, {"in"=>"query", "name"=>"minimum_size", "description"=>"Filter based on minimum size requested"}, {"in"=>"query", "name"=>"number_of_people", "description"=>"Filter based on the number of people in the image"}, {"in"=>"query", "name"=>"orientations", "description"=>"Return only images with selected aspect ratios"}, {"in"=>"query", "name"=>"page", "description"=>"Request results starting at a page number (default is 1)"}, {"in"=>"query", "name"=>"page_size", "description"=>"Request number of images to return in each page"}, {"in"=>"query", "name"=>"phrase", "description"=>"Search images using a search phrase"}, {"in"=>"query", "name"=>"prestige_content_only", "description"=>"Restrict search results to prestige images"}, {"in"=>"query", "name"=>"product_types", "description"=>"Filter images to those having product types from the selected list"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Select sort order of results"}, {"in"=>"query", "name"=>"specific_people", "description"=>"Return only images associated with specific people (using a comma-delimited list)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Images"]}}, "/v3/search/images/creative"=>{"get"=>{"summary"=>"Get Search Images Creative", "description"=>"Search for creative images only.", "operationId"=>"getV3SearchImagesCreative", "x-api-path-slug"=>"v3searchimagescreative-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"query", "name"=>"age_of_people", "description"=>"Filter based on the age of individuals in an image"}, {"in"=>"query", "name"=>"artists", "description"=>"Search for images by specific artists (free-text, comma-separated list of artists)"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"collections_filter_type", "description"=>"Use to include or exclude collections from search"}, {"in"=>"query", "name"=>"collection_codes", "description"=>"Filter by collection codes (comma-separated list)"}, {"in"=>"query", "name"=>"color", "description"=>"Filter based on predominant color in an image"}, {"in"=>"query", "name"=>"compositions", "description"=>"Filter based on image composition"}, {"in"=>"query", "name"=>"embed_content_only", "description"=>"Restrict search results to embeddable images"}, {"in"=>"query", "name"=>"ethnicity", "description"=>"Filter search results based on the ethnicity of individuals in an image"}, {"in"=>"query", "name"=>"exclude_nudity", "description"=>"Excludes images containing nudity"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"file_types", "description"=>"Return only images having a specific file type"}, {"in"=>"query", "name"=>"graphical_styles", "description"=>"Filter based on graphical style of the image"}, {"in"=>"query", "name"=>"keyword_ids", "description"=>"Return only images tagged with specific keyword(s)"}, {"in"=>"query", "name"=>"license_models", "description"=>"Specifies the image licensing model(s)"}, {"in"=>"query", "name"=>"minimum_size", "description"=>"Filter based on minimum size requested"}, {"in"=>"query", "name"=>"number_of_people", "description"=>"Filter based on the number of people in the image"}, {"in"=>"query", "name"=>"orientations", "description"=>"Return only images with selected aspect ratios"}, {"in"=>"query", "name"=>"page", "description"=>"Request results starting at a page number (default is 1)"}, {"in"=>"query", "name"=>"page_size", "description"=>"Request number of images to return in each page"}, {"in"=>"query", "name"=>"phrase", "description"=>"Search images using a search phrase"}, {"in"=>"query", "name"=>"prestige_content_only", "description"=>"Restrict search results to prestige images"}, {"in"=>"query", "name"=>"product_types", "description"=>"Filter images to those having product types from the selected list"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Select sort order of results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Images", "Creative"]}}, "/v3/search/images/editorial"=>{"get"=>{"summary"=>"Get Search Images Editorial", "description"=>"Search for editorial images only.", "operationId"=>"getV3SearchImagesEditorial", "x-api-path-slug"=>"v3searchimageseditorial-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"query", "name"=>"age_of_people", "description"=>"Filter based on the age of individuals in an image"}, {"in"=>"query", "name"=>"artists", "description"=>"Search for images by specific artists (free-text, comma-separated list of artists)"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"collections_filter_type", "description"=>"Use to include or exclude collections from search"}, {"in"=>"query", "name"=>"collection_codes", "description"=>"Filter by collections (comma-separated list of collection codes)"}, {"in"=>"query", "name"=>"compositions", "description"=>"Filter based on image composition"}, {"in"=>"query", "name"=>"date_from", "description"=>"Return only images that are created on or after this date"}, {"in"=>"query", "name"=>"date_to", "description"=>"Return only images that are created on or before this date"}, {"in"=>"query", "name"=>"editorial_segments", "description"=>"Return only events with a matching editorial segment"}, {"in"=>"query", "name"=>"embed_content_only", "description"=>"Restrict search results to embeddable images"}, {"in"=>"query", "name"=>"entity_uris", "description"=>"specify linked data entity uri"}, {"in"=>"query", "name"=>"ethnicity", "description"=>"Filter search results based on the ethnicity of individuals in an image"}, {"in"=>"query", "name"=>"event_ids", "description"=>"Filter based on specific events"}, {"in"=>"query", "name"=>"exclude_nudity", "description"=>"Excludes images containing nudity"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"file_types", "description"=>"Return only images having a specific file type"}, {"in"=>"query", "name"=>"graphical_styles", "description"=>"Filter based on graphical style of the image"}, {"in"=>"query", "name"=>"keyword_ids", "description"=>"Return only images tagged with specific keyword(s)"}, {"in"=>"query", "name"=>"minimum_quality_rank", "description"=>"Filter search results based on minimum quality ranking"}, {"in"=>"query", "name"=>"minimum_size", "description"=>"Filter based on minimum size requested"}, {"in"=>"query", "name"=>"number_of_people", "description"=>"Filter based on the number of people in the image"}, {"in"=>"query", "name"=>"orientations", "description"=>"Return only images with selected aspect ratios"}, {"in"=>"query", "name"=>"page", "description"=>"Request results starting at a page number (default is 1)"}, {"in"=>"query", "name"=>"page_size", "description"=>"Request number of images to return in each page"}, {"in"=>"query", "name"=>"phrase", "description"=>"Search images using a search phrase"}, {"in"=>"query", "name"=>"product_types", "description"=>"Filter images to those having product types from the selected list"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Select sort order of results"}, {"in"=>"query", "name"=>"specific_people", "description"=>"Return only images associated with specific people (using a comma-delimited list)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Images", "Editorial"]}}, "/v3/search/videos"=>{"get"=>{"summary"=>"Get Search Veos", "description"=>"Search for both creative and editorial videos.", "operationId"=>"getV3SearchVeos", "x-api-path-slug"=>"v3searchvideos-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"query", "name"=>"age_of_people", "description"=>"Provides filtering according to the age of individuals in a video"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"collections_filter_type", "description"=>"Provides searching based on specified collection(s)"}, {"in"=>"query", "name"=>"collection_codes", "description"=>"Provides filtering by collection code"}, {"in"=>"query", "name"=>"exclude_nudity", "description"=>"Excludes images containing nudity"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"format_available", "description"=>"Filters according to the digital video format available on a film asset"}, {"in"=>"query", "name"=>"keyword_ids", "description"=>"Return only images tagged with specific keyword(s)"}, {"in"=>"query", "name"=>"license_models", "description"=>"Specifies the video licensing model(s)"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}, {"in"=>"query", "name"=>"phrase", "description"=>"Free-text search query"}, {"in"=>"query", "name"=>"product_types", "description"=>"Provides filtering by a list of product types"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Allows sorting of results"}, {"in"=>"query", "name"=>"specific_people", "description"=>"Provides filtering by specific peoples names"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Veos"]}}, "/v3/search/videos/creative"=>{"get"=>{"summary"=>"Get Search Veos Creative", "description"=>"Search for creative videos.", "operationId"=>"getV3SearchVeosCreative", "x-api-path-slug"=>"v3searchvideoscreative-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"query", "name"=>"age_of_people", "description"=>"Provides filtering according to the age of individuals in a video"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"collections_filter_type", "description"=>"Provides searching based on specified collection(s)"}, {"in"=>"query", "name"=>"collection_codes", "description"=>"Provides filtering by collection code"}, {"in"=>"query", "name"=>"exclude_nudity", "description"=>"Excludes images containing nudity"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"format_available", "description"=>"Filters according to the digital video format available on a film asset"}, {"in"=>"query", "name"=>"keyword_ids", "description"=>"Return only images tagged with specific keyword(s)"}, {"in"=>"query", "name"=>"license_models", "description"=>"Specifies the video licensing model(s)"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}, {"in"=>"query", "name"=>"phrase", "description"=>"Free-text search query"}, {"in"=>"query", "name"=>"product_types", "description"=>"Allows filtering by a list of product types"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Allows sorting of results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Veos", "Creative"]}}, "/v3/search/videos/editorial"=>{"get"=>{"summary"=>"Get Search Veos Editorial", "description"=>"Search for editorial videos.", "operationId"=>"getV3SearchVeosEditorial", "x-api-path-slug"=>"v3searchvideoseditorial-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"query", "name"=>"age_of_people", "description"=>"Provides filtering according to the age of individuals in a video"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"collections_filter_type", "description"=>"Provides searching based on specified collection(s)"}, {"in"=>"query", "name"=>"collection_codes", "description"=>"Provides filtering by collection code"}, {"in"=>"query", "name"=>"entity_uris", "description"=>"specify link data entity uri"}, {"in"=>"query", "name"=>"exclude_nudity", "description"=>"Excludes images containing nudity"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"format_available", "description"=>"Filters according to the digital video format available on a film asset"}, {"in"=>"query", "name"=>"keyword_ids", "description"=>"Return only images tagged with specific keyword(s)"}, {"in"=>"query", "name"=>"page", "description"=>"Identifies page to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"Specifies page size"}, {"in"=>"query", "name"=>"phrase", "description"=>"Free-text search query"}, {"in"=>"query", "name"=>"product_types", "description"=>"Allows filtering by a list of product types"}, {"in"=>"query", "name"=>"sort_order", "description"=>"Allows sorting of results"}, {"in"=>"query", "name"=>"specific_people", "description"=>"Allows filtering by specific peoples names"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Veos", "Editorial"]}}, "/v3/usage-batches/{id}"=>{"put"=>{"summary"=>"Put Usage Batches", "description"=>"Report usage of assets via a batch format..", "operationId"=>"putV3UsageBatches", "x-api-path-slug"=>"v3usagebatchesid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Accept-Language parameter optional"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Authorization token required"}, {"in"=>"path", "name"=>"id", "description"=>"Specifies a unique batch transaction id to identify the report"}, {"in"=>"body", "name"=>"request", "description"=>"Specifies up to 1000 sets of asset Id, usage count, and date of use to submit usages for", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Usage", "Batches"]}}, "/v3/videos"=>{"get"=>{"summary"=>"Get Veos", "description"=>"Get metadata for multiple videos by supplying multiple video ids.", "operationId"=>"getV3Veos", "x-api-path-slug"=>"v3videos-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"Specifies fields to return"}, {"in"=>"query", "name"=>"ids", "description"=>"Specifies one or more video ids to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Veos"]}}, "/v3/videos/{id}"=>{"get"=>{"summary"=>"Get Veos", "description"=>"Get metadata for a single video by supplying one video id.", "operationId"=>"getV3Veos", "x-api-path-slug"=>"v3videosid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept-Language", "description"=>"Specifies the language of result values"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Provide access token in the format of Bearer {token}"}, {"in"=>"query", "name"=>"fields", "description"=>"comma delimited list of fields to retrive for the video"}, {"in"=>"path", "name"=>"id", "description"=>"A video id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Veos"]}}}}, "apis"=>{"name"=>"UK National Archives", "x-slug"=>"uk-national-archives", "description"=>"The National Archives (TNA) is a non-ministerial government department. Its parent department is the Department for Culture, Media and Sport of the United Kingdom of Great Britain and Northern Ireland. It is the official archive of the UK government and for England and Wales; and guardian of some of the nations most iconic documents, dating back more than 1,000 years. There are separate national archives for Scotland (the National Records of Scotland) and Northern Ireland (the Public Record Office of Northern Ireland).", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/uk-national-archives.jpeg", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Archives,Catalog,General Data,Government,Historical Data API,History", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"uk-national-archives/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Getty Images Search API", "x-api-slug"=>"getty-images-search-api", "description"=>"Our set of APIs enable seamless integration of Getty Images expansive content, powerful search and rich metadata directly into your internal workflows, products and services. With Connects API solutions, you can fully control, customize and scale as you grow.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/uk-national-archives.jpeg", "humanURL"=>"http://discovery.nationalarchives.gov.uk/SearchUI/api.htm", "baseURL"=>"https://api.gettyimages.com//", "tags"=>"Archives,Catalog,General Data,Government,Historical Data API,History", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/uk-national-archives/getty-images-search-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://discovery.nationalarchives.gov.uk/SearchUI/api.htm"}, {"type"=>"x-website", "url"=>"http:///Search"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
github{"github-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"GitHub", "x-complete"=>1, "info"=>{"title"=>"GitHub", "description"=>"github-is-the-best-place-to-share-code-with-friends-coworkers-classmates-and-complete-strangers--over-24-million-people-use-github-to-build-amazing-things-together-across-67-million-repositories--with-the-collaborative-features-of-github-com-and-github-business-it-has-never-been-easier-for-individuals-and-teams-to-write-faster-better-code-", "termsOfService"=>"https://help.github.com/articles/github-terms-of-service/#b-api-terms", "version"=>"1.0.0"}, "host"=>"api.github.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/emojis"=>{"get"=>{"summary"=>"Get Emojis", "description"=>"Lists all the emojis available to use on GitHub.", "operationId"=>"lists-all-the-emojis-available-to-use-on-github", "x-api-path-slug"=>"emojis-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Emojis"]}}, "/events"=>{"get"=>{"summary"=>"Get Events", "description"=>"List public events.", "operationId"=>"list-public-events", "x-api-path-slug"=>"events-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/feeds"=>{"get"=>{"summary"=>"Get Feeds", "description"=>"List Feeds.\nGitHub provides several timeline resources in Atom format. The Feeds API\n lists all the feeds available to the authenticating user.", "operationId"=>"list-feedsgithub-provides-several-timeline-resources-in-atom-format-the-feeds-api-lists-all-the-feed", "x-api-path-slug"=>"feeds-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feeds"]}}, "/gists"=>{"get"=>{"summary"=>"Get Gists", "description"=>"List the authenticated user's gists or if called anonymously, this will\nreturn all public gists.", "operationId"=>"list-the-authenticated-users-gists-or-if-called-anonymously-this-willreturn-all-public-gists", "x-api-path-slug"=>"gists-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"since", "description"=>"Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gists"]}, "post"=>{"summary"=>"Add Gists", "description"=>"Create a gist.", "operationId"=>"create-a-gist", "x-api-path-slug"=>"gists-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gists"]}}, "/gists/public"=>{"get"=>{"summary"=>"Get Gists Public", "description"=>"List all public gists.", "operationId"=>"list-all-public-gists", "x-api-path-slug"=>"gistspublic-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"since", "description"=>"Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gists", "Public"]}}, "/gists/starred"=>{"get"=>{"summary"=>"Get Gists Starred", "description"=>"List the authenticated user's starred gists.", "operationId"=>"list-the-authenticated-users-starred-gists", "x-api-path-slug"=>"gistsstarred-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"since", "description"=>"Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gists", "Starred"]}}, "/gists/{id}"=>{"delete"=>{"summary"=>"Delete Gists", "description"=>"Delete a gist.", "operationId"=>"delete-a-gist", "x-api-path-slug"=>"gistsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id", "description"=>"Id of gist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gists"]}, "get"=>{"summary"=>"Get Gists", "description"=>"Get a single gist.", "operationId"=>"get-a-single-gist", "x-api-path-slug"=>"gistsid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id", "description"=>"Id of gist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gists"]}, "patch"=>{"summary"=>"Patch Gists", "description"=>"Edit a gist.", "operationId"=>"edit-a-gist", "x-api-path-slug"=>"gistsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Id of gist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gists"]}}, "/gists/{id}/comments"=>{"get"=>{"summary"=>"Get Gists Comments", "description"=>"List comments on a gist.", "operationId"=>"list-comments-on-a-gist", "x-api-path-slug"=>"gistsidcomments-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id", "description"=>"Id of gist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gists", "", "Comments"]}, "post"=>{"summary"=>"Add Gists Comments", "description"=>"Create a commen", "operationId"=>"create-a-commen", "x-api-path-slug"=>"gistsidcomments-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Id of gist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gists", "", "Comments"]}}, "/gists/{id}/comments/{commentId}"=>{"delete"=>{"summary"=>"Delete Gists Comments Comment", "description"=>"Delete a comment.", "operationId"=>"delete-a-comment", "x-api-path-slug"=>"gistsidcommentscommentid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"commentId", "description"=>"Id of comment"}, {"in"=>"path", "name"=>"id", "description"=>"Id of gist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gists", "", "Comments", "Comment"]}, "get"=>{"summary"=>"Get Gists Comments Comment", "description"=>"Get a single comment.", "operationId"=>"get-a-single-comment", "x-api-path-slug"=>"gistsidcommentscommentid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"commentId", "description"=>"Id of comment"}, {"in"=>"path", "name"=>"id", "description"=>"Id of gist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gists", "", "Comments", "Comment"]}, "patch"=>{"summary"=>"Patch Gists Comments Comment", "description"=>"Edit a comment.", "operationId"=>"edit-a-comment", "x-api-path-slug"=>"gistsidcommentscommentid-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"commentId", "description"=>"Id of comment"}, {"in"=>"path", "name"=>"id", "description"=>"Id of gist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gists", "", "Comments", "Comment"]}}, "/gists/{id}/forks"=>{"post"=>{"summary"=>"Add Gists Forks", "description"=>"Fork a gist.", "operationId"=>"fork-a-gist", "x-api-path-slug"=>"gistsidforks-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id", "description"=>"Id of gist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gists", "", "Forks"]}}, "/gists/{id}/star"=>{"delete"=>{"summary"=>"Delete Gists Star", "description"=>"Unstar a gist.", "operationId"=>"unstar-a-gist", "x-api-path-slug"=>"gistsidstar-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id", "description"=>"Id of gist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gists", "", "Star"]}, "get"=>{"summary"=>"Get Gists Star", "description"=>"Check if a gist is starred.", "operationId"=>"check-if-a-gist-is-starred", "x-api-path-slug"=>"gistsidstar-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id", "description"=>"Id of gist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gists", "", "Star"]}, "put"=>{"summary"=>"Put Gists Star", "description"=>"Star a gist.", "operationId"=>"star-a-gist", "x-api-path-slug"=>"gistsidstar-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id", "description"=>"Id of gist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gists", "", "Star"]}}, "/gitignore/templates"=>{"get"=>{"summary"=>"Get Gitignore Templates", "description"=>"Listing available templates.\nList all templates available to pass as an option when creating a repository.", "operationId"=>"listing-available-templateslist-all-templates-available-to-pass-as-an-option-when-creating-a-reposit", "x-api-path-slug"=>"gitignoretemplates-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gitignore", "Templates"]}}, "/gitignore/templates/{language}"=>{"get"=>{"summary"=>"Get Gitignore Templates Language", "description"=>"Get a single template.", "operationId"=>"get-a-single-template", "x-api-path-slug"=>"gitignoretemplateslanguage-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"language"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gitignore", "Templates", "Language"]}}, "/issues"=>{"get"=>{"summary"=>"Get Issues", "description"=>"List issues.\nList all issues across all the authenticated user's visible repositories.", "operationId"=>"list-issueslist-all-issues-across-all-the-authenticated-users-visible-repositories", "x-api-path-slug"=>"issues-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"direction"}, {"in"=>"query", "name"=>"filter", "description"=>"Issues assigned to you / created by you / mentioning you / youresubscribed to updates for / All issues the authenticated user can see"}, {"in"=>"query", "name"=>"labels", "description"=>"String list of comma separated Label names"}, {"in"=>"query", "name"=>"since", "description"=>"Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Issues"]}}, "/legacy/issues/search/{owner}/{repository}/{state}/{keyword}"=>{"get"=>{"summary"=>"Get Legacy Issues Search Owner Repository State Keyword", "description"=>"Find issues by state and keyword.", "operationId"=>"find-issues-by-state-and-keyword", "x-api-path-slug"=>"legacyissuessearchownerrepositorystatekeyword-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"keyword", "description"=>"The search term"}, {"in"=>"path", "name"=>"owner"}, {"in"=>"path", "name"=>"repository"}, {"in"=>"path", "name"=>"state", "description"=>"Indicates the state of the issues to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Legacy", "Issues", "Search", "Owner", "Repository", "State", "Keyword"]}}, "/legacy/repos/search/{keyword}"=>{"get"=>{"summary"=>"Get Legacy Repos Search Keyword", "description"=>"Find repositories by keyword. Note, this legacy method does not follow the v3 pagination pattern. This method returns up to 100 results per page and pages can be fetched using the start_page parameter.", "operationId"=>"find-repositories-by-keyword-note-this-legacy-method-does-not-follow-the-v3-pagination-pattern-this-", "x-api-path-slug"=>"legacyrepossearchkeyword-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"keyword", "description"=>"The search term"}, {"in"=>"query", "name"=>"language", "description"=>"Filter results by language"}, {"in"=>"query", "name"=>"order", "description"=>"The sort field"}, {"in"=>"query", "name"=>"sort", "description"=>"The sort field"}, {"in"=>"query", "name"=>"start_page", "description"=>"The page number to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Legacy", "Repos", "Search", "Keyword"]}}, "/legacy/user/email/{email}"=>{"get"=>{"summary"=>"Get Legacy User Email Email", "description"=>"This API call is added for compatibility reasons only.", "operationId"=>"this-api-call-is-added-for-compatibility-reasons-only", "x-api-path-slug"=>"legacyuseremailemail-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"email", "description"=>"The email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Legacy", "User", "Email", "Email"]}}, "/legacy/user/search/{keyword}"=>{"get"=>{"summary"=>"Get Legacy User Search Keyword", "description"=>"Find users by keyword.", "operationId"=>"find-users-by-keyword", "x-api-path-slug"=>"legacyusersearchkeyword-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"keyword", "description"=>"The search term"}, {"in"=>"query", "name"=>"order", "description"=>"The sort field"}, {"in"=>"query", "name"=>"sort", "description"=>"The sort field"}, {"in"=>"query", "name"=>"start_page", "description"=>"The page number to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Legacy", "User", "Search", "Keyword"]}}, "/markdown"=>{"post"=>{"summary"=>"Add Markdown", "description"=>"Render an arbitrary Markdown document", "operationId"=>"render-an-arbitrary-markdown-document", "x-api-path-slug"=>"markdown-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Markdown"]}}, "/markdown/raw"=>{"post"=>{"summary"=>"Add Markdown Raw", "description"=>"Render a Markdown document in raw mode", "operationId"=>"render-a-markdown-document-in-raw-mode", "x-api-path-slug"=>"markdownraw-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Markdown", "Raw"]}}, "/meta"=>{"get"=>{"summary"=>"Get Meta", "description"=>"This gives some information about GitHub.com, the service.", "operationId"=>"this-gives-some-information-about-githubcom-the-service", "x-api-path-slug"=>"meta-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meta"]}}, "/networks/{owner}/{repo}/events"=>{"get"=>{"summary"=>"Get Networks Owner Repo Events", "description"=>"List public events for a network of repositories.", "operationId"=>"list-public-events-for-a-network-of-repositories", "x-api-path-slug"=>"networksownerrepoevents-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of the owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Networks", "Owner", "Repo", "Events"]}}, "/notifications"=>{"get"=>{"summary"=>"Get Notifications", "description"=>"List your notifications.\nList all notifications for the current user, grouped by repository.", "operationId"=>"list-your-notificationslist-all-notifications-for-the-current-user-grouped-by-repository", "x-api-path-slug"=>"notifications-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"all", "description"=>"True to show notifications marked as read"}, {"in"=>"query", "name"=>"participating", "description"=>"True to show only notifications in which the user is directly participatingor mentioned"}, {"in"=>"query", "name"=>"since", "description"=>"The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications"]}, "put"=>{"summary"=>"Put Notifications", "description"=>"Mark as read.\nMarking a notification as \"read\" removes it from the default view on GitHub.com.", "operationId"=>"mark-as-readmarking-a-notification-as-read-removes-it-from-the-default-view-on-githubcom", "x-api-path-slug"=>"notifications-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications"]}}, "/notifications/threads/{id}"=>{"get"=>{"summary"=>"Get Notifications Threads", "description"=>"View a single thread.", "operationId"=>"view-a-single-thread", "x-api-path-slug"=>"notificationsthreadsid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id", "description"=>"Id of thread"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Threads"]}, "patch"=>{"summary"=>"Patch Notifications Threads", "description"=>"Mark a thread as read", "operationId"=>"mark-a-thread-as-read", "x-api-path-slug"=>"notificationsthreadsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id", "description"=>"Id of thread"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Threads"]}}, "/notifications/threads/{id}/subscription"=>{"delete"=>{"summary"=>"Delete Notifications Threads Subscription", "description"=>"Delete a Thread Subscription.", "operationId"=>"delete-a-thread-subscription", "x-api-path-slug"=>"notificationsthreadsidsubscription-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id", "description"=>"Id of thread"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Threads", "", "Subscription"]}, "get"=>{"summary"=>"Get Notifications Threads Subscription", "description"=>"Get a Thread Subscription.", "operationId"=>"get-a-thread-subscription", "x-api-path-slug"=>"notificationsthreadsidsubscription-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id", "description"=>"Id of thread"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Threads", "", "Subscription"]}, "put"=>{"summary"=>"Put Notifications Threads Subscription", "description"=>"Set a Thread Subscription.\nThis lets you subscribe to a thread, or ignore it. Subscribing to a thread\nis unnecessary if the user is already subscribed to the repository. Ignoring\na thread will mute all future notifications (until you comment or get @mentioned).", "operationId"=>"set-a-thread-subscriptionthis-lets-you-subscribe-to-a-thread-or-ignore-it-subscribing-to-a-threadis-", "x-api-path-slug"=>"notificationsthreadsidsubscription-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Id of thread"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Threads", "", "Subscription"]}}, "/orgs/{org}"=>{"get"=>{"summary"=>"Get Orgs Org", "description"=>"Get an Organization.", "operationId"=>"get-an-organization", "x-api-path-slug"=>"orgsorg-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"org", "description"=>"Name of organisation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs", "Org"]}, "patch"=>{"summary"=>"Patch Orgs Org", "description"=>"Edit an Organization.", "operationId"=>"edit-an-organization", "x-api-path-slug"=>"orgsorg-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"org", "description"=>"Name of organisation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs", "Org"]}}, "/orgs/{org}/events"=>{"get"=>{"summary"=>"Get Orgs Org Events", "description"=>"List public events for an organization.", "operationId"=>"list-public-events-for-an-organization", "x-api-path-slug"=>"orgsorgevents-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"org", "description"=>"Name of organisation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs", "Org", "Events"]}}, "/orgs/{org}/issues"=>{"get"=>{"summary"=>"Get Orgs Org Issues", "description"=>"List issues.\nList all issues for a given organization for the authenticated user.", "operationId"=>"list-issueslist-all-issues-for-a-given-organization-for-the-authenticated-user", "x-api-path-slug"=>"orgsorgissues-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"direction"}, {"in"=>"query", "name"=>"filter", "description"=>"Issues assigned to you / created by you / mentioning you / youresubscribed to updates for / All issues the authenticated user can see"}, {"in"=>"query", "name"=>"labels", "description"=>"String list of comma separated Label names"}, {"in"=>"path", "name"=>"org", "description"=>"Name of organisation"}, {"in"=>"query", "name"=>"since", "description"=>"Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs", "Org", "Issues"]}}, "/orgs/{org}/members"=>{"get"=>{"summary"=>"Get Orgs Org Members", "description"=>"Members list.\nList all users who are members of an organization. A member is a user tha\nbelongs to at least 1 team in the organization. If the authenticated user\nis also an owner of this organization then both concealed and public members\nwill be returned. If the requester is not an owner of the organization the\nquery will be redirected to the public members list.", "operationId"=>"members-listlist-all-users-who-are-members-of-an-organization-a-member-is-a-user-thabelongs-to-at-le", "x-api-path-slug"=>"orgsorgmembers-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"org", "description"=>"Name of organisation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs", "Org", "Members"]}}, "/orgs/{org}/members/{username}"=>{"delete"=>{"summary"=>"Delete Orgs Org Members Username", "description"=>"Remove a member.\nRemoving a user from this list will remove them from all teams and they\nwill no longer have any access to the organization's repositories.", "operationId"=>"remove-a-memberremoving-a-user-from-this-list-will-remove-them-from-all-teams-and-theywill-no-longer", "x-api-path-slug"=>"orgsorgmembersusername-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"org", "description"=>"Name of organisation"}, {"in"=>"path", "name"=>"username", "description"=>"Name of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs", "Org", "Members", "Username"]}, "get"=>{"summary"=>"Get Orgs Org Members Username", "description"=>"Check if a user is, publicly or privately, a member of the organization.", "operationId"=>"check-if-a-user-is-publicly-or-privately-a-member-of-the-organization", "x-api-path-slug"=>"orgsorgmembersusername-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"org", "description"=>"Name of organisation"}, {"in"=>"path", "name"=>"username", "description"=>"Name of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs", "Org", "Members", "Username"]}}, "/orgs/{org}/public_members"=>{"get"=>{"summary"=>"Get Orgs Org Public Members", "description"=>"Public members list.\nMembers of an organization can choose to have their membership publicized\nor not.", "operationId"=>"public-members-listmembers-of-an-organization-can-choose-to-have-their-membership-publicizedor-not", "x-api-path-slug"=>"orgsorgpublic-members-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"org", "description"=>"Name of organisation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs", "Org", "Public", "Members"]}}, "/orgs/{org}/public_members/{username}"=>{"delete"=>{"summary"=>"Delete Orgs Org Public Members Username", "description"=>"Conceal a user's membership.", "operationId"=>"conceal-a-users-membership", "x-api-path-slug"=>"orgsorgpublic-membersusername-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"org", "description"=>"Name of organisation"}, {"in"=>"path", "name"=>"username", "description"=>"Name of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs", "Org", "Public", "Members", "Username"]}, "get"=>{"summary"=>"Get Orgs Org Public Members Username", "description"=>"Check public membership.", "operationId"=>"check-public-membership", "x-api-path-slug"=>"orgsorgpublic-membersusername-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"org", "description"=>"Name of organisation"}, {"in"=>"path", "name"=>"username", "description"=>"Name of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs", "Org", "Public", "Members", "Username"]}, "put"=>{"summary"=>"Put Orgs Org Public Members Username", "description"=>"Publicize a user's membership.", "operationId"=>"publicize-a-users-membership", "x-api-path-slug"=>"orgsorgpublic-membersusername-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"org", "description"=>"Name of organisation"}, {"in"=>"path", "name"=>"username", "description"=>"Name of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs", "Org", "Public", "Members", "Username"]}}, "/orgs/{org}/repos"=>{"get"=>{"summary"=>"Get Orgs Org Repos", "description"=>"List repositories for the specified org.", "operationId"=>"list-repositories-for-the-specified-org", "x-api-path-slug"=>"orgsorgrepos-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"org", "description"=>"Name of organisation"}, {"in"=>"query", "name"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs", "Org", "Repos"]}, "post"=>{"summary"=>"Add Orgs Org Repos", "description"=>"Create a new repository for the authenticated user. OAuth users must supply\nrepo scope.", "operationId"=>"create-a-new-repository-for-the-authenticated-user-oauth-users-must-supplyrepo-scope", "x-api-path-slug"=>"orgsorgrepos-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"org", "description"=>"Name of organisation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs", "Org", "Repos"]}}, "/orgs/{org}/teams"=>{"get"=>{"summary"=>"Get Orgs Org Teams", "description"=>"List teams.", "operationId"=>"list-teams", "x-api-path-slug"=>"orgsorgteams-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"org", "description"=>"Name of organisation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs", "Org", "Teams"]}, "post"=>{"summary"=>"Add Orgs Org Teams", "description"=>"Create team.\nIn order to create a team, the authenticated user must be an owner of organization.", "operationId"=>"create-teamin-order-to-create-a-team-the-authenticated-user-must-be-an-owner-of-organization", "x-api-path-slug"=>"orgsorgteams-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"org", "description"=>"Name of organisation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orgs", "Org", "Teams"]}}, "/rate_limit"=>{"get"=>{"summary"=>"Get Rate Limit", "description"=>"Get your current rate limit status\nNote: Accessing this endpoint does not count against your rate limit.", "operationId"=>"get-your-current-rate-limit-statusnote-accessing-this-endpoint-does-not-count-against-your-rate-limi", "x-api-path-slug"=>"rate-limit-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rate", "Limit"]}}, "/repos/{owner}/{repo}"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo", "description"=>"Delete a Repository.\nDeleting a repository requires admin access. If OAuth is used, the delete_repo\nscope is required.", "operationId"=>"delete-a-repositorydeleting-a-repository-requires-admin-access-if-oauth-is-used-the-delete-reposcope", "x-api-path-slug"=>"reposownerrepo-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo"]}, "get"=>{"summary"=>"Get Repos Owner Repo", "description"=>"Get repository.", "operationId"=>"get-repository", "x-api-path-slug"=>"reposownerrepo-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo"]}, "patch"=>{"summary"=>"Patch Repos Owner Repo", "description"=>"Edit repository.", "operationId"=>"edit-repository", "x-api-path-slug"=>"reposownerrepo-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo"]}}, "/repos/{owner}/{repo}/assignees"=>{"get"=>{"summary"=>"Get Repos Owner Repo Assignees", "description"=>"List assignees.\nThis call lists all the available assignees (owner + collaborators) to which\nissues may be assigned.", "operationId"=>"list-assigneesthis-call-lists-all-the-available-assignees-owner--collaborators-to-whichissues-may-be", "x-api-path-slug"=>"reposownerrepoassignees-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Assignees"]}}, "/repos/{owner}/{repo}/assignees/{assignee}"=>{"get"=>{"summary"=>"Get Repos Owner Repo Assignees Assignee", "description"=>"Check assignee.\nYou may also check to see if a particular user is an assignee for a repository.", "operationId"=>"check-assigneeyou-may-also-check-to-see-if-a-particular-user-is-an-assignee-for-a-repository", "x-api-path-slug"=>"reposownerrepoassigneesassignee-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"assignee", "description"=>"Login of the assignee"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Assignees", "Assignee"]}}, "/repos/{owner}/{repo}/branches"=>{"get"=>{"summary"=>"Get Repos Owner Repo Branches", "description"=>"Get list of branches", "operationId"=>"get-list-of-branches", "x-api-path-slug"=>"reposownerrepobranches-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Branches"]}}, "/repos/{owner}/{repo}/branches/{branch}"=>{"get"=>{"summary"=>"Get Repos Owner Repo Branches Branch", "description"=>"Get Branch", "operationId"=>"get-branch", "x-api-path-slug"=>"reposownerrepobranchesbranch-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"branch", "description"=>"Name of the branch"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Branches", "Branch"]}}, "/repos/{owner}/{repo}/collaborators"=>{"get"=>{"summary"=>"Get Repos Owner Repo Collaborators", "description"=>"List.\nWhen authenticating as an organization owner of an organization-owned\nrepository, all organization owners are included in the list of\ncollaborators. Otherwise, only users with access to the repository are\nreturned in the collaborators list.", "operationId"=>"listwhen-authenticating-as-an-organization-owner-of-an-organizationownedrepository-all-organization-", "x-api-path-slug"=>"reposownerrepocollaborators-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Collaborators"]}}, "/repos/{owner}/{repo}/collaborators/{user}"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo Collaborators User", "description"=>"Remove collaborator.", "operationId"=>"remove-collaborator", "x-api-path-slug"=>"reposownerrepocollaboratorsuser-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"path", "name"=>"user", "description"=>"Login of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Collaborators", "User"]}, "get"=>{"summary"=>"Get Repos Owner Repo Collaborators User", "description"=>"Check if user is a collaborator", "operationId"=>"check-if-user-is-a-collaborator", "x-api-path-slug"=>"reposownerrepocollaboratorsuser-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"path", "name"=>"user", "description"=>"Login of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Collaborators", "User"]}, "put"=>{"summary"=>"Put Repos Owner Repo Collaborators User", "description"=>"Add collaborator.", "operationId"=>"add-collaborator", "x-api-path-slug"=>"reposownerrepocollaboratorsuser-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"path", "name"=>"user", "description"=>"Login of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Collaborators", "User"]}}, "/repos/{owner}/{repo}/comments"=>{"get"=>{"summary"=>"Get Repos Owner Repo Comments", "description"=>"List commit comments for a repository.\nComments are ordered by ascending ID.", "operationId"=>"list-commit-comments-for-a-repositorycomments-are-ordered-by-ascending-id", "x-api-path-slug"=>"reposownerrepocomments-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Comments"]}}, "/repos/{owner}/{repo}/comments/{commentId}"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo Comments Comment", "description"=>"Delete a commit comment", "operationId"=>"delete-a-commit-comment", "x-api-path-slug"=>"reposownerrepocommentscommentid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"commentId", "description"=>"Id of comment"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Comments", "Comment"]}, "get"=>{"summary"=>"Get Repos Owner Repo Comments Comment", "description"=>"Get a single commit comment.", "operationId"=>"get-a-single-commit-comment", "x-api-path-slug"=>"reposownerrepocommentscommentid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"commentId", "description"=>"Id of comment"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Comments", "Comment"]}, "patch"=>{"summary"=>"Patch Repos Owner Repo Comments Comment", "description"=>"Update a commit comment.", "operationId"=>"update-a-commit-comment", "x-api-path-slug"=>"reposownerrepocommentscommentid-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"commentId", "description"=>"Id of comment"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Comments", "Comment"]}}, "/repos/{owner}/{repo}/commits"=>{"get"=>{"summary"=>"Get Repos Owner Repo Commits", "description"=>"List commits on a repository.", "operationId"=>"list-commits-on-a-repository", "x-api-path-slug"=>"reposownerrepocommits-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"author", "description"=>"GitHub login, name, or email by which to filter by commit author"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"query", "name"=>"path", "description"=>"Only commits containing this file path will be returned"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"query", "name"=>"sha", "description"=>"Sha or branch to start listing commits from"}, {"in"=>"query", "name"=>"since", "description"=>"The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"}, {"in"=>"query", "name"=>"until", "description"=>"ISO 8601 Date - Only commits before this date will be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Commits"]}}, "/repos/{owner}/{repo}/commits/{ref}/status"=>{"get"=>{"summary"=>"Get Repos Owner Repo Commits Ref Status", "description"=>"Get the combined Status for a specific Ref\nThe Combined status endpoint is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details.\nTo access this endpoint during the preview period, you must provide a custom media type in the Accept header:\napplication/vnd.github.she-hulk-preview+json", "operationId"=>"get-the-combined-status-for-a-specific-refthe-combined-status-endpoint-is-currently-available-for-de", "x-api-path-slug"=>"reposownerrepocommitsrefstatus-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"ref"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Commits", "Ref", "Status"]}}, "/repos/{owner}/{repo}/commits/{shaCode}"=>{"get"=>{"summary"=>"Get Repos Owner Repo Commits Shacode", "description"=>"Get a single commit.", "operationId"=>"get-a-single-commit", "x-api-path-slug"=>"reposownerrepocommitsshacode-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"path", "name"=>"shaCode", "description"=>"SHA-1 code of the commit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Commits", "Shacode"]}}, "/repos/{owner}/{repo}/commits/{shaCode}/comments"=>{"get"=>{"summary"=>"Get Repos Owner Repo Commits Shacode Comments", "description"=>"List comments for a single commitList comments for a single commit.", "operationId"=>"list-comments-for-a-single-commitlist-comments-for-a-single-commit", "x-api-path-slug"=>"reposownerrepocommitsshacodecomments-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"path", "name"=>"shaCode", "description"=>"SHA-1 code of the commit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Commits", "Shacode", "Comments"]}, "post"=>{"summary"=>"Add Repos Owner Repo Commits Shacode Comments", "description"=>"Create a commit comment.", "operationId"=>"create-a-commit-comment", "x-api-path-slug"=>"reposownerrepocommitsshacodecomments-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"path", "name"=>"shaCode", "description"=>"SHA-1 code of the commit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Commits", "Shacode", "Comments"]}}, "/repos/{owner}/{repo}/compare/{baseId}...{headId}"=>{"get"=>{"summary"=>"Get Repos Owner Repo Compare Base ... Head", "description"=>"Compare two commits", "operationId"=>"compare-two-commits", "x-api-path-slug"=>"reposownerrepocomparebaseid---headid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"baseId"}, {"in"=>"path", "name"=>"headId"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Compare", "Base", "...", "Head"]}}, "/repos/{owner}/{repo}/contents/{path}"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo Contents Path", "description"=>"Delete a file.\nThis method deletes a file in a repository.", "operationId"=>"delete-a-filethis-method-deletes-a-file-in-a-repository", "x-api-path-slug"=>"reposownerrepocontentspath-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"path"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Contents", "Path"]}, "get"=>{"summary"=>"Get Repos Owner Repo Contents Path", "description"=>"Get contents.\nThis method returns the contents of a file or directory in a repository.\nFiles and symlinks support a custom media type for getting the raw content.\nDirectories and submodules do not support custom media types.\nNote: This API supports files up to 1 megabyte in size.\nHere can be many outcomes. For details see \"http://developer.github.com/v3/repos/contents/\"", "operationId"=>"get-contentsthis-method-returns-the-contents-of-a-file-or-directory-in-a-repositoryfiles-and-symlink", "x-api-path-slug"=>"reposownerrepocontentspath-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"path"}, {"in"=>"query", "name"=>"path", "description"=>"The content path"}, {"in"=>"query", "name"=>"ref", "description"=>"The String name of the Commit/Branch/Tag"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Contents", "Path"]}, "put"=>{"summary"=>"Put Repos Owner Repo Contents Path", "description"=>"Create a file.", "operationId"=>"create-a-file", "x-api-path-slug"=>"reposownerrepocontentspath-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"path"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Contents", "Path"]}}, "/repos/{owner}/{repo}/contributors"=>{"get"=>{"summary"=>"Get Repos Owner Repo Contributors", "description"=>"Get list of contributors.", "operationId"=>"get-list-of-contributors", "x-api-path-slug"=>"reposownerrepocontributors-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"anon", "description"=>"Set to 1 or true to include anonymous contributors in results"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Contributors"]}}, "/repos/{owner}/{repo}/deployments"=>{"get"=>{"summary"=>"Get Repos Owner Repo Deployments", "description"=>"Users with pull access can view deployments for a repository", "operationId"=>"users-with-pull-access-can-view-deployments-for-a-repository", "x-api-path-slug"=>"reposownerrepodeployments-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Deployments"]}, "post"=>{"summary"=>"Add Repos Owner Repo Deployments", "description"=>"Users with push access can create a deployment for a given ref", "operationId"=>"users-with-push-access-can-create-a-deployment-for-a-given-ref", "x-api-path-slug"=>"reposownerrepodeployments-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Deployments"]}}, "/repos/{owner}/{repo}/deployments/{id}/statuses"=>{"get"=>{"summary"=>"Get Repos Owner Repo Deployments Statuses", "description"=>"Users with pull access can view deployment statuses for a deployment", "operationId"=>"users-with-pull-access-can-view-deployment-statuses-for-a-deployment", "x-api-path-slug"=>"reposownerrepodeploymentsidstatuses-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id", "description"=>"The Deployment ID to list the statuses from"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Deployments", "", "Statuses"]}, "post"=>{"summary"=>"Add Repos Owner Repo Deployments Statuses", "description"=>"Create a Deployment Status\nUsers with push access can create deployment statuses for a given deployment:", "operationId"=>"create-a-deployment-statususers-with-push-access-can-create-deployment-statuses-for-a-given-deployme", "x-api-path-slug"=>"reposownerrepodeploymentsidstatuses-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The Deployment ID to list the statuses from"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Deployments", "", "Statuses"]}}, "/repos/{owner}/{repo}/downloads"=>{"get"=>{"summary"=>"Get Repos Owner Repo Downloads", "description"=>"Deprecated. List downloads for a repository.", "operationId"=>"deprecated-list-downloads-for-a-repository", "x-api-path-slug"=>"reposownerrepodownloads-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Downloads"]}}, "/repos/{owner}/{repo}/downloads/{downloadId}"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo Downloads Download", "description"=>"Deprecated. Delete a download.", "operationId"=>"deprecated-delete-a-download", "x-api-path-slug"=>"reposownerrepodownloadsdownloadid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"downloadId", "description"=>"Id of download"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Downloads", "Download"]}, "get"=>{"summary"=>"Get Repos Owner Repo Downloads Download", "description"=>"Deprecated. Get a single download.", "operationId"=>"deprecated-get-a-single-download", "x-api-path-slug"=>"reposownerrepodownloadsdownloadid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"downloadId", "description"=>"Id of download"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Downloads", "Download"]}}, "/repos/{owner}/{repo}/events"=>{"get"=>{"summary"=>"Get Repos Owner Repo Events", "description"=>"Get list of repository events.", "operationId"=>"get-list-of-repository-events", "x-api-path-slug"=>"reposownerrepoevents-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Events"]}}, "/repos/{owner}/{repo}/forks"=>{"get"=>{"summary"=>"Get Repos Owner Repo Forks", "description"=>"List forks.", "operationId"=>"list-forks", "x-api-path-slug"=>"reposownerrepoforks-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"query", "name"=>"sort"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Forks"]}, "post"=>{"summary"=>"Add Repos Owner Repo Forks", "description"=>"Create a fork.\nForking a Repository happens asynchronously. Therefore, you may have to wai\na short period before accessing the git objects. If this takes longer than 5\nminutes, be sure to contact Support.", "operationId"=>"create-a-forkforking-a-repository-happens-asynchronously-therefore-you-may-have-to-waia-short-period", "x-api-path-slug"=>"reposownerrepoforks-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Forks"]}}, "/repos/{owner}/{repo}/git/blobs"=>{"post"=>{"summary"=>"Add Repos Owner Repo Git Blobs", "description"=>"Create a Blob.", "operationId"=>"create-a-blob", "x-api-path-slug"=>"reposownerrepogitblobs-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Git", "Blobs"]}}, "/repos/{owner}/{repo}/git/blobs/{shaCode}"=>{"get"=>{"summary"=>"Get Repos Owner Repo Git Blobs Shacode", "description"=>"Get a Blob.\nSince blobs can be any arbitrary binary data, the input and responses for\nthe blob API takes an encoding parameter that can be either utf-8 or\nbase64. If your data cannot be losslessly sent as a UTF-8 string, you can\nbase64 encode it.", "operationId"=>"get-a-blobsince-blobs-can-be-any-arbitrary-binary-data-the-input-and-responses-forthe-blob-api-takes", "x-api-path-slug"=>"reposownerrepogitblobsshacode-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"path", "name"=>"shaCode", "description"=>"SHA-1 code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Git", "Blobs", "Shacode"]}}, "/repos/{owner}/{repo}/git/commits"=>{"post"=>{"summary"=>"Add Repos Owner Repo Git Commits", "description"=>"Create a Commit.", "operationId"=>"create-a-commit", "x-api-path-slug"=>"reposownerrepogitcommits-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Git", "Commits"]}}, "/repos/{owner}/{repo}/git/commits/{shaCode}"=>{"get"=>{"summary"=>"Get Repos Owner Repo Git Commits Shacode", "description"=>"Get a Commit.", "operationId"=>"get-a-commit", "x-api-path-slug"=>"reposownerrepogitcommitsshacode-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"path", "name"=>"shaCode", "description"=>"SHA-1 code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Git", "Commits", "Shacode"]}}, "/repos/{owner}/{repo}/git/refs"=>{"get"=>{"summary"=>"Get Repos Owner Repo Git Refs", "description"=>"Get all References", "operationId"=>"get-all-references", "x-api-path-slug"=>"reposownerrepogitrefs-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Git", "Refs"]}, "post"=>{"summary"=>"Add Repos Owner Repo Git Refs", "description"=>"Create a Reference", "operationId"=>"create-a-reference", "x-api-path-slug"=>"reposownerrepogitrefs-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Git", "Refs"]}}, "/repos/{owner}/{repo}/git/refs/{ref}"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo Git Refs Ref", "description"=>"Delete a Reference\nExample: Deleting a branch: DELETE /repos/octocat/Hello-World/git/refs/heads/feature-a \nExample: Deleting a tag: DELETE /repos/octocat/Hello-World/git/refs/tags/v1.0", "operationId"=>"delete-a-referenceexample-deleting-a-branch-delete-reposoctocathelloworldgitrefsheadsfeaturea-exampl", "x-api-path-slug"=>"reposownerrepogitrefsref-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"ref"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Git", "Refs", "Ref"]}, "get"=>{"summary"=>"Get Repos Owner Repo Git Refs Ref", "description"=>"Get a Reference", "operationId"=>"get-a-reference", "x-api-path-slug"=>"reposownerrepogitrefsref-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"ref"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Git", "Refs", "Ref"]}, "patch"=>{"summary"=>"Patch Repos Owner Repo Git Refs Ref", "description"=>"Update a Reference", "operationId"=>"update-a-reference", "x-api-path-slug"=>"reposownerrepogitrefsref-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"ref"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Git", "Refs", "Ref"]}}, "/repos/{owner}/{repo}/git/tags"=>{"post"=>{"summary"=>"Add Repos Owner Repo Git Tags", "description"=>"Create a Tag Object.\nNote that creating a tag object does not create the reference that makes a\ntag in Git. If you want to create an annotated tag in Git, you have to do\nthis call to create the tag object, and then create the refs/tags/[tag]\nreference. If you want to create a lightweight tag, you only have to create\nthe tag reference - this call would be unnecessary.", "operationId"=>"create-a-tag-objectnote-that-creating-a-tag-object-does-not-create-the-reference-that-makes-atag-in-", "x-api-path-slug"=>"reposownerrepogittags-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Git", "Tags"]}}, "/repos/{owner}/{repo}/git/tags/{shaCode}"=>{"get"=>{"summary"=>"Get Repos Owner Repo Git Tags Shacode", "description"=>"Get a Tag.", "operationId"=>"get-a-tag", "x-api-path-slug"=>"reposownerrepogittagsshacode-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"path", "name"=>"shaCode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Git", "Tags", "Shacode"]}}, "/repos/{owner}/{repo}/git/trees"=>{"post"=>{"summary"=>"Add Repos Owner Repo Git Trees", "description"=>"Create a Tree.\nThe tree creation API will take nested entries as well. If both a tree and\na nested path modifying that tree are specified, it will overwrite the\ncontents of that tree with the new path contents and write a new tree out.", "operationId"=>"create-a-treethe-tree-creation-api-will-take-nested-entries-as-well-if-both-a-tree-anda-nested-path-", "x-api-path-slug"=>"reposownerrepogittrees-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Git", "Trees"]}}, "/repos/{owner}/{repo}/git/trees/{shaCode}"=>{"get"=>{"summary"=>"Get Repos Owner Repo Git Trees Shacode", "description"=>"Get a Tree.", "operationId"=>"get-a-tree", "x-api-path-slug"=>"reposownerrepogittreesshacode-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"query", "name"=>"recursive", "description"=>"Get a Tree Recursively"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"path", "name"=>"shaCode", "description"=>"Tree SHA"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Git", "Trees", "Shacode"]}}, "/repos/{owner}/{repo}/hooks"=>{"get"=>{"summary"=>"Get Repos Owner Repo Hooks", "description"=>"Get list of hooks.", "operationId"=>"get-list-of-hooks", "x-api-path-slug"=>"reposownerrepohooks-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Hooks"]}, "post"=>{"summary"=>"Add Repos Owner Repo Hooks", "description"=>"Create a hook.", "operationId"=>"create-a-hook", "x-api-path-slug"=>"reposownerrepohooks-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Hooks"]}}, "/repos/{owner}/{repo}/hooks/{hookId}"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo Hooks Hook", "description"=>"Delete a hook.", "operationId"=>"delete-a-hook", "x-api-path-slug"=>"reposownerrepohookshookid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"hookId", "description"=>"Id of hook"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Hooks", "Hook"]}, "get"=>{"summary"=>"Get Repos Owner Repo Hooks Hook", "description"=>"Get single hook.", "operationId"=>"get-single-hook", "x-api-path-slug"=>"reposownerrepohookshookid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"hookId", "description"=>"Id of hook"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Hooks", "Hook"]}, "patch"=>{"summary"=>"Patch Repos Owner Repo Hooks Hook", "description"=>"Edit a hook.", "operationId"=>"edit-a-hook", "x-api-path-slug"=>"reposownerrepohookshookid-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"hookId", "description"=>"Id of hook"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Hooks", "Hook"]}}, "/repos/{owner}/{repo}/hooks/{hookId}/tests"=>{"post"=>{"summary"=>"Add Repos Owner Repo Hooks Hook Tests", "description"=>"Test a push hook.\nThis will trigger the hook with the latest push to the current repository\nif the hook is subscribed to push events. If the hook is not subscribed\nto push events, the server will respond with 204 but no test POST will\nbe generated.\nNote: Previously /repos/:owner/:repo/hooks/:id/tes", "operationId"=>"test-a-push-hookthis-will-trigger-the-hook-with-the-latest-push-to-the-current-repositoryif-the-hook", "x-api-path-slug"=>"reposownerrepohookshookidtests-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"hookId", "description"=>"Id of hook"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Hooks", "Hook", "Tests"]}}, "/repos/{owner}/{repo}/issues"=>{"get"=>{"summary"=>"Get Repos Owner Repo Issues", "description"=>"List issues for a repository.", "operationId"=>"list-issues-for-a-repository", "x-api-path-slug"=>"reposownerrepoissues-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"direction"}, {"in"=>"query", "name"=>"filter", "description"=>"Issues assigned to you / created by you / mentioning you / youresubscribed to updates for / All issues the authenticated user can see"}, {"in"=>"query", "name"=>"labels", "description"=>"String list of comma separated Label names"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"query", "name"=>"since", "description"=>"Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues"]}, "post"=>{"summary"=>"Add Repos Owner Repo Issues", "description"=>"Create an issue.\nAny user with pull access to a repository can create an issue.", "operationId"=>"create-an-issueany-user-with-pull-access-to-a-repository-can-create-an-issue", "x-api-path-slug"=>"reposownerrepoissues-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues"]}}, "/repos/{owner}/{repo}/issues/comments"=>{"get"=>{"summary"=>"Get Repos Owner Repo Issues Comments", "description"=>"List comments in a repository.", "operationId"=>"list-comments-in-a-repository", "x-api-path-slug"=>"reposownerrepoissuescomments-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"direction", "description"=>"Ignored without sort parameter"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"query", "name"=>"since", "description"=>"The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"}, {"in"=>"query", "name"=>"sort"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues", "Comments"]}}, "/repos/{owner}/{repo}/issues/comments/{commentId}"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo Issues Comments Comment", "description"=>"Delete a comment.", "operationId"=>"delete-a-comment", "x-api-path-slug"=>"reposownerrepoissuescommentscommentid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"commentId", "description"=>"ID of comment"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues", "Comments", "Comment"]}, "get"=>{"summary"=>"Get Repos Owner Repo Issues Comments Comment", "description"=>"Get a single comment.", "operationId"=>"get-a-single-comment", "x-api-path-slug"=>"reposownerrepoissuescommentscommentid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"commentId", "description"=>"ID of comment"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues", "Comments", "Comment"]}, "patch"=>{"summary"=>"Patch Repos Owner Repo Issues Comments Comment", "description"=>"Edit a comment.", "operationId"=>"edit-a-comment", "x-api-path-slug"=>"reposownerrepoissuescommentscommentid-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"commentId", "description"=>"ID of comment"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues", "Comments", "Comment"]}}, "/repos/{owner}/{repo}/issues/events"=>{"get"=>{"summary"=>"Get Repos Owner Repo Issues Events", "description"=>"List issue events for a repository.", "operationId"=>"list-issue-events-for-a-repository", "x-api-path-slug"=>"reposownerrepoissuesevents-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues", "Events"]}}, "/repos/{owner}/{repo}/issues/events/{eventId}"=>{"get"=>{"summary"=>"Get Repos Owner Repo Issues Events Event", "description"=>"Get a single event.", "operationId"=>"get-a-single-event", "x-api-path-slug"=>"reposownerrepoissueseventseventid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"eventId", "description"=>"Id of the event"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues", "Events", "Event"]}}, "/repos/{owner}/{repo}/issues/{number}"=>{"get"=>{"summary"=>"Get Repos Owner Repo Issues Number", "description"=>"Get a single issue", "operationId"=>"get-a-single-issue", "x-api-path-slug"=>"reposownerrepoissuesnumber-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"number", "description"=>"Number of issue"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues", "Number"]}, "patch"=>{"summary"=>"Patch Repos Owner Repo Issues Number", "description"=>"Edit an issue.\nIssue owners and users with push access can edit an issue.", "operationId"=>"edit-an-issueissue-owners-and-users-with-push-access-can-edit-an-issue", "x-api-path-slug"=>"reposownerrepoissuesnumber-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"number", "description"=>"Number of issue"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues", "Number"]}}, "/repos/{owner}/{repo}/issues/{number}/comments"=>{"get"=>{"summary"=>"Get Repos Owner Repo Issues Number Comments", "description"=>"List comments on an issue.", "operationId"=>"list-comments-on-an-issue", "x-api-path-slug"=>"reposownerrepoissuesnumbercomments-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"number", "description"=>"Number of issue"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues", "Number", "Comments"]}, "post"=>{"summary"=>"Add Repos Owner Repo Issues Number Comments", "description"=>"Create a comment.", "operationId"=>"create-a-comment", "x-api-path-slug"=>"reposownerrepoissuesnumbercomments-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"number", "description"=>"Number of issue"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues", "Number", "Comments"]}}, "/repos/{owner}/{repo}/issues/{number}/events"=>{"get"=>{"summary"=>"Get Repos Owner Repo Issues Number Events", "description"=>"List events for an issue.", "operationId"=>"list-events-for-an-issue", "x-api-path-slug"=>"reposownerrepoissuesnumberevents-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"number", "description"=>"Number of issue"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues", "Number", "Events"]}}, "/repos/{owner}/{repo}/issues/{number}/labels"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo Issues Number Labels", "description"=>"Remove all labels from an issue.", "operationId"=>"remove-all-labels-from-an-issue", "x-api-path-slug"=>"reposownerrepoissuesnumberlabels-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"number", "description"=>"Number of issue"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues", "Number", "Labels"]}, "get"=>{"summary"=>"Get Repos Owner Repo Issues Number Labels", "description"=>"List labels on an issue.", "operationId"=>"list-labels-on-an-issue", "x-api-path-slug"=>"reposownerrepoissuesnumberlabels-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"number", "description"=>"Number of issue"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues", "Number", "Labels"]}, "post"=>{"summary"=>"Add Repos Owner Repo Issues Number Labels", "description"=>"Add labels to an issue.", "operationId"=>"add-labels-to-an-issue", "x-api-path-slug"=>"reposownerrepoissuesnumberlabels-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"number", "description"=>"Number of issue"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues", "Number", "Labels"]}, "put"=>{"summary"=>"Put Repos Owner Repo Issues Number Labels", "description"=>"Replace all labels for an issue.\nSending an empty array ([]) will remove all Labels from the Issue.", "operationId"=>"replace-all-labels-for-an-issuesending-an-empty-array--will-remove-all-labels-from-the-issue", "x-api-path-slug"=>"reposownerrepoissuesnumberlabels-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"number", "description"=>"Number of issue"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues", "Number", "Labels"]}}, "/repos/{owner}/{repo}/issues/{number}/labels/{name}"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo Issues Number Labels Name", "description"=>"Remove a label from an issue.", "operationId"=>"remove-a-label-from-an-issue", "x-api-path-slug"=>"reposownerrepoissuesnumberlabelsname-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"name", "description"=>"Name of the label"}, {"in"=>"path", "name"=>"number", "description"=>"Number of issue"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Issues", "Number", "Labels", "Name"]}}, "/repos/{owner}/{repo}/keys"=>{"get"=>{"summary"=>"Get Repos Owner Repo Keys", "description"=>"Get list of keys.", "operationId"=>"get-list-of-keys", "x-api-path-slug"=>"reposownerrepokeys-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Keys"]}, "post"=>{"summary"=>"Add Repos Owner Repo Keys", "description"=>"Create a key.", "operationId"=>"create-a-key", "x-api-path-slug"=>"reposownerrepokeys-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Keys"]}}, "/repos/{owner}/{repo}/keys/{keyId}"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo Keys Key", "description"=>"Delete a key.", "operationId"=>"delete-a-key", "x-api-path-slug"=>"reposownerrepokeyskeyid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"keyId", "description"=>"Id of key"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Keys", "Key"]}, "get"=>{"summary"=>"Get Repos Owner Repo Keys Key", "description"=>"Get a key", "operationId"=>"get-a-key", "x-api-path-slug"=>"reposownerrepokeyskeyid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"keyId", "description"=>"Id of key"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Keys", "Key"]}}, "/repos/{owner}/{repo}/labels"=>{"get"=>{"summary"=>"Get Repos Owner Repo Labels", "description"=>"List all labels for this repository.", "operationId"=>"list-all-labels-for-this-repository", "x-api-path-slug"=>"reposownerrepolabels-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Labels"]}, "post"=>{"summary"=>"Add Repos Owner Repo Labels", "description"=>"Create a label.", "operationId"=>"create-a-label", "x-api-path-slug"=>"reposownerrepolabels-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Labels"]}}, "/repos/{owner}/{repo}/labels/{name}"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo Labels Name", "description"=>"Delete a label.", "operationId"=>"delete-a-label", "x-api-path-slug"=>"reposownerrepolabelsname-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"name", "description"=>"Name of the label"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Labels", "Name"]}, "get"=>{"summary"=>"Get Repos Owner Repo Labels Name", "description"=>"Get a single label.", "operationId"=>"get-a-single-label", "x-api-path-slug"=>"reposownerrepolabelsname-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"name", "description"=>"Name of the label"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Labels", "Name"]}, "patch"=>{"summary"=>"Patch Repos Owner Repo Labels Name", "description"=>"Update a label.", "operationId"=>"update-a-label", "x-api-path-slug"=>"reposownerrepolabelsname-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"Name of the label"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Labels", "Name"]}}, "/repos/{owner}/{repo}/languages"=>{"get"=>{"summary"=>"Get Repos Owner Repo Languages", "description"=>"List languages.\nList languages for the specified repository. The value on the right of a\nlanguage is the number of bytes of code written in that language.", "operationId"=>"list-languageslist-languages-for-the-specified-repository-the-value-on-the-right-of-alanguage-is-the", "x-api-path-slug"=>"reposownerrepolanguages-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Languages"]}}, "/repos/{owner}/{repo}/merges"=>{"post"=>{"summary"=>"Add Repos Owner Repo Merges", "description"=>"Perform a merge.", "operationId"=>"perform-a-merge", "x-api-path-slug"=>"reposownerrepomerges-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Merges"]}}, "/repos/{owner}/{repo}/milestones"=>{"get"=>{"summary"=>"Get Repos Owner Repo Milestones", "description"=>"List milestones for a repository.", "operationId"=>"list-milestones-for-a-repository", "x-api-path-slug"=>"reposownerrepomilestones-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"direction", "description"=>"Ignored without sort parameter"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"state", "description"=>"String to filter by state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Milestones"]}, "post"=>{"summary"=>"Add Repos Owner Repo Milestones", "description"=>"Create a milestone.", "operationId"=>"create-a-milestone", "x-api-path-slug"=>"reposownerrepomilestones-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Milestones"]}}, "/repos/{owner}/{repo}/milestones/{number}"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo Milestones Number", "description"=>"Delete a milestone.", "operationId"=>"delete-a-milestone", "x-api-path-slug"=>"reposownerrepomilestonesnumber-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"number", "description"=>"Number of milestone"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Milestones", "Number"]}, "get"=>{"summary"=>"Get Repos Owner Repo Milestones Number", "description"=>"Get a single milestone.", "operationId"=>"get-a-single-milestone", "x-api-path-slug"=>"reposownerrepomilestonesnumber-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"number", "description"=>"Number of milestone"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Milestones", "Number"]}, "patch"=>{"summary"=>"Patch Repos Owner Repo Milestones Number", "description"=>"Update a milestone.", "operationId"=>"update-a-milestone", "x-api-path-slug"=>"reposownerrepomilestonesnumber-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"number", "description"=>"Number of milestone"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Milestones", "Number"]}}, "/repos/{owner}/{repo}/milestones/{number}/labels"=>{"get"=>{"summary"=>"Get Repos Owner Repo Milestones Number Labels", "description"=>"Get labels for every issue in a milestone.", "operationId"=>"get-labels-for-every-issue-in-a-milestone", "x-api-path-slug"=>"reposownerrepomilestonesnumberlabels-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"number", "description"=>"Number of milestone"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Milestones", "Number", "Labels"]}}, "/repos/{owner}/{repo}/notifications"=>{"get"=>{"summary"=>"Get Repos Owner Repo Notifications", "description"=>"List your notifications in a repository\nList all notifications for the current user.", "operationId"=>"list-your-notifications-in-a-repositorylist-all-notifications-for-the-current-user", "x-api-path-slug"=>"reposownerreponotifications-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"all", "description"=>"True to show notifications marked as read"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"query", "name"=>"participating", "description"=>"True to show only notifications in which the user is directly participatingor mentioned"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"query", "name"=>"since", "description"=>"The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Notifications"]}, "put"=>{"summary"=>"Put Repos Owner Repo Notifications", "description"=>"Mark notifications as read in a repository.\nMarking all notifications in a repository as \"read\" removes them from the\ndefault view on GitHub.com.", "operationId"=>"mark-notifications-as-read-in-a-repositorymarking-all-notifications-in-a-repository-as-read-removes-", "x-api-path-slug"=>"reposownerreponotifications-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Notifications"]}}, "/repos/{owner}/{repo}/pulls"=>{"get"=>{"summary"=>"Get Repos Owner Repo Pulls", "description"=>"List pull requests.", "operationId"=>"list-pull-requests", "x-api-path-slug"=>"reposownerrepopulls-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"base", "description"=>"Filter pulls by base branch name"}, {"in"=>"query", "name"=>"head", "description"=>"Filter pulls by head user and branch name in the format of user:ref-name"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"query", "name"=>"state", "description"=>"String to filter by state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Pulls"]}, "post"=>{"summary"=>"Add Repos Owner Repo Pulls", "description"=>"Create a pull request.", "operationId"=>"create-a-pull-request", "x-api-path-slug"=>"reposownerrepopulls-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Pulls"]}}, "/repos/{owner}/{repo}/pulls/comments"=>{"get"=>{"summary"=>"Get Repos Owner Repo Pulls Comments", "description"=>"List comments in a repository.\nBy default, Review Comments are ordered by ascending ID.", "operationId"=>"list-comments-in-a-repositoryby-default-review-comments-are-ordered-by-ascending-id", "x-api-path-slug"=>"reposownerrepopullscomments-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"direction", "description"=>"Ignored without sort parameter"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}, {"in"=>"query", "name"=>"since", "description"=>"The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"}, {"in"=>"query", "name"=>"sort"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Pulls", "Comments"]}}, "/repos/{owner}/{repo}/pulls/comments/{commentId}"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo Pulls Comments Comment", "description"=>"Delete a comment.", "operationId"=>"delete-a-comment", "x-api-path-slug"=>"reposownerrepopullscommentscommentid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"commentId", "description"=>"Id of comment"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Pulls", "Comments", "Comment"]}, "get"=>{"summary"=>"Get Repos Owner Repo Pulls Comments Comment", "description"=>"Get a single comment.", "operationId"=>"get-a-single-comment", "x-api-path-slug"=>"reposownerrepopullscommentscommentid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"commentId", "description"=>"Id of comment"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Pulls", "Comments", "Comment"]}, "patch"=>{"summary"=>"Patch Repos Owner Repo Pulls Comments Comment", "description"=>"Edit a comment.", "operationId"=>"edit-a-comment", "x-api-path-slug"=>"reposownerrepopullscommentscommentid-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"commentId", "description"=>"Id of comment"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Pulls", "Comments", "Comment"]}}, "/repos/{owner}/{repo}/pulls/{number}"=>{"get"=>{"summary"=>"Get Repos Owner Repo Pulls Number", "description"=>"Get a single pull request.", "operationId"=>"get-a-single-pull-request", "x-api-path-slug"=>"reposownerrepopullsnumber-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"number", "description"=>"Id of pull"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Pulls", "Number"]}, "patch"=>{"summary"=>"Patch Repos Owner Repo Pulls Number", "description"=>"Update a pull request.", "operationId"=>"update-a-pull-request", "x-api-path-slug"=>"reposownerrepopullsnumber-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"number", "description"=>"Id of pull"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Pulls", "Number"]}}, "/repos/{owner}/{repo}/pulls/{number}/comments"=>{"get"=>{"summary"=>"Get Repos Owner Repo Pulls Number Comments", "description"=>"List comments on a pull request.", "operationId"=>"list-comments-on-a-pull-request", "x-api-path-slug"=>"reposownerrepopullsnumbercomments-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"number", "description"=>"Id of pull"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Pulls", "Number", "Comments"]}, "post"=>{"summary"=>"Add Repos Owner Repo Pulls Number Comments", "description"=>"Create a comment.\n #TODO Alternative input ( http://developer.github.com/v3/pulls/comments/ )\n description: |\n Alternative Input.\n Instead of passing commit_id, path, and position you can reply to an\n existing Pull Request Comment like this:\n\n body\n Required string\n in_reply_to\n Required number - Comment id to reply to.", "operationId"=>"create-a-comment--todo-alternative-input--httpdevelopergithubcomv3pullscomments---description-----al", "x-api-path-slug"=>"reposownerrepopullsnumbercomments-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"number", "description"=>"Id of pull"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Pulls", "Number", "Comments"]}}, "/repos/{owner}/{repo}/pulls/{number}/commits"=>{"get"=>{"summary"=>"Get Repos Owner Repo Pulls Number Commits", "description"=>"List commits on a pull request.", "operationId"=>"list-commits-on-a-pull-request", "x-api-path-slug"=>"reposownerrepopullsnumbercommits-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"number", "description"=>"Id of pull"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Pulls", "Number", "Commits"]}}, "/repos/{owner}/{repo}/pulls/{number}/files"=>{"get"=>{"summary"=>"Get Repos Owner Repo Pulls Number Files", "description"=>"List pull requests files.", "operationId"=>"list-pull-requests-files", "x-api-path-slug"=>"reposownerrepopullsnumberfiles-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"number", "description"=>"Id of pull"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Pulls", "Number", "Files"]}}, "/repos/{owner}/{repo}/pulls/{number}/merge"=>{"get"=>{"summary"=>"Get Repos Owner Repo Pulls Number Merge", "description"=>"Get if a pull request has been merged.", "operationId"=>"get-if-a-pull-request-has-been-merged", "x-api-path-slug"=>"reposownerrepopullsnumbermerge-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"number", "description"=>"Id of pull"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Pulls", "Number", "Merge"]}, "put"=>{"summary"=>"Put Repos Owner Repo Pulls Number Merge", "description"=>"Merge a pull request (Merge Button's)", "operationId"=>"merge-a-pull-request-merge-buttons", "x-api-path-slug"=>"reposownerrepopullsnumbermerge-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"number", "description"=>"Id of pull"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Pulls", "Number", "Merge"]}}, "/repos/{owner}/{repo}/readme"=>{"get"=>{"summary"=>"Get Repos Owner Repo Readme", "description"=>"Get the README.\nThis method returns the preferred README for a repository.", "operationId"=>"get-the-readmethis-method-returns-the-preferred-readme-for-a-repository", "x-api-path-slug"=>"reposownerreporeadme-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"query", "name"=>"ref", "description"=>"The String name of the Commit/Branch/Tag"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Readme"]}}, "/repos/{owner}/{repo}/releases"=>{"get"=>{"summary"=>"Get Repos Owner Repo Releases", "description"=>"Users with push access to the repository will receive all releases (i.e., published releases and draft releases). Users with pull access will receive published releases only", "operationId"=>"users-with-push-access-to-the-repository-will-receive-all-releases-ie-published-releases-and-draft-r", "x-api-path-slug"=>"reposownerreporeleases-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Releases"]}, "post"=>{"summary"=>"Add Repos Owner Repo Releases", "description"=>"Create a release\nUsers with push access to the repository can create a release.", "operationId"=>"create-a-releaseusers-with-push-access-to-the-repository-can-create-a-release", "x-api-path-slug"=>"reposownerreporeleases-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Releases"]}}, "/repos/{owner}/{repo}/releases/assets/{id}"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo Releases Assets", "description"=>"Delete a release asset", "operationId"=>"delete-a-release-asset", "x-api-path-slug"=>"reposownerreporeleasesassetsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Releases", "Assets"]}, "get"=>{"summary"=>"Get Repos Owner Repo Releases Assets", "description"=>"Get a single release asset", "operationId"=>"get-a-single-release-asset", "x-api-path-slug"=>"reposownerreporeleasesassetsid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Releases", "Assets"]}, "patch"=>{"summary"=>"Patch Repos Owner Repo Releases Assets", "description"=>"Edit a release asset\nUsers with push access to the repository can edit a release asset.", "operationId"=>"edit-a-release-assetusers-with-push-access-to-the-repository-can-edit-a-release-asset", "x-api-path-slug"=>"reposownerreporeleasesassetsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Releases", "Assets"]}}, "/repos/{owner}/{repo}/releases/{id}"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo Releases", "description"=>"Users with push access to the repository can delete a release.", "operationId"=>"users-with-push-access-to-the-repository-can-delete-a-release", "x-api-path-slug"=>"reposownerreporeleasesid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Releases"]}, "get"=>{"summary"=>"Get Repos Owner Repo Releases", "description"=>"Get a single release", "operationId"=>"get-a-single-release", "x-api-path-slug"=>"reposownerreporeleasesid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Releases"]}, "patch"=>{"summary"=>"Patch Repos Owner Repo Releases", "description"=>"Users with push access to the repository can edit a release", "operationId"=>"users-with-push-access-to-the-repository-can-edit-a-release", "x-api-path-slug"=>"reposownerreporeleasesid-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Releases"]}}, "/repos/{owner}/{repo}/releases/{id}/assets"=>{"get"=>{"summary"=>"Get Repos Owner Repo Releases Assets", "description"=>"List assets for a release", "operationId"=>"list-assets-for-a-release", "x-api-path-slug"=>"reposownerreporeleasesidassets-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Releases", "", "Assets"]}}, "/repos/{owner}/{repo}/stargazers"=>{"get"=>{"summary"=>"Get Repos Owner Repo Stargazers", "description"=>"List Stargazers.", "operationId"=>"list-stargazers", "x-api-path-slug"=>"reposownerrepostargazers-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Stargazers"]}}, "/repos/{owner}/{repo}/stats/code_frequency"=>{"get"=>{"summary"=>"Get Repos Owner Repo Stats Code Frequency", "description"=>"Get the number of additions and deletions per week.\nReturns a weekly aggregate of the number of additions and deletions pushed\nto a repository.", "operationId"=>"get-the-number-of-additions-and-deletions-per-weekreturns-a-weekly-aggregate-of-the-number-of-additi", "x-api-path-slug"=>"reposownerrepostatscode-frequency-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Stats", "Code", "Frequency", "Aggregation"]}}, "/repos/{owner}/{repo}/stats/commit_activity"=>{"get"=>{"summary"=>"Get Repos Owner Repo Stats Commit Activity", "description"=>"Get the last year of commit activity data.\nReturns the last year of commit activity grouped by week. The days array\nis a group of commits per day, starting on Sunday.", "operationId"=>"get-the-last-year-of-commit-activity-datareturns-the-last-year-of-commit-activity-grouped-by-week-th", "x-api-path-slug"=>"reposownerrepostatscommit-activity-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Stats", "Commit", "Activity"]}}, "/repos/{owner}/{repo}/stats/contributors"=>{"get"=>{"summary"=>"Get Repos Owner Repo Stats Contributors", "description"=>"Get contributors list with additions, deletions, and commit counts.", "operationId"=>"get-contributors-list-with-additions-deletions-and-commit-counts", "x-api-path-slug"=>"reposownerrepostatscontributors-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Stats", "Contributors"]}}, "/repos/{owner}/{repo}/stats/participation"=>{"get"=>{"summary"=>"Get Repos Owner Repo Stats Participation", "description"=>"Get the weekly commit count for the repo owner and everyone else.", "operationId"=>"get-the-weekly-commit-count-for-the-repo-owner-and-everyone-else", "x-api-path-slug"=>"reposownerrepostatsparticipation-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Stats", "Participation"]}}, "/repos/{owner}/{repo}/stats/punch_card"=>{"get"=>{"summary"=>"Get Repos Owner Repo Stats Punch Card", "description"=>"Get the number of commits per hour in each day.\nEach array contains the day number, hour number, and number of commits\n0-6 Sunday - Saturday\n0-23 Hour of day\nNumber of commits\n\nFor example, [2, 14, 25] indicates that there were 25 total commits, during\nthe 2.00pm hour on Tuesdays. All times are based on the time zone of\nindividual commits.", "operationId"=>"get-the-number-of-commits-per-hour-in-each-dayeach-array-contains-the-day-number-hour-number-and-num", "x-api-path-slug"=>"reposownerrepostatspunch-card-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Stats", "Punch", "Card"]}}, "/repos/{owner}/{repo}/statuses/{ref}"=>{"get"=>{"summary"=>"Get Repos Owner Repo Statuses Ref", "description"=>"List Statuses for a specific Ref.", "operationId"=>"list-statuses-for-a-specific-ref", "x-api-path-slug"=>"reposownerrepostatusesref-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"ref", "description"=>"Ref to list the statuses from"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Statuses", "Ref"]}, "post"=>{"summary"=>"Add Repos Owner Repo Statuses Ref", "description"=>"Create a Status.", "operationId"=>"create-a-status", "x-api-path-slug"=>"reposownerrepostatusesref-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"ref", "description"=>"Ref to list the statuses from"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Statuses", "Ref"]}}, "/repos/{owner}/{repo}/subscribers"=>{"get"=>{"summary"=>"Get Repos Owner Repo Subscribers", "description"=>"List watchers.", "operationId"=>"list-watchers", "x-api-path-slug"=>"reposownerreposubscribers-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Subscribers"]}}, "/repos/{owner}/{repo}/subscription"=>{"delete"=>{"summary"=>"Delete Repos Owner Repo Subscription", "description"=>"Delete a Repository Subscription.", "operationId"=>"delete-a-repository-subscription", "x-api-path-slug"=>"reposownerreposubscription-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Subscription"]}, "get"=>{"summary"=>"Get Repos Owner Repo Subscription", "description"=>"Get a Repository Subscription.", "operationId"=>"get-a-repository-subscription", "x-api-path-slug"=>"reposownerreposubscription-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Subscription"]}, "put"=>{"summary"=>"Put Repos Owner Repo Subscription", "description"=>"Set a Repository Subscription", "operationId"=>"set-a-repository-subscription", "x-api-path-slug"=>"reposownerreposubscription-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Subscription"]}}, "/repos/{owner}/{repo}/tags"=>{"get"=>{"summary"=>"Get Repos Owner Repo Tags", "description"=>"Get list of tags.", "operationId"=>"get-list-of-tags", "x-api-path-slug"=>"reposownerrepotags-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Tags"]}}, "/repos/{owner}/{repo}/teams"=>{"get"=>{"summary"=>"Get Repos Owner Repo Teams", "description"=>"Get list of teams", "operationId"=>"get-list-of-teams", "x-api-path-slug"=>"reposownerrepoteams-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Teams"]}}, "/repos/{owner}/{repo}/watchers"=>{"get"=>{"summary"=>"Get Repos Owner Repo Watchers", "description"=>"List Stargazers. New implementation.", "operationId"=>"list-stargazers-new-implementation", "x-api-path-slug"=>"reposownerrepowatchers-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Watchers"]}}, "/repos/{owner}/{repo}/{archive_format}/{path}"=>{"get"=>{"summary"=>"Get Repos Owner Repo Archive Format Path", "description"=>"Get archive link.\nThis method will return a 302 to a URL to download a tarball or zipball\narchive for a repository. Please make sure your HTTP framework is\nconfigured to follow redirects or you will need to use the Location header\nto make a second GET request.\nNote: For private repositories, these links are temporary and expire quickly.", "operationId"=>"get-archive-linkthis-method-will-return-a-302-to-a-url-to-download-a-tarball-or-zipballarchive-for-a", "x-api-path-slug"=>"reposownerrepoarchive-formatpath-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"archive_format"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of repository owner"}, {"in"=>"path", "name"=>"path", "description"=>"Valid Git reference, defaults to master"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repos", "Owner", "Repo", "Archives", "Format", "Path"]}}, "/repositories"=>{"get"=>{"summary"=>"Get Repositories", "description"=>"List all public repositories.\nThis provides a dump of every public repository, in the order that they\nwere created.\nNote: Pagination is powered exclusively by the since parameter. is the\nLink header to get the URL for the next page of repositories.", "operationId"=>"list-all-public-repositoriesthis-provides-a-dump-of-every-public-repository-in-the-order-that-theywe", "x-api-path-slug"=>"repositories-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"since", "description"=>"The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories"]}}, "/search/code"=>{"get"=>{"summary"=>"Get Search Code", "description"=>"Search code.", "operationId"=>"search-code", "x-api-path-slug"=>"searchcode-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"order", "description"=>"The sort field"}, {"in"=>"query", "name"=>"q", "description"=>"The search terms"}, {"in"=>"query", "name"=>"sort", "description"=>"Can only be indexed, which indicates how recently a file has been indexedby the GitHub search infrastructure"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Code"]}}, "/search/issues"=>{"get"=>{"summary"=>"Get Search Issues", "description"=>"Find issues by state and keyword. (This method returns up to 100 results per page.)", "operationId"=>"find-issues-by-state-and-keyword-this-method-returns-up-to-100-results-per-page", "x-api-path-slug"=>"searchissues-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"order", "description"=>"The sort field"}, {"in"=>"query", "name"=>"q", "description"=>"The q search term can also contain any combination of the supported issue search qualifiers:"}, {"in"=>"query", "name"=>"sort", "description"=>"The sort field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Issues"]}}, "/search/repositories"=>{"get"=>{"summary"=>"Get Search Repositories", "description"=>"Search repositories.", "operationId"=>"search-repositories", "x-api-path-slug"=>"searchrepositories-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"order", "description"=>"The sort field"}, {"in"=>"query", "name"=>"q", "description"=>"The search terms"}, {"in"=>"query", "name"=>"sort", "description"=>"If not provided, results are sorted by best match"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Repositories"]}}, "/search/users"=>{"get"=>{"summary"=>"Get Search Users", "description"=>"Search users.", "operationId"=>"search-users", "x-api-path-slug"=>"searchusers-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"order", "description"=>"The sort field"}, {"in"=>"query", "name"=>"q", "description"=>"The search terms"}, {"in"=>"query", "name"=>"sort", "description"=>"If not provided, results are sorted by best match"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Users"]}}, "/teams/{teamId}"=>{"delete"=>{"summary"=>"Delete Teams Team", "description"=>"Delete team.\nIn order to delete a team, the authenticated user must be an owner of the\norg that the team is associated with.", "operationId"=>"delete-teamin-order-to-delete-a-team-the-authenticated-user-must-be-an-owner-of-theorg-that-the-team", "x-api-path-slug"=>"teamsteamid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"teamId", "description"=>"Id of team"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Team"]}, "get"=>{"summary"=>"Get Teams Team", "description"=>"Get team.", "operationId"=>"get-team", "x-api-path-slug"=>"teamsteamid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"teamId", "description"=>"Id of team"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Team"]}, "patch"=>{"summary"=>"Patch Teams Team", "description"=>"Edit team.\nIn order to edit a team, the authenticated user must be an owner of the org\nthat the team is associated with.", "operationId"=>"edit-teamin-order-to-edit-a-team-the-authenticated-user-must-be-an-owner-of-the-orgthat-the-team-is-", "x-api-path-slug"=>"teamsteamid-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"teamId", "description"=>"Id of team"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Team"]}}, "/teams/{teamId}/members"=>{"get"=>{"summary"=>"Get Teams Team Members", "description"=>"List team members.\nIn order to list members in a team, the authenticated user must be a member\nof the team.", "operationId"=>"list-team-membersin-order-to-list-members-in-a-team-the-authenticated-user-must-be-a-memberof-the-te", "x-api-path-slug"=>"teamsteamidmembers-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"teamId", "description"=>"Id of team"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Team", "Members"]}}, "/teams/{teamId}/members/{username}"=>{"delete"=>{"summary"=>"Delete Teams Team Members Username", "description"=>"The \"Remove team member\" API is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Remove team membership API instead. It allows you to remove both active and pending memberships.\n\nRemove team member.\nIn order to remove a user from a team, the authenticated user must have 'admin'\npermissions to the team or be an owner of the org that the team is associated\nwith.\nNOTE This does not delete the user, it just remove them from the team.", "operationId"=>"the-remove-team-member-api-is-deprecated-and-is-scheduled-for-removal-in-the-next-major-version-of-t", "x-api-path-slug"=>"teamsteamidmembersusername-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"teamId", "description"=>"Id of team"}, {"in"=>"path", "name"=>"username", "description"=>"Name of a member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Team", "Members", "Username"]}, "get"=>{"summary"=>"Get Teams Team Members Username", "description"=>"The \"Get team member\" API is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Get team membership API instead. It allows you to get both active and pending memberships.\n\nGet team member.\nIn order to get if a user is a member of a team, the authenticated user mus\nbe a member of the team.", "operationId"=>"the-get-team-member-api-is-deprecated-and-is-scheduled-for-removal-in-the-next-major-version-of-the-", "x-api-path-slug"=>"teamsteamidmembersusername-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"teamId", "description"=>"Id of team"}, {"in"=>"path", "name"=>"username", "description"=>"Name of a member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Team", "Members", "Username"]}, "put"=>{"summary"=>"Put Teams Team Members Username", "description"=>"The API (described below) is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Add team membership API instead. It allows you to invite new organization members to your teams.\n\nAdd team member.\nIn order to add a user to a team, the authenticated user must have 'admin'\npermissions to the team or be an owner of the org that the team is associated\nwith.", "operationId"=>"the-api-described-below-is-deprecated-and-is-scheduled-for-removal-in-the-next-major-version-of-the-", "x-api-path-slug"=>"teamsteamidmembersusername-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"teamId", "description"=>"Id of team"}, {"in"=>"path", "name"=>"username", "description"=>"Name of a member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Team", "Members", "Username"]}}, "/teams/{teamId}/memberships/{username}"=>{"delete"=>{"summary"=>"Delete Teams Team Memberships Username", "description"=>"Remove team membership.\nIn order to remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. NOTE: This does not delete the user, it just removes their membership from the team.", "operationId"=>"remove-team-membershipin-order-to-remove-a-membership-between-a-user-and-a-team-the-authenticated-us", "x-api-path-slug"=>"teamsteamidmembershipsusername-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"teamId", "description"=>"Id of team"}, {"in"=>"path", "name"=>"username", "description"=>"Name of a member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Team", "Memberships", "Username"]}, "get"=>{"summary"=>"Get Teams Team Memberships Username", "description"=>"Get team membership.\nIn order to get a user's membership with a team, the authenticated user must be a member of the team or an owner of the team's organization.", "operationId"=>"get-team-membershipin-order-to-get-a-users-membership-with-a-team-the-authenticated-user-must-be-a-m", "x-api-path-slug"=>"teamsteamidmembershipsusername-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"teamId", "description"=>"Id of team"}, {"in"=>"path", "name"=>"username", "description"=>"Name of a member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Team", "Memberships", "Username"]}, "put"=>{"summary"=>"Put Teams Team Memberships Username", "description"=>"Add team membership.\nIn order to add a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with.\n\nIf the user is already a part of the team's organization (meaning they're on at least one other team in the organization), this endpoint will add the user to the team.\n\nIf the user is completely unaffiliated with the team's organization (meaning they're on none of the organization's teams), this endpoint will send an invitation to the user via email. This newly-created membership will be in the 'pending' state until the user accepts the invitation, at which point the membership will transition to the 'active' state and the user will be added as a member of the team.", "operationId"=>"add-team-membershipin-order-to-add-a-membership-between-a-user-and-a-team-the-authenticated-user-mus", "x-api-path-slug"=>"teamsteamidmembershipsusername-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"teamId", "description"=>"Id of team"}, {"in"=>"path", "name"=>"username", "description"=>"Name of a member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Team", "Memberships", "Username"]}}, "/teams/{teamId}/repos"=>{"get"=>{"summary"=>"Get Teams Team Repos", "description"=>"List team repos", "operationId"=>"list-team-repos", "x-api-path-slug"=>"teamsteamidrepos-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"teamId", "description"=>"Id of team"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Team", "Repos"]}}, "/teams/{teamId}/repos/{org}/{repo}"=>{"put"=>{"summary"=>"Put Teams Team Repos Org Repo", "description"=>"In order to add a repository to a team, the authenticated user must be an owner of the org that the team is associated with. Also, the repository must be owned by the organization, or a direct fork of a repository owned by the organization.", "operationId"=>"in-order-to-add-a-repository-to-a-team-the-authenticated-user-must-be-an-owner-of-the-org-that-the-t", "x-api-path-slug"=>"teamsteamidreposorgrepo-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"org", "description"=>"Name of a organization"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of a repository"}, {"in"=>"path", "name"=>"teamId", "description"=>"Id of team"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Team", "Repos", "Org", "Repo"]}}, "/teams/{teamId}/repos/{owner}/{repo}"=>{"delete"=>{"summary"=>"Delete Teams Team Repos Owner Repo", "description"=>"In order to remove a repository from a team, the authenticated user must be an owner of the org that the team is associated with. NOTE: This does not delete the repository, it just removes it from the team.", "operationId"=>"in-order-to-remove-a-repository-from-a-team-the-authenticated-user-must-be-an-owner-of-the-org-that-", "x-api-path-slug"=>"teamsteamidreposownerrepo-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of a repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of a repository"}, {"in"=>"path", "name"=>"teamId", "description"=>"Id of team"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Team", "Repos", "Owner", "Repo"]}, "get"=>{"summary"=>"Get Teams Team Repos Owner Repo", "description"=>"Check if a team manages a repository", "operationId"=>"check-if-a-team-manages-a-repository", "x-api-path-slug"=>"teamsteamidreposownerrepo-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of a repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of a repository"}, {"in"=>"path", "name"=>"teamId", "description"=>"Id of team"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Team", "Repos", "Owner", "Repo"]}}, "/user"=>{"get"=>{"summary"=>"Get User", "description"=>"Get the authenticated user.", "operationId"=>"get-the-authenticated-user", "x-api-path-slug"=>"user-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "patch"=>{"summary"=>"Patch User", "description"=>"Update the authenticated user.", "operationId"=>"update-the-authenticated-user", "x-api-path-slug"=>"user-patch", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/user/emails"=>{"delete"=>{"summary"=>"Delete User Emails", "description"=>"Delete email address(es).\nYou can include a single email address or an array of addresses.", "operationId"=>"delete-email-addressesyou-can-include-a-single-email-address-or-an-array-of-addresses", "x-api-path-slug"=>"useremails-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Emails"]}, "get"=>{"summary"=>"Get User Emails", "description"=>"List email addresses for a user.\nIn the final version of the API, this method will return an array of hashes\nwith extended information for each email address indicating if the address\nhas been verified and if it's primary email address for GitHub.\nUntil API v3 is finalized, use the application/vnd.github.v3 media type to\nget other response format.", "operationId"=>"list-email-addresses-for-a-userin-the-final-version-of-the-api-this-method-will-return-an-array-of-h", "x-api-path-slug"=>"useremails-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Emails"]}, "post"=>{"summary"=>"Add User Emails", "description"=>"Add email address(es).\nYou can post a single email address or an array of addresses.", "operationId"=>"add-email-addressesyou-can-post-a-single-email-address-or-an-array-of-addresses", "x-api-path-slug"=>"useremails-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Emails"]}}, "/user/followers"=>{"get"=>{"summary"=>"Get User Followers", "description"=>"List the authenticated user's followers", "operationId"=>"list-the-authenticated-users-followers", "x-api-path-slug"=>"userfollowers-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Followers"]}}, "/user/following"=>{"get"=>{"summary"=>"Get User Following", "description"=>"List who the authenticated user is following.", "operationId"=>"list-who-the-authenticated-user-is-following", "x-api-path-slug"=>"userfollowing-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Following"]}}, "/user/following/{username}"=>{"delete"=>{"summary"=>"Delete User Following Username", "description"=>"Unfollow a user.\nUnfollowing a user requires the user to be logged in and authenticated with\nbasic auth or OAuth with the user:follow scope.", "operationId"=>"unfollow-a-userunfollowing-a-user-requires-the-user-to-be-logged-in-and-authenticated-withbasic-auth", "x-api-path-slug"=>"userfollowingusername-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"username", "description"=>"Name of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Following", "Username"]}, "get"=>{"summary"=>"Get User Following Username", "description"=>"Check if you are following a user.", "operationId"=>"check-if-you-are-following-a-user", "x-api-path-slug"=>"userfollowingusername-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"username", "description"=>"Name of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Following", "Username"]}, "put"=>{"summary"=>"Put User Following Username", "description"=>"Follow a user.\nFollowing a user requires the user to be logged in and authenticated with\nbasic auth or OAuth with the user:follow scope.", "operationId"=>"follow-a-userfollowing-a-user-requires-the-user-to-be-logged-in-and-authenticated-withbasic-auth-or-", "x-api-path-slug"=>"userfollowingusername-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"username", "description"=>"Name of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Following", "Username"]}}, "/user/issues"=>{"get"=>{"summary"=>"Get User Issues", "description"=>"List issues.\nList all issues across owned and member repositories for the authenticated\nuser.", "operationId"=>"list-issueslist-all-issues-across-owned-and-member-repositories-for-the-authenticateduser", "x-api-path-slug"=>"userissues-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"direction"}, {"in"=>"query", "name"=>"filter", "description"=>"Issues assigned to you / created by you / mentioning you / youresubscribed to updates for / All issues the authenticated user can see"}, {"in"=>"query", "name"=>"labels", "description"=>"String list of comma separated Label names"}, {"in"=>"query", "name"=>"since", "description"=>"Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Issues"]}}, "/user/keys"=>{"get"=>{"summary"=>"Get User Keys", "description"=>"List your public keys.\nLists the current user's keys. Management of public keys via the API requires\nthat you are authenticated through basic auth, or OAuth with the 'user', 'write:public_key' scopes.", "operationId"=>"list-your-public-keyslists-the-current-users-keys-management-of-public-keys-via-the-api-requiresthat", "x-api-path-slug"=>"userkeys-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Keys"]}, "post"=>{"summary"=>"Add User Keys", "description"=>"Create a public key.", "operationId"=>"create-a-public-key", "x-api-path-slug"=>"userkeys-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Keys"]}}, "/user/keys/{keyId}"=>{"delete"=>{"summary"=>"Delete User Keys Key", "description"=>"Delete a public key. Removes a public key. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:public_key scope.", "operationId"=>"delete-a-public-key-removes-a-public-key-requires-that-you-are-authenticated-via-basic-auth-or-via-o", "x-api-path-slug"=>"userkeyskeyid-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"keyId", "description"=>"ID of key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Keys", "Key"]}, "get"=>{"summary"=>"Get User Keys Key", "description"=>"Get a single public key.", "operationId"=>"get-a-single-public-key", "x-api-path-slug"=>"userkeyskeyid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"keyId", "description"=>"ID of key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Keys", "Key"]}}, "/user/orgs"=>{"get"=>{"summary"=>"Get User Orgs", "description"=>"List public and private organizations for the authenticated user.", "operationId"=>"list-public-and-private-organizations-for-the-authenticated-user", "x-api-path-slug"=>"userorgs-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Orgs"]}}, "/user/repos"=>{"get"=>{"summary"=>"Get User Repos", "description"=>"List repositories for the authenticated user. Note that this does not include\nrepositories owned by organizations which the user can access. You can lis\nuser organizations and list organization repositories separately.", "operationId"=>"list-repositories-for-the-authenticated-user-note-that-this-does-not-includerepositories-owned-by-or", "x-api-path-slug"=>"userrepos-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Repos"]}, "post"=>{"summary"=>"Add User Repos", "description"=>"Create a new repository for the authenticated user. OAuth users must supply\nrepo scope.", "operationId"=>"create-a-new-repository-for-the-authenticated-user-oauth-users-must-supplyrepo-scope", "x-api-path-slug"=>"userrepos-post", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Repos"]}}, "/user/starred"=>{"get"=>{"summary"=>"Get User Starred", "description"=>"List repositories being starred by the authenticated user.", "operationId"=>"list-repositories-being-starred-by-the-authenticated-user", "x-api-path-slug"=>"userstarred-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"direction", "description"=>"Ignored without sort parameter"}, {"in"=>"query", "name"=>"sort"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Starred"]}}, "/user/starred/{owner}/{repo}"=>{"delete"=>{"summary"=>"Delete User Starred Owner Repo", "description"=>"Unstar a repository", "operationId"=>"unstar-a-repository", "x-api-path-slug"=>"userstarredownerrepo-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of a repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of a repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Starred", "Owner", "Repo"]}, "get"=>{"summary"=>"Get User Starred Owner Repo", "description"=>"Check if you are starring a repository.", "operationId"=>"check-if-you-are-starring-a-repository", "x-api-path-slug"=>"userstarredownerrepo-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of a repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of a repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Starred", "Owner", "Repo"]}, "put"=>{"summary"=>"Put User Starred Owner Repo", "description"=>"Star a repository.", "operationId"=>"star-a-repository", "x-api-path-slug"=>"userstarredownerrepo-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of a repository owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of a repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Starred", "Owner", "Repo"]}}, "/user/subscriptions"=>{"get"=>{"summary"=>"Get User Subscriptions", "description"=>"List repositories being watched by the authenticated user.", "operationId"=>"list-repositories-being-watched-by-the-authenticated-user", "x-api-path-slug"=>"usersubscriptions-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Subscriptions"]}}, "/user/subscriptions/{owner}/{repo}"=>{"delete"=>{"summary"=>"Delete User Subscriptions Owner Repo", "description"=>"Stop watching a repository", "operationId"=>"stop-watching-a-repository", "x-api-path-slug"=>"usersubscriptionsownerrepo-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of the owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Subscriptions", "Owner", "Repo"]}, "get"=>{"summary"=>"Get User Subscriptions Owner Repo", "description"=>"Check if you are watching a repository.", "operationId"=>"check-if-you-are-watching-a-repository", "x-api-path-slug"=>"usersubscriptionsownerrepo-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of the owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Subscriptions", "Owner", "Repo"]}, "put"=>{"summary"=>"Put User Subscriptions Owner Repo", "description"=>"Watch a repository.", "operationId"=>"watch-a-repository", "x-api-path-slug"=>"usersubscriptionsownerrepo-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"owner", "description"=>"Name of the owner"}, {"in"=>"path", "name"=>"repo", "description"=>"Name of repository"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Subscriptions", "Owner", "Repo"]}}, "/user/teams"=>{"get"=>{"summary"=>"Get User Teams", "description"=>"List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user or repo scope when authenticating via OAuth.", "operationId"=>"list-all-of-the-teams-across-all-of-the-organizations-to-which-the-authenticated-user-belongs-this-m", "x-api-path-slug"=>"userteams-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Teams"]}}, "/users"=>{"get"=>{"summary"=>"Get Users", "description"=>"Get all users.\nThis provides a dump of every user, in the order that they signed up for GitHub.\nNote: Pagination is powered exclusively by the since parameter. Use the Link\nheader to get the URL for the next page of users.", "operationId"=>"get-all-usersthis-provides-a-dump-of-every-user-in-the-order-that-they-signed-up-for-githubnote-pagi", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"since", "description"=>"The integer ID of the last User that youve seen"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/{username}"=>{"get"=>{"summary"=>"Get Users Username", "description"=>"Get a single user.", "operationId"=>"get-a-single-user", "x-api-path-slug"=>"usersusername-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"username", "description"=>"Name of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username"]}}, "/users/{username}/events"=>{"get"=>{"summary"=>"Get Users Username Events", "description"=>"If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", "operationId"=>"if-you-are-authenticated-as-the-given-user-you-will-see-your-private-events-otherwise-youll-only-see", "x-api-path-slug"=>"usersusernameevents-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"username", "description"=>"Name of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Events"]}}, "/users/{username}/events/orgs/{org}"=>{"get"=>{"summary"=>"Get Users Username Events Orgs Org", "description"=>"This is the user's organization dashboard. You must be authenticated as the user to view this.", "operationId"=>"this-is-the-users-organization-dashboard-you-must-be-authenticated-as-the-user-to-view-this", "x-api-path-slug"=>"usersusernameeventsorgsorg-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"org"}, {"in"=>"path", "name"=>"username", "description"=>"Name of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Events", "Orgs", "Org"]}}, "/users/{username}/followers"=>{"get"=>{"summary"=>"Get Users Username Followers", "description"=>"List a user's followers", "operationId"=>"list-a-users-followers", "x-api-path-slug"=>"usersusernamefollowers-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"username", "description"=>"Name of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Followers"]}}, "/users/{username}/following/{targetUser}"=>{"get"=>{"summary"=>"Get Users Username Following Targetuser", "description"=>"Check if one user follows another.", "operationId"=>"check-if-one-user-follows-another", "x-api-path-slug"=>"usersusernamefollowingtargetuser-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"targetUser", "description"=>"Name of user"}, {"in"=>"path", "name"=>"username", "description"=>"Name of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Following", "Targetuser"]}}, "/users/{username}/gists"=>{"get"=>{"summary"=>"Get Users Username Gists", "description"=>"List a users gists.", "operationId"=>"list-a-users-gists", "x-api-path-slug"=>"usersusernamegists-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"since", "description"=>"The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ"}, {"in"=>"path", "name"=>"username", "description"=>"Name of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Gists"]}}, "/users/{username}/keys"=>{"get"=>{"summary"=>"Get Users Username Keys", "description"=>"List public keys for a user.\nLists the verified public keys for a user. This is accessible by anyone.", "operationId"=>"list-public-keys-for-a-userlists-the-verified-public-keys-for-a-user-this-is-accessible-by-anyone", "x-api-path-slug"=>"usersusernamekeys-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"username", "description"=>"Name of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Keys"]}}, "/users/{username}/orgs"=>{"get"=>{"summary"=>"Get Users Username Orgs", "description"=>"List all public organizations for a user.", "operationId"=>"list-all-public-organizations-for-a-user", "x-api-path-slug"=>"usersusernameorgs-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"username", "description"=>"Name of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Orgs"]}}, "/users/{username}/received_events"=>{"get"=>{"summary"=>"Get Users Username Received Events", "description"=>"These are events that you'll only see public events.", "operationId"=>"these-are-events-that-youll-only-see-public-events", "x-api-path-slug"=>"usersusernamereceived-events-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"username", "description"=>"Name of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Received", "Events"]}}, "/users/{username}/received_events/public"=>{"get"=>{"summary"=>"Get Users Username Received Events Public", "description"=>"List public events that a user has received", "operationId"=>"list-public-events-that-a-user-has-received", "x-api-path-slug"=>"usersusernamereceived-eventspublic-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"username", "description"=>"Name of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Received", "Events", "Public"]}}, "/users/{username}/repos"=>{"get"=>{"summary"=>"Get Users Username Repos", "description"=>"List public repositories for the specified user.", "operationId"=>"list-public-repositories-for-the-specified-user", "x-api-path-slug"=>"usersusernamerepos-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"query", "name"=>"type"}, {"in"=>"path", "name"=>"username", "description"=>"Name of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Repos"]}}, "/users/{username}/starred"=>{"get"=>{"summary"=>"Get Users Username Starred", "description"=>"List repositories being starred by a user.", "operationId"=>"list-repositories-being-starred-by-a-user", "x-api-path-slug"=>"usersusernamestarred-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"username", "description"=>"Name of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Starred"]}}, "/users/{username}/subscriptions"=>{"get"=>{"summary"=>"Get Users Username Subscriptions", "description"=>"List repositories being watched by a user.", "operationId"=>"list-repositories-being-watched-by-a-user", "x-api-path-slug"=>"usersusernamesubscriptions-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Is used to set specified media type"}, {"in"=>"query", "name"=>"access_token", "description"=>"Your Github OAuth token"}, {"in"=>"path", "name"=>"username", "description"=>"Name of user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Subscriptions"]}}, "/organizations"=>{"get"=>{"summary"=>"Get Organizations", "description"=>"Get all organizations", "operationId"=>"getOrganizations", "x-api-path-slug"=>"organizations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}}}, "apis"=>{"name"=>"GitHub", "x-slug"=>"github", "description"=>"GitHub brings together the worlds largest community of developers to discover, share, and build better software. From open source projects to private team repositories, were your all-in-one platform for collaborative development.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/github-logo.png", "x-kinRank"=>"10", "x-alexaRank"=>"64", "tags"=>"API Provider,API Service Provider,Change Log Example,Code,Coding,Developers,General Data,Hacker Storytelling,Historical Data API,Imports,Issue Management,Issues,Jobs,Management,My API Stack,Pedestal,Profiles,Programming,Relative Data,Relative StreamRank,SaaS,Social,Social,Stack,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"github/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Github", "x-api-slug"=>"github", "description"=>"GitHub brings together the worlds largest community of developers to discover, share, and build better software. From open source projects to private team repositories, were your all-in-one platform for collaborative development.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/github-logo.png", "humanURL"=>"https://github.com", "baseURL"=>"https://api.github.com//", "tags"=>"API Provider,API Service Provider,Change Log Example,Code,Coding,Developers,General Data,Hacker Storytelling,Historical Data API,Imports,Issue Management,Issues,Jobs,Management,My API Stack,Pedestal,Profiles,Programming,Relative Data,Relative StreamRank,SaaS,Social,Social,Stack,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/github/organizations-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/github/github-openapi.yaml"}]}], "x-common"=>[{"type"=>"x--net-library", "url"=>"https://github.com/octokit/octokit.net"}, {"type"=>"x-base", "url"=>"https://api.github.com"}, {"type"=>"x-blog", "url"=>"http://github.com/blog"}, {"type"=>"x-blog-rss", "url"=>"https://github.com/blog/subscribe"}, {"type"=>"x-change-log", "url"=>"https://developer.github.com/changes/"}, {"type"=>"x-contact-form", "url"=>"https://github.com/contact"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/github"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/github"}, {"type"=>"x-developer", "url"=>"https://developer.github.com/"}, {"type"=>"x-github", "url"=>"https://github.com/github"}, {"type"=>"x-guides", "url"=>"https://developer.github.com/guides/"}, {"type"=>"x-ios-sdk", "url"=>"https://github.com/octokit/octokit.objc"}, {"type"=>"x-pricing", "url"=>"https://github.com/pricing"}, {"type"=>"x-privacy", "url"=>"http://help.github.com/privacy-policy/"}, {"type"=>"x-ruby-library", "url"=>"https://github.com/octokit/octokit.rb"}, {"type"=>"x-security", "url"=>"http://help.github.com/security/"}, {"type"=>"x-status", "url"=>"https://status.github.com/"}, {"type"=>"x-terms-of-service", "url"=>"http://help.github.com/terms-of-service/"}, {"type"=>"x-transparency-report", "url"=>"https://blog.github.com/2018-05-11-2017-transparency-report/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/github"}, {"type"=>"x-webhooks", "url"=>"https://developer.github.com/webhooks/"}, {"type"=>"x-website", "url"=>"https://github.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
data2crm{"data2crm-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Data2CRM", "x-complete"=>1, "info"=>{"title"=>"Data2CRM.API", "description"=>"pmake-use-of-our-indepth-documentation-to-get-more-information-about-the-various-functions-of-the-service--those-willing-to-explore-the-mechanics-of-data2crm-api-can-test-it-in-live-regime-using-the-short-code-samples-ppselect-crm-span-iddocsselectcrm-stylefontweight-boldloading----please-waitspanpphere-are-the-api-access-keysbrbxapi2crmuserkeyb-span-iddocsuserkeye2a6379ab878ae7e58119d4ec842bf9c926e05b5spanbrbxapi2crmcrmkeyb-span-iddocscrmkey7ae5b17008fb414d84981191cf3b66a476ef8befspanpp-iddocscrmaccessthe-crm-access-details-arebrburlb-a-iddocscrmurl-hrefhttpslogin-salesforce-com-target-blankhttpslogin-salesforce-comabrbemail--usernameb-span-iddocscrmusernamedevelopers-data2crm-api1magneticone-comspanbrbpasswordb-span-iddocscrmpassworddata2crmapi123spanp", "version"=>"1"}, "host"=>"api.data2crm.com:80", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/account"=>{"get"=>{"summary"=>"GET for Account", "description"=>"Returns all accounts from the system", "operationId"=>"getAccountCollection", "x-api-path-slug"=>"account-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter"}, {"in"=>"query", "name"=>"limit", "description"=>"Amount of results (default: 25)"}, {"in"=>"query", "name"=>"offset", "description"=>"Start from record (default: 0)"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-DATA-ENABLE", "description"=>"Data Enable"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}, "post"=>{"summary"=>"POST for Account", "description"=>"Add account into the system", "operationId"=>"createAccountEntity", "x-api-path-slug"=>"account-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Add account into the system", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/account/count"=>{"get"=>{"summary"=>"COUNT for Account", "description"=>"Count all accounts from the system", "operationId"=>"getAccountCountCollection", "x-api-path-slug"=>"accountcount-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Count"]}}, "/account/describe"=>{"get"=>{"summary"=>"DESCRIBE for Account", "description"=>"Returns describe for accounts", "operationId"=>"getAccountDescribe", "x-api-path-slug"=>"accountdescribe-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts", "Describe"]}}, "/account/{account_id}"=>{"delete"=>{"summary"=>"DELETE for Account", "description"=>"Delete account information", "operationId"=>"deleteAccountEntity", "x-api-path-slug"=>"accountaccount-id-delete", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"Account Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}, "get"=>{"summary"=>"GET for Account", "description"=>"Return account information", "operationId"=>"getAccountEntity", "x-api-path-slug"=>"accountaccount-id-get", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"Account Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}, "put"=>{"summary"=>"PUT for Account", "description"=>"Update account information", "operationId"=>"updateAccountEntity", "x-api-path-slug"=>"accountaccount-id-put", "parameters"=>[{"in"=>"path", "name"=>"account_id", "description"=>"Account Identifier"}, {"in"=>"body", "name"=>"body", "description"=>"Update account information", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/attachment"=>{"get"=>{"summary"=>"GET for Attachment", "description"=>"Returns all attachments from the system", "operationId"=>"getAttachmentCollection", "x-api-path-slug"=>"attachment-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter"}, {"in"=>"query", "name"=>"limit", "description"=>"Amount of results (default: 25)"}, {"in"=>"query", "name"=>"offset", "description"=>"Start from record (default: 0)"}, {"in"=>"query", "name"=>"parent_id", "description"=>"Parent Identifier"}, {"in"=>"query", "name"=>"parent_type", "description"=>"Parent Type"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-DATA-ENABLE", "description"=>"Data Enable"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachments"]}, "post"=>{"summary"=>"POST for Attachment", "description"=>"Add attachment into the system", "operationId"=>"createAttachmentEntity", "x-api-path-slug"=>"attachment-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Add attachment into the system", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachments"]}}, "/attachment/count"=>{"get"=>{"summary"=>"COUNT for Attachment", "description"=>"Count all attachments from the system", "operationId"=>"getAttachmentCountCollection", "x-api-path-slug"=>"attachmentcount-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachments", "Count"]}}, "/attachment/describe"=>{"get"=>{"summary"=>"DESCRIBE for Attachment", "description"=>"Returns describe for attachments", "operationId"=>"getAttachmentDescribe", "x-api-path-slug"=>"attachmentdescribe-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachments", "Describe"]}}, "/attachment/{attachment_id}"=>{"delete"=>{"summary"=>"DELETE for Attachment", "description"=>"Delete attachment information", "operationId"=>"deleteAttachmentEntity", "x-api-path-slug"=>"attachmentattachment-id-delete", "parameters"=>[{"in"=>"path", "name"=>"attachment_id", "description"=>"Attachment Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachments"]}, "get"=>{"summary"=>"GET for Attachment", "description"=>"Return attachment information", "operationId"=>"getAttachmentEntity", "x-api-path-slug"=>"attachmentattachment-id-get", "parameters"=>[{"in"=>"path", "name"=>"attachment_id", "description"=>"Attachment Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachments"]}, "put"=>{"summary"=>"PUT for Attachment", "description"=>"Update attachment information", "operationId"=>"updateAttachmentEntity", "x-api-path-slug"=>"attachmentattachment-id-put", "parameters"=>[{"in"=>"path", "name"=>"attachment_id", "description"=>"Attachment Identifier"}, {"in"=>"body", "name"=>"body", "description"=>"Update attachment information", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachments"]}}, "/call"=>{"get"=>{"summary"=>"GET for Call", "description"=>"Returns all calls from the system", "operationId"=>"getCallCollection", "x-api-path-slug"=>"call-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter"}, {"in"=>"query", "name"=>"limit", "description"=>"Amount of results (default: 25)"}, {"in"=>"query", "name"=>"offset", "description"=>"Start from record (default: 0)"}, {"in"=>"query", "name"=>"parent_id", "description"=>"Parent Identifier"}, {"in"=>"query", "name"=>"parent_type", "description"=>"Parent Type"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-DATA-ENABLE", "description"=>"Data Enable"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls"]}, "post"=>{"summary"=>"POST for Call", "description"=>"Add call into the system", "operationId"=>"createCallEntity", "x-api-path-slug"=>"call-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Add call into the system", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls"]}}, "/call/count"=>{"get"=>{"summary"=>"COUNT for Call", "description"=>"Count all calls from the system", "operationId"=>"getCallCountCollection", "x-api-path-slug"=>"callcount-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Count"]}}, "/call/describe"=>{"get"=>{"summary"=>"DESCRIBE for Call", "description"=>"Returns describe for calls", "operationId"=>"getCallDescribe", "x-api-path-slug"=>"calldescribe-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls", "Describe"]}}, "/call/{call_id}"=>{"delete"=>{"summary"=>"DELETE for Call", "description"=>"Delete call information", "operationId"=>"deleteCallEntity", "x-api-path-slug"=>"callcall-id-delete", "parameters"=>[{"in"=>"path", "name"=>"call_id", "description"=>"Call Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls"]}, "get"=>{"summary"=>"GET for Call", "description"=>"Return call information", "operationId"=>"getCallEntity", "x-api-path-slug"=>"callcall-id-get", "parameters"=>[{"in"=>"path", "name"=>"call_id", "description"=>"Call Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls"]}, "put"=>{"summary"=>"PUT for Call", "description"=>"Update call information", "operationId"=>"updateCallEntity", "x-api-path-slug"=>"callcall-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Update call information", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"call_id", "description"=>"Call Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls"]}}, "/contact"=>{"get"=>{"summary"=>"GET for Contact", "description"=>"Returns all contacts from the system", "operationId"=>"getContactCollection", "x-api-path-slug"=>"contact-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter"}, {"in"=>"query", "name"=>"limit", "description"=>"Amount of results (default: 25)"}, {"in"=>"query", "name"=>"offset", "description"=>"Start from record (default: 0)"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-DATA-ENABLE", "description"=>"Data Enable"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}, "post"=>{"summary"=>"POST for Contact", "description"=>"Add contact into the system", "operationId"=>"createContactEntity", "x-api-path-slug"=>"contact-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Add contact into the system", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}}, "/contact/count"=>{"get"=>{"summary"=>"COUNT for Contact", "description"=>"Count all contacts from the system", "operationId"=>"getContactCountCollection", "x-api-path-slug"=>"contactcount-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Count"]}}, "/contact/describe"=>{"get"=>{"summary"=>"DESCRIBE for Contact", "description"=>"Returns describe for contacts", "operationId"=>"getContactDescribe", "x-api-path-slug"=>"contactdescribe-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Describe"]}}, "/contact/{contact_id}"=>{"delete"=>{"summary"=>"DELETE for Contact", "description"=>"Delete contact information", "operationId"=>"deleteContactEntity", "x-api-path-slug"=>"contactcontact-id-delete", "parameters"=>[{"in"=>"path", "name"=>"contact_id", "description"=>"Contact Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}, "get"=>{"summary"=>"GET for Contact", "description"=>"Return contact information", "operationId"=>"getContactEntity", "x-api-path-slug"=>"contactcontact-id-get", "parameters"=>[{"in"=>"path", "name"=>"contact_id", "description"=>"Contact Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}, "put"=>{"summary"=>"PUT for Contact", "description"=>"Update contact information", "operationId"=>"updateContactEntity", "x-api-path-slug"=>"contactcontact-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Update contact information", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"contact_id", "description"=>"Contact Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}}, "/crm"=>{"get"=>{"summary"=>"GET for Crm", "description"=>"Returns all CRMs from the system", "operationId"=>"getCrmCollection", "x-api-path-slug"=>"crm-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter"}, {"in"=>"query", "name"=>"limit", "description"=>"Amount of results (default: 25)"}, {"in"=>"query", "name"=>"offset", "description"=>"Start from record (default: 0)"}, {"in"=>"query", "name"=>"type", "description"=>"Type"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CRM"]}, "post"=>{"summary"=>"POST for Crm", "description"=>"Add CRM into the systemWhat do I need to connect a CRM to Data2CRM.API?", "operationId"=>"createCrmEntity", "x-api-path-slug"=>"crm-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Add CRM into the systemWhat do I need to connect a CRM to Data2CRM", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CRM"]}}, "/crm/count"=>{"get"=>{"summary"=>"COUNT for Crm", "description"=>"Count all CRMs from the system", "operationId"=>"getCrmCountCollection", "x-api-path-slug"=>"crmcount-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Crm", "Count"]}}, "/crm/{crm_id}"=>{"delete"=>{"summary"=>"DELETE for Crm", "description"=>"Delete CRM information", "operationId"=>"deleteCrmEntity", "x-api-path-slug"=>"crmcrm-id-delete", "parameters"=>[{"in"=>"path", "name"=>"crm_id", "description"=>"CRM Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CRM"]}, "get"=>{"summary"=>"GET for Crm", "description"=>"Return CRM information", "operationId"=>"getCrmEntity", "x-api-path-slug"=>"crmcrm-id-get", "parameters"=>[{"in"=>"path", "name"=>"crm_id", "description"=>"CRM Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CRM"]}, "put"=>{"summary"=>"PUT for Crm", "description"=>"Update CRM informationWhat do I need to connect a CRM to Data2CRM.API?", "operationId"=>"updateCrmEntity", "x-api-path-slug"=>"crmcrm-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Update CRM informationWhat do I need to connect a CRM to Data2CRM", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"crm_id", "description"=>"CRM Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CRM"]}}, "/customField"=>{"get"=>{"summary"=>"GET for CustomField", "description"=>"Returns all custom field from the system", "operationId"=>"getCustomFieldCollection", "x-api-path-slug"=>"customfield-get", "parameters"=>[{"in"=>"query", "name"=>"entity", "description"=>"Entity"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter"}, {"in"=>"query", "name"=>"label", "description"=>"Label"}, {"in"=>"query", "name"=>"limit", "description"=>"Amount of results (default: 25)"}, {"in"=>"query", "name"=>"name", "description"=>"Name"}, {"in"=>"query", "name"=>"offset", "description"=>"Start from record (default: 0)"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-DATA-ENABLE", "description"=>"Data Enable"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Fields"]}, "post"=>{"summary"=>"POST for CustomField", "description"=>"Add custom field into the system", "operationId"=>"createCustomFieldEntity", "x-api-path-slug"=>"customfield-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Add custom field into the system", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Fields"]}}, "/customField/{custom_field_id}"=>{"delete"=>{"summary"=>"DELETE for CustomField", "description"=>"Delete custom field information", "operationId"=>"deleteCustomFieldEntity", "x-api-path-slug"=>"customfieldcustom-field-id-delete", "parameters"=>[{"in"=>"path", "name"=>"custom_field_id", "description"=>"Custom Field Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Fields", "Custom", "Field"]}, "get"=>{"summary"=>"GET for CustomField", "description"=>"Return custom field information", "operationId"=>"getCustomFieldEntity", "x-api-path-slug"=>"customfieldcustom-field-id-get", "parameters"=>[{"in"=>"path", "name"=>"custom_field_id", "description"=>"Custom Field Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Fields", "Custom", "Field"]}, "put"=>{"summary"=>"PUT for CustomField", "description"=>"Update custom field information", "operationId"=>"updateCustomFieldEntity", "x-api-path-slug"=>"customfieldcustom-field-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Update custom field information", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"custom_field_id", "description"=>"Custom Field Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Fields", "Custom", "Field"]}}, "/email"=>{"get"=>{"summary"=>"GET for Email", "description"=>"Returns all emails from the system", "operationId"=>"getEmailCollection", "x-api-path-slug"=>"email-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter"}, {"in"=>"query", "name"=>"limit", "description"=>"Amount of results (default: 25)"}, {"in"=>"query", "name"=>"offset", "description"=>"Start from record (default: 0)"}, {"in"=>"query", "name"=>"parent_id", "description"=>"Parent Identifier"}, {"in"=>"query", "name"=>"parent_type", "description"=>"Parent Type"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-DATA-ENABLE", "description"=>"Data Enable"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Emails"]}, "post"=>{"summary"=>"POST for Email", "description"=>"Add email into the system", "operationId"=>"createEmailEntity", "x-api-path-slug"=>"email-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Add email into the system", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Emails"]}}, "/email/count"=>{"get"=>{"summary"=>"COUNT for Email", "description"=>"Count all emails from the system", "operationId"=>"getEmailCountCollection", "x-api-path-slug"=>"emailcount-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Emails", "Count"]}}, "/email/describe"=>{"get"=>{"summary"=>"DESCRIBE for Email", "description"=>"Returns describe for emails", "operationId"=>"getEmailDescribe", "x-api-path-slug"=>"emaildescribe-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Emails", "Describe"]}}, "/email/{email_id}"=>{"delete"=>{"summary"=>"DELETE for Email", "description"=>"Delete email information", "operationId"=>"deleteEmailEntity", "x-api-path-slug"=>"emailemail-id-delete", "parameters"=>[{"in"=>"path", "name"=>"email_id", "description"=>"Email Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Emails"]}, "get"=>{"summary"=>"GET for Email", "description"=>"Return email information", "operationId"=>"getEmailEntity", "x-api-path-slug"=>"emailemail-id-get", "parameters"=>[{"in"=>"path", "name"=>"email_id", "description"=>"Email Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Emails"]}, "put"=>{"summary"=>"PUT for Email", "description"=>"Update email information", "operationId"=>"updateEmailEntity", "x-api-path-slug"=>"emailemail-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Update email information", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"email_id", "description"=>"Email Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Emails"]}}, "/event"=>{"get"=>{"summary"=>"GET for Event", "description"=>"Returns all events from the system", "operationId"=>"getEventCollection", "x-api-path-slug"=>"event-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter"}, {"in"=>"query", "name"=>"limit", "description"=>"Amount of results (default: 25)"}, {"in"=>"query", "name"=>"offset", "description"=>"Start from record (default: 0)"}, {"in"=>"query", "name"=>"parent_id", "description"=>"Parent Identifier"}, {"in"=>"query", "name"=>"parent_type", "description"=>"Parent Type"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-DATA-ENABLE", "description"=>"Data Enable"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}, "post"=>{"summary"=>"POST for Event", "description"=>"Add event into the system", "operationId"=>"createEventEntity", "x-api-path-slug"=>"event-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Add event into the system", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/event/count"=>{"get"=>{"summary"=>"COUNT for Event", "description"=>"Count all events from the system", "operationId"=>"getEventCountCollection", "x-api-path-slug"=>"eventcount-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Count"]}}, "/event/describe"=>{"get"=>{"summary"=>"DESCRIBE for Event", "description"=>"Returns describe for events", "operationId"=>"getEventDescribe", "x-api-path-slug"=>"eventdescribe-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Describe"]}}, "/event/{event_id}"=>{"delete"=>{"summary"=>"DELETE for Event", "description"=>"Delete event information", "operationId"=>"deleteEventEntity", "x-api-path-slug"=>"eventevent-id-delete", "parameters"=>[{"in"=>"path", "name"=>"event_id", "description"=>"Event Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}, "get"=>{"summary"=>"GET for Event", "description"=>"Return event information", "operationId"=>"getEventEntity", "x-api-path-slug"=>"eventevent-id-get", "parameters"=>[{"in"=>"path", "name"=>"event_id", "description"=>"Event Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}, "put"=>{"summary"=>"PUT for Event", "description"=>"Update event information", "operationId"=>"updateEventEntity", "x-api-path-slug"=>"eventevent-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Update event information", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"event_id", "description"=>"Event Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/lead"=>{"get"=>{"summary"=>"GET for Lead", "description"=>"Returns all leads from the system", "operationId"=>"getLeadCollection", "x-api-path-slug"=>"lead-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter"}, {"in"=>"query", "name"=>"limit", "description"=>"Amount of results (default: 25)"}, {"in"=>"query", "name"=>"offset", "description"=>"Start from record (default: 0)"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-DATA-ENABLE", "description"=>"Data Enable"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads"]}, "post"=>{"summary"=>"POST for Lead", "description"=>"Add lead into the system", "operationId"=>"createLeadEntity", "x-api-path-slug"=>"lead-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Add lead into the system", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads"]}}, "/lead/count"=>{"get"=>{"summary"=>"COUNT for Lead", "description"=>"Count all leads from the system", "operationId"=>"getLeadCountCollection", "x-api-path-slug"=>"leadcount-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Count"]}}, "/lead/describe"=>{"get"=>{"summary"=>"DESCRIBE for Lead", "description"=>"Returns describe for leads", "operationId"=>"getLeadDescribe", "x-api-path-slug"=>"leaddescribe-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads", "Describe"]}}, "/lead/{lead_id}"=>{"delete"=>{"summary"=>"DELETE for Lead", "description"=>"Delete lead information", "operationId"=>"deleteLeadEntity", "x-api-path-slug"=>"leadlead-id-delete", "parameters"=>[{"in"=>"path", "name"=>"lead_id", "description"=>"Lead Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads"]}, "get"=>{"summary"=>"GET for Lead", "description"=>"Return lead information", "operationId"=>"getLeadEntity", "x-api-path-slug"=>"leadlead-id-get", "parameters"=>[{"in"=>"path", "name"=>"lead_id", "description"=>"Lead Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads"]}, "put"=>{"summary"=>"PUT for Lead", "description"=>"Update lead information", "operationId"=>"updateLeadEntity", "x-api-path-slug"=>"leadlead-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Update lead information", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"lead_id", "description"=>"Lead Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leads"]}}, "/meeting"=>{"get"=>{"summary"=>"GET for Meeting", "description"=>"Returns all meetings from the system", "operationId"=>"getMeetingCollection", "x-api-path-slug"=>"meeting-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter"}, {"in"=>"query", "name"=>"limit", "description"=>"Amount of results (default: 25)"}, {"in"=>"query", "name"=>"offset", "description"=>"Start from record (default: 0)"}, {"in"=>"query", "name"=>"parent_id", "description"=>"Parent Identifier"}, {"in"=>"query", "name"=>"parent_type", "description"=>"Parent Type"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-DATA-ENABLE", "description"=>"Data Enable"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meeting"]}, "post"=>{"summary"=>"POST for Meeting", "description"=>"Add meeting into the system", "operationId"=>"createMeetingEntity", "x-api-path-slug"=>"meeting-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Add meeting into the system", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meeting"]}}, "/meeting/count"=>{"get"=>{"summary"=>"COUNT for Meeting", "description"=>"Count all meetings from the system", "operationId"=>"getMeetingCountCollection", "x-api-path-slug"=>"meetingcount-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meeting", "Count"]}}, "/meeting/describe"=>{"get"=>{"summary"=>"DESCRIBE for Meeting", "description"=>"Returns describe for meetings", "operationId"=>"getMeetingDescribe", "x-api-path-slug"=>"meetingdescribe-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meeting", "Describe"]}}, "/meeting/{meeting_id}"=>{"delete"=>{"summary"=>"DELETE for Meeting", "description"=>"Delete meeting information", "operationId"=>"deleteMeetingEntity", "x-api-path-slug"=>"meetingmeeting-id-delete", "parameters"=>[{"in"=>"path", "name"=>"meeting_id", "description"=>"Meeting Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meetings"]}, "get"=>{"summary"=>"GET for Meeting", "description"=>"Return meeting information", "operationId"=>"getMeetingEntity", "x-api-path-slug"=>"meetingmeeting-id-get", "parameters"=>[{"in"=>"path", "name"=>"meeting_id", "description"=>"Meeting Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meetings"]}, "put"=>{"summary"=>"PUT for Meeting", "description"=>"Update meeting information", "operationId"=>"updateMeetingEntity", "x-api-path-slug"=>"meetingmeeting-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Update meeting information", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"meeting_id", "description"=>"Meeting Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meetings"]}}, "/note"=>{"get"=>{"summary"=>"GET for Note", "description"=>"Returns all notes from the system", "operationId"=>"getNoteCollection", "x-api-path-slug"=>"note-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter"}, {"in"=>"query", "name"=>"limit", "description"=>"Amount of results (default: 25)"}, {"in"=>"query", "name"=>"offset", "description"=>"Start from record (default: 0)"}, {"in"=>"query", "name"=>"parent_id", "description"=>"Parent Identifier"}, {"in"=>"query", "name"=>"parent_type", "description"=>"Parent Type"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-DATA-ENABLE", "description"=>"Data Enable"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Note"]}, "post"=>{"summary"=>"POST for Note", "description"=>"Add note into the system", "operationId"=>"createNoteEntity", "x-api-path-slug"=>"note-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Add note into the system", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Note"]}}, "/note/count"=>{"get"=>{"summary"=>"COUNT for Note", "description"=>"Count all notes from the system", "operationId"=>"getNoteCountCollection", "x-api-path-slug"=>"notecount-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Note", "Count"]}}, "/note/describe"=>{"get"=>{"summary"=>"DESCRIBE for Note", "description"=>"Returns describe for notes", "operationId"=>"getNoteDescribe", "x-api-path-slug"=>"notedescribe-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Note", "Describe"]}}, "/note/{note_id}"=>{"delete"=>{"summary"=>"DELETE for Note", "description"=>"Delete note information", "operationId"=>"deleteNoteEntity", "x-api-path-slug"=>"notenote-id-delete", "parameters"=>[{"in"=>"path", "name"=>"note_id", "description"=>"Note Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notes"]}, "get"=>{"summary"=>"GET for Note", "description"=>"Return note information", "operationId"=>"getNoteEntity", "x-api-path-slug"=>"notenote-id-get", "parameters"=>[{"in"=>"path", "name"=>"note_id", "description"=>"Note Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notes"]}, "put"=>{"summary"=>"PUT for Note", "description"=>"Update note information", "operationId"=>"updateNoteEntity", "x-api-path-slug"=>"notenote-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Update note information", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"note_id", "description"=>"Note Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notes"]}}, "/opportunity"=>{"get"=>{"summary"=>"GET for Opportunity", "description"=>"Returns all opportunities from the system", "operationId"=>"getOpportunityCollection", "x-api-path-slug"=>"opportunity-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter"}, {"in"=>"query", "name"=>"limit", "description"=>"Amount of results (default: 25)"}, {"in"=>"query", "name"=>"offset", "description"=>"Start from record (default: 0)"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-DATA-ENABLE", "description"=>"Data Enable"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Opportunities"]}, "post"=>{"summary"=>"POST for Opportunity", "description"=>"Add opportunity into the system", "operationId"=>"createOpportunityEntity", "x-api-path-slug"=>"opportunity-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Add opportunity into the system", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Opportunities"]}}, "/opportunity/count"=>{"get"=>{"summary"=>"COUNT for Opportunity", "description"=>"Count all opportunities from the system", "operationId"=>"getOpportunityCountCollection", "x-api-path-slug"=>"opportunitycount-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Opportunities", "Count"]}}, "/opportunity/describe"=>{"get"=>{"summary"=>"DESCRIBE for Opportunity", "description"=>"Returns describe for opportunities", "operationId"=>"getOpportunityDescribe", "x-api-path-slug"=>"opportunitydescribe-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Opportunities", "Describe"]}}, "/opportunity/{opportunity_id}"=>{"delete"=>{"summary"=>"DELETE for Opportunity", "description"=>"Delete opportunity information", "operationId"=>"deleteOpportunityEntity", "x-api-path-slug"=>"opportunityopportunity-id-delete", "parameters"=>[{"in"=>"path", "name"=>"opportunity_id", "description"=>"Opportunity Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Opportunities"]}, "get"=>{"summary"=>"GET for Opportunity", "description"=>"Return opportunity information", "operationId"=>"getOpportunityEntity", "x-api-path-slug"=>"opportunityopportunity-id-get", "parameters"=>[{"in"=>"path", "name"=>"opportunity_id", "description"=>"Opportunity Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Opportunities"]}, "put"=>{"summary"=>"PUT for Opportunity", "description"=>"Update opportunity information", "operationId"=>"updateOpportunityEntity", "x-api-path-slug"=>"opportunityopportunity-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Update opportunity information", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"opportunity_id", "description"=>"Opportunity Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Opportunities"]}}, "/task"=>{"get"=>{"summary"=>"GET for Task", "description"=>"Returns all tasks from the system", "operationId"=>"getTaskCollection", "x-api-path-slug"=>"task-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter"}, {"in"=>"query", "name"=>"limit", "description"=>"Amount of results (default: 25)"}, {"in"=>"query", "name"=>"offset", "description"=>"Start from record (default: 0)"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-DATA-ENABLE", "description"=>"Data Enable"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks"]}, "post"=>{"summary"=>"POST for Task", "description"=>"Add task into the system", "operationId"=>"createTaskEntity", "x-api-path-slug"=>"task-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Add task into the system", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks"]}}, "/task/count"=>{"get"=>{"summary"=>"COUNT for Task", "description"=>"Count all tasks from the system", "operationId"=>"getTaskCountCollection", "x-api-path-slug"=>"taskcount-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks", "Count"]}}, "/task/describe"=>{"get"=>{"summary"=>"DESCRIBE for Task", "description"=>"Returns describe for tasks", "operationId"=>"getTaskDescribe", "x-api-path-slug"=>"taskdescribe-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks", "Describe"]}}, "/task/{task_id}"=>{"delete"=>{"summary"=>"DELETE for Task", "description"=>"Delete task information", "operationId"=>"deleteTaskEntity", "x-api-path-slug"=>"tasktask-id-delete", "parameters"=>[{"in"=>"path", "name"=>"task_id", "description"=>"Task Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks"]}, "get"=>{"summary"=>"GET for Task", "description"=>"Return task information", "operationId"=>"getTaskEntity", "x-api-path-slug"=>"tasktask-id-get", "parameters"=>[{"in"=>"path", "name"=>"task_id", "description"=>"Task Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks"]}, "put"=>{"summary"=>"PUT for Task", "description"=>"Update task information", "operationId"=>"updateTaskEntity", "x-api-path-slug"=>"tasktask-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Update task information", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"task_id", "description"=>"Task Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks"]}}, "/user"=>{"get"=>{"summary"=>"GET for User", "description"=>"Returns all users from the system", "operationId"=>"getUserCollection", "x-api-path-slug"=>"user-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter"}, {"in"=>"query", "name"=>"limit", "description"=>"Amount of results (default: 25)"}, {"in"=>"query", "name"=>"offset", "description"=>"Start from record (default: 0)"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-DATA-ENABLE", "description"=>"Data Enable"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "post"=>{"summary"=>"POST for User", "description"=>"Add user into the system", "operationId"=>"createUserEntity", "x-api-path-slug"=>"user-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Add user into the system", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/user/count"=>{"get"=>{"summary"=>"COUNT for User", "description"=>"Count all users from the system", "operationId"=>"getUserCountCollection", "x-api-path-slug"=>"usercount-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Count"]}}, "/user/describe"=>{"get"=>{"summary"=>"DESCRIBE for User", "description"=>"Returns describe for users", "operationId"=>"getUserDescribe", "x-api-path-slug"=>"userdescribe-get", "parameters"=>[{"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Describe"]}}, "/user/{user_id}"=>{"delete"=>{"summary"=>"DELETE for User", "description"=>"Delete user information", "operationId"=>"deleteUserEntity", "x-api-path-slug"=>"useruser-id-delete", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"User Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "get"=>{"summary"=>"GET for User", "description"=>"Return user information", "operationId"=>"getUserEntity", "x-api-path-slug"=>"useruser-id-get", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"User Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "put"=>{"summary"=>"PUT for User", "description"=>"Update user information", "operationId"=>"updateUserEntity", "x-api-path-slug"=>"useruser-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Update user information", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"User Identifier"}, {"in"=>"header", "name"=>"X-API2CRM-CRMKEY", "description"=>"CRM Key"}, {"in"=>"header", "name"=>"X-API2CRM-USERKEY", "description"=>"User Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}}}, "apis"=>{"name"=>"Data2CRM", "x-slug"=>"data2crm", "description"=>"Data2CRM is all-in-one master touch instrument to create the perfect data environment for prosperous internal and external connections.Data2CRM.API, a Unified API Provider, to Connect Your Business Software with 17+ CRMs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/data2crm-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,CRM,Migrations,Profiles,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"data2crm/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Data2CRM", "x-api-slug"=>"data2crm", "description"=>"Data2CRM is all-in-one master touch instrument to create the perfect data environment for prosperous internal and external connections.Data2CRM.API, a Unified API Provider, to Connect Your Business Software with 17+ CRMs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/data2crm-logo.png", "humanURL"=>"http://data2crm.com", "baseURL"=>"https://api.data2crm.com:80//v1", "tags"=>"API Provider,CRM,Migrations,Profiles,Relative Data,Service API", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/data2crm/data2crm-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-twitter", "url"=>"https://twitter.com/data2crm"}, {"type"=>"x-website", "url"=>"http://data2crm.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
rotten-tomatoes{"apis"=>{"name"=>"Rotten Tomatoes", "x-slug"=>"rotten-tomatoes", "description"=>"Rotten Tomatoes is a website launched in August 1998 devoted to film reviews and news; it is widely known as a film review aggregator. Coverage now includes TV content as well. The name derives from the practice of audiences throwing rotten tomatoes when disapproving of a poor stage performance. The company was created by Senh Duong and since January 2010 has been owned by Flixster, which itself was acquired in 2011 by Warner Bros.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/rotten-tomatoes-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"General Data,Movies,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"rotten-tomatoes/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Rotten Tomatoes", "x-api-slug"=>"rotten-tomatoes", "description"=>"Rotten Tomatoes is a website containing information about movies: information, news, reviews and ratings, pictures, etx. The Rotten Tomatoes API is RESTful web service that was designed to be easy to explore and use. Developers can use the API to access the Rotten Tomatoes' database of movie data by using the Lists, Movies, or DVDs sections of the API.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/rotten-tomatoes-logo.png", "humanURL"=>"http://rottentomatoes.com", "baseURL"=>"https://api.rottentomatoes.com//api/public/v1.0", "tags"=>"General Data,Movies,Service API", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/rotten-tomatoes/moviesidsimilar-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/rotten-tomatoes/rotten-tomatoes-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"http://developer.rottentomatoes.com/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/RottenTomatoes"}, {"type"=>"x-website", "url"=>"http://rottentomatoes.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "rotten-tomatoes-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Rotten Tomatoes", "x-complete"=>1, "info"=>{"title"=>"Rotten Tomatoes", "description"=>"test-our-api-services-using-io-docs-", "contact"=>{"name"=>"Mike Ralphson", "url"=>"https://github.com/mermade/mashery2openapi", "email"=>"mike.ralphson@gmail.com"}, "version"=>"1.0"}, "host"=>"api.rottentomatoes.com", "basePath"=>"/api/public/v1.0", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/lists.json"=>{"get"=>{"summary"=>"Get Lists", "description"=>"Get lists.json.", "operationId"=>"getLists.json", "x-api-path-slug"=>"lists-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists"]}}, "/lists/dvds.json"=>{"get"=>{"summary"=>"Get Lists Dvds", "description"=>"Get lists dvds.json.", "operationId"=>"getListsDvds.json", "x-api-path-slug"=>"listsdvds-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Dvds"]}}, "/lists/dvds/current_releases.json"=>{"get"=>{"summary"=>"Get Lists Dvds Current Releases", "description"=>"Get lists dvds current releases.json.", "operationId"=>"getListsDvdsCurrentReleases.json", "x-api-path-slug"=>"listsdvdscurrent-releases-json-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"Provides localized data for the selected country (ISO 3166-1 alpha-2) if available"}, {"in"=>"query", "name"=>"page", "description"=>"The selected page of current DVD releases"}, {"in"=>"query", "name"=>"page_limit", "description"=>"The amount of new release dvds to show per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Dvds", "Current", "Releases"]}}, "/lists/dvds/new_releases.json"=>{"get"=>{"summary"=>"Get Lists Dvds New Releases", "description"=>"Get lists dvds new releases.json.", "operationId"=>"getListsDvdsNewReleases.json", "x-api-path-slug"=>"listsdvdsnew-releases-json-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"Provides localized data for the selected country (ISO 3166-1 alpha-2) if available"}, {"in"=>"query", "name"=>"page", "description"=>"The selected page of new release DVDs"}, {"in"=>"query", "name"=>"page_limit", "description"=>"The amount of new release dvds to show per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Dvds", "New", "Releases"]}}, "/lists/dvds/top_rentals.json"=>{"get"=>{"summary"=>"Get Lists Dvds Top Rentals", "description"=>"Get lists dvds top rentals.json.", "operationId"=>"getListsDvdsTopRentals.json", "x-api-path-slug"=>"listsdvdstop-rentals-json-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"Provides localized data for the selected country (ISO 3166-1 alpha-2) if available"}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of top rentals returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Dvds", "Top", "Rentals"]}}, "/lists/dvds/upcoming.json"=>{"get"=>{"summary"=>"Get Lists Dvds Upcoming", "description"=>"Get lists dvds upcoming.json.", "operationId"=>"getListsDvdsUpcoming.json", "x-api-path-slug"=>"listsdvdsupcoming-json-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"Provides localized data for the selected country (ISO 3166-1 alpha-2) if available"}, {"in"=>"query", "name"=>"page", "description"=>"The selected page of upcoming DVDs"}, {"in"=>"query", "name"=>"page_limit", "description"=>"The amount of upcoming dvds to show per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Dvds", "Upcoming"]}}, "/lists/movies.json"=>{"get"=>{"summary"=>"Get Lists Movies", "description"=>"Get lists movies.json.", "operationId"=>"getListsMovies.json", "x-api-path-slug"=>"listsmovies-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Movies"]}}, "/lists/movies/box_office.json"=>{"get"=>{"summary"=>"Get Lists Movies Box Office", "description"=>"Get lists movies box office.json.", "operationId"=>"getListsMoviesBoxOffice.json", "x-api-path-slug"=>"listsmoviesbox-office-json-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"Provides localized data for the selected country (ISO 3166-1 alpha-2) if available"}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of movies returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Movies", "Box", "Office"]}}, "/lists/movies/in_theaters.json"=>{"get"=>{"summary"=>"Get Lists Movies In Theaters", "description"=>"Get lists movies in theaters.json.", "operationId"=>"getListsMoviesInTheaters.json", "x-api-path-slug"=>"listsmoviesin-theaters-json-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"Provides localized data for the selected country (ISO 3166-1 alpha-2) if available"}, {"in"=>"query", "name"=>"page", "description"=>"The selected page of in theaters movies"}, {"in"=>"query", "name"=>"page_limit", "description"=>"The amount of movies in theaters to show per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Movies", "In", "Theaters"]}}, "/lists/movies/opening.json"=>{"get"=>{"summary"=>"Get Lists Movies Opening", "description"=>"Get lists movies opening.json.", "operationId"=>"getListsMoviesOpening.json", "x-api-path-slug"=>"listsmoviesopening-json-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"Provides localized data for the selected country (ISO 3166-1 alpha-2) if available"}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of opening movies returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Movies", "Opening"]}}, "/lists/movies/upcoming.json"=>{"get"=>{"summary"=>"Get Lists Movies Upcoming", "description"=>"Get lists movies upcoming.json.", "operationId"=>"getListsMoviesUpcoming.json", "x-api-path-slug"=>"listsmoviesupcoming-json-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"Provides localized data for the selected country (ISO 3166-1 alpha-2) if available"}, {"in"=>"query", "name"=>"page", "description"=>"The selected page of upcoming movies"}, {"in"=>"query", "name"=>"page_limit", "description"=>"The amount of upcoming movies to show per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Movies", "Upcoming"]}}, "/movie_alias.json"=>{"get"=>{"summary"=>"Get Movie Alias", "description"=>"Get movie alias.json.", "operationId"=>"getMovieAlias.json", "x-api-path-slug"=>"movie-alias-json-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"Movie ID"}, {"in"=>"query", "name"=>"type", "description"=>"Only supports imdb lookup at this time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movie", "Alias"]}}, "/movies.json"=>{"get"=>{"summary"=>"Get Movies", "description"=>"Get movies.json.", "operationId"=>"getMovies.json", "x-api-path-slug"=>"movies-json-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The selected page of movie search results"}, {"in"=>"query", "name"=>"page_limit", "description"=>"The amount of movie search results to show per page"}, {"in"=>"query", "name"=>"q", "description"=>"The plain text search query to search for a movie"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies"]}}, "/movies/{id}.json"=>{"get"=>{"summary"=>"Get Movies", "description"=>"Get movies .json.", "operationId"=>"getMovies.json", "x-api-path-slug"=>"moviesid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Movie ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies"]}}, "/movies/{id}/cast.json"=>{"get"=>{"summary"=>"Get Movies Cast", "description"=>"Get movies cast.json.", "operationId"=>"getMoviesCast.json", "x-api-path-slug"=>"moviesidcast-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Movie ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies", "Cast"]}}, "/movies/{id}/clips.json"=>{"get"=>{"summary"=>"Get Movies Clips", "description"=>"Get movies clips.json.", "operationId"=>"getMoviesClips.json", "x-api-path-slug"=>"moviesidclips-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Movie ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies", "Clips"]}}, "/movies/{id}/reviews.json"=>{"get"=>{"summary"=>"Get Movies Reviews", "description"=>"Get movies reviews.json.", "operationId"=>"getMoviesReviews.json", "x-api-path-slug"=>"moviesidreviews-json-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"Provides localized data for the selected country (ISO 3166-1 alpha-2) if available"}, {"in"=>"path", "name"=>"id", "description"=>"Movie ID"}, {"in"=>"query", "name"=>"page", "description"=>"The selected page of reviews"}, {"in"=>"query", "name"=>"page_limit", "description"=>"The number of reviews to show per page"}, {"in"=>"query", "name"=>"review_type", "description"=>"3 different review types are possible: all, top_critic and dvd"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies", "Reviews"]}}, "/movies/{id}/similar.json"=>{"get"=>{"summary"=>"Get Movies Similar", "description"=>"Get movies similar.json.", "operationId"=>"getMoviesSimilar.json", "x-api-path-slug"=>"moviesidsimilar-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Movie ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit the number of similar movies to show"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies", "Similar"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
facebook{"facebook-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Facebook", "x-complete"=>1, "info"=>{"title"=>"Facebook", "description"=>"connect-to-the-social-network-with-the-graph-api-", "version"=>"1.0.0"}, "host"=>"graph.facebook.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/search"=>{"get"=>{"summary"=>"Get Search", "description"=>"Search over all public objects in the social graph", "operationId"=>"getSearch", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The search string"}, {"in"=>"query", "name"=>"type", "description"=>"Supports these types of objects: All public posts (post), people (user), pages (page), events (event), groups (group), check-ins (checkin)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}, "/{album}"=>{"get"=>{"summary"=>"Get Album", "description"=>"A photo album", "operationId"=>"getAlbum", "x-api-path-slug"=>"album-get", "parameters"=>[{"in"=>"path", "name"=>"album", "description"=>"Represents the ID of the album object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Album"]}}, "/{album}/photos"=>{"get"=>{"summary"=>"Get Album Photos", "description"=>"The photos contained in this album", "operationId"=>"getAlbumPhotos", "x-api-path-slug"=>"albumphotos-get", "parameters"=>[{"in"=>"path", "name"=>"album", "description"=>"Represents the ID of the album object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Album", "Photos"]}, "post"=>{"summary"=>"Post Album Photos", "description"=>"Adds a photo to the album", "operationId"=>"postAlbumPhotos", "x-api-path-slug"=>"albumphotos-post", "parameters"=>[{"in"=>"path", "name"=>"album", "description"=>"Represents the ID of the album object"}, {"in"=>"query", "name"=>"message", "description"=>"Photo description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Album", "Photos"]}}, "/{album}/likes"=>{"get"=>{"summary"=>"Get Album Likes", "description"=>"The likes made on this album", "operationId"=>"getAlbumLikes", "x-api-path-slug"=>"albumlikes-get", "parameters"=>[{"in"=>"path", "name"=>"album", "description"=>"Represents the ID of the album object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Album", "Likes"]}, "post"=>{"summary"=>"Post Album Likes", "description"=>"Likes the album", "operationId"=>"postAlbumLikes", "x-api-path-slug"=>"albumlikes-post", "parameters"=>[{"in"=>"path", "name"=>"album", "description"=>"Represents the ID of the album object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Album", "Likes"]}, "delete"=>{"summary"=>"Delete Album Likes", "description"=>"Unlikes the album", "operationId"=>"deleteAlbumLikes", "x-api-path-slug"=>"albumlikes-delete", "parameters"=>[{"in"=>"path", "name"=>"album", "description"=>"Represents the ID of the album object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Album", "Likes"]}}, "/{album}/comments"=>{"get"=>{"summary"=>"Get Album Comments", "description"=>"The comments made on this album", "operationId"=>"getAlbumComments", "x-api-path-slug"=>"albumcomments-get", "parameters"=>[{"in"=>"path", "name"=>"album", "description"=>"Represents the ID of the album object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Album", "Comments"]}, "post"=>{"summary"=>"Post Album Comments", "description"=>"Posts a comment on the album", "operationId"=>"postAlbumComments", "x-api-path-slug"=>"albumcomments-post", "parameters"=>[{"in"=>"path", "name"=>"album", "description"=>"Represents the ID of the album object"}, {"in"=>"query", "name"=>"message", "description"=>"Comment text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Album", "Comments"]}}, "/{album}/picture"=>{"get"=>{"summary"=>"Get Album Picture", "description"=>"The album's cover photo; the first picture uploaded to an album becomes the cover photo for the album.", "operationId"=>"getAlbumPicture", "x-api-path-slug"=>"albumpicture-get", "parameters"=>[{"in"=>"path", "name"=>"album", "description"=>"Represents the ID of the album object"}, {"in"=>"query", "name"=>"type", "description"=>"One of square (50x50), small (50 pixels wide, variable height), and large (about 200 pixels wide, variable height)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Album", "Picture"]}}, "/{application}"=>{"get"=>{"summary"=>"Get Application", "description"=>"An application's profile", "operationId"=>"getApplication", "x-api-path-slug"=>"application-get", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}}, "/{application}/accounts"=>{"get"=>{"summary"=>"Get Application Accounts", "description"=>"Test User accounts associated with the application.", "operationId"=>"getApplicationAccounts", "x-api-path-slug"=>"applicationaccounts-get", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Accounts"]}}, "/{application}/accounts/test-users"=>{"post"=>{"summary"=>"Post Application Accounts Test Users", "description"=>"Creates a test account for the application", "operationId"=>"postApplicationAccountsTestUsers", "x-api-path-slug"=>"applicationaccountstestusers-post", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}, {"in"=>"query", "name"=>"installed", "description"=>"Install app for the test user upon creation"}, {"in"=>"query", "name"=>"name", "description"=>"A name for the test user"}, {"in"=>"query", "name"=>"permissions", "description"=>"List of extended permissions app granted for the new test user if installed is true"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Accounts", "Test", "Users"]}}, "/{application}/albums"=>{"get"=>{"summary"=>"Get Application Albums", "description"=>"The photo albums this application has created.", "operationId"=>"getApplicationAlbums", "x-api-path-slug"=>"applicationalbums-get", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Albums"]}}, "/{application}/feed"=>{"get"=>{"summary"=>"Get Application Feed", "description"=>"The application's wall.", "operationId"=>"getApplicationFeed", "x-api-path-slug"=>"applicationfeed-get", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Feed"]}, "post"=>{"summary"=>"Post Application Feed", "description"=>"Posts a status message on the application's profile page", "operationId"=>"postApplicationFeed", "x-api-path-slug"=>"applicationfeed-post", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}, {"in"=>"query", "name"=>"message", "description"=>"Status Message content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Feed"]}}, "/{application}/insights"=>{"get"=>{"summary"=>"Get Application Insights", "description"=>"Usage metrics for this application", "operationId"=>"getApplicationInsights", "x-api-path-slug"=>"applicationinsights-get", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Insights"]}}, "/{application}/links"=>{"get"=>{"summary"=>"Get Application Links", "description"=>"The application's posted links.", "operationId"=>"getApplicationLinks", "x-api-path-slug"=>"applicationlinks-get", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Links"]}, "post"=>{"summary"=>"Post Application Links", "description"=>"Posts a link on the application's profile page", "operationId"=>"postApplicationLinks", "x-api-path-slug"=>"applicationlinks-post", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}, {"in"=>"query", "name"=>"link", "description"=>"Link URL"}, {"in"=>"query", "name"=>"message", "description"=>"Link message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Links"]}}, "/{application}/picture"=>{"get"=>{"summary"=>"Get Application Picture", "description"=>"The application's logo", "operationId"=>"getApplicationPicture", "x-api-path-slug"=>"applicationpicture-get", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}, {"in"=>"query", "name"=>"type", "description"=>"One of square (50x50), small (50 pixels wide, variable height), and large (about 200 pixels wide, variable height)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Picture"]}}, "/{application}/posts"=>{"get"=>{"summary"=>"Get Application Adds", "description"=>"The application's own posts.", "operationId"=>"getApplicationAdds", "x-api-path-slug"=>"applicationposts-get", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Posts"]}}, "/{application}/reviews"=>{"get"=>{"summary"=>"Get Application Reviews", "description"=>"Reviews of this application", "operationId"=>"getApplicationReviews", "x-api-path-slug"=>"applicationreviews-get", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Reviews"]}}, "/{application}/staticresources"=>{"get"=>{"summary"=>"Get Application Staticresources", "description"=>"Usage stats about the canvas application's static resources, such as javascript and CSS, and which ones are being flushed to browsers early.", "operationId"=>"getApplicationStaticresources", "x-api-path-slug"=>"applicationstaticresources-get", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Staticresources"]}}, "/{application}/statuses"=>{"get"=>{"summary"=>"Get Application Statuses", "description"=>"The application's status updates", "operationId"=>"getApplicationStatuses", "x-api-path-slug"=>"applicationstatuses-get", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Statuses"]}, "post"=>{"summary"=>"Post Application Statuses", "description"=>"Posts a status message on the application's profile page", "operationId"=>"postApplicationStatuses", "x-api-path-slug"=>"applicationstatuses-post", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}, {"in"=>"query", "name"=>"message", "description"=>"Status Message content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Statuses"]}}, "/{application}/subscriptions"=>{"get"=>{"summary"=>"Get Application Subscriptions", "description"=>"All of the subscriptions this application has for real-time notifications.", "operationId"=>"getApplicationSubscriptions", "x-api-path-slug"=>"applicationsubscriptions-get", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Subscriptions"]}, "post"=>{"summary"=>"Post Application Subscriptions", "description"=>"Adds a real-time notification subscription for this application.", "operationId"=>"postApplicationSubscriptions", "x-api-path-slug"=>"applicationsubscriptions-post", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}, {"in"=>"query", "name"=>"callback_url", "description"=>"A callback URL to which Facebook will post subscription updates"}, {"in"=>"query", "name"=>"fields", "description"=>"List of properties for the `object` to monitor"}, {"in"=>"query", "name"=>"object", "description"=>"Object to monitor - `user`, `permissions`, or `page`"}, {"in"=>"query", "name"=>"verify_token", "description"=>"Token sent in the verification request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Subscriptions"]}, "delete"=>{"summary"=>"Delete Application Subscriptions", "description"=>"Deletes a real-time notification subscription for this application.", "operationId"=>"deleteApplicationSubscriptions", "x-api-path-slug"=>"applicationsubscriptions-delete", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}, {"in"=>"query", "name"=>"object", "description"=>"Object to monitor - `user`, `permissions`, or `page`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Subscriptions"]}}, "/{application}/tagged"=>{"get"=>{"summary"=>"Get Application Tagged", "description"=>"The photos, videos, and posts in which this application has been tagged.", "operationId"=>"getApplicationTagged", "x-api-path-slug"=>"applicationtagged-get", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Tagged"]}}, "/{application}/translations"=>{"get"=>{"summary"=>"Get Application Translations", "description"=>"The translated strings for this application.", "operationId"=>"getApplicationTranslations", "x-api-path-slug"=>"applicationtranslations-get", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Translations"]}, "post"=>{"summary"=>"Post Application Translations", "description"=>"Uploads translated strings for this application.", "operationId"=>"postApplicationTranslations", "x-api-path-slug"=>"applicationtranslations-post", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}, {"in"=>"query", "name"=>"native_strings", "description"=>"A JSON-encoded array of strings to translate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Translations"]}, "delete"=>{"summary"=>"Delete Application Translations", "description"=>"Deletes a translation string for this application.", "operationId"=>"deleteApplicationTranslations", "x-api-path-slug"=>"applicationtranslations-delete", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}, {"in"=>"query", "name"=>"native_hashes", "description"=>"An array of native hashes"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Translations"]}}, "/{application}/scores"=>{"get"=>{"summary"=>"Get Application Scores", "description"=>"Scores for the user and their friends.", "operationId"=>"getApplicationScores", "x-api-path-slug"=>"applicationscores-get", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Scores"]}, "delete"=>{"summary"=>"Delete Application Scores", "description"=>"Deletes all the scores for the application.", "operationId"=>"deleteApplicationScores", "x-api-path-slug"=>"applicationscores-delete", "parameters"=>[{"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Scores"]}}, "/{application}/achievements"=>{"post"=>{"summary"=>"Post Application Achievements", "description"=>"Registers an achievement for the application", "operationId"=>"postApplicationAchievements", "x-api-path-slug"=>"applicationachievements-post", "parameters"=>[{"in"=>"query", "name"=>"achievement", "description"=>"Unique URL to the achievement"}, {"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}, {"in"=>"query", "name"=>"display_order", "description"=>"Order of this achievement as it shows up in the achievement stories UI (low to high)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Achievements"]}, "delete"=>{"summary"=>"Delete Application Achievements", "description"=>"Unregisters an achievement for the application", "operationId"=>"deleteApplicationAchievements", "x-api-path-slug"=>"applicationachievements-delete", "parameters"=>[{"in"=>"query", "name"=>"achievement", "description"=>"Unique URL to the achievement"}, {"in"=>"path", "name"=>"application", "description"=>"Represents the ID of the application object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application", "Achievements"]}}, "/{checkin}"=>{"get"=>{"summary"=>"Get Checkin", "description"=>"Represents a single visit by a user to a location", "operationId"=>"getCheckin", "x-api-path-slug"=>"checkin-get", "parameters"=>[{"in"=>"path", "name"=>"checkin", "description"=>"Represents the ID of the checkin object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkin"]}}, "/{checkin}/comments"=>{"get"=>{"summary"=>"Get Checkin Comments", "description"=>"All of the comments on this checkin.", "operationId"=>"getCheckinComments", "x-api-path-slug"=>"checkincomments-get", "parameters"=>[{"in"=>"path", "name"=>"checkin", "description"=>"Represents the ID of the checkin object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkin", "Comments"]}, "post"=>{"summary"=>"Post Checkin Comments", "description"=>"Posts a comment to this checkin.", "operationId"=>"postCheckinComments", "x-api-path-slug"=>"checkincomments-post", "parameters"=>[{"in"=>"path", "name"=>"checkin", "description"=>"Represents the ID of the checkin object"}, {"in"=>"query", "name"=>"message", "description"=>"Comment text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkin", "Comments"]}}, "/{checkin}/likes"=>{"get"=>{"summary"=>"Get Checkin Likes", "description"=>"Users who like this checkin.", "operationId"=>"getCheckinLikes", "x-api-path-slug"=>"checkinlikes-get", "parameters"=>[{"in"=>"path", "name"=>"checkin", "description"=>"Represents the ID of the checkin object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkin", "Likes"]}, "post"=>{"summary"=>"Post Checkin Likes", "description"=>"Likes this checkin.", "operationId"=>"postCheckinLikes", "x-api-path-slug"=>"checkinlikes-post", "parameters"=>[{"in"=>"path", "name"=>"checkin", "description"=>"Represents the ID of the checkin object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkin", "Likes"]}, "delete"=>{"summary"=>"Delete Checkin Likes", "description"=>"Unlikes this checkin.", "operationId"=>"deleteCheckinLikes", "x-api-path-slug"=>"checkinlikes-delete", "parameters"=>[{"in"=>"path", "name"=>"checkin", "description"=>"Represents the ID of the checkin object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkin", "Likes"]}}, "/{comment}"=>{"get"=>{"summary"=>"Get Comment", "description"=>"Returns a comment", "operationId"=>"getComment", "x-api-path-slug"=>"comment-get", "parameters"=>[{"in"=>"path", "name"=>"comment", "description"=>"Represents the ID of the comment object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment"]}, "delete"=>{"summary"=>"Delete Comment", "description"=>"Deletes a comment", "operationId"=>"deleteComment", "x-api-path-slug"=>"comment-delete", "parameters"=>[{"in"=>"path", "name"=>"comment", "description"=>"Represents the ID of the comment object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment"]}}, "/{comment}/likes"=>{"get"=>{"summary"=>"Get Comment Likes", "description"=>"All the likes on this comment", "operationId"=>"getCommentLikes", "x-api-path-slug"=>"commentlikes-get", "parameters"=>[{"in"=>"path", "name"=>"comment", "description"=>"Represents the ID of the comment object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment", "Likes"]}, "post"=>{"summary"=>"Post Comment Likes", "description"=>"Likes the comment", "operationId"=>"postCommentLikes", "x-api-path-slug"=>"commentlikes-post", "parameters"=>[{"in"=>"path", "name"=>"comment", "description"=>"Represents the ID of the comment object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment", "Likes"]}, "delete"=>{"summary"=>"Delete Comment Likes", "description"=>"Unlikes the comment", "operationId"=>"deleteCommentLikes", "x-api-path-slug"=>"commentlikes-delete", "parameters"=>[{"in"=>"path", "name"=>"comment", "description"=>"Represents the ID of the comment object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment", "Likes"]}}, "/{event}"=>{"get"=>{"summary"=>"Get Event", "description"=>"Specifies information about an event, including the location, event name, and which invitees plan to attend.", "operationId"=>"getEvent", "x-api-path-slug"=>"event-get", "parameters"=>[{"in"=>"path", "name"=>"event", "description"=>"Represents the ID of the event object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/{event}/feed"=>{"get"=>{"summary"=>"Get Event Feed", "description"=>"This event's wall", "operationId"=>"getEventFeed", "x-api-path-slug"=>"eventfeed-get", "parameters"=>[{"in"=>"path", "name"=>"event", "description"=>"Represents the ID of the event object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Feed"]}, "post"=>{"summary"=>"Post Event Feed", "description"=>"Posts a status message on this event's wall", "operationId"=>"postEventFeed", "x-api-path-slug"=>"eventfeed-post", "parameters"=>[{"in"=>"path", "name"=>"event", "description"=>"Represents the ID of the event object"}, {"in"=>"query", "name"=>"message", "description"=>"Status Message content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Feed"]}}, "/{event}/noreply"=>{"get"=>{"summary"=>"Get Event Noreply", "description"=>"All of the users who have been not yet responded to their invitation to this event", "operationId"=>"getEventNoreply", "x-api-path-slug"=>"eventnoreply-get", "parameters"=>[{"in"=>"path", "name"=>"event", "description"=>"Represents the ID of the event object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Noreply"]}}, "/{event}/maybe"=>{"get"=>{"summary"=>"Get Event Maybe", "description"=>"All of the users who have been responded \"Maybe\" to their invitation to this event", "operationId"=>"getEventMaybe", "x-api-path-slug"=>"eventmaybe-get", "parameters"=>[{"in"=>"path", "name"=>"event", "description"=>"Represents the ID of the event object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Maybe"]}, "post"=>{"summary"=>"Post Event Maybe", "description"=>"RSVPs the user as a 'maybe' for the event", "operationId"=>"postEventMaybe", "x-api-path-slug"=>"eventmaybe-post", "parameters"=>[{"in"=>"path", "name"=>"event", "description"=>"Represents the ID of the event object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Maybe"]}}, "/{event}/invited"=>{"get"=>{"summary"=>"Get Event Invited", "description"=>"All of the users who have been invited to this event", "operationId"=>"getEventInvited", "x-api-path-slug"=>"eventinvited-get", "parameters"=>[{"in"=>"path", "name"=>"event", "description"=>"Represents the ID of the event object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Invited"]}}, "/{event}/attending"=>{"get"=>{"summary"=>"Get Event Attending", "description"=>"All of the users who are attending this event", "operationId"=>"getEventAttending", "x-api-path-slug"=>"eventattending-get", "parameters"=>[{"in"=>"path", "name"=>"event", "description"=>"Represents the ID of the event object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Attending"]}, "post"=>{"summary"=>"Post Event Attending", "description"=>"RSVPs the user as 'attending' for the event", "operationId"=>"postEventAttending", "x-api-path-slug"=>"eventattending-post", "parameters"=>[{"in"=>"path", "name"=>"event", "description"=>"Represents the ID of the event object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Attending"]}}, "/{event}/declined"=>{"get"=>{"summary"=>"Get Event Declined", "description"=>"All of the users who declined their invitation to this event", "operationId"=>"getEventDeclined", "x-api-path-slug"=>"eventdeclined-get", "parameters"=>[{"in"=>"path", "name"=>"event", "description"=>"Represents the ID of the event object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Declined"]}, "post"=>{"summary"=>"Post Event Declined", "description"=>"RSVPs the user as 'declined' for the event", "operationId"=>"postEventDeclined", "x-api-path-slug"=>"eventdeclined-post", "parameters"=>[{"in"=>"path", "name"=>"event", "description"=>"Represents the ID of the event object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Declined"]}}, "/{event}/picture"=>{"get"=>{"summary"=>"Get Event Picture", "description"=>"The event's profile picture", "operationId"=>"getEventPicture", "x-api-path-slug"=>"eventpicture-get", "parameters"=>[{"in"=>"path", "name"=>"event", "description"=>"Represents the ID of the event object"}, {"in"=>"query", "name"=>"type", "description"=>"One of square (50x50), small (50 pixels wide, variable height), and large (about 200 pixels wide, variable height)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Picture"]}}, "/{friendlist}"=>{"get"=>{"summary"=>"Get Friendlist", "description"=>"A Facebook friend list. This object represents the list itself and not the members of the list.", "operationId"=>"getFriendlist", "x-api-path-slug"=>"friendlist-get", "parameters"=>[{"in"=>"path", "name"=>"friendlist", "description"=>"Represents the ID of the FriendList object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Friendlist"]}, "delete"=>{"summary"=>"Delete Friendlist", "description"=>"Deletes the FriendList.", "operationId"=>"deleteFriendlist", "x-api-path-slug"=>"friendlist-delete", "parameters"=>[{"in"=>"path", "name"=>"friendlist", "description"=>"Represents the ID of the FriendList object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Friendlist"]}}, "/{friendlist}/members"=>{"get"=>{"summary"=>"Get Friendlist Members", "description"=>"All of the users who are members of this list.", "operationId"=>"getFriendlistMembers", "x-api-path-slug"=>"friendlistmembers-get", "parameters"=>[{"in"=>"path", "name"=>"friendlist", "description"=>"Represents the ID of the FriendList object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Friendlist", "Members"]}}, "/{friendlist}/members/{user}"=>{"post"=>{"summary"=>"Post Friendlist Members User", "description"=>"Adds a user to the friend list", "operationId"=>"postFriendlistMembersUser", "x-api-path-slug"=>"friendlistmembersuser-post", "parameters"=>[{"in"=>"path", "name"=>"friendlist", "description"=>"Represents the ID of the FriendList object"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the User to add to or remove from the friend list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Friendlist", "Members", "User"]}, "delete"=>{"summary"=>"Delete Friendlist Members User", "description"=>"Removes a user from the friend list", "operationId"=>"deleteFriendlistMembersUser", "x-api-path-slug"=>"friendlistmembersuser-delete", "parameters"=>[{"in"=>"path", "name"=>"friendlist", "description"=>"Represents the ID of the FriendList object"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the User to add to or remove from the friend list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Friendlist", "Members", "User"]}}, "/{group}"=>{"get"=>{"summary"=>"Get Group", "description"=>"A Facebook group", "operationId"=>"getGroup", "x-api-path-slug"=>"group-get", "parameters"=>[{"in"=>"path", "name"=>"group", "description"=>"Represents the ID of the group object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}}, "/{group}/feed"=>{"get"=>{"summary"=>"Get Group Feed", "description"=>"This group's wall", "operationId"=>"getGroupFeed", "x-api-path-slug"=>"groupfeed-get", "parameters"=>[{"in"=>"path", "name"=>"group", "description"=>"Represents the ID of the group object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Feed"]}, "post"=>{"summary"=>"Post Group Feed", "description"=>"Posts a status message on this group's wall", "operationId"=>"postGroupFeed", "x-api-path-slug"=>"groupfeed-post", "parameters"=>[{"in"=>"path", "name"=>"group", "description"=>"Represents the ID of the group object"}, {"in"=>"query", "name"=>"message", "description"=>"Status Message content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Feed"]}}, "/{group}/members"=>{"get"=>{"summary"=>"Get Group Members", "description"=>"All of the users who are members of this group", "operationId"=>"getGroupMembers", "x-api-path-slug"=>"groupmembers-get", "parameters"=>[{"in"=>"path", "name"=>"group", "description"=>"Represents the ID of the group object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Members"]}}, "/{group}/picture"=>{"get"=>{"summary"=>"Get Group Picture", "description"=>"The profile picture of this group", "operationId"=>"getGroupPicture", "x-api-path-slug"=>"grouppicture-get", "parameters"=>[{"in"=>"path", "name"=>"group", "description"=>"Represents the ID of the group object"}, {"in"=>"query", "name"=>"type", "description"=>"One of square (50x50), small (50 pixels wide, variable height), and large (about 200 pixels wide, variable height)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Picture"]}}, "/{group}/docs"=>{"get"=>{"summary"=>"Get Group Docs", "description"=>"The docs in this group", "operationId"=>"getGroupDocs", "x-api-path-slug"=>"groupdocs-get", "parameters"=>[{"in"=>"path", "name"=>"group", "description"=>"Represents the ID of the group object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Docs"]}}, "/{link}"=>{"get"=>{"summary"=>"Get Link", "description"=>"A link shared on a user's wall", "operationId"=>"getLink", "x-api-path-slug"=>"link-get", "parameters"=>[{"in"=>"path", "name"=>"link", "description"=>"Represents the ID of the link object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link"]}}, "/{link}/comments"=>{"get"=>{"summary"=>"Get Link Comments", "description"=>"All of the comments on this link.", "operationId"=>"getLinkComments", "x-api-path-slug"=>"linkcomments-get", "parameters"=>[{"in"=>"path", "name"=>"link", "description"=>"Represents the ID of the link object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Comments"]}, "post"=>{"summary"=>"Post Link Comments", "description"=>"Posts a comment to this link.", "operationId"=>"postLinkComments", "x-api-path-slug"=>"linkcomments-post", "parameters"=>[{"in"=>"path", "name"=>"link", "description"=>"Represents the ID of the link object"}, {"in"=>"query", "name"=>"message", "description"=>"Comment text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Comments"]}}, "/{link}/likes"=>{"get"=>{"summary"=>"Get Link Likes", "description"=>"Users who like this link.", "operationId"=>"getLinkLikes", "x-api-path-slug"=>"linklikes-get", "parameters"=>[{"in"=>"path", "name"=>"link", "description"=>"Represents the ID of the link object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Likes"]}, "post"=>{"summary"=>"Post Link Likes", "description"=>"Likes this link.", "operationId"=>"postLinkLikes", "x-api-path-slug"=>"linklikes-post", "parameters"=>[{"in"=>"path", "name"=>"link", "description"=>"Represents the ID of the link object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Likes"]}, "delete"=>{"summary"=>"Delete Link Likes", "description"=>"Unlikes this link.", "operationId"=>"deleteLinkLikes", "x-api-path-slug"=>"linklikes-delete", "parameters"=>[{"in"=>"path", "name"=>"link", "description"=>"Represents the ID of the link object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Link", "Likes"]}}, "/{note}"=>{"get"=>{"summary"=>"Get Note", "description"=>"A Facebook note", "operationId"=>"getNote", "x-api-path-slug"=>"note-get", "parameters"=>[{"in"=>"path", "name"=>"note", "description"=>"Represents the ID of the note object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Note"]}}, "/{note}/comments"=>{"get"=>{"summary"=>"Get Note Comments", "description"=>"All of the comments on this note.", "operationId"=>"getNoteComments", "x-api-path-slug"=>"notecomments-get", "parameters"=>[{"in"=>"path", "name"=>"note", "description"=>"Represents the ID of the note object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Note", "Comments"]}, "post"=>{"summary"=>"Post Note Comments", "description"=>"Posts a comment to this note.", "operationId"=>"postNoteComments", "x-api-path-slug"=>"notecomments-post", "parameters"=>[{"in"=>"query", "name"=>"message", "description"=>"Comment text"}, {"in"=>"path", "name"=>"note", "description"=>"Represents the ID of the note object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Note", "Comments"]}}, "/{note}/likes"=>{"get"=>{"summary"=>"Get Note Likes", "description"=>"Users who like this note.", "operationId"=>"getNoteLikes", "x-api-path-slug"=>"notelikes-get", "parameters"=>[{"in"=>"path", "name"=>"note", "description"=>"Represents the ID of the note object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Note", "Likes"]}, "post"=>{"summary"=>"Post Note Likes", "description"=>"Likes this note.", "operationId"=>"postNoteLikes", "x-api-path-slug"=>"notelikes-post", "parameters"=>[{"in"=>"path", "name"=>"note", "description"=>"Represents the ID of the note object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Note", "Likes"]}, "delete"=>{"summary"=>"Delete Note Likes", "description"=>"Unlikes this note.", "operationId"=>"deleteNoteLikes", "x-api-path-slug"=>"notelikes-delete", "parameters"=>[{"in"=>"path", "name"=>"note", "description"=>"Represents the ID of the note object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Note", "Likes"]}}, "/{page}"=>{"get"=>{"summary"=>"Get Page", "description"=>"Returns a Page", "operationId"=>"getPage", "x-api-path-slug"=>"page-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page"]}}, "/{page}/feed"=>{"get"=>{"summary"=>"Get Page Feed", "description"=>"This page's wall", "operationId"=>"getPageFeed", "x-api-path-slug"=>"pagefeed-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Feed"]}, "post"=>{"summary"=>"Post Page Feed", "description"=>"Posts a status message on this page's wall", "operationId"=>"postPageFeed", "x-api-path-slug"=>"pagefeed-post", "parameters"=>[{"in"=>"query", "name"=>"message", "description"=>"Status Message content"}, {"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Feed"]}}, "/{page}/picture"=>{"get"=>{"summary"=>"Get Page Picture", "description"=>"The page's profile picture", "operationId"=>"getPagePicture", "x-api-path-slug"=>"pagepicture-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}, {"in"=>"query", "name"=>"type", "description"=>"One of square (50x50), small (50 pixels wide, variable height), and large (about 200 pixels wide, variable height)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Picture"]}}, "/{page}/settings"=>{"get"=>{"summary"=>"Get Page Settings", "description"=>"The page's post permission settings", "operationId"=>"getPageSettings", "x-api-path-slug"=>"pagesettings-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Settings"]}, "post"=>{"summary"=>"Post Page Settings", "description"=>"The page's post permission settings", "operationId"=>"postPageSettings", "x-api-path-slug"=>"pagesettings-post", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}, {"in"=>"query", "name"=>"setting", "description"=>"Which single setting to update: USERS_CAN_POST, USERS_CAN_POST_PHOTOS, USERS_CAN_TAG_PHOTOS, USERS_CAN_POST_VIDEOS"}, {"in"=>"query", "name"=>"value", "description"=>"Connect to the social network with the Graph API"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Settings"]}}, "/{page}/tagged"=>{"get"=>{"summary"=>"Get Page Tagged", "description"=>"The photos, videos, and posts in which this page has been tagged", "operationId"=>"getPageTagged", "x-api-path-slug"=>"pagetagged-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Tagged"]}}, "/{page}/links"=>{"get"=>{"summary"=>"Get Page Links", "description"=>"The page's posted links", "operationId"=>"getPageLinks", "x-api-path-slug"=>"pagelinks-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Links"]}, "post"=>{"summary"=>"Post Page Links", "description"=>"Posts a link on the page", "operationId"=>"postPageLinks", "x-api-path-slug"=>"pagelinks-post", "parameters"=>[{"in"=>"query", "name"=>"link", "description"=>"Link URL"}, {"in"=>"query", "name"=>"message", "description"=>"Link message"}, {"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Links"]}}, "/{page}/photos"=>{"get"=>{"summary"=>"Get Page Photos", "description"=>"The photos contained on this page", "operationId"=>"getPagePhotos", "x-api-path-slug"=>"pagephotos-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Photos"]}, "post"=>{"summary"=>"Post Page Photos", "description"=>"Adds a photo to the page", "operationId"=>"postPagePhotos", "x-api-path-slug"=>"pagephotos-post", "parameters"=>[{"in"=>"query", "name"=>"message", "description"=>"Photo description"}, {"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Photos"]}}, "/{page}/groups"=>{"get"=>{"summary"=>"Get Page Groups", "description"=>"The groups this page is a member of", "operationId"=>"getPageGroups", "x-api-path-slug"=>"pagegroups-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Groups"]}}, "/{page}/albums"=>{"get"=>{"summary"=>"Get Page Albums", "description"=>"The photo albums this Page has uploaded", "operationId"=>"getPageAlbums", "x-api-path-slug"=>"pagealbums-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Albums"]}}, "/{page}/statuses"=>{"get"=>{"summary"=>"Get Page Statuses", "description"=>"The page's status updates", "operationId"=>"getPageStatuses", "x-api-path-slug"=>"pagestatuses-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Statuses"]}, "post"=>{"summary"=>"Post Page Statuses", "description"=>"Posts a status message on the page", "operationId"=>"postPageStatuses", "x-api-path-slug"=>"pagestatuses-post", "parameters"=>[{"in"=>"query", "name"=>"message", "description"=>"Status Message content"}, {"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Statuses"]}}, "/{page}/videos"=>{"get"=>{"summary"=>"Get Page Veos", "description"=>"The videos contained on this page", "operationId"=>"getPageVeos", "x-api-path-slug"=>"pagevideos-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Videos"]}, "post"=>{"summary"=>"Post Page Veos", "description"=>"Publishes a video to the page", "operationId"=>"postPageVeos", "x-api-path-slug"=>"pagevideos-post", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"Video description"}, {"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}, {"in"=>"query", "name"=>"title", "description"=>"Video title"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Videos"]}}, "/{page}/notes"=>{"get"=>{"summary"=>"Get Page Notes", "description"=>"The notes contained on this page", "operationId"=>"getPageNotes", "x-api-path-slug"=>"pagenotes-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Notes"]}, "post"=>{"summary"=>"Post Page Notes", "description"=>"Creates a note on the page", "operationId"=>"postPageNotes", "x-api-path-slug"=>"pagenotes-post", "parameters"=>[{"in"=>"query", "name"=>"message", "description"=>"Note content"}, {"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}, {"in"=>"query", "name"=>"subject", "description"=>"The subject of the Note"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Notes"]}}, "/{page}/posts"=>{"get"=>{"summary"=>"Get Page Adds", "description"=>"The page's own posts", "operationId"=>"getPageAdds", "x-api-path-slug"=>"pageposts-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Posts"]}}, "/{page}/events"=>{"get"=>{"summary"=>"Get Page Events", "description"=>"The events the Page is attending", "operationId"=>"getPageEvents", "x-api-path-slug"=>"pageevents-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Events"]}, "post"=>{"summary"=>"Post Page Events", "description"=>"Creates an event for the page", "operationId"=>"postPageEvents", "x-api-path-slug"=>"pageevents-post", "parameters"=>[{"in"=>"query", "name"=>"end_time", "description"=>"Event end time"}, {"in"=>"query", "name"=>"location", "description"=>"Event location"}, {"in"=>"query", "name"=>"message", "description"=>"Event description"}, {"in"=>"query", "name"=>"name", "description"=>"Event name"}, {"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}, {"in"=>"query", "name"=>"privacy_type", "description"=>"Event privacy setting"}, {"in"=>"query", "name"=>"start_time", "description"=>"Event start time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Events"]}}, "/{page}/checkins"=>{"get"=>{"summary"=>"Get Page Checkins", "description"=>"Checkins made to this Place Page by the current user, and friends of the current user", "operationId"=>"getPageCheckins", "x-api-path-slug"=>"pagecheckins-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Checkins"]}}, "/{page}/tabs"=>{"get"=>{"summary"=>"Get Page Tabs", "description"=>"The page's profile tabs", "operationId"=>"getPageTabs", "x-api-path-slug"=>"pagetabs-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Tabs"]}, "post"=>{"summary"=>"Post Page Tabs", "description"=>"Installs a profile tab at the end of the current list of installed tabs for the page", "operationId"=>"postPageTabs", "x-api-path-slug"=>"pagetabs-post", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"ID of the application for which to install the tab"}, {"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Tabs"]}}, "/{page}/tabs/{tab}"=>{"post"=>{"summary"=>"Post Page Tabs Tab", "description"=>"Updates an installed profile tab for a page", "operationId"=>"postPageTabsTab", "x-api-path-slug"=>"pagetabstab-post", "parameters"=>[{"in"=>"query", "name"=>"custom_name", "description"=>"Name to be used for the tab"}, {"in"=>"query", "name"=>"is_non_connection_landing_tab", "description"=>"Set this tab as the default landing tab for users who have not liked and are not admins of the Page"}, {"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}, {"in"=>"query", "name"=>"position", "description"=>"Order in which the tab will appear on the profile"}, {"in"=>"path", "name"=>"tab", "description"=>"Represents the ID of the tab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Tabs", "Tab"]}, "delete"=>{"summary"=>"Delete Page Tabs Tab", "description"=>"Deletes an installed profile tab (where is_permanent is not true) for a page", "operationId"=>"deletePageTabsTab", "x-api-path-slug"=>"pagetabstab-delete", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}, {"in"=>"path", "name"=>"tab", "description"=>"Represents the ID of the tab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Tabs", "Tab"]}}, "/{page}/admins"=>{"get"=>{"summary"=>"Get Page Admins", "description"=>"A list of the Page's admins.", "operationId"=>"getPageAdmins", "x-api-path-slug"=>"pageadmins-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Admins"]}}, "/{page}/blocked"=>{"get"=>{"summary"=>"Get Page Blocked", "description"=>"A list of the users blocked from the page.", "operationId"=>"getPageBlocked", "x-api-path-slug"=>"pageblocked-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Blocked"]}, "post"=>{"summary"=>"Post Page Blocked", "description"=>"Blocks a user (or users) from posting content to the page", "operationId"=>"postPageBlocked", "x-api-path-slug"=>"pageblocked-post", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}, {"in"=>"query", "name"=>"uids", "description"=>"Comma-separated list of the user IDs you wish to block"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Blocked"]}, "delete"=>{"summary"=>"Delete Page Blocked", "description"=>"Unblocks a user (or users) for the page", "operationId"=>"deletePageBlocked", "x-api-path-slug"=>"pageblocked-delete", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}, {"in"=>"query", "name"=>"uids", "description"=>"Comma-separated list of the user IDs you wish to unblock"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Blocked"]}}, "/{page}/blocked/{user}"=>{"get"=>{"summary"=>"Get Page Blocked User", "description"=>"Checks if a user is blocked from the page", "operationId"=>"getPageBlockedUser", "x-api-path-slug"=>"pageblockeduser-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page object"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page", "Blocked", "User"]}}, "/{photo}"=>{"get"=>{"summary"=>"Get Photo", "description"=>"An individual photo", "operationId"=>"getPhoto", "x-api-path-slug"=>"photo-get", "parameters"=>[{"in"=>"path", "name"=>"photo", "description"=>"Represents the ID of the photo object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo"]}}, "/{photo}/comments"=>{"get"=>{"summary"=>"Get Photo Comments", "description"=>"All of the comments on this photo.", "operationId"=>"getPhotoComments", "x-api-path-slug"=>"photocomments-get", "parameters"=>[{"in"=>"path", "name"=>"photo", "description"=>"Represents the ID of the photo object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo", "Comments"]}, "post"=>{"summary"=>"Post Photo Comments", "description"=>"Posts a comment to this photo.", "operationId"=>"postPhotoComments", "x-api-path-slug"=>"photocomments-post", "parameters"=>[{"in"=>"query", "name"=>"message", "description"=>"Comment text"}, {"in"=>"path", "name"=>"photo", "description"=>"Represents the ID of the photo object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo", "Comments"]}}, "/{photo}/likes"=>{"get"=>{"summary"=>"Get Photo Likes", "description"=>"Users who like this photo.", "operationId"=>"getPhotoLikes", "x-api-path-slug"=>"photolikes-get", "parameters"=>[{"in"=>"path", "name"=>"photo", "description"=>"Represents the ID of the photo object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo", "Likes"]}, "post"=>{"summary"=>"Post Photo Likes", "description"=>"Likes this photo.", "operationId"=>"postPhotoLikes", "x-api-path-slug"=>"photolikes-post", "parameters"=>[{"in"=>"path", "name"=>"photo", "description"=>"Represents the ID of the photo object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo", "Likes"]}, "delete"=>{"summary"=>"Delete Photo Likes", "description"=>"Unlikes this photo.", "operationId"=>"deletePhotoLikes", "x-api-path-slug"=>"photolikes-delete", "parameters"=>[{"in"=>"path", "name"=>"photo", "description"=>"Represents the ID of the photo object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo", "Likes"]}}, "/{photo}/picture"=>{"get"=>{"summary"=>"Get Photo Picture", "description"=>"The album-sized view of the photo", "operationId"=>"getPhotoPicture", "x-api-path-slug"=>"photopicture-get", "parameters"=>[{"in"=>"path", "name"=>"photo", "description"=>"Represents the ID of the photo object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo", "Picture"]}}, "/{photo}/tags"=>{"get"=>{"summary"=>"Get Photo Tags", "description"=>"Tags for this photo.", "operationId"=>"getPhotoTags", "x-api-path-slug"=>"phototags-get", "parameters"=>[{"in"=>"path", "name"=>"photo", "description"=>"Represents the ID of the photo object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo", "Tags"]}, "post"=>{"summary"=>"Post Photo Tags", "description"=>"Creates a tag on this photo.", "operationId"=>"postPhotoTags", "x-api-path-slug"=>"phototags-post", "parameters"=>[{"in"=>"path", "name"=>"photo", "description"=>"Represents the ID of the photo object"}, {"in"=>"query", "name"=>"to", "description"=>"USER_ID of the User to tag; can also be provided in URL path"}, {"in"=>"query", "name"=>"x", "description"=>"x coordinate of tag, as a percentage offset from the left edge of the picture"}, {"in"=>"query", "name"=>"y", "description"=>"y coordinate of tag, as a percentage offset from the top edge of the picture"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo", "Tags"]}}, "/{photo}/tags/{user}"=>{"post"=>{"summary"=>"Post Photo Tags User", "description"=>"Updates the position of a tag on this photo for the user.", "operationId"=>"postPhotoTagsUser", "x-api-path-slug"=>"phototagsuser-post", "parameters"=>[{"in"=>"path", "name"=>"photo", "description"=>"Represents the ID of the photo object"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user"}, {"in"=>"query", "name"=>"x", "description"=>"x coordinate of tag, as a percentage offset from the left edge of the picture"}, {"in"=>"query", "name"=>"y", "description"=>"y coordinate of tag, as a percentage offset from the top edge of the picture"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo", "Tags", "User"]}}, "/{post}"=>{"get"=>{"summary"=>"Get Add", "description"=>"A Facebook post", "operationId"=>"getAdd", "x-api-path-slug"=>"post-get", "parameters"=>[{"in"=>"path", "name"=>"post", "description"=>"Represents the ID of the post object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Post"]}}, "/{post}/comments"=>{"get"=>{"summary"=>"Get Add Comments", "description"=>"All of the comments on this post.", "operationId"=>"getAddComments", "x-api-path-slug"=>"postcomments-get", "parameters"=>[{"in"=>"path", "name"=>"post", "description"=>"Represents the ID of the post object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Post", "Comments"]}, "post"=>{"summary"=>"Post Add Comments", "description"=>"Posts a comment to this post.", "operationId"=>"postAddComments", "x-api-path-slug"=>"postcomments-post", "parameters"=>[{"in"=>"query", "name"=>"message", "description"=>"Comment text"}, {"in"=>"path", "name"=>"post", "description"=>"Represents the ID of the post object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Post", "Comments"]}}, "/{post}/likes"=>{"get"=>{"summary"=>"Get Add Likes", "description"=>"Users who like this post.", "operationId"=>"getAddLikes", "x-api-path-slug"=>"postlikes-get", "parameters"=>[{"in"=>"path", "name"=>"post", "description"=>"Represents the ID of the post object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Post", "Likes"]}, "post"=>{"summary"=>"Post Add Likes", "description"=>"Likes this post.", "operationId"=>"postAddLikes", "x-api-path-slug"=>"postlikes-post", "parameters"=>[{"in"=>"path", "name"=>"post", "description"=>"Represents the ID of the post object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Post", "Likes"]}, "delete"=>{"summary"=>"Delete Add Likes", "description"=>"Unlikes this post.", "operationId"=>"deleteAddLikes", "x-api-path-slug"=>"postlikes-delete", "parameters"=>[{"in"=>"path", "name"=>"post", "description"=>"Represents the ID of the post object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Post", "Likes"]}}, "/{status}"=>{"get"=>{"summary"=>"Get Status", "description"=>"A Facebook status", "operationId"=>"getStatus", "x-api-path-slug"=>"status-get", "parameters"=>[{"in"=>"path", "name"=>"status", "description"=>"Represents the ID of the status object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Status"]}}, "/{status}/comments"=>{"get"=>{"summary"=>"Get Status Comments", "description"=>"All of the comments on this status.", "operationId"=>"getStatusComments", "x-api-path-slug"=>"statuscomments-get", "parameters"=>[{"in"=>"path", "name"=>"status", "description"=>"Represents the ID of the status object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Status", "Comments"]}, "post"=>{"summary"=>"Post Status Comments", "description"=>"Posts a comment to this status.", "operationId"=>"postStatusComments", "x-api-path-slug"=>"statuscomments-post", "parameters"=>[{"in"=>"query", "name"=>"message", "description"=>"Comment text"}, {"in"=>"path", "name"=>"status", "description"=>"Represents the ID of the status object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Status", "Comments"]}}, "/{status}/likes"=>{"get"=>{"summary"=>"Get Status Likes", "description"=>"Users who like this status.", "operationId"=>"getStatusLikes", "x-api-path-slug"=>"statuslikes-get", "parameters"=>[{"in"=>"path", "name"=>"status", "description"=>"Represents the ID of the status object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Status", "Likes"]}, "post"=>{"summary"=>"Post Status Likes", "description"=>"Likes this status.", "operationId"=>"postStatusLikes", "x-api-path-slug"=>"statuslikes-post", "parameters"=>[{"in"=>"path", "name"=>"status", "description"=>"Represents the ID of the status object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Status", "Likes"]}, "delete"=>{"summary"=>"Delete Status Likes", "description"=>"Unlikes this status.", "operationId"=>"deleteStatusLikes", "x-api-path-slug"=>"statuslikes-delete", "parameters"=>[{"in"=>"path", "name"=>"status", "description"=>"Represents the ID of the status object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Status", "Likes"]}}, "/{user}"=>{"get"=>{"summary"=>"Get User", "description"=>"A user profile.", "operationId"=>"getUser", "x-api-path-slug"=>"user-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"The fields to return"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/{user}/accounts"=>{"get"=>{"summary"=>"Get User Accounts", "description"=>"The Facebook apps and pages owned by the current user", "operationId"=>"getUserAccounts", "x-api-path-slug"=>"useraccounts-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Accounts"]}}, "/{user}/achievements"=>{"post"=>{"summary"=>"Post User Achievements", "description"=>"Posts an achievement for the user", "operationId"=>"postUserAchievements", "x-api-path-slug"=>"userachievements-post", "parameters"=>[{"in"=>"query", "name"=>"achievement", "description"=>"The unique URL of the achievement which the user achieved"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Achievements"]}, "delete"=>{"summary"=>"Delete User Achievements", "description"=>"Deletes an achievement for the user", "operationId"=>"deleteUserAchievements", "x-api-path-slug"=>"userachievements-delete", "parameters"=>[{"in"=>"query", "name"=>"achievement", "description"=>"The unique URL of the achievement you wish to delete"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Achievements"]}}, "/{user}/activities"=>{"get"=>{"summary"=>"Get User Activities", "description"=>"The activities listed on the user's profile", "operationId"=>"getUserActivities", "x-api-path-slug"=>"useractivities-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Activities"]}}, "/{user}/albums"=>{"get"=>{"summary"=>"Get User Albums", "description"=>"The photo albums this user has created", "operationId"=>"getUserAlbums", "x-api-path-slug"=>"useralbums-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Albums"]}, "post"=>{"summary"=>"Post User Albums", "description"=>"Creates an album for the user", "operationId"=>"postUserAlbums", "x-api-path-slug"=>"useralbums-post", "parameters"=>[{"in"=>"query", "name"=>"message", "description"=>"Album description"}, {"in"=>"query", "name"=>"name", "description"=>"Album name"}, {"in"=>"query", "name"=>"privacy", "description"=>"Privacy settings for the Album"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Albums"]}}, "/{user}/apprequests"=>{"get"=>{"summary"=>"Get User Apprequests", "description"=>"The user's outstanding requests from an app.", "operationId"=>"getUserApprequests", "x-api-path-slug"=>"userapprequests-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Apprequests"]}}, "/{user}/books"=>{"get"=>{"summary"=>"Get User Books", "description"=>"The books listed on the user's profile.", "operationId"=>"getUserBooks", "x-api-path-slug"=>"userbooks-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Books"]}}, "/{user}/checkins"=>{"get"=>{"summary"=>"Get User Checkins", "description"=>"The places that the user has checked-into", "operationId"=>"getUserCheckins", "x-api-path-slug"=>"usercheckins-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Checkins"]}, "post"=>{"summary"=>"Post User Checkins", "description"=>"Checks the user into a place", "operationId"=>"postUserCheckins", "x-api-path-slug"=>"usercheckins-post", "parameters"=>[{"in"=>"query", "name"=>"coordinates", "description"=>"The users location, as a string containing latitude and longitude: {latitude:"}, {"in"=>"query", "name"=>"link", "description"=>"Checkin link"}, {"in"=>"query", "name"=>"message", "description"=>"Checkin description"}, {"in"=>"query", "name"=>"picture", "description"=>"Checkin picture"}, {"in"=>"query", "name"=>"place", "description"=>"Checkin Place ID; for example 110506962309835 for Facebook HQ"}, {"in"=>"query", "name"=>"tags", "description"=>"Comma-separated list of tagged friends user IDs"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Checkins"]}}, "/{user}/events"=>{"get"=>{"summary"=>"Get User Events", "description"=>"The events this user is attending.", "operationId"=>"getUserEvents", "x-api-path-slug"=>"userevents-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Events"]}, "post"=>{"summary"=>"Post User Events", "description"=>"Creates an event for the user", "operationId"=>"postUserEvents", "x-api-path-slug"=>"userevents-post", "parameters"=>[{"in"=>"query", "name"=>"end_time", "description"=>"Event end time"}, {"in"=>"query", "name"=>"location", "description"=>"Event location"}, {"in"=>"query", "name"=>"message", "description"=>"Event description"}, {"in"=>"query", "name"=>"name", "description"=>"Event name"}, {"in"=>"query", "name"=>"privacy_type", "description"=>"Event privacy setting"}, {"in"=>"query", "name"=>"start_time", "description"=>"Event start time"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Events"]}}, "/{user}/feed"=>{"get"=>{"summary"=>"Get User Feed", "description"=>"This user's wall", "operationId"=>"getUserFeed", "x-api-path-slug"=>"userfeed-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Feed"]}, "post"=>{"summary"=>"Post User Feed", "description"=>"Posts a status message on this user's wall", "operationId"=>"postUserFeed", "x-api-path-slug"=>"userfeed-post", "parameters"=>[{"in"=>"query", "name"=>"message", "description"=>"Status Message content"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Feed"]}}, "/{user}/friendlists"=>{"post"=>{"summary"=>"Post User Friendlists", "description"=>"Creates a FriendList for the user", "operationId"=>"postUserFriendlists", "x-api-path-slug"=>"userfriendlists-post", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"Friend list name"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Friendlists"]}}, "/{user}/friends"=>{"get"=>{"summary"=>"Get User Friends", "description"=>"The user's friends", "operationId"=>"getUserFriends", "x-api-path-slug"=>"userfriends-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Friends"]}}, "/{user}/friends/{friend}"=>{"get"=>{"summary"=>"Get User Friends Friend", "description"=>"Checks if the given user is a friend of the current user", "operationId"=>"getUserFriendsFriend", "x-api-path-slug"=>"userfriendsfriend-get", "parameters"=>[{"in"=>"path", "name"=>"friend", "description"=>"Represents the ID of the users friend"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Friends", "Friend"]}}, "/{user}/games"=>{"get"=>{"summary"=>"Get User Games", "description"=>"Games the user has added to the Arts and Entertainment section of their profile.", "operationId"=>"getUserGames", "x-api-path-slug"=>"usergames-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Games"]}}, "/{user}/groups"=>{"get"=>{"summary"=>"Get User Groups", "description"=>"The Groups that the user belongs to.", "operationId"=>"getUserGroups", "x-api-path-slug"=>"usergroups-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Groups"]}}, "/{user}/home"=>{"get"=>{"summary"=>"Get User Home", "description"=>"The user's news feed", "operationId"=>"getUserHome", "x-api-path-slug"=>"userhome-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Home"]}}, "/{user}/inbox"=>{"get"=>{"summary"=>"Get User Inbox", "description"=>"The threads in this user's inbox.", "operationId"=>"getUserInbox", "x-api-path-slug"=>"userinbox-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Inbox"]}}, "/{user}/interests"=>{"get"=>{"summary"=>"Get User Interests", "description"=>"The interests listed on the user's profile", "operationId"=>"getUserInterests", "x-api-path-slug"=>"userinterests-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Interests"]}}, "/{user}/likes"=>{"get"=>{"summary"=>"Get User Likes", "description"=>"All the pages this user has liked.", "operationId"=>"getUserLikes", "x-api-path-slug"=>"userlikes-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Likes"]}}, "/{user}/likes/{page}"=>{"get"=>{"summary"=>"Get User Likes Page", "description"=>"Checks if the user likes the given page.", "operationId"=>"getUserLikesPage", "x-api-path-slug"=>"userlikespage-get", "parameters"=>[{"in"=>"path", "name"=>"page", "description"=>"Represents the ID of the page"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Likes", "Page"]}}, "/{user}/links"=>{"get"=>{"summary"=>"Get User Links", "description"=>"The user's posted links.", "operationId"=>"getUserLinks", "x-api-path-slug"=>"userlinks-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Links"]}, "post"=>{"summary"=>"Post User Links", "description"=>"Posts a link on the user's profile page", "operationId"=>"postUserLinks", "x-api-path-slug"=>"userlinks-post", "parameters"=>[{"in"=>"query", "name"=>"link", "description"=>"Link URL"}, {"in"=>"query", "name"=>"message", "description"=>"Link message"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Links"]}}, "/{user}/movies"=>{"get"=>{"summary"=>"Get User Movies", "description"=>"The movies listed on the user's profile", "operationId"=>"getUserMovies", "x-api-path-slug"=>"usermovies-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Movies"]}}, "/{user}/music"=>{"get"=>{"summary"=>"Get User Music", "description"=>"The music listed on the user's profile", "operationId"=>"getUserMusic", "x-api-path-slug"=>"usermusic-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Music"]}}, "/{user}/notes"=>{"get"=>{"summary"=>"Get User Notes", "description"=>"The user's notes", "operationId"=>"getUserNotes", "x-api-path-slug"=>"usernotes-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Notes"]}, "post"=>{"summary"=>"Post User Notes", "description"=>"Creates a note on behalf of the user", "operationId"=>"postUserNotes", "x-api-path-slug"=>"usernotes-post", "parameters"=>[{"in"=>"query", "name"=>"message", "description"=>"Note content"}, {"in"=>"query", "name"=>"subject", "description"=>"The subject of the Note"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Notes"]}}, "/{user}/notifications"=>{"get"=>{"summary"=>"Get User Notifications", "description"=>"The user's notifications", "operationId"=>"getUserNotifications", "x-api-path-slug"=>"usernotifications-get", "parameters"=>[{"in"=>"query", "name"=>"include_read", "description"=>"Enables you to see notifications that the user has already read in addition to the ones which are unread"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Notifications"]}}, "/{user}/outbox"=>{"get"=>{"summary"=>"Get User Outbox", "description"=>"The messages in this user's outbox.", "operationId"=>"getUserOutbox", "x-api-path-slug"=>"useroutbox-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Outbox"]}}, "/{user}/payments"=>{"get"=>{"summary"=>"Get User Payments", "description"=>"The transactions the user placed with an application.", "operationId"=>"getUserPayments", "x-api-path-slug"=>"userpayments-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Payments"]}}, "/{user}/permissions"=>{"get"=>{"summary"=>"Get User Permissions", "description"=>"The permissions that user has granted the application.", "operationId"=>"getUserPermissions", "x-api-path-slug"=>"userpermissions-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Permissions"]}, "delete"=>{"summary"=>"Delete User Permissions", "description"=>"De-authorizes an application or revokes a specific extended permissions on behalf of a user", "operationId"=>"deleteUserPermissions", "x-api-path-slug"=>"userpermissions-delete", "parameters"=>[{"in"=>"query", "name"=>"permission", "description"=>"The permission you wish to revoke"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Permissions"]}}, "/{user}/photos"=>{"get"=>{"summary"=>"Get User Photos", "description"=>"The photos the user is tagged in", "operationId"=>"getUserPhotos", "x-api-path-slug"=>"userphotos-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Photos"]}, "post"=>{"summary"=>"Post User Photos", "description"=>"Posts a photo to the user's Wall", "operationId"=>"postUserPhotos", "x-api-path-slug"=>"userphotos-post", "parameters"=>[{"in"=>"query", "name"=>"message", "description"=>"Photo description"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Photos"]}}, "/{user}/picture"=>{"get"=>{"summary"=>"Get User Picture", "description"=>"The user's profile picture", "operationId"=>"getUserPicture", "x-api-path-slug"=>"userpicture-get", "parameters"=>[{"in"=>"query", "name"=>"type", "description"=>"One of square (50x50), small (50 pixels wide, variable height), and large (about 200 pixels wide, variable height)"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Picture"]}}, "/{user}/pokes"=>{"get"=>{"summary"=>"Get User Pokes", "description"=>"The user's pokes", "operationId"=>"getUserPokes", "x-api-path-slug"=>"userpokes-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Pokes"]}}, "/{user}/posts"=>{"get"=>{"summary"=>"Get User Adds", "description"=>"The user's posts", "operationId"=>"getUserAdds", "x-api-path-slug"=>"userposts-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Posts"]}, "post"=>{"summary"=>"Post User Adds", "description"=>"Creates a post on behalf of the user", "operationId"=>"postUserAdds", "x-api-path-slug"=>"userposts-post", "parameters"=>[{"in"=>"query", "name"=>"actions", "description"=>"Post actions"}, {"in"=>"query", "name"=>"caption", "description"=>"Post caption"}, {"in"=>"query", "name"=>"description", "description"=>"Post description"}, {"in"=>"query", "name"=>"link", "description"=>"Post URL"}, {"in"=>"query", "name"=>"message", "description"=>"Post message"}, {"in"=>"query", "name"=>"name", "description"=>"Post name"}, {"in"=>"query", "name"=>"object_attachment", "description"=>"Facebook ID for an existing picture in the Users photo albums to use as the thumbnail image"}, {"in"=>"query", "name"=>"picture", "description"=>"Post thumbnail image"}, {"in"=>"query", "name"=>"privacy", "description"=>"Post privacy settings"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Posts"]}}, "/{user}/scores"=>{"get"=>{"summary"=>"Get User Scores", "description"=>"The scores for the user", "operationId"=>"getUserScores", "x-api-path-slug"=>"userscores-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Scores"]}, "post"=>{"summary"=>"Post User Scores", "description"=>"Posts a score for the user", "operationId"=>"postUserScores", "x-api-path-slug"=>"userscores-post", "parameters"=>[{"in"=>"query", "name"=>"score", "description"=>"Numeric score with value < 0"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Scores"]}}, "/{user}/statuses"=>{"get"=>{"summary"=>"Get User Statuses", "description"=>"The user's status updates", "operationId"=>"getUserStatuses", "x-api-path-slug"=>"userstatuses-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Statuses"]}, "post"=>{"summary"=>"Post User Statuses", "description"=>"Posts a status message on the user", "operationId"=>"postUserStatuses", "x-api-path-slug"=>"userstatuses-post", "parameters"=>[{"in"=>"query", "name"=>"message", "description"=>"Status Message content"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Statuses"]}}, "/{user}/tagged"=>{"get"=>{"summary"=>"Get User Tagged", "description"=>"Posts the user is tagged in", "operationId"=>"getUserTagged", "x-api-path-slug"=>"usertagged-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Tagged"]}}, "/{user}/television"=>{"get"=>{"summary"=>"Get User Television", "description"=>"The television listed on the user's profile", "operationId"=>"getUserTelevision", "x-api-path-slug"=>"usertelevision-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Television"]}}, "/{user}/updates"=>{"get"=>{"summary"=>"Get User Updates", "description"=>"The updates in this user's inbox.", "operationId"=>"getUserUpdates", "x-api-path-slug"=>"userupdates-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Updates"]}}, "/{user}/videos"=>{"get"=>{"summary"=>"Get User Veos", "description"=>"The videos this user has been tagged in", "operationId"=>"getUserVeos", "x-api-path-slug"=>"uservideos-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Videos"]}, "post"=>{"summary"=>"Post User Veos", "description"=>"Publishes a video on behalf of the user", "operationId"=>"postUserVeos", "x-api-path-slug"=>"uservideos-post", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"Video description"}, {"in"=>"query", "name"=>"title", "description"=>"Video title"}, {"in"=>"path", "name"=>"user", "description"=>"Represents the ID of the user object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Videos"]}}, "/{notification}"=>{"post"=>{"summary"=>"Post Notification", "description"=>"Marks the notification as read", "operationId"=>"postNotification", "x-api-path-slug"=>"notification-post", "parameters"=>[{"in"=>"path", "name"=>"notification", "description"=>"Represents the ID of the notification"}, {"in"=>"query", "name"=>"unread", "description"=>"Connect to the social network with the Graph API"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification"]}}, "/{video}"=>{"get"=>{"summary"=>"Get Veo", "description"=>"An individual video", "operationId"=>"getVeo", "x-api-path-slug"=>"video-get", "parameters"=>[{"in"=>"path", "name"=>"video", "description"=>"Represents the ID of the video object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video"]}}, "/{video}/comments"=>{"get"=>{"summary"=>"Get Veo Comments", "description"=>"All of the comments on this video.", "operationId"=>"getVeoComments", "x-api-path-slug"=>"videocomments-get", "parameters"=>[{"in"=>"path", "name"=>"video", "description"=>"Represents the ID of the video object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video", "Comments"]}, "post"=>{"summary"=>"Post Veo Comments", "description"=>"Posts a comment to this video.", "operationId"=>"postVeoComments", "x-api-path-slug"=>"videocomments-post", "parameters"=>[{"in"=>"query", "name"=>"message", "description"=>"Comment text"}, {"in"=>"path", "name"=>"video", "description"=>"Represents the ID of the video object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video", "Comments"]}}, "/{video}/likes"=>{"get"=>{"summary"=>"Get Veo Likes", "description"=>"Users who like this video.", "operationId"=>"getVeoLikes", "x-api-path-slug"=>"videolikes-get", "parameters"=>[{"in"=>"path", "name"=>"video", "description"=>"Represents the ID of the video object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video", "Likes"]}, "post"=>{"summary"=>"Post Veo Likes", "description"=>"Likes this video.", "operationId"=>"postVeoLikes", "x-api-path-slug"=>"videolikes-post", "parameters"=>[{"in"=>"path", "name"=>"video", "description"=>"Represents the ID of the video object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video", "Likes"]}, "delete"=>{"summary"=>"Delete Veo Likes", "description"=>"Unlikes this video.", "operationId"=>"deleteVeoLikes", "x-api-path-slug"=>"videolikes-delete", "parameters"=>[{"in"=>"path", "name"=>"video", "description"=>"Represents the ID of the video object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video", "Likes"]}}, "/{video}/picture"=>{"get"=>{"summary"=>"Get Veo Picture", "description"=>"The image which represents the content of the video", "operationId"=>"getVeoPicture", "x-api-path-slug"=>"videopicture-get", "parameters"=>[{"in"=>"path", "name"=>"video", "description"=>"Represents the ID of the video object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Video", "Picture"]}}}}, "apis"=>{"name"=>"Facebook", "x-slug"=>"facebook", "description"=>"Facebook, Inc. is an American online social media and social networking service company based in Menlo Park, California.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/196-facebook.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"3", "tags"=>"API Provider,Facebook Stack,General Data,Historical Data API,Indie EdTech Data Jam,internet,Issues Example,Mobile,My API Stack,New,Payments,Pedestal,Profiles,Relative Data,Relative StreamRank,Social,Social,Social Networks,Stack,Stack Network,Streams,Streams,Streams,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"facebook/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Facebook", "x-api-slug"=>"facebook", "description"=>"Facebook, Inc. is an American online social media and social networking service company based in Menlo Park, California.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/196-facebook.jpg", "humanURL"=>"http:///business", "baseURL"=>"https://graph.facebook.com//", "tags"=>"API Provider,Facebook Stack,General Data,Historical Data API,Indie EdTech Data Jam,internet,Issues Example,Mobile,My API Stack,New,Payments,Pedestal,Profiles,Relative Data,Relative StreamRank,Social,Social,Social Networks,Stack,Stack Network,Streams,Streams,Streams,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/facebook/videopicture-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/facebook/facebook-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-android-sdk", "url"=>"https://developers.facebook.com/docs/android/share"}, {"type"=>"x-apigee-console", "url"=>"https://api.apigee.com/v1/consoles/facebook/apidescription?format=internal&ver=1386216190000"}, {"type"=>"x-application-gallery", "url"=>"https://developers.facebook.com/docs/showcase/"}, {"type"=>"x-base", "url"=>"https://graph.facebook.com"}, {"type"=>"x-best-practices", "url"=>"https://developers.facebook.com/docs/sharing/best-practices"}, {"type"=>"x-blog", "url"=>"http://blog.facebook.com"}, {"type"=>"x-blog-rss", "url"=>"https://www.facebook.com/business/news/rss/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/facebook"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/facebook"}, {"type"=>"x-developer", "url"=>"https://developers.facebook.com/"}, {"type"=>"x-forum", "url"=>"https://www.facebook.com/groups/fbdevelopers"}, {"type"=>"x-github", "url"=>"https://github.com/facebook"}, {"type"=>"x-ios-sdk", "url"=>"https://developers.facebook.com/docs/ios/share"}, {"type"=>"x-issues", "url"=>"https://developers.facebook.com/status/issues/"}, {"type"=>"x-javascript-library", "url"=>"https://developers.facebook.com/docs/reference/javascript/"}, {"type"=>"x-partners", "url"=>"https://facebookmarketingpartners.com/"}, {"type"=>"x-php-sdk", "url"=>"https://developers.facebook.com/docs/reference/php/"}, {"type"=>"x-plugins", "url"=>"https://developers.facebook.com/docs/plugins/"}, {"type"=>"x-privacy", "url"=>"https://www.facebook.com/settings?tab=privacy"}, {"type"=>"x-road-map", "url"=>"https://developers.facebook.com/docs/apps/migrations"}, {"type"=>"x-status", "url"=>"https://developers.facebook.com/status/"}, {"type"=>"x-terms-of-service", "url"=>"https://www.facebook.com/terms"}, {"type"=>"x-terms-of-service", "url"=>"https://developers.facebook.com/policy"}, {"type"=>"x-transparency-report", "url"=>"https://www.facebook.com/about/government_requests"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/facebook"}, {"type"=>"x-webhook", "url"=>"https://developers.facebook.com/docs/messenger-platform/webhook/"}, {"type"=>"x-website", "url"=>"http:///business"}, {"type"=>"x-website", "url"=>"http://facebook.com"}, {"type"=>"x-website", "url"=>"https://facebook.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
atlassian{"jira-service-desk-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Atlassian", "x-complete"=>1, "info"=>{"title"=>"Stride API", "description"=>"this-service-provides-public-api-for-the-stride-", "version"=>"1.0.0"}, "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/site/"=>{"get"=>{"summary"=>"Get list of sites", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"GetAllHandler", "x-api-path-slug"=>"site-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Sites"]}}, "/site/{cloudId}/conversation"=>{"get"=>{"summary"=>"Get a list of conversations", "description"=>"The API returns the list of conversations the app has access to Authentication required, with scope participate:conversation", "operationId"=>"ConversationGetAllHandler", "x-api-path-slug"=>"sitecloudidconversation-get", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"query", "name"=>"cursor", "description"=>"The cursor is a string, that you can use to scroll through the data set to get more results"}, {"in"=>"query", "name"=>"exclude-direct", "description"=>"Exclude direct messages from a response"}, {"in"=>"query", "name"=>"include-archived", "description"=>"Include archived conversations into response"}, {"in"=>"query", "name"=>"include-private", "description"=>"Include private conversations into response"}, {"in"=>"query", "name"=>"limit", "description"=>"A maximum number of conversations to return per call"}, {"in"=>"query", "name"=>"query", "description"=>"A string containing full or part of conversations name"}, {"in"=>"query", "name"=>"sort", "description"=>"A sort order of the conversations lists"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Conversations"]}, "post"=>{"summary"=>"Create conversation", "description"=>"Authentication required, with scope manage:conversation", "operationId"=>"ConversationPostHandler", "x-api-path-slug"=>"sitecloudidconversation-post", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversation"]}}, "/site/{cloudId}/conversation/user/{userId}"=>{"get"=>{"summary"=>"Get a direct conversation of a user", "description"=>"Get a direct conversation of a user.", "operationId"=>"ConversationUserGetHandler", "x-api-path-slug"=>"sitecloudidconversationuseruserid-get", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"userId", "description"=>"The user Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Direct", "Conversation", "Of", "User"]}}, "/site/{cloudId}/conversation/user/{userId}/message"=>{"post"=>{"summary"=>"Send message to a user", "description"=>"Send message to a user.", "operationId"=>"UserMessagePostHandler", "x-api-path-slug"=>"sitecloudidconversationuseruseridmessage-post", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"userId", "description"=>"The user Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Message", "To", "User"]}}, "/site/{cloudId}/conversation/user/{userId}/message/{messageId}"=>{"put"=>{"summary"=>"Edit a message in a direct conversation", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"UserMessagePutHandler", "x-api-path-slug"=>"sitecloudidconversationuseruseridmessagemessageid-put", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"messageId", "description"=>"The ID of the message"}, {"in"=>"path", "name"=>"userId", "description"=>"The user Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Message", "In", "Direct", "Conversation"]}, "delete"=>{"summary"=>"Delete a message in a direct conversation", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"UserMessageDeleteHandler", "x-api-path-slug"=>"sitecloudidconversationuseruseridmessagemessageid-delete", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"messageId", "description"=>"The ID of the message"}, {"in"=>"path", "name"=>"userId", "description"=>"The user Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "In", "Direct", "Conversation"]}}, "/site/{cloudId}/conversation/{conversationId}"=>{"get"=>{"summary"=>"Get conversation details", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"ConversationGetHandler", "x-api-path-slug"=>"sitecloudidconversationconversationid-get", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversation", "Details"]}, "patch"=>{"summary"=>"Update conversation", "description"=>"Authentication required, with scope manage:conversation", "operationId"=>"ConversationPatchHandler", "x-api-path-slug"=>"sitecloudidconversationconversationid-patch", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversation"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:actionTarget"=>{"get"=>{"summary"=>"Get a list of chat:actionTarget modules", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatActionTargetGetAllHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatactiontarget-get", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"query", "name"=>"limit", "description"=>"A maximum number of modules to return per call"}, {"in"=>"query", "name"=>"start", "description"=>"Offset for the query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Chat:actionTarget", "Modules"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:actionTarget/{key}"=>{"put"=>{"summary"=>"Create or update a chat:actionTarget module", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatActionTargetPutHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatactiontargetkey-put", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"The key to identify the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Chat:actionTarget", "Module"]}, "delete"=>{"summary"=>"Delete a chat:actionTarget module", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatActionTargetDeleteHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatactiontargetkey-delete", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"The key to identify the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat:actionTarget", "Module"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:bot"=>{"get"=>{"summary"=>"Get a list of chat:bot modules", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppWebhookChatBotGetAllHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatbot-get", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"query", "name"=>"limit", "description"=>"A maximum number of modules to return per call"}, {"in"=>"query", "name"=>"start", "description"=>"Offset for the query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Chat:bot", "Modules"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:bot/{key}"=>{"put"=>{"summary"=>"Create or update a chat:bot module", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppWebhookChatBotPutHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatbotkey-put", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"The key to identify the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Chat:bot", "Module"]}, "delete"=>{"summary"=>"Delete a chat:bot module", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppWebhookChatBotDeleteHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatbotkey-delete", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"The key to identify the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat:bot", "Module"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:bot:messages"=>{"get"=>{"summary"=>"Get a list of chat:bot:messages modules", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppWebhookChatBotMessageGetAllHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatbotmessages-get", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"query", "name"=>"limit", "description"=>"A maximum number of modules to return per call"}, {"in"=>"query", "name"=>"start", "description"=>"Offset for the query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Chat:bot:messages", "Modules"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:bot:messages/{key}"=>{"put"=>{"summary"=>"Create or update a chat:bot:messages module", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppWebhookChatBotMessagePutHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatbotmessageskey-put", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"The key to identify the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Chat:bot:messages", "Module"]}, "delete"=>{"summary"=>"Delete a chat:bot:messages module", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppWebhookChatBotMessageDeleteHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatbotmessageskey-delete", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"The key to identify the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat:bot:messages", "Module"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:configuration/{key}/state"=>{"put"=>{"summary"=>"Update the chat:configuration state", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatConfigurationPutHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatconfigurationkeystate-put", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"Key of the configuration module"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat:configuration", "State"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:dialog"=>{"get"=>{"summary"=>"Get a list of chat:dialog modules", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatDialogGetAllHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatdialog-get", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"query", "name"=>"limit", "description"=>"A maximum number of modules to return per call"}, {"in"=>"query", "name"=>"start", "description"=>"Offset for the query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Chat:dialog", "Modules"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:dialog/{key}"=>{"put"=>{"summary"=>"Create or update a chat:dialog module", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatDialogPutHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatdialogkey-put", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"The key to identify the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Chat:dialog", "Module"]}, "delete"=>{"summary"=>"Delete a chat:dialog module", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatDialogDeleteHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatdialogkey-delete", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"The key to identify the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat:dialog", "Module"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:externalPage"=>{"get"=>{"summary"=>"Get a list of chat:externalPage modules", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatExternalPageGetAllHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatexternalpage-get", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"query", "name"=>"limit", "description"=>"A maximum number of modules to return per call"}, {"in"=>"query", "name"=>"start", "description"=>"Offset for the query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Chat:externalPage", "Modules"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:externalPage/{key}"=>{"put"=>{"summary"=>"Create or update a chat:externalPage module", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatExternalPagePutHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatexternalpagekey-put", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"The key to identify the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Chat:externalPage", "Module"]}, "delete"=>{"summary"=>"Delete a chat:externalPage module", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatExternalPageDeleteHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatexternalpagekey-delete", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"The key to identify the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat:externalPage", "Module"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:glance"=>{"get"=>{"summary"=>"Get a list of chat:glance modules", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatGlanceGetAllHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatglance-get", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"query", "name"=>"limit", "description"=>"A maximum number of modules to return per call"}, {"in"=>"query", "name"=>"start", "description"=>"Offset for the query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Chat:glance", "Modules"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:glance/{key}"=>{"put"=>{"summary"=>"Create or update a chat:glance module", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatGlancePutHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatglancekey-put", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"The key to identify the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Chat:glance", "Module"]}, "delete"=>{"summary"=>"Delete a chat:glance module", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatGlanceDeleteHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatglancekey-delete", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"The key to identify the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat:glance", "Module"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:glance/{key}/state"=>{"put"=>{"summary"=>"Update the chat:glance state", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatGlanceStatePutHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatglancekeystate-put", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"Key of the glance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat:glance", "State"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:sidebar"=>{"get"=>{"summary"=>"Get a list of chat:sidebar modules", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatSidebarGetAllHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatsidebar-get", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"query", "name"=>"limit", "description"=>"A maximum number of modules to return per call"}, {"in"=>"query", "name"=>"start", "description"=>"Offset for the query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Chat:sidebar", "Modules"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:sidebar/{key}"=>{"put"=>{"summary"=>"Create or update a chat:sidebar module", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatSidebarPutHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatsidebarkey-put", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"The key to identify the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Chat:sidebar", "Module"]}, "delete"=>{"summary"=>"Delete a chat:sidebar module", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppModuleChatSidebarDeleteHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatsidebarkey-delete", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"The key to identify the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat:sidebar", "Module"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:webhook"=>{"get"=>{"summary"=>"Get a list of chat:webhook modules", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppWebhookChatWebhookGetAllHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatwebhook-get", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"query", "name"=>"limit", "description"=>"A maximum number of modules to return per call"}, {"in"=>"query", "name"=>"start", "description"=>"Offset for the query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Chat:webhook", "Modules"]}}, "/site/{cloudId}/conversation/{conversationId}/app/module/chat:webhook/{key}"=>{"put"=>{"summary"=>"Create or update a chat:webhook module", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppWebhookChatWebhookPutHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatwebhookkey-put", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"The key to identify the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Chat:webhook", "Module"]}, "delete"=>{"summary"=>"Delete a chat:webhook module", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"AppWebhookChatWebhookDeleteHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidappmodulechatwebhookkey-delete", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"key", "description"=>"The key to identify the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chat:webhook", "Module"]}}, "/site/{cloudId}/conversation/{conversationId}/archive"=>{"put"=>{"summary"=>"Archive conversation", "description"=>"Authentication required, with scope manage:conversation", "operationId"=>"ConversationArchivePutHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidarchive-put", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Archive", "Conversation"]}}, "/site/{cloudId}/conversation/{conversationId}/media"=>{"post"=>{"summary"=>"Upload a file", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"ConversationMediaPostHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidmedia-post", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"Cloud ID"}, {"in"=>"path", "name"=>"conversationId", "description"=>"Conversation ID"}, {"in"=>"query", "name"=>"name", "description"=>"File name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "File"]}}, "/site/{cloudId}/conversation/{conversationId}/media/{mediaId}"=>{"get"=>{"summary"=>"Get a file", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"ConversationMediaGetHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidmediamediaid-get", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"Cloud ID"}, {"in"=>"path", "name"=>"conversationId", "description"=>"Conversation ID"}, {"in"=>"path", "name"=>"mediaId", "description"=>"Media ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}, "delete"=>{"summary"=>"Delete a file", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"ConversationMediaDeleteHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidmediamediaid-delete", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"Cloud ID"}, {"in"=>"path", "name"=>"conversationId", "description"=>"Conversation ID"}, {"in"=>"path", "name"=>"mediaId", "description"=>"Media ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}}, "/site/{cloudId}/conversation/{conversationId}/message"=>{"get"=>{"summary"=>"Get conversation history", "description"=>"Authentication required, with scope participate:conversation This method returns messages after/before a given messageIDs or/and timestamps. If these parameters are omitted the method returns conversation’s latest messages. Max number of messages returned is 75.", "operationId"=>"ConversationMessagesGetHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidmessage-get", "parameters"=>[{"in"=>"query", "name"=>"afterMessage", "description"=>"Returns at most 75 latest messages after a provided messageID"}, {"in"=>"query", "name"=>"afterTimestamp", "description"=>"Returns at most 75 latest messages after a provided RFC3339 timestamp (2006-01-02T15:04:05+07:00)"}, {"in"=>"query", "name"=>"beforeMessage", "description"=>"Returns at most 75 messages before a provided messageID"}, {"in"=>"query", "name"=>"beforeTimestamp", "description"=>"Returns at most 75 messages before a provided RFC3339 timestamp (2006-01-02T15:04:05+07:00)"}, {"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversation", "History"]}, "post"=>{"summary"=>"Send a message to a conversation", "description"=>"Send a message to a conversation.", "operationId"=>"ConversationMessagePostHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidmessage-post", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Message", "To", "Conversation"]}}, "/site/{cloudId}/conversation/{conversationId}/message/recent"=>{"get"=>{"summary"=>"Get latest messages for conversation", "description"=>"Authentication required, with scope participate:conversation Max number of messages returned is 75.", "operationId"=>"ConversationMessagesRecentGetHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidmessagerecent-get", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Latest", "Messagesconversation"]}}, "/site/{cloudId}/conversation/{conversationId}/message/{messageId}"=>{"get"=>{"summary"=>"Get Message by id", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"ConversationMessageGetHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidmessagemessageid-get", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"messageId", "description"=>"The ID of the Message to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "By", "Id"]}, "put"=>{"summary"=>"Edit a message in a conversation", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"ConversationMessagePutHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidmessagemessageid-put", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"messageId", "description"=>"The ID of the message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Message", "In", "Conversation"]}, "delete"=>{"summary"=>"Delete a message in a conversation", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"ConversationMessageDeleteHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidmessagemessageid-delete", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"messageId", "description"=>"The ID of the message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "In", "Conversation"]}}, "/site/{cloudId}/conversation/{conversationId}/message/{messageId}/context"=>{"get"=>{"summary"=>"Get conversation history contextually", "description"=>"Authentication required, with scope participate:conversation This method returns messages after and/or before a given messageID including the message itself. Default value for 'after' and 'before' query parameters is 0. Max number of messages returned is 75.", "operationId"=>"ConversationContextMessagesGetHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidmessagemessageidcontext-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"A number of messages to return after the Message"}, {"in"=>"query", "name"=>"before", "description"=>"A number of messages to return before the Message"}, {"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}, {"in"=>"path", "name"=>"messageId", "description"=>"The ID of the Message to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversation", "History", "Contextually"]}}, "/site/{cloudId}/conversation/{conversationId}/roster"=>{"get"=>{"summary"=>"Get conversation roster", "description"=>"Authentication required, with scope participate:conversation", "operationId"=>"ConversationRosterGetHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidroster-get", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversation", "Roster"]}, "patch"=>{"summary"=>"Update a conversation roster", "description"=>"Authentication required, with scope manage:conversation", "operationId"=>"PatchRosterHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidroster-patch", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversation", "Roster"]}}, "/site/{cloudId}/conversation/{conversationId}/unarchive"=>{"put"=>{"summary"=>"Unarchive conversation", "description"=>"Authentication required, with scope manage:conversation", "operationId"=>"ConversationUnarchivePutHandler", "x-api-path-slug"=>"sitecloudidconversationconversationidunarchive-put", "parameters"=>[{"in"=>"path", "name"=>"cloudId", "description"=>"The id of the site (cloudId)"}, {"in"=>"path", "name"=>"conversationId", "description"=>"The conversation id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unarchive", "Conversation"]}}}}, "confluence-cloud-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Atlassian", "x-complete"=>1, "info"=>{"title"=>"The Confluence Cloud REST API", "description"=>"this-document-describes-the-rest-api-and-resources-provided-by-confluence--the-rest-apis-are-for-developers-who-want-to-integrate-confluence-into-their-application-and-for-administrators-who-want-to-script-interactions-with-the-confluence-server-confluences-rest-apis-provide-access-to-resources-data-entities-via-uri-paths--to-use-a-rest-api-your-application-will-make-an-http-request-and-parse-the-response--the-response-format-is-json--your-methods-will-be-the-standard-http-methods-like-get-put-post-and-delete--because-the-rest-api-is-based-on-open-standards-you-can-use-any-web-development-language-to-access-the-api-", "termsOfService"=>"http://atlassian.com/terms/", "version"=>"1.0.0"}, "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/audit"=>{"get"=>{"summary"=>"Get audit records", "description"=>"Returns all records in the audit log, optionally for a certain date range. \nThis contains information about events like space exports, group membership \nchanges, app installations, etc. For more information, see \n[Audit log](https://confluence.atlassian.com/confcloud/audit-log-802164269.html) \nin the Confluence administrator's guide.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \n'Confluence Administrator' global permission.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.AuditResource.getAuditRecords_get", "x-api-path-slug"=>"audit-get", "parameters"=>[{"in"=>"query", "name"=>"endDate", "description"=>"Filters the results to the records on or before the `endDate`"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of records to return per page"}, {"in"=>"query", "name"=>"searchString", "description"=>"Filters the results to records that have string property values matching the `searchString`"}, {"in"=>"query", "name"=>"start", "description"=>"The starting index of the returned records"}, {"in"=>"query", "name"=>"startDate", "description"=>"Filters the results to the records on or after the `startDate`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audit", "Records"]}, "post"=>{"summary"=>"Create audit record", "description"=>"Creates a record in the audit log. \n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \n'Confluence Administrator' global permission.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.AuditResource.createAuditRecord_post", "x-api-path-slug"=>"audit-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audit", "Record"]}}, "/audit/export"=>{"get"=>{"summary"=>"Export audit records", "description"=>"Exports audit records as a CSV file or ZIP file.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \n'Confluence Administrator' global permission.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.AuditResource.exportAuditRecords_get", "x-api-path-slug"=>"auditexport-get", "parameters"=>[{"in"=>"query", "name"=>"endDate", "description"=>"Filters the exported results to the records on or before the `endDate`"}, {"in"=>"query", "name"=>"format", "description"=>"The format of the export file for the audit records"}, {"in"=>"query", "name"=>"searchString", "description"=>"Filters the exported results to records that have string property values matching the `searchString`"}, {"in"=>"query", "name"=>"startDate", "description"=>"Filters the exported results to the records on or after the `startDate`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Export", "Audit", "Records"]}}, "/audit/retention"=>{"get"=>{"summary"=>"Get retention period", "description"=>"Returns the retention period for records in the audit log. The retention \nperiod is how long an audit record is kept for, from creation date until \nit is deleted.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \n'Confluence Administrator' global permission.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.AuditResource.getRetentionPeriod_get", "x-api-path-slug"=>"auditretention-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retention", "Period"]}, "put"=>{"summary"=>"Set retention period", "description"=>"Sets the retention period for records in the audit log. The retention period \ncan be set to a maximum of 20 years.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \n'Confluence Administrator' global permission.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.AuditResource.setRetentionPeriod_put", "x-api-path-slug"=>"auditretention-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Retention", "Period"]}}, "/audit/since"=>{"get"=>{"summary"=>"Get audit records for time period", "description"=>"Returns records from the audit log, for a time period back from the current \ndate. For example, you can use this method to get the last 3 months of records.\n\nThis contains information about events like space exports, group membership \nchanges, app installations, etc. For more information, see \n[Audit log](https://confluence.atlassian.com/confcloud/audit-log-802164269.html) \nin the Confluence administrator's guide.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \n'Confluence Administrator' global permission.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.AuditResource.getAuditRecordsForTimePeriod_get", "x-api-path-slug"=>"auditsince-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"The maximum number of records to return per page"}, {"in"=>"query", "name"=>"number", "description"=>"The number of units for the time period"}, {"in"=>"query", "name"=>"searchString", "description"=>"Filters the results to records that have string property values matching the `searchString`"}, {"in"=>"query", "name"=>"start", "description"=>"The starting index of the returned records"}, {"in"=>"query", "name"=>"units", "description"=>"The unit of time that the time period is measured in"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audit", "Recordstime", "Period"]}}, "/content"=>{"get"=>{"summary"=>"Get content", "description"=>"Returns all content in a Confluence instance.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \nPermission to access the Confluence site ('Can use' global permission). \nOnly content that the user has permission to view will be returned.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ContentResource.getContent_get", "x-api-path-slug"=>"content-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"A multi-value parameter indicating which properties of the content to expand"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of content objects to return per page"}, {"in"=>"query", "name"=>"orderby", "description"=>"Orders the content by a particular field"}, {"in"=>"query", "name"=>"postingDay", "description"=>"The posting date of the blog post to be returned"}, {"in"=>"query", "name"=>"spaceKey", "description"=>"The key of the space to be queried for its content"}, {"in"=>"query", "name"=>"start", "description"=>"The starting index of the returned content"}, {"in"=>"query", "name"=>"status", "description"=>"Filter the results to a set of content based on their status"}, {"in"=>"query", "name"=>"title", "description"=>"The title of the page to be returned"}, {"in"=>"query", "name"=>"trigger", "description"=>"If set to `viewed`, the request will trigger a viewed event for the content"}, {"in"=>"query", "name"=>"type", "description"=>"The type of content to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content"]}, "post"=>{"summary"=>"Create content", "description"=>"Creates a new piece of content or publishes an existing draft. \n\nTo publish a draft, add the `id` and `status` properties to the body of the request. \nSet the `id` to the ID of the draft and set the `status` to 'current'. When the \nrequest is sent, a new piece of content will be created and the metadata from the \ndraft will be transferred into it.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Add' permission for the \nspace that the content will be created in, and permission to view the draft if publishing a draft.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ContentResource.createContent_post", "x-api-path-slug"=>"content-post", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"A multi-value parameter indicating which properties of the new content to expand"}, {"in"=>"query", "name"=>"status", "description"=>"Filter the returned content by status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content"]}}, "/content/blueprint/instance/{draftId}"=>{"post"=>{"summary"=>"Publish legacy draft", "description"=>"Publishes a legacy draft of a page created from a blueprint. Legacy drafts \nwill eventually be removed in favour of shared drafts. For now, this method \nworks the same as [Publish shared draft](#api-content-blueprint-instance-draftId-put).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \nPermission to view the draft and 'Add' permission for the space that \nthe content will be created in.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ContentBlueprintResource.publishLegacyDraft_post", "x-api-path-slug"=>"contentblueprintinstancedraftid-post", "parameters"=>[{"in"=>"path", "name"=>"draftId", "description"=>"The ID of the draft page that was created from a blueprint"}, {"in"=>"query", "name"=>"expand", "description"=>"A multi-value parameter indicating which properties of the new content to expand when returned"}, {"in"=>"query", "name"=>"status", "description"=>"The status of the content to be updated, i"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Publish", "Legacy", "Draft"]}, "put"=>{"summary"=>"Publish shared draft", "description"=>"Publishes a shared draft of a page created from a blueprint.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \nPermission to view the draft and 'Add' permission for the space that \nthe content will be created in.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ContentBlueprintResource.publishSharedDraft_put", "x-api-path-slug"=>"contentblueprintinstancedraftid-put", "parameters"=>[{"in"=>"path", "name"=>"draftId", "description"=>"The ID of the draft page that was created from a blueprint"}, {"in"=>"query", "name"=>"expand", "description"=>"A multi-value parameter indicating which properties of the new content to expand when returned"}, {"in"=>"query", "name"=>"status", "description"=>"The status of the content to be updated, i"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Publish", "Shared", "Draft"]}}, "/content/search"=>{"get"=>{"summary"=>"Search content by CQL", "description"=>"Returns the list of content that matches a Confluence Query Language \n(CQL) query. For information on CQL, see: \n[Advanced searching using CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \nPermission to access the Confluence site ('Can use' global permission). \nOnly content that the user has permission to view will be returned.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ContentResource.searchContentByCQL_get", "x-api-path-slug"=>"contentsearch-get", "parameters"=>[{"in"=>"query", "name"=>"cql", "description"=>"The CQL string that is used to find the requested content"}, {"in"=>"query", "name"=>"cqlcontext", "description"=>"The space, content, and content status to execute the search against"}, {"in"=>"query", "name"=>"expand", "description"=>"A multi-value parameter indicating which properties of the content to expand"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of content objects to return per page"}, {"in"=>"query", "name"=>"start", "description"=>"The starting index of the returned content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Content", "By", "CQL"]}}, "/content/{id}"=>{"get"=>{"summary"=>"Get content by ID", "description"=>"Returns a single piece of content, like a page or a blog post.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \nPermission to view the content. If the content is a blog post, 'View' permission \nfor the space is required.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ContentResource.getContentById_get", "x-api-path-slug"=>"contentid-get", "parameters"=>[{"in"=>"query", "name"=>"embeddedContentRender", "description"=>"The version of embedded content (e"}, {"in"=>"query", "name"=>"expand", "description"=>"A multi-value parameter indicating which properties of the content to expand"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the content to be returned"}, {"in"=>"query", "name"=>"status", "description"=>"Filter the results to a set of content based on their status"}, {"in"=>"query", "name"=>"trigger", "description"=>"If set to `viewed`, the request will trigger a viewed event for the content"}, {"in"=>"query", "name"=>"version", "description"=>"The version number of the content to be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content", "By", "ID"]}, "put"=>{"summary"=>"Update content", "description"=>"Updates a piece of content. Use this method to update the title or body \nof a piece of content, change the status, change the parent page, and more.\n\nNote, updating draft content is currently not supported.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \nPermission to update the content.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ContentResource.updateContent_put", "x-api-path-slug"=>"contentid-put", "parameters"=>[{"in"=>"query", "name"=>"conflictPolicy", "description"=>"The action that should be taken when conflicts are discovered"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the content to be updated"}, {"in"=>"query", "name"=>"status", "description"=>"The updated status of the content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content"]}, "delete"=>{"summary"=>"Delete content", "description"=>"Moves a piece of content to the space's trash or purges it from the trash, \ndepending on the content's type and status:\n\n- If the content's type is `page` or `blogpost` and its status is `current`, \nit will be trashed.\n- If the content's type is `page` or `blogpost` and its status is `trashed`, \nthe content will be purged from the trash and deleted permanently. Note, \nyou must also set the `status` query parameter to `trashed` in your request.\n- If the content's type is `comment` or `attachment`, it will be deleted \npermanently without being trashed.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \n'Delete' permission for the space that the content is in, and permission to edit the content.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ContentResource.deleteContent_delete", "x-api-path-slug"=>"contentid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the content to be deleted"}, {"in"=>"query", "name"=>"status", "description"=>"Set this to `trashed`, if the contents status is `trashed` and you want to purge it"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content"]}}, "/content/{id}/child"=>{"get"=>{"summary"=>"Get content children", "description"=>"Returns a map of the direct children of a piece of content. A piece of content \nhas different types of child content, depending on its type. These are \nthe default parent-child content type relationships:\n\n- `page`: child content is `page`, `comment`, `attachment`\n- `blogpost`: child content is `comment`, `attachment`\n- `attachment`: child content is `comment`\n- `comment`: child content is `attachment`\n\nApps can override these default relationships. Apps can also introduce \nnew content types that create new parent-child content relationships.\n\nNote, the map will always include all child content types that are valid \nfor the content. However, if the content has no instances of a child content \ntype, the map will contain an empty array for that child content type.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, \nand permission to view the content if it is a page.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ChildContentResource.getContentChildren_get", "x-api-path-slug"=>"contentidchild-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"A multi-value parameter indicating which properties of the children to expand, where:- `attachment` returns all attachments for the content"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the content to be queried for its children"}, {"in"=>"query", "name"=>"parentVersion", "description"=>"The version of the parent content to retrieve children for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content", "Children"]}}, "/content/{id}/child/attachment"=>{"get"=>{"summary"=>"Get attachments", "description"=>"Returns the attachments for a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \nPermission to view the content. If the content is a blog post, 'View' permission \nfor the space is required.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.AttachmentResource.getAttachments_get", "x-api-path-slug"=>"contentidchildattachment-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"A multi-value parameter indicating which properties of the attachments to expand"}, {"in"=>"query", "name"=>"filename", "description"=>"Filter the results to attachments that match the filename"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the content to be queried for its attachments"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of attachments to return per page"}, {"in"=>"query", "name"=>"mediaType", "description"=>"Filter the results to attachments that match the media type"}, {"in"=>"query", "name"=>"start", "description"=>"The starting index of the returned attachments"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachments"]}, "post"=>{"summary"=>"Create attachment", "description"=>"Adds an attachment to a piece of content. This method only adds a new \nattachment. If you want to update an existing attachment, use \n[Create or update attachments](#api-content-id-child-attachment-put).\n\nNote, you must set a `X-Atlassian-Token: nocheck` header on the request \nfor this method, otherwise it will be blocked. This protects against XSRF \nattacks, which is necessary as this method accepts multipart/form-data.\n\nThe media type 'multipart/form-data' is defined in [RFC 1867](https://www.ietf.org/rfc/rfc1867.txt). \nMost client libraries have classes that make it easier to implement \nmultipart posts, like the [MultiPartEntity](http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html) \nJava class provided by Apache HTTP Components.\n\nExample: This curl command attaches a file ('example.txt') to a container \n(id='123') with a comment and `minorEdits`=true.\n\n``` bash\ncurl -D- \\\n -u admin:admin \\\n -X POST \\\n -H \"X-Atlassian-Token: nocheck\" \\\n -F \"file=@example.txt\" \\\n -F \"minorEdit=true\" \\\n -F \"comment=Example attachment comment\" \\\n http://myhost/rest/api/content/123/child/attachment\n```\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \nPermission to update the content.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.AttachmentResource.createAttachments_post", "x-api-path-slug"=>"contentidchildattachment-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the content to add the attachment to"}, {"in"=>"query", "name"=>"status", "description"=>"The status of the content that the attachment is being added to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}, "put"=>{"summary"=>"Create or update attachment", "description"=>"Adds an attachment to a piece of content. If the attachment already exists \nfor the content, then the attachment is updated (i.e. a new version of the \nattachment is created).\n\nNote, you must set a `X-Atlassian-Token: nocheck` header on the request \nfor this method, otherwise it will be blocked. This protects against XSRF \nattacks, which is necessary as this method accepts multipart/form-data.\n\nThe media type 'multipart/form-data' is defined in [RFC 1867](https://www.ietf.org/rfc/rfc1867.txt). \nMost client libraries have classes that make it easier to implement \nmultipart posts, like the [MultiPartEntity](http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html) \nJava class provided by Apache HTTP Components.\n\nExample: This curl command attaches a file ('example.txt') to a piece of \ncontent (id='123') with a comment and `minorEdits`=true. If the 'example.txt' \nfile already exists, it will update it with a new version of the attachment.\n\n``` bash\ncurl -D- \\\n -u admin:admin \\\n -X PUT \\\n -H \"X-Atlassian-Token: nocheck\" \\\n -F \"file=@example.txt\" \\\n -F \"minorEdit=true\" \\\n -F \"comment=Example attachment comment\" \\\n http://myhost/rest/api/content/123/child/attachment\n```\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \nPermission to update the content.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.AttachmentResource.createOrUpdateAttachments_put", "x-api-path-slug"=>"contentidchildattachment-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the content to add the attachment to"}, {"in"=>"query", "name"=>"status", "description"=>"The status of the content that the attachment is being added to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Update", "Attachment"]}}, "/content/{id}/child/attachment/{attachmentId}"=>{"put"=>{"summary"=>"Update attachment properties", "description"=>"Updates the attachment properties, i.e. the non-binary data of an attachment \nlike the filename, media-type, comment, and parent container.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \nPermission to update the content.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.AttachmentResource.updateAttachmentProperties_put", "x-api-path-slug"=>"contentidchildattachmentattachmentid-put", "parameters"=>[{"in"=>"path", "name"=>"attachmentId", "description"=>"The ID of the attachment to update"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the content that the attachment is attached to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment", "Properties"]}}, "/content/{id}/child/attachment/{attachmentId}/data"=>{"post"=>{"summary"=>"Update attachment data", "description"=>"Updates the binary data of an attachment, given the attachment ID, and \noptionally the comment and the minor edit field.\n\nThis method is essentially the same as [Create or update attachments](#api-content-id-child-attachment-put), \nexcept that it matches the attachment ID rather than the name.\n\nNote, you must set a `X-Atlassian-Token: nocheck` header on the request \nfor this method, otherwise it will be blocked. This protects against XSRF \nattacks, which is necessary as this method accepts multipart/form-data.\n\nThe media type 'multipart/form-data' is defined in [RFC 1867](https://www.ietf.org/rfc/rfc1867.txt). \nMost client libraries have classes that make it easier to implement \nmultipart posts, like the [MultiPartEntity](http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html) \nJava class provided by Apache HTTP Components.\n\nExample: This curl command updates an attachment (id='att456') that is attached \nto a piece of content (id='123') with a comment and `minorEdits`=true. \n\n``` bash\ncurl -D- \\\n -u admin:admin \\\n -X POST \\\n -H \"X-Atlassian-Token: nocheck\" \\\n -F \"file=@example.txt\" \\\n -F \"minorEdit=true\" \\\n -F \"comment=Example attachment comment\" \\\n http://myhost/rest/api/content/123/child/attachment/att456/data\n```\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \nPermission to update the content.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.AttachmentResource.updateAttachmentData_post", "x-api-path-slug"=>"contentidchildattachmentattachmentiddata-post", "parameters"=>[{"in"=>"path", "name"=>"attachmentId", "description"=>"The ID of the attachment to update"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the content that the attachment is attached to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment", "Data"]}}, "/content/{id}/child/comment"=>{"get"=>{"summary"=>"Get content comments", "description"=>"Returns the comments on a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, \nand permission to view the content if it is a page.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ChildContentResource.getContentComments_get", "x-api-path-slug"=>"contentidchildcomment-get", "parameters"=>[{"in"=>"query", "name"=>"depth", "description"=>"Currently, this parameter is not used"}, {"in"=>"query", "name"=>"expand", "description"=>"A multi-value parameter indicating which properties of the attachments to expand"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the content to be queried for its comments"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of comments to return per page"}, {"in"=>"query", "name"=>"location", "description"=>"The location of the comments in the page"}, {"in"=>"query", "name"=>"parentVersion", "description"=>"The version of the parent content to retrieve children for"}, {"in"=>"query", "name"=>"start", "description"=>"The starting index of the returned comments"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content", "Comments"]}}, "/content/{id}/child/{type}"=>{"get"=>{"summary"=>"Get content children by type", "description"=>"Returns all children of a given type, for a piece of content. \nA piece of content has different types of child content, depending on its type:\n\n- `page`: child content is `page`, `comment`, `attachment`\n- `blogpost`: child content is `comment`, `attachment`\n- `attachment`: child content is `comment`\n- `comment`: child content is `attachment`\n\nCustom content types that are provided by apps can also be returned.\n\nNote, this method only returns direct children. To return children at all \nlevels, use [Get descendants by type](#api-content-id-descendant-type-get).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, \nand permission to view the content if it is a page.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ChildContentResource.getContentChildrenByType_get", "x-api-path-slug"=>"contentidchildtype-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"A multi-value parameter indicating which properties of the new content to expand"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the content to be queried for its children"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of content to return per page"}, {"in"=>"query", "name"=>"parentVersion", "description"=>"The version of the parent content to retrieve children for"}, {"in"=>"query", "name"=>"start", "description"=>"The starting index of the returned content"}, {"in"=>"path", "name"=>"type", "description"=>"The type of children to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content", "Children", "By", "Type"]}}, "/content/{id}/descendant"=>{"get"=>{"summary"=>"Get content descendants", "description"=>"Returns a map of the descendants of a piece of content. This is similar \nto [Get content children](#api-content-id-child-get), except that this \nmethod returns child pages at all levels, rather than just the direct \nchild pages.\n\nA piece of content has different types of descendants, depending on its type:\n\n- `page`: descendant is `page`, `comment`, `attachment`\n- `blogpost`: descendant is `comment`, `attachment`\n- `attachment`: descendant is `comment`\n- `comment`: descendant is `attachment`\n\nThe map will always include all descendant types that are valid for the content. \nHowever, if the content has no instances of a descendant type, the map will \ncontain an empty array for that descendant type.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \n'View' permission for the space, and permission to view the content if it \nis a page.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.DescendantContentResource.getContentDescendants_g", "x-api-path-slug"=>"contentiddescendant-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"A multi-value parameter indicating which properties of the children to expand, where:- `attachment` returns all attachments for the content"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the content to be queried for its descendants"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content", "Descendants"]}}, "/content/{id}/descendant/{type}"=>{"get"=>{"summary"=>"Get content descendants by type", "description"=>"Returns all descendants of a given type, for a piece of content. This is \nsimilar to [Get content children by type](#api-content-id-child-type-get), \nexcept that this method returns child pages at all levels, rather than just \nthe direct child pages.\n\nA piece of content has different types of descendants, depending on its type:\n\n- `page`: descendant is `page`, `comment`, `attachment`\n- `blogpost`: descendant is `comment`, `attachment`\n- `attachment`: descendant is `comment`\n- `comment`: descendant is `attachment`\n\nCustom content types that are provided by apps can also be returned.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \n'View' permission for the space, and permission to view the content if it \nis a page.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.DescendantContentResource.descendantsOfType_get", "x-api-path-slug"=>"contentiddescendanttype-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"A multi-value parameter indicating which properties of the new content to expand"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the content to be queried for its descendants"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of content to return per page"}, {"in"=>"query", "name"=>"start", "description"=>"The starting index of the returned content"}, {"in"=>"path", "name"=>"type", "description"=>"The type of descendants to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content", "Descendants", "By", "Type"]}}, "/content/{id}/history"=>{"get"=>{"summary"=>"Get history for content", "description"=>"Returns the most recent update for a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ContentResource.getHistoryForContent_get", "x-api-path-slug"=>"contentidhistory-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"A multi-value parameter indicating which properties of the content history to expand"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the content to be queried for its history"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historycontent"]}}, "/content/{id}/history/{version}/macro/id/{macroId}"=>{"get"=>{"summary"=>"Get macro body by macro ID", "description"=>"Returns the body of a macro in storage format, for the given macro ID. \nThis includes information like the name of the macro, the body of the macro, \nand any macro parameters. This method is mainly used by Cloud apps.\n\nAbout the macro ID: When a macro is created in a new version of content, \nConfluence will generate a random ID for it, unless an ID is specified \n(by an app). The macro ID will look similar to this: '50884bd9-0cb8-41d5-98be-f80943c14f96'. \nThe ID is then persisted as new versions of content are created, and is \nonly modified by Confluence if there are conflicting IDs.\n\nNote, to preserve backwards compatibility this resource will also match on \nthe hash of the macro body, even if a macro ID is found. This check will \neventually become redundant, as macro IDs are generated for pages and \ntransparently propagate out to all instances.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \nPermission to view the content that the macro is in.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ContentResource.getMacroBodyByMacroId_get", "x-api-path-slug"=>"contentidhistoryversionmacroidmacroid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID for the content that contains the macro"}, {"in"=>"path", "name"=>"macroId", "description"=>"The ID of the macro"}, {"in"=>"path", "name"=>"version", "description"=>"The version of the content that contains the macro"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Macro", "Body", "By", "Macro", "ID"]}}, "/content/{id}/label"=>{"get"=>{"summary"=>"Get labels for content", "description"=>"Returns the labels on a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \n'View' permission for the space and permission to view the content if it is a page.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ContentLabelsResource.getLabelsForContent_get", "x-api-path-slug"=>"contentidlabel-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the content to be queried for its labels"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of labels to return per page"}, {"in"=>"query", "name"=>"prefix", "description"=>"Filters the results to labels with the specified prefix"}, {"in"=>"query", "name"=>"start", "description"=>"The starting index of the returned labels"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labelscontent"]}, "post"=>{"summary"=>"Add labels to content", "description"=>"Adds labels to a piece of content. Does not modify the existing labels.\n\nNotes:\n\n- Labels can also be added when creating content ([Create content](#api-content-post)).\n- Labels can be updated when updating content ([Update content](#api-content-id-put)). \nThis will delete the existing labels and replace them with the labels in \nthe request.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \nPermission to update the content.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ContentLabelsResource.addLabelsToContent_post", "x-api-path-slug"=>"contentidlabel-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the content that will have labels added to it"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labels", "To", "Content"]}, "delete"=>{"summary"=>"Remove label from content using query parameter", "description"=>"Removes a label from a piece of content. This is similar to \n[Remove label from content](#api-content-id-label-label-delete) \nexcept that the label name is specified via a query parameter. \n\nUse this method if the label name has \"/\" characters, as \n[Remove label from content using query parameter](#api-content-id-label-delete) \ndoes not accept \"/\" characters for the label name.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \nPermission to update the content.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ContentLabelsResource.removeLabelFromContentUsing", "x-api-path-slug"=>"contentidlabel-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the content that the label will be removed from"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the label to be removed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Label", "From", "Content", "Using", "Query", "Parameter"]}}, "/content/{id}/label/{label}"=>{"delete"=>{"summary"=>"Remove label from content", "description"=>"Removes a label from a piece of content. This is similar to \n[Remove label from content using query parameter](#api-content-id-label-delete) \nexcept that the label name is specified via a path parameter. \n\nUse this method if the label name does not have \"/\" characters, as the path \nparameter does not accept \"/\" characters for security reasons. Otherwise, \nuse [Remove label from content using query parameter](#api-content-id-label-delete).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: \nPermission to update the content.", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ContentLabelsResource.removeLabelFromContent_dele", "x-api-path-slug"=>"contentidlabellabel-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the content that the label will be removed from"}, {"in"=>"path", "name"=>"label", "description"=>"The name of the label to be removed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Label", "From", "Content"]}}, "/content/{id}/notification/child-created"=>{"get"=>{"summary"=>"Get watches for page", "description"=>"Returns the watches for a page. A user that watches a page will receive \nreceive notifications when the page is updated.\n\nIf you want to manage watches for a page, use the following `user` methods:\n\n- [Get content watch status for user](#api-user-watch-content-contentId-get)\n- [Add content watch](#api-user-watch-content-contentId-post)\n- [Remove content watch](#api-user-watch-content-contentId-delete)\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ContentNotificationsResource.getWatchesForPage_ge", "x-api-path-slug"=>"contentidnotificationchildcreated-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the content to be queried for its watches"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of watches to return per page"}, {"in"=>"query", "name"=>"start", "description"=>"The starting index of the returned watches"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watchespage"]}}, "/content/{id}/notification/created"=>{"get"=>{"summary"=>"Get watches for space", "description"=>"Returns all space watches for the space that the content is in. A user that \nwatches a space will receive receive notifications when any content in the \nspace is updated.\n\nIf you want to manage watches for a space, use the following `user` methods:\n\n- [Get space watch status for user](#api-user-watch-space-spaceKey-get)\n- [Add space watch](#api-user-watch-space-spaceKey-post)\n- [Remove space watch](#api-user-watch-space-spaceKey-delete)\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).", "operationId"=>"com.atlassian.confluence.plugins.restapi.resources.ContentNotificationsResource.getWatchesForSpace_g", "x-api-path-slug"=>"contentidnotificationcreated-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the content to be queried for its watches"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of watches to return per page"}, {"in"=>"query", "name"=>"start", "description"=>"The starting index of the returned watches"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watchesspace"]}}, "/content/{id}/pagehierarchy/copy"=>{"post"=>{"summary"=>"Copy page hierarchy", "description"=>"Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions and attachments.\n The id path parameter refers to the content id of the page to copy, and the new parent of this copied page is defined using the destinationPageId in the request body.\n The titleOptions object defines the rules of renaming page titles during the copy;\n for example, search and replace can be used in conjunction to rewrite the copied page titles.\n\n Response example:\n |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
rite-kit{"rite-kit-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Rite Kit", "x-complete"=>1, "info"=>{"title"=>"Rite Kit", "description"=>"ritekit-api-is-based-on-rest-principles-authentication-uses-standard-oauth-2-0-processgetting-started1--sign-up-for-ritekithttpsritekit-com1--go-to-developer-dashboardhttpsritekit-comdeveloperdashboard1--click-create-a-token-button-to-get-your-client-id-and-client-secret1--study-the-documentation-below-for-more-info-on-oauth-go-to-httpoauth-net1--when-you-reach-your-free-limit-of-calls-per-month-upgrade-to-paid-tiershttpsritekit-comdeveloper-options-for-authorizing-api-calls-a-using-client-id-directlyyou-can-directly-connect-to-our-api-using-your-client-id-by-sending-it-as-a-get-query-parameter--this-option-is-simple-no-need-for-oauth-but-it-should-be-used-only-in-case-the-client-id-is-not-exposed-publicly-get--httpsapi-ritekit-comv1statsmultiplehashtagstagsphpclient-id292c6912e7710c838347ae178b4a-b-using-access-token-oauth-2-0once-you-have-valid-access-token-you-can-access-our-api-by-sending-the-token-in-the-authorization-header-bearer-or-as-a-query-access-token--see-the-oauth-2-0-section-to-learn-how-to-get-access-token-and-keep-refreshing-it-authorization-bearer-xxxxorget--httpsapi-ritekit-comv1statsmultiplehashtagstagsphpaccess-token292c6912e7710c838347ae178b4a-oauth-2-0oauthschemahttpscdn-ritekit-comassetsmedia1oauthsimple-png-get-access-tokenuse-your-client-credentials-to-get-the-token-post---httpsritekit-comoauthtoken-----------grant-typeclient-credentials-----------client-idclient-id-----------client-secretclient-secret-----------scopedata-required-grant-type--client-credentials-required-client-id-client-id-required-client-secret-client-secret-required-always-use-scopedata-response--------access-token292c6912e7710c838347ae178b4a--------token-typebearer--------expires-in-3600--------refresh-token292c6912e7710c838347ae178b4a-----refresh-tokenevery-access-token-has-a-lifetime--you-can-use-refresh-token-to-request-a-new-access-token-post---httpsritekit-comoauthtoken-----------grant-typerefresh-token-----------refresh-tokenrefresh-token-----------client-idclient-id-----------scopedata-required-grant-type--refresh-token-required-refresh-token--refresh-token-the-refresh-token-you-got-from-the-expired-token-required-client-id-client-id-required-client-secret-client-secret-required-scope-always-use-scopedata-response--------access-token292c6912e7710c838347ae178b4a--------token-typebearer--------expires-in-3600--------refresh-token292c6912e7710c838347ae178b4a----", "version"=>"1.0.0"}, "host"=>"api.ritekit.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/emoji/auto-emojify"=>{"get"=>{"summary"=>"Auto-Emojify", "description"=>"Returns text of the post with emoji added", "operationId"=>"v1.emoji.auto_emojify.get", "x-api-path-slug"=>"v1emojiautoemojify-get", "parameters"=>[{"in"=>"query", "name"=>"text", "description"=>"Text of the post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/emoji/suggestions"=>{"get"=>{"summary"=>"Emoji Suggestions", "description"=>"Returns list of emoji suggestions for a given text of the post", "operationId"=>"v1.emoji.suggestions.get", "x-api-path-slug"=>"v1emojisuggestions-get", "parameters"=>[{"in"=>"query", "name"=>"text", "description"=>"Text of the post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/images/animate"=>{"get"=>{"summary"=>"Animate Image", "description"=>"Returns URL of an animated GIF.", "operationId"=>"v1.images.animate.get", "x-api-path-slug"=>"v1imagesanimate-get", "parameters"=>[{"in"=>"query", "name"=>"type", "description"=>"URL of the company"}, {"in"=>"query", "name"=>"url", "description"=>"URL of the company"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/images/logo"=>{"get"=>{"summary"=>"Company Logo", "description"=>"Returns a company logo based on website domain. If the logo is not in our database yet, it will be extracted from the site on the fly. White logo background is automatically removed to make the logo look better on color backgrounds.", "operationId"=>"v1.images.logo.get", "x-api-path-slug"=>"v1imageslogo-get", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"URL of the company"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/images/quote"=>{"get"=>{"summary"=>"Text to Image", "description"=>"Returns URL of an image created from text according to given style parameters", "operationId"=>"v1.images.quote.get", "x-api-path-slug"=>"v1imagesquote-get", "parameters"=>[{"in"=>"query", "name"=>"author", "description"=>"Name of the author/source"}, {"in"=>"query", "name"=>"authorFont", "description"=>"Font-family used for author name"}, {"in"=>"query", "name"=>"authorFontColor", "description"=>"Font color of the author"}, {"in"=>"query", "name"=>"backgroundColor", "description"=>"Background color for solid background type"}, {"in"=>"query", "name"=>"bgType", "description"=>"Background type (gradient/solid)"}, {"in"=>"query", "name"=>"brandLogo", "description"=>"URL of the brand logo"}, {"in"=>"query", "name"=>"enableHighlight", "description"=>"Enable highlight on quote text"}, {"in"=>"query", "name"=>"fontSize", "description"=>"Font size for the quote (author font size is calculated automatically)"}, {"in"=>"query", "name"=>"gradientColor1", "description"=>"First color for gradient background type"}, {"in"=>"query", "name"=>"gradientColor2", "description"=>"Second color for gradient background type"}, {"in"=>"query", "name"=>"gradientType", "description"=>"Type of gradient background (linear/radial)"}, {"in"=>"query", "name"=>"highlightColor", "description"=>"Color used for highlight"}, {"in"=>"query", "name"=>"quote", "description"=>"Text of the quote"}, {"in"=>"query", "name"=>"quoteFont", "description"=>"Font-family used for quote text"}, {"in"=>"query", "name"=>"quoteFontColor", "description"=>"Font color of the quote text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/influencers/hashtag/{hashtag}"=>{"get"=>{"summary"=>"Influencers for a Hashtag", "description"=>"Returns list of Twitter influencers for a given hashtag", "operationId"=>"v1.influencers.hashtag.hashtag.get", "x-api-path-slug"=>"v1influencershashtaghashtag-get", "parameters"=>[{"in"=>"path", "name"=>"hashtag", "description"=>"Hashtag without # mark"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/link/cta"=>{"get"=>{"summary"=>"List of CTAs", "description"=>"Returns list of available CTA for current user. Requires each user to authenticate with RiteKit", "operationId"=>"v1.link.cta.get", "x-api-path-slug"=>"v1linkcta-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/link/short-link"=>{"get"=>{"summary"=>"Shorten Link", "description"=>"Returns a shorten link with a given CTA.", "operationId"=>"v1.link.short_link.get", "x-api-path-slug"=>"v1linkshortlink-get", "parameters"=>[{"in"=>"query", "name"=>"cta", "description"=>"cta id"}, {"in"=>"query", "name"=>"url", "description"=>"URL"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/search/trending"=>{"get"=>{"summary"=>"Trending Hashtags", "description"=>"Returns list of hashtags currently trending on Twitter", "operationId"=>"v1.search.trending.get", "x-api-path-slug"=>"v1searchtrending-get", "parameters"=>[{"in"=>"query", "name"=>"green", "description"=>"Restrict results only to green hashtags"}, {"in"=>"query", "name"=>"latin", "description"=>"Restrict results only to hashtags with latin characters"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/stats/auto-hashtag?post={post}"=>{"get"=>{"summary"=>"Auto-Hashtag", "description"=>"Returns auto-hashtagged text of the post.", "operationId"=>"v1.stats.auto_hashtag_post_post.get", "x-api-path-slug"=>"v1statsautohashtagpostpost-get", "parameters"=>[{"in"=>"path", "name"=>"post", "description"=>"Text of the post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/stats/hashtag-suggestions/{topic}"=>{"get"=>{"summary"=>"Hashtag Suggestions", "description"=>"Returns list of hashtag suggestions and their real-time stats for a given topic", "operationId"=>"v1.stats.hashtag_suggestions.topic.get", "x-api-path-slug"=>"v1statshashtagsuggestionstopic-get", "parameters"=>[{"in"=>"path", "name"=>"topic", "description"=>"Topic"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/stats/history/{hashtag}"=>{"get"=>{"summary"=>"Hashtag History", "description"=>"Returns historical stats for a given hashtag from the last 30 days", "operationId"=>"v1.stats.history.hashtag.get", "x-api-path-slug"=>"v1statshistoryhashtag-get", "parameters"=>[{"in"=>"path", "name"=>"hashtag", "description"=>"Hashtag without # mark"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/v1/stats/multiple-hashtags"=>{"get"=>{"summary"=>"Hashtag Stats", "description"=>"Returns real-time stats for up to 100 hashtags (updated hourly).", "operationId"=>"v1.stats.multiple_hashtags.get", "x-api-path-slug"=>"v1statsmultiplehashtags-get", "parameters"=>[{"in"=>"query", "name"=>"tags", "description"=>"Hashtag(s) without # mark"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"Rite Kit", "x-slug"=>"rite-kit", "description"=>"", "image"=>"", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"General Data,Links,Publish,Relative Data,Service API,Social", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"rite-kit/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Rite Kit", "x-api-slug"=>"rite-kit", "description"=>"", "image"=>"", "humanURL"=>"http://ritekit.com", "baseURL"=>"https://api.ritekit.com//", "tags"=>"General Data,Links,Publish,Relative Data,Service API,Social", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/rite-kit/v1statsmultiplehashtags-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/rite-kit/rite-kit-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://blog.ritekit.com/"}, {"type"=>"x-developer", "url"=>"https://ritekit.docs.apiary.io/#"}, {"type"=>"x-github", "url"=>"https://github.com/RiteKit"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/RiteTag"}, {"type"=>"x-website", "url"=>"http://ritekit.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
eventbrite{"eventbrite-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Eventbrite", "x-complete"=>1, "info"=>{"title"=>"Eventbrite API", "description"=>"create-manage-promote-events--add-eventmanagement-features-to-your-site--show-the-world-what-exciting-things-are-happening-around-them-", "version"=>"1.0.0"}, "host"=>"www.eventbriteapi.com", "basePath"=>"/v3/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/events/"=>{"post"=>{"summary"=>"Post Events", "description"=>"Makes a new event, and returns an event for the specified event.", "operationId"=>"postEvents", "x-api-path-slug"=>"events-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"event.capacity", "description"=>"Set specific capacity (if omitted, sums ticket capacities)", "type"=>"query"}, {"in"=>"query", "name"=>"event.category_id", "description"=>"The category (vertical) of the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.currency", "description"=>"Event currency (3 letter code)", "type"=>"query"}, {"in"=>"query", "name"=>"event.description.html", "description"=>"The description on the event page", "type"=>"query"}, {"in"=>"query", "name"=>"event.end.timezone", "description"=>"End time timezone (Olson format)", "type"=>"query"}, {"in"=>"query", "name"=>"event.end.utc", "description"=>"The end time of the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.format_id", "description"=>"The format (general type) of the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.hide_end_date", "description"=>"Whether the end date should be hidden", "type"=>"query"}, {"in"=>"query", "name"=>"event.hide_start_date", "description"=>"Whether the start date should be hidden", "type"=>"query"}, {"in"=>"query", "name"=>"event.invite_only", "description"=>"Only invited users can see the event page", "type"=>"query"}, {"in"=>"query", "name"=>"event.is_reserved_seating", "description"=>"If the event is reserved seating", "type"=>"query"}, {"in"=>"query", "name"=>"event.listed", "description"=>"If the event is publicly listed and searchable", "type"=>"query"}, {"in"=>"query", "name"=>"event.logo.id", "description"=>"(Deprecated) The logo for the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.logo_id", "description"=>"The logo for the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.name.html", "description"=>"The name of the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.online_event", "description"=>"Is the event online-only (no venue)?", "type"=>"query"}, {"in"=>"query", "name"=>"event.organizer_id", "description"=>"The ID of the organizer of this event", "type"=>"query"}, {"in"=>"query", "name"=>"event.password", "description"=>"Password needed to see the event in unlisted mode", "type"=>"query"}, {"in"=>"query", "name"=>"event.shareable", "description"=>"If users can share the event on social media", "type"=>"query"}, {"in"=>"query", "name"=>"event.show_pick_a_seat", "description"=>"For reserved seating event, if attendees can pick their seats", "type"=>"query"}, {"in"=>"query", "name"=>"event.show_remaining", "description"=>"If the remaining number of tickets is publicly visible on the event page", "type"=>"query"}, {"in"=>"query", "name"=>"event.show_seatmap_thumbnail", "description"=>"For reserved seating event, if venue map thumbnail visible on the event page", "type"=>"query"}, {"in"=>"query", "name"=>"event.source", "description"=>"Source of the event (defaults to API)", "type"=>"query"}, {"in"=>"query", "name"=>"event.start.timezone", "description"=>"Start time timezone (Olson format)", "type"=>"query"}, {"in"=>"query", "name"=>"event.start.utc", "description"=>"The start time of the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.subcategory_id", "description"=>"The subcategory of the event (US only)", "type"=>"query"}, {"in"=>"query", "name"=>"event.venue_id", "description"=>"The ID of a previously-created venue to associate with this event", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/events/{id}"=>{"get"=>{"summary"=>"Get Events", "description"=>"Returns an event for the specified event. Many of Eventbrite?s API use cases resolve around pulling details of a specific event within an Eventbrite account.", "operationId"=>"getEvents", "x-api-path-slug"=>"eventsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Event Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}, "post"=>{"summary"=>"Post Events", "description"=>"Updates an event. Returns an event for the specified event.", "operationId"=>"postEvents", "x-api-path-slug"=>"eventsid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Event Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/categories/{id}/"=>{"get"=>{"summary"=>"Get Categories", "description"=>"Gets a category by ID as category.", "operationId"=>"getCategories", "x-api-path-slug"=>"categoriesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories"]}}, "/subcategories/"=>{"get"=>{"summary"=>"Get Subcategories", "description"=>"Returns a list of subcategory as subcategories.", "operationId"=>"getSubcategories", "x-api-path-slug"=>"subcategories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subcategories"]}}, "/subcategories/{id}/"=>{"get"=>{"summary"=>"Get Subcategories", "description"=>"Gets a subcategory by ID as subcategory.", "operationId"=>"getSubcategories", "x-api-path-slug"=>"subcategoriesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subcategories"]}}, "/checkout_settings/countries_currencies/"=>{"get"=>{"summary"=>"Get Checkout Settings Countries Currencies", "description"=>"Get the countries and currencies which are supported by Eventbrite for ticket payment", "operationId"=>"getCheckoutSettingsCountriesCurrencies", "x-api-path-slug"=>"checkout-settingscountries-currencies-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkout", "Settings", "Countries", "Currencies"]}}, "/checkout_settings/methods/"=>{"get"=>{"summary"=>"Get Checkout Settings Methods", "description"=>"Get the available checkout methods to do payments given a country and a currency.", "operationId"=>"getCheckoutSettingsMethods", "x-api-path-slug"=>"checkout-settingsmethods-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"Expected methods for Country", "type"=>"query"}, {"in"=>"query", "name"=>"currency", "description"=>"Expected methods for Currency", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkout", "Settings", "Methods"]}}, "/checkout_settings/"=>{"get"=>{"summary"=>"Get Checkout Settings", "description"=>"Searches and returns a list of checkout_settings for the current user as the key checkout_settings.", "operationId"=>"getCheckoutSettings", "x-api-path-slug"=>"checkout-settings-get", "parameters"=>[{"in"=>"query", "name"=>"checkout_methods", "description"=>"One or more optional (comma-separated) checkout methods by which to filter checkout settings", "type"=>"query"}, {"in"=>"query", "name"=>"country", "description"=>"An optional country code by which to filter checkout settings", "type"=>"query"}, {"in"=>"query", "name"=>"currency", "description"=>"An optional currency code by which to filter checkout settings", "type"=>"query"}, {"in"=>"query", "name"=>"search_most_recent_event", "description"=>" ", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkout", "Settings"]}, "post"=>{"summary"=>"Post Checkout Settings", "description"=>"Creates a new checkout_settings object belonging to the current user. Two common settings are Eventbrite Payment Processing ( checkout_method = “eventbrite” ) and PayPal ( checkout_method = “paypal” ). In addition to the checkout_method you must provide the country and currency proceeds from the event should be paid to.", "operationId"=>"postCheckoutSettings", "x-api-path-slug"=>"checkout-settings-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkout", "Settings"]}}, "/checkout_settings/:checkout_settings_id/"=>{"get"=>{"summary"=>"Get Checkout Settings Checkout Settings", "description"=>"Get a specific checkout_settings object by ID", "operationId"=>"getCheckoutSettingsCheckoutSettings", "x-api-path-slug"=>"checkout-settingscheckout-settings-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkout", "Settings", ":checkout", "Settings"]}}, "/events/:event_id/checkout_settings/"=>{"get"=>{"summary"=>"Get Events Event Checkout Settings", "description"=>"Gets and returns a list of checkout_settings associated with a given event by its event_id.", "operationId"=>"getEventsEventCheckoutSettings", "x-api-path-slug"=>"eventsevent-idcheckout-settings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", ":event", "Checkout", "Settings"]}, "post"=>{"summary"=>"Post Events Event Checkout Settings", "description"=>"Associate a single or set of checkout_settings with a given event by its event_id. This does not add more checkout settings to the event, but instead replaces all checkout settings for the event with the one(s) submitted. The JSON post body is a string list of the checkout_settings IDs you want to associate.", "operationId"=>"postEventsEventCheckoutSettings", "x-api-path-slug"=>"eventsevent-idcheckout-settings-post", "parameters"=>[{"in"=>"query", "name"=>"checkout_settings_ids", "description"=>"A list of IDs for checkout settings that should be linked to the event", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", ":event", "Checkout", "Settings"]}}, "/events/:event_id/payout_settings/"=>{"get"=>{"summary"=>"Get Events Event Payout Settings", "description"=>"Gets and returns the payout_settings (user instrument ID) associated with a given event by its event_id.", "operationId"=>"getEventsEventPayoutSettings", "x-api-path-slug"=>"eventsevent-idpayout-settings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", ":event", "Payout", "Settings"]}, "post"=>{"summary"=>"Post Events Event Payout Settings", "description"=>"Associate a payout user instrument ID with a given event, or clear the association by passing a null value for the user instrument ID.", "operationId"=>"postEventsEventPayoutSettings", "x-api-path-slug"=>"eventsevent-idpayout-settings-post", "parameters"=>[{"in"=>"query", "name"=>"payout_settings.user_instrument_vault_id", "description"=>"The vault ID for the user instrument to which payouts are sent", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", ":event", "Payout", "Settings"]}}, "/discounts/:discount_id/"=>{"get"=>{"summary"=>"Get Discounts Discount", "description"=>"Returns the cross_event_discount with the specified :discount_id.", "operationId"=>"getDiscountsDiscount", "x-api-path-slug"=>"discountsdiscount-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Discounts", ":discount"]}, "post"=>{"summary"=>"Post Discounts Discount", "description"=>"Updates the discount with the specified :discount_id. Returns the updated cross_event_discount. The fields sent are the ones that are going to be updated, the fields that are not sent will be unchanged. The same conditions and notes for the discount creation apply.", "operationId"=>"postDiscountsDiscount", "x-api-path-slug"=>"discountsdiscount-id-post", "parameters"=>[{"in"=>"query", "name"=>"discount.amount_off", "description"=>"Fixed reduction amount", "type"=>"query"}, {"in"=>"query", "name"=>"discount.code", "description"=>"Code used to activate discount", "type"=>"query"}, {"in"=>"query", "name"=>"discount.end_date", "description"=>"Allow use until this date", "type"=>"query"}, {"in"=>"query", "name"=>"discount.end_date_relative", "description"=>"Allow use until this number of seconds before the event starts", "type"=>"query"}, {"in"=>"query", "name"=>"discount.hold_ids", "description"=>"IDs of holds this discount can unlock", "type"=>"query"}, {"in"=>"query", "name"=>"discount.percent_off", "description"=>"Percentage reduction", "type"=>"query"}, {"in"=>"query", "name"=>"discount.quantity_available", "description"=>"Number of discount uses", "type"=>"query"}, {"in"=>"query", "name"=>"discount.start_date", "description"=>"Allow use from this date", "type"=>"query"}, {"in"=>"query", "name"=>"discount.start_date_relative", "description"=>"Allow use from this number of seconds before the event starts", "type"=>"query"}, {"in"=>"query", "name"=>"discount.ticket_class_ids", "description"=>"IDs of tickets to limit discount to", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Discounts", ":discount"]}, "delete"=>{"summary"=>"Delete Discounts Discount", "description"=>"Deletes the cross_event_discount with the specified :discount_id.\nOnly unused discounts can be deleted.", "operationId"=>"deleteDiscountsDiscount", "x-api-path-slug"=>"discountsdiscount-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Discounts", ":discount"]}}, "/discounts/"=>{"post"=>{"summary"=>"Post Discounts", "description"=>"Creates a discount. Returns the created cross_event_discount.", "operationId"=>"postDiscounts", "x-api-path-slug"=>"discounts-post", "parameters"=>[{"in"=>"query", "name"=>"discount.amount_off", "description"=>"Fixed reduction amount", "type"=>"query"}, {"in"=>"query", "name"=>"discount.code", "description"=>"Code used to activate discount", "type"=>"query"}, {"in"=>"query", "name"=>"discount.end_date", "description"=>"Allow use until this date", "type"=>"query"}, {"in"=>"query", "name"=>"discount.end_date_relative", "description"=>"Allow use until this number of seconds before the event starts", "type"=>"query"}, {"in"=>"query", "name"=>"discount.event_id", "description"=>"ID of the event", "type"=>"query"}, {"in"=>"query", "name"=>"discount.hold_ids", "description"=>"IDs of holds this discount can unlock", "type"=>"query"}, {"in"=>"query", "name"=>"discount.percent_off", "description"=>"Percentage reduction", "type"=>"query"}, {"in"=>"query", "name"=>"discount.quantity_available", "description"=>"Number of discount uses", "type"=>"query"}, {"in"=>"query", "name"=>"discount.start_date", "description"=>"Allow use from this date", "type"=>"query"}, {"in"=>"query", "name"=>"discount.start_date_relative", "description"=>"Allow use from this number of seconds before the event starts", "type"=>"query"}, {"in"=>"query", "name"=>"discount.ticket_class_ids", "description"=>"IDs of tickets to limit discount to", "type"=>"query"}, {"in"=>"query", "name"=>"discount.ticket_group_id", "description"=>"ID of the ticket group", "type"=>"query"}, {"in"=>"query", "name"=>"discount.type", "description"=>"The type of discount", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Discounts"]}}, "/events/{id}/"=>{"get"=>{"summary"=>"Get Events", "description"=>"Returns an event for the specified event. Many of Eventbrite???s API use cases revolve around pulling details\nof a specific event within an Eventbrite account. Does not support fetching a repeating event series parent\n(see GET /series/:id/).", "operationId"=>"getEvents", "x-api-path-slug"=>"eventsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}, "post"=>{"summary"=>"Post Events", "description"=>"Updates an event. Returns an event for the specified event. Does not support updating a repeating event\nseries parent (see POST /series/:id/).", "operationId"=>"postEvents", "x-api-path-slug"=>"eventsid-post", "parameters"=>[{"in"=>"query", "name"=>"event.capacity", "description"=>"Set specific capacity (if omitted, sums ticket capacities)", "type"=>"query"}, {"in"=>"query", "name"=>"event.category_id", "description"=>"The category (vertical) of the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.currency", "description"=>"Event currency (3 letter code)", "type"=>"query"}, {"in"=>"query", "name"=>"event.description.html", "description"=>"The description on the event page", "type"=>"query"}, {"in"=>"query", "name"=>"event.end.timezone", "description"=>"End time timezone (Olson format)", "type"=>"query"}, {"in"=>"query", "name"=>"event.end.utc", "description"=>"The end time of the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.format_id", "description"=>"The format (general type) of the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.hide_end_date", "description"=>"Whether the end date should be hidden", "type"=>"query"}, {"in"=>"query", "name"=>"event.hide_start_date", "description"=>"Whether the start date should be hidden", "type"=>"query"}, {"in"=>"query", "name"=>"event.invite_only", "description"=>"Only invited users can see the event page", "type"=>"query"}, {"in"=>"query", "name"=>"event.is_reserved_seating", "description"=>"If the event is reserved seating", "type"=>"query"}, {"in"=>"query", "name"=>"event.listed", "description"=>"If the event is publicly listed and searchable", "type"=>"query"}, {"in"=>"query", "name"=>"event.logo.id", "description"=>"(Deprecated) The logo for the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.logo_id", "description"=>"The logo for the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.name.html", "description"=>"The name of the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.online_event", "description"=>"Is the event online-only (no venue)?", "type"=>"query"}, {"in"=>"query", "name"=>"event.organizer_id", "description"=>"The ID of the organizer of this event", "type"=>"query"}, {"in"=>"query", "name"=>"event.password", "description"=>"Password needed to see the event in unlisted mode", "type"=>"query"}, {"in"=>"query", "name"=>"event.shareable", "description"=>"If users can share the event on social media", "type"=>"query"}, {"in"=>"query", "name"=>"event.show_pick_a_seat", "description"=>"For reserved seating event, if attendees can pick their seats", "type"=>"query"}, {"in"=>"query", "name"=>"event.show_remaining", "description"=>"If the remaining number of tickets is publicly visible on the event page", "type"=>"query"}, {"in"=>"query", "name"=>"event.show_seatmap_thumbnail", "description"=>"For reserved seating event, if venue map thumbnail visible on the event page", "type"=>"query"}, {"in"=>"query", "name"=>"event.source", "description"=>"Source of the event (defaults to API)", "type"=>"query"}, {"in"=>"query", "name"=>"event.start.timezone", "description"=>"Start time timezone (Olson format)", "type"=>"query"}, {"in"=>"query", "name"=>"event.start.utc", "description"=>"The start time of the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.subcategory_id", "description"=>"The subcategory of the event (US only)", "type"=>"query"}, {"in"=>"query", "name"=>"event.venue_id", "description"=>"ID of the venue", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}, "delete"=>{"summary"=>"Delete Events", "description"=>"Deletes an event if the delete is permitted. In order for a delete to be permitted, there must be no pending or\ncompleted orders. Returns a boolean indicating success or failure of the delete.", "operationId"=>"deleteEvents", "x-api-path-slug"=>"eventsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/events/{id}/publish/"=>{"post"=>{"summary"=>"Post Events Publish", "description"=>"Publishes an event if it has not already been deleted. In order for publish to be permitted, the event must have all\nnecessary information, including a name and description, an organizer, at least one ticket, and valid payment options.\nThis API endpoint will return argument errors for event fields that fail to validate the publish requirements. Returns\na boolean indicating success or failure of the publish.", "operationId"=>"postEventsPublish", "x-api-path-slug"=>"eventsidpublish-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Publish"]}}, "/events/{id}/unpublish/"=>{"post"=>{"summary"=>"Post Events Unpublish", "description"=>"Unpublishes an event. In order for a free event to be unpublished, it must not have any pending or completed orders,\neven if the event is in the past. In order for a paid event to be unpublished, it must not have any pending or completed\norders, unless the event has been completed and paid out. Returns a boolean indicating success or failure of the\nunpublish.", "operationId"=>"postEventsUnpublish", "x-api-path-slug"=>"eventsidunpublish-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Unpublish"]}}, "/events/{id}/cancel/"=>{"post"=>{"summary"=>"Post Events Cancel", "description"=>"Cancels an event if it has not already been deleted. In order for cancel to be permitted, there must be no pending or\ncompleted orders. Returns a boolean indicating success or failure of the cancel.", "operationId"=>"postEventsCancel", "x-api-path-slug"=>"eventsidcancel-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Cancel"]}}, "/events/{id}/copy/"=>{"post"=>{"summary"=>"Post Events Copy", "description"=>"Creates a duplicate version of the event being copied. Returns the event object for the newly created event.", "operationId"=>"postEventsCopy", "x-api-path-slug"=>"eventsidcopy-post", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"The end time of the new event", "type"=>"query"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the new event", "type"=>"query"}, {"in"=>"query", "name"=>"start_date", "description"=>"The start time of the new event", "type"=>"query"}, {"in"=>"query", "name"=>"timezone", "description"=>"timezone for the new event (Olson format)", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Copy"]}}, "/events/{id}/display_settings/"=>{"get"=>{"summary"=>"Get Events Display Settings", "description"=>"Retrieves the display settings for an event.", "operationId"=>"getEventsDisplaySettings", "x-api-path-slug"=>"eventsiddisplay-settings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Display", "Settings"]}, "post"=>{"summary"=>"Post Events Display Settings", "description"=>"Updates the display settings for an event.", "operationId"=>"postEventsDisplaySettings", "x-api-path-slug"=>"eventsiddisplay-settings-post", "parameters"=>[{"in"=>"query", "name"=>"display_settings.show_end_date", "description"=>"Whether to display the end date on the event listing", "type"=>"query"}, {"in"=>"query", "name"=>"display_settings.show_facebook_friends_going", "description"=>"Whether to display which of the user’s Facebook friends are going", "type"=>"query"}, {"in"=>"query", "name"=>"display_settings.show_map", "description"=>"Whether to display a map to the venue on the event listing", "type"=>"query"}, {"in"=>"query", "name"=>"display_settings.show_organizer_facebook", "description"=>"Whether to display a link to the organizer’s Facebook profile", "type"=>"query"}, {"in"=>"query", "name"=>"display_settings.show_organizer_twitter", "description"=>"Whether to display a link to the organizer’s Twitter profile", "type"=>"query"}, {"in"=>"query", "name"=>"display_settings.show_remaining", "description"=>"Whether to display the number of remaining tickets", "type"=>"query"}, {"in"=>"query", "name"=>"display_settings.show_start_date", "description"=>"Whether to display the start date on the event listing", "type"=>"query"}, {"in"=>"query", "name"=>"display_settings.show_start_end_time", "description"=>"Whether to display event start and end time on the event listing", "type"=>"query"}, {"in"=>"query", "name"=>"display_settings.show_timezone", "description"=>"Whether to display the event timezone on the event listing", "type"=>"query"}, {"in"=>"query", "name"=>"display_settings.terminology", "description"=>"Which terminology should be used to refer to the event (Valid choices are: tickets_vertical, or endurance_vertical)", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Display", "Settings"]}}, "/events/{id}/ticket_classes/"=>{"get"=>{"summary"=>"Get Events Ticket Classes", "description"=>"Returns a paginated response with a key of\nticket_classes, containing a list of ticket_class.", "operationId"=>"getEventsTicketClasses", "x-api-path-slug"=>"eventsidticket-classes-get", "parameters"=>[{"in"=>"query", "name"=>"pos", "description"=>"Only return ticket classes valid for the given point of sale (Valid choices are: online, or at_the_door)", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Ticket", "Classes"]}, "post"=>{"summary"=>"Post Events Ticket Classes", "description"=>"Creates a new ticket class, returning the result as a ticket_class\nunder the key ticket_class.", "operationId"=>"postEventsTicketClasses", "x-api-path-slug"=>"eventsidticket-classes-post", "parameters"=>[{"in"=>"query", "name"=>"ticket_class.auto_hide", "description"=>"Hide this ticket when it is not on sale", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.auto_hide_after", "description"=>"Override re-hide date for auto-hide", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.auto_hide_before", "description"=>"Override reveal date for auto-hide", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.cost", "description"=>"Cost of the ticket (currently currency must match event currency) e", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.description", "description"=>"Description of the ticket", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.donation", "description"=>"Is this a donation? (user-supplied cost)", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.free", "description"=>"Is this a free ticket?", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.hidden", "description"=>"Hide this ticket", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.hide_description", "description"=>"Hide the ticket description on the event page", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.include_fee", "description"=>"Absorb the fee into the displayed cost", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.maximum_quantity", "description"=>"Maximum number per order (blank for unlimited)", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.minimum_quantity", "description"=>"Minimum number per order", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.name", "description"=>"Name of this ticket type", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.order_confirmation_message", "description"=>"Order message per ticket type", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.quantity_total", "description"=>"Total available number of this ticket, required for non-donation tickets", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.sales_channels", "description"=>"A list of all supported sales channels ([“online”], [“online”, “atd”], [“atd”])", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.sales_end", "description"=>"When the ticket stops being on sale (leave empty for ‘one hour before event start’)", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.sales_start", "description"=>"When the ticket is available for sale (leave empty for ‘when event published’)", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.sales_start_after", "description"=>"The ID of another ticket class - when it sells out, this class will go on sale", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.split_fee", "description"=>"Absorb the payment fee, but show the eventbrite fee", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Ticket", "Classes"]}}, "/events/{id}/ticket_classes/:ticket_class_id/"=>{"get"=>{"summary"=>"Get Events Ticket Classes Ticket Class", "description"=>"Gets and returns a single ticket_class by ID, as the key\nticket_class.", "operationId"=>"getEventsTicketClassesTicketClass", "x-api-path-slug"=>"eventsidticket-classesticket-class-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Ticket", "Classes", ":ticket", "Class"]}, "post"=>{"summary"=>"Post Events Ticket Classes Ticket Class", "description"=>"Updates an existing ticket class, returning the updated result as a ticket_class under the key ticket_class.", "operationId"=>"postEventsTicketClassesTicketClass", "x-api-path-slug"=>"eventsidticket-classesticket-class-id-post", "parameters"=>[{"in"=>"query", "name"=>"ticket_class.auto_hide", "description"=>"Hide this ticket when it is not on sale", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.auto_hide_after", "description"=>"Override re-hide date for auto-hide", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.auto_hide_before", "description"=>"Override reveal date for auto-hide", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.cost", "description"=>"Cost of the ticket (currently currency must match event currency) e", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.description", "description"=>"Description of the ticket", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.donation", "description"=>"Is this a donation? (user-supplied cost)", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.free", "description"=>"Is this a free ticket?", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.hidden", "description"=>"Hide this ticket", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.hide_description", "description"=>"Hide the ticket description on the event page", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.include_fee", "description"=>"Absorb the fee into the displayed cost", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.maximum_quantity", "description"=>"Maximum number per order (blank for unlimited)", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.minimum_quantity", "description"=>"Minimum number per order", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.name", "description"=>"Name of this ticket type", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.order_confirmation_message", "description"=>"Order message per ticket type", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.quantity_total", "description"=>"Total available number of this ticket, required for non-donation tickets", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.sales_channels", "description"=>"A list of all supported sales channels ([“online”], [“online”, “atd”], [“atd”])", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.sales_end", "description"=>"When the ticket stops being on sale (leave empty for ‘one hour before event start’)", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.sales_start", "description"=>"When the ticket is available for sale (leave empty for ‘when event published’)", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.sales_start_after", "description"=>"The ID of another ticket class - when it sells out, this class will go on sale", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_class.split_fee", "description"=>"Absorb the payment fee, but show the eventbrite fee", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Ticket", "Classes", ":ticket", "Class"]}, "delete"=>{"summary"=>"Delete Events Ticket Classes Ticket Class", "description"=>"Deletes the ticket class. Returns {"deleted": true}.", "operationId"=>"deleteEventsTicketClassesTicketClass", "x-api-path-slug"=>"eventsidticket-classesticket-class-id-delete", "parameters"=>[{"in"=>"query", "name"=>"break_dependency", "description"=>"Delete even if ticket sales depend on this ticket", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Ticket", "Classes", ":ticket", "Class"]}}, "/events/{id}/canned_questions/"=>{"get"=>{"summary"=>"Get Events Canned Questions", "description"=>"This endpoint returns canned questions of a single event (examples: first name, last name, company, prefix, etc.). This endpoint will return question.", "operationId"=>"getEventsCannedQuestions", "x-api-path-slug"=>"eventsidcanned-questions-get", "parameters"=>[{"in"=>"query", "name"=>"as_owner", "description"=>"Return private events and more details", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Canned", "Questions"]}, "post"=>{"summary"=>"Post Events Canned Questions", "description"=>"Creates a new canned question; returns the result as a question.", "operationId"=>"postEventsCannedQuestions", "x-api-path-slug"=>"eventsidcanned-questions-post", "parameters"=>[{"in"=>"query", "name"=>"question.canned_type", "description"=>"String value of canned_type", "type"=>"query"}, {"in"=>"query", "name"=>"question.choices", "description"=>"Choices for multiple choice questions", "type"=>"query"}, {"in"=>"query", "name"=>"question.display_answer_on_order", "description"=>"Is this question displayed on order confirmation?", "type"=>"query"}, {"in"=>"query", "name"=>"question.parent_choice_id", "description"=>"ID of Parent Question (for subquestions)", "type"=>"query"}, {"in"=>"query", "name"=>"question.question.html", "description"=>"Question displayed to the recipient", "type"=>"query"}, {"in"=>"query", "name"=>"question.required", "description"=>"Is an answer to this question required for registration?", "type"=>"query"}, {"in"=>"query", "name"=>"question.respondent", "description"=>"Ask this question to the ticket buyer or each attendee? (Valid choices are: ticket_buyer, or attendee)", "type"=>"query"}, {"in"=>"query", "name"=>"question.ticket_classes", "description"=>"Tickets to which to limit this question", "type"=>"query"}, {"in"=>"query", "name"=>"question.type", "description"=>"Type of Question (Valid choices are: checkbox, dropdown, text, paragraph, radio, or waiver)", "type"=>"query"}, {"in"=>"query", "name"=>"question.waiver", "description"=>"Waiver content for questions of type waiver", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Canned", "Questions"]}}, "/events/{id}/questions/"=>{"get"=>{"summary"=>"Get Events Questions", "description"=>"Eventbrite allows event organizers to add custom questions that attendees fill\nout upon registration. This endpoint can be helpful for determining what\ncustom information is collected and available per event.", "operationId"=>"getEventsQuestions", "x-api-path-slug"=>"eventsidquestions-get", "parameters"=>[{"in"=>"query", "name"=>"as_owner", "description"=>"Return private events and more details", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Questions"]}, "post"=>{"summary"=>"Post Events Questions", "description"=>"Creates a new question; returns the result as a question as the key question.", "operationId"=>"postEventsQuestions", "x-api-path-slug"=>"eventsidquestions-post", "parameters"=>[{"in"=>"query", "name"=>"question.choices", "description"=>"Choices for multiple choice questions", "type"=>"query"}, {"in"=>"query", "name"=>"question.display_answer_on_order", "description"=>"Is this question displayed on order confirmation?", "type"=>"query"}, {"in"=>"query", "name"=>"question.parent_choice_id", "description"=>"ID of Parent Question Choice (for subquestions)", "type"=>"query"}, {"in"=>"query", "name"=>"question.parent_id", "description"=>"ID of Parent Question (for subquestions)", "type"=>"query"}, {"in"=>"query", "name"=>"question.question.html", "description"=>"Question displayed to the recipient", "type"=>"query"}, {"in"=>"query", "name"=>"question.required", "description"=>"Is an answer to this question required for registration?", "type"=>"query"}, {"in"=>"query", "name"=>"question.respondent", "description"=>"Ask this question to the ticket buyer or each attendee? (Valid choices are: ticket_buyer, or attendee)", "type"=>"query"}, {"in"=>"query", "name"=>"question.ticket_classes", "description"=>"Tickets to which to limit this question", "type"=>"query"}, {"in"=>"query", "name"=>"question.type", "description"=>"Type of Question (Valid choices are: checkbox, dropdown, text, paragraph, radio, or waiver)", "type"=>"query"}, {"in"=>"query", "name"=>"question.waiver", "description"=>"Waiver content for questions of type waiver", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Questions"]}}, "/events/{id}/questions/{id}/"=>{"get"=>{"summary"=>"Get Events Questions", "description"=>"This endpoint will return question for a specific question id.", "operationId"=>"getEventsQuestions", "x-api-path-slug"=>"eventsidquestionsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Questions"]}}, "/events/{id}/attendees/:attendee_id/"=>{"get"=>{"summary"=>"Get Events Attendees Attendee", "description"=>"Returns a single attendee by ID, as the key attendee.", "operationId"=>"getEventsAttendeesAttendee", "x-api-path-slug"=>"eventsidattendeesattendee-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Attendees", ":attendee"]}}, "/events/{id}/orders/"=>{"get"=>{"summary"=>"Get Events Orders", "description"=>"Returns a paginated response with a key of orders, containing a list of order against this event.", "operationId"=>"getEventsOrders", "x-api-path-slug"=>"eventsidorders-get", "parameters"=>[{"in"=>"query", "name"=>"changed_since", "description"=>"Only return orders changed on or after the time given", "type"=>"query"}, {"in"=>"query", "name"=>"exclude_emails", "description"=>"Don’t include orders placed by any of these emails", "type"=>"query"}, {"in"=>"query", "name"=>"last_item_seen", "description"=>"Only return orders changed on or after the time given and with an id bigger than last item seen", "type"=>"query"}, {"in"=>"query", "name"=>"only_emails", "description"=>"Only include orders placed by one of these emails", "type"=>"query"}, {"in"=>"query", "name"=>"refund_request_statuses", "description"=>"Return only orders with selected refund requests statuses", "type"=>"query"}, {"in"=>"query", "name"=>"status", "description"=>"Filter to active (attending), inactive (not attending), all (both) orders and all_not_deleted (active and inactive but not deleted) (Valid choices are: active, inactive, all, or all_not_deleted)", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Orders"]}}, "/events/{id}/discounts/"=>{"get"=>{"summary"=>"Get Events Discounts", "description"=>"Please use https://www.eventbrite.com/developer/v3/endpoints/users/#ebapi-get-users-user-id-discounts", "operationId"=>"getEventsDiscounts", "x-api-path-slug"=>"eventsiddiscounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Discounts"]}, "post"=>{"summary"=>"Post Events Discounts", "description"=>"Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-post-discounts", "operationId"=>"postEventsDiscounts", "x-api-path-slug"=>"eventsiddiscounts-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Discounts"]}}, "/events/{id}/discounts/:discount_id/"=>{"get"=>{"summary"=>"Get Events Discounts Discount", "description"=>"Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-get-discounts-discount-id", "operationId"=>"getEventsDiscountsDiscount", "x-api-path-slug"=>"eventsiddiscountsdiscount-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Discounts", ":discount"]}, "post"=>{"summary"=>"Post Events Discounts Discount", "description"=>"Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-post-discounts-discount-id", "operationId"=>"postEventsDiscountsDiscount", "x-api-path-slug"=>"eventsiddiscountsdiscount-id-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Discounts", ":discount"]}, "delete"=>{"summary"=>"Delete Events Discounts Discount", "description"=>"Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-delete-discounts-discount-id", "operationId"=>"deleteEventsDiscountsDiscount", "x-api-path-slug"=>"eventsiddiscountsdiscount-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Discounts", ":discount"]}}, "/events/{id}/public_discounts/"=>{"get"=>{"summary"=>"Get Events Public Discounts", "description"=>"Please use https://www.eventbrite.com/developer/v3/endpoints/users/#ebapi-get-users-user-id-discounts", "operationId"=>"getEventsPublicDiscounts", "x-api-path-slug"=>"eventsidpublic-discounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Public", "Discounts"]}, "post"=>{"summary"=>"Post Events Public Discounts", "description"=>"Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-post-discounts", "operationId"=>"postEventsPublicDiscounts", "x-api-path-slug"=>"eventsidpublic-discounts-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Public", "Discounts"]}}, "/events/{id}/public_discounts/:discount_id/"=>{"get"=>{"summary"=>"Get Events Public Discounts Discount", "description"=>"Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-get-discounts-discount-id", "operationId"=>"getEventsPublicDiscountsDiscount", "x-api-path-slug"=>"eventsidpublic-discountsdiscount-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Public", "Discounts", ":discount"]}, "post"=>{"summary"=>"Post Events Public Discounts Discount", "description"=>"Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-post-discounts-discount-id", "operationId"=>"postEventsPublicDiscountsDiscount", "x-api-path-slug"=>"eventsidpublic-discountsdiscount-id-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Public", "Discounts", ":discount"]}, "delete"=>{"summary"=>"Delete Events Public Discounts Discount", "description"=>"Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-delete-discounts-discount-id", "operationId"=>"deleteEventsPublicDiscountsDiscount", "x-api-path-slug"=>"eventsidpublic-discountsdiscount-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Public", "Discounts", ":discount"]}}, "/events/{id}/access_codes/"=>{"get"=>{"summary"=>"Get Events Access Codes", "description"=>"Please use https://www.eventbrite.com/developer/v3/endpoints/users/#ebapi-get-users-user-id-discounts", "operationId"=>"getEventsAccessCodes", "x-api-path-slug"=>"eventsidaccess-codes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Access", "Codes"]}, "post"=>{"summary"=>"Post Events Access Codes", "description"=>"Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-post-discounts", "operationId"=>"postEventsAccessCodes", "x-api-path-slug"=>"eventsidaccess-codes-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Access", "Codes"]}, "delete"=>{"summary"=>"Delete Events Access Codes", "description"=>"Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-delete-discounts-discount-id", "operationId"=>"deleteEventsAccessCodes", "x-api-path-slug"=>"eventsidaccess-codes-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Access", "Codes"]}}, "/events/{id}/access_codes/:access_code_id/"=>{"get"=>{"summary"=>"Get Events Access Codes Access Code", "description"=>"Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-get-discounts-discount-id", "operationId"=>"getEventsAccessCodesAccessCode", "x-api-path-slug"=>"eventsidaccess-codesaccess-code-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Access", "Codes", ":access", "Code"]}, "post"=>{"summary"=>"Post Events Access Codes Access Code", "description"=>"Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-get-discounts-discount-id", "operationId"=>"postEventsAccessCodesAccessCode", "x-api-path-slug"=>"eventsidaccess-codesaccess-code-id-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Access", "Codes", ":access", "Code"]}}, "/events/{id}/transfers/"=>{"get"=>{"summary"=>"Get Events Transfers", "description"=>"Returns a list of transfers for the event.", "operationId"=>"getEventsTransfers", "x-api-path-slug"=>"eventsidtransfers-get", "parameters"=>[{"in"=>"query", "name"=>"changed_since", "description"=>"Only return transfers changed on or after the time given", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Transfers"]}}, "/events/{id}/teams/"=>{"get"=>{"summary"=>"Get Events Teams", "description"=>"Returns a list of attendee-team for the event.", "operationId"=>"getEventsTeams", "x-api-path-slug"=>"eventsidteams-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Teams"]}}, "/events/{id}/teams/{id}/"=>{"get"=>{"summary"=>"Get Events Teams", "description"=>"Returns information for a single attendee-team.", "operationId"=>"getEventsTeams", "x-api-path-slug"=>"eventsidteamsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Teams"]}}, "/events/{id}/teams/{id}/attendees/"=>{"get"=>{"summary"=>"Get Events Teams Attendees", "description"=>"Returns attendee for a single attendee-team.", "operationId"=>"getEventsTeamsAttendees", "x-api-path-slug"=>"eventsidteamsidattendees-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Teams", "Attendees"]}}, "/events/:event_id/ticket_groups/"=>{"get"=>{"summary"=>"Get Events Event Ticket Groups", "description"=>"Get the list of ticket_group for the event with the specified :event_id.\nBy default, only the ticket groups that are live are shown.", "operationId"=>"getEventsEventTicketGroups", "x-api-path-slug"=>"eventsevent-idticket-groups-get", "parameters"=>[{"in"=>"query", "name"=>"status", "description"=>"Limits results to groups with the specific status (Valid choices are: live, archived, deleted, or all)", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", ":event", "Ticket", "Groups"]}}, "/events/:event_id/ticket_classes/:ticket_class_id/ticket_groups/:ticket_group_id/"=>{"post"=>{"summary"=>"Post Events Event Ticket Classes Ticket Class Ticket Groups Ticket Group", "description"=>"Add the Ticket Class with the specified :ticket_class_id that belongs to the event with :event_id to the Ticket Group identified by :ticket_group_id.", "operationId"=>"postEventsEventTicketClassesTicketClassTicketGroupsTicketGroup", "x-api-path-slug"=>"eventsevent-idticket-classesticket-class-idticket-groupsticket-group-id-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", ":event", "Ticket", "Classes", ":ticket", "Class", "Ticket", "Groups", ":ticket", "Group"]}, "delete"=>{"summary"=>"Delete Events Event Ticket Classes Ticket Class Ticket Groups Ticket Group", "description"=>"Remove the Ticket Class with the specified :ticket_class_id that belongs to the event with :event_id from the Ticket Group identified by :ticket_group_id.", "operationId"=>"deleteEventsEventTicketClassesTicketClassTicketGroupsTicketGroup", "x-api-path-slug"=>"eventsevent-idticket-classesticket-class-idticket-groupsticket-group-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", ":event", "Ticket", "Classes", ":ticket", "Class", "Ticket", "Groups", ":ticket", "Group"]}}, "/events/:event_id/ticket_classes/:ticket_class_id/ticket_groups/"=>{"get"=>{"summary"=>"Get Events Event Ticket Classes Ticket Class Ticket Groups", "description"=>"Get the Ticket Groups for Ticket Class with the specified :ticket_class_id that belongs to the event with :event_id.\nBy default, only the ticket groups that are live are shown.", "operationId"=>"getEventsEventTicketClassesTicketClassTicketGroups", "x-api-path-slug"=>"eventsevent-idticket-classesticket-class-idticket-groups-get", "parameters"=>[{"in"=>"query", "name"=>"status", "description"=>"Limits results to groups with the specific status (Valid choices are: live, archived, deleted, or all)", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", ":event", "Ticket", "Classes", ":ticket", "Class", "Ticket", "Groups"]}}, "/events/{id}/ticket_buyer_settings/"=>{"get"=>{"summary"=>"Get Events Ticket Buyer Settings", "description"=>"Returns a ticket_buyer_settings for an event.", "operationId"=>"getEventsTicketBuyerSettings", "x-api-path-slug"=>"eventsidticket-buyer-settings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Ticket", "Buyer", "Settings"]}, "post"=>{"summary"=>"Post Events Ticket Buyer Settings", "description"=>"Updates the ticket buyer settings for an event. Returns a ticket_buyer_settings.", "operationId"=>"postEventsTicketBuyerSettings", "x-api-path-slug"=>"eventsidticket-buyer-settings-post", "parameters"=>[{"in"=>"query", "name"=>"ticket_buyer_settings.confirmation_message.html", "description"=>"Confirmation message to display on order completion", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_buyer_settings.instructions.html", "description"=>"Instructions to display on the ticket", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_buyer_settings.redirect_url", "description"=>"Redirect to this url post-purchase", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_buyer_settings.refund_request_enabled", "description"=>"Whether refund requests are accepted for the event", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Ticket", "Buyer", "Settings"]}}, "/formats/"=>{"get"=>{"summary"=>"Get Formats", "description"=>"Returns a list of format as formats.", "operationId"=>"getFormats", "x-api-path-slug"=>"formats-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Formats"]}}, "/formats/{id}/"=>{"get"=>{"summary"=>"Get Formats", "description"=>"Gets a format by ID as format.", "operationId"=>"getFormats", "x-api-path-slug"=>"formatsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Formats"]}}, "/media/{id}/"=>{"get"=>{"summary"=>"Get Media", "description"=>"Return an image for a given id.", "operationId"=>"getMedia", "x-api-path-slug"=>"mediaid-get", "parameters"=>[{"in"=>"query", "name"=>"height", "description"=>"Optional thumbnail height (you can specify only this value or also width)", "type"=>"query"}, {"in"=>"query", "name"=>"width", "description"=>"Optional thumbnail width (you can specify only this value or also height)", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media"]}}, "/media/upload/"=>{"get"=>{"summary"=>"Get Media Upload", "description"=>"See Media Uploads.", "operationId"=>"getMediaUpload", "x-api-path-slug"=>"mediaupload-get", "parameters"=>[{"in"=>"query", "name"=>"type", "description"=>"The type of image to upload (Valid choices are: image-event-logo, image-event-logo-preserve-quality, image-event-view-from-seat, image-organizer-logo, image-user-photo, or image-structured-content)", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media", "Upload"]}}, "/users/me/notifications/"=>{"get"=>{"summary"=>"Get Users Me Notifications", "description"=>"Gets a paginated response of notification objects for a determined user.", "operationId"=>"getUsersMeNotifications", "x-api-path-slug"=>"usersmenotifications-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Me", "Notifications"]}}, "/orders/{id}/"=>{"get"=>{"summary"=>"Get Orders", "description"=>"Gets an order by ID an order object.", "operationId"=>"getOrders", "x-api-path-slug"=>"ordersid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders"]}}, "/users/:user_id/organizations/"=>{"get"=>{"summary"=>"Get Users User Organizations", "description"=>"Returns a continuated list of organizations\naccessible to the current user.", "operationId"=>"getUsersUserOrganizations", "x-api-path-slug"=>"usersuser-idorganizations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", ":user", "Organizations"]}}, "/organizers/"=>{"post"=>{"summary"=>"Post Organizers", "description"=>"Makes a new organizer. Returns an organizer as organizer.", "operationId"=>"postOrganizers", "x-api-path-slug"=>"organizers-post", "parameters"=>[{"in"=>"query", "name"=>"organizer.description.html", "description"=>"The description of the organizer", "type"=>"query"}, {"in"=>"query", "name"=>"organizer.facebook", "description"=>"The Facebook URL ID for the organizer", "type"=>"query"}, {"in"=>"query", "name"=>"organizer.instagram", "description"=>"The Instagram numeric ID for the organizer", "type"=>"query"}, {"in"=>"query", "name"=>"organizer.logo.id", "description"=>"The logo id of the organizer", "type"=>"query"}, {"in"=>"query", "name"=>"organizer.long_description.html", "description"=>"The long description of the organizer", "type"=>"query"}, {"in"=>"query", "name"=>"organizer.name", "description"=>"The name of the organizer", "type"=>"query"}, {"in"=>"query", "name"=>"organizer.twitter", "description"=>"The Twitter handle for the organizer", "type"=>"query"}, {"in"=>"query", "name"=>"organizer.website", "description"=>"The website for the organizer", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers"]}}, "/organizers/{id}/"=>{"get"=>{"summary"=>"Get Organizers", "description"=>"Gets an organizer by ID as organizer.", "operationId"=>"getOrganizers", "x-api-path-slug"=>"organizersid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers"]}, "post"=>{"summary"=>"Post Organizers", "description"=>"Updates an organizer and returns it as as organizer.", "operationId"=>"postOrganizers", "x-api-path-slug"=>"organizersid-post", "parameters"=>[{"in"=>"query", "name"=>"organizer.description.html", "description"=>"The description of the organizer", "type"=>"query"}, {"in"=>"query", "name"=>"organizer.facebook", "description"=>"The Facebook URL ID for the organizer", "type"=>"query"}, {"in"=>"query", "name"=>"organizer.instagram", "description"=>"The Instagram numeric ID for the organizer", "type"=>"query"}, {"in"=>"query", "name"=>"organizer.logo.id", "description"=>"The logo id of the organizer", "type"=>"query"}, {"in"=>"query", "name"=>"organizer.long_description.html", "description"=>"The long description of the organizer", "type"=>"query"}, {"in"=>"query", "name"=>"organizer.name", "description"=>"The name of the organizer", "type"=>"query"}, {"in"=>"query", "name"=>"organizer.twitter", "description"=>"The Twitter handle for the organizer", "type"=>"query"}, {"in"=>"query", "name"=>"organizer.website", "description"=>"The website for the organizer", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers"]}}, "/organizers/{id}/events/"=>{"get"=>{"summary"=>"Get Organizers Events", "description"=>"Gets events of the organizer.", "operationId"=>"getOrganizersEvents", "x-api-path-slug"=>"organizersidevents-get", "parameters"=>[{"in"=>"query", "name"=>"only_public", "description"=>"Only show public events even if viewing your own events", "type"=>"query"}, {"in"=>"query", "name"=>"order_by", "description"=>"How to order the results (Valid choices are: start_asc, start_desc, created_asc, or created_desc)", "type"=>"query"}, {"in"=>"query", "name"=>"start_date.range_end", "description"=>"Only return events with start dates before the given date", "type"=>"query"}, {"in"=>"query", "name"=>"start_date.range_start", "description"=>"Only return events with start dates after the given date", "type"=>"query"}, {"in"=>"query", "name"=>"status", "description"=>"Only return events with a specific status set", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizers", "Events"]}}, "/pricing/fee_rates/"=>{"get"=>{"summary"=>"Get Pricing Fee Rates", "description"=>"Returns a list of fee_rate objects for the different\ncurrencies, countries, assortments and sales channels we sell through\ntoday and in the future.", "operationId"=>"getPricingFeeRates", "x-api-path-slug"=>"pricingfee-rates-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"The sales channel", "type"=>"query"}, {"in"=>"query", "name"=>"country", "description"=>"The (ISO 3166 alpha-2 code of the) country where you want to know the fee rates", "type"=>"query"}, {"in"=>"query", "name"=>"currency", "description"=>"The (ISO 4217 3-character code of the) currency where you want to know the fee rates", "type"=>"query"}, {"in"=>"query", "name"=>"item_type", "description"=>"The item type for which get the price fee rates", "type"=>"query"}, {"in"=>"query", "name"=>"payment_type", "description"=>"The payment type to get the price for", "type"=>"query"}, {"in"=>"query", "name"=>"plan", "description"=>"The assortment package name to get the price for", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pricing", "Fee", "Rates"]}}, "/refund_requests/{id}/"=>{"get"=>{"summary"=>"Get Refund Requests", "description"=>"Gets a refund-request for the specified refund request.", "operationId"=>"getRefundRequests", "x-api-path-slug"=>"refund-requestsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Refund", "Requests"]}, "post"=>{"summary"=>"Post Refund Requests", "description"=>"Update a refund-request for a specific order. Each element in items is a refund-item", "operationId"=>"postRefundRequests", "x-api-path-slug"=>"refund-requestsid-post", "parameters"=>[{"in"=>"query", "name"=>"from_email", "description"=>"The email of the person is making the request", "type"=>"query"}, {"in"=>"query", "name"=>"from_name", "description"=>"The name of the person is making the request", "type"=>"query"}, {"in"=>"query", "name"=>"items", "description"=>"A list of items formatted as: [{“order_id”: “123”},", "type"=>"query"}, {"in"=>"query", "name"=>"message", "description"=>"The Message of the request", "type"=>"query"}, {"in"=>"query", "name"=>"reason", "description"=>"The reason of the request (Valid choices are: duplicate_order, event_cancelled, event_not_as_described, no_longer_able_to_attend, event_postponed, request_not_within_event_refund_policy, request_inaccurate, refunded_offline, or alternate_resolution_offered)", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Refund", "Requests"]}}, "/refund_requests/"=>{"post"=>{"summary"=>"Post Refund Requests", "description"=>"Creates a refund-request for a specific order. Each element in items is a refund-item", "operationId"=>"postRefundRequests", "x-api-path-slug"=>"refund-requests-post", "parameters"=>[{"in"=>"query", "name"=>"from_email", "description"=>"The email of the person is making the request", "type"=>"query"}, {"in"=>"query", "name"=>"from_name", "description"=>"The name of the person is making the request", "type"=>"query"}, {"in"=>"query", "name"=>"items", "description"=>"A list of items formatted as: [{“order_id”: “123”},", "type"=>"query"}, {"in"=>"query", "name"=>"message", "description"=>"The Message of the request", "type"=>"query"}, {"in"=>"query", "name"=>"reason", "description"=>"The reason of the request (Valid choices are: duplicate_order, event_cancelled, event_not_as_described, no_longer_able_to_attend, event_postponed, request_not_within_event_refund_policy, request_inaccurate, refunded_offline, or alternate_resolution_offered)", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Refund", "Requests"]}}, "/reports/sales/"=>{"get"=>{"summary"=>"Get Reports Sales", "description"=>"Returns a response of the aggregate sales data.", "operationId"=>"getReportsSales", "x-api-path-slug"=>"reportssales-get", "parameters"=>[{"in"=>"query", "name"=>"date_facet", "description"=>"Optional date aggregation level to return data for", "type"=>"query"}, {"in"=>"query", "name"=>"end_date", "description"=>"Optional end date to query", "type"=>"query"}, {"in"=>"query", "name"=>"event_ids", "description"=>"List of public event IDs to report on", "type"=>"query"}, {"in"=>"query", "name"=>"event_status", "description"=>"Event status to filter down results by (Valid choices are: all, live, or ended)", "type"=>"query"}, {"in"=>"query", "name"=>"filter_by", "description"=>"Optional filters for sales/attendees data formatted as: {“ticket_ids”: [1234, 5678], “currencies”: [“USD”],", "type"=>"query"}, {"in"=>"query", "name"=>"group_by", "description"=>"Optional field to group data on (Valid choices are: payment_method, payment_method_application, ticket, ticket_application, currency, event_currency, reserved_section, event, event_ticket, event_application, country, city, state, source, zone, location, access_level, device_name, sales_channel_lvl_1, sales_channel_lvl_2, or sales_channel_lvl_3)", "type"=>"query"}, {"in"=>"query", "name"=>"period", "description"=>"Time period to provide aggregation for in units of the selected date_facet", "type"=>"query"}, {"in"=>"query", "name"=>"start_date", "description"=>"Optional start date to query", "type"=>"query"}, {"in"=>"query", "name"=>"timezone", "description"=>"Optional timezone", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "Sales"]}}, "/reports/attendees/"=>{"get"=>{"summary"=>"Get Reports Attendees", "description"=>"Returns a response of the aggregate attendees data.", "operationId"=>"getReportsAttendees", "x-api-path-slug"=>"reportsattendees-get", "parameters"=>[{"in"=>"query", "name"=>"date_facet", "description"=>"Optional date aggregation level to return data for", "type"=>"query"}, {"in"=>"query", "name"=>"end_date", "description"=>"Optional end date to query", "type"=>"query"}, {"in"=>"query", "name"=>"event_ids", "description"=>"List of public event IDs to report on", "type"=>"query"}, {"in"=>"query", "name"=>"event_status", "description"=>"Event status to filter down results by (Valid choices are: all, live, or ended)", "type"=>"query"}, {"in"=>"query", "name"=>"filter_by", "description"=>"Optional filters for sales/attendees data formatted as: {“ticket_ids”: [1234, 5678], “currencies”: [“USD”],", "type"=>"query"}, {"in"=>"query", "name"=>"group_by", "description"=>"Optional field to group data on (Valid choices are: payment_method, payment_method_application, ticket, ticket_application, currency, event_currency, reserved_section, event, event_ticket, event_application, country, city, state, source, zone, location, access_level, device_name, sales_channel_lvl_1, sales_channel_lvl_2, or sales_channel_lvl_3)", "type"=>"query"}, {"in"=>"query", "name"=>"period", "description"=>"Time period to provide aggregation for in units of the selected date_facet", "type"=>"query"}, {"in"=>"query", "name"=>"start_date", "description"=>"Optional start date to query", "type"=>"query"}, {"in"=>"query", "name"=>"timezone", "description"=>"Optional timezone", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports", "Attendees"]}}, "/system/timezones/"=>{"get"=>{"summary"=>"Get System Timezones", "description"=>"Returns a paginated response with a key of timezones,\ncontaining a list of timezones.", "operationId"=>"getSystemTimezones", "x-api-path-slug"=>"systemtimezones-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["System", "Timezones"]}}, "/system/regions/"=>{"get"=>{"summary"=>"Get System Regions", "description"=>"Returns a single page response with a key of regions,\ncontaining a list of regions.", "operationId"=>"getSystemRegions", "x-api-path-slug"=>"systemregions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["System", "Regions"]}}, "/system/countries/"=>{"get"=>{"summary"=>"Get System Countries", "description"=>"Returns a single page response with a key of countries,\ncontaining a list of countries.", "operationId"=>"getSystemCountries", "x-api-path-slug"=>"systemcountries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["System", "Countries"]}}, "/ticket_groups/:ticket_group_id/"=>{"get"=>{"summary"=>"Get Ticket Groups Ticket Group", "description"=>"Returns the ticket_group with the specified :ticket_group_id.", "operationId"=>"getTicketGroupsTicketGroup", "x-api-path-slug"=>"ticket-groupsticket-group-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket", "Groups", ":ticket", "Group"]}, "delete"=>{"summary"=>"Delete Ticket Groups Ticket Group", "description"=>"Deletes the ticket_group with the specified :ticket_group_id.\nThe status of the ticket group is changed to deleted.", "operationId"=>"deleteTicketGroupsTicketGroup", "x-api-path-slug"=>"ticket-groupsticket-group-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket", "Groups", ":ticket", "Group"]}, "post"=>{"summary"=>"Post Ticket Groups Ticket Group", "description"=>"Updates the ticket group with the specified :ticket_group_id. Returns the updated ticket_group.", "operationId"=>"postTicketGroupsTicketGroup", "x-api-path-slug"=>"ticket-groupsticket-group-id-post", "parameters"=>[{"in"=>"query", "name"=>"ticket_group.event_ticket_ids", "description"=>"(‘IDs of tickets by event id for this ticket group", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_group.name", "description"=>"Name of ticket group", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_group.status", "description"=>"The status of ticket group", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket", "Groups", ":ticket", "Group"]}}, "/ticket_groups/"=>{"post"=>{"summary"=>"Post Ticket Groups", "description"=>"Creates a ticket group and returns the created ticket_group.\nOnly up to 200 live ticket groups may be created; those with archived or deleted status are not taken into account.", "operationId"=>"postTicketGroups", "x-api-path-slug"=>"ticket-groups-post", "parameters"=>[{"in"=>"query", "name"=>"ticket_group.event_ticket_ids", "description"=>"(‘IDs of tickets by event id for this ticket group", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_group.name", "description"=>"Name of ticket group", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_group.status", "description"=>"The status of ticket group", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket", "Groups"]}}, "/tracking_beacons/"=>{"post"=>{"summary"=>"Post Tracking Beacons", "description"=>"Makes a new tracking beacon. Returns an tracking_beacon as tracking_beacon. Either event_id or user_id is required for each tracking beacon. If the event_id is provided, the tracking pixel will fire only for that event. If the user_id is provided, the tracking pixel will fire for all events organized by that user.", "operationId"=>"postTrackingBeacons", "x-api-path-slug"=>"tracking-beacons-post", "parameters"=>[{"in"=>"query", "name"=>"event_id", "description"=>"The Event ID of the event that this tracking beacon will fire in", "type"=>"query"}, {"in"=>"query", "name"=>"pixel_id", "description"=>"The Pixel ID given by the third party that will fire when a attendee lands on the page you are tracking", "type"=>"query"}, {"in"=>"query", "name"=>"tracking_type", "description"=>"The tracking pixel third party type", "type"=>"query"}, {"in"=>"query", "name"=>"triggers", "description"=>"The additional pixel data needed to determine which page to fire the tracking pixel on", "type"=>"query"}, {"in"=>"query", "name"=>"user_id", "description"=>"The User ID wherein the tracking beacon will be assigned to all of this user’s events", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracking", "Beacons"]}}, "/tracking_beacons/:tracking_beacons_id/"=>{"get"=>{"summary"=>"Get Tracking Beacons Tracking Beacons", "description"=>"Returns the tracking_beacon with the specified :tracking_beacons_id.", "operationId"=>"getTrackingBeaconsTrackingBeacons", "x-api-path-slug"=>"tracking-beaconstracking-beacons-id-get", "parameters"=>[{"in"=>"query", "name"=>"return_fmt", "description"=>"returned format", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracking", "Beacons", ":tracking", "Beacons"]}, "post"=>{"summary"=>"Post Tracking Beacons Tracking Beacons", "description"=>"Updates the tracking_beacons with the specified :tracking_beacons_id. Though event_id and user_id are not individually required, it is a requirement to have a tracking beacon where either one must exist. Returns an tracking_beacon as tracking_beacon.", "operationId"=>"postTrackingBeaconsTrackingBeacons", "x-api-path-slug"=>"tracking-beaconstracking-beacons-id-post", "parameters"=>[{"in"=>"query", "name"=>"event_id", "description"=>"The Event ID of the event that this tracking beacon will fire in", "type"=>"query"}, {"in"=>"query", "name"=>"pixel_id", "description"=>"The Pixel ID given by the third party that will fire when a attendee lands on the page you are tracking", "type"=>"query"}, {"in"=>"query", "name"=>"tracking_type", "description"=>"The tracking pixel third party type", "type"=>"query"}, {"in"=>"query", "name"=>"triggers", "description"=>"The additional pixel data needed to determine which page to fire the tracking pixel on", "type"=>"query"}, {"in"=>"query", "name"=>"user_id", "description"=>"The User ID wherein the tracking beacon will be assigned to all of this user’s events", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracking", "Beacons", ":tracking", "Beacons"]}, "delete"=>{"summary"=>"Delete Tracking Beacons Tracking Beacons", "description"=>"Delete the tracking_beacons with the specified :tracking_beacons_id.", "operationId"=>"deleteTrackingBeaconsTrackingBeacons", "x-api-path-slug"=>"tracking-beaconstracking-beacons-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracking", "Beacons", ":tracking", "Beacons"]}}, "/events/:event_id/tracking_beacons/"=>{"get"=>{"summary"=>"Get Events Event Tracking Beacons", "description"=>"Returns the list of tracking_beacon for the event :event_id", "operationId"=>"getEventsEventTrackingBeacons", "x-api-path-slug"=>"eventsevent-idtracking-beacons-get", "parameters"=>[{"in"=>"query", "name"=>"return_fmt", "description"=>"returned format", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", ":event", "Tracking", "Beacons"]}}, "/users/:user_id/tracking_beacons/"=>{"get"=>{"summary"=>"Get Users User Tracking Beacons", "description"=>"Returns the list of tracking_beacon for the user :user_id", "operationId"=>"getUsersUserTrackingBeacons", "x-api-path-slug"=>"usersuser-idtracking-beacons-get", "parameters"=>[{"in"=>"query", "name"=>"return_fmt", "description"=>"returned format", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", ":user", "Tracking", "Beacons"]}}, "/users/{id}/"=>{"get"=>{"summary"=>"Get Users", "description"=>"Returns a user for the specified user as user. If you want to get details about the currently authenticated user, use /users/me/.", "operationId"=>"getUsers", "x-api-path-slug"=>"usersid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/{id}/orders/"=>{"get"=>{"summary"=>"Get Users Orders", "description"=>"Returns a paginated response of orders, under the key orders, of all orders the user has placed (i.e. where the user was the person buying the tickets).", "operationId"=>"getUsersOrders", "x-api-path-slug"=>"usersidorders-get", "parameters"=>[{"in"=>"query", "name"=>" ", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Orders"]}}, "/users/{id}/organizers/"=>{"get"=>{"summary"=>"Get Users Organizers", "description"=>"Returns a paginated response of organizer objects that are owned by the user.", "operationId"=>"getUsersOrganizers", "x-api-path-slug"=>"usersidorganizers-get", "parameters"=>[{"in"=>"query", "name"=>"hide_unsaved", "description"=>"True: Will hide organizers flagged as “unsaved”False: Will show organizers regardless of unsaved flag (Default value)", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Organizers"]}}, "/users/{id}/owned_events/"=>{"get"=>{"summary"=>"Get Users Owned Events", "description"=>"Returns a paginated response of events, under\nthe key events, of all events the user owns (i.e. events they are organising)", "operationId"=>"getUsersOwnedEvents", "x-api-path-slug"=>"usersidowned-events-get", "parameters"=>[{"in"=>"query", "name"=>"order_by", "description"=>"How to order the results (Valid choices are: start_asc, start_desc, created_asc, created_desc, name_asc, or name_desc)", "type"=>"query"}, {"in"=>"query", "name"=>"show_series_parent", "description"=>"True: Will show parent of a serie instead of childrenFalse: Will show children of a serie (Default value)", "type"=>"query"}, {"in"=>"query", "name"=>"status", "description"=>"Filter by events with a specific status set", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Owned", "Events"]}}, "/users/{id}/events/"=>{"get"=>{"summary"=>"Get Users Events", "description"=>"Returns a paginated response of events, under the key events, of all events the user has access to", "operationId"=>"getUsersEvents", "x-api-path-slug"=>"usersidevents-get", "parameters"=>[{"in"=>"query", "name"=>"currency_filter", "description"=>"Filter event results by currency", "type"=>"query"}, {"in"=>"query", "name"=>"event_group_id", "description"=>"Filter event results by event_group_id", "type"=>"query"}, {"in"=>"query", "name"=>"name_filter", "description"=>"Filter event results by name", "type"=>"query"}, {"in"=>"query", "name"=>"order_by", "description"=>"How to order the results (Valid choices are: start_asc, start_desc, created_asc, created_desc, name_asc, or name_desc)", "type"=>"query"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records in each page", "type"=>"query"}, {"in"=>"query", "name"=>"show_series_parent", "description"=>"True: Will show parent of a serie instead of childrenFalse: Will show children of a serie (Default value)", "type"=>"query"}, {"in"=>"query", "name"=>"status", "description"=>"Filter by events with a specific status set", "type"=>"query"}, {"in"=>"query", "name"=>"time_filter", "description"=>"Limits results to either past or current & future events / orders", "type"=>"query"}, {"in"=>"query", "name"=>"venue_filter", "description"=>"Filter event results by venue IDs", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Events"]}}, "/organizations/{id}/events/"=>{"post"=>{"summary"=>"Post Organizations Events", "description"=>"Creates new events objects under an organization and returns it as event.", "operationId"=>"postOrganizationsEvents", "x-api-path-slug"=>"organizationsidevents-post", "parameters"=>[{"in"=>"query", "name"=>"event.capacity", "description"=>"Set specific capacity (if omitted, sums ticket capacities)", "type"=>"query"}, {"in"=>"query", "name"=>"event.category_id", "description"=>"The category (vertical) of the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.currency", "description"=>"Event currency (3 letter code)", "type"=>"query"}, {"in"=>"query", "name"=>"event.description.html", "description"=>"The description on the event page", "type"=>"query"}, {"in"=>"query", "name"=>"event.end.timezone", "description"=>"End time timezone (Olson format)", "type"=>"query"}, {"in"=>"query", "name"=>"event.end.utc", "description"=>"The end time of the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.format_id", "description"=>"The format (general type) of the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.hide_end_date", "description"=>"Whether the end date should be hidden", "type"=>"query"}, {"in"=>"query", "name"=>"event.hide_start_date", "description"=>"Whether the start date should be hidden", "type"=>"query"}, {"in"=>"query", "name"=>"event.invite_only", "description"=>"Only invited users can see the event page", "type"=>"query"}, {"in"=>"query", "name"=>"event.is_reserved_seating", "description"=>"If the event is reserved seating", "type"=>"query"}, {"in"=>"query", "name"=>"event.listed", "description"=>"If the event is publicly listed and searchable", "type"=>"query"}, {"in"=>"query", "name"=>"event.logo.id", "description"=>"(Deprecated) The logo for the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.logo_id", "description"=>"The logo for the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.name.html", "description"=>"The name of the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.online_event", "description"=>"Is the event online-only (no venue)?", "type"=>"query"}, {"in"=>"query", "name"=>"event.organizer_id", "description"=>"The ID of the organizer of this event", "type"=>"query"}, {"in"=>"query", "name"=>"event.password", "description"=>"Password needed to see the event in unlisted mode", "type"=>"query"}, {"in"=>"query", "name"=>"event.shareable", "description"=>"If users can share the event on social media", "type"=>"query"}, {"in"=>"query", "name"=>"event.show_pick_a_seat", "description"=>"For reserved seating event, if attendees can pick their seats", "type"=>"query"}, {"in"=>"query", "name"=>"event.show_remaining", "description"=>"If the remaining number of tickets is publicly visible on the event page", "type"=>"query"}, {"in"=>"query", "name"=>"event.show_seatmap_thumbnail", "description"=>"For reserved seating event, if venue map thumbnail visible on the event page", "type"=>"query"}, {"in"=>"query", "name"=>"event.source", "description"=>"Source of the event (defaults to API)", "type"=>"query"}, {"in"=>"query", "name"=>"event.start.timezone", "description"=>"Start time timezone (Olson format)", "type"=>"query"}, {"in"=>"query", "name"=>"event.start.utc", "description"=>"The start time of the event", "type"=>"query"}, {"in"=>"query", "name"=>"event.subcategory_id", "description"=>"The subcategory of the event (US only)", "type"=>"query"}, {"in"=>"query", "name"=>"event.venue_id", "description"=>"ID of the venue", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Events"]}}, "/users/{id}/venues/"=>{"get"=>{"summary"=>"Get Users Venues", "description"=>"Returns a paginated response of venue objects that are owned by the user.", "operationId"=>"getUsersVenues", "x-api-path-slug"=>"usersidvenues-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Venues"]}}, "/organizations/{id}/venues/"=>{"post"=>{"summary"=>"Post Organizations Venues", "description"=>"Creates new venue objects under an organization and returns it as venue.", "operationId"=>"postOrganizationsVenues", "x-api-path-slug"=>"organizationsidvenues-post", "parameters"=>[{"in"=>"query", "name"=>"venue.address.address_1", "description"=>"The first line of the address", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.address_2", "description"=>"The second line of the address", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.city", "description"=>"The city where the venue is", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.country", "description"=>"The country where the venue is", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.latitude", "description"=>"The latitude of the coordinates for the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.longitude", "description"=>"The longitude of the coordinates for the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.postal_code", "description"=>"The postal_code where the venue is", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.region", "description"=>"The region where the venue is", "type"=>"query"}, {"in"=>"query", "name"=>"venue.age_restriction", "description"=>"The age restrictions for the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.capacity", "description"=>"The max capacity for the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.google_place_id", "description"=>"The google place id for the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.name", "description"=>"The name of the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.organizer_id", "description"=>"The organizer this venue belongs to (optional - leave this off to use the default organizer)", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Venues"]}}, "/users/{id}/owned_event_attendees/"=>{"get"=>{"summary"=>"Get Users Owned Event Attendees", "description"=>"Returns a paginated response of attendees,\nunder the key attendees, of attendees visiting any of the events the user owns\n(events that would be returned from /users/:id/owned_events/)", "operationId"=>"getUsersOwnedEventAttendees", "x-api-path-slug"=>"usersidowned-event-attendees-get", "parameters"=>[{"in"=>"query", "name"=>"changed_since", "description"=>"Only return resource changed on or after the time given", "type"=>"query"}, {"in"=>"query", "name"=>"status", "description"=>"Limits results to either confirmed attendees or cancelled/refunded/etc", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Owned", "Event", "Attendees"]}}, "/users/{id}/owned_event_orders/"=>{"get"=>{"summary"=>"Get Users Owned Event Orders", "description"=>"Returns a paginated response of orders,\nunder the key orders, of orders placed against any of the events the user owns\n(events that would be returned from /users/:id/owned_events/)", "operationId"=>"getUsersOwnedEventOrders", "x-api-path-slug"=>"usersidowned-event-orders-get", "parameters"=>[{"in"=>"query", "name"=>"changed_since", "description"=>"Only return resource changed on or after the time given", "type"=>"query"}, {"in"=>"query", "name"=>"exclude_emails", "description"=>"Don’t include orders placed by any of these emails", "type"=>"query"}, {"in"=>"query", "name"=>"only_emails", "description"=>"Only include orders placed by one of these emails", "type"=>"query"}, {"in"=>"query", "name"=>"status", "description"=>"Filter to active (attending), inactive (not attending), or all (both) orders (Valid choices are: active, inactive, or all)", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Owned", "Event", "Orders"]}}, "/users/{id}/contact_lists/"=>{"get"=>{"summary"=>"Get Users Contact Lists", "description"=>"Returns a list of contact_list that the user owns as the key\ncontact_lists.", "operationId"=>"getUsersContactLists", "x-api-path-slug"=>"usersidcontact-lists-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Contact", "Lists"]}, "post"=>{"summary"=>"Post Users Contact Lists", "description"=>"Makes a new contact_list for the user and returns it as\ncontact_list.", "operationId"=>"postUsersContactLists", "x-api-path-slug"=>"usersidcontact-lists-post", "parameters"=>[{"in"=>"query", "name"=>"contact_list.name", "description"=>"Name of the new contact list", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Contact", "Lists"]}}, "/users/{id}/contact_lists/:contact_list_id/"=>{"get"=>{"summary"=>"Get Users Contact Lists Contact List", "description"=>"Gets a user’s contact_list by ID as contact_list.", "operationId"=>"getUsersContactListsContactList", "x-api-path-slug"=>"usersidcontact-listscontact-list-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Contact", "Lists", ":contact", "List"]}, "post"=>{"summary"=>"Post Users Contact Lists Contact List", "description"=>"Updates the contact_list and returns it as contact_list.", "operationId"=>"postUsersContactListsContactList", "x-api-path-slug"=>"usersidcontact-listscontact-list-id-post", "parameters"=>[{"in"=>"query", "name"=>"contact_list.name", "description"=>"New name of the contact list", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Contact", "Lists", ":contact", "List"]}, "delete"=>{"summary"=>"Delete Users Contact Lists Contact List", "description"=>"Deletes the contact list. Returns {"deleted": true}.", "operationId"=>"deleteUsersContactListsContactList", "x-api-path-slug"=>"usersidcontact-listscontact-list-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Contact", "Lists", ":contact", "List"]}}, "/users/{id}/contact_lists/:contact_list_id/contacts/"=>{"get"=>{"summary"=>"Get Users Contact Lists Contact List Contacts", "description"=>"Returns the contacts on the contact list\nas contacts.", "operationId"=>"getUsersContactListsContactListContacts", "x-api-path-slug"=>"usersidcontact-listscontact-list-idcontacts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Contact", "Lists", ":contact", "List", "Contacts"]}, "post"=>{"summary"=>"Post Users Contact Lists Contact List Contacts", "description"=>"Adds a new contact to the contact list. Returns {"created": true}.", "operationId"=>"postUsersContactListsContactListContacts", "x-api-path-slug"=>"usersidcontact-listscontact-list-idcontacts-post", "parameters"=>[{"in"=>"query", "name"=>"contact.email", "description"=>"Contact’s email address", "type"=>"query"}, {"in"=>"query", "name"=>"contact.first_name", "description"=>"Contact’s first name (or full name)", "type"=>"query"}, {"in"=>"query", "name"=>"contact.last_name", "description"=>"Contact’s last name", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Contact", "Lists", ":contact", "List", "Contacts"]}, "delete"=>{"summary"=>"Delete Users Contact Lists Contact List Contacts", "description"=>"Deletes the specified contact from the contact list.\nReturns {"deleted": true}.", "operationId"=>"deleteUsersContactListsContactListContacts", "x-api-path-slug"=>"usersidcontact-listscontact-list-idcontacts-delete", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"Email address to remove", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Contact", "Lists", ":contact", "List", "Contacts"]}}, "/users/{id}/bookmarks/"=>{"get"=>{"summary"=>"Get Users Bookmarks", "description"=>"Gets all the user’s saved events.", "operationId"=>"getUsersBookmarks", "x-api-path-slug"=>"usersidbookmarks-get", "parameters"=>[{"in"=>"query", "name"=>"bookmark_list_id", "description"=>"Optional bookmark list id to fetch all bookmarks from", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Bookmarks"]}}, "/users/{id}/bookmarks/save/"=>{"post"=>{"summary"=>"Post Users Bookmarks Save", "description"=>"Adds a new bookmark for the user. Returns {"created": true}.", "operationId"=>"postUsersBookmarksSave", "x-api-path-slug"=>"usersidbookmarkssave-post", "parameters"=>[{"in"=>"query", "name"=>"bookmark_list_id", "description"=>"Optional Bookmark list id to save the bookmark(s) to", "type"=>"query"}, {"in"=>"query", "name"=>"event_id", "description"=>"Event id to bookmark for the user", "type"=>"query"}, {"in"=>"query", "name"=>"event_ids", "description"=>"Event ids to batch bookmark for the user", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Bookmarks", "Save"]}}, "/users/{id}/bookmarks/unsave/"=>{"post"=>{"summary"=>"Post Users Bookmarks Unsave", "description"=>"Removes the specified bookmark from the event for the user. Returns {"deleted": true}.", "operationId"=>"postUsersBookmarksUnsave", "x-api-path-slug"=>"usersidbookmarksunsave-post", "parameters"=>[{"in"=>"query", "name"=>"bookmark_list_id", "description"=>"Bookmark list id to save the bookmark(s) to", "type"=>"query"}, {"in"=>"query", "name"=>"event_id", "description"=>"Event id to bookmark for the user", "type"=>"query"}, {"in"=>"query", "name"=>"event_ids", "description"=>"Event ids to batch bookmark for the user", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Bookmarks", "Unsave"]}}, "/users/:user_id/ticket_groups/"=>{"get"=>{"summary"=>"Get Users User Ticket Groups", "description"=>"Returns a paginated response of ticket_group for the specified user.\nThe alias me (/users/me/) may be used to refer to the currently authenticated user.", "operationId"=>"getUsersUserTicketGroups", "x-api-path-slug"=>"usersuser-idticket-groups-get", "parameters"=>[{"in"=>"query", "name"=>"status", "description"=>"Limits results to groups with the specific status (Valid choices are: live, archived, deleted, or all)", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", ":user", "Ticket", "Groups"]}}, "/users/:user_id/events/:event_id/ticket_classes/:ticket_class_id/ticket_groups/"=>{"post"=>{"summary"=>"Post Users User Events Event Ticket Classes Ticket Class Ticket Groups", "description"=>"Add the Ticket Class with the specified :ticket_class_id of the event with :event_id that\nbelongs to the user with :user_id to many Ticket Groups specified with ticket_group_ids.\nIf the list provided is empty, remove this ticket class from every ticket group.", "operationId"=>"postUsersUserEventsEventTicketClassesTicketClassTicketGroups", "x-api-path-slug"=>"usersuser-ideventsevent-idticket-classesticket-class-idticket-groups-post", "parameters"=>[{"in"=>"query", "name"=>"ticket_group_ids", "description"=>"IDs of all ticket group this ticket belongs to", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", ":user", "Events", ":event", "Ticket", "Classes", ":ticket", "Class", "Ticket", "Groups"]}}, "/users/:user_id/discounts/"=>{"get"=>{"summary"=>"Get Users User Discounts", "description"=>"Returns a paginated response of cross_event_discount for the specified user.\nThis operation is only supported for the currently authenticated user. The alias me (/users/me/) may be used.", "operationId"=>"getUsersUserDiscounts", "x-api-path-slug"=>"usersuser-iddiscounts-get", "parameters"=>[{"in"=>"query", "name"=>"code", "description"=>"Search term to find discounts by code/name, in an exact match behavior", "type"=>"query"}, {"in"=>"query", "name"=>"code_filter", "description"=>"Search term to filter discounts by name", "type"=>"query"}, {"in"=>"query", "name"=>"event_id", "description"=>"ID of the event", "type"=>"query"}, {"in"=>"query", "name"=>"order_by", "description"=>"How to order the results (Valid choices are: code_asc, code_desc, discount_type_asc, discount_type_desc, start_asc, or start_desc)", "type"=>"query"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records in each page", "type"=>"query"}, {"in"=>"query", "name"=>"scope", "description"=>"Type of discount scopes", "type"=>"query"}, {"in"=>"query", "name"=>"ticket_group_id", "description"=>"ID of the ticket group", "type"=>"query"}, {"in"=>"query", "name"=>"type", "description"=>"Filter discounts with a specific discount type set", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", ":user", "Discounts"]}}, "/users/{id}/assortment/"=>{"get"=>{"summary"=>"Get Users Assortment", "description"=>"Retrieve the assortment for the user.", "operationId"=>"getUsersAssortment", "x-api-path-slug"=>"usersidassortment-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Assortment"]}, "post"=>{"summary"=>"Post Users Assortment", "description"=>"Set a user’s assortment and returns the assortment for the specified\nuser.", "operationId"=>"postUsersAssortment", "x-api-path-slug"=>"usersidassortment-post", "parameters"=>[{"in"=>"query", "name"=>"plan", "description"=>"The assortments package to upgrade/downgrade to", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Assortment"]}}, "/venues/{id}/"=>{"get"=>{"summary"=>"Get Venues", "description"=>"Returns a venue object.", "operationId"=>"getVenues", "x-api-path-slug"=>"venuesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues"]}, "post"=>{"summary"=>"Post Venues", "description"=>"Updates a venue and returns it as an object.", "operationId"=>"postVenues", "x-api-path-slug"=>"venuesid-post", "parameters"=>[{"in"=>"query", "name"=>"venue.address.address_1", "description"=>"The first line of the address", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.address_2", "description"=>"The second line of the address", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.city", "description"=>"The city where the venue is", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.country", "description"=>"The country where the venue is", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.latitude", "description"=>"The latitude of the coordinates for the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.longitude", "description"=>"The longitude of the coordinates for the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.postal_code", "description"=>"The postal_code where the venue is", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.region", "description"=>"The region where the venue is", "type"=>"query"}, {"in"=>"query", "name"=>"venue.age_restriction", "description"=>"The age restrictions for the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.capacity", "description"=>"The max capacity for the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.google_place_id", "description"=>"The google place id for the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.name", "description"=>"The name of the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.organizer_id", "description"=>"The organizer this venue belongs to (optional - leave this off to use the default organizer)", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues"]}}, "/venues/"=>{"post"=>{"summary"=>"Post Venues", "description"=>"Creates a new venue with associated address.", "operationId"=>"postVenues", "x-api-path-slug"=>"venues-post", "parameters"=>[{"in"=>"query", "name"=>"venue.address.address_1", "description"=>"The first line of the address", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.address_2", "description"=>"The second line of the address", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.city", "description"=>"The city where the venue is", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.country", "description"=>"The country where the venue is", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.latitude", "description"=>"The latitude of the coordinates for the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.longitude", "description"=>"The longitude of the coordinates for the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.postal_code", "description"=>"The postal_code where the venue is", "type"=>"query"}, {"in"=>"query", "name"=>"venue.address.region", "description"=>"The region where the venue is", "type"=>"query"}, {"in"=>"query", "name"=>"venue.age_restriction", "description"=>"The age restrictions for the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.capacity", "description"=>"The max capacity for the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.google_place_id", "description"=>"The google place id for the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.name", "description"=>"The name of the venue", "type"=>"query"}, {"in"=>"query", "name"=>"venue.organizer_id", "description"=>"The organizer this venue belongs to (optional - leave this off to use the default organizer)", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues"]}}, "/venues/{id}/events/"=>{"get"=>{"summary"=>"Get Venues Events", "description"=>"Returns events of a given venue.", "operationId"=>"getVenuesEvents", "x-api-path-slug"=>"venuesidevents-get", "parameters"=>[{"in"=>"query", "name"=>"only_public", "description"=>"Only show public events even if viewing your own events", "type"=>"query"}, {"in"=>"query", "name"=>"order_by", "description"=>"How to order the results (Valid choices are: start_asc, start_desc, created_asc, or created_desc)", "type"=>"query"}, {"in"=>"query", "name"=>"start_date.range_end", "description"=>"Only return events with start dates before the given date", "type"=>"query"}, {"in"=>"query", "name"=>"start_date.range_start", "description"=>"Only return events with start dates after the given date", "type"=>"query"}, {"in"=>"query", "name"=>"status", "description"=>"Only return events with a specific status set", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venues", "Events"]}}, "/webhooks/{id}/"=>{"get"=>{"summary"=>"Get Webhooks", "description"=>"Returns a webhook for the specified webhook as webhook.", "operationId"=>"getWebhooks", "x-api-path-slug"=>"webhooksid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}, "delete"=>{"summary"=>"Delete Webhooks", "description"=>"Deletes the specified webhook object.", "operationId"=>"deleteWebhooks", "x-api-path-slug"=>"webhooksid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}}, "/webhooks/"=>{"get"=>{"summary"=>"Get Webhooks", "description"=>"Returns the list of webhook objects that belong to the authenticated user.", "operationId"=>"getWebhooks", "x-api-path-slug"=>"webhooks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}, "post"=>{"summary"=>"Post Webhooks", "description"=>"Creates a webhook for the authenticated user.", "operationId"=>"postWebhooks", "x-api-path-slug"=>"webhooks-post", "parameters"=>[{"in"=>"query", "name"=>"actions", "description"=>"Determines what actions will trigger the webhook", "type"=>"query"}, {"in"=>"query", "name"=>"endpoint_url", "description"=>"The target URL of the Webhook subscription", "type"=>"query"}, {"in"=>"query", "name"=>"event_id", "description"=>"The ID of the event that triggers this webhook", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}}, "/series/"=>{"post"=>{"summary"=>"Post Series", "description"=>"Creates a new repeating event series. The POST data must include information for at least one event date in the series.", "operationId"=>"postSeries", "x-api-path-slug"=>"series-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Series"]}}, "/series/{id}/"=>{"get"=>{"summary"=>"Get Series", "description"=>"Returns a repeating event series parent object for the specified repeating event series.", "operationId"=>"getSeries", "x-api-path-slug"=>"seriesid-get", "parameters"=>[{"in"=>"query", "name"=>"tracking_code", "description"=>"Append the given tracking_code to the event URLs returned", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Series"]}, "post"=>{"summary"=>"Post Series", "description"=>"Updates a repeating event series parent object, and optionally also creates more event dates or updates or deletes\nexisting event dates in the series. In order for a series date to be deleted or updated, there must be no pending or\ncompleted orders for that date.", "operationId"=>"postSeries", "x-api-path-slug"=>"seriesid-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Series"]}, "delete"=>{"summary"=>"Delete Series", "description"=>"Deletes a repeating event series and all of its occurrences if the delete is permitted. In order for a delete to be\npermitted, there must be no pending or completed orders for any dates in the series. Returns a boolean indicating\nsuccess or failure of the delete.", "operationId"=>"deleteSeries", "x-api-path-slug"=>"seriesid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Series"]}}, "/series/{id}/publish/"=>{"post"=>{"summary"=>"Post Series Publish", "description"=>"Publishes a repeating event series and all of its occurrences that are not already canceled or deleted. Once a date is cancelled it can still be uncancelled and can be viewed by the public. A deleted date cannot be undeleted and cannot by viewed by the public. In order for\npublish to be permitted, the event must have all necessary information, including a name and description, an organizer,\nat least one ticket, and valid payment options. This API endpoint will return argument errors for event fields that\nfail to validate the publish requirements. Returns a boolean indicating success or failure of the publish.", "operationId"=>"postSeriesPublish", "x-api-path-slug"=>"seriesidpublish-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Series", "Publish"]}}, "/series/{id}/unpublish/"=>{"post"=>{"summary"=>"Post Series Unpublish", "description"=>"Unpublishes a repeating event series and all of its occurrences that are not already completed, canceled, or deleted. In\norder for a free series to be unpublished, it must not have any pending or completed orders for any dates, even past\ndates. In order for a paid series to be unpublished, it must not have any pending or completed orders for any dates,\nexcept that completed orders for past dates that have been completed and paid out do not prevent an unpublish. Returns\na boolean indicating success or failure of the unpublish.", "operationId"=>"postSeriesUnpublish", "x-api-path-slug"=>"seriesidunpublish-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Series", "Unpublish"]}}, "/series/{id}/cancel/"=>{"post"=>{"summary"=>"Post Series Cancel", "description"=>"Cancels a repeating event series and all of its occurrences that are not already canceled or deleted. In order for\ncancel to be permitted, there must be no pending or completed orders for any dates in the series. Returns a boolean\nindicating success or failure of the cancel.", "operationId"=>"postSeriesCancel", "x-api-path-slug"=>"seriesidcancel-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Series", "Cancel"]}}, "/series/{id}/events/"=>{"get"=>{"summary"=>"Get Series Events", "description"=>"Returns all of the events that belong to this repeating event series.", "operationId"=>"getSeriesEvents", "x-api-path-slug"=>"seriesidevents-get", "parameters"=>[{"in"=>"query", "name"=>"order_by", "description"=>"How to order the results (Valid choices are: start_asc, start_desc, created_asc, or created_desc)", "type"=>"query"}, {"in"=>"query", "name"=>"time_filter", "description"=>"Limits results to either past or current & future events", "type"=>"query"}, {"in"=>"query", "name"=>"tracking_code", "description"=>"Append the given tracking_code to the event URLs returned", "type"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Series", "Events"]}, "post"=>{"summary"=>"Post Series Events", "description"=>"Creates more event dates or updates or deletes existing event dates in a repeating event series. In order for a series\ndate to be deleted or updated, there must be no pending or completed orders for that date.", "operationId"=>"postSeriesEvents", "x-api-path-slug"=>"seriesidevents-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Series", "Events"]}}, "/events/search/"=>{"get"=>{"summary"=>"Event Search", "description"=>"This method uses our search index to find publicly listed events.", "operationId"=>"Get_event_search_", "x-api-path-slug"=>"eventssearch-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"The venue address"}, {"in"=>"query", "name"=>"category", "description"=>"Event categories (comma seperated): conference, conventions, entertainment, fundraisers, meetings, other, performances, reunions, sales, seminars, social, sports, tradeshows, travel, religion, fairs, food, music, recreation"}, {"in"=>"query", "name"=>"city", "description"=>"The venue city"}, {"in"=>"query", "name"=>"country", "description"=>"2-letter country code, according to the ISO 3166 format"}, {"in"=>"query", "name"=>"count_only", "description"=>"Only return the total number of events (???true??? or ???false???)"}, {"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"date", "description"=>"The event start date"}, {"in"=>"query", "name"=>"date_created", "description"=>"The date range the event was created, specified by a label or by exact dates"}, {"in"=>"query", "name"=>"date_modified", "description"=>"The date range the event was modified, specified by a label or by exact dates"}, {"in"=>"query", "name"=>"keywords", "description"=>"The search keywords"}, {"in"=>"query", "name"=>"latitude", "description"=>"If ???within??? is set you can limit your search to wgs84 coordinates (latitude, longitude)"}, {"in"=>"query", "name"=>"longitude", "description"=>"If ???within??? is set you can limit your search to wgs84 coordinates (latitude, longitude)"}, {"in"=>"query", "name"=>"max", "description"=>"Limit the number of events returned"}, {"in"=>"query", "name"=>"organizer", "description"=>"The organizer name"}, {"in"=>"query", "name"=>"page", "description"=>"Allows for paging through the results of a query"}, {"in"=>"query", "name"=>"postal_code", "description"=>"The postal/zip code of the venue"}, {"in"=>"query", "name"=>"q", "description"=>"The query", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"region", "description"=>"The venue state/province/county/territory depending on the country"}, {"in"=>"query", "name"=>"since_id", "description"=>"Returns events with id greater than ???since_id??? value"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Sort the list of events by ???id???, ???date???, ???name???, ???city???"}, {"in"=>"query", "name"=>"tracking_link", "description"=>"The tracking link code to add to the event URLs"}, {"in"=>"query", "name"=>"within", "description"=>"If ???within??? is set and the ???city??? or ???zipcode??? resolve to a specific geolocation, the search will be restricted to the specified within radius"}, {"in"=>"query", "name"=>"within_unit", "description"=>"If within is set, you can specify the unit to use: ???M??? for miles, or ???K??? for kilometers"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Search"]}}, "/event_get"=>{"get"=>{"summary"=>"Get Event Get", "description"=>"This method returns the data for a given event. Only public events are viewable if no authentication is passed.", "operationId"=>"Get_event_get_", "x-api-path-slug"=>"event-get-get", "parameters"=>[{"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"event_id", "description"=>"The ID of the requested event"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Get"]}}, "/event_new"=>{"get"=>{"summary"=>"Get Event New", "description"=>"This method creates a new event. It returns the ID of the newly created event.", "operationId"=>"Get_event_new_", "x-api-path-slug"=>"event-new-get", "parameters"=>[{"in"=>"query", "name"=>"background_color", "description"=>"Custom hexadecimal color for your registration page"}, {"in"=>"query", "name"=>"box_background_color", "description"=>"Custom hexadecimal color for your registration page"}, {"in"=>"query", "name"=>"box_border_color", "description"=>"Custom hexadecimal color for your registration page"}, {"in"=>"query", "name"=>"box_header_background_color", "description"=>"Custom hexadecimal color for your registration page"}, {"in"=>"query", "name"=>"box_header_text_color", "description"=>"Custom hexadecimal color for your registration page"}, {"in"=>"query", "name"=>"box_text_color", "description"=>"Custom hexadecimal color for your registration page"}, {"in"=>"query", "name"=>"capacity", "description"=>"The maximum number of people who can attend the event"}, {"in"=>"query", "name"=>"currency", "description"=>"The event currency in ISO 4217 format (e"}, {"in"=>"query", "name"=>"custom_footer", "description"=>"Custom HTML footer for your registration page"}, {"in"=>"query", "name"=>"custom_header", "description"=>"Custom HTML header for your registration page"}, {"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"description", "description"=>"The event description"}, {"in"=>"query", "name"=>"end_date", "description"=>"The event end date and time, in ISO 8601 format (e"}, {"in"=>"query", "name"=>"organizer_id", "description"=>"The event organizer ID"}, {"in"=>"query", "name"=>"personalized_url", "description"=>"The event registration URL"}, {"in"=>"query", "name"=>"privacy", "description"=>"0 for a private event, 1 for a public event"}, {"in"=>"query", "name"=>"start_date", "description"=>"The event start date and time, in ISO 8601 format (e"}, {"in"=>"query", "name"=>"status", "description"=>"The event status"}, {"in"=>"query", "name"=>"text_color", "description"=>"Custom hexadecimal color for your registration page"}, {"in"=>"query", "name"=>"timezone", "description"=>"The event time zone in relation to GMT (e"}, {"in"=>"query", "name"=>"title", "description"=>"The event title"}, {"in"=>"query", "name"=>"title_text_color", "description"=>"Custom hexadecimal color for your registration page"}, {"in"=>"query", "name"=>"venue_id", "description"=>"The event venue ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "New"]}}, "/event_update"=>{"get"=>{"summary"=>"Get Event Update", "description"=>"This method updates an existing event. Only the fields passed as arguments will be modified. This method returns the ID of the modified event.", "operationId"=>"Get_event_update_", "x-api-path-slug"=>"event-update-get", "parameters"=>[{"in"=>"query", "name"=>"background_color", "description"=>"Custom hexadecimal color for your registration page"}, {"in"=>"query", "name"=>"box_background_color", "description"=>"Custom hexadecimal color for your registration page"}, {"in"=>"query", "name"=>"box_border_color", "description"=>"Custom hexadecimal color for your registration page"}, {"in"=>"query", "name"=>"box_header_background_color", "description"=>"Custom hexadecimal color for your registration page"}, {"in"=>"query", "name"=>"box_header_text_color", "description"=>"Custom hexadecimal color for your registration page"}, {"in"=>"query", "name"=>"box_text_color", "description"=>"Custom hexadecimal color for your registration page"}, {"in"=>"query", "name"=>"capacity", "description"=>"The maximum number of people who can attend the event"}, {"in"=>"query", "name"=>"currency", "description"=>"The event currency in ISO 4217 format (e"}, {"in"=>"query", "name"=>"custom_footer", "description"=>"Custom HTML footer for your registration page"}, {"in"=>"query", "name"=>"custom_header", "description"=>"Custom HTML header for your registration page"}, {"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"description", "description"=>"The event description"}, {"in"=>"query", "name"=>"end_date", "description"=>"The event end date and time, in ISO 8601 format (e"}, {"in"=>"query", "name"=>"event_id", "description"=>"The ID of the event to update"}, {"in"=>"query", "name"=>"organizer_id", "description"=>"The event organizer ID"}, {"in"=>"query", "name"=>"personalized_url", "description"=>"The event registration URL subdomain"}, {"in"=>"query", "name"=>"privacy", "description"=>"0 for a private event, 1 for a public event"}, {"in"=>"query", "name"=>"start_date", "description"=>"The event start date and time, in ISO 8601 format (e"}, {"in"=>"query", "name"=>"status", "description"=>"The event status"}, {"in"=>"query", "name"=>"text_color", "description"=>"Custom hexadecimal color for your registration page"}, {"in"=>"query", "name"=>"timezone", "description"=>"The event time zone in relation to GMT (e"}, {"in"=>"query", "name"=>"title", "description"=>"The event title"}, {"in"=>"query", "name"=>"title_text_color", "description"=>"Custom hexadecimal color for your registration page"}, {"in"=>"query", "name"=>"venue_id", "description"=>"The event venue ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Update"]}}, "/event_copy"=>{"get"=>{"summary"=>"Get Event Copy", "description"=>"This method duplicates an existing event, returning the ID of the new event.", "operationId"=>"Get_event_copy_", "x-api-path-slug"=>"event-copy-get", "parameters"=>[{"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"event_id", "description"=>"The ID of the existing event"}, {"in"=>"query", "name"=>"event_name", "description"=>"A new name for this copy of the Event"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Copy"]}}, "/user_list_events"=>{"get"=>{"summary"=>"Get User List Events", "description"=>"This method lists the events created by this user. Only public events are returned if no authentication is passed.", "operationId"=>"Get_user_list_events_", "x-api-path-slug"=>"user-list-events-get", "parameters"=>[{"in"=>"query", "name"=>"asc_or_desc", "description"=>"Valid options include ???asc??? or results in ascending order or ???desc??? or descending order based on event start_date"}, {"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"do_not_display", "description"=>"Comma separated list without spaces"}, {"in"=>"query", "name"=>"email", "description"=>"The user email"}, {"in"=>"query", "name"=>"event_statuses", "description"=>"Comma separated list without spaces"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "List", "Events"]}}, "/ticket_new"=>{"get"=>{"summary"=>"Get Ticket New", "description"=>"This method creates new fixed-price or donation ticket types. It returns the ID of the newly created ticket.", "operationId"=>"Get_ticket_new_", "x-api-path-slug"=>"ticket-new-get", "parameters"=>[{"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"description", "description"=>"The ticket description"}, {"in"=>"query", "name"=>"end_sales", "description"=>"The date and time when ticket sales stop, in ISO 8601 format (e"}, {"in"=>"query", "name"=>"event_id", "description"=>"The event ID"}, {"in"=>"query", "name"=>"include_fee", "description"=>"0 to add the Eventbrite service fee on top of ticket price, or 1 to include it in the ticket price"}, {"in"=>"query", "name"=>"is_donation", "description"=>"0 for fixed-price tickets, 1 for donations"}, {"in"=>"query", "name"=>"max", "description"=>"The maximum number of tickets per order"}, {"in"=>"query", "name"=>"min", "description"=>"The minimum number of tickets per order"}, {"in"=>"query", "name"=>"name", "description"=>"The ticket name"}, {"in"=>"query", "name"=>"price", "description"=>"The ticket price"}, {"in"=>"query", "name"=>"quantity", "description"=>"The number of tickets available"}, {"in"=>"query", "name"=>"start_sales", "description"=>"The date and time when ticket sales start, in ISO 8601 format (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket", "New"]}}, "/ticket_update"=>{"get"=>{"summary"=>"Get Ticket Update", "description"=>"This method updates an existing ticket type. Only the fields passed as arguments will be modified. It returns the ID of the updated ticket.", "operationId"=>"Get_ticket_update_", "x-api-path-slug"=>"ticket-update-get", "parameters"=>[{"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"description", "description"=>"The ticket description"}, {"in"=>"query", "name"=>"end_sales", "description"=>"The date and time when ticket sales stop, in ISO 8601 format (e"}, {"in"=>"query", "name"=>"hide", "description"=>"Show or hide the ticket type"}, {"in"=>"query", "name"=>"id", "description"=>"The ticket ID"}, {"in"=>"query", "name"=>"include_fee", "description"=>"0 to add the Eventbrite service fee on top of ticket price, or 1 to include it in the ticket price"}, {"in"=>"query", "name"=>"is_donation", "description"=>"0 for fixed-price tickets, 1 for donations"}, {"in"=>"query", "name"=>"max", "description"=>"The maximum number of tickets per order"}, {"in"=>"query", "name"=>"min", "description"=>"The minimum number of tickets per order"}, {"in"=>"query", "name"=>"name", "description"=>"The ticket name"}, {"in"=>"query", "name"=>"price", "description"=>"The ticket price"}, {"in"=>"query", "name"=>"quantity", "description"=>"The number of tickets available"}, {"in"=>"query", "name"=>"start_sales", "description"=>"The date and time when ticket sales start, in ISO 8601 format (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket", "Update"]}}, "/event_list_attendees"=>{"get"=>{"summary"=>"Get Event List Attendees", "description"=>"This method returns a list of attendees for a given event. If no authentication is passed, only publicly available attendee records will be returned.", "operationId"=>"Get_event_list_attendees_", "x-api-path-slug"=>"event-list-attendees-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Limit the number of attendees returned"}, {"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"do_not_display", "description"=>"Comma separated list without spaces that leaves out certain data returned"}, {"in"=>"query", "name"=>"event_id", "description"=>"The ID of the event"}, {"in"=>"query", "name"=>"page", "description"=>"Allows for paging through the results of a query"}, {"in"=>"query", "name"=>"show_full_barcodes", "description"=>"If set to ???true???, it will return all barcodes associates with the attendee, plus the barcode status, device used, attendee_id, and barcode number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "List", "Attendees"]}}, "/venue_get"=>{"get"=>{"summary"=>"Get Venue Get", "description"=>"This method returns a single venue by id.", "operationId"=>"Get_venue_get_", "x-api-path-slug"=>"venue-get-get", "parameters"=>[{"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"id", "description"=>"The venue id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venue", "Get"]}}, "/venue_new"=>{"get"=>{"summary"=>"Get Venue New", "description"=>"This method creates a new venue. It returns the ID of the newly created venue.", "operationId"=>"Get_venue_new_", "x-api-path-slug"=>"venue-new-get", "parameters"=>[{"in"=>"query", "name"=>"adress", "description"=>"The venue address (line 1)"}, {"in"=>"query", "name"=>"adress_2", "description"=>"The venue address (line 2)"}, {"in"=>"query", "name"=>"city", "description"=>"The venue city"}, {"in"=>"query", "name"=>"country_code", "description"=>"2-letter country code, according to the ISO 3166 format"}, {"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"organizer_id", "description"=>"The ID of the related organizer"}, {"in"=>"query", "name"=>"postal_code", "description"=>"The postal code of the venue"}, {"in"=>"query", "name"=>"region", "description"=>"The venue state/province/county/territory depending on the country"}, {"in"=>"query", "name"=>"venue", "description"=>"The venue name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venue", "New"]}}, "/venue_update"=>{"get"=>{"summary"=>"Get Venue Update", "description"=>"This method updates an existing venue. Only the fields passed as arguments will be modified. It returns the ID of the updated venue.", "operationId"=>"Get_venue_update_", "x-api-path-slug"=>"venue-update-get", "parameters"=>[{"in"=>"query", "name"=>"adress", "description"=>"The venue address (line 1)"}, {"in"=>"query", "name"=>"adress_2", "description"=>"The venue address (line 2)"}, {"in"=>"query", "name"=>"city", "description"=>"The venue city"}, {"in"=>"query", "name"=>"country_code", "description"=>"2-letter country code, according to the ISO 3166 format"}, {"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"id", "description"=>"The venue ID"}, {"in"=>"query", "name"=>"postal_code", "description"=>"The postal code of the venue"}, {"in"=>"query", "name"=>"region", "description"=>"The venue state/province/county/territory depending on the country"}, {"in"=>"query", "name"=>"venue", "description"=>"The venue name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Venue", "Update"]}}, "/user_list_venues"=>{"get"=>{"summary"=>"Get User List Venues", "description"=>"This method lists the venues created by this user. Requires authentication.", "operationId"=>"Get_user_list_venues_", "x-api-path-slug"=>"user-list-venues-get", "parameters"=>[{"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "List", "Venues"]}}, "/organizer_list_events"=>{"get"=>{"summary"=>"Get Organizer List Events", "description"=>"This method returns a list of events for a given organizer.", "operationId"=>"Get_organizer_list_events_", "x-api-path-slug"=>"organizer-list-events-get", "parameters"=>[{"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"id", "description"=>"The organizer id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizer", "List", "Events"]}}, "/organizer_get"=>{"get"=>{"summary"=>"Get Organizer Get", "description"=>"This method returns a single organizer by id.", "operationId"=>"Get_organizer_get_", "x-api-path-slug"=>"organizer-get-get", "parameters"=>[{"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"id", "description"=>"The organizer profile id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizer", "Get"]}}, "/organizer_new"=>{"get"=>{"summary"=>"Get Organizer New", "description"=>"Many event creators prefer having a specific person identified as the point of contact for their event. This person is usually someone like the event emcee, or an on-site contact that can help with attendee check-ins or other issues during the event. This method creates a new organizer, and returns the organizer_id for the newly created resource.", "operationId"=>"Get_organizer_new_", "x-api-path-slug"=>"organizer-new-get", "parameters"=>[{"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"description", "description"=>"The organizer description"}, {"in"=>"query", "name"=>"name", "description"=>"The organizer name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizer", "New"]}}, "/organizer_update"=>{"get"=>{"summary"=>"Get Organizer Update", "description"=>"This method updates an existing organizer. Only the fields passed as arguments will be modified. It returns the ID of the updated organizer.", "operationId"=>"Get_organizer_update_", "x-api-path-slug"=>"organizer-update-get", "parameters"=>[{"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"description", "description"=>"The organizer description"}, {"in"=>"query", "name"=>"id", "description"=>"The organizer ID"}, {"in"=>"query", "name"=>"name", "description"=>"The organizer name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizer", "Update"]}}, "/user_list_organizers"=>{"get"=>{"summary"=>"Get User List Organizers", "description"=>"This method lists the organizers created by this user. Requires authentication.", "operationId"=>"Get_user_list_organizers_", "x-api-path-slug"=>"user-list-organizers-get", "parameters"=>[{"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "List", "Organizers"]}}, "/user_list_tickets"=>{"get"=>{"summary"=>"Get User List Tickets", "description"=>"This method lists the tickets purchased by the authenticated user. Each transaction is an order in our system and an order may contain one or more tickets. Tickets to free events are included.", "operationId"=>"Get_user_list_tickets_", "x-api-path-slug"=>"user-list-tickets-get", "parameters"=>[{"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "List", "Tickets"]}}, "/user_get"=>{"get"=>{"summary"=>"Get User Get", "description"=>"This method returns the user account identified by the user_id or email request parameters. Visibility is limited to users and sub-users of the given user_key.", "operationId"=>"Get_user_get_", "x-api-path-slug"=>"user-get-get", "parameters"=>[{"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"email", "description"=>"The email address of the subuser account"}, {"in"=>"query", "name"=>"user_id", "description"=>"The ID of the subuser account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Get"]}}, "/user_new"=>{"get"=>{"summary"=>"Get User New", "description"=>"This method creates a new user, returning the user???s ID in the response.", "operationId"=>"Get_user_new_", "x-api-path-slug"=>"user-new-get", "parameters"=>[{"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"email", "description"=>"The user email address"}, {"in"=>"query", "name"=>"passwd", "description"=>"The user password"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "New"]}}, "/user_update"=>{"get"=>{"summary"=>"Get User Update", "description"=>"This method updates an existing user. Only the fields passed as arguments will be modified. It returns the ID of the updated user.", "operationId"=>"Get_user_update_", "x-api-path-slug"=>"user-update-get", "parameters"=>[{"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"new_email", "description"=>"New user email address"}, {"in"=>"query", "name"=>"new_password", "description"=>"New user password"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Update"]}}, "/event_list_discounts"=>{"get"=>{"summary"=>"Get Event List Discounts", "description"=>"This method returns a list of discounts for a given event.", "operationId"=>"Get_event_list_discounts_", "x-api-path-slug"=>"event-list-discounts-get", "parameters"=>[{"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"id", "description"=>"The ID of the event"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "List", "Discounts"]}}, "/discount_new"=>{"get"=>{"summary"=>"Get Discount New", "description"=>"This method creates a new discount code for a specific event. It returns the ID of the newly created discount code.", "operationId"=>"Get_discount_new_", "x-api-path-slug"=>"discount-new-get", "parameters"=>[{"in"=>"query", "name"=>"amount_off", "description"=>"The fixed amount off the ticket price"}, {"in"=>"query", "name"=>"code", "description"=>"The discount code"}, {"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"end_date", "description"=>"The discount end date and time, in ISO 8601 format (e"}, {"in"=>"query", "name"=>"event_id", "description"=>"The event ID"}, {"in"=>"query", "name"=>"percent_off", "description"=>"The percentage off the ticket price"}, {"in"=>"query", "name"=>"quantity_available", "description"=>"Maximum number of times this discount can be used"}, {"in"=>"query", "name"=>"start_date", "description"=>"The discount start date and time, in ISO 8601 format (e"}, {"in"=>"query", "name"=>"tickets", "description"=>"Comma-separated list of ticket IDs for which the discount applies"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Discount", "New"]}}, "/discount_update"=>{"get"=>{"summary"=>"Get Discount Update", "description"=>"This method is used to update an existing discount code. Only the fields passed as arguments will be modified. This method returns the ID of the modified discount code.", "operationId"=>"Get_discount_update_", "x-api-path-slug"=>"discount-update-get", "parameters"=>[{"in"=>"query", "name"=>"amount_off", "description"=>"The fixed amount off the ticket price"}, {"in"=>"query", "name"=>"code", "description"=>"The discount code"}, {"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"end_date", "description"=>"The discount end date and time, in ISO 8601 format (e"}, {"in"=>"query", "name"=>"id", "description"=>"The discount ID to update"}, {"in"=>"query", "name"=>"percent_off", "description"=>"The percentage off the ticket price"}, {"in"=>"query", "name"=>"quantity_available", "description"=>"Maximum number of times this discount can be used"}, {"in"=>"query", "name"=>"start_date", "description"=>"The discount start date and time, in ISO 8601 format (e"}, {"in"=>"query", "name"=>"tickets", "description"=>"Comma-separated list of ticket IDs for which the discount applies"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Discount", "Update"]}}, "/payment_update"=>{"get"=>{"summary"=>"Get Payment Update", "description"=>"This method creates or updates the payment options for this event. Only the fields passed as arguments will be modified.", "operationId"=>"Get_payment_update_", "x-api-path-slug"=>"payment-update-get", "parameters"=>[{"in"=>"query", "name"=>"accept_cash", "description"=>"Accept ???Pay by Cash??? payments (1 or 0)"}, {"in"=>"query", "name"=>"accept_check", "description"=>"Accept ???Pay by Check??? payments (1 or 0)"}, {"in"=>"query", "name"=>"accept_google", "description"=>"Accept Google Checkout payments (1 or 0)"}, {"in"=>"query", "name"=>"accept_invoice", "description"=>"Accept ???Send an Invoice??? payments (1 or 0)"}, {"in"=>"query", "name"=>"accept_paypal", "description"=>"Accept PayPal payments (1 or 0)"}, {"in"=>"query", "name"=>"data-type", "description"=>"xml or json data-types are supported"}, {"in"=>"query", "name"=>"event_id", "description"=>"The event ID"}, {"in"=>"query", "name"=>"google_merchant_id", "description"=>"Google Checkout Merchant ID"}, {"in"=>"query", "name"=>"google_merchant_key", "description"=>"Google Checkout Merchant Key"}, {"in"=>"query", "name"=>"instructions_cash", "description"=>"Instructions to attendees who want to pay by cash"}, {"in"=>"query", "name"=>"instructions_check", "description"=>"Instructions to attendees who want to pay by check"}, {"in"=>"query", "name"=>"instructions_invoice", "description"=>"Instructions to attendees who need to be sent an invoice"}, {"in"=>"query", "name"=>"paypal_email", "description"=>"Your PayPal email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment", "Update"]}}}}, "apis"=>{"name"=>"Eventbrite", "x-slug"=>"eventbrite", "description"=>"Eventbrite brings people together through live experiences. Discover events that match your passions, or create your own with online ticketing tools.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/193-eventbrite.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"643", "tags"=>"API LIfeyclessss,API Provider,Events,Events,General Data,Historical Data API,internet,Marketplace,Mobile,My API Stack,Pedestal,Profiles,Registrations,Relative Data,Stack,Stack Network,Streams,Streams,Technology,Tickets,Tickets,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"eventbrite/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Eventbrite", "x-api-slug"=>"eventbrite", "description"=>"Eventbrite brings people together through live experiences. Discover events that match your passions, or create your own with online ticketing tools.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/193-eventbrite.jpg", "humanURL"=>"http://eventbriteapi.com", "baseURL"=>"https://www.eventbriteapi.com//v3/", "tags"=>"API LIfeyclessss,API Provider,Events,Events,General Data,Historical Data API,internet,Marketplace,Mobile,My API Stack,Pedestal,Profiles,Registrations,Relative Data,Stack,Stack Network,Streams,Streams,Technology,Tickets,Tickets,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/eventbrite/payment-update-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/eventbrite/eventbrite-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-apigee-console", "url"=>"https://api.apigee.com/v1/consoles/eventbrite/apidescription?format=internal&ver=1351170233000"}, {"type"=>"x-authentication", "url"=>"https://developer.eventbrite.com/docs/auth/"}, {"type"=>"x-base", "url"=>"https://www.eventbriteapi.com/"}, {"type"=>"x-blog", "url"=>"http://blog.eventbrite.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.eventbrite.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/eventbrite"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/eventbrite"}, {"type"=>"x-developer", "url"=>"https://developer.eventbrite.com/"}, {"type"=>"x-github", "url"=>"https://github.com/eventbrite"}, {"type"=>"x-pricing", "url"=>"http://help.eventbrite.com/customer/en_us/portal/articles/428604"}, {"type"=>"x-privacy", "url"=>"http://www.eventbrite.com/privacypolicy"}, {"type"=>"x-sdks-io", "url"=>"https://sdks.io/SDK/View/eventbrite"}, {"type"=>"x-selfservice-registration", "url"=>"https://www.eventbrite.com/signup/?referrer=%2F%3Fshow_onboarding%3D1&user_type=prebuyer&user_type_sig=AH_ElWGNJ_zHaAxwjzt5jiCRmvPvNBsy6w"}, {"type"=>"x-terms-of-service", "url"=>"http://www.eventbrite.com/tos"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/EventbriteAPI"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/eventbrite"}, {"type"=>"x-webhook", "url"=>"https://www.eventbrite.com/developer/v3/api_overview/webhooks/"}, {"type"=>"x-website", "url"=>"http://eventbriteapi.com"}, {"type"=>"x-website", "url"=>"http://developer.eventbrite.com/"}, {"type"=>"x-website", "url"=>"http://eventbrite.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
actility{"thingpark-dx-dataflow-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Actility", "x-complete"=>1, "info"=>{"title"=>"ThingPark DX Dataflow API", "description"=>"api-for-managing-thingpark-x-dataflows-and-associating-those-dataflows-with-thingpark-devices-", "version"=>"1.0.0"}, "host"=>"dx-api.thingpark.com", "basePath"=>"/dataflow/v021/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/bridgeDataflows"=>{"get"=>{"summary"=>"Bridge dataflows retrieval", "description"=>"Retrieves the list of Bridge dataflows available in the scope.", "operationId"=>"retrieves-the-list-of-bridge-dataflows-available-in-the-scope", "x-api-path-slug"=>"bridgedataflows-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bridge", "Dataflows", "Retrieval"]}, "post"=>{"summary"=>"Bridge dataflow creation", "description"=>"Creates a new Bridge dataflow.", "operationId"=>"creates-a-new-bridge-dataflow", "x-api-path-slug"=>"bridgedataflows-post", "parameters"=>[{"in"=>"body", "name"=>"bridgeDataflow", "description"=>"Contents of the Bridge dataflow to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bridge", "Dataflow", "Creation"]}}, "/bridgeDataflows/{bridgeDataflowRef}"=>{"get"=>{"summary"=>"Bridge dataflow retrieval", "description"=>"Retrieves the Bridge dataflow corresponding to the provided order ref, if that order is within authorized scopes.", "operationId"=>"retrieves-the-bridge-dataflow-corresponding-to-the-provided-order-ref-if-that-order-is-within-author", "x-api-path-slug"=>"bridgedataflowsbridgedataflowref-get", "parameters"=>[{"in"=>"path", "name"=>"bridgeDataflowRef", "description"=>"Ref of the Bridge dataflow to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bridge", "Dataflow", "Retrieval"]}, "put"=>{"summary"=>"Bridge dataflow update", "description"=>"Updates the Bridge dataflow corresponding to the provided Bridge dataflow ref, if that dataflow is within authorized scopes. Note that when updating a dataflow, all existing attributs must be provided next to your changes.", "operationId"=>"updates-the-bridge-dataflow-corresponding-to-the-provided-bridge-dataflow-ref-if-that-dataflow-is-wi", "x-api-path-slug"=>"bridgedataflowsbridgedataflowref-put", "parameters"=>[{"in"=>"body", "name"=>"bridgeDataflow", "description"=>"Contents of the Bridge dataflow to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bridgeDataflowRef", "description"=>"Ref of the Bridge dataflow to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bridge", "Dataflow", "Update"]}, "delete"=>{"summary"=>"Bridge dataflow deletion", "description"=>"Deletes the Bridge dataflow corresponding to the provided Bridge dataflow ref, if that dataflow is within authorized scopes.", "operationId"=>"deletes-the-bridge-dataflow-corresponding-to-the-provided-bridge-dataflow-ref-if-that-dataflow-is-wi", "x-api-path-slug"=>"bridgedataflowsbridgedataflowref-delete", "parameters"=>[{"in"=>"path", "name"=>"bridgeDataflowRef", "description"=>"Ref of the Bridge dataflow to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bridge", "Dataflow", "Deletion"]}}, "/constantMaps"=>{"get"=>{"summary"=>"Constant maps retrieval", "description"=>"Retrieves the list of constant maps (both system-provided and custom) available in the scope.", "operationId"=>"retrieves-the-list-of-constant-maps-both-systemprovided-and-custom-available-in-the-scope", "x-api-path-slug"=>"constantmaps-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Constant", "Maps", "Retrieval"]}, "post"=>{"summary"=>"Constant maps creation", "description"=>"Creates a new custom constant map for the subscriber.", "operationId"=>"creates-a-new-custom-constant-map-for-the-subscriber", "x-api-path-slug"=>"constantmaps-post", "parameters"=>[{"in"=>"body", "name"=>"constantMap", "description"=>"Contents of the constant map to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Constant", "Maps", "Creation"]}}, "/constantMaps/{constantMapRef}"=>{"get"=>{"summary"=>"Constant map retrieval", "description"=>"Retrieves the constant map corresponding to the provided constant map ref..", "operationId"=>"retrieves-the-constant-map-corresponding-to-the-provided-constant-map-ref", "x-api-path-slug"=>"constantmapsconstantmapref-get", "parameters"=>[{"in"=>"path", "name"=>"constantMapRef", "description"=>"Ref of the constant map to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Constant", "Map", "Retrieval"]}, "put"=>{"summary"=>"Constant map update", "description"=>"Updates the constant map corresponding to the provided constant map ref. This is only authorized if the constant map has been created by the subscriber (not provided by the system).", "operationId"=>"updates-the-constant-map-corresponding-to-the-provided-constant-map-ref-this-is-only-authorized-if-t", "x-api-path-slug"=>"constantmapsconstantmapref-put", "parameters"=>[{"in"=>"body", "name"=>"constantMap", "description"=>"Contents of the constant map to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"constantMapRef", "description"=>"Ref of the constant map to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Constant", "Map", "Update"]}, "delete"=>{"summary"=>"Constant map deletion", "description"=>"Deletes the constant map corresponding to the provided constant map ref. This is only authorized if the constant map has been created by the subscriber (not provided by the system).", "operationId"=>"deletes-the-constant-map-corresponding-to-the-provided-constant-map-ref-this-is-only-authorized-if-t", "x-api-path-slug"=>"constantmapsconstantmapref-delete", "parameters"=>[{"in"=>"path", "name"=>"constantMapRef", "description"=>"Ref of the constant map to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Constant", "Map", "Deletion"]}}, "/binderClasses"=>{"get"=>{"summary"=>"Binder processor classes retrieval", "description"=>"Retrieves the list of system-wide processor classes providing binder (e.g. with a device) behaviour.", "operationId"=>"retrieves-the-list-of-systemwide-processor-classes-providing-binder-eg-with-a-device-behaviour", "x-api-path-slug"=>"binderclasses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Binder", "Processor", "Classes", "Retrieval"]}}, "/driverClasses"=>{"get"=>{"summary"=>"Driver processor classes retrieval", "description"=>"Retrieves the list of system-wide processor classes providing driver behaviour.", "operationId"=>"retrieves-the-list-of-systemwide-processor-classes-providing-driver-behaviour", "x-api-path-slug"=>"driverclasses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Driver", "Processor", "Classes", "Retrieval"]}}, "/connectorClasses"=>{"get"=>{"summary"=>"Connector processor classes retrieval", "description"=>"Retrieves the list of system-wide processor classes providing connector behaviour.", "operationId"=>"retrieves-the-list-of-systemwide-processor-classes-providing-connector-behaviour", "x-api-path-slug"=>"connectorclasses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connector", "Processor", "Classes", "Retrieval"]}}, "/events"=>{"get"=>{"summary"=>"Dataflow events retrieval", "description"=>"Retrieves the list of events for all configured dataflows in scope.", "operationId"=>"retrieves-the-list-of-events-for-all-configured-dataflows-in-scope", "x-api-path-slug"=>"events-get", "parameters"=>[{"in"=>"query", "name"=>"dataflowRef", "description"=>"Ref of the dataflow for which events should be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dataflow", "Events", "Retrieval"]}}, "/uplinkMessages"=>{"post"=>{"summary"=>"Uplink data reception", "description"=>"Endpoint to be used by the LRC to push uplink data in order to use ThingPark X dataflows.", "operationId"=>"endpoint-to-be-used-by-the-lrc-to-push-uplink-data-in-order-to-use-thingpark-x-dataflows", "x-api-path-slug"=>"uplinkmessages-post", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"Uplink data frame in ThingPark XML or JSON format", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Uplink", "Data", "Reception"]}}}}, "thingpark-dx-admin-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Actility", "x-complete"=>1, "info"=>{"title"=>"ThingPark DX Admin API", "description"=>"api-providing-token-generation-and-administration-features-for-the-thingpark-dx-api-platform-", "version"=>"1.0.0"}, "host"=>"dx-api.thingpark.com", "basePath"=>"/admin/v140/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/oauth/token"=>{"post"=>{"summary"=>"Token Generation", "description"=>"Generates and retrieves a token for a client.", "operationId"=>"generates-and-retrieves-a-token-for-a-client", "x-api-path-slug"=>"oauthtoken-post", "parameters"=>[{"in"=>"formData", "name"=>"client_id", "description"=>"Id of the client"}, {"in"=>"formData", "name"=>"client_secret", "description"=>"Secret of the client"}, {"in"=>"formData", "name"=>"grant_type", "description"=>"Type of the OAuth2 grant workflow"}, {"in"=>"query", "name"=>"renewToken", "description"=>"Forces the token to be renewed"}, {"in"=>"query", "name"=>"validityPeriod", "description"=>"Validity of the new token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token", "Generation"]}}, "/oauth/revoke_token"=>{"post"=>{"summary"=>"Token Revocation", "description"=>"Revokes a token.", "operationId"=>"revokes-a-token", "x-api-path-slug"=>"oauthrevoke-token-post", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"Value of the token to revoke"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token", "Revocation"]}}, "/oauth/tokeninfo"=>{"get"=>{"summary"=>"Token Info Retrieval", "description"=>"Retrieves information about a valid token.", "operationId"=>"retrieves-information-about-a-valid-token", "x-api-path-slug"=>"oauthtokeninfo-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"Value of the token for which info is requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token", "Info", "Retrieval"]}}, "/profiles"=>{"get"=>{"summary"=>"Profiles Retrieval", "description"=>"Retrieves all available profiles. By default only retrieves ACTILITY-owned profiles.", "operationId"=>"retrieves-all-available-profiles-by-default-only-retrieves-actilityowned-profiles", "x-api-path-slug"=>"profiles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profiles", "Retrieval"]}}, "/profiles/{profileId}"=>{"get"=>{"summary"=>"Profile Retrieval", "description"=>"Retrieves the profile corresponding to the provided profile Id.", "operationId"=>"retrieves-the-profile-corresponding-to-the-provided-profile-id", "x-api-path-slug"=>"profilesprofileid-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"Id of the profile to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile", "Retrieval"]}}}}, "thingpark-dx-core-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Actility", "x-complete"=>1, "info"=>{"title"=>"ThingPark DX Core API", "description"=>"api-providing-activation-and-provisioning-capabilities-on-top-of-thingpark-os-and-thingpark-wireless-", "version"=>"1.0.0"}, "host"=>"dx-api.thingpark.com", "basePath"=>"/core/v141/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/suppliers"=>{"get"=>{"summary"=>"Suppliers retrieval", "description"=>"Retrieves a list of suppliers existing within authorized scopes.", "operationId"=>"retrieves-a-list-of-suppliers-existing-within-authorized-scopes", "x-api-path-slug"=>"suppliers-get", "parameters"=>[{"in"=>"query", "name"=>"supplierId", "description"=>"Id of the supplier to search for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suppliers", "Retrieval"]}, "post"=>{"summary"=>"Supplier creation", "description"=>"Creates a new supplier with a primary user having all admin rights. Note that the supplier id can be chosen. If not fully specified, the supplier id and name attribute values are deduced from the primaryUser attribute values.", "operationId"=>"creates-a-new-supplier-with-a-primary-user-having-all-admin-rights-note-that-the-supplier-id-can-be-", "x-api-path-slug"=>"suppliers-post", "parameters"=>[{"in"=>"body", "name"=>"supplier", "description"=>"Contents of the supplier to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Supplier", "Creation"]}}, "/suppliers/{supplierRef}"=>{"get"=>{"summary"=>"Supplier retrieval", "description"=>"Retrieves the supplier corresponding to the provided supplier ref, if that supplier is within authorized scopes.", "operationId"=>"retrieves-the-supplier-corresponding-to-the-provided-supplier-ref-if-that-supplier-is-within-authori", "x-api-path-slug"=>"supplierssupplierref-get", "parameters"=>[{"in"=>"path", "name"=>"supplierRef", "description"=>"Ref of the supplier to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Supplier", "Retrieval"]}, "put"=>{"summary"=>"Supplier update", "description"=>"Updates the supplier corresponding to the provided supplier ref, if that supplier is within authorized scopes.", "operationId"=>"updates-the-supplier-corresponding-to-the-provided-supplier-ref-if-that-supplier-is-within-authorize", "x-api-path-slug"=>"supplierssupplierref-put", "parameters"=>[{"in"=>"body", "name"=>"supplier", "description"=>"Contents of the supplier to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"supplierRef", "description"=>"Ref of the supplier to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Supplier", "Update"]}, "delete"=>{"summary"=>"Supplier deletion", "description"=>"Deletes the supplier corresponding to the provided supplier ref, if that supplier is within authorized scopes.", "operationId"=>"deletes-the-supplier-corresponding-to-the-provided-supplier-ref-if-that-supplier-is-within-authorize", "x-api-path-slug"=>"supplierssupplierref-delete", "parameters"=>[{"in"=>"path", "name"=>"supplierRef", "description"=>"Ref of the supplier to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Supplier", "Deletion"]}}, "/vendors"=>{"get"=>{"summary"=>"Vendors retrieval", "description"=>"Retrieves a list of vendors existing within authorized scopes.", "operationId"=>"retrieves-a-list-of-vendors-existing-within-authorized-scopes", "x-api-path-slug"=>"vendors-get", "parameters"=>[{"in"=>"query", "name"=>"vendorId", "description"=>"Id of the vendor to search for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vendors", "Retrieval"]}, "post"=>{"summary"=>"Vendor creation", "description"=>"Creates a new vendor with a primary user having all admin rights. Note that the vendor id can be chosen. If not fully specified, the vendor id and name attribute values are deduced from the primaryUser attribute values.", "operationId"=>"creates-a-new-vendor-with-a-primary-user-having-all-admin-rights-note-that-the-vendor-id-can-be-chos", "x-api-path-slug"=>"vendors-post", "parameters"=>[{"in"=>"body", "name"=>"vendor", "description"=>"Contents of the vendor to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vendor", "Creation"]}}, "/vendors/{vendorRef}"=>{"get"=>{"summary"=>"Vendor retrieval", "description"=>"Retrieves the vendor corresponding to the provided vendor ref, if that vendor is within authorized scopes.", "operationId"=>"retrieves-the-vendor-corresponding-to-the-provided-vendor-ref-if-that-vendor-is-within-authorized-sc", "x-api-path-slug"=>"vendorsvendorref-get", "parameters"=>[{"in"=>"path", "name"=>"vendorRef", "description"=>"Ref of the vendor to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vendor", "Retrieval"]}, "put"=>{"summary"=>"Vendor update", "description"=>"Updates the vendor corresponding to the provided vendor ref, if that vendor is within authorized scopes.", "operationId"=>"updates-the-vendor-corresponding-to-the-provided-vendor-ref-if-that-vendor-is-within-authorized-scop", "x-api-path-slug"=>"vendorsvendorref-put", "parameters"=>[{"in"=>"body", "name"=>"vendor", "description"=>"Contents of the vendor to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"vendorRef", "description"=>"Ref of the vendor to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vendor", "Update"]}, "delete"=>{"summary"=>"Vendor deletion", "description"=>"Deletes the vendor corresponding to the provided vendor ref, if that vendor is within authorized scopes.", "operationId"=>"deletes-the-vendor-corresponding-to-the-provided-vendor-ref-if-that-vendor-is-within-authorized-scop", "x-api-path-slug"=>"vendorsvendorref-delete", "parameters"=>[{"in"=>"path", "name"=>"vendorRef", "description"=>"Ref of the vendor to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vendor", "Deletion"]}}, "/subscribers"=>{"get"=>{"summary"=>"Subscribers retrieval", "description"=>"Retrieves a list of subscribers existing within authorized scopes.", "operationId"=>"retrieves-a-list-of-subscribers-existing-within-authorized-scopes", "x-api-path-slug"=>"subscribers-get", "parameters"=>[{"in"=>"query", "name"=>"applicationId", "description"=>"Id of an application which has been subscribed by the searched subscribers"}, {"in"=>"query", "name"=>"contactEmail", "description"=>"Contact email of the subscriber to search for"}, {"in"=>"query", "name"=>"subscriberId", "description"=>"Id of the subscriber to search for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscribers", "Retrieval"]}, "post"=>{"summary"=>"Subscriber creation", "description"=>"Creates a new subscriber. If not fully specified, the subscriber name, contactEmail and organization attribute values are deduced from the primaryUser attribute values.", "operationId"=>"creates-a-new-subscriber-if-not-fully-specified-the-subscriber-name-contactemail-and-organization-at", "x-api-path-slug"=>"subscribers-post", "parameters"=>[{"in"=>"body", "name"=>"subscriber", "description"=>"Contents of the subscriber to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriber", "Creation"]}}, "/subscribers/{subscriberRef}"=>{"get"=>{"summary"=>"Subscriber retrieval", "description"=>"Retrieves the subscriber corresponding to the provided subscriber ref, if that subscriber is within authorized scopes.", "operationId"=>"retrieves-the-subscriber-corresponding-to-the-provided-subscriber-ref-if-that-subscriber-is-within-a", "x-api-path-slug"=>"subscriberssubscriberref-get", "parameters"=>[{"in"=>"path", "name"=>"subscriberRef", "description"=>"Ref of the subscriber to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriber", "Retrieval"]}, "put"=>{"summary"=>"Subscriber update", "description"=>"Updates the subscriber corresponding to the provided subscriber ref, if that subscriber is within authorized scopes.", "operationId"=>"updates-the-subscriber-corresponding-to-the-provided-subscriber-ref-if-that-subscriber-is-within-aut", "x-api-path-slug"=>"subscriberssubscriberref-put", "parameters"=>[{"in"=>"body", "name"=>"subscriber", "description"=>"Contents of the subscriber to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"subscriberRef", "description"=>"Ref of the subscriber to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriber", "Update"]}, "delete"=>{"summary"=>"Subscriber deletion", "description"=>"Deletes the subscriber corresponding to the provided subscriber ref, if that subscriber is within authorized scopes.", "operationId"=>"deletes-the-subscriber-corresponding-to-the-provided-subscriber-ref-if-that-subscriber-is-within-aut", "x-api-path-slug"=>"subscriberssubscriberref-delete", "parameters"=>[{"in"=>"query", "name"=>"force", "description"=>"If true, forces the deletion of all orders, devices and base stations attached to the subscriber, before deleting the subscriber"}, {"in"=>"path", "name"=>"subscriberRef", "description"=>"Ref of the subscriber to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriber", "Deletion"]}}, "/users"=>{"get"=>{"summary"=>"Users retrieval", "description"=>"Retrieves a list of users existing within authorized scopes.", "operationId"=>"retrieves-a-list-of-users-existing-within-authorized-scopes", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"Email of the user to search for"}, {"in"=>"query", "name"=>"userId", "description"=>"Id of the user to search for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Retrieval"]}, "post"=>{"summary"=>"User creation", "description"=>"Creates a new user. Enclosing party depends on authorized scopes.", "operationId"=>"creates-a-new-user-enclosing-party-depends-on-authorized-scopes", "x-api-path-slug"=>"users-post", "parameters"=>[{"in"=>"body", "name"=>"user", "description"=>"Contents of the user to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Creation"]}}, "/users/{userRef}"=>{"get"=>{"summary"=>"User retrieval", "description"=>"Retrieves the user corresponding to the provided user ref, if that user is within authorized scopes.", "operationId"=>"retrieves-the-user-corresponding-to-the-provided-user-ref-if-that-user-is-within-authorized-scopes", "x-api-path-slug"=>"usersuserref-get", "parameters"=>[{"in"=>"path", "name"=>"userRef", "description"=>"Ref of the user to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Retrieval"]}, "put"=>{"summary"=>"User update", "description"=>"Updates the user corresponding to the provided user ref, if that user is within authorized scopes.", "operationId"=>"updates-the-user-corresponding-to-the-provided-user-ref-if-that-user-is-within-authorized-scopes", "x-api-path-slug"=>"usersuserref-put", "parameters"=>[{"in"=>"query", "name"=>"resetPassword", "description"=>"Indicates if the user password must be resetted and a new password must be sent to the users current email"}, {"in"=>"body", "name"=>"user", "description"=>"Contents of the user to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userRef", "description"=>"Ref of the user to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Update"]}, "delete"=>{"summary"=>"User deletion", "description"=>"Deletes the user corresponding to the provided user ref, if that user is within authorized scopes.", "operationId"=>"deletes-the-user-corresponding-to-the-provided-user-ref-if-that-user-is-within-authorized-scopes", "x-api-path-slug"=>"usersuserref-delete", "parameters"=>[{"in"=>"path", "name"=>"userRef", "description"=>"Ref of the user to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Deletion"]}}, "/offers"=>{"get"=>{"summary"=>"Offers retrieval", "description"=>"Retrieves a list of offers existing within authorized scopes. In case of a vendor scope, it retrieves all offers of that vendor. In case of a subscriber scope, it retrieves all offers subscribed by that subscriber.", "operationId"=>"retrieves-a-list-of-offers-existing-within-authorized-scopes-in-case-of-a-vendor-scope-it-retrieves-", "x-api-path-slug"=>"offers-get", "parameters"=>[{"in"=>"query", "name"=>"offerId", "description"=>"Id of the offer to search for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offers", "Retrieval"]}, "post"=>{"summary"=>"Offers creation", "description"=>"Creates a new offer. if not specified, 'state' is automatically set to 'ACTIVE'. Note that the offer id MUST start with the vendor id followed by a slash (e.g. 'vendor-id/offer-id').", "operationId"=>"creates-a-new-offer-if-not-specified-state-is-automatically-set-to-active-note-that-the-offer-id-mus", "x-api-path-slug"=>"offers-post", "parameters"=>[{"in"=>"body", "name"=>"offer", "description"=>"Contents of the offer to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offers", "Creation"]}}, "/offers/{offerRef}"=>{"get"=>{"summary"=>"Offer retrieval", "description"=>"Retrieves the offer corresponding to the provided offer ref, if that offer is within authorized scopes.", "operationId"=>"retrieves-the-offer-corresponding-to-the-provided-offer-ref-if-that-offer-is-within-authorized-scope", "x-api-path-slug"=>"offersofferref-get", "parameters"=>[{"in"=>"path", "name"=>"offerRef", "description"=>"Ref of the offer to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offer", "Retrieval"]}, "put"=>{"summary"=>"Offer update", "description"=>"Updates the offer corresponding to the provided offer ref, if that offer is within authorized scopes. Only 'name' and 'state' attributes can be updated.", "operationId"=>"updates-the-offer-corresponding-to-the-provided-offer-ref-if-that-offer-is-within-authorized-scopes-", "x-api-path-slug"=>"offersofferref-put", "parameters"=>[{"in"=>"body", "name"=>"offer", "description"=>"Contents of the offer to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"offerRef", "description"=>"Ref of the offer to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offer", "Update"]}, "delete"=>{"summary"=>"Offer deletion", "description"=>"Deletes the offer corresponding to the provided offer ref, if that offer is within authorized scopes.", "operationId"=>"deletes-the-offer-corresponding-to-the-provided-offer-ref-if-that-offer-is-within-authorized-scopes", "x-api-path-slug"=>"offersofferref-delete", "parameters"=>[{"in"=>"path", "name"=>"offerRef", "description"=>"Ref of the offer to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offer", "Deletion"]}}, "/orders"=>{"get"=>{"summary"=>"Orders retrieval", "description"=>"Retrieves a list of orders existing within authorized scopes. In case of a vendor scope, it retrieves all orders allowed by that vendor. In case of a subscriber scope, it retrieves all orders performed by that subscriber.", "operationId"=>"retrieves-a-list-of-orders-existing-within-authorized-scopes-in-case-of-a-vendor-scope-it-retrieves-", "x-api-path-slug"=>"orders-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Retrieval"]}, "post"=>{"summary"=>"Order creation", "description"=>"Creates an order, i.e. creates a subscription to a predefined offer for an existing subscriber.", "operationId"=>"creates-an-order-ie-creates-a-subscription-to-a-predefined-offer-for-an-existing-subscriber", "x-api-path-slug"=>"orders-post", "parameters"=>[{"in"=>"body", "name"=>"order", "description"=>"Contents of the order to create", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"withProcessingStrategyId", "description"=>"Id of a pre-defined data processing strategy"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order", "Creation"]}}, "/orders/{orderRef}"=>{"get"=>{"summary"=>"Order retrieval", "description"=>"Retrieves the order corresponding to the provided order ref, if that order is within authorized scopes.", "operationId"=>"retrieves-the-order-corresponding-to-the-provided-order-ref-if-that-order-is-within-authorized-scope", "x-api-path-slug"=>"ordersorderref-get", "parameters"=>[{"in"=>"path", "name"=>"orderRef", "description"=>"Ref of the order to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order", "Retrieval"]}, "delete"=>{"summary"=>"Order cancellation", "description"=>"Cancels all subscriptions related to the provided order ref, if that order is within authorized scopes.", "operationId"=>"cancels-all-subscriptions-related-to-the-provided-order-ref-if-that-order-is-within-authorized-scope", "x-api-path-slug"=>"ordersorderref-delete", "parameters"=>[{"in"=>"path", "name"=>"orderRef", "description"=>"Ref of the order to cancel"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order", "Cancellation"]}}, "/applications"=>{"get"=>{"summary"=>"Applications retrieval", "description"=>"Retrieves a list of applications existing within authorized scopes. In case of an operator or a vendor scope, it retrieves all applications available. In case of a subscriber scope, it retrieves all applications within subscribed offers. In case of a supplier scope, it retrieves all applications provided by that supplier.", "operationId"=>"retrieves-a-list-of-applications-existing-within-authorized-scopes-in-case-of-an-operator-or-a-vendo", "x-api-path-slug"=>"applications-get", "parameters"=>[{"in"=>"query", "name"=>"applicationId", "description"=>"Id of the application to search for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications", "Retrieval"]}}, "/accessCodes"=>{"post"=>{"summary"=>"Access code generation", "description"=>"Generates a new access code. If it is of type 'userAccessCode', the provided userId must reference an user within authorized scopes. This access code can then be used to access the targetted application without re-typing credentials (ThingPark SSO). In order to do so, the code needs to be appended to the application portal URL, i.e. 'portalUrl?userAccessCode=code'.", "operationId"=>"generates-a-new-access-code-if-it-is-of-type-useraccesscode-the-provided-userid-must-reference-an-us", "x-api-path-slug"=>"accesscodes-post", "parameters"=>[{"in"=>"body", "name"=>"accessCode", "description"=>"Information about the access code to generate", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Access", "Code", "Generation"]}, "get"=>{"summary"=>"Access code validation", "description"=>"Validates the access code value and retrieves extended access code information such as user information.", "operationId"=>"validates-the-access-code-value-and-retrieves-extended-access-code-information-such-as-user-informat", "x-api-path-slug"=>"accesscodes-get", "parameters"=>[{"in"=>"query", "name"=>"applicationId", "description"=>"Id of the application targetted by the access code to validate"}, {"in"=>"query", "name"=>"applicationRef", "description"=>"Ref of the application targetted by the access code to validate"}, {"in"=>"query", "name"=>"type", "description"=>"Type of the access code to validate"}, {"in"=>"query", "name"=>"value", "description"=>"Value of the access code to validate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Access", "Code", "Validation"]}}, "/devices"=>{"get"=>{"summary"=>"Devices retrieval", "description"=>"Retrieves a list of devices existing within authorized scopes. Note that for each device, by default only the following information is retrieved: 'ref', 'name', 'EUI', 'networkAddress'.", "operationId"=>"retrieves-a-list-of-devices-existing-within-authorized-scopes-note-that-for-each-device-by-default-o", "x-api-path-slug"=>"devices-get", "parameters"=>[{"in"=>"query", "name"=>"commercialDetails", "description"=>"Indicates to also retrieve commercial information along each device"}, {"in"=>"query", "name"=>"connectivityPlanId", "description"=>"Connectivity plan assigned to the devices to search for"}, {"in"=>"query", "name"=>"deviceEUI", "description"=>"EUI of the device to search for"}, {"in"=>"query", "name"=>"deviceToken", "description"=>"Token provided by the manufacturer for an easy registration on a standalone Join Server"}, {"in"=>"query", "name"=>"extendedInfo", "description"=>"Indicates to retrieve all available information (including statistics and commercial details) along each device"}, {"in"=>"query", "name"=>"healthState", "description"=>"Health state of the devices to search for"}, {"in"=>"query", "name"=>"pageIndex", "description"=>"If set, enables pagination and returns only the 100 devices of the specified page"}, {"in"=>"query", "name"=>"statistics", "description"=>"Indicates to also retrieve usage statistic information along each device"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices", "Retrieval"]}, "post"=>{"summary"=>"Device creation", "description"=>"Creates a new device. If no 'routingProfileId' or 'processingStrategyId' values are provided, then 'processingStrategyId' will be automatically set to 'DATAFLOW'. If no 'connectivityPlanId' value is provided, then the first connectivity plan of the subscriber with available connections will be assigned to the device.", "operationId"=>"creates-a-new-device-if-no-routingprofileid-or-processingstrategyid-values-are-provided-then-process", "x-api-path-slug"=>"devices-post", "parameters"=>[{"in"=>"body", "name"=>"device", "description"=>"Contents of the device to create", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"deviceToken", "description"=>"Token provided by the manufacturer for an easy registration on a standalone Join Server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Creation"]}}, "/devices/{deviceRef}"=>{"get"=>{"summary"=>"Device retrieval", "description"=>"Retrieves the device corresponding to the provided device ref, if that device is within authorized scopes.", "operationId"=>"retrieves-the-device-corresponding-to-the-provided-device-ref-if-that-device-is-within-authorized-sc", "x-api-path-slug"=>"devicesdeviceref-get", "parameters"=>[{"in"=>"path", "name"=>"deviceRef", "description"=>"Ref of the device to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Retrieval"]}, "put"=>{"summary"=>"Device update", "description"=>"Updates the device corresponding to the provided device ref, if that device is within authorized scopes. Only following attributes can be updated: 'name', 'routingProfileId', 'processingStrategyId', 'connectivityPlanId', 'deviceProfileId' and 'applicationEUI'. To update other attributes, device must be deleted than re-created.", "operationId"=>"updates-the-device-corresponding-to-the-provided-device-ref-if-that-device-is-within-authorized-scop", "x-api-path-slug"=>"devicesdeviceref-put", "parameters"=>[{"in"=>"body", "name"=>"device", "description"=>"Contents of the device to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"deviceRef", "description"=>"Ref of the device to update"}, {"in"=>"query", "name"=>"deviceToken", "description"=>"Token provided by the manufacturer for an easy registration on a standalone Join Server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Update"]}, "delete"=>{"summary"=>"Device deletion", "description"=>"Deletes the device corresponding to the provided device ref, if that device is within authorized scopes.", "operationId"=>"deletes-the-device-corresponding-to-the-provided-device-ref-if-that-device-is-within-authorized-scop", "x-api-path-slug"=>"devicesdeviceref-delete", "parameters"=>[{"in"=>"path", "name"=>"deviceRef", "description"=>"Ref of the device to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Deletion"]}}, "/deviceProfiles"=>{"get"=>{"summary"=>"Device profiles retrieval", "description"=>"Retrieves the list of existing device profiles.", "operationId"=>"retrieves-the-list-of-existing-device-profiles", "x-api-path-slug"=>"deviceprofiles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Profiles", "Retrieval"]}}, "/connectivityPlans"=>{"get"=>{"summary"=>"Connectivity plans retrieval", "description"=>"Retrieves a list of connectivity plans existing within authorized scopes.", "operationId"=>"retrieves-a-list-of-connectivity-plans-existing-within-authorized-scopes", "x-api-path-slug"=>"connectivityplans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connectivity", "Plans", "Retrieval"]}}, "/routingProfiles"=>{"get"=>{"summary"=>"Routing profiles retrieval", "description"=>"Retrieves a list of existing routing profiles within authorized scopes.", "operationId"=>"retrieves-a-list-of-existing-routing-profiles-within-authorized-scopes", "x-api-path-slug"=>"routingprofiles-get", "parameters"=>[{"in"=>"query", "name"=>"routingProfileId", "description"=>"Id of the routing profile to search for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Routing", "Profiles", "Retrieval"]}, "post"=>{"summary"=>"Routing profiles creation", "description"=>"Creates a new routing profile.", "operationId"=>"creates-a-new-routing-profile", "x-api-path-slug"=>"routingprofiles-post", "parameters"=>[{"in"=>"body", "name"=>"routingProfile", "description"=>"Contents of the routing profile to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Routing", "Profiles", "Creation"]}}, "/routingProfiles/{routingProfileRef}"=>{"get"=>{"summary"=>"Routing profile retrieval", "description"=>"Retrieves the routing profile corresponding to the provided routing profile ref, if that routing profile is within authorized scopes.", "operationId"=>"retrieves-the-routing-profile-corresponding-to-the-provided-routing-profile-ref-if-that-routing-prof", "x-api-path-slug"=>"routingprofilesroutingprofileref-get", "parameters"=>[{"in"=>"path", "name"=>"routingProfileRef", "description"=>"Ref of the routing profile to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Routing", "Profile", "Retrieval"]}, "put"=>{"summary"=>"Routing profile update", "description"=>"Updates the routing profile corresponding to the provided routing profile ref, if that routing profile is within authorized scopes. Note that the 'default' attribute can only be updated from 'false' to 'true' (thus updating 'default' attribute for the previous default routing profile from 'true' to 'false').", "operationId"=>"updates-the-routing-profile-corresponding-to-the-provided-routing-profile-ref-if-that-routing-profil", "x-api-path-slug"=>"routingprofilesroutingprofileref-put", "parameters"=>[{"in"=>"body", "name"=>"routingProfile", "description"=>"Contents of the routing profile to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"routingProfileRef", "description"=>"Ref of the routing profile to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Routing", "Profile", "Update"]}, "delete"=>{"summary"=>"Routing profile deletion", "description"=>"Deletes the routing profile corresponding to the provided routing profile ref, if that routing profile is within authorized scopes.", "operationId"=>"deletes-the-routing-profile-corresponding-to-the-provided-routing-profile-ref-if-that-routing-profil", "x-api-path-slug"=>"routingprofilesroutingprofileref-delete", "parameters"=>[{"in"=>"path", "name"=>"routingProfileRef", "description"=>"Ref of the routing profile to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Routing", "Profile", "Deletion"]}}, "/deviceFrameStatistics"=>{"get"=>{"summary"=>"Frame statistics retrieval", "description"=>"Retrieves frame statistics of the devices corresponding to the provided parameters, if those devices are within authorized scopes.", "operationId"=>"retrieves-frame-statistics-of-the-devices-corresponding-to-the-provided-parameters-if-those-devices-", "x-api-path-slug"=>"deviceframestatistics-get", "parameters"=>[{"in"=>"query", "name"=>"aggregationStep", "description"=>"Number of hours (between 1 and 24) used for aggregating the frame statistics"}, {"in"=>"query", "name"=>"baseStationId", "description"=>"Id of the base station which received the frame"}, {"in"=>"query", "name"=>"deviceEUIList", "description"=>"List of device EUIs for which device statistics should be retrieved"}, {"in"=>"query", "name"=>"duration", "description"=>"Period (number of days) for which frame statistics should be retrieved"}, {"in"=>"query", "name"=>"startDate", "description"=>"Start date in ISO 8601 format of the period for which frame statistics should be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Frame", "Statistics", "Retrieval"]}}, "/deviceHealthStatistics"=>{"get"=>{"summary"=>"Health statistics retrieval", "description"=>"Retrieves health statistics for all devices within authorized scopes.", "operationId"=>"retrieves-health-statistics-for-all-devices-within-authorized-scopes", "x-api-path-slug"=>"devicehealthstatistics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Health", "Statistics", "Retrieval"]}}, "/asKeys"=>{"get"=>{"summary"=>"AS key retrieval", "description"=>"Retrieves a list of AS keys existing within authorized scopes.", "operationId"=>"retrieves-a-list-of-as-keys-existing-within-authorized-scopes", "x-api-path-slug"=>"askeys-get", "parameters"=>[{"in"=>"query", "name"=>"deviceToken", "description"=>"Token provided by the manufacturer for operations on a standalone Join Server"}, {"in"=>"query", "name"=>"pageIndex", "description"=>"If set, enables pagination and returns only the 100 AS keys of the specified page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AS", "Key", "Retrieval"]}, "post"=>{"summary"=>"AS key creation", "description"=>"Creates a new AS key.", "operationId"=>"creates-a-new-as-key", "x-api-path-slug"=>"askeys-post", "parameters"=>[{"in"=>"body", "name"=>"asKey", "description"=>"Contents of the AS key to create", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"deviceToken", "description"=>"Token provided by the manufacturer for an easy registration on a standalone Join Server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AS", "Key", "Creation"]}}, "/asKeys/{asKeyRef}"=>{"get"=>{"summary"=>"AS key retrieval", "description"=>"Retrieves the AS key corresponding to the provided AS key ref, if that AS key is within authorized scopes.", "operationId"=>"retrieves-the-as-key-corresponding-to-the-provided-as-key-ref-if-that-as-key-is-within-authorized-sc", "x-api-path-slug"=>"askeysaskeyref-get", "parameters"=>[{"in"=>"path", "name"=>"asKeyRef", "description"=>"Ref of the AS key to retrieve"}, {"in"=>"query", "name"=>"deviceToken", "description"=>"Token provided by the manufacturer for operations on a standalone Join Server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AS", "Key", "Retrieval"]}, "put"=>{"summary"=>"AS key update", "description"=>"Updates the AS key corresponding to the provided asKey ref, if that AS key is within authorized scopes.", "operationId"=>"updates-the-as-key-corresponding-to-the-provided-askey-ref-if-that-as-key-is-within-authorized-scope", "x-api-path-slug"=>"askeysaskeyref-put", "parameters"=>[{"in"=>"body", "name"=>"asKey", "description"=>"Contents of the AS key to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"asKeyRef", "description"=>"Ref of the AS key to update"}, {"in"=>"query", "name"=>"deviceToken", "description"=>"Token provided by the manufacturer for operations on a standalone Join Server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AS", "Key", "Update"]}, "delete"=>{"summary"=>"AS key deletion", "description"=>"Deletes the AS key corresponding to the provided asKeyRef, if that AS key is within authorized scopes.", "operationId"=>"deletes-the-as-key-corresponding-to-the-provided-askeyref-if-that-as-key-is-within-authorized-scopes", "x-api-path-slug"=>"askeysaskeyref-delete", "parameters"=>[{"in"=>"path", "name"=>"asKeyRef", "description"=>"Ref of the AS key to delete"}, {"in"=>"query", "name"=>"deviceToken", "description"=>"Token provided by the manufacturer for operations on a standalone Join Server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AS", "Key", "Deletion"]}}, "/hsmGroups"=>{"get"=>{"summary"=>"HSM groups retrieval", "description"=>"Retrieves a list of HSM groups existing within authorized scopes.", "operationId"=>"retrieves-a-list-of-hsm-groups-existing-within-authorized-scopes", "x-api-path-slug"=>"hsmgroups-get", "parameters"=>[{"in"=>"query", "name"=>"deviceToken", "description"=>"Token provided by the manufacturer for operations on a standalone Join Server"}, {"in"=>"query", "name"=>"pageIndex", "description"=>"If set, enables pagination and returns only the 100 HSM groups of the specified page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["HSM", "Groups", "Retrieval"]}}, "/baseStations"=>{"get"=>{"summary"=>"Base stations retrieval", "description"=>"Retrieves a list of base stations existing within authorized scopes. Note that in case of an OPERATOR scope, only supplier-owned base stations are returned.", "operationId"=>"retrieves-a-list-of-base-stations-existing-within-authorized-scopes-note-that-in-case-of-an-operator", "x-api-path-slug"=>"basestations-get", "parameters"=>[{"in"=>"query", "name"=>"baseStationId", "description"=>"Id of the base station to search for"}, {"in"=>"query", "name"=>"commercialDetails", "description"=>"Indicates to also retrieve commercial information along each base station"}, {"in"=>"query", "name"=>"connectionState", "description"=>"Connection state of the base stations to search for"}, {"in"=>"query", "name"=>"healthState", "description"=>"Health state of the base stations to search for"}, {"in"=>"query", "name"=>"pageIndex", "description"=>"If set, enables pagination and returns only the 100 base stations in the specified page"}, {"in"=>"query", "name"=>"statistics", "description"=>"Indicates to also retrieve usage statistic information along each base station"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Base", "Stations", "Retrieval"]}, "post"=>{"summary"=>"Base stations creation", "description"=>"Creates a new base station.", "operationId"=>"creates-a-new-base-station", "x-api-path-slug"=>"basestations-post", "parameters"=>[{"in"=>"body", "name"=>"baseStation", "description"=>"Contents of the base station to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Base", "Stations", "Creation"]}}, "/baseStations/{baseStationRef}"=>{"get"=>{"summary"=>"Base station retrieval", "description"=>"Retrieves the base station corresponding to the provided base station ref, if that base station is within authorized scopes.", "operationId"=>"retrieves-the-base-station-corresponding-to-the-provided-base-station-ref-if-that-base-station-is-wi", "x-api-path-slug"=>"basestationsbasestationref-get", "parameters"=>[{"in"=>"path", "name"=>"baseStationRef", "description"=>"Ref of the base station to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Base", "Station", "Retrieval"]}, "put"=>{"summary"=>"Base station update", "description"=>"Updates the base station corresponding to the provided base station ref, if that base station is within authorized scopes.", "operationId"=>"updates-the-base-station-corresponding-to-the-provided-base-station-ref-if-that-base-station-is-with", "x-api-path-slug"=>"basestationsbasestationref-put", "parameters"=>[{"in"=>"body", "name"=>"baseStation", "description"=>"Contents of the base station to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"baseStationRef", "description"=>"Ref of the base station to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Base", "Station", "Update"]}, "delete"=>{"summary"=>"Base station deletion", "description"=>"Deletes the base station corresponding to the provided base station ref, if that base station is within authorized scopes.", "operationId"=>"deletes-the-base-station-corresponding-to-the-provided-base-station-ref-if-that-base-station-is-with", "x-api-path-slug"=>"basestationsbasestationref-delete", "parameters"=>[{"in"=>"path", "name"=>"baseStationRef", "description"=>"Ref of the base station to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Base", "Station", "Deletion"]}}, "/baseStationProfiles"=>{"get"=>{"summary"=>"Base station profiles retrieval", "description"=>"Retrieves the list of existing base station profiles.", "operationId"=>"retrieves-the-list-of-existing-base-station-profiles", "x-api-path-slug"=>"basestationprofiles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Base", "Station", "Profiles", "Retrieval"]}}, "/baseStationFrameStatistics"=>{"get"=>{"summary"=>"Frame statistics retrieval", "description"=>"Retrieves frame statistics of the base stations corresponding to the provided parameters, if those base stations are within authorized scopes.", "operationId"=>"retrieves-frame-statistics-of-the-base-stations-corresponding-to-the-provided-parameters-if-those-ba", "x-api-path-slug"=>"basestationframestatistics-get", "parameters"=>[{"in"=>"query", "name"=>"aggregationStep", "description"=>"Number of hours (between 1 and 24) used for aggregating the frame statistics"}, {"in"=>"query", "name"=>"baseStationId", "description"=>"Id of the base station for which frame statistics should be retrieved"}, {"in"=>"query", "name"=>"duration", "description"=>"Period (number of days) for which frame statistics should be retrieved"}, {"in"=>"query", "name"=>"startDate", "description"=>"Start date in ISO 8601 format of the period for which frame statistics should be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Frame", "Statistics", "Retrieval"]}}, "/baseStationHealthStatistics"=>{"get"=>{"summary"=>"Health statistics retrieval", "description"=>"Retrieves health statistics for all base stations within authorized scopes.", "operationId"=>"retrieves-health-statistics-for-all-base-stations-within-authorized-scopes", "x-api-path-slug"=>"basestationhealthstatistics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Health", "Statistics", "Retrieval"]}}, "/baseStations/{baseStationRef}/channels/{channelName}/signalStatistics"=>{"get"=>{"summary"=>"Signal statistics retrieval", "description"=>"Retrieves signal statistics (RSSI and SNR metrics) for a specific channel of the base station corresponding to the provided base station ref, if that base station is within authorized scopes.", "operationId"=>"retrieves-signal-statistics-rssi-and-snr-metrics-for-a-specific-channel-of-the-base-station-correspo", "x-api-path-slug"=>"basestationsbasestationrefchannelschannelnamesignalstatistics-get", "parameters"=>[{"in"=>"path", "name"=>"baseStationRef", "description"=>"Ref of the base station for which signal statistics should be retrieved"}, {"in"=>"path", "name"=>"channelName", "description"=>"Name of the channel for which signal statistics should be retrieved"}, {"in"=>"query", "name"=>"duration", "description"=>"Period (number of hours) for which signal statistics should be retrieved"}, {"in"=>"query", "name"=>"startDate", "description"=>"Start date in ISO 8601 format of the period for which signal statistics should be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signal", "Statistics", "Retrieval"]}}, "/baseStations/{baseStationRef}/channels/{channelName}/dutyCycleStatistics"=>{"get"=>{"summary"=>"Duty cycle statistics retrieval", "description"=>"Retrieves duty cycle statistics for a specific channel of the base station corresponding to the provided base station ref, if that base station is within authorized scopes.", "operationId"=>"retrieves-duty-cycle-statistics-for-a-specific-channel-of-the-base-station-corresponding-to-the-prov", "x-api-path-slug"=>"basestationsbasestationrefchannelschannelnamedutycyclestatistics-get", "parameters"=>[{"in"=>"query", "name"=>"aggregationStep", "description"=>"Number of hours (between 1 and 24) used for aggregating the duty cycle statistics"}, {"in"=>"path", "name"=>"baseStationRef", "description"=>"Ref of the base station for which duty cycle statistics should be retrieved"}, {"in"=>"path", "name"=>"channelName", "description"=>"Name of the channel for which duty cycle statistics should be retrieved"}, {"in"=>"query", "name"=>"duration", "description"=>"Period (number of days between 1 and 7) for which duty cycle statistics should be retrieved"}, {"in"=>"query", "name"=>"startDate", "description"=>"Start date in ISO 8601 format of the period for which duty cycle statistics should be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Duty", "Cycle", "Statistics", "Retrieval"]}}, "/baseStations/{baseStationRef}/lrcPacketStatistics"=>{"get"=>{"summary"=>"LRC packet statistics retrieval", "description"=>"Retrieves packets statistics between the LRC and the base station corresponding to the provided base station ref, if that base station is within authorized scopes.", "operationId"=>"retrieves-packets-statistics-between-the-lrc-and-the-base-station-corresponding-to-the-provided-base", "x-api-path-slug"=>"basestationsbasestationreflrcpacketstatistics-get", "parameters"=>[{"in"=>"query", "name"=>"aggregationStep", "description"=>"Number of hours (between 1 and 24) used for aggregating the LRC packet statistics"}, {"in"=>"path", "name"=>"baseStationRef", "description"=>"Ref of the base station for which LRC packet statistics should be retrieved"}, {"in"=>"query", "name"=>"duration", "description"=>"Period (number of days) for which LRC packet statistics should be retrieved"}, {"in"=>"query", "name"=>"startDate", "description"=>"Start date in ISO 8601 format of the period for which LRC packet statistics should be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["LRC", "Packet", "Statistics", "Retrieval"]}}, "/ismBands"=>{"get"=>{"summary"=>"ISM Bands retrieval", "description"=>"Retrieves a list of ISM Bands existing within authorized scopes.", "operationId"=>"retrieves-a-list-of-ism-bands-existing-within-authorized-scopes", "x-api-path-slug"=>"ismbands-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ISM", "Bands", "Retrieval"]}}, "/deviceAlarms"=>{"get"=>{"summary"=>"Device alarms retrieval", "description"=>"Retrieves a list of device alarms existing within authorized scopes.", "operationId"=>"retrieves-a-list-of-device-alarms-existing-within-authorized-scopes", "x-api-path-slug"=>"devicealarms-get", "parameters"=>[{"in"=>"query", "name"=>"deviceEUI", "description"=>"EUI of the device to search alarms for"}, {"in"=>"query", "name"=>"pageIndex", "description"=>"If set, enables pagination and returns only the 100 device alarms of the specified page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Alarms", "Retrieval"]}}, "/deviceAlarms/{deviceAlarmRef}"=>{"get"=>{"summary"=>"Device alarm retrieval", "description"=>"Retrieves the device alarm corresponding to the provided device alarm ref, if that device alarm is within authorized scopes.", "operationId"=>"retrieves-the-device-alarm-corresponding-to-the-provided-device-alarm-ref-if-that-device-alarm-is-wi", "x-api-path-slug"=>"devicealarmsdevicealarmref-get", "parameters"=>[{"in"=>"path", "name"=>"deviceAlarmRef", "description"=>"Ref of the device alarm to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Alarm", "Retrieval"]}}, "/deviceAlarms/{deviceAlarmRef}/acks"=>{"post"=>{"summary"=>"Device alarm acknowledgement", "description"=>"Acknowledges a device alarm.", "operationId"=>"acknowledges-a-device-alarm", "x-api-path-slug"=>"devicealarmsdevicealarmrefacks-post", "parameters"=>[{"in"=>"path", "name"=>"deviceAlarmRef", "description"=>"Ref of the device alarm to acknowledge"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device", "Alarm", "Acknowledgement"]}}, "/baseStationAlarms"=>{"get"=>{"summary"=>"Base station alarms retrieval", "description"=>"Retrieves a list of base station alarms existing within authorized scopes. Note that in case of an OPERATOR scope, only supplier-owned base station alarms are returned.", "operationId"=>"retrieves-a-list-of-base-station-alarms-existing-within-authorized-scopes-note-that-in-case-of-an-op", "x-api-path-slug"=>"basestationalarms-get", "parameters"=>[{"in"=>"query", "name"=>"baseStationId", "description"=>"Id of the base station to search alarms for"}, {"in"=>"query", "name"=>"pageIndex", "description"=>"If set, enables pagination and returns only the 100 base station alarms of the specified page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Base", "Station", "Alarms", "Retrieval"]}}, "/baseStationAlarms/{baseStationAlarmRef}"=>{"get"=>{"summary"=>"Base station alarm retrieval", "description"=>"Retrieves the base station alarm corresponding to the provided base station alarm ref, if that base station alarm is within authorized scopes.", "operationId"=>"retrieves-the-base-station-alarm-corresponding-to-the-provided-base-station-alarm-ref-if-that-base-s", "x-api-path-slug"=>"basestationalarmsbasestationalarmref-get", "parameters"=>[{"in"=>"path", "name"=>"baseStationAlarmRef", "description"=>"Ref of the base station alarm to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Base", "Station", "Alarm", "Retrieval"]}}, "/baseStationAlarms/{baseStationAlarmRef}/acks"=>{"post"=>{"summary"=>"Base station alarm acknowledgement", "description"=>"Acknowledges a base station alarm.", "operationId"=>"acknowledges-a-base-station-alarm", "x-api-path-slug"=>"basestationalarmsbasestationalarmrefacks-post", "parameters"=>[{"in"=>"path", "name"=>"baseStationAlarmRef", "description"=>"Ref of the base station alarm to acknowledge"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Base", "Station", "Alarm", "Acknowledgement"]}}, "/devices/{device}/downlinkMessages"=>{"post"=>{"summary"=>"Downlink message sending", "description"=>"Sends a new downlink message to the device, if that device is within authorized scopes. The message is queued in the LRC until the device is able to retrieve it (depending on its configured class).", "operationId"=>"sends-a-new-downlink-message-to-the-device-if-that-device-is-within-authorized-scopes-the-message-is", "x-api-path-slug"=>"devicesdevicedownlinkmessages-post", "parameters"=>[{"in"=>"query", "name"=>"confirmDownlink", "description"=>"Indicates to send a downlink reception confirmation"}, {"in"=>"path", "name"=>"device", "description"=>"Ref or DevEUI of the device to which the downlink message should be sent"}, {"in"=>"query", "name"=>"flushDownlinkQueue", "description"=>"Indicates to flush the LRC downlink queue before adding the new message to the queue"}, {"in"=>"body", "name"=>"message", "description"=>"Contents of the downlink message to send", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Downlink", "Message", "Sending"]}}}}, "thingpark-dx-maker-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Actility", "x-complete"=>1, "info"=>{"title"=>"ThingPark DX Maker API", "description"=>"api-providing-features-for-device-makers-such-as-preprovisioning-on-standalone-join-servers-", "version"=>"1.0.0"}, "host"=>"dx-api.thingpark.com", "basePath"=>"/maker/v011/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/factoryDevices"=>{"get"=>{"summary"=>"Factory devices retrieval", "description"=>"Retrieves all factory devices.", "operationId"=>"retrieves-all-factory-devices", "x-api-path-slug"=>"factorydevices-get", "parameters"=>[{"in"=>"query", "name"=>"deviceEUI", "description"=>"EUI of the factory device to retrieve"}, {"in"=>"query", "name"=>"pageIndex", "description"=>"If set, enables pagination and returns only the 100 factory devices of the specified page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Factory", "Devices", "Retrieval"]}, "post"=>{"summary"=>"Factory device creation", "description"=>"Creates a factory device.", "operationId"=>"creates-a-factory-device", "x-api-path-slug"=>"factorydevices-post", "parameters"=>[{"in"=>"body", "name"=>"deviceFactory", "description"=>"Contents of the factory device", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Factory", "Device", "Creation"]}}, "/factoryDevices/{factoryDeviceRef}"=>{"get"=>{"summary"=>"Factory device retrieval", "description"=>"Retrieves the factory device corresponding to the provided factoryDeviceRef.", "operationId"=>"retrieves-the-factory-device-corresponding-to-the-provided-factorydeviceref", "x-api-path-slug"=>"factorydevicesfactorydeviceref-get", "parameters"=>[{"in"=>"path", "name"=>"factoryDeviceRef", "description"=>"Ref of the factory device to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Factory", "Device", "Retrieval"]}, "put"=>{"summary"=>"Factory device update", "description"=>"Updates the factory device corresponding to the provided factoryDeviceRef.", "operationId"=>"updates-the-factory-device-corresponding-to-the-provided-factorydeviceref", "x-api-path-slug"=>"factorydevicesfactorydeviceref-put", "parameters"=>[{"in"=>"body", "name"=>"device", "description"=>"Contents of the factory device to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"factoryDeviceRef", "description"=>"Ref of the factory device to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Factory", "Device", "Update"]}, "delete"=>{"summary"=>"Factory device deletion", "description"=>"Deletes the factory device corresponding to the provided factoryDeviceRef.", "operationId"=>"deletes-the-factory-device-corresponding-to-the-provided-factorydeviceref", "x-api-path-slug"=>"factorydevicesfactorydeviceref-delete", "parameters"=>[{"in"=>"path", "name"=>"factoryDeviceRef", "description"=>"Ref of the factory device to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Factory", "Device", "Deletion"]}}, "/appKeyGens"=>{"post"=>{"summary"=>"AppKey generation", "description"=>"Generate some encrypted VendorKeys with an HSM. Encrypted VendorKeys can be decrypted with the private part of provided RSA key. A VendorKey is a concatenation of an AppKey (128 bits) and hsmEncryptedAppKey (128 bits).", "operationId"=>"generate-some-encrypted-vendorkeys-with-an-hsm-encrypted-vendorkeys-can-be-decrypted-with-the-privat", "x-api-path-slug"=>"appkeygens-post", "parameters"=>[{"in"=>"body", "name"=>"appKeyGen", "description"=>"Configuration for AppKey generation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"number", "description"=>"Define the number of AppKey generated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AppKey", "Generation"]}}, "/asKeys"=>{"get"=>{"summary"=>"AS keys retrieval", "description"=>"Retrieves the list of AS keys existing within authorized scopes.", "operationId"=>"retrieves-the-list-of-as-keys-existing-within-authorized-scopes", "x-api-path-slug"=>"askeys-get", "parameters"=>[{"in"=>"query", "name"=>"pageIndex", "description"=>"If set, enables pagination and returns only the 100 AS keys of the specified page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AS", "Keys", "Retrieval"]}, "post"=>{"summary"=>"AS key creation", "description"=>"Creates a new AS key.", "operationId"=>"creates-a-new-as-key", "x-api-path-slug"=>"askeys-post", "parameters"=>[{"in"=>"body", "name"=>"asKey", "description"=>"Contents of the AS key to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AS", "Key", "Creation"]}}, "/asKeys/{asKeyRef}"=>{"get"=>{"summary"=>"AS key retrieval", "description"=>"Retrieves the AS key corresponding to the provided AS key ref, if that AS key is within authorized scopes.", "operationId"=>"retrieves-the-as-key-corresponding-to-the-provided-as-key-ref-if-that-as-key-is-within-authorized-sc", "x-api-path-slug"=>"askeysaskeyref-get", "parameters"=>[{"in"=>"path", "name"=>"asKeyRef", "description"=>"Ref of the AS key to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AS", "Key", "Retrieval"]}, "put"=>{"summary"=>"AS key update", "description"=>"Updates the AS key corresponding to the provided asKey ref, if that AS key is within authorized scopes.", "operationId"=>"updates-the-as-key-corresponding-to-the-provided-askey-ref-if-that-as-key-is-within-authorized-scope", "x-api-path-slug"=>"askeysaskeyref-put", "parameters"=>[{"in"=>"body", "name"=>"asKey", "description"=>"Contents of the AS key to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"asKeyRef", "description"=>"Ref of the AS key to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AS", "Key", "Update"]}, "delete"=>{"summary"=>"AS key deletion", "description"=>"Deletes the AS key corresponding to the provided asKeyRef, if that AS key is within authorized scopes.", "operationId"=>"deletes-the-as-key-corresponding-to-the-provided-askeyref-if-that-as-key-is-within-authorized-scopes", "x-api-path-slug"=>"askeysaskeyref-delete", "parameters"=>[{"in"=>"path", "name"=>"asKeyRef", "description"=>"Ref of the AS key to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AS", "Key", "Deletion"]}}, "/hsmGroups"=>{"get"=>{"summary"=>"HSM groups retrieval", "description"=>"Retrieves all HSM groups.", "operationId"=>"retrieves-all-hsm-groups", "x-api-path-slug"=>"hsmgroups-get", "parameters"=>[{"in"=>"query", "name"=>"pageIndex", "description"=>"If set, enables pagination and returns only the 100 HSM groups of the specified page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["HSM", "Groups", "Retrieval"]}}}}, "thingpark-dx-location-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Actility", "x-complete"=>1, "info"=>{"title"=>"ThingPark DX Location API", "description"=>"api-providing-feed-configuration-and-query-capabilities-on-top-of-the-thingpark-location-solution-", "version"=>"1.0.0"}, "host"=>"dx-api.thingpark.com", "basePath"=>"/location/v110", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/feeds"=>{"post"=>{"summary"=>"Feed request", "description"=>"Feeds the platform with geolocation data. Data is then dispatched and processed based on available information.", "operationId"=>"feeds-the-platform-with-geolocation-data-data-is-then-dispatched-and-processed-based-on-available-in", "x-api-path-slug"=>"feeds-post", "parameters"=>[{"in"=>"body", "name"=>"feedRequest", "description"=>"Contents of the feed request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Feed", "Request"]}}, "/moduleConfigs"=>{"get"=>{"summary"=>"Module configurations retrieval", "description"=>"Retrieves the list of existing module configurations.", "operationId"=>"retrieves-the-list-of-existing-module-configurations", "x-api-path-slug"=>"moduleconfigs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Module", "Configurations", "Retrieval"]}, "post"=>{"summary"=>"Module configuration creation", "description"=>"Creates a new module configuration.", "operationId"=>"creates-a-new-module-configuration", "x-api-path-slug"=>"moduleconfigs-post", "parameters"=>[{"in"=>"body", "name"=>"moduleConfig", "description"=>"Contents of the module configuration to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Module", "Configuration", "Creation"]}}, "/moduleConfigs/{moduleConfigRef}"=>{"get"=>{"summary"=>"Module configuration retrieval", "description"=>"Retrieves the module configuration corresponding to the provided ref.", "operationId"=>"retrieves-the-module-configuration-corresponding-to-the-provided-ref", "x-api-path-slug"=>"moduleconfigsmoduleconfigref-get", "parameters"=>[{"in"=>"path", "name"=>"moduleConfigRef", "description"=>"Ref of the module configuration to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Module", "Configuration", "Retrieval"]}, "put"=>{"summary"=>"Module configuration update", "description"=>"Updates the module configuration corresponding to the provided ref.", "operationId"=>"updates-the-module-configuration-corresponding-to-the-provided-ref", "x-api-path-slug"=>"moduleconfigsmoduleconfigref-put", "parameters"=>[{"in"=>"body", "name"=>"moduleConfig", "description"=>"Contents of the module configuration to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"moduleConfigRef", "description"=>"Ref of the module configuration to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Module", "Configuration", "Update"]}, "delete"=>{"summary"=>"Module configuration deletion", "description"=>"Deletes the module configuration corresponding to the provided ref.", "operationId"=>"deletes-the-module-configuration-corresponding-to-the-provided-ref", "x-api-path-slug"=>"moduleconfigsmoduleconfigref-delete", "parameters"=>[{"in"=>"path", "name"=>"moduleConfigRef", "description"=>"Ref of the module configuration to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Module", "Configuration", "Deletion"]}}, "/trackerCommands"=>{"post"=>{"summary"=>"Tracker command sending", "description"=>"Sends a downlink command to a supported Abeeway tracker.", "operationId"=>"sends-a-downlink-command-to-a-supported-abeeway-tracker", "x-api-path-slug"=>"trackercommands-post", "parameters"=>[{"in"=>"body", "name"=>"trackerCommand", "description"=>"Contents of the tracker command", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tracker", "Command", "Sending"]}}}}, "apis"=>{"name"=>"Actility", "x-slug"=>"actility", "description"=>"Actility is the leader in low power wide area (LoRaWAN and 3GPP) network connectivity management for the Internet of Things: the ThingPark platform", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28250-actility.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"637591", "tags"=>"API Provider,Energy,Enterprise,Industrial,Internet of Things,ISP,Networks,Parking,Profiles,Relative Data,SaaS,Sensors,Technology,Telecommunications", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"actility/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"ThingPark DX Admin API", "x-api-slug"=>"thingpark-dx-admin-api", "description"=>"Actility is the leader in low power wide area (LoRaWAN and 3GPP) network connectivity management for the Internet of Things: the ThingPark platform", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28250-actility.jpg", "humanURL"=>"https://www.actility.com", "baseURL"=>"https://dx-api.thingpark.com//admin/v140/api", "tags"=>"API Provider,Energy,Enterprise,Industrial,Internet of Things,ISP,Networks,Parking,Profiles,Relative Data,SaaS,Sensors,Technology,Telecommunications", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/actility/profilesprofileid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/actility/thingpark-dx-admin-api-openapi.yaml"}]}, {"name"=>"ThingPark DX Core API", "x-api-slug"=>"thingpark-dx-core-api", "description"=>"Actility is the leader in low power wide area (LoRaWAN and 3GPP) network connectivity management for the Internet of Things: the ThingPark platform", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28250-actility.jpg", "humanURL"=>"https://www.actility.com", "baseURL"=>"https://dx-api.thingpark.com//core/v141/api", "tags"=>"Profile,Retrieval", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/actility/thingpark-dx-core-api-openapi.yaml"}]}, {"name"=>"ThingPark DX Dataflow API", "x-api-slug"=>"thingpark-dx-dataflow-api", "description"=>"Actility is the leader in low power wide area (LoRaWAN and 3GPP) network connectivity management for the Internet of Things: the ThingPark platform", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28250-actility.jpg", "humanURL"=>"https://www.actility.com", "baseURL"=>"https://dx-api.thingpark.com//dataflow/v021/api", "tags"=>"Downlink,Message,Sending", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/actility/thingpark-dx-dataflow-api-openapi.yaml"}]}, {"name"=>"ThingPark DX Location API", "x-api-slug"=>"thingpark-dx-location-api", "description"=>"Actility is the leader in low power wide area (LoRaWAN and 3GPP) network connectivity management for the Internet of Things: the ThingPark platform", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28250-actility.jpg", "humanURL"=>"https://www.actility.com", "baseURL"=>"https://dx-api.thingpark.com//location/v110", "tags"=>"Uplink,Data,Reception", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/actility/thingpark-dx-location-api-openapi.yaml"}]}, {"name"=>"ThingPark DX Maker API", "x-api-slug"=>"thingpark-dx-maker-api", "description"=>"Actility is the leader in low power wide area (LoRaWAN and 3GPP) network connectivity management for the Internet of Things: the ThingPark platform", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28250-actility.jpg", "humanURL"=>"https://www.actility.com", "baseURL"=>"https://dx-api.thingpark.com//maker/v011/api", "tags"=>"Tracker,Command,Sending", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/actility/thingpark-dx-maker-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog-rss", "url"=>"https://www.actility.com/blog/feed/"}, {"type"=>"x-github", "url"=>"https://github.com/actility"}, {"type"=>"x-openapi", "url"=>"https://dx-api.thingpark.com/core/latest/tpdx-core-api-contract.json"}, {"type"=>"x-blog", "url"=>"https://www.actility.com/blog/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/actility"}, {"type"=>"x-developer", "url"=>"https://www.actility.com/developer/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Actility"}, {"type"=>"x-website", "url"=>"https://www.actility.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hitbtc{"hitbtc-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"HitBTC", "x-complete"=>1, "info"=>{"title"=>"HitBTC API", "description"=>"create-api-keys-in-your-profile-httpshitbtc-comsettingsapikeys-and-use-public-api-key-as-username-and-secret-as-password-to-authorize-", "version"=>"1.0.0"}, "basePath"=>"/api/2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/public/symbol"=>{"get"=>{"summary"=>"Available Currency Symbols", "description"=>"Available currency symbols.", "operationId"=>"getPublicSymbol", "x-api-path-slug"=>"publicsymbol-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Available", "Currency", "Symbols"]}}, "/public/symbol/{symbol}"=>{"get"=>{"summary"=>"Get Symbol Info", "description"=>"Get symbol info.", "operationId"=>"getPublicSymbolSymbol", "x-api-path-slug"=>"publicsymbolsymbol-get", "parameters"=>[{"in"=>"path", "name"=>"symbol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Symbol", "Info"]}}, "/public/currency"=>{"get"=>{"summary"=>"Available Currencies", "description"=>"Available currencies.", "operationId"=>"getPublicCurrency", "x-api-path-slug"=>"publiccurrency-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Available", "Currencies"]}}, "/public/currency/{currency}"=>{"get"=>{"summary"=>"Get Currency Info", "description"=>"Get currency info.", "operationId"=>"getPublicCurrencyCurrency", "x-api-path-slug"=>"publiccurrencycurrency-get", "parameters"=>[{"in"=>"path", "name"=>"currency"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Currency", "Info"]}}, "/public/ticker"=>{"get"=>{"summary"=>"Ticker List For All Symbols", "description"=>"Ticker list for all symbols.", "operationId"=>"getPublicTicker", "x-api-path-slug"=>"publicticker-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticker", "List", "Symbols"]}}, "/public/ticker/{symbol}"=>{"get"=>{"summary"=>"Ticker For Symbol", "description"=>"Ticker for symbol.", "operationId"=>"getPublicTickerSymbol", "x-api-path-slug"=>"publictickersymbol-get", "parameters"=>[{"in"=>"path", "name"=>"symbol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tickersymbol"]}}, "/public/trades/{symbol}"=>{"get"=>{"summary"=>"Trades", "description"=>"Trades.", "operationId"=>"getPublicTradesSymbol", "x-api-path-slug"=>"publictradessymbol-get", "parameters"=>[{"in"=>"query", "name"=>"by", "description"=>"Filter field"}, {"in"=>"query", "name"=>"from", "description"=>"If filter by timestamp, then datetime in iso format or timestamp in millisecond otherwise trade id"}, {"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort direction"}, {"in"=>"path", "name"=>"symbol"}, {"in"=>"query", "name"=>"till", "description"=>"If filter by timestamp, then datetime in iso format or timestamp in millisecond otherwise trade id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trades"]}}, "/public/orderbook/{symbol}"=>{"get"=>{"summary"=>"Orderbook", "description"=>"Orderbook.", "operationId"=>"getPublicOrderbookSymbol", "x-api-path-slug"=>"publicorderbooksymbol-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"0 - full orderbook otherwise number of levels"}, {"in"=>"path", "name"=>"symbol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orderbook"]}}, "/public/candles/{symbol}"=>{"get"=>{"summary"=>"Candles", "description"=>"Candles.", "operationId"=>"getPublicCandlesSymbol", "x-api-path-slug"=>"publiccandlessymbol-get", "parameters"=>[{"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"period"}, {"in"=>"path", "name"=>"symbol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Candles"]}}, "/order"=>{"get"=>{"summary"=>"List Your Current Open Orders", "description"=>"List your current open orders.", "operationId"=>"getOrder", "x-api-path-slug"=>"order-get", "parameters"=>[{"in"=>"query", "name"=>"symbol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Your", "Current", "Open", "Orders"]}, "post"=>{"summary"=>"Create New Order", "description"=>"Create new order.", "operationId"=>"postOrder", "x-api-path-slug"=>"order-post", "parameters"=>[{"in"=>"formData", "name"=>"clientOrderId"}, {"in"=>"formData", "name"=>"expireTime"}, {"in"=>"formData", "name"=>"price"}, {"in"=>"formData", "name"=>"quantity"}, {"in"=>"formData", "name"=>"side"}, {"in"=>"formData", "name"=>"stopPrice"}, {"in"=>"formData", "name"=>"strictValidate", "description"=>"Strict validate amount and price precision without rounding"}, {"in"=>"formData", "name"=>"symbol"}, {"in"=>"formData", "name"=>"timeInForce"}, {"in"=>"formData", "name"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Order"]}, "delete"=>{"summary"=>"Cancel All Open Orders", "description"=>"Cancel all open orders.", "operationId"=>"deleteOrder", "x-api-path-slug"=>"order-delete", "parameters"=>[{"in"=>"formData", "name"=>"symbol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "", "Open", "Orders"]}}, "/order/{clientOrderId}"=>{"get"=>{"summary"=>"Get A Single Order By ClientOrderId", "description"=>"Get a single order by clientorderid.", "operationId"=>"getOrderClientorder", "x-api-path-slug"=>"orderclientorderid-get", "parameters"=>[{"in"=>"path", "name"=>"clientOrderId"}, {"in"=>"query", "name"=>"wait", "description"=>"Long polling wait timeout in milliseconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Order", "By", "ClientOrderId"]}, "put"=>{"summary"=>"Create New Order", "description"=>"Create new order.", "operationId"=>"putOrderClientorder", "x-api-path-slug"=>"orderclientorderid-put", "parameters"=>[{"in"=>"path", "name"=>"clientOrderId"}, {"in"=>"formData", "name"=>"expireTime"}, {"in"=>"formData", "name"=>"price"}, {"in"=>"formData", "name"=>"quantity"}, {"in"=>"formData", "name"=>"side"}, {"in"=>"formData", "name"=>"stopPrice"}, {"in"=>"formData", "name"=>"strictValidate", "description"=>"Strict validate amount and price precision without rounding"}, {"in"=>"formData", "name"=>"symbol"}, {"in"=>"formData", "name"=>"timeInForce"}, {"in"=>"formData", "name"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Order"]}, "delete"=>{"summary"=>"Cancel Order", "description"=>"Cancel order.", "operationId"=>"deleteOrderClientorder", "x-api-path-slug"=>"orderclientorderid-delete", "parameters"=>[{"in"=>"path", "name"=>"clientOrderId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Order"]}, "patch"=>{"summary"=>"Cancel Replace Order", "description"=>"Cancel replace order.", "operationId"=>"patchOrderClientorder", "x-api-path-slug"=>"orderclientorderid-patch", "parameters"=>[{"in"=>"path", "name"=>"clientOrderId"}, {"in"=>"formData", "name"=>"price"}, {"in"=>"formData", "name"=>"quantity"}, {"in"=>"formData", "name"=>"requestClientId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Replace", "Order"]}}, "/trading/balance"=>{"get"=>{"summary"=>"Get Trading Balance", "description"=>"Get trading balance.", "operationId"=>"getTradingBalance", "x-api-path-slug"=>"tradingbalance-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trading", "Balance"]}}, "/trading/fee/{symbol}"=>{"get"=>{"summary"=>"Get Trading Fee Rate", "description"=>"Get trading fee rate.", "operationId"=>"getTradingFeeSymbol", "x-api-path-slug"=>"tradingfeesymbol-get", "parameters"=>[{"in"=>"path", "name"=>"symbol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trading", "Fee", "Rate"]}}, "/history/trades"=>{"get"=>{"summary"=>"Get Historical Trades", "description"=>"Get historical trades.", "operationId"=>"getHistoryTrades", "x-api-path-slug"=>"historytrades-get", "parameters"=>[{"in"=>"query", "name"=>"by", "description"=>"Filter field"}, {"in"=>"query", "name"=>"from", "description"=>"If filter by timestamp, then datetime in iso format or timestamp in millisecond otherwise trade id"}, {"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort direction"}, {"in"=>"query", "name"=>"symbol"}, {"in"=>"query", "name"=>"till", "description"=>"If filter by timestamp, then datetime in iso format or timestamp in millisecond otherwise trade id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Trades"]}}, "/history/order"=>{"get"=>{"summary"=>"Get Historical Orders", "description"=>"Get historical orders.", "operationId"=>"getHistoryOrder", "x-api-path-slug"=>"historyorder-get", "parameters"=>[{"in"=>"query", "name"=>"clientOrderId"}, {"in"=>"query", "name"=>"from", "description"=>"Datetime in iso format or timestamp in millisecond"}, {"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"symbol"}, {"in"=>"query", "name"=>"till", "description"=>"Datetime in iso format or timestamp in millisecond"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Orders"]}}, "/history/order/{id}/trades"=>{"get"=>{"summary"=>"Get Historical Trades By Specified Order", "description"=>"Get historical trades by specified order.", "operationId"=>"getHistoryOrderTrades", "x-api-path-slug"=>"historyorderidtrades-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Trades", "By", "Specified", "Order"]}}, "/account/balance"=>{"get"=>{"summary"=>"Get Main Acccount Balance", "description"=>"Get main acccount balance.", "operationId"=>"getAccountBalance", "x-api-path-slug"=>"accountbalance-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Main", "Acccount", "Balance"]}}, "/account/transactions"=>{"get"=>{"summary"=>"Get Account Transactions", "description"=>"Get account transactions.", "operationId"=>"getAccountTransactions", "x-api-path-slug"=>"accounttransactions-get", "parameters"=>[{"in"=>"query", "name"=>"by", "description"=>"Filter field"}, {"in"=>"query", "name"=>"currency"}, {"in"=>"query", "name"=>"from", "description"=>"Datetime in iso format or timestamp in millisecond, or index"}, {"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort direction"}, {"in"=>"query", "name"=>"till", "description"=>"Datetime in iso format or timestamp in millisecond, or index"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Transactions"]}}, "/account/transactions/{id}"=>{"get"=>{"summary"=>"Get Account Transaction By Id", "description"=>"Get account transaction by id.", "operationId"=>"getAccountTransactions", "x-api-path-slug"=>"accounttransactionsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Transaction", "By", "Id"]}}, "/account/crypto/withdraw"=>{"post"=>{"summary"=>"Withdraw Crypro", "description"=>"Withdraw crypro.", "operationId"=>"postAccountCryptoWithdraw", "x-api-path-slug"=>"accountcryptowithdraw-post", "parameters"=>[{"in"=>"formData", "name"=>"address"}, {"in"=>"formData", "name"=>"amount"}, {"in"=>"formData", "name"=>"autoCommit", "description"=>"If Auto commit disabled you should commit it or rollback within 1 hour"}, {"in"=>"formData", "name"=>"currency"}, {"in"=>"formData", "name"=>"includeFee", "description"=>"If enabled, then fee will be subtracted from amount"}, {"in"=>"formData", "name"=>"networkFee", "description"=>"Suggest preferred network fee"}, {"in"=>"formData", "name"=>"paymentId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Withdraw", "Crypro"]}}, "/account/crypto/withdraw/{id}"=>{"put"=>{"summary"=>"Commit Withdraw Crypro", "description"=>"Commit withdraw crypro.", "operationId"=>"putAccountCryptoWithdraw", "x-api-path-slug"=>"accountcryptowithdrawid-put", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commit", "Withdraw", "Crypro"]}, "delete"=>{"summary"=>"Rollback Withdraw Crypro", "description"=>"Rollback withdraw crypro.", "operationId"=>"deleteAccountCryptoWithdraw", "x-api-path-slug"=>"accountcryptowithdrawid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rollback", "Withdraw", "Crypro"]}}, "/account/crypto/address/{currency}"=>{"get"=>{"summary"=>"Get Deposit Crypro Address", "description"=>"Get deposit crypro address.", "operationId"=>"getAccountCryptoAddressCurrency", "x-api-path-slug"=>"accountcryptoaddresscurrency-get", "parameters"=>[{"in"=>"path", "name"=>"currency"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deposit", "Crypro", "Address"]}, "post"=>{"summary"=>"Create New Deposit Crypro Address", "description"=>"Create new deposit crypro address.", "operationId"=>"postAccountCryptoAddressCurrency", "x-api-path-slug"=>"accountcryptoaddresscurrency-post", "parameters"=>[{"in"=>"path", "name"=>"currency"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Deposit", "Crypro", "Address"]}}, "/account/transfer"=>{"post"=>{"summary"=>"Transfer Amount To Trading", "description"=>"Transfer amount to trading.", "operationId"=>"postAccountTransfer", "x-api-path-slug"=>"accounttransfer-post", "parameters"=>[{"in"=>"formData", "name"=>"amount"}, {"in"=>"formData", "name"=>"currency"}, {"in"=>"formData", "name"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transfer", "Amount", "To", "Trading"]}}}}, "apis"=>{"name"=>"HitBTC", "x-slug"=>"hitbtc", "description"=>"We bring cutting-edge technology to the Bitcoin ecosystem! Hitbtc provides an excellent trading terminal based on professional trading software which is suitable for new and sophisticated users. As one of our valued customers, we understand how i...", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/hitbtc-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"3107", "tags"=>"API Provider,Blockchain,General Data,Marketplace,Profiles,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"hitbtc/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"HitBTC", "x-api-slug"=>"hitbtc", "description"=>"We bring cutting-edge technology to the Bitcoin ecosystem! Hitbtc provides an excellent trading terminal based on professional trading software which is suitable for new and sophisticated users. As one of our valued customers, we understand how i...", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/hitbtc-logo.png", "humanURL"=>"https://hitbtc.com", "baseURL"=>"https:////api/2", "tags"=>"API Provider,Blockchain,General Data,Marketplace,Profiles,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/hitbtc/accounttransfer-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/hitbtc/hitbtc-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog-rss", "url"=>"https://blog.hitbtc.com/feed/"}, {"type"=>"x-github", "url"=>"https://github.com/hitbtc-com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/hitbtc"}, {"type"=>"x-blog", "url"=>"https://blog.hitbtc.com/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/hitbtc"}, {"type"=>"x-documentation", "url"=>"https://api.hitbtc.com/api/2/explore/"}, {"type"=>"x-website", "url"=>"https://hitbtc.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-automation{"azure-automation-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Automation", "x-complete"=>1, "info"=>{"title"=>"AutomationManagementClient", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}"=>{"patch"=>{"summary"=>"Automation Account Update", "description"=>"Update an automation account.", "operationId"=>"AutomationAccount_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountname-patch", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"Automation account name"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the update automation account", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Automation", "Account"]}, "put"=>{"summary"=>"Automation Account Create Or Update", "description"=>"Create or update automation account.", "operationId"=>"AutomationAccount_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountname-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"Parameters supplied to the create or update automation account"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the create or update automation account", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Automation", "Account", "Or"]}, "delete"=>{"summary"=>"Automation Account Delete", "description"=>"Delete an automation account.", "operationId"=>"AutomationAccount_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountname-delete", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"Automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Automation", "Account"]}, "get"=>{"summary"=>"Automation Account Get", "description"=>"Get information about an Automation Account.", "operationId"=>"AutomationAccount_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountname-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts"=>{"get"=>{"summary"=>"Automation Account List By Resource Group", "description"=>"Retrieve a list of accounts within a given resource group.", "operationId"=>"AutomationAccount_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Automation", "Account", "List", "Resource", "Group"]}}, "/providers/Microsoft.Automation/operations"=>{"get"=>{"summary"=>"List Operations", "description"=>"Lists all of the available Automation REST API operations.", "operationId"=>"Operations_List", "x-api-path-slug"=>"providersmicrosoft-automationoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Operations"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Automation/automationAccounts"=>{"get"=>{"summary"=>"Lists the Automation Accounts", "description"=>"Retrieve a list of accounts within a given subscription.", "operationId"=>"AutomationAccount_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-automationautomationaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Automation", "Accounts"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/statistics"=>{"get"=>{"summary"=>"Statistics List By Automation Account", "description"=>"Retrieve the statistics for the account.", "operationId"=>"Statistics_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamestatistics-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Statistics", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/usages"=>{"get"=>{"summary"=>"Usages List By Automation Account", "description"=>"Retrieve the usage for the account id.", "operationId"=>"Usages_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameusages-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Usages", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates/{certificateName}"=>{"delete"=>{"summary"=>"Certificate Delete", "description"=>"Delete the certificate.", "operationId"=>"Certificate_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamecertificatescertificatename-delete", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"certificateName", "description"=>"The name of certificate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate"]}, "get"=>{"summary"=>"Certificate Get", "description"=>"Retrieve the certificate identified by certificate name.", "operationId"=>"Certificate_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamecertificatescertificatename-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"certificateName", "description"=>"The name of certificate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate"]}, "put"=>{"summary"=>"Certificate Create Or Update", "description"=>"Create a certificate.", "operationId"=>"Certificate_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamecertificatescertificatename-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"certificateName", "description"=>"The parameters supplied to the create or update certificate operation"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters supplied to the create or update certificate operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate", "Or"]}, "patch"=>{"summary"=>"Certificate Update", "description"=>"Update a certificate.", "operationId"=>"Certificate_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamecertificatescertificatename-patch", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"certificateName", "description"=>"The parameters supplied to the update certificate operation"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters supplied to the update certificate operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates"=>{"get"=>{"summary"=>"Certificate List By Automation Account", "description"=>"Retrieve a list of certificates.", "operationId"=>"Certificate_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamecertificates-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections/{connectionName}"=>{"delete"=>{"summary"=>"Connection Delete", "description"=>"Delete the connection.", "operationId"=>"Connection_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameconnectionsconnectionname-delete", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"connectionName", "description"=>"The name of connection"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connection"]}, "get"=>{"summary"=>"Connection Get", "description"=>"Retrieve the connection identified by connection name.", "operationId"=>"Connection_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameconnectionsconnectionname-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"connectionName", "description"=>"The name of connection"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connection"]}, "put"=>{"summary"=>"Connection Create Or Update", "description"=>"Create or update a connection.", "operationId"=>"Connection_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameconnectionsconnectionname-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"connectionName", "description"=>"The parameters supplied to the create or update connection operation"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters supplied to the create or update connection operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connection", "Or"]}, "patch"=>{"summary"=>"Connection Update", "description"=>"Update a connection.", "operationId"=>"Connection_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameconnectionsconnectionname-patch", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"connectionName", "description"=>"The parameters supplied to the update a connection operation"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters supplied to the update a connection operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connection"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections"=>{"get"=>{"summary"=>"Connection List By Automation Account", "description"=>"Retrieve a list of connections.", "operationId"=>"Connection_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameconnections-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connection", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connectionTypes/{connectionTypeName}"=>{"delete"=>{"summary"=>"Connection Type Delete", "description"=>"Delete the connectiontype.", "operationId"=>"ConnectionType_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameconnectiontypesconnectiontypename-delete", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"connectionTypeName", "description"=>"The name of connectiontype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connection", "Type"]}, "get"=>{"summary"=>"Connection Type Get", "description"=>"Retrieve the connectiontype identified by connectiontype name.", "operationId"=>"ConnectionType_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameconnectiontypesconnectiontypename-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"connectionTypeName", "description"=>"The name of connectiontype"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connection", "Type"]}, "put"=>{"summary"=>"Connection Type Create Or Update", "description"=>"Create a connectiontype.", "operationId"=>"ConnectionType_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameconnectiontypesconnectiontypename-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"connectionTypeName", "description"=>"The parameters supplied to the create or update connectiontype operation"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters supplied to the create or update connectiontype operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connection", "Type", "Or"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connectionTypes"=>{"get"=>{"summary"=>"Connection Type List By Automation Account", "description"=>"Retrieve a list of connectiontypes.", "operationId"=>"ConnectionType_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameconnectiontypes-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connection", "Type", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials/{credentialName}"=>{"delete"=>{"summary"=>"Credential Delete", "description"=>"Delete the credential.", "operationId"=>"Credential_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamecredentialscredentialname-delete", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"credentialName", "description"=>"The name of credential"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Credential"]}, "get"=>{"summary"=>"Credential Get", "description"=>"Retrieve the credential identified by credential name.", "operationId"=>"Credential_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamecredentialscredentialname-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"credentialName", "description"=>"The name of credential"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Credential"]}, "put"=>{"summary"=>"Credential Create Or Update", "description"=>"Create a credential.", "operationId"=>"Credential_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamecredentialscredentialname-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"credentialName", "description"=>"The parameters supplied to the create or update credential operation"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters supplied to the create or update credential operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Credential", "Or"]}, "patch"=>{"summary"=>"Credential Update", "description"=>"Update a credential.", "operationId"=>"Credential_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamecredentialscredentialname-patch", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"credentialName", "description"=>"The parameters supplied to the Update credential operation"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters supplied to the Update credential operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Credential"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials"=>{"get"=>{"summary"=>"Credential List By Automation Account", "description"=>"Retrieve a list of credentials.", "operationId"=>"Credential_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamecredentials-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Credential", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/compilationjobs/{compilationJobId}"=>{"put"=>{"summary"=>"Dsc Compilation Job Create", "description"=>"Creates the Dsc compilation job of the configuration.", "operationId"=>"DscCompilationJob_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamecompilationjobscompilationjobid-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"compilationJobId", "description"=>"The the DSC configuration Id"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters supplied to the create compilation job operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Compilation", "Job", "Create"]}, "get"=>{"summary"=>"Dsc Compilation Job Get", "description"=>"Retrieve the Dsc configuration compilation job identified by job id.", "operationId"=>"DscCompilationJob_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamecompilationjobscompilationjobid-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"compilationJobId", "description"=>"The Dsc configuration compilation job id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Compilation", "Job"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/compilationjobs"=>{"get"=>{"summary"=>"Dsc Compilation Job List By Automation Account", "description"=>"Retrieve a list of dsc compilation jobs.", "operationId"=>"DscCompilationJob_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamecompilationjobs-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Compilation", "Job", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/compilationjobs/{jobId}/streams/{jobStreamId}"=>{"get"=>{"summary"=>"Dsc Compilation Job Get Stream", "description"=>"Retrieve the job stream identified by job stream id.", "operationId"=>"DscCompilationJob_GetStream", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamecompilationjobsjobidstreamsjobstreamid-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"jobId", "description"=>"The job id"}, {"in"=>"path", "name"=>"jobStreamId", "description"=>"The job stream id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Compilation", "Job", "", "Stream"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}"=>{"delete"=>{"summary"=>"Dsc Configuration Delete", "description"=>"Delete the dsc configuration identified by configuration name.", "operationId"=>"DscConfiguration_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameconfigurationsconfigurationname-delete", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"configurationName", "description"=>"The configuration name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Configuration"]}, "get"=>{"summary"=>"Dsc Configuration Get", "description"=>"Retrieve the configuration identified by configuration name.", "operationId"=>"DscConfiguration_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameconfigurationsconfigurationname-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"configurationName", "description"=>"The configuration name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Configuration"]}, "put"=>{"summary"=>"Dsc Configuration Create Or Update", "description"=>"Create the configuration identified by configuration name.", "operationId"=>"DscConfiguration_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameconfigurationsconfigurationname-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"configurationName", "description"=>"The create or update parameters for configuration"}, {"in"=>"body", "name"=>"parameters", "description"=>"The create or update parameters for configuration", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Configuration", "Or"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}/content"=>{"get"=>{"summary"=>"Dsc Configuration Get Content", "description"=>"Retrieve the configuration script identified by configuration name.", "operationId"=>"DscConfiguration_GetContent", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameconfigurationsconfigurationnamecontent-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"configurationName", "description"=>"The configuration name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Configuration", "", "Content"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations"=>{"get"=>{"summary"=>"Dsc Configuration List By Automation Account", "description"=>"Retrieve a list of configurations.", "operationId"=>"DscConfiguration_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameconfigurations-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Configuration", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation"=>{"get"=>{"summary"=>"Agent Registration Information Get", "description"=>"Retrieve the automation agent registration information.", "operationId"=>"AgentRegistrationInformation_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameagentregistrationinformation-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agent", "Registration", "Information"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation/regenerateKey"=>{"post"=>{"summary"=>"Agent Registration Information Regenerate Key", "description"=>"Regenerate a primary or secondary agent registration key", "operationId"=>"AgentRegistrationInformation_RegenerateKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameagentregistrationinformationregeneratekey-post", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The name of the agent registration key to be regenerated", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agent", "Registration", "Information", "Regenerate", "Key"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}"=>{"delete"=>{"summary"=>"Dsc Node Delete", "description"=>"Delete the dsc node identified by node id.", "operationId"=>"DscNode_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamenodesnodeid-delete", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"Automation account name"}, {"in"=>"path", "name"=>"nodeId", "description"=>"The node id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Node"]}, "get"=>{"summary"=>"Dsc Node Get", "description"=>"Retrieve the dsc node identified by node id.", "operationId"=>"DscNode_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamenodesnodeid-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"nodeId", "description"=>"The node id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Node"]}, "patch"=>{"summary"=>"Dsc Node Update", "description"=>"Update the dsc node.", "operationId"=>"DscNode_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamenodesnodeid-patch", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"nodeId", "description"=>"Parameters supplied to the update dsc node"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the update dsc node", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Node"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes"=>{"get"=>{"summary"=>"Dsc Node List By Automation Account", "description"=>"Retrieve a list of dsc nodes.", "operationId"=>"DscNode_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamenodes-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Node", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports"=>{"get"=>{"summary"=>"Node Reports List By Node", "description"=>"Retrieve the Dsc node report list by node id.", "operationId"=>"NodeReports_ListByNode", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamenodesnodeidreports-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"nodeId", "description"=>"The parameters supplied to the list operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Node", "Reports", "ListNode"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports/{reportId}"=>{"get"=>{"summary"=>"Node Reports Get", "description"=>"Retrieve the Dsc node report data by node id and report id.", "operationId"=>"NodeReports_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamenodesnodeidreportsreportid-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"nodeId", "description"=>"The Dsc node id"}, {"in"=>"path", "name"=>"reportId", "description"=>"The report id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Node", "Reports"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports/{reportId}/content"=>{"get"=>{"summary"=>"Node Reports Get Content", "description"=>"Retrieve the Dsc node reports by node id and report id.", "operationId"=>"NodeReports_GetContent", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamenodesnodeidreportsreportidcontent-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"nodeId", "description"=>"The Dsc node id"}, {"in"=>"path", "name"=>"reportId", "description"=>"The report id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Node", "Reports", "", "Content"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations/{nodeConfigurationName}"=>{"delete"=>{"summary"=>"Dsc Node Configuration Delete", "description"=>"Delete the Dsc node configurations by node configuration.", "operationId"=>"DscNodeConfiguration_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamenodeconfigurationsnodeconfigurationname-delete", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"nodeConfigurationName", "description"=>"The Dsc node configuration name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Node", "Configuration"]}, "get"=>{"summary"=>"Dsc Node Configuration Get", "description"=>"Retrieve the Dsc node configurations by node configuration.", "operationId"=>"DscNodeConfiguration_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamenodeconfigurationsnodeconfigurationname-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"nodeConfigurationName", "description"=>"The Dsc node configuration name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Node", "Configuration"]}, "put"=>{"summary"=>"Dsc Node Configuration Create Or Update", "description"=>"Create the node configuration identified by node configuration name.", "operationId"=>"DscNodeConfiguration_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamenodeconfigurationsnodeconfigurationname-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"nodeConfigurationName", "description"=>"The create or update parameters for configuration"}, {"in"=>"body", "name"=>"parameters", "description"=>"The create or update parameters for configuration", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Node", "Configuration", "Or"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations"=>{"get"=>{"summary"=>"Dsc Node Configuration List By Automation Account", "description"=>"Retrieve a list of dsc node configurations.", "operationId"=>"DscNodeConfiguration_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamenodeconfigurations-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dsc", "Node", "Configuration", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}"=>{"delete"=>{"summary"=>"Hybrid Runbook Worker Group Delete", "description"=>"Delete a hybrid runbook worker group.", "operationId"=>"HybridRunbookWorkerGroup_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamehybridrunbookworkergroupshybridrunbookworkergroupname-delete", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"Automation account name"}, {"in"=>"path", "name"=>"hybridRunbookWorkerGroupName", "description"=>"The hybrid runbook worker group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hybrid", "Runbook", "Worker", "Group"]}, "get"=>{"summary"=>"Hybrid Runbook Worker Group Get", "description"=>"Retrieve a hybrid runbook worker group.", "operationId"=>"HybridRunbookWorkerGroup_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamehybridrunbookworkergroupshybridrunbookworkergroupname-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"hybridRunbookWorkerGroupName", "description"=>"The hybrid runbook worker group name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hybrid", "Runbook", "Worker", "Group"]}, "patch"=>{"summary"=>"Hybrid Runbook Worker Group Update", "description"=>"Update a hybrid runbook worker group.", "operationId"=>"HybridRunbookWorkerGroup_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamehybridrunbookworkergroupshybridrunbookworkergroupname-patch", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"hybridRunbookWorkerGroupName", "description"=>"The hybrid runbook worker group name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The hybrid runbook worker group", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hybrid", "Runbook", "Worker", "Group"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups"=>{"get"=>{"summary"=>"Hybrid Runbook Worker Group List By Automation Account", "description"=>"Retrieve a list of hybrid runbook worker groups.", "operationId"=>"HybridRunbookWorkerGroup_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamehybridrunbookworkergroups-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hybrid", "Runbook", "Worker", "Group", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobId}/output"=>{"get"=>{"summary"=>"Job Get Output", "description"=>"Retrieve the job output identified by job id.", "operationId"=>"Job_GetOutput", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamejobsjobidoutput-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"jobId", "description"=>"The job id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "", "Output"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobId}/runbookContent"=>{"get"=>{"summary"=>"Job Get Runbook Content", "description"=>"Retrieve the runbook content of the job identified by job id.", "operationId"=>"Job_GetRunbookContent", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamejobsjobidrunbookcontent-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"jobId", "description"=>"The job id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "", "Runbook", "Content"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobId}/suspend"=>{"post"=>{"summary"=>"Job Suspend", "description"=>"Suspend the job identified by jobId.", "operationId"=>"Job_Suspend", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamejobsjobidsuspend-post", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"jobId", "description"=>"The job id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "Suspend"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobId}/stop"=>{"post"=>{"summary"=>"Job Stop", "description"=>"Stop the job identified by jobId.", "operationId"=>"Job_Stop", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamejobsjobidstop-post", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"jobId", "description"=>"The job id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "Stop"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobId}"=>{"get"=>{"summary"=>"Job Get", "description"=>"Retrieve the job identified by job id.", "operationId"=>"Job_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamejobsjobid-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"jobId", "description"=>"The job id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}, "put"=>{"summary"=>"Job Create", "description"=>"Create a job of the runbook.", "operationId"=>"Job_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamejobsjobid-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"jobId", "description"=>"The job id"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters supplied to the create job operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "Create"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs"=>{"get"=>{"summary"=>"Job List By Automation Account", "description"=>"Retrieve a list of jobs.", "operationId"=>"Job_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamejobs-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobId}/resume"=>{"post"=>{"summary"=>"Job Resume", "description"=>"Resume the job identified by jobId.", "operationId"=>"Job_Resume", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamejobsjobidresume-post", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"jobId", "description"=>"The job id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "Resume"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobId}/streams/{jobStreamId}"=>{"get"=>{"summary"=>"Job Stream Get", "description"=>"Retrieve the job stream identified by job stream id.", "operationId"=>"JobStream_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamejobsjobidstreamsjobstreamid-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"jobId", "description"=>"The job id"}, {"in"=>"path", "name"=>"jobStreamId", "description"=>"The job stream id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "Stream"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobId}/streams"=>{"get"=>{"summary"=>"Job Stream List By Job", "description"=>"Retrieve a list of jobs streams identified by job id.", "operationId"=>"JobStream_ListByJob", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamejobsjobidstreams-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"jobId", "description"=>"The job Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "Stream", "ListJob"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobSchedules/{jobScheduleId}"=>{"delete"=>{"summary"=>"Job Schedule Delete", "description"=>"Delete the job schedule identified by job schedule name.", "operationId"=>"JobSchedule_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamejobschedulesjobscheduleid-delete", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"jobScheduleId", "description"=>"The job schedule name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "Schedule"]}, "get"=>{"summary"=>"Job Schedule Get", "description"=>"Retrieve the job schedule identified by job schedule name.", "operationId"=>"JobSchedule_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamejobschedulesjobscheduleid-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"jobScheduleId", "description"=>"The job schedule name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "Schedule"]}, "put"=>{"summary"=>"Job Schedule Create", "description"=>"Create a job schedule.", "operationId"=>"JobSchedule_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamejobschedulesjobscheduleid-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"jobScheduleId", "description"=>"The job schedule name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters supplied to the create job schedule operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "Schedule", "Create"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobSchedules"=>{"get"=>{"summary"=>"Job Schedule List By Automation Account", "description"=>"Retrieve a list of job schedules.", "operationId"=>"JobSchedule_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamejobschedules-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job", "Schedule", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/activities/{activityName}"=>{"get"=>{"summary"=>"Activity Get", "description"=>"Retrieve the activity in the module identified by module name and activity name.", "operationId"=>"Activity_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamemodulesmodulenameactivitiesactivityname-get", "parameters"=>[{"in"=>"path", "name"=>"activityName", "description"=>"The name of activity"}, {"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"moduleName", "description"=>"The name of module"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/activities"=>{"get"=>{"summary"=>"Activity List By Module", "description"=>"Retrieve a list of activities in the module identified by module name.", "operationId"=>"Activity_ListByModule", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamemodulesmodulenameactivities-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"moduleName", "description"=>"The name of module"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity", "ListModule"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}"=>{"delete"=>{"summary"=>"Module Delete", "description"=>"Delete the module by name.", "operationId"=>"Module_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamemodulesmodulename-delete", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"moduleName", "description"=>"The module name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Module"]}, "get"=>{"summary"=>"Module Get", "description"=>"Retrieve the module identified by module name.", "operationId"=>"Module_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamemodulesmodulename-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"moduleName", "description"=>"The module name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Module"]}, "put"=>{"summary"=>"Module Create Or Update", "description"=>"Create or Update the module identified by module name.", "operationId"=>"Module_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamemodulesmodulename-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"moduleName", "description"=>"The name of module"}, {"in"=>"body", "name"=>"parameters", "description"=>"The create or update parameters for module", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Module", "Or"]}, "patch"=>{"summary"=>"Module Update", "description"=>"Update the module identified by module name.", "operationId"=>"Module_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamemodulesmodulename-patch", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"moduleName", "description"=>"The name of module"}, {"in"=>"body", "name"=>"parameters", "description"=>"The update parameters for module", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Module"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules"=>{"get"=>{"summary"=>"Module List By Automation Account", "description"=>"Retrieve a list of modules.", "operationId"=>"Module_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamemodules-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Module", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/objectDataTypes/{typeName}/fields"=>{"get"=>{"summary"=>"Object Data Types List Fields By Module And Type", "description"=>"Retrieve a list of fields of a given type identified by module name.", "operationId"=>"ObjectDataTypes_ListFieldsByModuleAndType", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamemodulesmodulenameobjectdatatypestypenamefields-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"moduleName", "description"=>"The name of module"}, {"in"=>"path", "name"=>"typeName", "description"=>"The name of type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object", "Data", "Types", "List", "FieldsModuleType"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/objectDataTypes/{typeName}/fields"=>{"get"=>{"summary"=>"Object Data Types List Fields By Type", "description"=>"Retrieve a list of fields of a given type across all accessible modules.", "operationId"=>"ObjectDataTypes_ListFieldsByType", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameobjectdatatypestypenamefields-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"typeName", "description"=>"The name of type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object", "Data", "Types", "List", "FieldsType"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/types/{typeName}/fields"=>{"get"=>{"summary"=>"Fields List By Type", "description"=>"Retrieve a list of fields of a given type identified by module name.", "operationId"=>"Fields_ListByType", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamemodulesmodulenametypestypenamefields-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"moduleName", "description"=>"The name of module"}, {"in"=>"path", "name"=>"typeName", "description"=>"The name of type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fields", "ListType"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/content"=>{"get"=>{"summary"=>"Runbook Draft Get Content", "description"=>"Retrieve the content of runbook draft identified by runbook name.", "operationId"=>"RunbookDraft_GetContent", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbooknamedraftcontent-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"runbookName", "description"=>"The runbook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runbook", "Draft", "", "Content"]}, "put"=>{"summary"=>"Runbook Draft Create Or Update", "description"=>"Updates the runbook draft with runbookStream as its content.", "operationId"=>"RunbookDraft_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbooknamedraftcontent-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"body", "name"=>"runbookContent", "description"=>"Therunbookdraftcontent", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"runbookName", "description"=>"The runbook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runbook", "Draft", "Or"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft"=>{"get"=>{"summary"=>"Runbook Draft Get", "description"=>"Retrieve the runbook draft identified by runbook name.", "operationId"=>"RunbookDraft_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbooknamedraft-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"runbookName", "description"=>"The runbook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runbook", "Draft"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/publish"=>{"post"=>{"summary"=>"Runbook Draft Publish", "description"=>"Publish runbook draft.", "operationId"=>"RunbookDraft_Publish", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbooknamedraftpublish-post", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"runbookName", "description"=>"The parameters supplied to the publish runbook operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runbook", "Draft", "Publish"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/undoEdit"=>{"post"=>{"summary"=>"Runbook Draft Undo Edit", "description"=>"Retrieve the runbook identified by runbook name.", "operationId"=>"RunbookDraft_UndoEdit", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbooknamedraftundoedit-post", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"runbookName", "description"=>"The runbook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runbook", "Draft", "Undo", "Edit"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/content"=>{"get"=>{"summary"=>"Runbook Get Content", "description"=>"Retrieve the content of runbook identified by runbook name.", "operationId"=>"Runbook_GetContent", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbooknamecontent-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"runbookName", "description"=>"The runbook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runbook", "", "Content"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}"=>{"get"=>{"summary"=>"Runbook Get", "description"=>"Retrieve the runbook identified by runbook name.", "operationId"=>"Runbook_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbookname-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"runbookName", "description"=>"The runbook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runbook"]}, "put"=>{"summary"=>"Runbook Create Or Update", "description"=>"Create the runbook identified by runbook name.", "operationId"=>"Runbook_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbookname-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The create or update parameters for runbook", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"runbookName", "description"=>"The runbook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runbook", "Or"]}, "patch"=>{"summary"=>"Runbook Update", "description"=>"Update the runbook identified by runbook name.", "operationId"=>"Runbook_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbookname-patch", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The update parameters for runbook", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"runbookName", "description"=>"The runbook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runbook"]}, "delete"=>{"summary"=>"Runbook Delete", "description"=>"Delete the runbook by name.", "operationId"=>"Runbook_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbookname-delete", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"runbookName", "description"=>"The runbook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runbook"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks"=>{"get"=>{"summary"=>"Runbook List By Automation Account", "description"=>"Retrieve a list of runbooks.", "operationId"=>"Runbook_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooks-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runbook", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/streams/{jobStreamId}"=>{"get"=>{"summary"=>"Test Job Streams Get", "description"=>"Retrieve a test job streams identified by runbook name and stream id.", "operationId"=>"TestJobStreams_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbooknamedrafttestjobstreamsjobstreamid-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"jobStreamId", "description"=>"The job stream id"}, {"in"=>"path", "name"=>"runbookName", "description"=>"The runbook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "Job", "Streams"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/streams"=>{"get"=>{"summary"=>"Test Job Streams List By Test Job", "description"=>"Retrieve a list of test job streams identified by runbook name.", "operationId"=>"TestJobStreams_ListByTestJob", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbooknamedrafttestjobstreams-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"runbookName", "description"=>"The runbook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "Job", "Streams", "ListTest", "Job"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob"=>{"put"=>{"summary"=>"Test Jobs Create", "description"=>"Create a test job of the runbook.", "operationId"=>"TestJobs_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbooknamedrafttestjob-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters supplied to the create test job operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"runbookName", "description"=>"The parameters supplied to the create test job operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "Jobs", "Create"]}, "get"=>{"summary"=>"Test Jobs Get", "description"=>"Retrieve the test job for the specified runbook.", "operationId"=>"TestJobs_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbooknamedrafttestjob-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"runbookName", "description"=>"The runbook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "Jobs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/resume"=>{"post"=>{"summary"=>"Test Jobs Resume", "description"=>"Resume the test job.", "operationId"=>"TestJobs_Resume", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbooknamedrafttestjobresume-post", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"runbookName", "description"=>"The runbook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "Jobs", "Resume"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/stop"=>{"post"=>{"summary"=>"Test Jobs Stop", "description"=>"Stop the test job.", "operationId"=>"TestJobs_Stop", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbooknamedrafttestjobstop-post", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"runbookName", "description"=>"The runbook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "Jobs", "Stop"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/suspend"=>{"post"=>{"summary"=>"Test Jobs Suspend", "description"=>"Suspend the test job.", "operationId"=>"TestJobs_Suspend", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamerunbooksrunbooknamedrafttestjobsuspend-post", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"runbookName", "description"=>"The runbook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "Jobs", "Suspend"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/schedules/{scheduleName}"=>{"put"=>{"summary"=>"Schedule Create Or Update", "description"=>"Create a schedule.", "operationId"=>"Schedule_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameschedulesschedulename-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters supplied to the create or update schedule operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"scheduleName", "description"=>"The schedule name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedule", "Or"]}, "patch"=>{"summary"=>"Schedule Update", "description"=>"Update the schedule identified by schedule name.", "operationId"=>"Schedule_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameschedulesschedulename-patch", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters supplied to the update schedule operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"scheduleName", "description"=>"The schedule name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedule"]}, "get"=>{"summary"=>"Schedule Get", "description"=>"Retrieve the schedule identified by schedule name.", "operationId"=>"Schedule_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameschedulesschedulename-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"scheduleName", "description"=>"The schedule name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedule"]}, "delete"=>{"summary"=>"Schedule Delete", "description"=>"Delete the schedule identified by schedule name.", "operationId"=>"Schedule_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameschedulesschedulename-delete", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"scheduleName", "description"=>"The schedule name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedule"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/schedules"=>{"get"=>{"summary"=>"Schedule List By Automation Account", "description"=>"Retrieve a list of schedules.", "operationId"=>"Schedule_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnameschedules-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedule", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/variables/{variableName}"=>{"put"=>{"summary"=>"Variable Create Or Update", "description"=>"Create a variable.", "operationId"=>"Variable_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamevariablesvariablename-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters supplied to the create or update variable operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"variableName", "description"=>"The variable name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variable", "Or"]}, "patch"=>{"summary"=>"Variable Update", "description"=>"Update a variable.", "operationId"=>"Variable_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamevariablesvariablename-patch", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters supplied to the update variable operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"variableName", "description"=>"The variable name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variable"]}, "delete"=>{"summary"=>"Variable Delete", "description"=>"Delete the variable.", "operationId"=>"Variable_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamevariablesvariablename-delete", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"variableName", "description"=>"The name of variable"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variable"]}, "get"=>{"summary"=>"Variable Get", "description"=>"Retrieve the variable identified by variable name.", "operationId"=>"Variable_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamevariablesvariablename-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"variableName", "description"=>"The name of variable"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variable"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/variables"=>{"get"=>{"summary"=>"Variable List By Automation Account", "description"=>"Retrieve a list of variables.", "operationId"=>"Variable_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamevariables-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Variable", "List", "Automation", "Account"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/generateUri"=>{"post"=>{"summary"=>"Webhook Generate Uri", "description"=>"Generates a Uri for use in creating a webhook.", "operationId"=>"Webhook_GenerateUri", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamewebhooksgenerateuri-post", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook", "Generate", "Uri"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/{webhookName}"=>{"delete"=>{"summary"=>"Webhook Delete", "description"=>"Delete the webhook by name.", "operationId"=>"Webhook_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamewebhookswebhookname-delete", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"webhookName", "description"=>"The webhook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook"]}, "get"=>{"summary"=>"Webhook Get", "description"=>"Retrieve the webhook identified by webhook name.", "operationId"=>"Webhook_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamewebhookswebhookname-get", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"path", "name"=>"webhookName", "description"=>"The webhook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook"]}, "put"=>{"summary"=>"Webhook Create Or Update", "description"=>"Create the webhook identified by webhook name.", "operationId"=>"Webhook_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamewebhookswebhookname-put", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The create or update parameters for webhook", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"webhookName", "description"=>"The webhook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook", "Or"]}, "patch"=>{"summary"=>"Webhook Update", "description"=>"Update the webhook identified by webhook name.", "operationId"=>"Webhook_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamewebhookswebhookname-patch", "parameters"=>[{"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The update parameters for webhook", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"webhookName", "description"=>"The webhook name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks"=>{"get"=>{"summary"=>"Webhook List By Automation Account", "description"=>"Retrieve a list of webhooks.", "operationId"=>"Webhook_ListByAutomationAccount", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamewebhooks-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"path", "name"=>"automationAccountName", "description"=>"The automation account name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook", "List", "Automation", "Account"]}}}}, "apis"=>{"name"=>"Azure Automation", "x-slug"=>"azure-automation", "description"=>"Automate all of those frequent, time-consuming, and error-prone cloud management tasks. Azure Automation helps you focus on work that adds business value. By reducing errors and boosting efficiency, it also helps to lower your operational costs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-automation-save-time.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Automation,Microsoft,Orchestration,Profiles,Relative Data,Service API,Stack Network,Webhooks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-automation/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Automation API", "x-api-slug"=>"azure-automation-api", "description"=>"Automate all of those frequent, time-consuming, and error-prone cloud management tasks. Azure Automation helps you focus on work that adds business value. By reducing errors and boosting efficiency, it also helps to lower your operational costs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-automation-save-time.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/automation/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Automation,Microsoft,Orchestration,Profiles,Relative Data,Service API,Stack Network,Webhooks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-automation/subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-automationautomationaccountsautomationaccountnamewebhooks-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-automation/azure-automation-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/automation/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/automation/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/automation/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/automation/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bureau-of-economic-analysis{"the-bureau-of-economic-analysis-bea-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bureau of Economic Analysis", "x-complete"=>1, "info"=>{"title"=>"The Bureau of Economic Analysis (BEA) API", "description"=>"he-data-api-provides-programmatic-access-to-bea-published-economic-statistics-using-industrystandard-methods-and-procedures--beas-data-api-includes-methods-for-retrieving-a-subset-of-our-statistical-data-and-the-metadata-that-describes-it-", "version"=>"v1"}, "host"=>"www.bea.gov/api/data?&UserID=Your-36CharacterKey&method=getparameterlist&datasetname=RegionalData&", "basePath"=>"/api/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"data/"=>{"get"=>{"summary"=>"Economic Statistics", "description"=>"Economic Statistics", "operationId"=>"getData", "x-api-path-slug"=>"data-get", "parameters"=>[{"in"=>"query", "name"=>"datasetname"}, {"in"=>"query", "name"=>"method"}, {"in"=>"query", "name"=>"ParameterName"}, {"in"=>"query", "name"=>"ResultFormat"}, {"in"=>"query", "name"=>"UserID", "description"=>"Your user id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Economic", "Statistics"]}}}}, "apis"=>{"name"=>"Bureau of Economic Analysis", "x-slug"=>"bureau-of-economic-analysis", "description"=>"Official Bureau of Economic Analysis website. Source of US economic statistics including national income and product accounts (NIPAs), gross domestic product (GDP) and related measures of national, regional, industry and international accounts.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11179-bureau-of-economic-analysis.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"64160", "tags"=>"API Provider,Data JSON,Data Provider,Federal Government,Federal Government,General Data,Government,Profiles,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bureau-of-economic-analysis/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"The Bureau of Economic Analysis (BEA) API", "x-api-slug"=>"the-bureau-of-economic-analysis-bea-api", "description"=>"The data API provides programmatic access to BEA published economic statistics using industry-standard methods and procedures. BEAs data API includes methods for retrieving a subset of our statistical data and the meta-data that describes it.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11179-bureau-of-economic-analysis.jpg", "humanURL"=>"http://www.bea.gov", "baseURL"=>"://www.bea.gov/api/data?&UserID=Your-36CharacterKey&method=getparameterlist&datasetname=RegionalData&//api/", "tags"=>"API Provider,Data JSON,Data Provider,Federal Government,Federal Government,General Data,Government,Profiles,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bureau-of-economic-analysis/data-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bureau-of-economic-analysis/the-bureau-of-economic-analysis-bea-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://www.bea.gov/api/data/"}, {"type"=>"x-developer", "url"=>"http://www.bea.gov/API/signup/index.cfm"}, {"type"=>"x-email", "url"=>"privacy@bea.gov"}, {"type"=>"x-email", "url"=>"webmaster@bea.gov"}, {"type"=>"x-email", "url"=>"gianna.marrone@bea.gov"}, {"type"=>"x-email", "url"=>"james.fetzer@bea.gov"}, {"type"=>"x-email", "url"=>"william.jolliff@bea.gov"}, {"type"=>"x-email", "url"=>"blaire.thomson@bea.gov"}, {"type"=>"x-email", "url"=>"Ethan.Schein@bea.gov"}, {"type"=>"x-email", "url"=>"chelsea.nelson@bea.gov"}, {"type"=>"x-email", "url"=>"kevin.barefoot@bea.gov"}, {"type"=>"x-email", "url"=>"peter.kuhbach@bea.gov"}, {"type"=>"x-email", "url"=>"developers@bea.gov"}, {"type"=>"x-faq", "url"=>"http://www.bea.gov/faq/index.cfm"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/BEA_News"}, {"type"=>"x-website", "url"=>"http://www.bea.gov"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
apis-io{"apis-io-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"APIs.io", "x-complete"=>1, "info"=>{"title"=>"APIs.io", "description"=>"you-can-use-our-v1-api-to-get-and-add-data-to-apis-io-", "version"=>"1.0.0"}, "host"=>"apis.io", "basePath"=>"api/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/apis"=>{"get"=>{"summary"=>"Get APIS", "description"=>"List all the APIs available", "operationId"=>"getAPIs", "x-api-path-slug"=>"apis-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Fields to be returned in results", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"q", "description"=>"keyword to search for", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APIs"]}, "post"=>{"summary"=>"Add APIs", "description"=>"Adds an API to APIs.io", "operationId"=>"addAPI", "x-api-path-slug"=>"apis-post", "parameters"=>[{"in"=>"query", "name"=>"url", "description"=>"The URL of the APIs", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APIs"]}}, "/search"=>{"get"=>{"summary"=>"Search APIs", "description"=>"Search for apis", "operationId"=>"searchAPIs", "x-api-path-slug"=>"search-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APIs"]}}, "/maintainers"=>{"get"=>{"summary"=>"Get Maintainers", "description"=>"Returns a list of maintainers", "operationId"=>"getMaintainser", "x-api-path-slug"=>"maintainers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APIs"]}}}}, "apis"=>{"name"=>"APIs.io", "x-slug"=>"apis-io", "description"=>"Find all the APIs you need to build your successful projects. APIs.io is the first search engine for APIs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/95-apis-io.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"1028198", "tags"=>"API Provider,API Service Provider,API Tool,Directories,Discovery,Discovery,General Data,internet,Profiles,SaaS,Search,Search engine,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"apis-io/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"APIs.io", "x-api-slug"=>"apis-io", "description"=>"Find all the APIs you need to build your successful projects. APIs.io is the first search engine for APIs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/95-apis-io.jpg", "humanURL"=>"http://apis.io/", "baseURL"=>"http://apis.io/api/", "tags"=>"API Provider,API Service Provider,API Tool,Directories,Discovery,Discovery,General Data,internet,Profiles,SaaS,Search,Search engine,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/apis-io/maintainers-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/apis-io/apis-io-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-api-json--authoritative", "url"=>"http://apis.io/apis.json"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/product/api-search"}, {"type"=>"x-github", "url"=>"https://github.com/apisio"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/apisio"}, {"type"=>"x-website", "url"=>"http://apis.io/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-fusion-tables{"google-fusion-tables-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Fusion Tables", "x-complete"=>1, "info"=>{"title"=>"Fusion Tables", "description"=>"api-for-working-with-fusion-tables-data-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v2"}, "host"=>"www.googleapis.com", "basePath"=>"/fusiontables/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/query"=>{"get"=>{"summary"=>"Execute SQL Statement", "description"=>"Executes a SQL statement which can be any of \n- SELECT\n- SHOW\n- DESCRIBE", "operationId"=>"fusiontables.query.sqlGet", "x-api-path-slug"=>"query-get", "parameters"=>[{"in"=>"query", "name"=>"hdrs", "description"=>"Whether column names are included (in the first row)"}, {"in"=>"query", "name"=>"sql", "description"=>"A SQL statement which can be any of - SELECT- SHOW- DESCRIBE"}, {"in"=>"query", "name"=>"typed", "description"=>"Whether typed values are returned in the (JSON) response: numbers for numeric values and parsed geometries for KML values"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Query"]}, "post"=>{"summary"=>"Execute Fusion Table SQL Statement", "description"=>"Executes a Fusion Tables SQL statement, which can be any of \n- SELECT\n- INSERT\n- UPDATE\n- DELETE\n- SHOW\n- DESCRIBE\n- CREATE statement.", "operationId"=>"fusiontables.query.sql", "x-api-path-slug"=>"query-post", "parameters"=>[{"in"=>"query", "name"=>"hdrs", "description"=>"Whether column names are included in the first row"}, {"in"=>"query", "name"=>"sql", "description"=>"A Fusion Tables SQL statement, which can be any of - SELECT- INSERT- UPDATE- DELETE- SHOW- DESCRIBE- CREATE"}, {"in"=>"query", "name"=>"typed", "description"=>"Whether typed values are returned in the (JSON) response: numbers for numeric values and parsed geometries for KML values"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Query"]}}, "/tables"=>{"get"=>{"summary"=>"Get Tables", "description"=>"Retrieves a list of tables a user owns.", "operationId"=>"fusiontables.table.list", "x-api-path-slug"=>"tables-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of tables to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Continuation token specifying which result page to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}, "post"=>{"summary"=>"Create Table", "description"=>"Creates a new table.", "operationId"=>"fusiontables.table.insert", "x-api-path-slug"=>"tables-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}}, "/tables/import"=>{"post"=>{"summary"=>"Import Table", "description"=>"Imports a new table.", "operationId"=>"fusiontables.table.importTable", "x-api-path-slug"=>"tablesimport-post", "parameters"=>[{"in"=>"query", "name"=>"delimiter", "description"=>"The delimiter used to separate cell values"}, {"in"=>"query", "name"=>"encoding", "description"=>"The encoding of the content"}, {"in"=>"query", "name"=>"name", "description"=>"The name to be assigned to the new table"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}}, "/tables/{tableId}"=>{"delete"=>{"summary"=>"Delete Table", "description"=>"Deletes a table.", "operationId"=>"fusiontables.table.delete", "x-api-path-slug"=>"tablestableid-delete", "parameters"=>[{"in"=>"path", "name"=>"tableId", "description"=>"ID of the table to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}, "get"=>{"summary"=>"Get Table", "description"=>"Retrieves a specific table by its ID.", "operationId"=>"fusiontables.table.get", "x-api-path-slug"=>"tablestableid-get", "parameters"=>[{"in"=>"path", "name"=>"tableId", "description"=>"Identifier for the table being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}, "patch"=>{"summary"=>"Update Table", "description"=>"Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. This method supports patch semantics.", "operationId"=>"fusiontables.table.patch", "x-api-path-slug"=>"tablestableid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"replaceViewDefinition", "description"=>"Whether the view definition is also updated"}, {"in"=>"path", "name"=>"tableId", "description"=>"ID of the table that is being updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}, "put"=>{"summary"=>"Update Table", "description"=>"Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated.", "operationId"=>"fusiontables.table.update", "x-api-path-slug"=>"tablestableid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"replaceViewDefinition", "description"=>"Whether the view definition is also updated"}, {"in"=>"path", "name"=>"tableId", "description"=>"ID of the table that is being updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}}, "/tables/{tableId}/columns"=>{"get"=>{"summary"=>"Get Columns", "description"=>"Retrieves a list of columns.", "operationId"=>"fusiontables.column.list", "x-api-path-slug"=>"tablestableidcolumns-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of columns to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Continuation token specifying which result page to return"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table whose columns are being listed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Column"]}, "post"=>{"summary"=>"Add Column", "description"=>"Adds a new column to the table.", "operationId"=>"fusiontables.column.insert", "x-api-path-slug"=>"tablestableidcolumns-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tableId", "description"=>"Table for which a new column is being added"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Column"]}}, "/tables/{tableId}/columns/{columnId}"=>{"delete"=>{"summary"=>"Delete Column", "description"=>"Deletes the specified column.", "operationId"=>"fusiontables.column.delete", "x-api-path-slug"=>"tablestableidcolumnscolumnid-delete", "parameters"=>[{"in"=>"path", "name"=>"columnId", "description"=>"Name or identifier for the column being deleted"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table from which the column is being deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Column"]}, "get"=>{"summary"=>"Get Column", "description"=>"Retrieves a specific column by its ID.", "operationId"=>"fusiontables.column.get", "x-api-path-slug"=>"tablestableidcolumnscolumnid-get", "parameters"=>[{"in"=>"path", "name"=>"columnId", "description"=>"Name or identifier for the column that is being requested"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table to which the column belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Column"]}, "patch"=>{"summary"=>"Update Column", "description"=>"Updates the name or type of an existing column. This method supports patch semantics.", "operationId"=>"fusiontables.column.patch", "x-api-path-slug"=>"tablestableidcolumnscolumnid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"columnId", "description"=>"Name or identifier for the column that is being updated"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table for which the column is being updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Column"]}, "put"=>{"summary"=>"Update Column", "description"=>"Updates the name or type of an existing column.", "operationId"=>"fusiontables.column.update", "x-api-path-slug"=>"tablestableidcolumnscolumnid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"columnId", "description"=>"Name or identifier for the column that is being updated"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table for which the column is being updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Column"]}}, "/tables/{tableId}/copy"=>{"post"=>{"summary"=>"Copy Table", "description"=>"Copies a table.", "operationId"=>"fusiontables.table.copy", "x-api-path-slug"=>"tablestableidcopy-post", "parameters"=>[{"in"=>"query", "name"=>"copyPresentation", "description"=>"Whether to also copy tabs, styles, and templates"}, {"in"=>"path", "name"=>"tableId", "description"=>"ID of the table that is being copied"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}}, "/tables/{tableId}/import"=>{"post"=>{"summary"=>"import Rows", "description"=>"Imports more rows into a table.", "operationId"=>"fusiontables.table.importRows", "x-api-path-slug"=>"tablestableidimport-post", "parameters"=>[{"in"=>"query", "name"=>"delimiter", "description"=>"The delimiter used to separate cell values"}, {"in"=>"query", "name"=>"encoding", "description"=>"The encoding of the content"}, {"in"=>"query", "name"=>"endLine", "description"=>"The index of the line up to which data will be imported"}, {"in"=>"query", "name"=>"isStrict", "description"=>"Whether the imported CSV must have the same number of values for each row"}, {"in"=>"query", "name"=>"startLine", "description"=>"The index of the first line from which to start importing, inclusive"}, {"in"=>"path", "name"=>"tableId", "description"=>"The table into which new rows are being imported"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}}, "/tables/{tableId}/replace"=>{"post"=>{"summary"=>"Replace Rows", "description"=>"Replaces rows of an existing table. Current rows remain visible until all replacement rows are ready.", "operationId"=>"fusiontables.table.replaceRows", "x-api-path-slug"=>"tablestableidreplace-post", "parameters"=>[{"in"=>"query", "name"=>"delimiter", "description"=>"The delimiter used to separate cell values"}, {"in"=>"query", "name"=>"encoding", "description"=>"The encoding of the content"}, {"in"=>"query", "name"=>"endLine", "description"=>"The index of the line up to which data will be imported"}, {"in"=>"query", "name"=>"isStrict", "description"=>"Whether the imported CSV must have the same number of column values for each row"}, {"in"=>"query", "name"=>"startLine", "description"=>"The index of the first line from which to start importing, inclusive"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table whose rows will be replaced"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}}, "/tables/{tableId}/styles"=>{"get"=>{"summary"=>"Get Styels", "description"=>"Retrieves a list of styles.", "operationId"=>"fusiontables.style.list", "x-api-path-slug"=>"tablestableidstyles-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of styles to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Continuation token specifying which result page to return"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table whose styles are being listed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table Style"]}, "post"=>{"summary"=>"Create Style", "description"=>"Adds a new style for the table.", "operationId"=>"fusiontables.style.insert", "x-api-path-slug"=>"tablestableidstyles-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tableId", "description"=>"Table for which a new style is being added"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table Style"]}}, "/tables/{tableId}/styles/{styleId}"=>{"delete"=>{"summary"=>"Delete Style", "description"=>"Deletes a style.", "operationId"=>"fusiontables.style.delete", "x-api-path-slug"=>"tablestableidstylesstyleid-delete", "parameters"=>[{"in"=>"path", "name"=>"styleId", "description"=>"Identifier (within a table) for the style being deleted"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table from which the style is being deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table Style"]}, "get"=>{"summary"=>"DelGetete Style", "description"=>"Gets a specific style.", "operationId"=>"fusiontables.style.get", "x-api-path-slug"=>"tablestableidstylesstyleid-get", "parameters"=>[{"in"=>"path", "name"=>"styleId", "description"=>"Identifier (integer) for a specific style in a table"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table to which the requested style belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table Style"]}, "patch"=>{"summary"=>"Update Style", "description"=>"Updates an existing style. This method supports patch semantics.", "operationId"=>"fusiontables.style.patch", "x-api-path-slug"=>"tablestableidstylesstyleid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"styleId", "description"=>"Identifier (within a table) for the style being updated"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table whose style is being updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table Style"]}, "put"=>{"summary"=>"Update Style", "description"=>"Updates an existing style.", "operationId"=>"fusiontables.style.update", "x-api-path-slug"=>"tablestableidstylesstyleid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"styleId", "description"=>"Identifier (within a table) for the style being updated"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table whose style is being updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table Style"]}}, "/tables/{tableId}/tasks"=>{"get"=>{"summary"=>"Get Tasks", "description"=>"Retrieves a list of tasks.", "operationId"=>"fusiontables.task.list", "x-api-path-slug"=>"tablestableidtasks-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of tasks to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Continuation token specifying which result page to return"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Index of the first result returned in the current page"}, {"in"=>"path", "name"=>"tableId", "description"=>"Table whose tasks are being listed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task"]}}, "/tables/{tableId}/tasks/{taskId}"=>{"delete"=>{"summary"=>"Delete Task", "description"=>"Deletes a specific task by its ID, unless that task has already started running.", "operationId"=>"fusiontables.task.delete", "x-api-path-slug"=>"tablestableidtaskstaskid-delete", "parameters"=>[{"in"=>"path", "name"=>"tableId", "description"=>"Table from which the task is being deleted"}, {"in"=>"path", "name"=>"taskId", "description"=>"The identifier of the task to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task"]}, "get"=>{"summary"=>"Get Task", "description"=>"Retrieves a specific task by its ID.", "operationId"=>"fusiontables.task.get", "x-api-path-slug"=>"tablestableidtaskstaskid-get", "parameters"=>[{"in"=>"path", "name"=>"tableId", "description"=>"Table to which the task belongs"}, {"in"=>"path", "name"=>"taskId", "description"=>"The identifier of the task to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task"]}}, "/tables/{tableId}/templates"=>{"get"=>{"summary"=>"Get Templates", "description"=>"Retrieves a list of templates.", "operationId"=>"fusiontables.template.list", "x-api-path-slug"=>"tablestableidtemplates-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of templates to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Continuation token specifying which results page to return"}, {"in"=>"path", "name"=>"tableId", "description"=>"Identifier for the table whose templates are being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Template"]}, "post"=>{"summary"=>"Create Template", "description"=>"Creates a new template for the table.", "operationId"=>"fusiontables.template.insert", "x-api-path-slug"=>"tablestableidtemplates-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tableId", "description"=>"Table for which a new template is being created"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Template"]}}, "/tables/{tableId}/templates/{templateId}"=>{"delete"=>{"summary"=>"Delete Template", "description"=>"Deletes a template", "operationId"=>"fusiontables.template.delete", "x-api-path-slug"=>"tablestableidtemplatestemplateid-delete", "parameters"=>[{"in"=>"path", "name"=>"tableId", "description"=>"Table from which the template is being deleted"}, {"in"=>"path", "name"=>"templateId", "description"=>"Identifier for the template which is being deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Template"]}, "get"=>{"summary"=>"Get Template", "description"=>"Retrieves a specific template by its id", "operationId"=>"fusiontables.template.get", "x-api-path-slug"=>"tablestableidtemplatestemplateid-get", "parameters"=>[{"in"=>"path", "name"=>"tableId", "description"=>"Table to which the template belongs"}, {"in"=>"path", "name"=>"templateId", "description"=>"Identifier for the template that is being requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Template"]}, "patch"=>{"summary"=>"Update Template", "description"=>"Updates an existing template. This method supports patch semantics.", "operationId"=>"fusiontables.template.patch", "x-api-path-slug"=>"tablestableidtemplatestemplateid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tableId", "description"=>"Table to which the updated template belongs"}, {"in"=>"path", "name"=>"templateId", "description"=>"Identifier for the template that is being updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Template"]}, "put"=>{"summary"=>"Update Template", "description"=>"Updates an existing template", "operationId"=>"fusiontables.template.update", "x-api-path-slug"=>"tablestableidtemplatestemplateid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tableId", "description"=>"Table to which the updated template belongs"}, {"in"=>"path", "name"=>"templateId", "description"=>"Identifier for the template that is being updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Template"]}}}}, "apis"=>{"name"=>"Google Fusion Tables", "x-slug"=>"google-fusion-tables", "description"=>"Fusion Tables is an experimental data visualization web application to gather, visualize, and share data tables.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-fusion-tables.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Data,Databases,Embeddable,Google APIs,Profiles,Relative Data,Service API,Spreadsheets,Stack Network,Visualizations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-fusion-tables/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Fusion Tables API", "x-api-slug"=>"google-fusion-tables-api", "description"=>"Fusion Tables is an experimental data visualization web application to gather, visualize, and share data tables.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-fusion-tables.jpg", "humanURL"=>"https://developers.google.com/fusiontables/", "baseURL"=>"://www.googleapis.com//fusiontables/v2", "tags"=>"API Provider,API Service Provider,Data,Databases,Embeddable,Google APIs,Profiles,Relative Data,Service API,Spreadsheets,Stack Network,Visualizations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-fusion-tables/google-fusion-tables-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://developers.google.com/fusiontables/docs/v2/reference/"}, {"type"=>"x-forums", "url"=>"https://groups.google.com/forum/#!forum/fusion-tables-api-announce"}, {"type"=>"x-website", "url"=>"https://developers.google.com/fusiontables/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-sheets{"google-sheets-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Sheets", "x-complete"=>1, "info"=>{"title"=>"Google Sheets", "description"=>"reads-and-writes-google-sheets-", "termsOfService"=>"https://developers.google.com/terms/", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v4"}, "host"=>"sheets.googleapis.com", "basePath"=>"v4/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/spreadsheets"=>{"post"=>{"summary"=>"Create Spreadsheet", "description"=>"Creates a spreadsheet, returning the newly created spreadsheet.", "operationId"=>"sheets.spreadsheets.create", "x-api-path-slug"=>"spreadsheets-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}}, "/spreadsheets/{spreadsheetId}"=>{"get"=>{"summary"=>"Get Spreadsheet", "description"=>"Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nURL parameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.\n\nTo retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMultiple ranges can be specified. Limiting the range will\nreturn only the portions of the spreadsheet that intersect the requested\nranges. Ranges are specified using A1 notation.", "operationId"=>"sheets.spreadsheets.get", "x-api-path-slug"=>"spreadsheetsspreadsheetid-get", "parameters"=>[{"in"=>"query", "name"=>"includeGridData", "description"=>"True if grid data should be returned"}, {"in"=>"query", "name"=>"ranges", "description"=>"The ranges to retrieve from the spreadsheet"}, {"in"=>"path", "name"=>"spreadsheetId", "description"=>"The spreadsheet to request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}}, "/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo"=>{"post"=>{"summary"=>"Copy Spreadsheet", "description"=>"Copies a single sheet from a spreadsheet to another spreadsheet.\nReturns the properties of the newly created sheet.", "operationId"=>"sheets.spreadsheets.sheets.copyTo", "x-api-path-slug"=>"spreadsheetsspreadsheetidsheetssheetidcopyto-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"sheetId", "description"=>"The ID of the sheet to copy"}, {"in"=>"path", "name"=>"spreadsheetId", "description"=>"The ID of the spreadsheet containing the sheet to copy"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}}, "/spreadsheets/{spreadsheetId}/values/{range}"=>{"get"=>{"summary"=>"Get Spreadsheet Values", "description"=>"Returns a range of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and a range.", "operationId"=>"sheets.spreadsheets.values.get", "x-api-path-slug"=>"spreadsheetsspreadsheetidvaluesrange-get", "parameters"=>[{"in"=>"query", "name"=>"dateTimeRenderOption", "description"=>"How dates, times, and durations should be represented in the output"}, {"in"=>"query", "name"=>"majorDimension", "description"=>"The major dimension that results should use"}, {"in"=>"path", "name"=>"range", "description"=>"The A1 notation of the values to retrieve"}, {"in"=>"path", "name"=>"spreadsheetId", "description"=>"The ID of the spreadsheet to retrieve data from"}, {"in"=>"query", "name"=>"valueRenderOption", "description"=>"How values should be represented in the output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}, "put"=>{"summary"=>"Get Spreadsheet Values In Range", "description"=>"Sets values in a range of a spreadsheet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption.", "operationId"=>"sheets.spreadsheets.values.update", "x-api-path-slug"=>"spreadsheetsspreadsheetidvaluesrange-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"includeValuesInResponse", "description"=>"Determines if the update response should include the valuesof the cells that were updated"}, {"in"=>"path", "name"=>"range", "description"=>"The A1 notation of the values to update"}, {"in"=>"query", "name"=>"responseDateTimeRenderOption", "description"=>"Determines how dates, times, and durations in the response should berendered"}, {"in"=>"query", "name"=>"responseValueRenderOption", "description"=>"Determines how values in the response should be rendered"}, {"in"=>"path", "name"=>"spreadsheetId", "description"=>"The ID of the spreadsheet to update"}, {"in"=>"query", "name"=>"valueInputOption", "description"=>"How the input data should be interpreted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}}, "/spreadsheets/{spreadsheetId}/values/{range}:append"=>{"post"=>{"summary"=>"Append Values To Spreadsheet", "description"=>"Appends values to a spreadsheet. The input range is used to search for\nexisting data and find a \"table\" within that range. Values will be\nappended to the next row of the table, starting with the first column of\nthe table. See the\n[guide](/sheets/api/guides/values#appending_values)\nand\n[sample code](/sheets/api/samples/writing#append_values)\nfor specific details of how tables are detected and data is appended.\n\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption. The `valueInputOption` only\ncontrols how the input data will be added to the sheet (column-wise or\nrow-wise), it does not influence what cell the data starts being written\nto.", "operationId"=>"sheets.spreadsheets.values.append", "x-api-path-slug"=>"spreadsheetsspreadsheetidvaluesrangeappend-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"includeValuesInResponse", "description"=>"Determines if the update response should include the valuesof the cells that were appended"}, {"in"=>"query", "name"=>"insertDataOption", "description"=>"How the input data should be inserted"}, {"in"=>"path", "name"=>"range", "description"=>"The A1 notation of a range to search for a logical table of data"}, {"in"=>"query", "name"=>"responseDateTimeRenderOption", "description"=>"Determines how dates, times, and durations in the response should berendered"}, {"in"=>"query", "name"=>"responseValueRenderOption", "description"=>"Determines how values in the response should be rendered"}, {"in"=>"path", "name"=>"spreadsheetId", "description"=>"The ID of the spreadsheet to update"}, {"in"=>"query", "name"=>"valueInputOption", "description"=>"How the input data should be interpreted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}}, "/spreadsheets/{spreadsheetId}/values/{range}:clear"=>{"post"=>{"summary"=>"Clear Value From Spreadsheet", "description"=>"Clears values from a spreadsheet.\nThe caller must specify the spreadsheet ID and range.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.", "operationId"=>"sheets.spreadsheets.values.clear", "x-api-path-slug"=>"spreadsheetsspreadsheetidvaluesrangeclear-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"range", "description"=>"The A1 notation of the values to clear"}, {"in"=>"path", "name"=>"spreadsheetId", "description"=>"The ID of the spreadsheet to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}}, "/spreadsheets/{spreadsheetId}/values:batchClear"=>{"post"=>{"summary"=>"Clear Range of Value From Spreasheet", "description"=>"Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.", "operationId"=>"sheets.spreadsheets.values.batchClear", "x-api-path-slug"=>"spreadsheetsspreadsheetidvaluesbatchclear-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"spreadsheetId", "description"=>"The ID of the spreadsheet to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}}, "/spreadsheets/{spreadsheetId}/values:batchGet"=>{"get"=>{"summary"=>"Get Value From Spreadsheet", "description"=>"Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.", "operationId"=>"sheets.spreadsheets.values.batchGet", "x-api-path-slug"=>"spreadsheetsspreadsheetidvaluesbatchget-get", "parameters"=>[{"in"=>"query", "name"=>"dateTimeRenderOption", "description"=>"How dates, times, and durations should be represented in the output"}, {"in"=>"query", "name"=>"majorDimension", "description"=>"The major dimension that results should use"}, {"in"=>"query", "name"=>"ranges", "description"=>"The A1 notation of the values to retrieve"}, {"in"=>"path", "name"=>"spreadsheetId", "description"=>"The ID of the spreadsheet to retrieve data from"}, {"in"=>"query", "name"=>"valueRenderOption", "description"=>"How values should be represented in the output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}}, "/spreadsheets/{spreadsheetId}/values:batchUpdate"=>{"post"=>{"summary"=>"Update Values In Spreadsheet", "description"=>"Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nValueRanges.", "operationId"=>"sheets.spreadsheets.values.batchUpdate", "x-api-path-slug"=>"spreadsheetsspreadsheetidvaluesbatchupdate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"spreadsheetId", "description"=>"The ID of the spreadsheet to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}}, "/spreadsheets/{spreadsheetId}:batchUpdate"=>{"post"=>{"summary"=>"Update Spreadsheet", "description"=>"Spreadsheet", "operationId"=>"sheets.spreadsheets.batchUpdate", "x-api-path-slug"=>"spreadsheetsspreadsheetidbatchupdate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"spreadsheetId", "description"=>"The spreadsheet to apply the updates to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}}, "/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}"=>{"get"=>{"summary"=>"Get Spreadsheet Metadata", "description"=>"Returns the developer metadata with the specified ID.\nThe caller must specify the spreadsheet ID and the developer metadata's\nunique metadataId.", "operationId"=>"sheets.spreadsheets.developerMetadata.get", "x-api-path-slug"=>"spreadsheetsspreadsheetiddevelopermetadatametadataid-get", "parameters"=>[{"in"=>"path", "name"=>"metadataId", "description"=>"The ID of the developer metadata to retrieve"}, {"in"=>"path", "name"=>"spreadsheetId", "description"=>"The ID of the spreadsheet to retrieve metadata from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}}, "/spreadsheets/{spreadsheetId}/developerMetadata:search"=>{"post"=>{"summary"=>"Update Spreadsheet Metadata", "description"=>"Returns all developer metadata matching the specified DataFilter.\nIf the provided DataFilter represents a DeveloperMetadataLookup object,\nthis will return all DeveloperMetadata entries selected by it. If the\nDataFilter represents a location in a spreadsheet, this will return all\ndeveloper metadata associated with locations intersecting that region.", "operationId"=>"sheets.spreadsheets.developerMetadata.search", "x-api-path-slug"=>"spreadsheetsspreadsheetiddevelopermetadatasearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"spreadsheetId", "description"=>"The ID of the spreadsheet to retrieve metadata from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}}, "/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter"=>{"post"=>{"summary"=>"Batch Update of Spreadsheet", "description"=>"Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more\nDataFilters. Ranges matching any of the specified data\nfilters will be cleared. Only values are cleared -- all other properties\nof the cell (such as formatting, data validation, etc..) are kept.", "operationId"=>"sheets.spreadsheets.values.batchClearByDataFilter", "x-api-path-slug"=>"spreadsheetsspreadsheetidvaluesbatchclearbydatafilter-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"spreadsheetId", "description"=>"The ID of the spreadsheet to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}}, "/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter"=>{"post"=>{"summary"=>"Return Spreadsheet Ranges", "description"=>"Returns one or more ranges of values that match the specified data filters.\nThe caller must specify the spreadsheet ID and one or more\nDataFilters. Ranges that match any of the data filters in\nthe request will be returned.", "operationId"=>"sheets.spreadsheets.values.batchGetByDataFilter", "x-api-path-slug"=>"spreadsheetsspreadsheetidvaluesbatchgetbydatafilter-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"spreadsheetId", "description"=>"The ID of the spreadsheet to retrieve data from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}}, "/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter"=>{"post"=>{"summary"=>"Batch Update Spreadsheet", "description"=>"Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nDataFilterValueRanges.", "operationId"=>"sheets.spreadsheets.values.batchUpdateByDataFilter", "x-api-path-slug"=>"spreadsheetsspreadsheetidvaluesbatchupdatebydatafilter-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"spreadsheetId", "description"=>"The ID of the spreadsheet to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}}, "/spreadsheets/{spreadsheetId}:getByDataFilter"=>{"post"=>{"summary"=>"Update Spreadsheets", "description"=>"Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nThis method differs from GetSpreadsheet in that it allows selecting\nwhich subsets of spreadsheet data to return by specifying a\ndataFilters parameter.\nMultiple DataFilters can be specified. Specifying one or\nmore data filters will return the portions of the spreadsheet that\nintersect ranges matched by any of the filters.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nparameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.", "operationId"=>"sheets.spreadsheets.getByDataFilter", "x-api-path-slug"=>"spreadsheetsspreadsheetidgetbydatafilter-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"spreadsheetId", "description"=>"The spreadsheet to request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spreadsheet"]}}}}, "apis"=>{"name"=>"Google Sheets", "x-slug"=>"google-sheets", "description"=>"Google Sheets is an online spreadsheet app that lets users create and format spreadsheets and simultaneously work with other people. Google Sheets isn’t only for consumers: its used every day by businesses and schools to manage spreadsheet data. With the new Sheets API v4 and Sheets add-ons, that data can be accessed by code as well as users.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-sheets-icon.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Data,Documents,Google APIs,Productivity,Profiles,Relative Data,Relative StreamRank,Service API,Spreadsheets,Stack,Stack Network,Streams,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-sheets/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Sheets", "x-api-slug"=>"google-sheets", "description"=>"Google Sheets is an online spreadsheet app that lets users create and format spreadsheets and simultaneously work with other people. Google Sheets isn’t only for consumers: its used every day by businesses and schools to manage spreadsheet data. With the new Sheets API v4 and Sheets add-ons, that data can be accessed by code as well as users.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-sheets-icon.png", "humanURL"=>"https://developers.google.com/sheets/", "baseURL"=>"https://sheets.googleapis.com/v4/", "tags"=>"API Provider,API Service Provider,Data,Documents,Google APIs,Productivity,Profiles,Relative Data,Relative StreamRank,Service API,Spreadsheets,Stack,Stack Network,Streams,Streams,Streams", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-sheets/google-sheets-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://developers.google.com/sheets/api/"}, {"type"=>"x-guides", "url"=>"https://developers.google.com/sheets/api/guides/concepts"}, {"type"=>"x-issues", "url"=>"https://code.google.com/a/google.com/p/apps-api-issues/"}, {"type"=>"x-rate-limits", "url"=>"https://developers.google.com/sheets/api/limits"}, {"type"=>"x-samples", "url"=>"https://developers.google.com/sheets/api/samples/"}, {"type"=>"x-support", "url"=>"https://developers.google.com/sheets/api/support"}, {"type"=>"x-website", "url"=>"https://developers.google.com/sheets/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
backupify{"backupify-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Backupify", "x-complete"=>1, "info"=>{"title"=>"Backupify", "description"=>"the-backupify-api-allows-you-to-integrate-the-leading-saas-backup-solution-into-your-software-making-it-easy-to-give-your-customers-the-data-protection-they-need--", "version"=>"1.0.0"}, "host"=>"api.backupify.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/oauth/token"=>{"post"=>{"summary"=>"Retrieve an Access Token authenticated using the provided client_id and client_secret.", "description"=>"All actions and visibility is limited in scope to items that are descendents of the authenticated vendor and the backup_definitions owned thereby. At this time, all Access Tokens are scoped with full write capabilities.", "operationId"=>"postOauthToken", "x-api-path-slug"=>"oauthtoken-post", "parameters"=>[{"in"=>"formData", "name"=>"client_id", "description"=>"API Client ID"}, {"in"=>"formData", "name"=>"client_secret", "description"=>"API Client secret"}, {"in"=>"formData", "name"=>"grant_type", "description"=>"String identifying the grant type to be used for token retrieval"}, {"in"=>"formData", "name"=>"scope", "description"=>"A space separated list of operational scopes available to the returned token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Oauth", "Token"]}}, "/v1/authenticate_customer"=>{"get"=>{"summary"=>"A simple method to test authentication of a customer access token.", "description"=>"A simple method to test authentication of a customer access token..", "operationId"=>"getV1AuthenticateCustomer", "x-api-path-slug"=>"v1authenticate-customer-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted for customer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Authenticate", "Customer"]}}, "/v1/authenticate_vendor"=>{"get"=>{"summary"=>"A simple method to test authentication of a vendor access token. The response body is empty JSON object.", "description"=>"A simple method to test authentication of a vendor access token. the response body is empty json object..", "operationId"=>"getV1AuthenticateVendor", "x-api-path-slug"=>"v1authenticate-vendor-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client_credentials for vendor"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Authenticate", "Vendor"]}}, "/v1/backup_definitions"=>{"get"=>{"summary"=>"Retrieve an index of all backup_definitions", "description"=>"This will retrieve a list of backup_defintions from all vendors. To view backup_defintions for a particular vendor, see the vendors API. Records are returned in ascending order (by id), with a default of 20 per page. Links to the next, previous, first, and last pages can be found in the response headers.", "operationId"=>"getV1BackupDefinitions", "x-api-path-slug"=>"v1backup-definitions-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"query", "name"=>"vendor_id", "description"=>"Limit backup_definitions returned to those owned by the specified vendor_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Definitions"]}, "post"=>{"summary"=>"Create a new backup_definition", "description"=>"Create a new backup_definition.", "operationId"=>"postV1BackupDefinitions", "x-api-path-slug"=>"v1backup-definitions-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"formData", "name"=>"backup_definition[description]", "description"=>"Description of the backup_definition"}, {"in"=>"formData", "name"=>"backup_definition[name]", "description"=>"Name for the backup_definition"}, {"in"=>"formData", "name"=>"backup_definition[published]", "description"=>"Boolean flag indicating whether the backup definition is published and available for use"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Definitions"]}}, "/v1/backup_definitions/{backup_definition_id}"=>{"get"=>{"summary"=>"Retrieve a backup_definition by backup_definition_id", "description"=>"Only backup_definitions you have permission to view will be returned", "operationId"=>"getV1BackupDefinitionsBackupDefinition", "x-api-path-slug"=>"v1backup-definitionsbackup-definition-id-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_definition_id", "description"=>"ID of the backup_definition to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Definitions", "Backup", "Definition", "Id"]}, "put"=>{"summary"=>"Update the specified backup_definition", "description"=>"Only backup_definitions you have permission to change can be modified", "operationId"=>"putV1BackupDefinitionsBackupDefinition", "x-api-path-slug"=>"v1backup-definitionsbackup-definition-id-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"formData", "name"=>"backup_definition[description]", "description"=>"Description of the backup_definition"}, {"in"=>"formData", "name"=>"backup_definition[name]", "description"=>"Name for the backup_definition"}, {"in"=>"formData", "name"=>"backup_definition[published]", "description"=>"Boolean flag indicating whether the backup definition is published and available for use"}, {"in"=>"path", "name"=>"backup_definition_id", "description"=>"ID of the backup_definition to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Definitions", "Backup", "Definition", "Id"]}}, "/v1/backup_definitions/{backup_definition_id}/variables"=>{"get"=>{"summary"=>"Retrieve a list of variables for the specified backup_definition", "description"=>"You can only retrieve variables for backup_definitions you have access to. Records are returned in ascending order (by id), with a default of 20 per page. Links to the next, previous, first, and last pages can be found in the response headers.", "operationId"=>"getV1BackupDefinitionsBackupDefinitionVariables", "x-api-path-slug"=>"v1backup-definitionsbackup-definition-idvariables-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_definition_id", "description"=>"ID of the backup_definition to retrieve variables for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Definitions", "Backup", "Definition", "Id", "Variables"]}, "post"=>{"summary"=>"Create a new variable for the specified key for the specified backup_definition", "description"=>"It is only possible to create variables for backup_definitions you have permission to manage.", "operationId"=>"postV1BackupDefinitionsBackupDefinitionVariables", "x-api-path-slug"=>"v1backup-definitionsbackup-definition-idvariables-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_definition_id", "description"=>"ID of the backup_definition to create a variable for"}, {"in"=>"formData", "name"=>"variable[default_value]", "description"=>"A default value that can be used when no instance specific value is provided"}, {"in"=>"formData", "name"=>"variable[description]", "description"=>"Description offering additional information or detail about the variable"}, {"in"=>"formData", "name"=>"variable[key]", "description"=>"The symbolic name or identifier to access the defined variable by"}, {"in"=>"formData", "name"=>"variable[name]", "description"=>"A human-friendly name for the variable"}, {"in"=>"formData", "name"=>"variable[optional]", "description"=>"Flag indicating whether this variable is optional or if a value is required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Definitions", "Backup", "Definition", "Id", "Variables"]}}, "/v1/backup_definitions/{backup_definition_id}/variables/{key}"=>{"get"=>{"summary"=>"Retrieve a specific variable by key for the specified backup_definition", "description"=>"You can only retrieve variables for backup_definitions you have access to", "operationId"=>"getV1BackupDefinitionsBackupDefinitionVariablesKey", "x-api-path-slug"=>"v1backup-definitionsbackup-definition-idvariableskey-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_definition_id", "description"=>"ID of the backup_definition to retrieve a variable for"}, {"in"=>"path", "name"=>"key", "description"=>"The key, symbolic name, or identifier of the variable to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Definitions", "Backup", "Definition", "Id", "Variables", "Key"]}, "put"=>{"summary"=>"Update a specific variable by key for the specified backup_definition", "description"=>"You can only update variables for backup_definitions you have access to. Additionally, it is not possible to update a variable's key. Requests including a modified key name will result in an error.", "operationId"=>"putV1BackupDefinitionsBackupDefinitionVariablesKey", "x-api-path-slug"=>"v1backup-definitionsbackup-definition-idvariableskey-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_definition_id", "description"=>"ID of the backup_definition to retrieve a variable for"}, {"in"=>"path", "name"=>"key", "description"=>"The key, symbolic name, or identifier of the variable to update"}, {"in"=>"formData", "name"=>"name", "description"=>"The human-friendly name to use for the variable"}, {"in"=>"formData", "name"=>"variable[default_value]", "description"=>"A default value that can be used when no instance specific value is provided"}, {"in"=>"formData", "name"=>"variable[description]", "description"=>"Description offering additional information or detail about the variable"}, {"in"=>"formData", "name"=>"variable[optional]", "description"=>"Flag indicating whether this variable is optional or if a value is required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Definitions", "Backup", "Definition", "Id", "Variables", "Key"]}}, "/v1/backup_instances"=>{"get"=>{"summary"=>"Retrieves a list of backup_instances associated with the specified backup_definition", "description"=>"It is only possible to retrieve backup_instances for customers you are authorized to access. Records are returned in ascending order (by id), with a default of 20 per page. Links to the next, previous, first, and last pages can be found in the response headers.", "operationId"=>"getV1BackupInstances", "x-api-path-slug"=>"v1backup-instances-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"query", "name"=>"backup_definition_id", "description"=>"ID of the backup_definition to retrieve backup_instances for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances"]}, "post"=>{"summary"=>"Create a new backup_instance from the specified backup_definition for the specified customer", "description"=>"Create a new backup_instance from the specified backup_definition for the specified customer.", "operationId"=>"postV1BackupInstances", "x-api-path-slug"=>"v1backup-instances-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"formData", "name"=>"backup_instance[backup_definition_id]", "description"=>"ID of the backup_definition to create a backup_instance for"}, {"in"=>"formData", "name"=>"backup_instance[backup_frequency]", "description"=>"Frequency with which scheduled backups are performed"}, {"in"=>"formData", "name"=>"backup_instance[customer_id]", "description"=>"ID of the customer to create the backup_instance for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances"]}}, "/v1/backup_instances/{backup_instance_id}"=>{"get"=>{"summary"=>"Retrieve a backup_instance by backup_instance_id", "description"=>"Only backup_instances you have permission to view will be returned", "operationId"=>"getV1BackupInstancesBackupInstance", "x-api-path-slug"=>"v1backup-instancesbackup-instance-id-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id"]}, "put"=>{"summary"=>"Modify the specified backup_instance", "description"=>"Only backup_instances you have permission to change can be modified", "operationId"=>"putV1BackupInstancesBackupInstance", "x-api-path-slug"=>"v1backup-instancesbackup-instance-id-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"formData", "name"=>"backup_instance[backup_frequency]", "description"=>"Frequency with which scheduled backups will be performed"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id"]}}, "/v1/backup_instances/{backup_instance_id}/backups"=>{"get"=>{"summary"=>"Retrieve a list of all backups for the specified backup_instance.", "description"=>"Only backups belonging to backup_instances you have permission to manage can be retrieved. Records are returned in ascending order (by id), with a default of 20 per page. Links to the next, previous, first, and last pages can be found in the response headers.", "operationId"=>"getV1BackupInstancesBackupInstanceBackups", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idbackups-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to backup"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Backups"]}, "post"=>{"summary"=>"Perform an immediate backup of the specified backup_instance", "description"=>"Only backup_instances you have permission to manage can be backed up", "operationId"=>"postV1BackupInstancesBackupInstanceBackups", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idbackups-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to backup"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Backups"]}}, "/v1/backup_instances/{backup_instance_id}/backups/active"=>{"get"=>{"summary"=>"Retrieve the active backup for the specified backup_instance if one exists", "description"=>"Only backups belonging to backup_instances you have permission to access can be retrieved", "operationId"=>"getV1BackupInstancesBackupInstanceBackupsActive", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idbackupsactive-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance the requested backup belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Backups", "Active"]}}, "/v1/backup_instances/{backup_instance_id}/backups/{backup_id}"=>{"get"=>{"summary"=>"Retrieve the specified backup for the specified backup_instance", "description"=>"Only backups belonging to backup_instances you have permission to access can be retrieved", "operationId"=>"getV1BackupInstancesBackupInstanceBackupsBackup", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idbackupsbackup-id-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_id", "description"=>"ID of the backup to retrieve"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance the requested backup belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Backups", "Backup", "Id"]}}, "/v1/backup_instances/{backup_instance_id}/endpoints"=>{"get"=>{"summary"=>"Retrieve a list of endpoints for the specified backup_instance", "description"=>"You can only retrieve endpoints for backup_instances you have access to. Records are returned in ascending order (by id), with a default of 20 per page. Links to the next, previous, first, and last pages can be found in the response headers.", "operationId"=>"getV1BackupInstancesBackupInstanceEndpoints", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idendpoints-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to retrieve an endpoint for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Endpoints"]}}, "/v1/backup_instances/{backup_instance_id}/endpoints/{endpoint_name}"=>{"get"=>{"summary"=>"Retrieve a specific endpoint by name for the specified backup_instance", "description"=>"You can only retrieve endpoints for backup_instances you have access to", "operationId"=>"getV1BackupInstancesBackupInstanceEndpointsEndpointName", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idendpointsendpoint-name-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to retrieve an endpoint for"}, {"in"=>"path", "name"=>"endpoint_name", "description"=>"The name of the endpoint to retrieve as defined by the backup_definition of the specified backup_instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Endpoints", "Endpoint", "Name"]}}, "/v1/backup_instances/{backup_instance_id}/endpoints/{endpoint_name}/records"=>{"get"=>{"summary"=>"Retrieve a list of records stored for the specified endpoint and backup_instance", "description"=>"You can only retrieve records for endpoints that belong to backup_instances you have access to. Records are returned in ascending order (by id), with a default of 20 per page. Links to the next, previous, first, and last pages can be found in the response headers.", "operationId"=>"getV1BackupInstancesBackupInstanceEndpointsEndpointNameRecords", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idendpointsendpoint-namerecords-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to retrieve an endpoint for"}, {"in"=>"path", "name"=>"endpoint_name", "description"=>"ID of the endpoint to retrieve records for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Endpoints", "Endpoint", "Name", "Records"]}}, "/v1/backup_instances/{backup_instance_id}/endpoints/{endpoint_name}/records/{record_id}"=>{"get"=>{"summary"=>"Retrieve a specific record by id for the specified endpoint and backup_instance", "description"=>"You can only retrieve records for endpoints of backup_instances you have access to", "operationId"=>"getV1BackupInstancesBackupInstanceEndpointsEndpointNameRecordsRecord", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idendpointsendpoint-namerecordsrecord-id-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to retrieve an endpoint for"}, {"in"=>"path", "name"=>"endpoint_name", "description"=>"The name of the endpoint to retrieve the record from"}, {"in"=>"path", "name"=>"record_id", "description"=>"The id of the endpoint record to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Endpoints", "Endpoint", "Name", "Records", "Record", "Id"]}}, "/v1/backup_instances/{backup_instance_id}/endpoints/{endpoint_name}/records/{record_id}/blob"=>{"get"=>{"summary"=>"Retrieve the blob associated with the specified record for the specified endpoint and backup_instance", "description"=>"Retrieve the blob associated with the specified record for the specified endpoint and backup_instance.", "operationId"=>"getV1BackupInstancesBackupInstanceEndpointsEndpointNameRecordsRecordBlob", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idendpointsendpoint-namerecordsrecord-idblob-get", "parameters"=>[{"in"=>"header", "name"=>"Access-Token", "description"=>"Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to retrieve an endpoint for"}, {"in"=>"path", "name"=>"endpoint_name", "description"=>"The name of the endpoint to retrieve the record from"}, {"in"=>"path", "name"=>"record_id", "description"=>"The id of the endpoint record the blob belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Endpoints", "Endpoint", "Name", "Records", "Record", "Id", "Blob"]}}, "/v1/backup_instances/{backup_instance_id}/exports"=>{"get"=>{"summary"=>"Retrieve a list of exports for the specified backup_instance", "description"=>"You can only retrieve exports for backup_instances you have access to. Records are returned in ascending order (by id), with a default of 20 per page. Links to the next, previous, first, and last pages can be found in the response headers.", "operationId"=>"getV1BackupInstancesBackupInstanceExports", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idexports-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to retrieve exports for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Exports"]}, "post"=>{"summary"=>"Perform an export of the most recent backup of the specified backup_instance", "description"=>"Perform an export of the most recent backup of the specified backup_instance.", "operationId"=>"postV1BackupInstancesBackupInstanceExports", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idexports-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to export"}, {"in"=>"formData", "name"=>"export_run[backup_run_id]", "description"=>"ID of a specific backup_run to export"}, {"in"=>"formData", "name"=>"export_run[content_types]", "description"=>"Comma separated list of blob content-types to export"}, {"in"=>"formData", "name"=>"export_run[export_datetime]", "description"=>"Date (format: YYYY-MM-DD) from which to export"}, {"in"=>"formData", "name"=>"export_run[export_formats]", "description"=>"Comma separated list of export format options"}, {"in"=>"formData", "name"=>"export_run[force_full]", "description"=>"Flag to force a full export, as opposed to re-authorizing an old export if the data is the same"}, {"in"=>"formData", "name"=>"export_run[send_confirmation]", "description"=>"Flag to send a confirmation email w/export link upon completion"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Exports"]}}, "/v1/backup_instances/{backup_instance_id}/exports/{export_id}"=>{"get"=>{"summary"=>"Retrieve a specific export for the specified backup_instance", "description"=>"You can only retrieve exports for backup_instances you have access to", "operationId"=>"getV1BackupInstancesBackupInstanceExportsExport", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idexportsexport-id-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to retrieve an export for"}, {"in"=>"path", "name"=>"export_id", "description"=>"ID of the export to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Exports", "Export", "Id"]}}, "/v1/backup_instances/{backup_instance_id}/exports/{export_id}/reauth"=>{"post"=>{"summary"=>"Retrieve an updated exported_data_url for a specific export for the specified backup_instance", "description"=>"Retrieve an updated exported_data_url for a specific export for the specified backup_instance.", "operationId"=>"postV1BackupInstancesBackupInstanceExportsExportReauth", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idexportsexport-idreauth-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to retrieve an export for"}, {"in"=>"path", "name"=>"export_id", "description"=>"ID of the export to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Exports", "Export", "Id", "Reauth"]}}, "/v1/backup_instances/{backup_instance_id}/logs"=>{"get"=>{"summary"=>"Returns the logs for a given backup instance", "description"=>"Returns the logs for a given backup instance.", "operationId"=>"getV1BackupInstancesBackupInstanceLogs", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idlogs-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to pull logs for"}, {"in"=>"query", "name"=>"date", "description"=>"Date (format: YYYY-MM-DD) for which to fetch logs (default: today)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Logs"]}}, "/v1/backup_instances/{backup_instance_id}/logs/{scroll_id}"=>{"get"=>{"summary"=>"Returns the logs for a given backup instance", "description"=>"Returns the logs for a given backup instance.", "operationId"=>"getV1BackupInstancesBackupInstanceLogsScroll", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idlogsscroll-id-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to pull logs for"}, {"in"=>"path", "name"=>"scroll_id", "description"=>"scroll_id for pagination"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Logs", "Scroll", "Id"]}}, "/v1/backup_instances/{backup_instance_id}/variables"=>{"get"=>{"summary"=>"Retrieve a list of variables for the specified backup_instance", "description"=>"You can only retrieve variables for backup_instances you have access to. Records are returned in ascending order (by id), with a default of 20 per page. Links to the next, previous, first, and last pages can be found in the response headers.", "operationId"=>"getV1BackupInstancesBackupInstanceVariables", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idvariables-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to retrieve variables for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Variables"]}, "post"=>{"summary"=>"Create a custom variable value for the specified key for the specified backup_instance", "description"=>"The key specified must refer to the key of a previously defined backup_definition variable. It is only possible to create variables for backup_instances you have permission to manage.", "operationId"=>"postV1BackupInstancesBackupInstanceVariables", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idvariables-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to create a variable for"}, {"in"=>"formData", "name"=>"variable[key]", "description"=>"The key, as defined by the backup_definition, to set a value for"}, {"in"=>"formData", "name"=>"variable[value]", "description"=>"The value or information to store for the specified key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Variables"]}}, "/v1/backup_instances/{backup_instance_id}/variables/{key}"=>{"get"=>{"summary"=>"Retrieve a specific variable by key for the specified backup_instance", "description"=>"You can only retrieve variables for backup_instances you have access to", "operationId"=>"getV1BackupInstancesBackupInstanceVariablesKey", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idvariableskey-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to retrieve a variable for"}, {"in"=>"path", "name"=>"key", "description"=>"The key of the variable to retrieve as defined by the backup_definition of the specified backup_instance"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Variables", "Key"]}, "put"=>{"summary"=>"Update the value of a variable by key for the specified backup_instance", "description"=>"You can only alter variables for backup_instances you have access to manage", "operationId"=>"putV1BackupInstancesBackupInstanceVariablesKey", "x-api-path-slug"=>"v1backup-instancesbackup-instance-idvariableskey-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"backup_instance_id", "description"=>"ID of the backup_instance to update a variable for"}, {"in"=>"path", "name"=>"key", "description"=>"The key of the variable to update as defined by the backup_definition of the specified backup_instance"}, {"in"=>"formData", "name"=>"variable[value]", "description"=>"The updated data to store at the specified key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Backup", "Instances", "Backup", "Instance", "Id", "Variables", "Key"]}}, "/v1/customers"=>{"get"=>{"summary"=>"Retrieve a list of customers associated with the authenticated vendor", "description"=>"Requires Access Token granted from client credentials. Records are returned in ascending order (by id), with a default of 20 per page. Links to the next, previous, first, and last pages can be found in the response headers.", "operationId"=>"getV1Customers", "x-api-path-slug"=>"v1customers-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Customers"]}, "post"=>{"summary"=>"Create a new customer instance identified by the given {name} identifier", "description"=>"Create a new customer instance identified by the given {name} identifier.", "operationId"=>"postV1Customers", "x-api-path-slug"=>"v1customers-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"formData", "name"=>"customer[email]", "description"=>"Email address associated with the customer"}, {"in"=>"formData", "name"=>"customer[name]", "description"=>"Vendor provided ID uniquely identifying customer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Customers"]}}, "/v1/customers/{customer_id}"=>{"get"=>{"summary"=>"Retrieves the customer identified by customer_id", "description"=>"Requires Access Token granted from client credentials.", "operationId"=>"getV1CustomersCustomer", "x-api-path-slug"=>"v1customerscustomer-id-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"customer_id", "description"=>"ID of the customer to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Customers", "Customer", "Id"]}, "put"=>{"summary"=>"Update a customer instance identified by the given customer_id", "description"=>"Update a customer instance identified by the given customer_id.", "operationId"=>"putV1CustomersCustomer", "x-api-path-slug"=>"v1customerscustomer-id-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"formData", "name"=>"customer[name]", "description"=>"Vendor provided ID uniquely identifying customer"}, {"in"=>"path", "name"=>"customer_id", "description"=>"ID of the customer to modify"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Customers", "Customer", "Id"]}}, "/v1/customers/{customer_id}/backup_instances"=>{"get"=>{"summary"=>"Retrieves a list of backup_instances associated with the specified customer", "description"=>"It is only possible to retrieve backup_instances for customers you are authorized to access. Records are returned in ascending order (by id), with a default of 20 per page. Links to the next, previous, first, and last pages can be found in the response headers.", "operationId"=>"getV1CustomersCustomerBackupInstances", "x-api-path-slug"=>"v1customerscustomer-idbackup-instances-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}, {"in"=>"path", "name"=>"customer_id", "description"=>"ID of the customer to retrieve backup_instances for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Customers", "Customer", "Id", "Backup", "Instances"]}}, "/v1/ping"=>{"get"=>{"summary"=>"A simple method that returns a 200 response if the connection succeeds", "description"=>"A simple method that returns a 200 response if the connection succeeds.", "operationId"=>"getV1Ping", "x-api-path-slug"=>"v1ping-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Ping"]}}, "/v1/vendors/me"=>{"get"=>{"summary"=>"Provides information about the currently authenticated vendor user", "description"=>"Provides information about the currently authenticated vendor user.", "operationId"=>"getV1VendorsMe", "x-api-path-slug"=>"v1vendorsme-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer Access Token granted from client credentials authorizing vendor to perform action"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["V1", "Vendors", "Me"]}}}}, "apis"=>{"name"=>"Backupify", "x-slug"=>"backupify", "description"=>"", "image"=>"", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Not Found,API Provider,Backups,Profiles,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"backupify/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Backupify", "x-api-slug"=>"backupify", "description"=>"Backupify is a backup service for SaaS accounts. Backupify can help users backup their SaaS accounts and restore if and when needed. Backupify offers a developers program for developers to access and integrate the functionality of Backupify with other applications. Public documentation is not available; interested developers should sign up here for more information on the developers program: https://www.backupify.com/solutions/developers or email developerprogram@backupify.com.", "image"=>"", "humanURL"=>"http://backupify.com", "baseURL"=>"https://api.backupify.com//", "tags"=>"API Not Found,API Provider,Backups,Profiles,Relative Data,Service API", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/backupify/v1vendorsme-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/backupify/backupify-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://www.backupify.com/blog"}, {"type"=>"x-website", "url"=>"http://backupify.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-plus{"google-plus-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Plus", "x-complete"=>1, "info"=>{"title"=>"Google Plus", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/activities"=>{"get"=>{"summary"=>"Get Activities", "description"=>"Search public activities.", "operationId"=>"plus.activities.search", "x-api-path-slug"=>"activities-get", "parameters"=>[{"in"=>"query", "name"=>"language", "description"=>"Specify the preferred language to search with"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of activities to include in the response, which is used for paging"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Specifies how to order search results"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The continuation token, which is used to page through large result sets"}, {"in"=>"query", "name"=>"query", "description"=>"Full-text search query string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity"]}}, "/activities/{activityId}"=>{"get"=>{"summary"=>"Get Activity", "description"=>"Get an activity.", "operationId"=>"plusDomains.activities.get", "x-api-path-slug"=>"activitiesactivityid-get", "parameters"=>[{"in"=>"path", "name"=>"activityId", "description"=>"The ID of the activity to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity"]}}, "/activities/{activityId}/comments"=>{"get"=>{"summary"=>"Get Activity Commenets", "description"=>"List all of the comments for an activity.", "operationId"=>"plusDomains.comments.list", "x-api-path-slug"=>"activitiesactivityidcomments-get", "parameters"=>[{"in"=>"path", "name"=>"activityId", "description"=>"The ID of the activity to get comments for"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of comments to include in the response, which is used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The continuation token, which is used to page through large result sets"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"The order in which to sort the list of comments"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity"]}, "post"=>{"summary"=>"Create Activity Comment", "description"=>"Create a new comment in reply to an activity.", "operationId"=>"plusDomains.comments.insert", "x-api-path-slug"=>"activitiesactivityidcomments-post", "parameters"=>[{"in"=>"path", "name"=>"activityId", "description"=>"The ID of the activity to reply to"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity"]}}, "/activities/{activityId}/people/{collection}"=>{"get"=>{"summary"=>"Get People In Collection", "description"=>"List all of the people in the specified collection for a particular activity.", "operationId"=>"plusDomains.people.listByActivity", "x-api-path-slug"=>"activitiesactivityidpeoplecollection-get", "parameters"=>[{"in"=>"path", "name"=>"activityId", "description"=>"The ID of the activity to get the list of people for"}, {"in"=>"path", "name"=>"collection", "description"=>"The collection of people to list"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of people to include in the response, which is used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The continuation token, which is used to page through large result sets"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Person"]}}, "/comments/{commentId}"=>{"get"=>{"summary"=>"Get Comment", "description"=>"Get a comment.", "operationId"=>"plusDomains.comments.get", "x-api-path-slug"=>"commentscommentid-get", "parameters"=>[{"in"=>"path", "name"=>"commentId", "description"=>"The ID of the comment to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment"]}}, "/people"=>{"get"=>{"summary"=>"Get People", "description"=>"Search all public profiles.", "operationId"=>"plus.people.search", "x-api-path-slug"=>"people-get", "parameters"=>[{"in"=>"query", "name"=>"language", "description"=>"Specify the preferred language to search with"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of people to include in the response, which is used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The continuation token, which is used to page through large result sets"}, {"in"=>"query", "name"=>"query", "description"=>"Specify a query string for full text search of public text in all profiles"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Person"]}}, "/people/{userId}"=>{"get"=>{"summary"=>"Get Person Profile", "description"=>"Get a person's profile.", "operationId"=>"plusDomains.people.get", "x-api-path-slug"=>"peopleuserid-get", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"The ID of the person to get the profile for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Person"]}}, "/people/{userId}/activities/{collection}"=>{"get"=>{"summary"=>"Get Activities", "description"=>"List all of the activities in the specified collection for a particular user.", "operationId"=>"plusDomains.activities.list", "x-api-path-slug"=>"peopleuseridactivitiescollection-get", "parameters"=>[{"in"=>"path", "name"=>"collection", "description"=>"The collection of activities to list"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of activities to include in the response, which is used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The continuation token, which is used to page through large result sets"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user to get activities for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity"]}}, "/people/{userId}/people/{collection}"=>{"get"=>{"summary"=>"Get People In Collection", "description"=>"List all of the people in the specified collection.", "operationId"=>"plusDomains.people.list", "x-api-path-slug"=>"peopleuseridpeoplecollection-get", "parameters"=>[{"in"=>"path", "name"=>"collection", "description"=>"The collection of people to list"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of people to include in the response, which is used for paging"}, {"in"=>"query", "name"=>"orderBy", "description"=>"The order to return people in"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The continuation token, which is used to page through large result sets"}, {"in"=>"path", "name"=>"userId", "description"=>"Get the collection of people for the person identified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Person"]}}, "/circles/{circleId}"=>{"delete"=>{"summary"=>"Delete Circle", "description"=>"Delete a circle.", "operationId"=>"plusDomains.circles.remove", "x-api-path-slug"=>"circlescircleid-delete", "parameters"=>[{"in"=>"path", "name"=>"circleId", "description"=>"The ID of the circle to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Circle"]}, "get"=>{"summary"=>"Get Circle", "description"=>"Get a circle.", "operationId"=>"plusDomains.circles.get", "x-api-path-slug"=>"circlescircleid-get", "parameters"=>[{"in"=>"path", "name"=>"circleId", "description"=>"The ID of the circle to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Circle"]}, "patch"=>{"summary"=>"Update Circle", "description"=>"Update a circle's description. This method supports patch semantics.", "operationId"=>"plusDomains.circles.patch", "x-api-path-slug"=>"circlescircleid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"circleId", "description"=>"The ID of the circle to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Circle"]}, "put"=>{"summary"=>"Update Circle", "description"=>"Update a circle's description.", "operationId"=>"plusDomains.circles.update", "x-api-path-slug"=>"circlescircleid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"circleId", "description"=>"The ID of the circle to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Circle"]}}, "/circles/{circleId}/people"=>{"delete"=>{"summary"=>"Delete Circle", "description"=>"Remove a person from a circle.", "operationId"=>"plusDomains.circles.removePeople", "x-api-path-slug"=>"circlescircleidpeople-delete", "parameters"=>[{"in"=>"path", "name"=>"circleId", "description"=>"The ID of the circle to remove the person from"}, {"in"=>"query", "name"=>"email", "description"=>"Email of the people to add to the circle"}, {"in"=>"query", "name"=>"userId", "description"=>"IDs of the people to remove from the circle"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Circle"]}, "get"=>{"summary"=>"Get People in Circle", "description"=>"List all of the people who are members of a circle.", "operationId"=>"plusDomains.people.listByCircle", "x-api-path-slug"=>"circlescircleidpeople-get", "parameters"=>[{"in"=>"path", "name"=>"circleId", "description"=>"The ID of the circle to get the members of"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of people to include in the response, which is used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The continuation token, which is used to page through large result sets"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Person"]}, "put"=>{"summary"=>"Update People in Circle", "description"=>"Add a person to a circle. Google+ limits certain circle operations, including the number of circle adds. Learn More.", "operationId"=>"plusDomains.circles.addPeople", "x-api-path-slug"=>"circlescircleidpeople-put", "parameters"=>[{"in"=>"path", "name"=>"circleId", "description"=>"The ID of the circle to add the person to"}, {"in"=>"query", "name"=>"email", "description"=>"Email of the people to add to the circle"}, {"in"=>"query", "name"=>"userId", "description"=>"IDs of the people to add to the circle"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Person"]}}, "/people/{userId}/activities"=>{"post"=>{"summary"=>"Create Activity", "description"=>"Create a new activity for the authenticated user.", "operationId"=>"plusDomains.activities.insert", "x-api-path-slug"=>"peopleuseridactivities-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"preview", "description"=>"If true, extract the potential media attachments for a URL"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user to create the activity on behalf of"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity"]}}, "/people/{userId}/audiences"=>{"get"=>{"summary"=>"Get Audience", "description"=>"List all of the audiences to which a user can share.", "operationId"=>"plusDomains.audiences.list", "x-api-path-slug"=>"peopleuseridaudiences-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of circles to include in the response, which is used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The continuation token, which is used to page through large result sets"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user to get audiences for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audience"]}}, "/people/{userId}/circles"=>{"get"=>{"summary"=>"Get Circles", "description"=>"List all of the circles for a user.", "operationId"=>"plusDomains.circles.list", "x-api-path-slug"=>"peopleuseridcircles-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of circles to include in the response, which is used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The continuation token, which is used to page through large result sets"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user to get circles for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Circle"]}, "post"=>{"summary"=>"Create New Circle", "description"=>"Create a new circle for the authenticated user.", "operationId"=>"plusDomains.circles.insert", "x-api-path-slug"=>"peopleuseridcircles-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user to create the circle on behalf of"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Circle"]}}, "/people/{userId}/media/{collection}"=>{"post"=>{"summary"=>"Add Media To Collection", "description"=>"Add a new media item to an album. The current upload size limitations are 36MB for a photo and 1GB for a video. Uploads do not count against quota if photos are less than 2048 pixels on their longest side or videos are less than 15 minutes in length.", "operationId"=>"plusDomains.media.insert", "x-api-path-slug"=>"peopleuseridmediacollection-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"collection"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user to create the activity on behalf of"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media"]}}}}, "apis"=>{"name"=>"Google Plus", "x-slug"=>"google-plus", "description"=>"Create a more engaging experience and connect with more users by integrating social into your web site. Show profile information, and relevant content and connections from circles. Let visitors recommend and share your content, and prompt friends to take specific actions on your site.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-plus.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Domains,Google APIs,Profiles,Relative Data,Service API,Social,Social Networks,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-plus/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Plus", "x-api-slug"=>"google-plus", "description"=>"Create a more engaging experience and connect with more users by integrating social into your web site. Show profile information, and relevant content and connections from circles. Let visitors recommend and share your content, and prompt friends to take specific actions on your site.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-plus.png", "humanURL"=>"https://plus.google.com/", "baseURL"=>"https:///", "tags"=>"API Provider,API Service Provider,Domains,Google APIs,Profiles,Relative Data,Service API,Social,Social Networks,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-plus/google-plus-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-badges", "url"=>"https://developers.google.com/+/web/badge/"}, {"type"=>"x-buttons", "url"=>"https://developers.google.com/+/web/+1button/"}, {"type"=>"x-change-log", "url"=>"https://developers.google.com/+/web/release-notes"}, {"type"=>"x-code", "url"=>"https://developers.google.com/+/web/samples/javascript"}, {"type"=>"x-developer", "url"=>"https://developers.google.com/+/web/api/rest/"}, {"type"=>"x-documentation", "url"=>"https://developers.google.com/+/web/api/rest/latest/"}, {"type"=>"x-issues", "url"=>"https://code.google.com/p/google-plus-platform/"}, {"type"=>"x-support", "url"=>"https://developers.google.com/+/web/support"}, {"type"=>"x-terms-of-service", "url"=>"https://developers.google.com/+/web/terms"}, {"type"=>"x-website", "url"=>"https://plus.google.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-ec2-container-service{"amazon-ec2-container-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS EC2 Container Service", "x-complete"=>1, "info"=>{"title"=>"AWS EC2 Container Service API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=CreateCluster"=>{"get"=>{"summary"=>"Create Cluster", "description"=>"Creates a new Amazon ECS cluster.", "operationId"=>"createCluster", "x-api-path-slug"=>"actioncreatecluster-get", "parameters"=>[{"in"=>"query", "name"=>"clusterName", "description"=>"The name of your cluster", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=CreateService"=>{"get"=>{"summary"=>"Create Service", "description"=>"Runs and maintains a desired number of tasks from a specified task definition.", "operationId"=>"createService", "x-api-path-slug"=>"actioncreateservice-get", "parameters"=>[{"in"=>"query", "name"=>"clientToken", "description"=>"Unique, case-sensitive identifier you provide to ensure the idempotency of the request", "type"=>"string"}, {"in"=>"query", "name"=>"cluster", "description"=>"The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service", "type"=>"string"}, {"in"=>"query", "name"=>"deploymentConfiguration", "description"=>"Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks", "type"=>"string"}, {"in"=>"query", "name"=>"desiredCount", "description"=>"The number of instantiations of the specified task definition to place and keep running on your cluster", "type"=>"string"}, {"in"=>"query", "name"=>"loadBalancers", "description"=>"A load balancer object representing the load balancer to use with your service", "type"=>"string"}, {"in"=>"query", "name"=>"placementConstraints", "description"=>"An array of placement constraint objects to use for tasks in your service", "type"=>"string"}, {"in"=>"query", "name"=>"placementStrategy", "description"=>"The placement strategy objects to use for tasks in your service", "type"=>"string"}, {"in"=>"query", "name"=>"role", "description"=>"The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf", "type"=>"string"}, {"in"=>"query", "name"=>"serviceName", "description"=>"The name of your service", "type"=>"string"}, {"in"=>"query", "name"=>"taskDefinition", "description"=>"The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run in your service", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/?Action=DeleteAttributes"=>{"get"=>{"summary"=>"Delete Attributes", "description"=>"Deletes one or more custom attributes from an Amazon ECS resource.", "operationId"=>"deleteAttributes", "x-api-path-slug"=>"actiondeleteattributes-get", "parameters"=>[{"in"=>"query", "name"=>"attributes", "description"=>"The attributes to delete from your resource", "type"=>"string"}, {"in"=>"query", "name"=>"cluster", "description"=>"The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attributes"]}}, "/?Action=DeleteCluster"=>{"get"=>{"summary"=>"Delete Cluster", "description"=>"Deletes the specified cluster.", "operationId"=>"deleteCluster", "x-api-path-slug"=>"actiondeletecluster-get", "parameters"=>[{"in"=>"query", "name"=>"cluster", "description"=>"The short name or full Amazon Resource Name (ARN) of the cluster to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=DeleteService"=>{"get"=>{"summary"=>"Delete Service", "description"=>"Deletes a specified service within a cluster.", "operationId"=>"deleteService", "x-api-path-slug"=>"actiondeleteservice-get", "parameters"=>[{"in"=>"query", "name"=>"cluster", "description"=>"The name of the cluster that hosts the service to delete", "type"=>"string"}, {"in"=>"query", "name"=>"service", "description"=>"The name of the service to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/?Action=DeregisterContainerInstance"=>{"get"=>{"summary"=>"Deregister Container Instance", "description"=>"Deregisters an Amazon ECS container instance from the specified cluster.", "operationId"=>"deregisterContainerInstance", "x-api-path-slug"=>"actionderegistercontainerinstance-get", "parameters"=>[{"in"=>"query", "name"=>"cluster", "description"=>"The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister", "type"=>"string"}, {"in"=>"query", "name"=>"containerInstance", "description"=>"The container instance ID or full Amazon Resource Name (ARN) of the container instance to deregister", "type"=>"string"}, {"in"=>"query", "name"=>"force", "description"=>"Forces the deregistration of the container instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Instances"]}}, "/?Action=DeregisterTaskDefinition"=>{"get"=>{"summary"=>"Deregister Task Definition", "description"=>"Deregisters the specified task definition by family and revision.", "operationId"=>"deregisterTaskDefinition", "x-api-path-slug"=>"actionderegistertaskdefinition-get", "parameters"=>[{"in"=>"query", "name"=>"taskDefinition", "description"=>"The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task Definitions"]}}, "/?Action=DescribeClusters"=>{"get"=>{"summary"=>"Describe Clusters", "description"=>"Describes one or more of your clusters.", "operationId"=>"describeClusters", "x-api-path-slug"=>"actiondescribeclusters-get", "parameters"=>[{"in"=>"query", "name"=>"clusters", "description"=>"A space-separated list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=DescribeContainerInstances"=>{"get"=>{"summary"=>"Describe Container Instances", "description"=>"Describes Amazon EC2 Container Service container instances.", "operationId"=>"describeContainerInstances", "x-api-path-slug"=>"actiondescribecontainerinstances-get", "parameters"=>[{"in"=>"query", "name"=>"cluster", "description"=>"The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe", "type"=>"string"}, {"in"=>"query", "name"=>"containerInstances", "description"=>"A space-separated list of container instance IDs or full Amazon Resource Name (ARN) entries", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Instances"]}}, "/?Action=DescribeServices"=>{"get"=>{"summary"=>"Describe Services", "description"=>"Describes the specified services running in your cluster.", "operationId"=>"describeServices", "x-api-path-slug"=>"actiondescribeservices-get", "parameters"=>[{"in"=>"query", "name"=>"cluster", "description"=>"The name of the cluster that hosts the service to describe", "type"=>"string"}, {"in"=>"query", "name"=>"services", "description"=>"A list of services to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/?Action=DescribeTaskDefinition"=>{"get"=>{"summary"=>"Describe Task Definition", "description"=>"Describes a task definition.", "operationId"=>"describeTaskDefinition", "x-api-path-slug"=>"actiondescribetaskdefinition-get", "parameters"=>[{"in"=>"query", "name"=>"taskDefinition", "description"=>"The family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task Definitions"]}}, "/?Action=DescribeTasks"=>{"get"=>{"summary"=>"Describe Tasks", "description"=>"Describes a specified task or tasks.", "operationId"=>"describeTasks", "x-api-path-slug"=>"actiondescribetasks-get", "parameters"=>[{"in"=>"query", "name"=>"cluster", "description"=>"The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to describe", "type"=>"string"}, {"in"=>"query", "name"=>"tasks", "description"=>"A space-separated list of task IDs or full Amazon Resource Name (ARN) entries", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks"]}}, "/?Action=DiscoverPollEndpoint"=>{"get"=>{"summary"=>"Discover Poll Endpoint", "description"=>"This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.", "operationId"=>"discoverPollEndpoint", "x-api-path-slug"=>"actiondiscoverpollendpoint-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Poll Endpoints"]}}, "/?Action=ListAttributes"=>{"get"=>{"summary"=>"List Attributes", "description"=>"Lists the attributes for Amazon ECS resources within a specified target type and\n cluster.", "operationId"=>"listAttributes", "x-api-path-slug"=>"actionlistattributes-get", "parameters"=>[{"in"=>"query", "name"=>"attributeName", "description"=>"The name of the attribute with which to filter the results", "type"=>"string"}, {"in"=>"query", "name"=>"attributeValue", "description"=>"The value of the attribute with which to filter results", "type"=>"string"}, {"in"=>"query", "name"=>"cluster", "description"=>"The short name or full Amazon Resource Name (ARN) of the cluster to list attributes", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of cluster results returned by ListAttributes in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The nextToken value returned from a previous paginated ListAttributes request where maxResults was used and the results exceeded the value of that parameter", "type"=>"string"}, {"in"=>"query", "name"=>"targetType", "description"=>"The type of the target with which to list attributes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attributes"]}}, "/?Action=ListClusters"=>{"get"=>{"summary"=>"List Clusters", "description"=>"Returns a list of existing clusters.", "operationId"=>"listClusters", "x-api-path-slug"=>"actionlistclusters-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of cluster results returned by ListClusters in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=ListContainerInstances"=>{"get"=>{"summary"=>"List Container Instances", "description"=>"Returns a list of container instances in a specified cluster.", "operationId"=>"listContainerInstances", "x-api-path-slug"=>"actionlistcontainerinstances-get", "parameters"=>[{"in"=>"query", "name"=>"cluster", "description"=>"The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list", "type"=>"string"}, {"in"=>"query", "name"=>"filter", "description"=>"You can filter the results of a ListContainerInstances operation with cluster query language statements", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of container instance results returned by ListContainerInstances in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Instances"]}}, "/?Action=ListServices"=>{"get"=>{"summary"=>"List Services", "description"=>"Lists the services that are running in a specified cluster.", "operationId"=>"listServices", "x-api-path-slug"=>"actionlistservices-get", "parameters"=>[{"in"=>"query", "name"=>"cluster", "description"=>"The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of container instance results returned by ListServices in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The nextToken value returned from a previous paginated ListServices request where maxResults was used and the results exceeded the value of that parameter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/?Action=ListTaskDefinitionFamilies"=>{"get"=>{"summary"=>"List Task Definition Families", "description"=>"Returns a list of task definition families that are registered to your account\n (which may include task definition families that no longer have any ACTIVE\n task definition revisions).", "operationId"=>"listTaskDefinitionFamilies", "x-api-path-slug"=>"actionlisttaskdefinitionfamilies-get", "parameters"=>[{"in"=>"query", "name"=>"familyPrefix", "description"=>"The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The nextToken value returned from a previous paginated ListTaskDefinitionFamilies request where maxResults was used and the results exceeded the value of that parameter", "type"=>"string"}, {"in"=>"query", "name"=>"status", "description"=>"The task definition family status with which to filter the ListTaskDefinitionFamilies results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task Definition Families"]}}, "/?Action=ListTaskDefinitions"=>{"get"=>{"summary"=>"List Task Definitions", "description"=>"Returns a list of task definitions that are registered to your account.", "operationId"=>"listTaskDefinitions", "x-api-path-slug"=>"actionlisttaskdefinitions-get", "parameters"=>[{"in"=>"query", "name"=>"familyPrefix", "description"=>"The full family name with which to filter the ListTaskDefinitions results", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of task definition results returned by ListTaskDefinitions in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The nextToken value returned from a previous paginated ListTaskDefinitions request where maxResults was used and the results exceeded the value of that parameter", "type"=>"string"}, {"in"=>"query", "name"=>"sort", "description"=>"The order in which to sort the results", "type"=>"string"}, {"in"=>"query", "name"=>"status", "description"=>"The task definition status with which to filter the ListTaskDefinitions results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task Definitions"]}}, "/?Action=ListTasks"=>{"get"=>{"summary"=>"List Tasks", "description"=>"Returns a list of tasks for a specified cluster.", "operationId"=>"listTasks", "x-api-path-slug"=>"actionlisttasks-get", "parameters"=>[{"in"=>"query", "name"=>"cluster", "description"=>"The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list", "type"=>"string"}, {"in"=>"query", "name"=>"containerInstance", "description"=>"The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter the ListTasks results", "type"=>"string"}, {"in"=>"query", "name"=>"desiredStatus", "description"=>"The task desired status with which to filter the ListTasks results", "type"=>"string"}, {"in"=>"query", "name"=>"family", "description"=>"The name of the family with which to filter the ListTasks results", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of task results returned by ListTasks in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The nextToken value returned from a previous paginated ListTasks request where maxResults was used and the results exceeded the value of that parameter", "type"=>"string"}, {"in"=>"query", "name"=>"serviceName", "description"=>"The name of the service with which to filter the ListTasks results", "type"=>"string"}, {"in"=>"query", "name"=>"startedBy", "description"=>"The startedBy value with which to filter the task results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks"]}}, "/?Action=PutAttributes"=>{"get"=>{"summary"=>"Put Attributes", "description"=>"Create or update an attribute on an Amazon ECS resource.", "operationId"=>"putAttributes", "x-api-path-slug"=>"actionputattributes-get", "parameters"=>[{"in"=>"query", "name"=>"attributes", "description"=>"The attributes to apply to your resource", "type"=>"string"}, {"in"=>"query", "name"=>"cluster", "description"=>"The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attributes"]}}, "/?Action=RegisterContainerInstance"=>{"get"=>{"summary"=>"Register Container Instance", "description"=>"Deregisters an Amazon ECS container instance from the specified cluster.", "operationId"=>"registerContainerInstance", "x-api-path-slug"=>"actionregistercontainerinstance-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Instances"]}}, "/?Action=RegisterTaskDefinition"=>{"get"=>{"summary"=>"Register Task Definition", "description"=>"Registers a new task definition from the supplied family and\n containerDefinitions.", "operationId"=>"registerTaskDefinition", "x-api-path-slug"=>"actionregistertaskdefinition-get", "parameters"=>[{"in"=>"query", "name"=>"containerDefinitions", "description"=>"A list of container definitions in JSON format that describe the different containers that make up your task", "type"=>"string"}, {"in"=>"query", "name"=>"family", "description"=>"You must specify a family for a task definition, which allows you to track multiple versions of the same task definition", "type"=>"string"}, {"in"=>"query", "name"=>"networkMode", "description"=>"The Docker networking mode to use for the containers in the task", "type"=>"string"}, {"in"=>"query", "name"=>"placementConstraints", "description"=>"An array of placement constraint objects to use for the task", "type"=>"string"}, {"in"=>"query", "name"=>"taskRoleArn", "description"=>"The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume", "type"=>"string"}, {"in"=>"query", "name"=>"volumes", "description"=>"A list of volume definitions in JSON format that containers in your task may use", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task Definitions"]}}, "/?Action=RunTask"=>{"get"=>{"summary"=>"Run Task", "description"=>"Starts a new task using the specified task definition.", "operationId"=>"runTask", "x-api-path-slug"=>"actionruntask-get", "parameters"=>[{"in"=>"query", "name"=>"cluster", "description"=>"The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"The number of instantiations of the specified task to place on your cluster", "type"=>"string"}, {"in"=>"query", "name"=>"group", "description"=>"The name of the task group to associate with the task", "type"=>"string"}, {"in"=>"query", "name"=>"overrides", "description"=>"A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive", "type"=>"string"}, {"in"=>"query", "name"=>"placementConstraints", "description"=>"An array of placement constraint objects to use for the task", "type"=>"string"}, {"in"=>"query", "name"=>"placementStrategy", "description"=>"The placement strategy objects to use for the task", "type"=>"string"}, {"in"=>"query", "name"=>"startedBy", "description"=>"An optional tag specified when a task is started", "type"=>"string"}, {"in"=>"query", "name"=>"taskDefinition", "description"=>"The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks"]}}, "/?Action=StartTask"=>{"get"=>{"summary"=>"Start Task", "description"=>"Starts a new task from the specified task definition on the specified container\n instance or instances.", "operationId"=>"startTask", "x-api-path-slug"=>"actionstarttask-get", "parameters"=>[{"in"=>"query", "name"=>"cluster", "description"=>"The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task", "type"=>"string"}, {"in"=>"query", "name"=>"containerInstances", "description"=>"The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task", "type"=>"string"}, {"in"=>"query", "name"=>"group", "description"=>"The name of the task group to associate with the task", "type"=>"string"}, {"in"=>"query", "name"=>"overrides", "description"=>"A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive", "type"=>"string"}, {"in"=>"query", "name"=>"startedBy", "description"=>"An optional tag specified when a task is started", "type"=>"string"}, {"in"=>"query", "name"=>"taskDefinition", "description"=>"The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to start", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks"]}}, "/?Action=StopTask"=>{"get"=>{"summary"=>"Stop Task", "description"=>"Stops a running task.", "operationId"=>"stopTask", "x-api-path-slug"=>"actionstoptask-get", "parameters"=>[{"in"=>"query", "name"=>"cluster", "description"=>"The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop", "type"=>"string"}, {"in"=>"query", "name"=>"reason", "description"=>"An optional message specified when a task is stopped", "type"=>"string"}, {"in"=>"query", "name"=>"task", "description"=>"The task ID or full Amazon Resource Name (ARN) entry of the task to stop", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tasks"]}}, "/?Action=SubmitContainerStateChange"=>{"get"=>{"summary"=>"Submit Container State Change", "description"=>"This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.", "operationId"=>"submitContainerStateChange", "x-api-path-slug"=>"actionsubmitcontainerstatechange-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Container State Change"]}}, "/?Action=SubmitTaskStateChange"=>{"get"=>{"summary"=>"Submit Task State Change", "description"=>"This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.", "operationId"=>"submitTaskStateChange", "x-api-path-slug"=>"actionsubmittaskstatechange-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task State Change"]}}, "/?Action=UpdateContainerAgent"=>{"get"=>{"summary"=>"Update Container Agent", "description"=>"Updates the Amazon ECS container agent on a specified container instance.", "operationId"=>"updateContainerAgent", "x-api-path-slug"=>"actionupdatecontaineragent-get", "parameters"=>[{"in"=>"query", "name"=>"cluster", "description"=>"The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on", "type"=>"string"}, {"in"=>"query", "name"=>"containerInstance", "description"=>"The container instance ID or full Amazon Resource Name (ARN) entries for the container instance on which you would like to update the Amazon ECS container agent", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Agents"]}}, "/?Action=UpdateService"=>{"get"=>{"summary"=>"Update Service", "description"=>"Modifies the desired count, deployment configuration, or task definition used in a\n service.", "operationId"=>"updateService", "x-api-path-slug"=>"actionupdateservice-get", "parameters"=>[{"in"=>"query", "name"=>"cluster", "description"=>"The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on", "type"=>"string"}, {"in"=>"query", "name"=>"deploymentConfiguration", "description"=>"Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks", "type"=>"string"}, {"in"=>"query", "name"=>"desiredCount", "description"=>"The number of instantiations of the task to place and keep running in your service", "type"=>"string"}, {"in"=>"query", "name"=>"service", "description"=>"The name of the service to update", "type"=>"string"}, {"in"=>"query", "name"=>"taskDefinition", "description"=>"The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run in your service", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}}}, "apis"=>{"name"=>"AWS EC2 Container Service", "x-slug"=>"aws-ec2-container-service", "description"=>"Amazon EC2 Container Service (ECS) is a highly scalable, high performance container management service that supports Docker containers and allows you to easily run applications on a managed cluster of Amazon EC2 instances. Amazon ECS eliminates the need for you to install, operate, and scale your own cluster management infrastructure. With simple API calls, you can launch and stop Docker-enabled applications, query the complete state of your cluster, and access many familiar features like security groups, Elastic Load Balancing, EBS volumes, and IAM roles. You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs and availability requirements. You can also integrate your own scheduler or third-party schedulers to meet business or application specific requirements.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_AmazonECS.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Containers,Deployments,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-ec2-container-service/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Amazon EC2 Container Service API", "x-api-slug"=>"amazon-ec2-container-service-api", "description"=>"Amazon EC2 Container Service (ECS) is a highly scalable, high performance container management service that supports Docker containers and allows you to easily run applications on a managed cluster of Amazon EC2 instances. Amazon ECS eliminates the need for you to install, operate, and scale your own cluster management infrastructure. With simple API calls, you can launch and stop Docker-enabled applications, query the complete state of your cluster, and access many familiar features like security groups, Elastic Load Balancing, EBS volumes, and IAM roles. You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs and availability requirements. You can also integrate your own scheduler or third-party schedulers to meet business or application specific requirements.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_AmazonECS.png", "humanURL"=>"https://aws.amazon.com/ecs/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Containers,Deployments,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-ec2-container-service/amazon-ec2-container-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/AmazonECS/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/ecs/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/ecs/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/ecs/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
zendesk{"zendesk-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Zendesk", "x-complete"=>1, "info"=>{"title"=>"Swagger API", "version"=>"1.0.0"}, "host"=>"{host}.zendesk.com", "basePath"=>"/api/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/tickets.json"=>{"post"=>{"summary"=>"createTicket", "description"=>"Create Ticket", "operationId"=>"TicketsJsonPost", "x-api-path-slug"=>"tickets-json-post", "parameters"=>[{"in"=>"body", "name"=>"ticket", "description"=>"Ticket", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Support", "Tickets"]}}}}, "apis"=>{"name"=>"Zendesk", "x-slug"=>"zendesk", "description"=>"Customer service software and support ticketing system by Zendesk. Cloud-based help desk solution used by more than 200,000 organizations worldwide. Free 30-day trial.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/283-zendesk.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"402", "tags"=>"API LIfeyclessss,Helpdesk,Interent,Profiles,Relative Data,SaaS,Service API,Stack Network,Support,Support,Support,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"zendesk/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Zendesk", "x-api-slug"=>"zendesk", "description"=>"Customer service software and support ticketing system by Zendesk. Cloud-based help desk solution used by more than 200,000 organizations worldwide. Free 30-day trial.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/283-zendesk.jpg", "humanURL"=>"http://www.zendesk.com/", "baseURL"=>"https://{host}.zendesk.com//api/v2/", "tags"=>"API LIfeyclessss,Helpdesk,Interent,Profiles,Relative Data,SaaS,Service API,Stack Network,Support,Support,Support,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/zendesk/zendesk-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://zendesk.com/api/"}, {"type"=>"x-blog", "url"=>"http://www.zendesk.com/blog"}, {"type"=>"x-blog-rss", "url"=>"http://www.zendesk.com/feed"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/zendesk"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/zendesk"}, {"type"=>"x-developer", "url"=>"https://developer.zendesk.com/"}, {"type"=>"x-email", "url"=>"support@zendesk.com"}, {"type"=>"x-email", "url"=>"legal@zendesk.com"}, {"type"=>"x-email", "url"=>"ip@zendesk.com"}, {"type"=>"x-email", "url"=>"privacy@zendesk.com"}, {"type"=>"x-email", "url"=>"press@zendesk.com"}, {"type"=>"x-faq", "url"=>"https://gemini24.zendesk.com/hc/en-us"}, {"type"=>"x-github", "url"=>"https://github.com/zendesk"}, {"type"=>"x-pricing", "url"=>"https://www.zendesk.com/product/pricing/"}, {"type"=>"x-support", "url"=>"https://genexus.zendesk.com/hc/en-us"}, {"type"=>"x-support", "url"=>"https://gemini24.zendesk.com/hc/en-us/requests/new"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/zendesk"}, {"type"=>"x-website", "url"=>"http://www.zendesk.com/"}, {"type"=>"x-website", "url"=>"http://desk.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-appstream{"aws-appstream-2-0-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS AppStream", "x-complete"=>1, "info"=>{"title"=>"AWS AppStream 2.0 API", "description"=>"amazon-appstream-2-0-is-a-fully-managed-secure-application-streaming-service-that-allows-you-to-stream-desktop-applications-from-aws-to-any-device-running-a-web-browser-without-rewriting-them--amazon-appstream-2-0-provides-users-instanton-access-to-the-applications-they-need-and-a-responsive-fluid-user-experience-on-the-device-of-their-choice-", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AssociateFleet"=>{"get"=>{"summary"=>"Associate Fleet", "description"=>"Associate a fleet to a stack.", "operationId"=>"AssociateFleet", "x-api-path-slug"=>"actionassociatefleet-get", "parameters"=>[{"in"=>"query", "name"=>"FleetName", "description"=>"The name of the fleet to associate", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The name of the stack to which the fleet is associated", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fleet"]}}, "/?Action=CreateFleet"=>{"get"=>{"summary"=>"Create Fleet", "description"=>"Creates a new fleet.", "operationId"=>"CreateFleet", "x-api-path-slug"=>"actioncreatefleet-get", "parameters"=>[{"in"=>"query", "name"=>"ComputeCapacity", "description"=>"The parameters for the capacity allocated to the fleet", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"The description of the fleet", "type"=>"string"}, {"in"=>"query", "name"=>"DisconnectTimeoutInSeconds", "description"=>"The time after disconnection when a session is considered to have ended", "type"=>"string"}, {"in"=>"query", "name"=>"DisplayName", "description"=>"The display name of the fleet", "type"=>"string"}, {"in"=>"query", "name"=>"ImageName", "description"=>"Unique name of the image used by the fleet", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceType", "description"=>"The instance type of compute resources for the fleet", "type"=>"string"}, {"in"=>"query", "name"=>"MaxUserDurationInSeconds", "description"=>"The maximum time up to which a streaming session can run", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"A unique identifier for the fleet", "type"=>"string"}, {"in"=>"query", "name"=>"VpcConfig", "description"=>"The VPC configuration for the fleet", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fleet"]}}, "/?Action=CreateStack"=>{"get"=>{"summary"=>"Create Stack", "description"=>"Create a new stack.", "operationId"=>"CreateStack", "x-api-path-slug"=>"actioncreatestack-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"The description displayed to end users on the AppStream 2", "type"=>"string"}, {"in"=>"query", "name"=>"DisplayName", "description"=>"The name displayed to end users on the AppStream 2", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The unique identifier for this stack", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fleet"]}}, "/?Action=CreateStreamingURL"=>{"get"=>{"summary"=>"Create Streaming URL", "description"=>"Creates a URL to start an AppStream 2.", "operationId"=>"CreateStreamingURL", "x-api-path-slug"=>"actioncreatestreamingurl-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationId", "description"=>"The ID of the application that must be launched after the session starts", "type"=>"string"}, {"in"=>"query", "name"=>"FleetName", "description"=>"The fleet for which the URL is generated", "type"=>"string"}, {"in"=>"query", "name"=>"SessionContext", "description"=>"The sessionContext of the streaming URL", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The stack for which the URL is generated", "type"=>"string"}, {"in"=>"query", "name"=>"UserId", "description"=>"A unique user ID for whom the URL is generated", "type"=>"string"}, {"in"=>"query", "name"=>"Validity", "description"=>"The validity duration of the URL in seconds", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["URL"]}}, "/?Action=DeleteFleet"=>{"get"=>{"summary"=>"Delete Fleet", "description"=>"Deletes a fleet.", "operationId"=>"DeleteFleet", "x-api-path-slug"=>"actiondeletefleet-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"The name of the fleet to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fleet"]}}, "/?Action=DeleteStack"=>{"get"=>{"summary"=>"Delete Stack", "description"=>"Deletes the stack.", "operationId"=>"DeleteStack", "x-api-path-slug"=>"actiondeletestack-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"The name of the stack to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stack"]}}, "/?Action=DescribeFleets"=>{"get"=>{"summary"=>"Describe Fleets", "description"=>"If fleet names are provided, this operation describes the specified fleets;\n otherwise, all the fleets in the account are described.", "operationId"=>"DescribeFleets", "x-api-path-slug"=>"actiondescribefleets-get", "parameters"=>[{"in"=>"query", "name"=>"Names", "description"=>"The fleet names to describe", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The pagination token to use to retrieve the next page of results for this operation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fleet"]}}, "/?Action=DescribeImages"=>{"get"=>{"summary"=>"Describe Images", "description"=>"Describes the images.", "operationId"=>"DescribeImages", "x-api-path-slug"=>"actiondescribeimages-get", "parameters"=>[{"in"=>"query", "name"=>"Names", "description"=>"A specific list of images to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images"]}}, "/?Action=DescribeSessions"=>{"get"=>{"summary"=>"Describe Sessions", "description"=>"Describes the streaming sessions for a stack and a fleet.", "operationId"=>"DescribeSessions", "x-api-path-slug"=>"actiondescribesessions-get", "parameters"=>[{"in"=>"query", "name"=>"FleetName", "description"=>"The name of the fleet for which to list sessions", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The size of each page of results", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The pagination token to use to retrieve the next page of results for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The name of the stack for which to list sessions", "type"=>"string"}, {"in"=>"query", "name"=>"UserId", "description"=>"The user for whom to list sessions", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions"]}}, "/?Action=DescribeStacks"=>{"get"=>{"summary"=>"Describe Stacks", "description"=>"If stack names are not provided, this operation describes the specified stacks;\n otherwise, all stacks in the account are described.", "operationId"=>"DescribeStacks", "x-api-path-slug"=>"actiondescribestacks-get", "parameters"=>[{"in"=>"query", "name"=>"Names", "description"=>"The stack names to describe", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The pagination token to use to retrieve the next page of results for this operation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stacks"]}}, "/?Action=DisassociateFleet"=>{"get"=>{"summary"=>"Disassociate Fleet", "description"=>"Disassociates a fleet from a stack.", "operationId"=>"DisassociateFleet", "x-api-path-slug"=>"actiondisassociatefleet-get", "parameters"=>[{"in"=>"query", "name"=>"FleetName", "description"=>"The name of the fleet to disassociate", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The name of the stack with which the fleet is associated", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fleet"]}}, "/?Action=ExpireSession"=>{"get"=>{"summary"=>"Expire Session", "description"=>"This operation immediately stops a streaming session.", "operationId"=>"ExpireSession", "x-api-path-slug"=>"actionexpiresession-get", "parameters"=>[{"in"=>"query", "name"=>"SessionId", "description"=>"The unique identifier of the streaming session to be stopped", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session"]}}, "/?Action=ListAssociatedFleets"=>{"get"=>{"summary"=>"List Associated Fleets", "description"=>"Lists all fleets associated with the stack.", "operationId"=>"ListAssociatedFleets", "x-api-path-slug"=>"actionlistassociatedfleets-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"The pagination token to use to retrieve the next page of results for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The name of the stack whose associated fleets are listed", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fleet"]}}, "/?Action=ListAssociatedStacks"=>{"get"=>{"summary"=>"List Associated Stacks", "description"=>"Lists all stacks to which the specified fleet is associated.", "operationId"=>"ListAssociatedStacks", "x-api-path-slug"=>"actionlistassociatedstacks-get", "parameters"=>[{"in"=>"query", "name"=>"FleetName", "description"=>"The name of the fleet whose associated stacks are listed", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The pagination token to use to retrieve the next page of results for this operation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stack"]}}, "/?Action=StartFleet"=>{"get"=>{"summary"=>"Start Fleet", "description"=>"Starts a fleet.", "operationId"=>"StartFleet", "x-api-path-slug"=>"actionstartfleet-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"The name of the fleet to start", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fleet"]}}, "/?Action=StopFleet"=>{"get"=>{"summary"=>"Stop Fleet", "description"=>"Stops a fleet.", "operationId"=>"StopFleet", "x-api-path-slug"=>"actionstopfleet-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"The name of the fleet to stop", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fleet"]}}, "/?Action=UpdateFleet"=>{"get"=>{"summary"=>"Update Fleet", "description"=>"Updates an existing fleet.", "operationId"=>"UpdateFleet", "x-api-path-slug"=>"actionupdatefleet-get", "parameters"=>[{"in"=>"query", "name"=>"ComputeCapacity", "description"=>"The parameters for the capacity allocated to the fleet", "type"=>"string"}, {"in"=>"query", "name"=>"DeleteVpcConfig", "description"=>"Delete the VPC association for the specified fleet", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"The description displayed to end users on the AppStream 2", "type"=>"string"}, {"in"=>"query", "name"=>"DisconnectTimeoutInSeconds", "description"=>"The time after disconnection when a session is considered to have ended", "type"=>"string"}, {"in"=>"query", "name"=>"DisplayName", "description"=>"The name displayed to end users on the AppStream 2", "type"=>"string"}, {"in"=>"query", "name"=>"ImageName", "description"=>"The image name from which a fleet is created", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceType", "description"=>"The instance type of compute resources for the fleet", "type"=>"string"}, {"in"=>"query", "name"=>"MaxUserDurationInSeconds", "description"=>"The maximum time during which a streaming session can run", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the fleet", "type"=>"string"}, {"in"=>"query", "name"=>"VpcConfig", "description"=>"The VPC configuration for the fleet", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fleet"]}}, "/?Action=UpdateStack"=>{"get"=>{"summary"=>"Update Stack", "description"=>"Updates the specified fields in the stack with the specified name.", "operationId"=>"UpdateStack", "x-api-path-slug"=>"actionupdatestack-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"The description displayed to end users on the AppStream 2", "type"=>"string"}, {"in"=>"query", "name"=>"DisplayName", "description"=>"The name displayed to end users on the AppStream 2", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the stack to update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stack"]}}}}, "apis"=>{"name"=>"AWS AppStream", "x-slug"=>"aws-appstream", "description"=>"Amazon AppStream is a fully managed, secure application streaming service that allows you to stream desktop applications from AWS to any device running a web browser, without rewriting them. Amazon AppStream 2.0 provides users instant-on access to the applications they need, and a responsive, fluid user experience on the device of their choice.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/appstream2_try_it_now_2_big.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Applications,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-appstream/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS AppStream 2.0 API", "x-api-slug"=>"aws-appstream-2-0-api", "description"=>"Amazon AppStream 2.0 is a fully managed, secure application streaming service that allows you to stream desktop applications from AWS to any device running a web browser, without rewriting them. Amazon AppStream 2.0 provides users instant-on access to the applications they need, and a responsive, fluid user experience on the device of their choice.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/appstream2_try_it_now_2_big.png", "humanURL"=>"https://aws.amazon.com/appstream2/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Applications,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-appstream/actionupdatestack-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-appstream/aws-appstream-2-0-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/appstream2/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/appstream2/faqs/"}, {"type"=>"x-forum", "url"=>"https://aws.amazon.com/appstream2/resources/#forum"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/appstream2/resources/#getting_starte"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/appstream2/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/appstream2/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
elastic-email{"elastic-email-smtp-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Elastic Email", "x-complete"=>1, "info"=>{"title"=>"Elastic Email SMTP API", "description"=>"api-for-sending-and-management-email-", "version"=>"v1"}, "host"=>"api.elasticemail.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"attachments/upload/"=>{"get"=>{"summary"=>"Upload Attachment", "description"=>"The upload attachment command is used to upload an attachment for sending.", "operationId"=>"getAttachmentsUpload", "x-api-path-slug"=>"attachmentsupload-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"your api key"}, {"in"=>"query", "name"=>"file", "description"=>"The file name being uploaded"}, {"in"=>"query", "name"=>"username", "description"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachments", "Upload"]}}, "lists/add-contact"=>{"get"=>{"summary"=>"Add Existing Subscriber To List", "description"=>"Add Existing Subscriber To List", "operationId"=>"getListsAddContact", "x-api-path-slug"=>"listsaddcontact-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API Key"}, {"in"=>"query", "name"=>"listname", "description"=>"name of list you wish to add subscriber to (separate by semi-colon to add to multiple lists)"}, {"in"=>"query", "name"=>"username", "description"=>"Your user name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Add", "Contact"]}}, "lists/create-contact"=>{"get"=>{"summary"=>"Create New Subscriber", "description"=>"Create New Subscriber", "operationId"=>"getListsCreateContact", "x-api-path-slug"=>"listscreatecontact-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"your api key found on the Account screen"}, {"in"=>"query", "name"=>"birthdate", "description"=>"date of birth of the subscriber"}, {"in"=>"query", "name"=>"city", "description"=>"city of the subscriber"}, {"in"=>"query", "name"=>"country", "description"=>"country of the subscriber"}, {"in"=>"query", "name"=>"email", "description"=>"email address of subscriber/recipient"}, {"in"=>"query", "name"=>"firstname", "description"=>"first name of the subscriber"}, {"in"=>"query", "name"=>"gender", "description"=>"male or female"}, {"in"=>"query", "name"=>"lastname", "description"=>"last name of the subscriber"}, {"in"=>"query", "name"=>"listname", "description"=>"the name of the list or lists (separated by semi-colon) the subscriber will be added to - if blank, it will just create the subscriber"}, {"in"=>"query", "name"=>"organizationname", "description"=>"organization name the subscriber works for"}, {"in"=>"query", "name"=>"phone", "description"=>"phone number for the subscriber"}, {"in"=>"query", "name"=>"postalcode", "description"=>"the zip or postal code of the subscriber"}, {"in"=>"query", "name"=>"state", "description"=>"the state or province for the subscriber"}, {"in"=>"query", "name"=>"the zip or postal code of the subscriber", "description"=>"Your user name"}, {"in"=>"query", "name"=>"title", "description"=>"the title for the subscriber (Mr"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Create", "Contact"]}}, "lists/create-lists"=>{"get"=>{"summary"=>"Create New List", "description"=>"Create New List", "operationId"=>"getListsCreateLists", "x-api-path-slug"=>"listscreatelists-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API Key"}, {"in"=>"query", "name"=>"listname", "description"=>"name of list you wish to create"}, {"in"=>"query", "name"=>"username", "description"=>"Your user name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Create", "Lists"]}}, "lists/delete"=>{"get"=>{"summary"=>"Delete Existing List", "description"=>"Delete Existing List", "operationId"=>"getListsDelete", "x-api-path-slug"=>"listsdelete-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API Key"}, {"in"=>"query", "name"=>"listname", "description"=>"name of list you wish to delete"}, {"in"=>"query", "name"=>"username", "description"=>"Your user name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Delete"]}}, "lists/delete-contact"=>{"get"=>{"summary"=>"Delete Existing Subscriber", "description"=>"Delete Existing Subscriber", "operationId"=>"getListsDeleteContact", "x-api-path-slug"=>"listsdeletecontact-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API Key"}, {"in"=>"query", "name"=>"email", "description"=>"email address of subscriber/recipient (separate by semi-colon to remove multiple)"}, {"in"=>"query", "name"=>"username", "description"=>"Your user name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Delete", "Contact"]}}, "lists/remove-contact"=>{"get"=>{"summary"=>"Remove Existing Subscriber From List", "description"=>"Remove Existing Subscriber From List", "operationId"=>"getListsRemoveContact", "x-api-path-slug"=>"listsremovecontact-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API Key"}, {"in"=>"query", "name"=>"listname", "description"=>"name of list you wish to remove subscriber from (separate by semi-colon to remove from multiple lists)"}, {"in"=>"query", "name"=>"username", "description"=>"Your user name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Remove", "Contact"]}}, "lists/upload-contacts"=>{"get"=>{"summary"=>"Create Multiple Subscriber From CSV File", "description"=>"Create Multiple Subscriber From CSV File", "operationId"=>"getListsUploadContacts", "x-api-path-slug"=>"listsuploadcontacts-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API Key"}, {"in"=>"query", "name"=>"birthdate", "description"=>"date of birth of the subscriber"}, {"in"=>"query", "name"=>"city", "description"=>"city of the subscriber"}, {"in"=>"query", "name"=>"country", "description"=>"country of the subscriber"}, {"in"=>"query", "name"=>"email", "description"=>"email address of subscriber/recipient"}, {"in"=>"query", "name"=>"firstname", "description"=>"first name of the subscriber"}, {"in"=>"query", "name"=>"gender", "description"=>"male or female"}, {"in"=>"query", "name"=>"lastname", "description"=>"last name of the subscriber"}, {"in"=>"query", "name"=>"listname", "description"=>"the name of the list or lists (separated by semi-colon) the subscriber will be added to - if blank, it will just create the subscriber"}, {"in"=>"query", "name"=>"organizationname", "description"=>"organization name the subscriber works for"}, {"in"=>"query", "name"=>"phone", "description"=>"phone number for the subscriber"}, {"in"=>"query", "name"=>"postalcode", "description"=>"the zip or postal code of the subscriber"}, {"in"=>"query", "name"=>"state", "description"=>"the state or province for the subscriber"}, {"in"=>"query", "name"=>"title", "description"=>"the title for the subscriber (Mr"}, {"in"=>"query", "name"=>"username", "description"=>"Your user name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "Upload", "Contacts"]}}, "mailer/account-details"=>{"get"=>{"summary"=>"Account Details", "description"=>"The Account Details command is used to determine how much credit you have left.", "operationId"=>"getMailerAccountDetails", "x-api-path-slug"=>"maileraccountdetails-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API Key"}, {"in"=>"query", "name"=>"username", "description"=>"Your user name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mailer", "Account", "Details"]}}, "mailer/channel/delete"=>{"get"=>{"summary"=>"Deleting Channel", "description"=>"Deleting Channel", "operationId"=>"getMailerChannelDelete", "x-api-path-slug"=>"mailerchanneldelete-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API Key"}, {"in"=>"query", "name"=>"format", "description"=>"csv or xml"}, {"in"=>"query", "name"=>"name", "description"=>"channel name to delete"}, {"in"=>"query", "name"=>"username", "description"=>"Your user name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mailer", "Channel", "Delete"]}}, "mailer/channel/list"=>{"get"=>{"summary"=>"Listing of Active Channels", "description"=>"Listing of Active Channels", "operationId"=>"getMailerChannelList", "x-api-path-slug"=>"mailerchannellist-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API Key"}, {"in"=>"query", "name"=>"format", "description"=>"csv or xml"}, {"in"=>"query", "name"=>"username", "description"=>"Your user name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mailer", "Channel", "List"]}}, "mailer/list/bounced"=>{"get"=>{"summary"=>"Bounced", "description"=>"This api will return you the list of email addresses which are currently in your block list.", "operationId"=>"getMailerListBounced", "x-api-path-slug"=>"mailerlistbounced-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API Key"}, {"in"=>"query", "name"=>"username", "description"=>"Your user name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mailer", "List", "Bounced"]}}, "mailer/list/complaint"=>{"get"=>{"summary"=>"Complaint", "description"=>"This api will return you the list of email addresses which are currently in your block list.", "operationId"=>"getMailerListComplaint", "x-api-path-slug"=>"mailerlistcomplaint-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API Key"}, {"in"=>"query", "name"=>"username", "description"=>"Your user name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mailer", "List", "Complaint"]}}, "mailer/lists/unsubscribed"=>{"get"=>{"summary"=>"Unsubscribed", "description"=>"This api will return you the list of email addresses which are currently in your block list.", "operationId"=>"getMailerListsUnsubscribed", "x-api-path-slug"=>"mailerlistsunsubscribed-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API Key"}, {"in"=>"query", "name"=>"username", "description"=>"Your user name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mailer", "Lists", "Unsubscribed"]}}, "mailer/send/"=>{"get"=>{"summary"=>"Send Email", "description"=>"api.elasticemail.com", "operationId"=>"getMailerSend", "x-api-path-slug"=>"mailersend-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"your api key"}, {"in"=>"query", "name"=>"body_html", "description"=>"html email body"}, {"in"=>"query", "name"=>"body_text", "description"=>"text email body"}, {"in"=>"query", "name"=>"channel", "description"=>"an id field (max 60 chars) that can be used for reporting"}, {"in"=>"query", "name"=>"charset", "description"=>"text value of encoding for example: iso-8859-1, windows-1251, utf-8, us-ascii, windows-1250"}, {"in"=>"query", "name"=>"encodingtype", "description"=>"0 for None, 1 for Raw7Bit, 2 for Raw8Bit, 3 for QuotedPrintable, 4 for Base64 (Default), 5 for Uue note that you can also provide the text version such as Raw7Bit for value 1"}, {"in"=>"query", "name"=>"from", "description"=>"from email address"}, {"in"=>"query", "name"=>"from_name", "description"=>"display name for from email address"}, {"in"=>"query", "name"=>"lists", "description"=>"the name of a contact list you would like to send to"}, {"in"=>"query", "name"=>"merge_firstname", "description"=>"if sending to a template you can send merge_ fields to merge data with the template"}, {"in"=>"query", "name"=>"merge_lastname", "description"=>"if sending to a template you can send merge_ fields to merge data with the template"}, {"in"=>"query", "name"=>"reply_to", "description"=>"email address to reply to"}, {"in"=>"query", "name"=>"reply_to_name", "description"=>"display name of the reply to address"}, {"in"=>"query", "name"=>"sender", "description"=>"email address of the sender"}, {"in"=>"query", "name"=>"sender_name", "description"=>"display name sender"}, {"in"=>"query", "name"=>"subject", "description"=>"email subject"}, {"in"=>"query", "name"=>"template", "description"=>"the name of an email template you have created in your account"}, {"in"=>"query", "name"=>"time_offset_minutes", "description"=>"number of minutes in the future this email should be sent"}, {"in"=>"query", "name"=>"total", "description"=>"semi colon separated list of email recipients (each email is treated separately, like a BCC)"}, {"in"=>"query", "name"=>"username", "description"=>"your account email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mailer", "Send"]}}, "mailer/status/log"=>{"get"=>{"summary"=>"Log Activity", "description"=>"The detailed activity log api allows you to get detailed information from your activity log on the emails that you have sent. Information can be narrowed by email status, channel and datetime.", "operationId"=>"getMailerStatusLog", "x-api-path-slug"=>"mailerstatuslog-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API Key"}, {"in"=>"query", "name"=>"channel", "description"=>"If you included a channel name when submitting your requests you can filter here"}, {"in"=>"query", "name"=>"compress", "description"=>"True if you want the results returned as a compressed zip file"}, {"in"=>"query", "name"=>"format", "description"=>"xml or csv"}, {"in"=>"query", "name"=>"from", "description"=>"Server time in the format: 5/19/2011 10:54:20 PM"}, {"in"=>"query", "name"=>"status", "description"=>"One of the following status values: 0 or all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report"}, {"in"=>"query", "name"=>"to", "description"=>"Server time in the format: 5/19/2011 10:54:20 PM"}, {"in"=>"query", "name"=>"username", "description"=>"Your user name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mailer", "Status", "Log"]}}, "mailer/status/{message_id}"=>{"get"=>{"summary"=>"Get Status", "description"=>"Get the status of an email message", "operationId"=>"getMailerStatusMessage", "x-api-path-slug"=>"mailerstatusmessage-id-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API Key"}, {"in"=>"path", "name"=>"message_id", "description"=>"The ID of the email message"}, {"in"=>"query", "name"=>"showdelivered", "description"=>"true - This will return all the recipients who succeeded"}, {"in"=>"query", "name"=>"showdetails", "description"=>"true - This will return all recipients for each status"}, {"in"=>"query", "name"=>"showerrors", "description"=>"true - This will return all the recipients who bounced with details on why"}, {"in"=>"query", "name"=>"showfailed", "description"=>"true - This will return all the recipients who bounced"}, {"in"=>"query", "name"=>"showpending", "description"=>"true - This will return all the recipients still in progress"}, {"in"=>"query", "name"=>"showstats", "description"=>"Show stats"}, {"in"=>"query", "name"=>"username", "description"=>"Your user name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mailer", "Status", "Message", "Id"]}}}}, "apis"=>{"name"=>"Elastic Email", "x-slug"=>"elastic-email", "description"=>"Elastic Email is an all-in-one email delivery platform. Send beautiful newsletters or transactional emails in a better way.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/586-elastic-email.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"50338", "tags"=>"API Provider,Cloud,Emails,Emails,internet,Messages,Profiles,Relative Data,SaaS,Service API,Stack Network,Target,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"elastic-email/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Elastic Email SMTP API", "x-api-slug"=>"elastic-email-smtp-api", "description"=>"Elastic Email is a simple, fast email delivery service for your cloud application or marketing needs. Elastic Email is designed as an SMTP relay for reliable delivery of bulk email marketing or single recipient transactional emails with detailed delivery statistics. No monthly committments, no minimums, no limits. Just pay for what you use for as low as $0.08 / 1000 emails.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/586-elastic-email.jpg", "humanURL"=>"http://elasticemail.com", "baseURL"=>"http://api.elasticemail.com//", "tags"=>"API Provider,Cloud,Emails,Emails,internet,Messages,Profiles,Relative Data,SaaS,Service API,Stack Network,Target,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/elastic-email/mailerstatusmessage-id-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/elastic-email/elastic-email-smtp-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api.elasticemail.com"}, {"type"=>"x-blog", "url"=>"http://elasticemail.com/blog"}, {"type"=>"x-blog-rss", "url"=>"http://elasticemail.com/posts/rss/xml"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/elastic-email"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/elastic-email"}, {"type"=>"x-documentation", "url"=>"https://elasticemail.com/api-documentation"}, {"type"=>"x-email", "url"=>"support@elasticemail.com"}, {"type"=>"x-pricing", "url"=>"https://elasticemail.com/pricing"}, {"type"=>"x-privacy", "url"=>"https://elasticemail.com/privacy-policy"}, {"type"=>"x-selfservice-registration", "url"=>"https://elasticemail.com/account#/create-account"}, {"type"=>"x-terms-of-service", "url"=>"https://elasticemail.com/terms"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/elastic_email"}, {"type"=>"x-website", "url"=>"http://elasticemail.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-fonts{"google-fonts-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Fonts", "x-complete"=>1, "info"=>{"title"=>"Google Fonts Developer", "description"=>"accesses-the-metadata-for-all-families-served-by-google-fonts-providing-a-list-of-families-currently-available-including-available-styles-and-a-list-of-supported-script-subsets-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"www.googleapis.com", "basePath"=>"/webfonts/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/webfonts"=>{"get"=>{"summary"=>"Get Web Fonts", "description"=>"Retrieves the list of fonts currently served by the Google Fonts Developer API", "operationId"=>"webfonts.webfonts.list", "x-api-path-slug"=>"webfonts-get", "parameters"=>[{"in"=>"query", "name"=>"sort", "description"=>"Enables sorting of the list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Font"]}}}}, "apis"=>{"name"=>"Google Fonts", "x-slug"=>"google-fonts", "description"=>"Create dynamic apps by querying Google Fonts to get an accurate list of the families currently available. All fonts are released under open source licenses. You can use them in any non-commercial or commercial project.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2017-03-17 at 8.18.48 PM.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Fonts,Google APIs,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-fonts/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Fonts API", "x-api-slug"=>"google-fonts-api", "description"=>"Create dynamic apps by querying Google Fonts to get an accurate list of the families currently available. All fonts are released under open source licenses. You can use them in any non-commercial or commercial project.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2017-03-17 at 8.18.48 PM.png", "humanURL"=>"https://fonts.google.com/", "baseURL"=>"://www.googleapis.com//webfonts/v1", "tags"=>"API Provider,API Service Provider,Fonts,Google APIs,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/google-fonts/webfonts-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/google-fonts/google-fonts-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://fonts.googleblog.com/"}, {"type"=>"x-blog-rss", "url"=>"http://googlewebfonts.blogspot.in/atom.xml"}, {"type"=>"x-developer", "url"=>"https://developers.google.com/fonts/"}, {"type"=>"x-faq", "url"=>"https://developers.google.com/fonts/faq"}, {"type"=>"x-getting-started", "url"=>"https://developers.google.com/fonts/docs/getting_started"}, {"type"=>"x-terms-of-service", "url"=>"https://developers.google.com/fonts/terms"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/googlefonts"}, {"type"=>"x-website", "url"=>"https://fonts.google.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
instructure{"instructure-canvas-utility-apis-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Instructure", "x-complete"=>1, "info"=>{"title"=>"Instructure Canvas Utility APIs", "description"=>"canvas-lms-includes-a-rest-api-for-accessing-and-modifying-data-externally-from-the-main-application-in-your-own-programs-and-scripts--", "termsOfService"=>"https://www.canvaslms.com/policies/api-policy", "version"=>"v1"}, "host"=>"canvas.instructure.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/sis/accounts/{account_id}/assignments"=>{"get"=>{"summary"=>"Retrieve assignments enabled for grade export to SIS", "description"=>"Retrieve assignments enabled for grade export to sis.", "operationId"=>"retrieve-assignments-enabled-for-grade-export-to-sis", "x-api-path-slug"=>"apisisaccountsaccount-idassignments-get", "parameters"=>[{"in"=>"query", "name"=>"account_id", "description"=>"The ID of the account to query"}, {"in"=>"query", "name"=>"course_id", "description"=>"The ID of the course to query"}, {"in"=>"query", "name"=>"ends_after", "description"=>"When searching on an account, restricts to courses that end after this daten(if they have an end date)"}, {"in"=>"query", "name"=>"starts_before", "description"=>"When searching on an account, restricts to courses that start before thisndate (if they have a start date)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api", "Sis", "Accounts", "Account", "Id", "Assignments"]}}, "/api/sis/courses/{course_id}/assignments"=>{"get"=>{"summary"=>"Retrieve assignments enabled for grade export to SIS", "description"=>"Retrieve assignments enabled for grade export to sis.", "operationId"=>"retrieve-assignments-enabled-for-grade-export-to-sis", "x-api-path-slug"=>"apisiscoursescourse-idassignments-get", "parameters"=>[{"in"=>"query", "name"=>"account_id", "description"=>"The ID of the account to query"}, {"in"=>"query", "name"=>"course_id", "description"=>"The ID of the course to query"}, {"in"=>"query", "name"=>"ends_after", "description"=>"When searching on an account, restricts to courses that end after this daten(if they have an end date)"}, {"in"=>"query", "name"=>"starts_before", "description"=>"When searching on an account, restricts to courses that start before thisndate (if they have a start date)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api", "Sis", "Courses", "Course", "Id", "Assignments"]}}, "/collaborations/{id}/members"=>{"get"=>{"summary"=>"List members of a collaboration.", "description"=>"List members of a collaboration..", "operationId"=>"list-members-of-a-collaboration", "x-api-path-slug"=>"collaborationsidmembers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collaborations", "Id", "Members"]}}, "/comm_messages"=>{"get"=>{"summary"=>"List of CommMessages for a user", "description"=>"List of commmessages for a user.", "operationId"=>"list-of-commmessages-for-a-user", "x-api-path-slug"=>"comm-messages-get", "parameters"=>[{"in"=>"query", "name"=>"end_time", "description"=>"The end of the time range you want to retrieve messages for"}, {"in"=>"query", "name"=>"start_time", "description"=>"The beginning of the time range you want to retrieve message from"}, {"in"=>"query", "name"=>"user_id", "description"=>"The user id for whom you want to retrieve CommMessages"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comm", "Messages"]}}, "/course_accounts"=>{"get"=>{"summary"=>"List accounts for course admins", "description"=>"List accounts for course admins.", "operationId"=>"list-accounts-for-course-admins", "x-api-path-slug"=>"course-accounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Course", "Accounts"]}}, "/error_reports"=>{"post"=>{"summary"=>"Create Error Report", "description"=>"Create error report.", "operationId"=>"create-error-report", "x-api-path-slug"=>"error-reports-post", "parameters"=>[{"in"=>"query", "name"=>"error[comments]", "description"=>"The long version of the story from the user one what they experienced"}, {"in"=>"query", "name"=>"error[email]", "description"=>"Email address for the reporting user"}, {"in"=>"query", "name"=>"error[http_env]", "description"=>"A collection of metadata about the users' environment"}, {"in"=>"query", "name"=>"error[subject]", "description"=>"The summary of the problem"}, {"in"=>"query", "name"=>"error[url]", "description"=>"URL from which the report was issued"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Error", "Reports"]}}, "/jwts"=>{"post"=>{"summary"=>"Create JWT", "description"=>"Create jwt.", "operationId"=>"create-jwt", "x-api-path-slug"=>"jwts-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jwts"]}}, "/outcomes/{id}"=>{"get"=>{"summary"=>"Show an outcome", "description"=>"Show an outcome.", "operationId"=>"show-an-outcome", "x-api-path-slug"=>"outcomesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Outcomes", "Id"]}, "put"=>{"summary"=>"Update an outcome", "description"=>"Update an outcome.", "operationId"=>"update-an-outcome", "x-api-path-slug"=>"outcomesid-put", "parameters"=>[{"in"=>"query", "name"=>"calculation_int", "description"=>"The new calculation int"}, {"in"=>"query", "name"=>"calculation_method", "description"=>"The new calculation method"}, {"in"=>"query", "name"=>"description", "description"=>"The new outcome description"}, {"in"=>"query", "name"=>"display_name", "description"=>"A friendly name shown in reports for outcomes with cryptic titles, such asncommon core standards names"}, {"in"=>"query", "name"=>"mastery_points", "description"=>"The new mastery threshold for the embedded rubric criterion"}, {"in"=>"query", "name"=>"ratings[][description]", "description"=>"The description of a new rating level for the embedded rubric criterion"}, {"in"=>"query", "name"=>"ratings[][points]", "description"=>"The points corresponding to a new rating level for the embedded rubricncriterion"}, {"in"=>"query", "name"=>"title", "description"=>"The new outcome title"}, {"in"=>"query", "name"=>"vendor_guid", "description"=>"A custom GUID for the learning standard"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Outcomes", "Id"]}}, "/progress/{id}"=>{"get"=>{"summary"=>"Query progress", "description"=>"Query progress.", "operationId"=>"query-progress", "x-api-path-slug"=>"progressid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Progress", "Id"]}}, "/search/all_courses"=>{"get"=>{"summary"=>"List all courses", "description"=>"List all courses.", "operationId"=>"list-all-courses", "x-api-path-slug"=>"searchall-courses-get", "parameters"=>[{"in"=>"query", "name"=>"open_enrollment_only", "description"=>"Only return courses that allow self enrollment"}, {"in"=>"query", "name"=>"public_only", "description"=>"Only return courses with public content"}, {"in"=>"query", "name"=>"search", "description"=>"Search terms used for matching users/courses/groups (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "", "Courses"]}}, "/search/recipients"=>{"get"=>{"summary"=>"Find recipients", "description"=>"Find recipients.", "operationId"=>"find-recipients", "x-api-path-slug"=>"searchrecipients-get", "parameters"=>[{"in"=>"query", "name"=>"context", "description"=>"Limit the search to a particular course/group (e"}, {"in"=>"query", "name"=>"exclude[]", "description"=>"Array of ids to exclude from the search"}, {"in"=>"query", "name"=>"from_conversation_id", "description"=>"When searching by user_id, only users that could be normally messaged bynthis user will be returned"}, {"in"=>"query", "name"=>"permissions[]", "description"=>"Array of permission strings to be checked for each matched context (e"}, {"in"=>"query", "name"=>"search", "description"=>"Search terms used for matching users/courses/groups (e"}, {"in"=>"query", "name"=>"type", "description"=>"Limit the search just to users or contexts (groups/courses)"}, {"in"=>"query", "name"=>"user_id", "description"=>"Search for a specific user id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Recipients"]}}, "/services/kaltura"=>{"get"=>{"summary"=>"Get Kaltura config", "description"=>"Get kaltura config.", "operationId"=>"get-kaltura-config", "x-api-path-slug"=>"serviceskaltura-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services", "Kaltura"]}}, "/services/kaltura_session"=>{"post"=>{"summary"=>"Start Kaltura session", "description"=>"Start kaltura session.", "operationId"=>"start-kaltura-session", "x-api-path-slug"=>"serviceskaltura-session-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services", "Kaltura", "Session"]}}}}, "instructure-canvas-polls-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Instructure", "x-complete"=>1, "info"=>{"title"=>"Instructure Canvas Polls API", "description"=>"canvas-lms-includes-a-rest-api-for-accessing-and-modifying-data-externally-from-the-main-application-in-your-own-programs-and-scripts--", "termsOfService"=>"https://www.canvaslms.com/policies/api-policy", "version"=>"v1"}, "host"=>"canvas.instructure.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/polls"=>{"get"=>{"summary"=>"List polls", "description"=>"List polls.", "operationId"=>"list-polls", "x-api-path-slug"=>"polls-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls"]}, "post"=>{"summary"=>"Create a single poll", "description"=>"Create a single poll.", "operationId"=>"create-a-single-poll", "x-api-path-slug"=>"polls-post", "parameters"=>[{"in"=>"query", "name"=>"polls[][description]", "description"=>"A brief description or instructions for the poll"}, {"in"=>"query", "name"=>"polls[][question]", "description"=>"The title of the poll"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls"]}}, "/polls/{id}"=>{"delete"=>{"summary"=>"Delete a poll", "description"=>"Delete a poll.", "operationId"=>"delete-a-poll", "x-api-path-slug"=>"pollsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Id"]}, "get"=>{"summary"=>"Get a single poll", "description"=>"Get a single poll.", "operationId"=>"get-a-single-poll", "x-api-path-slug"=>"pollsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Id"]}, "put"=>{"summary"=>"Update a single poll", "description"=>"Update a single poll.", "operationId"=>"update-a-single-poll", "x-api-path-slug"=>"pollsid-put", "parameters"=>[{"in"=>"query", "name"=>"polls[][description]", "description"=>"A brief description or instructions for the poll"}, {"in"=>"query", "name"=>"polls[][question]", "description"=>"The title of the poll"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Id"]}}, "/polls/{poll_id}/poll_choices"=>{"get"=>{"summary"=>"List poll choices in a poll", "description"=>"List poll choices in a poll.", "operationId"=>"list-poll-choices-in-a-poll", "x-api-path-slug"=>"pollspoll-idpoll-choices-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Poll", "Id", "Poll", "Choices"]}, "post"=>{"summary"=>"Create a single poll choice", "description"=>"Create a single poll choice.", "operationId"=>"create-a-single-poll-choice", "x-api-path-slug"=>"pollspoll-idpoll-choices-post", "parameters"=>[{"in"=>"query", "name"=>"poll_choices[][is_correct]", "description"=>"Whether this poll choice is considered correct or not"}, {"in"=>"query", "name"=>"poll_choices[][position]", "description"=>"The order this poll choice should be returned in the context it'snsibling poll choices"}, {"in"=>"query", "name"=>"poll_choices[][text]", "description"=>"The descriptive text of the poll choice"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Poll", "Id", "Poll", "Choices"]}}, "/polls/{poll_id}/poll_choices/id"=>{"delete"=>{"summary"=>"Delete a poll choice", "description"=>"Delete a poll choice.", "operationId"=>"delete-a-poll-choice", "x-api-path-slug"=>"pollspoll-idpoll-choicesid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Poll", "Id", "Poll", "Choices", "Id"]}, "get"=>{"summary"=>"Get a single poll choice", "description"=>"Get a single poll choice.", "operationId"=>"get-a-single-poll-choice", "x-api-path-slug"=>"pollspoll-idpoll-choicesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Poll", "Id", "Poll", "Choices", "Id"]}, "put"=>{"summary"=>"Update a single poll choice", "description"=>"Update a single poll choice.", "operationId"=>"update-a-single-poll-choice", "x-api-path-slug"=>"pollspoll-idpoll-choicesid-put", "parameters"=>[{"in"=>"query", "name"=>"poll_choices[][is_correct]", "description"=>"Whether this poll choice is considered correct or not"}, {"in"=>"query", "name"=>"poll_choices[][position]", "description"=>"The order this poll choice should be returned in the context it'snsibling poll choices"}, {"in"=>"query", "name"=>"poll_choices[][text]", "description"=>"The descriptive text of the poll choice"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Poll", "Id", "Poll", "Choices", "Id"]}}, "/polls/{poll_id}/poll_sessions"=>{"get"=>{"summary"=>"List poll sessions for a poll", "description"=>"List poll sessions for a poll.", "operationId"=>"list-poll-sessions-for-a-poll", "x-api-path-slug"=>"pollspoll-idpoll-sessions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Poll", "Id", "Poll", "Sessions"]}, "post"=>{"summary"=>"Create a single poll session", "description"=>"Create a single poll session.", "operationId"=>"create-a-single-poll-session", "x-api-path-slug"=>"pollspoll-idpoll-sessions-post", "parameters"=>[{"in"=>"query", "name"=>"poll_sessions[][course_id]", "description"=>"The id of the course this session is associated with"}, {"in"=>"query", "name"=>"poll_sessions[][course_section_id]", "description"=>"The id of the course section this session is associated with"}, {"in"=>"query", "name"=>"poll_sessions[][has_public_results]", "description"=>"Whether or not results are viewable by students"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Poll", "Id", "Poll", "Sessions"]}}, "/polls/{poll_id}/poll_sessions/id"=>{"delete"=>{"summary"=>"Delete a poll session", "description"=>"Delete a poll session.", "operationId"=>"delete-a-poll-session", "x-api-path-slug"=>"pollspoll-idpoll-sessionsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Poll", "Id", "Poll", "Sessions", "Id"]}, "get"=>{"summary"=>"Get the results for a single poll session", "description"=>"Get the results for a single poll session.", "operationId"=>"get-the-results-for-a-single-poll-session", "x-api-path-slug"=>"pollspoll-idpoll-sessionsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Poll", "Id", "Poll", "Sessions", "Id"]}, "put"=>{"summary"=>"Update a single poll session", "description"=>"Update a single poll session.", "operationId"=>"update-a-single-poll-session", "x-api-path-slug"=>"pollspoll-idpoll-sessionsid-put", "parameters"=>[{"in"=>"query", "name"=>"poll_sessions[][course_id]", "description"=>"The id of the course this session is associated with"}, {"in"=>"query", "name"=>"poll_sessions[][course_section_id]", "description"=>"The id of the course section this session is associated with"}, {"in"=>"query", "name"=>"poll_sessions[][has_public_results]", "description"=>"Whether or not results are viewable by students"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Poll", "Id", "Poll", "Sessions", "Id"]}}, "/polls/{poll_id}/poll_sessions/id/close"=>{"get"=>{"summary"=>"Close an opened poll session", "description"=>"Close an opened poll session.", "operationId"=>"close-an-opened-poll-session", "x-api-path-slug"=>"pollspoll-idpoll-sessionsidclose-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Poll", "Id", "Poll", "Sessions", "Id", "Close"]}}, "/polls/{poll_id}/poll_sessions/id/open"=>{"get"=>{"summary"=>"Open a poll session", "description"=>"Open a poll session.", "operationId"=>"open-a-poll-session", "x-api-path-slug"=>"pollspoll-idpoll-sessionsidopen-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Poll", "Id", "Poll", "Sessions", "Id", "Open"]}}, "/polls/{poll_id}/poll_sessions/poll_session_id/poll_submissions"=>{"post"=>{"summary"=>"Create a single poll submission", "description"=>"Create a single poll submission.", "operationId"=>"create-a-single-poll-submission", "x-api-path-slug"=>"pollspoll-idpoll-sessionspoll-session-idpoll-submissions-post", "parameters"=>[{"in"=>"query", "name"=>"poll_submissions[][poll_choice_id]", "description"=>"The chosen poll choice for this submission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Poll", "Id", "Poll", "Sessions", "Poll", "Session", "Id", "Poll", "Submissions"]}}, "/polls/{poll_id}/poll_sessions/poll_session_id/poll_submissions/{id}"=>{"get"=>{"summary"=>"Get a single poll submission", "description"=>"Get a single poll submission.", "operationId"=>"get-a-single-poll-submission", "x-api-path-slug"=>"pollspoll-idpoll-sessionspoll-session-idpoll-submissionsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Polls", "Poll", "Id", "Poll", "Sessions", "Poll", "Session", "Id", "Poll", "Submissions", "Id"]}}, "/poll_sessions/closed"=>{"get"=>{"summary"=>"List closed poll sessions", "description"=>"List closed poll sessions.", "operationId"=>"list-closed-poll-sessions", "x-api-path-slug"=>"poll-sessionsclosed-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Poll", "Sessions", "Closed"]}}, "/poll_sessions/opened"=>{"get"=>{"summary"=>"List opened poll sessions", "description"=>"List opened poll sessions.", "operationId"=>"list-opened-poll-sessions", "x-api-path-slug"=>"poll-sessionsopened-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Poll", "Sessions", "Opened"]}}}}, "instructure-canvas-calendar-events-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Instructure", "x-complete"=>1, "info"=>{"title"=>"Instructure Canvas Calendar Events API", "description"=>"canvas-lms-includes-a-rest-api-for-accessing-and-modifying-data-externally-from-the-main-application-in-your-own-programs-and-scripts--", "termsOfService"=>"https://www.canvaslms.com/policies/api-policy", "version"=>"v1"}, "host"=>"canvas.instructure.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/calendar_events"=>{"get"=>{"summary"=>"List calendar events", "description"=>"List calendar events.", "operationId"=>"list-calendar-events", "x-api-path-slug"=>"calendar-events-get", "parameters"=>[{"in"=>"query", "name"=>"all_events", "description"=>"Defaults to false (uses start_date, end_date, and undated criteria)"}, {"in"=>"query", "name"=>"context_codes[]", "description"=>"List of context codes of courses/groups/users whose events you want to see"}, {"in"=>"query", "name"=>"end_date", "description"=>"Only return events before the end_date (inclusive)"}, {"in"=>"query", "name"=>"excludes[]", "description"=>"Array of attributes to exclude"}, {"in"=>"query", "name"=>"start_date", "description"=>"Only return events since the start_date (inclusive)"}, {"in"=>"query", "name"=>"type", "description"=>"Defaults to u201ceventu201dnn n n Allowed values: event, assignment"}, {"in"=>"query", "name"=>"undated", "description"=>"Defaults to false (dated events only)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar", "Events"]}, "post"=>{"summary"=>"Create a calendar event", "description"=>"Create a calendar event.", "operationId"=>"create-a-calendar-event", "x-api-path-slug"=>"calendar-events-post", "parameters"=>[{"in"=>"query", "name"=>"calendar_event[child_event_data][X][context_code]", "description"=>"Context code(s) corresponding to the section-level start and end time(s)"}, {"in"=>"query", "name"=>"calendar_event[child_event_data][X][end_at]", "description"=>"Section-level end time(s) if this is a course event"}, {"in"=>"query", "name"=>"calendar_event[child_event_data][X][start_at]", "description"=>"Section-level start time(s) if this is a course event"}, {"in"=>"query", "name"=>"calendar_event[context_code]", "description"=>"Context code of the course/group/user whose calendar this event should benadded to"}, {"in"=>"query", "name"=>"calendar_event[description]", "description"=>"Longer HTML description of the event"}, {"in"=>"query", "name"=>"calendar_event[duplicate][append_iterator]", "description"=>"Defaults to false"}, {"in"=>"query", "name"=>"calendar_event[duplicate][count]", "description"=>"Number of times to copy/duplicate the event"}, {"in"=>"query", "name"=>"calendar_event[duplicate][frequency]", "description"=>"Defaults to u201cweeklyu201d"}, {"in"=>"query", "name"=>"calendar_event[duplicate][interval]", "description"=>"Defaults to 1 if duplicate `count` is set"}, {"in"=>"query", "name"=>"calendar_event[end_at]", "description"=>"End date/time of the event"}, {"in"=>"query", "name"=>"calendar_event[location_address]", "description"=>"Location address"}, {"in"=>"query", "name"=>"calendar_event[location_name]", "description"=>"Location name of the event"}, {"in"=>"query", "name"=>"calendar_event[start_at]", "description"=>"Start date/time of the event"}, {"in"=>"query", "name"=>"calendar_event[time_zone_edited]", "description"=>"Time zone of the user editing the event"}, {"in"=>"query", "name"=>"calendar_event[title]", "description"=>"Short title for the calendar event"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar", "Events"]}}, "/calendar_events/{id}"=>{"delete"=>{"summary"=>"Delete a calendar event", "description"=>"Delete a calendar event.", "operationId"=>"delete-a-calendar-event", "x-api-path-slug"=>"calendar-eventsid-delete", "parameters"=>[{"in"=>"query", "name"=>"cancel_reason", "description"=>"Reason for deleting/canceling the event"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar", "Events", "Id"]}, "get"=>{"summary"=>"Get a single calendar event or assignment", "description"=>"Get a single calendar event or assignment.", "operationId"=>"get-a-single-calendar-event-or-assignment", "x-api-path-slug"=>"calendar-eventsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar", "Events", "Id"]}, "put"=>{"summary"=>"Update a calendar event", "description"=>"Update a calendar event.", "operationId"=>"update-a-calendar-event", "x-api-path-slug"=>"calendar-eventsid-put", "parameters"=>[{"in"=>"query", "name"=>"calendar_event[child_event_data][X][context_code]", "description"=>"Context code(s) corresponding to the section-level start and end time(s)"}, {"in"=>"query", "name"=>"calendar_event[child_event_data][X][end_at]", "description"=>"Section-level end time(s) if this is a course event"}, {"in"=>"query", "name"=>"calendar_event[child_event_data][X][start_at]", "description"=>"Section-level start time(s) if this is a course event"}, {"in"=>"query", "name"=>"calendar_event[context_code]", "description"=>"Context code of the course/group/user whose calendar this event should benadded to"}, {"in"=>"query", "name"=>"calendar_event[description]", "description"=>"Longer HTML description of the event"}, {"in"=>"query", "name"=>"calendar_event[end_at]", "description"=>"End date/time of the event"}, {"in"=>"query", "name"=>"calendar_event[location_address]", "description"=>"Location address"}, {"in"=>"query", "name"=>"calendar_event[location_name]", "description"=>"Location name of the event"}, {"in"=>"query", "name"=>"calendar_event[start_at]", "description"=>"Start date/time of the event"}, {"in"=>"query", "name"=>"calendar_event[time_zone_edited]", "description"=>"Time zone of the user editing the event"}, {"in"=>"query", "name"=>"calendar_event[title]", "description"=>"Short title for the calendar event"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar", "Events", "Id"]}}, "/calendar_events/{id}/reservations"=>{"post"=>{"summary"=>"Reserve a time slot", "description"=>"Reserve a time slot.", "operationId"=>"reserve-a-time-slot", "x-api-path-slug"=>"calendar-eventsidreservations-post", "parameters"=>[{"in"=>"query", "name"=>"cancel_existing", "description"=>"Defaults to false"}, {"in"=>"query", "name"=>"comments", "description"=>"Comments to associate with this reservation"}, {"in"=>"query", "name"=>"participant_id", "description"=>"User or group id for whom you are making the reservation (depends on thenparticipant type)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar", "Events", "Id", "Reservations"]}}, "/calendar_events/{id}/reservations/participant_id"=>{"post"=>{"summary"=>"Reserve a time slot", "description"=>"Reserve a time slot.", "operationId"=>"reserve-a-time-slot", "x-api-path-slug"=>"calendar-eventsidreservationsparticipant-id-post", "parameters"=>[{"in"=>"query", "name"=>"cancel_existing", "description"=>"Defaults to false"}, {"in"=>"query", "name"=>"comments", "description"=>"Comments to associate with this reservation"}, {"in"=>"query", "name"=>"participant_id", "description"=>"User or group id for whom you are making the reservation (depends on thenparticipant type)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar", "Events", "Id", "Reservations", "Participant", "Id"]}}}}, "instructure-canvas-appointment-groups-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Instructure", "x-complete"=>1, "info"=>{"title"=>"Instructure Canvas Appointment Groups API", "description"=>"canvas-lms-includes-a-rest-api-for-accessing-and-modifying-data-externally-from-the-main-application-in-your-own-programs-and-scripts--", "termsOfService"=>"https://www.canvaslms.com/policies/api-policy", "version"=>"v1"}, "host"=>"canvas.instructure.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/appointment_groups"=>{"get"=>{"summary"=>"List appointment groups", "description"=>"List appointment groups.", "operationId"=>"list-appointment-groups", "x-api-path-slug"=>"appointment-groups-get", "parameters"=>[{"in"=>"query", "name"=>"context_codes[]", "description"=>"Array of context codes used to limit returned results"}, {"in"=>"query", "name"=>"include[]", "description"=>"Array of additional information to include"}, {"in"=>"query", "name"=>"include_past_appointments", "description"=>"Defaults to false"}, {"in"=>"query", "name"=>"scope", "description"=>"Defaults to u201creservableu201dnn n n Allowed values: reservable, manageable"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointment", "Groups"]}, "post"=>{"summary"=>"Create an appointment group", "description"=>"Create an appointment group.", "operationId"=>"create-an-appointment-group", "x-api-path-slug"=>"appointment-groups-post", "parameters"=>[{"in"=>"query", "name"=>"appointment_group[context_codes][]", "description"=>"Array of context codes (courses, e"}, {"in"=>"query", "name"=>"appointment_group[description]", "description"=>"Longer text description of the appointment group"}, {"in"=>"query", "name"=>"appointment_group[location_address]", "description"=>"Location address"}, {"in"=>"query", "name"=>"appointment_group[location_name]", "description"=>"Location name of the appointment group"}, {"in"=>"query", "name"=>"appointment_group[max_appointments_per_participant]", "description"=>"Maximum number of time slots a user may register for"}, {"in"=>"query", "name"=>"appointment_group[min_appointments_per_participant]", "description"=>"Minimum number of time slots a user must register for"}, {"in"=>"query", "name"=>"appointment_group[new_appointments][X][]", "description"=>"Nested array of start time/end time pairs indicating time slots for thisnappointment group"}, {"in"=>"query", "name"=>"appointment_group[participants_per_appointment]", "description"=>"Maximum number of participants that may register for each time slot"}, {"in"=>"query", "name"=>"appointment_group[participant_visibility]", "description"=>"u201cprivateu201dnnparticipants cannot see who has signed up for a particular time slotnu201cprotectedu201dnnparticipants can see who has signed up"}, {"in"=>"query", "name"=>"appointment_group[publish]", "description"=>"Indicates whether this appointment group should be published (i"}, {"in"=>"query", "name"=>"appointment_group[sub_context_codes][]", "description"=>"Array of sub context codes (course sections or a single group category)nthis group should be linked to"}, {"in"=>"query", "name"=>"appointment_group[title]", "description"=>"Short title for the appointment group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointment", "Groups"]}}, "/appointment_groups/{id}"=>{"delete"=>{"summary"=>"Delete an appointment group", "description"=>"Delete an appointment group.", "operationId"=>"delete-an-appointment-group", "x-api-path-slug"=>"appointment-groupsid-delete", "parameters"=>[{"in"=>"query", "name"=>"cancel_reason", "description"=>"Reason for deleting/canceling the appointment group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointment", "Groups", "Id"]}, "get"=>{"summary"=>"Get a single appointment group", "description"=>"Get a single appointment group.", "operationId"=>"get-a-single-appointment-group", "x-api-path-slug"=>"appointment-groupsid-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Array of additional information to include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointment", "Groups", "Id"]}, "put"=>{"summary"=>"Update an appointment group", "description"=>"Update an appointment group.", "operationId"=>"update-an-appointment-group", "x-api-path-slug"=>"appointment-groupsid-put", "parameters"=>[{"in"=>"query", "name"=>"appointment_group[context_codes][]", "description"=>"Array of context codes (courses, e"}, {"in"=>"query", "name"=>"appointment_group[description]", "description"=>"Longer text description of the appointment group"}, {"in"=>"query", "name"=>"appointment_group[location_address]", "description"=>"Location address"}, {"in"=>"query", "name"=>"appointment_group[location_name]", "description"=>"Location name of the appointment group"}, {"in"=>"query", "name"=>"appointment_group[max_appointments_per_participant]", "description"=>"Maximum number of time slots a user may register for"}, {"in"=>"query", "name"=>"appointment_group[min_appointments_per_participant]", "description"=>"Minimum number of time slots a user must register for"}, {"in"=>"query", "name"=>"appointment_group[new_appointments][X][]", "description"=>"Nested array of start time/end time pairs indicating time slots for thisnappointment group"}, {"in"=>"query", "name"=>"appointment_group[participants_per_appointment]", "description"=>"Maximum number of participants that may register for each time slot"}, {"in"=>"query", "name"=>"appointment_group[participant_visibility]", "description"=>"u201cprivateu201dnnparticipants cannot see who has signed up for a particular time slotnu201cprotectedu201dnnparticipants can see who has signed up"}, {"in"=>"query", "name"=>"appointment_group[publish]", "description"=>"Indicates whether this appointment group should be published (i"}, {"in"=>"query", "name"=>"appointment_group[sub_context_codes][]", "description"=>"Array of sub context codes (course sections or a single group category)nthis group should be linked to"}, {"in"=>"query", "name"=>"appointment_group[title]", "description"=>"Short title for the appointment group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointment", "Groups", "Id"]}}, "/appointment_groups/{id}/groups"=>{"get"=>{"summary"=>"List student group participants", "description"=>"List student group participants.", "operationId"=>"list-student-group-participants", "x-api-path-slug"=>"appointment-groupsidgroups-get", "parameters"=>[{"in"=>"query", "name"=>"registration_status", "description"=>"Limits results to the a given participation status, defaults to u201callu201dnn n n Allowed values: all, registered, registered"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointment", "Groups", "Id", "Groups"]}}, "/appointment_groups/{id}/users"=>{"get"=>{"summary"=>"List user participants", "description"=>"List user participants.", "operationId"=>"list-user-participants", "x-api-path-slug"=>"appointment-groupsidusers-get", "parameters"=>[{"in"=>"query", "name"=>"registration_status", "description"=>"Limits results to the a given participation status, defaults to u201callu201dnn n n Allowed values: all, registered, registered"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appointment", "Groups", "Id", "Users"]}}}}, "instructure-canvas-sections-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Instructure", "x-complete"=>1, "info"=>{"title"=>"Instructure Canvas Sections API", "description"=>"canvas-lms-includes-a-rest-api-for-accessing-and-modifying-data-externally-from-the-main-application-in-your-own-programs-and-scripts--", "termsOfService"=>"https://www.canvaslms.com/policies/api-policy", "version"=>"v1"}, "host"=>"canvas.instructure.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/sections/{course_section_id}/assignments/assignment_id/override"=>{"get"=>{"summary"=>"Redirect to the assignment override for a section", "description"=>"Redirect to the assignment override for a section.", "operationId"=>"redirect-to-the-assignment-override-for-a-section", "x-api-path-slug"=>"sectionscourse-section-idassignmentsassignment-idoverride-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Course", "Section", "Id", "Assignments", "Assignment", "Id", "Override"]}}, "/sections/{id}"=>{"delete"=>{"summary"=>"Delete a section", "description"=>"Delete a section.", "operationId"=>"delete-a-section", "x-api-path-slug"=>"sectionsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Id"]}, "get"=>{"summary"=>"Get section information", "description"=>"Get section information.", "operationId"=>"get-section-information", "x-api-path-slug"=>"sectionsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Id"]}, "put"=>{"summary"=>"Edit a section", "description"=>"Edit a section.", "operationId"=>"edit-a-section", "x-api-path-slug"=>"sectionsid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Id"]}}, "/sections/{id}/crosslist"=>{"delete"=>{"summary"=>"De-cross-list a Section", "description"=>"De-cross-list a section.", "operationId"=>"decrosslist-a-section", "x-api-path-slug"=>"sectionsidcrosslist-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Id", "Crosslist"]}}, "/sections/{id}/crosslist/new_course_id"=>{"post"=>{"summary"=>"Cross-list a Section", "description"=>"Cross-list a section.", "operationId"=>"crosslist-a-section", "x-api-path-slug"=>"sectionsidcrosslistnew-course-id-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Id", "Crosslist", "New", "Course", "Id"]}}, "/sections/{section_id}/assignments/assignment_id/peer_reviews"=>{"get"=>{"summary"=>"Get all Peer Reviews", "description"=>"Get all peer reviews.", "operationId"=>"get-all-peer-reviews", "x-api-path-slug"=>"sectionssection-idassignmentsassignment-idpeer-reviews-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the peer review"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Section", "Id", "Assignments", "Assignment", "Id", "Peer", "Reviews"]}}, "/sections/{section_id}/assignments/assignment_id/submissions"=>{"get"=>{"summary"=>"List assignment submissions", "description"=>"List assignment submissions.", "operationId"=>"list-assignment-submissions", "x-api-path-slug"=>"sectionssection-idassignmentsassignment-idsubmissions-get", "parameters"=>[{"in"=>"query", "name"=>"grouped", "description"=>"If this argument is true, the response will be grouped by student groups"}, {"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Section", "Id", "Assignments", "Assignment", "Id", "Submissions"]}, "post"=>{"summary"=>"Submit an assignment", "description"=>"Submit an assignment.", "operationId"=>"submit-an-assignment", "x-api-path-slug"=>"sectionssection-idassignmentsassignment-idsubmissions-post", "parameters"=>[{"in"=>"query", "name"=>"comment[text_comment]", "description"=>"Include a textual comment with the submission"}, {"in"=>"query", "name"=>"submission[body]", "description"=>"Submit the assignment as an HTML document snippet"}, {"in"=>"query", "name"=>"submission[file_ids][]", "description"=>"Submit the assignment as a set of one or more previously uploaded filesnresiding in the submitting user's files section (or the group'snfiles section, for group assignments)"}, {"in"=>"query", "name"=>"submission[media_comment_id]", "description"=>"The media comment id to submit"}, {"in"=>"query", "name"=>"submission[media_comment_type]", "description"=>"The type of media comment being submitted"}, {"in"=>"query", "name"=>"submission[submission_type]", "description"=>"The type of submission being made"}, {"in"=>"query", "name"=>"submission[url]", "description"=>"Submit the assignment as a URL"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Section", "Id", "Assignments", "Assignment", "Id", "Submissions"]}}, "/sections/{section_id}/assignments/assignment_id/submissions/update_grades"=>{"post"=>{"summary"=>"Grade or comment on multiple submissions", "description"=>"Grade or comment on multiple submissions.", "operationId"=>"grade-or-comment-on-multiple-submissions", "x-api-path-slug"=>"sectionssection-idassignmentsassignment-idsubmissionsupdate-grades-post", "parameters"=>[{"in"=>"query", "name"=>"grade_data[student_id][file_ids][]", "description"=>"See documentation for the comment[] arguments in thenSubmissions Update documentation"}, {"in"=>"query", "name"=>"grade_data[student_id][group_comment]", "description"=>"no description"}, {"in"=>"query", "name"=>"grade_data[student_id][media_comment_id]", "description"=>"no description"}, {"in"=>"query", "name"=>"grade_data[student_id][media_comment_type]", "description"=>"no descriptionnn n n Allowed values: audio, video"}, {"in"=>"query", "name"=>"grade_data[student_id][posted_grade]", "description"=>"See documentation for the posted_grade argument in thenSubmissions Update documentation"}, {"in"=>"query", "name"=>"grade_data[student_id][rubric_assessment]", "description"=>"See documentation for the rubric_assessment argument in thenSubmissions Update documentation"}, {"in"=>"query", "name"=>"grade_data[student_id][text_comment]", "description"=>"no description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Section", "Id", "Assignments", "Assignment", "Id", "Submissions", "Update", "Grades"]}}, "/sections/{section_id}/assignments/assignment_id/submissions/{submission_id}/peer_reviews"=>{"delete"=>{"summary"=>"Create Peer Review", "description"=>"Create peer review.", "operationId"=>"create-peer-review", "x-api-path-slug"=>"sectionssection-idassignmentsassignment-idsubmissionssubmission-idpeer-reviews-delete", "parameters"=>[{"in"=>"query", "name"=>"user_id", "description"=>"user_id to delete as reviewer on this assignment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Section", "Id", "Assignments", "Assignment", "Id", "Submissions", "Submission", "Id", "Peer", "Reviews"]}, "get"=>{"summary"=>"Get all Peer Reviews", "description"=>"Get all peer reviews.", "operationId"=>"get-all-peer-reviews", "x-api-path-slug"=>"sectionssection-idassignmentsassignment-idsubmissionssubmission-idpeer-reviews-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the peer review"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Section", "Id", "Assignments", "Assignment", "Id", "Submissions", "Submission", "Id", "Peer", "Reviews"]}, "post"=>{"summary"=>"Create Peer Review", "description"=>"Create peer review.", "operationId"=>"create-peer-review", "x-api-path-slug"=>"sectionssection-idassignmentsassignment-idsubmissionssubmission-idpeer-reviews-post", "parameters"=>[{"in"=>"query", "name"=>"user_id", "description"=>"user_id to assign as reviewer on this assignment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Section", "Id", "Assignments", "Assignment", "Id", "Submissions", "Submission", "Id", "Peer", "Reviews"]}}, "/sections/{section_id}/assignments/assignment_id/submissions/{user_id}"=>{"get"=>{"summary"=>"Get a single submission", "description"=>"Get a single submission.", "operationId"=>"get-a-single-submission", "x-api-path-slug"=>"sectionssection-idassignmentsassignment-idsubmissionsuser-id-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Section", "Id", "Assignments", "Assignment", "Id", "Submissions", "User", "Id"]}, "put"=>{"summary"=>"Grade or comment on a submission", "description"=>"Grade or comment on a submission.", "operationId"=>"grade-or-comment-on-a-submission", "x-api-path-slug"=>"sectionssection-idassignmentsassignment-idsubmissionsuser-id-put", "parameters"=>[{"in"=>"query", "name"=>"comment[file_ids][]", "description"=>"Attach files to this comment that were previously uploaded using thenSubmission Comment API's files action"}, {"in"=>"query", "name"=>"comment[group_comment]", "description"=>"Whether or not this comment should be sent to the entire group (defaults tonfalse)"}, {"in"=>"query", "name"=>"comment[media_comment_id]", "description"=>"Add an audio/video comment to the submission"}, {"in"=>"query", "name"=>"comment[media_comment_type]", "description"=>"The type of media comment being added"}, {"in"=>"query", "name"=>"comment[text_comment]", "description"=>"Add a textual comment to the submission"}, {"in"=>"query", "name"=>"include[visibility]", "description"=>"Whether this assignment is visible to the owner of the submission"}, {"in"=>"query", "name"=>"rubric_assessment", "description"=>"Assign a rubric assessment to this assignment submission"}, {"in"=>"query", "name"=>"submission[excuse]", "description"=>"Sets the u201cexcusedu201d status of an assignment"}, {"in"=>"query", "name"=>"submission[posted_grade]", "description"=>"Assign a score to the submission, updating both the u201cscoreu201d and u201cgradeu201dnfields on the submission record"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Section", "Id", "Assignments", "Assignment", "Id", "Submissions", "User", "Id"]}}, "/sections/{section_id}/assignments/assignment_id/submissions/{user_id}/files"=>{"post"=>{"summary"=>"Upload a file", "description"=>"Upload a file.", "operationId"=>"upload-a-file", "x-api-path-slug"=>"sectionssection-idassignmentsassignment-idsubmissionsuser-idfiles-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Section", "Id", "Assignments", "Assignment", "Id", "Submissions", "User", "Id", "Files"]}}, "/sections/{section_id}/assignments/assignment_id/submissions/{user_id}/read"=>{"delete"=>{"summary"=>"Mark submission as unread", "description"=>"Mark submission as unread.", "operationId"=>"mark-submission-as-unread", "x-api-path-slug"=>"sectionssection-idassignmentsassignment-idsubmissionsuser-idread-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Section", "Id", "Assignments", "Assignment", "Id", "Submissions", "User", "Id", "Read"]}, "put"=>{"summary"=>"Mark submission as read", "description"=>"Mark submission as read.", "operationId"=>"mark-submission-as-read", "x-api-path-slug"=>"sectionssection-idassignmentsassignment-idsubmissionsuser-idread-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Section", "Id", "Assignments", "Assignment", "Id", "Submissions", "User", "Id", "Read"]}}, "/sections/{section_id}/enrollments"=>{"get"=>{"summary"=>"List enrollments", "description"=>"List enrollments.", "operationId"=>"list-enrollments", "x-api-path-slug"=>"sectionssection-idenrollments-get", "parameters"=>[{"in"=>"query", "name"=>"grading_period_id", "description"=>"Return grades for the given grading_period"}, {"in"=>"query", "name"=>"role[]", "description"=>"A list of enrollment roles to return"}, {"in"=>"query", "name"=>"state[]", "description"=>"Filter by enrollment state"}, {"in"=>"query", "name"=>"type[]", "description"=>"A list of enrollment types to return"}, {"in"=>"query", "name"=>"user_id", "description"=>"Filter by user_id (only valid for course or section enrollment queries)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Section", "Id", "Enrollments"]}, "post"=>{"summary"=>"Enroll a user", "description"=>"Enroll a user.", "operationId"=>"enroll-a-user", "x-api-path-slug"=>"sectionssection-idenrollments-post", "parameters"=>[{"in"=>"query", "name"=>"enrollment[course_section_id]", "description"=>"The ID of the course section to enroll the student in"}, {"in"=>"query", "name"=>"enrollment[enrollment_state]", "description"=>"If set to 'active,' student will be immediately enrolled in thencourse"}, {"in"=>"query", "name"=>"enrollment[limit_privileges_to_course_section]", "description"=>"If set, the enrollment will only allow the user to see and interact withnusers enrolled in the section given by course_section_id"}, {"in"=>"query", "name"=>"enrollment[notify]", "description"=>"If true, a notification will be sent to the enrolled user"}, {"in"=>"query", "name"=>"enrollment[role]", "description"=>"Assigns a custom course-level role to the user"}, {"in"=>"query", "name"=>"enrollment[role_id]", "description"=>"Assigns a custom course-level role to the user"}, {"in"=>"query", "name"=>"enrollment[self_enrolled]", "description"=>"If true, marks the enrollment as a self-enrollment, which gives studentsnthe ability to drop the course if desired"}, {"in"=>"query", "name"=>"enrollment[self_enrollment_code]", "description"=>"If the current user is not allowed to manage enrollments in this course,nbut the course allows self-enrollment, the user can self- enroll as anstudent in the default section by passing in a valid code"}, {"in"=>"query", "name"=>"enrollment[type]", "description"=>"Enroll the user as a student, teacher, TA, observer, or designer"}, {"in"=>"query", "name"=>"enrollment[user_id]", "description"=>"The ID of the user to be enrolled in the course"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Section", "Id", "Enrollments"]}}, "/sections/{section_id}/students/submissions"=>{"get"=>{"summary"=>"List submissions for multiple assignments", "description"=>"List submissions for multiple assignments.", "operationId"=>"list-submissions-for-multiple-assignments", "x-api-path-slug"=>"sectionssection-idstudentssubmissions-get", "parameters"=>[{"in"=>"query", "name"=>"assignment_ids[]", "description"=>"List of assignments to return submissions for"}, {"in"=>"query", "name"=>"grading_period_id", "description"=>"The id of the grading period in which submissions are being requestedn(Requires the Multiple Grading Periods account feature turned on)"}, {"in"=>"query", "name"=>"grouped", "description"=>"If this argument is present, the response will be grouped by student,nrather than a flat array of submissions"}, {"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the group"}, {"in"=>"query", "name"=>"student_ids[]", "description"=>"List of student ids to return submissions for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Section", "Id", "Students", "Submissions"]}}, "/sections/{section_id}/submissions/update_grades"=>{"post"=>{"summary"=>"Grade or comment on multiple submissions", "description"=>"Grade or comment on multiple submissions.", "operationId"=>"grade-or-comment-on-multiple-submissions", "x-api-path-slug"=>"sectionssection-idsubmissionsupdate-grades-post", "parameters"=>[{"in"=>"query", "name"=>"grade_data[student_id][file_ids][]", "description"=>"See documentation for the comment[] arguments in thenSubmissions Update documentation"}, {"in"=>"query", "name"=>"grade_data[student_id][group_comment]", "description"=>"no description"}, {"in"=>"query", "name"=>"grade_data[student_id][media_comment_id]", "description"=>"no description"}, {"in"=>"query", "name"=>"grade_data[student_id][media_comment_type]", "description"=>"no descriptionnn n n Allowed values: audio, video"}, {"in"=>"query", "name"=>"grade_data[student_id][posted_grade]", "description"=>"See documentation for the posted_grade argument in thenSubmissions Update documentation"}, {"in"=>"query", "name"=>"grade_data[student_id][rubric_assessment]", "description"=>"See documentation for the rubric_assessment argument in thenSubmissions Update documentation"}, {"in"=>"query", "name"=>"grade_data[student_id][text_comment]", "description"=>"no description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "Section", "Id", "Submissions", "Update", "Grades"]}}}}, "instructure-canvas-groups-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Instructure", "x-complete"=>1, "info"=>{"title"=>"Instructure Canvas Groups API", "description"=>"canvas-lms-includes-a-rest-api-for-accessing-and-modifying-data-externally-from-the-main-application-in-your-own-programs-and-scripts--", "termsOfService"=>"https://www.canvaslms.com/policies/api-policy", "version"=>"v1"}, "host"=>"canvas.instructure.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/groups"=>{"post"=>{"summary"=>"Create a group", "description"=>"Create a group.", "operationId"=>"create-a-group", "x-api-path-slug"=>"groups-post", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"A description of the group"}, {"in"=>"query", "name"=>"is_public", "description"=>"whether the group is public (applies only to community groups)"}, {"in"=>"query", "name"=>"join_level", "description"=>"no descriptionnn n n Allowed values: parent_context_auto_join, parent_context_request, invitation_only"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the group"}, {"in"=>"query", "name"=>"storage_quota_mb", "description"=>"The allowed file storage for the group, in megabytes"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/groups/{group_id}"=>{"delete"=>{"summary"=>"Delete a group", "description"=>"Delete a group.", "operationId"=>"delete-a-group", "x-api-path-slug"=>"groupsgroup-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id"]}, "get"=>{"summary"=>"Get a single group", "description"=>"Get a single group.", "operationId"=>"get-a-single-group", "x-api-path-slug"=>"groupsgroup-id-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"u201cpermissionsu201d: Include permissions the current user has for the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id"]}, "put"=>{"summary"=>"Edit a group", "description"=>"Edit a group.", "operationId"=>"edit-a-group", "x-api-path-slug"=>"groupsgroup-id-put", "parameters"=>[{"in"=>"query", "name"=>"avatar_id", "description"=>"The id of the attachment previously uploaded to the group that you wouldnlike to use as the avatar image for this group"}, {"in"=>"query", "name"=>"description", "description"=>"A description of the group"}, {"in"=>"query", "name"=>"is_public", "description"=>"Whether the group is public (applies only to community groups)"}, {"in"=>"query", "name"=>"join_level", "description"=>"no descriptionnn n n Allowed values: parent_context_auto_join, parent_context_request, invitation_only"}, {"in"=>"query", "name"=>"members[]", "description"=>"An array of user ids for users you would like in the group"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the group"}, {"in"=>"query", "name"=>"storage_quota_mb", "description"=>"The allowed file storage for the group, in megabytes"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id"]}}, "/groups/{group_id}/activity_stream"=>{"get"=>{"summary"=>"Group activity stream", "description"=>"Group activity stream.", "operationId"=>"group-activity-stream", "x-api-path-slug"=>"groupsgroup-idactivity-stream-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Activity", "Stream"]}}, "/groups/{group_id}/activity_stream/summary"=>{"get"=>{"summary"=>"Group activity stream summary", "description"=>"Group activity stream summary.", "operationId"=>"group-activity-stream-summary", "x-api-path-slug"=>"groupsgroup-idactivity-streamsummary-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Activity", "Stream", "Summary"]}}, "/groups/{group_id}/assignments/assignment_id/override"=>{"get"=>{"summary"=>"Redirect to the assignment override for a group", "description"=>"Redirect to the assignment override for a group.", "operationId"=>"redirect-to-the-assignment-override-for-a-group", "x-api-path-slug"=>"groupsgroup-idassignmentsassignment-idoverride-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Assignments", "Assignment", "Id", "Override"]}}, "/groups/{group_id}/conferences"=>{"get"=>{"summary"=>"List conferences", "description"=>"List conferences.", "operationId"=>"list-conferences", "x-api-path-slug"=>"groupsgroup-idconferences-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Conferences"]}}, "/groups/{group_id}/content_exports"=>{"get"=>{"summary"=>"List content exports", "description"=>"List content exports.", "operationId"=>"list-content-exports", "x-api-path-slug"=>"groupsgroup-idcontent-exports-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Content", "Exports"]}, "post"=>{"summary"=>"Export content", "description"=>"Export content.", "operationId"=>"export-content", "x-api-path-slug"=>"groupsgroup-idcontent-exports-post", "parameters"=>[{"in"=>"query", "name"=>"export_type", "description"=>"u201ccommon_cartridgeu201dnnExport the contents of the course in the Common Cartridge ("}, {"in"=>"query", "name"=>"skip_notifications", "description"=>"Don't send the notifications about the export to the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Content", "Exports"]}}, "/groups/{group_id}/content_exports/id"=>{"get"=>{"summary"=>"Show content export", "description"=>"Show content export.", "operationId"=>"show-content-export", "x-api-path-slug"=>"groupsgroup-idcontent-exportsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Content", "Exports", "Id"]}}, "/groups/{group_id}/content_licenses"=>{"get"=>{"summary"=>"List licenses", "description"=>"List licenses.", "operationId"=>"list-licenses", "x-api-path-slug"=>"groupsgroup-idcontent-licenses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Content", "Licenses"]}}, "/groups/{group_id}/content_migrations"=>{"get"=>{"summary"=>"List content migrations", "description"=>"List content migrations.", "operationId"=>"list-content-migrations", "x-api-path-slug"=>"groupsgroup-idcontent-migrations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Content", "Migrations"]}, "post"=>{"summary"=>"Create a content migration", "description"=>"Create a content migration.", "operationId"=>"create-a-content-migration", "x-api-path-slug"=>"groupsgroup-idcontent-migrations-post", "parameters"=>[{"in"=>"query", "name"=>"date_shift_options[day_substitutions][X]", "description"=>"Move anything scheduled for day 'X' to the specified day"}, {"in"=>"query", "name"=>"date_shift_options[new_end_date]", "description"=>"The new end date for the source content/course"}, {"in"=>"query", "name"=>"date_shift_options[new_start_date]", "description"=>"The new start date for the content/course"}, {"in"=>"query", "name"=>"date_shift_options[old_end_date]", "description"=>"The original end date of the source content/course"}, {"in"=>"query", "name"=>"date_shift_options[old_start_date]", "description"=>"The original start date of the source content/course"}, {"in"=>"query", "name"=>"date_shift_options[remove_dates]", "description"=>"Whether to remove dates in the copied course"}, {"in"=>"query", "name"=>"date_shift_options[shift_dates]", "description"=>"Whether to shift dates in the copied course"}, {"in"=>"query", "name"=>"migration_type", "description"=>"The type of the migration"}, {"in"=>"query", "name"=>"pre_attachment[*]", "description"=>"Other file upload properties, See File Upload Documentation"}, {"in"=>"query", "name"=>"pre_attachment[name]", "description"=>"Required if uploading a file"}, {"in"=>"query", "name"=>"settings[file_url]", "description"=>"A URL to download the file from"}, {"in"=>"query", "name"=>"settings[folder_id]", "description"=>"The folder to unzip the "}, {"in"=>"query", "name"=>"settings[overwrite_quizzes]", "description"=>"Whether to overwrite quizzes with the same identifiers between contentnpackages"}, {"in"=>"query", "name"=>"settings[question_bank_id]", "description"=>"The existing question bank ID to import questions into if not specified innthe content package"}, {"in"=>"query", "name"=>"settings[question_bank_name]", "description"=>"The question bank to import questions into if not specified in the contentnpackage, if both bank id and name are set, id will take precedence"}, {"in"=>"query", "name"=>"settings[source_course_id]", "description"=>"The course to copy from for a course copy migration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Content", "Migrations"]}}, "/groups/{group_id}/content_migrations/content_migration_id/migration_issues"=>{"get"=>{"summary"=>"List migration issues", "description"=>"List migration issues.", "operationId"=>"list-migration-issues", "x-api-path-slug"=>"groupsgroup-idcontent-migrationscontent-migration-idmigration-issues-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Content", "Migrations", "Content", "Migration", "Id", "Migration", "Issues"]}}, "/groups/{group_id}/content_migrations/content_migration_id/migration_issues/{id}"=>{"get"=>{"summary"=>"Get a migration issue", "description"=>"Get a migration issue.", "operationId"=>"get-a-migration-issue", "x-api-path-slug"=>"groupsgroup-idcontent-migrationscontent-migration-idmigration-issuesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Content", "Migrations", "Content", "Migration", "Id", "Migration", "Issues", "Id"]}, "put"=>{"summary"=>"Update a migration issue", "description"=>"Update a migration issue.", "operationId"=>"update-a-migration-issue", "x-api-path-slug"=>"groupsgroup-idcontent-migrationscontent-migration-idmigration-issuesid-put", "parameters"=>[{"in"=>"query", "name"=>"workflow_state", "description"=>"Set the workflow_state of the issue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Content", "Migrations", "Content", "Migration", "Id", "Migration", "Issues", "Id"]}}, "/groups/{group_id}/content_migrations/id"=>{"get"=>{"summary"=>"Get a content migration", "description"=>"Get a content migration.", "operationId"=>"get-a-content-migration", "x-api-path-slug"=>"groupsgroup-idcontent-migrationsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Content", "Migrations", "Id"]}, "put"=>{"summary"=>"Update a content migration", "description"=>"Update a content migration.", "operationId"=>"update-a-content-migration", "x-api-path-slug"=>"groupsgroup-idcontent-migrationsid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Content", "Migrations", "Id"]}}, "/groups/{group_id}/content_migrations/migrators"=>{"get"=>{"summary"=>"List Migration Systems", "description"=>"List migration systems.", "operationId"=>"list-migration-systems", "x-api-path-slug"=>"groupsgroup-idcontent-migrationsmigrators-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Content", "Migrations", "Migrators"]}}, "/groups/{group_id}/discussion_topics"=>{"get"=>{"summary"=>"List discussion topics", "description"=>"List discussion topics.", "operationId"=>"list-discussion-topics", "x-api-path-slug"=>"groupsgroup-iddiscussion-topics-get", "parameters"=>[{"in"=>"query", "name"=>"only_announcements", "description"=>"Return announcements instead of discussion topics"}, {"in"=>"query", "name"=>"order_by", "description"=>"Determines the order of the discussion topic list"}, {"in"=>"query", "name"=>"scope", "description"=>"Only return discussion topics in the given state(s)"}, {"in"=>"query", "name"=>"search_term", "description"=>"The partial title of the discussion topics to match and return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics"]}, "post"=>{"summary"=>"Create a new discussion topic", "description"=>"Create a new discussion topic.", "operationId"=>"create-a-new-discussion-topic", "x-api-path-slug"=>"groupsgroup-iddiscussion-topics-post", "parameters"=>[{"in"=>"query", "name"=>"allow_rating", "description"=>"If true, users will be allowed to rate entries"}, {"in"=>"query", "name"=>"assignment", "description"=>"To create an assignment discussion, pass the assignment parameters as ansub-object"}, {"in"=>"query", "name"=>"attachment", "description"=>"A multipart/form-data form-field-style attachment"}, {"in"=>"query", "name"=>"delayed_post_at", "description"=>"If a timestamp is given, the topic will not be published until that time"}, {"in"=>"query", "name"=>"discussion_type", "description"=>"The type of discussion"}, {"in"=>"query", "name"=>"group_category_id", "description"=>"If present, the topic will become a group discussion assigned to the group"}, {"in"=>"query", "name"=>"is_announcement", "description"=>"If true, this topic is an announcement"}, {"in"=>"query", "name"=>"lock_at", "description"=>"If a timestamp is given, the topic will be scheduled to lock at thenprovided timestamp"}, {"in"=>"query", "name"=>"message", "description"=>"no description"}, {"in"=>"query", "name"=>"only_graders_can_rate", "description"=>"If true, only graders will be allowed to rate entries"}, {"in"=>"query", "name"=>"pinned", "description"=>"If true, this topic will be listed in the u201cPinned Discussionu201d section"}, {"in"=>"query", "name"=>"podcast_enabled", "description"=>"If true, the topic will have an associated podcast feed"}, {"in"=>"query", "name"=>"podcast_has_student_posts", "description"=>"If true, the podcast will include posts from students as well"}, {"in"=>"query", "name"=>"position_after", "description"=>"By default, discussions are sorted chronologically by creation date, youncan pass the id of another topic to have this one show up after the othernwhen they are listed"}, {"in"=>"query", "name"=>"published", "description"=>"Whether this topic is published (true) or draft state (false)"}, {"in"=>"query", "name"=>"require_initial_post", "description"=>"If true then a user may not respond to other replies until that user hasnmade an initial reply"}, {"in"=>"query", "name"=>"sort_by_rating", "description"=>"If true, entries will be sorted by rating"}, {"in"=>"query", "name"=>"title", "description"=>"no description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics"]}}, "/groups/{group_id}/discussion_topics/reorder"=>{"post"=>{"summary"=>"Reorder pinned topics", "description"=>"Reorder pinned topics.", "operationId"=>"reorder-pinned-topics", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicsreorder-post", "parameters"=>[{"in"=>"query", "name"=>"order[]", "description"=>"The ids of the pinned discussion topics in the desired order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Reorder"]}}, "/groups/{group_id}/discussion_topics/topic_id"=>{"delete"=>{"summary"=>"Delete a topic", "description"=>"Delete a topic.", "operationId"=>"delete-a-topic", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id"]}, "get"=>{"summary"=>"Get a single topic", "description"=>"Get a single topic.", "operationId"=>"get-a-single-topic", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id"]}, "put"=>{"summary"=>"Update a topic", "description"=>"Update a topic.", "operationId"=>"update-a-topic", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-id-put", "parameters"=>[{"in"=>"query", "name"=>"allow_rating", "description"=>"If true, users will be allowed to rate entries"}, {"in"=>"query", "name"=>"assignment", "description"=>"To create an assignment discussion, pass the assignment parameters as ansub-object"}, {"in"=>"query", "name"=>"delayed_post_at", "description"=>"If a timestamp is given, the topic will not be published until that time"}, {"in"=>"query", "name"=>"discussion_type", "description"=>"The type of discussion"}, {"in"=>"query", "name"=>"group_category_id", "description"=>"If present, the topic will become a group discussion assigned to the group"}, {"in"=>"query", "name"=>"is_announcement", "description"=>"If true, this topic is an announcement"}, {"in"=>"query", "name"=>"lock_at", "description"=>"If a timestamp is given, the topic will be scheduled to lock at thenprovided timestamp"}, {"in"=>"query", "name"=>"message", "description"=>"no description"}, {"in"=>"query", "name"=>"only_graders_can_rate", "description"=>"If true, only graders will be allowed to rate entries"}, {"in"=>"query", "name"=>"pinned", "description"=>"If true, this topic will be listed in the u201cPinned Discussionu201d section"}, {"in"=>"query", "name"=>"podcast_enabled", "description"=>"If true, the topic will have an associated podcast feed"}, {"in"=>"query", "name"=>"podcast_has_student_posts", "description"=>"If true, the podcast will include posts from students as well"}, {"in"=>"query", "name"=>"position_after", "description"=>"By default, discussions are sorted chronologically by creation date, youncan pass the id of another topic to have this one show up after the othernwhen they are listed"}, {"in"=>"query", "name"=>"published", "description"=>"Whether this topic is published (true) or draft state (false)"}, {"in"=>"query", "name"=>"require_initial_post", "description"=>"If true then a user may not respond to other replies until that user hasnmade an initial reply"}, {"in"=>"query", "name"=>"sort_by_rating", "description"=>"If true, entries will be sorted by rating"}, {"in"=>"query", "name"=>"title", "description"=>"no description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id"]}}, "/groups/{group_id}/discussion_topics/topic_id/entries"=>{"get"=>{"summary"=>"List topic entries", "description"=>"List topic entries.", "operationId"=>"list-topic-entries", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-identries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "Entries"]}, "post"=>{"summary"=>"Post an entry", "description"=>"Post an entry.", "operationId"=>"post-an-entry", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-identries-post", "parameters"=>[{"in"=>"query", "name"=>"attachment", "description"=>"a multipart/form-data form-field-style attachment"}, {"in"=>"query", "name"=>"message", "description"=>"The body of the entry"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "Entries"]}}, "/groups/{group_id}/discussion_topics/topic_id/entries/{entry_id}/rating"=>{"post"=>{"summary"=>"Rate entry", "description"=>"Rate entry.", "operationId"=>"rate-entry", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-identriesentry-idrating-post", "parameters"=>[{"in"=>"query", "name"=>"rating", "description"=>"A rating to set on this entry"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "Entries", "Entry", "Id", "Rating"]}}, "/groups/{group_id}/discussion_topics/topic_id/entries/{entry_id}/read"=>{"delete"=>{"summary"=>"Mark entry as unread", "description"=>"Mark entry as unread.", "operationId"=>"mark-entry-as-unread", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-identriesentry-idread-delete", "parameters"=>[{"in"=>"query", "name"=>"forced_read_state", "description"=>"A boolean value to set the entry's forced_read_state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "Entries", "Entry", "Id", "Read"]}, "put"=>{"summary"=>"Mark entry as read", "description"=>"Mark entry as read.", "operationId"=>"mark-entry-as-read", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-identriesentry-idread-put", "parameters"=>[{"in"=>"query", "name"=>"forced_read_state", "description"=>"A boolean value to set the entry's forced_read_state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "Entries", "Entry", "Id", "Read"]}}, "/groups/{group_id}/discussion_topics/topic_id/entries/{entry_id}/replies"=>{"get"=>{"summary"=>"List entry replies", "description"=>"List entry replies.", "operationId"=>"list-entry-replies", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-identriesentry-idreplies-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "Entries", "Entry", "Id", "Replies"]}, "post"=>{"summary"=>"Post a reply", "description"=>"Post a reply.", "operationId"=>"post-a-reply", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-identriesentry-idreplies-post", "parameters"=>[{"in"=>"query", "name"=>"attachment", "description"=>"a multipart/form-data form-field-style attachment"}, {"in"=>"query", "name"=>"message", "description"=>"The body of the entry"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "Entries", "Entry", "Id", "Replies"]}}, "/groups/{group_id}/discussion_topics/topic_id/entries/{id}"=>{"delete"=>{"summary"=>"Delete an entry", "description"=>"Delete an entry.", "operationId"=>"delete-an-entry", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-identriesid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "Entries", "Id"]}, "put"=>{"summary"=>"Update an entry", "description"=>"Update an entry.", "operationId"=>"update-an-entry", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-identriesid-put", "parameters"=>[{"in"=>"query", "name"=>"message", "description"=>"The updated body of the entry"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "Entries", "Id"]}}, "/groups/{group_id}/discussion_topics/topic_id/entry_list"=>{"get"=>{"summary"=>"List entries", "description"=>"List entries.", "operationId"=>"list-entries", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-identry-list-get", "parameters"=>[{"in"=>"query", "name"=>"ids[]", "description"=>"A list of entry ids to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "Entry", "List"]}}, "/groups/{group_id}/discussion_topics/topic_id/read"=>{"delete"=>{"summary"=>"Mark topic as unread", "description"=>"Mark topic as unread.", "operationId"=>"mark-topic-as-unread", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-idread-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "Read"]}, "put"=>{"summary"=>"Mark topic as read", "description"=>"Mark topic as read.", "operationId"=>"mark-topic-as-read", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-idread-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "Read"]}}, "/groups/{group_id}/discussion_topics/topic_id/read_all"=>{"delete"=>{"summary"=>"Mark all entries as unread", "description"=>"Mark all entries as unread.", "operationId"=>"mark-all-entries-as-unread", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-idread-all-delete", "parameters"=>[{"in"=>"query", "name"=>"forced_read_state", "description"=>"A boolean value to set all of the entries' forced_read_state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "Read"]}, "put"=>{"summary"=>"Mark all entries as read", "description"=>"Mark all entries as read.", "operationId"=>"mark-all-entries-as-read", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-idread-all-put", "parameters"=>[{"in"=>"query", "name"=>"forced_read_state", "description"=>"A boolean value to set all of the entries' forced_read_state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "Read"]}}, "/groups/{group_id}/discussion_topics/topic_id/subscribed"=>{"delete"=>{"summary"=>"Unsubscribe from a topic", "description"=>"Unsubscribe from a topic.", "operationId"=>"unsubscribe-from-a-topic", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-idsubscribed-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "Subscribed"]}, "put"=>{"summary"=>"Subscribe to a topic", "description"=>"Subscribe to a topic.", "operationId"=>"subscribe-to-a-topic", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-idsubscribed-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "Subscribed"]}}, "/groups/{group_id}/discussion_topics/topic_id/view"=>{"get"=>{"summary"=>"Get the full topic", "description"=>"Get the full topic.", "operationId"=>"get-the-full-topic", "x-api-path-slug"=>"groupsgroup-iddiscussion-topicstopic-idview-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Discussion", "Topics", "Topic", "Id", "View"]}}, "/groups/{group_id}/external_feeds"=>{"get"=>{"summary"=>"List external feeds", "description"=>"List external feeds.", "operationId"=>"list-external-feeds", "x-api-path-slug"=>"groupsgroup-idexternal-feeds-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "External", "Feeds"]}, "post"=>{"summary"=>"Create an external feed", "description"=>"Create an external feed.", "operationId"=>"create-an-external-feed", "x-api-path-slug"=>"groupsgroup-idexternal-feeds-post", "parameters"=>[{"in"=>"query", "name"=>"header_match", "description"=>"If given, only feed entries that contain this string in their title will benimported"}, {"in"=>"query", "name"=>"url", "description"=>"The url to the external rss or atom feed"}, {"in"=>"query", "name"=>"verbosity", "description"=>"Defaults to u201cfullu201dnn n n Allowed values: full, truncate, link_only"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "External", "Feeds"]}}, "/groups/{group_id}/external_feeds/external_feed_id"=>{"delete"=>{"summary"=>"Delete an external feed", "description"=>"Delete an external feed.", "operationId"=>"delete-an-external-feed", "x-api-path-slug"=>"groupsgroup-idexternal-feedsexternal-feed-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "External", "Feeds", "External", "Feed", "Id"]}}, "/groups/{group_id}/files"=>{"get"=>{"summary"=>"List files", "description"=>"List files.", "operationId"=>"list-files", "x-api-path-slug"=>"groupsgroup-idfiles-get", "parameters"=>[{"in"=>"query", "name"=>"content_types[]", "description"=>"Filter results by content-type"}, {"in"=>"query", "name"=>"include[]", "description"=>"Array of additional information to include"}, {"in"=>"query", "name"=>"only[]", "description"=>"Array of information to restrict to"}, {"in"=>"query", "name"=>"order", "description"=>"The sorting order"}, {"in"=>"query", "name"=>"search_term", "description"=>"The partial name of the files to match and return"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort results by this field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Files"]}, "post"=>{"summary"=>"Upload a file", "description"=>"Upload a file.", "operationId"=>"upload-a-file", "x-api-path-slug"=>"groupsgroup-idfiles-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Files"]}}, "/groups/{group_id}/files/id"=>{"get"=>{"summary"=>"Get file", "description"=>"Get file.", "operationId"=>"get-file", "x-api-path-slug"=>"groupsgroup-idfilesid-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Array of additional information to include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Files", "Id"]}}, "/groups/{group_id}/files/quota"=>{"get"=>{"summary"=>"Get quota information", "description"=>"Get quota information.", "operationId"=>"get-quota-information", "x-api-path-slug"=>"groupsgroup-idfilesquota-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Files", "Quota"]}}, "/groups/{group_id}/folders"=>{"get"=>{"summary"=>"List all folders", "description"=>"List all folders.", "operationId"=>"list-all-folders", "x-api-path-slug"=>"groupsgroup-idfolders-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Folders"]}, "post"=>{"summary"=>"Create folder", "description"=>"Create folder.", "operationId"=>"create-folder", "x-api-path-slug"=>"groupsgroup-idfolders-post", "parameters"=>[{"in"=>"query", "name"=>"hidden", "description"=>"Flag the folder as hidden"}, {"in"=>"query", "name"=>"locked", "description"=>"Flag the folder as locked"}, {"in"=>"query", "name"=>"lock_at", "description"=>"The datetime to lock the folder at"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the folder"}, {"in"=>"query", "name"=>"parent_folder_id", "description"=>"The id of the folder to store the file in"}, {"in"=>"query", "name"=>"parent_folder_path", "description"=>"The path of the folder to store the new folder in"}, {"in"=>"query", "name"=>"position", "description"=>"Set an explicit sort position for the folder"}, {"in"=>"query", "name"=>"unlock_at", "description"=>"The datetime to unlock the folder at"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Folders"]}}, "/groups/{group_id}/folders/by_path"=>{"get"=>{"summary"=>"Resolve path", "description"=>"Resolve path.", "operationId"=>"resolve-path", "x-api-path-slug"=>"groupsgroup-idfoldersby-path-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Folders", "By", "Path"]}}, "/groups/{group_id}/folders/by_path/*full_path"=>{"get"=>{"summary"=>"Resolve path", "description"=>"Resolve path.", "operationId"=>"resolve-path", "x-api-path-slug"=>"groupsgroup-idfoldersby-pathfull-path-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Folders", "By", "Path", "*full", "Path"]}}, "/groups/{group_id}/folders/id"=>{"get"=>{"summary"=>"Get folder", "description"=>"Get folder.", "operationId"=>"get-folder", "x-api-path-slug"=>"groupsgroup-idfoldersid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Folders", "Id"]}}, "/groups/{group_id}/front_page"=>{"get"=>{"summary"=>"Show front page", "description"=>"Show front page.", "operationId"=>"show-front-page", "x-api-path-slug"=>"groupsgroup-idfront-page-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Front", "Page"]}, "put"=>{"summary"=>"Update/create front page", "description"=>"Update/create front page.", "operationId"=>"updatecreate-front-page", "x-api-path-slug"=>"groupsgroup-idfront-page-put", "parameters"=>[{"in"=>"query", "name"=>"wiki_page[body]", "description"=>"The content for the new page"}, {"in"=>"query", "name"=>"wiki_page[editing_roles]", "description"=>"Which user roles are allowed to edit this page"}, {"in"=>"query", "name"=>"wiki_page[notify_of_update]", "description"=>"Whether participants should be notified when this page changes"}, {"in"=>"query", "name"=>"wiki_page[published]", "description"=>"Whether the page is published (true) or draft state (false)"}, {"in"=>"query", "name"=>"wiki_page[title]", "description"=>"The title for the new page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Front", "Page"]}}, "/groups/{group_id}/invite"=>{"post"=>{"summary"=>"Invite others to a group", "description"=>"Invite others to a group.", "operationId"=>"invite-others-to-a-group", "x-api-path-slug"=>"groupsgroup-idinvite-post", "parameters"=>[{"in"=>"query", "name"=>"invitees[]", "description"=>"An array of email addresses to be sent invitations"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Invite"]}}, "/groups/{group_id}/memberships"=>{"get"=>{"summary"=>"List group memberships", "description"=>"List group memberships.", "operationId"=>"list-group-memberships", "x-api-path-slug"=>"groupsgroup-idmemberships-get", "parameters"=>[{"in"=>"query", "name"=>"filter_states[]", "description"=>"Only list memberships with the given workflow_states"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Memberships"]}, "post"=>{"summary"=>"Create a membership", "description"=>"Create a membership.", "operationId"=>"create-a-membership", "x-api-path-slug"=>"groupsgroup-idmemberships-post", "parameters"=>[{"in"=>"query", "name"=>"user_id", "description"=>"no description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Memberships"]}}, "/groups/{group_id}/memberships/membership_id"=>{"delete"=>{"summary"=>"Leave a group", "description"=>"Leave a group.", "operationId"=>"leave-a-group", "x-api-path-slug"=>"groupsgroup-idmembershipsmembership-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Memberships", "Membership", "Id"]}, "get"=>{"summary"=>"Get a single group membership", "description"=>"Get a single group membership.", "operationId"=>"get-a-single-group-membership", "x-api-path-slug"=>"groupsgroup-idmembershipsmembership-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Memberships", "Membership", "Id"]}, "put"=>{"summary"=>"Update a membership", "description"=>"Update a membership.", "operationId"=>"update-a-membership", "x-api-path-slug"=>"groupsgroup-idmembershipsmembership-id-put", "parameters"=>[{"in"=>"query", "name"=>"moderator", "description"=>"no description"}, {"in"=>"query", "name"=>"workflow_state", "description"=>"Currently, the only allowed value is u201cacceptedu201dnn n n Allowed values: accepted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Memberships", "Membership", "Id"]}}, "/groups/{group_id}/pages"=>{"get"=>{"summary"=>"List pages", "description"=>"List pages.", "operationId"=>"list-pages", "x-api-path-slug"=>"groupsgroup-idpages-get", "parameters"=>[{"in"=>"query", "name"=>"order", "description"=>"The sorting order"}, {"in"=>"query", "name"=>"published", "description"=>"If true, include only published paqes"}, {"in"=>"query", "name"=>"search_term", "description"=>"The partial title of the pages to match and return"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort results by this field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Pages"]}, "post"=>{"summary"=>"Create page", "description"=>"Create page.", "operationId"=>"create-page", "x-api-path-slug"=>"groupsgroup-idpages-post", "parameters"=>[{"in"=>"query", "name"=>"wiki_page[body]", "description"=>"The content for the new page"}, {"in"=>"query", "name"=>"wiki_page[editing_roles]", "description"=>"Which user roles are allowed to edit this page"}, {"in"=>"query", "name"=>"wiki_page[front_page]", "description"=>"Set an unhidden page as the front page (if true)"}, {"in"=>"query", "name"=>"wiki_page[notify_of_update]", "description"=>"Whether participants should be notified when this page changes"}, {"in"=>"query", "name"=>"wiki_page[published]", "description"=>"Whether the page is published (true) or draft state (false)"}, {"in"=>"query", "name"=>"wiki_page[title]", "description"=>"The title for the new page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Pages"]}}, "/groups/{group_id}/pages/url"=>{"delete"=>{"summary"=>"Delete page", "description"=>"Delete page.", "operationId"=>"delete-page", "x-api-path-slug"=>"groupsgroup-idpagesurl-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Pages", "Url"]}, "get"=>{"summary"=>"Show page", "description"=>"Show page.", "operationId"=>"show-page", "x-api-path-slug"=>"groupsgroup-idpagesurl-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Pages", "Url"]}, "put"=>{"summary"=>"Update/create page", "description"=>"Update/create page.", "operationId"=>"updatecreate-page", "x-api-path-slug"=>"groupsgroup-idpagesurl-put", "parameters"=>[{"in"=>"query", "name"=>"wiki_page[body]", "description"=>"The content for the new page"}, {"in"=>"query", "name"=>"wiki_page[editing_roles]", "description"=>"Which user roles are allowed to edit this page"}, {"in"=>"query", "name"=>"wiki_page[front_page]", "description"=>"Set an unhidden page as the front page (if true)"}, {"in"=>"query", "name"=>"wiki_page[notify_of_update]", "description"=>"Whether participants should be notified when this page changes"}, {"in"=>"query", "name"=>"wiki_page[published]", "description"=>"Whether the page is published (true) or draft state (false)"}, {"in"=>"query", "name"=>"wiki_page[title]", "description"=>"The title for the new page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Pages", "Url"]}}, "/groups/{group_id}/pages/url/revisions"=>{"get"=>{"summary"=>"List revisions", "description"=>"List revisions.", "operationId"=>"list-revisions", "x-api-path-slug"=>"groupsgroup-idpagesurlrevisions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Pages", "Url", "Revisions"]}}, "/groups/{group_id}/pages/url/revisions/latest"=>{"get"=>{"summary"=>"Show revision", "description"=>"Show revision.", "operationId"=>"show-revision", "x-api-path-slug"=>"groupsgroup-idpagesurlrevisionslatest-get", "parameters"=>[{"in"=>"query", "name"=>"summary", "description"=>"If set, exclude page content from results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Pages", "Url", "Revisions", "Latest"]}}, "/groups/{group_id}/pages/url/revisions/{revision_id}"=>{"get"=>{"summary"=>"Show revision", "description"=>"Show revision.", "operationId"=>"show-revision", "x-api-path-slug"=>"groupsgroup-idpagesurlrevisionsrevision-id-get", "parameters"=>[{"in"=>"query", "name"=>"summary", "description"=>"If set, exclude page content from results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Pages", "Url", "Revisions", "Revision", "Id"]}, "post"=>{"summary"=>"Revert to revision", "description"=>"Revert to revision.", "operationId"=>"revert-to-revision", "x-api-path-slug"=>"groupsgroup-idpagesurlrevisionsrevision-id-post", "parameters"=>[{"in"=>"query", "name"=>"revision_id", "description"=>"The revision to revert to (use the List Revisions API to see available revisions)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Pages", "Url", "Revisions", "Revision", "Id"]}}, "/groups/{group_id}/preview_html"=>{"post"=>{"summary"=>"Preview processed html", "description"=>"Preview processed html.", "operationId"=>"preview-processed-html", "x-api-path-slug"=>"groupsgroup-idpreview-html-post", "parameters"=>[{"in"=>"query", "name"=>"html", "description"=>"The html content to process"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Preview", "Html"]}}, "/groups/{group_id}/tabs"=>{"get"=>{"summary"=>"List available tabs for a course or group", "description"=>"List available tabs for a course or group.", "operationId"=>"list-available-tabs-for-a-course-or-group", "x-api-path-slug"=>"groupsgroup-idtabs-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Optionally include external tool tabs in the returned list of tabs (Onlynhas effect for courses, not groups)nn n n Allowed values: external"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Tabs"]}}, "/groups/{group_id}/usage_rights"=>{"delete"=>{"summary"=>"Remove usage rights", "description"=>"Remove usage rights.", "operationId"=>"remove-usage-rights", "x-api-path-slug"=>"groupsgroup-idusage-rights-delete", "parameters"=>[{"in"=>"query", "name"=>"file_ids[]", "description"=>"List of ids of files to remove associated usage rights from"}, {"in"=>"query", "name"=>"folder_ids[]", "description"=>"List of ids of folders"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Usage", "Rights"]}, "put"=>{"summary"=>"Set usage rights", "description"=>"Set usage rights.", "operationId"=>"set-usage-rights", "x-api-path-slug"=>"groupsgroup-idusage-rights-put", "parameters"=>[{"in"=>"query", "name"=>"file_ids[]", "description"=>"List of ids of files to set usage rights for"}, {"in"=>"query", "name"=>"folder_ids[]", "description"=>"List of ids of folders to search for files to set usage rights for"}, {"in"=>"query", "name"=>"publish", "description"=>"Whether the file(s) or folder(s) should be published on save, provided thatnusage rights have been specified (set to `true` to publish on save)"}, {"in"=>"query", "name"=>"usage_rights[legal_copyright]", "description"=>"The legal copyright line for the files"}, {"in"=>"query", "name"=>"usage_rights[license]", "description"=>"The license that applies to the files"}, {"in"=>"query", "name"=>"usage_rights[use_justification]", "description"=>"The intellectual property justification for using the files in Canvasnn n n Allowed values: own_copyright, used_by_permission, fair_use, public_domain, creative_commons"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Usage", "Rights"]}}, "/groups/{group_id}/users"=>{"get"=>{"summary"=>"List groups users", "description"=>"List groups users.", "operationId"=>"list-groups-users", "x-api-path-slug"=>"groupsgroup-idusers-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"u201cavatar_urlu201d: Include users' avatar_urls"}, {"in"=>"query", "name"=>"search_term", "description"=>"The partial name or full ID of the users to match and return in the resultsnlist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Users"]}}, "/groups/{group_id}/users/user_id"=>{"delete"=>{"summary"=>"Leave a group", "description"=>"Leave a group.", "operationId"=>"leave-a-group", "x-api-path-slug"=>"groupsgroup-idusersuser-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Users", "User", "Id"]}, "get"=>{"summary"=>"Get a single group membership", "description"=>"Get a single group membership.", "operationId"=>"get-a-single-group-membership", "x-api-path-slug"=>"groupsgroup-idusersuser-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Users", "User", "Id"]}, "put"=>{"summary"=>"Update a membership", "description"=>"Update a membership.", "operationId"=>"update-a-membership", "x-api-path-slug"=>"groupsgroup-idusersuser-id-put", "parameters"=>[{"in"=>"query", "name"=>"moderator", "description"=>"no description"}, {"in"=>"query", "name"=>"workflow_state", "description"=>"Currently, the only allowed value is u201cacceptedu201dnn n n Allowed values: accepted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Group", "Id", "Users", "User", "Id"]}}, "/group_categories/{group_category_id}"=>{"delete"=>{"summary"=>"Delete a Group Category", "description"=>"Delete a group category.", "operationId"=>"delete-a-group-category", "x-api-path-slug"=>"group-categoriesgroup-category-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Categories", "Group", "Category", "Id"]}, "get"=>{"summary"=>"Get a single group category", "description"=>"Get a single group category.", "operationId"=>"get-a-single-group-category", "x-api-path-slug"=>"group-categoriesgroup-category-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Categories", "Group", "Category", "Id"]}, "put"=>{"summary"=>"Update a Group Category", "description"=>"Update a group category.", "operationId"=>"update-a-group-category", "x-api-path-slug"=>"group-categoriesgroup-category-id-put", "parameters"=>[{"in"=>"query", "name"=>"auto_leader", "description"=>"Assigns group leaders automatically when generating and allocating studentsnto groups Valid values are:nu201cfirstu201dnnthe first student to be allocated to a group is the leadernu201crandomu201dnna random student from all members is chosen as the leadernnn n n Allowed values: first, random"}, {"in"=>"query", "name"=>"create_group_count", "description"=>"Create this number of groups (Course Only)"}, {"in"=>"query", "name"=>"group_limit", "description"=>"Limit the maximum number of users in each group (Course Only)"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the group category"}, {"in"=>"query", "name"=>"self_signup", "description"=>"Allow students to sign up for a group themselves (Course Only)"}, {"in"=>"query", "name"=>"split_group_count", "description"=>"(Deprecated) Create this number of groups, and evenly distribute studentsnamong them"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Categories", "Group", "Category", "Id"]}}, "/group_categories/{group_category_id}/assign_unassigned_members"=>{"post"=>{"summary"=>"Assign unassigned members", "description"=>"Assign unassigned members.", "operationId"=>"assign-unassigned-members", "x-api-path-slug"=>"group-categoriesgroup-category-idassign-unassigned-members-post", "parameters"=>[{"in"=>"query", "name"=>"sync", "description"=>"The assigning is done asynchronously by default"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Categories", "Group", "Category", "Id", "Assign", "Unassigned", "Members"]}}, "/group_categories/{group_category_id}/groups"=>{"get"=>{"summary"=>"List groups in group category", "description"=>"List groups in group category.", "operationId"=>"list-groups-in-group-category", "x-api-path-slug"=>"group-categoriesgroup-category-idgroups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Categories", "Group", "Category", "Id", "Groups"]}, "post"=>{"summary"=>"Create a group", "description"=>"Create a group.", "operationId"=>"create-a-group", "x-api-path-slug"=>"group-categoriesgroup-category-idgroups-post", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"A description of the group"}, {"in"=>"query", "name"=>"is_public", "description"=>"whether the group is public (applies only to community groups)"}, {"in"=>"query", "name"=>"join_level", "description"=>"no descriptionnn n n Allowed values: parent_context_auto_join, parent_context_request, invitation_only"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the group"}, {"in"=>"query", "name"=>"storage_quota_mb", "description"=>"The allowed file storage for the group, in megabytes"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Categories", "Group", "Category", "Id", "Groups"]}}, "/group_categories/{group_category_id}/users"=>{"get"=>{"summary"=>"List users in group category", "description"=>"List users in group category.", "operationId"=>"list-users-in-group-category", "x-api-path-slug"=>"group-categoriesgroup-category-idusers-get", "parameters"=>[{"in"=>"query", "name"=>"search_term", "description"=>"The partial name or full ID of the users to match and return in the resultsnlist"}, {"in"=>"query", "name"=>"unassigned", "description"=>"Set this value to true if you wish only to search unassigned users in thengroup category"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Categories", "Group", "Category", "Id", "Users"]}}}}, "instructure-canvas-courses-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Instructure", "x-complete"=>1, "info"=>{"title"=>"Instructure Canvas Courses API", "description"=>"canvas-lms-includes-a-rest-api-for-accessing-and-modifying-data-externally-from-the-main-application-in-your-own-programs-and-scripts--", "termsOfService"=>"https://www.canvaslms.com/policies/api-policy", "version"=>"v1"}, "host"=>"canvas.instructure.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/courses"=>{"get"=>{"summary"=>"List your courses", "description"=>"List your courses.", "operationId"=>"list-your-courses", "x-api-path-slug"=>"courses-get", "parameters"=>[{"in"=>"query", "name"=>"enrollment_role", "description"=>"Deprecated When set, only return courses where the user is enrolled withnthe specified course-level role"}, {"in"=>"query", "name"=>"enrollment_role_id", "description"=>"When set, only return courses where the user is enrolled with the specifiedncourse-level role"}, {"in"=>"query", "name"=>"enrollment_type", "description"=>"When set, only return courses where the user is enrolled as this type"}, {"in"=>"query", "name"=>"include[]", "description"=>"u201cneeds_grading_countu201d: Optional information to include with each Course"}, {"in"=>"query", "name"=>"state[]", "description"=>"If set, only return courses that are in the given state(s)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses"]}}, "/courses/{course_id}/activity_stream"=>{"get"=>{"summary"=>"Course activity stream", "description"=>"Course activity stream.", "operationId"=>"course-activity-stream", "x-api-path-slug"=>"coursescourse-idactivity-stream-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Activity", "Stream"]}}, "/courses/{course_id}/activity_stream/summary"=>{"get"=>{"summary"=>"Course activity stream summary", "description"=>"Course activity stream summary.", "operationId"=>"course-activity-stream-summary", "x-api-path-slug"=>"coursescourse-idactivity-streamsummary-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Activity", "Stream", "Summary"]}}, "/courses/{course_id}/analytics/activity"=>{"get"=>{"summary"=>"Get course-level participation data", "description"=>"Get course-level participation data.", "operationId"=>"get-courselevel-participation-data", "x-api-path-slug"=>"coursescourse-idanalyticsactivity-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Analytics", "Activity"]}}, "/courses/{course_id}/analytics/assignments"=>{"get"=>{"summary"=>"Get course-level assignment data", "description"=>"Get course-level assignment data.", "operationId"=>"get-courselevel-assignment-data", "x-api-path-slug"=>"coursescourse-idanalyticsassignments-get", "parameters"=>[{"in"=>"query", "name"=>"async", "description"=>"If async is true, then the course_assignments call can happen asynch-nronously and MAY return a response containing a progress_url key instead ofnan assignments array"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Analytics", "Assignments"]}}, "/courses/{course_id}/analytics/student_summaries"=>{"get"=>{"summary"=>"Get course-level student summary data", "description"=>"Get course-level student summary data.", "operationId"=>"get-courselevel-student-summary-data", "x-api-path-slug"=>"coursescourse-idanalyticsstudent-summaries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Analytics", "Student", "Summaries"]}}, "/courses/{course_id}/analytics/users/student_id/activity"=>{"get"=>{"summary"=>"Get user-in-a-course-level participation data", "description"=>"Get user-in-a-course-level participation data.", "operationId"=>"get-userinacourselevel-participation-data", "x-api-path-slug"=>"coursescourse-idanalyticsusersstudent-idactivity-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Analytics", "Users", "Student", "Id", "Activity"]}}, "/courses/{course_id}/analytics/users/student_id/assignments"=>{"get"=>{"summary"=>"Get user-in-a-course-level assignment data", "description"=>"Get user-in-a-course-level assignment data.", "operationId"=>"get-userinacourselevel-assignment-data", "x-api-path-slug"=>"coursescourse-idanalyticsusersstudent-idassignments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Analytics", "Users", "Student", "Id", "Assignments"]}}, "/courses/{course_id}/analytics/users/student_id/communication"=>{"get"=>{"summary"=>"Get user-in-a-course-level messaging data", "description"=>"Get user-in-a-course-level messaging data.", "operationId"=>"get-userinacourselevel-messaging-data", "x-api-path-slug"=>"coursescourse-idanalyticsusersstudent-idcommunication-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Analytics", "Users", "Student", "Id", "Communication"]}}, "/courses/{course_id}/assignments"=>{"get"=>{"summary"=>"List assignments", "description"=>"List assignments.", "operationId"=>"list-assignments", "x-api-path-slug"=>"coursescourse-idassignments-get", "parameters"=>[{"in"=>"query", "name"=>"bucket", "description"=>"If included, only return certain assignments depending on due date andnsubmission status"}, {"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the assignment"}, {"in"=>"query", "name"=>"needs_grading_count_by_section", "description"=>"Split up u201cneeds_grading_countu201d by sections into thenu201cneeds_grading_count_by_sectionu201d key, defaults to false"}, {"in"=>"query", "name"=>"override_assignment_dates", "description"=>"Apply assignment overrides for each assignment, defaults to true"}, {"in"=>"query", "name"=>"search_term", "description"=>"The partial title of the assignments to match and return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments"]}, "post"=>{"summary"=>"Create an assignment", "description"=>"Create an assignment.", "operationId"=>"create-an-assignment", "x-api-path-slug"=>"coursescourse-idassignments-post", "parameters"=>[{"in"=>"query", "name"=>"assignment[allowed_extensions][]", "description"=>"Allowed extensions if submission_types includes u201conline_uploadu201dnnExample:nnallowed_extensions: ["docx","ppt"]"}, {"in"=>"query", "name"=>"assignment[assignment_group_id]", "description"=>"The assignment group id to put the assignment in"}, {"in"=>"query", "name"=>"assignment[assignment_overrides][]", "description"=>"List of overrides for the assignment"}, {"in"=>"query", "name"=>"assignment[automatic_peer_reviews]", "description"=>"Whether peer reviews will be assigned automatically by Canvas or ifnteachers must manually assign peer reviews"}, {"in"=>"query", "name"=>"assignment[description]", "description"=>"The assignment's description, supports HTML"}, {"in"=>"query", "name"=>"assignment[due_at]", "description"=>"The day/time the assignment is due"}, {"in"=>"query", "name"=>"assignment[external_tool_tag_attributes]", "description"=>"Hash of attributes if submission_types is [u201cexternal_toolu201d] Example:nnexternal_tool_tag_attributes: {n %r/ url to the external tooln url: "http://instructure"}, {"in"=>"query", "name"=>"assignment[grade_group_students_individually]", "description"=>"If this is a group assignment, teachers have the options to grade studentsnindividually"}, {"in"=>"query", "name"=>"assignment[grading_standard_id]", "description"=>"The grading standard id to set for the course"}, {"in"=>"query", "name"=>"assignment[grading_type]", "description"=>"The strategy used for grading the assignment"}, {"in"=>"query", "name"=>"assignment[group_category_id]", "description"=>"If present, the assignment will become a group assignment assigned to thengroup"}, {"in"=>"query", "name"=>"assignment[integration_data]", "description"=>"Data related to third party integrations, JSON string required"}, {"in"=>"query", "name"=>"assignment[integration_id]", "description"=>"Unique ID from third party integrations"}, {"in"=>"query", "name"=>"assignment[lock_at]", "description"=>"The day/time the assignment is locked after"}, {"in"=>"query", "name"=>"assignment[muted]", "description"=>"Whether this assignment is muted"}, {"in"=>"query", "name"=>"assignment[name]", "description"=>"The assignment name"}, {"in"=>"query", "name"=>"assignment[notify_of_update]", "description"=>"If true, Canvas will send a notification to students in the class notifyingnthem that the content has changed"}, {"in"=>"query", "name"=>"assignment[only_visible_to_overrides]", "description"=>"Whether this assignment is only visible to overrides (Only useful ifn'differentiated assignments' account setting is on)"}, {"in"=>"query", "name"=>"assignment[peer_reviews]", "description"=>"If submission_types does not include external_tool,discussion_topic,nonline_quiz, or on_paper, determines whether or not peer reviews will benturned on for the assignment"}, {"in"=>"query", "name"=>"assignment[points_possible]", "description"=>"The maximum points possible on the assignment"}, {"in"=>"query", "name"=>"assignment[position]", "description"=>"The position of this assignment in the group when displaying assignmentnlists"}, {"in"=>"query", "name"=>"assignment[published]", "description"=>"Whether this assignment is published"}, {"in"=>"query", "name"=>"assignment[submission_types][]", "description"=>"List of supported submission types for the assignment"}, {"in"=>"query", "name"=>"assignment[turnitin_enabled]", "description"=>"Only applies when the Turnitin plugin is enabled for a course and thensubmission_types array includes u201conline_uploadu201d"}, {"in"=>"query", "name"=>"assignment[turnitin_settings]", "description"=>"Settings to send along to turnitin"}, {"in"=>"query", "name"=>"assignment[unlock_at]", "description"=>"The day/time the assignment is unlocked"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments"]}}, "/courses/{course_id}/assignments/assignment_id/gradeable_students"=>{"get"=>{"summary"=>"List gradeable students", "description"=>"List gradeable students.", "operationId"=>"list-gradeable-students", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idgradeable-students-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Gradeable", "Students"]}}, "/courses/{course_id}/assignments/assignment_id/moderated_students"=>{"get"=>{"summary"=>"List students selected for moderation", "description"=>"List students selected for moderation.", "operationId"=>"list-students-selected-for-moderation", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idmoderated-students-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Moderated", "Students"]}, "post"=>{"summary"=>"Select students for moderation", "description"=>"Select students for moderation.", "operationId"=>"select-students-for-moderation", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idmoderated-students-post", "parameters"=>[{"in"=>"query", "name"=>"student_ids[]", "description"=>"user ids for students to select for moderation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Moderated", "Students"]}}, "/courses/{course_id}/assignments/assignment_id/overrides"=>{"get"=>{"summary"=>"List assignment overrides", "description"=>"List assignment overrides.", "operationId"=>"list-assignment-overrides", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idoverrides-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Overrides"]}, "post"=>{"summary"=>"Create an assignment override", "description"=>"Create an assignment override.", "operationId"=>"create-an-assignment-override", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idoverrides-post", "parameters"=>[{"in"=>"query", "name"=>"assignment_override[course_section_id]", "description"=>"The ID of the override's target section"}, {"in"=>"query", "name"=>"assignment_override[due_at]", "description"=>"The day/time the overridden assignment is due"}, {"in"=>"query", "name"=>"assignment_override[group_id]", "description"=>"The ID of the override's target group"}, {"in"=>"query", "name"=>"assignment_override[lock_at]", "description"=>"The day/time the overridden assignment becomes locked"}, {"in"=>"query", "name"=>"assignment_override[student_ids][]", "description"=>"The IDs of the override's target students"}, {"in"=>"query", "name"=>"assignment_override[title]", "description"=>"The title of the adhoc assignment override"}, {"in"=>"query", "name"=>"assignment_override[unlock_at]", "description"=>"The day/time the overridden assignment becomes unlocked"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Overrides"]}}, "/courses/{course_id}/assignments/assignment_id/overrides/{id}"=>{"delete"=>{"summary"=>"Delete an assignment override", "description"=>"Delete an assignment override.", "operationId"=>"delete-an-assignment-override", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idoverridesid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Overrides", "Id"]}, "get"=>{"summary"=>"Get a single assignment override", "description"=>"Get a single assignment override.", "operationId"=>"get-a-single-assignment-override", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idoverridesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Overrides", "Id"]}, "put"=>{"summary"=>"Update an assignment override", "description"=>"Update an assignment override.", "operationId"=>"update-an-assignment-override", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idoverridesid-put", "parameters"=>[{"in"=>"query", "name"=>"assignment_override[due_at]", "description"=>"The day/time the overridden assignment is due"}, {"in"=>"query", "name"=>"assignment_override[lock_at]", "description"=>"The day/time the overridden assignment becomes locked"}, {"in"=>"query", "name"=>"assignment_override[student_ids][]", "description"=>"The IDs of the override's target students"}, {"in"=>"query", "name"=>"assignment_override[title]", "description"=>"The title of an adhoc assignment override"}, {"in"=>"query", "name"=>"assignment_override[unlock_at]", "description"=>"The day/time the overridden assignment becomes unlocked"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Overrides", "Id"]}}, "/courses/{course_id}/assignments/assignment_id/peer_reviews"=>{"get"=>{"summary"=>"Get all Peer Reviews", "description"=>"Get all peer reviews.", "operationId"=>"get-all-peer-reviews", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idpeer-reviews-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the peer review"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Peer", "Reviews"]}}, "/courses/{course_id}/assignments/assignment_id/provisional_grades/publish"=>{"post"=>{"summary"=>"Publish provisional grades for an assignment", "description"=>"Publish provisional grades for an assignment.", "operationId"=>"publish-provisional-grades-for-an-assignment", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idprovisional-gradespublish-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Provisional", "Grades", "Publish"]}}, "/courses/{course_id}/assignments/assignment_id/provisional_grades/status"=>{"get"=>{"summary"=>"Show provisional grade status for a student", "description"=>"Show provisional grade status for a student.", "operationId"=>"show-provisional-grade-status-for-a-student", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idprovisional-gradesstatus-get", "parameters"=>[{"in"=>"query", "name"=>"student_id", "description"=>"The id of the student to show the status for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Provisional", "Grades", "Status"]}}, "/courses/{course_id}/assignments/assignment_id/provisional_grades/{provisional_grade_id}/copy_to_final_mark"=>{"post"=>{"summary"=>"Copy provisional grade", "description"=>"Copy provisional grade.", "operationId"=>"copy-provisional-grade", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idprovisional-gradesprovisional-grade-idcopy-to-final-mark-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Provisional", "Grades", "Provisional", "Grade", "Id", "Copy", "To", "Final", "Mark"]}}, "/courses/{course_id}/assignments/assignment_id/provisional_grades/{provisional_grade_id}/select"=>{"put"=>{"summary"=>"Select provisional grade", "description"=>"Select provisional grade.", "operationId"=>"select-provisional-grade", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idprovisional-gradesprovisional-grade-idselect-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Provisional", "Grades", "Provisional", "Grade", "Id", "Select"]}}, "/courses/{course_id}/assignments/assignment_id/submissions"=>{"get"=>{"summary"=>"List assignment submissions", "description"=>"List assignment submissions.", "operationId"=>"list-assignment-submissions", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idsubmissions-get", "parameters"=>[{"in"=>"query", "name"=>"grouped", "description"=>"If this argument is true, the response will be grouped by student groups"}, {"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Submissions"]}, "post"=>{"summary"=>"Submit an assignment", "description"=>"Submit an assignment.", "operationId"=>"submit-an-assignment", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idsubmissions-post", "parameters"=>[{"in"=>"query", "name"=>"comment[text_comment]", "description"=>"Include a textual comment with the submission"}, {"in"=>"query", "name"=>"submission[body]", "description"=>"Submit the assignment as an HTML document snippet"}, {"in"=>"query", "name"=>"submission[file_ids][]", "description"=>"Submit the assignment as a set of one or more previously uploaded filesnresiding in the submitting user's files section (or the group'snfiles section, for group assignments)"}, {"in"=>"query", "name"=>"submission[media_comment_id]", "description"=>"The media comment id to submit"}, {"in"=>"query", "name"=>"submission[media_comment_type]", "description"=>"The type of media comment being submitted"}, {"in"=>"query", "name"=>"submission[submission_type]", "description"=>"The type of submission being made"}, {"in"=>"query", "name"=>"submission[url]", "description"=>"Submit the assignment as a URL"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Submissions"]}}, "/courses/{course_id}/assignments/assignment_id/submissions/update_grades"=>{"post"=>{"summary"=>"Grade or comment on multiple submissions", "description"=>"Grade or comment on multiple submissions.", "operationId"=>"grade-or-comment-on-multiple-submissions", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idsubmissionsupdate-grades-post", "parameters"=>[{"in"=>"query", "name"=>"grade_data[student_id][file_ids][]", "description"=>"See documentation for the comment[] arguments in thenSubmissions Update documentation"}, {"in"=>"query", "name"=>"grade_data[student_id][group_comment]", "description"=>"no description"}, {"in"=>"query", "name"=>"grade_data[student_id][media_comment_id]", "description"=>"no description"}, {"in"=>"query", "name"=>"grade_data[student_id][media_comment_type]", "description"=>"no descriptionnn n n Allowed values: audio, video"}, {"in"=>"query", "name"=>"grade_data[student_id][posted_grade]", "description"=>"See documentation for the posted_grade argument in thenSubmissions Update documentation"}, {"in"=>"query", "name"=>"grade_data[student_id][rubric_assessment]", "description"=>"See documentation for the rubric_assessment argument in thenSubmissions Update documentation"}, {"in"=>"query", "name"=>"grade_data[student_id][text_comment]", "description"=>"no description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Submissions", "Update", "Grades"]}}, "/courses/{course_id}/assignments/assignment_id/submissions/{submission_id}/peer_reviews"=>{"delete"=>{"summary"=>"Create Peer Review", "description"=>"Create peer review.", "operationId"=>"create-peer-review", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idsubmissionssubmission-idpeer-reviews-delete", "parameters"=>[{"in"=>"query", "name"=>"user_id", "description"=>"user_id to delete as reviewer on this assignment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Submissions", "Submission", "Id", "Peer", "Reviews"]}, "get"=>{"summary"=>"Get all Peer Reviews", "description"=>"Get all peer reviews.", "operationId"=>"get-all-peer-reviews", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idsubmissionssubmission-idpeer-reviews-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the peer review"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Submissions", "Submission", "Id", "Peer", "Reviews"]}, "post"=>{"summary"=>"Create Peer Review", "description"=>"Create peer review.", "operationId"=>"create-peer-review", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idsubmissionssubmission-idpeer-reviews-post", "parameters"=>[{"in"=>"query", "name"=>"user_id", "description"=>"user_id to assign as reviewer on this assignment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Submissions", "Submission", "Id", "Peer", "Reviews"]}}, "/courses/{course_id}/assignments/assignment_id/submissions/{user_id}"=>{"get"=>{"summary"=>"Get a single submission", "description"=>"Get a single submission.", "operationId"=>"get-a-single-submission", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idsubmissionsuser-id-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Submissions", "User", "Id"]}, "put"=>{"summary"=>"Grade or comment on a submission", "description"=>"Grade or comment on a submission.", "operationId"=>"grade-or-comment-on-a-submission", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idsubmissionsuser-id-put", "parameters"=>[{"in"=>"query", "name"=>"comment[file_ids][]", "description"=>"Attach files to this comment that were previously uploaded using thenSubmission Comment API's files action"}, {"in"=>"query", "name"=>"comment[group_comment]", "description"=>"Whether or not this comment should be sent to the entire group (defaults tonfalse)"}, {"in"=>"query", "name"=>"comment[media_comment_id]", "description"=>"Add an audio/video comment to the submission"}, {"in"=>"query", "name"=>"comment[media_comment_type]", "description"=>"The type of media comment being added"}, {"in"=>"query", "name"=>"comment[text_comment]", "description"=>"Add a textual comment to the submission"}, {"in"=>"query", "name"=>"include[visibility]", "description"=>"Whether this assignment is visible to the owner of the submission"}, {"in"=>"query", "name"=>"rubric_assessment", "description"=>"Assign a rubric assessment to this assignment submission"}, {"in"=>"query", "name"=>"submission[excuse]", "description"=>"Sets the u201cexcusedu201d status of an assignment"}, {"in"=>"query", "name"=>"submission[posted_grade]", "description"=>"Assign a score to the submission, updating both the u201cscoreu201d and u201cgradeu201dnfields on the submission record"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Submissions", "User", "Id"]}}, "/courses/{course_id}/assignments/assignment_id/submissions/{user_id}/comments/files"=>{"post"=>{"summary"=>"Upload a file", "description"=>"Upload a file.", "operationId"=>"upload-a-file", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idsubmissionsuser-idcommentsfiles-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Submissions", "User", "Id", "Comments", "Files"]}}, "/courses/{course_id}/assignments/assignment_id/submissions/{user_id}/files"=>{"post"=>{"summary"=>"Upload a file", "description"=>"Upload a file.", "operationId"=>"upload-a-file", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idsubmissionsuser-idfiles-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Submissions", "User", "Id", "Files"]}}, "/courses/{course_id}/assignments/assignment_id/submissions/{user_id}/read"=>{"delete"=>{"summary"=>"Mark submission as unread", "description"=>"Mark submission as unread.", "operationId"=>"mark-submission-as-unread", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idsubmissionsuser-idread-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Submissions", "User", "Id", "Read"]}, "put"=>{"summary"=>"Mark submission as read", "description"=>"Mark submission as read.", "operationId"=>"mark-submission-as-read", "x-api-path-slug"=>"coursescourse-idassignmentsassignment-idsubmissionsuser-idread-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Assignment", "Id", "Submissions", "User", "Id", "Read"]}}, "/courses/{course_id}/assignments/id"=>{"delete"=>{"summary"=>"Delete an assignment", "description"=>"Delete an assignment.", "operationId"=>"delete-an-assignment", "x-api-path-slug"=>"coursescourse-idassignmentsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Id"]}, "get"=>{"summary"=>"Get a single assignment", "description"=>"Get a single assignment.", "operationId"=>"get-a-single-assignment", "x-api-path-slug"=>"coursescourse-idassignmentsid-get", "parameters"=>[{"in"=>"query", "name"=>"all_dates", "description"=>"All dates associated with the assignment, if applicable"}, {"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the assignment"}, {"in"=>"query", "name"=>"needs_grading_count_by_section", "description"=>"Split up u201cneeds_grading_countu201d by sections into thenu201cneeds_grading_count_by_sectionu201d key, defaults to false"}, {"in"=>"query", "name"=>"override_assignment_dates", "description"=>"Apply assignment overrides to the assignment, defaults to true"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Id"]}, "put"=>{"summary"=>"Edit an assignment", "description"=>"Edit an assignment.", "operationId"=>"edit-an-assignment", "x-api-path-slug"=>"coursescourse-idassignmentsid-put", "parameters"=>[{"in"=>"query", "name"=>"assignment[allowed_extensions][]", "description"=>"Allowed extensions if submission_types includes u201conline_uploadu201dnnExample:nnallowed_extensions: ["docx","ppt"]"}, {"in"=>"query", "name"=>"assignment[assignment_group_id]", "description"=>"The assignment group id to put the assignment in"}, {"in"=>"query", "name"=>"assignment[assignment_overrides][]", "description"=>"List of overrides for the assignment"}, {"in"=>"query", "name"=>"assignment[automatic_peer_reviews]", "description"=>"Whether peer reviews will be assigned automatically by Canvas or ifnteachers must manually assign peer reviews"}, {"in"=>"query", "name"=>"assignment[description]", "description"=>"The assignment's description, supports HTML"}, {"in"=>"query", "name"=>"assignment[due_at]", "description"=>"The day/time the assignment is due"}, {"in"=>"query", "name"=>"assignment[external_tool_tag_attributes]", "description"=>"Hash of attributes if submission_types is [u201cexternal_toolu201d] Example:nnexternal_tool_tag_attributes: {n %r/ url to the external tooln url: "http://instructure"}, {"in"=>"query", "name"=>"assignment[grade_group_students_individually]", "description"=>"If this is a group assignment, teachers have the options to grade studentsnindividually"}, {"in"=>"query", "name"=>"assignment[grading_standard_id]", "description"=>"The grading standard id to set for the course"}, {"in"=>"query", "name"=>"assignment[grading_type]", "description"=>"The strategy used for grading the assignment"}, {"in"=>"query", "name"=>"assignment[group_category_id]", "description"=>"If present, the assignment will become a group assignment assigned to thengroup"}, {"in"=>"query", "name"=>"assignment[integration_data]", "description"=>"Data related to third party integrations, JSON string required"}, {"in"=>"query", "name"=>"assignment[integration_id]", "description"=>"Unique ID from third party integrations"}, {"in"=>"query", "name"=>"assignment[lock_at]", "description"=>"The day/time the assignment is locked after"}, {"in"=>"query", "name"=>"assignment[muted]", "description"=>"Whether this assignment is muted"}, {"in"=>"query", "name"=>"assignment[name]", "description"=>"The assignment name"}, {"in"=>"query", "name"=>"assignment[notify_of_update]", "description"=>"If true, Canvas will send a notification to students in the class notifyingnthem that the content has changed"}, {"in"=>"query", "name"=>"assignment[only_visible_to_overrides]", "description"=>"Whether this assignment is only visible to overrides (Only useful ifn'differentiated assignments' account setting is on)"}, {"in"=>"query", "name"=>"assignment[peer_reviews]", "description"=>"If submission_types does not include external_tool,discussion_topic,nonline_quiz, or on_paper, determines whether or not peer reviews will benturned on for the assignment"}, {"in"=>"query", "name"=>"assignment[points_possible]", "description"=>"The maximum points possible on the assignment"}, {"in"=>"query", "name"=>"assignment[position]", "description"=>"The position of this assignment in the group when displaying assignmentnlists"}, {"in"=>"query", "name"=>"assignment[published]", "description"=>"Whether this assignment is published"}, {"in"=>"query", "name"=>"assignment[submission_types][]", "description"=>"List of supported submission types for the assignment"}, {"in"=>"query", "name"=>"assignment[turnitin_enabled]", "description"=>"Only applies when the Turnitin plugin is enabled for a course and thensubmission_types array includes u201conline_uploadu201d"}, {"in"=>"query", "name"=>"assignment[turnitin_settings]", "description"=>"Settings to send along to turnitin"}, {"in"=>"query", "name"=>"assignment[unlock_at]", "description"=>"The day/time the assignment is unlocked"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignments", "Id"]}}, "/courses/{course_id}/assignment_groups"=>{"get"=>{"summary"=>"List assignment groups", "description"=>"List assignment groups.", "operationId"=>"list-assignment-groups", "x-api-path-slug"=>"coursescourse-idassignment-groups-get", "parameters"=>[{"in"=>"query", "name"=>"grading_period_id", "description"=>"The id of the grading period in which assignment groups are being requestedn(Requires the Multiple Grading Periods feature turned on"}, {"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the group"}, {"in"=>"query", "name"=>"override_assignment_dates", "description"=>"Apply assignment overrides for each assignment, defaults to true"}, {"in"=>"query", "name"=>"scope_assignments_to_student", "description"=>"If true, all assignments returned will apply to the current user in thenspecified grading period"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignment", "Groups"]}, "post"=>{"summary"=>"Create an Assignment Group", "description"=>"Create an assignment group.", "operationId"=>"create-an-assignment-group", "x-api-path-slug"=>"coursescourse-idassignment-groups-post", "parameters"=>[{"in"=>"query", "name"=>"group_weight", "description"=>"The percent of the total grade that this assignment group represents"}, {"in"=>"query", "name"=>"name", "description"=>"The assignment group's name"}, {"in"=>"query", "name"=>"position", "description"=>"The position of this assignment group in relation to the other assignmentngroups"}, {"in"=>"query", "name"=>"rules", "description"=>"The grading rules that are applied within this assignment group See thenAssignment Group object definition for format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignment", "Groups"]}}, "/courses/{course_id}/assignment_groups/assignment_group_id"=>{"delete"=>{"summary"=>"Destroy an Assignment Group", "description"=>"Destroy an assignment group.", "operationId"=>"destroy-an-assignment-group", "x-api-path-slug"=>"coursescourse-idassignment-groupsassignment-group-id-delete", "parameters"=>[{"in"=>"query", "name"=>"move_assignments_to", "description"=>"The ID of an active Assignment Group to which the assignments that arencurrently assigned to the destroyed Assignment Group will be assigned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignment", "Groups", "Assignment", "Group", "Id"]}, "get"=>{"summary"=>"Get an Assignment Group", "description"=>"Get an assignment group.", "operationId"=>"get-an-assignment-group", "x-api-path-slug"=>"coursescourse-idassignment-groupsassignment-group-id-get", "parameters"=>[{"in"=>"query", "name"=>"grading_period_id", "description"=>"The id of the grading period in which assignment groups are being requestedn(Requires the Multiple Grading Periods account feature turned on)"}, {"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the group"}, {"in"=>"query", "name"=>"override_assignment_dates", "description"=>"Apply assignment overrides for each assignment, defaults to true"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignment", "Groups", "Assignment", "Group", "Id"]}, "put"=>{"summary"=>"Edit an Assignment Group", "description"=>"Edit an assignment group.", "operationId"=>"edit-an-assignment-group", "x-api-path-slug"=>"coursescourse-idassignment-groupsassignment-group-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Assignment", "Groups", "Assignment", "Group", "Id"]}}, "/courses/{course_id}/conferences"=>{"get"=>{"summary"=>"List conferences", "description"=>"List conferences.", "operationId"=>"list-conferences", "x-api-path-slug"=>"coursescourse-idconferences-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Conferences"]}}, "/courses/{course_id}/content_exports"=>{"get"=>{"summary"=>"List content exports", "description"=>"List content exports.", "operationId"=>"list-content-exports", "x-api-path-slug"=>"coursescourse-idcontent-exports-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Content", "Exports"]}, "post"=>{"summary"=>"Export content", "description"=>"Export content.", "operationId"=>"export-content", "x-api-path-slug"=>"coursescourse-idcontent-exports-post", "parameters"=>[{"in"=>"query", "name"=>"export_type", "description"=>"u201ccommon_cartridgeu201dnnExport the contents of the course in the Common Cartridge ("}, {"in"=>"query", "name"=>"skip_notifications", "description"=>"Don't send the notifications about the export to the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Content", "Exports"]}}, "/courses/{course_id}/content_exports/id"=>{"get"=>{"summary"=>"Show content export", "description"=>"Show content export.", "operationId"=>"show-content-export", "x-api-path-slug"=>"coursescourse-idcontent-exportsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Content", "Exports", "Id"]}}, "/courses/{course_id}/content_licenses"=>{"get"=>{"summary"=>"List licenses", "description"=>"List licenses.", "operationId"=>"list-licenses", "x-api-path-slug"=>"coursescourse-idcontent-licenses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Content", "Licenses"]}}, "/courses/{course_id}/content_migrations"=>{"get"=>{"summary"=>"List content migrations", "description"=>"List content migrations.", "operationId"=>"list-content-migrations", "x-api-path-slug"=>"coursescourse-idcontent-migrations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Content", "Migrations"]}, "post"=>{"summary"=>"Create a content migration", "description"=>"Create a content migration.", "operationId"=>"create-a-content-migration", "x-api-path-slug"=>"coursescourse-idcontent-migrations-post", "parameters"=>[{"in"=>"query", "name"=>"date_shift_options[day_substitutions][X]", "description"=>"Move anything scheduled for day 'X' to the specified day"}, {"in"=>"query", "name"=>"date_shift_options[new_end_date]", "description"=>"The new end date for the source content/course"}, {"in"=>"query", "name"=>"date_shift_options[new_start_date]", "description"=>"The new start date for the content/course"}, {"in"=>"query", "name"=>"date_shift_options[old_end_date]", "description"=>"The original end date of the source content/course"}, {"in"=>"query", "name"=>"date_shift_options[old_start_date]", "description"=>"The original start date of the source content/course"}, {"in"=>"query", "name"=>"date_shift_options[remove_dates]", "description"=>"Whether to remove dates in the copied course"}, {"in"=>"query", "name"=>"date_shift_options[shift_dates]", "description"=>"Whether to shift dates in the copied course"}, {"in"=>"query", "name"=>"migration_type", "description"=>"The type of the migration"}, {"in"=>"query", "name"=>"pre_attachment[*]", "description"=>"Other file upload properties, See File Upload Documentation"}, {"in"=>"query", "name"=>"pre_attachment[name]", "description"=>"Required if uploading a file"}, {"in"=>"query", "name"=>"settings[file_url]", "description"=>"A URL to download the file from"}, {"in"=>"query", "name"=>"settings[folder_id]", "description"=>"The folder to unzip the "}, {"in"=>"query", "name"=>"settings[overwrite_quizzes]", "description"=>"Whether to overwrite quizzes with the same identifiers between contentnpackages"}, {"in"=>"query", "name"=>"settings[question_bank_id]", "description"=>"The existing question bank ID to import questions into if not specified innthe content package"}, {"in"=>"query", "name"=>"settings[question_bank_name]", "description"=>"The question bank to import questions into if not specified in the contentnpackage, if both bank id and name are set, id will take precedence"}, {"in"=>"query", "name"=>"settings[source_course_id]", "description"=>"The course to copy from for a course copy migration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Content", "Migrations"]}}, "/courses/{course_id}/content_migrations/content_migration_id/migration_issues"=>{"get"=>{"summary"=>"List migration issues", "description"=>"List migration issues.", "operationId"=>"list-migration-issues", "x-api-path-slug"=>"coursescourse-idcontent-migrationscontent-migration-idmigration-issues-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Content", "Migrations", "Content", "Migration", "Id", "Migration", "Issues"]}}, "/courses/{course_id}/content_migrations/content_migration_id/migration_issues/{id}"=>{"get"=>{"summary"=>"Get a migration issue", "description"=>"Get a migration issue.", "operationId"=>"get-a-migration-issue", "x-api-path-slug"=>"coursescourse-idcontent-migrationscontent-migration-idmigration-issuesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Content", "Migrations", "Content", "Migration", "Id", "Migration", "Issues", "Id"]}, "put"=>{"summary"=>"Update a migration issue", "description"=>"Update a migration issue.", "operationId"=>"update-a-migration-issue", "x-api-path-slug"=>"coursescourse-idcontent-migrationscontent-migration-idmigration-issuesid-put", "parameters"=>[{"in"=>"query", "name"=>"workflow_state", "description"=>"Set the workflow_state of the issue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Content", "Migrations", "Content", "Migration", "Id", "Migration", "Issues", "Id"]}}, "/courses/{course_id}/content_migrations/id"=>{"get"=>{"summary"=>"Get a content migration", "description"=>"Get a content migration.", "operationId"=>"get-a-content-migration", "x-api-path-slug"=>"coursescourse-idcontent-migrationsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Content", "Migrations", "Id"]}, "put"=>{"summary"=>"Update a content migration", "description"=>"Update a content migration.", "operationId"=>"update-a-content-migration", "x-api-path-slug"=>"coursescourse-idcontent-migrationsid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Content", "Migrations", "Id"]}}, "/courses/{course_id}/content_migrations/migrators"=>{"get"=>{"summary"=>"List Migration Systems", "description"=>"List migration systems.", "operationId"=>"list-migration-systems", "x-api-path-slug"=>"coursescourse-idcontent-migrationsmigrators-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Content", "Migrations", "Migrators"]}}, "/courses/{course_id}/course_copy"=>{"post"=>{"summary"=>"Copy course content", "description"=>"Copy course content.", "operationId"=>"copy-course-content", "x-api-path-slug"=>"coursescourse-idcourse-copy-post", "parameters"=>[{"in"=>"query", "name"=>"except[]", "description"=>"A list of the course content types to exclude, all areas not listed will bencopied"}, {"in"=>"query", "name"=>"only[]", "description"=>"A list of the course content types to copy, all areas not listed will notnbe copied"}, {"in"=>"query", "name"=>"source_course", "description"=>"ID or SIS-ID of the course to copy the content from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Course", "Copy"]}}, "/courses/{course_id}/course_copy/id"=>{"get"=>{"summary"=>"Get course copy status", "description"=>"Get course copy status.", "operationId"=>"get-course-copy-status", "x-api-path-slug"=>"coursescourse-idcourse-copyid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Course", "Copy", "Id"]}}, "/courses/{course_id}/custom_gradebook_columns"=>{"get"=>{"summary"=>"List custom gradebook columns", "description"=>"List custom gradebook columns.", "operationId"=>"list-custom-gradebook-columns", "x-api-path-slug"=>"coursescourse-idcustom-gradebook-columns-get", "parameters"=>[{"in"=>"query", "name"=>"include_hidden", "description"=>"Include hidden parameters (defaults to false)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Custom", "Gradebook", "Columns"]}, "post"=>{"summary"=>"Create a custom gradebook column", "description"=>"Create a custom gradebook column.", "operationId"=>"create-a-custom-gradebook-column", "x-api-path-slug"=>"coursescourse-idcustom-gradebook-columns-post", "parameters"=>[{"in"=>"query", "name"=>"column[hidden]", "description"=>"Hidden columns are not displayed in the gradebook"}, {"in"=>"query", "name"=>"column[position]", "description"=>"The position of the column relative to other custom columns"}, {"in"=>"query", "name"=>"column[teacher_notes]", "description"=>"Set this if the column is created by a teacher"}, {"in"=>"query", "name"=>"column[title]", "description"=>"no description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Custom", "Gradebook", "Columns"]}}, "/courses/{course_id}/custom_gradebook_columns/id"=>{"delete"=>{"summary"=>"Delete a custom gradebook column", "description"=>"Delete a custom gradebook column.", "operationId"=>"delete-a-custom-gradebook-column", "x-api-path-slug"=>"coursescourse-idcustom-gradebook-columnsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Custom", "Gradebook", "Columns", "Id"]}, "put"=>{"summary"=>"Update a custom gradebook column", "description"=>"Update a custom gradebook column.", "operationId"=>"update-a-custom-gradebook-column", "x-api-path-slug"=>"coursescourse-idcustom-gradebook-columnsid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Custom", "Gradebook", "Columns", "Id"]}}, "/courses/{course_id}/custom_gradebook_columns/id/data"=>{"get"=>{"summary"=>"List entries for a column", "description"=>"List entries for a column.", "operationId"=>"list-entries-for-a-column", "x-api-path-slug"=>"coursescourse-idcustom-gradebook-columnsiddata-get", "parameters"=>[{"in"=>"query", "name"=>"include_hidden", "description"=>"If true, hidden columns will be included in the result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Custom", "Gradebook", "Columns", "Id", "Data"]}}, "/courses/{course_id}/custom_gradebook_columns/id/data/{user_id}"=>{"put"=>{"summary"=>"Update column data", "description"=>"Update column data.", "operationId"=>"update-column-data", "x-api-path-slug"=>"coursescourse-idcustom-gradebook-columnsiddatauser-id-put", "parameters"=>[{"in"=>"query", "name"=>"column_data[content]", "description"=>"Column content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Custom", "Gradebook", "Columns", "Id", "Data", "User", "Id"]}}, "/courses/{course_id}/custom_gradebook_columns/reorder"=>{"post"=>{"summary"=>"Reorder custom columns", "description"=>"Reorder custom columns.", "operationId"=>"reorder-custom-columns", "x-api-path-slug"=>"coursescourse-idcustom-gradebook-columnsreorder-post", "parameters"=>[{"in"=>"query", "name"=>"order[]", "description"=>"no description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Custom", "Gradebook", "Columns", "Reorder"]}}, "/courses/{course_id}/discussion_topics"=>{"get"=>{"summary"=>"List discussion topics", "description"=>"List discussion topics.", "operationId"=>"list-discussion-topics", "x-api-path-slug"=>"coursescourse-iddiscussion-topics-get", "parameters"=>[{"in"=>"query", "name"=>"only_announcements", "description"=>"Return announcements instead of discussion topics"}, {"in"=>"query", "name"=>"order_by", "description"=>"Determines the order of the discussion topic list"}, {"in"=>"query", "name"=>"scope", "description"=>"Only return discussion topics in the given state(s)"}, {"in"=>"query", "name"=>"search_term", "description"=>"The partial title of the discussion topics to match and return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics"]}, "post"=>{"summary"=>"Create a new discussion topic", "description"=>"Create a new discussion topic.", "operationId"=>"create-a-new-discussion-topic", "x-api-path-slug"=>"coursescourse-iddiscussion-topics-post", "parameters"=>[{"in"=>"query", "name"=>"allow_rating", "description"=>"If true, users will be allowed to rate entries"}, {"in"=>"query", "name"=>"assignment", "description"=>"To create an assignment discussion, pass the assignment parameters as ansub-object"}, {"in"=>"query", "name"=>"attachment", "description"=>"A multipart/form-data form-field-style attachment"}, {"in"=>"query", "name"=>"delayed_post_at", "description"=>"If a timestamp is given, the topic will not be published until that time"}, {"in"=>"query", "name"=>"discussion_type", "description"=>"The type of discussion"}, {"in"=>"query", "name"=>"group_category_id", "description"=>"If present, the topic will become a group discussion assigned to the group"}, {"in"=>"query", "name"=>"is_announcement", "description"=>"If true, this topic is an announcement"}, {"in"=>"query", "name"=>"lock_at", "description"=>"If a timestamp is given, the topic will be scheduled to lock at thenprovided timestamp"}, {"in"=>"query", "name"=>"message", "description"=>"no description"}, {"in"=>"query", "name"=>"only_graders_can_rate", "description"=>"If true, only graders will be allowed to rate entries"}, {"in"=>"query", "name"=>"pinned", "description"=>"If true, this topic will be listed in the u201cPinned Discussionu201d section"}, {"in"=>"query", "name"=>"podcast_enabled", "description"=>"If true, the topic will have an associated podcast feed"}, {"in"=>"query", "name"=>"podcast_has_student_posts", "description"=>"If true, the podcast will include posts from students as well"}, {"in"=>"query", "name"=>"position_after", "description"=>"By default, discussions are sorted chronologically by creation date, youncan pass the id of another topic to have this one show up after the othernwhen they are listed"}, {"in"=>"query", "name"=>"published", "description"=>"Whether this topic is published (true) or draft state (false)"}, {"in"=>"query", "name"=>"require_initial_post", "description"=>"If true then a user may not respond to other replies until that user hasnmade an initial reply"}, {"in"=>"query", "name"=>"sort_by_rating", "description"=>"If true, entries will be sorted by rating"}, {"in"=>"query", "name"=>"title", "description"=>"no description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics"]}}, "/courses/{course_id}/discussion_topics/reorder"=>{"post"=>{"summary"=>"Reorder pinned topics", "description"=>"Reorder pinned topics.", "operationId"=>"reorder-pinned-topics", "x-api-path-slug"=>"coursescourse-iddiscussion-topicsreorder-post", "parameters"=>[{"in"=>"query", "name"=>"order[]", "description"=>"The ids of the pinned discussion topics in the desired order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Reorder"]}}, "/courses/{course_id}/discussion_topics/topic_id"=>{"delete"=>{"summary"=>"Delete a topic", "description"=>"Delete a topic.", "operationId"=>"delete-a-topic", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id"]}, "get"=>{"summary"=>"Get a single topic", "description"=>"Get a single topic.", "operationId"=>"get-a-single-topic", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id"]}, "put"=>{"summary"=>"Update a topic", "description"=>"Update a topic.", "operationId"=>"update-a-topic", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-id-put", "parameters"=>[{"in"=>"query", "name"=>"allow_rating", "description"=>"If true, users will be allowed to rate entries"}, {"in"=>"query", "name"=>"assignment", "description"=>"To create an assignment discussion, pass the assignment parameters as ansub-object"}, {"in"=>"query", "name"=>"delayed_post_at", "description"=>"If a timestamp is given, the topic will not be published until that time"}, {"in"=>"query", "name"=>"discussion_type", "description"=>"The type of discussion"}, {"in"=>"query", "name"=>"group_category_id", "description"=>"If present, the topic will become a group discussion assigned to the group"}, {"in"=>"query", "name"=>"is_announcement", "description"=>"If true, this topic is an announcement"}, {"in"=>"query", "name"=>"lock_at", "description"=>"If a timestamp is given, the topic will be scheduled to lock at thenprovided timestamp"}, {"in"=>"query", "name"=>"message", "description"=>"no description"}, {"in"=>"query", "name"=>"only_graders_can_rate", "description"=>"If true, only graders will be allowed to rate entries"}, {"in"=>"query", "name"=>"pinned", "description"=>"If true, this topic will be listed in the u201cPinned Discussionu201d section"}, {"in"=>"query", "name"=>"podcast_enabled", "description"=>"If true, the topic will have an associated podcast feed"}, {"in"=>"query", "name"=>"podcast_has_student_posts", "description"=>"If true, the podcast will include posts from students as well"}, {"in"=>"query", "name"=>"position_after", "description"=>"By default, discussions are sorted chronologically by creation date, youncan pass the id of another topic to have this one show up after the othernwhen they are listed"}, {"in"=>"query", "name"=>"published", "description"=>"Whether this topic is published (true) or draft state (false)"}, {"in"=>"query", "name"=>"require_initial_post", "description"=>"If true then a user may not respond to other replies until that user hasnmade an initial reply"}, {"in"=>"query", "name"=>"sort_by_rating", "description"=>"If true, entries will be sorted by rating"}, {"in"=>"query", "name"=>"title", "description"=>"no description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id"]}}, "/courses/{course_id}/discussion_topics/topic_id/entries"=>{"get"=>{"summary"=>"List topic entries", "description"=>"List topic entries.", "operationId"=>"list-topic-entries", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-identries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "Entries"]}, "post"=>{"summary"=>"Post an entry", "description"=>"Post an entry.", "operationId"=>"post-an-entry", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-identries-post", "parameters"=>[{"in"=>"query", "name"=>"attachment", "description"=>"a multipart/form-data form-field-style attachment"}, {"in"=>"query", "name"=>"message", "description"=>"The body of the entry"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "Entries"]}}, "/courses/{course_id}/discussion_topics/topic_id/entries/{entry_id}/rating"=>{"post"=>{"summary"=>"Rate entry", "description"=>"Rate entry.", "operationId"=>"rate-entry", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-identriesentry-idrating-post", "parameters"=>[{"in"=>"query", "name"=>"rating", "description"=>"A rating to set on this entry"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "Entries", "Entry", "Id", "Rating"]}}, "/courses/{course_id}/discussion_topics/topic_id/entries/{entry_id}/read"=>{"delete"=>{"summary"=>"Mark entry as unread", "description"=>"Mark entry as unread.", "operationId"=>"mark-entry-as-unread", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-identriesentry-idread-delete", "parameters"=>[{"in"=>"query", "name"=>"forced_read_state", "description"=>"A boolean value to set the entry's forced_read_state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "Entries", "Entry", "Id", "Read"]}, "put"=>{"summary"=>"Mark entry as read", "description"=>"Mark entry as read.", "operationId"=>"mark-entry-as-read", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-identriesentry-idread-put", "parameters"=>[{"in"=>"query", "name"=>"forced_read_state", "description"=>"A boolean value to set the entry's forced_read_state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "Entries", "Entry", "Id", "Read"]}}, "/courses/{course_id}/discussion_topics/topic_id/entries/{entry_id}/replies"=>{"get"=>{"summary"=>"List entry replies", "description"=>"List entry replies.", "operationId"=>"list-entry-replies", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-identriesentry-idreplies-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "Entries", "Entry", "Id", "Replies"]}, "post"=>{"summary"=>"Post a reply", "description"=>"Post a reply.", "operationId"=>"post-a-reply", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-identriesentry-idreplies-post", "parameters"=>[{"in"=>"query", "name"=>"attachment", "description"=>"a multipart/form-data form-field-style attachment"}, {"in"=>"query", "name"=>"message", "description"=>"The body of the entry"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "Entries", "Entry", "Id", "Replies"]}}, "/courses/{course_id}/discussion_topics/topic_id/entries/{id}"=>{"delete"=>{"summary"=>"Delete an entry", "description"=>"Delete an entry.", "operationId"=>"delete-an-entry", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-identriesid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "Entries", "Id"]}, "put"=>{"summary"=>"Update an entry", "description"=>"Update an entry.", "operationId"=>"update-an-entry", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-identriesid-put", "parameters"=>[{"in"=>"query", "name"=>"message", "description"=>"The updated body of the entry"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "Entries", "Id"]}}, "/courses/{course_id}/discussion_topics/topic_id/entry_list"=>{"get"=>{"summary"=>"List entries", "description"=>"List entries.", "operationId"=>"list-entries", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-identry-list-get", "parameters"=>[{"in"=>"query", "name"=>"ids[]", "description"=>"A list of entry ids to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "Entry", "List"]}}, "/courses/{course_id}/discussion_topics/topic_id/read"=>{"delete"=>{"summary"=>"Mark topic as unread", "description"=>"Mark topic as unread.", "operationId"=>"mark-topic-as-unread", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-idread-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "Read"]}, "put"=>{"summary"=>"Mark topic as read", "description"=>"Mark topic as read.", "operationId"=>"mark-topic-as-read", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-idread-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "Read"]}}, "/courses/{course_id}/discussion_topics/topic_id/read_all"=>{"delete"=>{"summary"=>"Mark all entries as unread", "description"=>"Mark all entries as unread.", "operationId"=>"mark-all-entries-as-unread", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-idread-all-delete", "parameters"=>[{"in"=>"query", "name"=>"forced_read_state", "description"=>"A boolean value to set all of the entries' forced_read_state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "Read"]}, "put"=>{"summary"=>"Mark all entries as read", "description"=>"Mark all entries as read.", "operationId"=>"mark-all-entries-as-read", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-idread-all-put", "parameters"=>[{"in"=>"query", "name"=>"forced_read_state", "description"=>"A boolean value to set all of the entries' forced_read_state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "Read"]}}, "/courses/{course_id}/discussion_topics/topic_id/subscribed"=>{"delete"=>{"summary"=>"Unsubscribe from a topic", "description"=>"Unsubscribe from a topic.", "operationId"=>"unsubscribe-from-a-topic", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-idsubscribed-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "Subscribed"]}, "put"=>{"summary"=>"Subscribe to a topic", "description"=>"Subscribe to a topic.", "operationId"=>"subscribe-to-a-topic", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-idsubscribed-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "Subscribed"]}}, "/courses/{course_id}/discussion_topics/topic_id/view"=>{"get"=>{"summary"=>"Get the full topic", "description"=>"Get the full topic.", "operationId"=>"get-the-full-topic", "x-api-path-slug"=>"coursescourse-iddiscussion-topicstopic-idview-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Discussion", "Topics", "Topic", "Id", "View"]}}, "/courses/{course_id}/enrollments"=>{"get"=>{"summary"=>"List enrollments", "description"=>"List enrollments.", "operationId"=>"list-enrollments", "x-api-path-slug"=>"coursescourse-idenrollments-get", "parameters"=>[{"in"=>"query", "name"=>"grading_period_id", "description"=>"Return grades for the given grading_period"}, {"in"=>"query", "name"=>"role[]", "description"=>"A list of enrollment roles to return"}, {"in"=>"query", "name"=>"state[]", "description"=>"Filter by enrollment state"}, {"in"=>"query", "name"=>"type[]", "description"=>"A list of enrollment types to return"}, {"in"=>"query", "name"=>"user_id", "description"=>"Filter by user_id (only valid for course or section enrollment queries)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Enrollments"]}, "post"=>{"summary"=>"Enroll a user", "description"=>"Enroll a user.", "operationId"=>"enroll-a-user", "x-api-path-slug"=>"coursescourse-idenrollments-post", "parameters"=>[{"in"=>"query", "name"=>"enrollment[course_section_id]", "description"=>"The ID of the course section to enroll the student in"}, {"in"=>"query", "name"=>"enrollment[enrollment_state]", "description"=>"If set to 'active,' student will be immediately enrolled in thencourse"}, {"in"=>"query", "name"=>"enrollment[limit_privileges_to_course_section]", "description"=>"If set, the enrollment will only allow the user to see and interact withnusers enrolled in the section given by course_section_id"}, {"in"=>"query", "name"=>"enrollment[notify]", "description"=>"If true, a notification will be sent to the enrolled user"}, {"in"=>"query", "name"=>"enrollment[role]", "description"=>"Assigns a custom course-level role to the user"}, {"in"=>"query", "name"=>"enrollment[role_id]", "description"=>"Assigns a custom course-level role to the user"}, {"in"=>"query", "name"=>"enrollment[self_enrolled]", "description"=>"If true, marks the enrollment as a self-enrollment, which gives studentsnthe ability to drop the course if desired"}, {"in"=>"query", "name"=>"enrollment[self_enrollment_code]", "description"=>"If the current user is not allowed to manage enrollments in this course,nbut the course allows self-enrollment, the user can self- enroll as anstudent in the default section by passing in a valid code"}, {"in"=>"query", "name"=>"enrollment[type]", "description"=>"Enroll the user as a student, teacher, TA, observer, or designer"}, {"in"=>"query", "name"=>"enrollment[user_id]", "description"=>"The ID of the user to be enrolled in the course"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Enrollments"]}}, "/courses/{course_id}/enrollments/id"=>{"delete"=>{"summary"=>"Conclude or inactivate an enrollment", "description"=>"Conclude or inactivate an enrollment.", "operationId"=>"conclude-or-inactivate-an-enrollment", "x-api-path-slug"=>"coursescourse-idenrollmentsid-delete", "parameters"=>[{"in"=>"query", "name"=>"task", "description"=>"The action to take on the enrollment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Enrollments", "Id"]}}, "/courses/{course_id}/enrollments/id/reactivate"=>{"put"=>{"summary"=>"Re-activate an enrollment", "description"=>"Re-activate an enrollment.", "operationId"=>"reactivate-an-enrollment", "x-api-path-slug"=>"coursescourse-idenrollmentsidreactivate-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Enrollments", "Id", "Reactivate"]}}, "/courses/{course_id}/epub_exports/id"=>{"get"=>{"summary"=>"Show ePub export", "description"=>"Show epub export.", "operationId"=>"show-epub-export", "x-api-path-slug"=>"coursescourse-idepub-exportsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Epub", "Exports", "Id"]}}, "/courses/{course_id}/external_feeds"=>{"get"=>{"summary"=>"List external feeds", "description"=>"List external feeds.", "operationId"=>"list-external-feeds", "x-api-path-slug"=>"coursescourse-idexternal-feeds-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "External", "Feeds"]}, "post"=>{"summary"=>"Create an external feed", "description"=>"Create an external feed.", "operationId"=>"create-an-external-feed", "x-api-path-slug"=>"coursescourse-idexternal-feeds-post", "parameters"=>[{"in"=>"query", "name"=>"header_match", "description"=>"If given, only feed entries that contain this string in their title will benimported"}, {"in"=>"query", "name"=>"url", "description"=>"The url to the external rss or atom feed"}, {"in"=>"query", "name"=>"verbosity", "description"=>"Defaults to u201cfullu201dnn n n Allowed values: full, truncate, link_only"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "External", "Feeds"]}}, "/courses/{course_id}/external_feeds/external_feed_id"=>{"delete"=>{"summary"=>"Delete an external feed", "description"=>"Delete an external feed.", "operationId"=>"delete-an-external-feed", "x-api-path-slug"=>"coursescourse-idexternal-feedsexternal-feed-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "External", "Feeds", "External", "Feed", "Id"]}}, "/courses/{course_id}/external_tools"=>{"get"=>{"summary"=>"List external tools", "description"=>"List external tools.", "operationId"=>"list-external-tools", "x-api-path-slug"=>"coursescourse-idexternal-tools-get", "parameters"=>[{"in"=>"query", "name"=>"search_term", "description"=>"The partial name of the tools to match and return"}, {"in"=>"query", "name"=>"selectable", "description"=>"If true, then only tools that are meant to be selectable are returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "External", "Tools"]}, "post"=>{"summary"=>"Create an external tool", "description"=>"Create an external tool.", "operationId"=>"create-an-external-tool", "x-api-path-slug"=>"coursescourse-idexternal-tools-post", "parameters"=>[{"in"=>"query", "name"=>"account_navigation[enabled]", "description"=>"Set this to enable this feature"}, {"in"=>"query", "name"=>"account_navigation[text]", "description"=>"The text that will show on the left-tab in the account navigation"}, {"in"=>"query", "name"=>"account_navigation[url]", "description"=>"The url of the external tool for account navigation"}, {"in"=>"query", "name"=>"config_type", "description"=>"Configuration can be passed in as CC xml instead of using query parameters"}, {"in"=>"query", "name"=>"config_url", "description"=>"URL where the server can retrieve an XML tool configuration, as specifiednin the CC xml specification"}, {"in"=>"query", "name"=>"config_xml", "description"=>"XML tool configuration, as specified in the CC xml specification"}, {"in"=>"query", "name"=>"consumer_key", "description"=>"The consumer key for the external tool"}, {"in"=>"query", "name"=>"course_navigation[default]", "description"=>"Whether the navigation option will show in the course by default or whethernthe teacher will have to explicitly enable it"}, {"in"=>"query", "name"=>"course_navigation[enabled]", "description"=>"Set this to enable this feature"}, {"in"=>"query", "name"=>"course_navigation[text]", "description"=>"The text that will show on the left-tab in the course navigation"}, {"in"=>"query", "name"=>"course_navigation[url]", "description"=>"The url of the external tool for course navigation"}, {"in"=>"query", "name"=>"course_navigation[visibility]", "description"=>"Who will see the navigation tab"}, {"in"=>"query", "name"=>"custom_fields", "description"=>"Custom fields that will be sent to the tool consumer, specified as custom_fields"}, {"in"=>"query", "name"=>"description", "description"=>"A description of the tool"}, {"in"=>"query", "name"=>"domain", "description"=>"The domain to match links against"}, {"in"=>"query", "name"=>"editor_button[enabled]", "description"=>"Set this to enable this feature"}, {"in"=>"query", "name"=>"editor_button[icon_url]", "description"=>"The url of the icon to show in the WYSIWYG editor"}, {"in"=>"query", "name"=>"editor_button[selection_height]", "description"=>"The height of the dialog the tool is launched in"}, {"in"=>"query", "name"=>"editor_button[selection_width]", "description"=>"The width of the dialog the tool is launched in"}, {"in"=>"query", "name"=>"editor_button[url]", "description"=>"The url of the external tool"}, {"in"=>"query", "name"=>"icon_url", "description"=>"The url of the icon to show for this tool"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the tool"}, {"in"=>"query", "name"=>"not_selectable", "description"=>"Default: false, if set to true the tool won't show up in the externalntool selection UI in modules and assignments"}, {"in"=>"query", "name"=>"privacy_level", "description"=>"What information to send to the external tool"}, {"in"=>"query", "name"=>"resource_selection[enabled]", "description"=>"Set this to enable this feature"}, {"in"=>"query", "name"=>"resource_selection[icon_url]", "description"=>"The url of the icon to show in the module external tool list"}, {"in"=>"query", "name"=>"resource_selection[selection_height]", "description"=>"The height of the dialog the tool is launched in"}, {"in"=>"query", "name"=>"resource_selection[selection_width]", "description"=>"The width of the dialog the tool is launched in"}, {"in"=>"query", "name"=>"resource_selection[url]", "description"=>"The url of the external tool"}, {"in"=>"query", "name"=>"shared_secret", "description"=>"The shared secret with the external tool"}, {"in"=>"query", "name"=>"text", "description"=>"The default text to show for this tool"}, {"in"=>"query", "name"=>"url", "description"=>"The url to match links against"}, {"in"=>"query", "name"=>"user_navigation[enabled]", "description"=>"Set this to enable this feature"}, {"in"=>"query", "name"=>"user_navigation[text]", "description"=>"The text that will show on the left-tab in the user navigation"}, {"in"=>"query", "name"=>"user_navigation[url]", "description"=>"The url of the external tool for user navigation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "External", "Tools"]}}, "/courses/{course_id}/external_tools/external_tool_id"=>{"delete"=>{"summary"=>"Delete an external tool", "description"=>"Delete an external tool.", "operationId"=>"delete-an-external-tool", "x-api-path-slug"=>"coursescourse-idexternal-toolsexternal-tool-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "External", "Tools", "External", "Tool", "Id"]}, "get"=>{"summary"=>"Get a single external tool", "description"=>"Get a single external tool.", "operationId"=>"get-a-single-external-tool", "x-api-path-slug"=>"coursescourse-idexternal-toolsexternal-tool-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "External", "Tools", "External", "Tool", "Id"]}, "put"=>{"summary"=>"Edit an external tool", "description"=>"Edit an external tool.", "operationId"=>"edit-an-external-tool", "x-api-path-slug"=>"coursescourse-idexternal-toolsexternal-tool-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "External", "Tools", "External", "Tool", "Id"]}}, "/courses/{course_id}/external_tools/sessionless_launch"=>{"get"=>{"summary"=>"Get a sessionless launch url for an external tool.", "description"=>"Get a sessionless launch url for an external tool..", "operationId"=>"get-a-sessionless-launch-url-for-an-external-tool", "x-api-path-slug"=>"coursescourse-idexternal-toolssessionless-launch-get", "parameters"=>[{"in"=>"query", "name"=>"assignment_id", "description"=>"The assignment id for an assignment launch"}, {"in"=>"query", "name"=>"id", "description"=>"The external id of the tool to launch"}, {"in"=>"query", "name"=>"launch_type", "description"=>"The type of launch to perform on the external tool"}, {"in"=>"query", "name"=>"url", "description"=>"The LTI launch url for the external tool"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "External", "Tools", "Sessionless", "Launch"]}}, "/courses/{course_id}/features"=>{"get"=>{"summary"=>"List features", "description"=>"List features.", "operationId"=>"list-features", "x-api-path-slug"=>"coursescourse-idfeatures-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Features"]}}, "/courses/{course_id}/features/enabled"=>{"get"=>{"summary"=>"List enabled features", "description"=>"List enabled features.", "operationId"=>"list-enabled-features", "x-api-path-slug"=>"coursescourse-idfeaturesenabled-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Features", "Enabled"]}}, "/courses/{course_id}/features/flags/feature"=>{"delete"=>{"summary"=>"Remove feature flag", "description"=>"Remove feature flag.", "operationId"=>"remove-feature-flag", "x-api-path-slug"=>"coursescourse-idfeaturesflagsfeature-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Features", "Flags", "Feature"]}, "get"=>{"summary"=>"Get feature flag", "description"=>"Get feature flag.", "operationId"=>"get-feature-flag", "x-api-path-slug"=>"coursescourse-idfeaturesflagsfeature-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Features", "Flags", "Feature"]}, "put"=>{"summary"=>"Set feature flag", "description"=>"Set feature flag.", "operationId"=>"set-feature-flag", "x-api-path-slug"=>"coursescourse-idfeaturesflagsfeature-put", "parameters"=>[{"in"=>"query", "name"=>"locking_account_id", "description"=>"If set, this FeatureFlag may only be modified by someone withnadministrative rights in the specified account"}, {"in"=>"query", "name"=>"state", "description"=>"u201coffu201dnnThe feature is not available for the course, user, or account andnsub-accounts"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Features", "Flags", "Feature"]}}, "/courses/{course_id}/files"=>{"get"=>{"summary"=>"List files", "description"=>"List files.", "operationId"=>"list-files", "x-api-path-slug"=>"coursescourse-idfiles-get", "parameters"=>[{"in"=>"query", "name"=>"content_types[]", "description"=>"Filter results by content-type"}, {"in"=>"query", "name"=>"include[]", "description"=>"Array of additional information to include"}, {"in"=>"query", "name"=>"only[]", "description"=>"Array of information to restrict to"}, {"in"=>"query", "name"=>"order", "description"=>"The sorting order"}, {"in"=>"query", "name"=>"search_term", "description"=>"The partial name of the files to match and return"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort results by this field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Files"]}, "post"=>{"summary"=>"Upload a file", "description"=>"Upload a file.", "operationId"=>"upload-a-file", "x-api-path-slug"=>"coursescourse-idfiles-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Files"]}}, "/courses/{course_id}/files/id"=>{"get"=>{"summary"=>"Get file", "description"=>"Get file.", "operationId"=>"get-file", "x-api-path-slug"=>"coursescourse-idfilesid-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Array of additional information to include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Files", "Id"]}}, "/courses/{course_id}/files/quota"=>{"get"=>{"summary"=>"Get quota information", "description"=>"Get quota information.", "operationId"=>"get-quota-information", "x-api-path-slug"=>"coursescourse-idfilesquota-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Files", "Quota"]}}, "/courses/{course_id}/folders"=>{"get"=>{"summary"=>"List all folders", "description"=>"List all folders.", "operationId"=>"list-all-folders", "x-api-path-slug"=>"coursescourse-idfolders-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Folders"]}, "post"=>{"summary"=>"Create folder", "description"=>"Create folder.", "operationId"=>"create-folder", "x-api-path-slug"=>"coursescourse-idfolders-post", "parameters"=>[{"in"=>"query", "name"=>"hidden", "description"=>"Flag the folder as hidden"}, {"in"=>"query", "name"=>"locked", "description"=>"Flag the folder as locked"}, {"in"=>"query", "name"=>"lock_at", "description"=>"The datetime to lock the folder at"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the folder"}, {"in"=>"query", "name"=>"parent_folder_id", "description"=>"The id of the folder to store the file in"}, {"in"=>"query", "name"=>"parent_folder_path", "description"=>"The path of the folder to store the new folder in"}, {"in"=>"query", "name"=>"position", "description"=>"Set an explicit sort position for the folder"}, {"in"=>"query", "name"=>"unlock_at", "description"=>"The datetime to unlock the folder at"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Folders"]}}, "/courses/{course_id}/folders/by_path"=>{"get"=>{"summary"=>"Resolve path", "description"=>"Resolve path.", "operationId"=>"resolve-path", "x-api-path-slug"=>"coursescourse-idfoldersby-path-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Folders", "By", "Path"]}}, "/courses/{course_id}/folders/by_path/*full_path"=>{"get"=>{"summary"=>"Resolve path", "description"=>"Resolve path.", "operationId"=>"resolve-path", "x-api-path-slug"=>"coursescourse-idfoldersby-pathfull-path-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Folders", "By", "Path", "*full", "Path"]}}, "/courses/{course_id}/folders/id"=>{"get"=>{"summary"=>"Get folder", "description"=>"Get folder.", "operationId"=>"get-folder", "x-api-path-slug"=>"coursescourse-idfoldersid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Folders", "Id"]}}, "/courses/{course_id}/front_page"=>{"get"=>{"summary"=>"Show front page", "description"=>"Show front page.", "operationId"=>"show-front-page", "x-api-path-slug"=>"coursescourse-idfront-page-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Front", "Page"]}, "put"=>{"summary"=>"Update/create front page", "description"=>"Update/create front page.", "operationId"=>"updatecreate-front-page", "x-api-path-slug"=>"coursescourse-idfront-page-put", "parameters"=>[{"in"=>"query", "name"=>"wiki_page[body]", "description"=>"The content for the new page"}, {"in"=>"query", "name"=>"wiki_page[editing_roles]", "description"=>"Which user roles are allowed to edit this page"}, {"in"=>"query", "name"=>"wiki_page[notify_of_update]", "description"=>"Whether participants should be notified when this page changes"}, {"in"=>"query", "name"=>"wiki_page[published]", "description"=>"Whether the page is published (true) or draft state (false)"}, {"in"=>"query", "name"=>"wiki_page[title]", "description"=>"The title for the new page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Front", "Page"]}}, "/courses/{course_id}/gradebook_history/date"=>{"get"=>{"summary"=>"Details for a given date in gradebook history for this course", "description"=>"Details for a given date in gradebook history for this course.", "operationId"=>"details-for-a-given-date-in-gradebook-history-for-this-course", "x-api-path-slug"=>"coursescourse-idgradebook-historydate-get", "parameters"=>[{"in"=>"query", "name"=>"course_id", "description"=>"The id of the contextual course for this API call"}, {"in"=>"query", "name"=>"date", "description"=>"The date for which you would like to see detailed information"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Gradebook", "History", "Date"]}}, "/courses/{course_id}/gradebook_history/date/graders/{grader_id}/assignments/assignment_id/submissions"=>{"get"=>{"summary"=>"Lists submissions", "description"=>"Lists submissions.", "operationId"=>"lists-submissions", "x-api-path-slug"=>"coursescourse-idgradebook-historydategradersgrader-idassignmentsassignment-idsubmissions-get", "parameters"=>[{"in"=>"query", "name"=>"assignment_id", "description"=>"The ID of the assignment for which you want to see submissions"}, {"in"=>"query", "name"=>"course_id", "description"=>"The id of the contextual course for this API call"}, {"in"=>"query", "name"=>"date", "description"=>"The date for which you would like to see submissions"}, {"in"=>"query", "name"=>"grader_id", "description"=>"The ID of the grader for which you want to see submissions"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Gradebook", "History", "Date", "Graders", "Grader", "Id", "Assignments", "Assignment", "Id", "Submissions"]}}, "/courses/{course_id}/gradebook_history/days"=>{"get"=>{"summary"=>"Days in gradebook history for this course", "description"=>"Days in gradebook history for this course.", "operationId"=>"days-in-gradebook-history-for-this-course", "x-api-path-slug"=>"coursescourse-idgradebook-historydays-get", "parameters"=>[{"in"=>"query", "name"=>"course_id", "description"=>"The id of the contextual course for this API call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Gradebook", "History", "Days"]}}, "/courses/{course_id}/gradebook_history/feed"=>{"get"=>{"summary"=>"List uncollated submission versions", "description"=>"List uncollated submission versions.", "operationId"=>"list-uncollated-submission-versions", "x-api-path-slug"=>"coursescourse-idgradebook-historyfeed-get", "parameters"=>[{"in"=>"query", "name"=>"ascending", "description"=>"Returns submission versions in ascending date order (oldest first)"}, {"in"=>"query", "name"=>"assignment_id", "description"=>"The ID of the assignment for which you want to see submissions"}, {"in"=>"query", "name"=>"course_id", "description"=>"The id of the contextual course for this API call"}, {"in"=>"query", "name"=>"user_id", "description"=>"The ID of the user for which you want to see submissions"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Gradebook", "History", "Feed"]}}, "/courses/{course_id}/grading_periods"=>{"get"=>{"summary"=>"List grading periods", "description"=>"List grading periods.", "operationId"=>"list-grading-periods", "x-api-path-slug"=>"coursescourse-idgrading-periods-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Grading", "Periods"]}, "post"=>{"summary"=>"Create a single grading period", "description"=>"Create a single grading period.", "operationId"=>"create-a-single-grading-period", "x-api-path-slug"=>"coursescourse-idgrading-periods-post", "parameters"=>[{"in"=>"query", "name"=>"grading_periods[][end_date]", "description"=>"no description"}, {"in"=>"query", "name"=>"grading_periods[][start_date]", "description"=>"The date the grading period starts"}, {"in"=>"query", "name"=>"grading_periods[][weight]", "description"=>"The percentage weight of how much the period should count toward the coursengrade"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Grading", "Periods"]}}, "/courses/{course_id}/grading_periods/id"=>{"delete"=>{"summary"=>"Delete a grading period", "description"=>"Delete a grading period.", "operationId"=>"delete-a-grading-period", "x-api-path-slug"=>"coursescourse-idgrading-periodsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Grading", "Periods", "Id"]}, "get"=>{"summary"=>"Get a single grading period", "description"=>"Get a single grading period.", "operationId"=>"get-a-single-grading-period", "x-api-path-slug"=>"coursescourse-idgrading-periodsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Grading", "Periods", "Id"]}, "put"=>{"summary"=>"Update a single grading period", "description"=>"Update a single grading period.", "operationId"=>"update-a-single-grading-period", "x-api-path-slug"=>"coursescourse-idgrading-periodsid-put", "parameters"=>[{"in"=>"query", "name"=>"grading_periods[][end_date]", "description"=>"no description"}, {"in"=>"query", "name"=>"grading_periods[][start_date]", "description"=>"The date the grading period starts"}, {"in"=>"query", "name"=>"grading_periods[][weight]", "description"=>"The percentage weight of how much the period should count toward the coursengrade"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Grading", "Periods", "Id"]}}, "/courses/{course_id}/grading_standards"=>{"get"=>{"summary"=>"List the grading standards available in a context.", "description"=>"List the grading standards available in a context..", "operationId"=>"list-the-grading-standards-available-in-a-context", "x-api-path-slug"=>"coursescourse-idgrading-standards-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Grading", "Standards"]}, "post"=>{"summary"=>"Create a new grading standard", "description"=>"Create a new grading standard.", "operationId"=>"create-a-new-grading-standard", "x-api-path-slug"=>"coursescourse-idgrading-standards-post", "parameters"=>[{"in"=>"query", "name"=>"grading_scheme_entry[][name]", "description"=>"The name for an entry value within a GradingStandard that describes thenrange of the value e"}, {"in"=>"query", "name"=>"grading_scheme_entry[][value]", "description"=>"The value for the name of the entry within a GradingStandard"}, {"in"=>"query", "name"=>"title", "description"=>"The title for the Grading Standard"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Grading", "Standards"]}}, "/courses/{course_id}/groups"=>{"get"=>{"summary"=>"List the groups available in a context.", "description"=>"List the groups available in a context..", "operationId"=>"list-the-groups-available-in-a-context", "x-api-path-slug"=>"coursescourse-idgroups-get", "parameters"=>[{"in"=>"query", "name"=>"only_own_groups", "description"=>"Will only include groups that the user belongs to if this is set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Groups"]}}, "/courses/{course_id}/group_categories"=>{"get"=>{"summary"=>"List group categories for a context", "description"=>"List group categories for a context.", "operationId"=>"list-group-categories-for-a-context", "x-api-path-slug"=>"coursescourse-idgroup-categories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Group", "Categories"]}, "post"=>{"summary"=>"Create a Group Category", "description"=>"Create a group category.", "operationId"=>"create-a-group-category", "x-api-path-slug"=>"coursescourse-idgroup-categories-post", "parameters"=>[{"in"=>"query", "name"=>"auto_leader", "description"=>"Assigns group leaders automatically when generating and allocating studentsnto groups Valid values are:nu201cfirstu201dnnthe first student to be allocated to a group is the leadernu201crandomu201dnna random student from all members is chosen as the leadernnn n n Allowed values: first, random"}, {"in"=>"query", "name"=>"create_group_count", "description"=>"Create this number of groups (Course Only)"}, {"in"=>"query", "name"=>"group_limit", "description"=>"Limit the maximum number of users in each group (Course Only)"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the group category"}, {"in"=>"query", "name"=>"self_signup", "description"=>"Allow students to sign up for a group themselves (Course Only)"}, {"in"=>"query", "name"=>"split_group_count", "description"=>"(Deprecated) Create this number of groups, and evenly distribute studentsnamong them"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Group", "Categories"]}}, "/courses/{course_id}/live_assessments"=>{"get"=>{"summary"=>"List live assessments", "description"=>"List live assessments.", "operationId"=>"list-live-assessments", "x-api-path-slug"=>"coursescourse-idlive-assessments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Live", "Assessments"]}, "post"=>{"summary"=>"Create or find a live assessment", "description"=>"Create or find a live assessment.", "operationId"=>"create-or-find-a-live-assessment", "x-api-path-slug"=>"coursescourse-idlive-assessments-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Live", "Assessments"]}}, "/courses/{course_id}/live_assessments/assessment_id/results"=>{"get"=>{"summary"=>"List live assessment results", "description"=>"List live assessment results.", "operationId"=>"list-live-assessment-results", "x-api-path-slug"=>"coursescourse-idlive-assessmentsassessment-idresults-get", "parameters"=>[{"in"=>"query", "name"=>"user_id", "description"=>"If set, restrict results to those for this user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Live", "Assessments", "Assessment", "Id", "Results"]}, "post"=>{"summary"=>"Create live assessment results", "description"=>"Create live assessment results.", "operationId"=>"create-live-assessment-results", "x-api-path-slug"=>"coursescourse-idlive-assessmentsassessment-idresults-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Live", "Assessments", "Assessment", "Id", "Results"]}}, "/courses/{course_id}/modules"=>{"get"=>{"summary"=>"List modules", "description"=>"List modules.", "operationId"=>"list-modules", "x-api-path-slug"=>"coursescourse-idmodules-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"u201citemsu201d: Return module items inline if possible"}, {"in"=>"query", "name"=>"search_term", "description"=>"The partial name of the modules (and module items, if include is specified) to match and return"}, {"in"=>"query", "name"=>"student_id", "description"=>"Returns module completion information for the student with this id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Modules"]}, "post"=>{"summary"=>"Create a module", "description"=>"Create a module.", "operationId"=>"create-a-module", "x-api-path-slug"=>"coursescourse-idmodules-post", "parameters"=>[{"in"=>"query", "name"=>"module[name]", "description"=>"The name of the module"}, {"in"=>"query", "name"=>"module[position]", "description"=>"The position of this module in the course (1-based)"}, {"in"=>"query", "name"=>"module[prerequisite_module_ids][]", "description"=>"IDs of Modules that must be completed before this one is unlocked"}, {"in"=>"query", "name"=>"module[publish_final_grade]", "description"=>"Whether to publish the student's final grade for the course uponncompletion of this module"}, {"in"=>"query", "name"=>"module[require_sequential_progress]", "description"=>"Whether module items must be unlocked in order"}, {"in"=>"query", "name"=>"module[unlock_at]", "description"=>"The date the module will unlock"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Modules"]}}, "/courses/{course_id}/modules/id"=>{"delete"=>{"summary"=>"Delete module", "description"=>"Delete module.", "operationId"=>"delete-module", "x-api-path-slug"=>"coursescourse-idmodulesid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Modules", "Id"]}, "get"=>{"summary"=>"Show module", "description"=>"Show module.", "operationId"=>"show-module", "x-api-path-slug"=>"coursescourse-idmodulesid-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"u201citemsu201d: Return module items inline if possible"}, {"in"=>"query", "name"=>"student_id", "description"=>"Returns module completion information for the student with this id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Modules", "Id"]}, "put"=>{"summary"=>"Update a module", "description"=>"Update a module.", "operationId"=>"update-a-module", "x-api-path-slug"=>"coursescourse-idmodulesid-put", "parameters"=>[{"in"=>"query", "name"=>"module[name]", "description"=>"The name of the module"}, {"in"=>"query", "name"=>"module[position]", "description"=>"The position of the module in the course (1-based)"}, {"in"=>"query", "name"=>"module[prerequisite_module_ids][]", "description"=>"IDs of Modules that must be completed before this one is unlockednPrerequisite modules must precede this module (i"}, {"in"=>"query", "name"=>"module[published]", "description"=>"Whether the module is published and visible to students"}, {"in"=>"query", "name"=>"module[publish_final_grade]", "description"=>"Whether to publish the student's final grade for the course uponncompletion of this module"}, {"in"=>"query", "name"=>"module[require_sequential_progress]", "description"=>"Whether module items must be unlocked in order"}, {"in"=>"query", "name"=>"module[unlock_at]", "description"=>"The date the module will unlock"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Modules", "Id"]}}, "/courses/{course_id}/modules/id/relock"=>{"put"=>{"summary"=>"Re-lock module progressions", "description"=>"Re-lock module progressions.", "operationId"=>"relock-module-progressions", "x-api-path-slug"=>"coursescourse-idmodulesidrelock-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Modules", "Id", "Relock"]}}, "/courses/{course_id}/modules/module_id/items"=>{"get"=>{"summary"=>"List module items", "description"=>"List module items.", "operationId"=>"list-module-items", "x-api-path-slug"=>"coursescourse-idmodulesmodule-iditems-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"If included, will return additional details specific to the contentnassociated with each item"}, {"in"=>"query", "name"=>"search_term", "description"=>"The partial title of the items to match and return"}, {"in"=>"query", "name"=>"student_id", "description"=>"Returns module completion information for the student with this id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Modules", "Module", "Id", "Items"]}, "post"=>{"summary"=>"Create a module item", "description"=>"Create a module item.", "operationId"=>"create-a-module-item", "x-api-path-slug"=>"coursescourse-idmodulesmodule-iditems-post", "parameters"=>[{"in"=>"query", "name"=>"module_item[completion_requirement][min_score]", "description"=>"Minimum score required to complete"}, {"in"=>"query", "name"=>"module_item[completion_requirement][type]", "description"=>"Completion requirement for this module item"}, {"in"=>"query", "name"=>"module_item[content_id]", "description"=>"The id of the content to link to the module item"}, {"in"=>"query", "name"=>"module_item[external_url]", "description"=>"External url that the item points to"}, {"in"=>"query", "name"=>"module_item[indent]", "description"=>"0-based indent level; module items may be indented to show a hierarchy"}, {"in"=>"query", "name"=>"module_item[new_tab]", "description"=>"Whether the external tool opens in a new tab"}, {"in"=>"query", "name"=>"module_item[page_url]", "description"=>"Suffix for the linked wiki page (e"}, {"in"=>"query", "name"=>"module_item[position]", "description"=>"The position of this item in the module (1-based)"}, {"in"=>"query", "name"=>"module_item[title]", "description"=>"The name of the module item and associated content"}, {"in"=>"query", "name"=>"module_item[type]", "description"=>"The type of content linked to the itemnn n n Allowed values: File, Page, Discussion, Assignment, Quiz, SubHeader, ExternalUrl, ExternalTool"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Modules", "Module", "Id", "Items"]}}, "/courses/{course_id}/modules/module_id/items/{id}"=>{"delete"=>{"summary"=>"Delete module item", "description"=>"Delete module item.", "operationId"=>"delete-module-item", "x-api-path-slug"=>"coursescourse-idmodulesmodule-iditemsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Modules", "Module", "Id", "Items", "Id"]}, "get"=>{"summary"=>"Show module item", "description"=>"Show module item.", "operationId"=>"show-module-item", "x-api-path-slug"=>"coursescourse-idmodulesmodule-iditemsid-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"If included, will return additional details specific to the contentnassociated with this item"}, {"in"=>"query", "name"=>"student_id", "description"=>"Returns module completion information for the student with this id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Modules", "Module", "Id", "Items", "Id"]}, "put"=>{"summary"=>"Update a module item", "description"=>"Update a module item.", "operationId"=>"update-a-module-item", "x-api-path-slug"=>"coursescourse-idmodulesmodule-iditemsid-put", "parameters"=>[{"in"=>"query", "name"=>"module_item[completion_requirement][min_score]", "description"=>"Minimum score required to complete, Required for completion_requirementntype 'min_score'"}, {"in"=>"query", "name"=>"module_item[completion_requirement][type]", "description"=>"Completion requirement for this module item"}, {"in"=>"query", "name"=>"module_item[external_url]", "description"=>"External url that the item points to"}, {"in"=>"query", "name"=>"module_item[indent]", "description"=>"0-based indent level; module items may be indented to show a hierarchy"}, {"in"=>"query", "name"=>"module_item[module_id]", "description"=>"Move this item to another module by specifying the target module id here"}, {"in"=>"query", "name"=>"module_item[new_tab]", "description"=>"Whether the external tool opens in a new tab"}, {"in"=>"query", "name"=>"module_item[position]", "description"=>"The position of this item in the module (1-based)"}, {"in"=>"query", "name"=>"module_item[published]", "description"=>"Whether the module item is published and visible to students"}, {"in"=>"query", "name"=>"module_item[title]", "description"=>"The name of the module item"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Modules", "Module", "Id", "Items", "Id"]}}, "/courses/{course_id}/modules/module_id/items/{id}/done"=>{"put"=>{"summary"=>"Mark module item as done/not done", "description"=>"Mark module item as done/not done.", "operationId"=>"mark-module-item-as-donenot-done", "x-api-path-slug"=>"coursescourse-idmodulesmodule-iditemsiddone-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Modules", "Module", "Id", "Items", "Id", "Done"]}}, "/courses/{course_id}/modules/module_id/items/{id}/mark_read"=>{"post"=>{"summary"=>"Mark module item read", "description"=>"Mark module item read.", "operationId"=>"mark-module-item-read", "x-api-path-slug"=>"coursescourse-idmodulesmodule-iditemsidmark-read-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Modules", "Module", "Id", "Items", "Id", "Mark", "Read"]}}, "/courses/{course_id}/module_item_sequence"=>{"get"=>{"summary"=>"Get module item sequence", "description"=>"Get module item sequence.", "operationId"=>"get-module-item-sequence", "x-api-path-slug"=>"coursescourse-idmodule-item-sequence-get", "parameters"=>[{"in"=>"query", "name"=>"asset_id", "description"=>"The id of the asset (or the url in the case of a Page)"}, {"in"=>"query", "name"=>"asset_type", "description"=>"The type of asset to find module sequence information for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Module", "Item", "Sequence"]}}, "/courses/{course_id}/outcome_groups"=>{"get"=>{"summary"=>"Get all outcome groups for context", "description"=>"Get all outcome groups for context.", "operationId"=>"get-all-outcome-groups-for-context", "x-api-path-slug"=>"coursescourse-idoutcome-groups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Outcome", "Groups"]}}, "/courses/{course_id}/outcome_groups/id"=>{"delete"=>{"summary"=>"Delete an outcome group", "description"=>"Delete an outcome group.", "operationId"=>"delete-an-outcome-group", "x-api-path-slug"=>"coursescourse-idoutcome-groupsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Outcome", "Groups", "Id"]}, "get"=>{"summary"=>"Show an outcome group", "description"=>"Show an outcome group.", "operationId"=>"show-an-outcome-group", "x-api-path-slug"=>"coursescourse-idoutcome-groupsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Outcome", "Groups", "Id"]}, "put"=>{"summary"=>"Update an outcome group", "description"=>"Update an outcome group.", "operationId"=>"update-an-outcome-group", "x-api-path-slug"=>"coursescourse-idoutcome-groupsid-put", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"The new outcome group description"}, {"in"=>"query", "name"=>"parent_outcome_group_id", "description"=>"The id of the new parent outcome group"}, {"in"=>"query", "name"=>"title", "description"=>"The new outcome group title"}, {"in"=>"query", "name"=>"vendor_guid", "description"=>"A custom GUID for the learning standard"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Outcome", "Groups", "Id"]}}, "/courses/{course_id}/outcome_groups/id/import"=>{"post"=>{"summary"=>"Import an outcome group", "description"=>"Import an outcome group.", "operationId"=>"import-an-outcome-group", "x-api-path-slug"=>"coursescourse-idoutcome-groupsidimport-post", "parameters"=>[{"in"=>"query", "name"=>"source_outcome_group_id", "description"=>"The ID of the source outcome group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Outcome", "Groups", "Id", "Import"]}}, "/courses/{course_id}/outcome_groups/id/outcomes"=>{"get"=>{"summary"=>"List linked outcomes", "description"=>"List linked outcomes.", "operationId"=>"list-linked-outcomes", "x-api-path-slug"=>"coursescourse-idoutcome-groupsidoutcomes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Outcome", "Groups", "Id", "Outcomes"]}, "post"=>{"summary"=>"Create/link an outcome", "description"=>"Create/link an outcome.", "operationId"=>"createlink-an-outcome", "x-api-path-slug"=>"coursescourse-idoutcome-groupsidoutcomes-post", "parameters"=>[{"in"=>"query", "name"=>"calculation_int", "description"=>"The new calculation int"}, {"in"=>"query", "name"=>"calculation_method", "description"=>"The new calculation method"}, {"in"=>"query", "name"=>"description", "description"=>"The description of the new outcome"}, {"in"=>"query", "name"=>"display_name", "description"=>"A friendly name shown in reports for outcomes with cryptic titles, such asncommon core standards names"}, {"in"=>"query", "name"=>"mastery_points", "description"=>"The mastery threshold for the embedded rubric criterion"}, {"in"=>"query", "name"=>"outcome_id", "description"=>"The ID of the existing outcome to link"}, {"in"=>"query", "name"=>"ratings[][description]", "description"=>"The description of a rating level for the embedded rubric criterion"}, {"in"=>"query", "name"=>"ratings[][points]", "description"=>"The points corresponding to a rating level for the embedded rubricncriterion"}, {"in"=>"query", "name"=>"title", "description"=>"The title of the new outcome"}, {"in"=>"query", "name"=>"vendor_guid", "description"=>"A custom GUID for the learning standard"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Outcome", "Groups", "Id", "Outcomes"]}}, "/courses/{course_id}/outcome_groups/id/outcomes/{outcome_id}"=>{"delete"=>{"summary"=>"Unlink an outcome", "description"=>"Unlink an outcome.", "operationId"=>"unlink-an-outcome", "x-api-path-slug"=>"coursescourse-idoutcome-groupsidoutcomesoutcome-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Outcome", "Groups", "Id", "Outcomes", "Outcome", "Id"]}, "put"=>{"summary"=>"Create/link an outcome", "description"=>"Create/link an outcome.", "operationId"=>"createlink-an-outcome", "x-api-path-slug"=>"coursescourse-idoutcome-groupsidoutcomesoutcome-id-put", "parameters"=>[{"in"=>"query", "name"=>"calculation_int", "description"=>"The new calculation int"}, {"in"=>"query", "name"=>"calculation_method", "description"=>"The new calculation method"}, {"in"=>"query", "name"=>"description", "description"=>"The description of the new outcome"}, {"in"=>"query", "name"=>"display_name", "description"=>"A friendly name shown in reports for outcomes with cryptic titles, such asncommon core standards names"}, {"in"=>"query", "name"=>"mastery_points", "description"=>"The mastery threshold for the embedded rubric criterion"}, {"in"=>"query", "name"=>"outcome_id", "description"=>"The ID of the existing outcome to link"}, {"in"=>"query", "name"=>"ratings[][description]", "description"=>"The description of a rating level for the embedded rubric criterion"}, {"in"=>"query", "name"=>"ratings[][points]", "description"=>"The points corresponding to a rating level for the embedded rubricncriterion"}, {"in"=>"query", "name"=>"title", "description"=>"The title of the new outcome"}, {"in"=>"query", "name"=>"vendor_guid", "description"=>"A custom GUID for the learning standard"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Outcome", "Groups", "Id", "Outcomes", "Outcome", "Id"]}}, "/courses/{course_id}/outcome_groups/id/subgroups"=>{"get"=>{"summary"=>"List subgroups", "description"=>"List subgroups.", "operationId"=>"list-subgroups", "x-api-path-slug"=>"coursescourse-idoutcome-groupsidsubgroups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Outcome", "Groups", "Id", "Subgroups"]}, "post"=>{"summary"=>"Create a subgroup", "description"=>"Create a subgroup.", "operationId"=>"create-a-subgroup", "x-api-path-slug"=>"coursescourse-idoutcome-groupsidsubgroups-post", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"The description of the new outcome group"}, {"in"=>"query", "name"=>"title", "description"=>"The title of the new outcome group"}, {"in"=>"query", "name"=>"vendor_guid", "description"=>"A custom GUID for the learning standard"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Outcome", "Groups", "Id", "Subgroups"]}}, "/courses/{course_id}/outcome_group_links"=>{"get"=>{"summary"=>"Get all outcome links for context", "description"=>"Get all outcome links for context.", "operationId"=>"get-all-outcome-links-for-context", "x-api-path-slug"=>"coursescourse-idoutcome-group-links-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Outcome", "Group", "Links"]}}, "/courses/{course_id}/outcome_results"=>{"get"=>{"summary"=>"Get outcome results", "description"=>"Get outcome results.", "operationId"=>"get-outcome-results", "x-api-path-slug"=>"coursescourse-idoutcome-results-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"String, u201calignmentsu201d|u201coutcomesu201d|u201coutcomes"}, {"in"=>"query", "name"=>"outcome_ids[]", "description"=>"If specified, only the outcomes whose ids are given will be included in thenresults"}, {"in"=>"query", "name"=>"user_ids[]", "description"=>"If specified, only the users whose ids are given will be included in thenresults"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Outcome", "Results"]}}, "/courses/{course_id}/outcome_rollups"=>{"get"=>{"summary"=>"Get outcome result rollups", "description"=>"Get outcome result rollups.", "operationId"=>"get-outcome-result-rollups", "x-api-path-slug"=>"coursescourse-idoutcome-rollups-get", "parameters"=>[{"in"=>"query", "name"=>"aggregate", "description"=>"If specified, instead of returning one rollup for each user, all the usernrollups will be combined into one rollup for the course that will containnthe average rollup score for each outcome"}, {"in"=>"query", "name"=>"include[]", "description"=>"String, u201ccoursesu201d|u201coutcomesu201d|u201coutcomes"}, {"in"=>"query", "name"=>"outcome_ids[]", "description"=>"If specified, only the outcomes whose ids are given will be included in thenresults"}, {"in"=>"query", "name"=>"user_ids[]", "description"=>"If specified, only the users whose ids are given will be included in thenresults or used in an aggregate result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Outcome", "Rollups"]}}, "/courses/{course_id}/pages"=>{"get"=>{"summary"=>"List pages", "description"=>"List pages.", "operationId"=>"list-pages", "x-api-path-slug"=>"coursescourse-idpages-get", "parameters"=>[{"in"=>"query", "name"=>"order", "description"=>"The sorting order"}, {"in"=>"query", "name"=>"published", "description"=>"If true, include only published paqes"}, {"in"=>"query", "name"=>"search_term", "description"=>"The partial title of the pages to match and return"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort results by this field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Pages"]}, "post"=>{"summary"=>"Create page", "description"=>"Create page.", "operationId"=>"create-page", "x-api-path-slug"=>"coursescourse-idpages-post", "parameters"=>[{"in"=>"query", "name"=>"wiki_page[body]", "description"=>"The content for the new page"}, {"in"=>"query", "name"=>"wiki_page[editing_roles]", "description"=>"Which user roles are allowed to edit this page"}, {"in"=>"query", "name"=>"wiki_page[front_page]", "description"=>"Set an unhidden page as the front page (if true)"}, {"in"=>"query", "name"=>"wiki_page[notify_of_update]", "description"=>"Whether participants should be notified when this page changes"}, {"in"=>"query", "name"=>"wiki_page[published]", "description"=>"Whether the page is published (true) or draft state (false)"}, {"in"=>"query", "name"=>"wiki_page[title]", "description"=>"The title for the new page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Pages"]}}, "/courses/{course_id}/pages/url"=>{"delete"=>{"summary"=>"Delete page", "description"=>"Delete page.", "operationId"=>"delete-page", "x-api-path-slug"=>"coursescourse-idpagesurl-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Pages", "Url"]}, "get"=>{"summary"=>"Show page", "description"=>"Show page.", "operationId"=>"show-page", "x-api-path-slug"=>"coursescourse-idpagesurl-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Pages", "Url"]}, "put"=>{"summary"=>"Update/create page", "description"=>"Update/create page.", "operationId"=>"updatecreate-page", "x-api-path-slug"=>"coursescourse-idpagesurl-put", "parameters"=>[{"in"=>"query", "name"=>"wiki_page[body]", "description"=>"The content for the new page"}, {"in"=>"query", "name"=>"wiki_page[editing_roles]", "description"=>"Which user roles are allowed to edit this page"}, {"in"=>"query", "name"=>"wiki_page[front_page]", "description"=>"Set an unhidden page as the front page (if true)"}, {"in"=>"query", "name"=>"wiki_page[notify_of_update]", "description"=>"Whether participants should be notified when this page changes"}, {"in"=>"query", "name"=>"wiki_page[published]", "description"=>"Whether the page is published (true) or draft state (false)"}, {"in"=>"query", "name"=>"wiki_page[title]", "description"=>"The title for the new page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Pages", "Url"]}}, "/courses/{course_id}/pages/url/revisions"=>{"get"=>{"summary"=>"List revisions", "description"=>"List revisions.", "operationId"=>"list-revisions", "x-api-path-slug"=>"coursescourse-idpagesurlrevisions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Pages", "Url", "Revisions"]}}, "/courses/{course_id}/pages/url/revisions/latest"=>{"get"=>{"summary"=>"Show revision", "description"=>"Show revision.", "operationId"=>"show-revision", "x-api-path-slug"=>"coursescourse-idpagesurlrevisionslatest-get", "parameters"=>[{"in"=>"query", "name"=>"summary", "description"=>"If set, exclude page content from results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Pages", "Url", "Revisions", "Latest"]}}, "/courses/{course_id}/pages/url/revisions/{revision_id}"=>{"get"=>{"summary"=>"Show revision", "description"=>"Show revision.", "operationId"=>"show-revision", "x-api-path-slug"=>"coursescourse-idpagesurlrevisionsrevision-id-get", "parameters"=>[{"in"=>"query", "name"=>"summary", "description"=>"If set, exclude page content from results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Pages", "Url", "Revisions", "Revision", "Id"]}, "post"=>{"summary"=>"Revert to revision", "description"=>"Revert to revision.", "operationId"=>"revert-to-revision", "x-api-path-slug"=>"coursescourse-idpagesurlrevisionsrevision-id-post", "parameters"=>[{"in"=>"query", "name"=>"revision_id", "description"=>"The revision to revert to (use the List Revisions API to see available revisions)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Pages", "Url", "Revisions", "Revision", "Id"]}}, "/courses/{course_id}/preview_html"=>{"post"=>{"summary"=>"Preview processed html", "description"=>"Preview processed html.", "operationId"=>"preview-processed-html", "x-api-path-slug"=>"coursescourse-idpreview-html-post", "parameters"=>[{"in"=>"query", "name"=>"html", "description"=>"The html content to process"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Preview", "Html"]}}, "/courses/{course_id}/quizzes"=>{"get"=>{"summary"=>"List quizzes in a course", "description"=>"List quizzes in a course.", "operationId"=>"list-quizzes-in-a-course", "x-api-path-slug"=>"coursescourse-idquizzes-get", "parameters"=>[{"in"=>"query", "name"=>"search_term", "description"=>"The partial title of the quizzes to match and return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes"]}, "post"=>{"summary"=>"Create a quiz", "description"=>"Create a quiz.", "operationId"=>"create-a-quiz", "x-api-path-slug"=>"coursescourse-idquizzes-post", "parameters"=>[{"in"=>"query", "name"=>"quiz[access_code]", "description"=>"Restricts access to the quiz with a password"}, {"in"=>"query", "name"=>"quiz[allowed_attempts]", "description"=>"Number of times a student is allowed to take a quiz"}, {"in"=>"query", "name"=>"quiz[assignment_group_id]", "description"=>"The assignment group id to put the assignment in"}, {"in"=>"query", "name"=>"quiz[cant_go_back]", "description"=>"Only valid if one_question_at_a_time=true If true, questions are lockednafter answering"}, {"in"=>"query", "name"=>"quiz[description]", "description"=>"A description of the quiz"}, {"in"=>"query", "name"=>"quiz[due_at]", "description"=>"The day/time the quiz is due"}, {"in"=>"query", "name"=>"quiz[hide_correct_answers_at]", "description"=>"Only valid if show_correct_answers=true If set, the correct answers willnstop being visible once this date has passed"}, {"in"=>"query", "name"=>"quiz[hide_results]", "description"=>"Dictates whether or not quiz results are hidden from students"}, {"in"=>"query", "name"=>"quiz[ip_filter]", "description"=>"Restricts access to the quiz to computers in a specified IP range"}, {"in"=>"query", "name"=>"quiz[lock_at]", "description"=>"The day/time the quiz is locked for students"}, {"in"=>"query", "name"=>"quiz[one_question_at_a_time]", "description"=>"If true, shows quiz to student one question at a time"}, {"in"=>"query", "name"=>"quiz[one_time_results]", "description"=>"Whether students should be prevented from viewing their quiz results pastnthe first time (right after they turn the quiz in"}, {"in"=>"query", "name"=>"quiz[published]", "description"=>"Whether the quiz should have a draft state of published or unpublished"}, {"in"=>"query", "name"=>"quiz[quiz_type]", "description"=>"The type of quiz"}, {"in"=>"query", "name"=>"quiz[scoring_policy]", "description"=>"Required and only valid if allowed_attempts > 1"}, {"in"=>"query", "name"=>"quiz[show_correct_answers]", "description"=>"Only valid if hide_results=null If false, hides correct answers fromnstudents when quiz results are viewed"}, {"in"=>"query", "name"=>"quiz[show_correct_answers_at]", "description"=>"Only valid if show_correct_answers=true If set, the correct answers will benvisible by students only after this date, otherwise the correct answers arenvisible once the student hands in their quiz submission"}, {"in"=>"query", "name"=>"quiz[show_correct_answers_last_attempt]", "description"=>"Only valid if show_correct_answers=true and allowed_attempts > 1 Ifntrue, hides correct answers from students when quiz results are viewednuntil they submit the last attempt for the quiz"}, {"in"=>"query", "name"=>"quiz[shuffle_answers]", "description"=>"If true, quiz answers for multiple choice questions will be randomized forneach student"}, {"in"=>"query", "name"=>"quiz[time_limit]", "description"=>"Time limit to take this quiz, in minutes"}, {"in"=>"query", "name"=>"quiz[title]", "description"=>"The quiz title"}, {"in"=>"query", "name"=>"quiz[unlock_at]", "description"=>"The day/time the quiz is unlocked for students"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes"]}}, "/courses/{course_id}/quizzes/assignment_overrides"=>{"get"=>{"summary"=>"Retrieve assignment-overridden dates for quizzes", "description"=>"Retrieve assignment-overridden dates for quizzes.", "operationId"=>"retrieve-assignmentoverridden-dates-for-quizzes", "x-api-path-slug"=>"coursescourse-idquizzesassignment-overrides-get", "parameters"=>[{"in"=>"query", "name"=>"quiz_assignment_overrides[0][quiz_ids][]", "description"=>"An array of quiz IDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Assignment", "Overrides"]}}, "/courses/{course_id}/quizzes/id"=>{"delete"=>{"summary"=>"Delete a quiz", "description"=>"Delete a quiz.", "operationId"=>"delete-a-quiz", "x-api-path-slug"=>"coursescourse-idquizzesid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Id"]}, "get"=>{"summary"=>"Get a single quiz", "description"=>"Get a single quiz.", "operationId"=>"get-a-single-quiz", "x-api-path-slug"=>"coursescourse-idquizzesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Id"]}, "put"=>{"summary"=>"Edit a quiz", "description"=>"Edit a quiz.", "operationId"=>"edit-a-quiz", "x-api-path-slug"=>"coursescourse-idquizzesid-put", "parameters"=>[{"in"=>"query", "name"=>"quiz[notify_of_update]", "description"=>"If true, notifies users that the quiz has changed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Id"]}}, "/courses/{course_id}/quizzes/id/reorder"=>{"post"=>{"summary"=>"Reorder quiz items", "description"=>"Reorder quiz items.", "operationId"=>"reorder-quiz-items", "x-api-path-slug"=>"coursescourse-idquizzesidreorder-post", "parameters"=>[{"in"=>"query", "name"=>"order[][id]", "description"=>"The associated item's unique identifier"}, {"in"=>"query", "name"=>"order[][type]", "description"=>"The type of item is either 'question' or 'group'nn n n Allowed values: question, group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Id", "Reorder"]}}, "/courses/{course_id}/quizzes/id/submission_users/message"=>{"post"=>{"summary"=>"Send a message to unsubmitted or submitted users for the quiz", "description"=>"Send a message to unsubmitted or submitted users for the quiz.", "operationId"=>"send-a-message-to-unsubmitted-or-submitted-users-for-the-quiz", "x-api-path-slug"=>"coursescourse-idquizzesidsubmission-usersmessage-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Id", "Submission", "Users", "Message"]}}, "/courses/{course_id}/quizzes/id/validate_access_code"=>{"post"=>{"summary"=>"Validate quiz access code", "description"=>"Validate quiz access code.", "operationId"=>"validate-quiz-access-code", "x-api-path-slug"=>"coursescourse-idquizzesidvalidate-access-code-post", "parameters"=>[{"in"=>"query", "name"=>"access_code", "description"=>"The access code being validated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Id", "Validate", "Access", "Code"]}}, "/courses/{course_id}/quizzes/quiz_id/extensions"=>{"post"=>{"summary"=>"Set extensions for student quiz submissions", "description"=>"Set extensions for student quiz submissions.", "operationId"=>"set-extensions-for-student-quiz-submissions", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idextensions-post", "parameters"=>[{"in"=>"query", "name"=>"extend_from_end_at", "description"=>"The number of minutes to extend the quiz beyond the quiz's currentnending time"}, {"in"=>"query", "name"=>"extend_from_now", "description"=>"The number of minutes to extend the quiz from the current time"}, {"in"=>"query", "name"=>"extra_attempts", "description"=>"Number of times the student is allowed to re-take the quiz over thenmultiple-attempt limit"}, {"in"=>"query", "name"=>"extra_time", "description"=>"The number of extra minutes to allow for all attempts"}, {"in"=>"query", "name"=>"manually_unlocked", "description"=>"Allow the student to take the quiz even if it's locked for everyonenelse"}, {"in"=>"query", "name"=>"user_id", "description"=>"The ID of the user we want to add quiz extensions for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Extensions"]}}, "/courses/{course_id}/quizzes/quiz_id/groups"=>{"post"=>{"summary"=>"Create a question group", "description"=>"Create a question group.", "operationId"=>"create-a-question-group", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idgroups-post", "parameters"=>[{"in"=>"query", "name"=>"quiz_groups[][assessment_question_bank_id]", "description"=>"The id of the assessment question bank to pull questions from"}, {"in"=>"query", "name"=>"quiz_groups[][name]", "description"=>"The name of the question group"}, {"in"=>"query", "name"=>"quiz_groups[][pick_count]", "description"=>"The number of questions to randomly select for this group"}, {"in"=>"query", "name"=>"quiz_groups[][question_points]", "description"=>"The number of points to assign to each question in the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Groups"]}}, "/courses/{course_id}/quizzes/quiz_id/groups/{id}"=>{"delete"=>{"summary"=>"Delete a question group", "description"=>"Delete a question group.", "operationId"=>"delete-a-question-group", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idgroupsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Groups", "Id"]}, "get"=>{"summary"=>"Get a single quiz group", "description"=>"Get a single quiz group.", "operationId"=>"get-a-single-quiz-group", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idgroupsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Groups", "Id"]}, "put"=>{"summary"=>"Update a question group", "description"=>"Update a question group.", "operationId"=>"update-a-question-group", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idgroupsid-put", "parameters"=>[{"in"=>"query", "name"=>"quiz_groups[][name]", "description"=>"The name of the question group"}, {"in"=>"query", "name"=>"quiz_groups[][pick_count]", "description"=>"The number of questions to randomly select for this group"}, {"in"=>"query", "name"=>"quiz_groups[][question_points]", "description"=>"The number of points to assign to each question in the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Groups", "Id"]}}, "/courses/{course_id}/quizzes/quiz_id/groups/{id}/reorder"=>{"post"=>{"summary"=>"Reorder question groups", "description"=>"Reorder question groups.", "operationId"=>"reorder-question-groups", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idgroupsidreorder-post", "parameters"=>[{"in"=>"query", "name"=>"order[][id]", "description"=>"The associated item's unique identifier"}, {"in"=>"query", "name"=>"order[][type]", "description"=>"The type of item is always 'question' for a groupnn n n Allowed values: question"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Groups", "Id", "Reorder"]}}, "/courses/{course_id}/quizzes/quiz_id/ip_filters"=>{"get"=>{"summary"=>"Get available quiz IP filters.", "description"=>"Get available quiz ip filters..", "operationId"=>"get-available-quiz-ip-filters", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idip-filters-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Ip", "Filters"]}}, "/courses/{course_id}/quizzes/quiz_id/questions"=>{"get"=>{"summary"=>"List questions in a quiz or a submission", "description"=>"List questions in a quiz or a submission.", "operationId"=>"list-questions-in-a-quiz-or-a-submission", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idquestions-get", "parameters"=>[{"in"=>"query", "name"=>"quiz_submission_attempt", "description"=>"The attempt of the submission you want the questions for"}, {"in"=>"query", "name"=>"quiz_submission_id", "description"=>"If specified, the endpoint will return the questions that were presentednfor that submission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Questions"]}, "post"=>{"summary"=>"Create a single quiz question", "description"=>"Create a single quiz question.", "operationId"=>"create-a-single-quiz-question", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idquestions-post", "parameters"=>[{"in"=>"query", "name"=>"question[answers]", "description"=>"no description"}, {"in"=>"query", "name"=>"question[correct_comments]", "description"=>"The comment to display if the student answers the question correctly"}, {"in"=>"query", "name"=>"question[incorrect_comments]", "description"=>"The comment to display if the student answers incorrectly"}, {"in"=>"query", "name"=>"question[neutral_comments]", "description"=>"The comment to display regardless of how the student answered"}, {"in"=>"query", "name"=>"question[points_possible]", "description"=>"The maximum amount of points received for answering this questionncorrectly"}, {"in"=>"query", "name"=>"question[position]", "description"=>"The order in which the question will be displayed in the quiz in relationnto other questions"}, {"in"=>"query", "name"=>"question[question_name]", "description"=>"The name of the question"}, {"in"=>"query", "name"=>"question[question_text]", "description"=>"The text of the question"}, {"in"=>"query", "name"=>"question[question_type]", "description"=>"The type of question"}, {"in"=>"query", "name"=>"question[quiz_group_id]", "description"=>"The id of the quiz group to assign the question to"}, {"in"=>"query", "name"=>"question[text_after_answers]", "description"=>"no description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Questions"]}}, "/courses/{course_id}/quizzes/quiz_id/questions/{id}"=>{"delete"=>{"summary"=>"Delete a quiz question", "description"=>"Delete a quiz question.", "operationId"=>"delete-a-quiz-question", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idquestionsid-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The quiz question's unique identifier"}, {"in"=>"query", "name"=>"quiz_id", "description"=>"The associated quiz's unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Questions", "Id"]}, "get"=>{"summary"=>"Get a single quiz question", "description"=>"Get a single quiz question.", "operationId"=>"get-a-single-quiz-question", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idquestionsid-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The quiz question unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Questions", "Id"]}, "put"=>{"summary"=>"Update an existing quiz question", "description"=>"Update an existing quiz question.", "operationId"=>"update-an-existing-quiz-question", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idquestionsid-put", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The quiz question's unique identifier"}, {"in"=>"query", "name"=>"question[answers]", "description"=>"no description"}, {"in"=>"query", "name"=>"question[correct_comments]", "description"=>"The comment to display if the student answers the question correctly"}, {"in"=>"query", "name"=>"question[incorrect_comments]", "description"=>"The comment to display if the student answers incorrectly"}, {"in"=>"query", "name"=>"question[neutral_comments]", "description"=>"The comment to display regardless of how the student answered"}, {"in"=>"query", "name"=>"question[points_possible]", "description"=>"The maximum amount of points received for answering this questionncorrectly"}, {"in"=>"query", "name"=>"question[position]", "description"=>"The order in which the question will be displayed in the quiz in relationnto other questions"}, {"in"=>"query", "name"=>"question[question_name]", "description"=>"The name of the question"}, {"in"=>"query", "name"=>"question[question_text]", "description"=>"The text of the question"}, {"in"=>"query", "name"=>"question[question_type]", "description"=>"The type of question"}, {"in"=>"query", "name"=>"question[quiz_group_id]", "description"=>"The id of the quiz group to assign the question to"}, {"in"=>"query", "name"=>"question[text_after_answers]", "description"=>"no description"}, {"in"=>"query", "name"=>"quiz_id", "description"=>"The associated quiz's unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Questions", "Id"]}}, "/courses/{course_id}/quizzes/quiz_id/reports"=>{"get"=>{"summary"=>"Retrieve all quiz reports", "description"=>"Retrieve all quiz reports.", "operationId"=>"retrieve-all-quiz-reports", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idreports-get", "parameters"=>[{"in"=>"query", "name"=>"includes_all_versions", "description"=>"Whether to retrieve reports that consider all the submissions or only thenmost recent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Reports"]}, "post"=>{"summary"=>"Create a quiz report", "description"=>"Create a quiz report.", "operationId"=>"create-a-quiz-report", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idreports-post", "parameters"=>[{"in"=>"query", "name"=>"include", "description"=>"Whether the output should include documents for the file and/or progressnobjects associated with this report"}, {"in"=>"query", "name"=>"quiz_report[includes_all_versions]", "description"=>"Whether the report should consider all submissions or only the most recent"}, {"in"=>"query", "name"=>"quiz_report[report_type]", "description"=>"The type of report to be generated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Reports"]}}, "/courses/{course_id}/quizzes/quiz_id/reports/{id}"=>{"delete"=>{"summary"=>"Abort the generation of a report, or remove a previously generated one", "description"=>"Abort the generation of a report, or remove a previously generated one.", "operationId"=>"abort-the-generation-of-a-report-or-remove-a-previously-generated-one", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idreportsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Reports", "Id"]}, "get"=>{"summary"=>"Get a quiz report", "description"=>"Get a quiz report.", "operationId"=>"get-a-quiz-report", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idreportsid-get", "parameters"=>[{"in"=>"query", "name"=>"include", "description"=>"Whether the output should include documents for the file and/or progressnobjects associated with this report"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Reports", "Id"]}}, "/courses/{course_id}/quizzes/quiz_id/statistics"=>{"get"=>{"summary"=>"Fetching the latest quiz statistics", "description"=>"Fetching the latest quiz statistics.", "operationId"=>"fetching-the-latest-quiz-statistics", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idstatistics-get", "parameters"=>[{"in"=>"query", "name"=>"all_versions", "description"=>"Whether the statistics report should include all submissions attempts"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Statistics"]}}, "/courses/{course_id}/quizzes/quiz_id/submissions"=>{"get"=>{"summary"=>"Get all quiz submissions.", "description"=>"Get all quiz submissions..", "operationId"=>"get-all-quiz-submissions", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idsubmissions-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the quiz submission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Submissions"]}, "post"=>{"summary"=>"Create the quiz submission (start a quiz-taking session)", "description"=>"Create the quiz submission (start a quiz-taking session).", "operationId"=>"create-the-quiz-submission-start-a-quiztaking-session", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idsubmissions-post", "parameters"=>[{"in"=>"query", "name"=>"access_code", "description"=>"Access code for the Quiz, if any"}, {"in"=>"query", "name"=>"preview", "description"=>"Whether this should be a preview QuizSubmission and not count towards thenuser's course record"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Submissions"]}}, "/courses/{course_id}/quizzes/quiz_id/submissions/self/files"=>{"post"=>{"summary"=>"Upload a file", "description"=>"Upload a file.", "operationId"=>"upload-a-file", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idsubmissionsselffiles-post", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"The name of the quiz submission file"}, {"in"=>"query", "name"=>"on_duplicate", "description"=>"How to handle duplicate names"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Submissions", "Self", "Files"]}}, "/courses/{course_id}/quizzes/quiz_id/submissions/{id}"=>{"get"=>{"summary"=>"Get a single quiz submission.", "description"=>"Get a single quiz submission..", "operationId"=>"get-a-single-quiz-submission", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idsubmissionsid-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the quiz submission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Submissions", "Id"]}, "put"=>{"summary"=>"Update student question scores and comments.", "description"=>"Update student question scores and comments..", "operationId"=>"update-student-question-scores-and-comments", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idsubmissionsid-put", "parameters"=>[{"in"=>"query", "name"=>"attempt", "description"=>"The attempt number of the quiz submission that should be updated"}, {"in"=>"query", "name"=>"fudge_points", "description"=>"Amount of positive or negative points to fudge the total score by"}, {"in"=>"query", "name"=>"questions", "description"=>"A set of scores and comments for each question answered by the student"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Submissions", "Id"]}}, "/courses/{course_id}/quizzes/quiz_id/submissions/{id}/complete"=>{"post"=>{"summary"=>"Complete the quiz submission (turn it in).", "description"=>"Complete the quiz submission (turn it in)..", "operationId"=>"complete-the-quiz-submission-turn-it-in", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idsubmissionsidcomplete-post", "parameters"=>[{"in"=>"query", "name"=>"access_code", "description"=>"Access code for the Quiz, if any"}, {"in"=>"query", "name"=>"attempt", "description"=>"The attempt number of the quiz submission that should be completed"}, {"in"=>"query", "name"=>"validation_token", "description"=>"The unique validation token you received when this Quiz Submission wasncreated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Submissions", "Id", "Complete"]}}, "/courses/{course_id}/quizzes/quiz_id/submissions/{id}/events"=>{"get"=>{"summary"=>"Retrieve captured events", "description"=>"Retrieve captured events.", "operationId"=>"retrieve-captured-events", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idsubmissionsidevents-get", "parameters"=>[{"in"=>"query", "name"=>"attempt", "description"=>"The specific submission attempt to look up the events for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Submissions", "Id", "Events"]}, "post"=>{"summary"=>"Submit captured events", "description"=>"Submit captured events.", "operationId"=>"submit-captured-events", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idsubmissionsidevents-post", "parameters"=>[{"in"=>"query", "name"=>"quiz_submission_events[]", "description"=>"The submission events to be recorded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Submissions", "Id", "Events"]}}, "/courses/{course_id}/quizzes/quiz_id/submissions/{id}/time"=>{"get"=>{"summary"=>"Get current quiz submission times.", "description"=>"Get current quiz submission times..", "operationId"=>"get-current-quiz-submission-times", "x-api-path-slug"=>"coursescourse-idquizzesquiz-idsubmissionsidtime-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quizzes", "Quiz", "Id", "Submissions", "Id", "Time"]}}, "/courses/{course_id}/quiz_extensions"=>{"post"=>{"summary"=>"Set extensions for student quiz submissions", "description"=>"Set extensions for student quiz submissions.", "operationId"=>"set-extensions-for-student-quiz-submissions", "x-api-path-slug"=>"coursescourse-idquiz-extensions-post", "parameters"=>[{"in"=>"query", "name"=>"extend_from_end_at", "description"=>"The number of minutes to extend the quiz beyond the quiz's currentnending time"}, {"in"=>"query", "name"=>"extend_from_now", "description"=>"The number of minutes to extend the quiz from the current time"}, {"in"=>"query", "name"=>"extra_attempts", "description"=>"Number of times the student is allowed to re-take the quiz over thenmultiple-attempt limit"}, {"in"=>"query", "name"=>"extra_time", "description"=>"The number of extra minutes to allow for all attempts"}, {"in"=>"query", "name"=>"manually_unlocked", "description"=>"Allow the student to take the quiz even if it's locked for everyonenelse"}, {"in"=>"query", "name"=>"user_id", "description"=>"The ID of the user we want to add quiz extensions for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Quiz", "Extensions"]}}, "/courses/{course_id}/recent_students"=>{"get"=>{"summary"=>"List recently logged in students", "description"=>"List recently logged in students.", "operationId"=>"list-recently-logged-in-students", "x-api-path-slug"=>"coursescourse-idrecent-students-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Recent", "Students"]}}, "/courses/{course_id}/reset_content"=>{"post"=>{"summary"=>"Reset a course", "description"=>"Reset a course.", "operationId"=>"reset-a-course", "x-api-path-slug"=>"coursescourse-idreset-content-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Reset", "Content"]}}, "/courses/{course_id}/root_outcome_group"=>{"get"=>{"summary"=>"Redirect to root outcome group for context", "description"=>"Redirect to root outcome group for context.", "operationId"=>"redirect-to-root-outcome-group-for-context", "x-api-path-slug"=>"coursescourse-idroot-outcome-group-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Root", "Outcome", "Group"]}}, "/courses/{course_id}/search_users"=>{"get"=>{"summary"=>"List users in course", "description"=>"List users in course.", "operationId"=>"list-users-in-course", "x-api-path-slug"=>"coursescourse-idsearch-users-get", "parameters"=>[{"in"=>"query", "name"=>"enrollment_role", "description"=>"Deprecated When set, only return users enrolled with the specifiedncourse-level role"}, {"in"=>"query", "name"=>"enrollment_role_id", "description"=>"When set, only return courses where the user is enrolled with the specifiedncourse-level role"}, {"in"=>"query", "name"=>"enrollment_state[]", "description"=>"When set, only return users where the enrollment workflow state is of onenof the given types"}, {"in"=>"query", "name"=>"enrollment_type[]", "description"=>"When set, only return users where the user is enrolled as this type"}, {"in"=>"query", "name"=>"include[]", "description"=>"u201cemailu201d: Optional user email"}, {"in"=>"query", "name"=>"search_term", "description"=>"The partial name or full ID of the users to match and return in the resultsnlist"}, {"in"=>"query", "name"=>"user_id", "description"=>"If included, the user will be queried and if the user is part of the usersnset, the page parameter will be modified so that the page containingnuser_id will be returned"}, {"in"=>"query", "name"=>"user_ids[]", "description"=>"If included, the course users set will only include users with IDsnspecified by the param"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Search", "Users"]}}, "/courses/{course_id}/sections"=>{"get"=>{"summary"=>"List course sections", "description"=>"List course sections.", "operationId"=>"list-course-sections", "x-api-path-slug"=>"coursescourse-idsections-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"u201cstudentsu201d: Associations to include with the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Sections"]}, "post"=>{"summary"=>"Create course section", "description"=>"Create course section.", "operationId"=>"create-course-section", "x-api-path-slug"=>"coursescourse-idsections-post", "parameters"=>[{"in"=>"query", "name"=>"course_section[end_at]", "description"=>"Section end date in ISO8601 format"}, {"in"=>"query", "name"=>"course_section[name]", "description"=>"The name of the section"}, {"in"=>"query", "name"=>"course_section[restrict_enrollments_to_section_dates]", "description"=>"Set to true to restrict user enrollments to the start and end dates of thensection"}, {"in"=>"query", "name"=>"course_section[sis_section_id]", "description"=>"The sis ID of the section"}, {"in"=>"query", "name"=>"course_section[start_at]", "description"=>"Section start date in ISO8601 format, e"}, {"in"=>"query", "name"=>"enable_sis_reactivation", "description"=>"When true, will first try to re-activate a deleted section with matchingnsis_section_id if possible"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Sections"]}}, "/courses/{course_id}/sections/id"=>{"get"=>{"summary"=>"Get section information", "description"=>"Get section information.", "operationId"=>"get-section-information", "x-api-path-slug"=>"coursescourse-idsectionsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Sections", "Id"]}}, "/courses/{course_id}/settings"=>{"get"=>{"summary"=>"Get course settings", "description"=>"Get course settings.", "operationId"=>"get-course-settings", "x-api-path-slug"=>"coursescourse-idsettings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Settings"]}, "put"=>{"summary"=>"Update course settings", "description"=>"Update course settings.", "operationId"=>"update-course-settings", "x-api-path-slug"=>"coursescourse-idsettings-put", "parameters"=>[{"in"=>"query", "name"=>"allow_student_discussion_editing", "description"=>"Let students edit or delete their own discussion posts"}, {"in"=>"query", "name"=>"allow_student_discussion_topics", "description"=>"Let students create discussion topics"}, {"in"=>"query", "name"=>"allow_student_forum_attachments", "description"=>"Let students attach files to discussions"}, {"in"=>"query", "name"=>"allow_student_organized_groups", "description"=>"Let students organize their own groups"}, {"in"=>"query", "name"=>"hide_distribution_graphs", "description"=>"Hide grade distribution graphs from students"}, {"in"=>"query", "name"=>"hide_final_grades", "description"=>"Hide totals in student grades summary"}, {"in"=>"query", "name"=>"lock_all_announcements", "description"=>"Disable comments on announcements"}, {"in"=>"query", "name"=>"restrict_student_future_view", "description"=>"Restrict students from viewing courses before start date"}, {"in"=>"query", "name"=>"restrict_student_past_view", "description"=>"Restrict students from viewing courses after end date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Settings"]}}, "/courses/{course_id}/students"=>{"get"=>{"summary"=>"List students", "description"=>"List students.", "operationId"=>"list-students", "x-api-path-slug"=>"coursescourse-idstudents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Students"]}}, "/courses/{course_id}/students/submissions"=>{"get"=>{"summary"=>"List submissions for multiple assignments", "description"=>"List submissions for multiple assignments.", "operationId"=>"list-submissions-for-multiple-assignments", "x-api-path-slug"=>"coursescourse-idstudentssubmissions-get", "parameters"=>[{"in"=>"query", "name"=>"assignment_ids[]", "description"=>"List of assignments to return submissions for"}, {"in"=>"query", "name"=>"grading_period_id", "description"=>"The id of the grading period in which submissions are being requestedn(Requires the Multiple Grading Periods account feature turned on)"}, {"in"=>"query", "name"=>"grouped", "description"=>"If this argument is present, the response will be grouped by student,nrather than a flat array of submissions"}, {"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the group"}, {"in"=>"query", "name"=>"student_ids[]", "description"=>"List of student ids to return submissions for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Students", "Submissions"]}}, "/courses/{course_id}/submissions/update_grades"=>{"post"=>{"summary"=>"Grade or comment on multiple submissions", "description"=>"Grade or comment on multiple submissions.", "operationId"=>"grade-or-comment-on-multiple-submissions", "x-api-path-slug"=>"coursescourse-idsubmissionsupdate-grades-post", "parameters"=>[{"in"=>"query", "name"=>"grade_data[student_id][file_ids][]", "description"=>"See documentation for the comment[] arguments in thenSubmissions Update documentation"}, {"in"=>"query", "name"=>"grade_data[student_id][group_comment]", "description"=>"no description"}, {"in"=>"query", "name"=>"grade_data[student_id][media_comment_id]", "description"=>"no description"}, {"in"=>"query", "name"=>"grade_data[student_id][media_comment_type]", "description"=>"no descriptionnn n n Allowed values: audio, video"}, {"in"=>"query", "name"=>"grade_data[student_id][posted_grade]", "description"=>"See documentation for the posted_grade argument in thenSubmissions Update documentation"}, {"in"=>"query", "name"=>"grade_data[student_id][rubric_assessment]", "description"=>"See documentation for the rubric_assessment argument in thenSubmissions Update documentation"}, {"in"=>"query", "name"=>"grade_data[student_id][text_comment]", "description"=>"no description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Submissions", "Update", "Grades"]}}, "/courses/{course_id}/tabs"=>{"get"=>{"summary"=>"List available tabs for a course or group", "description"=>"List available tabs for a course or group.", "operationId"=>"list-available-tabs-for-a-course-or-group", "x-api-path-slug"=>"coursescourse-idtabs-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Optionally include external tool tabs in the returned list of tabs (Onlynhas effect for courses, not groups)nn n n Allowed values: external"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Tabs"]}}, "/courses/{course_id}/tabs/tab_id"=>{"put"=>{"summary"=>"Update a tab for a course", "description"=>"Update a tab for a course.", "operationId"=>"update-a-tab-for-a-course", "x-api-path-slug"=>"coursescourse-idtabstab-id-put", "parameters"=>[{"in"=>"query", "name"=>"hidden", "description"=>"no description"}, {"in"=>"query", "name"=>"position", "description"=>"The new position of the tab, 1-based"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Tabs", "Tab", "Id"]}}, "/courses/{course_id}/todo"=>{"get"=>{"summary"=>"Course TODO items", "description"=>"Course todo items.", "operationId"=>"course-todo-items", "x-api-path-slug"=>"coursescourse-idtodo-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Todo"]}}, "/courses/{course_id}/usage_rights"=>{"delete"=>{"summary"=>"Remove usage rights", "description"=>"Remove usage rights.", "operationId"=>"remove-usage-rights", "x-api-path-slug"=>"coursescourse-idusage-rights-delete", "parameters"=>[{"in"=>"query", "name"=>"file_ids[]", "description"=>"List of ids of files to remove associated usage rights from"}, {"in"=>"query", "name"=>"folder_ids[]", "description"=>"List of ids of folders"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Usage", "Rights"]}, "put"=>{"summary"=>"Set usage rights", "description"=>"Set usage rights.", "operationId"=>"set-usage-rights", "x-api-path-slug"=>"coursescourse-idusage-rights-put", "parameters"=>[{"in"=>"query", "name"=>"file_ids[]", "description"=>"List of ids of files to set usage rights for"}, {"in"=>"query", "name"=>"folder_ids[]", "description"=>"List of ids of folders to search for files to set usage rights for"}, {"in"=>"query", "name"=>"publish", "description"=>"Whether the file(s) or folder(s) should be published on save, provided thatnusage rights have been specified (set to `true` to publish on save)"}, {"in"=>"query", "name"=>"usage_rights[legal_copyright]", "description"=>"The legal copyright line for the files"}, {"in"=>"query", "name"=>"usage_rights[license]", "description"=>"The license that applies to the files"}, {"in"=>"query", "name"=>"usage_rights[use_justification]", "description"=>"The intellectual property justification for using the files in Canvasnn n n Allowed values: own_copyright, used_by_permission, fair_use, public_domain, creative_commons"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Usage", "Rights"]}}, "/courses/{course_id}/users"=>{"get"=>{"summary"=>"List users in course", "description"=>"List users in course.", "operationId"=>"list-users-in-course", "x-api-path-slug"=>"coursescourse-idusers-get", "parameters"=>[{"in"=>"query", "name"=>"enrollment_role", "description"=>"Deprecated When set, only return users enrolled with the specifiedncourse-level role"}, {"in"=>"query", "name"=>"enrollment_role_id", "description"=>"When set, only return courses where the user is enrolled with the specifiedncourse-level role"}, {"in"=>"query", "name"=>"enrollment_state[]", "description"=>"When set, only return users where the enrollment workflow state is of onenof the given types"}, {"in"=>"query", "name"=>"enrollment_type[]", "description"=>"When set, only return users where the user is enrolled as this type"}, {"in"=>"query", "name"=>"include[]", "description"=>"u201cemailu201d: Optional user email"}, {"in"=>"query", "name"=>"search_term", "description"=>"The partial name or full ID of the users to match and return in the resultsnlist"}, {"in"=>"query", "name"=>"user_id", "description"=>"If included, the user will be queried and if the user is part of the usersnset, the page parameter will be modified so that the page containingnuser_id will be returned"}, {"in"=>"query", "name"=>"user_ids[]", "description"=>"If included, the course users set will only include users with IDsnspecified by the param"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Users"]}}, "/courses/{course_id}/users/id"=>{"get"=>{"summary"=>"Get single user", "description"=>"Get single user.", "operationId"=>"get-single-user", "x-api-path-slug"=>"coursescourse-idusersid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Course", "Id", "Users", "Id"]}}, "/courses/{id}"=>{"delete"=>{"summary"=>"Conclude a course", "description"=>"Conclude a course.", "operationId"=>"conclude-a-course", "x-api-path-slug"=>"coursesid-delete", "parameters"=>[{"in"=>"query", "name"=>"event", "description"=>"The action to take on the course"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Id"]}, "get"=>{"summary"=>"Get a single course", "description"=>"Get a single course.", "operationId"=>"get-a-single-course", "x-api-path-slug"=>"coursesid-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"u201call_coursesu201d: Also search recently deleted courses"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Id"]}, "put"=>{"summary"=>"Update a course", "description"=>"Update a course.", "operationId"=>"update-a-course", "x-api-path-slug"=>"coursesid-put", "parameters"=>[{"in"=>"query", "name"=>"course[account_id]", "description"=>"The unique ID of the account to create to course under"}, {"in"=>"query", "name"=>"course[allow_student_forum_attachments]", "description"=>"If true, students can attach files to forum posts"}, {"in"=>"query", "name"=>"course[allow_student_wiki_edits]", "description"=>"If true, students will be able to modify the course wiki"}, {"in"=>"query", "name"=>"course[allow_wiki_comments]", "description"=>"If true, course members will be able to comment on wiki pages"}, {"in"=>"query", "name"=>"course[apply_assignment_group_weights]", "description"=>"Set to true to weight final grade based on assignment groups percentages"}, {"in"=>"query", "name"=>"course[course_code]", "description"=>"The course code for the course"}, {"in"=>"query", "name"=>"course[course_format]", "description"=>"Optional"}, {"in"=>"query", "name"=>"course[end_at]", "description"=>"Course end date in ISO8601 format"}, {"in"=>"query", "name"=>"course[grading_standard_id]", "description"=>"The grading standard id to set for the course"}, {"in"=>"query", "name"=>"course[hide_final_grades]", "description"=>"If this option is set to true, the totals in student grades summary will benhidden"}, {"in"=>"query", "name"=>"course[integration_id]", "description"=>"The unique Integration identifier"}, {"in"=>"query", "name"=>"course[is_public]", "description"=>"Set to true if course if public"}, {"in"=>"query", "name"=>"course[license]", "description"=>"The name of the licensing"}, {"in"=>"query", "name"=>"course[name]", "description"=>"The name of the course"}, {"in"=>"query", "name"=>"course[open_enrollment]", "description"=>"Set to true if the course is open enrollment"}, {"in"=>"query", "name"=>"course[public_description]", "description"=>"A publicly visible description of the course"}, {"in"=>"query", "name"=>"course[public_syllabus]", "description"=>"Set to true to make the course syllabus public"}, {"in"=>"query", "name"=>"course[restrict_enrollments_to_course_dates]", "description"=>"Set to true to restrict user enrollments to the start and end dates of thencourse"}, {"in"=>"query", "name"=>"course[self_enrollment]", "description"=>"Set to true if the course is self enrollment"}, {"in"=>"query", "name"=>"course[sis_course_id]", "description"=>"The unique SIS identifier"}, {"in"=>"query", "name"=>"course[start_at]", "description"=>"Course start date in ISO8601 format, e"}, {"in"=>"query", "name"=>"course[syllabus_body]", "description"=>"The syllabus body for the course"}, {"in"=>"query", "name"=>"course[term_id]", "description"=>"The unique ID of the term to create to course in"}, {"in"=>"query", "name"=>"offer", "description"=>"If this option is set to true, the course will be available to studentsnimmediately"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Courses", "Id"]}}}}, "instructure-canvas-users-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Instructure", "x-complete"=>1, "info"=>{"title"=>"Instructure Canvas Users API", "description"=>"canvas-lms-includes-a-rest-api-for-accessing-and-modifying-data-externally-from-the-main-application-in-your-own-programs-and-scripts--", "termsOfService"=>"https://www.canvaslms.com/policies/api-policy", "version"=>"v1"}, "host"=>"canvas.instructure.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/users/activity_stream"=>{"get"=>{"summary"=>"List the activity stream", "description"=>"List the activity stream.", "operationId"=>"list-the-activity-stream", "x-api-path-slug"=>"usersactivity-stream-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Activity", "Stream"]}}, "/users/self/activity_stream"=>{"delete"=>{"summary"=>"Hide all stream items", "description"=>"Hide all stream items.", "operationId"=>"hide-all-stream-items", "x-api-path-slug"=>"usersselfactivity-stream-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Activity", "Stream"]}, "get"=>{"summary"=>"List the activity stream", "description"=>"List the activity stream.", "operationId"=>"list-the-activity-stream", "x-api-path-slug"=>"usersselfactivity-stream-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Activity", "Stream"]}}, "/users/self/activity_stream/summary"=>{"get"=>{"summary"=>"Activity stream summary", "description"=>"Activity stream summary.", "operationId"=>"activity-stream-summary", "x-api-path-slug"=>"usersselfactivity-streamsummary-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Activity", "Stream", "Summary"]}}, "/users/self/activity_stream/{id}"=>{"delete"=>{"summary"=>"Hide a stream item", "description"=>"Hide a stream item.", "operationId"=>"hide-a-stream-item", "x-api-path-slug"=>"usersselfactivity-streamid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Activity", "Stream", "Id"]}}, "/users/self/bookmarks"=>{"get"=>{"summary"=>"List bookmarks", "description"=>"List bookmarks.", "operationId"=>"list-bookmarks", "x-api-path-slug"=>"usersselfbookmarks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Bookmarks"]}, "post"=>{"summary"=>"Create bookmark", "description"=>"Create bookmark.", "operationId"=>"create-bookmark", "x-api-path-slug"=>"usersselfbookmarks-post", "parameters"=>[{"in"=>"query", "name"=>"data", "description"=>"The data associated with the bookmark"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the bookmark"}, {"in"=>"query", "name"=>"position", "description"=>"The position of the bookmark"}, {"in"=>"query", "name"=>"url", "description"=>"The url of the bookmark"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Bookmarks"]}}, "/users/self/bookmarks/{id}"=>{"delete"=>{"summary"=>"Delete bookmark", "description"=>"Delete bookmark.", "operationId"=>"delete-bookmark", "x-api-path-slug"=>"usersselfbookmarksid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Bookmarks", "Id"]}, "get"=>{"summary"=>"Get bookmark", "description"=>"Get bookmark.", "operationId"=>"get-bookmark", "x-api-path-slug"=>"usersselfbookmarksid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Bookmarks", "Id"]}, "put"=>{"summary"=>"Update bookmark", "description"=>"Update bookmark.", "operationId"=>"update-bookmark", "x-api-path-slug"=>"usersselfbookmarksid-put", "parameters"=>[{"in"=>"query", "name"=>"data", "description"=>"The data associated with the bookmark"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the bookmark"}, {"in"=>"query", "name"=>"position", "description"=>"The position of the bookmark"}, {"in"=>"query", "name"=>"url", "description"=>"The url of the bookmark"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Bookmarks", "Id"]}}, "/users/self/communication_channels/{communication_channel_id}/notification_preferences"=>{"put"=>{"summary"=>"Update multiple preferences", "description"=>"Update multiple preferences.", "operationId"=>"update-multiple-preferences", "x-api-path-slug"=>"usersselfcommunication-channelscommunication-channel-idnotification-preferences-put", "parameters"=>[{"in"=>"query", "name"=>"notification_preferences[X][frequency]", "description"=>"The desired frequency for <X> notification"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Communication", "Channels", "Communication", "Channel", "Id", "Notification", "Preferences"]}}, "/users/self/communication_channels/{communication_channel_id}/notification_preferences/notification"=>{"put"=>{"summary"=>"Update a preference", "description"=>"Update a preference.", "operationId"=>"update-a-preference", "x-api-path-slug"=>"usersselfcommunication-channelscommunication-channel-idnotification-preferencesnotification-put", "parameters"=>[{"in"=>"query", "name"=>"notification_preferences[frequency]", "description"=>"The desired frequency for this notification"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Communication", "Channels", "Communication", "Channel", "Id", "Notification", "Preferences", "Notification"]}}, "/users/self/communication_channels/{communication_channel_id}/notification_preference_categories/category"=>{"put"=>{"summary"=>"Update preferences by category", "description"=>"Update preferences by category.", "operationId"=>"update-preferences-by-category", "x-api-path-slug"=>"usersselfcommunication-channelscommunication-channel-idnotification-preference-categoriescategory-put", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"The name of the category"}, {"in"=>"query", "name"=>"notification_preferences[frequency]", "description"=>"The desired frequency for each notification in the category"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Communication", "Channels", "Communication", "Channel", "Id", "Notification", "Preference", "Categories", "Category"]}}, "/users/self/communication_channels/{type}/address/notification_preferences"=>{"put"=>{"summary"=>"Update multiple preferences", "description"=>"Update multiple preferences.", "operationId"=>"update-multiple-preferences", "x-api-path-slug"=>"usersselfcommunication-channelstypeaddressnotification-preferences-put", "parameters"=>[{"in"=>"query", "name"=>"notification_preferences[X][frequency]", "description"=>"The desired frequency for <X> notification"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Communication", "Channels", "Type", "Address", "Notification", "Preferences"]}}, "/users/self/communication_channels/{type}/address/notification_preferences/{notification}"=>{"put"=>{"summary"=>"Update a preference", "description"=>"Update a preference.", "operationId"=>"update-a-preference", "x-api-path-slug"=>"usersselfcommunication-channelstypeaddressnotification-preferencesnotification-put", "parameters"=>[{"in"=>"query", "name"=>"notification_preferences[frequency]", "description"=>"The desired frequency for this notification"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Communication", "Channels", "Type", "Address", "Notification", "Preferences", "Notification"]}}, "/users/self/course_nicknames"=>{"delete"=>{"summary"=>"Clear course nicknames", "description"=>"Clear course nicknames.", "operationId"=>"clear-course-nicknames", "x-api-path-slug"=>"usersselfcourse-nicknames-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Course", "Nicknames"]}, "get"=>{"summary"=>"List course nicknames", "description"=>"List course nicknames.", "operationId"=>"list-course-nicknames", "x-api-path-slug"=>"usersselfcourse-nicknames-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Course", "Nicknames"]}}, "/users/self/course_nicknames/{course_id}"=>{"delete"=>{"summary"=>"Remove course nickname", "description"=>"Remove course nickname.", "operationId"=>"remove-course-nickname", "x-api-path-slug"=>"usersselfcourse-nicknamescourse-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Course", "Nicknames", "Course", "Id"]}, "get"=>{"summary"=>"Get course nickname", "description"=>"Get course nickname.", "operationId"=>"get-course-nickname", "x-api-path-slug"=>"usersselfcourse-nicknamescourse-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Course", "Nicknames", "Course", "Id"]}, "put"=>{"summary"=>"Set course nickname", "description"=>"Set course nickname.", "operationId"=>"set-course-nickname", "x-api-path-slug"=>"usersselfcourse-nicknamescourse-id-put", "parameters"=>[{"in"=>"query", "name"=>"nickname", "description"=>"The nickname to set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Course", "Nicknames", "Course", "Id"]}}, "/users/self/favorites/courses"=>{"delete"=>{"summary"=>"Reset course favorites", "description"=>"Reset course favorites.", "operationId"=>"reset-course-favorites", "x-api-path-slug"=>"usersselffavoritescourses-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Favorites", "Courses"]}, "get"=>{"summary"=>"List favorite courses", "description"=>"List favorite courses.", "operationId"=>"list-favorite-courses", "x-api-path-slug"=>"usersselffavoritescourses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Favorites", "Courses"]}}, "/users/self/favorites/courses/{id}"=>{"delete"=>{"summary"=>"Remove course from favorites", "description"=>"Remove course from favorites.", "operationId"=>"remove-course-from-favorites", "x-api-path-slug"=>"usersselffavoritescoursesid-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"the ID or SIS ID of the course to remove"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Favorites", "Courses", "Id"]}, "post"=>{"summary"=>"Add course to favorites", "description"=>"Add course to favorites.", "operationId"=>"add-course-to-favorites", "x-api-path-slug"=>"usersselffavoritescoursesid-post", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The ID or SIS ID of the course to add"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Favorites", "Courses", "Id"]}}, "/users/self/favorites/groups"=>{"delete"=>{"summary"=>"Reset group favorites", "description"=>"Reset group favorites.", "operationId"=>"reset-group-favorites", "x-api-path-slug"=>"usersselffavoritesgroups-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Favorites", "Groups"]}, "get"=>{"summary"=>"List favorite groups", "description"=>"List favorite groups.", "operationId"=>"list-favorite-groups", "x-api-path-slug"=>"usersselffavoritesgroups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Favorites", "Groups"]}}, "/users/self/favorites/groups/{id}"=>{"delete"=>{"summary"=>"Remove group from favorites", "description"=>"Remove group from favorites.", "operationId"=>"remove-group-from-favorites", "x-api-path-slug"=>"usersselffavoritesgroupsid-delete", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"the ID or SIS ID of the group to remove"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Favorites", "Groups", "Id"]}, "post"=>{"summary"=>"Add group to favorites", "description"=>"Add group to favorites.", "operationId"=>"add-group-to-favorites", "x-api-path-slug"=>"usersselffavoritesgroupsid-post", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The ID or SIS ID of the group to add"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Favorites", "Groups", "Id"]}}, "/users/self/groups"=>{"get"=>{"summary"=>"List your groups", "description"=>"List your groups.", "operationId"=>"list-your-groups", "x-api-path-slug"=>"usersselfgroups-get", "parameters"=>[{"in"=>"query", "name"=>"context_type", "description"=>"Only include groups that are in this type of context"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Groups"]}}, "/users/self/todo"=>{"get"=>{"summary"=>"List the TODO items", "description"=>"List the todo items.", "operationId"=>"list-the-todo-items", "x-api-path-slug"=>"usersselftodo-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Todo"]}}, "/users/self/upcoming_events"=>{"get"=>{"summary"=>"List upcoming assignments, calendar events", "description"=>"List upcoming assignments, calendar events.", "operationId"=>"list-upcoming-assignments-calendar-events", "x-api-path-slug"=>"usersselfupcoming-events-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Self", "Upcoming", "Events"]}}, "/users/{id}"=>{"get"=>{"summary"=>"Show user details", "description"=>"Show user details.", "operationId"=>"show-user-details", "x-api-path-slug"=>"usersid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Id"]}, "put"=>{"summary"=>"Edit a user", "description"=>"Edit a user.", "operationId"=>"edit-a-user", "x-api-path-slug"=>"usersid-put", "parameters"=>[{"in"=>"query", "name"=>"user[avatar][token]", "description"=>"A unique representation of the avatar record to assign as the user'sncurrent avatar"}, {"in"=>"query", "name"=>"user[avatar][url]", "description"=>"To set the user's avatar to point to an external url, do not include antoken and instead pass the url here"}, {"in"=>"query", "name"=>"user[email]", "description"=>"The default email address of the user"}, {"in"=>"query", "name"=>"user[locale]", "description"=>"The user's preferred language as a two-letter ISO 639-1 code"}, {"in"=>"query", "name"=>"user[name]", "description"=>"The full name of the user"}, {"in"=>"query", "name"=>"user[short_name]", "description"=>"User's name as it will be displayed in discussions, messages, andncomments"}, {"in"=>"query", "name"=>"user[sortable_name]", "description"=>"User's name as used to sort alphabetically in lists"}, {"in"=>"query", "name"=>"user[time_zone]", "description"=>"The time zone for the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Id"]}}, "/users/{id}/colors"=>{"get"=>{"summary"=>"Get custom colors", "description"=>"Get custom colors.", "operationId"=>"get-custom-colors", "x-api-path-slug"=>"usersidcolors-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Id", "Colors"]}}, "/users/{id}/colors/asset_string"=>{"get"=>{"summary"=>"Get custom color", "description"=>"Get custom color.", "operationId"=>"get-custom-color", "x-api-path-slug"=>"usersidcolorsasset-string-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Id", "Colors", "Asset", "String"]}, "put"=>{"summary"=>"Update custom color", "description"=>"Update custom color.", "operationId"=>"update-custom-color", "x-api-path-slug"=>"usersidcolorsasset-string-put", "parameters"=>[{"in"=>"query", "name"=>"hexcode", "description"=>"The hexcode of the color to set for the context, if you choose to pass thenhexcode as a query parameter rather than in the request body you should NOTninclude the '#' unless you escape it first"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Id", "Colors", "Asset", "String"]}}, "/users/{id}/merge_into/accounts/destination_account_id/users/{destination_user_id}"=>{"put"=>{"summary"=>"Merge user into another user", "description"=>"Merge user into another user.", "operationId"=>"merge-user-into-another-user", "x-api-path-slug"=>"usersidmerge-intoaccountsdestination-account-idusersdestination-user-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Id", "Merge", "Into", "Accounts", "Destination", "Account", "Id", "Users", "Destination", "User", "Id"]}}, "/users/{id}/merge_into/destination_user_id"=>{"put"=>{"summary"=>"Merge user into another user", "description"=>"Merge user into another user.", "operationId"=>"merge-user-into-another-user", "x-api-path-slug"=>"usersidmerge-intodestination-user-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Id", "Merge", "Into", "Destination", "User", "Id"]}}, "/users/{id}/settings"=>{"get"=>{"summary"=>"Update user settings.", "description"=>"Update user settings..", "operationId"=>"update-user-settings", "x-api-path-slug"=>"usersidsettings-get", "parameters"=>[{"in"=>"query", "name"=>"manual_mark_as_read", "description"=>"If true, require user to manually mark discussion posts as read (don'tnauto-mark as read)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Id", "Settings"]}, "put"=>{"summary"=>"Update user settings.", "description"=>"Update user settings..", "operationId"=>"update-user-settings", "x-api-path-slug"=>"usersidsettings-put", "parameters"=>[{"in"=>"query", "name"=>"manual_mark_as_read", "description"=>"If true, require user to manually mark discussion posts as read (don'tnauto-mark as read)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Id", "Settings"]}}, "/users/{user_id}/avatars"=>{"get"=>{"summary"=>"List avatar options", "description"=>"List avatar options.", "operationId"=>"list-avatar-options", "x-api-path-slug"=>"usersuser-idavatars-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Avatars"]}}, "/users/{user_id}/calendar_events"=>{"get"=>{"summary"=>"List calendar events for a user", "description"=>"List calendar events for a user.", "operationId"=>"list-calendar-events-for-a-user", "x-api-path-slug"=>"usersuser-idcalendar-events-get", "parameters"=>[{"in"=>"query", "name"=>"all_events", "description"=>"Defaults to false (uses start_date, end_date, and undated criteria)"}, {"in"=>"query", "name"=>"context_codes[]", "description"=>"List of context codes of courses/groups/users whose events you want to see"}, {"in"=>"query", "name"=>"end_date", "description"=>"Only return events before the end_date (inclusive)"}, {"in"=>"query", "name"=>"excludes[]", "description"=>"Array of attributes to exclude"}, {"in"=>"query", "name"=>"start_date", "description"=>"Only return events since the start_date (inclusive)"}, {"in"=>"query", "name"=>"type", "description"=>"Defaults to u201ceventu201dnn n n Allowed values: event, assignment"}, {"in"=>"query", "name"=>"undated", "description"=>"Defaults to false (dated events only)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Calendar", "Events"]}}, "/users/{user_id}/communication_channels"=>{"get"=>{"summary"=>"List user communication channels", "description"=>"List user communication channels.", "operationId"=>"list-user-communication-channels", "x-api-path-slug"=>"usersuser-idcommunication-channels-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Communication", "Channels"]}, "post"=>{"summary"=>"Create a communication channel", "description"=>"Create a communication channel.", "operationId"=>"create-a-communication-channel", "x-api-path-slug"=>"usersuser-idcommunication-channels-post", "parameters"=>[{"in"=>"query", "name"=>"communication_channel[address]", "description"=>"An email address or SMS number"}, {"in"=>"query", "name"=>"communication_channel[token]", "description"=>"A registration id, device token, or equivalent token given to an app whennregistering with a push notification provider"}, {"in"=>"query", "name"=>"communication_channel[type]", "description"=>"The type of communication channel"}, {"in"=>"query", "name"=>"skip_confirmation", "description"=>"Only valid for site admins and account admins making requests; If true, thenchannel is automatically validated and no confirmation email or SMS isnsent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Communication", "Channels"]}}, "/users/{user_id}/communication_channels/communication_channel_id/notification_preferences"=>{"get"=>{"summary"=>"List preferences", "description"=>"List preferences.", "operationId"=>"list-preferences", "x-api-path-slug"=>"usersuser-idcommunication-channelscommunication-channel-idnotification-preferences-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Communication", "Channels", "Communication", "Channel", "Id", "Notification", "Preferences"]}}, "/users/{user_id}/communication_channels/communication_channel_id/notification_preferences/{notification}"=>{"get"=>{"summary"=>"Get a preference", "description"=>"Get a preference.", "operationId"=>"get-a-preference", "x-api-path-slug"=>"usersuser-idcommunication-channelscommunication-channel-idnotification-preferencesnotification-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Communication", "Channels", "Communication", "Channel", "Id", "Notification", "Preferences", "Notification"]}}, "/users/{user_id}/communication_channels/communication_channel_id/notification_preference_categories"=>{"get"=>{"summary"=>"List of preference categories", "description"=>"List of preference categories.", "operationId"=>"list-of-preference-categories", "x-api-path-slug"=>"usersuser-idcommunication-channelscommunication-channel-idnotification-preference-categories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Communication", "Channels", "Communication", "Channel", "Id", "Notification", "Preference", "Categories"]}}, "/users/{user_id}/communication_channels/id"=>{"delete"=>{"summary"=>"Delete a communication channel", "description"=>"Delete a communication channel.", "operationId"=>"delete-a-communication-channel", "x-api-path-slug"=>"usersuser-idcommunication-channelsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Communication", "Channels", "Id"]}}, "/users/{user_id}/communication_channels/type/{address}"=>{"delete"=>{"summary"=>"Delete a communication channel", "description"=>"Delete a communication channel.", "operationId"=>"delete-a-communication-channel", "x-api-path-slug"=>"usersuser-idcommunication-channelstypeaddress-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Communication", "Channels", "Type", "Address"]}}, "/users/{user_id}/communication_channels/type/{address}/notification_preferences"=>{"get"=>{"summary"=>"List preferences", "description"=>"List preferences.", "operationId"=>"list-preferences", "x-api-path-slug"=>"usersuser-idcommunication-channelstypeaddressnotification-preferences-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Communication", "Channels", "Type", "Address", "Notification", "Preferences"]}}, "/users/{user_id}/communication_channels/type/{address}/notification_preferences/notification"=>{"get"=>{"summary"=>"Get a preference", "description"=>"Get a preference.", "operationId"=>"get-a-preference", "x-api-path-slug"=>"usersuser-idcommunication-channelstypeaddressnotification-preferencesnotification-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Communication", "Channels", "Type", "Address", "Notification", "Preferences", "Notification"]}}, "/users/{user_id}/content_exports"=>{"get"=>{"summary"=>"List content exports", "description"=>"List content exports.", "operationId"=>"list-content-exports", "x-api-path-slug"=>"usersuser-idcontent-exports-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Content", "Exports"]}, "post"=>{"summary"=>"Export content", "description"=>"Export content.", "operationId"=>"export-content", "x-api-path-slug"=>"usersuser-idcontent-exports-post", "parameters"=>[{"in"=>"query", "name"=>"export_type", "description"=>"u201ccommon_cartridgeu201dnnExport the contents of the course in the Common Cartridge ("}, {"in"=>"query", "name"=>"skip_notifications", "description"=>"Don't send the notifications about the export to the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Content", "Exports"]}}, "/users/{user_id}/content_exports/id"=>{"get"=>{"summary"=>"Show content export", "description"=>"Show content export.", "operationId"=>"show-content-export", "x-api-path-slug"=>"usersuser-idcontent-exportsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Content", "Exports", "Id"]}}, "/users/{user_id}/content_licenses"=>{"get"=>{"summary"=>"List licenses", "description"=>"List licenses.", "operationId"=>"list-licenses", "x-api-path-slug"=>"usersuser-idcontent-licenses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Content", "Licenses"]}}, "/users/{user_id}/content_migrations"=>{"get"=>{"summary"=>"List content migrations", "description"=>"List content migrations.", "operationId"=>"list-content-migrations", "x-api-path-slug"=>"usersuser-idcontent-migrations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Content", "Migrations"]}, "post"=>{"summary"=>"Create a content migration", "description"=>"Create a content migration.", "operationId"=>"create-a-content-migration", "x-api-path-slug"=>"usersuser-idcontent-migrations-post", "parameters"=>[{"in"=>"query", "name"=>"date_shift_options[day_substitutions][X]", "description"=>"Move anything scheduled for day 'X' to the specified day"}, {"in"=>"query", "name"=>"date_shift_options[new_end_date]", "description"=>"The new end date for the source content/course"}, {"in"=>"query", "name"=>"date_shift_options[new_start_date]", "description"=>"The new start date for the content/course"}, {"in"=>"query", "name"=>"date_shift_options[old_end_date]", "description"=>"The original end date of the source content/course"}, {"in"=>"query", "name"=>"date_shift_options[old_start_date]", "description"=>"The original start date of the source content/course"}, {"in"=>"query", "name"=>"date_shift_options[remove_dates]", "description"=>"Whether to remove dates in the copied course"}, {"in"=>"query", "name"=>"date_shift_options[shift_dates]", "description"=>"Whether to shift dates in the copied course"}, {"in"=>"query", "name"=>"migration_type", "description"=>"The type of the migration"}, {"in"=>"query", "name"=>"pre_attachment[*]", "description"=>"Other file upload properties, See File Upload Documentation"}, {"in"=>"query", "name"=>"pre_attachment[name]", "description"=>"Required if uploading a file"}, {"in"=>"query", "name"=>"settings[file_url]", "description"=>"A URL to download the file from"}, {"in"=>"query", "name"=>"settings[folder_id]", "description"=>"The folder to unzip the "}, {"in"=>"query", "name"=>"settings[overwrite_quizzes]", "description"=>"Whether to overwrite quizzes with the same identifiers between contentnpackages"}, {"in"=>"query", "name"=>"settings[question_bank_id]", "description"=>"The existing question bank ID to import questions into if not specified innthe content package"}, {"in"=>"query", "name"=>"settings[question_bank_name]", "description"=>"The question bank to import questions into if not specified in the contentnpackage, if both bank id and name are set, id will take precedence"}, {"in"=>"query", "name"=>"settings[source_course_id]", "description"=>"The course to copy from for a course copy migration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Content", "Migrations"]}}, "/users/{user_id}/content_migrations/content_migration_id/migration_issues"=>{"get"=>{"summary"=>"List migration issues", "description"=>"List migration issues.", "operationId"=>"list-migration-issues", "x-api-path-slug"=>"usersuser-idcontent-migrationscontent-migration-idmigration-issues-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Content", "Migrations", "Content", "Migration", "Id", "Migration", "Issues"]}}, "/users/{user_id}/content_migrations/content_migration_id/migration_issues/{id}"=>{"get"=>{"summary"=>"Get a migration issue", "description"=>"Get a migration issue.", "operationId"=>"get-a-migration-issue", "x-api-path-slug"=>"usersuser-idcontent-migrationscontent-migration-idmigration-issuesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Content", "Migrations", "Content", "Migration", "Id", "Migration", "Issues", "Id"]}, "put"=>{"summary"=>"Update a migration issue", "description"=>"Update a migration issue.", "operationId"=>"update-a-migration-issue", "x-api-path-slug"=>"usersuser-idcontent-migrationscontent-migration-idmigration-issuesid-put", "parameters"=>[{"in"=>"query", "name"=>"workflow_state", "description"=>"Set the workflow_state of the issue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Content", "Migrations", "Content", "Migration", "Id", "Migration", "Issues", "Id"]}}, "/users/{user_id}/content_migrations/id"=>{"get"=>{"summary"=>"Get a content migration", "description"=>"Get a content migration.", "operationId"=>"get-a-content-migration", "x-api-path-slug"=>"usersuser-idcontent-migrationsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Content", "Migrations", "Id"]}, "put"=>{"summary"=>"Update a content migration", "description"=>"Update a content migration.", "operationId"=>"update-a-content-migration", "x-api-path-slug"=>"usersuser-idcontent-migrationsid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Content", "Migrations", "Id"]}}, "/users/{user_id}/content_migrations/migrators"=>{"get"=>{"summary"=>"List Migration Systems", "description"=>"List migration systems.", "operationId"=>"list-migration-systems", "x-api-path-slug"=>"usersuser-idcontent-migrationsmigrators-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Content", "Migrations", "Migrators"]}}, "/users/{user_id}/courses"=>{"get"=>{"summary"=>"List courses for a user", "description"=>"List courses for a user.", "operationId"=>"list-courses-for-a-user", "x-api-path-slug"=>"usersuser-idcourses-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"u201cneeds_grading_countu201d: Optional information to include with each Course"}, {"in"=>"query", "name"=>"state[]", "description"=>"If set, only return courses that are in the given state(s)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Courses"]}}, "/users/{user_id}/courses/course_id/assignments"=>{"get"=>{"summary"=>"List assignments for user", "description"=>"List assignments for user.", "operationId"=>"list-assignments-for-user", "x-api-path-slug"=>"usersuser-idcoursescourse-idassignments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Courses", "Course", "Id", "Assignments"]}}, "/users/{user_id}/custom_data(/*scope)"=>{"delete"=>{"summary"=>"Delete custom data", "description"=>"Delete custom data.", "operationId"=>"delete-custom-data", "x-api-path-slug"=>"usersuser-idcustom-datascope-delete", "parameters"=>[{"in"=>"query", "name"=>"ns", "description"=>"The namespace from which to delete the data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Custom", "Data(", "*scope)"]}, "get"=>{"summary"=>"Load custom data", "description"=>"Load custom data.", "operationId"=>"load-custom-data", "x-api-path-slug"=>"usersuser-idcustom-datascope-get", "parameters"=>[{"in"=>"query", "name"=>"ns", "description"=>"The namespace from which to retrieve the data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Custom", "Data(", "*scope)"]}, "put"=>{"summary"=>"Store custom data", "description"=>"Store custom data.", "operationId"=>"store-custom-data", "x-api-path-slug"=>"usersuser-idcustom-datascope-put", "parameters"=>[{"in"=>"query", "name"=>"data", "description"=>"The data you want to store for the user, at the specified scope"}, {"in"=>"query", "name"=>"ns", "description"=>"The namespace under which to store the data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Custom", "Data(", "*scope)"]}}, "/users/{user_id}/enrollments"=>{"get"=>{"summary"=>"List enrollments", "description"=>"List enrollments.", "operationId"=>"list-enrollments", "x-api-path-slug"=>"usersuser-idenrollments-get", "parameters"=>[{"in"=>"query", "name"=>"grading_period_id", "description"=>"Return grades for the given grading_period"}, {"in"=>"query", "name"=>"role[]", "description"=>"A list of enrollment roles to return"}, {"in"=>"query", "name"=>"state[]", "description"=>"Filter by enrollment state"}, {"in"=>"query", "name"=>"type[]", "description"=>"A list of enrollment types to return"}, {"in"=>"query", "name"=>"user_id", "description"=>"Filter by user_id (only valid for course or section enrollment queries)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Enrollments"]}}, "/users/{user_id}/features"=>{"get"=>{"summary"=>"List features", "description"=>"List features.", "operationId"=>"list-features", "x-api-path-slug"=>"usersuser-idfeatures-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Features"]}}, "/users/{user_id}/features/enabled"=>{"get"=>{"summary"=>"List enabled features", "description"=>"List enabled features.", "operationId"=>"list-enabled-features", "x-api-path-slug"=>"usersuser-idfeaturesenabled-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Features", "Enabled"]}}, "/users/{user_id}/features/flags/feature"=>{"delete"=>{"summary"=>"Remove feature flag", "description"=>"Remove feature flag.", "operationId"=>"remove-feature-flag", "x-api-path-slug"=>"usersuser-idfeaturesflagsfeature-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Features", "Flags", "Feature"]}, "get"=>{"summary"=>"Get feature flag", "description"=>"Get feature flag.", "operationId"=>"get-feature-flag", "x-api-path-slug"=>"usersuser-idfeaturesflagsfeature-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Features", "Flags", "Feature"]}, "put"=>{"summary"=>"Set feature flag", "description"=>"Set feature flag.", "operationId"=>"set-feature-flag", "x-api-path-slug"=>"usersuser-idfeaturesflagsfeature-put", "parameters"=>[{"in"=>"query", "name"=>"locking_account_id", "description"=>"If set, this FeatureFlag may only be modified by someone withnadministrative rights in the specified account"}, {"in"=>"query", "name"=>"state", "description"=>"u201coffu201dnnThe feature is not available for the course, user, or account andnsub-accounts"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Features", "Flags", "Feature"]}}, "/users/{user_id}/files"=>{"get"=>{"summary"=>"List files", "description"=>"List files.", "operationId"=>"list-files", "x-api-path-slug"=>"usersuser-idfiles-get", "parameters"=>[{"in"=>"query", "name"=>"content_types[]", "description"=>"Filter results by content-type"}, {"in"=>"query", "name"=>"include[]", "description"=>"Array of additional information to include"}, {"in"=>"query", "name"=>"only[]", "description"=>"Array of information to restrict to"}, {"in"=>"query", "name"=>"order", "description"=>"The sorting order"}, {"in"=>"query", "name"=>"search_term", "description"=>"The partial name of the files to match and return"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort results by this field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Files"]}, "post"=>{"summary"=>"Upload a file", "description"=>"Upload a file.", "operationId"=>"upload-a-file", "x-api-path-slug"=>"usersuser-idfiles-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Files"]}}, "/users/{user_id}/files/id"=>{"get"=>{"summary"=>"Get file", "description"=>"Get file.", "operationId"=>"get-file", "x-api-path-slug"=>"usersuser-idfilesid-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Array of additional information to include"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Files", "Id"]}}, "/users/{user_id}/files/quota"=>{"get"=>{"summary"=>"Get quota information", "description"=>"Get quota information.", "operationId"=>"get-quota-information", "x-api-path-slug"=>"usersuser-idfilesquota-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Files", "Quota"]}}, "/users/{user_id}/folders"=>{"get"=>{"summary"=>"List all folders", "description"=>"List all folders.", "operationId"=>"list-all-folders", "x-api-path-slug"=>"usersuser-idfolders-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Folders"]}, "post"=>{"summary"=>"Create folder", "description"=>"Create folder.", "operationId"=>"create-folder", "x-api-path-slug"=>"usersuser-idfolders-post", "parameters"=>[{"in"=>"query", "name"=>"hidden", "description"=>"Flag the folder as hidden"}, {"in"=>"query", "name"=>"locked", "description"=>"Flag the folder as locked"}, {"in"=>"query", "name"=>"lock_at", "description"=>"The datetime to lock the folder at"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the folder"}, {"in"=>"query", "name"=>"parent_folder_id", "description"=>"The id of the folder to store the file in"}, {"in"=>"query", "name"=>"parent_folder_path", "description"=>"The path of the folder to store the new folder in"}, {"in"=>"query", "name"=>"position", "description"=>"Set an explicit sort position for the folder"}, {"in"=>"query", "name"=>"unlock_at", "description"=>"The datetime to unlock the folder at"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Folders"]}}, "/users/{user_id}/folders/by_path"=>{"get"=>{"summary"=>"Resolve path", "description"=>"Resolve path.", "operationId"=>"resolve-path", "x-api-path-slug"=>"usersuser-idfoldersby-path-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Folders", "By", "Path"]}}, "/users/{user_id}/folders/by_path/*full_path"=>{"get"=>{"summary"=>"Resolve path", "description"=>"Resolve path.", "operationId"=>"resolve-path", "x-api-path-slug"=>"usersuser-idfoldersby-pathfull-path-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Folders", "By", "Path", "*full", "Path"]}}, "/users/{user_id}/folders/id"=>{"get"=>{"summary"=>"Get folder", "description"=>"Get folder.", "operationId"=>"get-folder", "x-api-path-slug"=>"usersuser-idfoldersid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Folders", "Id"]}}, "/users/{user_id}/logins"=>{"get"=>{"summary"=>"List user logins", "description"=>"List user logins.", "operationId"=>"list-user-logins", "x-api-path-slug"=>"usersuser-idlogins-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Logins"]}}, "/users/{user_id}/logins/id"=>{"delete"=>{"summary"=>"Delete a user login", "description"=>"Delete a user login.", "operationId"=>"delete-a-user-login", "x-api-path-slug"=>"usersuser-idloginsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Logins", "Id"]}}, "/users/{user_id}/missing_submissions"=>{"get"=>{"summary"=>"List Missing Submissions", "description"=>"List missing submissions.", "operationId"=>"list-missing-submissions", "x-api-path-slug"=>"usersuser-idmissing-submissions-get", "parameters"=>[{"in"=>"query", "name"=>"user_id", "description"=>"the student's ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Missing", "Submissions"]}}, "/users/{user_id}/observees"=>{"get"=>{"summary"=>"List observees", "description"=>"List observees.", "operationId"=>"list-observees", "x-api-path-slug"=>"usersuser-idobservees-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"u201cavatar_urlu201d: Optionally include avatar_url"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Observees"]}, "post"=>{"summary"=>"Add an observee with credentials", "description"=>"Add an observee with credentials.", "operationId"=>"add-an-observee-with-credentials", "x-api-path-slug"=>"usersuser-idobservees-post", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"The access token for the user to observe"}, {"in"=>"query", "name"=>"observee[password]", "description"=>"The password for the user to observe"}, {"in"=>"query", "name"=>"observee[unique_id]", "description"=>"The login id for the user to observe"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Observees"]}}, "/users/{user_id}/observees/observee_id"=>{"delete"=>{"summary"=>"Remove an observee", "description"=>"Remove an observee.", "operationId"=>"remove-an-observee", "x-api-path-slug"=>"usersuser-idobserveesobservee-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Observees", "Observee", "Id"]}, "get"=>{"summary"=>"Show an observee", "description"=>"Show an observee.", "operationId"=>"show-an-observee", "x-api-path-slug"=>"usersuser-idobserveesobservee-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Observees", "Observee", "Id"]}, "put"=>{"summary"=>"Add an observee", "description"=>"Add an observee.", "operationId"=>"add-an-observee", "x-api-path-slug"=>"usersuser-idobserveesobservee-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Observees", "Observee", "Id"]}}, "/users/{user_id}/page_views"=>{"get"=>{"summary"=>"List user page views", "description"=>"List user page views.", "operationId"=>"list-user-page-views", "x-api-path-slug"=>"usersuser-idpage-views-get", "parameters"=>[{"in"=>"query", "name"=>"end_time", "description"=>"The end of the time range from which you want page views"}, {"in"=>"query", "name"=>"start_time", "description"=>"The beginning of the time range from which you want page views"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Page", "Views"]}}, "/users/{user_id}/profile"=>{"get"=>{"summary"=>"Get user profile", "description"=>"Get user profile.", "operationId"=>"get-user-profile", "x-api-path-slug"=>"usersuser-idprofile-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Profile"]}}, "/users/{user_id}/usage_rights"=>{"delete"=>{"summary"=>"Remove usage rights", "description"=>"Remove usage rights.", "operationId"=>"remove-usage-rights", "x-api-path-slug"=>"usersuser-idusage-rights-delete", "parameters"=>[{"in"=>"query", "name"=>"file_ids[]", "description"=>"List of ids of files to remove associated usage rights from"}, {"in"=>"query", "name"=>"folder_ids[]", "description"=>"List of ids of folders"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Usage", "Rights"]}, "put"=>{"summary"=>"Set usage rights", "description"=>"Set usage rights.", "operationId"=>"set-usage-rights", "x-api-path-slug"=>"usersuser-idusage-rights-put", "parameters"=>[{"in"=>"query", "name"=>"file_ids[]", "description"=>"List of ids of files to set usage rights for"}, {"in"=>"query", "name"=>"folder_ids[]", "description"=>"List of ids of folders to search for files to set usage rights for"}, {"in"=>"query", "name"=>"publish", "description"=>"Whether the file(s) or folder(s) should be published on save, provided thatnusage rights have been specified (set to `true` to publish on save)"}, {"in"=>"query", "name"=>"usage_rights[legal_copyright]", "description"=>"The legal copyright line for the files"}, {"in"=>"query", "name"=>"usage_rights[license]", "description"=>"The license that applies to the files"}, {"in"=>"query", "name"=>"usage_rights[use_justification]", "description"=>"The intellectual property justification for using the files in Canvasnn n n Allowed values: own_copyright, used_by_permission, fair_use, public_domain, creative_commons"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User", "Id", "Usage", "Rights"]}}}}, "instructure-canvas-conversations-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Instructure", "x-complete"=>1, "info"=>{"title"=>"Instructure Canvas Conversations API", "description"=>"canvas-lms-includes-a-rest-api-for-accessing-and-modifying-data-externally-from-the-main-application-in-your-own-programs-and-scripts--", "termsOfService"=>"https://www.canvaslms.com/policies/api-policy", "version"=>"v1"}, "host"=>"canvas.instructure.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/conversations"=>{"get"=>{"summary"=>"List conversations", "description"=>"List conversations.", "operationId"=>"list-conversations", "x-api-path-slug"=>"conversations-get", "parameters"=>[{"in"=>"query", "name"=>"filter[]", "description"=>"When set, only return conversations for the specified courses, groups ornusers"}, {"in"=>"query", "name"=>"filter_mode", "description"=>"When filter[] contains multiple filters, combine them with this mode,nfiltering conversations that at have at least all of the contexts (u201candu201d)nor at least one of the contexts (u201coru201d)nn n n Allowed values: and, or, default or"}, {"in"=>"query", "name"=>"include_all_conversation_ids", "description"=>"Default is false"}, {"in"=>"query", "name"=>"interleave_submissions", "description"=>"(Obsolete) Submissions are no longer linked to conversations"}, {"in"=>"query", "name"=>"scope", "description"=>"When set, only return conversations of the specified type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversations"]}, "post"=>{"summary"=>"Create a conversation", "description"=>"Create a conversation.", "operationId"=>"create-a-conversation", "x-api-path-slug"=>"conversations-post", "parameters"=>[{"in"=>"query", "name"=>"attachment_ids[]", "description"=>"An array of attachments ids"}, {"in"=>"query", "name"=>"body", "description"=>"The message to be sent"}, {"in"=>"query", "name"=>"context_code", "description"=>"The course or group that is the context for this conversation"}, {"in"=>"query", "name"=>"filter[]", "description"=>"Used when generating u201cvisibleu201d in the API response"}, {"in"=>"query", "name"=>"filter_mode", "description"=>"Used when generating u201cvisibleu201d in the API response"}, {"in"=>"query", "name"=>"group_conversation", "description"=>"Defaults to false"}, {"in"=>"query", "name"=>"media_comment_id", "description"=>"Media comment id of an audio of video file to be associated with thisnmessage"}, {"in"=>"query", "name"=>"media_comment_type", "description"=>"Type of the associated media filenn n n Allowed values: audio, video"}, {"in"=>"query", "name"=>"mode", "description"=>"Determines whether the messages will be created/sent synchronously ornasynchronously"}, {"in"=>"query", "name"=>"recipients[]", "description"=>"An array of recipient ids"}, {"in"=>"query", "name"=>"scope", "description"=>"Used when generating u201cvisibleu201d in the API response"}, {"in"=>"query", "name"=>"subject", "description"=>"The subject of the conversation"}, {"in"=>"query", "name"=>"user_note", "description"=>"Will add a faculty journal entry for each recipient as long as the usernmaking the api call has permission, the recipient is a student and facultynjournals are enabled in the account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversations"]}, "put"=>{"summary"=>"Batch update conversations", "description"=>"Batch update conversations.", "operationId"=>"batch-update-conversations", "x-api-path-slug"=>"conversations-put", "parameters"=>[{"in"=>"query", "name"=>"conversation_ids[]", "description"=>"List of conversations to update"}, {"in"=>"query", "name"=>"event", "description"=>"The action to take on each conversation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversations"]}}, "/conversations/batches"=>{"get"=>{"summary"=>"Get running batches", "description"=>"Get running batches.", "operationId"=>"get-running-batches", "x-api-path-slug"=>"conversationsbatches-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversations", "Batches"]}}, "/conversations/find_recipients"=>{"get"=>{"summary"=>"Find recipients", "description"=>"Find recipients.", "operationId"=>"find-recipients", "x-api-path-slug"=>"conversationsfind-recipients-get", "parameters"=>[{"in"=>"query", "name"=>"context", "description"=>"Limit the search to a particular course/group (e"}, {"in"=>"query", "name"=>"exclude[]", "description"=>"Array of ids to exclude from the search"}, {"in"=>"query", "name"=>"from_conversation_id", "description"=>"When searching by user_id, only users that could be normally messaged bynthis user will be returned"}, {"in"=>"query", "name"=>"permissions[]", "description"=>"Array of permission strings to be checked for each matched context (e"}, {"in"=>"query", "name"=>"search", "description"=>"Search terms used for matching users/courses/groups (e"}, {"in"=>"query", "name"=>"type", "description"=>"Limit the search just to users or contexts (groups/courses)"}, {"in"=>"query", "name"=>"user_id", "description"=>"Search for a specific user id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversations", "Find", "Recipients"]}}, "/conversations/mark_all_as_read"=>{"post"=>{"summary"=>"Mark all as read", "description"=>"Mark all as read.", "operationId"=>"mark-all-as-read", "x-api-path-slug"=>"conversationsmark-all-as-read-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversations", "Mark", "", "As", "Read"]}}, "/conversations/unread_count"=>{"get"=>{"summary"=>"Unread count", "description"=>"Unread count.", "operationId"=>"unread-count", "x-api-path-slug"=>"conversationsunread-count-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversations", "Unread", "Count"]}}, "/conversations/{id}"=>{"delete"=>{"summary"=>"Delete a conversation", "description"=>"Delete a conversation.", "operationId"=>"delete-a-conversation", "x-api-path-slug"=>"conversationsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversations", "Id"]}, "get"=>{"summary"=>"Get a single conversation", "description"=>"Get a single conversation.", "operationId"=>"get-a-single-conversation", "x-api-path-slug"=>"conversationsid-get", "parameters"=>[{"in"=>"query", "name"=>"auto_mark_as_read", "description"=>"Default true"}, {"in"=>"query", "name"=>"filter[]", "description"=>"Used when generating u201cvisibleu201d in the API response"}, {"in"=>"query", "name"=>"filter_mode", "description"=>"Used when generating u201cvisibleu201d in the API response"}, {"in"=>"query", "name"=>"interleave_submissions", "description"=>"(Obsolete) Submissions are no longer linked to conversations"}, {"in"=>"query", "name"=>"scope", "description"=>"Used when generating u201cvisibleu201d in the API response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversations", "Id"]}, "put"=>{"summary"=>"Edit a conversation", "description"=>"Edit a conversation.", "operationId"=>"edit-a-conversation", "x-api-path-slug"=>"conversationsid-put", "parameters"=>[{"in"=>"query", "name"=>"conversation[starred]", "description"=>"Toggle the starred state of the current user's view of thenconversation"}, {"in"=>"query", "name"=>"conversation[subject]", "description"=>"Change the subject of this conversation"}, {"in"=>"query", "name"=>"conversation[subscribed]", "description"=>"Toggle the current user's subscription to the conversation (only validnfor group conversations)"}, {"in"=>"query", "name"=>"conversation[workflow_state]", "description"=>"Change the state of this conversationnn n n Allowed values: read, unread, archived"}, {"in"=>"query", "name"=>"filter[]", "description"=>"Used when generating u201cvisibleu201d in the API response"}, {"in"=>"query", "name"=>"filter_mode", "description"=>"Used when generating u201cvisibleu201d in the API response"}, {"in"=>"query", "name"=>"scope", "description"=>"Used when generating u201cvisibleu201d in the API response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversations", "Id"]}}, "/conversations/{id}/add_message"=>{"post"=>{"summary"=>"Add a message", "description"=>"Add a message.", "operationId"=>"add-a-message", "x-api-path-slug"=>"conversationsidadd-message-post", "parameters"=>[{"in"=>"query", "name"=>"attachment_ids[]", "description"=>"An array of attachments ids"}, {"in"=>"query", "name"=>"body", "description"=>"The message to be sent"}, {"in"=>"query", "name"=>"included_messages[]", "description"=>"no description"}, {"in"=>"query", "name"=>"media_comment_id", "description"=>"Media comment id of an audio of video file to be associated with thisnmessage"}, {"in"=>"query", "name"=>"media_comment_type", "description"=>"Type of the associated media file"}, {"in"=>"query", "name"=>"recipients[]", "description"=>"no description"}, {"in"=>"query", "name"=>"user_note", "description"=>"Will add a faculty journal entry for each recipient as long as the usernmaking the api call has permission, the recipient is a student and facultynjournals are enabled in the account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversations", "Id", "Add", "Message"]}}, "/conversations/{id}/add_recipients"=>{"post"=>{"summary"=>"Add recipients", "description"=>"Add recipients.", "operationId"=>"add-recipients", "x-api-path-slug"=>"conversationsidadd-recipients-post", "parameters"=>[{"in"=>"query", "name"=>"recipients[]", "description"=>"An array of recipient ids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversations", "Id", "Add", "Recipients"]}}, "/conversations/{id}/remove_messages"=>{"post"=>{"summary"=>"Delete a message", "description"=>"Delete a message.", "operationId"=>"delete-a-message", "x-api-path-slug"=>"conversationsidremove-messages-post", "parameters"=>[{"in"=>"query", "name"=>"remove[]", "description"=>"Array of message ids to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversations", "Id", "Remove", "Messages"]}}}}, "instructure-canvas-audit-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Instructure", "x-complete"=>1, "info"=>{"title"=>"Instructure Canvas Audit API", "description"=>"canvas-lms-includes-a-rest-api-for-accessing-and-modifying-data-externally-from-the-main-application-in-your-own-programs-and-scripts--", "termsOfService"=>"https://www.canvaslms.com/policies/api-policy", "version"=>"v1"}, "host"=>"canvas.instructure.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/audit/authentication/accounts/{account_id}"=>{"get"=>{"summary"=>"Query by account.", "description"=>"Query by account..", "operationId"=>"query-by-account", "x-api-path-slug"=>"auditauthenticationaccountsaccount-id-get", "parameters"=>[{"in"=>"query", "name"=>"end_time", "description"=>"The end of the time range from which you want events"}, {"in"=>"query", "name"=>"start_time", "description"=>"The beginning of the time range from which you want events"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audit", "Authentication", "Accounts", "Account", "Id"]}}, "/audit/authentication/logins/{login_id}"=>{"get"=>{"summary"=>"Query by login.", "description"=>"Query by login..", "operationId"=>"query-by-login", "x-api-path-slug"=>"auditauthenticationloginslogin-id-get", "parameters"=>[{"in"=>"query", "name"=>"end_time", "description"=>"The end of the time range from which you want events"}, {"in"=>"query", "name"=>"start_time", "description"=>"The beginning of the time range from which you want events"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audit", "Authentication", "Logins", "Login", "Id"]}}, "/audit/authentication/users/{user_id}"=>{"get"=>{"summary"=>"Query by user.", "description"=>"Query by user..", "operationId"=>"query-by-user", "x-api-path-slug"=>"auditauthenticationusersuser-id-get", "parameters"=>[{"in"=>"query", "name"=>"end_time", "description"=>"The end of the time range from which you want events"}, {"in"=>"query", "name"=>"start_time", "description"=>"The beginning of the time range from which you want events"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audit", "Authentication", "Users", "User", "Id"]}}, "/audit/course/courses/{course_id}"=>{"get"=>{"summary"=>"Query by course.", "description"=>"Query by course..", "operationId"=>"query-by-course", "x-api-path-slug"=>"auditcoursecoursescourse-id-get", "parameters"=>[{"in"=>"query", "name"=>"end_time", "description"=>"The end of the time range from which you want events"}, {"in"=>"query", "name"=>"start_time", "description"=>"The beginning of the time range from which you want events"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audit", "Course", "Courses", "Course", "Id"]}}, "/audit/grade_change/assignments/{assignment_id}"=>{"get"=>{"summary"=>"Query by assignment.", "description"=>"Query by assignment..", "operationId"=>"query-by-assignment", "x-api-path-slug"=>"auditgrade-changeassignmentsassignment-id-get", "parameters"=>[{"in"=>"query", "name"=>"end_time", "description"=>"The end of the time range from which you want events"}, {"in"=>"query", "name"=>"start_time", "description"=>"The beginning of the time range from which you want events"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audit", "Grade", "Change", "Assignments", "Assignment", "Id"]}}, "/audit/grade_change/courses/{course_id}"=>{"get"=>{"summary"=>"Query by course.", "description"=>"Query by course..", "operationId"=>"query-by-course", "x-api-path-slug"=>"auditgrade-changecoursescourse-id-get", "parameters"=>[{"in"=>"query", "name"=>"end_time", "description"=>"The end of the time range from which you want events"}, {"in"=>"query", "name"=>"start_time", "description"=>"The beginning of the time range from which you want events"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audit", "Grade", "Change", "Courses", "Course", "Id"]}}, "/audit/grade_change/graders/{grader_id}"=>{"get"=>{"summary"=>"Query by grader.", "description"=>"Query by grader..", "operationId"=>"query-by-grader", "x-api-path-slug"=>"auditgrade-changegradersgrader-id-get", "parameters"=>[{"in"=>"query", "name"=>"end_time", "description"=>"The end of the time range from which you want events"}, {"in"=>"query", "name"=>"start_time", "description"=>"The beginning of the time range from which you want events"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audit", "Grade", "Change", "Graders", "Grader", "Id"]}}, "/audit/grade_change/students/{student_id}"=>{"get"=>{"summary"=>"Query by student.", "description"=>"Query by student..", "operationId"=>"query-by-student", "x-api-path-slug"=>"auditgrade-changestudentsstudent-id-get", "parameters"=>[{"in"=>"query", "name"=>"end_time", "description"=>"The end of the time range from which you want events"}, {"in"=>"query", "name"=>"start_time", "description"=>"The beginning of the time range from which you want events"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audit", "Grade", "Change", "Students", "Student", "Id"]}}}}, "instructure-canvas-global-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Instructure", "x-complete"=>1, "info"=>{"title"=>"Instructure Canvas Global API", "description"=>"canvas-lms-includes-a-rest-api-for-accessing-and-modifying-data-externally-from-the-main-application-in-your-own-programs-and-scripts--", "termsOfService"=>"https://www.canvaslms.com/policies/api-policy", "version"=>"v1"}, "host"=>"canvas.instructure.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/global/outcome_groups/{id}"=>{"delete"=>{"summary"=>"Delete an outcome group", "description"=>"Delete an outcome group.", "operationId"=>"delete-an-outcome-group", "x-api-path-slug"=>"globaloutcome-groupsid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global", "Outcome", "Groups", "Id"]}, "get"=>{"summary"=>"Show an outcome group", "description"=>"Show an outcome group.", "operationId"=>"show-an-outcome-group", "x-api-path-slug"=>"globaloutcome-groupsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global", "Outcome", "Groups", "Id"]}, "put"=>{"summary"=>"Update an outcome group", "description"=>"Update an outcome group.", "operationId"=>"update-an-outcome-group", "x-api-path-slug"=>"globaloutcome-groupsid-put", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"The new outcome group description"}, {"in"=>"query", "name"=>"parent_outcome_group_id", "description"=>"The id of the new parent outcome group"}, {"in"=>"query", "name"=>"title", "description"=>"The new outcome group title"}, {"in"=>"query", "name"=>"vendor_guid", "description"=>"A custom GUID for the learning standard"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global", "Outcome", "Groups", "Id"]}}, "/global/outcome_groups/{id}/import"=>{"post"=>{"summary"=>"Import an outcome group", "description"=>"Import an outcome group.", "operationId"=>"import-an-outcome-group", "x-api-path-slug"=>"globaloutcome-groupsidimport-post", "parameters"=>[{"in"=>"query", "name"=>"source_outcome_group_id", "description"=>"The ID of the source outcome group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global", "Outcome", "Groups", "Id", "Import"]}}, "/global/outcome_groups/{id}/outcomes"=>{"get"=>{"summary"=>"List linked outcomes", "description"=>"List linked outcomes.", "operationId"=>"list-linked-outcomes", "x-api-path-slug"=>"globaloutcome-groupsidoutcomes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global", "Outcome", "Groups", "Id", "Outcomes"]}, "post"=>{"summary"=>"Create/link an outcome", "description"=>"Create/link an outcome.", "operationId"=>"createlink-an-outcome", "x-api-path-slug"=>"globaloutcome-groupsidoutcomes-post", "parameters"=>[{"in"=>"query", "name"=>"calculation_int", "description"=>"The new calculation int"}, {"in"=>"query", "name"=>"calculation_method", "description"=>"The new calculation method"}, {"in"=>"query", "name"=>"description", "description"=>"The description of the new outcome"}, {"in"=>"query", "name"=>"display_name", "description"=>"A friendly name shown in reports for outcomes with cryptic titles, such asncommon core standards names"}, {"in"=>"query", "name"=>"mastery_points", "description"=>"The mastery threshold for the embedded rubric criterion"}, {"in"=>"query", "name"=>"outcome_id", "description"=>"The ID of the existing outcome to link"}, {"in"=>"query", "name"=>"ratings[][description]", "description"=>"The description of a rating level for the embedded rubric criterion"}, {"in"=>"query", "name"=>"ratings[][points]", "description"=>"The points corresponding to a rating level for the embedded rubricncriterion"}, {"in"=>"query", "name"=>"title", "description"=>"The title of the new outcome"}, {"in"=>"query", "name"=>"vendor_guid", "description"=>"A custom GUID for the learning standard"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global", "Outcome", "Groups", "Id", "Outcomes"]}}, "/global/outcome_groups/{id}/outcomes/outcome_id"=>{"delete"=>{"summary"=>"Unlink an outcome", "description"=>"Unlink an outcome.", "operationId"=>"unlink-an-outcome", "x-api-path-slug"=>"globaloutcome-groupsidoutcomesoutcome-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global", "Outcome", "Groups", "Id", "Outcomes", "Outcome", "Id"]}, "put"=>{"summary"=>"Create/link an outcome", "description"=>"Create/link an outcome.", "operationId"=>"createlink-an-outcome", "x-api-path-slug"=>"globaloutcome-groupsidoutcomesoutcome-id-put", "parameters"=>[{"in"=>"query", "name"=>"calculation_int", "description"=>"The new calculation int"}, {"in"=>"query", "name"=>"calculation_method", "description"=>"The new calculation method"}, {"in"=>"query", "name"=>"description", "description"=>"The description of the new outcome"}, {"in"=>"query", "name"=>"display_name", "description"=>"A friendly name shown in reports for outcomes with cryptic titles, such asncommon core standards names"}, {"in"=>"query", "name"=>"mastery_points", "description"=>"The mastery threshold for the embedded rubric criterion"}, {"in"=>"query", "name"=>"outcome_id", "description"=>"The ID of the existing outcome to link"}, {"in"=>"query", "name"=>"ratings[][description]", "description"=>"The description of a rating level for the embedded rubric criterion"}, {"in"=>"query", "name"=>"ratings[][points]", "description"=>"The points corresponding to a rating level for the embedded rubricncriterion"}, {"in"=>"query", "name"=>"title", "description"=>"The title of the new outcome"}, {"in"=>"query", "name"=>"vendor_guid", "description"=>"A custom GUID for the learning standard"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global", "Outcome", "Groups", "Id", "Outcomes", "Outcome", "Id"]}}, "/global/outcome_groups/{id}/subgroups"=>{"get"=>{"summary"=>"List subgroups", "description"=>"List subgroups.", "operationId"=>"list-subgroups", "x-api-path-slug"=>"globaloutcome-groupsidsubgroups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global", "Outcome", "Groups", "Id", "Subgroups"]}, "post"=>{"summary"=>"Create a subgroup", "description"=>"Create a subgroup.", "operationId"=>"create-a-subgroup", "x-api-path-slug"=>"globaloutcome-groupsidsubgroups-post", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"The description of the new outcome group"}, {"in"=>"query", "name"=>"title", "description"=>"The title of the new outcome group"}, {"in"=>"query", "name"=>"vendor_guid", "description"=>"A custom GUID for the learning standard"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global", "Outcome", "Groups", "Id", "Subgroups"]}}, "/global/root_outcome_group"=>{"get"=>{"summary"=>"Redirect to root outcome group for context", "description"=>"Redirect to root outcome group for context.", "operationId"=>"redirect-to-root-outcome-group-for-context", "x-api-path-slug"=>"globalroot-outcome-group-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global", "Root", "Outcome", "Group"]}}}}, "apis"=>{"name"=>"Instructure", "x-slug"=>"instructure", "description"=>"Instructure makes software that makes smarter people. Products include Canvas LMS, Bridge and Canvas Network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/820-instructure.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"367", "tags"=>"API Provider,Education,Enterprise,Indie EdTech Data Jam,LMS,Profiles,SaaS,Service API,Stack Network,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"instructure/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Instructure Canvas Appointment Groups API", "x-api-slug"=>"instructure-canvas-appointment-groups-api", "description"=>"Instructure makes software that makes smarter people. Products include Canvas LMS, Bridge and Canvas Network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/820-instructure.jpg", "humanURL"=>"http://instructure.com", "baseURL"=>"https://canvas.instructure.com//api/v1", "tags"=>"API Provider,Education,Enterprise,Indie EdTech Data Jam,LMS,Profiles,SaaS,Service API,Stack Network,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/instructure/appointment-groupsidusers-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/instructure/instructure-canvas-appointment-groups-api-openapi.yaml"}]}, {"name"=>"Instructure Canvas Audit API", "x-api-slug"=>"instructure-canvas-audit-api", "description"=>"Instructure makes software that makes smarter people. Products include Canvas LMS, Bridge and Canvas Network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/820-instructure.jpg", "humanURL"=>"http://instructure.com", "baseURL"=>"https://canvas.instructure.com//api/v1", "tags"=>"Appointment,Groups,Id,Users", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/instructure/auditgrade-changestudentsstudent-id-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/instructure/instructure-canvas-audit-api-openapi.yaml"}]}, {"name"=>"Instructure Canvas Calendar Events API", "x-api-slug"=>"instructure-canvas-calendar-events-api", "description"=>"Instructure makes software that makes smarter people. Products include Canvas LMS, Bridge and Canvas Network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/820-instructure.jpg", "humanURL"=>"http://instructure.com", "baseURL"=>"https://canvas.instructure.com//api/v1", "tags"=>"Audit,Grade,Change,Students,Student,Id", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/instructure/calendar-eventsidreservationsparticipant-id-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/instructure/instructure-canvas-calendar-events-api-openapi.yaml"}]}, {"name"=>"Instructure Canvas Conversations API", "x-api-slug"=>"instructure-canvas-conversations-api", "description"=>"Instructure makes software that makes smarter people. Products include Canvas LMS, Bridge and Canvas Network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/820-instructure.jpg", "humanURL"=>"http://instructure.com", "baseURL"=>"https://canvas.instructure.com//api/v1", "tags"=>"Calendar,Events,Id,Reservations,Participant,Id", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/instructure/conversationsidremove-messages-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/instructure/instructure-canvas-conversations-api-openapi.yaml"}]}, {"name"=>"Instructure Canvas Courses API", "x-api-slug"=>"instructure-canvas-courses-api", "description"=>"Instructure makes software that makes smarter people. Products include Canvas LMS, Bridge and Canvas Network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/820-instructure.jpg", "humanURL"=>"http://instructure.com", "baseURL"=>"https://canvas.instructure.com//api/v1", "tags"=>"Conversations,Id,Remove,Messages", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/instructure/coursesid-put-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/instructure/instructure-canvas-courses-api-openapi.yaml"}]}, {"name"=>"Instructure Canvas Global API", "x-api-slug"=>"instructure-canvas-global-api", "description"=>"Instructure makes software that makes smarter people. Products include Canvas LMS, Bridge and Canvas Network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/820-instructure.jpg", "humanURL"=>"http://instructure.com", "baseURL"=>"https://canvas.instructure.com//api/v1", "tags"=>"Courses,Id", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/instructure/globalroot-outcome-group-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/instructure/instructure-canvas-global-api-openapi.yaml"}]}, {"name"=>"Instructure Canvas Groups API", "x-api-slug"=>"instructure-canvas-groups-api", "description"=>"Instructure makes software that makes smarter people. Products include Canvas LMS, Bridge and Canvas Network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/820-instructure.jpg", "humanURL"=>"http://instructure.com", "baseURL"=>"https://canvas.instructure.com//api/v1", "tags"=>"Global,Root,Outcome,Group", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/instructure/group-categoriesgroup-category-idusers-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/instructure/instructure-canvas-groups-api-openapi.yaml"}]}, {"name"=>"Instructure Canvas Polls API", "x-api-slug"=>"instructure-canvas-polls-api", "description"=>"Instructure makes software that makes smarter people. Products include Canvas LMS, Bridge and Canvas Network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/820-instructure.jpg", "humanURL"=>"http://instructure.com", "baseURL"=>"https://canvas.instructure.com//api/v1", "tags"=>"Group,Categories,Group,Category,Id,Users", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/instructure/poll-sessionsopened-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/instructure/instructure-canvas-polls-api-openapi.yaml"}]}, {"name"=>"Instructure Canvas Quiz Submissions API", "x-api-slug"=>"instructure-canvas-quiz-submissions-api", "description"=>"Instructure makes software that makes smarter people. Products include Canvas LMS, Bridge and Canvas Network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/820-instructure.jpg", "humanURL"=>"http://instructure.com", "baseURL"=>"https://canvas.instructure.com//api/v1", "tags"=>"Poll,Sessions,Opened", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/instructure/quiz-submissionsquiz-submission-idquestionsidunflag-put-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/instructure/instructure-canvas-quiz-submissions-api-openapi.yaml"}]}, {"name"=>"Instructure Canvas Sections API", "x-api-slug"=>"instructure-canvas-sections-api", "description"=>"Instructure makes software that makes smarter people. Products include Canvas LMS, Bridge and Canvas Network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/820-instructure.jpg", "humanURL"=>"http://instructure.com", "baseURL"=>"https://canvas.instructure.com//api/v1", "tags"=>"Quiz,Submissions,Quiz,Submission,Id,Questions,Id,Unflag", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/instructure/sectionssection-idsubmissionsupdate-grades-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/instructure/instructure-canvas-sections-api-openapi.yaml"}]}, {"name"=>"Instructure Canvas Users API", "x-api-slug"=>"instructure-canvas-users-api", "description"=>"Instructure makes software that makes smarter people. Products include Canvas LMS, Bridge and Canvas Network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/820-instructure.jpg", "humanURL"=>"http://instructure.com", "baseURL"=>"https://canvas.instructure.com//api/v1", "tags"=>"Sections,Section,Id,Submissions,Update,Grades", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/instructure/usersuser-idusage-rights-put-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/instructure/instructure-canvas-users-api-openapi.yaml"}]}, {"name"=>"Instructure Canvas Utility APIs", "x-api-slug"=>"instructure-canvas-utility-apis", "description"=>"Instructure makes software that makes smarter people. Products include Canvas LMS, Bridge and Canvas Network.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/820-instructure.jpg", "humanURL"=>"http://instructure.com", "baseURL"=>"https://canvas.instructure.com//api/v1", "tags"=>"Users,User,Id,Usage,Rights", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/instructure/serviceskaltura-session-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/instructure/instructure-canvas-utility-apis-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://blog.instructure.com"}, {"type"=>"x-blog-rss", "url"=>"http://voice.instructure.com/CMS/UI/Modules/BizBlogger/rss.aspx?tabid=772438&moduleid=1638884&maxcount=25&t=415c2e5d197a4d6f7cdcc81385b677f1"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/instructure"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/instructure"}, {"type"=>"x-email", "url"=>"info@instructure.com"}, {"type"=>"x-email", "url"=>"jobs@instructure.com"}, {"type"=>"x-email", "url"=>"privacy@instructure.com"}, {"type"=>"x-email", "url"=>"legal@instructure.com"}, {"type"=>"x-github", "url"=>"https://github.com/instructure"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/instructure"}, {"type"=>"x-webhook", "url"=>"https://canvas.instructure.com/doc/api/webhooks_subscriptions.html"}, {"type"=>"x-website", "url"=>"http://instructure.com"}, {"type"=>"x-website", "url"=>"https://canvas.instructure.com/doc/api/index.html"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "instructure-canvas-quiz-submissions-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Instructure", "x-complete"=>1, "info"=>{"title"=>"Instructure Canvas Quiz Submissions API", "description"=>"canvas-lms-includes-a-rest-api-for-accessing-and-modifying-data-externally-from-the-main-application-in-your-own-programs-and-scripts--", "termsOfService"=>"https://www.canvaslms.com/policies/api-policy", "version"=>"v1"}, "host"=>"canvas.instructure.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/quiz_submissions/{quiz_submission_id}/questions"=>{"get"=>{"summary"=>"Get all quiz submission questions.", "description"=>"Get all quiz submission questions..", "operationId"=>"get-all-quiz-submission-questions", "x-api-path-slug"=>"quiz-submissionsquiz-submission-idquestions-get", "parameters"=>[{"in"=>"query", "name"=>"include[]", "description"=>"Associations to include with the quiz submission question"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Quiz", "Submissions", "Quiz", "Submission", "Id", "Questions"]}, "post"=>{"summary"=>"Answering questions", "description"=>"Answering questions.", "operationId"=>"answering-questions", "x-api-path-slug"=>"quiz-submissionsquiz-submission-idquestions-post", "parameters"=>[{"in"=>"query", "name"=>"access_code", "description"=>"Access code for the Quiz, if any"}, {"in"=>"query", "name"=>"attempt", "description"=>"The attempt number of the quiz submission being taken"}, {"in"=>"query", "name"=>"quiz_questions[]", "description"=>"Set of question IDs and the answer value"}, {"in"=>"query", "name"=>"validation_token", "description"=>"The unique validation token you received when the Quiz Submission wasncreated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Quiz", "Submissions", "Quiz", "Submission", "Id", "Questions"]}}, "/quiz_submissions/{quiz_submission_id}/questions/id/flag"=>{"put"=>{"summary"=>"Flagging a question.", "description"=>"Flagging a question..", "operationId"=>"flagging-a-question", "x-api-path-slug"=>"quiz-submissionsquiz-submission-idquestionsidflag-put", "parameters"=>[{"in"=>"query", "name"=>"access_code", "description"=>"Access code for the Quiz, if any"}, {"in"=>"query", "name"=>"attempt", "description"=>"The attempt number of the quiz submission being taken"}, {"in"=>"query", "name"=>"validation_token", "description"=>"The unique validation token you received when the Quiz Submission wasncreated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Quiz", "Submissions", "Quiz", "Submission", "Id", "Questions", "Id", "Flag"]}}, "/quiz_submissions/{quiz_submission_id}/questions/id/unflag"=>{"put"=>{"summary"=>"Unflagging a question.", "description"=>"Unflagging a question..", "operationId"=>"unflagging-a-question", "x-api-path-slug"=>"quiz-submissionsquiz-submission-idquestionsidunflag-put", "parameters"=>[{"in"=>"query", "name"=>"access_code", "description"=>"Access code for the Quiz, if any"}, {"in"=>"query", "name"=>"attempt", "description"=>"The attempt number of the quiz submission being taken"}, {"in"=>"query", "name"=>"validation_token", "description"=>"The unique validation token you received when the Quiz Submission wasncreated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Quiz", "Submissions", "Quiz", "Submission", "Id", "Questions", "Id", "Unflag"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hsbc{"hsbc-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"HSBC", "x-complete"=>1, "info"=>{"title"=>"HSBC", "description"=>"this-is-an-openapi-definition-for-the-standard-set-of-open-banking-httpopenbankingapis-io-apis-for-hsbc-", "termsOfService"=>"https://www.openbanking.org.uk/open-licence/", "contact"=>{"name"=>"API Evangelist", "url"=>"https://apievangelist.com", "email"=>"info@apievangelist.com"}, "version"=>"1.0.0"}, "host"=>"api.hsbc.com", "basePath"=>"open-banking/v2.1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"atms/"=>{"get"=>{"summary"=>"Get ATMs", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can provide multiple ATMs.", "operationId"=>"getATMS", "x-api-path-slug"=>"atms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Atms"]}}, "branches/"=>{"get"=>{"summary"=>"Get Branches", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple branches.", "operationId"=>"getBranches", "x-api-path-slug"=>"branches-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branches"]}}, "personal-current-accounts/"=>{"get"=>{"summary"=>"Get Current Personal Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple PCA products.", "operationId"=>"getCurrentPersonalAccounts", "x-api-path-slug"=>"personalcurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Personal", "Current", "Accounts"]}}, "business-current-accounts/"=>{"get"=>{"summary"=>"Get Current Business Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple BCA products.", "operationId"=>"getCurentBusinessAccounts", "x-api-path-slug"=>"businesscurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Business", "Current", "Accounts"]}}, "unsecured-sme-loans/"=>{"get"=>{"summary"=>"Get Unsecured SME Loans", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Unsecured Loan products.", "operationId"=>"pathOperation", "x-api-path-slug"=>"unsecuredsmeloans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsecured", "Sme", "Loans"]}}, "commercial-credit-cards/"=>{"get"=>{"summary"=>"Get Commercial Credit Cards", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Commercial Credit Card products.", "operationId"=>"getCommercialCreditCards", "x-api-path-slug"=>"commercialcreditcards-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commercial", "Credit", "Cards"]}}}}, "apis"=>{"name"=>"HSBC", "x-slug"=>"hsbc", "description"=>"HSBC Holdings plc is a British multinational banking and financial services holding company, tracing its origin to a hong in Hong Kong. It is the worlds seventh largest bank by total assets and the largest in Europe with total assets of US$2.374 trillion (as of December 2016). It was established in its present form in London in 1991 by The Hongkong and Shanghai Banking Corporation to act as a new group holding company. The origins of the bank lie mainly in Hong Kong and to a lesser extent in Shanghai, where branches were first opened in 1865. The HSBC name is derived from the initials of the Hongkong and Shanghai Banking Corporation. The company was first formally incorporated in 1866. The company continues to see both the United Kingdom and Hong Kong as its home markets.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/HSBC-Logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"8074", "tags"=>"API Provider,ATMs,Banking,Financial Services,General Data,Profiles,Relative Data,UK Banks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"hsbc/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"HSBC", "x-api-slug"=>"hsbc", "description"=>"HSBC Holdings plc is a British multinational banking and financial services holding company, tracing its origin to a hong in Hong Kong. It is the worlds seventh largest bank by total assets and the largest in Europe with total assets of US$2.374 trillion (as of December 2016). It was established in its present form in London in 1991 by The Hongkong and Shanghai Banking Corporation to act as a new group holding company. The origins of the bank lie mainly in Hong Kong and to a lesser extent in Shanghai, where branches were first opened in 1865. The HSBC name is derived from the initials of the Hongkong and Shanghai Banking Corporation. The company was first formally incorporated in 1866. The company continues to see both the United Kingdom and Hong Kong as its home markets.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/HSBC-Logo.png", "humanURL"=>"https://hsbc.com", "baseURL"=>"https://api.hsbc.com/open-banking/v2.1/", "tags"=>"API Provider,ATMs,Banking,Financial Services,General Data,Profiles,Relative Data,UK Banks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/hsbc/commercialcreditcards-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/hsbc/hsbc-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/hsbc"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/HSBC"}, {"type"=>"x-developer", "url"=>"https://developer.hsbc.com"}, {"type"=>"x-website", "url"=>"https://hsbc.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-drive{"google-drive-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Drive", "x-complete"=>1, "info"=>{"title"=>"Google Drive", "description"=>"manages-files-in-drive-including-uploading-downloading-searching-detecting-changes-and-updating-sharing-permissions-", "termsOfService"=>"https://developers.google.com/terms/", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v3"}, "host"=>"www.googleapis.com", "basePath"=>"/drive/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/about"=>{"get"=>{"summary"=>"Get About", "description"=>"Gets information about the user, the user's Drive, and system capabilities.", "operationId"=>"drive.about.get", "x-api-path-slug"=>"about-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["About"]}}, "/changes"=>{"get"=>{"summary"=>"Get Changes", "description"=>"Lists the changes for a user or Team Drive.", "operationId"=>"drive.changes.list", "x-api-path-slug"=>"changes-get", "parameters"=>[{"in"=>"query", "name"=>"includeCorpusRemovals", "description"=>"Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file"}, {"in"=>"query", "name"=>"includeRemoved", "description"=>"Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access"}, {"in"=>"query", "name"=>"includeTeamDriveItems", "description"=>"Whether Team Drive files or changes should be included in results"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of changes to return per page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token for continuing a previous list request on the next page"}, {"in"=>"query", "name"=>"restrictToMyDrive", "description"=>"Whether to restrict the results to changes inside the My Drive hierarchy"}, {"in"=>"query", "name"=>"spaces", "description"=>"A comma-separated list of spaces to query within the user corpus"}, {"in"=>"query", "name"=>"supportsTeamDrives", "description"=>"Whether the requesting application supports Team Drives"}, {"in"=>"query", "name"=>"teamDriveId", "description"=>"The Team Drive from which changes will be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change"]}}, "/changes/startPageToken"=>{"get"=>{"summary"=>"Get Start Page Token Changes", "description"=>"Gets the starting pageToken for listing future changes.", "operationId"=>"drive.changes.getStartPageToken", "x-api-path-slug"=>"changesstartpagetoken-get", "parameters"=>[{"in"=>"query", "name"=>"supportsTeamDrives", "description"=>"Whether the requesting application supports Team Drives"}, {"in"=>"query", "name"=>"teamDriveId", "description"=>"The ID of the Team Drive for which the starting pageToken for listing future changes from that Team Drive will be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change"]}}, "/changes/watch"=>{"post"=>{"summary"=>"Watch Changes", "description"=>"Subscribes to changes for a user.", "operationId"=>"drive.changes.watch", "x-api-path-slug"=>"changeswatch-post", "parameters"=>[{"in"=>"query", "name"=>"includeCorpusRemovals", "description"=>"Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file"}, {"in"=>"query", "name"=>"includeRemoved", "description"=>"Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access"}, {"in"=>"query", "name"=>"includeTeamDriveItems", "description"=>"Whether Team Drive files or changes should be included in results"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of changes to return per page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token for continuing a previous list request on the next page"}, {"in"=>"body", "name"=>"resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"restrictToMyDrive", "description"=>"Whether to restrict the results to changes inside the My Drive hierarchy"}, {"in"=>"query", "name"=>"spaces", "description"=>"A comma-separated list of spaces to query within the user corpus"}, {"in"=>"query", "name"=>"supportsTeamDrives", "description"=>"Whether the requesting application supports Team Drives"}, {"in"=>"query", "name"=>"teamDriveId", "description"=>"The Team Drive from which changes will be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change"]}}, "/channels/stop"=>{"post"=>{"summary"=>"Stop Watching Changes", "description"=>"Stop watching resources through this channel", "operationId"=>"drive.channels.stop", "x-api-path-slug"=>"channelsstop-post", "parameters"=>[{"in"=>"body", "name"=>"resource", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change"]}}, "/files"=>{"get"=>{"summary"=>"Get Files", "description"=>"Lists or searches files.", "operationId"=>"drive.files.list", "x-api-path-slug"=>"files-get", "parameters"=>[{"in"=>"query", "name"=>"corpora", "description"=>"Comma-separated list of bodies of items (files/documents) to which the query applies"}, {"in"=>"query", "name"=>"corpus", "description"=>"The source of files to list"}, {"in"=>"query", "name"=>"includeTeamDriveItems", "description"=>"Whether Team Drive items should be included in results"}, {"in"=>"query", "name"=>"orderBy", "description"=>"A comma-separated list of sort keys"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of files to return per page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token for continuing a previous list request on the next page"}, {"in"=>"query", "name"=>"q", "description"=>"A query for filtering the file results"}, {"in"=>"query", "name"=>"spaces", "description"=>"A comma-separated list of spaces to query within the corpus"}, {"in"=>"query", "name"=>"supportsTeamDrives", "description"=>"Whether the requesting application supports Team Drives"}, {"in"=>"query", "name"=>"teamDriveId", "description"=>"ID of Team Drive to search"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}, "post"=>{"summary"=>"Create File", "description"=>"Creates a new file.", "operationId"=>"drive.files.create", "x-api-path-slug"=>"files-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"ignoreDefaultVisibility", "description"=>"Whether to ignore the domains default visibility settings for the created file"}, {"in"=>"query", "name"=>"keepRevisionForever", "description"=>"Whether to set the keepForever field in the new head revision"}, {"in"=>"query", "name"=>"ocrLanguage", "description"=>"A language hint for OCR processing during image import (ISO 639-1 code)"}, {"in"=>"query", "name"=>"supportsTeamDrives", "description"=>"Whether the requesting application supports Team Drives"}, {"in"=>"query", "name"=>"useContentAsIndexableText", "description"=>"Whether to use the uploaded content as indexable text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}}, "/files/generateIds"=>{"get"=>{"summary"=>"Generate File IDs", "description"=>"Generates a set of file IDs which can be provided in create requests.", "operationId"=>"drive.files.generateIds", "x-api-path-slug"=>"filesgenerateids-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"The number of IDs to return"}, {"in"=>"query", "name"=>"space", "description"=>"The space in which the IDs can be used to create new files"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}}, "/files/trash"=>{"delete"=>{"summary"=>"Empty Trash", "description"=>"Permanently deletes all of the user's trashed files.", "operationId"=>"drive.files.emptyTrash", "x-api-path-slug"=>"filestrash-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}}, "/files/{fileId}"=>{"delete"=>{"summary"=>"Delete File", "description"=>"Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a Team Drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted.", "operationId"=>"drive.files.delete", "x-api-path-slug"=>"filesfileid-delete", "parameters"=>[{"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"query", "name"=>"supportsTeamDrives", "description"=>"Whether the requesting application supports Team Drives"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}, "get"=>{"summary"=>"Get File", "description"=>"Gets a file's metadata or content by ID.", "operationId"=>"drive.files.get", "x-api-path-slug"=>"filesfileid-get", "parameters"=>[{"in"=>"query", "name"=>"acknowledgeAbuse", "description"=>"Whether the user is acknowledging the risk of downloading known malware or other abusive files"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"query", "name"=>"supportsTeamDrives", "description"=>"Whether the requesting application supports Team Drives"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}, "patch"=>{"summary"=>"Update File", "description"=>"Updates a file's metadata and/or content with patch semantics.", "operationId"=>"drive.files.update", "x-api-path-slug"=>"filesfileid-patch", "parameters"=>[{"in"=>"query", "name"=>"addParents", "description"=>"A comma-separated list of parent IDs to add"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"query", "name"=>"keepRevisionForever", "description"=>"Whether to set the keepForever field in the new head revision"}, {"in"=>"query", "name"=>"ocrLanguage", "description"=>"A language hint for OCR processing during image import (ISO 639-1 code)"}, {"in"=>"query", "name"=>"removeParents", "description"=>"A comma-separated list of parent IDs to remove"}, {"in"=>"query", "name"=>"supportsTeamDrives", "description"=>"Whether the requesting application supports Team Drives"}, {"in"=>"query", "name"=>"useContentAsIndexableText", "description"=>"Whether to use the uploaded content as indexable text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}}, "/files/{fileId}/comments"=>{"get"=>{"summary"=>"Get File Comments", "description"=>"Lists a file's comments.", "operationId"=>"drive.comments.list", "x-api-path-slug"=>"filesfileidcomments-get", "parameters"=>[{"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"query", "name"=>"includeDeleted", "description"=>"Whether to include deleted comments"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of comments to return per page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token for continuing a previous list request on the next page"}, {"in"=>"query", "name"=>"startModifiedTime", "description"=>"The minimum value of modifiedTime for the result comments (RFC 3339 date-time)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment"]}, "post"=>{"summary"=>"Create File Comment", "description"=>"Creates a new comment on a file.", "operationId"=>"drive.comments.create", "x-api-path-slug"=>"filesfileidcomments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment"]}}, "/files/{fileId}/comments/{commentId}"=>{"delete"=>{"summary"=>"Delete File Comment", "description"=>"Deletes a comment.", "operationId"=>"drive.comments.delete", "x-api-path-slug"=>"filesfileidcommentscommentid-delete", "parameters"=>[{"in"=>"path", "name"=>"commentId", "description"=>"The ID of the comment"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment"]}, "get"=>{"summary"=>"Get File Comment", "description"=>"Gets a comment by ID.", "operationId"=>"drive.comments.get", "x-api-path-slug"=>"filesfileidcommentscommentid-get", "parameters"=>[{"in"=>"path", "name"=>"commentId", "description"=>"The ID of the comment"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"query", "name"=>"includeDeleted", "description"=>"Whether to return deleted comments"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment"]}, "patch"=>{"summary"=>"Update File Comment", "description"=>"Updates a comment with patch semantics.", "operationId"=>"drive.comments.update", "x-api-path-slug"=>"filesfileidcommentscommentid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"commentId", "description"=>"The ID of the comment"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment"]}}, "/files/{fileId}/comments/{commentId}/replies"=>{"get"=>{"summary"=>"Get File Comment Replies", "description"=>"Lists a comment's replies.", "operationId"=>"drive.replies.list", "x-api-path-slug"=>"filesfileidcommentscommentidreplies-get", "parameters"=>[{"in"=>"path", "name"=>"commentId", "description"=>"The ID of the comment"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"query", "name"=>"includeDeleted", "description"=>"Whether to include deleted replies"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of replies to return per page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token for continuing a previous list request on the next page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment"]}, "post"=>{"summary"=>"Create File Comment Reply", "description"=>"Creates a new reply to a comment.", "operationId"=>"drive.replies.create", "x-api-path-slug"=>"filesfileidcommentscommentidreplies-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"commentId", "description"=>"The ID of the comment"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment"]}}, "/files/{fileId}/comments/{commentId}/replies/{replyId}"=>{"delete"=>{"summary"=>"Delete File Comment Reply", "description"=>"Deletes a reply.", "operationId"=>"drive.replies.delete", "x-api-path-slug"=>"filesfileidcommentscommentidrepliesreplyid-delete", "parameters"=>[{"in"=>"path", "name"=>"commentId", "description"=>"The ID of the comment"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"path", "name"=>"replyId", "description"=>"The ID of the reply"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment"]}, "get"=>{"summary"=>"Get File Comment Reply", "description"=>"Gets a reply by ID.", "operationId"=>"drive.replies.get", "x-api-path-slug"=>"filesfileidcommentscommentidrepliesreplyid-get", "parameters"=>[{"in"=>"path", "name"=>"commentId", "description"=>"The ID of the comment"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"query", "name"=>"includeDeleted", "description"=>"Whether to return deleted replies"}, {"in"=>"path", "name"=>"replyId", "description"=>"The ID of the reply"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment"]}, "patch"=>{"summary"=>"Update File Comment Reply", "description"=>"Updates a reply with patch semantics.", "operationId"=>"drive.replies.update", "x-api-path-slug"=>"filesfileidcommentscommentidrepliesreplyid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"commentId", "description"=>"The ID of the comment"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"path", "name"=>"replyId", "description"=>"The ID of the reply"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment"]}}, "/files/{fileId}/copy"=>{"post"=>{"summary"=>"Copy File", "description"=>"Creates a copy of a file and applies any requested updates with patch semantics.", "operationId"=>"drive.files.copy", "x-api-path-slug"=>"filesfileidcopy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"query", "name"=>"ignoreDefaultVisibility", "description"=>"Whether to ignore the domains default visibility settings for the created file"}, {"in"=>"query", "name"=>"keepRevisionForever", "description"=>"Whether to set the keepForever field in the new head revision"}, {"in"=>"query", "name"=>"ocrLanguage", "description"=>"A language hint for OCR processing during image import (ISO 639-1 code)"}, {"in"=>"query", "name"=>"supportsTeamDrives", "description"=>"Whether the requesting application supports Team Drives"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}}, "/files/{fileId}/export"=>{"get"=>{"summary"=>"Export File", "description"=>"Exports a Google Doc to the requested MIME type and returns the exported content.", "operationId"=>"drive.files.export", "x-api-path-slug"=>"filesfileidexport-get", "parameters"=>[{"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"query", "name"=>"mimeType", "description"=>"The MIME type of the format requested for this export"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}}, "/files/{fileId}/permissions"=>{"get"=>{"summary"=>"Get File Permissions", "description"=>"Lists a file's or Team Drive's permissions.", "operationId"=>"drive.permissions.list", "x-api-path-slug"=>"filesfileidpermissions-get", "parameters"=>[{"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file or Team Drive"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of permissions to return per page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token for continuing a previous list request on the next page"}, {"in"=>"query", "name"=>"supportsTeamDrives", "description"=>"Whether the requesting application supports Team Drives"}, {"in"=>"query", "name"=>"useDomainAdminAccess", "description"=>"Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}, "post"=>{"summary"=>"Create File Permission", "description"=>"Creates a permission for a file or Team Drive.", "operationId"=>"drive.permissions.create", "x-api-path-slug"=>"filesfileidpermissions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"emailMessage", "description"=>"A custom message to include in the notification email"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file or Team Drive"}, {"in"=>"query", "name"=>"sendNotificationEmail", "description"=>"Whether to send a notification email when sharing to users or groups"}, {"in"=>"query", "name"=>"supportsTeamDrives", "description"=>"Whether the requesting application supports Team Drives"}, {"in"=>"query", "name"=>"transferOwnership", "description"=>"Whether to transfer ownership to the specified user and downgrade the current owner to a writer"}, {"in"=>"query", "name"=>"useDomainAdminAccess", "description"=>"Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}}, "/files/{fileId}/permissions/{permissionId}"=>{"delete"=>{"summary"=>"Delete File Permission", "description"=>"Deletes a permission.", "operationId"=>"drive.permissions.delete", "x-api-path-slug"=>"filesfileidpermissionspermissionid-delete", "parameters"=>[{"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file or Team Drive"}, {"in"=>"path", "name"=>"permissionId", "description"=>"The ID of the permission"}, {"in"=>"query", "name"=>"supportsTeamDrives", "description"=>"Whether the requesting application supports Team Drives"}, {"in"=>"query", "name"=>"useDomainAdminAccess", "description"=>"Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}, "get"=>{"summary"=>"Get File Permission", "description"=>"Gets a permission by ID.", "operationId"=>"drive.permissions.get", "x-api-path-slug"=>"filesfileidpermissionspermissionid-get", "parameters"=>[{"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"path", "name"=>"permissionId", "description"=>"The ID of the permission"}, {"in"=>"query", "name"=>"supportsTeamDrives", "description"=>"Whether the requesting application supports Team Drives"}, {"in"=>"query", "name"=>"useDomainAdminAccess", "description"=>"Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}, "patch"=>{"summary"=>"Update File Permission", "description"=>"Updates a permission with patch semantics.", "operationId"=>"drive.permissions.update", "x-api-path-slug"=>"filesfileidpermissionspermissionid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file or Team Drive"}, {"in"=>"path", "name"=>"permissionId", "description"=>"The ID of the permission"}, {"in"=>"query", "name"=>"removeExpiration", "description"=>"Whether to remove the expiration date"}, {"in"=>"query", "name"=>"supportsTeamDrives", "description"=>"Whether the requesting application supports Team Drives"}, {"in"=>"query", "name"=>"transferOwnership", "description"=>"Whether to transfer ownership to the specified user and downgrade the current owner to a writer"}, {"in"=>"query", "name"=>"useDomainAdminAccess", "description"=>"Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}}, "/files/{fileId}/revisions"=>{"get"=>{"summary"=>"Get File Revisions", "description"=>"Lists a file's revisions.", "operationId"=>"drive.revisions.list", "x-api-path-slug"=>"filesfileidrevisions-get", "parameters"=>[{"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The maximum number of revisions to return per page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token for continuing a previous list request on the next page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Revision"]}}, "/files/{fileId}/revisions/{revisionId}"=>{"delete"=>{"summary"=>"Delete File Revision", "description"=>"Permanently deletes a revision. This method is only applicable to files with binary content in Drive.", "operationId"=>"drive.revisions.delete", "x-api-path-slug"=>"filesfileidrevisionsrevisionid-delete", "parameters"=>[{"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"path", "name"=>"revisionId", "description"=>"The ID of the revision"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Revision"]}, "get"=>{"summary"=>"Get File Revision", "description"=>"Gets a revision's metadata or content by ID.", "operationId"=>"drive.revisions.get", "x-api-path-slug"=>"filesfileidrevisionsrevisionid-get", "parameters"=>[{"in"=>"query", "name"=>"acknowledgeAbuse", "description"=>"Whether the user is acknowledging the risk of downloading known malware or other abusive files"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"path", "name"=>"revisionId", "description"=>"The ID of the revision"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Revision"]}, "patch"=>{"summary"=>"Update File Revision", "description"=>"Updates a revision with patch semantics.", "operationId"=>"drive.revisions.update", "x-api-path-slug"=>"filesfileidrevisionsrevisionid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"path", "name"=>"revisionId", "description"=>"The ID of the revision"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Revision"]}}, "/files/{fileId}/watch"=>{"post"=>{"summary"=>"Watch File", "description"=>"Subscribes to changes to a file", "operationId"=>"drive.files.watch", "x-api-path-slug"=>"filesfileidwatch-post", "parameters"=>[{"in"=>"query", "name"=>"acknowledgeAbuse", "description"=>"Whether the user is acknowledging the risk of downloading known malware or other abusive files"}, {"in"=>"path", "name"=>"fileId", "description"=>"The ID of the file"}, {"in"=>"body", "name"=>"resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"supportsTeamDrives", "description"=>"Whether the requesting application supports Team Drives"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}}, "/teamdrives"=>{"get"=>{"summary"=>"Get Team Drives", "description"=>"Lists the user's Team Drives.", "operationId"=>"drive.teamdrives.list", "x-api-path-slug"=>"teamdrives-get", "parameters"=>[{"in"=>"query", "name"=>"pageSize", "description"=>"Maximum number of Team Drives to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Page token for Team Drives"}, {"in"=>"query", "name"=>"q", "description"=>"Query string for searching Team Drives"}, {"in"=>"query", "name"=>"useDomainAdminAccess", "description"=>"Whether the request should be treated as if it was issued by a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team Drive"]}, "post"=>{"summary"=>"Create Team Drive", "description"=>"Creates a new Team Drive.", "operationId"=>"drive.teamdrives.create", "x-api-path-slug"=>"teamdrives-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"requestId", "description"=>"An ID, such as a random UUID, which uniquely identifies this users request for idempotent creation of a Team Drive"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team Drive"]}}, "/teamdrives/{teamDriveId}"=>{"delete"=>{"summary"=>"Delete Team Drive", "description"=>"Permanently deletes a Team Drive for which the user is an organizer. The Team Drive cannot contain any untrashed items.", "operationId"=>"drive.teamdrives.delete", "x-api-path-slug"=>"teamdrivesteamdriveid-delete", "parameters"=>[{"in"=>"path", "name"=>"teamDriveId", "description"=>"The ID of the Team Drive"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team Drive"]}, "get"=>{"summary"=>"CrGeteate Team Drive", "description"=>"Gets a Team Drive's metadata by ID.", "operationId"=>"drive.teamdrives.get", "x-api-path-slug"=>"teamdrivesteamdriveid-get", "parameters"=>[{"in"=>"path", "name"=>"teamDriveId", "description"=>"The ID of the Team Drive"}, {"in"=>"query", "name"=>"useDomainAdminAccess", "description"=>"Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team Drive"]}, "patch"=>{"summary"=>"Update Team Drive", "description"=>"Updates a Team Drive's metadata", "operationId"=>"drive.teamdrives.update", "x-api-path-slug"=>"teamdrivesteamdriveid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"teamDriveId", "description"=>"The ID of the Team Drive"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team Drive"]}}}}, "apis"=>{"name"=>"Google Drive", "x-slug"=>"google-drive", "description"=>"Google Drive is a file storage and synchronization service operated by Google. It allows users to store files in the cloud, synchronize files across devices, and share files. Google Drive encompasses Google Docs, Sheets and Slides, an office suite that permits collaborative editing of documents, spreadsheets, presentations, drawings, forms, and more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-drive-logo-new.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Documents,Google APIs,Productivity,Profiles,Relative Data,Service API,Stack,Stack Network,Storage", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-drive/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Drive", "x-api-slug"=>"google-drive", "description"=>"Google Drive is a file storage and synchronization service operated by Google. It allows users to store files in the cloud, synchronize files across devices, and share files. Google Drive encompasses Google Docs, Sheets and Slides, an office suite that permits collaborative editing of documents, spreadsheets, presentations, drawings, forms, and more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-drive-logo-new.png", "humanURL"=>"https://developers.google.com/drive/", "baseURL"=>"https://www.googleapis.com//drive/v3", "tags"=>"API Provider,API Service Provider,Documents,Google APIs,Productivity,Profiles,Relative Data,Service API,Stack,Stack Network,Storage", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-drive/google-drive-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-best-practices", "url"=>"https://developers.google.com/drive/v3/web/practices"}, {"type"=>"x-branding-guidelines", "url"=>"https://developers.google.com/drive/v3/web/marketing"}, {"type"=>"x-change-log", "url"=>"https://developers.google.com/drive/release-notes"}, {"type"=>"x-code", "url"=>"https://developers.google.com/drive/v3/web/downloads"}, {"type"=>"x-documentation", "url"=>"https://developers.google.com/drive/v3/web/about-sdk"}, {"type"=>"x-github", "url"=>"https://github.com/googledrive"}, {"type"=>"x-issues", "url"=>"https://code.google.com/a/google.com/p/apps-api-issues/issues/list?q=API%3DDrive"}, {"type"=>"x-performance", "url"=>"https://developers.google.com/drive/v3/web/performance"}, {"type"=>"x-support", "url"=>"https://developers.google.com/drive/v3/web/support"}, {"type"=>"x-website", "url"=>"https://developers.google.com/drive/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
server-density{"widgets-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Server Density", "x-complete"=>1, "info"=>{"title"=>"Widgets API", "description"=>"the-widgets-api-", "version"=>"1.0.0"}, "host"=>"api.serverdensity.io.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/users/widgets/widgetId"=>{""=>{"summary"=>"Deleting a widget", "description"=>"Deleting a widget.", "operationId"=>"deleting-a-widget", "x-api-path-slug"=>"userswidgetswidgetid-", "parameters"=>[{"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"body", "name"=>"token", "description"=>"Your API token", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"widgetId", "description"=>"The ID of the widget to delete", "type"=>"string"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Widgets"]}}, "/users/widgets/duplicate/widgetId"=>{""=>{"summary"=>"Duplicating a widget", "description"=>"Duplicating a widget.", "operationId"=>"duplicating-a-widget", "x-api-path-slug"=>"userswidgetsduplicatewidgetid-", "parameters"=>[{"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"body", "name"=>"token", "description"=>"Your API token", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"widgetId", "description"=>"ID of the widget to duplicate", "type"=>"string"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Widgets"]}}}}, "service-status-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Server Density", "x-complete"=>1, "info"=>{"title"=>"Service Status API", "description"=>"the-service-status-api-", "version"=>"1.0.0"}, "host"=>"api.serverdensity.io.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/alerts/service_alerts.json"=>{""=>{"summary"=>"Listing service alert metrics", "description"=>"Devices and services have different alert metrics which you can configure in the ui. The section correspond to the top-level of the alert metric whereas field corresponds to the subsection of the given section.", "operationId"=>"listing-service-alert-metrics", "x-api-path-slug"=>"alertsservice-alerts-json-", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Alerts"]}}, "/service-monitor/last/serviceId"=>{""=>{"summary"=>"Location service status (last)", "description"=>"Get the current results from a service check.", "operationId"=>"location-service-status-last", "x-api-path-slug"=>"servicemonitorlastserviceid-", "parameters"=>[{"in"=>"path", "name"=>"serviceId", "description"=>"The ID of the service to retrieve the details for", "type"=>"string"}, {"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Service Monitor"]}}}}, "tokens-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Server Density", "x-complete"=>1, "info"=>{"title"=>"Tokens API", "description"=>"the-tokens-api-", "version"=>"1.0.0"}, "host"=>"api.serverdensity.io.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/tokens"=>{""=>{"summary"=>"Getting a token via the API", "description"=>"If you need to generate tokens programmatically, you can request a token through the API with your username and password. All future requests can then be performed using the returned token.\nIf the user generating the token has Multi Factor Authentication enabled, you cannot use this method and must create the token via the web UI.", "operationId"=>"getting-a-token-via-the-api", "x-api-path-slug"=>"tokens-", "parameters"=>[{"in"=>"body", "name"=>"accountName", "description"=>"The Server Density account that the user is a member of e", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"password", "description"=>"The token will be associated with this password", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"tokenName", "description"=>"The name of the token, displayed in the UI", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"username", "description"=>"The token will be associated with this username", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Tokens"]}}, "/tokens/"=>{""=>{"summary"=>"Create a token", "description"=>"Create a token.", "operationId"=>"create-a-token", "x-api-path-slug"=>"tokens-", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"query", "name"=>"tokenName", "description"=>"The name of your new token", "type"=>"string"}, {"in"=>"body", "name"=>"tokenName", "description"=>"The name of your new token", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Tokens"]}}, "/tokens/tokenId"=>{""=>{"summary"=>"Delete a token", "description"=>"Delete a token.", "operationId"=>"delete-a-token", "x-api-path-slug"=>"tokenstokenid-", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"query", "name"=>"tokenId", "description"=>"The token you wish to delete", "type"=>"string"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Tokens"]}}}}, "dashboards-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Server Density", "x-complete"=>1, "info"=>{"title"=>"Dashboards API", "description"=>"the-dashboards-api-", "version"=>"1.0.0"}, "host"=>"api.serverdensity.io.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/users/dashboards/dashboardId"=>{""=>{"summary"=>"Deleting a dashboard", "description"=>"Deleting a dashboard.", "operationId"=>"deleting-a-dashboard", "x-api-path-slug"=>"usersdashboardsdashboardid-", "parameters"=>[{"in"=>"path", "name"=>"dashboardId", "description"=>"ID of the dashboard to delete", "type"=>"string"}, {"in"=>"path", "name"=>"layout", "description"=>"Dictionary with the ids of the widgets from this dashboard as keys", "type"=>"string"}, {"in"=>"body", "name"=>"layout", "description"=>"Dictionary with the ids of the widgets from this dashboard as keys", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"Name of the dashboard", "type"=>"string"}, {"in"=>"body", "name"=>"name", "description"=>"Name of the dashboard", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"body", "name"=>"token", "description"=>"Your API token", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Dashboards"]}}, "/users/dashboards/duplicate/dasboardId"=>{""=>{"summary"=>"Duplicating a dashboard", "description"=>"Duplicating a dashboard.", "operationId"=>"duplicating-a-dashboard", "x-api-path-slug"=>"usersdashboardsduplicatedasboardid-", "parameters"=>[{"in"=>"body", "name"=>"dashboardId", "description"=>"ID of the dashboard to duplicate", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"new_name", "description"=>"Name of the new, duplicated dashboard", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"token", "description"=>"Your API token", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Dashboards"]}}}}, "devices-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Server Density", "x-complete"=>1, "info"=>{"title"=>"Devices API", "description"=>"the-devices-api-", "version"=>"1.0.0"}, "host"=>"api.serverdensity.io.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/inventory/devices"=>{""=>{"summary"=>"Creating a device", "description"=>"You can create new devices via the API, useful if you want to automatically provision new devices and start monitoring automatically.\nThis API method is used by our Puppet manifest, Chef cookbook and installer shell script to automatically create devices during the agent installation.", "operationId"=>"creating-a-device", "x-api-path-slug"=>"inventorydevices-", "parameters"=>[{"in"=>"body", "name"=>"cpuCores", "description"=>"Item???s number of cores", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"group", "description"=>"Name of group", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"hostname", "description"=>"Device???s hostname", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"installedRAM", "description"=>"RAM installed", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"location", "description"=>"A dictionary containing countryCode, text (which is the city) and countryName", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"name", "description"=>"Name of device", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"os", "description"=>"A dictionary containing code and name", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"privateIPs", "description"=>"Item???s private IP addresses as a JSON encoded list", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"provider", "description"=>"The provider dependent string that identifies this item", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"publicIPs", "description"=>"Item???s public IP addresses as a JSON encoded list", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"swapSpace", "description"=>"Item???s swap space", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"tags", "description"=>"A JSON list of tag IDs", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"token", "description"=>"Your API token", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Devices"]}}, "/inventory/devices/deviceId"=>{""=>{"summary"=>"Updating a device", "description"=>"Update a device and the associated metadata.", "operationId"=>"updating-a-device", "x-api-path-slug"=>"inventorydevicesdeviceid-", "parameters"=>[{"in"=>"path", "name"=>"cpuCores", "description"=>"Item???s number of cores", "type"=>"string"}, {"in"=>"body", "name"=>"cpuCores", "description"=>"Item???s number of cores", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"deviceId", "description"=>"The ID of the device to update", "type"=>"string"}, {"in"=>"path", "name"=>"group", "description"=>"Name of group", "type"=>"string"}, {"in"=>"body", "name"=>"group", "description"=>"Name of group", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"hostname", "description"=>"Item???s hostname", "type"=>"string"}, {"in"=>"body", "name"=>"hostname", "description"=>"Item???s hostname", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"installedRAM", "description"=>"RAM installed", "type"=>"string"}, {"in"=>"body", "name"=>"installedRAM", "description"=>"RAM installed", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"Name of the device", "type"=>"string"}, {"in"=>"body", "name"=>"name", "description"=>"Name of the device", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"os", "description"=>"Operating system that it runs", "type"=>"string"}, {"in"=>"body", "name"=>"os", "description"=>"Operating system that it runs", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"privateIPs", "description"=>"Item???s private IP addresses as a JSON encoded list", "type"=>"string"}, {"in"=>"body", "name"=>"privateIPs", "description"=>"Item???s private IP addresses as a JSON encoded list", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"provider", "description"=>"Provider where the item is hosted", "type"=>"string"}, {"in"=>"body", "name"=>"provider", "description"=>"Provider where the item is hosted", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"providerId", "description"=>"The provider dependent string that identifies this item", "type"=>"string"}, {"in"=>"body", "name"=>"providerId", "description"=>"The provider dependent string that identifies this item", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"publicIPs", "description"=>"Item???s public IP addresss as a JSON encoded list", "type"=>"string"}, {"in"=>"body", "name"=>"publicIPs", "description"=>"Item???s public IP addresss as a JSON encoded list", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"swapSpace", "description"=>"Item???s swap space", "type"=>"string"}, {"in"=>"body", "name"=>"swapSpace", "description"=>"Item???s swap space", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tags", "description"=>"A JSON list of tag IDs", "type"=>"string"}, {"in"=>"body", "name"=>"tags", "description"=>"A JSON list of tag IDs", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"body", "name"=>"token", "description"=>"Your API token", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Devices"]}}, "/inventory/devices/agentKey/byagentkey"=>{""=>{"summary"=>"View device by agent key", "description"=>"View device by agent key.", "operationId"=>"view-device-by-agent-key", "x-api-path-slug"=>"inventorydevicesagentkeybyagentkey-", "parameters"=>[{"in"=>"path", "name"=>"agentKey", "description"=>"The key used by the agent", "type"=>"string"}, {"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Devices"]}}}}, "alerts-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Server Density", "x-complete"=>1, "info"=>{"title"=>"Alerts API", "description"=>"the-alerts-api-", "version"=>"1.0.0"}, "host"=>"api.serverdensity.io.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/alerts?check_id={check_id}&severity={severity}&enabled={enabled}&target_type={target_type}&target_id={target_id} "=>{" get "=>{"summary"=>"Alerts", "description"=>"Gets alerts filtered by set of optional parameters.", "operationId"=>"-alertscheck-idcheck-idampseverityseverityampenabledenabledamptarget-typetarget-typeamptarget-idtarg", "x-api-path-slug"=>"alertscheck-idcheck-idampseverityseverityampenabledenabledamptarget-typetarget-typeamptarget-idtarget-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/{alert_id} "=>{" get "=>{"summary"=>"Alerts", "description"=>"Gets alert by Id.", "operationId"=>"-alerts-alert-id-", "x-api-path-slug"=>"alertsalert-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}, " put "=>{"summary"=>"Alerts", "description"=>"Updates alert.", "operationId"=>"-alerts-alert-id-", "x-api-path-slug"=>"alertsalert-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}, " delete "=>{"summary"=>"Alerts", "description"=>"Deletes alert by Id.", "operationId"=>"-alerts-alert-id-", "x-api-path-slug"=>"alertsalert-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/{alert_type} "=>{" post "=>{"summary"=>"Alerts", "description"=>"Creates a new alert.", "operationId"=>"-alerts-alert-type-", "x-api-path-slug"=>"alertsalert-type-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/recipients "=>{" get "=>{"summary"=>"Alerts Recipients", "description"=>"Gets a list of all alert recipient's targets that are visible to you as a customer.", "operationId"=>"-alerts-recipients-", "x-api-path-slug"=>"alertsrecipients-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/recipients/{recipient_id} "=>{" get "=>{"summary"=>"Alerts Recipients", "description"=>"Gets a information about alert recipient's targets.", "operationId"=>"-alerts-recipients-recipient-id-", "x-api-path-slug"=>"alertsrecipientsrecipient-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/recipient/{recipient_id} "=>{" put "=>{"summary"=>"Alerts Recipient", "description"=>"Updates recipient along with sms and email targets associated.", "operationId"=>"-alerts-recipient-recipient-id-", "x-api-path-slug"=>"alertsrecipientrecipient-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/recipient "=>{" post "=>{"summary"=>"Alerts Recipient", "description"=>"Creates a new recipient with one sms and one email target associated.", "operationId"=>"-alerts-recipient-", "x-api-path-slug"=>"alertsrecipient-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/targets "=>{" get "=>{"summary"=>"Alerts Targets", "description"=>"Gets a list of all alert targets that are visible to you as a customer.", "operationId"=>"-alerts-targets-", "x-api-path-slug"=>"alertstargets-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/configs/alertId"=>{"delete"=>{"summary"=>"Deleting an alert", "description"=>"Deleting an alert", "operationId"=>"deleting-an-alert", "x-api-path-slug"=>"alertsconfigsalertid-delete", "parameters"=>[{"in"=>"path", "name"=>"alertId", "description"=>"The ID of the alert to be deleted", "type"=>"string"}, {"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"body", "name"=>"token", "description"=>"Your API token", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/configs/subjectId"=>{"get"=>{"summary"=>"Listing alerts by subject", "description"=>"Get a list of all configured alerts for a specific subject (device or service).", "operationId"=>"listing-alerts-by-subject", "x-api-path-slug"=>"alertsconfigssubjectid-get", "parameters"=>[{"in"=>"path", "name"=>"subjectId", "description"=>"The ID of the subject e", "type"=>"string"}, {"in"=>"path", "name"=>"subjectType", "description"=>"The type of the subject - device or service", "type"=>"string"}, {"in"=>"query", "name"=>"subjectType", "description"=>"The type of the subject - device or service", "type"=>"string"}, {"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/triggered"=>{"get"=>{"summary"=>"Triggered Alerts", "description"=>"Get a list of all triggered alerts on your account, per subject (device or service) or per alert config.", "operationId"=>"triggered-alerts", "x-api-path-slug"=>"alertstriggered-get", "parameters"=>[{"in"=>"query", "name"=>"closed", "description"=>"Whether to filter by closed or open alerts - unset = all alerts, false = open alerts, true = closed alerts", "type"=>"string"}, {"in"=>"query", "name"=>"filter", "description"=>"You can provide a JSON encoded hash filter for the search that will return items that match the filter", "type"=>"string"}, {"in"=>"query", "name"=>"subjectType", "description"=>"The type of the subject - device, service, deviceGroup or serviceGroup if you also specify the subjectId as part of the URL (see examples below)", "type"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}}}, "history-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Server Density", "x-complete"=>1, "info"=>{"title"=>"History API", "description"=>"the-history-api-", "version"=>"1.0.0"}, "host"=>"api.serverdensity.io.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/alerts/history/"=>{""=>{"summary"=>"Listing costs", "description"=>"Get the alerts history items limited by the given filter. If configId filter is set, then the results contains all events for that alert configuration. In any other case, the results are aggregated by itemId and configId including the following derived values:\n\nduration the sum of event durations.\ntriggeredCount the number of events for that alert in that item.\ncost the HumanOps cost in seconds. For more information please check our support docs\n\n\nWhen the query is aggregated, the non-derived fields are from the document whose startDate is the newest. In addition to this, an unique id is generated by concatenating the itemId and the configId.", "operationId"=>"listing-costs", "x-api-path-slug"=>"alertshistory-", "parameters"=>[{"in"=>"query", "name"=>"configId", "description"=>"_id of the config you want to limit by", "type"=>"string"}, {"in"=>"query", "name"=>"end", "description"=>"A string in the format, the end of the time frame eg", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"json encoded string - An array or a dict with all the fields we want returned", "type"=>"string"}, {"in"=>"query", "name"=>"filter", "description"=>"json encoded string - A dict with the filters we want to apply to the query (ex: {"config", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Sort ordering: ascending, descending", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Page number, default = 1", "type"=>"string"}, {"in"=>"query", "name"=>"perPage", "description"=>"Documents that we're going to get per page", "type"=>"string"}, {"in"=>"query", "name"=>"sort", "description"=>"Field to sort by", "type"=>"string"}, {"in"=>"query", "name"=>"start", "description"=>"A string in the format, the beginning of the time frame eg", "type"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, ""=>{"description"=>""}}, "tags"=>["Alerts"]}}}}, "apis"=>{"name"=>"Server Density", "x-slug"=>"server-density", "description"=>"SaaS infrastructure monitoring. Dashboards, graphs and alerts to help you improve performance and maintain uptime. Organizer of @humanops", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/475-server-density.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"209719", "tags"=>"API United Kingdom,Monitoring,Relative StreamRank,SaaS,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"server-density/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Alerts API", "x-api-slug"=>"alerts-api", "description"=>"SaaS infrastructure monitoring. Dashboards, graphs and alerts to help you improve performance and maintain uptime. Organizer of @humanops", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/475-server-density.jpg", "humanURL"=>"https://www.serverdensity.com", "baseURL"=>"://api.serverdensity.io./", "tags"=>"API United Kingdom,Monitoring,Relative StreamRank,SaaS,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/server-density/alerts-api-openapi.yaml"}]}, {"name"=>"Dashboards API", "x-api-slug"=>"dashboards-api", "description"=>"SaaS infrastructure monitoring. Dashboards, graphs and alerts to help you improve performance and maintain uptime. Organizer of @humanops", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/475-server-density.jpg", "humanURL"=>"https://www.serverdensity.com", "baseURL"=>"://api.serverdensity.io./", "tags"=>"Alerts", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/server-density/dashboards-api-openapi.yaml"}]}, {"name"=>"Devices API", "x-api-slug"=>"devices-api", "description"=>"SaaS infrastructure monitoring. Dashboards, graphs and alerts to help you improve performance and maintain uptime. Organizer of @humanops", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/475-server-density.jpg", "humanURL"=>"https://www.serverdensity.com", "baseURL"=>"://api.serverdensity.io./", "tags"=>"Dashboards", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/server-density/devices-api-openapi.yaml"}]}, {"name"=>"History API", "x-api-slug"=>"history-api", "description"=>"SaaS infrastructure monitoring. Dashboards, graphs and alerts to help you improve performance and maintain uptime. Organizer of @humanops", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/475-server-density.jpg", "humanURL"=>"https://www.serverdensity.com", "baseURL"=>"://api.serverdensity.io./", "tags"=>"Devices", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/server-density/alertshistory--postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/server-density/history-api-openapi.yaml"}]}, {"name"=>"Postbacks API", "x-api-slug"=>"postbacks-api", "description"=>"SaaS infrastructure monitoring. Dashboards, graphs and alerts to help you improve performance and maintain uptime. Organizer of @humanops", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/475-server-density.jpg", "humanURL"=>"https://www.serverdensity.com", "baseURL"=>"://api.serverdensity.io./", "tags"=>"Alerts", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/server-density/postbacks-api-openapi.yaml"}]}, {"name"=>"Service Status API", "x-api-slug"=>"service-status-api", "description"=>"SaaS infrastructure monitoring. Dashboards, graphs and alerts to help you improve performance and maintain uptime. Organizer of @humanops", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/475-server-density.jpg", "humanURL"=>"https://www.serverdensity.com", "baseURL"=>"://api.serverdensity.io./", "tags"=>"Alerts", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/server-density/servicemonitorlastserviceid--postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/server-density/service-status-api-openapi.yaml"}]}, {"name"=>"Tokens API", "x-api-slug"=>"tokens-api", "description"=>"SaaS infrastructure monitoring. Dashboards, graphs and alerts to help you improve performance and maintain uptime. Organizer of @humanops", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/475-server-density.jpg", "humanURL"=>"https://www.serverdensity.com", "baseURL"=>"://api.serverdensity.io./", "tags"=>"Service Monitor", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/server-density/tokens-api-openapi.yaml"}]}, {"name"=>"Widgets API", "x-api-slug"=>"widgets-api", "description"=>"SaaS infrastructure monitoring. Dashboards, graphs and alerts to help you improve performance and maintain uptime. Organizer of @humanops", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/475-server-density.jpg", "humanURL"=>"https://www.serverdensity.com", "baseURL"=>"://api.serverdensity.io./", "tags"=>"Tokens", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/server-density/widgets-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://www.serverdensity.com"}, {"type"=>"x-blog", "url"=>"http://blog.serverdensity.com/"}, {"type"=>"x-blog-rss", "url"=>"http://feeds.feedburner.com/serverdensity"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/server-density"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/server-density"}, {"type"=>"x-email", "url"=>"hello@serverdensity.com"}, {"type"=>"x-github", "url"=>"https://github.com/serverdensity"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/server-density"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/serverdensity"}, {"type"=>"x-website", "url"=>"http://www.serverdensity.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "postbacks-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Server Density", "x-complete"=>1, "info"=>{"title"=>"Postbacks API", "description"=>"the-postbacks-api-", "version"=>"1.0.0"}, "host"=>"api.serverdensity.io.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/alerts/postbacks/"=>{""=>{"summary"=>"Creating a postback", "description"=>"You can use this method to post data back to Server Density without using the agent, for example using your own scripts or to integrate in something custom you are doing. You will still be restricted to posting back once per minute using this method, as you would be using the agent.", "operationId"=>"creating-a-postback", "x-api-path-slug"=>"alertspostbacks-", "parameters"=>[{"in"=>"body", "name"=>"hash", "description"=>"An md5 hash of the JSON encoded payload, used for error checking", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"payload", "description"=>"The payload you want to post back to us", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"token", "description"=>"Your API token", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"X-Forwarded-Host", "description"=>"Set this to your Server Density account url, e", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{"apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}}, "tags"=>["Alerts"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
columbus-indiana-311{"columbus-indiana-311-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Columbus Indiana 311", "x-complete"=>1, "info"=>{"title"=>"Columbus Indiana 311 GeoReport API", "description"=>"open311-allows-you-to-getpost-civic-information-of-cities-via-a-unified-interface--the-georeport-part-allows-you-to-submit-and-view-issues-at-the-public-local-space", "contact"=>{"name"=>"Open311 community", "url"=>"http://wiki.open311.org/GeoReport_v2/", "email"=>"discuss@lists.open311.org"}, "version"=>"1.0.0"}, "host"=>"csr.columbus.in.gov", "basePath"=>"/csr/open311/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/requests.{response_format}"=>{"get"=>{"summary"=>"Requests", "description"=>"Query the current status of multiple requests.", "operationId"=>"query-the-current-status-of-multiple-requests", "x-api-path-slug"=>"requests-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"Latest datetime to include in search"}, {"in"=>"query", "name"=>"No Name"}, {"in"=>"path", "name"=>"response_format", "description"=>"The response in XML or JSON format", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"service_code", "description"=>"Specify the service type by calling the unique ID of the service_code"}, {"in"=>"query", "name"=>"service_request_id", "description"=>"To call multiple Service Requests at once, multiple service_request_id can be declared; comma delimited"}, {"in"=>"query", "name"=>"start_date", "description"=>"Earliest datetime to include in search"}, {"in"=>"query", "name"=>"status", "description"=>"Allows one to search for requests which have a specific status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Requests"]}, "post"=>{"summary"=>"Create Service Request", "description"=>"Submit a new request for with specific details of a single service. Must provide a location via lat/long or address_string or address_id", "operationId"=>"submit-a-new-request-for-with-specific-details-of-a-single-service-must-provide-a-location-via-latlo", "x-api-path-slug"=>"requests-response-format-post", "parameters"=>[{"in"=>"query", "name"=>"address_id"}, {"in"=>"query", "name"=>"address_string"}, {"in"=>"query", "name"=>"attribute", "description"=>"array of key/value responses based on Service Definitions"}, {"in"=>"query", "name"=>"lat", "description"=>"WGS-84 latitude"}, {"in"=>"query", "name"=>"long", "description"=>"WGS-84 longitude"}, {"in"=>"query", "name"=>"No Name"}, {"in"=>"path", "name"=>"response_format", "description"=>"The response in XML or JSON format", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"service_code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Service", "Request"]}}, "/request/{service_request_id}.{response_format}"=>{"get"=>{"summary"=>"Current Status", "description"=>"Query the current status of an individual request", "operationId"=>"query-the-current-status-of-an-individual-request", "x-api-path-slug"=>"requestservice-request-id-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"No Name"}, {"in"=>"path", "name"=>"service_request_id", "description"=>"Is specified in the main URL path rather than an added query string parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Current", "Status"]}}, "/services.{response_format}"=>{"get"=>{"summary"=>"Service Types", "description"=>"List acceptable service request types and their associated service codes. These request types can be unique to the city/jurisdiction.", "operationId"=>"list-acceptable-service-request-types-and-their-associated-service-codes-these-request-types-can-be-", "x-api-path-slug"=>"services-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"No Name"}, {"in"=>"path", "name"=>"response_format", "description"=>"The response in XML or JSON format", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Service", "Types"]}}, "/services/{service_code}.{response_format}"=>{"get"=>{"summary"=>"Definition Of A Service Type", "description"=>"Define attributes associated with a service code. These attributes can be unique to the city/jurisdiction.", "operationId"=>"define-attributes-associated-with-a-service-code-these-attributes-can-be-unique-to-the-cityjurisdict", "x-api-path-slug"=>"servicesservice-code-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"No Name"}, {"in"=>"path", "name"=>"service_code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Definition", "Service", "Type"]}}, "/tokens/{token_id}.{response_format}"=>{"get"=>{"summary"=>"Id Of Service_request Via Token", "description"=>"Get the service_request_id from a temporary token. This is unnecessary if the response from creating a service request does not contain a token.", "operationId"=>"get-the-service-request-id-from-a-temporary-token-this-is-unnecessary-if-the-response-from-creating-", "x-api-path-slug"=>"tokenstoken-id-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"No Name"}, {"in"=>"path", "name"=>"token_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Id", "Service", "Request", "Via", "Token"]}}}}, "apis"=>{"name"=>"Columbus Indiana 311", "x-slug"=>"columbus-indiana-311", "description"=>"The Columbus Service Center is also known as 3-1-1; its mission is to provide access to City services and City information with the highest possible levels of customer service. The 3-1-1 initiative strives to help City agencies provide efficient service delivery by allowing them to focus on their core missions, manage workloads efficiently, provide insight into the needs of residents, and measure how well services are delivered.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/COC_311_RGB_TEXT.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"311,Open311,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"columbus-indiana-311/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Columbus Indiana 311", "x-api-slug"=>"columbus-indiana-311", "description"=>"The Columbus Service Center is also known as 3-1-1; its mission is to provide access to City services and City information with the highest possible levels of customer service. The 3-1-1 initiative strives to help City agencies provide efficient service delivery by allowing them to focus on their core missions, manage workloads efficiently, provide insight into the needs of residents, and measure how well services are delivered.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/COC_311_RGB_TEXT.jpg", "humanURL"=>"https://311.columbus.gov/", "baseURL"=>"https://csr.columbus.in.gov//csr/open311/v2/", "tags"=>"311,Open311,Streams,Streams", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/columbus-indiana-311/tokenstoken-id-response-format-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/columbus-indiana-311/columbus-indiana-311-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-open-311-feed", "url"=>"http://csr.columbus.in.gov/csr/open311/v2/services.xml?jurisdiction_id=columbus.in.gov"}, {"type"=>"x-website", "url"=>"https://311.columbus.gov/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
knoema{"knoema-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Knoema", "x-complete"=>1, "info"=>{"title"=>"Knoema", "description"=>"you-dont-need-to-be-a-developer-to-get-started--we-made-a-number-of-useful-platform-features-available-as-ready-to-use-widgets--you-can-put-a-dashboard-or-presentation-with-any-visualizationcontent-you-like-and-then-embed-it-in-your-site-or-blog-in-a-few-minutes---such-an-approach-requires-no-programming-skills-at-all-just-basic-understanding-of-html--refer-to-widgets-sections-for-more-information-on-this-topic--knoema-is-a-truly-open-platform---in-addition-to-our-own-apis-we-support-several-formats-widely-acknowledged-by-industry-such-as-odata-and-sdmx---if-you-already-have-toolsclients-utilizing-data-in-these-formats-you-can-add-knoema-support-very-easily--more-information-can-be-found-in-open-data-section--for-enthusiasts-and-hardcore-developers-knoema-offers-extensive-knoema-api-providing-access-to-all-platform-capabilities--start-with-getting-familiar-with-core-knoema-concepts--then-proceed-to-applications-section-to-find-stepbystep-tutorials-detailed-documentation-and-sample-apps-", "version"=>"1.0.0"}, "host"=>"knoema.com", "basePath"=>"/api/1.0", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/meta/dataset"=>{"get"=>{"summary"=>"List of datasets", "description"=>"Returns the list of datasets", "operationId"=>"listOfDatasets", "x-api-path-slug"=>"metadataset-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets"]}}, "/meta/dataset/{dataset id}"=>{"get"=>{"summary"=>"Dataset details", "description"=>"Lists out details of a particular dataset.", "operationId"=>"datasetDetails", "x-api-path-slug"=>"metadatasetdataset-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets"]}}, "/meta/dataset/{datasetId}/dimension/{dimensionId}"=>{"get"=>{"summary"=>"Dimension", "description"=>"Lists out the given dataset's dimension details.", "operationId"=>"datasetDimensions", "x-api-path-slug"=>"metadatasetdatasetiddimensiondimensionid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Dimensions"]}}, "/meta/group/{groupKey}"=>{"get"=>{"summary"=>"Dimension Group", "description"=>"This endpoint used to list/add/edit/delete groups in dimensions. The functionality of endpoint depends on HTTP method: GET, POST, PUT or DELETE.", "operationId"=>"dimensionGroup", "x-api-path-slug"=>"metagroupgroupkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Dimensions"]}}, "/frontend/tags"=>{"get"=>{"summary"=>"List of tags", "description"=>"Lists out all the public tags present in the system", "operationId"=>"getTags", "x-api-path-slug"=>"frontendtags-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/data/dataset/{dataset id}"=>{"get"=>{"summary"=>"Get timeseries list", "description"=>"For the given dataset, this endpoint returns time series list for all the available frequencies with the combination of all the dimension members.", "operationId"=>"getTimeseriesList", "x-api-path-slug"=>"datadatasetdataset-id-get", "parameters"=>[{"in"=>"path", "name"=>"dataset id", "description"=>"Unique dataset identifier", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Time Series"]}}, "/data/get"=>{"get"=>{"summary"=>"Get data", "description"=>"This endpoint returns observation data for the given filter.", "operationId"=>"getData", "x-api-path-slug"=>"dataget-get", "parameters"=>[{"in"=>"query", "name"=>"DatasetId", "description"=>"Unique dataset identifier", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets"]}}, "/search"=>{"get"=>{"summary"=>"Search by keyword", "description"=>"This namespace provides search details for data accessible by that user.", "operationId"=>"search", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"correct", "description"=>"correct (default true) - correct mistakes in the query or not", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"count (default 100) - number results count [0", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"search query for which data is required", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"scope", "description"=>"String to specify the type of search results", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"start", "description"=>"start (default 0) - number of the first result [0", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Search"]}}}}, "apis"=>{"name"=>"Knoema", "x-slug"=>"knoema", "description"=>"Knoema is the free to use public and open data platform for users with interests in statistics and data analysis, visual storytelling and making infographics and data-driven presentations", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/knoema-logo.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"38551", "tags"=>"API Provider,Data,Data Provider,Enterprise,Finance,Finance,Free Tier,General Data,JSON,Market Data,Profiles,REST,SaaS,Service API,Sign In With Facebook,Sign In With Google,Sign In With LinkedIn,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"knoema/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Knoema API", "x-api-slug"=>"knoema-api", "description"=>"Knoema is the free to use public and open data platform for users with interests in statistics and data analysis, visual storytelling and making infographics and data-driven presentations", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/knoema-logo.jpg", "humanURL"=>"https://knoema.com", "baseURL"=>"http://knoema.com//api/1.0", "tags"=>"API Provider,Data,Data Provider,Enterprise,Finance,Finance,Free Tier,General Data,JSON,Market Data,Profiles,REST,SaaS,Service API,Sign In With Facebook,Sign In With Google,Sign In With LinkedIn,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/knoema/knoema-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://knoema.com/dev/apps/authentication"}, {"type"=>"x-blog", "url"=>"http://blog.knoema.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.knoema.com/feeds/posts/default?alt=rss"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/knoema"}, {"type"=>"x-developer", "url"=>"http://knoema.com/dev"}, {"type"=>"x-documentation", "url"=>"https://knoema.com/dev/docs"}, {"type"=>"x-email", "url"=>"jobs@knoema.com"}, {"type"=>"x-email", "url"=>"veskin@knoema.com"}, {"type"=>"x-email", "url"=>"jkasputys@knoema.com"}, {"type"=>"x-email", "url"=>"vb@knoema.com"}, {"type"=>"x-email", "url"=>"sales@knoema.com"}, {"type"=>"x-email", "url"=>"info@knoema.com"}, {"type"=>"x-email", "url"=>"support@knoema.com"}, {"type"=>"x-getting-started", "url"=>"https://knoema.com/signup"}, {"type"=>"x-getting-started", "url"=>"http://feedback.knoema.com/"}, {"type"=>"x-github", "url"=>"https://github.com/knoema"}, {"type"=>"x-selfservice-registration", "url"=>"https://knoema.com/sys/login?returnUrl=%2Fdev%2Fdocs%2Fmeta%2Fdatasets"}, {"type"=>"x-terms-of-service", "url"=>"https://knoema.com/legal/termsofuse"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/knoema"}, {"type"=>"x-website", "url"=>"https://knoema.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
paypal{"paypal-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"PayPal", "x-complete"=>1, "info"=>{"title"=>"PayPal (Sandbox)", "description"=>"bring-payments-to-apps-mobile-and-social-with-adaptive-payments-bsandbox-api-b", "version"=>"1.0.0"}, "host"=>"svcs.sandbox.paypal.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/Permissions/GetAdvancedPersonalData"=>{"post"=>{"summary"=>"Get Advanced Personal Data", "description"=>"Use the GetAdvancedPersonalData API operation to obtain sensitive personal data for an account holder.", "operationId"=>"Permissions.GetAdvancedPersonalData.post", "x-api-path-slug"=>"permissionsgetadvancedpersonaldata-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Profiles"]}}, "/Permissions/GetBasicPersonalData"=>{"post"=>{"summary"=>"Get Basic Personal Data", "description"=>"Use the GetBasicPersonalData API operation to obtain basic personal data for an account holder.", "operationId"=>"Permissions.GetBasicPersonalData.post", "x-api-path-slug"=>"permissionsgetbasicpersonaldata-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Profiles"]}}, "/Permissions/CancelPermissions"=>{"post"=>{"summary"=>"Cancel Permissions", "description"=>"Use the CancelPermissions API operation to cancel access to a set of permissions.", "operationId"=>"Permissions.CancelPermissions.post", "x-api-path-slug"=>"permissionscancelpermissions-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Permissions"]}}, "/Permissions/GetPermissions"=>{"post"=>{"summary"=>"Get Permissions", "description"=>"Use the GetPermissons API operation to obtain the permissions associated with an access token.", "operationId"=>"Permissions.GetPermissions.post", "x-api-path-slug"=>"permissionsgetpermissions-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Permissions"]}}, "/Permissions/GetAccessToken"=>{"post"=>{"summary"=>"GetAccess Token", "description"=>"Use the GetAccessToken API operation to obtain an access token for a set of permissions.", "operationId"=>"Permissions.GetAccessToken.post", "x-api-path-slug"=>"permissionsgetaccesstoken-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Access Tokens"]}}, "/Permissions/RequestPermissions"=>{"post"=>{"summary"=>"Request Permissions", "description"=>"Use the RequestPermissions API operation to request permissions to execute API operations on a PayPal account holder???s behalf.", "operationId"=>"Permissions.RequestPermissions.post", "x-api-path-slug"=>"permissionsrequestpermissions-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Permissions"]}}, "/Invoice/SearchInvoices"=>{"post"=>{"summary"=>"Search Invoices", "description"=>"Use the SearchInvoice API operation to search an invoice.", "operationId"=>"Invoice.SearchInvoices.post", "x-api-path-slug"=>"invoicesearchinvoices-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Invoices", "Search"]}}, "/Invoice/MarkInvoiceAsPaid"=>{"post"=>{"summary"=>"Mark Invoice As Paid", "description"=>"Use the MarkInvoiceAsPaid API operation to mark an invoice as paid.", "operationId"=>"Invoice.MarkInvoiceAsPaid.post", "x-api-path-slug"=>"invoicemarkinvoiceaspaid-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Invoices"]}}, "/Invoice/Cancel Invoice"=>{"post"=>{"summary"=>"Cancel Invoice", "description"=>"Use the CancelInvoice API operation to cancel an invoice.", "operationId"=>"Invoice.CancelInvoice.post", "x-api-path-slug"=>"invoicecancel-invoice-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Invoices"]}}, "/Invoice/GetInvoiceDetails"=>{"post"=>{"summary"=>"Get Invoice Details", "description"=>"Use the GetInvoiceDetails API operation to get detailed information about an invoice.", "operationId"=>"Invoice.GetInvoiceDetails.post", "x-api-path-slug"=>"invoicegetinvoicedetails-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Invoices"]}}, "/Invoice/UpdateInvoice"=>{"post"=>{"summary"=>"Update Invoice", "description"=>"Use the UpdateInvoice API operation to update an invoice.", "operationId"=>"Invoice.UpdateInvoice.post", "x-api-path-slug"=>"invoiceupdateinvoice-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Invoices"]}}, "/Invoice/CreateAndSendInvoice"=>{"post"=>{"summary"=>"Create And Send Invoice", "description"=>"Use the CreateAndSendInvoice API operation to create and send an invoice.", "operationId"=>"Invoice.CreateAndSendInvoice.post", "x-api-path-slug"=>"invoicecreateandsendinvoice-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Invoices"]}}, "/Invoice/SendInvoice"=>{"post"=>{"summary"=>"Send Invoice", "description"=>"Use the SendInvoice API operation to send an invoice to a payer, and notify the payer of the pending invoice.", "operationId"=>"Invoice.SendInvoice.post", "x-api-path-slug"=>"invoicesendinvoice-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Invoices"]}}, "/Invoice/CreateInvoice"=>{"post"=>{"summary"=>"Create Invoice", "description"=>"Use the CreateInvoice API operation to create a new invoice. The call includes merchant, payer, and API caller information, in addition to invoice detail. The response to the call contains an invoice ID and URL.", "operationId"=>"Invoice.CreateInvoice.post", "x-api-path-slug"=>"invoicecreateinvoice-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Invoices"]}}, "/AdaptiveAccounts/GetUserAgreement"=>{"post"=>{"summary"=>"Get User Agreement", "description"=>"The GetUserAgreement API operation lets you retrieve the user agreement for the customer to approve the new PayPal account.", "operationId"=>"AdaptiveAccounts.GetUserAgreement.post", "x-api-path-slug"=>"adaptiveaccountsgetuseragreement-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Aggreements"]}}, "/AdaptiveAccounts/GetVerifiedStatus"=>{"post"=>{"summary"=>"Get Verified Status", "description"=>"The GetVerifiedStatus API operation lets you check if a PayPal account status is verified. A PayPal account gains verified status under a variety of circumstances, such as when an account is linked to a verified funding source. Verified status serves to indicate a trust relationship. For more information about account verified status, refer to PayPal.com.", "operationId"=>"AdaptiveAccounts.GetVerifiedStatus.post", "x-api-path-slug"=>"adaptiveaccountsgetverifiedstatus-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Verified", "Status"]}}, "/AdaptiveAccounts/SetFundingSourceConfirmed"=>{"post"=>{"summary"=>"Set Funding Source Confirmed", "description"=>"The SetFundingSourceConfirmed API operation lets your application set up bank accounts as funding sources for PayPal accounts.", "operationId"=>"AdaptiveAccounts.SetFundingSourceConfirmed.post", "x-api-path-slug"=>"adaptiveaccountssetfundingsourceconfirmed-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Verified", "Status"]}}, "/AdaptiveAccounts/AddPaymentCard"=>{"post"=>{"summary"=>"Add Payment Card", "description"=>"The AddPaymentCard API operation lets your application set up credit cards as funding sources for PayPal accounts.", "operationId"=>"AdaptiveAccounts.AddPaymentCard.post", "x-api-path-slug"=>"adaptiveaccountsaddpaymentcard-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Credit Card"]}}, "/AdaptiveAccounts/AddBankAccount"=>{"post"=>{"summary"=>"Add Bank Account", "description"=>"The AddBankAccount API operation lets your application set up bank accounts as funding sources for PayPal accounts.", "operationId"=>"AdaptiveAccounts.AddBankAccount.post", "x-api-path-slug"=>"adaptiveaccountsaddbankaccount-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Bank Account"]}}, "/AdaptiveAccounts/CreateAccount"=>{"post"=>{"summary"=>"Create Account", "description"=>"The CreateAccount API operation enables you to create a PayPal account on behalf of a third party.", "operationId"=>"AdaptiveAccounts.CreateAccount.post", "x-api-path-slug"=>"adaptiveaccountscreateaccount-post", "parameters"=>[{"in"=>"header", "name"=>"X-PAYPAL-SANDBOX-EMAIL-ADDRESS"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}}, "/AdaptivePayments/GetFundingPlans"=>{"post"=>{"summary"=>"Get Funding Plans", "description"=>"Use the GetFundingPlans API operation to determine the funding sources that are available for a specified payment, identified by its key, which takes into account the preferences and country of the receiver as well as the payment amount. You must be both the sender of the payment and the caller of this API operation", "operationId"=>"AdaptivePayments.GetFundingPlans.post", "x-api-path-slug"=>"adaptivepaymentsgetfundingplans-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Plans"]}}, "/AdaptivePayments/GetShippingAddresses"=>{"post"=>{"summary"=>"Get Shipping Addresses", "description"=>"Use the GetShippingAddresses API operation to obtain the selected shipping address. You must have created the payment or preapproval key that identifies the account holder whose shipping address you want to obtain, or be the primary receiver of the payment or one of the parallel receivers of the payment. The shipping address is available only if it was provided during the embedded payment flow.", "operationId"=>"AdaptivePayments.GetShippingAddresses.post", "x-api-path-slug"=>"adaptivepaymentsgetshippingaddresses-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Addresses"]}}, "/AdaptivePayments/ExecutePayment"=>{"post"=>{"summary"=>"Execute Payment", "description"=>"The ExecutePayment API operation lets you execute a payment set up with the Pay API operation with the actionType CREATE. To pay receivers identified in the Pay call, set the pay key from the PayResponse message in the ExecutePaymentRequest message.", "operationId"=>"AdaptivePayments.ExecutePayment.post", "x-api-path-slug"=>"adaptivepaymentsexecutepayment-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}}, "/AdaptivePayments/SetPaymentOptions"=>{"post"=>{"summary"=>"Set Payment Options", "description"=>"You use the SetPaymentOptions API operation to specify settings for a payment of the actionType CREATE. \n\t\t\t\t\tThis actionType is specified in the PayRequest message.", "operationId"=>"AdaptivePayments.SetPaymentOptions.post", "x-api-path-slug"=>"adaptivepaymentssetpaymentoptions-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}}, "/AdaptivePayments/GetPaymentOptions"=>{"post"=>{"summary"=>"Get Payment Options", "description"=>"You use the GetPaymentOptions API operation to retrieve the payment options passed with the SetPaymentOptionsRequest.", "operationId"=>"AdaptivePayments.GetPaymentOptions.post", "x-api-path-slug"=>"adaptivepaymentsgetpaymentoptions-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}}, "/AdaptivePayments/Refund"=>{"post"=>{"summary"=>"Refund", "description"=>"Use the Refund API operation to refund all or part of a payment. You can specify the amount of the refund and identify the accounts to receive the refund by the payment key or tracking ID, and optionally, by transaction ID or the receivers of the original payment.", "operationId"=>"AdaptivePayments.Refund.post", "x-api-path-slug"=>"adaptivepaymentsrefund-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Refunds"]}}, "/AdaptivePayments/ConvertCurrency"=>{"post"=>{"summary"=>"Convert Currency", "description"=>"Use the ConvertCurrency API operation to request the current foreign exchange (FX) rate for a specific amount and currency.", "operationId"=>"AdaptivePayments.ConvertCurrency.post", "x-api-path-slug"=>"adaptivepaymentsconvertcurrency-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "Currency"]}}, "/AdaptivePayments/CancelPreapproval"=>{"post"=>{"summary"=>"Cancel Preapproval", "description"=>"Use the CancelPreapproval API operation to handle the canceling of preapprovals. Preapprovals can be canceled regardless of the state they are in, such as active, expired, deactivated, and previously canceled.", "operationId"=>"AdaptivePayments.CancelPreapproval.post", "x-api-path-slug"=>"adaptivepaymentscancelpreapproval-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}}, "/AdaptivePayments/PreapprovalDetails"=>{"post"=>{"summary"=>"Preapproval Details", "description"=>"Use the PreapprovalDetails API operation to obtain information about an agreement between you and a sender for making payments on the sender???s behalf.", "operationId"=>"AdaptivePayments.PreapprovalDetails.post", "x-api-path-slug"=>"adaptivepaymentspreapprovaldetails-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}}, "/AdaptivePayments/Preapproval"=>{"post"=>{"summary"=>"Preapproval", "description"=>"Use the Preapproval API operation to set up an agreement between yourself and a sender for making payments on the sender???s behalf. You set up a preapprovals for a specific maximum amount over a specific period of time and, optionally, by any of the following constraints: the number of payments, a maximum per-payment amount, a specific day of the week or the month, and whether or not a PIN is required for each payment request.", "operationId"=>"AdaptivePayments.Preapproval.post", "x-api-path-slug"=>"adaptivepaymentspreapproval-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}}, "/AdaptivePayments/PaymentDetails"=>{"post"=>{"summary"=>"Payment Details", "description"=>"Use the PaymentDetails API operation to obtain information about a payment. You can identify the payment by your tracking ID, the PayPal transaction ID in an IPN message, or the pay key associated with the payment.", "operationId"=>"AdaptivePayments.PaymentDetails.post", "x-api-path-slug"=>"adaptivepaymentspaymentdetails-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}}, "/AdaptivePayments/Pay"=>{"post"=>{"summary"=>"Pay", "description"=>"Use the Pay API operation to transfer funds from a sender???s PayPal account to one or more receivers??? PayPal accounts. You can use the Pay API operation to make simple payments, chained payments, or parallel payments; these payments can be explicitly approved, preapproved, or implicitly approved.", "operationId"=>"AdaptivePayments.Pay.post", "x-api-path-slug"=>"adaptivepaymentspay-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}}}}, "apis"=>{"name"=>"PayPal", "x-slug"=>"paypal", "description"=>"PayPal is the faster, safer way to send money, make an online payment, receive money or set up a merchant account.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/237-paypal.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"71", "tags"=>"Billing,Financial Services,Getting Started Example,Hypermedia API,Indie EdTech Data Jam,International,internet,Invoices,Merchant,Mobile,Payments,Payments,Payments,Relative Data,SaaS,Service API,Stack,Stack Network,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"paypal/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Paypal", "x-api-slug"=>"paypal", "description"=>"PayPal is the faster, safer way to send money, make an online payment, receive money or set up a merchant account.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/237-paypal.jpg", "humanURL"=>"https://paypal.com", "baseURL"=>"https://svcs.sandbox.paypal.com//", "tags"=>"Billing,Financial Services,Getting Started Example,Hypermedia API,Indie EdTech Data Jam,International,internet,Invoices,Merchant,Mobile,Payments,Payments,Payments,Relative Data,SaaS,Service API,Stack,Stack Network,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/paypal/paypal-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base-url", "url"=>"https://api.paypal.com"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/paypal"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/paypal"}, {"type"=>"x-developer", "url"=>"https://developer.paypal.com/"}, {"type"=>"x-faq", "url"=>"https://developer.paypal.com/docs/faq/"}, {"type"=>"x-getting-started", "url"=>"https://developer.paypal.com/docs/"}, {"type"=>"x-github", "url"=>"https://github.com/paypal"}, {"type"=>"x-playground", "url"=>"https://devtools-paypal.com/hateoas/index.html"}, {"type"=>"x-privacy", "url"=>"https://www.paypal.com/us/cgi-bin/webscr?cmd=p/gen/ua/policy_privacy-outside"}, {"type"=>"x-release-notes", "url"=>"https://developer.paypal.com/docs/release-notes/"}, {"type"=>"x-terms-of-service", "url"=>"https://cms.paypal.com/us/cgi-bin/?cmd=_render-content&content_ID=ua/Legal_Hub_full"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/paypal"}, {"type"=>"x-website", "url"=>"https://paypal.com"}, {"type"=>"x-webhook", "url"=>"https://developer.paypal.com/docs/integration/direct/webhooks/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-batch{"aws-batch-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Batch", "x-complete"=>1, "info"=>{"title"=>"AWS Batch API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=CancelJob"=>{"get"=>{"summary"=>"Cancel Job", "description"=>"Cancels jobs in an AWS Batch job queue.", "operationId"=>"cancelJob", "x-api-path-slug"=>"actioncanceljob-get", "parameters"=>[{"in"=>"query", "name"=>"jobId", "description"=>"A list of up to 100 job IDs to cancel", "type"=>"string"}, {"in"=>"query", "name"=>"reason", "description"=>"A message to attach to the job that explains the reason for cancelling it", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/?Action=CreateComputeEnvironment"=>{"get"=>{"summary"=>"Create Compute Environment", "description"=>"Creates an AWS Batch compute environment.", "operationId"=>"createComputeEnvironment", "x-api-path-slug"=>"actioncreatecomputeenvironment-get", "parameters"=>[{"in"=>"query", "name"=>"computeEnvironmentName", "description"=>"The name for your compute environment", "type"=>"string"}, {"in"=>"query", "name"=>"computeResources", "description"=>"Details of the compute resources managed by the compute environment", "type"=>"string"}, {"in"=>"query", "name"=>"serviceRole", "description"=>"The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf", "type"=>"string"}, {"in"=>"query", "name"=>"state", "description"=>"The state of the compute environment", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"The type of the compute environment", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compute Environment"]}}, "/?Action=CreateJobQueue"=>{"get"=>{"summary"=>"Create Job Queue", "description"=>"Creates an AWS Batch job queue.", "operationId"=>"createJobQueue", "x-api-path-slug"=>"actioncreatejobqueue-get", "parameters"=>[{"in"=>"query", "name"=>"computeEnvironmentOrder", "description"=>"The set of compute environments mapped to a job queue and their order relative to each other", "type"=>"string"}, {"in"=>"query", "name"=>"jobQueueName", "description"=>"The name of the job queue", "type"=>"string"}, {"in"=>"query", "name"=>"priority", "description"=>"The priority of the job queue", "type"=>"string"}, {"in"=>"query", "name"=>"state", "description"=>"The state of the job queue", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Queue"]}}, "/?Action=DeleteComputeEnvironment"=>{"get"=>{"summary"=>"Delete Compute Environment", "description"=>"Deletes an AWS Batch compute environment.", "operationId"=>"deleteComputeEnvironment", "x-api-path-slug"=>"actiondeletecomputeenvironment-get", "parameters"=>[{"in"=>"query", "name"=>"computeEnvironment", "description"=>"The name or Amazon Resource Name (ARN) of the compute environment to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compute Environment"]}}, "/?Action=DeleteJobQueue"=>{"get"=>{"summary"=>"Delete Job Queue", "description"=>"Deletes the specified job queue.", "operationId"=>"deleteJobQueue", "x-api-path-slug"=>"actiondeletejobqueue-get", "parameters"=>[{"in"=>"query", "name"=>"jobQueue", "description"=>"The short name or full Amazon Resource Name (ARN) of the queue to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Queue"]}}, "/?Action=DeregisterJobDefinition"=>{"get"=>{"summary"=>"Deregister Job Definition", "description"=>"Deregisters an AWS Batch job definition.", "operationId"=>"deregisterJobDefinition", "x-api-path-slug"=>"actionderegisterjobdefinition-get", "parameters"=>[{"in"=>"query", "name"=>"jobDefinition", "description"=>"The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to deregister", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Definitions"]}}, "/?Action=DescribeComputeEnvironments"=>{"get"=>{"summary"=>"Describe Compute Environments", "description"=>"Describes one or more of your compute environments.", "operationId"=>"describeComputeEnvironments", "x-api-path-slug"=>"actiondescribecomputeenvironments-get", "parameters"=>[{"in"=>"query", "name"=>"computeEnvironments", "description"=>"A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compute Environment"]}}, "/?Action=DescribeJobDefinitions"=>{"get"=>{"summary"=>"Describe Job Definitions", "description"=>"Describes a list of job definitions.", "operationId"=>"describeJobDefinitions", "x-api-path-slug"=>"actiondescribejobdefinitions-get", "parameters"=>[{"in"=>"query", "name"=>"jobDefinitionName", "description"=>"The name of the job definition to describe", "type"=>"string"}, {"in"=>"query", "name"=>"jobDefinitions", "description"=>"A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results returned by DescribeJobDefinitions in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The nextToken value returned from a previous paginated DescribeJobDefinitions request where maxResults was used and the results exceeded the value of that parameter", "type"=>"string"}, {"in"=>"query", "name"=>"status", "description"=>"The status with which to filter job definitions", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Definitions"]}}, "/?Action=DescribeJobQueues"=>{"get"=>{"summary"=>"Describe Job Queues", "description"=>"Describes one or more of your job queues.", "operationId"=>"describeJobQueues", "x-api-path-slug"=>"actiondescribejobqueues-get", "parameters"=>[{"in"=>"query", "name"=>"jobQueues", "description"=>"A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results returned by DescribeJobQueues in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Queue"]}}, "/?Action=DescribeJobs"=>{"get"=>{"summary"=>"Describe Jobs", "description"=>"Describes a list of AWS Batch jobs.", "operationId"=>"describeJobs", "x-api-path-slug"=>"actiondescribejobs-get", "parameters"=>[{"in"=>"query", "name"=>"jobs", "description"=>"A space-separated list of up to 100 job IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Definitions"]}}, "/?Action=ListJobs"=>{"get"=>{"summary"=>"List Jobs", "description"=>"Returns a list of task jobs for a specified job queue.", "operationId"=>"listJobs", "x-api-path-slug"=>"actionlistjobs-get", "parameters"=>[{"in"=>"query", "name"=>"jobQueue", "description"=>"The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs", "type"=>"string"}, {"in"=>"query", "name"=>"jobStatus", "description"=>"The job status with which to filter jobs in the specified queue", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results returned by ListJobs in paginated output", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/?Action=RegisterJobDefinition"=>{"get"=>{"summary"=>"Register Job Definition", "description"=>"Registers an AWS Batch job definition.", "operationId"=>"registerJobDefinition", "x-api-path-slug"=>"actionregisterjobdefinition-get", "parameters"=>[{"in"=>"query", "name"=>"containerProperties", "description"=>"An object with various properties specific for container-based jobs", "type"=>"string"}, {"in"=>"query", "name"=>"jobDefinitionName", "description"=>"The name of the job definition to register", "type"=>"string"}, {"in"=>"query", "name"=>"parameters", "description"=>"Default parameter substitution placeholders to set in the job definition", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"The type of job definition", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Definitions"]}}, "/?Action=SubmitJob"=>{"get"=>{"summary"=>"Submit Job", "description"=>"Submits an AWS Batch job from a job definition.", "operationId"=>"submitJob", "x-api-path-slug"=>"actionsubmitjob-get", "parameters"=>[{"in"=>"query", "name"=>"containerOverrides", "description"=>"A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive", "type"=>"string"}, {"in"=>"query", "name"=>"dependsOn", "description"=>"A list of job names or IDs on which this job depends", "type"=>"string"}, {"in"=>"query", "name"=>"jobDefinition", "description"=>"The job definition used by this job", "type"=>"string"}, {"in"=>"query", "name"=>"jobName", "description"=>"The name of the job", "type"=>"string"}, {"in"=>"query", "name"=>"jobQueue", "description"=>"The job queue into which the job will be submitted", "type"=>"string"}, {"in"=>"query", "name"=>"parameters", "description"=>"Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/?Action=TerminateJob"=>{"get"=>{"summary"=>"Terminate Job", "description"=>"Terminates jobs in a job queue.", "operationId"=>"terminateJob", "x-api-path-slug"=>"actionterminatejob-get", "parameters"=>[{"in"=>"query", "name"=>"jobId", "description"=>"Job IDs to be terminated", "type"=>"string"}, {"in"=>"query", "name"=>"reason", "description"=>"A message to attach to the job that explains the reason for cancelling it", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/?Action=UpdateComputeEnvironment"=>{"get"=>{"summary"=>"Update Compute Environment", "description"=>"Updates an AWS Batch compute environment.", "operationId"=>"updateComputeEnvironment", "x-api-path-slug"=>"actionupdatecomputeenvironment-get", "parameters"=>[{"in"=>"query", "name"=>"computeEnvironment", "description"=>"The name or full Amazon Resource Name (ARN) of the compute environment to update", "type"=>"string"}, {"in"=>"query", "name"=>"computeResources", "description"=>"Details of the compute resources managed by the compute environment", "type"=>"string"}, {"in"=>"query", "name"=>"serviceRole", "description"=>"The name or full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to ECS, Auto Scaling, and EC2 on your behalf", "type"=>"string"}, {"in"=>"query", "name"=>"state", "description"=>"The state of the compute environment", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compute Environment"]}}, "/?Action=UpdateJobQueue"=>{"get"=>{"summary"=>"Update Job Queue", "description"=>"Updates a job queue.", "operationId"=>"updateJobQueue", "x-api-path-slug"=>"actionupdatejobqueue-get", "parameters"=>[{"in"=>"query", "name"=>"computeEnvironmentOrder", "description"=>"Details the set of compute environments mapped to a job queue and their order relative to each other", "type"=>"string"}, {"in"=>"query", "name"=>"jobQueue", "description"=>"The name or the Amazon Resource Name (ARN) of the job queue", "type"=>"string"}, {"in"=>"query", "name"=>"priority", "description"=>"The priority of the job queue", "type"=>"string"}, {"in"=>"query", "name"=>"state", "description"=>"Describes the queues ability to accept new jobs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Queue"]}}}}, "apis"=>{"name"=>"AWS Batch", "x-slug"=>"aws-batch", "description"=>"AWS Batch enables developers, scientists, and engineers to easily and efficiently run hundreds of thousands of batch computing jobs on AWS. AWS Batch dynamically provisions the optimal quantity and type of compute resources (e.g., CPU or memory optimized instances) based on the volume and specific resource requirements of the batch jobs submitted. With AWS Batch, there is no need to install and manage batch computing software or server clusters that you use to run your jobs, allowing you to focus on analyzing results and solving problems. AWS Batch plans, schedules, and executes your batch computing workloads across the full range of AWS compute services and features, such as Amazon EC2 and Spot Instances.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-batch.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Data,Jobs,Profiles,Relative Data,Research,Science,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-batch/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Batch API", "x-api-slug"=>"aws-batch-api", "description"=>"AWS Batch enables developers, scientists, and engineers to easily and efficiently run hundreds of thousands of batch computing jobs on AWS. AWS Batch dynamically provisions the optimal quantity and type of compute resources (e.g., CPU or memory optimized instances) based on the volume and specific resource requirements of the batch jobs submitted. With AWS Batch, there is no need to install and manage batch computing software or server clusters that you use to run your jobs, allowing you to focus on analyzing results and solving problems. AWS Batch plans, schedules, and executes your batch computing workloads across the full range of AWS compute services and features, such as Amazon EC2 and Spot Instances.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-batch.jpg", "humanURL"=>"https://aws.amazon.com/batch/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Data,Jobs,Profiles,Relative Data,Research,Science,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-batch/actionupdatejobqueue-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-batch/aws-batch-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/batch/latest/APIReference/API_Operations.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/batch/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/batch/pricing/"}, {"type"=>"x-use-cases", "url"=>"https://aws.amazon.com/batch/use-cases/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/batch/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
opendatasoft{"opendatasoft-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"OpenDataSoft", "x-complete"=>1, "info"=>{"title"=>"OpenDataSoft", "description"=>"opendatasoft-is-a-cloudbased-turnkey-platform-for-data-publishing-and-api-management--its-interface-is-intuitively-designed-to-empower-anyone-regardless-of-technical-skills-to-upload-easytounderstand-open-data-or-to-even-share-data-within-an-admi---", "version"=>"2.1.0"}, "host"=>"public.opendatasoft.com", "basePath"=>"/api/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/"=>{"get"=>{"summary"=>"Get", "description"=>"API entry point\n\nProvides links for:\n* catalog, your domain's list of datasets\n* opendatasoft, all datasets on the OpenDataSoft network", "operationId"=>"getRoot", "x-api-path-slug"=>"get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/pages"=>{"get"=>{"summary"=>"Get Pages", "description"=>"List of all pages from this portal.", "operationId"=>"getPages", "x-api-path-slug"=>"pages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages"]}}, "/pages/{slug}"=>{"get"=>{"summary"=>"Get Pages Slug", "description"=>"A single page's metadata from this portal", "operationId"=>"getPage", "x-api-path-slug"=>"pagesslug-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages", "Slug"]}}, "/{source}"=>{"get"=>{"summary"=>"Get Source", "description"=>"Source entry points\n\nProvides links for the source's datasets and metadata.", "operationId"=>"getSource", "x-api-path-slug"=>"source-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source"]}}, "/{source}/aggregates"=>{"get"=>{"summary"=>"Get Source Aggregates", "description"=>"Compute aggregations from catalog and return a list of each aggregate indexed by their names.", "operationId"=>"aggregateDatasets", "x-api-path-slug"=>"sourceaggregates-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Aggregates"]}}, "/{source}/datasets"=>{"get"=>{"summary"=>"Get Source Datasets", "description"=>"List of available datasets, each with their endpoints, paginated.\n\nLinks provided:\n* previous page\n* next page\n* last page\n* first page", "operationId"=>"getDatasets", "x-api-path-slug"=>"sourcedatasets-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets"]}}, "/{source}/datasets/{dataset_id}"=>{"get"=>{"summary"=>"Get Source Datasets Dataset", "description"=>"List of available endpoints for the specified dataset, with metadata and endpoints.\n\nWill provide links for:\n* the attachments endpoint\n* the files endpoint\n* the records endpoint\n* the catalog endpoint", "operationId"=>"getDataset", "x-api-path-slug"=>"sourcedatasetsdataset-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id"]}}, "/{source}/datasets/{dataset_id}/aggregates"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Aggregates", "description"=>"Compute aggregations from dataset records and return a list of each aggregate indexed by their names.", "operationId"=>"aggregateRecords", "x-api-path-slug"=>"sourcedatasetsdataset-idaggregates-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Aggregates"]}}, "/{source}/datasets/{dataset_id}/attachments"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Attachments", "description"=>"Get list of all available attachments", "operationId"=>"getDatasetAttachements", "x-api-path-slug"=>"sourcedatasetsdataset-idattachments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Attachments"]}}, "/{source}/datasets/{dataset_id}/attachments/{attachment_id}"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Attachments Attachment", "description"=>"Download attachment", "operationId"=>"downloadDatasetAttachement", "x-api-path-slug"=>"sourcedatasetsdataset-idattachmentsattachment-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Attachments", "Attachment", "Id"]}}, "/{source}/datasets/{dataset_id}/exports/csv"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Exports Csv", "description"=>"Export dataset in CSV format", "operationId"=>"exportRecordsCSV", "x-api-path-slug"=>"sourcedatasetsdataset-idexportscsv-get", "parameters"=>[{"in"=>"query", "name"=>"delimiter", "description"=>"Provide a different delimiter (default ,)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Exports", "Csv"]}}, "/{source}/datasets/{dataset_id}/exports/geojson"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Exports Geojson", "description"=>"Export dataset in GEOJSON format", "operationId"=>"exportRecordsGEOJSON", "x-api-path-slug"=>"sourcedatasetsdataset-idexportsgeojson-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Exports", "Geojson"]}}, "/{source}/datasets/{dataset_id}/exports/ical"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Exports Ical", "description"=>"Export dataset in ICAL format", "operationId"=>"exportRecordsICAL", "x-api-path-slug"=>"sourcedatasetsdataset-idexportsical-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Exports", "Ical"]}}, "/{source}/datasets/{dataset_id}/exports/json"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Exports Json", "description"=>"Export dataset in JSON format", "operationId"=>"exportRecordsJSON", "x-api-path-slug"=>"sourcedatasetsdataset-idexportsjson-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Exports", "Json"]}}, "/{source}/datasets/{dataset_id}/exports/ov2"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Exports Ov2", "description"=>"Export dataset in OV2 format", "operationId"=>"exportRecordsOV2", "x-api-path-slug"=>"sourcedatasetsdataset-idexportsov2-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Exports", "Ov2"]}}, "/{source}/datasets/{dataset_id}/exports/shp"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Exports Shp", "description"=>"Export dataset in Esri shapefile (shp) format", "operationId"=>"exportRecordsSHP", "x-api-path-slug"=>"sourcedatasetsdataset-idexportsshp-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Exports", "Shp"]}}, "/{source}/datasets/{dataset_id}/exports/xls"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Exports Xls", "description"=>"Export dataset in XLS (Excel) format", "operationId"=>"exportRecordsXLS", "x-api-path-slug"=>"sourcedatasetsdataset-idexportsxls-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Exports", "Xls"]}}, "/{source}/datasets/{dataset_id}/feedback"=>{"put"=>{"summary"=>"Put Source Datasets Dataset Feedback", "description"=>"Create new feedback entry.", "operationId"=>"sendDatasetFeedback", "x-api-path-slug"=>"sourcedatasetsdataset-idfeedback-put", "parameters"=>[{"in"=>"body", "name"=>"feedback", "description"=>"Feedback entry", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Feedback"]}}, "/{source}/datasets/{dataset_id}/files/{file_id}"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Files File", "description"=>"Download file", "operationId"=>"getDatasetFile", "x-api-path-slug"=>"sourcedatasetsdataset-idfilesfile-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Files", "File", "Id"]}}, "/{source}/datasets/{dataset_id}/records"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Records", "description"=>"Search dataset's records.", "operationId"=>"getRecords", "x-api-path-slug"=>"sourcedatasetsdataset-idrecords-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Records"]}}, "/{source}/datasets/{dataset_id}/records/{record_id}"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Records Record", "description"=>"Retrieve a single record based on its ID.", "operationId"=>"getRecord", "x-api-path-slug"=>"sourcedatasetsdataset-idrecordsrecord-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Records", "Record", "Id"]}}, "/{source}/datasets/{dataset_id}/reuses"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Reuses", "description"=>"Get list of reuses", "operationId"=>"getDatasetReuses", "x-api-path-slug"=>"sourcedatasetsdataset-idreuses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Reuses"]}}, "/{source}/datasets/{dataset_id}/reuses/{reuse_id}"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Reuses Reuse", "description"=>"Retrieve a single reuse based on its ID.", "operationId"=>"getDatasetReuse", "x-api-path-slug"=>"sourcedatasetsdataset-idreusesreuse-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Reuses", "Reuse", "Id"]}}, "/{source}/datasets/{dataset_id}/snapshots"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Snapshots", "description"=>"List of all snapshots for this dataset.", "operationId"=>"getDatasetSnapshots", "x-api-path-slug"=>"sourcedatasetsdataset-idsnapshots-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Snapshots"]}}, "/{source}/datasets/{dataset_id}/snapshots/{snapshot_id}"=>{"get"=>{"summary"=>"Get Source Datasets Dataset Snapshots Snapshot", "description"=>"List of all snapshots for this dataset.", "operationId"=>"downloadDatasetSnapshot", "x-api-path-slug"=>"sourcedatasetsdataset-idsnapshotssnapshot-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Datasets", "Dataset", "Id", "Snapshots", "Snapshot", "Id"]}}, "/{source}/exports/csv"=>{"get"=>{"summary"=>"Get Source Exports Csv", "description"=>"Export catalog (source) in CSV format", "operationId"=>"exportDatasetsCSV", "x-api-path-slug"=>"sourceexportscsv-get", "parameters"=>[{"in"=>"query", "name"=>"delimiter", "description"=>"Provide a different delimiter (default ,)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Exports", "Csv"]}}, "/{source}/exports/json"=>{"get"=>{"summary"=>"Get Source Exports Json", "description"=>"Export catalog (source) in JSON format", "operationId"=>"exportDatasetsJson", "x-api-path-slug"=>"sourceexportsjson-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Exports", "Json"]}}, "/{source}/exports/rdf"=>{"get"=>{"summary"=>"Get Source Exports Rdf", "description"=>"Export catalog (source) in RDF/XML format", "operationId"=>"exportDatasetsRDF", "x-api-path-slug"=>"sourceexportsrdf-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Exports", "Rdf"]}}, "/{source}/exports/rss"=>{"get"=>{"summary"=>"Get Source Exports Rss", "description"=>"Export catalog (source) in RSS format", "operationId"=>"exportDatasetsRSS", "x-api-path-slug"=>"sourceexportsrss-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Exports", "Rss"]}}, "/{source}/exports/ttl"=>{"get"=>{"summary"=>"Get Source Exports Ttl", "description"=>"Export catalog (source) in TTL (turtle/rdf) format", "operationId"=>"exportDatasetsTTL", "x-api-path-slug"=>"sourceexportsttl-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Exports", "Ttl"]}}, "/{source}/exports/xls"=>{"get"=>{"summary"=>"Get Source Exports Xls", "description"=>"Export catalog (source) in XLS (Excel) format", "operationId"=>"exportDatasetsXLS", "x-api-path-slug"=>"sourceexportsxls-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Exports", "Xls"]}}, "/{source}/metadata_templates"=>{"get"=>{"summary"=>"Get Source Metadata Templates", "description"=>"List of available metadata templates types, each with their endpoints.", "operationId"=>"getMetadataTemplatesTypes", "x-api-path-slug"=>"sourcemetadata-templates-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Metadata", "Templates"]}}, "/{source}/metadata_templates/{metadata_template_type}"=>{"get"=>{"summary"=>"Get Source Metadata Templates Metadata Template Type", "description"=>"List of metadata templates available for this type.", "operationId"=>"getMetadataTemplatesType", "x-api-path-slug"=>"sourcemetadata-templatesmetadata-template-type-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Metadata", "Templates", "Metadata", "Template", "Type"]}}, "/{source}/metadata_templates/{metadata_template_type}/{metadata_template_name}"=>{"get"=>{"summary"=>"Get Source Metadata Templates Metadata Template Type Metadata Template Name", "description"=>"A single metadata_template", "operationId"=>"getMetadataTemplate", "x-api-path-slug"=>"sourcemetadata-templatesmetadata-template-typemetadata-template-name-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Metadata", "Templates", "Metadata", "Template", "Type", "Metadata", "Template", "Name"]}}}}, "apis"=>{"name"=>"OpenDataSoft", "x-slug"=>"opendatasoft", "description"=>"OpenDataSoft is a cloud-based turnkey platform for data publishing and API management. Its interface is intuitively designed to empower anyone, regardless of technical skills, to upload easy-to-understand Open Data, or to even share data within an admi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2716-opendatasoft.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"323884", "tags"=>"Cities,Data,Enterprise,General Data,Government,Relative Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"opendatasoft/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"OpenDataSoft", "x-api-slug"=>"opendatasoft", "description"=>"OpenDataSoft is a cloud-based turnkey platform for data publishing and API management. Its interface is intuitively designed to empower anyone, regardless of technical skills, to upload easy-to-understand Open Data, or to even share data within an admi...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2716-opendatasoft.jpg", "humanURL"=>"http://opendatasoft.com", "baseURL"=>"https://public.opendatasoft.com//api/v2", "tags"=>"Cities,Data,Enterprise,General Data,Government,Relative Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/opendatasoft/opendatasoft-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://www.opendatasoft.com/category/news/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/opendatasoft"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/opendatasoft"}, {"type"=>"x-email", "url"=>"contact@opendatasoft.com"}, {"type"=>"x-email", "url"=>"cil@opendatasoft.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/opendatasoft"}, {"type"=>"x-website", "url"=>"http://opendatasoft.com"}, {"type"=>"x-website", "url"=>"https://www.opendatasoft.com"}, {"type"=>"x-website", "url"=>"http://www.opendatasoft.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
capital-one-devexchange{"capital-one-devexchange-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Capital One DevExchange", "x-complete"=>1, "info"=>{"title"=>"Capital One DevExchange", "description"=>"nessie-is-capital-ones-hackathon-api-that-gives-you-access-to-a-multitude-of-real-publicfacing-data--such-as-atm-and-bank-branch-locations--along-with-mock-customer-account-data--use-http-requests-to-set-up-peertopeer-transactions-simulate-a-weekly-paycheck-or-even-schedule-bills-for-customers-this-is-all-structured-in-a-way-that-resembles-how-we-actually-run-things-here-at-capital-one-", "version"=>"1.0.0"}, "host"=>"api.reimaginebanking.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/accounts"=>{"get"=>{"summary"=>"Get all accounts", "description"=>"Returns the accounts that have been assigned to you.", "operationId"=>"returns-the-accounts-that-have-been-assigned-to-you", "x-api-path-slug"=>"accounts-get", "parameters"=>[{"in"=>"query", "name"=>"type", "description"=>"Empty Param will return all types of accounts"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts"]}}, "/accounts/{id}"=>{"get"=>{"summary"=>"Get account by id", "description"=>"Returns the account with the specific id", "operationId"=>"returns-the-account-with-the-specific-id", "x-api-path-slug"=>"accountsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of account that needs to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts"]}, "put"=>{"summary"=>"Update a specific existing account", "description"=>"Updates the specific account", "operationId"=>"updates-the-specific-account", "x-api-path-slug"=>"accountsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Updated account object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of account that needs to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts"]}, "delete"=>{"summary"=>"Delete a specific existing account", "description"=>"Deletes the specific account", "operationId"=>"deletes-the-specific-account", "x-api-path-slug"=>"accountsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of account that needs to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts"]}}, "/customers/{id}/accounts"=>{"post"=>{"summary"=>"Create an account", "description"=>"Creates an account for the customer with the id provided", "operationId"=>"creates-an-account-for-the-customer-with-the-id-provided", "x-api-path-slug"=>"customersidaccounts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Account to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of customer that account will belong to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Customers", "", "Accounts"]}, "get"=>{"summary"=>"Get accounts by customer id", "description"=>"Returns the accounts associated with the specific customer", "operationId"=>"returns-the-accounts-associated-with-the-specific-customer", "x-api-path-slug"=>"customersidaccounts-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of customer to fetch accounts for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Customers", "", "Accounts"]}}, "/accounts/{id}/customer"=>{"get"=>{"summary"=>"Get customer that owns the specified account", "description"=>"Returns the customer that the account belongs to.", "operationId"=>"returns-the-customer-that-the-account-belongs-to", "x-api-path-slug"=>"accountsidcustomer-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of customer that account will belong to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts", "", "Customer"]}}, "/atms"=>{"get"=>{"summary"=>"Get all ATMs", "description"=>"Returns all of the Capital One ATMs in the speified search area.", "operationId"=>"returns-all-of-the-capital-one-atms-in-the-speified-search-area", "x-api-path-slug"=>"atms-get", "parameters"=>[{"in"=>"query", "name"=>"lat", "description"=>"Latitude of where youre looking for an ATM"}, {"in"=>"query", "name"=>"lng", "description"=>"Longitude of where youre looking for an ATM"}, {"in"=>"query", "name"=>"rad", "description"=>"Search radius in miles"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Atms"]}}, "/atms/{id}"=>{"get"=>{"summary"=>"Get ATM by id", "description"=>"Returns the ATM with the specific id", "operationId"=>"returns-the-atm-with-the-specific-id", "x-api-path-slug"=>"atmsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of ATM that needs to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Atms"]}}, "/accounts/{id}/bills"=>{"get"=>{"summary"=>"Get all bills for a specific account", "description"=>"Returns the bills that are tied to the specific account.", "operationId"=>"returns-the-bills-that-are-tied-to-the-specific-account", "x-api-path-slug"=>"accountsidbills-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of account to fetch bills for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts", "", "Bills"]}, "post"=>{"summary"=>"Create a bill", "description"=>"Creates a bill for the specific account", "operationId"=>"creates-a-bill-for-the-specific-account", "x-api-path-slug"=>"accountsidbills-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Bill to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of account that the bill will belong to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts", "", "Bills"]}}, "/bills/{billId}"=>{"get"=>{"summary"=>"Get bill by id", "description"=>"Returns the bill with the specific id", "operationId"=>"returns-the-bill-with-the-specific-id", "x-api-path-slug"=>"billsbillid-get", "parameters"=>[{"in"=>"path", "name"=>"billId", "description"=>"ID of the bill to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Bills", "Bill"]}, "put"=>{"summary"=>"Update a specific existing bill", "description"=>"Updates the specific bill", "operationId"=>"updates-the-specific-bill", "x-api-path-slug"=>"billsbillid-put", "parameters"=>[{"in"=>"path", "name"=>"billId", "description"=>"ID of the bill to update"}, {"in"=>"body", "name"=>"body", "description"=>"Bill to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Bills", "Bill"]}, "delete"=>{"summary"=>"Delete a specific existing bill", "description"=>"Deletes the specific bill", "operationId"=>"deletes-the-specific-bill", "x-api-path-slug"=>"billsbillid-delete", "parameters"=>[{"in"=>"path", "name"=>"billId", "description"=>"ID of the bill to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Bills", "Bill"]}}, "/branches"=>{"get"=>{"summary"=>"Get all branches", "description"=>"Returns all of the Capital One branches.", "operationId"=>"returns-all-of-the-capital-one-branches", "x-api-path-slug"=>"branches-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Branches"]}}, "/branches/{id}"=>{"get"=>{"summary"=>"Get branch by id", "description"=>"Returns the branch with the specific id", "operationId"=>"returns-the-branch-with-the-specific-id", "x-api-path-slug"=>"branchesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of branch that needs to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Branches"]}}, "/customers"=>{"get"=>{"summary"=>"Get all customers", "description"=>"Returns the customers that have been assigned to you.", "operationId"=>"returns-the-customers-that-have-been-assigned-to-you", "x-api-path-slug"=>"customers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Customers"]}, "post"=>{"summary"=>"Create a customer", "description"=>"Creates a customer", "operationId"=>"creates-a-customer", "x-api-path-slug"=>"customers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Customer to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Customers"]}}, "/customers/{id}"=>{"get"=>{"summary"=>"Get customer by id", "description"=>"Returns the customer with the specific id", "operationId"=>"returns-the-customer-with-the-specific-id", "x-api-path-slug"=>"customersid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of customer that needs to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Customers"]}, "put"=>{"summary"=>"Update a specific existing customer", "description"=>"Updates the specific customer", "operationId"=>"updates-the-specific-customer", "x-api-path-slug"=>"customersid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Updated customer object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of customer that needs to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Customers"]}}, "/customers/{id}/bills"=>{"get"=>{"summary"=>"Get bills by customer id", "description"=>"Returns the bills associated with the specific customer", "operationId"=>"returns-the-bills-associated-with-the-specific-customer", "x-api-path-slug"=>"customersidbills-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of customer to fetch bills for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Customers", "", "Bills"]}}, "/data"=>{"delete"=>{"summary"=>"Delete data associated with your API key.", "description"=>"This endpoint deletes any data associated with your API key and of the type passed in as query parameters. If you do not specify any type to delete, no data will be deleted.", "operationId"=>"this-endpoint-deletes-any-data-associated-with-your-api-key-and-of-the-type-passed-in-as-query-param", "x-api-path-slug"=>"data-delete", "parameters"=>[{"in"=>"query", "name"=>"type", "description"=>"Collection to delete data from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Data"]}}, "/accounts/{id}/deposits"=>{"get"=>{"summary"=>"Get all deposits", "description"=>"Returns the deposits that you are involved in.", "operationId"=>"returns-the-deposits-that-you-are-involved-in", "x-api-path-slug"=>"accountsiddeposits-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of account associated with the deposit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts", "", "Deposits"]}, "post"=>{"summary"=>"Create a deposit", "description"=>"Creates a deposit where the account with the ID specified receives the amount.", "operationId"=>"creates-a-deposit-where-the-account-with-the-id-specified-receives-the-amount", "x-api-path-slug"=>"accountsiddeposits-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Deposit to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of account receiver of deposit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts", "", "Deposits"]}}, "/deposits/{id}"=>{"get"=>{"summary"=>"Get deposit by id", "description"=>"Returns the deposit with the specific id", "operationId"=>"returns-the-deposit-with-the-specific-id", "x-api-path-slug"=>"depositsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the deposit that is being fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Deposits"]}, "put"=>{"summary"=>"Update a specific existing deposit", "description"=>"Updates the specific deposit", "operationId"=>"updates-the-specific-deposit", "x-api-path-slug"=>"depositsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"deposit to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of the deposit that is being updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Deposits"]}, "delete"=>{"summary"=>"Delete a specific existing deposit", "description"=>"Deletes the specific deposit", "operationId"=>"deletes-the-specific-deposit", "x-api-path-slug"=>"depositsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the deposit that is being deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Deposits"]}}, "/accounts/{id}/loans"=>{"get"=>{"summary"=>"Get all loans", "description"=>"Returns the loans that you are involved in.", "operationId"=>"returns-the-loans-that-you-are-involved-in", "x-api-path-slug"=>"accountsidloans-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of account associated with the loan"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts", "", "Loans"]}, "post"=>{"summary"=>"Create a loan", "description"=>"Creates a loan where the account with the ID specified is debitted.", "operationId"=>"creates-a-loan-where-the-account-with-the-id-specified-is-debitted", "x-api-path-slug"=>"accountsidloans-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"loan to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of account receiver of loan"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts", "", "Loans"]}}, "/loans/{id}"=>{"get"=>{"summary"=>"Get loan by id", "description"=>"Returns the loan with the specific id", "operationId"=>"returns-the-loan-with-the-specific-id", "x-api-path-slug"=>"loansid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the loan that is being fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Loans"]}, "put"=>{"summary"=>"Update a specific existing loan", "description"=>"Updates the specific loan", "operationId"=>"updates-the-specific-loan", "x-api-path-slug"=>"loansid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"loan to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of the loan that is being updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Loans"]}, "delete"=>{"summary"=>"Delete a specific existing loan", "description"=>"Deletes the specific loan", "operationId"=>"deletes-the-specific-loan", "x-api-path-slug"=>"loansid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the loan that is being deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Loans"]}}, "/merchants"=>{"get"=>{"summary"=>"Get all merchants", "description"=>"Returns the merchants that have been assigned to you.", "operationId"=>"returns-the-merchants-that-have-been-assigned-to-you", "x-api-path-slug"=>"merchants-get", "parameters"=>[{"in"=>"query", "name"=>"lat", "description"=>"Latitude of where youre looking for a merchant"}, {"in"=>"query", "name"=>"lng", "description"=>"Longitude of where youre looking for a merchant"}, {"in"=>"query", "name"=>"rad", "description"=>"Search radius in miles"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Merchants"]}, "post"=>{"summary"=>"Create a merchant", "description"=>"Creates a merchant", "operationId"=>"creates-a-merchant", "x-api-path-slug"=>"merchants-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Merchant to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Merchants"]}}, "/merchants/{id}"=>{"get"=>{"summary"=>"Get merchant by id", "description"=>"Returns the merchant with the specific id", "operationId"=>"returns-the-merchant-with-the-specific-id", "x-api-path-slug"=>"merchantsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of merchant that needs to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Merchants"]}, "put"=>{"summary"=>"Update a specific existing merchant", "description"=>"Updates the specific merchant", "operationId"=>"updates-the-specific-merchant", "x-api-path-slug"=>"merchantsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Updated merchant object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of merchant that needs to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Merchants"]}}, "/accounts/{id}/purchases"=>{"get"=>{"summary"=>"Get all purchases", "description"=>"Returns the purchases that you are involved in.", "operationId"=>"returns-the-purchases-that-you-are-involved-in", "x-api-path-slug"=>"accountsidpurchases-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of account associated with the purchase"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts", "", "Purchases"]}, "post"=>{"summary"=>"Create a purchase", "description"=>"Creates a purchase where the account with the ID specified is the payer.", "operationId"=>"creates-a-purchase-where-the-account-with-the-id-specified-is-the-payer", "x-api-path-slug"=>"accountsidpurchases-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Purchase to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of account payer in purchase"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts", "", "Purchases"]}}, "/purchases/{id}"=>{"get"=>{"summary"=>"Get purchase by id", "description"=>"Returns the purchase with the specific id", "operationId"=>"returns-the-purchase-with-the-specific-id", "x-api-path-slug"=>"purchasesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the purchase that is being fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Purchases"]}, "delete"=>{"summary"=>"Delete a specific existing purchase", "description"=>"Deletes the specific purchase", "operationId"=>"deletes-the-specific-purchase", "x-api-path-slug"=>"purchasesid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the purchase that is being deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Purchases"]}, "put"=>{"summary"=>"Update a specific existing purchase", "description"=>"Updates the specific purchase", "operationId"=>"updates-the-specific-purchase", "x-api-path-slug"=>"purchasesid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Purchase to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of the purchase that is being updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Purchases"]}}, "/merchants/{id}/purchases"=>{"get"=>{"summary"=>"Get all purchases by merchant", "description"=>"Returns the purchases that a merchant is involved in.", "operationId"=>"returns-the-purchases-that-a-merchant-is-involved-in", "x-api-path-slug"=>"merchantsidpurchases-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the merchant associated with all the purchases"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Merchants", "", "Purchases"]}}, "/merchants/{id}/accounts/{accountId}/purchases"=>{"get"=>{"summary"=>"Get all purchases by account and merchant", "description"=>"Returns the purchases that a merchant is involved in.", "operationId"=>"returns-the-purchases-that-a-merchant-is-involved-in", "x-api-path-slug"=>"merchantsidaccountsaccountidpurchases-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"ID of the account associated with all the purchases"}, {"in"=>"path", "name"=>"id", "description"=>"ID of the merchant associated with all the purchases"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Merchants", "", "Accounts", "Account", "Purchases"]}}, "/accounts/{id}/transfers"=>{"get"=>{"summary"=>"Get all transfers", "description"=>"Returns the transfers that you are involved in.", "operationId"=>"returns-the-transfers-that-you-are-involved-in", "x-api-path-slug"=>"accountsidtransfers-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of account associated with the transfer"}, {"in"=>"query", "name"=>"type", "description"=>"When param is empty, will return transfers associated with account where account is payer AND payee"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts", "", "Transfers"]}, "post"=>{"summary"=>"Create a transfer", "description"=>"Creates a transfer where the account with the ID specified is the payer.", "operationId"=>"creates-a-transfer-where-the-account-with-the-id-specified-is-the-payer", "x-api-path-slug"=>"accountsidtransfers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Transfer to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of account payer in transfer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts", "", "Transfers"]}}, "/transfers/{transferId}"=>{"get"=>{"summary"=>"Get transfer by id", "description"=>"Returns the transfer with the specific id", "operationId"=>"returns-the-transfer-with-the-specific-id", "x-api-path-slug"=>"transferstransferid-get", "parameters"=>[{"in"=>"path", "name"=>"transferId", "description"=>"ID of the transfer that is being fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Transfers", "Transfer"]}, "put"=>{"summary"=>"Update a specific existing transfer", "description"=>"Updates the specific transfer", "operationId"=>"updates-the-specific-transfer", "x-api-path-slug"=>"transferstransferid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Transfer to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"transferId", "description"=>"ID of the transfer that is being updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Transfers", "Transfer"]}, "delete"=>{"summary"=>"Delete a specific existing transfer", "description"=>"Deletes the specific transfer", "operationId"=>"deletes-the-specific-transfer", "x-api-path-slug"=>"transferstransferid-delete", "parameters"=>[{"in"=>"path", "name"=>"transferId", "description"=>"ID of the transfer that is being deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Transfers", "Transfer"]}}, "/accounts/{id}/withdrawals"=>{"get"=>{"summary"=>"Get all withdrawals", "description"=>"Returns the withdrawals that you are involved in.", "operationId"=>"returns-the-withdrawals-that-you-are-involved-in", "x-api-path-slug"=>"accountsidwithdrawals-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of account associated with the withdrawal"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts", "", "Withdrawals"]}, "post"=>{"summary"=>"Create a withdrawal", "description"=>"Creates a withdrawal where the account with the ID specified is debitted.", "operationId"=>"creates-a-withdrawal-where-the-account-with-the-id-specified-is-debitted", "x-api-path-slug"=>"accountsidwithdrawals-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Withdrawal to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of account receiver of withdrawal"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Accounts", "", "Withdrawals"]}}, "/withdrawals/{id}"=>{"get"=>{"summary"=>"Get withdrawal by id", "description"=>"Returns the withdrawal with the specific id", "operationId"=>"returns-the-withdrawal-with-the-specific-id", "x-api-path-slug"=>"withdrawalsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the withdrawal that is being fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Withdrawals"]}, "put"=>{"summary"=>"Update a specific existing withdrawal", "description"=>"Updates the specific withdrawal", "operationId"=>"updates-the-specific-withdrawal", "x-api-path-slug"=>"withdrawalsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"withdrawal to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of the withdrawal that is being updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Withdrawals"]}, "delete"=>{"summary"=>"Delete a specific existing withdrawal", "description"=>"Deletes the specific withdrawal", "operationId"=>"deletes-the-specific-withdrawal", "x-api-path-slug"=>"withdrawalsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the withdrawal that is being deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Withdrawals"]}}}}, "apis"=>{"name"=>"Capital One DevExchange", "x-slug"=>"capital-one-devexchange", "description"=>"What unites us all is a desire to create better end customer experiences. Were building a full suite of tools and technology that make essential things in peoples everyday life – money, finances, identity – simpler for you. Now is the time to join our beta program, and help us shape the future.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/capitalone-devexchange.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,Profiles,Relative Data,Service API,US Bank", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"capital-one-devexchange/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Capital One DevExchange", "x-api-slug"=>"capital-one-devexchange", "description"=>"What unites us all is a desire to create better end customer experiences. Were building a full suite of tools and technology that make essential things in peoples everyday life – money, finances, identity – simpler for you. Now is the time to join our beta program, and help us shape the future.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/capitalone-devexchange.png", "humanURL"=>"http://capitalone.com", "baseURL"=>"https://api.reimaginebanking.com//", "tags"=>"API Provider,Profiles,Relative Data,Service API,US Bank", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/capital-one-devexchange/withdrawalsid-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/capital-one-devexchange/capital-one-devexchange-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://developer.capitalone.com/platform-documentation/authorization-with-oauth-20/"}, {"type"=>"x-blog", "url"=>"https://developer.capitalone.com/blogs/"}, {"type"=>"x-developer", "url"=>"https://developer.capitalone.com/"}, {"type"=>"x-documentation", "url"=>"https://developer.capitalone.com/platform-documentation/"}, {"type"=>"x-errors", "url"=>"https://developer.capitalone.com/platform-documentation/errors/"}, {"type"=>"x-getting-started", "url"=>"https://developer.capitalone.com/platform-documentation/getting-started/"}, {"type"=>"x-github", "url"=>"https://github.com/capitalone"}, {"type"=>"x-website", "url"=>"http://capitalone.com"}, {"type"=>"x-open-source", "url"=>"https://developer.capitalone.com/open-source/"}, {"type"=>"x-sandbox", "url"=>"https://developer.capitalone.com/platform-documentation/using-the-sandbox/"}, {"type"=>"x-login", "url"=>"https://developer.capitalone.com/sign-in/"}, {"type"=>"x-selfservice-registration", "url"=>"https://developer.capitalone.com/sign-up"}, {"type"=>"x-support", "url"=>"https://developer.capitalone.com/support/"}, {"type"=>"x-privacy-policy", "url"=>"https://www.capitalone.com/identity-protection/privacy/statement"}, {"type"=>"x-terms-of-service", "url"=>"https://developer.capitalone.com/single/terms-and-conditions/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/CapitalOneDevEx"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
angellist{"angellist-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AngelList", "x-complete"=>1, "info"=>{"title"=>"AngelList", "description"=>"the-angellist-api-provides-developers-with-a-restful-interface-to-the-angellist-data-set--for-more-information-read-the-oauth-faq-", "termsOfService"=>"https://angel.co/terms", "contact"=>{"name"=>"AngelList", "url"=>"https://angel.co/api", "email"=>"api@angel.co"}, "version"=>"v1"}, "host"=>"api.angel.co", "basePath"=>"/1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/accreditation"=>{"get"=>{"summary"=>"Get Accreditation", "description"=>"Pulls the accreditation for a startup and users.", "operationId"=>"accreditation", "x-api-path-slug"=>"accreditation-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses"]}}, "/comments"=>{"get"=>{"summary"=>"Get Comments", "description"=>"Pulls the comments for given object.", "operationId"=>"comments", "x-api-path-slug"=>"comments-get", "parameters"=>[{"in"=>"query", "name"=>"commentable_id"}, {"in"=>"query", "name"=>"commentable_type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Comments"]}, "post"=>{"summary"=>"Add Comment", "description"=>"Adds a comment for given object", "operationId"=>"comment", "x-api-path-slug"=>"comments-post", "parameters"=>[{"in"=>"query", "name"=>"comment"}, {"in"=>"query", "name"=>"commentable_id"}, {"in"=>"query", "name"=>"commentable_type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Comments"]}}, "/comments/{comment_id}"=>{"delete"=>{"summary"=>"Delete Comment", "description"=>"Deletes a comment for given object", "operationId"=>"comment", "x-api-path-slug"=>"commentscomment-id-delete", "parameters"=>[{"in"=>"path", "name"=>"comment_id", "description"=>"The comment id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Comments"]}}, "/follows"=>{"delete"=>{"summary"=>"Delete Follow", "description"=>"Delete the follow for given user or startup.", "operationId"=>"follows", "x-api-path-slug"=>"follows-delete", "parameters"=>[{"in"=>"query", "name"=>"id"}, {"in"=>"query", "name"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Follow"]}, "post"=>{"summary"=>"Add Follow", "description"=>"Add a follow for user or startup on AngelList.", "operationId"=>"follows", "x-api-path-slug"=>"follows-post", "parameters"=>[{"in"=>"query", "name"=>"id"}, {"in"=>"query", "name"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Follow"]}}, "/follows/batch"=>{"get"=>{"summary"=>"Get Batch of Follows", "description"=>"Returns a batched lists of follows", "operationId"=>"followsBatch", "x-api-path-slug"=>"followsbatch-get", "parameters"=>[{"in"=>"query", "name"=>"ids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Follow"]}}, "/follows/relationship"=>{"get"=>{"summary"=>"Get Follows Relationship", "description"=>"Gets the relationships for followers", "operationId"=>"followsRelationship", "x-api-path-slug"=>"followsrelationship-get", "parameters"=>[{"in"=>"query", "name"=>"source_id"}, {"in"=>"query", "name"=>"target_id"}, {"in"=>"query", "name"=>"target_type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Relationships"]}}, "/jobs"=>{"get"=>{"summary"=>"Get Jobs", "description"=>"Get jobs.", "operationId"=>"jobs", "x-api-path-slug"=>"jobs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Jobs"]}}, "/jobs/{job_id}"=>{"get"=>{"summary"=>"Get Job", "description"=>"Get job.", "operationId"=>"job", "x-api-path-slug"=>"jobsjob-id-get", "parameters"=>[{"in"=>"path", "name"=>"job_id", "description"=>"The id for the job"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Jobs"]}}, "/like"=>{"post"=>{"summary"=>"Add Like", "description"=>"Add like.", "operationId"=>"like", "x-api-path-slug"=>"like-post", "parameters"=>[{"in"=>"query", "name"=>"likable_id"}, {"in"=>"query", "name"=>"likable_type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Likes"]}}, "/likes"=>{"get"=>{"summary"=>"Get Likes", "description"=>"Get likes", "operationId"=>"likes", "x-api-path-slug"=>"likes-get", "parameters"=>[{"in"=>"query", "name"=>"likable_id"}, {"in"=>"query", "name"=>"likable_type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Likes"]}, "post"=>{"summary"=>"Add Like", "description"=>"Add Like", "operationId"=>"likes", "x-api-path-slug"=>"likes-post", "parameters"=>[{"in"=>"query", "name"=>"likable_id"}, {"in"=>"query", "name"=>"likable_type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Likes"]}}, "/likes/{like_id}"=>{"delete"=>{"summary"=>"Delete Like", "description"=>"Delete Like", "operationId"=>"likes", "x-api-path-slug"=>"likeslike-id-delete", "parameters"=>[{"in"=>"query", "name"=>"likable_type"}, {"in"=>"path", "name"=>"like_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Likes"]}}, "/me"=>{"get"=>{"summary"=>"Get Me", "description"=>"Get Me", "operationId"=>"me", "x-api-path-slug"=>"me-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses"]}}, "/press"=>{"get"=>{"summary"=>"Get Press", "description"=>"Get Press", "operationId"=>"press", "x-api-path-slug"=>"press-get", "parameters"=>[{"in"=>"query", "name"=>"startup_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Press"]}}, "/press/{press_id}"=>{"get"=>{"summary"=>"Get Press", "description"=>"Get Press", "operationId"=>"press", "x-api-path-slug"=>"presspress-id-get", "parameters"=>[{"in"=>"path", "name"=>"press_id"}, {"in"=>"query", "name"=>"startup_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Press"]}}, "/reviews"=>{"get"=>{"summary"=>"Get Reviews", "description"=>"Get Reviews", "operationId"=>"reviews", "x-api-path-slug"=>"reviews-get", "parameters"=>[{"in"=>"query", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Reviews"]}}, "/reviews/{review_id}"=>{"get"=>{"summary"=>"Get Review", "description"=>"Get Review", "operationId"=>"reviews", "x-api-path-slug"=>"reviewsreview-id-get", "parameters"=>[{"in"=>"path", "name"=>"review_id"}, {"in"=>"query", "name"=>"startup_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Reviews"]}}, "/search"=>{"get"=>{"summary"=>"Search AngelList", "description"=>"Search AngelList.", "operationId"=>"search", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"query"}, {"in"=>"query", "name"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Search"]}}, "/search/slugs"=>{"get"=>{"summary"=>"Search Slugs", "description"=>"Search by slug", "operationId"=>"search", "x-api-path-slug"=>"searchslugs-get", "parameters"=>[{"in"=>"query", "name"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Search"]}}, "/startups"=>{"get"=>{"summary"=>"Search Startups", "description"=>"Search Startups", "operationId"=>"startups", "x-api-path-slug"=>"startups-get", "parameters"=>[{"in"=>"query", "name"=>"filter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Search"]}}, "/startups/{startup_id}"=>{"get"=>{"summary"=>"Get Startup", "description"=>"Get Startup", "operationId"=>"startups", "x-api-path-slug"=>"startupsstartup-id-get", "parameters"=>[{"in"=>"path", "name"=>"startup_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses"]}}, "/startups/{startup_id}/comments"=>{"get"=>{"summary"=>"Get Startup Comments", "description"=>"Get Startup Comments", "operationId"=>"startupComments", "x-api-path-slug"=>"startupsstartup-idcomments-get", "parameters"=>[{"in"=>"path", "name"=>"startup_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Comments"]}}, "/startups/{startup_id}/followers"=>{"get"=>{"summary"=>"Get Startup Followers", "description"=>"Get Startup Followers", "operationId"=>"startupFollowers", "x-api-path-slug"=>"startupsstartup-idfollowers-get", "parameters"=>[{"in"=>"path", "name"=>"startup_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Followers"]}}, "/startups/{startup_id}/followers/ids"=>{"get"=>{"summary"=>"Get Startup Followers IDs", "description"=>"Get Startup Followers IDs", "operationId"=>"startupFollowersIDs", "x-api-path-slug"=>"startupsstartup-idfollowersids-get", "parameters"=>[{"in"=>"path", "name"=>"startup_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Followers"]}}, "/startups/{startup_id}/roles"=>{"get"=>{"summary"=>"Get Startup Roles", "description"=>"Get Startup Roles", "operationId"=>"startupRoles", "x-api-path-slug"=>"startupsstartup-idroles-get", "parameters"=>[{"in"=>"path", "name"=>"startup_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Roles"]}}, "/startup_roles"=>{"get"=>{"summary"=>"Get Startup Roles", "description"=>"Get Startup Roles", "operationId"=>"1Startup_roles", "x-api-path-slug"=>"startup-roles-get", "parameters"=>[{"in"=>"query", "name"=>"startup_id"}, {"in"=>"query", "name"=>"v"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Roles"]}}, "/status_updates"=>{"get"=>{"summary"=>"Get Status Updates", "description"=>"Get Status Updates", "operationId"=>"1Status_updates", "x-api-path-slug"=>"status-updates-get", "parameters"=>[{"in"=>"query", "name"=>"startup_id"}, {"in"=>"query", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Status"]}, "post"=>{"summary"=>"Add Status Update", "description"=>"Add Status Update", "operationId"=>"statusUpdate", "x-api-path-slug"=>"status-updates-post", "parameters"=>[{"in"=>"query", "name"=>"message"}, {"in"=>"query", "name"=>"startup_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Status"]}}, "/status_updates/{status_update_id}"=>{"delete"=>{"summary"=>"Delete Status Update", "description"=>"Delete Status Update", "operationId"=>"statusUpdate", "x-api-path-slug"=>"status-updatesstatus-update-id-delete", "parameters"=>[{"in"=>"query", "name"=>"message"}, {"in"=>"query", "name"=>"startup_id"}, {"in"=>"path", "name"=>"status_update_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Status"]}}, "/tags/{tag_id}"=>{"get"=>{"summary"=>"Get Tag", "description"=>"Get Tag", "operationId"=>"tags", "x-api-path-slug"=>"tagstag-id-get", "parameters"=>[{"in"=>"path", "name"=>"tag_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Tags"]}}, "/tags/{tag_id}/children"=>{"get"=>{"summary"=>"Get Tags Children", "description"=>"Get Tags Children", "operationId"=>"tagsChildren", "x-api-path-slug"=>"tagstag-idchildren-get", "parameters"=>[{"in"=>"path", "name"=>"tag_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Tags"]}}, "/tags/{tag_id}/jobs"=>{"get"=>{"summary"=>"Get Jobs by Tag", "description"=>"Get Jobs by Tag", "operationId"=>"jobs", "x-api-path-slug"=>"tagstag-idjobs-get", "parameters"=>[{"in"=>"path", "name"=>"tag_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Tags"]}}, "/tags/{tag_id}/parents"=>{"get"=>{"summary"=>"Get Tag Parents", "description"=>"Get Tag Parents", "operationId"=>"tagParents", "x-api-path-slug"=>"tagstag-idparents-get", "parameters"=>[{"in"=>"path", "name"=>"tag_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Tags"]}}, "/tags/{tag_id}/startups"=>{"get"=>{"summary"=>"Get Startups by Tag", "description"=>"Get Startups by Tag", "operationId"=>"tagStartups", "x-api-path-slug"=>"tagstag-idstartups-get", "parameters"=>[{"in"=>"path", "name"=>"tag_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Tags"]}}, "/tags/{tag_id}/users"=>{"get"=>{"summary"=>"Get Users by Tag", "description"=>"Get Users by Tag", "operationId"=>"tagUsers", "x-api-path-slug"=>"tagstag-idusers-get", "parameters"=>[{"in"=>"path", "name"=>"tag_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Tags", "Users"]}}, "/users/search"=>{"get"=>{"summary"=>"User Search", "description"=>"User Search", "operationId"=>"users", "x-api-path-slug"=>"userssearch-get", "parameters"=>[{"in"=>"query", "name"=>"slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Users"]}}, "/users/{user_id}"=>{"get"=>{"summary"=>"Get User", "description"=>"Get User", "operationId"=>"user", "x-api-path-slug"=>"usersuser-id-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Users"]}}, "/users/{user_id}/followers"=>{"get"=>{"summary"=>"Get User Followers", "description"=>"Get User Followers", "operationId"=>"userFollowers", "x-api-path-slug"=>"usersuser-idfollowers-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Users", "Followers"]}}, "/users/{user_id}/followers/ids"=>{"get"=>{"summary"=>"Get User Follower IDs", "description"=>"Get User Follower IDs", "operationId"=>"users", "x-api-path-slug"=>"usersuser-idfollowersids-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Users", "Followers"]}}, "/users/{user_id}/following"=>{"get"=>{"summary"=>"Get Users Following", "description"=>"Get Users Following", "operationId"=>"usersFollowing", "x-api-path-slug"=>"usersuser-idfollowing-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Users", "Followers"]}}, "/users/{user_id}/following/ids"=>{"get"=>{"summary"=>"Get User Following IDs", "description"=>"Get User Following IDs", "operationId"=>"userFollowingIDs", "x-api-path-slug"=>"usersuser-idfollowingids-get", "parameters"=>[{"in"=>"path", "name"=>"user_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Startups", "Businesses", "Users", "Followers"]}}}}, "apis"=>{"name"=>"AngelList", "x-slug"=>"angellist", "description"=>"AngelList is where the world meets startups. Find a great startup job, invest in a startup, or raise money", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/339-angellist.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"2447", "tags"=>"Angellist API Stack,API Provider,Business,Directories,General Data,internet,Investing,Marketplace,Media,My API Stack,Profiles,Relative Data,SDIO Data,Stack Network,Startup,Startups", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"angellist/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AngelList", "x-api-slug"=>"angellist", "description"=>"AngelList is where the world meets startups. Find a great startup job, invest in a startup, or raise money", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/339-angellist.jpg", "humanURL"=>"http://angel.co", "baseURL"=>"https://api.angel.co//1/", "tags"=>"Angellist API Stack,API Provider,Business,Directories,General Data,internet,Investing,Marketplace,Media,My API Stack,Profiles,Relative Data,SDIO Data,Stack Network,Startup,Startups", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/angellist/usersuser-idfollowingids-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/angellist/angellist-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://blog.angel.co"}, {"type"=>"x-base-url", "url"=>"http://api.angel.co/"}, {"type"=>"x-blog", "url"=>"http://blog.angel.co"}, {"type"=>"x-blog-rss", "url"=>"http://blog.angel.co/rss"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/angellist"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/angellist"}, {"type"=>"x-developer", "url"=>"https://angel.co/api"}, {"type"=>"x-email", "url"=>"copyright@angel.co"}, {"type"=>"x-email", "url"=>"syndicates@angel.co"}, {"type"=>"x-email", "url"=>"team@angel.co"}, {"type"=>"x-email", "url"=>"talent@angel.co"}, {"type"=>"x-email", "url"=>"privacy@angel.co"}, {"type"=>"x-email", "url"=>"abuse@angel.co"}, {"type"=>"x-github", "url"=>"https://github.com/angellist"}, {"type"=>"x-postman-collection", "url"=>"http://theapistack.com/data/angellist/angellist-postman-collection.json"}, {"type"=>"x-privacy", "url"=>"https://angel.co/privacy"}, {"type"=>"x-sdks-io", "url"=>"https://sdks.io/SDK/View/angellist-startup-api"}, {"type"=>"x-support", "url"=>"https://angel.co/help"}, {"type"=>"x-terms-of-service", "url"=>"https://angel.co/terms"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/angellist"}, {"type"=>"x-website", "url"=>"http://angel.co"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bc-geographical-names{"bc-geographical-names-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"BC Geographical Names", "x-complete"=>1, "info"=>{"title"=>"BC Geographical Names", "description"=>"this-rest-api-provides-searchable-access-to-information-about-geographical-names-in-the-province-of-british-columbia-including-name-status-and-details-about-the-corresponding-geographic-feature-", "contact"=>{"name"=>"BC Geographical Names Office", "email"=>"geographical.names@gov.bc.ca"}, "version"=>"3.x.x"}, "host"=>"apps.gov.bc.ca", "basePath"=>"/pub/bcgnws", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/featureCategories"=>{"get"=>{"summary"=>"Get all feature categories", "description"=>"Gets a list of all feature categories used by the BC Geographical Names Information System (BCGNIS). Note: there are three levels of classification in the BCGNIS feature taxonomy: classes, categories and types. A type is a subset of a category, and a category is a subset of a class.", "operationId"=>"gets-a-list-of-all-feature-categories-used-by-the-bc-geographical-names-information-system-bcgnis---", "x-api-path-slug"=>"featurecategories-get", "parameters"=>[{"in"=>"query", "name"=>"outputFormat", "description"=>"The format of the output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["FeatureCategories"]}}, "/featureClasses"=>{"get"=>{"summary"=>"Get all feature classes", "description"=>"Gets a list of all feature classes used by the BC Geographical Names Information System (BCGNIS). Note: there are three levels of classification in the BCGNIS feature taxonomy: classes, categories and types. A type is a subset of a category, and a category is a subset of a class.", "operationId"=>"gets-a-list-of-all-feature-classes-used-by-the-bc-geographical-names-information-system-bcgnis---not", "x-api-path-slug"=>"featureclasses-get", "parameters"=>[{"in"=>"query", "name"=>"outputFormat", "description"=>"The format of the output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["FeatureClasses"]}}, "/featureTypes"=>{"get"=>{"summary"=>"Get all feature types", "description"=>"Gets a list of all feature types used by the BC Geographical Names Information System (BCGNIS). Note: there are three levels of classification in the BCGNIS feature taxonomy: classes, categories and types. A type is a subset of a category, and a category is a subset of a class.", "operationId"=>"gets-a-list-of-all-feature-types-used-by-the-bc-geographical-names-information-system-bcgnis---note-", "x-api-path-slug"=>"featuretypes-get", "parameters"=>[{"in"=>"query", "name"=>"outputFormat", "description"=>"The format of the output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["FeatureTypes"]}}, "/features/{featureId}"=>{"get"=>{"summary"=>"Get a feature by its featureId", "description"=>"Get information about the geographical feature with the specified featureId.", "operationId"=>"get-information-about-the-geographical-feature-with-the-specified-featureid-", "x-api-path-slug"=>"featuresfeatureid-get", "parameters"=>[{"in"=>"path", "name"=>"featureId", "description"=>"The unique identifier for a feature"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Features", "FeatureId"]}}, "/nameAuthorities"=>{"get"=>{"summary"=>"Get all name authorities", "description"=>"Gets a list of all name authorities responsible for naming decisions of the geographical names in the BC Geographical Names Information System (BCGNIS)", "operationId"=>"gets-a-list-of-all-name-authorities-responsible-for-naming-decisions-of-the-geographical-names-in-th", "x-api-path-slug"=>"nameauthorities-get", "parameters"=>[{"in"=>"query", "name"=>"outputFormat", "description"=>"The format of the output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["NameAuthorities"]}}, "/names/changes"=>{"get"=>{"summary"=>"Search for names with metadata changes in a given period", "description"=>"Search for information about geographical names which have changed most recently within a specified time window. Changes may include status cupdates and metadata corrections.", "operationId"=>"search-for-information-about-geographical-names-which-have-changed-most-recently-within-a-specified-", "x-api-path-slug"=>"nameschanges-get", "parameters"=>[{"in"=>"query", "name"=>"embed", "description"=>"A flag to indicate whether to embed the corresponding feature into each matching name"}, {"in"=>"query", "name"=>"featureCategory", "description"=>"A filter to limit the search to names associated with features of a certain category The value of this parameter should be a featureCategoryCode value returned by the /featureCategories resource, or an asterisk (*) to request that all feature categories be included"}, {"in"=>"query", "name"=>"featureClass", "description"=>"A filter to limit the search to names associated with features of a certain class The value of this parameter should be a featureClassCode value returned by the /featureClasses resource, or an asterisk (*) to request that all feature classes be included"}, {"in"=>"query", "name"=>"featureType", "description"=>"A filter to limit the search to names associated with features of a certain type The value of this parameter should be a featureTypeCode value returned by the /featureTypes resource, or an asterisk (*) to request that all feature types be included"}, {"in"=>"query", "name"=>"fromDate", "description"=>"Defines the earliest date (YYYY-MM-DD format) of the change time window for the search"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"The number of search results to return (1-200)"}, {"in"=>"query", "name"=>"outputFormat", "description"=>"The format of the output"}, {"in"=>"query", "name"=>"outputSRS", "description"=>"The EPSG code of the spatial reference system (SRS) to use for output geometries"}, {"in"=>"query", "name"=>"outputStyle", "description"=>"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of attributes (detail)"}, {"in"=>"query", "name"=>"sortBy", "description"=>"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres)"}, {"in"=>"query", "name"=>"startIndex", "description"=>"The index of the first record to be returned (>= 1)"}, {"in"=>"query", "name"=>"toDate", "description"=>"Defines the latest date (YYYY-MM-DD format) of the change time window for the search"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Names", "Changes"]}}, "/names/decisions/recent"=>{"get"=>{"summary"=>"Search for names affected by recent naming decision", "description"=>"Search for information about geographical names affected by naming 'decisions' made by the BC Geographical Names Office (naming authority) within the last X days.", "operationId"=>"search-for-information-about-geographical-names-affected-by-naming-decisions-made-by-the-bc-geograph", "x-api-path-slug"=>"namesdecisionsrecent-get", "parameters"=>[{"in"=>"query", "name"=>"days", "description"=>"The number of days used to define the time window of naming decisions to search"}, {"in"=>"query", "name"=>"embed", "description"=>"A flag to indicate whether to embed the corresponding feature into each matching name"}, {"in"=>"query", "name"=>"featureCategory", "description"=>"A filter to limit the search to names associated with features of a certain category The value of this parameter should be a featureCategoryCode value returned by the /featureCategories resource, or an asterisk (*) to request that all feature categories be included"}, {"in"=>"query", "name"=>"featureClass", "description"=>"A filter to limit the search to names associated with features of a certain class The value of this parameter should be a featureClassCode value returned by the /featureClasses resource, or an asterisk (*) to request that all feature classes be included"}, {"in"=>"query", "name"=>"featureType", "description"=>"A filter to limit the search to names associated with features of a certain type The value of this parameter should be a featureTypeCode value returned by the /featureTypes resource, or an asterisk (*) to request that all feature types be included"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"The number of search results to return (1-200)"}, {"in"=>"query", "name"=>"outputFormat", "description"=>"The format of the output"}, {"in"=>"query", "name"=>"outputSRS", "description"=>"The EPSG code of the spatial reference system (SRS) to use for output geometries"}, {"in"=>"query", "name"=>"outputStyle", "description"=>"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of attributes (detail)"}, {"in"=>"query", "name"=>"sortBy", "description"=>"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres)"}, {"in"=>"query", "name"=>"startIndex", "description"=>"The index of the first record to be returned (>= 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Names", "Decisions", "Recent"]}}, "/names/decisions/year"=>{"get"=>{"summary"=>"Search for names affected by naming decisions in a given year", "description"=>"Search for information about geographical names affected by naming 'decisions' made by the BC Geographical Names Office (naming authority) in a given year.", "operationId"=>"search-for-information-about-geographical-names-affected-by-naming-decisions-made-by-the-bc-geograph", "x-api-path-slug"=>"namesdecisionsyear-get", "parameters"=>[{"in"=>"query", "name"=>"embed", "description"=>"A flag to indicate whether to embed the corresponding feature into each matching name"}, {"in"=>"query", "name"=>"featureCategory", "description"=>"A filter to limit the search to names associated with features of a certain category The value of this parameter should be a featureCategoryCode value returned by the /featureCategories resource, or an asterisk (*) to request that all feature categories be included"}, {"in"=>"query", "name"=>"featureClass", "description"=>"A filter to limit the search to names associated with features of a certain class The value of this parameter should be a featureClassCode value returned by the /featureClasses resource, or an asterisk (*) to request that all feature classes be included"}, {"in"=>"query", "name"=>"featureType", "description"=>"A filter to limit the search to names associated with features of a certain type The value of this parameter should be a featureTypeCode value returned by the /featureTypes resource, or an asterisk (*) to request that all feature types be included"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"The number of search results to return (1-200)"}, {"in"=>"query", "name"=>"outputFormat", "description"=>"The format of the output"}, {"in"=>"query", "name"=>"outputSRS", "description"=>"The EPSG code of the spatial reference system (SRS) to use for output geometries"}, {"in"=>"query", "name"=>"outputStyle", "description"=>"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of attributes (detail)"}, {"in"=>"query", "name"=>"sortBy", "description"=>"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres)"}, {"in"=>"query", "name"=>"startIndex", "description"=>"The index of the first record to be returned (>= 1)"}, {"in"=>"query", "name"=>"year", "description"=>"The year in which to search for names affected by naming decisions"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Names", "Decisions", "Year"]}}, "/names/inside"=>{"get"=>{"summary"=>"Search in a geographic area", "description"=>"Search for information about geographical names that correspond to features within a geographic bounding box. Various options and filter parameters are available to refine the search.", "operationId"=>"search-for-information-about-geographical-names-that-correspond-to-features-within-a-geographic-boun", "x-api-path-slug"=>"namesinside-get", "parameters"=>[{"in"=>"query", "name"=>"bbox", "description"=>"A geographic bounding box defining the search area"}, {"in"=>"query", "name"=>"embed", "description"=>"A flag to indicate whether to embed the corresponding feature into each matching name"}, {"in"=>"query", "name"=>"featureCategory", "description"=>"A filter to limit the search to names associated with features of a certain category The value of this parameter should be a featureCategoryCode value returned by the /featureCategories resource, or an asterisk (*) to request that all feature categories be included"}, {"in"=>"query", "name"=>"featureClass", "description"=>"A filter to limit the search to names associated with features of a certain class The value of this parameter should be a featureClassCode value returned by the /featureClasses resource, or an asterisk (*) to request that all feature classes be included"}, {"in"=>"query", "name"=>"featureType", "description"=>"A filter to limit the search to names associated with features of a certain type The value of this parameter should be a featureTypeCode value returned by the /featureTypes resource, or an asterisk (*) to request that all feature types be included"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"The number of search results to return (1-200)"}, {"in"=>"query", "name"=>"outputFormat", "description"=>"The format of the output"}, {"in"=>"query", "name"=>"outputSRS", "description"=>"The EPSG code of the spatial reference system (SRS) to use for output geometries"}, {"in"=>"query", "name"=>"outputStyle", "description"=>"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of attributes (detail)"}, {"in"=>"query", "name"=>"sortBy", "description"=>"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres)"}, {"in"=>"query", "name"=>"startIndex", "description"=>"The index of the first record to be returned (>= 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Names", "Inside"]}}, "/names/near"=>{"get"=>{"summary"=>"Search near to a geographic point", "description"=>"Search for information about geographical names that correspond to features within a geographic area defined by a centre point and a radius. Various options and filter parameters are available to refine the search.", "operationId"=>"search-for-information-about-geographical-names-that-correspond-to-features-within-a-geographic-area", "x-api-path-slug"=>"namesnear-get", "parameters"=>[{"in"=>"query", "name"=>"distance", "description"=>"A radius (in kilometres) around the centre point"}, {"in"=>"query", "name"=>"embed", "description"=>"A flag to indicate whether to embed the corresponding feature into each matching name"}, {"in"=>"query", "name"=>"featureCategory", "description"=>"A filter to limit the search to names associated with features of a certain category The value of this parameter should be a featureCategoryCode value returned by the /featureCategories resource, or an asterisk (*) to request that all feature categories be included"}, {"in"=>"query", "name"=>"featureClass", "description"=>"A filter to limit the search to names associated with features of a certain class The value of this parameter should be a featureClassCode value returned by the /featureClasses resource, or an asterisk (*) to request that all feature classes be included"}, {"in"=>"query", "name"=>"featurePoint", "description"=>"A geographic coordinate specifying the centre point of the search area"}, {"in"=>"query", "name"=>"featureType", "description"=>"A filter to limit the search to names associated with features of a certain type The value of this parameter should be a featureTypeCode value returned by the /featureTypes resource, or an asterisk (*) to request that all feature types be included"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"The number of search results to return (1-200)"}, {"in"=>"query", "name"=>"outputFormat", "description"=>"The format of the output"}, {"in"=>"query", "name"=>"outputSRS", "description"=>"The EPSG code of the spatial reference system (SRS) to use for output geometries"}, {"in"=>"query", "name"=>"outputStyle", "description"=>"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of attributes (detail)"}, {"in"=>"query", "name"=>"sortBy", "description"=>"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres)"}, {"in"=>"query", "name"=>"startIndex", "description"=>"The index of the first record to be returned (>= 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Names", "Near"]}}, "/names/notOfficial/search"=>{"get"=>{"summary"=>"Search by name, limit to unofficial names only", "description"=>"Search for information about unofficial geographical names by the text of the name itself. Various options and filter parameters are available to refine the search.", "operationId"=>"search-for-information-about-unofficial-geographical-names-by-the-text-of-the-name-itself---various-", "x-api-path-slug"=>"namesnotofficialsearch-get", "parameters"=>[{"in"=>"query", "name"=>"embed", "description"=>"A flag to indicate whether to embed the corresponding feature into each matching name"}, {"in"=>"query", "name"=>"exactSpelling", "description"=>"If the name parameter is specified, exactSpelling specifies whether to include only names that exactly match the search text (exactSpelling=1), or whether to also include names with similar spellings (exactSpelling=0)"}, {"in"=>"query", "name"=>"featureCategory", "description"=>"A filter to limit the search to names associated with features of a certain category The value of this parameter should be a featureCategoryCode value returned by the /featureCategories resource, or an asterisk (*) to request that all feature categories be included"}, {"in"=>"query", "name"=>"featureClass", "description"=>"A filter to limit the search to names associated with features of a certain class The value of this parameter should be a featureClassCode value returned by the /featureClasses resource, or an asterisk (*) to request that all feature classes be included"}, {"in"=>"query", "name"=>"featureType", "description"=>"A filter to limit the search to names associated with features of a certain type The value of this parameter should be a featureTypeCode value returned by the /featureTypes resource, or an asterisk (*) to request that all feature types be included"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"The number of search results to return (1-200)"}, {"in"=>"query", "name"=>"name", "description"=>"A filter to search based on the the text of the name itself"}, {"in"=>"query", "name"=>"outputFormat", "description"=>"The format of the output"}, {"in"=>"query", "name"=>"outputSRS", "description"=>"The EPSG code of the spatial reference system (SRS) to use for output geometries"}, {"in"=>"query", "name"=>"outputStyle", "description"=>"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of attributes (detail)"}, {"in"=>"query", "name"=>"sortBy", "description"=>"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres)"}, {"in"=>"query", "name"=>"startIndex", "description"=>"The index of the first record to be returned (>= 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Names", "NotOfficial", "Search"]}}, "/names/official/search"=>{"get"=>{"summary"=>"Search by name, limit to official names only", "description"=>"Search for information about official geographical names by the text of the name itself. Various options and filter parameters are available to refine the search.", "operationId"=>"search-for-information-about-official-geographical-names-by-the-text-of-the-name-itself---various-op", "x-api-path-slug"=>"namesofficialsearch-get", "parameters"=>[{"in"=>"query", "name"=>"embed", "description"=>"A flag to indicate whether to embed the corresponding feature into each matching name"}, {"in"=>"query", "name"=>"exactSpelling", "description"=>"If the name parameter is specified, exactSpelling specifies whether to include only names that exactly match the search text (exactSpelling=1), or whether to also include names with similar spellings (exactSpelling=0)"}, {"in"=>"query", "name"=>"featureCategory", "description"=>"A filter to limit the search to names associated with features of a certain category The value of this parameter should be a featureCategoryCode value returned by the /featureCategories resource, or an asterisk (*) to request that all feature categories be included"}, {"in"=>"query", "name"=>"featureClass", "description"=>"A filter to limit the search to names associated with features of a certain class The value of this parameter should be a featureClassCode value returned by the /featureClasses resource, or an asterisk (*) to request that all feature classes be included"}, {"in"=>"query", "name"=>"featureType", "description"=>"A filter to limit the search to names associated with features of a certain type The value of this parameter should be a featureTypeCode value returned by the /featureTypes resource, or an asterisk (*) to request that all feature types be included"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"The number of search results to return (1-200)"}, {"in"=>"query", "name"=>"name", "description"=>"A filter to search based on the the text of the name itself"}, {"in"=>"query", "name"=>"outputFormat", "description"=>"The format of the output"}, {"in"=>"query", "name"=>"outputSRS", "description"=>"The EPSG code of the spatial reference system (SRS) to use for output geometries"}, {"in"=>"query", "name"=>"outputStyle", "description"=>"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of attributes (detail)"}, {"in"=>"query", "name"=>"sortBy", "description"=>"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres)"}, {"in"=>"query", "name"=>"startIndex", "description"=>"The index of the first record to be returned (>= 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Names", "Official", "Search"]}}, "/names/search"=>{"get"=>{"summary"=>"Search by name", "description"=>"Search for information about geographical names by the text of the name itself. The response will include both official and unofficial names. Various options and filter parameters are available to refine the search.", "operationId"=>"search-for-information-about-geographical-names-by-the-text-of-the-name-itself---the-response-will-i", "x-api-path-slug"=>"namessearch-get", "parameters"=>[{"in"=>"query", "name"=>"embed", "description"=>"A flag to indicate whether to embed the corresponding feature into each matching name"}, {"in"=>"query", "name"=>"exactSpelling", "description"=>"If the name parameter is specified, exactSpelling specifies whether to include only names that exactly match the search text (exactSpelling=1), or whether to also include names with similar spellings (exactSpelling=0)"}, {"in"=>"query", "name"=>"featureCategory", "description"=>"A filter to limit the search to names associated with features of a certain category The value of this parameter should be a featureCategoryCode value returned by the /featureCategories resource, or an asterisk (*) to request that all feature categories be included"}, {"in"=>"query", "name"=>"featureClass", "description"=>"A filter to limit the search to names associated with features of a certain class The value of this parameter should be a featureClassCode value returned by the /featureClasses resource, or an asterisk (*) to request that all feature classes be included"}, {"in"=>"query", "name"=>"featureType", "description"=>"A filter to limit the search to names associated with features of a certain type The value of this parameter should be a featureTypeCode value returned by the /featureTypes resource, or an asterisk (*) to request that all feature types be included"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"The number of search results to return (1-200)"}, {"in"=>"query", "name"=>"name", "description"=>"A filter to search based on the the text of the name itself"}, {"in"=>"query", "name"=>"outputFormat", "description"=>"The format of the output"}, {"in"=>"query", "name"=>"outputSRS", "description"=>"The EPSG code of the spatial reference system (SRS) to use for output geometries"}, {"in"=>"query", "name"=>"outputStyle", "description"=>"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of attributes (detail)"}, {"in"=>"query", "name"=>"sortBy", "description"=>"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres)"}, {"in"=>"query", "name"=>"startIndex", "description"=>"The index of the first record to be returned (>= 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Names", "Search"]}}, "/names/{nameId}.{outputFormat}"=>{"get"=>{"summary"=>"Get a name by its nameId", "description"=>"Get information about the geographical name with the specified nameId.", "operationId"=>"get-information-about-the-geographical-name-with-the-specified-nameid-", "x-api-path-slug"=>"namesnameid-outputformat-get", "parameters"=>[{"in"=>"path", "name"=>"nameId", "description"=>"The unique identifier for a name"}, {"in"=>"path", "name"=>"outputFormat", "description"=>"The format of the output"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Names", "NameId", "OutputFormat"]}}}}, "geo-mark-web-service-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"BC Geographical Names", "x-complete"=>1, "info"=>{"title"=>"Geo Mark Web Service", "description"=>"the-geomark-web-service-allows-you-to-create-and-share-geographic-areas-of-interest-over-the-web-in-a-variety-of-formats-and-coordinate-systems--this-service-is-especially-helpful-when-you-need-to-share-an-area-of-interest-with-people-who-require-that-the-data-be-in-a-different-format-or-they-use-different-mapping-software-", "termsOfService"=>"http://www2.gov.bc.ca/gov/content/governments/about-the-bc-government/databc/open-data/api-terms-of-use-for-ogl-information", "contact"=>{"name"=>"Data BC", "url"=>"http://data.gov.bc.ca/", "email"=>"DataBCBA@gov.bc.ca"}, "version"=>"4.1.2"}, "host"=>"apps.gov.bc.ca", "basePath"=>"/pub/geomark", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/geomarks/copy"=>{"post"=>{"summary"=>"Create a new geomark by copying the geometries from one or more existing geomarks from the current server.", "description"=>"The source geomarks can be specified by with the geomarkUrl parameter. Repeat the parameter if sourcing from multiple geomarks", "operationId"=>"the-source-geomarks-can-be-specified-by-with-the-geomarkurl-parameter---repeat-the-parameter-if-sour", "x-api-path-slug"=>"geomarkscopy-post", "parameters"=>[{"in"=>"query", "name"=>"bufferCap", "description"=>"If bufferMetres is specified, The style of buffer to use at the ends of a buffered line"}, {"in"=>"query", "name"=>"bufferJoin", "description"=>"If bufferMetres is specified, The style of buffer to use for joins between the line segments for lines and polygons"}, {"in"=>"query", "name"=>"bufferMetres", "description"=>"The amount to buffer the geometry in metres, must only contain numerical digits (e"}, {"in"=>"query", "name"=>"bufferMitreLimit", "description"=>"If bufferMetres is specified, the maximum ratio of distance from the original geometry to a mitre buffer point and the buffer amount"}, {"in"=>"query", "name"=>"bufferSegments", "description"=>"If bufferMetres is specified, the number of line segments used in each quadrant to approximate the curve for round end-cap and join styles"}, {"in"=>"query", "name"=>"callback", "description"=>"The callback function a JSON result format would be wrapped in to support Ajax requests"}, {"in"=>"query", "name"=>"failureRedirectUrl", "description"=>"The url to redirect if the geomark could not be created"}, {"in"=>"query", "name"=>"geomarkUrl", "description"=>"One or more geomark URLs or identifiers to create the new geomark from"}, {"in"=>"query", "name"=>"redirectUrl", "description"=>"The optional external URL to redirect the user to when the geomark is created rather than showing the geomark info page"}, {"in"=>"query", "name"=>"resultFormat", "description"=>"The file format the geomark info resource should be returned using"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Geomarks", "Copy"]}}, "/geomarks/new"=>{"post"=>{"summary"=>"Create a new geomark", "description"=>"Create a new geomark from the geometries read from the 'body' parameter or file.", "operationId"=>"create-a-new-geomark-from-the-geometries-read-from-the-body-parameter-or-file-", "x-api-path-slug"=>"geomarksnew-post", "parameters"=>[{"in"=>"formData", "name"=>"body", "description"=>"The binary or character content representing the geometry or geometries"}, {"in"=>"formData", "name"=>"bufferCap", "description"=>"If bufferMetres is specified, The style of buffer to use at the ends of a buffered line"}, {"in"=>"formData", "name"=>"bufferJoin", "description"=>"If bufferMetres is specified, The style of buffer to use for joins between the line segments for lines and polygons"}, {"in"=>"formData", "name"=>"bufferMetres", "description"=>"The amount to buffer the geometry in metres, must only contain numerical digits (e"}, {"in"=>"formData", "name"=>"bufferMitreLimit", "description"=>"If bufferMetres is specified, the maximum ratio of distance from the original geometry to a mitre buffer point and the buffer amount"}, {"in"=>"formData", "name"=>"bufferSegments", "description"=>"If bufferMetres is specified, the number of line segments used in each quadrant to approximate the curve for round end-cap and join styles"}, {"in"=>"formData", "name"=>"callback", "description"=>"The callback function a JSON result format would be wrapped in to support Ajax requests"}, {"in"=>"formData", "name"=>"failureRedirectUrl", "description"=>"The url to redirect if the geomark could not be created"}, {"in"=>"formData", "name"=>"format", "description"=>"The file format name extension of the input geometry"}, {"in"=>"formData", "name"=>"multiple", "description"=>"Boolean flag indicating if multiple geometries are to be used for the geomark (true) or only a single geometry from the first geometry (false)"}, {"in"=>"formData", "name"=>"redirectUrl", "description"=>"The optional external URL to redirect the user to when the geomark is created rather than showing the geomark info page"}, {"in"=>"formData", "name"=>"resultFormat", "description"=>"The file format the geomark info resource should be returned using"}, {"in"=>"formData", "name"=>"srid", "description"=>"The srid of the coordinate system the input geometries are in"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Geomarks", "New"]}}, "/geomarks/{geomarkId}.{fileFormatExtension}"=>{"get"=>{"summary"=>"Get information about a particular geomark", "description"=>"The attribution can be downloaded as a info file format. The download files can then be processed by a client application to access the geomark info fields and to get the URLs to the geometry download resources.", "operationId"=>"the-attribution-can-be-downloaded-as-a-info-file-format--the-download-files-can-then-be-processed-by", "x-api-path-slug"=>"geomarksgeomarkid-fileformatextension-get", "parameters"=>[{"in"=>"path", "name"=>"fileFormatExtension", "description"=>"The file format name extension used to represent the geomark download"}, {"in"=>"path", "name"=>"geomarkId", "description"=>"The unique identifier for the geomark (e"}, {"in"=>"query", "name"=>"srid", "description"=>"The srid of the coordinate system the geometry should be converted to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Geomarks", "GeomarkId", "FileFormatExtension"]}}, "/geomarks/{geomarkId}/boundingBox.{fileFormatExtension}"=>{"get"=>{"summary"=>"Gets the bounding box of the geomark", "description"=>"The source geomarks can be specified by with the geomarkUrl parameter. Repeat the parameter if sourcing from multiple geomarks", "operationId"=>"the-source-geomarks-can-be-specified-by-with-the-geomarkurl-parameter---repeat-the-parameter-if-sour", "x-api-path-slug"=>"geomarksgeomarkidboundingbox-fileformatextension-get", "parameters"=>[{"in"=>"path", "name"=>"fileFormatExtension", "description"=>"The file format name extension used to represent the geomark download"}, {"in"=>"path", "name"=>"geomarkId", "description"=>"The unique identifier for the geomark (e"}, {"in"=>"query", "name"=>"srid", "description"=>"The srid of the coordinate system the geometry should be converted to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Geomarks", "GeomarkId", "BoundingBox", "FileFormatExtension"]}}, "/geomarks/{geomarkId}/feature.{fileFormatExtension}"=>{"get"=>{"summary"=>"Get the feature and attribution of the geomark", "description"=>"The geomark feature resource returns a single spatial feature with either a single (Point, LineString, Polygon) or multi-part geometry (MultiPoint, MultiLineString, MultiPolygon) and the geomark attribution. The geometry and attribution can be downloaded as a spatial download file format in a supported coordinate system. The download files can then be used in a desktop GIS application (e.g. ArcMap), Google Earth or a web mapping application.", "operationId"=>"the-geomark-feature-resource-returns-a-single-spatial-feature-with-either-a-single-point-linestring-", "x-api-path-slug"=>"geomarksgeomarkidfeature-fileformatextension-get", "parameters"=>[{"in"=>"path", "name"=>"fileFormatExtension", "description"=>"The file format name extension used to represent the geomark download"}, {"in"=>"path", "name"=>"geomarkId", "description"=>"The unique identifier for the geomark (e"}, {"in"=>"query", "name"=>"srid", "description"=>"The srid of the coordinate system the geometry should be converted to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Geomarks", "GeomarkId", "Feature", "FileFormatExtension"]}}, "/geomarks/{geomarkId}/parts.{fileFormatExtension}"=>{"get"=>{"summary"=>"Get the individual geometries within a multi-part geometry", "description"=>"The geomark parts resource returns a one or more spatial features. One for each part of the Geomark's geomerty. Each part contains a single (Point, LineString, Polygon) geometry and the geomark attribution.", "operationId"=>"the-geomark-parts-resource-returns-a-one-or-more-spatial-features--one-for-each-part-of-the-geomarks", "x-api-path-slug"=>"geomarksgeomarkidparts-fileformatextension-get", "parameters"=>[{"in"=>"path", "name"=>"fileFormatExtension", "description"=>"The file format name extension used to represent the geomark download"}, {"in"=>"path", "name"=>"geomarkId", "description"=>"The unique identifier for the geomark (e"}, {"in"=>"query", "name"=>"srid", "description"=>"The srid of the coordinate system the geometry should be converted to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Geomarks", "GeomarkId", "Parts", "FileFormatExtension"]}}, "/geomarks/{geomarkId}/point.{fileFormatExtension}"=>{"get"=>{"summary"=>"Gets a single spatial point representative of the geomark.", "description"=>"The geomark point resource returns a single spatial feature with a single Point and the geomark attribution. The point geometry will be created from the first geometry part of the Geomark. Point geomarks will return the first Point part in the geomark. LineString geomarks will return the first coordinate of the first LineString part in the geomark. Polygon geomarks will return the centroid or another point inside the first Polygon part in the geomark. The geometry and attribution can be downloaded as a spatial download file format in a supported coordinate system. The download files can then be used in a desktop GIS application (e.g. ArcMap), Google Earth or a web mapping application.", "operationId"=>"the-geomark-point-resource-returns-a-single-spatial-feature-with-a-single-point-and-the-geomark-attr", "x-api-path-slug"=>"geomarksgeomarkidpoint-fileformatextension-get", "parameters"=>[{"in"=>"path", "name"=>"fileFormatExtension", "description"=>"The file format name extension used to represent the geomark download"}, {"in"=>"path", "name"=>"geomarkId", "description"=>"The unique identifier for the geomark (e"}, {"in"=>"query", "name"=>"srid", "description"=>"The srid of the coordinate system the geometry should be converted to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Geomarks", "GeomarkId", "Point", "FileFormatExtension"]}}}}, "apis"=>{"name"=>"BC Geographical Names", "x-slug"=>"bc-geographical-names", "description"=>"Geographical names are more than labels on maps and road signs. They can reveal patterns of settlement, exploration and migration, and mirror outside influences to our history - aspects of the heritage and promise of an area that might otherwise be overlooked or forgotten by visitors and later generations.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/british-columbia.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,General Data,Geo,Geography,Locations,Profiles", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bc-geographical-names/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"BC Geographical Names", "x-api-slug"=>"bc-geographical-names", "description"=>"Geographical names are more than labels on maps and road signs. They can reveal patterns of settlement, exploration and migration, and mirror outside influences to our history - aspects of the heritage and promise of an area that might otherwise be overlooked or forgotten by visitors and later generations.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/british-columbia.png", "humanURL"=>"https://apps.gov.bc.ca/pub/bcgnws/", "baseURL"=>"https://apps.gov.bc.ca//pub/bcgnws", "tags"=>"API Provider,General Data,Geo,Geography,Locations,Profiles", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bc-geographical-names/namesnameid-outputformat-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bc-geographical-names/bc-geographical-names-openapi.yaml"}]}, {"name"=>"Geo Mark Web Service", "x-api-slug"=>"geo-mark-web-service", "description"=>"Geographical names are more than labels on maps and road signs. They can reveal patterns of settlement, exploration and migration, and mirror outside influences to our history - aspects of the heritage and promise of an area that might otherwise be overlooked or forgotten by visitors and later generations.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/british-columbia.png", "humanURL"=>"https://apps.gov.bc.ca/pub/bcgnws/", "baseURL"=>"https://apps.gov.bc.ca//pub/geomark", "tags"=>"Names,NameId,OutputFormat", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bc-geographical-names/geomarksgeomarkidpoint-fileformatextension-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bc-geographical-names/geo-mark-web-service-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://apps.gov.bc.ca/pub/bcgnws/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ibm-financial-crimes-insight-for-insurance{"ibm-financial-crimes-insight-for-insurance-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"IBM Financial Crimes Insight for Insurance", "x-complete"=>1, "info"=>{"title"=>"Financial Crimes Insight for Insurance public REST APIs", "description"=>"these-are-the-financial-crimes-insight-for-insurance-public-rest-apis-used-by-clients-to-access-the-fcii-capabilities", "version"=>"1.0.0"}, "host"=>"fcihost.ibm.com:9443", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/ibm/fci/platform/data_access/analysis_request"=>{"post"=>{"summary"=>"Request a managed analysis to run", "description"=>"This service can be used to initiate a managed analysis", "operationId"=>"startAnalysis", "x-api-path-slug"=>"ibmfciplatformdata-accessanalysis-request-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"query", "name"=>"waitTime", "description"=>"wait for NN seconds, and if no response continue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Managed", "Analysis", "To", "Run"]}}, "/ibm/fci/platform/external_alert/analysis_result"=>{"post"=>{"summary"=>"Submit assessments from monitored analytics", "description"=>"This method is used to submit analysis results from monitored analysis", "operationId"=>"postExternalAnalyticResult", "x-api-path-slug"=>"ibmfciplatformexternal-alertanalysis-result-post", "parameters"=>[{"in"=>"body", "name"=>"AnalysisAssessedResults", "description"=>"An XML object corresponding to the AnalysisAssessedResults", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Submit", "Assessments", "From", "Monitored", "Analytics"]}}, "/ibm/fci/platform/token_service/token"=>{"get"=>{"summary"=>"Obtain security token for REST execution", "description"=>"In addition to a username and password required to execute a REST service, the platform supports enhanced cross site scripting detection and requires a service token for REST API execution. REST services will need to supply the token as both cookie and header in a REST request.", "operationId"=>"getServiceToken", "x-api-path-slug"=>"ibmfciplatformtoken-servicetoken-get", "parameters"=>[{"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Obtain", "Security", "TokenREST", "Execution"]}}, "/ibm/fci/platform/fact/account"=>{"put"=>{"summary"=>"Insert account data into the database", "description"=>"This method is used to insert account data into the database. The XML schema is defined in the ACCOUNT.XSD file.", "operationId"=>"putAccount", "x-api-path-slug"=>"ibmfciplatformfactaccount-put", "parameters"=>[{"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insert", "Account", "Data", "Into", "Database"]}}, "/ibm/fci/platform/fact/account/{id}"=>{"get"=>{"summary"=>"Retrieve account data from the database, for the id", "description"=>"This method is used to retrieve account data from the database", "operationId"=>"getAccount", "x-api-path-slug"=>"ibmfciplatformfactaccountid-get", "parameters"=>[{"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Account", "Data", "From", "Database", "The", "Id"]}}, "/ibm/fci/platform/fact/{type}/{remoteSystem}/{remoteKey}/assessments]"=>{"get"=>{"summary"=>"Return the existing assessments for the object specified", "description"=>"This service is used to return the existing assessments for the object specified.", "operationId"=>"requestAssessmentValue", "x-api-path-slug"=>"ibmfciplatformfacttyperemotesystemremotekeyassessments-get", "parameters"=>[{"in"=>"query", "name"=>"context", "description"=>"The fraud context for which to return assessements"}, {"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"path", "name"=>"remoteKey", "description"=>"The combination of remoteSystem and remoteKey uniquely defines an object"}, {"in"=>"path", "name"=>"remoteSystem", "description"=>"The combination of remoteSystem and remoteKey uniquely defines an object"}, {"in"=>"path", "name"=>"type", "description"=>"Type of object; party, account, transaction, event, or other defined object type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "Existing", "Assessmentsthe", "Object", "Specified"]}}, "/ibm/fci/platform/fact/entity/{remote_system_id}/{external_remote_reference}"=>{"get"=>{"summary"=>"Retrieve set of identities considered to be the same entity", "description"=>"This method is used to retrieve the set of individuals (or organizations) that are considered the same as the provided party reference", "operationId"=>"getResolvedEntityByRef", "x-api-path-slug"=>"ibmfciplatformfactentityremote-system-idexternal-remote-reference-get", "parameters"=>[{"in"=>"path", "name"=>"external_remote_reference"}, {"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"path", "name"=>"remote_system_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Set", "Of", "Identities", "Considered", "To", "Be", "Same", "Entity"]}}, "/ibm/fci/platform/fact/match"=>{"get"=>{"summary"=>"Determine if one object is a match to the other.", "description"=>"Using the provided objects, determine if one is a 'match' of the other", "operationId"=>"getMatchedObject", "x-api-path-slug"=>"ibmfciplatformfactmatch-get", "parameters"=>[{"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"query", "name"=>"objectId1", "description"=>"Object id of first object"}, {"in"=>"query", "name"=>"objectId2", "description"=>"Object id of second object"}, {"in"=>"query", "name"=>"objectStereotype", "description"=>"stereotype of the objects being compared"}, {"in"=>"query", "name"=>"updateResolvedEntities", "description"=>"Boolean to indicate whether or not to record relationship"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Determine", "If", "Object", "Is", "Match", "To", "Other"]}}, "/ibm/fci/platform/fact/entity/match"=>{"get"=>{"summary"=>"Get a list of resolved objects from resolved entities for a given object.", "description"=>"Get a list of resolved objects from resolved entities for a given object. Using the provided object ID, produce a list of all objects of the same business object type that have been determined to be 'matches'.", "operationId"=>"getMatchedEntity", "x-api-path-slug"=>"ibmfciplatformfactentitymatch-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Number of objects to return; all if not included"}, {"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"query", "name"=>"id", "description"=>"Object id of the object"}, {"in"=>"query", "name"=>"logicalType", "description"=>"Metadata element ID for a business object"}, {"in"=>"query", "name"=>"returnFlag", "description"=>"Default value == 2"}, {"in"=>"query", "name"=>"threshold", "description"=>"Minimum matching score to include a resolved entity; defaults to system property if not supplied"}, {"in"=>"query", "name"=>"type", "description"=>"Stereotype for object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Resolved", "Objects", "From", "Resolved", "Entitiesa", "Given", "Object"]}}, "/ibm/fci/platform/fact/entity/{id}"=>{"get"=>{"summary"=>"Get the data for the resolved entity id.", "description"=>"Using the provided party id, obtain the entity id", "operationId"=>"getResolvedEntityById", "x-api-path-slug"=>"ibmfciplatformfactentityid-get", "parameters"=>[{"in"=>"body", "name"=>"Entity", "description"=>"A JSON structure that provide the details of an entity", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datathe", "Resolved", "Entity", "Id"]}}, "/ibm/fci/platform/fact/entitysearch"=>{"post"=>{"summary"=>"Search for objects that match the search terms specified.", "description"=>"Search for objects that match the search terms specified. The searchType refers to the type of object being searched for. Valid values include: Folio,Account,Event,Group,PhysicalObject,Party,Transaction,Any. Note that paging and ordering is not supported for type Any. The parameter globalsearch represents a global search string with support for the * wildcard. The propertysearch fields are a list of searches for matching on specified fields of an object.", "operationId"=>"entitySearch", "x-api-path-slug"=>"ibmfciplatformfactentitysearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Searchobjects", "That", "Match", "Search", "Terms", "Specified"]}}, "/ibm/fci/platform/fact/entity/relatedparties/{systemId}/{remoteReference}"=>{"get"=>{"summary"=>"This method is used to retrieve the set of explicitly related parties and implicitly related entities for the supplied externally sourced reference party", "description"=>"A data source must be configured in the appropriate server.xml to use ISII. Ensure that the following has been included:\n\n<dataSource beginTranForResultSetScrollingAPIs=\"false\" id=\"ISIIDB\" isolationLevel=\"TRANSACTION_READ_COMMITTED\" jndiName=\"jdbc/isii\">\n\n<jdbcDriver javax.sql.DataSource=\"com.ibm.db2.jcc.DB2XADataSource\" libraryRef=\"DB2_LIB\"/>\n\n<properties.db2.jcc databaseName=\"ISII\" password=\"${isii_db_pass}\" portNumber=\"${isii_db_port}\" serverName=\"${isii_host}\" user=\"${isii_db_user}\"/>\n\n<connectionManager connectionTimeout=\"60s\" maxIdleTime=\"3m\" maxPoolSize=\"200\" minPoolSize=\"0\"/>\n\n</dataSource>\n\nWhere password, portNumber, serverName, and user values are replaced with the appropriate properties or environment variables for your configuration.", "operationId"=>"getRelatedObjects", "x-api-path-slug"=>"ibmfciplatformfactentityrelatedpartiessystemidremotereference-get", "parameters"=>[{"in"=>"query", "name"=>"minRelatedScore", "description"=>"Minimum matching score for implicit relationships"}, {"in"=>"path", "name"=>"remoteReference", "description"=>"Remote reference object key"}, {"in"=>"path", "name"=>"systemId", "description"=>"Remote reference system ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["This", "Method", "Is", "Used", "To", "Retrieve", "Set", "Of", "Explicitly", "Related", "Parties", "Implicitly", "Related", "Entitiesthe", "Supplied", "Externally", "Sourced", "Reference", "Party"]}}, "/ibm/fci/platform/fact/event"=>{"put"=>{"summary"=>"Insert event data into the database", "description"=>"This method is used to insert event data into the database. The XML schema is defined in the EVENT.XSD file.", "operationId"=>"putEvent", "x-api-path-slug"=>"ibmfciplatformfactevent-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insert", "Event", "Data", "Into", "Database"]}}, "/ibm/fci/platform/fact/event/{id}"=>{"get"=>{"summary"=>"Retrieve event data from the database, for the id", "description"=>"This method is used to retrieve event data from the database", "operationId"=>"getEvent", "x-api-path-slug"=>"ibmfciplatformfacteventid-get", "parameters"=>[{"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Event", "Data", "From", "Database", "The", "Id"]}}, "/ibm/fci/platform/fact/group"=>{"put"=>{"summary"=>"Insert group data into the database", "description"=>"This method is used to insert group data into the database. The XML schema is defined in the GROUP.XSD file.", "operationId"=>"putGroup", "x-api-path-slug"=>"ibmfciplatformfactgroup-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insert", "Group", "Data", "Into", "Database"]}}, "/ibm/fci/platform/fact/group/{id}"=>{"get"=>{"summary"=>"Retrieve group data from the database, for the specific group id", "description"=>"This method is used to retrieve specific group data from the database", "operationId"=>"getGroup", "x-api-path-slug"=>"ibmfciplatformfactgroupid-get", "parameters"=>[{"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Group", "Data", "From", "Database", "The", "Specific", "Group", "Id"]}}, "/ibm/fci/platform/fact/party"=>{"put"=>{"summary"=>"Insert party data into the database", "description"=>"This method is used to insert party data into the database. The XML schema is defined in the PARTY.XSD file.", "operationId"=>"putParty", "x-api-path-slug"=>"ibmfciplatformfactparty-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insert", "Party", "Data", "Into", "Database"]}}, "/ibm/fci/platform/fact/party/{id}"=>{"get"=>{"summary"=>"Retrieve party data from the database, for the id", "description"=>"This method is used to retrieve party data from the database", "operationId"=>"getParty", "x-api-path-slug"=>"ibmfciplatformfactpartyid-get", "parameters"=>[{"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Party", "Data", "From", "Database", "The", "Id"]}}, "/ibm/fci/platform/fact/physical_object"=>{"put"=>{"summary"=>"Insert physical object data into the database", "description"=>"This method is used to insert physical object data into the database. The XML schema is defined in the PhysicalObject.XSD file.", "operationId"=>"putPhysicalObject", "x-api-path-slug"=>"ibmfciplatformfactphysical-object-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insert", "Physical", "Object", "Data", "Into", "Database"]}}, "/ibm/fci/platform/fact/physical_object/{id}"=>{"get"=>{"summary"=>"Retrieve a specific physical object data from the database, based on its internal id", "description"=>"This method is used to retrieve specific physical object data from the database, based on its internal id", "operationId"=>"getPhysicalObject", "x-api-path-slug"=>"ibmfciplatformfactphysical-objectid-get", "parameters"=>[{"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Specific", "Physical", "Object", "Data", "From", "Database", "", "Based", "On", "Its", "Internal", "Id"]}}, "/ibm/fci/platform/fact/screen"=>{"get"=>{"summary"=>"Screen a specific attribute against a dynamic list", "description"=>"This method is used to screen data against a specific list of values, resulting in a JSON object containing a list of matching objects", "operationId"=>"screen", "x-api-path-slug"=>"ibmfciplatformfactscreen-get", "parameters"=>[{"in"=>"query", "name"=>"context", "description"=>"Registered context to which to filter / restrict this screen"}, {"in"=>"query", "name"=>"fieldName", "description"=>"Field of the logical object to be searched"}, {"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"query", "name"=>"objectType", "description"=>"Business object name of the objects to search"}, {"in"=>"query", "name"=>"offset", "description"=>"Used when more then max set of objects meet the criteria; when paging is required, this represents the paging offset"}, {"in"=>"query", "name"=>"style", "description"=>"Searching style, defaults to SMART_MATCH"}, {"in"=>"query", "name"=>"values", "description"=>"Comma separated list of values to search for in the local database"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Screen", "Specific", "Attribute", "Against", "Dynamic", "List"]}}, "/ibm/fci/platform/fact/transaction"=>{"put"=>{"summary"=>"Insert transaction data into the database", "description"=>"This method is used to insert transaction data into the database. The XML schema is defined in the TRANSACTION.XSD file.", "operationId"=>"putTransaction", "x-api-path-slug"=>"ibmfciplatformfacttransaction-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insert", "Transaction", "Data", "Into", "Database"]}}, "/ibm/fci/platform/fact/transaction/{id}"=>{"get"=>{"summary"=>"Retrieve transaction data from the database, by its internal id", "description"=>"This method is used to retrieve transaction data from the database", "operationId"=>"getTransaction", "x-api-path-slug"=>"ibmfciplatformfacttransactionid-get", "parameters"=>[{"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Transaction", "Data", "From", "Database", "", "By", "Its", "Internal", "Id"]}}, "/ibm/fci/platform/fact/watchlist"=>{"get"=>{"summary"=>"Retrieve a list of the registered watchlists", "description"=>"This method is used to retrieve the list of registered watchlists from the database", "operationId"=>"getWatchlists", "x-api-path-slug"=>"ibmfciplatformfactwatchlist-get", "parameters"=>[{"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Registered", "Watchlists"]}, "post"=>{"summary"=>"Persist the provided watchlist into the local database", "description"=>"This method is used to persist the contents of a watchlist into the database. Note: This method uses some data import functionality to create business object entries, then calls putWatchlist to create/update a watchlist for the provided identifier, and finally calls putWatchlistItem for every object created. This one also has the caveat of needing a disposition defined, but in this case all you need to pass in is the stereotype value.", "operationId"=>"uploadWatchlist", "x-api-path-slug"=>"ibmfciplatformfactwatchlist-post", "parameters"=>[{"in"=>"formData", "name"=>"data", "description"=>"CSV file containing an external watchlist"}, {"in"=>"formData", "name"=>"dataName", "description"=>"CSV file name"}, {"in"=>"query", "name"=>"disposition", "description"=>"watchlist_disposition stereotype"}, {"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"query", "name"=>"identifier"}, {"in"=>"query", "name"=>"overwrite"}, {"in"=>"formData", "name"=>"properties", "description"=>"A "}, {"in"=>"formData", "name"=>"propertiesName", "description"=>"Properties file name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Persist", "Provided", "Watchlist", "Into", "Local", "Database"]}}, "/ibm/fci/platform/fact/watchlist/{id}"=>{"get"=>{"summary"=>"Retrieve the contents of a watchlist, based on its id", "description"=>"This method is used to retrieve the contents of a watchlist from the database", "operationId"=>"getWatchlistById", "x-api-path-slug"=>"ibmfciplatformfactwatchlistid-get", "parameters"=>[{"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"summary", "description"=>"If set to true, this flag will cause inclusion any Watchlist_Item_Properties associated with the item"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Contents", "Of", "Watchlist", "", "Based", "On", "Its", "Id"]}}, "/ibm/fci/platform/folio_management/folio/{id}"=>{"get"=>{"summary"=>"Retrieve details of a folio, by its internal id", "description"=>"This method is used to retrieve the folio contents from the database", "operationId"=>"getFolioById", "x-api-path-slug"=>"ibmfciplatformfolio-managementfolioid-get", "parameters"=>[{"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"path", "name"=>"id", "description"=>"Investigation folio to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Details", "Of", "Folio", "", "By", "Its", "Internal", "Id"]}}, "/ibm/fci/platform/logical_object/search"=>{"post"=>{"summary"=>"Retrieve business objects using the specified parameters", "description"=>"This method provides searches for business objects within the database. The results for searching on a time stamp field are affected by the way that DB2® handles time stamps. The JSON string uses ISO format for time stamps, such as 2016-06-15T20:11:19.326-04:00. DB2 converts this value to 2016-06-15-20.11.19.326000. Because DB2 might add more precision by storing a time stamp as 2016-06-15-20.11.19.326nnnn, the search results might not return what is expected. Refer to your DB2 documentation for more information on time stamps.", "operationId"=>"searchInstanceData", "x-api-path-slug"=>"ibmfciplatformlogical-objectsearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"IBM-FCI-Role", "description"=>"Userid / password for user with appropriate role"}, {"in"=>"header", "name"=>"IBM-FCI-Token", "description"=>"Security token obtained for execution"}, {"in"=>"query", "name"=>"lob_type", "description"=>"A valid business object type"}, {"in"=>"query", "name"=>"prominence", "description"=>"Prominence level of the fields that you want returned"}, {"in"=>"query", "name"=>"rec_count", "description"=>"The number of matching records to return"}, {"in"=>"query", "name"=>"start_idx", "description"=>"The starting index of the matching records to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Business", "Objects", "Using", "Specified", "Parameters"]}}}}, "apis"=>{"name"=>"IBM Financial Crimes Insight for Insurance", "x-slug"=>"ibm-financial-crimes-insight-for-insurance", "description"=>"IBM® Financial Crimes Insight® for Insurance V3.0, formerly known as IBM Counter Fraud Management for Insurance, is now being offered as a cloud service offering. It helps organizations analyze data to determine the fraud risk of claims, medical providers, and other business entities, manage the full investigation lifecycle, and report on outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/WFS-Counter-Fraud-Technical-Level-3.png", "x-kinRank"=>"7", "x-alexaRank"=>"", "tags"=>"Financial,Insurance,Policing,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"ibm-financial-crimes-insight-for-insurance/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"IBM Financial Crimes Insight for Insurance API", "x-api-slug"=>"ibm-financial-crimes-insight-for-insurance-api", "description"=>"IBM® Financial Crimes Insight® for Insurance V3.0, formerly known as IBM Counter Fraud Management for Insurance, is now being offered as a cloud service offering. It helps organizations analyze data to determine the fraud risk of claims, medical providers, and other business entities, manage the full investigation lifecycle, and report on outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/WFS-Counter-Fraud-Technical-Level-3.png", "humanURL"=>"https://www-01.ibm.com/common/ssi/cgi-bin/ssialias?infotype=AN&subtype=CA&htmlfid=897/ENUS218-305&appname=USN", "baseURL"=>"https://fcihost.ibm.com:9443//", "tags"=>"Financial,Insurance,Policing,Relative Data,Service API", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/ibm-financial-crimes-insight-for-insurance/ibm-financial-crimes-insight-for-insurance-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-openapi", "url"=>"https://www.ibm.com/support/knowledgecenter/SSC2HF_3.0.0/api/fcii-insurance-v3.0.0.yaml?origin=swagger-ui"}, {"type"=>"x-pricing", "url"=>"https://www-01.ibm.com/common/ssi/cgi-bin/ssialias?infotype=AN&subtype=CA&htmlfid=897/ENUS218-305&appname=USN#echargex"}, {"type"=>"x-website", "url"=>"https://www-01.ibm.com/common/ssi/cgi-bin/ssialias?infotype=AN&subtype=CA&htmlfid=897/ENUS218-305&appname=USN"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-dataflow{"google-cloud-dataflow-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Dataflow", "x-complete"=>1, "info"=>{"title"=>"Google Dataflow", "description"=>"manages-google-cloud-dataflow-projects-on-google-cloud-platform-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1b3"}, "host"=>"dataflow.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1b3/projects/{projectId}/WorkerMessages"=>{"post"=>{"summary"=>"Send Worker Message", "description"=>"Send a worker_message to the service.", "operationId"=>"dataflow.projects.workerMessages", "x-api-path-slug"=>"v1b3projectsprojectidworkermessages-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"The project to send the WorkerMessages to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Worker Message"]}}, "/v1b3/projects/{projectId}/jobs"=>{"get"=>{"summary"=>"Get Project Jobs", "description"=>"List the jobs of a project.", "operationId"=>"dataflow.projects.jobs.list", "x-api-path-slug"=>"v1b3projectsprojectidjobs-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"The kind of filter to use"}, {"in"=>"query", "name"=>"location", "description"=>"The location that contains this job"}, {"in"=>"query", "name"=>"pageSize", "description"=>"If there are many jobs, limit response to at most this many"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Set this to the next_page_token field of a previous responseto request additional results in a long list"}, {"in"=>"path", "name"=>"projectId", "description"=>"The project which owns the jobs"}, {"in"=>"query", "name"=>"view", "description"=>"Level of information requested in response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}, "post"=>{"summary"=>"Create Project Job", "description"=>"Creates a Cloud Dataflow job.", "operationId"=>"dataflow.projects.jobs.create", "x-api-path-slug"=>"v1b3projectsprojectidjobs-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"location", "description"=>"The location that contains this job"}, {"in"=>"path", "name"=>"projectId", "description"=>"The ID of the Cloud Platform project that the job belongs to"}, {"in"=>"query", "name"=>"replaceJobId", "description"=>"Deprecated"}, {"in"=>"query", "name"=>"view", "description"=>"The level of information requested in response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/v1b3/projects/{projectId}/jobs/{jobId}"=>{"get"=>{"summary"=>"Get Project Job", "description"=>"Gets the state of the specified Cloud Dataflow job.", "operationId"=>"dataflow.projects.jobs.get", "x-api-path-slug"=>"v1b3projectsprojectidjobsjobid-get", "parameters"=>[{"in"=>"path", "name"=>"jobId", "description"=>"The job ID"}, {"in"=>"query", "name"=>"location", "description"=>"The location that contains this job"}, {"in"=>"path", "name"=>"projectId", "description"=>"The ID of the Cloud Platform project that the job belongs to"}, {"in"=>"query", "name"=>"view", "description"=>"The level of information requested in response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}, "put"=>{"summary"=>"Update Project Job", "description"=>"Updates the state of an existing Cloud Dataflow job.", "operationId"=>"dataflow.projects.jobs.update", "x-api-path-slug"=>"v1b3projectsprojectidjobsjobid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"jobId", "description"=>"The job ID"}, {"in"=>"query", "name"=>"location", "description"=>"The location that contains this job"}, {"in"=>"path", "name"=>"projectId", "description"=>"The ID of the Cloud Platform project that the job belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig"=>{"post"=>{"summary"=>"Get Encoded Debug Info", "description"=>"Get encoded debug configuration for component. Not cacheable.", "operationId"=>"dataflow.projects.jobs.debug.getConfig", "x-api-path-slug"=>"v1b3projectsprojectidjobsjobiddebuggetconfig-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"jobId", "description"=>"The job id"}, {"in"=>"path", "name"=>"projectId", "description"=>"The project id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Debug Info"]}}, "/v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture"=>{"post"=>{"summary"=>"Send Encoded Debug Info", "description"=>"Send encoded debug capture data for component.", "operationId"=>"dataflow.projects.jobs.debug.sendCapture", "x-api-path-slug"=>"v1b3projectsprojectidjobsjobiddebugsendcapture-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"jobId", "description"=>"The job id"}, {"in"=>"path", "name"=>"projectId", "description"=>"The project id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Debug Info"]}}, "/v1b3/projects/{projectId}/jobs/{jobId}/messages"=>{"get"=>{"summary"=>"Get Job Status", "description"=>"Request the job status.", "operationId"=>"dataflow.projects.jobs.messages.list", "x-api-path-slug"=>"v1b3projectsprojectidjobsjobidmessages-get", "parameters"=>[{"in"=>"query", "name"=>"endTime", "description"=>"Return only messages with timestamps < end_time"}, {"in"=>"path", "name"=>"jobId", "description"=>"The job to get messages about"}, {"in"=>"query", "name"=>"location", "description"=>"The location which contains the job specified by job_id"}, {"in"=>"query", "name"=>"minimumImportance", "description"=>"Filter to only get messages with importance >= level"}, {"in"=>"query", "name"=>"pageSize", "description"=>"If specified, determines the maximum number of messages toreturn"}, {"in"=>"query", "name"=>"pageToken", "description"=>"If supplied, this should be the value of next_page_token returnedby an earlier call"}, {"in"=>"path", "name"=>"projectId", "description"=>"A project id"}, {"in"=>"query", "name"=>"startTime", "description"=>"If specified, return only messages with timestamps >= start_time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/v1b3/projects/{projectId}/jobs/{jobId}/metrics"=>{"get"=>{"summary"=>"Get Job Metrics", "description"=>"Request the job status.", "operationId"=>"dataflow.projects.jobs.getMetrics", "x-api-path-slug"=>"v1b3projectsprojectidjobsjobidmetrics-get", "parameters"=>[{"in"=>"path", "name"=>"jobId", "description"=>"The job to get messages for"}, {"in"=>"query", "name"=>"location", "description"=>"The location which contains the job specified by job_id"}, {"in"=>"path", "name"=>"projectId", "description"=>"A project id"}, {"in"=>"query", "name"=>"startTime", "description"=>"Return only metric data that has changed since this time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease"=>{"post"=>{"summary"=>"Work Item Run", "description"=>"Leases a dataflow WorkItem to run.", "operationId"=>"dataflow.projects.jobs.workItems.lease", "x-api-path-slug"=>"v1b3projectsprojectidjobsjobidworkitemslease-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"jobId", "description"=>"Identifies the workflow job this worker belongs to"}, {"in"=>"path", "name"=>"projectId", "description"=>"Identifies the project this worker belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Work item"]}}, "/v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus"=>{"post"=>{"summary"=>"Work Item Status", "description"=>"Reports the status of dataflow WorkItems leased by a worker.", "operationId"=>"dataflow.projects.jobs.workItems.reportStatus", "x-api-path-slug"=>"v1b3projectsprojectidjobsjobidworkitemsreportstatus-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"jobId", "description"=>"The job which the WorkItem is part of"}, {"in"=>"path", "name"=>"projectId", "description"=>"The project which owns the WorkItems job"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Work item"]}}, "/v1b3/projects/{projectId}/locations/{location}/jobs"=>{"get"=>{"summary"=>"Get Project Jobs for Location", "description"=>"List the jobs of a project.", "operationId"=>"dataflow.projects.locations.jobs.list", "x-api-path-slug"=>"v1b3projectsprojectidlocationslocationjobs-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"The kind of filter to use"}, {"in"=>"path", "name"=>"location", "description"=>"The location that contains this job"}, {"in"=>"query", "name"=>"pageSize", "description"=>"If there are many jobs, limit response to at most this many"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Set this to the next_page_token field of a previous responseto request additional results in a long list"}, {"in"=>"path", "name"=>"projectId", "description"=>"The project which owns the jobs"}, {"in"=>"query", "name"=>"view", "description"=>"Level of information requested in response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}, "post"=>{"summary"=>"Create Project Job for Location", "description"=>"Creates a Cloud Dataflow job.", "operationId"=>"dataflow.projects.locations.jobs.create", "x-api-path-slug"=>"v1b3projectsprojectidlocationslocationjobs-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"location", "description"=>"The location that contains this job"}, {"in"=>"path", "name"=>"projectId", "description"=>"The ID of the Cloud Platform project that the job belongs to"}, {"in"=>"query", "name"=>"replaceJobId", "description"=>"Deprecated"}, {"in"=>"query", "name"=>"view", "description"=>"The level of information requested in response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}"=>{"get"=>{"summary"=>"Get State of Project Job for Location", "description"=>"Gets the state of the specified Cloud Dataflow job.", "operationId"=>"dataflow.projects.locations.jobs.get", "x-api-path-slug"=>"v1b3projectsprojectidlocationslocationjobsjobid-get", "parameters"=>[{"in"=>"path", "name"=>"jobId", "description"=>"The job ID"}, {"in"=>"path", "name"=>"location", "description"=>"The location that contains this job"}, {"in"=>"path", "name"=>"projectId", "description"=>"The ID of the Cloud Platform project that the job belongs to"}, {"in"=>"query", "name"=>"view", "description"=>"The level of information requested in response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}, "put"=>{"summary"=>"Get State of Project Job for Location", "description"=>"Updates the state of an existing Cloud Dataflow job.", "operationId"=>"dataflow.projects.locations.jobs.update", "x-api-path-slug"=>"v1b3projectsprojectidlocationslocationjobsjobid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"jobId", "description"=>"The job ID"}, {"in"=>"path", "name"=>"location", "description"=>"The location that contains this job"}, {"in"=>"path", "name"=>"projectId", "description"=>"The ID of the Cloud Platform project that the job belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages"=>{"get"=>{"summary"=>"Get Job Status", "description"=>"Request the job status.", "operationId"=>"dataflow.projects.locations.jobs.messages.list", "x-api-path-slug"=>"v1b3projectsprojectidlocationslocationjobsjobidmessages-get", "parameters"=>[{"in"=>"query", "name"=>"endTime", "description"=>"Return only messages with timestamps < end_time"}, {"in"=>"path", "name"=>"jobId", "description"=>"The job to get messages about"}, {"in"=>"path", "name"=>"location", "description"=>"The location which contains the job specified by job_id"}, {"in"=>"query", "name"=>"minimumImportance", "description"=>"Filter to only get messages with importance >= level"}, {"in"=>"query", "name"=>"pageSize", "description"=>"If specified, determines the maximum number of messages toreturn"}, {"in"=>"query", "name"=>"pageToken", "description"=>"If supplied, this should be the value of next_page_token returnedby an earlier call"}, {"in"=>"path", "name"=>"projectId", "description"=>"A project id"}, {"in"=>"query", "name"=>"startTime", "description"=>"If specified, return only messages with timestamps >= start_time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics"=>{"get"=>{"summary"=>"Get Job Status", "description"=>"Request the job status.", "operationId"=>"dataflow.projects.locations.jobs.getMetrics", "x-api-path-slug"=>"v1b3projectsprojectidlocationslocationjobsjobidmetrics-get", "parameters"=>[{"in"=>"path", "name"=>"jobId", "description"=>"The job to get messages for"}, {"in"=>"path", "name"=>"location", "description"=>"The location which contains the job specified by job_id"}, {"in"=>"path", "name"=>"projectId", "description"=>"A project id"}, {"in"=>"query", "name"=>"startTime", "description"=>"Return only metric data that has changed since this time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job"]}}, "/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease"=>{"post"=>{"summary"=>"Work Item Run", "description"=>"Leases a dataflow WorkItem to run.", "operationId"=>"dataflow.projects.locations.jobs.workItems.lease", "x-api-path-slug"=>"v1b3projectsprojectidlocationslocationjobsjobidworkitemslease-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"jobId", "description"=>"Identifies the workflow job this worker belongs to"}, {"in"=>"path", "name"=>"location", "description"=>"The location which contains the WorkItems job"}, {"in"=>"path", "name"=>"projectId", "description"=>"Identifies the project this worker belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Work item"]}}, "/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus"=>{"post"=>{"summary"=>"Work Item Status", "description"=>"Reports the status of dataflow WorkItems leased by a worker.", "operationId"=>"dataflow.projects.locations.jobs.workItems.reportStatus", "x-api-path-slug"=>"v1b3projectsprojectidlocationslocationjobsjobidworkitemsreportstatus-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"jobId", "description"=>"The job which the WorkItem is part of"}, {"in"=>"path", "name"=>"location", "description"=>"The location which contains the WorkItems job"}, {"in"=>"path", "name"=>"projectId", "description"=>"The project which owns the WorkItems job"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Template"]}}, "/v1b3/projects/{projectId}/templates"=>{"post"=>{"summary"=>"Create Job Template", "description"=>"Creates a Cloud Dataflow job from a template.", "operationId"=>"dataflow.projects.templates.create", "x-api-path-slug"=>"v1b3projectsprojectidtemplates-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Template"]}}, "/v1b3/projects/{projectId}/templates:get"=>{"get"=>{"summary"=>"Get Job Template", "description"=>"Get the template associated with a template.", "operationId"=>"dataflow.projects.templates.get", "x-api-path-slug"=>"v1b3projectsprojectidtemplatesget-get", "parameters"=>[{"in"=>"query", "name"=>"gcsPath", "description"=>"Required"}, {"in"=>"path", "name"=>"projectId", "description"=>"Required"}, {"in"=>"query", "name"=>"view", "description"=>"The view to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Template"]}}, "/v1b3/projects/{projectId}/templates:launch"=>{"post"=>{"summary"=>"Launch Job Template", "description"=>"Launch a template.", "operationId"=>"dataflow.projects.templates.launch", "x-api-path-slug"=>"v1b3projectsprojectidtemplateslaunch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Whether or not the job should actually be executed aftervalidating parameters"}, {"in"=>"query", "name"=>"gcsPath", "description"=>"Required"}, {"in"=>"path", "name"=>"projectId", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Template"]}}}}, "apis"=>{"name"=>"Google Dataflow", "x-slug"=>"google-dataflow", "description"=>"Dataflow is a unified programming model and a managed service for developing and executing a wide range of data processing patterns including ETL, batch computation, and continuous computation. Cloud Dataflow frees you from operational tasks like resource management and performance optimization.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-cloud-dataflow.jpeg", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Data,Google APIs,iPaaS,Orchestration,Profiles,Relative Data,SDIO Competition,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-dataflow/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Dataflow API", "x-api-slug"=>"google-cloud-dataflow-api", "description"=>"Dataflow is a unified programming model and a managed service for developing and executing a wide range of data processing patterns including ETL, batch computation, and continuous computation. Cloud Dataflow frees you from operational tasks like resource management and performance optimization.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-cloud-dataflow.jpeg", "humanURL"=>"https://cloud.google.com/dataflow/", "baseURL"=>"://dataflow.googleapis.com//", "tags"=>"API Provider,API Service Provider,Data,Google APIs,iPaaS,Orchestration,Profiles,Relative Data,SDIO Competition,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-dataflow/google-cloud-dataflow-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-hacker-news-search", "url"=>"Google DataFlow"}, {"type"=>"x-code", "url"=>"https://cloud.google.com/dataflow/docs/samples"}, {"type"=>"x-concepts", "url"=>"https://cloud.google.com/dataflow/docs/concepts"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/dataflow/docs/"}, {"type"=>"x-faq", "url"=>"https://cloud.google.com/dataflow/faq"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/dataflow/docs/how-to"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/dataflow/pricing"}, {"type"=>"x-rate-limits", "url"=>"https://cloud.google.com/dataflow/limits"}, {"type"=>"x-service-level-agreements", "url"=>"https://cloud.google.com/dataflow/sla"}, {"type"=>"x-support", "url"=>"https://cloud.google.com/dataflow/support"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/dataflow/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
nxtport{"portcall-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"NxtPort", "x-complete"=>1, "info"=>{"title"=>"Portcall+ API (sandbox)", "description"=>"portplus-api", "version"=>"1.0.0"}, "host"=>"api-sb.nxtport.eu", "basePath"=>"/PortCallPlus/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/vessels/expected"=>{"get"=>{"summary"=>"Get Expected Vessels", "description"=>"Get all the expected vessels of BEANR and BEZEE", "operationId"=>"Vessels_Expected", "x-api-path-slug"=>"vesselsexpected-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Vessels", "Ports"]}}, "/vessels/in-port"=>{"get"=>{"summary"=>"Get Vessels In Port", "description"=>"Get all the in-port vessels of BEANR and BEZEE", "operationId"=>"Vessels_InPort", "x-api-path-slug"=>"vesselsinport-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Vesses", "Ports"]}}}}, "port-portdirectory-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"NxtPort", "x-complete"=>1, "info"=>{"title"=>"Port+ Portdirectory API (live)", "description"=>"port-directory-api", "version"=>"1.0.0"}, "host"=>"api.nxtport.eu", "basePath"=>"/portdirectory/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/companies"=>{"get"=>{"summary"=>"Get Companies", "description"=>"Get companies where name contains input.", "operationId"=>"Company_GetCompaniesOverviewContainingName", "x-api-path-slug"=>"companies-get", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"Name of the company"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies"]}}, "/companies/{id}"=>{"get"=>{"summary"=>"Get Companies", "description"=>"Get a company by its id.", "operationId"=>"Company_GetCompanyById", "x-api-path-slug"=>"companiesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Format - uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies"]}}, "/companies/name/{name}"=>{"get"=>{"summary"=>"Get Companies Name Name", "description"=>"Get a company by its name.", "operationId"=>"Company_GetCompanyByName", "x-api-path-slug"=>"companiesnamename-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Name of the company"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "Name", "Name"]}}, "/companies/pcs/{pcs}"=>{"get"=>{"summary"=>"Get Companies Pcs Pcs", "description"=>"Get a company by its pcs code.", "operationId"=>"Company_GetCompanyByPcs", "x-api-path-slug"=>"companiespcspcs-get", "parameters"=>[{"in"=>"path", "name"=>"pcs", "description"=>"Pcs code of the company"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "Pcs", "Pcs"]}}, "/companies/vat/{vat}"=>{"get"=>{"summary"=>"Get Companies Vat Vat", "description"=>"Get a company by its vat.", "operationId"=>"Company_GetCompanyByVat", "x-api-path-slug"=>"companiesvatvat-get", "parameters"=>[{"in"=>"path", "name"=>"vat", "description"=>"Vat of the company"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "Vat", "Vat"]}}}}, "nxtport-un-location-codes-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"NxtPort", "x-complete"=>1, "info"=>{"title"=>"UN Location Codes API (live)", "description"=>"available-apis-for-the-un-location-codes", "version"=>"1.0.0"}, "host"=>"api.nxtport.eu", "basePath"=>"/unlocodes/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/countries"=>{"get"=>{"summary"=>"Get Countries", "description"=>"Get a list of all the countries. The API will return the complete list of the existing countries with their country name and 2-character country code in JSON format. The example output for a HTTP Status code 200 contains a subset of the possible outcome.", "operationId"=>"getCountries", "x-api-path-slug"=>"countries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countries"]}}, "/countries/{countryCode}"=>{"get"=>{"summary"=>"Get Countries Countrycode", "description"=>"Get the details of 1 specific country, specified by the country code in the query parameter. Both the country name and country code are returned in a JSON object. The example response in case of HTTP Status Code 200 contains the result when requested for countryCode BE.", "operationId"=>"getCountry", "x-api-path-slug"=>"countriescountrycode-get", "parameters"=>[{"in"=>"path", "name"=>"countryCode", "description"=>"2-character country code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countries", "Countrycode"]}}, "/countries/{countryCode}/subdivisions"=>{"get"=>{"summary"=>"Get Countries Code Subdivisions", "description"=>"Get a list of all the subdivisions of a certain country, specified by the country code in the query parameter. The example response contains a subset of the output when requested for BE.", "operationId"=>"getCountrySubdivisions", "x-api-path-slug"=>"countriescountrycodesubdivisions-get", "parameters"=>[{"in"=>"path", "name"=>"countryCode", "description"=>"2-character country code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countries", "Countrycode", "Subdivisions"]}}, "/countries/{countryCode}/subdivisions/{subdivisionCode}"=>{"get"=>{"summary"=>"Get Countries Country Code Subdivisions Code", "description"=>"Get the details of 1 specific subdivision, based on the countryCode and subdivisionCode in the query parameters.", "operationId"=>"getCountrySubdivision", "x-api-path-slug"=>"countriescountrycodesubdivisionssubdivisioncode-get", "parameters"=>[{"in"=>"path", "name"=>"countryCode", "description"=>"2-character country code"}, {"in"=>"path", "name"=>"subdivisionCode", "description"=>"3-character subdivision code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countries", "Countrycode", "Subdivisions", "Subdivisioncode"]}}, "/locations"=>{"get"=>{"summary"=>"Get Locations", "description"=>"This api will return a (paged) list of locations that match the search parameters (query parameters) ordered by the name without diacritics.", "operationId"=>"searchLocations", "x-api-path-slug"=>"locations-get", "parameters"=>[{"in"=>"query", "name"=>"code", "description"=>"3-character location code"}, {"in"=>"query", "name"=>"country", "description"=>"2-character country code"}, {"in"=>"query", "name"=>"page", "description"=>"the page number to allow paging (needs to be an integer > 0)"}, {"in"=>"query", "name"=>"searchterm", "description"=>"Part of the name of the location without diacritics"}, {"in"=>"query", "name"=>"size", "description"=>"the page size to allow paging (needs to be an integer 0 < pagesize < 1000)"}, {"in"=>"query", "name"=>"subdiv", "description"=>"3-character subdivision code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Locations"]}}, "/locations/{latitude}/{longitude}/{radius}"=>{"get"=>{"summary"=>"Get Locations Latitude Longitude Radius", "description"=>"This api will return locations in a certain radius of a point, ordered by distance , not necessarily in the same country", "operationId"=>"locations_getinNeighbourhood", "x-api-path-slug"=>"locationslatitudelongituderadius-get", "parameters"=>[{"in"=>"path", "name"=>"latitude", "description"=>"the latitude of the specified point"}, {"in"=>"path", "name"=>"longitude", "description"=>"the longitude of the specified point"}, {"in"=>"query", "name"=>"page", "description"=>"the page number to allow paging (needs to be an integer > 0)"}, {"in"=>"path", "name"=>"radius", "description"=>"the radius in km (max 75km)"}, {"in"=>"query", "name"=>"size", "description"=>"the page size to allow paging (needs to be an integer 0 < pagesize < 1000)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Locations", "Latitude", "Longitude", "Radius"]}}, "/locations/{locode}"=>{"get"=>{"summary"=>"Get Locations Locode", "description"=>"Get the details of 1 location based on the locode.", "operationId"=>"locations_getByCountryAndLocode", "x-api-path-slug"=>"locationslocode-get", "parameters"=>[{"in"=>"path", "name"=>"locode", "description"=>"5-character location code (country code + location code)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Locations", "Locode"]}}}}, "nxtport-vessel-stay-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"NxtPort", "x-complete"=>1, "info"=>{"title"=>"Vessel Stay API (live)", "description"=>"stay-numbers-port-of-antwerp-api", "version"=>"1.0.0"}, "host"=>"api.nxtport.eu", "basePath"=>"/sa/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/stays/{imoNumber}"=>{"get"=>{"summary"=>"Get Stay", "description"=>"Get a single stay by IMO number.", "operationId"=>"Stays By ImoNumber", "x-api-path-slug"=>"staysimonumber-get", "parameters"=>[{"in"=>"path", "name"=>"imoNumber"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Stays"]}}}}, "nxtport-tmining-secure-container-release-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"NxtPort", "x-complete"=>1, "info"=>{"title"=>"T-mining Secure Container Release API (live)", "description"=>"this-api-allows-carriers-forwarders-and-transport-companies-to-securely-release-full-import-containers-on-a-terminal-and-to-transfer-this-release-to-the-other-parties-in-the-chain-up-to-the-truck-driver-or-the-bargerail-operator-", "contact"=>{"name"=>"T-Mining API support", "url"=>"http://support.t-mining.be/", "email"=>"support@t-mining.be"}, "version"=>"1.0.0"}, "host"=>"api.nxtport.eu", "basePath"=>"/blockchain", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/v1/releases/"=>{"post"=>{"summary"=>"Create release", "description"=>"Serves to create a Container together with its PickupRight that gets automatically transferred to the consignee.", "operationId"=>"postApiV1Releases", "x-api-path-slug"=>"apiv1releases-post", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Release"]}}, "/api/v1/releases/{id}"=>{"delete"=>{"summary"=>"Block", "description"=>"Blocking a release is done by a delete. This will revoke the PickupRight from the consignee. The Container and its PickupRight are deleted. Afterwards it is still possible to release again.\n The following conditions apply for this to work:\n* the container must have been released, i.e. there must be a vallid PickupRight for the Container\n* the PickupRight should not be transferred to another Organization than the one that got the relesase initially\n* the PickupRight should not yet be assigned (to a driver / skipper)", "operationId"=>"deleteApiV1Releases", "x-api-path-slug"=>"apiv1releasesid-delete", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}, {"in"=>"path", "name"=>"id", "description"=>"original id of the release as defined in the client system and passed during the creation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Block"]}}, "/api/v1/containers"=>{"get"=>{"summary"=>"List Containers", "description"=>"Get all containers currently in the database. Only Containers accessible by the user will be reported.", "operationId"=>"getApiV1Containers", "x-api-path-slug"=>"apiv1containers-get", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Containers"]}, "post"=>{"summary"=>"Create a new Container", "description"=>"Create a new container.\nIf all goes well, a 200 status code is returned.\nIf the create fails, a 500 status code is returned.", "operationId"=>"postApiV1Containers", "x-api-path-slug"=>"apiv1containers-post", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Container"]}}, "/api/v1/containers/{id}/events"=>{"get"=>{"summary"=>"Get container events", "description"=>"Get the list of Events related to a container", "operationId"=>"getApiV1ContainersEvents", "x-api-path-slug"=>"apiv1containersidevents-get", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}, {"in"=>"path", "name"=>"id", "description"=>"id of the Container"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Container", "Events"]}}, "/api/v1/containers/{id}/release"=>{"put"=>{"summary"=>"Release", "description"=>"Release a container to an organization.", "operationId"=>"putApiV1ContainersRelease", "x-api-path-slug"=>"apiv1containersidrelease-put", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"id of the Container"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Release"]}}, "/api/v1/pickup_rights/"=>{"get"=>{"summary"=>"List PickupRights", "description"=>"Get all PickupRights that are assigned / transferred to the users's Organization.", "operationId"=>"getApiV1PickupRights", "x-api-path-slug"=>"apiv1pickup-rights-get", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "PickupRights"]}}, "/api/v1/pickup_rights/{id}/request"=>{"get"=>{"summary"=>"Request", "description"=>"When a driver needs to pickup a container, he should send a request to get\nauthorization for the pickup. This will return a **temporary pincode**.\nIf no authorization is given, http status 403 is returned", "operationId"=>"getApiV1PickupRightsRequest", "x-api-path-slug"=>"apiv1pickup-rightsidrequest-get", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}, {"in"=>"path", "name"=>"id", "description"=>"id of the PickupRight"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request"]}}, "/api/v1/pickup_rights/{id}/transfer"=>{"put"=>{"summary"=>"Transfer", "description"=>"Transfer the PickupRight to another Organization (a subcontractor).", "operationId"=>"putApiV1PickupRightsTransfer", "x-api-path-slug"=>"apiv1pickup-rightsidtransfer-put", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"id of the PickupRight (as reported by List PickupRights)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transfer"]}}, "/api/v1/pickup_rights/{id}/assign"=>{"put"=>{"summary"=>"Assign", "description"=>"Assign the PickupRight to a truck driver.", "operationId"=>"putApiV1PickupRightsAssign", "x-api-path-slug"=>"apiv1pickup-rightsidassign-put", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"id of the PickupRight as reported by List PickupRights"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assign"]}}, "/api/v1/pickup_rights/{id}/revoke_assignment"=>{"put"=>{"summary"=>"Revoke Assignment", "description"=>"Revoke the current PickupRight assignment. This must be used in case you did an assign of a PickupRight to a driver and you want to cancel this. This action is only possible as long as the PickupRight is not exercised.", "operationId"=>"putApiV1PickupRightsRevokeAssignment", "x-api-path-slug"=>"apiv1pickup-rightsidrevoke-assignment-put", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}, {"in"=>"path", "name"=>"id", "description"=>"id of the PickupRight as reported by List PickupRights"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Revoke", "Assignment"]}}, "/api/v1/pickup_rights/{id}/revoke_transfer"=>{"put"=>{"summary"=>"Revoke Transfer", "description"=>"Revoke the current PickupRight transfer. This must be used in case you did a transfer of a PickupRight to another Organization and you want to cancel this. This action is only possible as long as the PickupRight is not assigned.", "operationId"=>"putApiV1PickupRightsRevokeTransfer", "x-api-path-slug"=>"apiv1pickup-rightsidrevoke-transfer-put", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}, {"in"=>"path", "name"=>"id", "description"=>"id of the PickupRight as reported by List PickupRights"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Revoke", "Transfer"]}}, "/api/v1/pickups"=>{"post"=>{"summary"=>"Create pickup", "description"=>"When the driver has picked up the container, a request should be sent to the server to record (create) the pickup. The server will record the datetime of the pickup.", "operationId"=>"postApiV1Pickups", "x-api-path-slug"=>"apiv1pickups-post", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pickup"]}}, "/api/v1/deliveries"=>{"post"=>{"summary"=>"Record delivery", "description"=>"When the driver has delivered the container, a request should be sent to the server to record (create) the delivery. Note that a delivery is associated with a PickupRight, because the driver who gets a PickupRight, will automatically get a right to deliver the container. For that reason, the PickupRight must be reported.", "operationId"=>"postApiV1Deliveries", "x-api-path-slug"=>"apiv1deliveries-post", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Record", "Delivery"]}}, "/api/v1/coordinates/"=>{"get"=>{"summary"=>"Get Coordinates", "description"=>"Get the coordinates of the location with the given name and type.", "operationId"=>"getApiV1Coordinates", "x-api-path-slug"=>"apiv1coordinates-get", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}, {"in"=>"query", "name"=>"name", "description"=>"name of the location"}, {"in"=>"query", "name"=>"type", "description"=>"type of the Location, can be Quay, Depot, Warehouse, InlandTerminal, Checkpoint"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Coordinates"]}}, "/api/v1/coordinates"=>{"get"=>{"summary"=>"Get all coordinates", "description"=>"Get the coordinates of all known locations.", "operationId"=>"getApiV1Coordinates", "x-api-path-slug"=>"apiv1coordinates-get", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Coordinates"]}}, "/api/v1/locations"=>{"get"=>{"summary"=>"List", "description"=>"List all Locations with their details. Locations have a type, name and the ISRS Locode.", "operationId"=>"getApiV1Locations", "x-api-path-slug"=>"apiv1locations-get", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List"]}, "post"=>{"summary"=>"Create", "description"=>"Create a new Location", "operationId"=>"postApiV1Locations", "x-api-path-slug"=>"apiv1locations-post", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Create"]}}, "/api/v1/locations/{id}"=>{"get"=>{"summary"=>"Details", "description"=>"Get details of 1 location.", "operationId"=>"getApiV1Locations", "x-api-path-slug"=>"apiv1locationsid-get", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}, {"in"=>"path", "name"=>"id", "description"=>"id of the location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Details"]}}, "/api/v1/container_types"=>{"get"=>{"summary"=>"List", "description"=>"List all ContainerTypes", "operationId"=>"getApiV1ContainerTypes", "x-api-path-slug"=>"apiv1container-types-get", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List"]}}, "/api/v1/organizations"=>{"get"=>{"summary"=>"List", "description"=>"List all registered organizations.", "operationId"=>"getApiV1Organizations", "x-api-path-slug"=>"apiv1organizations-get", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List"]}, "post"=>{"summary"=>"Register organization", "description"=>"Register an Organization with a name. The name must be unique, so if one registers an Organization with a name that is already in use, an error will occur.", "operationId"=>"postApiV1Organizations", "x-api-path-slug"=>"apiv1organizations-post", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "Organization"]}}, "/api/v1/users"=>{"get"=>{"summary"=>"List", "description"=>"List all users registered.", "operationId"=>"getApiV1Users", "x-api-path-slug"=>"apiv1users-get", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List"]}, "post"=>{"summary"=>"Register user", "description"=>"Register information of a user. Note that the \"real\" (human) user should have\nan account on the blockchain (upfront). This account is represented by an address on the chain, which is based on the public key of the user. Registering therefore means defining user **properties** like a username, which can then be used to refer to users in a more human-friendly way then by using the account addresses. User registration should be done by the user who owns an account on the chain. As a result of registration, a User contract is created on the chain, which contains the user properties, and which is owned by the user account. From then on, one can use the username to refer to a user on the web/mobile app.", "operationId"=>"postApiV1Users", "x-api-path-slug"=>"apiv1users-post", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "User"]}}, "/api/v1/events/"=>{"post"=>{"summary"=>"Create an Event", "description"=>"Used to create an event for a container at a specific location and time.\nEach event is defined by a type.\nCurrently a limited number of events (pickup and availability) are supported, but this may be extended with e.g. passage events.\nThere are 2 ways to refer to a Container: by means of its id as defined in the Blockchain (this requires recording these ids in your app), or by means of a combination of the blNumber and isoNumber. Similarly, locations can be specified in 2 ways: by means of their id as defined in the Blockchain or by means of their name. In the latter case the name must be defined in a mapping file for the Organization you - as a user- belong to. Also note that the container may not yet be known in the Blockchain at the time\nan availability event is created!", "operationId"=>"postApiV1Events", "x-api-path-slug"=>"apiv1events-post", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"authentication token of user making the request"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}}}, "nxtport-bel-air-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"NxtPort", "x-complete"=>1, "info"=>{"title"=>"Bel Air API (staging)", "description"=>"api-for-querying-air-quality-data--different-layers-of-and-time-slices-for-each-metric-can-be-queried--the-project-is-part-of-the-antwerp-smart-zone-initiative-", "termsOfService"=>"https://www.nxtport.eu/General-Terms-And-Conditions", "version"=>"1.0.0"}, "host"=>"api-stg.nxtport.eu", "basePath"=>"/belair/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/metrics"=>{"get"=>{"summary"=>"Retrieving supported metrics", "description"=>"The platform allows you to retrieve supported metrics by sending a HTTP GET to /metrics. \nThe string-values for the attribute id can be used as a metricId path parameter in the City Layer operations. \nThe attribute granularity indicates how fine grained temporal pages should be split up when querying individual sources (and can be ignored here).", "operationId"=>"getMetrics", "x-api-path-slug"=>"metrics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MEtrics"]}}, "/layers"=>{"get"=>{"summary"=>"Retrieve available layers", "description"=>"This operation lists the currently available city layers. \nThe returned strings can then be used as a layerId path parameter in the /layers operations included in this API.", "operationId"=>"getLayers", "x-api-path-slug"=>"layers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layers"]}}, "/layers/{layerId}/{metricId}/{date}"=>{"get"=>{"summary"=>"Retrieve the city layer data for the specified layer, metric and date.", "description"=>"This operation retrieves city layer data for the specified layer, metric and date combination. The date is passed in the following format: YYYYMMDD. The values for the layerId and metricId can be fetched from the /layers and /metrics operations.", "operationId"=>"getLayerDateByLayerMetricDate", "x-api-path-slug"=>"layerslayeridmetriciddate-get", "parameters"=>[{"in"=>"path", "name"=>"date", "description"=>"TODO"}, {"in"=>"path", "name"=>"layerId", "description"=>"TODO"}, {"in"=>"path", "name"=>"metricId", "description"=>"TODO"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layers", "Metrics"]}}, "/layers/{layerId}/{metricId}/{date}/{hour}"=>{"get"=>{"summary"=>"Retrieve the city layer data for the specified layer, metric and date.", "description"=>"This operation retrieves city layer data for the specified layer, metric and date combination. The date is passed in the following format: YYYYMMDD. The values for the layerId and metricId can be fetched from the /layers and /metrics operations.", "operationId"=>"getLayerDateByLayerMetricDateHour", "x-api-path-slug"=>"layerslayeridmetriciddatehour-get", "parameters"=>[{"in"=>"path", "name"=>"date", "description"=>"TODO"}, {"in"=>"path", "name"=>"hour", "description"=>"TODO"}, {"in"=>"path", "name"=>"layerId", "description"=>"TODO"}, {"in"=>"path", "name"=>"metricId", "description"=>"TODO"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layers"]}}}}, "nxtport-vgm-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"NxtPort", "x-complete"=>1, "info"=>{"title"=>"VGM API (live)", "description"=>"the-vgm-api-provides-information-about-the-verified-gross-mass-of-a-container-currently-used-in-an-export-flow-as-provided-by-certified-weighing-stations-", "version"=>"1.0.0"}, "host"=>"api.nxtport.eu", "basePath"=>"/VGM/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/nxtportdocument/{bookingnumber}/{containernumber}"=>{"get"=>{"summary"=>"Get VERMAS Files", "description"=>"Returns the VERMAS files with the according booking number and container number", "operationId"=>"NxtportdocumentByBookingnumberByContainernumberGet", "x-api-path-slug"=>"nxtportdocumentbookingnumbercontainernumber-get", "parameters"=>[{"in"=>"path", "name"=>"bookingnumber", "description"=>"bookingnumber"}, {"in"=>"path", "name"=>"containernumber", "description"=>"containernumber"}, {"in"=>"header", "name"=>"Ocp-Apim-Subscription-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "VERMAS", "Files"]}}}}, "nxtport-consignment-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"NxtPort", "x-complete"=>1, "info"=>{"title"=>"NxtPort Consignment API (live)", "description"=>"the-consignmentinfo-api-provides-access-to-the-customs-status-of-consignments-submitted-to-customs-using-a-cuscar-message-", "version"=>"1.0.0"}, "host"=>"api.nxtport.eu", "basePath"=>"/Consignment/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/nxtportdocument/{blnumber}/sn/{stayNumber}"=>{"get"=>{"summary"=>"Returns the file with corresponding blnumbers and staynumber.", "description"=>"Returns the file with corresponding blnumbers and staynumber..", "operationId"=>"NxtportdocumentByBlnumberSnByStayNumberGet", "x-api-path-slug"=>"nxtportdocumentblnumbersnstaynumber-get", "parameters"=>[{"in"=>"path", "name"=>"blnumber", "description"=>"blnumber"}, {"in"=>"header", "name"=>"Ocp-Apim-Subscription-Key"}, {"in"=>"path", "name"=>"stayNumber", "description"=>"staynumber"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "File", "Corresponding", "Blnumbers", "Staynumber"]}}, "/nxtportdocument/{blnumber}/cn/{containerNumber}"=>{"get"=>{"summary"=>"Returns the file with corresponding blnumbers and containernumber.", "description"=>"Returns the file with corresponding blnumbers and containernumber..", "operationId"=>"NxtportdocumentByBlnumberCnByContainerNumberGet", "x-api-path-slug"=>"nxtportdocumentblnumbercncontainernumber-get", "parameters"=>[{"in"=>"path", "name"=>"blnumber", "description"=>"blnumber"}, {"in"=>"path", "name"=>"containerNumber", "description"=>"containernumber"}, {"in"=>"header", "name"=>"Ocp-Apim-Subscription-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "File", "Corresponding", "Blnumbers", "Containernumber"]}}, "/nxtportdocument/{blnumber}/ag/{agent}"=>{"get"=>{"summary"=>"Returns the file with corresponding blnumbers and senderID.", "description"=>"Returns the file with corresponding blnumbers and senderid..", "operationId"=>"NxtportdocumentByBlnumberAgByAgentGet", "x-api-path-slug"=>"nxtportdocumentblnumberagagent-get", "parameters"=>[{"in"=>"path", "name"=>"agent", "description"=>"agent"}, {"in"=>"path", "name"=>"blnumber", "description"=>"blnumber"}, {"in"=>"header", "name"=>"Ocp-Apim-Subscription-Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "File", "Corresponding", "Blnumbers", "SenderID"]}}}}, "apis"=>{"name"=>"NxtPort", "x-slug"=>"nxtport", "description"=>"NxtPort opens the gates to the Port of the future. This project is a milestone in the digitalization of logistics and cargo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28835-www-nxtport-eu.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"3933231", "tags"=>"Data,Enterprise,General Data,Relative Data,SaaS,Service API,Shipping,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"nxtport/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"NxtPort Bel Air API", "x-api-slug"=>"nxtport-bel-air-api", "description"=>"NxtPort opens the gates to the Port of the future. This project is a milestone in the digitalization of logistics and cargo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28835-www-nxtport-eu.jpg", "humanURL"=>"https://www.nxtport.eu", "baseURL"=>"https://api-stg.nxtport.eu//belair/v1", "tags"=>"Data,Enterprise,General Data,Relative Data,SaaS,Service API,Shipping,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/nxtport/layerslayeridmetriciddatehour-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/nxtport/nxtport-bel-air-api-openapi.yaml"}]}, {"name"=>"NxtPort Big Belly API", "x-api-slug"=>"nxtport-big-belly-api", "description"=>"NxtPort opens the gates to the Port of the future. This project is a milestone in the digitalization of logistics and cargo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28835-www-nxtport-eu.jpg", "humanURL"=>"https://www.nxtport.eu", "baseURL"=>"https://api-stg.nxtport.eu//bigbelly/v1", "tags"=>"Layers", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/nxtport/nxtport-big-belly-api-openapi.yaml"}]}, {"name"=>"NxtPort Consignment API", "x-api-slug"=>"nxtport-consignment-api", "description"=>"NxtPort opens the gates to the Port of the future. This project is a milestone in the digitalization of logistics and cargo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28835-www-nxtport-eu.jpg", "humanURL"=>"https://www.nxtport.eu", "baseURL"=>"https://api.nxtport.eu//Consignment/v1", "tags"=>"Devices", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/nxtport/nxtportdocumentblnumberagagent-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/nxtport/nxtport-consignment-api-openapi.yaml"}]}, {"name"=>"NxtPort T-mining Secure Container Release API", "x-api-slug"=>"nxtport-tmining-secure-container-release-api", "description"=>"NxtPort opens the gates to the Port of the future. This project is a milestone in the digitalization of logistics and cargo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28835-www-nxtport-eu.jpg", "humanURL"=>"https://www.nxtport.eu", "baseURL"=>"https://api.nxtport.eu//blockchain", "tags"=>"Returns,File,Corresponding,Blnumbers,SenderID", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/nxtport/nxtport-tmining-secure-container-release-api-openapi.yaml"}]}, {"name"=>"NxtPort UN Location Codes API", "x-api-slug"=>"nxtport-un-location-codes-api", "description"=>"NxtPort opens the gates to the Port of the future. This project is a milestone in the digitalization of logistics and cargo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28835-www-nxtport-eu.jpg", "humanURL"=>"https://www.nxtport.eu", "baseURL"=>"https://api.nxtport.eu//unlocodes/v1", "tags"=>"Event", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/nxtport/locationslocode-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/nxtport/nxtport-un-location-codes-api-openapi.yaml"}]}, {"name"=>"NxtPort Vessel Stay API", "x-api-slug"=>"nxtport-vessel-stay-api", "description"=>"NxtPort opens the gates to the Port of the future. This project is a milestone in the digitalization of logistics and cargo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28835-www-nxtport-eu.jpg", "humanURL"=>"https://www.nxtport.eu", "baseURL"=>"https://api.nxtport.eu//sa/v1", "tags"=>"Locations,Locode", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/nxtport/staysimonumber-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/nxtport/nxtport-vessel-stay-api-openapi.yaml"}]}, {"name"=>"NxtPort VGM API", "x-api-slug"=>"nxtport-vgm-api", "description"=>"NxtPort opens the gates to the Port of the future. This project is a milestone in the digitalization of logistics and cargo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28835-www-nxtport-eu.jpg", "humanURL"=>"https://www.nxtport.eu", "baseURL"=>"https://api.nxtport.eu//VGM/v1", "tags"=>"Shipping,Stays", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/nxtport/nxtportdocumentbookingnumbercontainernumber-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/nxtport/nxtport-vgm-api-openapi.yaml"}]}, {"name"=>"Port+ Portdirectory API", "x-api-slug"=>"port-portdirectory-api", "description"=>"NxtPort opens the gates to the Port of the future. This project is a milestone in the digitalization of logistics and cargo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28835-www-nxtport-eu.jpg", "humanURL"=>"https://www.nxtport.eu", "baseURL"=>"https://api.nxtport.eu//portdirectory/v1", "tags"=>"Shipping,VERMAS,Files", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/nxtport/companiesvatvat-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/nxtport/port-portdirectory-api-openapi.yaml"}]}, {"name"=>"Portcall+ API", "x-api-slug"=>"portcall-api", "description"=>"NxtPort opens the gates to the Port of the future. This project is a milestone in the digitalization of logistics and cargo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28835-www-nxtport-eu.jpg", "humanURL"=>"https://www.nxtport.eu", "baseURL"=>"https://api-sb.nxtport.eu//PortCallPlus/v1", "tags"=>"Companies,Vat,Vat", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/nxtport/vesselsinport-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/nxtport/portcall-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-email", "url"=>"mail@nxtport.eu"}, {"type"=>"x-email", "url"=>"development@nxtport.eu"}, {"type"=>"x-email", "url"=>"privacy@nxtport.eu"}, {"type"=>"x-github", "url"=>"https://github.com/NxtPort"}, {"type"=>"x-openapi", "url"=>"https://github.com/NxtPort/nxtport.github.io/tree/master/api"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/NxtPortNews"}, {"type"=>"x-website", "url"=>"https://www.nxtport.eu"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "nxtport-big-belly-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"NxtPort", "x-complete"=>1, "info"=>{"title"=>"Big Belly API (staging)", "description"=>"api-for-ingestion-of-fill-level-updates-from-smart-containers--the-project-is-part-of-the-antwerp-smart-zone-initiative-", "termsOfService"=>"https://www.nxtport.eu/General-Terms-And-Conditions", "version"=>"1.0.0"}, "host"=>"api-stg.nxtport.eu", "basePath"=>"/bigbelly/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/devices"=>{"post"=>{"summary"=>"Publish Device", "description"=>"Publish the fill level for all Big Belly devices.", "operationId"=>"Publish_Devices", "x-api-path-slug"=>"devices-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-ec2-systems-manager{"amazon-ec2-systems-manager-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS EC2 Systems Manager", "x-complete"=>1, "info"=>{"title"=>"AWS EC2 Systems Manager API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddTagsToResource"=>{"get"=>{"summary"=>"Add Tags To Resource", "description"=>"Adds or overwrites one or more tags for the specified resource.", "operationId"=>"addTagsToResource", "x-api-path-slug"=>"actionaddtagstoresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceId", "description"=>"The resource ID you want to tag", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceType", "description"=>"Specifies the type of resource you are tagging", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"One or more tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources"]}}, "/?Action=CancelCommand"=>{"get"=>{"summary"=>"Cancel Command", "description"=>"Attempts to cancel the command specified by the Command ID.", "operationId"=>"cancelCommand", "x-api-path-slug"=>"actioncancelcommand-get", "parameters"=>[{"in"=>"query", "name"=>"CommandId", "description"=>"The ID of the command you want to cancel", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceIds", "description"=>"(Optional) A list of instance IDs on which you want to cancel the command", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Command"]}}, "/?Action=CreateActivation"=>{"get"=>{"summary"=>"Create Activation", "description"=>"Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage\n these resources using Run Command.", "operationId"=>"createActivation", "x-api-path-slug"=>"actioncreateactivation-get", "parameters"=>[{"in"=>"query", "name"=>"DefaultInstanceName", "description"=>"The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A user-defined description of the resource that you want to register with Amazon EC2", "type"=>"string"}, {"in"=>"query", "name"=>"ExpirationDate", "description"=>"The date by which this activation request should expire", "type"=>"string"}, {"in"=>"query", "name"=>"IamRole", "description"=>"The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance", "type"=>"string"}, {"in"=>"query", "name"=>"RegistrationLimit", "description"=>"Specify the maximum number of managed instances you want to register", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activation"]}}, "/?Action=CreateAssociation"=>{"get"=>{"summary"=>"Create Association", "description"=>"Associates the specified SSM document with the specified instances or targets.", "operationId"=>"createAssociation", "x-api-path-slug"=>"actioncreateassociation-get", "parameters"=>[{"in"=>"query", "name"=>"DocumentVersion", "description"=>"The document version you want to associate with the target(s)", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the SSM document", "type"=>"string"}, {"in"=>"query", "name"=>"OutputLocation", "description"=>"An Amazon S3 bucket where you want to store the output details of the request", "type"=>"string"}, {"in"=>"query", "name"=>"Parameters", "description"=>"The parameters for the documents runtime configuration", "type"=>"string"}, {"in"=>"query", "name"=>"ScheduleExpression", "description"=>"A cron expression when the association will be applied to the target(s)", "type"=>"string"}, {"in"=>"query", "name"=>"Targets", "description"=>"The targets (either instances or tags) for the association", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Association"]}}, "/?Action=CreateAssociationBatch"=>{"get"=>{"summary"=>"Create Association Batch", "description"=>"Associates the specified SSM document with the specified instances or targets.", "operationId"=>"createAssociationBatch", "x-api-path-slug"=>"actioncreateassociationbatch-get", "parameters"=>[{"in"=>"query", "name"=>"Entries", "description"=>"One or more associations", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Association", "Batch"]}}, "/?Action=CreateDocument"=>{"get"=>{"summary"=>"Create Document", "description"=>"Creates an SSM document.", "operationId"=>"createDocument", "x-api-path-slug"=>"actioncreatedocument-get", "parameters"=>[{"in"=>"query", "name"=>"Content", "description"=>"A valid JSON string", "type"=>"string"}, {"in"=>"query", "name"=>"DocumentType", "description"=>"The type of document to create", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"A name for the SSM document", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Document"]}}, "/?Action=CreateMaintenanceWindow"=>{"get"=>{"summary"=>"Create Maintenance Window", "description"=>"Creates a new Maintenance Window.", "operationId"=>"createMaintenanceWindow", "x-api-path-slug"=>"actioncreatemaintenancewindow-get", "parameters"=>[{"in"=>"query", "name"=>"AllowUnassociatedTargets", "description"=>"Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets", "type"=>"string"}, {"in"=>"query", "name"=>"ClientToken", "description"=>"User-provided idempotency token", "type"=>"string"}, {"in"=>"query", "name"=>"Cutoff", "description"=>"The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution", "type"=>"string"}, {"in"=>"query", "name"=>"Duration", "description"=>"The duration of the Maintenance Window in hours", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the Maintenance Window", "type"=>"string"}, {"in"=>"query", "name"=>"Schedule", "description"=>"The schedule of the Maintenance Window in the form of a cron or rate expression", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance", "Window"]}}, "/?Action=CreatePatchBaseline"=>{"get"=>{"summary"=>"Create Patch Baseline", "description"=>"Creates a patch baseline.", "operationId"=>"createPatchBaseline", "x-api-path-slug"=>"actioncreatepatchbaseline-get", "parameters"=>[{"in"=>"query", "name"=>"ApprovalRules", "description"=>"A set of rules used to include patches in the baseline", "type"=>"string"}, {"in"=>"query", "name"=>"ApprovedPatches", "description"=>"A list of explicitly approved patches for the baseline", "type"=>"string"}, {"in"=>"query", "name"=>"ClientToken", "description"=>"Caller-provided idempotency token", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A description of the patch baseline", "type"=>"string"}, {"in"=>"query", "name"=>"GlobalFilters", "description"=>"A set of global filters used to exclude patches from the baseline", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the patch baseline", "type"=>"string"}, {"in"=>"query", "name"=>"RejectedPatches", "description"=>"A list of explicitly rejected patches for the baseline", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Baseline"]}}, "/?Action=DeleteActivation"=>{"get"=>{"summary"=>"Delete Activation", "description"=>"Deletes an activation.", "operationId"=>"deleteActivation", "x-api-path-slug"=>"actiondeleteactivation-get", "parameters"=>[{"in"=>"query", "name"=>"ActivationId", "description"=>"The ID of the activation that you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activation"]}}, "/?Action=DeleteAssociation"=>{"get"=>{"summary"=>"Delete Association", "description"=>"Disassociates the specified SSM document from the specified instance.", "operationId"=>"deleteAssociation", "x-api-path-slug"=>"actiondeleteassociation-get", "parameters"=>[{"in"=>"query", "name"=>"AssociationId", "description"=>"The association ID that you want to delete", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the SSM document", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Association"]}}, "/?Action=DeleteDocument"=>{"get"=>{"summary"=>"Delete Document", "description"=>"Deletes the SSM document and all instance associations to the document.", "operationId"=>"deleteDocument", "x-api-path-slug"=>"actiondeletedocument-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"The name of the SSM document", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Document"]}}, "/?Action=DeleteMaintenanceWindow"=>{"get"=>{"summary"=>"Delete Maintenance Window", "description"=>"Deletes a Maintenance Window.", "operationId"=>"deleteMaintenanceWindow", "x-api-path-slug"=>"actiondeletemaintenancewindow-get", "parameters"=>[{"in"=>"query", "name"=>"WindowId", "description"=>"The ID of the Maintenance Window to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance", "Window"]}}, "/?Action=DeleteParameter"=>{"get"=>{"summary"=>"Delete Parameter", "description"=>"Delete a parameter from the system.", "operationId"=>"deleteParameter", "x-api-path-slug"=>"actiondeleteparameter-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"The name of the parameter to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameter"]}}, "/?Action=DeletePatchBaseline"=>{"get"=>{"summary"=>"Delete Patch Baseline", "description"=>"Deletes a patch baseline.", "operationId"=>"deletePatchBaseline", "x-api-path-slug"=>"actiondeletepatchbaseline-get", "parameters"=>[{"in"=>"query", "name"=>"BaselineId", "description"=>"The ID of the patch baseline to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Baseline"]}}, "/?Action=DeregisterManagedInstance"=>{"get"=>{"summary"=>"Deregister Managed Instance", "description"=>"Removes the server or virtual machine from the list of registered servers.", "operationId"=>"deregisterManagedInstance", "x-api-path-slug"=>"actionderegistermanagedinstance-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The ID assigned to the managed instance when you registered it using the activation process", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deregister", "Managed", "Instance"]}}, "/?Action=DeregisterPatchBaselineForPatchGroup"=>{"get"=>{"summary"=>"Deregister Patch Baseline For Patch Group", "description"=>"Removes a patch group from a patch baseline.", "operationId"=>"deregisterPatchBaselineForPatchGroup", "x-api-path-slug"=>"actionderegisterpatchbaselineforpatchgroup-get", "parameters"=>[{"in"=>"query", "name"=>"BaselineId", "description"=>"The ID of the patch baseline to deregister the patch group from", "type"=>"string"}, {"in"=>"query", "name"=>"PatchGroup", "description"=>"The name of the patch group that should be deregistered from the patch baseline", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deregister", "BaselineGroup"]}}, "/?Action=DeregisterTargetFromMaintenanceWindow"=>{"get"=>{"summary"=>"Deregister Target From Maintenance Window", "description"=>"Removes a target from a Maintenance Window.", "operationId"=>"deregisterTargetFromMaintenanceWindow", "x-api-path-slug"=>"actionderegistertargetfrommaintenancewindow-get", "parameters"=>[{"in"=>"query", "name"=>"WindowId", "description"=>"The ID of the Maintenance Window the target should be removed from", "type"=>"string"}, {"in"=>"query", "name"=>"WindowTargetId", "description"=>"The ID of the target definition to remove", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deregister", "Target", "From", "Maintenance", "Window"]}}, "/?Action=DeregisterTaskFromMaintenanceWindow"=>{"get"=>{"summary"=>"Deregister Task From Maintenance Window", "description"=>"Removes a task from a Maintenance Window.", "operationId"=>"deregisterTaskFromMaintenanceWindow", "x-api-path-slug"=>"actionderegistertaskfrommaintenancewindow-get", "parameters"=>[{"in"=>"query", "name"=>"WindowId", "description"=>"The ID of the Maintenance Window the task should be removed from", "type"=>"string"}, {"in"=>"query", "name"=>"WindowTaskId", "description"=>"The ID of the task to remove from the Maintenance Window", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deregister", "Task", "From", "Maintenance", "Window"]}}, "/?Action=DescribeActivations"=>{"get"=>{"summary"=>"Describe Activations", "description"=>"Details about the activation, including: the date and time the activation was created,\n the expiration date, the IAM role assigned to the instances in the activation, and the number of\n instances activated by this registration.", "operationId"=>"describeActivations", "x-api-path-slug"=>"actiondescribeactivations-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"A filter to view information about your activations", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"A token to start the list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activations"]}}, "/?Action=DescribeAssociation"=>{"get"=>{"summary"=>"Describe Association", "description"=>"Describes the associations for the specified SSM document or instance.", "operationId"=>"describeAssociation", "x-api-path-slug"=>"actiondescribeassociation-get", "parameters"=>[{"in"=>"query", "name"=>"AssociationId", "description"=>"The association ID for which you want information", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the SSM document", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Association"]}}, "/?Action=DescribeAutomationExecutions"=>{"get"=>{"summary"=>"Describe Automation Executions", "description"=>"Provides details about all active and terminated Automation executions.", "operationId"=>"describeAutomationExecutions", "x-api-path-slug"=>"actiondescribeautomationexecutions-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Filters used to limit the scope of executions that are requested", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Automation", "Executions"]}}, "/?Action=DescribeAvailablePatches"=>{"get"=>{"summary"=>"Describe Available Patches", "description"=>"Lists all patches that could possibly be included in a patch baseline.", "operationId"=>"describeAvailablePatches", "x-api-path-slug"=>"actiondescribeavailablepatches-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Filters used to scope down the returned patches", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of patches to return (per page)", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Available", "Patches"]}}, "/?Action=DescribeDocument"=>{"get"=>{"summary"=>"Describe Document", "description"=>"Describes the specified SSM document.", "operationId"=>"describeDocument", "x-api-path-slug"=>"actiondescribedocument-get", "parameters"=>[{"in"=>"query", "name"=>"DocumentVersion", "description"=>"The document version for which you want information", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the SSM document", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Document"]}}, "/?Action=DescribeDocumentPermission"=>{"get"=>{"summary"=>"Describe Document Permission", "description"=>"Describes the permissions for an SSM document.", "operationId"=>"describeDocumentPermission", "x-api-path-slug"=>"actiondescribedocumentpermission-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"The name of the document for which you are the owner", "type"=>"string"}, {"in"=>"query", "name"=>"PermissionType", "description"=>"The permission type for the document", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Document", "Permission"]}}, "/?Action=DescribeEffectiveInstanceAssociations"=>{"get"=>{"summary"=>"Describe Effective Instance Associations", "description"=>"All associations for the instance(s).", "operationId"=>"describeEffectiveInstanceAssociations", "x-api-path-slug"=>"actiondescribeeffectiveinstanceassociations-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID for which you want to view all associations", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Effective", "Instance", "Associations"]}}, "/?Action=DescribeEffectivePatchesForPatchBaseline"=>{"get"=>{"summary"=>"Describe Effective Patches For Patch Baseline", "description"=>"Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.", "operationId"=>"describeEffectivePatchesForPatchBaseline", "x-api-path-slug"=>"actiondescribeeffectivepatchesforpatchbaseline-get", "parameters"=>[{"in"=>"query", "name"=>"BaselineId", "description"=>"The ID of the patch baseline to retrieve the effective patches for", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of patches to return (per page)", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Effective", "PatchesBaseline"]}}, "/?Action=DescribeInstanceAssociationsStatus"=>{"get"=>{"summary"=>"Describe Instance Associations Status", "description"=>"The status of the associations for the instance(s).", "operationId"=>"describeInstanceAssociationsStatus", "x-api-path-slug"=>"actiondescribeinstanceassociationsstatus-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The instance IDs for which you want association status information", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance", "Associations", "Status"]}}, "/?Action=DescribeInstanceInformation"=>{"get"=>{"summary"=>"Describe Instance Information", "description"=>"Describes one or more of your instances.", "operationId"=>"describeInstanceInformation", "x-api-path-slug"=>"actiondescribeinstanceinformation-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceInformationFilterList", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance", "Information"]}}, "/?Action=DescribeInstancePatches"=>{"get"=>{"summary"=>"Describe Instance Patches", "description"=>"Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.", "operationId"=>"describeInstancePatches", "x-api-path-slug"=>"actiondescribeinstancepatches-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Each entry in the array is a structure containing:", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance whose patch state information should be retrieved", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of patches to return (per page)", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance", "Patches"]}}, "/?Action=DescribeInstancePatchStates"=>{"get"=>{"summary"=>"Describe Instance Patch States", "description"=>"Retrieves the high-level patch state of one or more instances.", "operationId"=>"describeInstancePatchStates", "x-api-path-slug"=>"actiondescribeinstancepatchstates-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceIds", "description"=>"The ID of the instance whose patch state information should be retrieved", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of instances to return (per page)", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance", "States"]}}, "/?Action=DescribeInstancePatchStatesForPatchGroup"=>{"get"=>{"summary"=>"Describe Instance Patch States For Patch Group", "description"=>"Retrieves the high-level patch state for the instances in the specified patch group.", "operationId"=>"describeInstancePatchStatesForPatchGroup", "x-api-path-slug"=>"actiondescribeinstancepatchstatesforpatchgroup-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Each entry in the array is a structure containing:", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of patches to return (per page)", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"PatchGroup", "description"=>"The name of the patch group for which the patch state information should be retrieved", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance", "StatesGroup"]}}, "/?Action=DescribeMaintenanceWindowExecutions"=>{"get"=>{"summary"=>"Describe Maintenance Window Executions", "description"=>"Lists the executions of a Maintenance Window (meaning, information about when the\n Maintenance Window was scheduled to be active and information about tasks registered and run with\n the Maintenance Window).", "operationId"=>"describeMaintenanceWindowExecutions", "x-api-path-slug"=>"actiondescribemaintenancewindowexecutions-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Each entry in the array is a structure containing:", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"WindowId", "description"=>"The ID of the Maintenance Window whose executions should be retrieved", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance", "Window", "Executions"]}}, "/?Action=DescribeMaintenanceWindowExecutionTaskInvocations"=>{"get"=>{"summary"=>"Describe Maintenance Window Execution Task Invocations", "description"=>"Retrieves the individual task executions (one per target) for a particular task executed\n as part of a Maintenance Window execution.", "operationId"=>"describeMaintenanceWindowExecutionTaskInvocations", "x-api-path-slug"=>"actiondescribemaintenancewindowexecutiontaskinvocations-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Optional filters used to scope down the returned task invocations", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"TaskId", "description"=>"The ID of the specific task in the Maintenance Window task that should be retrieved", "type"=>"string"}, {"in"=>"query", "name"=>"WindowExecutionId", "description"=>"The ID of the Maintenance Window execution the task is part of", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance", "Window", "Execution", "Task", "Invocations"]}}, "/?Action=DescribeMaintenanceWindowExecutionTasks"=>{"get"=>{"summary"=>"Describe Maintenance Window Execution Tasks", "description"=>"For a given Maintenance Window execution, lists the tasks that were executed.", "operationId"=>"describeMaintenanceWindowExecutionTasks", "x-api-path-slug"=>"actiondescribemaintenancewindowexecutiontasks-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Optional filters used to scope down the returned tasks", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"WindowExecutionId", "description"=>"The ID of the Maintenance Window execution whose task executions should be retrieved", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance", "Window", "Execution", "Tasks"]}}, "/?Action=DescribeMaintenanceWindows"=>{"get"=>{"summary"=>"Describe Maintenance Windows", "description"=>"Retrieves the Maintenance Windows in an AWS account.", "operationId"=>"describeMaintenanceWindows", "x-api-path-slug"=>"actiondescribemaintenancewindows-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Optional filters used to narrow down the scope of the returned Maintenance Windows", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance", "Windows"]}}, "/?Action=DescribeMaintenanceWindowTargets"=>{"get"=>{"summary"=>"Describe Maintenance Window Targets", "description"=>"Lists the targets registered with the Maintenance Window.", "operationId"=>"describeMaintenanceWindowTargets", "x-api-path-slug"=>"actiondescribemaintenancewindowtargets-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Optional filters that can be used to narrow down the scope of the returned window targets", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"WindowId", "description"=>"The ID of the Maintenance Window whose targets should be retrieved", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance", "Window", "Targets"]}}, "/?Action=DescribeMaintenanceWindowTasks"=>{"get"=>{"summary"=>"Describe Maintenance Window Tasks", "description"=>"Lists the tasks in a Maintenance Window.", "operationId"=>"describeMaintenanceWindowTasks", "x-api-path-slug"=>"actiondescribemaintenancewindowtasks-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Optional filters used to narrow down the scope of the returned tasks", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"WindowId", "description"=>"The ID of the Maintenance Window whose tasks should be retrieved", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance", "Window", "Tasks"]}}, "/?Action=DescribeParameters"=>{"get"=>{"summary"=>"Describe Parameters", "description"=>"Get information about a parameter.", "operationId"=>"describeParameters", "x-api-path-slug"=>"actiondescribeparameters-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters"]}}, "/?Action=DescribePatchBaselines"=>{"get"=>{"summary"=>"Describe Patch Baselines", "description"=>"Lists the patch baselines in your AWS account.", "operationId"=>"describePatchBaselines", "x-api-path-slug"=>"actiondescribepatchbaselines-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"Each element in the array is a structure containing:", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of patch baselines to return (per page)", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Baselines"]}}, "/?Action=DescribePatchGroups"=>{"get"=>{"summary"=>"Describe Patch Groups", "description"=>"Lists all patch groups that have been registered with patch baselines.", "operationId"=>"describePatchGroups", "x-api-path-slug"=>"actiondescribepatchgroups-get", "parameters"=>[{"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of patch groups to return (per page)", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/?Action=DescribePatchGroupState"=>{"get"=>{"summary"=>"Describe Patch Group State", "description"=>"Returns high-level aggregated patch compliance state for a patch group.", "operationId"=>"describePatchGroupState", "x-api-path-slug"=>"actiondescribepatchgroupstate-get", "parameters"=>[{"in"=>"query", "name"=>"PatchGroup", "description"=>"The name of the patch group whose patch snapshot should be retrieved", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "State"]}}, "/?Action=GetAutomationExecution"=>{"get"=>{"summary"=>"Get Automation Execution", "description"=>"Get detailed information about a particular Automation execution.", "operationId"=>"getAutomationExecution", "x-api-path-slug"=>"actiongetautomationexecution-get", "parameters"=>[{"in"=>"query", "name"=>"AutomationExecutionId", "description"=>"The unique identifier for an existing automation execution to examine", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Automation", "Execution"]}}, "/?Action=GetCommandInvocation"=>{"get"=>{"summary"=>"Get Command Invocation", "description"=>"Returns detailed information about command execution for an invocation or plugin.", "operationId"=>"getCommandInvocation", "x-api-path-slug"=>"actiongetcommandinvocation-get", "parameters"=>[{"in"=>"query", "name"=>"CommandId", "description"=>"(Required) The parent command ID of the invocation plugin", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"(Required) The ID of the managed instance targeted by the command", "type"=>"string"}, {"in"=>"query", "name"=>"PluginName", "description"=>"(Optional) The name of the plugin for which you want detailed results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Command", "Invocation"]}}, "/?Action=GetDefaultPatchBaseline"=>{"get"=>{"summary"=>"Get Default Patch Baseline", "description"=>"Retrieves the default patch baseline.", "operationId"=>"getDefaultPatchBaseline", "x-api-path-slug"=>"actiongetdefaultpatchbaseline-get", "parameters"=>[{"in"=>"query", "name"=>"BaselineId", "description"=>"The ID of the default patch baseline", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Default", "Baseline"]}}, "/?Action=GetDeployablePatchSnapshotForInstance"=>{"get"=>{"summary"=>"Get Deployable Patch Snapshot For Instance", "description"=>"Retrieves the current snapshot for the patch baseline the instance uses.", "operationId"=>"getDeployablePatchSnapshotForInstance", "x-api-path-slug"=>"actiongetdeployablepatchsnapshotforinstance-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance for which the appropriate patch snapshot should be retrieved", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotId", "description"=>"The user-defined snapshot ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployable", "SnapshotInstance"]}}, "/?Action=GetDocument"=>{"get"=>{"summary"=>"Get Document", "description"=>"Gets the contents of the specified SSM document.", "operationId"=>"getDocument", "x-api-path-slug"=>"actiongetdocument-get", "parameters"=>[{"in"=>"query", "name"=>"DocumentVersion", "description"=>"The document version for which you want information", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the SSM document", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Document"]}}, "/?Action=GetInventory"=>{"get"=>{"summary"=>"Get Inventory", "description"=>"Query inventory information.", "operationId"=>"getInventory", "x-api-path-slug"=>"actiongetinventory-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"ResultAttributes", "description"=>"The list of inventory item types to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Inventory"]}}, "/?Action=GetInventorySchema"=>{"get"=>{"summary"=>"Get Inventory Schema", "description"=>"Return a list of inventory type names for the account, or return a list of attribute\n names for a specific Inventory item type.", "operationId"=>"getInventorySchema", "x-api-path-slug"=>"actiongetinventoryschema-get", "parameters"=>[{"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"TypeName", "description"=>"The type of inventory item to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Inventory", "Schema"]}}, "/?Action=GetMaintenanceWindow"=>{"get"=>{"summary"=>"Get Maintenance Window", "description"=>"Retrieves a Maintenance Window.", "operationId"=>"getMaintenanceWindow", "x-api-path-slug"=>"actiongetmaintenancewindow-get", "parameters"=>[{"in"=>"query", "name"=>"WindowId", "description"=>"The ID of the desired Maintenance Window", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance", "Window"]}}, "/?Action=GetMaintenanceWindowExecution"=>{"get"=>{"summary"=>"Get Maintenance Window Execution", "description"=>"Retrieves details about a specific task executed as part of a Maintenance Window\n execution.", "operationId"=>"getMaintenanceWindowExecution", "x-api-path-slug"=>"actiongetmaintenancewindowexecution-get", "parameters"=>[{"in"=>"query", "name"=>"WindowExecutionId", "description"=>"The ID of the Maintenance Window execution that includes the task", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance", "Window", "Execution"]}}, "/?Action=GetMaintenanceWindowExecutionTask"=>{"get"=>{"summary"=>"Get Maintenance Window Execution Task", "description"=>"Retrieves the details about a specific task executed as part of a Maintenance Window\n execution.", "operationId"=>"getMaintenanceWindowExecutionTask", "x-api-path-slug"=>"actiongetmaintenancewindowexecutiontask-get", "parameters"=>[{"in"=>"query", "name"=>"TaskId", "description"=>"The ID of the specific task execution in the Maintenance Window task that should be retrieved", "type"=>"string"}, {"in"=>"query", "name"=>"WindowExecutionId", "description"=>"The ID of the Maintenance Window execution that includes the task", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance", "Window", "Execution", "Task"]}}, "/?Action=GetParameterHistory"=>{"get"=>{"summary"=>"Get Parameter History", "description"=>"Query a list of all parameters used by the AWS account.", "operationId"=>"getParameterHistory", "x-api-path-slug"=>"actiongetparameterhistory-get", "parameters"=>[{"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of a parameter you want to query", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"WithDecryption", "description"=>"Return decrypted values for secure string parameters", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameter", "History"]}}, "/?Action=GetParameters"=>{"get"=>{"summary"=>"Get Parameters", "description"=>"Get a list of parameters used by the AWS account.", "operationId"=>"getParameters", "x-api-path-slug"=>"actiongetparameters-get", "parameters"=>[{"in"=>"query", "name"=>"Names", "description"=>"Names of the parameters for which you want to query information", "type"=>"string"}, {"in"=>"query", "name"=>"WithDecryption", "description"=>"Return decrypted secure string value", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters"]}}, "/?Action=GetPatchBaseline"=>{"get"=>{"summary"=>"Get Patch Baseline", "description"=>"Retrieves information about a patch baseline.", "operationId"=>"getPatchBaseline", "x-api-path-slug"=>"actiongetpatchbaseline-get", "parameters"=>[{"in"=>"query", "name"=>"BaselineId", "description"=>"The ID of the patch baseline to retrieve", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Baseline"]}}, "/?Action=GetPatchBaselineForPatchGroup"=>{"get"=>{"summary"=>"Get Patch Baseline For Patch Group", "description"=>"Retrieves the patch baseline that should be used for the specified patch group.", "operationId"=>"getPatchBaselineForPatchGroup", "x-api-path-slug"=>"actiongetpatchbaselineforpatchgroup-get", "parameters"=>[{"in"=>"query", "name"=>"PatchGroup", "description"=>"The name of the patch group whose patch baseline should be retrieved", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["BaselineGroup"]}}, "/?Action=ListAssociations"=>{"get"=>{"summary"=>"List Associations", "description"=>"Lists the associations for the specified SSM document or instance.", "operationId"=>"listAssociations", "x-api-path-slug"=>"actionlistassociations-get", "parameters"=>[{"in"=>"query", "name"=>"AssociationFilterList", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Associations"]}}, "/?Action=ListCommandInvocations"=>{"get"=>{"summary"=>"List Command Invocations", "description"=>"An invocation is copy of a command sent to a specific instance.", "operationId"=>"listCommandInvocations", "x-api-path-slug"=>"actionlistcommandinvocations-get", "parameters"=>[{"in"=>"query", "name"=>"CommandId", "description"=>"(Optional) The invocations for a specific command ID", "type"=>"string"}, {"in"=>"query", "name"=>"Details", "description"=>"(Optional) If set this returns the response of the command executions and any command output", "type"=>"string"}, {"in"=>"query", "name"=>"Filters", "description"=>"(Optional) One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"(Optional) The command execution details for a specific instance ID", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"(Optional) The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"(Optional) The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Command", "Invocations"]}}, "/?Action=ListCommands"=>{"get"=>{"summary"=>"List Commands", "description"=>"Lists the commands requested by users of the AWS account.", "operationId"=>"listCommands", "x-api-path-slug"=>"actionlistcommands-get", "parameters"=>[{"in"=>"query", "name"=>"CommandId", "description"=>"(Optional) If provided, lists only the specified command", "type"=>"string"}, {"in"=>"query", "name"=>"Filters", "description"=>"(Optional) One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"(Optional) Lists commands issued against this instance ID", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"(Optional) The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"(Optional) The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Commands"]}}, "/?Action=ListDocuments"=>{"get"=>{"summary"=>"List Documents", "description"=>"Describes one or more of your SSM documents.", "operationId"=>"listDocuments", "x-api-path-slug"=>"actionlistdocuments-get", "parameters"=>[{"in"=>"query", "name"=>"DocumentFilterList", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Documents"]}}, "/?Action=ListDocumentVersions"=>{"get"=>{"summary"=>"List Document Versions", "description"=>"List all versions for a document.", "operationId"=>"listDocumentVersions", "x-api-path-slug"=>"actionlistdocumentversions-get", "parameters"=>[{"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the document about which you want version information", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Document", "Versions"]}}, "/?Action=ListInventoryEntries"=>{"get"=>{"summary"=>"List Inventory Entries", "description"=>"A list of inventory items returned by the request.", "operationId"=>"listInventoryEntries", "x-api-path-slug"=>"actionlistinventoryentries-get", "parameters"=>[{"in"=>"query", "name"=>"Filters", "description"=>"One or more filters", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID for which you want inventory information", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of items to return for this call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The token for the next set of items to return", "type"=>"string"}, {"in"=>"query", "name"=>"TypeName", "description"=>"The type of inventory item for which you want information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Inventory", "Entries"]}}, "/?Action=ListTagsForResource"=>{"get"=>{"summary"=>"List Tags For Resource", "description"=>"Returns a list of the tags assigned to the specified resource.", "operationId"=>"listTagsForResource", "x-api-path-slug"=>"actionlisttagsforresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceId", "description"=>"The resource ID for which you want to see a list of tags", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceType", "description"=>"Returns a list of tags for a specific resource type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "TagsResource"]}}, "/?Action=ModifyDocumentPermission"=>{"get"=>{"summary"=>"Modify Document Permission", "description"=>"Share a document publicly or privately.", "operationId"=>"modifyDocumentPermission", "x-api-path-slug"=>"actionmodifydocumentpermission-get", "parameters"=>[{"in"=>"query", "name"=>"AccountIdsToAdd", "description"=>"The AWS user accounts that should have access to the document", "type"=>"string"}, {"in"=>"query", "name"=>"AccountIdsToRemove", "description"=>"The AWS user accounts that should no longer have access to the document", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the document that you want to share", "type"=>"string"}, {"in"=>"query", "name"=>"PermissionType", "description"=>"The permission type for the document", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Modify", "Document", "Permission"]}}, "/?Action=PutInventory"=>{"get"=>{"summary"=>"Put Inventory", "description"=>"Bulk update custom inventory items on one more instance.", "operationId"=>"putInventory", "x-api-path-slug"=>"actionputinventory-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"One or more instance IDs where you want to add or update inventory items", "type"=>"string"}, {"in"=>"query", "name"=>"Items", "description"=>"The inventory items that you want to add or update on instances", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Inventory"]}}, "/?Action=PutParameter"=>{"get"=>{"summary"=>"Put Parameter", "description"=>"Add one or more paramaters to the system.", "operationId"=>"putParameter", "x-api-path-slug"=>"actionputparameter-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"Information about the parameter that you want to add to the system", "type"=>"string"}, {"in"=>"query", "name"=>"KeyId", "description"=>"The parameter key ID that you want to add to the system", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the parameter that you want to add to the system", "type"=>"string"}, {"in"=>"query", "name"=>"Overwrite", "description"=>"Overwrite an existing parameter", "type"=>"string"}, {"in"=>"query", "name"=>"Type", "description"=>"The type of parameter that you want to add to the system", "type"=>"string"}, {"in"=>"query", "name"=>"Value", "description"=>"The parameter value that you want to add to the system", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameter"]}}, "/?Action=RegisterDefaultPatchBaseline"=>{"get"=>{"summary"=>"Register Default Patch Baseline", "description"=>"Defines the default patch baseline.", "operationId"=>"registerDefaultPatchBaseline", "x-api-path-slug"=>"actionregisterdefaultpatchbaseline-get", "parameters"=>[{"in"=>"query", "name"=>"BaselineId", "description"=>"The ID of the patch baseline that should be the default patch baseline", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "Default", "Baseline"]}}, "/?Action=RegisterPatchBaselineForPatchGroup"=>{"get"=>{"summary"=>"Register Patch Baseline For Patch Group", "description"=>"Registers a patch baseline for a patch group.", "operationId"=>"registerPatchBaselineForPatchGroup", "x-api-path-slug"=>"actionregisterpatchbaselineforpatchgroup-get", "parameters"=>[{"in"=>"query", "name"=>"BaselineId", "description"=>"The ID of the patch baseline to register the patch group with", "type"=>"string"}, {"in"=>"query", "name"=>"PatchGroup", "description"=>"The name of the patch group that should be registered with the patch baseline", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "BaselineGroup"]}}, "/?Action=RegisterTargetWithMaintenanceWindow"=>{"get"=>{"summary"=>"Register Target With Maintenance Window", "description"=>"Registers a target with a Maintenance Window.", "operationId"=>"registerTargetWithMaintenanceWindow", "x-api-path-slug"=>"actionregistertargetwithmaintenancewindow-get", "parameters"=>[{"in"=>"query", "name"=>"ClientToken", "description"=>"User-provided idempotency token", "type"=>"string"}, {"in"=>"query", "name"=>"OwnerInformation", "description"=>"User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceType", "description"=>"The type of target being registered with the Maintenance Window", "type"=>"string"}, {"in"=>"query", "name"=>"Targets", "description"=>"The targets (either instances or tags)", "type"=>"string"}, {"in"=>"query", "name"=>"WindowId", "description"=>"The ID of the Maintenance Window the target should be registered with", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "TargetMaintenance", "Window"]}}, "/?Action=RegisterTaskWithMaintenanceWindow"=>{"get"=>{"summary"=>"Register Task With Maintenance Window", "description"=>"Adds a new task to a Maintenance Window.", "operationId"=>"registerTaskWithMaintenanceWindow", "x-api-path-slug"=>"actionregistertaskwithmaintenancewindow-get", "parameters"=>[{"in"=>"query", "name"=>"ClientToken", "description"=>"User-provided idempotency token", "type"=>"string"}, {"in"=>"query", "name"=>"LoggingInfo", "description"=>"A structure containing information about an Amazon S3 bucket to write instance-level logs to", "type"=>"string"}, {"in"=>"query", "name"=>"MaxConcurrency", "description"=>"The maximum number of targets this task can be run for in parallel", "type"=>"string"}, {"in"=>"query", "name"=>"MaxErrors", "description"=>"The maximum number of errors allowed before this task stops being scheduled", "type"=>"string"}, {"in"=>"query", "name"=>"Priority", "description"=>"The priority of the task in the Maintenance Window, the lower the number the higher the priority", "type"=>"string"}, {"in"=>"query", "name"=>"ServiceRoleArn", "description"=>"The role that should be assumed when executing the task", "type"=>"string"}, {"in"=>"query", "name"=>"Targets", "description"=>"The targets (either instances or tags)", "type"=>"string"}, {"in"=>"query", "name"=>"TaskArn", "description"=>"The ARN of the task to execute", "type"=>"string"}, {"in"=>"query", "name"=>"TaskParameters", "description"=>"The parameters that should be passed to the task when it is executed", "type"=>"string"}, {"in"=>"query", "name"=>"TaskType", "description"=>"The type of task being registered", "type"=>"string"}, {"in"=>"query", "name"=>"WindowId", "description"=>"The id of the Maintenance Window the task should be added to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "TaskMaintenance", "Window"]}}, "/?Action=RemoveTagsFromResource"=>{"get"=>{"summary"=>"Remove Tags From Resource", "description"=>"Removes all tags from the specified resource.", "operationId"=>"removeTagsFromResource", "x-api-path-slug"=>"actionremovetagsfromresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceId", "description"=>"The resource ID for which you want to remove tags", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceType", "description"=>"The type of resource of which you want to remove a tag", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys", "description"=>"Tag keys that you want to remove from the specified resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Tags", "From", "Resource"]}}, "/?Action=SendCommand"=>{"get"=>{"summary"=>"Send Command", "description"=>"Executes commands on one or more remote instances.", "operationId"=>"sendCommand", "x-api-path-slug"=>"actionsendcommand-get", "parameters"=>[{"in"=>"query", "name"=>"Comment", "description"=>"User-specified information about the command, such as a brief description of what the command should do", "type"=>"string"}, {"in"=>"query", "name"=>"DocumentHash", "description"=>"The Sha256 or Sha1 hash created by the system when the document was created", "type"=>"string"}, {"in"=>"query", "name"=>"DocumentHashType", "description"=>"Sha256 or Sha1", "type"=>"string"}, {"in"=>"query", "name"=>"DocumentName", "description"=>"Required", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceIds", "description"=>"Required", "type"=>"string"}, {"in"=>"query", "name"=>"MaxConcurrency", "description"=>"(Optional) The maximum number of instances that are allowed to execute the command at the same time", "type"=>"string"}, {"in"=>"query", "name"=>"MaxErrors", "description"=>"The maximum number of errors allowed without the command failing", "type"=>"string"}, {"in"=>"query", "name"=>"NotificationConfig", "description"=>"Configurations for sending notifications", "type"=>"string"}, {"in"=>"query", "name"=>"OutputS3BucketName", "description"=>"The name of the S3 bucket where command execution responses should be stored", "type"=>"string"}, {"in"=>"query", "name"=>"OutputS3KeyPrefix", "description"=>"The directory structure within the S3 bucket where the responses should be stored", "type"=>"string"}, {"in"=>"query", "name"=>"OutputS3Region", "description"=>"(Optional) The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located", "type"=>"string"}, {"in"=>"query", "name"=>"Parameters", "description"=>"The required and optional parameters specified in the SSM document being executed", "type"=>"string"}, {"in"=>"query", "name"=>"ServiceRoleArn", "description"=>"The IAM role that Systems Manager uses to send notifications", "type"=>"string"}, {"in"=>"query", "name"=>"Targets", "description"=>"(Optional) An array of search criteria that targets instances using a Key;Value combination that you specify", "type"=>"string"}, {"in"=>"query", "name"=>"TimeoutSeconds", "description"=>"If this time is reached and the command has not already started executing, it will not execute", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Command"]}}, "/?Action=StartAutomationExecution"=>{"get"=>{"summary"=>"Start Automation Execution", "description"=>"Initiates execution of an Automation document.", "operationId"=>"startAutomationExecution", "x-api-path-slug"=>"actionstartautomationexecution-get", "parameters"=>[{"in"=>"query", "name"=>"DocumentName", "description"=>"The name of the Automation document to use for this execution", "type"=>"string"}, {"in"=>"query", "name"=>"DocumentVersion", "description"=>"The version of the Automation document to use for this execution", "type"=>"string"}, {"in"=>"query", "name"=>"Parameters", "description"=>"A key-value map of execution parameters, which match the declared parameters in the Automation document", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Start", "Automation", "Execution"]}}, "/?Action=StopAutomationExecution"=>{"get"=>{"summary"=>"Stop Automation Execution", "description"=>"Stop an Automation that is currently executing.", "operationId"=>"stopAutomationExecution", "x-api-path-slug"=>"actionstopautomationexecution-get", "parameters"=>[{"in"=>"query", "name"=>"AutomationExecutionId", "description"=>"The execution ID of the Automation to stop", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Automation", "Execution"]}}, "/?Action=UpdateAssociation"=>{"get"=>{"summary"=>"Update Association", "description"=>"Updates an association.", "operationId"=>"updateAssociation", "x-api-path-slug"=>"actionupdateassociation-get", "parameters"=>[{"in"=>"query", "name"=>"AssociationId", "description"=>"The ID of the association you want to update", "type"=>"string"}, {"in"=>"query", "name"=>"DocumentVersion", "description"=>"The document version you want update for the association", "type"=>"string"}, {"in"=>"query", "name"=>"OutputLocation", "description"=>"An Amazon S3 bucket where you want to store the results of this request", "type"=>"string"}, {"in"=>"query", "name"=>"Parameters", "description"=>"The parameters you want to update for the association", "type"=>"string"}, {"in"=>"query", "name"=>"ScheduleExpression", "description"=>"The cron expression used to schedule the association that you want to update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Association"]}}, "/?Action=UpdateAssociationStatus"=>{"get"=>{"summary"=>"Update Association Status", "description"=>"Updates the status of the SSM document associated with the specified\n instance.", "operationId"=>"updateAssociationStatus", "x-api-path-slug"=>"actionupdateassociationstatus-get", "parameters"=>[{"in"=>"query", "name"=>"AssociationStatus", "description"=>"The association status", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the instance", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the SSM document", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Association", "Status"]}}, "/?Action=UpdateDocument"=>{"get"=>{"summary"=>"Update Document", "description"=>"The document you want to update.", "operationId"=>"updateDocument", "x-api-path-slug"=>"actionupdatedocument-get", "parameters"=>[{"in"=>"query", "name"=>"Content", "description"=>"The content in a document that you want to update", "type"=>"string"}, {"in"=>"query", "name"=>"DocumentVersion", "description"=>"The version of the document that you want to update", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the document that you want to update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Document"]}}, "/?Action=UpdateDocumentDefaultVersion"=>{"get"=>{"summary"=>"Update Document Default Version", "description"=>"Set the default version of a document.", "operationId"=>"updateDocumentDefaultVersion", "x-api-path-slug"=>"actionupdatedocumentdefaultversion-get", "parameters"=>[{"in"=>"query", "name"=>"DocumentVersion", "description"=>"The version of a custom document that you want to set as the default version", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of a custom document that you want to set as the default version", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Document", "Default", "Version"]}}, "/?Action=UpdateMaintenanceWindow"=>{"get"=>{"summary"=>"Update Maintenance Window", "description"=>"Updates an existing Maintenance Window.", "operationId"=>"updateMaintenanceWindow", "x-api-path-slug"=>"actionupdatemaintenancewindow-get", "parameters"=>[{"in"=>"query", "name"=>"AllowUnassociatedTargets", "description"=>"Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets", "type"=>"string"}, {"in"=>"query", "name"=>"Cutoff", "description"=>"The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution", "type"=>"string"}, {"in"=>"query", "name"=>"Duration", "description"=>"The duration of the Maintenance Window in hours", "type"=>"string"}, {"in"=>"query", "name"=>"Enabled", "description"=>"Whether the Maintenance Window is enabled", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the Maintenance Window", "type"=>"string"}, {"in"=>"query", "name"=>"Schedule", "description"=>"The schedule of the Maintenance Window in the form of a cron or rate expression", "type"=>"string"}, {"in"=>"query", "name"=>"WindowId", "description"=>"The ID of the Maintenance Window to update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Maintenance", "Window"]}}, "/?Action=UpdateManagedInstanceRole"=>{"get"=>{"summary"=>"Update Managed Instance Role", "description"=>"Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed\n instance.", "operationId"=>"updateManagedInstanceRole", "x-api-path-slug"=>"actionupdatemanagedinstancerole-get", "parameters"=>[{"in"=>"query", "name"=>"IamRole", "description"=>"The IAM role you want to assign or change", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The ID of the managed instance where you want to update the role", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managed", "Instance", "Role"]}}, "/?Action=UpdatePatchBaseline"=>{"get"=>{"summary"=>"Update Patch Baseline", "description"=>"Modifies an existing patch baseline.", "operationId"=>"updatePatchBaseline", "x-api-path-slug"=>"actionupdatepatchbaseline-get", "parameters"=>[{"in"=>"query", "name"=>"ApprovalRules", "description"=>"A set of rules used to include patches in the baseline", "type"=>"string"}, {"in"=>"query", "name"=>"ApprovedPatches", "description"=>"A list of explicitly approved patches for the baseline", "type"=>"string"}, {"in"=>"query", "name"=>"BaselineId", "description"=>"The ID of the patch baseline to update", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A description of the patch baseline", "type"=>"string"}, {"in"=>"query", "name"=>"GlobalFilters", "description"=>"A set of global filters used to exclude patches from the baseline", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the patch baseline", "type"=>"string"}, {"in"=>"query", "name"=>"RejectedPatches", "description"=>"A list of explicitly rejected patches for the baseline", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Baseline"]}}}}, "apis"=>{"name"=>"AWS EC2 Systems Manager", "x-slug"=>"aws-ec2-systems-manager", "description"=>"Amazon EC2 Systems Manager is a management service that helps you automatically collect software inventory, apply OS patches, create system images, and configure Windows and Linux operating systems. These capabilities help you define and track system configurations, prevent drift, and maintain software compliance of your EC2 and on-premises configurations. By providing a management approach that is designed for the scale and agility of the cloud but extends into your on-premises data center, EC2 Systems Manager makes it easier for you to seamlessly bridge your existing infrastructure with AWS.EC2 Systems Manager is easy to use. Simply access EC2 Systems Manager from the EC2 Management Console, select the instances you want to manage, and define the management tasks you want to perform. EC2 Systems Manager is available now at no cost to manage both your EC2 and on-premises resources.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_AmazonEC2.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Cloud,Deployments,Management,Orchestration,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-ec2-systems-manager/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Amazon EC2 Systems Manager API", "x-api-slug"=>"amazon-ec2-systems-manager-api", "description"=>"Amazon EC2 Systems Manager is a management service that helps you automatically collect software inventory, apply OS patches, create system images, and configure Windows and Linux operating systems. These capabilities help you define and track system configurations, prevent drift, and maintain software compliance of your EC2 and on-premises configurations. By providing a management approach that is designed for the scale and agility of the cloud but extends into your on-premises data center, EC2 Systems Manager makes it easier for you to seamlessly bridge your existing infrastructure with AWS.EC2 Systems Manager is easy to use. Simply access EC2 Systems Manager from the EC2 Management Console, select the instances you want to manage, and define the management tasks you want to perform. EC2 Systems Manager is available now at no cost to manage both your EC2 and on-premises resources.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_AmazonEC2.png", "humanURL"=>"https://aws.amazon.com/ec2/systems-manager/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Cloud,Deployments,Management,Orchestration,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-ec2-systems-manager/actionupdatepatchbaseline-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-ec2-systems-manager/amazon-ec2-systems-manager-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/ssm/latest/APIReference/Welcome.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/ec2/systems-manager/faqs/"}, {"type"=>"x-getting-started", "url"=>"http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/systems-manager.html"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/ec2/systems-manager/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-service-control{"google-service-control-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Service Control", "x-complete"=>1, "info"=>{"title"=>"Google Service Control", "description"=>"google-service-control-provides-control-plane-functionality-to-managed-services-such-as-logging-monitoring-and-status-checks-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"servicecontrol.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/services/{serviceName}:allocateQuota"=>{"post"=>{"summary"=>"Allocate Quota", "description"=>"Attempts to allocate quota for the specified consumer. It should be called\nbefore the operation is executed.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).", "operationId"=>"servicecontrol.services.allocateQuota", "x-api-path-slug"=>"v1servicesservicenameallocatequota-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"serviceName", "description"=>"Name of the service as specified in the service configuration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Quota"]}}, "/v1/services/{serviceName}:check"=>{"post"=>{"summary"=>"Check Operation", "description"=>"Checks an operation with Google Service Control to decide whether\nthe given operation should proceed. It should be called before the\noperation is executed.\n\nIf feasible, the client should cache the check results and reuse them for\n60 seconds. In case of server errors, the client can rely on the cached\nresults for longer time.\n\nNOTE: the `CheckRequest` has the size limit of 64KB.\n\nThis method requires the `servicemanagement.services.check` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).", "operationId"=>"servicecontrol.services.check", "x-api-path-slug"=>"v1servicesservicenamecheck-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"serviceName", "description"=>"The service name as specified in its service configuration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Operation"]}}, "/v1/services/{serviceName}:endReconciliation"=>{"post"=>{"summary"=>"End Reconciliation", "description"=>"Signals the quota controller that service ends the ongoing usage\nreconciliation.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).", "operationId"=>"servicecontrol.services.endReconciliation", "x-api-path-slug"=>"v1servicesservicenameendreconciliation-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"serviceName", "description"=>"Name of the service as specified in the service configuration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Reconcilliation"]}}, "/v1/services/{serviceName}:releaseQuota"=>{"post"=>{"summary"=>"Release Quota", "description"=>"Releases previously allocated quota done through AllocateQuota method.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).", "operationId"=>"servicecontrol.services.releaseQuota", "x-api-path-slug"=>"v1servicesservicenamereleasequota-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"serviceName", "description"=>"Name of the service as specified in the service configuration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Quota"]}}, "/v1/services/{serviceName}:report"=>{"post"=>{"summary"=>"Report", "description"=>"Reports operation results to Google Service Control, such as logs and\nmetrics. It should be called after an operation is completed.\n\nIf feasible, the client should aggregate reporting data for up to 5\nseconds to reduce API traffic. Limiting aggregation to 5 seconds is to\nreduce data loss during client crashes. Clients should carefully choose\nthe aggregation time window to avoid data loss risk more than 0.01%\nfor business and compliance reasons.\n\nNOTE: the `ReportRequest` has the size limit of 1MB.\n\nThis method requires the `servicemanagement.services.report` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).", "operationId"=>"servicecontrol.services.report", "x-api-path-slug"=>"v1servicesservicenamereport-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"serviceName", "description"=>"The service name as specified in its service configuration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report"]}}, "/v1/services/{serviceName}:startReconciliation"=>{"post"=>{"summary"=>"Start Reconciliation", "description"=>"Unlike rate quota, allocation quota does not get refilled periodically.\nSo, it is possible that the quota usage as seen by the service differs from\nwhat the One Platform considers the usage is. This is expected to happen\nonly rarely, but over time this can accumulate. Services can invoke\nStartReconciliation and EndReconciliation to correct this usage drift, as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in future for each\n metric that needs to be reconciled. The timestamp being in future allows\n to account for in-flight AllocateQuota and ReleaseQuota requests for the\n same metric.\n2. One Platform records this timestamp and starts tracking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconciliation is\n called.\n3. At or after the time specified in the StartReconciliation, service\n sends EndReconciliation with the usage that needs to be reconciled to.\n4. One Platform adjusts its own record of usage for that metric to the\n value specified in EndReconciliation by taking in to account any\n allocation or release between StartReconciliation and EndReconciliation.\n\nSignals the quota controller that the service wants to perform a usage\nreconciliation as specified in the request.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).", "operationId"=>"servicecontrol.services.startReconciliation", "x-api-path-slug"=>"v1servicesservicenamestartreconciliation-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"serviceName", "description"=>"Name of the service as specified in the service configuration"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Reconcilliation"]}}}}, "apis"=>{"name"=>"Google Service Control", "x-slug"=>"google-service-control", "description"=>"Google Service Control is a Google Cloud Platform infrastructure service. It provides control plane functionality to managed services, such as logging, monitoring, and status checks. It is widely used by Google APIs and Google Cloud Endpoints. This page provides an overview of what it does and how it works.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2017-03-17 at 3.49.30 PM.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Logging,Monitoring,Profiles,Relative Data,Service API,Stack Network,Statuses", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-service-control/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Service Control API", "x-api-slug"=>"google-service-control-api", "description"=>"Google Service Control is a Google Cloud Platform infrastructure service. It provides control plane functionality to managed services, such as logging, monitoring, and status checks. It is widely used by Google APIs and Google Cloud Endpoints. This page provides an overview of what it does and how it works.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2017-03-17 at 3.49.30 PM.png", "humanURL"=>"https://cloud.google.com/service-control/overview", "baseURL"=>"://servicecontrol.googleapis.com//", "tags"=>"API Provider,API Service Provider,Google APIs,Logging,Monitoring,Profiles,Relative Data,Service API,Stack Network,Statuses", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-service-control/google-service-control-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-log", "url"=>"https://cloud.google.com/service-control/release-notes"}, {"type"=>"x-code", "url"=>"https://cloud.google.com/service-control/libraries"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/service-control/docs/"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/service-control/how-to"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/service-control/pricing-and-quotas"}, {"type"=>"x-support", "url"=>"https://cloud.google.com/service-control/support"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/service-control/overview"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
first-trust-bank{"first-trust-bank-open-banking-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"First Trust Bank", "x-complete"=>1, "info"=>{"title"=>"First Trust Bank", "description"=>"this-is-the-open-banking-driven-set-of-apis-for-first-trust-bank--providing-a-machine-readable-definition-of-what-is-available-via-their-open-banking-set-of-apis-", "termsOfService"=>"https://www.openbanking.org.uk/open-licence/", "contact"=>{"name"=>"API Evangelist", "url"=>"https://apievangelist.com", "email"=>"info@apievangelist.com"}, "version"=>"1.0.0"}, "host"=>"openapi.firsttrustbank.co.uk", "basePath"=>"open-banking/v2.1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"atms/"=>{"get"=>{"summary"=>"Get ATMs", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can provide multiple ATMs.", "operationId"=>"getATMS", "x-api-path-slug"=>"atms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ATMs"]}}, "branches/"=>{"get"=>{"summary"=>"Get Branches", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple branches.", "operationId"=>"getBranches", "x-api-path-slug"=>"branches-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branches"]}}, "personal-current-accounts/"=>{"get"=>{"summary"=>"Get Current Personal Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple PCA products.", "operationId"=>"getCurrentPersonalAccounts", "x-api-path-slug"=>"personalcurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "Personal", "Accounts"]}}, "business-current-accounts/"=>{"get"=>{"summary"=>"Get Current Business Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple BCA products.", "operationId"=>"getCurentBusinessAccounts", "x-api-path-slug"=>"businesscurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "Business", "Accounts"]}}, "unsecured-sme-loans/"=>{"get"=>{"summary"=>"Get Unsecured SME Loans", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Unsecured Loan products.", "operationId"=>"pathOperation", "x-api-path-slug"=>"unsecuredsmeloans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsecured", "SME", "Loans"]}}}}, "apis"=>{"name"=>"First Trust Bank", "x-slug"=>"first-trust-bank", "description"=>"First Trust Bank is a trade mark of AIB Group (UK) p.l.c. (a wholly owned subsidiary of Allied Irish Banks, p.l.c.), incorporated in Northern Ireland. Registered Office 92 Ann Street, Belfast BT1 3HH. Registered Number NI018800. Authorised by the Prudential Regulation Authority and regulated by the Financial Conduct Authority and the Prudential Regulation Authority.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/mdy_8774354__firsttrustbank.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Provider,ATMs,Banking,General Data,Profiles,Relative Data,UK Banks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"first-trust-bank/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"First Trust Bank (Open Banking)", "x-api-slug"=>"first-trust-bank-open-banking", "description"=>"First Trust Bank is a trade mark of AIB Group (UK) p.l.c. (a wholly owned subsidiary of Allied Irish Banks, p.l.c.), incorporated in Northern Ireland. Registered Office 92 Ann Street, Belfast BT1 3HH. Registered Number NI018800. Authorised by the Prudential Regulation Authority and regulated by the Financial Conduct Authority and the Prudential Regulation Authority.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/mdy_8774354__firsttrustbank.jpg", "humanURL"=>"https://firsttrustbank.co.uk/", "baseURL"=>"https://openapi.firsttrustbank.co.uk/open-banking/v2.1/", "tags"=>"API Provider,ATMs,Banking,General Data,Profiles,Relative Data,UK Banks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/first-trust-bank/unsecuredsmeloans-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/first-trust-bank/first-trust-bank-open-banking-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"http://openbankingapis.io/united-kingdom/first-trust-bank"}, {"type"=>"x-documentation", "url"=>"https://openbanking.atlassian.net/wiki/spaces/DZ/pages/54919225/Open+Data+API+Dashboard#"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/firsttrustbank"}, {"type"=>"x-website", "url"=>"https://firsttrustbank.co.uk/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-container-engine{"google-container-engine-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Container Engine", "x-complete"=>1, "info"=>{"title"=>"Google Container Engine", "description"=>"builds-and-manages-clusters-that-run-containerbased-applications-powered-by-open-source-kubernetes-technology-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"container.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/projects/{projectId}/zones/{zone}/clusters"=>{"get"=>{"summary"=>"Get Clusters", "description"=>"Lists all clusters owned by a project in either the specified zone or all zones.", "operationId"=>"container.projects.zones.clusters.list", "x-api-path-slug"=>"v1projectsprojectidzoneszoneclusters-get", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"The Google Developers Console [project ID or project number](https://support"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or - for all zones"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster"]}, "post"=>{"summary"=>"Create Cluster", "description"=>"Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the cluster creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range is being used by the cluster.", "operationId"=>"container.projects.zones.clusters.create", "x-api-path-slug"=>"v1projectsprojectidzoneszoneclusters-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"The Google Developers Console [project ID or project number](https://support"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster"]}}, "/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}"=>{"delete"=>{"summary"=>"Delete Cluster", "description"=>"Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster (e.g. load balancer resources) will not be deleted if they weren't present at the initial create time.", "operationId"=>"container.projects.zones.clusters.delete", "x-api-path-slug"=>"v1projectsprojectidzoneszoneclustersclusterid-delete", "parameters"=>[{"in"=>"path", "name"=>"clusterId", "description"=>"The name of the cluster to delete"}, {"in"=>"path", "name"=>"projectId", "description"=>"The Google Developers Console [project ID or project number](https://support"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster"]}, "get"=>{"summary"=>"Get Cluster", "description"=>"Gets the details of a specific cluster.", "operationId"=>"container.projects.zones.clusters.get", "x-api-path-slug"=>"v1projectsprojectidzoneszoneclustersclusterid-get", "parameters"=>[{"in"=>"path", "name"=>"clusterId", "description"=>"The name of the cluster to retrieve"}, {"in"=>"path", "name"=>"projectId", "description"=>"The Google Developers Console [project ID or project number](https://support"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster"]}, "put"=>{"summary"=>"Update Cluster", "description"=>"Updates the settings of a specific cluster.", "operationId"=>"container.projects.zones.clusters.update", "x-api-path-slug"=>"v1projectsprojectidzoneszoneclustersclusterid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"clusterId", "description"=>"The name of the cluster to upgrade"}, {"in"=>"path", "name"=>"projectId", "description"=>"The Google Developers Console [project ID or project number](https://support"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster"]}}, "/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools"=>{"get"=>{"summary"=>"Get Cluster Node Pools", "description"=>"Lists the node pools for a cluster.", "operationId"=>"container.projects.zones.clusters.nodePools.list", "x-api-path-slug"=>"v1projectsprojectidzoneszoneclustersclusteridnodepools-get", "parameters"=>[{"in"=>"path", "name"=>"clusterId", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"projectId", "description"=>"The Google Developers Console [project ID or project number](https://developers"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Node Pool"]}, "post"=>{"summary"=>"Create Cluster Node Pool", "description"=>"Creates a node pool for a cluster.", "operationId"=>"container.projects.zones.clusters.nodePools.create", "x-api-path-slug"=>"v1projectsprojectidzoneszoneclustersclusteridnodepools-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"clusterId", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"projectId", "description"=>"The Google Developers Console [project ID or project number](https://developers"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Node Pool"]}}, "/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}"=>{"delete"=>{"summary"=>"Delete Cluster Node Pool", "description"=>"Deletes a node pool from a cluster.", "operationId"=>"container.projects.zones.clusters.nodePools.delete", "x-api-path-slug"=>"v1projectsprojectidzoneszoneclustersclusteridnodepoolsnodepoolid-delete", "parameters"=>[{"in"=>"path", "name"=>"clusterId", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"nodePoolId", "description"=>"The name of the node pool to delete"}, {"in"=>"path", "name"=>"projectId", "description"=>"The Google Developers Console [project ID or project number](https://developers"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Node Pool"]}, "get"=>{"summary"=>"Get Cluster Node Pool", "description"=>"Retrieves the node pool requested.", "operationId"=>"container.projects.zones.clusters.nodePools.get", "x-api-path-slug"=>"v1projectsprojectidzoneszoneclustersclusteridnodepoolsnodepoolid-get", "parameters"=>[{"in"=>"path", "name"=>"clusterId", "description"=>"The name of the cluster"}, {"in"=>"path", "name"=>"nodePoolId", "description"=>"The name of the node pool"}, {"in"=>"path", "name"=>"projectId", "description"=>"The Google Developers Console [project ID or project number](https://developers"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Node Pool"]}}, "/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement"=>{"post"=>{"summary"=>"Set Cluster Node Management", "description"=>"Sets the NodeManagement options for a node pool.", "operationId"=>"container.projects.zones.clusters.nodePools.setManagement", "x-api-path-slug"=>"v1projectsprojectidzoneszoneclustersclusteridnodepoolsnodepoolidsetmanagement-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"clusterId", "description"=>"The name of the cluster to update"}, {"in"=>"path", "name"=>"nodePoolId", "description"=>"The name of the node pool to update"}, {"in"=>"path", "name"=>"projectId", "description"=>"The Google Developers Console [project ID or project number](https://support"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Node Pool"]}}, "/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback"=>{"post"=>{"summary"=>"Rollback Node", "description"=>"Roll back the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.", "operationId"=>"container.projects.zones.clusters.nodePools.rollback", "x-api-path-slug"=>"v1projectsprojectidzoneszoneclustersclusteridnodepoolsnodepoolidrollback-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"clusterId", "description"=>"The name of the cluster to rollback"}, {"in"=>"path", "name"=>"nodePoolId", "description"=>"The name of the node pool to rollback"}, {"in"=>"path", "name"=>"projectId", "description"=>"The Google Developers Console [project ID or project number](https://support"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Node Pool"]}}, "/v1/projects/{projectId}/zones/{zone}/operations"=>{"get"=>{"summary"=>"Get Operations", "description"=>"Lists all operations in a project in a specific zone or all zones.", "operationId"=>"container.projects.zones.operations.list", "x-api-path-slug"=>"v1projectsprojectidzoneszoneoperations-get", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"The Google Developers Console [project ID or project number](https://support"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1/projects/{projectId}/zones/{zone}/operations/{operationId}"=>{"get"=>{"summary"=>"Get Operations", "description"=>"Gets the specified operation.", "operationId"=>"container.projects.zones.operations.get", "x-api-path-slug"=>"v1projectsprojectidzoneszoneoperationsoperationid-get", "parameters"=>[{"in"=>"path", "name"=>"operationId", "description"=>"The server-assigned `name` of the operation"}, {"in"=>"path", "name"=>"projectId", "description"=>"The Google Developers Console [project ID or project number](https://support"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel"=>{"post"=>{"summary"=>"Create Operation", "description"=>"Cancels the specified operation.", "operationId"=>"container.projects.zones.operations.cancel", "x-api-path-slug"=>"v1projectsprojectidzoneszoneoperationsoperationidcancel-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"operationId", "description"=>"The server-assigned `name` of the operation"}, {"in"=>"path", "name"=>"projectId", "description"=>"The Google Developers Console [project ID or project number](https://support"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1/projects/{projectId}/zones/{zone}/serverconfig"=>{"get"=>{"summary"=>"Get Server Configuration", "description"=>"Returns configuration info about the Container Engine service.", "operationId"=>"container.projects.zones.getServerconfig", "x-api-path-slug"=>"v1projectsprojectidzoneszoneserverconfig-get", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"The Google Developers Console [project ID or project number](https://support"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server"]}}}}, "apis"=>{"name"=>"Google Container Engine", "x-slug"=>"google-container-engine", "description"=>"Google Container Engine is a powerful cluster manager and orchestration system for running your Docker containers. Container Engine schedules your containers into the cluster and manages them automatically based on requirements you define (such as CPU and memory). Its built on the open source Kubernetes system, giving you the flexibility to take advantage of on-premises, hybrid, or public cloud infrastructure.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/docker-container.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Containers,Deployments,Google APIs,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-container-engine/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Container Engine API", "x-api-slug"=>"google-container-engine-api", "description"=>"Google Container Engine is a powerful cluster manager and orchestration system for running your Docker containers. Container Engine schedules your containers into the cluster and manages them automatically based on requirements you define (such as CPU and memory). Its built on the open source Kubernetes system, giving you the flexibility to take advantage of on-premises, hybrid, or public cloud infrastructure.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/docker-container.png", "humanURL"=>"https://cloud.google.com/container-engine/", "baseURL"=>"://container.googleapis.com//", "tags"=>"API Provider,API Service Provider,Containers,Deployments,Google APIs,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-container-engine/google-container-engine-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-log", "url"=>"https://cloud.google.com/container-engine/release-notes"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/container-engine/docs/"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/container-engine/docs/quickstart"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/container-engine/docs/how-to"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/container-engine/pricing"}, {"type"=>"x-schedule-maintenance", "url"=>"https://cloud.google.com/container-engine/docs/scheduled-maintenance"}, {"type"=>"x-service-level-agreements", "url"=>"https://cloud.google.com/container-engine/sla"}, {"type"=>"x-tutorials", "url"=>"https://cloud.google.com/container-engine/docs/tutorials"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/container-engine/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
nexmo{"nexmo-sms-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Nexmo", "x-complete"=>1, "info"=>{"title"=>"Nexmo SMS API", "description"=>"nexmo-makes-it-simple-to-send-and-receive-a-high-volume-of-sms-anywhere-in-the-world-within-minutes-", "termsOfService"=>"https://www.nexmo.com/terms", "version"=>"v1"}, "host"=>"rest.nexmo.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"sms/{format}"=>{"get"=>{"summary"=>"Send Message", "description"=>"Nexmo makes it simple to send and receive a high volume of SMS anywhere in the world within minutes.", "operationId"=>"sendMessage", "x-api-path-slug"=>"smsformat-get", "parameters"=>[{"in"=>"query", "name"=>"api_key", "description"=>"Your API Key"}, {"in"=>"query", "name"=>"api_secret", "description"=>"Your API Secret"}, {"in"=>"query", "name"=>"client-ref", "description"=>"Include any reference string for your reference"}, {"in"=>"path", "name"=>"format", "description"=>"XML or JSON"}, {"in"=>"query", "name"=>"from", "description"=>"Sender address may be alphanumeric (Ex: from=MyCompany20)"}, {"in"=>"query", "name"=>"message-class", "description"=>"Set to 0 for Flash SMS"}, {"in"=>"query", "name"=>"network-code", "description"=>"Force the recipient network operator MCCMNC, make sure to supply the correct information otherwise the message wont be delivered"}, {"in"=>"query", "name"=>"status-report-req", "description"=>"Set to 1 if you want to receive a delivery report (DLR) for this request"}, {"in"=>"query", "name"=>"text", "description"=>"Body of the text message (with a maximum length of 3200 characters), UTF-8 and URL encoded value"}, {"in"=>"query", "name"=>"to", "description"=>"Mobile number in international format, and one recipient per request"}, {"in"=>"query", "name"=>"ttl", "description"=>"Message life span in milliseconds"}, {"in"=>"query", "name"=>"type_of_media", "description"=>"This can be omitted for text (default), but is required when sending a Binary (binary), WAP Push (wappush), Unicode message (unicode), vcal (vcal) or vcard (vcard)"}, {"in"=>"query", "name"=>"vcard", "description"=>"vcard text body correctly formatted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "SMS"]}}}}, "apis"=>{"name"=>"Nexmo", "x-slug"=>"nexmo", "description"=>"Nexmo, a Vonage Company, is a global cloud communications platform leader providing innovative APIs & SDKs for voice, text, messaging & phone verification.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/626-nexmo.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"33205", "tags"=>"API Provider,API United Kingdom,Bulk,Enterprise,Global,Messages,Profiles,Relative Data,SaaS,Service API,SMPP,SMS,SMS,Technology,Telecommunications,Telecommunications,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"nexmo/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Nexmo SMS API", "x-api-slug"=>"nexmo-sms-api", "description"=>"Nexmo lets you send and receive high volume of SMS at wholesale rates using web technologies that you already know.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/626-nexmo.jpg", "humanURL"=>"http://nexmo.com/", "baseURL"=>"http://rest.nexmo.com//", "tags"=>"API Provider,API United Kingdom,Bulk,Enterprise,Global,Messages,Profiles,Relative Data,SaaS,Service API,SMPP,SMS,SMS,Technology,Telecommunications,Telecommunications,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/nexmo/smsformat-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/nexmo/nexmo-sms-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x--net-sdk", "url"=>"http://dotnet-snippets.com/dns/send-sms-SID658.aspx"}, {"type"=>"x-base", "url"=>"https://rest.nexmo.com/"}, {"type"=>"x-blog", "url"=>"http://blog.nexmo.com"}, {"type"=>"x-case-studies", "url"=>"http://www.nexmo.com/customers/#case"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/nexmo"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/nexmo"}, {"type"=>"x-developer", "url"=>"https://docs.nexmo.com/"}, {"type"=>"x-email", "url"=>"sales@nexmo.com"}, {"type"=>"x-email", "url"=>"press@nexmo.com"}, {"type"=>"x-email", "url"=>"privacy@nexmo.com"}, {"type"=>"x-email", "url"=>"support@nexmo.com"}, {"type"=>"x-email", "url"=>"billing@nexmo.com"}, {"type"=>"x-email", "url"=>"legal@nexmo.com"}, {"type"=>"x-email", "url"=>"info@nexmo.com"}, {"type"=>"x-github", "url"=>"https://github.com/Nexmo"}, {"type"=>"x-java-sdk", "url"=>"https://labs.nexmo.com/download/nexmo-java-sdk-v1.5.zip"}, {"type"=>"x-node-js-sdk", "url"=>"https://github.com/pvela/nexmo"}, {"type"=>"x-perl-sdk", "url"=>"https://github.com/reneeb/perl-Nexmo-SMS"}, {"type"=>"x-php-sdk", "url"=>"https://github.com/prawnsalad/Nexmo-PHP-lib"}, {"type"=>"x-pricing", "url"=>"http://www.nexmo.com/pricing/"}, {"type"=>"x-privacy", "url"=>"http://www.nexmo.com/privacy-policy-2/"}, {"type"=>"x-python-sdk", "url"=>"https://github.com/marcuz/libpynexmo"}, {"type"=>"x-ruby-sdk", "url"=>"https://github.com/timcraft/nexmo"}, {"type"=>"x-selfservice-registration", "url"=>"https://dashboard.nexmo.com/register"}, {"type"=>"x-terms-of-service", "url"=>"http://www.nexmo.com/terms-use/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/nexmo"}, {"type"=>"x-webhook", "url"=>"https://developer.nexmo.com/concepts/guides/webhooks"}, {"type"=>"x-webinar", "url"=>"http://www.nexmo.com/resources/webinars/"}, {"type"=>"x-website", "url"=>"http://nexmo.com/"}, {"type"=>"x-website", "url"=>"http://nexmo.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
the-open-movie-database{"omdb-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"The Open Movie Database", "x-complete"=>1, "info"=>{"title"=>"OMDb", "description"=>"the-open-movie-database--the-omdb-api-is-a-free-web-service-to-obtain-movie-information-all-content-and-images-on-the-site-are-contributed-and-maintained-by-our-users-", "termsOfService"=>"http://www.omdbapi.com/legal.htm", "contact"=>{"name"=>"Open Movie Database", "url"=>"http://omdbapi.com", "email"=>"bfritz@fadingsignal.com"}, "version"=>"1"}, "host"=>"www.omdbapi.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/"=>{"get"=>{"summary"=>"OMDb Search", "description"=>"Find a movie, series or episode from the OMDb by title, IMDb-id or by free-text search", "operationId"=>"getMovies", "x-api-path-slug"=>"get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"JSONP callback name"}, {"in"=>"query", "name"=>"i", "description"=>"A valid IMDb ID (e"}, {"in"=>"query", "name"=>"page", "description"=>"Page number to return"}, {"in"=>"query", "name"=>"plot", "description"=>"Return short or full plot"}, {"in"=>"query", "name"=>"r", "description"=>"The data type to return"}, {"in"=>"query", "name"=>"s", "description"=>"Movie title to search for"}, {"in"=>"query", "name"=>"t", "description"=>"Movie title to search for"}, {"in"=>"query", "name"=>"tomatoes", "description"=>"Include Rotten Tomatoes ratings"}, {"in"=>"query", "name"=>"type", "description"=>"Type of result to return"}, {"in"=>"query", "name"=>"v", "description"=>"API version (reserved for future use)"}, {"in"=>"query", "name"=>"y", "description"=>"Year of release"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies"]}}}}, "apis"=>{"name"=>"The Open Movie Database", "x-slug"=>"the-open-movie-database", "description"=>"The OMDb API is a free web service to obtain movie information, all content and images on the site are contributed and maintained by our users.", "image"=>"", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"General Data,Movie,Movies,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"the-open-movie-database/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"OMDb", "x-api-slug"=>"omdb", "description"=>"The OMDb API is a free web service to obtain movie information, all content and images on the site are contributed and maintained by our users.", "image"=>"", "humanURL"=>"http://omdbapi.com", "baseURL"=>"https://www.omdbapi.com//", "tags"=>"General Data,Movie,Movies,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/the-open-movie-database/get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/the-open-movie-database/omdb-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-selfservice-registration", "url"=>"http://beforethecode.com/projects/omdb/apikey.aspx"}, {"type"=>"x-website", "url"=>"http://omdbapi.com"}, {"type"=>"x-website", "url"=>"http://www.omdbapi.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-spanner{"google-cloud-spanner-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Spanner", "x-complete"=>1, "info"=>{"title"=>"Cloud Spanner", "description"=>"cloud-spanner-is-a-managed-missioncritical-globally-consistent-and-scalable-relational-database-service-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"spanner.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/{database}"=>{"delete"=>{"summary"=>"Delete Database", "description"=>"Drops (aka deletes) a Cloud Spanner database.", "operationId"=>"spanner.projects.instances.databases.dropDatabase", "x-api-path-slug"=>"v1database-delete", "parameters"=>[{"in"=>"path", "name"=>"database", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Database"]}}, "/v1/{database}/ddl"=>{"get"=>{"summary"=>"Get Database Schema", "description"=>"Returns the schema of a Cloud Spanner database as a list of formatted\nDDL statements. This method does not show pending schema updates, those may\nbe queried using the Operations API.", "operationId"=>"spanner.projects.instances.databases.getDdl", "x-api-path-slug"=>"v1databaseddl-get", "parameters"=>[{"in"=>"path", "name"=>"database", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Database Schema"]}, "patch"=>{"summary"=>"Update Database Schema", "description"=>"Updates the schema of a Cloud Spanner database by\ncreating/altering/dropping tables, columns, indexes, etc. The returned\nlong-running operation will have a name of\nthe format ` |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
reddit{"reddit-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Reddit", "x-complete"=>1, "info"=>{"title"=>"Reddit", "description"=>"the-reddit-api-allows-you-to-access-the-user-submitted-and-rated-stories-on-reddit-com--it-also-provides-advanced-functionality-including-user-account-information-and-subreddit-moderation-", "version"=>"1.0.0"}, "host"=>"www.reddit.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/me"=>{"get "=>{"summary"=>"Get Me", "description"=>"Returns the identity of the user currently authenticated via OAuth.", "operationId"=>"get V1Me", "x-api-path-slug"=>"v1me-getnbsp", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me"]}}, "/v1/me/karma"=>{"get "=>{"summary"=>"Get Me Karma", "description"=>"Return a breakdown of subreddit karma.", "operationId"=>"get V1MeKarma", "x-api-path-slug"=>"v1mekarma-getnbsp", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Karma"]}}, "/v1/me/prefs"=>{"get "=>{"summary"=>"Get Me Prefs", "description"=>"Return the preference settings of the logged in user", "operationId"=>"get V1MePrefs", "x-api-path-slug"=>"v1meprefs-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-separated list of items from this set:default_theme_srthreaded_messageshide_downsemail_messagesprofile_opt_outshow_link_flaircreddit_autorenewshow_trendingprivate_feedsmonitor_mentionsresearchignore_suggested_sortemail_digestsmediaclickgadgetuse_global_defaultslabel_nsfwdomain_detailsshow_stylesheetslive_orangeredshighlight_controversialno_profanityemail_unsubscribe_alllanghide_upsallow_clicktrackinghide_from_robotscompressstore_visitsthreaded_modmaildesign_betabetaother_thememedia_previewover_18enable_default_themesgeopopularshow_promotemin_comment_scorepublic_votesno_video_autoplayorganiccollapse_read_messagesshow_flairmark_messages_readsearch_include_over_18hide_adsmin_link_scoretop_karma_subredditsnewwindownumsiteslegacy_searchnum_commentsshow_gold_expirationhighlight_new_commentsdefault_comment_sorthide_locationbar", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Prefs"]}, "patch "=>{"summary"=>"Patch Me Prefs", "description"=>"", "operationId"=>"patch V1MePrefs", "x-api-path-slug"=>"v1meprefs-patchnbsp", "parameters"=>[{"in"=>"query", "name"=>"This endpoint expects JSON data of this format", "description"=>"{ "allow_clicktracking": boolean value, "beta": boolean value, "clickgadget": boolean value, "collapse_read_messages": boolean value, "compress": boolean value, "creddit_autorenew": boolean value, "default_comment_sort": one of (`confidence`, `top`, `new`, `controversial`, `old`, `random`, `qa`, `live`), "domain_details": boolean value, "email_digests": boolean value, "email_messages": boolean value, "email_unsubscribe_all": boolean value, "enable_default_themes": boolean value, "g": one of (`GLOBAL`, `US`, `AR`, `AU`, `BG`, `CA`, `CL`, `CO`, `HR`, `CZ`, `FI`, `GR`, `HU`, `IS`, `IN`, `IE`, `JP`, `MY`, `MX`, `NZ`, `PH`, `PL`, `PT`, `PR`, `RO`, `RS`, `SG`, `SE`, `TW`, `TH`, `TR`, `GB`, `US_WA`, `US_DE`, `US_DC`, `US_WI`, `US_WV`, `US_HI`, `US_FL`, `US_WY`, `US_NH`, `US_NJ`, `US_NM`, `US_TX`, `US_LA`, `US_NC`, `US_ND`, `US_NE`, `US_TN`, `US_NY`, `US_PA`, `US_CA`, `US_NV`, `US_VA`, `US_CO`, `US_AK`, `US_AL`, `US_AR`, `US_VT`, `US_IL`, `US_GA`, `US_IN`, `US_IA`, `US_OK`, `US_AZ`, `US_ID`, `US_CT`, `US_ME`, `US_MD`, `US_MA`, `US_OH`, `US_UT`, `US_MO`, `US_MN`, `US_MI`, `US_RI`, `US_KS`, `US_MT`, `US_MS`, `US_SC`, `US_KY`, `US_OR`, `US_SD`), "hide_ads": boolean value, "hide_downs": boolean value, "hide_from_robots": boolean value, "hide_locationbar": boolean value, "hide_ups": boolean value, "highlight_controversial": boolean value, "highlight_new_comments": boolean value, "ignore_suggested_sort": boolean value, "in_redesign_beta": boolean value, "label_nsfw": boolean value, "lang": a valid IETF language tag (underscore separated), "legacy_search": boolean value, "live_orangereds": boolean value, "mark_messages_read": boolean value, "media": one of (`on`, `off`, `subreddit`), "media_preview": one of (`on`, `off`, `subreddit`), "min_comment_score": an integer between -100 and 100, "min_link_score": an integer between -100 and 100, "monitor_mentions": boolean value, "newwindow": boolean value, "no_profanity": boolean value, "no_video_autoplay": boolean value, "num_comments": an integer between 1 and 500, "numsites": an integer between 1 and 100, "organic": boolean value, "other_theme": subreddit name, "over_18": boolean value, "private_feeds": boolean value, "profile_opt_out": boolean value, "public_votes": boolean value, "research": boolean value, "search_include_over_18": boolean value, "show_flair": boolean value, "show_gold_expiration": boolean value, "show_link_flair": boolean value, "show_promote": boolean value, "show_stylesheets": boolean value, "show_trending": boolean value, "store_visits": boolean value, "theme_selector": subreddit name, "threaded_messages": boolean value, "threaded_modmail": boolean value, "top_karma_subreddits": boolean value, "use_global_defaults": boolean value,}", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Prefs"]}}, "/v1/me/trophies"=>{"get "=>{"summary"=>"Get Me Trophies", "description"=>"Return a list of trophies for the current user.", "operationId"=>"get V1MeTrophies", "x-api-path-slug"=>"v1metrophies-getnbsp", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Trophies"]}}, "/prefs/where"=>{"get "=>{"summary"=>"Get Prefs Where", "description"=>"This endpoint is a listing.", "operationId"=>"get PrefsWhere", "x-api-path-slug"=>"prefswhere-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Prefs", "Where"]}}, "/v1/subreddit/emoji.json"=>{"post "=>{"summary"=>"Add Subreddit Emoji.json", "description"=>"Add an emoji to the DB by posting a message on emoji_upload_q.\nA job processor that listens on a queue, uses the s3_key provided\nin the request to locate the image in S3 Temp Bucket and moves it\nto the PERM bucket. It also adds it to the DB using name as the column\nand sr_fullname as the key and sends the status on the websocket URL\nthat is provided as part of this response.", "operationId"=>"post V1SubredditEmoji.json", "x-api-path-slug"=>"v1subredditemoji-json-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"Name of the emoji to be created", "type"=>"string"}, {"in"=>"query", "name"=>"s3_key", "description"=>"S3 key of the uploaded image which can be obtained from the S3 url", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Emoji.json"]}}, "/v1/subreddit/emoji/emoji_name"=>{"delete "=>{"summary"=>"Delete Subreddit Emoji Emoji Name", "description"=>"Delete a Subreddit emoji.\nRemove the emoji from Cassandra and purge the assets from S3\nand the image resizing provider.", "operationId"=>"delete V1SubredditEmojiEmojiName", "x-api-path-slug"=>"v1subredditemojiemoji-name-deletenbsp", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Emoji", "Emoji", "Name"]}}, "/v1/subreddit/emoji_asset_upload_s3.json"=>{"post "=>{"summary"=>"Add Subreddit Emoji Asset Upload S3.json", "description"=>"Acquire and return an upload lease to s3 temp bucket. The return value\nof this function is a json object containing credentials for uploading\nassets to S3 bucket, S3 url for upload request and the key to use for\nuploading. Using this lease the client will upload the emoji image to\nS3 temp bucket (included as part of the S3 URL).", "operationId"=>"post V1SubredditEmojiAssetUploadS3.json", "x-api-path-slug"=>"v1subredditemoji-asset-upload-s3-json-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"filepath", "description"=>"name and extension of the image file e", "type"=>"string"}, {"in"=>"query", "name"=>"mimetype", "description"=>"mime type of the image e", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Emoji", "Asset", "Upload", "S3.json"]}}, "/v1/subreddit/emojis/all"=>{"get "=>{"summary"=>"Get Subreddit Emojis All", "description"=>"Get all emojis for a SR. The response inclueds reddit emojis\nas well as emojis for the SR specified in the request.", "operationId"=>"get V1SubredditEmojisAll", "x-api-path-slug"=>"v1subredditemojisall-getnbsp", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Emojis"]}}, "/v1/gold/gild/fullname"=>{"post "=>{"summary"=>"Add Gold Gild Fullname", "description"=>"fullname of a thing", "operationId"=>"post V1GoldGildFullname", "x-api-path-slug"=>"v1goldgildfullname-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"fullname", "description"=>"fullname of a thing", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gold", "Gild", "Fullname"]}}, "/v1/gold/give/username"=>{"post "=>{"summary"=>"Add Gold Give Username", "description"=>"an integer between 1 and 36", "operationId"=>"post V1GoldGiveUsername", "x-api-path-slug"=>"v1goldgiveusername-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"months", "description"=>"an integer between 1 and 36", "type"=>"string"}, {"in"=>"query", "name"=>"username", "description"=>"A valid, existing reddit username", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gold", "Give", "Username"]}}, "/best.json"=>{"get"=>{"summary"=>"Get Best", "description"=>"This endpoint is a listing.", "operationId"=>"get Best", "x-api-path-slug"=>"best-json-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Best"]}}, "/by_id/names"=>{"get"=>{"summary"=>"Get By Names", "description"=>"Get a listing of links by fullname.", "operationId"=>"get ByNames", "x-api-path-slug"=>"by-idnames-get", "parameters"=>[{"in"=>"query", "name"=>"names", "description"=>"A comma-separated list of link fullnames", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Names"]}}, "{/r/subreddit}/comments/article"=>{"get "=>{"summary"=>"Get Subreddit Comments Article", "description"=>"Get the comment tree for a given Link article.", "operationId"=>"get RSubredditCommentsArticle", "x-api-path-slug"=>"rsubredditcommentsarticle-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"article", "description"=>"ID36 of a link", "type"=>"string"}, {"in"=>"query", "name"=>"comment", "description"=>"(optional) ID36 of a comment", "type"=>"string"}, {"in"=>"query", "name"=>"context", "description"=>"an integer between 0 and 8", "type"=>"string"}, {"in"=>"query", "name"=>"depth", "description"=>"(optional) an integer", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"(optional) an integer", "type"=>"string"}, {"in"=>"query", "name"=>"showedits", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"showmore", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"sort", "description"=>"one of (confidence, top, new, controversial, old, random, qa, live)", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}, {"in"=>"query", "name"=>"threaded", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"truncate", "description"=>"an integer between 0 and 50", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Comments", "Article"]}}, "/duplicates/article"=>{"get "=>{"summary"=>"Get Duplicates Article", "description"=>"Return a list of other submissions of the same URL", "operationId"=>"get DuplicatesArticle", "x-api-path-slug"=>"duplicatesarticle-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"article", "description"=>"The base 36 ID of a Link", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Duplicates", "Article"]}}, "{/r/subreddit}/hot.json"=>{"get"=>{"summary"=>"Get Subreddit Hot", "description"=>"This endpoint is a listing.", "operationId"=>"get RSubredditHot", "x-api-path-slug"=>"rsubreddithot-json-get", "parameters"=>[{"in"=>"path", "name"=>"/r/subreddit", "description"=>"The subreddit", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"g", "description"=>"one of (GLOBAL, US, AR, AU, BG, CA, CL, CO, HR, CZ, FI, GR, HU, IS, IN, IE, JP, MY, MX, NZ, PH, PL, PT, PR, RO, RS, SG, SE, TW, TH, TR, GB, US_WA, US_DE, US_DC, US_WI, US_WV, US_HI, US_FL, US_WY, US_NH, US_NJ, US_NM, US_TX, US_LA, US_NC, US_ND, US_NE, US_TN, US_NY, US_PA, US_CA, US_NV, US_VA, US_CO, US_AK, US_AL, US_AR, US_VT, US_IL, US_GA, US_IN, US_IA, US_OK, US_AZ, US_ID, US_CT, US_ME, US_MD, US_MA, US_OH, US_UT, US_MO, US_MN, US_MI, US_RI, US_KS, US_MT, US_MS, US_SC, US_KY, US_OR, US_SD)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Hot"]}}, "{/r/subreddit}/new.json"=>{"get"=>{"summary"=>"Get Subreddit New", "description"=>"This endpoint is a listing.", "operationId"=>"get RSubredditNew", "x-api-path-slug"=>"rsubredditnew-json-get", "parameters"=>[{"in"=>"path", "name"=>"/r/subreddit", "description"=>"the subreddit", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "New"]}}, "{/r/subreddit}/random.json"=>{"get"=>{"summary"=>"Get Subreddit Random", "description"=>"The Serendipity button", "operationId"=>"get RSubredditRandom", "x-api-path-slug"=>"rsubredditrandom-json-get", "parameters"=>[{"in"=>"path", "name"=>"/r/subreddit", "description"=>"The subreddit", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Random"]}}, "{/r/subreddit}/rising.json"=>{"get"=>{"summary"=>"Get Subreddit Rising", "description"=>"This endpoint is a listing.", "operationId"=>"get RSubredditRising", "x-api-path-slug"=>"rsubredditrising-json-get", "parameters"=>[{"in"=>"path", "name"=>"/r/subreddit", "description"=>"The subreddit", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Rising"]}}, "{/r/subreddit}/sort"=>{"get"=>{"summary"=>"Get Subreddit Sort", "description"=>"This endpoint is a listing.", "operationId"=>"get RSubredditSort", "x-api-path-slug"=>"rsubredditsort-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}, {"in"=>"query", "name"=>"t", "description"=>"one of (hour, day, week, month, year, all)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Sort"]}}, "/block"=>{"post "=>{"summary"=>"Add Block", "description"=>"For blocking the author of a thing via inbox.", "operationId"=>"post Block", "x-api-path-slug"=>"block-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Block"]}}, "/collapse_message"=>{"post "=>{"summary"=>"Add Collapse Message", "description"=>"Collapse a message", "operationId"=>"post CollapseMessage", "x-api-path-slug"=>"collapse-message-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"A comma-separated list of thing fullnames", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collapse", "Message"]}}, "/compose"=>{"post "=>{"summary"=>"Add Compose", "description"=>"Handles message composition under /message/compose.", "operationId"=>"post Compose", "x-api-path-slug"=>"compose-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"api_type", "description"=>"the string json", "type"=>"string"}, {"in"=>"query", "name"=>"from_sr", "description"=>"subreddit name", "type"=>"string"}, {"in"=>"query", "name"=>"g-recaptcha-response", "type"=>"string"}, {"in"=>"query", "name"=>"subject", "description"=>"a string no longer than 100 characters", "type"=>"string"}, {"in"=>"query", "name"=>"text", "description"=>"raw markdown text", "type"=>"string"}, {"in"=>"query", "name"=>"to", "description"=>"the name of an existing user", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compose"]}}, "/del_msg"=>{"post "=>{"summary"=>"Add Del Msg", "description"=>"Delete messages from the recipient's view of their inbox.", "operationId"=>"post DelMsg", "x-api-path-slug"=>"del-msg-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Del", "Msg"]}}, "/read_all_messages"=>{"post "=>{"summary"=>"Add Read All Messages", "description"=>"Queue up marking all messages for a user as read.", "operationId"=>"post ReadAllMessages", "x-api-path-slug"=>"read-all-messages-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"filter_types", "description"=>"A comma-separated list of items", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Read", "Messages"]}}, "/read_message"=>{"post "=>{"summary"=>"Add Read Message", "description"=>"A comma-separated list of thing fullnames", "operationId"=>"post ReadMessage", "x-api-path-slug"=>"read-message-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"A comma-separated list of thing fullnames", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Read", "Message"]}}, "/unblock_subreddit"=>{"post "=>{"summary"=>"Add Unblock Subreddit", "description"=>"fullname of a thing", "operationId"=>"post UnblockSubreddit", "x-api-path-slug"=>"unblock-subreddit-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unblock", "Subreddit"]}}, "/uncollapse_message"=>{"post "=>{"summary"=>"Add Uncollapse Message", "description"=>"Uncollapse a message", "operationId"=>"post UncollapseMessage", "x-api-path-slug"=>"uncollapse-message-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"A comma-separated list of thing fullnames", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Uncollapse", "Message"]}}, "/unread_message"=>{"post "=>{"summary"=>"Add Unread Message", "description"=>"A comma-separated list of thing fullnames", "operationId"=>"post UnreadMessage", "x-api-path-slug"=>"unread-message-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"A comma-separated list of thing fullnames", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unread", "Message"]}}, "/message/where"=>{"get "=>{"summary"=>"Get Message Where", "description"=>"This endpoint is a listing.", "operationId"=>"get MessageWhere", "x-api-path-slug"=>"messagewhere-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"mark", "description"=>"one of (true, false)", "type"=>"string"}, {"in"=>"query", "name"=>"mid", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Where"]}}, "{/r/subreddit}/about/log"=>{"get "=>{"summary"=>"Get Subreddit About Log", "description"=>"Get a list of recent moderation actions.", "operationId"=>"get RSubredditAboutLog", "x-api-path-slug"=>"rsubredditaboutlog-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 500)", "type"=>"string"}, {"in"=>"query", "name"=>"mod", "description"=>"(optional) a moderator filter", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"one of (banuser, unbanuser, spamlink, removelink, approvelink, spamcomment, removecomment, approvecomment, addmoderator, invitemoderator, uninvitemoderator, acceptmoderatorinvite, removemoderator, addcontributor, removecontributor, editsettings, editflair, distinguish, marknsfw, wikibanned, wikicontributor, wikiunbanned, wikipagelisted, removewikicontributor, wikirevise, wikipermlevel, ignorereports, unignorereports, setpermissions, setsuggestedsort, sticky, unsticky, setcontestmode, unsetcontestmode, lock, unlock, muteuser, unmuteuser, createrule, editrule, deleterule, spoiler, unspoiler, modmail_enrollment, community_styling, community_widgets)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "About", "Log"]}}, "{/r/subreddit}/about/location"=>{"get "=>{"summary"=>"Get Subreddit About Location", "description"=>"Return a listing of posts relevant to moderators.", "operationId"=>"get RSubredditAboutLocation", "x-api-path-slug"=>"rsubredditaboutlocation-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"location", "type"=>"string"}, {"in"=>"query", "name"=>"only", "description"=>"one of (links, comments)", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "About", "Location"]}}, "{/r/subreddit}/accept_moderator_invite"=>{"post "=>{"summary"=>"Add Subreddit Accept Moderator Invite", "description"=>"Accept an invite to moderate the specified subreddit.", "operationId"=>"post RSubredditAcceptModeratorInvite", "x-api-path-slug"=>"rsubredditaccept-moderator-invite-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"api_type", "description"=>"the string json", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Accept", "Moderator", "Invite"]}}, "/approve"=>{"post "=>{"summary"=>"Add Approve", "description"=>"Approve a link or comment.", "operationId"=>"post Approve", "x-api-path-slug"=>"approve-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Approve"]}}, "/distinguish"=>{"post "=>{"summary"=>"Add Distinguish", "description"=>"Distinguish a thing's author with a sigil.", "operationId"=>"post Distinguish", "x-api-path-slug"=>"distinguish-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"api_type", "description"=>"the string json", "type"=>"string"}, {"in"=>"query", "name"=>"how", "description"=>"one of (yes, no, admin, special)", "type"=>"string"}, {"in"=>"query", "name"=>"id", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"sticky", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Distinguish"]}}, "/ignore_reports"=>{"post "=>{"summary"=>"Add Ignore Reports", "description"=>"Prevent future reports on a thing from causing notifications.", "operationId"=>"post IgnoreReports", "x-api-path-slug"=>"ignore-reports-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ignore", "Reports"]}}, "/leavecontributor"=>{"post "=>{"summary"=>"Add Leavecontributor", "description"=>"Abdicate approved submitter status in a subreddit.", "operationId"=>"post Leavecontributor", "x-api-path-slug"=>"leavecontributor-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leavecontributor"]}}, "/leavemoderator"=>{"post "=>{"summary"=>"Add Leavemoderator", "description"=>"Abdicate moderator status in a subreddit.", "operationId"=>"post Leavemoderator", "x-api-path-slug"=>"leavemoderator-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leavemoderator"]}}, "/mute_message_author"=>{"post "=>{"summary"=>"Add Mute Message Author", "description"=>"For muting user via modmail.", "operationId"=>"post MuteMessageAuthor", "x-api-path-slug"=>"mute-message-author-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mute", "Message", "Author"]}}, "/remove"=>{"post "=>{"summary"=>"Add Remove", "description"=>"Remove a link, comment, or modmail message.", "operationId"=>"post Remove", "x-api-path-slug"=>"remove-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"spam", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove"]}}, "/unignore_reports"=>{"post "=>{"summary"=>"Add Unignore Reports", "description"=>"Allow future reports on a thing to cause notifications.", "operationId"=>"post UnignoreReports", "x-api-path-slug"=>"unignore-reports-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unignore", "Reports"]}}, "/unmute_message_author"=>{"post "=>{"summary"=>"Add Unmute Message Author", "description"=>"For unmuting user via modmail.", "operationId"=>"post UnmuteMessageAuthor", "x-api-path-slug"=>"unmute-message-author-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unmute", "Message", "Author"]}}, "{/r/subreddit}/stylesheet"=>{"get"=>{"summary"=>"Get Subreddit Stylesheet", "description"=>"Redirect to the subreddit's stylesheet if one exists.", "operationId"=>"get RSubredditStylesheet", "x-api-path-slug"=>"rsubredditstylesheet-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Stylesheet"]}}, "/multi/copy"=>{"post "=>{"summary"=>"Add Multi Copy", "description"=>"Copy a multi.", "operationId"=>"post MultiCopy", "x-api-path-slug"=>"multicopy-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"display_name", "description"=>"a string no longer than 50 characters", "type"=>"string"}, {"in"=>"query", "name"=>"from", "description"=>"multireddit url path", "type"=>"string"}, {"in"=>"query", "name"=>"to", "description"=>"destination multireddit url path", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Copy"]}}, "/multi/mine"=>{"get "=>{"summary"=>"Get Multi Mine", "description"=>"Fetch a list of multis belonging to the current user.", "operationId"=>"get MultiMine", "x-api-path-slug"=>"multimine-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"expand_srs", "description"=>"boolean value", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Mine"]}}, "/multi/rename"=>{"post "=>{"summary"=>"Add Multi Rename", "description"=>"Rename a multi.", "operationId"=>"post MultiRename", "x-api-path-slug"=>"multirename-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"display_name", "description"=>"a string no longer than 50 characters", "type"=>"string"}, {"in"=>"query", "name"=>"from", "description"=>"multireddit url path", "type"=>"string"}, {"in"=>"query", "name"=>"to", "description"=>"destination multireddit url path", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Rename"]}}, "/multi/user/username"=>{"get "=>{"summary"=>"Get Multi User Username", "description"=>"Fetch a list of public multis belonging to username", "operationId"=>"get MultiUserUsername", "x-api-path-slug"=>"multiuserusername-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"expand_srs", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"username", "description"=>"A valid, existing reddit username", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "User", "Username"]}}, "/multi/multipath"=>{"delete "=>{"summary"=>"Delete Multi Multipath", "description"=>"Delete a multi.", "operationId"=>"delete MultiMultipath", "x-api-path-slug"=>"multimultipath-deletenbsp", "parameters"=>[{"in"=>"query", "name"=>"expand_srs", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"multipath", "description"=>"multireddit url path", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Multipath"]}, "get "=>{"summary"=>"Get Multi Multipath", "description"=>"Fetch a multi's data and subreddit list by name.", "operationId"=>"get MultiMultipath", "x-api-path-slug"=>"multimultipath-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"expand_srs", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"multipath", "description"=>"multireddit url path", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Multipath"]}, "post "=>{"summary"=>"Add Multi Multipath", "description"=>"Create a multi. Responds with 409 Conflict if it already exists.", "operationId"=>"post MultiMultipath", "x-api-path-slug"=>"multimultipath-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"expand_srs", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"model", "description"=>"json data:{ "description_md": raw markdown text, "display_name": a string no longer than 50 characters, "icon_name": one of (`art and design`, `ask`, `books`, `business`, `cars`, `comics`, `cute animals`, `diy`, `entertainment`, `food and drink`, `funny`, `games`, `grooming`, `health`, `life advice`, `military`, `models pinup`, `music`, `news`, `philosophy`, `pictures and gifs`, `science`, `shopping`, `sports`, `style`, `tech`, `travel`, `unusual stories`, `video`, ``, `None`), "key_color": a 6-digit rgb hex color, e", "type"=>"string"}, {"in"=>"query", "name"=>"multipath", "description"=>"multireddit url path", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Multipath"]}, "put "=>{"summary"=>"Put Multi Multipath", "description"=>"Create or update a multi.", "operationId"=>"put MultiMultipath", "x-api-path-slug"=>"multimultipath-putnbsp", "parameters"=>[{"in"=>"query", "name"=>"expand_srs", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"model", "description"=>"json data:{ "description_md": raw markdown text, "display_name": a string no longer than 50 characters, "icon_name": one of (`art and design`, `ask`, `books`, `business`, `cars`, `comics`, `cute animals`, `diy`, `entertainment`, `food and drink`, `funny`, `games`, `grooming`, `health`, `life advice`, `military`, `models pinup`, `music`, `news`, `philosophy`, `pictures and gifs`, `science`, `shopping`, `sports`, `style`, `tech`, `travel`, `unusual stories`, `video`, ``, `None`), "key_color": a 6-digit rgb hex color, e", "type"=>"string"}, {"in"=>"query", "name"=>"multipath", "description"=>"multireddit url path", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Multipath"]}}, "/multi/multipath/description"=>{"get "=>{"summary"=>"Get Multi Multipath Description", "description"=>"Get a multi's description.", "operationId"=>"get MultiMultipathDescription", "x-api-path-slug"=>"multimultipathdescription-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"multipath", "description"=>"multireddit url path", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Multipath", "Description"]}, "put "=>{"summary"=>"Put Multi Multipath Description", "description"=>"Change a multi's markdown description.", "operationId"=>"put MultiMultipathDescription", "x-api-path-slug"=>"multimultipathdescription-putnbsp", "parameters"=>[{"in"=>"query", "name"=>"model", "description"=>"json data:{ "body_md": raw markdown text,}", "type"=>"string"}, {"in"=>"query", "name"=>"multipath", "description"=>"multireddit url path", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Multipath", "Description"]}}, "/multi/multipath/r/srname"=>{"delete "=>{"summary"=>"Delete Multi Multipath Srname", "description"=>"Remove a subreddit from a multi.", "operationId"=>"delete MultiMultipathRSrname", "x-api-path-slug"=>"multimultipathrsrname-deletenbsp", "parameters"=>[{"in"=>"query", "name"=>"multipath", "description"=>"multireddit url path", "type"=>"string"}, {"in"=>"query", "name"=>"srname", "description"=>"subreddit name", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Multipath", "Srname"]}, "get "=>{"summary"=>"Get Multi Multipath Srname", "description"=>"Get data about a subreddit in a multi.", "operationId"=>"get MultiMultipathRSrname", "x-api-path-slug"=>"multimultipathrsrname-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"multipath", "description"=>"multireddit url path", "type"=>"string"}, {"in"=>"query", "name"=>"srname", "description"=>"subreddit name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Multipath", "Srname"]}, "put "=>{"summary"=>"Put Multi Multipath Srname", "description"=>"Add a subreddit to a multi.", "operationId"=>"put MultiMultipathRSrname", "x-api-path-slug"=>"multimultipathrsrname-putnbsp", "parameters"=>[{"in"=>"query", "name"=>"model", "description"=>"json data:{ "name": subreddit name,}", "type"=>"string"}, {"in"=>"query", "name"=>"multipath", "description"=>"multireddit url path", "type"=>"string"}, {"in"=>"query", "name"=>"srname", "description"=>"subreddit name", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Multipath", "Srname"]}}, "{/r/subreddit}/about/where"=>{"get "=>{"summary"=>"Get Subreddit About Where", "description"=>"This endpoint is a listing.", "operationId"=>"get RSubredditAboutWhere", "x-api-path-slug"=>"rsubredditaboutwhere-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"A valid, existing reddit username", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "About", "Where"]}}, "{/r/subreddit}/delete_sr_banner"=>{"post "=>{"summary"=>"Add Subreddit Delete Sr Banner", "description"=>"Remove the subreddit's custom mobile banner.", "operationId"=>"post RSubredditDeleteSrBanner", "x-api-path-slug"=>"rsubredditdelete-sr-banner-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"api_type", "description"=>"the string json", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "", "Sr", "Banner"]}}, "{/r/subreddit}/delete_sr_header"=>{"post "=>{"summary"=>"Add Subreddit Delete Sr Header", "description"=>"Remove the subreddit's custom header image.", "operationId"=>"post RSubredditDeleteSrHeader", "x-api-path-slug"=>"rsubredditdelete-sr-header-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"api_type", "description"=>"the string json", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "", "Sr", "Header"]}}, "{/r/subreddit}/delete_sr_icon"=>{"post "=>{"summary"=>"Add Subreddit Delete Sr Icon", "description"=>"Remove the subreddit's custom mobile icon.", "operationId"=>"post RSubredditDeleteSrIcon", "x-api-path-slug"=>"rsubredditdelete-sr-icon-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"api_type", "description"=>"the string json", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "", "Sr", "Icon"]}}, "{/r/subreddit}/delete_sr_img"=>{"post "=>{"summary"=>"Add Subreddit Delete Sr Img", "description"=>"Remove an image from the subreddit's custom image set.", "operationId"=>"post RSubredditDeleteSrImg", "x-api-path-slug"=>"rsubredditdelete-sr-img-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"api_type", "description"=>"the string json", "type"=>"string"}, {"in"=>"query", "name"=>"img_name", "description"=>"a valid subreddit image name", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "", "Sr", "Img"]}}, "/recommend/sr/srnames"=>{"get "=>{"summary"=>"Get Recommend Sr Srnames", "description"=>"Return subreddits recommended for the given subreddit(s).", "operationId"=>"get RecommendSrSrnames", "x-api-path-slug"=>"recommendsrsrnames-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"omit", "description"=>"comma-delimited list of subreddit names", "type"=>"string"}, {"in"=>"query", "name"=>"over_18", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"srnames", "description"=>"comma-delimited list of subreddit names", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recommend", "Sr", "Srnames"]}}, "/api/search_reddit_names.json"=>{"get"=>{"summary"=>"Get Search Reddit Names", "description"=>"List subreddit names that begin with a query string.", "operationId"=>"get SearchRedditNames", "x-api-path-slug"=>"apisearch-reddit-names-json-get", "parameters"=>[{"in"=>"query", "name"=>"exact", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"include_over_18", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"include_unadvertisable", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"a string up to 50 characters long, consisting of printable characters", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Reddit", "Names"]}}, "/search_reddit_names"=>{"post "=>{"summary"=>"Add Search Reddit Names", "description"=>"List subreddit names that begin with a query string.", "operationId"=>"post SearchRedditNames", "x-api-path-slug"=>"search-reddit-names-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"exact", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"include_over_18", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"include_unadvertisable", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"a string up to 50 characters long, consisting of printable characters", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Reddit", "Names"]}}, "/search_subreddits"=>{"post "=>{"summary"=>"Add Search Subreddits", "description"=>"List subreddits that begin with a query string.", "operationId"=>"post SearchSubreddits", "x-api-path-slug"=>"search-subreddits-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"exact", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"include_over_18", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"include_unadvertisable", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"a string up to 50 characters long, consisting of printable characters", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Subreddits"]}}, "/site_admin"=>{"post "=>{"summary"=>"Add Site Admin", "description"=>"Create or configure a subreddit.", "operationId"=>"post SiteAdmin", "x-api-path-slug"=>"site-admin-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"allow_discovery", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"allow_images", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"allow_post_crossposts", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"allow_top", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"allow_videos", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"api_type", "description"=>"the string json", "type"=>"string"}, {"in"=>"query", "name"=>"collapse_deleted_comments", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"comment_score_hide_mins", "description"=>"an integer between 0 and 1440 (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"description", "description"=>"raw markdown text", "type"=>"string"}, {"in"=>"query", "name"=>"exclude_banned_modqueue", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"free_form_reports", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"g-recaptcha-response", "type"=>"string"}, {"in"=>"query", "name"=>"header-title", "description"=>"a string no longer than 500 characters", "type"=>"string"}, {"in"=>"query", "name"=>"hide_ads", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"key_color", "description"=>"a 6-digit rgb hex color, e", "type"=>"string"}, {"in"=>"query", "name"=>"lang", "description"=>"a valid IETF language tag (underscore separated)", "type"=>"string"}, {"in"=>"query", "name"=>"link_type", "description"=>"one of (any, link, self)", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"subreddit name", "type"=>"string"}, {"in"=>"query", "name"=>"over_18", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"public_description", "description"=>"raw markdown text", "type"=>"string"}, {"in"=>"query", "name"=>"show_media", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"show_media_preview", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"spam_comments", "description"=>"one of (low, high, all)", "type"=>"string"}, {"in"=>"query", "name"=>"spam_links", "description"=>"one of (low, high, all)", "type"=>"string"}, {"in"=>"query", "name"=>"spam_selfposts", "description"=>"one of (low, high, all)", "type"=>"string"}, {"in"=>"query", "name"=>"spoilers_enabled", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"sr", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"submit_link_label", "description"=>"a string no longer than 60 characters", "type"=>"string"}, {"in"=>"query", "name"=>"submit_text", "description"=>"raw markdown text", "type"=>"string"}, {"in"=>"query", "name"=>"submit_text_label", "description"=>"a string no longer than 60 characters", "type"=>"string"}, {"in"=>"query", "name"=>"suggested_comment_sort", "description"=>"one of (confidence, top, new, controversial, old, random, qa, live)", "type"=>"string"}, {"in"=>"query", "name"=>"theme_sr", "description"=>"subreddit name", "type"=>"string"}, {"in"=>"query", "name"=>"theme_sr_update", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"title", "description"=>"a string no longer than 100 characters", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"one of (gold_restricted, archived, restricted, employees_only, gold_only, private, user, public)", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}, {"in"=>"query", "name"=>"wikimode", "description"=>"one of (disabled, modonly, anyone)", "type"=>"string"}, {"in"=>"query", "name"=>"wiki_edit_age", "description"=>"an integer between 0 and 36600 (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"wiki_edit_karma", "description"=>"an integer between 0 and 1000000000 (default: 0)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Site", "Admin"]}}, "{/r/subreddit}/submit_text"=>{"get"=>{"summary"=>"Get Subreddit Submit Text", "description"=>"Get the submission text for the subreddit.", "operationId"=>"get RSubredditSubmitText", "x-api-path-slug"=>"rsubredditsubmit-text-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Submit", "Text"]}}, "/subreddit_autocomplete"=>{"get "=>{"summary"=>"Get Subreddit Autocomplete", "description"=>"Return a list of subreddits and data for subreddits whose names start\nwith 'query'.", "operationId"=>"get SubredditAutocomplete", "x-api-path-slug"=>"subreddit-autocomplete-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"include_over_18", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"include_profiles", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"a string up to 50 characters long, consisting of printable characters", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Autocomplete"]}}, "/subreddit_autocomplete_v2"=>{"get "=>{"summary"=>"Get Subreddit Autocomplete V2", "description"=>"boolean value", "operationId"=>"get SubredditAutocompleteV2", "x-api-path-slug"=>"subreddit-autocomplete-v2-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"include_over_18", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"include_profiles", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"an integer between 1 and 10 (default: 5)", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"a string up to 50 characters long, consisting of printable characters", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Autocomplete", "V2"]}}, "{/r/subreddit}/subreddit_stylesheet"=>{"post "=>{"summary"=>"Add Subreddit Subreddit Stylesheet", "description"=>"Update a subreddit's stylesheet.", "operationId"=>"post RSubredditSubredditStylesheet", "x-api-path-slug"=>"rsubredditsubreddit-stylesheet-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"api_type", "description"=>"the string json", "type"=>"string"}, {"in"=>"query", "name"=>"op", "description"=>"one of (save, preview)", "type"=>"string"}, {"in"=>"query", "name"=>"reason", "description"=>"a string up to 256 characters long, consisting of printable characters", "type"=>"string"}, {"in"=>"query", "name"=>"stylesheet_contents", "description"=>"the new stylesheet content", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Subreddit", "Stylesheet"]}}, "/subreddits/new.json"=>{"get"=>{"summary"=>"Get New Subreddits", "description"=>"Returns new subreddits.", "operationId"=>"getNewSubreddit", "x-api-path-slug"=>"subredditsnew-json-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"a string no longer than 50 characters", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddits", "New"]}}, "/subscribe"=>{"post "=>{"summary"=>"Add Subscribe", "description"=>"Subscribe to or unsubscribe from a subreddit.", "operationId"=>"post Subscribe", "x-api-path-slug"=>"subscribe-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"action", "description"=>"one of (sub, unsub)", "type"=>"string"}, {"in"=>"query", "name"=>"skip_initial_defaults", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"sr / sr_name", "description"=>"A comma-separated list of subreddit fullnames (when using the "sr" parameter), or of subreddit names (when using the "sr_name" parameter)", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscribe"]}}, "{/r/subreddit}/upload_sr_img"=>{"post "=>{"summary"=>"Add Subreddit Upload Sr Img", "description"=>"Add or replace a subreddit image, custom header logo, custom mobile\nicon, or custom mobile banner.", "operationId"=>"post RSubredditUploadSrImg", "x-api-path-slug"=>"rsubredditupload-sr-img-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"file", "description"=>"file upload with maximum size of 500 KiB", "type"=>"string"}, {"in"=>"query", "name"=>"formid", "description"=>"(optional) can be ignored", "type"=>"string"}, {"in"=>"query", "name"=>"header", "description"=>"an integer between 0 and 1", "type"=>"string"}, {"in"=>"query", "name"=>"img_type", "description"=>"one of png or jpg (default: png)", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"a valid subreddit image name", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}, {"in"=>"query", "name"=>"upload_type", "description"=>"one of (img, header, icon, banner)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Upload", "Sr", "Img"]}}, "/r/subreddit/about"=>{"get "=>{"summary"=>"Get Subreddit About", "description"=>"Return information about the subreddit.", "operationId"=>"get RSubredditAbout", "x-api-path-slug"=>"rsubredditabout-getnbsp", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "About"]}}, "/r/subreddit/about/edit"=>{"get "=>{"summary"=>"Get Subreddit About Edit", "description"=>"Get the current settings of a subreddit.", "operationId"=>"get RSubredditAboutEdit", "x-api-path-slug"=>"rsubredditaboutedit-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"created", "description"=>"one of (true, false)", "type"=>"string"}, {"in"=>"query", "name"=>"location", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "About", "Edit"]}}, "/r/subreddit/about/rules"=>{"get "=>{"summary"=>"Get Subreddit About Rules", "description"=>"Get the rules for the current subreddit", "operationId"=>"get RSubredditAboutRules", "x-api-path-slug"=>"rsubredditaboutrules-getnbsp", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "About", "Rules"]}}, "/r/subreddit/about/traffic"=>{"get "=>{"summary"=>"Get Subreddit About Traffic", "description"=>"Get the traffic for the current subreddit", "operationId"=>"get RSubredditAboutTraffic", "x-api-path-slug"=>"rsubredditabouttraffic-getnbsp", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "About", "Traffic"]}}, "{/r/subreddit}/sidebar"=>{"get"=>{"summary"=>"Get Subreddit Sebar", "description"=>"Get the sidebar for the current subreddit", "operationId"=>"get RSubredditSebar", "x-api-path-slug"=>"rsubredditsidebar-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Sebar"]}}, "{/r/subreddit}/sticky"=>{"get"=>{"summary"=>"Get Subreddit Sticky", "description"=>"Redirect to one of the posts stickied in the current subreddit", "operationId"=>"get RSubredditSticky", "x-api-path-slug"=>"rsubredditsticky-get", "parameters"=>[{"in"=>"query", "name"=>"num", "description"=>"an integer between 1 and 2 (default: 1)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Sticky"]}}, "/subreddits/mine/where"=>{"get "=>{"summary"=>"Get Subreddits Mine Where", "description"=>"Get subreddits the user has a relationship with.", "operationId"=>"get SubredditsMineWhere", "x-api-path-slug"=>"subredditsminewhere-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddits", "Mine", "Where"]}}, "/subreddits/search.json"=>{"get"=>{"summary"=>"Get Subreddits Search", "description"=>"Search subreddits by title and description.", "operationId"=>"get SubredditsSearch", "x-api-path-slug"=>"subredditssearch-json-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"q", "description"=>"a search query", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sort", "description"=>"one of (relevance, activity)", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddits", "Search"]}}, "/subreddits/popular.json"=>{"get"=>{"summary"=>"Get Subreddits Where", "description"=>"Get all subreddits.", "operationId"=>"get SubredditsWhere", "x-api-path-slug"=>"subredditspopular-json-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddits", "Where"]}}, "/users/where"=>{"get "=>{"summary"=>"Get Users Where", "description"=>"Get all user subreddits.", "operationId"=>"get UsersWhere", "x-api-path-slug"=>"userswhere-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Where"]}}, "{/r/subreddit}/wiki/alloweditor/act"=>{"post "=>{"summary"=>"Add Subreddit Wiki Alloweditor Act", "description"=>"Allow/deny username to edit this wiki page", "operationId"=>"post RSubredditWikiAlloweditorAct", "x-api-path-slug"=>"rsubredditwikialloweditoract-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"act", "description"=>"one of (del, add)", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"the name of an existing wiki page", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}, {"in"=>"query", "name"=>"username", "description"=>"the name of an existing user", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Wikioweditor", "Act"]}}, "{/r/subreddit}/wiki/edit"=>{"post "=>{"summary"=>"Subreddit Wiki Edit", "description"=>"Edit a wiki page", "operationId"=>"post RSubredditWikiEdit", "x-api-path-slug"=>"rsubredditwikiedit-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"content", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"the name of an existing page or a new page to create", "type"=>"string"}, {"in"=>"query", "name"=>"previous", "description"=>"the starting point revision for this edit", "type"=>"string"}, {"in"=>"query", "name"=>"reason", "description"=>"a string up to 256 characters long, consisting of printable characters", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Wiki", "Edit"]}}, "{/r/subreddit}/wiki/hide"=>{"post "=>{"summary"=>"Add Subreddit Wiki", "description"=>"Toggle the public visibility of a wiki page revision", "operationId"=>"post RSubredditWikiHe", "x-api-path-slug"=>"rsubredditwikihide-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"the name of an existing wiki page", "type"=>"string"}, {"in"=>"query", "name"=>"revision", "description"=>"a wiki revision ID", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Wiki"]}}, "{/r/subreddit}/wiki/revert"=>{"post "=>{"summary"=>"Add Subreddit Wiki Revert", "description"=>"Revert a wiki page to revision", "operationId"=>"post RSubredditWikiRevert", "x-api-path-slug"=>"rsubredditwikirevert-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"the name of an existing wiki page", "type"=>"string"}, {"in"=>"query", "name"=>"revision", "description"=>"a wiki revision ID", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Wiki", "Revert"]}}, "{/r/subreddit}/wiki/discussions/page"=>{"get "=>{"summary"=>"Get Subreddit Wiki Discussions Page", "description"=>"Retrieve a list of discussions about this wiki page", "operationId"=>"get RSubredditWikiDiscussionsPage", "x-api-path-slug"=>"rsubredditwikidiscussionspage-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"the name of an existing wiki page", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Wiki", "Discussions", "Page"]}}, "{/r/subreddit}/wiki/pages"=>{"get "=>{"summary"=>"Get Subreddit Wiki Pages", "description"=>"Retrieve a list of wiki pages in this subreddit", "operationId"=>"get RSubredditWikiPages", "x-api-path-slug"=>"rsubredditwikipages-getnbsp", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Wiki", "Pages"]}}, "{/r/subreddit}/wiki/revisions"=>{"get "=>{"summary"=>"Get Subreddit Wiki Revisions", "description"=>"Retrieve a list of recently changed wiki pages in this subreddit", "operationId"=>"get RSubredditWikiRevisions", "x-api-path-slug"=>"rsubredditwikirevisions-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Wiki", "Revisions"]}}, "{/r/subreddit}/wiki/revisions/page"=>{"get "=>{"summary"=>"Get Subreddit Wiki Revisions Page", "description"=>"Retrieve a list of revisions of this wiki page", "operationId"=>"get RSubredditWikiRevisionsPage", "x-api-path-slug"=>"rsubredditwikirevisionspage-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"fullname of a thing", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"a positive integer (default: 0)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"the maximum number of items desired (default: 25, maximum: 100)", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"the name of an existing wiki page", "type"=>"string"}, {"in"=>"query", "name"=>"show", "description"=>"(optional) the string all", "type"=>"string"}, {"in"=>"query", "name"=>"sr_detail", "description"=>"(optional) expand subreddits", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Wiki", "Revisions", "Page"]}}, "{/r/subreddit}/wiki/settings/page"=>{"get "=>{"summary"=>"Get Subreddit Wiki Settings Page", "description"=>"Retrieve the current permission settings for page", "operationId"=>"get RSubredditWikiSettingsPage", "x-api-path-slug"=>"rsubredditwikisettingspage-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"the name of an existing wiki page", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Wiki", "Settings", "Page"]}, "post "=>{"summary"=>"Add Subreddit Wiki Settings Page", "description"=>"Update the permissions and visibility of wiki page", "operationId"=>"post RSubredditWikiSettingsPage", "x-api-path-slug"=>"rsubredditwikisettingspage-postnbsp", "parameters"=>[{"in"=>"query", "name"=>"/r/subreddit", "description"=>"subreddit", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"listed", "description"=>"boolean value", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"the name of an existing wiki page", "type"=>"string"}, {"in"=>"query", "name"=>"permlevel", "description"=>"an integer", "type"=>"string"}, {"in"=>"query", "name"=>"uh / X-Modhash header", "description"=>"a modhash", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Wiki", "Settings", "Page"]}}, "{/r/subreddit}/wiki/page"=>{"get "=>{"summary"=>"Get Subreddit Wiki Page", "description"=>"Return the content of a wiki page", "operationId"=>"get RSubredditWikiPage", "x-api-path-slug"=>"rsubredditwikipage-getnbsp", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"the name of an existing wiki page", "type"=>"string"}, {"in"=>"query", "name"=>"v", "description"=>"a wiki revision ID", "type"=>"string"}, {"in"=>"query", "name"=>"v2", "description"=>"a wiki revision ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subreddit", "Wiki", "Page"]}}}}, "apis"=>{"name"=>"Reddit", "x-slug"=>"reddit", "description"=>"Reddit is a community of millions of users engaging in the creation of content and the sharing of conversation across tens of thousands of topics.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/3516-reddit.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"6", "tags"=>"General Data,internet,Links,Media,Mobile,My API Stack,Pedestal,Relative StreamRank,SDIO Syndication,Social,Social,Stack,Stack Network,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"reddit/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Reddit", "x-api-slug"=>"reddit", "description"=>"Reddit is a community of millions of users engaging in the creation of content and the sharing of conversation across tens of thousands of topics.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/3516-reddit.jpg", "humanURL"=>"http://www.reddit.com", "baseURL"=>"https://www.reddit.com//", "tags"=>"General Data,internet,Links,Media,Mobile,My API Stack,Pedestal,Relative StreamRank,SDIO Syndication,Social,Social,Stack,Stack Network,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/reddit/reddit-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://github.com/reddit/reddit/wiki/OAuth2"}, {"type"=>"x-base", "url"=>"https://www.reddit.com/"}, {"type"=>"x-best-practices", "url"=>"https://github.com/reddit/reddit/wiki/API"}, {"type"=>"x-blog", "url"=>"http://www.redditblog.com/"}, {"type"=>"x-blog-rss", "url"=>"https://www.reddit.com/r/datasets/.rss"}, {"type"=>"x-blog-rss", "url"=>"http://www.redditblog.com/feeds/posts/default?alt=rss"}, {"type"=>"x-code-libraries", "url"=>"https://github.com/reddit/reddit/wiki/API-Wrappers"}, {"type"=>"x-console", "url"=>"https://apigee.com/console/reddit"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/reddit"}, {"type"=>"x-developer", "url"=>"http://www.reddit.com/dev/api"}, {"type"=>"x-email", "url"=>"legal@reddit.com"}, {"type"=>"x-github", "url"=>"https://github.com/reddit"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/product-hunt/"}, {"type"=>"x-privacy", "url"=>"https://www.reddit.com/help/privacypolicy"}, {"type"=>"x-security", "url"=>"https://www.reddit.com/help/privacypolicy#section_security"}, {"type"=>"x-support", "url"=>"https://www.reddit.com/contact/"}, {"type"=>"x-terms-of-service", "url"=>"http://www.reddit.com/help/useragreement"}, {"type"=>"x-transparency-report", "url"=>"https://www.reddit.com/wiki/transparency"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/reddit"}, {"type"=>"x-website", "url"=>"http://www.reddit.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
okta{"okta-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Okta", "x-complete"=>1, "info"=>{"title"=>"Users (Okta API)", "description"=>"the-okta-user-apidocsapirestusers-html-provides-operations-to-manage-users-in-your-organization-", "version"=>"1.0.0"}, "host"=>"example.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/users/{userId}"=>{"get"=>{"summary"=>"Get User", "description"=>"Get user.", "operationId"=>"getUsersUser", "x-api-path-slug"=>"usersuserid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "put"=>{"summary"=>"Set Password", "description"=>"Set password.", "operationId"=>"putUsersUser", "x-api-path-slug"=>"usersuserid-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Password"]}}, "/users"=>{"get"=>{"summary"=>"List Password Expired Users", "description"=>"List password expired users.", "operationId"=>"getUsers", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"filter"}, {"in"=>"query", "name"=>"limit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Password", "Expired", "Users"]}, "post"=>{"summary"=>"Create User without Credentials", "description"=>"Create user without credentials.", "operationId"=>"postUsers", "x-api-path-slug"=>"users-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"activate"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Without", "Credentials"]}}, "/users/{userId}/lifecycle/reset_factors"=>{"post"=>{"summary"=>"Reset Factors", "description"=>"Reset factors.", "operationId"=>"postUsersUserLifecycleResetFactors", "x-api-path-slug"=>"usersuseridlifecyclereset-factors-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reset", "Factors"]}}, "/users/{userId}/lifecycle/suspend"=>{"post"=>{"summary"=>"Suspend User", "description"=>"Suspend user.", "operationId"=>"postUsersUserLifecycleSuspend", "x-api-path-slug"=>"usersuseridlifecyclesuspend-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suspend", "User"]}}, "/users/{userId}/credentials/forgot_password"=>{"post"=>{"summary"=>"Forgot Password (One Time Code)", "description"=>"Forgot password (one time code).", "operationId"=>"postUsersUserCredentialsForgotPassword", "x-api-path-slug"=>"usersuseridcredentialsforgot-password-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"sendEmail"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forgot", "Password", "(One", "Time", "Code)"]}}, "/users/{userId}/credentials/change_password"=>{"post"=>{"summary"=>"Change Password", "description"=>"Change password.", "operationId"=>"postUsersUserCredentialsChangePassword", "x-api-path-slug"=>"usersuseridcredentialschange-password-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change", "Password"]}}, "/users/{userId}/lifecycle/reset_password"=>{"post"=>{"summary"=>"Reset Password", "description"=>"Reset password.", "operationId"=>"postUsersUserLifecycleResetPassword", "x-api-path-slug"=>"usersuseridlifecyclereset-password-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"sendEmail"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reset", "Password"]}}, "/users/{userId}/credentials/change_recovery_question"=>{"post"=>{"summary"=>"Change Recovery Question", "description"=>"Change recovery question.", "operationId"=>"postUsersUserCredentialsChangeRecoveryQuestion", "x-api-path-slug"=>"usersuseridcredentialschange-recovery-question-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change", "Recovery", "Question"]}}, "/users/{userId}/lifecycle/activate"=>{"post"=>{"summary"=>"Activate User", "description"=>"Activate user.", "operationId"=>"postUsersUserLifecycleActivate", "x-api-path-slug"=>"usersuseridlifecycleactivate-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"sendEmail"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activate", "User"]}}, "/users/{userId}/sessions"=>{"delete"=>{"summary"=>"Clear User Sessions", "description"=>"Clear user sessions.", "operationId"=>"deleteUsersUserSessions", "x-api-path-slug"=>"usersuseridsessions-delete", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clear", "User", "Sessions"]}}, "/users/{userId}/appLinks"=>{"get"=>{"summary"=>"Get Assigned App Links", "description"=>"Get assigned app links.", "operationId"=>"getUsersUserApplinks", "x-api-path-slug"=>"usersuseridapplinks-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assigned", "App", "Links"]}}, "/users/{userId}/lifecycle/unsuspend"=>{"post"=>{"summary"=>"Unsuspend User", "description"=>"Unsuspend user.", "operationId"=>"postUsersUserLifecycleUnsuspend", "x-api-path-slug"=>"usersuseridlifecycleunsuspend-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsuspend", "User"]}}, "/users/{userId}/lifecycle/expire_password"=>{"post"=>{"summary"=>"Expire Password", "description"=>"Expire password.", "operationId"=>"postUsersUserLifecycleExpirePassword", "x-api-path-slug"=>"usersuseridlifecycleexpire-password-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Expire", "Password"]}}, "/users/{userId}/groups"=>{"get"=>{"summary"=>"Get Groups for User", "description"=>"Get groups for user.", "operationId"=>"getUsersUserGroups", "x-api-path-slug"=>"usersuseridgroups-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GroupsUser"]}}, "/users/me"=>{"get"=>{"summary"=>"Get Current User", "description"=>"Get current user.", "operationId"=>"getUsersMe", "x-api-path-slug"=>"usersme-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "User"]}}, "/users/{userId}/lifecycle/deactivate"=>{"post"=>{"summary"=>"Deactivate User", "description"=>"Deactivate user.", "operationId"=>"postUsersUserLifecycleDeactivate", "x-api-path-slug"=>"usersuseridlifecycledeactivate-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deactivate", "User"]}}, "/users/{userId}/lifecycle/unlock"=>{"post"=>{"summary"=>"Unlock User", "description"=>"Unlock user.", "operationId"=>"postUsersUserLifecycleUnlock", "x-api-path-slug"=>"usersuseridlifecycleunlock-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unlock", "User"]}}}}, "apis"=>{"name"=>"Okta", "x-slug"=>"okta", "description"=>"Provide secure identity management and single sign-on to any application, whether in the cloud, on-premises or on a mobile device for your employees, partners and customers with Okta.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1937-okta.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"450", "tags"=>"API Provider,API Service Provider,Authentication,Enterprise,Identities,Profiles,Relative Data,SaaS,Service API,Stack Network,Target,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"okta/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Okta", "x-api-slug"=>"okta", "description"=>"Provide secure identity management and single sign-on to any application, whether in the cloud, on-premises or on a mobile device for your employees, partners and customers with Okta.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1937-okta.jpg", "humanURL"=>"https://www.okta.com", "baseURL"=>"https://example.com//api/v1", "tags"=>"API Provider,API Service Provider,Authentication,Enterprise,Identities,Profiles,Relative Data,SaaS,Service API,Stack Network,Target,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/okta/okta-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://*.okta.com"}, {"type"=>"x-blog", "url"=>"http://www.okta.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"http://feeds.feedburner.com/OktaBlog"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/okta"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/okta"}, {"type"=>"x-developer", "url"=>"http://developer.okta.com/"}, {"type"=>"x-github", "url"=>"https://github.com/okta"}, {"type"=>"x-partners", "url"=>"https://servicenowsignon.okta.com/login/login.htm?fromURI=%2Fapp%2Fservicenowexternal_partnerportal_1%2Fexk3solzovVHsGaP20x7%2Fsso%2Fsaml%3FSAMLRequest%3DjZLNTuswEIVfJfI%252BiZ2EprWaSqEVUImfqO1lcTfITaZg4djB45TC05OmRZTF5bL1fDNn5hyPUdQqanjeuie9gJcW0Hm7Wmnkh0pGWqu5ESiRa1EDclfyZX5zzaOA8sYaZ0qjiJcjgnXS6KnR2NZgl2C3soQ%252Fi%252BuMPDnXIA%252FDRlinwTbGOqECPBC%252BNq9BaWrizTpxqcV%252BylfPkeoglI%252Fa6MA8O7HnQ9E0J1XYObBaqIdvIg8shN1zjEa9m%252B39FV6KIqK7NEQ04f5A4l0YW0J%252FfkY2QiEQbz7LyPJ2miaDeD1cQ5nQlI0YKwejwZrFURwnLKFnmw7EQiDKLXy1IrYw1%252BiEdhmJKBv6NPVpsmJnnEacDYMRTf8Srzgady51JfXjzy6vDxDyq9Wq8Iu75aofsJUV2NuO%252FrXB92CxN7ebSibjPmHer2xPQ%252F95G%252FGZNJn8N6NxeKpxVGz4fun5rDBKlm9erpR5nVoQrjvE2Rb6TGrh%252Fr0GC1j%252FIit%252F06McaiFVXlUWEEk4Oep%252B%252"}, {"type"=>"x-postman-collection", "url"=>"https://app.getpostman.com/run-collection/1755573c5cf5fbf7968b"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/okta"}, {"type"=>"x-website", "url"=>"https://www.okta.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
datadog{"datadog-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Datadog", "x-complete"=>1, "info"=>{"title"=>"DataDog Merged API", "version"=>"1.0.0"}, "basePath"=>"api/v1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/metrics"=>{"get"=>{"summary"=>"Get Metrics", "description"=>"Get the list of actively reporting metrics from a given time until now. This endpoint is not available in the Python and Ruby libraries.", "operationId"=>"getMetrics", "x-api-path-slug"=>"metrics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Metrics"]}}, "/series"=>{"post"=>{"summary"=>"Add Series", "description"=>"The metrics end-point allows you to post time-series data that can be\n graphed on Datadog's dashboards.", "operationId"=>"postSeries", "x-api-path-slug"=>"series-post", "parameters"=>[{"in"=>"query", "name"=>"[[POSIX_timestamp, numeric_value], ...]", "description"=>"Note that the timestamp should be in seconds, must be current, and the numeric value is a 32bit float gauge-type value", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Series"]}}, "/query"=>{"get"=>{"summary"=>"Get Query", "description"=>"This end point allows you to query for metrics from any time period.", "operationId"=>"getQuery", "x-api-path-slug"=>"query-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Query"]}}, "/check_run"=>{"post"=>{"summary"=>"Add Check Run", "description"=>"Post a Check Run", "operationId"=>"postCheckRun", "x-api-path-slug"=>"check-run-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Checks", "Run"]}}, "/downtime"=>{"post"=>{"summary"=>"Add Downtime", "description"=>"Schedule monitor downtime", "operationId"=>"postDowntime", "x-api-path-slug"=>"downtime-post", "parameters"=>[{"in"=>"query", "name"=>"period", "description"=>"how often to repeat as an integer", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"the type of recurrence", "type"=>"string"}, {"in"=>"query", "name"=>"until_date", "description"=>"(optional) the date at which the recurrence should end as a POSIX timestmap", "type"=>"string"}, {"in"=>"query", "name"=>"until_occurrences", "description"=>"(optional) how many times the downtime will be rescheduled", "type"=>"string"}, {"in"=>"query", "name"=>"week_days", "description"=>"(optional) a list of week days to repeat on", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Downtime"]}, "get"=>{"summary"=>"Get Downtime", "description"=>"Get all monitor downtimes", "operationId"=>"getDowntime", "x-api-path-slug"=>"downtime-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Downtime"]}}, "/downtime/:downtime_id"=>{"put"=>{"summary"=>"Put Downtime Downtime", "description"=>"Update monitor downtime", "operationId"=>"putDowntimeDowntime", "x-api-path-slug"=>"downtimedowntime-id-put", "parameters"=>[{"in"=>"query", "name"=>"period", "description"=>"how often to repeat as an integer", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"the type of recurrence", "type"=>"string"}, {"in"=>"query", "name"=>"until_date", "description"=>"(optional) the date at which the recurrence should end as a POSIX timestmap", "type"=>"string"}, {"in"=>"query", "name"=>"until_occurrences", "description"=>"(optional) how many times the downtime will be rescheduled", "type"=>"string"}, {"in"=>"query", "name"=>"week_days", "description"=>"(optional) a list of week days to repeat on", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Downtime", "Downtime"]}, "delete"=>{"summary"=>"Delete Downtime Downtime", "description"=>"DELETE downtime downtime", "operationId"=>"deleteDowntimeDowntime", "x-api-path-slug"=>"downtimedowntime-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Downtime", "Downtime"]}, "get"=>{"summary"=>"Get Downtime Downtime", "description"=>"Get a monitor downtime", "operationId"=>"getDowntimeDowntime", "x-api-path-slug"=>"downtimedowntime-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Downtime", "Downtime"]}}, "/screen"=>{"post"=>{"summary"=>"Add Screen", "description"=>"POST screen", "operationId"=>"postScreen", "x-api-path-slug"=>"screen-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Screen"]}, "get"=>{"summary"=>"Get Screen", "description"=>"Fetch all of your screenboards' definitions.", "operationId"=>"getScreen", "x-api-path-slug"=>"screen-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Screen"]}}, "/screen/:board_id"=>{"put"=>{"summary"=>"Put Screen Board", "description"=>"PUT screen board", "operationId"=>"putScreenBoard", "x-api-path-slug"=>"screenboard-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Screen", "Board"]}, "delete"=>{"summary"=>"Delete Screen Board", "description"=>"Delete an existing screenboard.", "operationId"=>"deleteScreenBoard", "x-api-path-slug"=>"screenboard-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Screen", "Board"]}, "get"=>{"summary"=>"Get Screen Board", "description"=>"Fetch an existing screenboard's definition.", "operationId"=>"getScreenBoard", "x-api-path-slug"=>"screenboard-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Screen", "Board"]}}, "/screen/share/:board_id"=>{"get"=>{"summary"=>"Get Screen Share Board", "description"=>"Share an existing screenboard's with a public URL.", "operationId"=>"getScreenShareBoard", "x-api-path-slug"=>"screenshareboard-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Screen", "Share", "Board"]}, "delete"=>{"summary"=>"Delete Screen Share Board", "description"=>"Revoke a currently shared screenboard's.", "operationId"=>"deleteScreenShareBoard", "x-api-path-slug"=>"screenshareboard-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Screen", "Share", "Board"]}}, "/tags/hosts"=>{"get"=>{"summary"=>"Get Tags Hosts", "description"=>"Return a mapping of tags to hosts for your whole infrastructure.", "operationId"=>"getTagsHosts", "x-api-path-slug"=>"tagshosts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Tags", "Hosts"]}}, "/tags/hosts/:host_name"=>{"get"=>{"summary"=>"Get Tags Hosts Host Name", "description"=>"Return the list of tags that apply to a given host.", "operationId"=>"getTagsHostsHostName", "x-api-path-slug"=>"tagshostshost-name-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Tags", "Hosts", "Host", "Name"]}, "post"=>{"summary"=>"Add Tags Hosts Host Name", "description"=>"This end point allows you to add tags to a host.", "operationId"=>"postTagsHostsHostName", "x-api-path-slug"=>"tagshostshost-name-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Tags", "Hosts", "Host", "Name"]}, "put"=>{"summary"=>"Put Tags Hosts Host Name", "description"=>"This end point allows you to update all tags for a given host.", "operationId"=>"putTagsHostsHostName", "x-api-path-slug"=>"tagshostshost-name-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Tags", "Hosts", "Host", "Name"]}, "delete"=>{"summary"=>"Delete Tags Hosts Host Name", "description"=>"This end point allows you to remove all tags for a given host.", "operationId"=>"deleteTagsHostsHostName", "x-api-path-slug"=>"tagshostshost-name-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Tags", "Hosts", "Host", "Name"]}}, "comments"=>{"post"=>{"summary"=>"Add Comments", "description"=>"Comments are essentially special forms of events that\n appear in the stream. They can start a new discussion thread or\n optionally, reply in another thread.", "operationId"=>"postComments", "x-api-path-slug"=>"comments-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Comments"]}}, "comments/:comment_id"=>{"put"=>{"summary"=>"Put Comments Comment", "description"=>"PUT comments comment", "operationId"=>"putCommentsComment", "x-api-path-slug"=>"commentscomment-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Comments", "Comment"]}, "delete"=>{"summary"=>"Delete Comments Comment", "description"=>"DELETE comments comment", "operationId"=>"deleteCommentsComment", "x-api-path-slug"=>"commentscomment-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Comments", "Comment"]}}, "graph/snapshot"=>{"get"=>{"summary"=>"Get Graph Snapshot", "description"=>"GET graph snapshot", "operationId"=>"getGraphSnapshot", "x-api-path-slug"=>"graphsnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"graph_def", "description"=>"can be used instead of metric_query", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Graph", "Snapshot"]}}, "/events"=>{"post"=>{"summary"=>"Add Events", "description"=>"Post an Event", "operationId"=>"postEvents", "x-api-path-slug"=>"events-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Events"]}}, "/events/:event_id"=>{"get"=>{"summary"=>"Get Events Event", "description"=>"GET events event", "operationId"=>"getEventsEvent", "x-api-path-slug"=>"eventsevent-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Events", "Event"]}, "delete"=>{"summary"=>"Delete Events Event", "description"=>"DELETE events event", "operationId"=>"deleteEventsEvent", "x-api-path-slug"=>"eventsevent-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Events", "Event"]}}, "/monitor"=>{"post"=>{"summary"=>"Add Monitor", "description"=>"Create a monitor", "operationId"=>"postMonitor", "x-api-path-slug"=>"monitor-post", "parameters"=>[{"in"=>"query", "name"=>"#", "description"=>"an integer or decimal number used to set the threshold", "type"=>"string"}, {"in"=>"query", "name"=>"change_aggr", "description"=>"change, pct_change", "type"=>"string"}, {"in"=>"query", "name"=>"check", "description"=>"name of the check, e", "type"=>"string"}, {"in"=>"query", "name"=>"count", "description"=>"must be at >= your max threshold (defined in the options)", "type"=>"string"}, {"in"=>"query", "name"=>"escalation_message", "description"=>"a message to include with a re-notification", "type"=>"string"}, {"in"=>"query", "name"=>"event", "description"=>", the event query string: string_query free text query to match against event title and text", "type"=>"string"}, {"in"=>"query", "name"=>"event alert", "type"=>"string"}, {"in"=>"query", "name"=>"excluded_tags", "description"=>"exluded event tags (comma-separated)", "type"=>"string"}, {"in"=>"query", "name"=>"host", "description"=>"event reporting host (comma-separated)", "type"=>"string"}, {"in"=>"query", "name"=>"include_tags", "description"=>"a boolean indicating whether notifications from this monitor will automatically insert its triggering tags into the title", "type"=>"string"}, {"in"=>"query", "name"=>"key", "description"=>"a key in key:value tag syntax; defines a separate alert for each tag in the group (multi-alert)", "type"=>"string"}, {"in"=>"query", "name"=>"last", "description"=>"the timeframe to roll up the counts", "type"=>"string"}, {"in"=>"query", "name"=>"locked", "description"=>"a boolean indicating whether changes to to this monitor should be restricted to the creator or admins", "type"=>"string"}, {"in"=>"query", "name"=>"metric alert", "type"=>"string"}, {"in"=>"query", "name"=>"notify_audit", "description"=>"a boolean indicating whether tagged users will be notified on changes to this monitor", "type"=>"string"}, {"in"=>"query", "name"=>"notify_no_data", "description"=>"a boolean indicating whether this monitor will notify when data stops reporting", "type"=>"string"}, {"in"=>"query", "name"=>"no_data_timeframe", "description"=>"the number of minutes before a monitor will notify when data stops reporting", "type"=>"string"}, {"in"=>"query", "name"=>"operator", "description"=>"<, <=, >, >=, ==, or !=", "type"=>"string"}, {"in"=>"query", "name"=>"priority", "description"=>"event priorities (comma-separated)", "type"=>"string"}, {"in"=>"query", "name"=>"renotify_interval", "description"=>"the number of minutes after the last notification before a monitor will re-notify on the current status", "type"=>"string"}, {"in"=>"query", "name"=>"require_full_window", "description"=>"a boolean indicating whether this monitor needs a full window of data before its evaluated", "type"=>"string"}, {"in"=>"query", "name"=>"role:db", "description"=>"for a short time: {role:db: 1412798116}", "type"=>"string"}, {"in"=>"query", "name"=>"rollup", "description"=>"the stats rollup method", "type"=>"string"}, {"in"=>"query", "name"=>"service check", "type"=>"string"}, {"in"=>"query", "name"=>"silenced", "description"=>"dictionary of scopes to timestamps or None", "type"=>"string"}, {"in"=>"query", "name"=>"sources", "description"=>"event sources (comma-separated)", "type"=>"string"}, {"in"=>"query", "name"=>"space_aggr", "description"=>"avg, sum, min, or max", "type"=>"string"}, {"in"=>"query", "name"=>"status", "description"=>"event statuses (comma-separated)", "type"=>"string"}, {"in"=>"query", "name"=>"tags", "description"=>"one or more tags (comma-separated), or *", "type"=>"string"}, {"in"=>"query", "name"=>"thresholds", "description"=>"a dictionary of thresholds by threshold type", "type"=>"string"}, {"in"=>"query", "name"=>"timeout_h", "description"=>"the number of hours of the monitor not reporting data before it will automatically resolve from a triggered state", "type"=>"string"}, {"in"=>"query", "name"=>"timeshift", "description"=>"#m_ago (5, 10, 15, or 30), #h_ago (1, 2, or 4), or 1d_ago", "type"=>"string"}, {"in"=>"query", "name"=>"time_aggr", "description"=>"avg, sum, max, min", "type"=>"string"}, {"in"=>"query", "name"=>"time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator #", "description"=>"time_aggr avg, sum, max, min, change, or pct_change", "type"=>"string"}, {"in"=>"query", "name"=>"time_window", "description"=>"last_#m (5, 10, 15, or 30), last_#h (1, 2, or 4), or last_1d", "type"=>"string"}, {"in"=>"query", "name"=>"[Triggered] Monitor Title", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Monitor"]}, "get"=>{"summary"=>"Get Monitor", "description"=>"Get all monitor details", "operationId"=>"getMonitor", "x-api-path-slug"=>"monitor-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Monitor"]}}, "/monitor/:monitor_id"=>{"get"=>{"summary"=>"Get Monitor Monitor", "description"=>"GET monitor monitor", "operationId"=>"getMonitorMonitor", "x-api-path-slug"=>"monitormonitor-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Monitor", "Monitor"]}, "put"=>{"summary"=>"Put Monitor Monitor", "description"=>"PUT monitor monitor", "operationId"=>"putMonitorMonitor", "x-api-path-slug"=>"monitormonitor-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Monitor", "Monitor"]}, "delete"=>{"summary"=>"Delete Monitor Monitor", "description"=>"DELETE monitor monitor", "operationId"=>"deleteMonitorMonitor", "x-api-path-slug"=>"monitormonitor-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Monitor", "Monitor"]}}, "/monitor/mute_all"=>{"post"=>{"summary"=>"Add Monitor Mute All", "description"=>"Muting will prevent all monitors from notifying through email and posts\n to the event stream. State changes will only be visible by checking\n the alert page.", "operationId"=>"postMonitorMuteAll", "x-api-path-slug"=>"monitormute-all-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Monitor", "Mute", "All"]}}, "/monitor/unmute_all"=>{"post"=>{"summary"=>"Add Monitor Unmute All", "description"=>"Disables muting all monitors. Throws an error if mute all was\n not enabled previously.", "operationId"=>"postMonitorUnmuteAll", "x-api-path-slug"=>"monitorunmute-all-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Monitor", "Unmute", "All"]}}, "/monitor/:monitor_id/mute"=>{"post"=>{"summary"=>"Add Monitor Monitor Mute", "description"=>"POST monitor monitor mute", "operationId"=>"postMonitorMonitorMute", "x-api-path-slug"=>"monitormonitor-idmute-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Monitor", "Monitor", "", "Mute"]}}, "/dash"=>{"post"=>{"summary"=>"Add Dash", "description"=>"Create a Timeboard", "operationId"=>"postDash", "x-api-path-slug"=>"dash-post", "parameters"=>[{"in"=>"query", "name"=>"{requests: [{q: system.cpu.idle{} by {host}}", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Dash"]}, "get"=>{"summary"=>"Get Dash", "description"=>"Get all Timeboards", "operationId"=>"getDash", "x-api-path-slug"=>"dash-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Dash"]}}, "/dash/:dash_id"=>{"put"=>{"summary"=>"Put Dash Dash", "description"=>"Update a Timeboard", "operationId"=>"putDashDash", "x-api-path-slug"=>"dashdash-id-put", "parameters"=>[{"in"=>"query", "name"=>"{requests: [{q: system.cpu.idle{} by {host}}", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Dash", "Dash"]}, "delete"=>{"summary"=>"Delete Dash Dash", "description"=>"Delete a Timeboard", "operationId"=>"deleteDashDash", "x-api-path-slug"=>"dashdash-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Dash", "Dash"]}}, "user"=>{"post"=>{"summary"=>"Add User", "description"=>"POST user", "operationId"=>"postUser", "x-api-path-slug"=>"user-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User"]}, "get"=>{"summary"=>"Get User", "description"=>"GET user", "operationId"=>"getUser", "x-api-path-slug"=>"user-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User"]}}, "user/:handle"=>{"get"=>{"summary"=>"Get User Handle", "description"=>"GET user handle", "operationId"=>"getUserHandle", "x-api-path-slug"=>"userhandle-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User", "Handle"]}, "put"=>{"summary"=>"Put User Handle", "description"=>"Can only be used with application keys belonging to administrators.", "operationId"=>"putUserHandle", "x-api-path-slug"=>"userhandle-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User", "Handle"]}}, "graph/embed"=>{"get"=>{"summary"=>"Get Graph Embed", "description"=>"Gets a list of previously created embeddable graphs.", "operationId"=>"getGraphEmbed", "x-api-path-slug"=>"graphembed-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Graph", "Embed"]}, "post"=>{"summary"=>"Add Graph Embed", "description"=>"Creates a new embeddable graph.", "operationId"=>"postGraphEmbed", "x-api-path-slug"=>"graphembed-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Graph", "Embed"]}}, "graph/embed/:embed_id"=>{"get"=>{"summary"=>"Get Graph Embed Embed", "description"=>"Get the HTML fragment for a previously generated embed with embed_id.", "operationId"=>"getGraphEmbedEmbed", "x-api-path-slug"=>"graphembedembed-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Graph", "Embed", "Embed"]}}, "graph/embed/:embed_id/enable"=>{"get"=>{"summary"=>"Get Graph Embed Embed Enable", "description"=>"Enable a specified embed.", "operationId"=>"getGraphEmbedEmbedEnable", "x-api-path-slug"=>"graphembedembed-idenable-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Graph", "Embed", "Embed", "", "Enable"]}}}}, "apis"=>{"name"=>"Datadog", "x-slug"=>"datadog", "description"=>"See inside any stack, any app, at any scale, anywhere.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/22961-datadog.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"13593", "tags"=>"Aggregation,API Provider,API Service Provider,Monitoring,Orchestration,Performance,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"datadog/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"DataDog API", "x-api-slug"=>"datadog-api", "description"=>"See inside any stack, any app, at any scale, anywhere.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/22961-datadog.jpg", "humanURL"=>"https://www.datadoghq.com/", "baseURL"=>"https:///api/v1/", "tags"=>"Aggregation,API Provider,API Service Provider,Monitoring,Orchestration,Performance,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/datadog/datadog-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://www.datadoghq.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"https://www.datadoghq.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/datadog"}, {"type"=>"x-email", "url"=>"info@datadoghq.com"}, {"type"=>"x-email", "url"=>"help@datadoghq.com"}, {"type"=>"x-email", "url"=>"legalcompliance@datadoghq.com"}, {"type"=>"x-email", "url"=>"legal@datadoghq.com"}, {"type"=>"x-email", "url"=>"iwant@datadoghq.com"}, {"type"=>"x-github", "url"=>"https://github.com/datadog"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/datadoghq"}, {"type"=>"x-integrations", "url"=>"https://www.datadoghq.com/product/integrations/"}, {"type"=>"x-pricing", "url"=>"https://www.datadoghq.com/pricing/"}, {"type"=>"x-security", "url"=>"https://www.datadoghq.com/security/"}, {"type"=>"x-website", "url"=>"https://www.datadoghq.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
mynewsdesk{"my-news-desk-pressroom-list-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Mynewsdesk", "x-complete"=>1, "info"=>{"title"=>"My News Desk Pressroom List", "description"=>"mynewsdesk-webservice-for-newsroom-is-a-way-for-you-as-a-registered-customer-to-fetch-information-from-your-newsroom-at-mynewsdesk-to-any-system--you-can-get-all-your-information-as-xml-and-create-email-subscriptions-to-your-material-", "termsOfService"=>"http://www.mynewsdesk.com/about/terms-and-conditions?locale=en", "version"=>"v1"}, "host"=>"www.mynewsdesk.com", "basePath"=>"/services/pressroom/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"create_comment/"=>{"get"=>{"summary"=>"Create Comment", "description"=>"Create Comment", "operationId"=>"getCreateComment", "x-api-path-slug"=>"create-comment-get", "parameters"=>[{"in"=>"query", "name"=>"blog", "description"=>"URL of commenters blog/website"}, {"in"=>"query", "name"=>"body", "description"=>"Content of comment"}, {"in"=>"query", "name"=>"commentable_id", "description"=>"ID of the material that is commented"}, {"in"=>"query", "name"=>"email", "description"=>"Email address of commenter"}, {"in"=>"query", "name"=>"name", "description"=>"Name of commenter"}, {"in"=>"query", "name"=>"type_of_media", "description"=>"Type of material"}, {"in"=>"path", "name"=>"unique key", "description"=>"The MyNewsDesk API Key"}, {"in"=>"query", "name"=>"user_ip", "description"=>"IP number of commenter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment"]}}, "list/"=>{"get"=>{"summary"=>"Lists news", "description"=>"Lists news", "operationId"=>"getList", "x-api-path-slug"=>"list-get", "parameters"=>[{"in"=>"query", "name"=>"archived", "description"=>"Fetch items marked as archived, this is useful for fetching old events"}, {"in"=>"query", "name"=>"callback", "description"=>"If format is JSON and callback is specified, the JSON response is wrapped in a function call with the specified callback name"}, {"in"=>"query", "name"=>"format", "description"=>"Specify the format of the response: RSS 2"}, {"in"=>"query", "name"=>"limit", "description"=>"Set the maximum number of items in the response"}, {"in"=>"query", "name"=>"offset", "description"=>"Specify which item (sequentially) should be first, skipping preceding items"}, {"in"=>"query", "name"=>"order", "description"=>"Specify the sort order of the result: publish date (published), latest update (updated) or creation date (created)"}, {"in"=>"query", "name"=>"pressroom", "description"=>"Set the pressroom to fetch material from"}, {"in"=>"query", "name"=>"type_of_media", "description"=>"Fetch material of this type only"}, {"in"=>"path", "name"=>"unique key", "description"=>"The MyNewsDesk API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News"]}}, "pressroom_info/"=>{"get"=>{"summary"=>"Pressroom Info", "description"=>"Pressroom Info", "operationId"=>"getPressroomInfo", "x-api-path-slug"=>"pressroom-info-get", "parameters"=>[{"in"=>"query", "name"=>"pressroom", "description"=>"Set the pressroom to search in"}, {"in"=>"path", "name"=>"unique key", "description"=>"The MyNewsDesk API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Pressroom", "Info"]}}, "search/"=>{"get"=>{"summary"=>"News Search", "description"=>"News Search", "operationId"=>"getSearch", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"If format is JSON and callback is specified, the JSON response is wrapped in a function call with the specified callback name"}, {"in"=>"query", "name"=>"date_end", "description"=>"End date"}, {"in"=>"query", "name"=>"date_mode", "description"=>"Specifies how the date parameters are used"}, {"in"=>"query", "name"=>"date_on", "description"=>"Date"}, {"in"=>"query", "name"=>"date_start", "description"=>"Start date"}, {"in"=>"query", "name"=>"format", "description"=>"Specify the format of the response: RSS 2"}, {"in"=>"query", "name"=>"limit", "description"=>"Set the maximum number of items in the response"}, {"in"=>"query", "name"=>"page", "description"=>"Page number in the search result"}, {"in"=>"query", "name"=>"pressroom", "description"=>"Set the pressroom to search in"}, {"in"=>"query", "name"=>"query", "description"=>"Search string"}, {"in"=>"query", "name"=>"type_of_media", "description"=>"The type of material to be fetched"}, {"in"=>"path", "name"=>"unique key", "description"=>"The MyNewsDesk API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Search"]}}, "send_email/"=>{"get"=>{"summary"=>"Send Email", "description"=>"Send Email", "operationId"=>"getSendEmail", "x-api-path-slug"=>"send-email-get", "parameters"=>[{"in"=>"query", "name"=>"from", "description"=>"Name of sender"}, {"in"=>"query", "name"=>"item_id", "description"=>"ID of the material to be fetched"}, {"in"=>"query", "name"=>"message", "description"=>"Personal message from the sender to the recipient"}, {"in"=>"query", "name"=>"to_email", "description"=>"Recipient email address"}, {"in"=>"query", "name"=>"type_of_media", "description"=>"The type of material to be fetched"}, {"in"=>"path", "name"=>"unique key", "description"=>"The MyNewsDesk API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Email"]}}, "subscription/"=>{"get"=>{"summary"=>"News Subscription", "description"=>"News Subscription", "operationId"=>"getSubscription", "x-api-path-slug"=>"subscription-get", "parameters"=>[{"in"=>"query", "name"=>"newsdesk_pressroom", "description"=>"Set the pressroom to search in"}, {"in"=>"query", "name"=>"newsdesk_subscriber_email", "description"=>"Email address of the subscriber"}, {"in"=>"query", "name"=>"newsdesk_subscribe_to_type", "description"=>"Send a parameter with the value 1 for each type of material to be included in the subscription"}, {"in"=>"query", "name"=>"unique key", "description"=>"The MyNewsDesk API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["News", "Subscription"]}}, "view/"=>{"get"=>{"summary"=>"View News", "description"=>"View News", "operationId"=>"getView", "x-api-path-slug"=>"view-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"If format is JSON and callback is specified, the JSON response is wrapped in a function call with the specified callback name"}, {"in"=>"query", "name"=>"format", "description"=>"Specify the format of the response: JSON or full XML"}, {"in"=>"query", "name"=>"item_id", "description"=>"ID of the material to be fetched"}, {"in"=>"query", "name"=>"type_of_media", "description"=>"The type of material to be fetched"}, {"in"=>"path", "name"=>"unique key", "description"=>"The MyNewsDesk API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "News"]}}}}, "apis"=>{"name"=>"Mynewsdesk", "x-slug"=>"mynewsdesk", "description"=>"Discover the impact of Digital PR! Monitor what is being said about your brand, create your story, identify and engage your audience and analyze the results", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11441-mynewsdesk.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"26576", "tags"=>"API Provider,General Data,News,News,News API,Profiles,Public relations,Relative Data,SaaS,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"mynewsdesk/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"My News Desk Pressroom List", "x-api-slug"=>"my-news-desk-pressroom-list", "description"=>"Discover the impact of Digital PR! Monitor what is being said about your brand, create your story, identify and engage your audience and analyze the results", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11441-mynewsdesk.jpg", "humanURL"=>"http://www.mynewsdesk.com", "baseURL"=>"https://www.mynewsdesk.com//services/pressroom/", "tags"=>"API Provider,General Data,News,News,News API,Profiles,Public relations,Relative Data,SaaS,Service API,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/mynewsdesk/view-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/mynewsdesk/my-news-desk-pressroom-list-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://www.mynewsdesk.com/services/"}, {"type"=>"x-blog", "url"=>"http://www.mynewsdesk.com/us/mynewsdesk/blog_posts"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/mynewsdesk"}, {"type"=>"x-developer", "url"=>"http://www.mynewsdesk.com/docs"}, {"type"=>"x-documentation", "url"=>"http://www.mynewsdesk.com/docs/webservice_pressroom"}, {"type"=>"x-github", "url"=>"https://github.com/mynewsdesk"}, {"type"=>"x-terms-of-service", "url"=>"http://www.mynewsdesk.com/about/terms-and-conditions?locale=en"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/mynewsdesk"}, {"type"=>"x-website", "url"=>"http://www.mynewsdesk.com"}, {"type"=>"x-website", "url"=>"http://mynewsdesk.com"}, {"type"=>"x-widget-builder", "url"=>"http://www.mynewsdesk.com/us/widget/settings"}, {"type"=>"x-wikipedia-", "url"=>"http://en.wikipedia.org/wiki/Mynewsdesk"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ship-station{"ship-station-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Ship Station", "x-complete"=>1, "info"=>{"title"=>"Ship Station Developer Portal", "description"=>"-integrating-with-shipstationshipstation-strives-to-streamline-shipping-for-online-sellers-no-matter-where-they-sell-their-products-online--we-are-continuously-adding-new-marketplaces-shopping-carts-and-integration-tools-because-we-know-the-ecommerce-space-is-growing--as-a-result-weve-worked-hard-to-provide-developer-resources-to-build-custom-integrations-with-shipstation---if-youre-interested-in-becoming-a-partner-of-ours-drop-us-a-line-by-filling-out-this-formhttpwww-shipstation-compartnersshipstationapicustomstore-and-well-get-in-touch-there-are-two-methods-to-integrate-with-shipstation-custom-store-integration-shipstation-api-custom-store-integrationlooking-for-a-more-1to1-relationship-between-shipstation-and-your-chosen-selling-platform-the-custom-store-integration-is-the-ticket--our-custom-store-integration-is-just-like-any-of-our-other-selling-channel-integration-and-could-be-eligible-based-on-internal-review-as-a-branded-option-within-the-shipstation-admin--it-also-allows-the-user-to-sync-orders-within-shipstation-in-a-single-click-in-addition-to-shipstation-automatically-sending-shipment-status-and-tracking-information-updates-back-to-your-cart-or-marketplace-once-a-label-is-created--its-the-best-way-to-sync-up-orders-with-shipstation-and-have-the-most-seamless-experience-the-custom-store-allows-you-to-perform-two-major-functions-provide-order-information-to-shipstation-including-recipient-address-products-customers-etc--receive-tracking-information-when-an-order-is-shipped-including-shipping-method-shipping-status-tracking-number-and-moreto-integrate-with-the-custom-store-you-must-expose-a-web-page-that-renders-xml-that-adheres-to-the-specification-defined-in-the-custom-store-integration-guide--we-refer-to-this-page-as-your-xml-endpoint--if-you-can-provide-us-an-xml-endpoint-we-can-pull-data-from-your-endpoint-just-like-we-do-with-other-marketplaces-like-ebay-and-amazon-to-find-out-more-about-our-custom-store-integration-click-here-custom-store-integration-guidehttpshelp-shipstation-comhcenusarticles205928478-shipstation-apiour-api-is-available-for-any-plan-and-allows-for-read-access-to-almost-all-data-in-your-account-and-write-access-to-create-specific-objects-like-orders-customers-and-products--the-api-is-a-great-way-to-get-data-directly-to-and-from-shipstation-like-creating-products-customers-and-querying-order-shipping-data--please-note-that-an-api-integration-will-not-allow-you-to-use-your-own-marketplaceid-that-could-eventually-be-branded-with-your-companys-logo-see-the-custom-store-integration-above-for-that-functionality-this-api-allows-developers-to-build-applications-that-interface-with-the-shipstation-platform--the-api-can-be-used-to-automate-many-tasks-including-managing-orders-managing-shipments-creating-shipping-labels-retrieving-shipping-rates-and-moreto-learn-more-about-our-api-please-review-our-api-documentation-below--which-one-should-i-pickthe-method-thats-right-for-your-integration-very-much-depends-on-the-type-of-integration-youre-planning-on-implementing--a-custom-store-allows-shipstation-to-pull-order-information-from-your-platform-the-very-same-way-we-pull-data-from-marketplaces-such-as-ebay-amazon-and-shopify--once-an-order-has-been-shipped-in-shipstation-shipstation-automatically-pushes-tracking-information-back-to-your-custom-store--though-the-functionality-afforded-by-this-approach-is-limited-to-these-2-main-functions-much-of-the-heavy-lifting-is-performed-by-shipstation--importing-orders-and-sending-tracking-information-is-performed-automatically-by-shipstation-as-long-as-your-xml-endpoint-is-available-to-receive-our-data-an-api-integration-on-the-other-hand-exposes-much-more-functionality-but-requires-that-the-developer-do-much-of-the-heavy-lifting--orders-must-be-pushed-to-shipstation-by-using-our-orderscreateorder-endpoint---the-api-allows-developers-to-perform-functions-such-as-tagging-an-order-shipping-an-order-creating-a-shipping-label-without-an-order-retrieving-shipping-rates-adding-funds-to-a-carrier-account-creating-a-warehouse-listing-products-and-much-more---the-functionality-the-api-affords-are-typical-actions-that-a-user-would-perform-if-using-the-web-app--considerations-will-your-integration-be-the-main-order-management-tool-for-the-online-seller--if-so-the-apis-broader-range-of-functionality-may-be-the-best-option--would-you-like-your-store-integration-to-be-a-branded-marketplace-within-the-shipstation-admin-when-you-integrate-using-the-custom-store-integration-you-could-be-eligible-to-have-your-company-branded-within-the-shipstation-admin--a-branded-store-could-have-the-plugins-logo-in-the-appas-well-as-an-easier-store-setup-order-sync-and-reporting--please-note-shipstation-makes-the-final-decision-based-on-integration-and-partner-requirements-on-which-custom-stores-are-branded-within-our-application--shipstation-api-requirements-end-pointendpoints-are-located-at-the-following-domain-httpsssapi-shipstation-com-and-will-need-to-have-a-specific-reference-added-to-return-data--please-note-you-cannot-access-this-url-directly-and-must-reference-one-of-the-specific-endpoints-below--authenticationthe-shipstation-api-uses-basic-http-authenticationhttpen-wikipedia-orgwikibasic-access-authentication--use-your-shipstation-api-key-as-the-username-and-api-secret-as-the-password---you-can-find-your-api-key-as-the-username-and-api-secret-under-settings-at-httpsss-shipstation-comsettingsapi--the-authorization-header-is-constructed-as-follows-username-api-key-and-password-api-secret-are-combined-into-a-string-usernamepassword-the-resulting-string-is-then-encoded-using-the-rfc2045mime-variant-of-base64-except-not-limited-to-76-charline-the-authorization-method-and-a-space-i-e--basic--is-then-put-before-the-encoded-string-for-example-if-the-api-key-given-is-shipstation-and-the-api-secret-is-rocks-then-the-header-is-formed-as-follows-authorization-basic-u2hpcfn0yxrpb246um9ja3m-api-rate-limitsin-an-effort-to-ensure-consistent-application-performance-and-increased-scalability-we-have-implemented-rate-limiting-on-the-shipstation-api---your-integration-will-need-to-be-able-to-handle-http-rate-limiting-status-messages-as-defined-belowresponse-headersall-responses-will-include-headers-with-status-information-about-rate-limiting-1--xratelimitlimit-the-maximum-number-of-requests-per-minute-to-the-endpoint2--xratelimitremaining-the-available-requests-remaining-in-the-current-window3--xratelimitreset-the-number-of-seconds-remaining-until-the-next-window-beginshitting-the-limitif-your-application-hits-the-rate-limit-an-http-429-will-be-returned-with-this-body----message-too-many-requestsand-these-headers-assuming-it-is-40-seconds-into-the-current-window----xratelimitlimit-60----xratelimitremaining-0----xratelimitreset-20when-the-limit-is-reached-your-application-should-stop-making-requests-until-xratelimitreset-seconds-have-elapsed--the-current-rate-limit-for-each-set-of-the-api-key-and-secret-is-40-requests-per-minute-if-you-have-any-issues-with-the-api-please-email-us-at-apisupportshipstation-com-server-responsesstatus-code--description200--ok--the-request-was-successful-some-api-calls-may-return-201-instead-201--created--the-request-was-successful-and-a-resource-was-created-204--no-content--the-request-was-successful-but-there-is-no-representation-to-return-that-is-the-response-is-empty-400--bad-request---the-request-could-not-be-understood-or-was-missing-required-parameters-401--unauthorized---authentication-failed-or-user-does-not-have-permissions-for-the-requested-operation-403--forbidden--access-denied-404--not-found---resource-was-not-found-405--method-not-allowed---requested-method-is-not-supported-for-the-specified-resource-429--too-many-requests--exceeded-shipstation-api-limits--when-the-limit-is-reached-your-application-should-stop-making-requests-until-xratelimitreset-seconds-have-elapsed-500--internal-server-error--shipstation-has-encountered-an-error--datetime-format-and-time-zoneshipstation-uses-the-iso-8601-combined-format-for-datetime-stamps-being-submitted-to-and-returned-from-the-api--please-be-sure-to-submit-all-datetime-values-as-followsyyyymmdd-hhmmss-24-hour-notation--example--20161129-235959the-time-zone-represented-in-all-api-responses-is-pstpdt--similarly-shipstation-asks-that-you-make-all-time-zone-convertions-and-submit-any-datetime-requests-in-pstpdt-", "version"=>"1.0.0"}, "host"=>"ssapi.shipstation.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/accounts/listtags"=>{"get"=>{"summary"=>"List Tags", "description"=>"Lists all tags defined for this account.", "operationId"=>"accounts.listtags.get", "x-api-path-slug"=>"accountslisttags-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Tags"]}}, "/accounts/registeraccount"=>{"post"=>{"summary"=>"Register Account", "description"=>"Creates a new ShipStation account and generates an apiKey and apiSecret to be used by the newly created account. PLEASE NOTE: This endpoint does not require API key and API Secret credentials. The Authorization header can be left off. Use of this specific endpoint requires approval, and is meant only for direct partners of ShipStation. This is the only endpoint to require approval. All other endpoints listed in this document can be accessed by submitting proper authorization credentials in the header of the request. To become a direct partner of ShipStation, or to request more information on becoming a direct partner, we recommend reaching out to our Partners and Integrations team here: https://info.shipstation.com/become-a-partner-api-and-custom-store-integrations\n\nThe body of this request has the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``firstName`` | string, required | First Name\n``lastName`` | string, required | Last Name\n``email`` | string, required | Email address. This will also be the username of the account.\n``password`` | string, required | Password to set for account access.\n``companyName`` | string, optional | Name of Company.\n``addr1`` | string, optional | Company Address - Street 1\n``addr2`` | string, optional | Company Address - Street 2\n``city`` | string, optional | Company Address - City\n``state`` | string, optional | Company Address - State \n``zip`` | string, optional | Company Address - Zip Code\n``countryCode`` |string, optional | Company Address - Country. Please use a 2-character country code.\n``phone`` | string, optional | Company Phone number.", "operationId"=>"accounts.registeraccount.post", "x-api-path-slug"=>"accountsregisteraccount-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "Account"]}}, "/carriers"=>{"get"=>{"summary"=>"List Carriers", "description"=>"Lists all shipping providers connected to this account.", "operationId"=>"carriers.get", "x-api-path-slug"=>"carriers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Carriers"]}}, "/carriers/addfunds"=>{"post"=>{"summary"=>"Add Funds", "description"=>"Adds funds to a carrier account using the payment information on file. The body of this request should specify the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n ``carrierCode`` | string, required | The carrier to add funds to.\n ``amount`` | number, required | The dollar amount to add to the account. The minimum value that can be added is $10.00. The maximum value is $10,000.00.", "operationId"=>"carriers.addfunds.post", "x-api-path-slug"=>"carriersaddfunds-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Funds"]}}, "/carriers/getcarrier?carrierCode={carrierCode}"=>{"get"=>{"summary"=>"Get Carrier", "description"=>"Retrieves the shipping carrier account details for the specified carrierCode. Use this method to determine a carrier's account balance.", "operationId"=>"carriers.getcarrier_carrierCode_carrierCode.get", "x-api-path-slug"=>"carriersgetcarriercarriercodecarriercode-get", "parameters"=>[{"in"=>"path", "name"=>"carrierCode", "description"=>"The code for the carrier account to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Carrier"]}}, "/carriers/listpackages?carrierCode={carrierCode}"=>{"get"=>{"summary"=>"List Packages", "description"=>"Retrieves a list of packages for the specified carrier", "operationId"=>"carriers.listpackages_carrierCode_carrierCode.get", "x-api-path-slug"=>"carrierslistpackagescarriercodecarriercode-get", "parameters"=>[{"in"=>"path", "name"=>"carrierCode", "description"=>"The carriers code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Packages"]}}, "/carriers/listservices?carrierCode={carrierCode}"=>{"get"=>{"summary"=>"List Services", "description"=>"Retrieves the list of available shipping services provided by the specified carrier", "operationId"=>"carriers.listservices_carrierCode_carrierCode.get", "x-api-path-slug"=>"carrierslistservicescarriercodecarriercode-get", "parameters"=>[{"in"=>"path", "name"=>"carrierCode", "description"=>"The carriers code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Services"]}}, "/customers/{customerId}"=>{"get"=>{"summary"=>"Get Customer", "description"=>"", "operationId"=>"customers.customerId.get", "x-api-path-slug"=>"customerscustomerid-get", "parameters"=>[{"in"=>"path", "name"=>"customerId", "description"=>"The system generated identifier for the Customer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer"]}}, "/customers?stateCode={stateCode}&countryCode={countryCode}&tagId={tagId}&marketplaceId={marketplaceId}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}"=>{"get"=>{"summary"=>"List Customers", "description"=>"Obtains a list of customers that match the specified criteria.", "operationId"=>"customers_stateCode_stateCode_countryCode_countryCode_tagId_tagId_marketplaceId_marketplaceId_sortBy", "x-api-path-slug"=>"customersstatecodestatecodecountrycodecountrycodetagidtagidmarketplaceidmarketplaceidsortbysortbysortdirsortdirpagepagepagesizepagesize-get", "parameters"=>[{"in"=>"path", "name"=>"countryCode", "description"=>"Returns customers that reside in the specified countryCode"}, {"in"=>"path", "name"=>"marketplaceId", "description"=>"Returns customers that purchased items from the specified marketplaceId"}, {"in"=>"path", "name"=>"page", "description"=>"Page number"}, {"in"=>"path", "name"=>"pageSize", "description"=>"Requested page size"}, {"in"=>"path", "name"=>"sortBy", "description"=>"Sorts the order of the response based off the specified value"}, {"in"=>"path", "name"=>"sortDir", "description"=>"Sets the direction of the sort order"}, {"in"=>"path", "name"=>"stateCode", "description"=>"Returns customers that reside in the specified stateCode"}, {"in"=>"path", "name"=>"tagId", "description"=>"Returns customers that have been tagged with the specified tagId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Customers"]}}, "/fulfillments"=>{"get"=>{"summary"=>"List Fulfillments w/o parameters", "description"=>"", "operationId"=>"fulfillments.get", "x-api-path-slug"=>"fulfillments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Fulfillments", "W", "O", "Parameters"]}}, "/fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDa"=>{"get"=>{"summary"=>"List Fulfillments with parameters", "description"=>"Obtains a list of fulfillments that match the specified criteria. Please note the following:\n\n- Orders that have been marked as shipped either through the UI or the API will appear in the response as they are considered fulfillments.\n\nAll of the available filters are optional. They do not need to be included in the URL. If you do include them, here's what the URL may look like:\n\nUrl format with filters:\n\n```\nfulfillments?fulfillmentId={fulfillmentId}\n&orderId={orderId}\n&orderNumber={orderNumber}\n&trackingNumber={trackingNumber}\n&recipientName={recipientName}\n&createDateStart={createDateStart}\n&createDateEnd={createDateEnd}\n&shipDateStart={shipDateStart}\n&shipDateEnd={shipDateEnd}\n&sortBy={sortBy}\n&sortDir={sortDir}\n&page={page}\n&pageSize={pageSize}\n```", "operationId"=>"fulfillments_fulfillmentId_fulfillmentId_orderId_orderId_orderNumber_orderNumber_trackingNumber_trac", "x-api-path-slug"=>"fulfillmentsfulfillmentidfulfillmentidorderidorderidordernumberordernumbertrackingnumbertrackingnumberrecipientnamerecipientnamecreatedatestartcreatedatestartcreatedateendcreatedateendshipdatestartshipdatestartshipda-get", "parameters"=>[{"in"=>"path", "name"=>"createDateEnd", "description"=>"Returns fulfillments created on or before the specified ``createDate``"}, {"in"=>"path", "name"=>"createDateStart", "description"=>"Returns fulfillments created on or after the specified ``createDate``"}, {"in"=>"path", "name"=>"fulfillmentId", "description"=>"Returns the fulfillment with the specified fulfillment ID"}, {"in"=>"path", "name"=>"orderId", "description"=>"Returns fulfillments whose orders have the specified order ID"}, {"in"=>"path", "name"=>"orderNumber", "description"=>"Returns fulfillments whose orders have the specified order number"}, {"in"=>"path", "name"=>"page", "description"=>"page number"}, {"in"=>"path", "name"=>"pageSize", "description"=>"page size"}, {"in"=>"path", "name"=>"recipientName", "description"=>"Returns fulfillments shipped to the specified recipient name"}, {"in"=>"path", "name"=>"shipDateEnd", "description"=>"Returns fulfillments with the ``shipDate`` on or before the specified date"}, {"in"=>"path", "name"=>"shipDateStart", "description"=>"Returns fulfillments with the ``shipDate`` on or after the specified date"}, {"in"=>"path", "name"=>"sortBy", "description"=>"Sort the responses by a set value"}, {"in"=>"path", "name"=>"sortDir", "description"=>"Sets the direction of the sort order"}, {"in"=>"path", "name"=>"trackingNumber", "description"=>"Returns fulfillments with the specified tracking number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Fulfillments", "Parameters"]}}, "/orders"=>{"get"=>{"summary"=>"List Orders w/o parameters", "description"=>"", "operationId"=>"orders.get", "x-api-path-slug"=>"orders-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Orders", "W", "O", "Parameters"]}}, "/orders/addtag"=>{"post"=>{"summary"=>"Add Tag to Order", "description"=>"Adds a tag to an order. The body of this request should specify the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderId`` | number, required | Identifies the order that will be tagged.\n``tagId`` | number, required | Identifies the tag that will be applied to the order.", "operationId"=>"orders.addtag.post", "x-api-path-slug"=>"ordersaddtag-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tag", "To", "Order"]}}, "/orders/assignuser"=>{"post"=>{"summary"=>"Assign User to Order", "description"=>"Assigns a user to an order. The body of this request should specify the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderIds`` | number, required | Identifies set of orders that will be assigned the user. Please note that if ANY of the orders within the array are not found, no orders will have a user assigned to them.\n``userId`` | number, required | Identifies the user that will be applied to the orders. It should contain a GUID of the user to be assigned to the array of orders.", "operationId"=>"orders.assignuser.post", "x-api-path-slug"=>"ordersassignuser-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assign", "User", "To", "Order"]}}, "/orders/createlabelfororder"=>{"post"=>{"summary"=>"Create Label for Order", "description"=>"Creates a shipping label for a given order. The ``labelData`` field returned in the response is a base64 encoded PDF value. Simply decode and save the output as a PDF file to retrieve a printable label. The body of this request should specify the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderId`` | number, required | Identifies the order that will be shipped.\n``carrierCode`` | string, required | The code for the carrier that is to be used for the label.\n``serviceCode`` | string, required | The code for the shipping service that is to be used for the label.\n``confirmation`` | string, required | The type of delivery confirmation that is to be used once the shipment is created. Possible values: ``none``, ``delivery``, ``signature``, ``adult_signature``, and ``direct_signature``. ``direct_signature`` is available for FedEx only.\n``shipDate`` | string, required | The date the order should be shipped.\n``weight`` | Weight, optional | Weight of the order. Use the [**Weight**](http://www.shipstation.com/developer-api/#/reference/model-weight) model.\n``dimensions`` | Dimensions, optional | Dimensions of the order. Use [**Dimensions**](http://www.shipstation.com/developer-api/#/reference/model-dimensions) model.\n``insuranceOptions`` | InsuranceOptions, optional | The shipping insurance information associated with this label. Use the [**InsuranceOptions**](http://www.shipstation.com/developer-api/#/reference/model-insuranceoptions) model.\n``internationalOptions`` | InternationalOptions, optional | Customs information that can be used to generate customs documents for international orders. Use the [**InternationalOptions**](http://www.shipstation.com/developer-api/#/reference/model-internationaloptions) model.\n``advancedOptions`` | AdvancedOptions, optional | Various advanced options that may be available depending on the shipping carrier that is used to ship the order. Use the Customs information that can be used to generate customs documents for international orders. Use the [**AdvancedOptions**](http://www.shipstation.com/developer-api/#/reference/model-advancedoptions) model.\n``testLabel`` | boolean, required | Specifies whether a test label should be created.", "operationId"=>"orders.createlabelfororder.post", "x-api-path-slug"=>"orderscreatelabelfororder-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["LabelOrder"]}}, "/orders/createorder"=>{"post"=>{"summary"=>"Create/Update Order", "description"=>"If the ``orderKey`` is specified, the method becomes idempotent and the existing order with that key will be updated. Note: Only orders in an open status in ShipStation (``awaiting_payment``,``awaiting_shipment``, and ``on_hold``) can be updated through this method. ``cancelled`` and ``shipped`` are locked from modification through the API. The body of this request should specify an [**Order**](https://www.shipstation.com/developer-api/#/reference/model-order) object:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderNumber`` | string, required | A user-defined order number used to identify an order.\n``orderKey`` | string, optional | A user-provided key that should be unique to each order. If an orderKey is not provided, ShipStation will create a new order and generate a unique orderKey for that order. If the orderKey *is* provided, the **createorder** method will either: create a new order if the provided orderKey is not found, or, update the existing order if the orderKey is found.\n``orderDate`` | string, required | The date the order was placed.\n``paymentDate`` | string, optional | The date the order was paid for.\n``shipByDate`` | string, optional | The date the order is to be shipped before or on. This field is a suggested value generated by the order source/platform/cart and passed to ShipStation.\n``orderStatus`` | string, required | The order's status. Possible values: ``awaiting_payment``, ``awaiting_shipment``, ``shipped``, ``on_hold``, ``cancelled``\n``customerUsername`` | string, optional | The customer's username.\n``customerEmail`` | string, optional | The customer's email address.\n``billTo`` | Address, required | The recipients billing address. Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.\n``shipTo`` | Address, required | The recipient's shipping address. Use the [**Address**](http://www.shipstation.com/developer-api/#/reference/model-address) model.\n``items`` | OrderItem, optional | An array of item objects. Use an array of [**OrderItem**](http://www.shipstation.com/developer-api/#/reference/model-orderitem) models.\n``amountPaid`` | number, optional | The total amount paid for the Order.\n``taxAmount`` | number, optional | The total tax amount for the Order.\n``shippingAmount`` | number, optional | Shipping amount paid by the customer, if any.\n``customerNotes`` | string, optional | Notes left by the customer when placing the order.\n``internalNotes`` | string, optional | Private notes that are only visible to the seller.\n``gift`` | boolean, optional | Specifies whether or not this Order is a gift\n``giftMessage`` | string, optional | Gift message left by the customer when placing the order.\n``paymentMethod`` | string, optional | Identifies the shipping service selected by the customer when placing this order.\n``requestedShippingService`` | string, optional |Identifies the shipping service selected by the customer when placing this order. This value is given to ShipStation by the marketplace/cart and helps identify what shipping service the customer selected upon checkout.\n``carrierCode`` | string, optional | The code for the carrier that is to be used(or was used) when this order is shipped(was shipped).\n``serviceCode`` | string, optional | The code for the shipping service that is to be used(or was used) when this order is shipped(was shipped).\n``packageCode`` | string, optional | The code for the package type that is to be used(or was used) when this order is shipped(was shipped).\n``confirmation`` | string, optional | The type of delivery confirmation that is to be used(or was used) when this order is shipped(was shipped). Possible values: ``none``, ``delivery``, ``signature``, ``adult_signature``, and ``direct_signature``. ``direct_signature`` is available for FedEx only. \n``shipDate`` | string, optional | The date the order was shipped.\n``weight`` | Weight, optional | Weight of the order. Use the [**Weight**](http://www.shipstation.com/developer-api/#/reference/model-weight) model.\n``dimensions`` | Dimensions, optional | Dimensions of the order. Use the [**Dimensions**](http://www.shipstation.com/developer-api/#/reference/model-dimensions) model.\n``insuranceOptions`` | InsuranceOptions, optional | The shipping insurance information associated with this order. Use the [**InsuranceOptions**](http://www.shipstation.com/developer-api/#/reference/model-insuranceoptions) model.\n``internationalOptions`` | InternationalOptions, optional | Customs information that can be used to generate customs documents for international orders. Use the [**InternationalOptions**](http://www.shipstation.com/developer-api/#/reference/model-internationaloptions) model.\n``advancedOptions`` | AdvancedOptions, optional | Various advanced options that may be available depending on the shipping carrier that is used to ship the order. Use the [**AdvancedOptions**](http://www.shipstation.com/developer-api/#/reference/model-advancedoptions) model.", "operationId"=>"orders.createorder.post", "x-api-path-slug"=>"orderscreateorder-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order"]}}, "/orders/createorders"=>{"post"=>{"summary"=>"Create/Update Multiple Orders", "description"=>"This endpoint can be used to create or update multiple orders in one request. If the ``orderKey`` is specified in an order, the existing order with that key will be updated. Note: Only orders in an open status in ShipStation (``awaiting_payment``,``awaiting_shipment``, and ``on_hold``) can be updated through this method. ``cancelled`` and ``shipped`` are locked from modification through the API.\n\nData Type |Description\n-------------------|-------------------\nOrder, required | An array of [**Order**](http://www.shipstation.com/developer-api/#/reference/model-order) objects (maximum of 100 per request)", "operationId"=>"orders.createorders.post", "x-api-path-slug"=>"orderscreateorders-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multiple", "Orders"]}}, "/orders/holduntil"=>{"post"=>{"summary"=>"Hold Order Until", "description"=>"This method will change the status of the given order to On Hold until the date specified, when the status will automatically change to Awaiting Shipment.\n\nThe body of this request should specify the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderId`` | number, required | Identifies the order that will be held.\n``holdUntilDate`` | string, required | Date when order is moved from ``on_hold`` status to ``awaiting_shipment``.", "operationId"=>"orders.holduntil.post", "x-api-path-slug"=>"ordersholduntil-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hold", "Order", "Until"]}}, "/orders/listbytag?orderStatus={orderStatus}&tagId={tagId}&page={page}&pageSize={pageSize}"=>{"get"=>{"summary"=>"List Orders by Tag", "description"=>"Lists all orders that match the specified status and tag ID.\n\nUrl format with filters:\n\n```\n/listbytag?orderStatus={orderStatus}\n&tagId={tagId}\n&page={page}\n&pageSize={pageSize}\n```", "operationId"=>"orders.listbytag_orderStatus_orderStatus_tagId_tagId_page_page_pageSize_pageSize.get", "x-api-path-slug"=>"orderslistbytagorderstatusorderstatustagidtagidpagepagepagesizepagesize-get", "parameters"=>[{"in"=>"path", "name"=>"orderStatus", "description"=>"The orders status"}, {"in"=>"path", "name"=>"page", "description"=>"Page number"}, {"in"=>"path", "name"=>"pageSize", "description"=>"Requested page size"}, {"in"=>"path", "name"=>"tagId", "description"=>"ID of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Orders", "By", "Tag"]}}, "/orders/markasshipped"=>{"post"=>{"summary"=>"Mark an Order as Shipped", "description"=>"Marks an order as shipped without creating a label in ShipStation. The body of this request has the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n ``orderId`` | number, required | Identifies the order that will be marked as shipped.\n ``carrierCode`` | string, required | Code of the carrier that is marked as having shipped the order.\n ``shipDate`` | string, optional | Date order was shipped.\n ``trackingNumber`` | string, optional | Tracking number of shipment.\n ``notifyCustomer`` | boolean, optional | Specifies whether the customer should be notified of the shipment. Default value: false\n ``notifySalesChannel`` | boolean, optional | Specifies whether the sales channel should be notified of the shipment. Default value: false", "operationId"=>"orders.markasshipped.post", "x-api-path-slug"=>"ordersmarkasshipped-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mark", "Order", "As", "Shipped"]}}, "/orders/removetag"=>{"post"=>{"summary"=>"Remove Tag from Order", "description"=>"Removes a tag from the specified order. The body of this request has the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderId`` | number, required | Identifies the order whose tag will be removed.\n``tagId`` | number, required | Identifies the tag to remove.", "operationId"=>"orders.removetag.post", "x-api-path-slug"=>"ordersremovetag-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Tag", "From", "Order"]}}, "/orders/restorefromhold"=>{"post"=>{"summary"=>"Restore Order from On Hold", "description"=>"This method will change the status of the given order from On Hold to Awaiting Shipment. This endpoint is used when a holdUntil Date is attached to an order.\n\nThe body of this request should specify the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderId`` | number, required | Identifies the order that will be restored to ``awaiting_shipment`` from ``on_hold``.", "operationId"=>"orders.restorefromhold.post", "x-api-path-slug"=>"ordersrestorefromhold-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Restore", "Order", "From", "On", "Hold"]}}, "/orders/unassignuser"=>{"post"=>{"summary"=>"Unassign User from Order", "description"=>"Unassigns a user from an order. The body of this request should specify the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderIds`` | number, required | Identifies set of orders that will have the user unassigned. Please note that if ANY of the orders within the array are not found, then no orders will have their users unassigned.", "operationId"=>"orders.unassignuser.post", "x-api-path-slug"=>"ordersunassignuser-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unassign", "User", "From", "Order"]}}, "/orders/{orderId}"=>{"delete"=>{"summary"=>"Delete Order", "description"=>"Removes order from ShipStation's UI. Note this is a \"soft\" delete action so the order will still exist in the database, but will be set to ``inactive``", "operationId"=>"orders.orderId.delete", "x-api-path-slug"=>"ordersorderid-delete", "parameters"=>[{"in"=>"path", "name"=>"orderId", "description"=>"The system generated identifier for the order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order"]}, "get"=>{"summary"=>"Get Order", "description"=>"Retrieves a single order from the database.", "operationId"=>"orders.orderId.get", "x-api-path-slug"=>"ordersorderid-get", "parameters"=>[{"in"=>"path", "name"=>"orderId", "description"=>"The system generated identifier for the order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order"]}}, "/orders?customerName={customerName}&itemKeyword={itemKeyword}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&modifyDateStart={modifyDateStart}&modifyDateEnd={modifyDateEnd}&orderDateStart={orderDateStart}&orderDateEnd={orderDateEnd}&"=>{"get"=>{"summary"=>"List Orders with parameters", "description"=>"Obtains a list of orders that match the specified criteria. All of the available filters are optional. They do not need to be included in the URL. If you do include them, here's what the URL may look like:\n\nUrl format with filters:\n\n```\n/orders?customerName={customerName}\n&itemKeyword={itemKeyword}\n&createDateStart={createDateStart}\n&createDateEnd={createDateEnd}\n&modifyDateStart={modifyDateStart}\n&modifyDateEnd={modifyDateEnd}\n&orderDateStart={orderDateStart}\n&orderDateEnd={orderDateEnd}\n&orderNumber={orderNumber}\n&orderStatus={orderStatus}\n&paymentDateStart={paymentDateStart}\n&paymentDateEnd={paymentDateEnd}\n&storeId={storeId}\n&sortBy={sortBy}\n&sortDir={sortDir}\n&page={page}\n&pageSize={pageSize}\n```", "operationId"=>"orders_customerName_customerName_itemKeyword_itemKeyword_createDateStart_createDateStart_createDateE", "x-api-path-slug"=>"orderscustomernamecustomernameitemkeyworditemkeywordcreatedatestartcreatedatestartcreatedateendcreatedateendmodifydatestartmodifydatestartmodifydateendmodifydateendorderdatestartorderdatestartorderdateendorderdateend-get", "parameters"=>[{"in"=>"path", "name"=>"createDateEnd", "description"=>"Returns orders that were created in ShipStation before the specified date"}, {"in"=>"path", "name"=>"createDateStart", "description"=>"Returns orders that were created in ShipStation after the specified date"}, {"in"=>"path", "name"=>"customerName", "description"=>"Returns orders that match the specified name"}, {"in"=>"path", "name"=>"itemKeyword", "description"=>"Returns orders that contain items that match the specified keyword"}, {"in"=>"path", "name"=>"modifyDateEnd", "description"=>"Returns orders that were modified before the specified date"}, {"in"=>"path", "name"=>"modifyDateStart", "description"=>"Returns orders that were modified after the specified date"}, {"in"=>"path", "name"=>"orderDateEnd", "description"=>"Returns orders less than or equal to the specified date"}, {"in"=>"path", "name"=>"orderDateStart", "description"=>"Returns orders greater than the specified date"}, {"in"=>"path", "name"=>"orderNumber", "description"=>"Filter by order number, performs a starts with search"}, {"in"=>"path", "name"=>"orderStatus", "description"=>"Filter by order status"}, {"in"=>"path", "name"=>"page", "description"=>"Page number"}, {"in"=>"path", "name"=>"pageSize", "description"=>"Requested page size"}, {"in"=>"path", "name"=>"paymentDateEnd", "description"=>"Returns orders that were paid before the specified date"}, {"in"=>"path", "name"=>"paymentDateStart", "description"=>"Returns orders that were paid after the specified date"}, {"in"=>"path", "name"=>"sortBy", "description"=>"Sort the responses by a set value"}, {"in"=>"path", "name"=>"sortDir", "description"=>"Sets the direction of the sort order"}, {"in"=>"path", "name"=>"storeId", "description"=>"Filters orders to a single store"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Orders", "Parameters"]}}, "/products"=>{"get"=>{"summary"=>"List Products w/o parameters", "description"=>"", "operationId"=>"products.get", "x-api-path-slug"=>"products-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Products", "W", "O", "Parameters"]}}, "/products/{productId}"=>{"get"=>{"summary"=>"Get Product", "description"=>"", "operationId"=>"products.productId.get", "x-api-path-slug"=>"productsproductid-get", "parameters"=>[{"in"=>"path", "name"=>"productId", "description"=>"The system generated identifier for the Product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}, "put"=>{"summary"=>"Update Product", "description"=>"Updates an existing product. This call does not currently support partial updates. The entire resource must be provided in the body of the request.", "operationId"=>"products.productId.put", "x-api-path-slug"=>"productsproductid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"productId", "description"=>"The system generated identifier for the Product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}}, "/products?sku={sku}&name={name}&productCategoryId={productCategoryId}&productTypeId={productTypeId}&tagId={tagId}&startDate={startDate}&endDate={endDate}&showInactive={showInactive}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}"=>{"get"=>{"summary"=>"List Products with parameters", "description"=>"Obtains a list of products that match the specified criteria. All of the available filters are optional. They do not need to be included in the URL. If you do include them, here's what the URL may look like:\n\nUrl format with filters:\n\n```\n/products?sku={sku}\n&name={name}\n&productCategoryId={productCategoryId}\n&productTypeId={productTypeId}\n&tagId={tagId}\n&startDate={startDate}\n&endDate={endDate}\n&showInactive={showInactive}\n&sortBy={sortBy}\n&sortDir={sortDir}\n&page={page}\n&pageSize={pageSize}\n```", "operationId"=>"products_sku_sku_name_name_productCategoryId_productCategoryId_productTypeId_productTypeId_tagId_tag", "x-api-path-slug"=>"productsskuskunamenameproductcategoryidproductcategoryidproducttypeidproducttypeidtagidtagidstartdatestartdateenddateenddateshowinactiveshowinactivesortbysortbysortdirsortdirpagepagepagesizepagesize-get", "parameters"=>[{"in"=>"path", "name"=>"endDate", "description"=>"Returns products that were created before the specified date"}, {"in"=>"path", "name"=>"name", "description"=>"Returns products that match the specified product name"}, {"in"=>"path", "name"=>"page", "description"=>"Page number"}, {"in"=>"path", "name"=>"pageSize", "description"=>"Requested page size"}, {"in"=>"path", "name"=>"productCategoryId", "description"=>"Returns products that match the specified productCategoryId"}, {"in"=>"path", "name"=>"productTypeId", "description"=>"Returns products that match the specified productTypeId"}, {"in"=>"path", "name"=>"showInactive", "description"=>"Specifies whether the list should include inactive products"}, {"in"=>"path", "name"=>"sku", "description"=>"Returns products that match the specified SKU"}, {"in"=>"path", "name"=>"sortBy", "description"=>"Sorts the order of the response based off the specified value"}, {"in"=>"path", "name"=>"sortDir", "description"=>"Sets the direction of the sort order"}, {"in"=>"path", "name"=>"startDate", "description"=>"Returns products that were created after the specified date"}, {"in"=>"path", "name"=>"tagId", "description"=>"Returns products that match the specified tagId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Products", "Parameters"]}}, "/shipments"=>{"get"=>{"summary"=>"List Shipments w/o parameters", "description"=>"", "operationId"=>"shipments.get", "x-api-path-slug"=>"shipments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Shipments", "W", "O", "Parameters"]}}, "/shipments/createlabel"=>{"post"=>{"summary"=>"Create Shipment Label", "description"=>"Creates a shipping label. The ``labelData`` field returned in the response is a base64 encoded PDF value. Simply decode and save the output as a PDF file to retrieve a printable label. The body of this request has the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n ``carrierCode`` | string, required | Identifies the carrier to be used for this label.\n ``serviceCode`` | string, required | Identifies the shipping service to be used for this label.\n ``packageCode`` | string, required | Identifies the packing type that should be used for this label.\n ``confirmation`` | string, optional | Identifies the delivery confirmation type to be used for this label.\n ``shipDate`` | string, required | The date the shipment will be shipped.\n ``weight`` | Weight, required | Shipment's weight. Use the [**Weight**](https://www.shipstation.com/developer-api/#/reference/model-weight) model.\n ``dimensions`` | Dimensions, optional | Shipment's dimensions. Use the [**Dimensions**](https://www.shipstation.com/developer-api/#/reference/model-dimensions) model.\n ``shipFrom`` | Address, required | Address indicating shipment's origin. Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.\n ``shipTo`` | Address, required | Address indicating shipment's destination. Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.\n ``insuranceOptions`` | InsuranceOptions, optional | The shipping insurance information associated with this order. \n ``internationalOptions`` | InternationalOptions, optional | Customs information that can be used to generate customs documents for international orders. Use the [**InternationalOptions**](https://www.shipstation.com/developer-api/#/reference/model-internationaloptions) model.\n ``advancedOptions`` | AdvancedOptions, optional | Various advanced options that may be available depending on the shipping carrier that is used to ship the order. Use the [**AdvancedOptions**](https://www.shipstation.com/developer-api/#/reference/model-advancedoptions) model. \n ``testLabel`` | boolean, optional | Specifies whether a test label should be created. Default value: false.", "operationId"=>"shipments.createlabel.post", "x-api-path-slug"=>"shipmentscreatelabel-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipment", "Label"]}}, "/shipments/getrates"=>{"post"=>{"summary"=>"Get Rates", "description"=>"Retrieves shipping rates for the specified shipping details. The body of this request should specify the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n ``carrierCode`` | string, required | Returns rates for the specified carrier.\n ``serviceCode`` | string, optional | Returns rates for the specified shipping service.\n ``packageCode`` | string, optional | Returns rates for the specified package type.\n ``fromPostalCode`` | string, required | Originating postal code.\n ``toState`` | string, optional | Destination State/Province. Please use two-character state/province abbreviation. Note this field is required for the following carriers: UPS\n ``toCountry`` | string, required | Destination Country. Please use the two-character ISO country code.\n ``toPostalCode`` | string, required | Destination Postal Code.\n ``toCity`` | string, optional | Destination City.\n ``weight`` | Weight, required | Shipment's weight. Use ``Weight`` object.\n ``dimensions`` | Dimensions, optional | Shipment's dimensions. Use ``Dimensions`` object. \n ``confirmation`` | string, optional | Returns rates that account for the specified delivery confirmation type.\n ``residential`` | boolean, optional | Returns rates that account for the specified delivery confirmation type. Default value: false", "operationId"=>"shipments.getrates.post", "x-api-path-slug"=>"shipmentsgetrates-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rates"]}}, "/shipments/voidlabel"=>{"post"=>{"summary"=>"Void Label", "description"=>"Voids the specified label by shipmentId. The body of this request should specify the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n ``shipmentId`` | number, required | ID of the shipment to void.", "operationId"=>"shipments.voidlabel.post", "x-api-path-slug"=>"shipmentsvoidlabel-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Void", "Label"]}}, "/shipments?recipientName={recipientName}&recipientCountryCode={recipientCountryCode}&orderNumber={orderNumber}&orderId={orderId}&carrierCode={carrierCode}&serviceCode={serviceCode}&trackingNumber={trackingNumber}&createDateStart={createDateStart}&cre"=>{"get"=>{"summary"=>"List Shipments with parameters", "description"=>"Obtains a list of shipments that match the specified criteria. Please note the following:\n\n- Only valid shipments with labels generated in ShipStation will be returned in the response. Orders that have been marked as shipped either through the UI or the API will not appear as they are considered external shipments.\n\n- To include every shipment's associated shipmentItems in the response, be sure to set the `includeShipmentItems` parameter to `true`.\n\nAll of the available filters are optional. They do not need to be included in the URL. If you do include them, here's what the URL may look like:\n\nUrl format with filters:\n\n```\nshipments?recipientName={recipientName}\n&recipientCountryCode={recipientCountryCode}\n&orderNumber={orderNumber}\n&orderId={orderId}\n&carrierCode={carrierCode}\n&serviceCode={serviceCode}\n&trackingNumber={trackingNumber}\n&createDateStart={createDateStart}\n&createDateEnd={createDateEnd}\n&shipDateStart={shipDateStart}\n&shipDateEnd={shipDateEnd}\n&voidDateStart={voidDateStart}\n&voidDateEnd={voidDateEnd}\n&includeShipmentItems={includeShipmentItems}\n&sortBy={sortBy}\n&sortDir={sortDir}\n&page={page}\n&pageSize={pageSize}\n```", "operationId"=>"shipments_recipientName_recipientName_recipientCountryCode_recipientCountryCode_orderNumber_orderNum", "x-api-path-slug"=>"shipmentsrecipientnamerecipientnamerecipientcountrycoderecipientcountrycodeordernumberordernumberorderidorderidcarriercodecarriercodeservicecodeservicecodetrackingnumbertrackingnumbercreatedatestartcreatedatestartcre-get", "parameters"=>[{"in"=>"path", "name"=>"carrierCode", "description"=>"Returns shipments shipped with the specified carrier"}, {"in"=>"path", "name"=>"createDateEnd", "description"=>"Returns shipments created on or before the specified ``createDate``"}, {"in"=>"path", "name"=>"createDateStart", "description"=>"Returns shipments created on or after the specified ``createDate``"}, {"in"=>"path", "name"=>"includeShipmentItems", "description"=>"Specifies whether to include shipment items with results Default value: false"}, {"in"=>"path", "name"=>"orderId", "description"=>"Returns shipments whose orders have the specified order ID"}, {"in"=>"path", "name"=>"orderNumber", "description"=>"Returns shipments whose orders have the specified order number"}, {"in"=>"path", "name"=>"page", "description"=>"page number"}, {"in"=>"path", "name"=>"pageSize", "description"=>"page size"}, {"in"=>"path", "name"=>"recipientCountryCode", "description"=>"Returns shipments shipped to the specified country code"}, {"in"=>"path", "name"=>"recipientName", "description"=>"Returns shipments shipped to the specified recipient name"}, {"in"=>"path", "name"=>"serviceCode", "description"=>"Returns shipments shipped with the specified shipping service"}, {"in"=>"path", "name"=>"shipDateEnd", "description"=>"Returns shipments with the ``shipDate`` on or before the specified date"}, {"in"=>"path", "name"=>"shipDateStart", "description"=>"Returns shipments with the ``shipDate`` on or after the specified date"}, {"in"=>"path", "name"=>"sortBy", "description"=>"Sort the responses by a set value"}, {"in"=>"path", "name"=>"sortDir", "description"=>"Sets the direction of the sort order"}, {"in"=>"path", "name"=>"trackingNumber", "description"=>"Returns shipments with the specified tracking number"}, {"in"=>"path", "name"=>"voidDateEnd", "description"=>"Returns shipments voided on or before the specified date"}, {"in"=>"path", "name"=>"voidDateStart", "description"=>"Returns shipments voided on or after the specified date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Shipments", "Parameters"]}}, "/stores/deactivate"=>{"post"=>{"summary"=>"Deactivate Store", "description"=>"Deactivates the specified store.\n\nThe body of this request has the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``storeId`` | number, required | ID of the store to deactivate.", "operationId"=>"stores.deactivate.post", "x-api-path-slug"=>"storesdeactivate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deactivate", "Store"]}}, "/stores/getrefreshstatus?storeId={storeId}"=>{"get"=>{"summary"=>"Get Store Refresh Status", "description"=>"Retrieves the refresh status of a given store.", "operationId"=>"stores.getrefreshstatus_storeId_storeId.get", "x-api-path-slug"=>"storesgetrefreshstatusstoreidstoreid-get", "parameters"=>[{"in"=>"path", "name"=>"storeId", "description"=>"Specifies the store whose status will be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store", "Refresh", "Status"]}}, "/stores/marketplaces"=>{"get"=>{"summary"=>"List Marketplaces", "description"=>"Lists the marketplaces that can be integrated with ShipStation.", "operationId"=>"stores.marketplaces.get", "x-api-path-slug"=>"storesmarketplaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Marketplaces"]}}, "/stores/reactivate"=>{"post"=>{"summary"=>"Reactivate Store", "description"=>"Reactivates the specified store. Note: stores are active by default\n\nThe body of this request has the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``storeId`` | number, required | ID of the store to reactivate.", "operationId"=>"stores.reactivate.post", "x-api-path-slug"=>"storesreactivate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reactivate", "Store"]}}, "/stores/refreshstore?storeId={storeId}&refreshDate={refreshDate}"=>{"post"=>{"summary"=>"Refresh Store", "description"=>"Initiates a store refresh.", "operationId"=>"stores.refreshstore_storeId_storeId_refreshDate_refreshDate.post", "x-api-path-slug"=>"storesrefreshstorestoreidstoreidrefreshdaterefreshdate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"refreshDate", "description"=>"Specifies the starting date for new order imports"}, {"in"=>"path", "name"=>"storeId", "description"=>"Specifies the store which will get refreshed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Refresh", "Store"]}}, "/stores/{storeId}"=>{"get"=>{"summary"=>"Get Store", "description"=>"", "operationId"=>"stores.storeId.get", "x-api-path-slug"=>"storesstoreid-get", "parameters"=>[{"in"=>"path", "name"=>"storeId", "description"=>"A unique ID generated by ShipStation and assigned to each store"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store"]}, "put"=>{"summary"=>"Update Store", "description"=>"Updates an existing store. This call does not currently support partial updates. The entire resource must be provided in the body of the request.", "operationId"=>"stores.storeId.put", "x-api-path-slug"=>"storesstoreid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"storeId", "description"=>"A unique ID generated by ShipStation and assigned to each store"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store"]}}, "/stores?showInactive={showInactive}&marketplaceId={marketplaceId}"=>{"get"=>{"summary"=>"List Stores", "description"=>"Retrieve the list of installed stores on the account.", "operationId"=>"stores_showInactive_showInactive_marketplaceId_marketplaceId.get", "x-api-path-slug"=>"storesshowinactiveshowinactivemarketplaceidmarketplaceid-get", "parameters"=>[{"in"=>"path", "name"=>"marketplaceId", "description"=>"Returns stores of this marketplace type"}, {"in"=>"path", "name"=>"showInactive", "description"=>"Determines whether inactive stores will be returned in the list of stores"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Stores"]}}, "/users?showInactive={showInactive}"=>{"get"=>{"summary"=>"List Users", "description"=>"", "operationId"=>"users_showInactive_showInactive.get", "x-api-path-slug"=>"usersshowinactiveshowinactive-get", "parameters"=>[{"in"=>"path", "name"=>"showInactive", "description"=>"Determines whether inactive users will be returned in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Users"]}}, "/warehouses"=>{"get"=>{"summary"=>"List Warehouses", "description"=>"Retrieves a list of your Ship From Locations (formerly known as warehouses).", "operationId"=>"warehouses.get", "x-api-path-slug"=>"warehouses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Warehouses"]}}, "/warehouses/createwarehouse"=>{"post"=>{"summary"=>"Create Warehouse", "description"=>"Adds a Ship From Location (formerly known as warehouse) to your account. The body of this request should specify the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n ``warehouseName`` | string, optional | Name of Ship From Location.\n ``originAddress`` | Address, required | The origin address. Shipping rates will be calculated from this address. Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.\n ``returnAddress`` | Address, optional | The return address. If a \"returnAddress\" is not specified, your \"originAddress\" will be used as your \"returnAddress\". Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.\n ``isDefault`` | boolean, optional | Specifies whether or not this will be your default Ship From Location.", "operationId"=>"warehouses.createwarehouse.post", "x-api-path-slug"=>"warehousescreatewarehouse-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse"]}}, "/warehouses/{warehouseId}"=>{"get"=>{"summary"=>"Get Warehouse", "description"=>"Returns a list of active Ship From Locations (formerly known as warehouses) on the ShipStation account. Warehouses are now called \"Ship From Locations\" in the UI.", "operationId"=>"warehouses.warehouseId.get", "x-api-path-slug"=>"warehouseswarehouseid-get", "parameters"=>[{"in"=>"path", "name"=>"warehouseId", "description"=>"A unique ID generated by ShipStation and assigned to each Ship From Location (formerly known as warehouse)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse"]}, "put"=>{"summary"=>"Update Warehouse", "description"=>"Updates an existing Ship From Location (formerly known as warehouse). This call does not currently support partial updates. The entire resource must be provided in the body of the request. If a \"returnAddress\" object is not specified, your \"originAddress\" will be used as your \"returnAddress\".", "operationId"=>"warehouses.warehouseId.put", "x-api-path-slug"=>"warehouseswarehouseid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"warehouseId", "description"=>"A unique ID generated by ShipStation and assigned to each Ship From Location (formerly known as warehouse)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Warehouse"]}}, "/webhooks"=>{"get"=>{"summary"=>"List Webhooks", "description"=>"Retrieves a list of registered webhooks for the account", "operationId"=>"webhooks.get", "x-api-path-slug"=>"webhooks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Webhooks"]}}, "/webhooks/subscribe"=>{"post"=>{"summary"=>"Subscribe to Webhook", "description"=>"Subscribes to a specific type of webhook. If a ``store_id`` is passed in, the webhooks will only be triggered for that specific ``store_id``.\nThe ``event`` type that is passed in will determine what type of webhooks will be sent.\n\nNOTE: Webhooks will be sent to the URL specified in the ``target_url``. The HTTP request will be sent via POST and will contain a [**webhook JSON object**](https://www.shipstation.com/developer-api/#/reference/model-webhook) in the body.\n\nThe body of this request to subscribe has the following attributes:\n\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``target_url`` | string, required | The URL to send the webhooks to\n``event`` | string, required | The type of webhook to subscribe to. Must contain one of the following values: ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY\n``store_id`` | int, optional | If passed in, the webhooks will only be triggered for this ``store_id``\n``friendly_name`` | string, optional | Display name for the webhook", "operationId"=>"webhooks.subscribe.post", "x-api-path-slug"=>"webhookssubscribe-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscribe", "To", "Webhook"]}}, "/webhooks/{webhookId}"=>{"delete"=>{"summary"=>"Unsubscribe to Webhook", "description"=>"Unsubscribes from a certain webhook.", "operationId"=>"webhooks.webhookId.delete", "x-api-path-slug"=>"webhookswebhookid-delete", "parameters"=>[{"in"=>"path", "name"=>"webhookId", "description"=>"A unique ID generated by ShipStation and assigned to each webhook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsubscribe", "To", "Webhook"]}}}}, "apis"=>{"name"=>"Ship Station", "x-slug"=>"ship-station", "description"=>"ShipStation is a web-based shipping solution that streamlines the order fulfillment process for your online business. ShipStation consolidates orders from over 70 ecommerce channels, creates shipping labels, packing slips, and pick lists in batch, communicates tracking information to your customers, provides endless automation, filters, and views, wireless printing, a mobile app, and a lot more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/ShipStation-stacked-blue.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Relative Data,Service API,Shipping", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"ship-station/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Ship Station", "x-api-slug"=>"ship-station", "description"=>"ShipStation is a web-based shipping solution that streamlines the order fulfillment process for your online business. ShipStation consolidates orders from over 70 ecommerce channels, creates shipping labels, packing slips, and pick lists in batch, communicates tracking information to your customers, provides endless automation, filters, and views, wireless printing, a mobile app, and a lot more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/ShipStation-stacked-blue.png", "humanURL"=>"http://bit.ly/_ShipStation", "baseURL"=>"https://ssapi.shipstation.com//", "tags"=>"Relative Data,Service API,Shipping", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/ship-station/ship-station-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://bit.ly/_ShipStation"}, {"type"=>"x-blog", "url"=>"https://www.shipstation.com/blog/"}, {"type"=>"x-developer", "url"=>"https://shipstation.docs.apiary.io/#"}, {"type"=>"x-github", "url"=>"https://github.com/shipstation"}, {"type"=>"x-partners", "url"=>"https://www.shipstation.com/partners/"}, {"type"=>"x-pricing", "url"=>"https://www.shipstation.com/pricing/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/ShipStation"}, {"type"=>"x-website", "url"=>"http://shipstation.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
open-science-framework{"open-science-framework-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Open Science Framework", "x-complete"=>1, "info"=>{"title"=>"Open Science Framework", "description"=>"osf-provides-free-and-open-source-project-management-support-for-researchers-across-the-entire-research-lifecycle--as-a-collaboration-tool-osf-helps-researchers-work-on-projects-privately-with-a-limited-number-of-collaborators-and-make-parts-of-their-projects-public-or-make-all-the-project-publicly-accessible-for-broader-dissemination--as-a-workflow-system-osf-enables-connections-to-the-many-services-researchers-already-use-to-streamline-their-process-and-increase-efficiency--as-a-flexible-repository-it-can-store-and-archive-research-data-protocols-and-materials--", "contact"=>{"name"=>"OSF", "url"=>"https://osf.io/support", "email"=>"support@osf.io"}, "version"=>"2.0"}, "host"=>"test-api.osf.io", "basePath"=>"/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/"=>{"get"=>{"summary"=>"Root", "description"=>"Welcome to the Open Science Framework API. With this API you can access users, projects, components, logs, and files from the [Open Science Framework](https://osf.io/). The Open Science Framework (OSF) is a free, open-source service maintained by the [Center for Open Science](http://cos.io/).\n\n#### Returns\nA JSON object with `meta` and `links` keys.\n\nThe `meta` key contains information such as a welcome message from the API, the specified version of the request, and the full representation of the current user, if authentication credentials were provided in the request.\n\nThe `links` key contains links to the following entity collections: [addons](), [collections](), [institutions](#Institutions_institutions_list), [licenses](#Licenses_license_list), [metaschemas](), [nodes](#Nodes_nodes_list), [registrations](), [users](#Users_users_list)", "operationId"=>"base_read", "x-api-path-slug"=>"get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Root"]}}, "/actions/"=>{"get"=>{"summary"=>"Actions", "description"=>"A log can have one of many actions. The complete list of loggable actions (in the format {identifier}: {description}) is as follows:\n* `project_created`: A Node is created\n* `project_registered`: A Node is registered\n* `project_deleted`: A Node is deleted\n* `created_from`: A Node is created using an existing Node as a template\n* `pointer_created`: A Pointer is created\n* `pointer_forked`: A Pointer is forked\n* `pointer_removed`: A Pointer is removed\n* `node_removed`: A component is deleted\n* `node_forked`: A Node is forked\n---\n* `made_public`: A Node is made public\n* `made_private`: A Node is made private\n* `tag_added`: A tag is added to a Node\n* `tag_removed`: A tag is removed from a Node\n* `edit_title`: A Node's title is changed\n* `edit_description`: A Node's description is changed\n* `updated_fields`: One or more of a Node's fields are changed\n* `external_ids_added`: An external identifier is added to a Node (e.g. DOI, ARK)\n* `view_only_link_added`: A view-only link was added to a Node\n* `view_only_link_removed`: A view-only link was removed from a Node\n---\n* `contributor_added`: A Contributor is added to a Node\n* `contributor_removed`: A Contributor is removed from a Node\n* `contributors_reordered`: A Contributor's position in a Node's bibliography is changed\n* `permissions_updated`: A Contributor`s permissions on a Node are changed\n* `made_contributor_visible`: A Contributor is made bibliographically visible on a Node\n* `made_contributor_invisible`: A Contributor is made bibliographically invisible on a Node\n---\n* `wiki_updated`: A Node's wiki is updated\n* `wiki_deleted`: A Node's wiki is deleted\n* `wiki_renamed`: A Node's wiki is renamed\n* `made_wiki_public`: A Node's wiki is made public\n* `made_wiki_private`: A Node's wiki is made private\n---\n* `addon_added`: An add-on is linked to a Node\n* `addon_removed`: An add-on is unlinked from a Node\n* `addon_file_moved`: A File in a Node's linked add-on is moved\n* `addon_file_copied`: A File in a Node's linked add-on is copied\n* `addon_file_renamed`: A File in a Node's linked add-on is renamed\n* `node_authorized`: An addon is authorized for a project\n* `node_deauthorized`: An addon is deauthorized for a project\n* `folder_created`: A Folder is created in a Node's linked add-on\n* `file_added`: A File is added to a Node's linked add-on\n* `file_updated`: A File is updated on a Node's linked add-on\n* `file_removed`: A File is removed from a Node's linked add-on\n* `file_restored`: A File is restored in a Node's linked add-on\n---\n* `comment_added`: A Comment is added to some item\n* `comment_removed`: A Comment is removed from some item\n* `comment_updated`: A Comment is updated on some item\n---\n* `embargo_initiated`: An embargoed Registration is proposed on a Node\n* `embargo_approved`: A proposed Embargo of a Node is approved\n* `embargo_cancelled`: A proposed Embargo of a Node is cancelled\n* `embargo_completed`: A proposed Embargo of a Node is completed\n* `retraction_initiated`: A Withdrawal of a Registration is proposed\n* `retraction_approved`: A Withdrawal of a Registration is approved\n* `retraction_cancelled`: A Withdrawal of a Registration is cancelled\n* `registration_initiated`: A Registration of a Node is proposed\n* `registration_approved`: A proposed Registration is approved\n* `registration_cancelled`: A proposed Registration is cancelled", "operationId"=>"logs_actions", "x-api-path-slug"=>"actions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions"]}}, "/addons/"=>{"get"=>{"summary"=>"List all addons", "description"=>"A paginated list of addons configurable with the OSF\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of up to 10 addons. Each resource in the array is a separate addon object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n\nThis request should never return an error.", "operationId"=>"addons_list", "x-api-path-slug"=>"addons-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addons"]}}, "/citations/styles/"=>{"get"=>{"summary"=>"List all citation styles", "description"=>"A paginated list of all standard citation styles available for rendering citations.\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of 10 citation styles. Each resource in the array is a separate citation syle and contains the full representation of the citation style object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n\nThis request should never return an error.\n#### Filtering\nYou can optionally request that the response only include citation styles that match your filters by utilizing the `filter` query parameter, e.g. https://api.osf.io/v2/citations/styles/?filter[title]=open.\n\nCitation styles may be filtered by their `id`, `title`, `short-title`, and `summary`.", "operationId"=>"citations_styles_list", "x-api-path-slug"=>"citationsstyles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Citations", "Styles"]}}, "/citations/styles/{style_id}/"=>{"get"=>{"summary"=>"Retrieve a citation style", "description"=>"Retrieves the details of a citation style.\n#### Returns\nReturns a JSON object with a `data` key containing the representation of the requested citation style, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"citations_styles_read", "x-api-path-slug"=>"citationsstylesstyle-id-get", "parameters"=>[{"in"=>"path", "name"=>"style_id", "description"=>"The unique identifier of the citation style"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Citations", "Styles", "Style"]}}, "/comments/{comment_id}/"=>{"delete"=>{"summary"=>"Delete a comment", "description"=>"Deletes a comment. This action can be undone by setting deleted to False in a comment update request.\n#### Returns\nIf the request is successful, no content is returned.\n\nIf the request is unsuccessful, a JSON object with an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"comments_delete", "x-api-path-slug"=>"commentscomment-id-delete", "parameters"=>[{"in"=>"path", "name"=>"comment_id", "description"=>"The unique identifier of the comment you wish to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Comment"]}, "get"=>{"summary"=>"Retrieve a comment", "description"=>"Retrieves the details of a comment\n####Returns\nReturns a JSON object with a `data` key containing the representation of the requested comment, if the request was successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"comments_read", "x-api-path-slug"=>"commentscomment-id-get", "parameters"=>[{"in"=>"path", "name"=>"comment_id", "description"=>"The unique identifier of the comment you wish to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Comment"]}, "put"=>{"summary"=>"Update a comment", "description"=>"Updates the specified comment by setting the values of the parameters passed. Any parameters not provided will be left unchanged.\n#### Returns\nReturns JSON with a `data` key containing the new representation of the updated comment, if the request is successful.\n\nIf the request is unsuccessful, JSON with an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"comments_put", "x-api-path-slug"=>"commentscomment-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"comment_id", "description"=>"The unique identifier of the comment you wish to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Comment"]}}, "/files/{file_id}/"=>{"get"=>{"summary"=>"Retrieve a file", "description"=>"Retrieves the details of a file (or folder)\n####Returns\nReturns a JSON object with a `data` key containing the representation of the requested file, if the request was successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.\n###Waterbutler API actions\n\nFiles can be modified through the Waterbutler API routes found in `links` (`new_folder`, `move`, `upload`, `download`, and `delete`).\n\n#### Download (files)\n\nTo download a file, issue a GET request against the download link. The response will have the Content-Disposition header set, which will will trigger a download in a browser.\n\n#### Create Subfolder (folders)\n\nYou can create a subfolder of an existing folder by issuing a PUT request against the new_folder link. The ?kind=folder portion of the query parameter is already included in the new_folder link. The name of the new subfolder should be provided in the name query parameter. The response will contain a WaterButler folder entity. If a folder with that name already exists in the parent directory, the server will return a 409 Conflict error response.\n\n#### Upload New File (folders)\n\n\n To upload a file to a folder, issue a PUT request to the folder's upload link with the raw file data in the request body, and the kind and name query parameters set to 'file' and the desired name of the file. The response will contain a WaterButler file entity that describes the new file. If a file with the same name already exists in the folder, the server will return a 409 Conflict error response.\n\n\n#### Update Existing File (file)\n\nTo update an existing file, issue a PUT request to the file's upload link with the raw file data in the request body and the kind query parameter set to \"file\". The update action will create a new version of the file. The response will contain a WaterButler file entity that describes the updated file.\n\n#### Rename (files, folders)\n\nTo rename a file or folder, issue a POST request to the move link with the action body parameter set to \"rename\" and the rename body parameter set to the desired name. The response will contain either a folder entity or file entity with the new name.\n\n#### Move & Copy (files, folders)\n\nMove and copy actions both use the same request structure, a POST to the move url, but with different values for the action body parameters. The path parameter is also required and should be the OSF path attribute of the folder being written to. The rename and conflict parameters are optional. If you wish to change the name of the file or folder at its destination, set the rename parameter to the new name. The conflict param governs how name clashes are resolved. Possible values are replace and keep. replace is the default and will overwrite the file that already exists in the target folder. keep will attempt to keep both by adding a suffix to the new file's name until it no longer conflicts. The suffix will be ' (x)' where x is a increasing integer starting from 1. This behavior is intended to mimic that of the OS X Finder. The response will contain either a folder entity or file entity with the new name.\nFiles and folders can also be moved between nodes and providers. The resource parameter is the id of the node under which the file/folder should be moved. It must agree with the path parameter, that is the path must identify a valid folder under the node identified by resource. Likewise, the provider parameter may be used to move the file/folder to another storage provider, but both the resource and path parameters must belong to a node and folder already extant on that provider. Both resource and provider default to the current node and providers.\nIf a moved/copied file is overwriting an existing file, a 200 OK response will be returned. Otherwise, a 201 Created will be returned.\n\n#### Delete (file, folders)\n\nTo delete a file or folder send a DELETE request to the delete link. Nothing will be returned in the response body.", "operationId"=>"files_detail", "x-api-path-slug"=>"filesfile-id-get", "parameters"=>[{"in"=>"path", "name"=>"file_id", "description"=>"The unique identifier of the file you wish to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files", "File"]}, "patch"=>{"summary"=>"Update a file", "description"=>"Updates the specified file by setting the values of the parameters passed. Any parameters not provided will be left unchanged.\n#### Returns\nReturns JSON with a `data` key containing the new representation of the updated file, if the request is successful.\n\nIf the request is unsuccessful, JSON with an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"files_patch", "x-api-path-slug"=>"filesfile-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"file_id", "description"=>"The unique identifier of the file you wish to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files", "File"]}}, "/files/{file_id}/versions/"=>{"get"=>{"summary"=>"List all file versions", "description"=>"A paginated list of all file versions.\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of 10 file versions. Each resource in the array is a separate file version object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"files_versions", "x-api-path-slug"=>"filesfile-idversions-get", "parameters"=>[{"in"=>"path", "name"=>"file_id", "description"=>"The unique identifier of the file from which you want to retrieve versions"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files", "File", "Versions"]}}, "/files/{file_id}/versions/{version_id}/"=>{"get"=>{"summary"=>"Retrieve a file version", "description"=>"Retrieves the details of a file version\n####Returns\n\nReturns a JSON object with a `data` key containing the representation of the requested file, if the request was successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"files_version_detail", "x-api-path-slug"=>"filesfile-idversionsversion-id-get", "parameters"=>[{"in"=>"path", "name"=>"file_id", "description"=>"The unique identifier of the file from which you want to retrieve versions"}, {"in"=>"path", "name"=>"version_id", "description"=>"The file version number you want to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files", "File", "Versions", "Version"]}}, "/institutions/"=>{"get"=>{"summary"=>"List all institutions", "description"=>"A paginated list of all verified institutions.\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of 10 institutions. Each resource in the array is a separate institution object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n\nThis request should never return an error.\n#### Filtering\nYou can optionally request that the response only include institutions that match your filters by utilizing the `filter` query parameter, e.g. https://api.osf.io/v2/institutions/?filter[id]=cos.\n\nInstitutions may be filtered by their `id`, `name`, and `auth_url`", "operationId"=>"institutions_list", "x-api-path-slug"=>"institutions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Institutions"]}}, "/institutions/{institution_id}/"=>{"get"=>{"summary"=>"Retrieve an institution", "description"=>"Retrieves the details of an institution\n####Returns\nReturns a JSON object with a `data` key containing the representation of the requested institution, if the request was successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"institutions_detail", "x-api-path-slug"=>"institutionsinstitution-id-get", "parameters"=>[{"in"=>"path", "name"=>"institution_id", "description"=>"The unique identifier of the institution you wish to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Institutions", "Institution"]}}, "/institutions/{institution_id}/nodes/"=>{"get"=>{"summary"=>"List all affiliated nodes", "description"=>"A paginated list of all nodes affiliated with an institution.\n#### Versioning\nAs of version `2.2`, affiliated components (in addition to affiliated top-level projects) are returned from this endpoint.\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of 10 nodes. Each resource in the array is a separate nodes object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.\n#### Filtering\nYou can optionally request that the response only include nodes that match your filters by utilizing the `filter` query parameter, e.g. https://api.osf.io/v2/institutions/cos/nodes?filter[title]=science.\n\nNodes may be filtered by their `id`, `title`, `description`, `public`, `tags`, `category`, `date_created`, `date_modified`, `root`, `parent`, `contributors`, and `preprint`", "operationId"=>"institutions_node_list", "x-api-path-slug"=>"institutionsinstitution-idnodes-get", "parameters"=>[{"in"=>"path", "name"=>"institution_id", "description"=>"The unique identifier of the institution you wish to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Institutions", "Institution", "Nodes"]}}, "/institutions/{institution_id}/registrations/"=>{"get"=>{"summary"=>"List all affiliated registrations", "description"=>"A paginated list of all registrations affiliated with an institution.\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of 10 registrations. Each resource in the array is a separate users object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.\n#### Filtering\nYou can optionally request that the response only include registrations that match your filters by utilizing the `filter` query parameter, e.g. https://api.osf.io/v2/institutions/cos/registrations?filter[title]=science.\n\nRegistrations may be filtered by their `id`, `title`, `description`, `public`, `tags`, `category`, `date_created`, `date_modified`, `root`, `parent`, `contributors`, and `preprint`", "operationId"=>"institutions_registration_list", "x-api-path-slug"=>"institutionsinstitution-idregistrations-get", "parameters"=>[{"in"=>"path", "name"=>"institution_id", "description"=>"The unique identifier of the institution you wish to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Institutions", "Institution", "Registrations"]}}, "/institutions/{institution_id}/users/"=>{"get"=>{"summary"=>"List all affiliated users", "description"=>"A paginated list of all users affiliated with an institution.\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of 10 users. Each resource in the array is a separate users object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.\n#### Filtering\nYou can optionally request that the response only include users that match your filters by utilizing the `filter` query parameter, e.g. https://api.osf.io/v2/institutions/cos/users?filter[family_name]=Nosek.\n\nUsers may be filtered by their `id`, `full_name`, `given_name`, `middle_names`, and `family_name`", "operationId"=>"institutions_users_list", "x-api-path-slug"=>"institutionsinstitution-idusers-get", "parameters"=>[{"in"=>"path", "name"=>"institution_id", "description"=>"The unique identifier of the institution you wish to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Institutions", "Institution", "Users"]}}, "/license/{license_id}/"=>{"get"=>{"summary"=>"Retrieve a license", "description"=>"Retrieves the details of a license.\n#### Returns\nReturns a JSON object with a `data` key containing the representation of the requested license, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"licenses_read", "x-api-path-slug"=>"licenselicense-id-get", "parameters"=>[{"in"=>"path", "name"=>"license_id", "description"=>"The unique identifier of the license"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License", "License"]}}, "/licenses/"=>{"get"=>{"summary"=>"List all licenses", "description"=>"A paginated list of licenses. The returned licenses are sorted by their name.\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\nThe `data` key contains an array of 10 licenses. Each resource in the array is a separate license object and contains the full representation of the license, meaning additional requests to a license's detail view are not necessary.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n\nThis request should never return an error.\n#### Filtering\nYou can optionally request that the response only include licenses that match your filters by utilizing the `filter` query parameter, e.g. [https://api.osf.io/v2/licenses/?filter[name]=apache](https://api.osf.io/v2/licenses/?filter[name]=apache).\n\nLicenses may be filtered by their `id`, and `name`.", "operationId"=>"license_list", "x-api-path-slug"=>"licenses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licenses"]}}, "/logs/{log_id}/"=>{"get"=>{"summary"=>"Retrieve a log", "description"=>"Retrieves the details of a log.\nA log is permanent immutable record of a node's history. A log is created when a user performs one of many actions. See the [actions](#Logs_logs_actions) section for more details.\n####Returns\nReturns a JSON object with a `data` key containing the representation of the requested log, if the request was successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"logs_read", "x-api-path-slug"=>"logslog-id-get", "parameters"=>[{"in"=>"path", "name"=>"log_id", "description"=>"The unique identifier of the log you wish to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logs", "Log"]}}, "/metaschemas/"=>{"get"=>{"summary"=>"List all metaschemas", "description"=>"A paginated list of all active metaschemas.\nMetaschemas describe the supplemental questions that accompany a registration.\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of 10 metaschemas. Each resource in the array is a separate metaschema object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n\nThis request should never return an error.", "operationId"=>"metaschemas_list", "x-api-path-slug"=>"metaschemas-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metaschemas"]}}, "/metaschemas/{metaschema_id}"=>{"get"=>{"summary"=>"Retrieve a metaschema", "description"=>"Retrieves the details of a given metaschema.\n\nMetaschemas describe the supplemental questions that accompany a registration.\n\n#### Returns\nReturns a JSON object with a `data` key containing the representation of the requested metaschema, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"metaschemas_read", "x-api-path-slug"=>"metaschemasmetaschema-id-get", "parameters"=>[{"in"=>"path", "name"=>"metaschema_id", "description"=>"The unique identifier of the metaschema"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metaschemas", "Metaschema"]}}, "/nodes/"=>{"get"=>{"summary"=>"List all nodes", "description"=>"A paginated list of nodes, representing projects and components, on the OSF.\n\nThe returned nodes are those which are public or which the user has access to view.\n\nThe returned nodes are sorted by their `date_modified`, with the most recently updated nodes appearing first.\n\nRegistrations cannot be accessed through this endpoint (use the [registrations](#Registrations_registrations_list) endpoints instead).\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of 10 nodes. Each resource in the array is a separate node object and contains the full representation of the node, meaning additional requests to a node's detail view are not necessary.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n\nThis request should never return an error.\n#### Filtering\nYou can optionally request that the response only include nodes that match your filters by utilizing the `filter` query parameter, e.g. https://api.osf.io/v2/nodes/?filter[title]=reproducibility.\n\nNodes may be filtered by their `id`, `title`, `category`, `description`, `public`, `tags`, `date_created`, `date_modified`, `root`, `parent`, `preprint`, and `contributors`.\n\nMost fields are string fields and will be filtered using simple substring matching. Public and preprint are boolean fields, and can be filtered using truthy values, such as **true**, **false**, **0** or **1**. Note that quoting true or false in the query will cause the match to fail.", "operationId"=>"nodes_list", "x-api-path-slug"=>"nodes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes"]}, "post"=>{"summary"=>"Create a node", "description"=>"Creates a new node.\n\nOn the OSF, nodes are considered **projects** or **components**. The difference between a project and a component is that a project is a top-level node, and a component is a child of a project.\n\nAdditionally, nodes have a `category` field that includes **project** as an option. The categorization determines what icon is displayed with the node on the OSF, and helps with search organization. Projects (top-level nodes) may have a category other than project, and components (children) may have a category of **project**.\n#### Required\nRequired fields for creating a node include:\n\n `title`\n\n `category`\n\nNote: Nodes default to **private** unless the `public` field is explicitly set to **true** in the request payload.\n#### Returns\nReturns a JSON object with a `data` key containing the representation of the created node, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_create", "x-api-path-slug"=>"nodes-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes"]}}, "/nodes/{node_id}/"=>{"delete"=>{"summary"=>"Delete a node", "description"=>"Permanently deletes a node. This action cannot be undone.\n#### Permissions\nOnly project administrators may delete a node. Attempting to delete a node for which you are not an administrator will result in a **403 Forbidden** response.\n#### Returns\nIf the request is successful, no content is returned.\n\nIf the request is unsuccessful, a JSON object with an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_delete", "x-api-path-slug"=>"nodesnode-id-delete", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node"]}, "get"=>{"summary"=>"Retrieve a node", "description"=>"Retrieves the details of a given node (project or component).\n#### Permissions\nOnly project contributors may retrieve the details of a private node. Attempting to retreive a private node for which you are not a contributor will result in a **403 Forbidden** response.\n\nAuthentication is not required to view the details of a public node, as public nodes give read-only access to everyone.\n#### Returns\nReturns a JSON object with a `data` key containing the representation of the requested node, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_read", "x-api-path-slug"=>"nodesnode-id-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node"]}, "patch"=>{"summary"=>"Update a node", "description"=>"Updates a node by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged.\n\nNodes can be updated with either a **PUT** or **PATCH** request. The `title` and `category` fields are mandatory in a **PUT** request, and optional in a **PATCH**.\n#### Permissions\nOnly write contributors may update a node. Attempting to update a node for which you do not have write access will result in a **403 Forbidden** response.\n#### Returns\nReturns a JSON object with a `data` key containing the new representation of the updated node, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_partial_update", "x-api-path-slug"=>"nodesnode-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node"]}}, "/nodes/{node_id}/addons/"=>{"get"=>{"summary"=>"List all addons", "description"=>"A paginated list of addons connected to the given node or project.\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of at most 10 addon objects. Each resource in the array is a separate addon object and contains the full representation of the addon, meaning additional requests to a addon's detail view are not necessary.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).", "operationId"=>"nodes_addons_list", "x-api-path-slug"=>"nodesnode-idaddons-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Addons"]}}, "/nodes/{node_id}/addons/{provider}/"=>{"get"=>{"summary"=>"Retrieve an addon", "description"=>"Retrieve details of an individual addon connected to this node.\n#### Permissions\nNodeSettings that are attached to public nodes will give read-only access to everyone. Private nodes require explicit read permission. Write and admin access are the same for public and private nodes. Administrators on a parent node have implicit read permissions for all child nodes.\nAny users with write or admin access to the node are able to deauthorize an enabled addon, but only the addon authorizer is able to change the configuration (i.e. selected folder) of an already-configured NodeSettings entity.\n#### Returns\nReturns a JSON object with a `data` key containing the details of the requested addon, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_addon_read", "x-api-path-slug"=>"nodesnode-idaddonsprovider-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}, {"in"=>"path", "name"=>"provider", "description"=>"The unique identifier of the addon"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Addons", "Provider"]}, "patch"=>{"summary"=>"Update an addon", "description"=>"Updates a node addon by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged.\n\nNode addon can be updated with either a **PUT** or **PATCH** request. The `external_account_id`, `enabled`, and `folder_id` fields are mandatory in a **PUT**, and optional in **PATCH**. Non-string values will be accepted and stringified, however we make no promises about the stringification output.\n\nTo delete or deauthorize a node addon, issue a **PUT** with all fields set to `null` or `False`, or a **PATCH** with enabled set `False`.\n#### Permissions\nNodeSettings that are attached to public nodes will give read-only access to everyone. Private nodes require explicit read permission. Write and admin access are the same for public and private nodes. Administrators on a parent node have implicit read permissions for all child nodes.\nAny users with write or admin access to the node are able to deauthorize an enabled addon, but only the addon authorizer is able to change the configuration (i.e. selected folder) of an already-configured NodeSettings entity.\n\n#### Returns\nReturns a JSON object with a `data` key containing the new representation of the updated node addon, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_node_addon_update", "x-api-path-slug"=>"nodesnode-idaddonsprovider-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}, {"in"=>"path", "name"=>"provider", "description"=>"The unique identifier of the addon"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Addons", "Provider"]}}, "/nodes/{node_id}/addons/{provider}/folders/"=>{"get"=>{"summary"=>"List all addon folders", "description"=>"A paginated list of folders retrieved from the associated third-party (provider) service.\n#### Permissions\nFolders are visible only to the user that authorized the addon.\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of addon folder objects. Each resource in the array is a separate addon folder object and contains the full representation of the addon folder, meaning additional requests to a addon folder's detail view are not necessary.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).", "operationId"=>"nodes_addons_folders_list", "x-api-path-slug"=>"nodesnode-idaddonsproviderfolders-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}, {"in"=>"path", "name"=>"provider", "description"=>"The unique identifier of the provider"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Addons", "Provider", "Folders"]}}, "/nodes/{node_id}/children/"=>{"get"=>{"summary"=>"List all child nodes", "description"=>"A paginated list of the next level child nodes for the given node. The returned nodes are sorted by their `date_modified`, with the most recently updated child nodes appearing first.\n\nThe list will include child nodes that are public, as well as child nodes that are private, if the authenticated user has permission to view them.\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of up to 10 child nodes. If the given node has zero child nodes, the `data` key will contain an empty array. Each resource in the array is a separate node object and contains the full representation of the child node, meaning additional requests to the child node's detail view are not necessary.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n\nThis request should never return an error.\n#### Filtering\nYou can optionally request that the response only include nodes that match your filters by utilizing the `filter` query parameter, e.g. https://api.osf.io/v2/nodes/ezcuj/children/?filter[title]=reproducibility.\n\nNodes may be filtered by their `id`, `title`, `category`, `description`, `public`, `tags`, `date_created`, `date_modified`, `root`, `parent`, `preprint`, and `contributors`.\n\nMost fields are string fields and will be filtered using simple substring matching. Public and preprint are boolean fields, and can be filtered using truthy values, such as **true**, **false**, **0** or **1**. Note that quoting true or false in the query will cause the match to fail.", "operationId"=>"nodes_children_list", "x-api-path-slug"=>"nodesnode-idchildren-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Children"]}, "post"=>{"summary"=>"Create a child node", "description"=>"Creates a new child node.\n\nNote: Creating a child node via this endpoint will function the same as creating a node via the node list endpoint, but the child node will have the given node set as its parent.\n#### Permissions\nOnly write contributors may create children nodes.\n#### Required\nRequired fields for creating a node include:\n\n `title`\n\n `category`\n\nNote: nodes default to **private** unless the `public` field is explicitly set to **true** in the request payload.\n#### Returns\nReturns a JSON object with a `data` key containing the representation of the created node, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_children_create", "x-api-path-slug"=>"nodesnode-idchildren-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Children"]}}, "/nodes/{node_id}/citation/"=>{"get"=>{"summary"=>"Retrieve citation details", "description"=>"The citation details for a node, in CSL format.\n#### Returns\nReturns a JSON object with a `data` key that contains the representation of the details necessary for the node citation.", "operationId"=>"nodes_citation_list", "x-api-path-slug"=>"nodesnode-idcitation-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Citation"]}}, "/nodes/{node_id}/citation/{style_id}/"=>{"get"=>{"summary"=>"Retrieve a styled citation", "description"=>"The citation for a node in a specific style.\n#### Returns\nReturns a JSON object with a `data` key that contains the representation of the node citation, in the requested style.", "operationId"=>"nodes_citation_read", "x-api-path-slug"=>"nodesnode-idcitationstyle-id-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}, {"in"=>"path", "name"=>"style_id", "description"=>"The unique identifier of the citation style"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Citation", "Style"]}}, "/nodes/{node_id}/comments/"=>{"get"=>{"summary"=>"List all comments", "description"=>"A paginated list of comments related to a given node.\n\nThe returned comments are sorted by their creation date, with the most recent comments appearing first.\n####Permissions\nComments on public nodes are given read-only access to everyone.\n\nIf the node comment-level is `private`, only contributors have permission to comment.\n\nIf the comment-level is `public`, any logged-in OSF user can comment.\n\nComments on private nodes are only visible to contributors and administrators on the parent node.\n####Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of comment objects. Each resource in the array is a separate comment object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n#### Filtering\nYou can optionally request that the response only include comments that match your filters by utilizing the `filter` query parameter, e.g. https://api.osf.io/v2/nodes/ezcuj/comments/?filter[target_id]=jg7sezmdnt93\n\nNodes may be filtered by their `deleted`, `target_id`, `date_created`, `date_modified`.\n\nMost fields are string fields and will be filtered using simple substring matching. Public and preprint are boolean fields, and can be filtered using truthy values, such as **true**, **false**, **0** or **1**. Note that quoting `true` or `false` in the query will cause the match to fail.", "operationId"=>"nodes_comments_list", "x-api-path-slug"=>"nodesnode-idcomments-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Comments"]}, "post"=>{"summary"=>"Create a comment", "description"=>"Create a comment on a given node overview page or a reply to a comment on that node.\n\nTo create a comment on the node overview page, the target `type` would be \"nodes\" and the target `id` would be the node `id`.\n\nTo reply to a comment on this node, the target `type` would be \"comments\" and the target `id` would be the `id` of the comment to reply to.\n####Required\nA relationship object with a `data` key, containing the target (`comments` or `nodes`) type and a target `id` is required.\nIn addition, the `content` attribute describing the relationship between the node and the comment is required.\n####Returns\nReturns a JSON object with a data key containing the representation of the new comment, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_comment_create", "x-api-path-slug"=>"nodesnode-idcomments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node you want to comment on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Comments"]}}, "/nodes/{node_id}/contributors/"=>{"get"=>{"summary"=>"List all contributors", "description"=>"A paginated list of the node's contributors, sorted by their index.\n\nContributors are users who can make changes to the node or, in the case of private nodes, have read access to the node.\n\nContributors are categorized as either \"bibliographic\" or \"non-bibliographic\". From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed on the project overview page on the OSF, while non-bibliographic contributors are not.\n\nNote that if an anonymous view_only key is being used to view the list of contributors, the user relationship will not be exposed and the contributor ID will be an empty string.\n\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of 10 contributors. Each resource in the array contains the full representation of the contributor, meaning additional requests to a contributor's detail view are not necessary. Additionally, the full representation of the user this contributor represents is automatically embedded within the `data` key of the response.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n#### Filtering\nYou can optionally request that the response only include contributors that match your filters by utilizing the `filter` query parameter, e.g. https://api.osf.io/v2/nodes/y9jdt/contributors/?filter[bibliographic]=true.\n\nContributors may be filtered by their `bibliographic` and `permission` attributes.", "operationId"=>"nodes_contributors_list", "x-api-path-slug"=>"nodesnode-idcontributors-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Contributors"]}, "post"=>{"summary"=>"Create a contributor", "description"=>"Adds a contributor to a node, effectively creating a relationship between the node and a user.\n\nContributors are users who can make changes to the node or, in the case of private nodes, have read access to the node.\n\nContributors are categorized as either \"bibliographic\" or \"non-bibliographic\" contributors. From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed on the project overview page on the OSF, while non-bibliographic contributors are not.\n#### Permissions\nOnly project administrators can add contributors to a node.\n#### Required\nA relationship object with a `data` key, containing the `users` type and valid user ID is required.\n\nAll attributes describing the relationship between the node and the user are optional.\n#### Returns\nReturns a JSON object with a `data` key containing the representation of the new contributor, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_contributors_create", "x-api-path-slug"=>"nodesnode-idcontributors-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Contributors"]}}, "/nodes/{node_id}/contributors/{user_id}/"=>{"delete"=>{"summary"=>"Delete a contributor", "description"=>"Removes a contributor from a node. This request only removes the relationship between the node and the user, it does not delete the user itself.\n\nA node must always have at least one admin, and attempting to remove the only admin from a node will result in a **400 Bad Request** response.\n#### Permissions\nA user can remove themselves as a node contributor. Otherwise, only project administrators can remove contributors.\n#### Returns\nIf the request is successful, no content is returned.\n\nIf the request is unsuccessful, a JSON object with an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_contributors_delete", "x-api-path-slug"=>"nodesnode-idcontributorsuser-id-delete", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}, {"in"=>"path", "name"=>"user_id", "description"=>"The unique identifier of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Contributors", "User"]}, "get"=>{"summary"=>"Retrieve a contributor", "description"=>"Retrieves the details of a given contributor.\n\nContributors are users who can make changes to the node or, in the case of private nodes, have read access to the node.\n\nContributors are categorized as either \"bibliographic\" or \"non-bibliographic\". From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed on the project overview page on the OSF, while non-bibliographic contributors are not.\n#### Returns\nReturns a JSON object with a `data` key containing the representation of the requested contributor, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_contributors_read", "x-api-path-slug"=>"nodesnode-idcontributorsuser-id-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}, {"in"=>"path", "name"=>"user_id", "description"=>"The unique identifier of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Contributors", "User"]}, "patch"=>{"summary"=>"Update a contributor", "description"=>"Updates a contributor by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged.\n\nContributors can be updated with either a **PUT** or **PATCH** request. Since this endpoint has no mandatory attributes, PUT and PATCH are functionally the same.\n#### Permissions\nOnly project administrators can update the contributors on a node.\n#### Returns\nReturns a JSON object with a `data` key containing the new representation of the updated contributor, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.\n\nIf the given user is not already in the contributor list, a 404 Not Found error will be returned. A node must always have at least one admin, and any attempt to downgrade the permissions of a sole admin will result in a 400 Bad Request error.", "operationId"=>"nodes_contributors_partial_update", "x-api-path-slug"=>"nodesnode-idcontributorsuser-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}, {"in"=>"path", "name"=>"user_id", "description"=>"The unique identifier of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Contributors", "User"]}}, "/nodes/{node_id}/draft_registrations/"=>{"get"=>{"summary"=>"List all draft registrations", "description"=>"A paginated list of all of the draft registrations of a given node.\n\nDraft registrations contain the supplemental registration questions that accompany a registration. A registration is a frozen version of the project that can never be edited or deleted, but can be withdrawn.\n\nYour original project remains editable but will now have the draft registration linked to it.\n#### Permissions\nOnly project administrators may view draft registrations.\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of 10 draft registrations. Each resource in the array is a separate draft registration object and contains the full representation of the draft registration, meaning additional requests to a draft registration's detail view are not necessary.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).", "operationId"=>"nodes_draft_registrations_list", "x-api-path-slug"=>"nodesnode-iddraft-registrations-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Draft", "Registrations"]}, "post"=>{"summary"=>"Create a draft registration", "description"=>"Initiate a draft registration of the current node.\nDraft registrations contain the supplemental registration questions that accompany a registration. A registration is a frozen version of the project that can never be edited or deleted, but can be withdrawn.\n\nYour original project remains editable but will now have the draft registration linked to it.\n#### Permissions\nOnly project administrators may view create registrations.\n#### Required\nRequired fields for creating a draft registration include:\n\n `registration_supplement`\n#### Returns\nReturns a JSON object with a `data` key containing the representation of the created draft registration, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_draft_registrations_create", "x-api-path-slug"=>"nodesnode-iddraft-registrations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Draft", "Registrations"]}}, "/nodes/{node_id}/draft_registrations/{draft_id}/"=>{"delete"=>{"summary"=>"Delete a draft registration", "description"=>"Permanently deletes a draft registration. A draft that has already been registered cannot be deleted.\n#### Permissions\nOnly project administrators may delete draft registrations.\n#### Returns\nIf the request is successful, no content is returned.\n\nIf the request is unsuccessful, a JSON object with an `errors` key containing information about the failure will be returned. Refer to the [list of error codes]() to understand why this request may have failed.", "operationId"=>"nodes_draft_registrations_delete", "x-api-path-slug"=>"nodesnode-iddraft-registrationsdraft-id-delete", "parameters"=>[{"in"=>"path", "name"=>"draft_id", "description"=>"The unique identifier of the draft registration"}, {"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Draft", "Registrations", "Draft"]}, "get"=>{"summary"=>"Retrieve a draft registration", "description"=>"Retrieve the details of a given draft registration.\nDraft registrations contain the supplemental registration questions that accompany a registration. A registration is a frozen version of the project that can never be edited or deleted, but can be withdrawn.\n\nYour original project remains editable but will now have the draft registration linked to it.\n#### Permissions\nOnly project administrators may view draft registrations.\n#### Returns\nReturns a JSON object with a `data` key containing the representation of the requested draft registration, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_draft_registrations_read", "x-api-path-slug"=>"nodesnode-iddraft-registrationsdraft-id-get", "parameters"=>[{"in"=>"path", "name"=>"draft_id", "description"=>"The unique identifier of the draft registration"}, {"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Draft", "Registrations", "Draft"]}, "patch"=>{"summary"=>"Update a draft registration", "description"=>"Updates a draft registration by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged.\n\nDraft registrations contain the supplemental registration questions that accompany a registration. Answer the questions in the draft registration supplement by sending update requests until you are ready to submit the draft.\n\nThe registration supplement of a draft registration cannot be updated after the draft has been created.\n\nWhen updating a draft registration, `registration_metadata` is required. It must be a dictionary with keys as question ids in the registration form, and values as nested dictionaries matching the specific format in the [registration schema](TODO: link me pls).\n\nIf a question is multiple-choice, the question response must exactly match one of the possible choices.\n#### Permissions\nOnly project administrators may update draft registrations.\n#### Returns\nReturns a JSON object with a `data` key containing the new representation of the updated draft registration, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_draft_registrations_partial_update", "x-api-path-slug"=>"nodesnode-iddraft-registrationsdraft-id-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"draft_id", "description"=>"The unique identifier of the draft registration"}, {"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Draft", "Registrations", "Draft"]}}, "/nodes/{node_id}/files/"=>{"get"=>{"summary"=>"List all storage providers", "description"=>"List of all storage providers that are configured for this node\n\nUsers of the OSF may access their data on a [number of cloud-storage services](https://api.osf.io/v2/#storage-providers) that have integrations with the OSF. We call these **providers**. By default, every node has access to the OSF-provided storage but may use as many of the supported providers as desired.\n\n\n####Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of files. Each resource in the array is a separate file object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n\nNote: In the OSF filesystem model, providers are treated as folders, but with special properties that distinguish them from regular folders. Every provider folder is considered a root folder, and may not be deleted through the regular file API.", "operationId"=>"nodes_providers_list", "x-api-path-slug"=>"nodesnode-idfiles-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Files"]}}, "/nodes/{node_id}/files/providers/{provider}/"=>{"get"=>{"summary"=>"Retrieve a storage provider", "description"=>"Retrieves the details of a storage provider enabled on this node.\n####Returns\nReturns a JSON object with a `data` key containing the representation of the requested file object, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_providers_read", "x-api-path-slug"=>"nodesnode-idfilesprovidersprovider-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}, {"in"=>"path", "name"=>"provider", "description"=>"The unique identifier of the storage provider"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Files", "Providers", "Provider"]}}, "/nodes/{node_id}/files/{provider}/"=>{"get"=>{"summary"=>"List all node files", "description"=>"List of all the files/folders that are attached to your project for a given storage provider.\n####Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of files. Each resource in the array is a separate file object and contains the full representation of the file.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n\n####Filtering\n\nYou can optionally request that the response only include files that match your filters by utilizing the `filter` query parameter, e.g. https://api.osf.io/v2/nodes/ezcuj/files/osfstorage/?filter[kind]=file\n\nNode files may be filtered by `id`, `name`, `node`, `kind`, `path`, `provider`, `size`, and `last_touched`.\n\n###Waterbutler API actions\n\nFiles can be modified through the Waterbutler API routes found in `links` (`new_folder`, `move`, `upload`, `download`, and `delete`).\n\n#### Download (files)\n\nTo download a file, issue a GET request against the download link. The response will have the Content-Disposition header set, which will will trigger a download in a browser.\n\n#### Create Subfolder (folders)\n\nYou can create a subfolder of an existing folder by issuing a PUT request against the new_folder link. The ?kind=folder portion of the query parameter is already included in the new_folder link. The name of the new subfolder should be provided in the name query parameter. The response will contain a WaterButler folder entity. If a folder with that name already exists in the parent directory, the server will return a 409 Conflict error response.\n\n#### Upload New File (folders)\n\nTo upload a file to a folder, issue a PUT request to the folder's upload link with the raw file data in the request body, and the kind and name query parameters set to 'file' and the desired name of the file. The response will contain a WaterButler file entity that describes the new file. If a file with the same name already exists in the folder, the server will return a 409 Conflict error response.\n\n#### Update Existing File (file)\n\nTo update an existing file, issue a PUT request to the file's upload link with the raw file data in the request body and the kind query parameter set to \"file\". The update action will create a new version of the file. The response will contain a WaterButler file entity that describes the updated file.\n\n#### Rename (files, folders)\n\nTo rename a file or folder, issue a POST request to the move link with the action body parameter set to \"rename\" and the rename body parameter set to the desired name. The response will contain either a folder entity or file entity with the new name.\n\n#### Move & Copy (files, folders)\n\nMove and copy actions both use the same request structure, a POST to the move url, but with different values for the action body parameters. The path parameter is also required and should be the OSF path attribute of the folder being written to. The rename and conflict parameters are optional. If you wish to change the name of the file or folder at its destination, set the rename parameter to the new name. The conflict param governs how name clashes are resolved. Possible values are replace and keep. replace is the default and will overwrite the file that already exists in the target folder. keep will attempt to keep both by adding a suffix to the new file's name until it no longer conflicts. The suffix will be ' (x)' where x is a increasing integer starting from 1. This behavior is intended to mimic that of the OS X Finder. The response will contain either a folder entity or file entity with the new name.\nFiles and folders can also be moved between nodes and providers. The resource parameter is the id of the node under which the file/folder should be moved. It must agree with the path parameter, that is the path must identify a valid folder under the node identified by resource. Likewise, the provider parameter may be used to move the file/folder to another storage provider, but both the resource and path parameters must belong to a node and folder already extant on that provider. Both resource and provider default to the current node and providers.\nIf a moved/copied file is overwriting an existing file, a 200 OK response will be returned. Otherwise, a 201 Created will be returned.\n\n#### Delete (file, folders)\n\nTo delete a file or folder send a DELETE request to the delete link. Nothing will be returned in the response body.", "operationId"=>"nodes_files_list", "x-api-path-slug"=>"nodesnode-idfilesprovider-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}, {"in"=>"path", "name"=>"provider", "description"=>"The unique identifier of the storage provider"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Files", "Provider"]}}, "/nodes/{node_id}/files/{provider}/{path}/"=>{"get"=>{"summary"=>"Retrieve a file", "description"=>"Retrieves the details of a file attached to given node (project or component) for the given storage provider.\n####Returns\nReturns a JSON object with a `data` key containing the representation of the requested file object, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_files_read", "x-api-path-slug"=>"nodesnode-idfilesproviderpath-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}, {"in"=>"path", "name"=>"path", "description"=>"The unique identifier of the file path"}, {"in"=>"path", "name"=>"provider", "description"=>"The unique identifier of the storage provider"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Files", "Provider", "Path"]}}, "/nodes/{node_id}/forks/"=>{"get"=>{"summary"=>"List all forks of this node", "description"=>"A paginated list of the current node's forks. The returned fork nodes are sorted by their `forked_date`, with the most recently forked nodes appearing first.\n\nForking a project creates a copy of an existing node and all of its contents. The fork always points back to the original node, forming a network of nodes.\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of up to 10 forked nodes. If the current node has zero forked nodes, the `data` key will contain an empty array. Each resource in the array is a separate node object and contains the full representation of the forked node, meaning additional requests to the forked node's detail view are not necessary.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n\nThis request should never return an error.", "operationId"=>"nodes_forks_list", "x-api-path-slug"=>"nodesnode-idforks-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Forks"]}, "post"=>{"summary"=>"Create a fork of this node", "description"=>"Creates a fork of the given node.\n\nForking a project creates a copy of an existing node and all of its contents. The fork always points back to the original node, forming a network of nodes.\n\nYou might use a fork to copy another's work to build on and extend. For example, a professor may create an OSF project of materials for individual student use. Each student forks the project to have his or her own copy of the materials to start his/her own work.\n\nWhen creating a fork, your fork will only contain public components of the current node and components for which you are a contributor. Private components that you do not have access to will not be forked.\n#### Required\nThere are no required attributes when creating a fork, as all of the forked node's attributes will be copied from the current node.\n\nThe `title` field is optional, with the default title being \"Fork of \" prepended to the current node's title.\n#### Returns\nReturns a JSON object with a `data` key containing the complete srepresentation of the forked node, if the request is successful.\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.", "operationId"=>"nodes_forks_create", "x-api-path-slug"=>"nodesnode-idforks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Forks"]}}, "/nodes/{node_id}/identifiers/"=>{"get"=>{"summary"=>"List all identifiers", "description"=>"List all identifiers associated with a given node.\n####Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of identifiers. Each resource in the array is a separate identifier object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n####Filtering\n\nYou can optionally request that the response only include nodes that match your filters by utilizing the `filter` query parameter, e.g. https://api.osf.io/v2/nodes/ezcuj/identifiers/?filter[category]=ark\n\nIdentifiers may be filtered by their `category` e.g `ark` or `doi`.", "operationId"=>"nodes_identifiers_list", "x-api-path-slug"=>"nodesnode-ididentifiers-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Nodeentifiers"]}}, "/nodes/{node_id}/institutions/"=>{"get"=>{"summary"=>"List all institutions", "description"=>"List of all institutions affiliated with this node.\n####Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of up to 10 affilited institutions. Each resource in the array is a separate institution object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).", "operationId"=>"nodes_institutions_list", "x-api-path-slug"=>"nodesnode-idinstitutions-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Institutions"]}}, "/nodes/{node_id}/linked_nodes/"=>{"get"=>{"summary"=>"List all linked nodes", "description"=>"List of all nodes linked to the given node.\n####Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of up to 10 nodes. Each resource in the array is a separate node object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n####Filtering\nYou can optionally request that the response only include nodes that match your filters by utilizing the `filter` query parameter, e.g. https://api.osf.io/v2/nodes/?filter[title]=reproducibility.\n\nNodes may be filtered by their `title`, `category`, `description`, `public`, `registration`, or `tags`. `title`, `description`, and `category` are string fields and will be filteres using simple substring matching. `public`, `registration` are boolean and can be filtered using truthy values, such as `true`, `false`, `0`, `1`. `tags` is an array of simple strings.", "operationId"=>"nodes_linked_nodes_list", "x-api-path-slug"=>"nodesnode-idlinked-nodes-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Linked", "Nodes"]}}, "/nodes/{node_id}/logs/"=>{"get"=>{"summary"=>"List all logs", "description"=>"A paginated list of all logs associated with a given node.\n\nThe returned logs are sorted by their `date`, with the most recents logs appearing first.\n\nThis list includes the logs of the specified node as well as the logs of that node's children to which the current user has read-only access.\n\n####Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of up to 10 logs. Each resource in the array is a separate logs object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n####Filtering\nYou can optionally request that the response only include logs that match your filters by utilizing the `filter` query parameter, e.g. https://api.osf.io/v2/nodes/ezcuj/logs/?filter[action]=made_private.\n\nNodes may be filtered by their `action`, and `date`.", "operationId"=>"nodes_logs_list", "x-api-path-slug"=>"nodesnode-idlogs-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Logs"]}}, "/nodes/{node_id}/preprints/"=>{"get"=>{"summary"=>"List all preprints", "description"=>"A paginated list of preprints related to a given node. The returned preprints are sorted by their creation date, with the most recent preprints appearing first.\n\n**Note: This API endpoint is under active development, and is subject to change in the future.**\n#### Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of up to 10 preprints. Each resource in the array is a separate preprint object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).", "operationId"=>"nodes_preprints_list", "x-api-path-slug"=>"nodesnode-idpreprints-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Preprints"]}}, "/nodes/{node_id}/registrations/"=>{"get"=>{"summary"=>"List all registrations", "description"=>"List of all registrations of the given node.\n####Returns\n\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of up to 10 registrations. Each resource in the array is a separate registrations object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n####Filtering\n\nYou can optionally request that the response only include registrations that match your filters by utilizing the filter query parameter, e.g. https://api.osf.io/v2/registrations/?filter[title]=open.\n\nRegistrations may be filtered by their `id`, `title`, `category`, `description`, `public`, `tags`, `date_created`, `date_modified`, `root`, `parent`, and `contributors`.", "operationId"=>"nodes_registrations_list", "x-api-path-slug"=>"nodesnode-idregistrations-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "Registrations"]}}, "/nodes/{node_id}/view_only_links/"=>{"get"=>{"summary"=>"List all view only links", "description"=>"List of view only links on a node.\n####Returns\nReturns a JSON object containing `data` and `links` keys.\n\nThe `data` key contains an array of up to 10 view only links. Each resource in the array is a view only link object.\n\nThe `links` key contains a dictionary of links that can be used for [pagination](#Introduction_pagination).\n\n####Permissions\n\nView only links on a node, public or private, are readable and writeable only by users that are administrators on the node.\n\n####Filtering\n\nYou can optionally request that the response only include view only links that match your filters by utilizing the `filter` query parameter, e.g. https://api.osf.io/v2/nodes/ezcuj/view_only_links/?filter[anonymous]=true.\n\nView Only Links may be filtered based on their `name`, `anonymous` and `date_created` fields. Possible comparison operators include 'gt' (greater than), 'gte'(greater than or equal to), 'lt' (less than) and 'lte' (less than or equal to). The date must be in the format YYYY-MM-DD and the time is optional.", "operationId"=>"nodes_view_only_links_list", "x-api-path-slug"=>"nodesnode-idview-only-links-get", "parameters"=>[{"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "View", "Only", "Links"]}}, "/nodes/{node_id}/view_only_links/{link_id}/"=>{"get"=>{"summary"=>"Retrieve a view only link", "description"=>"Retrieves the details of a view only link on a node.\n####Returns\nReturns a JSON object with a `data` key containing the representation of the requested view only link, if the request is successful.\n\nIf the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.\n####Permissions\n\nView only links on a node, public or private, are readable and writeable only by users that are administrators on the node.", "operationId"=>"nodes_view_only_links_read", "x-api-path-slug"=>"nodesnode-idview-only-linkslink-id-get", "parameters"=>[{"in"=>"path", "name"=>"link_id", "description"=>"The unique identifier of the view only link"}, {"in"=>"path", "name"=>"node_id", "description"=>"The unique identifier of the node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Node", "View", "Only", "Links", "Link"]}}, "/nodes/{node_id}/wikis/"=>{"get"=>{"summary"=>"List all wikis", "description"=>"List of wiki pages on a node.\n####Returns\nPaginated list of the node's current wiki page versions ordered by their date_modified. Each resource contains the full representation of the wiki, meaning additional requests to an individual wiki's detail view are not necessary.\n\nNote that if an anonymous view_only key is being used, the user relationship will not be exposed.\n\nIf the request is unsuccessful, a JSON object with an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#Introduction_error_codes) to understand why this request may have failed.\n#### Filtering\nWiki pages can be filtered based on their `name` and `date_modified` fields.\n+ `filter[name]= |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bandsintown{"bands-in-town-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bandsintown", "x-complete"=>1, "info"=>{"title"=>"Bandsintown API", "description"=>"the-bandsintown-api-is-designed-for-enterprise-partners-and-artists-with-websites-media-players-andor-mobile-applications-that-would-like-to-list-an-artists-events-and-provide-their-users-with-the-ability-to-buy-tickets-and-rsvp-to-these-events--it-offers-readonly-access-to-artist-info-and-artist-events-artist-info-returns-the-link-to-the-bandsintown-artist-page-the-link-to-the-artist-photo-the-current-number-of-trackers-and-more-artist-events-returns-the-list-of-upcoming-events-including-their-date-and-time-venue-name-and-location-ticket-links-lineup-description-and-the-link-to-the-bandsintown-event-page-", "contact"=>{"name"=>"Bandsintown", "url"=>"https://bandsintown.com/"}, "version"=>"1.0.0"}, "host"=>"rest.bandsintown.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/artists/{artistname}"=>{"get"=>{"summary"=>"Get artist information", "description"=>"Get artist information", "operationId"=>"artist", "x-api-path-slug"=>"artistsartistname-get", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"The application ID assigned to you by Bandsintown"}, {"in"=>"path", "name"=>"artistname", "description"=>"The name of the artist"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bands", "Music", "Concerts"]}}, "/artists/{artistname}/events"=>{"get"=>{"summary"=>"Get all upcoming artist events or all past and upcoming events within a date range", "description"=>"artist events", "operationId"=>"artistEvents", "x-api-path-slug"=>"artistsartistnameevents-get", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"The application ID assigned to you by Bandsintown"}, {"in"=>"path", "name"=>"artistname", "description"=>"The name of the artist"}, {"in"=>"query", "name"=>"date", "description"=>"Date range of requested shows e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bands", "Music", "Concerts"]}}}}, "apis"=>{"name"=>"Bandsintown", "x-slug"=>"bandsintown", "description"=>"Concert discovery has changed. Previously, fans would seek out concert dates, but with the rise of social media, fans now expect that information to come to them. Bandsintown simplifies concert discovery by allowing music fans to Track their favorite artists, see which shows they have RSVP’d to & share these shows with their friends. The concerts are then synced with their calendar, so fans are sure not to miss the show.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/bands_in_town_logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,Band,General Data,Profiles,Touring", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bandsintown/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Bands in Town", "x-api-slug"=>"bands-in-town", "description"=>"Concert discovery has changed. Previously, fans would seek out concert dates, but with the rise of social media, fans now expect that information to come to them. Bandsintown simplifies concert discovery by allowing music fans to Track their favorite artists, see which shows they have RSVP’d to & share these shows with their friends. The concerts are then synced with their calendar, so fans are sure not to miss the show.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/bands_in_town_logo.png", "humanURL"=>"http://news.bandsintown.com/home", "baseURL"=>"https://rest.bandsintown.com//", "tags"=>"API Provider,Band,General Data,Profiles,Touring", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bandsintown/artistsartistnameevents-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bandsintown/bands-in-town-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://blog.bandsintown.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.bandsintown.com/rss"}, {"type"=>"x-developer", "url"=>"http://www.bandsintown.com/api/overview"}, {"type"=>"x-github", "url"=>"https://github.com/bandsintown"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Bandsintown"}, {"type"=>"x-website", "url"=>"http://news.bandsintown.com/home"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-internet-of-things{"aws-internet-of-things-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Internet of Things", "x-complete"=>1, "info"=>{"title"=>"AWS Internet of Things API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AcceptCertificateTransfer"=>{"get"=>{"summary"=>"Accept Certificate Transfer", "description"=>"Accepts a pending certificate transfer.", "operationId"=>"acceptCertificateTransfer", "x-api-path-slug"=>"actionacceptcertificatetransfer-get", "parameters"=>[{"in"=>"query", "name"=>"certificateId", "description"=>"The ID of the certificate", "type"=>"string"}, {"in"=>"query", "name"=>"setAsActive", "description"=>"Specifies whether the certificate is active", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate Transfers"]}}, "/?Action=AttachPrincipalPolicy"=>{"get"=>{"summary"=>"Attach Principal Policy", "description"=>"Attaches the specified policy to the specified principal (certificate or other credential).", "operationId"=>"attachPrincipalPolicy", "x-api-path-slug"=>"actionattachprincipalpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"policyName", "description"=>"The policy name", "type"=>"string"}, {"in"=>"query", "name"=>"principal", "description"=>"The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Principal Policies"]}}, "/?Action=AttachThingPrincipal"=>{"get"=>{"summary"=>"Attach Thing Principal", "description"=>"Attaches the specified principal to the specified thing.", "operationId"=>"attachThingPrincipal", "x-api-path-slug"=>"actionattachthingprincipal-get", "parameters"=>[{"in"=>"query", "name"=>"principal", "description"=>"The principal, such as a certificate or other credential", "type"=>"string"}, {"in"=>"query", "name"=>"thingName", "description"=>"The name of the thing", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thing Principals"]}}, "/?Action=CancelCertificateTransfer"=>{"get"=>{"summary"=>"Cancel Certificate Transfer", "description"=>"Cancels a pending transfer for the specified certificate.", "operationId"=>"cancelCertificateTransfer", "x-api-path-slug"=>"actioncancelcertificatetransfer-get", "parameters"=>[{"in"=>"query", "name"=>"certificateId", "description"=>"The ID of the certificate", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate Transfers"]}}, "/?Action=CreateCertificateFromCsr"=>{"get"=>{"summary"=>"Create Certificate From Csr", "description"=>"Creates an X.", "operationId"=>"createCertificateFromCsr", "x-api-path-slug"=>"actioncreatecertificatefromcsr-get", "parameters"=>[{"in"=>"query", "name"=>"certificateSigningRequest", "description"=>"The certificate signing request (CSR)", "type"=>"string"}, {"in"=>"query", "name"=>"setAsActive", "description"=>"Specifies whether the certificate is active", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=CreateKeysAndCertificate"=>{"get"=>{"summary"=>"Create Keys And Certificate", "description"=>"Creates a 2048-bit RSA key pair and issues an X.", "operationId"=>"createKeysAndCertificate", "x-api-path-slug"=>"actioncreatekeysandcertificate-get", "parameters"=>[{"in"=>"query", "name"=>"setAsActive", "description"=>"Specifies whether the certificate is active", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keys And Certificates"]}}, "/?Action=CreatePolicy"=>{"get"=>{"summary"=>"Create Policy", "description"=>"Creates an AWS IoT policy.", "operationId"=>"createPolicy", "x-api-path-slug"=>"actioncreatepolicy-get", "parameters"=>[{"in"=>"query", "name"=>"policyDocument", "description"=>"The JSON document that describes the policy", "type"=>"string"}, {"in"=>"query", "name"=>"policyName", "description"=>"The policy name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=CreatePolicyVersion"=>{"get"=>{"summary"=>"Create Policy Version", "description"=>"Creates a new version of the specified AWS IoT policy.", "operationId"=>"createPolicyVersion", "x-api-path-slug"=>"actioncreatepolicyversion-get", "parameters"=>[{"in"=>"query", "name"=>"policyDocument", "description"=>"The JSON document that describes the policy", "type"=>"string"}, {"in"=>"query", "name"=>"policyName", "description"=>"The policy name", "type"=>"string"}, {"in"=>"query", "name"=>"setAsDefault", "description"=>"Specifies whether the policy version is set as the default", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=CreateThing"=>{"get"=>{"summary"=>"Create Thing", "description"=>"Creates a thing record in the thing registry.", "operationId"=>"createThing", "x-api-path-slug"=>"actioncreatething-get", "parameters"=>[{"in"=>"query", "name"=>"attributePayload", "description"=>"The attribute payload, which consists of up to three name/value pairs in a JSON document", "type"=>"string"}, {"in"=>"query", "name"=>"thingName", "description"=>"The name of the thing to create", "type"=>"string"}, {"in"=>"query", "name"=>"thingTypeName", "description"=>"The name of the thing type associated with the new thing", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Things"]}}, "/?Action=CreateThingType"=>{"get"=>{"summary"=>"Create Thing Type", "description"=>"Creates a new thing type.", "operationId"=>"createThingType", "x-api-path-slug"=>"actioncreatethingtype-get", "parameters"=>[{"in"=>"query", "name"=>"thingTypeName", "description"=>"The name of the thing type", "type"=>"string"}, {"in"=>"query", "name"=>"thingTypeProperties", "description"=>"The ThingTypeProperties for the thing type to create", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thing Types"]}}, "/?Action=CreateTopicRule"=>{"get"=>{"summary"=>"Create Topic Rule", "description"=>"Creates a rule.", "operationId"=>"createTopicRule", "x-api-path-slug"=>"actioncreatetopicrule-get", "parameters"=>[{"in"=>"query", "name"=>"ruleName", "description"=>"The name of the rule", "type"=>"string"}, {"in"=>"query", "name"=>"topicRulePayload", "description"=>"The rule payload", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topic Rules"]}}, "/?Action=DeleteCACertificate"=>{"get"=>{"summary"=>"Delete C A Certificate", "description"=>"Deletes a registered CA certificate.", "operationId"=>"deleteCACertificate", "x-api-path-slug"=>"actiondeletecacertificate-get", "parameters"=>[{"in"=>"query", "name"=>"certificateId", "description"=>"The ID of the certificate to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CA Certificates"]}}, "/?Action=DeleteCertificate"=>{"get"=>{"summary"=>"Delete Certificate", "description"=>"Deletes the specified certificate.", "operationId"=>"deleteCertificate", "x-api-path-slug"=>"actiondeletecertificate-get", "parameters"=>[{"in"=>"query", "name"=>"certificateId", "description"=>"The ID of the certificate", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=DeletePolicy"=>{"get"=>{"summary"=>"Delete Policy", "description"=>"Deletes the specified policy.", "operationId"=>"deletePolicy", "x-api-path-slug"=>"actiondeletepolicy-get", "parameters"=>[{"in"=>"query", "name"=>"policyName", "description"=>"The name of the policy to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=DeletePolicyVersion"=>{"get"=>{"summary"=>"Delete Policy Version", "description"=>"Deletes the specified version of the specified policy.", "operationId"=>"deletePolicyVersion", "x-api-path-slug"=>"actiondeletepolicyversion-get", "parameters"=>[{"in"=>"query", "name"=>"policyName", "description"=>"The name of the policy", "type"=>"string"}, {"in"=>"query", "name"=>"policyVersionId", "description"=>"The policy version ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=DeleteRegistrationCode"=>{"get"=>{"summary"=>"Delete Registration Code", "description"=>"Deletes a CA certificate registration code.", "operationId"=>"deleteRegistrationCode", "x-api-path-slug"=>"actiondeleteregistrationcode-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registration Codes"]}}, "/?Action=DeleteThing"=>{"get"=>{"summary"=>"Delete Thing", "description"=>"Deletes the specified thing.", "operationId"=>"deleteThing", "x-api-path-slug"=>"actiondeletething-get", "parameters"=>[{"in"=>"query", "name"=>"expectedVersion", "description"=>"The expected version of the thing record in the registry", "type"=>"string"}, {"in"=>"query", "name"=>"thingName", "description"=>"The name of the thing to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Things"]}}, "/?Action=DeleteThingType"=>{"get"=>{"summary"=>"Delete Thing Type", "description"=>"Deletes the specified thing type.", "operationId"=>"deleteThingType", "x-api-path-slug"=>"actiondeletethingtype-get", "parameters"=>[{"in"=>"query", "name"=>"thingTypeName", "description"=>"The name of the thing type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thing Types"]}}, "/?Action=DeleteTopicRule"=>{"get"=>{"summary"=>"Delete Topic Rule", "description"=>"Deletes the specified rule.", "operationId"=>"deleteTopicRule", "x-api-path-slug"=>"actiondeletetopicrule-get", "parameters"=>[{"in"=>"query", "name"=>"ruleName", "description"=>"The name of the rule", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topic Rules"]}}, "/?Action=DeprecateThingType"=>{"get"=>{"summary"=>"Deprecate Thing Type", "description"=>"Deprecates a thing type.", "operationId"=>"deprecateThingType", "x-api-path-slug"=>"actiondeprecatethingtype-get", "parameters"=>[{"in"=>"query", "name"=>"thingTypeName", "description"=>"The name of the thing type to deprecate", "type"=>"string"}, {"in"=>"query", "name"=>"undoDeprecate", "description"=>"Whether to undeprecate a deprecated thing type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thing Types"]}}, "/?Action=DescribeCACertificate"=>{"get"=>{"summary"=>"Describe C A Certificate", "description"=>"Describes a registered CA certificate.", "operationId"=>"describeCACertificate", "x-api-path-slug"=>"actiondescribecacertificate-get", "parameters"=>[{"in"=>"query", "name"=>"certificateId", "description"=>"The CA certificate identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CA Certificates"]}}, "/?Action=DescribeCertificate"=>{"get"=>{"summary"=>"Describe Certificate", "description"=>"Gets information about the specified certificate.", "operationId"=>"describeCertificate", "x-api-path-slug"=>"actiondescribecertificate-get", "parameters"=>[{"in"=>"query", "name"=>"certificateId", "description"=>"The ID of the certificate", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=DescribeEndpoint"=>{"get"=>{"summary"=>"Describe Endpoint", "description"=>"Returns a unique endpoint specific to the AWS account making the call.", "operationId"=>"describeEndpoint", "x-api-path-slug"=>"actiondescribeendpoint-get", "parameters"=>[{"in"=>"query", "name"=>"endpointAddress", "description"=>"The endpoint", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoints"]}}, "/?Action=DescribeThing"=>{"get"=>{"summary"=>"Describe Thing", "description"=>"Gets information about the specified thing.", "operationId"=>"describeThing", "x-api-path-slug"=>"actiondescribething-get", "parameters"=>[{"in"=>"query", "name"=>"thingName", "description"=>"The name of the thing", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Things"]}}, "/?Action=DescribeThingType"=>{"get"=>{"summary"=>"Describe Thing Type", "description"=>"Gets information about the specified thing type.", "operationId"=>"describeThingType", "x-api-path-slug"=>"actiondescribethingtype-get", "parameters"=>[{"in"=>"query", "name"=>"thingTypeName", "description"=>"The name of the thing type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thing Types"]}}, "/?Action=DetachPrincipalPolicy"=>{"get"=>{"summary"=>"Detach Principal Policy", "description"=>"Removes the specified policy from the specified certificate.", "operationId"=>"detachPrincipalPolicy", "x-api-path-slug"=>"actiondetachprincipalpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"policyName", "description"=>"The name of the policy to detach", "type"=>"string"}, {"in"=>"query", "name"=>"principal", "description"=>"The principal", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Principal Policies"]}}, "/?Action=DetachThingPrincipal"=>{"get"=>{"summary"=>"Detach Thing Principal", "description"=>"Detaches the specified principal from the specified thing.", "operationId"=>"detachThingPrincipal", "x-api-path-slug"=>"actiondetachthingprincipal-get", "parameters"=>[{"in"=>"query", "name"=>"principal", "description"=>"If the principal is a certificate, this value must be ARN of the certificate", "type"=>"string"}, {"in"=>"query", "name"=>"thingName", "description"=>"The name of the thing", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thing Principals"]}}, "/?Action=DisableTopicRule"=>{"get"=>{"summary"=>"Disable Topic Rule", "description"=>"Disables the specified rule.", "operationId"=>"disableTopicRule", "x-api-path-slug"=>"actiondisabletopicrule-get", "parameters"=>[{"in"=>"query", "name"=>"ruleName", "description"=>"The name of the rule to disable", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topic Rules"]}}, "/?Action=EnableTopicRule"=>{"get"=>{"summary"=>"Enable Topic Rule", "description"=>"Enables the specified rule.", "operationId"=>"enableTopicRule", "x-api-path-slug"=>"actionenabletopicrule-get", "parameters"=>[{"in"=>"query", "name"=>"ruleName", "description"=>"The name of the topic rule to enable", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topic Rules"]}}, "/?Action=GetLoggingOptions"=>{"get"=>{"summary"=>"Get Logging Options", "description"=>"Gets the logging options.", "operationId"=>"getLoggingOptions", "x-api-path-slug"=>"actiongetloggingoptions-get", "parameters"=>[{"in"=>"query", "name"=>"logLevel", "description"=>"The logging level", "type"=>"string"}, {"in"=>"query", "name"=>"roleArn", "description"=>"The ARN of the IAM role that grants access", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logging Options"]}}, "/?Action=GetPolicy"=>{"get"=>{"summary"=>"Get Policy", "description"=>"Gets information about the specified policy with the policy document of the default version.", "operationId"=>"getPolicy", "x-api-path-slug"=>"actiongetpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"policyName", "description"=>"The name of the policy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=GetPolicyVersion"=>{"get"=>{"summary"=>"Get Policy Version", "description"=>"Gets information about the specified policy version.", "operationId"=>"getPolicyVersion", "x-api-path-slug"=>"actiongetpolicyversion-get", "parameters"=>[{"in"=>"query", "name"=>"policyName", "description"=>"The name of the policy", "type"=>"string"}, {"in"=>"query", "name"=>"policyVersionId", "description"=>"The policy version ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=GetRegistrationCode"=>{"get"=>{"summary"=>"Get Registration Code", "description"=>"Gets a registration code used to register a CA certificate with AWS IoT.", "operationId"=>"getRegistrationCode", "x-api-path-slug"=>"actiongetregistrationcode-get", "parameters"=>[{"in"=>"query", "name"=>"registrationCode", "description"=>"The CA certificate registration code", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registration Codes"]}}, "/?Action=GetTopicRule"=>{"get"=>{"summary"=>"Get Topic Rule", "description"=>"Gets information about the specified rule.", "operationId"=>"getTopicRule", "x-api-path-slug"=>"actiongettopicrule-get", "parameters"=>[{"in"=>"query", "name"=>"ruleName", "description"=>"The name of the rule", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topic Rules"]}}, "/?Action=ListCACertificates"=>{"get"=>{"summary"=>"List C A Certificates", "description"=>"Lists the CA certificates registered for your AWS account.", "operationId"=>"listCACertificates", "x-api-path-slug"=>"actionlistcacertificates-get", "parameters"=>[{"in"=>"query", "name"=>"ascendingOrder", "description"=>"Determines the order of the results", "type"=>"string"}, {"in"=>"query", "name"=>"marker", "description"=>"The marker for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The result page size", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CA Certificates"]}}, "/?Action=ListCertificates"=>{"get"=>{"summary"=>"List Certificates", "description"=>"Lists the certificates registered in your AWS account.", "operationId"=>"listCertificates", "x-api-path-slug"=>"actionlistcertificates-get", "parameters"=>[{"in"=>"query", "name"=>"ascendingOrder", "description"=>"Specifies the order for results", "type"=>"string"}, {"in"=>"query", "name"=>"marker", "description"=>"The marker for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The result page size", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=ListCertificatesByCA"=>{"get"=>{"summary"=>"List Certificates By C A", "description"=>"List the device certificates signed by the specified CA certificate.", "operationId"=>"listCertificatesByCA", "x-api-path-slug"=>"actionlistcertificatesbyca-get", "parameters"=>[{"in"=>"query", "name"=>"ascendingOrder", "description"=>"Specifies the order for results", "type"=>"string"}, {"in"=>"query", "name"=>"caCertificateId", "description"=>"The ID of the CA certificate", "type"=>"string"}, {"in"=>"query", "name"=>"marker", "description"=>"The marker for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The result page size", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CA Certificates"]}}, "/?Action=ListOutgoingCertificates"=>{"get"=>{"summary"=>"List Outgoing Certificates", "description"=>"Lists certificates that are being transfered but not yet accepted.", "operationId"=>"listOutgoingCertificates", "x-api-path-slug"=>"actionlistoutgoingcertificates-get", "parameters"=>[{"in"=>"query", "name"=>"ascendingOrder", "description"=>"Specifies the order for results", "type"=>"string"}, {"in"=>"query", "name"=>"marker", "description"=>"The marker for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The result page size", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=ListPolicies"=>{"get"=>{"summary"=>"List Policies", "description"=>"Lists your policies.", "operationId"=>"listPolicies", "x-api-path-slug"=>"actionlistpolicies-get", "parameters"=>[{"in"=>"query", "name"=>"ascendingOrder", "description"=>"Specifies the order for results", "type"=>"string"}, {"in"=>"query", "name"=>"marker", "description"=>"The marker for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The result page size", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=ListPolicyPrincipals"=>{"get"=>{"summary"=>"List Policy Principals", "description"=>"Lists the principals associated with the specified policy.", "operationId"=>"listPolicyPrincipals", "x-api-path-slug"=>"actionlistpolicyprincipals-get", "parameters"=>[{"in"=>"query", "name"=>"ascendingOrder", "description"=>"Specifies the order for results", "type"=>"string"}, {"in"=>"query", "name"=>"marker", "description"=>"The marker for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The result page size", "type"=>"string"}, {"in"=>"query", "name"=>"policyName", "description"=>"The policy name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Principals"]}}, "/?Action=ListPolicyVersions"=>{"get"=>{"summary"=>"List Policy Versions", "description"=>"Lists the versions of the specified policy and identifies the default version.", "operationId"=>"listPolicyVersions", "x-api-path-slug"=>"actionlistpolicyversions-get", "parameters"=>[{"in"=>"query", "name"=>"policyName", "description"=>"The policy name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Versions"]}}, "/?Action=ListPrincipalPolicies"=>{"get"=>{"summary"=>"List Principal Policies", "description"=>"Lists the policies attached to the specified principal.", "operationId"=>"listPrincipalPolicies", "x-api-path-slug"=>"actionlistprincipalpolicies-get", "parameters"=>[{"in"=>"query", "name"=>"ascendingOrder", "description"=>"Specifies the order for results", "type"=>"string"}, {"in"=>"query", "name"=>"marker", "description"=>"The marker for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The result page size", "type"=>"string"}, {"in"=>"query", "name"=>"principal", "description"=>"The principal", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Principal Policies"]}}, "/?Action=ListPrincipalThings"=>{"get"=>{"summary"=>"List Principal Things", "description"=>"Lists the things associated with the specified principal.", "operationId"=>"listPrincipalThings", "x-api-path-slug"=>"actionlistprincipalthings-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results to return in this operation", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The token for the next set of results, or null if there are no additional results", "type"=>"string"}, {"in"=>"query", "name"=>"principal", "description"=>"The principal", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Principal Things"]}}, "/?Action=ListThingPrincipals"=>{"get"=>{"summary"=>"List Thing Principals", "description"=>"Lists the principals associated with the specified thing.", "operationId"=>"listThingPrincipals", "x-api-path-slug"=>"actionlistthingprincipals-get", "parameters"=>[{"in"=>"query", "name"=>"thingName", "description"=>"The name of the thing", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thing Principals"]}}, "/?Action=ListThings"=>{"get"=>{"summary"=>"List Things", "description"=>"Lists your things.", "operationId"=>"listThings", "x-api-path-slug"=>"actionlistthings-get", "parameters"=>[{"in"=>"query", "name"=>"attributeName", "description"=>"The attribute name used to search for things", "type"=>"string"}, {"in"=>"query", "name"=>"attributeValue", "description"=>"The attribute value used to search for things", "type"=>"string"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results to return in this operation", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The token for the next set of results, or null if there are no additional results", "type"=>"string"}, {"in"=>"query", "name"=>"thingTypeName", "description"=>"The name of the thing type used to search for things", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Things"]}}, "/?Action=ListThingTypes"=>{"get"=>{"summary"=>"List Thing Types", "description"=>"Lists the existing thing types.", "operationId"=>"listThingTypes", "x-api-path-slug"=>"actionlistthingtypes-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results to return in this operation", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The token for the next set of results, or null if there are no additional results", "type"=>"string"}, {"in"=>"query", "name"=>"thingTypeName", "description"=>"The name of the thing type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thing Types"]}}, "/?Action=ListTopicRules"=>{"get"=>{"summary"=>"List Topic Rules", "description"=>"Lists the rules for the specific topic.", "operationId"=>"listTopicRules", "x-api-path-slug"=>"actionlisttopicrules-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results to return", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"A token used to retrieve the next value", "type"=>"string"}, {"in"=>"query", "name"=>"ruleDisabled", "description"=>"Specifies whether the rule is disabled", "type"=>"string"}, {"in"=>"query", "name"=>"topic", "description"=>"The topic", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topic Rules"]}}, "/?Action=RegisterCACertificate"=>{"get"=>{"summary"=>"Register C A Certificate", "description"=>"Registers a CA certificate with AWS IoT.", "operationId"=>"registerCACertificate", "x-api-path-slug"=>"actionregistercacertificate-get", "parameters"=>[{"in"=>"query", "name"=>"allowAutoRegistration", "description"=>"Allows this CA certificate to be used for auto registration of device certificates", "type"=>"string"}, {"in"=>"query", "name"=>"caCertificate", "description"=>"The CA certificate", "type"=>"string"}, {"in"=>"query", "name"=>"setAsActive", "description"=>"A boolean value that specifies if the CA certificate is set to active", "type"=>"string"}, {"in"=>"query", "name"=>"verificationCertificate", "description"=>"The private key verification certificate", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CA Certificates"]}}, "/?Action=RegisterCertificate"=>{"get"=>{"summary"=>"Register Certificate", "description"=>"Registers a device certificate with AWS IoT.", "operationId"=>"registerCertificate", "x-api-path-slug"=>"actionregistercertificate-get", "parameters"=>[{"in"=>"query", "name"=>"caCertificatePem", "description"=>"The CA certificate used to sign the device certificate being registered", "type"=>"string"}, {"in"=>"query", "name"=>"certificatePem", "description"=>"The certificate data, in PEM format", "type"=>"string"}, {"in"=>"query", "name"=>"setAsActive", "description"=>"A boolean value that specifies if the CA certificate is set to active", "type"=>"string"}, {"in"=>"query", "name"=>"status", "description"=>"The status of the register certificate request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=RejectCertificateTransfer"=>{"get"=>{"summary"=>"Reject Certificate Transfer", "description"=>"Rejects a pending certificate transfer.", "operationId"=>"rejectCertificateTransfer", "x-api-path-slug"=>"actionrejectcertificatetransfer-get", "parameters"=>[{"in"=>"query", "name"=>"certificateId", "description"=>"The ID of the certificate", "type"=>"string"}, {"in"=>"query", "name"=>"rejectReason", "description"=>"The reason the certificate transfer was rejected", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate Transfers"]}}, "/?Action=ReplaceTopicRule"=>{"get"=>{"summary"=>"Replace Topic Rule", "description"=>"Replaces the specified rule.", "operationId"=>"replaceTopicRule", "x-api-path-slug"=>"actionreplacetopicrule-get", "parameters"=>[{"in"=>"query", "name"=>"ruleName", "description"=>"The name of the rule", "type"=>"string"}, {"in"=>"query", "name"=>"topicRulePayload", "description"=>"The rule payload", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topic Rules"]}}, "/?Action=SetDefaultPolicyVersion"=>{"get"=>{"summary"=>"Set Default Policy Version", "description"=>"Sets the specified version of the specified policy as the policy's default (operative) version.", "operationId"=>"setDefaultPolicyVersion", "x-api-path-slug"=>"actionsetdefaultpolicyversion-get", "parameters"=>[{"in"=>"query", "name"=>"policyName", "description"=>"The policy name", "type"=>"string"}, {"in"=>"query", "name"=>"policyVersionId", "description"=>"The policy version ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/?Action=SetLoggingOptions"=>{"get"=>{"summary"=>"Set Logging Options", "description"=>"Sets the logging options.", "operationId"=>"setLoggingOptions", "x-api-path-slug"=>"actionsetloggingoptions-get", "parameters"=>[{"in"=>"query", "name"=>"loggingOptionsPayload", "description"=>"The logging options payload", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logging"]}}, "/?Action=TransferCertificate"=>{"get"=>{"summary"=>"Transfer Certificate", "description"=>"Transfers the specified certificate to the specified AWS account.", "operationId"=>"transferCertificate", "x-api-path-slug"=>"actiontransfercertificate-get", "parameters"=>[{"in"=>"query", "name"=>"certificateId", "description"=>"The ID of the certificate", "type"=>"string"}, {"in"=>"query", "name"=>"targetAwsAccount", "description"=>"The AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"transferMessage", "description"=>"The transfer message", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=UpdateCACertificate"=>{"get"=>{"summary"=>"Update C A Certificate", "description"=>"Updates a registered CA certificate.", "operationId"=>"updateCACertificate", "x-api-path-slug"=>"actionupdatecacertificate-get", "parameters"=>[{"in"=>"query", "name"=>"certificateId", "description"=>"The CA certificate identifier", "type"=>"string"}, {"in"=>"query", "name"=>"newAutoRegistrationStatus", "description"=>"The new value for the auto registration status", "type"=>"string"}, {"in"=>"query", "name"=>"newStatus", "description"=>"The updated status of the CA certificate", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CA Certificates"]}}, "/?Action=UpdateCertificate"=>{"get"=>{"summary"=>"Update Certificate", "description"=>"Updates the status of the specified certificate.", "operationId"=>"updateCertificate", "x-api-path-slug"=>"actionupdatecertificate-get", "parameters"=>[{"in"=>"query", "name"=>"certificateId", "description"=>"The ID of the certificate", "type"=>"string"}, {"in"=>"query", "name"=>"newStatus", "description"=>"The new status", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/?Action=UpdateThing"=>{"get"=>{"summary"=>"Update Thing", "description"=>"Updates the data for a thing.", "operationId"=>"updateThing", "x-api-path-slug"=>"actionupdatething-get", "parameters"=>[{"in"=>"query", "name"=>"attributePayload", "description"=>"A list of thing attributes, a JSON string containing name-value pairs", "type"=>"string"}, {"in"=>"query", "name"=>"expectedVersion", "description"=>"The expected version of the thing record in the registry", "type"=>"string"}, {"in"=>"query", "name"=>"removeThingType", "description"=>"Remove a thing type association", "type"=>"string"}, {"in"=>"query", "name"=>"thingName", "description"=>"The name of the thing to update", "type"=>"string"}, {"in"=>"query", "name"=>"thingTypeName", "description"=>"The name of the thing type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Things"]}}}}, "apis"=>{"name"=>"AWS Internet of Things", "x-slug"=>"aws-internet-of-things", "description"=>"AWS IoT is a managed cloud platform that lets connected devices easily and securely interact with cloud applications and other devices. AWS IoT can support billions of devices and trillions of messages, and can process and route those messages to AWS endpoints and to other devices reliably and securely. With AWS IoT, your applications can keep track of and communicate with all your devices, all the time, even when they aren’t connected.AWS IoT makes it easy to use AWS services like AWS Lambda, Amazon Kinesis, Amazon S3, Amazon Machine Learning, Amazon DynamoDB, Amazon CloudWatch, AWS CloudTrail, and Amazon Elasticsearch Service with built-in Kibana integration, to build IoT applications that gather, process, analyze and act on data generated by connected devices, without having to manage any infrastructure.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Internet-Of-Things_AWSIoT.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Devices,Internet of Things,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-internet-of-things/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Internet of Things API", "x-api-slug"=>"aws-internet-of-things-api", "description"=>"AWS IoT is a managed cloud platform that lets connected devices easily and securely interact with cloud applications and other devices. AWS IoT can support billions of devices and trillions of messages, and can process and route those messages to AWS endpoints and to other devices reliably and securely. With AWS IoT, your applications can keep track of and communicate with all your devices, all the time, even when they aren’t connected.AWS IoT makes it easy to use AWS services like AWS Lambda, Amazon Kinesis, Amazon S3, Amazon Machine Learning, Amazon DynamoDB, Amazon CloudWatch, AWS CloudTrail, and Amazon Elasticsearch Service with built-in Kibana integration, to build IoT applications that gather, process, analyze and act on data generated by connected devices, without having to manage any infrastructure.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Internet-Of-Things_AWSIoT.png", "humanURL"=>"https://aws.amazon.com/iot-platform/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Devices,Internet of Things,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-internet-of-things/aws-internet-of-things-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://aws.amazon.com/iot-platform/developer-resources/#Blog"}, {"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/cli/latest/reference/iot/index.html"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/iot/latest/apireference/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/iot/latest/developerguide/thing-shadow-rest-api.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/iot-platform/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/iot-platform/getting-started/"}, {"type"=>"x-how-it-works", "url"=>"https://aws.amazon.com/iot-platform/how-it-works/"}, {"type"=>"x-partners", "url"=>"https://aws.amazon.com/iot/partner-solutions/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/iot-platform/pricing/"}, {"type"=>"x-sdk", "url"=>"https://aws.amazon.com/iot-platform/developer-resources/#SDKs"}, {"type"=>"x-slides", "url"=>"https://aws.amazon.com/iot-platform/developer-resources/#Slides"}, {"type"=>"x-videos", "url"=>"https://aws.amazon.com/iot-platform/developer-resources/#Videos"}, {"type"=>"x-webinars", "url"=>"https://aws.amazon.com/iot-platform/developer-resources/#Webinars"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/iot-platform/"}, {"type"=>"x-white-papers", "url"=>"https://aws.amazon.com/iot-platform/developer-resources/#Whitepapers"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
arin{"point-of-contact-poc-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"ARIN", "x-complete"=>1, "info"=>{"title"=>"Point of Contact (POC) API", "description"=>"for-managing-point-of-contact-poc-", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/poc"=>{"get"=>{"summary"=>"Point of Contact (POC)", "description"=>"lists the Point of Contact (POC)", "operationId"=>"poc", "x-api-path-slug"=>"poc-get", "parameters"=>[{"in"=>"query", "name"=>"city", "description"=>"the city registered by the POC", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"company", "description"=>"the company name registered by the POC", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"domain", "description"=>"the domain of the email address for the POC", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"first", "description"=>"the first name of the POC", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"handle", "description"=>"the handle of the POC", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"last", "description"=>"the last name of the POC", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"middle", "description"=>"the middle name of the POC", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Point of Contact"]}}, "/poc/org"=>{"get"=>{"summary"=>"Organizations", "description"=>"lists the organizations associated with a given POC.", "operationId"=>"pocOrg", "x-api-path-slug"=>"pocorg-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}, "/poc/asns"=>{"get"=>{"summary"=>"ASNs", "description"=>"lists the ASNs associated with a given POC.", "operationId"=>"pocAsns", "x-api-path-slug"=>"pocasns-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ASN"]}}, "/poc/nets"=>{"get"=>{"summary"=>"Nets", "description"=>"lists the networks associated with a given POC.", "operationId"=>"pocNets", "x-api-path-slug"=>"pocnets-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nets"]}}}}, "reverse-dns-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"ARIN", "x-complete"=>1, "info"=>{"title"=>"Reverse DNS API", "description"=>"for-managing-reverse-dns-", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/rdns"=>{"get"=>{"summary"=>"Reverse DNS", "description"=>"", "operationId"=>"rdns", "x-api-path-slug"=>"rdns-get", "parameters"=>[{"in"=>"query", "name"=>"delegation name", "description"=>"the name of the delegation", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reverse DNS"]}}, "/rdns/nets"=>{"get"=>{"summary"=>"List Nets", "description"=>"lists networks related to a give delegation.", "operationId"=>"rdnsNets", "x-api-path-slug"=>"rdnsnets-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RDNS"]}}}}, "organization-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"ARIN", "x-complete"=>1, "info"=>{"title"=>"Organization API", "description"=>"for-managing-organizations-", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/orgs"=>{"get"=>{"summary"=>"Manages organizations", "description"=>"", "operationId"=>"organizations", "x-api-path-slug"=>"orgs-get", "parameters"=>[{"in"=>"query", "name"=>"dba", "description"=>"the name the organization does business as", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"handle", "description"=>"the handle of the organization", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"the name of organization", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}, "/org/pocs"=>{"get"=>{"summary"=>"List POCs", "description"=>"lists the POCs associate with a given organization.", "operationId"=>"orgPocs", "x-api-path-slug"=>"orgpocs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["POCs"]}}, "/org/asns"=>{"get"=>{"summary"=>"List ASNS", "description"=>"lists the ASNs associated with a given organization.", "operationId"=>"orgAsns", "x-api-path-slug"=>"orgasns-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ASNs"]}}, "/org/nets"=>{"get"=>{"summary"=>"List Nets", "description"=>"lists the networks associated with a given organization.", "operationId"=>"orgNets", "x-api-path-slug"=>"orgnets-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nets"]}}}}, "autonomous-system-numbers-asns-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"ARIN", "x-complete"=>1, "info"=>{"title"=>"Autonomous System Numbers (ASNs) API", "description"=>"for-managing-autonomous-system-numbers-asns-", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/asn"=>{"get"=>{"summary"=>"Autonomous System Number(s)", "description"=>"", "operationId"=>"asn", "x-api-path-slug"=>"asn-get", "parameters"=>[{"in"=>"query", "name"=>"handle", "description"=>"the handle of the ASN", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autonomous Systen Numbers"]}}, "/asn/pocs"=>{"get"=>{"summary"=>"List POCs", "description"=>"lists the POCs associated with a given ASN.", "operationId"=>"asnPocs", "x-api-path-slug"=>"asnpocs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["POCs"]}}}}, "network-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"ARIN", "x-complete"=>1, "info"=>{"title"=>"Network API", "description"=>"for-managing-network-details-", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/nets"=>{"get"=>{"summary"=>"Networks", "description"=>"", "operationId"=>"nets", "x-api-path-slug"=>"nets-get", "parameters"=>[{"in"=>"query", "name"=>"handle", "description"=>"the handle of the network", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"the name of the network", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Networks"]}}, "/net/pocs"=>{"get"=>{"summary"=>"List POCs", "description"=>"lists the POCs associated with a given network.", "operationId"=>"netsPocs", "x-api-path-slug"=>"netpocs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["POCs"]}}, "/net/parent"=>{"get"=>{"summary"=>"List Partent", "description"=>"lists the parent network of a given network.", "operationId"=>"netParent", "x-api-path-slug"=>"netparent-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parent"]}}, "/net/children"=>{"get"=>{"summary"=>"List Children", "description"=>"lists the child networks of a given network.", "operationId"=>"netChildren", "x-api-path-slug"=>"netchildren-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Children"]}}, "/net/rdns"=>{"get"=>{"summary"=>"List RDNS", "description"=>"lists the delegations of a given network.", "operationId"=>"netRdns", "x-api-path-slug"=>"netrdns-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["RDNS"]}}}}, "delegation-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"ARIN", "x-complete"=>1, "info"=>{"title"=>"Delegation API", "description"=>"delegations-are-entries-that-relate-ip-addresses-to-domain-names-using-the-domain-name-system-dns-of-the-internet--delegations-contain-the-information-necessary-for-reverse-dns-including-the-associated-nameservers-and-dns-delegation-signer-ds-record-information--delegations-may-not-be-created-or-deleted-independently--they-appear-and-disappear-automatically-alongside-their-associated-networks--unlike-the-other-objects-delegations-are-not-given-a-handle--they-are-searched-for-within-whois-using-a-delegation-name-like-0-192-inaddr-arpa-", "version"=>"1.0.0"}, "host"=>"www.arin.net", "basePath"=>"/regrws/core/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/delegation"=>{"get"=>{"summary"=>"Get Delegation", "description"=>"This call will return a payload containing details about the Delegation specified in your URL.", "operationId"=>"getDelegation", "x-api-path-slug"=>"delegation-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Delegation"]}, "put"=>{"summary"=>"Update Delegation", "description"=>"This call will modify the details of the Delegation specified in your URL. When making this call, attach a Delegation Payload containing the details of the Delegation you intend to modify. To ensure accuracy, use Get Delegation to get the most current information before making changes. This call returns a payload containing that Delegation's information as it exists after modification.", "operationId"=>"updateDelegation", "x-api-path-slug"=>"delegation-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Delegation"]}, "post"=>{"summary"=>"Add Delegation", "description"=>"This call will add the single nameserver specified in your URL to the Delegation specified in your URL, and return a payload containing that Delegation's information after the nameserver has been added.", "operationId"=>"addDelegation", "x-api-path-slug"=>"delegation-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Delegation"]}, "delete"=>{"summary"=>"Delete Delegation", "description"=>"This call will delete the single nameserver specified in your URL from the Delegation specified in your URL, and return a payload containing that Delegation's information after the nameserver has been deleted. If Reg-RWS returns an error code and/or Error Payload to you when performing this call, refer to the Error Codes section.", "operationId"=>"deleteDelegation", "x-api-path-slug"=>"delegation-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Delegation"]}}}}, "customers-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"ARIN", "x-complete"=>1, "info"=>{"title"=>"Customer API", "description"=>"for-managing-customers", "version"=>"1.0"}, "host"=>"whois.arin.net", "basePath"=>"/rest", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/customers"=>{"get"=>{"summary"=>"Manage customers", "description"=>"", "operationId"=>"customers", "x-api-path-slug"=>"customers-get", "parameters"=>[{"in"=>"query", "name"=>"handle", "description"=>"the handle of the customer", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"the name of the customer", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}}}}, "cidr-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"ARIN", "x-complete"=>1, "info"=>{"title"=>"CIDR API", "description"=>"managing-ip-address-and-cidr-details-", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"cidr/"=>{"get"=>{"summary"=>"IP and CIDR Queries", "description"=>"", "operationId"=>"cidr", "x-api-path-slug"=>"cidr-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CIDR"]}}}}, "apis"=>{"name"=>"ARIN", "x-slug"=>"arin", "description"=>"The American Registry for Internet Numbers (ARIN) is a Regional Internet Registry (RIR) incorporated in the Commonwealth of Virginia, USA. ARIN is one of five (5) RIRs. Like the other RIRs, ARIN: Provides services related to the technical coordinati...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1381-arin.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"51791", "tags"=>"API Provider,DNS,DNS Internet,General Data,Infrastructure,internet,ISP,Profiles,Registry,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"arin/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Autonomous System Numbers (ASNs) API", "x-api-slug"=>"autonomous-system-numbers-asns-api", "description"=>"The American Registry for Internet Numbers (ARIN) is a Regional Internet Registry (RIR) incorporated in the Commonwealth of Virginia, USA. ARIN is one of five (5) RIRs. Like the other RIRs, ARIN: Provides services related to the technical coordinati...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1381-arin.jpg", "humanURL"=>"https://www.arin.net", "baseURL"=>":///", "tags"=>"API Provider,DNS,DNS Internet,General Data,Infrastructure,internet,ISP,Profiles,Registry,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/arin/asnpocs-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/arin/autonomous-system-numbers-asns-api-openapi.yaml"}]}, {"name"=>"CIDR API", "x-api-slug"=>"cidr-api", "description"=>"The American Registry for Internet Numbers (ARIN) is a Regional Internet Registry (RIR) incorporated in the Commonwealth of Virginia, USA. ARIN is one of five (5) RIRs. Like the other RIRs, ARIN: Provides services related to the technical coordinati...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1381-arin.jpg", "humanURL"=>"https://www.arin.net", "baseURL"=>":///", "tags"=>"POCs", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/arin/cidr-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/arin/cidr-api-openapi.yaml"}]}, {"name"=>"Customers API", "x-api-slug"=>"customers-api", "description"=>"The American Registry for Internet Numbers (ARIN) is a Regional Internet Registry (RIR) incorporated in the Commonwealth of Virginia, USA. ARIN is one of five (5) RIRs. Like the other RIRs, ARIN: Provides services related to the technical coordinati...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1381-arin.jpg", "humanURL"=>"https://www.arin.net", "baseURL"=>"https://whois.arin.net//rest", "tags"=>"CIDR", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/arin/customers-api-openapi.yaml"}]}, {"name"=>"Delegation API", "x-api-slug"=>"delegation-api", "description"=>"The American Registry for Internet Numbers (ARIN) is a Regional Internet Registry (RIR) incorporated in the Commonwealth of Virginia, USA. ARIN is one of five (5) RIRs. Like the other RIRs, ARIN: Provides services related to the technical coordinati...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1381-arin.jpg", "humanURL"=>"https://www.arin.net", "baseURL"=>"https://www.arin.net//regrws/core/v1", "tags"=>"Customers", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/arin/delegation-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/arin/delegation-api-openapi.yaml"}]}, {"name"=>"Network API", "x-api-slug"=>"network-api", "description"=>"The American Registry for Internet Numbers (ARIN) is a Regional Internet Registry (RIR) incorporated in the Commonwealth of Virginia, USA. ARIN is one of five (5) RIRs. Like the other RIRs, ARIN: Provides services related to the technical coordinati...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1381-arin.jpg", "humanURL"=>"https://www.arin.net", "baseURL"=>":///", "tags"=>"Delegation", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/arin/netrdns-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/arin/network-api-openapi.yaml"}]}, {"name"=>"Organization API", "x-api-slug"=>"organization-api", "description"=>"The American Registry for Internet Numbers (ARIN) is a Regional Internet Registry (RIR) incorporated in the Commonwealth of Virginia, USA. ARIN is one of five (5) RIRs. Like the other RIRs, ARIN: Provides services related to the technical coordinati...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1381-arin.jpg", "humanURL"=>"https://www.arin.net", "baseURL"=>":///", "tags"=>"RDNS", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/arin/orgnets-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/arin/organization-api-openapi.yaml"}]}, {"name"=>"Point of Contact (POC) API", "x-api-slug"=>"point-of-contact-poc-api", "description"=>"The American Registry for Internet Numbers (ARIN) is a Regional Internet Registry (RIR) incorporated in the Commonwealth of Virginia, USA. ARIN is one of five (5) RIRs. Like the other RIRs, ARIN: Provides services related to the technical coordinati...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1381-arin.jpg", "humanURL"=>"https://www.arin.net", "baseURL"=>":///", "tags"=>"Nets", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/arin/pocnets-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/arin/point-of-contact-poc-api-openapi.yaml"}]}, {"name"=>"Reverse DNS API", "x-api-slug"=>"reverse-dns-api", "description"=>"The American Registry for Internet Numbers (ARIN) is a Regional Internet Registry (RIR) incorporated in the Commonwealth of Virginia, USA. ARIN is one of five (5) RIRs. Like the other RIRs, ARIN: Provides services related to the technical coordinati...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1381-arin.jpg", "humanURL"=>"https://www.arin.net", "baseURL"=>":///", "tags"=>"Nets", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/arin/rdnsnets-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/arin/reverse-dns-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://www.arin.net"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/american-registry-for-internet-numbers"}, {"type"=>"x-developer", "url"=>"https://www.arin.net/resources/restful-interfaces.html"}, {"type"=>"x-email", "url"=>"hostmaster@arin.net"}, {"type"=>"x-email", "url"=>"billing@arin.net"}, {"type"=>"x-email", "url"=>"reassign@arin.net"}, {"type"=>"x-email", "url"=>"info@arin.net"}, {"type"=>"x-email", "url"=>"meetings@arin.net"}, {"type"=>"x-email", "url"=>"members@arin.net"}, {"type"=>"x-email", "url"=>"compliance@arin.net"}, {"type"=>"x-email", "url"=>"mlc@arin.net"}, {"type"=>"x-email", "url"=>"media@arin.net"}, {"type"=>"x-email", "url"=>"noc@arin.net"}, {"type"=>"x-github", "url"=>"https://github.com/arineng"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/TeamARIN"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| pingometer{"checks-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Pingometer", "x-complete"=>1, "info"=>{"title"=>"Checks API", "description"=>"the-checks-api-", "version"=>"1.0.0"}, "host"=>"api.pingdom.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/checks "=>{" get "=>{"summary"=>"Get Checks", "description"=>"Gets a list of all checks that are visible to you as a user or a customer depending on the request context.", "operationId"=>"getChecks", "x-api-path-slug"=>"checks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}, "/checks/{checkId} "=>{" get "=>{"summary"=>"Get Check", "description"=>"Gets info about a check, current SLA, last result and its status.", "operationId"=>"getChecksCheck", "x-api-path-slug"=>"checkscheckid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}, " put "=>{"summary"=>"Update Check", "description"=>"Updates a check.", "operationId"=>"putChecksCheck", "x-api-path-slug"=>"checkscheckid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}, " delete "=>{"summary"=>"Delete Check", "description"=>"Deletes a check.", "operationId"=>"deleteChecksCheck", "x-api-path-slug"=>"checkscheckid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}, "/checks/{checkId}/lastvalue "=>{" get "=>{"summary"=>"Get Checks Lastvalue", "description"=>"Gets the absolute last value of a specific check.", "operationId"=>"getChecksCheckLastvalue", "x-api-path-slug"=>"checkscheckidlastvalue-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}, "/checks/{checkId}/results/{millisecondsUtc}"=>{" get "=>{"summary"=>"Get Checks Results", "description"=>"Gets a specific check result by a numeric java timestamp.", "operationId"=>"getChecksCheckResultsMillisecondsutcDetailLevelDetailLevel", "x-api-path-slug"=>"checkscheckidresultsmillisecondsutc-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}, "/checks/{checkId}/results"=>{" get "=>{"summary"=>"Get Checks Results", "description"=>"Gets the most recent check results.", "operationId"=>"getChecksCheckResultsMostrecentMostrecent&detailLevelDetailLevel", "x-api-path-slug"=>"checkscheckidresults-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}, "\n /api/{version}/checks"=>{"\n get"=>{"summary"=>"Get Check List", "description"=>"Returns a list overview of all checks.", "operationId"=>"\ngetApiVersionChecks", "x-api-path-slug"=>"apiversionchecks-get", "parameters"=>[{"in"=>"query", "name"=>"include_tags", "description"=>"Include tag list for each check", "type"=>" | boolean | "}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of returned probes to the specified quantity", "type"=>"integer | "}, {"in"=>"query", "name"=>"offset", "description"=>"Offset for listing", "type"=>"integer | "}, {"in"=>"query", "name"=>"tags", "description"=>"Tag list separated by commas", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}}}, "alerts-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Pingometer", "x-complete"=>1, "info"=>{"title"=>"Alerts API", "description"=>"the-alerts-api-", "version"=>"1.0.0"}, "host"=>"api.serverdensity.io.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/alerts?check_id={check_id}&severity={severity}&enabled={enabled}&target_type={target_type}&target_id={target_id} "=>{" get "=>{"summary"=>"Alerts", "description"=>"Gets alerts filtered by set of optional parameters.", "operationId"=>"-alertscheck-idcheck-idampseverityseverityampenabledenabledamptarget-typetarget-typeamptarget-idtarg", "x-api-path-slug"=>"alertscheck-idcheck-idampseverityseverityampenabledenabledamptarget-typetarget-typeamptarget-idtarget-id-get", "responses"=>{""=>{"description"=>""}, 400=>{"description"=>"Bad input parameter"}, 401=>{"description"=>"Bad or expired token"}, 403=>{"description"=>"Bad OAuth request (wrong consumer key, bad nonce, expired timestamp"}, 404=>{"description"=>"File or folder not found at the specified path"}, 405=>{"description"=>"Request method not expected (generally should be GET or POST)"}, 429=>{"description"=>"Your app is making too many requests and is being rate limited"}, 503=>{"description"=>"If the response includes the Retry-After header, this means your OAuth 1"}, 507=>{"description"=>"User is over Dropbox storage quota"}, "5xx"=>{"description"=>"Server error"}, "apps"=>{"description"=>"app_allow"}, "devices"=>{"description"=>"device_link"}, "members"=>{"description"=>"member_invite"}, "passwords"=>{"description"=>"tfa_enable"}, "sharing"=>{"description"=>"shmodel_create"}, "team_admin_actions"=>{"description"=>"sf_external_accept_allow"}, 200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/{alert_id} "=>{" get "=>{"summary"=>"Alerts", "description"=>"Gets alert by Id.", "operationId"=>"-alerts-alert-id-", "x-api-path-slug"=>"alertsalert-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}, " put "=>{"summary"=>"Alerts", "description"=>"Updates alert.", "operationId"=>"-alerts-alert-id-", "x-api-path-slug"=>"alertsalert-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}, " delete "=>{"summary"=>"Alerts", "description"=>"Deletes alert by Id.", "operationId"=>"-alerts-alert-id-", "x-api-path-slug"=>"alertsalert-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/{alert_type} "=>{" post "=>{"summary"=>"Alerts", "description"=>"Creates a new alert.", "operationId"=>"-alerts-alert-type-", "x-api-path-slug"=>"alertsalert-type-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/recipients "=>{" get "=>{"summary"=>"Alerts Recipients", "description"=>"Gets a list of all alert recipient's targets that are visible to you as a customer.", "operationId"=>"-alerts-recipients-", "x-api-path-slug"=>"alertsrecipients-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/recipients/{recipient_id} "=>{" get "=>{"summary"=>"Alerts Recipients", "description"=>"Gets a information about alert recipient's targets.", "operationId"=>"-alerts-recipients-recipient-id-", "x-api-path-slug"=>"alertsrecipientsrecipient-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/recipient/{recipient_id} "=>{" put "=>{"summary"=>"Alerts Recipient", "description"=>"Updates recipient along with sms and email targets associated.", "operationId"=>"-alerts-recipient-recipient-id-", "x-api-path-slug"=>"alertsrecipientrecipient-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/recipient "=>{" post "=>{"summary"=>"Alerts Recipient", "description"=>"Creates a new recipient with one sms and one email target associated.", "operationId"=>"-alerts-recipient-", "x-api-path-slug"=>"alertsrecipient-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/targets "=>{" get "=>{"summary"=>"Alerts Targets", "description"=>"Gets a list of all alert targets that are visible to you as a customer.", "operationId"=>"-alerts-targets-", "x-api-path-slug"=>"alertstargets-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/configs/alertId"=>{"delete"=>{"summary"=>"Deleting an alert", "description"=>"Deleting an alert", "operationId"=>"deleting-an-alert", "x-api-path-slug"=>"alertsconfigsalertid-delete", "parameters"=>[{"in"=>"path", "name"=>"alertId", "description"=>"The ID of the alert to be deleted", "type"=>"string"}, {"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"body", "name"=>"token", "description"=>"Your API token", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/configs/subjectId"=>{"get"=>{"summary"=>"Listing alerts by subject", "description"=>"Get a list of all configured alerts for a specific subject (device or service).", "operationId"=>"listing-alerts-by-subject", "x-api-path-slug"=>"alertsconfigssubjectid-get", "parameters"=>[{"in"=>"path", "name"=>"subjectId", "description"=>"The ID of the subject e", "type"=>"string"}, {"in"=>"path", "name"=>"subjectType", "description"=>"The type of the subject - device or service", "type"=>"string"}, {"in"=>"query", "name"=>"subjectType", "description"=>"The type of the subject - device or service", "type"=>"string"}, {"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/triggered"=>{"get"=>{"summary"=>"Triggered Alerts", "description"=>"Get a list of all triggered alerts on your account, per subject (device or service) or per alert config.", "operationId"=>"triggered-alerts", "x-api-path-slug"=>"alertstriggered-get", "parameters"=>[{"in"=>"query", "name"=>"closed", "description"=>"Whether to filter by closed or open alerts - unset = all alerts, false = open alerts, true = closed alerts", "type"=>"string"}, {"in"=>"query", "name"=>"filter", "description"=>"You can provide a JSON encoded hash filter for the search that will return items that match the filter", "type"=>"string"}, {"in"=>"query", "name"=>"subjectType", "description"=>"The type of the subject - device, service, deviceGroup or serviceGroup if you also specify the subjectId as part of the URL (see examples below)", "type"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}}}, "apis"=>{"name"=>"Pingometer", "x-slug"=>"pingometer", "description"=>"Pingometer is a service that monitors the uptime, downtime, and performance of websites. Get 24/7 monitoring - sign up for your FREE account today!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/18847-pingometer.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"1995680", "tags"=>"internet,Monitoring,Performance,Relative Data,Relative StreamRank,SaaS,Service API,Stack Network,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"pingometer/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Alerts API", "x-api-slug"=>"alerts-api", "description"=>"Pingometer is a service that monitors the uptime, downtime, and performance of websites. Get 24/7 monitoring - sign up for your FREE account today!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/18847-pingometer.jpg", "humanURL"=>"https://pingometer.com/", "baseURL"=>"://api.serverdensity.io./", "tags"=>"internet,Monitoring,Performance,Relative Data,Relative StreamRank,SaaS,Service API,Stack Network,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/pingometer/alerts-api-openapi.yaml"}]}, {"name"=>"Checks API", "x-api-slug"=>"checks-api", "description"=>"Pingometer is a service that monitors the uptime, downtime, and performance of websites. Get 24/7 monitoring - sign up for your FREE account today!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/18847-pingometer.jpg", "humanURL"=>"https://pingometer.com/", "baseURL"=>"https://api.pingdom.com//", "tags"=>"Alerts", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/pingometer/checks-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://pingometer.com/blog/"}, {"type"=>"x-crunchbase", "url"=>"https://www.crunchbase.com/organization/pingometer"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/pingometer"}, {"type"=>"x-github", "url"=>"https://github.com/pingometer"}, {"type"=>"x-integrations", "url"=>"https://pingometer.com/integrations/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/pingometer"}, {"type"=>"x-website", "url"=>"https://pingometer.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}}|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
natwest{"natwest-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"NatWest", "x-complete"=>1, "info"=>{"title"=>"NatWest", "description"=>"this-is-an-openapi-definition-for-the-standard-set-of-open-banking-httpopenbankingapis-io-apis-for-natwest-", "termsOfService"=>"https://www.openbanking.org.uk/open-licence/", "contact"=>{"name"=>"API Evangelist", "url"=>"https://apievangelist.com", "email"=>"info@apievangelist.com"}, "version"=>"1.0.0"}, "host"=>"openapi.natwest.com", "basePath"=>"open-banking/v2.1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"atms/"=>{"get"=>{"summary"=>"Get ATMs", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can provide multiple ATMs.", "operationId"=>"getATMS", "x-api-path-slug"=>"atms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ATMs"]}}, "branches/"=>{"get"=>{"summary"=>"Get Branches", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple branches.", "operationId"=>"getBranches", "x-api-path-slug"=>"branches-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branches"]}}, "personal-current-accounts/"=>{"get"=>{"summary"=>"Get Current Personal Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple PCA products.", "operationId"=>"getCurrentPersonalAccounts", "x-api-path-slug"=>"personalcurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "Personal", "Accounts"]}}, "business-current-accounts/"=>{"get"=>{"summary"=>"Get Current Business Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple BCA products.", "operationId"=>"getCurentBusinessAccounts", "x-api-path-slug"=>"businesscurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "Business", "Accounts"]}}, "unsecured-sme-loans/"=>{"get"=>{"summary"=>"Get Unsecured SME Loans", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Unsecured Loan products.", "operationId"=>"pathOperation", "x-api-path-slug"=>"unsecuredsmeloans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsecured", "SME", "Loans"]}}, "commercial-credit-cards/"=>{"get"=>{"summary"=>"Get Commercial Credit Cards", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Commercial Credit Card products.", "operationId"=>"getCommercialCreditCards", "x-api-path-slug"=>"commercialcreditcards-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commercial", "Credit", "Cards"]}}}}, "apis"=>{"name"=>"NatWest", "x-slug"=>"natwest", "description"=>"National Westminster Bank, commonly known as NatWest, is a large retail and commercial bank in the United Kingdom. It was established in 1968 by the merger of National Provincial Bank (established 1833 as National Provincial Bank of England) and Westminster Bank (established 1834 as London County and Westminster Bank). Since 2000 it has been part of the Royal Bank of Scotland Group. Following ring-fencing of the Groups core domestic business, the bank is a direct subsidiary of NatWest Holdings. NatWest Markets comprises its investment banking arm.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/natwest-logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Provider,Banking,General Data,Profiles,Relative Data,UK Banks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"natwest/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"NatWest", "x-api-slug"=>"natwest", "description"=>"National Westminster Bank, commonly known as NatWest, is a large retail and commercial bank in the United Kingdom. It was established in 1968 by the merger of National Provincial Bank (established 1833 as National Provincial Bank of England) and Westminster Bank (established 1834 as London County and Westminster Bank). Since 2000 it has been part of the Royal Bank of Scotland Group. Following ring-fencing of the Groups core domestic business, the bank is a direct subsidiary of NatWest Holdings. NatWest Markets comprises its investment banking arm.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/natwest-logo.png", "humanURL"=>"https://personal.natwest.com/personal.html", "baseURL"=>"https://openapi.natwest.com/open-banking/v2.1/", "tags"=>"API Provider,Banking,General Data,Profiles,Relative Data,UK Banks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/natwest/commercialcreditcards-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/natwest/natwest-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"http://openbankingapis.io/uk/natwest"}, {"type"=>"x-documentation", "url"=>"https://openbanking.atlassian.net/wiki/spaces/DZ/pages/54919225/Open+Data+API+Dashboard#"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/natwest_help"}, {"type"=>"x-website", "url"=>"https://personal.natwest.com/personal.html"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
isendpro-telecom{"api-i-send-pro-openapi"=>false, "apis"=>{"name"=>"iSendPro Telecom", "x-slug"=>"isendpro-telecom", "description"=>"Solution denvoi de SMS pro direct Oprateur. Oprateur Franais, Qualit Garantie Sans Engagement et Sans Dlai.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28430-api-i-send-pro.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"635223", "tags"=>"Agencies,Messages,Profiles,Relative Data,Service API,Telecommunications", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"isendpro-telecom/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"API i Send Pro", "x-api-slug"=>"api-i-send-pro", "description"=>"Solution denvoi de SMS pro direct Oprateur. Oprateur Franais, Qualit Garantie Sans Engagement et Sans Dlai.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28430-api-i-send-pro.jpg", "humanURL"=>"http://isendpro.com", "baseURL"=>"https://apirest.isendpro.com//cgi-bin", "tags"=>"Agencies,Messages,Profiles,Relative Data,Service API,Telecommunications", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/isendpro-telecom/api-i-send-pro-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-email", "url"=>"contact@isendpro.com"}, {"type"=>"x-email", "url"=>"support@isendpro.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/iSendPro"}, {"type"=>"x-website", "url"=>"http://isendpro.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-storage{"azure-storage-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Storage", "x-complete"=>1, "info"=>{"title"=>"StorSimpleSeries8000ManagementClient", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability"=>{"post"=>{"summary"=>"Storage Accounts Check Name Availability", "description"=>"Checks that the storage account name is valid and is not already in use.", "operationId"=>"StorageAccounts_CheckNameAvailability", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-storagechecknameavailability-post", "parameters"=>[{"in"=>"body", "name"=>"accountName", "description"=>"The name of the storage account within the specified resource group", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage Accounts Name Availability"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}"=>{"put"=>{"summary"=>"Storage Accounts Create", "description"=>"Asynchronously creates a new storage account with the specified parameters. If an account is already created and a subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.", "operationId"=>"StorageAccounts_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storagestorageaccountsaccountname-put", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the storage account within the specified resource group"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters to provide for the created account", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage Accounts"]}, "delete"=>{"summary"=>"Storage Accounts Delete", "description"=>"Deletes a storage account in Microsoft Azure.", "operationId"=>"StorageAccounts_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storagestorageaccountsaccountname-delete", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the storage account within the specified resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage Accounts"]}, "get"=>{"summary"=>"Storage Accounts Get Properties", "description"=>"Returns the properties for the specified storage account including but not limited to name, SKU name, location, and account status. The ListKeys operation should be used to retrieve storage keys.", "operationId"=>"StorageAccounts_GetProperties", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storagestorageaccountsaccountname-get", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the storage account within the specified resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage Accounts Properties"]}, "patch"=>{"summary"=>"Storage Accounts Update", "description"=>"The update operation can be used to update the SKU, encryption, access tier, or tags for a storage account. It can also be used to map the account to a custom domain. Only one custom domain is supported per storage account; the replacement/change of custom domain is not supported. In order to replace an old custom domain, the old value must be cleared/unregistered before a new value can be set. The update of multiple properties is supported. This call does not change the storage keys for the account. If you want to change the storage account keys, use the regenerate keys operation. The location and name of the storage account cannot be changed after creation.", "operationId"=>"StorageAccounts_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storagestorageaccountsaccountname-patch", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the storage account within the specified resource group"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters to provide for the updated account", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage Accounts"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts"=>{"get"=>{"summary"=>"Storage Accounts List", "description"=>"Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.", "operationId"=>"StorageAccounts_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-storagestorageaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage Accounts"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts"=>{"get"=>{"summary"=>"Storage Accounts List By Resource Group", "description"=>"Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.", "operationId"=>"StorageAccounts_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storagestorageaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage Accounts Resource Group"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys"=>{"post"=>{"summary"=>"Storage Accounts List Keys", "description"=>"Lists the access keys for the specified storage account.", "operationId"=>"StorageAccounts_ListKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storagestorageaccountsaccountnamelistkeys-post", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the storage account within the specified resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage Accounts Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey"=>{"post"=>{"summary"=>"Storage Accounts Regenerate Key", "description"=>"Regenerates one of the access keys for the specified storage account.", "operationId"=>"StorageAccounts_RegenerateKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storagestorageaccountsaccountnameregeneratekey-post", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the storage account within the specified resource group"}, {"in"=>"body", "name"=>"regenerateKey", "description"=>"Specifies name of the key which should be regenerated -- key1 or key2", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage Accounts Regenerate Key"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/usages"=>{"get"=>{"summary"=>"Usage List", "description"=>"Gets the current usage count and the limit for the resources under the subscription.", "operationId"=>"Usage_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-storageusages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Usage"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListAccountSas"=>{"post"=>{"summary"=>"Storage Accounts List Account SAS", "description"=>"List SAS credentials of a storage account.", "operationId"=>"StorageAccounts_ListAccountSAS", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storagestorageaccountsaccountnamelistaccountsas-post", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the storage account within the specified resource group"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters to provide to list SAS credentials for the storage account", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage Accounts Account Sas"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListServiceSas"=>{"post"=>{"summary"=>"Storage Accounts List Service SAS", "description"=>"List service SAS credentials of a specific resource.", "operationId"=>"StorageAccounts_ListServiceSAS", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storagestorageaccountsaccountnamelistservicesas-post", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the storage account within the specified resource group"}, {"in"=>"body", "name"=>"parameters", "description"=>"The parameters to provide to list service SAS credentials", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage Accounts Service Sas"]}}, "/providers/Microsoft.ImportExport/locations"=>{"get"=>{"summary"=>"List Locations", "description"=>"Returns a list of locations to which you can ship the disks associated with an import or export job. A location is a Microsoft data center region.", "operationId"=>"ListLocations", "x-api-path-slug"=>"providersmicrosoft-importexportlocations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Locations"]}}, "/providers/Microsoft.ImportExport/locations/{locationName}"=>{"get"=>{"summary"=>"Get Location", "description"=>"Gets a location to which you can ship the disks associated with an import or export job. A location is an Azure region.", "operationId"=>"GetLocation", "x-api-path-slug"=>"providersmicrosoft-importexportlocationslocationname-get", "parameters"=>[{"in"=>"path", "name"=>"locationName", "description"=>"The name of the location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Location"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.ImportExport/jobs"=>{"get"=>{"summary"=>"Jobs List", "description"=>"Gets all the active and completed import/export jobs in a subscription.", "operationId"=>"Jobs_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-importexportjobs-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"Can be used to restrict the results to certain conditions"}, {"in"=>"query", "name"=>"$top", "description"=>"An integer value that specifies how many jobs at most should be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs"=>{"get"=>{"summary"=>"Jobs List By Resource Group", "description"=>"Returns all active and completed import/export jobs in a resource group.", "operationId"=>"Jobs_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-importexportjobs-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"Can be used to restrict the results to certain conditions"}, {"in"=>"query", "name"=>"$top", "description"=>"An integer value that specifies how many jobs at most should be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs Resource Group"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}"=>{"get"=>{"summary"=>"Jobs Get", "description"=>"Gets information about an existing import/export job.", "operationId"=>"Jobs_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-importexportjobsjobname-get", "parameters"=>[{"in"=>"path", "name"=>"jobName", "description"=>"The name of the import/export job"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}, "patch"=>{"summary"=>"Jobs Update", "description"=>"Updates specific properties of the import/export job. You can call this operation to notify the Import/Export service that the hard drives comprising the import or export job have been shipped to the Microsoft data center. It can also be used to cancel an existing job.", "operationId"=>"Jobs_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-importexportjobsjobname-patch", "parameters"=>[{"in"=>"path", "name"=>"jobName", "description"=>"The name of the import/export job"}, {"in"=>"body", "name"=>"jobProperties", "description"=>"Import/export job properties that need to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}, "put"=>{"summary"=>"Jobs Create Or Update", "description"=>"Creates a new import/export job or updates an existing import/export job in the specified subscription.", "operationId"=>"Jobs_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-importexportjobsjobname-put", "parameters"=>[{"in"=>"path", "name"=>"jobName", "description"=>"The name of the import/export job"}, {"in"=>"body", "name"=>"jobProperties", "description"=>"Properties of the import/export job that need to be specified during creation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}, "delete"=>{"summary"=>"Jobs Delete", "description"=>"Deletes an existing import/export job. Only import/export jobs in the Creating or Completed states can be deleted.", "operationId"=>"Jobs_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-importexportjobsjobname-delete", "parameters"=>[{"in"=>"path", "name"=>"jobName", "description"=>"The name of the import/export job"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/moveResources"=>{"post"=>{"summary"=>"Jobs Move", "description"=>"Moves the specified import/export jobs from the resource group to a target resource group. The target resource group may be in a different subscription.", "operationId"=>"Jobs_Move", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-importexportmoveresources-post", "parameters"=>[{"in"=>"body", "name"=>"MoveJobsParameters", "description"=>"Parameters to be provided to move a job from one resource group to another", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}/listBitLockerKeys"=>{"get"=>{"summary"=>"Jobs List Bit Locker Keys", "description"=>"Lists the BitLocker keys for all drives in the specified import/export job.", "operationId"=>"Jobs_ListBitLockerKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-importexportjobsjobnamelistbitlockerkeys-get", "parameters"=>[{"in"=>"path", "name"=>"jobName", "description"=>"The name of the import/export job"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/providers/Microsoft.ImportExport/operations"=>{"get"=>{"summary"=>"List Supported Operations", "description"=>"Returns the list of operations supported by the import/export resource provider.", "operationId"=>"ListSupportedOperations", "x-api-path-slug"=>"providersmicrosoft-importexportoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Supported Operations"]}}, "/providers/Microsoft.StorSimple/operations"=>{"get"=>{"summary"=>"Operations List", "description"=>"Lists all of the available REST API operations of the Microsoft.Storsimple provider", "operationId"=>"Operations_List", "x-api-path-slug"=>"providersmicrosoft-storsimpleoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.StorSimple/managers"=>{"get"=>{"summary"=>"Managers List", "description"=>"Retrieves all the managers in a subscription.", "operationId"=>"Managers_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-storsimplemanagers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers"=>{"get"=>{"summary"=>"Managers List By Resource Group", "description"=>"Retrieves all the managers in a resource group.", "operationId"=>"Managers_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers Resource Group"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}"=>{"get"=>{"summary"=>"Managers Get", "description"=>"Returns the properties of the specified manager name.", "operationId"=>"Managers_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagername-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers"]}, "put"=>{"summary"=>"Managers Create Or Update", "description"=>"Creates or updates the manager.", "operationId"=>"Managers_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagername-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The manager", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers"]}, "delete"=>{"summary"=>"Managers Delete", "description"=>"Deletes the manager.", "operationId"=>"Managers_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagername-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/configureDevice"=>{"post"=>{"summary"=>"Devices Configure", "description"=>"Complete minimal setup before using the device.", "operationId"=>"Devices_Configure", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagernameconfiguredevice-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The minimal properties to configure a device", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices"=>{"get"=>{"summary"=>"Devices List By Manager", "description"=>"Returns the list of devices for the specified manager.", "operationId"=>"Devices_ListByManager", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagernamedevices-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify $expand=details to populate additional fields related to the device"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}"=>{"get"=>{"summary"=>"Devices Get", "description"=>"Returns the properties of the specified device.", "operationId"=>"Devices_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagernamedevicesdevicename-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify $expand=details to populate additional fields related to the device"}, {"in"=>"path", "name"=>"deviceName", "description"=>"The device name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}, "delete"=>{"summary"=>"Devices Delete", "description"=>"Deletes the device.", "operationId"=>"Devices_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagernamedevicesdevicename-delete", "parameters"=>[{"in"=>"path", "name"=>"deviceName", "description"=>"The device name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}, "patch"=>{"summary"=>"Devices Update", "description"=>"Patches the device.", "operationId"=>"Devices_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagernamedevicesdevicename-patch", "parameters"=>[{"in"=>"path", "name"=>"deviceName", "description"=>"The device Name"}, {"in"=>"body", "name"=>"parameters", "description"=>"Patch representation of the device", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/deactivate"=>{"post"=>{"summary"=>"Devices Deactivate", "description"=>"Deactivates the device.", "operationId"=>"Devices_Deactivate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagernamedevicesdevicenamedeactivate-post", "parameters"=>[{"in"=>"path", "name"=>"deviceName", "description"=>"The device name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/publicEncryptionKey"=>{"post"=>{"summary"=>"Managers Get Device Public Encryption Key", "description"=>"Returns the public encryption key of the device.", "operationId"=>"Managers_GetDevicePublicEncryptionKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagernamedevicesdevicenamepublicencryptionkey-post", "parameters"=>[{"in"=>"path", "name"=>"deviceName", "description"=>"The device name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/encryptionSettings/default"=>{"get"=>{"summary"=>"Managers Get Encryption Settings", "description"=>"Returns the encryption settings of the manager.", "operationId"=>"Managers_GetEncryptionSettings", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagernameencryptionsettingsdefault-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/extendedInformation/vaultExtendedInfo"=>{"get"=>{"summary"=>"Managers Get Extended Info", "description"=>"Returns the extended information of the specified manager name.", "operationId"=>"Managers_GetExtendedInfo", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagernameextendedinformationvaultextendedinfo-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers"]}, "put"=>{"summary"=>"Managers Create Extended Info", "description"=>"Creates the extended info of the manager.", "operationId"=>"Managers_CreateExtendedInfo", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagernameextendedinformationvaultextendedinfo-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The manager extended information", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers"]}, "delete"=>{"summary"=>"Managers Delete Extended Info", "description"=>"Deletes the extended info of the manager.", "operationId"=>"Managers_DeleteExtendedInfo", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagernameextendedinformationvaultextendedinfo-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers"]}, "patch"=>{"summary"=>"Managers Update Extended Info", "description"=>"Updates the extended info of the manager.", "operationId"=>"Managers_UpdateExtendedInfo", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagernameextendedinformationvaultextendedinfo-patch", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"Pass the ETag of ExtendedInfo fetched from GET call"}, {"in"=>"body", "name"=>"parameters", "description"=>"The manager extended information", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/listActivationKey"=>{"post"=>{"summary"=>"Managers Get Activation Key", "description"=>"Returns the activation key of the manager.", "operationId"=>"Managers_GetActivationKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagernamelistactivationkey-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers Activation Key"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/listPrivateEncryptionKey"=>{"post"=>{"summary"=>"Managers Get Private Encryption Key", "description"=>"Returns the symmetric encrypted private encryption key of the manager.", "operationId"=>"Managers_GetPrivateEncryptionKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagernamelistprivateencryptionkey-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers Private Encryption Key"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/listPublicEncryptionKey"=>{"post"=>{"summary"=>"Managers Get Public Encryption Key", "description"=>"Returns the symmetric encrypted public encryption key of the manager.", "operationId"=>"Managers_GetPublicEncryptionKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagernamelistpublicencryptionkey-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers Public Encryption Key"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/regenerateActivationKey"=>{"post"=>{"summary"=>"Managers Regenerate Activation Key", "description"=>"Re-generates and returns the activation key of the manager.", "operationId"=>"Managers_RegenerateActivationKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-storsimplemanagersmanagernameregenerateactivationkey-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers"]}}}}, "apis"=>{"name"=>"Azure Storage", "x-slug"=>"azure-storage", "description"=>"Azure Storage offers non-relational data storage including Blob Storage, Table Storage, Queue Storage, and Files.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-storage.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Microsoft,Profiles,Relative Data,Service API,Stack Network,Storage", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-storage/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Storage API", "x-api-slug"=>"azure-storage-api", "description"=>"Azure Storage offers non-relational data storage including Blob Storage, Table Storage, Queue Storage, and Files.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-storage.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/storage/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Microsoft,Profiles,Relative Data,Service API,Stack Network,Storage", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/azure-storage/azure-storage-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/storage/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/storage/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/storage/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/storage/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
geneea{"geneea-natural-language-processing-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Geneea", "x-complete"=>1, "info"=>{"title"=>"Geneea Natural Language Processing", "description"=>"div-classapidescription----h2authenticationh2----pfor-all-calls-supply-your-api-key--a-hrefhttpswww-geneea-compricingsign-up-to-emobtain-the-keyema-p----p--------our-api-supports-both-emunencrypted-httpem-and-emencrypted-httpsem-protocols---------however-for-security-reasons-we-strongly-encourage-using-only-the-encrypted-version-----p----pthe-api-key-should-be-supplied-as-either-a-request-parameter-codeuser-keycode-or-in-codeauthorizationcode-header-p----precodeauthorization-user-key-ltyour-api-keygtcodepre----h2api-operationsh2----p--------all-api-operations-can-perform-analysis-on-supplied-raw-text-or-on-text-extracted-from-a-given-url---------optionally-one-can-supply-additional-information-which-can-make-the-result-more-precise--an-example--------of-such-information-would-be-the-language-of-text-or-a-particular-text-extractor-for-url-resources-----p----pthe-supported-types-of-analyses-arep----ul--------listronglemmatizationstrong-longrightarrow------------finds-out-lemmata-basic-forms-of-all-the-words-in-the-document---------li--------listrongcorrectionstrong-longrightarrow------------performs-correction-diacritization-on-all-the-words-in-the-document---------li--------listrongtopic-detectionstrong-longrightarrow------------determines-a-topic-of-the-document-e-g--finance-or-sports---------li--------listrongsentiment-analysisstrong-longrightarrow------------determines-a-sentiment-of-the-document-i-e--how-positive-or-negative-the-document-is---------li--------listrongnamed-entity-recognitionstrong-longrightarrow------------finds-named-entities-like-person-location-date-etc--mentioned-the-the-document---------li----ul----h2encodingh2----pthe-supplied-text-is-expected-to-be-in-utf8-encoding-this-is-especially-important-for-nonenglish-texts-p----h2returned-valuesh2----pthe-api-calls-always-return-objects-in-serialized-json-format-in-utf8-encoding-p----p--------if-any-error-occurs-the-http-response-code-will-be-in-the-range-code4xxcode-clientside-error-or--------code5xxcode-serverside-error--in-this-situation-the-body-of-the-response-will-contain-information--------about-the-error-in-json-format-with-codeexceptioncode-and-codemessagecode-values-----p----h2url-limitationsh2----p--------all-the-requests-are-semantically-codegetcode--however-for-longer-texts-you-may-run-into-issues--------with-url-length-limit--therefore-its-possible-to-always-issue-a-codepostcode-request-with-all--------the-parameters-encoded-as-a-json-in-the-request-body-----p----pexamplep----precode--------post-s1sentiment--------contenttype-applicationjson--------textthere-is-no-harm-in-being-sometimes-wrong--especially-if-one-is-promptly-found-out-----codepre----pthis-is-equivalent-to-codeget-s1sentimenttextthere20is20no20harm---codep----h2request-limitationsh2----p--------the-api-has-other-limitations-concerning-the-size-of-the-http-requests--the-maximum-allowed-size-of-any--------post-request-body-is-em512-kibem--for-request-with-a-url-resource-the-maximum-allowed-number-of--------extracted-characters-from-each-such-resource-is-em100000em-----p----h2more-informationh2----p--------a-hrefhttpsgeneea-atlassian-netwikidisplayipdtheinterpretorapipublicdocumentation-target-blank--------the-interpretor-public-documentation--------a----pdiv", "version"=>"1.0"}, "host"=>"api.geneea.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/account"=>{"get"=>{"summary"=>"Get Account", "description"=>"Information about current user account.", "operationId"=>"getAccount", "x-api-path-slug"=>"account-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/s1/correction"=>{"get"=>{"summary"=>"Get Correction", "description"=>"Performs text correction (diacritization) on the given document.", "operationId"=>"getS1Correction", "x-api-path-slug"=>"s1correction-get", "parameters"=>[{"in"=>"query", "name"=>"extractor", "description"=>"document extractor"}, {"in"=>"query", "name"=>"language", "description"=>"document language"}, {"in"=>"query", "name"=>"returnTextInfo"}, {"in"=>"query", "name"=>"text", "description"=>"raw document text"}, {"in"=>"query", "name"=>"url", "description"=>"document URL"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Correction"]}, "post"=>{"summary"=>"Post Correction", "description"=>"Performs text correction (diacritization) on the given document.", "operationId"=>"postS1Correction", "x-api-path-slug"=>"s1correction-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Correction"]}}, "/s1/entities"=>{"get"=>{"summary"=>"Get Entities", "description"=>"Performs named-entity recognition on the given document.", "operationId"=>"getS1Entities", "x-api-path-slug"=>"s1entities-get", "parameters"=>[{"in"=>"query", "name"=>"extractor", "description"=>"document extractor"}, {"in"=>"query", "name"=>"language", "description"=>"document language"}, {"in"=>"query", "name"=>"returnTextInfo"}, {"in"=>"query", "name"=>"text", "description"=>"raw document text"}, {"in"=>"query", "name"=>"url", "description"=>"document URL"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entities"]}, "post"=>{"summary"=>"Post Entities", "description"=>"Performs named-entity recognition on the given document.", "operationId"=>"postS1Entities", "x-api-path-slug"=>"s1entities-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entities"]}}, "/s1/lemmatize"=>{"get"=>{"summary"=>"Get Lemmatize", "description"=>"Performs lemmatization on the given document.", "operationId"=>"getS1Lemmatize", "x-api-path-slug"=>"s1lemmatize-get", "parameters"=>[{"in"=>"query", "name"=>"extractor", "description"=>"document extractor"}, {"in"=>"query", "name"=>"language", "description"=>"document language"}, {"in"=>"query", "name"=>"returnTextInfo"}, {"in"=>"query", "name"=>"text", "description"=>"raw document text"}, {"in"=>"query", "name"=>"url", "description"=>"document URL"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lemmatize"]}, "post"=>{"summary"=>"Post Lemmatize", "description"=>"Performs lemmatization on the given document.", "operationId"=>"postS1Lemmatize", "x-api-path-slug"=>"s1lemmatize-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lemmatize"]}}, "/s1/sentiment"=>{"get"=>{"summary"=>"Get Sentiment", "description"=>"Performs sentiment analysis on the given document.", "operationId"=>"getS1Sentiment", "x-api-path-slug"=>"s1sentiment-get", "parameters"=>[{"in"=>"query", "name"=>"extractor", "description"=>"document extractor"}, {"in"=>"query", "name"=>"language", "description"=>"document language"}, {"in"=>"query", "name"=>"returnTextInfo"}, {"in"=>"query", "name"=>"text", "description"=>"raw document text"}, {"in"=>"query", "name"=>"url", "description"=>"document URL"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sentiment"]}, "post"=>{"summary"=>"Post Sentiment", "description"=>"Performs sentiment analysis on the given document.", "operationId"=>"postS1Sentiment", "x-api-path-slug"=>"s1sentiment-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sentiment"]}}, "/s1/topic"=>{"get"=>{"summary"=>"Get Topic", "description"=>"Performs topic detection on the given document.", "operationId"=>"getS1Topic", "x-api-path-slug"=>"s1topic-get", "parameters"=>[{"in"=>"query", "name"=>"extractor", "description"=>"document extractor"}, {"in"=>"query", "name"=>"language", "description"=>"document language"}, {"in"=>"query", "name"=>"returnTextInfo"}, {"in"=>"query", "name"=>"text", "description"=>"raw document text"}, {"in"=>"query", "name"=>"url", "description"=>"document URL"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topic"]}, "post"=>{"summary"=>"Post Topic", "description"=>"Performs topic detection on the given document.", "operationId"=>"postS1Topic", "x-api-path-slug"=>"s1topic-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topic"]}}}}, "apis"=>{"name"=>"Geneea", "x-slug"=>"geneea", "description"=>"Geneea helps you analyze large amounts of text. Whether it is Facebook, blogs, e-mails or legal documents in your archives. Within seconds. Dont change your business processes. Simply plug in the output of The Interpretor, our powerful software p...", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/geneea-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"11275166", "tags"=>"API Provider,Entities,Languages,Machine Learning,Profiles,Relative Data,SaaS,Sentiment Analysis,Service API,Tags,Tags,Technology,Topic Identification", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"geneea/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Geneea Natural Language Processing", "x-api-slug"=>"geneea-natural-language-processing", "description"=>"Geneea helps you analyze large amounts of text. Whether it is Facebook, blogs, e-mails or legal documents in your archives. Within seconds. Dont change your business processes. Simply plug in the output of The Interpretor, our powerful software p...", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/geneea-logo.png", "humanURL"=>"https://www.geneea.com", "baseURL"=>"https://api.geneea.com//", "tags"=>"API Provider,Entities,Languages,Machine Learning,Profiles,Relative Data,SaaS,Sentiment Analysis,Service API,Tags,Tags,Technology,Topic Identification", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/geneea/geneea-natural-language-processing-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://www.geneea.com"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/geneea"}, {"type"=>"x-email", "url"=>"info@geneea.com"}, {"type"=>"x-github", "url"=>"https://github.com/Geneea"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/GeneeaAnalytics"}, {"type"=>"x-website", "url"=>"http://geneea.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
versapay{"versapay-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"VersaPay", "x-complete"=>1, "info"=>{"title"=>"VersaPay API Reference", "description"=>"-introductionthe-versapay-api-offers-operations-in-support-of-its-flagship-products-arc--accounts-receivable-platform-with-automated-invoicing-effective-collaboration-flexible-payments-and-cash-application-to-improve-efficiency-and-customer-relationships----importing-exporting-customers-invoices-and-payments----monitoring-file-based-importsbatches--payport--cloud-based-platform-to-electronically-push-and-pull-funds-across-the-eft--ach-network----moving-funds-using-transactions-and-preauthorized-debit-agreements----a-secure-hosted-checkout-for-accepting-payments-through-your-website-or-email-please-contact-us-at-supportversapay-com-for-support-setup-of-ar-invoicing-integration-hosted-checkout-andor-payment-acceptance--environmentsthe-demo-environment-is-a-useful-sandbox-for-integration-testing-where-transaction-settlements-are-simulated-using-test-account-numbers-and-test-dollar-amounts-httpsdemo-versapay-comonce-integration-testing-is-complete-via-the-demo-environment-start-sending-your-requests-to-the-production-url-to-start-moving-money-andor-integrating-with-versapay-httpssecure-versapay-com-rate-limitsthere-is-a-60-request-per-minute-api-limit--any-requests-above-this-limit-will-result-in-http-return-code-403-forbidden-rate-limit-exceeded--access-to-api-keysvisit-your-account-settings-in-demohttpsdemo-versapay-comaccount-or-productionhttpssecure-versapay-comaccount-to-setup-api-keys-needed-for-authentication-as-well-as-webhooks-to-receive-relevant-callbacks-from-versapay-transaction-processing--you-can-generatedisable-your-api-keys-as-often-as-necessary-for-security-reasons-if-you-do-not-have-an-account-please-contact-versapay-support-for-support-setup-of-ar-invoicing-integration-hosted-checkout-andor-payment-acceptance--authenticationapi-requests-are-authenticated-using-http-basic-access-authenticationhttpsen-wikipedia-orgwikibasic-access-authentication--simply-provide-the-tokenkey-values-as-the-user-and-password-parameters-using-curl-for-instancecurl-u-nvax---un0i----x-post-httpssecure-versapay-comapi----testing-transactions-eft-bank-account-numbersin-the-demo-environment-the-following-test-bank-accounts-can-be-setup-up-in-your-account-institutioninstitution-numberbranchaccount-numbertd00499960112-digitsrbc00316824112-digitsbmo00199520112-digitshsbc01610880112-digitswhen-versapay-prompts-you-to-verify-these-bank-accounts-enter-a-value-of-1-23-for-the-verification-amount-to-determine-the-outcome-of-a-transaction-funded-by-a-bank-account-set-the-amount-accordinglyamountresulting-statex-10nsfedx-11completed-but-nsfedx-30erroranything-elsecompleted-ach-bank-account-numbersplease-contact-supportversapay-com-for-support-setup-of-ach-acceptance-and-bank-account-numbers-that-can-be-used-for-testing--credit-card-numbersplease-contact-supportversapay-com-for-support-setup-of-credit-card-acceptance-and-card-brandsnumbers-that-can-be-used-for-testing--tools-postmantry-out-the-api-using-postman-apphttpswww-getpostman-com-a-powerful-rest-api-client--download-the-versapay-api-reference-as-a-postman-collection-by-clicking-on-the-button-belowrun-in-postmanhttpsrun-pstmn-iobutton-svghttpsapp-getpostman-comruncollection7e34e0700a2f8c3074c6after-downloading-the-collection-set-up-and-configure-the-environment-as-follows1--download-the-sample-environment-filehttpsdevelopers-versapay-comdemo-postman-environment-json-2--import-the-environment-file-in-postman---import-environmenthttpsdevelopers-versapay-comimagesimport-environment-png3--once-it-is-imported-edit-the-environment-to-add-api-token-and-keys-associated-to-your-test-account---edit-environmenthttpsdevelopers-versapay-comimagesedit-environment-png4--click-update-to-save-your-changes-5--before-placing-api-calls-make-sure-the-correct-environment-is-selected---select-environmenthttpsdevelopers-versapay-comimagesselect-environment-png", "contact"=>{"name"=>"VersaPay Support", "url"=>"https://www.versapay.com/support", "email"=>"support@versapay.com"}, "version"=>"1.0.0"}, "host"=>"secure.versapay.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/funds"=>{"get"=>{"summary"=>"View Your Fund Sources", "description"=>"View your fund sources.", "operationId"=>"getFundSources", "x-api-path-slug"=>"apifunds-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "Your", "Fund", "Sources"]}}, "/api/transactions"=>{"get"=>{"summary"=>"View Transactions", "description"=>"View transactions.", "operationId"=>"viewAllTransactions", "x-api-path-slug"=>"apitransactions-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"50 items are displayed per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "", "Transactionss"]}, "post"=>{"summary"=>"Create Transactions", "description"=>"Create transactions.", "operationId"=>"createTransaction", "x-api-path-slug"=>"apitransactions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Transaction to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["", "Transactionss"]}}, "/api/transactions/{token}"=>{"get"=>{"summary"=>"View a Transaction", "description"=>"View a transaction.", "operationId"=>"viewTransaction", "x-api-path-slug"=>"apitransactionstoken-get", "parameters"=>[{"in"=>"path", "name"=>"token", "description"=>"The transaction identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "Transactions"]}}, "/api/transactions/{token}/approve"=>{"post"=>{"summary"=>"Approve a Transaction", "description"=>"Approve a `new` or `wait_for_request_approval` transaction. \nAn API key with administrative access is required to approve a transaction.", "operationId"=>"approveTransaction", "x-api-path-slug"=>"apitransactionstokenapprove-post", "parameters"=>[{"in"=>"body", "name"=>"fund_token", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"token", "description"=>"The transaction identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Approve", "Transactions"]}}, "/api/transactions/{token}/cancel"=>{"post"=>{"summary"=>"Cancel a Transaction", "description"=>"Cancel a `new`, `wait_for_request_approval` or `wait_for_bank_account_verification` transaction you created. Transactions cannot be cancelled after they have been sent to the bank and are `in_progress`. \nAn API key with administrative access is required to approve a transaction.", "operationId"=>"cancelTransaction", "x-api-path-slug"=>"apitransactionstokencancel-post", "parameters"=>[{"in"=>"path", "name"=>"token", "description"=>"The transaction identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Transactions"]}}, "/api/debit_agreements"=>{"post"=>{"summary"=>"Create an Agreement", "description"=>"Create an agreement.", "operationId"=>"createAgreement", "x-api-path-slug"=>"apidebit-agreements-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Create", "", "Agreementss"]}}, "/api/debit_agreements/sent"=>{"get"=>{"summary"=>"View Sent Agreements", "description"=>"View sent agreements.", "operationId"=>"viewSentAgreements", "x-api-path-slug"=>"apidebit-agreementssent-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"50 items are displayed per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "Sent", "Agreements"]}}, "/api/debit_agreements/received"=>{"get"=>{"summary"=>"View Received Agreements", "description"=>"View received agreements.", "operationId"=>"viewReceivedAgreements", "x-api-path-slug"=>"apidebit-agreementsreceived-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"50 items are displayed per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "Received", "Agreements"]}}, "/api/debit_agreements/{token}/approve"=>{"post"=>{"summary"=>"Approve an Agreement", "description"=>"Approve an agreement.", "operationId"=>"approveAgreement", "x-api-path-slug"=>"apidebit-agreementstokenapprove-post", "parameters"=>[{"in"=>"body", "name"=>"fund_token", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"token", "description"=>"The agreement identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Approve", "Agreements"]}}, "/api/debit_agreements/{token}/cancel"=>{"post"=>{"summary"=>"Cancel an Agreement", "description"=>"Cancel an agreement.", "operationId"=>"cancelAgreement", "x-api-path-slug"=>"apidebit-agreementstokencancel-post", "parameters"=>[{"in"=>"path", "name"=>"token", "description"=>"The agreement identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Agreements"]}}, "/api/debit_agreements/{token}/reject"=>{"post"=>{"summary"=>"Reject an Agreement", "description"=>"Reject a *pending* agreement by supplying an agreement's *token* attribute and providing a *rejection_reason*.", "operationId"=>"rejectAgreement", "x-api-path-slug"=>"apidebit-agreementstokenreject-post", "parameters"=>[{"in"=>"path", "name"=>"token", "description"=>"The agreement identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reject", "Agreements"]}}, "/api/debit_agreements/{token}/revoke"=>{"post"=>{"summary"=>"Revoke an Agreement", "description"=>"Revoke an *approved* agreement for your account by supplying an agreement's token attribute. The agreement's creator will no longer be able to debit your account using this agreement.", "operationId"=>"revokeAgreement", "x-api-path-slug"=>"apidebit-agreementstokenrevoke-post", "parameters"=>[{"in"=>"path", "name"=>"token", "description"=>"The agreement identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Revoke", "Agreements"]}}, "/send_money"=>{"get"=>{"summary"=>"Single Payment Hosted Checkout", "description"=>"Clients, customers, or donors, for instance, can send your organization money directly from their bank account or credit card simply by clicking a link which displays a page with your account name allowing your customer to make a payment to you for the specified dollar amount:\n \n`https://secure.versapay.com/send_money?api_token={your_api_token}&amount={dollar_amount_for_customer_to_pay}`\n \nFunds will go to the fund destination passed in the to_fund parameter. By default, the funds will be deposited into your default bank account once the transaction clears from the other party.", "operationId"=>"hostedCheckout", "x-api-path-slug"=>"send-money-get", "parameters"=>[{"in"=>"query", "name"=>"amount", "description"=>"The amount in dollars that the transaction is for"}, {"in"=>"query", "name"=>"api_token", "description"=>"A valid API token generated from your account"}, {"in"=>"query", "name"=>"link_url", "description"=>"A url that gets stored and displayed on the transaction for an invoice"}, {"in"=>"query", "name"=>"locale", "description"=>"Set the default language of the checkout, either `en` or `fr`"}, {"in"=>"query", "name"=>"message", "description"=>"A message which will be stored with the transaction"}, {"in"=>"query", "name"=>"pref", "description"=>"The preferred payment type either `ba` or `cc` for bank or credit card respectively"}, {"in"=>"query", "name"=>"reference", "description"=>"Extra data (max 255 characters)"}, {"in"=>"query", "name"=>"return_to", "description"=>"A url which will displayed to the user to return to your website after they finish the Signup and Confirmation"}, {"in"=>"query", "name"=>"to_fund", "description"=>"The token of the bank account or balance where the funds should go to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Payment", "Hosted", "Checkout"]}}, "/authorize"=>{"get"=>{"summary"=>"Debit Agreement Hosted Checkout", "description"=>"Clients, customers, or donors, for instance, can initiate a pre-authorized debit agreement by clicking a link on your website or in an email.\n \n`https://secure.versapay.com/authorize?api_token={your_api_token}&message={explanation_of_what_this_is_for}`\n ", "operationId"=>"clients-customers-or-donors-for-instance-can-initiate-a-preauthorized-debit-agreement-by-clicking-a-", "x-api-path-slug"=>"authorize-get", "parameters"=>[{"in"=>"query", "name"=>"api_token", "description"=>"A valid API token generated from your account"}, {"in"=>"query", "name"=>"message", "description"=>"A message for the user describing the pre-authorized debit agreement"}, {"in"=>"query", "name"=>"reference", "description"=>"Extra data (max 255 characters)"}, {"in"=>"query", "name"=>"return_to", "description"=>"A url which will displayed to the user to return to your website after they finish the Signup and Confirmation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Debit", "", "Agreements", "Hosted", "Checkout"]}}, "/api/imports/customer"=>{"post"=>{"summary"=>"Create and Update Customer", "description"=>"Create a customer in ARC using the following attributes (at minimum by providing values for required attributes). If providing an identifier for an existing customer, its information is updated. \n*Note: Any additional non-standard attribute will be stored with customer record and available for presentment rendering.*", "operationId"=>"createCustomer", "x-api-path-slug"=>"apiimportscustomer-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer"]}}, "/api/imports/invoice"=>{"post"=>{"summary"=>"Create and Update Invoice", "description"=>"Create and update invoices in ARC. If the invoice already exists when a request is processed, it will be updated. \nThe set of attributes to send in the request body may vary based on the account configuration. Please contact the implementation specialist for more information. \n*Note:*\n * *Customer will be created/updated using the customer_* attributes if necessary at time of invoice import.*\n * *Any additional non-standard attribute will be stored with invoice record and available for presentment rendering.*", "operationId"=>"createInvoice", "x-api-path-slug"=>"apiimportsinvoice-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice"]}}, "/api/imports/payment"=>{"post"=>{"summary"=>"Create a Payment", "description"=>"Create and update external payment records in ARC. The set of attributes to send in the request body may vary based on the account configuration. Please contact the implementation specialist for more information. \nThe request schema for posting a payment for a single invoice is slightly different than that for posting a payment for multiple invoices.\n\nFor instance, sample request for posting payment for a single invoice looks like:\n```\n{\n \"identifier\": \"PMT0010-05\",\n \"invoice_number\": \"INV1234-01\",\n \"amount\": 10000,\n \"currency\": \"usd\",\n \"date\": \"2018-01-10\",\n \"customer_identifier\": \"C1234\",\n \"customer_name\": \"Acme Inc.\",\n \"notes\": \"Notes\",\n \"ref1\": \"1234\",\n \"ref2\": \"PO# 84767\"\n}\n```\n\n*Note: Customer will be created using the customer_* attributes if it doesn???t already exist at the time of payment import.*", "operationId"=>"createPayment", "x-api-path-slug"=>"apiimportspayment-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreatePayment"]}}, "/api/imports"=>{"get"=>{"summary"=>"View In-Progress & Completed Batches", "description"=>"View recent in-progress and completed import batches.", "operationId"=>"viewAllBatches", "x-api-path-slug"=>"apiimports-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"50 items are displayed per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "In-Progress", "&", "Completed", "Batches"]}, "post"=>{"summary"=>"Import a CSV File", "description"=>"When uploading a CSV-formatted file it???s helpful to use your language/framework tooling to simplify the [multipart/form-data](https://www.ietf.org/rfc/rfc2388.txt) file upload.\n### Size Limit\nThe file cannot exceed 25MB.\n### Layouts\nPlease contact support@versapay.com or reach out to your implementation specialist for standard inbound CSV file layouts.", "operationId"=>"importBatchFile", "x-api-path-slug"=>"apiimports-post", "parameters"=>[{"in"=>"formData", "name"=>"file", "description"=>"The file to upload"}, {"in"=>"formData", "name"=>"filename", "description"=>"Name of original file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ImportCSV", "File"]}}, "/api/imports/processing"=>{"get"=>{"summary"=>"View In-Progress Batches", "description"=>"View only recent in-progress import batches.", "operationId"=>"viewInProgressBatches", "x-api-path-slug"=>"apiimportsprocessing-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"50 items are displayed per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "In-Progress", "Batches"]}}, "/api/imports/completed"=>{"get"=>{"summary"=>"View Completed Batches", "description"=>"View only recent completed import batches.", "operationId"=>"viewCompletedBatches", "x-api-path-slug"=>"apiimportscompleted-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"50 items are displayed per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "Completed", "Batches"]}}, "/api/imports/{id}"=>{"get"=>{"summary"=>"View Batch Details", "description"=>"View batch details.", "operationId"=>"viewBatchDetail", "x-api-path-slug"=>"apiimportsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The import batch identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "Batch", "Details"]}}, "/api/exports/payment_amounts"=>{"get"=>{"summary"=>"Payments made in ARC", "description"=>"Payments made to your supplier account from your customers since watermark, limited to 100 payment amounts at a time. A consumer should store the last `id` value of each response and include it as the watermark parameter for a subsequent calls.", "operationId"=>"getARCPayments", "x-api-path-slug"=>"apiexportspayment-amounts-get", "parameters"=>[{"in"=>"query", "name"=>"watermark", "description"=>"The `id` value to base a subsequent extract of the next 100 payment amounts"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments", "made", "in", "ARC"]}}, "/api/exports/disputes"=>{"get"=>{"summary"=>"Open and Closed Disputes", "description"=>"Open and closed disputes since watermark, limited to 100 disputes at a time.", "operationId"=>"getDisputes", "x-api-path-slug"=>"apiexportsdisputes-get", "parameters"=>[{"in"=>"query", "name"=>"watermark", "description"=>"The date value to base a subsequent extract of the next 100 disputes"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OpenClosed", "Disputes"]}}}}, "apis"=>{"name"=>"VersaPay", "x-slug"=>"versapay", "description"=>"VersaPay handles elements of both credit and debit card merchant payment processing in Canada. In offering a host of merchant account services and credit card POS terminals it allows for an efficient merchant payment service in all aspects- in person, on the go, online, and at the office. Founded in 2005 by Michael Gokturk, VersaPay is a Canadian owned and operated national financial transaction services provider partnered with Chase Paymentech. Versapay also offers electronic funds transfer through a system called Versapay EMT.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1208-versapay-corporation.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"410909", "tags"=>"Billing,Checking,Financial Services,Payments,Payments,Relative Data,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"versapay/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"VersaPay", "x-api-slug"=>"versapay", "description"=>"VersaPay handles elements of both credit and debit card merchant payment processing in Canada. In offering a host of merchant account services and credit card POS terminals it allows for an efficient merchant payment service in all aspects- in person, on the go, online, and at the office. Founded in 2005 by Michael Gokturk, VersaPay is a Canadian owned and operated national financial transaction services provider partnered with Chase Paymentech. Versapay also offers electronic funds transfer through a system called Versapay EMT.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1208-versapay-corporation.jpg", "humanURL"=>"http://developers.versapay.com/index.html", "baseURL"=>"https://secure.versapay.com//", "tags"=>"Billing,Checking,Financial Services,Payments,Payments,Relative Data,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/versapay/apiexportsdisputes-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/versapay/versapay-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://secure.versapay.com/api/"}, {"type"=>"x-blog", "url"=>"https://www.versapay.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"http://www.versapay.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/versapay"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/versapay"}, {"type"=>"x-github", "url"=>"https://github.com/versapay"}, {"type"=>"x-partners", "url"=>"https://www.versapay.com/partners/"}, {"type"=>"x-support", "url"=>"https://www.versapay.com/support/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/VersaPay"}, {"type"=>"x-website", "url"=>"http://developers.versapay.com/index.html"}, {"type"=>"x-website", "url"=>"https://www.versapay.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-spectrum-database{"google-spectrum-database-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Spectrum Database", "x-complete"=>1, "info"=>{"title"=>"Google Spectrum Database", "description"=>"api-for-spectrummanagement-functions-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1explorer"}, "host"=>"www.googleapis.com", "basePath"=>"/spectrum/v1explorer/paws", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/getSpectrum"=>{"post"=>{"summary"=>"Get Spectrum", "description"=>"Requests information about the available spectrum for a device at a location. Requests from a fixed-mode device must include owner information so the device can be registered with the database.", "operationId"=>"spectrum.paws.getSpectrum", "x-api-path-slug"=>"getspectrum-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spectrum"]}}, "/getSpectrumBatch"=>{"post"=>{"summary"=>"Get Spectrum Batch", "description"=>"The Google Spectrum Database does not support batch requests, so this method always yields an UNIMPLEMENTED error.", "operationId"=>"spectrum.paws.getSpectrumBatch", "x-api-path-slug"=>"getspectrumbatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spectrum"]}}, "/init"=>{"post"=>{"summary"=>"Initialize Connection", "description"=>"Initializes the connection between a white space device and the database.", "operationId"=>"spectrum.paws.init", "x-api-path-slug"=>"init-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connection"]}}, "/notifySpectrumUse"=>{"post"=>{"summary"=>"Notify Spectrum Use", "description"=>"Notifies the database that the device has selected certain frequency ranges for transmission. Only to be invoked when required by the regulator. The Google Spectrum Database does not operate in domains that require notification, so this always yields an UNIMPLEMENTED error.", "operationId"=>"spectrum.paws.notifySpectrumUse", "x-api-path-slug"=>"notifyspectrumuse-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spectrum"]}}, "/register"=>{"post"=>{"summary"=>"Register Spectrum", "description"=>"The Google Spectrum Database implements registration in the getSpectrum method. As such this always returns an UNIMPLEMENTED error.", "operationId"=>"spectrum.paws.register", "x-api-path-slug"=>"register-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spectrum"]}}, "/verifyDevice"=>{"post"=>{"summary"=>"Verify Device", "description"=>"Validates a device for white space use in accordance with regulatory rules. The Google Spectrum Database does not support master/slave configurations, so this always yields an UNIMPLEMENTED error.", "operationId"=>"spectrum.paws.verifyDevice", "x-api-path-slug"=>"verifydevice-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device"]}}}}, "apis"=>{"name"=>"Google Spectrum Database", "x-slug"=>"google-spectrum-database", "description"=>"The Google Spectrum Database API provides PAWS-compatible JSON-RPC methods that allow devices to query the database to find available TV-band spectrum at a given geolocation.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-spectrum-database-earth.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Networks,Profiles,Relative Data,Service API,Spectrum,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-spectrum-database/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Spectrum Database API", "x-api-slug"=>"google-spectrum-database-api", "description"=>"The Google Spectrum Database API provides PAWS-compatible JSON-RPC methods that allow devices to query the database to find available TV-band spectrum at a given geolocation.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-spectrum-database-earth.jpg", "humanURL"=>"https://www.google.com/get/spectrumdatabase/", "baseURL"=>"://www.googleapis.com//spectrum/v1explorer/paws", "tags"=>"API Provider,API Service Provider,Google APIs,Networks,Profiles,Relative Data,Service API,Spectrum,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-spectrum-database/google-spectrum-database-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://developers.google.com/spectrum/v1"}, {"type"=>"x-getting-started", "url"=>"https://developers.google.com/spectrum/paws/gettingstarted"}, {"type"=>"x-terms-of-service", "url"=>"https://developers.google.com/spectrum/terms"}, {"type"=>"x-developer", "url"=>"https://developers.google.com/spectrum/"}, {"type"=>"x-website", "url"=>"https://www.google.com/get/spectrumdatabase/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
globalchange-gov{"global-change-information-system-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"GlobalChange.gov", "x-complete"=>1, "info"=>{"title"=>"Global Change Information System API", "description"=>"who-we-are-what-the-gcis-is-and-how-we-use-identifiers-and-semantic-information-to-provide-points-of-reference-and-traceability--examples-and-tutorials-for-using-this-system-as-a-researcher-citizen-scientist-application-developer-or-information-theorist--a-description-of-how-the-information-is-structured-including-the-overlaps-between-relational-and-semantic-representations-of-the-information--complete-documentation-for-the-api-including-methods-for-browsing-and-finding-resources-", "version"=>"v1"}, "host"=>"data.globalchange.gov", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/activity"=>{"get"=>{"summary"=>"List activities.", "description"=>"List the activities, 20 per page.", "operationId"=>"list-the-activities-20-per-page", "x-api-path-slug"=>"activity-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the activities"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activities"]}}, "/activity/{activity_identifier}"=>{"get"=>{"summary"=>"Get a representation of an activity.", "description"=>"Get JSON which represents the structure of an activity.", "operationId"=>"get-json-which-represents-the-structure-of-an-activity", "x-api-path-slug"=>"activityactivity-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"activity_identifier", "description"=>"activity_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Activity"]}}, "/array"=>{"get"=>{"summary"=>"List arrays.", "description"=>"List the arrays, 20 per page.", "operationId"=>"list-the-arrays-20-per-page", "x-api-path-slug"=>"array-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the arrays"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Arrays"]}}, "/array/{array_identifier}"=>{"get"=>{"summary"=>"Get a representation of an array.", "description"=>"Get JSON which represents the structure of an array.", "operationId"=>"get-json-which-represents-the-structure-of-an-array", "x-api-path-slug"=>"arrayarray-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"array_identifier", "description"=>"array_identifier description"}, {"in"=>"query", "name"=>"with_gcmd", "description"=>"Include GCMD keywords associated with the array"}, {"in"=>"query", "name"=>"with_regions", "description"=>"Include regions associated with the array"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Array"]}}, "/article"=>{"get"=>{"summary"=>"List articles.", "description"=>"List the articles, 20 per page.", "operationId"=>"list-the-articles-20-per-page", "x-api-path-slug"=>"article-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the articles"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Articles"]}}, "/article/{article_identifier}"=>{"get"=>{"summary"=>"Get a representation of an article.", "description"=>"Get JSON which represents the structure of an article.", "operationId"=>"get-json-which-represents-the-structure-of-an-article", "x-api-path-slug"=>"articlearticle-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"article_identifier", "description"=>"article_identifier description"}, {"in"=>"query", "name"=>"with_gcmd", "description"=>"Include GCMD keywords associated with the article"}, {"in"=>"query", "name"=>"with_regions", "description"=>"Include regions associated with the article"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Article"]}}, "/book"=>{"get"=>{"summary"=>"List books.", "description"=>"List the books, 20 per page.", "operationId"=>"list-the-books-20-per-page", "x-api-path-slug"=>"book-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the books"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Books"]}}, "/book/{book_identifier}"=>{"get"=>{"summary"=>"Get a representation of a book.", "description"=>"Get JSON which represents the structure of a book.", "operationId"=>"get-json-which-represents-the-structure-of-a-book", "x-api-path-slug"=>"bookbook-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"book_identifier", "description"=>"book_identifier description"}, {"in"=>"query", "name"=>"with_gcmd", "description"=>"Include GCMD keywords associated with the book"}, {"in"=>"query", "name"=>"with_regions", "description"=>"Include regions associated with the book"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Book"]}}, "/contributor/{contributor_identifier}"=>{"get"=>{"summary"=>"Redirect to a particular contributor.", "description"=>"Given a numeric ID, redirect to the full URI of a contributor.", "operationId"=>"given-a-numeric-id-redirect-to-the-full-uri-of-a-contributor", "x-api-path-slug"=>"contributorcontributor-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"contributor_identifier", "description"=>"contributor_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redirect", "To", "Particular", "Contributor"]}}, "/dataset"=>{"get"=>{"summary"=>"List datasets.", "description"=>"List the datasets, 20 per page.", "operationId"=>"list-the-datasets-20-per-page", "x-api-path-slug"=>"dataset-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the datasets"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets"]}}, "/dataset/lookup/{doi}"=>{"get"=>{"summary"=>"Look up a dataset by DOI.", "description"=>"Given a DOI, return a redirect to the GCIS dataset.", "operationId"=>"given-a-doi-return-a-redirect-to-the-gcis-dataset", "x-api-path-slug"=>"datasetlookupdoi-get", "parameters"=>[{"in"=>"path", "name"=>"doi", "description"=>"doi description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Look", "Up", "Dataset", "By", "DOI"]}}, "/dataset/{dataset_identifier}"=>{"get"=>{"summary"=>"Get a representation of a dataset.", "description"=>"Get JSON which represents the structure of a dataset.", "operationId"=>"get-json-which-represents-the-structure-of-a-dataset", "x-api-path-slug"=>"datasetdataset-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"dataset_identifier", "description"=>"dataset_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Dataset"]}}, "/figure"=>{"get"=>{"summary"=>"List all figures", "description"=>"List all the figures in GCIS.", "operationId"=>"list-all-the-figures-in-gcis", "x-api-path-slug"=>"figure-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the figures"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["", "Figures"]}}, "/file/{file_identifier}"=>{"get"=>{"summary"=>"Get a representation of a file.", "description"=>"Get JSON which represents the structure of a file.", "operationId"=>"get-json-which-represents-the-structure-of-a-file", "x-api-path-slug"=>"filefile-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"file_identifier", "description"=>"file_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "File"]}}, "/gcmd_keyword"=>{"get"=>{"summary"=>"List GCMD keywords in the GCIS.", "description"=>"List the GCMD keywords in the GCIS, 20 per page.", "operationId"=>"list-the-gcmd-keywords-in-the-gcis-20-per-page", "x-api-path-slug"=>"gcmd-keyword-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GCMD", "Keywords", "GCIS"]}}, "/gcmd_keyword/{gcmd_keyword_identifier}"=>{"get"=>{"summary"=>"Get a representation of a GCMD keyword.", "description"=>"Get JSON which represents the structure of a GCMD keyword.", "operationId"=>"get-json-which-represents-the-structure-of-a-gcmd-keyword", "x-api-path-slug"=>"gcmd-keywordgcmd-keyword-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"gcmd_keyword_identifier", "description"=>"gcmd_keyword_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "GCMD", "Keyword"]}}, "/generic"=>{"get"=>{"summary"=>"List generic publications.", "description"=>"List the generic publications, 20 per page.", "operationId"=>"list-the-generic-publications-20-per-page", "x-api-path-slug"=>"generic-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the generic publications"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generic", "Publications"]}}, "/generic/{generic_identifier}"=>{"get"=>{"summary"=>"Get a representation of a generic publication.", "description"=>"Get JSON which represents the structure of a generic publication.", "operationId"=>"get-json-which-represents-the-structure-of-a-generic-publication", "x-api-path-slug"=>"genericgeneric-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"generic_identifier", "description"=>"generic_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Generic", "Publication"]}}, "/image"=>{"get"=>{"summary"=>"List images.", "description"=>"List the images, 20 per page.", "operationId"=>"list-the-images-20-per-page", "x-api-path-slug"=>"image-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the images"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images"]}}, "/image/{image_identifier}"=>{"get"=>{"summary"=>"Get a representation of an image.", "description"=>"Get JSON which represents the structure of an image.", "operationId"=>"get-json-which-represents-the-structure-of-an-image", "x-api-path-slug"=>"imageimage-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"image_identifier", "description"=>"image_identifier description"}, {"in"=>"query", "name"=>"with_gcmd", "description"=>"Include GCMD keywords associated with the image"}, {"in"=>"query", "name"=>"with_regions", "description"=>"Include regions associated with the image"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Image"]}}, "/instrument"=>{"get"=>{"summary"=>"List instruments.", "description"=>"List the instruments, 20 per page.", "operationId"=>"list-the-instruments-20-per-page", "x-api-path-slug"=>"instrument-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the instruments"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instruments"]}}, "/instrument/{instrument_identifier}"=>{"get"=>{"summary"=>"Get a representation of an instrument.", "description"=>"Get JSON which represents the structure of an instrument.", "operationId"=>"get-json-which-represents-the-structure-of-an-instrument", "x-api-path-slug"=>"instrumentinstrument-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"instrument_identifier", "description"=>"instrument_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Instrument"]}}, "/journal"=>{"get"=>{"summary"=>"List journals.", "description"=>"List the journals, 20 per page.", "operationId"=>"list-the-journals-20-per-page", "x-api-path-slug"=>"journal-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the journals"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Journals"]}}, "/journal/{journal_identifier}"=>{"get"=>{"summary"=>"Get a representation of a journal.", "description"=>"Get JSON which represents the structure of a journal.", "operationId"=>"get-json-which-represents-the-structure-of-a-journal", "x-api-path-slug"=>"journaljournal-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"journal_identifier", "description"=>"journal_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Journal"]}}, "/lexicon"=>{"get"=>{"summary"=>"List lexicons.", "description"=>"List the lexicons, 20 per page.", "operationId"=>"list-the-lexicons-20-per-page", "x-api-path-slug"=>"lexicon-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the lexicons"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lexicons"]}}, "/lexicon/{lexicon_identifier}"=>{"get"=>{"summary"=>"Get a representation of a lexicon.", "description"=>"Get JSON which represents the structure of a lexicon.", "operationId"=>"get-json-which-represents-the-structure-of-a-lexicon", "x-api-path-slug"=>"lexiconlexicon-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"lexicon_identifier", "description"=>"lexicon_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Lexicon"]}}, "/lexicon/{lexicon_identifier}/find/{context}/{term}"=>{"get"=>{"summary"=>"Lookup a GCID from a term", "description"=>"Given a lexicon, term, and context, return a 303 redirect to a GCID", "operationId"=>"given-a-lexicon-term-and-context-return-a-303-redirect-to-a-gcid", "x-api-path-slug"=>"lexiconlexicon-identifierfindcontextterm-get", "parameters"=>[{"in"=>"path", "name"=>"context", "description"=>"context description"}, {"in"=>"path", "name"=>"lexicon_identifier", "description"=>"lexicon_identifier description"}, {"in"=>"path", "name"=>"term", "description"=>"term description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lookup", "GCID", "From", "Term"]}}, "/lexicon/{lexicon_identifier}/list/{context}"=>{"get"=>{"summary"=>"List the terms within a context of a lexicon", "description"=>"List the terms within a context of a lexicon", "operationId"=>"list-the-terms-within-a-context-of-a-lexicon", "x-api-path-slug"=>"lexiconlexicon-identifierlistcontext-get", "parameters"=>[{"in"=>"path", "name"=>"context", "description"=>"context description"}, {"in"=>"path", "name"=>"lexicon_identifier", "description"=>"lexicon_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Terms", "Within", "Context", "Lexicon"]}}, "/lexicon/{lexicon_identifier}/{context}/{term}"=>{"get"=>{"summary"=>"Lookup a GCID from a term", "description"=>"Given a lexicon, term, and context, return a 303 redirect to a GCID", "operationId"=>"given-a-lexicon-term-and-context-return-a-303-redirect-to-a-gcid", "x-api-path-slug"=>"lexiconlexicon-identifiercontextterm-get", "parameters"=>[{"in"=>"path", "name"=>"context", "description"=>"context description"}, {"in"=>"path", "name"=>"lexicon_identifier", "description"=>"lexicon_identifier description"}, {"in"=>"path", "name"=>"term", "description"=>"term description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lookup", "GCID", "From", "Term"]}}, "/metrics"=>{"get"=>{"summary"=>"Get overall metrics about GCIS data", "description"=>"Get overall metrics about GCIS data", "operationId"=>"get-overall-metrics-about-gcis-data", "x-api-path-slug"=>"metrics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Overall", "Metrics", "About", "GCIS", "Data"]}}, "/model"=>{"get"=>{"summary"=>"List models.", "description"=>"List the models, 20 per page.", "operationId"=>"list-the-models-20-per-page", "x-api-path-slug"=>"model-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the models"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Models"]}}, "/model/{model_identifier}"=>{"get"=>{"summary"=>"Get a representation of a model.", "description"=>"Get JSON which represents the structure of a model.", "operationId"=>"get-json-which-represents-the-structure-of-a-model", "x-api-path-slug"=>"modelmodel-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"model_identifier", "description"=>"model_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Model"]}}, "/model/{model_identifier}/run"=>{"get"=>{"summary"=>"List model runs for a particular model.", "description"=>"List the model runs for a particular model, 20 per page.", "operationId"=>"list-the-model-runs-for-a-particular-model-20-per-page", "x-api-path-slug"=>"modelmodel-identifierrun-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the model runs"}, {"in"=>"path", "name"=>"model_identifier", "description"=>"model_identifier description"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Model", "Runsa", "Particular", "Model"]}}, "/model_run"=>{"get"=>{"summary"=>"List model runs.", "description"=>"List the model runs, 20 per page.", "operationId"=>"list-the-model-runs-20-per-page", "x-api-path-slug"=>"model-run-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the model runs"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Model", "Runs"]}}, "/model_run/{model_identifier}/{scenario_identifier}/{range_start}/{range_end}/{spatial_resolution}/{time_resolution}/{sequence}"=>{"get"=>{"summary"=>"Get a representation of a model run.", "description"=>"Get JSON which represents the structure of a model run.", "operationId"=>"get-json-which-represents-the-structure-of-a-model-run", "x-api-path-slug"=>"model-runmodel-identifierscenario-identifierrange-startrange-endspatial-resolutiontime-resolutionsequence-get", "parameters"=>[{"in"=>"path", "name"=>"model_identifier", "description"=>"model_identifier description"}, {"in"=>"path", "name"=>"range_end", "description"=>"range_end description"}, {"in"=>"path", "name"=>"range_start", "description"=>"range_start description"}, {"in"=>"path", "name"=>"scenario_identifier", "description"=>"scenario_identifier description"}, {"in"=>"path", "name"=>"sequence", "description"=>"sequence description"}, {"in"=>"path", "name"=>"spatial_resolution", "description"=>"spatial_resolution description"}, {"in"=>"path", "name"=>"time_resolution", "description"=>"time_resolution description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Model", "Run"]}}, "/model_run/{model_run_identifier}"=>{"get"=>{"summary"=>"Get a representation of a model run.", "description"=>"Get JSON which represents the structure of a model run.", "operationId"=>"get-json-which-represents-the-structure-of-a-model-run", "x-api-path-slug"=>"model-runmodel-run-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"model_run_identifier", "description"=>"model_run_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Model", "Run"]}}, "/organization"=>{"get"=>{"summary"=>"List organizations.", "description"=>"List the organizations, 20 per page.", "operationId"=>"list-the-organizations-20-per-page", "x-api-path-slug"=>"organization-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the organizations"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}, "/organization/{organization_identifier}"=>{"get"=>{"summary"=>"Get a representation of an organization.", "description"=>"Get JSON which represents the structure of an organization.", "operationId"=>"get-json-which-represents-the-structure-of-an-organization", "x-api-path-slug"=>"organizationorganization-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"organization_identifier", "description"=>"organization_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Organization"]}}, "/organization/{organization_identifier}/contributions/{role_type_identifier}/{resource}"=>{"get"=>{"summary"=>"Show contributions of a certain type by an organization", "description"=>"Given a resource (dataset, report, etc.) and a role (editor, etc), and an identifier for an organization, show the resources to which the organization has contributed in that role.", "operationId"=>"given-a-resource-dataset-report-etc-and-a-role-editor-etc-and-an-identifier-for-an-organization-show", "x-api-path-slug"=>"organizationorganization-identifiercontributionsrole-type-identifierresource-get", "parameters"=>[{"in"=>"path", "name"=>"organization_identifier", "description"=>"organization_identifier description"}, {"in"=>"path", "name"=>"resource", "description"=>"resource description"}, {"in"=>"path", "name"=>"role_type_identifier", "description"=>"role_type_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Show", "Contributions", "Certain", "Type", "By", "Organization"]}}, "/person"=>{"get"=>{"summary"=>"List people.", "description"=>"List the people, 20 per page.", "operationId"=>"list-the-people-20-per-page", "x-api-path-slug"=>"person-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the people"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People"]}}, "/person/{name}"=>{"get"=>{"summary"=>"Redirect to a person based on a name", "description"=>"Given a name (case sensitive, concatenated by dashes), redirect if there is a single match. The first and last names can be in either order.", "operationId"=>"given-a-name-case-sensitive-concatenated-by-dashes-redirect-if-there-is-a-single-match--the-first-an", "x-api-path-slug"=>"personname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redirect", "To", "Person", "Based", "On", "Name"]}}, "/person/{orcid}"=>{"get"=>{"summary"=>"Redirect to a person based on an ORCID.", "description"=>"Given an ORCID, if there is a match, redirect to the persons URI.", "operationId"=>"given-an-orcid-if-there-is-a-match-redirect-to-the-persons-uri", "x-api-path-slug"=>"personorcid-get", "parameters"=>[{"in"=>"path", "name"=>"orcid", "description"=>"orcid description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redirect", "To", "Person", "Based", "On", "ORCID"]}}, "/person/{person_identifier}"=>{"get"=>{"summary"=>"Get a representation of a person.", "description"=>"Get JSON which represents the structure of a person.", "operationId"=>"get-json-which-represents-the-structure-of-a-person", "x-api-path-slug"=>"personperson-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"person_identifier", "description"=>"person_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Person"]}}, "/person/{person_identifier}/contributions/{role_type_identifier}/{resource}"=>{"get"=>{"summary"=>"Show contributions of a certain type by a person", "description"=>"Given a resource (dataset, report, etc.) and a role (editor, etc), and an identifier for a person, show the resources to which the person has contributed in that role.", "operationId"=>"given-a-resource-dataset-report-etc-and-a-role-editor-etc-and-an-identifier-for-a-person-show-the-re", "x-api-path-slug"=>"personperson-identifiercontributionsrole-type-identifierresource-get", "parameters"=>[{"in"=>"path", "name"=>"person_identifier", "description"=>"person_identifier description"}, {"in"=>"path", "name"=>"resource", "description"=>"resource description"}, {"in"=>"path", "name"=>"role_type_identifier", "description"=>"role_type_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Show", "Contributions", "Certain", "Type", "By", "Person"]}}, "/platform"=>{"get"=>{"summary"=>"List platforms.", "description"=>"List the platforms, 20 per page.", "operationId"=>"list-the-platforms-20-per-page", "x-api-path-slug"=>"platform-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the platforms"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Platforms"]}}, "/platform/{platform_identifier}"=>{"get"=>{"summary"=>"Get a representation of a platform.", "description"=>"Get JSON which represents the structure of a platform.", "operationId"=>"get-json-which-represents-the-structure-of-a-platform", "x-api-path-slug"=>"platformplatform-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"platform_identifier", "description"=>"platform_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Platform"]}}, "/platform/{platform_identifier}/instrument"=>{"get"=>{"summary"=>"List instruments on a platform.", "description"=>"List the instruments on a platform, 20 per page.", "operationId"=>"list-the-instruments-on-a-platform-20-per-page", "x-api-path-slug"=>"platformplatform-identifierinstrument-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the instruments"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}, {"in"=>"path", "name"=>"platform_identifier", "description"=>"platform_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instruments", "On", "Platform"]}}, "/platform/{platform_identifier}/instrument/{instrument_identifier}"=>{"get"=>{"summary"=>"Get a representation of an instrument on a platform.", "description"=>"Get JSON which represents the structure of an instrument on a platform.", "operationId"=>"get-json-which-represents-the-structure-of-an-instrument-on-a-platform", "x-api-path-slug"=>"platformplatform-identifierinstrumentinstrument-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"instrument_identifier", "description"=>"instrument_identifier description"}, {"in"=>"path", "name"=>"platform_identifier", "description"=>"platform_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Instrument", "On", "Platform"]}}, "/project"=>{"get"=>{"summary"=>"List projects.", "description"=>"List the projects, 20 per page.", "operationId"=>"list-the-projects-20-per-page", "x-api-path-slug"=>"project-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the projects"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/project/{project_identifier}"=>{"get"=>{"summary"=>"Get a representation of a project.", "description"=>"Get JSON which represents the structure of a project.", "operationId"=>"get-json-which-represents-the-structure-of-a-project", "x-api-path-slug"=>"projectproject-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"project_identifier", "description"=>"project_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Project"]}}, "/publication/{publication_identifier}"=>{"get"=>{"summary"=>"Redirect to a particular publication.", "description"=>"Given a numeric ID, redirect to the full URI of a publication.", "operationId"=>"given-a-numeric-id-redirect-to-the-full-uri-of-a-publication", "x-api-path-slug"=>"publicationpublication-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"publication_identifier", "description"=>"publication_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redirect", "To", "Particular", "Publication"]}}, "/reference"=>{"get"=>{"summary"=>"List references.", "description"=>"List the references, 20 per page.", "operationId"=>"list-the-references-20-per-page", "x-api-path-slug"=>"reference-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["References"]}}, "/reference/{reference_identifier}"=>{"get"=>{"summary"=>"Get a representation of a reference.", "description"=>"Get JSON which represents the structure of a reference.", "operationId"=>"get-json-which-represents-the-structure-of-a-reference", "x-api-path-slug"=>"referencereference-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"reference_identifier", "description"=>"reference_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Reference"]}}, "/region"=>{"get"=>{"summary"=>"List regions.", "description"=>"List the regions, 20 per page.", "operationId"=>"list-the-regions-20-per-page", "x-api-path-slug"=>"region-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the regions"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions"]}}, "/region/{region_identifier}"=>{"get"=>{"summary"=>"Get a representation of a region.", "description"=>"Get JSON which represents the structure of a region.", "operationId"=>"get-json-which-represents-the-structure-of-a-region", "x-api-path-slug"=>"regionregion-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"region_identifier", "description"=>"region_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Region"]}}, "/report"=>{"get"=>{"summary"=>"Get a list of reports.", "description"=>"List the reports, 20 per page.", "operationId"=>"list-the-reports-20-per-page", "x-api-path-slug"=>"report-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the reports"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}, {"in"=>"query", "name"=>"report_type", "description"=>"The type of report"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports"]}}, "/report/{report_identifier}"=>{"get"=>{"summary"=>"Get a representation of a report.", "description"=>"Get JSON which represents the structure of a report.", "operationId"=>"get-json-which-represents-the-structure-of-a-report", "x-api-path-slug"=>"reportreport-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}, {"in"=>"query", "name"=>"with_gcmd", "description"=>"Include GCMD keywords associated with the report"}, {"in"=>"query", "name"=>"with_regions", "description"=>"Include regions associated with the report"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Report"]}}, "/report/{report_identifier}/array"=>{"get"=>{"summary"=>"List arrays associated with a report.", "description"=>"List the arrays associated with a report, 20 per page.", "operationId"=>"list-the-arrays-associated-with-a-report-20-per-page", "x-api-path-slug"=>"reportreport-identifierarray-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the arrays"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Arrays", "Associated", "Report"]}}, "/report/{report_identifier}/book"=>{"get"=>{"summary"=>"List books associated with a report.", "description"=>"List the books associated with a report, 20 per page.", "operationId"=>"list-the-books-associated-with-a-report-20-per-page", "x-api-path-slug"=>"reportreport-identifierbook-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the books"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Books", "Associated", "Report"]}}, "/report/{report_identifier}/chapter"=>{"get"=>{"summary"=>"List chapters in a report", "description"=>"Get a list of chapters in a report.", "operationId"=>"get-a-list-of-chapters-in-a-report", "x-api-path-slug"=>"reportreport-identifierchapter-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the chapters"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chapters", "Report"]}}, "/report/{report_identifier}/chapter/{chapter_identifier}"=>{"get"=>{"summary"=>"Get a representation of a chapter.", "description"=>"Get JSON which represents the structure of a chapter.", "operationId"=>"get-json-which-represents-the-structure-of-a-chapter", "x-api-path-slug"=>"reportreport-identifierchapterchapter-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"chapter_identifier", "description"=>"chapter_identifier description"}, {"in"=>"path", "name"=>"ids", "description"=>"{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for answer_id on answer objects"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}, {"in"=>"query", "name"=>"with_gcmd", "description"=>"Include GCMD keywords associated with the chapter"}, {"in"=>"query", "name"=>"with_regions", "description"=>"Include regions associated with the chapter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Chapter"]}}, "/report/{report_identifier}/chapter/{chapter_identifier}/figure"=>{"get"=>{"summary"=>"List figures in a chapter", "description"=>"Get a list of figures in a chapter.", "operationId"=>"get-a-list-of-figures-in-a-chapter", "x-api-path-slug"=>"reportreport-identifierchapterchapter-identifierfigure-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the figures"}, {"in"=>"path", "name"=>"chapter_identifier", "description"=>"chapter_identifier description"}, {"in"=>"path", "name"=>"ids", "description"=>"{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for answer_id on answer objects"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Figures", "Chapter"]}}, "/report/{report_identifier}/chapter/{chapter_identifier}/figure/{figure_identifier}"=>{"get"=>{"summary"=>"Get a representation of a figure in a chapter.", "description"=>"Get JSON which represents the structure of a figure in a chapter.", "operationId"=>"get-json-which-represents-the-structure-of-a-figure-in-a-chapter", "x-api-path-slug"=>"reportreport-identifierchapterchapter-identifierfigurefigure-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"chapter_identifier", "description"=>"chapter_identifier description"}, {"in"=>"path", "name"=>"figure_identifier", "description"=>"figure_identifier description"}, {"in"=>"path", "name"=>"ids", "description"=>"{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for answer_id on answer objects"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}, {"in"=>"query", "name"=>"with_gcmd", "description"=>"Include GCMD keywords associated with the figure"}, {"in"=>"query", "name"=>"with_regions", "description"=>"Include regions associated with the figure"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Figure", "Chapter"]}}, "/report/{report_identifier}/chapter/{chapter_identifier}/finding"=>{"get"=>{"summary"=>"List findings in a chapter", "description"=>"Get a list of findings in a chapter.", "operationId"=>"get-a-list-of-findings-in-a-chapter", "x-api-path-slug"=>"reportreport-identifierchapterchapter-identifierfinding-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the findings"}, {"in"=>"path", "name"=>"chapter_identifier", "description"=>"chapter_identifier description"}, {"in"=>"path", "name"=>"ids", "description"=>"{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for answer_id on answer objects"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Findings", "Chapter"]}}, "/report/{report_identifier}/chapter/{chapter_identifier}/finding/{finding_identifier}"=>{"get"=>{"summary"=>"Get a representation of a finding in a chapter.", "description"=>"Get JSON which represents the structure of a finding in a chapter.", "operationId"=>"get-json-which-represents-the-structure-of-a-finding-in-a-chapter", "x-api-path-slug"=>"reportreport-identifierchapterchapter-identifierfindingfinding-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"chapter_identifier", "description"=>"chapter_identifier description"}, {"in"=>"path", "name"=>"finding_identifier", "description"=>"finding_identifier description"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}, {"in"=>"query", "name"=>"with_gcmd", "description"=>"Include GCMD keywords associated with the finding"}, {"in"=>"query", "name"=>"with_regions", "description"=>"Include regions associated with the finding"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Finding", "Chapter"]}}, "/report/{report_identifier}/chapter/{chapter_identifier}/reference"=>{"get"=>{"summary"=>"List references in a chapter", "description"=>"Get a list of references in a chapter.", "operationId"=>"get-a-list-of-references-in-a-chapter", "x-api-path-slug"=>"reportreport-identifierchapterchapter-identifierreference-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the references"}, {"in"=>"path", "name"=>"chapter_identifier", "description"=>"chapter_identifier description"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["References", "Chapter"]}}, "/report/{report_identifier}/chapter/{chapter_identifier}/table"=>{"get"=>{"summary"=>"List tables in a chapter", "description"=>"Get a list of tables in a chapter.", "operationId"=>"get-a-list-of-tables-in-a-chapter", "x-api-path-slug"=>"reportreport-identifierchapterchapter-identifiertable-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the tables"}, {"in"=>"path", "name"=>"chapter_identifier", "description"=>"chapter_identifier description"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tables", "Chapter"]}}, "/report/{report_identifier}/chapter/{chapter_identifier}/table/{table_identifier}"=>{"get"=>{"summary"=>"Get a representation of a table in a chapter.", "description"=>"Get JSON which represents the structure of a table in a chapter.", "operationId"=>"get-json-which-represents-the-structure-of-a-table-in-a-chapter", "x-api-path-slug"=>"reportreport-identifierchapterchapter-identifiertabletable-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"chapter_identifier", "description"=>"chapter_identifier description"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}, {"in"=>"path", "name"=>"table_identifier", "description"=>"table_identifier description"}, {"in"=>"query", "name"=>"with_gcmd", "description"=>"Include GCMD keywords associated with the table"}, {"in"=>"query", "name"=>"with_regions", "description"=>"Include regions associated with the table"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Table", "Chapter"]}}, "/report/{report_identifier}/figure"=>{"get"=>{"summary"=>"List figures in a report.", "description"=>"List the figures in a report, 20 per page.", "operationId"=>"list-the-figures-in-a-report-20-per-page", "x-api-path-slug"=>"reportreport-identifierfigure-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the figures"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Figures", "Report"]}}, "/report/{report_identifier}/figure/{figure_identifier}"=>{"get"=>{"summary"=>"Get a representation of a figure.", "description"=>"Get JSON which represents the structure of a figure.", "operationId"=>"get-json-which-represents-the-structure-of-a-figure", "x-api-path-slug"=>"reportreport-identifierfigurefigure-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"figure_identifier", "description"=>"figure_identifier description"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}, {"in"=>"query", "name"=>"with_gcmd", "description"=>"Include GCMD keywords associated with the figure"}, {"in"=>"query", "name"=>"with_regions", "description"=>"Include regions associated with the figure"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Figure"]}}, "/report/{report_identifier}/finding"=>{"get"=>{"summary"=>"List findings in a report.", "description"=>"List the findings in a report, 20 per page.", "operationId"=>"list-the-findings-in-a-report-20-per-page", "x-api-path-slug"=>"reportreport-identifierfinding-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the findings"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Findings", "Report"]}}, "/report/{report_identifier}/finding/{finding_identifier}"=>{"get"=>{"summary"=>"Get a representation of a finding.", "description"=>"Get JSON which represents the structure of a finding.", "operationId"=>"get-json-which-represents-the-structure-of-a-finding", "x-api-path-slug"=>"reportreport-identifierfindingfinding-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"finding_identifier", "description"=>"finding_identifier description"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}, {"in"=>"query", "name"=>"with_gcmd", "description"=>"Include GCMD keywords associated with the finding"}, {"in"=>"query", "name"=>"with_regions", "description"=>"Include regions associated with the finding"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Finding"]}}, "/report/{report_identifier}/image"=>{"get"=>{"summary"=>"List images associated with a report.", "description"=>"List the images associated with a report, 20 per page.", "operationId"=>"list-the-images-associated-with-a-report-20-per-page", "x-api-path-slug"=>"reportreport-identifierimage-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the images"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Associated", "Report"]}}, "/report/{report_identifier}/reference"=>{"get"=>{"summary"=>"List references in a report.", "description"=>"List the references in a report, 20 per page.", "operationId"=>"list-the-references-in-a-report-20-per-page", "x-api-path-slug"=>"reportreport-identifierreference-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the references"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["References", "Report"]}}, "/report/{report_identifier}/table"=>{"get"=>{"summary"=>"List tables in a report.", "description"=>"List the tables in a report, 20 per page.", "operationId"=>"list-the-tables-in-a-report-20-per-page", "x-api-path-slug"=>"reportreport-identifiertable-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the tables"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tables", "Report"]}}, "/report/{report_identifier}/table/{table_identifier}"=>{"get"=>{"summary"=>"Get a representation of a table.", "description"=>"Get JSON which represents the structure of a table.", "operationId"=>"get-json-which-represents-the-structure-of-a-table", "x-api-path-slug"=>"reportreport-identifiertabletable-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}, {"in"=>"path", "name"=>"table_identifier", "description"=>"table_identifier description"}, {"in"=>"query", "name"=>"with_gcmd", "description"=>"Include GCMD keywords associated with the table"}, {"in"=>"query", "name"=>"with_regions", "description"=>"Include regions associated with the table"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Table"]}}, "/report/{report_identifier}/webpage"=>{"get"=>{"summary"=>"List webpages associated with a report.", "description"=>"List the webpages associated with a report, 20 per page.", "operationId"=>"list-the-webpages-associated-with-a-report-20-per-page", "x-api-path-slug"=>"reportreport-identifierwebpage-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the webpages"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}, {"in"=>"path", "name"=>"report_identifier", "description"=>"report_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webpages", "Associated", "Report"]}}, "/role_type"=>{"get"=>{"summary"=>"List roles", "description"=>"Get a list of the types of roles for contributors.", "operationId"=>"get-a-list-of-the-types-of-roles-for-contributors", "x-api-path-slug"=>"role-type-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the contributors"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles"]}}, "/scenario"=>{"get"=>{"summary"=>"List scenarios.", "description"=>"List the scenarios, 20 per page.", "operationId"=>"list-the-scenarios-20-per-page", "x-api-path-slug"=>"scenario-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the scenarios"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scenarios"]}}, "/scenario/{scenario_identifier}"=>{"get"=>{"summary"=>"Get a representation of a scenario.", "description"=>"Get JSON which represents the structure of a scenario.", "operationId"=>"get-json-which-represents-the-structure-of-a-scenario", "x-api-path-slug"=>"scenarioscenario-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"scenario_identifier", "description"=>"scenario_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Scenario"]}}, "/scenario/{scenario_identifier}/run"=>{"get"=>{"summary"=>"List model runs for a particular scenario.", "description"=>"List the model runs for a particular scenario, 20 per page.", "operationId"=>"list-the-model-runs-for-a-particular-scenario-20-per-page", "x-api-path-slug"=>"scenarioscenario-identifierrun-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the model runs"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}, {"in"=>"path", "name"=>"scenario_identifier", "description"=>"scenario_identifier description"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Model", "Runsa", "Particular", "Scenario"]}}, "/uuid"=>{"get"=>{"summary"=>"Generate a UUID.", "description"=>" Generate version 4 Universally Unique Identifiers. The algorithm used for thisn is described here.n ", "operationId"=>"pgenerate-version-4-universally-unique-identifiers--the-algorithm-used-for-this----is-described-a-ta", "x-api-path-slug"=>"uuid-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Number of UUIDs to generate (max 1000)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generate", "UUID"]}}, "/webpage"=>{"get"=>{"summary"=>"List web pages.", "description"=>"List the web pages, 20 per page.", "operationId"=>"list-the-web-pages-20-per-page", "x-api-path-slug"=>"webpage-get", "parameters"=>[{"in"=>"query", "name"=>"all", "description"=>"Set to 1 to get all of the web pages"}, {"in"=>"query", "name"=>"page", "description"=>"The page number (starting at 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web", "Pages"]}}, "/webpage/{webpage_identifier}"=>{"get"=>{"summary"=>"Get a representation of a web page.", "description"=>"Get JSON which represents the structure of a web page.", "operationId"=>"get-json-which-represents-the-structure-of-a-web-page", "x-api-path-slug"=>"webpagewebpage-identifier-get", "parameters"=>[{"in"=>"path", "name"=>"webpage_identifier", "description"=>"webpage_identifier description"}, {"in"=>"query", "name"=>"with_gcmd", "description"=>"Include GCMD keywords associated with the web page"}, {"in"=>"query", "name"=>"with_regions", "description"=>"Include regions associated with the web page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representation", "Web", "Page"]}}}}, "apis"=>{"name"=>"GlobalChange.gov", "x-slug"=>"globalchange-gov", "description"=>"The U.S. Global Change Research Program (USGCRP) was established by Presidential Initiative in 1989 and mandated by Congress in the Global Change Research Act (GCRA) of 1990 to “assist the Nation and the world to understand, assess, predict, and respond to human-induced and natural processes of global change.”", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/global-change-gov.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Provider,Federal Government,Federal Government,General Data,Profiles,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"globalchange-gov/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Global Change Information System API", "x-api-slug"=>"global-change-information-system-api", "description"=>"The U.S. Global Change Research Program (USGCRP) was established by Presidential Initiative in 1989 and mandated by Congress in the Global Change Research Act (GCRA) of 1990 to “assist the Nation and the world to understand, assess, predict, and respond to human-induced and natural processes of global change.”", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/global-change-gov.png", "humanURL"=>"http://globalchange.gov/", "baseURL"=>"https://data.globalchange.gov//", "tags"=>"API Provider,Federal Government,Federal Government,General Data,Profiles,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/globalchange-gov/webpagewebpage-identifier-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/globalchange-gov/global-change-information-system-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"http://data.globalchange.gov/"}, {"type"=>"x-website", "url"=>"http://globalchange.gov/"}, {"type"=>"x-website", "url"=>"http://globalchange.gov"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
link-fish{"link-fish-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"link.fish", "x-complete"=>1, "info"=>{"title"=>"link.fish", "description"=>"api-to-easily-extract-data-from-websites--base-urlall-urls-referenced-in-the-documentation-have-the-following-basehttpsapi-link-fishthe-rest-api-is-only-served-over-https--to-ensure-data-privacy-unencrypted-http-is-not-supported--authenticationhttp-requests-to-the-rest-api-are-protected-with-http-basic-authenticationhttpsen-wikipedia-orgwikibasic-access-authentication--you-will-use-the-email-address-of-your-link-fish-account-as-the-username-and-your-api-access-token-as-the-password-for-http-basic-authentication-if-you-do-not-have-an-account-yet-go-to-httpslink-fishapihttpslink-fishapi-and-create-one-first-you-will-receive-the-api-access-token-automatically-via-email-after-you-signed-up--to-generate-a-new-token-and-invalidate-the-current-one-log-into-your-link-fish--account-at-httpsapp-link-fishhttpsapp-link-fish-and-go-to-plugins--api-dashboardthere-you-can-also-see-how-many-credits-you-used-already--errorsthe-api-uses-standard-http-status-codes-to-indicate-the-success-or-failure-of-the-api-call--the-body-of-the-response-will-be-json-in-the-following-format--status-http-status-code--message-error-messagelike-for-example-when-the-authorization-is-not-provided-or-wrong--status-401--message-unauthorized-request-idseach-api-request-has-an-associated-request-identifier--you-can-find-it-in-the-response-headers-under-xlfrequestid--in-case-you-have-problems-please-provide-this-identifier-that-we-can-help-you-as-good-and-fast-as-possible-examplexlfrequestid-f7f0036f5277421ab143f7a151571d18-item-formatthe-data-is-by-default-deeply-nested--so-if-it-should-be-checked-if-there-is-an-offer-with-a-price-the-whole-tree-has-to-be-checked--to-make-that-simpler-it-is-also-possible-to-return-the-data-flat--if-selected-it-will-flatten-the-tree-by-copying-all-the-data-to-the-main-level-under-a-property-with-the-name-of-its-type-and-link-the-data-internally-information-we-created-a-node-module-which-allows-converting-between-the-two-formats--it-did-not-get-open-sourced-yet--if-you-are-in-need-simply-contact-us-via-apilink-fish--response-content-typeby-default-all-data-gets-returned-as-json--if-the-data-should-be-returned-as-xml-add-the-following-headeraccept-applicationxml-creditsdepending-on-the-request-made-a-different-amount-of-credits-get-charged--how-many-which-request-costs-can-be-found-on-the-api-pricing-pagehttplink-fishapipricing--additionally-does-a--header-named-xlfcreditscharged-get-added-to-each-successful-response-with-the-amount-of-credits-charged-examplexlfcreditscharged-1you-can-check-anytime-how-many-credits-you-did-use-already-by-logging-into-your-link-fish--account-at-httpsapp-link-fishhttpsapp-link-fish-and-checking-under--plugins--api-dashboardif-you-have-problems-questions-or-improvement-advice-please-send-us-an-email-to-apilink-fish", "termsOfService"=>"https://link.fish/terms-of-service/", "contact"=>{"name"=>"link.fish", "url"=>"https://link.fish/api", "email"=>"api@link.fish"}, "version"=>"2017-12-01"}, "host"=>"api.link.fish", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/Urls/apps"=>{"get"=>{"summary"=>"Get mobile apps", "description"=>"Visits the URL and checks if there are mobile apps on them and returns the found ones.\n\nWill by default return the app identifiers and not the full URL to the apps. To return URLs instead set the parameter \"return_urls\" to true.\n\nThe URLs can also be created manually like this:\n\n| Property | URL |\n| -------- | -------------------------------------------------- |\n| android | https://play.google.com/store/apps/details?id={ID} |\n| ios | https://itunes.apple.com/us/app/app-name/id{ID} |\n\nProperties only get set when a value for it has been found. That means that if no app has been found only the property \"url\" will be set.", "operationId"=>"Urls.apps.get", "x-api-path-slug"=>"urlsapps-get", "parameters"=>[{"in"=>"query", "name"=>"browser_render", "description"=>"If the page should be fully rendered with a browser to extract data"}, {"in"=>"query", "name"=>"return_urls", "description"=>"Returns app URLs instead of the identifiers"}, {"in"=>"query", "name"=>"url", "description"=>"The URL of the website to query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Urls", "Apps"]}}, "/Urls/browser-data"=>{"get"=>{"summary"=>"Extract data (browser)", "description"=>"Visits the URL with a full browser and extracts the data. This request costs 5 credits.", "operationId"=>"Urls.browser_data.get", "x-api-path-slug"=>"urlsbrowserdata-get", "parameters"=>[{"in"=>"query", "name"=>"item_format", "description"=>"If the items should be return normal with multiple levels or flat with just one level and linked instead"}, {"in"=>"query", "name"=>"screenshot", "description"=>"If and what kind of screenshot should be returned"}, {"in"=>"query", "name"=>"screenshot_file_format", "description"=>"The file format of the screenshot"}, {"in"=>"query", "name"=>"screenshot_width", "description"=>"The widh of the screenshot in pixel"}, {"in"=>"query", "name"=>"simplify_special_types", "description"=>"Some types like PropertyValue do save key and value in separate properties which makes the data harder to process"}, {"in"=>"query", "name"=>"url", "description"=>"The URL of the website to query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Urls", "Browser", "Data"]}}, "/Urls/browser-screenshot"=>{"get"=>{"summary"=>"Generate screenshot (browser)", "description"=>"Visits the URL with full browser and creates a screenshot. This request costs 5 credits.", "operationId"=>"Urls.browser_screenshot.get", "x-api-path-slug"=>"urlsbrowserscreenshot-get", "parameters"=>[{"in"=>"query", "name"=>"file_format", "description"=>"The file format of the screenshot"}, {"in"=>"query", "name"=>"type", "description"=>"What kind of screenshot should be returned"}, {"in"=>"query", "name"=>"url", "description"=>"The URL of the website to create screenshot of"}, {"in"=>"query", "name"=>"width", "description"=>"The widh of the screenshot in pixel"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Urls", "Browser", "Screenshot"]}}, "/Urls/data"=>{"get"=>{"summary"=>"Extract data", "description"=>"Visits the URL and extracts the data.", "operationId"=>"Urls.data.get", "x-api-path-slug"=>"urlsdata-get", "parameters"=>[{"in"=>"query", "name"=>"browser_render", "description"=>"If the page should be fully rendered with a browser to extract data"}, {"in"=>"query", "name"=>"item_format", "description"=>"If the items should be return normal with multiple levels or flat with just one level and linked instead"}, {"in"=>"query", "name"=>"simplify_special_types", "description"=>"Some types like PropertyValue do save key and value in separate properties which makes the data harder to process"}, {"in"=>"query", "name"=>"url", "description"=>"The URL of the website to query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Urls", "Data"]}}, "/Urls/geo-coordinates"=>{"get"=>{"summary"=>"Get geo coordinates", "description"=>"Visits the URL and checks if there are Geo Coordinates on them and returns the found ones.\n\nProperties only get set when a value for both latitude and longitude have been found. That means that if no geo coordinates have been found only the property \"url\" will be set.", "operationId"=>"Urls.geo_coordinates.get", "x-api-path-slug"=>"urlsgeocoordinates-get", "parameters"=>[{"in"=>"query", "name"=>"browser_render", "description"=>"If the page should be fully rendered with a browser to extract data"}, {"in"=>"query", "name"=>"url", "description"=>"The URL of the website to query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Urls", "Geo", "Coordinates"]}}, "/Urls/social-media"=>{"get"=>{"summary"=>"Get social media accounts", "description"=>"Visits the URL and checks if there are any social media accounts and returns the found ones.\n\nWill by default return the account identifiers and not the full URL to the profiles. To return URLs instead set the parameter \"return_urls\" to true.\n\nThe URLs can also be created manually like this:\n\n| Property | URL |\n| --------------- | -------------------------------------- |\n| facebookPage | https://facebook.com/{ID} |\n| githubUser | https://github.com/{ID} |\n| googlePlus | https://plus.google.com/+{ID} |\n| instagram | https://instagram.com/{ID} |\n| linkedInCompany | https://linkedin.com/company/{ID} |\n| pinterest | https://pinterest.com/{ID} |\n| twitter | https://twitter.com/{ID} |\n| youTubeUser | https://youtube.com/user/{ID} |\n\nProperties only get set when a value for it has been found. That means that if no social media account has been found only the property \"url\" will be set.", "operationId"=>"Urls.social_media.get", "x-api-path-slug"=>"urlssocialmedia-get", "parameters"=>[{"in"=>"query", "name"=>"browser_render", "description"=>"If the page should be fully rendered with a browser to extract data"}, {"in"=>"query", "name"=>"return_urls", "description"=>"Returns profile URLs instead of the profile names/ids"}, {"in"=>"query", "name"=>"url", "description"=>"The URL of the website to query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Urls", "Social", "Media"]}}}}, "apis"=>{"name"=>"link.fish", "x-slug"=>"link-fish", "description"=>"Automatically get the information of the websites you are interested in and work with it together with others in real-time. Depending on the page you bookmark link.fish automatically extracts the data you actually care about. No matter if bedrooms for apartments, rating of movies or the cook time of your favorite recipe. Invite other people to your collection to work with them or make it public for everbody to see. All changes made will immediately be visible by everyone.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/link-fish-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,Content,Links,Profiles,Relative Data,Scraping,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"link-fish/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"link.fish", "x-api-slug"=>"link-fish", "description"=>"Automatically get the information of the websites you are interested in and work with it together with others in real-time. Depending on the page you bookmark link.fish automatically extracts the data you actually care about. No matter if bedrooms for apartments, rating of movies or the cook time of your favorite recipe. Invite other people to your collection to work with them or make it public for everbody to see. All changes made will immediately be visible by everyone.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/link-fish-logo.png", "humanURL"=>"http://link.fish", "baseURL"=>"https://api.link.fish//", "tags"=>"API Provider,Content,Links,Profiles,Relative Data,Scraping,Service API", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/link-fish/urlssocialmedia-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/link-fish/link-fish-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"https://link.fish/api/"}, {"type"=>"x-github", "url"=>"https://github.com/link-fish"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/linkfish_"}, {"type"=>"x-website", "url"=>"http://link.fish"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-redis-cache{"azure-redis-cache-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Redis Cache", "x-complete"=>1, "info"=>{"title"=>"RedisManagementClient", "description"=>"rest-api-for-azure-redis-cache-service-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/providers/Microsoft.Cache/operations"=>{"get"=>{"summary"=>"Operations List", "description"=>"Lists all of the available REST API operations of the Microsoft.Cache provider.", "operationId"=>"Operations_List", "x-api-path-slug"=>"providersmicrosoft-cacheoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}"=>{"put"=>{"summary"=>"Redis Create", "description"=>"Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.", "operationId"=>"Redis_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacheredisname-put", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the Redis cache"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the Create Redis operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redis"]}, "patch"=>{"summary"=>"Redis Update", "description"=>"Update an existing Redis cache.", "operationId"=>"Redis_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacheredisname-patch", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the Redis cache"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the Update Redis operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redis"]}, "delete"=>{"summary"=>"Redis Delete", "description"=>"Deletes a Redis cache.", "operationId"=>"Redis_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacheredisname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the Redis cache"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redis"]}, "get"=>{"summary"=>"Redis Get", "description"=>"Gets a Redis cache (resource description).", "operationId"=>"Redis_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacheredisname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the Redis cache"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redis"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/"=>{"get"=>{"summary"=>"Redis List By Resource Group", "description"=>"Lists all Redis caches in a resource group.", "operationId"=>"Redis_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacheredis-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redis Resource Group"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/Redis/"=>{"get"=>{"summary"=>"Redis List", "description"=>"Gets all Redis caches in the specified subscription.", "operationId"=>"Redis_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-cacheredis-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redis"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listKeys"=>{"post"=>{"summary"=>"Redis List Keys", "description"=>"Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.", "operationId"=>"Redis_ListKeys", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacheredisnamelistkeys-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the Redis cache"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redis Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/regenerateKey"=>{"post"=>{"summary"=>"Redis Regenerate Key", "description"=>"Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.", "operationId"=>"Redis_RegenerateKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacheredisnameregeneratekey-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the Redis cache"}, {"in"=>"body", "name"=>"parameters", "description"=>"Specifies which key to regenerate", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redis Regenerate Key"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/forceReboot"=>{"post"=>{"summary"=>"Redis Force Reboot", "description"=>"Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.", "operationId"=>"Redis_ForceReboot", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacheredisnameforcereboot-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the Redis cache"}, {"in"=>"body", "name"=>"parameters", "description"=>"Specifies which Redis node(s) to reboot", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redis Force Reboot"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/import"=>{"post"=>{"summary"=>"Redis Import Data", "description"=>"Import data into Redis cache.", "operationId"=>"Redis_ImportData", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacheredisnameimport-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the Redis cache"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters for Redis import operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redis Import Data"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/export"=>{"post"=>{"summary"=>"Redis Export Data", "description"=>"Export data from the redis cache to blobs in a container.", "operationId"=>"Redis_ExportData", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacheredisnameexport-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the Redis cache"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters for Redis export operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redis Export Data"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules"=>{"get"=>{"summary"=>"Firewall Rules List", "description"=>"Gets all firewall rules in the specified redis cache.", "operationId"=>"FirewallRules_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacherediscachenamefirewallrules-get", "parameters"=>[{"in"=>"path", "name"=>"cacheName", "description"=>"The name of the Redis cache"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall Rules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}"=>{"put"=>{"summary"=>"Redis Firewall Rule Create Or Update", "description"=>"Create or update a redis cache firewall rule", "operationId"=>"RedisFirewallRule_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacherediscachenamefirewallrulesrulename-put", "parameters"=>[{"in"=>"path", "name"=>"cacheName", "description"=>"The name of the Redis cache"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the create or update redis firewall rule operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"ruleName", "description"=>"The name of the firewall rule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redis Firewall Rule"]}, "get"=>{"summary"=>"Redis Firewall Rule Get", "description"=>"Gets a single firewall rule in a specified redis cache.", "operationId"=>"RedisFirewallRule_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacherediscachenamefirewallrulesrulename-get", "parameters"=>[{"in"=>"path", "name"=>"cacheName", "description"=>"The name of the Redis cache"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"ruleName", "description"=>"The name of the firewall rule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redis Firewall Rule"]}, "delete"=>{"summary"=>"Redis Firewall Rule Delete", "description"=>"Deletes a single firewall rule in a specified redis cache.", "operationId"=>"RedisFirewallRule_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacherediscachenamefirewallrulesrulename-delete", "parameters"=>[{"in"=>"path", "name"=>"cacheName", "description"=>"The name of the Redis cache"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"ruleName", "description"=>"The name of the firewall rule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redis Firewall Rule"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/default"=>{"put"=>{"summary"=>"Patch Schedules Create Or Update", "description"=>"Create or replace the patching schedule for Redis cache (requires Premium SKU).", "operationId"=>"PatchSchedules_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacheredisnamepatchschedulesdefault-put", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the Redis cache"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters to set the patching schedule for Redis cache", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedules"]}, "delete"=>{"summary"=>"Patch Schedules Delete", "description"=>"Deletes the patching schedule of a redis cache (requires Premium SKU).", "operationId"=>"PatchSchedules_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacheredisnamepatchschedulesdefault-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the redis cache"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedules"]}, "get"=>{"summary"=>"Patch Schedules Get", "description"=>"Gets the patching schedule of a redis cache (requires Premium SKU).", "operationId"=>"PatchSchedules_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacheredisnamepatchschedulesdefault-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the redis cache"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedules"]}}}}, "apis"=>{"name"=>"Azure Redis Cache", "x-slug"=>"azure-redis-cache", "description"=>"Azure Redis Cache is based on the popular open source Redis cache. It gives you access to a secure, dedicated Redis cache, managed by Microsoft and accessible from any application within Azure.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-redis-cache-performance.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Caching,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-redis-cache/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Redis Cache API", "x-api-slug"=>"azure-redis-cache-api", "description"=>"Azure Redis Cache is based on the popular open source Redis cache. It gives you access to a secure, dedicated Redis cache, managed by Microsoft and accessible from any application within Azure.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-redis-cache-performance.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/cache/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Caching,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-redis-cache/subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cacheredisnamepatchschedulesdefault-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-redis-cache/azure-redis-cache-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/redis-cache/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/cache/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/cache/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/cache/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
dropbox{"dropbox-datastore-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Dropbox", "x-complete"=>1, "info"=>{"title"=>"Dropbox", "description"=>"the-dropbox-api-allows-you-to-build-the-power-of-dropbox-directly-into-your-app-", "version"=>"1"}, "host"=>"api.dropbox.com", "basePath"=>"/1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/chunked_upload"=>{"put"=>{"summary"=>"Chunked Upload", "description"=>"/chunked_upload", "operationId"=>"chunked-upload", "x-api-path-slug"=>"chunked-upload-put", "parameters"=>[{"in"=>"query", "name"=>"offset", "description"=>"The byte offset of this chunk, relative to the beginning of the full file"}, {"in"=>"query", "name"=>"upload_id", "description"=>"The unique ID of the in-progress upload on the server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chunked", "Upload"]}}, "/delta/latest_cursor"=>{"post"=>{"summary"=>"Latest Cursor", "description"=>"/delta/latest_cursor", "operationId"=>"deltalatest-cursor", "x-api-path-slug"=>"deltalatest-cursor-post", "parameters"=>[{"in"=>"query", "name"=>"include_media_info", "description"=>"If true, the returned cursor will be encoded with include_media_info set to true for use with /delta"}, {"in"=>"query", "name"=>"path_prefix", "description"=>"If present, the returned cursor will be encoded with a path_prefix for the specified path for use with /delta"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Delta", "Latest", "Cursor"]}}, "/disable_access_token"=>{"post"=>{"summary"=>"Disable Access Token", "description"=>"/disable_access_token", "operationId"=>"disable-access-token", "x-api-path-slug"=>"disable-access-token-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disable", "Access", "Token"]}}, "/fileops/create_folder"=>{"post"=>{"summary"=>"Create Folder", "description"=>"/fileops/create_folder", "operationId"=>"fileopscreate-folder", "x-api-path-slug"=>"fileopscreate-folder-post", "parameters"=>[{"in"=>"query", "name"=>"locale", "description"=>"The metadata returned will have its size field translated based on the given locale"}, {"in"=>"query", "name"=>"path", "description"=>"The path to the new folder to create relative to root"}, {"in"=>"query", "name"=>"root", "description"=>"The root relative to which path is specified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fileops", "Create", "Folder"]}}, "/files"=>{"get"=>{"summary"=>"Get File", "description"=>"/files (GET)", "operationId"=>"files-get", "x-api-path-slug"=>"files-get", "parameters"=>[{"in"=>"query", "name"=>"path", "description"=>"The path to the file you want to retrieve"}, {"in"=>"query", "name"=>"rev", "description"=>"The revision of the file to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files"]}}, "/media"=>{"post"=>{"summary"=>"Add Media", "description"=>"/media", "operationId"=>"media", "x-api-path-slug"=>"media-post", "parameters"=>[{"in"=>"query", "name"=>"locale", "description"=>"Use to specify language settings for user error messages and other language specific text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media"]}}, "/metadata"=>{"get"=>{"summary"=>"Get Meta Data", "description"=>"/metadata", "operationId"=>"metadata", "x-api-path-slug"=>"metadata-get", "parameters"=>[{"in"=>"query", "name"=>"file_limit", "description"=>"Default is 10,000 (max is 25,000)"}, {"in"=>"query", "name"=>"hash", "description"=>"Each call to /metadata on a folder will return a hash field, generated by hashing all of the metadata contained in that response"}, {"in"=>"query", "name"=>"include_deleted", "description"=>"Only applicable when list is set"}, {"in"=>"query", "name"=>"include_media_info", "description"=>"If true, each file will include a photo_info dictionary for photos and a video_info dictionary for videos with additional media info"}, {"in"=>"query", "name"=>"include_membership", "description"=>"If true, metadata for a shared folder will include a list of the members of the shared folder"}, {"in"=>"query", "name"=>"list", "description"=>"The strings true and false are valid values"}, {"in"=>"query", "name"=>"locale", "description"=>"The metadata returned will have its size field translated based on the given locale"}, {"in"=>"query", "name"=>"rev", "description"=>"If you include a particular revision number, then only the metadata for that revision will be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata"]}}, "/oauth/access_token"=>{"post"=>{"summary"=>"OAuth Access Token", "description"=>"/oauth/access_token", "operationId"=>"oauthaccess-token", "x-api-path-slug"=>"oauthaccess-token-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Oauth", "Access", "Token"]}}, "/oauth/request_token"=>{"post"=>{"summary"=>"OAuth Request Token", "description"=>"/oauth/request_token", "operationId"=>"oauthrequest-token", "x-api-path-slug"=>"oauthrequest-token-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Oauth", "Request", "Token"]}}, "/oauth2/token"=>{"post"=>{"summary"=>"OAuth Token", "description"=>"/oauth2/token", "operationId"=>"oauth2token", "x-api-path-slug"=>"oauth2token-post", "parameters"=>[{"in"=>"query", "name"=>"client_id", "description"=>"If credentials are passed in POST parameters, this parameter should be present and should be the apps key (found in the App Console)"}, {"in"=>"query", "name"=>"client_secret", "description"=>"If credentials are passed in POST parameters, this parameter should be present and should be the apps secret"}, {"in"=>"query", "name"=>"code", "description"=>"The code acquired by directing users to /oauth2/authorize?response_type=code"}, {"in"=>"query", "name"=>"grant_type", "description"=>"The grant type, which must be authorization_code"}, {"in"=>"query", "name"=>"redirect_uri", "description"=>"Only used to validate that it matches the original /oauth2/authorize, not used to redirect again"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Oauth2", "Token"]}}, "/revisions"=>{"get"=>{"summary"=>"Get Revisions", "description"=>"/revisions", "operationId"=>"revisions", "x-api-path-slug"=>"revisions-get", "parameters"=>[{"in"=>"query", "name"=>"locale", "description"=>"The metadata returned will have its size field translated based on the given locale"}, {"in"=>"query", "name"=>"rev_limit", "description"=>"Default is 10"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Revisions"]}}, "/search"=>{"get"=>{"summary"=>"Search", "description"=>"/search", "operationId"=>"search", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"file_limit", "description"=>"The maximum and default value is 1,000"}, {"in"=>"query", "name"=>"include_deleted", "description"=>"If this parameter is set to true, then files and folders that have been deleted will also be included in the search"}, {"in"=>"query", "name"=>"include_membership", "description"=>"If true, metadata for a shared folder will include a list of the members of the shared folder"}, {"in"=>"query", "name"=>"locale", "description"=>"The metadata returned will have its size field translated based on the given locale"}, {"in"=>"query", "name"=>"query", "description"=>"The search string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}, "/shared_folders"=>{"get"=>{"summary"=>"Shared Folders", "description"=>"/shared_folders", "operationId"=>"shared-folders", "x-api-path-slug"=>"shared-folders-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The ID of a specific shared folder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shared", "Folders"]}}, "/thumbnails"=>{"get"=>{"summary"=>"Get Thumbnails", "description"=>"/thumbnails", "operationId"=>"thumbnails", "x-api-path-slug"=>"thumbnails-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"jpeg (default) or png"}, {"in"=>"query", "name"=>"size", "description"=>"One of the following values (default: s):valuedimensions (px)xs32x32s64x64m128x128l640x480xl1024x768"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thumbnails"]}}}}, "cloud-elements--dropbox-for-business-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Dropbox", "x-complete"=>1, "info"=>{"title"=>"Dropbox for Business API", "description"=>"the-business-version-of-the-dropbox-api-", "version"=>"1"}, "host"=>"api.dropbox.com", "basePath"=>"/1/team", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/get_info"=>{"post"=>{"summary"=>"Get Info", "description"=>"Get info.", "operationId"=>"postGetInfo", "x-api-path-slug"=>"get-info-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Info"]}}, "/log/get_events"=>{"post"=>{"summary"=>"Get Events", "description"=>"Get events.", "operationId"=>"postLogGetEvents", "x-api-path-slug"=>"logget-events-post", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"optional filter the returned events to a single category (see Event types below)"}, {"in"=>"query", "name"=>"cursor", "description"=>"optional encoded value indicating from what point to get the next limit logs"}, {"in"=>"query", "name"=>"end_ts", "description"=>"optional end time (UTC timestamp in milliseconds since the Unix epoch)"}, {"in"=>"query", "name"=>"limit", "description"=>"optional number of results to return per call (default 1000, maximum 1000)"}, {"in"=>"query", "name"=>"start_ts", "description"=>"optional start time (UTC timestamp in milliseconds since the Unix epoch)"}, {"in"=>"query", "name"=>"user", "description"=>"optional member ID, user ID, or email of a user for filtering events"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/members/add"=>{"post"=>{"summary"=>"Add Member", "description"=>"Add member.", "operationId"=>"postMembersAdd", "x-api-path-slug"=>"membersadd-post", "parameters"=>[{"in"=>"query", "name"=>"member_email", "description"=>"member email"}, {"in"=>"query", "name"=>"member_external_id", "description"=>"optional external ID for member"}, {"in"=>"query", "name"=>"member_given_name", "description"=>"member first name"}, {"in"=>"query", "name"=>"member_surname", "description"=>"member last name"}, {"in"=>"query", "name"=>"send_welcome_email", "description"=>"optional boolean to send a welcome email to the member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Member"]}}, "/members/get_info"=>{"post"=>{"summary"=>"Get Member Info", "description"=>"Get member info.", "operationId"=>"postMembersGetInfo", "x-api-path-slug"=>"membersget-info-post", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"optional email of member"}, {"in"=>"query", "name"=>"external_id", "description"=>"optional external ID of member"}, {"in"=>"query", "name"=>"member_id", "description"=>"optional ID of member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Member", "Info"]}}, "/members/get_info_batch"=>{"post"=>{"summary"=>"Get Info Batch", "description"=>"Get info batch.", "operationId"=>"postMembersGetInfoBatch", "x-api-path-slug"=>"membersget-info-batch-post", "parameters"=>[{"in"=>"query", "name"=>"emails", "description"=>"optional list of member emails"}, {"in"=>"query", "name"=>"external_ids", "description"=>"optional list of external member IDs"}, {"in"=>"query", "name"=>"member_ids", "description"=>"optional list of member IDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Info", "Batch"]}}, "/members/list"=>{"post"=>{"summary"=>"List Members", "description"=>"List members.", "operationId"=>"postMembersList", "x-api-path-slug"=>"memberslist-post", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"optional encoded value indicating from what point to get the next limit members"}, {"in"=>"query", "name"=>"limit", "description"=>"optional number of results to return per call (default 1000, maximum 1000)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Members"]}}, "/members/remove"=>{"post"=>{"summary"=>"Remove", "description"=>"Remove.", "operationId"=>"postMembersRemove", "x-api-path-slug"=>"membersremove-post", "parameters"=>[{"in"=>"query", "name"=>"delete_data", "description"=>"optional controls if the users data will be deleted on their linked devices"}, {"in"=>"query", "name"=>"external_id", "description"=>"optional external ID"}, {"in"=>"query", "name"=>"member_id", "description"=>"optional member ID"}, {"in"=>"query", "name"=>"transfer_admin_member_id", "description"=>"optional errors during the transfer process will be sent via email to the transfer_admin_member_id"}, {"in"=>"query", "name"=>"transfer_dest_member_id", "description"=>"optional files from the deleted member account will be transferred to this member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove"]}}, "/members/set_permissions"=>{"post"=>{"summary"=>"Set Member Permissions", "description"=>"Set member permissions.", "operationId"=>"postMembersSetPermissions", "x-api-path-slug"=>"membersset-permissions-post", "parameters"=>[{"in"=>"query", "name"=>"external_id", "description"=>"optional external ID"}, {"in"=>"query", "name"=>"member_id", "description"=>"optional member ID"}, {"in"=>"query", "name"=>"new_is_admin", "description"=>"optional change the admin status of the member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Member", "Permissions"]}}, "/members/set_profile"=>{"get"=>{"summary"=>"Set Profile", "description"=>"Set profile.", "operationId"=>"getMembersSetProfile", "x-api-path-slug"=>"membersset-profile-get", "parameters"=>[{"in"=>"query", "name"=>"external_id", "description"=>"optional external ID"}, {"in"=>"query", "name"=>"member_id", "description"=>"optional member ID"}, {"in"=>"query", "name"=>"new_email", "description"=>"optional new email for member"}, {"in"=>"query", "name"=>"new_external_id", "description"=>"optional new external ID for member"}, {"in"=>"query", "name"=>"new_given_name", "description"=>"optional new given name for member"}, {"in"=>"query", "name"=>"new_surname", "description"=>"optional new surname for member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Profile"]}}, "/reports/get_activity"=>{"post"=>{"summary"=>"Get Activity", "description"=>"Get activity.", "operationId"=>"postReportsGetActivity", "x-api-path-slug"=>"reportsget-activity-post", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"optional ending date (exclusive)"}, {"in"=>"query", "name"=>"start_date", "description"=>"optional starting date (inclusive)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity"]}}, "/reports/get_devices"=>{"post"=>{"summary"=>"Get Devices", "description"=>"Get devices.", "operationId"=>"postReportsGetDevices", "x-api-path-slug"=>"reportsget-devices-post", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"optional ending date (exclusive)"}, {"in"=>"query", "name"=>"start_date", "description"=>"optional starting date (inclusive)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/reports/get_membership"=>{"post"=>{"summary"=>"Get Membership", "description"=>"Get membership.", "operationId"=>"postReportsGetMembership", "x-api-path-slug"=>"reportsget-membership-post", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"optional ending date (exclusive)"}, {"in"=>"query", "name"=>"start_date", "description"=>"optional starting date (inclusive)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Membership"]}}, "/reports/get_storage"=>{"post"=>{"summary"=>"Get Storage", "description"=>"Get storage.", "operationId"=>"postReportsGetStorage", "x-api-path-slug"=>"reportsget-storage-post", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"optional ending date (exclusive)"}, {"in"=>"query", "name"=>"start_date", "description"=>"optional starting date (inclusive)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage"]}}}}, "dropbox-content-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Dropbox", "x-complete"=>1, "info"=>{"title"=>"Dropbox Content API v1", "description"=>"the-dropbox-content-api-is-a-part-of-dropbox-core-api-with-a-separate-endpoint-for-file-content-management-operations-", "termsOfService"=>"https://www.dropbox.com/developers/reference/tos", "contact"=>{"name"=>"Dropbox", "url"=>"https://www.dropbox.com/developers"}, "version"=>"1.0.0"}, "host"=>"api-content.dropbox.com", "basePath"=>"/1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/files/{root}/{path}"=>{"get"=>{"summary"=>"Downloads a file.", "description"=>"Downloads a file.\n\nThis method also supports [HTTP Range Retrieval Requests](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.2)\nto allow retrieving partial file contents.", "operationId"=>"downloads-a-filethis-method-also-supports-http-range-retrieval-requestshttpwwww3orgprotocolsrfc2616r", "x-api-path-slug"=>"filesrootpath-get", "parameters"=>[{"in"=>"path", "name"=>"path", "description"=>"The path to the file you want to retrieve"}, {"in"=>"query", "name"=>"rev", "description"=>"The revision of the file to retrieve"}, {"in"=>"path", "name"=>"root", "description"=>"Root folder: `auto` - automatically determines the appropriate root folder using your apps permissionlevel (recommended); `sandbox` - the codename for app folder level; `dropbox` - full dropbox access"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Files", "Root", "Path"]}}, "/files_put/{root}/{path}"=>{"post"=>{"summary"=>"Uploads a file using PUT semantics.", "description"=>"Uploads a file using PUT semantics.\n\nThe preferred HTTP method for this call is **PUT**. For compatibility with browser environments, the **POST**\nHTTP method is also recognized.\n\n**Note:** Providing a `Content-Length` header set to the size of the uploaded file is required so that the\nserver can verify that it has received the entire file contents.\n\n**Note:** `/files_put` has a maximum file size limit of 150 MB and does not support uploads with chunked\nencoding. To upload larger files, use [/chunked_upload](https://www.dropbox.com/developers/core/docs#chunked-upload)\ninstead.", "operationId"=>"uploads-a-file-using-put-semanticsthe-preferred-http-method-for-this-call-is-put-for-compatibility-w", "x-api-path-slug"=>"files-putrootpath-post", "parameters"=>[{"in"=>"query", "name"=>"autorename", "description"=>"This value, either `true` (default) or `false`, determines what happens when there is a conflict"}, {"in"=>"body", "name"=>"file_content", "description"=>"The file contents to be uploaded", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"locale", "description"=>"The metadata returned on successful upload will have its `size` field translated based on the given locale"}, {"in"=>"query", "name"=>"overwrite", "description"=>"This value, either `true` (default) or `false`, determines whether an existing file will be overwrittenby this upload"}, {"in"=>"query", "name"=>"parent_rev", "description"=>"If present, this parameter specifies the revision of the file youre editing"}, {"in"=>"path", "name"=>"path", "description"=>"The full path to the file you want to write to"}, {"in"=>"path", "name"=>"root", "description"=>"Root folder: `auto` - automatically determines the appropriate root folder using your apps permissionlevel (recommended); `sandbox` - the codename for app folder level; `dropbox` - full dropbox access"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Files", "Put", "Root", "Path"]}, "put"=>{"summary"=>"Uploads a file using PUT semantics.", "description"=>"Uploads a file using PUT semantics.\n\nThe preferred HTTP method for this call is **PUT**. For compatibility with browser environments, the **POST**\nHTTP method is also recognized.\n\n**Note:** Providing a `Content-Length` header set to the size of the uploaded file is required so that the\nserver can verify that it has received the entire file contents.\n\n**Note:** `/files_put` has a maximum file size limit of 150 MB and does not support uploads with chunked\nencoding. To upload larger files, use [/chunked_upload](https://www.dropbox.com/developers/core/docs#chunked-upload)\ninstead.", "operationId"=>"uploads-a-file-using-put-semanticsthe-preferred-http-method-for-this-call-is-put-for-compatibility-w", "x-api-path-slug"=>"files-putrootpath-put", "parameters"=>[{"in"=>"query", "name"=>"autorename", "description"=>"This value, either `true` (default) or `false`, determines what happens when there is a conflict"}, {"in"=>"body", "name"=>"file_content", "description"=>"The file contents to be uploaded", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"locale", "description"=>"The metadata returned on successful upload will have its `size` field translated based on the given locale"}, {"in"=>"query", "name"=>"overwrite", "description"=>"This value, either `true` (default) or `false`, determines whether an existing file will be overwrittenby this upload"}, {"in"=>"query", "name"=>"parent_rev", "description"=>"If present, this parameter specifies the revision of the file youre editing"}, {"in"=>"path", "name"=>"path", "description"=>"The full path to the file you want to write to"}, {"in"=>"path", "name"=>"root", "description"=>"Root folder: `auto` - automatically determines the appropriate root folder using your apps permissionlevel (recommended); `sandbox` - the codename for app folder level; `dropbox` - full dropbox access"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Files", "Put", "Root", "Path"]}}, "/thumbnails/{root}/{path}"=>{"get"=>{"summary"=>"Gets a thumbnail for an image.", "description"=>"Gets a thumbnail for an image.\n\nThis method currently supports files with the following file extensions: .jpg, .jpeg, .png, .tiff, .tif, .gif, .bmp\n\nPhotos that are larger than 20MB in size won't be converted to a thumbnail.", "operationId"=>"gets-a-thumbnail-for-an-imagethis-method-currently-supports-files-with-the-following-file-extensions", "x-api-path-slug"=>"thumbnailsrootpath-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"For images that are photos, `jpeg` (default) should be preferred, while `png` is better for screenshots and digital art"}, {"in"=>"path", "name"=>"path", "description"=>"The path to the image file you want to thumbnail"}, {"in"=>"path", "name"=>"root", "description"=>"Root folder: `auto` - automatically determines the appropriate root folder using your apps permissionlevel (recommended); `sandbox` - the codename for app folder level; `dropbox` - full dropbox access"}, {"in"=>"query", "name"=>"size", "description"=>"Default size is `s`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Thumbnails", "Root", "Path"]}}, "/previews/{root}/{path}"=>{"get"=>{"summary"=>"Gets a preview for a file.", "description"=>"Gets a preview for a file.\n\nPreviews are only generated for the files with the following extensions: .doc, .docx, .docm, .ppt, .pps,\n.ppsx, .ppsm, .pptx, .pptm, .xls, .xlsx, .xlsm, .rtf", "operationId"=>"gets-a-preview-for-a-filepreviews-are-only-generated-for-the-files-with-the-following-extensions-doc", "x-api-path-slug"=>"previewsrootpath-get", "parameters"=>[{"in"=>"path", "name"=>"path", "description"=>"The absolute path to the file you want to preview"}, {"in"=>"query", "name"=>"rev", "description"=>"The revision of the file to retrieve"}, {"in"=>"path", "name"=>"root", "description"=>"Root folder: `auto` - automatically determines the appropriate root folder using your apps permissionlevel (recommended); `sandbox` - the codename for app folder level; `dropbox` - full dropbox access"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Previews", "Root", "Path"]}}, "/chunked_upload"=>{"put"=>{"summary"=>"Uploads large files to Dropbox in multiple chunks.", "description"=>"Uploads large files to Dropbox in multiple chunks. Also has the ability to resume if the upload is interrupted.\nThis allows for uploads larger than the `/files_put` maximum of 150 MB.\n\nTypical usage:\n 1. Send a PUT request to `/chunked_upload` with the first chunk of the file without setting `upload_id`, and\n receive an `upload_id` in return.\n 2. Repeatedly `PUT` subsequent chunks using the `upload_id` to identify the upload in progress and an `offset`\n representing the number of bytes transferred so far.\n 3. After each chunk has been uploaded, the server returns a new offset representing the total amount transferred.\n 4. After the last chunk, `POST` to `/commit_chunked_upload` to complete the upload.\n\nChunks can be any size up to 150 MB. A typical chunk is 4 MB. Using large chunks will mean fewer calls\nto `/chunked_upload` and faster overall throughput. However, whenever a transfer is interrupted, you will\nhave to resume at the beginning of the last chunk, so it is often safer to use smaller chunks.\n\nIf the offset you submit does not match the expected offset on the server, the server will ignore the request\nand respond with a 400 error that includes the current offset. To resume upload, seek to the correct offset\n(in bytes) within the file and then resume uploading from that point.\n\nA chunked upload can take a maximum of 48 hours before expiring.", "operationId"=>"uploads-large-files-to-dropbox-in-multiple-chunks-also-has-the-ability-to-resume-if-the-upload-is-in", "x-api-path-slug"=>"chunked-upload-put", "parameters"=>[{"in"=>"body", "name"=>"file_content", "description"=>"A chunk of data from the file being uploaded", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"offset", "description"=>"The byte offset of this chunk, relative to the beginning of the full file"}, {"in"=>"query", "name"=>"upload_id", "description"=>"The unique ID of the in-progress upload on the server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Chunked", "Upload"]}}, "/commit_chunked_upload/{root}/{path}"=>{"post"=>{"summary"=>"Completes an upload initiated by the chunked upload method.", "description"=>"Completes an upload initiated by the `/chunked_upload` method. Saves a file uploaded via `/chunked_upload` to\na user's Dropbox.\n\n`/commit_chunked_upload` is similar to `/files_put`. The main difference is that while `/files_put` takes the\nfile contents in the request body, `/commit_chunked_upload` takes a parameter `upload_id`, which is obtained\nwhen the file contents are uploaded via `/chunked_upload`.", "operationId"=>"completes-an-upload-initiated-by-the-chunked-upload-method-saves-a-file-uploaded-via-chunked-upload-", "x-api-path-slug"=>"commit-chunked-uploadrootpath-post", "parameters"=>[{"in"=>"query", "name"=>"autorename", "description"=>"This value, either `true` (default) or `false`, determines what happens when there is a conflict"}, {"in"=>"query", "name"=>"locale", "description"=>"The metadata returned on successful upload will have its `size` field translated based on the given locale"}, {"in"=>"query", "name"=>"overwrite", "description"=>"This value, either `true` (default) or `false`, determines whether an existing file will be overwritten bythis upload"}, {"in"=>"query", "name"=>"parent_rev", "description"=>"If present, this parameter specifies the revision of the file youre editing"}, {"in"=>"path", "name"=>"path", "description"=>"The full path to the file you want to write to"}, {"in"=>"path", "name"=>"root", "description"=>"Root folder: `auto` - automatically determines the appropriate root folder using your apps permissionlevel (recommended); `sandbox` - the codename for app folder level; `dropbox` - full dropbox access"}, {"in"=>"query", "name"=>"upload_id", "description"=>"Used to identify the chunked upload session youd like to commit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Commit", "Chunked", "Upload", "Root", "Path"]}}}}, "dropbox-core-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Dropbox", "x-complete"=>1, "info"=>{"title"=>"Dropbox Core API v1", "description"=>"the-dropbox-core-api-is-the-underlying-interface-for-all-of-our-official-dropbox-mobile-appshttpswww-dropbox-commobileand-our-sdkshttpswww-dropbox-comdeveloperscoresdk--its-the-most-direct-way-to-access-the-api--thisreference-document-is-designed-for-those-interested-in-developing-for-platforms-not-supported-by-the-sdks-or-forthose-interested-in-exploring-api-features-in-detail-", "termsOfService"=>"https://www.dropbox.com/developers/reference/tos", "contact"=>{"name"=>"Dropbox", "url"=>"https://www.dropbox.com/developers"}, "version"=>"1.0.0"}, "host"=>"api.dropbox.com", "basePath"=>"/1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/oauth2/token_from_oauth1"=>{"post"=>{"summary"=>"Convert OAuth 1 token to OAuth 2 token.", "description"=>"This endpoint should be used by apps transitioning from OAuth 1 to OAuth 2. It will return an OAuth 2 token\nfor the authenticated user.", "operationId"=>"this-endpoint-should-be-used-by-apps-transitioning-from-oauth-1-to-oauth-2-it-will-return-an-oauth-2", "x-api-path-slug"=>"oauth2token-from-oauth1-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Oauth2", "Token_from_oauth1"]}}, "/disable_access_token"=>{"post"=>{"summary"=>"Disables the access token.", "description"=>"Disables the access token used to authenticate the call. This method works for OAuth 1 and OAuth 2 tokens.", "operationId"=>"disables-the-access-token-used-to-authenticate-the-call-this-method-works-for-oauth-1-and-oauth-2-to", "x-api-path-slug"=>"disable-access-token-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Disable_access_token"]}}, "/account/info"=>{"get"=>{"summary"=>"Retrieves information about the user's account.", "description"=>"Retrieves information about the user's account.", "operationId"=>"retrieves-information-about-the-users-account", "x-api-path-slug"=>"accountinfo-get", "parameters"=>[{"in"=>"query", "name"=>"locale", "description"=>"Use to specify language settings for user error messages and other language specific text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Account", "Info"]}}, "/metadata/{root}/{path}"=>{"get"=>{"summary"=>"Retrieves file and folder metadata.", "description"=>"Retrieves file and folder metadata.\n\n**Note:** `modified`, `rev`, and `revision` aren't returned in the metadata for the root/top-level path.", "operationId"=>"retrieves-file-and-folder-metadatanote-modified-rev-and-revision-arent-returned-in-the-metadata-for-", "x-api-path-slug"=>"metadatarootpath-get", "parameters"=>[{"in"=>"query", "name"=>"file_limit", "description"=>"Default is 10,000 (max is 25,000)"}, {"in"=>"query", "name"=>"hash", "description"=>"Each call to `/metadata` on a folder will return a `hash` field, generated by hashing all of the metadatacontained in that response"}, {"in"=>"query", "name"=>"include_deleted", "description"=>"Only applicable when `list` is set"}, {"in"=>"query", "name"=>"include_media_info", "description"=>"If `true`, each file will include a `photo_info` dictionary for photos and a `video_info` dictionaryfor videos with additional media info"}, {"in"=>"query", "name"=>"include_membership", "description"=>"If `true`, metadata for a shared folder will include a list of members and a list of groups"}, {"in"=>"query", "name"=>"list", "description"=>"The strings `true` and `false` are valid values"}, {"in"=>"query", "name"=>"locale", "description"=>"The metadata returned will have its `size` field translated based on the given `locale`"}, {"in"=>"path", "name"=>"path", "description"=>"The path to the file or folder"}, {"in"=>"query", "name"=>"rev", "description"=>"If you include a particular revision number, then only the metadata for that revision will be returned"}, {"in"=>"path", "name"=>"root", "description"=>"Root folder: `auto` - automatically determines the appropriate root folder using your apps permissionlevel (recommended); `sandbox` - the codename for app folder level; `dropbox` - full dropbox access"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Metadata", "Root", "Path"]}}, "/delta"=>{"post"=>{"summary"=>"A way of letting you keep up with changes to files and folders in a user's Dropbox.", "description"=>"A way of letting you keep up with changes to files and folders in a user's Dropbox.\n\nYou can periodically call `/delta` to get a list of \"delta entries\", which are instructions on how to\nupdate your local state to match the server's state.\n\nIf you use the `path_prefix` parameter, you must continue to pass the correct prefix on subsequent calls\nusing the returned cursor. You can switch the `path_prefix` on any existing cursor to a descendant of the\nexisting `path_prefix` on subsequent calls to `/delta`. For example if your cursor has no `path_prefix`,\nyou can switch to any `path_prefix`. If your cursor has a `path_prefix` of \"/Photos\", you can switch it\nto \"/Photos/Vacaction\".\n\nWhen `include_media_info` is specified, files will only appear in delta responses when the media info is\nready. If you use the `include_media_info` parameter, you must continue to pass the same value on subsequent\ncalls using the returned cursor.\n\n**Important:** Unfortunately it is not possible to model correct Dropbox response with Swagger specification,\ndue to [nested array](https://github.com/swagger-api/swagger-spec/issues/40) usage in delta response.\n\nSuccessful result [will return](https://gist.github.com/ando-takahiro/5203137) an array of delta `entries`.\nEach delta entry is a 2-item list of one of the following forms:\n\n * `[, ]` - Indicates that there is a file/folder at the given path. You should add the entry\n to your local state. The metadata value is the same as what would be returned by the `/metadata` call, except\n folder metadata doesn't have `hash` or `contents` fields. To correctly process delta entries:\n * If the new entry includes parent folders that don't yet exist in your local state, create those parent\n folders in your local state.\n * If the new entry is a file, replace whatever your local state has at path with the new entry.\n * If the new entry is a folder, check what your local state has at ``. If it's a file, replace it\n with the new entry. If it's a folder, apply the new `` to the folder, but don't modify the\n folder's children. If your local state doesn't yet include this path, create it as a folder.\n * If the new entry is a folder with the `read-only` field set to `true`, apply the read-only permission\n recursively to all files within the shared folder.\n * `[, null]` - Indicates that there is no file/folder at the given path. To update your local state\n to match, anything at path and all its children should be deleted. Deleting a folder in your Dropbox will\n sometimes send down a single deleted entry for that folder, and sometimes separate entries for the folder\n and all child paths. If your local state doesn't have anything at path, ignore this entry.\n\n**Note:** Dropbox treats file names in a case-insensitive but case-preserving way. To facilitate this,\nthe `` values above are lower-cased versions of the actual path. The last path component of the\n`` value will be case-preserved.", "operationId"=>"a-way-of-letting-you-keep-up-with-changes-to-files-and-folders-in-a-users-dropboxyou-can-periodicall", "x-api-path-slug"=>"delta-post", "parameters"=>[{"in"=>"formData", "name"=>"cursor", "description"=>"A string that is used to keep track of your current state"}, {"in"=>"formData", "name"=>"include_media_info", "description"=>"If `true`, each file will include a `photo_info` dictionary for photos and a `video_info` dictionary forvideos with additional media info"}, {"in"=>"formData", "name"=>"locale", "description"=>"The metadata returned will have its `size` field translated based on the given `locale`"}, {"in"=>"formData", "name"=>"path_prefix", "description"=>"If present, this parameter filters the response to only include entries at or under the specified path"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Delta"]}}, "/delta/latest_cursor"=>{"post"=>{"summary"=>"A way to quickly get a cursor for the server's state, for use with /delta.", "description"=>"A way to quickly get a cursor for the server's state, for use with `/delta`.\n\nUnlike `/delta`, `/delta/latest_cursor` does not return any entries, so your app will not know about any\nexisting files or folders in the Dropbox account. For example, if your app processes future delta entries\nand sees that a folder was deleted, your app won't know what files were in that folder. Use this endpoint\nif your app only needs to know about new files and modifications and doesn't need to know about files that\nalready exist in Dropbox.\n\nIf you need to build local state to match the server state in Dropbox, you should instead use `/delta`.", "operationId"=>"a-way-to-quickly-get-a-cursor-for-the-servers-state-for-use-with-deltaunlike-delta-deltalatest-curso", "x-api-path-slug"=>"deltalatest-cursor-post", "parameters"=>[{"in"=>"formData", "name"=>"include_media_info", "description"=>"If `true`, the returned cursor will be encoded with `include_media_info` set to `true` for usewith `/delta`"}, {"in"=>"formData", "name"=>"path_prefix", "description"=>"If present, the returned cursor will be encoded with a `path_prefix` for the specified path for usewith `/delta`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Delta", "Latest_cursor"]}}, "/revisions/{root}/{path}"=>{"get"=>{"summary"=>"Obtains metadata for all available revisions of a file, including the current revision.", "description"=>"Obtains metadata for all available revisions of a file, including the current revision.\n\nOnly revisions up to thirty days old are available (or more if the Dropbox user has\n[Extended Version History](https://www.dropbox.com/help/113)). You can use the revision number in conjunction\nwith the `/restore` call to revert the file to its previous state.", "operationId"=>"obtains-metadata-for-all-available-revisions-of-a-file-including-the-current-revisiononly-revisions-", "x-api-path-slug"=>"revisionsrootpath-get", "parameters"=>[{"in"=>"query", "name"=>"locale", "description"=>"The metadata returned will have its `size` field translated based on the given `locale`"}, {"in"=>"path", "name"=>"path", "description"=>"The path to the file"}, {"in"=>"query", "name"=>"rev_limit", "description"=>"Default is 10"}, {"in"=>"path", "name"=>"root", "description"=>"Root folder: `auto` - automatically determines the appropriate root folder using your apps permissionlevel (recommended); `sandbox` - the codename for app folder level; `dropbox` - full dropbox access"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Revisions", "Root", "Path"]}}, "/restore/{root}/{path}"=>{"post"=>{"summary"=>"Restores a file path to a previous revision.", "description"=>"Restores a file path to a previous revision.\n\nUnlike downloading a file at a given revision and then re-uploading it, this call is atomic. It also saves\na bunch of bandwidth.", "operationId"=>"restores-a-file-path-to-a-previous-revisionunlike-downloading-a-file-at-a-given-revision-and-then-re", "x-api-path-slug"=>"restorerootpath-post", "parameters"=>[{"in"=>"formData", "name"=>"locale", "description"=>"The metadata returned will have its `size` field translated based on the given `locale`"}, {"in"=>"path", "name"=>"path", "description"=>"The path to the file"}, {"in"=>"formData", "name"=>"rev", "description"=>"The revision of the file to restore"}, {"in"=>"path", "name"=>"root", "description"=>"Root folder: `auto` - automatically determines the appropriate root folder using your apps permissionlevel (recommended); `sandbox` - the codename for app folder level; `dropbox` - full dropbox access"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Restore", "Root", "Path"]}}, "/search/{root}/{path}"=>{"get"=>{"summary"=>"Search for files and folders by name.", "description"=>"Returns metadata for all files and folders whose filename contains the given search string as a substring.\n\nSearches are limited to the folder path and its sub-folder hierarchy provided in the call.\n\n**Note:** Recent changes may not immediately be reflected in search results due to a short delay in indexing.", "operationId"=>"returns-metadata-for-all-files-and-folders-whose-filename-contains-the-given-search-string-as-a-subs", "x-api-path-slug"=>"searchrootpath-get", "parameters"=>[{"in"=>"query", "name"=>"file_limit", "description"=>"The maximum and default value is 1,000"}, {"in"=>"query", "name"=>"include_deleted", "description"=>"If this parameter is set to `true`, then files and folders that have been deleted will also be includedin the search"}, {"in"=>"query", "name"=>"include_membership", "description"=>"If `true`, metadata for a shared folder will include a list of members and a list of groups"}, {"in"=>"query", "name"=>"locale", "description"=>"The metadata returned will have its `size` field translated based on the given `locale`"}, {"in"=>"path", "name"=>"path", "description"=>"The path to the folder you want to search from"}, {"in"=>"query", "name"=>"query", "description"=>"The search string"}, {"in"=>"path", "name"=>"root", "description"=>"Root folder: `auto` - automatically determines the appropriate root folder using your apps permissionlevel (recommended); `sandbox` - the codename for app folder level; `dropbox` - full dropbox access"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Search", "Root", "Path"]}, "post"=>{"summary"=>"Search for files and folders by name.", "description"=>"Returns metadata for all files and folders whose filename contains the given search string as a substring.\n\nSearches are limited to the folder path and its sub-folder hierarchy provided in the call.\n\n**Note:** Recent changes may not immediately be reflected in search results due to a short delay in indexing.", "operationId"=>"returns-metadata-for-all-files-and-folders-whose-filename-contains-the-given-search-string-as-a-subs", "x-api-path-slug"=>"searchrootpath-post", "parameters"=>[{"in"=>"formData", "name"=>"file_limit", "description"=>"The maximum and default value is 1,000"}, {"in"=>"formData", "name"=>"include_deleted", "description"=>"If this parameter is set to `true`, then files and folders that have been deleted will also be includedin the search"}, {"in"=>"formData", "name"=>"include_membership", "description"=>"If `true`, metadata for a shared folder will include a list of members and a list of groups"}, {"in"=>"formData", "name"=>"locale", "description"=>"The metadata returned will have its `size` field translated based on the given `locale`"}, {"in"=>"path", "name"=>"path", "description"=>"The path to the folder you want to search from"}, {"in"=>"formData", "name"=>"query", "description"=>"The search string"}, {"in"=>"path", "name"=>"root", "description"=>"Root folder: `auto` - automatically determines the appropriate root folder using your apps permissionlevel (recommended); `sandbox` - the codename for app folder level; `dropbox` - full dropbox access"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Search", "Root", "Path"]}}, "/shares/{root}/{path}"=>{"post"=>{"summary"=>"Creates and returns a shared link to a file or folder.", "description"=>"Creates and returns a [shared link](https://www.dropbox.com/help/167) to a file or folder.\n\nDropbox for Business users can set restrictions on shared links; the `visibility` field indicates what\n(if any) restrictions are set on this particular link. Possible values include:\n * `PUBLIC` - anyone can view\n * `TEAM_ONLY` - only the owner's team can view\n * `PASSWORD` - a password is required\n * `TEAM_AND_PASSWORD` - a combination of `TEAM_ONLY` and `PASSWORD` restrictions\n * `SHARED_FOLDER_ONLY` - only [members](https://www.dropbox.com/help/6636) of the enclosing shared folder can view\n\nNote that other values may be added at any time.", "operationId"=>"creates-and-returns-a-shared-linkhttpswwwdropboxcomhelp167-to-a-file-or-folderdropbox-for-business-u", "x-api-path-slug"=>"sharesrootpath-post", "parameters"=>[{"in"=>"formData", "name"=>"locale", "description"=>"Use to specify language settings for user error messages and other language specific text"}, {"in"=>"path", "name"=>"path", "description"=>"The path to the file or folder you want to link to"}, {"in"=>"path", "name"=>"root", "description"=>"Root folder: `auto` - automatically determines the appropriate root folder using your apps permissionlevel (recommended); `sandbox` - the codename for app folder level; `dropbox` - full dropbox access"}, {"in"=>"formData", "name"=>"short_url", "description"=>"When `true` (default), the URL returned will be shortened using the Dropbox URL shortener"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Shares", "Root", "Path"]}}, "/media/{root}/{path}"=>{"post"=>{"summary"=>"Returns a link directly to a file.", "description"=>"Returns a link directly to a file.\n\nSimilar to [/shares](https://www.dropbox.com/developers/core/docs#shares). The difference is that this\nbypasses the Dropbox webserver, used to provide a preview of the file, so that you can effectively stream\nthe contents of your media. This URL should not be used to display content directly in the browser.\n\nThe `/media` link expires after four hours, allotting enough time to stream files, but not enough to leave\na connection open indefinitely.", "operationId"=>"returns-a-link-directly-to-a-filesimilar-to-shareshttpswwwdropboxcomdeveloperscoredocsshares-the-dif", "x-api-path-slug"=>"mediarootpath-post", "parameters"=>[{"in"=>"formData", "name"=>"locale", "description"=>"Use to specify language settings for user error messages and other language specific text"}, {"in"=>"path", "name"=>"path", "description"=>"The path to the media file you want a direct link to"}, {"in"=>"path", "name"=>"root", "description"=>"Root folder: `auto` - automatically determines the appropriate root folder using your apps permissionlevel (recommended); `sandbox` - the codename for app folder level; `dropbox` - full dropbox access"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Media", "Root", "Path"]}}, "/copy_ref/{root}/{path}"=>{"get"=>{"summary"=>"Creates and returns a copy_ref to a file.", "description"=>"Creates and returns a `copy_ref` to a file.\n\nThis reference string can be used to copy that file to another user's Dropbox by passing it in as the\n`from_copy_ref` parameter on [/fileops/copy](https://www.dropbox.com/developers/core/docs#fileops-copy).", "operationId"=>"creates-and-returns-a-copy-ref-to-a-filethis-reference-string-can-be-used-to-copy-that-file-to-anoth", "x-api-path-slug"=>"copy-refrootpath-get", "parameters"=>[{"in"=>"path", "name"=>"path", "description"=>"The path to the file you want a `copy_ref` to refer to"}, {"in"=>"path", "name"=>"root", "description"=>"Root folder: `auto` - automatically determines the appropriate root folder using your apps permissionlevel (recommended); `sandbox` - the codename for app folder level; `dropbox` - full dropbox access"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Copy", "Root", "Path"]}}, "/shared_folders"=>{"get"=>{"summary"=>"Returns a list of all shared folders.", "description"=>"Returns a list of all shared folders the authenticated user has access to.\n\nThis API call requires Full Dropbox or File type [permissions](https://www.dropbox.com/developers/reference/devguide#app-permissions).\n\nNote that `same_team` is only present if the linked account is a member of a Dropbox for Business team,\nand `member_id` is only present when this endpoint is called by a Dropbox for Business app and the user\nis on that team.\n\nThe `membership` field only contains users who have joined the shared folder and does not include users who\nhave been invited but have not accepted. When the `active` field is `false`, it means that a user has left\na shared folder (but may still rejoin).", "operationId"=>"returns-a-list-of-all-shared-folders-the-authenticated-user-has-access-tothis-api-call-requires-full", "x-api-path-slug"=>"shared-folders-get", "parameters"=>[{"in"=>"query", "name"=>"include_membership", "description"=>"If `true`, include a list of members and a list of groups for the shared folder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Shared_folders"]}}, "/shared_folders/{shared_folder_id}"=>{"get"=>{"summary"=>"Returns metadata about a specific shared folder.", "description"=>"Returns metadata about a specific shared folder.\n\nThis API call requires Full Dropbox or File type [permissions](https://www.dropbox.com/developers/reference/devguide#app-permissions).\n\nNote that `same_team` is only present if the linked account is a member of a Dropbox for Business team,\nand `member_id` is only present when this endpoint is called by a Dropbox for Business app and the user\nis on that team.\n\nThe `membership` field only contains users who have joined the shared folder and does not include users who\nhave been invited but have not accepted. When the `active` field is `false`, it means that a user has left\na shared folder (but may still rejoin).", "operationId"=>"returns-metadata-about-a-specific-shared-folderthis-api-call-requires-full-dropbox-or-file-type-perm", "x-api-path-slug"=>"shared-foldersshared-folder-id-get", "parameters"=>[{"in"=>"query", "name"=>"include_membership", "description"=>"If `true`, include a list of members and a list of groups for the shared folder"}, {"in"=>"path", "name"=>"shared_folder_id", "description"=>"The ID of a specific shared folder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Shared_folders", "Shared_folder_id"]}}, "/save_url/{root}/{path}"=>{"post"=>{"summary"=>"Save a file from the specified URL into Dropbox.", "description"=>"Save a file from the specified URL into Dropbox.\n\nIf the given path already exists, the file will be renamed to avoid the conflict (e.g. `myfile (1).txt`).", "operationId"=>"save-a-file-from-the-specified-url-into-dropboxif-the-given-path-already-exists-the-file-will-be-ren", "x-api-path-slug"=>"save-urlrootpath-post", "parameters"=>[{"in"=>"path", "name"=>"path", "description"=>"The path in Dropbox where the file will be saved"}, {"in"=>"path", "name"=>"root", "description"=>"Root folder: `auto` - automatically determines the appropriate root folder using your apps permissionlevel (recommended); `sandbox` - the codename for app folder level; `dropbox` - full dropbox access"}, {"in"=>"formData", "name"=>"url", "description"=>"The URL to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "URL", "Root", "Path"]}}, "/save_url_job/{job-id}"=>{"get"=>{"summary"=>"Check the status of a save URL job.", "description"=>"Check the status of a [save URL](https://www.dropbox.com/developers/core/docs#save-url) job.\n\nStatus field may have one of the following values:\n * `PENDING` ??? The job has not yet started.\n * `DOWNLOADING` ??? The job has started but hasn't yet completed.\n * `COMPLETE` ??? The job is complete.\n * `FAILED` ??? The job failed. An additional `error` field will describe the failure.", "operationId"=>"check-the-status-of-a-save-urlhttpswwwdropboxcomdeveloperscoredocssaveurl-jobstatus-field-may-have-o", "x-api-path-slug"=>"save-url-jobjobid-get", "parameters"=>[{"in"=>"path", "name"=>"job-id", "description"=>"A job ID returned from [/save_url](https://www"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Save_url_job", "Job-id"]}}, "/fileops/copy"=>{"post"=>{"summary"=>"Copies a file or folder to a new location.", "description"=>"Copies a file or folder to a new location.", "operationId"=>"copies-a-file-or-folder-to-a-new-location", "x-api-path-slug"=>"fileopscopy-post", "parameters"=>[{"in"=>"formData", "name"=>"from_copy_ref", "description"=>"Specifies a `copy_ref` generated from a previous [/copy_ref](https://www"}, {"in"=>"formData", "name"=>"from_path", "description"=>"Specifies the file or folder to be copied from relative to `root`"}, {"in"=>"formData", "name"=>"locale", "description"=>"The metadata returned will have its `size` field translated based on the given locale"}, {"in"=>"formData", "name"=>"root", "description"=>"The root relative to which `from_path` and `to_path` are specified"}, {"in"=>"formData", "name"=>"to_path", "description"=>"Specifies the destination path, *including the new name for the file or folder*, relative to `root`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Fileops", "Copy"]}}, "/fileops/create_folder"=>{"post"=>{"summary"=>"Creates a folder.", "description"=>"Creates a folder.", "operationId"=>"creates-a-folder", "x-api-path-slug"=>"fileopscreate-folder-post", "parameters"=>[{"in"=>"formData", "name"=>"locale", "description"=>"The metadata returned will have its `size` field translated based on the given locale"}, {"in"=>"formData", "name"=>"path", "description"=>"The path to the new folder to create relative to `root`"}, {"in"=>"formData", "name"=>"root", "description"=>"The root relative to which `path` is specified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Fileops", "Create_folder"]}}, "/fileops/delete"=>{"post"=>{"summary"=>"Deletes a file or folder.", "description"=>"Deletes a file or folder.", "operationId"=>"deletes-a-file-or-folder", "x-api-path-slug"=>"fileopsdelete-post", "parameters"=>[{"in"=>"formData", "name"=>"locale", "description"=>"The metadata returned will have its `size` field translated based on the given locale"}, {"in"=>"formData", "name"=>"path", "description"=>"The path to the file or folder to be deleted"}, {"in"=>"formData", "name"=>"root", "description"=>"The root relative to which `path` is specified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Fileops", "Delete"]}}, "/fileops/move"=>{"post"=>{"summary"=>"Moves a file or folder to a new location.", "description"=>"Moves a file or folder to a new location.", "operationId"=>"moves-a-file-or-folder-to-a-new-location", "x-api-path-slug"=>"fileopsmove-post", "parameters"=>[{"in"=>"formData", "name"=>"from_path", "description"=>"Specifies the file or folder to be moved from relative to `root`"}, {"in"=>"formData", "name"=>"locale", "description"=>"The metadata returned will have its `size` field translated based on the given locale"}, {"in"=>"formData", "name"=>"root", "description"=>"The root relative to which `from_path` and `to_path` are specified"}, {"in"=>"formData", "name"=>"to_path", "description"=>"Specifies the destination path, *including the new name for the file or folder*, relative to `root`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Documents", "Fileops", "Move"]}}}}, "dropbox-notify-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Dropbox", "x-complete"=>1, "info"=>{"title"=>"Dropbox Notify Appendix API v1", "description"=>"the-dropbox-notify--is-a-part-of-dropbox-core-ap-with-a-separate-endpoint-for-notification-call-", "termsOfService"=>"https://www.dropbox.com/developers/reference/tos", "contact"=>{"name"=>"Dropbox", "url"=>"https://www.dropbox.com/developers"}, "version"=>"1.0.0"}, "host"=>"api-notify.dropbox.com", "basePath"=>"/1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/longpoll_delta"=>{"get"=>{"summary"=>"A long-poll endpoint to wait for changes on an account.", "description"=>"A long-poll endpoint to wait for changes on an account. In conjunction with [/delta](https://www.dropbox.com/developers/core/docs#delta),\nthis call gives you a low-latency way to monitor an account for file changes.\n\nNote that this call goes to **api-notify.dropbox.com** instead of *api.dropbox.com*.\n\nUnlike most other API endpoints, this call does not require OAuth authentication. The passed in `cursor` can\nonly be acquired via an authenticated call to [/delta](https://www.dropbox.com/developers/core/docs#delta).", "operationId"=>"a-longpoll-endpoint-to-wait-for-changes-on-an-account-in-conjunction-with-deltahttpswwwdropboxcomdev", "x-api-path-slug"=>"longpoll-delta-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"A delta cursor as returned from a call to [/delta](https://www"}, {"in"=>"query", "name"=>"timeout", "description"=>"An optional integer indicating a timeout, in seconds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Documents", "Notify"]}}}}, "apis"=>{"name"=>"Dropbox", "x-slug"=>"dropbox", "description"=>"Dropbox is a modern workspace designed to reduce busywork-so you can focus on the things that matter. Sign in and put your creative energy to work.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/184-dropbox.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"89", "tags"=>"API LIfeyclessss,API Provider,API Service Provider,File Storage,Indie EdTech Data Jam,internet,Mobile,My API Stack,Profiles,Relative Data,SaaS,Service API,Sharing,Stack,Storage,Storage,Storage,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"dropbox/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Cloud Elements - Dropbox For Business API", "x-api-slug"=>"cloud-elements--dropbox-for-business-api", "description"=>"Dropbox is a modern workspace designed to reduce busywork-so you can focus on the things that matter. Sign in and put your creative energy to work.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/184-dropbox.jpg", "humanURL"=>"http://dropbox.com", "baseURL"=>"https://api.dropbox.com//1/team", "tags"=>"API LIfeyclessss,API Provider,API Service Provider,File Storage,Indie EdTech Data Jam,internet,Mobile,My API Stack,Profiles,Relative Data,SaaS,Service API,Sharing,Stack,Storage,Storage,Storage,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/dropbox/reportsget-storage-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/dropbox/cloud-elements--dropbox-for-business-api-openapi.yaml"}]}, {"name"=>"Dropbox Content", "x-api-slug"=>"dropbox-content", "description"=>"Dropbox is a modern workspace designed to reduce busywork-so you can focus on the things that matter. Sign in and put your creative energy to work.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/184-dropbox.jpg", "humanURL"=>"http://dropbox.com", "baseURL"=>"https://api-content.dropbox.com//1", "tags"=>"Storage", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/dropbox/dropbox-content-openapi.yaml"}]}, {"name"=>"Dropbox Core", "x-api-slug"=>"dropbox-core", "description"=>"Dropbox is a modern workspace designed to reduce busywork-so you can focus on the things that matter. Sign in and put your creative energy to work.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/184-dropbox.jpg", "humanURL"=>"http://dropbox.com", "baseURL"=>"https://api.dropbox.com//1", "tags"=>"Storage,Documents,Commit,Chunked,Upload,Root,Path", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/dropbox/fileopsmove-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/dropbox/dropbox-core-openapi.yaml"}]}, {"name"=>"Dropbox Datastore API", "x-api-slug"=>"dropbox-datastore-api", "description"=>"Keep your apps structured data in sync with Dropbox", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/184-dropbox.jpg", "humanURL"=>"http://dropbox.com", "baseURL"=>"https://api.dropbox.com//1", "tags"=>"Storage,Documents,Fileops,Move", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/dropbox/thumbnails-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/dropbox/dropbox-datastore-api-openapi.yaml"}]}, {"name"=>"Dropbox Notify", "x-api-slug"=>"dropbox-notify", "description"=>"Dropbox is a modern workspace designed to reduce busywork-so you can focus on the things that matter. Sign in and put your creative energy to work.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/184-dropbox.jpg", "humanURL"=>"http://dropbox.com", "baseURL"=>"https://api-notify.dropbox.com//1", "tags"=>"Thumbnails", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/dropbox/longpoll-delta-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/dropbox/dropbox-notify-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-application-management", "url"=>"https://www.dropbox.com/developers/apps"}, {"type"=>"x-base", "url"=>"https://api.dropbox.com/"}, {"type"=>"x-blog", "url"=>"https://blog.dropbox.com/"}, {"type"=>"x-blog-rss", "url"=>"https://blog.dropbox.com/feed/"}, {"type"=>"x-branding", "url"=>"https://www.dropbox.com/developers/reference/branding"}, {"type"=>"x-branding", "url"=>"https://www.dropbox.com/branding"}, {"type"=>"x-contact-form", "url"=>"https://www.dropbox.com/developers/contact"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/dropbox"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/dropbox"}, {"type"=>"x-developer", "url"=>"https://www.dropbox.com/developers"}, {"type"=>"x-email", "url"=>"privacyshield@dropbox.com"}, {"type"=>"x-email", "url"=>"privacy@dropbox.com"}, {"type"=>"x-email", "url"=>"contractnotices@dropbox.com"}, {"type"=>"x-email", "url"=>"copyright@dropbox.com"}, {"type"=>"x-email", "url"=>"dispute-notice@dropbox.com"}, {"type"=>"x-faq", "url"=>"https://www.dropbox.com/developers/support"}, {"type"=>"x-forum", "url"=>"https://www.dropboxforum.com/hc/communities/public/topics/200209245-API-Development"}, {"type"=>"x-github", "url"=>"https://github.com/dropbox"}, {"type"=>"x-pricing", "url"=>"https://www.dropbox.com/plans"}, {"type"=>"x-privacy", "url"=>"https://www.dropbox.com/privacy"}, {"type"=>"x-stack-overflow", "url"=>"http://stackoverflow.com/questions/tagged/dropbox-api?sort=votes&pagesize=15"}, {"type"=>"x-support", "url"=>"https://www.dropbox.com/help"}, {"type"=>"x-terms-of-service", "url"=>"https://www.dropbox.com/privacy#terms"}, {"type"=>"x-transparency-report", "url"=>"https://www.dropbox.com/transparency"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/dropbox"}, {"type"=>"x-webhook", "url"=>"https://www.dropbox.com/developers/reference/webhooks"}, {"type"=>"x-webhooks", "url"=>"https://www.dropbox.com/developers/webhooks/docs"}, {"type"=>"x-website", "url"=>"http://dropbox.com"}, {"type"=>"x-website", "url"=>"https://www.dropbox.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-elastic-load-balancing{"aws-elastic-load-balancing-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Elastic Load Balancing", "x-complete"=>1, "info"=>{"title"=>"AWS Elastic Load Balancing API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddTags"=>{"get"=>{"summary"=>"Add Tags", "description"=>"Adds the specified tags to the specified resource.", "operationId"=>"addTags", "x-api-path-slug"=>"actionaddtags-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceArns.member.N", "description"=>"The Amazon Resource Name (ARN) of the resource", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.member.N", "description"=>"The tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=CreateListener"=>{"get"=>{"summary"=>"Create Listener", "description"=>"Creates a listener for the specified Application Load Balancer.", "operationId"=>"createListener", "x-api-path-slug"=>"actioncreatelistener-get", "parameters"=>[{"in"=>"query", "name"=>"Certificates.member.N", "description"=>"The SSL server certificate", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultActions.member.N", "description"=>"The default action for the listener", "type"=>"string"}, {"in"=>"query", "name"=>"LoadBalancerArn", "description"=>"The Amazon Resource Name (ARN) of the load balancer", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port on which the load balancer is listening", "type"=>"string"}, {"in"=>"query", "name"=>"Protocol", "description"=>"The protocol for connections from clients to the load balancer", "type"=>"string"}, {"in"=>"query", "name"=>"SslPolicy", "description"=>"The security policy that defines which ciphers and protocols are supported", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listeners"]}}, "/?Action=CreateLoadBalancer"=>{"get"=>{"summary"=>"Create Load Balancer", "description"=>"Creates an Application Load Balancer.", "operationId"=>"createLoadBalancer", "x-api-path-slug"=>"actioncreateloadbalancer-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"The name of the load balancer", "type"=>"string"}, {"in"=>"query", "name"=>"Scheme", "description"=>"The nodes of an Internet-facing load balancer have public IP addresses", "type"=>"string"}, {"in"=>"query", "name"=>"SecurityGroups.member.N", "description"=>"The IDs of the security groups to assign to the load balancer", "type"=>"string"}, {"in"=>"query", "name"=>"Subnets.member.N", "description"=>"The IDs of the subnets to attach to the load balancer", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.member.N", "description"=>"One or more tags to assign to the load balancer", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load Balancers"]}}, "/?Action=CreateRule"=>{"get"=>{"summary"=>"Create Rule", "description"=>"Creates a rule for the specified listener.", "operationId"=>"createRule", "x-api-path-slug"=>"actioncreaterule-get", "parameters"=>[{"in"=>"query", "name"=>"Actions.member.N", "description"=>"An action", "type"=>"string"}, {"in"=>"query", "name"=>"Conditions.member.N", "description"=>"A condition", "type"=>"string"}, {"in"=>"query", "name"=>"ListenerArn", "description"=>"The Amazon Resource Name (ARN) of the listener", "type"=>"string"}, {"in"=>"query", "name"=>"Priority", "description"=>"The priority for the rule", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rules"]}}, "/?Action=CreateTargetGroup"=>{"get"=>{"summary"=>"Create Target Group", "description"=>"Creates a target group.", "operationId"=>"createTargetGroup", "x-api-path-slug"=>"actioncreatetargetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"HealthCheckIntervalSeconds", "description"=>"The approximate amount of time, in seconds, between health checks of an individual target", "type"=>"string"}, {"in"=>"query", "name"=>"HealthCheckPath", "description"=>"The ping path that is the destination on the targets for health checks", "type"=>"string"}, {"in"=>"query", "name"=>"HealthCheckPort", "description"=>"The port the load balancer uses when performing health checks on targets", "type"=>"string"}, {"in"=>"query", "name"=>"HealthCheckProtocol", "description"=>"The protocol the load balancer uses when performing health checks on targets", "type"=>"string"}, {"in"=>"query", "name"=>"HealthCheckTimeoutSeconds", "description"=>"The amount of time, in seconds, during which no response from a target means a failed health check", "type"=>"string"}, {"in"=>"query", "name"=>"HealthyThresholdCount", "description"=>"The number of consecutive health checks successes required before considering an unhealthy target healthy", "type"=>"string"}, {"in"=>"query", "name"=>"Matcher", "description"=>"The HTTP codes to use when checking for a successful response from a target", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the target group", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port on which the targets receive traffic", "type"=>"string"}, {"in"=>"query", "name"=>"Protocol", "description"=>"The protocol to use for routing traffic to the targets", "type"=>"string"}, {"in"=>"query", "name"=>"UnhealthyThresholdCount", "description"=>"The number of consecutive health check failures required before considering a target unhealthy", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The identifier of the virtual private cloud (VPC)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Groups"]}}, "/?Action=DeleteListener"=>{"get"=>{"summary"=>"Delete Listener", "description"=>"Deletes the specified listener.", "operationId"=>"deleteListener", "x-api-path-slug"=>"actiondeletelistener-get", "parameters"=>[{"in"=>"query", "name"=>"ListenerArn", "description"=>"The Amazon Resource Name (ARN) of the listener", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listeners"]}}, "/?Action=DeleteLoadBalancer"=>{"get"=>{"summary"=>"Delete Load Balancer", "description"=>"Deletes the specified Application Load Balancer and its attached listeners.", "operationId"=>"deleteLoadBalancer", "x-api-path-slug"=>"actiondeleteloadbalancer-get", "parameters"=>[{"in"=>"query", "name"=>"LoadBalancerArn", "description"=>"The Amazon Resource Name (ARN) of the load balancer", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load Balancers"]}}, "/?Action=DeleteRule"=>{"get"=>{"summary"=>"Delete Rule", "description"=>"Deletes the specified rule.", "operationId"=>"deleteRule", "x-api-path-slug"=>"actiondeleterule-get", "parameters"=>[{"in"=>"query", "name"=>"RuleArn", "description"=>"The Amazon Resource Name (ARN) of the rule", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rules"]}}, "/?Action=DeleteTargetGroup"=>{"get"=>{"summary"=>"Delete Target Group", "description"=>"Deletes the specified target group.", "operationId"=>"deleteTargetGroup", "x-api-path-slug"=>"actiondeletetargetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"TargetGroupArn", "description"=>"The Amazon Resource Name (ARN) of the target group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Groups"]}}, "/?Action=DeregisterTargets"=>{"get"=>{"summary"=>"Deregister Targets", "description"=>"Deregisters the specified targets from the specified target group.", "operationId"=>"deregisterTargets", "x-api-path-slug"=>"actionderegistertargets-get", "parameters"=>[{"in"=>"query", "name"=>"TargetGroupArn", "description"=>"The Amazon Resource Name (ARN) of the target group", "type"=>"string"}, {"in"=>"query", "name"=>"Targets.member.N", "description"=>"The targets", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Targets"]}}, "/?Action=DescribeListeners"=>{"get"=>{"summary"=>"Describe Listeners", "description"=>"Describes the specified listeners or the listeners for the specified Application Load Balancer.", "operationId"=>"describeListeners", "x-api-path-slug"=>"actiondescribelisteners-get", "parameters"=>[{"in"=>"query", "name"=>"ListenerArns.member.N", "description"=>"The Amazon Resource Names (ARN) of the listeners", "type"=>"string"}, {"in"=>"query", "name"=>"LoadBalancerArn", "description"=>"The Amazon Resource Name (ARN) of the load balancer", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"The marker for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"PageSize", "description"=>"The maximum number of results to return with this call", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listeners"]}}, "/?Action=DescribeLoadBalancerAttributes"=>{"get"=>{"summary"=>"Describe Load Balancer Attributes", "description"=>"Describes the attributes for the specified Application Load Balancer.", "operationId"=>"describeLoadBalancerAttributes", "x-api-path-slug"=>"actiondescribeloadbalancerattributes-get", "parameters"=>[{"in"=>"query", "name"=>"LoadBalancerArn", "description"=>"The Amazon Resource Name (ARN) of the load balancer", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load Balancers"]}}, "/?Action=DescribeLoadBalancers"=>{"get"=>{"summary"=>"Describe Load Balancers", "description"=>"Describes the specified Application Load Balancers or all of your Application Load Balancers.", "operationId"=>"describeLoadBalancers", "x-api-path-slug"=>"actiondescribeloadbalancers-get", "parameters"=>[{"in"=>"query", "name"=>"LoadBalancerArns.member.N", "description"=>"The Amazon Resource Names (ARN) of the load balancers", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"The marker for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"Names.member.N", "description"=>"The names of the load balancers", "type"=>"string"}, {"in"=>"query", "name"=>"PageSize", "description"=>"The maximum number of results to return with this call", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load Balancers"]}}, "/?Action=DescribeRules"=>{"get"=>{"summary"=>"Describe Rules", "description"=>"Describes the specified rules or the rules for the specified listener.", "operationId"=>"describeRules", "x-api-path-slug"=>"actiondescriberules-get", "parameters"=>[{"in"=>"query", "name"=>"ListenerArn", "description"=>"The Amazon Resource Name (ARN) of the listener", "type"=>"string"}, {"in"=>"query", "name"=>"RuleArns.member.N", "description"=>"The Amazon Resource Names (ARN) of the rules", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rules"]}}, "/?Action=DescribeSSLPolicies"=>{"get"=>{"summary"=>"Describe S S L Policies", "description"=>"Describes the specified policies or all policies used for SSL negotiation.", "operationId"=>"describeSSLPolicies", "x-api-path-slug"=>"actiondescribesslpolicies-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"The marker for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"Names.member.N", "description"=>"The names of the policies", "type"=>"string"}, {"in"=>"query", "name"=>"PageSize", "description"=>"The maximum number of results to return with this call", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SSL Policies"]}}, "/?Action=DescribeTags"=>{"get"=>{"summary"=>"Describe Tags", "description"=>"Describes the tags for the specified resources.", "operationId"=>"describeTags", "x-api-path-slug"=>"actiondescribetags-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceArns.member.N", "description"=>"The Amazon Resource Names (ARN) of the resources", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=DescribeTargetGroupAttributes"=>{"get"=>{"summary"=>"Describe Target Group Attributes", "description"=>"Describes the attributes for the specified target group.", "operationId"=>"describeTargetGroupAttributes", "x-api-path-slug"=>"actiondescribetargetgroupattributes-get", "parameters"=>[{"in"=>"query", "name"=>"TargetGroupArn", "description"=>"The Amazon Resource Name (ARN) of the target group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Groups"]}}, "/?Action=DescribeTargetGroups"=>{"get"=>{"summary"=>"Describe Target Groups", "description"=>"Describes the specified target groups or all of your target groups.", "operationId"=>"describeTargetGroups", "x-api-path-slug"=>"actiondescribetargetgroups-get", "parameters"=>[{"in"=>"query", "name"=>"LoadBalancerArn", "description"=>"The Amazon Resource Name (ARN) of the load balancer", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"The marker for the next set of results", "type"=>"string"}, {"in"=>"query", "name"=>"Names.member.N", "description"=>"The names of the target groups", "type"=>"string"}, {"in"=>"query", "name"=>"PageSize", "description"=>"The maximum number of results to return with this call", "type"=>"string"}, {"in"=>"query", "name"=>"TargetGroupArns.member.N", "description"=>"The Amazon Resource Names (ARN) of the target groups", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Groups"]}}, "/?Action=DescribeTargetHealth"=>{"get"=>{"summary"=>"Describe Target Health", "description"=>"Describes the health of the specified targets or all of your targets.", "operationId"=>"describeTargetHealth", "x-api-path-slug"=>"actiondescribetargethealth-get", "parameters"=>[{"in"=>"query", "name"=>"TargetGroupArn", "description"=>"The Amazon Resource Name (ARN) of the target group", "type"=>"string"}, {"in"=>"query", "name"=>"Targets.member.N", "description"=>"The targets", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Health"]}}, "/?Action=ModifyListener"=>{"get"=>{"summary"=>"Modify Listener", "description"=>"Modifies the specified properties of the specified listener.", "operationId"=>"modifyListener", "x-api-path-slug"=>"actionmodifylistener-get", "parameters"=>[{"in"=>"query", "name"=>"Certificates.member.N", "description"=>"The SSL server certificate", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultActions.member.N", "description"=>"The default actions", "type"=>"string"}, {"in"=>"query", "name"=>"ListenerArn", "description"=>"The Amazon Resource Name (ARN) of the listener", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port for connections from clients to the load balancer", "type"=>"string"}, {"in"=>"query", "name"=>"Protocol", "description"=>"The protocol for connections from clients to the load balancer", "type"=>"string"}, {"in"=>"query", "name"=>"SslPolicy", "description"=>"The security policy that defines which ciphers and protocols are supported", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Listeners"]}}, "/?Action=ModifyLoadBalancerAttributes"=>{"get"=>{"summary"=>"Modify Load Balancer Attributes", "description"=>"Modifies the specified attributes of the specified Application Load Balancer.", "operationId"=>"modifyLoadBalancerAttributes", "x-api-path-slug"=>"actionmodifyloadbalancerattributes-get", "parameters"=>[{"in"=>"query", "name"=>"Attributes.member.N", "description"=>"The load balancer attributes", "type"=>"string"}, {"in"=>"query", "name"=>"LoadBalancerArn", "description"=>"The Amazon Resource Name (ARN) of the load balancer", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load Balancers"]}}, "/?Action=ModifyRule"=>{"get"=>{"summary"=>"Modify Rule", "description"=>"Modifies the specified rule.", "operationId"=>"modifyRule", "x-api-path-slug"=>"actionmodifyrule-get", "parameters"=>[{"in"=>"query", "name"=>"Actions.member.N", "description"=>"The actions", "type"=>"string"}, {"in"=>"query", "name"=>"Conditions.member.N", "description"=>"The conditions", "type"=>"string"}, {"in"=>"query", "name"=>"RuleArn", "description"=>"The Amazon Resource Name (ARN) of the rule", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rules"]}}, "/?Action=ModifyTargetGroup"=>{"get"=>{"summary"=>"Modify Target Group", "description"=>"Modifies the health checks used when evaluating the health state of the targets in the specified target group.", "operationId"=>"modifyTargetGroup", "x-api-path-slug"=>"actionmodifytargetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"HealthCheckIntervalSeconds", "description"=>"The approximate amount of time, in seconds, between health checks of an individual target", "type"=>"string"}, {"in"=>"query", "name"=>"HealthCheckPath", "description"=>"The ping path that is the destination for the health check request", "type"=>"string"}, {"in"=>"query", "name"=>"HealthCheckPort", "description"=>"The port to use to connect with the target", "type"=>"string"}, {"in"=>"query", "name"=>"HealthCheckProtocol", "description"=>"The protocol to use to connect with the target", "type"=>"string"}, {"in"=>"query", "name"=>"HealthCheckTimeoutSeconds", "description"=>"The amount of time, in seconds, during which no response means a failed health check", "type"=>"string"}, {"in"=>"query", "name"=>"HealthyThresholdCount", "description"=>"The number of consecutive health checks successes required before considering an unhealthy target healthy", "type"=>"string"}, {"in"=>"query", "name"=>"Matcher", "description"=>"The HTTP codes to use when checking for a successful response from a target", "type"=>"string"}, {"in"=>"query", "name"=>"TargetGroupArn", "description"=>"The Amazon Resource Name (ARN) of the target group", "type"=>"string"}, {"in"=>"query", "name"=>"UnhealthyThresholdCount", "description"=>"The number of consecutive health check failures required before considering the target unhealthy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Groups"]}}, "/?Action=ModifyTargetGroupAttributes"=>{"get"=>{"summary"=>"Modify Target Group Attributes", "description"=>"Modifies the specified attributes of the specified target group.", "operationId"=>"modifyTargetGroupAttributes", "x-api-path-slug"=>"actionmodifytargetgroupattributes-get", "parameters"=>[{"in"=>"query", "name"=>"Attributes.member.N", "description"=>"The attributes", "type"=>"string"}, {"in"=>"query", "name"=>"TargetGroupArn", "description"=>"The Amazon Resource Name (ARN) of the target group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Groups"]}}, "/?Action=RegisterTargets"=>{"get"=>{"summary"=>"Register Targets", "description"=>"Registers the specified targets with the specified target group.", "operationId"=>"registerTargets", "x-api-path-slug"=>"actionregistertargets-get", "parameters"=>[{"in"=>"query", "name"=>"TargetGroupArn", "description"=>"The Amazon Resource Name (ARN) of the target group", "type"=>"string"}, {"in"=>"query", "name"=>"Targets.member.N", "description"=>"The targets", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Targets"]}}, "/?Action=RemoveTags"=>{"get"=>{"summary"=>"Remove Tags", "description"=>"Removes the specified tags from the specified resource.", "operationId"=>"removeTags", "x-api-path-slug"=>"actionremovetags-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceArns.member.N", "description"=>"The Amazon Resource Name (ARN) of the resource", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys.member.N", "description"=>"The tag keys for the tags to remove", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=SetRulePriorities"=>{"get"=>{"summary"=>"Set Rule Priorities", "description"=>"Sets the priorities of the specified rules.", "operationId"=>"setRulePriorities", "x-api-path-slug"=>"actionsetrulepriorities-get", "parameters"=>[{"in"=>"query", "name"=>"RulePriorities.member.N", "description"=>"The rule priorities", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rule Priorities"]}}, "/?Action=SetSecurityGroups"=>{"get"=>{"summary"=>"Set Security Groups", "description"=>"Associates the specified security groups with the specified load balancer.", "operationId"=>"setSecurityGroups", "x-api-path-slug"=>"actionsetsecuritygroups-get", "parameters"=>[{"in"=>"query", "name"=>"LoadBalancerArn", "description"=>"The Amazon Resource Name (ARN) of the load balancer", "type"=>"string"}, {"in"=>"query", "name"=>"SecurityGroups.member.N", "description"=>"The IDs of the security groups", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Groups"]}}, "/?Action=SetSubnets"=>{"get"=>{"summary"=>"Set Subnets", "description"=>"Enables the Availability Zone for the specified subnets for the specified load balancer.", "operationId"=>"setSubnets", "x-api-path-slug"=>"actionsetsubnets-get", "parameters"=>[{"in"=>"query", "name"=>"LoadBalancerArn", "description"=>"The Amazon Resource Name (ARN) of the load balancer", "type"=>"string"}, {"in"=>"query", "name"=>"Subnets.member.N", "description"=>"The IDs of the subnets", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnets"]}}}}, "apis"=>{"name"=>"AWS Elastic Load Balancing", "x-slug"=>"aws-elastic-load-balancing", "description"=>"Elastic Load Balancing automatically distributes incoming application traffic across multiple Amazon EC2 instances. It enables you to achieve fault tolerance in your applications, seamlessly providing the required amount of load balancing capacity needed to route application traffic.Elastic Load Balancing offers two types of load balancers that both feature high availability, automatic scaling, and robust security. These include theClassic Load Balancerthat routes traffic based on either application or network level information, and theApplication Load Balancerthat routes traffic based on advanced application level information that includes the content of the request. The Classic Load Balancer is ideal for simple load balancing of traffic across multiple EC2 instances, while the Application Load Balancer is ideal for applications needing advanced routing capabilities, microservices, and container-based architectures. Application Load Balancer offers ability to route traffic to multiple services or load balance across multiple ports on the same EC2 instance.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_ElasticLoadBalancing.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Availability,Compute,Performance,Profiles,Relative Data,Servers,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-elastic-load-balancing/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Elastic Load Balancing API", "x-api-slug"=>"aws-elastic-load-balancing-api", "description"=>"Elastic Load Balancing automatically distributes incoming application traffic across multiple Amazon EC2 instances. It enables you to achieve fault tolerance in your applications, seamlessly providing the required amount of load balancing capacity needed to route application traffic.Elastic Load Balancing offers two types of load balancers that both feature high availability, automatic scaling, and robust security. These include theClassic Load Balancerthat routes traffic based on either application or network level information, and theApplication Load Balancerthat routes traffic based on advanced application level information that includes the content of the request. The Classic Load Balancer is ideal for simple load balancing of traffic across multiple EC2 instances, while the Application Load Balancer is ideal for applications needing advanced routing capabilities, microservices, and container-based architectures. Application Load Balancer offers ability to route traffic to multiple services or load balance across multiple ports on the same EC2 instance.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_ElasticLoadBalancing.png", "humanURL"=>"https://aws.amazon.com/elasticloadbalancing/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Availability,Compute,Performance,Profiles,Relative Data,Servers,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-elastic-load-balancing/actionsetsubnets-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-elastic-load-balancing/aws-elastic-load-balancing-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/cli/latest/reference/elbv2/index.html"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/elasticloadbalancing/classicloadbalancer/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/elasticloadbalancing/classicloadbalancer/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/elasticloadbalancing/classicloadbalancer/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/elasticloadbalancing/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
akeneo{"akeneo-pim-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Akeneo", "x-complete"=>1, "info"=>{"title"=>"Official Akeneo PIM API", "description"=>"the-akeneo-api-brought-to-youfind-out-how-this-postman-collection-works-by-visiting-httpapi-akeneo-com", "version"=>"1.0.0"}, "host"=>"example.com", "basePath"=>"/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/rest/v1/assets/paint"=>{"get"=>{"summary"=>"asset (2.1 only)", "description"=>"Assuming that the given code is the code of an existing asset", "operationId"=>"RestV1AssetsPaintGet", "x-api-path-slug"=>"restv1assetspaint-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "(2", "1", "Only)"]}, "patch"=>{"summary"=>"asset (2.1 only)", "description"=>"Asset (2.1 only).", "operationId"=>"RestV1AssetsPaintPatch", "x-api-path-slug"=>"restv1assetspaint-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "(2", "1", "Only)"]}}, "/rest/v1/assets"=>{"get"=>{"summary"=>"assets (2.1 only)", "description"=>"Assets (2.1 only).", "operationId"=>"RestV1AssetsGet", "x-api-path-slug"=>"restv1assets-get", "parameters"=>[{"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"with_count"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assets", "(2", "1", "Only)"]}, "post"=>{"summary"=>"asset (2.1 only)", "description"=>"Assuming that there is no \"new_asset\" already existing", "operationId"=>"RestV1AssetsPost", "x-api-path-slug"=>"restv1assets-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "(2", "1", "Only)"]}, "patch"=>{"summary"=>"assets (2.1 only)", "description"=>"Assets (2.1 only).", "operationId"=>"RestV1AssetsPatch", "x-api-path-slug"=>"restv1assets-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assets", "(2", "1", "Only)"]}}, "/rest/v1/assets/paint/reference-files/no-locale"=>{"get"=>{"summary"=>"asset reference file (2.1 only)", "description"=>"Assuming that the given codes are respectively the code of an existing asset and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)", "operationId"=>"RestV1AssetsPaintReferenceFilesNoLocaleGet", "x-api-path-slug"=>"restv1assetspaintreferencefilesnolocale-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Reference", "File", "(2", "1", "Only)"]}, "post"=>{"summary"=>"asset reference file (2.1 only)", "description"=>"Assuming that the given codes are respectively the code of an existing asset and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)", "operationId"=>"RestV1AssetsPaintReferenceFilesNoLocalePost", "x-api-path-slug"=>"restv1assetspaintreferencefilesnolocale-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"formData", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Reference", "File", "(2", "1", "Only)"]}}, "/rest/v1/assets/paint/reference-files/no-locale/download"=>{"get"=>{"summary"=>"download asset reference file (2.1 only)", "description"=>"Assuming that the given codes are respectively the code of an existing asset and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)", "operationId"=>"RestV1AssetsPaintReferenceFilesNoLocaleDownloadGet", "x-api-path-slug"=>"restv1assetspaintreferencefilesnolocaledownload-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Download", "Asset", "Reference", "File", "(2", "1", "Only)"]}}, "/rest/v1/assets/paint/variation-files/ecommerce/no-locale"=>{"get"=>{"summary"=>"asset variation file (2.1 only)", "description"=>"Assuming that the given codes are respectively the code of an existing asset, an existing channel and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)", "operationId"=>"RestV1AssetsPaintVariationFilesEcommerceNoLocaleGet", "x-api-path-slug"=>"restv1assetspaintvariationfilesecommercenolocale-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Variation", "File", "(2", "1", "Only)"]}, "post"=>{"summary"=>"asset variation file (2.1 only)", "description"=>"Assuming that the given codes are respectively the code of an existing asset, an existing channel and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)", "operationId"=>"RestV1AssetsPaintVariationFilesEcommerceNoLocalePost", "x-api-path-slug"=>"restv1assetspaintvariationfilesecommercenolocale-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"formData", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Variation", "File", "(2", "1", "Only)"]}}, "/rest/v1/assets/paint/variation-files/ecommerce/no-locale/download"=>{"get"=>{"summary"=>"download asset variation file (2.1 only)", "description"=>"Assuming that the given codes are respectively the code of an existing asset, an existing channel and an activated locale if the asset is localizable (it should be equal to \"no-locale\" otherwise)", "operationId"=>"RestV1AssetsPaintVariationFilesEcommerceNoLocaleDownloadGet", "x-api-path-slug"=>"restv1assetspaintvariationfilesecommercenolocaledownload-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Download", "Asset", "Variation", "File", "(2", "1", "Only)"]}}, "/rest/v1/asset-categories/asset_main_catalog"=>{"get"=>{"summary"=>"asset category (2.1 only)", "description"=>"Assuming that the given code is the code of an existing asset category", "operationId"=>"RestV1AssetCategoriesAssetMainCatalogGet", "x-api-path-slug"=>"restv1assetcategoriesasset-main-catalog-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Category", "(2", "1", "Only)"]}}, "/rest/v1/asset-categories"=>{"get"=>{"summary"=>"asset categories (2.1 only)", "description"=>"Asset categories (2.1 only).", "operationId"=>"RestV1AssetCategoriesGet", "x-api-path-slug"=>"restv1assetcategories-get", "parameters"=>[{"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"with_count"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Categories", "(2", "1", "Only)"]}, "post"=>{"summary"=>"asset category (2.1 only)", "description"=>"Assuming that there is no \"new_asset_category\" already existing", "operationId"=>"RestV1AssetCategoriesPost", "x-api-path-slug"=>"restv1assetcategories-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Category", "(2", "1", "Only)"]}, "patch"=>{"summary"=>"asset categories (2.1 only)", "description"=>"Asset categories (2.1 only).", "operationId"=>"RestV1AssetCategoriesPatch", "x-api-path-slug"=>"restv1assetcategories-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Categories", "(2", "1", "Only)"]}}, "/rest/v1/asset-categories/new_asset_category"=>{"patch"=>{"summary"=>"asset category (2.1 only)", "description"=>"Asset category (2.1 only).", "operationId"=>"RestV1AssetCategoriesNewAssetCategoryPatch", "x-api-path-slug"=>"restv1assetcategoriesnew-asset-category-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Category", "(2", "1", "Only)"]}}, "/rest/v1/asset-tags/colored"=>{"get"=>{"summary"=>"asset tag (2.1 only)", "description"=>"Assuming that the given code is the code of an existing asset tag", "operationId"=>"RestV1AssetTagsColoredGet", "x-api-path-slug"=>"restv1assettagscolored-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Tag", "(2", "1", "Only)"]}, "patch"=>{"summary"=>"asset tag (2.1 only)", "description"=>"Asset tag (2.1 only).", "operationId"=>"RestV1AssetTagsColoredPatch", "x-api-path-slug"=>"restv1assettagscolored-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Tag", "(2", "1", "Only)"]}}, "/rest/v1/asset-tags"=>{"get"=>{"summary"=>"asset tags (2.1 only)", "description"=>"Asset tags (2.1 only).", "operationId"=>"RestV1AssetTagsGet", "x-api-path-slug"=>"restv1assettags-get", "parameters"=>[{"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"with_count"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Asset", "Tags", "(2", "1", "Only)"]}}, "/rest/v1/association-types/upsell"=>{"get"=>{"summary"=>"association type (2.x only)", "description"=>"Assuming that the given code is the code of an existing association type", "operationId"=>"RestV1AssociationTypesUpsellGet", "x-api-path-slug"=>"restv1associationtypesupsell-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Association", "Type", "(2", "X", "Only)"]}, "patch"=>{"summary"=>"association type (2.x only)", "description"=>"Association type (2.x only).", "operationId"=>"RestV1AssociationTypesUpsellPatch", "x-api-path-slug"=>"restv1associationtypesupsell-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Association", "Type", "(2", "X", "Only)"]}}, "/rest/v1/association-types"=>{"get"=>{"summary"=>"association types (2.x only)", "description"=>"Association types (2.x only).", "operationId"=>"RestV1AssociationTypesGet", "x-api-path-slug"=>"restv1associationtypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Association", "Types", "(2", "X", "Only)"]}, "post"=>{"summary"=>"association type (2.x only)", "description"=>"Assuming that there is no \"new_association_type\" already existing", "operationId"=>"RestV1AssociationTypesPost", "x-api-path-slug"=>"restv1associationtypes-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Association", "Type", "(2", "X", "Only)"]}, "patch"=>{"summary"=>"association types (2.x only)", "description"=>"Association types (2.x only).", "operationId"=>"RestV1AssociationTypesPatch", "x-api-path-slug"=>"restv1associationtypes-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Association", "Types", "(2", "X", "Only)"]}}, "/rest/v1/attributes/auto_exposure"=>{"get"=>{"summary"=>"attribute", "description"=>"Assuming that the given code is the code of an existing attribute", "operationId"=>"RestV1AttributesAutoExposureGet", "x-api-path-slug"=>"restv1attributesauto-exposure-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute"]}, "patch"=>{"summary"=>"attribute", "description"=>"Attribute.", "operationId"=>"RestV1AttributesAutoExposurePatch", "x-api-path-slug"=>"restv1attributesauto-exposure-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute"]}}, "/rest/v1/attributes"=>{"get"=>{"summary"=>"attributes", "description"=>"Attributes.", "operationId"=>"RestV1AttributesGet", "x-api-path-slug"=>"restv1attributes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attributes"]}, "post"=>{"summary"=>"attribute", "description"=>"Assuming that there is no \"new_attribute\" already existing", "operationId"=>"RestV1AttributesPost", "x-api-path-slug"=>"restv1attributes-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute"]}, "patch"=>{"summary"=>"attributes", "description"=>"Attributes.", "operationId"=>"RestV1AttributesPatch", "x-api-path-slug"=>"restv1attributes-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attributes"]}}, "/rest/v1/attributes/main_color/options/white"=>{"get"=>{"summary"=>"attribute option", "description"=>"Assuming that the given codes are respectively the code of an existing attribute and an existing option of this attribute", "operationId"=>"RestV1AttributesMainColorOptionsWhiteGet", "x-api-path-slug"=>"restv1attributesmain-coloroptionswhite-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Option"]}, "patch"=>{"summary"=>"attribute option", "description"=>"Assuming that the given code is the code of an existing attribute", "operationId"=>"RestV1AttributesMainColorOptionsWhitePatch", "x-api-path-slug"=>"restv1attributesmain-coloroptionswhite-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Option"]}}, "/rest/v1/attributes/main_color/options"=>{"get"=>{"summary"=>"attribute options", "description"=>"Attribute options.", "operationId"=>"RestV1AttributesMainColorOptionsGet", "x-api-path-slug"=>"restv1attributesmain-coloroptions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Options"]}, "post"=>{"summary"=>"attribute option", "description"=>"Assuming that there is no \"yellow\" option already existing for the given attribute", "operationId"=>"RestV1AttributesMainColorOptionsPost", "x-api-path-slug"=>"restv1attributesmain-coloroptions-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Option"]}, "patch"=>{"summary"=>"attribute options (2.1 only)", "description"=>"Assuming that the given code is the code of an existing attribute", "operationId"=>"RestV1AttributesMainColorOptionsPatch", "x-api-path-slug"=>"restv1attributesmain-coloroptions-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Options", "(2", "1", "Only)"]}}, "/rest/v1/attribute-groups/technical"=>{"get"=>{"summary"=>"attribute group (2.x only)", "description"=>"Assuming that the given code is the code of an existing attribute group", "operationId"=>"RestV1AttributeGroupsTechnicalGet", "x-api-path-slug"=>"restv1attributegroupstechnical-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Group", "(2", "X", "Only)"]}, "patch"=>{"summary"=>"attribute group (2.x only)", "description"=>"Attribute group (2.x only).", "operationId"=>"RestV1AttributeGroupsTechnicalPatch", "x-api-path-slug"=>"restv1attributegroupstechnical-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Group", "(2", "X", "Only)"]}}, "/rest/v1/attribute-groups"=>{"get"=>{"summary"=>"attribute groups (2.x only)", "description"=>"Attribute groups (2.x only).", "operationId"=>"RestV1AttributeGroupsGet", "x-api-path-slug"=>"restv1attributegroups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Groups", "(2", "X", "Only)"]}, "post"=>{"summary"=>"attribute group (2.x only)", "description"=>"Assuming that there is no \"new_attribute_group\" already existing", "operationId"=>"RestV1AttributeGroupsPost", "x-api-path-slug"=>"restv1attributegroups-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Group", "(2", "X", "Only)"]}, "patch"=>{"summary"=>"attribute groups (2.x only)", "description"=>"Attribute groups (2.x only).", "operationId"=>"RestV1AttributeGroupsPatch", "x-api-path-slug"=>"restv1attributegroups-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attribute", "Groups", "(2", "X", "Only)"]}}, "/rest/v1/categories/master"=>{"get"=>{"summary"=>"category", "description"=>"Assuming that the given code is the code of an existing category", "operationId"=>"RestV1CategoriesMasterGet", "x-api-path-slug"=>"restv1categoriesmaster-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Category"]}}, "/rest/v1/categories"=>{"get"=>{"summary"=>"categories", "description"=>"Categories.", "operationId"=>"RestV1CategoriesGet", "x-api-path-slug"=>"restv1categories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories"]}, "post"=>{"summary"=>"category", "description"=>"Assuming that there is no \"new_category\" already existing", "operationId"=>"RestV1CategoriesPost", "x-api-path-slug"=>"restv1categories-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Category"]}, "patch"=>{"summary"=>"categories", "description"=>"Categories.", "operationId"=>"RestV1CategoriesPatch", "x-api-path-slug"=>"restv1categories-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories"]}}, "/rest/v1/categories/audio_video"=>{"patch"=>{"summary"=>"category", "description"=>"Category.", "operationId"=>"RestV1CategoriesAudioVideoPatch", "x-api-path-slug"=>"restv1categoriesaudio-video-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Category"]}}, "/rest/v1/channels/ecommerce"=>{"get"=>{"summary"=>"channel", "description"=>"Assuming that the given code is the code of an existing channel", "operationId"=>"RestV1ChannelsEcommerceGet", "x-api-path-slug"=>"restv1channelsecommerce-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel"]}}, "/rest/v1/channels"=>{"get"=>{"summary"=>"channels", "description"=>"Channels.", "operationId"=>"RestV1ChannelsGet", "x-api-path-slug"=>"restv1channels-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channels"]}, "post"=>{"summary"=>"channel (2.x only)", "description"=>"Assuming that there is no \"new_channel\" already existing", "operationId"=>"RestV1ChannelsPost", "x-api-path-slug"=>"restv1channels-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel", "(2", "X", "Only)"]}, "patch"=>{"summary"=>"channels (2.x only)", "description"=>"Channels (2.x only).", "operationId"=>"RestV1ChannelsPatch", "x-api-path-slug"=>"restv1channels-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channels", "(2", "X", "Only)"]}}, "/rest/v1/channels/my_new_channel_3"=>{"patch"=>{"summary"=>"channel (2.x only)", "description"=>"Channel (2.x only).", "operationId"=>"RestV1ChannelsMyNewChannel3Patch", "x-api-path-slug"=>"restv1channelsmy-new-channel-3-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel", "(2", "X", "Only)"]}}, "/rest/v1/currencies/USD"=>{"get"=>{"summary"=>"currency (2.x only)", "description"=>"Assuming that the given code is the code of an existing currency", "operationId"=>"RestV1CurrenciesUSDGet", "x-api-path-slug"=>"restv1currenciesusd-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Currency", "(2", "X", "Only)"]}}, "/rest/v1/currencies"=>{"get"=>{"summary"=>"currencies (2.x only)", "description"=>"Currencies (2.x only).", "operationId"=>"RestV1CurrenciesGet", "x-api-path-slug"=>"restv1currencies-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Currencies", "(2", "X", "Only)"]}}, "/rest/v1/families/camcorders"=>{"get"=>{"summary"=>"family", "description"=>"Assuming that the given code is the code of an existing family", "operationId"=>"RestV1FamiliesCamcordersGet", "x-api-path-slug"=>"restv1familiescamcorders-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Family"]}, "patch"=>{"summary"=>"family", "description"=>"Family.", "operationId"=>"RestV1FamiliesCamcordersPatch", "x-api-path-slug"=>"restv1familiescamcorders-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Family"]}}, "/rest/v1/families"=>{"get"=>{"summary"=>"families", "description"=>"Families.", "operationId"=>"RestV1FamiliesGet", "x-api-path-slug"=>"restv1families-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Families"]}, "post"=>{"summary"=>"family", "description"=>"Assuming that there is no \"new_family\" already existing", "operationId"=>"RestV1FamiliesPost", "x-api-path-slug"=>"restv1families-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Family"]}, "patch"=>{"summary"=>"families", "description"=>"Families.", "operationId"=>"RestV1FamiliesPatch", "x-api-path-slug"=>"restv1families-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Families"]}}, "/rest/v1/families/clothing/variants/clothing_colorsize"=>{"get"=>{"summary"=>"family variant (2.x only)", "description"=>"Assuming that the given codes are respectively the code of an existing family and an existing family variant", "operationId"=>"RestV1FamiliesClothingVariantsClothingColorsizeGet", "x-api-path-slug"=>"restv1familiesclothingvariantsclothing-colorsize-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Family", "Variant", "(2", "X", "Only)"]}, "patch"=>{"summary"=>"family variant (2.x only)", "description"=>"Assuming that the given codes are respectively the code of an existing family and an existing family variant", "operationId"=>"RestV1FamiliesClothingVariantsClothingColorsizePatch", "x-api-path-slug"=>"restv1familiesclothingvariantsclothing-colorsize-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Family", "Variant", "(2", "X", "Only)"]}}, "/rest/v1/families/clothing/variants"=>{"get"=>{"summary"=>"family variants (2.x only)", "description"=>"Family variants (2.x only).", "operationId"=>"RestV1FamiliesClothingVariantsGet", "x-api-path-slug"=>"restv1familiesclothingvariants-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Family", "Variants", "(2", "X", "Only)"]}, "post"=>{"summary"=>"family variant (2.x only)", "description"=>"Assuming that the given code is the code of an existing family", "operationId"=>"RestV1FamiliesClothingVariantsPost", "x-api-path-slug"=>"restv1familiesclothingvariants-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Family", "Variant", "(2", "X", "Only)"]}, "patch"=>{"summary"=>"family variants (2.x only)", "description"=>"Assuming that the given code is the code of an existing family", "operationId"=>"RestV1FamiliesClothingVariantsPatch", "x-api-path-slug"=>"restv1familiesclothingvariants-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Family", "Variants", "(2", "X", "Only)"]}}, "/rest/v1/locales/en_US"=>{"get"=>{"summary"=>"locale", "description"=>"Assuming that the given code is the code of an existing locale", "operationId"=>"RestV1LocalesEnUSGet", "x-api-path-slug"=>"restv1localesen-us-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Locale"]}}, "/rest/v1/locales"=>{"get"=>{"summary"=>"locales", "description"=>"Locales.", "operationId"=>"RestV1LocalesGet", "x-api-path-slug"=>"restv1locales-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Locales"]}}, "/rest/v1/measure-families/area"=>{"get"=>{"summary"=>"measure family (2.x only)", "description"=>"Assuming that the given code is the code of an existing measure family", "operationId"=>"RestV1MeasureFamiliesAreaGet", "x-api-path-slug"=>"restv1measurefamiliesarea-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Measure", "Family", "(2", "X", "Only)"]}}, "/rest/v1/measure-families"=>{"get"=>{"summary"=>"measure families (2.x only)", "description"=>"Measure families (2.x only).", "operationId"=>"RestV1MeasureFamiliesGet", "x-api-path-slug"=>"restv1measurefamilies-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Measure", "Families", "(2", "X", "Only)"]}}, "/rest/v1/media-files/d/d/b/6/ddb6ad393f81503b6be7380785e3b32bbd28cd08_test.png"=>{"get"=>{"summary"=>"media", "description"=>"Assuming that the given code is the code of an existing media file", "operationId"=>"RestV1MediaFilesDDB6Ddb6ad393f81503b6be7380785e3b32bbd28cd08TestPngGet", "x-api-path-slug"=>"restv1mediafilesddb6ddb6ad393f81503b6be7380785e3b32bbd28cd08-test-png-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media"]}}, "/rest/v1/media-files"=>{"get"=>{"summary"=>"medias", "description"=>"Medias.", "operationId"=>"RestV1MediaFilesGet", "x-api-path-slug"=>"restv1mediafiles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Medias"]}, "post"=>{"summary"=>"media", "description"=>"Assuming that the given identifier is the identifier of an existing product and that the given attribute code exists", "operationId"=>"RestV1MediaFilesPost", "x-api-path-slug"=>"restv1mediafiles-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"formData", "name"=>"file"}, {"in"=>"formData", "name"=>"product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Media"]}}, "/rest/v1/products/AKNSTK"=>{"get"=>{"summary"=>"product", "description"=>"Assuming that the given identifier is the identifier of an existing product", "operationId"=>"RestV1ProductsAKNSTKGet", "x-api-path-slug"=>"restv1productsaknstk-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}, "patch"=>{"summary"=>"product", "description"=>"Product.", "operationId"=>"RestV1ProductsAKNSTKPatch", "x-api-path-slug"=>"restv1productsaknstk-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}}, "/rest/v1/products"=>{"get"=>{"summary"=>"products", "description"=>"Products.", "operationId"=>"RestV1ProductsGet", "x-api-path-slug"=>"restv1products-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"Cookie"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}, "post"=>{"summary"=>"product", "description"=>"Assuming that there is no \"new_product\" already existing", "operationId"=>"RestV1ProductsPost", "x-api-path-slug"=>"restv1products-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}, "patch"=>{"summary"=>"products", "description"=>"Products.", "operationId"=>"RestV1ProductsPatch", "x-api-path-slug"=>"restv1products-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/rest/v1/products/AKNTS_BPXS"=>{"delete"=>{"summary"=>"product", "description"=>"Assuming that the given identifier is the identifier of an existing product", "operationId"=>"RestV1ProductsAKNTSBPXSDelete", "x-api-path-slug"=>"restv1productsaknts-bpxs-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}}, "/rest/v1/products/AKNTS_BPS/draft"=>{"get"=>{"summary"=>"draft (2.x and EE only)", "description"=>"Assuming that there is already a draft for the given product. The draft was created by the same user that using this request.\nThe user has only an edition permission through categories on the given product.", "operationId"=>"RestV1ProductsAKNTSBPSDraftGet", "x-api-path-slug"=>"restv1productsaknts-bpsdraft-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Draft", "(2", "X", "EE", "Only)"]}}, "/rest/v1/products/AKNTS_BPS/proposal"=>{"post"=>{"summary"=>"proposal (2.x and EE only)", "description"=>"Assuming that there is already a draft for the given product. The draft was created by the same user using this request.\nThe user has only an edition permission through categories on the given product.", "operationId"=>"RestV1ProductsAKNTSBPSProposalPost", "x-api-path-slug"=>"restv1productsaknts-bpsproposal-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proposal", "(2", "X", "EE", "Only)"]}}, "/rest/v1/product-models/amor"=>{"get"=>{"summary"=>"product model (2.x only)", "description"=>"Assuming that the given code is the code of an existing product model", "operationId"=>"RestV1ProductModelsAmorGet", "x-api-path-slug"=>"restv1productmodelsamor-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "Model", "(2", "X", "Only)"]}, "patch"=>{"summary"=>"product model (2.x only)", "description"=>"Assuming that the given code is the code of an existing product model", "operationId"=>"RestV1ProductModelsAmorPatch", "x-api-path-slug"=>"restv1productmodelsamor-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "Model", "(2", "X", "Only)"]}}, "/rest/v1/product-models"=>{"get"=>{"summary"=>"product models (2.x only)", "description"=>"Product models (2.x only).", "operationId"=>"RestV1ProductModelsGet", "x-api-path-slug"=>"restv1productmodels-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "Models", "(2", "X", "Only)"]}, "post"=>{"summary"=>"product model (2.x only)", "description"=>"Product model (2.x only).", "operationId"=>"RestV1ProductModelsPost", "x-api-path-slug"=>"restv1productmodels-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "Model", "(2", "X", "Only)"]}, "patch"=>{"summary"=>"product models (2.x only)", "description"=>"Product models (2.x only).", "operationId"=>"RestV1ProductModelsPatch", "x-api-path-slug"=>"restv1productmodels-patch", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "Models", "(2", "X", "Only)"]}}, "/rest/v1/product-models/amor/draft"=>{"get"=>{"summary"=>"draft (2.3 and EE only)", "description"=>"Assuming that there is already a draft for the given product model. The draft was created by the same user that is using this request.\nThe user has only an edition permission through categories on the given product model.", "operationId"=>"RestV1ProductModelsAmorDraftGet", "x-api-path-slug"=>"restv1productmodelsamordraft-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Draft", "(2", "3", "EE", "Only)"]}}, "/rest/v1/product-models/amor/proposal"=>{"post"=>{"summary"=>"proposal (2.3 and EE only)", "description"=>"Assuming that there is already a draft for the given product model. The draft was created by the same user using this request.\nThe user has only an edition permission through categories on the given product model.", "operationId"=>"RestV1ProductModelsAmorProposalPost", "x-api-path-slug"=>"restv1productmodelsamorproposal-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proposal", "(2", "3", "EE", "Only)"]}}, "/rest/v1/published-products/13527420"=>{"get"=>{"summary"=>"published product (2.x and EE only)", "description"=>"Assuming that the given identifier is the identifier of an existing product that is currently published", "operationId"=>"RestV1PublishedProducts13527420Get", "x-api-path-slug"=>"restv1publishedproducts13527420-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Published", "Product", "(2", "X", "EE", "Only)"]}}, "/rest/v1/published-products"=>{"get"=>{"summary"=>"published products (2.x and EE only)", "description"=>"Published products (2.x and ee only).", "operationId"=>"RestV1PublishedProductsGet", "x-api-path-slug"=>"restv1publishedproducts-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Published", "Products", "(2", "X", "EE", "Only)"]}}, "/oauth/v1/token"=>{"post"=>{"summary"=>"Authentification by refresh token", "description"=>"Authentification by refresh token.", "operationId"=>"OauthV1TokenPost2", "x-api-path-slug"=>"oauthv1token-post", "parameters"=>[{"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authentification", "By", "Refresh", "Token"]}}}}, "apis"=>{"name"=>"Akeneo", "x-slug"=>"akeneo", "description"=>"Our team has been working in the e-commerce industry for over 10 years. As we were helping brands to grow their online businesses, we realized that they were all struggling with complex or archaic systems to manage product information. We founded Akeneo in 2013 with the idea that products are the most important assets in a company and that many merchants lack a tool to help them manage and leverage this crucial asset. Merchants needed a tool that was designed for marketers and flexible enough to be integrated with any third-party application.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/akeneo-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"164081", "tags"=>"Commerce,Enterprise,Products,Relative Data,SaaS,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"akeneo/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Akeneo PIM API", "x-api-slug"=>"akeneo-pim-api", "description"=>"Our team has been working in the e-commerce industry for over 10 years. As we were helping brands to grow their online businesses, we realized that they were all struggling with complex or archaic systems to manage product information. We founded Akeneo in 2013 with the idea that products are the most important assets in a company and that many merchants lack a tool to help them manage and leverage this crucial asset. Merchants needed a tool that was designed for marketers and flexible enough to be integrated with any third-party application.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/akeneo-logo.png", "humanURL"=>"https://akeneo.com", "baseURL"=>"https://example.com//api", "tags"=>"Commerce,Enterprise,Products,Relative Data,SaaS,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/akeneo/akeneo-pim-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog-rss", "url"=>"https://www.akeneo.com/feed/"}, {"type"=>"x-github", "url"=>"https://github.com/akeneo"}, {"type"=>"x-marketplace", "url"=>"https://marketplace.akeneo.com/"}, {"type"=>"x-postman-collection", "url"=>"https://api.akeneo.com/files/Akeneo%20PIM%20API.postman_collection.json"}, {"type"=>"x-website", "url"=>"https://akeneo.com"}, {"type"=>"x-website", "url"=>"http://www.akeneo.com"}, {"type"=>"x-blog", "url"=>"https://www.akeneo.com/blog/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/akeneo"}, {"type"=>"x-documentation", "url"=>"https://api.akeneo.com/documentation/introduction.html"}, {"type"=>"x-email", "url"=>"unsubscribe@akeneo.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/akeneopim"}, {"type"=>"x-developer", "url"=>"https://api.akeneo.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
sugarsync{"sugar-sync--api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"SugarSync", "x-complete"=>1, "info"=>{"title"=>"Sugar Sync API", "description"=>"the-sugarsync-service-presents-a-set-of-resources-that-your-application-can-access-through-the-platform-api--", "version"=>"1"}, "host"=>"api.sugarsync.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/album/"=>{"get"=>{"summary"=>"Retrieving Album Information", "description"=>"To retrieve information about an album, an application submits an HTTP GET request to then album resource that represents the album.", "operationId"=>"retrieving-album-information", "x-api-path-slug"=>"album-get", "parameters"=>[{"in"=>"query", "name"=>"max", "description"=>"Positive integer"}, {"in"=>"query", "name"=>"order", "description"=>"name, last_modified, size, or extension"}, {"in"=>"query", "name"=>"start", "description"=>"0 or positive integer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Album"]}}, "/app-authorization"=>{"post"=>{"summary"=>"Creating a Refresh Token", "description"=>"An application needs to be authorized to access a users SugarSync resources through the Platform API.nTo do that, the app needs to create a refresh token. When a user first runs the application, it creates a refresh tokennby submitting a POST request that includes the users credentials to the API.nIf the request is successful, the SugarSync service grants the application permission to access the users account and returns a refresh token.n", "operationId"=>"creating-a-refresh-token", "x-api-path-slug"=>"appauthorization-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Length", "description"=>"The length of the request body"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"The content type and character encoding of the response"}, {"in"=>"header", "name"=>"Host", "description"=>"The domain name of the server"}, {"in"=>"header", "name"=>"User-Agent", "description"=>"The client application implementing the network protocol for communication between the client and server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App", "Authorization"]}}, "/authorization"=>{"post"=>{"summary"=>"Creating an Access Token", "description"=>"An application needs to be authorized to access a users SugarSync resources through the Platform API. To do that,nthe app needs to create an access token, which allows the app to access files, folders,nand other resources within a users account. After the token is created, the app needs to specify it in the HTTP request header when it makes a request through the API to access a resource.", "operationId"=>"creating-an-access-token", "x-api-path-slug"=>"authorization-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Length", "description"=>"The length of the request body"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"The content type and character encoding of the response"}, {"in"=>"header", "name"=>"Host", "description"=>"The domain name of the server"}, {"in"=>"header", "name"=>"User-Agent", "description"=>"The client application implementing the network protocol for communication between the client and server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorization"]}}, "/contact/"=>{"get"=>{"summary"=>"Retrieving Contact Information", "description"=>"A contact represents another SugarSync user who has shared a folder or folders with this user.n To retrieve information about a contact, an application submits an HTTP GET request to then contact resource.", "operationId"=>"retrieving-contact-information", "x-api-path-slug"=>"contact-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/file"=>{"get"=>{"summary"=>"Retrieving File Data", "description"=>"To retrieve file data, an application submits an HTTP GET request to then file data resource that represents the data for the file.", "operationId"=>"retrieving-file-data", "x-api-path-slug"=>"file-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}, "put"=>{"summary"=>"Uploading File Data", "description"=>"An application can upload data to a file by issuing an HTTP PUT request to thenfile data resource that represents the data for the file.n", "operationId"=>"uploading-file-data", "x-api-path-slug"=>"file-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}}, "/file/"=>{"delete"=>{"summary"=>"Deleting a File", "description"=>"An application can permanently delete a file by issuing an HTTP DELETE request to the URL of thenfile resource.nIts a good idea to precede DELETE requests like this with a caution note in your applications user interface.n", "operationId"=>"deleting-a-file", "x-api-path-slug"=>"file-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}, "get"=>{"summary"=>"Retrieving File Information", "description"=>"To retrieve information about a file, an application submits an HTTP GET request to then file resource that represents the file.", "operationId"=>"retrieving-file-information", "x-api-path-slug"=>"file-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}, "post"=>{"summary"=>"Creating a New File Version", "description"=>"nAn application can create a new version of a file by submitting an HTTP POST request to the URL that represents the version history. The version history URL is returned in the <versions> element whenn retrieving information about a file.n", "operationId"=>"creating-a-new-file-version", "x-api-path-slug"=>"file-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}, "put"=>{"summary"=>"Updating File Information", "description"=>"An application can update various attributes of a file by issuing an HTTP PUT request to the URL thatnrepresents the file resource. In addition, the app needs to provide as input, XML that identifies the new attribute values for the file. Upon receiving the PUT request, the SugarSync service examines the input and updates any of the attributes that have been modified.", "operationId"=>"updating-file-information", "x-api-path-slug"=>"file-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The access token"}, {"in"=>"header", "name"=>"Content-Length", "description"=>"The length of the request body"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"The content type and character encoding of the response"}, {"in"=>"header", "name"=>"Host", "description"=>"The domain name of the server"}, {"in"=>"header", "name"=>"User-Agent", "description"=>"The client application implementing the network protocol for communication between the client and server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}}, "/folder"=>{"get"=>{"summary"=>"Retrieving Folder Information", "description"=>"To retrieve information about a folder, an application submits an HTTP GET request to then folder resource that represents the folder.", "operationId"=>"retrieving-folder-information", "x-api-path-slug"=>"folder-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folder"]}}, "/folder/"=>{"delete"=>{"summary"=>"Deleting a Folder", "description"=>"An application can permanantly delete a folder by issuing an HTTP DELETE request to the URL of thenfolder resource.nIts a good idea to precede DELETE requests like this with a caution note in your applications user interface.n", "operationId"=>"deleting-a-folder", "x-api-path-slug"=>"folder-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folder"]}, "get"=>{"summary"=>"Retrieving Folder Contents", "description"=>"To retrieve the contents of a folder, an application submits an HTTP GET request to the URLn that represents the folder contents.", "operationId"=>"retrieving-folder-contents", "x-api-path-slug"=>"folder-get", "parameters"=>[{"in"=>"query", "name"=>"max", "description"=>"Positive integer"}, {"in"=>"query", "name"=>"order", "description"=>"name, last_modified, size, or extension"}, {"in"=>"query", "name"=>"start", "description"=>"0 or positive integer"}, {"in"=>"query", "name"=>"type", "description"=>"folder or file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folder"]}, "post"=>{"summary"=>"Creating a Folder", "description"=>"An application can create a folder within another folder by issuing an HTTP POST request to the URL ofnthe containing folder resource.nIn addition, the application needs to provide as input, XML that identifies the display name of the folder to be created.nNote that an application can create a folder only within another folder, and not directly in a workspace.", "operationId"=>"creating-a-folder", "x-api-path-slug"=>"folder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The access token"}, {"in"=>"header", "name"=>"Content-Length", "description"=>"The length of the request body"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"The content type and character encoding of the response"}, {"in"=>"header", "name"=>"Host", "description"=>"The domain name of the server"}, {"in"=>"header", "name"=>"User-Agent", "description"=>"The client application implementing the network protocol for communication between the client and server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folder"]}, "put"=>{"summary"=>"Updating Folder Information", "description"=>"An application can update various attributes of a folder by issuing an HTTP PUT request to the URL thatnrepresents the folder resource. In addition, the app needs to provide as input, XML that identifies the new attribute values for the folder. Upon receiving the PUT request, the SugarSync service examines the input and updates any of the attributes that have been modified.", "operationId"=>"updating-folder-information", "x-api-path-slug"=>"folder-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The access token"}, {"in"=>"header", "name"=>"Content-Length", "description"=>"The length of the request body"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"The content type and character encoding of the response"}, {"in"=>"header", "name"=>"Host", "description"=>"The domain name of the server"}, {"in"=>"header", "name"=>"User-Agent", "description"=>"The client application implementing the network protocol for communication between the client and server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Folder"]}}, "/receivedShare/"=>{"get"=>{"summary"=>"Retrieving Received Share Information", "description"=>"To retrieve information about a received share (that is, a shared folder owned by another user and to whichnthis user has been granted access privileges by the owner), an application submits an HTTP GET request to the URLnthat represents the received share resource. The URL is referenced in the <receivedShare> element for the received share in the received shares list.nSee Retrieving the Received Shares List.", "operationId"=>"retrieving-received-share-information", "x-api-path-slug"=>"receivedshare-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ReceivedShare"]}}, "/user"=>{"get"=>{"summary"=>"Retrieving User Information", "description"=>"To retrieve information about a SugarSync user, an application submits an HTTP GET request to thenuser resource that represents the user.", "operationId"=>"retrieving-user-information", "x-api-path-slug"=>"user-get", "parameters"=>[{"in"=>"query", "name"=>"max", "description"=>"The maximum number of workspaces, beginning with the workspace at the start index, that the clienttt wants listed in the response"}, {"in"=>"query", "name"=>"start", "description"=>"Specifies the index within the indexed sequence of workspaces in the users account where thett client wants workspaces to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/user/"=>{"get"=>{"summary"=>"Retrieving Received Shares List", "description"=>"One of the elements in the representation of a user resource isn<receivedShares>.nThe element contains a link to a list that describes the shared folders that are owned by other users and to which this user has been granted access privileges by those owners. For example:nnn<?xml version=1.0 encoding=UTF-8?>n<user>n ...n <receivedShares>https://api.sugarsync.com/user/5664947/receivedShares/contents</receivedShares>n ...n</user>nnn To retrieve the list, an application submits an HTTP GET request to the link in the <receivedShares>nelement.nn Requestnn URLn The URL that represents the received shares list.", "operationId"=>"retrieving-received-shares-list", "x-api-path-slug"=>"user-get", "parameters"=>[{"in"=>"query", "name"=>"max", "description"=>"The maximum number of albums, beginning with the album at the start index, that the clienttt wants listed in the response"}, {"in"=>"query", "name"=>"start", "description"=>"Specifies the index within the indexed sequence of albums in the users account where thett client wants albums to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/workspace"=>{"get"=>{"summary"=>"Retrieving Workspace Information", "description"=>"To retrieve information about a workspace, an application submits an HTTP GET request to then workspace resource that represents the workspace.", "operationId"=>"retrieving-workspace-information", "x-api-path-slug"=>"workspace-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspace"]}}, "/workspace/"=>{"get"=>{"summary"=>"Retrieving Workspace Contents", "description"=>"To retrieve the contents of a workspace, an application submits an HTTP GET request to the URLn that represents the workspace contents. Note that the contents of a workspace are the sync folders that are mappedntt to that workspace in SugarSync.", "operationId"=>"retrieving-workspace-contents", "x-api-path-slug"=>"workspace-get", "parameters"=>[{"in"=>"query", "name"=>"max", "description"=>"Positive integer"}, {"in"=>"query", "name"=>"order", "description"=>"name, last_modified, size, or extension"}, {"in"=>"query", "name"=>"start", "description"=>"0 or positive integer"}, {"in"=>"query", "name"=>"type", "description"=>"Must be specified with a value of folder when retrieving folders from a parent folder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspace"]}, "put"=>{"summary"=>"Updating Workspace Information", "description"=>"An application can update attributes of a workspace by issuing an HTTP PUT request to the URL that representsnthe workspace resource. In addition, the app needs to provide as input, XML that identifies the new attribute values for the workspace.nUpon receiving the PUT request, the SugarSync service examines the input and updates any of the attributes that have been modified.", "operationId"=>"updating-workspace-information", "x-api-path-slug"=>"workspace-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"The access token"}, {"in"=>"header", "name"=>"Content-Length", "description"=>"The length of the request body"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"The content type and character encoding of the response"}, {"in"=>"header", "name"=>"Host", "description"=>"The domain name of the server"}, {"in"=>"header", "name"=>"User-Agent", "description"=>"The client application implementing the network protocol for communication between the client and server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspace"]}}}}, "apis"=>{"name"=>"SugarSync", "x-slug"=>"sugarsync", "description"=>"SugarSync is a cloud file sharing, file sync and online backup service that is simple, powerful and easy to use. Unlike Dropbox, SugarSync enables you to back up your existing folder structure. Try it for FREE for 30 days and get started today!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/488-sugarsync-.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"64898", "tags"=>"Backups,Cloud,File,Getting Started Example,internet,Mobile,Relative Data,Relative StreamRank,SaaS,Service API,Stack Network,Storage,Storage,Storage,Streams,Streams,Streams,Target,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"sugarsync/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Sugar Sync API", "x-api-slug"=>"sugar-sync--api", "description"=>"SugarSync is a cloud file sharing, file sync and online backup service that is simple, powerful and easy to use. Unlike Dropbox, SugarSync enables you to back up your existing folder structure. Try it for FREE for 30 days and get started today!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/488-sugarsync-.jpg", "humanURL"=>"http://sugarsync.com", "baseURL"=>"https://api.sugarsync.com//", "tags"=>"Backups,Cloud,File,Getting Started Example,internet,Mobile,Relative Data,Relative StreamRank,SaaS,Service API,Stack Network,Storage,Storage,Storage,Streams,Streams,Streams,Target,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/sugarsync/workspace-put-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/sugarsync/sugar-sync--api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-application-gallery", "url"=>"https://www.sugarsync.com/partners/"}, {"type"=>"x-base", "url"=>"https://api.sugarsync.com"}, {"type"=>"x-best-practices", "url"=>"https://www.sugarsync.com/dev/best-practices.html"}, {"type"=>"x-blog", "url"=>"http://www.sugarsync.com/blog"}, {"type"=>"x-blog-rss", "url"=>"http://blog.sugarsync.com/blog/feed"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/sugarsync"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/sugarsync"}, {"type"=>"x-developer", "url"=>"https://www.sugarsync.com/developer"}, {"type"=>"x-forum", "url"=>"https://groups.google.com/a/developers.sugarsync.com/forum/#!forum/platform-api/join"}, {"type"=>"x-getting-started", "url"=>"https://www.sugarsync.com/dev/getting-started.html"}, {"type"=>"x-glossary", "url"=>"https://www.sugarsync.com/dev/glossary.html"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/sugarsync"}, {"type"=>"x-pricing", "url"=>"https://www.sugarsync.com/"}, {"type"=>"x-selfservice-registration", "url"=>"https://www.sugarsync.com/developer/signup"}, {"type"=>"x-terms-of-service", "url"=>"https://www.sugarsync.com/dev/terms.html"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/SugarSync"}, {"type"=>"x-website", "url"=>"http://sugarsync.com"}, {"type"=>"x-website", "url"=>"http://www.sugarsync.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-devtest-labs{"azure-devtest-labs-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure DevTest Labs", "x-complete"=>1, "info"=>{"title"=>"DevTestLabsClient", "description"=>"the-devtest-labs-client-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/labs"=>{"get"=>{"summary"=>"Labs List By Subscription", "description"=>"List labs in a subscription.", "operationId"=>"Labs_ListBySubscription", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-devtestlablabs-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labs"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/schedules"=>{"get"=>{"summary"=>"Global Schedules List By Subscription", "description"=>"List schedules in a subscription.", "operationId"=>"GlobalSchedules_ListBySubscription", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-devtestlabschedules-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global Schedules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs"=>{"get"=>{"summary"=>"Labs List By Resource Group", "description"=>"List labs in a resource group.", "operationId"=>"Labs_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabs-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources"=>{"get"=>{"summary"=>"Artifact Sources List", "description"=>"List artifact sources in a given lab.", "operationId"=>"ArtifactSources_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameartifactsources-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Artifact Sources"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/armtemplates"=>{"get"=>{"summary"=>"Arm Templates List", "description"=>"List azure resource manager templates in a given artifact source.", "operationId"=>"ArmTemplates_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameartifactsourcesartifactsourcenamearmtemplates-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"artifactSourceName", "description"=>"The name of the artifact source"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ARM Templates"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/armtemplates/{name}"=>{"get"=>{"summary"=>"Arm Templates Get", "description"=>"Get azure resource manager template.", "operationId"=>"ArmTemplates_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameartifactsourcesartifactsourcenamearmtemplatesname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"artifactSourceName", "description"=>"The name of the artifact source"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the azure Resource Manager template"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ARM Templates"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts"=>{"get"=>{"summary"=>"Artifacts List", "description"=>"List artifacts in a given artifact source.", "operationId"=>"Artifacts_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameartifactsourcesartifactsourcenameartifacts-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"artifactSourceName", "description"=>"The name of the artifact source"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Artifacts"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts/{name}"=>{"get"=>{"summary"=>"Artifacts Get", "description"=>"Get artifact.", "operationId"=>"Artifacts_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameartifactsourcesartifactsourcenameartifactsname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"artifactSourceName", "description"=>"The name of the artifact source"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the artifact"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Artifacts"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts/{name}/generateArmTemplate"=>{"post"=>{"summary"=>"Artifacts Generate Arm Template", "description"=>"Generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact.", "operationId"=>"Artifacts_GenerateArmTemplate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameartifactsourcesartifactsourcenameartifactsnamegeneratearmtemplate-post", "parameters"=>[{"in"=>"path", "name"=>"artifactSourceName", "description"=>"The name of the artifact source"}, {"in"=>"body", "name"=>"generateArmTemplateRequest", "description"=>"Parameters for generating an ARM template for deploying artifacts", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the artifact"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Artifacts"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}"=>{"get"=>{"summary"=>"Artifact Sources Get", "description"=>"Get artifact source.", "operationId"=>"ArtifactSources_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameartifactsourcesname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the artifact source"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Artifact Sources"]}, "put"=>{"summary"=>"Artifact Sources Create Or Update", "description"=>"Create or replace an existing artifact source.", "operationId"=>"ArtifactSources_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameartifactsourcesname-put", "parameters"=>[{"in"=>"body", "name"=>"artifactSource", "description"=>"Properties of an artifact source", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the artifact source"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Artifact Sources"]}, "delete"=>{"summary"=>"Artifact Sources Delete", "description"=>"Delete artifact source.", "operationId"=>"ArtifactSources_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameartifactsourcesname-delete", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the artifact source"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Artifact Sources"]}, "patch"=>{"summary"=>"Artifact Sources Update", "description"=>"Modify properties of artifact sources.", "operationId"=>"ArtifactSources_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameartifactsourcesname-patch", "parameters"=>[{"in"=>"body", "name"=>"artifactSource", "description"=>"Properties of an artifact source", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the artifact source"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Artifact Sources"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costs/{name}"=>{"get"=>{"summary"=>"Costs Get", "description"=>"Get cost.", "operationId"=>"Costs_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamecostsname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the cost"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Costs"]}, "put"=>{"summary"=>"Costs Create Or Update", "description"=>"Create or replace an existing cost.", "operationId"=>"Costs_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamecostsname-put", "parameters"=>[{"in"=>"body", "name"=>"labCost", "description"=>"A cost item", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the cost"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Costs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages"=>{"get"=>{"summary"=>"Custom Images List", "description"=>"List custom images in a given lab.", "operationId"=>"CustomImages_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamecustomimages-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom Images"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}"=>{"get"=>{"summary"=>"Custom Images Get", "description"=>"Get custom image.", "operationId"=>"CustomImages_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamecustomimagesname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the custom image"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom Images"]}, "put"=>{"summary"=>"Custom Images Create Or Update", "description"=>"Create or replace an existing custom image. This operation can take a while to complete.", "operationId"=>"CustomImages_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamecustomimagesname-put", "parameters"=>[{"in"=>"body", "name"=>"customImage", "description"=>"A custom image", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the custom image"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom Images"]}, "delete"=>{"summary"=>"Custom Images Delete", "description"=>"Delete custom image. This operation can take a while to complete.", "operationId"=>"CustomImages_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamecustomimagesname-delete", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the custom image"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom Images"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas"=>{"get"=>{"summary"=>"Formulas List", "description"=>"List formulas in a given lab.", "operationId"=>"Formulas_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameformulas-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Formulas"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}"=>{"get"=>{"summary"=>"Formulas Get", "description"=>"Get formula.", "operationId"=>"Formulas_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameformulasname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the formula"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Formulas"]}, "put"=>{"summary"=>"Formulas Create Or Update", "description"=>"Create or replace an existing Formula. This operation can take a while to complete.", "operationId"=>"Formulas_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameformulasname-put", "parameters"=>[{"in"=>"body", "name"=>"formula", "description"=>"A formula for creating a VM, specifying an image base and other parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the formula"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Formulas"]}, "delete"=>{"summary"=>"Formulas Delete", "description"=>"Delete formula.", "operationId"=>"Formulas_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameformulasname-delete", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the formula"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Formulas"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/galleryimages"=>{"get"=>{"summary"=>"Gallery Images List", "description"=>"List gallery images in a given lab.", "operationId"=>"GalleryImages_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamegalleryimages-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gallery Images"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels"=>{"get"=>{"summary"=>"Notification Channels List", "description"=>"List notificationchannels in a given lab.", "operationId"=>"NotificationChannels_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamenotificationchannels-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Channels"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}"=>{"get"=>{"summary"=>"Notification Channels Get", "description"=>"Get notificationchannel.", "operationId"=>"NotificationChannels_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamenotificationchannelsname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the notificationChannel"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Channels"]}, "put"=>{"summary"=>"Notification Channels Create Or Update", "description"=>"Create or replace an existing notificationChannel.", "operationId"=>"NotificationChannels_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamenotificationchannelsname-put", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the notificationChannel"}, {"in"=>"body", "name"=>"notificationChannel", "description"=>"A notification", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Channels"]}, "delete"=>{"summary"=>"Notification Channels Delete", "description"=>"Delete notificationchannel.", "operationId"=>"NotificationChannels_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamenotificationchannelsname-delete", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the notificationChannel"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Channels"]}, "patch"=>{"summary"=>"Notification Channels Update", "description"=>"Modify properties of notificationchannels.", "operationId"=>"NotificationChannels_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamenotificationchannelsname-patch", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the notificationChannel"}, {"in"=>"body", "name"=>"notificationChannel", "description"=>"A notification", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Channels"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}/notify"=>{"post"=>{"summary"=>"Notification Channels Notify", "description"=>"Send notification to provided channel.", "operationId"=>"NotificationChannels_Notify", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamenotificationchannelsnamenotify-post", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the notificationChannel"}, {"in"=>"body", "name"=>"notifyParameters", "description"=>"Properties for generating a Notification", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification Channels"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{name}/evaluatePolicies"=>{"post"=>{"summary"=>"Policy Sets Evaluate Policies", "description"=>"Evaluates lab policy.", "operationId"=>"PolicySets_EvaluatePolicies", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamepolicysetsnameevaluatepolicies-post", "parameters"=>[{"in"=>"body", "name"=>"evaluatePoliciesRequest", "description"=>"Request body for evaluating a policy set", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the policy set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies"=>{"get"=>{"summary"=>"Policies List", "description"=>"List policies in a given policy set.", "operationId"=>"Policies_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamepolicysetspolicysetnamepolicies-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"policySetName", "description"=>"The name of the policy set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}"=>{"get"=>{"summary"=>"Policies Get", "description"=>"Get policy.", "operationId"=>"Policies_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamepolicysetspolicysetnamepoliciesname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the policy"}, {"in"=>"path", "name"=>"policySetName", "description"=>"The name of the policy set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}, "put"=>{"summary"=>"Policies Create Or Update", "description"=>"Create or replace an existing policy.", "operationId"=>"Policies_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamepolicysetspolicysetnamepoliciesname-put", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the policy"}, {"in"=>"body", "name"=>"policy", "description"=>"A Policy", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"policySetName", "description"=>"The name of the policy set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}, "delete"=>{"summary"=>"Policies Delete", "description"=>"Delete policy.", "operationId"=>"Policies_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamepolicysetspolicysetnamepoliciesname-delete", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the policy"}, {"in"=>"path", "name"=>"policySetName", "description"=>"The name of the policy set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}, "patch"=>{"summary"=>"Policies Update", "description"=>"Modify properties of policies.", "operationId"=>"Policies_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamepolicysetspolicysetnamepoliciesname-patch", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the policy"}, {"in"=>"body", "name"=>"policy", "description"=>"A Policy", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"policySetName", "description"=>"The name of the policy set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules"=>{"get"=>{"summary"=>"Schedules List", "description"=>"List schedules in a given lab.", "operationId"=>"Schedules_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameschedules-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}"=>{"get"=>{"summary"=>"Schedules Get", "description"=>"Get schedule.", "operationId"=>"Schedules_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameschedulesname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedules"]}, "put"=>{"summary"=>"Schedules Create Or Update", "description"=>"Create or replace an existing schedule.", "operationId"=>"Schedules_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameschedulesname-put", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}, {"in"=>"body", "name"=>"schedule", "description"=>"A schedule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedules"]}, "delete"=>{"summary"=>"Schedules Delete", "description"=>"Delete schedule.", "operationId"=>"Schedules_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameschedulesname-delete", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedules"]}, "patch"=>{"summary"=>"Schedules Update", "description"=>"Modify properties of schedules.", "operationId"=>"Schedules_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameschedulesname-patch", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}, {"in"=>"body", "name"=>"schedule", "description"=>"A schedule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}/execute"=>{"post"=>{"summary"=>"Schedules Execute", "description"=>"Execute a schedule. This operation can take a while to complete.", "operationId"=>"Schedules_Execute", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameschedulesnameexecute-post", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}/listApplicable"=>{"post"=>{"summary"=>"Schedules List Applicable", "description"=>"Lists all applicable schedules", "operationId"=>"Schedules_ListApplicable", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameschedulesnamelistapplicable-post", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/servicerunners"=>{"get"=>{"summary"=>"Service Runners List", "description"=>"List service runners in a given lab.", "operationId"=>"ServiceRunners_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameservicerunners-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Runners"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/servicerunners/{name}"=>{"get"=>{"summary"=>"Service Runners Get", "description"=>"Get service runner.", "operationId"=>"ServiceRunners_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameservicerunnersname-get", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the service runner"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Runners"]}, "put"=>{"summary"=>"Service Runners Create Or Update", "description"=>"Create or replace an existing Service runner.", "operationId"=>"ServiceRunners_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameservicerunnersname-put", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the service runner"}, {"in"=>"body", "name"=>"serviceRunner", "description"=>"A container for a managed identity to execute DevTest lab services", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Runners"]}, "delete"=>{"summary"=>"Service Runners Delete", "description"=>"Delete service runner.", "operationId"=>"ServiceRunners_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameservicerunnersname-delete", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the service runner"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Runners"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users"=>{"get"=>{"summary"=>"Users List", "description"=>"List user profiles in a given lab.", "operationId"=>"Users_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusers-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}"=>{"get"=>{"summary"=>"Users Get", "description"=>"Get user profile.", "operationId"=>"Users_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the user profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "put"=>{"summary"=>"Users Create Or Update", "description"=>"Create or replace an existing user profile.", "operationId"=>"Users_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersname-put", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the user profile"}, {"in"=>"body", "name"=>"user", "description"=>"Profile of a lab user", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "delete"=>{"summary"=>"Users Delete", "description"=>"Delete user profile. This operation can take a while to complete.", "operationId"=>"Users_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersname-delete", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the user profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "patch"=>{"summary"=>"Users Update", "description"=>"Modify properties of user profiles.", "operationId"=>"Users_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersname-patch", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the user profile"}, {"in"=>"body", "name"=>"user", "description"=>"Profile of a lab user", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks"=>{"get"=>{"summary"=>"Disks List", "description"=>"List disks in a given user profile.", "operationId"=>"Disks_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersusernamedisks-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"userName", "description"=>"The name of the user profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disks"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}"=>{"get"=>{"summary"=>"Disks Get", "description"=>"Get disk.", "operationId"=>"Disks_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersusernamedisksname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the disk"}, {"in"=>"path", "name"=>"userName", "description"=>"The name of the user profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disks"]}, "put"=>{"summary"=>"Disks Create Or Update", "description"=>"Create or replace an existing disk. This operation can take a while to complete.", "operationId"=>"Disks_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersusernamedisksname-put", "parameters"=>[{"in"=>"body", "name"=>"disk", "description"=>"A Disk", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the disk"}, {"in"=>"path", "name"=>"userName", "description"=>"The name of the user profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disks"]}, "delete"=>{"summary"=>"Disks Delete", "description"=>"Delete disk. This operation can take a while to complete.", "operationId"=>"Disks_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersusernamedisksname-delete", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the disk"}, {"in"=>"path", "name"=>"userName", "description"=>"The name of the user profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disks"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}/attach"=>{"post"=>{"summary"=>"Disks Attach", "description"=>"Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.", "operationId"=>"Disks_Attach", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersusernamedisksnameattach-post", "parameters"=>[{"in"=>"body", "name"=>"attachDiskProperties", "description"=>"Properties of the disk to attach", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the disk"}, {"in"=>"path", "name"=>"userName", "description"=>"The name of the user profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disks"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}/detach"=>{"post"=>{"summary"=>"Disks Detach", "description"=>"Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.", "operationId"=>"Disks_Detach", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersusernamedisksnamedetach-post", "parameters"=>[{"in"=>"body", "name"=>"detachDiskProperties", "description"=>"Properties of the disk to detach", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the disk"}, {"in"=>"path", "name"=>"userName", "description"=>"The name of the user profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disks"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments"=>{"get"=>{"summary"=>"Environments List", "description"=>"List environments in a given user profile.", "operationId"=>"Environments_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersusernameenvironments-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"userName", "description"=>"The name of the user profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}"=>{"get"=>{"summary"=>"Environments Get", "description"=>"Get environment.", "operationId"=>"Environments_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersusernameenvironmentsname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the environment"}, {"in"=>"path", "name"=>"userName", "description"=>"The name of the user profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}, "put"=>{"summary"=>"Environments Create Or Update", "description"=>"Create or replace an existing environment. This operation can take a while to complete.", "operationId"=>"Environments_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersusernameenvironmentsname-put", "parameters"=>[{"in"=>"body", "name"=>"dtlEnvironment", "description"=>"An environment, which is essentially an ARM template deployment", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the environment"}, {"in"=>"path", "name"=>"userName", "description"=>"The name of the user profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}, "delete"=>{"summary"=>"Environments Delete", "description"=>"Delete environment. This operation can take a while to complete.", "operationId"=>"Environments_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersusernameenvironmentsname-delete", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the environment"}, {"in"=>"path", "name"=>"userName", "description"=>"The name of the user profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets"=>{"get"=>{"summary"=>"Secrets List", "description"=>"List secrets in a given user profile.", "operationId"=>"Secrets_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersusernamesecrets-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"userName", "description"=>"The name of the user profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Secrets"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}"=>{"get"=>{"summary"=>"Secrets Get", "description"=>"Get secret.", "operationId"=>"Secrets_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersusernamesecretsname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the secret"}, {"in"=>"path", "name"=>"userName", "description"=>"The name of the user profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Secrets"]}, "put"=>{"summary"=>"Secrets Create Or Update", "description"=>"Create or replace an existing secret.", "operationId"=>"Secrets_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersusernamesecretsname-put", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the secret"}, {"in"=>"body", "name"=>"secret", "description"=>"A secret", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userName", "description"=>"The name of the user profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Secrets"]}, "delete"=>{"summary"=>"Secrets Delete", "description"=>"Delete secret.", "operationId"=>"Secrets_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnameusersusernamesecretsname-delete", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the secret"}, {"in"=>"path", "name"=>"userName", "description"=>"The name of the user profile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Secrets"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines"=>{"get"=>{"summary"=>"Virtual Machines List", "description"=>"List virtual machines in a given lab.", "operationId"=>"VirtualMachines_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachines-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machines"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}"=>{"get"=>{"summary"=>"Virtual Machines Get", "description"=>"Get virtual machine.", "operationId"=>"VirtualMachines_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machines"]}, "put"=>{"summary"=>"Virtual Machines Create Or Update", "description"=>"Create or replace an existing Virtual machine. This operation can take a while to complete.", "operationId"=>"VirtualMachines_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesname-put", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"body", "name"=>"labVirtualMachine", "description"=>"A virtual machine", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machines"]}, "delete"=>{"summary"=>"Virtual Machines Delete", "description"=>"Delete virtual machine. This operation can take a while to complete.", "operationId"=>"VirtualMachines_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesname-delete", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machines"]}, "patch"=>{"summary"=>"Virtual Machines Update", "description"=>"Modify properties of virtual machines.", "operationId"=>"VirtualMachines_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesname-patch", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"body", "name"=>"labVirtualMachine", "description"=>"A virtual machine", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machines"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/addDataDisk"=>{"post"=>{"summary"=>"Virtual Machines Add Data Disk", "description"=>"Attach a new or existing data disk to virtual machine. This operation can take a while to complete.", "operationId"=>"VirtualMachines_AddDataDisk", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesnameadddatadisk-post", "parameters"=>[{"in"=>"body", "name"=>"dataDiskProperties", "description"=>"Request body for adding a new or existing data disk to a virtual machine", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machines"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/applyArtifacts"=>{"post"=>{"summary"=>"Virtual Machines Apply Artifacts", "description"=>"Apply artifacts to virtual machine. This operation can take a while to complete.", "operationId"=>"VirtualMachines_ApplyArtifacts", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesnameapplyartifacts-post", "parameters"=>[{"in"=>"body", "name"=>"applyArtifactsRequest", "description"=>"Request body for applying artifacts to a virtual machine", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machines"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/claim"=>{"post"=>{"summary"=>"Virtual Machines Claim", "description"=>"Take ownership of an existing virtual machine This operation can take a while to complete.", "operationId"=>"VirtualMachines_Claim", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesnameclaim-post", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machines"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/detachDataDisk"=>{"post"=>{"summary"=>"Virtual Machines Detach Data Disk", "description"=>"Detach the specified disk from the virtual machine. This operation can take a while to complete.", "operationId"=>"VirtualMachines_DetachDataDisk", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesnamedetachdatadisk-post", "parameters"=>[{"in"=>"body", "name"=>"detachDataDiskProperties", "description"=>"Request body for detaching data disk from a virtual machine", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machines"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/listApplicableSchedules"=>{"post"=>{"summary"=>"Virtual Machines List Applicable Schedules", "description"=>"Lists all applicable schedules", "operationId"=>"VirtualMachines_ListApplicableSchedules", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesnamelistapplicableschedules-post", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machines"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/start"=>{"post"=>{"summary"=>"Virtual Machines Start", "description"=>"Start a virtual machine. This operation can take a while to complete.", "operationId"=>"VirtualMachines_Start", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesnamestart-post", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machines"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/stop"=>{"post"=>{"summary"=>"Virtual Machines Stop", "description"=>"Stop a virtual machine This operation can take a while to complete.", "operationId"=>"VirtualMachines_Stop", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesnamestop-post", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machines"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules"=>{"get"=>{"summary"=>"Virtual Machine Schedules List", "description"=>"List schedules in a given virtual machine.", "operationId"=>"VirtualMachineSchedules_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesvirtualmachinenameschedules-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"virtualMachineName", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machine Schedules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}"=>{"get"=>{"summary"=>"Virtual Machine Schedules Get", "description"=>"Get schedule.", "operationId"=>"VirtualMachineSchedules_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesvirtualmachinenameschedulesname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}, {"in"=>"path", "name"=>"virtualMachineName", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machine Schedules"]}, "put"=>{"summary"=>"Virtual Machine Schedules Create Or Update", "description"=>"Create or replace an existing schedule.", "operationId"=>"VirtualMachineSchedules_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesvirtualmachinenameschedulesname-put", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}, {"in"=>"body", "name"=>"schedule", "description"=>"A schedule", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"virtualMachineName", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machine Schedules"]}, "delete"=>{"summary"=>"Virtual Machine Schedules Delete", "description"=>"Delete schedule.", "operationId"=>"VirtualMachineSchedules_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesvirtualmachinenameschedulesname-delete", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}, {"in"=>"path", "name"=>"virtualMachineName", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machine Schedules"]}, "patch"=>{"summary"=>"Virtual Machine Schedules Update", "description"=>"Modify properties of schedules.", "operationId"=>"VirtualMachineSchedules_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesvirtualmachinenameschedulesname-patch", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}, {"in"=>"body", "name"=>"schedule", "description"=>"A schedule", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"virtualMachineName", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machine Schedules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}/execute"=>{"post"=>{"summary"=>"Virtual Machine Schedules Execute", "description"=>"Execute a schedule. This operation can take a while to complete.", "operationId"=>"VirtualMachineSchedules_Execute", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualmachinesvirtualmachinenameschedulesnameexecute-post", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}, {"in"=>"path", "name"=>"virtualMachineName", "description"=>"The name of the virtual machine"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Machine Schedules Execute"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks"=>{"get"=>{"summary"=>"Virtual Networks List", "description"=>"List virtual networks in a given lab.", "operationId"=>"VirtualNetworks_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualnetworks-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Networks"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}"=>{"get"=>{"summary"=>"Virtual Networks Get", "description"=>"Get virtual network.", "operationId"=>"VirtualNetworks_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualnetworksname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the virtual network"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Networks"]}, "put"=>{"summary"=>"Virtual Networks Create Or Update", "description"=>"Create or replace an existing virtual network. This operation can take a while to complete.", "operationId"=>"VirtualNetworks_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualnetworksname-put", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the virtual network"}, {"in"=>"body", "name"=>"virtualNetwork", "description"=>"A virtual network", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Networks"]}, "delete"=>{"summary"=>"Virtual Networks Delete", "description"=>"Delete virtual network. This operation can take a while to complete.", "operationId"=>"VirtualNetworks_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualnetworksname-delete", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the virtual network"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Networks"]}, "patch"=>{"summary"=>"Virtual Networks Update", "description"=>"Modify properties of virtual networks.", "operationId"=>"VirtualNetworks_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabslabnamevirtualnetworksname-patch", "parameters"=>[{"in"=>"path", "name"=>"labName", "description"=>"The name of the lab"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the virtual network"}, {"in"=>"body", "name"=>"virtualNetwork", "description"=>"A virtual network", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Virtual Networks"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}"=>{"get"=>{"summary"=>"Labs Get", "description"=>"Get lab.", "operationId"=>"Labs_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabsname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labs"]}, "put"=>{"summary"=>"Labs Create Or Update", "description"=>"Create or replace an existing lab. This operation can take a while to complete.", "operationId"=>"Labs_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabsname-put", "parameters"=>[{"in"=>"body", "name"=>"lab", "description"=>"A lab", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labs"]}, "delete"=>{"summary"=>"Labs Delete", "description"=>"Delete lab. This operation can take a while to complete.", "operationId"=>"Labs_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabsname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labs"]}, "patch"=>{"summary"=>"Labs Update", "description"=>"Modify properties of labs.", "operationId"=>"Labs_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabsname-patch", "parameters"=>[{"in"=>"body", "name"=>"lab", "description"=>"A lab", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/claimAnyVm"=>{"post"=>{"summary"=>"Labs Claim Any Vm", "description"=>"Claim a random claimable virtual machine in the lab. This operation can take a while to complete.", "operationId"=>"Labs_ClaimAnyVm", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabsnameclaimanyvm-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/createEnvironment"=>{"post"=>{"summary"=>"Labs Create Environment", "description"=>"Create virtual machines in a lab. This operation can take a while to complete.", "operationId"=>"Labs_CreateEnvironment", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabsnamecreateenvironment-post", "parameters"=>[{"in"=>"body", "name"=>"labVirtualMachineCreationParameter", "description"=>"Properties for creating a virtual machine", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labs Environment"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/exportResourceUsage"=>{"post"=>{"summary"=>"Labs Export Resource Usage", "description"=>"Exports the lab resource usage into a storage account This operation can take a while to complete.", "operationId"=>"Labs_ExportResourceUsage", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabsnameexportresourceusage-post", "parameters"=>[{"in"=>"body", "name"=>"exportResourceUsageParameters", "description"=>"The parameters of the export operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labs Export"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/generateUploadUri"=>{"post"=>{"summary"=>"Labs Generate Upload Uri", "description"=>"Generate a URI for uploading custom disk images to a Lab.", "operationId"=>"Labs_GenerateUploadUri", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabsnamegenerateuploaduri-post", "parameters"=>[{"in"=>"body", "name"=>"generateUploadUriParameter", "description"=>"Properties for generating an upload URI", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/listVhds"=>{"post"=>{"summary"=>"Labs List Vhds", "description"=>"List disk images available for custom image creation.", "operationId"=>"Labs_ListVhds", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlablabsnamelistvhds-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the lab"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labs Vhds"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules"=>{"get"=>{"summary"=>"Global Schedules List By Resource Group", "description"=>"List schedules in a resource group.", "operationId"=>"GlobalSchedules_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlabschedules-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the operation"}, {"in"=>"query", "name"=>"$orderby", "description"=>"The ordering expression for the results, using OData notation"}, {"in"=>"query", "name"=>"$top", "description"=>"The maximum number of resources to return from the operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global Schedules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}"=>{"get"=>{"summary"=>"Global Schedules Get", "description"=>"Get schedule.", "operationId"=>"GlobalSchedules_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlabschedulesname-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"Specify the $expand query"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global Schedules"]}, "put"=>{"summary"=>"Global Schedules Create Or Update", "description"=>"Create or replace an existing schedule.", "operationId"=>"GlobalSchedules_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlabschedulesname-put", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}, {"in"=>"body", "name"=>"schedule", "description"=>"A schedule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global Schedules"]}, "delete"=>{"summary"=>"Global Schedules Delete", "description"=>"Delete schedule.", "operationId"=>"GlobalSchedules_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlabschedulesname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global Schedules"]}, "patch"=>{"summary"=>"Global Schedules Update", "description"=>"Modify properties of schedules.", "operationId"=>"GlobalSchedules_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlabschedulesname-patch", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}, {"in"=>"body", "name"=>"schedule", "description"=>"A schedule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global Schedules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}/execute"=>{"post"=>{"summary"=>"Global Schedules Execute", "description"=>"Execute a schedule. This operation can take a while to complete.", "operationId"=>"GlobalSchedules_Execute", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlabschedulesnameexecute-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global Schedules"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}/retarget"=>{"post"=>{"summary"=>"Global Schedules Retarget", "description"=>"Updates a schedule's target resource Id. This operation can take a while to complete.", "operationId"=>"GlobalSchedules_Retarget", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-devtestlabschedulesnameretarget-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the schedule"}, {"in"=>"body", "name"=>"retargetScheduleProperties", "description"=>"Properties for retargeting a virtual machine schedule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global Schedules"]}}}}, "apis"=>{"name"=>"Azure DevTest Labs", "x-slug"=>"azure-devtest-labs", "description"=>"Azure DevTest Labs makes it easy to quickly create environments to deploy and test applications. Use reusable templates and artifacts to build Windows and Linux environments while minimalizing waste and controlling costs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-devtest-integrate.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Microsoft,Orchestration,Profiles,Relative Data,Service API,Stack Network,Testing", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-devtest-labs/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure DevTest Labs API", "x-api-slug"=>"azure-devtest-labs-api", "description"=>"Azure DevTest Labs makes it easy to quickly create environments to deploy and test applications. Use reusable templates and artifacts to build Windows and Linux environments while minimalizing waste and controlling costs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-devtest-integrate.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/devtest-lab/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Microsoft,Orchestration,Profiles,Relative Data,Service API,Stack Network,Testing", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/azure-devtest-labs/azure-devtest-labs-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/devtest-lab/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/devtest-lab/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/devtest-lab/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/devtest-lab/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
rat-genome-database{"rat-genome-database-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Rat Genome Database", "x-complete"=>1, "info"=>{"title"=>"Rat Genome Database", "description"=>"the-rgd-rest-api-provides-programmatic-access-to-information-and-annotation-stored-in-the-rat-genome-database", "termsOfService"=>"http://rgd.mcw.edu/wg/citing-rgd", "contact"=>{"name"=>"Rat Genome Database", "url"=>"http://rgd.mcw.edu", "email"=>"RGD.Data2@mcw.edu"}, "version"=>"1.1"}, "host"=>"rest.rgd.mcw.edu", "basePath"=>"/rgdws", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/annotations/accId/{rgdId}"=>{"get"=>{"summary"=>"Returns a list ontology term accession IDs annotated to an rgd object", "description"=>"", "operationId"=>"getTermAccIdsUsingGET", "x-api-path-slug"=>"annotationsaccidrgdid-get", "parameters"=>[{"in"=>"path", "name"=>"rgdId", "description"=>"RGD ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/annotations/count/{accId}/{includeChildren}"=>{"get"=>{"summary"=>"Returns annotation count for ontology accession ID", "description"=>"", "operationId"=>"getAnnotationCountByAccIdUsingGET", "x-api-path-slug"=>"annotationscountaccidincludechildren-get", "parameters"=>[{"in"=>"path", "name"=>"accId", "description"=>"Ontology term accession ID"}, {"in"=>"path", "name"=>"includeChildren", "description"=>"true: return annotations for the term and children, false: return annotations for the term only"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/annotations/count/{accId}/{speciesTypeKey}/{includeChildren}"=>{"get"=>{"summary"=>"Returns annotation count for ontology accession ID and speicies", "description"=>"", "operationId"=>"getAnnotationCountByAccIdAndSpeciesUsingGET", "x-api-path-slug"=>"annotationscountaccidspeciestypekeyincludechildren-get", "parameters"=>[{"in"=>"path", "name"=>"accId", "description"=>"Ontology term accession ID"}, {"in"=>"path", "name"=>"includeChildren", "description"=>"true: return annotations for the term and children, false: return annotations for the term only"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"A list of species type keys can be found using the lookup service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/annotations/count/{accId}/{speciesTypeKey}/{includeChildren}/{objectType}"=>{"get"=>{"summary"=>"Returns annotation count for ontology accession ID and object type", "description"=>"", "operationId"=>"getAnnotationCountByAccIdAndObjectTypeUsingGET", "x-api-path-slug"=>"annotationscountaccidspeciestypekeyincludechildrenobjecttype-get", "parameters"=>[{"in"=>"path", "name"=>"accId", "description"=>"Ontology term accession ID"}, {"in"=>"path", "name"=>"includeChildren", "description"=>"true: return annotations for the term and children, false: return annotations for the term only"}, {"in"=>"path", "name"=>"objectType", "description"=>"A list of object types can be found using the lookup service"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"A list of species type keys can be found using the lookup service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/annotations/reference/{refRgdId}"=>{"get"=>{"summary"=>"Returns a list of annotations for a reference", "description"=>"", "operationId"=>"getAnnotsByRefrerenceUsingGET", "x-api-path-slug"=>"annotationsreferencerefrgdid-get", "parameters"=>[{"in"=>"path", "name"=>"refRgdId", "description"=>"Reference RGD ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/annotations/rgdId/{rgdId}"=>{"get"=>{"summary"=>"Returns a list of annotations by RGD ID", "description"=>"", "operationId"=>"getAnnotationsByRgdIdUsingGET", "x-api-path-slug"=>"annotationsrgdidrgdid-get", "parameters"=>[{"in"=>"path", "name"=>"rgdId", "description"=>"RGD ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/annotations/rgdId/{rgdId}/{ontologyPrefix}"=>{"get"=>{"summary"=>"Returns a list of annotations by RGD ID and ontology prefix", "description"=>"", "operationId"=>"getAnnotationsByRgdIdAndOntologyUsingGET", "x-api-path-slug"=>"annotationsrgdidrgdidontologyprefix-get", "parameters"=>[{"in"=>"path", "name"=>"ontologyPrefix", "description"=>"Ontology Prefix"}, {"in"=>"path", "name"=>"rgdId", "description"=>"RGD ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/annotations/{accId}/{rgdId}"=>{"get"=>{"summary"=>"Returns a list of annotations by RGD ID and ontology term accession ID", "description"=>"", "operationId"=>"getAnnotationsByAccIdAndRgdIdUsingGET", "x-api-path-slug"=>"annotationsaccidrgdid-get", "parameters"=>[{"in"=>"path", "name"=>"accId", "description"=>"Ontology Term Accession ID"}, {"in"=>"path", "name"=>"rgdId", "description"=>"RGD ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/annotations/{accId}/{speciesTypeKey}/{includeChildren}"=>{"get"=>{"summary"=>"Returns a list annotations for an ontology term or a term and it's children", "description"=>"", "operationId"=>"getAnnotationsUsingGET", "x-api-path-slug"=>"annotationsaccidspeciestypekeyincludechildren-get", "parameters"=>[{"in"=>"path", "name"=>"accId", "description"=>"Ontology term accession ID"}, {"in"=>"path", "name"=>"includeChildren", "description"=>"true: return annotations for the term and children, false: return annotations for the term only"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"A list of species type keys can be found using the lookup service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/genes/affyId/{affyId}/{speciesTypeKey}"=>{"get"=>{"summary"=>"Return a list of genes for an affymetrix ID", "description"=>"", "operationId"=>"getGenesByAffyIdUsingGET", "x-api-path-slug"=>"genesaffyidaffyidspeciestypekey-get", "parameters"=>[{"in"=>"path", "name"=>"affyId", "description"=>"Affymetrix ID"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"A list of RGD species type keys can be found in the lookup service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/genes/alias/{aliasSymbol}/{speciesTypeKey}"=>{"get"=>{"summary"=>"Return a list of genes for an alias and species", "description"=>"", "operationId"=>"getGenesByAliasSymbolUsingGET", "x-api-path-slug"=>"genesaliasaliassymbolspeciestypekey-get", "parameters"=>[{"in"=>"path", "name"=>"aliasSymbol", "description"=>"Gene alias symbol"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"A list of RGD species type keys can be found in the lookup service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/genes/allele/{rgdId}"=>{"get"=>{"summary"=>"Return a list of gene alleles", "description"=>"", "operationId"=>"getGeneAllelesUsingGET", "x-api-path-slug"=>"genesallelergdid-get", "parameters"=>[{"in"=>"path", "name"=>"rgdId", "description"=>"RGD ID of gene"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/genes/annotation/{accId}/{speciesTypeKey}"=>{"get"=>{"summary"=>"Return a list of genes annotated to an ontology term", "description"=>"", "operationId"=>"getGenesAnnotatedUsingGET", "x-api-path-slug"=>"genesannotationaccidspeciestypekey-get", "parameters"=>[{"in"=>"path", "name"=>"accId", "description"=>"Ontology term accession ID"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"Species type key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/genes/keyword/{keyword}/{speciesTypeKey}"=>{"get"=>{"summary"=>"Return a list of genes by keyword and species type key", "description"=>"", "operationId"=>"getGenesByKeywordUsingGET", "x-api-path-slug"=>"geneskeywordkeywordspeciestypekey-get", "parameters"=>[{"in"=>"path", "name"=>"keyword", "description"=>"Search keyword"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"Species type key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/genes/map/{mapKey}"=>{"get"=>{"summary"=>"Return a list of all genes with position information for an assembly", "description"=>"", "operationId"=>"getGeneByMapKeyUsingGET", "x-api-path-slug"=>"genesmapmapkey-get", "parameters"=>[{"in"=>"path", "name"=>"mapKey", "description"=>"A list of RGD assembly map keys can be found in the lookup service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/genes/ortholog/{rgdId}"=>{"get"=>{"summary"=>"Return a list of gene orthologs", "description"=>"", "operationId"=>"getGeneOrthologsUsingGET", "x-api-path-slug"=>"genesorthologrgdid-get", "parameters"=>[{"in"=>"path", "name"=>"rgdId", "description"=>"RGD ID of a gene"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/genes/species/{speciesTypeKey}"=>{"get"=>{"summary"=>"Return a list of all genes for a species in RGD", "description"=>"", "operationId"=>"getGenesBySpeciesUsingGET", "x-api-path-slug"=>"genesspeciesspeciestypekey-get", "parameters"=>[{"in"=>"path", "name"=>"speciesTypeKey", "description"=>"A list of RGD species type keys can be found in the lookup service"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/genes/{chr}/{start}/{stop}/{mapKey}"=>{"get"=>{"summary"=>"Return a list of genes position and map key", "description"=>"", "operationId"=>"getGenesByPositionUsingGET", "x-api-path-slug"=>"geneschrstartstopmapkey-get", "parameters"=>[{"in"=>"path", "name"=>"chr", "description"=>"Chromosome"}, {"in"=>"path", "name"=>"mapKey", "description"=>"A list of RGD assembly map keys can be found in the lookup service"}, {"in"=>"path", "name"=>"start", "description"=>"Start Position"}, {"in"=>"path", "name"=>"stop", "description"=>"Stop Position"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/genes/{rgdId}"=>{"get"=>{"summary"=>"Get a gene record by RGD ID", "description"=>"", "operationId"=>"getGeneByRgdIdUsingGET", "x-api-path-slug"=>"genesrgdid-get", "parameters"=>[{"in"=>"path", "name"=>"rgdId", "description"=>"The RGD ID of a Gene in RGD"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/genes/{symbol}/{speciesTypeKey}"=>{"get"=>{"summary"=>"Get a gene record by symbol and species type key", "description"=>"", "operationId"=>"getGeneBySymbolUsingGET", "x-api-path-slug"=>"genessymbolspeciestypekey-get", "parameters"=>[{"in"=>"path", "name"=>"speciesTypeKey", "description"=>"Species type key"}, {"in"=>"path", "name"=>"symbol", "description"=>"Gene Symbol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/lookup/geneTypes"=>{"get"=>{"summary"=>"Returns a list of gene types avialable in RGD", "description"=>"", "operationId"=>"getGeneTypesUsingGET", "x-api-path-slug"=>"lookupgenetypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/lookup/maps/{speciesTypeKey}"=>{"get"=>{"summary"=>"Return a list assembly maps for a species", "description"=>"", "operationId"=>"getMapsUsingGET", "x-api-path-slug"=>"lookupmapsspeciestypekey-get", "parameters"=>[{"in"=>"path", "name"=>"speciesTypeKey", "description"=>"RGD species type key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/lookup/speciesTypeKeys"=>{"get"=>{"summary"=>"Return a Map of species type keys available in RGD", "description"=>"", "operationId"=>"getSpeciesTypesUsingGET", "x-api-path-slug"=>"lookupspeciestypekeys-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/pathways/diagrams/search/{searchString}"=>{"get"=>{"summary"=>"Return a list of pathways based on search term", "description"=>"", "operationId"=>"searchPathwaysUsingGET", "x-api-path-slug"=>"pathwaysdiagramssearchsearchstring-get", "parameters"=>[{"in"=>"path", "name"=>"searchString", "description"=>"Free text search string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/pathways/diagramsForCategory/{category}"=>{"get"=>{"summary"=>"Return a list of pathways based on category provided", "description"=>"", "operationId"=>"getPathwaysWithDiagramsForCategoryUsingGET", "x-api-path-slug"=>"pathwaysdiagramsforcategorycategory-get", "parameters"=>[{"in"=>"path", "name"=>"category", "description"=>"Pathway Category"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/phenotype/phenominer/chart/{speciesTypeKey}/{termString}"=>{"get"=>{"summary"=>"Return a list of pathways based on search term and species type. 3=rat 4=chinchilla", "description"=>"", "operationId"=>"getChartInfoUsingGET", "x-api-path-slug"=>"phenotypephenominerchartspeciestypekeytermstring-get", "parameters"=>[{"in"=>"path", "name"=>"speciesTypeKey", "description"=>"Species Type Key - 3=rat 4=chinchilla"}, {"in"=>"path", "name"=>"termString", "description"=>"List of term accession IDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/qtls/{chr}/{start}/{stop}/{mapKey}"=>{"get"=>{"summary"=>"Returns a list QTL for given position and assembly map", "description"=>"", "operationId"=>"getQtlListByPositionUsingGET", "x-api-path-slug"=>"qtlschrstartstopmapkey-get", "parameters"=>[{"in"=>"path", "name"=>"chr", "description"=>"Chromosome"}, {"in"=>"path", "name"=>"mapKey", "description"=>"A list of assembly map keys can be found using the lookup service"}, {"in"=>"path", "name"=>"start", "description"=>"Start Position"}, {"in"=>"path", "name"=>"stop", "description"=>"Stop Position"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/qtls/{rgdId}"=>{"get"=>{"summary"=>"Return a QTL for provided RGD ID", "description"=>"", "operationId"=>"getQTLByRgdIdUsingGET", "x-api-path-slug"=>"qtlsrgdid-get", "parameters"=>[{"in"=>"path", "name"=>"rgdId", "description"=>"RGD ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/count/activeObject/{speciesTypeKey}/{dateYYYYMMDD}"=>{"get"=>{"summary"=>"Count of active objects by type, for specified species and date", "description"=>"", "operationId"=>"getActiveObjectCountUsingGET", "x-api-path-slug"=>"statscountactiveobjectspeciestypekeydateyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateYYYYMMDD", "description"=>"dateYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/count/geneType/{speciesTypeKey}/{dateYYYYMMDD}"=>{"get"=>{"summary"=>"Count of gene types, for specified species and date", "description"=>"", "operationId"=>"getGeneTypeCountUsingGET", "x-api-path-slug"=>"statscountgenetypespeciestypekeydateyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateYYYYMMDD", "description"=>"dateYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/count/objectStatus/{speciesTypeKey}/{dateYYYYMMDD}"=>{"get"=>{"summary"=>"Count of objects with given status, for specified species and date", "description"=>"", "operationId"=>"getObjectStatusCountUsingGET", "x-api-path-slug"=>"statscountobjectstatusspeciestypekeydateyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateYYYYMMDD", "description"=>"dateYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/count/objectWithRefSeq/{speciesTypeKey}/{dateYYYYMMDD}"=>{"get"=>{"summary"=>"Count of objects with reference sequence(s), by object type, for specified species and date", "description"=>"", "operationId"=>"getObjectsWithRefSeqCountUsingGET", "x-api-path-slug"=>"statscountobjectwithrefseqspeciestypekeydateyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateYYYYMMDD", "description"=>"dateYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/count/objectWithReference/{speciesTypeKey}/{dateYYYYMMDD}"=>{"get"=>{"summary"=>"Count of objects with reference, by object type, for specified species and date", "description"=>"", "operationId"=>"getObjectsWithReferenceCountUsingGET", "x-api-path-slug"=>"statscountobjectwithreferencespeciestypekeydateyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateYYYYMMDD", "description"=>"dateYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/count/objectWithXdb/{speciesTypeKey}/{objectKey}/{dateYYYYMMDD}"=>{"get"=>{"summary"=>"Count of objects with external database ids, by database id, for specified species, object type and date", "description"=>"", "operationId"=>"getObjectsWithXDBsCountUsingGET", "x-api-path-slug"=>"statscountobjectwithxdbspeciestypekeyobjectkeydateyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateYYYYMMDD", "description"=>"dateYYYYMMDD"}, {"in"=>"path", "name"=>"objectKey", "description"=>"objectKey"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/count/proteinInteraction/{speciesTypeKey}/{dateYYYYMMDD}"=>{"get"=>{"summary"=>"Count of protein interactions, for specified species and date", "description"=>"", "operationId"=>"getProteinInteractionCountUsingGET", "x-api-path-slug"=>"statscountproteininteractionspeciestypekeydateyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateYYYYMMDD", "description"=>"dateYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/count/qtlInheritanceType/{speciesTypeKey}/{dateYYYYMMDD}"=>{"get"=>{"summary"=>"Count of strains, by qtl inheritance type, for specified species and date", "description"=>"", "operationId"=>"getQtlInheritanceTypeCountUsingGET", "x-api-path-slug"=>"statscountqtlinheritancetypespeciestypekeydateyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateYYYYMMDD", "description"=>"dateYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/count/retiredObject/{speciesTypeKey}/{dateYYYYMMDD}"=>{"get"=>{"summary"=>"Count of retired objects by type, for specified species and date", "description"=>"", "operationId"=>"getRetiredObjectCountUsingGET", "x-api-path-slug"=>"statscountretiredobjectspeciestypekeydateyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateYYYYMMDD", "description"=>"dateYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/count/strainType/{speciesTypeKey}/{dateYYYYMMDD}"=>{"get"=>{"summary"=>"Count of strain types, for specified species and date", "description"=>"", "operationId"=>"getStrainTypeCountUsingGET", "x-api-path-slug"=>"statscountstraintypespeciestypekeydateyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateYYYYMMDD", "description"=>"dateYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/count/withdrawnObject/{speciesTypeKey}/{dateYYYYMMDD}"=>{"get"=>{"summary"=>"Count of withdrawn objects by type, for specified species and date", "description"=>"", "operationId"=>"getWithdrawnObjectCountUsingGET", "x-api-path-slug"=>"statscountwithdrawnobjectspeciestypekeydateyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateYYYYMMDD", "description"=>"dateYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/count/xdb/{speciesTypeKey}/{dateYYYYMMDD}"=>{"get"=>{"summary"=>"Count of external database ids, for specied species and date", "description"=>"", "operationId"=>"getXdbsCountUsingGET", "x-api-path-slug"=>"statscountxdbspeciestypekeydateyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateYYYYMMDD", "description"=>"dateYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/diff/activeObject/{speciesTypeKey}/{dateFromYYYYMMDD}/{dateToYYYYMMDD}"=>{"get"=>{"summary"=>"Count difference of active objects, by type, for specified species and date range", "description"=>"", "operationId"=>"getActiveObjectDiffUsingGET", "x-api-path-slug"=>"statsdiffactiveobjectspeciestypekeydatefromyyyymmdddatetoyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateFromYYYYMMDD", "description"=>"dateFromYYYYMMDD"}, {"in"=>"path", "name"=>"dateToYYYYMMDD", "description"=>"dateToYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/diff/geneType/{speciesTypeKey}/{dateFromYYYYMMDD}/{dateToYYYYMMDD}"=>{"get"=>{"summary"=>"Count difference of gene types, for specified species and date range", "description"=>"", "operationId"=>"getGeneTypeDiffUsingGET", "x-api-path-slug"=>"statsdiffgenetypespeciestypekeydatefromyyyymmdddatetoyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateFromYYYYMMDD", "description"=>"dateFromYYYYMMDD"}, {"in"=>"path", "name"=>"dateToYYYYMMDD", "description"=>"dateToYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/diff/objectStatus/{speciesTypeKey}/{dateFromYYYYMMDD}/{dateToYYYYMMDD}"=>{"get"=>{"summary"=>"Count difference of objects with given status, for specified species and date range", "description"=>"", "operationId"=>"getObjectStatusDiffUsingGET", "x-api-path-slug"=>"statsdiffobjectstatusspeciestypekeydatefromyyyymmdddatetoyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateFromYYYYMMDD", "description"=>"dateFromYYYYMMDD"}, {"in"=>"path", "name"=>"dateToYYYYMMDD", "description"=>"dateToYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/diff/objectWithRefSeq/{speciesTypeKey}/{dateFromYYYYMMDD}/{dateToYYYYMMDD}"=>{"get"=>{"summary"=>"Count difference of objects with reference sequence(s), by object type, for specified species and date range", "description"=>"", "operationId"=>"getObjectsWithRefSeqDiffUsingGET", "x-api-path-slug"=>"statsdiffobjectwithrefseqspeciestypekeydatefromyyyymmdddatetoyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateFromYYYYMMDD", "description"=>"dateFromYYYYMMDD"}, {"in"=>"path", "name"=>"dateToYYYYMMDD", "description"=>"dateToYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/diff/objectWithReference/{speciesTypeKey}/{dateFromYYYYMMDD}/{dateToYYYYMMDD}"=>{"get"=>{"summary"=>"Count difference of objects with reference, by object type, for specified species and date range", "description"=>"", "operationId"=>"getObjectsWithReferenceDiffUsingGET", "x-api-path-slug"=>"statsdiffobjectwithreferencespeciestypekeydatefromyyyymmdddatetoyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateFromYYYYMMDD", "description"=>"dateFromYYYYMMDD"}, {"in"=>"path", "name"=>"dateToYYYYMMDD", "description"=>"dateToYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/diff/objectWithXdb/{speciesTypeKey}/{objectKey}/{dateFromYYYYMMDD}/{dateToYYYYMMDD}"=>{"get"=>{"summary"=>"Count difference of objects with external database ids, by database id, for specified species, object type and date range", "description"=>"", "operationId"=>"getObjectsWithXDBsDiffUsingGET", "x-api-path-slug"=>"statsdiffobjectwithxdbspeciestypekeyobjectkeydatefromyyyymmdddatetoyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateFromYYYYMMDD", "description"=>"dateFromYYYYMMDD"}, {"in"=>"path", "name"=>"dateToYYYYMMDD", "description"=>"dateToYYYYMMDD"}, {"in"=>"path", "name"=>"objectKey", "description"=>"objectKey"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/diff/proteinInteraction/{speciesTypeKey}/{dateFromYYYYMMDD}/{dateToYYYYMMDD}"=>{"get"=>{"summary"=>"Count difference of protein interactions, for specified species and date range", "description"=>"", "operationId"=>"getProteinInteractionDiffUsingGET", "x-api-path-slug"=>"statsdiffproteininteractionspeciestypekeydatefromyyyymmdddatetoyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateFromYYYYMMDD", "description"=>"dateFromYYYYMMDD"}, {"in"=>"path", "name"=>"dateToYYYYMMDD", "description"=>"dateToYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/diff/qtlInheritanceType/{speciesTypeKey}/{dateFromYYYYMMDD}/{dateToYYYYMMDD}"=>{"get"=>{"summary"=>"Count difference of strains, by qtl inheritance type, for specified species and date range", "description"=>"", "operationId"=>"getQtlInheritanceTypeDiffUsingGET", "x-api-path-slug"=>"statsdiffqtlinheritancetypespeciestypekeydatefromyyyymmdddatetoyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateFromYYYYMMDD", "description"=>"dateFromYYYYMMDD"}, {"in"=>"path", "name"=>"dateToYYYYMMDD", "description"=>"dateToYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/diff/retiredObject/{speciesTypeKey}/{dateFromYYYYMMDD}/{dateToYYYYMMDD}"=>{"get"=>{"summary"=>"Count difference of retired objects, by type, for specified species and date range", "description"=>"", "operationId"=>"getRetiredObjectDiffUsingGET", "x-api-path-slug"=>"statsdiffretiredobjectspeciestypekeydatefromyyyymmdddatetoyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateFromYYYYMMDD", "description"=>"dateFromYYYYMMDD"}, {"in"=>"path", "name"=>"dateToYYYYMMDD", "description"=>"dateToYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/diff/strainType/{speciesTypeKey}/{dateFromYYYYMMDD}/{dateToYYYYMMDD}"=>{"get"=>{"summary"=>"Count difference of strain types, for specified species and date range", "description"=>"", "operationId"=>"getStrainTypeDiffUsingGET", "x-api-path-slug"=>"statsdiffstraintypespeciestypekeydatefromyyyymmdddatetoyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateFromYYYYMMDD", "description"=>"dateFromYYYYMMDD"}, {"in"=>"path", "name"=>"dateToYYYYMMDD", "description"=>"dateToYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/diff/withdrawnObject/{speciesTypeKey}/{dateFromYYYYMMDD}/{dateToYYYYMMDD}"=>{"get"=>{"summary"=>"Count difference of withdrawn objects, by type, for specified species and date range", "description"=>"", "operationId"=>"getWithdrawnObjectDiffUsingGET", "x-api-path-slug"=>"statsdiffwithdrawnobjectspeciestypekeydatefromyyyymmdddatetoyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateFromYYYYMMDD", "description"=>"dateFromYYYYMMDD"}, {"in"=>"path", "name"=>"dateToYYYYMMDD", "description"=>"dateToYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/diff/xdb/{speciesTypeKey}/{dateFromYYYYMMDD}/{dateToYYYYMMDD}"=>{"get"=>{"summary"=>"Count difference of external database ids, for specified species and date range", "description"=>"", "operationId"=>"getXdbsDiffUsingGET", "x-api-path-slug"=>"statsdiffxdbspeciestypekeydatefromyyyymmdddatetoyyyymmdd-get", "parameters"=>[{"in"=>"path", "name"=>"dateFromYYYYMMDD", "description"=>"dateFromYYYYMMDD"}, {"in"=>"path", "name"=>"dateToYYYYMMDD", "description"=>"dateToYYYYMMDD"}, {"in"=>"path", "name"=>"speciesTypeKey", "description"=>"speciesTypeKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/stats/term/{accId}/{filterAccId}"=>{"get"=>{"summary"=>"getTermStats", "description"=>"", "operationId"=>"getTermStatsUsingGET", "x-api-path-slug"=>"statstermaccidfilteraccid-get", "parameters"=>[{"in"=>"path", "name"=>"accId", "description"=>"accId"}, {"in"=>"path", "name"=>"filterAccId", "description"=>"filterAccId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/strains/all"=>{"get"=>{"summary"=>"Return all active strains in RGD", "description"=>"", "operationId"=>"getAllStrainsUsingGET", "x-api-path-slug"=>"strainsall-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/strains/{chr}/{start}/{stop}/{mapKey}"=>{"get"=>{"summary"=>"Return all active strains by position", "description"=>"", "operationId"=>"getStrainsByPositionUsingGET", "x-api-path-slug"=>"strainschrstartstopmapkey-get", "parameters"=>[{"in"=>"path", "name"=>"chr", "description"=>"Chromosome"}, {"in"=>"path", "name"=>"mapKey", "description"=>"RGD Map Key (available through lookup service)"}, {"in"=>"path", "name"=>"start", "description"=>"Start Position"}, {"in"=>"path", "name"=>"stop", "description"=>"Stop Position"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/strains/{rgdId}"=>{"get"=>{"summary"=>"Return a strain by RGD ID", "description"=>"", "operationId"=>"getStrainByRgdIdUsingGET", "x-api-path-slug"=>"strainsrgdid-get", "parameters"=>[{"in"=>"path", "name"=>"rgdId", "description"=>"RGD ID of the strain"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"Rat Genome Database", "x-slug"=>"rat-genome-database", "description"=>"", "image"=>"", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"General Data,Science", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"rat-genome-database/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Rat Genome Database", "x-api-slug"=>"rat-genome-database", "description"=>"", "image"=>"", "humanURL"=>"http://rest.rgd.mcw.edu", "baseURL"=>"https://rest.rgd.mcw.edu//rgdws", "tags"=>"General Data,Science", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/rat-genome-database/strainsrgdid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/rat-genome-database/rat-genome-database-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://rest.rgd.mcw.edu"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-play{"google-play-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Play", "x-complete"=>1, "info"=>{"title"=>"Google Play", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{packageName}/edits"=>{"post"=>{"summary"=>"Create App Edit", "description"=>"Creates a new edit for an app, populated with the app's current state.", "operationId"=>"androidpublisher.edits.insert", "x-api-path-slug"=>"packagenameedits-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}}, "/{packageName}/edits/{editId}"=>{"delete"=>{"summary"=>"Delete App Edit", "description"=>"Deletes an edit for an app. Creating a new edit will automatically delete any of your previous edits so this method need only be called if you want to preemptively abandon an edit.", "operationId"=>"androidpublisher.edits.delete", "x-api-path-slug"=>"packagenameeditseditid-delete", "parameters"=>[{"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}, "get"=>{"summary"=>"DGetelete App Edit", "description"=>"Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired).", "operationId"=>"androidpublisher.edits.get", "x-api-path-slug"=>"packagenameeditseditid-get", "parameters"=>[{"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}}, "/{packageName}/edits/{editId}/apks/externallyHosted"=>{"post"=>{"summary"=>"Create APK", "description"=>"Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to enterprises using Google Play for Work whose application is configured to restrict distribution to the enterprise domain.", "operationId"=>"androidpublisher.edits.apks.addexternallyhosted", "x-api-path-slug"=>"packagenameeditseditidapksexternallyhosted-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}}, "/{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}"=>{"post"=>{"summary"=>"Update Deobfuscation FIle", "description"=>"Uploads the deobfuscation file of the specified APK. If a deobfuscation file already exists, it will be replaced.", "operationId"=>"androidpublisher.edits.deobfuscationfiles.upload", "x-api-path-slug"=>"packagenameeditseditidapksapkversioncodedeobfuscationfilesdeobfuscationfiletype-post", "parameters"=>[{"in"=>"path", "name"=>"apkVersionCode", "description"=>"The version code of the APK whose deobfuscation file is being uploaded"}, {"in"=>"path", "name"=>"deobfuscationFileType"}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier of the Android app for which the deobfuscatiuon files are being uploaded; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deobfuscation FIle"]}}, "/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}"=>{"get"=>{"summary"=>"Get Expansion File", "description"=>"Fetches the Expansion File configuration for the APK specified.", "operationId"=>"androidpublisher.edits.expansionfiles.get", "x-api-path-slug"=>"packagenameeditseditidapksapkversioncodeexpansionfilesexpansionfiletype-get", "parameters"=>[{"in"=>"path", "name"=>"apkVersionCode", "description"=>"The version code of the APK whose Expansion File configuration is being read or modified"}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"expansionFileType"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Expansion File"]}, "patch"=>{"summary"=>"Update APK Expansion File", "description"=>"Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method. This method supports patch semantics.", "operationId"=>"androidpublisher.edits.expansionfiles.patch", "x-api-path-slug"=>"packagenameeditseditidapksapkversioncodeexpansionfilesexpansionfiletype-patch", "parameters"=>[{"in"=>"path", "name"=>"apkVersionCode", "description"=>"The version code of the APK whose Expansion File configuration is being read or modified"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"expansionFileType"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APK Expansion File"]}, "post"=>{"summary"=>"Upload APK Expansion File", "description"=>"Uploads and attaches a new Expansion File to the APK specified.", "operationId"=>"androidpublisher.edits.expansionfiles.upload", "x-api-path-slug"=>"packagenameeditseditidapksapkversioncodeexpansionfilesexpansionfiletype-post", "parameters"=>[{"in"=>"path", "name"=>"apkVersionCode", "description"=>"The version code of the APK whose Expansion File configuration is being read or modified"}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"expansionFileType"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APK Expansion File"]}, "put"=>{"summary"=>"Update APK Expansion File", "description"=>"Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method.", "operationId"=>"androidpublisher.edits.expansionfiles.update", "x-api-path-slug"=>"packagenameeditseditidapksapkversioncodeexpansionfilesexpansionfiletype-put", "parameters"=>[{"in"=>"path", "name"=>"apkVersionCode", "description"=>"The version code of the APK whose Expansion File configuration is being read or modified"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"expansionFileType"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APK Expansion File"]}}, "/{packageName}/edits/{editId}/apks/{apkVersionCode}/listings"=>{"delete"=>{"summary"=>"Delete All APK Localized Listing", "description"=>"Deletes all the APK-specific localized listings for a specified APK.", "operationId"=>"androidpublisher.edits.apklistings.deleteall", "x-api-path-slug"=>"packagenameeditseditidapksapkversioncodelistings-delete", "parameters"=>[{"in"=>"path", "name"=>"apkVersionCode", "description"=>"The APK version code whose APK-specific listings should be read or modified"}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APK Localized Listing"]}, "get"=>{"summary"=>"Get APK Localized Listings", "description"=>"Lists all the APK-specific localized listings for a specified APK.", "operationId"=>"androidpublisher.edits.apklistings.list", "x-api-path-slug"=>"packagenameeditseditidapksapkversioncodelistings-get", "parameters"=>[{"in"=>"path", "name"=>"apkVersionCode", "description"=>"The APK version code whose APK-specific listings should be read or modified"}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APK Localized Listing"]}}, "/{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}"=>{"delete"=>{"summary"=>"Delete APK Localized Listing", "description"=>"Deletes the APK-specific localized listing for a specified APK and language code.", "operationId"=>"androidpublisher.edits.apklistings.delete", "x-api-path-slug"=>"packagenameeditseditidapksapkversioncodelistingslanguage-delete", "parameters"=>[{"in"=>"path", "name"=>"apkVersionCode", "description"=>"The APK version code whose APK-specific listings should be read or modified"}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"language", "description"=>"The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APK Localized Listing"]}, "get"=>{"summary"=>"Get APK Localized Listing", "description"=>"Fetches the APK-specific localized listing for a specified APK and language code.", "operationId"=>"androidpublisher.edits.apklistings.get", "x-api-path-slug"=>"packagenameeditseditidapksapkversioncodelistingslanguage-get", "parameters"=>[{"in"=>"path", "name"=>"apkVersionCode", "description"=>"The APK version code whose APK-specific listings should be read or modified"}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"language", "description"=>"The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APK Localized Listing"]}, "patch"=>{"summary"=>"Update APK Localized Listing", "description"=>"Updates or creates the APK-specific localized listing for a specified APK and language code. This method supports patch semantics.", "operationId"=>"androidpublisher.edits.apklistings.patch", "x-api-path-slug"=>"packagenameeditseditidapksapkversioncodelistingslanguage-patch", "parameters"=>[{"in"=>"path", "name"=>"apkVersionCode", "description"=>"The APK version code whose APK-specific listings should be read or modified"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"language", "description"=>"The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APK Localized Listing"]}, "put"=>{"summary"=>"Update APK Localized Listing", "description"=>"Updates or creates the APK-specific localized listing for a specified APK and language code.", "operationId"=>"androidpublisher.edits.apklistings.update", "x-api-path-slug"=>"packagenameeditseditidapksapkversioncodelistingslanguage-put", "parameters"=>[{"in"=>"path", "name"=>"apkVersionCode", "description"=>"The APK version code whose APK-specific listings should be read or modified"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"language", "description"=>"The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APK Localized Listing"]}}, "/{packageName}/edits/{editId}/details"=>{"get"=>{"summary"=>"Get App Detail", "description"=>"Fetches app details for this edit. This includes the default language and developer support contact information.", "operationId"=>"androidpublisher.edits.details.get", "x-api-path-slug"=>"packagenameeditseditiddetails-get", "parameters"=>[{"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}, "patch"=>{"summary"=>"Update App Detail", "description"=>"Updates app details for this edit. This method supports patch semantics.", "operationId"=>"androidpublisher.edits.details.patch", "x-api-path-slug"=>"packagenameeditseditiddetails-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}, "put"=>{"summary"=>"Update App Detail", "description"=>"Updates app details for this edit.", "operationId"=>"androidpublisher.edits.details.update", "x-api-path-slug"=>"packagenameeditseditiddetails-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}}, "/{packageName}/edits/{editId}/listings"=>{"delete"=>{"summary"=>"Delete App Detail", "description"=>"Deletes all localized listings from an edit.", "operationId"=>"androidpublisher.edits.listings.deleteall", "x-api-path-slug"=>"packagenameeditseditidlistings-delete", "parameters"=>[{"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}, "get"=>{"summary"=>"Get App Details", "description"=>"Returns all of the localized store listings attached to this edit.", "operationId"=>"androidpublisher.edits.listings.list", "x-api-path-slug"=>"packagenameeditseditidlistings-get", "parameters"=>[{"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}}, "/{packageName}/edits/{editId}/listings/{language}"=>{"delete"=>{"summary"=>"Delete Localized Store Listing", "description"=>"Deletes the specified localized store listing from an edit.", "operationId"=>"androidpublisher.edits.listings.delete", "x-api-path-slug"=>"packagenameeditseditidlistingslanguage-delete", "parameters"=>[{"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"language", "description"=>"The language code (a BCP-47 language tag) of the localized listing to read or modify"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Localized Store Listing"]}, "get"=>{"summary"=>"Get Localized Store Listing", "description"=>"Fetches information about a localized store listing.", "operationId"=>"androidpublisher.edits.listings.get", "x-api-path-slug"=>"packagenameeditseditidlistingslanguage-get", "parameters"=>[{"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"language", "description"=>"The language code (a BCP-47 language tag) of the localized listing to read or modify"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Localized Store Listing"]}, "patch"=>{"summary"=>"Update Localized Store Listing", "description"=>"Creates or updates a localized store listing. This method supports patch semantics.", "operationId"=>"androidpublisher.edits.listings.patch", "x-api-path-slug"=>"packagenameeditseditidlistingslanguage-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"language", "description"=>"The language code (a BCP-47 language tag) of the localized listing to read or modify"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Localized Store Listing"]}, "put"=>{"summary"=>"Update Localized Store Listing", "description"=>"Creates or updates a localized store listing.", "operationId"=>"androidpublisher.edits.listings.update", "x-api-path-slug"=>"packagenameeditseditidlistingslanguage-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"language", "description"=>"The language code (a BCP-47 language tag) of the localized listing to read or modify"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Localized Store Listing"]}}, "/{packageName}/edits/{editId}/listings/{language}/{imageType}"=>{"delete"=>{"summary"=>"Delete All Images", "description"=>"Deletes all images for the specified language and image type.", "operationId"=>"androidpublisher.edits.images.deleteall", "x-api-path-slug"=>"packagenameeditseditidlistingslanguageimagetype-delete", "parameters"=>[{"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"imageType"}, {"in"=>"path", "name"=>"language", "description"=>"The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image"]}, "get"=>{"summary"=>"Get All Images", "description"=>"Lists all images for the specified language and image type.", "operationId"=>"androidpublisher.edits.images.list", "x-api-path-slug"=>"packagenameeditseditidlistingslanguageimagetype-get", "parameters"=>[{"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"imageType"}, {"in"=>"path", "name"=>"language", "description"=>"The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image"]}, "post"=>{"summary"=>"Upoads Image", "description"=>"Uploads a new image and adds it to the list of images for the specified language and image type.", "operationId"=>"androidpublisher.edits.images.upload", "x-api-path-slug"=>"packagenameeditseditidlistingslanguageimagetype-post", "parameters"=>[{"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"imageType"}, {"in"=>"path", "name"=>"language", "description"=>"The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image"]}}, "/enterprises"=>{"get"=>{"summary"=>"Get Enterprises", "description"=>"Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call.", "operationId"=>"androidenterprise.enterprises.list", "x-api-path-slug"=>"enterprises-get", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"The exact primary domain name of the enterprise to look up"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Enterprise"]}, "post"=>{"summary"=>"Create Enterprise", "description"=>"Establishes the binding between the EMM and an enterprise. This is now deprecated; use enroll instead.", "operationId"=>"androidenterprise.enterprises.insert", "x-api-path-slug"=>"enterprises-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"token", "description"=>"The token provided by the enterprise to register the EMM"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Enterprise"]}}, "/enterprises/acknowledgeNotificationSet"=>{"post"=>{"summary"=>"Create Acknowledges Notification Set", "description"=>"Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.", "operationId"=>"androidenterprise.enterprises.acknowledgeNotificationSet", "x-api-path-slug"=>"enterprisesacknowledgenotificationset-post", "parameters"=>[{"in"=>"query", "name"=>"notificationSetId", "description"=>"The notification set ID as returned by Enterprises"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification"]}}, "/enterprises/completeSignup"=>{"post"=>{"summary"=>"Complete Signup Flow", "description"=>"Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.", "operationId"=>"androidenterprise.enterprises.completeSignup", "x-api-path-slug"=>"enterprisescompletesignup-post", "parameters"=>[{"in"=>"query", "name"=>"completionToken", "description"=>"The Completion token initially returned by GenerateSignupUrl"}, {"in"=>"query", "name"=>"enterpriseToken", "description"=>"The Enterprise token appended to the Callback URL"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signup"]}}, "/{packageName}/edits/{editId}/listings/{language}/{imageType}/{imageId}"=>{"delete"=>{"summary"=>"Delete Image", "description"=>"Deletes the image (specified by id) from the edit.", "operationId"=>"androidpublisher.edits.images.delete", "x-api-path-slug"=>"packagenameeditseditidlistingslanguageimagetypeimageid-delete", "parameters"=>[{"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"imageId", "description"=>"Unique identifier an image within the set of images attached to this edit"}, {"in"=>"path", "name"=>"imageType"}, {"in"=>"path", "name"=>"language", "description"=>"The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image"]}}, "/enterprises/enroll"=>{"post"=>{"summary"=>"Entroll Enterprise", "description"=>"Enrolls an enterprise with the calling EMM.", "operationId"=>"androidenterprise.enterprises.enroll", "x-api-path-slug"=>"enterprisesenroll-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"token", "description"=>"The token provided by the enterprise to register the EMM"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Enroll"]}}, "/enterprises/pullNotificationSet"=>{"post"=>{"summary"=>"Get Notification Set", "description"=>"Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending.\nA notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty.\nNotifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy.\nMultiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending.\nIf no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.", "operationId"=>"androidenterprise.enterprises.pullNotificationSet", "x-api-path-slug"=>"enterprisespullnotificationset-post", "parameters"=>[{"in"=>"query", "name"=>"requestMode", "description"=>"The request mode for pulling notifications"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification"]}}, "/enterprises/signupUrl"=>{"post"=>{"summary"=>"", "description"=>"Generates a sign-up URL.", "operationId"=>"androidenterprise.enterprises.generateSignupUrl", "x-api-path-slug"=>"enterprisessignupurl-post", "parameters"=>[{"in"=>"query", "name"=>"callbackUrl", "description"=>"The callback URL to which the Admin will be redirected after successfully creating an enterprise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signup"]}}, "/enterprises/{enterpriseId}"=>{"delete"=>{"summary"=>"Delete Enterprise", "description"=>"Deletes the binding between the EMM and enterprise. This is now deprecated. Use this method only to unenroll customers that were previously enrolled with the insert call, then enroll them again with the enroll call.", "operationId"=>"androidenterprise.enterprises.delete", "x-api-path-slug"=>"enterprisesenterpriseid-delete", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Enterprise"]}, "get"=>{"summary"=>"Get Enterprise", "description"=>"Retrieves the name and domain of an enterprise.", "operationId"=>"androidenterprise.enterprises.get", "x-api-path-slug"=>"enterprisesenterpriseid-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Enterprise"]}}, "/enterprises/{enterpriseId}/account"=>{"put"=>{"summary"=>"Update Enterprise Account", "description"=>"Sets the account that will be used to authenticate to the API as the enterprise.", "operationId"=>"androidenterprise.enterprises.setAccount", "x-api-path-slug"=>"enterprisesenterpriseidaccount-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Enterprise"]}}, "/enterprises/{enterpriseId}/createWebToken"=>{"post"=>{"summary"=>"Create Web Token", "description"=>"Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.", "operationId"=>"androidenterprise.enterprises.createWebToken", "x-api-path-slug"=>"enterprisesenterpriseidcreatewebtoken-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token"]}}, "/enterprises/{enterpriseId}/groupLicenses"=>{"get"=>{"summary"=>"Get Group Licenses", "description"=>"Retrieves IDs of all products for which the enterprise has a group license.", "operationId"=>"androidenterprise.grouplicenses.list", "x-api-path-slug"=>"enterprisesenterpriseidgrouplicenses-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License"]}}, "/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}"=>{"get"=>{"summary"=>"Get Group License", "description"=>"Retrieves details of an enterprise's group license for a product.", "operationId"=>"androidenterprise.grouplicenses.get", "x-api-path-slug"=>"enterprisesenterpriseidgrouplicensesgrouplicenseid-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"groupLicenseId", "description"=>"The ID of the product the group license is for, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License"]}}, "/{packageName}/edits/{editId}/tracks"=>{"get"=>{"summary"=>"Get Track Configurations", "description"=>"Lists all the track configurations for this edit.", "operationId"=>"androidpublisher.edits.tracks.list", "x-api-path-slug"=>"packagenameeditseditidtracks-get", "parameters"=>[{"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Track Configuration"]}}, "/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/users"=>{"get"=>{"summary"=>"Get Group License User", "description"=>"Retrieves the IDs of the users who have been granted entitlements under the license.", "operationId"=>"androidenterprise.grouplicenseusers.list", "x-api-path-slug"=>"enterprisesenterpriseidgrouplicensesgrouplicenseidusers-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"groupLicenseId", "description"=>"The ID of the product the group license is for, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License"]}}, "/{packageName}/edits/{editId}/tracks/{track}"=>{"get"=>{"summary"=>"Get Track Configuration", "description"=>"Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track.", "operationId"=>"androidpublisher.edits.tracks.get", "x-api-path-slug"=>"packagenameeditseditidtrackstrack-get", "parameters"=>[{"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}, {"in"=>"path", "name"=>"track", "description"=>"The track type to read or modify"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Track Configuration"]}, "patch"=>{"summary"=>"Update Track Configuration", "description"=>"Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume. This method supports patch semantics.", "operationId"=>"androidpublisher.edits.tracks.patch", "x-api-path-slug"=>"packagenameeditseditidtrackstrack-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}, {"in"=>"path", "name"=>"track", "description"=>"The track type to read or modify"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Track Configuration"]}, "put"=>{"summary"=>"Update Track Configuration", "description"=>"Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume.", "operationId"=>"androidpublisher.edits.tracks.update", "x-api-path-slug"=>"packagenameeditseditidtrackstrack-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}, {"in"=>"path", "name"=>"track", "description"=>"The track type to read or modify"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Track Configuration"]}}, "/enterprises/{enterpriseId}/products"=>{"get"=>{"summary"=>"Get Products", "description"=>"Finds approved products that match a query, or all approved products if there is no query.", "operationId"=>"androidenterprise.products.list", "x-api-path-slug"=>"enterprisesenterpriseidproducts-get", "parameters"=>[{"in"=>"query", "name"=>"approved", "description"=>"Specifies whether to search among all products (false) or among only products that have been approved (true)"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"query", "name"=>"language", "description"=>"The BCP47 tag for the users preferred language (e"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Specifies the maximum number of products that can be returned per request"}, {"in"=>"query", "name"=>"query", "description"=>"The search query as typed in the Google Play store search box"}, {"in"=>"query", "name"=>"token", "description"=>"A pagination token is contained in a requests response when there are more products"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}}, "/enterprises/{enterpriseId}/products/{productId}"=>{"get"=>{"summary"=>"Get Product", "description"=>"Retrieves details of a product for display to an enterprise admin.", "operationId"=>"androidenterprise.products.get", "x-api-path-slug"=>"enterprisesenterpriseidproductsproductid-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"query", "name"=>"language", "description"=>"The BCP47 tag for the users preferred language (e"}, {"in"=>"path", "name"=>"productId", "description"=>"The ID of the product, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}}, "/enterprises/{enterpriseId}/products/{productId}/appRestrictionsSchema"=>{"get"=>{"summary"=>"Get Restriction Schema", "description"=>"Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an admin to configure the product. To apply a managed configuration based on the schema obtained using this API, see Managed Configurations through Play.", "operationId"=>"androidenterprise.products.getAppRestrictionsSchema", "x-api-path-slug"=>"enterprisesenterpriseidproductsproductidapprestrictionsschema-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"query", "name"=>"language", "description"=>"The BCP47 tag for the users preferred language (e"}, {"in"=>"path", "name"=>"productId", "description"=>"The ID of the product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schema"]}}, "/{packageName}/edits/{editId}:commit"=>{"post"=>{"summary"=>"Commit Changes", "description"=>"Commits/applies the changes made in this edit back to the app.", "operationId"=>"androidpublisher.edits.commit", "x-api-path-slug"=>"packagenameeditseditidcommit-post", "parameters"=>[{"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change"]}}, "/{packageName}/edits/{editId}:validate"=>{"post"=>{"summary"=>"Validate Changes", "description"=>"Checks that the edit can be successfully committed. The edit's changes are not applied to the live app.", "operationId"=>"androidpublisher.edits.validate", "x-api-path-slug"=>"packagenameeditseditidvalidate-post", "parameters"=>[{"in"=>"path", "name"=>"editId", "description"=>"Unique identifier for this edit"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app that is being updated; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change"]}}, "/enterprises/{enterpriseId}/products/{productId}/approve"=>{"post"=>{"summary"=>"Approve Product", "description"=>"Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000.\n\nTo learn how to use managed Google Play to design and create a store layout to display approved products to your users, see Store Layout Design.", "operationId"=>"androidenterprise.products.approve", "x-api-path-slug"=>"enterprisesenterpriseidproductsproductidapprove-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"productId", "description"=>"The ID of the product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}}, "/{packageName}/entitlements"=>{"get"=>{"summary"=>"Get Entitlements", "description"=>"Lists the user's current inapp item or subscription entitlements", "operationId"=>"androidpublisher.entitlements.list", "x-api-path-slug"=>"packagenameentitlements-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults"}, {"in"=>"path", "name"=>"packageName", "description"=>"The package name of the application the inapp product was sold in (for example, com"}, {"in"=>"query", "name"=>"productId", "description"=>"The product id of the inapp product (for example, sku1)"}, {"in"=>"query", "name"=>"startIndex"}, {"in"=>"query", "name"=>"token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entitlement"]}}, "/enterprises/{enterpriseId}/products/{productId}/generateApprovalUrl"=>{"post"=>{"summary"=>"Generates a URL", "description"=>"Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product.\n\nAdmins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day.", "operationId"=>"androidenterprise.products.generateApprovalUrl", "x-api-path-slug"=>"enterprisesenterpriseidproductsproductidgenerateapprovalurl-post", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"query", "name"=>"languageCode", "description"=>"The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance en-US"}, {"in"=>"path", "name"=>"productId", "description"=>"The ID of the product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["URL"]}}, "/enterprises/{enterpriseId}/products/{productId}/permissions"=>{"get"=>{"summary"=>"Retrieves the Android App Permission", "description"=>"Retrieves the Android app permissions required by this app.", "operationId"=>"androidenterprise.products.getPermissions", "x-api-path-slug"=>"enterprisesenterpriseidproductsproductidpermissions-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"productId", "description"=>"The ID of the product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}}, "/{packageName}/inappproducts"=>{"get"=>{"summary"=>"Get In App Products", "description"=>"List all the in-app products for an Android app, both subscriptions and managed in-app products..", "operationId"=>"androidpublisher.inappproducts.list", "x-api-path-slug"=>"packagenameinappproducts-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app with in-app products; for example, com"}, {"in"=>"query", "name"=>"startIndex"}, {"in"=>"query", "name"=>"token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["In App Product"]}, "post"=>{"summary"=>"Create In App Products", "description"=>"Creates a new in-app product for an app.", "operationId"=>"androidpublisher.inappproducts.insert", "x-api-path-slug"=>"packagenameinappproducts-post", "parameters"=>[{"in"=>"query", "name"=>"autoConvertMissingPrices", "description"=>"If true the prices for all regions targeted by the parent app that dont have a price specified for this in-app product will be auto converted to the target currency based on the default price"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app; for example, com"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["In App Product"]}}, "/enterprises/{enterpriseId}/products/{productId}/unapprove"=>{"post"=>{"summary"=>"Unnarove Product", "description"=>"Unapproves the specified product (and the relevant app permissions, if any)", "operationId"=>"androidenterprise.products.unapprove", "x-api-path-slug"=>"enterprisesenterpriseidproductsproductidunapprove-post", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"productId", "description"=>"The ID of the product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}}, "/enterprises/{enterpriseId}/sendTestPushNotification"=>{"post"=>{"summary"=>"Send Test Push", "description"=>"Sends a test push notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.", "operationId"=>"androidenterprise.enterprises.sendTestPushNotification", "x-api-path-slug"=>"enterprisesenterpriseidsendtestpushnotification-post", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Testing"]}}, "/enterprises/{enterpriseId}/serviceAccount"=>{"get"=>{"summary"=>"Return Service Account", "description"=>"Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side.\n\nThis method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error.\n\nSubsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials.\n\nOnce the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource.", "operationId"=>"androidenterprise.enterprises.getServiceAccount", "x-api-path-slug"=>"enterprisesenterpriseidserviceaccount-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"query", "name"=>"keyType", "description"=>"The type of credential to return with the service account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/{packageName}/inappproducts/{sku}"=>{"delete"=>{"summary"=>"Delete In App Products", "description"=>"Delete an in-app product for an app.", "operationId"=>"androidpublisher.inappproducts.delete", "x-api-path-slug"=>"packagenameinappproductssku-delete", "parameters"=>[{"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app with the in-app product; for example, com"}, {"in"=>"path", "name"=>"sku", "description"=>"Unique identifier for the in-app product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["In App Product"]}, "get"=>{"summary"=>"Get In App Product", "description"=>"Returns information about the in-app product specified.", "operationId"=>"androidpublisher.inappproducts.get", "x-api-path-slug"=>"packagenameinappproductssku-get", "parameters"=>[{"in"=>"path", "name"=>"packageName"}, {"in"=>"path", "name"=>"sku", "description"=>"Unique identifier for the in-app product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["In App Product"]}, "patch"=>{"summary"=>"Update In App Product", "description"=>"Updates the details of an in-app product. This method supports patch semantics.", "operationId"=>"androidpublisher.inappproducts.patch", "x-api-path-slug"=>"packagenameinappproductssku-patch", "parameters"=>[{"in"=>"query", "name"=>"autoConvertMissingPrices", "description"=>"If true the prices for all regions targeted by the parent app that dont have a price specified for this in-app product will be auto converted to the target currency based on the default price"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app with the in-app product; for example, com"}, {"in"=>"path", "name"=>"sku", "description"=>"Unique identifier for the in-app product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["In App Product"]}, "put"=>{"summary"=>"Update In App Product", "description"=>"Updates the details of an in-app product.", "operationId"=>"androidpublisher.inappproducts.update", "x-api-path-slug"=>"packagenameinappproductssku-put", "parameters"=>[{"in"=>"query", "name"=>"autoConvertMissingPrices", "description"=>"If true the prices for all regions targeted by the parent app that dont have a price specified for this in-app product will be auto converted to the target currency based on the default price"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app with the in-app product; for example, com"}, {"in"=>"path", "name"=>"sku", "description"=>"Unique identifier for the in-app product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["In App Product"]}}, "/enterprises/{enterpriseId}/serviceAccountKeys"=>{"get"=>{"summary"=>"Return Active Credentials", "description"=>"Lists all active credentials for the service account associated with this enterprise. Only the ID and key type are returned. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.", "operationId"=>"androidenterprise.serviceaccountkeys.list", "x-api-path-slug"=>"enterprisesenterpriseidserviceaccountkeys-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Credential"]}, "post"=>{"summary"=>"Generate New Credentials", "description"=>"Generates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.\n\nOnly the type of the key should be populated in the resource to be inserted.", "operationId"=>"androidenterprise.serviceaccountkeys.insert", "x-api-path-slug"=>"enterprisesenterpriseidserviceaccountkeys-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Credential"]}}, "/enterprises/{enterpriseId}/serviceAccountKeys/{keyId}"=>{"delete"=>{"summary"=>"Remove and Invalidates Credentials", "description"=>"Removes and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.", "operationId"=>"androidenterprise.serviceaccountkeys.delete", "x-api-path-slug"=>"enterprisesenterpriseidserviceaccountkeyskeyid-delete", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"keyId", "description"=>"The ID of the key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Credential"]}}, "/enterprises/{enterpriseId}/storeLayout"=>{"get"=>{"summary"=>"Get Store Layout", "description"=>"Returns the store layout for the enterprise. If the store layout has not been set, or if the store layout has no homepageId set, returns a NOT_FOUND error.", "operationId"=>"androidenterprise.enterprises.getStoreLayout", "x-api-path-slug"=>"enterprisesenterpriseidstorelayout-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store Layout"]}, "put"=>{"summary"=>"Update Store Layout", "description"=>"Sets the store layout for the enterprise. By default, storeLayoutType is set to \"basic\" and the basic store layout is enabled. The basic layout only contains apps approved by the admin, and that have been added to the available product set for a user (using the setAvailableProductSet call). Apps on the page are sorted in order of their product ID value. If you create a custom store layout (by setting storeLayoutType = \"custom\"), the basic store layout is disabled.", "operationId"=>"androidenterprise.enterprises.setStoreLayout", "x-api-path-slug"=>"enterprisesenterpriseidstorelayout-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store Layout"]}}, "/enterprises/{enterpriseId}/storeLayout/pages"=>{"get"=>{"summary"=>"Get Store Layout Pages", "description"=>"Retrieves the details of all pages in the store.", "operationId"=>"androidenterprise.storelayoutpages.list", "x-api-path-slug"=>"enterprisesenterpriseidstorelayoutpages-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store Layout Page"]}, "post"=>{"summary"=>"Create Store Layout Page", "description"=>"Inserts a new store page.", "operationId"=>"androidenterprise.storelayoutpages.insert", "x-api-path-slug"=>"enterprisesenterpriseidstorelayoutpages-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store Layout Page"]}}, "/{packageName}/purchases/products/{productId}/tokens/{token}"=>{"get"=>{"summary"=>"Get In App Purchases", "description"=>"Checks the purchase and consumption status of an inapp item.", "operationId"=>"androidpublisher.purchases.products.get", "x-api-path-slug"=>"packagenamepurchasesproductsproductidtokenstoken-get", "parameters"=>[{"in"=>"path", "name"=>"packageName", "description"=>"The package name of the application the inapp product was sold in (for example, com"}, {"in"=>"path", "name"=>"productId", "description"=>"The inapp product SKU (for example, com"}, {"in"=>"path", "name"=>"token", "description"=>"The token provided to the users device when the inapp product was purchased"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["In App Purchase"]}}, "/enterprises/{enterpriseId}/storeLayout/pages/{pageId}"=>{"delete"=>{"summary"=>"Delete Store Layout Page", "description"=>"Deletes a store page.", "operationId"=>"androidenterprise.storelayoutpages.delete", "x-api-path-slug"=>"enterprisesenterpriseidstorelayoutpagespageid-delete", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"pageId", "description"=>"The ID of the page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store Layout Page"]}, "get"=>{"summary"=>"Get Store Layout Page", "description"=>"Retrieves details of a store page.", "operationId"=>"androidenterprise.storelayoutpages.get", "x-api-path-slug"=>"enterprisesenterpriseidstorelayoutpagespageid-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"pageId", "description"=>"The ID of the page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store Layout Page"]}, "patch"=>{"summary"=>"Update Store Layout Page", "description"=>"Updates the content of a store page. This method supports patch semantics.", "operationId"=>"androidenterprise.storelayoutpages.patch", "x-api-path-slug"=>"enterprisesenterpriseidstorelayoutpagespageid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"pageId", "description"=>"The ID of the page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store Layout Page"]}, "put"=>{"summary"=>"Create Store Layout Page", "description"=>"Updates the content of a store page.", "operationId"=>"androidenterprise.storelayoutpages.update", "x-api-path-slug"=>"enterprisesenterpriseidstorelayoutpagespageid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"pageId", "description"=>"The ID of the page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store Layout Page Cluster"]}}, "/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}"=>{"get"=>{"summary"=>"Check User Subscriptions", "description"=>"Checks whether a user's subscription purchase is valid and returns its expiry time.", "operationId"=>"androidpublisher.purchases.subscriptions.get", "x-api-path-slug"=>"packagenamepurchasessubscriptionssubscriptionidtokenstoken-get", "parameters"=>[{"in"=>"path", "name"=>"packageName", "description"=>"The package name of the application for which this subscription was purchased (for example, com"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"The purchased subscription ID (for example, monthly001)"}, {"in"=>"path", "name"=>"token", "description"=>"The token provided to the users device when the subscription was purchased"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel"=>{"post"=>{"summary"=>"Cancel User Subscription", "description"=>"Cancels a user's subscription purchase. The subscription remains valid until its expiration time.", "operationId"=>"androidpublisher.purchases.subscriptions.cancel", "x-api-path-slug"=>"packagenamepurchasessubscriptionssubscriptionidtokenstokencancel-post", "parameters"=>[{"in"=>"path", "name"=>"packageName", "description"=>"The package name of the application for which this subscription was purchased (for example, com"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"The purchased subscription ID (for example, monthly001)"}, {"in"=>"path", "name"=>"token", "description"=>"The token provided to the users device when the subscription was purchased"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:defer"=>{"post"=>{"summary"=>"Defer User Subscription", "description"=>"Defers a user's subscription purchase until a specified future expiration time.", "operationId"=>"androidpublisher.purchases.subscriptions.defer", "x-api-path-slug"=>"packagenamepurchasessubscriptionssubscriptionidtokenstokendefer-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"packageName", "description"=>"The package name of the application for which this subscription was purchased (for example, com"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"The purchased subscription ID (for example, monthly001)"}, {"in"=>"path", "name"=>"token", "description"=>"The token provided to the users device when the subscription was purchased"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters"=>{"get"=>{"summary"=>"Get Store Layout Page Clusters", "description"=>"Retrieves the details of all clusters on the specified page.", "operationId"=>"androidenterprise.storelayoutclusters.list", "x-api-path-slug"=>"enterprisesenterpriseidstorelayoutpagespageidclusters-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"pageId", "description"=>"The ID of the page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store Layout Page Cluster"]}, "post"=>{"summary"=>"Insert Store Layout Page Cluster", "description"=>"Inserts a new cluster in a page.", "operationId"=>"androidenterprise.storelayoutclusters.insert", "x-api-path-slug"=>"enterprisesenterpriseidstorelayoutpagespageidclusters-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"pageId", "description"=>"The ID of the page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store Layout Page Cluster"]}}, "/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:refund"=>{"post"=>{"summary"=>"Refund User Subscription", "description"=>"Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.", "operationId"=>"androidpublisher.purchases.subscriptions.refund", "x-api-path-slug"=>"packagenamepurchasessubscriptionssubscriptionidtokenstokenrefund-post", "parameters"=>[{"in"=>"path", "name"=>"packageName", "description"=>"The package name of the application for which this subscription was purchased (for example, com"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"The purchased subscription ID (for example, monthly001)"}, {"in"=>"path", "name"=>"token", "description"=>"The token provided to the users device when the subscription was purchased"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}"=>{"delete"=>{"summary"=>"Delete Store Layout Page Cluster", "description"=>"Deletes a cluster.", "operationId"=>"androidenterprise.storelayoutclusters.delete", "x-api-path-slug"=>"enterprisesenterpriseidstorelayoutpagespageidclustersclusterid-delete", "parameters"=>[{"in"=>"path", "name"=>"clusterId", "description"=>"The ID of the cluster"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"pageId", "description"=>"The ID of the page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store Layout Page Cluster"]}, "get"=>{"summary"=>"Get Store Layout Page Cluster", "description"=>"Retrieves details of a cluster.", "operationId"=>"androidenterprise.storelayoutclusters.get", "x-api-path-slug"=>"enterprisesenterpriseidstorelayoutpagespageidclustersclusterid-get", "parameters"=>[{"in"=>"path", "name"=>"clusterId", "description"=>"The ID of the cluster"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"pageId", "description"=>"The ID of the page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store Layout Page Cluster"]}, "patch"=>{"summary"=>"Update Store Layout Page Cluster", "description"=>"Updates a cluster. This method supports patch semantics.", "operationId"=>"androidenterprise.storelayoutclusters.patch", "x-api-path-slug"=>"enterprisesenterpriseidstorelayoutpagespageidclustersclusterid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"clusterId", "description"=>"The ID of the cluster"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"pageId", "description"=>"The ID of the page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store Layout Page Cluster"]}, "put"=>{"summary"=>"Update Store Layout Page Cluster", "description"=>"Updates a cluster.", "operationId"=>"androidenterprise.storelayoutclusters.update", "x-api-path-slug"=>"enterprisesenterpriseidstorelayoutpagespageidclustersclusterid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"clusterId", "description"=>"The ID of the cluster"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"pageId", "description"=>"The ID of the page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store Layout Page Cluster"]}}, "/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:revoke"=>{"post"=>{"summary"=>"Refunds and Revoke", "description"=>"Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.", "operationId"=>"androidpublisher.purchases.subscriptions.revoke", "x-api-path-slug"=>"packagenamepurchasessubscriptionssubscriptionidtokenstokenrevoke-post", "parameters"=>[{"in"=>"path", "name"=>"packageName", "description"=>"The package name of the application for which this subscription was purchased (for example, com"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"The purchased subscription ID (for example, monthly001)"}, {"in"=>"path", "name"=>"token", "description"=>"The token provided to the users device when the subscription was purchased"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/{packageName}/purchases/voidedpurchases"=>{"get"=>{"summary"=>"List Cancelled Purches", "description"=>"Lists the purchases that were cancelled, refunded or charged-back.", "operationId"=>"androidpublisher.purchases.voidedpurchases.list", "x-api-path-slug"=>"packagenamepurchasesvoidedpurchases-get", "parameters"=>[{"in"=>"query", "name"=>"endTime", "description"=>"The time, in milliseconds since the Epoch, of the newest voided in-app product purchase that you want to see in the response"}, {"in"=>"query", "name"=>"maxResults"}, {"in"=>"path", "name"=>"packageName", "description"=>"The package name of the application for which voided purchases need to be returned (for example, com"}, {"in"=>"query", "name"=>"startIndex"}, {"in"=>"query", "name"=>"startTime", "description"=>"The time, in milliseconds since the Epoch, of the oldest voided in-app product purchase that you want to see in the response"}, {"in"=>"query", "name"=>"token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/{packageName}/reviews"=>{"get"=>{"summary"=>"Get Reviews", "description"=>"Returns a list of reviews. Only reviews from last week will be returned.", "operationId"=>"androidpublisher.reviews.list", "x-api-path-slug"=>"packagenamereviews-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults"}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app for which we want reviews; for example, com"}, {"in"=>"query", "name"=>"startIndex"}, {"in"=>"query", "name"=>"token"}, {"in"=>"query", "name"=>"translationLanguage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reviews"]}}, "/enterprises/{enterpriseId}/unenroll"=>{"post"=>{"summary"=>"Unenroll Enterprise", "description"=>"Unenrolls an enterprise from the calling EMM.", "operationId"=>"androidenterprise.enterprises.unenroll", "x-api-path-slug"=>"enterprisesenterpriseidunenroll-post", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Enterprise"]}}, "/{packageName}/reviews/{reviewId}"=>{"get"=>{"summary"=>"Get Review", "description"=>"Returns a single review.", "operationId"=>"androidpublisher.reviews.get", "x-api-path-slug"=>"packagenamereviewsreviewid-get", "parameters"=>[{"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app for which we want reviews; for example, com"}, {"in"=>"path", "name"=>"reviewId"}, {"in"=>"query", "name"=>"translationLanguage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reviews"]}}, "/enterprises/{enterpriseId}/users"=>{"get"=>{"summary"=>"Lookup User", "description"=>"Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.", "operationId"=>"androidenterprise.users.list", "x-api-path-slug"=>"enterprisesenterpriseidusers-get", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"The exact primary email address of the user to look up"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "post"=>{"summary"=>"Create New User", "description"=>"Creates a new EMM-managed user.\n\nThe Users resource passed in the body of the request should include an accountIdentifier and an accountType.\nIf a corresponding user already exists with the same account identifier, the user will be updated with the resource. In this case only the displayName field can be changed.", "operationId"=>"androidenterprise.users.insert", "x-api-path-slug"=>"enterprisesenterpriseidusers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/{packageName}/reviews/{reviewId}:reply"=>{"post"=>{"summary"=>"Reply To Review", "description"=>"Reply to a single review, or update an existing reply.", "operationId"=>"androidpublisher.reviews.reply", "x-api-path-slug"=>"packagenamereviewsreviewidreply-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"packageName", "description"=>"Unique identifier for the Android app for which we want reviews; for example, com"}, {"in"=>"path", "name"=>"reviewId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reviews"]}}, "/enterprises/{enterpriseId}/users/{userId}"=>{"delete"=>{"summary"=>"Delete User", "description"=>"Deleted an EMM-managed user.", "operationId"=>"androidenterprise.users.delete", "x-api-path-slug"=>"enterprisesenterpriseidusersuserid-delete", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "get"=>{"summary"=>"Get User", "description"=>"Retrieves a user's details.", "operationId"=>"androidenterprise.users.get", "x-api-path-slug"=>"enterprisesenterpriseidusersuserid-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "patch"=>{"summary"=>"Update User", "description"=>"Updates the details of an EMM-managed user.\n\nCan be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value. This method supports patch semantics.", "operationId"=>"androidenterprise.users.patch", "x-api-path-slug"=>"enterprisesenterpriseidusersuserid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "put"=>{"summary"=>"Update User", "description"=>"Updates the details of an EMM-managed user.\n\nCan be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value.", "operationId"=>"androidenterprise.users.update", "x-api-path-slug"=>"enterprisesenterpriseidusersuserid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/enterprises/{enterpriseId}/users/{userId}/authenticationToken"=>{"post"=>{"summary"=>"Generate Authentication Token", "description"=>"Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes.\n\nThis call only works with EMM-managed accounts.", "operationId"=>"androidenterprise.users.generateAuthenticationToken", "x-api-path-slug"=>"enterprisesenterpriseidusersuseridauthenticationtoken-post", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token"]}}, "/enterprises/{enterpriseId}/users/{userId}/availableProductSet"=>{"get"=>{"summary"=>"Get Products", "description"=>"Retrieves the set of products a user is entitled to access.", "operationId"=>"androidenterprise.users.getAvailableProductSet", "x-api-path-slug"=>"enterprisesenterpriseidusersuseridavailableproductset-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}, "put"=>{"summary"=>"Update Products", "description"=>"Modifies the set of products that a user is entitled to access (referred to as whitelisted products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted.", "operationId"=>"androidenterprise.users.setAvailableProductSet", "x-api-path-slug"=>"enterprisesenterpriseidusersuseridavailableproductset-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}}, "/enterprises/{enterpriseId}/users/{userId}/devices"=>{"get"=>{"summary"=>"Get User Devices", "description"=>"Retrieves the IDs of all of a user's devices.", "operationId"=>"androidenterprise.devices.list", "x-api-path-slug"=>"enterprisesenterpriseidusersuseriddevices-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device"]}}, "/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}"=>{"get"=>{"summary"=>"Get User Device", "description"=>"Retrieves the details of a device.", "operationId"=>"androidenterprise.devices.get", "x-api-path-slug"=>"enterprisesenterpriseidusersuseriddevicesdeviceid-get", "parameters"=>[{"in"=>"path", "name"=>"deviceId", "description"=>"The ID of the device"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device"]}}, "/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs"=>{"get"=>{"summary"=>"Get App Installs", "description"=>"Retrieves the details of all apps installed on the specified device.", "operationId"=>"androidenterprise.installs.list", "x-api-path-slug"=>"enterprisesenterpriseidusersuseriddevicesdeviceidinstalls-get", "parameters"=>[{"in"=>"path", "name"=>"deviceId", "description"=>"The Android ID of the device"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App Install"]}}, "/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}"=>{"delete"=>{"summary"=>"Remove App Install", "description"=>"Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed.", "operationId"=>"androidenterprise.installs.delete", "x-api-path-slug"=>"enterprisesenterpriseidusersuseriddevicesdeviceidinstallsinstallid-delete", "parameters"=>[{"in"=>"path", "name"=>"deviceId", "description"=>"The Android ID of the device"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"installId", "description"=>"The ID of the product represented by the install, e"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App Install"]}, "get"=>{"summary"=>"Get App Install", "description"=>"Retrieves details of an installation of an app on a device.", "operationId"=>"androidenterprise.installs.get", "x-api-path-slug"=>"enterprisesenterpriseidusersuseriddevicesdeviceidinstallsinstallid-get", "parameters"=>[{"in"=>"path", "name"=>"deviceId", "description"=>"The Android ID of the device"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"installId", "description"=>"The ID of the product represented by the install, e"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App Install"]}, "patch"=>{"summary"=>"Update App Install", "description"=>"Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary. This method supports patch semantics.", "operationId"=>"androidenterprise.installs.patch", "x-api-path-slug"=>"enterprisesenterpriseidusersuseriddevicesdeviceidinstallsinstallid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"deviceId", "description"=>"The Android ID of the device"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"installId", "description"=>"The ID of the product represented by the install, e"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App Install"]}, "put"=>{"summary"=>"Update App Install", "description"=>"Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary.", "operationId"=>"androidenterprise.installs.update", "x-api-path-slug"=>"enterprisesenterpriseidusersuseriddevicesdeviceidinstallsinstallid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"deviceId", "description"=>"The Android ID of the device"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"installId", "description"=>"The ID of the product represented by the install, e"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App Install"]}}, "/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice"=>{"get"=>{"summary"=>"Get Per Device App Installs", "description"=>"Lists all the per-device managed configurations for the specified device. Only the ID is set.", "operationId"=>"androidenterprise.managedconfigurationsfordevice.list", "x-api-path-slug"=>"enterprisesenterpriseidusersuseriddevicesdeviceidmanagedconfigurationsfordevice-get", "parameters"=>[{"in"=>"path", "name"=>"deviceId", "description"=>"The Android ID of the device"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App Install"]}}, "/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}"=>{"delete"=>{"summary"=>"Remove Per Device App Install", "description"=>"Removes a per-device managed configuration for an app for the specified device.", "operationId"=>"androidenterprise.managedconfigurationsfordevice.delete", "x-api-path-slug"=>"enterprisesenterpriseidusersuseriddevicesdeviceidmanagedconfigurationsfordevicemanagedconfigurationfordeviceid-delete", "parameters"=>[{"in"=>"path", "name"=>"deviceId", "description"=>"The Android ID of the device"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"managedConfigurationForDeviceId", "description"=>"The ID of the managed configuration (a product ID), e"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App Install"]}, "get"=>{"summary"=>"Get Per Device App Install", "description"=>"Retrieves details of a per-device managed configuration.", "operationId"=>"androidenterprise.managedconfigurationsfordevice.get", "x-api-path-slug"=>"enterprisesenterpriseidusersuseriddevicesdeviceidmanagedconfigurationsfordevicemanagedconfigurationfordeviceid-get", "parameters"=>[{"in"=>"path", "name"=>"deviceId", "description"=>"The Android ID of the device"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"managedConfigurationForDeviceId", "description"=>"The ID of the managed configuration (a product ID), e"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App Install"]}, "patch"=>{"summary"=>"Update Per Device App Install", "description"=>"Adds or updates a per-device managed configuration for an app for the specified device. This method supports patch semantics.", "operationId"=>"androidenterprise.managedconfigurationsfordevice.patch", "x-api-path-slug"=>"enterprisesenterpriseidusersuseriddevicesdeviceidmanagedconfigurationsfordevicemanagedconfigurationfordeviceid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"deviceId", "description"=>"The Android ID of the device"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"managedConfigurationForDeviceId", "description"=>"The ID of the managed configuration (a product ID), e"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App Install"]}, "put"=>{"summary"=>"Update Per Device App Install", "description"=>"Adds or updates a per-device managed configuration for an app for the specified device.", "operationId"=>"androidenterprise.managedconfigurationsfordevice.update", "x-api-path-slug"=>"enterprisesenterpriseidusersuseriddevicesdeviceidmanagedconfigurationsfordevicemanagedconfigurationfordeviceid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"deviceId", "description"=>"The Android ID of the device"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"managedConfigurationForDeviceId", "description"=>"The ID of the managed configuration (a product ID), e"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App Install"]}}, "/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state"=>{"get"=>{"summary"=>"Get Per Device App Install State", "description"=>"Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.", "operationId"=>"androidenterprise.devices.getState", "x-api-path-slug"=>"enterprisesenterpriseidusersuseriddevicesdeviceidstate-get", "parameters"=>[{"in"=>"path", "name"=>"deviceId", "description"=>"The ID of the device"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App Install"]}, "put"=>{"summary"=>"Update Per Device App Install State", "description"=>"Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.", "operationId"=>"androidenterprise.devices.setState", "x-api-path-slug"=>"enterprisesenterpriseidusersuseriddevicesdeviceidstate-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"deviceId", "description"=>"The ID of the device"}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App Install"]}}, "/enterprises/{enterpriseId}/users/{userId}/entitlements"=>{"get"=>{"summary"=>"Get Entitlements", "description"=>"Lists all entitlements for the specified user. Only the ID is set.", "operationId"=>"androidenterprise.entitlements.list", "x-api-path-slug"=>"enterprisesenterpriseidusersuseridentitlements-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entitlement"]}}, "/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}"=>{"delete"=>{"summary"=>"Remove Entitlement", "description"=>"Removes an entitlement to an app for a user.", "operationId"=>"androidenterprise.entitlements.delete", "x-api-path-slug"=>"enterprisesenterpriseidusersuseridentitlementsentitlementid-delete", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"entitlementId", "description"=>"The ID of the entitlement (a product ID), e"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entitlement"]}, "get"=>{"summary"=>"Get Entitlement", "description"=>"Retrieves details of an entitlement.", "operationId"=>"androidenterprise.entitlements.get", "x-api-path-slug"=>"enterprisesenterpriseidusersuseridentitlementsentitlementid-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"entitlementId", "description"=>"The ID of the entitlement (a product ID), e"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entitlement"]}, "patch"=>{"summary"=>"Update Entitlement", "description"=>"Adds or updates an entitlement to an app for a user. This method supports patch semantics.", "operationId"=>"androidenterprise.entitlements.patch", "x-api-path-slug"=>"enterprisesenterpriseidusersuseridentitlementsentitlementid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"entitlementId", "description"=>"The ID of the entitlement (a product ID), e"}, {"in"=>"query", "name"=>"install", "description"=>"Set to true to also install the product on all the users devices where possible"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entitlement"]}, "put"=>{"summary"=>"Update Entitlement", "description"=>"Adds or updates an entitlement to an app for a user.", "operationId"=>"androidenterprise.entitlements.update", "x-api-path-slug"=>"enterprisesenterpriseidusersuseridentitlementsentitlementid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"entitlementId", "description"=>"The ID of the entitlement (a product ID), e"}, {"in"=>"query", "name"=>"install", "description"=>"Set to true to also install the product on all the users devices where possible"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entitlement"]}}, "/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser"=>{"get"=>{"summary"=>"Get Per User Configurations", "description"=>"Lists all the per-user managed configurations for the specified user. Only the ID is set.", "operationId"=>"androidenterprise.managedconfigurationsforuser.list", "x-api-path-slug"=>"enterprisesenterpriseidusersuseridmanagedconfigurationsforuser-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration"]}}, "/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}"=>{"delete"=>{"summary"=>"Delete Per User Configurations", "description"=>"Removes a per-user managed configuration for an app for the specified user.", "operationId"=>"androidenterprise.managedconfigurationsforuser.delete", "x-api-path-slug"=>"enterprisesenterpriseidusersuseridmanagedconfigurationsforusermanagedconfigurationforuserid-delete", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"managedConfigurationForUserId", "description"=>"The ID of the managed configuration (a product ID), e"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration"]}, "get"=>{"summary"=>"Get Per User Configuration", "description"=>"Retrieves details of a per-user managed configuration for an app for the specified user.", "operationId"=>"androidenterprise.managedconfigurationsforuser.get", "x-api-path-slug"=>"enterprisesenterpriseidusersuseridmanagedconfigurationsforusermanagedconfigurationforuserid-get", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"managedConfigurationForUserId", "description"=>"The ID of the managed configuration (a product ID), e"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration"]}, "patch"=>{"summary"=>"Update Per User Configuration", "description"=>"Adds or updates a per-user managed configuration for an app for the specified user. This method supports patch semantics.", "operationId"=>"androidenterprise.managedconfigurationsforuser.patch", "x-api-path-slug"=>"enterprisesenterpriseidusersuseridmanagedconfigurationsforusermanagedconfigurationforuserid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"managedConfigurationForUserId", "description"=>"The ID of the managed configuration (a product ID), e"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration"]}, "put"=>{"summary"=>"Update Per User Configuration", "description"=>"Adds or updates a per-user managed configuration for an app for the specified user.", "operationId"=>"androidenterprise.managedconfigurationsforuser.update", "x-api-path-slug"=>"enterprisesenterpriseidusersuseridmanagedconfigurationsforusermanagedconfigurationforuserid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"managedConfigurationForUserId", "description"=>"The ID of the managed configuration (a product ID), e"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration"]}}, "/enterprises/{enterpriseId}/users/{userId}/token"=>{"delete"=>{"summary"=>"Delete User Token", "description"=>"Revokes a previously generated token (activation code) for the user.", "operationId"=>"androidenterprise.users.revokeToken", "x-api-path-slug"=>"enterprisesenterpriseidusersuseridtoken-delete", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token"]}, "post"=>{"summary"=>"Generate User Token", "description"=>"Generates a token (activation code) to allow this user to configure their managed account in the Android Setup Wizard. Revokes any previously generated token.\n\nThis call only works with Google managed accounts.", "operationId"=>"androidenterprise.users.generateToken", "x-api-path-slug"=>"enterprisesenterpriseidusersuseridtoken-post", "parameters"=>[{"in"=>"path", "name"=>"enterpriseId", "description"=>"The ID of the enterprise"}, {"in"=>"path", "name"=>"userId", "description"=>"The ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token"]}}, "/permissions/{permissionId}"=>{"get"=>{"summary"=>"Get Permissions", "description"=>"Retrieves details of an Android app permission for display to an enterprise admin.", "operationId"=>"androidenterprise.permissions.get", "x-api-path-slug"=>"permissionspermissionid-get", "parameters"=>[{"in"=>"query", "name"=>"language", "description"=>"The BCP47 tag for the users preferred language (e"}, {"in"=>"path", "name"=>"permissionId", "description"=>"The ID of the permission"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}}, "/states"=>{"get"=>{"summary"=>"Get State Keys", "description"=>"Lists all the states keys, and optionally the state data.", "operationId"=>"appstate.states.list", "x-api-path-slug"=>"states-get", "parameters"=>[{"in"=>"query", "name"=>"includeData", "description"=>"Whether to include the full data in addition to the version number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application State"]}}, "/states/{stateKey}"=>{"delete"=>{"summary"=>"Delete State Key", "description"=>"Deletes a key and the data associated with it. The key is removed and no longer counts against the key quota. Note that since this method is not safe in the face of concurrent modifications, it should only be used for development and testing purposes. Invoking this method in shipping code can result in data loss and data corruption.", "operationId"=>"appstate.states.delete", "x-api-path-slug"=>"statesstatekey-delete", "parameters"=>[{"in"=>"path", "name"=>"stateKey", "description"=>"The key for the data to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application State"]}, "get"=>{"summary"=>"Get State Key", "description"=>"Retrieves the data corresponding to the passed key. If the key does not exist on the server, an HTTP 404 will be returned.", "operationId"=>"appstate.states.get", "x-api-path-slug"=>"statesstatekey-get", "parameters"=>[{"in"=>"path", "name"=>"stateKey", "description"=>"The key for the data to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application State"]}, "put"=>{"summary"=>"Update State Key", "description"=>"Update the data associated with the input key if and only if the passed version matches the currently stored version. This method is safe in the face of concurrent writes. Maximum per-key size is 128KB.", "operationId"=>"appstate.states.update", "x-api-path-slug"=>"statesstatekey-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"currentStateVersion", "description"=>"The version of the app state your application is attempting to update"}, {"in"=>"path", "name"=>"stateKey", "description"=>"The key for the data to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application State"]}}, "/states/{stateKey}/clear"=>{"post"=>{"summary"=>"Clear State Key", "description"=>"Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch.", "operationId"=>"appstate.states.clear", "x-api-path-slug"=>"statesstatekeyclear-post", "parameters"=>[{"in"=>"query", "name"=>"currentDataVersion", "description"=>"The version of the data to be cleared"}, {"in"=>"path", "name"=>"stateKey", "description"=>"The key for the data to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application State"]}}, "/achievements"=>{"get"=>{"summary"=>"Get Achievements", "description"=>"Lists all the achievement definitions for your application.", "operationId"=>"games.achievementDefinitions.list", "x-api-path-slug"=>"achievements-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of achievement resources to return in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Achievement"]}}, "/achievements/updateMultiple"=>{"post"=>{"summary"=>"Update Multiple Achievements", "description"=>"Updates multiple achievements for the currently authenticated player.", "operationId"=>"games.achievements.updateMultiple", "x-api-path-slug"=>"achievementsupdatemultiple-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Achievement"]}}, "/achievements/{achievementId}/increment"=>{"post"=>{"summary"=>"Increment Step Of Achievement", "description"=>"Increments the steps of the achievement with the given ID for the currently authenticated player.", "operationId"=>"games.achievements.increment", "x-api-path-slug"=>"achievementsachievementidincrement-post", "parameters"=>[{"in"=>"path", "name"=>"achievementId", "description"=>"The ID of the achievement used by this method"}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"requestId", "description"=>"A randomly generated numeric ID for each request specified by the caller"}, {"in"=>"query", "name"=>"stepsToIncrement", "description"=>"The number of steps to increment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Achievement"]}}, "/achievements/{achievementId}/reveal"=>{"post"=>{"summary"=>"Set State of Achievement", "description"=>"Sets the state of the achievement with the given ID to REVEALED for the currently authenticated player.", "operationId"=>"games.achievements.reveal", "x-api-path-slug"=>"achievementsachievementidreveal-post", "parameters"=>[{"in"=>"path", "name"=>"achievementId", "description"=>"The ID of the achievement used by this method"}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Achievement"]}}, "/achievements/{achievementId}/setStepsAtLeast"=>{"post"=>{"summary"=>"Set Steps for Achievements", "description"=>"Sets the steps for the currently authenticated player towards unlocking an achievement. If the steps parameter is less than the current number of steps that the player already gained for the achievement, the achievement is not modified.", "operationId"=>"games.achievements.setStepsAtLeast", "x-api-path-slug"=>"achievementsachievementidsetstepsatleast-post", "parameters"=>[{"in"=>"path", "name"=>"achievementId", "description"=>"The ID of the achievement used by this method"}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"steps", "description"=>"The minimum value to set the steps to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Achievement"]}}, "/achievements/{achievementId}/unlock"=>{"post"=>{"summary"=>"Unlock Achievement", "description"=>"Unlocks this achievement for the currently authenticated player.", "operationId"=>"games.achievements.unlock", "x-api-path-slug"=>"achievementsachievementidunlock-post", "parameters"=>[{"in"=>"path", "name"=>"achievementId", "description"=>"The ID of the achievement used by this method"}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Achievement"]}}, "/applications/played"=>{"post"=>{"summary"=>"Set Played", "description"=>"Indicate that the the currently authenticated user is playing your application.", "operationId"=>"games.applications.played", "x-api-path-slug"=>"applicationsplayed-post", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}}, "/applications/{applicationId}"=>{"get"=>{"summary"=>"Get Application", "description"=>"Retrieves the metadata of the application with the given ID. If the requested application is not available for the specified platformType, the returned response will not include any instance data.", "operationId"=>"games.applications.get", "x-api-path-slug"=>"applicationsapplicationid-get", "parameters"=>[{"in"=>"path", "name"=>"applicationId", "description"=>"The application ID from the Google Play developer console"}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"query", "name"=>"platformType", "description"=>"Restrict application details returned to the specific platform"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}}, "/applications/{applicationId}/verify"=>{"get"=>{"summary"=>"Verify Token", "description"=>"Verifies the auth token provided with this request is for the application with the specified ID, and returns the ID of the player it was granted for.", "operationId"=>"games.applications.verify", "x-api-path-slug"=>"applicationsapplicationidverify-get", "parameters"=>[{"in"=>"path", "name"=>"applicationId", "description"=>"The application ID from the Google Play developer console"}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token"]}}, "/eventDefinitions"=>{"get"=>{"summary"=>"Get Event Definitions", "description"=>"Returns a list of the event definitions in this application.", "operationId"=>"games.events.listDefinitions", "x-api-path-slug"=>"eventdefinitions-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of event definitions to return in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/events"=>{"get"=>{"summary"=>"Get Events", "description"=>"Returns a list showing the current progress on events in this application for the currently authenticated user.", "operationId"=>"games.events.listByPlayer", "x-api-path-slug"=>"events-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of events to return in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "post"=>{"summary"=>"Create Event", "description"=>"Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.", "operationId"=>"games.events.record", "x-api-path-slug"=>"events-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/leaderboards"=>{"get"=>{"summary"=>"Get Leader Boards", "description"=>"Lists all the leaderboard metadata for your application.", "operationId"=>"games.leaderboards.list", "x-api-path-slug"=>"leaderboards-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of leaderboards to return in the response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leader Board"]}}, "/leaderboards/scores"=>{"post"=>{"summary"=>"Create Leader Board", "description"=>"Submits multiple scores to leaderboards.", "operationId"=>"games.scores.submitMultiple", "x-api-path-slug"=>"leaderboardsscores-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leader Board"]}}, "/leaderboards/{leaderboardId}"=>{"get"=>{"summary"=>"Get Leader Board", "description"=>"Retrieves the metadata of the leaderboard with the given ID.", "operationId"=>"games.leaderboards.get", "x-api-path-slug"=>"leaderboardsleaderboardid-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"leaderboardId", "description"=>"The ID of the leaderboard"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leader Board"]}}, "/leaderboards/{leaderboardId}/scores"=>{"post"=>{"summary"=>"Update Leader Board Score", "description"=>"Submits a score to the specified leaderboard.", "operationId"=>"games.scores.submit", "x-api-path-slug"=>"leaderboardsleaderboardidscores-post", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"leaderboardId", "description"=>"The ID of the leaderboard"}, {"in"=>"query", "name"=>"score", "description"=>"The score youre submitting"}, {"in"=>"query", "name"=>"scoreTag", "description"=>"Additional information about the score youre submitting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leader Board"]}}, "/leaderboards/{leaderboardId}/scores/{collection}"=>{"get"=>{"summary"=>"Get Leader Board Scores", "description"=>"Lists the scores in a leaderboard, starting from the top.", "operationId"=>"games.scores.list", "x-api-path-slug"=>"leaderboardsleaderboardidscorescollection-get", "parameters"=>[{"in"=>"path", "name"=>"collection", "description"=>"The collection of scores youre requesting"}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"leaderboardId", "description"=>"The ID of the leaderboard"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of leaderboard scores to return in the response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}, {"in"=>"query", "name"=>"timeSpan", "description"=>"The time span for the scores and ranks youre requesting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leader Board"]}}, "/leaderboards/{leaderboardId}/window/{collection}"=>{"get"=>{"summary"=>"Get Leader Board Window", "description"=>"Lists the scores in a leaderboard around (and including) a player's score.", "operationId"=>"games.scores.listWindow", "x-api-path-slug"=>"leaderboardsleaderboardidwindowcollection-get", "parameters"=>[{"in"=>"path", "name"=>"collection", "description"=>"The collection of scores youre requesting"}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"leaderboardId", "description"=>"The ID of the leaderboard"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of leaderboard scores to return in the response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}, {"in"=>"query", "name"=>"resultsAbove", "description"=>"The preferred number of scores to return above the players score"}, {"in"=>"query", "name"=>"returnTopIfAbsent", "description"=>"True if the top scores should be returned when the player is not in the leaderboard"}, {"in"=>"query", "name"=>"timeSpan", "description"=>"The time span for the scores and ranks youre requesting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Leader Board"]}}, "/metagameConfig"=>{"get"=>{"summary"=>"Get Metagame Confirmation", "description"=>"Return the metagame configuration data for the calling application.", "operationId"=>"games.metagame.getMetagameConfig", "x-api-path-slug"=>"metagameconfig-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Game"]}}, "/players/me/players/{collection}"=>{"get"=>{"summary"=>"Get PLayers", "description"=>"Get the collection of players for the currently authenticated user.", "operationId"=>"games.players.list", "x-api-path-slug"=>"playersmeplayerscollection-get", "parameters"=>[{"in"=>"path", "name"=>"collection", "description"=>"Collection of players being retrieved"}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of player resources to return in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Player"]}}, "/players/{playerId}"=>{"get"=>{"summary"=>"Get Player", "description"=>"Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set playerId to me.", "operationId"=>"games.players.get", "x-api-path-slug"=>"playersplayerid-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"playerId", "description"=>"A player ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Player"]}}, "/players/{playerId}/achievements"=>{"get"=>{"summary"=>"Get Player Achievements", "description"=>"Lists the progress for all your application's achievements for the currently authenticated player.", "operationId"=>"games.achievements.list", "x-api-path-slug"=>"playersplayeridachievements-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of achievement resources to return in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}, {"in"=>"path", "name"=>"playerId", "description"=>"A player ID"}, {"in"=>"query", "name"=>"state", "description"=>"Tells the server to return only achievements with the specified state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Player"]}}, "/players/{playerId}/categories/{collection}"=>{"get"=>{"summary"=>"Get Player Categories", "description"=>"List play data aggregated per category for the player corresponding to playerId.", "operationId"=>"games.metagame.listCategoriesByPlayer", "x-api-path-slug"=>"playersplayeridcategoriescollection-get", "parameters"=>[{"in"=>"path", "name"=>"collection", "description"=>"The collection of categories for which data will be returned"}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of category resources to return in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}, {"in"=>"path", "name"=>"playerId", "description"=>"A player ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Player"]}}, "/players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}"=>{"get"=>{"summary"=>"Get Player Leaderboard Scores", "description"=>"Get high scores, and optionally ranks, in leaderboards for the currently authenticated player. For a specific time span, leaderboardId can be set to ALL to retrieve data for all leaderboards in a given time span.\nNOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same request; only one parameter may be set to 'ALL'.", "operationId"=>"games.scores.get", "x-api-path-slug"=>"playersplayeridleaderboardsleaderboardidscorestimespan-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"includeRankType", "description"=>"The types of ranks to return"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"leaderboardId", "description"=>"The ID of the leaderboard"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of leaderboard scores to return in the response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}, {"in"=>"path", "name"=>"playerId", "description"=>"A player ID"}, {"in"=>"path", "name"=>"timeSpan", "description"=>"The time span for the scores and ranks youre requesting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Player"]}}, "/players/{playerId}/quests"=>{"get"=>{"summary"=>"Get Guests", "description"=>"Get a list of quests for your application and the currently authenticated player.", "operationId"=>"games.quests.list", "x-api-path-slug"=>"playersplayeridquests-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of quest resources to return in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}, {"in"=>"path", "name"=>"playerId", "description"=>"A player ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guest"]}}, "/players/{playerId}/snapshots"=>{"get"=>{"summary"=>"Get Player Snapshots", "description"=>"Retrieves a list of snapshots created by your application for the player corresponding to the player ID.", "operationId"=>"games.snapshots.list", "x-api-path-slug"=>"playersplayeridsnapshots-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of snapshot resources to return in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}, {"in"=>"path", "name"=>"playerId", "description"=>"A player ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Player"]}}, "/pushtokens"=>{"put"=>{"summary"=>"Register Push Token", "description"=>"Registers a push token for the current user and application.", "operationId"=>"games.pushtokens.update", "x-api-path-slug"=>"pushtokens-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token"]}}, "/pushtokens/remove"=>{"post"=>{"summary"=>"Remove Push Token", "description"=>"Removes a push token for the current user and application. Removing a non-existent push token will report success.", "operationId"=>"games.pushtokens.remove", "x-api-path-slug"=>"pushtokensremove-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token"]}}, "/quests/{questId}/accept"=>{"post"=>{"summary"=>"Accept Quest", "description"=>"Indicates that the currently authorized user will participate in the quest.", "operationId"=>"games.quests.accept", "x-api-path-slug"=>"questsquestidaccept-post", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"questId", "description"=>"The ID of the quest"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Quest"]}}, "/quests/{questId}/milestones/{milestoneId}/claim"=>{"put"=>{"summary"=>"Claim Quest Milestone", "description"=>"Report that a reward for the milestone corresponding to milestoneId for the quest corresponding to questId has been claimed by the currently authorized user.", "operationId"=>"games.questMilestones.claim", "x-api-path-slug"=>"questsquestidmilestonesmilestoneidclaim-put", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"path", "name"=>"milestoneId", "description"=>"The ID of the milestone"}, {"in"=>"path", "name"=>"questId", "description"=>"The ID of the quest"}, {"in"=>"query", "name"=>"requestId", "description"=>"A numeric ID to ensure that the request is handled correctly across retries"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Milestone"]}}, "/revisions/check"=>{"get"=>{"summary"=>"Check Revision", "description"=>"Checks whether the games client is out of date.", "operationId"=>"games.revisions.check", "x-api-path-slug"=>"revisionscheck-get", "parameters"=>[{"in"=>"query", "name"=>"clientRevision", "description"=>"The revision of the client SDK used by your application"}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Revision"]}}, "/rooms"=>{"get"=>{"summary"=>"Get Rooms", "description"=>"Returns invitations to join rooms.", "operationId"=>"games.rooms.list", "x-api-path-slug"=>"rooms-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of rooms to return in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Room"]}}, "/rooms/create"=>{"post"=>{"summary"=>"Create Room", "description"=>"Create a room. For internal use by the Games SDK only. Calling this method directly is unsupported.", "operationId"=>"games.rooms.create", "x-api-path-slug"=>"roomscreate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Room"]}}, "/rooms/{roomId}"=>{"get"=>{"summary"=>"Get Room", "description"=>"Get the data for a room.", "operationId"=>"games.rooms.get", "x-api-path-slug"=>"roomsroomid-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"roomId", "description"=>"The ID of the room"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Room"]}}, "/rooms/{roomId}/decline"=>{"post"=>{"summary"=>"Decline Room", "description"=>"Decline an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.", "operationId"=>"games.rooms.decline", "x-api-path-slug"=>"roomsroomiddecline-post", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"roomId", "description"=>"The ID of the room"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Room"]}}, "/rooms/{roomId}/dismiss"=>{"post"=>{"summary"=>"Dismiss Room", "description"=>"Dismiss an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.", "operationId"=>"games.rooms.dismiss", "x-api-path-slug"=>"roomsroomiddismiss-post", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"path", "name"=>"roomId", "description"=>"The ID of the room"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Room"]}}, "/rooms/{roomId}/join"=>{"post"=>{"summary"=>"Join Room", "description"=>"Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.", "operationId"=>"games.rooms.join", "x-api-path-slug"=>"roomsroomidjoin-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"roomId", "description"=>"The ID of the room"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Room"]}}, "/rooms/{roomId}/leave"=>{"post"=>{"summary"=>"Leave Room", "description"=>"Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported.", "operationId"=>"games.rooms.leave", "x-api-path-slug"=>"roomsroomidleave-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"roomId", "description"=>"The ID of the room"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Room"]}}, "/rooms/{roomId}/reportstatus"=>{"post"=>{"summary"=>"Report Room Status", "description"=>"Updates sent by a client reporting the status of peers in a room. For internal use by the Games SDK only. Calling this method directly is unsupported.", "operationId"=>"games.rooms.reportStatus", "x-api-path-slug"=>"roomsroomidreportstatus-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"roomId", "description"=>"The ID of the room"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Room"]}}, "/snapshots/{snapshotId}"=>{"get"=>{"summary"=>"Get Snapshot", "description"=>"Retrieves the metadata for a given snapshot ID.", "operationId"=>"games.snapshots.get", "x-api-path-slug"=>"snapshotssnapshotid-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"snapshotId", "description"=>"The ID of the snapshot"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshot"]}}, "/turnbasedmatches"=>{"get"=>{"summary"=>"Return Turn-Based Match", "description"=>"Returns turn-based matches the player is or was involved in.", "operationId"=>"games.turnBasedMatches.list", "x-api-path-slug"=>"turnbasedmatches-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"includeMatchData", "description"=>"True if match data should be returned in the response"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"query", "name"=>"maxCompletedMatches", "description"=>"The maximum number of completed or canceled matches to return in the response"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of matches to return in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Match"]}}, "/turnbasedmatches/create"=>{"post"=>{"summary"=>"Create Turn-Based Match", "description"=>"Create a turn-based match.", "operationId"=>"games.turnBasedMatches.create", "x-api-path-slug"=>"turnbasedmatchescreate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Match"]}}, "/turnbasedmatches/sync"=>{"get"=>{"summary"=>"Sync Turn-Based Match", "description"=>"Returns turn-based matches the player is or was involved in that changed since the last sync call, with the least recent changes coming first. Matches that should be removed from the local cache will have a status of MATCH_DELETED.", "operationId"=>"games.turnBasedMatches.sync", "x-api-path-slug"=>"turnbasedmatchessync-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"includeMatchData", "description"=>"True if match data should be returned in the response"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"query", "name"=>"maxCompletedMatches", "description"=>"The maximum number of completed or canceled matches to return in the response"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of matches to return in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Match"]}}, "/turnbasedmatches/{matchId}"=>{"get"=>{"summary"=>"Get Turn-Based Match", "description"=>"Get the data for a turn-based match.", "operationId"=>"games.turnBasedMatches.get", "x-api-path-slug"=>"turnbasedmatchesmatchid-get", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"includeMatchData", "description"=>"Get match data along with metadata"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"matchId", "description"=>"The ID of the match"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Match"]}}, "/turnbasedmatches/{matchId}/cancel"=>{"put"=>{"summary"=>"Update Turn-Based Match", "description"=>"Cancel a turn-based match.", "operationId"=>"games.turnBasedMatches.cancel", "x-api-path-slug"=>"turnbasedmatchesmatchidcancel-put", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"path", "name"=>"matchId", "description"=>"The ID of the match"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Match"]}}, "/turnbasedmatches/{matchId}/decline"=>{"put"=>{"summary"=>"Decline Turn-Based Match", "description"=>"Decline an invitation to play a turn-based match.", "operationId"=>"games.turnBasedMatches.decline", "x-api-path-slug"=>"turnbasedmatchesmatchiddecline-put", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"matchId", "description"=>"The ID of the match"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Match"]}}, "/turnbasedmatches/{matchId}/dismiss"=>{"put"=>{"summary"=>"Dismiss Turn-Based Match", "description"=>"Dismiss a turn-based match from the match list. The match will no longer show up in the list and will not generate notifications.", "operationId"=>"games.turnBasedMatches.dismiss", "x-api-path-slug"=>"turnbasedmatchesmatchiddismiss-put", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"path", "name"=>"matchId", "description"=>"The ID of the match"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Match"]}}, "/turnbasedmatches/{matchId}/finish"=>{"put"=>{"summary"=>"Finish Turn-Based Match", "description"=>"Finish a turn-based match. Each player should make this call once, after all results are in. Only the player whose turn it is may make the first call to Finish, and can pass in the final match state.", "operationId"=>"games.turnBasedMatches.finish", "x-api-path-slug"=>"turnbasedmatchesmatchidfinish-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"matchId", "description"=>"The ID of the match"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Match"]}}, "/turnbasedmatches/{matchId}/join"=>{"put"=>{"summary"=>"Join Turn-Based Match", "description"=>"Join a turn-based match.", "operationId"=>"games.turnBasedMatches.join", "x-api-path-slug"=>"turnbasedmatchesmatchidjoin-put", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"matchId", "description"=>"The ID of the match"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Match"]}}, "/turnbasedmatches/{matchId}/leave"=>{"put"=>{"summary"=>"Leave Turn-Based Match", "description"=>"Leave a turn-based match when it is not the current player's turn, without canceling the match.", "operationId"=>"games.turnBasedMatches.leave", "x-api-path-slug"=>"turnbasedmatchesmatchidleave-put", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"matchId", "description"=>"The ID of the match"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Match"]}}, "/turnbasedmatches/{matchId}/leaveTurn"=>{"put"=>{"summary"=>"ReLeave Turnturn Turn-Based Match", "description"=>"Leave a turn-based match during the current player's turn, without canceling the match.", "operationId"=>"games.turnBasedMatches.leaveTurn", "x-api-path-slug"=>"turnbasedmatchesmatchidleaveturn-put", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"matchId", "description"=>"The ID of the match"}, {"in"=>"query", "name"=>"matchVersion", "description"=>"The version of the match being updated"}, {"in"=>"query", "name"=>"pendingParticipantId", "description"=>"The ID of another participant who should take their turn next"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Match"]}}, "/turnbasedmatches/{matchId}/rematch"=>{"post"=>{"summary"=>"Rematch Turn-Based Match", "description"=>"Create a rematch of a match that was previously completed, with the same participants. This can be called by only one player on a match still in their list; the player must have called Finish first. Returns the newly created match; it will be the caller's turn.", "operationId"=>"games.turnBasedMatches.rematch", "x-api-path-slug"=>"turnbasedmatchesmatchidrematch-post", "parameters"=>[{"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"matchId", "description"=>"The ID of the match"}, {"in"=>"query", "name"=>"requestId", "description"=>"A randomly generated numeric ID for each request specified by the caller"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Match"]}}, "/turnbasedmatches/{matchId}/turn"=>{"put"=>{"summary"=>"Turn Turn-Based Match", "description"=>"Commit the results of a player turn.", "operationId"=>"games.turnBasedMatches.takeTurn", "x-api-path-slug"=>"turnbasedmatchesmatchidturn-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"consistencyToken", "description"=>"The last-seen mutation timestamp"}, {"in"=>"query", "name"=>"language", "description"=>"The preferred language to use for strings returned by this method"}, {"in"=>"path", "name"=>"matchId", "description"=>"The ID of the match"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Match"]}}, "/v1/accounts/{accountId}/avails"=>{"get"=>{"summary"=>"Get Available Movies", "description"=>"List Avails owned or managed by the partner.\n\nSee _Authentication and Authorization rules_ and\n_List methods rules_ for more information about this method.", "operationId"=>"playmoviespartner.accounts.avails.list", "x-api-path-slug"=>"v1accountsaccountidavails-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"REQUIRED"}, {"in"=>"query", "name"=>"altId", "description"=>"Filter Avails that match a case-insensitive, partner-specific custom id"}, {"in"=>"query", "name"=>"altIds", "description"=>"Filter Avails that match (case-insensitive) any of the given partner-specific custom ids"}, {"in"=>"query", "name"=>"pageSize", "description"=>"See _List methods rules_ for info about this field"}, {"in"=>"query", "name"=>"pageToken", "description"=>"See _List methods rules_ for info about this field"}, {"in"=>"query", "name"=>"pphNames", "description"=>"See _List methods rules_ for info about this field"}, {"in"=>"query", "name"=>"studioNames", "description"=>"See _List methods rules_ for info about this field"}, {"in"=>"query", "name"=>"territories", "description"=>"Filter Avails that match (case-insensitive) any of the given country codes,using the ISO 3166-1 alpha-2 format (examples: US, us, Us)"}, {"in"=>"query", "name"=>"title", "description"=>"Filter that matches Avails with a `title_internal_alias`,`series_title_internal_alias`, `season_title_internal_alias`,or `episode_title_internal_alias` that contains the givencase-insensitive title"}, {"in"=>"query", "name"=>"videoIds", "description"=>"Filter Avails that match any of the given `video_id`s"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movie"]}}, "/v1/accounts/{accountId}/avails/{availId}"=>{"get"=>{"summary"=>"Get Available Movie", "description"=>"Get an Avail given its avail group id and avail id.", "operationId"=>"playmoviespartner.accounts.avails.get", "x-api-path-slug"=>"v1accountsaccountidavailsavailid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"REQUIRED"}, {"in"=>"path", "name"=>"availId", "description"=>"REQUIRED"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movie"]}}, "/v1/accounts/{accountId}/orders"=>{"get"=>{"summary"=>"Get Orders", "description"=>"List Orders owned or managed by the partner.\n\nSee _Authentication and Authorization rules_ and\n_List methods rules_ for more information about this method.", "operationId"=>"playmoviespartner.accounts.orders.list", "x-api-path-slug"=>"v1accountsaccountidorders-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"REQUIRED"}, {"in"=>"query", "name"=>"customId", "description"=>"Filter Orders that match a case-insensitive, partner-specific custom id"}, {"in"=>"query", "name"=>"name", "description"=>"Filter that matches Orders with a `name`, `show`, `season` or `episode`that contains the given case-insensitive name"}, {"in"=>"query", "name"=>"pageSize", "description"=>"See _List methods rules_ for info about this field"}, {"in"=>"query", "name"=>"pageToken", "description"=>"See _List methods rules_ for info about this field"}, {"in"=>"query", "name"=>"pphNames", "description"=>"See _List methods rules_ for info about this field"}, {"in"=>"query", "name"=>"status", "description"=>"Filter Orders that match one of the given status"}, {"in"=>"query", "name"=>"studioNames", "description"=>"See _List methods rules_ for info about this field"}, {"in"=>"query", "name"=>"videoIds", "description"=>"Filter Orders that match any of the given `video_id`s"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order"]}}, "/v1/accounts/{accountId}/orders/{orderId}"=>{"get"=>{"summary"=>"Get Order", "description"=>"Get an Order given its id.\n\nSee _Authentication and Authorization rules_ and\n_Get methods rules_ for more information about this method.", "operationId"=>"playmoviespartner.accounts.orders.get", "x-api-path-slug"=>"v1accountsaccountidordersorderid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"REQUIRED"}, {"in"=>"path", "name"=>"orderId", "description"=>"REQUIRED"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order"]}}, "/v1/accounts/{accountId}/storeInfos"=>{"get"=>{"summary"=>"Get Store Information", "description"=>"List StoreInfos owned or managed by the partner.\n\nSee _Authentication and Authorization rules_ and\n_List methods rules_ for more information about this method.", "operationId"=>"playmoviespartner.accounts.storeInfos.list", "x-api-path-slug"=>"v1accountsaccountidstoreinfos-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"REQUIRED"}, {"in"=>"query", "name"=>"countries", "description"=>"Filter StoreInfos that match (case-insensitive) any of the given countrycodes, using the ISO 3166-1 alpha-2 format (examples: US, us, Us)"}, {"in"=>"query", "name"=>"mids", "description"=>"Filter StoreInfos that match any of the given `mid`s"}, {"in"=>"query", "name"=>"name", "description"=>"Filter that matches StoreInfos with a `name` or `show_name`that contains the given case-insensitive name"}, {"in"=>"query", "name"=>"pageSize", "description"=>"See _List methods rules_ for info about this field"}, {"in"=>"query", "name"=>"pageToken", "description"=>"See _List methods rules_ for info about this field"}, {"in"=>"query", "name"=>"pphNames", "description"=>"See _List methods rules_ for info about this field"}, {"in"=>"query", "name"=>"seasonIds", "description"=>"Filter StoreInfos that match any of the given `season_id`s"}, {"in"=>"query", "name"=>"studioNames", "description"=>"See _List methods rules_ for info about this field"}, {"in"=>"query", "name"=>"videoId", "description"=>"Filter StoreInfos that match a given `video_id`"}, {"in"=>"query", "name"=>"videoIds", "description"=>"Filter StoreInfos that match any of the given `video_id`s"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store"]}}, "/v1/accounts/{accountId}/storeInfos/{videoId}/country/{country}"=>{"get"=>{"summary"=>"Get Video Country", "description"=>"Get a StoreInfo given its video id and country.\n\nSee _Authentication and Authorization rules_ and\n_Get methods rules_ for more information about this method.", "operationId"=>"playmoviespartner.accounts.storeInfos.country.get", "x-api-path-slug"=>"v1accountsaccountidstoreinfosvideoidcountrycountry-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"REQUIRED"}, {"in"=>"path", "name"=>"country", "description"=>"REQUIRED"}, {"in"=>"path", "name"=>"videoId", "description"=>"REQUIRED"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Country"]}}}}, "apis"=>{"name"=>"Google Play", "x-slug"=>"google-play", "description"=>"The Google Play Developer API allows you to perform a number of publishing and app-management tasks. It includes two components: The Subscriptions and In-App Purchases API lets you manage in-app purchases and subscriptions. The Publishing API lets you upload and publish apps, and perform other publishing-related tasks.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-play.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"Android,API Provider,API Service Provider,Games,Gaming,Google APIs,Mobile,Movies,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-play/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Play", "x-api-slug"=>"google-play", "description"=>"The Google Play Developer API allows you to perform a number of publishing and app-management tasks. It includes two components: The Subscriptions and In-App Purchases API lets you manage in-app purchases and subscriptions. The Publishing API lets you upload and publish apps, and perform other publishing-related tasks.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-play.png", "humanURL"=>"https://play.google.com/store", "baseURL"=>"https:///", "tags"=>"Android,API Provider,API Service Provider,Games,Gaming,Google APIs,Mobile,Movies,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-play/google-play-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://blog.google/products/google-play/"}, {"type"=>"x-blog-rss", "url"=>"https://blog.google/products/google-play/rss"}, {"type"=>"x-developer", "url"=>"https://developers.google.com/android-publisher/"}, {"type"=>"x-facebook", "url"=>"https://www.facebook.com/GooglePlay"}, {"type"=>"x-getting-started", "url"=>"https://developers.google.com/android-publisher/getting_started"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/GooglePlay"}, {"type"=>"x-website", "url"=>"https://play.google.com/store"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
salesforce{"salesforce-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Salesforce", "x-complete"=>1, "info"=>{"title"=>"Salesforce", "description"=>"explore-the-beta-salesforce-rest-api-to-integrate-crm-", "version"=>"1.0.0"}, "host"=>"na14.salesforce.com", "basePath"=>"/services/data", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{version}"=>{"get"=>{"summary"=>"Get Version", "description"=>"Lists available resources for the specified API version, including resource name and URI.", "operationId"=>"version.get", "x-api-path-slug"=>"version-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version"]}}, "/{version}/sobjects"=>{"get"=>{"summary"=>"Get Version Sobjects", "description"=>"Lists the available objects and their metadata for your organization's data. In addition, it provides the organization encoding, as well as maximum batch size permitted in queries. For more information, see Internationalization and Character Sets (http://www.salesforce.com/us/developer/docs/api/Content/implementation_considerations.htm#sforce_api_other_internationalization).", "operationId"=>"version.sobjects.get", "x-api-path-slug"=>"versionsobjects-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects"]}}, "/{version}/sobjects/{sobject}"=>{"get"=>{"summary"=>"Get Version Sobjects Sobject", "description"=>"Retrieves the metadata for an object.", "operationId"=>"version.sobjects.sobject.get", "x-api-path-slug"=>"versionsobjectssobject-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "Sobject"]}, "post"=>{"summary"=>"Add Version Sobjects Sobject", "description"=>"Creates a new object.", "operationId"=>"version.sobjects.sobject.post", "x-api-path-slug"=>"versionsobjectssobject-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "Sobject"]}}, "/{version}/sobjects/{sobject}/describe"=>{"get"=>{"summary"=>"Get Version Sobjects Sobject Describe", "description"=>"Completely describes the individual metadata at all levels for the specified object. For example, this can be used to retrieve the fields, URLs, and child relationships for the Account object.", "operationId"=>"version.sobjects.sobject.describe.get", "x-api-path-slug"=>"versionsobjectssobjectdescribe-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "Sobject", "Describe"]}}, "/{version}/sobjects/{sobject}/{id}"=>{"get"=>{"summary"=>"Get Version Sobjects Sobject", "description"=>"Retrieves individual records for an object.", "operationId"=>"version.sobjects.sobject.id.get", "x-api-path-slug"=>"versionsobjectssobjectid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Optional list of fields used to return values for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "Sobject"]}, "delete"=>{"summary"=>"Delete Version Sobjects Sobject", "description"=>"Deletes a record.", "operationId"=>"version.sobjects.sobject.id.delete", "x-api-path-slug"=>"versionsobjectssobjectid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "Sobject"]}}, "/{version}/sobjects/{sobject}/{id}/{blobField}"=>{"get"=>{"summary"=>"Get Version Sobjects Sobject Blobfield", "description"=>"Retrieves the specified blob field from an individual record. Because blob fields contain binary data, you can't use JSON or XML to retrieve this data.", "operationId"=>"version.sobjects.sobject.id.blobField.get", "x-api-path-slug"=>"versionsobjectssobjectidblobfield-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Optional list of fields used to return values for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "Sobject", "", "Blobfield"]}}, "/{version}/sobjects/User/{id}/password"=>{"get"=>{"summary"=>"Get Version Sobjects User Password", "description"=>"Gets password expiration status for a given user. The session must have permission to access the given user password information, otherwise an error response is returned.", "operationId"=>"version.sobjects.User.id.password.get", "x-api-path-slug"=>"versionsobjectsuseridpassword-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "User", "", "Password"]}, "post"=>{"summary"=>"Add Version Sobjects User Password", "description"=>"Changes the password for a given user ID. The new password must conform to the password policies for the organization, otherwise you will get an error response. You can only change one password per request.", "operationId"=>"version.sobjects.User.id.password.post", "x-api-path-slug"=>"versionsobjectsuseridpassword-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "User", "", "Password"]}, "delete"=>{"summary"=>"Delete Version Sobjects User Password", "description"=>"Resets an user password. Salesforce will reset the user password to an auto-generated password, which will be returned in the response.", "operationId"=>"version.sobjects.User.id.password.delete", "x-api-path-slug"=>"versionsobjectsuseridpassword-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "User", "", "Password"]}}, "/{version}/query"=>{"get"=>{"summary"=>"Get Version Query", "description"=>"Executes the specified SOQL query. If the initial query returns only part of the results, the end of the response will contain a field called nextRecordsUrl. In such cases, use the resource {version}/query/{id} to request the next batch of records and repeat until all records have been retrieved.", "operationId"=>"version.query.get", "x-api-path-slug"=>"versionquery-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Query"]}}, "/{version}/query/{id}"=>{"get"=>{"summary"=>"Get Version Query", "description"=>"Retrieves the remaining SOQL query results using the identifier within the field \"nextRecordsUrl\" value (i.e. \"nextRecordsUrl\" : \"/services/data/v24.0/query/01gD0000002HU6KIAW-2000\") located at the end of the initial query results. Requests the next batch of records and you could repeat (using the corresponding identifier) until all records have been retrieved.", "operationId"=>"version.query.id.get", "x-api-path-slug"=>"versionqueryid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Query"]}}, "/{version}/search"=>{"get"=>{"summary"=>"Get Version Search", "description"=>"Executes the specified SOSL search. The search string must be URL-encoded.", "operationId"=>"version.search.get", "x-api-path-slug"=>"versionsearch-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Search"]}}}}, "salesforce-sandbox-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Salesforce", "x-complete"=>1, "info"=>{"title"=>"Salesforce Sandbox", "description"=>"create-sandbox-copies-of-your-environments-for-development-testing-and-training-without-compromising-the-data-and-applications-in-your-production-environment-", "version"=>"1.0.0"}, "host"=>"na14.salesforce.com", "basePath"=>"/services/data/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/"=>{"get"=>{"summary"=>"Get", "description"=>"Lists summary information about each Salesforce version currently available, including the version, label, and a link to each version's root.", "operationId"=>"get", "x-api-path-slug"=>"get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/{version}"=>{"get"=>{"summary"=>"Get Version", "description"=>"Lists available resources for the specified API version, including resource name and URI.", "operationId"=>"getVersion", "x-api-path-slug"=>"version-get", "parameters"=>[{"in"=>"path", "name"=>"version", "description"=>"An API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version"]}}, "/{version}/sobjects"=>{"get"=>{"summary"=>"Get Version Sobjects", "description"=>"Lists the available objects and their metadata for your organization's data. In addition, it provides the organization encoding, as well as maximum batch size permitted in queries. For more information, see Internationalization and Character Sets (http://www.salesforce.com/us/developer/docs/api/Content/implementation_considerations.htm#sforce_api_other_internationalization).", "operationId"=>"getVersionSobjects", "x-api-path-slug"=>"versionsobjects-get", "parameters"=>[{"in"=>"path", "name"=>"version", "description"=>"An API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects"]}}, "/{version}/sobjects/{sobject}"=>{"get"=>{"summary"=>"Get Version Sobjects Sobject", "description"=>"Retrieves the metadata for an object.", "operationId"=>"getVersionSobjectsSobject", "x-api-path-slug"=>"versionsobjectssobject-get", "parameters"=>[{"in"=>"path", "name"=>"sobject", "description"=>"A Salesforces object"}, {"in"=>"path", "name"=>"version", "description"=>"An API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "Sobject"]}, "post"=>{"summary"=>"Post Version Sobjects Sobject", "description"=>"Creates a new object.", "operationId"=>"postVersionSobjectsSobject", "x-api-path-slug"=>"versionsobjectssobject-post", "parameters"=>[{"in"=>"path", "name"=>"sobject", "description"=>"A Salesforces object"}, {"in"=>"path", "name"=>"version", "description"=>"An API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "Sobject"]}}, "/{version}/sobjects/{sobject}/describe"=>{"get"=>{"summary"=>"Get Version Sobjects Sobject Describe", "description"=>"Completely describes the individual metadata at all levels for the specified object. For example, this can be used to retrieve the fields, URLs, and child relationships for the Account object.", "operationId"=>"getVersionSobjectsSobjectDescribe", "x-api-path-slug"=>"versionsobjectssobjectdescribe-get", "parameters"=>[{"in"=>"path", "name"=>"sobject", "description"=>"A Salesforces object"}, {"in"=>"path", "name"=>"version", "description"=>"An API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "Sobject", "Describe"]}}, "/{version}/sobjects/{sobject}/{id}"=>{"get"=>{"summary"=>"Get Version Sobjects Sobject", "description"=>"Retrieves individual records for an object.", "operationId"=>"getVersionSobjectsSobject", "x-api-path-slug"=>"versionsobjectssobjectid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Optional list of fields used to return values for"}, {"in"=>"path", "name"=>"id", "description"=>"A Salesforces object ID"}, {"in"=>"path", "name"=>"sobject", "description"=>"A Salesforces object"}, {"in"=>"path", "name"=>"version", "description"=>"An API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "Sobject"]}, "delete"=>{"summary"=>"Delete Version Sobjects Sobject", "description"=>"Deletes a record.", "operationId"=>"deleteVersionSobjectsSobject", "x-api-path-slug"=>"versionsobjectssobjectid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"A Salesforces object ID"}, {"in"=>"path", "name"=>"sobject", "description"=>"A Salesforces object"}, {"in"=>"path", "name"=>"version", "description"=>"An API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "Sobject"]}}, "/{version}/sobjects/{sobject}/{id}/{blobField}"=>{"get"=>{"summary"=>"Get Version Sobjects Sobject Blobfield", "description"=>"Retrieves the specified blob field from an individual record. Because blob fields contain binary data, you can't use JSON or XML to retrieve this data.", "operationId"=>"getVersionSobjectsSobjectBlobfield", "x-api-path-slug"=>"versionsobjectssobjectidblobfield-get", "parameters"=>[{"in"=>"path", "name"=>"blobField", "description"=>"A Salesforces object blob field"}, {"in"=>"query", "name"=>"fields", "description"=>"Optional list of fields used to return values for"}, {"in"=>"path", "name"=>"id", "description"=>"A Salesforces object ID"}, {"in"=>"path", "name"=>"sobject", "description"=>"A Salesforces object"}, {"in"=>"path", "name"=>"version", "description"=>"An API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "Sobject", "Blobfield"]}}, "/{version}/sobjects/User/{id}/password"=>{"get"=>{"summary"=>"Get Version Sobjects User Password", "description"=>"Gets password expiration status for a given user. The session must have permission to access the given user password information, otherwise an error response is returned.", "operationId"=>"getVersionSobjectsUserPassword", "x-api-path-slug"=>"versionsobjectsuseridpassword-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"A Salesforces user ID"}, {"in"=>"path", "name"=>"version", "description"=>"An API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "User", "Password"]}, "post"=>{"summary"=>"Post Version Sobjects User Password", "description"=>"Changes the password for a given user ID. The new password must conform to the password policies for the organization, otherwise you will get an error response. You can only change one password per request.", "operationId"=>"postVersionSobjectsUserPassword", "x-api-path-slug"=>"versionsobjectsuseridpassword-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"A Salesforces user ID"}, {"in"=>"path", "name"=>"version", "description"=>"An API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "User", "Password"]}, "delete"=>{"summary"=>"Delete Version Sobjects User Password", "description"=>"Resets an user password. Salesforce will reset the user password to an auto-generated password, which will be returned in the response.", "operationId"=>"deleteVersionSobjectsUserPassword", "x-api-path-slug"=>"versionsobjectsuseridpassword-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"A Salesforces user ID"}, {"in"=>"path", "name"=>"version", "description"=>"An API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Sobjects", "User", "Password"]}}, "/{version}/query"=>{"get"=>{"summary"=>"Get Version Query", "description"=>"Executes the specified SOQL query. If the initial query returns only part of the results, the end of the response will contain a field called nextRecordsUrl. In such cases, use the resource {version}/query/{id} to request the next batch of records and repeat until all records have been retrieved.", "operationId"=>"getVersionQuery", "x-api-path-slug"=>"versionquery-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"A SOQL query"}, {"in"=>"path", "name"=>"version", "description"=>"An API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Query"]}}, "/{version}/query/{id}"=>{"get"=>{"summary"=>"Get Version Query", "description"=>"Retrieves the remaining SOQL query results using the identifier within the field \"nextRecordsUrl\" value (i.e. \"nextRecordsUrl\" : \"/services/data/v24.0/query/01gD0000002HU6KIAW-2000\") located at the end of the initial query results. Requests the next batch of records and you could repeat (using the corresponding identifier) until all records have been retrieved.", "operationId"=>"getVersionQuery", "x-api-path-slug"=>"versionqueryid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"An identifier used to retrieve the remaining results"}, {"in"=>"path", "name"=>"version", "description"=>"An API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Query"]}}, "/{version}/search"=>{"get"=>{"summary"=>"Get Version Search", "description"=>"Executes the specified SOSL search. The search string must be URL-encoded.", "operationId"=>"getVersionSearch", "x-api-path-slug"=>"versionsearch-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"A SOSL statement"}, {"in"=>"path", "name"=>"version", "description"=>"An API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Search"]}}}}, "apis"=>{"name"=>"Salesforce", "x-slug"=>"salesforce", "description"=>"Build more meaningful and lasting relationships and connect with your customers across sales, customer service, marketing, communities, apps, analytics, and more using our Customer Success Platform. Try for Free.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/175-salesforce.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"146", "tags"=>"BaaS,CRM,Customers,Databases,Enterprise,Freshbooks,Hosting,internet,Notifications,PaaS,Productivity,Relative Data,SaaS,Sales,SDIO Partner,Service API,Spreadsheets,Stack,Stack Network,Technology,Wearables", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"salesforce/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"SalesForce", "x-api-slug"=>"salesforce", "description"=>"Build more meaningful and lasting relationships and connect with your customers across sales, customer service, marketing, communities, apps, analytics, and more using our Customer Success Platform. Try for Free.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/175-salesforce.jpg", "humanURL"=>"http://developer.salesforce.com", "baseURL"=>"https://na14.salesforce.com//services/data", "tags"=>"BaaS,CRM,Customers,Databases,Enterprise,Freshbooks,Hosting,internet,Notifications,PaaS,Productivity,Relative Data,SaaS,Sales,SDIO Partner,Service API,Spreadsheets,Stack,Stack Network,Technology,Wearables", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/salesforce/salesforce-openapi.yaml"}]}, {"name"=>"Salesforce Sandbox", "x-api-slug"=>"salesforce-sandbox", "description"=>"Build more meaningful and lasting relationships and connect with your customers across sales, customer service, marketing, communities, apps, analytics, and more using our Customer Success Platform. Try for Free.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/175-salesforce.jpg", "humanURL"=>"http://developer.salesforce.com", "baseURL"=>"https://na14.salesforce.com//services/data/", "tags"=>"Version, Search", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/salesforce/versionsearch-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/salesforce/salesforce-sandbox-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://developer.salesforce.com"}, {"type"=>"x-base", "url"=>"https://na1.salesforce.com"}, {"type"=>"x-blog", "url"=>"https://developer.salesforce.com/blogs/"}, {"type"=>"x-blog-rss", "url"=>"http://feeds.feedburner.com/SforceBlog"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/salesforce"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/salesforce"}, {"type"=>"x-email", "url"=>"legal@salesforce.com"}, {"type"=>"x-email", "url"=>"copyright@salesforce.com"}, {"type"=>"x-email", "url"=>"legalcompliance@salesforce.com"}, {"type"=>"x-email", "url"=>"trademarks@salesforce.com"}, {"type"=>"x-email", "url"=>"privacymark@salesforce.com"}, {"type"=>"x-email", "url"=>"marketingcloudsupport@salesforce.com"}, {"type"=>"x-email", "url"=>"support@desk.com"}, {"type"=>"x-email", "url"=>"credits@salesforce.com"}, {"type"=>"x-email", "url"=>"privacy@salesforce.com"}, {"type"=>"x-github", "url"=>"https://github.com/salesforce"}, {"type"=>"x-partners", "url"=>"https://partners.salesforce.com/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/salesforcedevs"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/salesforce"}, {"type"=>"x-website", "url"=>"http://salesforce.com"}, {"type"=>"x-website", "url"=>"https://developer.salesforce.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
wordnik{"wordnik-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Wordnik", "x-complete"=>1, "info"=>{"title"=>"Wordnik", "description"=>"wordnik-is-the-worlds-biggest-online-english-dictionary-by-number-of-words", "version"=>"4.0"}, "host"=>"api.wordnik.com", "basePath"=>"/v4", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/account.json/apiTokenStatus"=>{"get"=>{"summary"=>"Returns usage statistics for the API account.", "description"=>"Returns usage statistics for the api account..", "operationId"=>"getApiTokenStatus", "x-api-path-slug"=>"account-jsonapitokenstatus-get", "parameters"=>[{"in"=>"header", "name"=>"api_key", "description"=>"Wordnik authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "ApiTokenStatus"]}}, "/account.json/authenticate/{username}"=>{"get"=>{"summary"=>"Authenticates a User", "description"=>"Authenticates a user.", "operationId"=>"authenticate", "x-api-path-slug"=>"account-jsonauthenticateusername-get", "parameters"=>[{"in"=>"query", "name"=>"password", "description"=>"The users password"}, {"in"=>"path", "name"=>"username", "description"=>"A confirmed Wordnik username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Authenticate", "Username"]}, "post"=>{"summary"=>"Authenticates a user", "description"=>"Authenticates a user.", "operationId"=>"authenticatePost", "x-api-path-slug"=>"account-jsonauthenticateusername-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The users password", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"username", "description"=>"A confirmed Wordnik username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Authenticate", "Username"]}}, "/account.json/user"=>{"get"=>{"summary"=>"Returns the logged-in User", "description"=>"Requires a valid auth_token to be set.", "operationId"=>"getLoggedInUser", "x-api-path-slug"=>"account-jsonuser-get", "parameters"=>[{"in"=>"header", "name"=>"auth_token", "description"=>"The auth token of the logged-in user, obtained by calling /account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "User"]}}, "/account.json/wordLists"=>{"get"=>{"summary"=>"Fetches WordList objects for the logged-in user.", "description"=>"Fetches wordlist objects for the logged-in user..", "operationId"=>"getWordListsForLoggedInUser", "x-api-path-slug"=>"account-jsonwordlists-get", "parameters"=>[{"in"=>"header", "name"=>"auth_token", "description"=>"auth_token of logged-in user"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"skip", "description"=>"Results to skip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Words", "Lists"]}}, "/word.json/{word}"=>{"get"=>{"summary"=>"Given a word as a string, returns the WordObject that represents it", "description"=>"Given a word as a string, returns the wordobject that represents it.", "operationId"=>"getWord", "x-api-path-slug"=>"word-jsonword-get", "parameters"=>[{"in"=>"query", "name"=>"includeSuggestions", "description"=>"Return suggestions (for correct spelling, case variants, etc"}, {"in"=>"query", "name"=>"useCanonical", "description"=>"If true will try to return the correct word root (cats -> cat)"}, {"in"=>"path", "name"=>"word", "description"=>"String value of WordObject to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words"]}}, "/word.json/{word}/audio"=>{"get"=>{"summary"=>"Fetches audio metadata for a word.", "description"=>"The metadata includes a time-expiring fileUrl which allows reading the audio file directly from the API. Currently only audio pronunciations from the American Heritage Dictionary in mp3 format are supported.", "operationId"=>"getAudio", "x-api-path-slug"=>"word-jsonwordaudio-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"useCanonical", "description"=>"Use the canonical form of the word"}, {"in"=>"path", "name"=>"word", "description"=>"Word to get audio for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words", "Audio"]}}, "/word.json/{word}/definitions"=>{"get"=>{"summary"=>"Return definitions for a word", "description"=>"Return definitions for a word.", "operationId"=>"getDefinitions", "x-api-path-slug"=>"word-jsonworddefinitions-get", "parameters"=>[{"in"=>"query", "name"=>"includeRelated", "description"=>"Return related words with definitions"}, {"in"=>"query", "name"=>"includeTags", "description"=>"Return a closed set of XML tags in response"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"partOfSpeech", "description"=>"CSV list of part-of-speech types"}, {"in"=>"query", "name"=>"sourceDictionaries", "description"=>"Source dictionary to return definitions from"}, {"in"=>"query", "name"=>"useCanonical", "description"=>"If true will try to return the correct word root (cats -> cat)"}, {"in"=>"path", "name"=>"word", "description"=>"Word to return definitions for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words", "Definitions"]}}, "/word.json/{word}/etymologies"=>{"get"=>{"summary"=>"Fetches etymology data", "description"=>"Fetches etymology data.", "operationId"=>"getEtymologies", "x-api-path-slug"=>"word-jsonwordetymologies-get", "parameters"=>[{"in"=>"query", "name"=>"useCanonical", "description"=>"If true will try to return the correct word root (cats -> cat)"}, {"in"=>"path", "name"=>"word", "description"=>"Word to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words", "Etymologies"]}}, "/word.json/{word}/examples"=>{"get"=>{"summary"=>"Returns examples for a word", "description"=>"Returns examples for a word.", "operationId"=>"getExamples", "x-api-path-slug"=>"word-jsonwordexamples-get", "parameters"=>[{"in"=>"query", "name"=>"includeDuplicates", "description"=>"Show duplicate examples from different sources"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"skip", "description"=>"Results to skip"}, {"in"=>"query", "name"=>"useCanonical", "description"=>"If true will try to return the correct word root (cats -> cat)"}, {"in"=>"path", "name"=>"word", "description"=>"Word to return examples for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words", "Examples"]}}, "/word.json/{word}/frequency"=>{"get"=>{"summary"=>"Returns word usage over time", "description"=>"Returns word usage over time.", "operationId"=>"getWordFrequency", "x-api-path-slug"=>"word-jsonwordfrequency-get", "parameters"=>[{"in"=>"query", "name"=>"endYear", "description"=>"Ending Year"}, {"in"=>"query", "name"=>"startYear", "description"=>"Starting Year"}, {"in"=>"query", "name"=>"useCanonical", "description"=>"If true will try to return the correct word root (cats -> cat)"}, {"in"=>"path", "name"=>"word", "description"=>"Word to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words", "Frequency"]}}, "/word.json/{word}/hyphenation"=>{"get"=>{"summary"=>"Returns syllable information for a word", "description"=>"Returns syllable information for a word.", "operationId"=>"getHyphenation", "x-api-path-slug"=>"word-jsonwordhyphenation-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"sourceDictionary", "description"=>"Get from a single dictionary"}, {"in"=>"query", "name"=>"useCanonical", "description"=>"If true will try to return a correct word root (cats -> cat)"}, {"in"=>"path", "name"=>"word", "description"=>"Word to get syllables for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words", "Hyphenation"]}}, "/word.json/{word}/phrases"=>{"get"=>{"summary"=>"Fetches bi-gram phrases for a word", "description"=>"Fetches bi-gram phrases for a word.", "operationId"=>"getPhrases", "x-api-path-slug"=>"word-jsonwordphrases-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"useCanonical", "description"=>"If true will try to return the correct word root (cats -> cat)"}, {"in"=>"query", "name"=>"wlmi", "description"=>"Minimum WLMI for the phrase"}, {"in"=>"path", "name"=>"word", "description"=>"Word to fetch phrases for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words", "Phrases"]}}, "/word.json/{word}/pronunciations"=>{"get"=>{"summary"=>"Returns text pronunciations for a given word", "description"=>"Returns text pronunciations for a given word.", "operationId"=>"getTextPronunciations", "x-api-path-slug"=>"word-jsonwordpronunciations-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"sourceDictionary", "description"=>"Get from a single dictionary"}, {"in"=>"query", "name"=>"typeFormat", "description"=>"Text pronunciation type"}, {"in"=>"query", "name"=>"useCanonical", "description"=>"If true will try to return a correct word root (cats -> cat)"}, {"in"=>"path", "name"=>"word", "description"=>"Word to get pronunciations for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words", "Pronunciations"]}}, "/word.json/{word}/relatedWords"=>{"get"=>{"summary"=>"Given a word as a string, returns relationships from the Word Graph", "description"=>"Given a word as a string, returns relationships from the word graph.", "operationId"=>"getRelatedWords", "x-api-path-slug"=>"word-jsonwordrelatedwords-get", "parameters"=>[{"in"=>"query", "name"=>"limitPerRelationshipType", "description"=>"Restrict to the supplied relationship types"}, {"in"=>"query", "name"=>"relationshipTypes", "description"=>"Limits the total results per type of relationship type"}, {"in"=>"query", "name"=>"useCanonical", "description"=>"If true will try to return the correct word root (cats -> cat)"}, {"in"=>"path", "name"=>"word", "description"=>"Word to fetch relationships for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words", "RelatedWords"]}}, "/word.json/{word}/topExample"=>{"get"=>{"summary"=>"Returns a top example for a word", "description"=>"Returns a top example for a word.", "operationId"=>"getTopExample", "x-api-path-slug"=>"word-jsonwordtopexample-get", "parameters"=>[{"in"=>"query", "name"=>"useCanonical", "description"=>"If true will try to return the correct word root (cats -> cat)"}, {"in"=>"path", "name"=>"word", "description"=>"Word to fetch examples for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words", "TopExample"]}}, "/wordList.json/{permalink}"=>{"delete"=>{"summary"=>"Deletes an existing WordList", "description"=>"Deletes an existing wordlist.", "operationId"=>"deleteWordList", "x-api-path-slug"=>"wordlist-jsonpermalink-delete", "parameters"=>[{"in"=>"header", "name"=>"auth_token", "description"=>"The auth token of the logged-in user, obtained by calling /account"}, {"in"=>"path", "name"=>"permalink", "description"=>"ID of WordList to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WordList", "Permalink"]}, "get"=>{"summary"=>"Fetches a WordList by ID", "description"=>"Fetches a wordlist by id.", "operationId"=>"getWordListByPermalink", "x-api-path-slug"=>"wordlist-jsonpermalink-get", "parameters"=>[{"in"=>"header", "name"=>"auth_token", "description"=>"The auth token of the logged-in user, obtained by calling /account"}, {"in"=>"path", "name"=>"permalink", "description"=>"permalink of WordList to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WordList", "Permalink"]}, "put"=>{"summary"=>"Updates an existing WordList", "description"=>"Updates an existing wordlist.", "operationId"=>"updateWordList", "x-api-path-slug"=>"wordlist-jsonpermalink-put", "parameters"=>[{"in"=>"header", "name"=>"auth_token", "description"=>"The auth token of the logged-in user, obtained by calling /account"}, {"in"=>"body", "name"=>"body", "description"=>"Updated WordList", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"permalink", "description"=>"permalink of WordList to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WordList", "Permalink"]}}, "/wordList.json/{permalink}/deleteWords"=>{"post"=>{"summary"=>"Removes words from a WordList", "description"=>"Removes words from a wordlist.", "operationId"=>"deleteWordsFromWordList", "x-api-path-slug"=>"wordlist-jsonpermalinkdeletewords-post", "parameters"=>[{"in"=>"header", "name"=>"auth_token", "description"=>"The auth token of the logged-in user, obtained by calling /account"}, {"in"=>"body", "name"=>"body", "description"=>"Words to remove from WordList", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"permalink", "description"=>"permalink of WordList to use"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WordList", "Permalink", "DeleteWords"]}}, "/wordList.json/{permalink}/words"=>{"get"=>{"summary"=>"Fetches words in a WordList", "description"=>"Fetches words in a wordlist.", "operationId"=>"getWordListWords", "x-api-path-slug"=>"wordlist-jsonpermalinkwords-get", "parameters"=>[{"in"=>"header", "name"=>"auth_token", "description"=>"The auth token of the logged-in user, obtained by calling /account"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return"}, {"in"=>"path", "name"=>"permalink", "description"=>"ID of WordList to use"}, {"in"=>"query", "name"=>"skip", "description"=>"Results to skip"}, {"in"=>"query", "name"=>"sortBy", "description"=>"Field to sort by"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Direction to sort"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WordList", "Permalink", "Words"]}, "post"=>{"summary"=>"Adds words to a WordList", "description"=>"Adds words to a wordlist.", "operationId"=>"addWordsToWordList", "x-api-path-slug"=>"wordlist-jsonpermalinkwords-post", "parameters"=>[{"in"=>"header", "name"=>"auth_token", "description"=>"The auth token of the logged-in user, obtained by calling /account"}, {"in"=>"body", "name"=>"body", "description"=>"Array of words to add to WordList", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"permalink", "description"=>"permalink of WordList to user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WordList", "Permalink", "Words"]}}, "/wordLists.json"=>{"post"=>{"summary"=>"Creates a WordList.", "description"=>"Creates a wordlist..", "operationId"=>"createWordList", "x-api-path-slug"=>"wordlists-json-post", "parameters"=>[{"in"=>"header", "name"=>"auth_token", "description"=>"The auth token of the logged-in user, obtained by calling /account"}, {"in"=>"body", "name"=>"body", "description"=>"WordList to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words", "Lists"]}}, "/words.json/randomWord"=>{"get"=>{"summary"=>"Returns a single random WordObject", "description"=>"Returns a single random wordobject.", "operationId"=>"getRandomWord", "x-api-path-slug"=>"words-jsonrandomword-get", "parameters"=>[{"in"=>"query", "name"=>"excludePartOfSpeech", "description"=>"CSV part-of-speech values to exclude"}, {"in"=>"query", "name"=>"hasDictionaryDef", "description"=>"Only return words with dictionary definitions"}, {"in"=>"query", "name"=>"includePartOfSpeech", "description"=>"CSV part-of-speech values to include"}, {"in"=>"query", "name"=>"maxCorpusCount", "description"=>"Maximum corpus frequency for terms"}, {"in"=>"query", "name"=>"maxDictionaryCount", "description"=>"Maximum dictionary count"}, {"in"=>"query", "name"=>"maxLength", "description"=>"Maximum word length"}, {"in"=>"query", "name"=>"minCorpusCount", "description"=>"Minimum corpus frequency for terms"}, {"in"=>"query", "name"=>"minDictionaryCount", "description"=>"Minimum dictionary count"}, {"in"=>"query", "name"=>"minLength", "description"=>"Minimum word length"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words", "RandomWord"]}}, "/words.json/randomWords"=>{"get"=>{"summary"=>"Returns an array of random WordObjects", "description"=>"Returns an array of random wordobjects.", "operationId"=>"getRandomWords", "x-api-path-slug"=>"words-jsonrandomwords-get", "parameters"=>[{"in"=>"query", "name"=>"excludePartOfSpeech", "description"=>"CSV part-of-speech values to exclude"}, {"in"=>"query", "name"=>"hasDictionaryDef", "description"=>"Only return words with dictionary definitions"}, {"in"=>"query", "name"=>"includePartOfSpeech", "description"=>"CSV part-of-speech values to include"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"maxCorpusCount", "description"=>"Maximum corpus frequency for terms"}, {"in"=>"query", "name"=>"maxDictionaryCount", "description"=>"Maximum dictionary count"}, {"in"=>"query", "name"=>"maxLength", "description"=>"Maximum word length"}, {"in"=>"query", "name"=>"minCorpusCount", "description"=>"Minimum corpus frequency for terms"}, {"in"=>"query", "name"=>"minDictionaryCount", "description"=>"Minimum dictionary count"}, {"in"=>"query", "name"=>"minLength", "description"=>"Minimum word length"}, {"in"=>"query", "name"=>"sortBy", "description"=>"Attribute to sort by"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Sort direction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words", "RandomWords"]}}, "/words.json/reverseDictionary"=>{"get"=>{"summary"=>"Reverse dictionary search", "description"=>"Reverse dictionary search.", "operationId"=>"reverseDictionary", "x-api-path-slug"=>"words-jsonreversedictionary-get", "parameters"=>[{"in"=>"query", "name"=>"excludePartOfSpeech", "description"=>"Exclude these comma-delimited parts of speech"}, {"in"=>"query", "name"=>"excludeSourceDictionaries", "description"=>"Exclude these comma-delimited source dictionaries"}, {"in"=>"query", "name"=>"expandTerms", "description"=>"Expand terms"}, {"in"=>"query", "name"=>"findSenseForWord", "description"=>"Restricts words and finds closest sense"}, {"in"=>"query", "name"=>"includePartOfSpeech", "description"=>"Only include these comma-delimited parts of speech"}, {"in"=>"query", "name"=>"includeSourceDictionaries", "description"=>"Only include these comma-delimited source dictionaries"}, {"in"=>"query", "name"=>"includeTags", "description"=>"Return a closed set of XML tags in response"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"maxCorpusCount", "description"=>"Maximum corpus frequency for terms"}, {"in"=>"query", "name"=>"maxLength", "description"=>"Maximum word length"}, {"in"=>"query", "name"=>"minCorpusCount", "description"=>"Minimum corpus frequency for terms"}, {"in"=>"query", "name"=>"minLength", "description"=>"Minimum word length"}, {"in"=>"query", "name"=>"query", "description"=>"Search term"}, {"in"=>"query", "name"=>"skip", "description"=>"Results to skip"}, {"in"=>"query", "name"=>"sortBy", "description"=>"Attribute to sort by"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Sort direction"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words", "ReverseDictionary"]}}, "/words.json/search/{query}"=>{"get"=>{"summary"=>"Searches words", "description"=>"Searches words.", "operationId"=>"searchWords", "x-api-path-slug"=>"words-jsonsearchquery-get", "parameters"=>[{"in"=>"query", "name"=>"caseSensitive", "description"=>"Search case sensitive"}, {"in"=>"query", "name"=>"excludePartOfSpeech", "description"=>"Exclude these comma-delimited parts of speech"}, {"in"=>"query", "name"=>"includePartOfSpeech", "description"=>"Only include these comma-delimited parts of speech"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"maxCorpusCount", "description"=>"Maximum corpus frequency for terms"}, {"in"=>"query", "name"=>"maxDictionaryCount", "description"=>"Maximum dictionary definition count"}, {"in"=>"query", "name"=>"maxLength", "description"=>"Maximum word length"}, {"in"=>"query", "name"=>"minCorpusCount", "description"=>"Minimum corpus frequency for terms"}, {"in"=>"query", "name"=>"minDictionaryCount", "description"=>"Minimum number of dictionary entries for words returned"}, {"in"=>"query", "name"=>"minLength", "description"=>"Minimum word length"}, {"in"=>"path", "name"=>"query", "description"=>"Search query"}, {"in"=>"query", "name"=>"skip", "description"=>"Results to skip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words", "Search", "Query"]}}, "/words.json/wordOfTheDay"=>{"get"=>{"summary"=>"Returns a specific WordOfTheDay", "description"=>"Returns a specific wordoftheday.", "operationId"=>"getWordOfTheDay", "x-api-path-slug"=>"words-jsonwordoftheday-get", "parameters"=>[{"in"=>"query", "name"=>"date", "description"=>"Fetches by date in yyyy-MM-dd"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Words", "WordOfTheDay"]}}}}, "apis"=>{"name"=>"Wordnik", "x-slug"=>"wordnik", "description"=>"Wordnik is an online English dictionary and language resource that provides dictionary and thesaurus content, some of it based on print dictionaries such as the Century Dictionary, the American Heritage Dictionary, WordNet, and GCIDE. Wordnik has collected a corpus of billions of words which it uses to display example sentences, allowing it to provide information on a much larger set of words than a typical dictionary.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2708-wordnik.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"46540", "tags"=>"Content,Dictionary,General Data,internet,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"wordnik/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Wordnik", "x-api-slug"=>"wordnik", "description"=>"The Wordnik API lets you request definitions, example sentences, spelling suggestions, related words like synonyms and antonyms, phrases containing a given word, word autocompletion, random words, words of the day, and much more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2708-wordnik.jpg", "humanURL"=>"http://wordnik.com", "baseURL"=>"https://api.wordnik.com//v4", "tags"=>"Content,Dictionary,General Data,internet,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/wordnik/wordnik-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/wordnik"}, {"type"=>"x-developer", "url"=>"http://developer.wordnik.com/"}, {"type"=>"x-documentation", "url"=>"http://developer.wordnik.com/docs.html"}, {"type"=>"x-email", "url"=>"feedback@wordnik.com"}, {"type"=>"x-email", "url"=>"support@wordnik.com"}, {"type"=>"x-email", "url"=>"privacy@wordnik.com"}, {"type"=>"x-email", "url"=>"dmca@wordnik.com"}, {"type"=>"x-github", "url"=>"https://github.com/wordnik"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/wordnik"}, {"type"=>"x-website", "url"=>"http://wordnik.com"}, {"type"=>"x-website", "url"=>"https://www.wordnik.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
quandl{"quandl-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Quandl", "x-complete"=>1, "info"=>{"title"=>"Quandl", "description"=>"the-quandl-api", "version"=>"1.0.0"}, "host"=>"www.quandl.com", "basePath"=>"/api/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/datasets/{database_code}/{dataset_code}/metadata"=>{"get"=>{"summary"=>"Get Datasets Database Code Dataset Code Metadata", "description"=>"To download the metadata associated with any dataset object, append /metadata to your API request. (You can replace .csv with .json or .xml in this request). The following metadata fields are available in the response:", "operationId"=>"datasets.database_code.dataset_code.metadata.get", "x-api-path-slug"=>"datasetsdatabase-codedataset-codemetadata-get", "parameters"=>[{"in"=>"query", "name"=>"column_names"}, {"in"=>"path", "name"=>"database_code", "description"=>"The unique database code on Quandl (ex"}, {"in"=>"path", "name"=>"dataset_code", "description"=>"The unique dataset code on Quandl (ex"}, {"in"=>"query", "name"=>"description"}, {"in"=>"query", "name"=>"frequency"}, {"in"=>"query", "name"=>"name"}, {"in"=>"query", "name"=>"newest_available_date"}, {"in"=>"query", "name"=>"oldest_available_date"}, {"in"=>"query", "name"=>"premium"}, {"in"=>"query", "name"=>"refreshed_at"}, {"in"=>"query", "name"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Datasets", "Database", "Code", "Dataset", "Code", "Metadata"]}}, "/datasets/{database_code}/{dataset_code}/data"=>{"get"=>{"summary"=>"Get Datasets Database Code Dataset Code Data", "description"=>"To download the data in a dataset, simply append /data to the Quandl code in your API request. (You can replace .csv with .json or .xml in this request). If you request CSV, only the data you requested will be returned. If you request JSON or XML, both data and input parameters will be returned. You can customize the dataset object being returned by adding various optional parameters to your query. Available parameters are tabulated below: If a datapoint for time t is denoted as y[t] and the transformed data as y???[t], the available transformations are defined as below: y[0] in the above table refers to the starting date for the API call, i.e., the date specified by start_date= or rows=, NOT the starting date of the underlying dataset.", "operationId"=>"datasets.database_code.dataset_code.data.get", "x-api-path-slug"=>"datasetsdatabase-codedataset-codedata-get", "parameters"=>[{"in"=>"query", "name"=>"collapse", "description"=>"Parameters to indicate the desired frequency"}, {"in"=>"query", "name"=>"column_index", "description"=>"Request a specific column by passing the column_index=n parameter"}, {"in"=>"query", "name"=>"Cumulative", "description"=>"y???[t] = y[t] +y[t-1] + ??? + y[0]"}, {"in"=>"path", "name"=>"database_code", "description"=>"Each database on Quandl has a unique database code"}, {"in"=>"path", "name"=>"dataset_code", "description"=>"Each dataset on Quandl has a unique dataset code"}, {"in"=>"query", "name"=>"end_date", "description"=>"Retrieve data within a specific date range, by setting end dates for your query"}, {"in"=>"query", "name"=>"limit", "description"=>"You can use limit=n to get only the first n rows of your dataset"}, {"in"=>"query", "name"=>"order", "description"=>"Select the sort order by passing the parameter order=asc|desc"}, {"in"=>"query", "name"=>"Row-on-row", "description"=>"y???[t] = y[t] - y[t-1]"}, {"in"=>"query", "name"=>"rows", "description"=>"You can use rows=n to get only the first n rows of your dataset"}, {"in"=>"query", "name"=>"Start", "description"=>"y???[t] = (y[t]/y[0]) * 100"}, {"in"=>"query", "name"=>"start_date", "description"=>"Retrieve data within a specific date range, by setting start dates for your query"}, {"in"=>"query", "name"=>"transform", "description"=>"Perform calculations on your data prior to downloading"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Datasets", "Database", "Code", "Dataset", "Code", "Data"]}}, "/datasets/{database_code}/{dataset_code}"=>{"get"=>{"summary"=>"Get Datasets Database Code Dataset Code", "description"=>"You can download both data and metadata in a single call, using the following API request. (You can replace .json with .csv or .xml in this request. If you use .csv, only data will be returned.). In this call, you can customize the dataset object being returned, exactly as in the /data request above.", "operationId"=>"datasets.database_code.dataset_code.get", "x-api-path-slug"=>"datasetsdatabase-codedataset-code-get", "parameters"=>[{"in"=>"query", "name"=>"collapse", "description"=>"Parameters to indicate the desired frequency"}, {"in"=>"query", "name"=>"column_index", "description"=>"Request a specific column by passing the column_index=n parameter"}, {"in"=>"path", "name"=>"database_code", "description"=>"Each database on Quandl has a unique database code"}, {"in"=>"path", "name"=>"dataset_code", "description"=>"Each dataset on Quandl has a unique dataset code"}, {"in"=>"query", "name"=>"end_date", "description"=>"Retrieve data within a specific date range, by setting end dates for your query"}, {"in"=>"query", "name"=>"exclude_column_names", "description"=>"Request data without column names by passing the exclude_column_names=true parameter"}, {"in"=>"query", "name"=>"limit", "description"=>"You can use limit=n to get only the first n rows of your dataset"}, {"in"=>"query", "name"=>"order", "description"=>"You can select the sort order by passing the parameter order=asc|desc"}, {"in"=>"query", "name"=>"rows", "description"=>"You can use rows=n to get only the first n rows of your dataset"}, {"in"=>"query", "name"=>"start_date", "description"=>"Retrieve data within a specific date range, by setting start for your query"}, {"in"=>"query", "name"=>"transform", "description"=>"Perform calculations on your data prior to downloading"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Datasets", "Database", "Code", "Dataset", "Code"]}}, "/datasets"=>{"get"=>{"summary"=>"Get Datasets", "description"=>"You can search for individual datasets on Quandl by making the following API request. The API will return datasets related to your query, as well as datasets that belong to databases related to your query. Datasets are returned 100 results at a time. You can page through the results using these parameters:", "operationId"=>"datasets.get", "x-api-path-slug"=>"datasets-get", "parameters"=>[{"in"=>"query", "name"=>"database_code", "description"=>"You can restrict your search to a specific database by including a Quandl database code"}, {"in"=>"query", "name"=>"page", "description"=>"The current page of total available pages you wish to view"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of results per page that will be returned"}, {"in"=>"query", "name"=>"query", "description"=>"You can retrieve all datasets related to a search term using the query parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Datasets"]}}, "/databases/{database_code}/data"=>{"get"=>{"summary"=>"Get Databases Database Code Data", "description"=>"You can download all the data in a premium database in a single call, by appending /data to your database request. You can specify whether you want the entire history, or merely the last day???s worth of updates, by setting the correct query parameters.", "operationId"=>"databases.database_code.data.get", "x-api-path-slug"=>"databasesdatabase-codedata-get", "parameters"=>[{"in"=>"path", "name"=>"database_code", "description"=>"The unique database code on Quandl (ex"}, {"in"=>"query", "name"=>"download_type", "description"=>"Data returned can be either partial or complete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Databases", "Database", "Code", "Data"]}}, "/databases/{database_code}/codes"=>{"get"=>{"summary"=>"Get Databases Database Code Codes", "description"=>"You can download a list of all dataset codes in a database in a single call, by appending /codes to your database request. The call will return a ZIP file containing a CSV.", "operationId"=>"databases.database_code.codes.get", "x-api-path-slug"=>"databasesdatabase-codecodes-get", "parameters"=>[{"in"=>"path", "name"=>"database_code", "description"=>"The unique database code on Quandl (ex"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Databases", "Database", "Code", "Codes"]}}, "/databases/{database_code}"=>{"get"=>{"summary"=>"Get Databases Database Code", "description"=>"This call returns descriptive metadata for the specified database.", "operationId"=>"databases.database_code.get", "x-api-path-slug"=>"databasesdatabase-code-get", "parameters"=>[{"in"=>"path", "name"=>"database_code", "description"=>"The unique database code on Quandl (ex"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Databases", "Database", "Code"]}}, "/databases"=>{"get"=>{"summary"=>"Get Databases", "description"=>"You can search for specific databases on Quandl by making the following API request. The API will return databases related to your query. Databases are returned 100 results at a time. You can page through the results using these parameters:", "operationId"=>"databases.get", "x-api-path-slug"=>"databases-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The current page of total available pages you wish to view"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of results per page that will be returned"}, {"in"=>"query", "name"=>"query", "description"=>"You can retrieve all databases related to a search term using the query parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Databases"]}}}}, "apis"=>{"name"=>"Quandl", "x-slug"=>"quandl", "description"=>"Quandl delivers financial data to users in the format they want. Access thousands of databases via the Quandl API or in your tool of choice.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11440-quandl.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"53781", "tags"=>"Data,Enterprise,Finance,Finance,General Data,Have API Key,Imports,internet,Market Data,Relative Data,SaaS,Service API,Sign In With Github,Sign In With Google,Sign In With LinkedIn,Stack Network,Target,Technology,Visualizations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"quandl/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Quandl", "x-api-slug"=>"quandl", "description"=>"Quandl delivers financial data to users in the format they want. Access thousands of databases via the Quandl API or in your tool of choice.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11440-quandl.jpg", "humanURL"=>"http://quandl.com", "baseURL"=>"https://www.quandl.com//api/v3", "tags"=>"Data,Enterprise,Finance,Finance,General Data,Have API Key,Imports,internet,Market Data,Relative Data,SaaS,Service API,Sign In With Github,Sign In With Google,Sign In With LinkedIn,Stack Network,Target,Technology,Visualizations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/quandl/databases-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/quandl/quandl-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://docs.quandl.com/docs#section-authentication"}, {"type"=>"x-blog", "url"=>"http://blog.quandl.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.quandl.com/feed/"}, {"type"=>"x-branding", "url"=>"https://www.quandl.com/brand-guidelines"}, {"type"=>"x-contact-form", "url"=>"https://www.quandl.com/contact"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/quandl"}, {"type"=>"x-documentation", "url"=>"https://docs.quandl.com/"}, {"type"=>"x-errors", "url"=>"https://docs.quandl.com/docs/error-codes"}, {"type"=>"x-getting-started", "url"=>"https://docs.quandl.com/docs/getting-started"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/2459204/?trk=tyah&trkInfo=clickedVertical%3Acompany%2CclickedEntityId%3A2459204%2Cidx%3A2-1-2%2CtarId%3A1479320490204%2Ctas%3Aquandl"}, {"type"=>"x-login", "url"=>"https://www.quandl.com/?modal=login"}, {"type"=>"x-press", "url"=>"https://www.quandl.com/press"}, {"type"=>"x-spreadsheets", "url"=>"https://docs.quandl.com/docs/excel-add-in"}, {"type"=>"x-status", "url"=>"http://status.quandl.com/"}, {"type"=>"x-support", "url"=>"https://docs.quandl.com/docs/contact-support"}, {"type"=>"x-terms-of-service", "url"=>"https://www.quandl.com/terms"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/quandl"}, {"type"=>"x-website", "url"=>"http://quandl.com"}, {"type"=>"x-website", "url"=>"https://www.quandl.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
mapquest{"mapquest-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"MapQuest", "x-complete"=>1, "info"=>{"title"=>"MapQuest Search API: Place Search", "description"=>"place-search-is-a-spatiallyaware-search-engine-most-commonly-used-to-return-point-of-interest-poi-results-near-a-geographic-point-of-reference-or-within-a-geographic-boundary-such-as-find-all-coffee-shops-within-the-extent-of-the-current-map--results-can-be-ordered-by-distance-or-relevance--this-api-complements-the-search-ahead-api-by-performing-the-backend-search-necessary-to-fulfill-category-or-franchise-requests-", "version"=>"1.0.0"}, "host"=>"www.mapquestapi.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/search/v4/place"=>{"get"=>{"summary"=>"Search for places with optional geographic and categorical contexts.", "description"=>"Get a list of search results ordered by relevance or distance from a spatial reference point, optionally filtered by category, and optionally bounded within a geographic constraint.", "operationId"=>"get-a-list-of-search-results-ordered-by-relevance-or-distance-from-a-spatial-reference-point-optiona", "x-api-path-slug"=>"searchv4place-get", "parameters"=>[{"in"=>"query", "name"=>"bbox", "description"=>"A geographic rectangle used to bound the search"}, {"in"=>"query", "name"=>"category", "description"=>"The categories of places to search over"}, {"in"=>"query", "name"=>"circle", "description"=>"A geographic circle used to bound the search"}, {"in"=>"query", "name"=>"corridor", "description"=>"A collection of points defining a route used for the search"}, {"in"=>"query", "name"=>"feedback"}, {"in"=>"query", "name"=>"key", "description"=>"A valid and authorized MapQuest API key"}, {"in"=>"query", "name"=>"limit", "description"=>"(Deprecated"}, {"in"=>"query", "name"=>"location", "description"=>"A geographic context used for searching, ranking, and ordering results"}, {"in"=>"query", "name"=>"page", "description"=>"The page within the result set to return, where pageSize determines the page size"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The number of results to return per page"}, {"in"=>"query", "name"=>"q", "description"=>"A query phrase"}, {"in"=>"query", "name"=>"sort", "description"=>"The scheme used to order results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mapping", "Places"]}}}}, "apis"=>{"name"=>"MapQuest", "x-slug"=>"mapquest", "description"=>"Official MapQuest website, find driving directions, maps, live traffic updates and road conditions. Find nearby businesses, restaurants and hotels. Explore!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/365-mapquest.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"2843", "tags"=>"API Provider,Directions,Directions,Directions,Display,Display,Display,Display,Elevation,General Data,Geo,Geo,Geo,Geo,GPS,HTTP POST,internet,Locations,Locations,Mapping,Maps,Mobile,Navigation,Openstreetmap,Openstreetmap", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"mapquest/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"MapQuest", "x-api-slug"=>"mapquest", "description"=>"Official MapQuest website, find driving directions, maps, live traffic updates and road conditions. Find nearby businesses, restaurants and hotels. Explore!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/365-mapquest.jpg", "humanURL"=>"http://mapquest.com", "baseURL"=>"https://www.mapquestapi.com//", "tags"=>"API Provider,Directions,Directions,Directions,Display,Display,Display,Display,Elevation,General Data,Geo,Geo,Geo,Geo,GPS,HTTP POST,internet,Locations,Locations,Mapping,Maps,Mobile,Navigation,Openstreetmap,Openstreetmap", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/mapquest/searchv4place-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/mapquest/mapquest-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://open.mapquestapi.com/s"}, {"type"=>"x-blog", "url"=>"http://blog.mapquest.com"}, {"type"=>"x-blog-rss", "url"=>"http://blog.mapquest.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/mapquest"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/mapquest"}, {"type"=>"x-developer", "url"=>"https://developer.mapquest.com/"}, {"type"=>"x-developer", "url"=>"http://www.mapquestapi.com/"}, {"type"=>"x-documentation", "url"=>"https://developer.mapquest.com/documentation/"}, {"type"=>"x-github", "url"=>"https://github.com/MapQuest"}, {"type"=>"x-openapi", "url"=>"https://developer.mapquest.com/documentation/search-api/v4/swagger/search-v4-swagger.yaml"}, {"type"=>"x-pricing", "url"=>"https://developer.mapquest.com/plans"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/MapQuest"}, {"type"=>"x-website", "url"=>"http://mapquest.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
meetup{"meetup-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Meetup", "x-complete"=>1, "info"=>{"title"=>"Meetup", "description"=>"the-meetup-api-provides-simple-restful-http-and-streaming-interfaces-for-exploring-and-interacting-meetup-platform-from-your-own-apps--the-api-is-a-set-of-core-methods-and-a-common-request-format--these-are-combined-to-form-a-url-that-returns-the-information-you-want--", "version"=>"1.0.0"}, "host"=>"api.meetup.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/2/categories"=>{"get"=>{"summary"=>"Categories", "description"=>"Returns a list of Meetup group categories", "operationId"=>"categories", "x-api-path-slug"=>"2categories-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Parameter for requesting optional response properties", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Categories"]}}, "/dashboard"=>{"get"=>{"summary"=>"Dashboard", "description"=>"A dashboard of aggregated Meetup information for the authorized member", "operationId"=>"dashboard", "x-api-path-slug"=>"dashboard-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Request that additional fields (separated by commas) be included in the output", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Dashboard"]}}, "/2/topic_categories"=>{"get"=>{"summary"=>"Topic Categories", "description"=>"Returns a list of Meetup topic categories", "operationId"=>"topics", "x-api-path-slug"=>"2topic-categories-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Parameter for requesting optional response properties", "type"=>"string"}, {"in"=>"query", "name"=>"lat,lon,radius", "description"=>"Use a given lat/lon/radius (miles) to search best_topics for instead of using the members lat/lon", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Categories"]}}, "/topics"=>{"get"=>{"summary"=>"Topics", "description"=>"API method for accessing meetup topics", "operationId"=>"topics", "x-api-path-slug"=>"topics-get", "parameters"=>[{"in"=>"query", "name"=>"member_id", "description"=>"Return topics a target member is subscribed to", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"Return topics that match the specified name (e", "type"=>"string"}, {"in"=>"query", "name"=>"search", "description"=>"Return topics related to a list of search terms [separate search keywords with +s]", "type"=>"string"}, {"in"=>"query", "name"=>"topic", "description"=>"Return topics for this topic urlkey", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Topics"]}}, "/events"=>{"get"=>{"summary"=>"Events", "description"=>"Deprecated API method for accessing meetup events. Please see [/2/events](/meetup_api/docs/2/events/) and [/2/open_events](/meetup_api/docs/2/open_events/) for replacements.", "operationId"=>"deprecated", "x-api-path-slug"=>"events-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"Return events that start after the specified date, formatted as either a relative date such as -1w for one week ago or by absolute time in milliseconds since the epoch", "type"=>"string"}, {"in"=>"query", "name"=>"before", "description"=>"Return events that started before the specified date, formatted as described by the after parameter", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"Request that additional fields (separated by commas) be included in the output", "type"=>"string"}, {"in"=>"query", "name"=>"group_id", "description"=>"Return events from groups with the specified IDs, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"group_urlname", "description"=>"Return events for the group with this custom URL path", "type"=>"string"}, {"in"=>"query", "name"=>"id", "description"=>"Return events with the specified IDs, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"member_id", "description"=>"A member id number, limits results set to events in groups that the member specified by this id is currently a member of (excludes private groups, unless the member_id is the same as that of the member making the request)", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp_limit", "description"=>"The number of yes rsvps an event can have before members will be added to the waiting list", "type"=>"string"}, {"in"=>"query", "name"=>"status", "description"=>"Return events matching one of the given status values, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"text_format", "description"=>"Format of the description text, html, plain, or simplehtml", "type"=>"string"}, {"in"=>"query", "name"=>"topic", "description"=>"Return events in the specified topic(s), one topic allowed", "type"=>"string"}, {"in"=>"query", "name"=>"topic, groupnum", "description"=>"Return events for the group with given topic and number", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/2/open_events"=>{"get"=>{"summary"=>"OpenEvents", "description"=>"Searches for recent and upcoming public events hosted by Meetup groups. Its search window is the past one month through the next three months, and is subject to change. Open Events is optimized to search for current events by location, category, topic, or text, and only lists Meetups that have **3 or more RSVPs**. The number or results returned with each request is not guaranteed to be the same as the page size due to secondary filtering. If you're looking for a particular event or events within a particular group, use the standard [Events](/meetup_api/docs/2/events/) method.", "operationId"=>"events", "x-api-path-slug"=>"2open-events-get", "parameters"=>[{"in"=>"query", "name"=>"and_text", "description"=>"Changes the interpretation of the text field from ORd terms to ANDd terms", "type"=>"string"}, {"in"=>"query", "name"=>"api_version", "description"=>"2", "type"=>"string"}, {"in"=>"query", "name"=>"category", "description"=>"Return events in the specified category or categories specified by commas", "type"=>"string"}, {"in"=>"query", "name"=>"city", "description"=>"A valid city", "type"=>"string"}, {"in"=>"query", "name"=>"country", "description"=>"A valid country code", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"Request that additional fields (separated by commas) be included in the output", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"A valid latitude, limits the returned group events to those within radius miles", "type"=>"string"}, {"in"=>"query", "name"=>"limited_events", "description"=>"Include limited event information for private groups that wish to expose only a small amount of information about their events", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"A valid longitude, limits the returned group events to those within radius miles", "type"=>"string"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius, in miles for geographic requests, default 25", "type"=>"string"}, {"in"=>"query", "name"=>"since_count", "description"=>"Request that some number of recent messages be sent immediately, if available", "type"=>"string"}, {"in"=>"query", "name"=>"since_mtime", "description"=>"Return events with an mtime greater than the supplied time, in milliseconds since the epoch", "type"=>"string"}, {"in"=>"query", "name"=>"state", "description"=>"If searching in a country with states, a valid 2 character state code", "type"=>"string"}, {"in"=>"query", "name"=>"status", "description"=>"Status may be upcoming, past or both separated by a comma", "type"=>"string"}, {"in"=>"query", "name"=>"text", "description"=>"Events that contain the given term or terms somewhere in their content", "type"=>"string"}, {"in"=>"query", "name"=>"text_format", "description"=>"Format of the description text, html or plain", "type"=>"string"}, {"in"=>"query", "name"=>"time", "description"=>"Return events scheduled within the given time range, defined by two times separated with a single comma", "type"=>"string"}, {"in"=>"query", "name"=>"topic", "description"=>"Return events in the specified topic or topics specified by commas", "type"=>"string"}, {"in"=>"query", "name"=>"zip", "description"=>"A valid US zip code, limits the returned groups to those within radius miles", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/2/concierge"=>{"get"=>{"summary"=>"Concierge", "description"=>"Recommends upcoming meetups for the authorized member in a given location and in thier groups", "operationId"=>"events", "x-api-path-slug"=>"2concierge-get", "parameters"=>[{"in"=>"query", "name"=>"category_id", "description"=>"Comma delimited list of category ids to limit recommendations to", "type"=>"string"}, {"in"=>"query", "name"=>"city", "description"=>"A valid city", "type"=>"string"}, {"in"=>"query", "name"=>"country", "description"=>"A valid country code", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"Request that additional fields (separated by commas) be included in the output", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"A valid latitude, limits the returned group events to those within radius miles", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"A valid longitude, limits the returned group events to those within radius miles", "type"=>"string"}, {"in"=>"query", "name"=>"page_token", "description"=>"An opaque string used to page through results", "type"=>"string"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius, in miles for geographic requests, defaults to the members preferred radius or 0", "type"=>"string"}, {"in"=>"query", "name"=>"self_groups", "description"=>"set to include or exclude groups the authorized member belongs to", "type"=>"string"}, {"in"=>"query", "name"=>"state", "description"=>"If searching in a country with states, a valid 2 character state code", "type"=>"string"}, {"in"=>"query", "name"=>"text_format", "description"=>"Format of the description text, html, plain, or simplehtml", "type"=>"string"}, {"in"=>"query", "name"=>"time", "description"=>"Return events scheduled within the given time range, defined by two times separated with a single comma", "type"=>"string"}, {"in"=>"query", "name"=>"topic_id", "description"=>"Comma delimited list of topics to help inform recommendation", "type"=>"string"}, {"in"=>"query", "name"=>"with_friends", "description"=>"Boolean parameter", "type"=>"string"}, {"in"=>"query", "name"=>"zip", "description"=>"A valid US zip code, limits the returned groups to those within radius miles", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/2/groups"=>{"get"=>{"summary"=>"Groups", "description"=>"Fetch information about Meetup Groups.", "operationId"=>"groups", "x-api-path-slug"=>"2groups-get", "parameters"=>[{"in"=>"query", "name"=>"category_id", "description"=>"Only return groups in the specified category", "type"=>"string"}, {"in"=>"query", "name"=>"country, city, state", "description"=>"A valid country code, city and for the US, State", "type"=>"string"}, {"in"=>"query", "name"=>"domain", "description"=>"one or more custom group domains, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"optional result fields, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"group_id", "description"=>"one or more separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"group_urlname", "description"=>"one or more separated by commas, includes no slashes", "type"=>"string"}, {"in"=>"query", "name"=>"lat,lon", "description"=>"A valid latitude and longitude, limits the returned groups to those within radius miles", "type"=>"string"}, {"in"=>"query", "name"=>"member_id", "description"=>"one or more separated by commas, for groups this member belongs to", "type"=>"string"}, {"in"=>"query", "name"=>"organizer_id", "description"=>"one or more organizer IDs, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius, in miles for geographic requests, default 25 -- maximum 100", "type"=>"string"}, {"in"=>"query", "name"=>"topic", "description"=>"Only return groups in the specified topic [one topic allowed]", "type"=>"string"}, {"in"=>"query", "name"=>"topic, groupnum", "description"=>"Return the group with this topic and number", "type"=>"string"}, {"in"=>"query", "name"=>"zip", "description"=>"A valid US zip code, limits the returned groups to those within radius miles", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups"]}}, "/2/events"=>{"get"=>{"summary"=>"Events", "description"=>"Access Meetup events using a group, member, or event id. Events in private groups are available only to authenticated members of those groups. To search events by topic or location, see [Open Events](/meetup_api/docs/2/open_events).", "operationId"=>"events", "x-api-path-slug"=>"2events-get", "parameters"=>[{"in"=>"query", "name"=>"event_id", "description"=>"Multiple ids may be separated with commas", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"Request that additional fields (separated by commas) be included in the output", "type"=>"string"}, {"in"=>"query", "name"=>"group_domain", "description"=>"Group custom domain", "type"=>"string"}, {"in"=>"query", "name"=>"group_id", "description"=>"Multiple ids may be separated with commas", "type"=>"string"}, {"in"=>"query", "name"=>"group_urlname", "description"=>"Path to group from meetup", "type"=>"string"}, {"in"=>"query", "name"=>"limited_events", "description"=>"Include limited event information for private groups that wish to expose only a small amount of information about their events", "type"=>"string"}, {"in"=>"query", "name"=>"member_id", "description"=>"Single member id, to find events in this members groups", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp", "description"=>"Filters events by the currently authenticated members RSVP status", "type"=>"string"}, {"in"=>"query", "name"=>"status", "description"=>"Status may be upcoming, past, proposed, suggested, cancelled, draft or multiple separated by a comma", "type"=>"string"}, {"in"=>"query", "name"=>"text_format", "description"=>"Format of the description text, html or plain", "type"=>"string"}, {"in"=>"query", "name"=>"time", "description"=>"Return events scheduled within the given time range, defined by two times separated with a single comma", "type"=>"string"}, {"in"=>"query", "name"=>"venue_id", "description"=>"Multiple ids may be separated with commas", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/2/event"=>{"post"=>{"summary"=>"Event Create", "description"=>"Create a new Meetup event within the system.", "operationId"=>"events", "x-api-path-slug"=>"2event-post", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"Longer description of the event, in HTML", "type"=>"string"}, {"in"=>"query", "name"=>"duration", "description"=>"Event duration in milliseconds", "type"=>"string"}, {"in"=>"query", "name"=>"group_id", "description"=>"Group hosting the event", "type"=>"string"}, {"in"=>"query", "name"=>"group_urlname", "description"=>"URL name of the Group hosting the event", "type"=>"string"}, {"in"=>"query", "name"=>"guest_limit", "description"=>"Number of guests members may include in their RSVP, 0 or more", "type"=>"string"}, {"in"=>"query", "name"=>"hosts", "description"=>"Up to 5 comma-separated valid member ids to be hosts for the event", "type"=>"string"}, {"in"=>"query", "name"=>"how_to_find_us", "description"=>"The information provided by the event host for How will members find you there?", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"Name of the event", "type"=>"string"}, {"in"=>"query", "name"=>"publish_status", "description"=>"If you are an organizer of the group, you may set this to draft to save the event as a draft", "type"=>"string"}, {"in"=>"query", "name"=>"question_{index}", "description"=>"Those with permission may include up to 6 survey questions for the event with each being up to 250 characters", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp_close", "description"=>"Users with permission may set the RSVP close time for the event", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp_limit", "description"=>"Total number of RSVPs available for the event", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp_open", "description"=>"Users with permission may set the RSVP open time for the event", "type"=>"string"}, {"in"=>"query", "name"=>"simple_html_description", "description"=>"Description of the event, in simple HTML format", "type"=>"string"}, {"in"=>"query", "name"=>"time", "description"=>"Event start time in milliseconds since the epoch, or relative to the current time in the d/w/m format", "type"=>"string"}, {"in"=>"query", "name"=>"venue_id", "description"=>"Numeric identifier of a venue", "type"=>"string"}, {"in"=>"query", "name"=>"venue_visibility", "description"=>"Controls the visibility of the event venue for non members of the hosting group", "type"=>"string"}, {"in"=>"query", "name"=>"why", "description"=>"We should do this because", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/2/event/:id"=>{"post"=>{"summary"=>"Event Edit", "description"=>"Update an existing Meetup", "operationId"=>"events", "x-api-path-slug"=>"2eventid-post", "parameters"=>[{"in"=>"query", "name"=>"announce", "description"=>"Organizers and hosts may set this to true to announce a Meetup", "type"=>"string"}, {"in"=>"query", "name"=>"description", "description"=>"Longer description of the event, in HTML", "type"=>"string"}, {"in"=>"query", "name"=>"duration", "description"=>"Event duration in milliseconds", "type"=>"string"}, {"in"=>"query", "name"=>"group_id", "description"=>"Group to hold the event", "type"=>"string"}, {"in"=>"query", "name"=>"guest_limit", "description"=>"number of guests members may include in their RSVP, 0 or more", "type"=>"string"}, {"in"=>"query", "name"=>"hosts", "description"=>"Up to 5 valid member ids to be hosts for the event", "type"=>"string"}, {"in"=>"query", "name"=>"how_to_find_us", "description"=>"The information provided by the event host for How will members find you there?", "type"=>"string"}, {"in"=>"query", "name"=>"lat,lon", "description"=>"Updates to the venues latitude and longitude", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"Event name", "type"=>"string"}, {"in"=>"query", "name"=>"publish_status", "description"=>"If you are an organizer of the group, you may set this to draft or published", "type"=>"string"}, {"in"=>"query", "name"=>"question_edit_{id}", "description"=>"Those with permission may include up to 6 survey questions with each being up to 250 characters, including new questions", "type"=>"string"}, {"in"=>"query", "name"=>"question_{index}", "description"=>"Those with permission may include up to 6 survey questions with each being up to 250 characters, including edited questions, for the event", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp_close", "description"=>"Users with permission may set the RSVP close time for the event", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp_limit", "description"=>"Total number of RSVPs available for the event", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp_open", "description"=>"Users with permission may set the RSVP open time for the event", "type"=>"string"}, {"in"=>"query", "name"=>"simple_html_description", "description"=>"Description of the event, in simple HTML format", "type"=>"string"}, {"in"=>"query", "name"=>"time", "description"=>"event start time in milliseconds since the epoch, or relative to the current time in the d/w/m format", "type"=>"string"}, {"in"=>"query", "name"=>"venue_id", "description"=>"Numeric identifier of a venue", "type"=>"string"}, {"in"=>"query", "name"=>"venue_visibility", "description"=>"Controls the visibility of venue", "type"=>"string"}, {"in"=>"query", "name"=>"why", "description"=>"We should do this because", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}, "delete"=>{"summary"=>"Event Delete", "description"=>"Deletes a specified meetup", "operationId"=>"events", "x-api-path-slug"=>"2eventid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/photos"=>{"get"=>{"summary"=>"Photos", "description"=>"API method for accessing meetup photos", "operationId"=>"deprecated", "x-api-path-slug"=>"photos-get", "parameters"=>[{"in"=>"query", "name"=>"album_id", "description"=>"return photos for the albums with the given id, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"group_id", "description"=>"Return photos in groups with these ID numbers [separated by commas]", "type"=>"string"}, {"in"=>"query", "name"=>"group_urlname", "description"=>"return photos for the group with given custom URL path", "type"=>"string"}, {"in"=>"query", "name"=>"topic", "description"=>"Return photos in this topic", "type"=>"string"}, {"in"=>"query", "name"=>"topic, groupnum", "description"=>"return photos for the group with given topic and number", "type"=>"string"}, {"in"=>"query", "name"=>"topic_id", "description"=>"Return photos in topics with this ID number", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}}, "/cities"=>{"get"=>{"summary"=>"Cities", "description"=>"API method for accessing meetup cities", "operationId"=>"deprecated", "x-api-path-slug"=>"cities-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"Return cities in these countries [separate countries with commas]", "type"=>"string"}, {"in"=>"query", "name"=>"state", "description"=>"Return cities in these states [separate states with commas]", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Cities"]}}, "/2/cities"=>{"get"=>{"summary"=>"Cities", "description"=>"Returns Meetup cities. This method supports search by latitude/longitude/radius, by country/state, by query term/zip, or a combination of all of these. Location-only searches by lat and lon return all cities within a radius of the provided coordinates. Searches with a query return up to 10 cities matching the term, and can be sorted by size or distance to a given coordinate. 'smart' ordering can be used to return the match(es) with the highest member_count, unless a smaller size match exists nearby the given coordinates. Query searches are supported for country but not country and state", "operationId"=>"cities", "x-api-path-slug"=>"2cities-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"A valid country code", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"Latitude to search", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"Longitude to search", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"Search term and/or zip to look for (if this is specified, max result size limited to 10)", "type"=>"string"}, {"in"=>"query", "name"=>"radius", "description"=>"When searching by lat/lon only, specify a radius to search (default 50 miles)", "type"=>"string"}, {"in"=>"query", "name"=>"state", "description"=>"A valid state code for the given country, if the country has states", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Cities"]}}, "/members"=>{"get"=>{"summary"=>"Members", "description"=>"API method for accessing members of Meetup Groups", "operationId"=>"deprecated", "x-api-path-slug"=>"members-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Request that additional fields (separated by commas) be included in the output", "type"=>"string"}, {"in"=>"query", "name"=>"group_id", "description"=>"Return members in groups with these ID numbers, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"group_urlname", "description"=>"Return members for the group with the given custom URL path", "type"=>"string"}, {"in"=>"query", "name"=>"member_id", "description"=>"Return the member with this ID", "type"=>"string"}, {"in"=>"query", "name"=>"relation", "description"=>"Supply the string self as the value for this parameter to get the information of the member linked to the API key making the request", "type"=>"string"}, {"in"=>"query", "name"=>"service", "description"=>"Match users by the external services theyve linked to their member account, specified as servicename:identifier", "type"=>"string"}, {"in"=>"query", "name"=>"topic,groupnum", "description"=>"Return members for the group with given topic and number", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups", "Members"]}}, "/2/members"=>{"get"=>{"summary"=>"Members", "description"=>"API method for accessing members of Meetup Groups", "operationId"=>"members", "x-api-path-slug"=>"2members-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Request that additional fields (separated by commas) be included in the output", "type"=>"string"}, {"in"=>"query", "name"=>"group_id", "description"=>"Return members in groups with these ID numbers, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"group_urlname", "description"=>"Return members for the group with the given custom URL path", "type"=>"string"}, {"in"=>"query", "name"=>"member_id", "description"=>"Return the member with this ID", "type"=>"string"}, {"in"=>"query", "name"=>"service", "description"=>"Match users by the external services theyve linked to their member account, specified as servicename:identifier", "type"=>"string"}, {"in"=>"query", "name"=>"topic,groupnum", "description"=>"Return members for the group with given topic and number", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups", "Member"]}}, "/2/member/:id"=>{"get"=>{"summary"=>"Member Get", "description"=>"Retrieve a single member", "operationId"=>"members", "x-api-path-slug"=>"2memberid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"comma-separate list of optional fields", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups", "Member"]}, "post"=>{"summary"=>"Member Edit", "description"=>"Edit the authorized member's attributes", "operationId"=>"members", "x-api-path-slug"=>"2memberid-post", "parameters"=>[{"in"=>"query", "name"=>"add_topics", "description"=>"Comma-delimited list of topics ids to add to your alert list", "type"=>"string"}, {"in"=>"query", "name"=>"bio", "description"=>"Free form text passage about you", "type"=>"string"}, {"in"=>"query", "name"=>"bio_privacy", "description"=>"Controls the visibility of the members bio", "type"=>"string"}, {"in"=>"query", "name"=>"birthday", "description"=>"Day you were born", "type"=>"string"}, {"in"=>"query", "name"=>"city", "description"=>"City name for your location", "type"=>"string"}, {"in"=>"query", "name"=>"city_id", "description"=>"Valid city id from /2/cities method", "type"=>"string"}, {"in"=>"query", "name"=>"country", "description"=>"Valid country code for your location", "type"=>"string"}, {"in"=>"query", "name"=>"facebook_privacy", "description"=>"Controls the visibility of the members facebook connection", "type"=>"string"}, {"in"=>"query", "name"=>"gender", "description"=>"Your gender (used for better recommendations)", "type"=>"string"}, {"in"=>"query", "name"=>"groups_privacy", "description"=>"Controls the visibility of the members groups", "type"=>"string"}, {"in"=>"query", "name"=>"hometown", "description"=>"Hometown of member", "type"=>"string"}, {"in"=>"query", "name"=>"lang", "description"=>"Language preference used on the site", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"latitude of city", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"longitude of city", "type"=>"string"}, {"in"=>"query", "name"=>"messaging_pref", "description"=>"This specifies the members preference for being contacted from members on the site", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the current member", "type"=>"string"}, {"in"=>"query", "name"=>"photos_privacy", "description"=>"Controls the visibility of the members photos", "type"=>"string"}, {"in"=>"query", "name"=>"photo_id", "description"=>"A valid photo_id from the members photos to set as the main profile photo", "type"=>"string"}, {"in"=>"query", "name"=>"radius", "description"=>"radius, in miles to search for city given a lat and lon", "type"=>"string"}, {"in"=>"query", "name"=>"remove_topics", "description"=>"Comma-delimited list of topic ids to remove from your alert list", "type"=>"string"}, {"in"=>"query", "name"=>"sync_photo", "description"=>"When set to true, this parameter will sync all of the group profile photos for the member with the provided photo_id", "type"=>"string"}, {"in"=>"query", "name"=>"topics_privacy", "description"=>"Controls the visibility of the members topics", "type"=>"string"}, {"in"=>"query", "name"=>"zip", "description"=>"Valid zip code for city", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups", "Member"]}}, "/2/profiles"=>{"get"=>{"summary"=>"Profiles", "description"=>"This method returns member *profiles* associated with a particular group. Meetup members have separate profiles for each group they join.", "operationId"=>"profiles", "x-api-path-slug"=>"2profiles-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"comma delimited list of optional response properties", "type"=>"string"}, {"in"=>"query", "name"=>"group_id", "description"=>"Return profiles in the group with this ID", "type"=>"string"}, {"in"=>"query", "name"=>"group_urlname", "description"=>"Return profiles for the group with the given custom URL path", "type"=>"string"}, {"in"=>"query", "name"=>"member_id", "description"=>"Return the profiles for members with these IDs, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"role", "description"=>"if leads, only profiles for members of the leadership team are included", "type"=>"string"}, {"in"=>"query", "name"=>"status", "description"=>"Status filter for members", "type"=>"string"}, {"in"=>"query", "name"=>"topic, groupnum", "description"=>"Group identification by topic, deprecated", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Profile"]}}, "/2/profile"=>{"post"=>{"summary"=>"Profile Create (Group Join)", "description"=>"This method allows an authenticated member to join a group by creating a profile", "operationId"=>"profiles", "x-api-path-slug"=>"2profile-post", "parameters"=>[{"in"=>"query", "name"=>"answer_{qid}", "description"=>"Answers to questions from groups API join_info question fields", "type"=>"string"}, {"in"=>"query", "name"=>"group_id", "description"=>"Id of group to join", "type"=>"string"}, {"in"=>"query", "name"=>"group_urlname", "description"=>"Urlname of group to join", "type"=>"string"}, {"in"=>"query", "name"=>"intro", "description"=>"Provides a Member an opportunity to tell the group about themselves", "type"=>"string"}, {"in"=>"query", "name"=>"new_photo", "description"=>"file upload for a new member photo", "type"=>"string"}, {"in"=>"query", "name"=>"photo_id", "description"=>"photo_id of the photo to use for this profile", "type"=>"string"}, {"in"=>"query", "name"=>"site_name", "description"=>"Name of members site", "type"=>"string"}, {"in"=>"query", "name"=>"site_url", "description"=>"Link to members site", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Profile"]}}, "/2/profile/:gid/:mid"=>{"post"=>{"summary"=>"Profile Edit", "description"=>"Update a member's group profile", "operationId"=>"profiles", "x-api-path-slug"=>"2profilegidmid-post", "parameters"=>[{"in"=>"query", "name"=>"add_role", "description"=>"Allows those with permission to assign one of the following roles: coorganizer, event_organizer, assistant_organizer", "type"=>"string"}, {"in"=>"query", "name"=>"answer_{qid}", "description"=>"Answers to questions from groups API join_info question fields", "type"=>"string"}, {"in"=>"query", "name"=>"intro", "description"=>"Provides a Member an opportunity to tell the group about themselves", "type"=>"string"}, {"in"=>"query", "name"=>"new_photo", "description"=>"file upload for a new member photo", "type"=>"string"}, {"in"=>"query", "name"=>"photo_id", "description"=>"photo_id of the photo to use for this profile", "type"=>"string"}, {"in"=>"query", "name"=>"remove_role", "description"=>"Allows those with permission to remove one of the following roles: coorganizer, event_organizer, assistant_organizer", "type"=>"string"}, {"in"=>"query", "name"=>"site_name", "description"=>"Name of members site", "type"=>"string"}, {"in"=>"query", "name"=>"site_url", "description"=>"Link to members site", "type"=>"string"}, {"in"=>"query", "name"=>"title", "description"=>"An organizer-defined member title", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Profile"]}, "get"=>{"summary"=>"Profile Get", "description"=>"Retrieves a single group profile", "operationId"=>"profiles", "x-api-path-slug"=>"2profilegidmid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Request that additional fields (separated by commas) be included in the output", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Profile"]}, "delete"=>{"summary"=>"Profile Delete (Leave Group)", "description"=>"Deletes a member's group profile", "operationId"=>"profiles", "x-api-path-slug"=>"2profilegidmid-delete", "parameters"=>[{"in"=>"query", "name"=>"exit_comment", "description"=>"Optional message to the organizer when leaving", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Profile"]}}, "/2/photo/:id"=>{"delete"=>{"summary"=>"Event Photo Delete", "description"=>"Deletes a specified event photo", "operationId"=>"photos", "x-api-path-slug"=>"2photoid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}, "post"=>{"summary"=>"Event Photo Edit", "description"=>"Edits a specified event photo", "operationId"=>"photos", "x-api-path-slug"=>"2photoid-post", "parameters"=>[{"in"=>"query", "name"=>"caption", "description"=>"Photo caption of up to 255 characters", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}}, "/2/member_photo/:id"=>{"delete"=>{"summary"=>"Member Photo Delete", "description"=>"Delete the specified member photo", "operationId"=>"members", "x-api-path-slug"=>"2member-photoid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/comments"=>{"get"=>{"summary"=>"Comments", "description"=>"API method for accessing meetup group comments", "operationId"=>"groups", "x-api-path-slug"=>"comments-get", "parameters"=>[{"in"=>"query", "name"=>"group_id", "description"=>"Return comments in groups with these ID numbers [separated by commas]", "type"=>"string"}, {"in"=>"query", "name"=>"group_urlname", "description"=>"Return comments for the group with this custom URL path", "type"=>"string"}, {"in"=>"query", "name"=>"topic, groupnum", "description"=>"Return comments for the group with given topic and number", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Comments"]}}, "/2/event_comments"=>{"get"=>{"summary"=>"Comments v2", "description"=>"This method returns messages that appear under Talk about this Meetup. To post messages, see the corresponding write method.", "operationId"=>"events", "x-api-path-slug"=>"2event-comments-get", "parameters"=>[{"in"=>"query", "name"=>"api_version", "description"=>"2", "type"=>"string"}, {"in"=>"query", "name"=>"callback", "description"=>"Name of a function to be called with an array of Event Comment notification objects", "type"=>"string"}, {"in"=>"query", "name"=>"comment_id", "description"=>"Return comments for a given set of comment IDs, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"event_id", "description"=>"Limit notifications to a specific event id", "type"=>"string"}, {"in"=>"query", "name"=>"event_id", "description"=>"Return comments on these events, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"Optionally accepts the value member_photo or notifications", "type"=>"string"}, {"in"=>"query", "name"=>"group_id", "description"=>"Return comments in groups with these ID numbers, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"member_id", "description"=>"Return comments for the given member_ids, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"since_count", "description"=>"Request that some number of recent messages be sent immediately, if available", "type"=>"string"}, {"in"=>"query", "name"=>"since_mtime", "description"=>"Should be supplied for all but the first polling request, so that any missed notifications are can be sent in an immediate response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Comments"]}, "ws"=>{"summary"=>"WebSockets Event Comments Stream", "description"=>"For browsers that support it, [WebSockets](http://dev.w3.org/html5/websockets/) is a more\nefficient alternative to the long-polling stream. This is a **push only** endpoint and will discard\nany messages received from the client after the socket is open.\n\nBecause browser support for WebSockets is limited, we recommend that you consume this stream\nthrough the [must.js](https://github.com/meetup/must.js#readme) client, which can fallback to long-polling.", "operationId"=>"streams", "x-api-path-slug"=>"2event-comments-ws", "parameters"=>[{"in"=>"query", "name"=>"api_version", "description"=>"2", "type"=>"string"}, {"in"=>"query", "name"=>"event_id", "description"=>"Limit notifications to a specific event id", "type"=>"string"}, {"in"=>"query", "name"=>"since_count", "description"=>"Request that some number of recent messages be sent immediately, if available", "type"=>"string"}, {"in"=>"query", "name"=>"since_mtime", "description"=>"Return recent Event Comments with an mtime greater than the supplied time, in milliseconds since the epoch", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Comments"]}}, "/2/event_comment"=>{"post"=>{"summary"=>"Event Comment v2", "description"=>"This method posts messages that appear under Talk about this Meetup.", "operationId"=>"events", "x-api-path-slug"=>"2event-comment-post", "parameters"=>[{"in"=>"query", "name"=>"comment", "description"=>"The comment text", "type"=>"string"}, {"in"=>"query", "name"=>"event_id", "description"=>"The event related to this comment", "type"=>"string"}, {"in"=>"query", "name"=>"in_reply_to", "description"=>"If this comment is a reply, the ID of the comment being replied to", "type"=>"string"}, {"in"=>"query", "name"=>"notifications", "description"=>"Notification control for authorized member on this comment thread", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Comments"]}}, "/2/event_comment/:id"=>{"get"=>{"summary"=>"Event Comment Get", "description"=>"Retrieve a single event comment or reply", "operationId"=>"events", "x-api-path-slug"=>"2event-commentid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"comma-separate list of optional fields", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Comments"]}, "delete"=>{"summary"=>"Event Comment Delete", "description"=>"Delete a single event comment or reply", "operationId"=>"events", "x-api-path-slug"=>"2event-commentid-delete", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"comma-separate list of optional fields", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Comments"]}}, "/2/event_comment_flag"=>{"post"=>{"summary"=>"Event Comment Flag", "description"=>"This method creates a spam report for comment content", "operationId"=>"events", "x-api-path-slug"=>"2event-comment-flag-post", "parameters"=>[{"in"=>"query", "name"=>"comment_id", "description"=>"The id of the comment", "type"=>"string"}, {"in"=>"query", "name"=>"reason", "description"=>"Reason for flagging the comment", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Comments"]}}, "/2/event_comment_subscribe/:id"=>{"delete"=>{"summary"=>"Event Comment Unsubscribe", "description"=>"Unsubscribe to notifications for updates to a given comment thread", "operationId"=>"events", "x-api-path-slug"=>"2event-comment-subscribeid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Comments"]}, "post"=>{"summary"=>"Event Comment Subscribe", "description"=>"Subscribe to notifications on updates to a given comment thread", "operationId"=>"events", "x-api-path-slug"=>"2event-comment-subscribeid-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Ratings"]}}, "/2/event_comment_like/:id"=>{"post"=>{"summary"=>"Event Comment Like", "description"=>"Like a given Event comment", "operationId"=>"events", "x-api-path-slug"=>"2event-comment-likeid-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Comments"]}, "delete"=>{"summary"=>"Event Comment Unlike", "description"=>"Unlike a given Event comment", "operationId"=>"events", "x-api-path-slug"=>"2event-comment-likeid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Comments"]}}, "/2/event_comment_likes"=>{"get"=>{"summary"=>"Comment Likes", "description"=>"Api for listing likes of a given event comment", "operationId"=>"events", "x-api-path-slug"=>"2event-comment-likes-get", "parameters"=>[{"in"=>"query", "name"=>"comment_id", "description"=>"Return likes for a given comment_id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Comments"]}}, "/2/photo_comments"=>{"get"=>{"summary"=>"Photo Comments v2", "description"=>"This method returns comments on meetup photos. To post messages, see the corresponding write method", "operationId"=>"photos", "x-api-path-slug"=>"2photo-comments-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Request that additional fields (separated by commas) be included in the output", "type"=>"string"}, {"in"=>"query", "name"=>"member_id", "description"=>"Return comments for the given member_ids, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"photo_id", "description"=>"Return comments on these photos, separated by commas", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Profile"]}}, "/2/photo_comment"=>{"post"=>{"summary"=>"Photo Comment v2", "description"=>"This method posts comments that appear below photos", "operationId"=>"photos", "x-api-path-slug"=>"2photo-comment-post", "parameters"=>[{"in"=>"query", "name"=>"comment", "description"=>"The comment text", "type"=>"string"}, {"in"=>"query", "name"=>"photo_id", "description"=>"The photo related to this comment", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos", "Comments"]}}, "/2/event_ratings"=>{"get"=>{"summary"=>"Ratings v2", "description"=>"API method for accessing Meetup comments", "operationId"=>"events", "x-api-path-slug"=>"2event-ratings-get", "parameters"=>[{"in"=>"query", "name"=>"event_id", "description"=>"The ID of the event to fetch ratings data for", "type"=>"string"}, {"in"=>"query", "name"=>"member_id", "description"=>"The ID of a member to filter ratings on", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups"]}}, "/2/event_rating"=>{"post"=>{"summary"=>"Event Rating", "description"=>"This method allows members to posts rating for an event after it's occurred. Only permitted for members who rsvp'd yes or maybe to the event", "operationId"=>"events", "x-api-path-slug"=>"2event-rating-post", "parameters"=>[{"in"=>"query", "name"=>"attendee_count", "description"=>"DEPRECATED: The number of attendees for the event (organizers/assistant organizers/co-organizers/event organizers/event hosts only)", "type"=>"string"}, {"in"=>"query", "name"=>"event_id", "description"=>"The ID of the event to fetch ratings data for", "type"=>"string"}, {"in"=>"query", "name"=>"rating", "description"=>"The members rating (either 1, 2, 3, 4, or 5)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Ratings"]}}, "/2/photo_albums"=>{"get"=>{"summary"=>"Photo Albums", "description"=>"This method returns photo albums associated with Meetup groups. To create albums, see the corresponding write method.", "operationId"=>"photos", "x-api-path-slug"=>"2photo-albums-get", "parameters"=>[{"in"=>"query", "name"=>"event_id", "description"=>"Return photo albums for these event ids, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"group_id", "description"=>"Return albums in groups with these ID, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"photo_album_id", "description"=>"Return albums with these IDs, separated by commas", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos", "Comments"]}}, "/2/photos"=>{"get"=>{"summary"=>"Photos", "description"=>"This method returns photos by member, group, album, event, photo ID, or tagged member.", "operationId"=>"photos", "x-api-path-slug"=>"2photos-get", "parameters"=>[{"in"=>"query", "name"=>"api_version", "description"=>"2", "type"=>"string"}, {"in"=>"query", "name"=>"callback", "description"=>"Name of a function to be called with an array of photo notification objects", "type"=>"string"}, {"in"=>"query", "name"=>"event_id", "description"=>"Limit notifications to a specific event id", "type"=>"string"}, {"in"=>"query", "name"=>"event_id", "description"=>"Event ids, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"comma-delimited optional response properties such as member_country, member_city, member_state, and self", "type"=>"string"}, {"in"=>"query", "name"=>"group_id", "description"=>"Group IDs, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"group_urlname", "description"=>"Group urlnames, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"member_id", "description"=>"Uploaded by members with these IDs, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"photo_album_id", "description"=>"Photo Album IDs, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"photo_id", "description"=>"Photo IDs, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"since_count", "description"=>"Request that some number of recent messages be sent immediately, if available", "type"=>"string"}, {"in"=>"query", "name"=>"since_mtime", "description"=>"Should be supplied for all but the first polling request, so that any missed notifications are can be sent in an immediate response", "type"=>"string"}, {"in"=>"query", "name"=>"tagged", "description"=>"Tagged with members with these IDs, separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"time", "description"=>"Return photos uploaded within the given time range, defined by two times separated with a single comma", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}, "ws"=>{"summary"=>"WebSocket Photo Stream", "description"=>"For browsers that support it, [WebSockets](http://dev.w3.org/html5/websockets/) is a more\nefficient alternative to the long-polling stream. This is a **push only** endpoint and will discard\nany messages received from the client after the socket is open.\n\nBecause browser support for WebSockets is limited, we recommend that you consume this stream\nthrough the [must.js](https://github.com/meetup/must.js#readme) client, which can fallback to long-polling.", "operationId"=>"streams", "x-api-path-slug"=>"2photos-ws", "parameters"=>[{"in"=>"query", "name"=>"api_version", "description"=>"2", "type"=>"string"}, {"in"=>"query", "name"=>"since_count", "description"=>"Request that some number of recent messages be sent immediately, if available", "type"=>"string"}, {"in"=>"query", "name"=>"since_mtime", "description"=>"Return recent photos with an mtime greater then the supplied time, in millisends since the epoch", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos", "Albums"]}}, "/2/photo_album"=>{"post"=>{"summary"=>"Photo Album2", "description"=>"This method creates photo albums within a Meetup group", "operationId"=>"photos", "x-api-path-slug"=>"2photo-album-post", "parameters"=>[{"in"=>"query", "name"=>"group_id", "description"=>"Group to create the album in", "type"=>"string"}, {"in"=>"query", "name"=>"title", "description"=>"Title of the new album", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos", "Albums"]}}, "/2/open_venues"=>{"get"=>{"summary"=>"OpenVenues", "description"=>"Searches for public venues within a given geo space. To search for specific venues that your group has used, use the [Venues](/meetup_api/docs/2/venues) method", "operationId"=>"venues", "x-api-path-slug"=>"2open-venues-get", "parameters"=>[{"in"=>"query", "name"=>"api_version", "description"=>"2", "type"=>"string"}, {"in"=>"query", "name"=>"city", "description"=>"A valid city", "type"=>"string"}, {"in"=>"query", "name"=>"country", "description"=>"A valid country code", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"Request that additional fields (separated by commas) be included in the output", "type"=>"string"}, {"in"=>"query", "name"=>"group_urlname", "description"=>"Returns venues with location relative to the group associated with this urlname", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"A valid latitude, limits the returned venues to those within radius miles", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"A valid longitude, limits the returned venues to those within radius miles", "type"=>"string"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius, in miles for geographic requests, default 25", "type"=>"string"}, {"in"=>"query", "name"=>"since_count", "description"=>"Request that some number of recent messages be sent immediately, if available", "type"=>"string"}, {"in"=>"query", "name"=>"since_mtime", "description"=>"Return recent open venues with an mtime greater then the supplied time, in milliseconds since the epoch", "type"=>"string"}, {"in"=>"query", "name"=>"state", "description"=>"For the US, a valid 2 character state code", "type"=>"string"}, {"in"=>"query", "name"=>"text", "description"=>"Venues that contain the given term or terms somewhere in their content", "type"=>"string"}, {"in"=>"query", "name"=>"trickle", "description"=>"When supplied with a request, the Meetup API will push your client the entire Meetup database of public venues in batches of 512", "type"=>"string"}, {"in"=>"query", "name"=>"zip", "description"=>"A valid US zip code, limits the returned venues to those within radius miles", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}}, "/2/venues"=>{"get"=>{"summary"=>"Venues", "description"=>"Search for Meetup venues by one of your groups, events, or venue identifiers. For a full text search on public venues use [OpenVenues](/meetup_api/docs/2/open_venues).", "operationId"=>"venues", "x-api-path-slug"=>"2venues-get", "parameters"=>[{"in"=>"query", "name"=>"event_id", "description"=>"multiple ids may be separated with commas", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"Request that additional fields (separated by commas) be included in the output", "type"=>"string"}, {"in"=>"query", "name"=>"group_id", "description"=>"multiple ids may be separated with commas", "type"=>"string"}, {"in"=>"query", "name"=>"group_urlname", "description"=>"path to group from meetup", "type"=>"string"}, {"in"=>"query", "name"=>"venue_id", "description"=>"multiple ids may be separated with commas", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Venues"]}}, "/rsvps"=>{"get"=>{"summary"=>"Rsvps", "description"=>"API method for accessing meetup rsvps", "operationId"=>"deprecated", "x-api-path-slug"=>"rsvps-get", "parameters"=>[{"in"=>"query", "name"=>"event_id", "description"=>"Return members that RSVPd to events with these ID numbers [separated by commas]", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "RSVP"]}}, "/rsvp"=>{"post"=>{"summary"=>"RSVP", "description"=>"Creates a new Rsvp", "operationId"=>"deprecated", "x-api-path-slug"=>"rsvp-post", "parameters"=>[{"in"=>"query", "name"=>"answer_{qid}", "description"=>"Answers to event survey questions", "type"=>"string"}, {"in"=>"query", "name"=>"comments", "description"=>"A comment to post along with the RSVP", "type"=>"string"}, {"in"=>"query", "name"=>"event_id", "description"=>"The event that you are RSVPing to", "type"=>"string"}, {"in"=>"query", "name"=>"guests", "description"=>"Number of guests also coming to the event", "type"=>"string"}, {"in"=>"query", "name"=>"member_id", "description"=>"Organizers and event hosts may RSVP on behalf of a member by specifying an ID here", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp", "description"=>"The RSVP setting - value must be either yes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "RSVP"]}}, "/2/rsvps"=>{"get"=>{"summary"=>"RSVPs v2", "description"=>"Query for Event RSVPs by event", "operationId"=>"rsvps", "x-api-path-slug"=>"2rsvps-get", "parameters"=>[{"in"=>"query", "name"=>"api_version", "description"=>"2", "type"=>"string"}, {"in"=>"query", "name"=>"callback", "description"=>"Name of a function to be called with an array of RSVP notification objects", "type"=>"string"}, {"in"=>"query", "name"=>"event_id", "description"=>"Multiple alphanumeric ids may be separated with commas", "type"=>"string"}, {"in"=>"query", "name"=>"event_id", "description"=>"Limit notifications to a specific event id", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"Parameter for requesting optional response properties, set to other_services for a list of third party services", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp", "description"=>"Filters response on RSVP status", "type"=>"string"}, {"in"=>"query", "name"=>"since_count", "description"=>"Request that some number of recent messages be sent immediately, if available", "type"=>"string"}, {"in"=>"query", "name"=>"since_mtime", "description"=>"Should be supplied for all but the first polling request, so that any missed notifications are can be sent in an immediate response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}, "ws"=>{"summary"=>"WebSockets RSVP Stream", "description"=>"For browsers that support it, [WebSockets](http://dev.w3.org/html5/websockets/) is a more\nefficient alternative to the long-polling stream. This is a **push only** endpoint and will discard\nany messages received from the client after the socket is open.\n\nBecause browser support for WebSockets is limited, we recommend that you consume this stream\nthrough the [must.js](https://github.com/meetup/must.js#readme) client, which can fallback to long-polling.", "operationId"=>"streams", "x-api-path-slug"=>"2rsvps-ws", "parameters"=>[{"in"=>"query", "name"=>"api_version", "description"=>"2", "type"=>"string"}, {"in"=>"query", "name"=>"event_id", "description"=>"Limit notifications to a specific event id", "type"=>"string"}, {"in"=>"query", "name"=>"since_count", "description"=>"Request that some number of recent messages be sent immediately, if available", "type"=>"string"}, {"in"=>"query", "name"=>"since_mtime", "description"=>"Return recent RSVPs with an mtime greater than the supplied time, in milliseconds since the epoch", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Streaming", "Websockets"]}}, "/2/rsvp"=>{"post"=>{"summary"=>"RSVP Create/Update", "description"=>"Creates or updates an existing RSVP", "operationId"=>"rsvps", "x-api-path-slug"=>"2rsvp-post", "parameters"=>[{"in"=>"query", "name"=>"agree_to_refund", "description"=>"For events with fees, the authorized member must agree to the events refund policy", "type"=>"string"}, {"in"=>"query", "name"=>"answer_{qid}", "description"=>"Answers to event survey questions", "type"=>"string"}, {"in"=>"query", "name"=>"comments", "description"=>"A comment to post along with the RSVP", "type"=>"string"}, {"in"=>"query", "name"=>"event_id", "description"=>"The event that you are RSVPing to", "type"=>"string"}, {"in"=>"query", "name"=>"guests", "description"=>"Number of guests also coming to the event", "type"=>"string"}, {"in"=>"query", "name"=>"member_id", "description"=>"Organizers and event hosts may RSVP on behalf of a member by specifying an ID here", "type"=>"string"}, {"in"=>"query", "name"=>"opt_to_pay", "description"=>"For events with fees, the authorized member may opt to pay as part of the RSVP request", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp", "description"=>"The RSVP setting - value must be either yes, no or waitlist", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/2/rsvp/:id"=>{"get"=>{"summary"=>"RSVP Get", "description"=>"Retrieve a single RSVP", "operationId"=>"rsvps", "x-api-path-slug"=>"2rsvpid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Request that additional fields (separated by commas) be included in the output", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/2/group_photo"=>{"post"=>{"summary"=>"Group Photo Upload", "description"=>"Uploads a new Meetup Group photo. To change other Group settings use the [Group Edit](/meetup_api/docs/:urlname/#edit) endpoint", "operationId"=>"groups", "x-api-path-slug"=>"2group-photo-post", "parameters"=>[{"in"=>"query", "name"=>"await", "description"=>"If true, this ensures a response will not be returned until the upload is accessible", "type"=>"string"}, {"in"=>"query", "name"=>"group_id", "description"=>"Group ID for the target group", "type"=>"string"}, {"in"=>"query", "name"=>"group_urlname", "description"=>"Group urlname", "type"=>"string"}, {"in"=>"query", "name"=>"main", "description"=>"Set to true to have this photo become the groups main photo", "type"=>"string"}, {"in"=>"query", "name"=>"photo", "description"=>"The photo, encoded as multipart/form-data", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups"]}}, "/2/member_photo"=>{"post"=>{"summary"=>"Member Photo Upload", "description"=>"Uploads a photo to be associated with a Member", "operationId"=>"members", "x-api-path-slug"=>"2member-photo-post", "parameters"=>[{"in"=>"query", "name"=>"await", "description"=>"If true, this ensures a response will not be returned until the upload is accessible", "type"=>"string"}, {"in"=>"query", "name"=>"main", "description"=>"Set to true to have this photo become the members main profile photo", "type"=>"string"}, {"in"=>"query", "name"=>"photo", "description"=>"The photo, encoded as multipart/form-data", "type"=>"string"}, {"in"=>"query", "name"=>"sync_matching_photo", "description"=>"When set to true and main is set to true, this will replace all group profile photos matching the current photo with the provided replacement", "type"=>"string"}, {"in"=>"query", "name"=>"sync_photo", "description"=>"When set to true, this parameter will sync all of the group profile photos for the member with the provided photo_id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups", "Member"]}}, "/2/photo"=>{"post"=>{"summary"=>"Event Photo Upload", "description"=>"Uploads a photo for a given event", "operationId"=>"photos", "x-api-path-slug"=>"2photo-post", "parameters"=>[{"in"=>"query", "name"=>"await", "description"=>"If true, this ensures a response will not be returned until the upload is accessible", "type"=>"string"}, {"in"=>"query", "name"=>"caption", "description"=>"Caption for the photo", "type"=>"string"}, {"in"=>"query", "name"=>"event_id", "description"=>"Identifier of an event", "type"=>"string"}, {"in"=>"query", "name"=>"photo", "description"=>"The photo, encoded as multipart/form-data", "type"=>"string"}, {"in"=>"query", "name"=>"photo_album_id", "description"=>"Identifier of an existing photo album, which may be an event or group album", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}}, "/groups"=>{"get"=>{"summary"=>"Groups", "description"=>"API method for accessing meetup groups", "operationId"=>"deprecated", "x-api-path-slug"=>"groups-get", "parameters"=>[{"in"=>"query", "name"=>"country, city, state", "description"=>"A valid country code, city and for the US, State", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"Set to short_link to include shortened group URLs in response items", "type"=>"string"}, {"in"=>"query", "name"=>"group_urlname", "description"=>"Return the group with this custom url path (e", "type"=>"string"}, {"in"=>"query", "name"=>"id", "description"=>"Only return groups with the specified IDs [separate ID numbers with commas]", "type"=>"string"}, {"in"=>"query", "name"=>"lat,lon", "description"=>"A valid latitude and longitude, limits the returned groups to those within radius miles", "type"=>"string"}, {"in"=>"query", "name"=>"member_id", "description"=>"A member id number, limits results set to only those groups that the member specified by this id is currently a member of (excludes private groups, unless the member_id is the same as that of the member making the request)", "type"=>"string"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius, in miles for geographic requests, default 25 -- maximum 100", "type"=>"string"}, {"in"=>"query", "name"=>"topic", "description"=>"Only return groups in the specified topic [one topic allowed]", "type"=>"string"}, {"in"=>"query", "name"=>"topic, groupnum", "description"=>"Return the group with this topic and number", "type"=>"string"}, {"in"=>"query", "name"=>"visibility", "description"=>"Set to members or public to restrict to groups of a particular visibility", "type"=>"string"}, {"in"=>"query", "name"=>"zip", "description"=>"A valid US zip code, limits the returned groups to those within radius miles", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups"]}}, "/activity"=>{"get"=>{"summary"=>"ActivityFeed", "description"=>"API method for retrieving the activity feed for a member's groups", "operationId"=>"feeds", "x-api-path-slug"=>"activity-get", "parameters"=>[{"in"=>"query", "name"=>"member_id", "description"=>"Returns activity from this members groups", "type"=>"string"}, {"in"=>"query", "name"=>"page_start", "description"=>"Starting timestamp for item to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Activity", "Feeds"]}}, "/oembed"=>{"get"=>{"summary"=>"oEmbed", "description"=>"oEmbed implementation", "operationId"=>"oembed", "x-api-path-slug"=>"oembed-get", "parameters"=>[{"in"=>"query", "name"=>"maxwidth", "description"=>"maximum width to display", "type"=>"string"}, {"in"=>"query", "name"=>"url", "description"=>"url of resource to be embedded", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "oEmbed", "Media"]}}, "/status"=>{"get"=>{"summary"=>"API Status", "description"=>"Returns the current API service status", "operationId"=>"meta", "x-api-path-slug"=>"status-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Status"]}}, "/self/blocks/:member_id"=>{"get"=>{"summary"=>"Block status", "description"=>"Checks the block status for a target member relative to the authenticated member", "operationId"=>"abuse", "x-api-path-slug"=>"selfblocksmember-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Abuse", "Status"]}, "post"=>{"summary"=>"Block member", "description"=>"Blocks a target member from various interactions with the authenticated member on the platform", "operationId"=>"abuse", "x-api-path-slug"=>"selfblocksmember-id-post", "parameters"=>[{"in"=>"query", "name"=>"comments", "description"=>"An optional string of text describing why you have chosen to block this member", "type"=>"string"}, {"in"=>"query", "name"=>"report", "description"=>"An optional value that represents a type of abuse the target member is being blocked for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Abuse", "Members"]}, "delete"=>{"summary"=>"Unblock member", "description"=>"Unblocks a previously blocked member from various interactions with the authenticated member on the platform", "operationId"=>"abuse", "x-api-path-slug"=>"selfblocksmember-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Abuse", "Members"]}}, "/self/abuse_reports"=>{"post"=>{"summary"=>"Report Abuse", "description"=>"Submits a new abuse report for a target member. Abuse reports will be followed up on by our Community Support team.", "operationId"=>"abuse", "x-api-path-slug"=>"selfabuse-reports-post", "parameters"=>[{"in"=>"query", "name"=>"comments", "description"=>"An optional string of text that describes why you are submitting this report", "type"=>"string"}, {"in"=>"query", "name"=>"content_tag", "description"=>"An optional identifier for flagged content that identifies both the type and id, where possible, of the content reported", "type"=>"string"}, {"in"=>"query", "name"=>"member_id", "description"=>"A numeric identifier for the member being reported", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"A required identifier for type of abuse you are reporting", "type"=>"string"}, {"in"=>"query", "name"=>"url", "description"=>"An optional URL for the location of the reported content if one exists", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Abuse"]}}, "/:urlname/abuse_reports"=>{"post"=>{"summary"=>"Report Group", "description"=>"Submits a new abuse report for a target group. Abuse reports will be followed up on by our Community Support team.", "operationId"=>"abuse", "x-api-path-slug"=>"urlnameabuse-reports-post", "parameters"=>[{"in"=>"query", "name"=>"type", "description"=>"A required identifier for type of abuse you are reporting", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups"]}}, "/:urlname/member/approvals"=>{"post"=>{"summary"=>"Membership Approval", "description"=>"Approves one or more requests for group membership", "operationId"=>"profiles", "x-api-path-slug"=>"urlnamememberapprovals-post", "parameters"=>[{"in"=>"query", "name"=>"member", "description"=>"Comma-delimited numeric pending member IDs", "type"=>"string"}, {"in"=>"query", "name"=>"send_copy", "description"=>"Optional boolean value indicating whether or not the org should receive a copy of the message sent to the approved members", "type"=>"string"}, {"in"=>"query", "name"=>"welcome_message", "description"=>"Optional message to send to the members being approved", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Members"]}, "delete"=>{"summary"=>"Membership Decline", "description"=>"Declines one or more requests for group membership", "operationId"=>"profiles", "x-api-path-slug"=>"urlnamememberapprovals-delete", "parameters"=>[{"in"=>"query", "name"=>"anon", "description"=>"Optional Boolean value indicating whether the declining members email address should be hidden in the resulting response", "type"=>"string"}, {"in"=>"query", "name"=>"ban", "description"=>"Optional Boolean value indicating whether or not to ban the member in the future", "type"=>"string"}, {"in"=>"query", "name"=>"explanation", "description"=>"Optional explanation to send to the members being declined", "type"=>"string"}, {"in"=>"query", "name"=>"member", "description"=>"Comma-delimited numeric pending member IDs", "type"=>"string"}, {"in"=>"query", "name"=>"send_copy", "description"=>"Optional Boolean value indicating whether or not to send a copy to the member issuing the decline", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Members"]}}, "/:urlname/events/:id/attendance"=>{"get"=>{"summary"=>"Attendance", "description"=>"Lists attendance records for Meetup events. Limited for use by administrative members.", "operationId"=>"events", "x-api-path-slug"=>"urlnameeventsidattendance-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"A named filter to apply to the attendance list", "type"=>"string"}, {"in"=>"query", "name"=>"member", "description"=>"Raw text used to search for member by name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Attendance"]}, "post"=>{"summary"=>"Attendance Taking", "description"=>"Takes member attendance for an event. Limited for use by administrative members.", "operationId"=>"events", "x-api-path-slug"=>"urlnameeventsidattendance-post", "parameters"=>[{"in"=>"query", "name"=>"guests", "description"=>"The number of guests accompanying member", "type"=>"string"}, {"in"=>"query", "name"=>"headcount", "description"=>"Sets the overall headcount for the event", "type"=>"string"}, {"in"=>"query", "name"=>"member", "description"=>"A comma-delimited list of valid ids associated with members RSVPd to the event", "type"=>"string"}, {"in"=>"query", "name"=>"status", "description"=>"An attendance status for the provided members", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Attendance"]}}, "/batch"=>{"post"=>{"summary"=>"batch", "description"=>"Performs multiple API requests in batch, useful for reducing HTTP network requests. This method is only available for OAuth authentication", "operationId"=>"batch", "x-api-path-slug"=>"batch-post", "parameters"=>[{"in"=>"query", "name"=>"requests", "description"=>"JSON-encoding of multiple request objects as described in the parameter notes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Batch"]}}, "/:urlname/boards"=>{"get"=>{"summary"=>"Discussion Boards", "description"=>"Listings of Group discussion boards", "operationId"=>"boards", "x-api-path-slug"=>"urlnameboards-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Discussions"]}}, "/:urlname/venues"=>{"get"=>{"summary"=>"Group Venues", "description"=>"Returns venues a group has previously hosted events at", "operationId"=>"venues", "x-api-path-slug"=>"urlnamevenues-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Comma-delimited list of optional fields to append to the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos", "Veues"]}, "post"=>{"summary"=>"Venue Create", "description"=>"Interface for creating new Meetup venues", "operationId"=>"venues", "x-api-path-slug"=>"urlnamevenues-post", "parameters"=>[{"in"=>"query", "name"=>"address_1", "description"=>"Primary address of the venue", "type"=>"string"}, {"in"=>"query", "name"=>"address_2", "description"=>"Secondary address info", "type"=>"string"}, {"in"=>"query", "name"=>"city", "description"=>"City name of the venue", "type"=>"string"}, {"in"=>"query", "name"=>"country", "description"=>"2 character country code of the venue", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"Comma-delimited list of optional fields to append to the response", "type"=>"string"}, {"in"=>"query", "name"=>"hours", "description"=>"Open hours information about the venue", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"Unique name of the venue", "type"=>"string"}, {"in"=>"query", "name"=>"phone", "description"=>"Optional phone number for the venue", "type"=>"string"}, {"in"=>"query", "name"=>"state", "description"=>"If in the US or CA, the state code for the venue", "type"=>"string"}, {"in"=>"query", "name"=>"visibility", "description"=>"Optional value indicating the venues visibility to others", "type"=>"string"}, {"in"=>"query", "name"=>"web_url", "description"=>"Optional web url for the venue", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos", "Veues"]}}, "/:urlname/boards/:bid/discussions"=>{"get"=>{"summary"=>"Discussions", "description"=>"Listings of group discussions", "operationId"=>"boards", "x-api-path-slug"=>"urlnameboardsbiddiscussions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Discussions"]}}, "/:urlname/boards/:bid/discussions/:did"=>{"get"=>{"summary"=>"Discussion Posts", "description"=>"Listing Group discussion posts", "operationId"=>"boards", "x-api-path-slug"=>"urlnameboardsbiddiscussionsdid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Discussions"]}}, "/self/events"=>{"get"=>{"summary"=>"Member Events", "description"=>"Gets a listing of all scheduled Meetup Events the authenticated member has RSVP'd to\nthat have been announced to the group.\nThis listing is ordered from oldest to most recent by default", "operationId"=>"events", "x-api-path-slug"=>"selfevents-get", "parameters"=>[{"in"=>"query", "name"=>"desc", "description"=>"When true, sorts results in descending order", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional fields names which may be appended to the response", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Number of results to return", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp", "description"=>"Comma-delimited list of RSVP responses", "type"=>"string"}, {"in"=>"query", "name"=>"scroll", "description"=>"A string representing an alias for a point on a timeline", "type"=>"string"}, {"in"=>"query", "name"=>"status", "description"=>"Comma-delimited list of event statuses", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Members"]}}, "/:urlname/events"=>{"post"=>{"summary"=>"Create Event", "description"=>"Creates a new Meetup group event", "operationId"=>"events", "x-api-path-slug"=>"urlnameevents-post", "parameters"=>[{"in"=>"query", "name"=>"announce", "description"=>"Boolean value indicating whether or not Meetup should announce this event to group members", "type"=>"string"}, {"in"=>"query", "name"=>"description", "description"=>"String setting the description of the event, in simple HTML format", "type"=>"string"}, {"in"=>"query", "name"=>"duration", "description"=>"Positive long representing event duration in milliseconds", "type"=>"string"}, {"in"=>"query", "name"=>"event_hosts", "description"=>"String containing up to 5 comma-separated valid member ids for members who will be hosts of the event", "type"=>"string"}, {"in"=>"query", "name"=>"featured_photo_id", "description"=>"Positive integer representing a numeric identifier for a photo, which must be one associated with this group", "type"=>"string"}, {"in"=>"query", "name"=>"guest_limit", "description"=>"Positive integer representing the number of guests that members may include in their RSVP, 0 inclusive", "type"=>"string"}, {"in"=>"query", "name"=>"how_to_find_us", "description"=>"String setting the description for the location of the host(s) at the event venue", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"Float representing adjusted venue latitude", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"Float representing adjusted venue longitude", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"String setting the name of the event", "type"=>"string"}, {"in"=>"query", "name"=>"publish_status", "description"=>"String indicating whether an event will be published to the group or as a draft visible only to the leadership team", "type"=>"string"}, {"in"=>"query", "name"=>"question", "description"=>"String setting the RSVP survey question for the event", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp_close_time", "description"=>"Positive long representing the time before which members will be allowed to RSVP to the event in milliseconds since the epoch", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp_limit", "description"=>"Positive integer representing total number of RSVP slots available for the event", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp_open_time", "description"=>"Positive long representing the time after which members will be allowed to RSVP to the event in milliseconds since the epoch", "type"=>"string"}, {"in"=>"query", "name"=>"self_rsvp", "description"=>"Boolean value indicating whether the authenticated member will be RSVPd to the event upon creation", "type"=>"string"}, {"in"=>"query", "name"=>"time", "description"=>"Positive long representing event start time in milliseconds since the epoch", "type"=>"string"}, {"in"=>"query", "name"=>"venue_id", "description"=>"Positive integer representing a numeric identifier for a venue", "type"=>"string"}, {"in"=>"query", "name"=>"venue_visibility", "description"=>"String indicating whether the event venue and host location description will be visible to non-members of the hosting group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}, "get"=>{"summary"=>"Group Events", "description"=>"Gets a listing of all Meetup Events hosted by a target group, in ascending order by default", "operationId"=>"events", "x-api-path-slug"=>"urlnameevents-get", "parameters"=>[{"in"=>"query", "name"=>"desc", "description"=>"When true, sorts results in descending order", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"Comma-delimited list of optional fields to append to the response", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Number of results to return in a page", "type"=>"string"}, {"in"=>"query", "name"=>"scroll", "description"=>"A string representing an alias for a point on a timeline", "type"=>"string"}, {"in"=>"query", "name"=>"status", "description"=>"A comma-delimited list of event statuses", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups"]}}, "/:urlname/events/:id"=>{"patch"=>{"summary"=>"Update Event", "description"=>"Updates an existing Meetup group event's details", "operationId"=>"events", "x-api-path-slug"=>"urlnameeventsid-patch", "parameters"=>[{"in"=>"query", "name"=>"announce", "description"=>"Boolean value indicating whether or not Meetup should announce this event to group members", "type"=>"string"}, {"in"=>"query", "name"=>"description", "description"=>"String setting the description of the event, in simple HTML format", "type"=>"string"}, {"in"=>"query", "name"=>"duration", "description"=>"Positive long representing event duration in milliseconds", "type"=>"string"}, {"in"=>"query", "name"=>"event_hosts", "description"=>"String containing up to 5 comma-separated valid member ids for members who will be hosts of the event", "type"=>"string"}, {"in"=>"query", "name"=>"featured_photo_id", "description"=>"Positive integer representing a numeric identifier for a photo, which must be one associated with this group", "type"=>"string"}, {"in"=>"query", "name"=>"guest_limit", "description"=>"Positive integer representing the number of guests that members may include in their RSVP, 0 inclusive", "type"=>"string"}, {"in"=>"query", "name"=>"how_to_find_us", "description"=>"String setting the description for the location of the host(s) at the event venue", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"Float representing adjusted venue latitude", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"Float representing adjusted venue longitude", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"String setting the name of the event", "type"=>"string"}, {"in"=>"query", "name"=>"publish_status", "description"=>"String indicating whether an event will be published to the group or as a draft visible only to the leadership team", "type"=>"string"}, {"in"=>"query", "name"=>"question", "description"=>"String setting or replacing the RSVP survey question for the event", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp_close_time", "description"=>"Positive long representing the time before which members will be allowed to RSVP to the event in milliseconds since the epoch", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp_limit", "description"=>"Positive integer representing total number of RSVP slots available for the event", "type"=>"string"}, {"in"=>"query", "name"=>"rsvp_open_time", "description"=>"Positive long representing the time after which members will be allowed to RSVP to the event in milliseconds since the epoch", "type"=>"string"}, {"in"=>"query", "name"=>"time", "description"=>"Positive long representing event start time in milliseconds since the epoch", "type"=>"string"}, {"in"=>"query", "name"=>"venue_id", "description"=>"Positive integer representing a numeric identifier for a venue", "type"=>"string"}, {"in"=>"query", "name"=>"venue_visibility", "description"=>"String indicating whether the event venue and host location description will be visible to non-members of the hosting group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}, "delete"=>{"summary"=>"Event Delete", "description"=>"Cancels or removes an event from a groups calendar", "operationId"=>"events", "x-api-path-slug"=>"urlnameeventsid-delete", "parameters"=>[{"in"=>"query", "name"=>"remove_from_calendar", "description"=>"Optional boolean parameter that, when set to true, fully deletes the event", "type"=>"string"}, {"in"=>"query", "name"=>"update_series", "description"=>"Optional boolean parameter that, when set to true, will update all future recurrences of this event if this event belongs to an event series", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}, "get"=>{"summary"=>"Get Event", "description"=>"Fetches a Meetup Event by group urlname and event_id", "operationId"=>"events", "x-api-path-slug"=>"urlnameeventsid-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional fields to append to the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/:urlname/events/:event_id/rsvps/open"=>{"post"=>{"summary"=>"Open Rsvps", "description"=>"Opens rsvps for an event", "operationId"=>"events", "x-api-path-slug"=>"urlnameeventsevent-idrsvpsopen-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "RSVP"]}}, "/:urlname/events/:event_id/rsvps/close"=>{"post"=>{"summary"=>"Close Rsvps", "description"=>"Closes rsvps for an event", "operationId"=>"events", "x-api-path-slug"=>"urlnameeventsevent-idrsvpsclose-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "RSVP"]}}, "/:urlname/events/:event_id/hosts"=>{"get"=>{"summary"=>"Event Hosts", "description"=>"Returns the list of hosts for a given event", "operationId"=>"hosts", "x-api-path-slug"=>"urlnameeventsevent-idhosts-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional fields to append to the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}}, "/:urlname/events/:event_id/comments"=>{"get"=>{"summary"=>"Event Comments List", "description"=>"Lists the comments and replies posted in a given Meetup Event.\n\nTo view the list of likes for a comment or reply\nsee the [likes](/meetup_api/docs/:urlname/events/:event_id/comments/:comment_id/likes/)\nendpoint", "operationId"=>"comments", "x-api-path-slug"=>"urlnameeventsevent-idcomments-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional fields to append to the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Comments"]}, "post"=>{"summary"=>"Event comment and reply", "description"=>"Creates new comments and replies to existing comments within an Meetup event", "operationId"=>"comments", "x-api-path-slug"=>"urlnameeventsevent-idcomments-post", "parameters"=>[{"in"=>"query", "name"=>"comment", "description"=>"The text of the comment in at most 1024 characters", "type"=>"string"}, {"in"=>"query", "name"=>"in_reply_to", "description"=>"If posting a reply, set this to the numeric identifier of the associated top level comment", "type"=>"string"}, {"in"=>"query", "name"=>"notifications", "description"=>"A boolean value indicating whether or not you wish to recieve future notifications about updates to this comment thread", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Comments"]}}, "/:urlname/events/:event_id/comments/:comment_id"=>{"delete"=>{"summary"=>"Event comment delete", "description"=>"Deletes comments posted in events", "operationId"=>"comments", "x-api-path-slug"=>"urlnameeventsevent-idcommentscomment-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Comments"]}}, "/:urlname/events/:id/payments"=>{"post"=>{"summary"=>"Event Payments", "description"=>"Allows organizers of a group to note payments made by members for an event. This is the 'Mark Paid' feature seen in the RSVP listings on event details pages and affects the 'pay_status' response fields in [2/rsvps](/meetup_api/docs/2/rsvps/#response) for paid events", "operationId"=>"events", "x-api-path-slug"=>"urlnameeventsidpayments-post", "parameters"=>[{"in"=>"query", "name"=>"amount", "description"=>"The monetary amount of money the member submitted", "type"=>"string"}, {"in"=>"query", "name"=>"member", "description"=>"Member Id of member who made a payment", "type"=>"string"}, {"in"=>"query", "name"=>"paid_on", "description"=>"The time the payment was made in milliseconds from the epoc", "type"=>"string"}, {"in"=>"query", "name"=>"quantity", "description"=>"The number of payments made", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Payments"]}}, "/:urlname/photo_albums/:album_id/photos"=>{"get"=>{"summary"=>"Album Photos", "description"=>"Lists photos for a given photo album", "operationId"=>"photos", "x-api-path-slug"=>"urlnamephoto-albumsalbum-idphotos-get", "parameters"=>[{"in"=>"query", "name"=>"desc", "description"=>"Controls directional order or listing", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional response fields", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Number of items to return per-page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}, "post"=>{"summary"=>"Album Photo Upload", "description"=>"Support for uploading new Album photos", "operationId"=>"photos", "x-api-path-slug"=>"urlnamephoto-albumsalbum-idphotos-post", "parameters"=>[{"in"=>"query", "name"=>"await", "description"=>"Optional boolean parameter that will defer a requests a response until confirmation that photo is immediately displayable is received", "type"=>"string"}, {"in"=>"query", "name"=>"caption", "description"=>"Caption for display", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional response fields", "type"=>"string"}, {"in"=>"query", "name"=>"photo", "description"=>"Photo upload data, encoded as multipart/form-data", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}}, "/:urlname/events/:event_id/photos"=>{"get"=>{"summary"=>"Event Photos", "description"=>"Lists photos for a given event", "operationId"=>"photos", "x-api-path-slug"=>"urlnameeventsevent-idphotos-get", "parameters"=>[{"in"=>"query", "name"=>"desc", "description"=>"Controls directional order or listing", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional response fields", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Number of items to return per-page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}, "post"=>{"summary"=>"Event Photo Upload", "description"=>"Support for uploading new Event photos", "operationId"=>"photos", "x-api-path-slug"=>"urlnameeventsevent-idphotos-post", "parameters"=>[{"in"=>"query", "name"=>"await", "description"=>"Optional boolean parameter that will defer a requests a response until confirmation that photo is immediately displayable is received", "type"=>"string"}, {"in"=>"query", "name"=>"caption", "description"=>"Caption for display", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional response fields", "type"=>"string"}, {"in"=>"query", "name"=>"photo", "description"=>"Photo upload data, encoded as multipart/form-data", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}}, "/:urlname/events/:event_id/photos/:photo_id"=>{"get"=>{"summary"=>"Event Photo", "description"=>"Gets information about a specific photo", "operationId"=>"photos", "x-api-path-slug"=>"urlnameeventsevent-idphotosphoto-id-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional response fields", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}, "patch"=>{"summary"=>"Event Photo Edit", "description"=>"Edits photo details", "operationId"=>"photos", "x-api-path-slug"=>"urlnameeventsevent-idphotosphoto-id-patch", "parameters"=>[{"in"=>"query", "name"=>"caption", "description"=>"The photo caption", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional response fields", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}, "delete"=>{"summary"=>"Event Photo Delete", "description"=>"Deletes a specified event photo", "operationId"=>"photos", "x-api-path-slug"=>"urlnameeventsevent-idphotosphoto-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}}, "/find/events"=>{"get"=>{"summary"=>"Find Events", "description"=>"Returns list of upcoming events based on location", "operationId"=>"deprecated", "x-api-path-slug"=>"findevents-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional fields to populate in the response", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"Approximate target latitude", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"Approximate target longitude", "type"=>"string"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius in miles", "type"=>"string"}, {"in"=>"query", "name"=>"text", "description"=>"Raw full text search query", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Search"]}}, "/find/upcoming_events"=>{"get"=>{"summary"=>"Find Upcoming Events", "description"=>"Returns a list of upcoming events", "operationId"=>"events", "x-api-path-slug"=>"findupcoming-events-get", "parameters"=>[{"in"=>"query", "name"=>"end_date_range", "description"=>"Return events that start before this date", "type"=>"string"}, {"in"=>"query", "name"=>"end_time_range", "description"=>"Return events that start before this time", "type"=>"string"}, {"in"=>"query", "name"=>"excluded_groups", "description"=>"IDs for groups to exclude from the returned events", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional fields to populate in the response", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"Approximate target latitude", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"Approximate target longitude", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"The sort order of returned events", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"A target minimum number of events to return in a single page of results", "type"=>"string"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius in miles", "type"=>"string"}, {"in"=>"query", "name"=>"self_groups", "description"=>"set to include or exclude or only get groups that the member belongs to", "type"=>"string"}, {"in"=>"query", "name"=>"start_date_range", "description"=>"Return events that start after this date", "type"=>"string"}, {"in"=>"query", "name"=>"start_time_range", "description"=>"Return events that start after this time", "type"=>"string"}, {"in"=>"query", "name"=>"text", "description"=>"Full text search query", "type"=>"string"}, {"in"=>"query", "name"=>"topic_category", "description"=>"Numeric topic category identifier for filtering recommendations by a topic category", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Search"]}}, "/find/groups"=>{"get"=>{"summary"=>"Find Groups", "description"=>"Text, location, category and friend-based group searches", "operationId"=>"groups", "x-api-path-slug"=>"findgroups-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"Comma-delimited list of numeric category ids", "type"=>"string"}, {"in"=>"query", "name"=>"country", "description"=>"A valid two character country code, defaults to US", "type"=>"string"}, {"in"=>"query", "name"=>"fallback_suggestions", "description"=>"boolean indicator of whether or not to return a list of curated suggestions for groups if we cant find groups matching your criteria", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"Request that additional fields (separated by commas) be included in the output", "type"=>"string"}, {"in"=>"query", "name"=>"filter", "description"=>"Determines which groups are returned", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"Approximate latitude", "type"=>"string"}, {"in"=>"query", "name"=>"location", "description"=>"Raw text location query", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"Approximate longitude", "type"=>"string"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius in miles", "type"=>"string"}, {"in"=>"query", "name"=>"self_groups", "description"=>"set to include or exclude Meetups the authorized member belongs to; default is include", "type"=>"string"}, {"in"=>"query", "name"=>"text", "description"=>"Raw full text search query", "type"=>"string"}, {"in"=>"query", "name"=>"topic_id", "description"=>"Comma-delimited list of numeric topic ids", "type"=>"string"}, {"in"=>"query", "name"=>"upcoming_events", "description"=>"If true, filters text and category based searches on groups that have upcoming events", "type"=>"string"}, {"in"=>"query", "name"=>"zip", "description"=>"Zipcode of location to limit search to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Search", "Groups"]}}, "/find/venues"=>{"get"=>{"summary"=>"Find Venues", "description"=>"Returns list of venues based on location", "operationId"=>"venues", "x-api-path-slug"=>"findvenues-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"A valid two charater country code, desfaults to US", "type"=>"string"}, {"in"=>"query", "name"=>"desc", "description"=>"Boolean value to indicate to direction ordered results", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"Comma-delimited list of optional fields to append to the response", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"Approximate latitude", "type"=>"string"}, {"in"=>"query", "name"=>"location", "description"=>"Raw text location query", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"Approximate longitude", "type"=>"string"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius in miles", "type"=>"string"}, {"in"=>"query", "name"=>"text", "description"=>"Raw full text search query", "type"=>"string"}, {"in"=>"query", "name"=>"zip", "description"=>"Zipcode of location to limit search to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Search", "Venues"]}}, "/:urlname/photos"=>{"get"=>{"summary"=>"Album Photos", "description"=>"Lists of all photos uploaded for the group", "operationId"=>"photos", "x-api-path-slug"=>"urlnamephotos-get", "parameters"=>[{"in"=>"query", "name"=>"desc", "description"=>"Controls directional order or listing", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional response fields", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Number of items to return per-page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}}, "/:urlname/members"=>{"get"=>{"summary"=>"Group Profile list", "description"=>"Get a list of Meetup group members", "operationId"=>"profiles", "x-api-path-slug"=>"urlnamemembers-get", "parameters"=>[{"in"=>"query", "name"=>"desc", "description"=>"Boolean value controling sort order of results", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional fields to append to the response", "type"=>"string"}, {"in"=>"query", "name"=>"filter", "description"=>"May be set to stepup_eligible to return only members eligible to step up as organizer", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Orders results according to definitions listed below", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Number of requested members to return", "type"=>"string"}, {"in"=>"query", "name"=>"role", "description"=>"May be set to leads to filter returned members on the lead team", "type"=>"string"}, {"in"=>"query", "name"=>"status", "description"=>"A comma-delimited list of member statuses", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups"]}, "post"=>{"summary"=>"Group Join", "description"=>"This method allows an authenticated member to join a group by creating a profile", "operationId"=>"profiles", "x-api-path-slug"=>"urlnamemembers-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups"]}}, "/find/:urlname/members"=>{"get"=>{"summary"=>"Group Profile search", "description"=>"Find group member profiles by name.\nMember's who very recently joined or left the group may not be immediately searchable", "operationId"=>"profiles", "x-api-path-slug"=>"findurlnamemembers-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional fields to append to the response", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Orders results according to definitions listed below", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Number of requested members to return", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"The name to search for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups", "Search"]}}, "/:urlname"=>{"get"=>{"summary"=>"Get Group", "description"=>"Fetches a Meetup group by urlname", "operationId"=>"groups", "x-api-path-slug"=>"urlname-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional fields to append to the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups"]}, "post"=>{"summary"=>"Group Edit", "description"=>"Allows organizers to edit their Meetup group information. To change group topics, see the [add](/meetup_api/docs/:urlname/topics/#add) and [remove](/meetup_api/docs/:urlname/topics/#remove) topics endpoints. To change group photo use the [Group photo upload](/meetup_api/docs/2/group_photo/#create) endpoint. OAuth authenticated requests require an additional [group_edit](/meetup_api/auth/#oauth2-scopes) permission.", "operationId"=>"groups", "x-api-path-slug"=>"urlname-post", "parameters"=>[{"in"=>"query", "name"=>"add_topics", "description"=>"Comma-delimited list of topic ids to associate with group", "type"=>"string"}, {"in"=>"query", "name"=>"country", "description"=>"The ISO_3166-1 country code for the country which contains the city", "type"=>"string"}, {"in"=>"query", "name"=>"description", "description"=>"Summary of what the Meetup group is about in simple HTML format", "type"=>"string"}, {"in"=>"query", "name"=>"dryrun", "description"=>"Boolean parameter that will cause this endpoint to apply all validation rules without actually saving changes in which case the response will only reflect the groups current attributes", "type"=>"string"}, {"in"=>"query", "name"=>"ga_code", "description"=>"Google Analytics code for group", "type"=>"string"}, {"in"=>"query", "name"=>"join_mode", "description"=>"Controls how members are let into the group", "type"=>"string"}, {"in"=>"query", "name"=>"key_photo", "description"=>"Groups primary photo", "type"=>"string"}, {"in"=>"query", "name"=>"list_addr", "description"=>"Mailing list prefix", "type"=>"string"}, {"in"=>"query", "name"=>"list_mode", "description"=>"Defines policy for who can post to the group mailing list", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"Display name of the group", "type"=>"string"}, {"in"=>"query", "name"=>"photo_req", "description"=>"Indicates that a member must provide a photo before joining", "type"=>"string"}, {"in"=>"query", "name"=>"questions_req", "description"=>"Indicates that provided questions are required before joining", "type"=>"string"}, {"in"=>"query", "name"=>"question_edit_{id}", "description"=>"Edits a current profile question identified by an id in the parameter name", "type"=>"string"}, {"in"=>"query", "name"=>"question_{index}", "description"=>"A new profile question defined in the order of index provided in the request parameter name", "type"=>"string"}, {"in"=>"query", "name"=>"remove_topics", "description"=>"Comma-delimited list of topic ids to disassociate with group", "type"=>"string"}, {"in"=>"query", "name"=>"urlname", "description"=>"Name used for the groups web address on meetup", "type"=>"string"}, {"in"=>"query", "name"=>"visibility", "description"=>"Restricts group visibility for non-members", "type"=>"string"}, {"in"=>"query", "name"=>"welcome_message", "description"=>"Message sent to members after they join", "type"=>"string"}, {"in"=>"query", "name"=>"who", "description"=>"What members of the group will be called", "type"=>"string"}, {"in"=>"query", "name"=>"zip", "description"=>"The ZIP code of the city", "type"=>"string"}, {"in"=>"query", "name"=>"{service}_uri", "description"=>"A URI for a social network service", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups"]}}, "/:urlname/topics"=>{"post"=>{"summary"=>"Group Topics Add", "description"=>"Associates topics with a given Meetup group. Limited to organizers of the group. OAuth authenticated requests require an additional [group_edit](/meetup_api/auth/#oauth2-scopes) permission.", "operationId"=>"groups", "x-api-path-slug"=>"urlnametopics-post", "parameters"=>[{"in"=>"query", "name"=>"topic_id", "description"=>"Comma-delimited list of topic ids to associate with group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}, "delete"=>{"summary"=>"Group Topics Remove", "description"=>"Disassociates topics with a given Meetup group. Limited to organizers of the group. OAuth authenticated requests require an additional [group_edit](/meetup_api/auth/#oauth2-scopes) permission.", "operationId"=>"groups", "x-api-path-slug"=>"urlnametopics-delete", "parameters"=>[{"in"=>"query", "name"=>"topic_id", "description"=>"Comma-delimited list of topic ids to disassociate with group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}}, "/find/locations"=>{"get"=>{"summary"=>"Find locations", "description"=>"Provides a query interface for finding known locations", "operationId"=>"geo", "x-api-path-slug"=>"findlocations-get", "parameters"=>[{"in"=>"query", "name"=>"lat", "description"=>"Search for locations based on location latitude", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"Search for locations based on location longitude", "type"=>"string"}, {"in"=>"query", "name"=>"offset", "description"=>"The current offset in the paginated set, represented as an incrementing value", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"The desired number of locations to return in a single set of results", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"Search for locations based on city name or zip code", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Search", "Location"]}}, "/self/calendar"=>{"get"=>{"summary"=>"Member Calendar", "description"=>"Get a listing of all upcoming Meetup events for the authenticated member", "operationId"=>"events", "x-api-path-slug"=>"selfcalendar-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional fields names which may be appended to the response", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Number of results to return in a page", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Members", "Calendardars"]}}, "/self/groups"=>{"get"=>{"summary"=>"Member groups", "description"=>"Lists the authenticated member's groups in the order of leadership,\nnext upcoming event, then alphabetical order by name", "operationId"=>"groups", "x-api-path-slug"=>"selfgroups-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional fields to append to the response", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Number of groups to return in a single page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Members", "Groups"]}}, "/:urlname/events/:event_id/comments/:comment_id/likes"=>{"get"=>{"summary"=>"Event Comment and Reply Likes", "description"=>"Returns lists of likes for an event comment or reply", "operationId"=>"comments", "x-api-path-slug"=>"urlnameeventsevent-idcommentscomment-idlikes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Comments"]}, "post"=>{"summary"=>"Event Comment Like", "description"=>"Like a given event comment", "operationId"=>"comments", "x-api-path-slug"=>"urlnameeventsevent-idcommentscomment-idlikes-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Hosts"]}, "delete"=>{"summary"=>"Event Comment Unlike", "description"=>"Unlike a given event comment", "operationId"=>"comments", "x-api-path-slug"=>"urlnameeventsevent-idcommentscomment-idlikes-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Comments"]}}, "/members/:member_id/photos/:photo_id"=>{"delete"=>{"summary"=>"Member Photo Delete", "description"=>"Deletes a member photo by id", "operationId"=>"photos", "x-api-path-slug"=>"membersmember-idphotosphoto-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}}, "/members/:member_id/photos"=>{"post"=>{"summary"=>"Member Photo Upload", "description"=>"Support for uploading new Member photos", "operationId"=>"photos", "x-api-path-slug"=>"membersmember-idphotos-post", "parameters"=>[{"in"=>"query", "name"=>"await", "description"=>"Optional boolean parameter that, when set to true, will defer a requests a response until confirmation that photo is immediately displayable is received", "type"=>"string"}, {"in"=>"query", "name"=>"main", "description"=>"Optional boolean parameter that, when set to true, will cause the members main profile photo to be set to the uploaded photo", "type"=>"string"}, {"in"=>"query", "name"=>"photo", "description"=>"Photo upload data, encoded as a multipart/form-data file", "type"=>"string"}, {"in"=>"query", "name"=>"sync_photo", "description"=>"Optional boolean parameter that, when set to true, will sync all of the group profile photos for the member with the provided photo", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}}, "/pro/:urlname/groups"=>{"get"=>{"summary"=>"Search Pro Groups", "description"=>"Name and statistics range search for the meetup groups belonging to Pro organization.", "operationId"=>"pro", "x-api-path-slug"=>"prourlnamegroups-get", "parameters"=>[{"in"=>"query", "name"=>"active_within_days", "description"=>"Positive Integer: including only those groups that had event in the last specified days", "type"=>"string"}, {"in"=>"query", "name"=>"average_age_max", "description"=>"Positive Integer: Maximum range of the average age of the members", "type"=>"string"}, {"in"=>"query", "name"=>"average_age_min", "description"=>"Positive Integer: Minumum range of the average age of the members", "type"=>"string"}, {"in"=>"query", "name"=>"category", "description"=>"List of Integers: the ids of the category of the group", "type"=>"string"}, {"in"=>"query", "name"=>"chapters", "description"=>"List of Integer: the chapter ids that may belong to the organization", "type"=>"string"}, {"in"=>"query", "name"=>"chapter_urlname", "description"=>"List of String: the urlnames of chapters that may belong to the organization", "type"=>"string"}, {"in"=>"query", "name"=>"country", "description"=>"String: Country", "type"=>"string"}, {"in"=>"query", "name"=>"desc", "description"=>"List of Boolean: whether to sort ascending or decending on each attributes in `order`", "type"=>"string"}, {"in"=>"query", "name"=>"excluded_chapters", "description"=>"List of Integer: the chapters to exclude from the result", "type"=>"string"}, {"in"=>"query", "name"=>"founded_date_max", "description"=>"Milliseconds since epoch: Maximum range of the founded dates of the groups", "type"=>"string"}, {"in"=>"query", "name"=>"founded_date_min", "description"=>"Milliseconds since epoch: Minumum range of the founded dates of the groups", "type"=>"string"}, {"in"=>"query", "name"=>"inactive_within_days", "description"=>"Positive Integer: including only those groups that did not have event in the last specified days", "type"=>"string"}, {"in"=>"query", "name"=>"last_event_max", "description"=>"Milliseconds since epoch: Maximum range of the date that the last meetup happened", "type"=>"string"}, {"in"=>"query", "name"=>"last_event_min", "description"=>"Milliseconds since epoch: Minumum range of the date that the last meetup happened", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"Float: Latitude", "type"=>"string"}, {"in"=>"query", "name"=>"location", "description"=>"String: Raw location", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"Float: Longitude", "type"=>"string"}, {"in"=>"query", "name"=>"member_count_max", "description"=>"Positive Integer: Maximum range of the number of members", "type"=>"string"}, {"in"=>"query", "name"=>"member_count_min", "description"=>"Positive Integer: Minimum range of the number of members", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"String: Name of the group looking for", "type"=>"string"}, {"in"=>"query", "name"=>"next_event_max", "description"=>"Milliseconds since epoch: Maximum range of the date that the next meetup is scheduled", "type"=>"string"}, {"in"=>"query", "name"=>"next_event_min", "description"=>"Milliseconds since epoch: Minumum range of the date that the next meetup is scheduled", "type"=>"string"}, {"in"=>"query", "name"=>"offset", "description"=>"Positive Integer: the page offset", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"List of String: attributes to sort on", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Positive Integer: the size of page window", "type"=>"string"}, {"in"=>"query", "name"=>"past_events_max", "description"=>"Positive Integer: Maximum range of the number of the past events held", "type"=>"string"}, {"in"=>"query", "name"=>"past_events_min", "description"=>"Positive Integer: Minumum range of the number of the past events held", "type"=>"string"}, {"in"=>"query", "name"=>"past_rsvps_max", "description"=>"Positive Integer: Maximum range of the total number of past RSVPs", "type"=>"string"}, {"in"=>"query", "name"=>"past_rsvps_min", "description"=>"Positive Integer: Minumum range of the total number of past RSVPs", "type"=>"string"}, {"in"=>"query", "name"=>"pro_join_date_max", "description"=>"Milliseconds since epoch: Maximum range of the dates the groups joined Pro organization", "type"=>"string"}, {"in"=>"query", "name"=>"pro_join_date_min", "description"=>"Milliseconds since epoch: Minumum range of the dates the groups joined Pro organization", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"String: raw query to search from group name, description, leadership member name, or city", "type"=>"string"}, {"in"=>"query", "name"=>"radius", "description"=>"String: `global`, `smart`, or search radius in Float", "type"=>"string"}, {"in"=>"query", "name"=>"repeat_rsvpers_max", "description"=>"Positive Integer: Maximum range of the average number of repeat rsvpers", "type"=>"string"}, {"in"=>"query", "name"=>"repeat_rsvpers_min", "description"=>"Positive Integer: Minumum range of the average number of repeat rsvpers", "type"=>"string"}, {"in"=>"query", "name"=>"rsvps_per_event_max", "description"=>"Positive Integer: Maximum range of the average number of RSVPs per event", "type"=>"string"}, {"in"=>"query", "name"=>"rsvps_per_event_min", "description"=>"Positive Integer: Minumum range of the average number of RSVPs per event", "type"=>"string"}, {"in"=>"query", "name"=>"topics", "description"=>"List of Integers: the ids of topic of the group", "type"=>"string"}, {"in"=>"query", "name"=>"upcoming_events_max", "description"=>"Positive Integer: Maximum range of the number of the upcoming events", "type"=>"string"}, {"in"=>"query", "name"=>"upcoming_events_min", "description"=>"Positive Integer: Minumum range of the number of the upcoming events", "type"=>"string"}, {"in"=>"query", "name"=>"zip", "description"=>"String: Zip code", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups"]}}, "/pro/:urlname/members"=>{"get"=>{"summary"=>"Search Pro Members", "description"=>"Name, location, and time based search for the members of the meetups belonging to Pro organization.", "operationId"=>"pro", "x-api-path-slug"=>"prourlnamemembers-get", "parameters"=>[{"in"=>"query", "name"=>"active_within_days", "description"=>"Positive Integer: The range of date from the past until today, for the recent activity", "type"=>"string"}, {"in"=>"query", "name"=>"chapters", "description"=>"List of Integers: The chapters which the member belongs to", "type"=>"string"}, {"in"=>"query", "name"=>"country", "description"=>"String: Country", "type"=>"string"}, {"in"=>"query", "name"=>"desc", "description"=>"Boolean: whether to sort ascending or decending", "type"=>"string"}, {"in"=>"query", "name"=>"email_received", "description"=>"Integers: The id of a previous emails that the member received", "type"=>"string"}, {"in"=>"query", "name"=>"events_attended_max", "description"=>"Positive Integer: Maximum number of attended events", "type"=>"string"}, {"in"=>"query", "name"=>"events_attended_min", "description"=>"Positive Integer: Minimum number of attended events", "type"=>"string"}, {"in"=>"query", "name"=>"is_organizer", "description"=>"Boolean: To limit to only organizers or non-organizers", "type"=>"string"}, {"in"=>"query", "name"=>"join_time_max", "description"=>"Milliseconds since epoch: The latest time limit for member join", "type"=>"string"}, {"in"=>"query", "name"=>"join_time_min", "description"=>"Milliseconds since epoch: The oldest time limit for member join", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"Float: Latitude", "type"=>"string"}, {"in"=>"query", "name"=>"location", "description"=>"String: Raw location", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"Float: Longitude", "type"=>"string"}, {"in"=>"query", "name"=>"member_name", "description"=>"String: Name of the member", "type"=>"string"}, {"in"=>"query", "name"=>"offset", "description"=>"Positive Integer: the page offset", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"String: attribute to sort on", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Positive Integer: the size of page window", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"String: raw query string to search from member name or city", "type"=>"string"}, {"in"=>"query", "name"=>"radius", "description"=>"String: `global`, `smart`, or search radius in Float", "type"=>"string"}, {"in"=>"query", "name"=>"zip", "description"=>"String: Zip code", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups"]}}, "/pro/:urlname/tickets"=>{"get"=>{"summary"=>"Search Issued Pro Tickets", "description"=>"Redeemed chapter, redeemed member, status, and timestamp for tickets belonging to Pro organization.", "operationId"=>"pro", "x-api-path-slug"=>"prourlnametickets-get", "parameters"=>[{"in"=>"query", "name"=>"chapters", "description"=>"Comma delimited positive integers: ids of redeemed chapters", "type"=>"string"}, {"in"=>"query", "name"=>"chapter_name", "description"=>"String: partial or full name of the redeemed chapter", "type"=>"string"}, {"in"=>"query", "name"=>"country", "description"=>"String: two-letter country code of the redeemed chapters", "type"=>"string"}, {"in"=>"query", "name"=>"status", "description"=>"Comma delimited strings: ticket status, among the following: inactive, available, claimed, redeemed", "type"=>"string"}, {"in"=>"query", "name"=>"ticket_key", "description"=>"String: full matching string of an issued ticket key", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Tickets"]}}, "/notifications"=>{"get"=>{"summary"=>"Notifications", "description"=>"Returns all recent Meetup notifications for the authorized member. To mark notifications read use [/notifications/read](/meetup_api/docs/notifications/read/) endpoint. To get the authenticated Member's current unread count, request it in an [HTTP header](/meetup_api/docs/#meta-headers).", "operationId"=>"notifications", "x-api-path-slug"=>"notifications-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Request that additional fields (separated by commas) be included in the output", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Notifications"]}}, "/notifications/read"=>{"post"=>{"summary"=>"Read Notifications", "description"=>"Marks groups of [notifications](/meetup_api/docs/notifications/) as read.", "operationId"=>"notifications", "x-api-path-slug"=>"notificationsread-post", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Request that additional fields (separated by commas) be included in the output", "type"=>"string"}, {"in"=>"query", "name"=>"since_id", "description"=>"The id of the newest notification item, typically the first in the list returned by the notifications endpoint", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Notifications"]}}, "/notifications/clicked"=>{"post"=>{"summary"=>"Clicked Notifications", "description"=>"Marks groups of [notifications](/meetup_api/docs/notifications/) as clicked.", "operationId"=>"notifications", "x-api-path-slug"=>"notificationsclicked-post", "parameters"=>[{"in"=>"query", "name"=>"notif_id", "description"=>"The id of the notification to set as clicked", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Notifications"]}}, "/:urlname/photo_albums/:album_id"=>{"get"=>{"summary"=>"Photo Album", "description"=>"Gets information about a specific photo album", "operationId"=>"photos", "x-api-path-slug"=>"urlnamephoto-albumsalbum-id-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional response fields", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}}, "/:urlname/photo_albums"=>{"get"=>{"summary"=>"Photo Album List", "description"=>"Gets a list a group photo albums in ascending order based on the time they were created", "operationId"=>"photos", "x-api-path-slug"=>"urlnamephoto-albums-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional response fields", "type"=>"string"}, {"in"=>"query", "name"=>"offset", "description"=>"Incrementing number used for pagination offsets", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Number of albums to return per page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}}, "/members/:member_id"=>{"get"=>{"summary"=>"Get Member Profile", "description"=>"Gets Member Profiles.\nFor Group Profiles, see [this endpoint](/meetup_api/docs/:urlname/members/:member_id)", "operationId"=>"profiles", "x-api-path-slug"=>"membersmember-id-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited string of optional response field names", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups"]}, "patch"=>{"summary"=>"Member Profile Edit", "description"=>"Edits Member Profiles.For Group Profiles, see [this endpoint](/meetup_api/docs/:urlname/members/:member_id)", "operationId"=>"profiles", "x-api-path-slug"=>"membersmember-id-patch", "parameters"=>[{"in"=>"query", "name"=>"add_topics", "description"=>"Comma-delimited list of topic ids to add to members interest list", "type"=>"string"}, {"in"=>"query", "name"=>"bio", "description"=>"Member bio of up to 250 characters", "type"=>"string"}, {"in"=>"query", "name"=>"bio_privacy", "description"=>"Preference for hiding or showing member bio to others", "type"=>"string"}, {"in"=>"query", "name"=>"birthday", "description"=>"Members date or year of birth", "type"=>"string"}, {"in"=>"query", "name"=>"city_id", "description"=>"Valid Meetup city identifier that indicates the city in which the member resides", "type"=>"string"}, {"in"=>"query", "name"=>"facebook_privacy", "description"=>"Preference for hiding showing information members facebook connection", "type"=>"string"}, {"in"=>"query", "name"=>"gender", "description"=>"Members gender", "type"=>"string"}, {"in"=>"query", "name"=>"groups_privacy", "description"=>"Preference for hiding or showing group memberships to others", "type"=>"string"}, {"in"=>"query", "name"=>"lang", "description"=>"Members language preference", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"A valid latitude to resolve the closest location to associate with the member", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"A valid longitude to resolve the closest location to associate with the memberThis parameter must be accompanied by lat and zip", "type"=>"string"}, {"in"=>"query", "name"=>"messaging_pref", "description"=>"Preference for which members may contact you via the Meetup platform", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"Member name", "type"=>"string"}, {"in"=>"query", "name"=>"photo_id", "description"=>"A valid photo id to this member has previously updated to use as profile photo", "type"=>"string"}, {"in"=>"query", "name"=>"remove_topics", "description"=>"Comma-delimited list of topic ids to remove from members interest list", "type"=>"string"}, {"in"=>"query", "name"=>"sync_photo", "description"=>"When set to true, this parameter will sync all the groupprofile photos for the member with the provided photo_id", "type"=>"string"}, {"in"=>"query", "name"=>"topics_privacy", "description"=>"Preference for hiding or showing member interests to others", "type"=>"string"}, {"in"=>"query", "name"=>"zip", "description"=>"A valid zip code to associate with the member", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Profiles"]}}, "/:urlname/members/:member_id"=>{"get"=>{"summary"=>"Get Group Member Profile", "description"=>"Gets Group Profiles.\nFor Member Profiles, see [this endpoint](/meetup_api/docs/members/:member_id)", "operationId"=>"profiles", "x-api-path-slug"=>"urlnamemembersmember-id-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited string of optional response field names", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups"]}, "patch"=>{"summary"=>"Edit Group Member Profile", "description"=>"Edits Group Profiles.\nTo fetch Group Member Profiles,\nsee [this endpoint](/meetup_api/docs/:urlname/members/:member_id#get)", "operationId"=>"profiles", "x-api-path-slug"=>"urlnamemembersmember-id-patch", "parameters"=>[{"in"=>"query", "name"=>"add_role", "description"=>"Allows those with permission to assign one of the following roles:assistant_organizer, coorganizer, or event_organizer", "type"=>"string"}, {"in"=>"query", "name"=>"answer_{qid}", "description"=>"Answers to questions from groups API join_info question fields", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited string of optional response field names", "type"=>"string"}, {"in"=>"query", "name"=>"intro", "description"=>"Provides a Member an opportunity to tell the group about themselves,in at most 255 characters", "type"=>"string"}, {"in"=>"query", "name"=>"photo_id", "description"=>"Numeric id of the photo to use for this profile", "type"=>"string"}, {"in"=>"query", "name"=>"remove_role", "description"=>"Allows those with permission to remove one of the following roles:assistant_organizer, coorganizer, or event_organizer", "type"=>"string"}, {"in"=>"query", "name"=>"title", "description"=>"An organizer-defined title,in at most 255 characters", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups"]}, "delete"=>{"summary"=>"Delete Group Member Profile (Leave Group)", "description"=>"Deletes a member's group profiles.", "operationId"=>"profiles", "x-api-path-slug"=>"urlnamemembersmember-id-delete", "parameters"=>[{"in"=>"query", "name"=>"exit_comment", "description"=>"Optional message to the organizer when leaving", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Groups"]}}, "/:urlname/events/:event_id/photos/:photo_id/comments"=>{"post"=>{"summary"=>"Photo Comment", "description"=>"Creates a new photo comment", "operationId"=>"photos", "x-api-path-slug"=>"urlnameeventsevent-idphotosphoto-idcomments-post", "parameters"=>[{"in"=>"query", "name"=>"comment", "description"=>"The text of the comment", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos", "Comments"]}, "get"=>{"summary"=>"Photo Comments", "description"=>"Lists photo comments associated with a photo", "operationId"=>"photos", "x-api-path-slug"=>"urlnameeventsevent-idphotosphoto-idcomments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos", "Comments"]}}, "/:urlname/events/:event_id/photos/:photo_id/comments/:comment_id"=>{"delete"=>{"summary"=>"Photo Comment Delete", "description"=>"Deletes photo comments", "operationId"=>"photos", "x-api-path-slug"=>"urlnameeventsevent-idphotosphoto-idcommentscomment-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos", "Comments"]}}, "/:urlname/events/:event_id/rsvps"=>{"post"=>{"summary"=>"RSVP Create and Update", "description"=>"Creates or updates an existing RSVP", "operationId"=>"rsvps", "x-api-path-slug"=>"urlnameeventsevent-idrsvps-post", "parameters"=>[{"in"=>"query", "name"=>"agree_to_refund", "description"=>"A boolean indicator used for Events with ticketing feeds to imply the Member has agreed to the Events refund policy", "type"=>"string"}, {"in"=>"query", "name"=>"answer_{qid}", "description"=>"Answers to Event survey questions", "type"=>"string"}, {"in"=>"query", "name"=>"guests", "description"=>"The number of guests Member will be attending with", "type"=>"string"}, {"in"=>"query", "name"=>"opt_to_pay", "description"=>"A boolean indicator used for Events with ticketing fees to imply the Member has opted to pay as part of the RSVP request", "type"=>"string"}, {"in"=>"query", "name"=>"pro_email_share_optin", "description"=>"The authenticated Members email opt in status", "type"=>"string"}, {"in"=>"query", "name"=>"response", "description"=>"The authenticated Members RSVP response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "RSVP"]}, "get"=>{"summary"=>"Event RSVP list", "description"=>"Retrieves list of event RSVPs", "operationId"=>"rsvps", "x-api-path-slug"=>"urlnameeventsevent-idrsvps-get", "parameters"=>[{"in"=>"query", "name"=>"desc", "description"=>"Boolean value controling sort order of results", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional fields to append to the response", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"The sort order of returned RSVPs", "type"=>"string"}, {"in"=>"query", "name"=>"response", "description"=>"Filter returned list to one or more of the following RSVP responses", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "RSVP"]}}, "/find/topic_categories"=>{"get"=>{"summary"=>"Topic Categories", "description"=>"Returns a list high level topic categories", "operationId"=>"topics", "x-api-path-slug"=>"findtopic-categories-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-limited list of optional fields to append to the response", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"An optional approximate latitude to center a request for best_topics", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"An optional approximate longitude to center a request for best_topics", "type"=>"string"}, {"in"=>"query", "name"=>"radius", "description"=>"An radius (in miles) to center a request for best_topics", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Search", "Topic Categories"]}}, "/recommended/events"=>{"get"=>{"summary"=>"Recommended Events", "description"=>"Returns a list of upcoming recommended events", "operationId"=>"deprecated", "x-api-path-slug"=>"recommendedevents-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"A comma-delimited list of optional fields to populate in the response", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"Approximate target latitude", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"Approximate target longitude", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"A target minimum number of events to return in a single page of results", "type"=>"string"}, {"in"=>"query", "name"=>"self_groups", "description"=>"Boolean indicator of whether or not to include events within your existing Meetup network", "type"=>"string"}, {"in"=>"query", "name"=>"topic_category", "description"=>"Numeric topic category identifier for filtering recommendations by a topic category", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Recomendations"]}}, "/recommended/group_topics"=>{"get"=>{"summary"=>"Recommend Group Topics", "description"=>"Recommends suggestions for group topics based on a text search or other topics", "operationId"=>"topics", "x-api-path-slug"=>"recommendedgroup-topics-get", "parameters"=>[{"in"=>"query", "name"=>"exclude_topics", "description"=>"A comma-delimited list of topic ids to exclude from the recommendations", "type"=>"string"}, {"in"=>"query", "name"=>"lang", "description"=>"Defines a language preference for ordering results", "type"=>"string"}, {"in"=>"query", "name"=>"other_topics", "description"=>"A comma-delimited list of topic ids to inform recommendations", "type"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Target number of recommendations to return", "type"=>"string"}, {"in"=>"query", "name"=>"text", "description"=>"Free form text search", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Recomendations", "Groups", "Topics"]}}, "/recommended/groups"=>{"get"=>{"summary"=>"Recommended Groups", "description"=>"Returns groups Meetup finds relevant to you", "operationId"=>"groups", "x-api-path-slug"=>"recommendedgroups-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"A valid category id which limits recommended groups to a particular category", "type"=>"string"}, {"in"=>"query", "name"=>"country", "description"=>"A valid two character country code, defaults to US", "type"=>"string"}, {"in"=>"query", "name"=>"fields", "description"=>"Request that additional fields (separated by commas) be included in the output", "type"=>"string"}, {"in"=>"query", "name"=>"instant_join_only", "description"=>"Recommend only groups without join requirements and that can be joined instantly", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"Approximate latitude", "type"=>"string"}, {"in"=>"query", "name"=>"location", "description"=>"Raw text location query", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"Approximate longitude", "type"=>"string"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius in miles", "type"=>"string"}, {"in"=>"query", "name"=>"sort", "description"=>"How to order the results", "type"=>"string"}, {"in"=>"query", "name"=>"topic_id", "description"=>"Comma delimited list of up to 100 topic ids to help inform recommendations", "type"=>"string"}, {"in"=>"query", "name"=>"zip", "description"=>"Zip code you are searching for recommendations in", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Recomendations", "Groups"]}}, "/recommended/groups/ignores/:urlname"=>{"post"=>{"summary"=>"Recommended Groups Ignore", "description"=>"Provides a form of feedback by requesting to remove a group from future recommendations", "operationId"=>"groups", "x-api-path-slug"=>"recommendedgroupsignoresurlname-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Recomendations", "Groups"]}}, "/recommended/venues"=>{"get"=>{"summary"=>"Recommended Venues", "description"=>"Returns venues Meetup finds relevant to you based on location and category. This method does not yet support sorting or pagination.", "operationId"=>"venues", "x-api-path-slug"=>"recommendedvenues-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"Comma-delimited list of up to 200 category ids to help inform recommendations", "type"=>"string"}, {"in"=>"query", "name"=>"country", "description"=>"A valid two character country code, defaults to US", "type"=>"string"}, {"in"=>"query", "name"=>"group_id", "description"=>"Comma-delimited list of up to 200 group ids to help inform recommendations", "type"=>"string"}, {"in"=>"query", "name"=>"group_urlname", "description"=>"Comma-delimited list of up to 200 group urlnames to help inform recommendations", "type"=>"string"}, {"in"=>"query", "name"=>"lat", "description"=>"Approximate latitude", "type"=>"string"}, {"in"=>"query", "name"=>"location", "description"=>"Raw text location query", "type"=>"string"}, {"in"=>"query", "name"=>"lon", "description"=>"Approximate longitude", "type"=>"string"}, {"in"=>"query", "name"=>"min_groups", "description"=>"The minimum number of groups that have hosted events at this venue", "type"=>"string"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius in miles", "type"=>"string"}, {"in"=>"query", "name"=>"used_between", "description"=>"Return venues that have been used within the given time range, defined by two times separated with a single comma", "type"=>"string"}, {"in"=>"query", "name"=>"zip", "description"=>"Zip code you are searching for recommendations in", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Recomendations", "Venues"]}}, "/:urlname/similar_groups"=>{"get"=>{"summary"=>"Similar groups", "description"=>"Renders a list of similar groups", "operationId"=>"groups", "x-api-path-slug"=>"urlnamesimilar-groups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Photos"]}}, "/find/topics"=>{"get"=>{"summary"=>"Find Topics", "description"=>"Find topics by name", "operationId"=>"topics", "x-api-path-slug"=>"findtopics-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Number of results to return in a single set of results", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"The text to topic text search for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events", "Search", "Topics"]}}}}, "apis"=>{"name"=>"Meetup", "x-slug"=>"meetup", "description"=>"Find Meetups so you can do more of what matters to you. Or create your own group and meet people near you who share your interests.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/6564-meetup.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"917", "tags"=>"API Provider,API Service Provider,Events,General Data,Historical Data API,internet,Marketplace,Media,Meetups,My API Stack,Pedestal,Profiles,Relative Data,Relative StreamRank,Service API,Stack,Stack Network,Streams,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"meetup/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Meetup", "x-api-slug"=>"meetup", "description"=>"Find Meetups so you can do more of what matters to you. Or create your own group and meet people near you who share your interests.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/6564-meetup.jpg", "humanURL"=>"http://meetup.com", "baseURL"=>"https://api.meetup.com//", "tags"=>"API Provider,API Service Provider,Events,General Data,Historical Data API,internet,Marketplace,Media,Meetups,My API Stack,Pedestal,Profiles,Relative Data,Relative StreamRank,Service API,Stack,Stack Network,Streams,Streams,Streams", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/meetup/meetup-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api.meetup.com"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/meetup"}, {"type"=>"x-developer", "url"=>"http://www.meetup.com/meetup_api/"}, {"type"=>"x-email", "url"=>"privacy@meetup.com"}, {"type"=>"x-email", "url"=>"abuse@meetup.com"}, {"type"=>"x-email", "url"=>"api_license@meetup.com"}, {"type"=>"x-email", "url"=>"arbitration-opt-out@meetup.com"}, {"type"=>"x-email", "url"=>"legal@meetup.com"}, {"type"=>"x-github", "url"=>"https://github.com/meetup"}, {"type"=>"x-pricing", "url"=>"http://www.meetup.com/pricing/"}, {"type"=>"x-privacy", "url"=>"http://www.meetup.com/privacy/"}, {"type"=>"x-support", "url"=>"http://www.meetup.com/help/"}, {"type"=>"x-terms-of-service", "url"=>"http://www.meetup.com/terms/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/MeetupAPI"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Meetup"}, {"type"=>"x-website", "url"=>"http://meetup.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-api-management{"azure-api-management-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure API Management", "x-complete"=>1, "info"=>{"title"=>"ApiManagementClient", "description"=>"use-these-rest-apis-for-performing-operations-on-user-entity-in-azure-api-management-deployment--the-user-entity-in-api-management-represents-the-developers-that-call-the-apis-of-the-products-to-which-they-are-subscribed-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policySnippets"=>{"get"=>{"summary"=>"PolicySnippets ListByService", "description"=>"Lists all policy snippets.", "operationId"=>"PolicySnippets_ListByService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamepolicysnippets-get", "parameters"=>[{"in"=>"query", "name"=>"scope", "description"=>"Policy scope"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Snippets"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/regions"=>{"get"=>{"summary"=>"Regions ListByService", "description"=>"Lists all azure regions in which the service exists.", "operationId"=>"Regions_ListByService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameregions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis"=>{"get"=>{"summary"=>"Apis ListByService", "description"=>"Lists all APIs of the API Management service instance.", "operationId"=>"Apis_ListByService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapis-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||-------------|------------------------|-----------------------------------|| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith || name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith || description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith || serviceUrl | ge, le, eq, ne, gt, lt | substringof, startswith, endswith || path | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APIs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}"=>{"get"=>{"summary"=>"Apis Get", "description"=>"Gets the details of the API specified by its identifier.", "operationId"=>"Apis_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapisapiid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APIs"]}, "put"=>{"summary"=>"Apis CreateOrUpdate", "description"=>"Creates new or updates existing specified API of the API Management service instance.", "operationId"=>"Apis_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapisapiid-put", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"ETag of the Api Entity"}, {"in"=>"body", "name"=>"parameters", "description"=>"Create or update parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APIs"]}, "patch"=>{"summary"=>"Apis Update", "description"=>"Updates the specified API of the API Management service instance.", "operationId"=>"Apis_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapisapiid-patch", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"ETag of the API entity"}, {"in"=>"body", "name"=>"parameters", "description"=>"API Update Contract parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APIs"]}, "delete"=>{"summary"=>"Apis Delete", "description"=>"Deletes the specified API of the API Management service instance.", "operationId"=>"Apis_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapisapiid-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"ETag of the API Entity"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["APIs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations"=>{"get"=>{"summary"=>"ApiOperations ListByApis", "description"=>"Lists a collection of the operations for the specified API.", "operationId"=>"ApiOperations_ListByApis", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapisapiidoperations-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||-------------|------------------------|-----------------------------------|| name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith || method | ge, le, eq, ne, gt, lt | substringof, startswith, endswith || description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith || urlTemplate | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Operations"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}"=>{"get"=>{"summary"=>"ApiOperations Get", "description"=>"Gets the details of the API Operation specified by its identifier.", "operationId"=>"ApiOperations_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapisapiidoperationsoperationid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Operations"]}, "put"=>{"summary"=>"ApiOperations CreateOrUpdate", "description"=>"Creates a new API operation or updates an existing one.", "operationId"=>"ApiOperations_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapisapiidoperationsoperationid-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Create parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Operations"]}, "patch"=>{"summary"=>"ApiOperations Update", "description"=>"Updates the details of the operation specified by its identifier.", "operationId"=>"ApiOperations_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapisapiidoperationsoperationid-patch", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"ETag of the API Operation Entity"}, {"in"=>"body", "name"=>"parameters", "description"=>"API Operation Update parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Operations"]}, "delete"=>{"summary"=>"ApiOperations Delete", "description"=>"Deletes the specified operation.", "operationId"=>"ApiOperations_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapisapiidoperationsoperationid-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"ETag of the API Operation Entity"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Operations"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policy"=>{"get"=>{"summary"=>"ApiOperationsPolicy Get", "description"=>"Get the policy configuration at the API Operation level.", "operationId"=>"ApiOperationsPolicy_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapisapiidoperationsoperationidpolicy-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Operations"]}, "put"=>{"summary"=>"ApiOperationsPolicy CreateOrUpdate", "description"=>"Creates or updates policy configuration for the API Operation level.", "operationId"=>"ApiOperationsPolicy_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapisapiidoperationsoperationidpolicy-put", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the Api Operation policy to update"}, {"in"=>"body", "name"=>"parameters", "description"=>"The policy contents to apply", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Operations"]}, "delete"=>{"summary"=>"ApiOperationsPolicy Delete", "description"=>"Deletes the policy configuration at the Api Operation.", "operationId"=>"ApiOperationsPolicy_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapisapiidoperationsoperationidpolicy-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the Api operation policy to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Operations"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products"=>{"get"=>{"summary"=>"ApiProducts ListByApis", "description"=>"Lists all API associated products.", "operationId"=>"ApiProducts_ListByApis", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapisapiidproducts-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||-------|------------------------|---------------------------------------------|| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Products"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policy"=>{"get"=>{"summary"=>"ApiPolicy Get", "description"=>"Get the policy configuration at the API level.", "operationId"=>"ApiPolicy_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapisapiidpolicy-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Policy"]}, "put"=>{"summary"=>"ApiPolicy CreateOrUpdate", "description"=>"Creates or updates policy configuration for the API.", "operationId"=>"ApiPolicy_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapisapiidpolicy-put", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the Api Policy to update"}, {"in"=>"body", "name"=>"parameters", "description"=>"The policy contents to apply", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Policy"]}, "delete"=>{"summary"=>"ApiPolicy Delete", "description"=>"Deletes the policy configuration at the Api.", "operationId"=>"ApiPolicy_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapisapiidpolicy-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the Api policy to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Policy"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers"=>{"get"=>{"summary"=>"AuthorizationServers ListByService", "description"=>"Lists a collection of authorization servers defined within a service instance.", "operationId"=>"AuthorizationServers_ListByService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameauthorizationservers-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||-------|------------------------|---------------------------------------------|| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorization Servers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}"=>{"get"=>{"summary"=>"AuthorizationServers Get", "description"=>"Gets the details of the authorization server specified by its identifier.", "operationId"=>"AuthorizationServers_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameauthorizationserversauthsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorization Servers"]}, "put"=>{"summary"=>"AuthorizationServers CreateOrUpdate", "description"=>"Creates new authorization server or updates an existing authorization server.", "operationId"=>"AuthorizationServers_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameauthorizationserversauthsid-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Create or update parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorization Servers"]}, "patch"=>{"summary"=>"AuthorizationServers Update", "description"=>"Updates the details of the authorization server specified by its identifier.", "operationId"=>"AuthorizationServers_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameauthorizationserversauthsid-patch", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the authorization server to update"}, {"in"=>"body", "name"=>"parameters", "description"=>"OAuth2 Server settings Update parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorization Servers"]}, "delete"=>{"summary"=>"AuthorizationServers Delete", "description"=>"Deletes specific authorization server instance.", "operationId"=>"AuthorizationServers_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameauthorizationserversauthsid-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the authentication server to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorization Servers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends"=>{"get"=>{"summary"=>"Backends ListByService", "description"=>"Lists a collection of backends in the specified service instance.", "operationId"=>"Backends_ListByService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamebackends-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||-------|------------------------|---------------------------------------------|| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || host | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backends"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendid}"=>{"get"=>{"summary"=>"Backends Get", "description"=>"Gets the details of the backend specified by its identifier.", "operationId"=>"Backends_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamebackendsbackendid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backends"]}, "put"=>{"summary"=>"Backends CreateOrUpdate", "description"=>"Creates or Updates a backend.", "operationId"=>"Backends_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamebackendsbackendid-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Create parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backends"]}, "patch"=>{"summary"=>"Backends Update", "description"=>"Updates an existing backend.", "operationId"=>"Backends_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamebackendsbackendid-patch", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the backend to update"}, {"in"=>"body", "name"=>"parameters", "description"=>"Update parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backends"]}, "delete"=>{"summary"=>"Backends Delete", "description"=>"Deletes the specified backend.", "operationId"=>"Backends_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamebackendsbackendid-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the backend to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backends"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates"=>{"get"=>{"summary"=>"Certificates ListByService", "description"=>"Lists a collection of all certificates in the specified service instance.", "operationId"=>"Certificates_ListByService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamecertificates-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||----------------|------------------------|---------------------------------------------|| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || subject | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || thumbprint | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || expirationDate | ge, le, eq, ne, gt, lt | N/A |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}"=>{"get"=>{"summary"=>"Certificates Get", "description"=>"Gets the details of the certificate specified by its identifier.", "operationId"=>"Certificates_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamecertificatescertificateid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}, "put"=>{"summary"=>"Certificates CreateOrUpdate", "description"=>"Creates or updates the certificate being used for authentication with the backend.", "operationId"=>"Certificates_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamecertificatescertificateid-put", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the certificate to update"}, {"in"=>"body", "name"=>"parameters", "description"=>"Create parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}, "delete"=>{"summary"=>"Certificates Delete", "description"=>"Deletes specific certificate.", "operationId"=>"Certificates_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamecertificatescertificateid-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the certificate to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificates"]}}, "/providers/Microsoft.ApiManagement/operations"=>{"get"=>{"summary"=>"API Management Operations List", "description"=>"Lists all of the available REST API operations of the Microsoft.ApiManagement provider.", "operationId"=>"ApiManagementOperations_List", "x-api-path-slug"=>"providersmicrosoft-apimanagementoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Operations"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/managedeployments"=>{"post"=>{"summary"=>"ApiManagementServices ManageDeployments", "description"=>"Manages deployments of an API Management service. This operation can be used to do the following: Change SKU, Change SKU Units, Change Service Tier (Developer/Standard/Premium) and Manage VPN Configuration. This is a long running operation and can take several minutes to complete.", "operationId"=>"ApiManagementServices_ManageDeployments", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamemanagedeployments-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the ManageDeployments operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Management Service"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore"=>{"post"=>{"summary"=>"ApiManagementServices Restore", "description"=>"Restores a backup of an API Management service created using the ApiManagementServices_Backup operation on the current service. This is a long running operation and could take several minutes to complete.", "operationId"=>"ApiManagementServices_Restore", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamerestore-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the Restore API Management service from backup operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Management Services"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup"=>{"post"=>{"summary"=>"ApiManagementServices Backup", "description"=>"Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.", "operationId"=>"ApiManagementServices_Backup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamebackup-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the ApiManagementServices_Backup operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Management Service"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}"=>{"put"=>{"summary"=>"ApiManagementServices CreateOrUpdate", "description"=>"Creates or updates an API Management service. This is long running operation and could take several minutes to complete.", "operationId"=>"ApiManagementServices_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicename-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the CreateOrUpdate API Management service operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}, "patch"=>{"summary"=>"ApiManagementServices Update", "description"=>"Updates an existing API Management service.", "operationId"=>"ApiManagementServices_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicename-patch", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the CreateOrUpdate API Management service operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Service"]}, "get"=>{"summary"=>"ApiManagementServices Get", "description"=>"Gets an API Management service resource description.", "operationId"=>"ApiManagementServices_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Service"]}, "delete"=>{"summary"=>"ApiManagementServices Delete", "description"=>"Deletes an existing API Management service.", "operationId"=>"ApiManagementServices_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicename-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Service"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/"=>{"get"=>{"summary"=>"API Management Services ListByResourceGroup", "description"=>"List all API Management services within a resource group.", "operationId"=>"ApiManagementServices_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementservice-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Service"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/service/"=>{"get"=>{"summary"=>"API Management Services List", "description"=>"Lists all API Management services within an Azure subscription.", "operationId"=>"ApiManagementServices_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-apimanagementservice-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Service"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/getssotoken"=>{"post"=>{"summary"=>"ApiManagementServices GetSsoToken", "description"=>"Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.", "operationId"=>"ApiManagementServices_GetSsoToken", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamegetssotoken-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Management Service"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/checkNameAvailability"=>{"post"=>{"summary"=>"API Management Services Check Name Availability", "description"=>"Checks availability and correctness of a name for an API Management service.", "operationId"=>"ApiManagementServices_CheckNameAvailability", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-apimanagementchecknameavailability-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the CheckNameAvailability operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Service"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/uploadcertificate"=>{"post"=>{"summary"=>"ApiManagementServices UploadCertificate", "description"=>"Upload Custom Domain SSL certificate for an API Management service.", "operationId"=>"ApiManagementServices_UploadCertificate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameuploadcertificate-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the Upload SSL certificate for an API Management service operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Management Services"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/updatehostname"=>{"post"=>{"summary"=>"ApiManagementServices UpdateHostname", "description"=>"Creates, updates, or deletes the custom hostnames for an API Management service. The custom hostname can be applied to the Proxy and Portal endpoint. This is a long running operation and could take several minutes to complete.", "operationId"=>"ApiManagementServices_UpdateHostname", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameupdatehostname-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the UpdateHostname operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Management Services"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates"=>{"post"=>{"summary"=>"ApiManagementServices ApplyNetworkConfigurationUpdates", "description"=>"Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated network settings.", "operationId"=>"ApiManagementServices_ApplyNetworkConfigurationUpdates", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameapplynetworkconfigurationupdates-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API Products"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups"=>{"get"=>{"summary"=>"Groups ListByService", "description"=>"Lists a collection of groups defined within a service instance.", "operationId"=>"Groups_ListByService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamegroups-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||-------------|------------------------|---------------------------------------------|| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || type | eq, ne | N/A |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}"=>{"get"=>{"summary"=>"Groups Get", "description"=>"Gets the details of the group specified by its identifier.", "operationId"=>"Groups_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamegroupsgroupid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, "put"=>{"summary"=>"Groups CreateOrUpdate", "description"=>"Creates or Updates a group.", "operationId"=>"Groups_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamegroupsgroupid-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Create parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, "patch"=>{"summary"=>"Groups Update", "description"=>"Updates the details of the group specified by its identifier.", "operationId"=>"Groups_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamegroupsgroupid-patch", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"ETag of the Group Entity"}, {"in"=>"body", "name"=>"parameters", "description"=>"Update parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, "delete"=>{"summary"=>"Groups Delete", "description"=>"Deletes specific group of the API Management service instance.", "operationId"=>"Groups_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamegroupsgroupid-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"ETag of the Group Entity"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users"=>{"get"=>{"summary"=>"GroupUsers ListByGroups", "description"=>"Lists a collection of the members of the group, specified by its identifier.", "operationId"=>"GroupUsers_ListByGroups", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamegroupsgroupidusers-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||------------------|------------------------|-----------------------------------|| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || state | eq | N/A || registrationDate | ge, le, eq, ne, gt, lt | N/A || note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group Users"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{uid}"=>{"put"=>{"summary"=>"GroupUsers Create", "description"=>"Adds a user to the specified group.", "operationId"=>"GroupUsers_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamegroupsgroupidusersuid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group Users"]}, "delete"=>{"summary"=>"GroupUsers Delete", "description"=>"Remove existing user from existing group.", "operationId"=>"GroupUsers_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamegroupsgroupidusersuid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group Users"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders"=>{"get"=>{"summary"=>"IdentityProviders ListByService", "description"=>"Lists a collection of Identity Provider configured in the specified service instance.", "operationId"=>"IdentityProviders_ListByService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameidentityproviders-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Providers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}"=>{"get"=>{"summary"=>"IdentityProviders Get", "description"=>"Gets the configuration details of the identity Provider configured in specified service instance.", "operationId"=>"IdentityProviders_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameidentityprovidersidentityprovidername-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Providers"]}, "put"=>{"summary"=>"IdentityProviders CreateOrUpdate", "description"=>"Creates or Updates the IdentityProvider configuration.", "operationId"=>"IdentityProviders_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameidentityprovidersidentityprovidername-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Create parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Providers"]}, "patch"=>{"summary"=>"IdentityProviders Update", "description"=>"Updates an existing IdentityProvider configuration.", "operationId"=>"IdentityProviders_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameidentityprovidersidentityprovidername-patch", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the identity provider configuration to update"}, {"in"=>"body", "name"=>"parameters", "description"=>"Update parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Providers"]}, "delete"=>{"summary"=>"IdentityProviders Delete", "description"=>"Deletes the specified identity provider configuration.", "operationId"=>"IdentityProviders_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameidentityprovidersidentityprovidername-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the backend to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Identity Providers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers"=>{"get"=>{"summary"=>"Loggers ListByService", "description"=>"Lists a collection of loggers in the specified service instance.", "operationId"=>"Loggers_ListByService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameloggers-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||-------|------------------------|---------------------------------------------|| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || type | eq | |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Loggers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerid}"=>{"get"=>{"summary"=>"Loggers Get", "description"=>"Gets the details of the logger specified by its identifier.", "operationId"=>"Loggers_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameloggersloggerid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Loggers"]}, "put"=>{"summary"=>"Loggers CreateOrUpdate", "description"=>"Creates or Updates a logger.", "operationId"=>"Loggers_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameloggersloggerid-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Create parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Loggers"]}, "patch"=>{"summary"=>"Loggers Update", "description"=>"Updates an existing logger.", "operationId"=>"Loggers_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameloggersloggerid-patch", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the logger to update"}, {"in"=>"body", "name"=>"parameters", "description"=>"Update parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Loggers"]}, "delete"=>{"summary"=>"Loggers Delete", "description"=>"Deletes the specified logger.", "operationId"=>"Loggers_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameloggersloggerid-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the logger to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Loggers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/networkstatus"=>{"get"=>{"summary"=>"NetworkStatus GetByService", "description"=>"Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.", "operationId"=>"NetworkStatus_GetByService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamenetworkstatus-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network Status"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders"=>{"get"=>{"summary"=>"OpenIdConnectProviders ListByService", "description"=>"Lists all OpenID Connect Providers.", "operationId"=>"OpenIdConnectProviders_ListByService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameopenidconnectproviders-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||-------|------------------------|---------------------------------------------|| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OpenId Connect Providers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}"=>{"get"=>{"summary"=>"OpenIdConnectProviders Get", "description"=>"Gets specific OpenID Connect Provider.", "operationId"=>"OpenIdConnectProviders_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameopenidconnectprovidersopid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OpenId Connect Providers"]}, "put"=>{"summary"=>"OpenIdConnectProviders CreateOrUpdate", "description"=>"Creates or updates the OpenID Connect Provider.", "operationId"=>"OpenIdConnectProviders_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameopenidconnectprovidersopid-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Create parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OpenId Connect Providers"]}, "patch"=>{"summary"=>"OpenIdConnectProviders Update", "description"=>"Updates the specific OpenID Connect Provider.", "operationId"=>"OpenIdConnectProviders_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameopenidconnectprovidersopid-patch", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the OpenID Connect Provider to update"}, {"in"=>"body", "name"=>"parameters", "description"=>"Update parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OpenId Connect Providers"]}, "delete"=>{"summary"=>"OpenIdConnectProviders Delete", "description"=>"Deletes specific OpenID Connect Provider of the API Management service instance.", "operationId"=>"OpenIdConnectProviders_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameopenidconnectprovidersopid-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the OpenID Connect Provider to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OpenId Connect Providers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products"=>{"get"=>{"summary"=>"Products ListByService", "description"=>"Lists a collection of products in the specified service instance.", "operationId"=>"Products_ListByService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameproducts-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||-------------|------------------------|---------------------------------------------|| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || terms | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || state | eq | |"}, {"in"=>"query", "name"=>"expandGroups", "description"=>"When set to true, the response contains an array of groups that have visibility to the product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}"=>{"get"=>{"summary"=>"Products Get", "description"=>"Gets the details of the product specified by its identifier.", "operationId"=>"Products_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameproductsproductid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}, "put"=>{"summary"=>"Products CreateOrUpdate", "description"=>"Creates or Updates a product.", "operationId"=>"Products_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameproductsproductid-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Create or update parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}, "patch"=>{"summary"=>"Products Update", "description"=>"Update product.", "operationId"=>"Products_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameproductsproductid-patch", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"ETag of the Product Entity"}, {"in"=>"body", "name"=>"parameters", "description"=>"Update parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}, "delete"=>{"summary"=>"Products Delete", "description"=>"Delete product.", "operationId"=>"Products_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameproductsproductid-delete", "parameters"=>[{"in"=>"query", "name"=>"deleteSubscriptions", "description"=>"Delete existing subscriptions to the product or not"}, {"in"=>"header", "name"=>"If-Match", "description"=>"ETag of the Product Entity"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis"=>{"get"=>{"summary"=>"ProductApis ListByProducts", "description"=>"Lists a collection of the APIs associated with a product.", "operationId"=>"ProductApis_ListByProducts", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameproductsproductidapis-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||-------------|------------------------|---------------------------------------------|| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product APIs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}"=>{"put"=>{"summary"=>"ProductApis Create", "description"=>"Adds an API to the specified product.", "operationId"=>"ProductApis_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameproductsproductidapisapiid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product APIs"]}, "delete"=>{"summary"=>"ProductApis Delete", "description"=>"Deletes the specified API from the specified product.", "operationId"=>"ProductApis_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameproductsproductidapisapiid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product APIs"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups"=>{"get"=>{"summary"=>"ProductGroups ListByProducts", "description"=>"Lists the collection of developer groups associated with the specified product.", "operationId"=>"ProductGroups_ListByProducts", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameproductsproductidgroups-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||-------------|------------------------|---------------------------------------------|| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || type | eq, ne | N/A |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product Groups"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}"=>{"put"=>{"summary"=>"ProductGroups Create", "description"=>"Adds the association between the specified developer group with the specified product.", "operationId"=>"ProductGroups_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameproductsproductidgroupsgroupid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product Groups"]}, "delete"=>{"summary"=>"ProductGroups Delete", "description"=>"Deletes the association between the specified group and product.", "operationId"=>"ProductGroups_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameproductsproductidgroupsgroupid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product Groups"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/subscriptions"=>{"get"=>{"summary"=>"ProductSubscriptions ListByProducts", "description"=>"Lists the collection of subscriptions to the specified product.", "operationId"=>"ProductSubscriptions_ListByProducts", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameproductsproductidsubscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||--------------|------------------------|---------------------------------------------|| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || state | eq | |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product Subscriptions"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policy"=>{"get"=>{"summary"=>"ProductPolicy Get", "description"=>"Get the policy configuration at the Product level.", "operationId"=>"ProductPolicy_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameproductsproductidpolicy-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product Policy"]}, "put"=>{"summary"=>"ProductPolicy CreateOrUpdate", "description"=>"Creates or updates policy configuration for the Product.", "operationId"=>"ProductPolicy_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameproductsproductidpolicy-put", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the product policy to update"}, {"in"=>"body", "name"=>"parameters", "description"=>"The policy contents to apply", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product Policy"]}, "delete"=>{"summary"=>"ProductPolicy Delete", "description"=>"Deletes the policy configuration at the Product.", "operationId"=>"ProductPolicy_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameproductsproductidpolicy-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the product policy to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product Policy"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/properties"=>{"get"=>{"summary"=>"Properties ListByService", "description"=>"Lists a collection of properties defined within a service instance.", "operationId"=>"Properties_ListByService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameproperties-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||-------|------------------------|-------------------------------------------------------|| tags | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all || name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Properties"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/properties/{propId}"=>{"get"=>{"summary"=>"Property Get", "description"=>"Gets the details of the property specified by its identifier.", "operationId"=>"Property_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamepropertiespropid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Properties"]}, "put"=>{"summary"=>"Property CreateOrUpdate", "description"=>"Creates or updates a property.", "operationId"=>"Property_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamepropertiespropid-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Create parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Properties"]}, "patch"=>{"summary"=>"Property Update", "description"=>"Updates the specific property.", "operationId"=>"Property_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamepropertiespropid-patch", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the property to update"}, {"in"=>"body", "name"=>"parameters", "description"=>"Update parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Properties"]}, "delete"=>{"summary"=>"Property Delete", "description"=>"Deletes specific property from the the API Management service instance.", "operationId"=>"Property_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamepropertiespropid-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the property to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Properties"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}"=>{"get"=>{"summary"=>"QuotaByCounterKeys ListByService", "description"=>"Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet.", "operationId"=>"QuotaByCounterKeys_ListByService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamequotasquotacounterkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Quotas"]}, "patch"=>{"summary"=>"QuotaByCounterKeys Update", "description"=>"Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values.", "operationId"=>"QuotaByCounterKeys_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamequotasquotacounterkey-patch", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The value of the quota counter to be applied to all quota counter periods", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Quotas"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/{quotaPeriodKey}"=>{"get"=>{"summary"=>"QuotaByPeriodKeys Get", "description"=>"Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.", "operationId"=>"QuotaByPeriodKeys_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamequotasquotacounterkeyquotaperiodkey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Quotas"]}, "patch"=>{"summary"=>"QuotaByPeriodKeys Update", "description"=>"Updates an existing quota counter value in the specified service instance.", "operationId"=>"QuotaByPeriodKeys_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamequotasquotacounterkeyquotaperiodkey-patch", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The value of the Quota counter to be applied on the specified period", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Quotas"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/{aggregation}"=>{"get"=>{"summary"=>"Reports ListByService", "description"=>"Lists report records.", "operationId"=>"Reports_ListByService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamereportsaggregation-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"path", "name"=>"aggregation", "description"=>"Report aggregation"}, {"in"=>"query", "name"=>"interval", "description"=>"By time interval"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions"=>{"get"=>{"summary"=>"Subscriptions List", "description"=>"Lists all subscriptions of the API Management service instance.", "operationId"=>"Subscriptions_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamesubscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||--------------|------------------------|---------------------------------------------|| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || state | eq | |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}"=>{"get"=>{"summary"=>"Subscriptions Get", "description"=>"Gets the specified Subscription entity.", "operationId"=>"Subscriptions_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamesubscriptionssid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}, "put"=>{"summary"=>"Subscriptions CreateOrUpdate", "description"=>"Creates or updates the subscription of specified user to the specified product.", "operationId"=>"Subscriptions_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamesubscriptionssid-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Create parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}, "patch"=>{"summary"=>"Subscriptions Update", "description"=>"Updates the details of a subscription specificied by its identifier.", "operationId"=>"Subscriptions_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamesubscriptionssid-patch", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"ETag of the Subscription Entity"}, {"in"=>"body", "name"=>"parameters", "description"=>"Update parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}, "delete"=>{"summary"=>"Subscriptions Delete", "description"=>"Deletes the specified subscription.", "operationId"=>"Subscriptions_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamesubscriptionssid-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"ETag of the Subscription Entity"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regeneratePrimaryKey"=>{"post"=>{"summary"=>"Subscriptions RegeneratePrimaryKey", "description"=>"Regenerates primary key of existing subscription of the API Management service instance.", "operationId"=>"Subscriptions_RegeneratePrimaryKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamesubscriptionssidregenerateprimarykey-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regenerateSecondaryKey"=>{"post"=>{"summary"=>"Subscriptions RegenerateSecondaryKey", "description"=>"Regenerates secondary key of existing subscription of the API Management service instance.", "operationId"=>"Subscriptions_RegenerateSecondaryKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenamesubscriptionssidregeneratesecondarykey-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access"=>{"get"=>{"summary"=>"TenantAccess Get", "description"=>"Get tenant access information details.", "operationId"=>"TenantAccess_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenametenantaccess-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants"]}, "patch"=>{"summary"=>"TenantAccess Update", "description"=>"Update tenant access information details.", "operationId"=>"TenantAccess_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenametenantaccess-patch", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the tenant access settings to update"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access/regeneratePrimaryKey"=>{"post"=>{"summary"=>"TenantAccess RegeneratePrimaryKey", "description"=>"Regenerate primary access key.", "operationId"=>"TenantAccess_RegeneratePrimaryKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenametenantaccessregenerateprimarykey-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access/regenerateSecondaryKey"=>{"post"=>{"summary"=>"TenantAccess RegenerateSecondaryKey", "description"=>"Regenerate secondary access key.", "operationId"=>"TenantAccess_RegenerateSecondaryKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenametenantaccessregeneratesecondarykey-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access/git"=>{"get"=>{"summary"=>"TenantAccessGit Get", "description"=>"Gets the Git access configuration for the tenant.", "operationId"=>"TenantAccessGit_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenametenantaccessgit-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access/git/regeneratePrimaryKey"=>{"post"=>{"summary"=>"TenantAccessGit RegeneratePrimaryKey", "description"=>"Regenerate primary access key for GIT.", "operationId"=>"TenantAccessGit_RegeneratePrimaryKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenametenantaccessgitregenerateprimarykey-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access/git/regenerateSecondaryKey"=>{"post"=>{"summary"=>"TenantAccessGit RegenerateSecondaryKey", "description"=>"Regenerate secondary access key for GIT.", "operationId"=>"TenantAccessGit_RegenerateSecondaryKey", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenametenantaccessgitregeneratesecondarykey-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/deploy"=>{"post"=>{"summary"=>"TenantConfiguration Deploy", "description"=>"This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.", "operationId"=>"TenantConfiguration_Deploy", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenametenantconfigurationdeploy-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Deploy Configuration parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/save"=>{"post"=>{"summary"=>"TenantConfiguration Save", "description"=>"This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.", "operationId"=>"TenantConfiguration_Save", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenametenantconfigurationsave-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Save Configuration parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/validate"=>{"post"=>{"summary"=>"TenantConfiguration Validate", "description"=>"This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.", "operationId"=>"TenantConfiguration_Validate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenametenantconfigurationvalidate-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Validate Configuration parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/syncState"=>{"get"=>{"summary"=>"TenantConfigurationSyncState Get", "description"=>"Gets the status of the most recent synchronization between the configuration database and the Git repository.", "operationId"=>"TenantConfigurationSyncState_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenametenantconfigurationsyncstate-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/policy"=>{"get"=>{"summary"=>"TenantPolicy Get", "description"=>"Get the global policy configuration of the tenant.", "operationId"=>"TenantPolicy_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenametenantpolicy-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenant Policy"]}, "put"=>{"summary"=>"TenantPolicy CreateOrUpdate", "description"=>"Creates or updates global policy configuration for the tenant.", "operationId"=>"TenantPolicy_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenametenantpolicy-put", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the tenant policy to update"}, {"in"=>"body", "name"=>"parameters", "description"=>"The policy content details", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenant Policy"]}, "delete"=>{"summary"=>"TenantPolicy Delete", "description"=>"Deletes the global tenant policy configuration.", "operationId"=>"TenantPolicy_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenametenantpolicy-delete", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the tenant policy to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenant Policy"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users"=>{"get"=>{"summary"=>"Users ListByService", "description"=>"Lists a collection of registered users in the specified service instance.", "operationId"=>"Users_ListByService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameusers-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||------------------|------------------------|-----------------------------------|| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || state | eq | N/A || registrationDate | ge, le, eq, ne, gt, lt | N/A || note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}"=>{"get"=>{"summary"=>"Users Get", "description"=>"Gets the details of the user specified by its identifier.", "operationId"=>"Users_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameusersuid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "put"=>{"summary"=>"Users CreateOrUpdate", "description"=>"Creates or Updates a user.", "operationId"=>"Users_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameusersuid-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Create or update parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "patch"=>{"summary"=>"Users Update", "description"=>"Updates the details of the user specified by its identifier.", "operationId"=>"Users_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameusersuid-patch", "parameters"=>[{"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the user to update"}, {"in"=>"body", "name"=>"parameters", "description"=>"Update parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "delete"=>{"summary"=>"Users Delete", "description"=>"Deletes specific user.", "operationId"=>"Users_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameusersuid-delete", "parameters"=>[{"in"=>"query", "name"=>"deleteSubscriptions", "description"=>"Whether to delete users subscription or not"}, {"in"=>"header", "name"=>"If-Match", "description"=>"The entity state (Etag) version of the user to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/generateSsoUrl"=>{"post"=>{"summary"=>"Users GenerateSsoUrl", "description"=>"Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.", "operationId"=>"Users_GenerateSsoUrl", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameusersuidgeneratessourl-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/groups"=>{"get"=>{"summary"=>"UserGroups ListByUsers", "description"=>"Lists all user groups.", "operationId"=>"UserGroups_ListByUsers", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameusersuidgroups-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||-------------|------------------------|---------------------------------------------|| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/subscriptions"=>{"get"=>{"summary"=>"UserSubscriptions ListByUsers", "description"=>"Lists the collection of subscriptions of the specified user.", "operationId"=>"UserSubscriptions_ListByUsers", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameusersuidsubscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"| Field | Supported operators | Supported functions ||--------------|------------------------|---------------------------------------------|| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || state | eq | |"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/identities"=>{"get"=>{"summary"=>"UserIdentities ListByUsers", "description"=>"Lists all user identities.", "operationId"=>"UserIdentities_ListByUsers", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameusersuididentities-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}}}, "apis"=>{"name"=>"Azure API Management", "x-slug"=>"azure-api-management", "description"=>"Use Azure API Management as a turnkey solution for publishing APIs to external and internal customers. Quickly create consistent and modern API gateways for existing back-end services hosted anywhere, secure and protect them from abuse and overuse, and get insights into usage and health. Plus, automate and scale developer onboarding to help get your API program up and running.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-api-management.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Management,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-api-management/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure API Management API", "x-api-slug"=>"azure-api-management-api", "description"=>"Use Azure API Management as a turnkey solution for publishing APIs to external and internal customers. Quickly create consistent and modern API gateways for existing back-end services hosted anywhere, secure and protect them from abuse and overuse, and get insights into usage and health. Plus, automate and scale developer onboarding to help get your API program up and running.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-api-management.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/api-management/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Management,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-api-management/subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-apimanagementserviceservicenameusersuididentities-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-api-management/azure-api-management-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/api-management/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/api-management/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/api-management/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/api-management/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
netatmo{"apis"=>{"name"=>"Netatmo", "x-slug"=>"netatmo", "description"=>"We develop groundbreaking, intuitive and beautifully-designed connected consumer electronics. Truly smart, our innovative products provide a seamless experience that helps users create a safer, healthier and more comfortable home. We carefully design the mechanics, electronics and embedded software of all our products to the highest standards. Our mobile and web applications are designed to be simple to operate, yet deliver a rich user experience.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/netatmo-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Home,Profiles,Relative Data,Security Cameras,Service API,Weather", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"netatmo/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Netatmo", "x-api-slug"=>"netatmo", "description"=>"Netatmo offers wireless thermostats and air quality measuring devices that can be accessed over the internet. Their Private API allows device owners to grant third party applications access to their devices in order to retrieve the data the devices have recorded. In the near future, developers will also have access to the Netatmo Public API, which will allow third party applications to retrieve data that has been marked as public by the device's owner.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/netatmo-logo.png", "humanURL"=>"http://www.netatmo.com", "baseURL"=>"https://api.netatmo.net//api", "tags"=>"API Provider,API Service Provider,Home,Profiles,Relative Data,Security Cameras,Service API,Weather", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/netatmo/netatmo-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://www.netatmo.com"}, {"type"=>"x-documentation", "url"=>"https://dev.netatmo.com/resources/technical/reference"}, {"type"=>"x-github", "url"=>"https://github.com/netatmo"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/netatmo"}, {"type"=>"x-website", "url"=>"http://netatmo.net"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "netatmo-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Netatmo", "x-complete"=>1, "info"=>{"title"=>"Netatmo", "description"=>"we-develop-groundbreaking-intuitive-and-beautifullydesigned-connected-consumer-electronics--truly-smart-our-innovative-products-provide-a-seamless-experience-that-helps-users-create-a-safer-healthier-and-more-comfortable-home---we-carefully-design-the-mechanics-electronics-and-embedded-software-of-all-our-products-to-the-highest-standards--our-mobile-and-web-applications-are-designed-to-be-simple-to-operate-yet-deliver-a-rich-user-experience-", "termsOfService"=>"https://dev.netatmo.com/dev/resources/legal/introduction", "contact"=>{"name"=>"Netatmo", "email"=>"contact-api@netatmo.com"}, "version"=>"1.1.1"}, "host"=>"api.netatmo.net", "basePath"=>"/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/addwebhook"=>{"get"=>{"summary"=>"Get Addwebhook", "description"=>"Links a callback url to a user.", "operationId"=>"addwebhook", "x-api-path-slug"=>"addwebhook-get", "parameters"=>[{"in"=>"query", "name"=>"app_type", "description"=>"Webhooks are only available for Welcome, enter app_camera"}, {"in"=>"query", "name"=>"url", "description"=>"Your webhook callback url"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web Hooks"]}}, "/createnewschedule"=>{"post"=>{"summary"=>"Post Createnewschedule", "description"=>"The method createnewschedule creates a new schedule stored in the backup list.", "operationId"=>"createnewschedule", "x-api-path-slug"=>"createnewschedule-post", "parameters"=>[{"in"=>"query", "name"=>"device_id", "description"=>"The relay id"}, {"in"=>"query", "name"=>"module_id", "description"=>"The thermostat id"}, {"in"=>"body", "name"=>"therm_program", "description"=>"The thermostat program (zones and timetable)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedules"]}}, "/devicelist"=>{"get"=>{"summary"=>"Get Devicelist", "description"=>"The method devicelist returns the list of devices owned by the user, and their modules.\nA device is identified by its _id (which is its mac address) and each device may have one, several or no modules, also identified by an _id.", "operationId"=>"devicelist", "x-api-path-slug"=>"devicelist-get", "parameters"=>[{"in"=>"query", "name"=>"app_type", "description"=>"Defines which device type will be returned by devicelist"}, {"in"=>"query", "name"=>"device_id", "description"=>"Specify a device_id if you want to retrieve only this device informations"}, {"in"=>"query", "name"=>"get_favorites", "description"=>"When set to true, the favorite devices of the user are returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/dropwebhook"=>{"get"=>{"summary"=>"Get Dropwebhook", "description"=>"Dissociates a webhook from a user.", "operationId"=>"dropwebhook", "x-api-path-slug"=>"dropwebhook-get", "parameters"=>[{"in"=>"query", "name"=>"app_type", "description"=>"For Welcome, use app_camera"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Web Hooks"]}}, "/getcamerapicture"=>{"get"=>{"summary"=>"Get Getcamerapicture", "description"=>"Returns the snapshot associated to an event.", "operationId"=>"getcamerapicture", "x-api-path-slug"=>"getcamerapicture-get", "parameters"=>[{"in"=>"query", "name"=>"image_id", "description"=>"id of the image (can be retrieved as id in face in Gethomedata, or as id in snapshot in Getnextevents, Getlasteventof and Geteventsuntil)"}, {"in"=>"query", "name"=>"key", "description"=>"Security key to access snapshots"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cameras", "ictures"]}}, "/geteventsuntil"=>{"get"=>{"summary"=>"Get Geteventsuntil", "description"=>"Returns the snapshot associated to an event.", "operationId"=>"geteventsuntil", "x-api-path-slug"=>"geteventsuntil-get", "parameters"=>[{"in"=>"query", "name"=>"event_id", "description"=>"Your request will retrieve all the events until this one"}, {"in"=>"query", "name"=>"home_id", "description"=>"ID of the Home youre interested in"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/gethomecoachsdata"=>{"get"=>{"summary"=>"Get Gethomecoachsdata", "description"=>"The method gethomecoachsdata Returns data from a user Healthy Home Coach Station (measures and device specific data).", "operationId"=>"gethomecoachsdata", "x-api-path-slug"=>"gethomecoachsdata-get", "parameters"=>[{"in"=>"query", "name"=>"device_id", "description"=>"Id of the device you want to retrieve information of"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/gethomedata"=>{"get"=>{"summary"=>"Get Gethomedata", "description"=>"Returns information about users homes and cameras.", "operationId"=>"gethomedata", "x-api-path-slug"=>"gethomedata-get", "parameters"=>[{"in"=>"query", "name"=>"home_id", "description"=>"Specify if youre looking for the events of a specific Home"}, {"in"=>"query", "name"=>"size", "description"=>"Number of events to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/getlasteventof"=>{"get"=>{"summary"=>"Get Getlasteventof", "description"=>"Returns most recent events.", "operationId"=>"getlasteventof", "x-api-path-slug"=>"getlasteventof-get", "parameters"=>[{"in"=>"query", "name"=>"home_id", "description"=>"ID of the Home youre interested in"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of events to retrieve"}, {"in"=>"query", "name"=>"person_id", "description"=>"Your request will retrieve all events of the given home until the most recent event of the given person"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/getmeasure"=>{"get"=>{"summary"=>"Get Getmeasure", "description"=>"The method getmeasure returns the measurements of a device or a module.", "operationId"=>"getmeasure", "x-api-path-slug"=>"getmeasure-get", "parameters"=>[{"in"=>"query", "name"=>"date_begin", "description"=>"Starting timestamp (utc) of the requested measurements"}, {"in"=>"query", "name"=>"date_end", "description"=>"Ending timestamp (utc) of the request measurements"}, {"in"=>"query", "name"=>"device_id", "description"=>"Id of the device whose modules measurements you want to retrieve"}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of measurements returned (default & max is 1024)"}, {"in"=>"query", "name"=>"module_id", "description"=>"If you dont specify any module_id you will retrieve the devices measurements"}, {"in"=>"query", "name"=>"optimize", "description"=>"Allows you to choose the format of the answer"}, {"in"=>"query", "name"=>"real_time", "description"=>"In scales higher than max, since the data is aggregated, the timestamps returned are by default offset by +(scale/2)"}, {"in"=>"query", "name"=>"scale", "description"=>"Defines the time interval between two measurements"}, {"in"=>"query", "name"=>"type", "description"=>"Sets the type of measurement you want to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/getnextevents"=>{"get"=>{"summary"=>"Get Getnextevents", "description"=>"Returns previous events.", "operationId"=>"getnextevents", "x-api-path-slug"=>"getnextevents-get", "parameters"=>[{"in"=>"query", "name"=>"event_id", "description"=>"Your request will retrieve events occured before this one"}, {"in"=>"query", "name"=>"home_id", "description"=>"ID of the Home youre interested in"}, {"in"=>"query", "name"=>"size", "description"=>"Number of events to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices", "Events"]}}, "/getstationsdata"=>{"get"=>{"summary"=>"Get Getstationsdata", "description"=>"The method getstationsdata Returns data from a user Weather Stations (measures and device specific data).", "operationId"=>"getstationsdata", "x-api-path-slug"=>"getstationsdata-get", "parameters"=>[{"in"=>"query", "name"=>"device_id", "description"=>"Id of the device you want to retrieve information of"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Stations"]}}, "/getthermostatsdata"=>{"get"=>{"summary"=>"Get Getthermostatsdata", "description"=>"The method getthermostatsdata returns information about user's thermostats such as their last measurements.", "operationId"=>"getthermostatsdata", "x-api-path-slug"=>"getthermostatsdata-get", "parameters"=>[{"in"=>"query", "name"=>"device_id", "description"=>"Id of the device you want to retrieve information of"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/getthermstate"=>{"get"=>{"summary"=>"Get Getthermstate", "description"=>"The method getthermstate returns the last Thermostat measurements, its current weekly schedule, and, if present, its current manual temperature setpoint.", "operationId"=>"getthermstate", "x-api-path-slug"=>"getthermstate-get", "parameters"=>[{"in"=>"query", "name"=>"device_id", "description"=>"The relay id"}, {"in"=>"query", "name"=>"module_id", "description"=>"The thermostat id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/getuser"=>{"get"=>{"summary"=>"Get Getuser", "description"=>"The method getuser returns information about a user such as prefered language, prefered units, and list of devices.", "operationId"=>"getuser", "x-api-path-slug"=>"getuser-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/partnerdevices"=>{"get"=>{"summary"=>"Get Partnerdevices", "description"=>"The method partnerdevices returns the list of device_id to which your partner application has access to.", "operationId"=>"partnerdevices", "x-api-path-slug"=>"partnerdevices-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Partners"]}}, "/setpersonsaway"=>{"get"=>{"summary"=>"Get Setpersonsaway", "description"=>"Sets a person as 'Away' or the Home as 'Empty'. The event will be added to the user???s timeline.", "operationId"=>"setpersonsaway", "x-api-path-slug"=>"setpersonsaway-get", "parameters"=>[{"in"=>"query", "name"=>"home_id", "description"=>"ID of the Home youre interested in"}, {"in"=>"query", "name"=>"person_id", "description"=>"If a person_id is specified, that person will be set as Away"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/setthermpoint"=>{"post"=>{"summary"=>"Post Setthermpoint", "description"=>"The method setthermpoint changes the Thermostat manual temperature setpoint.", "operationId"=>"setthermpoint", "x-api-path-slug"=>"setthermpoint-post", "parameters"=>[{"in"=>"query", "name"=>"device_id", "description"=>"The relay id"}, {"in"=>"query", "name"=>"module_id", "description"=>"The thermostat id"}, {"in"=>"query", "name"=>"setpoint_endtime", "description"=>"When using the manual or max setpoint_mode, this parameter defines when the setpoint expires"}, {"in"=>"query", "name"=>"setpoint_mode", "description"=>"Chosen setpoint_mode"}, {"in"=>"query", "name"=>"setpoint_temp", "description"=>"When using the manual setpoint_mode, this parameter defines the temperature setpoint (in Celcius) to use"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/switchschedule"=>{"post"=>{"summary"=>"Post Switchschedule", "description"=>"The method switchschedule switches the Thermostat's schedule to another existing schedule.", "operationId"=>"switchschedule", "x-api-path-slug"=>"switchschedule-post", "parameters"=>[{"in"=>"query", "name"=>"device_id", "description"=>"The relay id"}, {"in"=>"query", "name"=>"module_id", "description"=>"The thermostat id"}, {"in"=>"query", "name"=>"schedule_id", "description"=>"The schedule id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedules"]}}, "/syncschedule"=>{"post"=>{"summary"=>"Post Syncschedule", "description"=>"The method syncschedule changes the Thermostat weekly schedule.", "operationId"=>"syncschedule", "x-api-path-slug"=>"syncschedule-post", "parameters"=>[{"in"=>"query", "name"=>"device_id", "description"=>"The relay id"}, {"in"=>"query", "name"=>"module_id", "description"=>"The thermostat id"}, {"in"=>"body", "name"=>"therm_program", "description"=>"The thermostat program (zones, timetable and name)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schedules"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
chaingenie{"chaingenie-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"ChainGenie", "x-complete"=>1, "info"=>{"title"=>"ChainGenie = DLT + Blockchain + Magic", "description"=>"chaingenie-is-here-to-help-companies-enjoy-the-benefits-of-blockchain-technology-distributed-tamper-proof-record-keeping-consensus-between-distrusting-nodes-when-you-do-not-have-the-expensive-blockchain-resources-chaingenie-offers-a-hook-to-connect-your-existing-it-applications-to-popular-blockchain-networks-like-ethereum-bitcoin-blockchain-etc-with-great-ease---want-to-know-how-chaingenie-works-under-the-hood-download-our-flyer--httpchaingenie-comchaingenieflyer-pdfthe-following-is-only-teaser-documentation--for-full-information-email--a-hrefmailtomagicchaingenie-commagicchaingenie-comahrupdate-09262016-brullibanking-micro-services-addedliliapikey-is-required-for-invoking-any-micro-serviceliulemail-a-hrefmailtomagicchaingenie-commagicchaingenie-coma-for-your-sandbox-apikey-hrcoming-soon-brmagic-canvas--drag-and-drop-microservices-to-create-a-blockchain-application---iblockchain-made-easyihrwant-to-connect-with-me-on-linkedin-send-me-an-invite--a-hrefhttplinkedin-cominupriya-target-blankhttplinkedin-cominupriyaahrscript----function-i-s-o-g-r-a-m---------igoogleanalyticsobject--r-ir--ir--function--------------ir-q--ir-q---pusharguments---------ir-l--1--new-date-a--s-createelemento--m--s-getelementsbytagnameo0-a-async--1-a-src--g-m-parentnode-insertbeforea-m----window-document-script-httpswww-googleanalytics-comanalytics-js-ga----gacreate-ua825523031-auto----gasend-pageviewscript", "version"=>"1.0"}, "host"=>"api.chaingenie.com", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/ethbank/deposit"=>{"post"=>{"summary"=>"Deposit into bank account", "description"=>"Deposit crypto currency into the bank. In sandbox mode, the account used is the demo account on the blockchain server.", "operationId"=>"EthbankDepositPost", "x-api-path-slug"=>"ethbankdeposit-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Deposit", "Into", "Bank", "Account"]}}, "/ethbank/withdraw"=>{"post"=>{"summary"=>"Withdraw from bank account", "description"=>"Withdraw crypto currency into the bank. In sandbox mode, the account used is the demo account on the blockchain server. Of course, you can only withdraw if there is money in the account!", "operationId"=>"EthbankWithdrawPost", "x-api-path-slug"=>"ethbankwithdraw-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Withdraw", "From", "Bank", "Account"]}}, "/ethbank/passbook"=>{"get"=>{"summary"=>"Bank passbook (user)", "description"=>"Displays all transactions made by the user", "operationId"=>"EthbankPassbookGet", "x-api-path-slug"=>"ethbankpassbook-get", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Bank", "Passbook", "(user)"]}}, "/ethbank/balance"=>{"get"=>{"summary"=>"Bank balance (user)", "description"=>"Displays user bank balance information", "operationId"=>"EthbankBalanceGet", "x-api-path-slug"=>"ethbankbalance-get", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Bank", "Balance", "(user)"]}}, "/ethledger/invokecontract"=>{"post"=>{"summary"=>"Generate, Sign & Route Document (Advanced)", "description"=>"This API is the generic version of the \"Generate document from template\" API. Any template file can be uploaded (sample available as link for testing). If you just want to see how this would work - use the other call and just run it without any uploaded certificate. \nUpload a templated pdf with editable / filable fields and generate a document with automated sign and routing to a recipient. Every attribute that needs to be filled will need to be passed in the format - ex. course field to be substituted - field = attrib; value = [\"course\",\"course value\"] or date field to be substituted - field = attrib; value = [\"date\",\"12/12/2016\"]. If your fillable form has the field named \"today\", current time will be used for filling the value of that field.\nYou will need to upload for the file attribute a real template file with fillable fields. For the sample values as configured, you can use the demo template available at http://chaingenie.com/cert.pdf. Download this certificate and add it as your input file\nTo route the document to recipient (optional) add field recipient with \"key\" of the recipient - available recipient in the system - 0xb3A214341df9560a3e09E256BfacefD6648f5Ca9 for your testing\nUse case - Upload an invoice template with fillable fields, add attrib values for all the fields that needs to be filled, add the recipient field - your invoice will be created, signed with your key (in production / in test it will be signed with the local admin key) and will be routed to the recipient (in production you can add your recipient / in sandbox - use recipient 0xb3A214341df9560a3e09E256BfacefD6648f5Ca9)\nResponse will contain the document name, signatories, timestamps, recipient, IPFS hash (handle to retrieve the actual document)\nThe document hash will be posted on blockchain and the actual document will be added to IPFS. Want to retrieve your document? Check out the API - Write & Retrieve - Docs (IPFS).", "operationId"=>"EthledgerInvokecontractPost", "x-api-path-slug"=>"ethledgerinvokecontract-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"attribs"}, {"in"=>"formData", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Generate", "", "Sign", "&", "Route", "Document", "(Advanced)"]}}, "/ethledger/docert"=>{"post"=>{"summary"=>"Generate and Manage Document (Basic)", "description"=>"This is an over simplified version for testing this API for its powers a template - uses an inbuilt into ChainGenie template and values are preconfigured - just running this will work and provide you an IPFS handle to retrieve the document you generated with your variables / values from the template.\nUse an existing document on our server and generate a document with automated sign and routing to a recipient. Ex. this configured api will generate a certificate for a student name (name) with the completed certificate course (course) and dated (date). \nThe document hash will be posted on blockchain and the actual document will be added to IPFS. Want to retrieve your document? Check out the API - Write & Retrieve - Docs (IPFS).", "operationId"=>"EthledgerDocertPost2", "x-api-path-slug"=>"ethledgerdocert-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"course"}, {"in"=>"formData", "name"=>"date"}, {"in"=>"formData", "name"=>"students"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Generate", "Manage", "Document", "(Basic)"]}}, "/ethledger/sendforsign"=>{"post"=>{"summary"=>"Send document", "description"=>"Route the document for signature. The document history and status is updated for querying.", "operationId"=>"EthledgerSendforsignPost", "x-api-path-slug"=>"ethledgersendforsign-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"files"}, {"in"=>"formData", "name"=>"recipient"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Send", "Document"]}}, "/ethledger/sign"=>{"post"=>{"summary"=>"Sign document", "description"=>"Cryptographically sign the document and add the record to blockchain. The document history and status is updated for querying.", "operationId"=>"EthledgerSignPost", "x-api-path-slug"=>"ethledgersign-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"files"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Sign", "Document"]}}, "/ethledger/docstatus"=>{"post"=>{"summary"=>"Get document status with file", "description"=>"Review the document status - existence, hash, block info, signatories, routing to users and details", "operationId"=>"EthledgerDocstatusPost", "x-api-path-slug"=>"ethledgerdocstatus-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"files"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Document", "Status", "File"]}}, "/ethledger/existsdoc"=>{"post"=>{"summary"=>"Check document exists on blockchain", "description"=>"Check if your documents exists in the eth blockchain", "operationId"=>"EthledgerExistsdocPost", "x-api-path-slug"=>"ethledgerexistsdoc-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"files"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Check", "Document", "Exists", "On", "Blockchain"]}}, "/ethledger/postdoc"=>{"post"=>{"summary"=>"Post document to IPFS + blockchain", "description"=>"Post document hash into eth chain for POE (proof of existence) and post the document into ipfs for safekeep!", "operationId"=>"EthledgerPostdocPost", "x-api-path-slug"=>"ethledgerpostdoc-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"files"}, {"in"=>"formData", "name"=>"filetypes"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Document", "To", "IPFS", "+", "Blockchain"]}}, "/ethledger/sendcert"=>{"post"=>{"summary"=>"Send document using hash (min fn; no return)", "description"=>"Route the document to a recipient. The document history and status is updated for querying. The API call does not return any document properties. This is a minimalistic function for stringing with other functions", "operationId"=>"EthledgerSendcertPost", "x-api-path-slug"=>"ethledgersendcert-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"recipient"}, {"in"=>"formData", "name"=>"strHash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Send", "Document", "Using", "Hash", "(min", "Fn;", "No", "Return)"]}}, "/ethledger/signcert"=>{"post"=>{"summary"=>"Sign document using hash (min fn; no return)", "description"=>"Cryptographically sign the document and add the record to blockchain. The document history and status is updated for querying. The API call does not return any document properties. This is a minimalistic function for stringing with other functions", "operationId"=>"EthledgerSigncertPost", "x-api-path-slug"=>"ethledgersigncert-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"strHash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Sign", "Document", "Using", "Hash", "(min", "Fn;", "No", "Return)"]}}, "/ethledger/getdocstate"=>{"post"=>{"summary"=>"Get document status using hash", "description"=>"Review the document status - existence, hash, block info, signatories, routing to users and details", "operationId"=>"EthledgerGetdocstatePost", "x-api-path-slug"=>"ethledgergetdocstate-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"strHash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Document", "Status", "Using", "Hash"]}}, "/ethledger/posthash"=>{"post"=>{"summary"=>"Write hash to blockchain", "description"=>"Post string hash into eth chain for POE (proof of existence)", "operationId"=>"EthledgerPosthashPost", "x-api-path-slug"=>"ethledgerposthash-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Write", "Hash", "To", "Blockchain"]}}, "/ethledger/existshash"=>{"post"=>{"summary"=>"Check hash exists on blockchain", "description"=>"Check if your hash exists in the eth blockchain", "operationId"=>"EthledgerExistshashPost", "x-api-path-slug"=>"ethledgerexistshash-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Check", "Hash", "Exists", "On", "Blockchain"]}}, "/ethledger/poststr"=>{"post"=>{"summary"=>"Write message to blockchain", "description"=>"Post string hash into eth chain for POE (proof of existence)", "operationId"=>"EthledgerPoststrPost", "x-api-path-slug"=>"ethledgerpoststr-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"str"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Write", "Message", "To", "Blockchain"]}}, "/ethledger/existsstr"=>{"post"=>{"summary"=>"Check message exists on blockchain", "description"=>"Check if your string exists in the eth blockchain", "operationId"=>"EthledgerExistsstrPost", "x-api-path-slug"=>"ethledgerexistsstr-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"str"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Check", "Message", "Exists", "On", "Blockchain"]}}, "/ethledger/gettrans"=>{"get"=>{"summary"=>"Document transactions", "description"=>"Displays all transactions connected to this project / smart contract", "operationId"=>"EthledgerGettransGet", "x-api-path-slug"=>"ethledgergettrans-get", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Document", "Transactions"]}}, "/tradechain/CreateTradeContract"=>{"post"=>{"summary"=>"List product for sale", "description"=>"List product on marketplace: \r\n- Seller initiates sale - CreateTradeContract \r\n- Escrow from seller added for value of contract \r\n- End transaction state = Smart Contract Created ", "operationId"=>"TradechainCreateTradeContractPost", "x-api-path-slug"=>"tradechaincreatetradecontract-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"itemName"}, {"in"=>"formData", "name"=>"itemPartNum"}, {"in"=>"formData", "name"=>"itemSellerName"}, {"in"=>"formData", "name"=>"itemValidUntil"}, {"in"=>"formData", "name"=>"itemValue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "List", "Productsale"]}}, "/tradechain/ConfirmAbort"=>{"post"=>{"summary"=>"Remove Listing (by Seller)", "description"=>"Remove Listing (by Seller) \r\n- Seller cancels the market trade after listing but before bid/buy \r\n- Escrow from seller is returned back to the seller \r\n- End transaction state = Smart contract is rendered inactive ", "operationId"=>"TradechainConfirmAbortPost", "x-api-path-slug"=>"tradechainconfirmabort-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"itemContractId"}, {"in"=>"formData", "name"=>"itemSellerName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Remove", "Listing", "(by", "Seller)"]}}, "/tradechain/ConfirmPurchase"=>{"post"=>{"summary"=>"Bid / buy listed item (by Buyer)", "description"=>"Bid / buy the item listed on the marketplace: \r\n- Buyer confirms interest in buying \r\n- Escrow from buyer added to value of contract \r\n- Invoice document is created with all details using invoice template \r\n- Invoice is added IPFS and invoice hash into blockchain \r\n- End transaction state = Trade is actively locked between the seller and buyer ", "operationId"=>"TradechainConfirmPurchasePost", "x-api-path-slug"=>"tradechainconfirmpurchase-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"itemBuyerName"}, {"in"=>"formData", "name"=>"itemContractId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Bid", "", "", "Buy", "Listed", "Item", "(by", "Buyer)"]}}, "/tradechain/ConfirmRefund"=>{"post"=>{"summary"=>"Refund buyer and stop trade (by Seller)", "description"=>"Seller can cancel the market trade after bid/buy by refunding the seller \r\nEscrow from buyer is returned back to the buyer \r\nEscrow from seller is returned back to the seller (optional: penalties can be imposed) \r\nEnd transaction state = Escrow returned, smart contract cancelled and become inactive ", "operationId"=>"TradechainConfirmRefundPost", "x-api-path-slug"=>"tradechainconfirmrefund-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"itemContractId"}, {"in"=>"formData", "name"=>"itemSellerName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Refund", "Buyer", "Stop", "Trade", "(by", "Seller)"]}}, "/tradechain/ConfirmReceived"=>{"post"=>{"summary"=>"Delivery of item confirmed (by Buyer)", "description"=>"Delivery of item confirmed by the buyer \r\n-Escrow is fully sent to seller\r\n- End transaction state = TRANSACTION COMPLETE", "operationId"=>"TradechainConfirmReceivedPost", "x-api-path-slug"=>"tradechainconfirmreceived-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"itemBuyerName"}, {"in"=>"formData", "name"=>"itemContractId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Delivery", "Of", "Item", "Confirmed", "(by", "Buyer)"]}}, "/tradechain/GetStateOfContract"=>{"post"=>{"summary"=>"Get contract details & state", "description"=>"Get contract details & state\n- Provide full information including\n - Escrow amount in contract\n - Contract state \n - Buyer & Seller information\n - Links to contract / invoice documents\n - and other contract / sale specific information", "operationId"=>"TradechainGetStateOfContractPost", "x-api-path-slug"=>"tradechaingetstateofcontract-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"itemContractId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Contract", "Details", "&", "State"]}}, "/tradechain/GetFundsLockedInContract"=>{"post"=>{"summary"=>"Get contract escrow details", "description"=>"Get contract escrow details -\n- Retrieves full information including but not limited to\n - Escrow amount in contract\n - Contract state \n - Buyer & Seller information\n - Links to contract / invoice documents\n - and other contract / sale specific information", "operationId"=>"TradechainGetFundsLockedInContractPost", "x-api-path-slug"=>"tradechaingetfundslockedincontract-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"itemContractId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Contract", "Escrow", "Details"]}}, "/tradechain/WhoIsSeller"=>{"post"=>{"summary"=>"Get seller information", "description"=>"Get full information about the seller by providing the contract id. Response will also include some contract details.", "operationId"=>"TradechainWhoIsSellerPost", "x-api-path-slug"=>"tradechainwhoisseller-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"itemContractId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Seller", "Information"]}}, "/tradechain/WhoIsBuyer"=>{"post"=>{"summary"=>"Get buyer information", "description"=>"Get full information about the seller by providing the contract id. Response will also include some contract details.", "operationId"=>"TradechainWhoIsBuyerPost", "x-api-path-slug"=>"tradechainwhoisbuyer-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"itemContractId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Buyer", "Information"]}}, "/tradechain/GetItemsFilterSort"=>{"post"=>{"summary"=>"Report / list of marketplace transactions", "description"=>"Use a combination of fields to get any type of report. Ex. send specific seller name or id to get active for sale items by seller; send specific filehash to get status of a particular item/invoice; send itemPartNum to get a list of all products of that partnumber and send sort order as itemValue ascending to cheapest top list) . . . \r\n-\tfilterField (accepted items below, default – none)\r\no\titemSellerId\r\no\titemSellerName\r\no\titemBuyerId\r\no\titemBuyerName\r\no\titemId\r\no\titemName\r\no\titemPartNum\r\no\tfileHash\r\no\tFileHash\r\n-\tsortField (accepted items below, default – itemValidUntil)\r\no\titemSellerId\r\no\titemSellerName\r\no\titemBuyerId\r\no\titemBuyerName\r\no\titemId\r\no\titemName\r\no\titemValue\r\no\titemPartNum\r\no\titemValidUntil\r\n-\tsortOrder (default – desc)\r\no\tasc\r\no\tdesc\r\n-\tonSaleOnly (default – true, only if not “Inactive”)\r\no\ttrue\r\no\tfalse\r\n-\tmaxPrice (double; default - 0)", "operationId"=>"TradechainGetItemsFilterSortPost", "x-api-path-slug"=>"tradechaingetitemsfiltersort-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"filterField"}, {"in"=>"formData", "name"=>"filterValue"}, {"in"=>"formData", "name"=>"maxPrice"}, {"in"=>"formData", "name"=>"onSaleOnly"}, {"in"=>"formData", "name"=>"sortField"}, {"in"=>"formData", "name"=>"sortOrder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Report", "", "", "List", "Of", "Marketplace", "Transactions"]}}, "/basicfns/GetAccountBalance"=>{"post"=>{"summary"=>"Get user's account balance (*)", "description"=>"Get information about an user's account balance. The call is restricted to the unlocked user's account / query only. * In this sandbox, you can query any user's account balance for testing purposes. All accounts are test accounts and no actual value or account is exposed in the sandbox.", "operationId"=>"BasicfnsGetAccountBalancePost", "x-api-path-slug"=>"basicfnsgetaccountbalance-post", "parameters"=>[{"in"=>"formData", "name"=>"accountId"}, {"in"=>"header", "name"=>"ApiKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Users", "Account", "Balance", "(*)"]}}, "/ethledger/ipfsadd"=>{"post"=>{"summary"=>"Write document to IPFS", "description"=>"Post the document into ipfs for safekeep!", "operationId"=>"EthledgerIpfsaddPost", "x-api-path-slug"=>"ethledgeripfsadd-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"files"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Write", "Document", "To", "IPFS"]}}, "/ethledger/ipfsget"=>{"post"=>{"summary"=>"Retrieve document from IPFS", "description"=>"Retrieve the document stream from IPFS node", "operationId"=>"EthledgerIpfsgetPost", "x-api-path-slug"=>"ethledgeripfsget-post", "parameters"=>[{"in"=>"header", "name"=>"ApiKey"}, {"in"=>"formData", "name"=>"hash"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Retrieve", "Document", "From", "IPFS"]}}}}, "apis"=>{"name"=>"ChainGenie", "x-slug"=>"chaingenie", "description"=>"ChainGenie provides a plug and play platform that helps you connect your existing (or create new) applications to DLTs for lodging and workflow management using a simple easy to use user interface. ChainGenie is a platform to create blockchain apps that provide speed-to-market for companies looking to launch faster, rather than reinvent the wheel. Write your applications to run on popular Blockchain networks like Ethereum, Bitcoin Blockchain etc with great ease when you require to validate credentials or make your existing traditional applications use the power of DLT and blockchain overnight!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28902-api-chaingenie-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"", "tags"=>"Blockchain", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"chaingenie/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"ChainGenie", "x-api-slug"=>"chaingenie", "description"=>"ChainGenie provides a plug and play platform that helps you connect your existing (or create new) applications to DLTs for lodging and workflow management using a simple easy to use user interface. ChainGenie is a platform to create blockchain apps that provide speed-to-market for companies looking to launch faster, rather than reinvent the wheel. Write your applications to run on popular Blockchain networks like Ethereum, Bitcoin Blockchain etc with great ease when you require to validate credentials or make your existing traditional applications use the power of DLT and blockchain overnight!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28902-api-chaingenie-com.jpg", "humanURL"=>"http://chaingenie.com", "baseURL"=>"https://api.chaingenie.com//api/v1", "tags"=>"Blockchain", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/chaingenie/ethledgeripfsget-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/chaingenie/chaingenie-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-github", "url"=>"https://github.com/ChainGenie"}, {"type"=>"x-website", "url"=>"http://chaingenie.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/ChainGenie"}, {"type"=>"x-website", "url"=>"http://api.chaingenie.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-xray{"aws-xray-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS X-Ray", "x-complete"=>1, "info"=>{"title"=>"AWS X-Ray API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=BatchGetTraces"=>{"get"=>{"summary"=>"Batch Get Traces", "description"=>"Retrieves a list of traces specified by ID.", "operationId"=>"batchGetTraces", "x-api-path-slug"=>"actionbatchgettraces-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"Pagination token", "type"=>"string"}, {"in"=>"query", "name"=>"TraceIds", "description"=>"Specify the trace IDs of requests for which to retrieve segments", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traces"]}}, "/?Action=GetServiceGraph"=>{"get"=>{"summary"=>"Get Service Graph", "description"=>"Retrieves a document that describes services that process incoming requests, and\n downstream services that they call as a result.", "operationId"=>"getServiceGraph", "x-api-path-slug"=>"actiongetservicegraph-get", "parameters"=>[{"in"=>"query", "name"=>"EndTime", "description"=>"The end of the time frame for which to generate a graph", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"Pagination token", "type"=>"string"}, {"in"=>"query", "name"=>"StartTime", "description"=>"The start of the time frame for which to generate a graph", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service Graph"]}}, "/?Action=GetTraceGraph"=>{"get"=>{"summary"=>"Get Trace Graph", "description"=>"Retrieves a service graph for one or more specific trace IDs.", "operationId"=>"getTraceGraph", "x-api-path-slug"=>"actiongettracegraph-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"Pagination token", "type"=>"string"}, {"in"=>"query", "name"=>"TraceIds", "description"=>"Trace IDs of requests for which to generate a service graph", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trace Graph"]}}, "/?Action=GetTraceSummaries"=>{"get"=>{"summary"=>"Get Trace Summaries", "description"=>"Retrieves IDs and metadata for traces available for a specified time frame using an\n optional filter.", "operationId"=>"getTraceSummaries", "x-api-path-slug"=>"actiongettracesummaries-get", "parameters"=>[{"in"=>"query", "name"=>"EndTime", "description"=>"The end of the time frame for which to retrieve traces", "type"=>"string"}, {"in"=>"query", "name"=>"FilterExpression", "description"=>"Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"Specify the pagination token returned by a previous request to retrieve the next page of results", "type"=>"string"}, {"in"=>"query", "name"=>"Sampling", "description"=>"Set to true to get summaries for only a subset of available traces", "type"=>"string"}, {"in"=>"query", "name"=>"StartTime", "description"=>"The start of the time frame for which to retrieve traces", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trace Summaries"]}}, "/?Action=PutTelemetryRecords"=>{"get"=>{"summary"=>"Put Telemetry Records", "description"=>"Used by the AWS X-Ray daemon to upload telemetry.", "operationId"=>"putTelemetryRecords", "x-api-path-slug"=>"actionputtelemetryrecords-get", "parameters"=>[{"in"=>"query", "name"=>"EC2InstanceId", "type"=>"string"}, {"in"=>"query", "name"=>"Hostname", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceARN", "type"=>"string"}, {"in"=>"query", "name"=>"TelemetryRecords", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Telemetry Records"]}}, "/?Action=PutTraceSegments"=>{"get"=>{"summary"=>"Put Trace Segments", "description"=>"Uploads segment documents to AWS X-Ray.", "operationId"=>"putTraceSegments", "x-api-path-slug"=>"actionputtracesegments-get", "parameters"=>[{"in"=>"query", "name"=>"TraceSegmentDocuments", "description"=>"A JSON document defining one or more segments or subsegments", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trace Segments"]}}}}, "apis"=>{"name"=>"AWS X-Ray", "x-slug"=>"aws-xray", "description"=>"AWS X-Ray helps developers analyze and debug production, distributed applications, such as those built using a microservices architecture. With X-Ray, you can understand how your application and its underlying services are performing to identify and troubleshoot the root cause of performance issues and errors. X-Ray provides an end-to-end view of requests as they travel through your application, and shows a map of your applications underlying components. You can use X-Ray to analyze both applications in development and in production, from simple three-tier applications to complex microservices applications consisting of thousands of services.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-xray.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Monitoring,Orchestration,Profiles,Relative Data,Service API,Stack Network,Testing", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-xray/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS X-Ray API", "x-api-slug"=>"aws-xray-api", "description"=>"AWS X-Ray helps developers analyze and debug production, distributed applications, such as those built using a microservices architecture. With X-Ray, you can understand how your application and its underlying services are performing to identify and troubleshoot the root cause of performance issues and errors. X-Ray provides an end-to-end view of requests as they travel through your application, and shows a map of your applications underlying components. You can use X-Ray to analyze both applications in development and in production, from simple three-tier applications to complex microservices applications consisting of thousands of services.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-xray.png", "humanURL"=>"https://aws.amazon.com/xray/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Monitoring,Orchestration,Profiles,Relative Data,Service API,Stack Network,Testing", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-xray/aws-xray-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/xray/latest/api/Welcome.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/xray/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/xray/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/xray/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/xray/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
data-gov{"data-gov-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Data.Gov", "x-complete"=>1, "info"=>{"title"=>"Data.gov API", "description"=>"the-data-gov-catalog-is-powered-by-ckan-a-powerful-open-source-data-platform-that-includes-a-robust-api--please-be-aware-that-data-gov-and-the-data-gov-ckan-api-only-contain-metadata-about-datasets--this-metadata-includes-urls-and-descriptions-of-datasets-but-it-does-not-include-the-actual-data-within-each-dataset-", "version"=>"3"}, "host"=>"catalog.data.gov", "basePath"=>"/api/3/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/activity"=>{"get"=>{"summary"=>"Get Activity", "description"=>"Fetch site activity, optionally filterd by user of org", "operationId"=>"getActivity", "x-api-path-slug"=>"activity-get", "parameters"=>[{"in"=>"query", "name"=>"organization", "description"=>"Filter activities for that particular organization"}, {"in"=>"query", "name"=>"page", "description"=>"The page to fetch"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size to fetch"}, {"in"=>"query", "name"=>"user", "description"=>"Filter activities for that particular user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity"]}}, "/datasets/"=>{"get"=>{"summary"=>"Get Datasets", "description"=>"List or search all datasets", "operationId"=>"getDatasets", "x-api-path-slug"=>"datasets-get", "parameters"=>[{"in"=>"query", "name"=>"badge"}, {"in"=>"query", "name"=>"extra"}, {"in"=>"query", "name"=>"facets", "description"=>"Selected facets to fetch"}, {"in"=>"query", "name"=>"featured"}, {"in"=>"query", "name"=>"format"}, {"in"=>"query", "name"=>"geozone"}, {"in"=>"query", "name"=>"granularity"}, {"in"=>"query", "name"=>"license"}, {"in"=>"query", "name"=>"organization"}, {"in"=>"query", "name"=>"owner"}, {"in"=>"query", "name"=>"page", "description"=>"The page to display"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size"}, {"in"=>"query", "name"=>"q", "description"=>"The search query"}, {"in"=>"query", "name"=>"reuses"}, {"in"=>"query", "name"=>"sort", "description"=>"The field (and direction) on which sorting apply"}, {"in"=>"query", "name"=>"tag"}, {"in"=>"query", "name"=>"temporal_coverage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets"]}, "post"=>{"summary"=>"Add Datasets", "description"=>"Create a new dataset", "operationId"=>"postDatasets", "x-api-path-slug"=>"datasets-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets"]}}, "/datasets/badges/"=>{"get"=>{"summary"=>"Get Datasets Badges", "description"=>"List all available dataset badges and their labels", "operationId"=>"getDatasetsBadges", "x-api-path-slug"=>"datasetsbadges-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Badges"]}}, "/datasets/checkurl/"=>{"get"=>{"summary"=>"Get Datasets Checkurl", "description"=>"Checks that a URL exists and returns metadata", "operationId"=>"getDatasetsCheckurl", "x-api-path-slug"=>"datasetscheckurl-get", "parameters"=>[{"in"=>"query", "name"=>"group", "description"=>"The dataset related to the URL"}, {"in"=>"query", "name"=>"url", "description"=>"The URL to check"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Checkurl"]}}, "/datasets/community_resources/"=>{"get"=>{"summary"=>"Get Datasets Community Resources", "description"=>"List all community resources", "operationId"=>"getDatasetsCommunityResources", "x-api-path-slug"=>"datasetscommunity-resources-get", "parameters"=>[{"in"=>"query", "name"=>"dataset", "description"=>"Filter activities for that particular dataset"}, {"in"=>"query", "name"=>"organization", "description"=>"Filter activities for that particular organization"}, {"in"=>"query", "name"=>"owner", "description"=>"Filter activities for that particular user"}, {"in"=>"query", "name"=>"page", "description"=>"The page to fetch"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size to fetch"}, {"in"=>"query", "name"=>"sort", "description"=>"The sorting attribute"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Community", "Resources"]}, "post"=>{"summary"=>"Add Datasets Community Resources", "description"=>"Create a new community resource", "operationId"=>"postDatasetsCommunityResources", "x-api-path-slug"=>"datasetscommunity-resources-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Community", "Resources"]}}, "/datasets/community_resources/{community}/"=>{"delete"=>{"summary"=>"Delete Datasets Community Resources Community", "description"=>"Delete a given community resource", "operationId"=>"deleteDatasetsCommunityResourcesCommunity", "x-api-path-slug"=>"datasetscommunity-resourcescommunity-delete", "parameters"=>[{"in"=>"path", "name"=>"community", "description"=>"The community resource unique identifier"}, {"in"=>"query", "name"=>"dataset", "description"=>"The dataset ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Community", "Resources", "Community"]}, "get"=>{"summary"=>"Get Datasets Community Resources Community", "description"=>"Retrieve a community resource given its identifier", "operationId"=>"getDatasetsCommunityResourcesCommunity", "x-api-path-slug"=>"datasetscommunity-resourcescommunity-get", "parameters"=>[{"in"=>"path", "name"=>"community", "description"=>"The community resource unique identifier"}, {"in"=>"query", "name"=>"dataset", "description"=>"The dataset ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Community", "Resources", "Community"]}, "put"=>{"summary"=>"Put Datasets Community Resources Community", "description"=>"Update a given community resource", "operationId"=>"putDatasetsCommunityResourcesCommunity", "x-api-path-slug"=>"datasetscommunity-resourcescommunity-put", "parameters"=>[{"in"=>"path", "name"=>"community", "description"=>"The community resource unique identifier"}, {"in"=>"query", "name"=>"dataset", "description"=>"The dataset ID or slug"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Community", "Resources", "Community"]}}, "/datasets/community_resources/{community}/upload/"=>{"post"=>{"summary"=>"Add Datasets Community Resources Community Upload", "description"=>"Update the file related to a given community resource", "operationId"=>"postDatasetsCommunityResourcesCommunityUpload", "x-api-path-slug"=>"datasetscommunity-resourcescommunityupload-post", "parameters"=>[{"in"=>"path", "name"=>"community", "description"=>"The community resource unique identifier"}, {"in"=>"query", "name"=>"dataset", "description"=>"The dataset ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Community", "Resources", "Community", "Upload"]}}, "/datasets/frequencies/"=>{"get"=>{"summary"=>"Get Datasets Frequencies", "description"=>"List all available frequencies", "operationId"=>"getDatasetsFrequencies", "x-api-path-slug"=>"datasetsfrequencies-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Frequencies"]}}, "/datasets/full/"=>{"get"=>{"summary"=>"Get Datasets Full", "description"=>"", "operationId"=>"getDatasetsFull", "x-api-path-slug"=>"datasetsfull-get", "parameters"=>[{"in"=>"query", "name"=>"badge"}, {"in"=>"query", "name"=>"extra"}, {"in"=>"query", "name"=>"facets", "description"=>"Selected facets to fetch"}, {"in"=>"query", "name"=>"featured"}, {"in"=>"query", "name"=>"format"}, {"in"=>"query", "name"=>"geozone"}, {"in"=>"query", "name"=>"granularity"}, {"in"=>"query", "name"=>"license"}, {"in"=>"query", "name"=>"organization"}, {"in"=>"query", "name"=>"owner"}, {"in"=>"query", "name"=>"page", "description"=>"The page to display"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size"}, {"in"=>"query", "name"=>"q", "description"=>"The search query"}, {"in"=>"query", "name"=>"reuses"}, {"in"=>"query", "name"=>"sort", "description"=>"The field (and direction) on which sorting apply"}, {"in"=>"query", "name"=>"tag"}, {"in"=>"query", "name"=>"temporal_coverage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Full"]}}, "/datasets/licenses/"=>{"get"=>{"summary"=>"Get Datasets Licenses", "description"=>"List all available licenses", "operationId"=>"getDatasetsLicenses", "x-api-path-slug"=>"datasetslicenses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Licenses"]}}, "/datasets/suggest/"=>{"get"=>{"summary"=>"Get Datasets Suggest", "description"=>"Suggest datasets", "operationId"=>"getDatasetsSuggest", "x-api-path-slug"=>"datasetssuggest-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The string to autocomplete/suggest"}, {"in"=>"query", "name"=>"size", "description"=>"The amount of suggestion to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Suggest"]}}, "/datasets/suggest/formats/"=>{"get"=>{"summary"=>"Get Datasets Suggest Formats", "description"=>"Suggest file formats", "operationId"=>"getDatasetsSuggestFormats", "x-api-path-slug"=>"datasetssuggestformats-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The string to autocomplete/suggest"}, {"in"=>"query", "name"=>"size", "description"=>"The amount of suggestion to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Suggest", "Formats"]}}, "/datasets/{dataset}/"=>{"delete"=>{"summary"=>"Delete Datasets Dataset", "description"=>"Delete a dataset given its identifier", "operationId"=>"deleteDatasetsDataset", "x-api-path-slug"=>"datasetsdataset-delete", "parameters"=>[{"in"=>"path", "name"=>"dataset", "description"=>"The dataset ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Dataset"]}, "get"=>{"summary"=>"Get Datasets Dataset", "description"=>"Get a dataset given its identifier", "operationId"=>"getDatasetsDataset", "x-api-path-slug"=>"datasetsdataset-get", "parameters"=>[{"in"=>"path", "name"=>"dataset", "description"=>"The dataset ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Dataset"]}, "put"=>{"summary"=>"Put Datasets Dataset", "description"=>"Update a dataset given its identifier", "operationId"=>"putDatasetsDataset", "x-api-path-slug"=>"datasetsdataset-put", "parameters"=>[{"in"=>"path", "name"=>"dataset", "description"=>"The dataset ID or slug"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Dataset"]}}, "/datasets/{dataset}/badges/"=>{"post"=>{"summary"=>"Add Datasets Dataset Badges", "description"=>"Create a new badge for a given dataset", "operationId"=>"postDatasetsDatasetBadges", "x-api-path-slug"=>"datasetsdatasetbadges-post", "parameters"=>[{"in"=>"path", "name"=>"dataset", "description"=>"The dataset ID or slug"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Dataset", "Badges"]}}, "/datasets/{dataset}/badges/{badge_kind}/"=>{"delete"=>{"summary"=>"Delete Datasets Dataset Badges Badge Kind", "description"=>"Delete a badge for a given dataset", "operationId"=>"deleteDatasetsDatasetBadgesBadgeKind", "x-api-path-slug"=>"datasetsdatasetbadgesbadge-kind-delete", "parameters"=>[{"in"=>"path", "name"=>"badge_kind"}, {"in"=>"path", "name"=>"dataset", "description"=>"The dataset ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Dataset", "Badges", "Badge", "Kind"]}}, "/datasets/{dataset}/featured/"=>{"delete"=>{"summary"=>"Delete Datasets Dataset Featured", "description"=>"Unmark the dataset as featured", "operationId"=>"deleteDatasetsDatasetFeatured", "x-api-path-slug"=>"datasetsdatasetfeatured-delete", "parameters"=>[{"in"=>"path", "name"=>"dataset", "description"=>"The dataset ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Dataset", "Featured"]}, "post"=>{"summary"=>"Add Datasets Dataset Featured", "description"=>"Mark the dataset as featured", "operationId"=>"postDatasetsDatasetFeatured", "x-api-path-slug"=>"datasetsdatasetfeatured-post", "parameters"=>[{"in"=>"path", "name"=>"dataset", "description"=>"The dataset ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Dataset", "Featured"]}}, "/datasets/{dataset}/full/"=>{"get"=>{"summary"=>"Get Datasets Dataset Full", "description"=>"Get a dataset given its identifier", "operationId"=>"getDatasetsDatasetFull", "x-api-path-slug"=>"datasetsdatasetfull-get", "parameters"=>[{"in"=>"path", "name"=>"dataset", "description"=>"The dataset ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Dataset", "Full"]}}, "/datasets/{dataset}/resources/"=>{"post"=>{"summary"=>"Add Datasets Dataset Resources", "description"=>"Create a new resource for a given dataset", "operationId"=>"postDatasetsDatasetResources", "x-api-path-slug"=>"datasetsdatasetresources-post", "parameters"=>[{"in"=>"path", "name"=>"dataset", "description"=>"The dataset ID or slug"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Dataset", "Resources"]}, "put"=>{"summary"=>"Put Datasets Dataset Resources", "description"=>"Reorder resources", "operationId"=>"putDatasetsDatasetResources", "x-api-path-slug"=>"datasetsdatasetresources-put", "parameters"=>[{"in"=>"path", "name"=>"dataset", "description"=>"The dataset ID or slug"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Dataset", "Resources"]}}, "/datasets/{dataset}/resources/{rid}/"=>{"delete"=>{"summary"=>"Delete Datasets Dataset Resources R", "description"=>"Delete a given resource on a given dataset", "operationId"=>"deleteDatasetsDatasetResourcesR", "x-api-path-slug"=>"datasetsdatasetresourcesrid-delete", "parameters"=>[{"in"=>"path", "name"=>"dataset", "description"=>"The dataset ID or slug"}, {"in"=>"path", "name"=>"rid", "description"=>"The resource unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Dataset", "Resources", "R"]}, "put"=>{"summary"=>"Put Datasets Dataset Resources R", "description"=>"Update a given resource on a given dataset", "operationId"=>"putDatasetsDatasetResourcesR", "x-api-path-slug"=>"datasetsdatasetresourcesrid-put", "parameters"=>[{"in"=>"path", "name"=>"dataset", "description"=>"The dataset ID or slug"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"rid", "description"=>"The resource unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Dataset", "Resources", "R"]}}, "/datasets/{dataset}/resources/{rid}/upload/"=>{"post"=>{"summary"=>"Add Datasets Dataset Resources R Upload", "description"=>"Upload a file related to a given resource on a given dataset", "operationId"=>"postDatasetsDatasetResourcesRUpload", "x-api-path-slug"=>"datasetsdatasetresourcesridupload-post", "parameters"=>[{"in"=>"path", "name"=>"dataset", "description"=>"The dataset ID or slug"}, {"in"=>"path", "name"=>"rid", "description"=>"The resource unique identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Dataset", "Resources", "R", "Upload"]}}, "/datasets/{dataset}/upload/"=>{"post"=>{"summary"=>"Add Datasets Dataset Upload", "description"=>"Upload a new dataset resource", "operationId"=>"postDatasetsDatasetUpload", "x-api-path-slug"=>"datasetsdatasetupload-post", "parameters"=>[{"in"=>"path", "name"=>"dataset", "description"=>"The dataset ID or slug"}, {"in"=>"formData", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Dataset", "Upload"]}}, "/datasets/{dataset}/upload/community/"=>{"post"=>{"summary"=>"Add Datasets Dataset Upload Community", "description"=>"Upload a new community resource", "operationId"=>"postDatasetsDatasetUploadCommunity", "x-api-path-slug"=>"datasetsdatasetuploadcommunity-post", "parameters"=>[{"in"=>"path", "name"=>"dataset", "description"=>"The dataset ID or slug"}, {"in"=>"formData", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "Dataset", "Upload", "Community"]}}, "/datasets/{id}/followers/"=>{"delete"=>{"summary"=>"Delete Datasets Followers", "description"=>"Unfollow an object given its ID", "operationId"=>"deleteDatasetsFollowers", "x-api-path-slug"=>"datasetsidfollowers-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "", "Followers"]}, "get"=>{"summary"=>"Get Datasets Followers", "description"=>"List all followers for a given object", "operationId"=>"getDatasetsFollowers", "x-api-path-slug"=>"datasetsidfollowers-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"page", "description"=>"The page to fetch"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "", "Followers"]}, "post"=>{"summary"=>"Add Datasets Followers", "description"=>"Follow an object given its ID", "operationId"=>"postDatasetsFollowers", "x-api-path-slug"=>"datasetsidfollowers-post", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Datasets", "", "Followers"]}}, "/discussions/"=>{"get"=>{"summary"=>"Get Discussions", "description"=>"List all Discussions", "operationId"=>"getDiscussions", "x-api-path-slug"=>"discussions-get", "parameters"=>[{"in"=>"query", "name"=>"closed", "description"=>"Filters discussions on their closed status if specified"}, {"in"=>"query", "name"=>"for", "description"=>"Filter discussions for a given subject"}, {"in"=>"query", "name"=>"page", "description"=>"The page to fetch"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size to fetch"}, {"in"=>"query", "name"=>"sort", "description"=>"The sorting attribute"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Discussions"]}, "post"=>{"summary"=>"Add Discussions", "description"=>"Create a new Discussion", "operationId"=>"postDiscussions", "x-api-path-slug"=>"discussions-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Discussions"]}}, "/discussions/{id}/"=>{"delete"=>{"summary"=>"Delete Discussions", "description"=>"Delete a discussion given its ID", "operationId"=>"deleteDiscussions", "x-api-path-slug"=>"discussionsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Discussions"]}, "get"=>{"summary"=>"Get Discussions", "description"=>"Get a discussion given its ID", "operationId"=>"getDiscussions", "x-api-path-slug"=>"discussionsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Discussions"]}, "post"=>{"summary"=>"Add Discussions", "description"=>"Add comment and optionnaly close a discussion given its ID", "operationId"=>"postDiscussions", "x-api-path-slug"=>"discussionsid-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Discussions"]}}, "/harvest/backends"=>{"get"=>{"summary"=>"Get Harvest Backends", "description"=>"List all available harvest backends", "operationId"=>"getHarvestBackends", "x-api-path-slug"=>"harvestbackends-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Harvest", "Backends"]}}, "/harvest/job/{ident}/"=>{"get"=>{"summary"=>"Get Harvest Job", "description"=>"List all jobs for a given source", "operationId"=>"getHarvestJobEnt", "x-api-path-slug"=>"harvestjobident-get", "parameters"=>[{"in"=>"path", "name"=>"ident"}, {"in"=>"query", "name"=>"page", "description"=>"The page to fetch"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Harvest", "Job", "Ent"]}}, "/harvest/job_status"=>{"get"=>{"summary"=>"Get Harvest Job Status", "description"=>"List all available harvesters", "operationId"=>"getHarvestJobStatus", "x-api-path-slug"=>"harvestjob-status-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Harvest", "Job", "Status"]}}, "/harvest/source/{ident}"=>{"delete"=>{"summary"=>"Delete Harvest Source Ent", "description"=>"", "operationId"=>"deleteHarvestSourceEnt", "x-api-path-slug"=>"harvestsourceident-delete", "parameters"=>[{"in"=>"path", "name"=>"ident", "description"=>"A source ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Harvest", "Source", "Ent"]}, "get"=>{"summary"=>"Get Harvest Source Ent", "description"=>"Get a single source given an ID or a slug", "operationId"=>"getHarvestSourceEnt", "x-api-path-slug"=>"harvestsourceident-get", "parameters"=>[{"in"=>"path", "name"=>"ident", "description"=>"A source ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Harvest", "Source", "Ent"]}}, "/harvest/source/{ident}/jobs/"=>{"get"=>{"summary"=>"Get Harvest Source Ent Jobs", "description"=>"List all jobs for a given source", "operationId"=>"getHarvestSourceEntJobs", "x-api-path-slug"=>"harvestsourceidentjobs-get", "parameters"=>[{"in"=>"path", "name"=>"ident"}, {"in"=>"query", "name"=>"page", "description"=>"The page to fetch"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Harvest", "Source", "Ent", "Jobs"]}}, "/harvest/source/{ident}/preview"=>{"get"=>{"summary"=>"Get Harvest Source Ent Preview", "description"=>"Preview a single harvest source given an ID or a slug", "operationId"=>"getHarvestSourceEntPreview", "x-api-path-slug"=>"harvestsourceidentpreview-get", "parameters"=>[{"in"=>"path", "name"=>"ident", "description"=>"A source ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Harvest", "Source", "Ent", "Preview"]}}, "/harvest/source/{ident}/validate"=>{"post"=>{"summary"=>"Add Harvest Source Ent Valate", "description"=>"Validate or reject an harvest source", "operationId"=>"postHarvestSourceEntValate", "x-api-path-slug"=>"harvestsourceidentvalidate-post", "parameters"=>[{"in"=>"path", "name"=>"ident", "description"=>"A source ID or slug"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Harvest", "Source", "Ent", "Valate"]}}, "/harvest/sources/"=>{"get"=>{"summary"=>"Get Harvest Sources", "description"=>"List all harvest sources", "operationId"=>"getHarvestSources", "x-api-path-slug"=>"harvestsources-get", "parameters"=>[{"in"=>"query", "name"=>"owner", "description"=>"The organization or user ID to filter on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Harvest", "Sources"]}, "post"=>{"summary"=>"Add Harvest Sources", "description"=>"Create a new harvests source", "operationId"=>"postHarvestSources", "x-api-path-slug"=>"harvestsources-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Harvest", "Sources"]}}, "/issues/"=>{"get"=>{"summary"=>"Get Issues", "description"=>"List all Issues", "operationId"=>"getIssues", "x-api-path-slug"=>"issues-get", "parameters"=>[{"in"=>"query", "name"=>"closed", "description"=>"Filter closed issues"}, {"in"=>"query", "name"=>"for", "description"=>"Filter issues for a given subject"}, {"in"=>"query", "name"=>"page", "description"=>"The page to fetch"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size to fetch"}, {"in"=>"query", "name"=>"sort", "description"=>"The sorting attribute"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Issues"]}, "post"=>{"summary"=>"Add Issues", "description"=>"Create a new Issue", "operationId"=>"postIssues", "x-api-path-slug"=>"issues-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Issues"]}}, "/issues/{id}/"=>{"get"=>{"summary"=>"Get Issues", "description"=>"Get an issue given its ID", "operationId"=>"getIssues", "x-api-path-slug"=>"issuesid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Issues"]}, "post"=>{"summary"=>"Add Issues", "description"=>"Add comment and optionnaly close an issue given its ID", "operationId"=>"postIssues", "x-api-path-slug"=>"issuesid-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Issues"]}}, "/me/"=>{"get"=>{"summary"=>"Get Me", "description"=>"Fetch the current user (me) identity", "operationId"=>"getMe", "x-api-path-slug"=>"me-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me"]}, "put"=>{"summary"=>"Put Me", "description"=>"Update my profile", "operationId"=>"putMe", "x-api-path-slug"=>"me-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me"]}}, "/me/apikey"=>{"delete"=>{"summary"=>"Delete Me Apikey", "description"=>"Clear/destroy an apikey", "operationId"=>"deleteMeApikey", "x-api-path-slug"=>"meapikey-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Apikey"]}, "post"=>{"summary"=>"Add Me Apikey", "description"=>"(Re)Generate my API Key", "operationId"=>"postMeApikey", "x-api-path-slug"=>"meapikey-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Apikey"]}}, "/me/avatar"=>{"post"=>{"summary"=>"Add Me Avatar", "description"=>"Upload a new avatar", "operationId"=>"postMeAvatar", "x-api-path-slug"=>"meavatar-post", "parameters"=>[{"in"=>"formData", "name"=>"bbox"}, {"in"=>"formData", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Avatar"]}}, "/me/datasets/"=>{"get"=>{"summary"=>"Get Me Datasets", "description"=>"List all my datasets (including private ones)", "operationId"=>"getMeDatasets", "x-api-path-slug"=>"medatasets-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Datasets"]}}, "/me/metrics/"=>{"get"=>{"summary"=>"Get Me Metrics", "description"=>"Fetch the current user (me) metrics", "operationId"=>"getMeMetrics", "x-api-path-slug"=>"memetrics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Metrics"]}}, "/me/org_community_resources/"=>{"get"=>{"summary"=>"Get Me Org Community Resources", "description"=>"List all community resources related to me and my organizations", "operationId"=>"getMeOrgCommunityResources", "x-api-path-slug"=>"meorg-community-resources-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The string to filter items"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Org", "Community", "Resources"]}}, "/me/org_datasets/"=>{"get"=>{"summary"=>"Get Me Org Datasets", "description"=>"List all datasets related to me and my organizations", "operationId"=>"getMeOrgDatasets", "x-api-path-slug"=>"meorg-datasets-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The string to filter items"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Org", "Datasets"]}}, "/me/org_discussions/"=>{"get"=>{"summary"=>"Get Me Org Discussions", "description"=>"List all discussions related to my organizations", "operationId"=>"getMeOrgDiscussions", "x-api-path-slug"=>"meorg-discussions-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The string to filter items"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Org", "Discussions"]}}, "/me/org_issues/"=>{"get"=>{"summary"=>"Get Me Org Issues", "description"=>"List all issues related to my organizations", "operationId"=>"getMeOrgIssues", "x-api-path-slug"=>"meorg-issues-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The string to filter items"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Org", "Issues"]}}, "/me/org_reuses/"=>{"get"=>{"summary"=>"Get Me Org Reuses", "description"=>"List all reuses related to me and my organizations", "operationId"=>"getMeOrgReuses", "x-api-path-slug"=>"meorg-reuses-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The string to filter items"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Org", "Reuses"]}}, "/me/reuses/"=>{"get"=>{"summary"=>"Get Me Reuses", "description"=>"List all my reuses (including private ones)", "operationId"=>"getMeReuses", "x-api-path-slug"=>"mereuses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Me", "Reuses"]}}, "/metrics/{id}"=>{"get"=>{"summary"=>"Get Metrics", "description"=>"Fetch metrics for an object given its ID", "operationId"=>"getMetrics", "x-api-path-slug"=>"metricsid-get", "parameters"=>[{"in"=>"query", "name"=>"cumulative", "description"=>"Either cumulative metrics or not"}, {"in"=>"query", "name"=>"day", "description"=>"Specific day date to fetch"}, {"in"=>"query", "name"=>"end", "description"=>"End of the period to fetch"}, {"in"=>"path", "name"=>"id", "description"=>"The object ID to fetch metric for"}, {"in"=>"query", "name"=>"start", "description"=>"Start of the period to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}}, "/notifications/"=>{"get"=>{"summary"=>"Get Notifications", "description"=>"List all current user pending notifications", "operationId"=>"getNotifications", "x-api-path-slug"=>"notifications-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications"]}}, "/oembeds/"=>{"get"=>{"summary"=>"Get Oembeds", "description"=>"The returned payload is a list of OEmbed formatted responses", "operationId"=>"getOembeds", "x-api-path-slug"=>"oembeds-get", "parameters"=>[{"in"=>"query", "name"=>"references", "description"=>"References of the resources to embed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Oembeds"]}}, "/organizations/"=>{"get"=>{"summary"=>"Get Organizations", "description"=>"List or search all organizations", "operationId"=>"getOrganizations", "x-api-path-slug"=>"organizations-get", "parameters"=>[{"in"=>"query", "name"=>"badge"}, {"in"=>"query", "name"=>"datasets"}, {"in"=>"query", "name"=>"facets", "description"=>"Selected facets to fetch"}, {"in"=>"query", "name"=>"followers"}, {"in"=>"query", "name"=>"page", "description"=>"The page to display"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size"}, {"in"=>"query", "name"=>"permitted_reuses"}, {"in"=>"query", "name"=>"q", "description"=>"The search query"}, {"in"=>"query", "name"=>"reuses"}, {"in"=>"query", "name"=>"sort", "description"=>"The field (and direction) on which sorting apply"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}, "post"=>{"summary"=>"Add Organizations", "description"=>"Create a new organization", "operationId"=>"postOrganizations", "x-api-path-slug"=>"organizations-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}, "/organizations/badges/"=>{"get"=>{"summary"=>"Get Organizations Badges", "description"=>"List all available organization badges and their labels", "operationId"=>"getOrganizationsBadges", "x-api-path-slug"=>"organizationsbadges-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Badges"]}}, "/organizations/suggest/"=>{"get"=>{"summary"=>"Get Organizations Suggest", "description"=>"Suggest organizations", "operationId"=>"getOrganizationsSuggest", "x-api-path-slug"=>"organizationssuggest-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The string to autocomplete/suggest"}, {"in"=>"query", "name"=>"size", "description"=>"The amount of suggestion to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Suggest"]}}, "/organizations/{id}/followers/"=>{"delete"=>{"summary"=>"Delete Organizations Followers", "description"=>"Unfollow an object given its ID", "operationId"=>"deleteOrganizationsFollowers", "x-api-path-slug"=>"organizationsidfollowers-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "", "Followers"]}, "get"=>{"summary"=>"Get Organizations Followers", "description"=>"List all followers for a given object", "operationId"=>"getOrganizationsFollowers", "x-api-path-slug"=>"organizationsidfollowers-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"page", "description"=>"The page to fetch"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "", "Followers"]}, "post"=>{"summary"=>"Add Organizations Followers", "description"=>"Follow an object given its ID", "operationId"=>"postOrganizationsFollowers", "x-api-path-slug"=>"organizationsidfollowers-post", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "", "Followers"]}}, "/organizations/{org}/"=>{"delete"=>{"summary"=>"Delete Organizations Org", "description"=>"Delete a organization given its identifier", "operationId"=>"deleteOrganizationsOrg", "x-api-path-slug"=>"organizationsorg-delete", "parameters"=>[{"in"=>"path", "name"=>"org", "description"=>"The organization ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org"]}, "get"=>{"summary"=>"Get Organizations Org", "description"=>"Get a organization given its identifier", "operationId"=>"getOrganizationsOrg", "x-api-path-slug"=>"organizationsorg-get", "parameters"=>[{"in"=>"path", "name"=>"org", "description"=>"The organization ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org"]}, "put"=>{"summary"=>"Put Organizations Org", "description"=>"Update a organization given its identifier", "operationId"=>"putOrganizationsOrg", "x-api-path-slug"=>"organizationsorg-put", "parameters"=>[{"in"=>"path", "name"=>"org", "description"=>"The organization ID or slug"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org"]}}, "/organizations/{org}/badges/"=>{"post"=>{"summary"=>"Add Organizations Org Badges", "description"=>"Create a new badge for a given organization", "operationId"=>"postOrganizationsOrgBadges", "x-api-path-slug"=>"organizationsorgbadges-post", "parameters"=>[{"in"=>"path", "name"=>"org", "description"=>"The organization ID or slug"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org", "Badges"]}}, "/organizations/{org}/badges/{badge_kind}/"=>{"delete"=>{"summary"=>"Delete Organizations Org Badges Badge Kind", "description"=>"Delete a badge for a given organization", "operationId"=>"deleteOrganizationsOrgBadgesBadgeKind", "x-api-path-slug"=>"organizationsorgbadgesbadge-kind-delete", "parameters"=>[{"in"=>"path", "name"=>"badge_kind"}, {"in"=>"path", "name"=>"org", "description"=>"The organization ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org", "Badges", "Badge", "Kind"]}}, "/organizations/{org}/datasets/"=>{"get"=>{"summary"=>"Get Organizations Org Datasets", "description"=>"List organization datasets (including private ones when member)", "operationId"=>"getOrganizationsOrgDatasets", "x-api-path-slug"=>"organizationsorgdatasets-get", "parameters"=>[{"in"=>"path", "name"=>"org"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org", "Datasets"]}}, "/organizations/{org}/discussions/"=>{"get"=>{"summary"=>"Get Organizations Org Discussions", "description"=>"List organization discussions", "operationId"=>"getOrganizationsOrgDiscussions", "x-api-path-slug"=>"organizationsorgdiscussions-get", "parameters"=>[{"in"=>"path", "name"=>"org"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org", "Discussions"]}}, "/organizations/{org}/issues/"=>{"get"=>{"summary"=>"Get Organizations Org Issues", "description"=>"List organization issues", "operationId"=>"getOrganizationsOrgIssues", "x-api-path-slug"=>"organizationsorgissues-get", "parameters"=>[{"in"=>"path", "name"=>"org"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org", "Issues"]}}, "/organizations/{org}/logo"=>{"post"=>{"summary"=>"Add Organizations Org Logo", "description"=>"Upload a new logo", "operationId"=>"postOrganizationsOrgLogo", "x-api-path-slug"=>"organizationsorglogo-post", "parameters"=>[{"in"=>"formData", "name"=>"bbox"}, {"in"=>"formData", "name"=>"file"}, {"in"=>"path", "name"=>"org", "description"=>"The organization ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org", "Logo"]}, "put"=>{"summary"=>"Put Organizations Org Logo", "description"=>"Set the logo BBox", "operationId"=>"putOrganizationsOrgLogo", "x-api-path-slug"=>"organizationsorglogo-put", "parameters"=>[{"in"=>"formData", "name"=>"bbox"}, {"in"=>"formData", "name"=>"file"}, {"in"=>"path", "name"=>"org", "description"=>"The organization ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org", "Logo"]}}, "/organizations/{org}/member/{user}"=>{"delete"=>{"summary"=>"Delete Organizations Org Member User", "description"=>"Delete member from an organization", "operationId"=>"deleteOrganizationsOrgMemberUser", "x-api-path-slug"=>"organizationsorgmemberuser-delete", "parameters"=>[{"in"=>"path", "name"=>"org", "description"=>"The organization ID or slug"}, {"in"=>"path", "name"=>"user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org", "Member", "User"]}, "post"=>{"summary"=>"Add Organizations Org Member User", "description"=>"Add a member into a given organization", "operationId"=>"postOrganizationsOrgMemberUser", "x-api-path-slug"=>"organizationsorgmemberuser-post", "parameters"=>[{"in"=>"path", "name"=>"org", "description"=>"The organization ID or slug"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org", "Member", "User"]}, "put"=>{"summary"=>"Put Organizations Org Member User", "description"=>"Update member status into a given organization", "operationId"=>"putOrganizationsOrgMemberUser", "x-api-path-slug"=>"organizationsorgmemberuser-put", "parameters"=>[{"in"=>"path", "name"=>"org", "description"=>"The organization ID or slug"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org", "Member", "User"]}}, "/organizations/{org}/membership/"=>{"get"=>{"summary"=>"Get Organizations Org Membership", "description"=>"List membership requests for a given organization", "operationId"=>"getOrganizationsOrgMembership", "x-api-path-slug"=>"organizationsorgmembership-get", "parameters"=>[{"in"=>"path", "name"=>"org", "description"=>"The organization ID or slug"}, {"in"=>"query", "name"=>"status", "description"=>"If provided, only return requests ith a given status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org", "Membership"]}, "post"=>{"summary"=>"Add Organizations Org Membership", "description"=>"Apply for membership to a given organization", "operationId"=>"postOrganizationsOrgMembership", "x-api-path-slug"=>"organizationsorgmembership-post", "parameters"=>[{"in"=>"path", "name"=>"org", "description"=>"The organization ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org", "Membership"]}}, "/organizations/{org}/membership/{id}/accept/"=>{"post"=>{"summary"=>"Add Organizations Org Membership Accept", "description"=>"Accept user membership to a given organization", "operationId"=>"postOrganizationsOrgMembershipAccept", "x-api-path-slug"=>"organizationsorgmembershipidaccept-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"org", "description"=>"The organization ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org", "Membership", "", "Accept"]}}, "/organizations/{org}/membership/{id}/refuse/"=>{"post"=>{"summary"=>"Add Organizations Org Membership Refuse", "description"=>"Refuse user membership to a given organization", "operationId"=>"postOrganizationsOrgMembershipRefuse", "x-api-path-slug"=>"organizationsorgmembershipidrefuse-post", "parameters"=>[{"in"=>"body", "name"=>"comment", "description"=>"The refusal reason", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"org", "description"=>"The organization ID or slug"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org", "Membership", "", "Refuse"]}}, "/organizations/{org}/reuses/"=>{"get"=>{"summary"=>"Get Organizations Org Reuses", "description"=>"List organization reuses (including private ones when member)", "operationId"=>"getOrganizationsOrgReuses", "x-api-path-slug"=>"organizationsorgreuses-get", "parameters"=>[{"in"=>"path", "name"=>"org"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Org", "Reuses"]}}, "/posts/"=>{"get"=>{"summary"=>"Posts", "description"=>"List all posts", "operationId"=>"getPosts", "x-api-path-slug"=>"posts-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page to fetch"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts"]}, "post"=>{"summary"=>"Add Post", "description"=>"Create a post", "operationId"=>"postPosts", "x-api-path-slug"=>"posts-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts"]}}, "/posts/{post}/"=>{"delete"=>{"summary"=>"Delete Post", "description"=>"Delete a given post", "operationId"=>"deletePostsPost", "x-api-path-slug"=>"postspost-delete", "parameters"=>[{"in"=>"path", "name"=>"post", "description"=>"The post ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts"]}, "get"=>{"summary"=>"Get Post", "description"=>"Get a given post", "operationId"=>"getPostsPost", "x-api-path-slug"=>"postspost-get", "parameters"=>[{"in"=>"path", "name"=>"post", "description"=>"The post ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts"]}, "put"=>{"summary"=>"Update Post", "description"=>"Update a given post", "operationId"=>"putPostsPost", "x-api-path-slug"=>"postspost-put", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"post", "description"=>"The post ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts"]}}, "/posts/{post}/image"=>{"post"=>{"summary"=>"Add Post Image", "description"=>"Upload a new image", "operationId"=>"postPostsPostImage", "x-api-path-slug"=>"postspostimage-post", "parameters"=>[{"in"=>"formData", "name"=>"bbox"}, {"in"=>"formData", "name"=>"file"}, {"in"=>"path", "name"=>"post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts", "Images"]}, "put"=>{"summary"=>"Update Post Image", "description"=>"Set the image BBox", "operationId"=>"putPostsPostImage", "x-api-path-slug"=>"postspostimage-put", "parameters"=>[{"in"=>"formData", "name"=>"bbox"}, {"in"=>"formData", "name"=>"file"}, {"in"=>"path", "name"=>"post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts", "Images"]}}, "/reuses/"=>{"get"=>{"summary"=>"Get Reuses", "description"=>"Get Reuses", "operationId"=>"getReuses", "x-api-path-slug"=>"reuses-get", "parameters"=>[{"in"=>"query", "name"=>"badge"}, {"in"=>"query", "name"=>"dataset"}, {"in"=>"query", "name"=>"datasets"}, {"in"=>"query", "name"=>"extra"}, {"in"=>"query", "name"=>"facets", "description"=>"Selected facets to fetch"}, {"in"=>"query", "name"=>"featured"}, {"in"=>"query", "name"=>"followers"}, {"in"=>"query", "name"=>"organization"}, {"in"=>"query", "name"=>"owner"}, {"in"=>"query", "name"=>"page", "description"=>"The page to display"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size"}, {"in"=>"query", "name"=>"q", "description"=>"The search query"}, {"in"=>"query", "name"=>"sort", "description"=>"The field (and direction) on which sorting apply"}, {"in"=>"query", "name"=>"tag"}, {"in"=>"query", "name"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses"]}, "post"=>{"summary"=>"Add Reuses", "description"=>"Create a new object", "operationId"=>"postReuses", "x-api-path-slug"=>"reuses-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses"]}}, "/reuses/badges/"=>{"get"=>{"summary"=>"Get Reuses Badges", "description"=>"List all available reuse badges and their labels", "operationId"=>"getReusesBadges", "x-api-path-slug"=>"reusesbadges-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses", "Badges"]}}, "/reuses/suggest/"=>{"get"=>{"summary"=>"Get Reuses Suggest", "description"=>"Suggest reuses", "operationId"=>"getReusesSuggest", "x-api-path-slug"=>"reusessuggest-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The string to autocomplete/suggest"}, {"in"=>"query", "name"=>"size", "description"=>"The amount of suggestion to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses", "Suggest"]}}, "/reuses/types/"=>{"get"=>{"summary"=>"Get Reuses Types", "description"=>"List all reuse types", "operationId"=>"getReusesTypes", "x-api-path-slug"=>"reusestypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses", "Types"]}}, "/reuses/{id}/followers/"=>{"delete"=>{"summary"=>"Delete Reuses Followers", "description"=>"Unfollow an object given its ID", "operationId"=>"deleteReusesFollowers", "x-api-path-slug"=>"reusesidfollowers-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses", "", "Followers"]}, "get"=>{"summary"=>"Get Reuses Followers", "description"=>"List all followers for a given object", "operationId"=>"getReusesFollowers", "x-api-path-slug"=>"reusesidfollowers-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"page", "description"=>"The page to fetch"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses", "", "Followers"]}, "post"=>{"summary"=>"Add Reuses Followers", "description"=>"Follow an object given its ID", "operationId"=>"postReusesFollowers", "x-api-path-slug"=>"reusesidfollowers-post", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses", "", "Followers"]}}, "/reuses/{reuse}/"=>{"delete"=>{"summary"=>"Delete Reuses Reuse", "description"=>"Delete a given reuse", "operationId"=>"deleteReusesReuse", "x-api-path-slug"=>"reusesreuse-delete", "parameters"=>[{"in"=>"path", "name"=>"reuse", "description"=>"The reuse ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses", "Reuse"]}, "get"=>{"summary"=>"Get Reuses Reuse", "description"=>"Fetch a given reuse", "operationId"=>"getReusesReuse", "x-api-path-slug"=>"reusesreuse-get", "parameters"=>[{"in"=>"path", "name"=>"reuse", "description"=>"The reuse ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses", "Reuse"]}, "put"=>{"summary"=>"Put Reuses Reuse", "description"=>"Update a given reuse", "operationId"=>"putReusesReuse", "x-api-path-slug"=>"reusesreuse-put", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"reuse", "description"=>"The reuse ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses", "Reuse"]}}, "/reuses/{reuse}/badges/"=>{"post"=>{"summary"=>"Add Reuses Reuse Badges", "description"=>"Create a new badge for a given reuse", "operationId"=>"postReusesReuseBadges", "x-api-path-slug"=>"reusesreusebadges-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"reuse", "description"=>"The reuse ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses", "Reuse", "Badges"]}}, "/reuses/{reuse}/badges/{badge_kind}/"=>{"delete"=>{"summary"=>"Delete Reuses Reuse Badges Badge Kind", "description"=>"Delete a badge for a given reuse", "operationId"=>"deleteReusesReuseBadgesBadgeKind", "x-api-path-slug"=>"reusesreusebadgesbadge-kind-delete", "parameters"=>[{"in"=>"path", "name"=>"badge_kind"}, {"in"=>"path", "name"=>"reuse", "description"=>"The reuse ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses", "Reuse", "Badges", "Badge", "Kind"]}}, "/reuses/{reuse}/datasets/"=>{"post"=>{"summary"=>"Add Reuses Reuse Datasets", "description"=>"Add a dataset to a given reuse", "operationId"=>"postReusesReuseDatasets", "x-api-path-slug"=>"reusesreusedatasets-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"reuse", "description"=>"The reuse ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses", "Reuse", "Datasets"]}}, "/reuses/{reuse}/featured/"=>{"delete"=>{"summary"=>"Delete Reuses Reuse Featured", "description"=>"Unmark a reuse as featured", "operationId"=>"deleteReusesReuseFeatured", "x-api-path-slug"=>"reusesreusefeatured-delete", "parameters"=>[{"in"=>"path", "name"=>"reuse", "description"=>"The reuse ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses", "Reuse", "Featured"]}, "post"=>{"summary"=>"Add Reuses Reuse Featured", "description"=>"Mark a reuse as featured", "operationId"=>"postReusesReuseFeatured", "x-api-path-slug"=>"reusesreusefeatured-post", "parameters"=>[{"in"=>"path", "name"=>"reuse", "description"=>"The reuse ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses", "Reuse", "Featured"]}}, "/reuses/{reuse}/image"=>{"post"=>{"summary"=>"Add Reuses Reuse Image", "description"=>"Upload a new reuse image", "operationId"=>"postReusesReuseImage", "x-api-path-slug"=>"reusesreuseimage-post", "parameters"=>[{"in"=>"formData", "name"=>"bbox"}, {"in"=>"formData", "name"=>"file"}, {"in"=>"path", "name"=>"reuse", "description"=>"The reuse ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reuses", "Reuse", "Image"]}}, "/site/"=>{"get"=>{"summary"=>"Get Site", "description"=>"Site-wide variables", "operationId"=>"getSite", "x-api-path-slug"=>"site-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Site"]}}, "/site/home/datasets/"=>{"get"=>{"summary"=>"Get Site Home Datasets", "description"=>"List homepage datasets", "operationId"=>"getSiteHomeDatasets", "x-api-path-slug"=>"sitehomedatasets-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Site", "Home", "Datasets"]}, "put"=>{"summary"=>"Put Site Home Datasets", "description"=>"Set the homepage datasets editorial selection", "operationId"=>"putSiteHomeDatasets", "x-api-path-slug"=>"sitehomedatasets-put", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Dataset IDs to put in homepage", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Site", "Home", "Datasets"]}}, "/site/home/reuses/"=>{"get"=>{"summary"=>"Get Site Home Reuses", "description"=>"List homepage featured reuses", "operationId"=>"getSiteHomeReuses", "x-api-path-slug"=>"sitehomereuses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Site", "Home", "Reuses"]}, "put"=>{"summary"=>"Put Site Home Reuses", "description"=>"Set the homepage reuses editorial selection", "operationId"=>"putSiteHomeReuses", "x-api-path-slug"=>"sitehomereuses-put", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Reuse IDs to put in homepage", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Site", "Home", "Reuses"]}}, "/spatial/coverage/{level}"=>{"get"=>{"summary"=>"Get Spatial Coverage Level", "description"=>"List each zone for a given level with their datasets count", "operationId"=>"getSpatialCoverageLevel", "x-api-path-slug"=>"spatialcoveragelevel-get", "parameters"=>[{"in"=>"path", "name"=>"level"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spatial", "Coverage", "Level"]}}, "/spatial/granularities"=>{"get"=>{"summary"=>"Get Spatial Granularities", "description"=>"List all known spatial granularities", "operationId"=>"getSpatialGranularities", "x-api-path-slug"=>"spatialgranularities-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spatial", "Granularities"]}}, "/spatial/levels"=>{"get"=>{"summary"=>"Get Spatial Levels", "description"=>"List all known levels", "operationId"=>"getSpatialLevels", "x-api-path-slug"=>"spatiallevels-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spatial", "Levels"]}}, "/spatial/zone/{id}"=>{"get"=>{"summary"=>"Get Spatial Zone", "description"=>"Fetch a zone", "operationId"=>"getSpatialZone", "x-api-path-slug"=>"spatialzoneid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"A zone identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spatial", "Zone"]}}, "/spatial/zones/suggest"=>{"get"=>{"summary"=>"Get Spatial Zones Suggest", "description"=>"Suggest geospatial zones", "operationId"=>"getSpatialZonesSuggest", "x-api-path-slug"=>"spatialzonessuggest-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The string to autocomplete/suggest"}, {"in"=>"query", "name"=>"size", "description"=>"The amount of suggestion to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spatial", "Zones", "Suggest"]}}, "/spatial/zones/{ids}"=>{"get"=>{"summary"=>"Get Spatial Zones S", "description"=>"Fetch a zone list as GeoJSON", "operationId"=>"getSpatialZonesS", "x-api-path-slug"=>"spatialzonesids-get", "parameters"=>[{"in"=>"path", "name"=>"ids", "description"=>"A zone identifiers list (comma separated)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spatial", "Zones", "S"]}}, "/tags/suggest/"=>{"get"=>{"summary"=>"Get Tags Suggest", "description"=>"Suggest tags", "operationId"=>"getTagsSuggest", "x-api-path-slug"=>"tagssuggest-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The string to autocomplete/suggest"}, {"in"=>"query", "name"=>"size", "description"=>"The amount of suggestion to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Suggest"]}}, "/territory/suggest/"=>{"get"=>{"summary"=>"Get Territory Suggest", "description"=>"", "operationId"=>"getTerritorySuggest", "x-api-path-slug"=>"territorysuggest-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The string to autocomplete/suggest"}, {"in"=>"query", "name"=>"size", "description"=>"The maximum result size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Territory", "Suggest"]}}, "/topics/"=>{"get"=>{"summary"=>"Get Topics", "description"=>"List all topics", "operationId"=>"getTopics", "x-api-path-slug"=>"topics-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page to fetch"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics"]}, "post"=>{"summary"=>"Add Topics", "description"=>"Create a topic", "operationId"=>"postTopics", "x-api-path-slug"=>"topics-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics"]}}, "/topics/{topic}/"=>{"delete"=>{"summary"=>"Delete Topics Topic", "description"=>"Delete a given topic", "operationId"=>"deleteTopicsTopic", "x-api-path-slug"=>"topicstopic-delete", "parameters"=>[{"in"=>"path", "name"=>"topic", "description"=>"The topic ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics", "Topic"]}, "get"=>{"summary"=>"Get Topics Topic", "description"=>"Get a given topic", "operationId"=>"getTopicsTopic", "x-api-path-slug"=>"topicstopic-get", "parameters"=>[{"in"=>"path", "name"=>"topic", "description"=>"The topic ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics", "Topic"]}, "put"=>{"summary"=>"Put Topics Topic", "description"=>"Update a given topic", "operationId"=>"putTopicsTopic", "x-api-path-slug"=>"topicstopic-put", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"topic", "description"=>"The topic ID or slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Topics", "Topic"]}}, "/transfer/"=>{"get"=>{"summary"=>"Get Transfer", "description"=>"List all transfer requests", "operationId"=>"getTransfer", "x-api-path-slug"=>"transfer-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transfer"]}, "post"=>{"summary"=>"Add Transfer", "description"=>"Initiate transfer request", "operationId"=>"postTransfer", "x-api-path-slug"=>"transfer-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transfer"]}}, "/transfer/{id}/"=>{"get"=>{"summary"=>"Get Transfer", "description"=>"Fetch a transfer request given its identifier", "operationId"=>"getTransfer", "x-api-path-slug"=>"transferid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transfer"]}, "post"=>{"summary"=>"Add Transfer", "description"=>"Respond to a transfer request", "operationId"=>"postTransfer", "x-api-path-slug"=>"transferid-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transfer"]}}, "/users/"=>{"get"=>{"summary"=>"Get Users", "description"=>"List all objects", "operationId"=>"getUsers", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"query", "name"=>"datasets"}, {"in"=>"query", "name"=>"facets", "description"=>"Selected facets to fetch"}, {"in"=>"query", "name"=>"organization"}, {"in"=>"query", "name"=>"page", "description"=>"The page to display"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size"}, {"in"=>"query", "name"=>"q", "description"=>"The search query"}, {"in"=>"query", "name"=>"reuses"}, {"in"=>"query", "name"=>"sort", "description"=>"The field (and direction) on which sorting apply"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "post"=>{"summary"=>"Add Users", "description"=>"Create a new object", "operationId"=>"postUsers", "x-api-path-slug"=>"users-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/suggest/"=>{"get"=>{"summary"=>"Get Users Suggest", "description"=>"Suggest users", "operationId"=>"getUsersSuggest", "x-api-path-slug"=>"userssuggest-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The string to autocomplete/suggest"}, {"in"=>"query", "name"=>"size", "description"=>"The amount of suggestion to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Suggest"]}}, "/users/{id}/followers/"=>{"delete"=>{"summary"=>"Delete Users Followers", "description"=>"Unfollow an object given its ID", "operationId"=>"deleteUsersFollowers", "x-api-path-slug"=>"usersidfollowers-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "", "Followers"]}, "get"=>{"summary"=>"Get Users Followers", "description"=>"List all followers for a given object", "operationId"=>"getUsersFollowers", "x-api-path-slug"=>"usersidfollowers-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"page", "description"=>"The page to fetch"}, {"in"=>"query", "name"=>"page_size", "description"=>"The page size to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "", "Followers"]}, "post"=>{"summary"=>"Add Users Followers", "description"=>"Follow an user given its ID", "operationId"=>"postUsersFollowers", "x-api-path-slug"=>"usersidfollowers-post", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "", "Followers"]}}, "/users/{user}/"=>{"delete"=>{"summary"=>"Delete Users User", "description"=>"Delete a given object", "operationId"=>"deleteUsersUser", "x-api-path-slug"=>"usersuser-delete", "parameters"=>[{"in"=>"path", "name"=>"user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User"]}, "get"=>{"summary"=>"Get Users User", "description"=>"Get a given object", "operationId"=>"getUsersUser", "x-api-path-slug"=>"usersuser-get", "parameters"=>[{"in"=>"path", "name"=>"user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User"]}, "put"=>{"summary"=>"Put Users User", "description"=>"Update a given object", "operationId"=>"putUsersUser", "x-api-path-slug"=>"usersuser-put", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "User"]}}, "/workers/jobs/"=>{"get"=>{"summary"=>"Get Workers Jobs", "description"=>"List all scheduled jobs", "operationId"=>"getWorkersJobs", "x-api-path-slug"=>"workersjobs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workers", "Jobs"]}, "post"=>{"summary"=>"Add Workers Jobs", "description"=>"Create a new scheduled job", "operationId"=>"postWorkersJobs", "x-api-path-slug"=>"workersjobs-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workers", "Jobs"]}}, "/workers/jobs/schedulables"=>{"get"=>{"summary"=>"Get Workers Jobs Schedulables", "description"=>"List all schedulable jobs", "operationId"=>"getWorkersJobsSchedulables", "x-api-path-slug"=>"workersjobsschedulables-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workers", "Jobs", "Schedulables"]}}, "/workers/jobs/{id}"=>{"delete"=>{"summary"=>"Delete Workers Jobs", "description"=>"Delete a single scheduled job", "operationId"=>"deleteWorkersJobs", "x-api-path-slug"=>"workersjobsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"A job ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workers", "Jobs"]}, "get"=>{"summary"=>"Get Workers Jobs", "description"=>"Fetch a single scheduled job", "operationId"=>"getWorkersJobs", "x-api-path-slug"=>"workersjobsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"A job ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workers", "Jobs"]}, "put"=>{"summary"=>"Put Workers Jobs", "description"=>"Update a single scheduled job", "operationId"=>"putWorkersJobs", "x-api-path-slug"=>"workersjobsid-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"A job ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workers", "Jobs"]}}, "/workers/tasks/{id}"=>{"get"=>{"summary"=>"Get Workers Tasks", "description"=>"Get a tasks status given its ID", "operationId"=>"getWorkersTasks", "x-api-path-slug"=>"workerstasksid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workers", "Tasks"]}}}}, "apis"=>{"name"=>"Data.Gov", "x-slug"=>"data-gov", "description"=>"data.gov is a U.S. government website launched in late May 2009 by the then Federal Chief Information Officer (CIO) of the United States, Vivek Kundra. According to its website, The purpose of data.gov is to increase public access to high value, machine readable datasets generated by the Executive Branch of the Federal Government. The site seeks to become a repository for all the information the government collects. The site would publish to the public any data that is not private or restricted for national security reasons.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/data-gov-logo.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,Data Provider,Federal Government,Federal Government,Federal Government GSA,General Data,Profiles,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"data-gov/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Data.gov API", "x-api-slug"=>"data-gov-api", "description"=>"data.gov is a U.S. government website launched in late May 2009 by the then Federal Chief Information Officer (CIO) of the United States, Vivek Kundra. According to its website, The purpose of data.gov is to increase public access to high value, machine readable datasets generated by the Executive Branch of the Federal Government. The site seeks to become a repository for all the information the government collects. The site would publish to the public any data that is not private or restricted for national security reasons.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/data-gov-logo.png", "humanURL"=>"http://data.gov/", "baseURL"=>"https://catalog.data.gov//api/3/", "tags"=>"API Provider,Data Provider,Federal Government,Federal Government,Federal Government GSA,General Data,Profiles,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/data-gov/workerstasksid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/data-gov/data-gov-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://www.data.gov/meta/"}, {"type"=>"x-blog-rss", "url"=>"https://www.data.gov/feed/"}, {"type"=>"x-developer", "url"=>"http://developer.data.gov/"}, {"type"=>"x-signup", "url"=>"https://api.data.gov/signup/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/usdatagov"}, {"type"=>"x-website", "url"=>"http://data.gov/"}, {"type"=>"x-wikipedia", "url"=>"http://en.wikipedia.org/wiki/Data.gov"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
mailgun{"mailgun-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Mailgun", "x-complete"=>1, "info"=>{"title"=>"Mailgun API", "description"=>"powerful-apis-that-allow-you-to-send-receive-and-track-email-effortlessly-", "version"=>"v2"}, "host"=>"api.mailgun.net", "basePath"=>"v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"bounces/"=>{"get"=>{"summary"=>"Bounces", "description"=>"Fetches the list of bounces.", "operationId"=>"getBounces", "x-api-path-slug"=>"bounces-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of records to return"}, {"in"=>"query", "name"=>"skip", "description"=>"Number of records to skip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bounces"]}, "post"=>{"summary"=>"Add Bounce", "description"=>"Adds a permanent bounce to the bounces table. Updates the existing record if already here.", "operationId"=>"postBounces", "x-api-path-slug"=>"bounces-post", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Email address to add to bounce list"}, {"in"=>"query", "name"=>"code", "description"=>"Error code (default 550)"}, {"in"=>"query", "name"=>"error", "description"=>"Error description, (default is empty)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bounce"]}}, "bounces/{address}"=>{"delete"=>{"summary"=>"Delete Bounce", "description"=>"Clears a bounce event.", "operationId"=>"deleteBouncesAddress", "x-api-path-slug"=>"bouncesaddress-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bounce"]}, "get"=>{"summary"=>"Bounce", "description"=>"Fetches a single bounce event by a given email address. This is useful to check if a given email address has bounced before.", "operationId"=>"getBouncesAddress", "x-api-path-slug"=>"bouncesaddress-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"The email address to get bounce request for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bounce"]}}, "complaints/"=>{"get"=>{"summary"=>"Complaints", "description"=>"Fetches the list of complaints.", "operationId"=>"getComplaints", "x-api-path-slug"=>"complaints-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of records to return"}, {"in"=>"query", "name"=>"skip", "description"=>"Number of records to skip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Complaints"]}, "post"=>{"summary"=>"Add Complaint", "description"=>"Adds an address to the complaints table.", "operationId"=>"postComplaints", "x-api-path-slug"=>"complaints-post", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Email address to add to the complaint list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Complaint"]}}, "complaints/{address}"=>{"delete"=>{"summary"=>"Delete Complaint", "description"=>"Removes a given spam complaint.", "operationId"=>"deleteComplaintsAddress", "x-api-path-slug"=>"complaintsaddress-delete", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Email address of complaint to remove"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Complaint"]}, "get"=>{"summary"=>"Complaint", "description"=>"Fetches a single spam complaint by a given email address. This is useful to check if a particular user has complained.", "operationId"=>"getComplaintsAddress", "x-api-path-slug"=>"complaintsaddress-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Email address of the complaint to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Complaint"]}}, "lists"=>{"post"=>{"summary"=>"Create List", "description"=>"Creates a new mailing list.", "operationId"=>"postLists", "x-api-path-slug"=>"lists-post", "parameters"=>[{"in"=>"query", "name"=>"access_level", "description"=>"List access level, one of: readonly (default), members, everyone"}, {"in"=>"query", "name"=>"address", "description"=>"A valid email address for the mailing list, e"}, {"in"=>"query", "name"=>"description", "description"=>"A description"}, {"in"=>"query", "name"=>"name", "description"=>"Mailing list name, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List"]}}, "lists/"=>{"get"=>{"summary"=>"Lists", "description"=>"Returns a list of mailing lists under your account.", "operationId"=>"getLists", "x-api-path-slug"=>"lists-get", "parameters"=>[{"in"=>"query", "name"=>"access_level", "description"=>"List access level, one of: readonly (default), members, everyone"}, {"in"=>"query", "name"=>"address", "description"=>"Find a mailing list by itu2019s address (optional)"}, {"in"=>"query", "name"=>"description", "description"=>"Description string"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of records to return (100 by default)"}, {"in"=>"query", "name"=>"namespace_id", "description"=>"New name, e"}, {"in"=>"query", "name"=>"skip", "description"=>"Records to skip (0 by default)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists"]}}, "lists/{address}"=>{"delete"=>{"summary"=>"Delete List", "description"=>"Deletes a mailing list.", "operationId"=>"deleteListsAddress", "x-api-path-slug"=>"listsaddress-delete", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Address to remove"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List"]}, "get"=>{"summary"=>"List", "description"=>"Returns a single mailing list by a given address.", "operationId"=>"getListsAddress", "x-api-path-slug"=>"listsaddress-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Address to return for a single list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List"]}, "put"=>{"summary"=>"Update List", "description"=>"Update mailing list properties, such as address, description or name", "operationId"=>"putListsAddress", "x-api-path-slug"=>"listsaddress-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List"]}}, "lists/{address}/members"=>{"get"=>{"summary"=>"Add To List", "description"=>"Adds a member to the mailing list.", "operationId"=>"getListsAddressMembers", "x-api-path-slug"=>"listsaddressmembers-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Valid email address specification, e"}, {"in"=>"query", "name"=>"Name", "description"=>"Optional member name"}, {"in"=>"query", "name"=>"subscribed", "description"=>"yes to add as subscribed (default), no as unsubscribed"}, {"in"=>"query", "name"=>"upsert", "description"=>"yes to update member if present, no to raise error in case of a duplicate member (default)"}, {"in"=>"query", "name"=>"vars", "description"=>"JSON-encoded dictionary string with arbitrary parameters, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List"]}}, "lists/{address}/members/"=>{"get"=>{"summary"=>"List Members", "description"=>"Fetches the list of mailing list members.", "operationId"=>"getListsAddressMembers", "x-api-path-slug"=>"listsaddressmembers-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of records to return (100 by default)"}, {"in"=>"query", "name"=>"skip", "description"=>"Records to skip (0 by default)"}, {"in"=>"query", "name"=>"subscribed", "description"=>"yes to list subscribed, no for unsubscribed, list all if not set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Members"]}}, "lists/{address}/members/{member_address}"=>{"get"=>{"summary"=>"List Member", "description"=>"Retrieves a mailing list member.", "operationId"=>"getListsAddressMembersMemberAddress", "x-api-path-slug"=>"listsaddressmembersmember-address-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"Email address of commenter"}, {"in"=>"query", "name"=>"member_address", "description"=>"Email address on the list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Member"]}}, "messages.mime"=>{"post"=>{"summary"=>"Posts Mime Message", "description"=>"Posts a message in MIME format. Note: you will need to build a MIME string yourself. Use a MIME library for your programming language to do this. Pass the resulting MIME string as message parameter.", "operationId"=>"postMessages.mime", "x-api-path-slug"=>"messages-mime-post", "parameters"=>[{"in"=>"query", "name"=>"h:X-My-Header", "description"=>"h: prefix followed by an arbitrary value allows to appendna custom MIME header to the message (X-My-Headernin this case)"}, {"in"=>"query", "name"=>"message", "description"=>"MIME string of the message"}, {"in"=>"query", "name"=>"o:campaign", "description"=>"Id of the campaign the message belongs to"}, {"in"=>"query", "name"=>"o:deliverytime", "description"=>"Desired time of delivery"}, {"in"=>"query", "name"=>"o:dkim", "description"=>"Enables/disabled DKIM signatures on per-message basis"}, {"in"=>"query", "name"=>"o:tag", "description"=>"Tag string"}, {"in"=>"query", "name"=>"o:testmode", "description"=>"Enables sending in test mode"}, {"in"=>"query", "name"=>"o:tracking", "description"=>"Toggles tracking on a per-message basis, seenTracking Messages for details"}, {"in"=>"query", "name"=>"o:tracking-clicks", "description"=>"Toggles clicks tracking on a per-message basis"}, {"in"=>"query", "name"=>"o:tracking-opens", "description"=>"Toggles opens tracking on a per-message basis"}, {"in"=>"query", "name"=>"to", "description"=>"Email address of the recipient(s)"}, {"in"=>"query", "name"=>"v:my-var", "description"=>"v: prefix followed by an arbitrary name allows tonattach a custom JSON data to the message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Mime", "Message"]}}, "messages/"=>{"post"=>{"summary"=>"Send Message", "description"=>"Sends a message by assembling it from the components. Note that you can specify most parameters multiple times, HTTP supports this out of the box. This makes sense for parameters like cc, to or attachment.", "operationId"=>"postMessages", "x-api-path-slug"=>"messages-post", "parameters"=>[{"in"=>"query", "name"=>"attachment", "description"=>"File attachment"}, {"in"=>"query", "name"=>"bcc", "description"=>"Same as To but for Bcc"}, {"in"=>"query", "name"=>"cc", "description"=>"Same as To but for Cc"}, {"in"=>"query", "name"=>"from", "description"=>"Email address for From header"}, {"in"=>"query", "name"=>"h:X-My-Header", "description"=>"h: prefix followed by an arbitrary value allows to appendna custom MIME header to the message (X-My-Headernin this case)"}, {"in"=>"query", "name"=>"html", "description"=>"Body of the message"}, {"in"=>"query", "name"=>"inline", "description"=>"Attachment with inline disposition"}, {"in"=>"query", "name"=>"o:campaign", "description"=>"Id of the campaign the message belongs to"}, {"in"=>"query", "name"=>"o:deliverytime", "description"=>"Desired time of delivery"}, {"in"=>"query", "name"=>"o:dkim", "description"=>"Enables/disables DKIM signatures on per-message basis"}, {"in"=>"query", "name"=>"o:tag", "description"=>"Tag string"}, {"in"=>"query", "name"=>"o:testmode", "description"=>"Enables sending in test mode"}, {"in"=>"query", "name"=>"o:tracking", "description"=>"Toggles tracking on a per-message basis, seenTracking Messages for details"}, {"in"=>"query", "name"=>"o:tracking-clicks", "description"=>"Toggles clicks tracking on a per-message basis"}, {"in"=>"query", "name"=>"o:tracking-opens", "description"=>"Toggles opens tracking on a per-message basis"}, {"in"=>"query", "name"=>"subject", "description"=>"Message subject"}, {"in"=>"query", "name"=>"text", "description"=>"Body of the message"}, {"in"=>"query", "name"=>"to", "description"=>"Email address of the recipient(s)"}, {"in"=>"query", "name"=>"v:my-var", "description"=>"v: prefix followed by an arbitrary name allows tonattach a custom JSON data to the message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Message"]}}, "messages/{id}"=>{"get"=>{"summary"=>"Message", "description"=>"Gets a message.", "operationId"=>"getMessages", "x-api-path-slug"=>"messagesid-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"ID of the message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}}, "routes/"=>{"get"=>{"summary"=>"Routes", "description"=>"Fetches the list of routes. Note that routes are defined globally, per account, not per domain as most of other API calls.", "operationId"=>"getRoutes", "x-api-path-slug"=>"routes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Routes"]}, "post"=>{"summary"=>"Add Route", "description"=>"Creates a new route.", "operationId"=>"postRoutes", "x-api-path-slug"=>"routes-post", "parameters"=>[{"in"=>"query", "name"=>"action", "description"=>"Route action"}, {"in"=>"query", "name"=>"description", "description"=>"An arbitrary string"}, {"in"=>"query", "name"=>"expression", "description"=>"A filter expression like match_recipient("}, {"in"=>"query", "name"=>"priority", "description"=>"Integer: smaller number indicates higher priority"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route"]}}, "routes/{id}"=>{"delete"=>{"summary"=>"Delete Route", "description"=>"Deletes a route based on the id.", "operationId"=>"deleteRoutes", "x-api-path-slug"=>"routesid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the route"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route"]}, "get"=>{"summary"=>"Route", "description"=>"Returns a single route object based on its ID.", "operationId"=>"getRoutes", "x-api-path-slug"=>"routesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route"]}, "put"=>{"summary"=>"Updates Route", "description"=>"Updates a given route by ID.", "operationId"=>"putRoutes", "x-api-path-slug"=>"routesid-put", "parameters"=>[{"in"=>"query", "name"=>"action", "description"=>"Route action"}, {"in"=>"query", "name"=>"description", "description"=>"An arbitrary string"}, {"in"=>"query", "name"=>"expression", "description"=>"A filter expression like match_recipient("}, {"in"=>"path", "name"=>"id", "description"=>"ID of the route"}, {"in"=>"query", "name"=>"priority", "description"=>"Integer: smaller number indicates higher priority"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Route"]}}, "stats/"=>{"get"=>{"summary"=>"Stats", "description"=>"Returns a list of event stat items. Each record represents counts for one event per one day.", "operationId"=>"getStats", "x-api-path-slug"=>"stats-get", "parameters"=>[{"in"=>"query", "name"=>"event", "description"=>"Name of the event to receive the stats for"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of records to return"}, {"in"=>"query", "name"=>"skip", "description"=>"Number of records to skip"}, {"in"=>"query", "name"=>"start-date", "description"=>"The date to receive the stats starting from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats"]}}, "tags/{tag}"=>{"delete"=>{"summary"=>"Delete Tag", "description"=>"Deletes all counters for particular tag and the tag itself.", "operationId"=>"deleteTagsTag", "x-api-path-slug"=>"tagstag-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tag"]}}, "unsubscribes/"=>{"get"=>{"summary"=>"Unsubscribes", "description"=>"This API allows you to programmatically download the list of recipients who have unsubscribed from your emails.", "operationId"=>"getUnsubscribes", "x-api-path-slug"=>"unsubscribes-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Number of records to return"}, {"in"=>"query", "name"=>"skip", "description"=>"Number of records to skip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsubscribes"]}, "post"=>{"summary"=>"Add to unsubscribe list.", "description"=>"Adds address to unsubscribed table.", "operationId"=>"postUnsubscribes", "x-api-path-slug"=>"unsubscribes-post", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"The address to add to unsubscribe list"}, {"in"=>"query", "name"=>"tag", "description"=>"Tag to unsubscribe from, use * to unsubscribe address from domain"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["To", "Unsubscribe", "List"]}}, "unsubscribes/{address}"=>{"delete"=>{"summary"=>"Delete Unsubscribe", "description"=>"Removes an address from the unsubscribes table. Address defines which events to delete.", "operationId"=>"deleteUnsubscribesAddress", "x-api-path-slug"=>"unsubscribesaddress-delete", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"The email address of the person on the unsubscribe list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsubscribe"]}, "get"=>{"summary"=>"Unsubscribe", "description"=>"Retreives a single unsubscribe record. Can be used to check if a given address is present in the list of unsubscribed users.", "operationId"=>"getUnsubscribesAddress", "x-api-path-slug"=>"unsubscribesaddress-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"The email address of the person on the unsubscribe list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsubscribe"]}}}}, "apis"=>{"name"=>"Mailgun", "x-slug"=>"mailgun", "description"=>"Mailgun provides a web service for integrating email inboxes into apps. Providing APIs for sending, receiving, and storing APis, including tools for managing delivery, real-time integration, organizing, routing, and tracking on emails. Malign provides a free trial to learn about services, and pay as you go, unit based pricing to continue from there, including volume pricing for increased usage.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/612-mail_gun.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"24750", "tags"=>"API Provider,API Provider,Emails,Emails,Messages,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"mailgun/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Mailgun API", "x-api-slug"=>"mailgun-api", "description"=>"Mailgun is a set of powerful APIs that allow you to send, receive, track and store email effortlessly.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/612-mail_gun.jpg", "humanURL"=>"http://mailgun.net", "baseURL"=>"https://api.mailgun.net/v2/", "tags"=>"API Provider,API Provider,Emails,Emails,Messages,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/mailgun/unsubscribesaddress-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/mailgun/mailgun-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x--net-library", "url"=>"http://documentation.mailgun.com/libraries.html#c"}, {"type"=>"x-base", "url"=>"https://api.mailgun.net"}, {"type"=>"x-blog", "url"=>"http://blog.mailgun.net"}, {"type"=>"x-blog-rss", "url"=>"https://twitter.com/unbounce"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/mailgun"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/mailgun"}, {"type"=>"x-developer", "url"=>"http://documentation.mailgun.com/"}, {"type"=>"x-email", "url"=>"privacy@mailgun.com"}, {"type"=>"x-faq", "url"=>"http://documentation.mailgun.com/faqs.html"}, {"type"=>"x-github", "url"=>"https://github.com/mailgun"}, {"type"=>"x-heroku-addon", "url"=>"https://addons.heroku.com/mailgun"}, {"type"=>"x-java-library", "url"=>"http://documentation.mailgun.com/libraries.html#java"}, {"type"=>"x-node-js-library", "url"=>"http://documentation.mailgun.com/libraries.html#node-js"}, {"type"=>"x-php-library", "url"=>"http://documentation.mailgun.com/libraries.html#php"}, {"type"=>"x-pricing", "url"=>"http://www.mailgun.com/pricing"}, {"type"=>"x-privacy", "url"=>"http://www.mailgun.com/privacy"}, {"type"=>"x-python-library", "url"=>"http://documentation.mailgun.com/libraries.html#python"}, {"type"=>"x-ruby-library", "url"=>"http://documentation.mailgun.com/libraries.html#ruby"}, {"type"=>"x-selfservice-registration", "url"=>"https://www.mailgun.com/signup"}, {"type"=>"x-stack-overflow", "url"=>"https://stackoverflow.com/questions/tagged/mailgun"}, {"type"=>"x-terms-of-service", "url"=>"http://www.mailgun.com/terms"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/#!/mail_gun"}, {"type"=>"x-website", "url"=>"http://mailgun.net"}, {"type"=>"x-wordpress-plugin", "url"=>"https://wordpress.org/plugins/mailgun/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
loginradius{"matrix-login-operations-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"LoginRadius", "x-complete"=>1, "info"=>{"title"=>"Login Operations", "version"=>"1.0.0"}, "host"=>"/login", "basePath"=>"http://localhost:8008/_matrix/client/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/login"=>{"get"=>{"summary"=>"Get the login mechanism to use when logging in.", "description"=>"All login stages MUST be mentioned if there is >1 login type.", "operationId"=>"get_login_info", "x-api-path-slug"=>"login-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Login", "Mechanism", "To", "Use", "When", "Logging", "In"]}, "post"=>{"summary"=>"Submit a login action.", "description"=>"If this is part of a multi-stage login, there MUST be a session key.", "operationId"=>"submit_login", "x-api-path-slug"=>"login-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A login submission", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Submit", "Login", "Action"]}}}}, "apis"=>{"name"=>"LoginRadius", "x-slug"=>"loginradius", "description"=>"Simplify customer authentication and authorization to amplify your business with better understanding of your audience using our customer identity management", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1086-loginradius.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"60839", "tags"=>"API Provider,API Service Provider,Authentication,Authentication,Enterprise,Identities,Login,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology,Users", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"loginradius/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Matrix Login Operations API", "x-api-slug"=>"matrix-login-operations-api", "description"=>"Matrix is an open standard for decentralised communication, providing simple HTTP APIs and open source reference implementations for securely distributing and persisting JSON over an open federation of servers.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1086-loginradius.jpg", "humanURL"=>"http://www.loginradius.com/", "baseURL"=>":///login/http://localhost:8008/_matrix/client/api/v1", "tags"=>"API Provider,API Service Provider,Authentication,Authentication,Enterprise,Identities,Login,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology,Users", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/loginradius/matrix-login-operations-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.loginradius.com"}, {"type"=>"x-blog", "url"=>"http://blog.loginradius.com"}, {"type"=>"x-blog-rss", "url"=>"http://blog.loginradius.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/loginradius"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/loginradius"}, {"type"=>"x-developer", "url"=>"http://www.loginradius.com/developers"}, {"type"=>"x-email", "url"=>"privacy@loginradius.com"}, {"type"=>"x-email", "url"=>"legal@loginradius.com"}, {"type"=>"x-email", "url"=>"support@loginradius.com"}, {"type"=>"x-github", "url"=>"https://github.com/LoginRadius"}, {"type"=>"x-pricing", "url"=>"http://www.loginradius.com/pricing"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/LoginRadius"}, {"type"=>"x-website", "url"=>"http://www.loginradius.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
graphhopper{"route-optimization-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"GraphHopper", "x-complete"=>1, "info"=>{"title"=>"Route Optimization", "description"=>"our-route-optimization-api-solves-the-so-called-vehicle-routing-problem-fast--it-calculates-an-optimal-tour-for-a-set-of-vehicles-services-and-constraints", "version"=>"1.0"}, "host"=>"graphhopper.com", "basePath"=>"/api/1/vrp", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/optimize"=>{"post"=>{"summary"=>"Solves vehicle routing problems", "description"=>"This endpoint for solving vehicle routing problems, i.e. traveling salesman or vehicle routing problems, and returns the solution.", "operationId"=>"postVrp", "x-api-path-slug"=>"optimize-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Request object that contains the problem to be solved", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"key", "description"=>"your API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/solution/{jobId}"=>{"get"=>{"summary"=>"Return the solution associated to the jobId", "description"=>"This endpoint returns the solution of a large problems. You can fetch it with the job_id, you have been sent.", "operationId"=>"getSolution", "x-api-path-slug"=>"solutionjobid-get", "parameters"=>[{"in"=>"path", "name"=>"jobId", "description"=>"Request solution with jobId"}, {"in"=>"query", "name"=>"key", "description"=>"your API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"GraphHopper", "x-slug"=>"graphhopper", "description"=>"Use our web services to add route planning, navigation and traffic aware route optimization to your application in the food delivery industry or for traveling salesmen. We help you to optimize the routes in your logistics, GIS or real estate software.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/graphhopper-logo-small-300x51.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"General Data,Maps,Relative Data,Routes,Service API,Travel", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"graphhopper/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Route Optimization", "x-api-slug"=>"route-optimization", "description"=>"Use our web services to add route planning, navigation and traffic aware route optimization to your application in the food delivery industry or for traveling salesmen. We help you to optimize the routes in your logistics, GIS or real estate software.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/graphhopper-logo-small-300x51.png", "humanURL"=>"https://graphhopper.com", "baseURL"=>"https://graphhopper.com//api/1/vrp", "tags"=>"General Data,Maps,Relative Data,Routes,Service API,Travel", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/graphhopper/route-optimization-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://graphhopper.com"}, {"type"=>"x-blog", "url"=>"https://www.graphhopper.com/blog/"}, {"type"=>"x-developer", "url"=>"https://www.graphhopper.com/developers/"}, {"type"=>"x-documentation", "url"=>"https://graphhopper.com/api/1/docs/"}, {"type"=>"x-faq", "url"=>"https://graphhopper.com/api/1/docs/FAQ/"}, {"type"=>"x-forum", "url"=>"https://discuss.graphhopper.com/"}, {"type"=>"x-github", "url"=>"https://github.com/graphhopper"}, {"type"=>"x-pricing", "url"=>"https://www.graphhopper.com/pricing/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/graphhopper"}, {"type"=>"x-website", "url"=>"http://graphhopper.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-machine-learning-engine{"google-cloud-machine-learning-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Machine Learning Engine", "x-complete"=>1, "info"=>{"title"=>"Google Cloud Machine Learning Engine", "description"=>"an-api-to-enable-creating-and-using-machine-learning-models-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"ml.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/{name}"=>{"delete"=>{"summary"=>"Delete Model Version", "description"=>"Deletes a model version.\n\nEach model can have multiple versions deployed and in use at any given\ntime. Use this method to remove a single version.\n\nNote: You cannot delete the version that is set as the default version\nof the model unless it is the only remaining version.", "operationId"=>"ml.projects.models.versions.delete", "x-api-path-slug"=>"v1name-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Version"]}, "get"=>{"summary"=>"Get Model Version", "description"=>"Gets information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml/reference/rest/v1/projects.models.versions/list)\nto get the same information that this method returns for all of the\nversions of a model.", "operationId"=>"ml.projects.models.versions.get", "x-api-path-slug"=>"v1name-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Version"]}}, "/v1/{name}/operations"=>{"get"=>{"summary"=>"Get Operations", "description"=>"Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.", "operationId"=>"ml.projects.operations.list", "x-api-path-slug"=>"v1nameoperations-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"The standard list filter"}, {"in"=>"path", "name"=>"name", "description"=>"The name of the operation collection"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The standard list page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The standard list page token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Operation"]}}, "/v1/{name}:cancel"=>{"post"=>{"summary"=>"Cancel Operation", "description"=>"Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", "operationId"=>"ml.projects.operations.cancel", "x-api-path-slug"=>"v1namecancel-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The name of the operation resource to be cancelled"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Operation"]}}, "/v1/{name}:getConfig"=>{"get"=>{"summary"=>"Get Operation", "description"=>"Get the service account information associated with your project. You need\nthis information in order to grant the service account persmissions for\nthe Google Cloud Storage location where you put your model training code\nfor training the model with Google Cloud Machine Learning.", "operationId"=>"ml.projects.getConfig", "x-api-path-slug"=>"v1namegetconfig-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Operation"]}}, "/v1/{name}:predict"=>{"post"=>{"summary"=>"Predict Operation", "description"=>"Performs prediction on the data in the request.\n\n**** REMOVE FROM GENERATED DOCUMENTATION", "operationId"=>"ml.projects.predict", "x-api-path-slug"=>"v1namepredict-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Operation"]}}, "/v1/{name}:setDefault"=>{"post"=>{"summary"=>"Set Default Version", "description"=>"Designates a version to be the default for the model.\n\nThe default version is used for prediction requests made against the model\nthat don't specify a version.\n\nThe first version to be created for a model is automatically set as the\ndefault. You must make any subsequent changes to the default version\nsetting manually using this method.", "operationId"=>"ml.projects.models.versions.setDefault", "x-api-path-slug"=>"v1namesetdefault-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Version"]}}, "/v1/{parent}/jobs"=>{"get"=>{"summary"=>"List Jobs", "description"=>"Lists the jobs in the project.", "operationId"=>"ml.projects.jobs.list", "x-api-path-slug"=>"v1parentjobs-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Optional"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Optional"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Optional"}, {"in"=>"path", "name"=>"parent", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Job"]}, "post"=>{"summary"=>"Create Job", "description"=>"Creates a training or a batch prediction job.", "operationId"=>"ml.projects.jobs.create", "x-api-path-slug"=>"v1parentjobs-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"parent", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Job"]}}, "/v1/{parent}/models"=>{"get"=>{"summary"=>"List Models", "description"=>"Lists the models in a project.\n\nEach project can contain multiple models, and each model can have multiple\nversions.", "operationId"=>"ml.projects.models.list", "x-api-path-slug"=>"v1parentmodels-get", "parameters"=>[{"in"=>"query", "name"=>"pageSize", "description"=>"Optional"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Optional"}, {"in"=>"path", "name"=>"parent", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Model"]}, "post"=>{"summary"=>"Create Models", "description"=>"Creates a model which will later contain one or more versions.\n\nYou must add at least one version before you can request predictions from\nthe model. Add versions by calling\n[projects.models.versions.create](/ml/reference/rest/v1/projects.models.versions/create).", "operationId"=>"ml.projects.models.create", "x-api-path-slug"=>"v1parentmodels-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"parent", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Model"]}}, "/v1/{parent}/versions"=>{"get"=>{"summary"=>"Get Version", "description"=>"Gets basic information about all the versions of a model.\n\nIf you expect that a model has a lot of versions, or if you need to handle\nonly a limited number of results at a time, you can request that the list\nbe retrieved in batches (called pages):", "operationId"=>"ml.projects.models.versions.list", "x-api-path-slug"=>"v1parentversions-get", "parameters"=>[{"in"=>"query", "name"=>"pageSize", "description"=>"Optional"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Optional"}, {"in"=>"path", "name"=>"parent", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Version"]}, "post"=>{"summary"=>"Create Version", "description"=>"Creates a new version of a model from a trained TensorFlow model.\n\nIf the version created in the cloud by this call is the first deployed\nversion of the specified model, it will be made the default version of the\nmodel. When you add a version to a model that already has one or more\nversions, the default version does not automatically change. If you want a\nnew version to be the default, you must call\n[projects.models.versions.setDefault](/ml/reference/rest/v1/projects.models.versions/setDefault).", "operationId"=>"ml.projects.models.versions.create", "x-api-path-slug"=>"v1parentversions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"parent", "description"=>"Required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Version"]}}}}, "apis"=>{"name"=>"Google Cloud Machine Learning Engine", "x-slug"=>"google-cloud-machine-learning-engine", "description"=>"Google Cloud Machine Learning Engine is a managed service that enables you to easily build machine learning models, that work on any type of data, of any size. Create your model with the powerful TensorFlow framework that powers many Google products, from Google Photos to Google Cloud Speech. Build models of any size with our managed scalable infrastructure. Your trained model is immediately available for use with our global prediction platform that can support thousands of users and TBs of data.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-cloud-ml.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Machine Learning,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-machine-learning-engine/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Machine Learning API", "x-api-slug"=>"google-cloud-machine-learning-api", "description"=>"Google Cloud Machine Learning Engine is a managed service that enables you to easily build machine learning models, that work on any type of data, of any size. Create your model with the powerful TensorFlow framework that powers many Google products, from Google Photos to Google Cloud Speech. Build models of any size with our managed scalable infrastructure. Your trained model is immediately available for use with our global prediction platform that can support thousands of users and TBs of data.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-cloud-ml.png", "humanURL"=>"https://cloud.google.com/ml-engine/", "baseURL"=>"://ml.googleapis.com//", "tags"=>"API Provider,API Service Provider,Google APIs,Machine Learning,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-machine-learning-engine/google-cloud-machine-learning-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-log", "url"=>"https://cloud.google.com/ml-engine/docs/resources/release-notes"}, {"type"=>"x-command-line-interface", "url"=>"https://cloud.google.com/sdk/gcloud/reference/ml-engine/"}, {"type"=>"x-concepts", "url"=>"https://cloud.google.com/ml-engine/docs/concepts/"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/ml-engine/docs/"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/ml-engine/docs/quickstarts/"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/ml-engine/pricing"}, {"type"=>"x-rate-limits", "url"=>"https://cloud.google.com/ml-engine/quotas"}, {"type"=>"x-service-level-agreements", "url"=>"https://cloud.google.com/ml-engine/sla"}, {"type"=>"x-support", "url"=>"https://cloud.google.com/ml-engine/docs/resources/support"}, {"type"=>"x-terms-of-service", "url"=>"https://cloud.google.com/terms/"}, {"type"=>"x-tutorials", "url"=>"https://cloud.google.com/ml-engine/docs/tutorials/"}, {"type"=>"x-versioning", "url"=>"https://cloud.google.com/ml-engine/docs/concepts/versioning"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/ml-engine/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
slack{"slack-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Slack", "x-complete"=>1, "info"=>{"title"=>"Slack", "description"=>"one-way-to-interact-with-the-slack-platform-is-its-http-rpcbased-web-api-a-collection-of-methods-requiring-oauth-2-0based-user-bot-or-workspace-tokens-blessed-with-related-oauth-scopes-", "version"=>"1.0.3"}, "host"=>"slack.com", "basePath"=>"/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/chat.delete"=>{"post"=>{"summary"=>"Delete Message", "description"=>"Deletes a message.", "operationId"=>"chat_delete", "x-api-path-slug"=>"chat-delete-post", "parameters"=>[{"in"=>"formData", "name"=>"as_user", "description"=>"Pass true to delete the message as the authed user with `chat:write:user` scope"}, {"in"=>"formData", "name"=>"channel", "description"=>"Channel containing the message to be deleted"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"ts", "description"=>"Timestamp of the message to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages"]}}, "/files.comments.edit"=>{"post"=>{"summary"=>"Edit File Comments", "description"=>"Edit an existing file comment.", "operationId"=>"files_comments_edit", "x-api-path-slug"=>"files-comments-edit-post", "parameters"=>[{"in"=>"formData", "name"=>"comment", "description"=>"Text of the comment to edit"}, {"in"=>"formData", "name"=>"file", "description"=>"File containing the comment to edit"}, {"in"=>"formData", "name"=>"id", "description"=>"The comment to edit"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Files", "Comments"]}}, "/im.close"=>{"post"=>{"summary"=>"Close Group", "description"=>"Close a direct message channel.", "operationId"=>"im_close", "x-api-path-slug"=>"im-close-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Direct message channel to close"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging"]}}, "/groups.replies"=>{"get"=>{"summary"=>"Get Group Thread", "description"=>"Retrieve a thread of messages posted to a private channel", "operationId"=>"groups_replies", "x-api-path-slug"=>"groups-replies-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"Private channel to fetch thread from"}, {"in"=>"query", "name"=>"thread_ts", "description"=>"Unique identifier of a threads parent message"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/bots.info"=>{"get"=>{"summary"=>"Get Bot Info", "description"=>"Gets information about a bot user.", "operationId"=>"bots_info", "x-api-path-slug"=>"bots-info-get", "parameters"=>[{"in"=>"query", "name"=>"bot", "description"=>"Bot user to get info on"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Bots"]}}, "/groups.rename"=>{"post"=>{"summary"=>"Rename Group", "description"=>"Renames a private channel.", "operationId"=>"groups_rename", "x-api-path-slug"=>"groups-rename-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Private channel to rename"}, {"in"=>"formData", "name"=>"name", "description"=>"New name for private channel"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"validate", "description"=>"Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/users.profile.set"=>{"post"=>{"summary"=>"Set User Profile", "description"=>"Set the profile information for a user.", "operationId"=>"users_profile_set", "x-api-path-slug"=>"users-profile-set-post", "parameters"=>[{"in"=>"formData", "name"=>"name", "description"=>"Name of a single key to set"}, {"in"=>"formData", "name"=>"profile", "description"=>"Collection of key:value pairs presented as a URL-encoded JSON hash"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"user", "description"=>"ID of user to change"}, {"in"=>"formData", "name"=>"value", "description"=>"Value to set a single key to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Users"]}}, "/users.setPresence"=>{"post"=>{"summary"=>"Set User Presence", "description"=>"Manually sets user presence.", "operationId"=>"users_setPresence", "x-api-path-slug"=>"users-setpresence-post", "parameters"=>[{"in"=>"formData", "name"=>"presence", "description"=>"Either `auto` or `away`"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Users"]}}, "/conversations.close"=>{"post"=>{"summary"=>"Close Conversation", "description"=>"Closes a direct message or multi-person direct message.", "operationId"=>"conversations_close", "x-api-path-slug"=>"conversations-close-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Conversation to close"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations"]}}, "/im.open"=>{"post"=>{"summary"=>"Open Messages", "description"=>"Opens a direct message channel.", "operationId"=>"im_open", "x-api-path-slug"=>"im-open-post", "parameters"=>[{"in"=>"formData", "name"=>"include_locale", "description"=>"Set this to `true` to receive the locale for this im"}, {"in"=>"formData", "name"=>"return_im", "description"=>"Boolean, indicates you want the full IM channel definition in the response"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"user", "description"=>"User to open a direct message channel with"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging"]}}, "/groups.list"=>{"get"=>{"summary"=>"Get Group", "description"=>"Lists private channels that the calling user has access to.", "operationId"=>"groups_list", "x-api-path-slug"=>"groups-list-get", "parameters"=>[{"in"=>"query", "name"=>"exclude_archived", "description"=>"Dont return archived private channels"}, {"in"=>"query", "name"=>"exclude_members", "description"=>"Exclude the `members` from each `group`"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/team.integrationLogs"=>{"get"=>{"summary"=>"Get Team Logs", "description"=>"Gets the integration logs for the current team.", "operationId"=>"team_integrationLogs", "x-api-path-slug"=>"team-integrationlogs-get", "parameters"=>[{"in"=>"query", "name"=>"app_id", "description"=>"Filter logs to this Slack app"}, {"in"=>"query", "name"=>"change_type", "description"=>"Filter logs with this change type"}, {"in"=>"query", "name"=>"count"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"service_id", "description"=>"Filter logs to this service"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"user", "description"=>"Filter logs generated by this user???s actions"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Teams"]}}, "/groups.kick"=>{"post"=>{"summary"=>"Remove User From Group", "description"=>"Removes a user from a private channel.", "operationId"=>"groups_kick", "x-api-path-slug"=>"groups-kick-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Private channel to remove user from"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"user", "description"=>"User to remove from private channel"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/dnd.info"=>{"get"=>{"summary"=>"Get Do Not Disturb", "description"=>"Retrieves a user's current Do Not Disturb status.", "operationId"=>"dnd_info", "x-api-path-slug"=>"dnd-info-get", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"user", "description"=>"User to fetch status for (defaults to current user)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Do Not Disturb"]}}, "/channels.archive"=>{"post"=>{"summary"=>"Archive Channel", "description"=>"Archives a channel.", "operationId"=>"channels_archive", "x-api-path-slug"=>"channels-archive-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel to archive"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Channels", "Archives"]}}, "/reminders.info"=>{"get"=>{"summary"=>"Get Reminder", "description"=>"Gets information about a reminder.", "operationId"=>"reminders_info", "x-api-path-slug"=>"reminders-info-get", "parameters"=>[{"in"=>"query", "name"=>"reminder", "description"=>"The ID of the reminder"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Reminders"]}}, "/channels.info"=>{"get"=>{"summary"=>"Get Channel", "description"=>"Gets information about a channel.", "operationId"=>"channels_info", "x-api-path-slug"=>"channels-info-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"Channel to get info on"}, {"in"=>"query", "name"=>"include_locale", "description"=>"Set this to `true` to receive the locale for this channel"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Channels"]}}, "/channels.kick"=>{"post"=>{"summary"=>"Remove User From Channel", "description"=>"Removes a user from a channel.", "operationId"=>"channels_kick", "x-api-path-slug"=>"channels-kick-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel to remove user from"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"user", "description"=>"User to remove from channel"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Channels"]}}, "/groups.mark"=>{"post"=>{"summary"=>"Mark Group", "description"=>"Sets the read cursor in a private channel.", "operationId"=>"groups_mark", "x-api-path-slug"=>"groups-mark-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Private channel to set reading cursor in"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"ts", "description"=>"Timestamp of the most recently seen message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/mpim.close"=>{"post"=>{"summary"=>"Close Multiparty Direct Message", "description"=>"Closes a multiparty direct message channel.", "operationId"=>"mpim_close", "x-api-path-slug"=>"mpim-close-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"MPIM to close"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging"]}}, "/conversations.join"=>{"post"=>{"summary"=>"Join Conversation", "description"=>"Joins an existing conversation.", "operationId"=>"conversations_join", "x-api-path-slug"=>"conversations-join-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"ID of conversation to join"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations"]}}, "/channels.history"=>{"get"=>{"summary"=>"Get Channel History", "description"=>"Fetches history of messages and events from a channel.", "operationId"=>"channels_history", "x-api-path-slug"=>"channels-history-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"Channel to fetch history for"}, {"in"=>"query", "name"=>"count", "description"=>"Number of messages to return, between 1 and 1000"}, {"in"=>"query", "name"=>"inclusive", "description"=>"Include messages with latest or oldest timestamp in results"}, {"in"=>"query", "name"=>"latest", "description"=>"End of time range of messages to include in results"}, {"in"=>"query", "name"=>"oldest", "description"=>"Start of time range of messages to include in results"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"unreads", "description"=>"Include `unread_count_display` in the output?"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Channels"]}}, "/im.mark"=>{"post"=>{"summary"=>"Mark Messages", "description"=>"Sets the read cursor in a direct message channel.", "operationId"=>"im_mark", "x-api-path-slug"=>"im-mark-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Direct message channel to set reading cursor in"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"ts", "description"=>"Timestamp of the most recently seen message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging"]}}, "/oauth.token"=>{"get"=>{"summary"=>"Oauth Token", "description"=>"Exchanges a temporary OAuth verifier code for a workspace token.", "operationId"=>"oauth_token", "x-api-path-slug"=>"oauth-token-get", "parameters"=>[{"in"=>"query", "name"=>"client_id", "description"=>"Issued when you created your application"}, {"in"=>"query", "name"=>"client_secret", "description"=>"Issued when you created your application"}, {"in"=>"query", "name"=>"code", "description"=>"The `code` param returned via the OAuth callback"}, {"in"=>"query", "name"=>"redirect_uri", "description"=>"This must match the originally submitted URI (if one was sent)"}, {"in"=>"query", "name"=>"single_channel", "description"=>"Request the user to add your app only to a single channel"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "OAuth"]}}, "/files.upload"=>{"post"=>{"summary"=>"Upload File", "description"=>"Uploads or creates a file.", "operationId"=>"files_upload", "x-api-path-slug"=>"files-upload-post", "parameters"=>[{"in"=>"formData", "name"=>"channels", "description"=>"Comma-separated list of channel names or IDs where the file will be shared"}, {"in"=>"formData", "name"=>"content", "description"=>"File contents via a POST variable"}, {"in"=>"formData", "name"=>"file", "description"=>"File contents via `multipart/form-data`"}, {"in"=>"formData", "name"=>"filename", "description"=>"Filename of file"}, {"in"=>"formData", "name"=>"filetype", "description"=>"A [file type](/types/file#file_types) identifier"}, {"in"=>"formData", "name"=>"initial_comment", "description"=>"Initial comment to add to file"}, {"in"=>"formData", "name"=>"title", "description"=>"Title of file"}, {"in"=>"formData", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Files"]}}, "/usergroups.users.list"=>{"get"=>{"summary"=>"List Group Users", "description"=>"List all users in a User Group", "operationId"=>"usergroups_users_list", "x-api-path-slug"=>"usergroups-users-list-get", "parameters"=>[{"in"=>"query", "name"=>"include_disabled", "description"=>"Allow results that involve disabled User Groups"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"usergroup", "description"=>"The encoded ID of the User Group to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/users.info"=>{"get"=>{"summary"=>"Get User Info", "description"=>"Gets information about a user.", "operationId"=>"users_info", "x-api-path-slug"=>"users-info-get", "parameters"=>[{"in"=>"query", "name"=>"include_locale", "description"=>"Set this to `true` to receive the locale for this user"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"user", "description"=>"User to get info on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Users"]}}, "/users.lookupByEmail"=>{"get"=>{"summary"=>"Find User", "description"=>"Find a user with an email address.", "operationId"=>"users_lookupByEmail", "x-api-path-slug"=>"users-lookupbyemail-get", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"An email address belonging to a user in the workspace"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Users"]}}, "/reactions.list"=>{"get"=>{"summary"=>"List Reactions", "description"=>"Lists reactions made by a user.", "operationId"=>"reactions_list", "x-api-path-slug"=>"reactions-list-get", "parameters"=>[{"in"=>"query", "name"=>"count"}, {"in"=>"query", "name"=>"full", "description"=>"If true always return the complete reaction list"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"user", "description"=>"Show reactions made by this user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Reactions"]}}, "/conversations.create"=>{"post"=>{"summary"=>"Create Conversation", "description"=>"Initiates a public or private channel-based conversation", "operationId"=>"conversations_create", "x-api-path-slug"=>"conversations-create-post", "parameters"=>[{"in"=>"formData", "name"=>"is_private", "description"=>"Create a private channel instead of a public one"}, {"in"=>"formData", "name"=>"name", "description"=>"Name of the public or private channel to create"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations"]}}, "/team.billableInfo"=>{"get"=>{"summary"=>"Get Billable Info", "description"=>"Gets billable users information for the current team.", "operationId"=>"team_billableInfo", "x-api-path-slug"=>"team-billableinfo-get", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"user", "description"=>"A user to retrieve the billable information for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Billing"]}}, "/dnd.endDnd"=>{"post"=>{"summary"=>"End Do Not Disturb", "description"=>"Ends the current user's Do Not Disturb session immediately.", "operationId"=>"dnd_endDnd", "x-api-path-slug"=>"dnd-enddnd-post", "parameters"=>[{"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Do Not Disturb"]}}, "/search.all"=>{"get"=>{"summary"=>"Search Real Time Messaging", "description"=>"Searches for messages and files matching a query.", "operationId"=>"search_all", "x-api-path-slug"=>"search-all-get", "parameters"=>[{"in"=>"query", "name"=>"count"}, {"in"=>"query", "name"=>"highlight", "description"=>"Pass a value of `true` to enable query highlight markers (see below)"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"query", "description"=>"Search query"}, {"in"=>"query", "name"=>"sort", "description"=>"Return matches sorted by either `score` or `timestamp`"}, {"in"=>"query", "name"=>"sort_dir", "description"=>"Change sort direction to ascending (`asc`) or descending (`desc`)"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Real Time"]}}, "/files.comments.delete"=>{"post"=>{"summary"=>"Delete File Comments", "description"=>"Deletes an existing comment on a file.", "operationId"=>"files_comments_delete", "x-api-path-slug"=>"files-comments-delete-post", "parameters"=>[{"in"=>"formData", "name"=>"file", "description"=>"File to delete a comment from"}, {"in"=>"formData", "name"=>"id", "description"=>"The comment to delete"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Files", "Comments"]}}, "/auth.revoke"=>{"get"=>{"summary"=>"Revoke Auth", "description"=>"Revokes a token.", "operationId"=>"auth_revoke", "x-api-path-slug"=>"auth-revoke-get", "parameters"=>[{"in"=>"query", "name"=>"test", "description"=>"Setting this parameter to `1` triggers a _testing mode_ where the specified token will not actually be revoked"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Authentication"]}}, "/reactions.add"=>{"post"=>{"summary"=>"Add Reaction", "description"=>"Adds a reaction to an item.", "operationId"=>"reactions_add", "x-api-path-slug"=>"reactions-add-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel where the message to add reaction to was posted"}, {"in"=>"formData", "name"=>"file", "description"=>"File to add reaction to"}, {"in"=>"formData", "name"=>"file_comment", "description"=>"File comment to add reaction to"}, {"in"=>"formData", "name"=>"name", "description"=>"Reaction (emoji) name"}, {"in"=>"formData", "name"=>"timestamp", "description"=>"Timestamp of the message to add reaction to"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Reactions"]}}, "/stars.add"=>{"post"=>{"summary"=>"Star Item", "description"=>"Adds a star to an item.", "operationId"=>"stars_add", "x-api-path-slug"=>"stars-add-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel to add star to, or channel where the message to add star to was posted (used with `timestamp`)"}, {"in"=>"formData", "name"=>"file", "description"=>"File to add star to"}, {"in"=>"formData", "name"=>"file_comment", "description"=>"File comment to add star to"}, {"in"=>"formData", "name"=>"timestamp", "description"=>"Timestamp of the message to add star to"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Stars"]}}, "/reminders.complete"=>{"post"=>{"summary"=>"Mark Reminders Complete", "description"=>"Marks a reminder as complete.", "operationId"=>"reminders_complete", "x-api-path-slug"=>"reminders-complete-post", "parameters"=>[{"in"=>"formData", "name"=>"reminder", "description"=>"The ID of the reminder to be marked as complete"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Reminders"]}}, "/chat.unfurl"=>{"post"=>{"summary"=>"Unfurl Message", "description"=>"Provide custom unfurl behavior for user-posted URLs", "operationId"=>"chat_unfurl", "x-api-path-slug"=>"chat-unfurl-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel ID of the message"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"ts", "description"=>"Timestamp of the message to add unfurl behavior to"}, {"in"=>"formData", "name"=>"unfurls", "description"=>"URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl message attachments"}, {"in"=>"formData", "name"=>"user_auth_message", "description"=>"Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior"}, {"in"=>"formData", "name"=>"user_auth_required", "description"=>"Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain"}, {"in"=>"formData", "name"=>"user_auth_url", "description"=>"Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages"]}}, "/conversations.unarchive"=>{"post"=>{"summary"=>"Unarchve Conversation", "description"=>"Reverses conversation archival.", "operationId"=>"conversations_unarchive", "x-api-path-slug"=>"conversations-unarchive-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"ID of conversation to unarchive"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations", "Archives"]}}, "/groups.info"=>{"get"=>{"summary"=>"Get Group", "description"=>"Gets information about a private channel.", "operationId"=>"groups_info", "x-api-path-slug"=>"groups-info-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"Private channel to get info on"}, {"in"=>"query", "name"=>"include_locale", "description"=>"Set this to `true` to receive the locale for this group"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/files.revokePublicURL"=>{"post"=>{"summary"=>"Revoke Public URL", "description"=>"Revokes public/external sharing access for a file", "operationId"=>"files_revokePublicURL", "x-api-path-slug"=>"files-revokepublicurl-post", "parameters"=>[{"in"=>"formData", "name"=>"file", "description"=>"File to revoke"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Files"]}}, "/conversations.list"=>{"get"=>{"summary"=>"List Conversations", "description"=>"Lists all channels in a Slack team.", "operationId"=>"conversations_list", "x-api-path-slug"=>"conversations-list-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous requests `response_metadata`"}, {"in"=>"query", "name"=>"exclude_archived", "description"=>"Set to `true` to exclude archived channels from the list"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"types", "description"=>"Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations"]}}, "/stars.list"=>{"get"=>{"summary"=>"List Stars", "description"=>"Lists stars for a user.", "operationId"=>"stars_list", "x-api-path-slug"=>"stars-list-get", "parameters"=>[{"in"=>"query", "name"=>"count"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Stars"]}}, "/reactions.get"=>{"get"=>{"summary"=>"Get Reaction", "description"=>"Gets reactions for an item.", "operationId"=>"reactions_get", "x-api-path-slug"=>"reactions-get-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"Channel where the message to get reactions for was posted"}, {"in"=>"query", "name"=>"file", "description"=>"File to get reactions for"}, {"in"=>"query", "name"=>"file_comment", "description"=>"File comment to get reactions for"}, {"in"=>"query", "name"=>"full", "description"=>"If true always return the complete reaction list"}, {"in"=>"query", "name"=>"timestamp", "description"=>"Timestamp of the message to get reactions for"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Reactions"]}}, "/im.history"=>{"get"=>{"summary"=>"Get Messages History", "description"=>"Fetches history of messages and events from direct message channel.", "operationId"=>"im_history", "x-api-path-slug"=>"im-history-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"Direct message channel to fetch history for"}, {"in"=>"query", "name"=>"count", "description"=>"Number of messages to return, between 1 and 1000"}, {"in"=>"query", "name"=>"inclusive", "description"=>"Include messages with latest or oldest timestamp in results"}, {"in"=>"query", "name"=>"latest", "description"=>"End of time range of messages to include in results"}, {"in"=>"query", "name"=>"oldest", "description"=>"Start of time range of messages to include in results"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"unreads", "description"=>"Include `unread_count_display` in the output?"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging"]}}, "/pins.add"=>{"post"=>{"summary"=>"Pin Item", "description"=>"Pins an item to a channel.", "operationId"=>"pins_add", "x-api-path-slug"=>"pins-add-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel to pin the item in"}, {"in"=>"formData", "name"=>"file", "description"=>"File to pin"}, {"in"=>"formData", "name"=>"file_comment", "description"=>"File comment to pin"}, {"in"=>"formData", "name"=>"timestamp", "description"=>"Timestamp of the message to pin"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Pins"]}}, "/channels.leave"=>{"post"=>{"summary"=>"Leave Channel", "description"=>"Leaves a channel.", "operationId"=>"channels_leave", "x-api-path-slug"=>"channels-leave-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel to leave"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Channels"]}}, "/chat.getPermalink"=>{"get"=>{"summary"=>"Get Permalink", "description"=>"Retrieve a permalink URL for a specific extant message", "operationId"=>"chat_getPermalink", "x-api-path-slug"=>"chat-getpermalink-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"The ID of the conversation or channel containing the message"}, {"in"=>"query", "name"=>"message_ts", "description"=>"A messages `ts` value, uniquely identifying it within a channel"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages"]}}, "/channels.rename"=>{"post"=>{"summary"=>"Rename Channel", "description"=>"Renames a channel.", "operationId"=>"channels_rename", "x-api-path-slug"=>"channels-rename-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel to rename"}, {"in"=>"formData", "name"=>"name", "description"=>"New name for channel"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"validate", "description"=>"Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Channels"]}}, "/files.list"=>{"get"=>{"summary"=>"List Files", "description"=>"Lists & filters team files.", "operationId"=>"files_list", "x-api-path-slug"=>"files-list-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"Filter files appearing in a specific channel, indicated by its ID"}, {"in"=>"query", "name"=>"count"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"ts_from", "description"=>"Filter files created after this timestamp (inclusive)"}, {"in"=>"query", "name"=>"ts_to", "description"=>"Filter files created before this timestamp (inclusive)"}, {"in"=>"query", "name"=>"types", "description"=>"Filter files by type:* `all` - All files* `spaces` - Posts* `snippets` - Snippets* `images` - Image files* `gdocs` - Google docs* `zips` - Zip files* `pdfs` - PDF filesYou can pass multiple values in the types argument, like `types=spaces,snippets`"}, {"in"=>"query", "name"=>"user", "description"=>"Filter files created by a single user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Files"]}}, "/mpim.mark"=>{"post"=>{"summary"=>"Mark Multiparty Direct Messages", "description"=>"Sets the read cursor in a multiparty direct message channel.", "operationId"=>"mpim_mark", "x-api-path-slug"=>"mpim-mark-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"multiparty direct message channel to set reading cursor in"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"ts", "description"=>"Timestamp of the most recently seen message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging"]}}, "/usergroups.users.update"=>{"post"=>{"summary"=>"Update Group Users", "description"=>"Update the list of users for a User Group", "operationId"=>"usergroups_users_update", "x-api-path-slug"=>"usergroups-users-update-post", "parameters"=>[{"in"=>"formData", "name"=>"include_count", "description"=>"Include the number of users in the User Group"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"usergroup", "description"=>"The encoded ID of the User Group to update"}, {"in"=>"formData", "name"=>"users", "description"=>"A comma separated string of encoded user IDs that represent the entire list of users for the User Group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/conversations.setTopic"=>{"post"=>{"summary"=>"Set Conversation Topic", "description"=>"Sets the topic for a conversation.", "operationId"=>"conversations_setTopic", "x-api-path-slug"=>"conversations-settopic-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Conversation to set the topic of"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"topic", "description"=>"The new topic string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations"]}}, "/conversations.members"=>{"get"=>{"summary"=>"Get Conversation Members", "description"=>"Retrieve members of a conversation.", "operationId"=>"conversations_members", "x-api-path-slug"=>"conversations-members-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"ID of the conversation to retrieve members for"}, {"in"=>"query", "name"=>"cursor", "description"=>"Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous requests `response_metadata`"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations"]}}, "/conversations.open"=>{"post"=>{"summary"=>"Open Conversation", "description"=>"Opens or resumes a direct message or multi-person direct message.", "operationId"=>"conversations_open", "x-api-path-slug"=>"conversations-open-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Resume a conversation by supplying an `im` or `mpim`s ID"}, {"in"=>"formData", "name"=>"return_im", "description"=>"Boolean, indicates you want the full IM channel definition in the response"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"users", "description"=>"Comma separated lists of users"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations"]}}, "/pins.remove"=>{"post"=>{"summary"=>"Unpin Item", "description"=>"Un-pins an item from a channel.", "operationId"=>"pins_remove", "x-api-path-slug"=>"pins-remove-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel where the item is pinned to"}, {"in"=>"formData", "name"=>"file", "description"=>"File to un-pin"}, {"in"=>"formData", "name"=>"file_comment", "description"=>"File comment to un-pin"}, {"in"=>"formData", "name"=>"timestamp", "description"=>"Timestamp of the message to un-pin"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Pins"]}}, "/files.delete"=>{"post"=>{"summary"=>"Delete File", "description"=>"Deletes a file.", "operationId"=>"files_delete", "x-api-path-slug"=>"files-delete-post", "parameters"=>[{"in"=>"formData", "name"=>"file", "description"=>"ID of file to delete"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Files"]}}, "/pins.list"=>{"get"=>{"summary"=>"List Pins", "description"=>"Lists items pinned to a channel.", "operationId"=>"pins_list", "x-api-path-slug"=>"pins-list-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"Channel to get pinned items for"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Pins"]}}, "/api.test"=>{"get"=>{"summary"=>"Test API", "description"=>"Checks API calling code.", "operationId"=>"api_test", "x-api-path-slug"=>"api-test-get", "parameters"=>[{"in"=>"query", "name"=>"error", "description"=>"Error response to return"}, {"in"=>"query", "name"=>"foo", "description"=>"example property to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging"]}}, "/reminders.list"=>{"get"=>{"summary"=>"List Reminders", "description"=>"Lists all reminders created by or for a given user.", "operationId"=>"reminders_list", "x-api-path-slug"=>"reminders-list-get", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Reminders"]}}, "/users.getPresence"=>{"get"=>{"summary"=>"Get Presence", "description"=>"Gets user presence information.", "operationId"=>"users_getPresence", "x-api-path-slug"=>"users-getpresence-get", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"user", "description"=>"User to get presence info on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Presence"]}}, "/usergroups.update"=>{"post"=>{"summary"=>"Update Group", "description"=>"Update an existing User Group", "operationId"=>"usergroups_update", "x-api-path-slug"=>"usergroups-update-post", "parameters"=>[{"in"=>"formData", "name"=>"channels", "description"=>"A comma separated string of encoded channel IDs for which the User Group uses as a default"}, {"in"=>"formData", "name"=>"description", "description"=>"A short description of the User Group"}, {"in"=>"formData", "name"=>"handle", "description"=>"A mention handle"}, {"in"=>"formData", "name"=>"include_count", "description"=>"Include the number of users in the User Group"}, {"in"=>"formData", "name"=>"name", "description"=>"A name for the User Group"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"usergroup", "description"=>"The encoded ID of the User Group to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/conversations.leave"=>{"post"=>{"summary"=>"Leave Conversation", "description"=>"Leaves a conversation.", "operationId"=>"conversations_leave", "x-api-path-slug"=>"conversations-leave-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Conversation to leave"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations"]}}, "/files.info"=>{"get"=>{"summary"=>"Get File", "description"=>"Gets information about a team file.", "operationId"=>"files_info", "x-api-path-slug"=>"files-info-get", "parameters"=>[{"in"=>"query", "name"=>"count"}, {"in"=>"query", "name"=>"file", "description"=>"Specify a file by providing its ID"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Files"]}}, "/groups.leave"=>{"post"=>{"summary"=>"Leave Group", "description"=>"Leaves a private channel.", "operationId"=>"groups_leave", "x-api-path-slug"=>"groups-leave-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Private channel to leave"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/apps.permissions.info"=>{"get"=>{"summary"=>"App Permissions", "description"=>"Returns list of permissions this app has on a team.", "operationId"=>"apps_permissions_info", "x-api-path-slug"=>"apps-permissions-info-get", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Permissions"]}}, "/usergroups.create"=>{"post"=>{"summary"=>"Create Group", "description"=>"Create a User Group", "operationId"=>"usergroups_create", "x-api-path-slug"=>"usergroups-create-post", "parameters"=>[{"in"=>"formData", "name"=>"channels", "description"=>"A comma separated string of encoded channel IDs for which the User Group uses as a default"}, {"in"=>"formData", "name"=>"description", "description"=>"A short description of the User Group"}, {"in"=>"formData", "name"=>"handle", "description"=>"A mention handle"}, {"in"=>"formData", "name"=>"include_count", "description"=>"Include the number of users in each User Group"}, {"in"=>"formData", "name"=>"name", "description"=>"A name for the User Group"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/groups.createChild"=>{"post"=>{"summary"=>"Create Child Group", "description"=>"Clones and archives a private channel.", "operationId"=>"groups_createChild", "x-api-path-slug"=>"groups-createchild-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Private channel to clone and archive"}, {"in"=>"formData", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups", "archives"]}}, "/channels.mark"=>{"post"=>{"summary"=>"Mark Channel", "description"=>"Sets the read cursor in a channel.", "operationId"=>"channels_mark", "x-api-path-slug"=>"channels-mark-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel to set reading cursor in"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"ts", "description"=>"Timestamp of the most recently seen message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Channels"]}}, "/users.deletePhoto"=>{"post"=>{"summary"=>"Delete Photo", "description"=>"Delete the user profile photo", "operationId"=>"users_deletePhoto", "x-api-path-slug"=>"users-deletephoto-post", "parameters"=>[{"in"=>"formData", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Photos"]}}, "/users.setPhoto"=>{"post"=>{"summary"=>"Set User Profile Photo", "description"=>"Set the user profile photo", "operationId"=>"users_setPhoto", "x-api-path-slug"=>"users-setphoto-post", "parameters"=>[{"in"=>"formData", "name"=>"crop_w", "description"=>"Width/height of crop box (always square)"}, {"in"=>"formData", "name"=>"crop_x", "description"=>"X coordinate of top-left corner of crop box"}, {"in"=>"formData", "name"=>"crop_y", "description"=>"Y coordinate of top-left corner of crop box"}, {"in"=>"formData", "name"=>"image", "description"=>"File contents via `multipart/form-data`"}, {"in"=>"formData", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Users"]}}, "/files.sharedPublicURL"=>{"post"=>{"summary"=>"Share Public URL", "description"=>"Enables a file for public/external sharing.", "operationId"=>"files_sharedPublicURL", "x-api-path-slug"=>"files-sharedpublicurl-post", "parameters"=>[{"in"=>"formData", "name"=>"file", "description"=>"File to share"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Files"]}}, "/conversations.kick"=>{"post"=>{"summary"=>"Remove User From Conversation", "description"=>"Removes a user from a conversation.", "operationId"=>"conversations_kick", "x-api-path-slug"=>"conversations-kick-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"ID of conversation to remove user from"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"user", "description"=>"User ID to be removed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations"]}}, "/chat.postEphemeral"=>{"post"=>{"summary"=>"Sent Ephemeral lMessage", "description"=>"Sends an ephemeral message to a user in a channel.", "operationId"=>"chat_postEphemeral", "x-api-path-slug"=>"chat-postephemeral-post", "parameters"=>[{"in"=>"formData", "name"=>"as_user", "description"=>"Pass true to post the message as the authed bot"}, {"in"=>"formData", "name"=>"attachments", "description"=>"A JSON-based array of structured attachments, presented as a URL-encoded string"}, {"in"=>"formData", "name"=>"channel", "description"=>"Channel, private group, or IM channel to send message to"}, {"in"=>"formData", "name"=>"link_names", "description"=>"Find and link channel names and usernames"}, {"in"=>"formData", "name"=>"parse", "description"=>"Change how messages are treated"}, {"in"=>"formData", "name"=>"text", "description"=>"Text of the message to send"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"user", "description"=>"`id` of the user who will receive the ephemeral message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages"]}}, "/conversations.rename"=>{"post"=>{"summary"=>"Rename Conversation", "description"=>"Renames a conversation.", "operationId"=>"conversations_rename", "x-api-path-slug"=>"conversations-rename-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"ID of conversation to rename"}, {"in"=>"formData", "name"=>"name", "description"=>"New name for conversation"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations"]}}, "/migration.exchange"=>{"get"=>{"summary"=>"Migration Exchange", "description"=>"For Enterprise Grid workspaces, map local user IDs to global user IDs", "operationId"=>"migration_exchange", "x-api-path-slug"=>"migration-exchange-get", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"to_old", "description"=>"Specify `true` to convert `W` global user IDs to workspace-specific `U` IDs"}, {"in"=>"query", "name"=>"users", "description"=>"A comma-separated list of user ids, up to 400 per request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging"]}}, "/usergroups.enable"=>{"post"=>{"summary"=>"Enable Group", "description"=>"Enable a User Group", "operationId"=>"usergroups_enable", "x-api-path-slug"=>"usergroups-enable-post", "parameters"=>[{"in"=>"formData", "name"=>"include_count", "description"=>"Include the number of users in the User Group"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"usergroup", "description"=>"The encoded ID of the User Group to enable"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/dnd.setSnooze"=>{"post"=>{"summary"=>"End Do Not Disturb Snooze", "description"=>"Turns on Do Not Disturb mode for the current user, or changes its duration.", "operationId"=>"dnd_setSnooze", "x-api-path-slug"=>"dnd-setsnooze-post", "parameters"=>[{"in"=>"formData", "name"=>"num_minutes", "description"=>"Number of minutes, from now, to snooze until"}, {"in"=>"formData", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Do Not Disturb"]}}, "/chat.update"=>{"post"=>{"summary"=>"Update Message", "description"=>"Updates a message.", "operationId"=>"chat_update", "x-api-path-slug"=>"chat-update-post", "parameters"=>[{"in"=>"formData", "name"=>"as_user", "description"=>"Pass true to update the message as the authed user"}, {"in"=>"formData", "name"=>"attachments", "description"=>"A JSON-based array of structured attachments, presented as a URL-encoded string"}, {"in"=>"formData", "name"=>"channel", "description"=>"Channel containing the message to be updated"}, {"in"=>"formData", "name"=>"link_names", "description"=>"Find and link channel names and usernames"}, {"in"=>"formData", "name"=>"parse", "description"=>"Change how messages are treated"}, {"in"=>"formData", "name"=>"text", "description"=>"New text for the message, using the [default formatting rules](/docs/formatting)"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"ts", "description"=>"Timestamp of the message to be updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages"]}}, "/mpim.history"=>{"get"=>{"summary"=>"Get Multiparty Direct Message History", "description"=>"Fetches history of messages and events from a multiparty direct message.", "operationId"=>"mpim_history", "x-api-path-slug"=>"mpim-history-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"Multiparty direct message to fetch history for"}, {"in"=>"query", "name"=>"count", "description"=>"Number of messages to return, between 1 and 1000"}, {"in"=>"query", "name"=>"inclusive", "description"=>"Include messages with latest or oldest timestamp in results"}, {"in"=>"query", "name"=>"latest", "description"=>"End of time range of messages to include in results"}, {"in"=>"query", "name"=>"oldest", "description"=>"Start of time range of messages to include in results"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"unreads", "description"=>"Include `unread_count_display` in the output?"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging"]}}, "/apps.permissions.request"=>{"get"=>{"summary"=>"Request App Permissions", "description"=>"Allows an app to request additional scopes", "operationId"=>"apps_permissions_request", "x-api-path-slug"=>"apps-permissions-request-get", "parameters"=>[{"in"=>"query", "name"=>"scopes", "description"=>"A comma separated list of scopes to request for"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"trigger_id", "description"=>"Token used to trigger the permissions API"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Permissions"]}}, "/search.files"=>{"get"=>{"summary"=>"Start Real Time Messaging Files", "description"=>"Searches for files matching a query.", "operationId"=>"search_files", "x-api-path-slug"=>"search-files-get", "parameters"=>[{"in"=>"query", "name"=>"count"}, {"in"=>"query", "name"=>"highlight", "description"=>"Pass a value of `true` to enable query highlight markers (see below)"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"query", "description"=>"Search query"}, {"in"=>"query", "name"=>"sort", "description"=>"Return matches sorted by either `score` or `timestamp`"}, {"in"=>"query", "name"=>"sort_dir", "description"=>"Change sort direction to ascending (`asc`) or descending (`desc`)"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Real Time"]}}, "/users.identity"=>{"get"=>{"summary"=>"Get User Identity", "description"=>"Get a user's identity.", "operationId"=>"users_identity", "x-api-path-slug"=>"users-identity-get", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Users"]}}, "/team.accessLogs"=>{"get"=>{"summary"=>"Get Logs", "description"=>"Gets the access logs for the current team.", "operationId"=>"team_accessLogs", "x-api-path-slug"=>"team-accesslogs-get", "parameters"=>[{"in"=>"query", "name"=>"before", "description"=>"End of time range of logs to include in results (inclusive)"}, {"in"=>"query", "name"=>"count"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Logs"]}}, "/groups.invite"=>{"post"=>{"summary"=>"Invite User To Group", "description"=>"Invites a user to a private channel.", "operationId"=>"groups_invite", "x-api-path-slug"=>"groups-invite-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Private channel to invite user to"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"user", "description"=>"User to invite"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/channels.unarchive"=>{"post"=>{"summary"=>"Unarchive Channel", "description"=>"Unarchives a channel.", "operationId"=>"channels_unarchive", "x-api-path-slug"=>"channels-unarchive-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel to unarchive"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Channels", "Archives"]}}, "/rtm.connect"=>{"get"=>{"summary"=>"Connect Real Time Messaging", "description"=>"Starts a Real Time Messaging session.", "operationId"=>"rtm_connect", "x-api-path-slug"=>"rtm-connect-get", "parameters"=>[{"in"=>"query", "name"=>"batch_presence_aware", "description"=>"Only deliver presence events when requested by subscription"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Real Time"]}}, "/team.info"=>{"get"=>{"summary"=>"Get Team", "description"=>"Gets information about the current team.", "operationId"=>"team_info", "x-api-path-slug"=>"team-info-get", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Teams"]}}, "/conversations.history"=>{"get"=>{"summary"=>"Get Conversation History", "description"=>"Fetches a conversation's history of messages and events.", "operationId"=>"conversations_history", "x-api-path-slug"=>"conversations-history-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"Conversation ID to fetch history for"}, {"in"=>"query", "name"=>"cursor", "description"=>"Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous requests `response_metadata`"}, {"in"=>"query", "name"=>"inclusive", "description"=>"Include messages with latest or oldest timestamp in results only when either timestamp is specified"}, {"in"=>"query", "name"=>"latest", "description"=>"End of time range of messages to include in results"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"oldest", "description"=>"Start of time range of messages to include in results"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations"]}}, "/channels.create"=>{"post"=>{"summary"=>"Create Channel", "description"=>"Creates a channel.", "operationId"=>"channels_create", "x-api-path-slug"=>"channels-create-post", "parameters"=>[{"in"=>"formData", "name"=>"name", "description"=>"Name of channel to create"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"validate", "description"=>"Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Channels"]}}, "/im.replies"=>{"get"=>{"summary"=>"Reply to Messages", "description"=>"Retrieve a thread of messages posted to a direct message conversation", "operationId"=>"im_replies", "x-api-path-slug"=>"im-replies-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"Direct message channel to fetch thread from"}, {"in"=>"query", "name"=>"thread_ts", "description"=>"Unique identifier of a threads parent message"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging"]}}, "/groups.create"=>{"post"=>{"summary"=>"Create Group", "description"=>"Creates a private channel.", "operationId"=>"groups_create", "x-api-path-slug"=>"groups-create-post", "parameters"=>[{"in"=>"formData", "name"=>"name", "description"=>"Name of private channel to create"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"validate", "description"=>"Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/reminders.add"=>{"post"=>{"summary"=>"Add Reminders", "description"=>"Creates a reminder.", "operationId"=>"reminders_add", "x-api-path-slug"=>"reminders-add-post", "parameters"=>[{"in"=>"formData", "name"=>"text", "description"=>"The content of the reminder"}, {"in"=>"formData", "name"=>"time", "description"=>"When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"user", "description"=>"The user who will receive the reminder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Reminders"]}}, "/conversations.setPurpose"=>{"post"=>{"summary"=>"Set Conversation Purpose", "description"=>"Sets the purpose for a conversation.", "operationId"=>"conversations_setPurpose", "x-api-path-slug"=>"conversations-setpurpose-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Conversation to set the purpose of"}, {"in"=>"formData", "name"=>"purpose", "description"=>"A new, specialer purpose"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations"]}}, "/channels.join"=>{"post"=>{"summary"=>"Join Channel", "description"=>"Joins a channel, creating it if needed.", "operationId"=>"channels_join", "x-api-path-slug"=>"channels-join-post", "parameters"=>[{"in"=>"formData", "name"=>"name", "description"=>"Name of channel to join"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"validate", "description"=>"Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Channels"]}}, "/usergroups.list"=>{"get"=>{"summary"=>"List Groups", "description"=>"List all User Groups for a team", "operationId"=>"usergroups_list", "x-api-path-slug"=>"usergroups-list-get", "parameters"=>[{"in"=>"query", "name"=>"include_count", "description"=>"Include the number of users in each User Group"}, {"in"=>"query", "name"=>"include_disabled", "description"=>"Include disabled User Groups"}, {"in"=>"query", "name"=>"include_users", "description"=>"Include the list of users for each User Group"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/users.profile.get"=>{"get"=>{"summary"=>"Get User Profile", "description"=>"Retrieves a user's profile information.", "operationId"=>"users_profile_get", "x-api-path-slug"=>"users-profile-get-get", "parameters"=>[{"in"=>"query", "name"=>"include_labels", "description"=>"Include labels for each ID in custom profile fields"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"user", "description"=>"User to retrieve profile info for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Users"]}}, "/groups.open"=>{"post"=>{"summary"=>"Open Group", "description"=>"Opens a private channel.", "operationId"=>"groups_open", "x-api-path-slug"=>"groups-open-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Private channel to open"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/emoji.list"=>{"get"=>{"summary"=>"List Emojis", "description"=>"Lists custom emoji for a team.", "operationId"=>"emoji_list", "x-api-path-slug"=>"emoji-list-get", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Emoji"]}}, "/conversations.info"=>{"get"=>{"summary"=>"Get Conversation", "description"=>"Retrieve information about a conversation.", "operationId"=>"conversations_info", "x-api-path-slug"=>"conversations-info-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"Conversation ID to learn more about"}, {"in"=>"query", "name"=>"include_locale", "description"=>"Set this to `true` to receive the locale for this conversation"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations"]}}, "/chat.meMessage"=>{"post"=>{"summary"=>"Share Message", "description"=>"Share a me message into a channel.", "operationId"=>"chat_meMessage", "x-api-path-slug"=>"chat-memessage-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel to send message to"}, {"in"=>"formData", "name"=>"text", "description"=>"Text of the message to send"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages"]}}, "/dnd.endSnooze"=>{"post"=>{"summary"=>"End Do Not Disturb Snooze", "description"=>"Ends the current user's snooze mode immediately.", "operationId"=>"dnd_endSnooze", "x-api-path-slug"=>"dnd-endsnooze-post", "parameters"=>[{"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Do Not Disturb"]}}, "/groups.history"=>{"get"=>{"summary"=>"Group History", "description"=>"Fetches history of messages and events from a private channel.", "operationId"=>"groups_history", "x-api-path-slug"=>"groups-history-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"Private channel to fetch history for"}, {"in"=>"query", "name"=>"count", "description"=>"Number of messages to return, between 1 and 1000"}, {"in"=>"query", "name"=>"inclusive", "description"=>"Include messages with latest or oldest timestamp in results"}, {"in"=>"query", "name"=>"latest", "description"=>"End of time range of messages to include in results"}, {"in"=>"query", "name"=>"oldest", "description"=>"Start of time range of messages to include in results"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"unreads", "description"=>"Include `unread_count_display` in the output?"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/search.messages"=>{"get"=>{"summary"=>"Search Real Time Messaging", "description"=>"Searches for messages matching a query.", "operationId"=>"search_messages", "x-api-path-slug"=>"search-messages-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Pass the number of results you want per page"}, {"in"=>"query", "name"=>"highlight", "description"=>"Pass a value of `true` to enable query highlight markers (see below)"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"query", "description"=>"Search query"}, {"in"=>"query", "name"=>"sort", "description"=>"Return matches sorted by either `score` or `timestamp`"}, {"in"=>"query", "name"=>"sort_dir", "description"=>"Change sort direction to ascending (`asc`) or descending (`desc`)"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Real Time"]}}, "/rtm.start"=>{"get"=>{"summary"=>"Start Real Time Messaging", "description"=>"Starts a Real Time Messaging session.", "operationId"=>"rtm_start", "x-api-path-slug"=>"rtm-start-get", "parameters"=>[{"in"=>"query", "name"=>"batch_presence_aware", "description"=>"Only deliver presence events when requested by subscription"}, {"in"=>"query", "name"=>"include_locale", "description"=>"Set this to `true` to receive the locale for users and channels"}, {"in"=>"query", "name"=>"mpim_aware", "description"=>"Returns MPIMs to the client in the API response"}, {"in"=>"query", "name"=>"no_latest", "description"=>"Exclude latest timestamps for channels, groups, mpims, and ims"}, {"in"=>"query", "name"=>"no_unreads", "description"=>"Skip unread counts for each channel (improves performance)"}, {"in"=>"query", "name"=>"simple_latest", "description"=>"Return timestamp only for latest message object of each channel (improves performance)"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Real Time"]}}, "/channels.setTopic"=>{"post"=>{"summary"=>"Set Channel Topic", "description"=>"Sets the topic for a channel.", "operationId"=>"channels_setTopic", "x-api-path-slug"=>"channels-settopic-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel to set the topic of"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"topic", "description"=>"The new topic"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Channels"]}}, "/groups.setTopic"=>{"post"=>{"summary"=>"Set Group Topic", "description"=>"Sets the topic for a private channel.", "operationId"=>"groups_setTopic", "x-api-path-slug"=>"groups-settopic-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Private channel to set the topic of"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"topic", "description"=>"The new topic"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/mpim.open"=>{"post"=>{"summary"=>"Open Multiparty Direct Messages", "description"=>"This method opens a multiparty direct message.", "operationId"=>"mpim_open", "x-api-path-slug"=>"mpim-open-post", "parameters"=>[{"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"users", "description"=>"Comma separated lists of users"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging"]}}, "/reactions.remove"=>{"post"=>{"summary"=>"Remove Reaction", "description"=>"Removes a reaction from an item.", "operationId"=>"reactions_remove", "x-api-path-slug"=>"reactions-remove-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel where the message to remove reaction from was posted"}, {"in"=>"formData", "name"=>"file", "description"=>"File to remove reaction from"}, {"in"=>"formData", "name"=>"file_comment", "description"=>"File comment to remove reaction from"}, {"in"=>"formData", "name"=>"name", "description"=>"Reaction (emoji) name"}, {"in"=>"formData", "name"=>"timestamp", "description"=>"Timestamp of the message to remove reaction from"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Reactions"]}}, "/reminders.delete"=>{"post"=>{"summary"=>"Delete Reminders", "description"=>"Deletes a reminder.", "operationId"=>"reminders_delete", "x-api-path-slug"=>"reminders-delete-post", "parameters"=>[{"in"=>"formData", "name"=>"reminder", "description"=>"The ID of the reminder"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Reminders"]}}, "/usergroups.disable"=>{"post"=>{"summary"=>"Disable Group", "description"=>"Disable an existing User Group", "operationId"=>"usergroups_disable", "x-api-path-slug"=>"usergroups-disable-post", "parameters"=>[{"in"=>"formData", "name"=>"include_count", "description"=>"Include the number of users in the User Group"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"usergroup", "description"=>"The encoded ID of the User Group to disable"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/files.comments.add"=>{"post"=>{"summary"=>"Add File Comments", "description"=>"Add a comment to an existing file.", "operationId"=>"files_comments_add", "x-api-path-slug"=>"files-comments-add-post", "parameters"=>[{"in"=>"formData", "name"=>"comment", "description"=>"Text of the comment to add"}, {"in"=>"formData", "name"=>"file", "description"=>"File to add a comment to"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Files", "Comments"]}}, "/im.list"=>{"get"=>{"summary"=>"List Messages", "description"=>"Lists direct message channels for the calling user.", "operationId"=>"im_list", "x-api-path-slug"=>"im-list-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous requests `response_metadata`"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging"]}}, "/channels.setPurpose"=>{"post"=>{"summary"=>"Set Channel Purpose", "description"=>"Sets the purpose for a channel.", "operationId"=>"channels_setPurpose", "x-api-path-slug"=>"channels-setpurpose-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel to set the purpose of"}, {"in"=>"formData", "name"=>"purpose", "description"=>"The new purpose"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Channels"]}}, "/mpim.replies"=>{"get"=>{"summary"=>"Reply to Multiparty Direct Messages", "description"=>"Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message.", "operationId"=>"mpim_replies", "x-api-path-slug"=>"mpim-replies-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"Multiparty direct message channel to fetch thread from"}, {"in"=>"query", "name"=>"thread_ts", "description"=>"Unique identifier of a threads parent message"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging"]}}, "/dialog.open"=>{"get"=>{"summary"=>"Open Dialog", "description"=>"Open a dialog with a user", "operationId"=>"dialog_open", "x-api-path-slug"=>"dialog-open-get", "parameters"=>[{"in"=>"query", "name"=>"dialog", "description"=>"The dialog definition"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"trigger_id", "description"=>"Exchange a trigger to post to the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations"]}}, "/dnd.teamInfo"=>{"get"=>{"summary"=>"Get Do Not Disturb Status", "description"=>"Retrieves the Do Not Disturb status for users on a team.", "operationId"=>"dnd_teamInfo", "x-api-path-slug"=>"dnd-teaminfo-get", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"users", "description"=>"Comma-separated list of users to fetch Do Not Disturb status for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Do Not Disturb"]}}, "/users.list"=>{"get"=>{"summary"=>"List Team Users", "description"=>"Lists all users in a Slack team.", "operationId"=>"users_list", "x-api-path-slug"=>"users-list-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous requests `response_metadata`"}, {"in"=>"query", "name"=>"include_locale", "description"=>"Set this to `true` to receive the locale for users"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"presence", "description"=>"Whether to include presence data in the output"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Users"]}}, "/conversations.invite"=>{"post"=>{"summary"=>"Invite User To Conversation", "description"=>"Invites users to a channel.", "operationId"=>"conversations_invite", "x-api-path-slug"=>"conversations-invite-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"The ID of the public or private channel to invite user(s) to"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"users", "description"=>"A comma separated list of user IDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations"]}}, "/auth.test"=>{"get"=>{"summary"=>"Test Auth", "description"=>"Checks authentication & identity.", "operationId"=>"auth_test", "x-api-path-slug"=>"auth-test-get", "parameters"=>[{"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Authentication"]}}, "/channels.list"=>{"get"=>{"summary"=>"List Channels", "description"=>"Lists all channels in a Slack team.", "operationId"=>"channels_list", "x-api-path-slug"=>"channels-list-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous requests `response_metadata`"}, {"in"=>"query", "name"=>"exclude_archived", "description"=>"Exclude archived channels from the list"}, {"in"=>"query", "name"=>"exclude_members", "description"=>"Exclude the `members` collection from each `channel`"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Channels"]}}, "/groups.setPurpose"=>{"post"=>{"summary"=>"Set Group Purpose", "description"=>"Sets the purpose for a private channel.", "operationId"=>"groups_setPurpose", "x-api-path-slug"=>"groups-setpurpose-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Private channel to set the purpose of"}, {"in"=>"formData", "name"=>"purpose", "description"=>"The new purpose"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups"]}}, "/channels.invite"=>{"post"=>{"summary"=>"Invite Channel User", "description"=>"Invites a user to a channel.", "operationId"=>"channels_invite", "x-api-path-slug"=>"channels-invite-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel to invite user to"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"user", "description"=>"User to invite to channel"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Channels"]}}, "/oauth.access"=>{"get"=>{"summary"=>"Oauth Access", "description"=>"Exchanges a temporary OAuth code for an API token.", "operationId"=>"oauth_access", "x-api-path-slug"=>"oauth-access-get", "parameters"=>[{"in"=>"query", "name"=>"client_id", "description"=>"Issued when you created your application"}, {"in"=>"query", "name"=>"client_secret", "description"=>"Issued when you created your application"}, {"in"=>"query", "name"=>"code", "description"=>"The `code` param returned via the OAuth callback"}, {"in"=>"query", "name"=>"redirect_uri", "description"=>"This must match the originally submitted URI (if one was sent)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "OAuth"]}}, "/mpim.list"=>{"get"=>{"summary"=>"List Multiparty Direct Messages", "description"=>"Lists multiparty direct message channels for the calling user.", "operationId"=>"mpim_list", "x-api-path-slug"=>"mpim-list-get", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging"]}}, "/groups.unarchive"=>{"post"=>{"summary"=>"Unarchive Group", "description"=>"Unarchives a private channel.", "operationId"=>"groups_unarchive", "x-api-path-slug"=>"groups-unarchive-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Private channel to unarchive"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups", "Archives"]}}, "/channels.replies"=>{"get"=>{"summary"=>"Get Channel Thread", "description"=>"Retrieve a thread of messages posted to a channel", "operationId"=>"channels_replies", "x-api-path-slug"=>"channels-replies-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"Channel to fetch thread from"}, {"in"=>"query", "name"=>"thread_ts", "description"=>"Unique identifier of a threads parent message"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Channels"]}}, "/chat.postMessage"=>{"post"=>{"summary"=>"Send Channel Message", "description"=>"Sends a message to a channel.", "operationId"=>"chat_postMessage", "x-api-path-slug"=>"chat-postmessage-post", "parameters"=>[{"in"=>"formData", "name"=>"as_user", "description"=>"Pass true to post the message as the authed user, instead of as a bot"}, {"in"=>"formData", "name"=>"attachments", "description"=>"A JSON-based array of structured attachments, presented as a URL-encoded string"}, {"in"=>"formData", "name"=>"channel", "description"=>"Channel, private group, or IM channel to send message to"}, {"in"=>"formData", "name"=>"icon_emoji", "description"=>"Emoji to use as the icon for this message"}, {"in"=>"formData", "name"=>"icon_url", "description"=>"URL to an image to use as the icon for this message"}, {"in"=>"formData", "name"=>"link_names", "description"=>"Find and link channel names and usernames"}, {"in"=>"formData", "name"=>"parse", "description"=>"Change how messages are treated"}, {"in"=>"formData", "name"=>"reply_broadcast", "description"=>"Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation"}, {"in"=>"formData", "name"=>"text", "description"=>"Text of the message to send"}, {"in"=>"formData", "name"=>"thread_ts", "description"=>"Provide another messages `ts` value to make this message a reply"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"formData", "name"=>"unfurl_links", "description"=>"Pass true to enable unfurling of primarily text-based content"}, {"in"=>"formData", "name"=>"unfurl_media", "description"=>"Pass false to disable unfurling of media content"}, {"in"=>"formData", "name"=>"username", "description"=>"Set your bots user name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages"]}}, "/users.setActive"=>{"post"=>{"summary"=>"Make User Inactive", "description"=>"Marks a user as active.", "operationId"=>"users_setActive", "x-api-path-slug"=>"users-setactive-post", "parameters"=>[{"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Users"]}}, "/conversations.archive"=>{"post"=>{"summary"=>"Archive Conversation", "description"=>"Archives a conversation.", "operationId"=>"conversations_archive", "x-api-path-slug"=>"conversations-archive-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"ID of conversation to archive"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations", "Archives"]}}, "/team.profile.get"=>{"get"=>{"summary"=>"Get Team Profile", "description"=>"Retrieve a team's profile.", "operationId"=>"team_profile_get", "x-api-path-slug"=>"team-profile-get-get", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"visibility", "description"=>"Filter by visibility"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Teams"]}}, "/groups.archive"=>{"post"=>{"summary"=>"Archive Group", "description"=>"Archives a private channel.", "operationId"=>"groups_archive", "x-api-path-slug"=>"groups-archive-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Private channel to archive"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Groups", "Archives"]}}, "/conversations.replies"=>{"get"=>{"summary"=>"Reply Conversation", "description"=>"Retrieve a thread of messages posted to a conversation", "operationId"=>"conversations_replies", "x-api-path-slug"=>"conversations-replies-get", "parameters"=>[{"in"=>"query", "name"=>"channel", "description"=>"Conversation ID to fetch thread from"}, {"in"=>"query", "name"=>"cursor", "description"=>"Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous requests `response_metadata`"}, {"in"=>"query", "name"=>"inclusive", "description"=>"Include messages with latest or oldest timestamp in results only when either timestamp is specified"}, {"in"=>"query", "name"=>"latest", "description"=>"End of time range of messages to include in results"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of items to return"}, {"in"=>"query", "name"=>"oldest", "description"=>"Start of time range of messages to include in results"}, {"in"=>"query", "name"=>"token", "description"=>"Authentication token"}, {"in"=>"query", "name"=>"ts", "description"=>"Unique identifier of a threads parent message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Conversations"]}}, "/stars.remove"=>{"post"=>{"summary"=>"Remove Star from Item", "description"=>"Removes a star from an item.", "operationId"=>"stars_remove", "x-api-path-slug"=>"stars-remove-post", "parameters"=>[{"in"=>"formData", "name"=>"channel", "description"=>"Channel to remove star from, or channel where the message to remove star from was posted (used with `timestamp`)"}, {"in"=>"formData", "name"=>"file", "description"=>"File to remove star from"}, {"in"=>"formData", "name"=>"file_comment", "description"=>"File comment to remove star from"}, {"in"=>"formData", "name"=>"timestamp", "description"=>"Timestamp of the message to remove star from"}, {"in"=>"header", "name"=>"token", "description"=>"Authentication token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Stars"]}}}}, "apis"=>{"name"=>"Slack", "x-slug"=>"slack", "description"=>"Slack is a team communication application providing services such as real-time messaging, archiving, and to search for modern teams. It offers one-on-one messaging, private groups, persistent chat rooms, and direct messaging as well as group chats organized by topic. All content inside Slack is searchable from one search box and it integrates with a number of third-party services, including Google Docs, Dropbox, Heroku, Crashlytics, GitHub, and Zendesk.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/slack-logo.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"Change Log Example,Chats,Collaboration,Communications,Getting Started Example,Imports,Indie EdTech Data Jam,Media,Messages,Messages,My API Stack,New,Relative Data,Service API,Stack,Stack Network,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"slack/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Slack", "x-api-slug"=>"slack", "description"=>"Slack is a team communication application providing services such as real-time messaging, archiving, and to search for modern teams. It offers one-on-one messaging, private groups, persistent chat rooms, and direct messaging as well as group chats organized by topic. All content inside Slack is searchable from one search box and it integrates with a number of third-party services, including Google Docs, Dropbox, Heroku, Crashlytics, GitHub, and Zendesk.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/slack-logo.png", "humanURL"=>"https://api.slack.com", "baseURL"=>"https://slack.com//api", "tags"=>"Change Log Example,Chats,Collaboration,Communications,Getting Started Example,Imports,Indie EdTech Data Jam,Media,Messages,Messages,My API Stack,New,Relative Data,Service API,Stack,Stack Network,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/slack/stars-remove-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/slack/slack-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://api.slack.com"}, {"type"=>"x-application-gallery", "url"=>"https://slack.com/apps"}, {"type"=>"x-blog", "url"=>"http://slackhq.com/"}, {"type"=>"x-blog", "url"=>"https://medium.com/slack-developer-blog"}, {"type"=>"x-blog-rss", "url"=>"http://slackhq.com/rss"}, {"type"=>"x-blog-rss", "url"=>"https://medium.com/feed/slack-developer-blog"}, {"type"=>"x-branding", "url"=>"https://slack.com/brand-guidelines"}, {"type"=>"x-buttons", "url"=>"https://api.slack.com/docs/slack-button"}, {"type"=>"x-c-sharp-sdk", "url"=>"https://api.slack.com/web"}, {"type"=>"x-change-log", "url"=>"https://api.slack.com/changelog"}, {"type"=>"x-developer", "url"=>"https://api.slack.com/"}, {"type"=>"x-faq", "url"=>"https://api.slack.com/faq"}, {"type"=>"x-getting-started", "url"=>"https://slack.com/getting-started"}, {"type"=>"x-github", "url"=>"https://github.com/slackhq"}, {"type"=>"x-incoming-webhooks", "url"=>"https://api.slack.com/incoming-webhooks"}, {"type"=>"x-oauth-overview", "url"=>"https://api.slack.com/docs/oauth"}, {"type"=>"x-oauth-scopes", "url"=>"https://api.slack.com/docs/oauth-scopes"}, {"type"=>"x-outgoing-webhooks", "url"=>"https://api.slack.com/outgoing-webhooks"}, {"type"=>"x-presence", "url"=>"https://api.slack.com/docs/presence"}, {"type"=>"x-pricing", "url"=>"https://slack.com/pricing"}, {"type"=>"x-privacy", "url"=>"https://slack.com/privacy-policy"}, {"type"=>"x-rate-limits", "url"=>"https://api.slack.com/docs/rate-limits"}, {"type"=>"x-real-time-messaging-api", "url"=>"https://api.slack.com/rtm"}, {"type"=>"x-road-map", "url"=>"https://api.slack.com/roadmap"}, {"type"=>"x-security", "url"=>"https://slack.com/security"}, {"type"=>"x-status", "url"=>"https://status.slack.com/"}, {"type"=>"x-support", "url"=>"https://get.slack.help/hc/en-us"}, {"type"=>"x-terms-of-service", "url"=>"https://slack.com/terms-of-service"}, {"type"=>"x-transparency-report", "url"=>"https://slack.com/transparency-report"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/slackapi"}, {"type"=>"x-website", "url"=>"http://slack.com"}, {"type"=>"x-website", "url"=>"https://slack.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
authentiq-connect{"authentiq-connect-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Authentiq Connect", "x-complete"=>1, "info"=>{"title"=>"Authentiq Connect", "description"=>"authentiq-connect-oauth-2-0-and-openid-connect-api-reference-learn-about-authentiq-idhttpswww-authentiq-com-or-check-out-the-authentiq-connecthttpsdevelopers-authentiq-com-developer-documentation-", "termsOfService"=>"https://www.authentiq.com/tos/", "contact"=>{"name"=>"Team Authentiq", "url"=>"https://www.authentiq.com/", "email"=>"hello@authentiq.com"}, "version"=>"1.0"}, "host"=>"connect.authentiq.io", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/authorize"=>{"get"=>{"summary"=>"Authenticate a user", "description"=>"Start a session with Authentiq Connect and authenticate a user.\n\nExample:\n\n```\nGET https://connect.authentiq.io/authorize?client_id= |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
lloyds-bank{"lloyds-bank-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Lloyds Bank", "x-complete"=>1, "info"=>{"title"=>"Lloyds Bank", "description"=>"this-is-an-openapi-definition-for-the-standard-set-of-open-banking-httpopenbankingapis-io-apis-from-lloyds-ban-", "termsOfService"=>"https://www.openbanking.org.uk/open-licence/", "contact"=>{"name"=>"API Evangelist", "url"=>"https://apievangelist.com", "email"=>"info@apievangelist.com"}, "version"=>"1.0.0"}, "host"=>"api.lloydsbank.com", "basePath"=>"open-banking/v2.1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"atms/"=>{"get"=>{"summary"=>"Get ATMs", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can provide multiple ATMs.", "operationId"=>"getATMS", "x-api-path-slug"=>"atms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Atms"]}}, "branches/"=>{"get"=>{"summary"=>"Get Branches", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple branches.", "operationId"=>"getBranches", "x-api-path-slug"=>"branches-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branches"]}}, "personal-current-accounts/"=>{"get"=>{"summary"=>"Get Current Personal Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple PCA products.", "operationId"=>"getCurrentPersonalAccounts", "x-api-path-slug"=>"personalcurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Personal", "Current", "Accounts"]}}, "business-current-accounts/"=>{"get"=>{"summary"=>"Get Current Business Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple BCA products.", "operationId"=>"getCurentBusinessAccounts", "x-api-path-slug"=>"businesscurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Business", "Current", "Accounts"]}}, "unsecured-sme-loans/"=>{"get"=>{"summary"=>"Get Unsecured SME Loans", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Unsecured Loan products.", "operationId"=>"pathOperation", "x-api-path-slug"=>"unsecuredsmeloans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsecured", "Sme", "Loans"]}}, "commercial-credit-cards/"=>{"get"=>{"summary"=>"Get Commercial Credit Cards", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Commercial Credit Card products.", "operationId"=>"getCommercialCreditCards", "x-api-path-slug"=>"commercialcreditcards-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commercial", "Credit", "Cards"]}}}}, "apis"=>{"name"=>"Lloyds Bank", "x-slug"=>"lloyds-bank", "description"=>"Lloyds Bank plc is a British retail and commercial bank with branches across England and Wales. It has traditionally been considered one of the Big Four clearing banks. The bank was founded in Birmingham in 1765. It expanded during the nineteenth and twentieth centuries and took over a number of smaller banking companies. In 1995 it merged with the Trustee Savings Bank and traded as Lloyds TSB Bank plc between 1999 and 2013.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/lloyds_bank.png", "x-kinRank"=>"7", "x-alexaRank"=>"4007", "tags"=>"API Provider,Banking,Financial Services,General Data,Profiles,Relative Data,UK Banks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"lloyds-bank/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Lloyds Bank", "x-api-slug"=>"lloyds-bank", "description"=>"Lloyds Bank plc is a British retail and commercial bank with branches across England and Wales. It has traditionally been considered one of the Big Four clearing banks. The bank was founded in Birmingham in 1765. It expanded during the nineteenth and twentieth centuries and took over a number of smaller banking companies. In 1995 it merged with the Trustee Savings Bank and traded as Lloyds TSB Bank plc between 1999 and 2013.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/lloyds_bank.png", "humanURL"=>"https://lloydsbank.com", "baseURL"=>"https://api.lloydsbank.com/open-banking/v2.1/", "tags"=>"API Provider,Banking,Financial Services,General Data,Profiles,Relative Data,UK Banks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/lloyds-bank/commercialcreditcards-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/lloyds-bank/lloyds-bank-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/lloyds-tsb-group"}, {"type"=>"x-developer", "url"=>"https://developer.lloydsbank.com/"}, {"type"=>"x-documentation", "url"=>"https://developer.lloydsbank.com/opendata-v2"}, {"type"=>"x-support", "url"=>"https://developer.lloydsbank.com/faq-page"}, {"type"=>"x-terms-of-service", "url"=>"https://developer.lloydsbank.com/terms"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/AskLloydsTSB"}, {"type"=>"x-website", "url"=>"https://lloydsbank.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-apps-script-execution{"google-apps-script-execution-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Apps Script Execution", "x-complete"=>1, "info"=>{"title"=>"Google Apps Script Execution", "description"=>"executes-google-apps-script-projects-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"script.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/scripts/{scriptId}:run"=>{"post"=>{"summary"=>"Run Script", "description"=>"Runs a function in an Apps Script project. The project must be deployed\nfor use with the Apps Script Execution API.\n\nThis method requires authorization with an OAuth 2.0 token that includes at\nleast one of the scopes listed in the [Authorization](#authorization)\nsection; script projects that do not require authorization cannot be\nexecuted through this API. To find the correct scopes to include in the\nauthentication token, open the project in the script editor, then select\n**File > Project properties** and click the **Scopes** tab.", "operationId"=>"script.scripts.run", "x-api-path-slug"=>"v1scriptsscriptidrun-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"scriptId", "description"=>"The project key of the script to be executed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Script"]}}}}, "apis"=>{"name"=>"Google Apps Script Execution", "x-slug"=>"google-apps-script-execution", "description"=>"Runs a function in an Apps Script project. The project must be deployed for use with the Apps Script Execution API. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the Authorization section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the project in the script editor, then select File > Project properties and click the Scopes tab.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-apps-scripts-services.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Scripts,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-apps-script-execution/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Apps Script Execution API", "x-api-slug"=>"google-apps-script-execution-api", "description"=>"Runs a function in an Apps Script project. The project must be deployed for use with the Apps Script Execution API. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the Authorization section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the project in the script editor, then select File > Project properties and click the Scopes tab.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-apps-scripts-services.png", "humanURL"=>"https://developers.google.com/apps-script/execution/rest/v1/scripts/run", "baseURL"=>"://script.googleapis.com//", "tags"=>"API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Scripts,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-apps-script-execution/google-apps-script-execution-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-best-practices", "url"=>"https://developers.google.com/apps-script/best_practices"}, {"type"=>"x-case-studies", "url"=>"https://developers.google.com/apps-script/case-studies"}, {"type"=>"x-getting-started", "url"=>"https://developers.google.com/apps-script/overview"}, {"type"=>"x-glossary", "url"=>"https://developers.google.com/apps-script/glossary"}, {"type"=>"x-issues", "url"=>"https://code.google.com/p/google-apps-script-issues/issues/list"}, {"type"=>"x-status-dashboard", "url"=>"https://script.google.com/dashboard"}, {"type"=>"x-support", "url"=>"https://developers.google.com/apps-script/support"}, {"type"=>"x-terms-of-service", "url"=>"https://developers.google.com/apps-script/terms"}, {"type"=>"x-website", "url"=>"https://developers.google.com/apps-script/execution/rest/v1/scripts/run"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
mattermost{"mattermost-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Mattermost", "x-complete"=>1, "info"=>{"title"=>"Mattermost API Reference", "description"=>"-api-v4-is-stable-with-the-mattermost-server-4-0-release--api-v3-was-deprecated-on-january-16th-2018-and-scheduled-for-removal-in-mattermost-v5-0--details-heretagapiv3deprecation--looking-for-the-api-v3-reference-it-has-moved-herehttpsapi-mattermost-comv3-", "termsOfService"=>"https://about.mattermost.com/default-terms/", "version"=>"4.0.0"}, "host"=>"your-mattermost-url.com", "basePath"=>"/api/v4", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/users"=>{"post"=>{"summary"=>"Create a user", "description"=>"Create a new user on the system.\n##### Permissions\nNo permission required but user creation can be controlled by server configuration.", "operationId"=>"create-a-new-user-on-the-system-permissionsno-permission-required-but-user-creation-can-be-controlle", "x-api-path-slug"=>"users-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"User object to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "get"=>{"summary"=>"Get users", "description"=>"Get a page of a list of users. Based on query string parameters, select users from a team, channel, or select users not in a specific channel.\n\nSince server version 4.0, some basic sorting is available using the `sort` query parameter. Sorting is currently only supported when selecting users on a team.\n##### Permissions\nRequires an active session and (if specified) membership to the channel or team being selected from.", "operationId"=>"get-a-page-of-a-list-of-users-based-on-query-string-parameters-select-users-from-a-team-channel-or-s", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"query", "name"=>"in_channel", "description"=>"The ID of the channel to get users for"}, {"in"=>"query", "name"=>"in_team", "description"=>"The ID of the team to get users for"}, {"in"=>"query", "name"=>"not_in_channel", "description"=>"The ID of the channel to exclude users for"}, {"in"=>"query", "name"=>"not_in_team", "description"=>"The ID of the team to exclude users for"}, {"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of users per page"}, {"in"=>"query", "name"=>"sort", "description"=>"Sort is only available in conjunction with certain options below"}, {"in"=>"query", "name"=>"without_team", "description"=>"Whether or not to list users that are not on any team"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/ids"=>{"post"=>{"summary"=>"Get users by ids", "description"=>"Get a list of users based on a provided list of user ids.\n##### Permissions\nRequires an active session but no other permissions.", "operationId"=>"get-a-list-of-users-based-on-a-provided-list-of-user-ids-permissionsrequires-an-active-session-but-n", "x-api-path-slug"=>"usersids-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"List of user ids", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "By", "Ids"]}}, "/users/usernames"=>{"post"=>{"summary"=>"Get users by usernames", "description"=>"Get a list of users based on a provided list of usernames.\n##### Permissions\nRequires an active session but no other permissions.", "operationId"=>"get-a-list-of-users-based-on-a-provided-list-of-usernames-permissionsrequires-an-active-session-but-", "x-api-path-slug"=>"usersusernames-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"List of usernames", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "By", "Usernames"]}}, "/users/search"=>{"post"=>{"summary"=>"Search users", "description"=>"Get a list of users based on search criteria provided in the request body. Searches are typically done against username, full name, nickname and email unless otherwise configured by the server.\n##### Permissions\nRequires an active session and `read_channel` and/or `view_team` permissions for any channels or teams specified in the request body.", "operationId"=>"get-a-list-of-users-based-on-search-criteria-provided-in-the-request-body-searches-are-typically-don", "x-api-path-slug"=>"userssearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Search criteria", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Users"]}}, "/users/autocomplete"=>{"get"=>{"summary"=>"Autocomplete users", "description"=>"Get a list of users for the purpose of autocompleting based on the provided search term. Specify a combination of `team_id` and `channel_id` to filter results further.\n##### Permissions\nRequires an active session and `view_team` and `read_channel` on any teams or channels used to filter the results further.", "operationId"=>"get-a-list-of-users-for-the-purpose-of-autocompleting-based-on-the-provided-search-term-specify-a-co", "x-api-path-slug"=>"usersautocomplete-get", "parameters"=>[{"in"=>"query", "name"=>"channel_id", "description"=>"Channel ID"}, {"in"=>"query", "name"=>"name", "description"=>"Username, nickname first name or last name"}, {"in"=>"query", "name"=>"team_id", "description"=>"Team ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autocomplete", "Users"]}}, "/users/{user_id}"=>{"get"=>{"summary"=>"Get a user", "description"=>"Get a user a object. Sensitive information will be sanitized out.\n##### Permissions\nRequires an active session but no other permissions.", "operationId"=>"get-a-user-a-object-sensitive-information-will-be-sanitized-out-permissionsrequires-an-active-sessio", "x-api-path-slug"=>"usersuser-id-get", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "put"=>{"summary"=>"Update a user", "description"=>"Update a user by providing the user object. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.", "operationId"=>"update-a-user-by-providing-the-user-object-the-fields-that-can-be-updated-are-defined-in-the-request", "x-api-path-slug"=>"usersuser-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"User object that is to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "delete"=>{"summary"=>"Deactivate a user account.", "description"=>"Deactivates the user by archiving its user object.\n##### Permissions\nMust be logged in as the user being deactivated or have the `edit_other_users` permission.", "operationId"=>"deactivates-the-user-by-archiving-its-user-object-permissionsmust-be-logged-in-as-the-user-being-dea", "x-api-path-slug"=>"usersuser-id-delete", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deactivate", "User", "Account."]}}, "/users/{user_id}/patch"=>{"put"=>{"summary"=>"Patch a user", "description"=>"Partially update a user by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.", "operationId"=>"partially-update-a-user-by-providing-only-the-fields-you-want-to-update-omitted-fields-will-not-be-u", "x-api-path-slug"=>"usersuser-idpatch-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"User object that is to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/users/{user_id}/roles"=>{"put"=>{"summary"=>"Update a user's roles", "description"=>"Update a user's system-level roles. Valid user roles are \"system_user\", \"system_admin\" or both of them. Overwrites any previously assigned system-level roles.\n##### Permissions\nMust have the `manage_roles` permission.", "operationId"=>"update-a-users-systemlevel-roles-valid-user-roles-are-system-user-system-admin-or-both-of-them-overw", "x-api-path-slug"=>"usersuser-idroles-put", "parameters"=>[{"in"=>"body", "name"=>"roles", "description"=>"Space-delimited system roles to assign to the user", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Roles"]}}, "/users/{user_id}/active"=>{"put"=>{"summary"=>"Update user active status", "description"=>"Update user active or inactive status.\n\n__Since server version 4.6, users using a SSO provider to login can be activated or deactivated with this endpoint. However, if their activation status in Mattermost does not reflect their status in the SSO provider, the next synchronization or login by that user will reset the activation status to that of their account in the SSO provider. Server versions 4.5 and before do not allow activation or deactivation of SSO users from this endpoint.__\n##### Permissions\nUser can deactivate themself.\nUser with `manage_system` permission can activate or deactivate a user.", "operationId"=>"update-user-active-or-inactive-status-since-server-version-46-users-using-a-sso-provider-to-login-ca", "x-api-path-slug"=>"usersuser-idactive-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Use `true` to set the user active, `false` for inactive", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Active", "Status"]}}, "/users/{user_id}/image"=>{"get"=>{"summary"=>"Get user's profile image", "description"=>"Get a user's profile image based on user_id string parameter.\n##### Permissions\nMust be logged in.", "operationId"=>"get-a-users-profile-image-based-on-user-id-string-parameter-permissionsmust-be-logged-in", "x-api-path-slug"=>"usersuser-idimage-get", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Profile", "Image"]}, "post"=>{"summary"=>"Set user's profile image", "description"=>"Set a user's profile image based on user_id string parameter.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.", "operationId"=>"set-a-users-profile-image-based-on-user-id-string-parameter-permissionsmust-be-logged-in-as-the-user", "x-api-path-slug"=>"usersuser-idimage-post", "parameters"=>[{"in"=>"formData", "name"=>"image", "description"=>"The image to be uploaded"}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Users", "Profile", "Image"]}}, "/users/username/{username}"=>{"get"=>{"summary"=>"Get a user by username", "description"=>"Get a user object by providing a username. Sensitive information will be sanitized out.\n##### Permissions\nRequires an active session but no other permissions.", "operationId"=>"get-a-user-object-by-providing-a-username-sensitive-information-will-be-sanitized-out-permissionsreq", "x-api-path-slug"=>"usersusernameusername-get", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "By", "Username"]}}, "/users/password/reset"=>{"post"=>{"summary"=>"Reset password", "description"=>"Update the password for a user using a one-use, timed recovery code tied to the user's account. Only works for non-SSO users.\n##### Permissions\nNo permissions required.", "operationId"=>"update-the-password-for-a-user-using-a-oneuse-timed-recovery-code-tied-to-the-users-account-only-wor", "x-api-path-slug"=>"userspasswordreset-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reset", "Password"]}}, "/users/{user_id}/mfa"=>{"put"=>{"summary"=>"Update a user's MFA", "description"=>"Activates multi-factor authentication for the user if `activate` is true and a valid `code` is provided. If activate is false, then `code` is not required and multi-factor authentication is disabled for the user.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.", "operationId"=>"activates-multifactor-authentication-for-the-user-if-activate-is-true-and-a-valid-code-is-provided-i", "x-api-path-slug"=>"usersuser-idmfa-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "MFA"]}}, "/users/{user_id}/mfa/generate"=>{"post"=>{"summary"=>"Generate MFA secret", "description"=>"Generates an multi-factor authentication secret for a user and returns it as a string and as base64 encoded QR code image.\n##### Permissions\nMust be logged in as the user or have the `edit_other_users` permission.", "operationId"=>"generates-an-multifactor-authentication-secret-for-a-user-and-returns-it-as-a-string-and-as-base64-e", "x-api-path-slug"=>"usersuser-idmfagenerate-post", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generate", "MFA", "Secret"]}}, "/users/mfa"=>{"post"=>{"summary"=>"Check MFA", "description"=>"Check if a user has multi-factor authentication active on their account by providing a login id. Used to check whether an MFA code needs to be provided when logging in.\n##### Permissions\nNo permission required.", "operationId"=>"check-if-a-user-has-multifactor-authentication-active-on-their-account-by-providing-a-login-id-used-", "x-api-path-slug"=>"usersmfa-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Check", "MFA"]}}, "/users/{user_id}/password"=>{"put"=>{"summary"=>"Update a user's password", "description"=>"Update a user's password. New password must meet password policy set by server configuration. Current password is required if you're updating your own password.\n##### Permissions\nMust be logged in as the user the password is being changed for or have `manage_system` permission.", "operationId"=>"update-a-users-password-new-password-must-meet-password-policy-set-by-server-configuration-current-p", "x-api-path-slug"=>"usersuser-idpassword-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Password"]}}, "/users/password/reset/send"=>{"post"=>{"summary"=>"Send password reset email", "description"=>"Send an email containing a link for resetting the user's password. The link will contain a one-use, timed recovery code tied to the user's account. Only works for non-SSO users.\n##### Permissions\nNo permissions required.", "operationId"=>"send-an-email-containing-a-link-for-resetting-the-users-password-the-link-will-contain-a-oneuse-time", "x-api-path-slug"=>"userspasswordresetsend-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Password", "Reset", "Email"]}}, "/users/email/{email}"=>{"get"=>{"summary"=>"Get a user by email", "description"=>"Get a user object by providing a user email. Sensitive information will be sanitized out.\n##### Permissions\nRequires an active session but no other permissions.", "operationId"=>"get-a-user-object-by-providing-a-user-email-sensitive-information-will-be-sanitized-out-permissionsr", "x-api-path-slug"=>"usersemailemail-get", "parameters"=>[{"in"=>"path", "name"=>"email", "description"=>"User Email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "By", "Email"]}}, "/users/{user_id}/sessions"=>{"get"=>{"summary"=>"Get user's sessions", "description"=>"Get a list of sessions by providing the user GUID. Sensitive information will be sanitized out.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.", "operationId"=>"get-a-list-of-sessions-by-providing-the-user-guid-sensitive-information-will-be-sanitized-out-permis", "x-api-path-slug"=>"usersuser-idsessions-get", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Sessions"]}}, "/users/{user_id}/sessions/revoke"=>{"post"=>{"summary"=>"Revoke a user session", "description"=>"Revokes a user session from the provided user id and session id strings.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.", "operationId"=>"revokes-a-user-session-from-the-provided-user-id-and-session-id-strings-permissionsmust-be-logged-in", "x-api-path-slug"=>"usersuser-idsessionsrevoke-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Revoke", "User", "Session"]}}, "/users/{user_id}/sessions/revoke/all"=>{"post"=>{"summary"=>"Revoke all active sessions for a user", "description"=>"Revokes all user sessions from the provided user id and session id strings.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n__Minimum server version__: 4.4", "operationId"=>"revokes-all-user-sessions-from-the-provided-user-id-and-session-id-strings-permissionsmust-be-logged", "x-api-path-slug"=>"usersuser-idsessionsrevokeall-post", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Revoke", "", "Active", "Sessionsa", "User"]}}, "/users/sessions/device"=>{"put"=>{"summary"=>"Attach mobile device", "description"=>"Attach a mobile device id to the currently logged in session. This will enable push notiofications for a user, if configured by the server.\n##### Permissions\nMust be authenticated.", "operationId"=>"attach-a-mobile-device-id-to-the-currently-logged-in-session-this-will-enable-push-notiofications-fo", "x-api-path-slug"=>"userssessionsdevice-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attach", "Mobile", "Device"]}}, "/users/{user_id}/audits"=>{"get"=>{"summary"=>"Get users audits", "description"=>"Get a list of audit by providing the user GUID.\n##### Permissions\nMust be logged in as the user or have the `edit_other_users` permission.", "operationId"=>"get-a-list-of-audit-by-providing-the-user-guid-permissionsmust-be-logged-in-as-the-user-or-have-the-", "x-api-path-slug"=>"usersuser-idaudits-get", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Audits"]}}, "/users/email/verify"=>{"post"=>{"summary"=>"Verify user email", "description"=>"Verify the email used by a user to sign-up their account with.\n##### Permissions\nNo permissions required.", "operationId"=>"verify-the-email-used-by-a-user-to-signup-their-account-with-permissionsno-permissions-required", "x-api-path-slug"=>"usersemailverify-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Verify", "User", "Email"]}}, "/users/email/verify/send"=>{"post"=>{"summary"=>"Send verification email", "description"=>"Send an email with a verification link to a user that has an email matching the one in the request body. This endpoint will return success even if the email does not match any users on the system.\n##### Permissions\nNo permissions required.", "operationId"=>"send-an-email-with-a-verification-link-to-a-user-that-has-an-email-matching-the-one-in-the-request-b", "x-api-path-slug"=>"usersemailverifysend-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Verification", "Email"]}}, "/users/login/switch"=>{"post"=>{"summary"=>"Switch login method", "description"=>"Switch a user's login method from using email to OAuth2/SAML/LDAP or back to email. When switching to OAuth2/SAML, account switching is not complete until the user follows the returned link and completes any steps on the OAuth2/SAML service provider.\n\nTo switch from email to OAuth2/SAML, specify `current_service`, `new_service`, `email` and `password`.\n\nTo switch from OAuth2/SAML to email, specify `current_service`, `new_service`, `email` and `new_password`.\n\nTo switch from email to LDAP/AD, specify `current_service`, `new_service`, `email`, `password`, `ldap_ip` and `new_password` (this is the user's LDAP password).\n\nTo switch from LDAP/AD to email, specify `current_service`, `new_service`, `ldap_ip`, `password` (this is the user's LDAP password), `email` and `new_password`.\n\nAdditionally, specify `mfa_code` when trying to switch an account on LDAP/AD or email that has MFA activated.\n\n##### Permissions\nNo current authentication required except when switching from OAuth2/SAML to email.", "operationId"=>"switch-a-users-login-method-from-using-email-to-oauth2samlldap-or-back-to-email-when-switching-to-oa", "x-api-path-slug"=>"usersloginswitch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Switch", "Login", "Method"]}}, "/users/{user_id}/tokens"=>{"post"=>{"summary"=>"Create a user access token", "description"=>"Generate a user access token that can be used to authenticate with the Mattermost REST API.\n\n__Minimum server version__: 4.1\n\n##### Permissions\nMust have `create_user_access_token` permission. For non-self requests, must also have the `edit_other_users` permission.", "operationId"=>"generate-a-user-access-token-that-can-be-used-to-authenticate-with-the-mattermost-rest-api-minimum-s", "x-api-path-slug"=>"usersuser-idtokens-post", "parameters"=>[{"in"=>"body", "name"=>"token", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Access", "Token"]}, "get"=>{"summary"=>"Get user access tokens", "description"=>"Get a list of user access tokens for a user. Does not include the actual authentication tokens. Use query paremeters for paging.\n\n__Minimum server version__: 4.1\n\n##### Permissions\nMust have `read_user_access_token` permission. For non-self requests, must also have the `edit_other_users` permission.", "operationId"=>"get-a-list-of-user-access-tokens-for-a-user-does-not-include-the-actual-authentication-tokens-use-qu", "x-api-path-slug"=>"usersuser-idtokens-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of tokens per page"}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Access", "Tokens"]}}, "/users/tokens"=>{"get"=>{"summary"=>"Get user access tokens", "description"=>"Get a page of user access tokens for users on the system. Does not include the actual authentication tokens. Use query parameters for paging.\n\n__Minimum server version__: 4.7\n\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"get-a-page-of-user-access-tokens-for-users-on-the-system-does-not-include-the-actual-authentication-", "x-api-path-slug"=>"userstokens-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of tokens per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Access", "Tokens"]}}, "/users/tokens/revoke"=>{"post"=>{"summary"=>"Revoke a user access token", "description"=>"Revoke a user access token and delete any sessions using the token.\n\n__Minimum server version__: 4.1\n\n##### Permissions\nMust have `revoke_user_access_token` permission. For non-self requests, must also have the `edit_other_users` permission.", "operationId"=>"revoke-a-user-access-token-and-delete-any-sessions-using-the-token-minimum-server-version--41-permis", "x-api-path-slug"=>"userstokensrevoke-post", "parameters"=>[{"in"=>"body", "name"=>"token", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Revoke", "User", "Access", "Token"]}}, "/users/tokens/{token_id}"=>{"get"=>{"summary"=>"Get a user access token", "description"=>"Get a user access token. Does not include the actual authentication token.\n\n__Minimum server version__: 4.1\n\n##### Permissions\nMust have `read_user_access_token` permission. For non-self requests, must also have the `edit_other_users` permission.", "operationId"=>"get-a-user-access-token-does-not-include-the-actual-authentication-token-minimum-server-version--41-", "x-api-path-slug"=>"userstokenstoken-id-get", "parameters"=>[{"in"=>"path", "name"=>"token_id", "description"=>"User access token GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Access", "Token"]}}, "/users/tokens/disable"=>{"post"=>{"summary"=>"Disable personal access token", "description"=>"Disable a personal access token and delete any sessions using the token. The token can be re-enabled using `/users/tokens/enable`.\n\n__Minimum server version__: 4.4\n\n##### Permissions\nMust have `revoke_user_access_token` permission. For non-self requests, must also have the `edit_other_users` permission.", "operationId"=>"disable-a-personal-access-token-and-delete-any-sessions-using-the-token-the-token-can-be-reenabled-u", "x-api-path-slug"=>"userstokensdisable-post", "parameters"=>[{"in"=>"body", "name"=>"token", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disable", "Personal", "Access", "Token"]}}, "/users/tokens/enable"=>{"post"=>{"summary"=>"Enable personal access token", "description"=>"Re-enable a personal access token that has been disabled.\n\n__Minimum server version__: 4.4\n\n##### Permissions\nMust have `create_user_access_token` permission. For non-self requests, must also have the `edit_other_users` permission.", "operationId"=>"reenable-a-personal-access-token-that-has-been-disabled-minimum-server-version--44-permissionsmust-h", "x-api-path-slug"=>"userstokensenable-post", "parameters"=>[{"in"=>"body", "name"=>"token", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Enable", "Personal", "Access", "Token"]}}, "/users/tokens/search"=>{"post"=>{"summary"=>"Search tokens", "description"=>"Get a list of tokens based on search criteria provided in the request body. Searches are done against the token id, user id and username.\n\n__Minimum server version__: 4.7\n\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"get-a-list-of-tokens-based-on-search-criteria-provided-in-the-request-body-searches-are-done-against", "x-api-path-slug"=>"userstokenssearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Search criteria", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Tokens"]}}, "/users/{user_id}/auth"=>{"put"=>{"summary"=>"Update a users authentication method", "description"=>"Updates a user's authentication method. This can be used to change them to/from LDAP authentication for example.\n\n__Minimum server version__: 4.6\n##### Permissions\nMust have the `edit_other_users` permission.", "operationId"=>"updates-a-users-authentication-method-this-can-be-used-to-change-them-tofrom-ldap-authentication-for", "x-api-path-slug"=>"usersuser-idauth-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Authentication", "Method"]}}, "/users/{user_id}/status"=>{"get"=>{"summary"=>"Get user status", "description"=>"Get user status by id from the server.\n##### Permissions\nMust be authenticated.", "operationId"=>"get-user-status-by-id-from-the-server-permissionsmust-be-authenticated", "x-api-path-slug"=>"usersuser-idstatus-get", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Status"]}, "put"=>{"summary"=>"Update user status", "description"=>"Manually set a user's status. When setting a user's status, the status will remain that value until set \"online\" again, which will return the status to being automatically updated based on user activity.\n##### Permissions\nMust have `edit_other_users` permission for the team.", "operationId"=>"manually-set-a-users-status-when-setting-a-users-status-the-status-will-remain-that-value-until-set-", "x-api-path-slug"=>"usersuser-idstatus-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Status object that is to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Status"]}}, "/users/status/ids"=>{"post"=>{"summary"=>"Get user statuses by id", "description"=>"Get a list of user statuses by id from the server.\n##### Permissions\nMust be authenticated.", "operationId"=>"get-a-list-of-user-statuses-by-id-from-the-server-permissionsmust-be-authenticated", "x-api-path-slug"=>"usersstatusids-post", "parameters"=>[{"in"=>"body", "name"=>"post", "description"=>"List of user ids to fetch", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Statuses", "By", "Id"]}}, "/teams"=>{"post"=>{"summary"=>"Create a team", "description"=>"Create a new team on the system.\n##### Permissions\nMust be authenticated and have the `create_team` permission.", "operationId"=>"create-a-new-team-on-the-system-permissionsmust-be-authenticated-and-have-the-create-team-permission", "x-api-path-slug"=>"teams-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Team that is to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team"]}, "get"=>{"summary"=>"Get teams", "description"=>"For regular users only returns open teams. Users with the \"manage_system\" permission will return teams regardless of type. The result is based on query string parameters - page and per_page.\n##### Permissions\nMust be authenticated. \"manage_system\" permission is required to show all teams.", "operationId"=>"for-regular-users-only-returns-open-teams-users-with-the-manage-system-permission-will-return-teams-", "x-api-path-slug"=>"teams-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of teams per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams"]}}, "/teams/{team_id}"=>{"get"=>{"summary"=>"Get a team", "description"=>"Get a team on the system.\n##### Permissions\nMust be authenticated and have the `view_team` permission.", "operationId"=>"get-a-team-on-the-system-permissionsmust-be-authenticated-and-have-the-view-team-permission", "x-api-path-slug"=>"teamsteam-id-get", "parameters"=>[{"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team"]}, "put"=>{"summary"=>"Update a team", "description"=>"Update a team by providing the team object. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n##### Permissions\nMust have the `manage_team` permission.", "operationId"=>"update-a-team-by-providing-the-team-object-the-fields-that-can-be-updated-are-defined-in-the-request", "x-api-path-slug"=>"teamsteam-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Team to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team"]}, "delete"=>{"summary"=>"Delete a team", "description"=>"Soft deletes a team, by marking the team as deleted in the database. Soft deleted teams will not be accessible in the user interface.\n\nOptionally use the permanent query parameter to hard delete the team for compliance reasons.\n##### Permissions\nMust have the `manage_team` permission.", "operationId"=>"soft-deletes-a-team-by-marking-the-team-as-deleted-in-the-database-soft-deleted-teams-will-not-be-ac", "x-api-path-slug"=>"teamsteam-id-delete", "parameters"=>[{"in"=>"query", "name"=>"permanent", "description"=>"Permanently delete the team, to be used for compliance reasons only"}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team"]}}, "/teams/{team_id}/patch"=>{"put"=>{"summary"=>"Patch a team", "description"=>"Partially update a team by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n##### Permissions\nMust have the `manage_team` permission.", "operationId"=>"partially-update-a-team-by-providing-only-the-fields-you-want-to-update-omitted-fields-will-not-be-u", "x-api-path-slug"=>"teamsteam-idpatch-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Team object that is to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team"]}}, "/teams/name/{name}"=>{"get"=>{"summary"=>"Get a team by name", "description"=>"Get a team based on provided name string\n##### Permissions\nMust be authenticated, team type is open and have the `view_team` permission.", "operationId"=>"get-a-team-based-on-provided-name-string-permissionsmust-be-authenticated-team-type-is-open-and-have", "x-api-path-slug"=>"teamsnamename-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Team Name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "By", "Name"]}}, "/teams/search"=>{"post"=>{"summary"=>"Search teams", "description"=>"Search teams based on search term provided in the request body.\n##### Permissions\nLogged in user only shows open teams\nLogged in user with \"manage_system\" permission shows all teams", "operationId"=>"search-teams-based-on-search-term-provided-in-the-request-body-permissionslogged-in-user-only-shows-", "x-api-path-slug"=>"teamssearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Search criteria", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Teams"]}}, "/teams/name/{name}/exists"=>{"get"=>{"summary"=>"Check if team exists", "description"=>"Check if the team exists based on a team name.", "operationId"=>"check-if-the-team-exists-based-on-a-team-name", "x-api-path-slug"=>"teamsnamenameexists-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Team Name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Check", "If", "Team", "Exists"]}}, "/users/{user_id}/teams"=>{"get"=>{"summary"=>"Get a user's teams", "description"=>"Get a list of teams that a user is on.\n##### Permissions\nMust be authenticated as the user or have the `manage_system` permission.", "operationId"=>"get-a-list-of-teams-that-a-user-is-on-permissionsmust-be-authenticated-as-the-user-or-have-the-manag", "x-api-path-slug"=>"usersuser-idteams-get", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Teams"]}}, "/teams/{team_id}/members"=>{"get"=>{"summary"=>"Get team members", "description"=>"Get a page team members list based on query string parameters - team id, page and per page.\n##### Permissions\nMust be authenticated and have the `view_team` permission.", "operationId"=>"get-a-page-team-members-list-based-on-query-string-parameters--team-id-page-and-per-page-permissions", "x-api-path-slug"=>"teamsteam-idmembers-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of users per page"}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Members"]}, "post"=>{"summary"=>"Add user to team", "description"=>"Add user to the team by user_id.\n##### Permissions\nMust be authenticated and team be open to add self. For adding another user, authenticated user must have the `add_user_to_team` permission.", "operationId"=>"add-user-to-the-team-by-user-id-permissionsmust-be-authenticated-and-team-be-open-to-add-self-for-ad", "x-api-path-slug"=>"teamsteam-idmembers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "To", "Team"]}}, "/teams/members/invite"=>{"post"=>{"summary"=>"Add user to team from invite", "description"=>"Using either an invite id or hash/data pair from an email invite link, add a user to a team.\n##### Permissions\nMust be authenticated.", "operationId"=>"using-either-an-invite-id-or-hashdata-pair-from-an-email-invite-link-add-a-user-to-a-team-permission", "x-api-path-slug"=>"teamsmembersinvite-post", "parameters"=>[{"in"=>"query", "name"=>"data", "description"=>"Data with time and team id"}, {"in"=>"query", "name"=>"hash", "description"=>"Hash value with time, team id and and InviteSaltId"}, {"in"=>"query", "name"=>"invite_id", "description"=>"Invite id to add user to the team"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "To", "Team", "From", "Invite"]}}, "/teams/{team_id}/members/batch"=>{"post"=>{"summary"=>"Add multiple users to team", "description"=>"Add a number of users to the team by user_id.\n##### Permissions\nMust be authenticated. Authenticated user must have the `add_user_to_team` permission.", "operationId"=>"add-a-number-of-users-to-the-team-by-user-id-permissionsmust-be-authenticated-authenticated-user-mus", "x-api-path-slug"=>"teamsteam-idmembersbatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multiple", "Users", "To", "Team"]}}, "/users/{user_id}/teams/members"=>{"get"=>{"summary"=>"Get team members for a user", "description"=>"Get a list of team members for a user. Useful for getting the ids of teams the user is on and the roles they have in those teams.\n##### Permissions\nMust be logged in as the user or have the `edit_other_users` permission.", "operationId"=>"get-a-list-of-team-members-for-a-user-useful-for-getting-the-ids-of-teams-the-user-is-on-and-the-rol", "x-api-path-slug"=>"usersuser-idteamsmembers-get", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Membersa", "User"]}}, "/teams/{team_id}/members/{user_id}"=>{"get"=>{"summary"=>"Get a team member", "description"=>"Get a team member on the system.\n##### Permissions\nMust be authenticated and have the `view_team` permission.", "operationId"=>"get-a-team-member-on-the-system-permissionsmust-be-authenticated-and-have-the-view-team-permission", "x-api-path-slug"=>"teamsteam-idmembersuser-id-get", "parameters"=>[{"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Member"]}, "delete"=>{"summary"=>"Remove user from team", "description"=>"Delete the team member object for a user, effectively removing them from a team.\n##### Permissions\nMust be logged in as the user or have the `remove_user_from_team` permission.", "operationId"=>"delete-the-team-member-object-for-a-user-effectively-removing-them-from-a-team-permissionsmust-be-lo", "x-api-path-slug"=>"teamsteam-idmembersuser-id-delete", "parameters"=>[{"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "User", "From", "Team"]}}, "/teams/{team_id}/members/ids"=>{"post"=>{"summary"=>"Get team members by ids", "description"=>"Get a list of team members based on a provided array of user ids.\n##### Permissions\nMust have `view_team` permission for the team.", "operationId"=>"get-a-list-of-team-members-based-on-a-provided-array-of-user-ids-permissionsmust-have-view-team-perm", "x-api-path-slug"=>"teamsteam-idmembersids-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"List of user ids", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Members", "By", "Ids"]}}, "/teams/{team_id}/stats"=>{"get"=>{"summary"=>"Get a team stats", "description"=>"Get a team stats on the system.\n##### Permissions\nMust be authenticated and have the `view_team` permission.", "operationId"=>"get-a-team-stats-on-the-system-permissionsmust-be-authenticated-and-have-the-view-team-permission", "x-api-path-slug"=>"teamsteam-idstats-get", "parameters"=>[{"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Stats"]}}, "/teams/{team_id}/image"=>{"get"=>{"summary"=>"Get the team icon", "description"=>"Get the team icon of the team.\n\n__Minimum server version__: 4.9\n\n##### Permissions\nUser must be authenticated. In addition, team must be open or the user must have the `view_team` permission.", "operationId"=>"get-the-team-icon-of-the-team-minimum-server-version--49-permissionsuser-must-be-authenticated-in-ad", "x-api-path-slug"=>"teamsteam-idimage-get", "parameters"=>[{"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Icon"]}, "post"=>{"summary"=>"Sets the team icon", "description"=>"Sets the team icon for the team.\n\n__Minimum server version__: 4.9\n\n##### Permissions\nMust be authenticated and have the `manage_team` permission.", "operationId"=>"sets-the-team-icon-for-the-team-minimum-server-version--49-permissionsmust-be-authenticated-and-have", "x-api-path-slug"=>"teamsteam-idimage-post", "parameters"=>[{"in"=>"formData", "name"=>"image", "description"=>"The image to be uploaded"}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sets", "Team", "Icon"]}}, "/teams/{team_id}/members/{user_id}/roles"=>{"put"=>{"summary"=>"Update a team member roles", "description"=>"Update a team member roles. Valid team roles are \"team_user\", \"team_admin\" or both of them. Overwrites any previously assigned team roles.\n##### Permissions\nMust be authenticated and have the `manage_team_roles` permission.", "operationId"=>"update-a-team-member-roles-valid-team-roles-are-team-user-team-admin-or-both-of-them-overwrites-any-", "x-api-path-slug"=>"teamsteam-idmembersuser-idroles-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Space-delimited team roles to assign to the user", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Member", "Roles"]}}, "/users/{user_id}/teams/unread"=>{"get"=>{"summary"=>"Get team unreads for a user", "description"=>"Get the count for unread messages and mentions in the teams the user is a member of.\n##### Permissions\nMust be logged in.", "operationId"=>"get-the-count-for-unread-messages-and-mentions-in-the-teams-the-user-is-a-member-of-permissionsmust-", "x-api-path-slug"=>"usersuser-idteamsunread-get", "parameters"=>[{"in"=>"query", "name"=>"exclude_team", "description"=>"Optional team id to be excluded from the results"}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Unreadsa", "User"]}}, "/users/{user_id}/teams/{team_id}/unread"=>{"get"=>{"summary"=>"Get unreads for a team", "description"=>"Get the unread mention and message counts for a team for the specified user.\n##### Permissions\nMust be the user or have `edit_other_users` permission and have `view_team` permission for the team.", "operationId"=>"get-the-unread-mention-and-message-counts-for-a-team-for-the-specified-user-permissionsmust-be-the-u", "x-api-path-slug"=>"usersuser-idteamsteam-idunread-get", "parameters"=>[{"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unreadsa", "Team"]}}, "/teams/{team_id}/invite/email"=>{"post"=>{"summary"=>"Invite users to the team by email", "description"=>"Invite users to the existing team usign the user's email.\n##### Permissions\nMust have `invite_to_team` permission for the team.", "operationId"=>"invite-users-to-the-existing-team-usign-the-users-email-permissionsmust-have-invite-to-team-permissi", "x-api-path-slug"=>"teamsteam-idinviteemail-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"List of users email", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invite", "Users", "To", "Team", "By", "Email"]}}, "/teams/{team_id}/import"=>{"post"=>{"summary"=>"Import a Team from other application", "description"=>"Import a team into a existing team. Import users, channels, posts, hooks.\n##### Permissions\nMust have `permission_import_team` permission.", "operationId"=>"import-a-team-into-a-existing-team-import-users-channels-posts-hooks-permissionsmust-have-permission", "x-api-path-slug"=>"teamsteam-idimport-post", "parameters"=>[{"in"=>"formData", "name"=>"file", "description"=>"A file to be uploaded in zip format"}, {"in"=>"formData", "name"=>"filesize", "description"=>"The size of the zip file to be imported"}, {"in"=>"formData", "name"=>"importFrom", "description"=>"String that defines from which application the team was exported to be imported into Mattermost"}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import", "Team", "From", "Other", "Application"]}}, "/teams/invite/{invite_id}"=>{"get"=>{"summary"=>"Get invite info for a team", "description"=>"Get the `name`, `display_name`, `description` and `id` for a team from the invite id.\n\n__Minimum server version__: 4.0\n\n##### Permissions\nNo authentication required.", "operationId"=>"get-the-name-display-name-description-and-id-for-a-team-from-the-invite-id-minimum-server-version--4", "x-api-path-slug"=>"teamsinviteinvite-id-get", "parameters"=>[{"in"=>"path", "name"=>"invite_id", "description"=>"Invite id for a team"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invite", "Infoa", "Team"]}}, "/channels"=>{"post"=>{"summary"=>"Create a channel", "description"=>"Create a new channel.\n##### Permissions\nIf creating a public channel, `create_public_channel` permission is required. If creating a private channel, `create_private_channel` permission is required.", "operationId"=>"create-a-new-channel-permissionsif-creating-a-public-channel-create-public-channel-permission-is-req", "x-api-path-slug"=>"channels-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Channel object to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel"]}}, "/channels/direct"=>{"post"=>{"summary"=>"Create a direct message channel", "description"=>"Create a new direct message channel between two users.\n##### Permissions\nMust be one of the two users and have `create_direct_channel` permission. Having the `manage_system` permission voids the previous requirements.", "operationId"=>"create-a-new-direct-message-channel-between-two-users-permissionsmust-be-one-of-the-two-users-and-ha", "x-api-path-slug"=>"channelsdirect-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The two user ids to be in the direct message", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Direct", "Message", "Channel"]}}, "/channels/group"=>{"post"=>{"summary"=>"Create a group message channel", "description"=>"Create a new group message channel to group of users. If the logged in user's id is not included in the list, it will be appended to the end.\n##### Permissions\nMust have `create_group_channel` permission.", "operationId"=>"create-a-new-group-message-channel-to-group-of-users-if-the-logged-in-users-id-is-not-included-in-th", "x-api-path-slug"=>"channelsgroup-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"User ids to be in the group message channel", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Message", "Channel"]}}, "/teams/{team_id}/channels/ids"=>{"post"=>{"summary"=>"Get a list of channels by ids", "description"=>"Get a list of public channels on a team by id.\n##### Permissions\n`view_team` for the team the channels are on.", "operationId"=>"get-a-list-of-public-channels-on-a-team-by-id-permissionsview-team-for-the-team-the-channels-are-on", "x-api-path-slug"=>"teamsteam-idchannelsids-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"List of channel ids", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Channels", "By", "Ids"]}}, "/channels/{channel_id}"=>{"get"=>{"summary"=>"Get a channel", "description"=>"Get channel from the provided channel id string.\n##### Permissions\n`read_channel` permission for the channel.", "operationId"=>"get-channel-from-the-provided-channel-id-string-permissionsread-channel-permission-for-the-channel", "x-api-path-slug"=>"channelschannel-id-get", "parameters"=>[{"in"=>"path", "name"=>"channel_id", "description"=>"Channel GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel"]}, "put"=>{"summary"=>"Update a channel", "description"=>"Update a channel. The fields that can be updated are listed as paramters. Omitted fields will be treated as blanks.\n##### Permissions\nIf updating a public channel, `manage_public_channel_members` permission is required. If updating a private channel, `manage_private_channel_members` permission is required.", "operationId"=>"update-a-channel-the-fields-that-can-be-updated-are-listed-as-paramters-omitted-fields-will-be-treat", "x-api-path-slug"=>"channelschannel-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Channel object to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"channel_id", "description"=>"Channel GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel"]}, "delete"=>{"summary"=>"Delete a channel", "description"=>"Soft deletes a channel, by marking the channel as deleted in the database. Soft deleted channels will not be accessible in the user interface.\n##### Permissions\n`delete_public_channel` permission if the channel is public,\n`delete_private_channel` permission if the channel is private,\nor have `manage_system` permission.", "operationId"=>"soft-deletes-a-channel-by-marking-the-channel-as-deleted-in-the-database-soft-deleted-channels-will-", "x-api-path-slug"=>"channelschannel-id-delete", "parameters"=>[{"in"=>"path", "name"=>"channel_id", "description"=>"Channel GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel"]}}, "/channels/{channel_id}/patch"=>{"put"=>{"summary"=>"Patch a channel", "description"=>"Partially update a channel by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n##### Permissions\nIf updating a public channel, `manage_public_channel_members` permission is required. If updating a private channel, `manage_private_channel_members` permission is required.", "operationId"=>"partially-update-a-channel-by-providing-only-the-fields-you-want-to-update-omitted-fields-will-not-b", "x-api-path-slug"=>"channelschannel-idpatch-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Channel object to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"channel_id", "description"=>"Channel GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel"]}}, "/channels/{channel_id}/convert"=>{"post"=>{"summary"=>"Convert a channel from public to private", "description"=>"Convert into private channel from the provided channel id string.\n\n__Minimum server version__: 4.10\n\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"convert-into-private-channel-from-the-provided-channel-id-string-minimum-server-version--410-permiss", "x-api-path-slug"=>"channelschannel-idconvert-post", "parameters"=>[{"in"=>"path", "name"=>"channel_id", "description"=>"Channel GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Convert", "Channel", "From", "Public", "To", "Private"]}}, "/channels/{channel_id}/restore"=>{"post"=>{"summary"=>"Restore a channel", "description"=>"Restore channel from the provided channel id string.\n\n__Minimum server version__: 3.10\n\n##### Permissions\n`manage_team` permission for the team of channel.", "operationId"=>"restore-channel-from-the-provided-channel-id-string-minimum-server-version--310-permissionsmanage-te", "x-api-path-slug"=>"channelschannel-idrestore-post", "parameters"=>[{"in"=>"path", "name"=>"channel_id", "description"=>"Channel GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Restore", "Channel"]}}, "/channels/{channel_id}/stats"=>{"get"=>{"summary"=>"Get channel statistics", "description"=>"Get statistics for a channel.\n##### Permissions\nMust have the `read_channel` permission.", "operationId"=>"get-statistics-for-a-channel-permissionsmust-have-the-read-channel-permission", "x-api-path-slug"=>"channelschannel-idstats-get", "parameters"=>[{"in"=>"path", "name"=>"channel_id", "description"=>"Channel GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel", "Statistics"]}}, "/channels/{channel_id}/pinned"=>{"get"=>{"summary"=>"Get a channels pinned posts", "description"=>"Get a list of pinned posts for channel.", "operationId"=>"get-a-list-of-pinned-posts-for-channel", "x-api-path-slug"=>"channelschannel-idpinned-get", "parameters"=>[{"in"=>"path", "name"=>"channel_id", "description"=>"Channel GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channels", "Pinned", "Posts"]}}, "/teams/{team_id}/channels"=>{"get"=>{"summary"=>"Get public channels", "description"=>"Get a page of public channels on a team based on query string parameters - page and per_page.\n##### Permissions\nMust be authenticated and have the `list_team_channels` permission.", "operationId"=>"get-a-page-of-public-channels-on-a-team-based-on-query-string-parameters--page-and-per-page-permissi", "x-api-path-slug"=>"teamsteam-idchannels-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of public channels per page"}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Public", "Channels"]}}, "/teams/{team_id}/channels/deleted"=>{"get"=>{"summary"=>"Get deleted channels", "description"=>"Get a page of deleted channels on a team based on query string parameters - team_id, page and per_page.\n\n__Minimum server version__: 3.10\n\n##### Permissions\nMust be authenticated and have the `manage_team` permission.", "operationId"=>"get-a-page-of-deleted-channels-on-a-team-based-on-query-string-parameters--team-id-page-and-per-page", "x-api-path-slug"=>"teamsteam-idchannelsdeleted-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of public channels per page"}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deleted", "Channels"]}}, "/teams/{team_id}/channels/autocomplete"=>{"get"=>{"summary"=>"Autocomplete channels", "description"=>"Autocomplete public channels on a team based on the search term provided in the request URL.\n\n__Minimum server version__: 4.7\n\n##### Permissions\nMust have the `list_team_channels` permission.", "operationId"=>"autocomplete-public-channels-on-a-team-based-on-the-search-term-provided-in-the-request-url-minimum-", "x-api-path-slug"=>"teamsteam-idchannelsautocomplete-get", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"Name or display name"}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autocomplete", "Channels"]}}, "/teams/{team_id}/channels/search"=>{"post"=>{"summary"=>"Search channels", "description"=>"Search public channels on a team based on the search term provided in the request body.\n##### Permissions\nMust have the `list_team_channels` permission.", "operationId"=>"search-public-channels-on-a-team-based-on-the-search-term-provided-in-the-request-body-permissionsmu", "x-api-path-slug"=>"teamsteam-idchannelssearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Search criteria", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Channels"]}}, "/teams/{team_id}/channels/name/{channel_name}"=>{"get"=>{"summary"=>"Get a channel by name", "description"=>"Gets channel from the provided team id and channel name strings.\n##### Permissions\n`read_channel` permission for the channel.", "operationId"=>"gets-channel-from-the-provided-team-id-and-channel-name-strings-permissionsread-channel-permission-f", "x-api-path-slug"=>"teamsteam-idchannelsnamechannel-name-get", "parameters"=>[{"in"=>"path", "name"=>"channel_name", "description"=>"Channel Name"}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel", "By", "Name"]}}, "/teams/name/{team_name}/channels/name/{channel_name}"=>{"get"=>{"summary"=>"Get a channel by name and team name", "description"=>"Gets a channel from the provided team name and channel name strings.\n##### Permissions\n`read_channel` permission for the channel.", "operationId"=>"gets-a-channel-from-the-provided-team-name-and-channel-name-strings-permissionsread-channel-permissi", "x-api-path-slug"=>"teamsnameteam-namechannelsnamechannel-name-get", "parameters"=>[{"in"=>"path", "name"=>"channel_name", "description"=>"Channel Name"}, {"in"=>"path", "name"=>"team_name", "description"=>"Team Name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel", "By", "Name", "Team", "Name"]}}, "/channels/{channel_id}/members"=>{"get"=>{"summary"=>"Get channel members", "description"=>"Get a page of members for a channel.\n##### Permissions\n`read_channel` permission for the channel.", "operationId"=>"get-a-page-of-members-for-a-channel-permissionsread-channel-permission-for-the-channel", "x-api-path-slug"=>"channelschannel-idmembers-get", "parameters"=>[{"in"=>"path", "name"=>"channel_id", "description"=>"Channel GUID"}, {"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of members per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel", "Members"]}, "post"=>{"summary"=>"Add user to channel", "description"=>"Add a user to a channel by creating a channel member object.", "operationId"=>"add-a-user-to-a-channel-by-creating-a-channel-member-object", "x-api-path-slug"=>"channelschannel-idmembers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"channel_id", "description"=>"The channel ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "To", "Channel"]}}, "/channels/{channel_id}/members/ids"=>{"post"=>{"summary"=>"Get channel members by ids", "description"=>"Get a list of channel members based on the provided user ids.\n##### Permissions\nMust have the `read_channel` permission.", "operationId"=>"get-a-list-of-channel-members-based-on-the-provided-user-ids-permissionsmust-have-the-read-channel-p", "x-api-path-slug"=>"channelschannel-idmembersids-post", "parameters"=>[{"in"=>"path", "name"=>"channel_id", "description"=>"Channel GUID"}, {"in"=>"body", "name"=>"user_ids", "description"=>"List of user ids", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel", "Members", "By", "Ids"]}}, "/channels/{channel_id}/members/{user_id}"=>{"get"=>{"summary"=>"Get channel member", "description"=>"Get a channel member.\n##### Permissions\n`read_channel` permission for the channel.", "operationId"=>"get-a-channel-member-permissionsread-channel-permission-for-the-channel", "x-api-path-slug"=>"channelschannel-idmembersuser-id-get", "parameters"=>[{"in"=>"path", "name"=>"channel_id", "description"=>"Channel GUID"}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel", "Member"]}, "delete"=>{"summary"=>"Remove user from channel", "description"=>"Delete a channel member, effectively removing them from a channel.\n##### Permissions\n`manage_public_channel_members` permission if the channel is public.\n`manage_private_channel_members` permission if the channel is private.", "operationId"=>"delete-a-channel-member-effectively-removing-them-from-a-channel-permissionsmanage-public-channel-me", "x-api-path-slug"=>"channelschannel-idmembersuser-id-delete", "parameters"=>[{"in"=>"path", "name"=>"channel_id", "description"=>"Channel GUID"}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "User", "From", "Channel"]}}, "/channels/{channel_id}/members/{user_id}/roles"=>{"put"=>{"summary"=>"Update channel roles", "description"=>"Update a user's roles for a channel.\n##### Permissions\nMust have `manage_channel_roles` permission for the channel.", "operationId"=>"update-a-users-roles-for-a-channel-permissionsmust-have-manage-channel-roles-permission-for-the-chan", "x-api-path-slug"=>"channelschannel-idmembersuser-idroles-put", "parameters"=>[{"in"=>"path", "name"=>"channel_id", "description"=>"Channel GUID"}, {"in"=>"body", "name"=>"roles", "description"=>"Space-delimited channel roles to assign to the user", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel", "Roles"]}}, "/channels/{channel_id}/members/{user_id}/notify_props"=>{"put"=>{"summary"=>"Update channel notifications", "description"=>"Update a user's notification properties for a channel. Only the provided fields are updated.\n##### Permissions\nMust be logged in as the user or have `edit_other_users` permission.", "operationId"=>"update-a-users-notification-properties-for-a-channel-only-the-provided-fields-are-updated-permission", "x-api-path-slug"=>"channelschannel-idmembersuser-idnotify-props-put", "parameters"=>[{"in"=>"path", "name"=>"channel_id", "description"=>"Channel GUID"}, {"in"=>"body", "name"=>"notify_props", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel", "Notifications"]}}, "/channels/members/{user_id}/view"=>{"post"=>{"summary"=>"View channel", "description"=>"Perform all the actions involved in viewing a channel. This includes marking channels as read, clearing push notifications, and updating the active channel.\n##### Permissions\nMust be logged in as user or have `edit_other_users` permission.\n\n__Response only includes `last_viewed_at_times` in Mattermost server 4.3 and newer.__", "operationId"=>"perform-all-the-actions-involved-in-viewing-a-channel-this-includes-marking-channels-as-read-clearin", "x-api-path-slug"=>"channelsmembersuser-idview-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Paremeters affecting how and which channels to view", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"User ID to perform the view action for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "Channel"]}}, "/users/{user_id}/teams/{team_id}/channels/members"=>{"get"=>{"summary"=>"Get channel members for user", "description"=>"Get all channel members on a team for a user.\n##### Permissions\nLogged in as the user and `view_team` permission for the team. Having `manage_system` permission voids the previous requirements.", "operationId"=>"get-all-channel-members-on-a-team-for-a-user-permissionslogged-in-as-the-user-and-view-team-permissi", "x-api-path-slug"=>"usersuser-idteamsteam-idchannelsmembers-get", "parameters"=>[{"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channel", "Membersuser"]}}, "/users/{user_id}/teams/{team_id}/channels"=>{"get"=>{"summary"=>"Get channels for user", "description"=>"Get all the channels on a team for a user.\n##### Permissions\nLogged in as the user, or have `edit_other_users` permission, and `view_team` permission for the team.", "operationId"=>"get-all-the-channels-on-a-team-for-a-user-permissionslogged-in-as-the-user-or-have-edit-other-users-", "x-api-path-slug"=>"usersuser-idteamsteam-idchannels-get", "parameters"=>[{"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Channelsuser"]}}, "/users/{user_id}/channels/{channel_id}/unread"=>{"get"=>{"summary"=>"Get unread messages", "description"=>"Get the total unread messages and mentions for a channel for a user.\n##### Permissions\nMust be logged in as user and have the `read_channel` permission, or have `edit_other_usrs` permission.", "operationId"=>"get-the-total-unread-messages-and-mentions-for-a-channel-for-a-user-permissionsmust-be-logged-in-as-", "x-api-path-slug"=>"usersuser-idchannelschannel-idunread-get", "parameters"=>[{"in"=>"path", "name"=>"channel_id", "description"=>"Channel GUID"}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unread", "Messages"]}}, "/posts"=>{"post"=>{"summary"=>"Create a post", "description"=>"Create a new post in a channel. To create the post as a comment on another post, provide `root_id`.\n##### Permissions\nMust have `create_post` permission for the channel the post is being created in.", "operationId"=>"create-a-new-post-in-a-channel-to-create-the-post-as-a-comment-on-another-post-provide-root-id-permi", "x-api-path-slug"=>"posts-post", "parameters"=>[{"in"=>"body", "name"=>"post", "description"=>"Post object to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Post"]}}, "/posts/ephemeral"=>{"post"=>{"summary"=>"Create a ephemeral post", "description"=>"Create a new ephemeral post in a channel.\n##### Permissions\nMust have `create_post_ephemeral` permission (currently only given to system admin)", "operationId"=>"create-a-new-ephemeral-post-in-a-channel-permissionsmust-have-create-post-ephemeral-permission-curre", "x-api-path-slug"=>"postsephemeral-post", "parameters"=>[{"in"=>"body", "name"=>"ephemeral_post", "description"=>"Ephemeral Post object to send", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ephemeral", "Post"]}}, "/posts/{post_id}"=>{"get"=>{"summary"=>"Get a post", "description"=>"Get a single post.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in or if the channel is public, have the `read_public_channels` permission for the team.", "operationId"=>"get-a-single-post-permissionsmust-have-read-channel-permission-for-the-channel-the-post-is-in-or-if-", "x-api-path-slug"=>"postspost-id-get", "parameters"=>[{"in"=>"path", "name"=>"post_id", "description"=>"ID of the post to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Post"]}, "delete"=>{"summary"=>"Delete a post", "description"=>"Soft deletes a post, by marking the post as deleted in the database. Soft deleted posts will not be returned in post queries.\n##### Permissions\nMust be logged in as the user or have `delete_others_posts` permission.", "operationId"=>"soft-deletes-a-post-by-marking-the-post-as-deleted-in-the-database-soft-deleted-posts-will-not-be-re", "x-api-path-slug"=>"postspost-id-delete", "parameters"=>[{"in"=>"path", "name"=>"post_id", "description"=>"ID of the post to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Post"]}, "put"=>{"summary"=>"Update a post", "description"=>"Update a post. Only the fields listed below are updatable, omitted fields will be treated as blank.\n##### Permissions\nMust have `edit_post` permission for the channel the post is in.", "operationId"=>"update-a-post-only-the-fields-listed-below-are-updatable-omitted-fields-will-be-treated-as-blank-per", "x-api-path-slug"=>"postspost-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Post object that is to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"post_id", "description"=>"ID of the post to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Post"]}}, "/posts/{post_id}/patch"=>{"put"=>{"summary"=>"Patch a post", "description"=>"Partially update a post by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n##### Permissions\nMust have the `edit_post` permission.", "operationId"=>"partially-update-a-post-by-providing-only-the-fields-you-want-to-update-omitted-fields-will-not-be-u", "x-api-path-slug"=>"postspost-idpatch-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Post object that is to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"post_id", "description"=>"Post GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Post"]}}, "/posts/{post_id}/thread"=>{"get"=>{"summary"=>"Get a thread", "description"=>"Get a post and the rest of the posts in the same thread.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in or if the channel is public, have the `read_public_channels` permission for the team.", "operationId"=>"get-a-post-and-the-rest-of-the-posts-in-the-same-thread-permissionsmust-have-read-channel-permission", "x-api-path-slug"=>"postspost-idthread-get", "parameters"=>[{"in"=>"path", "name"=>"post_id", "description"=>"ID of a post in the thread"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thread"]}}, "/users/{user_id}/posts/flagged"=>{"get"=>{"summary"=>"Get a list of flagged posts", "description"=>"Get a page of flagged posts of a user provided user id string. Selects from a channel, team or all flagged posts by a user.\n##### Permissions\nMust be user or have `manage_system` permission.", "operationId"=>"get-a-page-of-flagged-posts-of-a-user-provided-user-id-string-selects-from-a-channel-team-or-all-fla", "x-api-path-slug"=>"usersuser-idpostsflagged-get", "parameters"=>[{"in"=>"query", "name"=>"channel_id", "description"=>"Channel ID"}, {"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of posts per page"}, {"in"=>"query", "name"=>"team_id", "description"=>"Team ID"}, {"in"=>"path", "name"=>"user_id", "description"=>"ID of the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Flagged", "Posts"]}}, "/posts/{post_id}/files/info"=>{"get"=>{"summary"=>"Get file info for post", "description"=>"Gets a list of file information objects for the files attached to a post.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in.", "operationId"=>"gets-a-list-of-file-information-objects-for-the-files-attached-to-a-post-permissionsmust-have-read-c", "x-api-path-slug"=>"postspost-idfilesinfo-get", "parameters"=>[{"in"=>"path", "name"=>"post_id", "description"=>"ID of the post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File", "Infopost"]}}, "/channels/{channel_id}/posts"=>{"get"=>{"summary"=>"Get posts for a channel", "description"=>"Get a page of posts in a channel. Use the query parameters to modify the behaviour of this endpoint. The parameters `since`, `before` and `after` must not be used together.\n##### Permissions\nMust have `read_channel` permission for the channel.", "operationId"=>"get-a-page-of-posts-in-a-channel-use-the-query-parameters-to-modify-the-behaviour-of-this-endpoint-t", "x-api-path-slug"=>"channelschannel-idposts-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"A post id to select the posts that came after this one"}, {"in"=>"query", "name"=>"before", "description"=>"A post id to select the posts that came before this one"}, {"in"=>"path", "name"=>"channel_id", "description"=>"The channel ID to get the posts for"}, {"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of posts per page"}, {"in"=>"query", "name"=>"since", "description"=>"Provide a non-zero value in Unix time milliseconds to select posts created after that time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Postsa", "Channel"]}}, "/teams/{team_id}/posts/search"=>{"post"=>{"summary"=>"Search for team posts", "description"=>"Search posts in the team and from the provided terms string.\n##### Permissions\nMust be authenticated and have the `view_team` permission.", "operationId"=>"search-posts-in-the-team-and-from-the-provided-terms-string-permissionsmust-be-authenticated-and-hav", "x-api-path-slug"=>"teamsteam-idpostssearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The search terms and logic to use in the search", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Searchteam", "Posts"]}}, "/posts/{post_id}/pin"=>{"post"=>{"summary"=>"Pin a post to the channel", "description"=>"Pin a post to a channel it is in based from the provided post id string.\n##### Permissions\nMust be authenticated and have the `read_channel` permission to the channel the post is in.", "operationId"=>"pin-a-post-to-a-channel-it-is-in-based-from-the-provided-post-id-string-permissionsmust-be-authentic", "x-api-path-slug"=>"postspost-idpin-post", "parameters"=>[{"in"=>"path", "name"=>"post_id", "description"=>"Post GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pin", "Post", "To", "Channel"]}}, "/posts/{post_id}/unpin"=>{"post"=>{"summary"=>"Unpin a post to the channel", "description"=>"Unpin a post to a channel it is in based from the provided post id string.\n##### Permissions\nMust be authenticated and have the `read_channel` permission to the channel the post is in.", "operationId"=>"unpin-a-post-to-a-channel-it-is-in-based-from-the-provided-post-id-string-permissionsmust-be-authent", "x-api-path-slug"=>"postspost-idunpin-post", "parameters"=>[{"in"=>"path", "name"=>"post_id", "description"=>"Post GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unpin", "Post", "To", "Channel"]}}, "/posts/{post_id}/actions/{action_id}"=>{"post"=>{"summary"=>"Perform a post action", "description"=>"Perform a post action, which allows users to interact with integrations through posts.\n##### Permissions\nMust be authenticated and have the `read_channel` permission to the channel the post is in.", "operationId"=>"perform-a-post-action-which-allows-users-to-interact-with-integrations-through-posts-permissionsmust", "x-api-path-slug"=>"postspost-idactionsaction-id-post", "parameters"=>[{"in"=>"path", "name"=>"action_id", "description"=>"Action GUID"}, {"in"=>"path", "name"=>"post_id", "description"=>"Post GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Perform", "Post", "Action"]}}, "/users/{user_id}/preferences"=>{"get"=>{"summary"=>"Get the user's preferences", "description"=>"Get a list of the user's preferences.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.", "operationId"=>"get-a-list-of-the-users-preferences-permissionsmust-be-logged-in-as-the-user-being-updated-or-have-t", "x-api-path-slug"=>"usersuser-idpreferences-get", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Preferences"]}, "put"=>{"summary"=>"Save the user's preferences", "description"=>"Save a list of the user's preferences.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.", "operationId"=>"save-a-list-of-the-users-preferences-permissionsmust-be-logged-in-as-the-user-being-updated-or-have-", "x-api-path-slug"=>"usersuser-idpreferences-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"List of preference object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Save", "Users", "Preferences"]}}, "/users/{user_id}/preferences/delete"=>{"post"=>{"summary"=>"Delete user's preferences", "description"=>"Delete a list of the user's preferences.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.", "operationId"=>"delete-a-list-of-the-users-preferences-permissionsmust-be-logged-in-as-the-user-being-updated-or-hav", "x-api-path-slug"=>"usersuser-idpreferencesdelete-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"List of preference object", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Preferences"]}}, "/users/{user_id}/preferences/{category}"=>{"get"=>{"summary"=>"List a user's preferences by category", "description"=>"Lists the current user's stored preferences in the given category.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.", "operationId"=>"lists-the-current-users-stored-preferences-in-the-given-category-permissionsmust-be-logged-in-as-the", "x-api-path-slug"=>"usersuser-idpreferencescategory-get", "parameters"=>[{"in"=>"path", "name"=>"category", "description"=>"The category of a group of preferences"}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Users", "Preferences", "By", "Category"]}}, "/users/{user_id}/preferences/{category}/name/{preference_name}"=>{"get"=>{"summary"=>"Get a specific user preference", "description"=>"Gets a single preference for the current user with the given category and name.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.", "operationId"=>"gets-a-single-preference-for-the-current-user-with-the-given-category-and-name-permissionsmust-be-lo", "x-api-path-slug"=>"usersuser-idpreferencescategorynamepreference-name-get", "parameters"=>[{"in"=>"path", "name"=>"category", "description"=>"The category of a group of preferences"}, {"in"=>"path", "name"=>"preference_name", "description"=>"The name of the preference"}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Specific", "User", "Preference"]}}, "/files"=>{"post"=>{"summary"=>"Upload a file", "description"=>"Uploads a file that can later be attached to a post.\n\nThis request can either be a multipart/form-data request with a channel_id, files and optional\nclient_ids defined in the FormData, or it can be a request with the channel_id and filename\ndefined as query parameters with the contents of a single file in the body of the request.\n\nOnly multipart/form-data requests are supported by server versions up to and including 4.7.\nServer versions 4.8 and higher support both types of requests.\n\n##### Permissions\nMust have `upload_file` permission.", "operationId"=>"uploads-a-file-that-can-later-be-attached-to-a-postthis-request-can-either-be-a-multipartformdata-re", "x-api-path-slug"=>"files-post", "parameters"=>[{"in"=>"formData", "name"=>"channel_id", "description"=>"The ID of the channel that this file will be uploaded to"}, {"in"=>"query", "name"=>"channel_id", "description"=>"The ID of the channel that this file will be uploaded to"}, {"in"=>"formData", "name"=>"client_ids", "description"=>"A unique identifier for the file that will be returned in the response"}, {"in"=>"query", "name"=>"filename", "description"=>"The ID of the channel that this file will be uploaded to"}, {"in"=>"formData", "name"=>"files", "description"=>"A file to be uploaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "File"]}}, "/files/{file_id}"=>{"get"=>{"summary"=>"Get a file", "description"=>"Gets a file that has been uploaded previously.\n##### Permissions\nMust have `read_channel` permission or be uploader of the file.", "operationId"=>"gets-a-file-that-has-been-uploaded-previously-permissionsmust-have-read-channel-permission-or-be-upl", "x-api-path-slug"=>"filesfile-id-get", "parameters"=>[{"in"=>"path", "name"=>"file_id", "description"=>"The ID of the file to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["File"]}}, "/files/{file_id}/thumbnail"=>{"get"=>{"summary"=>"Get a files thumbnail", "description"=>"Gets a file's thumbnail.\n##### Permissions\nMust have `read_channel` permission or be uploader of the file.", "operationId"=>"gets-a-files-thumbnail-permissionsmust-have-read-channel-permission-or-be-uploader-of-the-file", "x-api-path-slug"=>"filesfile-idthumbnail-get", "parameters"=>[{"in"=>"path", "name"=>"file_id", "description"=>"The ID of the file to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files", "Thumbnail"]}}, "/files/{file_id}/preview"=>{"get"=>{"summary"=>"Get a files preview", "description"=>"Gets a file's preview.\n##### Permissions\nMust have `read_channel` permission or be uploader of the file.", "operationId"=>"gets-a-files-preview-permissionsmust-have-read-channel-permission-or-be-uploader-of-the-file", "x-api-path-slug"=>"filesfile-idpreview-get", "parameters"=>[{"in"=>"path", "name"=>"file_id", "description"=>"The ID of the file to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files", "Preview"]}}, "/files/{file_id}/link"=>{"get"=>{"summary"=>"Get a public file link", "description"=>"Gets a public link for a file that can be accessed without logging into Mattermost.", "operationId"=>"gets-a-public-link-for-a-file-that-can-be-accessed-without-logging-into-mattermost", "x-api-path-slug"=>"filesfile-idlink-get", "parameters"=>[{"in"=>"path", "name"=>"file_id", "description"=>"The ID of the file to get a link for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Public", "File", "Link"]}}, "/files/{file_id}/info"=>{"get"=>{"summary"=>"Get metadata for a file", "description"=>"Gets a file's info.\n##### Permissions\nMust have `read_channel` permission or be uploader of the file.", "operationId"=>"gets-a-files-info-permissionsmust-have-read-channel-permission-or-be-uploader-of-the-file", "x-api-path-slug"=>"filesfile-idinfo-get", "parameters"=>[{"in"=>"path", "name"=>"file_id", "description"=>"The ID of the file info to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadataa", "File"]}}, "/jobs"=>{"get"=>{"summary"=>"Get the jobs.", "description"=>"Get a page of jobs. Use the query parameters to modify the behaviour of this endpoint.\n__Minimum server version: 4.1__\n##### Permissions\nMust have `manage_jobs` permission.", "operationId"=>"get-a-page-of-jobs-use-the-query-parameters-to-modify-the-behaviour-of-this-endpoint-minimum-server-", "x-api-path-slug"=>"jobs-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of jobs per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs."]}, "post"=>{"summary"=>"Create a new job.", "description"=>"Create a new job.\n__Minimum server version: 4.1__\n##### Permissions\nMust have `manage_jobs` permission.", "operationId"=>"create-a-new-job-minimum-server-version-41--permissionsmust-have-manage-jobs-permission", "x-api-path-slug"=>"jobs-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Job object to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Job."]}}, "/jobs/{job_id}"=>{"get"=>{"summary"=>"Get a job.", "description"=>"Gets a single job.\n__Minimum server version: 4.1__\n##### Permissions\nMust have `manage_jobs` permission.", "operationId"=>"gets-a-single-job-minimum-server-version-41--permissionsmust-have-manage-jobs-permission", "x-api-path-slug"=>"jobsjob-id-get", "parameters"=>[{"in"=>"path", "name"=>"job_id", "description"=>"Job GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job."]}}, "/jobs/{job_id}/cancel"=>{"post"=>{"summary"=>"Cancel a job.", "description"=>"Cancel a job.\n__Minimum server version: 4.1__\n##### Permissions\nMust have `manage_jobs` permission.", "operationId"=>"cancel-a-job-minimum-server-version-41--permissionsmust-have-manage-jobs-permission", "x-api-path-slug"=>"jobsjob-idcancel-post", "parameters"=>[{"in"=>"path", "name"=>"job_id", "description"=>"Job GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Job."]}}, "/jobs/type/{type}"=>{"get"=>{"summary"=>"Get the jobs of the given type.", "description"=>"Get a page of jobs of the given type. Use the query parameters to modify the behaviour of this endpoint.\n__Minimum server version: 4.1__\n##### Permissions\nMust have `manage_jobs` permission.", "operationId"=>"get-a-page-of-jobs-of-the-given-type-use-the-query-parameters-to-modify-the-behaviour-of-this-endpoi", "x-api-path-slug"=>"jobstypetype-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of jobs per page"}, {"in"=>"path", "name"=>"type", "description"=>"Job type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs", "Of", "Given", "Type."]}}, "/system/ping"=>{"get"=>{"summary"=>"Check system health", "description"=>"Check if the server is up and healthy based on the configuration setting `GoRoutineHealthThreshold`. If `GoRoutineHealthThreshold` and the number of goroutines on the server exceeds that threshold the server is considered unhealthy. If `GoRoutineHealthThreshold` is not set or the number of goroutines is below the threshold the server is considered healthy.\n__Minimum server version__: 3.10\n##### Permissions\nMust be logged in.", "operationId"=>"check-if-the-server-is-up-and-healthy-based-on-the-configuration-setting-goroutinehealththreshold-if", "x-api-path-slug"=>"systemping-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Check", "System", "Health"]}}, "/database/recycle"=>{"post"=>{"summary"=>"Recycle database connections", "description"=>"Recycle database connections by closing and reconnecting all connections to master and read replica databases.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"recycle-database-connections-by-closing-and-reconnecting-all-connections-to-master-and-read-replica-", "x-api-path-slug"=>"databaserecycle-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recycle", "Database", "Connections"]}}, "/email/test"=>{"post"=>{"summary"=>"Send a test email", "description"=>"Send a test email to make sure you have your email settings configured correctly. Optionally provide a configuration in the request body to test. If no valid configuration is present in the request body the current server configuration will be tested.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"send-a-test-email-to-make-sure-you-have-your-email-settings-configured-correctly-optionally-provide-", "x-api-path-slug"=>"emailtest-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Mattermost configuration", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Test", "Email"]}}, "/file/s3_test"=>{"post"=>{"summary"=>"Test AWS S3 connection", "description"=>"Send a test to validate if can connect to AWS S3. Optionally provide a configuration in the request body to test. If no valid configuration is present in the request body the current server configuration will be tested.\n##### Permissions\nMust have `manage_system` permission.\n__Minimum server version__: 4.8", "operationId"=>"send-a-test-to-validate-if-can-connect-to-aws-s3-optionally-provide-a-configuration-in-the-request-b", "x-api-path-slug"=>"files3-test-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Mattermost configuration", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "AWS", "S3", "Connection"]}}, "/config"=>{"get"=>{"summary"=>"Get configuration", "description"=>"Retrieve the current server configuration\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"retrieve-the-current-server-configuration-permissionsmust-have-manage-system-permission", "x-api-path-slug"=>"config-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration"]}, "put"=>{"summary"=>"Update configuration", "description"=>"Submit a new configuration for the server to use. As of server version 4.8, the `PluginSettings.EnableUploads` setting cannot be modified by this endpoint.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"submit-a-new-configuration-for-the-server-to-use-as-of-server-version-48-the-pluginsettingsenableupl", "x-api-path-slug"=>"config-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Mattermost configuration", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration"]}}, "/config/reload"=>{"post"=>{"summary"=>"Reload configuration", "description"=>"Reload the configuration file to pick up on any changes made to it.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"reload-the-configuration-file-to-pick-up-on-any-changes-made-to-it-permissionsmust-have-manage-syste", "x-api-path-slug"=>"configreload-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reload", "Configuration"]}}, "/config/client"=>{"get"=>{"summary"=>"Get client configuration", "description"=>"Get a subset of the server configuration needed by the client.\n##### Permissions\nNo permission required.", "operationId"=>"get-a-subset-of-the-server-configuration-needed-by-the-client-permissionsno-permission-required", "x-api-path-slug"=>"configclient-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Must be `old`, other formats not implemented yet"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Client", "Configuration"]}}, "/config/environment"=>{"get"=>{"summary"=>"Get configuration made through environment variables", "description"=>"Retrieve a json object mirroring the server configuration where fields are set to true\nif the corresponding config setting is set through an environment variable. Settings\nthat haven't been set through environment variables will be missing from the object.\n\n__Minimum server version__: 4.10\n\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"retrieve-a-json-object-mirroring-the-server-configuration-where-fields-are-set-to-trueif-the-corresp", "x-api-path-slug"=>"configenvironment-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration", "Made", "Through", "Environment", "Variables"]}}, "/license"=>{"post"=>{"summary"=>"Upload license file", "description"=>"Upload a license to enable enterprise features.\n\n__Minimum server version__: 4.0\n\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"upload-a-license-to-enable-enterprise-features-minimum-server-version--40-permissionsmust-have-manag", "x-api-path-slug"=>"license-post", "parameters"=>[{"in"=>"formData", "name"=>"license", "description"=>"The license to be uploaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "License", "File"]}, "delete"=>{"summary"=>"Remove license file", "description"=>"Remove the license file from the server. This will disable all enterprise features.\n\n__Minimum server version__: 4.0\n\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"remove-the-license-file-from-the-server-this-will-disable-all-enterprise-features-minimum-server-ver", "x-api-path-slug"=>"license-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "License", "File"]}}, "/license/client"=>{"get"=>{"summary"=>"Get client license", "description"=>"Get a subset of the server license needed by the client.\n##### Permissions\nNo permission required but having the `manage_system` permission returns more information.", "operationId"=>"get-a-subset-of-the-server-license-needed-by-the-client-permissionsno-permission-required-but-having", "x-api-path-slug"=>"licenseclient-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Must be `old`, other formats not implemented yet"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Client", "License"]}}, "/audits"=>{"get"=>{"summary"=>"Get audits", "description"=>"Get a page of audits for all users on the system, selected with `page` and `per_page` query parameters.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"get-a-page-of-audits-for-all-users-on-the-system-selected-with-page-and-per-page-query-parameters-pe", "x-api-path-slug"=>"audits-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of audits per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Audits"]}}, "/caches/invalidate"=>{"post"=>{"summary"=>"Invalidate all the caches", "description"=>"Purge all the in-memory caches for the Mattermost server. This can have a temporary negative effect on performance while the caches are re-populated.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"purge-all-the-inmemory-caches-for-the-mattermost-server-this-can-have-a-temporary-negative-effect-on", "x-api-path-slug"=>"cachesinvalidate-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invalidate", "", "Caches"]}}, "/logs"=>{"get"=>{"summary"=>"Get logs", "description"=>"Get a page of server logs, selected with `page` and `logs_per_page` query parameters.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"get-a-page-of-server-logs-selected-with-page-and-logs-per-page-query-parameters-permissionsmust-have", "x-api-path-slug"=>"logs-get", "parameters"=>[{"in"=>"query", "name"=>"logs_per_page", "description"=>"The number of logs per page"}, {"in"=>"query", "name"=>"page", "description"=>"The page to select"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logs"]}, "post"=>{"summary"=>"Add log message", "description"=>"Add log messages to the server logs.\n##### Permissions\nUsers with `manage_system` permission can log ERROR or DEBUG messages.\nLogged in users can log ERROR or DEBUG messages when `ServiceSettings.EnableDeveloper` is `true` or just DEBUG messages when `false`.\nNon-logged in users can log ERROR or DEBUG messages when `ServiceSettings.EnableDeveloper` is `true` and cannot log when `false`.", "operationId"=>"add-log-messages-to-the-server-logs-permissionsusers-with-manage-system-permission-can-log-error-or-", "x-api-path-slug"=>"logs-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Log", "Message"]}}, "/webrtc/token"=>{"get"=>{"summary"=>"Get WebRTC token", "description"=>"Get a valid WebRTC token, STUN and TURN server URLs along with TURN credentials to use with the Mattermost WebRTC service. See https://docs.mattermost.com/administration/config-settings.html#webrtc-beta for WebRTC configutation settings. The token returned is for the current user's session.\n##### Permissions\nMust be authenticated.", "operationId"=>"get-a-valid-webrtc-token-stun-and-turn-server-urls-along-with-turn-credentials-to-use-with-the-matte", "x-api-path-slug"=>"webrtctoken-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["WebRTC", "Token"]}}, "/analytics/old"=>{"get"=>{"summary"=>"Get analytics", "description"=>"Get some analytics data about the system. This endpoint uses the old format, the `/analytics` route is reserved for the new format when it gets implemented.\n\nThe returned JSON changes based on the `name` query parameter but is always key/value pairs.\n\n__Minimum server version__: 4.0\n\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"get-some-analytics-data-about-the-system-this-endpoint-uses-the-old-format-the-analytics-route-is-re", "x-api-path-slug"=>"analyticsold-get", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"Possible values are standard, post_counts_day, user_counts_with_posts_day or extra_counts"}, {"in"=>"query", "name"=>"team_id", "description"=>"The team ID to filter the data by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics"]}}, "/emoji"=>{"post"=>{"summary"=>"Create a custom emoji", "description"=>"Create a custom emoji for the team.\n##### Permissions\nMust be authenticated.", "operationId"=>"create-a-custom-emoji-for-the-team-permissionsmust-be-authenticated", "x-api-path-slug"=>"emoji-post", "parameters"=>[{"in"=>"formData", "name"=>"emoji", "description"=>"A JSON object containing a `name` field with the name of the emoji and a `creator_id` field with the id of the authenticated user"}, {"in"=>"formData", "name"=>"image", "description"=>"A file to be uploaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Emoji"]}, "get"=>{"summary"=>"Get a list of custom emoji", "description"=>"Get a page of metadata for custom emoji on the system. Since server version 4.7, sort using the `sort` query parameter.\n##### Permissions\nMust be authenticated.", "operationId"=>"get-a-page-of-metadata-for-custom-emoji-on-the-system-since-server-version-47-sort-using-the-sort-qu", "x-api-path-slug"=>"emoji-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of users per page"}, {"in"=>"query", "name"=>"sort", "description"=>"Either blank for no sorting or name to sort by emoji names"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Custom", "Emoji"]}}, "/emoji/{emoji_id}"=>{"get"=>{"summary"=>"Get a custom emoji", "description"=>"Get some metadata for a custom emoji.\n##### Permissions\nMust be authenticated.", "operationId"=>"get-some-metadata-for-a-custom-emoji-permissionsmust-be-authenticated", "x-api-path-slug"=>"emojiemoji-id-get", "parameters"=>[{"in"=>"path", "name"=>"emoji_id", "description"=>"Emoji GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Emoji"]}, "delete"=>{"summary"=>"Delete a custom emoji", "description"=>"Delete a custom emoji.\n##### Permissions\nMust have the `manage_team` or `manage_system` permissions or be the user who created the emoji.", "operationId"=>"delete-a-custom-emoji-permissionsmust-have-the-manage-team-or-manage-system-permissions-or-be-the-us", "x-api-path-slug"=>"emojiemoji-id-delete", "parameters"=>[{"in"=>"path", "name"=>"emoji_id", "description"=>"Emoji GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Emoji"]}}, "/emoji/name/{emoji_name}"=>{"get"=>{"summary"=>"Get a custom emoji by name", "description"=>"Get some metadata for a custom emoji using its name.\n##### Permissions\nMust be authenticated.\n\n__Minimum server version__: 4.7", "operationId"=>"get-some-metadata-for-a-custom-emoji-using-its-name-permissionsmust-be-authenticated-minimum-server-", "x-api-path-slug"=>"emojinameemoji-name-get", "parameters"=>[{"in"=>"path", "name"=>"emoji_name", "description"=>"Emoji name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Emoji", "By", "Name"]}}, "/emoji/{emoji_id}/image"=>{"get"=>{"summary"=>"Get custom emoji image", "description"=>"Get the image for a custom emoji.\n##### Permissions\nMust be authenticated.", "operationId"=>"get-the-image-for-a-custom-emoji-permissionsmust-be-authenticated", "x-api-path-slug"=>"emojiemoji-idimage-get", "parameters"=>[{"in"=>"path", "name"=>"emoji_id", "description"=>"Emoji GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Emoji", "Image"]}}, "/emoji/search"=>{"post"=>{"summary"=>"Search custom emoji", "description"=>"Search for custom emoji by name based on search criteria provided in the request body. A maximum of 200 results are returned.\n##### Permissions\nMust be authenticated.\n\n__Minimum server version__: 4.7", "operationId"=>"search-for-custom-emoji-by-name-based-on-search-criteria-provided-in-the-request-body-a-maximum-of-2", "x-api-path-slug"=>"emojisearch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Search criteria", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Custom", "Emoji"]}}, "/emoji/autocomplete"=>{"get"=>{"summary"=>"Autocomplete custom emoji", "description"=>"Get a list of custom emoji with names starting with or matching the provided name. Returns a maximum of 100 results.\n##### Permissions\nMust be authenticated.\n\n__Minimum server version__: 4.7", "operationId"=>"get-a-list-of-custom-emoji-with-names-starting-with-or-matching-the-provided-name-returns-a-maximum-", "x-api-path-slug"=>"emojiautocomplete-get", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"The emoji name to search"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autocomplete", "Custom", "Emoji"]}}, "/hooks/incoming"=>{"post"=>{"summary"=>"Create an incoming webhook", "description"=>"Create an incoming webhook for a channel.\n##### Permissions\n`manage_webhooks` for the channel the webhook is in.", "operationId"=>"create-an-incoming-webhook-for-a-channel-permissionsmanage-webhooks-for-the-channel-the-webhook-is-i", "x-api-path-slug"=>"hooksincoming-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Incoming webhook to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incoming", "Webhook"]}, "get"=>{"summary"=>"List incoming webhooks", "description"=>"Get a page of a list of incoming webhooks. Optionally filter for a specific team using query parameters.\n##### Permissions\n`manage_webhooks` for the system or `manage_webhooks` for the specific team.", "operationId"=>"get-a-page-of-a-list-of-incoming-webhooks-optionally-filter-for-a-specific-team-using-query-paramete", "x-api-path-slug"=>"hooksincoming-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of hooks per page"}, {"in"=>"query", "name"=>"team_id", "description"=>"The ID of the team to get hooks for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Incoming", "Webhooks"]}}, "/hooks/incoming/{hook_id}"=>{"get"=>{"summary"=>"Get an incoming webhook", "description"=>"Get an incoming webhook given the hook id.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.", "operationId"=>"get-an-incoming-webhook-given-the-hook-id-permissionsmanage-webhooks-for-system-or-manage-webhooks-f", "x-api-path-slug"=>"hooksincominghook-id-get", "parameters"=>[{"in"=>"path", "name"=>"hook_id", "description"=>"Incoming Webhook GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incoming", "Webhook"]}, "put"=>{"summary"=>"Update an incoming webhook", "description"=>"Update an incoming webhook given the hook id.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.", "operationId"=>"update-an-incoming-webhook-given-the-hook-id-permissionsmanage-webhooks-for-system-or-manage-webhook", "x-api-path-slug"=>"hooksincominghook-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Incoming webhook to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"hook_id", "description"=>"Incoming Webhook GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incoming", "Webhook"]}}, "/hooks/outgoing"=>{"post"=>{"summary"=>"Create an outgoing webhook", "description"=>"Create an outgoing webhook for a team.\n##### Permissions\n`manage_webhooks` for the team the webhook is in.", "operationId"=>"create-an-outgoing-webhook-for-a-team-permissionsmanage-webhooks-for-the-team-the-webhook-is-in", "x-api-path-slug"=>"hooksoutgoing-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Outgoing webhook to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Outgoing", "Webhook"]}, "get"=>{"summary"=>"List outgoing webhooks", "description"=>"Get a page of a list of outgoing webhooks. Optionally filter for a specific team or channel using query parameters.\n##### Permissions\n`manage_webhooks` for the system or `manage_webhooks` for the specific team/channel.", "operationId"=>"get-a-page-of-a-list-of-outgoing-webhooks-optionally-filter-for-a-specific-team-or-channel-using-que", "x-api-path-slug"=>"hooksoutgoing-get", "parameters"=>[{"in"=>"query", "name"=>"channel_id", "description"=>"The ID of the channel to get hooks for"}, {"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of hooks per page"}, {"in"=>"query", "name"=>"team_id", "description"=>"The ID of the team to get hooks for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Outgoing", "Webhooks"]}}, "/hooks/outgoing/{hook_id}"=>{"get"=>{"summary"=>"Get an outgoing webhook", "description"=>"Get an outgoing webhook given the hook id.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.", "operationId"=>"get-an-outgoing-webhook-given-the-hook-id-permissionsmanage-webhooks-for-system-or-manage-webhooks-f", "x-api-path-slug"=>"hooksoutgoinghook-id-get", "parameters"=>[{"in"=>"path", "name"=>"hook_id", "description"=>"Outgoing webhook GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Outgoing", "Webhook"]}, "delete"=>{"summary"=>"Delete an outgoing webhook", "description"=>"Delete an outgoing webhook given the hook id.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.", "operationId"=>"delete-an-outgoing-webhook-given-the-hook-id-permissionsmanage-webhooks-for-system-or-manage-webhook", "x-api-path-slug"=>"hooksoutgoinghook-id-delete", "parameters"=>[{"in"=>"path", "name"=>"hook_id", "description"=>"Outgoing webhook GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Outgoing", "Webhook"]}, "put"=>{"summary"=>"Update an outgoing webhook", "description"=>"Update an outgoing webhook given the hook id.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.", "operationId"=>"update-an-outgoing-webhook-given-the-hook-id-permissionsmanage-webhooks-for-system-or-manage-webhook", "x-api-path-slug"=>"hooksoutgoinghook-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Outgoing webhook to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"hook_id", "description"=>"outgoing Webhook GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Outgoing", "Webhook"]}}, "/hooks/outgoing/{hook_id}/regen_token"=>{"post"=>{"summary"=>"Regenerate the token for the outgoing webhook.", "description"=>"Regenerate the token for the outgoing webhook.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.", "operationId"=>"regenerate-the-token-for-the-outgoing-webhook-permissionsmanage-webhooks-for-system-or-manage-webhoo", "x-api-path-slug"=>"hooksoutgoinghook-idregen-token-post", "parameters"=>[{"in"=>"path", "name"=>"hook_id", "description"=>"Outgoing webhook GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regenerate", "Tokenthe", "Outgoing", "Webhook."]}}, "/saml/metadata"=>{"get"=>{"summary"=>"Get metadata", "description"=>"Get SAML metadata from the server. SAML must be configured properly.\n##### Permissions\nNo permission required.", "operationId"=>"get-saml-metadata-from-the-server-saml-must-be-configured-properly-permissionsno-permission-required", "x-api-path-slug"=>"samlmetadata-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata"]}}, "/saml/certificate/idp"=>{"post"=>{"summary"=>"Upload IDP certificate", "description"=>"Upload the IDP certificate to be used with your SAML configuration. This will also set the filename for the IdpCertificateFile setting in your `config.json`.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"upload-the-idp-certificate-to-be-used-with-your-saml-configuration-this-will-also-set-the-filename-f", "x-api-path-slug"=>"samlcertificateidp-post", "parameters"=>[{"in"=>"formData", "name"=>"certificate", "description"=>"The IDP certificate file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "IDP", "Certificate"]}, "delete"=>{"summary"=>"Remove IDP certificate", "description"=>"Delete the current IDP certificate being used with your SAML configuration. This will also disable SAML on your system as this certificate is required for SAML.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"delete-the-current-idp-certificate-being-used-with-your-saml-configuration-this-will-also-disable-sa", "x-api-path-slug"=>"samlcertificateidp-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "IDP", "Certificate"]}}, "/saml/certificate/public"=>{"post"=>{"summary"=>"Upload public certificate", "description"=>"Upload the public certificate to be used for encryption with your SAML configuration. This will also set the filename for the PublicCertificateFile setting in your `config.json`.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"upload-the-public-certificate-to-be-used-for-encryption-with-your-saml-configuration-this-will-also-", "x-api-path-slug"=>"samlcertificatepublic-post", "parameters"=>[{"in"=>"formData", "name"=>"certificate", "description"=>"The public certificate file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Public", "Certificate"]}, "delete"=>{"summary"=>"Remove public certificate", "description"=>"Delete the current public certificate being used with your SAML configuration. This will also disable encryption for SAML on your system as this certificate is required for that.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"delete-the-current-public-certificate-being-used-with-your-saml-configuration-this-will-also-disable", "x-api-path-slug"=>"samlcertificatepublic-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Public", "Certificate"]}}, "/saml/certificate/private"=>{"post"=>{"summary"=>"Upload private key", "description"=>"Upload the private key to be used for encryption with your SAML configuration. This will also set the filename for the PrivateKeyFile setting in your `config.json`.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"upload-the-private-key-to-be-used-for-encryption-with-your-saml-configuration-this-will-also-set-the", "x-api-path-slug"=>"samlcertificateprivate-post", "parameters"=>[{"in"=>"formData", "name"=>"certificate", "description"=>"The private key file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Private", "Key"]}, "delete"=>{"summary"=>"Remove private key", "description"=>"Delete the current private key being used with your SAML configuration. This will also disable encryption for SAML on your system as this key is required for that.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"delete-the-current-private-key-being-used-with-your-saml-configuration-this-will-also-disable-encryp", "x-api-path-slug"=>"samlcertificateprivate-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Private", "Key"]}}, "/saml/certificate/status"=>{"get"=>{"summary"=>"Get certificate status", "description"=>"Get the status of the uploaded certificates and keys in use by your SAML configuration.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"get-the-status-of-the-uploaded-certificates-and-keys-in-use-by-your-saml-configuration-permissionsmu", "x-api-path-slug"=>"samlcertificatestatus-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate", "Status"]}}, "/compliance/reports"=>{"post"=>{"summary"=>"Create report", "description"=>"Create and save a compliance report.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"create-and-save-a-compliance-report-permissionsmust-have-manage-system-permission", "x-api-path-slug"=>"compliancereports-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report"]}, "get"=>{"summary"=>"Get reports", "description"=>"Get a list of compliance reports previously created by page, selected with `page` and `per_page` query parameters.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"get-a-list-of-compliance-reports-previously-created-by-page-selected-with-page-and-per-page-query-pa", "x-api-path-slug"=>"compliancereports-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of reports per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reports"]}}, "/compliance/reports/{report_id}"=>{"get"=>{"summary"=>"Get a report", "description"=>"Get a compliance reports previously created.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"get-a-compliance-reports-previously-created-permissionsmust-have-manage-system-permission", "x-api-path-slug"=>"compliancereportsreport-id-get", "parameters"=>[{"in"=>"path", "name"=>"report_id", "description"=>"Compliance report GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Report"]}}, "/compliance/reports/{report_id}/download"=>{"get"=>{"summary"=>"Download a report", "description"=>"Download the full contents of a report as a file.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"download-the-full-contents-of-a-report-as-a-file-permissionsmust-have-manage-system-permission", "x-api-path-slug"=>"compliancereportsreport-iddownload-get", "parameters"=>[{"in"=>"path", "name"=>"report_id", "description"=>"Compliance report GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Download", "Report"]}}, "/ldap/sync"=>{"post"=>{"summary"=>"Sync with LDAP", "description"=>"Synchronize any user attribute changes in the configured AD/LDAP server with Mattermost.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"synchronize-any-user-attribute-changes-in-the-configured-adldap-server-with-mattermost-permissionsmu", "x-api-path-slug"=>"ldapsync-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sync", "LDAP"]}}, "/ldap/test"=>{"post"=>{"summary"=>"Test LDAP configuration", "description"=>"Test the current AD/LDAP configuration to see if the AD/LDAP server can be contacted successfully.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"test-the-current-adldap-configuration-to-see-if-the-adldap-server-can-be-contacted-successfully-perm", "x-api-path-slug"=>"ldaptest-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "LDAP", "Configuration"]}}, "/cluster/status"=>{"get"=>{"summary"=>"Get cluster status", "description"=>"Get a set of information for each node in the cluster, useful for checking the status and health of each node.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"get-a-set-of-information-for-each-node-in-the-cluster-useful-for-checking-the-status-and-health-of-e", "x-api-path-slug"=>"clusterstatus-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster", "Status"]}}, "/brand/image"=>{"get"=>{"summary"=>"Get brand image", "description"=>"Get the previously uploaded brand image. Returns 404 if no brand image has been uploaded.\n##### Permissions\nNo permission required.", "operationId"=>"get-the-previously-uploaded-brand-image-returns-404-if-no-brand-image-has-been-uploaded-permissionsn", "x-api-path-slug"=>"brandimage-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Brand", "Image"]}, "post"=>{"summary"=>"Upload brand image", "description"=>"Uploads a brand image.\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"uploads-a-brand-image-permissionsmust-have-manage-system-permission", "x-api-path-slug"=>"brandimage-post", "parameters"=>[{"in"=>"formData", "name"=>"image", "description"=>"The image to be uploaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Brand", "Image"]}}, "/commands"=>{"post"=>{"summary"=>"Create a command", "description"=>"Create a command for a team.\n##### Permissions\n`manage_slash_commands` for the team the command is in.", "operationId"=>"create-a-command-for-a-team-permissionsmanage-slash-commands-for-the-team-the-command-is-in", "x-api-path-slug"=>"commands-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"command to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Command"]}, "get"=>{"summary"=>"List commands for a team", "description"=>"List commands for a team.\n##### Permissions\n`manage_slash_commands` if need list custom commands.", "operationId"=>"list-commands-for-a-team-permissionsmanage-slash-commands-if-need-list-custom-commands", "x-api-path-slug"=>"commands-get", "parameters"=>[{"in"=>"query", "name"=>"custom_only", "description"=>"To get only the custom commands"}, {"in"=>"query", "name"=>"team_id", "description"=>"The team id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Commandsa", "Team"]}}, "/teams/{team_id}/commands/autocomplete"=>{"get"=>{"summary"=>"List autocomplete commands", "description"=>"List autocomplete commands in the team.\n##### Permissions\n`view_team` for the team.", "operationId"=>"list-autocomplete-commands-in-the-team-permissionsview-team-for-the-team", "x-api-path-slug"=>"teamsteam-idcommandsautocomplete-get", "parameters"=>[{"in"=>"path", "name"=>"team_id", "description"=>"Team GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Autocomplete", "Commands"]}}, "/commands/{command_id}"=>{"put"=>{"summary"=>"Update a command", "description"=>"Update a single command based on command id string and Command struct.\n##### Permissions\nMust have `manage_slash_commands` permission for the team the command is in.", "operationId"=>"update-a-single-command-based-on-command-id-string-and-command-struct-permissionsmust-have-manage-sl", "x-api-path-slug"=>"commandscommand-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"command_id", "description"=>"ID of the command to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Command"]}, "delete"=>{"summary"=>"Delete a command", "description"=>"Delete a command based on command id string.\n##### Permissions\nMust have `manage_slash_commands` permission for the team the command is in.", "operationId"=>"delete-a-command-based-on-command-id-string-permissionsmust-have-manage-slash-commands-permission-fo", "x-api-path-slug"=>"commandscommand-id-delete", "parameters"=>[{"in"=>"path", "name"=>"command_id", "description"=>"ID of the command to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Command"]}}, "/commands/{command_id}/regen_token"=>{"put"=>{"summary"=>"Generate a new token", "description"=>"Generate a new token for the command based on command id string.\n##### Permissions\nMust have `manage_slash_commands` permission for the team the command is in.", "operationId"=>"generate-a-new-token-for-the-command-based-on-command-id-string-permissionsmust-have-manage-slash-co", "x-api-path-slug"=>"commandscommand-idregen-token-put", "parameters"=>[{"in"=>"path", "name"=>"command_id", "description"=>"ID of the command to generate the new token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generate", "New", "Token"]}}, "/commands/execute"=>{"post"=>{"summary"=>"Execute a command", "description"=>"Execute a command on a team.\n##### Permissions\nMust have `use_slash_commands` permission for the team the command is in.", "operationId"=>"execute-a-command-on-a-team-permissionsmust-have-use-slash-commands-permission-for-the-team-the-comm", "x-api-path-slug"=>"commandsexecute-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"command to be executed", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execute", "Command"]}}, "/oauth/apps"=>{"post"=>{"summary"=>"Register OAuth app", "description"=>"Register an OAuth 2.0 client application with Mattermost as the service provider.\n##### Permissions\nMust have `manage_oauth` permission.", "operationId"=>"register-an-oauth-20-client-application-with-mattermost-as-the-service-provider-permissionsmust-have", "x-api-path-slug"=>"oauthapps-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"OAuth application to register", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "OAuth", "App"]}, "get"=>{"summary"=>"Get OAuth apps", "description"=>"Get a page of OAuth 2.0 client applications registered with Mattermost.\n##### Permissions\nWith `manage_oauth` permission, the apps registered by the logged in user are returned. With `manage_system_wide_oauth` permission, all apps regardless of creator are returned.", "operationId"=>"get-a-page-of-oauth-20-client-applications-registered-with-mattermost-permissionswith-manage-oauth-p", "x-api-path-slug"=>"oauthapps-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of apps per page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OAuth", "Apps"]}}, "/oauth/apps/{app_id}"=>{"get"=>{"summary"=>"Get an OAuth app", "description"=>"Get an OAuth 2.0 client application registered with Mattermost.\n##### Permissions\nIf app creator, must have `mange_oauth` permission otherwise `manage_system_wide_oauth` permission is required.", "operationId"=>"get-an-oauth-20-client-application-registered-with-mattermost-permissionsif-app-creator-must-have-ma", "x-api-path-slug"=>"oauthappsapp-id-get", "parameters"=>[{"in"=>"path", "name"=>"app_id", "description"=>"Application client id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OAuth", "App"]}, "put"=>{"summary"=>"Update an OAuth app", "description"=>"Update an OAuth 2.0 client application based on OAuth struct.\n##### Permissions\nIf app creator, must have `mange_oauth` permission otherwise `manage_system_wide_oauth` permission is required.", "operationId"=>"update-an-oauth-20-client-application-based-on-oauth-struct-permissionsif-app-creator-must-have-mang", "x-api-path-slug"=>"oauthappsapp-id-put", "parameters"=>[{"in"=>"path", "name"=>"app_id", "description"=>"Application client id"}, {"in"=>"body", "name"=>"body", "description"=>"OAuth application to update", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OAuth", "App"]}, "delete"=>{"summary"=>"Delete an OAuth app", "description"=>"Delete and unregister an OAuth 2.0 client application \n##### Permissions\nIf app creator, must have `mange_oauth` permission otherwise `manage_system_wide_oauth` permission is required.", "operationId"=>"delete-and-unregister-an-oauth-20-client-application--permissionsif-app-creator-must-have-mange-oaut", "x-api-path-slug"=>"oauthappsapp-id-delete", "parameters"=>[{"in"=>"path", "name"=>"app_id", "description"=>"Application client id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OAuth", "App"]}}, "/oauth/apps/{app_id}/regen_secret"=>{"post"=>{"summary"=>"Regenerate OAuth app secret", "description"=>"Regenerate the client secret for an OAuth 2.0 client application registered with Mattermost.\n##### Permissions\nIf app creator, must have `mange_oauth` permission otherwise `manage_system_wide_oauth` permission is required.", "operationId"=>"regenerate-the-client-secret-for-an-oauth-20-client-application-registered-with-mattermost-permissio", "x-api-path-slug"=>"oauthappsapp-idregen-secret-post", "parameters"=>[{"in"=>"path", "name"=>"app_id", "description"=>"Application client id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regenerate", "OAuth", "App", "Secret"]}}, "/oauth/apps/{app_id}/info"=>{"get"=>{"summary"=>"Get info on an OAuth app", "description"=>"Get public information about an OAuth 2.0 client application registered with Mattermost. The application's client secret will be blanked out.\n##### Permissions\nMust be authenticated.", "operationId"=>"get-public-information-about-an-oauth-20-client-application-registered-with-mattermost-the-applicati", "x-api-path-slug"=>"oauthappsapp-idinfo-get", "parameters"=>[{"in"=>"path", "name"=>"app_id", "description"=>"Application client id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Info", "On", "OAuth", "App"]}}, "/users/{user_id}/oauth/apps/authorized"=>{"get"=>{"summary"=>"Get authorized OAuth apps", "description"=>"Get a page of OAuth 2.0 client applications authorized to access a user's account.\n##### Permissions\nMust be authenticated as the user or have `edit_other_users` permission.", "operationId"=>"get-a-page-of-oauth-20-client-applications-authorized-to-access-a-users-account-permissionsmust-be-a", "x-api-path-slug"=>"usersuser-idoauthappsauthorized-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"The page to select"}, {"in"=>"query", "name"=>"per_page", "description"=>"The number of apps per page"}, {"in"=>"path", "name"=>"user_id", "description"=>"User GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorized", "OAuth", "Apps"]}}, "/elasticsearch/test"=>{"post"=>{"summary"=>"Test Elasticsearch configuration", "description"=>"Test the current Elasticsearch configuration to see if the Elasticsearch server can be contacted successfully.\nOptionally provide a configuration in the request body to test. If no valid configuration is present in the\nrequest body the current server configuration will be tested.\n\n__Minimum server version__: 4.1\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"test-the-current-elasticsearch-configuration-to-see-if-the-elasticsearch-server-can-be-contacted-suc", "x-api-path-slug"=>"elasticsearchtest-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "Elasticsearch", "Configuration"]}}, "/elasticsearch/purge_indexes"=>{"post"=>{"summary"=>"Purge all Elasticsearch indexes", "description"=>"Deletes all Elasticsearch indexes and their contents. After calling this endpoint, it is\nnecessary to schedule a new Elasticsearch indexing job to repopulate the indexes.\n__Minimum server version__: 4.1\n##### Permissions\nMust have `manage_system` permission.", "operationId"=>"deletes-all-elasticsearch-indexes-and-their-contents-after-calling-this-endpoint-it-isnecessary-to-s", "x-api-path-slug"=>"elasticsearchpurge-indexes-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Purge", "", "Elasticsearch", "Indexes"]}}, "/data_retention/policy"=>{"get"=>{"summary"=>"Get the data retention policy details.", "description"=>"Gets the current data retention policy details from the server, including what data should be purged and the cutoff times for each data type that should be purged.\n__Minimum server version__: 4.3\n##### Permissions\nRequires an active session but no other permissions.", "operationId"=>"gets-the-current-data-retention-policy-details-from-the-server-including-what-data-should-be-purged-", "x-api-path-slug"=>"data-retentionpolicy-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data", "Retention", "Policy", "Details."]}}, "/plugins"=>{"post"=>{"summary"=>"Upload plugin", "description"=>"Upload a plugin compressed in a .tar.gz file. Plugins and plugin uploads must be enabled in the server's config settings.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 4.4", "operationId"=>"upload-a-plugin-compressed-in-a-targz-file-plugins-and-plugin-uploads-must-be-enabled-in-the-servers", "x-api-path-slug"=>"plugins-post", "parameters"=>[{"in"=>"formData", "name"=>"plugin", "description"=>"The plugin image to be uploaded"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Plugin"]}, "get"=>{"summary"=>"Get plugins", "description"=>"Get a list of inactive and a list of active plugin manifests. Plugins must be enabled in the server's config settings.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 4.4", "operationId"=>"get-a-list-of-inactive-and-a-list-of-active-plugin-manifests-plugins-must-be-enabled-in-the-servers-", "x-api-path-slug"=>"plugins-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Plugins"]}}, "/plugins/{plugin_id}"=>{"delete"=>{"summary"=>"Remove plugin", "description"=>"Remove the plugin with the provided ID from the server. All plugin files are deleted. Plugins must be enabled in the server's config settings.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 4.4", "operationId"=>"remove-the-plugin-with-the-provided-id-from-the-server-all-plugin-files-are-deleted-plugins-must-be-", "x-api-path-slug"=>"pluginsplugin-id-delete", "parameters"=>[{"in"=>"path", "name"=>"plugin_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Plugin"]}}, "/plugins/{plugin_id}/activate"=>{"post"=>{"summary"=>"Activate plugin", "description"=>"Activate a previously uploaded plugin. Plugins must be enabled in the server's config settings.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 4.4", "operationId"=>"activate-a-previously-uploaded-plugin-plugins-must-be-enabled-in-the-servers-config-settings-permiss", "x-api-path-slug"=>"pluginsplugin-idactivate-post", "parameters"=>[{"in"=>"path", "name"=>"plugin_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activate", "Plugin"]}}, "/plugins/{plugin_id}/deactivate"=>{"post"=>{"summary"=>"Deactivate plugin", "description"=>"Deactivate a previously activated plugin. Plugins must be enabled in the server's config settings.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 4.4", "operationId"=>"deactivate-a-previously-activated-plugin-plugins-must-be-enabled-in-the-servers-config-settings-perm", "x-api-path-slug"=>"pluginsplugin-iddeactivate-post", "parameters"=>[{"in"=>"path", "name"=>"plugin_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deactivate", "Plugin"]}}, "/plugins/webapp"=>{"get"=>{"summary"=>"Get webapp plugins", "description"=>"Get a list of web app plugins installed and activated on the server.\n\n##### Permissions\nNo permissions required.\n\n__Minimum server version__: 4.4", "operationId"=>"get-a-list-of-web-app-plugins-installed-and-activated-on-the-server-permissionsno-permissions-requir", "x-api-path-slug"=>"pluginswebapp-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webapp", "Plugins"]}}, "/roles/{role_id}"=>{"get"=>{"summary"=>"Get a role", "description"=>"Get a role from the provided role id.\n\n##### Permissions\nRequires an active session but no other permissions.\n\n__Minimum server version__: 4.9", "operationId"=>"get-a-role-from-the-provided-role-id-permissionsrequires-an-active-session-but-no-other-permissions-", "x-api-path-slug"=>"rolesrole-id-get", "parameters"=>[{"in"=>"path", "name"=>"role_id", "description"=>"Role GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Role"]}}, "/roles/name/{role_name}"=>{"get"=>{"summary"=>"Get a role", "description"=>"Get a role from the provided role name.\n\n##### Permissions\nRequires an active session but no other permissions.\n\n__Minimum server version__: 4.9", "operationId"=>"get-a-role-from-the-provided-role-name-permissionsrequires-an-active-session-but-no-other-permission", "x-api-path-slug"=>"rolesnamerole-name-get", "parameters"=>[{"in"=>"path", "name"=>"role_name", "description"=>"Role Name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Role"]}}, "/roles/{role_id}/patch"=>{"put"=>{"summary"=>"Patch a role", "description"=>"Partially update a role by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n\n##### Permissions\n`manage_system` permission is required.\n\n__Minimum server version__: 4.9", "operationId"=>"partially-update-a-role-by-providing-only-the-fields-you-want-to-update-omitted-fields-will-not-be-u", "x-api-path-slug"=>"rolesrole-idpatch-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Role object to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"role_id", "description"=>"Role GUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Role"]}}, "/roles/names"=>{"post"=>{"summary"=>"Get a list of roles by name", "description"=>"Get a list of roles from their names.\n\n##### Permissions\nRequires an active session but no other permissions.\n\n__Minimum server version__: 4.9", "operationId"=>"get-a-list-of-roles-from-their-names-permissionsrequires-an-active-session-but-no-other-permissions-", "x-api-path-slug"=>"rolesnames-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"List of role names", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Roles", "By", "Name"]}}}}, "apis"=>{"name"=>"Mattermost", "x-slug"=>"mattermost", "description"=>"Open source, private cloud Slack-alternative, Workplace messaging for web, PCs and phones. MIT-licensed. Hundreds of contributors. 14 languages. Secure, configurable, and scalable from teams to the enterprise.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/mattermost-logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"95684", "tags"=>"API Provider,API Service Provider,Cloud,Enterprise,Networks,Profiles,Relative Data,SaaS,Service API,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"mattermost/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Mattermost API", "x-api-slug"=>"mattermost-api", "description"=>"Open source, private cloud Slack-alternative, Workplace messaging for web, PCs and phones. MIT-licensed. Hundreds of contributors. 14 languages. Secure, configurable, and scalable from teams to the enterprise.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/mattermost-logo.png", "humanURL"=>"https://mattermost.com", "baseURL"=>"https://your-mattermost-url.com//api/v4", "tags"=>"API Provider,API Service Provider,Cloud,Enterprise,Networks,Profiles,Relative Data,SaaS,Service API,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/mattermost/mattermost-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://about.mattermost.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"https://about.mattermost.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/mattermost"}, {"type"=>"x-developer", "url"=>"https://api.mattermost.com/"}, {"type"=>"x-github", "url"=>"https://github.com/mattermost"}, {"type"=>"x-pricing", "url"=>"https://about.mattermost.com/pricing/"}, {"type"=>"x-security", "url"=>"https://docs.mattermost.com/overview/security.html"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/mattermosthq"}, {"type"=>"x-webhook", "url"=>"https://docs.mattermost.com/developer/webhooks-incoming.html"}, {"type"=>"x-website", "url"=>"https://mattermost.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-marketplace-metering-service{"aws-marketplace-metering-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Marketplace Metering Service", "x-complete"=>1, "info"=>{"title"=>"AWS Marketplace Metering Service API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=MeterUsage"=>{"get"=>{"summary"=>"Meter Usage", "description"=>"API to emit metering records.", "operationId"=>"MeterUsage", "x-api-path-slug"=>"actionmeterusage-get", "parameters"=>[{"in"=>"query", "name"=>"DryRun", "description"=>"Checks whether you have the permissions required for the action, but does not make the request", "type"=>"string"}, {"in"=>"query", "name"=>"ProductCode", "description"=>"Product code is used to uniquely identify a product in AWS Marketplace", "type"=>"string"}, {"in"=>"query", "name"=>"Timestamp", "description"=>"Timestamp of the hour, recorded in UTC", "type"=>"string"}, {"in"=>"query", "name"=>"UsageDimension", "description"=>"It will be one of the fcp dimension name provided during the publishing of the product", "type"=>"string"}, {"in"=>"query", "name"=>"UsageQuantity", "description"=>"Consumption value for the hour", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meter Usage"]}}}}, "apis"=>{"name"=>"AWS Marketplace Metering Service", "x-slug"=>"aws-marketplace-metering-service", "description"=>"AWS Marketplace provides a new sales channel for ISVs and Consulting Partners to sell their solutions to AWS customers. We make it easy for customers to find, buy, deploy and manage software solutions, including SaaS, in a matter of minutes. AWS Marketplace sellers can use this API to submit usage data for custom usage dimensions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-marketplace-icon.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Applications,Marketplace,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-marketplace-metering-service/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Marketplace Metering Service API", "x-api-slug"=>"aws-marketplace-metering-service-api", "description"=>"AWS Marketplace provides a new sales channel for ISVs and Consulting Partners to sell their solutions to AWS customers. We make it easy for customers to find, buy, deploy and manage software solutions, including SaaS, in a matter of minutes. AWS Marketplace sellers can use this API to submit usage data for custom usage dimensions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-marketplace-icon.jpg", "humanURL"=>"https://aws.amazon.com/marketplace/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Applications,Marketplace,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-marketplace-metering-service/actionmeterusage-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-marketplace-metering-service/aws-marketplace-metering-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/marketplacemetering/latest/APIReference/API_MeterUsage.html"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/marketplace/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
barclays{"barclays-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Barclays", "x-complete"=>1, "info"=>{"title"=>"Barclays", "description"=>"this-is-an-openapi-definition-for-the-standard-set-of-open-banking-httpopenbankingapis-io-apis-for-barclays-", "termsOfService"=>"https://www.openbanking.org.uk/open-licence/", "contact"=>{"name"=>"API Evangelist", "url"=>"https://apievangelist.com", "email"=>"info@apievangelist.com"}, "version"=>"1.0.0"}, "host"=>"atlas.api.barclays", "basePath"=>"open-banking/v2.1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"atms/"=>{"get"=>{"summary"=>"Get ATMs", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can provide multiple ATMs.", "operationId"=>"getATMS", "x-api-path-slug"=>"atms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Atms"]}}, "branches/"=>{"get"=>{"summary"=>"Get Branches", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple branches.", "operationId"=>"getBranches", "x-api-path-slug"=>"branches-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branches"]}}, "personal-current-accounts/"=>{"get"=>{"summary"=>"Get Current Personal Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple PCA products.", "operationId"=>"getCurrentPersonalAccounts", "x-api-path-slug"=>"personalcurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Personal", "Current", "Accounts"]}}, "business-current-accounts/"=>{"get"=>{"summary"=>"Get Current Business Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple BCA products.", "operationId"=>"getCurentBusinessAccounts", "x-api-path-slug"=>"businesscurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Business", "Current", "Accounts"]}}, "unsecured-sme-loans/"=>{"get"=>{"summary"=>"Get Unsecured SME Loans", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Unsecured Loan products.", "operationId"=>"pathOperation", "x-api-path-slug"=>"unsecuredsmeloans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsecured", "Sme", "Loans"]}}, "commercial-credit-cards/"=>{"get"=>{"summary"=>"Get Commercial Credit Cards", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Commercial Credit Card products.", "operationId"=>"getCommercialCreditCards", "x-api-path-slug"=>"commercialcreditcards-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commercial", "Credit", "Cards"]}}}}, "apis"=>{"name"=>"Barclays", "x-slug"=>"barclays", "description"=>"Barclays is a British multinational bank and financial services company headquartered in London. It is a universal bank with global reach, offering products and services across personal, corporate and investment banking, credit cards and wealth management. It has operations in over 40 countries and employs approximately 120,000 people. Barclays is organised into four core businesses: Personal & Corporate (Personal Banking, Corporate Banking, Wealth & Investment Management), Barclaycard, Investment Banking and Africa.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/barclays-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"77947", "tags"=>"API Provider,Banking,Finance,Financial Services,General Data,Profiles,Relative Data,UK Banks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"barclays/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Barclays", "x-api-slug"=>"barclays", "description"=>"Barclays is a British multinational bank and financial services company headquartered in London. It is a universal bank with global reach, offering products and services across personal, corporate and investment banking, credit cards and wealth management. It has operations in over 40 countries and employs approximately 120,000 people. Barclays is organised into four core businesses: Personal & Corporate (Personal Banking, Corporate Banking, Wealth & Investment Management), Barclaycard, Investment Banking and Africa.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/barclays-logo.png", "humanURL"=>"https://barclays.com", "baseURL"=>"https://atlas.api.barclays/open-banking/v2.1/", "tags"=>"API Provider,Banking,Finance,Financial Services,General Data,Profiles,Relative Data,UK Banks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/barclays/commercialcreditcards-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/barclays/barclays-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://developer.barclays.com/documentation/36324e85-05dc-4ffd-9301-0d0cf161e382.bdn/api#authentication"}, {"type"=>"x-code", "url"=>"https://developer.barclays.com/catalogue/sdk"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/barclays-plc"}, {"type"=>"x-developer", "url"=>"https://developer.barclays.com/"}, {"type"=>"x-documentation", "url"=>"https://developer.barclays.com/catalogue/api"}, {"type"=>"x-documentation", "url"=>"https://developer.barclays.com/documentation/36324e85-05dc-4ffd-9301-0d0cf161e382.bdn/api"}, {"type"=>"x-privacy-policy", "url"=>"https://developer.barclays.com/bdn/#/home/landing/Barclays_Developer_Privacy_Policy.htm"}, {"type"=>"x-selfservice-registration", "url"=>"https://developer.barclays.com/bdn/#/home/signup"}, {"type"=>"x-terms-of-service", "url"=>"https://developer.barclays.com/bdn/#/home/landing/Barclays_Developer_Agreement.htm"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Barclays"}, {"type"=>"x-website", "url"=>"https://barclays.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
usa-gov-corporate-consumer-contact-information{"usa-gov-corporate-consumer-contact-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"USA.Gov Corporate Consumer Contact Information", "x-complete"=>1, "info"=>{"title"=>"USA.Gov Corporate Consumer Contact Information API", "description"=>"we-make-the-corporate-consumer-contact-listing-found-in-the-consumer-action-handbook-pdf-available-via-a-rest-api--the-api-programmatically-returns-all-of-the-information-contained-in-the-directory-or-you-can-query-the-api-to-return-just-a-subset-of-the-available-information-", "termsOfService"=>"https://github.com/usagov/Corporate-Consumer-Contact-API-Documentation#terms-of-service", "contact"=>{"name"=>"USA.Gov Developers", "email"=>"usagov-developers@gsa.gov"}, "version"=>"1.0.0"}, "host"=>"www.usa.gov", "basePath"=>"api/USAGovAPI/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/contacts.{format}/contacts"=>{"get"=>{"summary"=>"Get Contacts", "description"=>"Contacts is a general purpose call that, by default, will return all of the corporate directory records. However, you can pass parameters into the contacts call that allow you to filter the records returned by the API in powerful ways.", "operationId"=>"getContacts", "x-api-path-slug"=>"contacts-formatcontacts-get", "parameters"=>[{"in"=>"query", "name"=>"query_filter", "description"=>"Return only corporate directory records that meet the criteria you enter into this parameter", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"result_filter", "description"=>"Return only the fields listed here (separated by |) as opposed to every field in each directory record", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"sort", "description"=>"Allows you to specify the sort order of the returned agency directory records", "type"=>"string", "format"=>"string"}, {"in"=>"header", "name"=>"X-Range", "description"=>"You can limit the results returned by the API by including an X-Range HTTP header in your GET request, with a value of items=x to y, where x is the lower limit and y is the upper limit of the results to be returned", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}}, "/contacts.{format}/contacts/{id}"=>{"get"=>{"summary"=>"Get Contact", "description"=>"The Contact call will let you access an individual corporation's information by including its unique identifier in the call.", "operationId"=>"getContact", "x-api-path-slug"=>"contacts-formatcontactsid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}}}}, "apis"=>{"name"=>"USA.Gov Corporate Consumer Contact Information", "x-slug"=>"usa-gov-corporate-consumer-contact-information", "description"=>"We make the Corporate Consumer Contact listing found in the Consumer Action Handbook (PDF) available via a REST API. The API programmatically returns all of the information contained in the directory, or you can query the API to return just a subset of the available information.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/usa-gov-logo.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"Federal Government GSA,General Data,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"usa-gov-corporate-consumer-contact-information/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"USA.Gov Corporate Consumer Contact API", "x-api-slug"=>"usa-gov-corporate-consumer-contact-api", "description"=>"We make the Corporate Consumer Contact listing found in theConsumer Action Handbook (PDF)available via a REST API. The API programmatically returns all of the information contained in the directory, or you can query the API to return just a subset of the available information.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/usa-gov-logo.png", "humanURL"=>"https://github.com/usagov/Corporate-Consumer-Contact-API-Documentation", "baseURL"=>"https://www.usa.gov/api/USAGovAPI/", "tags"=>"Federal Government GSA,General Data,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/usa-gov-corporate-consumer-contact-information/contacts-formatcontactsid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/usa-gov-corporate-consumer-contact-information/usa-gov-corporate-consumer-contact-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-terms-of-service", "url"=>"https://www.usa.gov/developer-terms-of-service"}, {"type"=>"x-website", "url"=>"https://github.com/usagov/Corporate-Consumer-Contact-API-Documentation"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-qpx-express{"apis"=>{"name"=>"Google QPX Express", "x-slug"=>"google-qpx-express", "description"=>"QPX Express is suited for companies that want to provide airfare pricing and shopping service for their customers. The API returns full display and booking information with real-time availability through an easy-to-implement JSON interface. The QPX Express self-service, pay-as-you-go model offers business flexibility and new opportunities for innovation.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/qpx-express-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Airlines,API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Service API,Stack Network,Transportation,Travel", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-qpx-express/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google QPX Express API", "x-api-slug"=>"google-qpx-express-api", "description"=>"QPX Express is suited for companies that want to provide airfare pricing and shopping service for their customers. The API returns full display and booking information with real-time availability through an easy-to-implement JSON interface. The QPX Express self-service, pay-as-you-go model offers business flexibility and new opportunities for innovation.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/qpx-express-logo.png", "humanURL"=>"https://developers.google.com/qpx-express/", "baseURL"=>"://www.googleapis.com//qpxExpress/v1/trips", "tags"=>"Airlines,API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Service API,Stack Network,Transportation,Travel", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-qpx-express/google-qpx-express-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://developers.google.com/qpx-express/v1/how-tos/authorizing"}, {"type"=>"x-documentation", "url"=>"https://developers.google.com/qpx-express/v1/"}, {"type"=>"x-faq", "url"=>"https://developers.google.com/qpx-express/faq"}, {"type"=>"x-pricing", "url"=>"https://developers.google.com/qpx-express/v1/pricing"}, {"type"=>"x-website", "url"=>"https://developers.google.com/qpx-express/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "google-qpx-express-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google QPX Express", "x-complete"=>1, "info"=>{"title"=>"QPX Express", "description"=>"finds-the-least-expensive-flights-between-an-origin-and-a-destination-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"www.googleapis.com", "basePath"=>"/qpxExpress/v1/trips", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/search"=>{"post"=>{"summary"=>"Search Flights", "description"=>"Returns a list of flights.", "operationId"=>"qpxExpress.trips.search", "x-api-path-slug"=>"search-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Flights"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bc-route-planner{"bc-route-planner-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"BC Route Planner", "x-complete"=>1, "info"=>{"title"=>"BC Route Planner", "description"=>"the-bc-route-planner-is-a-rest-web-service-that-offers-vehicle-route-plans-that-are-based-on-the-bc-digital-road-atlas-dra--the-bc-route-planner-computes-the-shortest-or-fastest-route-between-start-and-end-points-and-returns-the-route-distance-time-and-directions-", "termsOfService"=>"http://www.data.gov.bc.ca/local/dbc/docs/license/API_Terms_of_Use.pdf", "contact"=>{"name"=>"Data BC", "url"=>"https://forms.gov.bc.ca/databc-contact-us/", "email"=>"DataBCBA@gov.bc.ca"}, "version"=>"1.2.0"}, "host"=>"router.api.gov.bc.ca", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/directions.{outputFormat}"=>{"get"=>{"summary"=>"Get the directions, path, distance and travel time between a series of geographic points", "description"=>"Represents the turn-by-turn directions, geometry, distance, and time of the shortest path or fastest path between given start and end points", "operationId"=>"represents-the-turnbyturn-directions-geometry-distance-and-time-of-the-shortest-path-or-fastest-path", "x-api-path-slug"=>"directions-outputformat-get", "parameters"=>[{"in"=>"query", "name"=>"criteria", "description"=>"Routing criteria to optimize (e"}, {"in"=>"query", "name"=>"distanceUnit", "description"=>"distance unit of measure (e"}, {"in"=>"path", "name"=>"outputFormat", "description"=>"Format of representation"}, {"in"=>"query", "name"=>"outputSRS", "description"=>"The EPSG code of the spatial reference system (SRS) to use for output geometries"}, {"in"=>"query", "name"=>"points", "description"=>"Example: -123"}, {"in"=>"query", "name"=>"routeDescription", "description"=>"Route description (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Directions", "OutputFormat"]}}, "/distance.{outputFormat}"=>{"get"=>{"summary"=>"Get distance and travel time between two geographic points", "description"=>"Represents the distance and time of the shortest or fastest path between given start and end points.", "operationId"=>"represents-the-distance-and-time-of-the-shortest-or-fastest-path-between-given-start-and-end-points-", "x-api-path-slug"=>"distance-outputformat-get", "parameters"=>[{"in"=>"query", "name"=>"criteria", "description"=>"Routing criteria to optimize (e"}, {"in"=>"query", "name"=>"distanceUnit", "description"=>"distance unit of measure (e"}, {"in"=>"path", "name"=>"outputFormat", "description"=>"Format of representation"}, {"in"=>"query", "name"=>"outputSRS", "description"=>"The EPSG code of the spatial reference system (SRS) to use for output geometries"}, {"in"=>"query", "name"=>"points", "description"=>"Example: -123"}, {"in"=>"query", "name"=>"routeDescription", "description"=>"Route description (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Distance", "OutputFormat"]}}, "/distance/betweenPairs.{outputFormat}"=>{"get"=>{"summary"=>"Get distance and travel time between each pair of geographic points", "description"=>"Represents the distance and time of the shortest or fastest paths between all pairs of fromPoints and toPoints. The number of fromPoints times the number of toPoints should not exceed 100 or the request will time out.", "operationId"=>"represents-the-distance-and-time-of-the-shortest-or-fastest-paths-between-all-pairs-of-frompoints-an", "x-api-path-slug"=>"distancebetweenpairs-outputformat-get", "parameters"=>[{"in"=>"query", "name"=>"criteria", "description"=>"Routing criteria to optimize (e"}, {"in"=>"query", "name"=>"distanceUnit", "description"=>"distance unit of measure (e"}, {"in"=>"query", "name"=>"fromPoints", "description"=>"Example: -123"}, {"in"=>"path", "name"=>"outputFormat", "description"=>"Format of representation"}, {"in"=>"query", "name"=>"outputSRS", "description"=>"The EPSG code of the spatial reference system (SRS) to use for output geometries"}, {"in"=>"query", "name"=>"routeDescription", "description"=>"Route description (e"}, {"in"=>"query", "name"=>"toPoints", "description"=>"Example: -124"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Distance", "BetweenPairs", "OutputFormat"]}}, "/route.{outputFormat}"=>{"get"=>{"summary"=>"Get the path, distance and travel time between a series of geographic points", "description"=>"Represents the geometry, distance, and time of the shortest or fastest path between given start and end points.", "operationId"=>"represents-the-geometry-distance-and-time-of-the-shortest-or-fastest-path-between-given-start-and-en", "x-api-path-slug"=>"route-outputformat-get", "parameters"=>[{"in"=>"query", "name"=>"criteria", "description"=>"Routing criteria to optimize (e"}, {"in"=>"query", "name"=>"distanceUnit", "description"=>"distance unit of measure (e"}, {"in"=>"path", "name"=>"outputFormat", "description"=>"Format of representation"}, {"in"=>"query", "name"=>"outputSRS", "description"=>"The EPSG code of the spatial reference system (SRS) to use for output geometries"}, {"in"=>"query", "name"=>"points", "description"=>"Example: -123"}, {"in"=>"query", "name"=>"routeDescription", "description"=>"Route description (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route", "OutputFormat"]}}}}, "apis"=>{"name"=>"BC Route Planner", "x-slug"=>"bc-route-planner", "description"=>"The BC Route Planner is a REST web service that offers vehicle route plans that are based on the BC Digital Road Atlas (DRA). The BC Route Planner computes the shortest or fastest route between start and end points and returns the route, distance, time, and directions.", "image"=>"", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,Locations,Profiles,Routes,Routes,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bc-route-planner/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"BC Route Planner", "x-api-slug"=>"bc-route-planner", "description"=>"The BC Route Planner is a REST web service that offers vehicle route plans that are based on the BC Digital Road Atlas (DRA). The BC Route Planner computes the shortest or fastest route between start and end points and returns the route, distance, time, and directions.", "image"=>"", "humanURL"=>"https://catalogue.data.gov.bc.ca/dataset/bc-route-planner", "baseURL"=>"https://router.api.gov.bc.ca//", "tags"=>"API Provider,Locations,Profiles,Routes,Routes,Service API", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bc-route-planner/route-outputformat-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bc-route-planner/bc-route-planner-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://catalogue.data.gov.bc.ca/dataset/bc-route-planner"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
tigertext{"tiger-connect-message-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"TigerText", "x-complete"=>1, "info"=>{"title"=>"Tiger Connect Message API", "description"=>"the-message-system-for-tigerconnect-messaging-platform-", "termsOfService"=>"http://www.tigertext.com/developer-terms-of-use", "contact"=>{"name"=>"TigerText", "url"=>"http://www.tigertext.com/supportform/", "email"=>"info@tigertext.com"}, "version"=>"v2"}, "host"=>"developer.tigertext.me", "basePath"=>"/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/message/"=>{"post"=>{"summary"=>"Send a message to a User or Group.", "description"=>"Send a message to a User or Group. The parameters to be included either on the JSON object or the POST body itself. If no recipient is found, a new account is created and the message is sent to the associated email or phone number if available.", "operationId"=>"sendMessage", "x-api-path-slug"=>"message-post", "parameters"=>[{"in"=>"formData", "name"=>"body", "description"=>"The message body"}, {"in"=>"formData", "name"=>"data", "description"=>"A JSON Array of user-defined datum elements, each one with the following fields, if no data then this will be empty"}, {"in"=>"formData", "name"=>"dor", "description"=>"Boolean value indicating that the message will be deleted on read"}, {"in"=>"query", "name"=>"recipient", "description"=>"The recipient User or Group based on address encoding"}, {"in"=>"formData", "name"=>"recipient_organization", "description"=>"The recipient organization token"}, {"in"=>"formData", "name"=>"sender_organization", "description"=>"The sender User organization token"}, {"in"=>"formData", "name"=>"ttl", "description"=>"An integer value with the number of minutes until the message expires"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}}, "/message/status/"=>{"put"=>{"summary"=>"Update the status of a message or several messages.", "description"=>"Update the status of a message or several messages.", "operationId"=>"updateMessageStatus", "x-api-path-slug"=>"messagestatus-put", "parameters"=>[{"in"=>"formData", "name"=>"delivered", "description"=>"A list of message tokens to set status to Delivered"}, {"in"=>"formData", "name"=>"read", "description"=>"A list of message tokens to set status to Read"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Status"]}}, "/message/typing/"=>{"get"=>{"summary"=>"Notify a recipient that a particular User is typing in a conversation.", "description"=>"Notify a recipient that a particular User is typing in a conversation.", "operationId"=>"typingMessage", "x-api-path-slug"=>"messagetyping-get", "parameters"=>[{"in"=>"query", "name"=>"recipient", "description"=>"The recipient is either another User or Group using address encoding"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Typing"]}}, "/message/typing/{recipient_address}/"=>{"delete"=>{"summary"=>"Notify a recipient that the User is no longer typing in a conversation.", "description"=>"Notify a recipient that the User is no longer typing in a conversation. The recipient is either another User or Group using address encoding.", "operationId"=>"deleteMessageTyping", "x-api-path-slug"=>"messagetypingrecipient-address-delete", "parameters"=>[{"in"=>"path", "name"=>"recipient_address", "description"=>"The recipient address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Typing", "Recipient", "Address"]}}, "/message/{message_token}/"=>{"delete"=>{"summary"=>"Recalls the message with the following message token.", "description"=>"Recalls the message with the following message token. If the message was already recalled, no error is reported.", "operationId"=>"deleteMessage", "x-api-path-slug"=>"messagemessage-token-delete", "parameters"=>[{"in"=>"path", "name"=>"message_token", "description"=>"The message token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Message", "Token"]}, "get"=>{"summary"=>"Get information about a message", "description"=>"Get information about a message", "operationId"=>"getMessage", "x-api-path-slug"=>"messagemessage-token-get", "parameters"=>[{"in"=>"path", "name"=>"message_token", "description"=>"The message token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Message", "Token"]}}, "/message/{message_token}/attachment/1/"=>{"get"=>{"summary"=>"Retrieves the attachment from the message.", "description"=>"Retrieves the attachment from the message. Currently we only support one attachment per message. if found. It returns the attached file.", "operationId"=>"getMessageAttachment", "x-api-path-slug"=>"messagemessage-tokenattachment1-get", "parameters"=>[{"in"=>"path", "name"=>"message_token", "description"=>"The message token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Message", "Token", "Attachment", "1"]}}, "/message/{message_token}/forward/"=>{"post"=>{"summary"=>"Forward the message to the following User or Group.", "description"=>"Forward the message to the following User or Group.", "operationId"=>"forwardMessage", "x-api-path-slug"=>"messagemessage-tokenforward-post", "parameters"=>[{"in"=>"path", "name"=>"message_token", "description"=>"The message token"}, {"in"=>"formData", "name"=>"recipient_organization", "description"=>"The recipient organization token"}, {"in"=>"formData", "name"=>"recipient_token", "description"=>"The recipient User or Group token based on address encoding"}, {"in"=>"formData", "name"=>"sender_organization", "description"=>"The sender User organization token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Message", "Token", "Forward"]}}}}, "tiger-connect-metadata-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"TigerText", "x-complete"=>1, "info"=>{"title"=>"Tiger Connect Metadata API", "description"=>"the-metadata-system-for-tigerconnect-messaging-platform-", "termsOfService"=>"http://www.tigertext.com/developer-terms-of-use", "contact"=>{"name"=>"TigerText", "url"=>"http://www.tigertext.com/supportform/", "email"=>"info@tigertext.com"}, "version"=>"v2"}, "host"=>"developer.tigertext.me", "basePath"=>"/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/metadata/{group_token}/"=>{"delete"=>{"summary"=>"Clears the metadata for a User or Group based on address encoding.", "description"=>"Clears the metadata for a User or Group based on address encoding.", "operationId"=>"deleteMetadata", "x-api-path-slug"=>"metadatagroup-token-delete", "parameters"=>[{"in"=>"path", "name"=>"group_token", "description"=>"The group token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "Group", "Token"]}, "get"=>{"summary"=>"Get the metadata for a User or Group based on address encoding.", "description"=>"Get the metadata for a User or Group based on address encoding.", "operationId"=>"getMetadata", "x-api-path-slug"=>"metadatagroup-token-get", "parameters"=>[{"in"=>"path", "name"=>"group_token", "description"=>"The group token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "Group", "Token"]}, "post"=>{"summary"=>"Adds metadata for a User or Group based on address encoding", "description"=>"Adds metadata for a User or Group based on address encoding", "operationId"=>"addMetadata", "x-api-path-slug"=>"metadatagroup-token-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The metadata in the body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"group_token", "description"=>"The group token"}, {"in"=>"query", "name"=>"TT-X-Organization-Key", "description"=>"The organization with which the entity is associated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "Group", "Token"]}}}}, "tiger-connect-roster-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"TigerText", "x-complete"=>1, "info"=>{"title"=>"Tiger Connect Roster API", "description"=>"the-roster-system-for-tigerconnect-messaging-platform-", "termsOfService"=>"http://www.tigertext.com/developer-terms-of-use", "contact"=>{"name"=>"TigerText", "url"=>"http://www.tigertext.com/supportform/", "email"=>"info@tigertext.com"}, "version"=>"v2"}, "host"=>"developer.tigertext.me", "basePath"=>"/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/roster/"=>{"get"=>{"summary"=>"Get the recent conversation list for a user. As new messages are sent and received, the roster is updated with those conversations.", "description"=>"Get the recent conversation list for a user. As new messages are sent and received, the roster is updated with those conversations.", "operationId"=>"getRoster", "x-api-path-slug"=>"roster-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roster"]}}, "/roster/{user_address}/"=>{"delete"=>{"summary"=>"Remove a conversation from the recent conversation list.", "description"=>"Remove a conversation from the recent conversation list. For conversations that are with another User, all messages are deleted. For conversations with a group, the User leaves the group and is no longer receives subsequent group messages.", "operationId"=>"removeRoster", "x-api-path-slug"=>"rosteruser-address-delete", "parameters"=>[{"in"=>"query", "name"=>"TT-X-Organization-Key", "description"=>"The organization with which the entity is associated in the roster"}, {"in"=>"query", "name"=>"TT-X-Type", "description"=>"The entity type"}, {"in"=>"path", "name"=>"user_address", "description"=>"User address or group token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roster", "User", "Address"]}}}}, "tiger-connect-events-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"TigerText", "x-complete"=>1, "info"=>{"title"=>"Tiger Connect Events API", "description"=>"the-events-system-for-tigerconnect-messaging-platform-", "termsOfService"=>"http://www.tigertext.com/developer-terms-of-use", "contact"=>{"name"=>"TigerText", "url"=>"http://www.tigertext.com/supportform/", "email"=>"info@tigertext.com"}, "version"=>"v2"}, "host"=>"developer.tigertext.me", "basePath"=>"/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/events/"=>{"delete"=>{"summary"=>"Drop the events connections.", "description"=>"Drop the events connections.", "operationId"=>"dropConnect", "x-api-path-slug"=>"events-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}, "get"=>{"summary"=>"Opens a SSE event stream.", "description"=>"Opens a SSE event stream. The various Event Types are listed below.", "operationId"=>"createEvents", "x-api-path-slug"=>"events-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}}}, "tiger-connect-group-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"TigerText", "x-complete"=>1, "info"=>{"title"=>"Tiger Connect Group API", "description"=>"the-group-system-for-tigerconnect-messaging-platform-", "termsOfService"=>"http://www.tigertext.com/developer-terms-of-use", "contact"=>{"name"=>"TigerText", "url"=>"http://www.tigertext.com/supportform/", "email"=>"info@tigertext.com"}, "version"=>"v2"}, "host"=>"developer.tigertext.me", "basePath"=>"/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/group/"=>{"post"=>{"summary"=>"Create a new group.", "description"=>"Create a new group.", "operationId"=>"createNewGroup", "x-api-path-slug"=>"group-post", "parameters"=>[{"in"=>"query", "name"=>"avatar", "description"=>"Binary data to use for the groups avatar"}, {"in"=>"formData", "name"=>"members", "description"=>"The members to add to the group encoded using user address encoding"}, {"in"=>"formData", "name"=>"name", "description"=>"The group name"}, {"in"=>"formData", "name"=>"replay_history", "description"=>"A boolean value indicating if, when a new member is added to the group, it should get the messages sent to the group before that"}, {"in"=>"formData", "name"=>"TT-X-Organization-Key", "description"=>"The organization in which the user wants to create the group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/group/{group_token}/"=>{"delete"=>{"summary"=>"Delete a group. If the group has already been deleted, no error is reported.", "description"=>"Delete a group. If the group has already been deleted, no error is reported.", "operationId"=>"deleteGroup", "x-api-path-slug"=>"groupgroup-token-delete", "parameters"=>[{"in"=>"path", "name"=>"group_token", "description"=>"The group token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/group/{group_token}/members/"=>{"post"=>{"summary"=>"Add members to a group.", "description"=>"Add members to a group.", "operationId"=>"addGroupMember", "x-api-path-slug"=>"groupgroup-tokenmembers-post", "parameters"=>[{"in"=>"path", "name"=>"group_token", "description"=>"The group token"}, {"in"=>"formData", "name"=>"members", "description"=>"A list of members to add to a group using user address encoding"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/group/{group_token}/members/remove/"=>{"post"=>{"summary"=>"Remove members from a group.", "description"=>"Remove members from a group.", "operationId"=>"removeMemberFromGroup", "x-api-path-slug"=>"groupgroup-tokenmembersremove-post", "parameters"=>[{"in"=>"path", "name"=>"group_token", "description"=>"The group token"}, {"in"=>"formData", "name"=>"members", "description"=>"A list of members to remove from a group using address encoding"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "tiger-connect-user-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"TigerText", "x-complete"=>1, "info"=>{"title"=>"Tiger Connect User API", "description"=>"the-user-system-for-tigerconnect-messaging-platform-", "termsOfService"=>"http://www.tigertext.com/developer-terms-of-use", "contact"=>{"name"=>"TigerText", "url"=>"http://www.tigertext.com/supportform/", "email"=>"info@tigertext.com"}, "version"=>"v2"}, "host"=>"developer.tigertext.me", "basePath"=>"/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/user/{user_address}/"=>{"get"=>{"summary"=>"Get information about users using their user address encoding.", "description"=>"Get information about users using their user address encoding.", "operationId"=>"getUser", "x-api-path-slug"=>"useruser-address-get", "parameters"=>[{"in"=>"query", "name"=>"TT-X-Organization-Key", "description"=>"The organization for which to show the users organization-bound fields (i"}, {"in"=>"path", "name"=>"user_address", "description"=>"The user address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Address"]}}}}, "apis"=>{"name"=>"TigerText", "x-slug"=>"tigertext", "description"=>"TigerText is a multi-platform, secure, real-time messaging application for the enterprise that allows text messages to be deleted from both the senders and the receivers phones after expiration, which could be a set period of time or after reading. The messages cannot be saved, copied or forwarded by recipients. TigerText does this by storing the message on a company server, not the receiving and sending device, and deleting when the expiration conditions are met.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/tigertext-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Getting Started Example,Messages,Messages,Relative Data,Secure,Service API,SMS,SMS,SMS", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"tigertext/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Tiger Connect Events API", "x-api-slug"=>"tiger-connect-events-api", "description"=>"TigerText is a multi-platform, secure, real-time messaging application for the enterprise that allows text messages to be deleted from both the senders and the receivers phones after expiration, which could be a set period of time or after reading. The messages cannot be saved, copied or forwarded by recipients. TigerText does this by storing the message on a company server, not the receiving and sending device, and deleting when the expiration conditions are met.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/tigertext-logo.png", "humanURL"=>"http://www.tigertext.com/", "baseURL"=>"https://developer.tigertext.me//v2/", "tags"=>"Getting Started Example,Messages,Messages,Relative Data,Secure,Service API,SMS,SMS,SMS", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/tigertext/events-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/tigertext/tiger-connect-events-api-openapi.yaml"}]}, {"name"=>"Tiger Connect Group API", "x-api-slug"=>"tiger-connect-group-api", "description"=>"TigerText is a multi-platform, secure, real-time messaging application for the enterprise that allows text messages to be deleted from both the senders and the receivers phones after expiration, which could be a set period of time or after reading. The messages cannot be saved, copied or forwarded by recipients. TigerText does this by storing the message on a company server, not the receiving and sending device, and deleting when the expiration conditions are met.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/tigertext-logo.png", "humanURL"=>"http://www.tigertext.com/", "baseURL"=>"https://developer.tigertext.me//v2/", "tags"=>"Events", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/tigertext/groupgroup-tokenmembersremove-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/tigertext/tiger-connect-group-api-openapi.yaml"}]}, {"name"=>"Tiger Connect Message API", "x-api-slug"=>"tiger-connect-message-api", "description"=>"TigerText is a multi-platform, secure, real-time messaging application for the enterprise that allows text messages to be deleted from both the senders and the receivers phones after expiration, which could be a set period of time or after reading. The messages cannot be saved, copied or forwarded by recipients. TigerText does this by storing the message on a company server, not the receiving and sending device, and deleting when the expiration conditions are met.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/tigertext-logo.png", "humanURL"=>"http://www.tigertext.com/", "baseURL"=>"https://developer.tigertext.me//v2/", "tags"=>nil, "properties"=>[{"type"=>"x-postman-collection", "url"=>"/tigertext/messagemessage-tokenforward-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/tigertext/tiger-connect-message-api-openapi.yaml"}]}, {"name"=>"Tiger Connect Metadata API", "x-api-slug"=>"tiger-connect-metadata-api", "description"=>"TigerText is a multi-platform, secure, real-time messaging application for the enterprise that allows text messages to be deleted from both the senders and the receivers phones after expiration, which could be a set period of time or after reading. The messages cannot be saved, copied or forwarded by recipients. TigerText does this by storing the message on a company server, not the receiving and sending device, and deleting when the expiration conditions are met.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/tigertext-logo.png", "humanURL"=>"http://www.tigertext.com/", "baseURL"=>"https://developer.tigertext.me//v2/", "tags"=>"Message,Message,Token,Forward", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/tigertext/tiger-connect-metadata-api-openapi.yaml"}]}, {"name"=>"Tiger Connect Roster API", "x-api-slug"=>"tiger-connect-roster-api", "description"=>"TigerText is a multi-platform, secure, real-time messaging application for the enterprise that allows text messages to be deleted from both the senders and the receivers phones after expiration, which could be a set period of time or after reading. The messages cannot be saved, copied or forwarded by recipients. TigerText does this by storing the message on a company server, not the receiving and sending device, and deleting when the expiration conditions are met.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/tigertext-logo.png", "humanURL"=>"http://www.tigertext.com/", "baseURL"=>"https://developer.tigertext.me//v2/", "tags"=>"Metadata,Group,Token", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/tigertext/rosteruser-address-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/tigertext/tiger-connect-roster-api-openapi.yaml"}]}, {"name"=>"Tiger Connect User API", "x-api-slug"=>"tiger-connect-user-api", "description"=>"TigerText is a multi-platform, secure, real-time messaging application for the enterprise that allows text messages to be deleted from both the senders and the receivers phones after expiration, which could be a set period of time or after reading. The messages cannot be saved, copied or forwarded by recipients. TigerText does this by storing the message on a company server, not the receiving and sending device, and deleting when the expiration conditions are met.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/tigertext-logo.png", "humanURL"=>"http://www.tigertext.com/", "baseURL"=>"https://developer.tigertext.me//v2/", "tags"=>"Roster,User,Address", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/tigertext/useruser-address-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/tigertext/tiger-connect-user-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-android-sdk", "url"=>"https://developer.tigertext.com/docs/sdk#android-sdk"}, {"type"=>"x-angellist", "url"=>"https://angel.co/tigertext"}, {"type"=>"x-authentication", "url"=>"https://developer.tigertext.com/docs/tigerconnect-basics#authentication"}, {"type"=>"x-base", "url"=>"http://developer.tigertext.me"}, {"type"=>"x-blog", "url"=>"http://www.tigertext.com/blog/"}, {"type"=>"x-case-studies", "url"=>"http://www.tigertext.com/secure-messaging-case-studies"}, {"type"=>"x-compliance", "url"=>"http://www.tigertext.com/compliance-guarantee/"}, {"type"=>"x-contact-form", "url"=>"http://www.tigertext.com/supportform/"}, {"type"=>"x-crunchbase", "url"=>"https://www.crunchbase.com/organization/tigertext"}, {"type"=>"x-developer", "url"=>"https://developer.tigertext.com/"}, {"type"=>"x-documentation", "url"=>"https://developer.tigertext.com/docs/rest-api-reference"}, {"type"=>"x-email", "url"=>"mailto:info@tigertext.com"}, {"type"=>"x-events", "url"=>"http://www.tigertext.com/event/"}, {"type"=>"x-facebook", "url"=>"https://www.facebook.com/TigerText"}, {"type"=>"x-faq", "url"=>"http://www.tigertext.com/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://developer.tigertext.com/docs"}, {"type"=>"x-github", "url"=>"https://github.com/tigertext"}, {"type"=>"x-google-plus", "url"=>"https://plus.google.com/+TigertextApp/posts"}, {"type"=>"x-instagram", "url"=>"https://instagram.com/tigertext/"}, {"type"=>"x-ios-sdk", "url"=>"https://developer.tigertext.com/docs/sdk#ios-sdk"}, {"type"=>"x-javascript-sdk", "url"=>"https://developer.tigertext.com/docs/sdk#web-sdk"}, {"type"=>"x-license", "url"=>"http://reseller.tigertext.com/license/"}, {"type"=>"x-partner-signup", "url"=>"http://reseller.tigertext.com/partner-signup"}, {"type"=>"x-pricing", "url"=>"http://www.tigertext.com/pricing/"}, {"type"=>"x-privacy", "url"=>"http://www.tigertext.com/privacy-policy/"}, {"type"=>"x-reseller-signup", "url"=>"http://reseller.tigertext.com/"}, {"type"=>"x-security", "url"=>"https://developer.tigertext.com/docs/tigerconnect-basics#security-and-compliance"}, {"type"=>"x-selfservice-registration", "url"=>"https://developer.tigertext.com"}, {"type"=>"x-status", "url"=>"http://status.tigertext.com/"}, {"type"=>"x-terms-of-service", "url"=>"http://www.tigertext.com/developer-terms-of-use/"}, {"type"=>"x-terms-of-service", "url"=>"http://www.tigertext.com/developer-terms-of-use"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/tigertext"}, {"type"=>"x-videos", "url"=>"http://reseller.tigertext.com/videos/"}, {"type"=>"x-vimeo", "url"=>"https://vimeo.com/tigertext"}, {"type"=>"x-webinars", "url"=>"http://www.tigertext.com/webinars/"}, {"type"=>"x-website", "url"=>"http://www.tigertext.com/"}, {"type"=>"x-website", "url"=>"http://tigertext.me"}, {"type"=>"x-white-papers", "url"=>"http://www.tigertext.com/white-papers-case-studie"}, {"type"=>"x-wikipedia", "url"=>"http://en.wikipedia.org/wiki/TigerText"}, {"type"=>"x-windows-sdk", "url"=>"https://developer.tigertext.com/docs/sdk#win-sdk"}, {"type"=>"x-youtube", "url"=>"https://www.youtube.com/tigertext"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-cdn{"azure-cdn-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure CDN", "x-complete"=>1, "info"=>{"title"=>"CdnManagementClient", "description"=>"use-these-apis-to-manage-azure-cdn-resources-through-the-azure-resource-manager--you-must-make-sure-that-requests-made-to-these-resources-are-secure-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/profiles"=>{"get"=>{"summary"=>"Profiles List", "description"=>"Lists all of the CDN profiles within an Azure subscription.", "operationId"=>"Profiles_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-cdnprofiles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Profile"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles"=>{"get"=>{"summary"=>"Profiles List By Resource Group", "description"=>"Lists all of the CDN profiles within a resource group.", "operationId"=>"Profiles_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofiles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Profile"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}"=>{"get"=>{"summary"=>"Profiles Get", "description"=>"Gets a CDN profile with the specified profile name under the specified subscription and resource group.", "operationId"=>"Profiles_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilename-get", "parameters"=>[{"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Profile"]}, "put"=>{"summary"=>"Profiles Create", "description"=>"Creates a new CDN profile with a profile name under the specified subscription and resource group.", "operationId"=>"Profiles_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilename-put", "parameters"=>[{"in"=>"body", "name"=>"profile", "description"=>"Profile properties needed to create a new profile", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Profile"]}, "patch"=>{"summary"=>"Profiles Update", "description"=>"Updates an existing CDN profile with the specified profile name under the specified subscription and resource group.", "operationId"=>"Profiles_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilename-patch", "parameters"=>[{"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}, {"in"=>"body", "name"=>"profileUpdateParameters", "description"=>"Profile properties needed to update an existing profile", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Profile"]}, "delete"=>{"summary"=>"Profiles Delete", "description"=>"Deletes an existing CDN profile with the specified parameters. Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains.", "operationId"=>"Profiles_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilename-delete", "parameters"=>[{"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Profile"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/generateSsoUri"=>{"post"=>{"summary"=>"Profiles Generate Sso Uri", "description"=>"Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemnetal portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.", "operationId"=>"Profiles_GenerateSsoUri", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenamegeneratessouri-post", "parameters"=>[{"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Profile"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkResourceUsage"=>{"post"=>{"summary"=>"Profiles List Resource Usage", "description"=>"Checks the quota and actual usage of endpoints under the given CDN profile.", "operationId"=>"Profiles_ListResourceUsage", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenamecheckresourceusage-post", "parameters"=>[{"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Profile"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints"=>{"get"=>{"summary"=>"Endpoints List By Profile", "description"=>"Lists existing CDN endpoints.", "operationId"=>"Endpoints_ListByProfile", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpoints-get", "parameters"=>[{"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Endpoint"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}"=>{"get"=>{"summary"=>"Endpoints Get", "description"=>"Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", "operationId"=>"Endpoints_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointname-get", "parameters"=>[{"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Endpoint"]}, "put"=>{"summary"=>"Endpoints Create", "description"=>"Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", "operationId"=>"Endpoints_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointname-put", "parameters"=>[{"in"=>"body", "name"=>"endpoint", "description"=>"Endpoint properties", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Endpoint"]}, "patch"=>{"summary"=>"Endpoints Update", "description"=>"Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags and Origin HostHeader can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update custom domains, use the Update Custom Domain operation.", "operationId"=>"Endpoints_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointname-patch", "parameters"=>[{"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"body", "name"=>"endpointUpdateProperties", "description"=>"Endpoint update properties", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Endpoint"]}, "delete"=>{"summary"=>"Endpoints Delete", "description"=>"Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", "operationId"=>"Endpoints_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointname-delete", "parameters"=>[{"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Endpoint"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start"=>{"post"=>{"summary"=>"Endpoints Start", "description"=>"Starts an existing CDN endpoint that is on a stopped state.", "operationId"=>"Endpoints_Start", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointnamestart-post", "parameters"=>[{"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Endpoint"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop"=>{"post"=>{"summary"=>"Endpoints Stop", "description"=>"Stops an existing running CDN endpoint.", "operationId"=>"Endpoints_Stop", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointnamestop-post", "parameters"=>[{"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Endpoint"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge"=>{"post"=>{"summary"=>"Endpoints Purge Content", "description"=>"Removes a content from CDN.", "operationId"=>"Endpoints_PurgeContent", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointnamepurge-post", "parameters"=>[{"in"=>"body", "name"=>"contentFilePaths", "description"=>"The path to the content to be purged", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Endpoint"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load"=>{"post"=>{"summary"=>"Endpoints Load Content", "description"=>"Pre-loads a content to CDN. Available for Verizon Profiles.", "operationId"=>"Endpoints_LoadContent", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointnameload-post", "parameters"=>[{"in"=>"body", "name"=>"contentFilePaths", "description"=>"The path to the content to be loaded", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Endpoint"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain"=>{"post"=>{"summary"=>"Endpoints Validate Custom Domain", "description"=>"Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.", "operationId"=>"Endpoints_ValidateCustomDomain", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointnamevalidatecustomdomain-post", "parameters"=>[{"in"=>"body", "name"=>"customDomainProperties", "description"=>"Custom domain to be validated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Endpointv"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/checkResourceUsage"=>{"post"=>{"summary"=>"Endpoints List Resource Usage", "description"=>"Checks the quota and usage of geo filters and custom domains under the given endpoint.", "operationId"=>"Endpoints_ListResourceUsage", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointnamecheckresourceusage-post", "parameters"=>[{"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Endpoint"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins"=>{"get"=>{"summary"=>"Origins List By Endpoint", "description"=>"Lists all of the existing origins within an endpoint.", "operationId"=>"Origins_ListByEndpoint", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointnameorigins-get", "parameters"=>[{"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Endpoint"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}"=>{"get"=>{"summary"=>"Origins Get", "description"=>"Gets an existing origin within an endpoint.", "operationId"=>"Origins_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointnameoriginsoriginname-get", "parameters"=>[{"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"originName", "description"=>"Name of the origin which is unique within the endpoint"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Orgins"]}, "patch"=>{"summary"=>"Origins Update", "description"=>"Updates an existing origin within an endpoint.", "operationId"=>"Origins_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointnameoriginsoriginname-patch", "parameters"=>[{"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"originName", "description"=>"Name of the origin which is unique within the endpoint"}, {"in"=>"body", "name"=>"originUpdateProperties", "description"=>"Origin properties", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Orgins"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains"=>{"get"=>{"summary"=>"Custom Domains List By Endpoint", "description"=>"Lists all of the existing custom domains within an endpoint.", "operationId"=>"CustomDomains_ListByEndpoint", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointnamecustomdomains-get", "parameters"=>[{"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Custom Domain"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}"=>{"get"=>{"summary"=>"Custom Domains Get", "description"=>"Gets an exisitng custom domain within an endpoint.", "operationId"=>"CustomDomains_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointnamecustomdomainscustomdomainname-get", "parameters"=>[{"in"=>"path", "name"=>"customDomainName", "description"=>"Name of the custom domain within an endpoint"}, {"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Custom Domain"]}, "put"=>{"summary"=>"Custom Domains Create", "description"=>"Creates a new custom domain within an endpoint.", "operationId"=>"CustomDomains_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointnamecustomdomainscustomdomainname-put", "parameters"=>[{"in"=>"path", "name"=>"customDomainName", "description"=>"Name of the custom domain within an endpoint"}, {"in"=>"body", "name"=>"customDomainProperties", "description"=>"Properties required to create a new custom domain", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Custom Domain"]}, "delete"=>{"summary"=>"Custom Domains Delete", "description"=>"Deletes an existing custom domain within an endpoint.", "operationId"=>"CustomDomains_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointnamecustomdomainscustomdomainname-delete", "parameters"=>[{"in"=>"path", "name"=>"customDomainName", "description"=>"Name of the custom domain within an endpoint"}, {"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Custom Domain"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/disableCustomHttps"=>{"post"=>{"summary"=>"Custom Domains Disable Custom Https", "description"=>"Disable https delivery of the custom domain.", "operationId"=>"CustomDomains_DisableCustomHttps", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointnamecustomdomainscustomdomainnamedisablecustomhttps-post", "parameters"=>[{"in"=>"path", "name"=>"customDomainName", "description"=>"Name of the custom domain within an endpoint"}, {"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Custom Domain"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps"=>{"post"=>{"summary"=>"Custom Domains Enable Custom Https", "description"=>"Enable https delivery of the custom domain.", "operationId"=>"CustomDomains_EnableCustomHttps", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-cdnprofilesprofilenameendpointsendpointnamecustomdomainscustomdomainnameenablecustomhttps-post", "parameters"=>[{"in"=>"path", "name"=>"customDomainName", "description"=>"Name of the custom domain within an endpoint"}, {"in"=>"path", "name"=>"endpointName", "description"=>"Name of the endpoint under the profile which is unique globally"}, {"in"=>"path", "name"=>"profileName", "description"=>"Name of the CDN profile which is unique within the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Custom Domain"]}}, "/providers/Microsoft.Cdn/checkNameAvailability"=>{"post"=>{"summary"=>"Check Name Availability", "description"=>"Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.", "operationId"=>"CheckNameAvailability", "x-api-path-slug"=>"providersmicrosoft-cdnchecknameavailability-post", "parameters"=>[{"in"=>"body", "name"=>"checkNameAvailabilityInput", "description"=>"Input to check", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Name Availability"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkResourceUsage"=>{"post"=>{"summary"=>"List Resource Usage", "description"=>"Check the quota and actual usage of the CDN profiles under the given subscription.", "operationId"=>"ListResourceUsage", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-cdncheckresourceusage-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Resource Usage"]}}, "/providers/Microsoft.Cdn/operations"=>{"get"=>{"summary"=>"List Operations", "description"=>"Lists all of the available CDN REST API operations.", "operationId"=>"ListOperations", "x-api-path-slug"=>"providersmicrosoft-cdnoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Operations"]}}, "/providers/Microsoft.Cdn/edgenodes"=>{"get"=>{"summary"=>"Edge Nodes List", "description"=>"Lists all the edge nodes of a CDN service.", "operationId"=>"EdgeNodes_List", "x-api-path-slug"=>"providersmicrosoft-cdnedgenodes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CDN", "Edge Node"]}}}}, "apis"=>{"name"=>"Azure CDN", "x-slug"=>"azure-cdn", "description"=>"Ensuring a consistent user experience is important. If your websites or mobile apps involve streaming media, gaming software, firmware updates (Smart TVs, consumer electronic appliances) or IoT endpoints (cars, sensors), Content Delivery Network helps you reduce load times, save bandwidth, and increase responsiveness.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/02-delivery.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,CDN,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-cdn/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure CDN API", "x-api-slug"=>"azure-cdn-api", "description"=>"Ensuring a consistent user experience is important. If your websites or mobile apps involve streaming media, gaming software, firmware updates (Smart TVs, consumer electronic appliances) or IoT endpoints (cars, sensors), Content Delivery Network helps you reduce load times, save bandwidth, and increase responsiveness.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/02-delivery.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/cdn/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,CDN,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-cdn/providersmicrosoft-cdnedgenodes-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-cdn/azure-cdn-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/cdn/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/cdn/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/cdn/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
predix{"predix-fingerprint-of-things-object-tagging-service-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Fingerprint of Things Object Tagging Service", "description"=>"query-objects-by-their-unique-microscopic-surface-features-trace-parts-and-detect-counterfeits-", "contact"=>{"name"=>"NEC"}, "version"=>"1.0.0"}, "host"=>"fingerprint-of-things-ga1-dast.run.aws-usw02-pr.ice.predix.io", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/group/createGroup"=>{"post"=>{"summary"=>"Create Group", "description"=>"Create group.", "operationId"=>"createGroup", "x-api-path-slug"=>"v1groupcreategroup-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"body", "name"=>"body", "description"=>"Request body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}}, "/v1/group/deleteGroup"=>{"post"=>{"summary"=>"Delete Group", "description"=>"Delete group.", "operationId"=>"deleteGroup", "x-api-path-slug"=>"v1groupdeletegroup-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"body", "name"=>"body", "description"=>"Request body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}}, "/v1/object/preregisterObject"=>{"post"=>{"summary"=>"Object Pre-Register", "description"=>"Pre-register object with image. Individual ID must be designated by user.", "operationId"=>"userIssue", "x-api-path-slug"=>"v1objectpreregisterobject-post", "parameters"=>[{"in"=>"formData", "name"=>"applyFlag", "description"=>"* DO NOT USE"}, {"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"formData", "name"=>"individualId", "description"=>"Individual ID"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}, {"in"=>"formData", "name"=>"registImage", "description"=>"Image data(Max file size: 5MByte)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object", "Pre-Register"]}}, "/v1/object/preregisterObjectWithoutID"=>{"post"=>{"summary"=>"Object Pre-Register without ID", "description"=>"Pre-register object with image. Individual ID will be issued from system.", "operationId"=>"systemIssue", "x-api-path-slug"=>"v1objectpreregisterobjectwithoutid-post", "parameters"=>[{"in"=>"formData", "name"=>"applyFlag", "description"=>"* DO NOT USE"}, {"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}, {"in"=>"formData", "name"=>"registImage", "description"=>"Image data(Max file size: 5MByte)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object", "Pre-Register", "Without", "ID"]}}, "/v1/object/deleteRegisteredObject"=>{"post"=>{"summary"=>"Delete Registered Object", "description"=>"Delete registered object.", "operationId"=>"deleteRegularRegistration", "x-api-path-slug"=>"v1objectdeleteregisteredobject-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"body", "name"=>"body", "description"=>"Request body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registered", "Object"]}}, "/v1/object/deletePreregisteredObject"=>{"post"=>{"summary"=>"Delete Pre-Registered Object", "description"=>"Delete pre-registered object.", "operationId"=>"deleteTempRegistration", "x-api-path-slug"=>"v1objectdeletepreregisteredobject-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"body", "name"=>"body", "description"=>"Request body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pre-Registered", "Object"]}}, "/v1/object/setObjectDoNotRegisterFlag"=>{"post"=>{"summary"=>"Switch Apply Flag", "description"=>"* DO NOT USE. This API will be deleted. Switch the Apply flag on or off.", "operationId"=>"config", "x-api-path-slug"=>"v1objectsetobjectdonotregisterflag-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"body", "name"=>"body", "description"=>"Request body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Switch", "Apply", "Flag"]}}, "/v1/object/setGroupDoNotRegisterFlag"=>{"post"=>{"summary"=>"Switch Apply Flag per Group", "description"=>"* DO NOT USE. This API will be deleted. Switch the Apply flag per group", "operationId"=>"groupConfig", "x-api-path-slug"=>"v1objectsetgroupdonotregisterflag-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"body", "name"=>"body", "description"=>"Request body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Switch", "Apply", "Flag", "Per", "Group"]}}, "/v1/group/putInGroup"=>{"post"=>{"summary"=>"Put Object in Group", "description"=>"Put Object in Group.", "operationId"=>"joinGroup", "x-api-path-slug"=>"v1groupputingroup-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"body", "name"=>"body", "description"=>"Request body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Object", "In", "Group"]}}, "/v1/group/removeFromGroup"=>{"post"=>{"summary"=>"Remove Object from Group", "description"=>"Remove Object from Group.", "operationId"=>"leaveGroup", "x-api-path-slug"=>"v1groupremovefromgroup-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"body", "name"=>"body", "description"=>"Request body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Object", "From", "Group"]}}, "/v1/object/registerObject"=>{"post"=>{"summary"=>"Register Object", "description"=>"Register Object. A registered object can be queried from Query APIs.", "operationId"=>"apply", "x-api-path-slug"=>"v1objectregisterobject-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"body", "name"=>"body", "description"=>"Request body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "Object"]}}, "/v1/object/registerGroup"=>{"post"=>{"summary"=>"Register Object per Group", "description"=>"Register Object per Group. A registered object can be queried from Query APIs.", "operationId"=>"groupApply", "x-api-path-slug"=>"v1objectregistergroup-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"body", "name"=>"body", "description"=>"Request body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "Object", "Per", "Group"]}}, "/v1/object/listObjects"=>{"post"=>{"summary"=>"List Registered Objects", "description"=>"List registered Objects.", "operationId"=>"reference", "x-api-path-slug"=>"v1objectlistobjects-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"body", "name"=>"body", "description"=>"Request body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Registered", "Objects"]}}, "/v1/group/listGroups"=>{"post"=>{"summary"=>"List Groups", "description"=>"List groups", "operationId"=>"groupReference", "x-api-path-slug"=>"v1grouplistgroups-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"body", "name"=>"body", "description"=>"Request body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Groups"]}}, "/v1/object/checkPreregisteredObject"=>{"post"=>{"summary"=>"Check Pre-Registered Object", "description"=>"Check a score of Pre-Registered Object.", "operationId"=>"check", "x-api-path-slug"=>"v1objectcheckpreregisteredobject-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"formData", "name"=>"individualId", "description"=>"Individual ID"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}, {"in"=>"formData", "name"=>"registImage", "description"=>"Image data(Max file size: 5MByte)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Check", "Pre-Registered", "Object"]}}, "/v1/query/queryByObject"=>{"post"=>{"summary"=>"Query by Object", "description"=>"Query image by object.", "operationId"=>"dozicheck", "x-api-path-slug"=>"v1queryquerybyobject-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"formData", "name"=>"checkResultDisplayNumber", "description"=>"Result display number: Specify number of verification result to retrieve"}, {"in"=>"formData", "name"=>"idSpecificationFlag", "description"=>"ID specification flag (0: Query with all registered objects , 1: Query with specified object by individual ID)"}, {"in"=>"formData", "name"=>"individualId", "description"=>"Individual ID: Use CSV form when specifying multiple IDs"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}, {"in"=>"formData", "name"=>"queryImage", "description"=>"Query image data(Max file size: 5MByte)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Query", "By", "Object"]}}, "/v1/query/queryByGroup"=>{"post"=>{"summary"=>"Query by Group", "description"=>"Query image per group.", "operationId"=>"groupzicheck", "x-api-path-slug"=>"v1queryquerybygroup-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization: Bearer", "description"=>"OAuth2 token"}, {"in"=>"formData", "name"=>"checkResultDisplayNumber", "description"=>"Result display number: Specify number of verification result to retrieve"}, {"in"=>"formData", "name"=>"groupId", "description"=>"Group ID: Use CSV form when specifying multiple IDs"}, {"in"=>"formData", "name"=>"idSpecificationFlag", "description"=>"ID specification flag(0: Query with all registered objects , 1: Query with specified object by groupId)"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Zone ID"}, {"in"=>"formData", "name"=>"queryImage", "description"=>"Query image data(Max file size: 5MByte)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Query", "By", "Group"]}}}}, "predix-nurego-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Nurego API", "description"=>"-getting-started-developers--you-will-find-all-the-information-that-you-need-to-integrate-with-nurego-belownurego-is-a-webbased-application-that-provides-organizations-with-total-control-of-their-service-metering-entitlements-and-monetization-learn-how-to-integrate-your-subscription-business-with-nurego-you-can-find-more-details-explanations-and-examples-of-nurego-apis-herehttpsdocs-nurego-comreferenceintegrationsgettingstarted-want-a-quick-tutorial-with-inline-code-samples-for-java-give-our-quick-tutorialhttpsdocs-nurego-comreferencequicktutorial-a-try-if-you-have-any-question-please-dont-hesitate-to-contact-usmailtosupportticketnurego-com-or-tweet-us-nuregoinchttpstwitter-comnuregoinc-", "contact"=>{"name"=>"support@nurego.com"}, "version"=>"1.0.0"}, "host"=>"api.nurego.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/registrations"=>{"post"=>{"summary"=>"Post Registrations", "description"=>"The following parameters can be used to validate the user's request.\nThe parameters are optional, but the sample code includes email as part of the requestParams.post method.", "operationId"=>"postV1Registrations", "x-api-path-slug"=>"v1registrations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Body Parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registrations"]}}, "/v1/registrations/{registration_id}"=>{"get"=>{"summary"=>"Get Registrations", "description"=>"You can use a registration_id to retrieve the respective registration object.", "operationId"=>"getV1RegistrationsRegistration", "x-api-path-slug"=>"v1registrationsregistration-id-get", "parameters"=>[{"in"=>"path", "name"=>"registration_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registrations"]}}, "/v1/accounts/{account_id}"=>{"parameters"=>{"summary"=>"Parameters Accounts", "description"=>"Parameters accounts.", "operationId"=>"parametersV1AccountsAccount", "x-api-path-slug"=>"v1accountsaccount-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Accounts"]}, "get"=>{"summary"=>"Get Accounts", "description"=>"You can retrieve a specific account by using the account number.", "operationId"=>"getV1AccountsAccount", "x-api-path-slug"=>"v1accountsaccount-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}, "put"=>{"summary"=>"Put Accounts", "description"=>"You can update an account using the following parameters.\nUse this method to set the accounts payment method, credit card token (when applicable), bill to contact and custom fields.", "operationId"=>"putV1AccountsAccount", "x-api-path-slug"=>"v1accountsaccount-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Body Parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/v1/organizations/{organization_id}"=>{"parameters"=>{"summary"=>"Parameters Organizations", "description"=>"Parameters organizations.", "operationId"=>"parametersV1OrganizationsOrganization", "x-api-path-slug"=>"v1organizationsorganization-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Organizations"]}, "get"=>{"summary"=>"Get Organizations", "description"=>"You can retrieve an organization by GUID using the following parameters.", "operationId"=>"getV1OrganizationsOrganization", "x-api-path-slug"=>"v1organizationsorganization-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}, "post"=>{"summary"=>"Post Organizations", "description"=>"You can update an organization using the following parameters.", "operationId"=>"postV1OrganizationsOrganization", "x-api-path-slug"=>"v1organizationsorganization-id-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Body Parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}, "/v1/subscriptions/{subscription_id}"=>{"parameters"=>{"summary"=>"Parameters Subscriptions", "description"=>"Parameters subscriptions.", "operationId"=>"parametersV1SubscriptionsSubscription", "x-api-path-slug"=>"v1subscriptionssubscription-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Subscriptions"]}, "get"=>{"summary"=>"Get Subscriptions", "description"=>"You can retrieve a specific subscription by using it's id.", "operationId"=>"getV1SubscriptionsSubscription", "x-api-path-slug"=>"v1subscriptionssubscription-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/v1/organizations/{organization_id}/subscriptions"=>{"parameters"=>{"summary"=>"Parameters Organizations Subscriptions", "description"=>"Parameters organizations subscriptions.", "operationId"=>"parametersV1OrganizationsOrganizationSubscriptions", "x-api-path-slug"=>"v1organizationsorganization-idsubscriptions-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Organizations", "Subscriptions"]}, "post"=>{"summary"=>"Post Organizations Subscriptions", "description"=>"Create a new subscription to a plan.", "operationId"=>"postV1OrganizationsOrganizationSubscriptions", "x-api-path-slug"=>"v1organizationsorganization-idsubscriptions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Body Parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Subscriptions"]}}, "/v1/organizations/{organization_id}/subscriptions/{subscription_id}"=>{"parameters"=>{"summary"=>"Parameters Organizations Subscriptions", "description"=>"Parameters organizations subscriptions.", "operationId"=>"parametersV1OrganizationsOrganizationSubscriptionsSubscription", "x-api-path-slug"=>"v1organizationsorganization-idsubscriptionssubscription-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Organizations", "Subscriptions"]}, "put"=>{"summary"=>"Put Organizations Subscriptions", "description"=>"You can update a subscription's plan, using the following parameters.", "operationId"=>"putV1OrganizationsOrganizationSubscriptionsSubscription", "x-api-path-slug"=>"v1organizationsorganization-idsubscriptionssubscription-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Body Parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Subscriptions"]}, "delete"=>{"summary"=>"Delete Organizations Subscriptions", "description"=>"You can cancel a plan subscription using the following parameters. When the last subscription is canceled, the customer will become canceled.", "operationId"=>"deleteV1OrganizationsOrganizationSubscriptionsSubscription", "x-api-path-slug"=>"v1organizationsorganization-idsubscriptionssubscription-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Subscriptions"]}}, "/v1/subscriptions/{subscription_id}/entitlements"=>{"parameters"=>{"summary"=>"Parameters Subscriptions Entitlements", "description"=>"Parameters subscriptions entitlements.", "operationId"=>"parametersV1SubscriptionsSubscriptionEntitlements", "x-api-path-slug"=>"v1subscriptionssubscription-identitlements-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parameters", "Subscriptions", "Entitlements"]}, "post"=>{"summary"=>"Post Subscriptions Entitlements", "description"=>"You can use this method to retrieve the Entitlements associated with a specific Subscription. It returns a list of entitlement objects.", "operationId"=>"postV1SubscriptionsSubscriptionEntitlements", "x-api-path-slug"=>"v1subscriptionssubscription-identitlements-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Body Parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions", "Entitlements"]}}, "/v1/usages"=>{"post"=>{"summary"=>"Post Usages", "description"=>"You can use this method to report usage events for multiple subscriptions and multiple features with a single API call.", "operationId"=>"postV1Usages", "x-api-path-slug"=>"v1usages-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Body Parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Usages"]}}, "/v1/catalog"=>{"get"=>{"summary"=>"Get Catalog", "description"=>"You can retrieve the service catalog for specific distribution channels, segments or customers.", "operationId"=>"getV1Catalog", "x-api-path-slug"=>"v1catalog-get", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Body Parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog"]}}, "/v1/offerings"=>{"get"=>{"summary"=>"Get Offerings", "description"=>"You can retrieve the available Offerings for a specific Segment and/or Distribution channel, by using the following attributes in your method call.", "operationId"=>"getV1Offerings", "x-api-path-slug"=>"v1offerings-get", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Body Parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offerings"]}}}}, "predix-dynamic-time-warping-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"DTW API", "description"=>"dynamic-time-warping-dtw-is-an-algorithm-to-calculate-an-optimal-match-between-two-sequences-which-may-vary-in-length-dtw-originates-from-the-speech-regconition-field-and-has-been-applied-to-batch-process-data-due-to-the-presence-of-batchtobatch-disturbance-and-physical-constrains-the-data-sequences-from-batches-may-vary-in-length-and-unsynchronized-with-dtw-data-sequences-from-batches-will-be-aligned-to-the-same-length-and-events-taking-place-during-each-batch-will-be-synchronized-then-they-are-ready-for-further-analysis--dtw-plays-a-key-role-in-process-monitoring-and-optimization-applications-", "version"=>"1.0.0"}, "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/warp"=>{"post"=>{"summary"=>"Warp subject and reference arrays", "description"=>"Warp subject and reference arrays.", "operationId"=>"postWarp", "x-api-path-slug"=>"warp-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Subject and Reference arrays to be processed", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Warp", "Subject", "Reference", "Arrays"]}}}}, "predix-enterprise-connect-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Enterprise Connect API (osaka.67)", "description"=>"enterprise-connect-service--api", "version"=>"1.0.0"}, "host"=>"ec-predix-service-osaka.run.aws-usw02-pr.ice.predix.io", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/settings"=>{"get"=>{"summary"=>"Get EC Gateway settings", "description"=>"Get your EC Gateway settings details", "operationId"=>"get-your-ec-gateway-settings-details", "x-api-path-slug"=>"apisettings-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer *your_token"}, {"in"=>"header", "name"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["EC", "Gateway", "Settings"]}}, "/api/token/validate"=>{"post"=>{"summary"=>"Validate the oauth2 token", "description"=>"Validate the oauth2 token for the gateway usage", "operationId"=>"validate-the-oauth2-token-for-the-gateway-usage", "x-api-path-slug"=>"apitokenvalidate-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer *your_token"}, {"in"=>"header", "name"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Validate", "Oauth2", "Token"]}}, "/health/check"=>{"get"=>{"summary"=>"Validate the EC service status", "description"=>"Validate the EC API status", "operationId"=>"validate-the-ec-api-status", "x-api-path-slug"=>"healthcheck-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Validate", "EC", "Service", "Status"]}}, "/health/memory"=>{"get"=>{"summary"=>"Validate the EC service memory usage", "description"=>"Validate the EC gateway memory usage", "operationId"=>"validate-the-ec-gateway-memory-usage", "x-api-path-slug"=>"healthmemory-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Validate", "EC", "Service", "Memory", "Usage"]}}, "/reports/usage"=>{"post"=>{"summary"=>"Report usage", "description"=>"Report usage by zoneid", "operationId"=>"report-usage-by-zoneid", "x-api-path-slug"=>"reportsusage-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Basic *token"}, {"in"=>"body", "name"=>"content", "description"=>"The content for reporting the usage", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"predix-zone-id", "description"=>"Cloud Foundry service instance id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Report", "Usage"]}, "get"=>{"summary"=>"Get last usage", "description"=>"get last usage by zoneid", "operationId"=>"get-last-usage-by-zoneid", "x-api-path-slug"=>"reportsusage-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Basic *token"}, {"in"=>"header", "name"=>"predix-zone-id", "description"=>"Cloud Foundry service instance id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Last", "Usage"]}}, "/certs"=>{"post"=>{"summary"=>"Request a digital certificate", "description"=>"Submit a CSR for a certificate for the EC usage", "operationId"=>"submit-a-csr-for-a-certificate-for-the-ec-usage", "x-api-path-slug"=>"certs-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Basic *token"}, {"in"=>"body", "name"=>"content", "description"=>"The CSR content in pem format", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"predix-zone-id", "description"=>"Cloud Foundry service instance id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Request", "Digital", "Certificate"]}, "get"=>{"summary"=>"Retrieve current certificate", "description"=>"Retrieve the current certificate issued by the GE Digital CA.", "operationId"=>"retrieve-the-current-certificate-issued-by-the-ge-digital-ca", "x-api-path-slug"=>"certs-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Basic *token"}, {"in"=>"header", "name"=>"predix-zone-id", "description"=>"Cloud Foundry service instance id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieve", "Current", "Certificate"]}}, "/admin/accounts/{predix-zone-id}"=>{"post"=>{"summary"=>"Create an EC system account", "description"=>"Create a EC system account with the CF details", "operationId"=>"create-a-ec-system-account-with-the-cf-details", "x-api-path-slug"=>"adminaccountspredixzoneid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Basic *token"}, {"in"=>"path", "name"=>"predix-zone-id", "description"=>"Cloud Foundry service instance details"}, {"in"=>"body", "name"=>"settings", "description"=>"Cloud Foundry setting details", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["EC", "System", "Account"]}, "get"=>{"summary"=>"Get the EC system account", "description"=>"Get an existing EC system account by predix zone id", "operationId"=>"get-an-existing-ec-system-account-by-predix-zone-id", "x-api-path-slug"=>"adminaccountspredixzoneid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Basic *token"}, {"in"=>"path", "name"=>"predix-zone-id", "description"=>"pass the predix zone id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["EC", "System", "Account"]}, "delete"=>{"summary"=>"Delete the EC system account", "description"=>"Delete an existing EC system account by predix zone id", "operationId"=>"delete-an-existing-ec-system-account-by-predix-zone-id", "x-api-path-slug"=>"adminaccountspredixzoneid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Basic *token"}, {"in"=>"path", "name"=>"predix-zone-id", "description"=>"pass the predix zone id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["EC", "System", "Account"]}, "put"=>{"summary"=>"Update the EC gateway setting in the account", "description"=>"Update the EC gateway setting in the account with the CF details", "operationId"=>"update-the-ec-gateway-setting-in-the-account-with-the-cf-details", "x-api-path-slug"=>"adminaccountspredixzoneid-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Basic *token"}, {"in"=>"path", "name"=>"predix-zone-id", "description"=>"Predix Zone Id"}, {"in"=>"body", "name"=>"settings", "description"=>"Cloud Foundry setting destails", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["EC", "Gateway", "Setting", "In", "Account"]}}}}, "predix-thetaray-predix-service-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"ThetaRay Predix Service API", "description"=>"thetaray-anomaly-detection-service-for-predix", "contact"=>{"name"=>"supportforpredix@thetaray.com"}, "version"=>"1.0.0"}, "host"=>"thetaray-anomaly-service.run.aws-usw02-pr.ice.predix.io", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/proxy/analyses"=>{"get"=>{"summary"=>"Analyses List", "description"=>"Get list of Analyses", "operationId"=>"retrieveNewUsingGET", "x-api-path-slug"=>"v1proxyanalyses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Analyses"]}}, "/v1/proxy/anomalies/report"=>{"get"=>{"summary"=>"Anomalies Report", "description"=>"Retrieves Anomalies Report", "operationId"=>"retrieveReportUsingGET", "x-api-path-slug"=>"v1proxyanomaliesreport-get", "parameters"=>[{"in"=>"query", "name"=>"analysisId", "description"=>"Analysis Id"}, {"in"=>"query", "name"=>"dataSourceName", "description"=>"Data Source name"}, {"in"=>"query", "name"=>"fromAnomaly", "description"=>"Fetch from Anomaly in Analysis"}, {"in"=>"query", "name"=>"numOfTopFeatures", "description"=>"Number of top features to fetch"}, {"in"=>"query", "name"=>"toAnomaly", "description"=>"Fetch up to Anomaly in Analysis"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Anomalies", "Report"]}}, "/v1/proxy/clusters/report"=>{"get"=>{"summary"=>"Clusters Report", "description"=>"Get Clusters report", "operationId"=>"getClustersReportUsingGET", "x-api-path-slug"=>"v1proxyclustersreport-get", "parameters"=>[{"in"=>"query", "name"=>"analysisId", "description"=>"Analysis Id"}, {"in"=>"query", "name"=>"dataSourceName", "description"=>"Data Source name"}, {"in"=>"query", "name"=>"filterOnlyUsedToCluster", "description"=>"Filter Anomalies used to set create Clusters"}, {"in"=>"query", "name"=>"fromAnomaly", "description"=>"Filter from Anomaly in Analysis"}, {"in"=>"query", "name"=>"toAnomaly", "description"=>"Filter to Anomaly in Analysis"}, {"in"=>"query", "name"=>"withMinClusterSize", "description"=>"Get only Clusters with minimum size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Clusters", "Report"]}}, "/v1/proxy/datasources/datasources"=>{"get"=>{"summary"=>"Data Sources List", "description"=>"Get list of all Data Sources", "operationId"=>"getDataSourcesUsingGET", "x-api-path-slug"=>"v1proxydatasourcesdatasources-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Datasources", "Datasources"]}}, "/v1/proxy/datasources/process"=>{"post"=>{"summary"=>"Upload a file", "description"=>"Upload a data file", "operationId"=>"processUsingPOST", "x-api-path-slug"=>"v1proxydatasourcesprocess-post", "parameters"=>[{"in"=>"query", "name"=>"dataSourceName", "description"=>"Data source name - up to 15 chars"}, {"in"=>"formData", "name"=>"file", "description"=>"The file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Datasources", "Process"]}}}}, "predix-analytics-runtime-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Analytics Runtime", "version"=>"1.0.0"}, "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/v1/analytics/customdata/healthcheck"=>{"get"=>{"summary"=>"Healthcheck for custom datasource.", "description"=>"Indicates whether custom data connector is up and running.", "operationId"=>"healthcheck", "x-api-path-slug"=>"apiv1analyticscustomdatahealthcheck-get", "responses"=>{2=>{"description"=>"Successful response"}, 200=>{"description"=>"Successful response"}}, "tags"=>["Healthcheckcustom", "Datasource"]}}, "/api/v1/analytics/customdata/read"=>{"post"=>{"summary"=>"Retrieve analytic input data from custom datasource.", "description"=>"Returns the analytic input data used during runtime execution.", "operationId"=>"readCustomProviderData", "x-api-path-slug"=>"apiv1analyticscustomdataread-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Analytic Input Data Read request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieve", "Analytic", "Input", "Data", "From", "Custom", "Datasource"]}}, "/api/v1/analytics/customdata/write"=>{"post"=>{"summary"=>"Write analytic output data to custom datasource.", "description"=>"Writes analytic output data generated during runtime execution.", "operationId"=>"writeCustomProviderData", "x-api-path-slug"=>"apiv1analyticscustomdatawrite-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Analytic Output Data Write Request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Write", "Analytic", "Output", "Data", "To", "Custom", "Datasource"]}}, "/api/v1/execution"=>{"post"=>{"summary"=>"Execute the specified orchestration.", "description"=>"To successfully execute the orchestration, the OrchestrationRequest must contain valid orchestration id, bpmn workflow xml and optionally input data for each analytic step defined in the workflow.", "operationId"=>"run", "x-api-path-slug"=>"apiv1execution-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"orchestration execution request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Execute", "Specified", "Orchestration"]}}, "/api/v1/monitoring/orchestrations/{orchestrationRequestId}"=>{"get"=>{"summary"=>"Retrieve orchestration execution result", "description"=>"Returns orchestration execution result for the given orchestration request id.", "operationId"=>"retrieveOrchestrationResult", "x-api-path-slug"=>"apiv1monitoringorchestrationsorchestrationrequestid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"orchestrationRequestId"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieve", "Orchestration", "Execution", "Result"]}}, "/api/v1/scheduler/jobs"=>{"get"=>{"summary"=>"Get all job definition entries.", "description"=>"Returns all job definition entries as specified by page and sort criteria.", "operationId"=>"retrieveAllJobs", "x-api-path-slug"=>"apiv1schedulerjobs-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"query", "name"=>"page", "description"=>"page index : zero-based page index"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"query", "name"=>"size", "description"=>"page size : between 1 and 1000 inclusive"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"sort order : asc | desc"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Job", "Definition", "Entries"]}, "post"=>{"summary"=>"Create a scheduler job.", "description"=>"Creates the scheduler job with a generated id. Set the state value to 'Active' to start the job. Set the state value to 'Inactive' to avoid starting the job.", "operationId"=>"createJob", "x-api-path-slug"=>"apiv1schedulerjobs-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"header", "name"=>"Refresh-Token-For-Job-Execution", "description"=>"Refresh-Token-For-Job-Execution"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Scheduler", "Job"]}}, "/api/v1/scheduler/jobs/{id}"=>{"get"=>{"summary"=>"Get a scheduler job by id.", "description"=>"Returns the scheduler job with the given id.", "operationId"=>"retrieveJob", "x-api-path-slug"=>"apiv1schedulerjobsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"Job id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Scheduler", "Job", "By", "Id"]}, "put"=>{"summary"=>"Update an existing scheduler job.", "description"=>"Updates the scheduled job. The updated changes will be effective from the next scheduling of this job. To suspend a job, update the job with state value 'Inactive'. To resume a job, update the job with state value 'Active'.", "operationId"=>"updateJob", "x-api-path-slug"=>"apiv1schedulerjobsid-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"header", "name"=>"Refresh-Token-For-Job-Execution", "description"=>"Refresh-Token-For-Job-Execution"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Existing", "Scheduler", "Job"]}, "delete"=>{"summary"=>"Delete job definition.", "description"=>"Delete job definition for the given job id.", "operationId"=>"deleteJob", "x-api-path-slug"=>"apiv1schedulerjobsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"Job id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Job", "Definition"]}}, "/api/v1/scheduler/jobs/{id}/history"=>{"get"=>{"summary"=>"Retrieve job execution history of the given job.", "description"=>"Retrieve job execution history", "operationId"=>"retrieveJobHistory", "x-api-path-slug"=>"apiv1schedulerjobsidhistory-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"query", "name"=>"endTime", "description"=>"End time in millis"}, {"in"=>"path", "name"=>"id", "description"=>"Job id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"query", "name"=>"startTime", "description"=>"Start time in millis"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieve", "Job", "Execution", "History", "Of", "Given", "Job"]}}, "/api/v2/config/orchestrations"=>{"get"=>{"summary"=>"Get all orchestration configuration entries.", "description"=>"Returns all orchestration configuration entries as specified by page and sort criteria.", "operationId"=>"retrieveAllOrchConfigs", "x-api-path-slug"=>"apiv2configorchestrations-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"query", "name"=>"page", "description"=>"page index : zero-based page index"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"query", "name"=>"size", "description"=>"page size : between 1 and 1000 inclusive"}, {"in"=>"query", "name"=>"sortableFields", "description"=>"sortable fields : name"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"sort order : asc | desc"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Orchestration", "Configuration", "Entries"]}, "post"=>{"summary"=>"Create an orchestration configuration entry.", "description"=>"Creates the orchestration configuration entry with a generated id.", "operationId"=>"createOrchestrationEntry", "x-api-path-slug"=>"apiv2configorchestrations-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"body", "name"=>"body", "description"=>"orchestration configuration entry", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Orchestration", "Configuration", "Entry"]}}, "/api/v2/config/orchestrations/artifacts"=>{"post"=>{"summary"=>"Upload an artifact and attach it to an orchestration configuration entry.", "description"=>"Upload a single artifact file in a multipart MIME structure and attach it to an orchestration configuration entry. The multipart MIME structure must have the orchestration entry id tagged as 'orchestrationEntryId', the file contents tagged as 'file', the artifact type tagged as 'type', and the name of artifact tagged as 'name'. A description (under 1024 characters) tagged as 'description' can be optionally specified. Artifact types can be either 'portToFieldMap', 'bpmn' or any. If the artifact type is 'portToFieldMap', specify the orchestration step ID tagged as 'stepId'. Otherwise, 'name' will be used as 'stepId'. (See the documentation for more information regarding these files.)", "operationId"=>"uploadOrchConfigArtifact", "x-api-path-slug"=>"apiv2configorchestrationsartifacts-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"formData", "name"=>"description", "description"=>"Artifact description"}, {"in"=>"formData", "name"=>"file", "description"=>"(Required) Artifact file"}, {"in"=>"formData", "name"=>"name", "description"=>"(Required) Artifact name"}, {"in"=>"formData", "name"=>"orchestrationEntryId", "description"=>"(Required) orchestration configuration entry id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"formData", "name"=>"stepId", "description"=>"Orchestration Step ID"}, {"in"=>"formData", "name"=>"type", "description"=>"(Required) Artifact type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Upload", "Artifact", "Attach", "It", "To", "Orchestration", "Configuration", "Entry"]}}, "/api/v2/config/orchestrations/artifacts/{id}"=>{"put"=>{"summary"=>"Update an artifact by id.", "description"=>"Update the artifact of the orchestration configuration with the contents of the supplied multipart MIME structure. The multipart MIME structure may have new file contents tagged as 'file', new artifact type tagged as 'type', new name of artifact tagged as 'name', new description (under 1024 characters) tagged as 'description', and new value of the orchestration step id tagged as 'stepId. Artifact types can be either 'portToFieldMap', 'bpmn' or any. (See the documentation for more information regarding these files.)", "operationId"=>"updateOrchConfigArtifact", "x-api-path-slug"=>"apiv2configorchestrationsartifactsid-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"formData", "name"=>"description", "description"=>"Artifact description"}, {"in"=>"formData", "name"=>"file", "description"=>"Artifact file"}, {"in"=>"path", "name"=>"id", "description"=>"Artifact id"}, {"in"=>"formData", "name"=>"name", "description"=>"Artifact name"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"formData", "name"=>"stepId", "description"=>"Orchestration Step ID"}, {"in"=>"formData", "name"=>"type", "description"=>"Artifact type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Artifact", "By", "Id"]}, "delete"=>{"summary"=>"Delete an orchestration artifact by id.", "description"=>"Delete the orchestration artifact by artifact id.", "operationId"=>"deleteOrchConfigArtifact", "x-api-path-slug"=>"apiv2configorchestrationsartifactsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"Artifact id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Orchestration", "Artifact", "By", "Id"]}}, "/api/v2/config/orchestrations/artifacts/{id}/file"=>{"get"=>{"summary"=>"Download an orchestration artifact file by id.", "description"=>"The file is downloaded as an octet-stream.", "operationId"=>"downloadOrchConfigArtifact", "x-api-path-slug"=>"apiv2configorchestrationsartifactsidfile-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"Artifact id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Download", "Orchestration", "Artifact", "File", "By", "Id"]}}, "/api/v2/config/orchestrations/defaulttagquery"=>{"get"=>{"summary"=>"Get the default tag query corresponding for the tenant.", "description"=>"Returns all information (query string, fieldnamespecifier, tagnamespecifer, description etc.) associated with the default tag query. An error is returned if tag query does not exist for the tenant.", "operationId"=>"retrieveDefaultTagQuery", "x-api-path-slug"=>"apiv2configorchestrationsdefaulttagquery-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Default", "Tag", "Query", "Correspondingthe", "Tenant"]}, "post"=>{"summary"=>"Create the default tag query corresponding for the tenant.", "description"=>"Creates the default tag query including all information (query string, fieldnamespecifier, tagnamespecifer, description etc.) associated with the query.", "operationId"=>"createDefaultTagQuery", "x-api-path-slug"=>"apiv2configorchestrationsdefaulttagquery-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"body", "name"=>"body", "description"=>"tag names default query", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Default", "Tag", "Query", "Correspondingthe", "Tenant"]}, "put"=>{"summary"=>"Update the default tag query for the tenant.", "description"=>"Updates the default tag query including all information (query string, fieldnamespecifier, tagnamespecifer, description etc.) associated with the query.", "operationId"=>"updateDefaultTagQuery", "x-api-path-slug"=>"apiv2configorchestrationsdefaulttagquery-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"body", "name"=>"body", "description"=>"tag names default query", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Default", "Tag", "Querythe", "Tenant"]}, "delete"=>{"summary"=>"Delete the default tag query for the tenant.", "description"=>"Deletes the default tag query.", "operationId"=>"deleteDefaultTagQuery", "x-api-path-slug"=>"apiv2configorchestrationsdefaulttagquery-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Default", "Tag", "Querythe", "Tenant"]}}, "/api/v2/config/orchestrations/models"=>{"get"=>{"summary"=>"Get all model entries.", "description"=>"Returns all model entries as specified by page and sort criteria. By default, retrieves all models for tenant. If additional query params specified, then results will be filtered", "operationId"=>"retrieveAllModels", "x-api-path-slug"=>"apiv2configorchestrationsmodels-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"query", "name"=>"modelKey", "description"=>"Model Key"}, {"in"=>"query", "name"=>"modelName", "description"=>"Model Name"}, {"in"=>"query", "name"=>"modelVersion", "description"=>"Model Version"}, {"in"=>"query", "name"=>"page", "description"=>"page index : zero-based page index"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"query", "name"=>"size", "description"=>"page size : between 1 and 1000 inclusive"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Model", "Entries"]}, "post"=>{"summary"=>"Upload a model.", "description"=>"Upload a model in a multipart MIME structure. The multipart MIME structure must have the modelKey tagged as 'modelKey', the modelName tagged as 'modelName', the modelVersion tagged as 'modelVersion', the file contents tagged as 'file', a description (under 1024 characters) tagged as 'description'. (See the documentation for more information regarding these files.)", "operationId"=>"uploadModel", "x-api-path-slug"=>"apiv2configorchestrationsmodels-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"formData", "name"=>"description", "description"=>"Artifact description"}, {"in"=>"formData", "name"=>"file", "description"=>"(Required) Model file"}, {"in"=>"formData", "name"=>"modelKey", "description"=>"(Required) Model Key"}, {"in"=>"formData", "name"=>"modelName", "description"=>"(Required) Model Name"}, {"in"=>"formData", "name"=>"modelVersion", "description"=>"(Required) Model Version"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Upload", "Model"]}}, "/api/v2/config/orchestrations/models/{id}"=>{"put"=>{"summary"=>"Update model by id.", "description"=>"Update a model with attributes of the supplied multipart MIME structure. The multipart MIME structure must have the modelKey tagged as 'modelKey', the modelName tagged as 'modelName', the modelVersion tagged as 'modelVersion', the file contents tagged as 'file', a description (under 1024 characters) tagged as 'description'. (See the documentation for more information regarding these files.)", "operationId"=>"updateModel", "x-api-path-slug"=>"apiv2configorchestrationsmodelsid-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"formData", "name"=>"description", "description"=>"Artifact description"}, {"in"=>"formData", "name"=>"file", "description"=>"(Required) Model file"}, {"in"=>"path", "name"=>"id", "description"=>"artifact id"}, {"in"=>"formData", "name"=>"modelKey", "description"=>"(Required) Model Key"}, {"in"=>"formData", "name"=>"modelName", "description"=>"(Required) Model Name"}, {"in"=>"formData", "name"=>"modelVersion", "description"=>"(Required) Model Version"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Model", "By", "Id"]}, "delete"=>{"summary"=>"Delete a model by id.", "description"=>"Delete a model by model id.", "operationId"=>"deleteModel", "x-api-path-slug"=>"apiv2configorchestrationsmodelsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"Model id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Model", "By", "Id"]}}, "/api/v2/config/orchestrations/models/{id}/file"=>{"get"=>{"summary"=>"Download a model file by id.", "description"=>"The file is downloaded as an octet-stream.", "operationId"=>"downloadModel", "x-api-path-slug"=>"apiv2configorchestrationsmodelsidfile-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"Model id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Download", "Model", "File", "By", "Id"]}}, "/api/v2/config/orchestrations/{id}"=>{"get"=>{"summary"=>"Get an orchestration configuration entry by id.", "description"=>"Returns the orchestration configuration entry with the given id.", "operationId"=>"retrieveOrchestrationEntryById", "x-api-path-slug"=>"apiv2configorchestrationsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"orchestration configuration entry id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Orchestration", "Configuration", "Entry", "By", "Id"]}, "put"=>{"summary"=>"Update an existing orchestration configuration entry.", "description"=>"Updates the orchestration configuration entry with given orchestration configuration.", "operationId"=>"updateOrchestrationEntry", "x-api-path-slug"=>"apiv2configorchestrationsid-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"body", "name"=>"body", "description"=>"orchestration configuration entry", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"orchestration configuration id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Existing", "Orchestration", "Configuration", "Entry"]}, "delete"=>{"summary"=>"Delete an orchestration configuration entry by id.", "description"=>"Deletes the orchestration configuration entry with the given id.", "operationId"=>"deleteOrchestrationEntryById", "x-api-path-slug"=>"apiv2configorchestrationsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"orchestration configuration entry id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Orchestration", "Configuration", "Entry", "By", "Id"]}}, "/api/v2/config/orchestrations/{id}/artifacts"=>{"get"=>{"summary"=>"Get the descriptive information of the orchestration artifacts corresponding to an orchestration configuration entry.", "description"=>"Returns the description information (type, description, etc.) for all orchestration artifacts associated with the given configuration entry id. Note: it does not return the orchestration artifact file contents; use the download APIs to obtain an artifact file. An error is returned if the supplied orchestration configuration entry id does not exist.", "operationId"=>"retrieveArtifactsByOrchestrationEntryId", "x-api-path-slug"=>"apiv2configorchestrationsidartifacts-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"orchestration configuration entry id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Descriptive", "Information", "Of", "Orchestration", "Artifacts", "Corresponding", "To", "Orchestration", "Configuration", "Entry"]}}, "/api/v2/config/orchestrations/{id}/file"=>{"get"=>{"summary"=>"Download an orchestration artifact file by orchestration id and artifact type.", "description"=>"The file is downloaded as an octet-stream. If the type is bpmn, then then bpmn xml is downloaded. If the type is portToFieldMap, then the system expects analyticStepId to download the portToFieldMap for the given step", "operationId"=>"downloadArtifactByType", "x-api-path-slug"=>"apiv2configorchestrationsidfile-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"orchestration configuration entry id"}, {"in"=>"query", "name"=>"name", "description"=>"artifact name (analytic step id)"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"query", "name"=>"type", "description"=>"artifact type (Ex"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Download", "Orchestration", "Artifact", "File", "By", "Orchestration", "Id", "Artifact", "Type"]}}, "/api/v2/execution"=>{"post"=>{"summary"=>"Execute the specified orchestration.", "description"=>"To successfully execute the orchestration, the OrchestrationExecutionRequest must contain valid orchestration id, asset id, asset data field mapping details. This API will execute the orchestration in synchronous mode and if the execution is not completed in 1 minute then the request will fail. After successful completion, the response will contain each orchestration steps output data.", "operationId"=>"runSyncV2", "x-api-path-slug"=>"apiv2execution-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"orchestration execution request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Execute", "Specified", "Orchestration"]}}, "/api/v2/execution/async"=>{"post"=>{"summary"=>"Execute the specified orchestration in asynchronous mode.", "description"=>"To successfully execute the orchestration, the OrchestrationExecutionRequest must contain valid orchestration id, asset id, asset data field mapping details.", "operationId"=>"runAsync", "x-api-path-slug"=>"apiv2executionasync-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"orchestration execution request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Execute", "Specified", "Orchestration", "In", "Asynchronous", "Mode"]}}, "/api/v2/execution/orchestrations/{orchConfigId}/deployment"=>{"post"=>{"summary"=>"Deploy the specified orchestration workflow file to the Orchestration Engine.", "description"=>"This API will deploy the BPMN file associated with the specified orchestration configuration to the Orchestration Engine in preparation for orchestration execution.", "operationId"=>"retrieveAndDeployBpmn", "x-api-path-slug"=>"apiv2executionorchestrationsorchconfigiddeployment-post", "parameters"=>[{"in"=>"path", "name"=>"orchConfigId", "description"=>"orchestration configuration id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Deploy", "Specified", "Orchestration", "Workflow", "File", "To", "Orchestration", "Engine"]}}, "/api/v2/execution/testrun"=>{"post"=>{"summary"=>"Execute the orchestration with given bpmn and input data.", "description"=>"To successfully execute the orchestration, the request must contain valid bpmn20.xml, input data for each step in the bpmn.", "operationId"=>"testRun", "x-api-path-slug"=>"apiv2executiontestrun-post", "parameters"=>[{"in"=>"formData", "name"=>"bpmn", "description"=>"BPMN file"}, {"in"=>"formData", "name"=>"input", "description"=>"Input data file"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Execute", "Orchestration", "Given", "Bpmn", "Input", "Data"]}}, "/api/v2/execution/validation"=>{"post"=>{"summary"=>"Validate the specified orchestration and the health of all the analytics used in the orchestration.", "description"=>"To successfully validate the orchestration, the BPMN XML file must reference analytics that are running. The validation will call a 'healthCheck' entry on each analytic. Analytics in the platform automatically have this entry, analytics outside the platform must implement this APIfor their validation to pass. The results contain the http status for each for the healthCheck call to each analytic.", "operationId"=>"validate", "x-api-path-slug"=>"apiv2executionvalidation-post", "parameters"=>[{"in"=>"body", "name"=>"file", "description"=>"(Required) artifact file", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Validate", "Specified", "Orchestration", "Health", "Of", "", "Analytics", "Used", "In", "Orchestration"]}}}}, "predix-tenant-management-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Tenant Management", "description"=>"tenancy-management-service-tms", "version"=>"1.0.0"}, "host"=>"predix-tms.run.aws-usw02-pr.ice.predix.io", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/client-credentials"=>{"get"=>{"summary"=>"Get tenant credentials", "description"=>"Get tenant credentials .", "operationId"=>"getTenantCredentialsUsingGET", "x-api-path-slug"=>"v1clientcredentials-get", "parameters"=>[{"in"=>"header", "name"=>"TMS-Zone-Subdomain"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenant", "Credentials"]}, "post"=>{"summary"=>"Create tenant credentials", "description"=>"Create tenant credentials .", "operationId"=>"createTenantCredentialsUsingPOST", "x-api-path-slug"=>"v1clientcredentials-post", "parameters"=>[{"in"=>"body", "name"=>"tenantCredentialsRequests", "description"=>"tenantCredentialsRequests", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"TMS-Zone-Subdomain"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenant", "Credentials"]}, "put"=>{"summary"=>"Create tenant credentials", "description"=>"Create tenant credentials .", "operationId"=>"updateTenantCredentialsUsingPUT", "x-api-path-slug"=>"v1clientcredentials-put", "parameters"=>[{"in"=>"body", "name"=>"tenantCredentialsRequest", "description"=>"tenantCredentialsRequest", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"TMS-Zone-Subdomain"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenant", "Credentials"]}}, "/v1/client-credentials/client-ids/{clientId}"=>{"delete"=>{"summary"=>"Delete tenant credentials", "description"=>"Delete tenant credentials .", "operationId"=>"deleteTenantCredentialsUsingDELETE_1", "x-api-path-slug"=>"v1clientcredentialsclientidsclientid-delete", "parameters"=>[{"in"=>"path", "name"=>"clientId", "description"=>"clientId"}, {"in"=>"header", "name"=>"TMS-Zone-Subdomain"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenant", "Credentials"]}}, "/v1/client-credentials/client-ids/{clientId}/authorized-clients/{authorizedClientId}"=>{"delete"=>{"summary"=>"Delete tenant credentials", "description"=>"Delete tenant credentials .", "operationId"=>"deleteTenantCredentialsUsingDELETE", "x-api-path-slug"=>"v1clientcredentialsclientidsclientidauthorizedclientsauthorizedclientid-delete", "parameters"=>[{"in"=>"path", "name"=>"authorizedClientId", "description"=>"authorizedClientId"}, {"in"=>"path", "name"=>"clientId", "description"=>"clientId"}, {"in"=>"header", "name"=>"TMS-Zone-Subdomain"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenant", "Credentials"]}}, "/v1/tenant"=>{"get"=>{"summary"=>"Retrieve all the tenants in the given zone", "description"=>"Retrieve all the tenants in the given zone.", "operationId"=>"getTenantsUsingGET", "x-api-path-slug"=>"v1tenant-get", "parameters"=>[{"in"=>"header", "name"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieve", "", "Tenants", "In", "Given", "Zone"]}, "post"=>{"summary"=>"create a tenant", "description"=>"Create a tenant.", "operationId"=>"createTenantUsingPOST", "x-api-path-slug"=>"v1tenant-post", "parameters"=>[{"in"=>"header", "name"=>"Predix-Zone-Id"}, {"in"=>"body", "name"=>"tenantProvisioningRequest", "description"=>"tenantProvisioningRequest", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Create", "Tenant"]}, "put"=>{"summary"=>"update a tenant", "description"=>"Update a tenant.", "operationId"=>"updateTenantUsingPUT", "x-api-path-slug"=>"v1tenant-put", "parameters"=>[{"in"=>"header", "name"=>"Predix-Zone-Id"}, {"in"=>"body", "name"=>"tenantProvisioningRequest", "description"=>"tenantProvisioningRequest", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Update", "Tenant"]}}, "/v1/tenant/profile"=>{"get"=>{"summary"=>"Lookup Tenant by Subdomain", "description"=>"Lookup tenant by subdomain.", "operationId"=>"getTenantBySubdomainUsingGET", "x-api-path-slug"=>"v1tenantprofile-get", "parameters"=>[{"in"=>"header", "name"=>"TMS-Zone-Subdomain"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Lookup", "Tenant", "By", "Subdomain"]}}, "/v1/tenant/profile/service/{serviceName}"=>{"get"=>{"summary"=>"Lookup Tenant service by Subdomain", "description"=>"Lookup tenant service by subdomain.", "operationId"=>"getTenantServiceBySubdomainUsingGET", "x-api-path-slug"=>"v1tenantprofileserviceservicename-get", "parameters"=>[{"in"=>"path", "name"=>"serviceName", "description"=>"serviceName"}, {"in"=>"header", "name"=>"TMS-Zone-Subdomain"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Lookup", "Tenant", "Service", "By", "Subdomain"]}}, "/v1/tenant/{tenantName}"=>{"get"=>{"summary"=>"Retrieve a tenant and its list of services", "description"=>"Retrieve a tenant and its list of services.", "operationId"=>"getTenantUsingGET", "x-api-path-slug"=>"v1tenanttenantname-get", "parameters"=>[{"in"=>"header", "name"=>"Predix-Zone-Id"}, {"in"=>"path", "name"=>"tenantName", "description"=>"tenantName"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieve", "Tenant", "Its", "List", "Of", "Services"]}}, "/v1/tenant/{tenantName}/service/{instanceName}"=>{"put"=>{"summary"=>"update a PROVISIONED service instance", "description"=>"Update a provisioned service instance.", "operationId"=>"updateServiceUsingPUT", "x-api-path-slug"=>"v1tenanttenantnameserviceinstancename-put", "parameters"=>[{"in"=>"path", "name"=>"instanceName", "description"=>"instanceName"}, {"in"=>"header", "name"=>"Predix-Zone-Id"}, {"in"=>"body", "name"=>"serviceRequest", "description"=>"serviceRequest", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tenantName", "description"=>"tenantName"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Update", "PROVISIONED", "Service", "Instance"]}}, "/v1/tenant/{tenantName}/service/{serviceName}"=>{"get"=>{"summary"=>"Retrieve service details", "description"=>"Retrieve service details.", "operationId"=>"getServiceDetailsUsingGET", "x-api-path-slug"=>"v1tenanttenantnameserviceservicename-get", "parameters"=>[{"in"=>"header", "name"=>"Predix-Zone-Id"}, {"in"=>"path", "name"=>"serviceName", "description"=>"serviceName"}, {"in"=>"path", "name"=>"tenantName", "description"=>"tenantName"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieve", "Service", "Details"]}, "delete"=>{"summary"=>"Delete service instance", "description"=>"Delete service instance.", "operationId"=>"deleteServiceInstanceUsingDELETE", "x-api-path-slug"=>"v1tenanttenantnameserviceservicename-delete", "parameters"=>[{"in"=>"query", "name"=>"instanceName", "description"=>"instanceName"}, {"in"=>"header", "name"=>"Predix-Zone-Id"}, {"in"=>"path", "name"=>"serviceName", "description"=>"serviceName"}, {"in"=>"path", "name"=>"tenantName", "description"=>"tenantName"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Service", "Instance"]}}, "/v1/tenant/{tenantName}/service/{serviceName}/credentials"=>{"get"=>{"summary"=>"Retrieve service credentials", "description"=>"Retrieve service credentials.", "operationId"=>"getServiceCredentialsUsingGET", "x-api-path-slug"=>"v1tenanttenantnameserviceservicenamecredentials-get", "parameters"=>[{"in"=>"header", "name"=>"Predix-Zone-Id"}, {"in"=>"path", "name"=>"serviceName", "description"=>"serviceName"}, {"in"=>"path", "name"=>"tenantName", "description"=>"tenantName"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieve", "Service", "Credentials"]}}, "/v1/tenant/{tenantName}/status"=>{"get"=>{"summary"=>"Retrieve a tenant's status", "description"=>"Retrieve a tenant's status.", "operationId"=>"getTenantStatusUsingGET", "x-api-path-slug"=>"v1tenanttenantnamestatus-get", "parameters"=>[{"in"=>"header", "name"=>"Predix-Zone-Id"}, {"in"=>"path", "name"=>"tenantName", "description"=>"tenantName"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieve", "Tenants", "Status"]}}, "/v1/tenant/{tenantname}"=>{"delete"=>{"summary"=>"Delete a tenant", "description"=>"Delete a tenant.", "operationId"=>"deleteTenantUsingDELETE", "x-api-path-slug"=>"v1tenanttenantname-delete", "parameters"=>[{"in"=>"header", "name"=>"Predix-Zone-Id"}, {"in"=>"path", "name"=>"tenantname", "description"=>"tenantName"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenant"]}}, "/v2/tenants/{tenantSubdomain}"=>{"get"=>{"summary"=>"Lookup Tenant by Subdomain", "description"=>"Lookup tenant by subdomain.", "operationId"=>"getTenantProfileBySubdomainUsingGET", "x-api-path-slug"=>"v2tenantstenantsubdomain-get", "parameters"=>[{"in"=>"path", "name"=>"tenantSubdomain", "description"=>"tenantSubdomain"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Lookup", "Tenant", "By", "Subdomain"]}, "put"=>{"summary"=>"Create or Update Tenant by Subdomain", "description"=>"Create or update tenant by subdomain.", "operationId"=>"upsertTenantBySubdomainUsingPUT", "x-api-path-slug"=>"v2tenantstenantsubdomain-put", "parameters"=>[{"in"=>"body", "name"=>"tenantProfile", "description"=>"tenantProfile", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tenantSubdomain", "description"=>"tenantSubdomain"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenant", "By", "Subdomain"]}, "delete"=>{"summary"=>"Delete Tenant by Subdomain", "description"=>"Delete tenant by subdomain.", "operationId"=>"deleteTenantBySubdomainUsingDELETE", "x-api-path-slug"=>"v2tenantstenantsubdomain-delete", "parameters"=>[{"in"=>"path", "name"=>"tenantSubdomain", "description"=>"tenantSubdomain"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenant", "By", "Subdomain"]}}, "/v2/tenants/{tenantSubdomain}/service-instances/{serviceInstanceName}"=>{"get"=>{"summary"=>"Lookup Tenant Service by Subdomain", "description"=>"Lookup tenant service by subdomain.", "operationId"=>"getTenantServiceBySubdomainUsingGET_1", "x-api-path-slug"=>"v2tenantstenantsubdomainserviceinstancesserviceinstancename-get", "parameters"=>[{"in"=>"path", "name"=>"serviceInstanceName", "description"=>"serviceInstanceName"}, {"in"=>"path", "name"=>"tenantSubdomain", "description"=>"tenantSubdomain"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Lookup", "Tenant", "Service", "By", "Subdomain"]}, "put"=>{"summary"=>"Update Tenant Service by Subdomain", "description"=>"Update tenant service by subdomain.", "operationId"=>"upsertTenantServiceUsingPUT", "x-api-path-slug"=>"v2tenantstenantsubdomainserviceinstancesserviceinstancename-put", "parameters"=>[{"in"=>"path", "name"=>"serviceInstanceName", "description"=>"serviceInstanceName"}, {"in"=>"body", "name"=>"serviceRequest", "description"=>"serviceRequest", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tenantSubdomain", "description"=>"tenantSubdomain"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenant", "Service", "By", "Subdomain"]}, "delete"=>{"summary"=>"Delete Tenant Service by Subdomain", "description"=>"Delete tenant service by subdomain.", "operationId"=>"deleteTenantServiceInstanceUsingDELETE", "x-api-path-slug"=>"v2tenantstenantsubdomainserviceinstancesserviceinstancename-delete", "parameters"=>[{"in"=>"path", "name"=>"serviceInstanceName", "description"=>"serviceInstanceName"}, {"in"=>"path", "name"=>"tenantSubdomain", "description"=>"tenantSubdomain"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenant", "Service", "By", "Subdomain"]}}, "/v2/tenants/{tenantSubdomain}/status"=>{"get"=>{"summary"=>"Lookup Tenant status by Subdomain", "description"=>"Lookup tenant status by subdomain.", "operationId"=>"getTenantProfileStatusBySubdomainUsingGET", "x-api-path-slug"=>"v2tenantstenantsubdomainstatus-get", "parameters"=>[{"in"=>"path", "name"=>"tenantSubdomain", "description"=>"tenantSubdomain"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Lookup", "Tenant", "Status", "By", "Subdomain"]}}}}, "predix-blockchain-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Predix BlockChain API", "description"=>"predix-blockchain-restful-api", "version"=>"1.0.0"}, "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/chaincodes/{chaincodeName}"=>{"put"=>{"summary"=>"Put Chaincodes", "description"=>"Deploy chaincode (smart contract) to Blockchain", "operationId"=>"deploy-chaincode-smart-contract-to-blockchain", "x-api-path-slug"=>"v1chaincodeschaincodename-put", "parameters"=>[{"in"=>"formData", "name"=>"args", "description"=>"args for uploaded script, e"}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"formData", "name"=>"chaincode", "description"=>"upload compressed file (tar"}, {"in"=>"path", "name"=>"chaincodeName", "description"=>"name of chain code"}, {"in"=>"header", "name"=>"predix-zone-id", "description"=>"tenantId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chaincodes"]}, "get"=>{"summary"=>"Get Chaincodes", "description"=>"Get a single chaincode", "operationId"=>"get-a-single-chaincode", "x-api-path-slug"=>"v1chaincodeschaincodename-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"chaincodeName", "description"=>"name of deployed chain code"}, {"in"=>"header", "name"=>"predix-zone-id", "description"=>"tenantId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chaincodes"]}}, "/v1/chaincodes"=>{"get"=>{"summary"=>"Get Chaincodes", "description"=>"Get all chaincodes", "operationId"=>"get-all-chaincodes", "x-api-path-slug"=>"v1chaincodes-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"header", "name"=>"predix-zone-id", "description"=>"tenantId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chaincodes"]}}, "/v1/chaincodes/{chaincodeName}/query"=>{"post"=>{"summary"=>"Post Chaincodes Query", "description"=>"Performs query operation on the chaincode and returns the result", "operationId"=>"performs-query-operation-on-the-chaincode-and-returns-the-result", "x-api-path-slug"=>"v1chaincodeschaincodenamequery-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"chaincodeName", "description"=>"chain code name"}, {"in"=>"body", "name"=>"payload", "description"=>"payload of function and args", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"predix-zone-id", "description"=>"tenantId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chaincodes", "Query"]}}, "/v1/users/{userId}/enroll"=>{"post"=>{"summary"=>"Post Users Userid Enroll", "description"=>"Enrolls the blockchain user by downloading its certificates and storing it in Vault. It also maps the oauth user with the blockchain user. This is the very first operation that must be performed.", "operationId"=>"enrolls-the-blockchain-user-by-downloading-its-certificates-and-storing-it-in-vault-it-also-maps-the", "x-api-path-slug"=>"v1usersuseridenroll-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"header", "name"=>"predix-zone-id", "description"=>"tenantId"}, {"in"=>"body", "name"=>"secret", "description"=>"one time password", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"user id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Userid", "Enroll"]}}, "/v1/users/{userId}"=>{"put"=>{"summary"=>"Put User", "description"=>"Registers a new user with blockchain. It sets the attribute 'zone' for the user to 'tenantId' as specified in predix-zone-id header", "operationId"=>"registers-a-new-user-with-blockchain-it-sets-the-attribute-zone-for-the-user-to-tenantid-as-specifie", "x-api-path-slug"=>"v1usersuserid-put", "parameters"=>[{"in"=>"body", "name"=>"attributes", "description"=>"Attributes for this user", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"header", "name"=>"predix-zone-id", "description"=>"tenantId"}, {"in"=>"path", "name"=>"userId", "description"=>"user id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "delete"=>{"summary"=>"Delete Users", "description"=>"Deletes the user and the user mapping with oauth user. User can be deleted only after user has been enrolled.", "operationId"=>"deletes-the-user-and-the-user-mapping-with-oauth-user-user-can-be-deleted-only-after-user-has-been-e", "x-api-path-slug"=>"v1usersuserid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"header", "name"=>"predix-zone-id", "description"=>"tenantId"}, {"in"=>"path", "name"=>"userId", "description"=>"user id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/v1/chaincodes/{chaincodeName}/invoke"=>{"post"=>{"summary"=>"Post Chaincodes Invoke", "description"=>"Performs the invoke or state change operation on chaincode. It invokes the function as specified in the body with given arguments. It returns the transaction id to the user.", "operationId"=>"performs-the-invoke-or-state-change-operation-on-chaincode-it-invokes-the-function-as-specified-in-t", "x-api-path-slug"=>"v1chaincodeschaincodenameinvoke-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"chaincodeName", "description"=>"chain code name"}, {"in"=>"body", "name"=>"payload", "description"=>"payload of function and args", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"predix-zone-id", "description"=>"tenantId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chaincodes", "Invoke"]}}, "/v1/blocks"=>{"get"=>{"summary"=>"Get Blocks", "description"=>"Get current blockchain root info", "operationId"=>"get-current-blockchain-root-info", "x-api-path-slug"=>"v1blocks-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"header", "name"=>"predix-zone-id", "description"=>"tenantId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blocks"]}}, "/v1/blocks/{blockNumber}"=>{"get"=>{"summary"=>"Get Blocks Blocknumber", "description"=>"Get a single blockchain info", "operationId"=>"get-a-single-blockchain-info", "x-api-path-slug"=>"v1blocksblocknumber-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"path", "name"=>"blockNumber", "description"=>"block node number"}, {"in"=>"header", "name"=>"predix-zone-id", "description"=>"tenantId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blocks", "Blocknumber"]}}, "/v1/transactions/{transactionId}"=>{"get"=>{"summary"=>"Get Transactions", "description"=>"Get a transaction info", "operationId"=>"get-a-transaction-info", "x-api-path-slug"=>"v1transactionstransactionid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"access token"}, {"in"=>"header", "name"=>"predix-zone-id", "description"=>"tenantId"}, {"in"=>"path", "name"=>"transactionId", "description"=>"transaction Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transactions"]}}}}, "predix-assets-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Asset", "description"=>"predix-asset-api", "version"=>"1.0.0"}, "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/"=>{"get"=>{"summary"=>"Get a listing of user-defined domain object collections", "description"=>"Returns the names of all user-defined domain object collections with counts of domain objects contained.", "operationId"=>"getV1", "x-api-path-slug"=>"v1-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Listing", "Of", "User-defined", "Domain", "Object", "Collections"]}}, "/v1/{collection}"=>{"get"=>{"summary"=>"Gets all user-defined domain objects.", "description"=>"This is a user-defined domain object collection.\n\nYou can create your own custom domain objects, add properties to them, define relationships, and so on.", "operationId"=>"getV1Collection", "x-api-path-slug"=>"v1collection-get", "parameters"=>[{"in"=>"path", "name"=>"collection", "description"=>"Name of the user-defined domain object collection"}, {"in"=>"query", "name"=>"fields", "description"=>"Fields to be returned from each entity (comma separated)"}, {"in"=>"query", "name"=>"filter", "description"=>"GEL query filter"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Limits the number of entities returned"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "", "User-defined", "Domain", "Objects"]}, "post"=>{"summary"=>"Create one or more user-defined domain objects", "description"=>"This is a user-defined domain object collection.\n\nYou can create your own custom domain objects, add properties to them, define relationships, and so on.\n\nThe following characters are not allowed in any attribute names: $ < > : | ( ) , = ! ? &", "operationId"=>"postV1Collection", "x-api-path-slug"=>"v1collection-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Array of entities to create", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"collection", "description"=>"Name of the user-defined domain object collection"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["More", "User-defined", "Domain", "Objects"]}}, "/v1/{collection}/{id}"=>{"get"=>{"summary"=>"Get entity based on uri", "description"=>"This is a user-defined domain object collection.\n\nYou can create your own custom domain objects, add properties to them, define relationships, and so on.", "operationId"=>"getV1Collection", "x-api-path-slug"=>"v1collectionid-get", "parameters"=>[{"in"=>"path", "name"=>"collection", "description"=>"Name of the user-defined domain object collection"}, {"in"=>"query", "name"=>"fields", "description"=>"Fields to be returned from the entity (comma separated)"}, {"in"=>"path", "name"=>"id", "description"=>"ID of the domain object to retrieve"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Entity", "Based", "On", "", "Uri"]}, "put"=>{"summary"=>"Update a user-defined domain object", "description"=>"This is a user-defined domain object collection.\n\nYou can create your own custom domain objects, add properties to them, define relationships, and so on.\n\nThe following characters are not allowed in any attribute names: $ < > : | ( ) , = ! ? &", "operationId"=>"putV1Collection", "x-api-path-slug"=>"v1collectionid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Array of one entity to create/update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"collection", "description"=>"Name of the user-defined domain object collection"}, {"in"=>"path", "name"=>"id", "description"=>"ID of the domain object to update"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["User-defined", "Domain", "Object"]}, "patch"=>{"summary"=>"Patch a user-defined domain object", "description"=>"This is a user-defined domain object collection.\n\nYou can create your own custom domain objects, add properties to them, define relationships, and so on.\n\nUpdate specific model using http PATCH requests. Request format should follow JSON PATCH format. Supported operations on each attribute are add, remove, replace, move, copy, test. Refer RFC link for more details on request format. https://tools.ietf.org/html/rfc6902", "operationId"=>"patchV1Collection", "x-api-path-slug"=>"v1collectionid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Array of patch operations to apply to the domain object (see: https://tools", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"collection", "description"=>"Name of the user-defined domain object collection"}, {"in"=>"path", "name"=>"id", "description"=>"ID of the domain object to patch"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["User-defined", "Domain", "Object"]}, "delete"=>{"summary"=>"Delete a user-defined domain object", "description"=>"This is a user-defined domain object collection.\n\nYou can create your own custom domain objects, add properties to them, define relationships, and so on.", "operationId"=>"deleteV1Collection", "x-api-path-slug"=>"v1collectionid-delete", "parameters"=>[{"in"=>"path", "name"=>"collection", "description"=>"Name of the user-defined domain object collection"}, {"in"=>"path", "name"=>"id", "description"=>"ID of the domain object to delete"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["User-defined", "Domain", "Object"]}}, "/v1/system/audit"=>{"get"=>{"summary"=>"Get domain object audit records.", "description"=>"For detailed documentation of all available query options please refer to Predix Asset Documentation.", "operationId"=>"getV1SystemAudit", "x-api-path-slug"=>"v1systemaudit-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Fields to be returned from the entity (comma separated)"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Domain", "Object", "Audit", "Records"]}}, "/v1/system/audit/changes"=>{"get"=>{"summary"=>"Get property-level audit records.", "description"=>"For detailed documentation of all available query options please refer to Predix Asset Documentation.", "operationId"=>"getV1SystemAuditChanges", "x-api-path-slug"=>"v1systemauditchanges-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"Fields to be returned from the entity (comma separated)"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Property-level", "Audit", "Records"]}}, "/v1/system/audit/snapshots"=>{"get"=>{"summary"=>"Get a snapshot of an entity at or before a specified datetime (ISO-8601).", "description"=>"For detailed documentation of all available query options please refer to Predix Asset Documentation.", "operationId"=>"getV1SystemAuditSnapshots", "x-api-path-slug"=>"v1systemauditsnapshots-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"identifier={entity uri}:{before|eBefore}={ISO-8601 datetime}"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Snapshot", "Of", "Entity", "At", "Before", "Specified", "Datetime", "(ISO-8601)"]}}, "/v1/system/configs"=>{"get"=>{"summary"=>"Get tenant-specific configuration settings", "description"=>"This can be used to verify whether the audit feature is enabled.", "operationId"=>"getV1SystemConfigs", "x-api-path-slug"=>"v1systemconfigs-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenant-specific", "Configuration", "Settings"]}, "post"=>{"summary"=>"Update tenant-specific configuration settings", "description"=>"This can be used to enable or disable the audit feature.", "operationId"=>"postV1SystemConfigs", "x-api-path-slug"=>"v1systemconfigs-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Array of configs to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenant-specific", "Configuration", "Settings"]}}, "/v1/system/schema/entities/{type}"=>{"get"=>{"summary"=>"Get the JSON Schema of the specified entity type", "description"=>"Get the json schema of the specified entity type.", "operationId"=>"getV1SystemSchemaEntitiesType", "x-api-path-slug"=>"v1systemschemaentitiestype-get", "parameters"=>[{"in"=>"path", "name"=>"type", "description"=>"Entity type (e"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["JSON", "Schema", "Of", "Specified", "Entity", "Type"]}, "put"=>{"summary"=>"Create or update the JSON Schema of the specified entity type", "description"=>"Create or update the json schema of the specified entity type.", "operationId"=>"putV1SystemSchemaEntitiesType", "x-api-path-slug"=>"v1systemschemaentitiestype-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON Schema for the specified entity type", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"type", "description"=>"Entity type (e"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Update", "JSON", "Schema", "Of", "Specified", "Entity", "Type"]}, "delete"=>{"summary"=>"Delete the JSON Schema of the specified entity type", "description"=>"Delete the json schema of the specified entity type.", "operationId"=>"deleteV1SystemSchemaEntitiesType", "x-api-path-slug"=>"v1systemschemaentitiestype-delete", "parameters"=>[{"in"=>"path", "name"=>"type", "description"=>"Entity type (e"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["JSON", "Schema", "Of", "Specified", "Entity", "Type"]}}}}, "predix-intelligent-mapping-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Intelligent Mapping", "description"=>"intelligent-mapping-services-for-geospatial-data-management-and-viewing", "version"=>"1.0.0"}, "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/collections"=>{"get"=>{"summary"=>"List all data collections for a customer", "description"=>"Returns an array containing the names of all data collections for the\nspecified customer.", "operationId"=>"returns-an-array-containing-the-names-of-all-data-collections-for-thespecified-customer", "x-api-path-slug"=>"v1collections-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Data", "Collectionsa", "Customer"]}}, "/v1/collections/{collectionName}"=>{"get"=>{"summary"=>"Return all data for a collection", "description"=>"Returns the full GeoJSON FeatureCollection uploaded for this collection.\nAll GeoJSON Features will be as originally uploaded with the addition of\na featureId attribute that uniquely identifies the feature across all\nyour collections.", "operationId"=>"returns-the-full-geojson-featurecollection-uploaded-for-this-collectionall-geojson-features-will-be-", "x-api-path-slug"=>"v1collectionscollectionname-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "", "Dataa", "Collection"]}, "post"=>{"summary"=>"Add a new collection", "description"=>"Add a new collection of data in the form of a GeoJSON FeatureCollection.\nAll coordinates must be in EPSG:4326 (WGS84) (for further details see\nhttp://epsg.io/4326). Any feature that is not compliant with the GeoJSON\nspecification will not be stored. If the specified collection already\nexists, the geospatial data will be appended to the existing data.", "operationId"=>"add-a-new-collection-of-data-in-the-form-of-a-geojson-featurecollectionall-coordinates-must-be-in-ep", "x-api-path-slug"=>"v1collectionscollectionname-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Geospatial data for the collection", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Collection"]}, "put"=>{"summary"=>"Add a new collection", "description"=>"Add a new collection of data in the form of a GeoJSON FeatureCollection.\nAll coordinates must be in EPSG:4326 (WGS84) (for further details see\nhttp://epsg.io/4326). Any feature that is not compliant with the GeoJSON\nspecification will not be stored. Any feature that doesn't contain an id\nwill not be stored. If the specified collection already exists, the\ngeospatial data will be appended to the existing data. Features with matching\nid's are overwritten.", "operationId"=>"add-a-new-collection-of-data-in-the-form-of-a-geojson-featurecollectionall-coordinates-must-be-in-ep", "x-api-path-slug"=>"v1collectionscollectionname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Geospatial data for the collection", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Collection"]}, "delete"=>{"summary"=>"Delete a collection", "description"=>"Delete the collection of data specified by the collection name.", "operationId"=>"delete-the-collection-of-data-specified-by-the-collection-name", "x-api-path-slug"=>"v1collectionscollectionname-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collection"]}}, "/v1/collections/{collectionName}/spatial-query/bbox-interacts"=>{"get"=>{"summary"=>"Return collection features in specified bounding box", "description"=>"Returns all features in the specified collection that exist fully or\npartially within the specified bounding box. The bounding box is defined\nby two coordinates in the EPSG:4326 (WGS84) (for further details see\nhttp://epsg.io/4326):\n\n* left (longitude), bottom (latitude)\n\n* right (longitude), top (latitude)", "operationId"=>"returns-all-features-in-the-specified-collection-that-exist-fully-orpartially-within-the-specified-b", "x-api-path-slug"=>"v1collectionscollectionnamespatialquerybboxinteracts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "Collection", "Features", "In", "Specified", "Bounding", "Box"]}}, "/v1/collections/{collectionName}/features"=>{"get"=>{"summary"=>"Return feature", "description"=>"Returns GeoJSON of type FeatureCollection containing all GeoJSON features\nfrom the named collection with a matching GeoJSON id.", "operationId"=>"returns-geojson-of-type-featurecollection-containing-all-geojson-featuresfrom-the-named-collection-w", "x-api-path-slug"=>"v1collectionscollectionnamefeatures-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "Feature"]}, "delete"=>{"summary"=>"Delete from the named collection all features with a matching GeoJSON id.", "description"=>"Delete from the named collection all features with a matching GeoJSON id. This could be 0, 1 or many features.", "operationId"=>"delete-from-the-named-collection-all-features-with-a-matching-geojson-id-this-could-be-0-1-or-many-f", "x-api-path-slug"=>"v1collectionscollectionnamefeatures-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["From", "Named", "Collection", "", "Features", "Matching", "GeoJSON", "Id"]}, "post"=>{"summary"=>"Insert an individual feature into a collection.", "description"=>"Insert a new feature into the the named collection. The GeoJSON id is used to identify the feature.\nThe GeoJSON id included in the url must match the top level id member of the feature provided.", "operationId"=>"insert-a-new-feature-into-the-the-named-collection-the-geojson-id-is-used-to-identify-the-featurethe", "x-api-path-slug"=>"v1collectionscollectionnamefeatures-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Insert", "Individual", "Feature", "Into", "Collection"]}, "put"=>{"summary"=>"Update all features in a collection with a matching GeoJSON id.", "description"=>"Updates the attributes and geometry of matching features in the named collection. This could be 0, 1 or many features.", "operationId"=>"updates-the-attributes-and-geometry-of-matching-features-in-the-named-collection--this-could-be-0-1-", "x-api-path-slug"=>"v1collectionscollectionnamefeatures-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Features", "In", "Collection", "Matching", "GeoJSON", "Id"]}}, "/v1/collections/{collectionName}/collectionSize"=>{"get"=>{"summary"=>"Return the size of a collection.", "description"=>"Returns the size of the specified collection to decide whether to use the whole collection for spatial query\nor not.", "operationId"=>"returns-the-size-of-the-specified-collection-to-decide-whether-to-use-the-whole-collection-for-spati", "x-api-path-slug"=>"v1collectionscollectionnamecollectionsize-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "Size", "Of", "Collection"]}}, "/v1/collections/{collectionName}/spatial-query"=>{"post"=>{"summary"=>"For 'within' operator - find all points within an area.\nFor 'nearest' operator - return the nearest point to the one specified.\nFor 'lineIntersectsLine' - find all points of intersection between two linestrings.", "description"=>"'Within' returns GeoGJSON of type FeatureCollection containing all GeoJSON features within the provided polygon.\n'Nearest' returns a FeatureCollection with the longitude and latitude of the nearest point.\n'LineIntersectsLine' returns a FeatureCollection containing all points of intersection as GeoJSON features.", "operationId"=>"within-returns-geogjson-of-type-featurecollection-containing-all-geojson-features-within-the-provide", "x-api-path-slug"=>"v1collectionscollectionnamespatialquery-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"For within query - a geojson polygon which we wish to search", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"operator", "description"=>"The type of spatial query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["For", "Within", "Operator", "-", "Find", "", "Points", "Within", "Area", "For", "Nearest", "Operator", "-", "Return", "Nearest", "Point", "To", "Specified", "For", "LineIntersectsLine", "-", "Find", "", "Points", "Of", "Intersection", "Between", "Two", "Linestrings"]}}, "/v1/collections/{collectionName}/text"=>{"get"=>{"summary"=>"Free text search of a feature collection", "description"=>"Returns GeoJSON of type FeatureCollection containing all GeoJSON features from the named collection that match\nthe supplied search string.\n\nThe search text consists of one or more strings that can be space or comma separated. A match with a given\nfeature occurs only if an exact match can be found for each of the strings in the search text amongst a\nconcatenation of the values of child members of the top level 'properties' member of the feature,\ntogether with the value of its GeoJSON id. The matching is case insensitve, partial matches and\nwildcard searching is not supported.\n\nExamples of search text:\n\n - 28,West End,Histon\n - 240.000 V\n - Company Owned", "operationId"=>"returns-geojson-of-type-featurecollection-containing-all-geojson-features-from-the-named-collection-", "x-api-path-slug"=>"v1collectionscollectionnametext-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The search text"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Free", "Text", "Search", "Of", "Feature", "Collection"]}}, "/v1/collections/{collectionName}/cluster"=>{"get"=>{"summary"=>"Returns clustering data for collection features in specified bounding box", "description"=>"Returns Clustering data for the specified collection that exist fully\n or partially within the specified bounding box. The bounding box is\n defined by two coordinates in the EPSG:4326 (WGS84)\n (for further details see http://epsg.io/4326):\n * left (longitude), bottom (latitude)\n * right (longitude), top (latitude)", "operationId"=>"returns-clustering-data-for-the-specified-collection-that-exist-fully-or-partially-within-the-specif", "x-api-path-slug"=>"v1collectionscollectionnamecluster-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Clustering", "Datacollection", "Features", "In", "Specified", "Bounding", "Box"]}}, "/v1/maps"=>{"get"=>{"summary"=>"List all maps for a customer", "description"=>"Returns an array of maps for the specified customer. The array contains\nthe name and identifier for each map.", "operationId"=>"returns-an-array-of-maps-for-the-specified-customer-the-array-containsthe-name-and-identifier-for-ea", "x-api-path-slug"=>"v1maps-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "", "Mapsa", "Customer"]}, "post"=>{"summary"=>"Create a map", "description"=>"Creates a map with the specified name.", "operationId"=>"creates-a-map-with-the-specified-name", "x-api-path-slug"=>"v1maps-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Map"]}}, "/v1/maps/{mapId}"=>{"get"=>{"summary"=>"Return map details", "description"=>"For the specified map identifier, returns the map properties and an\narray of the associated layers. For each layer, the identifier, name and\nUniform Resource Identifier (URI) are returned.", "operationId"=>"for-the-specified-map-identifier-returns-the-map-properties-and-anarray-of-the-associated-layers-for", "x-api-path-slug"=>"v1mapsmapid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "Map", "Details"]}, "delete"=>{"summary"=>"Delete a map", "description"=>"Deletes the map with the specified identifier. Any layers associated\nwith the map are also deleted.", "operationId"=>"deletes-the-map-with-the-specified-identifier-any-layers-associatedwith-the-map-are-also-deleted", "x-api-path-slug"=>"v1mapsmapid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Map"]}, "put"=>{"summary"=>"Rename a map", "description"=>"Updates the name of the map that has the specified identifier.", "operationId"=>"updates-the-name-of-the-map-that-has-the-specified-identifier", "x-api-path-slug"=>"v1mapsmapid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rename", "Map"]}}, "/v1/maps/{mapId}/orderlayers"=>{"post"=>{"summary"=>"Update order of layers", "description"=>"Updates the order of layers for a given map.", "operationId"=>"updates-the-order-of-layers-for-a-given-map", "x-api-path-slug"=>"v1mapsmapidorderlayers-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order", "Of", "Layers"]}}, "/v1/maps/{mapId}/layers"=>{"post"=>{"summary"=>"Create a new layer", "description"=>"Creates a new layer and associates it with the specified map.", "operationId"=>"creates-a-new-layer-and-associates-it-with-the-specified-map", "x-api-path-slug"=>"v1mapsmapidlayers-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Layer"]}}, "/v1/maps/{mapId}/layers/{layerId}"=>{"get"=>{"summary"=>"Return layer details", "description"=>"For the layer identified by the map and layer identifiers, returns the\nlayer details (identifier, name, Uniform Resource Identifier (URI), and\nvisibility).", "operationId"=>"for-the-layer-identified-by-the-map-and-layer-identifiers-returns-thelayer-details-identifier-name-u", "x-api-path-slug"=>"v1mapsmapidlayerslayerid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "Layer", "Details"]}, "put"=>{"summary"=>"Update the layer properties", "description"=>"For the layer identified by the specified map and layer identifiers,\nupdates the layer properties.", "operationId"=>"for-the-layer-identified-by-the-specified-map-and-layer-identifiersupdates-the-layer-properties", "x-api-path-slug"=>"v1mapsmapidlayerslayerid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layer", "Properties"]}, "delete"=>{"summary"=>"Delete a layer", "description"=>"Deletes the layer identified by the specified map and layer identifiers.", "operationId"=>"deletes-the-layer-identified-by-the-specified-map-and-layer-identifiers", "x-api-path-slug"=>"v1mapsmapidlayerslayerid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layer"]}}, "/v1/maps/{mapId}/layers/{layerId}/style"=>{"get"=>{"summary"=>"Retrieves style data for a layer", "description"=>"Retrieve style data for the layer identified by the specified map and\nlayer identifiers.", "operationId"=>"retrieve-style-data-for-the-layer-identified-by-the-specified-map-andlayer-identifiers", "x-api-path-slug"=>"v1mapsmapidlayerslayeridstyle-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieves", "Style", "Dataa", "Layer"]}, "put"=>{"summary"=>"Update the style data for a layer", "description"=>"Update the style data for the layer identified by the specified map and\nlayer identifiers.", "operationId"=>"update-the-style-data-for-the-layer-identified-by-the-specified-map-andlayer-identifiers", "x-api-path-slug"=>"v1mapsmapidlayerslayeridstyle-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Style data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Style", "Dataa", "Layer"]}}}}, "predix-blockchain-data-integrity-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Blockchain Data Integrity", "description"=>"blockchain-data-integrity-service-provided-by-ericsson", "contact"=>{"name"=>"Ericsson - dcs.support@ericsson.com"}, "version"=>"1.0.0"}, "host"=>"bcdi-proxy-service.run.aws-usw02-pr.ice.predix.io", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/proxy/signature"=>{"post"=>{"summary"=>"Post Proxy Signature", "description"=>"Post proxy signature.", "operationId"=>"postV1ProxySignature", "x-api-path-slug"=>"v1proxysignature-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"token"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"serviceInstanceId"}, {"in"=>"body", "name"=>"request", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Signature"]}}, "/v1/proxy/signature/details"=>{"post"=>{"summary"=>"Post Proxy Signature Details", "description"=>"Post proxy signature details.", "operationId"=>"postV1ProxySignatureDetails", "x-api-path-slug"=>"v1proxysignaturedetails-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"token"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"serviceInstanceId"}, {"in"=>"body", "name"=>"request", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Signature", "Details"]}}, "/v1/proxy/signature/extension"=>{"post"=>{"summary"=>"Post Proxy Signature Extension", "description"=>"Post proxy signature extension.", "operationId"=>"postV1ProxySignatureExtension", "x-api-path-slug"=>"v1proxysignatureextension-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"token"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"serviceInstanceId"}, {"in"=>"body", "name"=>"request", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Signature", "Extension"]}}}}, "predix-access-control-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Access Control", "description"=>"access-control-services-acs--", "version"=>"1.0.0"}, "host"=>"predix-acs.run.aws-usw02-pr.ice.predix.io", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/monitoring/heartbeat"=>{"get"=>{"summary"=>"Monitoring API that allows to check the ACS heartbeat", "description"=>"Monitoring api that allows to check the acs heartbeat.", "operationId"=>"getHeartBeatUsingGET", "x-api-path-slug"=>"monitoringheartbeat-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Monitoring", "That", "Ows", "To", "Check", "ACS", "Heartbeat"]}}, "/v1/connector/resource"=>{"get"=>{"summary"=>"Retrieves connector configuration for external resource attributes for the given zone.", "description"=>"Retrieves connector configuration for external resource attributes for the given zone..", "operationId"=>"getResourceConnectorUsingGET_1", "x-api-path-slug"=>"v1connectorresource-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Connector", "Configurationexternal", "Resource", "Attributesthe", "Given", "Zone"]}, "put"=>{"summary"=>"Creates or updates connector configuration for external resource attributes for the given zone.", "description"=>"Creates or updates connector configuration for external resource attributes for the given zone..", "operationId"=>"putResourceConnectorUsingPUT_1", "x-api-path-slug"=>"v1connectorresource-put", "parameters"=>[{"in"=>"body", "name"=>"connector", "description"=>"New or updated connector configuration for external resource attributes", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Creates", "Updates", "Connector", "Configurationexternal", "Resource", "Attributesthe", "Given", "Zone"]}, "delete"=>{"summary"=>"Deletes connector configuration for external resource attributes for the given zone.", "description"=>"Deletes connector configuration for external resource attributes for the given zone..", "operationId"=>"deleteResourceConnectorUsingDELETE", "x-api-path-slug"=>"v1connectorresource-delete", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Connector", "Configurationexternal", "Resource", "Attributesthe", "Given", "Zone"]}}, "/v1/connector/subject"=>{"get"=>{"summary"=>"Retrieves connector configuration for external subject attributes for the given zone.", "description"=>"Retrieves connector configuration for external subject attributes for the given zone..", "operationId"=>"getSubjectConnectorUsingGET", "x-api-path-slug"=>"v1connectorsubject-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Connector", "Configurationexternal", "Subject", "Attributesthe", "Given", "Zone"]}, "put"=>{"summary"=>"Creates or updates connector configuration for external subject attributes for the given zone.", "description"=>"Creates or updates connector configuration for external subject attributes for the given zone..", "operationId"=>"putSubjectConnectorUsingPUT_1", "x-api-path-slug"=>"v1connectorsubject-put", "parameters"=>[{"in"=>"body", "name"=>"connector", "description"=>"New or updated connector configuration for external subject attributes", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Creates", "Updates", "Connector", "Configurationexternal", "Subject", "Attributesthe", "Given", "Zone"]}, "delete"=>{"summary"=>"Deletes connector configuration for external subject attributes for the given zone.", "description"=>"Deletes connector configuration for external subject attributes for the given zone..", "operationId"=>"deleteSubjectConnectorUsingDELETE", "x-api-path-slug"=>"v1connectorsubject-delete", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Connector", "Configurationexternal", "Subject", "Attributesthe", "Given", "Zone"]}}, "/v1/policy-evaluation"=>{"post"=>{"summary"=>"Evaluates all applicable policies and returns decision result", "description"=>"Evaluates all applicable policies and returns decision result.", "operationId"=>"evalPolicyV1UsingPOST", "x-api-path-slug"=>"v1policyevaluation-post", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Evaluates", "", "Applicable", "Policies", "Returns", "Decision", "Result"]}}, "/v1/policy-set"=>{"get"=>{"summary"=>"Returns all the policy sets for the given zone.", "description"=>"Returns all the policy sets for the given zone..", "operationId"=>"getAllPolicySetsUsingGET_1", "x-api-path-slug"=>"v1policyset-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Returns", "", "Policy", "Setsthe", "Given", "Zone"]}}, "/v1/policy-set/{policySetId}"=>{"get"=>{"summary"=>"Retrieves a policy set for the given zone.", "description"=>"Retrieves a policy set for the given zone..", "operationId"=>"getPolicySetUsingGET", "x-api-path-slug"=>"v1policysetpolicysetid-get", "parameters"=>[{"in"=>"path", "name"=>"policySetId", "description"=>"policySetId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Policy", "Setthe", "Given", "Zone"]}, "put"=>{"summary"=>"Creates/Updates a policy set for the given zone.", "description"=>"Creates/updates a policy set for the given zone..", "operationId"=>"createPolicySetUsingPUT_1", "x-api-path-slug"=>"v1policysetpolicysetid-put", "parameters"=>[{"in"=>"body", "name"=>"policySet", "description"=>"policySet", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"policySetId", "description"=>"policySetId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Creates", "S", "Policy", "Setthe", "Given", "Zone"]}, "delete"=>{"summary"=>"Deletes a policy set for the given zone.", "description"=>"Deletes a policy set for the given zone..", "operationId"=>"deletePolicySetUsingDELETE", "x-api-path-slug"=>"v1policysetpolicysetid-delete", "parameters"=>[{"in"=>"path", "name"=>"policySetId", "description"=>"policySetId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Policy", "Setthe", "Given", "Zone"]}}, "/v1/resource"=>{"get"=>{"summary"=>"Retrieves the list of all resources for the given zone.", "description"=>"Retrieves the list of all resources for the given zone..", "operationId"=>"getResourcesUsingGET", "x-api-path-slug"=>"v1resource-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "List", "Of", "", "Resourcesthe", "Given", "Zone"]}, "post"=>{"summary"=>"Creates a list of resources for the given zone. Existing resources will be updated with the provided values.", "description"=>"Creates a list of resources for the given zone. existing resources will be updated with the provided values..", "operationId"=>"appendResourcesUsingPOST", "x-api-path-slug"=>"v1resource-post", "parameters"=>[{"in"=>"body", "name"=>"resources", "description"=>"resources", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Creates", "List", "Of", "Resourcesthe", "Given", "Zone", "", "Existing", "Resources", "Will", "Be", "Updated", "Provided", "Values"]}}, "/v1/resource/{resourceIdentifier}"=>{"get"=>{"summary"=>"Retrieves the resource for the given zone. The resourceIdentifier must be URL encoded in application/x-www-form-urlencoded format with UTF-8.", "description"=>"Retrieves the resource for the given zone. the resourceidentifier must be url encoded in application/x-www-form-urlencoded format with utf-8..", "operationId"=>"getResourceV1UsingGET", "x-api-path-slug"=>"v1resourceresourceidentifier-get", "parameters"=>[{"in"=>"query", "name"=>"includeInheritedAttributes", "description"=>"includeInheritedAttributes"}, {"in"=>"path", "name"=>"resourceIdentifier", "description"=>"resourceIdentifier"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Resourcethe", "Given", "Zone", "", "ResourceIdentifier", "Must", "Be", "URL", "Encoded", "In", "Application", "X-www-form-urlencoded", "Format", "UTF-8"]}, "put"=>{"summary"=>"Creates/Updates a given resource for a given zone. The resourceIdentifier must be URL encoded in application/x-www-form-urlencoded format with UTF-8.", "description"=>"Creates/updates a given resource for a given zone. the resourceidentifier must be url encoded in application/x-www-form-urlencoded format with utf-8..", "operationId"=>"putResourceV1UsingPUT_1", "x-api-path-slug"=>"v1resourceresourceidentifier-put", "parameters"=>[{"in"=>"body", "name"=>"resource", "description"=>"resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceIdentifier", "description"=>"resourceIdentifier"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Creates", "S", "Given", "Resourcea", "Given", "Zone", "", "ResourceIdentifier", "Must", "Be", "URL", "Encoded", "In", "Application", "X-www-form-urlencoded", "Format", "UTF-8"]}, "delete"=>{"summary"=>"Deletes the resource for a given zone. The resourceIdentifier must be URL encoded in application/x-www-form-urlencoded format with UTF-8.", "description"=>"Deletes the resource for a given zone. the resourceidentifier must be url encoded in application/x-www-form-urlencoded format with utf-8..", "operationId"=>"deleteResourceV1UsingDELETE", "x-api-path-slug"=>"v1resourceresourceidentifier-delete", "parameters"=>[{"in"=>"path", "name"=>"resourceIdentifier", "description"=>"resourceIdentifier"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Resourcea", "Given", "Zone", "", "ResourceIdentifier", "Must", "Be", "URL", "Encoded", "In", "Application", "X-www-form-urlencoded", "Format", "UTF-8"]}}, "/v1/subject"=>{"get"=>{"summary"=>"Retrieves the list of subjects for the given zone.", "description"=>"Retrieves the list of subjects for the given zone..", "operationId"=>"getSubjectsUsingGET_1", "x-api-path-slug"=>"v1subject-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "List", "Of", "Subjectsthe", "Given", "Zone"]}, "post"=>{"summary"=>"Creates a list of subjects. Existing subjects will be updated with the provided values.", "description"=>"Creates a list of subjects. existing subjects will be updated with the provided values..", "operationId"=>"appendsubjectsUsingPOST_1", "x-api-path-slug"=>"v1subject-post", "parameters"=>[{"in"=>"body", "name"=>"subjects", "description"=>"subjects", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Creates", "List", "Of", "Subjects", "", "Existing", "Subjects", "Will", "Be", "Updated", "Provided", "Values"]}}, "/v1/subject/{subjectIdentifier}"=>{"get"=>{"summary"=>"Retrieves the subject for the given zone. The subjectIdentifier must be URL encoded in application/x-www-form-urlencoded format with UTF-8.", "description"=>"Retrieves the subject for the given zone. the subjectidentifier must be url encoded in application/x-www-form-urlencoded format with utf-8..", "operationId"=>"getSubjectUsingGET", "x-api-path-slug"=>"v1subjectsubjectidentifier-get", "parameters"=>[{"in"=>"query", "name"=>"includeInheritedAttributes", "description"=>"includeInheritedAttributes"}, {"in"=>"path", "name"=>"subjectIdentifier", "description"=>"subjectIdentifier"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Retrieves", "Subjectthe", "Given", "Zone", "", "SubjectIdentifier", "Must", "Be", "URL", "Encoded", "In", "Application", "X-www-form-urlencoded", "Format", "UTF-8"]}, "put"=>{"summary"=>"Creates/Updates a given Subject.", "description"=>"Creates/updates a given subject..", "operationId"=>"putSubjectUsingPUT_1", "x-api-path-slug"=>"v1subjectsubjectidentifier-put", "parameters"=>[{"in"=>"body", "name"=>"subject", "description"=>"subject", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"subjectIdentifier", "description"=>"subjectIdentifier"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Creates", "S", "Given", "Subject"]}, "delete"=>{"summary"=>"Deletes the subject for a given zone. The subjectIdentifier must be URL encoded in application/x-www-form-urlencoded format with UTF-8.", "description"=>"Deletes the subject for a given zone. the subjectidentifier must be url encoded in application/x-www-form-urlencoded format with utf-8..", "operationId"=>"deleteSubjectUsingDELETE_1", "x-api-path-slug"=>"v1subjectsubjectidentifier-delete", "parameters"=>[{"in"=>"path", "name"=>"subjectIdentifier", "description"=>"subjectIdentifier"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["S", "Subjecta", "Given", "Zone", "", "SubjectIdentifier", "Must", "Be", "URL", "Encoded", "In", "Application", "X-www-form-urlencoded", "Format", "UTF-8"]}}}}, "predix-sas-esp-predix-service-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"SAS ESP Predix Service API", "description"=>"sas-esp-service-for-predix", "contact"=>{"name"=>"zahid.iqbal2@ge.com"}, "version"=>"1.0.0"}, "host"=>"sas-proxy.run.aws-usw02-pr.ice.predix.io", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/proxy/projects/{id}"=>{"put"=>{"summary"=>"Load/Create Project", "description"=>"API to Load/Create project in ESP server.", "operationId"=>"loadOrCreateProjectUsingPUT", "x-api-path-slug"=>"v1proxyprojectsid-put", "parameters"=>[{"in"=>"body", "name"=>"reqBody", "description"=>"reqBody", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load", "Project"]}, "delete"=>{"summary"=>"Delete project.", "description"=>"API to delete project from ESP server.", "operationId"=>"deleteProjectUsingDELETE", "x-api-path-slug"=>"v1proxyprojectsid-delete", "parameters"=>[{"in"=>"body", "name"=>"reqBody", "description"=>"reqBody", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project"]}}, "/v1/proxy/projects/{id}/state"=>{"put"=>{"summary"=>"Update project status", "description"=>"API to update project status etc. started, running, stopped", "operationId"=>"projectStatusUsingPUT", "x-api-path-slug"=>"v1proxyprojectsidstate-put", "parameters"=>[{"in"=>"body", "name"=>"reqBody", "description"=>"reqBody", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Status"]}}, "/v1/proxy/resource"=>{"get"=>{"summary"=>"retrieve service instance", "description"=>"API to retrieve service instance", "operationId"=>"retrieveUsingGET", "x-api-path-slug"=>"v1proxyresource-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Service", "Instance"]}}, "/v1/proxy/server"=>{"head"=>{"summary"=>"ESP server health check", "description"=>"API to to check health of ESP server.", "operationId"=>"healthCheckUsingHEAD", "x-api-path-slug"=>"v1proxyserver-head", "parameters"=>[{"in"=>"body", "name"=>"reqBody", "description"=>"reqBody", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ESP", "Server", "Health", "Check"]}}}}, "predix-insights-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Api Documentation", "description"=>"api-documentation", "termsOfService"=>"urn:tos", "version"=>"1.0.0"}, "host"=>"insights-api.data-services.predix.io", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/dags"=>{"get"=>{"summary"=>"Get Dags", "description"=>"Get dags.", "operationId"=>"getDAGsUsingGET", "x-api-path-slug"=>"dags-get", "parameters"=>[{"in"=>"query", "name"=>"maxUpdateTime", "description"=>"maxUpdateTime"}, {"in"=>"query", "name"=>"minUpdateTime", "description"=>"minUpdateTime"}, {"in"=>"query", "name"=>"name", "description"=>"name"}, {"in"=>"query", "name"=>"page", "description"=>"Results page you want to retrieve (0"}, {"in"=>"query", "name"=>"size", "description"=>"Number of records per page"}, {"in"=>"query", "name"=>"sort", "description"=>"Sorting criteria in the format: property(,asc|desc)"}, {"in"=>"query", "name"=>"tag", "description"=>"tag"}, {"in"=>"query", "name"=>"type", "description"=>"type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags"]}, "post"=>{"summary"=>"Post Dags", "description"=>"Post dags.", "operationId"=>"saveDAGUsingPOST", "x-api-path-slug"=>"dags-post", "parameters"=>[{"in"=>"body", "name"=>"dag", "description"=>"dag", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags"]}}, "/dags/pause/{dagName}"=>{"put"=>{"summary"=>"Put Dags Pause", "description"=>"Put dags pause.", "operationId"=>"pauseDAGUsingPUT", "x-api-path-slug"=>"dagspausedagname-put", "parameters"=>[{"in"=>"path", "name"=>"dagName", "description"=>"dagName"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags", "Pause"]}}, "/dags/status/{dagName}"=>{"get"=>{"summary"=>"Get Dags Status", "description"=>"Get dags status.", "operationId"=>"getDAGStatusUsingGET", "x-api-path-slug"=>"dagsstatusdagname-get", "parameters"=>[{"in"=>"path", "name"=>"dagName", "description"=>"dagName"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags", "Status"]}}, "/dags/status/{dagName}/runs"=>{"get"=>{"summary"=>"Get Dags Status Runs", "description"=>"Get dags status runs.", "operationId"=>"getDagRunsUsingGET", "x-api-path-slug"=>"dagsstatusdagnameruns-get", "parameters"=>[{"in"=>"path", "name"=>"dagName", "description"=>"dagName"}, {"in"=>"query", "name"=>"end_time", "description"=>"end_time or latest for latest dag run"}, {"in"=>"query", "name"=>"start_time", "description"=>"start_time"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags", "Status", "Runs"]}}, "/dags/status/{dagName}/runs/{runId}"=>{"get"=>{"summary"=>"Get Dags Status Runs Runid", "description"=>"Get dags status runs runid.", "operationId"=>"getUniqueDagRunUsingGET", "x-api-path-slug"=>"dagsstatusdagnamerunsrunid-get", "parameters"=>[{"in"=>"path", "name"=>"dagName", "description"=>"dagName"}, {"in"=>"path", "name"=>"runId", "description"=>"runId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags", "Status", "Runs", "Runid"]}}, "/dags/status/{dagName}/tasks"=>{"get"=>{"summary"=>"Get Dags Status Tasks", "description"=>"Get dags status tasks.", "operationId"=>"getAllDagTasksUsingGET", "x-api-path-slug"=>"dagsstatusdagnametasks-get", "parameters"=>[{"in"=>"path", "name"=>"dagName", "description"=>"dagName"}, {"in"=>"query", "name"=>"end_time", "description"=>"end_time"}, {"in"=>"query", "name"=>"start_time", "description"=>"start_time"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags", "Status", "Tasks"]}}, "/dags/status/{dagName}/tasks/runs/{runId}"=>{"get"=>{"summary"=>"Get Dags Status Tasks Runs Runid", "description"=>"Get dags status tasks runs runid.", "operationId"=>"getTaskStatusByRunIdUsingGET", "x-api-path-slug"=>"dagsstatusdagnametasksrunsrunid-get", "parameters"=>[{"in"=>"path", "name"=>"dagName", "description"=>"dagName"}, {"in"=>"path", "name"=>"runId", "description"=>"runId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags", "Status", "Tasks", "Runs", "Runid"]}}, "/dags/status/{dagName}/tasks/{taskId}"=>{"get"=>{"summary"=>"Get Dags Status Tasks Taskid", "description"=>"Get dags status tasks taskid.", "operationId"=>"getTaskStatusUsingGET", "x-api-path-slug"=>"dagsstatusdagnametaskstaskid-get", "parameters"=>[{"in"=>"path", "name"=>"dagName", "description"=>"dagName"}, {"in"=>"path", "name"=>"taskId", "description"=>"taskId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags", "Status", "Tasks", "Taskid"]}}, "/dags/status/{dagName}/tasks/{taskId}/runs/{runId}"=>{"get"=>{"summary"=>"Get Dags Status Tasks Taskid Runs Runid", "description"=>"Get dags status tasks taskid runs runid.", "operationId"=>"getUniqueRunTaskStatusUsingGET", "x-api-path-slug"=>"dagsstatusdagnametaskstaskidrunsrunid-get", "parameters"=>[{"in"=>"path", "name"=>"dagName", "description"=>"dagName"}, {"in"=>"path", "name"=>"runId", "description"=>"runId"}, {"in"=>"path", "name"=>"taskId", "description"=>"taskId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags", "Status", "Tasks", "Taskid", "Runs", "Runid"]}}, "/dags/statusall"=>{"get"=>{"summary"=>"Get Dags Statusall", "description"=>"Get dags statusall.", "operationId"=>"getDagsByTenantUsingGET", "x-api-path-slug"=>"dagsstatusall-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags", "Statusall"]}}, "/dags/tags"=>{"get"=>{"summary"=>"Get Dags Tags", "description"=>"Get dags tags.", "operationId"=>"getAllDagTagsUsingGET", "x-api-path-slug"=>"dagstags-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags", "Tags"]}}, "/dags/trigger/{dagName}/{dagId}"=>{"post"=>{"summary"=>"Post Dags Trigger", "description"=>"Post dags trigger.", "operationId"=>"triggerDAGUsingPOST", "x-api-path-slug"=>"dagstriggerdagnamedagid-post", "parameters"=>[{"in"=>"query", "name"=>"dagId", "description"=>"dagId"}, {"in"=>"query", "name"=>"dagName", "description"=>"Dag Reference Id"}, {"in"=>"body", "name"=>"jsonBody", "description"=>"jsonBody", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags", "Trigger"]}}, "/dags/{dagName}"=>{"get"=>{"summary"=>"Get Dags", "description"=>"Get dags.", "operationId"=>"getDAGUsingGET", "x-api-path-slug"=>"dagsdagname-get", "parameters"=>[{"in"=>"path", "name"=>"dagName", "description"=>"dagName"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags"]}, "post"=>{"summary"=>"Post Dags", "description"=>"Post dags.", "operationId"=>"updateDAGUsingPOST_1", "x-api-path-slug"=>"dagsdagname-post", "parameters"=>[{"in"=>"path", "name"=>"dagName", "description"=>"dagName"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags"]}, "delete"=>{"summary"=>"Delete Dags", "description"=>"Delete dags.", "operationId"=>"deleteDAGUsingDELETE", "x-api-path-slug"=>"dagsdagname-delete", "parameters"=>[{"in"=>"path", "name"=>"dagName", "description"=>"dagName"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags"]}}, "/dags/{dagName}/deploy"=>{"post"=>{"summary"=>"Post Dags Deploy", "description"=>"Post dags deploy.", "operationId"=>"deployDAGUsingPOST", "x-api-path-slug"=>"dagsdagnamedeploy-post", "parameters"=>[{"in"=>"path", "name"=>"dagName", "description"=>"dagName"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dags", "Deploy"]}}, "/dependencies"=>{"get"=>{"summary"=>"Get Dependencies", "description"=>"Get dependencies.", "operationId"=>"getDependencyListUsingGET", "x-api-path-slug"=>"dependencies-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Results page you want to retrieve (0"}, {"in"=>"query", "name"=>"size", "description"=>"Number of records per page"}, {"in"=>"query", "name"=>"sort", "description"=>"Sorting criteria in the format: property(,asc|desc)"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dependencies"]}, "post"=>{"summary"=>"Post Dependencies", "description"=>"Post dependencies.", "operationId"=>"createDependencyUsingPOST", "x-api-path-slug"=>"dependencies-post", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dependencies"]}}, "/dependencies/deploy"=>{"post"=>{"summary"=>"Post Dependencies Deploy", "description"=>"Post dependencies deploy.", "operationId"=>"deployDependencyUsingPOST_1", "x-api-path-slug"=>"dependenciesdeploy-post", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dependencies", "Deploy"]}}, "/dependencies/deploy/{dependencyId}"=>{"post"=>{"summary"=>"Post Dependencies Deploy Dependencyid", "description"=>"Post dependencies deploy dependencyid.", "operationId"=>"deployDependencyUsingPOST", "x-api-path-slug"=>"dependenciesdeploydependencyid-post", "parameters"=>[{"in"=>"path", "name"=>"dependencyId", "description"=>"dependencyId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dependencies", "Deploy", "Dependencyid"]}}, "/dependencies/tags"=>{"get"=>{"summary"=>"Get Dependencies Tags", "description"=>"Get dependencies tags.", "operationId"=>"getAllDependencyTagsUsingGET", "x-api-path-slug"=>"dependenciestags-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dependencies", "Tags"]}}, "/dependencies/undeploy"=>{"post"=>{"summary"=>"Post Dependencies Undeploy", "description"=>"Post dependencies undeploy.", "operationId"=>"undeployDependencyUsingPOST_1", "x-api-path-slug"=>"dependenciesundeploy-post", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dependencies", "Undeploy"]}}, "/dependencies/undeploy/{dependencyId}"=>{"post"=>{"summary"=>"Post Dependencies Undeploy Dependencyid", "description"=>"Post dependencies undeploy dependencyid.", "operationId"=>"undeployDependencyUsingPOST", "x-api-path-slug"=>"dependenciesundeploydependencyid-post", "parameters"=>[{"in"=>"path", "name"=>"dependencyId", "description"=>"dependencyId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dependencies", "Undeploy", "Dependencyid"]}}, "/dependencies/{dependencyId}"=>{"get"=>{"summary"=>"Get Dependencies Dependencyid", "description"=>"Get dependencies dependencyid.", "operationId"=>"getDependencyUsingGET", "x-api-path-slug"=>"dependenciesdependencyid-get", "parameters"=>[{"in"=>"path", "name"=>"dependencyId", "description"=>"dependencyId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dependencies", "Dependencyid"]}, "post"=>{"summary"=>"Post Dependencies Dependencyid", "description"=>"Post dependencies dependencyid.", "operationId"=>"updateDependencyUsingPOST", "x-api-path-slug"=>"dependenciesdependencyid-post", "parameters"=>[{"in"=>"path", "name"=>"dependencyId", "description"=>"dependencyId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dependencies", "Dependencyid"]}, "delete"=>{"summary"=>"Delete Dependencies Dependencyid", "description"=>"Delete dependencies dependencyid.", "operationId"=>"deleteDependencyUsingDELETE", "x-api-path-slug"=>"dependenciesdependencyid-delete", "parameters"=>[{"in"=>"path", "name"=>"dependencyId", "description"=>"dependencyId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Dependencies", "Dependencyid"]}}, "/flow-templates"=>{"get"=>{"summary"=>"Get Flow Templates", "description"=>"Get flow templates.", "operationId"=>"getFlowTemplatesUsingGET", "x-api-path-slug"=>"flowtemplates-get", "parameters"=>[{"in"=>"query", "name"=>"displayShellTemplates", "description"=>"displayShellTemplates"}, {"in"=>"query", "name"=>"maxUpdateTime", "description"=>"maxUpdateTime"}, {"in"=>"query", "name"=>"minUpdateTime", "description"=>"minUpdateTime"}, {"in"=>"query", "name"=>"name", "description"=>"name"}, {"in"=>"query", "name"=>"page", "description"=>"Results page you want to retrieve (0"}, {"in"=>"query", "name"=>"size", "description"=>"Number of records per page"}, {"in"=>"query", "name"=>"sort", "description"=>"Sorting criteria in the format: property(,asc|desc)"}, {"in"=>"query", "name"=>"tag", "description"=>"tag"}, {"in"=>"query", "name"=>"type", "description"=>"type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates"]}, "post"=>{"summary"=>"Post Flow Templates", "description"=>"Post flow templates.", "operationId"=>"saveFlowTemplateUsingPOST", "x-api-path-slug"=>"flowtemplates-post", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates"]}}, "/flow-templates/tags"=>{"get"=>{"summary"=>"Get Flow Templates Tags", "description"=>"Get flow templates tags.", "operationId"=>"getAllFlowTemplateTagsUsingGET", "x-api-path-slug"=>"flowtemplatestags-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Tags"]}}, "/flow-templates/{flowTemplateId}"=>{"get"=>{"summary"=>"Get Flow Templates Flowtemplateid", "description"=>"Get flow templates flowtemplateid.", "operationId"=>"getFlowTemplateUsingGET", "x-api-path-slug"=>"flowtemplatesflowtemplateid-get", "parameters"=>[{"in"=>"path", "name"=>"flowTemplateId", "description"=>"flowTemplateId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid"]}, "post"=>{"summary"=>"Post Flow Templates Flowtemplateid", "description"=>"Post flow templates flowtemplateid.", "operationId"=>"updateFlowTemplateUsingPOST", "x-api-path-slug"=>"flowtemplatesflowtemplateid-post", "parameters"=>[{"in"=>"path", "name"=>"flowTemplateId", "description"=>"flowTemplateId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid"]}, "put"=>{"summary"=>"Put Flow Templates Flowtemplateid", "description"=>"Put flow templates flowtemplateid.", "operationId"=>"updateFlowTemplateUsingPUT", "x-api-path-slug"=>"flowtemplatesflowtemplateid-put", "parameters"=>[{"in"=>"body", "name"=>"flowTemplate", "description"=>"flowTemplate", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"flowTemplateId", "description"=>"flowTemplateId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid"]}, "delete"=>{"summary"=>"Delete Flow Templates Flowtemplateid", "description"=>"Delete flow templates flowtemplateid.", "operationId"=>"deleteFlowTemplateUsingDELETE", "x-api-path-slug"=>"flowtemplatesflowtemplateid-delete", "parameters"=>[{"in"=>"path", "name"=>"flowTemplateId", "description"=>"flowTemplateId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid"]}}, "/flow-templates/{flowTemplateId}/download"=>{"get"=>{"summary"=>"Get Flow Templates Flowtemplateid Download", "description"=>"Get flow templates flowtemplateid download.", "operationId"=>"getFlowTemplateFileUsingGET", "x-api-path-slug"=>"flowtemplatesflowtemplateiddownload-get", "parameters"=>[{"in"=>"path", "name"=>"flowTemplateId", "description"=>"flowTemplateId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "Download"]}}, "/flow-templates/{flowTemplateId}/flows"=>{"get"=>{"summary"=>"Get Flow Templates Flowtemplateid Flows", "description"=>"Get flow templates flowtemplateid flows.", "operationId"=>"getFlowsUsingGET_1", "x-api-path-slug"=>"flowtemplatesflowtemplateidflows-get", "parameters"=>[{"in"=>"path", "name"=>"flowTemplateId", "description"=>"flowTemplateId"}, {"in"=>"query", "name"=>"maxUpdateTime", "description"=>"maxUpdateTime"}, {"in"=>"query", "name"=>"minUpdateTime", "description"=>"minUpdateTime"}, {"in"=>"query", "name"=>"name", "description"=>"name"}, {"in"=>"query", "name"=>"page", "description"=>"Results page you want to retrieve (0"}, {"in"=>"query", "name"=>"size", "description"=>"Number of records per page"}, {"in"=>"query", "name"=>"sort", "description"=>"Sorting criteria in the format: property(,asc|desc)"}, {"in"=>"query", "name"=>"tag", "description"=>"tag"}, {"in"=>"query", "name"=>"type", "description"=>"type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "Flows"]}, "post"=>{"summary"=>"Post Flow Templates Flowtemplateid Flows", "description"=>"Post flow templates flowtemplateid flows.", "operationId"=>"saveFlowUsingPOST_1", "x-api-path-slug"=>"flowtemplatesflowtemplateidflows-post", "parameters"=>[{"in"=>"path", "name"=>"flowTemplateId", "description"=>"flowTemplateId"}, {"in"=>"query", "name"=>"launch", "description"=>"launch"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "Flows"]}}, "/flow-templates/{flowTemplateId}/flows/{flowId}"=>{"get"=>{"summary"=>"Get Flow Templates Flowtemplateid Flows Flowid", "description"=>"Get flow templates flowtemplateid flows flowid.", "operationId"=>"getFlowUsingGET_1", "x-api-path-slug"=>"flowtemplatesflowtemplateidflowsflowid-get", "parameters"=>[{"in"=>"path", "name"=>"flowId", "description"=>"flowId"}, {"in"=>"path", "name"=>"flowTemplateId", "description"=>"flowTemplateId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "Flows", "Flowid"]}, "post"=>{"summary"=>"Post Flow Templates Flowtemplateid Flows Flowid", "description"=>"Post flow templates flowtemplateid flows flowid.", "operationId"=>"updateFlowUsingPOST_1", "x-api-path-slug"=>"flowtemplatesflowtemplateidflowsflowid-post", "parameters"=>[{"in"=>"body", "name"=>"flow", "description"=>"flow", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"flowId", "description"=>"flowId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "Flows", "Flowid"]}, "delete"=>{"summary"=>"Delete Flow Templates Flowtemplateid Flows Flowid", "description"=>"Delete flow templates flowtemplateid flows flowid.", "operationId"=>"deleteFlowUsingDELETE_1", "x-api-path-slug"=>"flowtemplatesflowtemplateidflowsflowid-delete", "parameters"=>[{"in"=>"path", "name"=>"flowId", "description"=>"flowId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "Flows", "Flowid"]}}, "/flow-templates/{flowTemplateId}/flows/{flowId}/config"=>{"get"=>{"summary"=>"Get Flow Templates Flowtemplateid Flows Flowid Config", "description"=>"Get flow templates flowtemplateid flows flowid config.", "operationId"=>"listFlowConfigFilesUsingGET_1", "x-api-path-slug"=>"flowtemplatesflowtemplateidflowsflowidconfig-get", "parameters"=>[{"in"=>"path", "name"=>"flowId", "description"=>"flowId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "Flows", "Flowid", "Config"]}, "post"=>{"summary"=>"Post Flow Templates Flowtemplateid Flows Flowid Config", "description"=>"Post flow templates flowtemplateid flows flowid config.", "operationId"=>"addFlowConfigFileUsingPOST_1", "x-api-path-slug"=>"flowtemplatesflowtemplateidflowsflowidconfig-post", "parameters"=>[{"in"=>"path", "name"=>"flowId", "description"=>"flowId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "Flows", "Flowid", "Config"]}}, "/flow-templates/{flowTemplateId}/flows/{flowId}/config/{fileName}"=>{"get"=>{"summary"=>"Get Flow Templates Flowtemplateid Flows Flowid Config Filename", "description"=>"Get flow templates flowtemplateid flows flowid config filename.", "operationId"=>"getFlowConfigFileUsingGET_1", "x-api-path-slug"=>"flowtemplatesflowtemplateidflowsflowidconfigfilename-get", "parameters"=>[{"in"=>"path", "name"=>"fileName", "description"=>"fileName"}, {"in"=>"path", "name"=>"flowId", "description"=>"flowId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "Flows", "Flowid", "Config", "Filename"]}, "delete"=>{"summary"=>"Delete Flow Templates Flowtemplateid Flows Flowid Config Filename", "description"=>"Delete flow templates flowtemplateid flows flowid config filename.", "operationId"=>"deleteFlowConfigFileUsingDELETE_1", "x-api-path-slug"=>"flowtemplatesflowtemplateidflowsflowidconfigfilename-delete", "parameters"=>[{"in"=>"path", "name"=>"fileName", "description"=>"fileName"}, {"in"=>"path", "name"=>"flowId", "description"=>"flowId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "Flows", "Flowid", "Config", "Filename"]}}, "/flow-templates/{flowTemplateId}/flows/{flowId}/launch"=>{"post"=>{"summary"=>"Post Flow Templates Flowtemplateid Flows Flowid Launch", "description"=>"Post flow templates flowtemplateid flows flowid launch.", "operationId"=>"launchUsingPOST_1", "x-api-path-slug"=>"flowtemplatesflowtemplateidflowsflowidlaunch-post", "parameters"=>[{"in"=>"path", "name"=>"flowId", "description"=>"flowId"}, {"in"=>"body", "name"=>"launchRequest", "description"=>"launchRequest", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "Flows", "Flowid", "Launch"]}}, "/flow-templates/{flowTemplateId}/flows/{flowId}/stop"=>{"post"=>{"summary"=>"Post Flow Templates Flowtemplateid Flows Flowid Stop", "description"=>"Post flow templates flowtemplateid flows flowid stop.", "operationId"=>"stopUsingPOST_1", "x-api-path-slug"=>"flowtemplatesflowtemplateidflowsflowidstop-post", "parameters"=>[{"in"=>"path", "name"=>"flowId", "description"=>"flowId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "Flows", "Flowid", "Stop"]}}, "/flow-templates/{flowTemplateId}/flows/{flowId}/tags"=>{"get"=>{"summary"=>"Get Flow Templates Flowtemplateid Flows Flowid Tags", "description"=>"Get flow templates flowtemplateid flows flowid tags.", "operationId"=>"getFlowTagsUsingGET", "x-api-path-slug"=>"flowtemplatesflowtemplateidflowsflowidtags-get", "parameters"=>[{"in"=>"path", "name"=>"flowId", "description"=>"flowId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "Flows", "Flowid", "Tags"]}, "post"=>{"summary"=>"Post Flow Templates Flowtemplateid Flows Flowid Tags", "description"=>"Post flow templates flowtemplateid flows flowid tags.", "operationId"=>"saveFlowTagsUsingPOST_1", "x-api-path-slug"=>"flowtemplatesflowtemplateidflowsflowidtags-post", "parameters"=>[{"in"=>"path", "name"=>"flowId", "description"=>"flowId"}, {"in"=>"body", "name"=>"tags", "description"=>"tags", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "Flows", "Flowid", "Tags"]}}, "/flow-templates/{flowTemplateId}/list"=>{"get"=>{"summary"=>"Get Flow Templates Flowtemplateid List", "description"=>"Get flow templates flowtemplateid list.", "operationId"=>"listFlowTemplateAnalyticFileUsingGET", "x-api-path-slug"=>"flowtemplatesflowtemplateidlist-get", "parameters"=>[{"in"=>"path", "name"=>"flowTemplateId", "description"=>"flowTemplateId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "List"]}}, "/flow-templates/{flowTemplateId}/tags"=>{"get"=>{"summary"=>"Get Flow Templates Flowtemplateid Tags", "description"=>"Get flow templates flowtemplateid tags.", "operationId"=>"getTemplateTagsUsingGET", "x-api-path-slug"=>"flowtemplatesflowtemplateidtags-get", "parameters"=>[{"in"=>"path", "name"=>"flowTemplateId", "description"=>"flowTemplateId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "Tags"]}, "post"=>{"summary"=>"Post Flow Templates Flowtemplateid Tags", "description"=>"Post flow templates flowtemplateid tags.", "operationId"=>"saveTemplateTagsUsingPOST", "x-api-path-slug"=>"flowtemplatesflowtemplateidtags-post", "parameters"=>[{"in"=>"path", "name"=>"flowTemplateId", "description"=>"flowTemplateId"}, {"in"=>"body", "name"=>"tags", "description"=>"tags", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flow", "Templates", "Flowtemplateid", "Tags"]}}, "/flows"=>{"get"=>{"summary"=>"Get Flows", "description"=>"Get flows.", "operationId"=>"getFlowsUsingGET", "x-api-path-slug"=>"flows-get", "parameters"=>[{"in"=>"query", "name"=>"maxUpdateTime", "description"=>"maxUpdateTime"}, {"in"=>"query", "name"=>"minUpdateTime", "description"=>"minUpdateTime"}, {"in"=>"query", "name"=>"name", "description"=>"name"}, {"in"=>"query", "name"=>"page", "description"=>"Results page you want to retrieve (0"}, {"in"=>"query", "name"=>"size", "description"=>"Number of records per page"}, {"in"=>"query", "name"=>"sort", "description"=>"Sorting criteria in the format: property(,asc|desc)"}, {"in"=>"query", "name"=>"tag", "description"=>"tag"}, {"in"=>"query", "name"=>"type", "description"=>"type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flows"]}, "post"=>{"summary"=>"Post Flows", "description"=>"Post flows.", "operationId"=>"saveDirectFlowUsingPOST", "x-api-path-slug"=>"flows-post", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flows"]}}, "/flows/tags"=>{"get"=>{"summary"=>"Get Flows Tags", "description"=>"Get flows tags.", "operationId"=>"getAllFlowTagsUsingGET", "x-api-path-slug"=>"flowstags-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flows", "Tags"]}}, "/flows/{flowId}"=>{"post"=>{"summary"=>"Post Flows Flowid", "description"=>"Post flows flowid.", "operationId"=>"updateDirectFlowUsingPOST", "x-api-path-slug"=>"flowsflowid-post", "parameters"=>[{"in"=>"path", "name"=>"flowId", "description"=>"flowId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flows", "Flowid"]}, "delete"=>{"summary"=>"Delete Flows Flowid", "description"=>"Delete flows flowid.", "operationId"=>"deleteFlowUsingDELETE", "x-api-path-slug"=>"flowsflowid-delete", "parameters"=>[{"in"=>"path", "name"=>"flowId", "description"=>"flowId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flows", "Flowid"]}}, "/flows/{flowId}/config"=>{"get"=>{"summary"=>"Get Flows Flowid Config", "description"=>"Get flows flowid config.", "operationId"=>"listFlowConfigFilesUsingGET", "x-api-path-slug"=>"flowsflowidconfig-get", "parameters"=>[{"in"=>"path", "name"=>"flowId", "description"=>"flowId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flows", "Flowid", "Config"]}, "post"=>{"summary"=>"Post Flows Flowid Config", "description"=>"Post flows flowid config.", "operationId"=>"addFlowConfigFileUsingPOST", "x-api-path-slug"=>"flowsflowidconfig-post", "parameters"=>[{"in"=>"path", "name"=>"flowId", "description"=>"flowId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flows", "Flowid", "Config"]}}, "/flows/{flowId}/config/{fileName}"=>{"get"=>{"summary"=>"Get Flows Flowid Config Filename", "description"=>"Get flows flowid config filename.", "operationId"=>"getFlowConfigFileUsingGET", "x-api-path-slug"=>"flowsflowidconfigfilename-get", "parameters"=>[{"in"=>"path", "name"=>"fileName", "description"=>"fileName"}, {"in"=>"path", "name"=>"flowId", "description"=>"flowId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flows", "Flowid", "Config", "Filename"]}, "delete"=>{"summary"=>"Delete Flows Flowid Config Filename", "description"=>"Delete flows flowid config filename.", "operationId"=>"deleteFlowConfigFileUsingDELETE", "x-api-path-slug"=>"flowsflowidconfigfilename-delete", "parameters"=>[{"in"=>"path", "name"=>"fileName", "description"=>"fileName"}, {"in"=>"path", "name"=>"flowId", "description"=>"flowId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flows", "Flowid", "Config", "Filename"]}}, "/flows/{flowId}/create-template"=>{"post"=>{"summary"=>"Post Flows Flowid Create Template", "description"=>"Post flows flowid create template.", "operationId"=>"createTemplateFromDirectFlowUsingPOST", "x-api-path-slug"=>"flowsflowidcreatetemplate-post", "parameters"=>[{"in"=>"path", "name"=>"flowId", "description"=>"flowId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flows", "Flowid", "Template"]}}, "/flows/{flowId}/download"=>{"get"=>{"summary"=>"Get Flows Flowid Download", "description"=>"Get flows flowid download.", "operationId"=>"getFlowAnalyticFileUsingGET", "x-api-path-slug"=>"flowsflowiddownload-get", "parameters"=>[{"in"=>"path", "name"=>"flowId", "description"=>"flowId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flows", "Flowid", "Download"]}}, "/flows/{flowId}/tags"=>{"post"=>{"summary"=>"Post Flows Flowid Tags", "description"=>"Post flows flowid tags.", "operationId"=>"saveFlowTagsUsingPOST", "x-api-path-slug"=>"flowsflowidtags-post", "parameters"=>[{"in"=>"path", "name"=>"flowId", "description"=>"flowId"}, {"in"=>"body", "name"=>"tags", "description"=>"tags", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flows", "Flowid", "Tags"]}}, "/flows/{flowName}"=>{"get"=>{"summary"=>"Get Flows Flowname", "description"=>"Get flows flowname.", "operationId"=>"getFlowUsingGET", "x-api-path-slug"=>"flowsflowname-get", "parameters"=>[{"in"=>"path", "name"=>"flowName", "description"=>"flowName"}, {"in"=>"query", "name"=>"id", "description"=>"id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flows", "Flowname"]}}, "/flows/{flowName}/launch"=>{"post"=>{"summary"=>"Post Flows Flowname Launch", "description"=>"Post flows flowname launch.", "operationId"=>"launchUsingPOST", "x-api-path-slug"=>"flowsflownamelaunch-post", "parameters"=>[{"in"=>"path", "name"=>"flowName", "description"=>"flowName"}, {"in"=>"body", "name"=>"launchRequest", "description"=>"launchRequest", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flows", "Flowname", "Launch"]}}, "/flows/{flowName}/stop"=>{"post"=>{"summary"=>"Post Flows Flowname Stop", "description"=>"Post flows flowname stop.", "operationId"=>"stopUsingPOST", "x-api-path-slug"=>"flowsflownamestop-post", "parameters"=>[{"in"=>"path", "name"=>"flowName", "description"=>"flowName"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Flows", "Flowname", "Stop"]}}, "/instances"=>{"get"=>{"summary"=>"Get Instances", "description"=>"Get instances.", "operationId"=>"findInstancesUsingGET", "x-api-path-slug"=>"instances-get", "parameters"=>[{"in"=>"query", "name"=>"flowName", "description"=>"flowName"}, {"in"=>"query", "name"=>"maxUpdateTime", "description"=>"maxUpdateTime"}, {"in"=>"query", "name"=>"minUpdateTime", "description"=>"minUpdateTime"}, {"in"=>"query", "name"=>"name", "description"=>"name"}, {"in"=>"query", "name"=>"page", "description"=>"Results page you want to retrieve (0"}, {"in"=>"query", "name"=>"size", "description"=>"Number of records per page"}, {"in"=>"query", "name"=>"sort", "description"=>"Sorting criteria in the format: property(,asc|desc)"}, {"in"=>"query", "name"=>"statuses", "description"=>"statuses"}, {"in"=>"query", "name"=>"tag", "description"=>"tag"}, {"in"=>"query", "name"=>"type", "description"=>"type"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Instances"]}}, "/instances/{instanceId}"=>{"get"=>{"summary"=>"Get Instances Instanceid", "description"=>"Get instances instanceid.", "operationId"=>"getInstanceUsingGET", "x-api-path-slug"=>"instancesinstanceid-get", "parameters"=>[{"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Instances", "Instanceid"]}, "delete"=>{"summary"=>"Delete Instances Instanceid", "description"=>"Delete instances instanceid.", "operationId"=>"stopInstanceUsingDELETE", "x-api-path-slug"=>"instancesinstanceid-delete", "parameters"=>[{"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Instances", "Instanceid"]}}, "/instances/{instanceId}/appattempts/{attemptId}/containers"=>{"get"=>{"summary"=>"Get Instances Instanceid Appattempts Attemptid Containers", "description"=>"Get instances instanceid appattempts attemptid containers.", "operationId"=>"getInstanceAttemptContainersUsingGET", "x-api-path-slug"=>"instancesinstanceidappattemptsattemptidcontainers-get", "parameters"=>[{"in"=>"path", "name"=>"attemptId", "description"=>"attemptId"}, {"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Instances", "Instanceid", "Appattempts", "Attemptid", "Containers"]}}, "/instances/{instanceId}/config"=>{"get"=>{"summary"=>"Get Instances Instanceid Config", "description"=>"Get instances instanceid config.", "operationId"=>"listInstanceConfigFileUsingGET", "x-api-path-slug"=>"instancesinstanceidconfig-get", "parameters"=>[{"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Instances", "Instanceid", "Config"]}}, "/instances/{instanceId}/config/{fileName}"=>{"get"=>{"summary"=>"Get Instances Instanceid Config Filename", "description"=>"Get instances instanceid config filename.", "operationId"=>"getInstanceConfigFileUsingGET", "x-api-path-slug"=>"instancesinstanceidconfigfilename-get", "parameters"=>[{"in"=>"path", "name"=>"fileName", "description"=>"fileName"}, {"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Instances", "Instanceid", "Config", "Filename"]}}, "/instances/{instanceId}/containers"=>{"get"=>{"summary"=>"Get Instances Instanceid Containers", "description"=>"Get instances instanceid containers.", "operationId"=>"getInstanceContainersUsingGET", "x-api-path-slug"=>"instancesinstanceidcontainers-get", "parameters"=>[{"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Instances", "Instanceid", "Containers"]}}, "/instances/{instanceId}/containers/{containerId}/logs"=>{"get"=>{"summary"=>"Get Instances Instanceid Containers Containerid Logs", "description"=>"Get instances instanceid containers containerid logs.", "operationId"=>"getInstanceContainerLogsUsingGET", "x-api-path-slug"=>"instancesinstanceidcontainerscontaineridlogs-get", "parameters"=>[{"in"=>"path", "name"=>"containerId", "description"=>"containerId"}, {"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Instances", "Instanceid", "Containers", "Containerid", "Logs"]}}, "/instances/{instanceId}/containers/{containerId}/logs/{logName}"=>{"get"=>{"summary"=>"Get Instances Instanceid Containers Containerid Logs Logname", "description"=>"Get instances instanceid containers containerid logs logname.", "operationId"=>"getInstanceContainerLogContentsUsingGET", "x-api-path-slug"=>"instancesinstanceidcontainerscontaineridlogslogname-get", "parameters"=>[{"in"=>"path", "name"=>"containerId", "description"=>"containerId"}, {"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}, {"in"=>"query", "name"=>"length", "description"=>"length"}, {"in"=>"path", "name"=>"logName", "description"=>"logName"}, {"in"=>"query", "name"=>"offset", "description"=>"offset"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Instances", "Instanceid", "Containers", "Containerid", "Logs", "Logname"]}}, "/instances/{instanceId}/sparkproxy/**"=>{"get"=>{"summary"=>"Get Instances Instanceid Sparkproxy **", "description"=>"Get instances instanceid sparkproxy **.", "operationId"=>"getInstanceSparkProxyUsingGET", "x-api-path-slug"=>"instancesinstanceidsparkproxy-get", "parameters"=>[{"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Instances", "Instanceid", "Sparkproxy", "**"]}, "head"=>{"summary"=>"Head Instances Instanceid Sparkproxy **", "description"=>"Head instances instanceid sparkproxy **.", "operationId"=>"getInstanceSparkProxyUsingHEAD", "x-api-path-slug"=>"instancesinstanceidsparkproxy-head", "parameters"=>[{"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Head", "Instances", "Instanceid", "Sparkproxy", "**"]}, "post"=>{"summary"=>"Post Instances Instanceid Sparkproxy **", "description"=>"Post instances instanceid sparkproxy **.", "operationId"=>"getInstanceSparkProxyUsingPOST", "x-api-path-slug"=>"instancesinstanceidsparkproxy-post", "parameters"=>[{"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Instances", "Instanceid", "Sparkproxy", "**"]}, "put"=>{"summary"=>"Put Instances Instanceid Sparkproxy **", "description"=>"Put instances instanceid sparkproxy **.", "operationId"=>"getInstanceSparkProxyUsingPUT", "x-api-path-slug"=>"instancesinstanceidsparkproxy-put", "parameters"=>[{"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Instances", "Instanceid", "Sparkproxy", "**"]}, "delete"=>{"summary"=>"Delete Instances Instanceid Sparkproxy **", "description"=>"Delete instances instanceid sparkproxy **.", "operationId"=>"getInstanceSparkProxyUsingDELETE", "x-api-path-slug"=>"instancesinstanceidsparkproxy-delete", "parameters"=>[{"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Instances", "Instanceid", "Sparkproxy", "**"]}, "options"=>{"summary"=>"Options Instances Instanceid Sparkproxy **", "description"=>"Options instances instanceid sparkproxy **.", "operationId"=>"getInstanceSparkProxyUsingOPTIONS", "x-api-path-slug"=>"instancesinstanceidsparkproxy-options", "parameters"=>[{"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Options", "Instances", "Instanceid", "Sparkproxy", "**"]}, "patch"=>{"summary"=>"Patch Instances Instanceid Sparkproxy **", "description"=>"Patch instances instanceid sparkproxy **.", "operationId"=>"getInstanceSparkProxyUsingPATCH", "x-api-path-slug"=>"instancesinstanceidsparkproxy-patch", "parameters"=>[{"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Instances", "Instanceid", "Sparkproxy", "**"]}}, "/instances/{instanceId}/submit-logs"=>{"get"=>{"summary"=>"Get Instances Instanceid Submit Logs", "description"=>"Get instances instanceid submit logs.", "operationId"=>"getSparkSubmitLogsUsingGET", "x-api-path-slug"=>"instancesinstanceidsubmitlogs-get", "parameters"=>[{"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}, {"in"=>"query", "name"=>"length", "description"=>"length"}, {"in"=>"query", "name"=>"offset", "description"=>"offset"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Instances", "Instanceid", "Submit", "Logs"]}}}}, "predix-data-services-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Data Services", "version"=>"1.0.0"}, "host"=>"time-series-service-doc.grc-apps.svc.ice.ge.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/aggregations"=>{"get"=>{"summary"=>"Get all available aggregations", "description"=>"Return all supported aggregations.Response JSON (Status 200){\n \"results\": [\n {\n \"name\": \"max\",\n \"type\": \"Maximum\",\n \"description\": \"Returns the maximum value data point for the time range\"\n },\n {\n \"name\": \"trendmode\",\n \"type\": \"Trend Mode\",\n \"description\": \"Returns the maximum and minimum value data point for the time range\"\n },\n {\n \"name\": \"count\",\n \"type\": \"Count\",\n \"description\": \"Returns the number of data points\"\n },\n {\n \"name\": \"scale\",\n \"type\": \"Scale\",\n \"description\": \"Scales each data point by a factor\"\n },\n {\n \"name\": \"interpolate\",\n \"type\": \"Interpolate\",\n \"description\": \"Does linear interpolation for the chosen window\"\n },\n {\n \"name\": \"sum\",\n \"type\": \"Sum\",\n \"description\": \"Adds the data points together\"\n },\n {\n \"name\": \"diff\",\n \"type\": \"Difference\",\n \"description\": \"Returns the difference between successive data points\"\n },\n {\n \"name\": \"gaps\",\n \"type\": \"Gaps\",\n \"description\": \"Marks gaps in data according to sampling rate with a null data point\"\n },\n {\n \"name\": \"sampler\",\n \"type\": \"Sampler\",\n \"description\": \"Returns the sampling rate of change for the data points\"\n },\n {\n \"name\": \"div\",\n \"type\": \"Divide\",\n \"description\": \"Divides each data point by a divisor\"\n },\n {\n \"name\": \"min\",\n \"type\": \"Minimum\",\n \"description\": \"Returns the minimum value data point for the time range\"\n },\n {\n \"name\": \"avg\",\n \"type\": \"Average\",\n \"description\": \"Returns the average of the data point set\"\n },\n {\n \"name\": \"least_squares\",\n \"type\": \"Least Squares\",\n \"description\": \"Returns a best fit line through the data points using the least squares algorithm\"\n },\n {\n \"name\": \"percentile\",\n \"type\": \"Percentile\",\n \"description\": \"Returns the percentile of the data range\"\n },\n {\n \"name\": \"dev\",\n \"type\": \"Standard Deviation\",\n \"description\": \"Returns the standard deviation of the time series\"\n },\n {\n \"name\": \"rate\",\n \"type\": \"Rate\",\n \"description\": \"Returns the rate of change for the data points\"\n }\n ]\n}", "operationId"=>"getAggregationNames", "x-api-path-slug"=>"v1aggregations-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Available", "Aggregations"]}}, "/v1/datapoints"=>{"get"=>{"summary"=>"Query Datapoints", "description"=>"Both the GET and POST methods can be used to query time series data. Use the query API with the GET HTTP method by passing the query JSON as a URL query parameter. The advantage of using the GET method is that requests and responses can be cached in proxy servers and browsers. In cases where the query JSON is very long and exceeds query parameter length (for some browsers), use POST as a convenience method to query the time series API. POST requests have no restrictions on data length, however, requests are never cached. The Time Series service API is designed this way to support complex, nested time series queries on one or more tags and their attributes, with start and end times, along with aggregations and filters.Response JSON (Status 200)\n{\n\t\"tags\": [{\n\t\t\"name\": \"ALT_SENSOR\",\n\t\t\"results\": [{\n\t\t\t\"filters\": {\n\t\t\t\t\"attributes\": {\n\t\t\t\t\t\"host\": [\n\t\t\t\t\t\t\"test\"\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t\"measurements\": {\n\t\t\t\t\t\"condition\": \"le\",\n\t\t\t\t\t\"values\": [\n\t\t\t\t\t\t36\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t\"qualities\": {\n\t\t\t\t\t\"values\": [\n\t\t\t\t\t\t\"3\"\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"attributes\": {\n\t\t\t\t\"host\": [\"test\"]\n\t\t\t},\n\t\t\t\"values\": [\n\t\t\t\t[1449709894000, 5, 3],\n\t\t\t\t[1449709895000, 7, 3]\n\t\t\t]\n\t\t}],\n\t\t\"stats\": {\n\t\t\t\"rawCount\": 2\n\t\t}\n\t}]\n}", "operationId"=>"query", "x-api-path-slug"=>"v1datapoints-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"Predix-Zone-Id"}, {"in"=>"query", "name"=>"query", "description"=>"Valid JSON string"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Query", "Datapoints"]}, "post"=>{"summary"=>"Query Datapoints", "description"=>"Both the GET and POST methods can be used to query time series data. Use the query API with the GET HTTP method by passing the query JSON as a URL query parameter. The advantage of using the GET method is that requests and responses can be cached in proxy servers and browsers. In cases where the query JSON is very long and exceeds query parameter length (for some browsers), use POST as a convenience method to query the time series API. POST requests have no restrictions on data length, however, requests are never cached. The Time Series service API is designed this way to support complex, nested time series queries on one or more tags and their attributes, with start and end times, along with aggregations and filters. Following is a sample request message: Request JSON{\n\t\"start\": \"24h-ago\",\n\t\"end\": \"12h-ago\",\n\t\"tags\": [{\n\t\t\"name\": \"ALT_SENSOR\",\n\t\t\"limit\": 1000,\n\t\t\"order\": \"desc\",\n\t\t\"suppressGroupByType\": true|false,\n\t\t\"aggregations\": [{\n\t\t\t\"type\": \"avg\",\n\t\t\t\"interval\": \"1h\"\n\t\t}],\n\t\t\"filters\": {\n\t\t\t\"attributes\": {\n\t\t\t\t\"host\": [\n\t\t\t\t\t\"test\"\n\t\t\t\t]\n\t\t\t},\n\t\t\t\"measurements\": {\n\t\t\t\t\"condition\": \"le\",\n\t\t\t\t\"values\": [\n\t\t\t\t\t\"36\"\n\t\t\t\t]\n\t\t\t},\n\t\t\t\"qualities\": {\n\t\t\t\t\"values\": [\n\t\t\t\t\t\"3\"\n\t\t\t\t]\n\t\t\t}\n\t\t},\n\t\t\"groups\": [{\n\t\t\t\"name\": \"attribute\",\n\t\t\t\"attributes\": [\n\t\t\t\t\"host\", \"subtenant\"\n\t\t\t]\n\t\t}]\n\t}]\n}\nResponse JSON (Status 200){\n\t\"tags\": [{\n\t\t\"name\": \"ALT_SENSOR\",\n\t\t\"results\": [{\n\t\t\t\"filters\": {\n\t\t\t\t\"attributes\": {\n\t\t\t\t\t\"host\": [\n\t\t\t\t\t\t\"test\"\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t\"measurements\": {\n\t\t\t\t\t\"condition\": \"le\",\n\t\t\t\t\t\"values\": [\n\t\t\t\t\t\t36\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t\"qualities\": {\n\t\t\t\t\t\"values\": [\n\t\t\t\t\t\t\"3\"\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"attributes\": {\n\t\t\t\t\"host\": [\"test\"]\n\t\t\t},\n\t\t\t\"values\": [\n\t\t\t\t[1449709894000, 5, 3],\n\t\t\t\t[1449709895000, 7, 3]\n\t\t\t]\n\t\t}],\n\t\t\"stats\": {\n\t\t\t\"rawCount\": 2\n\t\t}\n\t}]\n}", "operationId"=>"get", "x-api-path-slug"=>"v1datapoints-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"Predix-Zone-Id"}, {"in"=>"body", "name"=>"Query Request JSON", "description"=>"Query Request (JSON)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Query", "Datapoints"]}}, "/v1/datapoints/latest"=>{"get"=>{"summary"=>"Query for Current Value", "description"=>"This API helps to query time series data for the latest values.Response JSON (Status 200){\n\t\"tags\": [{\n\t\t\"name\": \"tagName1\",\n\t\t\"results\": [{\n\t\t\t\"values\": [\n\t\t\t\t[1449709895000, 7, 3]\n\t\t\t]\n\t\t}],\n\t\t\"stats\": {\n\t\t\t\"rawCount\": 1\n\t\t}\n\t}, {\n\t\t\"name\": \"tagName2\",\n\t\t\"results\": [{\n\t\t\t\"values\": [\n\t\t\t\t[1449709896000, 8, 3]\n\t\t\t]\n\t\t}],\n\t\t\"stats\": {\n\t\t\t\"rawCount\": 1\n\t\t}\n\t}]\n}", "operationId"=>"queryCurrent", "x-api-path-slug"=>"v1datapointslatest-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"Predix-Zone-Id"}, {"in"=>"query", "name"=>"suppressGroupByType", "description"=>"Flag to suppress the grouping of results by type"}, {"in"=>"query", "name"=>"tags", "description"=>"List of tags Eg: tag1,tag2"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["QueryCurrent", "Value"]}, "post"=>{"summary"=>"Query for Current Value", "description"=>"This API helps to query for timeseries for the latest values for the given tags. The POST API also provides a way to specify a time window or filter options and retrieves the latest value that satisfies it.Request JSON{\n\t\"tags\": [{\n\t\t\"name\": \"ALT_SENSOR\",\n\t\t\"suppressGroupByType\": true|false,\n\t\t\"filters\": {\n\t\t\t\"attributes\": {\n\t\t\t\t\"host\": [\n\t\t\t\t\t\"test\"\n\t\t\t\t]\n\t\t\t},\n\t\t\t\"measurements\": {\n\t\t\t\t\"condition\": \"le\",\n\t\t\t\t\"values\": [\n\t\t\t\t\t\"36\"\n\t\t\t\t]\n\t\t\t},\n\t\t\t\"qualities\": {\n\t\t\t\t\"values\": [\n\t\t\t\t\t\"3\"\n\t\t\t\t]\n\t\t\t}\n\t\t}\n\t}]\n}Response JSON (Status 200){\n\t\"tags\": [{\n\t\t\"name\": \"ALT_SENSOR\",\n\t\t\"results\": [{\n\t\t\t\"filters\": {\n\t\t\t\t\"attributes\": {\n\t\t\t\t\t\"host\": [\n\t\t\t\t\t\t\"test\"\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t\"measurements\": {\n\t\t\t\t\t\"condition\": \"le\",\n\t\t\t\t\t\"values\": [\n\t\t\t\t\t\t36\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t\"qualities\": {\n\t\t\t\t\t\"values\": [\n\t\t\t\t\t\t\"3\"\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"attributes\": {\n\t\t\t\t\"host\": [\"test\"]\n\t\t\t},\n\t\t\t\"values\": [\n\t\t\t\t[1449709895000, 7, 3]\n\t\t\t]\n\t\t}],\n\t\t\"stats\": {\n\t\t\t\"rawCount\": 1\n\t\t}\n\t}]\n}", "operationId"=>"queryCurrentPost", "x-api-path-slug"=>"v1datapointslatest-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"Predix-Zone-Id"}, {"in"=>"body", "name"=>"Query Request JSON", "description"=>"Query Request (JSON)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["QueryCurrent", "Value"]}}, "/v1/tags"=>{"get"=>{"summary"=>"Get all tags", "description"=>"Return all the ingested tag names.Response JSON (Status 200){\n\t\"results\": [\n\t\t\"ALT_SENSOR\",\n\t\t\"tagName1\",\n\t\t\"tagName2\"\n\t]\n}", "operationId"=>"getMetricNames", "x-api-path-slug"=>"v1tags-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tags"]}}}}, "predix-analytics-framework-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Analytics Framework", "version"=>"1.0.0"}, "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/v1/analytic/execution"=>{"post"=>{"summary"=>"Execute the analytic synchronously.", "description"=>"Execute the analytic synchronously with the given execution payload.", "operationId"=>"synchronousExecution", "x-api-path-slug"=>"apiv1analyticexecution-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"body", "name"=>"body", "description"=>"request payload containing analytic input data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Execute", "Analytic", "Synchronously"]}}, "/api/v1/analytic/execution/async"=>{"post"=>{"summary"=>"Execute the analytic asynchronously using input data.", "description"=>"Execute the analytic asynchronously with the given input data payload.", "operationId"=>"asynchronousExecution", "x-api-path-slug"=>"apiv1analyticexecutionasync-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"body", "name"=>"body", "description"=>"request payload containing analytic input data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Execute", "Analytic", "Asynchronously", "Using", "Input", "Data"]}}, "/api/v1/analytic/execution/async/{requestId}"=>{"delete"=>{"summary"=>"Cleanup analytic execution result by request id.", "description"=>"Removes the analytic execution result from the cache. It is highly recommended to clean your old result data to have room for future result data.", "operationId"=>"clearAnalyticExecutionResult", "x-api-path-slug"=>"apiv1analyticexecutionasyncrequestid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"header", "name"=>"Predix-Zone-Id"}, {"in"=>"path", "name"=>"requestId"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Cleanup", "Analytic", "Execution", "Result", "By", "Request", "Id"]}}, "/api/v1/analytic/execution/async/{requestId}/result"=>{"get"=>{"summary"=>"Get the analytic execution result by request id.", "description"=>"Returns the analytic execution result.", "operationId"=>"retrieveAnalyticExecutionResult", "x-api-path-slug"=>"apiv1analyticexecutionasyncrequestidresult-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"path", "name"=>"requestId", "description"=>"analytic execution request id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Analytic", "Execution", "Result", "By", "Request", "Id"]}}, "/api/v1/analytic/execution/async/{requestId}/status"=>{"get"=>{"summary"=>"Get the analytic execution status by request id.", "description"=>"Returns the analytic execution status (one of QUEUED, PROCESSING, COMPLETED, or FAILED).", "operationId"=>"retrieveAnalyticExecutionStatus", "x-api-path-slug"=>"apiv1analyticexecutionasyncrequestidstatus-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"path", "name"=>"requestId", "description"=>"analytic execution request id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Analytic", "Execution", "Status", "By", "Request", "Id"]}}, "/api/v1/analytics/customdata/healthcheck"=>{"get"=>{"summary"=>"Healthcheck for custom datasource.", "description"=>"Indicates whether custom data connector is up and running.", "operationId"=>"healthcheck", "x-api-path-slug"=>"apiv1analyticscustomdatahealthcheck-get", "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Healthcheckcustom", "Datasource"]}}, "/api/v1/analytics/customdata/read"=>{"post"=>{"summary"=>"Retrieve analytic input data from custom datasource.", "description"=>"Returns the analytic input data used during runtime execution.", "operationId"=>"readCustomProviderData", "x-api-path-slug"=>"apiv1analyticscustomdataread-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Analytic Input Data Read request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Retrieve", "Analytic", "Input", "Data", "From", "Custom", "Datasource"]}}, "/api/v1/analytics/customdata/write"=>{"post"=>{"summary"=>"Write analytic output data to custom datasource.", "description"=>"Writes analytic output data generated during runtime execution.", "operationId"=>"writeCustomProviderData", "x-api-path-slug"=>"apiv1analyticscustomdatawrite-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Analytic Output Data Write Request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Write", "Analytic", "Output", "Data", "To", "Custom", "Datasource"]}}, "/api/v1/catalog/analytics"=>{"get"=>{"summary"=>"Get all analytic catalog entries.", "description"=>"Returns all analytic catalog entries as specified by page and sort criteria.", "operationId"=>"retrieveAll", "x-api-path-slug"=>"apiv1cataloganalytics-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"page index : zero-based page index"}, {"in"=>"query", "name"=>"size", "description"=>"page size : between 1 and 1000 inclusive"}, {"in"=>"query", "name"=>"sortableFields", "description"=>"sortable fields : name"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"sort order : asc | desc"}, {"in"=>"query", "name"=>"taxonomyPath", "description"=>"taxonomy path : taxonomyPath"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Analytic", "Catalog", "Entries"]}, "post"=>{"summary"=>"Create an analytic catalog entry.", "description"=>"Creates the analytic catalog entry with a generated id.", "operationId"=>"createAnalyticCatalogEntry", "x-api-path-slug"=>"apiv1cataloganalytics-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"analytic catalog entry", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Analytic", "Catalog", "Entry"]}}, "/api/v1/catalog/analytics/versions"=>{"get"=>{"summary"=>"Get all versions of the analytic catalog entry with the given name.", "description"=>"Returns all versions of the analytic catalog entry with the given name.", "operationId"=>"retrieveByName", "x-api-path-slug"=>"apiv1cataloganalyticsversions-get", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"analytic name"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Versions", "Of", "Analytic", "Catalog", "Entry", "Given", "Name"]}}, "/api/v1/catalog/analytics/{id}"=>{"get"=>{"summary"=>"Get an analytic catalog entry by id.", "description"=>"Returns the analytic catalog entry with the given id.", "operationId"=>"retrieveAnalyticCatalogEntryById", "x-api-path-slug"=>"apiv1cataloganalyticsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"analytic catalog entry id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Analytic", "Catalog", "Entry", "By", "Id"]}, "put"=>{"summary"=>"Update an analytic catalog entry by id.", "description"=>"The analytic catalog entry with the given id will be updated.", "operationId"=>"updateAnalyticCatalogEntry", "x-api-path-slug"=>"apiv1cataloganalyticsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"analytic catalog entry", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"analytic catalog entry id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Analytic", "Catalog", "Entry", "By", "Id"]}, "delete"=>{"summary"=>"Delete an analytic catalog entry by id.", "description"=>"Deletes the analytic catalog entry with the given id.", "operationId"=>"deleteAnalyticCatalogEntryById", "x-api-path-slug"=>"apiv1cataloganalyticsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"analytic catalog entry id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Analytic", "Catalog", "Entry", "By", "Id"]}}, "/api/v1/catalog/analytics/{id}/artifacts"=>{"get"=>{"summary"=>"Get the descriptive information of the artifacts corresponding to an analytic catalog entry.", "description"=>"Returns the description information (type, description, etc.) for all artifacts associated with the given analytic catalog entry id. Note: it does not return the artifact file contents; use the download APIs to obtain an artifact file. An error is returned if the supplied analytic catalog entry id does not exist.", "operationId"=>"retrieveArtifactsByCatalogEntryId", "x-api-path-slug"=>"apiv1cataloganalyticsidartifacts-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"analytic catalog entry id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Descriptive", "Information", "Of", "Artifacts", "Corresponding", "To", "Analytic", "Catalog", "Entry"]}}, "/api/v1/catalog/analytics/{id}/deployment"=>{"post"=>{"summary"=>"Deploy an analytic with an optional deployment configuration by analytic catalog entry id.", "description"=>"This operation FORCE deploys the specified analytic into the Cloud Foundry environment with an optional deployment configuration, responds with the request id (generated for the request), and the current request status. The force deploy usually takes longer than the standard timeout, so the calling process should use the returned request id to monitor the request status and to retrieve the deployment results.", "operationId"=>"deployAnalytic", "x-api-path-slug"=>"apiv1cataloganalyticsiddeployment-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"deployment configuration", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"analytic catalog entry id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Deploy", "Analytic", "Optional", "Deployment", "Configuration", "By", "Analytic", "Catalog", "Entry", "Id"]}}, "/api/v1/catalog/analytics/{id}/deployment/{requestId}"=>{"get"=>{"summary"=>"Get the analytic deployment status by request id.", "description"=>"Returns the analytic deployment status (one of 'queued,' 'processing,' or 'completed').", "operationId"=>"retrieveAnalyticDeploymentResult", "x-api-path-slug"=>"apiv1cataloganalyticsiddeploymentrequestid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"analytic id"}, {"in"=>"path", "name"=>"requestId", "description"=>"analytic deployment request id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Analytic", "Deployment", "Status", "By", "Request", "Id"]}}, "/api/v1/catalog/analytics/{id}/execution"=>{"post"=>{"summary"=>"Execute an analytic by analytic catalog entry id.", "description"=>"This operation executes the specified analytic and responds with the result produced by analytic.", "operationId"=>"executeAnalytic", "x-api-path-slug"=>"apiv1cataloganalyticsidexecution-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"request payload containing analytic input data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"analytic catalog entry id"}, {"in"=>"query", "name"=>"inputId", "description"=>"test artifact id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Execute", "Analytic", "By", "Analytic", "Catalog", "Entry", "Id"]}}, "/api/v1/catalog/analytics/{id}/logs"=>{"get"=>{"summary"=>"Get the analytic recent logs", "description"=>"Return the recent analytic logs", "operationId"=>"retrieveAnalyticLog", "x-api-path-slug"=>"apiv1cataloganalyticsidlogs-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"analytic id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Analytic", "Recent", "Logs"]}}, "/api/v1/catalog/analytics/{id}/validation"=>{"post"=>{"summary"=>"Validate an analytic by analytic catalog entry id.", "description"=>"This operation FORCE deploys the specified analytic into the Cloud Foundry environment, runs the analytic and responds with the validation request id (generated for the request), and the current request status. The force deploy usually takes longer than the standard timeout, so the calling process should use the returned validation request id to monitor the request status and to retrieve the validation results.", "operationId"=>"validateAnalytic", "x-api-path-slug"=>"apiv1cataloganalyticsidvalidation-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"request payload containing analytic input data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"analytic catalog entry id"}, {"in"=>"query", "name"=>"inputId", "description"=>"test artifact id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Validate", "Analytic", "By", "Analytic", "Catalog", "Entry", "Id"]}, "delete"=>{"summary"=>"Undeploy test analytics.", "description"=>"This operation un-deploys the analytic app from the Cloud Foundry environment only if the analytic has been validated for testing purposes. This api will not un-deploy production analytics.", "operationId"=>"invalidateAnalytic", "x-api-path-slug"=>"apiv1cataloganalyticsidvalidation-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"analytic catalog entry id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Undeploy", "Test", "Analytics"]}}, "/api/v1/catalog/analytics/{id}/validation/{validationRequestId}"=>{"get"=>{"summary"=>"Get the analytic validation status by validation request id.", "description"=>"Returns the analytic validation status (one of 'queued,' 'processing,' or 'completed' and the result from running the analytic (when status is 'completed').", "operationId"=>"retrieveAnalyticValidationResult", "x-api-path-slug"=>"apiv1cataloganalyticsidvalidationvalidationrequestid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"analytic id"}, {"in"=>"path", "name"=>"validationRequestId", "description"=>"analytic validation request id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Analytic", "Validation", "Status", "By", "Validation", "Request", "Id"]}}, "/api/v1/catalog/analytics/{name}/versions"=>{"delete"=>{"summary"=>"Delete all versions of the named analytic.", "description"=>"Given the name of an analytic, this API deletes all its versions.", "operationId"=>"deleteAllVersions", "x-api-path-slug"=>"apiv1cataloganalyticsnameversions-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"analytic name"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Versions", "Of", "Named", "Analytic"]}}, "/api/v1/catalog/artifacts"=>{"post"=>{"summary"=>"Upload an artifact and attach it to an analytic catalog entry.", "description"=>"Upload a single artifact file in a multipart MIME structure and attach it to an analytic catalog entry. The multipart MIME structure must have the catalog entry id tagged as 'catalogEntryId', the file contents tagged as 'file', the artifact type tagged as 'type', and a description (under 1024 characters) tagged as 'description'. Artifact types can be any string. Artifacts with the type 'executable' must contain the executable for the analytic. An analytic can only have 1 artifact labelled as 'executable'(See the documentation for more information regarding these files.)", "operationId"=>"uploadAnalyticArtifact", "x-api-path-slug"=>"apiv1catalogartifacts-post", "parameters"=>[{"in"=>"formData", "name"=>"catalogEntryId", "description"=>"(Required) analytic catalog entry id"}, {"in"=>"formData", "name"=>"description", "description"=>"artifact description"}, {"in"=>"formData", "name"=>"file", "description"=>"(Required) artifact file"}, {"in"=>"formData", "name"=>"type", "description"=>"(Required) artifact type"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Upload", "Artifact", "Attach", "It", "To", "Analytic", "Catalog", "Entry"]}}, "/api/v1/catalog/artifacts/{id}"=>{"put"=>{"summary"=>"Update an artifact by id.", "description"=>"Update an artifact in the catalog with the contents of the supplied multipart MIME structure. The multipart MIME structure may have any of the following: new file contents tagged as 'file', a new artifact type tagged as 'type', and a new description (under 1024 characters) tagged as 'description'. Artifact types can be any string. Artifacts with the type 'executable' must contain the executable for the analytic. An analytic can only have 1 artifact labelled as 'executable' (See the documentation for more information regarding these files.)", "operationId"=>"updateAnalyticArtifact", "x-api-path-slug"=>"apiv1catalogartifactsid-put", "parameters"=>[{"in"=>"formData", "name"=>"description", "description"=>"artifact description"}, {"in"=>"formData", "name"=>"file", "description"=>"artifact file"}, {"in"=>"path", "name"=>"id", "description"=>"artifact id"}, {"in"=>"formData", "name"=>"type", "description"=>"artifact type"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Artifact", "By", "Id"]}, "delete"=>{"summary"=>"Delete an artifact by id.", "description"=>"Deletes the artifact by artifact id.", "operationId"=>"deleteAnalyticArtifact", "x-api-path-slug"=>"apiv1catalogartifactsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"artifact id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Artifact", "By", "Id"]}}, "/api/v1/catalog/artifacts/{id}/file"=>{"get"=>{"summary"=>"Download an artifact file by id.", "description"=>"The file is downloaded as an octet-stream.", "operationId"=>"downloadAnalyticArtifact", "x-api-path-slug"=>"apiv1catalogartifactsidfile-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"artifact id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Download", "Artifact", "File", "By", "Id"]}}, "/api/v1/catalog/taxonomy"=>{"get"=>{"summary"=>"Retrieve the full taxonomy.", "description"=>"This operation retrieves the full taxonomy structure from the catalog.", "operationId"=>"retrieveFullTaxonomy", "x-api-path-slug"=>"apiv1catalogtaxonomy-get", "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Retrieve", "Full", "Taxonomy"]}, "post"=>{"summary"=>"Load a taxonomy.", "description"=>"This operation loads the supplied taxonomy structure into catalog. If a taxonomy already exists in the catalog, new paths in the supplied structure will be added. It will not delete existing paths.", "operationId"=>"loadTaxonomy", "x-api-path-slug"=>"apiv1catalogtaxonomy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"taxonomy JSON request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Load", "Taxonomy"]}}, "/api/v1/execution"=>{"post"=>{"summary"=>"Execute the specified orchestration.", "description"=>"To successfully execute the orchestration, the OrchestrationRequest must contain valid orchestration id, bpmn workflow xml and optionally input data for each analytic step defined in the workflow.", "operationId"=>"run", "x-api-path-slug"=>"apiv1execution-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"orchestration execution request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Execute", "Specified", "Orchestration"]}}, "/api/v1/monitoring/orchestrations/{orchestrationRequestId}"=>{"get"=>{"summary"=>"Retrieve orchestration execution result", "description"=>"Returns orchestration execution result for the given orchestration request id.", "operationId"=>"retrieveOrchestrationResult", "x-api-path-slug"=>"apiv1monitoringorchestrationsorchestrationrequestid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"orchestrationRequestId"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Retrieve", "Orchestration", "Execution", "Result"]}}, "/api/v1/scheduler/jobs"=>{"get"=>{"summary"=>"Get all job definition entries.", "description"=>"Returns all job definition entries as specified by page and sort criteria.", "operationId"=>"retrieveAllJobs", "x-api-path-slug"=>"apiv1schedulerjobs-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"query", "name"=>"page", "description"=>"page index : zero-based page index"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"query", "name"=>"size", "description"=>"page size : between 1 and 1000 inclusive"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"sort order : asc | desc"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Job", "Definition", "Entries"]}, "post"=>{"summary"=>"Create a scheduler job.", "description"=>"Creates the scheduler job with a generated id. Set the state value to 'Active' to start the job. Set the state value to 'Inactive' to avoid starting the job.", "operationId"=>"createJob", "x-api-path-slug"=>"apiv1schedulerjobs-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"header", "name"=>"Refresh-Token-For-Job-Execution", "description"=>"Refresh-Token-For-Job-Execution"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Scheduler", "Job"]}}, "/api/v1/scheduler/jobs/{id}"=>{"get"=>{"summary"=>"Get a scheduler job by id.", "description"=>"Returns the scheduler job with the given id.", "operationId"=>"retrieveJob", "x-api-path-slug"=>"apiv1schedulerjobsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"Job id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Scheduler", "Job", "By", "Id"]}, "put"=>{"summary"=>"Update an existing scheduler job.", "description"=>"Updates the scheduled job. The updated changes will be effective from the next scheduling of this job. To suspend a job, update the job with state value 'Inactive'. To resume a job, update the job with state value 'Active'.", "operationId"=>"updateJob", "x-api-path-slug"=>"apiv1schedulerjobsid-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"header", "name"=>"Refresh-Token-For-Job-Execution", "description"=>"Refresh-Token-For-Job-Execution"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Existing", "Scheduler", "Job"]}, "delete"=>{"summary"=>"Delete job definition.", "description"=>"Delete job definition for the given job id.", "operationId"=>"deleteJob", "x-api-path-slug"=>"apiv1schedulerjobsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"Job id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Job", "Definition"]}}, "/api/v1/scheduler/jobs/{id}/history"=>{"get"=>{"summary"=>"Retrieve job execution history of the given job.", "description"=>"Retrieve job execution history", "operationId"=>"retrieveJobHistory", "x-api-path-slug"=>"apiv1schedulerjobsidhistory-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"query", "name"=>"endTime", "description"=>"End time in millis"}, {"in"=>"path", "name"=>"id", "description"=>"Job id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"query", "name"=>"startTime", "description"=>"Start time in millis"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Retrieve", "Job", "Execution", "History", "Of", "Given", "Job"]}}, "/api/v2/config/orchestrations"=>{"get"=>{"summary"=>"Get all orchestration configuration entries.", "description"=>"Returns all orchestration configuration entries as specified by page and sort criteria.", "operationId"=>"retrieveAllOrchConfigs", "x-api-path-slug"=>"apiv2configorchestrations-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"query", "name"=>"page", "description"=>"page index : zero-based page index"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"query", "name"=>"size", "description"=>"page size : between 1 and 1000 inclusive"}, {"in"=>"query", "name"=>"sortableFields", "description"=>"sortable fields : name"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"sort order : asc | desc"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Orchestration", "Configuration", "Entries"]}, "post"=>{"summary"=>"Create an orchestration configuration entry.", "description"=>"Creates the orchestration configuration entry with a generated id.", "operationId"=>"createOrchestrationEntry", "x-api-path-slug"=>"apiv2configorchestrations-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"body", "name"=>"body", "description"=>"orchestration configuration entry", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Orchestration", "Configuration", "Entry"]}}, "/api/v2/config/orchestrations/artifacts"=>{"post"=>{"summary"=>"Upload an artifact and attach it to an orchestration configuration entry.", "description"=>"Upload a single artifact file in a multipart MIME structure and attach it to an orchestration configuration entry. The multipart MIME structure must have the orchestration entry id tagged as 'orchestrationEntryId', the file contents tagged as 'file', the artifact type tagged as 'type', and the name of artifact tagged as 'name'. A description (under 1024 characters) tagged as 'description' can be optionally specified. Artifact types can be either 'portToFieldMap', 'bpmn' or any. If the artifact type is 'portToFieldMap', specify the orchestration step ID tagged as 'stepId'. Otherwise, 'name' will be used as 'stepId'. (See the documentation for more information regarding these files.)", "operationId"=>"uploadOrchConfigArtifact", "x-api-path-slug"=>"apiv2configorchestrationsartifacts-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"formData", "name"=>"description", "description"=>"Artifact description"}, {"in"=>"formData", "name"=>"file", "description"=>"(Required) Artifact file"}, {"in"=>"formData", "name"=>"name", "description"=>"(Required) Artifact name"}, {"in"=>"formData", "name"=>"orchestrationEntryId", "description"=>"(Required) orchestration configuration entry id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"formData", "name"=>"stepId", "description"=>"Orchestration Step ID"}, {"in"=>"formData", "name"=>"type", "description"=>"(Required) Artifact type"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Upload", "Artifact", "Attach", "It", "To", "Orchestration", "Configuration", "Entry"]}}, "/api/v2/config/orchestrations/artifacts/{id}"=>{"put"=>{"summary"=>"Update an artifact by id.", "description"=>"Update the artifact of the orchestration configuration with the contents of the supplied multipart MIME structure. The multipart MIME structure may have new file contents tagged as 'file', new artifact type tagged as 'type', new name of artifact tagged as 'name', new description (under 1024 characters) tagged as 'description', and new value of the orchestration step id tagged as 'stepId. Artifact types can be either 'portToFieldMap', 'bpmn' or any. (See the documentation for more information regarding these files.)", "operationId"=>"updateOrchConfigArtifact", "x-api-path-slug"=>"apiv2configorchestrationsartifactsid-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"formData", "name"=>"description", "description"=>"Artifact description"}, {"in"=>"formData", "name"=>"file", "description"=>"Artifact file"}, {"in"=>"path", "name"=>"id", "description"=>"Artifact id"}, {"in"=>"formData", "name"=>"name", "description"=>"Artifact name"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"formData", "name"=>"stepId", "description"=>"Orchestration Step ID"}, {"in"=>"formData", "name"=>"type", "description"=>"Artifact type"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Artifact", "By", "Id"]}, "delete"=>{"summary"=>"Delete an orchestration artifact by id.", "description"=>"Delete the orchestration artifact by artifact id.", "operationId"=>"deleteOrchConfigArtifact", "x-api-path-slug"=>"apiv2configorchestrationsartifactsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"Artifact id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Orchestration", "Artifact", "By", "Id"]}}, "/api/v2/config/orchestrations/artifacts/{id}/file"=>{"get"=>{"summary"=>"Download an orchestration artifact file by id.", "description"=>"The file is downloaded as an octet-stream.", "operationId"=>"downloadOrchConfigArtifact", "x-api-path-slug"=>"apiv2configorchestrationsartifactsidfile-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"Artifact id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Download", "Orchestration", "Artifact", "File", "By", "Id"]}}, "/api/v2/config/orchestrations/defaulttagquery"=>{"get"=>{"summary"=>"Get the default tag query corresponding for the tenant.", "description"=>"Returns all information (query string, fieldnamespecifier, tagnamespecifer, description etc.) associated with the default tag query. An error is returned if tag query does not exist for the tenant.", "operationId"=>"retrieveDefaultTagQuery", "x-api-path-slug"=>"apiv2configorchestrationsdefaulttagquery-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Default", "Tag", "Query", "Correspondingthe", "Tenant"]}, "post"=>{"summary"=>"Create the default tag query corresponding for the tenant.", "description"=>"Creates the default tag query including all information (query string, fieldnamespecifier, tagnamespecifer, description etc.) associated with the query.", "operationId"=>"createDefaultTagQuery", "x-api-path-slug"=>"apiv2configorchestrationsdefaulttagquery-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"body", "name"=>"body", "description"=>"tag names default query", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Default", "Tag", "Query", "Correspondingthe", "Tenant"]}, "put"=>{"summary"=>"Update the default tag query for the tenant.", "description"=>"Updates the default tag query including all information (query string, fieldnamespecifier, tagnamespecifer, description etc.) associated with the query.", "operationId"=>"updateDefaultTagQuery", "x-api-path-slug"=>"apiv2configorchestrationsdefaulttagquery-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"body", "name"=>"body", "description"=>"tag names default query", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Default", "Tag", "Querythe", "Tenant"]}, "delete"=>{"summary"=>"Delete the default tag query for the tenant.", "description"=>"Deletes the default tag query.", "operationId"=>"deleteDefaultTagQuery", "x-api-path-slug"=>"apiv2configorchestrationsdefaulttagquery-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Default", "Tag", "Querythe", "Tenant"]}}, "/api/v2/config/orchestrations/models"=>{"get"=>{"summary"=>"Get all model entries.", "description"=>"Returns all model entries as specified by page and sort criteria. By default, retrieves all models for tenant. If additional query params specified, then results will be filtered", "operationId"=>"retrieveAllModels", "x-api-path-slug"=>"apiv2configorchestrationsmodels-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"query", "name"=>"modelKey", "description"=>"Model Key"}, {"in"=>"query", "name"=>"modelName", "description"=>"Model Name"}, {"in"=>"query", "name"=>"modelVersion", "description"=>"Model Version"}, {"in"=>"query", "name"=>"page", "description"=>"page index : zero-based page index"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"query", "name"=>"size", "description"=>"page size : between 1 and 1000 inclusive"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Model", "Entries"]}, "post"=>{"summary"=>"Upload a model.", "description"=>"Upload a model in a multipart MIME structure. The multipart MIME structure must have the modelKey tagged as 'modelKey', the modelName tagged as 'modelName', the modelVersion tagged as 'modelVersion', the file contents tagged as 'file', a description (under 1024 characters) tagged as 'description'. (See the documentation for more information regarding these files.)", "operationId"=>"uploadModel", "x-api-path-slug"=>"apiv2configorchestrationsmodels-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"formData", "name"=>"description", "description"=>"Artifact description"}, {"in"=>"formData", "name"=>"file", "description"=>"(Required) Model file"}, {"in"=>"formData", "name"=>"modelKey", "description"=>"(Required) Model Key"}, {"in"=>"formData", "name"=>"modelName", "description"=>"(Required) Model Name"}, {"in"=>"formData", "name"=>"modelVersion", "description"=>"(Required) Model Version"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Upload", "Model"]}}, "/api/v2/config/orchestrations/models/{id}"=>{"put"=>{"summary"=>"Update model by id.", "description"=>"Update a model with attributes of the supplied multipart MIME structure. The multipart MIME structure must have the modelKey tagged as 'modelKey', the modelName tagged as 'modelName', the modelVersion tagged as 'modelVersion', the file contents tagged as 'file', a description (under 1024 characters) tagged as 'description'. (See the documentation for more information regarding these files.)", "operationId"=>"updateModel", "x-api-path-slug"=>"apiv2configorchestrationsmodelsid-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"formData", "name"=>"description", "description"=>"Artifact description"}, {"in"=>"formData", "name"=>"file", "description"=>"(Required) Model file"}, {"in"=>"path", "name"=>"id", "description"=>"artifact id"}, {"in"=>"formData", "name"=>"modelKey", "description"=>"(Required) Model Key"}, {"in"=>"formData", "name"=>"modelName", "description"=>"(Required) Model Name"}, {"in"=>"formData", "name"=>"modelVersion", "description"=>"(Required) Model Version"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Model", "By", "Id"]}, "delete"=>{"summary"=>"Delete a model by id.", "description"=>"Delete a model by model id.", "operationId"=>"deleteModel", "x-api-path-slug"=>"apiv2configorchestrationsmodelsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"Model id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Model", "By", "Id"]}}, "/api/v2/config/orchestrations/models/{id}/file"=>{"get"=>{"summary"=>"Download a model file by id.", "description"=>"The file is downloaded as an octet-stream.", "operationId"=>"downloadModel", "x-api-path-slug"=>"apiv2configorchestrationsmodelsidfile-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"Model id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Download", "Model", "File", "By", "Id"]}}, "/api/v2/config/orchestrations/{id}"=>{"get"=>{"summary"=>"Get an orchestration configuration entry by id.", "description"=>"Returns the orchestration configuration entry with the given id.", "operationId"=>"retrieveOrchestrationEntryById", "x-api-path-slug"=>"apiv2configorchestrationsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"orchestration configuration entry id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Orchestration", "Configuration", "Entry", "By", "Id"]}, "put"=>{"summary"=>"Update an existing orchestration configuration entry.", "description"=>"Updates the orchestration configuration entry with given orchestration configuration.", "operationId"=>"updateOrchestrationEntry", "x-api-path-slug"=>"apiv2configorchestrationsid-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"body", "name"=>"body", "description"=>"orchestration configuration entry", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"orchestration configuration id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Existing", "Orchestration", "Configuration", "Entry"]}, "delete"=>{"summary"=>"Delete an orchestration configuration entry by id.", "description"=>"Deletes the orchestration configuration entry with the given id.", "operationId"=>"deleteOrchestrationEntryById", "x-api-path-slug"=>"apiv2configorchestrationsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"orchestration configuration entry id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Orchestration", "Configuration", "Entry", "By", "Id"]}}, "/api/v2/config/orchestrations/{id}/artifacts"=>{"get"=>{"summary"=>"Get the descriptive information of the orchestration artifacts corresponding to an orchestration configuration entry.", "description"=>"Returns the description information (type, description, etc.) for all orchestration artifacts associated with the given configuration entry id. Note: it does not return the orchestration artifact file contents; use the download APIs to obtain an artifact file. An error is returned if the supplied orchestration configuration entry id does not exist.", "operationId"=>"retrieveArtifactsByOrchestrationEntryId", "x-api-path-slug"=>"apiv2configorchestrationsidartifacts-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"orchestration configuration entry id"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Descriptive", "Information", "Of", "Orchestration", "Artifacts", "Corresponding", "To", "Orchestration", "Configuration", "Entry"]}}, "/api/v2/config/orchestrations/{id}/file"=>{"get"=>{"summary"=>"Download an orchestration artifact file by orchestration id and artifact type.", "description"=>"The file is downloaded as an octet-stream. If the type is bpmn, then then bpmn xml is downloaded. If the type is portToFieldMap, then the system expects analyticStepId to download the portToFieldMap for the given step", "operationId"=>"downloadArtifactByType", "x-api-path-slug"=>"apiv2configorchestrationsidfile-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"path", "name"=>"id", "description"=>"orchestration configuration entry id"}, {"in"=>"query", "name"=>"name", "description"=>"artifact name (analytic step id)"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"query", "name"=>"type", "description"=>"artifact type (Ex"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Download", "Orchestration", "Artifact", "File", "By", "Orchestration", "Id", "Artifact", "Type"]}}, "/api/v2/execution"=>{"post"=>{"summary"=>"Execute the specified orchestration.", "description"=>"To successfully execute the orchestration, the OrchestrationExecutionRequest must contain valid orchestration id, asset id, asset data field mapping details. This API will execute the orchestration in synchronous mode and if the execution is not completed in 1 minute then the request will fail. After successful completion, the response will contain each orchestration steps output data.", "operationId"=>"runSyncV2", "x-api-path-slug"=>"apiv2execution-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"orchestration execution request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Execute", "Specified", "Orchestration"]}}, "/api/v2/execution/async"=>{"post"=>{"summary"=>"Execute the specified orchestration in asynchronous mode.", "description"=>"To successfully execute the orchestration, the OrchestrationExecutionRequest must contain valid orchestration id, asset id, asset data field mapping details.", "operationId"=>"runAsync", "x-api-path-slug"=>"apiv2executionasync-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"orchestration execution request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Execute", "Specified", "Orchestration", "In", "Asynchronous", "Mode"]}}, "/api/v2/execution/orchestrations/{orchConfigId}/deployment"=>{"post"=>{"summary"=>"Deploy the specified orchestration workflow file to the Orchestration Engine.", "description"=>"This API will deploy the BPMN file associated with the specified orchestration configuration to the Orchestration Engine in preparation for orchestration execution.", "operationId"=>"retrieveAndDeployBpmn", "x-api-path-slug"=>"apiv2executionorchestrationsorchconfigiddeployment-post", "parameters"=>[{"in"=>"path", "name"=>"orchConfigId", "description"=>"orchestration configuration id"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Deploy", "Specified", "Orchestration", "Workflow", "File", "To", "Orchestration", "Engine"]}}, "/api/v2/execution/testrun"=>{"post"=>{"summary"=>"Execute the orchestration with given bpmn and input data.", "description"=>"To successfully execute the orchestration, the request must contain valid bpmn20.xml, input data for each step in the bpmn.", "operationId"=>"testRun", "x-api-path-slug"=>"apiv2executiontestrun-post", "parameters"=>[{"in"=>"formData", "name"=>"bpmn", "description"=>"BPMN file"}, {"in"=>"formData", "name"=>"input", "description"=>"Input data file"}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Execute", "Orchestration", "Given", "Bpmn", "Input", "Data"]}}, "/api/v2/execution/validation"=>{"post"=>{"summary"=>"Validate the specified orchestration and the health of all the analytics used in the orchestration.", "description"=>"To successfully validate the orchestration, the BPMN XML file must reference analytics that are running. The validation will call a 'healthCheck' entry on each analytic. Analytics in the platform automatically have this entry, analytics outside the platform must implement this APIfor their validation to pass. The results contain the http status for each for the healthCheck call to each analytic.", "operationId"=>"validate", "x-api-path-slug"=>"apiv2executionvalidation-post", "parameters"=>[{"in"=>"body", "name"=>"file", "description"=>"(Required) artifact file", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{2=>{"description"=>"Successful response"}}, "tags"=>["Validate", "Specified", "Orchestration", "Health", "Of", "", "Analytics", "Used", "In", "Orchestration"]}}}}, "predix-notification-service-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Notification Service Documentation", "description"=>"notification-service-rest-swagger-documentation", "version"=>"1.0.0"}, "host"=>"ev-notification-service.run.aws-usw02-pr.ice.predix.io", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/tenants/{tenant_uuid}"=>{"get"=>{"summary"=>"Get Tenants", "description"=>"Get tenants.", "operationId"=>"getV1TenantsTenantUu", "x-api-path-slug"=>"v1tenantstenant-uuid-get", "parameters"=>[{"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants"]}, "put"=>{"summary"=>"Put Tenants", "description"=>"Put tenants.", "operationId"=>"putV1TenantsTenantUu", "x-api-path-slug"=>"v1tenantstenant-uuid-put", "parameters"=>[{"in"=>"body", "name"=>"tenant", "description"=>"tenant", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants"]}}, "/v1/tenants/{tenant_uuid}/configurations"=>{"get"=>{"summary"=>"Get Tenants Configurations", "description"=>"Get tenants configurations.", "operationId"=>"getV1TenantsTenantUuConfigurations", "x-api-path-slug"=>"v1tenantstenant-uuidconfigurations-get", "parameters"=>[{"in"=>"query", "name"=>"configurationUuid", "description"=>"configurationUuid"}, {"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants", "Configurations"]}, "post"=>{"summary"=>"Post Tenants Configurations", "description"=>"Post tenants configurations.", "operationId"=>"postV1TenantsTenantUuConfigurations", "x-api-path-slug"=>"v1tenantstenant-uuidconfigurations-post", "parameters"=>[{"in"=>"body", "name"=>"configurations", "description"=>"configurations", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants", "Configurations"]}}, "/v1/tenants/{tenant_uuid}/configurations/{uuid}"=>{"get"=>{"summary"=>"Get Tenants Configurations", "description"=>"Get tenants configurations.", "operationId"=>"getV1TenantsTenantUuConfigurationsUu", "x-api-path-slug"=>"v1tenantstenant-uuidconfigurationsuuid-get", "parameters"=>[{"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}, {"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants", "Configurations"]}, "put"=>{"summary"=>"Put Tenants Configurations", "description"=>"Put tenants configurations.", "operationId"=>"putV1TenantsTenantUuConfigurationsUu", "x-api-path-slug"=>"v1tenantstenant-uuidconfigurationsuuid-put", "parameters"=>[{"in"=>"body", "name"=>"configuration", "description"=>"configuration", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}, {"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants", "Configurations"]}, "delete"=>{"summary"=>"Delete Tenants Configurations", "description"=>"Delete tenants configurations.", "operationId"=>"deleteV1TenantsTenantUuConfigurationsUu", "x-api-path-slug"=>"v1tenantstenant-uuidconfigurationsuuid-delete", "parameters"=>[{"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}, {"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants", "Configurations"]}}, "/v1/tenants/{tenant_uuid}/email"=>{"post"=>{"summary"=>"Post Tenants Email", "description"=>"Post tenants email.", "operationId"=>"postV1TenantsTenantUuEmail", "x-api-path-slug"=>"v1tenantstenant-uuidemail-post", "parameters"=>[{"in"=>"body", "name"=>"applicationMessage", "description"=>"applicationMessage", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"configuration", "description"=>"configuration"}, {"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants", "Email"]}}, "/v1/tenants/{tenant_uuid}/events"=>{"get"=>{"summary"=>"Get Tenants Events", "description"=>"Get tenants events.", "operationId"=>"getV1TenantsTenantUuEvents", "x-api-path-slug"=>"v1tenantstenant-uuidevents-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"end_date"}, {"in"=>"query", "name"=>"start_date", "description"=>"start_date"}, {"in"=>"query", "name"=>"tag", "description"=>"tag"}, {"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants", "Events"]}}, "/v1/tenants/{tenant_uuid}/usage"=>{"get"=>{"summary"=>"Get Tenants Usage", "description"=>"Get tenants usage.", "operationId"=>"getV1TenantsTenantUuUsage", "x-api-path-slug"=>"v1tenantstenant-uuidusage-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"end_date"}, {"in"=>"query", "name"=>"start_date", "description"=>"start_date"}, {"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants", "Usage"]}}}}, "predix-apphub-arcs-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Predix AppHub ARCS", "description"=>"bapplication-registry-and-configurationb", "termsOfService"=>"Terms of service", "contact"=>{"name"=>"Digital Predix AppHub ARCS: Development"}, "version"=>"1.0.0"}, "host"=>"predix-apphub-arcs-prod.run.aws-usw02-pr.ice.predix.io", "basePath"=>"/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/apps"=>{"get"=>{"summary"=>"Get all the registered microapps", "description"=>"Get the registered microapps for the given tenant", "operationId"=>"getAllRegisteredAppsUsingGET", "x-api-path-slug"=>"apps-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apps"]}, "post"=>{"summary"=>"Register the microapp", "description"=>"Register the microapps", "operationId"=>"registerAppUsingPOST", "x-api-path-slug"=>"apps-post", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apps"]}, "put"=>{"summary"=>"Update the microapp", "description"=>"Update the microapps", "operationId"=>"updateAppUsingPUT", "x-api-path-slug"=>"apps-put", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apps"]}}, "/apps/{uuid}"=>{"get"=>{"summary"=>"Get the registered microapp", "description"=>"Get the registered microapp for the given uri", "operationId"=>"getRegisterAppUsingGET", "x-api-path-slug"=>"appsuuid-get", "parameters"=>[{"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apps", "Uuid"]}, "delete"=>{"summary"=>"Unregister the microapp", "description"=>"Unregister the microapp", "operationId"=>"unRegisterAppUsingDELETE", "x-api-path-slug"=>"appsuuid-delete", "parameters"=>[{"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apps", "Uuid"]}}, "/globalconfig"=>{"get"=>{"summary"=>"Get global config information", "description"=>"Get global config information", "operationId"=>"getGlobalConfigUsingGET", "x-api-path-slug"=>"globalconfig-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Globalconfig"]}, "post"=>{"summary"=>"Save global config information", "description"=>"Save global config information", "operationId"=>"saveGlobalConfigUsingPOST", "x-api-path-slug"=>"globalconfig-post", "parameters"=>[{"in"=>"body", "name"=>"config", "description"=>"config", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Globalconfig"]}}, "/globalconfig/{uuid}"=>{"put"=>{"summary"=>"Update global config information", "description"=>"Update global config information", "operationId"=>"updateGlobalConfigUsingPUT", "x-api-path-slug"=>"globalconfiguuid-put", "parameters"=>[{"in"=>"body", "name"=>"config", "description"=>"config", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Globalconfig", "Uuid"]}, "delete"=>{"summary"=>"Delete global config information", "description"=>"Delete global config information", "operationId"=>"deleteGlobalConfigUsingDELETE", "x-api-path-slug"=>"globalconfiguuid-delete", "parameters"=>[{"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Globalconfig", "Uuid"]}}, "/preferences"=>{"get"=>{"summary"=>"Get the preferences information", "description"=>"Get the preferences information", "operationId"=>"getPreferenceUsingGET", "x-api-path-slug"=>"preferences-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Preferences"]}, "post"=>{"summary"=>"Save the preferences information", "description"=>"save the preferences information", "operationId"=>"savePreferenceUsingPOST", "x-api-path-slug"=>"preferences-post", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Preferences"]}}, "/preferences/{uuid}"=>{"put"=>{"summary"=>"Update the preferences information", "description"=>"Update the preferences information", "operationId"=>"updatePreferenceUsingPUT", "x-api-path-slug"=>"preferencesuuid-put", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Preferences", "Uuid"]}, "delete"=>{"summary"=>"Delete the preferences information", "description"=>"Delete the preferences information", "operationId"=>"deletePreferenceUsingDELETE", "x-api-path-slug"=>"preferencesuuid-delete", "parameters"=>[{"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Preferences", "Uuid"]}}, "/privileges"=>{"get"=>{"summary"=>"Get the privileges information", "description"=>"Get the privileges information", "operationId"=>"getPrivilegeUsingGET", "x-api-path-slug"=>"privileges-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privileges"]}, "post"=>{"summary"=>"Save the privileges information", "description"=>"Save the privileges information", "operationId"=>"savePrivilegeUsingPOST", "x-api-path-slug"=>"privileges-post", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privileges"]}}, "/privileges/{uuid}"=>{"put"=>{"summary"=>"Update the privileges information", "description"=>"Update the privileges information", "operationId"=>"updatePrivilegeUsingPUT", "x-api-path-slug"=>"privilegesuuid-put", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privileges", "Uuid"]}, "delete"=>{"summary"=>"Delete the privileges information", "description"=>"Delete the privileges information", "operationId"=>"deletePrivilegeUsingDELETE", "x-api-path-slug"=>"privilegesuuid-delete", "parameters"=>[{"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privileges", "Uuid"]}}, "/provision"=>{"post"=>{"summary"=>"postTenantConfig", "description"=>"", "operationId"=>"postTenantConfigUsingPOST", "x-api-path-slug"=>"provision-post", "parameters"=>[{"in"=>"body", "name"=>"tenantConfigReq", "description"=>"tenantConfigReq", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provision"]}}, "/provision/{tenantId}"=>{"delete"=>{"summary"=>"deleteTenantConfig", "description"=>"", "operationId"=>"deleteTenantConfigUsingDELETE", "x-api-path-slug"=>"provisiontenantid-delete", "parameters"=>[{"in"=>"path", "name"=>"tenantId", "description"=>"tenantId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provision", "TenantId"]}}, "/themes"=>{"get"=>{"summary"=>"Get theme information for a tenant", "description"=>"Get theme information", "operationId"=>"getThemeUsingGET", "x-api-path-slug"=>"themes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Themes"]}, "post"=>{"summary"=>"Save theme config information", "description"=>"Save theme config information", "operationId"=>"saveThemeUsingPOST", "x-api-path-slug"=>"themes-post", "parameters"=>[{"in"=>"body", "name"=>"theme", "description"=>"theme", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Themes"]}, "put"=>{"summary"=>"Update theme", "description"=>"Update theme", "operationId"=>"updateThemeUsingPUT", "x-api-path-slug"=>"themes-put", "parameters"=>[{"in"=>"body", "name"=>"theme", "description"=>"theme", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Themes"]}}, "/themes/{uuid}"=>{"get"=>{"summary"=>"Get the registered theme by uri", "description"=>"Get the registered theme infromation for the given uri", "operationId"=>"getThemeInfoByIdUsingGET", "x-api-path-slug"=>"themesuuid-get", "parameters"=>[{"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Themes", "Uuid"]}, "delete"=>{"summary"=>"Delete theme", "description"=>"Delete theme", "operationId"=>"deleteThemeUsingDELETE", "x-api-path-slug"=>"themesuuid-delete", "parameters"=>[{"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Themes", "Uuid"]}}, "/user"=>{"get"=>{"summary"=>"Get the current user information", "description"=>"Get the current user information", "operationId"=>"getUserUsingGET", "x-api-path-slug"=>"user-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "post"=>{"summary"=>"Save the current user information", "description"=>"Save the current user information", "operationId"=>"saveUserUsingPOST", "x-api-path-slug"=>"user-post", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/user/{uuid}"=>{"put"=>{"summary"=>"Update the current user information", "description"=>"Update the current user information", "operationId"=>"updateUserUsingPUT", "x-api-path-slug"=>"useruuid-put", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Uuid"]}, "delete"=>{"summary"=>"Delete the current user information", "description"=>"Delete the current user information", "operationId"=>"deleteUserUsingDELETE", "x-api-path-slug"=>"useruuid-delete", "parameters"=>[{"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Uuid"]}}}}, "predix-analytics-catalog-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Analytics Catalog", "version"=>"1.0.0"}, "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/v1/analytic/execution"=>{"post"=>{"summary"=>"Execute the analytic synchronously.", "description"=>"Execute the analytic synchronously with the given execution payload.", "operationId"=>"synchronousExecution", "x-api-path-slug"=>"apiv1analyticexecution-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"body", "name"=>"body", "description"=>"request payload containing analytic input data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execute", "Analytic", "Synchronously"]}}, "/api/v1/analytic/execution/async"=>{"post"=>{"summary"=>"Execute the analytic asynchronously using input data.", "description"=>"Execute the analytic asynchronously with the given input data payload.", "operationId"=>"asynchronousExecution", "x-api-path-slug"=>"apiv1analyticexecutionasync-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"body", "name"=>"body", "description"=>"request payload containing analytic input data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execute", "Analytic", "Asynchronously", "Using", "Input", "Data"]}}, "/api/v1/analytic/execution/async/{requestId}"=>{"delete"=>{"summary"=>"Cleanup analytic execution result by request id.", "description"=>"Removes the analytic execution result from the cache. It is highly recommended to clean your old result data to have room for future result data.", "operationId"=>"clearAnalyticExecutionResult", "x-api-path-slug"=>"apiv1analyticexecutionasyncrequestid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"header", "name"=>"Predix-Zone-Id"}, {"in"=>"path", "name"=>"requestId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cleanup", "Analytic", "Execution", "Result", "By", "Request", "Id"]}}, "/api/v1/analytic/execution/async/{requestId}/result"=>{"get"=>{"summary"=>"Get the analytic execution result by request id.", "description"=>"Returns the analytic execution result.", "operationId"=>"retrieveAnalyticExecutionResult", "x-api-path-slug"=>"apiv1analyticexecutionasyncrequestidresult-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"path", "name"=>"requestId", "description"=>"analytic execution request id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytic", "Execution", "Result", "By", "Request", "Id"]}}, "/api/v1/analytic/execution/async/{requestId}/status"=>{"get"=>{"summary"=>"Get the analytic execution status by request id.", "description"=>"Returns the analytic execution status (one of QUEUED, PROCESSING, COMPLETED, or FAILED).", "operationId"=>"retrieveAnalyticExecutionStatus", "x-api-path-slug"=>"apiv1analyticexecutionasyncrequestidstatus-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Authorization"}, {"in"=>"header", "name"=>"Predix-Zone-Id", "description"=>"Predix-Zone-Id"}, {"in"=>"path", "name"=>"requestId", "description"=>"analytic execution request id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytic", "Execution", "Status", "By", "Request", "Id"]}}, "/api/v1/catalog/analytics"=>{"get"=>{"summary"=>"Get all analytic catalog entries.", "description"=>"Returns all analytic catalog entries as specified by page and sort criteria.", "operationId"=>"retrieveAll", "x-api-path-slug"=>"apiv1cataloganalytics-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"page index : zero-based page index"}, {"in"=>"query", "name"=>"size", "description"=>"page size : between 1 and 1000 inclusive"}, {"in"=>"query", "name"=>"sortableFields", "description"=>"sortable fields : name"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"sort order : asc | desc"}, {"in"=>"query", "name"=>"taxonomyPath", "description"=>"taxonomy path : taxonomyPath"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytic", "Catalog", "Entries"]}, "post"=>{"summary"=>"Create an analytic catalog entry.", "description"=>"Creates the analytic catalog entry with a generated id.", "operationId"=>"createAnalyticCatalogEntry", "x-api-path-slug"=>"apiv1cataloganalytics-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"analytic catalog entry", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytic", "Catalog", "Entry"]}}, "/api/v1/catalog/analytics/versions"=>{"get"=>{"summary"=>"Get all versions of the analytic catalog entry with the given name.", "description"=>"Returns all versions of the analytic catalog entry with the given name.", "operationId"=>"retrieveByName", "x-api-path-slug"=>"apiv1cataloganalyticsversions-get", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"analytic name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Versions", "Of", "Analytic", "Catalog", "Entry", "Given", "Name"]}}, "/api/v1/catalog/analytics/{id}"=>{"get"=>{"summary"=>"Get an analytic catalog entry by id.", "description"=>"Returns the analytic catalog entry with the given id.", "operationId"=>"retrieveAnalyticCatalogEntryById", "x-api-path-slug"=>"apiv1cataloganalyticsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"analytic catalog entry id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytic", "Catalog", "Entry", "By", "Id"]}, "put"=>{"summary"=>"Update an analytic catalog entry by id.", "description"=>"The analytic catalog entry with the given id will be updated.", "operationId"=>"updateAnalyticCatalogEntry", "x-api-path-slug"=>"apiv1cataloganalyticsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"analytic catalog entry", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"analytic catalog entry id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytic", "Catalog", "Entry", "By", "Id"]}, "delete"=>{"summary"=>"Delete an analytic catalog entry by id.", "description"=>"Deletes the analytic catalog entry with the given id.", "operationId"=>"deleteAnalyticCatalogEntryById", "x-api-path-slug"=>"apiv1cataloganalyticsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"analytic catalog entry id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytic", "Catalog", "Entry", "By", "Id"]}}, "/api/v1/catalog/analytics/{id}/artifacts"=>{"get"=>{"summary"=>"Get the descriptive information of the artifacts corresponding to an analytic catalog entry.", "description"=>"Returns the description information (type, description, etc.) for all artifacts associated with the given analytic catalog entry id. Note: it does not return the artifact file contents; use the download APIs to obtain an artifact file. An error is returned if the supplied analytic catalog entry id does not exist.", "operationId"=>"retrieveArtifactsByCatalogEntryId", "x-api-path-slug"=>"apiv1cataloganalyticsidartifacts-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"analytic catalog entry id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Descriptive", "Information", "Of", "Artifacts", "Corresponding", "To", "Analytic", "Catalog", "Entry"]}}, "/api/v1/catalog/analytics/{id}/deployment"=>{"post"=>{"summary"=>"Deploy an analytic with an optional deployment configuration by analytic catalog entry id.", "description"=>"This operation FORCE deploys the specified analytic into the Cloud Foundry environment with an optional deployment configuration, responds with the request id (generated for the request), and the current request status. The force deploy usually takes longer than the standard timeout, so the calling process should use the returned request id to monitor the request status and to retrieve the deployment results.", "operationId"=>"deployAnalytic", "x-api-path-slug"=>"apiv1cataloganalyticsiddeployment-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"deployment configuration", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"analytic catalog entry id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deploy", "Analytic", "Optional", "Deployment", "Configuration", "By", "Analytic", "Catalog", "Entry", "Id"]}}, "/api/v1/catalog/analytics/{id}/deployment/{requestId}"=>{"get"=>{"summary"=>"Get the analytic deployment status by request id.", "description"=>"Returns the analytic deployment status (one of 'queued,' 'processing,' or 'completed').", "operationId"=>"retrieveAnalyticDeploymentResult", "x-api-path-slug"=>"apiv1cataloganalyticsiddeploymentrequestid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"analytic id"}, {"in"=>"path", "name"=>"requestId", "description"=>"analytic deployment request id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytic", "Deployment", "Status", "By", "Request", "Id"]}}, "/api/v1/catalog/analytics/{id}/execution"=>{"post"=>{"summary"=>"Execute an analytic by analytic catalog entry id.", "description"=>"This operation executes the specified analytic and responds with the result produced by analytic.", "operationId"=>"executeAnalytic", "x-api-path-slug"=>"apiv1cataloganalyticsidexecution-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"request payload containing analytic input data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"analytic catalog entry id"}, {"in"=>"query", "name"=>"inputId", "description"=>"test artifact id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execute", "Analytic", "By", "Analytic", "Catalog", "Entry", "Id"]}}, "/api/v1/catalog/analytics/{id}/logs"=>{"get"=>{"summary"=>"Get the analytic recent logs", "description"=>"Return the recent analytic logs", "operationId"=>"retrieveAnalyticLog", "x-api-path-slug"=>"apiv1cataloganalyticsidlogs-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"analytic id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytic", "Recent", "Logs"]}}, "/api/v1/catalog/analytics/{id}/validation"=>{"post"=>{"summary"=>"Validate an analytic by analytic catalog entry id.", "description"=>"This operation FORCE deploys the specified analytic into the Cloud Foundry environment, runs the analytic and responds with the validation request id (generated for the request), and the current request status. The force deploy usually takes longer than the standard timeout, so the calling process should use the returned validation request id to monitor the request status and to retrieve the validation results.", "operationId"=>"validateAnalytic", "x-api-path-slug"=>"apiv1cataloganalyticsidvalidation-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"request payload containing analytic input data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"analytic catalog entry id"}, {"in"=>"query", "name"=>"inputId", "description"=>"test artifact id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Validate", "Analytic", "By", "Analytic", "Catalog", "Entry", "Id"]}, "delete"=>{"summary"=>"Undeploy test analytics.", "description"=>"This operation un-deploys the analytic app from the Cloud Foundry environment only if the analytic has been validated for testing purposes. This api will not un-deploy production analytics.", "operationId"=>"invalidateAnalytic", "x-api-path-slug"=>"apiv1cataloganalyticsidvalidation-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"analytic catalog entry id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Undeploy", "Test", "Analytics"]}}, "/api/v1/catalog/analytics/{id}/validation/{validationRequestId}"=>{"get"=>{"summary"=>"Get the analytic validation status by validation request id.", "description"=>"Returns the analytic validation status (one of 'queued,' 'processing,' or 'completed' and the result from running the analytic (when status is 'completed').", "operationId"=>"retrieveAnalyticValidationResult", "x-api-path-slug"=>"apiv1cataloganalyticsidvalidationvalidationrequestid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"analytic id"}, {"in"=>"path", "name"=>"validationRequestId", "description"=>"analytic validation request id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytic", "Validation", "Status", "By", "Validation", "Request", "Id"]}}, "/api/v1/catalog/analytics/{name}/versions"=>{"delete"=>{"summary"=>"Delete all versions of the named analytic.", "description"=>"Given the name of an analytic, this API deletes all its versions.", "operationId"=>"deleteAllVersions", "x-api-path-slug"=>"apiv1cataloganalyticsnameversions-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"analytic name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Versions", "Of", "Named", "Analytic"]}}, "/api/v1/catalog/artifacts"=>{"post"=>{"summary"=>"Upload an artifact and attach it to an analytic catalog entry.", "description"=>"Upload a single artifact file in a multipart MIME structure and attach it to an analytic catalog entry. The multipart MIME structure must have the catalog entry id tagged as 'catalogEntryId', the file contents tagged as 'file', the artifact type tagged as 'type', and a description (under 1024 characters) tagged as 'description'. Artifact types can be any string. Artifacts with the type 'executable' must contain the executable for the analytic. An analytic can only have 1 artifact labelled as 'executable'(See the documentation for more information regarding these files.)", "operationId"=>"uploadAnalyticArtifact", "x-api-path-slug"=>"apiv1catalogartifacts-post", "parameters"=>[{"in"=>"formData", "name"=>"catalogEntryId", "description"=>"(Required) analytic catalog entry id"}, {"in"=>"formData", "name"=>"description", "description"=>"artifact description"}, {"in"=>"formData", "name"=>"file", "description"=>"(Required) artifact file"}, {"in"=>"formData", "name"=>"type", "description"=>"(Required) artifact type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Artifact", "Attach", "It", "To", "Analytic", "Catalog", "Entry"]}}, "/api/v1/catalog/artifacts/{id}"=>{"put"=>{"summary"=>"Update an artifact by id.", "description"=>"Update an artifact in the catalog with the contents of the supplied multipart MIME structure. The multipart MIME structure may have any of the following: new file contents tagged as 'file', a new artifact type tagged as 'type', and a new description (under 1024 characters) tagged as 'description'. Artifact types can be any string. Artifacts with the type 'executable' must contain the executable for the analytic. An analytic can only have 1 artifact labelled as 'executable' (See the documentation for more information regarding these files.)", "operationId"=>"updateAnalyticArtifact", "x-api-path-slug"=>"apiv1catalogartifactsid-put", "parameters"=>[{"in"=>"formData", "name"=>"description", "description"=>"artifact description"}, {"in"=>"formData", "name"=>"file", "description"=>"artifact file"}, {"in"=>"path", "name"=>"id", "description"=>"artifact id"}, {"in"=>"formData", "name"=>"type", "description"=>"artifact type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Artifact", "By", "Id"]}, "delete"=>{"summary"=>"Delete an artifact by id.", "description"=>"Deletes the artifact by artifact id.", "operationId"=>"deleteAnalyticArtifact", "x-api-path-slug"=>"apiv1catalogartifactsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"artifact id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Artifact", "By", "Id"]}}, "/api/v1/catalog/artifacts/{id}/file"=>{"get"=>{"summary"=>"Download an artifact file by id.", "description"=>"The file is downloaded as an octet-stream.", "operationId"=>"downloadAnalyticArtifact", "x-api-path-slug"=>"apiv1catalogartifactsidfile-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"artifact id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Download", "Artifact", "File", "By", "Id"]}}, "/api/v1/catalog/taxonomy"=>{"get"=>{"summary"=>"Retrieve the full taxonomy.", "description"=>"This operation retrieves the full taxonomy structure from the catalog.", "operationId"=>"retrieveFullTaxonomy", "x-api-path-slug"=>"apiv1catalogtaxonomy-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Full", "Taxonomy"]}, "post"=>{"summary"=>"Load a taxonomy.", "description"=>"This operation loads the supplied taxonomy structure into catalog. If a taxonomy already exists in the catalog, new paths in the supplied structure will be added. It will not delete existing paths.", "operationId"=>"loadTaxonomy", "x-api-path-slug"=>"apiv1catalogtaxonomy-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"taxonomy JSON request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Load", "Taxonomy"]}}}}, "apis"=>{"name"=>"Predix", "x-slug"=>"predix", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"264121", "tags"=>"Enterprise,Internet of Things,Relative Data,SaaS,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"predix/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Predix Access Control", "x-api-slug"=>"predix-access-control", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https://predix-acs.run.aws-usw02-pr.ice.predix.io//", "tags"=>"Enterprise,Internet of Things,Relative Data,SaaS,Service API,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-access-control-openapi.yaml"}]}, {"name"=>"Predix Analytics Catalog", "x-api-slug"=>"predix-analytics-catalog", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https:////", "tags"=>"S,Subjecta,Given,Zone,,SubjectIdentifier,Must,Be,URL,Encoded,In,Application,X-www-form-urlencoded,Format,UTF-8", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-analytics-catalog-openapi.yaml"}]}, {"name"=>"Predix Analytics Framework", "x-api-slug"=>"predix-analytics-framework", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https:////", "tags"=>"Load,Taxonomy", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-analytics-framework-openapi.yaml"}]}, {"name"=>"Predix Analytics Runtime", "x-api-slug"=>"predix-analytics-runtime", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https:////", "tags"=>"Validate,Specified,Orchestration,Health,Of,,Analytics,Used,In,Orchestration", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-analytics-runtime-openapi.yaml"}]}, {"name"=>"Predix AppHub ARCS", "x-api-slug"=>"predix-apphub-arcs", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https://predix-apphub-arcs-prod.run.aws-usw02-pr.ice.predix.io//api", "tags"=>"Validate,Specified,Orchestration,Health,Of,,Analytics,Used,In,Orchestration", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-apphub-arcs-openapi.yaml"}]}, {"name"=>"Predix Assets", "x-api-slug"=>"predix-assets", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https:////", "tags"=>"User,Uuid", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-assets-openapi.yaml"}]}, {"name"=>"Predix BlockChain", "x-api-slug"=>"predix-blockchain", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https:////", "tags"=>"JSON,Schema,Of,Specified,Entity,Type", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-blockchain-openapi.yaml"}]}, {"name"=>"Predix Blockchain Data Integrity", "x-api-slug"=>"predix-blockchain-data-integrity", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https://bcdi-proxy-service.run.aws-usw02-pr.ice.predix.io//", "tags"=>"Transactions", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-blockchain-data-integrity-openapi.yaml"}]}, {"name"=>"Predix Data Services", "x-api-slug"=>"predix-data-services", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https://time-series-service-doc.grc-apps.svc.ice.ge.com//", "tags"=>"Proxy,Signature,Extension", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-data-services-openapi.yaml"}]}, {"name"=>"Predix Dynamic Mapping", "x-api-slug"=>"predix-dynamic-mapping", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https:////", "tags"=>"Tags", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-dynamic-mapping-openapi.yaml"}]}, {"name"=>"Predix Dynamic Time Warping", "x-api-slug"=>"predix-dynamic-time-warping", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https:////v1", "tags"=>"Return,Locationsan,Asset,By,Query,Conditiongiven,Customer,Id,Collection,Name", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-dynamic-time-warping-openapi.yaml"}]}, {"name"=>"Predix Enterprise Connect", "x-api-slug"=>"predix-enterprise-connect", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https://ec-predix-service-osaka.run.aws-usw02-pr.ice.predix.io//v1", "tags"=>"Warp,Subject,Reference,Arrays", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-enterprise-connect-openapi.yaml"}]}, {"name"=>"Predix Event Audit Trail", "x-api-slug"=>"predix-event-audit-trail", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https://event-audit-trail.run.aws-usw02-pr.ice.predix.io//", "tags"=>"EC,Gateway,Setting,In,Account", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-event-audit-trail-openapi.yaml"}]}, {"name"=>"Predix Fingerprint of Things Object Tagging Service", "x-api-slug"=>"predix-fingerprint-of-things-object-tagging-service", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https://fingerprint-of-things-ga1-dast.run.aws-usw02-pr.ice.predix.io//", "tags"=>"Service,Instances,Service,Bindings,Bindingid", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-fingerprint-of-things-object-tagging-service-openapi.yaml"}]}, {"name"=>"Predix Insights", "x-api-slug"=>"predix-insights", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https://insights-api.data-services.predix.io//api/v1", "tags"=>"Query,By,Group", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-insights-openapi.yaml"}]}, {"name"=>"Predix Intelligent Mapping", "x-api-slug"=>"predix-intelligent-mapping", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https:////", "tags"=>"Instances,Instanceid,Submit,Logs", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-intelligent-mapping-openapi.yaml"}]}, {"name"=>"Predix Notification Service", "x-api-slug"=>"predix-notification-service", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https://ev-notification-service.run.aws-usw02-pr.ice.predix.io//", "tags"=>"Style,Dataa,Layer", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-notification-service-openapi.yaml"}]}, {"name"=>"Predix Nurego", "x-api-slug"=>"predix-nurego", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https://api.nurego.com//", "tags"=>"Tenants,Usage", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-nurego-openapi.yaml"}]}, {"name"=>"Predix SAS ESP Predix Service", "x-api-slug"=>"predix-sas-esp-predix-service", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https://sas-proxy.run.aws-usw02-pr.ice.predix.io//", "tags"=>"Offerings", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-sas-esp-predix-service-openapi.yaml"}]}, {"name"=>"Predix Tenant Management", "x-api-slug"=>"predix-tenant-management", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https://predix-tms.run.aws-usw02-pr.ice.predix.io//", "tags"=>"ESP,Server,Health,Check", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-tenant-management-openapi.yaml"}]}, {"name"=>"Predix ThetaRay Predix Service", "x-api-slug"=>"predix-thetaray-predix-service", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https://thetaray-anomaly-service.run.aws-usw02-pr.ice.predix.io//", "tags"=>"Lookup,Tenant,Status,By,Subdomain", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/predix/v1proxydatasourcesprocess-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/predix/predix-thetaray-predix-service-openapi.yaml"}]}, {"name"=>"Predix Views", "x-api-slug"=>"predix-views", "description"=>"Predix (IoT PaaS) helps you develop apps that connect people with industrial machines through analytics and data for better business outcomes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/predix-vector-logo.png", "humanURL"=>"https://www.predix.io", "baseURL"=>"https:////v1", "tags"=>"Proxy,Datasources,Process", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/predix/predix-views-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/predix"}, {"type"=>"x-documentation", "url"=>"https://docs.predix.io/en-US/platform"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Predix"}, {"type"=>"x-website", "url"=>"https://www.predix.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "predix-dynamic-mapping-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Dynamic Mapping", "description"=>"dynamic-mapping-services-for-geospatial-data-management-and-viewing", "version"=>"1.0.0"}, "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/collections"=>{"get"=>{"summary"=>"List all asset collections for a customer", "description"=>"Returns an array containing the names of all asset collections for the\nspecified customer.", "operationId"=>"returns-an-array-containing-the-names-of-all-asset-collections-for-thespecified-customer", "x-api-path-slug"=>"v1collections-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["List", "", "Asset", "Collectionsa", "Customer"]}}, "/v1/collections/{collectionName}"=>{"get"=>{"summary"=>"Return all asset ids for a collection", "description"=>"Returns the collection name and a list of ids of the assets that belong to\nthe collection.", "operationId"=>"returns-the-collection-name-and-a-list-of-ids-of-the-assets-that-belong-tothe-collection", "x-api-path-slug"=>"v1collectionscollectionname-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Return", "", "Asset", "Idsa", "Collection"]}, "delete"=>{"summary"=>"Delete a collection", "description"=>"Delete the asset collection specified by the collection name. Any associated asset and asset location data\nare also deleted", "operationId"=>"delete-the-asset-collection-specified-by-the-collection-name-any-associated-asset-and-asset-location", "x-api-path-slug"=>"v1collectionscollectionname-delete", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Collection"]}}, "/v1/collections/{collectionName}/spatial-query/bbox-interacts"=>{"get"=>{"summary"=>"Returns collection assets in specified bounding box", "description"=>"Returns all assets in the specified collection whose latest location exist within the specified bounding box.\nThe bounding box is defined by two coordinates in the EPSG:4326 (WGS84) (for further details see\nhttp://epsg.io/4326):\n* left (longitude), bottom (latitude)\n* right (longitude), top (latitude)\nThe results can be filtered by including key and value pairs to match in location meta data.", "operationId"=>"returns-all-assets-in-the-specified-collection-whose-latest-location-exist-within-the-specified-boun", "x-api-path-slug"=>"v1collectionscollectionnamespatialquerybboxinteracts-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Returns", "Collection", "Assets", "In", "Specified", "Bounding", "Box"]}}, "/v1/collections/{collectionName}/cluster"=>{"get"=>{"summary"=>"Returns clustered assets in a specified bounding box", "description"=>"Returns clusters of assets in the specified collection whose latest location exists within the specified\nbounding box. The clusters can also optionally be filtered by a single key-value pair.", "operationId"=>"returns-clusters-of-assets-in-the-specified-collection-whose-latest-location-exists-within-the-speci", "x-api-path-slug"=>"v1collectionscollectionnamecluster-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Returns", "Clustered", "Assets", "In", "Specified", "Bounding", "Box"]}}, "/v1/collections/{collectionName}/assets/{assetId}"=>{"put"=>{"summary"=>"Add an asset location into a collection.", "description"=>"Insert a location entry into the named collection for the given asset identifier and timestamp. In addition to\nadding the new asset location, the request also controls the retention of the location history that is\nstored for the given asset in the given collection.\n\n - If the mandatory property retain_history is set to false then all existing location history for the\n given asset is removed before the new location is added.\n\n - If the retain_history property is set to true and the optional property purge_history_before is not set\n then the new location is added to the existing set of locations for the given asset.\n\n - If retain_history is set to true and the optional property purge_history_before is set then any existing\n locations for the given asset that have a timestamp that is older than the supplied purge_history_before\n timestamp are first deleted. Next the new location is added to the set of locations that remain.\n\n - If the set of location entries for the given asset (after any possible removals) contains a location entry\n with the same timestamp as the new location then the location of that entry is updated rather than a new\n location entry being added.\n\n - Note the new entry is always added or used to update an existing entry.", "operationId"=>"insert-a-location-entry-into-the-named-collection-for-the-given-asset-identifier-and-timestamp-in-ad", "x-api-path-slug"=>"v1collectionscollectionnameassetsassetid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"An object containing the location of the asset at a given timestamp, together with additional properties to controlthe retention of any existing asset location history", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Asset", "Location", "Into", "Collection"]}, "delete"=>{"summary"=>"Delete an asset and its location data", "description"=>"Delete the asset specified by the collection name. Any location data associated with the asset are also deleted.", "operationId"=>"delete-the-asset-specified-by-the-collection-name-any-location-data-associated-with-the-asset-are-al", "x-api-path-slug"=>"v1collectionscollectionnameassetsassetid-delete", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Asset", "Its", "Location", "Data"]}, "get"=>{"summary"=>"Return the latest location data for an asset", "description"=>"Returns the latest location entry for the given asset. The timestamp and location data for the\ngiven entry is included in the response.", "operationId"=>"returns-the-latest-location-entry-for-the-given-asset-the-timestamp-and-location-data-for-thegiven-e", "x-api-path-slug"=>"v1collectionscollectionnameassetsassetid-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Return", "Latest", "Location", "Dataan", "Asset"]}}, "/v1/collections/{collectionName}/assets/{assetId}/query"=>{"post"=>{"summary"=>"Return locations for an asset by query condition for given customer id and collection name.", "description"=>"Returns the locations for an asset by three types of query for a given customer id and collection name.\nThe returned locations are in descending order of time.\nThree types of query:\n1. type=latest: The latest n locations will be returned.\n2. type=timeperiod: Locations within a time period will be returned.\n3. type=bbox: Locations within a time period and a spatial bounding box will be returned.", "operationId"=>"returns-the-locations-for-an-asset-by-three-types-of-query-for-a-given-customer-id-and-collection-na", "x-api-path-slug"=>"v1collectionscollectionnameassetsassetidquery-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The parameters for the query for asset locations", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Return", "Locationsan", "Asset", "By", "Query", "Conditiongiven", "Customer", "Id", "Collection", "Name"]}}}}, "predix-event-audit-trail-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"Event Audit Trail Documentation", "description"=>"event-audit-trail-rest-swagger-documentation", "version"=>"1.0.0"}, "host"=>"event-audit-trail.run.aws-usw02-pr.ice.predix.io", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/plugins/archive/tenants/{tenant_uuid}/archives"=>{"get"=>{"summary"=>"Get Plugins Archive Tenants Archives", "description"=>"Get plugins archive tenants archives.", "operationId"=>"getV1PluginsArchiveTenantsTenantUuArchives", "x-api-path-slug"=>"v1pluginsarchivetenantstenant-uuidarchives-get", "parameters"=>[{"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Plugins", "Archive", "Tenants", "Archives"]}}, "/v1/plugins/archive/tenants/{tenant_uuid}/archives/{uuid}"=>{"get"=>{"summary"=>"Get Plugins Archive Tenants Archives", "description"=>"Get plugins archive tenants archives.", "operationId"=>"getV1PluginsArchiveTenantsTenantUuArchivesUu", "x-api-path-slug"=>"v1pluginsarchivetenantstenant-uuidarchivesuuid-get", "parameters"=>[{"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}, {"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Plugins", "Archive", "Tenants", "Archives"]}, "delete"=>{"summary"=>"Delete Plugins Archive Tenants Archives", "description"=>"Delete plugins archive tenants archives.", "operationId"=>"deleteV1PluginsArchiveTenantsTenantUuArchivesUu", "x-api-path-slug"=>"v1pluginsarchivetenantstenant-uuidarchivesuuid-delete", "parameters"=>[{"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}, {"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Plugins", "Archive", "Tenants", "Archives"]}}, "/v1/plugins/archive/tenants/{tenant_uuid}/configuration"=>{"get"=>{"summary"=>"Get Plugins Archive Tenants Configuration", "description"=>"Get plugins archive tenants configuration.", "operationId"=>"getV1PluginsArchiveTenantsTenantUuConfiguration", "x-api-path-slug"=>"v1pluginsarchivetenantstenant-uuidconfiguration-get", "parameters"=>[{"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Plugins", "Archive", "Tenants", "Configuration"]}, "post"=>{"summary"=>"Post Plugins Archive Tenants Configuration", "description"=>"Post plugins archive tenants configuration.", "operationId"=>"postV1PluginsArchiveTenantsTenantUuConfiguration", "x-api-path-slug"=>"v1pluginsarchivetenantstenant-uuidconfiguration-post", "parameters"=>[{"in"=>"body", "name"=>"archivePluginConfiguration", "description"=>"archivePluginConfiguration", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Plugins", "Archive", "Tenants", "Configuration"]}}, "/v1/plugins/archive/tenants/{tenant_uuid}/staged-events"=>{"get"=>{"summary"=>"Get Plugins Archive Tenants Staged Events", "description"=>"Get plugins archive tenants staged events.", "operationId"=>"getV1PluginsArchiveTenantsTenantUuStagedEvents", "x-api-path-slug"=>"v1pluginsarchivetenantstenant-uuidstagedevents-get", "parameters"=>[{"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Plugins", "Archive", "Tenants", "Staged", "Events"]}}, "/v1/tenants/{tenant_uuid}"=>{"get"=>{"summary"=>"Get Tenants", "description"=>"Get tenants.", "operationId"=>"getV1TenantsTenantUu", "x-api-path-slug"=>"v1tenantstenant-uuid-get", "parameters"=>[{"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenants"]}}, "/v1/tenants/{tenant_uuid}/event-search"=>{"get"=>{"summary"=>"Get Tenants Event Search", "description"=>"Get tenants event search.", "operationId"=>"getV1TenantsTenantUuEventSearch", "x-api-path-slug"=>"v1tenantstenant-uuideventsearch-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"query"}, {"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenants", "Event", "Search"]}}, "/v1/tenants/{tenant_uuid}/events"=>{"get"=>{"summary"=>"Get Tenants Events", "description"=>"Get tenants events.", "operationId"=>"getV1TenantsTenantUuEvents", "x-api-path-slug"=>"v1tenantstenant-uuidevents-get", "parameters"=>[{"in"=>"query", "name"=>"classification", "description"=>"classification"}, {"in"=>"query", "name"=>"context", "description"=>"context"}, {"in"=>"query", "name"=>"end_date", "description"=>"end_date"}, {"in"=>"query", "name"=>"start_date", "description"=>"start_date"}, {"in"=>"query", "name"=>"tag", "description"=>"tag"}, {"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenants", "Events"]}, "post"=>{"summary"=>"Post Tenants Events", "description"=>"Post tenants events.", "operationId"=>"postV1TenantsTenantUuEvents", "x-api-path-slug"=>"v1tenantstenant-uuidevents-post", "parameters"=>[{"in"=>"body", "name"=>"events", "description"=>"events", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenants", "Events"]}}, "/v1/tenants/{tenant_uuid}/events/{uuid}"=>{"get"=>{"summary"=>"Get Tenants Events", "description"=>"Get tenants events.", "operationId"=>"getV1TenantsTenantUuEventsUu", "x-api-path-slug"=>"v1tenantstenant-uuideventsuuid-get", "parameters"=>[{"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}, {"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenants", "Events"]}, "put"=>{"summary"=>"Put Tenants Events", "description"=>"Put tenants events.", "operationId"=>"putV1TenantsTenantUuEventsUu", "x-api-path-slug"=>"v1tenantstenant-uuideventsuuid-put", "parameters"=>[{"in"=>"body", "name"=>"event", "description"=>"event", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}, {"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenants", "Events"]}, "delete"=>{"summary"=>"Delete Tenants Events", "description"=>"Delete tenants events.", "operationId"=>"deleteV1TenantsTenantUuEventsUu", "x-api-path-slug"=>"v1tenantstenant-uuideventsuuid-delete", "parameters"=>[{"in"=>"path", "name"=>"tenant_uuid", "description"=>"tenant_uuid"}, {"in"=>"path", "name"=>"uuid", "description"=>"uuid"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Tenants", "Events"]}}, "/v2/catalog"=>{"get"=>{"summary"=>"Get Catalog", "description"=>"Get catalog.", "operationId"=>"getV2Catalog", "x-api-path-slug"=>"v2catalog-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Catalog"]}}, "/v2/service_instances/{instanceId}"=>{"put"=>{"summary"=>"Put Service Instances", "description"=>"Put service instances.", "operationId"=>"putV2ServiceInstancesInstance", "x-api-path-slug"=>"v2service-instancesinstanceid-put", "parameters"=>[{"in"=>"query", "name"=>"accepts_incomplete", "description"=>"accepts_incomplete"}, {"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}, {"in"=>"body", "name"=>"request", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Service", "Instances"]}, "delete"=>{"summary"=>"Delete Service Instances", "description"=>"Delete service instances.", "operationId"=>"deleteV2ServiceInstancesInstance", "x-api-path-slug"=>"v2service-instancesinstanceid-delete", "parameters"=>[{"in"=>"query", "name"=>"accepts_incomplete", "description"=>"accepts_incomplete"}, {"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}, {"in"=>"query", "name"=>"plan_id", "description"=>"plan_id"}, {"in"=>"query", "name"=>"service_id", "description"=>"service_id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Service", "Instances"]}, "patch"=>{"summary"=>"Patch Service Instances", "description"=>"Patch service instances.", "operationId"=>"patchV2ServiceInstancesInstance", "x-api-path-slug"=>"v2service-instancesinstanceid-patch", "parameters"=>[{"in"=>"query", "name"=>"accepts_incomplete", "description"=>"accepts_incomplete"}, {"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}, {"in"=>"body", "name"=>"request", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Service", "Instances"]}}, "/v2/service_instances/{instanceId}/last_operation"=>{"get"=>{"summary"=>"Get Service Instances Last Operation", "description"=>"Get service instances last operation.", "operationId"=>"getV2ServiceInstancesInstanceLastOperation", "x-api-path-slug"=>"v2service-instancesinstanceidlast-operation-get", "parameters"=>[{"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Service", "Instances", "Last", "Operation"]}}, "/v2/service_instances/{instanceId}/service_bindings/{bindingId}"=>{"put"=>{"summary"=>"Put Service Instances Service Bindings Bindingid", "description"=>"Put service instances service bindings bindingid.", "operationId"=>"putV2ServiceInstancesInstanceServiceBindingsBinding", "x-api-path-slug"=>"v2service-instancesinstanceidservice-bindingsbindingid-put", "parameters"=>[{"in"=>"path", "name"=>"bindingId", "description"=>"bindingId"}, {"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}, {"in"=>"body", "name"=>"request", "description"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Service", "Instances", "Service", "Bindings", "Bindingid"]}, "delete"=>{"summary"=>"Delete Service Instances Service Bindings Bindingid", "description"=>"Delete service instances service bindings bindingid.", "operationId"=>"deleteV2ServiceInstancesInstanceServiceBindingsBinding", "x-api-path-slug"=>"v2service-instancesinstanceidservice-bindingsbindingid-delete", "parameters"=>[{"in"=>"path", "name"=>"bindingId", "description"=>"bindingId"}, {"in"=>"path", "name"=>"instanceId", "description"=>"instanceId"}, {"in"=>"query", "name"=>"plan_id", "description"=>"plan_id"}, {"in"=>"query", "name"=>"service_id", "description"=>"service_id"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Service", "Instances", "Service", "Bindings", "Bindingid"]}}}}, "predix-views-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Predix", "x-complete"=>1, "info"=>{"title"=>"VIEWS", "version"=>"1.0.0"}, "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/decks/{id}/tags/{fk}"=>{"delete"=>{"summary"=>"Delete a related item by id for tags.", "description"=>"Delete a related item by id for tags..", "operationId"=>"deleteDecksTagsFk", "x-api-path-slug"=>"decksidtagsfk-delete", "parameters"=>[{"in"=>"path", "name"=>"fk", "description"=>"Foreign key for tags"}, {"in"=>"path", "name"=>"id", "description"=>"PersistedModel id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Related", "Item", "By", "Idtags"]}}, "/decks/{id}/cards"=>{"get"=>{"summary"=>"Queries cards of Deck.", "description"=>"Queries cards of deck..", "operationId"=>"getDecksCards", "x-api-path-slug"=>"decksidcards-get", "parameters"=>[{"in"=>"query", "name"=>"filter"}, {"in"=>"path", "name"=>"id", "description"=>"PersistedModel id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queries", "Cards", "Of", "Deck"]}}, "/decks/{id}/cards/count"=>{"get"=>{"summary"=>"Counts cards of Deck.", "description"=>"Counts cards of deck..", "operationId"=>"getDecksCardsCount", "x-api-path-slug"=>"decksidcardscount-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"PersistedModel id"}, {"in"=>"query", "name"=>"where", "description"=>"Criteria to match Deck instances"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Counts", "Cards", "Of", "Deck"]}}, "/decks/{id}/tags"=>{"get"=>{"summary"=>"Queries tags of Deck.", "description"=>"Queries tags of deck..", "operationId"=>"getDecksTags", "x-api-path-slug"=>"decksidtags-get", "parameters"=>[{"in"=>"query", "name"=>"filter"}, {"in"=>"path", "name"=>"id", "description"=>"PersistedModel id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queries", "Tags", "Of", "Deck"]}, "post"=>{"summary"=>"Creates a new instance in tags of this Tag.", "description"=>"Creates a new instance in tags of this tag..", "operationId"=>"postDecksTags", "x-api-path-slug"=>"decksidtags-post", "parameters"=>[{"in"=>"body", "name"=>"data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"PersistedModel id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "New", "Instance", "In", "Tags", "Of", "This", "Tag"]}, "delete"=>{"summary"=>"Deletes all tags of this Deck.", "description"=>"Deletes all tags of this deck..", "operationId"=>"deleteDecksTags", "x-api-path-slug"=>"decksidtags-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"PersistedModel id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "", "Tags", "Of", "This", "Deck"]}}, "/decks"=>{"post"=>{"summary"=>"Create a new instance of the Deck and persist it.", "description"=>"Create a new instance of the deck and persist it..", "operationId"=>"postDecks", "x-api-path-slug"=>"decks-post", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"Deck instance data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Instance", "Of", "Deck", "Persist", "It"]}, "get"=>{"summary"=>"Find all instances of the Deck matched by filter.", "description"=>"Find all instances of the deck matched by filter..", "operationId"=>"getDecks", "x-api-path-slug"=>"decks-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter defining fields, where, include, order, offset, and limit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "", "Instances", "Of", "Deck", "Matched", "By", "Filter"]}}, "/decks/{id}"=>{"get"=>{"summary"=>"Find a Deck instance by id.", "description"=>"Find a deck instance by id..", "operationId"=>"getDecks", "x-api-path-slug"=>"decksid-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter defining fields and include"}, {"in"=>"path", "name"=>"id", "description"=>"Deck id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Deck", "Instance", "By", "Id"]}, "delete"=>{"summary"=>"Delete a Tag instance by id.", "description"=>"Delete a tag instance by id..", "operationId"=>"deleteDecks", "x-api-path-slug"=>"decksid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Deck id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tag", "Instance", "By", "Id"]}, "put"=>{"summary"=>"Update attributes for a Tag instance and persist it.", "description"=>"Update attributes for a tag instance and persist it..", "operationId"=>"putDecks", "x-api-path-slug"=>"decksid-put", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"An object of Deck property name/value pairs", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"PersistedModel id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attributesa", "Tag", "Instance", "Persist", "It"]}}, "/decks/{id}/cards/ordered"=>{"get"=>{"summary"=>"API return deck", "description"=>"Api return deck.", "operationId"=>"getDecksCardsOrdered", "x-api-path-slug"=>"decksidcardsordered-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["API", "Return", "Deck"]}}, "/decks/{id}/cards/add"=>{"post"=>{"summary"=>"Add Cards to Deck", "description"=>"Add cards to deck.", "operationId"=>"postDecksCardsAdd", "x-api-path-slug"=>"decksidcardsadd-post", "parameters"=>[{"in"=>"body", "name"=>"cardIds", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "To", "Deck"]}}, "/decks/{id}/cards/remove"=>{"post"=>{"summary"=>"Remove Cards from Deck", "description"=>"Remove cards from deck.", "operationId"=>"postDecksCardsRemove", "x-api-path-slug"=>"decksidcardsremove-post", "parameters"=>[{"in"=>"body", "name"=>"cardIds", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Cards", "From", "Deck"]}}, "/decks/tags"=>{"get"=>{"summary"=>"Get all decks by tags", "description"=>"Get all decks by tags.", "operationId"=>"getDecksTags", "x-api-path-slug"=>"deckstags-get", "parameters"=>[{"in"=>"query", "name"=>"values"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Decks", "By", "Tags"]}}, "/decks/bulkCreateCardsAndDecks"=>{"post"=>{"summary"=>"Bulk create decks and cards", "description"=>"Bulk create decks and cards.", "operationId"=>"postDecksBulkcreatecardsanddecks", "x-api-path-slug"=>"decksbulkcreatecardsanddecks-post", "parameters"=>[{"in"=>"body", "name"=>"decks", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bulk", "Create", "Decks", "Cards"]}}, "/cards/{id}/tags/{fk}"=>{"delete"=>{"summary"=>"Delete a related item by id for tags.", "description"=>"Delete a related item by id for tags..", "operationId"=>"deleteCardsTagsFk", "x-api-path-slug"=>"cardsidtagsfk-delete", "parameters"=>[{"in"=>"path", "name"=>"fk", "description"=>"Foreign key for tags"}, {"in"=>"path", "name"=>"id", "description"=>"PersistedModel id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Related", "Item", "By", "Idtags"]}}, "/cards/{id}/tags"=>{"get"=>{"summary"=>"Queries tags of Card.", "description"=>"Queries tags of card..", "operationId"=>"getCardsTags", "x-api-path-slug"=>"cardsidtags-get", "parameters"=>[{"in"=>"query", "name"=>"filter"}, {"in"=>"path", "name"=>"id", "description"=>"PersistedModel id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Queries", "Tags", "Of", "Card"]}, "post"=>{"summary"=>"Creates a new instance in tags of this Card.", "description"=>"Creates a new instance in tags of this card..", "operationId"=>"postCardsTags", "x-api-path-slug"=>"cardsidtags-post", "parameters"=>[{"in"=>"body", "name"=>"data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"PersistedModel id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "New", "Instance", "In", "Tags", "Of", "This", "Card"]}, "delete"=>{"summary"=>"Deletes all tags of this Card.", "description"=>"Deletes all tags of this card..", "operationId"=>"deleteCardsTags", "x-api-path-slug"=>"cardsidtags-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"PersistedModel id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "", "Tags", "Of", "This", "Card"]}}, "/cards"=>{"post"=>{"summary"=>"Create a new instance of the Cards and persist it.", "description"=>"Create a new instance of the cards and persist it..", "operationId"=>"postCards", "x-api-path-slug"=>"cards-post", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"Card instance data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Instance", "Of", "Cards", "Persist", "It"]}, "get"=>{"summary"=>"Find all instances of the Card matched by filter.", "description"=>"Find all instances of the card matched by filter..", "operationId"=>"getCards", "x-api-path-slug"=>"cards-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter defining fields, where, include, order, offset, and limit"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "", "Instances", "Of", "Card", "Matched", "By", "Filter"]}}, "/cards/count"=>{"get"=>{"summary"=>"Counts cards.", "description"=>"Counts cards..", "operationId"=>"getCardsCount", "x-api-path-slug"=>"cardscount-get", "parameters"=>[{"in"=>"query", "name"=>"where", "description"=>"Criteria to match Card instances"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Counts", "Cards"]}}, "/cards/{id}"=>{"get"=>{"summary"=>"Find a Card instance by id.", "description"=>"Find a card instance by id..", "operationId"=>"getCards", "x-api-path-slug"=>"cardsid-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Filter defining fields and include"}, {"in"=>"path", "name"=>"id", "description"=>"Card id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Card", "Instance", "By", "Id"]}, "delete"=>{"summary"=>"Delete a Card instance by id.", "description"=>"Delete a card instance by id..", "operationId"=>"deleteCards", "x-api-path-slug"=>"cardsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Card id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Card", "Instance", "By", "Id"]}, "put"=>{"summary"=>"Update attributes for a Card instance and persist it.", "description"=>"Update attributes for a card instance and persist it..", "operationId"=>"putCards", "x-api-path-slug"=>"cardsid-put", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"An object of Card property name/value pairs", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"PersistedModel id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attributesa", "Card", "Instance", "Persist", "It"]}}, "/cards/tags"=>{"get"=>{"summary"=>"Get all cards by tags", "description"=>"Get all cards by tags.", "operationId"=>"getCardsTags", "x-api-path-slug"=>"cardstags-get", "parameters"=>[{"in"=>"query", "name"=>"values"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "By", "Tags"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
oxford-dictionaries{"oxford-dictionaries-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Oxford Dictionaries", "x-complete"=>1, "info"=>{"title"=>"Oxford Dictionaries", "description"=>"if-youre-looking-to-enhance-your-app-or-website-with-dictionary-data-dont-compromise-on-quality--the-oxford-dictionaries-api-offers-easy-and-intuitive-access-to-oxfords-dictionary-content-which-is-trusted-around-the-world--here-at-oxford-dictionaries-home-of-the-oed-we-love-words--thats-why-we-have-experienced-lexicographers-tracking-the-living-language-delving-deep-into-our-corpora-and-monitoring-a-wide-range-of-media-in-order-to-understand-how-words-are-being-used-and-how-language-is-evolving--this-research-is-used-by-our-editors-to-write-and-edit-dictionary-entries-and-translations-meaning-were-able-to-offer-uptodate-accurate-and-reliable-lexical-content-in-multiple-languages-", "termsOfService"=>"http://helloreverb.com/terms/", "version"=>"1.8.0"}, "host"=>"od-api-demo.oxforddictionaries.com:443", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/domains/{source_domains_language}/{target_domains_language}"=>{"get"=>{"summary"=>"Lists available domains in a bilingual dataset", "description"=>"Returns a list of the available [domains](documentation/glossary?term=domain) for a given bilingual language dataset.", "operationId"=>"getDomainsSourceDomainsLanguageTargetDomainsLanguage", "x-api-path-slug"=>"domainssource-domains-languagetarget-domains-language-get", "parameters"=>[{"in"=>"path", "name"=>"source_domains_language", "description"=>"IANA language code"}, {"in"=>"path", "name"=>"target_domains_language", "description"=>"IANA language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains", "Source", "Domains", "Language", "Target", "Domains", "Language"]}}, "/domains/{source_language}"=>{"get"=>{"summary"=>"Lists available domains in a monolingual dataset", "description"=>"Returns a list of the available [domains](documentation/glossary?term=domain) for a given monolingual language dataset.", "operationId"=>"getDomainsSourceLanguage", "x-api-path-slug"=>"domainssource-language-get", "parameters"=>[{"in"=>"path", "name"=>"source_language", "description"=>"IANA language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains", "Source", "Language"]}}, "/entries/{source_language}/{word_id}/sentences"=>{"get"=>{"summary"=>"Retrieve corpus sentences for a given word", "description"=>"Use this to retrieve sentences extracted from corpora which show how a word is used in the language. This is available for English and Spanish. For English, the sentences are linked to the correct [sense](documentation/glossary?term=sense) of the word in the dictionary. In Spanish, they are linked at the [headword](documentation/glossary?term=headword) level.", "operationId"=>"getEntriesSourceLanguageWordSentences", "x-api-path-slug"=>"entriessource-languageword-idsentences-get", "parameters"=>[{"in"=>"path", "name"=>"source_language", "description"=>"IANA language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entries", "Source", "Language", "Word", "Id", "Sentences"]}}, "/entries/{source_lang}/{word_id}"=>{"get"=>{"summary"=>"Retrieve dictionary information for a given word", "description"=>"Use this to retrieve definitions, [pronunciations](documentation/glossary?term=pronunciation), example sentences, [grammatical information](documentation/glossary?term=grammaticalfeatures) and [word origins](documentation/glossary?term=etymology). It only works for dictionary [headwords](documentation/glossary?term=headword), so you may need to use the [Lemmatron](documentation/glossary?term=lemma) first if your input is likely to be an [inflected](documentation/glossary?term=inflection) form (e.g., 'swimming'). This would return the linked [headword](documentation/glossary?term=headword) (e.g., 'swim') which you can then use in the Entries endpoint. Unless specified using a region filter, the default lookup will be the Oxford Dictionary of English (GB).", "operationId"=>"getEntriesSourceLangWord", "x-api-path-slug"=>"entriessource-langword-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entries", "Source", "Lang", "Word", "Id"]}}, "/entries/{source_lang}/{word_id}/antonyms"=>{"get"=>{"summary"=>"Retrieve words that mean the opposite", "description"=>"Retrieve words that are opposite in meaning to the input word ([antonym](documentation/glossary?term=thesaurus)).", "operationId"=>"getEntriesSourceLangWordAntonyms", "x-api-path-slug"=>"entriessource-langword-idantonyms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entries", "Source", "Lang", "Word", "Id", "Antonyms"]}}, "/entries/{source_lang}/{word_id}/regions={region}"=>{"get"=>{"summary"=>"Specify GB or US dictionary for English entry search", "description"=>"USe this filter to restrict the lookup to either our Oxford Dictionary of English (GB) or New Oxford American Dictionary (US).", "operationId"=>"getEntriesSourceLangWordRegionsRegion", "x-api-path-slug"=>"entriessource-langword-idregionsregion-get", "parameters"=>[{"in"=>"path", "name"=>"region", "description"=>"Region filter parameter"}, {"in"=>"path", "name"=>"source_lang", "description"=>"IANA language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entries", "Source", "Lang", "Word", "Id", "Regions=region"]}}, "/entries/{source_lang}/{word_id}/synonyms"=>{"get"=>{"summary"=>"Retrieve words that are similar", "description"=>"Use this to retrieve words that are similar in meaning to the input word ([synonym](documentation/glossary?term=synonym)).", "operationId"=>"getEntriesSourceLangWordSynonyms", "x-api-path-slug"=>"entriessource-langword-idsynonyms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entries", "Source", "Lang", "Word", "Id", "Synonyms"]}}, "/entries/{source_lang}/{word_id}/synonyms;antonyms"=>{"get"=>{"summary"=>"Retrieve synonyms and antonyms for a given word", "description"=>"Retrieve available [synonyms](documentation/glossary?term=thesaurus) and [antonyms](documentation/glossary?term=thesaurus) for a given word and language.", "operationId"=>"getEntriesSourceLangWordSynonyms;antonyms", "x-api-path-slug"=>"entriessource-langword-idsynonymsantonyms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entries", "Source", "Lang", "Word", "Id", "Synonyms;antonyms"]}}, "/entries/{source_lang}/{word_id}/{filters}"=>{"get"=>{"summary"=>"Apply filters to response", "description"=>"Use filters to limit the [entry](documentation/glossary?term=entry) information that is returned. For example, you may only require definitions and not everything else, or just [pronunciations](documentation/glossary?term=pronunciation). The full list of filters can be retrieved from the filters Utility endpoint. You can also specify values within the filter using '='. For example 'grammaticalFeatures=singular'. Filters can also be combined using a semicolon.", "operationId"=>"getEntriesSourceLangWordFilters", "x-api-path-slug"=>"entriessource-langword-idfilters-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entries", "Source", "Lang", "Word", "Id", "Filters"]}}, "/entries/{source_translation_language}/{word_id}/translations={target_translation_language}"=>{"get"=>{"summary"=>"Retrieve translation for a given word", "description"=>"Use this to return translations for a given word. In the event that a word in the dataset does not have a direct translation, the response will be a [definition](documentation/glossary?term=entry) in the target language.", "operationId"=>"getEntriesSourceTranslationLanguageWordTranslationsTargetTranslationLanguage", "x-api-path-slug"=>"entriessource-translation-languageword-idtranslationstarget-translation-language-get", "parameters"=>[{"in"=>"path", "name"=>"source_translation_language", "description"=>"IANA language code"}, {"in"=>"path", "name"=>"target_translation_language", "description"=>"IANA language code"}, {"in"=>"path", "name"=>"word_id", "description"=>"The source word"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entries", "Source", "Translation", "Language", "Word", "Id", "Translations=target", "Translation", "Language"]}}, "/filters"=>{"get"=>{"summary"=>"Lists available filters", "description"=>"Returns a list of all the valid filters to construct API calls.", "operationId"=>"getFilters", "x-api-path-slug"=>"filters-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filters"]}}, "/filters/{endpoint}"=>{"get"=>{"summary"=>"Lists available filters for specific endpoint", "description"=>"Returns a list of all the valid filters for a given endpoint to construct API calls.", "operationId"=>"getFiltersEndpoint", "x-api-path-slug"=>"filtersendpoint-get", "parameters"=>[{"in"=>"path", "name"=>"endpoint", "description"=>"Name of the endpoint"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filters", "Endpoint"]}}, "/grammaticalFeatures/{source_language}"=>{"get"=>{"summary"=>"Lists available grammatical features in a dataset", "description"=>"Returns a list of the available [grammatical features](documentation/glossary?term=grammaticalfeatures) for a given language dataset.", "operationId"=>"getGrammaticalfeaturesSourceLanguage", "x-api-path-slug"=>"grammaticalfeaturessource-language-get", "parameters"=>[{"in"=>"path", "name"=>"source_language", "description"=>"IANA language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GrammaticalFeatures", "Source", "Language"]}}, "/inflections/{source_lang}/{word_id}"=>{"get"=>{"summary"=>"Check a word exists in the dictionary and retrieve its root form", "description"=>"Use this to check if a word exists in the dictionary, or what 'root' form it links to (e.g., swimming > swim). The response tells you the possible [lemmas](documentation/glossary?term=lemma) for a given [inflected](documentation/glossary?term=inflection) word. This can then be combined with other endpoints to retrieve more information.", "operationId"=>"getInflectionsSourceLangWord", "x-api-path-slug"=>"inflectionssource-langword-id-get", "parameters"=>[{"in"=>"path", "name"=>"word_id", "description"=>"The input word"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Inflections", "Source", "Lang", "Word", "Id"]}}, "/inflections/{source_lang}/{word_id}/{filters}"=>{"get"=>{"summary"=>"Apply optional filters to Lemmatron response", "description"=>"Retrieve available [lemmas](documentation/glossary?term=lemma) for a given [inflected](documentation/glossary?term=inflection) wordform. Filter results by categories.", "operationId"=>"getInflectionsSourceLangWordFilters", "x-api-path-slug"=>"inflectionssource-langword-idfilters-get", "parameters"=>[{"in"=>"path", "name"=>"word_id", "description"=>"The input word"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Inflections", "Source", "Lang", "Word", "Id", "Filters"]}}, "/languages"=>{"get"=>{"summary"=>"Lists available dictionaries", "description"=>"Returns a list of monolingual and bilingual language datasets available in the API", "operationId"=>"getLanguages", "x-api-path-slug"=>"languages-get", "parameters"=>[{"in"=>"query", "name"=>"sourceLanguage", "description"=>"IANA language code"}, {"in"=>"query", "name"=>"targetLanguage", "description"=>"IANA language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Languages"]}}, "/lexicalcategories/{language}"=>{"get"=>{"summary"=>"Lists available lexical categories in a dataset", "description"=>"Returns a list of available [lexical categories](documentation/glossary?term=lexicalcategory) for a given language dataset.", "operationId"=>"getLexicalcategoriesLanguage", "x-api-path-slug"=>"lexicalcategorieslanguage-get", "parameters"=>[{"in"=>"path", "name"=>"language", "description"=>"IANA language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lexicalcategories", "Language"]}}, "/regions/{source_language}"=>{"get"=>{"summary"=>"Lists available regions in a monolingual dataset", "description"=>"Returns a list of the available [regions](documentation/glossary?term=regions) for a given monolingual language dataset.", "operationId"=>"getRegionsSourceLanguage", "x-api-path-slug"=>"regionssource-language-get", "parameters"=>[{"in"=>"path", "name"=>"source_language", "description"=>"IANA language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions", "Source", "Language"]}}, "/registers/{source_language}"=>{"get"=>{"summary"=>"Lists available registers in a monolingual dataset", "description"=>"Returns a list of the available [registers](documentation/glossary?term=registers) for a given monolingual language dataset.", "operationId"=>"getRegistersSourceLanguage", "x-api-path-slug"=>"registerssource-language-get", "parameters"=>[{"in"=>"path", "name"=>"source_language", "description"=>"IANA language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registers", "Source", "Language"]}}, "/registers/{source_register_language}/{target_register_language}"=>{"get"=>{"summary"=>"Lists available registers in a bilingual dataset", "description"=>"Returns a list of the available [registers](documentation/glossary?term=registers) for a given bilingual language dataset.", "operationId"=>"getRegistersSourceRegisterLanguageTargetRegisterLanguage", "x-api-path-slug"=>"registerssource-register-languagetarget-register-language-get", "parameters"=>[{"in"=>"path", "name"=>"source_register_language", "description"=>"IANA language code"}, {"in"=>"path", "name"=>"target_register_language", "description"=>"IANA language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registers", "Source", "Register", "Language", "Target", "Register", "Language"]}}, "/search/{source_lang}"=>{"get"=>{"summary"=>"Retrieve possible matches to input", "description"=>"Use this to retrieve possible [headword](documentation/glossary?term=headword) matches for a given string of text. The results are culculated using headword matching, fuzzy matching, and [lemmatization](documentation/glossary?term=lemma)", "operationId"=>"getSearchSourceLang", "x-api-path-slug"=>"searchsource-lang-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limit the number of results per response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset the start number of the result"}, {"in"=>"query", "name"=>"prefix", "description"=>"Set prefix to true if youd like to get results only starting with search string"}, {"in"=>"query", "name"=>"q", "description"=>"Search string"}, {"in"=>"query", "name"=>"regions", "description"=>"If searching in English, filter words with specific region(s) either us or gb"}, {"in"=>"path", "name"=>"source_lang", "description"=>"IANA language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Source", "Lang"]}}, "/search/{source_search_language}/translations={target_search_language}"=>{"get"=>{"summary"=>"Retrieve possible translation matches to input", "description"=>"Use this to find matches in our translation dictionaries.", "operationId"=>"getSearchSourceSearchLanguageTranslationsTargetSearchLanguage", "x-api-path-slug"=>"searchsource-search-languagetranslationstarget-search-language-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limit the number of results per response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset the start number of the result"}, {"in"=>"query", "name"=>"prefix", "description"=>"Set prefix to true if youd like to get results only starting with search string"}, {"in"=>"query", "name"=>"q", "description"=>"Search string"}, {"in"=>"query", "name"=>"regions", "description"=>"Filter words with specific region(s) E"}, {"in"=>"path", "name"=>"source_search_language", "description"=>"IANA language code"}, {"in"=>"path", "name"=>"target_search_language", "description"=>"IANA language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Source", "Search", "Language", "Translations=target", "Search", "Language"]}}, "/stats/frequency/ngrams/{source_lang}/{corpus}/{ngram-size}/"=>{"get"=>{"summary"=>"Retrieve the frequency of ngrams (1-4) derived from a corpus", "description"=>"This endpoint returns frequencies of ngrams of size 1-4. That is the number of times a word (ngram size = 1) or words (ngram size > 1) appear in the corpus. Ngrams are case sensitive (\"I AM\" and \"I am\" will have different frequency) and frequencies are calculated per word (true case) so \"the book\" and \"the books\" are two different ngrams. The results can be filtered based on query parameters. Parameters can be provided in PATH, GET or POST (form or json). The parameters in PATH are overriden by parameters in GET, POST and json (in that order). In PATH, individual options are separated by semicolon and values are separated by commas (where multiple values can be used). Example for bigrams (ngram of size 2):\n* PATH: /tokens=a word,another word\n* GET: /?tokens=a word&tokens=another word\n* POST (json):\n\n ```javascript\n {\n \"tokens\": [\"a word\", \"another word\"]\n }\n ```", "operationId"=>"getStatsFrequencyNgramsSourceLangCorpusNgramSize", "x-api-path-slug"=>"statsfrequencyngramssource-langcorpusngramsize-get", "parameters"=>[{"in"=>"query", "name"=>"contains", "description"=>"Find ngrams containing the given token(s)"}, {"in"=>"path", "name"=>"corpus", "description"=>"For corpora other than nmc (New Monitor Corpus) please contact api@oxforddictionaries"}, {"in"=>"query", "name"=>"format", "description"=>"Option specifying whether tokens should be returned as a single string (option google) or as a list of strings (option oup)"}, {"in"=>"query", "name"=>"limit", "description"=>"pagination - results limit"}, {"in"=>"query", "name"=>"maxDocumentFrequency", "description"=>"Restrict the query to entries that appera in at most `maxDocumentFrequency` documents"}, {"in"=>"query", "name"=>"maxFrequency", "description"=>"Restrict the query to entries with frequency of at most `maxFrequency`"}, {"in"=>"query", "name"=>"minDocumentFrequency", "description"=>"Restrict the query to entries that appear in at least `minDocumentFrequency` documents"}, {"in"=>"query", "name"=>"minFrequency", "description"=>"Restrict the query to entries with frequency of at least `minFrequency`"}, {"in"=>"path", "name"=>"ngram-size", "description"=>"the size of ngrams requested (1-4)"}, {"in"=>"query", "name"=>"offset", "description"=>"pagination - results offset"}, {"in"=>"query", "name"=>"punctuation", "description"=>"Flag specifying whether to lookup ngrams that include punctuation or not (possible values are true and false; default is false)"}, {"in"=>"path", "name"=>"source_lang", "description"=>"IANA language code"}, {"in"=>"query", "name"=>"tokens", "description"=>"List of tokens to filter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Frequency", "Ngrams", "Source", "Lang", "Corpus", "Ngram-size"]}}, "/stats/frequency/word/{source_lang}/"=>{"get"=>{"summary"=>"Retrieve the frequency of a word derived from a corpus.", "description"=>"This endpoint provides the frequency of a given word. When multiple database records match the query parameters, the returned frequency is the sum of the individual frequencies. For example, if the query parameters are lemma=test, the returned frequency will include the verb \"test\", the noun \"test\" and the adjective \"test\" in all forms (Test, tested, testing, etc.) If you are interested in the frequency of the word \"test\" but want to exclude other forms (e.g., tested) use the option trueCase=test. Normally, the word \"test\" will be spelt with a capital letter at the beginning of a sentence. The option trueCase will ignore this and it will count \"Test\" and \"test\" as the same token. If you are interested in frequencies of \"Test\" and \"test\", use the option wordform=test or wordform=Test. Note that trueCase is not just a lower case of the word as some words are genuinely spelt with a capital letter such as the word \"press\" in Oxford University Press. Parameters can be provided in PATH, GET or POST (form or json). The parameters in PATH are overriden by parameters in GET, POST and json (in that order). In PATH, individual options are separated by semicolon and values are separated by commas (where multiple values can be used). Examples:\n* PATH: /lemma=test;lexicalCategory=noun\n* GET: /?lemma=test&lexicalCategory=noun\n* POST (json):\n\n ```javascript\n {\n \"lemma\": \"test\",\n \"lexicalCategory\": \"noun\"\n }\n ```\n\n One of the options wordform/trueCase/lemma/lexicalCategory has to be provided.", "operationId"=>"getStatsFrequencyWordSourceLang", "x-api-path-slug"=>"statsfrequencywordsource-lang-get", "parameters"=>[{"in"=>"query", "name"=>"corpus", "description"=>"For corpora other than nmc (New Monitor Corpus) please contact api@oxforddictionaries"}, {"in"=>"query", "name"=>"lemma", "description"=>"The lemma of the word to look up (e"}, {"in"=>"query", "name"=>"lexicalCategory", "description"=>"The lexical category of the word(s) to look up (e"}, {"in"=>"path", "name"=>"source_lang", "description"=>"IANA language code"}, {"in"=>"query", "name"=>"trueCase", "description"=>"The written form of the word to look up with normalised case (Books --> books)"}, {"in"=>"query", "name"=>"wordform", "description"=>"The written form of the word to look up (preserving case e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Frequency", "Word", "Source", "Lang"]}}, "/stats/frequency/words/{source_lang}/"=>{"get"=>{"summary"=>"Retrieve a list of frequencies of a word/words derived from a corpus.", "description"=>"This endpoint provides a list of frequencies for a given word or words. Unlike the /word/ endpoint, the results are split into the smallest units. To exclude a specific value, prepend it with the minus sign ('-'). For example, to get frequencies of the lemma 'happy' but exclude superlative forms (i.e., happiest) you could use options 'lemma=happy;grammaticalFeatures=-degreeType:superlative'. Parameters can be provided in PATH, GET or POST (form or json). The parameters in PATH are overriden by parameters in GET, POST and json (in that order). In PATH, individual options are separated by semicolon and values are separated by commas (where multiple values can be used). The parameters wordform/trueCase/lemma/lexicalCategory also exist in a plural form, taking a lists of items. Examples:\n* PATH: /wordforms=happy,happier,happiest\n* GET: /?wordforms=happy&wordforms=happier&wordforms=happiest\n* POST (json):\n```javascript\n {\n \"wordforms\": [\"happy\", \"happier\", \"happiest\"]\n }\n```\n Aside from individual frequency requests, users can also post a list of items for which they would like to get frequencies. The list has to be uploaded in json and the required fields are \"items\" and \"collate\". The field \"items\" is a list of items for which you want the frequencies. The content of the items depends on the option for \"collate\". The value of \"collate\" should be a list of \"columns\" that the items contain. The list is limited to combinations of \"wordform\", \"lemma\", \"trueCase\" and \"lexicalCategory\". The fields that are listed in the \"collate\" options have to be present in each item. Here are some examples of queries:\n* ### Get frequencies of provided wordforms:\n```javascript\n {\n \"collate\": [\"wordform\"],\n \"items\": [{\"wordform\": \"test\"}, {\"wordform\": \"Test\"}]\n }\n```\n* ### Get frequencies of provided lemmas:\n```javascript\n {\n \"collate\": [\"lemma\"],\n \"items\": [{\"lemma\": \"test\"}, {\"lemma\": \"Test\"}]\n }\n```\n* ### Get frequencies of provided lemmas per lexical category:\n```javascript\n {\n \"collate\": [\"lemma\", \"lexicalCategory\"],\n \"items\": [\n {\"lemma\": \"test\", \"lexicalCategory\": \"verb\"},\n {\"lemma\": \"test\", \"lexicalCategory\": \"noun\"}\n ]\n }\n```", "operationId"=>"getStatsFrequencyWordsSourceLang", "x-api-path-slug"=>"statsfrequencywordssource-lang-get", "parameters"=>[{"in"=>"query", "name"=>"corpus", "description"=>"For corpora other than nmc (New Monitor Corpus) please contact api@oxforddictionaries"}, {"in"=>"query", "name"=>"grammaticalFeatures", "description"=>"The grammatical features of the word(s) to look up entered as a list of k:v (e"}, {"in"=>"query", "name"=>"lemma", "description"=>"The lemma of the word to look up (e"}, {"in"=>"query", "name"=>"lexicalCategory", "description"=>"The lexical category of the word(s) to look up (e"}, {"in"=>"query", "name"=>"limit", "description"=>"pagination - results limit"}, {"in"=>"query", "name"=>"maxFrequency", "description"=>"Restrict the query to entries with frequency of at most `maxFrequency`"}, {"in"=>"query", "name"=>"maxNormalizedFrequency", "description"=>"Restrict the query to entries with frequency of at most `maxNormalizedFrequency`"}, {"in"=>"query", "name"=>"minFrequency", "description"=>"Restrict the query to entries with frequency of at least `minFrequency`"}, {"in"=>"query", "name"=>"minNormalizedFrequency", "description"=>"Restrict the query to entries with frequency of at least `minNormalizedFrequency`"}, {"in"=>"query", "name"=>"offset", "description"=>"pagination - results offset"}, {"in"=>"query", "name"=>"sort", "description"=>"sort the resulting list by wordform, trueCase, lemma, lexicalCategory, frequency, normalizedFrequency"}, {"in"=>"path", "name"=>"source_lang", "description"=>"IANA language code"}, {"in"=>"query", "name"=>"trueCase", "description"=>"The written form of the word to look up with normalised case (Books --> books)"}, {"in"=>"query", "name"=>"wordform", "description"=>"The written form of the word to look up (preserving case e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Frequency", "Words", "Source", "Lang"]}}, "/wordlist/{source_lang}/{filters_advanced}"=>{"get"=>{"summary"=>"Retrieve list of words for category with advanced options", "description"=>"Use this to apply more complex filters to the [list of words](documentation/glossary?term=wordlist). For example, you may only want to filter out words for which all [senses](documentation/glossary?term=sense) match the filter, or only its 'prime sense'. You can also filter by word length or match by substring (prefix).", "operationId"=>"getWordlistSourceLangFiltersAdvanced", "x-api-path-slug"=>"wordlistsource-langfilters-advanced-get", "parameters"=>[{"in"=>"query", "name"=>"exact", "description"=>"If exact=true wordlist returns a list of entries that exactly matches the search string"}, {"in"=>"query", "name"=>"exclude", "description"=>"Semicolon separated list of parameters-value pairs (same as filters)"}, {"in"=>"query", "name"=>"exclude_prime_senses", "description"=>"Semicolon separated list of parameters-value pairs (same as filters)"}, {"in"=>"query", "name"=>"exclude_senses", "description"=>"Semicolon separated list of parameters-value pairs (same as filters)"}, {"in"=>"path", "name"=>"filters_advanced", "description"=>"Semicolon separated list of wordlist parameters, presented as value pairs: LexicalCategory, domains, regions, registers"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit the number of results per response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset the start number of the result"}, {"in"=>"query", "name"=>"prefix", "description"=>"Filter words that start with prefix parameter"}, {"in"=>"query", "name"=>"word_length", "description"=>"Parameter to speficy the minimum (>), exact or maximum (5 - more than 5 chars; 5"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wordlist", "Source", "Lang", "Filters", "Advanced"]}}, "/wordlist/{source_lang}/{filters_basic}"=>{"get"=>{"summary"=>"Retrieve a list of words in a category", "description"=>"Use this to retrieve a [list of words](documentation/glossary?term=wordlist) for particular [domain](documentation/glossary?term=domain), [lexical category](documentation/glossary?term=lexicalcategory), [register](documentation/glossary?term=registers) and/or [region](documentation/glossary?term=regions). View the full list of possible filters using the filters Utility endpoint. The response only includes [headwords](documentation/glossary?term=headword), not all their possible [inflections](documentation/glossary?term=inflection). If you require a full [wordlist](documentation/glossary?term=wordlist) including [inflected forms](documentation/glossary?term=inflection), contact us and we can help.", "operationId"=>"getWordlistSourceLangFiltersBasic", "x-api-path-slug"=>"wordlistsource-langfilters-basic-get", "parameters"=>[{"in"=>"path", "name"=>"filters_basic", "description"=>"Semicolon separated list of wordlist parameters, presented as value pairs: LexicalCategory, domains, regions, registers"}, {"in"=>"query", "name"=>"limit", "description"=>"Limit the number of results per response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset the start number of the result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wordlist", "Source", "Lang", "Filters", "Basic"]}}, "/domains/{source_language}/{target_language}"=>{"get"=>{"summary"=>"Lists available domains in a given bilingual language dataset.", "description"=>"Returns a list of the available [domains](/glossary?tag=#domains&expand) for a given bilingual language dataset.", "operationId"=>"getDomainsSourceLanguageTargetLanguage", "x-api-path-slug"=>"domainssource-languagetarget-language-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains", "Source", "Language", "Target", "Language"]}}, "/entries/{source_lang}/{word_id}/definitions"=>{"get"=>{"summary"=>"Retrieve only definitions in entry search.", "description"=>"Find available [dictionary entries](/glossary?tag=#entry&expand) for given word and language. Filter results by categories.", "operationId"=>"getEntriesSourceLangWordDefinitions", "x-api-path-slug"=>"entriessource-langword-iddefinitions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entries", "Source", "Lang", "Word", "Id", "Definitions"]}}, "/entries/{source_lang}/{word_id}/examples"=>{"get"=>{"summary"=>"Retrieve only example sentences in entry search.", "description"=>"Find available [dictionary entries](/glossary?tag=#entry&expand) for given word and language. Filter results by categories.", "operationId"=>"getEntriesSourceLangWordExamples", "x-api-path-slug"=>"entriessource-langword-idexamples-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entries", "Source", "Lang", "Word", "Id", "Examples"]}}, "/entries/{source_lang}/{word_id}/pronunciations"=>{"get"=>{"summary"=>"Retrieve only pronunciations in entry search.", "description"=>"Find available [dictionary entries](/glossary?tag=#entry&expand) for given word and language. Filter results by categories.", "operationId"=>"getEntriesSourceLangWordPronunciations", "x-api-path-slug"=>"entriessource-langword-idpronunciations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entries", "Source", "Lang", "Word", "Id", "Pronunciations"]}}, "/entries/{source_lang}/{word_id}/translations={target_lang}"=>{"get"=>{"summary"=>"Find translation for a given word.", "description"=>"Returns target language translations for a given word ID and source language. \nIn the event that a word in the dataset does not have a direct translation, the response will be a [definition](/glossary?tag=#entry&expand) in the target language.", "operationId"=>"getEntriesSourceLangWordTranslationsTargetLang", "x-api-path-slug"=>"entriessource-langword-idtranslationstarget-lang-get", "parameters"=>[{"in"=>"path", "name"=>"word_id", "description"=>"An Entry identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Entries", "Source", "Lang", "Word", "Id", "Translations=target", "Lang"]}}, "/registers/{source_language}/{target_language}"=>{"get"=>{"summary"=>"Lists available registers in a given bilingual language dataset.", "description"=>"Returns a list of the available [registers](/glossary?tag=#registers&expand) for a given bilingual language dataset.", "operationId"=>"getRegistersSourceLanguageTargetLanguage", "x-api-path-slug"=>"registerssource-languagetarget-language-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registers", "Source", "Language", "Target", "Language"]}}, "/search/{source_lang}/translations={target_lang}"=>{"get"=>{"summary"=>"Find translation results for search query.", "description"=>"Find available translation results for a search query and language.", "operationId"=>"getSearchSourceLangTranslationsTargetLang", "x-api-path-slug"=>"searchsource-langtranslationstarget-lang-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limit the number of results per response"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset the start number of the result"}, {"in"=>"query", "name"=>"prefix", "description"=>"Set prefix to true if youd like to get results only starting with search string"}, {"in"=>"query", "name"=>"q", "description"=>"Search string"}, {"in"=>"query", "name"=>"regions", "description"=>"Filter words with specific region(s) E"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Source", "Lang", "Translations=target", "Lang"]}}}}, "apis"=>{"name"=>"Oxford Dictionaries", "x-slug"=>"oxford-dictionaries", "description"=>"If you’re looking to enhance your app or website with dictionary data, don’t compromise on quality. The Oxford Dictionaries API offers easy and intuitive access to Oxfords dictionary content, which is trusted around the world. Here at Oxford Dictionaries, home of the OED, we love words. That’s why we have experienced lexicographers tracking the living language, delving deep into our corpora and monitoring a wide range of media in order to understand how words are being used and how language is evolving. This research is used by our editors to write and edit dictionary entries and translations, meaning we’re able to offer up-to-date, accurate, and reliable lexical content in multiple languages.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/oxford-dictionaries-api.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"dictionaries,General Data,Pedestal,Service API,Words", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"oxford-dictionaries/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Oxford Dictionaries", "x-api-slug"=>"oxford-dictionaries", "description"=>"If you’re looking to enhance your app or website with dictionary data, don’t compromise on quality. The Oxford Dictionaries API offers easy and intuitive access to Oxfords dictionary content, which is trusted around the world. Here at Oxford Dictionaries, home of the OED, we love words. That’s why we have experienced lexicographers tracking the living language, delving deep into our corpora and monitoring a wide range of media in order to understand how words are being used and how language is evolving. This research is used by our editors to write and edit dictionary entries and translations, meaning we’re able to offer up-to-date, accurate, and reliable lexical content in multiple languages.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/oxford-dictionaries-api.png", "humanURL"=>"https://developer.oxforddictionaries.com/", "baseURL"=>"https://od-api-demo.oxforddictionaries.com:443//api/v1", "tags"=>"dictionaries,General Data,Pedestal,Service API,Words", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/oxford-dictionaries/searchsource-langtranslationstarget-lang-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/oxford-dictionaries/oxford-dictionaries-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://api-blog.oxforddictionaries.com/"}, {"type"=>"x-developer", "url"=>"https://developer.oxforddictionaries.com/"}, {"type"=>"x-faq", "url"=>"https://developer.oxforddictionaries.com/faq"}, {"type"=>"x-forum", "url"=>"https://forum.oxforddictionaries.com/api/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/OxfordWordsAPI"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
mocklab{"mocklab-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"MockLab", "x-complete"=>1, "info"=>{"title"=>"WireMock", "version"=>"1.0.0"}, "basePath"=>"/__admin", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/mappings"=>{"delete"=>{"summary"=>"Delete Mappings", "description"=>"Delete all stub mappings", "operationId"=>"deleteMappings", "x-api-path-slug"=>"mappings-delete", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Mappings"]}, "get"=>{"summary"=>"Get Mappings", "description"=>"Get all stub mappings", "operationId"=>"getMappings", "x-api-path-slug"=>"mappings-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"The maximum number of results to return"}, {"in"=>"query", "name"=>"offset", "description"=>"The start index of the results to return"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Mappings"]}, "post"=>{"summary"=>"Post Mappings", "description"=>"Create a new stub mapping", "operationId"=>"postMappings", "x-api-path-slug"=>"mappings-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Mappings"]}}, "/mappings/find-by-metadata"=>{"post"=>{"summary"=>"Post Mappings Find By Metadata", "description"=>"Find stubs by matching on their metadata", "operationId"=>"postMappingsFindByMetadata", "x-api-path-slug"=>"mappingsfindbymetadata-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Mappings", "Find", "Metadata"]}}, "/mappings/remove-by-metadata"=>{"post"=>{"summary"=>"Post Mappings Remove By Metadata", "description"=>"Remove stubs by matching on their metadata", "operationId"=>"postMappingsRemoveByMetadata", "x-api-path-slug"=>"mappingsremovebymetadata-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Mappings", "Remove", "Metadata"]}}, "/mappings/reset"=>{"post"=>{"summary"=>"Post Mappings Reset", "description"=>"Reset stub mappings (restore to defaults defined back the backing store)", "operationId"=>"postMappingsReset", "x-api-path-slug"=>"mappingsreset-post", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Mappings", "Reset"]}}, "/mappings/save"=>{"post"=>{"summary"=>"Post Mappings Save", "description"=>"Save all persistent stub mappings to the backing store", "operationId"=>"postMappingsSave", "x-api-path-slug"=>"mappingssave-post", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Mappings", "Save"]}}, "/mappings/{stubMappingId}"=>{"delete"=>{"summary"=>"Delete Mappings Stubmappingid", "description"=>"Delete mappings stubmappingid.", "operationId"=>"deleteMappingsStubmapping", "x-api-path-slug"=>"mappingsstubmappingid-delete", "parameters"=>[{"in"=>"path", "name"=>"stubMappingId", "description"=>"The UUID of stub mapping"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Mappings", "Stubmappingid"]}, "get"=>{"summary"=>"Get Mappings Stubmappingid", "description"=>"Get mappings stubmappingid.", "operationId"=>"getMappingsStubmapping", "x-api-path-slug"=>"mappingsstubmappingid-get", "parameters"=>[{"in"=>"path", "name"=>"stubMappingId", "description"=>"The UUID of stub mapping"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Mappings", "Stubmappingid"]}, "put"=>{"summary"=>"Put Mappings Stubmappingid", "description"=>"Update an existing stub mapping", "operationId"=>"putMappingsStubmapping", "x-api-path-slug"=>"mappingsstubmappingid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"stubMappingId", "description"=>"The UUID of stub mapping"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Mappings", "Stubmappingid"]}}, "/near-misses/request"=>{"post"=>{"summary"=>"Post Near Misses Request", "description"=>"Find at most 3 near misses for closest stub mappings to the specified request", "operationId"=>"postNearMissesRequest", "x-api-path-slug"=>"nearmissesrequest-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Near", "Misses", "Request"]}}, "/near-misses/request-pattern"=>{"post"=>{"summary"=>"Post Near Misses Request Pattern", "description"=>"Find at most 3 near misses for closest logged requests to the specified request pattern", "operationId"=>"postNearMissesRequestPattern", "x-api-path-slug"=>"nearmissesrequestpattern-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Near", "Misses", "Request", "Pattern"]}}, "/recordings/snapshot"=>{"post"=>{"summary"=>"Post Recordings Snapshot", "description"=>"Take a snapshot recording", "operationId"=>"postRecordingsSnapshot", "x-api-path-slug"=>"recordingssnapshot-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Recordings", "Snapshot"]}}, "/recordings/start"=>{"post"=>{"summary"=>"Post Recordings Start", "description"=>"Start recording stub mappings", "operationId"=>"postRecordingsStart", "x-api-path-slug"=>"recordingsstart-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Recordings", "Start"]}}, "/recordings/status"=>{"get"=>{"summary"=>"Get Recordings Status", "description"=>"Get the recording status (started or stopped)", "operationId"=>"getRecordingsStatus", "x-api-path-slug"=>"recordingsstatus-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Recordings", "Status"]}}, "/recordings/stop"=>{"post"=>{"summary"=>"Post Recordings Stop", "description"=>"Stop recording stub mappings", "operationId"=>"postRecordingsStop", "x-api-path-slug"=>"recordingsstop-post", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Recordings", "Stop"]}}, "/requests"=>{"delete"=>{"summary"=>"Delete Requests", "description"=>"Delete all received requests", "operationId"=>"deleteRequests", "x-api-path-slug"=>"requests-delete", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Requests"]}, "get"=>{"summary"=>"Get Requests", "description"=>"Get received requests", "operationId"=>"getRequests", "x-api-path-slug"=>"requests-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"The maximum number of results to return"}, {"in"=>"query", "name"=>"since", "description"=>"Only return logged requests after this date"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Requests"]}}, "/requests/count"=>{"post"=>{"summary"=>"Post Requests Count", "description"=>"Count requests logged in the journal matching the specified criteria", "operationId"=>"postRequestsCount", "x-api-path-slug"=>"requestscount-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Requests", "Count"]}}, "/requests/find"=>{"post"=>{"summary"=>"Post Requests Find", "description"=>"Retrieve details of requests logged in the journal matching the specified criteria", "operationId"=>"postRequestsFind", "x-api-path-slug"=>"requestsfind-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Requests", "Find"]}}, "/requests/reset"=>{"post"=>{"summary"=>"Post Requests Reset", "description"=>"Empty the request journal", "operationId"=>"postRequestsReset", "x-api-path-slug"=>"requestsreset-post", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Requests", "Reset"]}}, "/requests/unmatched"=>{"get"=>{"summary"=>"Get Requests Unmatched", "description"=>"Get details of logged requests that weren't matched by any stub mapping", "operationId"=>"getRequestsUnmatched", "x-api-path-slug"=>"requestsunmatched-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Requests", "Unmatched"]}}, "/requests/unmatched/near-misses"=>{"get"=>{"summary"=>"Get Requests Unmatched Near Misses", "description"=>"Retrieve near-misses for all unmatched requests", "operationId"=>"getRequestsUnmatchedNearMisses", "x-api-path-slug"=>"requestsunmatchednearmisses-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Requests", "Unmatched", "Near", "Misses"]}}, "/requests/{requestId}"=>{"get"=>{"summary"=>"Get Requests Requestid", "description"=>"Get requests requestid.", "operationId"=>"getRequestsRequest", "x-api-path-slug"=>"requestsrequestid-get", "parameters"=>[{"in"=>"path", "name"=>"requestId", "description"=>"The UUID of the logged request"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Requests", "Requestid"]}}, "/scenarios"=>{"get"=>{"summary"=>"Get Scenarios", "description"=>"Get all scenarios", "operationId"=>"getScenarios", "x-api-path-slug"=>"scenarios-get", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Scenarios"]}}, "/scenarios/reset"=>{"post"=>{"summary"=>"Post Scenarios Reset", "description"=>"Reset the state of all scenarios", "operationId"=>"postScenariosReset", "x-api-path-slug"=>"scenariosreset-post", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Scenarios", "Reset"]}}, "/settings"=>{"post"=>{"summary"=>"Post Settings", "description"=>"Update global settings", "operationId"=>"postSettings", "x-api-path-slug"=>"settings-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Settings"]}}, "/shutdown"=>{"post"=>{"summary"=>"Post Shutdown", "description"=>"Shutdown the WireMock server", "operationId"=>"postShutdown", "x-api-path-slug"=>"shutdown-post", "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Shutdown"]}}}}, "apis"=>{"name"=>"MockLab", "x-slug"=>"mocklab", "description"=>"MockLab helps teams ship better apps faster by mocking APIs that arent ready, dont have a reliable sandbox or have high usage charges. Keep building and testing when the APIs you use arent ready. Ship more robust systems by simulating edge cases and faults. Performance testing without large 3rd party bills. Simulate stateful behaviour in your mocked API using a simple finite state machine model. Dynamically render responses using the Handlebars templating language. Craft your simulation using the friendly, no-code UI or go fully automated with the 100% WireMock-compatible API. Capture traffic to another API, then play it back from MockLab. Mock the unfinished parts of the API and proxy the rest straight through to the real thing. Test your app to destruction by injecting delays, dropped connections, drip-drip responses and corrupt HTTP payloads. All the power and flexibility you need for pain-free testing.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Mocklab_Logo_4x.png", "x-kinRank"=>"8", "x-alexaRank"=>"1638385", "tags"=>"Mocking,Relative Data,Service API,Virtualizations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"mocklab/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"MockLab", "x-api-slug"=>"mocklab", "description"=>"MockLab helps teams ship better apps faster by mocking APIs that arent ready, dont have a reliable sandbox or have high usage charges. Keep building and testing when the APIs you use arent ready. Ship more robust systems by simulating edge cases and faults. Performance testing without large 3rd party bills. Simulate stateful behaviour in your mocked API using a simple finite state machine model. Dynamically render responses using the Handlebars templating language. Craft your simulation using the friendly, no-code UI or go fully automated with the 100% WireMock-compatible API. Capture traffic to another API, then play it back from MockLab. Mock the unfinished parts of the API and proxy the rest straight through to the real thing. Test your app to destruction by injecting delays, dropped connections, drip-drip responses and corrupt HTTP payloads. All the power and flexibility you need for pain-free testing.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Mocklab_Logo_4x.png", "humanURL"=>"https://get.mocklab.io", "baseURL"=>"https:////__admin", "tags"=>"Mocking,Relative Data,Service API,Virtualizations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/mocklab/mocklab-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/mocklab"}, {"type"=>"x-documentation", "url"=>"http://docs.mocklab.io/docs/getting-started/"}, {"type"=>"x-openapi", "url"=>"http://example.mocklab.io/__admin/docs/swagger"}, {"type"=>"x-pricing", "url"=>"http://get.mocklab.io/pricing/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/TomAkehurst"}, {"type"=>"x-website", "url"=>"https://get.mocklab.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-slides{"google-slides-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Slides", "x-complete"=>1, "info"=>{"title"=>"Google Slides", "description"=>"an-api-for-creating-and-editing-google-slides-presentations-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"slides.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/presentations"=>{"post"=>{"summary"=>"Create Presentation", "description"=>"Creates a new presentation using the title given in the request. Other\nfields in the request are ignored.\nReturns the created presentation.", "operationId"=>"slides.presentations.create", "x-api-path-slug"=>"v1presentations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Presentation"]}}, "/v1/presentations/{presentationId}"=>{"get"=>{"summary"=>"Get Presentation", "description"=>"Gets the latest version of the specified presentation.", "operationId"=>"slides.presentations.get", "x-api-path-slug"=>"v1presentationspresentationid-get", "parameters"=>[{"in"=>"path", "name"=>"presentationId", "description"=>"The ID of the presentation to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Presentation"]}}, "/v1/presentations/{presentationId}/pages/{pageObjectId}"=>{"get"=>{"summary"=>"Get Presentation Page", "description"=>"Gets the latest version of the specified page in the presentation.", "operationId"=>"slides.presentations.pages.get", "x-api-path-slug"=>"v1presentationspresentationidpagespageobjectid-get", "parameters"=>[{"in"=>"path", "name"=>"pageObjectId", "description"=>"The object ID of the page to retrieve"}, {"in"=>"path", "name"=>"presentationId", "description"=>"The ID of the presentation to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Presentation", "Page"]}}, "/v1/presentations/{presentationId}:batchUpdate"=>{"post"=>{"summary"=>"Update Presentation", "description"=>"Applies one or more updates to the presentation.\n\nEach request is validated before\nbeing applied. If any request is not valid, then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how they are applied. Other requests do\nnot need to return information; these each return an empty reply.\nThe order of replies matches that of the requests.\n\nFor example, suppose you call batchUpdate with four updates, and only the\nthird one returns information. The response would have two empty replies:\nthe reply to the third request, and another empty reply, in that order.\n\nBecause other users may be editing the presentation, the presentation\nmight not exactly reflect your changes: your changes may\nbe altered with respect to collaborator changes. If there are no\ncollaborators, the presentation should reflect your changes. In any case,\nthe updates in your request are guaranteed to be applied together\natomically.", "operationId"=>"slides.presentations.batchUpdate", "x-api-path-slug"=>"v1presentationspresentationidbatchupdate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"presentationId", "description"=>"The presentation to apply the updates to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Presentation"]}}}}, "apis"=>{"name"=>"Google Slides", "x-slug"=>"google-slides", "description"=>"The Google Slides API lets you create and modify Google Slides presentations. Apps can integrate with the Google Slides API to create beautiful slide decks automatically from user- and system-provided data. For example, you could use customer details from a database and combine them with predesigned templates and selected configuration options to create finished presentations in a fraction of the time it would take to create them manually.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-slides-icon.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Documents,Google APIs,Productivity,Profiles,Relative Data,Service API,Slides,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-slides/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Slides API", "x-api-slug"=>"google-slides-api", "description"=>"The Google Slides API lets you create and modify Google Slides presentations. Apps can integrate with the Google Slides API to create beautiful slide decks automatically from user- and system-provided data. For example, you could use customer details from a database and combine them with predesigned templates and selected configuration options to create finished presentations in a fraction of the time it would take to create them manually.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-slides-icon.png", "humanURL"=>"https://docs.google.com/presentation/", "baseURL"=>"://slides.googleapis.com//", "tags"=>"API Provider,API Service Provider,Documents,Google APIs,Productivity,Profiles,Relative Data,Service API,Slides,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-slides/google-slides-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"https://developers.google.com/slides/"}, {"type"=>"x-documentation", "url"=>"https://developers.google.com/slides/reference/rest/"}, {"type"=>"x-getting-started", "url"=>"https://developers.google.com/slides/quickstart/android"}, {"type"=>"x-guides", "url"=>"https://developers.google.com/slides/how-tos/overview"}, {"type"=>"x-samples", "url"=>"https://developers.google.com/slides/samples/"}, {"type"=>"x-support", "url"=>"https://developers.google.com/slides/support"}, {"type"=>"x-website", "url"=>"https://docs.google.com/presentation/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
blazemeter{"blazemeter-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"BlazeMeter", "x-complete"=>1, "info"=>{"title"=>"Blazemeter API Explorer", "description"=>"live-api-documentation", "version"=>"1.0.0"}, "host"=>"a.blazemeter.com", "basePath"=>"/api/v4", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/user/active/sessions"=>{"get"=>{"summary"=>"Get User Active Sessions", "description"=>"Get user active sessions.", "operationId"=>"active_sessions", "x-api-path-slug"=>"useractivesessions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User", "Active", "Sessions"]}}, "/user/active/terminate"=>{"post"=>{"summary"=>"Post User Active Terminate", "description"=>"Post user active terminate.", "operationId"=>"panic_terminate", "x-api-path-slug"=>"useractiveterminate-post", "parameters"=>[{"in"=>"body", "name"=>"blazemeter\\Routing\\v4\\UserModel5", "description"=>"session_ids (required)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User", "Active", "Terminate"]}}, "/user/collections"=>{"get"=>{"summary"=>"Get User Collections", "description"=>"Get user collections.", "operationId"=>"retrieveCollections", "x-api-path-slug"=>"usercollections-get", "parameters"=>[{"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"skip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User", "Collections"]}}, "/user/invites"=>{"get"=>{"summary"=>"Get User Invites", "description"=>"Get user invites.", "operationId"=>"retrieveInvites", "x-api-path-slug"=>"userinvites-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User", "Invites"]}}, "/user/locations"=>{"get"=>{"summary"=>"Get User Locations", "description"=>"Get user locations.", "operationId"=>"retrieveLocations", "x-api-path-slug"=>"userlocations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User", "Locations"]}}, "/user/masters"=>{"get"=>{"summary"=>"Get User Masters", "description"=>"Get user masters.", "operationId"=>"retrieveMasters", "x-api-path-slug"=>"usermasters-get", "parameters"=>[{"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"skip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User", "Masters"]}}, "/user/password"=>{"patch"=>{"summary"=>"Patch User Password", "description"=>"Patch user password.", "operationId"=>"user.password.patch", "x-api-path-slug"=>"userpassword-patch", "parameters"=>[{"in"=>"body", "name"=>"blazemeter\\Routing\\v4\\UserModel1", "description"=>"currentPassword (required)newPassword (required)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User", "Password"]}, "post"=>{"summary"=>"Post User Password", "description"=>"Post user password.", "operationId"=>"user.password.post", "x-api-path-slug"=>"userpassword-post", "parameters"=>[{"in"=>"body", "name"=>"blazemeter\\Routing\\v4\\UserModel3", "description"=>"currentPassword (required)newPassword (required)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User", "Password"]}, "put"=>{"summary"=>"Put User Password", "description"=>"Put user password.", "operationId"=>"user.password.put", "x-api-path-slug"=>"userpassword-put", "parameters"=>[{"in"=>"body", "name"=>"blazemeter\\Routing\\v4\\UserModel2", "description"=>"currentPassword (required)newPassword (required)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User", "Password"]}}, "/user/projects"=>{"get"=>{"summary"=>"Get User Projects", "description"=>"Get user projects.", "operationId"=>"retrieveProjects", "x-api-path-slug"=>"userprojects-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User", "Projects"]}}, "/user/register"=>{"get"=>{"summary"=>"Get User Register", "description"=>"Get user register.", "operationId"=>"register_retrieve", "x-api-path-slug"=>"userregister-get", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"Email address"}, {"in"=>"query", "name"=>"firstName", "description"=>"First name"}, {"in"=>"query", "name"=>"lastName", "description"=>"Last name"}, {"in"=>"query", "name"=>"password", "description"=>"Password"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User", "Register"]}, "post"=>{"summary"=>"Post User Register", "description"=>"Post user register.", "operationId"=>"register", "x-api-path-slug"=>"userregister-post", "parameters"=>[{"in"=>"body", "name"=>"blazemeter\\Routing\\v4\\UserModel4", "description"=>"firstName (required)lastName (required)email (required)password (required)", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User", "Register"]}}, "/user/tests"=>{"get"=>{"summary"=>"Get User Tests", "description"=>"Get user tests.", "operationId"=>"retrieveTests", "x-api-path-slug"=>"usertests-get", "parameters"=>[{"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"skip"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User", "Tests"]}}, "/user/top"=>{"get"=>{"summary"=>"Get User Top", "description"=>"Get user top.", "operationId"=>"top", "x-api-path-slug"=>"usertop-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "User", "Top"]}}}}, "apis"=>{"name"=>"BlazeMeter", "x-slug"=>"blazemeter", "description"=>"BlazeMeter platform for load and performance testing enables dev and QA teams to run scalable and continuous testing for website, mobile, api and software", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1297-blazemeter.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"69236", "tags"=>"API Provider,API Service Provider,Enterprise,Performance,Profiles,SaaS,Service API,Stack Network,Technology,Testing,Testing", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"blazemeter/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Blazemeter", "x-api-slug"=>"blazemeter", "description"=>"BlazeMeter platform for load and performance testing enables dev and QA teams to run scalable and continuous testing for website, mobile, api and software", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1297-blazemeter.jpg", "humanURL"=>"http://blazemeter.com/", "baseURL"=>"https://a.blazemeter.com//api/v4", "tags"=>"API Provider,API Service Provider,Enterprise,Performance,Profiles,SaaS,Service API,Stack Network,Technology,Testing,Testing", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/blazemeter/blazemeter-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://blazemeter.com/blog"}, {"type"=>"x-blog-rss", "url"=>"http://feedburner.google.com/fb/a/mailverify?uri=JmeterCloudBlog"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/blazemeter"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/blazemeter"}, {"type"=>"x-documentation", "url"=>"https://guide.blazemeter.com/hc/en-us/articles/206732689-BlazeMeter-REST-APIs-BlazeMeter-REST-APIs"}, {"type"=>"x-email", "url"=>"marketing@blazemeter.com"}, {"type"=>"x-email", "url"=>"support@blazemeter.com"}, {"type"=>"x-email", "url"=>"sales@blazemeter.com"}, {"type"=>"x-email", "url"=>"info@blazemeter.com"}, {"type"=>"x-github", "url"=>"https://github.com/Blazemeter"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/BlazeMeter"}, {"type"=>"x-website", "url"=>"http://blazemeter.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
nfusion-solutions{"nfusion-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"nFusion Solutions", "x-complete"=>1, "info"=>{"title"=>"nFusion Solutions Market Data API v1", "description"=>"nfusion-solutions-provides-rest-and-streaming-apis-that-deliver-enterprisegrade-financial-data--data-sets-include-realtime-and-historical-pricing-for-spot-prices-of-precious-metals-such-as-gold-silver-platinum-and-palladium-exchange-rates-for-major-currency-pairs-exchange-rates-for-crypto-currencies-such-as-btc-eth-and-ltc--all-api-access-requires-authentication--in-order-to-be-issued-access-credentials-you-must-first-enter-into-a-service-agreement-with-nfusion-solutions-and-acquire-a-commercial-license--for-information-on-how-to-obtain-a-licence-contact-salesnfusionsolutions-com-", "contact"=>{"name"=>"nFusion Solutions", "url"=>"https://nfusionsolutions.com/contact", "email"=>"support@nfusionsolutions.com"}, "version"=>"1.0.0"}, "host"=>"api.nfusionsolutions.biz", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/v{version}/Currencies/rate/supported"=>{"get"=>{"summary"=>"Get list of currencies supported by the rate endpoint", "description"=>"Any of the currencies in this list can be paired with any other currency in this list when supplied to the Rate endpoint.\r\nFor example: USD/CAD,CAD/USD,USD/EUR,EUR/CAD", "operationId"=>"ApiV{versionCurrenciesRateSupportedGet", "x-api-path-slug"=>"apivversioncurrenciesratesupported-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Currencies", "Supported", "By", "Rate", "Endpoint"]}}, "/api/v{version}/Currencies/summary/supported"=>{"get"=>{"summary"=>"Get list of currency pairs supported by the Summary endpoint", "description"=>"Only the currency pairs in the direction noted can be used with the Summary endpoint.\r\nFor example: USD/CAD is not the same as CAD/USD", "operationId"=>"ApiV{versionCurrenciesSummarySupportedGet", "x-api-path-slug"=>"apivversioncurrenciessummarysupported-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Currency", "Pairs", "Supported", "By", "Summary", "Endpoint"]}}, "/api/v{version}/Currencies/history/supported"=>{"get"=>{"summary"=>"Get list of currency pairs supported by the history endpoint", "description"=>"Only the currency pairs in the direction noted can be used with the history endpoint.\r\nFor example: USD/CAD is not the same as CAD/USD", "operationId"=>"ApiV{versionCurrenciesHistorySupportedGet", "x-api-path-slug"=>"apivversioncurrencieshistorysupported-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Currency", "Pairs", "Supported", "By", "History", "Endpoint"]}}, "/api/v{version}/Currencies/rate"=>{"get"=>{"summary"=>"Get latest mid rate for requested currency pairs", "description"=>"Get latest mid rate for requested currency pairs.", "operationId"=>"ApiV{versionCurrenciesRateGet", "x-api-path-slug"=>"apivversioncurrenciesrate-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"pairs", "description"=>"comma separated list of currency pairs"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Latest", "Mid", "Raterequested", "Currency", "Pairs"]}}, "/api/v{version}/Currencies/summary"=>{"get"=>{"summary"=>"Get latest Summary for requested currency pairs", "description"=>"Current and daily summary information combined into a single quote", "operationId"=>"ApiV{versionCurrenciesSummaryGet", "x-api-path-slug"=>"apivversioncurrenciessummary-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"pairs", "description"=>"comma separated list of currency pairs"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Latest", "Summaryrequested", "Currency", "Pairs"]}}, "/api/v{version}/Currencies/history"=>{"get"=>{"summary"=>"Get historical prices for requested currency pairs", "description"=>"Historical OHLC data for the specified period and interval size\r\n\r\nThe combination of the interval parameter and start and end dates can result in results\r\nbeing truncated to conform to result size limits. See comments on interval parameter for details on valid interval values.", "operationId"=>"ApiV{versionCurrenciesHistoryGet", "x-api-path-slug"=>"apivversioncurrencieshistory-get", "parameters"=>[{"in"=>"query", "name"=>"end", "description"=>"end date of time period"}, {"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"interval", "description"=>"aggregation interval"}, {"in"=>"query", "name"=>"pairs", "description"=>"comma separated list of currency pairs"}, {"in"=>"query", "name"=>"start", "description"=>"start date of time period"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Pricesrequested", "Currency", "Pairs"]}}, "/api/v{version}/Metals/supported/currency"=>{"get"=>{"summary"=>"Get list of currencies supported by metals endpoints for currency conversion", "description"=>"Get list of currencies supported by metals endpoints for currency conversion.", "operationId"=>"ApiV{versionMetalsSupportedCurrencyGet", "x-api-path-slug"=>"apivversionmetalssupportedcurrency-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Currencies", "Supported", "By", "Metals", "Endpointscurrency", "Conversion"]}}, "/api/v{version}/Metals/spot/supported"=>{"get"=>{"summary"=>"Get list of symbols supported by the spot endpoints", "description"=>"Get list of symbols supported by the spot endpoints.", "operationId"=>"ApiV{versionMetalsSpotSupportedGet", "x-api-path-slug"=>"apivversionmetalsspotsupported-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Symbols", "Supported", "By", "Spot", "Endpoints"]}}, "/api/v{version}/Metals/spot/summary"=>{"get"=>{"summary"=>"Get latest Spot Summary for requested metals", "description"=>"Current and daily summary information combined into a single quote", "operationId"=>"ApiV{versionMetalsSpotSummaryGet", "x-api-path-slug"=>"apivversionmetalsspotsummary-get", "parameters"=>[{"in"=>"query", "name"=>"adjust", "description"=>"apply global and per-tenant spot price adjustments"}, {"in"=>"query", "name"=>"currency", "description"=>"comma separated list of conversion currencies, defaults to USD"}, {"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"metals", "description"=>"comma separated list of metals"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"query", "name"=>"unitofmeasure", "description"=>"unit of meaure, defaults to troy ounces"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Latest", "Spot", "Summaryrequested", "Metals"]}}, "/api/v{version}/Metals/spot/history"=>{"get"=>{"summary"=>"Get historical Spot prices for requested metals", "description"=>"Historical OHLC data for the specified period and interval size\r\n\r\nThe combination of the interval parameter and start and end dates can result in results\r\nbeing truncated to conform to result size limits. See comments on interval parameter for details on valid interval values.\r\n\r\nThe historicalfx flag is used to determine whether to apply today's fx rates to a historical period, or to apply the historical rates from that same time frame.", "operationId"=>"ApiV{versionMetalsSpotHistoryGet", "x-api-path-slug"=>"apivversionmetalsspothistory-get", "parameters"=>[{"in"=>"query", "name"=>"currency", "description"=>"comma separated list of conversion currencies, defaults to USD"}, {"in"=>"query", "name"=>"end", "description"=>"end date of time period"}, {"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"historicalfx", "description"=>"if true use historical currency rates otherwise current currency rates"}, {"in"=>"query", "name"=>"interval", "description"=>"aggregation interval"}, {"in"=>"query", "name"=>"metals", "description"=>"comma separated list of metals"}, {"in"=>"query", "name"=>"start", "description"=>"start date of time period"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"query", "name"=>"unitofmeasure", "description"=>"unit of meaure, defaults to troy ounces"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Spot", "Pricesrequested", "Metals"]}}, "/api/v{version}/Metals/spot/ratio/summary"=>{"get"=>{"summary"=>"Get latest Spot Summary for requested metal ratios", "description"=>"Get latest spot summary for requested metal ratios.", "operationId"=>"ApiV{versionMetalsSpotRatioSummaryGet", "x-api-path-slug"=>"apivversionmetalsspotratiosummary-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"pairs", "description"=>"comma separated list of metal pairs"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Latest", "Spot", "Summaryrequested", "Metal", "Ratios"]}}, "/api/v{version}/Metals/spot/ratio/history"=>{"get"=>{"summary"=>"Get historical Spot Ratio prices for requested metals", "description"=>"Historical data for the specified period and interval size\r\n\r\nThe combination of the interval parameter and start and end dates can result in results\r\nbeing truncated to conform to result size limits. See comments on interval parameter for details on valid interval values.", "operationId"=>"ApiV{versionMetalsSpotRatioHistoryGet", "x-api-path-slug"=>"apivversionmetalsspotratiohistory-get", "parameters"=>[{"in"=>"query", "name"=>"end", "description"=>"end date of time period"}, {"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"interval", "description"=>"aggregation interval"}, {"in"=>"query", "name"=>"pairs", "description"=>"comma separated list of metals"}, {"in"=>"query", "name"=>"start", "description"=>"start date of time period"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Spot", "Ratio", "Pricesrequested", "Metals"]}}, "/api/v{version}/Metals/benchmark/supported"=>{"get"=>{"summary"=>"Get list of symbols supported by the benchmark endpoints", "description"=>"Get list of symbols supported by the benchmark endpoints.", "operationId"=>"ApiV{versionMetalsBenchmarkSupportedGet", "x-api-path-slug"=>"apivversionmetalsbenchmarksupported-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Symbols", "Supported", "By", "Benchmark", "Endpoints"]}}, "/api/v{version}/Metals/benchmark/summary"=>{"get"=>{"summary"=>"Get latest Benchmark prices for requested metals", "description"=>"Get latest benchmark prices for requested metals.", "operationId"=>"ApiV{versionMetalsBenchmarkSummaryGet", "x-api-path-slug"=>"apivversionmetalsbenchmarksummary-get", "parameters"=>[{"in"=>"query", "name"=>"currency", "description"=>"comma separated list of conversion currencies, defaults to USD"}, {"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"metals", "description"=>"comma separated list of metals"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"query", "name"=>"unitofmeasure", "description"=>"unit of meaure, defaults to troy ounces"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Latest", "Benchmark", "Pricesrequested", "Metals"]}}, "/api/v{version}/Metals/benchmark/history"=>{"get"=>{"summary"=>"Get historical benchmark prices for requested metals", "description"=>"Historical OHLC data for the specified period and interval size\r\n\r\nThe combination of the interval parameter and start and end dates can result in results\r\nbeing truncated to conform to result size limits. See comments on interval parameter for details on valid interval values.\r\n\r\nThe historicalfx flag is used to determine whether to apply today's fx rates to a historical period, or to apply the historical rates from that same time frame.", "operationId"=>"ApiV{versionMetalsBenchmarkHistoryGet", "x-api-path-slug"=>"apivversionmetalsbenchmarkhistory-get", "parameters"=>[{"in"=>"query", "name"=>"currency", "description"=>"comma separated list of conversion currencies, defaults to USD"}, {"in"=>"query", "name"=>"end", "description"=>"end date of time period"}, {"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"historicalfx", "description"=>"if true use historical currency rates otherwise current currency rates"}, {"in"=>"query", "name"=>"interval", "description"=>"aggregation interval"}, {"in"=>"query", "name"=>"metals", "description"=>"comma separated list of metals"}, {"in"=>"query", "name"=>"start", "description"=>"start date of time period"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"query", "name"=>"unitofmeasure", "description"=>"unit of meaure, defaults to troy ounces"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Benchmark", "Pricesrequested", "Metals"]}}, "/api/v{version}/Metals/spot/performance/annual"=>{"get"=>{"summary"=>"Get Historical Annual Performance for requested metals", "description"=>"Get historical annual performance for requested metals.", "operationId"=>"ApiV{versionMetalsSpotPerformanceAnnualGet", "x-api-path-slug"=>"apivversionmetalsspotperformanceannual-get", "parameters"=>[{"in"=>"query", "name"=>"currency", "description"=>"comma separated list of conversion currencies, defaults to USD"}, {"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"metals", "description"=>"comma separated list of metals"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"query", "name"=>"unitofmeasure", "description"=>"unit of meaure, defaults to troy ounces"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}, {"in"=>"query", "name"=>"years", "description"=>"Number of years of history to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Annual", "Performancerequested", "Metals"]}}, "/api/v{version}/Metals/spot/performance"=>{"get"=>{"summary"=>"Get Historical Performance for requested metals", "description"=>"Get historical performance for requested metals.", "operationId"=>"ApiV{versionMetalsSpotPerformanceGet", "x-api-path-slug"=>"apivversionmetalsspotperformance-get", "parameters"=>[{"in"=>"query", "name"=>"currency", "description"=>"comma separated list of conversion currencies, defaults to USD"}, {"in"=>"query", "name"=>"format", "description"=>"to override content negotiation specify a value of json or xml"}, {"in"=>"query", "name"=>"metals", "description"=>"comma separated list of metals"}, {"in"=>"query", "name"=>"token", "description"=>"auth token"}, {"in"=>"query", "name"=>"unitofmeasure", "description"=>"unit of meaure, defaults to troy ounces"}, {"in"=>"path", "name"=>"version", "description"=>"The requested API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Performancerequested", "Metals"]}}}}, "apis"=>{"name"=>"nFusion Solutions", "x-slug"=>"nfusion-solutions", "description"=>"nFusion Solutions ecosystem of products and solutions lets you power your apps, websites and software with precious metals market data directly from exchanges around the world. Built on the Azure Cloud platform, nFusion delivers a reliable and scalabl...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28883-nfusionsolutions-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"4970472", "tags"=>"Enterprise,Financial Services,General Data,Market Data,Metals,Relative Data,SaaS,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"nfusion-solutions/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"nFusion API", "x-api-slug"=>"nfusion-api", "description"=>"nFusion Solutions ecosystem of products and solutions lets you power your apps, websites and software with precious metals market data directly from exchanges around the world. Built on the Azure Cloud platform, nFusion delivers a reliable and scalabl...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28883-nfusionsolutions-com.jpg", "humanURL"=>"http://www.nfusionsolutions.com", "baseURL"=>"https://api.nfusionsolutions.biz//", "tags"=>"Enterprise,Financial Services,General Data,Market Data,Metals,Relative Data,SaaS,Service API,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/nfusion-solutions/apivversionmetalsspotperformance-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/nfusion-solutions/nfusion-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog-rss", "url"=>"https://nfusionsolutions.com/feed/"}, {"type"=>"x-documentation", "url"=>"https://api.nfusionsolutions.biz/api-docs/index.html"}, {"type"=>"x-openapi", "url"=>"https://api.nfusionsolutions.biz/swagger/1/swagger.json"}, {"type"=>"x-website", "url"=>"http://www.nfusionsolutions.com"}, {"type"=>"x-blog", "url"=>"https://nfusionsolutions.com/metals-blog/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/nfusionsolution"}, {"type"=>"x-website", "url"=>"https://nfusionsolutions.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
amee{"amee-company-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AMEE", "x-complete"=>1, "info"=>{"title"=>"AMEE Company API", "description"=>"the-amee-company-api-", "version"=>"1.0"}, "host"=>"api.roaring.io", "basePath"=>"/company/1.0", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/company-board-members"=>{"get"=>{"summary"=>"Get Company Board Members", "description"=>"Get company board members.", "operationId"=>"getCompanyBoardMembers", "x-api-path-slug"=>"companyboardmembers-get", "parameters"=>[{"in"=>"query", "name"=>"companyId", "description"=>"Company identification for the company"}, {"in"=>"query", "name"=>"countryCode", "description"=>"Country code for the company"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Board", "Members"]}, "post"=>{"summary"=>"Post Company Board Members", "description"=>"Post company board members.", "operationId"=>"postCompanyBoardMembers", "x-api-path-slug"=>"companyboardmembers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Request body with company identifiers to lookup", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"countryCode", "description"=>"Country code for the company"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Board", "Members"]}}, "/company-credit-decision"=>{"get"=>{"summary"=>"Get Company Credit Decision", "description"=>"Get company credit decision.", "operationId"=>"getCompanyCreditDecision", "x-api-path-slug"=>"companycreditdecision-get", "parameters"=>[{"in"=>"query", "name"=>"companyId", "description"=>"Company identification for the company"}, {"in"=>"query", "name"=>"countryCode", "description"=>"Country code for the company"}, {"in"=>"query", "name"=>"template", "description"=>"Template for credit decision"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Credit", "Decision"]}}, "/company-economy-overview"=>{"get"=>{"summary"=>"Get Company Economy Overview", "description"=>"Get company economy overview.", "operationId"=>"getCompanyEconomyOverview", "x-api-path-slug"=>"companyeconomyoverview-get", "parameters"=>[{"in"=>"query", "name"=>"companyId", "description"=>"Company identification for the company"}, {"in"=>"query", "name"=>"countryCode", "description"=>"Country code for the company"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Economy", "Overview"]}, "post"=>{"summary"=>"Post Company Economy Overview", "description"=>"Post company economy overview.", "operationId"=>"postCompanyEconomyOverview", "x-api-path-slug"=>"companyeconomyoverview-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Request body with company identifiers to lookup", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"countryCode", "description"=>"Country code for the company"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Economy", "Overview"]}}, "/company-event"=>{"post"=>{"summary"=>"Post Company Event", "description"=>"Post company event.", "operationId"=>"postCompanyEvent", "x-api-path-slug"=>"companyevent-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Request body with company identifiers to lookup", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"countryCode", "description"=>"Country code for the company"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Event"]}}, "/company-overview"=>{"get"=>{"summary"=>"Get Company Overview", "description"=>"Get company overview.", "operationId"=>"getCompanyOverview", "x-api-path-slug"=>"companyoverview-get", "parameters"=>[{"in"=>"query", "name"=>"companyId", "description"=>"Company identification for the company"}, {"in"=>"query", "name"=>"countryCode", "description"=>"Country code for the company"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Overview"]}, "post"=>{"summary"=>"Post Company Overview", "description"=>"Post company overview.", "operationId"=>"postCompanyOverview", "x-api-path-slug"=>"companyoverview-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Request body with company identifiers to lookup", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"countryCode", "description"=>"Country code for the company"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Overview"]}}, "/company-signatory"=>{"get"=>{"summary"=>"Get Company Signatory", "description"=>"Get company signatory.", "operationId"=>"getCompanySignatory", "x-api-path-slug"=>"companysignatory-get", "parameters"=>[{"in"=>"query", "name"=>"companyId", "description"=>"Company identification for the company"}, {"in"=>"query", "name"=>"countryCode", "description"=>"Country code for the company"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Signatory"]}, "post"=>{"summary"=>"Post Company Signatory", "description"=>"Post company signatory.", "operationId"=>"postCompanySignatory", "x-api-path-slug"=>"companysignatory-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Request body with company identifiers to lookup", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"countryCode", "description"=>"Country code for the company"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Signatory"]}}, "/company-simple-search"=>{"get"=>{"summary"=>"Get Company Simple Search", "description"=>"Get company simple search.", "operationId"=>"getCompanySimpleSearch", "x-api-path-slug"=>"companysimplesearch-get", "parameters"=>[{"in"=>"query", "name"=>"companyName", "description"=>"Company name"}, {"in"=>"query", "name"=>"countryCode", "description"=>"Country code for the company"}, {"in"=>"query", "name"=>"town", "description"=>"Town"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Simple", "Search"]}}}}, "apis"=>{"name"=>"AMEE", "x-slug"=>"amee", "description"=>"Data driven solutions to strengthen supply chain performance and risk.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/335-amee-developers.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"4769400", "tags"=>"API Provider,Business,Carbon,Cleantech,Cleanweb,Climate,Enterprise,Environment,General Data,Profiles,SaaS,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"amee/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AMEE Company API", "x-api-slug"=>"amee-company-api", "description"=>"Data driven solutions to strengthen supply chain performance and risk.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/335-amee-developers.jpg", "humanURL"=>"https://www.amee.com", "baseURL"=>"https://api.roaring.io//company/1.0", "tags"=>"API Provider,Business,Carbon,Cleantech,Cleanweb,Climate,Enterprise,Environment,General Data,Profiles,SaaS,Stack Network,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/amee/amee-company-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://www.amee.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.amee.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/amee"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/amee"}, {"type"=>"x-developer", "url"=>"https://www.amee.com/api"}, {"type"=>"x-github", "url"=>"https://github.com/AMEE"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/ameedev"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/ameeHQ"}, {"type"=>"x-website", "url"=>"https://www.amee.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-service-management{"google-service-management-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Service Management", "x-complete"=>1, "info"=>{"title"=>"Google Service Management", "description"=>"google-service-management-allows-service-producers-to-publish-their-services-on-google-cloud-platform-so-that-they-can-be-discovered-and-used-by-service-consumers-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"servicemanagement.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/services"=>{"get"=>{"summary"=>"Get Services", "description"=>"Lists managed services.\n\nReturns all public services. For authenticated users, also returns all\nservices the calling user has \"servicemanagement.services.get\" permission\nfor.\n\n**BETA:** If the caller specifies the `consumer_id`, it returns only the\nservices enabled on the consumer. The `consumer_id` must have the format\nof \"project:{PROJECT-ID}\".", "operationId"=>"servicemanagement.services.list", "x-api-path-slug"=>"v1services-get", "parameters"=>[{"in"=>"query", "name"=>"consumerId", "description"=>"Include services consumed by the specified consumer"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Requested size of the next page of data"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token identifying which result to start with; returned by a previous listcall"}, {"in"=>"query", "name"=>"producerProjectId", "description"=>"Include services produced by the specified project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service"]}, "post"=>{"summary"=>"Create Service", "description"=>"Creates a new managed service.\nPlease note one producer project can own no more than 20 services.\n\nOperation |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-speech{"google-cloud-speech-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Speech", "x-complete"=>1, "info"=>{"title"=>"Google Cloud Speech", "description"=>"google-cloud-speech-api-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1beta1"}, "host"=>"speech.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1beta1/operations"=>{"get"=>{"summary"=>"Get Operations", "description"=>"Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.", "operationId"=>"speech.operations.list", "x-api-path-slug"=>"v1beta1operations-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"The standard list filter"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the operation collection"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The standard list page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The standard list page token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1beta1/operations/{name}"=>{"delete"=>{"summary"=>"Delete Operation", "description"=>"Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", "operationId"=>"speech.operations.delete", "x-api-path-slug"=>"v1beta1operationsname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the operation resource to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}, "get"=>{"summary"=>"Delete Operation", "description"=>"Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", "operationId"=>"speech.operations.get", "x-api-path-slug"=>"v1beta1operationsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the operation resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1beta1/operations/{name}:cancel"=>{"post"=>{"summary"=>"Cancel Operation", "description"=>"Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", "operationId"=>"speech.operations.cancel", "x-api-path-slug"=>"v1beta1operationsnamecancel-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the operation resource to be cancelled"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1beta1/speech:asyncrecognize"=>{"post"=>{"summary"=>"Perform Asynchronous Speech Recognition", "description"=>"Performs asynchronous speech recognition: receive results via the\n[google.longrunning.Operations]\n(/speech/reference/rest/v1beta1/operations#Operation)\ninterface. Returns either an\n`Operation.error` or an `Operation.response` which contains\nan `AsyncRecognizeResponse` message.", "operationId"=>"speech.speech.asyncrecognize", "x-api-path-slug"=>"v1beta1speechasyncrecognize-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Speech Recognition"]}}, "/v1beta1/speech:syncrecognize"=>{"post"=>{"summary"=>"Perform Synchronous Speech Recognition", "description"=>"Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.", "operationId"=>"speech.speech.syncrecognize", "x-api-path-slug"=>"v1beta1speechsyncrecognize-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Speech Recognition"]}}}}, "apis"=>{"name"=>"Google Speech", "x-slug"=>"google-speech", "description"=>"Google Cloud Speech API enables developers to convert audio to text by applying powerful neural network models in an easy to use API. The API recognizes over 80 languages and variants, to support your global user base. You can transcribe the text of users dictating to an application’s microphone, enable command-and-control through voice, or transcribe audio files, among many other use cases. Recognize audio uploaded in the request, and integrate with your audio storage on Google Cloud Storage, by using the same technology Google uses to power its own products.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/speech-api-lead_2x.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Machine Learning,Profiles,Relative Data,Service API,Speech Recognition,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-speech/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Speech API", "x-api-slug"=>"google-cloud-speech-api", "description"=>"Google Cloud Speech API enables developers to convert audio to text by applying powerful neural network models in an easy to use API. The API recognizes over 80 languages and variants, to support your global user base. You can transcribe the text of users dictating to an application’s microphone, enable command-and-control through voice, or transcribe audio files, among many other use cases. Recognize audio uploaded in the request, and integrate with your audio storage on Google Cloud Storage, by using the same technology Google uses to power its own products.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/speech-api-lead_2x.png", "humanURL"=>"https://cloud.google.com/speech/", "baseURL"=>"://speech.googleapis.com//", "tags"=>"API Provider,API Service Provider,Google APIs,Machine Learning,Profiles,Relative Data,Service API,Speech Recognition,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-speech/google-cloud-speech-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-code", "url"=>"https://cloud.google.com/speech/docs/reference/libraries"}, {"type"=>"x-concepts", "url"=>"https://cloud.google.com/speech/docs/best-practices"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/speech/docs/"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/speech/docs/getting-started"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/speech/docs/common/auth"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/speech/pricing"}, {"type"=>"x-rate-limits", "url"=>"https://cloud.google.com/speech/limits"}, {"type"=>"x-samples", "url"=>"https://cloud.google.com/speech/docs/samples"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/speech/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
trello{"trello-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Trello", "x-complete"=>1, "info"=>{"title"=>"Trello", "description"=>"this-document-describes-the-rest-api-of-trello-as-published-by-trello-com---a-hrefhttpstrello-comdocsindex-html-target-blankofficial-documentationa--a-hrefhttpstrello-comdocsapi-target-blankthe-html-pages-that-were-scraped-in-order-to-generate-this-specification-a", "termsOfService"=>"https://trello.com/legal", "contact"=>{"name"=>"Trello", "url"=>"https://trello.com/home"}, "version"=>"1.0"}, "host"=>"trello.com", "basePath"=>"/1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/actions/{idAction}"=>{"delete"=>{"summary"=>"Delete Actions", "description"=>"Delete actions.", "operationId"=>"deleteActionsByIdAction", "x-api-path-slug"=>"actionsidaction-delete", "parameters"=>[{"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{2=>{"description"=>"Successful response"}, 200=>{"description"=>"OK"}}, "tags"=>["Actions"]}, "get"=>{"summary"=>"Get Actions", "description"=>"Get actions.", "operationId"=>"getActionsByIdAction", "x-api-path-slug"=>"actionsidaction-get", "parameters"=>[{"in"=>"query", "name"=>"display", "description"=>"true or false"}, {"in"=>"query", "name"=>"entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator or type"}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"member", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberCreator", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberCreator_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions"]}, "put"=>{"summary"=>"Put Actions", "description"=>"Put actions.", "operationId"=>"updateActionsByIdAction", "x-api-path-slug"=>"actionsidaction-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Actions to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions"]}}, "/actions/{idAction}/board"=>{"get"=>{"summary"=>"Get Actions Board", "description"=>"Get actions board.", "operationId"=>"getActionsBoardByIdAction", "x-api-path-slug"=>"actionsidactionboard-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "Board"]}}, "/actions/{idAction}/board/{field}"=>{"get"=>{"summary"=>"Get Actions Board Field", "description"=>"Get actions board field.", "operationId"=>"getActionsBoardByIdActionByField", "x-api-path-slug"=>"actionsidactionboardfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "Board", "Field"]}}, "/actions/{idAction}/card"=>{"get"=>{"summary"=>"Get Actions Card", "description"=>"Get actions card.", "operationId"=>"getActionsCardByIdAction", "x-api-path-slug"=>"actionsidactioncard-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "Card"]}}, "/actions/{idAction}/card/{field}"=>{"get"=>{"summary"=>"Get Actions Card Field", "description"=>"Get actions card field.", "operationId"=>"getActionsCardByIdActionByField", "x-api-path-slug"=>"actionsidactioncardfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "Card", "Field"]}}, "/actions/{idAction}/display"=>{"get"=>{"summary"=>"Get Actions Display", "description"=>"Get actions display.", "operationId"=>"getActionsDisplayByIdAction", "x-api-path-slug"=>"actionsidactiondisplay-get", "parameters"=>[{"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "Display"]}}, "/actions/{idAction}/entities"=>{"get"=>{"summary"=>"Get Actions Entities", "description"=>"Get actions entities.", "operationId"=>"getActionsEntitiesByIdAction", "x-api-path-slug"=>"actionsidactionentities-get", "parameters"=>[{"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "Entities"]}}, "/actions/{idAction}/list"=>{"get"=>{"summary"=>"Get Actions List", "description"=>"Get actions list.", "operationId"=>"getActionsListByIdAction", "x-api-path-slug"=>"actionsidactionlist-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: closed, idBoard, name, pos or subscribed"}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "List"]}}, "/actions/{idAction}/list/{field}"=>{"get"=>{"summary"=>"Get Actions List Field", "description"=>"Get actions list field.", "operationId"=>"getActionsListByIdActionByField", "x-api-path-slug"=>"actionsidactionlistfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "List", "Field"]}}, "/actions/{idAction}/member"=>{"get"=>{"summary"=>"Get Actions Member", "description"=>"Get actions member.", "operationId"=>"getActionsMemberByIdAction", "x-api-path-slug"=>"actionsidactionmember-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username"}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "Member"]}}, "/actions/{idAction}/member/{field}"=>{"get"=>{"summary"=>"Get Actions Member Field", "description"=>"Get actions member field.", "operationId"=>"getActionsMemberByIdActionByField", "x-api-path-slug"=>"actionsidactionmemberfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "Member", "Field"]}}, "/actions/{idAction}/memberCreator"=>{"get"=>{"summary"=>"Get Actions Member Creator", "description"=>"Get actions member creator.", "operationId"=>"getActionsMemberCreatorByIdAction", "x-api-path-slug"=>"actionsidactionmembercreator-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username"}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "Member", "Creator"]}}, "/actions/{idAction}/memberCreator/{field}"=>{"get"=>{"summary"=>"Get Actions Member Creator Field", "description"=>"Get actions member creator field.", "operationId"=>"getActionsMemberCreatorByIdActionByField", "x-api-path-slug"=>"actionsidactionmembercreatorfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "Member", "Creator", "Field"]}}, "/actions/{idAction}/organization"=>{"get"=>{"summary"=>"Get Actions Organization", "description"=>"Get actions organization.", "operationId"=>"getActionsOrganizationByIdAction", "x-api-path-slug"=>"actionsidactionorganization-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website"}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "Organization"]}}, "/actions/{idAction}/organization/{field}"=>{"get"=>{"summary"=>"Get Actions Organization Field", "description"=>"Get actions organization field.", "operationId"=>"getActionsOrganizationByIdActionByField", "x-api-path-slug"=>"actionsidactionorganizationfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "Organization", "Field"]}}, "/actions/{idAction}/text"=>{"put"=>{"summary"=>"Put Actions Text", "description"=>"Put actions text.", "operationId"=>"updateActionsTextByIdAction", "x-api-path-slug"=>"actionsidactiontext-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Actions Text to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "Text"]}}, "/actions/{idAction}/{field}"=>{"get"=>{"summary"=>"Get Actions Field", "description"=>"Get actions field.", "operationId"=>"getActionsByIdActionByField", "x-api-path-slug"=>"actionsidactionfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "Field"]}}, "/batch"=>{"get"=>{"summary"=>"Get Batch", "description"=>"Get batch.", "operationId"=>"getBatch", "x-api-path-slug"=>"batch-get", "parameters"=>[{"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}, {"in"=>"query", "name"=>"urls", "description"=>"list of API v1 GET routes, not including the version prefix"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Batch"]}}, "/boards"=>{"post"=>{"summary"=>"Post Boards", "description"=>"Post boards.", "operationId"=>"addBoards", "x-api-path-slug"=>"boards-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Boards to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards"]}}, "/boards/{idBoard}"=>{"get"=>{"summary"=>"Get Boards", "description"=>"Get boards.", "operationId"=>"getBoardsByIdBoard", "x-api-path-slug"=>"boardsidboard-get", "parameters"=>[{"in"=>"query", "name"=>"actions", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"actions_display", "description"=>"true or false"}, {"in"=>"query", "name"=>"actions_entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"actions_format", "description"=>"One of: count, list or minimal"}, {"in"=>"query", "name"=>"actions_limit", "description"=>"a number from 0 to 1000"}, {"in"=>"query", "name"=>"actions_since", "description"=>"A date, null or lastView"}, {"in"=>"query", "name"=>"action_fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator or type"}, {"in"=>"query", "name"=>"action_member", "description"=>"true or false"}, {"in"=>"query", "name"=>"action_memberCreator", "description"=>"true or false"}, {"in"=>"query", "name"=>"action_memberCreator_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"action_member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"boardStars", "description"=>"One of: mine or none"}, {"in"=>"query", "name"=>"cards", "description"=>"One of: all, closed, none, open or visible"}, {"in"=>"query", "name"=>"card_attachments", "description"=>"A boolean value or "cover" for only card cover attachments"}, {"in"=>"query", "name"=>"card_attachment_fields", "description"=>"all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url"}, {"in"=>"query", "name"=>"card_checklists", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"card_fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"query", "name"=>"card_stickers", "description"=>"true or false"}, {"in"=>"query", "name"=>"checklists", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"checklist_fields", "description"=>"all or a comma-separated list of: idBoard, idCard, name or pos"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"labels", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"labels_limit", "description"=>"a number from 0 to 1000"}, {"in"=>"query", "name"=>"label_fields", "description"=>"all or a comma-separated list of: color, idBoard, name or uses"}, {"in"=>"query", "name"=>"lists", "description"=>"One of: all, closed, none or open"}, {"in"=>"query", "name"=>"list_fields", "description"=>"all or a comma-separated list of: closed, idBoard, name, pos or subscribed"}, {"in"=>"query", "name"=>"members", "description"=>"One of: admins, all, none, normal or owners"}, {"in"=>"query", "name"=>"memberships", "description"=>"all or a comma-separated list of: active, admin, deactivated, me or normal"}, {"in"=>"query", "name"=>"memberships_member", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberships_member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"membersInvited", "description"=>"One of: admins, all, none, normal or owners"}, {"in"=>"query", "name"=>"membersInvited_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"myPrefs", "description"=>"true or false"}, {"in"=>"query", "name"=>"organization", "description"=>"true or false"}, {"in"=>"query", "name"=>"organization_fields", "description"=>"all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website"}, {"in"=>"query", "name"=>"organization_memberships", "description"=>"all or a comma-separated list of: active, admin, deactivated, me or normal"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards"]}, "put"=>{"summary"=>"Put Boards", "description"=>"Put boards.", "operationId"=>"updateBoardsByIdBoard", "x-api-path-slug"=>"boardsidboard-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Boards to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards"]}}, "/boards/{idBoard}/actions"=>{"get"=>{"summary"=>"Get Boards Actions", "description"=>"Get boards actions.", "operationId"=>"getBoardsActionsByIdBoard", "x-api-path-slug"=>"boardsidboardactions-get", "parameters"=>[{"in"=>"query", "name"=>"before", "description"=>"A date, or null"}, {"in"=>"query", "name"=>"display", "description"=>"true or false"}, {"in"=>"query", "name"=>"entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator or type"}, {"in"=>"query", "name"=>"filter", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"format", "description"=>"One of: count, list or minimal"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"idModels", "description"=>"Only return actions related to these model ids"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"limit", "description"=>"a number from 0 to 1000"}, {"in"=>"query", "name"=>"member", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberCreator", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberCreator_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"page", "description"=>"Page * limit must be less than 1000"}, {"in"=>"query", "name"=>"since", "description"=>"A date, null or lastView"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Actions"]}}, "/boards/{idBoard}/boardStars"=>{"get"=>{"summary"=>"Get Boards Boardstars", "description"=>"Get boards boardstars.", "operationId"=>"getBoardsBoardStarsByIdBoard", "x-api-path-slug"=>"boardsidboardboardstars-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"One of: mine or none"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Boardstars"]}}, "/boards/{idBoard}/calendarKey/generate"=>{"post"=>{"summary"=>"Post Boards Calendarkey Generate", "description"=>"Post boards calendarkey generate.", "operationId"=>"addBoardsCalendarKeyGenerateByIdBoard", "x-api-path-slug"=>"boardsidboardcalendarkeygenerate-post", "parameters"=>[{"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Calendarkey", "Generate"]}}, "/boards/{idBoard}/cards"=>{"get"=>{"summary"=>"Get Boards Cards", "description"=>"Get boards cards.", "operationId"=>"getBoardsCardsByIdBoard", "x-api-path-slug"=>"boardsidboardcards-get", "parameters"=>[{"in"=>"query", "name"=>"actions", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"attachments", "description"=>"A boolean value or "cover" for only card cover attachments"}, {"in"=>"query", "name"=>"attachment_fields", "description"=>"all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url"}, {"in"=>"query", "name"=>"before", "description"=>"A date, or null"}, {"in"=>"query", "name"=>"checkItemStates", "description"=>"true or false"}, {"in"=>"query", "name"=>"checklists", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"query", "name"=>"filter", "description"=>"One of: all, closed, none, open or visible"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"limit", "description"=>"a number from 1 to 1000"}, {"in"=>"query", "name"=>"members", "description"=>"true or false"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"since", "description"=>"A date, or null"}, {"in"=>"query", "name"=>"stickers", "description"=>"true or false"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Cards"]}}, "/boards/{idBoard}/cards/{filter}"=>{"get"=>{"summary"=>"Get Boards Cards Filter", "description"=>"Get boards cards filter.", "operationId"=>"getBoardsCardsByIdBoardByFilter", "x-api-path-slug"=>"boardsidboardcardsfilter-get", "parameters"=>[{"in"=>"path", "name"=>"filter", "description"=>"filter"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Cards", "Filter"]}}, "/boards/{idBoard}/cards/{idCard}"=>{"get"=>{"summary"=>"Get Boards Cards", "description"=>"Get boards cards.", "operationId"=>"getBoardsCardsByIdBoardByIdCard", "x-api-path-slug"=>"boardsidboardcardsidcard-get", "parameters"=>[{"in"=>"query", "name"=>"actions", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"actions_display", "description"=>"true or false"}, {"in"=>"query", "name"=>"actions_entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"actions_limit", "description"=>"a number from 0 to 1000"}, {"in"=>"query", "name"=>"action_fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator or type"}, {"in"=>"query", "name"=>"action_memberCreator_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"attachments", "description"=>"A boolean value or "cover" for only card cover attachments"}, {"in"=>"query", "name"=>"attachment_fields", "description"=>"all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url"}, {"in"=>"query", "name"=>"checkItemStates", "description"=>"true or false"}, {"in"=>"query", "name"=>"checkItemState_fields", "description"=>"all or a comma-separated list of: idCheckItem or state"}, {"in"=>"query", "name"=>"checklists", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"checklist_fields", "description"=>"all or a comma-separated list of: idBoard, idCard, name or pos"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"path", "name"=>"idCard", "description"=>"idCard"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"labels", "description"=>"true or false"}, {"in"=>"query", "name"=>"members", "description"=>"true or false"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Cards"]}}, "/boards/{idBoard}/checklists"=>{"get"=>{"summary"=>"Get Boards Checklists", "description"=>"Get boards checklists.", "operationId"=>"getBoardsChecklistsByIdBoard", "x-api-path-slug"=>"boardsidboardchecklists-get", "parameters"=>[{"in"=>"query", "name"=>"cards", "description"=>"One of: all, closed, none, open or visible"}, {"in"=>"query", "name"=>"card_fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"query", "name"=>"checkItems", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"checkItem_fields", "description"=>"all or a comma-separated list of: name, nameData, pos, state or type"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: idBoard, idCard, name or pos"}, {"in"=>"query", "name"=>"filter", "description"=>"One of: all or none"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Checklists"]}, "post"=>{"summary"=>"Post Boards Checklists", "description"=>"Post boards checklists.", "operationId"=>"addBoardsChecklistsByIdBoard", "x-api-path-slug"=>"boardsidboardchecklists-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Boards Checklists to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Checklists"]}}, "/boards/{idBoard}/closed"=>{"put"=>{"summary"=>"Put Boards Closed", "description"=>"Put boards closed.", "operationId"=>"updateBoardsClosedByIdBoard", "x-api-path-slug"=>"boardsidboardclosed-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Boards Closed to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Closed"]}}, "/boards/{idBoard}/deltas"=>{"get"=>{"summary"=>"Get Boards Deltas", "description"=>"Get boards deltas.", "operationId"=>"getBoardsDeltasByIdBoard", "x-api-path-slug"=>"boardsidboarddeltas-get", "parameters"=>[{"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"ixLastUpdate", "description"=>"a number from -1 to Infinity"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"tags", "description"=>"A valid tag for subscribing"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Deltas"]}}, "/boards/{idBoard}/desc"=>{"put"=>{"summary"=>"Put Boards Desc", "description"=>"Put boards desc.", "operationId"=>"updateBoardsDescByIdBoard", "x-api-path-slug"=>"boardsidboarddesc-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Boards Desc to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Desc"]}}, "/boards/{idBoard}/emailKey/generate"=>{"post"=>{"summary"=>"Post Boards Emailkey Generate", "description"=>"Post boards emailkey generate.", "operationId"=>"addBoardsEmailKeyGenerateByIdBoard", "x-api-path-slug"=>"boardsidboardemailkeygenerate-post", "parameters"=>[{"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Emailkey", "Generate"]}}, "/boards/{idBoard}/idOrganization"=>{"put"=>{"summary"=>"Put Boards Organization", "description"=>"Put boards organization.", "operationId"=>"updateBoardsIdOrganizationByIdBoard", "x-api-path-slug"=>"boardsidboardidorganization-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Boards Id Organization to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Organization"]}}, "/boards/{idBoard}/labelNames/blue"=>{"put"=>{"summary"=>"Put Boards Label Names Blue", "description"=>"Put boards label names blue.", "operationId"=>"updateBoardsLabelNamesBlueByIdBoard", "x-api-path-slug"=>"boardsidboardlabelnamesblue-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Label Names Blue to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Label", "Names", "Blue"]}}, "/boards/{idBoard}/labelNames/green"=>{"put"=>{"summary"=>"Put Boards Label Names Green", "description"=>"Put boards label names green.", "operationId"=>"updateBoardsLabelNamesGreenByIdBoard", "x-api-path-slug"=>"boardsidboardlabelnamesgreen-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Label Names Green to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Label", "Names", "Green"]}}, "/boards/{idBoard}/labelNames/orange"=>{"put"=>{"summary"=>"Put Boards Label Names Orange", "description"=>"Put boards label names orange.", "operationId"=>"updateBoardsLabelNamesOrangeByIdBoard", "x-api-path-slug"=>"boardsidboardlabelnamesorange-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Label Names Orange to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Label", "Names", "Orange"]}}, "/boards/{idBoard}/labelNames/purple"=>{"put"=>{"summary"=>"Put Boards Label Names Purple", "description"=>"Put boards label names purple.", "operationId"=>"updateBoardsLabelNamesPurpleByIdBoard", "x-api-path-slug"=>"boardsidboardlabelnamespurple-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Label Names Purple to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Label", "Names", "Purple"]}}, "/boards/{idBoard}/labelNames/red"=>{"put"=>{"summary"=>"Put Boards Label Names Red", "description"=>"Put boards label names red.", "operationId"=>"updateBoardsLabelNamesRedByIdBoard", "x-api-path-slug"=>"boardsidboardlabelnamesred-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Label Names Red to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Label", "Names", "Red"]}}, "/boards/{idBoard}/labelNames/yellow"=>{"put"=>{"summary"=>"Put Boards Label Names Yellow", "description"=>"Put boards label names yellow.", "operationId"=>"updateBoardsLabelNamesYellowByIdBoard", "x-api-path-slug"=>"boardsidboardlabelnamesyellow-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Label Names Yellow to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Label", "Names", "Yellow"]}}, "/boards/{idBoard}/labels"=>{"get"=>{"summary"=>"Get Boards Labels", "description"=>"Get boards labels.", "operationId"=>"getBoardsLabelsByIdBoard", "x-api-path-slug"=>"boardsidboardlabels-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: color, idBoard, name or uses"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"limit", "description"=>"a number from 0 to 1000"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Labels"]}, "post"=>{"summary"=>"Post Boards Labels", "description"=>"Post boards labels.", "operationId"=>"addBoardsLabelsByIdBoard", "x-api-path-slug"=>"boardsidboardlabels-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Boards Labels to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Labels"]}}, "/boards/{idBoard}/labels/{idLabel}"=>{"get"=>{"summary"=>"Get Boards Labels Label", "description"=>"Get boards labels label.", "operationId"=>"getBoardsLabelsByIdBoardByIdLabel", "x-api-path-slug"=>"boardsidboardlabelsidlabel-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: color, idBoard, name or uses"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"path", "name"=>"idLabel", "description"=>"idLabel"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Labels", "Label"]}}, "/boards/{idBoard}/lists"=>{"get"=>{"summary"=>"Get Boards Lists", "description"=>"Get boards lists.", "operationId"=>"getBoardsListsByIdBoard", "x-api-path-slug"=>"boardsidboardlists-get", "parameters"=>[{"in"=>"query", "name"=>"cards", "description"=>"One of: all, closed, none, open or visible"}, {"in"=>"query", "name"=>"card_fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: closed, idBoard, name, pos or subscribed"}, {"in"=>"query", "name"=>"filter", "description"=>"One of: all, closed, none or open"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Lists"]}, "post"=>{"summary"=>"Post Boards Lists", "description"=>"Post boards lists.", "operationId"=>"addBoardsListsByIdBoard", "x-api-path-slug"=>"boardsidboardlists-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Boards Lists to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Lists"]}}, "/boards/{idBoard}/lists/{filter}"=>{"get"=>{"summary"=>"Get Boards Lists Filter", "description"=>"Get boards lists filter.", "operationId"=>"getBoardsListsByIdBoardByFilter", "x-api-path-slug"=>"boardsidboardlistsfilter-get", "parameters"=>[{"in"=>"path", "name"=>"filter", "description"=>"filter"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Lists", "Filter"]}}, "/boards/{idBoard}/markAsViewed"=>{"post"=>{"summary"=>"Post Boards Markasviewed", "description"=>"Post boards markasviewed.", "operationId"=>"addBoardsMarkAsViewedByIdBoard", "x-api-path-slug"=>"boardsidboardmarkasviewed-post", "parameters"=>[{"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Markasviewed"]}}, "/boards/{idBoard}/members"=>{"get"=>{"summary"=>"Get Boards Members", "description"=>"Get boards members.", "operationId"=>"getBoardsMembersByIdBoard", "x-api-path-slug"=>"boardsidboardmembers-get", "parameters"=>[{"in"=>"query", "name"=>"activity", "description"=>"true or false ; works for premium organizations only"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"filter", "description"=>"One of: admins, all, none, normal or owners"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Members"]}, "put"=>{"summary"=>"Put Boards Members", "description"=>"Put boards members.", "operationId"=>"updateBoardsMembersByIdBoard", "x-api-path-slug"=>"boardsidboardmembers-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Boards Members to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Members"]}}, "/boards/{idBoard}/members/{filter}"=>{"get"=>{"summary"=>"Get Boards Members Filter", "description"=>"Get boards members filter.", "operationId"=>"getBoardsMembersByIdBoardByFilter", "x-api-path-slug"=>"boardsidboardmembersfilter-get", "parameters"=>[{"in"=>"path", "name"=>"filter", "description"=>"filter"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Members", "Filter"]}}, "/boards/{idBoard}/members/{idMember}"=>{"delete"=>{"summary"=>"Delete Boards Members", "description"=>"Delete boards members.", "operationId"=>"deleteBoardsMembersByIdBoardByIdMember", "x-api-path-slug"=>"boardsidboardmembersidmember-delete", "parameters"=>[{"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Members"]}, "put"=>{"summary"=>"Put Boards Members", "description"=>"Put boards members.", "operationId"=>"updateBoardsMembersByIdBoardByIdMember", "x-api-path-slug"=>"boardsidboardmembersidmember-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Boards Members to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Members"]}}, "/boards/{idBoard}/members/{idMember}/cards"=>{"get"=>{"summary"=>"Get Boards Members Cards", "description"=>"Get boards members cards.", "operationId"=>"getBoardsMembersCardsByIdBoardByIdMember", "x-api-path-slug"=>"boardsidboardmembersidmembercards-get", "parameters"=>[{"in"=>"query", "name"=>"actions", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"attachments", "description"=>"A boolean value or "cover" for only card cover attachments"}, {"in"=>"query", "name"=>"attachment_fields", "description"=>"all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url"}, {"in"=>"query", "name"=>"board", "description"=>"true or false"}, {"in"=>"query", "name"=>"board_fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"query", "name"=>"checkItemStates", "description"=>"true or false"}, {"in"=>"query", "name"=>"checklists", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"query", "name"=>"filter", "description"=>"One of: all, closed, none, open or visible"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"list", "description"=>"true or false"}, {"in"=>"query", "name"=>"list_fields", "description"=>"all or a comma-separated list of: closed, idBoard, name, pos or subscribed"}, {"in"=>"query", "name"=>"members", "description"=>"true or false"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Members", "Cards"]}}, "/boards/{idBoard}/membersInvited"=>{"get"=>{"summary"=>"Get Boards Membersinvited", "description"=>"Get boards membersinvited.", "operationId"=>"getBoardsMembersInvitedByIdBoard", "x-api-path-slug"=>"boardsidboardmembersinvited-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Membersinvited"]}}, "/boards/{idBoard}/membersInvited/{field}"=>{"get"=>{"summary"=>"Get Boards Membersinvited Field", "description"=>"Get boards membersinvited field.", "operationId"=>"getBoardsMembersInvitedByIdBoardByField", "x-api-path-slug"=>"boardsidboardmembersinvitedfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Membersinvited", "Field"]}}, "/boards/{idBoard}/memberships"=>{"get"=>{"summary"=>"Get Boards Memberships", "description"=>"Get boards memberships.", "operationId"=>"getBoardsMembershipsByIdBoard", "x-api-path-slug"=>"boardsidboardmemberships-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"all or a comma-separated list of: active, admin, deactivated, me or normal"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"member", "description"=>"true or false"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Memberships"]}}, "/boards/{idBoard}/memberships/{idMembership}"=>{"get"=>{"summary"=>"Get Boards Memberships", "description"=>"Get boards memberships.", "operationId"=>"getBoardsMembershipsByIdBoardByIdMembership", "x-api-path-slug"=>"boardsidboardmembershipsidmembership-get", "parameters"=>[{"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"path", "name"=>"idMembership", "description"=>"idMembership"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"member", "description"=>"true or false"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Memberships"]}, "put"=>{"summary"=>"Put Boards Memberships", "description"=>"Put boards memberships.", "operationId"=>"updateBoardsMembershipsByIdBoardByIdMembership", "x-api-path-slug"=>"boardsidboardmembershipsidmembership-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Boards Memberships to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"path", "name"=>"idMembership", "description"=>"idMembership"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Memberships"]}}, "/boards/{idBoard}/myPrefs"=>{"get"=>{"summary"=>"Get Boards My Preferences", "description"=>"Get boards my preferences.", "operationId"=>"getBoardsMyPrefsByIdBoard", "x-api-path-slug"=>"boardsidboardmyprefs-get", "parameters"=>[{"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "My", "Preferences"]}}, "/boards/{idBoard}/myPrefs/emailPosition"=>{"put"=>{"summary"=>"Put Boards My Preferences Emailposition", "description"=>"Put boards my preferences emailposition.", "operationId"=>"updateBoardsMyPrefsEmailPositionByIdBoard", "x-api-path-slug"=>"boardsidboardmyprefsemailposition-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of My Prefs Email Position to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "My", "Preferences", "Emailposition"]}}, "/boards/{idBoard}/myPrefs/idEmailList"=>{"put"=>{"summary"=>"Put Boards My Preferences Emaillist", "description"=>"Put boards my preferences emaillist.", "operationId"=>"updateBoardsMyPrefsIdEmailListByIdBoard", "x-api-path-slug"=>"boardsidboardmyprefsidemaillist-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of My Prefs Id Email List to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "My", "Preferences", "Emaillist"]}}, "/boards/{idBoard}/myPrefs/showListGuide"=>{"put"=>{"summary"=>"Put Boards My Preferences Showlistgue", "description"=>"Put boards my preferences showlistgue.", "operationId"=>"updateBoardsMyPrefsShowListGuideByIdBoard", "x-api-path-slug"=>"boardsidboardmyprefsshowlistguide-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of My Prefs Show List Guide to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "My", "Preferences", "Showlistgue"]}}, "/boards/{idBoard}/myPrefs/showSidebar"=>{"put"=>{"summary"=>"Put Boards My Preferences Show Sidebar", "description"=>"Put boards my preferences show sidebar.", "operationId"=>"updateBoardsMyPrefsShowSidebarByIdBoard", "x-api-path-slug"=>"boardsidboardmyprefsshowsidebar-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of My Prefs Show Sidebar to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "My", "Preferences", "Show", "Sidebar"]}}, "/boards/{idBoard}/myPrefs/showSidebarActivity"=>{"put"=>{"summary"=>"Put Boards My Preferences Show Sidebar Activity", "description"=>"Put boards my preferences show sidebar activity.", "operationId"=>"updateBoardsMyPrefsShowSidebarActivityByIdBoard", "x-api-path-slug"=>"boardsidboardmyprefsshowsidebaractivity-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of My Prefs Show Sidebar Activity to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "My", "Preferences", "Show", "Sidebar", "Activity"]}}, "/boards/{idBoard}/myPrefs/showSidebarBoardActions"=>{"put"=>{"summary"=>"Put Boards My Preferences Show Sidebar Board Actions", "description"=>"Put boards my preferences show sidebar board actions.", "operationId"=>"updateBoardsMyPrefsShowSidebarBoardActionsByIdBoard", "x-api-path-slug"=>"boardsidboardmyprefsshowsidebarboardactions-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of My Prefs Show Sidebar Board Actions to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "My", "Preferences", "Show", "Sidebar", "Board", "Actions"]}}, "/boards/{idBoard}/myPrefs/showSidebarMembers"=>{"put"=>{"summary"=>"Put Boards My Preferences Show Sidebarmembers", "description"=>"Put boards my preferences show sidebarmembers.", "operationId"=>"updateBoardsMyPrefsShowSidebarMembersByIdBoard", "x-api-path-slug"=>"boardsidboardmyprefsshowsidebarmembers-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of My Prefs Show Sidebar Members to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "My", "Preferences", "Show", "Sidebarmembers"]}}, "/boards/{idBoard}/name"=>{"put"=>{"summary"=>"Put Boards Name", "description"=>"Put boards name.", "operationId"=>"updateBoardsNameByIdBoard", "x-api-path-slug"=>"boardsidboardname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Boards Name to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Name"]}}, "/boards/{idBoard}/organization"=>{"get"=>{"summary"=>"Get Boards Organization", "description"=>"Get boards organization.", "operationId"=>"getBoardsOrganizationByIdBoard", "x-api-path-slug"=>"boardsidboardorganization-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Organization"]}}, "/boards/{idBoard}/organization/{field}"=>{"get"=>{"summary"=>"Get Boards Organization Field", "description"=>"Get boards organization field.", "operationId"=>"getBoardsOrganizationByIdBoardByField", "x-api-path-slug"=>"boardsidboardorganizationfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Organization", "Field"]}}, "/boards/{idBoard}/powerUps"=>{"post"=>{"summary"=>"Post Boards Powerups", "description"=>"Post boards powerups.", "operationId"=>"addBoardsPowerUpsByIdBoard", "x-api-path-slug"=>"boardsidboardpowerups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Boards Power Ups to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Powerups"]}}, "/boards/{idBoard}/powerUps/{powerUp}"=>{"delete"=>{"summary"=>"Delete Boards Powerups Powerup", "description"=>"Delete boards powerups powerup.", "operationId"=>"deleteBoardsPowerUpsByIdBoardByPowerUp", "x-api-path-slug"=>"boardsidboardpowerupspowerup-delete", "parameters"=>[{"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"path", "name"=>"powerUp", "description"=>"powerUp"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Powerups", "Powerup"]}}, "/boards/{idBoard}/prefs/background"=>{"put"=>{"summary"=>"Put Boards Preferences Background", "description"=>"Put boards preferences background.", "operationId"=>"updateBoardsPrefsBackgroundByIdBoard", "x-api-path-slug"=>"boardsidboardprefsbackground-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Background to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Preferences", "Background"]}}, "/boards/{idBoard}/prefs/calendarFeedEnabled"=>{"put"=>{"summary"=>"Put Boards Preferences Calendar Feed Enabled", "description"=>"Put boards preferences calendar feed enabled.", "operationId"=>"updateBoardsPrefsCalendarFeedEnabledByIdBoard", "x-api-path-slug"=>"boardsidboardprefscalendarfeedenabled-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Calendar Feed Enabled to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Preferences", "Calendar", "Feed", "Enabled"]}}, "/boards/{idBoard}/prefs/cardAging"=>{"put"=>{"summary"=>"Put Boards Preferences Cardaging", "description"=>"Put boards preferences cardaging.", "operationId"=>"updateBoardsPrefsCardAgingByIdBoard", "x-api-path-slug"=>"boardsidboardprefscardaging-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Card Aging to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Preferences", "Cardaging"]}}, "/boards/{idBoard}/prefs/cardCovers"=>{"put"=>{"summary"=>"Put Boards Preferences Cardcovers", "description"=>"Put boards preferences cardcovers.", "operationId"=>"updateBoardsPrefsCardCoversByIdBoard", "x-api-path-slug"=>"boardsidboardprefscardcovers-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Card Covers to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Preferences", "Cardcovers"]}}, "/boards/{idBoard}/prefs/comments"=>{"put"=>{"summary"=>"Put Boards Preferences Comments", "description"=>"Put boards preferences comments.", "operationId"=>"updateBoardsPrefsCommentsByIdBoard", "x-api-path-slug"=>"boardsidboardprefscomments-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Comments to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Preferences", "Comments"]}}, "/boards/{idBoard}/prefs/invitations"=>{"put"=>{"summary"=>"Put Boards Preferences Invitations", "description"=>"Put boards preferences invitations.", "operationId"=>"updateBoardsPrefsInvitationsByIdBoard", "x-api-path-slug"=>"boardsidboardprefsinvitations-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Invitations to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Preferences", "Invitations"]}}, "/boards/{idBoard}/prefs/permissionLevel"=>{"put"=>{"summary"=>"Put Boards Preferences Permissionlevel", "description"=>"Put boards preferences permissionlevel.", "operationId"=>"updateBoardsPrefsPermissionLevelByIdBoard", "x-api-path-slug"=>"boardsidboardprefspermissionlevel-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Permission Level to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Preferences", "Permissionlevel"]}}, "/boards/{idBoard}/prefs/selfJoin"=>{"put"=>{"summary"=>"Put Boards Preferences Selfjoin", "description"=>"Put boards preferences selfjoin.", "operationId"=>"updateBoardsPrefsSelfJoinByIdBoard", "x-api-path-slug"=>"boardsidboardprefsselfjoin-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Self Join to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Preferences", "Selfjoin"]}}, "/boards/{idBoard}/prefs/voting"=>{"put"=>{"summary"=>"Put Boards Preferences Voting", "description"=>"Put boards preferences voting.", "operationId"=>"updateBoardsPrefsVotingByIdBoard", "x-api-path-slug"=>"boardsidboardprefsvoting-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Voting to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Preferences", "Voting"]}}, "/boards/{idBoard}/subscribed"=>{"put"=>{"summary"=>"Put Boards Subscribed", "description"=>"Put boards subscribed.", "operationId"=>"updateBoardsSubscribedByIdBoard", "x-api-path-slug"=>"boardsidboardsubscribed-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Boards Subscribed to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Subscribed"]}}, "/boards/{idBoard}/{field}"=>{"get"=>{"summary"=>"Get Boards Field", "description"=>"Get boards field.", "operationId"=>"getBoardsByIdBoardByField", "x-api-path-slug"=>"boardsidboardfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idBoard", "description"=>"board_id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Boards", "Field"]}}, "/cards"=>{"post"=>{"summary"=>"Post Cards", "description"=>"Post cards.", "operationId"=>"addCards", "x-api-path-slug"=>"cards-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards"]}}, "/cards/{idCard}"=>{"delete"=>{"summary"=>"Delete Cards", "description"=>"Delete cards.", "operationId"=>"deleteCardsByIdCard", "x-api-path-slug"=>"cardsidcard-delete", "parameters"=>[{"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards"]}, "get"=>{"summary"=>"Get Cards", "description"=>"Get cards.", "operationId"=>"getCardsByIdCard", "x-api-path-slug"=>"cardsidcard-get", "parameters"=>[{"in"=>"query", "name"=>"actions", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"actions_display", "description"=>"true or false"}, {"in"=>"query", "name"=>"actions_entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"actions_limit", "description"=>"a number from 0 to 1000"}, {"in"=>"query", "name"=>"action_fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator or type"}, {"in"=>"query", "name"=>"action_memberCreator_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"attachments", "description"=>"A boolean value or "cover" for only card cover attachments"}, {"in"=>"query", "name"=>"attachment_fields", "description"=>"all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url"}, {"in"=>"query", "name"=>"board", "description"=>"true or false"}, {"in"=>"query", "name"=>"board_fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"query", "name"=>"checkItemStates", "description"=>"true or false"}, {"in"=>"query", "name"=>"checkItemState_fields", "description"=>"all or a comma-separated list of: idCheckItem or state"}, {"in"=>"query", "name"=>"checklists", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"checklist_fields", "description"=>"all or a comma-separated list of: idBoard, idCard, name or pos"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"list", "description"=>"true or false"}, {"in"=>"query", "name"=>"list_fields", "description"=>"all or a comma-separated list of: closed, idBoard, name, pos or subscribed"}, {"in"=>"query", "name"=>"members", "description"=>"true or false"}, {"in"=>"query", "name"=>"membersVoted", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberVoted_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"stickers", "description"=>"true or false"}, {"in"=>"query", "name"=>"sticker_fields", "description"=>"all or a comma-separated list of: image, imageScaled, imageUrl, left, rotate, top or zIndex"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards"]}, "put"=>{"summary"=>"Put Cards", "description"=>"Put cards.", "operationId"=>"updateCardsByIdCard", "x-api-path-slug"=>"cardsidcard-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards"]}}, "/cards/{idCard}/actions"=>{"get"=>{"summary"=>"Get Cards Actions", "description"=>"Get cards actions.", "operationId"=>"getCardsActionsByIdCard", "x-api-path-slug"=>"cardsidcardactions-get", "parameters"=>[{"in"=>"query", "name"=>"before", "description"=>"A date, or null"}, {"in"=>"query", "name"=>"display", "description"=>"true or false"}, {"in"=>"query", "name"=>"entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator or type"}, {"in"=>"query", "name"=>"filter", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"format", "description"=>"One of: count, list or minimal"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"idModels", "description"=>"Only return actions related to these model ids"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"limit", "description"=>"a number from 0 to 1000"}, {"in"=>"query", "name"=>"member", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberCreator", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberCreator_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"page", "description"=>"Page * limit must be less than 1000"}, {"in"=>"query", "name"=>"since", "description"=>"A date, null or lastView"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Actions"]}}, "/cards/{idCard}/actions/comments"=>{"post"=>{"summary"=>"Post Cards Actions Comments", "description"=>"Post cards actions comments.", "operationId"=>"addCardsActionsCommentsByIdCard", "x-api-path-slug"=>"cardsidcardactionscomments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Actions Comments to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Actions", "Comments"]}}, "/cards/{idCard}/actions/{idAction}/comments"=>{"delete"=>{"summary"=>"Delete Cards Actions Comments", "description"=>"Delete cards actions comments.", "operationId"=>"deleteCardsActionsCommentsByIdCardByIdAction", "x-api-path-slug"=>"cardsidcardactionsidactioncomments-delete", "parameters"=>[{"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Actions", "Comments"]}, "put"=>{"summary"=>"Put Cards Actions Comments", "description"=>"Put cards actions comments.", "operationId"=>"updateCardsActionsCommentsByIdCardByIdAction", "x-api-path-slug"=>"cardsidcardactionsidactioncomments-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Actions Comments to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idAction", "description"=>"idAction"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Actions", "Comments"]}}, "/cards/{idCard}/attachments"=>{"get"=>{"summary"=>"Get Cards Attachments", "description"=>"Get cards attachments.", "operationId"=>"getCardsAttachmentsByIdCard", "x-api-path-slug"=>"cardsidcardattachments-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url"}, {"in"=>"query", "name"=>"filter", "description"=>"A boolean value or "cover" for only card cover attachments"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Attachments"]}, "post"=>{"summary"=>"Post Cards Attachments", "description"=>"Post cards attachments.", "operationId"=>"addCardsAttachmentsByIdCard", "x-api-path-slug"=>"cardsidcardattachments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Attachments to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Attachments"]}}, "/cards/{idCard}/attachments/{idAttachment}"=>{"delete"=>{"summary"=>"Delete Cards Attachments Attachment", "description"=>"Delete cards attachments attachment.", "operationId"=>"deleteCardsAttachmentsByIdCardByIdAttachment", "x-api-path-slug"=>"cardsidcardattachmentsidattachment-delete", "parameters"=>[{"in"=>"path", "name"=>"idAttachment", "description"=>"idAttachment"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Attachments", "Attachment"]}, "get"=>{"summary"=>"Get Cards Attachments Attachment", "description"=>"Get cards attachments attachment.", "operationId"=>"getCardsAttachmentsByIdCardByIdAttachment", "x-api-path-slug"=>"cardsidcardattachmentsidattachment-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url"}, {"in"=>"path", "name"=>"idAttachment", "description"=>"idAttachment"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Attachments", "Attachment"]}}, "/cards/{idCard}/board"=>{"get"=>{"summary"=>"Get Cards Board", "description"=>"Get cards board.", "operationId"=>"getCardsBoardByIdCard", "x-api-path-slug"=>"cardsidcardboard-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Board"]}}, "/cards/{idCard}/board/{field}"=>{"get"=>{"summary"=>"Get Cards Board Field", "description"=>"Get cards board field.", "operationId"=>"getCardsBoardByIdCardByField", "x-api-path-slug"=>"cardsidcardboardfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Board", "Field"]}}, "/cards/{idCard}/checkItemStates"=>{"get"=>{"summary"=>"Get Cards Checkitemstates", "description"=>"Get cards checkitemstates.", "operationId"=>"getCardsCheckItemStatesByIdCard", "x-api-path-slug"=>"cardsidcardcheckitemstates-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: idCheckItem or state"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Checkitemstates"]}}, "/cards/{idCard}/checklist/{idChecklistCurrent}/checkItem/{idCheckItem}"=>{"put"=>{"summary"=>"Put Cards Checklistcurrent Checkitem Checkitem", "description"=>"Put cards checklistcurrent checkitem checkitem.", "operationId"=>"updateCardsChecklistCheckItemByIdCardByIdChecklistCurrentByIdCheckItem", "x-api-path-slug"=>"cardsidcardchecklistidchecklistcurrentcheckitemidcheckitem-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Checklist Id Checklist Current Check Item to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"path", "name"=>"idCheckItem", "description"=>"idCheckItem"}, {"in"=>"path", "name"=>"idChecklistCurrent", "description"=>"idChecklistCurrent"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Checklistcurrent", "Checkitem", "Checkitem"]}}, "/cards/{idCard}/checklist/{idChecklist}/checkItem"=>{"post"=>{"summary"=>"Post Cards Checklist Checkitem", "description"=>"Post cards checklist checkitem.", "operationId"=>"addCardsChecklistCheckItemByIdCardByIdChecklist", "x-api-path-slug"=>"cardsidcardchecklistidchecklistcheckitem-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Checklist Check Item to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Checklist", "Checkitem"]}}, "/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}"=>{"delete"=>{"summary"=>"Delete Cards Checklist Checkitem Checkitem", "description"=>"Delete cards checklist checkitem checkitem.", "operationId"=>"deleteCardsChecklistCheckItemByIdCardByIdChecklistByIdCheckItem", "x-api-path-slug"=>"cardsidcardchecklistidchecklistcheckitemidcheckitem-delete", "parameters"=>[{"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"path", "name"=>"idCheckItem", "description"=>"idCheckItem"}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Checklist", "Checkitem", "Checkitem"]}}, "/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/convertToCard"=>{"post"=>{"summary"=>"Post Cards Checklist Checkitem Checkitem Converttocard", "description"=>"Post cards checklist checkitem checkitem converttocard.", "operationId"=>"addCardsChecklistCheckItemConvertToCardByIdCardByIdChecklistByIdCheckItem", "x-api-path-slug"=>"cardsidcardchecklistidchecklistcheckitemidcheckitemconverttocard-post", "parameters"=>[{"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"path", "name"=>"idCheckItem", "description"=>"idCheckItem"}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Checklist", "Checkitem", "Checkitem", "Converttocard"]}}, "/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/name"=>{"put"=>{"summary"=>"Put Cards Checklist Checkitem Checkitem Name", "description"=>"Put cards checklist checkitem checkitem name.", "operationId"=>"updateCardsChecklistCheckItemNameByIdCardByIdChecklistByIdCheckItem", "x-api-path-slug"=>"cardsidcardchecklistidchecklistcheckitemidcheckitemname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Checklist Check Item Name to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"path", "name"=>"idCheckItem", "description"=>"idCheckItem"}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Checklist", "Checkitem", "Checkitem", "Name"]}}, "/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/pos"=>{"put"=>{"summary"=>"Put Cards Checklist Checkitem Checkitem Pos", "description"=>"Put cards checklist checkitem checkitem pos.", "operationId"=>"updateCardsChecklistCheckItemPosByIdCardByIdChecklistByIdCheckItem", "x-api-path-slug"=>"cardsidcardchecklistidchecklistcheckitemidcheckitempos-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Checklist Check Item Pos to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"path", "name"=>"idCheckItem", "description"=>"idCheckItem"}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Checklist", "Checkitem", "Checkitem", "Pos"]}}, "/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/state"=>{"put"=>{"summary"=>"Put Cards Checklist Checkitem Checkitem State", "description"=>"Put cards checklist checkitem checkitem state.", "operationId"=>"updateCardsChecklistCheckItemStateByIdCardByIdChecklistByIdCheckItem", "x-api-path-slug"=>"cardsidcardchecklistidchecklistcheckitemidcheckitemstate-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Checklist Check Item State to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"path", "name"=>"idCheckItem", "description"=>"idCheckItem"}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Checklist", "Checkitem", "Checkitem", "State"]}}, "/cards/{idCard}/checklists"=>{"get"=>{"summary"=>"Get Cards Checklists", "description"=>"Get cards checklists.", "operationId"=>"getCardsChecklistsByIdCard", "x-api-path-slug"=>"cardsidcardchecklists-get", "parameters"=>[{"in"=>"query", "name"=>"cards", "description"=>"One of: all, closed, none, open or visible"}, {"in"=>"query", "name"=>"card_fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"query", "name"=>"checkItems", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"checkItem_fields", "description"=>"all or a comma-separated list of: name, nameData, pos, state or type"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: idBoard, idCard, name or pos"}, {"in"=>"query", "name"=>"filter", "description"=>"One of: all or none"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Checklists"]}, "post"=>{"summary"=>"Post Cards Checklists", "description"=>"Post cards checklists.", "operationId"=>"addCardsChecklistsByIdCard", "x-api-path-slug"=>"cardsidcardchecklists-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Checklists to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Checklists"]}}, "/cards/{idCard}/checklists/{idChecklist}"=>{"delete"=>{"summary"=>"Delete Cards Checklists", "description"=>"Delete cards checklists.", "operationId"=>"deleteCardsChecklistsByIdCardByIdChecklist", "x-api-path-slug"=>"cardsidcardchecklistsidchecklist-delete", "parameters"=>[{"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Checklists"]}}, "/cards/{idCard}/closed"=>{"put"=>{"summary"=>"Put Cards Closed", "description"=>"Put cards closed.", "operationId"=>"updateCardsClosedByIdCard", "x-api-path-slug"=>"cardsidcardclosed-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Closed to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Closed"]}}, "/cards/{idCard}/desc"=>{"put"=>{"summary"=>"Put Cards Desc", "description"=>"Put cards desc.", "operationId"=>"updateCardsDescByIdCard", "x-api-path-slug"=>"cardsidcarddesc-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Desc to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Desc"]}}, "/cards/{idCard}/due"=>{"put"=>{"summary"=>"Put Cards Due", "description"=>"Put cards due.", "operationId"=>"updateCardsDueByIdCard", "x-api-path-slug"=>"cardsidcarddue-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Due to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Due"]}}, "/cards/{idCard}/idAttachmentCover"=>{"put"=>{"summary"=>"Put Cards Attachmentcover", "description"=>"Put cards attachmentcover.", "operationId"=>"updateCardsIdAttachmentCoverByIdCard", "x-api-path-slug"=>"cardsidcardidattachmentcover-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Id Attachment Cover to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Attachmentcover"]}}, "/cards/{idCard}/idBoard"=>{"put"=>{"summary"=>"Put Cards Board", "description"=>"Put cards board.", "operationId"=>"updateCardsIdBoardByIdCard", "x-api-path-slug"=>"cardsidcardidboard-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Id Board to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Board"]}}, "/cards/{idCard}/idLabels"=>{"post"=>{"summary"=>"Post Cards Labels", "description"=>"Post cards labels.", "operationId"=>"addCardsIdLabelsByIdCard", "x-api-path-slug"=>"cardsidcardidlabels-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Id Labels to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Labels"]}}, "/cards/{idCard}/idLabels/{idLabel}"=>{"delete"=>{"summary"=>"Delete Cards Labels Label", "description"=>"Delete cards labels label.", "operationId"=>"deleteCardsIdLabelsByIdCardByIdLabel", "x-api-path-slug"=>"cardsidcardidlabelsidlabel-delete", "parameters"=>[{"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"path", "name"=>"idLabel", "description"=>"idLabel"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Labels", "Label"]}}, "/cards/{idCard}/idList"=>{"put"=>{"summary"=>"Put Cards List", "description"=>"Put cards list.", "operationId"=>"updateCardsIdListByIdCard", "x-api-path-slug"=>"cardsidcardidlist-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Id List to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "List"]}}, "/cards/{idCard}/idMembers"=>{"post"=>{"summary"=>"Post Cards Members", "description"=>"Post cards members.", "operationId"=>"addCardsIdMembersByIdCard", "x-api-path-slug"=>"cardsidcardidmembers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Id Members to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Members"]}, "put"=>{"summary"=>"Put Cards Members", "description"=>"Put cards members.", "operationId"=>"updateCardsIdMembersByIdCard", "x-api-path-slug"=>"cardsidcardidmembers-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Id Members to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Members"]}}, "/cards/{idCard}/idMembers/{idMember}"=>{"delete"=>{"summary"=>"Delete Cards Members", "description"=>"Delete cards members.", "operationId"=>"deleteCardsIdMembersByIdCardByIdMember", "x-api-path-slug"=>"cardsidcardidmembersidmember-delete", "parameters"=>[{"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Members"]}}, "/cards/{idCard}/labels"=>{"post"=>{"summary"=>"Post Cards Labels", "description"=>"Post cards labels.", "operationId"=>"addCardsLabelsByIdCard", "x-api-path-slug"=>"cardsidcardlabels-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Labels to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Labels"]}, "put"=>{"summary"=>"Put Cards Labels", "description"=>"Put cards labels.", "operationId"=>"updateCardsLabelsByIdCard", "x-api-path-slug"=>"cardsidcardlabels-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Labels to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Labels"]}}, "/cards/{idCard}/labels/{color}"=>{"delete"=>{"summary"=>"Delete Cards Labels Color", "description"=>"Delete cards labels color.", "operationId"=>"deleteCardsLabelsByIdCardByColor", "x-api-path-slug"=>"cardsidcardlabelscolor-delete", "parameters"=>[{"in"=>"path", "name"=>"color", "description"=>"color"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Labels", "Color"]}}, "/cards/{idCard}/list"=>{"get"=>{"summary"=>"Get Cards List", "description"=>"Get cards list.", "operationId"=>"getCardsListByIdCard", "x-api-path-slug"=>"cardsidcardlist-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: closed, idBoard, name, pos or subscribed"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "List"]}}, "/cards/{idCard}/list/{field}"=>{"get"=>{"summary"=>"Get Cards List Field", "description"=>"Get cards list field.", "operationId"=>"getCardsListByIdCardByField", "x-api-path-slug"=>"cardsidcardlistfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "List", "Field"]}}, "/cards/{idCard}/markAssociatedNotificationsRead"=>{"post"=>{"summary"=>"Post Cards Markassociatednotificationsread", "description"=>"Post cards markassociatednotificationsread.", "operationId"=>"addCardsMarkAssociatedNotificationsReadByIdCard", "x-api-path-slug"=>"cardsidcardmarkassociatednotificationsread-post", "parameters"=>[{"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Markassociatednotificationsread"]}}, "/cards/{idCard}/members"=>{"get"=>{"summary"=>"Get Cards Members", "description"=>"Get cards members.", "operationId"=>"getCardsMembersByIdCard", "x-api-path-slug"=>"cardsidcardmembers-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Members"]}}, "/cards/{idCard}/membersVoted"=>{"get"=>{"summary"=>"Get Cards Membersvoted", "description"=>"Get cards membersvoted.", "operationId"=>"getCardsMembersVotedByIdCard", "x-api-path-slug"=>"cardsidcardmembersvoted-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Membersvoted"]}, "post"=>{"summary"=>"Post Cards Membersvoted", "description"=>"Post cards membersvoted.", "operationId"=>"addCardsMembersVotedByIdCard", "x-api-path-slug"=>"cardsidcardmembersvoted-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Members Voted to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Membersvoted"]}}, "/cards/{idCard}/membersVoted/{idMember}"=>{"delete"=>{"summary"=>"Delete Cards Membersvoted Member", "description"=>"Delete cards membersvoted member.", "operationId"=>"deleteCardsMembersVotedByIdCardByIdMember", "x-api-path-slug"=>"cardsidcardmembersvotedidmember-delete", "parameters"=>[{"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Membersvoted", "Member"]}}, "/cards/{idCard}/name"=>{"put"=>{"summary"=>"Put Cards Name", "description"=>"Put cards name.", "operationId"=>"updateCardsNameByIdCard", "x-api-path-slug"=>"cardsidcardname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Name to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Name"]}}, "/cards/{idCard}/pos"=>{"put"=>{"summary"=>"Put Cards Pos", "description"=>"Put cards pos.", "operationId"=>"updateCardsPosByIdCard", "x-api-path-slug"=>"cardsidcardpos-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Pos to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Pos"]}}, "/cards/{idCard}/stickers"=>{"get"=>{"summary"=>"Get Cards Stickers", "description"=>"Get cards stickers.", "operationId"=>"getCardsStickersByIdCard", "x-api-path-slug"=>"cardsidcardstickers-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: image, imageScaled, imageUrl, left, rotate, top or zIndex"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Stickers"]}, "post"=>{"summary"=>"Post Cards Stickers", "description"=>"Post cards stickers.", "operationId"=>"addCardsStickersByIdCard", "x-api-path-slug"=>"cardsidcardstickers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Stickers to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Stickers"]}}, "/cards/{idCard}/stickers/{idSticker}"=>{"delete"=>{"summary"=>"Delete Cards Stickers Sticker", "description"=>"Delete cards stickers sticker.", "operationId"=>"deleteCardsStickersByIdCardByIdSticker", "x-api-path-slug"=>"cardsidcardstickersidsticker-delete", "parameters"=>[{"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"path", "name"=>"idSticker", "description"=>"idSticker"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Stickers", "Sticker"]}, "get"=>{"summary"=>"Get Cards Stickers Sticker", "description"=>"Get cards stickers sticker.", "operationId"=>"getCardsStickersByIdCardByIdSticker", "x-api-path-slug"=>"cardsidcardstickersidsticker-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: image, imageScaled, imageUrl, left, rotate, top or zIndex"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"path", "name"=>"idSticker", "description"=>"idSticker"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Stickers", "Sticker"]}, "put"=>{"summary"=>"Put Cards Stickers Sticker", "description"=>"Put cards stickers sticker.", "operationId"=>"updateCardsStickersByIdCardByIdSticker", "x-api-path-slug"=>"cardsidcardstickersidsticker-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Stickers to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"path", "name"=>"idSticker", "description"=>"idSticker"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Stickers", "Sticker"]}}, "/cards/{idCard}/subscribed"=>{"put"=>{"summary"=>"Put Cards Subscribed", "description"=>"Put cards subscribed.", "operationId"=>"updateCardsSubscribedByIdCard", "x-api-path-slug"=>"cardsidcardsubscribed-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Cards Subscribed to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Subscribed"]}}, "/cards/{idCard}/{field}"=>{"get"=>{"summary"=>"Get Cards Field", "description"=>"Get cards field.", "operationId"=>"getCardsByIdCardByField", "x-api-path-slug"=>"cardsidcardfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idCard", "description"=>"card id or shortlink"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cards", "Field"]}}, "/checklists"=>{"post"=>{"summary"=>"Post Checklists", "description"=>"Post checklists.", "operationId"=>"addChecklists", "x-api-path-slug"=>"checklists-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Checklists to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checklists"]}}, "/checklists/{idChecklist}"=>{"delete"=>{"summary"=>"Delete Checklists", "description"=>"Delete checklists.", "operationId"=>"deleteChecklistsByIdChecklist", "x-api-path-slug"=>"checklistsidchecklist-delete", "parameters"=>[{"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checklists"]}, "get"=>{"summary"=>"Get Checklists", "description"=>"Get checklists.", "operationId"=>"getChecklistsByIdChecklist", "x-api-path-slug"=>"checklistsidchecklist-get", "parameters"=>[{"in"=>"query", "name"=>"cards", "description"=>"One of: all, closed, none, open or visible"}, {"in"=>"query", "name"=>"card_fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"query", "name"=>"checkItems", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"checkItem_fields", "description"=>"all or a comma-separated list of: name, nameData, pos, state or type"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: idBoard, idCard, name or pos"}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checklists"]}, "put"=>{"summary"=>"Put Checklists", "description"=>"Put checklists.", "operationId"=>"updateChecklistsByIdChecklist", "x-api-path-slug"=>"checklistsidchecklist-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Checklists to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checklists"]}}, "/checklists/{idChecklist}/board"=>{"get"=>{"summary"=>"Get Checklists Board", "description"=>"Get checklists board.", "operationId"=>"getChecklistsBoardByIdChecklist", "x-api-path-slug"=>"checklistsidchecklistboard-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checklists", "Board"]}}, "/checklists/{idChecklist}/board/{field}"=>{"get"=>{"summary"=>"Get Checklists Board Field", "description"=>"Get checklists board field.", "operationId"=>"getChecklistsBoardByIdChecklistByField", "x-api-path-slug"=>"checklistsidchecklistboardfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checklists", "Board", "Field"]}}, "/checklists/{idChecklist}/cards"=>{"get"=>{"summary"=>"Get Checklists Cards", "description"=>"Get checklists cards.", "operationId"=>"getChecklistsCardsByIdChecklist", "x-api-path-slug"=>"checklistsidchecklistcards-get", "parameters"=>[{"in"=>"query", "name"=>"actions", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"attachments", "description"=>"A boolean value or "cover" for only card cover attachments"}, {"in"=>"query", "name"=>"attachment_fields", "description"=>"all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url"}, {"in"=>"query", "name"=>"before", "description"=>"A date, or null"}, {"in"=>"query", "name"=>"checkItemStates", "description"=>"true or false"}, {"in"=>"query", "name"=>"checklists", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"query", "name"=>"filter", "description"=>"One of: all, closed, none or open"}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"limit", "description"=>"a number from 1 to 1000"}, {"in"=>"query", "name"=>"members", "description"=>"true or false"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"since", "description"=>"A date, or null"}, {"in"=>"query", "name"=>"stickers", "description"=>"true or false"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checklists", "Cards"]}}, "/checklists/{idChecklist}/cards/{filter}"=>{"get"=>{"summary"=>"Get Checklists Cards Filter", "description"=>"Get checklists cards filter.", "operationId"=>"getChecklistsCardsByIdChecklistByFilter", "x-api-path-slug"=>"checklistsidchecklistcardsfilter-get", "parameters"=>[{"in"=>"path", "name"=>"filter", "description"=>"filter"}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checklists", "Cards", "Filter"]}}, "/checklists/{idChecklist}/checkItems"=>{"get"=>{"summary"=>"Get Checklists Checkitems", "description"=>"Get checklists checkitems.", "operationId"=>"getChecklistsCheckItemsByIdChecklist", "x-api-path-slug"=>"checklistsidchecklistcheckitems-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: name, nameData, pos, state or type"}, {"in"=>"query", "name"=>"filter", "description"=>"One of: all or none"}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checklists", "Checkitems"]}, "post"=>{"summary"=>"Post Checklists Checkitems", "description"=>"Post checklists checkitems.", "operationId"=>"addChecklistsCheckItemsByIdChecklist", "x-api-path-slug"=>"checklistsidchecklistcheckitems-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Checklists Check Items to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checklists", "Checkitems"]}}, "/checklists/{idChecklist}/checkItems/{idCheckItem}"=>{"delete"=>{"summary"=>"Delete Checklists Checkitems Checkitem", "description"=>"Delete checklists checkitems checkitem.", "operationId"=>"deleteChecklistsCheckItemsByIdChecklistByIdCheckItem", "x-api-path-slug"=>"checklistsidchecklistcheckitemsidcheckitem-delete", "parameters"=>[{"in"=>"path", "name"=>"idCheckItem", "description"=>"idCheckItem"}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checklists", "Checkitems", "Checkitem"]}, "get"=>{"summary"=>"Get Checklists Checkitems Checkitem", "description"=>"Get checklists checkitems checkitem.", "operationId"=>"getChecklistsCheckItemsByIdChecklistByIdCheckItem", "x-api-path-slug"=>"checklistsidchecklistcheckitemsidcheckitem-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: name, nameData, pos, state or type"}, {"in"=>"path", "name"=>"idCheckItem", "description"=>"idCheckItem"}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checklists", "Checkitems", "Checkitem"]}}, "/checklists/{idChecklist}/idCard"=>{"put"=>{"summary"=>"Put Checklists Card", "description"=>"Put checklists card.", "operationId"=>"updateChecklistsIdCardByIdChecklist", "x-api-path-slug"=>"checklistsidchecklistidcard-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Checklists Id Card to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checklists", "Card"]}}, "/checklists/{idChecklist}/name"=>{"put"=>{"summary"=>"Put Checklists Name", "description"=>"Put checklists name.", "operationId"=>"updateChecklistsNameByIdChecklist", "x-api-path-slug"=>"checklistsidchecklistname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Checklists Name to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checklists", "Name"]}}, "/checklists/{idChecklist}/pos"=>{"put"=>{"summary"=>"Put Checklists Pos", "description"=>"Put checklists pos.", "operationId"=>"updateChecklistsPosByIdChecklist", "x-api-path-slug"=>"checklistsidchecklistpos-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Checklists Pos to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checklists", "Pos"]}}, "/checklists/{idChecklist}/{field}"=>{"get"=>{"summary"=>"Get Checklists Field", "description"=>"Get checklists field.", "operationId"=>"getChecklistsByIdChecklistByField", "x-api-path-slug"=>"checklistsidchecklistfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idChecklist", "description"=>"idChecklist"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checklists", "Field"]}}, "/labels"=>{"post"=>{"summary"=>"Post Labels", "description"=>"Post labels.", "operationId"=>"addLabels", "x-api-path-slug"=>"labels-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Labels to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labels"]}}, "/labels/{idLabel}"=>{"delete"=>{"summary"=>"Delete Labels Label", "description"=>"Delete labels label.", "operationId"=>"deleteLabelsByIdLabel", "x-api-path-slug"=>"labelsidlabel-delete", "parameters"=>[{"in"=>"path", "name"=>"idLabel", "description"=>"idLabel"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labels", "Label"]}, "get"=>{"summary"=>"Get Labels Label", "description"=>"Get labels label.", "operationId"=>"getLabelsByIdLabel", "x-api-path-slug"=>"labelsidlabel-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: color, idBoard, name or uses"}, {"in"=>"path", "name"=>"idLabel", "description"=>"idLabel"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labels", "Label"]}, "put"=>{"summary"=>"Put Labels Label", "description"=>"Put labels label.", "operationId"=>"updateLabelsByIdLabel", "x-api-path-slug"=>"labelsidlabel-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Labels to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idLabel", "description"=>"idLabel"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labels", "Label"]}}, "/labels/{idLabel}/board"=>{"get"=>{"summary"=>"Get Labels Label Board", "description"=>"Get labels label board.", "operationId"=>"getLabelsBoardByIdLabel", "x-api-path-slug"=>"labelsidlabelboard-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"path", "name"=>"idLabel", "description"=>"idLabel"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labels", "Label", "Board"]}}, "/labels/{idLabel}/board/{field}"=>{"get"=>{"summary"=>"Get Labels Label Board Field", "description"=>"Get labels label board field.", "operationId"=>"getLabelsBoardByIdLabelByField", "x-api-path-slug"=>"labelsidlabelboardfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idLabel", "description"=>"idLabel"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labels", "Label", "Board", "Field"]}}, "/labels/{idLabel}/color"=>{"put"=>{"summary"=>"Put Labels Label Color", "description"=>"Put labels label color.", "operationId"=>"updateLabelsColorByIdLabel", "x-api-path-slug"=>"labelsidlabelcolor-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Labels Color to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idLabel", "description"=>"idLabel"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labels", "Label", "Color"]}}, "/labels/{idLabel}/name"=>{"put"=>{"summary"=>"Put Labels Label Name", "description"=>"Put labels label name.", "operationId"=>"updateLabelsNameByIdLabel", "x-api-path-slug"=>"labelsidlabelname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Labels Name to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idLabel", "description"=>"idLabel"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Labels", "Label", "Name"]}}, "/lists"=>{"post"=>{"summary"=>"Post Lists", "description"=>"Post lists.", "operationId"=>"addLists", "x-api-path-slug"=>"lists-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Lists to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists"]}}, "/lists/{idList}"=>{"get"=>{"summary"=>"Get Lists List", "description"=>"Get lists list.", "operationId"=>"getListsByIdList", "x-api-path-slug"=>"listsidlist-get", "parameters"=>[{"in"=>"query", "name"=>"board", "description"=>"true or false"}, {"in"=>"query", "name"=>"board_fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"query", "name"=>"cards", "description"=>"One of: all, closed, none or open"}, {"in"=>"query", "name"=>"card_fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: closed, idBoard, name, pos or subscribed"}, {"in"=>"path", "name"=>"idList", "description"=>"idList"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List"]}, "put"=>{"summary"=>"Put Lists List", "description"=>"Put lists list.", "operationId"=>"updateListsByIdList", "x-api-path-slug"=>"listsidlist-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Lists to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idList", "description"=>"idList"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List"]}}, "/lists/{idList}/actions"=>{"get"=>{"summary"=>"Get Lists List Actions", "description"=>"Get lists list actions.", "operationId"=>"getListsActionsByIdList", "x-api-path-slug"=>"listsidlistactions-get", "parameters"=>[{"in"=>"query", "name"=>"before", "description"=>"A date, or null"}, {"in"=>"query", "name"=>"display", "description"=>"true or false"}, {"in"=>"query", "name"=>"entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator or type"}, {"in"=>"query", "name"=>"filter", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"format", "description"=>"One of: count, list or minimal"}, {"in"=>"path", "name"=>"idList", "description"=>"idList"}, {"in"=>"query", "name"=>"idModels", "description"=>"Only return actions related to these model ids"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"limit", "description"=>"a number from 0 to 1000"}, {"in"=>"query", "name"=>"member", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberCreator", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberCreator_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"page", "description"=>"Page * limit must be less than 1000"}, {"in"=>"query", "name"=>"since", "description"=>"A date, null or lastView"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List", "Actions"]}}, "/lists/{idList}/archiveAllCards"=>{"post"=>{"summary"=>"Post Lists List Archiveallcards", "description"=>"Post lists list archiveallcards.", "operationId"=>"addListsArchiveAllCardsByIdList", "x-api-path-slug"=>"listsidlistarchiveallcards-post", "parameters"=>[{"in"=>"path", "name"=>"idList", "description"=>"idList"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List", "Archiveallcards"]}}, "/lists/{idList}/board"=>{"get"=>{"summary"=>"Get Lists List Board", "description"=>"Get lists list board.", "operationId"=>"getListsBoardByIdList", "x-api-path-slug"=>"listsidlistboard-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"path", "name"=>"idList", "description"=>"idList"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List", "Board"]}}, "/lists/{idList}/board/{field}"=>{"get"=>{"summary"=>"Get Lists List Board Field", "description"=>"Get lists list board field.", "operationId"=>"getListsBoardByIdListByField", "x-api-path-slug"=>"listsidlistboardfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idList", "description"=>"idList"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List", "Board", "Field"]}}, "/lists/{idList}/cards"=>{"get"=>{"summary"=>"Get Lists List Cards", "description"=>"Get lists list cards.", "operationId"=>"getListsCardsByIdList", "x-api-path-slug"=>"listsidlistcards-get", "parameters"=>[{"in"=>"query", "name"=>"actions", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"attachments", "description"=>"A boolean value or "cover" for only card cover attachments"}, {"in"=>"query", "name"=>"attachment_fields", "description"=>"all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url"}, {"in"=>"query", "name"=>"before", "description"=>"A date, or null"}, {"in"=>"query", "name"=>"checkItemStates", "description"=>"true or false"}, {"in"=>"query", "name"=>"checklists", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"query", "name"=>"filter", "description"=>"One of: all, closed, none or open"}, {"in"=>"path", "name"=>"idList", "description"=>"idList"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"limit", "description"=>"a number from 1 to 1000"}, {"in"=>"query", "name"=>"members", "description"=>"true or false"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"since", "description"=>"A date, or null"}, {"in"=>"query", "name"=>"stickers", "description"=>"true or false"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List", "Cards"]}, "post"=>{"summary"=>"Post Lists List Cards", "description"=>"Post lists list cards.", "operationId"=>"addListsCardsByIdList", "x-api-path-slug"=>"listsidlistcards-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Lists Cards to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idList", "description"=>"idList"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List", "Cards"]}}, "/lists/{idList}/cards/{filter}"=>{"get"=>{"summary"=>"Get Lists List Cards Filter", "description"=>"Get lists list cards filter.", "operationId"=>"getListsCardsByIdListByFilter", "x-api-path-slug"=>"listsidlistcardsfilter-get", "parameters"=>[{"in"=>"path", "name"=>"filter", "description"=>"filter"}, {"in"=>"path", "name"=>"idList", "description"=>"idList"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List", "Cards", "Filter"]}}, "/lists/{idList}/closed"=>{"put"=>{"summary"=>"Put Lists List Closed", "description"=>"Put lists list closed.", "operationId"=>"updateListsClosedByIdList", "x-api-path-slug"=>"listsidlistclosed-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Lists Closed to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idList", "description"=>"idList"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List", "Closed"]}}, "/lists/{idList}/idBoard"=>{"put"=>{"summary"=>"Put Lists List Board", "description"=>"Put lists list board.", "operationId"=>"updateListsIdBoardByIdList", "x-api-path-slug"=>"listsidlistidboard-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Lists Id Board to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idList", "description"=>"idList"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List", "Board"]}}, "/lists/{idList}/moveAllCards"=>{"post"=>{"summary"=>"Post Lists List Moveallcards", "description"=>"Post lists list moveallcards.", "operationId"=>"addListsMoveAllCardsByIdList", "x-api-path-slug"=>"listsidlistmoveallcards-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Lists Move All Cards to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idList", "description"=>"idList"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List", "Moveallcards"]}}, "/lists/{idList}/name"=>{"put"=>{"summary"=>"Put Lists List Name", "description"=>"Put lists list name.", "operationId"=>"updateListsNameByIdList", "x-api-path-slug"=>"listsidlistname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Lists Name to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idList", "description"=>"idList"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List", "Name"]}}, "/lists/{idList}/pos"=>{"put"=>{"summary"=>"Put Lists List Pos", "description"=>"Put lists list pos.", "operationId"=>"updateListsPosByIdList", "x-api-path-slug"=>"listsidlistpos-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Lists Pos to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idList", "description"=>"idList"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List", "Pos"]}}, "/lists/{idList}/subscribed"=>{"put"=>{"summary"=>"Put Lists List Subscribed", "description"=>"Put lists list subscribed.", "operationId"=>"updateListsSubscribedByIdList", "x-api-path-slug"=>"listsidlistsubscribed-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Lists Subscribed to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idList", "description"=>"idList"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List", "Subscribed"]}}, "/lists/{idList}/{field}"=>{"get"=>{"summary"=>"Get Lists List Field", "description"=>"Get lists list field.", "operationId"=>"getListsByIdListByField", "x-api-path-slug"=>"listsidlistfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idList", "description"=>"idList"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lists", "List", "Field"]}}, "/members/{idMember}"=>{"get"=>{"summary"=>"Get Members", "description"=>"Get members.", "operationId"=>"getMembersByIdMember", "x-api-path-slug"=>"membersidmember-get", "parameters"=>[{"in"=>"query", "name"=>"actions", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"actions_display", "description"=>"true or false"}, {"in"=>"query", "name"=>"actions_entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"actions_limit", "description"=>"a number from 0 to 1000"}, {"in"=>"query", "name"=>"action_before", "description"=>"A date, or null"}, {"in"=>"query", "name"=>"action_fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator or type"}, {"in"=>"query", "name"=>"action_since", "description"=>"A date, null or lastView"}, {"in"=>"query", "name"=>"boardBackgrounds", "description"=>"One of: all, custom, default, none or premium"}, {"in"=>"query", "name"=>"boards", "description"=>"all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned"}, {"in"=>"query", "name"=>"boardsInvited", "description"=>"all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned"}, {"in"=>"query", "name"=>"boardsInvited_fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"query", "name"=>"boardStars", "description"=>"true or false"}, {"in"=>"query", "name"=>"board_actions", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"board_actions_display", "description"=>"true or false"}, {"in"=>"query", "name"=>"board_actions_entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"board_actions_format", "description"=>"One of: count, list or minimal"}, {"in"=>"query", "name"=>"board_actions_limit", "description"=>"a number from 0 to 1000"}, {"in"=>"query", "name"=>"board_actions_since", "description"=>"A date, null or lastView"}, {"in"=>"query", "name"=>"board_action_fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator or type"}, {"in"=>"query", "name"=>"board_fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"query", "name"=>"board_lists", "description"=>"One of: all, closed, none or open"}, {"in"=>"query", "name"=>"board_memberships", "description"=>"all or a comma-separated list of: active, admin, deactivated, me or normal"}, {"in"=>"query", "name"=>"board_organization", "description"=>"true or false"}, {"in"=>"query", "name"=>"board_organization_fields", "description"=>"all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website"}, {"in"=>"query", "name"=>"cards", "description"=>"One of: all, closed, none, open or visible"}, {"in"=>"query", "name"=>"card_attachments", "description"=>"A boolean value or "cover" for only card cover attachments"}, {"in"=>"query", "name"=>"card_attachment_fields", "description"=>"all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url"}, {"in"=>"query", "name"=>"card_fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"query", "name"=>"card_members", "description"=>"true or false"}, {"in"=>"query", "name"=>"card_member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"card_stickers", "description"=>"true or false"}, {"in"=>"query", "name"=>"customBoardBackgrounds", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"customEmoji", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"customStickers", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"notifications", "description"=>"all or a comma-separated list of: addAdminToBoard, addAdminToOrganization, addedAttachmentToCard, addedMemberToCard, addedToBoard, addedToCard, addedToOrganization, cardDueSoon, changeCard, closeBoard, commentCard, createdCard, declinedInvitationToBoard, declinedInvitationToOrganization, invitedToBoard, invitedToOrganization, makeAdminOfBoard, makeAdminOfOrganization, memberJoinedTrello, mentionedOnCard, removedFromBoard, removedFromCard, removedFromOrganization, removedMemberFromCard, unconfirmedInvitedToBoard, unconfirmedInvitedToOrganization or updateCheckItemStateOnCard"}, {"in"=>"query", "name"=>"notifications_display", "description"=>"true or false"}, {"in"=>"query", "name"=>"notifications_entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"notifications_limit", "description"=>"a number from 1 to 1000"}, {"in"=>"query", "name"=>"notification_before", "description"=>"An id, or null"}, {"in"=>"query", "name"=>"notification_fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator, type or unread"}, {"in"=>"query", "name"=>"notification_memberCreator", "description"=>"true or false"}, {"in"=>"query", "name"=>"notification_memberCreator_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"notification_since", "description"=>"An id, or null"}, {"in"=>"query", "name"=>"organizations", "description"=>"One of: all, members, none or public"}, {"in"=>"query", "name"=>"organizationsInvited", "description"=>"One of: all, members, none or public"}, {"in"=>"query", "name"=>"organizationsInvited_fields", "description"=>"all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website"}, {"in"=>"query", "name"=>"organization_fields", "description"=>"all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website"}, {"in"=>"query", "name"=>"organization_paid_account", "description"=>"true or false"}, {"in"=>"query", "name"=>"paid_account", "description"=>"true or false"}, {"in"=>"query", "name"=>"savedSearches", "description"=>"true or false"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}, {"in"=>"query", "name"=>"tokens", "description"=>"One of: all or none"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members"]}, "put"=>{"summary"=>"Put Members", "description"=>"Put members.", "operationId"=>"updateMembersByIdMember", "x-api-path-slug"=>"membersidmember-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members"]}}, "/members/{idMember}/actions"=>{"get"=>{"summary"=>"Get Members Actions", "description"=>"Get members actions.", "operationId"=>"getMembersActionsByIdMember", "x-api-path-slug"=>"membersidmemberactions-get", "parameters"=>[{"in"=>"query", "name"=>"before", "description"=>"A date, or null"}, {"in"=>"query", "name"=>"display", "description"=>"true or false"}, {"in"=>"query", "name"=>"entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator or type"}, {"in"=>"query", "name"=>"filter", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"format", "description"=>"One of: count, list or minimal"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"idModels", "description"=>"Only return actions related to these model ids"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"limit", "description"=>"a number from 0 to 1000"}, {"in"=>"query", "name"=>"member", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberCreator", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberCreator_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"page", "description"=>"Page * limit must be less than 1000"}, {"in"=>"query", "name"=>"since", "description"=>"A date, null or lastView"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Actions"]}}, "/members/{idMember}/avatar"=>{"post"=>{"summary"=>"Post Members Avatar", "description"=>"Post members avatar.", "operationId"=>"addMembersAvatarByIdMember", "x-api-path-slug"=>"membersidmemberavatar-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Avatar to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Avatar"]}}, "/members/{idMember}/avatarSource"=>{"put"=>{"summary"=>"Put Members Avatarsource", "description"=>"Put members avatarsource.", "operationId"=>"updateMembersAvatarSourceByIdMember", "x-api-path-slug"=>"membersidmemberavatarsource-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Avatar Source to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Avatarsource"]}}, "/members/{idMember}/bio"=>{"put"=>{"summary"=>"Put Members Bio", "description"=>"Put members bio.", "operationId"=>"updateMembersBioByIdMember", "x-api-path-slug"=>"membersidmemberbio-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Bio to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Bio"]}}, "/members/{idMember}/boardBackgrounds"=>{"get"=>{"summary"=>"Get Members Boardbackgrounds", "description"=>"Get members boardbackgrounds.", "operationId"=>"getMembersBoardBackgroundsByIdMember", "x-api-path-slug"=>"membersidmemberboardbackgrounds-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"One of: all, custom, default, none or premium"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Boardbackgrounds"]}, "post"=>{"summary"=>"Post Members Boardbackgrounds", "description"=>"Post members boardbackgrounds.", "operationId"=>"addMembersBoardBackgroundsByIdMember", "x-api-path-slug"=>"membersidmemberboardbackgrounds-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Board Backgrounds to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Boardbackgrounds"]}}, "/members/{idMember}/boardBackgrounds/{idBoardBackground}"=>{"delete"=>{"summary"=>"Delete Members Boardbackgrounds Boardbackground", "description"=>"Delete members boardbackgrounds boardbackground.", "operationId"=>"deleteMembersBoardBackgroundsByIdMemberByIdBoardBackground", "x-api-path-slug"=>"membersidmemberboardbackgroundsidboardbackground-delete", "parameters"=>[{"in"=>"path", "name"=>"idBoardBackground", "description"=>"idBoardBackground"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Boardbackgrounds", "Boardbackground"]}, "get"=>{"summary"=>"Get Members Boardbackgrounds Boardbackground", "description"=>"Get members boardbackgrounds boardbackground.", "operationId"=>"getMembersBoardBackgroundsByIdMemberByIdBoardBackground", "x-api-path-slug"=>"membersidmemberboardbackgroundsidboardbackground-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: brightness, fullSizeUrl, scaled or tile"}, {"in"=>"path", "name"=>"idBoardBackground", "description"=>"idBoardBackground"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Boardbackgrounds", "Boardbackground"]}, "put"=>{"summary"=>"Put Members Boardbackgrounds Boardbackground", "description"=>"Put members boardbackgrounds boardbackground.", "operationId"=>"updateMembersBoardBackgroundsByIdMemberByIdBoardBackground", "x-api-path-slug"=>"membersidmemberboardbackgroundsidboardbackground-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Board Backgrounds to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoardBackground", "description"=>"idBoardBackground"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Boardbackgrounds", "Boardbackground"]}}, "/members/{idMember}/boardStars"=>{"get"=>{"summary"=>"Get Members Boardstars", "description"=>"Get members boardstars.", "operationId"=>"getMembersBoardStarsByIdMember", "x-api-path-slug"=>"membersidmemberboardstars-get", "parameters"=>[{"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Boardstars"]}, "post"=>{"summary"=>"Post Members Boardstars", "description"=>"Post members boardstars.", "operationId"=>"addMembersBoardStarsByIdMember", "x-api-path-slug"=>"membersidmemberboardstars-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Board Stars to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Boardstars"]}}, "/members/{idMember}/boardStars/{idBoardStar}"=>{"delete"=>{"summary"=>"Delete Members Boardstars", "description"=>"Delete members boardstars.", "operationId"=>"deleteMembersBoardStarsByIdMemberByIdBoardStar", "x-api-path-slug"=>"membersidmemberboardstarsidboardstar-delete", "parameters"=>[{"in"=>"path", "name"=>"idBoardStar", "description"=>"idBoardStar"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Boardstars"]}, "get"=>{"summary"=>"Get Members Boardstars", "description"=>"Get members boardstars.", "operationId"=>"getMembersBoardStarsByIdMemberByIdBoardStar", "x-api-path-slug"=>"membersidmemberboardstarsidboardstar-get", "parameters"=>[{"in"=>"path", "name"=>"idBoardStar", "description"=>"idBoardStar"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Boardstars"]}, "put"=>{"summary"=>"Put Members Boardstars", "description"=>"Put members boardstars.", "operationId"=>"updateMembersBoardStarsByIdMemberByIdBoardStar", "x-api-path-slug"=>"membersidmemberboardstarsidboardstar-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Board Stars to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoardStar", "description"=>"idBoardStar"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Boardstars"]}}, "/members/{idMember}/boardStars/{idBoardStar}/idBoard"=>{"put"=>{"summary"=>"Put Members Boardstars Board", "description"=>"Put members boardstars board.", "operationId"=>"updateMembersBoardStarsIdBoardByIdMemberByIdBoardStar", "x-api-path-slug"=>"membersidmemberboardstarsidboardstaridboard-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Board Stars Id Board to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoardStar", "description"=>"idBoardStar"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Boardstars", "Board"]}}, "/members/{idMember}/boardStars/{idBoardStar}/pos"=>{"put"=>{"summary"=>"Put Members Boardstars Pos", "description"=>"Put members boardstars pos.", "operationId"=>"updateMembersBoardStarsPosByIdMemberByIdBoardStar", "x-api-path-slug"=>"membersidmemberboardstarsidboardstarpos-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Board Stars Pos to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoardStar", "description"=>"idBoardStar"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Boardstars", "Pos"]}}, "/members/{idMember}/boards"=>{"get"=>{"summary"=>"Get Members Boards", "description"=>"Get members boards.", "operationId"=>"getMembersBoardsByIdMember", "x-api-path-slug"=>"membersidmemberboards-get", "parameters"=>[{"in"=>"query", "name"=>"actions", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"actions_entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"actions_format", "description"=>"One of: count, list or minimal"}, {"in"=>"query", "name"=>"actions_limit", "description"=>"a number from 0 to 1000"}, {"in"=>"query", "name"=>"actions_since", "description"=>"A date, null or lastView"}, {"in"=>"query", "name"=>"action_fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator or type"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"query", "name"=>"filter", "description"=>"all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"lists", "description"=>"One of: all, closed, none or open"}, {"in"=>"query", "name"=>"memberships", "description"=>"all or a comma-separated list of: active, admin, deactivated, me or normal"}, {"in"=>"query", "name"=>"organization", "description"=>"true or false"}, {"in"=>"query", "name"=>"organization_fields", "description"=>"all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Boards"]}}, "/members/{idMember}/boards/{filter}"=>{"get"=>{"summary"=>"Get Members Boards Filter", "description"=>"Get members boards filter.", "operationId"=>"getMembersBoardsByIdMemberByFilter", "x-api-path-slug"=>"membersidmemberboardsfilter-get", "parameters"=>[{"in"=>"path", "name"=>"filter", "description"=>"filter"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Boards", "Filter"]}}, "/members/{idMember}/boardsInvited"=>{"get"=>{"summary"=>"Get Members Boardsinvited", "description"=>"Get members boardsinvited.", "operationId"=>"getMembersBoardsInvitedByIdMember", "x-api-path-slug"=>"membersidmemberboardsinvited-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Boardsinvited"]}}, "/members/{idMember}/boardsInvited/{field}"=>{"get"=>{"summary"=>"Get Members Boardsinvited Field", "description"=>"Get members boardsinvited field.", "operationId"=>"getMembersBoardsInvitedByIdMemberByField", "x-api-path-slug"=>"membersidmemberboardsinvitedfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Boardsinvited", "Field"]}}, "/members/{idMember}/cards"=>{"get"=>{"summary"=>"Get Members Cards", "description"=>"Get members cards.", "operationId"=>"getMembersCardsByIdMember", "x-api-path-slug"=>"membersidmembercards-get", "parameters"=>[{"in"=>"query", "name"=>"actions", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"attachments", "description"=>"A boolean value or "cover" for only card cover attachments"}, {"in"=>"query", "name"=>"attachment_fields", "description"=>"all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url"}, {"in"=>"query", "name"=>"before", "description"=>"A date, or null"}, {"in"=>"query", "name"=>"checkItemStates", "description"=>"true or false"}, {"in"=>"query", "name"=>"checklists", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"query", "name"=>"filter", "description"=>"One of: all, closed, none, open or visible"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"limit", "description"=>"a number from 1 to 1000"}, {"in"=>"query", "name"=>"members", "description"=>"true or false"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"since", "description"=>"A date, or null"}, {"in"=>"query", "name"=>"stickers", "description"=>"true or false"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Cards"]}}, "/members/{idMember}/cards/{filter}"=>{"get"=>{"summary"=>"Get Members Cards Filter", "description"=>"Get members cards filter.", "operationId"=>"getMembersCardsByIdMemberByFilter", "x-api-path-slug"=>"membersidmembercardsfilter-get", "parameters"=>[{"in"=>"path", "name"=>"filter", "description"=>"filter"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Cards", "Filter"]}}, "/members/{idMember}/customBoardBackgrounds"=>{"get"=>{"summary"=>"Get Members Customboardbackgrounds", "description"=>"Get members customboardbackgrounds.", "operationId"=>"getMembersCustomBoardBackgroundsByIdMember", "x-api-path-slug"=>"membersidmembercustomboardbackgrounds-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"One of: all or none"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Customboardbackgrounds"]}, "post"=>{"summary"=>"Post Members Customboardbackgrounds", "description"=>"Post members customboardbackgrounds.", "operationId"=>"addMembersCustomBoardBackgroundsByIdMember", "x-api-path-slug"=>"membersidmembercustomboardbackgrounds-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Custom Board Backgrounds to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Customboardbackgrounds"]}}, "/members/{idMember}/customBoardBackgrounds/{idBoardBackground}"=>{"delete"=>{"summary"=>"Delete Members Customboardbackgrounds Boardbackground", "description"=>"Delete members customboardbackgrounds boardbackground.", "operationId"=>"deleteMembersCustomBoardBackgroundsByIdMemberByIdBoardBackground", "x-api-path-slug"=>"membersidmembercustomboardbackgroundsidboardbackground-delete", "parameters"=>[{"in"=>"path", "name"=>"idBoardBackground", "description"=>"idBoardBackground"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Customboardbackgrounds", "Boardbackground"]}, "get"=>{"summary"=>"Get Members Customboardbackgrounds Boardbackground", "description"=>"Get members customboardbackgrounds boardbackground.", "operationId"=>"getMembersCustomBoardBackgroundsByIdMemberByIdBoardBackground", "x-api-path-slug"=>"membersidmembercustomboardbackgroundsidboardbackground-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: brightness, fullSizeUrl, scaled or tile"}, {"in"=>"path", "name"=>"idBoardBackground", "description"=>"idBoardBackground"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Customboardbackgrounds", "Boardbackground"]}, "put"=>{"summary"=>"Put Members Customboardbackgrounds Boardbackground", "description"=>"Put members customboardbackgrounds boardbackground.", "operationId"=>"updateMembersCustomBoardBackgroundsByIdMemberByIdBoardBackground", "x-api-path-slug"=>"membersidmembercustomboardbackgroundsidboardbackground-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Custom Board Backgrounds to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idBoardBackground", "description"=>"idBoardBackground"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Customboardbackgrounds", "Boardbackground"]}}, "/members/{idMember}/customEmoji"=>{"get"=>{"summary"=>"Get Members Customemoji", "description"=>"Get members customemoji.", "operationId"=>"getMembersCustomEmojiByIdMember", "x-api-path-slug"=>"membersidmembercustomemoji-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"One of: all or none"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Customemoji"]}, "post"=>{"summary"=>"Post Members Customemoji", "description"=>"Post members customemoji.", "operationId"=>"addMembersCustomEmojiByIdMember", "x-api-path-slug"=>"membersidmembercustomemoji-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Custom Emoji to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Customemoji"]}}, "/members/{idMember}/customEmoji/{idCustomEmoji}"=>{"get"=>{"summary"=>"Get Members Customemoji Customemoji", "description"=>"Get members customemoji customemoji.", "operationId"=>"getMembersCustomEmojiByIdMemberByIdCustomEmoji", "x-api-path-slug"=>"membersidmembercustomemojiidcustomemoji-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: name or url"}, {"in"=>"path", "name"=>"idCustomEmoji", "description"=>"idCustomEmoji"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Customemoji", "Customemoji"]}}, "/members/{idMember}/customStickers"=>{"get"=>{"summary"=>"Get Members Customstickers", "description"=>"Get members customstickers.", "operationId"=>"getMembersCustomStickersByIdMember", "x-api-path-slug"=>"membersidmembercustomstickers-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"One of: all or none"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Customstickers"]}, "post"=>{"summary"=>"Post Members Customstickers", "description"=>"Post members customstickers.", "operationId"=>"addMembersCustomStickersByIdMember", "x-api-path-slug"=>"membersidmembercustomstickers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Custom Stickers to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Customstickers"]}}, "/members/{idMember}/customStickers/{idCustomSticker}"=>{"delete"=>{"summary"=>"Delete Members Customstickers Customsticker", "description"=>"Delete members customstickers customsticker.", "operationId"=>"deleteMembersCustomStickersByIdMemberByIdCustomSticker", "x-api-path-slug"=>"membersidmembercustomstickersidcustomsticker-delete", "parameters"=>[{"in"=>"path", "name"=>"idCustomSticker", "description"=>"idCustomSticker"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Customstickers", "Customsticker"]}, "get"=>{"summary"=>"Get Members Customstickers Customsticker", "description"=>"Get members customstickers customsticker.", "operationId"=>"getMembersCustomStickersByIdMemberByIdCustomSticker", "x-api-path-slug"=>"membersidmembercustomstickersidcustomsticker-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: scaled or url"}, {"in"=>"path", "name"=>"idCustomSticker", "description"=>"idCustomSticker"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Customstickers", "Customsticker"]}}, "/members/{idMember}/deltas"=>{"get"=>{"summary"=>"Get Members Deltas", "description"=>"Get members deltas.", "operationId"=>"getMembersDeltasByIdMember", "x-api-path-slug"=>"membersidmemberdeltas-get", "parameters"=>[{"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"ixLastUpdate", "description"=>"a number from -1 to Infinity"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"tags", "description"=>"A valid tag for subscribing"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Deltas"]}}, "/members/{idMember}/fullName"=>{"put"=>{"summary"=>"Put Members Fullname", "description"=>"Put members fullname.", "operationId"=>"updateMembersFullNameByIdMember", "x-api-path-slug"=>"membersidmemberfullname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Full Name to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Fullname"]}}, "/members/{idMember}/initials"=>{"put"=>{"summary"=>"Put Members Initials", "description"=>"Put members initials.", "operationId"=>"updateMembersInitialsByIdMember", "x-api-path-slug"=>"membersidmemberinitials-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Initials to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Initials"]}}, "/members/{idMember}/notifications"=>{"get"=>{"summary"=>"Get Members Notifications", "description"=>"Get members notifications.", "operationId"=>"getMembersNotificationsByIdMember", "x-api-path-slug"=>"membersidmembernotifications-get", "parameters"=>[{"in"=>"query", "name"=>"before", "description"=>"An id, or null"}, {"in"=>"query", "name"=>"display", "description"=>"true or false"}, {"in"=>"query", "name"=>"entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator, type or unread"}, {"in"=>"query", "name"=>"filter", "description"=>"all or a comma-separated list of: addAdminToBoard, addAdminToOrganization, addedAttachmentToCard, addedMemberToCard, addedToBoard, addedToCard, addedToOrganization, cardDueSoon, changeCard, closeBoard, commentCard, createdCard, declinedInvitationToBoard, declinedInvitationToOrganization, invitedToBoard, invitedToOrganization, makeAdminOfBoard, makeAdminOfOrganization, memberJoinedTrello, mentionedOnCard, removedFromBoard, removedFromCard, removedFromOrganization, removedMemberFromCard, unconfirmedInvitedToBoard, unconfirmedInvitedToOrganization or updateCheckItemStateOnCard"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"limit", "description"=>"a number from 1 to 1000"}, {"in"=>"query", "name"=>"memberCreator", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberCreator_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"page", "description"=>"a number from 0 to 100"}, {"in"=>"query", "name"=>"read_filter", "description"=>"One of: all, read or unread"}, {"in"=>"query", "name"=>"since", "description"=>"An id, or null"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Notifications"]}}, "/members/{idMember}/notifications/{filter}"=>{"get"=>{"summary"=>"Get Members Notifications Filter", "description"=>"Get members notifications filter.", "operationId"=>"getMembersNotificationsByIdMemberByFilter", "x-api-path-slug"=>"membersidmembernotificationsfilter-get", "parameters"=>[{"in"=>"path", "name"=>"filter", "description"=>"filter"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Notifications", "Filter"]}}, "/members/{idMember}/oneTimeMessagesDismissed"=>{"post"=>{"summary"=>"Post Members Onetimemessagesdismissed", "description"=>"Post members onetimemessagesdismissed.", "operationId"=>"addMembersOneTimeMessagesDismissedByIdMember", "x-api-path-slug"=>"membersidmemberonetimemessagesdismissed-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members One Time Messages Dismissed to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Onetimemessagesdismissed"]}}, "/members/{idMember}/organizations"=>{"get"=>{"summary"=>"Get Members Organizations", "description"=>"Get members organizations.", "operationId"=>"getMembersOrganizationsByIdMember", "x-api-path-slug"=>"membersidmemberorganizations-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website"}, {"in"=>"query", "name"=>"filter", "description"=>"One of: all, members, none or public"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"paid_account", "description"=>"true or false"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Organizations"]}}, "/members/{idMember}/organizations/{filter}"=>{"get"=>{"summary"=>"Get Members Organizations Filter", "description"=>"Get members organizations filter.", "operationId"=>"getMembersOrganizationsByIdMemberByFilter", "x-api-path-slug"=>"membersidmemberorganizationsfilter-get", "parameters"=>[{"in"=>"path", "name"=>"filter", "description"=>"filter"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Organizations", "Filter"]}}, "/members/{idMember}/organizationsInvited"=>{"get"=>{"summary"=>"Get Members Organizationsinvited", "description"=>"Get members organizationsinvited.", "operationId"=>"getMembersOrganizationsInvitedByIdMember", "x-api-path-slug"=>"membersidmemberorganizationsinvited-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Organizationsinvited"]}}, "/members/{idMember}/organizationsInvited/{field}"=>{"get"=>{"summary"=>"Get Members Organizationsinvited Field", "description"=>"Get members organizationsinvited field.", "operationId"=>"getMembersOrganizationsInvitedByIdMemberByField", "x-api-path-slug"=>"membersidmemberorganizationsinvitedfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Organizationsinvited", "Field"]}}, "/members/{idMember}/prefs/colorBlind"=>{"put"=>{"summary"=>"Put Members Preferences Colorblind", "description"=>"Put members preferences colorblind.", "operationId"=>"updateMembersPrefsColorBlindByIdMember", "x-api-path-slug"=>"membersidmemberprefscolorblind-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Color Blind to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Preferences", "Colorblind"]}}, "/members/{idMember}/prefs/locale"=>{"put"=>{"summary"=>"Put Members Preferences Locale", "description"=>"Put members preferences locale.", "operationId"=>"updateMembersPrefsLocaleByIdMember", "x-api-path-slug"=>"membersidmemberprefslocale-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Locale to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Preferences", "Locale"]}}, "/members/{idMember}/prefs/minutesBetweenSummaries"=>{"put"=>{"summary"=>"Put Members Preferences Minutesbetweensummaries", "description"=>"Put members preferences minutesbetweensummaries.", "operationId"=>"updateMembersPrefsMinutesBetweenSummariesByIdMember", "x-api-path-slug"=>"membersidmemberprefsminutesbetweensummaries-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Minutes Between Summaries to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Preferences", "Minutesbetweensummaries"]}}, "/members/{idMember}/savedSearches"=>{"get"=>{"summary"=>"Get Members Savedsearches", "description"=>"Get members savedsearches.", "operationId"=>"getMembersSavedSearchesByIdMember", "x-api-path-slug"=>"membersidmembersavedsearches-get", "parameters"=>[{"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Savedsearches"]}, "post"=>{"summary"=>"Post Members Savedsearches", "description"=>"Post members savedsearches.", "operationId"=>"addMembersSavedSearchesByIdMember", "x-api-path-slug"=>"membersidmembersavedsearches-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Saved Searches to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Savedsearches"]}}, "/members/{idMember}/savedSearches/{idSavedSearch}"=>{"delete"=>{"summary"=>"Delete Members Savedsearches Savedsearch", "description"=>"Delete members savedsearches savedsearch.", "operationId"=>"deleteMembersSavedSearchesByIdMemberByIdSavedSearch", "x-api-path-slug"=>"membersidmembersavedsearchesidsavedsearch-delete", "parameters"=>[{"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"path", "name"=>"idSavedSearch", "description"=>"idSavedSearch"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Savedsearches", "Savedsearch"]}, "get"=>{"summary"=>"Get Members Savedsearches Savedsearch", "description"=>"Get members savedsearches savedsearch.", "operationId"=>"getMembersSavedSearchesByIdMemberByIdSavedSearch", "x-api-path-slug"=>"membersidmembersavedsearchesidsavedsearch-get", "parameters"=>[{"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"path", "name"=>"idSavedSearch", "description"=>"idSavedSearch"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Savedsearches", "Savedsearch"]}, "put"=>{"summary"=>"Put Members Savedsearches Savedsearch", "description"=>"Put members savedsearches savedsearch.", "operationId"=>"updateMembersSavedSearchesByIdMemberByIdSavedSearch", "x-api-path-slug"=>"membersidmembersavedsearchesidsavedsearch-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Saved Searches to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"path", "name"=>"idSavedSearch", "description"=>"idSavedSearch"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Savedsearches", "Savedsearch"]}}, "/members/{idMember}/savedSearches/{idSavedSearch}/name"=>{"put"=>{"summary"=>"Put Members Savedsearches Savedsearch Name", "description"=>"Put members savedsearches savedsearch name.", "operationId"=>"updateMembersSavedSearchesNameByIdMemberByIdSavedSearch", "x-api-path-slug"=>"membersidmembersavedsearchesidsavedsearchname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Saved Searches Name to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"path", "name"=>"idSavedSearch", "description"=>"idSavedSearch"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Savedsearches", "Savedsearch", "Name"]}}, "/members/{idMember}/savedSearches/{idSavedSearch}/pos"=>{"put"=>{"summary"=>"Put Members Savedsearches Savedsearch Pos", "description"=>"Put members savedsearches savedsearch pos.", "operationId"=>"updateMembersSavedSearchesPosByIdMemberByIdSavedSearch", "x-api-path-slug"=>"membersidmembersavedsearchesidsavedsearchpos-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Saved Searches Pos to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"path", "name"=>"idSavedSearch", "description"=>"idSavedSearch"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Savedsearches", "Savedsearch", "Pos"]}}, "/members/{idMember}/savedSearches/{idSavedSearch}/query"=>{"put"=>{"summary"=>"Put Members Savedsearches Savedsearch Query", "description"=>"Put members savedsearches savedsearch query.", "operationId"=>"updateMembersSavedSearchesQueryByIdMemberByIdSavedSearch", "x-api-path-slug"=>"membersidmembersavedsearchesidsavedsearchquery-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Saved Searches Query to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"path", "name"=>"idSavedSearch", "description"=>"idSavedSearch"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Savedsearches", "Savedsearch", "Query"]}}, "/members/{idMember}/tokens"=>{"get"=>{"summary"=>"Get Members Tokens", "description"=>"Get members tokens.", "operationId"=>"getMembersTokensByIdMember", "x-api-path-slug"=>"membersidmembertokens-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"One of: all or none"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Tokens"]}}, "/members/{idMember}/username"=>{"put"=>{"summary"=>"Put Members Username", "description"=>"Put members username.", "operationId"=>"updateMembersUsernameByIdMember", "x-api-path-slug"=>"membersidmemberusername-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Members Username to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Username"]}}, "/members/{idMember}/{field}"=>{"get"=>{"summary"=>"Get Members Field", "description"=>"Get members field.", "operationId"=>"getMembersByIdMemberByField", "x-api-path-slug"=>"membersidmemberfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Members", "Field"]}}, "/notifications/all/read"=>{"post"=>{"summary"=>"Post Notifications All Read", "description"=>"Post notifications all read.", "operationId"=>"addNotificationsAllRead", "x-api-path-slug"=>"notificationsallread-post", "parameters"=>[{"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "", "Read"]}}, "/notifications/{idNotification}"=>{"get"=>{"summary"=>"Get Notifications Notification", "description"=>"Get notifications notification.", "operationId"=>"getNotificationsByIdNotification", "x-api-path-slug"=>"notificationsidnotification-get", "parameters"=>[{"in"=>"query", "name"=>"board", "description"=>"true or false"}, {"in"=>"query", "name"=>"board_fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"query", "name"=>"card", "description"=>"true or false"}, {"in"=>"query", "name"=>"card_fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"query", "name"=>"display", "description"=>"true or false"}, {"in"=>"query", "name"=>"entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator, type or unread"}, {"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"list", "description"=>"true or false"}, {"in"=>"query", "name"=>"member", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberCreator", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberCreator_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"organization", "description"=>"true or false"}, {"in"=>"query", "name"=>"organization_fields", "description"=>"all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification"]}, "put"=>{"summary"=>"Put Notifications Notification", "description"=>"Put notifications notification.", "operationId"=>"updateNotificationsByIdNotification", "x-api-path-slug"=>"notificationsidnotification-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Notifications to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification"]}}, "/notifications/{idNotification}/board"=>{"get"=>{"summary"=>"Get Notifications Notification Board", "description"=>"Get notifications notification board.", "operationId"=>"getNotificationsBoardByIdNotification", "x-api-path-slug"=>"notificationsidnotificationboard-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification", "Board"]}}, "/notifications/{idNotification}/board/{field}"=>{"get"=>{"summary"=>"Get Notifications Notification Board Field", "description"=>"Get notifications notification board field.", "operationId"=>"getNotificationsBoardByIdNotificationByField", "x-api-path-slug"=>"notificationsidnotificationboardfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification", "Board", "Field"]}}, "/notifications/{idNotification}/card"=>{"get"=>{"summary"=>"Get Notifications Notification Card", "description"=>"Get notifications notification card.", "operationId"=>"getNotificationsCardByIdNotification", "x-api-path-slug"=>"notificationsidnotificationcard-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification", "Card"]}}, "/notifications/{idNotification}/card/{field}"=>{"get"=>{"summary"=>"Get Notifications Notification Card Field", "description"=>"Get notifications notification card field.", "operationId"=>"getNotificationsCardByIdNotificationByField", "x-api-path-slug"=>"notificationsidnotificationcardfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification", "Card", "Field"]}}, "/notifications/{idNotification}/display"=>{"get"=>{"summary"=>"Get Notifications Notification Display", "description"=>"Get notifications notification display.", "operationId"=>"getNotificationsDisplayByIdNotification", "x-api-path-slug"=>"notificationsidnotificationdisplay-get", "parameters"=>[{"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification", "Display"]}}, "/notifications/{idNotification}/entities"=>{"get"=>{"summary"=>"Get Notifications Notification Entities", "description"=>"Get notifications notification entities.", "operationId"=>"getNotificationsEntitiesByIdNotification", "x-api-path-slug"=>"notificationsidnotificationentities-get", "parameters"=>[{"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification", "Entities"]}}, "/notifications/{idNotification}/list"=>{"get"=>{"summary"=>"Get Notifications Notification List", "description"=>"Get notifications notification list.", "operationId"=>"getNotificationsListByIdNotification", "x-api-path-slug"=>"notificationsidnotificationlist-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: closed, idBoard, name, pos or subscribed"}, {"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification", "List"]}}, "/notifications/{idNotification}/list/{field}"=>{"get"=>{"summary"=>"Get Notifications Notification List Field", "description"=>"Get notifications notification list field.", "operationId"=>"getNotificationsListByIdNotificationByField", "x-api-path-slug"=>"notificationsidnotificationlistfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification", "List", "Field"]}}, "/notifications/{idNotification}/member"=>{"get"=>{"summary"=>"Get Notifications Notification Member", "description"=>"Get notifications notification member.", "operationId"=>"getNotificationsMemberByIdNotification", "x-api-path-slug"=>"notificationsidnotificationmember-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username"}, {"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification", "Member"]}}, "/notifications/{idNotification}/member/{field}"=>{"get"=>{"summary"=>"Get Notifications Notification Member Field", "description"=>"Get notifications notification member field.", "operationId"=>"getNotificationsMemberByIdNotificationByField", "x-api-path-slug"=>"notificationsidnotificationmemberfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification", "Member", "Field"]}}, "/notifications/{idNotification}/memberCreator"=>{"get"=>{"summary"=>"Get Notifications Notification Member Creator", "description"=>"Get notifications notification member creator.", "operationId"=>"getNotificationsMemberCreatorByIdNotification", "x-api-path-slug"=>"notificationsidnotificationmembercreator-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username"}, {"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification", "Member", "Creator"]}}, "/notifications/{idNotification}/memberCreator/{field}"=>{"get"=>{"summary"=>"Get Notifications Notification Member Creator Field", "description"=>"Get notifications notification member creator field.", "operationId"=>"getNotificationsMemberCreatorByIdNotificationByField", "x-api-path-slug"=>"notificationsidnotificationmembercreatorfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification", "Member", "Creator", "Field"]}}, "/notifications/{idNotification}/organization"=>{"get"=>{"summary"=>"Get Notifications Notification Organization", "description"=>"Get notifications notification organization.", "operationId"=>"getNotificationsOrganizationByIdNotification", "x-api-path-slug"=>"notificationsidnotificationorganization-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website"}, {"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification", "Organization"]}}, "/notifications/{idNotification}/organization/{field}"=>{"get"=>{"summary"=>"Get Notifications Notification Organization Field", "description"=>"Get notifications notification organization field.", "operationId"=>"getNotificationsOrganizationByIdNotificationByField", "x-api-path-slug"=>"notificationsidnotificationorganizationfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification", "Organization", "Field"]}}, "/notifications/{idNotification}/unread"=>{"put"=>{"summary"=>"Put Notifications Notification Unread", "description"=>"Put notifications notification unread.", "operationId"=>"updateNotificationsUnreadByIdNotification", "x-api-path-slug"=>"notificationsidnotificationunread-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Notifications Unread to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification", "Unread"]}}, "/notifications/{idNotification}/{field}"=>{"get"=>{"summary"=>"Get Notifications Notification Field", "description"=>"Get notifications notification field.", "operationId"=>"getNotificationsByIdNotificationByField", "x-api-path-slug"=>"notificationsidnotificationfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idNotification", "description"=>"idNotification"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications", "Notification", "Field"]}}, "/organizations"=>{"post"=>{"summary"=>"Post Organizations", "description"=>"Post organizations.", "operationId"=>"addOrganizations", "x-api-path-slug"=>"organizations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Organizations to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}, "/organizations/{idOrg}"=>{"delete"=>{"summary"=>"Delete Organizations", "description"=>"Delete organizations.", "operationId"=>"deleteOrganizationsByIdOrg", "x-api-path-slug"=>"organizationsidorg-delete", "parameters"=>[{"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}, "get"=>{"summary"=>"Get Organizations", "description"=>"Get organizations.", "operationId"=>"getOrganizationsByIdOrg", "x-api-path-slug"=>"organizationsidorg-get", "parameters"=>[{"in"=>"query", "name"=>"actions", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"actions_display", "description"=>"true or false"}, {"in"=>"query", "name"=>"actions_entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"actions_limit", "description"=>"a number from 0 to 1000"}, {"in"=>"query", "name"=>"action_fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator or type"}, {"in"=>"query", "name"=>"boards", "description"=>"all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned"}, {"in"=>"query", "name"=>"board_actions", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"board_actions_display", "description"=>"true or false"}, {"in"=>"query", "name"=>"board_actions_entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"board_actions_format", "description"=>"One of: count, list or minimal"}, {"in"=>"query", "name"=>"board_actions_limit", "description"=>"a number from 0 to 1000"}, {"in"=>"query", "name"=>"board_actions_since", "description"=>"A date, null or lastView"}, {"in"=>"query", "name"=>"board_action_fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator or type"}, {"in"=>"query", "name"=>"board_fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"query", "name"=>"board_lists", "description"=>"One of: all, closed, none or open"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"members", "description"=>"One of: admins, all, none, normal or owners"}, {"in"=>"query", "name"=>"memberships", "description"=>"all or a comma-separated list of: active, admin, deactivated, me or normal"}, {"in"=>"query", "name"=>"memberships_member", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberships_member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"membersInvited", "description"=>"One of: admins, all, none, normal or owners"}, {"in"=>"query", "name"=>"membersInvited_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"member_activity", "description"=>"true or false ; works for premium organizations only"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"paid_account", "description"=>"true or false"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}, "put"=>{"summary"=>"Put Organizations", "description"=>"Put organizations.", "operationId"=>"updateOrganizationsByIdOrg", "x-api-path-slug"=>"organizationsidorg-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Organizations to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}, "/organizations/{idOrg}/actions"=>{"get"=>{"summary"=>"Get Organizations Actions", "description"=>"Get organizations actions.", "operationId"=>"getOrganizationsActionsByIdOrg", "x-api-path-slug"=>"organizationsidorgactions-get", "parameters"=>[{"in"=>"query", "name"=>"before", "description"=>"A date, or null"}, {"in"=>"query", "name"=>"display", "description"=>"true or false"}, {"in"=>"query", "name"=>"entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator or type"}, {"in"=>"query", "name"=>"filter", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"format", "description"=>"One of: count, list or minimal"}, {"in"=>"query", "name"=>"idModels", "description"=>"Only return actions related to these model ids"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"limit", "description"=>"a number from 0 to 1000"}, {"in"=>"query", "name"=>"member", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberCreator", "description"=>"true or false"}, {"in"=>"query", "name"=>"memberCreator_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"page", "description"=>"Page * limit must be less than 1000"}, {"in"=>"query", "name"=>"since", "description"=>"A date, null or lastView"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Actions"]}}, "/organizations/{idOrg}/boards"=>{"get"=>{"summary"=>"Get Organizations Boards", "description"=>"Get organizations boards.", "operationId"=>"getOrganizationsBoardsByIdOrg", "x-api-path-slug"=>"organizationsidorgboards-get", "parameters"=>[{"in"=>"query", "name"=>"actions", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"actions_entities", "description"=>"true or false"}, {"in"=>"query", "name"=>"actions_format", "description"=>"One of: count, list or minimal"}, {"in"=>"query", "name"=>"actions_limit", "description"=>"a number from 0 to 1000"}, {"in"=>"query", "name"=>"actions_since", "description"=>"A date, null or lastView"}, {"in"=>"query", "name"=>"action_fields", "description"=>"all or a comma-separated list of: data, date, idMemberCreator or type"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"query", "name"=>"filter", "description"=>"all or a comma-separated list of: closed, members, open, organization, pinned, public, starred or unpinned"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"lists", "description"=>"One of: all, closed, none or open"}, {"in"=>"query", "name"=>"memberships", "description"=>"all or a comma-separated list of: active, admin, deactivated, me or normal"}, {"in"=>"query", "name"=>"organization", "description"=>"true or false"}, {"in"=>"query", "name"=>"organization_fields", "description"=>"all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Boards"]}}, "/organizations/{idOrg}/boards/{filter}"=>{"get"=>{"summary"=>"Get Organizations Boards Filter", "description"=>"Get organizations boards filter.", "operationId"=>"getOrganizationsBoardsByIdOrgByFilter", "x-api-path-slug"=>"organizationsidorgboardsfilter-get", "parameters"=>[{"in"=>"path", "name"=>"filter", "description"=>"filter"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Boards", "Filter"]}}, "/organizations/{idOrg}/deltas"=>{"get"=>{"summary"=>"Get Organizations Deltas", "description"=>"Get organizations deltas.", "operationId"=>"getOrganizationsDeltasByIdOrg", "x-api-path-slug"=>"organizationsidorgdeltas-get", "parameters"=>[{"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"ixLastUpdate", "description"=>"a number from -1 to Infinity"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"tags", "description"=>"A valid tag for subscribing"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Deltas"]}}, "/organizations/{idOrg}/desc"=>{"put"=>{"summary"=>"Put Organizations Desc", "description"=>"Put organizations desc.", "operationId"=>"updateOrganizationsDescByIdOrg", "x-api-path-slug"=>"organizationsidorgdesc-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Organizations Desc to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Desc"]}}, "/organizations/{idOrg}/displayName"=>{"put"=>{"summary"=>"Put Organizations Displayname", "description"=>"Put organizations displayname.", "operationId"=>"updateOrganizationsDisplayNameByIdOrg", "x-api-path-slug"=>"organizationsidorgdisplayname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Organizations Display Name to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Displayname"]}}, "/organizations/{idOrg}/logo"=>{"delete"=>{"summary"=>"Delete Organizations Logo", "description"=>"Delete organizations logo.", "operationId"=>"deleteOrganizationsLogoByIdOrg", "x-api-path-slug"=>"organizationsidorglogo-delete", "parameters"=>[{"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Logo"]}, "post"=>{"summary"=>"Post Organizations Logo", "description"=>"Post organizations logo.", "operationId"=>"addOrganizationsLogoByIdOrg", "x-api-path-slug"=>"organizationsidorglogo-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Organizations Logo to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Logo"]}}, "/organizations/{idOrg}/members"=>{"get"=>{"summary"=>"Get Organizations Members", "description"=>"Get organizations members.", "operationId"=>"getOrganizationsMembersByIdOrg", "x-api-path-slug"=>"organizationsidorgmembers-get", "parameters"=>[{"in"=>"query", "name"=>"activity", "description"=>"true or false ; works for premium organizations only"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"filter", "description"=>"One of: admins, all, none, normal or owners"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Members"]}, "put"=>{"summary"=>"Put Organizations Members", "description"=>"Put organizations members.", "operationId"=>"updateOrganizationsMembersByIdOrg", "x-api-path-slug"=>"organizationsidorgmembers-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Organizations Members to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Members"]}}, "/organizations/{idOrg}/members/{filter}"=>{"get"=>{"summary"=>"Get Organizations Members Filter", "description"=>"Get organizations members filter.", "operationId"=>"getOrganizationsMembersByIdOrgByFilter", "x-api-path-slug"=>"organizationsidorgmembersfilter-get", "parameters"=>[{"in"=>"path", "name"=>"filter", "description"=>"filter"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Members", "Filter"]}}, "/organizations/{idOrg}/members/{idMember}"=>{"delete"=>{"summary"=>"Delete Organizations Members", "description"=>"Delete organizations members.", "operationId"=>"deleteOrganizationsMembersByIdOrgByIdMember", "x-api-path-slug"=>"organizationsidorgmembersidmember-delete", "parameters"=>[{"in"=>"path", "name"=>"idMember", "description"=>"idMember"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Members"]}, "put"=>{"summary"=>"Put Organizations Members", "description"=>"Put organizations members.", "operationId"=>"updateOrganizationsMembersByIdOrgByIdMember", "x-api-path-slug"=>"organizationsidorgmembersidmember-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Organizations Members to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Members"]}}, "/organizations/{idOrg}/members/{idMember}/all"=>{"delete"=>{"summary"=>"Delete Organizations Members All", "description"=>"Delete organizations members all.", "operationId"=>"deleteOrganizationsMembersAllByIdOrgByIdMember", "x-api-path-slug"=>"organizationsidorgmembersidmemberall-delete", "parameters"=>[{"in"=>"path", "name"=>"idMember", "description"=>"idMember"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Members"]}}, "/organizations/{idOrg}/members/{idMember}/cards"=>{"get"=>{"summary"=>"Get Organizations Members Cards", "description"=>"Get organizations members cards.", "operationId"=>"getOrganizationsMembersCardsByIdOrgByIdMember", "x-api-path-slug"=>"organizationsidorgmembersidmembercards-get", "parameters"=>[{"in"=>"query", "name"=>"actions", "description"=>"all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization"}, {"in"=>"query", "name"=>"attachments", "description"=>"A boolean value or "cover" for only card cover attachments"}, {"in"=>"query", "name"=>"attachment_fields", "description"=>"all or a comma-separated list of: bytes, date, edgeColor, idMember, isUpload, mimeType, name, previews or url"}, {"in"=>"query", "name"=>"board", "description"=>"true or false"}, {"in"=>"query", "name"=>"board_fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"query", "name"=>"checkItemStates", "description"=>"true or false"}, {"in"=>"query", "name"=>"checklists", "description"=>"One of: all or none"}, {"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"query", "name"=>"filter", "description"=>"One of: all, closed, none, open or visible"}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"list", "description"=>"true or false"}, {"in"=>"query", "name"=>"list_fields", "description"=>"all or a comma-separated list of: closed, idBoard, name, pos or subscribed"}, {"in"=>"query", "name"=>"members", "description"=>"true or false"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Members", "Cards"]}}, "/organizations/{idOrg}/members/{idMember}/deactivated"=>{"put"=>{"summary"=>"Put Organizations Members Deactivated", "description"=>"Put organizations members deactivated.", "operationId"=>"updateOrganizationsMembersDeactivatedByIdOrgByIdMember", "x-api-path-slug"=>"organizationsidorgmembersidmemberdeactivated-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Organizations Members Deactivated to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMember", "description"=>"idMember"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Members", "Deactivated"]}}, "/organizations/{idOrg}/membersInvited"=>{"get"=>{"summary"=>"Get Organizations Membersinvited", "description"=>"Get organizations membersinvited.", "operationId"=>"getOrganizationsMembersInvitedByIdOrg", "x-api-path-slug"=>"organizationsidorgmembersinvited-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Membersinvited"]}}, "/organizations/{idOrg}/membersInvited/{field}"=>{"get"=>{"summary"=>"Get Organizations Membersinvited Field", "description"=>"Get organizations membersinvited field.", "operationId"=>"getOrganizationsMembersInvitedByIdOrgByField", "x-api-path-slug"=>"organizationsidorgmembersinvitedfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Membersinvited", "Field"]}}, "/organizations/{idOrg}/memberships"=>{"get"=>{"summary"=>"Get Organizations Memberships", "description"=>"Get organizations memberships.", "operationId"=>"getOrganizationsMembershipsByIdOrg", "x-api-path-slug"=>"organizationsidorgmemberships-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"all or a comma-separated list of: active, admin, deactivated, me or normal"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"member", "description"=>"true or false"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Memberships"]}}, "/organizations/{idOrg}/memberships/{idMembership}"=>{"get"=>{"summary"=>"Get Organizations Memberships", "description"=>"Get organizations memberships.", "operationId"=>"getOrganizationsMembershipsByIdOrgByIdMembership", "x-api-path-slug"=>"organizationsidorgmembershipsidmembership-get", "parameters"=>[{"in"=>"path", "name"=>"idMembership", "description"=>"idMembership"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"member", "description"=>"true or false"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Memberships"]}, "put"=>{"summary"=>"Put Organizations Memberships", "description"=>"Put organizations memberships.", "operationId"=>"updateOrganizationsMembershipsByIdOrgByIdMembership", "x-api-path-slug"=>"organizationsidorgmembershipsidmembership-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Organizations Memberships to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idMembership", "description"=>"idMembership"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Memberships"]}}, "/organizations/{idOrg}/name"=>{"put"=>{"summary"=>"Put Organizations Name", "description"=>"Put organizations name.", "operationId"=>"updateOrganizationsNameByIdOrg", "x-api-path-slug"=>"organizationsidorgname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Organizations Name to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Name"]}}, "/organizations/{idOrg}/prefs/associatedDomain"=>{"delete"=>{"summary"=>"Delete Organizations Preferences Associateddomain", "description"=>"Delete organizations preferences associateddomain.", "operationId"=>"deleteOrganizationsPrefsAssociatedDomainByIdOrg", "x-api-path-slug"=>"organizationsidorgprefsassociateddomain-delete", "parameters"=>[{"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Preferences", "Associateddomain"]}, "put"=>{"summary"=>"Put Organizations Preferences Associateddomain", "description"=>"Put organizations preferences associateddomain.", "operationId"=>"updateOrganizationsPrefsAssociatedDomainByIdOrg", "x-api-path-slug"=>"organizationsidorgprefsassociateddomain-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Associated Domain to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Preferences", "Associateddomain"]}}, "/organizations/{idOrg}/prefs/boardVisibilityRestrict/org"=>{"put"=>{"summary"=>"Put Organizations Preferences Boardvisibilityrestrict Org", "description"=>"Put organizations preferences boardvisibilityrestrict org.", "operationId"=>"updateOrganizationsPrefsBoardVisibilityRestrictOrgByIdOrg", "x-api-path-slug"=>"organizationsidorgprefsboardvisibilityrestrictorg-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Board Visibility Restrict to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Preferences", "Boardvisibilityrestrict", "Org"]}}, "/organizations/{idOrg}/prefs/boardVisibilityRestrict/private"=>{"put"=>{"summary"=>"Put Organizations Preferences Boardvisibilityrestrict Private", "description"=>"Put organizations preferences boardvisibilityrestrict private.", "operationId"=>"updateOrganizationsPrefsBoardVisibilityRestrictPrivateByIdOrg", "x-api-path-slug"=>"organizationsidorgprefsboardvisibilityrestrictprivate-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Board Visibility Restrict to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Preferences", "Boardvisibilityrestrict", "Private"]}}, "/organizations/{idOrg}/prefs/boardVisibilityRestrict/public"=>{"put"=>{"summary"=>"Put Organizations Preferences Boardvisibilityrestrict Public", "description"=>"Put organizations preferences boardvisibilityrestrict public.", "operationId"=>"updateOrganizationsPrefsBoardVisibilityRestrictPublicByIdOrg", "x-api-path-slug"=>"organizationsidorgprefsboardvisibilityrestrictpublic-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Board Visibility Restrict to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Preferences", "Boardvisibilityrestrict", "Public"]}}, "/organizations/{idOrg}/prefs/externalMembersDisabled"=>{"put"=>{"summary"=>"Put Organizations Preferences Externalmembersdisabled", "description"=>"Put organizations preferences externalmembersdisabled.", "operationId"=>"updateOrganizationsPrefsExternalMembersDisabledByIdOrg", "x-api-path-slug"=>"organizationsidorgprefsexternalmembersdisabled-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs External Members Disabled to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Preferences", "Externalmembersdisabled"]}}, "/organizations/{idOrg}/prefs/googleAppsVersion"=>{"put"=>{"summary"=>"Put Organizations Preferences Googleappsversion", "description"=>"Put organizations preferences googleappsversion.", "operationId"=>"updateOrganizationsPrefsGoogleAppsVersionByIdOrg", "x-api-path-slug"=>"organizationsidorgprefsgoogleappsversion-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Google Apps Version to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Preferences", "Googleappsversion"]}}, "/organizations/{idOrg}/prefs/orgInviteRestrict"=>{"delete"=>{"summary"=>"Delete Organizations Preferences Orginviterestrict", "description"=>"Delete organizations preferences orginviterestrict.", "operationId"=>"deleteOrganizationsPrefsOrgInviteRestrictByIdOrg", "x-api-path-slug"=>"organizationsidorgprefsorginviterestrict-delete", "parameters"=>[{"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}, {"in"=>"query", "name"=>"value", "description"=>"An email address with optional expansion tokens"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Preferences", "Orginviterestrict"]}, "put"=>{"summary"=>"Put Organizations Preferences Orginviterestrict", "description"=>"Put organizations preferences orginviterestrict.", "operationId"=>"updateOrganizationsPrefsOrgInviteRestrictByIdOrg", "x-api-path-slug"=>"organizationsidorgprefsorginviterestrict-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Org Invite Restrict to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Preferences", "Orginviterestrict"]}}, "/organizations/{idOrg}/prefs/permissionLevel"=>{"put"=>{"summary"=>"Put Organizations Preferences Permissionlevel", "description"=>"Put organizations preferences permissionlevel.", "operationId"=>"updateOrganizationsPrefsPermissionLevelByIdOrg", "x-api-path-slug"=>"organizationsidorgprefspermissionlevel-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Prefs Permission Level to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Preferences", "Permissionlevel"]}}, "/organizations/{idOrg}/website"=>{"put"=>{"summary"=>"Put Organizations Website", "description"=>"Put organizations website.", "operationId"=>"updateOrganizationsWebsiteByIdOrg", "x-api-path-slug"=>"organizationsidorgwebsite-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Organizations Website to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Website"]}}, "/organizations/{idOrg}/{field}"=>{"get"=>{"summary"=>"Get Organizations Field", "description"=>"Get organizations field.", "operationId"=>"getOrganizationsByIdOrgByField", "x-api-path-slug"=>"organizationsidorgfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idOrg", "description"=>"idOrg or name"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations", "Field"]}}, "/search"=>{"get"=>{"summary"=>"Get Search", "description"=>"Get search.", "operationId"=>"getSearch", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"boards_limit", "description"=>"a number from 1 to 1000"}, {"in"=>"query", "name"=>"board_fields", "description"=>"all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed or url"}, {"in"=>"query", "name"=>"cards_limit", "description"=>"a number from 1 to 1000"}, {"in"=>"query", "name"=>"cards_page", "description"=>"a number from 0 to 100"}, {"in"=>"query", "name"=>"card_attachments", "description"=>"A boolean value or "cover" for only card cover attachments"}, {"in"=>"query", "name"=>"card_board", "description"=>"true or false"}, {"in"=>"query", "name"=>"card_fields", "description"=>"all or a comma-separated list of: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idAttachmentCover, idBoard, idChecklists, idLabels, idList, idMembers, idMembersVoted, idShort, labels, manualCoverAttachment, name, pos, shortLink, shortUrl, subscribed or url"}, {"in"=>"query", "name"=>"card_list", "description"=>"true or false"}, {"in"=>"query", "name"=>"card_members", "description"=>"true or false"}, {"in"=>"query", "name"=>"card_stickers", "description"=>"true or false"}, {"in"=>"query", "name"=>"idBoards", "description"=>"A comma-separated list of objectIds, 24-character hex strings"}, {"in"=>"query", "name"=>"idCards", "description"=>"A comma-separated list of objectIds, 24-character hex strings"}, {"in"=>"query", "name"=>"idOrganizations", "description"=>"A comma-separated list of objectIds, 24-character hex strings"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"members_limit", "description"=>"a number from 1 to 1000"}, {"in"=>"query", "name"=>"member_fields", "description"=>"all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"}, {"in"=>"query", "name"=>"modelTypes", "description"=>"all or a comma-separated list of: actions, boards, cards, members or organizations"}, {"in"=>"query", "name"=>"organizations_limit", "description"=>"a number from 1 to 1000"}, {"in"=>"query", "name"=>"organization_fields", "description"=>"all or a comma-separated list of: billableMemberCount, desc, descData, displayName, idBoards, invitations, invited, logoHash, memberships, name, powerUps, prefs, premiumFeatures, products, url or website"}, {"in"=>"query", "name"=>"partial", "description"=>"true or false"}, {"in"=>"query", "name"=>"query", "description"=>"a string with a length from 1 to 16384"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}, "/search/members"=>{"get"=>{"summary"=>"Get Search Members", "description"=>"Get search members.", "operationId"=>"getSearchMembers", "x-api-path-slug"=>"searchmembers-get", "parameters"=>[{"in"=>"query", "name"=>"idBoard", "description"=>"An id, or null"}, {"in"=>"query", "name"=>"idOrganization", "description"=>"An id, or null"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"limit", "description"=>"a number from 1 to 20"}, {"in"=>"query", "name"=>"onlyOrgMembers", "description"=>"A boolean"}, {"in"=>"query", "name"=>"query", "description"=>"a string with a length from 1 to 16384"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Members"]}}, "/sessions"=>{"post"=>{"summary"=>"Post Sessions", "description"=>"Post sessions.", "operationId"=>"addSessions", "x-api-path-slug"=>"sessions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Sessions to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions"]}}, "/sessions/socket"=>{"get"=>{"summary"=>"Get Sessions Socket", "description"=>"Get sessions socket.", "operationId"=>"getSessionsSocket", "x-api-path-slug"=>"sessionssocket-get", "parameters"=>[{"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions", "Socket"]}}, "/sessions/{idSession}"=>{"put"=>{"summary"=>"Put Sessions", "description"=>"Put sessions.", "operationId"=>"updateSessionsByIdSession", "x-api-path-slug"=>"sessionsidsession-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Sessions to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idSession", "description"=>"idSession"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions"]}}, "/sessions/{idSession}/status"=>{"put"=>{"summary"=>"Put Sessions Status", "description"=>"Put sessions status.", "operationId"=>"updateSessionsStatusByIdSession", "x-api-path-slug"=>"sessionsidsessionstatus-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Sessions Status to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idSession", "description"=>"idSession"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sessions", "Status"]}}, "/tokens/{token}"=>{"delete"=>{"summary"=>"Delete Tokens", "description"=>"Delete tokens.", "operationId"=>"deleteTokensByToken", "x-api-path-slug"=>"tokenstoken-delete", "parameters"=>[{"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"path", "name"=>"token", "description"=>"token"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tokens"]}, "get"=>{"summary"=>"Get Tokens", "description"=>"Get tokens.", "operationId"=>"getTokensByToken", "x-api-path-slug"=>"tokenstoken-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: dateCreated, dateExpires, idMember, identifier or permissions"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"path", "name"=>"token", "description"=>"token"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}, {"in"=>"query", "name"=>"webhooks", "description"=>"true or false"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tokens"]}}, "/tokens/{token}/member"=>{"get"=>{"summary"=>"Get Tokens Member", "description"=>"Get tokens member.", "operationId"=>"getTokensMemberByToken", "x-api-path-slug"=>"tokenstokenmember-get", "parameters"=>[{"in"=>"query", "name"=>"fields", "description"=>"all or a comma-separated list of: avatarHash, avatarSource, bio, bioData, confirmed, email, fullName, gravatarHash, idBoards, idBoardsPinned, idOrganizations, idPremOrgsAdmin, initials, loginTypes, memberType, oneTimeMessagesDismissed, prefs, premiumFeatures, products, status, status, trophies, uploadedAvatarHash, url or username"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"path", "name"=>"token", "description"=>"token"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tokens", "Member"]}}, "/tokens/{token}/member/{field}"=>{"get"=>{"summary"=>"Get Tokens Member Field", "description"=>"Get tokens member field.", "operationId"=>"getTokensMemberByTokenByField", "x-api-path-slug"=>"tokenstokenmemberfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"path", "name"=>"token", "description"=>"token"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tokens", "Member", "Field"]}}, "/tokens/{token}/webhooks"=>{"get"=>{"summary"=>"Get Tokens Webhooks", "description"=>"Get tokens webhooks.", "operationId"=>"getTokensWebhooksByToken", "x-api-path-slug"=>"tokenstokenwebhooks-get", "parameters"=>[{"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"path", "name"=>"token", "description"=>"token"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tokens", "Webhooks"]}, "post"=>{"summary"=>"Post Tokens Webhooks", "description"=>"Post tokens webhooks.", "operationId"=>"addTokensWebhooksByToken", "x-api-path-slug"=>"tokenstokenwebhooks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Tokens Webhooks to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"path", "name"=>"token", "description"=>"token"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tokens", "Webhooks"]}, "put"=>{"summary"=>"Put Tokens Webhooks", "description"=>"Put tokens webhooks.", "operationId"=>"updateTokensWebhooksByToken", "x-api-path-slug"=>"tokenstokenwebhooks-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Tokens Webhooks to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"path", "name"=>"token", "description"=>"token"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tokens", "Webhooks"]}}, "/tokens/{token}/webhooks/{idWebhook}"=>{"delete"=>{"summary"=>"Delete Tokens Webhooks", "description"=>"Delete tokens webhooks.", "operationId"=>"deleteTokensWebhooksByTokenByIdWebhook", "x-api-path-slug"=>"tokenstokenwebhooksidwebhook-delete", "parameters"=>[{"in"=>"path", "name"=>"idWebhook", "description"=>"idWebhook"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"path", "name"=>"token", "description"=>"token"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tokens", "Webhooks"]}, "get"=>{"summary"=>"Get Tokens Webhooks", "description"=>"Get tokens webhooks.", "operationId"=>"getTokensWebhooksByTokenByIdWebhook", "x-api-path-slug"=>"tokenstokenwebhooksidwebhook-get", "parameters"=>[{"in"=>"path", "name"=>"idWebhook", "description"=>"idWebhook"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"path", "name"=>"token", "description"=>"token"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tokens", "Webhooks"]}}, "/tokens/{token}/{field}"=>{"get"=>{"summary"=>"Get Tokens Field", "description"=>"Get tokens field.", "operationId"=>"getTokensByTokenByField", "x-api-path-slug"=>"tokenstokenfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"path", "name"=>"token", "description"=>"token"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tokens", "Field"]}}, "/types/{id}"=>{"get"=>{"summary"=>"Get Types", "description"=>"Get types.", "operationId"=>"getTypesById", "x-api-path-slug"=>"typesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Types"]}}, "/webhooks"=>{"post"=>{"summary"=>"Post Webhooks", "description"=>"Post webhooks.", "operationId"=>"addWebhooks", "x-api-path-slug"=>"webhooks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Webhooks to be added", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}}, "/webhooks/"=>{"put"=>{"summary"=>"Put Webhooks", "description"=>"Put webhooks.", "operationId"=>"updateWebhooks", "x-api-path-slug"=>"webhooks-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Webhooks to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}}, "/webhooks/{idWebhook}"=>{"delete"=>{"summary"=>"Delete Webhooks", "description"=>"Delete webhooks.", "operationId"=>"deleteWebhooksByIdWebhook", "x-api-path-slug"=>"webhooksidwebhook-delete", "parameters"=>[{"in"=>"path", "name"=>"idWebhook", "description"=>"idWebhook"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}, "get"=>{"summary"=>"Get Webhooks", "description"=>"Get webhooks.", "operationId"=>"getWebhooksByIdWebhook", "x-api-path-slug"=>"webhooksidwebhook-get", "parameters"=>[{"in"=>"path", "name"=>"idWebhook", "description"=>"idWebhook"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}, "put"=>{"summary"=>"Put Webhooks", "description"=>"Put webhooks.", "operationId"=>"updateWebhooksByIdWebhook", "x-api-path-slug"=>"webhooksidwebhook-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Webhooks to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idWebhook", "description"=>"idWebhook"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}}, "/webhooks/{idWebhook}/active"=>{"put"=>{"summary"=>"Put Webhooks Active", "description"=>"Put webhooks active.", "operationId"=>"updateWebhooksActiveByIdWebhook", "x-api-path-slug"=>"webhooksidwebhookactive-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Webhooks Active to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idWebhook", "description"=>"idWebhook"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "Active"]}}, "/webhooks/{idWebhook}/callbackURL"=>{"put"=>{"summary"=>"Put Webhooks Callbackurl", "description"=>"Put webhooks callbackurl.", "operationId"=>"updateWebhooksCallbackURLByIdWebhook", "x-api-path-slug"=>"webhooksidwebhookcallbackurl-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Webhooks Callback Url to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idWebhook", "description"=>"idWebhook"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "Callbackurl"]}}, "/webhooks/{idWebhook}/description"=>{"put"=>{"summary"=>"Put Webhooks Description", "description"=>"Put webhooks description.", "operationId"=>"updateWebhooksDescriptionByIdWebhook", "x-api-path-slug"=>"webhooksidwebhookdescription-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Webhooks Description to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idWebhook", "description"=>"idWebhook"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "Description"]}}, "/webhooks/{idWebhook}/idModel"=>{"put"=>{"summary"=>"Put Webhooks Model", "description"=>"Put webhooks model.", "operationId"=>"updateWebhooksIdModelByIdWebhook", "x-api-path-slug"=>"webhooksidwebhookidmodel-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Attributes of Webhooks Id Model to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"idWebhook", "description"=>"idWebhook"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "Model"]}}, "/webhooks/{idWebhook}/{field}"=>{"get"=>{"summary"=>"Get Webhooks Field", "description"=>"Get webhooks field.", "operationId"=>"getWebhooksByIdWebhookByField", "x-api-path-slug"=>"webhooksidwebhookfield-get", "parameters"=>[{"in"=>"path", "name"=>"field", "description"=>"field"}, {"in"=>"path", "name"=>"idWebhook", "description"=>"idWebhook"}, {"in"=>"query", "name"=>"key", "description"=>"Generate your application key"}, {"in"=>"query", "name"=>"token", "description"=>"Getting a token from a user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "Field"]}}}}, "apis"=>{"name"=>"Trello", "x-slug"=>"trello", "description"=>"Trusted by millions, Trello is the visual collaboration tool that creates a shared perspective on any project. Trello’s boards, lists and cards enable you to organize and prioritize your personal and work life in a fun, flexible and rewarding way.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/trello-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Collaboration,General Data,Pedestal,Projects,Relative Data,Service API,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"trello/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Trello", "x-api-slug"=>"trello", "description"=>"Trello is an online project management and collaboration platform. Users can manage their projects on Trello boards that display the various aspects of their projects, such as what has been done and who is working on what.The Trello API allows developers to access and integrate the data and functionality of Trello with other applications and to create new applications. Some example API methods include retrieving project information, managing user information, and viewing lists and tasks.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/trello-logo.png", "humanURL"=>"http://trello.com", "baseURL"=>"https://trello.com//1", "tags"=>"Collaboration,General Data,Pedestal,Projects,Relative Data,Service API,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/trello/trello-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://blog.trello.com/"}, {"type"=>"x-developer", "url"=>"https://developers.trello.com/"}, {"type"=>"x-documentation", "url"=>"https://developers.trello.com/v1.0/reference#introduction"}, {"type"=>"x-github", "url"=>"https://github.com/trello"}, {"type"=>"x-pricing", "url"=>"https://trello.com/pricing"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/trello"}, {"type"=>"x-webhook", "url"=>"https://developers.trello.com/v1.0/reference#webhooks"}, {"type"=>"x-webhook", "url"=>"https://developers.trello.com/page/webhooks"}, {"type"=>"x-website", "url"=>"http://trello.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-functions{"google-cloud-functions-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Functions", "x-complete"=>1, "info"=>{"title"=>"Google Cloud Functions", "description"=>"api-for-managing-lightweight-userprovided-functions-executed-in-response-to-events-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"cloudfunctions.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/{name}"=>{"get"=>{"summary"=>"Get Location", "description"=>"Get information about a location.", "operationId"=>"cloudfunctions.projects.locations.get", "x-api-path-slug"=>"v1name-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Resource name for the location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Location"]}}}}, "apis"=>{"name"=>"Google Cloud Functions", "x-slug"=>"google-cloud-functions", "description"=>"Cloud computing has made possible fully serverless models of computing where logic can be spun up on-demand in response to events originating from anywhere. Construct applications from bite-sized business logic billed to the nearest 100 milliseconds, only while your code is running. Serve users from zero to planet-scale, all without managing any infrastructure.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Cloud-Functions.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Deployments,Google APIs,Profiles,Relative Data,Serverless,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-functions/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Functions API", "x-api-slug"=>"google-cloud-functions-api", "description"=>"Cloud computing has made possible fully serverless models of computing where logic can be spun up on-demand in response to events originating from anywhere. Construct applications from bite-sized business logic billed to the nearest 100 milliseconds, only while your code is running. Serve users from zero to planet-scale, all without managing any infrastructure.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Cloud-Functions.png", "humanURL"=>"https://cloud.google.com/functions/", "baseURL"=>"://cloudfunctions.googleapis.com//", "tags"=>"API Provider,API Service Provider,Deployments,Google APIs,Profiles,Relative Data,Serverless,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/google-cloud-functions/v1name-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/google-cloud-functions/google-cloud-functions-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-log", "url"=>"https://cloud.google.com/functions/docs/release-notes"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/functions/docs/"}, {"type"=>"x-how-to-guides", "url"=>"https://cloud.google.com/functions/docs/how-to"}, {"type"=>"x-monitoring", "url"=>"https://cloud.google.com/functions/docs/monitoring/"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/functions/pricing"}, {"type"=>"x-rate-limits", "url"=>"https://cloud.google.com/functions/quotas"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/functions/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
pivotal-tracker{"pivotal-tracker-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Pivotal Tracker", "x-complete"=>1, "info"=>{"title"=>"Pivotal Tracker", "description"=>"access-and-manipulate-agile-project-management-data-including-projects-stories-and-tasks-", "version"=>"1.0.0"}, "host"=>"www.pivotaltracker.com", "basePath"=>"/services/v3/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/tokens/active"=>{"get"=>{"summary"=>"Get Tokens Active", "description"=>"Returns an API token associated with the user. This method requires HTTP Basic authentication.", "operationId"=>"getTokensActive", "x-api-path-slug"=>"tokensactive-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tokens", "Active"]}, "post"=>{"summary"=>"Post Tokens Active", "description"=>"Returns an API token associated with the user.", "operationId"=>"postTokensActive", "x-api-path-slug"=>"tokensactive-post", "parameters"=>[{"in"=>"query", "name"=>"password", "description"=>"The users password"}, {"in"=>"query", "name"=>"username", "description"=>"The users name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tokens", "Active"]}}, "/activities"=>{"get"=>{"summary"=>"Get Activities", "description"=>"Retrieves the recent activity of all your projects.", "operationId"=>"getActivities", "x-api-path-slug"=>"activities-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limits the number of activity feed items"}, {"in"=>"query", "name"=>"newer_than_version", "description"=>"Restricts the activity feed to only those items that have a greater than supplied version"}, {"in"=>"query", "name"=>"occurred_since_date", "description"=>"Restricts the activity feed to only those items that occurred after a supplied date (example format: 2009/12/18 21:00:00 UTC)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activities"]}}, "/projects/{PROJECT_ID}/activities"=>{"get"=>{"summary"=>"Get Projects Project Activities", "description"=>"Retrieves the recent activity of a specific project.", "operationId"=>"getProjectsProjectActivities", "x-api-path-slug"=>"projectsproject-idactivities-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limits the number of activity feed items"}, {"in"=>"query", "name"=>"occurred_since_date", "description"=>"Restricts the activity feed to only those items that occurred after a supplied date (example format: 2009/12/18 21:00:00 UTC)"}, {"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project to retrieve the activity for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Activities"]}}, "/projects/{PROJECT_ID}"=>{"get"=>{"summary"=>"Get Projects Project", "description"=>"Retrieves information about a project.", "operationId"=>"getProjectsProject", "x-api-path-slug"=>"projectsproject-id-get", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID"]}}, "/projects"=>{"get"=>{"summary"=>"Get Projects", "description"=>"Retrieves all of the user's projects.", "operationId"=>"getProjects", "x-api-path-slug"=>"projects-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}, "post"=>{"summary"=>"Post Projects", "description"=>"Adds a new project.", "operationId"=>"postProjects", "x-api-path-slug"=>"projects-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/projects/{PROJECT_ID}/memberships"=>{"get"=>{"summary"=>"Get Projects Project Memberships", "description"=>"Retrieves all memberships for a project.", "operationId"=>"getProjectsProjectMemberships", "x-api-path-slug"=>"projectsproject-idmemberships-get", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Memberships"]}, "post"=>{"summary"=>"Post Projects Project Memberships", "description"=>"Adds a new membership to a project.", "operationId"=>"postProjectsProjectMemberships", "x-api-path-slug"=>"projectsproject-idmemberships-post", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Memberships"]}}, "/projects/{PROJECT_ID}/memberships/{MEMBERSHIP_ID}"=>{"get"=>{"summary"=>"Get Projects Project Memberships Membership", "description"=>"Retrieves information about a single membership.", "operationId"=>"getProjectsProjectMembershipsMembership", "x-api-path-slug"=>"projectsproject-idmembershipsmembership-id-get", "parameters"=>[{"in"=>"path", "name"=>"MEMBERSHIP_ID", "description"=>"The ID of the membership"}, {"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Memberships", "MEMBERSHIP", "ID"]}, "delete"=>{"summary"=>"Delete Projects Project Memberships Membership", "description"=>"Delete projects project memberships membership.", "operationId"=>"deleteProjectsProjectMembershipsMembership", "x-api-path-slug"=>"projectsproject-idmembershipsmembership-id-delete", "parameters"=>[{"in"=>"path", "name"=>"MEMBERSHIP_ID", "description"=>"The ID of the membership"}, {"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Memberships", "MEMBERSHIP", "ID"]}}, "/projects/{PROJECT_ID}/iterations"=>{"get"=>{"summary"=>"Get Projects Project Iterations", "description"=>"Retrieves all iterations, with stories.", "operationId"=>"getProjectsProjectIterations", "x-api-path-slug"=>"projectsproject-iditerations-get", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Iterations"]}}, "/projects/{PROJECT_ID}/iterations/done"=>{"get"=>{"summary"=>"Get Projects Project Iterations Done", "description"=>"Retrieves iterations from the \"done\" group, with stories.", "operationId"=>"getProjectsProjectIterationsDone", "x-api-path-slug"=>"projectsproject-iditerationsdone-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Controls the maximum number of iterations returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Controls the number of iterations to skip from the beginning of the result"}, {"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Iterations", "Done"]}}, "/projects/{PROJECT_ID}/iterations/current"=>{"get"=>{"summary"=>"Get Projects Project Iterations Current", "description"=>"Retrieves iterations from the \"current\" group, with stories.", "operationId"=>"getProjectsProjectIterationsCurrent", "x-api-path-slug"=>"projectsproject-iditerationscurrent-get", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Iterations", "Current"]}}, "/projects/{PROJECT_ID}/iterations/backlog"=>{"get"=>{"summary"=>"Get Projects Project Iterations Backlog", "description"=>"Retrieves iterations from the \"backlog\" group, with stories.", "operationId"=>"getProjectsProjectIterationsBacklog", "x-api-path-slug"=>"projectsproject-iditerationsbacklog-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Controls the maximum number of iterations returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Controls the number of iterations to skip from the beginning of the result"}, {"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Iterations", "Backlog"]}}, "/projects/{PROJECT_ID}/iterations/current_backlog"=>{"get"=>{"summary"=>"Get Projects Project Iterations Current Backlog", "description"=>"Retrieves iterations from the \"current\" and \"backlog\" groups, with stories.", "operationId"=>"getProjectsProjectIterationsCurrentBacklog", "x-api-path-slug"=>"projectsproject-iditerationscurrent-backlog-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Controls the maximum number of iterations returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Controls the number of iterations to skip from the beginning of the result"}, {"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Iterations", "Current", "Backlog"]}}, "/projects/{PROJECT_ID}/stories/{STORY_ID}"=>{"get"=>{"summary"=>"Get Projects Project Stories Story", "description"=>"Retrieves information about a single story.", "operationId"=>"getProjectsProjectStoriesStory", "x-api-path-slug"=>"projectsproject-idstoriesstory-id-get", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"STORY_ID", "description"=>"The ID of the story"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Stories", "STORY", "ID"]}, "put"=>{"summary"=>"Put Projects Project Stories Story", "description"=>"Put projects project stories story.", "operationId"=>"putProjectsProjectStoriesStory", "x-api-path-slug"=>"projectsproject-idstoriesstory-id-put", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"STORY_ID", "description"=>"The ID of the story"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Stories", "STORY", "ID"]}, "delete"=>{"summary"=>"Delete Projects Project Stories Story", "description"=>"Delete projects project stories story.", "operationId"=>"deleteProjectsProjectStoriesStory", "x-api-path-slug"=>"projectsproject-idstoriesstory-id-delete", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"STORY_ID", "description"=>"The ID of the story"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Stories", "STORY", "ID"]}}, "/projects/{PROJECT_ID}/stories"=>{"get"=>{"summary"=>"Get Projects Project Stories", "description"=>"Retrieves all stories for a project, or those matching filter(s)", "operationId"=>"getProjectsProjectStories", "x-api-path-slug"=>"projectsproject-idstories-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"A filter for the returned stories to match"}, {"in"=>"query", "name"=>"limit", "description"=>"Controls the maximum number of stories returned"}, {"in"=>"query", "name"=>"offset", "description"=>"Controls the number of stories to skip from the beginning of the result"}, {"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Stories"]}, "post"=>{"summary"=>"Post Projects Project Stories", "description"=>"Post projects project stories.", "operationId"=>"postProjectsProjectStories", "x-api-path-slug"=>"projectsproject-idstories-post", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Stories"]}}, "/projects/{PROJECT_ID}/stories/{STORY_ID}/notes"=>{"put"=>{"summary"=>"Put Projects Project Stories Story Notes", "description"=>"Put projects project stories story notes.", "operationId"=>"putProjectsProjectStoriesStoryNotes", "x-api-path-slug"=>"projectsproject-idstoriesstory-idnotes-put", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"STORY_ID", "description"=>"The ID of the story"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Stories", "STORY", "ID", "Notes"]}}, "/projects/{PROJECT_ID}/stories/deliver_all_finished"=>{"post"=>{"summary"=>"Post Projects Project Stories Deliver All Finished", "description"=>"Takes all finished stories and marks them as delivered. This could be used to automate a demo deploy process. The updated stories are returned as the result.", "operationId"=>"postProjectsProjectStoriesDeliverAllFinished", "x-api-path-slug"=>"projectsproject-idstoriesdeliver-all-finished-post", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Stories", "Deliver", "", "Finished"]}}, "/projects/{PROJECT_ID}/stories/{STORY_ID}/moves"=>{"post"=>{"summary"=>"Post Projects Project Stories Story Moves", "description"=>"Moves a story before or after another story. The moved story is returned in the response.", "operationId"=>"postProjectsProjectStoriesStoryMoves", "x-api-path-slug"=>"projectsproject-idstoriesstory-idmoves-post", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"STORY_ID", "description"=>"The ID of the story"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Stories", "STORY", "ID", "Moves"]}}, "/projects/{PROJECT_ID}/stories/{STORY_ID}/tasks/{TASK_ID}"=>{"get"=>{"summary"=>"Get Projects Project Stories Story Tasks Task", "description"=>"Get projects project stories story tasks task.", "operationId"=>"getProjectsProjectStoriesStoryTasksTask", "x-api-path-slug"=>"projectsproject-idstoriesstory-idtaskstask-id-get", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"STORY_ID", "description"=>"The ID of the story"}, {"in"=>"path", "name"=>"TASK_ID", "description"=>"The ID of the task"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Stories", "STORY", "ID", "Tasks", "TASK", "ID"]}, "put"=>{"summary"=>"Put Projects Project Stories Story Tasks Task", "description"=>"Put projects project stories story tasks task.", "operationId"=>"putProjectsProjectStoriesStoryTasksTask", "x-api-path-slug"=>"projectsproject-idstoriesstory-idtaskstask-id-put", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"STORY_ID", "description"=>"The ID of the story"}, {"in"=>"path", "name"=>"TASK_ID", "description"=>"The ID of the task"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Stories", "STORY", "ID", "Tasks", "TASK", "ID"]}, "delete"=>{"summary"=>"Delete Projects Project Stories Story Tasks Task", "description"=>"Delete projects project stories story tasks task.", "operationId"=>"deleteProjectsProjectStoriesStoryTasksTask", "x-api-path-slug"=>"projectsproject-idstoriesstory-idtaskstask-id-delete", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"STORY_ID", "description"=>"The ID of the story"}, {"in"=>"path", "name"=>"TASK_ID", "description"=>"The ID of the task"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Stories", "STORY", "ID", "Tasks", "TASK", "ID"]}}, "/projects/{PROJECT_ID}/stories/{STORY_ID}/tasks"=>{"get"=>{"summary"=>"Get Projects Project Stories Story Tasks", "description"=>"Get projects project stories story tasks.", "operationId"=>"getProjectsProjectStoriesStoryTasks", "x-api-path-slug"=>"projectsproject-idstoriesstory-idtasks-get", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"STORY_ID", "description"=>"The ID of the story"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Stories", "STORY", "ID", "Tasks"]}, "post"=>{"summary"=>"Post Projects Project Stories Story Tasks", "description"=>"Post projects project stories story tasks.", "operationId"=>"postProjectsProjectStoriesStoryTasks", "x-api-path-slug"=>"projectsproject-idstoriesstory-idtasks-post", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"STORY_ID", "description"=>"The ID of the story"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Stories", "STORY", "ID", "Tasks"]}}, "/projects/{PROJECT_ID}/stories/{STORY_ID}/attachments"=>{"post"=>{"summary"=>"Post Projects Project Stories Story Attachments", "description"=>"Post projects project stories story attachments.", "operationId"=>"postProjectsProjectStoriesStoryAttachments", "x-api-path-slug"=>"projectsproject-idstoriesstory-idattachments-post", "parameters"=>[{"in"=>"path", "name"=>"PROJECT_ID", "description"=>"The ID of the project"}, {"in"=>"path", "name"=>"STORY_ID", "description"=>"The ID of the story"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Stories", "STORY", "ID", "Attachments"]}}, "/source_commits"=>{"post"=>{"summary"=>"Post Source Commits", "description"=>"Allows integration with post-commit hooks of Source Control Management (SCM) systems such as Subversion, Git, etc.", "operationId"=>"postSourceCommits", "x-api-path-slug"=>"source-commits-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Source", "Commits"]}}}}, "apis"=>{"name"=>"Pivotal Tracker", "x-slug"=>"pivotal-tracker", "description"=>"Pivotal Tracker is the agile project management tool of choice for developers around the world for real-time collaboration around a shared, prioritized backlog.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11526-pivotal-tracker.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"15894", "tags"=>"API LIfeyclessss,Projects,Projects,Relative Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"pivotal-tracker/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Pivotal Tracker", "x-api-slug"=>"pivotal-tracker", "description"=>"Whether welding together two apps or forging a unique one, tap into 100% of the Tracker feature set with the very same API the Tracker team uses.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11526-pivotal-tracker.jpg", "humanURL"=>"http://pivotaltracker.com", "baseURL"=>"https://www.pivotaltracker.com//services/v3/", "tags"=>"API LIfeyclessss,Projects,Projects,Relative Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/pivotal-tracker/source-commits-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/pivotal-tracker/pivotal-tracker-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://www.pivotaltracker.com/community/tracker-blog"}, {"type"=>"x-blog", "url"=>"http://www.pivotaltracker.com/feed"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/pivotaltracker"}, {"type"=>"x-faq", "url"=>"https://www.pivotaltracker.com/faq"}, {"type"=>"x-github", "url"=>"https://github.com/pivotal"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/showcase/pivotal-tracker/"}, {"type"=>"x-pricing", "url"=>"http://www.pivotaltracker.com/why-tracker/pricing"}, {"type"=>"x-selfservice-registration", "url"=>"https://www.pivotaltracker.com/signup/new"}, {"type"=>"x-status", "url"=>"http://status.pivotaltracker.com/"}, {"type"=>"x-terms-of-service", "url"=>"https://www.pivotaltracker.com/policy/eula"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/pivotaltracker"}, {"type"=>"x-website", "url"=>"http://pivotaltracker.com"}, {"type"=>"x-website", "url"=>"http://www.pivotaltracker.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
lufthansa{"lh-public-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Lufthansa", "x-complete"=>1, "info"=>{"title"=>"LH Public", "version"=>"1.0"}, "host"=>"api.lufthansa.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/cargo/getRoute/{origin}-{destination}/{fromDate}/{productCode}"=>{"get"=>{"summary"=>"Retrieve all flights", "description"=>"Retrieve a list of all possible flights (both direct and connecting) between two airports on a given date. Routes are available for today and up to days in the future.", "operationId"=>"CargoGetRouteFromDateProductCodeByOriginAndDestinationGet", "x-api-path-slug"=>"cargogetrouteorigindestinationfromdateproductcode-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"path", "name"=>"destination", "description"=>"Arrival airport : 3-letter IATA airport code, e"}, {"in"=>"path", "name"=>"fromDate", "description"=>"Departure date in the local time of the departure airport"}, {"in"=>"path", "name"=>"origin", "description"=>"Departure Airport : 3-letter IATA airport code, e"}, {"in"=>"path", "name"=>"productCode", "description"=>"Product code for requested service and specials : 3-letter eg: YNZ"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cargo", "GetRoute", "Origin", "Destination", "FromDate", "ProductCode"]}}, "/cargo/shipmentTracking/{aWBPrefix}-{aWBNumber}"=>{"get"=>{"summary"=>"Shipment Tracking", "description"=>"With this tracking service you can easily retrieve your shipment or flight status information.", "operationId"=>"CargoShipmentTrackingByAWBPrefixAndAWBNumberGet", "x-api-path-slug"=>"cargoshipmenttrackingawbprefixawbnumber-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"path", "name"=>"aWBNumber", "description"=>"aWBNumber : The Air Waybill Number , format : [0-9]{8} e"}, {"in"=>"path", "name"=>"aWBPrefix", "description"=>"aWBPrefix : Represents the airline that is the owner of this AWB, i"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cargo", "ShipmentTracking", "AWBPrefix", "AWBNumber"]}}, "/offers/lounges/{location}"=>{"get"=>{"summary"=>"Lounges", "description"=>"Lounge information", "operationId"=>"OffersLoungesByLocationGet", "x-api-path-slug"=>"offersloungeslocation-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"query", "name"=>"cabinClass", "description"=>"Cabin class: M, E, C, F (Acceptable values are: , M, E, C, F)"}, {"in"=>"query", "name"=>"lang", "description"=>"Language code"}, {"in"=>"path", "name"=>"location", "description"=>"3-leter IATA airport or city code (e"}, {"in"=>"query", "name"=>"tierCode", "description"=>"Frequent flyer level (FTL, SGC, SEN, HON) (Acceptable values are: , FTL, SGC, SEN, HON)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offers", "Lounges", "Location"]}}, "/offers/seatmaps/{flightNumber}/{origin}/{destination}/{date}/{cabinClass}"=>{"get"=>{"summary"=>"Seat Maps", "description"=>"Cabin layout and seat characteristics.", "operationId"=>"OffersSeatmapsDestinationDateCabinClassByFlightNumberAndOriginGet", "x-api-path-slug"=>"offersseatmapsflightnumberorigindestinationdatecabinclass-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"path", "name"=>"cabinClass", "description"=>"Cabin class: M, E, C, F"}, {"in"=>"path", "name"=>"date", "description"=>"Departure date (YYYY-MM-DD)"}, {"in"=>"path", "name"=>"destination", "description"=>"Destination airport"}, {"in"=>"path", "name"=>"flightNumber", "description"=>"Flight number including carrier code and any suffix (e"}, {"in"=>"path", "name"=>"origin", "description"=>"Departure airport"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offers", "Seatmaps", "FlightNumber", "Origin", "Destination", "Date", "CabinClass"]}}, "/operations/flightstatus/arrivals/{airportCode}/{fromDateTime}"=>{"get"=>{"summary"=>"Flight Status at Arrival Airport", "description"=>"Status of all arrivals at a given airport up to 4 hours from the provided date time.", "operationId"=>"OperationsFlightstatusArrivalsByAirportCodeAndFromDateTimeGet", "x-api-path-slug"=>"operationsflightstatusarrivalsairportcodefromdatetime-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"path", "name"=>"airportCode", "description"=>"3-letter IATA aiport code (e"}, {"in"=>"path", "name"=>"fromDateTime", "description"=>"Start of time range in local time of arrival airport (YYYY-MM-DDTHH:mm)"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of records returned per request"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of records skipped"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations", "Flightstatus", "Arrivals", "AirportCode", "FromDateTime"]}}, "/operations/flightstatus/departures/{airportCode}/{fromDateTime}"=>{"get"=>{"summary"=>"Flight Status at Departure Airport", "description"=>"Status of all departures from a given airport up to 4 hours from the provided date time.", "operationId"=>"OperationsFlightstatusDeparturesByAirportCodeAndFromDateTimeGet", "x-api-path-slug"=>"operationsflightstatusdeparturesairportcodefromdatetime-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"path", "name"=>"airportCode", "description"=>"Departure airport"}, {"in"=>"path", "name"=>"fromDateTime", "description"=>"Start of time range in local time of departure airport (YYYY-MM-DDTHH:mm)"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of records returned per request"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of records skipped"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations", "Flightstatus", "Departures", "AirportCode", "FromDateTime"]}}, "/operations/flightstatus/route/{origin}/{destination}/{date}"=>{"get"=>{"summary"=>"Flight Status by Route", "description"=>"Status of flights between a given origin and destination on a given date.", "operationId"=>"OperationsFlightstatusRouteDateByOriginAndDestinationGet", "x-api-path-slug"=>"operationsflightstatusrouteorigindestinationdate-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"path", "name"=>"date", "description"=>"Departure date (YYYY-MM-DD) in local time of departure airport"}, {"in"=>"path", "name"=>"destination", "description"=>"3-letter IATA airport code (e"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of records returned per request"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of records skipped"}, {"in"=>"path", "name"=>"origin", "description"=>"3-letter IATA airport (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations", "Flightstatus", "Route", "Origin", "Destination", "Date"]}}, "/operations/flightstatus/{flightNumber}/{date}"=>{"get"=>{"summary"=>"Flight Status", "description"=>"Status of a particular flight (boarding, delayed, etc.).", "operationId"=>"OperationsFlightstatusByFlightNumberAndDateGet", "x-api-path-slug"=>"operationsflightstatusflightnumberdate-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"path", "name"=>"date", "description"=>"The departure date (YYYY-MM-DD) in the local time of the departure airport"}, {"in"=>"path", "name"=>"flightNumber", "description"=>"Flight number including carrier code and any suffix (e"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of records returned per request"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of records skipped"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations", "Flightstatus", "FlightNumber", "Date"]}}, "/operations/schedules/{origin}/{destination}/{fromDateTime}"=>{"get"=>{"summary"=>"Flight Schedules", "description"=>"Scheduled flights between given airports on a given date.", "operationId"=>"OperationsSchedulesFromDateTimeByOriginAndDestinationGet", "x-api-path-slug"=>"operationsschedulesorigindestinationfromdatetime-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"path", "name"=>"destination", "description"=>"Destination airport"}, {"in"=>"query", "name"=>"directFlights", "description"=>"Show only direct flights (false=0, true=1)"}, {"in"=>"path", "name"=>"fromDateTime", "description"=>"Local departure date and optionally departure time (YYYY-MM-DD or YYYY-MM-DDTHH:mm)"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of records returned per request"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of records skipped"}, {"in"=>"path", "name"=>"origin", "description"=>"Departure airport"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations", "Schedules", "Origin", "Destination", "FromDateTime"]}}, "/references/aircraft/{aircraftCode}"=>{"get"=>{"summary"=>"Aircraft", "description"=>"List all aircraft types or one specific aircraft type.", "operationId"=>"ReferencesAircraftByAircraftCodeGet", "x-api-path-slug"=>"referencesaircraftaircraftcode-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"path", "name"=>"aircraftCode", "description"=>"3-character IATA aircraft code"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of records returned per request"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of records skipped"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["References", "Aircraft", "AircraftCode"]}}, "/references/airlines/{airlineCode}"=>{"get"=>{"summary"=>"Airlines", "description"=>"List all airlines or one specific airline.", "operationId"=>"ReferencesAirlinesByAirlineCodeGet", "x-api-path-slug"=>"referencesairlinesairlinecode-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"path", "name"=>"airlineCode", "description"=>"2-character IATA airline/carrier code"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of records returned per request"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of records skipped"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["References", "Airlines", "AirlineCode"]}}, "/references/airports/nearest/{latitude},{longitude}"=>{"get"=>{"summary"=>"Nearest Airports", "description"=>"List the 5 closest airports to the given latitude and longitude, irrespective of the radius of the reference point.", "operationId"=>"ReferencesAirportsNearestByLatitudeAndLongitudeGet", "x-api-path-slug"=>"referencesairportsnearestlatitudelongitude-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"query", "name"=>"lang", "description"=>"2 letter ISO 3166-1 language code"}, {"in"=>"path", "name"=>"latitude", "description"=>"Latitude in decimal format to at most 3 decimal places"}, {"in"=>"path", "name"=>"longitude", "description"=>"Longitude in decimal format to at most 3 decimal places"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["References", "Airports", "Nearest", "Latitude", "Longitude"]}}, "/references/airports/{airportCode}"=>{"get"=>{"summary"=>"Airports", "description"=>"List all airports or one specific airport. All airports response is very large. It is possible to request the response in a specific language.", "operationId"=>"ReferencesAirportsByAirportCodeGet", "x-api-path-slug"=>"referencesairportsairportcode-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"path", "name"=>"airportCode", "description"=>"3-letter IATA airport code"}, {"in"=>"query", "name"=>"lang", "description"=>"2-letter ISO 3166-1 language code"}, {"in"=>"query", "name"=>"LHoperated", "description"=>"Restrict the results to locations with flights operated by LH (false=0, true=1)"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of records returned per request"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of records skipped"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["References", "Airports", "AirportCode"]}}, "/references/cities/{cityCode}"=>{"get"=>{"summary"=>"Cities", "description"=>"List all cities or one specific city. It is possible to request the response in a specific language.", "operationId"=>"ReferencesCitiesByCityCodeGet", "x-api-path-slug"=>"referencescitiescitycode-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"path", "name"=>"cityCode", "description"=>"3-letter IATA city code"}, {"in"=>"query", "name"=>"lang", "description"=>"2 letter ISO 3166-1 language code"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of records returned per request"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of records skipped"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["References", "Cities", "CityCode"]}}, "/references/countries/{countryCode}"=>{"get"=>{"summary"=>"Countries", "description"=>"List all countries or one specific country. It is possible to request the response in a specific language.", "operationId"=>"ReferencesCountriesByCountryCodeGet", "x-api-path-slug"=>"referencescountriescountrycode-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"path", "name"=>"countryCode", "description"=>"2-letter ISO 3166-1 country code"}, {"in"=>"query", "name"=>"lang", "description"=>"2 letter ISO 3166-1 language code"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of records returned per request"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of records skipped"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["References", "Countries", "CountryCode"]}}}}, "lh-partner-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Lufthansa", "x-complete"=>1, "info"=>{"title"=>"LH Partner", "version"=>"1.0"}, "host"=>"api.lufthansa.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/baggage/baggagetripandcontact/{searchID}"=>{"get"=>{"summary"=>"Baggage Trip and Contact", "description"=>"Retrieve passenger trip, contact and baggage details. This service is only accessible for LH privileged partners", "operationId"=>"baggage.baggagetripandcontact.searchID.get", "x-api-path-slug"=>"baggagebaggagetripandcontactsearchid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"path", "name"=>"searchID", "description"=>"Bag tag number, PNR, boarding card or FQTV ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Baggage", "Trip", "Contact"]}}, "/offers/fares/allfares"=>{"get"=>{"summary"=>"All Fares", "description"=>"Retrieves all available fares for a specific Origin & Destination pair on a given date. Available fares are: One-way and Return for 4U. Return only for OS", "operationId"=>"offers.fares.allfares.get", "x-api-path-slug"=>"offersfaresallfares-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Mandatory http header: application/xml or application/json"}, {"in"=>"query", "name"=>"cabin-class", "description"=>"Enter the required cabin class (e"}, {"in"=>"query", "name"=>"catalogues", "description"=>"Specifies in which catalogue the fares need to be searched (e"}, {"in"=>"query", "name"=>"destination", "description"=>"Enter journey destination (e"}, {"in"=>"query", "name"=>"fare-family", "description"=>"Mandatory for 4U"}, {"in"=>"query", "name"=>"origin", "description"=>"Enter journey origin (e"}, {"in"=>"query", "name"=>"return-date", "description"=>"Enter journey return-date (e"}, {"in"=>"query", "name"=>"trackingid", "description"=>"Austrian Airlines only - specify the web tracking id to be used in OS Deep link"}, {"in"=>"query", "name"=>"travel-date", "description"=>"Enter journey travel-date (e"}, {"in"=>"query", "name"=>"travelers", "description"=>"Specifies the type and number of travelers (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["All", "Fares"]}}, "/offers/fares/bestfares"=>{"get"=>{"summary"=>"Best Fares", "description"=>"Retrieve best fares for the requested journey across multiple days or multiple months.", "operationId"=>"offers.fares.bestfares.get", "x-api-path-slug"=>"offersfaresbestfares-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"query", "name"=>"cabin-class", "description"=>"Cabin class: economy, premium_economy, business, first (Acceptable values are: , economy, premium_economy, business, first)"}, {"in"=>"query", "name"=>"catalogues", "description"=>"Search fares from these carriers catalogues (e"}, {"in"=>"query", "name"=>"country", "description"=>"Country code of requestor"}, {"in"=>"query", "name"=>"destination", "description"=>"Journey destination"}, {"in"=>"query", "name"=>"fare-family", "description"=>"Fare family: basic, smart, best, smartflex, bestflex - Germanwings only (Acceptable values are: , basic, smart, best, smartflex, bestflex)"}, {"in"=>"query", "name"=>"origin", "description"=>"Journey origin"}, {"in"=>"query", "name"=>"range", "description"=>"Fare range: byday or bymonth (Acceptable values are: byday, bymonth)"}, {"in"=>"query", "name"=>"trackingid", "description"=>"Austrian Airlines only - specify the web tracking id to be used in OS Deep link"}, {"in"=>"query", "name"=>"travel-date", "description"=>"Journey travel-date (YYYY-MM-DD)"}, {"in"=>"query", "name"=>"trip-duration", "description"=>"Trip duration in days (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Best", "Fares"]}}, "/offers/fares/deeplink"=>{"get"=>{"summary"=>"Deep Links", "description"=>"Returns valid deep links for the provided input parameters", "operationId"=>"offers.fares.deeplink.get", "x-api-path-slug"=>"offersfaresdeeplink-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"query", "name"=>"cabin-class", "description"=>"Cabin class: economy, premium_economy, business, first (Acceptable values are: , economy, premium_economy, business, first)"}, {"in"=>"query", "name"=>"catalogues", "description"=>"Carrier for which the deep link will be created (e"}, {"in"=>"query", "name"=>"country", "description"=>"2-letter ISO 3166-1 country code"}, {"in"=>"query", "name"=>"destination", "description"=>"Journey destination"}, {"in"=>"query", "name"=>"destination-name", "description"=>"Journey destination airport or city name (e"}, {"in"=>"query", "name"=>"encryption-key", "description"=>"Deep link encryption-key"}, {"in"=>"query", "name"=>"fare", "description"=>"Travel fare (e"}, {"in"=>"query", "name"=>"fare-currency", "description"=>"Fare currency (e"}, {"in"=>"query", "name"=>"lang", "description"=>"2-letter ISO 3166-1 language code"}, {"in"=>"query", "name"=>"net-fare", "description"=>"Travel net fare"}, {"in"=>"query", "name"=>"origin", "description"=>"Journey origin"}, {"in"=>"query", "name"=>"origin-name", "description"=>"Journey origin airport or city name (e"}, {"in"=>"query", "name"=>"outbound-segments", "description"=>"Outbound flight segments in the sequence of travel (e"}, {"in"=>"query", "name"=>"partnerid", "description"=>"Deep link partner id (e"}, {"in"=>"query", "name"=>"return-date", "description"=>"Journey return-date (YYYY-MM-DD)"}, {"in"=>"query", "name"=>"return-segments", "description"=>"Flight segments in the sequence of travel (e"}, {"in"=>"query", "name"=>"trackingid", "description"=>"Deep link tracking ID"}, {"in"=>"query", "name"=>"travel-date", "description"=>"Journey travel-date (YYYY-MM-DD)"}, {"in"=>"query", "name"=>"travelers", "description"=>"Type and number of travelers (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deep", "Links"]}}, "/offers/fares/deeplink/ffp"=>{"get"=>{"summary"=>"LH Deep Links - FFP", "description"=>"Returns valid LH deep links (FFP - links to flight selection screen on LH.COM)", "operationId"=>"offers.fares.deeplink.ffp.get", "x-api-path-slug"=>"offersfaresdeeplinkffp-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"query", "name"=>"cabin-class", "description"=>"Cabin class: economy, premium_economy, business, first (Acceptable values are: , economy, premium_economy, business, first)"}, {"in"=>"query", "name"=>"catalogues", "description"=>"Carrier for which the deep link will be created (e"}, {"in"=>"query", "name"=>"country", "description"=>"2-letter ISO 3166-1 country code"}, {"in"=>"query", "name"=>"destination", "description"=>"Journey destination"}, {"in"=>"query", "name"=>"encryption-key", "description"=>"Deep link encryption-key"}, {"in"=>"query", "name"=>"lang", "description"=>"2-letter ISO 3166-1 language code"}, {"in"=>"query", "name"=>"origin", "description"=>"Journey origin"}, {"in"=>"query", "name"=>"partnerid", "description"=>"Deep link partner id (e"}, {"in"=>"query", "name"=>"return-date", "description"=>"Journey return-date (YYYY-MM-DD)"}, {"in"=>"query", "name"=>"trackingid", "description"=>"Deep link tracking ID"}, {"in"=>"query", "name"=>"travel-date", "description"=>"Journey travel-date (YYYY-MM-DD)"}, {"in"=>"query", "name"=>"travelers", "description"=>"Type and number of travelers (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["LH", "Deep", "Links", "-", "FFP"]}}, "/offers/fares/deeplink/itco"=>{"get"=>{"summary"=>"LH Deep Links - ITCO", "description"=>"Returns valid LH deep links (ITCO - links to shopping cart on LH.COM)", "operationId"=>"offers.fares.deeplink.itco.get", "x-api-path-slug"=>"offersfaresdeeplinkitco-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"query", "name"=>"cabin-class", "description"=>"Cabin class: economy, premium_economy, business, first (Acceptable values are: , economy, premium_economy, business, first)"}, {"in"=>"query", "name"=>"catalogues", "description"=>"Carrier for which the deep link will be created (e"}, {"in"=>"query", "name"=>"country", "description"=>"2-letter ISO 3166-1 country code"}, {"in"=>"query", "name"=>"destination", "description"=>"Journey destination"}, {"in"=>"query", "name"=>"encryption-key", "description"=>"Deep link encryption-key"}, {"in"=>"query", "name"=>"fare", "description"=>"Travel fare (e"}, {"in"=>"query", "name"=>"fare-currency", "description"=>"Fare currency (e"}, {"in"=>"query", "name"=>"lang", "description"=>"2-letter ISO 3166-1 language code"}, {"in"=>"query", "name"=>"net-fare", "description"=>"Travel net fare"}, {"in"=>"query", "name"=>"origin", "description"=>"Journey origin"}, {"in"=>"query", "name"=>"outbound-segments", "description"=>"Outbound flight segments in the sequence of travel (e"}, {"in"=>"query", "name"=>"partnerid", "description"=>"Deep link partner id (e"}, {"in"=>"query", "name"=>"return-date", "description"=>"Journey return-date (YYYY-MM-DD)"}, {"in"=>"query", "name"=>"return-segments", "description"=>"Flight segments in the sequence of travel (e"}, {"in"=>"query", "name"=>"trackingid", "description"=>"Deep link tracking ID"}, {"in"=>"query", "name"=>"travel-date", "description"=>"Journey travel-date (YYYY-MM-DD)"}, {"in"=>"query", "name"=>"travelers", "description"=>"Type and number of travelers (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["LH", "Deep", "Links", "-", "ITCO"]}}, "/offers/fares/fares"=>{"get"=>{"summary"=>"Fares", "description"=>"Retrieve all available fares per fare family for a specific Origin & Destination on a given date", "operationId"=>"Fares", "x-api-path-slug"=>"offersfaresfares-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"query", "name"=>"carriers", "description"=>"Include fares for these carriers e"}, {"in"=>"query", "name"=>"catalogues", "description"=>"Search fares from these carriers catalogues - currently active for Germanwings only (4U)"}, {"in"=>"query", "name"=>"fare-types", "description"=>"Fares family: basic,smart, best, smartflex, bestflex - Germanwings only (Acceptable values are: , basic, smart, best, smartflex, bestflex)"}, {"in"=>"query", "name"=>"segments", "description"=>"Journey details e"}, {"in"=>"query", "name"=>"travelers", "description"=>"Type and number of travelers e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fares"]}}, "/offers/fares/lowestfares"=>{"get"=>{"summary"=>"Lowest Fares", "description"=>"Retrieve lowest fare for a specific Origin & Destination pair on a given date. Available fares are: One-way and Return for 4U. Return only for OS & LH", "operationId"=>"offers.fares.lowestfares.get", "x-api-path-slug"=>"offersfareslowestfares-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"query", "name"=>"cabin-class", "description"=>"Cabin class: economy, premium_economy, business, first (Acceptable values are: , economy, premium_economy, business, first)"}, {"in"=>"query", "name"=>"catalogues", "description"=>"Search fares from these carriers catalogues e"}, {"in"=>"query", "name"=>"country", "description"=>"Country code of requestor"}, {"in"=>"query", "name"=>"destination", "description"=>"Journey destination"}, {"in"=>"query", "name"=>"fare-family", "description"=>"Fare family: basic, smart, best, smartflex, bestflex - Germanwings only (Acceptable values are: , basic, smart, best, smartflex, bestflex)"}, {"in"=>"query", "name"=>"origin", "description"=>"Journey origin"}, {"in"=>"query", "name"=>"return-date", "description"=>"Journey return-date - mandatory for OS and LH searches YYYY-MM-DD"}, {"in"=>"query", "name"=>"travel-date", "description"=>"Journey travel-date YYYY-MM-DD"}, {"in"=>"query", "name"=>"travelers", "description"=>"Type and number of travelers e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lowest", "Fares"]}}, "/offers/fares/subscriptions"=>{"get"=>{"summary"=>"Fares Subscriptions", "description"=>"Create a subscription for best price O&D. Receive regular updates on lowest fares", "operationId"=>"offers.fares.subscriptions.get", "x-api-path-slug"=>"offersfaressubscriptions-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"query", "name"=>"cabin-class", "description"=>"Cabin class: economy, premium_economy, business, first (Acceptable values are: , economy, premium_economy, business, first)"}, {"in"=>"query", "name"=>"country", "description"=>"2-letter ISO 3166-1 country code"}, {"in"=>"query", "name"=>"destination", "description"=>"Journey destination"}, {"in"=>"query", "name"=>"email", "description"=>"Email Address)"}, {"in"=>"query", "name"=>"lang", "description"=>"2-letter ISO 3166-1 language code"}, {"in"=>"query", "name"=>"origin", "description"=>"Journey origin"}, {"in"=>"query", "name"=>"trackingid", "description"=>"Tracking parameter"}, {"in"=>"query", "name"=>"trip-duration", "description"=>"Trip duration in days (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fares", "Subscriptions"]}}, "/offers/ond/route/{origin}/{destination}"=>{"get"=>{"summary"=>"OND Route", "description"=>"Returns LH route origin & destination information", "operationId"=>"offers.ond.route.origin.destination.get", "x-api-path-slug"=>"offersondrouteorigindestination-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Mandatory http header: application/xml or application/json"}, {"in"=>"query", "name"=>"catalogues", "description"=>"Carrier for which the OND will be retrieved (e"}, {"in"=>"path", "name"=>"destination", "description"=>"Enter either the destination city or country code (e"}, {"in"=>"query", "name"=>"limit", "description"=>"Number of records returned per request"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of records skipped"}, {"in"=>"path", "name"=>"origin", "description"=>"Enter either the orgin city or orgin country code (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OND", "Route"]}}, "/offers/ond/status"=>{"get"=>{"summary"=>"OND Status", "description"=>"Returns LH network route status information. Search for recently added or retired routes", "operationId"=>"offers.ond.status.get", "x-api-path-slug"=>"offersondstatus-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Mandatory http header: application/xml or application/json"}, {"in"=>"query", "name"=>"catalogues", "description"=>"Carrier for which the OND will be retrieved (e"}, {"in"=>"query", "name"=>"new-routes", "description"=>"Enter if newly added routes should be returned in the response"}, {"in"=>"query", "name"=>"old-routes", "description"=>"Enter if old (deleted) routes should be returned in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["OND", "Status"]}}, "/offers/ond/top"=>{"get"=>{"summary"=>"Top OND", "description"=>"Returns LH Top routes per country or across all countries", "operationId"=>"offers.ond.top.get", "x-api-path-slug"=>"offersondtop-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Mandatory http header: application/xml or application/json"}, {"in"=>"query", "name"=>"catalogues", "description"=>"Carrier for which the OND will be retrieved (e"}, {"in"=>"query", "name"=>"origin", "description"=>"Enter the origin country code (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Top", "OND"]}}, "/orders/orders/{orderID}/{name}"=>{"get"=>{"summary"=>"Orders", "description"=>"Retrieve order by ID and optionally name. This service is only accessible for LH privileged partners", "operationId"=>"Orders", "x-api-path-slug"=>"ordersordersorderidname-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"path", "name"=>"name", "description"=>"Surname of traveller"}, {"in"=>"path", "name"=>"orderID", "description"=>"Unique order identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders"]}}, "/preflight/autocheckin/{ticketnumber}"=>{"put"=>{"summary"=>"Auto Check-In", "description"=>"Trigger an automatic check-in given a ticket number. This service is only accessible for LH privileged partners", "operationId"=>"preflight.autocheckin.ticketnumber.put", "x-api-path-slug"=>"preflightautocheckinticketnumber-put", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"query", "name"=>"emailAddress", "description"=>"Email address"}, {"in"=>"path", "name"=>"ticketnumber", "description"=>"Ticket number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auto", "Check-In"]}}, "/promotions/priceoffers/flights/ond/{origin}/{destination}"=>{"get"=>{"summary"=>"Price Offers", "description"=>"Retrieve a best price offer given an origin and destination.", "operationId"=>"promotions.priceoffers.flights.ond.origin.destination.get", "x-api-path-slug"=>"promotionspriceoffersflightsondorigindestination-get", "parameters"=>[{"in"=>"query", "name"=>"departureDate", "description"=>"Departure date in local time (YYYY-MM-DD)"}, {"in"=>"path", "name"=>"destination", "description"=>"Destination city"}, {"in"=>"path", "name"=>"origin", "description"=>"Departure city"}, {"in"=>"query", "name"=>"returnDate", "description"=>"Return date in local time (YYYY-MM-DD)"}, {"in"=>"query", "name"=>"service", "description"=>"Optional parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Price", "Offers"]}}, "/references/seatdetails/{aircraftCode}/{cabinCode}"=>{"get"=>{"summary"=>"Seat Details", "description"=>"A description of all available seat details by aircraft type. You can retrieve the full set or details for a particular aircraft type.", "operationId"=>"references.seatdetails.aircraftCode.cabinCode.get", "x-api-path-slug"=>"referencesseatdetailsaircraftcodecabincode-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"http header: application/json or application/xml (Acceptable values are: application/json, application/xml)"}, {"in"=>"path", "name"=>"aircraftCode", "description"=>"Aircraft type"}, {"in"=>"path", "name"=>"cabinCode", "description"=>"Cabin class: M, E, C, F (Acceptable values are: , M, E, C, F)"}, {"in"=>"query", "name"=>"lang", "description"=>"2-letter ISO 3166-1 language code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Seat", "Details"]}}}}, "apis"=>{"name"=>"Lufthansa", "x-slug"=>"lufthansa", "description"=>"Book your flights to Germany, Italy, UK or France online at attractive low fares. Fly via Frankfurt, Munich or Zurich - Lufthansa United States of America", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28453-lh-partner.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"3886", "tags"=>"Airlines,API Provider,General Data,Profiles,Relative Data", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"lufthansa/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"LH Partner", "x-api-slug"=>"lh-partner", "description"=>"Book your flights to Germany, Italy, UK or France online at attractive low fares. Fly via Frankfurt, Munich or Zurich - Lufthansa United States of America", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28453-lh-partner.jpg", "humanURL"=>"http://lufthansa.com", "baseURL"=>"https://api.lufthansa.com//v1", "tags"=>"Airlines,API Provider,General Data,Profiles,Relative Data", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/lufthansa/referencesseatdetailsaircraftcodecabincode-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/lufthansa/lh-partner-openapi.yaml"}]}, {"name"=>"LH Public", "x-api-slug"=>"lh-public", "description"=>"Book your flights to Germany, Italy, UK or France online at attractive low fares. Fly via Frankfurt, Munich or Zurich - Lufthansa United States of America", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28453-lh-partner.jpg", "humanURL"=>"http://lufthansa.com", "baseURL"=>"https://api.lufthansa.com//v1", "tags"=>"Seat,Details", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/lufthansa/referencescountriescountrycode-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/lufthansa/lh-public-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/lufthansa"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/lufthansa"}, {"type"=>"x-website", "url"=>"http://lufthansa.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
gig-crowd{"gigandcrowd-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"GIG & CROWD", "x-complete"=>1, "info"=>{"title"=>"GIG & Crowd", "version"=>"1.0.0"}, "host"=>"gigandcrowd.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/v1/account/user"=>{"get"=>{"summary"=>"Get Account User", "description"=>"Get account user.", "operationId"=>"getApiV1AccountUser", "x-api-path-slug"=>"apiv1accountuser-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "User"]}}, "/api/v1/account/register/org"=>{"post"=>{"summary"=>"Post Account Register Org", "description"=>"Post account register org.", "operationId"=>"postApiV1AccountRegisterOrg", "x-api-path-slug"=>"apiv1accountregisterorg-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Register", "Org"]}}, "/api/v1/account/register/art"=>{"post"=>{"summary"=>"Post Account Register Art", "description"=>"Post account register art.", "operationId"=>"postApiV1AccountRegisterArt", "x-api-path-slug"=>"apiv1accountregisterart-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Register", "Art"]}}, "/api/v1/invitations/{inviteId}"=>{"get"=>{"summary"=>"Get Invitations Inviteid", "description"=>"Get invitations inviteid.", "operationId"=>"getApiV1InvitationsInvite", "x-api-path-slug"=>"apiv1invitationsinviteid-get", "parameters"=>[{"in"=>"path", "name"=>"inviteId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invitations", "Inviteid"]}}, "/api/v1/account/register/invite"=>{"post"=>{"summary"=>"Post Account Register Invite", "description"=>"Post account register invite.", "operationId"=>"postApiV1AccountRegisterInvite", "x-api-path-slug"=>"apiv1accountregisterinvite-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Register", "Invite"]}}, "/api/v1/account/logout"=>{"post"=>{"summary"=>"Post Account Logout", "description"=>"Post account logout.", "operationId"=>"postApiV1AccountLogout", "x-api-path-slug"=>"apiv1accountlogout-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Logout"]}}, "/api/v1/account/avatar"=>{"post"=>{"summary"=>"Post Account Avatar", "description"=>"Post account avatar.", "operationId"=>"postApiV1AccountAvatar", "x-api-path-slug"=>"apiv1accountavatar-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Avatar"]}}, "/api/v1/account/devicetoken"=>{"post"=>{"summary"=>"Post Account Devicetoken", "description"=>"Post account devicetoken.", "operationId"=>"postApiV1AccountDevicetoken", "x-api-path-slug"=>"apiv1accountdevicetoken-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Devicetoken"]}}, "/api/v1/account/culture"=>{"post"=>{"summary"=>"Post Account Culture", "description"=>"Post account culture.", "operationId"=>"postApiV1AccountCulture", "x-api-path-slug"=>"apiv1accountculture-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"culture", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Culture"]}}, "/api/v1/account/external/register/{userSocialId}"=>{"post"=>{"summary"=>"Post Account External Register Usersocialid", "description"=>"Post account external register usersocialid.", "operationId"=>"postApiV1AccountExternalRegisterUsersocial", "x-api-path-slug"=>"apiv1accountexternalregisterusersocialid-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userSocialId", "description"=>"id UserSocial"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "External", "Register", "Usersocialid"]}}, "/api/v1/account/external/link/{provider}"=>{"get"=>{"summary"=>"Get Account External Link Prover", "description"=>"Get account external link prover.", "operationId"=>"getApiV1AccountExternalLinkProver", "x-api-path-slug"=>"apiv1accountexternallinkprovider-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"code"}, {"in"=>"path", "name"=>"provider"}, {"in"=>"query", "name"=>"redirectUri"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "External", "Link", "Prover"]}}, "/api/v1/admin/event/{page}"=>{"get"=>{"summary"=>"Get Admin Event Page", "description"=>"Get admin event page.", "operationId"=>"getApiV1AdminEventPage", "x-api-path-slug"=>"apiv1admineventpage-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"page"}, {"in"=>"query", "name"=>"request.cityId"}, {"in"=>"query", "name"=>"request.from"}, {"in"=>"query", "name"=>"request.isRecommended"}, {"in"=>"query", "name"=>"request.placeId"}, {"in"=>"query", "name"=>"request.placeName"}, {"in"=>"query", "name"=>"request.query"}, {"in"=>"query", "name"=>"request.status"}, {"in"=>"query", "name"=>"request.to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Event", "Page"]}}, "/api/v1/admin/event/approve/{eventId}"=>{"post"=>{"summary"=>"Post Admin Event Approve Eventid", "description"=>"Post admin event approve eventid.", "operationId"=>"postApiV1AdminEventApproveEvent", "x-api-path-slug"=>"apiv1admineventapproveeventid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"eventId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Event", "Approve", "Eventid"]}}, "/api/v1/admin/event/reject"=>{"post"=>{"summary"=>"Post Admin Event Reject", "description"=>"Post admin event reject.", "operationId"=>"postApiV1AdminEventReject", "x-api-path-slug"=>"apiv1admineventreject-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Event", "Reject"]}}, "/api/v1/admin/event/defer"=>{"post"=>{"summary"=>"Post Admin Event Defer", "description"=>"Post admin event defer.", "operationId"=>"postApiV1AdminEventDefer", "x-api-path-slug"=>"apiv1admineventdefer-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Event", "Defer"]}}, "/api/v1/admin/event/add"=>{"post"=>{"summary"=>"Post Admin Event Add", "description"=>"Post admin event add.", "operationId"=>"postApiV1AdminEventAdd", "x-api-path-slug"=>"apiv1admineventadd-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"event", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Event"]}}, "/api/v1/admin/event/tags/main"=>{"get"=>{"summary"=>"Get Admin Event Tags Main", "description"=>"Get admin event tags main.", "operationId"=>"getApiV1AdminEventTagsMain", "x-api-path-slug"=>"apiv1admineventtagsmain-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Event", "Tags", "Main"]}}, "/api/v1/admin/event/tags/additional"=>{"get"=>{"summary"=>"Get Admin Event Tags Additional", "description"=>"Get admin event tags additional.", "operationId"=>"getApiV1AdminEventTagsAdditional", "x-api-path-slug"=>"apiv1admineventtagsadditional-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Event", "Tags", "Itional"]}}, "/api/v1/admin/event/{eventId}/thumbnail/url"=>{"post"=>{"summary"=>"Post Admin Event Eventid Thumbnail Url", "description"=>"Post admin event eventid thumbnail url.", "operationId"=>"postApiV1AdminEventEventThumbnailUrl", "x-api-path-slug"=>"apiv1admineventeventidthumbnailurl-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"eventId"}, {"in"=>"body", "name"=>"url", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Event", "Eventid", "Thumbnail", "Url"]}}, "/api/v1/admin/event/{primaryId}/merge/{secondaryId}"=>{"get"=>{"summary"=>"Get Admin Event Primaryid Merge Secondaryid", "description"=>"Get admin event primaryid merge secondaryid.", "operationId"=>"getApiV1AdminEventPrimaryMergeSecondary", "x-api-path-slug"=>"apiv1admineventprimaryidmergesecondaryid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"primaryId"}, {"in"=>"path", "name"=>"secondaryId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Event", "Primaryid", "Merge", "Secondaryid"]}}, "/api/v1/admin/event/statistic"=>{"get"=>{"summary"=>"Get Admin Event Statistic", "description"=>"Get admin event statistic.", "operationId"=>"getApiV1AdminEventStatistic", "x-api-path-slug"=>"apiv1admineventstatistic-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Event", "Statistic"]}}, "/api/v1/admin/moderator/statistic"=>{"get"=>{"summary"=>"Get Admin Moderator Statistic", "description"=>"Get admin moderator statistic.", "operationId"=>"getApiV1AdminModeratorStatistic", "x-api-path-slug"=>"apiv1adminmoderatorstatistic-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Moderator", "Statistic"]}}, "/api/v1/admin/parser/config"=>{"get"=>{"summary"=>"Get Admin Parser Config", "description"=>"Get admin parser config.", "operationId"=>"getApiV1AdminParserConfig", "x-api-path-slug"=>"apiv1adminparserconfig-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Parser", "Config"]}}, "/api/v1/admin/parser/all"=>{"get"=>{"summary"=>"Get Admin Parser All", "description"=>"Get admin parser all.", "operationId"=>"getApiV1AdminParserAll", "x-api-path-slug"=>"apiv1adminparserall-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Parser"]}}, "/api/v1/admin/parser/logs"=>{"get"=>{"summary"=>"Get Admin Parser Logs", "description"=>"Get admin parser logs.", "operationId"=>"getApiV1AdminParserLogs", "x-api-path-slug"=>"apiv1adminparserlogs-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"request.from"}, {"in"=>"query", "name"=>"request.query"}, {"in"=>"query", "name"=>"request.to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Parser", "Logs"]}}, "/api/v1/admin/parser/statistic"=>{"get"=>{"summary"=>"Get Admin Parser Statistic", "description"=>"Get admin parser statistic.", "operationId"=>"getApiV1AdminParserStatistic", "x-api-path-slug"=>"apiv1adminparserstatistic-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Parser", "Statistic"]}}, "/api/v1/admin/parser/log/error"=>{"post"=>{"summary"=>"Post Admin Parser Log Error", "description"=>"Post admin parser log error.", "operationId"=>"postApiV1AdminParserLogError", "x-api-path-slug"=>"apiv1adminparserlogerror-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Parser", "Log", "Error"]}}, "/api/v1/admin/place/{page}"=>{"get"=>{"summary"=>"Get Admin Place Page", "description"=>"Get admin place page.", "operationId"=>"getApiV1AdminPlacePage", "x-api-path-slug"=>"apiv1adminplacepage-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"page"}, {"in"=>"query", "name"=>"request.cityId"}, {"in"=>"query", "name"=>"request.isRecommended"}, {"in"=>"query", "name"=>"request.query"}, {"in"=>"query", "name"=>"request.status"}, {"in"=>"query", "name"=>"request.url"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Place", "Page"]}}, "/api/v1/admin/place/{placeId}"=>{"put"=>{"summary"=>"Put Admin Place Placeid", "description"=>"Put admin place placeid.", "operationId"=>"putApiV1AdminPlacePlace", "x-api-path-slug"=>"apiv1adminplaceplaceid-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"placeId"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Place", "Placeid"]}, "delete"=>{"summary"=>"Delete Admin Place Placeid", "description"=>"Delete admin place placeid.", "operationId"=>"deleteApiV1AdminPlacePlace", "x-api-path-slug"=>"apiv1adminplaceplaceid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"placeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Place", "Placeid"]}}, "/api/v1/admin/place"=>{"post"=>{"summary"=>"Post Admin Place", "description"=>"Post admin place.", "operationId"=>"postApiV1AdminPlace", "x-api-path-slug"=>"apiv1adminplace-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Place"]}}, "/api/v1/admin/place/{placeId}/thumbnail"=>{"post"=>{"summary"=>"Post Admin Place Placeid Thumbnail", "description"=>"Post admin place placeid thumbnail.", "operationId"=>"postApiV1AdminPlacePlaceThumbnail", "x-api-path-slug"=>"apiv1adminplaceplaceidthumbnail-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Place", "Placeid", "Thumbnail"]}}, "/api/v1/admin/place/{placeId}/photos"=>{"post"=>{"summary"=>"Post Admin Place Placeid Photos", "description"=>"Post admin place placeid photos.", "operationId"=>"postApiV1AdminPlacePlacePhotos", "x-api-path-slug"=>"apiv1adminplaceplaceidphotos-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Place", "Placeid", "Photos"]}}, "/api/v1/admin/place/{placeId}/photo/{photoId}"=>{"delete"=>{"summary"=>"Delete Admin Place Placeid Photo Photoid", "description"=>"Delete admin place placeid photo photoid.", "operationId"=>"deleteApiV1AdminPlacePlacePhotoPhoto", "x-api-path-slug"=>"apiv1adminplaceplaceidphotophotoid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"photoId"}, {"in"=>"path", "name"=>"placeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Place", "Placeid", "Photo", "Photoid"]}}, "/api/v1/admin/place/{placeId}/confirm"=>{"put"=>{"summary"=>"Put Admin Place Placeid Confirm", "description"=>"Put admin place placeid confirm.", "operationId"=>"putApiV1AdminPlacePlaceConfirm", "x-api-path-slug"=>"apiv1adminplaceplaceidconfirm-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"placeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Place", "Placeid", "Confirm"]}}, "/api/v1/admin/place/tags/main"=>{"get"=>{"summary"=>"Get Admin Place Tags Main", "description"=>"Get admin place tags main.", "operationId"=>"getApiV1AdminPlaceTagsMain", "x-api-path-slug"=>"apiv1adminplacetagsmain-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Place", "Tags", "Main"]}}, "/api/v1/admin/place/tags/additional"=>{"get"=>{"summary"=>"Get Admin Place Tags Additional", "description"=>"Get admin place tags additional.", "operationId"=>"getApiV1AdminPlaceTagsAdditional", "x-api-path-slug"=>"apiv1adminplacetagsadditional-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Place", "Tags", "Itional"]}}, "/api/v1/admin/place/{primaryId}/merge/{secondaryId}"=>{"get"=>{"summary"=>"Get Admin Place Primaryid Merge Secondaryid", "description"=>"Get admin place primaryid merge secondaryid.", "operationId"=>"getApiV1AdminPlacePrimaryMergeSecondary", "x-api-path-slug"=>"apiv1adminplaceprimaryidmergesecondaryid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"primaryId"}, {"in"=>"path", "name"=>"secondaryId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Place", "Primaryid", "Merge", "Secondaryid"]}}, "/api/v1/admin/place/statistic"=>{"get"=>{"summary"=>"Get Admin Place Statistic", "description"=>"Get admin place statistic.", "operationId"=>"getApiV1AdminPlaceStatistic", "x-api-path-slug"=>"apiv1adminplacestatistic-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Place", "Statistic"]}}, "/api/v1/admin/placeReview/{page}"=>{"get"=>{"summary"=>"Get Admin Placereview Page", "description"=>"Get admin placereview page.", "operationId"=>"getApiV1AdminPlacereviewPage", "x-api-path-slug"=>"apiv1adminplacereviewpage-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"page"}, {"in"=>"query", "name"=>"request.placeName"}, {"in"=>"query", "name"=>"request.status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Placereview", "Page"]}}, "/api/v1/admin/placeReview/{reviewId}/confirm"=>{"post"=>{"summary"=>"Post Admin Placereview Reviewid Confirm", "description"=>"Post admin placereview reviewid confirm.", "operationId"=>"postApiV1AdminPlacereviewReviewConfirm", "x-api-path-slug"=>"apiv1adminplacereviewreviewidconfirm-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"reviewId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Placereview", "Reviewid", "Confirm"]}}, "/api/v1/admin/placeReview/{reviewId}/reject"=>{"post"=>{"summary"=>"Post Admin Placereview Reviewid Reject", "description"=>"Post admin placereview reviewid reject.", "operationId"=>"postApiV1AdminPlacereviewReviewReject", "x-api-path-slug"=>"apiv1adminplacereviewreviewidreject-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"reason", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"reviewId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Placereview", "Reviewid", "Reject"]}}, "/api/v1/admin/promocode/generate"=>{"get"=>{"summary"=>"Get Admin Promocode Generate", "description"=>"Get admin promocode generate.", "operationId"=>"getApiV1AdminPromocodeGenerate", "x-api-path-slug"=>"apiv1adminpromocodegenerate-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Promocode", "Generate"]}}, "/api/v1/admin/promocode/{page}"=>{"get"=>{"summary"=>"Get Admin Promocode Page", "description"=>"Get admin promocode page.", "operationId"=>"getApiV1AdminPromocodePage", "x-api-path-slug"=>"apiv1adminpromocodepage-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"page"}, {"in"=>"query", "name"=>"request.used"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Promocode", "Page"]}}, "/api/v1/admin/promocode"=>{"post"=>{"summary"=>"Post Admin Promocode", "description"=>"Post admin promocode.", "operationId"=>"postApiV1AdminPromocode", "x-api-path-slug"=>"apiv1adminpromocode-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Promocode"]}}, "/api/v1/admin/promocode/{promoCodeId}"=>{"put"=>{"summary"=>"Put Admin Promocode Promocodeid", "description"=>"Put admin promocode promocodeid.", "operationId"=>"putApiV1AdminPromocodePromocode", "x-api-path-slug"=>"apiv1adminpromocodepromocodeid-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"promoCodeId"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Promocode", "Promocodeid"]}, "delete"=>{"summary"=>"Delete Admin Promocode Promocodeid", "description"=>"Delete admin promocode promocodeid.", "operationId"=>"deleteApiV1AdminPromocodePromocode", "x-api-path-slug"=>"apiv1adminpromocodepromocodeid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"promoCodeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Promocode", "Promocodeid"]}}, "/api/v1/admin/settings/{userId}"=>{"get"=>{"summary"=>"Get Admin Settings Userid", "description"=>"Get admin settings userid.", "operationId"=>"getApiV1AdminSettingsUser", "x-api-path-slug"=>"apiv1adminsettingsuserid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Settings", "Userid"]}, "post"=>{"summary"=>"Post Admin Settings Userid", "description"=>"Post admin settings userid.", "operationId"=>"postApiV1AdminSettingsUser", "x-api-path-slug"=>"apiv1adminsettingsuserid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Settings", "Userid"]}}, "/api/v1/admin/statistics"=>{"get"=>{"summary"=>"Get Admin Statistics", "description"=>"Get admin statistics.", "operationId"=>"getApiV1AdminStatistics", "x-api-path-slug"=>"apiv1adminstatistics-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Statistics"]}}, "/api/v1/admin/statistics/{type}"=>{"get"=>{"summary"=>"Get Admin Statistics Type", "description"=>"Get admin statistics type.", "operationId"=>"getApiV1AdminStatisticsType", "x-api-path-slug"=>"apiv1adminstatisticstype-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Statistics", "Type"]}}, "/api/v1/admin/transactions"=>{"get"=>{"summary"=>"Get Admin Transactions", "description"=>"Get admin transactions.", "operationId"=>"getApiV1AdminTransactions", "x-api-path-slug"=>"apiv1admintransactions-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Transactions"]}}, "/api/v1/admin/transactions/{filter}"=>{"get"=>{"summary"=>"Get Admin Transactions Filter", "description"=>"Get admin transactions filter.", "operationId"=>"getApiV1AdminTransactionsFilter", "x-api-path-slug"=>"apiv1admintransactionsfilter-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"filter"}, {"in"=>"query", "name"=>"range.from"}, {"in"=>"query", "name"=>"range.to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "Transactions", "Filter"]}}, "/api/v1/admin/user"=>{"get"=>{"summary"=>"Get Admin User", "description"=>"Get admin user.", "operationId"=>"getApiV1AdminUser", "x-api-path-slug"=>"apiv1adminuser-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"filter.email"}, {"in"=>"query", "name"=>"filter.emailConfirmed"}, {"in"=>"query", "name"=>"filter.phoneConfirmed"}, {"in"=>"query", "name"=>"filter.phoneNumber"}, {"in"=>"query", "name"=>"filter.roleId"}, {"in"=>"query", "name"=>"filter.status"}, {"in"=>"query", "name"=>"filter.userName"}, {"in"=>"query", "name"=>"page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "User"]}}, "/api/v1/admin/user/{userId}/avatar"=>{"post"=>{"summary"=>"Post Admin User Userid Avatar", "description"=>"Post admin user userid avatar.", "operationId"=>"postApiV1AdminUserUserAvatar", "x-api-path-slug"=>"apiv1adminuseruseridavatar-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "User", "Userid", "Avatar"]}}, "/api/v1/admin/user/roles/{userId}"=>{"get"=>{"summary"=>"Get Admin User Roles Userid", "description"=>"Get admin user roles userid.", "operationId"=>"getApiV1AdminUserRolesUser", "x-api-path-slug"=>"apiv1adminuserrolesuserid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "User", "Roles", "Userid"]}, "post"=>{"summary"=>"Post Admin User Roles Userid", "description"=>"Post admin user roles userid.", "operationId"=>"postApiV1AdminUserRolesUser", "x-api-path-slug"=>"apiv1adminuserrolesuserid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"roles", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "User", "Roles", "Userid"]}}, "/api/v1/admin/user/roles"=>{"get"=>{"summary"=>"Get Admin User Roles", "description"=>"Get admin user roles.", "operationId"=>"getApiV1AdminUserRoles", "x-api-path-slug"=>"apiv1adminuserroles-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "User", "Roles"]}}, "/api/v1/admin/user/empty/{role}"=>{"get"=>{"summary"=>"Get Admin User Empty Role", "description"=>"Get admin user empty role.", "operationId"=>"getApiV1AdminUserEmptyRole", "x-api-path-slug"=>"apiv1adminuseremptyrole-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"role"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "User", "Empty", "Role"]}}, "/api/v1/admin/user/client/{userId}"=>{"get"=>{"summary"=>"Get Admin User Client Userid", "description"=>"Get admin user client userid.", "operationId"=>"getApiV1AdminUserClientUser", "x-api-path-slug"=>"apiv1adminuserclientuserid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "User", "Client", "Userid"]}, "post"=>{"summary"=>"Post Admin User Client Userid", "description"=>"Post admin user client userid.", "operationId"=>"postApiV1AdminUserClientUser", "x-api-path-slug"=>"apiv1adminuserclientuserid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "User", "Client", "Userid"]}}, "/api/v1/admin/user/emailAndPhone/{userId}"=>{"post"=>{"summary"=>"Post Admin User Emailandphone Userid", "description"=>"Post admin user emailandphone userid.", "operationId"=>"postApiV1AdminUserEmailandphoneUser", "x-api-path-slug"=>"apiv1adminuseremailandphoneuserid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin", "User", "Emailandphone", "Userid"]}}, "/api/v1/art/{unique}/details"=>{"get"=>{"summary"=>"Get Art Unique Details", "description"=>"Get art unique details.", "operationId"=>"getApiV1ArtUniqueDetails", "x-api-path-slug"=>"apiv1artuniquedetails-get", "parameters"=>[{"in"=>"path", "name"=>"unique"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Unique", "Details"]}}, "/api/v1/art/{id}/videos"=>{"get"=>{"summary"=>"Get Art Veos", "description"=>"Get art veos.", "operationId"=>"getApiV1ArtVeos", "x-api-path-slug"=>"apiv1artidvideos-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Veos"]}}, "/api/v1/art/{id}/events/past"=>{"get"=>{"summary"=>"Get Art Events Past", "description"=>"Get art events past.", "operationId"=>"getApiV1ArtEventsPast", "x-api-path-slug"=>"apiv1artideventspast-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Events", "Past"]}}, "/api/v1/art/invited/{artistId}/{eventId}"=>{"get"=>{"summary"=>"Get Art Invited Artistid Eventid", "description"=>"Get art invited artistid eventid.", "operationId"=>"getApiV1ArtInvitedArtistEvent", "x-api-path-slug"=>"apiv1artinvitedartistideventid-get", "parameters"=>[{"in"=>"path", "name"=>"artistId"}, {"in"=>"path", "name"=>"eventId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Invited", "Artistid", "Eventid"]}}, "/api/v1/art/search/{page}"=>{"post"=>{"summary"=>"Post Art Search Page", "description"=>"Post art search page.", "operationId"=>"postApiV1ArtSearchPage", "x-api-path-slug"=>"apiv1artsearchpage-post", "parameters"=>[{"in"=>"path", "name"=>"page"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Search", "Page"]}}, "/api/v1/art/info"=>{"post"=>{"summary"=>"Post Art Info", "description"=>"Post art info.", "operationId"=>"postApiV1ArtInfo", "x-api-path-slug"=>"apiv1artinfo-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Info"]}}, "/api/v1/art/riderinfo"=>{"post"=>{"summary"=>"Post Art Rerinfo", "description"=>"Post art rerinfo.", "operationId"=>"postApiV1ArtRerinfo", "x-api-path-slug"=>"apiv1artriderinfo-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Rerinfo"]}}, "/api/v1/art/rider"=>{"get"=>{"summary"=>"Get Art Rer", "description"=>"Get art rer.", "operationId"=>"getApiV1ArtRer", "x-api-path-slug"=>"apiv1artrider-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Rer"]}, "post"=>{"summary"=>"Post Art Rer", "description"=>"Post art rer.", "operationId"=>"postApiV1ArtRer", "x-api-path-slug"=>"apiv1artrider-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Rer"]}, "delete"=>{"summary"=>"Delete Art Rer", "description"=>"Delete art rer.", "operationId"=>"deleteApiV1ArtRer", "x-api-path-slug"=>"apiv1artrider-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Rer"]}}, "/api/v1/art/rider/home"=>{"get"=>{"summary"=>"Get Art Rer Home", "description"=>"Get art rer home.", "operationId"=>"getApiV1ArtRerHome", "x-api-path-slug"=>"apiv1artriderhome-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Rer", "Home"]}, "post"=>{"summary"=>"Post Art Rer Home", "description"=>"Post art rer home.", "operationId"=>"postApiV1ArtRerHome", "x-api-path-slug"=>"apiv1artriderhome-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Rer", "Home"]}, "delete"=>{"summary"=>"Delete Art Rer Home", "description"=>"Delete art rer home.", "operationId"=>"deleteApiV1ArtRerHome", "x-api-path-slug"=>"apiv1artriderhome-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Rer", "Home"]}}, "/api/v1/art/background"=>{"post"=>{"summary"=>"Post Art Background", "description"=>"Post art background.", "operationId"=>"postApiV1ArtBackground", "x-api-path-slug"=>"apiv1artbackground-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Background"]}}, "/api/v1/art/photo/{photoId}"=>{"get"=>{"summary"=>"Get Art Photo Photoid", "description"=>"Get art photo photoid.", "operationId"=>"getApiV1ArtPhotoPhoto", "x-api-path-slug"=>"apiv1artphotophotoid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"photoId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Photo", "Photoid"]}}, "/api/v1/art/photo/{photoId}/thumb"=>{"get"=>{"summary"=>"Get Art Photo Photoid Thumb", "description"=>"Get art photo photoid thumb.", "operationId"=>"getApiV1ArtPhotoPhotoThumb", "x-api-path-slug"=>"apiv1artphotophotoidthumb-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"photoId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Photo", "Photoid", "Thumb"]}}, "/api/v1/art/photo/{type}"=>{"post"=>{"summary"=>"Post Art Photo Type", "description"=>"Post art photo type.", "operationId"=>"postApiV1ArtPhotoType", "x-api-path-slug"=>"apiv1artphototype-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Photo", "Type"]}}, "/api/v1/art/link"=>{"post"=>{"summary"=>"Post Art Link", "description"=>"Post art link.", "operationId"=>"postApiV1ArtLink", "x-api-path-slug"=>"apiv1artlink-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Link"]}}, "/api/v1/art/photo/{id}"=>{"delete"=>{"summary"=>"Delete Art Photo", "description"=>"Delete art photo.", "operationId"=>"deleteApiV1ArtPhoto", "x-api-path-slug"=>"apiv1artphotoid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Photo"]}}, "/api/v1/art/link/{id}"=>{"delete"=>{"summary"=>"Delete Art Link", "description"=>"Delete art link.", "operationId"=>"deleteApiV1ArtLink", "x-api-path-slug"=>"apiv1artlinkid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Link"]}}, "/api/v1/art/video"=>{"post"=>{"summary"=>"Post Art Veo", "description"=>"Post art veo.", "operationId"=>"postApiV1ArtVeo", "x-api-path-slug"=>"apiv1artvideo-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Veo"]}}, "/api/v1/art/video/{id}"=>{"delete"=>{"summary"=>"Delete Art Veo", "description"=>"Delete art veo.", "operationId"=>"deleteApiV1ArtVeo", "x-api-path-slug"=>"apiv1artvideoid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Veo"]}}, "/api/v1/art/video/{id}/main"=>{"post"=>{"summary"=>"Post Art Veo Main", "description"=>"Post art veo main.", "operationId"=>"postApiV1ArtVeoMain", "x-api-path-slug"=>"apiv1artvideoidmain-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art", "Veo", "Main"]}}, "/api/v1/Art"=>{"get"=>{"summary"=>"Get Art", "description"=>"Get art.", "operationId"=>"getApiV1Art", "x-api-path-slug"=>"apiv1art-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Art"]}}, "/api/v1/ArtistRequest"=>{"post"=>{"summary"=>"Post Artistrequest", "description"=>"Post artistrequest.", "operationId"=>"postApiV1Artistrequest", "x-api-path-slug"=>"apiv1artistrequest-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Artistrequest"]}}, "/api/v1/city/events"=>{"get"=>{"summary"=>"Get City Events", "description"=>"Get city events.", "operationId"=>"getApiV1CityEvents", "x-api-path-slug"=>"apiv1cityevents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["City", "Events"]}}, "/api/v1/city/current"=>{"get"=>{"summary"=>"Get City Current", "description"=>"Get city current.", "operationId"=>"getApiV1CityCurrent", "x-api-path-slug"=>"apiv1citycurrent-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["City", "Current"]}}, "/api/v1/city/{query}"=>{"get"=>{"summary"=>"Get City Query", "description"=>"Get city query.", "operationId"=>"getApiV1CityQuery", "x-api-path-slug"=>"apiv1cityquery-get", "parameters"=>[{"in"=>"path", "name"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["City", "Query"]}}, "/api/v1/Config"=>{"get"=>{"summary"=>"Get Config", "description"=>"Get config.", "operationId"=>"getApiV1Config", "x-api-path-slug"=>"apiv1config-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Config"]}}, "/api/v1/country/{query}"=>{"get"=>{"summary"=>"Get Country Query", "description"=>"Get country query.", "operationId"=>"getApiV1CountryQuery", "x-api-path-slug"=>"apiv1countryquery-get", "parameters"=>[{"in"=>"path", "name"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Country", "Query"]}}, "/api/v1/email/send"=>{"post"=>{"summary"=>"Post Email Send", "description"=>"Post email send.", "operationId"=>"postApiV1EmailSend", "x-api-path-slug"=>"apiv1emailsend-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Send"]}}, "/api/v1/email/confirm"=>{"post"=>{"summary"=>"Post Email Confirm", "description"=>"Post email confirm.", "operationId"=>"postApiV1EmailConfirm", "x-api-path-slug"=>"apiv1emailconfirm-post", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"email", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Confirm"]}}, "/api/v1/email/save"=>{"put"=>{"summary"=>"Put Email Save", "description"=>"Put email save.", "operationId"=>"putApiV1EmailSave", "x-api-path-slug"=>"apiv1emailsave-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"email", "description"=>"Email", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Save"]}}, "/api/v1/event/{id}/details"=>{"get"=>{"summary"=>"Get Event Details", "description"=>"Get event details.", "operationId"=>"getApiV1EventDetails", "x-api-path-slug"=>"apiv1eventiddetails-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Details"]}}, "/api/v1/event/{unique}/details"=>{"get"=>{"summary"=>"Get Event Unique Details", "description"=>"Get event unique details.", "operationId"=>"getApiV1EventUniqueDetails", "x-api-path-slug"=>"apiv1eventuniquedetails-get", "parameters"=>[{"in"=>"path", "name"=>"unique"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Unique", "Details"]}}, "/api/v1/event/{id}"=>{"get"=>{"summary"=>"Get Event", "description"=>"Get event.", "operationId"=>"getApiV1Event", "x-api-path-slug"=>"apiv1eventid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/api/v1/event/active"=>{"get"=>{"summary"=>"Get Event Active", "description"=>"Get event active.", "operationId"=>"getApiV1EventActive", "x-api-path-slug"=>"apiv1eventactive-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Active"]}}, "/api/v1/event/past"=>{"get"=>{"summary"=>"Get Event Past", "description"=>"Get event past.", "operationId"=>"getApiV1EventPast", "x-api-path-slug"=>"apiv1eventpast-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Past"]}}, "/api/v1/event/sales/{eventId}/start"=>{"post"=>{"summary"=>"Post Event Sales Eventid Start", "description"=>"Post event sales eventid start.", "operationId"=>"postApiV1EventSalesEventStart", "x-api-path-slug"=>"apiv1eventsaleseventidstart-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"eventId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Sales", "Eventid", "Start"]}}, "/api/v1/event/sales/{eventId}/stop"=>{"post"=>{"summary"=>"Post Event Sales Eventid Stop", "description"=>"Post event sales eventid stop.", "operationId"=>"postApiV1EventSalesEventStop", "x-api-path-slug"=>"apiv1eventsaleseventidstop-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"eventId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Sales", "Eventid", "Stop"]}}, "/api/v1/event/add"=>{"post"=>{"summary"=>"Post Event Add", "description"=>"Post event add.", "operationId"=>"postApiV1EventAdd", "x-api-path-slug"=>"apiv1eventadd-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/api/v1/event/del/{id}"=>{"delete"=>{"summary"=>"Delete Event Del", "description"=>"Delete event del.", "operationId"=>"deleteApiV1EventDel", "x-api-path-slug"=>"apiv1eventdelid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Del"]}}, "/api/v1/event/banner/{eventId}"=>{"post"=>{"summary"=>"Post Event Banner Eventid", "description"=>"Post event banner eventid.", "operationId"=>"postApiV1EventBannerEvent", "x-api-path-slug"=>"apiv1eventbannereventid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Banner", "Eventid"]}, "delete"=>{"summary"=>"Delete Event Banner Eventid", "description"=>"Delete event banner eventid.", "operationId"=>"deleteApiV1EventBannerEvent", "x-api-path-slug"=>"apiv1eventbannereventid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"eventId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Banner", "Eventid"]}}, "/api/v1/event/save"=>{"post"=>{"summary"=>"Post Event Save", "description"=>"Post event save.", "operationId"=>"postApiV1EventSave", "x-api-path-slug"=>"apiv1eventsave-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "description"=>",", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Save"]}}, "/api/v1/event/promo/{eventId}"=>{"post"=>{"summary"=>"Post Event Promo Eventid", "description"=>"Post event promo eventid.", "operationId"=>"postApiV1EventPromoEvent", "x-api-path-slug"=>"apiv1eventpromoeventid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Promo", "Eventid"]}, "delete"=>{"summary"=>"Delete Event Promo Eventid", "description"=>"Delete event promo eventid.", "operationId"=>"deleteApiV1EventPromoEvent", "x-api-path-slug"=>"apiv1eventpromoeventid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"eventId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Promo", "Eventid"]}}, "/api/v1/event/{eventId}/video"=>{"post"=>{"summary"=>"Post Event Eventid Veo", "description"=>"Post event eventid veo.", "operationId"=>"postApiV1EventEventVeo", "x-api-path-slug"=>"apiv1eventeventidvideo-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"eventId"}, {"in"=>"body", "name"=>"url", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Eventid", "Veo"]}}, "/api/v1/event/{eventId}/video/{videoId}"=>{"delete"=>{"summary"=>"Delete Event Eventid Veo Veoid", "description"=>"Delete event eventid veo veoid.", "operationId"=>"deleteApiV1EventEventVeoVeo", "x-api-path-slug"=>"apiv1eventeventidvideovideoid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"eventId"}, {"in"=>"path", "name"=>"videoId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Eventid", "Veo", "Veoid"]}}, "/api/v1/event/{eventId}/photo"=>{"post"=>{"summary"=>"Post Event Eventid Photo", "description"=>"Post event eventid photo.", "operationId"=>"postApiV1EventEventPhoto", "x-api-path-slug"=>"apiv1eventeventidphoto-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Eventid", "Photo"]}}, "/api/v1/event/{eventId}/photos"=>{"post"=>{"summary"=>"Post Event Eventid Photos", "description"=>"Post event eventid photos.", "operationId"=>"postApiV1EventEventPhotos", "x-api-path-slug"=>"apiv1eventeventidphotos-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Eventid", "Photos"]}}, "/api/v1/event/{eventId}/photo/{photoId}"=>{"delete"=>{"summary"=>"Delete Event Eventid Photo Photoid", "description"=>"Delete event eventid photo photoid.", "operationId"=>"deleteApiV1EventEventPhotoPhoto", "x-api-path-slug"=>"apiv1eventeventidphotophotoid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"eventId"}, {"in"=>"path", "name"=>"photoId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Eventid", "Photo", "Photoid"]}}, "/api/v1/event/{eventId}/partner"=>{"post"=>{"summary"=>"Post Event Eventid Partner", "description"=>"Post event eventid partner.", "operationId"=>"postApiV1EventEventPartner", "x-api-path-slug"=>"apiv1eventeventidpartner-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Eventid", "Partner"]}, "delete"=>{"summary"=>"Delete Event Eventid Partner", "description"=>"Delete event eventid partner.", "operationId"=>"deleteApiV1EventEventPartner", "x-api-path-slug"=>"apiv1eventeventidpartner-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"eventId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Eventid", "Partner"]}}, "/api/v1/event/add/private"=>{"post"=>{"summary"=>"Post Event Add Private", "description"=>"Post event add private.", "operationId"=>"postApiV1EventAddPrivate", "x-api-path-slug"=>"apiv1eventaddprivate-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "description"=>",", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "", "Private"]}}, "/api/v1/finance/active"=>{"get"=>{"summary"=>"Get Finance Active", "description"=>"Get finance active.", "operationId"=>"getApiV1FinanceActive", "x-api-path-slug"=>"apiv1financeactive-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Finance", "Active"]}}, "/api/v1/genre/{query}"=>{"get"=>{"summary"=>"Get Genre Query", "description"=>"Get genre query.", "operationId"=>"getApiV1GenreQuery", "x-api-path-slug"=>"apiv1genrequery-get", "parameters"=>[{"in"=>"path", "name"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Genre", "Query"]}}, "/api/v1/gigme/account/user"=>{"get"=>{"summary"=>"Get Gigme Account User", "description"=>"Get gigme account user.", "operationId"=>"getApiV1GigmeAccountUser", "x-api-path-slug"=>"apiv1gigmeaccountuser-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Account", "User"]}, "post"=>{"summary"=>"Post Gigme Account User", "description"=>"Post gigme account user.", "operationId"=>"postApiV1GigmeAccountUser", "x-api-path-slug"=>"apiv1gigmeaccountuser-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Account", "User"]}}, "/api/v1/gigme/account/user/{id}"=>{"get"=>{"summary"=>"Get Gigme Account User", "description"=>"Get gigme account user.", "operationId"=>"getApiV1GigmeAccountUser", "x-api-path-slug"=>"apiv1gigmeaccountuserid-get", "parameters"=>[{"in"=>"query", "name"=>"hash"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Account", "User"]}}, "/api/v1/gigme/account/register"=>{"post"=>{"summary"=>"Post Gigme Account Register", "description"=>"Post gigme account register.", "operationId"=>"postApiV1GigmeAccountRegister", "x-api-path-slug"=>"apiv1gigmeaccountregister-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Account", "Register"]}}, "/api/v1/gigme/account/external/register/{userSocialId}"=>{"post"=>{"summary"=>"Post Gigme Account External Register Usersocialid", "description"=>"Post gigme account external register usersocialid.", "operationId"=>"postApiV1GigmeAccountExternalRegisterUsersocial", "x-api-path-slug"=>"apiv1gigmeaccountexternalregisterusersocialid-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userSocialId", "description"=>"id UserSocial"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Account", "External", "Register", "Usersocialid"]}}, "/api/v1/gigme/analytics"=>{"post"=>{"summary"=>"Post Gigme Analytics", "description"=>"Post gigme analytics.", "operationId"=>"postApiV1GigmeAnalytics", "x-api-path-slug"=>"apiv1gigmeanalytics-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Analytics"]}}, "/api/v1/gigme/artist/search/{page}"=>{"post"=>{"summary"=>"Post Gigme Artist Search Page", "description"=>"Post gigme artist search page.", "operationId"=>"postApiV1GigmeArtistSearchPage", "x-api-path-slug"=>"apiv1gigmeartistsearchpage-post", "parameters"=>[{"in"=>"path", "name"=>"page"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Artist", "Search", "Page"]}}, "/api/v1/gigme/artist/searchActive"=>{"post"=>{"summary"=>"Post Gigme Artist Searchactive", "description"=>"Post gigme artist searchactive.", "operationId"=>"postApiV1GigmeArtistSearchactive", "x-api-path-slug"=>"apiv1gigmeartistsearchactive-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Artist", "Searchactive"]}}, "/api/v1/gigme/artist"=>{"get"=>{"summary"=>"Get Gigme Artist", "description"=>"Get gigme artist.", "operationId"=>"getApiV1GigmeArtist", "x-api-path-slug"=>"apiv1gigmeartist-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Artist"]}}, "/api/v1/gigme/artist/{unique}/details"=>{"get"=>{"summary"=>"Get Gigme Artist Unique Details", "description"=>"Get gigme artist unique details.", "operationId"=>"getApiV1GigmeArtistUniqueDetails", "x-api-path-slug"=>"apiv1gigmeartistuniquedetails-get", "parameters"=>[{"in"=>"path", "name"=>"unique"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Artist", "Unique", "Details"]}}, "/api/v1/gigme/artist/{id}/videos"=>{"get"=>{"summary"=>"Get Gigme Artist Veos", "description"=>"Get gigme artist veos.", "operationId"=>"getApiV1GigmeArtistVeos", "x-api-path-slug"=>"apiv1gigmeartistidvideos-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Artist", "Veos"]}}, "/api/v1/gigme/artist/{id}/events/past"=>{"get"=>{"summary"=>"Get Gigme Artist Events Past", "description"=>"Get gigme artist events past.", "operationId"=>"getApiV1GigmeArtistEventsPast", "x-api-path-slug"=>"apiv1gigmeartistideventspast-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Artist", "Events", "Past"]}}, "/api/v1/gigme/artist/{id}/events/future"=>{"get"=>{"summary"=>"Get Gigme Artist Events Future", "description"=>"Get gigme artist events future.", "operationId"=>"getApiV1GigmeArtistEventsFuture", "x-api-path-slug"=>"apiv1gigmeartistideventsfuture-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Artist", "Events", "Future"]}}, "/api/v1/gigme/city/events"=>{"get"=>{"summary"=>"Get Gigme City Events", "description"=>"Get gigme city events.", "operationId"=>"getApiV1GigmeCityEvents", "x-api-path-slug"=>"apiv1gigmecityevents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "City", "Events"]}}, "/api/v1/gigme/city/current"=>{"get"=>{"summary"=>"Get Gigme City Current", "description"=>"Get gigme city current.", "operationId"=>"getApiV1GigmeCityCurrent", "x-api-path-slug"=>"apiv1gigmecitycurrent-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "City", "Current"]}}, "/api/v1/gigme/email/save"=>{"put"=>{"summary"=>"Put Gigme Email Save", "description"=>"Put gigme email save.", "operationId"=>"putApiV1GigmeEmailSave", "x-api-path-slug"=>"apiv1gigmeemailsave-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"email", "description"=>"Email", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Email", "Save"]}}, "/api/v1/gigme/email/send"=>{"post"=>{"summary"=>"Post Gigme Email Send", "description"=>"Post gigme email send.", "operationId"=>"postApiV1GigmeEmailSend", "x-api-path-slug"=>"apiv1gigmeemailsend-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Email", "Send"]}}, "/api/v1/gigme/email/confirm"=>{"post"=>{"summary"=>"Post Gigme Email Confirm", "description"=>"Post gigme email confirm.", "operationId"=>"postApiV1GigmeEmailConfirm", "x-api-path-slug"=>"apiv1gigmeemailconfirm-post", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"email", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Email", "Confirm"]}}, "/api/v1/gigme/event/previews/{page}"=>{"post"=>{"summary"=>"Post Gigme Event Previews Page", "description"=>"Post gigme event previews page.", "operationId"=>"postApiV1GigmeEventPreviewsPage", "x-api-path-slug"=>"apiv1gigmeeventpreviewspage-post", "parameters"=>[{"in"=>"path", "name"=>"page"}, {"in"=>"body", "name"=>"preview", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Event", "Previews", "Page"]}}, "/api/v1/gigme/event/{page}"=>{"post"=>{"summary"=>"Post Gigme Event Page", "description"=>"Post gigme event page.", "operationId"=>"postApiV1GigmeEventPage", "x-api-path-slug"=>"apiv1gigmeeventpage-post", "parameters"=>[{"in"=>"path", "name"=>"page"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Event", "Page"]}}, "/api/v1/gigme/event/previews/map"=>{"post"=>{"summary"=>"Post Gigme Event Previews Map", "description"=>"Post gigme event previews map.", "operationId"=>"postApiV1GigmeEventPreviewsMap", "x-api-path-slug"=>"apiv1gigmeeventpreviewsmap-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Event", "Previews", "Map"]}}, "/api/v1/gigme/event/history"=>{"get"=>{"summary"=>"Get Gigme Event History", "description"=>"Get gigme event history.", "operationId"=>"getApiV1GigmeEventHistory", "x-api-path-slug"=>"apiv1gigmeeventhistory-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Event", "History"]}}, "/api/v1/gigme/event/recommended"=>{"get"=>{"summary"=>"Get Gigme Event Recommended", "description"=>"Get gigme event recommended.", "operationId"=>"getApiV1GigmeEventRecommended", "x-api-path-slug"=>"apiv1gigmeeventrecommended-get", "parameters"=>[{"in"=>"query", "name"=>"request.amount"}, {"in"=>"query", "name"=>"request.dateFilter"}, {"in"=>"query", "name"=>"request.type", "description"=>"Type of Preview (event or place)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Event", "Recommended"]}}, "/api/v1/gigme/event/{eventId}/related"=>{"get"=>{"summary"=>"Get Gigme Event Eventid Related", "description"=>"Get gigme event eventid related.", "operationId"=>"getApiV1GigmeEventEventRelated", "x-api-path-slug"=>"apiv1gigmeeventeventidrelated-get", "parameters"=>[{"in"=>"path", "name"=>"eventId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Event", "Eventid", "Related"]}}, "/api/v1/gigme/event/{placeId}/upcoming"=>{"get"=>{"summary"=>"Get Gigme Event Placeid Upcoming", "description"=>"Get gigme event placeid upcoming.", "operationId"=>"getApiV1GigmeEventPlaceUpcoming", "x-api-path-slug"=>"apiv1gigmeeventplaceidupcoming-get", "parameters"=>[{"in"=>"path", "name"=>"placeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Event", "Placeid", "Upcoming"]}}, "/api/v1/gigme/event/{id}/details"=>{"get"=>{"summary"=>"Get Gigme Event Details", "description"=>"Get gigme event details.", "operationId"=>"getApiV1GigmeEventDetails", "x-api-path-slug"=>"apiv1gigmeeventiddetails-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Event", "Details"]}}, "/api/v1/gigme/event/{unique}/details"=>{"get"=>{"summary"=>"Get Gigme Event Unique Details", "description"=>"Get gigme event unique details.", "operationId"=>"getApiV1GigmeEventUniqueDetails", "x-api-path-slug"=>"apiv1gigmeeventuniquedetails-get", "parameters"=>[{"in"=>"path", "name"=>"unique"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Event", "Unique", "Details"]}}, "/api/v1/gigme/genre/{query}"=>{"get"=>{"summary"=>"Get Gigme Genre Query", "description"=>"Get gigme genre query.", "operationId"=>"getApiV1GigmeGenreQuery", "x-api-path-slug"=>"apiv1gigmegenrequery-get", "parameters"=>[{"in"=>"path", "name"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Genre", "Query"]}}, "/api/v1/gigme/event/{eventId}/like"=>{"get"=>{"summary"=>"Get Gigme Event Eventid Like", "description"=>"Get gigme event eventid like.", "operationId"=>"getApiV1GigmeEventEventLike", "x-api-path-slug"=>"apiv1gigmeeventeventidlike-get", "parameters"=>[{"in"=>"path", "name"=>"eventId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Event", "Eventid", "Like"]}}, "/api/v1/gigme/event/{eventId}/dislike"=>{"get"=>{"summary"=>"Get Gigme Event Eventid Dislike", "description"=>"Get gigme event eventid dislike.", "operationId"=>"getApiV1GigmeEventEventDislike", "x-api-path-slug"=>"apiv1gigmeeventeventiddislike-get", "parameters"=>[{"in"=>"path", "name"=>"eventId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Event", "Eventid", "Dislike"]}}, "/api/v1/gigme/place/{placeId}/like"=>{"get"=>{"summary"=>"Get Gigme Place Placeid Like", "description"=>"Get gigme place placeid like.", "operationId"=>"getApiV1GigmePlacePlaceLike", "x-api-path-slug"=>"apiv1gigmeplaceplaceidlike-get", "parameters"=>[{"in"=>"path", "name"=>"placeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Place", "Placeid", "Like"]}}, "/api/v1/gigme/place/{placeId}/dislike"=>{"get"=>{"summary"=>"Get Gigme Place Placeid Dislike", "description"=>"Get gigme place placeid dislike.", "operationId"=>"getApiV1GigmePlacePlaceDislike", "x-api-path-slug"=>"apiv1gigmeplaceplaceiddislike-get", "parameters"=>[{"in"=>"path", "name"=>"placeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Place", "Placeid", "Dislike"]}}, "/api/v1/gigme/likes/sync"=>{"post"=>{"summary"=>"Post Gigme Likes Sync", "description"=>"Post gigme likes sync.", "operationId"=>"postApiV1GigmeLikesSync", "x-api-path-slug"=>"apiv1gigmelikessync-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Likes", "Sync"]}}, "/api/v1/gigme/password/forgot"=>{"post"=>{"summary"=>"Post Gigme Password Forgot", "description"=>"Post gigme password forgot.", "operationId"=>"postApiV1GigmePasswordForgot", "x-api-path-slug"=>"apiv1gigmepasswordforgot-post", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"Email", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Password", "Forgot"]}}, "/api/v1/gigme/password/restore"=>{"post"=>{"summary"=>"Post Gigme Password Restore", "description"=>"Post gigme password restore.", "operationId"=>"postApiV1GigmePasswordRestore", "x-api-path-slug"=>"apiv1gigmepasswordrestore-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Password", "Restore"]}}, "/api/v1/gigme/password/change"=>{"post"=>{"summary"=>"Post Gigme Password Change", "description"=>"Post gigme password change.", "operationId"=>"postApiV1GigmePasswordChange", "x-api-path-slug"=>"apiv1gigmepasswordchange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Password", "Change"]}}, "/api/v1/gigme/phone/save"=>{"put"=>{"summary"=>"Put Gigme Phone Save", "description"=>"Put gigme phone save.", "operationId"=>"putApiV1GigmePhoneSave", "x-api-path-slug"=>"apiv1gigmephonesave-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"phoneNumber", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Phone", "Save"]}}, "/api/v1/gigme/phone/send"=>{"post"=>{"summary"=>"Post Gigme Phone Send", "description"=>"Post gigme phone send.", "operationId"=>"postApiV1GigmePhoneSend", "x-api-path-slug"=>"apiv1gigmephonesend-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Phone", "Send"]}}, "/api/v1/gigme/phone/confirm"=>{"post"=>{"summary"=>"Post Gigme Phone Confirm", "description"=>"Post gigme phone confirm.", "operationId"=>"postApiV1GigmePhoneConfirm", "x-api-path-slug"=>"apiv1gigmephoneconfirm-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Phone", "Confirm"]}}, "/api/v1/gigme/place/{placeUnique}"=>{"get"=>{"summary"=>"Get Gigme Place Placeunique", "description"=>"Get gigme place placeunique.", "operationId"=>"getApiV1GigmePlacePlaceunique", "x-api-path-slug"=>"apiv1gigmeplaceplaceunique-get", "parameters"=>[{"in"=>"path", "name"=>"placeUnique"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Place", "Placeunique"]}}, "/api/v1/gigme/place/{placeId}/related"=>{"get"=>{"summary"=>"Get Gigme Place Placeid Related", "description"=>"Get gigme place placeid related.", "operationId"=>"getApiV1GigmePlacePlaceRelated", "x-api-path-slug"=>"apiv1gigmeplaceplaceidrelated-get", "parameters"=>[{"in"=>"path", "name"=>"placeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Place", "Placeid", "Related"]}}, "/api/v1/gigme/place/{placeId}/reviews/{page}/{pageSize}"=>{"get"=>{"summary"=>"Get Gigme Place Placeid Reviews Page Pagesize", "description"=>"Get gigme place placeid reviews page pagesize.", "operationId"=>"getApiV1GigmePlacePlaceReviewsPagePagesize", "x-api-path-slug"=>"apiv1gigmeplaceplaceidreviewspagepagesize-get", "parameters"=>[{"in"=>"path", "name"=>"page"}, {"in"=>"path", "name"=>"pageSize"}, {"in"=>"path", "name"=>"placeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Place", "Placeid", "Reviews", "Page", "Pagesize"]}}, "/api/v1/gigme/place/reviews/add"=>{"post"=>{"summary"=>"Post Gigme Place Reviews Add", "description"=>"Post gigme place reviews add.", "operationId"=>"postApiV1GigmePlaceReviewsAdd", "x-api-path-slug"=>"apiv1gigmeplacereviewsadd-post", "parameters"=>[{"in"=>"body", "name"=>"reviewRequest", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Gigme", "Place", "Reviews"]}}, "/api/v1/images/temp/save"=>{"post"=>{"summary"=>"Post Images Temp Save", "description"=>"Post images temp save.", "operationId"=>"postApiV1ImagesTempSave", "x-api-path-slug"=>"apiv1imagestempsave-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"url", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Temp", "Save"]}}, "/api/v1/images/temp/remove"=>{"post"=>{"summary"=>"Post Images Temp Remove", "description"=>"Post images temp remove.", "operationId"=>"postApiV1ImagesTempRemove", "x-api-path-slug"=>"apiv1imagestempremove-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"url", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Temp", "Remove"]}}, "/api/v1/manager/artists"=>{"get"=>{"summary"=>"Get Manager Artists", "description"=>"Get manager artists.", "operationId"=>"getApiV1ManagerArtists", "x-api-path-slug"=>"apiv1managerartists-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"page", "description"=>"The page number"}, {"in"=>"query", "name"=>"request.query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Manager", "Artists"]}}, "/api/v1/managers/settings"=>{"get"=>{"summary"=>"Get Managers Settings", "description"=>"Get managers settings.", "operationId"=>"getApiV1ManagersSettings", "x-api-path-slug"=>"apiv1managerssettings-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers", "Settings"]}}, "/api/v1/managers/search"=>{"get"=>{"summary"=>"Get Managers Search", "description"=>"Get managers search.", "operationId"=>"getApiV1ManagersSearch", "x-api-path-slug"=>"apiv1managerssearch-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"request.query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers", "Search"]}}, "/api/v1/managers/{managerId}/permissions"=>{"put"=>{"summary"=>"Put Managers Managerid Permissions", "description"=>"Put managers managerid permissions.", "operationId"=>"putApiV1ManagersManagerPermissions", "x-api-path-slug"=>"apiv1managersmanageridpermissions-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"managerId"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers", "Managerid", "Permissions"]}}, "/api/v1/managers/{managerId}"=>{"delete"=>{"summary"=>"Delete Managers Managerid", "description"=>"Delete managers managerid.", "operationId"=>"deleteApiV1ManagersManager", "x-api-path-slug"=>"apiv1managersmanagerid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"managerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers", "Managerid"]}}, "/api/v1/manager/artists/{artistId}"=>{"delete"=>{"summary"=>"Delete Manager Artists Artistid", "description"=>"Delete manager artists artistid.", "operationId"=>"deleteApiV1ManagerArtistsArtist", "x-api-path-slug"=>"apiv1managerartistsartistid-delete", "parameters"=>[{"in"=>"path", "name"=>"artistId"}, {"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Manager", "Artists", "Artistid"]}}, "/api/v1/managers/accept/{artistId}"=>{"post"=>{"summary"=>"Post Managers Accept Artistid", "description"=>"Post managers accept artistid.", "operationId"=>"postApiV1ManagersAcceptArtist", "x-api-path-slug"=>"apiv1managersacceptartistid-post", "parameters"=>[{"in"=>"path", "name"=>"artistId"}, {"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers", "Accept", "Artistid"]}}, "/api/v1/managers/approve/{artistId}"=>{"post"=>{"summary"=>"Post Managers Approve Artistid", "description"=>"Post managers approve artistid.", "operationId"=>"postApiV1ManagersApproveArtist", "x-api-path-slug"=>"apiv1managersapproveartistid-post", "parameters"=>[{"in"=>"path", "name"=>"artistId"}, {"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers", "Approve", "Artistid"]}}, "/api/v1/managers/combine/{oldid}/{newid}"=>{"post"=>{"summary"=>"Post Managers Combine Old New", "description"=>"Post managers combine old new.", "operationId"=>"postApiV1ManagersCombineOldNew", "x-api-path-slug"=>"apiv1managerscombineoldidnewid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"newid"}, {"in"=>"path", "name"=>"oldid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers", "Combine", "Old", "New"]}}, "/api/v1/managers/reject/{artistId}/{reason}"=>{"post"=>{"summary"=>"Post Managers Reject Artistid Reason", "description"=>"Post managers reject artistid reason.", "operationId"=>"postApiV1ManagersRejectArtistReason", "x-api-path-slug"=>"apiv1managersrejectartistidreason-post", "parameters"=>[{"in"=>"path", "name"=>"artistId"}, {"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"reason"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers", "Reject", "Artistid", "Reason"]}}, "/api/v1/Managers"=>{"get"=>{"summary"=>"Get Managers", "description"=>"Get managers.", "operationId"=>"getApiV1Managers", "x-api-path-slug"=>"apiv1managers-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers"]}, "put"=>{"summary"=>"Put Managers", "description"=>"Put managers.", "operationId"=>"putApiV1Managers", "x-api-path-slug"=>"apiv1managers-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers"]}, "post"=>{"summary"=>"Post Managers", "description"=>"Post managers.", "operationId"=>"postApiV1Managers", "x-api-path-slug"=>"apiv1managers-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"model", "description"=>",", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Managers"]}}, "/api/v1/message/new/{withUserId}/{lastMessageId}"=>{"get"=>{"summary"=>"Get Message New Withuserid Lastmessageid", "description"=>"Get message new withuserid lastmessageid.", "operationId"=>"getApiV1MessageNewWithuserLastmessage", "x-api-path-slug"=>"apiv1messagenewwithuseridlastmessageid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"lastMessageId"}, {"in"=>"path", "name"=>"withUserId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "New", "Withuserid", "Lastmessageid"]}}, "/api/v1/message/chats/{pageNumber}/{search}"=>{"get"=>{"summary"=>"Get Message Chats Pagenumber Search", "description"=>"Get message chats pagenumber search.", "operationId"=>"getApiV1MessageChatsPagenumberSearch", "x-api-path-slug"=>"apiv1messagechatspagenumbersearch-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"pageNumber"}, {"in"=>"path", "name"=>"search"}, {"in"=>"query", "name"=>"unread"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Chats", "Pagenumber", "Search"]}}, "/api/v1/message/send"=>{"post"=>{"summary"=>"Post Message Send", "description"=>"Post message send.", "operationId"=>"postApiV1MessageSend", "x-api-path-slug"=>"apiv1messagesend-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"message", "description"=>"ID", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Send"]}}, "/api/v1/message/chat/{id}/{from}"=>{"get"=>{"summary"=>"Get Message Chat From", "description"=>"Get message chat from.", "operationId"=>"getApiV1MessageChatFrom", "x-api-path-slug"=>"apiv1messagechatidfrom-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"from", "description"=>"20"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Chat", "From"]}}, "/api/v1/message/count/{userId}"=>{"get"=>{"summary"=>"Get Message Count Userid", "description"=>"Get message count userid.", "operationId"=>"getApiV1MessageCountUser", "x-api-path-slug"=>"apiv1messagecountuserid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Count", "Userid"]}}, "/api/v1/message/delete"=>{"post"=>{"summary"=>"Post Message Delete", "description"=>"Post message delete.", "operationId"=>"postApiV1MessageDelete", "x-api-path-slug"=>"apiv1messagedelete-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}}, "/api/v1/message/feedback"=>{"post"=>{"summary"=>"Post Message Feedback", "description"=>"Post message feedback.", "operationId"=>"postApiV1MessageFeedback", "x-api-path-slug"=>"apiv1messagefeedback-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Feedback"]}}, "/api/v1/notify/unpayed"=>{"get"=>{"summary"=>"Get Notify Unpayed", "description"=>"Get notify unpayed.", "operationId"=>"getApiV1NotifyUnpayed", "x-api-path-slug"=>"apiv1notifyunpayed-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notify", "Unpayed"]}}, "/api/v1/notify/artists"=>{"get"=>{"summary"=>"Get Notify Artists", "description"=>"Get notify artists.", "operationId"=>"getApiV1NotifyArtists", "x-api-path-slug"=>"apiv1notifyartists-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notify", "Artists"]}}, "/api/v1/notify/manager"=>{"get"=>{"summary"=>"Get Notify Manager", "description"=>"Get notify manager.", "operationId"=>"getApiV1NotifyManager", "x-api-path-slug"=>"apiv1notifymanager-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notify", "Manager"]}}, "/api/v1/notify/artists/new"=>{"get"=>{"summary"=>"Get Notify Artists New", "description"=>"Get notify artists new.", "operationId"=>"getApiV1NotifyArtistsNew", "x-api-path-slug"=>"apiv1notifyartistsnew-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notify", "Artists", "New"]}}, "/api/v1/notify/requests"=>{"get"=>{"summary"=>"Get Notify Requests", "description"=>"Get notify requests.", "operationId"=>"getApiV1NotifyRequests", "x-api-path-slug"=>"apiv1notifyrequests-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notify", "Requests"]}}, "/api/v1/notify/messages"=>{"get"=>{"summary"=>"Get Notify Messages", "description"=>"Get notify messages.", "operationId"=>"getApiV1NotifyMessages", "x-api-path-slug"=>"apiv1notifymessages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notify", "Messages"]}}, "/api/v1/notify/{userId}"=>{"get"=>{"summary"=>"Get Notify Userid", "description"=>"Get notify userid.", "operationId"=>"getApiV1NotifyUser", "x-api-path-slug"=>"apiv1notifyuserid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notify", "Userid"]}, "post"=>{"summary"=>"Post Notify Userid", "description"=>"Post notify userid.", "operationId"=>"postApiV1NotifyUser", "x-api-path-slug"=>"apiv1notifyuserid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"notificationIds", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notify", "Userid"]}}, "/api/v1/org/{userId}"=>{"get"=>{"summary"=>"Get Org Userid", "description"=>"Get org userid.", "operationId"=>"getApiV1OrgUser", "x-api-path-slug"=>"apiv1orguserid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Org", "Userid"]}, "post"=>{"summary"=>"Post Org Userid", "description"=>"Post org userid.", "operationId"=>"postApiV1OrgUser", "x-api-path-slug"=>"apiv1orguserid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Org", "Userid"]}}, "/api/v1/password/forgot"=>{"post"=>{"summary"=>"Post Password Forgot", "description"=>"Post password forgot.", "operationId"=>"postApiV1PasswordForgot", "x-api-path-slug"=>"apiv1passwordforgot-post", "parameters"=>[{"in"=>"body", "name"=>"request", "description"=>"Email", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Password", "Forgot"]}}, "/api/v1/password/restore"=>{"post"=>{"summary"=>"Post Password Restore", "description"=>"Post password restore.", "operationId"=>"postApiV1PasswordRestore", "x-api-path-slug"=>"apiv1passwordrestore-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Password", "Restore"]}}, "/api/v1/password/change"=>{"post"=>{"summary"=>"Post Password Change", "description"=>"Post password change.", "operationId"=>"postApiV1PasswordChange", "x-api-path-slug"=>"apiv1passwordchange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Password", "Change"]}}, "/api/v1/payment/add"=>{"post"=>{"summary"=>"Post Payment Add", "description"=>"Post payment add.", "operationId"=>"postApiV1PaymentAdd", "x-api-path-slug"=>"apiv1paymentadd-post", "parameters"=>[{"in"=>"body", "name"=>"payRequest", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment"]}}, "/api/v1/payment/promocode/price"=>{"post"=>{"summary"=>"Post Payment Promocode Price", "description"=>"Post payment promocode price.", "operationId"=>"postApiV1PaymentPromocodePrice", "x-api-path-slug"=>"apiv1paymentpromocodeprice-post", "parameters"=>[{"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment", "Promocode", "Price"]}}, "/api/v1/payment/promocode/{requestId}"=>{"post"=>{"summary"=>"Post Payment Promocode Requestid", "description"=>"Post payment promocode requestid.", "operationId"=>"postApiV1PaymentPromocodeRequest", "x-api-path-slug"=>"apiv1paymentpromocoderequestid-post", "parameters"=>[{"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"requestId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment", "Promocode", "Requestid"]}}, "/api/v1/performanceformats"=>{"get"=>{"summary"=>"Get Performanceformats", "description"=>"Get performanceformats.", "operationId"=>"getApiV1Performanceformats", "x-api-path-slug"=>"apiv1performanceformats-get", "parameters"=>[{"in"=>"query", "name"=>"startWith"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Performanceformats"]}}, "/api/v1/phone/send"=>{"post"=>{"summary"=>"Post Phone Send", "description"=>"Post phone send.", "operationId"=>"postApiV1PhoneSend", "x-api-path-slug"=>"apiv1phonesend-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Phone", "Send"]}}, "/api/v1/phone/confirm"=>{"post"=>{"summary"=>"Post Phone Confirm", "description"=>"Post phone confirm.", "operationId"=>"postApiV1PhoneConfirm", "x-api-path-slug"=>"apiv1phoneconfirm-post", "parameters"=>[{"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Phone", "Confirm"]}}, "/api/v1/phone/save"=>{"put"=>{"summary"=>"Put Phone Save", "description"=>"Put phone save.", "operationId"=>"putApiV1PhoneSave", "x-api-path-slug"=>"apiv1phonesave-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"phoneNumber", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Phone", "Save"]}}, "/api/v1/phone/check/{smsId}"=>{"get"=>{"summary"=>"Get Phone Check Smsid", "description"=>"Get phone check smsid.", "operationId"=>"getApiV1PhoneCheckSms", "x-api-path-slug"=>"apiv1phonechecksmsid-get", "parameters"=>[{"in"=>"path", "name"=>"smsId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Phone", "Check", "Smsid"]}}, "/api/v1/place/{placeId}"=>{"get"=>{"summary"=>"Get Place Placeid", "description"=>"Get place placeid.", "operationId"=>"getApiV1PlacePlace", "x-api-path-slug"=>"apiv1placeplaceid-get", "parameters"=>[{"in"=>"path", "name"=>"placeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "Placeid"]}}, "/api/v1/place/{placeUnique}"=>{"get"=>{"summary"=>"Get Place Placeunique", "description"=>"Get place placeunique.", "operationId"=>"getApiV1PlacePlaceunique", "x-api-path-slug"=>"apiv1placeplaceunique-get", "parameters"=>[{"in"=>"path", "name"=>"placeUnique"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "Placeunique"]}}, "/api/v1/place/{placeId}/related"=>{"get"=>{"summary"=>"Get Place Placeid Related", "description"=>"Get place placeid related.", "operationId"=>"getApiV1PlacePlaceRelated", "x-api-path-slug"=>"apiv1placeplaceidrelated-get", "parameters"=>[{"in"=>"path", "name"=>"placeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "Placeid", "Related"]}}, "/api/v1/place/search"=>{"get"=>{"summary"=>"Get Place Search", "description"=>"Get place search.", "operationId"=>"getApiV1PlaceSearch", "x-api-path-slug"=>"apiv1placesearch-get", "parameters"=>[{"in"=>"query", "name"=>"request.cities"}, {"in"=>"query", "name"=>"request.query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "Search"]}}, "/api/v1/place/{cityId}/search/{query}"=>{"get"=>{"summary"=>"Get Place Cityid Search Query", "description"=>"Get place cityid search query.", "operationId"=>"getApiV1PlaceCitySearchQuery", "x-api-path-slug"=>"apiv1placecityidsearchquery-get", "parameters"=>[{"in"=>"path", "name"=>"cityId"}, {"in"=>"path", "name"=>"query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "Cityid", "Search", "Query"]}}, "/api/v1/place"=>{"post"=>{"summary"=>"Post Place", "description"=>"Post place.", "operationId"=>"postApiV1Place", "x-api-path-slug"=>"apiv1place-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place"]}}, "/api/v1/place/scheme/{placeId}"=>{"post"=>{"summary"=>"Post Place Scheme Placeid", "description"=>"Post place scheme placeid.", "operationId"=>"postApiV1PlaceSchemePlace", "x-api-path-slug"=>"apiv1placeschemeplaceid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "Scheme", "Placeid"]}}, "/api/v1/place/empty"=>{"post"=>{"summary"=>"Post Place Empty", "description"=>"Post place empty.", "operationId"=>"postApiV1PlaceEmpty", "x-api-path-slug"=>"apiv1placeempty-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "Empty"]}}, "/api/v1/place/{placeId}/reviews/{page}/{pageSize}"=>{"get"=>{"summary"=>"Get Place Placeid Reviews Page Pagesize", "description"=>"Get place placeid reviews page pagesize.", "operationId"=>"getApiV1PlacePlaceReviewsPagePagesize", "x-api-path-slug"=>"apiv1placeplaceidreviewspagepagesize-get", "parameters"=>[{"in"=>"path", "name"=>"page"}, {"in"=>"path", "name"=>"pageSize"}, {"in"=>"path", "name"=>"placeId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "Placeid", "Reviews", "Page", "Pagesize"]}}, "/api/v1/place/reviews/add"=>{"post"=>{"summary"=>"Post Place Reviews Add", "description"=>"Post place reviews add.", "operationId"=>"postApiV1PlaceReviewsAdd", "x-api-path-slug"=>"apiv1placereviewsadd-post", "parameters"=>[{"in"=>"body", "name"=>"reviewRequest", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "Reviews"]}}, "/api/v1/rating/artists"=>{"post"=>{"summary"=>"Post Rating Artists", "description"=>"Post rating artists.", "operationId"=>"postApiV1RatingArtists", "x-api-path-slug"=>"apiv1ratingartists-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rating", "Artists"]}}, "/api/v1/rating/{eventId}/artists"=>{"get"=>{"summary"=>"Get Rating Eventid Artists", "description"=>"Get rating eventid artists.", "operationId"=>"getApiV1RatingEventArtists", "x-api-path-slug"=>"apiv1ratingeventidartists-get", "parameters"=>[{"in"=>"path", "name"=>"eventId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rating", "Eventid", "Artists"]}}, "/api/v1/Rating"=>{"post"=>{"summary"=>"Post Rating", "description"=>"Post rating.", "operationId"=>"postApiV1Rating", "x-api-path-slug"=>"apiv1rating-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rating"]}}, "/api/v1/request/org/invite"=>{"post"=>{"summary"=>"Post Request Org Invite", "description"=>"Post request org invite.", "operationId"=>"postApiV1RequestOrgInvite", "x-api-path-slug"=>"apiv1requestorginvite-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Org", "Invite"]}}, "/api/v1/request/org/out"=>{"get"=>{"summary"=>"Get Request Org Out", "description"=>"Get request org out.", "operationId"=>"getApiV1RequestOrgOut", "x-api-path-slug"=>"apiv1requestorgout-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Org", "Out"]}}, "/api/v1/request/org/archive"=>{"get"=>{"summary"=>"Get Request Org Archive", "description"=>"Get request org archive.", "operationId"=>"getApiV1RequestOrgArchive", "x-api-path-slug"=>"apiv1requestorgarchive-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Org", "Archive"]}}, "/api/v1/request/org/reject"=>{"post"=>{"summary"=>"Post Request Org Reject", "description"=>"Post request org reject.", "operationId"=>"postApiV1RequestOrgReject", "x-api-path-slug"=>"apiv1requestorgreject-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Org", "Reject"]}}, "/api/v1/request/org/accept"=>{"post"=>{"summary"=>"Post Request Org Accept", "description"=>"Post request org accept.", "operationId"=>"postApiV1RequestOrgAccept", "x-api-path-slug"=>"apiv1requestorgaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Org", "Accept"]}}, "/api/v1/request/price"=>{"post"=>{"summary"=>"Post Request Price", "description"=>"Post request price.", "operationId"=>"postApiV1RequestPrice", "x-api-path-slug"=>"apiv1requestprice-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Price"]}}, "/api/v1/request/performanceDate"=>{"post"=>{"summary"=>"Post Request Performancedate", "description"=>"Post request performancedate.", "operationId"=>"postApiV1RequestPerformancedate", "x-api-path-slug"=>"apiv1requestperformancedate-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Performancedate"]}}, "/api/v1/request/art/invite"=>{"post"=>{"summary"=>"Post Request Art Invite", "description"=>"Post request art invite.", "operationId"=>"postApiV1RequestArtInvite", "x-api-path-slug"=>"apiv1requestartinvite-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Art", "Invite"]}}, "/api/v1/request/key/{key}"=>{"get"=>{"summary"=>"Get Request Key Key", "description"=>"Get request key key.", "operationId"=>"getApiV1RequestKeyKey", "x-api-path-slug"=>"apiv1requestkeykey-get", "parameters"=>[{"in"=>"path", "name"=>"key", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Key", "Key"]}}, "/api/v1/request/art/in"=>{"get"=>{"summary"=>"Get Request Art In", "description"=>"Get request art in.", "operationId"=>"getApiV1RequestArtIn", "x-api-path-slug"=>"apiv1requestartin-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Art", "In"]}}, "/api/v1/request/art/calendar"=>{"get"=>{"summary"=>"Get Request Art Calendar", "description"=>"Get request art calendar.", "operationId"=>"getApiV1RequestArtCalendar", "x-api-path-slug"=>"apiv1requestartcalendar-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"request.from"}, {"in"=>"query", "name"=>"request.to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Art", "Calendar"]}}, "/api/v1/request/art/archive"=>{"get"=>{"summary"=>"Get Request Art Archive", "description"=>"Get request art archive.", "operationId"=>"getApiV1RequestArtArchive", "x-api-path-slug"=>"apiv1requestartarchive-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Art", "Archive"]}}, "/api/v1/request/art/reject"=>{"post"=>{"summary"=>"Post Request Art Reject", "description"=>"Post request art reject.", "operationId"=>"postApiV1RequestArtReject", "x-api-path-slug"=>"apiv1requestartreject-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Art", "Reject"]}}, "/api/v1/request/art/accept"=>{"post"=>{"summary"=>"Post Request Art Accept", "description"=>"Post request art accept.", "operationId"=>"postApiV1RequestArtAccept", "x-api-path-slug"=>"apiv1requestartaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Art", "Accept"]}}, "/api/v1/request/art/accept/performanceDate"=>{"post"=>{"summary"=>"Post Request Art Accept Performancedate", "description"=>"Post request art accept performancedate.", "operationId"=>"postApiV1RequestArtAcceptPerformancedate", "x-api-path-slug"=>"apiv1requestartacceptperformancedate-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "description"=>"/", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Art", "Accept", "Performancedate"]}}, "/api/v1/request/art/reject/performanceDate"=>{"post"=>{"summary"=>"Post Request Art Reject Performancedate", "description"=>"Post request art reject performancedate.", "operationId"=>"postApiV1RequestArtRejectPerformancedate", "x-api-path-slug"=>"apiv1requestartrejectperformancedate-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "description"=>"/", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Art", "Reject", "Performancedate"]}}, "/api/v1/request/{requestId}"=>{"get"=>{"summary"=>"Get Request Requestid", "description"=>"Get request requestid.", "operationId"=>"getApiV1RequestRequest", "x-api-path-slug"=>"apiv1requestrequestid-get", "parameters"=>[{"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid"]}}, "/api/v1/request/{requestId}/history"=>{"get"=>{"summary"=>"Get Request Requestid History", "description"=>"Get request requestid history.", "operationId"=>"getApiV1RequestRequestHistory", "x-api-path-slug"=>"apiv1requestrequestidhistory-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "History"]}}, "/api/v1/request/{requestId}/comments"=>{"get"=>{"summary"=>"Get Request Requestid Comments", "description"=>"Get request requestid comments.", "operationId"=>"getApiV1RequestRequestComments", "x-api-path-slug"=>"apiv1requestrequestidcomments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Comments"]}, "post"=>{"summary"=>"Post Request Requestid Comments", "description"=>"Post request requestid comments.", "operationId"=>"postApiV1RequestRequestComments", "x-api-path-slug"=>"apiv1requestrequestidcomments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Comments"]}}, "/api/v1/request/{requestId}/files"=>{"get"=>{"summary"=>"Get Request Requestid Files", "description"=>"Get request requestid files.", "operationId"=>"getApiV1RequestRequestFiles", "x-api-path-slug"=>"apiv1requestrequestidfiles-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Files"]}, "post"=>{"summary"=>"Post Request Requestid Files", "description"=>"Post request requestid files.", "operationId"=>"postApiV1RequestRequestFiles", "x-api-path-slug"=>"apiv1requestrequestidfiles-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Files"]}}, "/api/v1/request/{requestId}/files/{fileId}"=>{"get"=>{"summary"=>"Get Request Requestid Files Fileid", "description"=>"Get request requestid files fileid.", "operationId"=>"getApiV1RequestRequestFilesFile", "x-api-path-slug"=>"apiv1requestrequestidfilesfileid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"fileId"}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Files", "Fileid"]}, "delete"=>{"summary"=>"Delete Request Requestid Files Fileid", "description"=>"Delete request requestid files fileid.", "operationId"=>"deleteApiV1RequestRequestFilesFile", "x-api-path-slug"=>"apiv1requestrequestidfilesfileid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"fileId"}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Files", "Fileid"]}}, "/api/v1/request/{requestId}/condition/visa"=>{"get"=>{"summary"=>"Get Request Requestid Condition Visa", "description"=>"Get request requestid condition visa.", "operationId"=>"getApiV1RequestRequestConditionVisa", "x-api-path-slug"=>"apiv1requestrequestidconditionvisa-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Condition", "Visa"]}, "post"=>{"summary"=>"Post Request Requestid Condition Visa", "description"=>"Post request requestid condition visa.", "operationId"=>"postApiV1RequestRequestConditionVisa", "x-api-path-slug"=>"apiv1requestrequestidconditionvisa-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Condition", "Visa"]}}, "/api/v1/request/{requestId}/condition/travel"=>{"get"=>{"summary"=>"Get Request Requestid Condition Travel", "description"=>"Get request requestid condition travel.", "operationId"=>"getApiV1RequestRequestConditionTravel", "x-api-path-slug"=>"apiv1requestrequestidconditiontravel-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Condition", "Travel"]}, "post"=>{"summary"=>"Post Request Requestid Condition Travel", "description"=>"Post request requestid condition travel.", "operationId"=>"postApiV1RequestRequestConditionTravel", "x-api-path-slug"=>"apiv1requestrequestidconditiontravel-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Condition", "Travel"]}}, "/api/v1/request/{requestId}/condition/residence"=>{"get"=>{"summary"=>"Get Request Requestid Condition Resence", "description"=>"Get request requestid condition resence.", "operationId"=>"getApiV1RequestRequestConditionResence", "x-api-path-slug"=>"apiv1requestrequestidconditionresidence-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Condition", "Resence"]}, "post"=>{"summary"=>"Post Request Requestid Condition Resence", "description"=>"Post request requestid condition resence.", "operationId"=>"postApiV1RequestRequestConditionResence", "x-api-path-slug"=>"apiv1requestrequestidconditionresidence-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Condition", "Resence"]}}, "/api/v1/request/{requestId}/condition/delivery"=>{"get"=>{"summary"=>"Get Request Requestid Condition Delivery", "description"=>"Get request requestid condition delivery.", "operationId"=>"getApiV1RequestRequestConditionDelivery", "x-api-path-slug"=>"apiv1requestrequestidconditiondelivery-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Condition", "Delivery"]}, "post"=>{"summary"=>"Post Request Requestid Condition Delivery", "description"=>"Post request requestid condition delivery.", "operationId"=>"postApiV1RequestRequestConditionDelivery", "x-api-path-slug"=>"apiv1requestrequestidconditiondelivery-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"model", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Condition", "Delivery"]}}, "/api/v1/request/{requestId}/condition/{condition}/confirm"=>{"post"=>{"summary"=>"Post Request Requestid Condition Condition Confirm", "description"=>"Post request requestid condition condition confirm.", "operationId"=>"postApiV1RequestRequestConditionConditionConfirm", "x-api-path-slug"=>"apiv1requestrequestidconditionconditionconfirm-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"condition"}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Condition", "Condition", "Confirm"]}}, "/api/v1/request/{requestId}/condition/{condition}/reject"=>{"post"=>{"summary"=>"Post Request Requestid Condition Condition Reject", "description"=>"Post request requestid condition condition reject.", "operationId"=>"postApiV1RequestRequestConditionConditionReject", "x-api-path-slug"=>"apiv1requestrequestidconditionconditionreject-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"condition"}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Condition", "Condition", "Reject"]}}, "/api/v1/request/{requestId}/condition/{condition}/documents"=>{"get"=>{"summary"=>"Get Request Requestid Condition Condition Documents", "description"=>"Get request requestid condition condition documents.", "operationId"=>"getApiV1RequestRequestConditionConditionDocuments", "x-api-path-slug"=>"apiv1requestrequestidconditionconditiondocuments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"condition"}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Condition", "Condition", "Documents"]}, "post"=>{"summary"=>"Post Request Requestid Condition Condition Documents", "description"=>"Post request requestid condition condition documents.", "operationId"=>"postApiV1RequestRequestConditionConditionDocuments", "x-api-path-slug"=>"apiv1requestrequestidconditionconditiondocuments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Condition", "Condition", "Documents"]}}, "/api/v1/request/requests/{requestId}/logs"=>{"get"=>{"summary"=>"Get Request Requests Requestid Logs", "description"=>"Get request requests requestid logs.", "operationId"=>"getApiV1RequestRequestsRequestLogs", "x-api-path-slug"=>"apiv1requestrequestsrequestidlogs-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"requestId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requests", "Requestid", "Logs"]}}, "/api/v1/request/{requestId}/art/{artistId}/rider"=>{"get"=>{"summary"=>"Get Request Requestid Art Artistid Rer", "description"=>"Get request requestid art artistid rer.", "operationId"=>"getApiV1RequestRequestArtArtistRer", "x-api-path-slug"=>"apiv1requestrequestidartartistidrider-get", "parameters"=>[{"in"=>"path", "name"=>"artistId"}, {"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Art", "Artistid", "Rer"]}}, "/api/v1/request/{requestId}/art/{artistId}/rider/home"=>{"get"=>{"summary"=>"Get Request Requestid Art Artistid Rer Home", "description"=>"Get request requestid art artistid rer home.", "operationId"=>"getApiV1RequestRequestArtArtistRerHome", "x-api-path-slug"=>"apiv1requestrequestidartartistidriderhome-get", "parameters"=>[{"in"=>"path", "name"=>"artistId"}, {"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"requestId", "description"=>"/"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Art", "Artistid", "Rer", "Home"]}}, "/api/v1/request/{requestId}/art/{artistId}/presskit/{photoId}"=>{"get"=>{"summary"=>"Get Request Requestid Art Artistid Presskit Photoid", "description"=>"Get request requestid art artistid presskit photoid.", "operationId"=>"getApiV1RequestRequestArtArtistPresskitPhoto", "x-api-path-slug"=>"apiv1requestrequestidartartistidpresskitphotoid-get", "parameters"=>[{"in"=>"path", "name"=>"artistId"}, {"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"photoId"}, {"in"=>"path", "name"=>"requestId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Requestid", "Art", "Artistid", "Presskit", "Photoid"]}}, "/api/v1/ticket/{ticketId}"=>{"get"=>{"summary"=>"Get Ticket Ticketid", "description"=>"Get ticket ticketid.", "operationId"=>"getApiV1TicketTicket", "x-api-path-slug"=>"apiv1ticketticketid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"ticketId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket", "Ticketid"]}}, "/api/v1/ticket/{eventId}/{ticketId}"=>{"delete"=>{"summary"=>"Delete Ticket Eventid Ticketid", "description"=>"Delete ticket eventid ticketid.", "operationId"=>"deleteApiV1TicketEventTicket", "x-api-path-slug"=>"apiv1ticketeventidticketid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"eventId"}, {"in"=>"path", "name"=>"ticketId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket", "Eventid", "Ticketid"]}}, "/api/v1/ticket/{eventId}"=>{"get"=>{"summary"=>"Get Ticket Eventid", "description"=>"Get ticket eventid.", "operationId"=>"getApiV1TicketEvent", "x-api-path-slug"=>"apiv1ticketeventid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"eventId"}, {"in"=>"query", "name"=>"from"}, {"in"=>"query", "name"=>"to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket", "Eventid"]}}, "/api/v1/ticket/{eventId}/export"=>{"get"=>{"summary"=>"Get Ticket Eventid Export", "description"=>"Get ticket eventid export.", "operationId"=>"getApiV1TicketEventExport", "x-api-path-slug"=>"apiv1ticketeventidexport-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"path", "name"=>"eventId"}, {"in"=>"query", "name"=>"from"}, {"in"=>"query", "name"=>"to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket", "Eventid", "Export"]}}, "/api/v1/Ticket"=>{"get"=>{"summary"=>"Get Ticket", "description"=>"Get ticket.", "operationId"=>"getApiV1Ticket", "x-api-path-slug"=>"apiv1ticket-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"query", "name"=>"from"}, {"in"=>"query", "name"=>"to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket"]}, "post"=>{"summary"=>"Post Ticket", "description"=>"Post ticket.", "operationId"=>"postApiV1Ticket", "x-api-path-slug"=>"apiv1ticket-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization"}, {"in"=>"body", "name"=>"request", "description"=>",", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ticket"]}}}}, "apis"=>{"name"=>"GIG & CROWD", "x-slug"=>"gig-crowd", "description"=>"A unique system of the order and booking of artists: negotiations, coordination of conditions, convenient reminders of fee payment terms and rider preparation.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/gigandcrowd.png", "x-kinRank"=>"7", "x-alexaRank"=>"", "tags"=>"Concerts,Entertainment,Events,Relative Data", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"gig-crowd/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"GIGANDCROWD", "x-api-slug"=>"gigandcrowd", "description"=>"A unique system of the order and booking of artists: negotiations, coordination of conditions, convenient reminders of fee payment terms and rider preparation.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/gigandcrowd.png", "humanURL"=>"https://gigandcrowd.com", "baseURL"=>"https://gigandcrowd.com//", "tags"=>"Concerts,Entertainment,Events,Relative Data", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/gig-crowd/gigandcrowd-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-openapi", "url"=>"https://gigandcrowd.com/swagger/docs/v1"}, {"type"=>"x-documentation", "url"=>"https://gigandcrowd.com/swagger/ui/index"}, {"type"=>"x-website", "url"=>"https://gigandcrowd.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
logicbroker{"logic-broker-commerceapi-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Logicbroker", "x-complete"=>1, "info"=>{"title"=>"CommerceAPI", "version"=>"1.0.0"}, "host"=>"stage.commerceapi.io", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/v1/Acknowledgements/{LogicbrokerKey}"=>{"get"=>{"summary"=>"Get acknowledgement details", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Acknowledgement_GetAck", "x-api-path-slug"=>"apiv1acknowledgementslogicbrokerkey-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Acknowledgement", "Details"]}}, "/api/v1/Acknowledgements/CustomXML"=>{"post"=>{"summary"=>"Create acknowledgement(s) based on custom XML.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Acknowledgement_UploadCustomXml", "x-api-path-slug"=>"apiv1acknowledgementscustomxml-post", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"XML data to upload", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"formData", "name"=>"file", "description"=>"File to upload"}, {"in"=>"query", "name"=>"xmlType", "description"=>"XML type, leave blank unless directed otherwise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Acknowledgement(s)", "Based", "On", "Custom", "XML"]}}, "/api/v1/Acknowledgements/Request"=>{"post"=>{"summary"=>"Request an acknowledgement from a trading partner", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Acknowledgement_RequestAck", "x-api-path-slug"=>"apiv1acknowledgementsrequest-post", "parameters"=>[{"in"=>"body", "name"=>"Acknowledgement", "description"=>"Acknowledgement request object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Acknowledgement", "From", "Trading", "Partner"]}}, "/api/v1/Acknowledgements"=>{"get"=>{"summary"=>"Search acknowledgements", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Acknowledgement_SearchAcks", "x-api-path-slug"=>"apiv1acknowledgements-get", "parameters"=>[{"in"=>"query", "name"=>"filters.advanced", "description"=>"Advanced query options"}, {"in"=>"query", "name"=>"filters.from", "description"=>"Beginning of time search window"}, {"in"=>"query", "name"=>"filters.linkkey", "description"=>"The linkkey identifies a group of related documents"}, {"in"=>"query", "name"=>"filters.page", "description"=>"Page number"}, {"in"=>"query", "name"=>"filters.pageSize", "description"=>"Page size"}, {"in"=>"query", "name"=>"filters.partnerPO", "description"=>"The partners purchase order number"}, {"in"=>"query", "name"=>"filters.receiverCompanyId", "description"=>"This Id is indicate who is received this document"}, {"in"=>"query", "name"=>"filters.senderCompanyId", "description"=>"This Id is indicate who is sent this document"}, {"in"=>"query", "name"=>"filters.sourceKey", "description"=>"Source key is usually the unique key the sender uses to find this document"}, {"in"=>"query", "name"=>"filters.status", "description"=>"The status of the document"}, {"in"=>"query", "name"=>"filters.to", "description"=>"End of time search window"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Acknowledgements"]}, "post"=>{"summary"=>"Create an acknowledgement", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Acknowledgement_CreateAck", "x-api-path-slug"=>"apiv1acknowledgements-post", "parameters"=>[{"in"=>"body", "name"=>"Acknowledgement", "description"=>"Acknowledgement object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Acknowledgement"]}}, "/api/v1/Acknowledgements/{LogicbrokerKey}/Status/{Status}"=>{"put"=>{"summary"=>"Update acknowledgement status", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Acknowledgement_UpdateAckStatus", "x-api-path-slug"=>"apiv1acknowledgementslogicbrokerkeystatusstatus-put", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker Key"}, {"in"=>"path", "name"=>"Status", "description"=>"The Status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Acknowledgement", "Status"]}}, "/api/v1/Acknowledgements/{LogicbrokerKey}/Status"=>{"get"=>{"summary"=>"Retrieve acknowledgement status", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Acknowledgement_GetAckStatus", "x-api-path-slug"=>"apiv1acknowledgementslogicbrokerkeystatus-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Acknowledgement", "Status"]}}, "/api/v1/Acknowledgements/Export"=>{"get"=>{"summary"=>"Export to CSV/XLSX", "description"=>"The 'fields' parameter accepts a comma delimited list of JSON paths, for example: 'Identifier.LogicbrokerKey, BillToAddress.FirstName'. It is also possible to rename these fields using syntax like 'DocumentDate as Date' or 'DocumentDate Date'.\r\n You must specify a value for either the 'LogicbrokerKeys' parameter or the 'filter' parameter.", "operationId"=>"Acknowledgement_GetDocumentExportToken", "x-api-path-slug"=>"apiv1acknowledgementsexport-get", "parameters"=>[{"in"=>"query", "name"=>"delimiter", "description"=>"The column delimiter to use for CSV export"}, {"in"=>"query", "name"=>"fields", "description"=>"The fields to export"}, {"in"=>"query", "name"=>"fileType", "description"=>"Valid options are csv, xlsx, xml, json and legacy"}, {"in"=>"query", "name"=>"filter.advanced", "description"=>"Advanced query options"}, {"in"=>"query", "name"=>"filter.from", "description"=>"Beginning of time search window"}, {"in"=>"query", "name"=>"filter.linkkey", "description"=>"The linkkey identifies a group of related documents"}, {"in"=>"query", "name"=>"filter.page", "description"=>"Page number"}, {"in"=>"query", "name"=>"filter.pageSize", "description"=>"Page size"}, {"in"=>"query", "name"=>"filter.partnerPO", "description"=>"The partners purchase order number"}, {"in"=>"query", "name"=>"filter.receiverCompanyId", "description"=>"This Id is indicate who is received this document"}, {"in"=>"query", "name"=>"filter.senderCompanyId", "description"=>"This Id is indicate who is sent this document"}, {"in"=>"query", "name"=>"filter.sourceKey", "description"=>"Source key is usually the unique key the sender uses to find this document"}, {"in"=>"query", "name"=>"filter.status", "description"=>"The status of the document"}, {"in"=>"query", "name"=>"filter.to", "description"=>"End of time search window"}, {"in"=>"query", "name"=>"LogicbrokerKeys", "description"=>"The logicbroker keys"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Export", "To", "CSV", "XLSX"]}}, "/api/v1/Acknowledgements/{LogicbrokerKey}/EDI"=>{"get"=>{"summary"=>"Retrieve EDI", "description"=>"Returns the latest EDI related to this document that was either sent or received by Logicbroker. The EDI output may also contain other documents that were in the same batch.", "operationId"=>"Acknowledgement_GetDocumentEDI", "x-api-path-slug"=>"apiv1acknowledgementslogicbrokerkeyedi-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "EDI"]}}, "/api/v1/Acknowledgements/Import"=>{"post"=>{"summary"=>"Import from flat file.", "description"=>"Request rate limited to 1 request per second with bursts up to 10 requests.", "operationId"=>"Acknowledgement_Import", "x-api-path-slug"=>"apiv1acknowledgementsimport-post", "parameters"=>[{"in"=>"query", "name"=>"aliases", "description"=>"List of field names and aliases"}, {"in"=>"query", "name"=>"custom", "description"=>"False for standard format, true if using custom mapping configured by Logicbroker"}, {"in"=>"query", "name"=>"delimiter", "description"=>"Delimiter (CSV only)"}, {"in"=>"query", "name"=>"dryRun", "description"=>"Return shipment list instead of saving"}, {"in"=>"formData", "name"=>"file", "description"=>"File to import"}, {"in"=>"query", "name"=>"fileType", "description"=>"CSV or XLSX"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import", "From", "Flat", "File"]}}, "/api/v1/ActivityEvents"=>{"get"=>{"summary"=>"Get events for given fitlers", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"ActivityEvent_SearchActivityEvent", "x-api-path-slug"=>"apiv1activityevents-get", "parameters"=>[{"in"=>"query", "name"=>"Filters.category", "description"=>"Gets or sets the invoice number"}, {"in"=>"query", "name"=>"Filters.documentType", "description"=>"Gets or sets the shipment number"}, {"in"=>"query", "name"=>"Filters.from", "description"=>"Gets or sets the start date"}, {"in"=>"query", "name"=>"Filters.level", "description"=>"Gets or sets the status"}, {"in"=>"query", "name"=>"Filters.linkKey", "description"=>"Gets or sets the order number"}, {"in"=>"query", "name"=>"Filters.logicbrokerKey", "description"=>"Gets or sets the order number"}, {"in"=>"query", "name"=>"Filters.page", "description"=>"Gets or sets the page"}, {"in"=>"query", "name"=>"Filters.processed", "description"=>"Gets or sets the company id"}, {"in"=>"query", "name"=>"Filters.receiverId", "description"=>"Gets or sets the company id"}, {"in"=>"query", "name"=>"Filters.senderId", "description"=>"Gets or sets the partner company id"}, {"in"=>"query", "name"=>"Filters.to", "description"=>"Gets or sets the end date"}, {"in"=>"query", "name"=>"Filters.typeId", "description"=>"Gets or sets the event type id"}, {"in"=>"query", "name"=>"Filters.viewed", "description"=>"Gets or sets the company id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Eventsgiven", "Fitlers"]}, "post"=>{"summary"=>"Create an activity event.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"ActivityEvent_CreateEvent", "x-api-path-slug"=>"apiv1activityevents-post", "parameters"=>[{"in"=>"body", "name"=>"ActivityEvent", "description"=>"The Activity Event", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity", "Event"]}}, "/api/v1/ActivityEvents/{EventId}"=>{"get"=>{"summary"=>"Gets the event with the specified id.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"ActivityEvent_GetActivityEvent", "x-api-path-slug"=>"apiv1activityeventseventid-get", "parameters"=>[{"in"=>"path", "name"=>"EventId", "description"=>"The id to search for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Event", "Specified", "Id"]}, "put"=>{"summary"=>"Update activity event", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"ActivityEvent_UpdateActivityEvent", "x-api-path-slug"=>"apiv1activityeventseventid-put", "parameters"=>[{"in"=>"body", "name"=>"activityEvent", "description"=>"The updated activityEvent", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"EventId", "description"=>"The Event Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity", "Event"]}}, "/api/v1/ActivityEvents/EventTypes"=>{"get"=>{"summary"=>"Gets a list of all possible event types.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"ActivityEvent_GetEventTypes", "x-api-path-slug"=>"apiv1activityeventseventtypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "List", "Of", "", "Possible", "Event", "Types"]}}, "/api/v1/Attachments"=>{"get"=>{"summary"=>"Get a list of all attachments matching a given filter.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Attachment_GetList", "x-api-path-slug"=>"apiv1attachments-get", "parameters"=>[{"in"=>"query", "name"=>"acknowledged", "description"=>"Acknowledged flag"}, {"in"=>"query", "name"=>"logicbrokerKey", "description"=>"Logicbroker key"}, {"in"=>"query", "name"=>"page", "description"=>"Page number"}, {"in"=>"query", "name"=>"receiverId", "description"=>"Receiver account number"}, {"in"=>"query", "name"=>"type", "description"=>"Attachment type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "", "Attachments", "Matching", "Given", "Filter"]}, "post"=>{"summary"=>"Upload an attachment", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Attachment_Upload", "x-api-path-slug"=>"apiv1attachments-post", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"XML/JSON data to attach (webhooks)", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"description", "description"=>"Attachment description"}, {"in"=>"formData", "name"=>"file", "description"=>"File to attach"}, {"in"=>"query", "name"=>"logicbrokerKey", "description"=>"Logicbroker key to attach"}, {"in"=>"query", "name"=>"notify", "description"=>"If true, create an activty event"}, {"in"=>"query", "name"=>"receiverId", "description"=>"Receiver account number"}, {"in"=>"query", "name"=>"type", "description"=>"Attachment type (json, xml, csv, txt, pdf, png)"}, {"in"=>"query", "name"=>"url", "description"=>"URL of file to attach"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Attachment"]}}, "/api/v1/Attachments/{container}/{name}"=>{"get"=>{"summary"=>"Retrieve a file from Logicbroker storage.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Attachment_DownloadWithCoId", "x-api-path-slug"=>"apiv1attachmentscontainername-get", "parameters"=>[{"in"=>"path", "name"=>"container", "description"=>"File container (ex"}, {"in"=>"path", "name"=>"name", "description"=>"File name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "File", "From", "Logicbroker", "Storage"]}}, "/api/v1/Document/Script/{ScriptName}"=>{"get"=>{"summary"=>"Execute custom handler.", "description"=>"Request rate limited to 2 requests per second with bursts up to 25 requests.", "operationId"=>"Document_GetCustomScript", "x-api-path-slug"=>"apiv1documentscriptscriptname-get", "parameters"=>[{"in"=>"path", "name"=>"ScriptName", "description"=>"The custom script name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execute", "Custom", "Handler"]}, "post"=>{"summary"=>"Execute custom handler.", "description"=>"Request rate limited to 2 requests per second with bursts up to 25 requests.", "operationId"=>"Document_PostCustomScript", "x-api-path-slug"=>"apiv1documentscriptscriptname-post", "parameters"=>[{"in"=>"path", "name"=>"ScriptName", "description"=>"The custom script name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execute", "Custom", "Handler"]}, "options"=>{"summary"=>"Execute custom handler.", "description"=>"Request rate limited to 2 requests per second with bursts up to 25 requests.", "operationId"=>"Document_OptionsCustomScript", "x-api-path-slug"=>"apiv1documentscriptscriptname-options", "parameters"=>[{"in"=>"path", "name"=>"ScriptName", "description"=>"The custom script name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Execute", "Custom", "Handler"]}}, "/api/v1/Inventory/{partnerId}"=>{"get"=>{"summary"=>"Download inventory as CSV.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Inventory_Download", "x-api-path-slug"=>"apiv1inventorypartnerid-get", "parameters"=>[{"in"=>"query", "name"=>"fileType", "description"=>"CSV or XLSX"}, {"in"=>"query", "name"=>"includeNullQuantity", "description"=>"Set to true to include items with null quantity"}, {"in"=>"query", "name"=>"mapped", "description"=>"Set to false to view items with no merchant SKU"}, {"in"=>"query", "name"=>"modifiedAfter", "description"=>"Only items modified after this time"}, {"in"=>"path", "name"=>"partnerId", "description"=>"Partner account number"}, {"in"=>"query", "name"=>"transform", "description"=>"Transform CSV (if configured)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Download", "Inventory", "As", "CSV"]}, "post"=>{"summary"=>"Import inventory from CSV.", "description"=>"Request rate limited to 1 request per second with bursts up to 2 requests.", "operationId"=>"Inventory_Upload", "x-api-path-slug"=>"apiv1inventorypartnerid-post", "parameters"=>[{"in"=>"formData", "name"=>"file", "description"=>"File to import"}, {"in"=>"path", "name"=>"partnerId", "description"=>"Partner account number"}, {"in"=>"query", "name"=>"transform", "description"=>"Transform CSV (if configured)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import", "Inventory", "From", "CSV"]}, "delete"=>{"summary"=>"Delete all inventory records.", "description"=>"Request rate limited to 1 request every 60 seconds with bursts up to 2 requests.", "operationId"=>"Inventory_DeleteAll", "x-api-path-slug"=>"apiv1inventorypartnerid-delete", "parameters"=>[{"in"=>"path", "name"=>"partnerId", "description"=>"Partner account number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Inventory", "Records"]}}, "/api/v1/Inventory/Broadcast"=>{"post"=>{"summary"=>"Import inventory from CSV.", "description"=>"Request rate limited to 1 request every 60 seconds with bursts up to 2 requests.", "operationId"=>"Inventory_Broadcast", "x-api-path-slug"=>"apiv1inventorybroadcast-post", "parameters"=>[{"in"=>"formData", "name"=>"file", "description"=>"File to import"}, {"in"=>"query", "name"=>"transform", "description"=>"Transform CSV (if configured)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import", "Inventory", "From", "CSV"]}}, "/api/v1/Inventory/{partnerId}/Matching"=>{"post"=>{"summary"=>"Match items with CSV.", "description"=>"Request rate limited to 1 request per second with bursts up to 2 requests.", "operationId"=>"Inventory_UploadMatching", "x-api-path-slug"=>"apiv1inventorypartneridmatching-post", "parameters"=>[{"in"=>"formData", "name"=>"file", "description"=>"File to import"}, {"in"=>"path", "name"=>"partnerId", "description"=>"Partner account number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Match", "Items", "CSV"]}, "delete"=>{"summary"=>"Delete all SKU mappings.", "description"=>"Request rate limited to 1 request every 60 seconds with bursts up to 2 requests.", "operationId"=>"Inventory_DeleteMappings", "x-api-path-slug"=>"apiv1inventorypartneridmatching-delete", "parameters"=>[{"in"=>"path", "name"=>"partnerId", "description"=>"Partner account number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SKU", "Mappings"]}}, "/api/v1/Inventory/{partnerId}/Resend"=>{"put"=>{"summary"=>"Resend all inventory items.", "description"=>"Request rate limited to 1 request every 5 minutes with bursts up to 2 requests.", "operationId"=>"Inventory_ResendAll", "x-api-path-slug"=>"apiv1inventorypartneridresend-put", "parameters"=>[{"in"=>"path", "name"=>"partnerId", "description"=>"Partner account number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resend", "", "Inventory", "Items"]}}, "/api/v1/Inventory/{partnerId}/Item/{sku}"=>{"get"=>{"summary"=>"Get a single item by SKU", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Inventory_GetItem", "x-api-path-slug"=>"apiv1inventorypartneriditemsku-get", "parameters"=>[{"in"=>"path", "name"=>"partnerId", "description"=>"Partner account number"}, {"in"=>"path", "name"=>"sku", "description"=>"Item SKU"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Item", "By", "SKU"]}}, "/api/v1/Inventory/Availability/{sku}"=>{"get"=>{"summary"=>"Get the availability of an item across all suppliers.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Inventory_GetAvailability", "x-api-path-slug"=>"apiv1inventoryavailabilitysku-get", "parameters"=>[{"in"=>"path", "name"=>"sku", "description"=>"Merchant SKU"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availability", "Of", "Item", "Across", "", "Suppliers"]}}, "/api/v1/Invoices/CustomXML"=>{"post"=>{"summary"=>"Create invoice(s) based on custom XML.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Invoice_UploadCustomXml", "x-api-path-slug"=>"apiv1invoicescustomxml-post", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"XML data to upload", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"formData", "name"=>"file", "description"=>"File to upload"}, {"in"=>"query", "name"=>"xmlType", "description"=>"XML type, leave blank unless directed otherwise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoice(s)", "Based", "On", "Custom", "XML"]}}, "/api/v1/Invoices"=>{"get"=>{"summary"=>"Get invoices based on provided filters", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Invoice_SearchInvoice", "x-api-path-slug"=>"apiv1invoices-get", "parameters"=>[{"in"=>"query", "name"=>"filters.advanced", "description"=>"Advanced query options"}, {"in"=>"query", "name"=>"filters.from", "description"=>"Beginning of time search window"}, {"in"=>"query", "name"=>"filters.linkkey", "description"=>"The linkkey identifies a group of related documents"}, {"in"=>"query", "name"=>"filters.page", "description"=>"Page number"}, {"in"=>"query", "name"=>"filters.pageSize", "description"=>"Page size"}, {"in"=>"query", "name"=>"filters.partnerPO", "description"=>"The partners purchase order number"}, {"in"=>"query", "name"=>"filters.receiverCompanyId", "description"=>"This Id is indicate who is received this document"}, {"in"=>"query", "name"=>"filters.senderCompanyId", "description"=>"This Id is indicate who is sent this document"}, {"in"=>"query", "name"=>"filters.sourceKey", "description"=>"Source key is usually the unique key the sender uses to find this document"}, {"in"=>"query", "name"=>"filters.status", "description"=>"The status of the document"}, {"in"=>"query", "name"=>"filters.to", "description"=>"End of time search window"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Invoices", "Based", "On", "Provided", "Filters"]}, "post"=>{"summary"=>"Create a new invoice", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Invoice_CreateInvoice", "x-api-path-slug"=>"apiv1invoices-post", "parameters"=>[{"in"=>"body", "name"=>"invoice", "description"=>"The invoice to save", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Invoice"]}}, "/api/v1/Invoices/{LogicbrokerKey}/Events"=>{"get"=>{"summary"=>"Retrieve related events", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Invoice_GetActivityEvent", "x-api-path-slug"=>"apiv1invoiceslogicbrokerkeyevents-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Related", "Events"]}}, "/api/v1/Invoices/{LogicbrokerKey}/EDI"=>{"get"=>{"summary"=>"Retrieve EDI", "description"=>"Returns the latest EDI related to this document that was either sent or received by Logicbroker. The EDI output may also contain other documents that were in the same batch.", "operationId"=>"Invoice_GetDocumentEDI", "x-api-path-slug"=>"apiv1invoiceslogicbrokerkeyedi-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "EDI"]}}, "/api/v1/Invoices/Import"=>{"post"=>{"summary"=>"Import from flat file.", "description"=>"Request rate limited to 1 request per second with bursts up to 10 requests.", "operationId"=>"Invoice_Import", "x-api-path-slug"=>"apiv1invoicesimport-post", "parameters"=>[{"in"=>"query", "name"=>"aliases", "description"=>"List of field names and aliases"}, {"in"=>"query", "name"=>"custom", "description"=>"False for standard format, true if using custom mapping configured by Logicbroker"}, {"in"=>"query", "name"=>"delimiter", "description"=>"Delimiter (CSV only)"}, {"in"=>"query", "name"=>"dryRun", "description"=>"Return invoice list instead of saving"}, {"in"=>"formData", "name"=>"file", "description"=>"File to import"}, {"in"=>"query", "name"=>"fileType", "description"=>"CSV or XLSX"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import", "From", "Flat", "File"]}}, "/api/v1/Invoices/Export"=>{"get"=>{"summary"=>"Export to CSV/XLSX", "description"=>"The 'fields' parameter accepts a comma delimited list of JSON paths, for example: 'Identifier.LogicbrokerKey, BillToAddress.FirstName'. It is also possible to rename these fields using syntax like 'DocumentDate as Date' or 'DocumentDate Date'.\r\n You must specify a value for either the 'LogicbrokerKeys' parameter or the 'filter' parameter.", "operationId"=>"Invoice_GetDocumentExportToken", "x-api-path-slug"=>"apiv1invoicesexport-get", "parameters"=>[{"in"=>"query", "name"=>"delimiter", "description"=>"The column delimiter to use for CSV export"}, {"in"=>"query", "name"=>"fields", "description"=>"The fields to export"}, {"in"=>"query", "name"=>"fileType", "description"=>"Valid options are csv, xlsx, xml, json and legacy"}, {"in"=>"query", "name"=>"filter.advanced", "description"=>"Advanced query options"}, {"in"=>"query", "name"=>"filter.from", "description"=>"Beginning of time search window"}, {"in"=>"query", "name"=>"filter.linkkey", "description"=>"The linkkey identifies a group of related documents"}, {"in"=>"query", "name"=>"filter.page", "description"=>"Page number"}, {"in"=>"query", "name"=>"filter.pageSize", "description"=>"Page size"}, {"in"=>"query", "name"=>"filter.partnerPO", "description"=>"The partners purchase order number"}, {"in"=>"query", "name"=>"filter.receiverCompanyId", "description"=>"This Id is indicate who is received this document"}, {"in"=>"query", "name"=>"filter.senderCompanyId", "description"=>"This Id is indicate who is sent this document"}, {"in"=>"query", "name"=>"filter.sourceKey", "description"=>"Source key is usually the unique key the sender uses to find this document"}, {"in"=>"query", "name"=>"filter.status", "description"=>"The status of the document"}, {"in"=>"query", "name"=>"filter.to", "description"=>"End of time search window"}, {"in"=>"query", "name"=>"LogicbrokerKeys", "description"=>"The logicbroker keys"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Export", "To", "CSV", "XLSX"]}}, "/api/v1/Invoices/{LogicbrokerKey}"=>{"get"=>{"summary"=>"Returns the invoice with the specified key.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Invoice_GetInvoice", "x-api-path-slug"=>"apiv1invoiceslogicbrokerkey-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The logicbroker key to search for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Invoice", "Specified", "Key"]}}, "/api/v1/Invoices/{LogicbrokerKey}/Status"=>{"get"=>{"summary"=>"Return the current status code of an invoice.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Invoice_GetInvoiceStatus", "x-api-path-slug"=>"apiv1invoiceslogicbrokerkeystatus-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The logicbroker key of the invoice to look up"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "Current", "Status", "Code", "Of", "Invoice"]}}, "/api/v1/Invoices/{LogicbrokerKey}/Status/{Status}"=>{"put"=>{"summary"=>"Updates an invoice to the specified status.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Invoice_UpdateInvoiceStatus", "x-api-path-slug"=>"apiv1invoiceslogicbrokerkeystatusstatus-put", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The logicbroker key of the invoice to update"}, {"in"=>"path", "name"=>"Status", "description"=>"The Status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Invoice", "To", "Specified", "Status"]}}, "/api/v1/Orders/{LogicbrokerKey}/Invoices"=>{"get"=>{"summary"=>"Retrieve a list of invoices for an order", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Order_GetInvoice", "x-api-path-slug"=>"apiv1orderslogicbrokerkeyinvoices-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Invoicesan", "Order"]}, "post"=>{"summary"=>"Creates invoice and links with the given order", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Order_CreateInvoiceForSalesOrder", "x-api-path-slug"=>"apiv1orderslogicbrokerkeyinvoices-post", "parameters"=>[{"in"=>"body", "name"=>"Invoice", "description"=>"The invoice", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Invoice", "Links", "Given", "Order"]}}, "/api/v1/Orders/CustomXML"=>{"post"=>{"summary"=>"Create order(s) based on custom XML.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Order_UploadCustomXml", "x-api-path-slug"=>"apiv1orderscustomxml-post", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"XML data to upload", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"formData", "name"=>"file", "description"=>"File to upload"}, {"in"=>"query", "name"=>"xmlType", "description"=>"XML type, leave blank unless directed otherwise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order(s)", "Based", "On", "Custom", "XML"]}}, "/api/v1/Orders"=>{"get"=>{"summary"=>"Search orders", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Order_SearchSalesOrders", "x-api-path-slug"=>"apiv1orders-get", "parameters"=>[{"in"=>"query", "name"=>"Filters.advanced", "description"=>"Advanced query options"}, {"in"=>"query", "name"=>"Filters.from", "description"=>"Beginning of time search window"}, {"in"=>"query", "name"=>"Filters.linkkey", "description"=>"The linkkey identifies a group of related documents"}, {"in"=>"query", "name"=>"Filters.page", "description"=>"Page number"}, {"in"=>"query", "name"=>"Filters.pageSize", "description"=>"Page size"}, {"in"=>"query", "name"=>"Filters.partnerPO", "description"=>"The partners purchase order number"}, {"in"=>"query", "name"=>"Filters.receiverCompanyId", "description"=>"This Id is indicate who is received this document"}, {"in"=>"query", "name"=>"Filters.senderCompanyId", "description"=>"This Id is indicate who is sent this document"}, {"in"=>"query", "name"=>"Filters.sourceKey", "description"=>"Source key is usually the unique key the sender uses to find this document"}, {"in"=>"query", "name"=>"Filters.status", "description"=>"The status of the document"}, {"in"=>"query", "name"=>"Filters.to", "description"=>"End of time search window"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Orders"]}, "post"=>{"summary"=>"Create an order", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Order_CreateSalesOrder", "x-api-path-slug"=>"apiv1orders-post", "parameters"=>[{"in"=>"body", "name"=>"SalesOrder", "description"=>"Order object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order"]}}, "/api/v1/Orders/{LogicbrokerKey}/Shipments"=>{"get"=>{"summary"=>"Retrieve a list of shipments for an order", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Order_GetASN", "x-api-path-slug"=>"apiv1orderslogicbrokerkeyshipments-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Shipmentsan", "Order"]}, "post"=>{"summary"=>"The create shipment for sales order.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Order_CreateShipmentForSalesOrder", "x-api-path-slug"=>"apiv1orderslogicbrokerkeyshipments-post", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker Key"}, {"in"=>"body", "name"=>"Shipment", "description"=>"The shipment", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["The", "Create", "Shipmentsales", "Order"]}}, "/api/v1/Orders/{LogicbrokerKey}/Events"=>{"get"=>{"summary"=>"Retrieve related events", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Order_GetActivityEvent", "x-api-path-slug"=>"apiv1orderslogicbrokerkeyevents-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Related", "Events"]}}, "/api/v1/Orders/{LogicbrokerKey}/Returns"=>{"get"=>{"summary"=>"Retrieve a list of returns for an order", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Order_GetReturns", "x-api-path-slug"=>"apiv1orderslogicbrokerkeyreturns-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Returnsan", "Order"]}, "post"=>{"summary"=>"The create return for sales order.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Order_CreateReturnForSalesOrder", "x-api-path-slug"=>"apiv1orderslogicbrokerkeyreturns-post", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker Key"}, {"in"=>"body", "name"=>"Return", "description"=>"The shipment", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["The", "Create", "Returnsales", "Order"]}}, "/api/v1/Orders/{LogicbrokerKey}/EDI"=>{"get"=>{"summary"=>"Retrieve EDI", "description"=>"Returns the latest EDI related to this document that was either sent or received by Logicbroker. The EDI output may also contain other documents that were in the same batch.", "operationId"=>"Order_GetDocumentEDI", "x-api-path-slug"=>"apiv1orderslogicbrokerkeyedi-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "EDI"]}}, "/api/v1/Orders/Import"=>{"post"=>{"summary"=>"Import from flat file.", "description"=>"Request rate limited to 1 request per second with bursts up to 10 requests.", "operationId"=>"Order_Import", "x-api-path-slug"=>"apiv1ordersimport-post", "parameters"=>[{"in"=>"query", "name"=>"aliases", "description"=>"List of field names and aliases"}, {"in"=>"query", "name"=>"custom", "description"=>"False for standard format, true if using custom mapping configured by Logicbroker"}, {"in"=>"query", "name"=>"delimiter", "description"=>"Delimiter (CSV only)"}, {"in"=>"query", "name"=>"dryRun", "description"=>"Return order list instead of saving"}, {"in"=>"formData", "name"=>"file", "description"=>"File to import"}, {"in"=>"query", "name"=>"fileType", "description"=>"CSV or XLSX"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import", "From", "Flat", "File"]}}, "/api/v1/Orders/Export"=>{"get"=>{"summary"=>"Export to CSV/XLSX", "description"=>"The 'fields' parameter accepts a comma delimited list of JSON paths, for example: 'Identifier.logicbrokerKey, BillToAddress.FirstName'. It is also possible to rename these fields using syntax like 'DocumentDate as Date' or 'DocumentDate Date'.\r\n You must specify a value for either the 'LogicbrokerKeys' parameter or the 'filter' parameter.", "operationId"=>"Order_GetDocumentExportToken", "x-api-path-slug"=>"apiv1ordersexport-get", "parameters"=>[{"in"=>"query", "name"=>"Delimiter", "description"=>"The column delimiter to use for CSV export"}, {"in"=>"query", "name"=>"Fields", "description"=>"The fields to export"}, {"in"=>"query", "name"=>"FileType", "description"=>"Valid options are csv, xlsx, xml, json and legacy"}, {"in"=>"query", "name"=>"Filter.advanced", "description"=>"Advanced query options"}, {"in"=>"query", "name"=>"Filter.from", "description"=>"Beginning of time search window"}, {"in"=>"query", "name"=>"Filter.linkkey", "description"=>"The linkkey identifies a group of related documents"}, {"in"=>"query", "name"=>"Filter.page", "description"=>"Page number"}, {"in"=>"query", "name"=>"Filter.pageSize", "description"=>"Page size"}, {"in"=>"query", "name"=>"Filter.partnerPO", "description"=>"The partners purchase order number"}, {"in"=>"query", "name"=>"Filter.receiverCompanyId", "description"=>"This Id is indicate who is received this document"}, {"in"=>"query", "name"=>"Filter.senderCompanyId", "description"=>"This Id is indicate who is sent this document"}, {"in"=>"query", "name"=>"Filter.sourceKey", "description"=>"Source key is usually the unique key the sender uses to find this document"}, {"in"=>"query", "name"=>"Filter.status", "description"=>"The status of the document"}, {"in"=>"query", "name"=>"Filter.to", "description"=>"End of time search window"}, {"in"=>"query", "name"=>"LogicbrokerKeys", "description"=>"The logicbroker keys"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Export", "To", "CSV", "XLSX"]}}, "/api/v1/Orders/{LogicbrokerKey}/PickList"=>{"get"=>{"summary"=>"Get pick list for one order", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Order_GetOrderPickList", "x-api-path-slug"=>"apiv1orderslogicbrokerkeypicklist-get", "parameters"=>[{"in"=>"query", "name"=>"FileType", "description"=>"Valid types: jpg, png, pdf, ps, zpl"}, {"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The logicbroker Key"}, {"in"=>"query", "name"=>"ViewInBrowser", "description"=>"Set to true to view the resulting link in the browser"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pick", "Listone", "Order"]}}, "/api/v1/Orders/PickList"=>{"get"=>{"summary"=>"Get pick lists for multiple orders", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Order_GetOrderPickListToken", "x-api-path-slug"=>"apiv1orderspicklist-get", "parameters"=>[{"in"=>"query", "name"=>"FileType", "description"=>"Valid types: jpg, png, pdf, ps, zpl"}, {"in"=>"query", "name"=>"LogicbrokerKeys", "description"=>"The logicbroker Keys"}, {"in"=>"query", "name"=>"ViewInBrowser", "description"=>"Set to true to view the resulting link in the browser"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pick", "Listsmultiple", "Orders"]}}, "/api/v1/Orders/{LogicbrokerKey}"=>{"get"=>{"summary"=>"Retrieve an order", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Order_GetSalesOrderDetails", "x-api-path-slug"=>"apiv1orderslogicbrokerkey-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Order"]}}, "/api/v1/Orders/{LogicbrokerKey}/Status"=>{"get"=>{"summary"=>"Retrieve order status", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Order_GetSalesOrderStatus", "x-api-path-slug"=>"apiv1orderslogicbrokerkeystatus-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Order", "Status"]}}, "/api/v1/Orders/{LogicbrokerKey}/Status/{Status}"=>{"put"=>{"summary"=>"Update order status", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Order_UpdateSalesOrderStatus", "x-api-path-slug"=>"apiv1orderslogicbrokerkeystatusstatus-put", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker Key"}, {"in"=>"path", "name"=>"Status", "description"=>"The Status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order", "Status"]}}, "/api/v1/Orders/{LogicbrokerKey}/ShippingOptions"=>{"get"=>{"summary"=>"Get shipping/tracking label options.", "description"=>"Request rate limited to 2 requests per second with bursts up to 25 requests.", "operationId"=>"Order_GetShippingOptions", "x-api-path-slug"=>"apiv1orderslogicbrokerkeyshippingoptions-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Tracking", "Label", "Options"]}}, "/api/v1/Orders/{LogicbrokerKey}/TrackingLabel"=>{"post"=>{"summary"=>"Generate a tracking label for a given package", "description"=>"Request rate limited to 2 requests per second with bursts up to 25 requests.", "operationId"=>"Order_CreateTrackingLabel", "x-api-path-slug"=>"apiv1orderslogicbrokerkeytrackinglabel-post", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker key"}, {"in"=>"body", "name"=>"package", "description"=>"Package details", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"useSenderAccount", "description"=>"Set to true to use the senders shipping account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Generate", "Tracking", "Labela", "Given", "Package"]}}, "/api/v1/Partners"=>{"get"=>{"summary"=>"Retrieve a list of trading partners.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Partner_GetPartners", "x-api-path-slug"=>"apiv1partners-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "List", "Of", "Trading", "Partners"]}}, "/api/v1/Product/{partnerId}"=>{"post"=>{"summary"=>"Import product from CSV.", "description"=>"Request rate limited to 1 request per second with bursts up to 10 requests.", "operationId"=>"Product_Upload", "x-api-path-slug"=>"apiv1productpartnerid-post", "parameters"=>[{"in"=>"formData", "name"=>"file", "description"=>"File to import"}, {"in"=>"path", "name"=>"partnerId", "description"=>"Partner account number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import", "Product", "From", "CSV"]}}, "/api/v1/Product/{partnerId}/{feedId}"=>{"get"=>{"summary"=>"Get product feed status.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Product_GetFeedStatus", "x-api-path-slug"=>"apiv1productpartneridfeedid-get", "parameters"=>[{"in"=>"path", "name"=>"feedId", "description"=>"Feed identifier"}, {"in"=>"path", "name"=>"partnerId", "description"=>"Partner account number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "Feed", "Status"]}, "put"=>{"summary"=>"Send product feed.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Product_SendFeed", "x-api-path-slug"=>"apiv1productpartneridfeedid-put", "parameters"=>[{"in"=>"path", "name"=>"feedId", "description"=>"Feed identifier"}, {"in"=>"path", "name"=>"partnerId", "description"=>"Partner account number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Product", "Feed"]}, "delete"=>{"summary"=>"Delete product feed.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Product_DeleteFeed", "x-api-path-slug"=>"apiv1productpartneridfeedid-delete", "parameters"=>[{"in"=>"path", "name"=>"feedId", "description"=>"Feed identifier"}, {"in"=>"path", "name"=>"partnerId", "description"=>"Partner account number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "Feed"]}}, "/api/v1/Product/{partnerId}/{feedId}/Items"=>{"get"=>{"summary"=>"Get items in the product feed.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Product_GetFeedItems", "x-api-path-slug"=>"apiv1productpartneridfeediditems-get", "parameters"=>[{"in"=>"path", "name"=>"feedId", "description"=>"Feed identifier"}, {"in"=>"query", "name"=>"isCompliant", "description"=>"Compliant filter"}, {"in"=>"query", "name"=>"page", "description"=>"Page number"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Page size"}, {"in"=>"path", "name"=>"partnerId", "description"=>"Partner account number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Items", "In", "Product", "Feed"]}}, "/api/v1/Product/{partnerId}/{feedId}/Items/{productId}"=>{"get"=>{"summary"=>"Get product feed item.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Product_GetFeedItem", "x-api-path-slug"=>"apiv1productpartneridfeediditemsproductid-get", "parameters"=>[{"in"=>"path", "name"=>"feedId", "description"=>"Feed identifier"}, {"in"=>"path", "name"=>"partnerId", "description"=>"Partner account number"}, {"in"=>"path", "name"=>"productId", "description"=>"Product identifier within the feed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "Feed", "Item"]}, "put"=>{"summary"=>"Update product feed item.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Product_UpdateFeedItem", "x-api-path-slug"=>"apiv1productpartneridfeediditemsproductid-put", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"Data fields to update", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"feedId", "description"=>"Feed identifier"}, {"in"=>"path", "name"=>"partnerId", "description"=>"Partner account number"}, {"in"=>"path", "name"=>"productId", "description"=>"Product identifier within the feed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "Feed", "Item"]}, "delete"=>{"summary"=>"Remove product feed item.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Product_RemoveFeedItem", "x-api-path-slug"=>"apiv1productpartneridfeediditemsproductid-delete", "parameters"=>[{"in"=>"path", "name"=>"feedId", "description"=>"Feed identifier"}, {"in"=>"path", "name"=>"partnerId", "description"=>"Partner account number"}, {"in"=>"path", "name"=>"productId", "description"=>"Product identifier within the feed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Product", "Feed", "Item"]}}, "/api/v1/Returns/{LogicbrokerKey}"=>{"get"=>{"summary"=>"Get return details", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Return_GetReturn", "x-api-path-slug"=>"apiv1returnslogicbrokerkey-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "Details"]}}, "/api/v1/Returns/CustomXML"=>{"post"=>{"summary"=>"Create return(s) based on custom XML.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Return_UploadCustomXml", "x-api-path-slug"=>"apiv1returnscustomxml-post", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"XML data to upload", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"formData", "name"=>"file", "description"=>"File to upload"}, {"in"=>"query", "name"=>"xmlType", "description"=>"XML type, leave blank unless directed otherwise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return(s)", "Based", "On", "Custom", "XML"]}}, "/api/v1/Returns/Request"=>{"post"=>{"summary"=>"Request a return", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Return_CreateReturnRequest", "x-api-path-slug"=>"apiv1returnsrequest-post", "parameters"=>[{"in"=>"body", "name"=>"Return", "description"=>"Return object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Request", "Return"]}}, "/api/v1/Returns"=>{"get"=>{"summary"=>"Search returns", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Return_SearchReturns", "x-api-path-slug"=>"apiv1returns-get", "parameters"=>[{"in"=>"query", "name"=>"filters.advanced", "description"=>"Advanced query options"}, {"in"=>"query", "name"=>"filters.from", "description"=>"Beginning of time search window"}, {"in"=>"query", "name"=>"filters.linkkey", "description"=>"The linkkey identifies a group of related documents"}, {"in"=>"query", "name"=>"filters.page", "description"=>"Page number"}, {"in"=>"query", "name"=>"filters.pageSize", "description"=>"Page size"}, {"in"=>"query", "name"=>"filters.partnerPO", "description"=>"The partners purchase order number"}, {"in"=>"query", "name"=>"filters.receiverCompanyId", "description"=>"This Id is indicate who is received this document"}, {"in"=>"query", "name"=>"filters.senderCompanyId", "description"=>"This Id is indicate who is sent this document"}, {"in"=>"query", "name"=>"filters.sourceKey", "description"=>"Source key is usually the unique key the sender uses to find this document"}, {"in"=>"query", "name"=>"filters.status", "description"=>"The status of the document"}, {"in"=>"query", "name"=>"filters.to", "description"=>"End of time search window"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Returns"]}, "post"=>{"summary"=>"Create a return", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Return_CreateReturn", "x-api-path-slug"=>"apiv1returns-post", "parameters"=>[{"in"=>"body", "name"=>"Return", "description"=>"Return object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return"]}}, "/api/v1/Returns/{LogicbrokerKey}/Status/{Status}"=>{"put"=>{"summary"=>"Update return status", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Return_UpdateReturnStatus", "x-api-path-slug"=>"apiv1returnslogicbrokerkeystatusstatus-put", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker Key"}, {"in"=>"path", "name"=>"Status", "description"=>"The Status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "Status"]}}, "/api/v1/Returns/{LogicbrokerKey}/Status"=>{"get"=>{"summary"=>"Retrieve return status", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Return_GetReturnStatus", "x-api-path-slug"=>"apiv1returnslogicbrokerkeystatus-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Return", "Status"]}}, "/api/v1/Returns/Export"=>{"get"=>{"summary"=>"Export to CSV/XLSX", "description"=>"The 'fields' parameter accepts a comma delimited list of JSON paths, for example: 'Identifier.LogicbrokerKey, BillToAddress.FirstName'. It is also possible to rename these fields using syntax like 'DocumentDate as Date' or 'DocumentDate Date'.\r\n You must specify a value for either the 'LogicbrokerKeys' parameter or the 'filter' parameter.", "operationId"=>"Return_GetDocumentExportToken", "x-api-path-slug"=>"apiv1returnsexport-get", "parameters"=>[{"in"=>"query", "name"=>"delimiter", "description"=>"The column delimiter to use for CSV export"}, {"in"=>"query", "name"=>"fields", "description"=>"The fields to export"}, {"in"=>"query", "name"=>"fileType", "description"=>"Valid options are csv, xlsx, xml, and json"}, {"in"=>"query", "name"=>"filter.advanced", "description"=>"Advanced query options"}, {"in"=>"query", "name"=>"filter.from", "description"=>"Beginning of time search window"}, {"in"=>"query", "name"=>"filter.linkkey", "description"=>"The linkkey identifies a group of related documents"}, {"in"=>"query", "name"=>"filter.page", "description"=>"Page number"}, {"in"=>"query", "name"=>"filter.pageSize", "description"=>"Page size"}, {"in"=>"query", "name"=>"filter.partnerPO", "description"=>"The partners purchase order number"}, {"in"=>"query", "name"=>"filter.receiverCompanyId", "description"=>"This Id is indicate who is received this document"}, {"in"=>"query", "name"=>"filter.senderCompanyId", "description"=>"This Id is indicate who is sent this document"}, {"in"=>"query", "name"=>"filter.sourceKey", "description"=>"Source key is usually the unique key the sender uses to find this document"}, {"in"=>"query", "name"=>"filter.status", "description"=>"The status of the document"}, {"in"=>"query", "name"=>"filter.to", "description"=>"End of time search window"}, {"in"=>"query", "name"=>"LogicbrokerKeys", "description"=>"The logicbroker keys"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Export", "To", "CSV", "XLSX"]}}, "/api/v1/Returns/{LogicbrokerKey}/EDI"=>{"get"=>{"summary"=>"Retrieve EDI", "description"=>"Returns the latest EDI related to this document that was either sent or received by Logicbroker. The EDI output may also contain other documents that were in the same batch.", "operationId"=>"Return_GetDocumentEDI", "x-api-path-slug"=>"apiv1returnslogicbrokerkeyedi-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "EDI"]}}, "/api/v1/Returns/Import"=>{"post"=>{"summary"=>"Import from flat file.", "description"=>"Request rate limited to 1 request per second with bursts up to 10 requests.", "operationId"=>"Return_Import", "x-api-path-slug"=>"apiv1returnsimport-post", "parameters"=>[{"in"=>"query", "name"=>"aliases", "description"=>"List of field names and aliases"}, {"in"=>"query", "name"=>"custom", "description"=>"False for standard format, true if using custom mapping configured by Logicbroker"}, {"in"=>"query", "name"=>"delimiter", "description"=>"Delimiter (CSV only)"}, {"in"=>"query", "name"=>"dryRun", "description"=>"Return shipment list instead of saving"}, {"in"=>"formData", "name"=>"file", "description"=>"File to import"}, {"in"=>"query", "name"=>"fileType", "description"=>"CSV or XLSX"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import", "From", "Flat", "File"]}}, "/api/v1/Shipments/CustomXML"=>{"post"=>{"summary"=>"Create shipment(s) based on custom XML.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Shipment_UploadCustomXml", "x-api-path-slug"=>"apiv1shipmentscustomxml-post", "parameters"=>[{"in"=>"body", "name"=>"data", "description"=>"XML data to upload", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"formData", "name"=>"file", "description"=>"File to upload"}, {"in"=>"query", "name"=>"xmlType", "description"=>"XML type, leave blank unless directed otherwise"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipment(s)", "Based", "On", "Custom", "XML"]}}, "/api/v1/Shipments"=>{"get"=>{"summary"=>"Get shipments for given filters", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Shipment_SearchShipment", "x-api-path-slug"=>"apiv1shipments-get", "parameters"=>[{"in"=>"query", "name"=>"Filters.advanced", "description"=>"Advanced query options"}, {"in"=>"query", "name"=>"Filters.from", "description"=>"Beginning of time search window"}, {"in"=>"query", "name"=>"Filters.linkkey", "description"=>"The linkkey identifies a group of related documents"}, {"in"=>"query", "name"=>"Filters.page", "description"=>"Page number"}, {"in"=>"query", "name"=>"Filters.pageSize", "description"=>"Page size"}, {"in"=>"query", "name"=>"Filters.partnerPO", "description"=>"The partners purchase order number"}, {"in"=>"query", "name"=>"Filters.receiverCompanyId", "description"=>"This Id is indicate who is received this document"}, {"in"=>"query", "name"=>"Filters.senderCompanyId", "description"=>"This Id is indicate who is sent this document"}, {"in"=>"query", "name"=>"Filters.sourceKey", "description"=>"Source key is usually the unique key the sender uses to find this document"}, {"in"=>"query", "name"=>"Filters.status", "description"=>"The status of the document"}, {"in"=>"query", "name"=>"Filters.to", "description"=>"End of time search window"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipmentsgiven", "Filters"]}, "post"=>{"summary"=>"Create a new shipment", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Shipment_CreateShipment", "x-api-path-slug"=>"apiv1shipments-post", "parameters"=>[{"in"=>"body", "name"=>"Shipment", "description"=>"The shipment to save", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Shipment"]}}, "/api/v1/Shipments/{LogicbrokerKey}/Events"=>{"get"=>{"summary"=>"Retrieve related events", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Shipment_GetActivityEvent", "x-api-path-slug"=>"apiv1shipmentslogicbrokerkeyevents-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "Related", "Events"]}}, "/api/v1/Shipments/{LogicbrokerKey}/EDI"=>{"get"=>{"summary"=>"Retrieve EDI", "description"=>"Returns the latest EDI related to this document that was either sent or received by Logicbroker. The EDI output may also contain other documents that were in the same batch.", "operationId"=>"Shipment_GetDocumentEDI", "x-api-path-slug"=>"apiv1shipmentslogicbrokerkeyedi-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Retrieve", "EDI"]}}, "/api/v1/Shipments/Import"=>{"post"=>{"summary"=>"Import from flat file.", "description"=>"Request rate limited to 1 request per second with bursts up to 10 requests.", "operationId"=>"Shipment_Import", "x-api-path-slug"=>"apiv1shipmentsimport-post", "parameters"=>[{"in"=>"query", "name"=>"aliases", "description"=>"List of field names and aliases"}, {"in"=>"query", "name"=>"custom", "description"=>"False for standard format, true if using custom mapping configured by Logicbroker"}, {"in"=>"query", "name"=>"delimiter", "description"=>"Delimiter (CSV only)"}, {"in"=>"query", "name"=>"dryRun", "description"=>"Return shipment list instead of saving"}, {"in"=>"formData", "name"=>"file", "description"=>"File to import"}, {"in"=>"query", "name"=>"fileType", "description"=>"CSV or XLSX"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Import", "From", "Flat", "File"]}}, "/api/v1/Shipments/Export"=>{"get"=>{"summary"=>"Export to CSV/XLSX", "description"=>"The 'fields' parameter accepts a comma delimited list of JSON paths, for example: 'Identifier.logicbrokerKey, BillToAddress.FirstName'. It is also possible to rename these fields using syntax like 'DocumentDate as Date' or 'DocumentDate Date'.\r\n You must specify a value for either the 'LogicbrokerKeys' parameter or the 'filter' parameter.", "operationId"=>"Shipment_GetDocumentExportToken", "x-api-path-slug"=>"apiv1shipmentsexport-get", "parameters"=>[{"in"=>"query", "name"=>"delimiter", "description"=>"The column delimiter to use for CSV export"}, {"in"=>"query", "name"=>"fields", "description"=>"The fields to export"}, {"in"=>"query", "name"=>"fileType", "description"=>"Valid options are csv, xlsx, xml, json and legacy"}, {"in"=>"query", "name"=>"filter.advanced", "description"=>"Advanced query options"}, {"in"=>"query", "name"=>"filter.from", "description"=>"Beginning of time search window"}, {"in"=>"query", "name"=>"filter.linkkey", "description"=>"The linkkey identifies a group of related documents"}, {"in"=>"query", "name"=>"filter.page", "description"=>"Page number"}, {"in"=>"query", "name"=>"filter.pageSize", "description"=>"Page size"}, {"in"=>"query", "name"=>"filter.partnerPO", "description"=>"The partners purchase order number"}, {"in"=>"query", "name"=>"filter.receiverCompanyId", "description"=>"This Id is indicate who is received this document"}, {"in"=>"query", "name"=>"filter.senderCompanyId", "description"=>"This Id is indicate who is sent this document"}, {"in"=>"query", "name"=>"filter.sourceKey", "description"=>"Source key is usually the unique key the sender uses to find this document"}, {"in"=>"query", "name"=>"filter.status", "description"=>"The status of the document"}, {"in"=>"query", "name"=>"filter.to", "description"=>"End of time search window"}, {"in"=>"query", "name"=>"LogicbrokerKeys", "description"=>"The logicbroker keys"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Export", "To", "CSV", "XLSX"]}}, "/api/v1/Shipments/{LogicbrokerKey}"=>{"get"=>{"summary"=>"Get shipment details", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Shipment_GetShipment", "x-api-path-slug"=>"apiv1shipmentslogicbrokerkey-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipment", "Details"]}, "put"=>{"summary"=>"Update shipment details", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Shipment_UpdateShipment", "x-api-path-slug"=>"apiv1shipmentslogicbrokerkey-put", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker key"}, {"in"=>"body", "name"=>"Shipment", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipment", "Details"]}}, "/api/v1/Shipments/{LogicbrokerKey}/PackingSlip"=>{"get"=>{"summary"=>"Get packing slips for one shipment", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Shipment_GetShipmentPackingSlip", "x-api-path-slug"=>"apiv1shipmentslogicbrokerkeypackingslip-get", "parameters"=>[{"in"=>"query", "name"=>"fileType", "description"=>"Valid types: jpg, png, pdf, ps, zpl"}, {"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The logicbroker Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Packing", "Slipsone", "Shipment"]}}, "/api/v1/Shipments/PackingSlip"=>{"get"=>{"summary"=>"Get packing slips for multiple shipments", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Shipment_GetShipmentPackingSlipsToken", "x-api-path-slug"=>"apiv1shipmentspackingslip-get", "parameters"=>[{"in"=>"query", "name"=>"fileType", "description"=>"Valid types: jpg, png, pdf, ps, zpl"}, {"in"=>"query", "name"=>"LogicbrokerKeys", "description"=>"The logicbroker Keys"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Packing", "Slipsmultiple", "Shipments"]}, "post"=>{"summary"=>"Get packing slips for a shipment before submitting", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Shipment_GetShipmentPackingSlipsToken", "x-api-path-slug"=>"apiv1shipmentspackingslip-post", "parameters"=>[{"in"=>"query", "name"=>"fileType", "description"=>"Valid types: jpg, png, pdf, ps, zpl"}, {"in"=>"body", "name"=>"shipment", "description"=>"Shipment data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Packing", "Slipsa", "Shipment", "Before", "Submitting"]}}, "/api/v1/Shipments/ShippingLabel"=>{"get"=>{"summary"=>"Get shipping labels for multiple shipments", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Shipment_GetShipmentShippingLabelToken", "x-api-path-slug"=>"apiv1shipmentsshippinglabel-get", "parameters"=>[{"in"=>"query", "name"=>"containerCode", "description"=>"Specific container code"}, {"in"=>"query", "name"=>"fileType", "description"=>"Valid types: jpg, png, pdf, ps, zpl"}, {"in"=>"query", "name"=>"LogicbrokerKeys", "description"=>"The Logicbroker keys"}, {"in"=>"query", "name"=>"ViewInBrowser", "description"=>"Set to true to view the resulting link in the browser"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Labelsmultiple", "Shipments"]}, "post"=>{"summary"=>"Get shipping labels for a shipment before submitting", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Shipment_GetShipmentShippingLabelToken", "x-api-path-slug"=>"apiv1shipmentsshippinglabel-post", "parameters"=>[{"in"=>"query", "name"=>"containerCode", "description"=>"Specific container code"}, {"in"=>"query", "name"=>"fileType", "description"=>"Valid types: jpg, png, pdf, ps, zpl"}, {"in"=>"body", "name"=>"shipment", "description"=>"Shipment data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"ViewInBrowser", "description"=>"Set to true to view the resulting link in the browser"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Labelsa", "Shipment", "Before", "Submitting"]}}, "/api/v1/Shipments/{LogicbrokerKey}/ShippingLabel"=>{"get"=>{"summary"=>"Get shipping labels for one shipment.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Shipment_GetShipmentShippingSingleLabelToken", "x-api-path-slug"=>"apiv1shipmentslogicbrokerkeyshippinglabel-get", "parameters"=>[{"in"=>"query", "name"=>"containerCode", "description"=>"Specific container code"}, {"in"=>"query", "name"=>"fileType", "description"=>"Valid types: jpg, png, pdf, ps, zpl"}, {"in"=>"path", "name"=>"LogicbrokerKey", "description"=>"The Logicbroker key"}, {"in"=>"query", "name"=>"ViewInBrowser", "description"=>"Set to true to view the resulting link in the browser"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Labelsone", "Shipment"]}}, "/api/v1/Shipments/{LogicbrokerKey}/status"=>{"get"=>{"summary"=>"Get shipment status", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Shipment_GetShipmentStatus", "x-api-path-slug"=>"apiv1shipmentslogicbrokerkeystatus-get", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipment", "Status"]}}, "/api/v1/Shipments/{LogicbrokerKey}/status/{Status}"=>{"put"=>{"summary"=>"Update shipment status", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Shipment_UpdateShipmentStatus", "x-api-path-slug"=>"apiv1shipmentslogicbrokerkeystatusstatus-put", "parameters"=>[{"in"=>"path", "name"=>"LogicbrokerKey"}, {"in"=>"path", "name"=>"Status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipment", "Status"]}}, "/api/v1/Shipments/ContainerCode"=>{"get"=>{"summary"=>"Gets a new SSCC18 container code.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Shipment_GetContainerCode", "x-api-path-slug"=>"apiv1shipmentscontainercode-get", "parameters"=>[{"in"=>"query", "name"=>"containerType", "description"=>"Container type, valid types are box and pallet"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "New", "SSCC18", "Container", "Code"]}}, "/api/v1/Statuses"=>{"get"=>{"summary"=>"Get configured document statuses for each document", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Status_GetDocumentStatuses", "x-api-path-slug"=>"apiv1statuses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configured", "Document", "Statuseseach", "Document"]}}, "/api/v1/Statuses/{documentType}"=>{"get"=>{"summary"=>"Get configured document statuses for each document", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Status_GetDocumentStatusesByType", "x-api-path-slug"=>"apiv1statusesdocumenttype-get", "parameters"=>[{"in"=>"path", "name"=>"documentType", "description"=>"Document type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configured", "Document", "Statuseseach", "Document"]}}, "/api/v1/Webhooks"=>{"get"=>{"summary"=>"Get list of webhooks", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Webhook_GetWebHooks", "x-api-path-slug"=>"apiv1webhooks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Webhooks"]}, "post"=>{"summary"=>"Create a new webhook", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Webhook_CreateWebhook", "x-api-path-slug"=>"apiv1webhooks-post", "parameters"=>[{"in"=>"body", "name"=>"Webhook", "description"=>"The new webhook", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["New", "Webhook"]}}, "/api/v1/Webhooks/{WebhookId}"=>{"get"=>{"summary"=>"Get webhook details", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Webhook_GetWebhook", "x-api-path-slug"=>"apiv1webhookswebhookid-get", "parameters"=>[{"in"=>"path", "name"=>"WebhookId", "description"=>"The webhook id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook", "Details"]}, "put"=>{"summary"=>"Update a webhook", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Webhook_UpdateWebhook", "x-api-path-slug"=>"apiv1webhookswebhookid-put", "parameters"=>[{"in"=>"body", "name"=>"Webhook", "description"=>"The webhook", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"WebhookId", "description"=>"The webhook id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook"]}, "delete"=>{"summary"=>"Delete a webhook.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Webhook_DeleteWebhook", "x-api-path-slug"=>"apiv1webhookswebhookid-delete", "parameters"=>[{"in"=>"path", "name"=>"WebhookId", "description"=>"The webhook id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook"]}}, "/api/v1/Webhooks/{WebhookId}/Test"=>{"get"=>{"summary"=>"Test a webhook endpoint.", "description"=>"Request rate limited to 10 requests per second with bursts up to 100 requests.", "operationId"=>"Webhook_TestWebhook", "x-api-path-slug"=>"apiv1webhookswebhookidtest-get", "parameters"=>[{"in"=>"query", "name"=>"LogicbrokerKey", "description"=>"The key for a test document"}, {"in"=>"path", "name"=>"WebhookId", "description"=>"The webhook id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "Webhook", "Endpoint"]}}}}, "apis"=>{"name"=>"Logicbroker", "x-slug"=>"logicbroker", "description"=>"Logicbroker provides beautiful technology that unites brands, retailers, and the systems they rely on. Harness the latest in cloud and supply chain automation technology with unrivaled speed and integration flexibility. We craft the connections that enable digital commerce.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/logicbroker-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"", "tags"=>"Commerce,Retail", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"logicbroker/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Logic Broker CommerceAPI", "x-api-slug"=>"logic-broker-commerceapi", "description"=>"Logicbroker provides beautiful technology that unites brands, retailers, and the systems they rely on. Harness the latest in cloud and supply chain automation technology with unrivaled speed and integration flexibility. We craft the connections that enable digital commerce.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/logicbroker-logo.png", "humanURL"=>"https://www.logicbroker.com/", "baseURL"=>"https://stage.commerceapi.io//", "tags"=>"Commerce,Retail", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/logicbroker/logic-broker-commerceapi-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog-rss", "url"=>"https://www.logicbroker.com/feed/"}, {"type"=>"x-developer", "url"=>"https://dev.logicbroker.com/"}, {"type"=>"x-openapi", "url"=>"https://stage.commerceapi.io/swagger/docs/v1"}, {"type"=>"x-documentation", "url"=>"https://stage.commerceapi.io/swagger/ui/index"}, {"type"=>"x-website", "url"=>"https://www.logicbroker.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
lota-data{"lota-data-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Lota Data", "x-complete"=>1, "info"=>{"title"=>"Lota Data", "description"=>"access-the-most-exhaustive-accurate-and-uptodate-collection-of-global-and-hyperlocal-geocoded-events-and-activities-across-a-wide-range-of-categories-and-genres", "version"=>"2.0.0"}, "host"=>"api2.lotadata.com", "basePath"=>"/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/events"=>{"get"=>{"summary"=>"Get Events", "description"=>"Find event occurrences in the area. returns results at specific place and time, event groups are expanded for every occurrence..", "operationId"=>"events.get", "x-api-path-slug"=>"events-get", "parameters"=>[{"in"=>"query", "name"=>"activity", "description"=>"List of required activity type ids (compliment to category)"}, {"in"=>"query", "name"=>"ambience", "description"=>"List of required ambience ids"}, {"in"=>"query", "name"=>"bbox", "description"=>"Corner of a bounding box (lat,lng)"}, {"in"=>"query", "name"=>"capacity_max", "description"=>"Min capacity at location"}, {"in"=>"query", "name"=>"capacity_min", "description"=>"Min capacity at location"}, {"in"=>"query", "name"=>"category", "description"=>"List of required EventCategory ids (Tier 1)"}, {"in"=>"query", "name"=>"center", "description"=>"latitude,longitude of the origin point"}, {"in"=>"query", "name"=>"fieldset", "description"=>"Return results starting at specified offset (summary, context, detail)"}, {"in"=>"query", "name"=>"from_day", "description"=>"Start on or after date specified (2015-10-16)"}, {"in"=>"query", "name"=>"genre", "description"=>"List of required genre ids"}, {"in"=>"query", "name"=>"limit", "description"=>"Max results to return"}, {"in"=>"query", "name"=>"name", "description"=>"Matching on event and place names"}, {"in"=>"query", "name"=>"offset", "description"=>"Return results starting at specified offset"}, {"in"=>"query", "name"=>"polygon", "description"=>"Closed custom polygon"}, {"in"=>"query", "name"=>"q", "description"=>"Text query matching titles, description, various text, tags, category"}, {"in"=>"query", "name"=>"radius", "description"=>"Distance from origin in meters"}, {"in"=>"query", "name"=>"to_day", "description"=>"Start on or before date specified (2015-10-16)"}, {"in"=>"query", "name"=>"within", "description"=>"Search within specified geopolitical place id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/events/{id}"=>{"get"=>{"summary"=>"Get Events", "description"=>"Get specific event details..", "operationId"=>"events.id.get", "x-api-path-slug"=>"eventsid-get", "parameters"=>[{"in"=>"query", "name"=>"fieldset"}, {"in"=>"path", "name"=>"id", "description"=>"event @id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/places"=>{"get"=>{"summary"=>"Get Places", "description"=>"Venues, landmarks, regions, these are all places to search..", "operationId"=>"places.get", "x-api-path-slug"=>"places-get", "parameters"=>[{"in"=>"query", "name"=>"ambience", "description"=>"List of required ambience ids"}, {"in"=>"query", "name"=>"bbox", "description"=>"Corner of a bounding box (lat,lng)"}, {"in"=>"query", "name"=>"capacity_max", "description"=>"Min capacity at location"}, {"in"=>"query", "name"=>"capacity_min", "description"=>"Min capacity at location"}, {"in"=>"query", "name"=>"category", "description"=>"List of required PlaceCategory ids (Tier 1)"}, {"in"=>"query", "name"=>"center", "description"=>"latitude,longitude of the origin point"}, {"in"=>"query", "name"=>"country", "description"=>"country component of the address"}, {"in"=>"query", "name"=>"exact", "description"=>"Require an exact name match"}, {"in"=>"query", "name"=>"fieldset", "description"=>"Return results starting at specified offset (summary, context, detail)"}, {"in"=>"query", "name"=>"function", "description"=>"List of required PlaceFunction ids (Tier 2)"}, {"in"=>"query", "name"=>"limit", "description"=>"Max results to return"}, {"in"=>"query", "name"=>"locality", "description"=>"city, town, or neighborhood of the place"}, {"in"=>"query", "name"=>"name", "description"=>"Match on place names"}, {"in"=>"query", "name"=>"offset", "description"=>"Return results starting at specified offset"}, {"in"=>"query", "name"=>"polygon", "description"=>"Closed custom polygon"}, {"in"=>"query", "name"=>"postal_code", "description"=>"Postal or zip code"}, {"in"=>"query", "name"=>"radius", "description"=>"Distance from origin in meters"}, {"in"=>"query", "name"=>"region", "description"=>"region or state"}, {"in"=>"query", "name"=>"street", "description"=>"Address of the place or street component of the address"}, {"in"=>"query", "name"=>"tag", "description"=>"List of required tags"}, {"in"=>"query", "name"=>"type", "description"=>"Specific PlaceType to return"}, {"in"=>"query", "name"=>"within", "description"=>"Search within specified geopolitical place id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places"]}}, "/places/{id}"=>{"get"=>{"summary"=>"Get Places", "description"=>"Get specific place details.", "operationId"=>"places.id.get", "x-api-path-slug"=>"placesid-get", "parameters"=>[{"in"=>"query", "name"=>"fieldset"}, {"in"=>"path", "name"=>"id", "description"=>"place @id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Places"]}}}}, "apis"=>{"name"=>"Lota Data", "x-slug"=>"lota-data", "description"=>"", "image"=>"", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Analysis,API Provider,Data,General Data,Profiles,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"lota-data/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Lota Data", "x-api-slug"=>"lota-data", "description"=>"", "image"=>"", "humanURL"=>"http://lotadata.com", "baseURL"=>"https://api2.lotadata.com//v2", "tags"=>"Analysis,API Provider,Data,General Data,Profiles,Relative Data,Service API", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/lota-data/placesid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/lota-data/lota-data-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://www.lotadata.com/blog/"}, {"type"=>"x-developer", "url"=>"https://docs.lotadata.com/"}, {"type"=>"x-documentation", "url"=>"https://docs.lotadata.com/apis.html"}, {"type"=>"x-monetization", "url"=>"https://docs.lotadata.com/monetization.html"}, {"type"=>"x-website", "url"=>"http://lotadata.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-codedeploy{"aws-codedeploy-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS CodeDeploy", "x-complete"=>1, "info"=>{"title"=>"AWS CodeDeploy API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddTagsToOnPremisesInstances"=>{"get"=>{"summary"=>"Add Tags To On Premises Instances", "description"=>"Adds tags to on-premises instances.", "operationId"=>"addTagsToOnPremisesInstances", "x-api-path-slug"=>"actionaddtagstoonpremisesinstances-get", "parameters"=>[{"in"=>"query", "name"=>"instanceNames", "description"=>"The names of the on-premises instances to which to add tags", "type"=>"string"}, {"in"=>"query", "name"=>"tags", "description"=>"The tag key-value pairs to add to the on-premises instances", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Premises Instances Tags"]}}, "/?Action=BatchGetApplicationRevisions"=>{"get"=>{"summary"=>"Batch Get Application Revisions", "description"=>"Gets information about one or more application revisions.", "operationId"=>"batchGetApplicationRevisions", "x-api-path-slug"=>"actionbatchgetapplicationrevisions-get", "parameters"=>[{"in"=>"query", "name"=>"applicationName", "description"=>"The name of an AWS CodeDeploy application about which to get revision information", "type"=>"string"}, {"in"=>"query", "name"=>"revisions", "description"=>"Information to get about the application revisions, including type and location", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Revisions"]}}, "/?Action=BatchGetApplications"=>{"get"=>{"summary"=>"Batch Get Applications", "description"=>"Gets information about one or more applications.", "operationId"=>"batchGetApplications", "x-api-path-slug"=>"actionbatchgetapplications-get", "parameters"=>[{"in"=>"query", "name"=>"applicationNames", "description"=>"A list of application names separated by spaces", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=BatchGetDeploymentGroups"=>{"get"=>{"summary"=>"Batch Get Deployment Groups", "description"=>"Gets information about one or more deployment groups.", "operationId"=>"batchGetDeploymentGroups", "x-api-path-slug"=>"actionbatchgetdeploymentgroups-get", "parameters"=>[{"in"=>"query", "name"=>"applicationName", "description"=>"The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"deploymentGroupNames", "description"=>"The deployment groups names", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment Groups"]}}, "/?Action=BatchGetDeploymentInstances"=>{"get"=>{"summary"=>"Batch Get Deployment Instances", "description"=>"Gets information about one or more instance that are part of a deployment\n group.", "operationId"=>"batchGetDeploymentInstances", "x-api-path-slug"=>"actionbatchgetdeploymentinstances-get", "parameters"=>[{"in"=>"query", "name"=>"deploymentId", "description"=>"The unique ID of a deployment", "type"=>"string"}, {"in"=>"query", "name"=>"instanceIds", "description"=>"The unique IDs of instances in the deployment group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment Instances"]}}, "/?Action=BatchGetDeployments"=>{"get"=>{"summary"=>"Batch Get Deployments", "description"=>"Gets information about one or more deployments.", "operationId"=>"batchGetDeployments", "x-api-path-slug"=>"actionbatchgetdeployments-get", "parameters"=>[{"in"=>"query", "name"=>"deploymentIds", "description"=>"A list of deployment IDs, separated by spaces", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/?Action=BatchGetOnPremisesInstances"=>{"get"=>{"summary"=>"Batch Get On Premises Instances", "description"=>"Gets information about one or more on-premises instances.", "operationId"=>"batchGetOnPremisesInstances", "x-api-path-slug"=>"actionbatchgetonpremisesinstances-get", "parameters"=>[{"in"=>"query", "name"=>"instanceNames", "description"=>"The names of the on-premises instances about which to get information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["On Premises Instances"]}}, "/?Action=CreateApplication"=>{"get"=>{"summary"=>"Create Application", "description"=>"Creates an application.", "operationId"=>"createApplication", "x-api-path-slug"=>"actioncreateapplication-get", "parameters"=>[{"in"=>"query", "name"=>"applicationName", "description"=>"The name of the application", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=CreateDeployment"=>{"get"=>{"summary"=>"Create Deployment", "description"=>"Deploys an application revision through the specified deployment group.", "operationId"=>"createDeployment", "x-api-path-slug"=>"actioncreatedeployment-get", "parameters"=>[{"in"=>"query", "name"=>"applicationName", "description"=>"The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"autoRollbackConfiguration", "description"=>"Configuration information for an automatic rollback that is added when a deployment is created", "type"=>"string"}, {"in"=>"query", "name"=>"deploymentConfigName", "description"=>"The name of a deployment configuration associated with the applicable IAM user or AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"deploymentGroupName", "description"=>"The name of the deployment group", "type"=>"string"}, {"in"=>"query", "name"=>"description", "description"=>"A comment about the deployment", "type"=>"string"}, {"in"=>"query", "name"=>"ignoreApplicationStopFailures", "description"=>"If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event", "type"=>"string"}, {"in"=>"query", "name"=>"revision", "description"=>"The type and location of the revision to deploy", "type"=>"string"}, {"in"=>"query", "name"=>"updateOutdatedInstancesOnly", "description"=>"Indicates whether to deploy to all instances or only to instances that are not running the latest application revision", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/?Action=CreateDeploymentConfig"=>{"get"=>{"summary"=>"Create Deployment Config", "description"=>"Creates a deployment configuration.", "operationId"=>"createDeploymentConfig", "x-api-path-slug"=>"actioncreatedeploymentconfig-get", "parameters"=>[{"in"=>"query", "name"=>"deploymentConfigName", "description"=>"The name of the deployment configuration to create", "type"=>"string"}, {"in"=>"query", "name"=>"minimumHealthyHosts", "description"=>"The minimum number of healthy instances that should be available at any time during the deployment", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/?Action=CreateDeploymentGroup"=>{"get"=>{"summary"=>"Create Deployment Group", "description"=>"Creates a deployment group to which application revisions will be\n deployed.", "operationId"=>"createDeploymentGroup", "x-api-path-slug"=>"actioncreatedeploymentgroup-get", "parameters"=>[{"in"=>"query", "name"=>"alarmConfiguration", "description"=>"Information to add about Amazon CloudWatch alarms when the deployment group is created", "type"=>"string"}, {"in"=>"query", "name"=>"applicationName", "description"=>"The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"autoRollbackConfiguration", "description"=>"Configuration information for an automatic rollback that is added when a deployment group is created", "type"=>"string"}, {"in"=>"query", "name"=>"autoScalingGroups", "description"=>"A list of associated Auto Scaling groups", "type"=>"string"}, {"in"=>"query", "name"=>"deploymentConfigName", "description"=>"If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation", "type"=>"string"}, {"in"=>"query", "name"=>"deploymentGroupName", "description"=>"The name of a new deployment group for the specified application", "type"=>"string"}, {"in"=>"query", "name"=>"ec2TagFilters", "description"=>"The Amazon EC2 tags on which to filter", "type"=>"string"}, {"in"=>"query", "name"=>"onPremisesInstanceTagFilters", "description"=>"The on-premises instance tags on which to filter", "type"=>"string"}, {"in"=>"query", "name"=>"serviceRoleArn", "description"=>"A service role ARN that allows AWS CodeDeploy to act on the users behalf when interacting with AWS services", "type"=>"string"}, {"in"=>"query", "name"=>"triggerConfigurations", "description"=>"Information about triggers to create when the deployment group is created", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment Groups"]}}, "/?Action=DeleteApplication"=>{"get"=>{"summary"=>"Delete Application", "description"=>"Deletes an application.", "operationId"=>"deleteApplication", "x-api-path-slug"=>"actiondeleteapplication-get", "parameters"=>[{"in"=>"query", "name"=>"applicationName", "description"=>"The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=DeleteDeploymentConfig"=>{"get"=>{"summary"=>"Delete Deployment Config", "description"=>"Deletes a deployment configuration.", "operationId"=>"deleteDeploymentConfig", "x-api-path-slug"=>"actiondeletedeploymentconfig-get", "parameters"=>[{"in"=>"query", "name"=>"deploymentConfigName", "description"=>"The name of a deployment configuration associated with the applicable IAM user or AWS account", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/?Action=DeleteDeploymentGroup"=>{"get"=>{"summary"=>"Delete Deployment Group", "description"=>"Deletes a deployment group.", "operationId"=>"deleteDeploymentGroup", "x-api-path-slug"=>"actiondeletedeploymentgroup-get", "parameters"=>[{"in"=>"query", "name"=>"applicationName", "description"=>"The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"deploymentGroupName", "description"=>"The name of an existing deployment group for the specified application", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment Groups"]}}, "/?Action=DeregisterOnPremisesInstance"=>{"get"=>{"summary"=>"Deregister On Premises Instance", "description"=>"Deregisters an on-premises instance.", "operationId"=>"deregisterOnPremisesInstance", "x-api-path-slug"=>"actionderegisteronpremisesinstance-get", "parameters"=>[{"in"=>"query", "name"=>"instanceName", "description"=>"The name of the on-premises instance to deregister", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["On Premises Instances"]}}, "/?Action=GetApplication"=>{"get"=>{"summary"=>"Get Application", "description"=>"Gets information about an application.", "operationId"=>"getApplication", "x-api-path-slug"=>"actiongetapplication-get", "parameters"=>[{"in"=>"query", "name"=>"applicationName", "description"=>"The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=GetApplicationRevision"=>{"get"=>{"summary"=>"Get Application Revision", "description"=>"Gets information about an application revision.", "operationId"=>"getApplicationRevision", "x-api-path-slug"=>"actiongetapplicationrevision-get", "parameters"=>[{"in"=>"query", "name"=>"applicationName", "description"=>"The name of the application that corresponds to the revision", "type"=>"string"}, {"in"=>"query", "name"=>"revision", "description"=>"Information about the application revision to get, including type and location", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Revisions"]}}, "/?Action=GetDeployment"=>{"get"=>{"summary"=>"Get Deployment", "description"=>"Gets information about a deployment.", "operationId"=>"getDeployment", "x-api-path-slug"=>"actiongetdeployment-get", "parameters"=>[{"in"=>"query", "name"=>"deploymentId", "description"=>"A deployment ID associated with the applicable IAM user or AWS account", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/?Action=GetDeploymentConfig"=>{"get"=>{"summary"=>"Get Deployment Config", "description"=>"Gets information about a deployment configuration.", "operationId"=>"getDeploymentConfig", "x-api-path-slug"=>"actiongetdeploymentconfig-get", "parameters"=>[{"in"=>"query", "name"=>"deploymentConfigName", "description"=>"The name of a deployment configuration associated with the applicable IAM user or AWS account", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/?Action=GetDeploymentGroup"=>{"get"=>{"summary"=>"Get Deployment Group", "description"=>"Gets information about a deployment group.", "operationId"=>"getDeploymentGroup", "x-api-path-slug"=>"actiongetdeploymentgroup-get", "parameters"=>[{"in"=>"query", "name"=>"applicationName", "description"=>"The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"deploymentGroupName", "description"=>"The name of an existing deployment group for the specified application", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment Groups"]}}, "/?Action=GetDeploymentInstance"=>{"get"=>{"summary"=>"Get Deployment Instance", "description"=>"Gets information about an instance as part of a deployment.", "operationId"=>"getDeploymentInstance", "x-api-path-slug"=>"actiongetdeploymentinstance-get", "parameters"=>[{"in"=>"query", "name"=>"deploymentId", "description"=>"The unique ID of a deployment", "type"=>"string"}, {"in"=>"query", "name"=>"instanceId", "description"=>"The unique ID of an instance in the deployment group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment Instances"]}}, "/?Action=GetOnPremisesInstance"=>{"get"=>{"summary"=>"Get On Premises Instance", "description"=>"Gets information about an on-premises instance.", "operationId"=>"getOnPremisesInstance", "x-api-path-slug"=>"actiongetonpremisesinstance-get", "parameters"=>[{"in"=>"query", "name"=>"instanceName", "description"=>"The name of the on-premises instance about which to get information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["On Premises Instances"]}}, "/?Action=ListApplicationRevisions"=>{"get"=>{"summary"=>"List Application Revisions", "description"=>"Lists information about revisions for an application.", "operationId"=>"listApplicationRevisions", "x-api-path-slug"=>"actionlistapplicationrevisions-get", "parameters"=>[{"in"=>"query", "name"=>"applicationName", "description"=>"The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"deployed", "description"=>"Whether to list revisions based on whether the revision is the target revision of an deployment group:", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier returned from the previous list application revisions call", "type"=>"string"}, {"in"=>"query", "name"=>"s3Bucket", "description"=>"An Amazon S3 bucket name to limit the search for revisions", "type"=>"string"}, {"in"=>"query", "name"=>"s3KeyPrefix", "description"=>"A key prefix for the set of Amazon S3 objects to limit the search for revisions", "type"=>"string"}, {"in"=>"query", "name"=>"sortBy", "description"=>"The column name to use to sort the list results:", "type"=>"string"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"The order in which to sort the list results:", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Revisions"]}}, "/?Action=ListApplications"=>{"get"=>{"summary"=>"List Applications", "description"=>"Lists the applications registered with the applicable IAM user or AWS\n account.", "operationId"=>"listApplications", "x-api-path-slug"=>"actionlistapplications-get", "parameters"=>[{"in"=>"query", "name"=>"nextToken", "description"=>"An identifier returned from the previous list applications call", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=ListDeploymentConfigs"=>{"get"=>{"summary"=>"List Deployment Configs", "description"=>"Lists the deployment configurations with the applicable IAM user or AWS\n account.", "operationId"=>"listDeploymentConfigs", "x-api-path-slug"=>"actionlistdeploymentconfigs-get", "parameters"=>[{"in"=>"query", "name"=>"nextToken", "description"=>"An identifier returned from the previous list deployment configurations call", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/?Action=ListDeploymentGroups"=>{"get"=>{"summary"=>"List Deployment Groups", "description"=>"Lists the deployment groups for an application registered with the applicable IAM\n user or AWS account.", "operationId"=>"listDeploymentGroups", "x-api-path-slug"=>"actionlistdeploymentgroups-get", "parameters"=>[{"in"=>"query", "name"=>"applicationName", "description"=>"The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier returned from the previous list deployment groups call", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment Groups"]}}, "/?Action=ListDeploymentInstances"=>{"get"=>{"summary"=>"List Deployment Instances", "description"=>"Lists the instance for a deployment associated with the applicable IAM user or AWS\n account.", "operationId"=>"listDeploymentInstances", "x-api-path-slug"=>"actionlistdeploymentinstances-get", "parameters"=>[{"in"=>"query", "name"=>"deploymentId", "description"=>"The unique ID of a deployment", "type"=>"string"}, {"in"=>"query", "name"=>"instanceStatusFilter", "description"=>"A subset of instances to list by status:", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier returned from the previous list deployment instances call", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment Instances"]}}, "/?Action=ListDeployments"=>{"get"=>{"summary"=>"List Deployments", "description"=>"Lists the deployments in a deployment group for an application registered with the\n applicable IAM user or AWS account.", "operationId"=>"listDeployments", "x-api-path-slug"=>"actionlistdeployments-get", "parameters"=>[{"in"=>"query", "name"=>"applicationName", "description"=>"The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"createTimeRange", "description"=>"A time range (start and end) for returning a subset of the list of deployments", "type"=>"string"}, {"in"=>"query", "name"=>"deploymentGroupName", "description"=>"The name of an existing deployment group for the specified application", "type"=>"string"}, {"in"=>"query", "name"=>"includeOnlyStatuses", "description"=>"A subset of deployments to list by status:", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier returned from the previous list deployments call", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/?Action=ListOnPremisesInstances"=>{"get"=>{"summary"=>"List On Premises Instances", "description"=>"Gets a list of names for one or more on-premises instances.", "operationId"=>"listOnPremisesInstances", "x-api-path-slug"=>"actionlistonpremisesinstances-get", "parameters"=>[{"in"=>"query", "name"=>"nextToken", "description"=>"An identifier returned from the previous list on-premises instances call", "type"=>"string"}, {"in"=>"query", "name"=>"registrationStatus", "description"=>"The registration status of the on-premises instances:", "type"=>"string"}, {"in"=>"query", "name"=>"tagFilters", "description"=>"The on-premises instance tags that will be used to restrict the corresponding on-premises instance names returned", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["On Premises Instances"]}}, "/?Action=RegisterApplicationRevision"=>{"get"=>{"summary"=>"Register Application Revision", "description"=>"Registers with AWS CodeDeploy a revision for the specified application.", "operationId"=>"registerApplicationRevision", "x-api-path-slug"=>"actionregisterapplicationrevision-get", "parameters"=>[{"in"=>"query", "name"=>"applicationName", "description"=>"The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account", "type"=>"string"}, {"in"=>"query", "name"=>"description", "description"=>"A comment about the revision", "type"=>"string"}, {"in"=>"query", "name"=>"revision", "description"=>"Information about the application revision to register, including type and location", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Revisions"]}}, "/?Action=RegisterOnPremisesInstance"=>{"get"=>{"summary"=>"Register On Premises Instance", "description"=>"Registers an on-premises instance.", "operationId"=>"registerOnPremisesInstance", "x-api-path-slug"=>"actionregisteronpremisesinstance-get", "parameters"=>[{"in"=>"query", "name"=>"iamSessionArn", "description"=>"The ARN of the IAM session to associate with the on-premises instance", "type"=>"string"}, {"in"=>"query", "name"=>"iamUserArn", "description"=>"The ARN of the IAM user to associate with the on-premises instance", "type"=>"string"}, {"in"=>"query", "name"=>"instanceName", "description"=>"The name of the on-premises instance to register", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["On Premises Instances"]}}, "/?Action=RemoveTagsFromOnPremisesInstances"=>{"get"=>{"summary"=>"Remove Tags From On Premises Instances", "description"=>"Removes one or more tags from one or more on-premises instances.", "operationId"=>"removeTagsFromOnPremisesInstances", "x-api-path-slug"=>"actionremovetagsfromonpremisesinstances-get", "parameters"=>[{"in"=>"query", "name"=>"instanceNames", "description"=>"The names of the on-premises instances from which to remove tags", "type"=>"string"}, {"in"=>"query", "name"=>"tags", "description"=>"The tag key-value pairs to remove from the on-premises instances", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["On Premises Instances"]}}, "/?Action=StopDeployment"=>{"get"=>{"summary"=>"Stop Deployment", "description"=>"Attempts to stop an ongoing deployment.", "operationId"=>"stopDeployment", "x-api-path-slug"=>"actionstopdeployment-get", "parameters"=>[{"in"=>"query", "name"=>"autoRollbackEnabled", "description"=>"Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision", "type"=>"string"}, {"in"=>"query", "name"=>"deploymentId", "description"=>"The unique ID of a deployment", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/?Action=UpdateApplication"=>{"get"=>{"summary"=>"Update Application", "description"=>"Changes the name of an application.", "operationId"=>"updateApplication", "x-api-path-slug"=>"actionupdateapplication-get", "parameters"=>[{"in"=>"query", "name"=>"applicationName", "description"=>"The current name of the application you want to change", "type"=>"string"}, {"in"=>"query", "name"=>"newApplicationName", "description"=>"The new name to give the application", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=UpdateDeploymentGroup"=>{"get"=>{"summary"=>"Update Deployment Group", "description"=>"Changes information about a deployment group.", "operationId"=>"updateDeploymentGroup", "x-api-path-slug"=>"actionupdatedeploymentgroup-get", "parameters"=>[{"in"=>"query", "name"=>"alarmConfiguration", "description"=>"Information to add or change about Amazon CloudWatch alarms when the deployment group is updated", "type"=>"string"}, {"in"=>"query", "name"=>"applicationName", "description"=>"The application name corresponding to the deployment group to update", "type"=>"string"}, {"in"=>"query", "name"=>"autoRollbackConfiguration", "description"=>"Information for an automatic rollback configuration that is added or changed when a deployment group is updated", "type"=>"string"}, {"in"=>"query", "name"=>"autoScalingGroups", "description"=>"The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them", "type"=>"string"}, {"in"=>"query", "name"=>"currentDeploymentGroupName", "description"=>"The current name of the deployment group", "type"=>"string"}, {"in"=>"query", "name"=>"deploymentConfigName", "description"=>"The replacement deployment configuration name to use, if you want to change it", "type"=>"string"}, {"in"=>"query", "name"=>"ec2TagFilters", "description"=>"The replacement set of Amazon EC2 tags on which to filter, if you want to change them", "type"=>"string"}, {"in"=>"query", "name"=>"newDeploymentGroupName", "description"=>"The new name of the deployment group, if you want to change it", "type"=>"string"}, {"in"=>"query", "name"=>"onPremisesInstanceTagFilters", "description"=>"The replacement set of on-premises instance tags on which to filter, if you want to change them", "type"=>"string"}, {"in"=>"query", "name"=>"serviceRoleArn", "description"=>"A replacement ARN for the service role, if you want to change it", "type"=>"string"}, {"in"=>"query", "name"=>"triggerConfigurations", "description"=>"Information about triggers to change when the deployment group is updated", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment Groups"]}}}}, "apis"=>{"name"=>"AWS CodeDeploy", "x-slug"=>"aws-codedeploy", "description"=>"AWS CodeDeploy is a service that automates code deployments to any instance, including Amazon EC2 instances and instances running on-premises. AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications. You can use AWS CodeDeploy to automate software deployments, eliminating the need for error-prone manual operations, and the service scales with your infrastructure so you can easily deploy to one instance or thousands.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-codedeploy.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Orchestration,Profiles,Relative Data,SDK,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-codedeploy/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS CodeDeploy API", "x-api-slug"=>"aws-codedeploy-api", "description"=>"AWS CodeDeploy is a service that automates code deployments to any instance, including Amazon EC2 instances and instances running on-premises. AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications. You can use AWS CodeDeploy to automate software deployments, eliminating the need for error-prone manual operations, and the service scales with your infrastructure so you can easily deploy to one instance or thousands.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-codedeploy.png", "humanURL"=>"https://aws.amazon.com/codedeploy/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Orchestration,Profiles,Relative Data,SDK,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-codedeploy/aws-codedeploy-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/cli/latest/reference/codedeploy"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/codedeploy/latest/APIReference"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/codedeploy/faqs/"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=179"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/codedeploy/getting-started/"}, {"type"=>"x-integrations", "url"=>"https://aws.amazon.com/codedeploy/product-integrations/"}, {"type"=>"x-partners", "url"=>"https://aws.amazon.com/solutions/partners/dev-ops/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/codedeploy/pricing/"}, {"type"=>"x-tutorials", "url"=>"https://aws.amazon.com/codedeploy/developer-resources/#tutorials"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/codedeploy/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
clickatell{"clickatell-sms-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Clickatell", "x-complete"=>1, "info"=>{"title"=>"Clickatell SMS", "description"=>"the-clickatell-https-api-provides-just-about-the-simplest-way-of-programming-your-connection-to-clickatell-and-if-you-need-to-overcome-a-firewall-problem-https-is-almost-certainly-your-best-solution-", "termsOfService"=>"https://www.clickatell.com/about-us/terms-and-conditions/?_ga=1.209522258.1120142809.1413957851", "version"=>"v1"}, "host"=>"api.clickatell.com", "basePath"=>"http/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"sendmsg/"=>{"get"=>{"summary"=>"Send Message", "description"=>"The Clickatell HTTP/S API provides just about the simplest way of programming your connection to Clickatell, and if you need to overcome a firewall problem HTTP/S is almost certainly your best solution.", "operationId"=>"getSendmsg", "x-api-path-slug"=>"sendmsg-get", "parameters"=>[{"in"=>"query", "name"=>"api_id"}, {"in"=>"query", "name"=>"password"}, {"in"=>"query", "name"=>"text"}, {"in"=>"query", "name"=>"to"}, {"in"=>"query", "name"=>"user", "description"=>"The user id sending message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging"]}}}}, "apis"=>{"name"=>"Clickatell", "x-slug"=>"clickatell", "description"=>"Clickatell is a leading company in Global Mobile Messaging. You can reach 1000+ global networks with 1 API using Clickatells Bulk SMS Gateway.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/169-clickatell.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"105051", "tags"=>"API Provider,Applications,Email Marketing,Emails,Enterprise,File Transfer,Messages,Mobile,Networks,Profiles,Relative Data,SaaS,Service API,SMPP,SMS,SMS,SMTP,Stack Network,Technology,Telecommunications,Telecommunications", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"clickatell/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Clickatell SMS", "x-api-slug"=>"clickatell-sms", "description"=>"The Clickatell HTTP/S API provides just about the simplest way of programming your connection to Clickatell, and if you need to overcome a firewall problem HTTP/S is almost certainly your best solution.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/169-clickatell.jpg", "humanURL"=>"http://clickatell.com", "baseURL"=>"http://api.clickatell.com/http/", "tags"=>"API Provider,Applications,Email Marketing,Emails,Enterprise,File Transfer,Messages,Mobile,Networks,Profiles,Relative Data,SaaS,Service API,SMPP,SMS,SMS,SMTP,Stack Network,Technology,Telecommunications,Telecommunications", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/clickatell/sendmsg-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/clickatell/clickatell-sms-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-press", "url"=>"http://americas.clickatell.com/press-release/"}, {"type"=>"x--net-library", "url"=>"http://americas.clickatell.com/apis-scripts/scripts/c-scripts/"}, {"type"=>"x-base", "url"=>"http://api.clickatell.com"}, {"type"=>"x-coldfusion-library", "url"=>"http://americas.clickatell.com/apis-scripts/scripts/cold-fusion/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/clickatell-inc"}, {"type"=>"x-developer", "url"=>"http://americas.clickatell.com/apis-scripts/"}, {"type"=>"x-email", "url"=>"support@clickatell.com"}, {"type"=>"x-email", "url"=>"expertadvisors@clickatell.com"}, {"type"=>"x-email", "url"=>"accounts@clickatell.com"}, {"type"=>"x-email", "url"=>"legal@clickatell.com"}, {"type"=>"x-email", "url"=>"webterms@clickatell.com"}, {"type"=>"x-github", "url"=>"https://github.com/Clickatell"}, {"type"=>"x-php-library", "url"=>"http://americas.clickatell.com/apis-scripts/scripts/php/"}, {"type"=>"x-pricing", "url"=>"http://americas.clickatell.com/products/sms-gateway-cmnext/international-text-pricing/"}, {"type"=>"x-privacy", "url"=>"https://www.clickatell.com/about-us/privacy-policy/?_ga=1.185583465.1120142809.1413957851"}, {"type"=>"x-selfservice-registration", "url"=>"http://americas.clickatell.com/register/"}, {"type"=>"x-terms-of-service", "url"=>"https://www.clickatell.com/about-us/terms-and-conditions/?_ga=1.205319120.1120142809.1413957851"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Clickatell"}, {"type"=>"x-website", "url"=>"http://clickatell.com"}, {"type"=>"x-website", "url"=>"http://americas.clickatell.com/"}, {"type"=>"x-white-papers", "url"=>"http://americas.clickatell.com/resources/white-papers-guides/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
messente{"messente-sms-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Messente", "x-complete"=>1, "info"=>{"title"=>"Messente SMS API", "description"=>"-sending-sms-text-messages", "termsOfService"=>"https://messente.com/pages/terms", "version"=>"v1"}, "host"=>"api2.messente.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"send_sms/"=>{"get"=>{"summary"=>"Send SMS", "description"=>"Sending SMS text messages", "operationId"=>"sendSMS", "x-api-path-slug"=>"send-sms-get", "parameters"=>[{"in"=>"query", "name"=>"autoconvert", "description"=>"ontuse replacement settings from accounts API Auto Replace settings page fulltall non GSM 03"}, {"in"=>"query", "name"=>"charset", "description"=>"Encoding of the text and from parameter value"}, {"in"=>"query", "name"=>"dlr-url", "description"=>"URL where automatic Delivery Request is made"}, {"in"=>"query", "name"=>"from", "description"=>"Optional parameter that sets Sender"}, {"in"=>"query", "name"=>"password", "description"=>"API account security key (API key) from the Messentes web page"}, {"in"=>"query", "name"=>"text", "description"=>"All characters (Unicode) and long messages are supported"}, {"in"=>"query", "name"=>"time_to_send", "description"=>"Optional parameter for sending message at some specific time in the future"}, {"in"=>"query", "name"=>"to", "description"=>"Receivers phone number with country code"}, {"in"=>"query", "name"=>"udh", "description"=>"SMS User Data Header"}, {"in"=>"query", "name"=>"username", "description"=>"API account user name from the Messentes web page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SMS", "Messaging"]}}}}, "apis"=>{"name"=>"Messente", "x-slug"=>"messente", "description"=>"Simple, powerful, and transparent. Thats how we do business. Start messaging your clients and verifying users now. No commitments, contracts, or sign-up fees. http://messente.com/contact Were a forward-thinking team. Our purpose is to connect ...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1817-messente.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"677156", "tags"=>"API Provider,Enterprise,Messages,Messages,Mobile,Networks,Profiles,Relative Data,SaaS,Service API,SMS,Target,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"messente/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Messente SMS API", "x-api-slug"=>"messente-sms-api", "description"=>"Simple, powerful, and transparent. Thats how we do business. Start messaging your clients and verifying users now. No commitments, contracts, or sign-up fees. http://messente.com/contact Were a forward-thinking team. Our purpose is to connect ...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1817-messente.jpg", "humanURL"=>"https://messente.com", "baseURL"=>"http://api2.messente.com//", "tags"=>"API Provider,Enterprise,Messages,Messages,Mobile,Networks,Profiles,Relative Data,SaaS,Service API,SMS,Target,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/messente/send-sms-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/messente/messente-sms-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api2.messente.com"}, {"type"=>"x-blog", "url"=>"http://messente.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"http://messente.com/blog/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/messente-communications"}, {"type"=>"x-developer", "url"=>"https://messente.com/pages/api/"}, {"type"=>"x-email", "url"=>"support@messente.com"}, {"type"=>"x-email", "url"=>"lauri.kinkar@messente.com"}, {"type"=>"x-email", "url"=>"marcis.jurisons@messente.com"}, {"type"=>"x-email", "url"=>"jaanus.roomus@messente.com"}, {"type"=>"x-email", "url"=>"joosep.pintsaar@messente.com"}, {"type"=>"x-email", "url"=>"margus.sytt@messente.com"}, {"type"=>"x-email", "url"=>"marcus.kallavus@messente.com"}, {"type"=>"x-email", "url"=>"kaur.virunurm@messente.com"}, {"type"=>"x-email", "url"=>"uku.tomikas@messente.com"}, {"type"=>"x-email", "url"=>"raili.liiva@messente.com"}, {"type"=>"x-email", "url"=>"yuriy.mikitchenko@messente.com"}, {"type"=>"x-faq", "url"=>"https://messente.com/pages/faq"}, {"type"=>"x-pricing", "url"=>"https://messente.com/pricing/full"}, {"type"=>"x-terms-of-service", "url"=>"https://messente.com/pages/terms"}, {"type"=>"x-twitter", "url"=>"http://www.twitter.com/messente"}, {"type"=>"x-website", "url"=>"https://messente.com"}, {"type"=>"x-website", "url"=>"http://messente.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
constant-contact{"constant-contact-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Constant Contact", "x-complete"=>1, "info"=>{"title"=>"Constant Contact", "description"=>"make-constant-contacts-leading-email-and-event-marketing-services-accessible-directly-from-your-app-", "version"=>"1.0.0"}, "host"=>"api.constantcontact.com", "basePath"=>"/ws/customers/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{username}/activities"=>{"get"=>{"summary"=>"List Activities", "description"=>"List Activities", "operationId"=>"list-activities", "x-api-path-slug"=>"usernameactivities-get", "parameters"=>[{"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Activities"]}, "post"=>{"summary"=>"Add Activity", "description"=>"Add Activity", "operationId"=>"add-activity", "x-api-path-slug"=>"usernameactivities-post", "parameters"=>[{"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity"]}}, "/{username}/activities/{activity-id}"=>{"get"=>{"summary"=>"Get Activity", "description"=>"Get Activity", "operationId"=>"get-activity", "x-api-path-slug"=>"usernameactivitiesactivityid-get", "parameters"=>[{"in"=>"path", "name"=>"activity-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity"]}}, "/{username}/campaigns"=>{"get"=>{"summary"=>"List Campaigns", "description"=>"List Campaigns", "operationId"=>"list-campaigns", "x-api-path-slug"=>"usernamecampaigns-get", "parameters"=>[{"in"=>"query", "name"=>"refresh", "description"=>"To initiate re-calculation of campaign results, you must use refresh= true"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Campaigns"]}, "post"=>{"summary"=>"Add Campaign", "description"=>"Add Campaign", "operationId"=>"add-campaign", "x-api-path-slug"=>"usernamecampaigns-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaign"]}}, "/{username}/campaigns/{campaign-id}"=>{"delete"=>{"summary"=>"Delete Campaign", "description"=>"Delete Campaign", "operationId"=>"delete-campaign", "x-api-path-slug"=>"usernamecampaignscampaignid-delete", "parameters"=>[{"in"=>"path", "name"=>"campaign-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaign"]}, "get"=>{"summary"=>"Get Campaign", "description"=>"Get Campaign", "operationId"=>"get-campaign", "x-api-path-slug"=>"usernamecampaignscampaignid-get", "parameters"=>[{"in"=>"path", "name"=>"campaign-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaign"]}, "put"=>{"summary"=>"Update Campaign", "description"=>"Update Campaign", "operationId"=>"update-campaign", "x-api-path-slug"=>"usernamecampaignscampaignid-put", "parameters"=>[{"in"=>"path", "name"=>"campaign-id"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaign"]}}, "/{username}/campaigns/{campaign-id}/events/"=>{"get"=>{"summary"=>"Get Campaign Events", "description"=>"Get Campaign Events", "operationId"=>"get-campaign-events", "x-api-path-slug"=>"usernamecampaignscampaignidevents-get", "parameters"=>[{"in"=>"path", "name"=>"campaign-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Campaign", "Events"]}}, "/{username}/contacts"=>{"get"=>{"summary"=>"List Contacts", "description"=>"List Contacts", "operationId"=>"list-contacts", "x-api-path-slug"=>"usernamecontacts-get", "parameters"=>[{"in"=>"query", "name"=>"listid", "description"=>"Specific list"}, {"in"=>"query", "name"=>"updatedsince", "description"=>"Specified date"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Contacts"]}, "post"=>{"summary"=>"Add Contact", "description"=>"Add Contact", "operationId"=>"add-contact", "x-api-path-slug"=>"usernamecontacts-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/{username}/contacts/{contact-id}"=>{"delete"=>{"summary"=>"Opting-out Contact", "description"=>"Opting-out Contact", "operationId"=>"optingout-contact", "x-api-path-slug"=>"usernamecontactscontactid-delete", "parameters"=>[{"in"=>"path", "name"=>"contact-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Opting-out", "Contact"]}, "get"=>{"summary"=>"Get Contact", "description"=>"Get Contact", "operationId"=>"get-contact", "x-api-path-slug"=>"usernamecontactscontactid-get", "parameters"=>[{"in"=>"path", "name"=>"contact-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}, "put"=>{"summary"=>"Update Contact", "description"=>"Update Contact", "operationId"=>"update-contact", "x-api-path-slug"=>"usernamecontactscontactid-put", "parameters"=>[{"in"=>"path", "name"=>"contact-id"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/{username}/contacts/{contact-id}/events/"=>{"get"=>{"summary"=>"Get Per-Contact Campaign Events", "description"=>"Get Per-Contact Campaign Events", "operationId"=>"get-percontact-campaign-events", "x-api-path-slug"=>"usernamecontactscontactidevents-get", "parameters"=>[{"in"=>"path", "name"=>"contact-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Per-Contact", "Campaign", "Events"]}}, "/{username}/events"=>{"get"=>{"summary"=>"List Events", "description"=>"List Events", "operationId"=>"list-events", "x-api-path-slug"=>"usernameevents-get", "parameters"=>[{"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Events"]}, "post"=>{"summary"=>"Add Event", "description"=>"Add Event", "operationId"=>"add-event", "x-api-path-slug"=>"usernameevents-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/{username}/events/{event-id}"=>{"get"=>{"summary"=>"Get Event", "description"=>"Get Event", "operationId"=>"get-event", "x-api-path-slug"=>"usernameeventseventid-get", "parameters"=>[{"in"=>"path", "name"=>"event-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/{username}/events/{event-id}/registrants"=>{"get"=>{"summary"=>"List Registrants", "description"=>"List Registrants", "operationId"=>"list-registrants", "x-api-path-slug"=>"usernameeventseventidregistrants-get", "parameters"=>[{"in"=>"path", "name"=>"event-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Registrants"]}}, "/{username}/events/{event-id}/registrants/{registrant-id}"=>{"get"=>{"summary"=>"Get Registrant", "description"=>"Get Registrant", "operationId"=>"get-registrant", "x-api-path-slug"=>"usernameeventseventidregistrantsregistrantid-get", "parameters"=>[{"in"=>"path", "name"=>"event-id"}, {"in"=>"path", "name"=>"registrant-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registrant"]}}, "/{username}/events/{event-id}/registrants/{registrant-id}/attendancestatus"=>{"get"=>{"summary"=>"Get Attendance Status", "description"=>"Get Attendance Status", "operationId"=>"get-attendance-status", "x-api-path-slug"=>"usernameeventseventidregistrantsregistrantidattendancestatus-get", "parameters"=>[{"in"=>"path", "name"=>"event-id"}, {"in"=>"path", "name"=>"registrant-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attendance", "Status"]}, "put"=>{"summary"=>"Update Attendance Status", "description"=>"Update Attendance Status", "operationId"=>"update-attendance-status", "x-api-path-slug"=>"usernameeventseventidregistrantsregistrantidattendancestatus-put", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"path", "name"=>"event-id"}, {"in"=>"path", "name"=>"registrant-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attendance", "Status"]}}, "/{username}/events/{event-id}/registrants/{registrant-id}/guests"=>{"get"=>{"summary"=>"Get List of Guests", "description"=>"Get List of Guests", "operationId"=>"get-list-of-guests", "x-api-path-slug"=>"usernameeventseventidregistrantsregistrantidguests-get", "parameters"=>[{"in"=>"path", "name"=>"event-id"}, {"in"=>"path", "name"=>"registrant-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Guests"]}}, "/{username}/events/{event-id}/registrants/{registrant-id}/guests/{guest-id}"=>{"get"=>{"summary"=>"Get Guest Details", "description"=>"Get Guest Details", "operationId"=>"get-guest-details", "x-api-path-slug"=>"usernameeventseventidregistrantsregistrantidguestsguestid-get", "parameters"=>[{"in"=>"path", "name"=>"event-id"}, {"in"=>"path", "name"=>"guest-id"}, {"in"=>"path", "name"=>"registrant-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Guest", "Details"]}}, "/{username}/events/{event-id}/registrants/{registrant-id}/paymentstatus"=>{"get"=>{"summary"=>"Get Payment Status", "description"=>"Get Payment Status", "operationId"=>"get-payment-status", "x-api-path-slug"=>"usernameeventseventidregistrantsregistrantidpaymentstatus-get", "parameters"=>[{"in"=>"path", "name"=>"event-id"}, {"in"=>"path", "name"=>"registrant-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment", "Status"]}, "put"=>{"summary"=>"Update Payment Status", "description"=>"Update Payment Status", "operationId"=>"update-payment-status", "x-api-path-slug"=>"usernameeventseventidregistrantsregistrantidpaymentstatus-put", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"path", "name"=>"event-id"}, {"in"=>"path", "name"=>"registrant-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment", "Status"]}}, "/{username}/library/folders"=>{"get"=>{"summary"=>"List Folders", "description"=>"List Folders", "operationId"=>"list-folders", "x-api-path-slug"=>"usernamelibraryfolders-get", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"Specifies Accept"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Folders"]}}, "/{username}/library/folders/{folder-id}/images"=>{"delete"=>{"summary"=>"Delete All Images", "description"=>"Delete All Images", "operationId"=>"delete-all-images", "x-api-path-slug"=>"usernamelibraryfoldersfolderidimages-delete", "parameters"=>[{"in"=>"path", "name"=>"folder-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images"]}, "get"=>{"summary"=>"List Images", "description"=>"List Images", "operationId"=>"list-images", "x-api-path-slug"=>"usernamelibraryfoldersfolderidimages-get", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"Specifies Accept"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"path", "name"=>"folder-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Images"]}}, "/{username}/library/folders/{folder-id}/images/{image-id}"=>{"delete"=>{"summary"=>"Delete Image", "description"=>"Delete Image", "operationId"=>"delete-image", "x-api-path-slug"=>"usernamelibraryfoldersfolderidimagesimageid-delete", "parameters"=>[{"in"=>"path", "name"=>"folder-id"}, {"in"=>"path", "name"=>"image-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image"]}, "get"=>{"summary"=>"Get Image", "description"=>"Get Image", "operationId"=>"get-image", "x-api-path-slug"=>"usernamelibraryfoldersfolderidimagesimageid-get", "parameters"=>[{"in"=>"query", "name"=>"Accept", "description"=>"Specifies Accept"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"path", "name"=>"folder-id"}, {"in"=>"path", "name"=>"image-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image"]}}, "/{username}/lists"=>{"get"=>{"summary"=>"Get All Mailing Lists", "description"=>"Get All Mailing Lists", "operationId"=>"get-all-mailing-lists", "x-api-path-slug"=>"usernamelists-get", "parameters"=>[{"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mailing", "Lists"]}, "post"=>{"summary"=>"Add Mailing List", "description"=>"Add Mailing List", "operationId"=>"add-mailing-list", "x-api-path-slug"=>"usernamelists-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mailing", "List"]}}, "/{username}/lists/{list-id}"=>{"delete"=>{"summary"=>"Delete Mailing List", "description"=>"Delete Mailing List", "operationId"=>"delete-mailing-list", "x-api-path-slug"=>"usernamelistslistid-delete", "parameters"=>[{"in"=>"path", "name"=>"list-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mailing", "List"]}, "get"=>{"summary"=>"Get Mailing List", "description"=>"Get Mailing List", "operationId"=>"get-mailing-list", "x-api-path-slug"=>"usernamelistslistid-get", "parameters"=>[{"in"=>"path", "name"=>"list-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mailing", "List"]}, "put"=>{"summary"=>"Update Mailing List", "description"=>"Update Mailing List", "operationId"=>"update-mailing-list", "x-api-path-slug"=>"usernamelistslistid-put", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Specifies Content Type"}, {"in"=>"path", "name"=>"list-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mailing", "List"]}}, "/{username}/lists/{list-id}/members"=>{"get"=>{"summary"=>"Get Contacts Collection from a List", "description"=>"Get Contacts Collection from a List", "operationId"=>"get-contacts-collection-from-a-list", "x-api-path-slug"=>"usernamelistslistidmembers-get", "parameters"=>[{"in"=>"path", "name"=>"list-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts", "Collection", "From", "List"]}}, "/{username}/settings/emailaddresses"=>{"get"=>{"summary"=>"List Account Email Addresses", "description"=>"List Account Email Addresses", "operationId"=>"list-account-email-addresses", "x-api-path-slug"=>"usernamesettingsemailaddresses-get", "parameters"=>[{"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Account", "Email", "Resses"]}}, "/{username}/settings/emailaddresses/{email-id}"=>{"get"=>{"summary"=>"Get Email Address Details", "description"=>"Get Email Address Details", "operationId"=>"get-email-address-details", "x-api-path-slug"=>"usernamesettingsemailaddressesemailid-get", "parameters"=>[{"in"=>"path", "name"=>"email-id"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Ress", "Details"]}}}}, "apis"=>{"name"=>"Constant Contact", "x-slug"=>"constant-contact", "description"=>"With Constant Contact, you can create effective email marketing and other online marketing campaigns to meet your business goals. Start your FREE trial today!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/171-constant-contact.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"1364", "tags"=>"API Provider,CRM,Email Marketing,Emails,Federal Government,Federal Government,Federal Government,Federal Government,Getting Started Example,Profiles,Relative Data,SaaS,Service API,Social Media Marketing,Surveys,Technology,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"constant-contact/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Constant Contact", "x-api-slug"=>"constant-contact", "description"=>"With Constant Contact, you can create effective email marketing and other online marketing campaigns to meet your business goals. Start your FREE trial today!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/171-constant-contact.jpg", "humanURL"=>"http://blogs.constantcontact.com", "baseURL"=>"https://api.constantcontact.com//ws/customers/", "tags"=>"API Provider,CRM,Email Marketing,Emails,Federal Government,Federal Government,Federal Government,Federal Government,Getting Started Example,Profiles,Relative Data,SaaS,Service API,Social Media Marketing,Surveys,Technology,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/constant-contact/usernamesettingsemailaddressesemailid-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/constant-contact/constant-contact-openapi.yaml"}]}], "x-common"=>[{"type"=>"x--net-library", "url"=>"https://github.com/constantcontact/.net-sdk"}, {"type"=>"x-authentication", "url"=>"http://developer.constantcontact.com/docs/authentication/authentication.html"}, {"type"=>"x-base", "url"=>"https://api.constantcontact.com"}, {"type"=>"x-blog", "url"=>"http://techblog.constantcontact.com/"}, {"type"=>"x-blog-rss", "url"=>"http://techblog.constantcontact.com/feed/"}, {"type"=>"x-curated-source", "url"=>"http://blogs.constantcontact.com/mylibrary-mobile/"}, {"type"=>"x-website", "url"=>"http://blogs.constantcontact.com"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/constant-contact"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/constant-contact"}, {"type"=>"x-email", "url"=>"Webservices@constantcontact.com"}, {"type"=>"x-email", "url"=>"abuse@constantcontact.com"}, {"type"=>"x-email", "url"=>"privacy@constantcontact.com"}, {"type"=>"x-email", "url"=>"legal@constantcontact.com"}, {"type"=>"x-email", "url"=>"support@constantcontact.com"}, {"type"=>"x-email", "url"=>"security@constantcontact.com"}, {"type"=>"x-email", "url"=>"donotcall@constantcontact.com"}, {"type"=>"x-email", "url"=>"DMCA@constantcontact.com"}, {"type"=>"x-forum", "url"=>"http://developer.constantcontact.com/forums"}, {"type"=>"x-getting-started", "url"=>"http://developer.constantcontact.com/get-started.html"}, {"type"=>"x-github", "url"=>"https://github.com/constantcontact"}, {"type"=>"x-ios-sdk", "url"=>"https://github.com/constantcontact/ios-sdk"}, {"type"=>"x-issues", "url"=>"http://developer.constantcontact.com/docs/api-issues-and-status/open-issues.html"}, {"type"=>"x-issues-page", "url"=>""}, {"type"=>"x-java-library", "url"=>"https://github.com/constantcontact/java-sdk"}, {"type"=>"x-partners", "url"=>"http://www.constantcontact.com/partners/technology"}, {"type"=>"x-php-library", "url"=>"https://github.com/constantcontact/php-sdk"}, {"type"=>"x-pricing", "url"=>"http://www.constantcontact.com/pricing"}, {"type"=>"x-ruby-library", "url"=>"https://github.com/constantcontact/ruby-sdk"}, {"type"=>"x-selfservice-registration", "url"=>"http://developer.constantcontact.com/api-keys.html"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/constantcontact"}, {"type"=>"x-webhook", "url"=>"http://developer.constantcontact.com/docs/partnerwebhooks/webhooks_index.html"}, {"type"=>"x-website", "url"=>"http://constantcontact.com"}, {"type"=>"x-website", "url"=>"http://developer.constantcontact.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
boston-massachusetts-311{"boston-massachusetts-311-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Boston Massachusetts 311", "x-complete"=>1, "info"=>{"title"=>"Boston Massachusetts 311 GeoReport API", "description"=>"open311-allows-you-to-getpost-civic-information-of-cities-via-a-unified-interface--the-georeport-part-allows-you-to-submit-and-view-issues-at-the-public-local-space", "contact"=>{"name"=>"Open311 community", "url"=>"http://wiki.open311.org/GeoReport_v2/", "email"=>"discuss@lists.open311.org"}, "version"=>"1.0.0"}, "host"=>"mayors24.cityofboston.gov", "basePath"=>"/open311/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/requests.{response_format}"=>{"get"=>{"summary"=>"Requests", "description"=>"Query the current status of multiple requests.", "operationId"=>"query-the-current-status-of-multiple-requests", "x-api-path-slug"=>"requests-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"Latest datetime to include in search"}, {"in"=>"query", "name"=>"No Name"}, {"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON format", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"service_code", "description"=>"Specify the service type by calling the unique ID of the service_code"}, {"in"=>"query", "name"=>"service_request_id", "description"=>"To call multiple Service Requests at once, multiple service_request_id can be declared; comma delimited"}, {"in"=>"query", "name"=>"start_date", "description"=>"Earliest datetime to include in search"}, {"in"=>"query", "name"=>"status", "description"=>"Allows one to search for requests which have a specific status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Requests"]}, "post"=>{"summary"=>"Create Service Request", "description"=>"Submit a new request for with specific details of a single service. Must provide a location via lat/long or address_string or address_id", "operationId"=>"submit-a-new-request-for-with-specific-details-of-a-single-service-must-provide-a-location-via-latlo", "x-api-path-slug"=>"requests-response-format-post", "parameters"=>[{"in"=>"query", "name"=>"address_id"}, {"in"=>"query", "name"=>"address_string"}, {"in"=>"query", "name"=>"attribute", "description"=>"array of key/value responses based on Service Definitions"}, {"in"=>"query", "name"=>"lat", "description"=>"WGS-84 latitude"}, {"in"=>"query", "name"=>"long", "description"=>"WGS-84 longitude"}, {"in"=>"query", "name"=>"No Name"}, {"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON format", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"service_code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Service", "Request"]}}, "/request/{service_request_id}.{response_format}"=>{"get"=>{"summary"=>"Current Status", "description"=>"Query the current status of an individual request", "operationId"=>"query-the-current-status-of-an-individual-request", "x-api-path-slug"=>"requestservice-request-id-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"No Name"}, {"in"=>"path", "name"=>"service_request_id", "description"=>"Is specified in the main URL path rather than an added query string parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Current", "Status"]}}, "/services.{response_format}"=>{"get"=>{"summary"=>"Service Types", "description"=>"List acceptable service request types and their associated service codes. These request types can be unique to the city/jurisdiction.", "operationId"=>"list-acceptable-service-request-types-and-their-associated-service-codes-these-request-types-can-be-", "x-api-path-slug"=>"services-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"No Name"}, {"in"=>"query", "name"=>"response_format", "description"=>"Response in XML or JSON format", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Service", "Types"]}}, "/services/{service_code}.{response_format}"=>{"get"=>{"summary"=>"Definition Of A Service Type", "description"=>"Define attributes associated with a service code. These attributes can be unique to the city/jurisdiction.", "operationId"=>"define-attributes-associated-with-a-service-code-these-attributes-can-be-unique-to-the-cityjurisdict", "x-api-path-slug"=>"servicesservice-code-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"No Name"}, {"in"=>"path", "name"=>"service_code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Definition", "Service", "Type"]}}, "/tokens/{token_id}.{response_format}"=>{"get"=>{"summary"=>"Id Of Service_request Via Token", "description"=>"Get the service_request_id from a temporary token. This is unnecessary if the response from creating a service request does not contain a token.", "operationId"=>"get-the-service-request-id-from-a-temporary-token-this-is-unnecessary-if-the-response-from-creating-", "x-api-path-slug"=>"tokenstoken-id-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"No Name"}, {"in"=>"path", "name"=>"token_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Id", "Service", "Request", "Via", "Token"]}}}}, "apis"=>{"name"=>"Boston Massachusetts 311", "x-slug"=>"boston-massachusetts-311", "description"=>"311 is an easy-to-remember telephone number that connects you with highly-trained Constituent Service Center representatives who are ready to help you with requests for non-emergency City services and information.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/nH93RnFb.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"311,Open311,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"boston-massachusetts-311/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Boston Massachusetts 311", "x-api-slug"=>"boston-massachusetts-311", "description"=>"311 is an easy-to-remember telephone number that connects you with highly-trained Constituent Service Center representatives who are ready to help you with requests for non-emergency City services and information.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/nH93RnFb.png", "humanURL"=>"https://www.cityofboston.gov/311/", "baseURL"=>"https://mayors24.cityofboston.gov//open311/v2/", "tags"=>"311,Open311,Streams,Streams", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/boston-massachusetts-311/boston-massachusetts-311-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-open-311-feed", "url"=>"https://mayors24.cityofboston.gov/open311/v2/services.xml?jurisdiction_id=cityofboston.gov"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/BOS311"}, {"type"=>"x-website", "url"=>"https://www.cityofboston.gov/311/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bitbucket{"bitbucket-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bitbucket", "x-complete"=>1, "info"=>{"title"=>"Bitbucket", "description"=>"code-against-the-bitbucket-api-to-automate-simple-tasks-embed-bitbucket-data-into-your-own-site-build-mobile-or-desktop-apps-or-even-add-custom-ui-addons-into-bitbucket-itself-using-the-connect-framework-", "termsOfService"=>"https://www.atlassian.com/legal/customer-agreement", "contact"=>{"name"=>"Bitbucket Support", "url"=>"https://support.atlassian.com/bitbucket", "email"=>"support@bitbucket.org"}, "version"=>"1.0.0"}, "host"=>"api.bitbucket.org", "basePath"=>"/2.0", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/addon"=>{"delete"=>{"summary"=>"Delete Add On", "description"=>"Delete addon", "operationId"=>"deleteAddon", "x-api-path-slug"=>"addon-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addon"]}, "parameters"=>{"summary"=>"Parameters Add On", "description"=>"Parameters addon", "operationId"=>"parametersAddon", "x-api-path-slug"=>"addon-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addon"]}, "put"=>{"summary"=>"Update Add On", "description"=>"Put addon", "operationId"=>"putAddon", "x-api-path-slug"=>"addon-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addon"]}}, "/addon/linkers"=>{"get"=>{"summary"=>"Get Add On Linkers", "description"=>"Get addon linkers", "operationId"=>"getAddonLinkers", "x-api-path-slug"=>"addonlinkers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addon", "Linkers"]}, "parameters"=>{"summary"=>"Parameters Add On Linkers", "description"=>"Parameters addon linkers", "operationId"=>"parametersAddonLinkers", "x-api-path-slug"=>"addonlinkers-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addon", "Linkers"]}}, "/addon/linkers/{linker_key}"=>{"get"=>{"summary"=>"Get Add On Linkers Linker Key", "description"=>"Get addon linkers linker key", "operationId"=>"getAddonLinkersLinkerKey", "x-api-path-slug"=>"addonlinkerslinker-key-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addon", "Linkers", "Linker", "Key"]}, "parameters"=>{"summary"=>"Parameters Add On Linkers Linker Key", "description"=>"Parameters addon linkers linker key", "operationId"=>"parametersAddonLinkersLinkerKey", "x-api-path-slug"=>"addonlinkerslinker-key-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addon", "Linkers", "Linker", "Key"]}}, "/addon/linkers/{linker_key}/values"=>{"delete"=>{"summary"=>"Delete Add On Linkers Linker Key Values", "description"=>"Delete addon linkers linker key values", "operationId"=>"deleteAddonLinkersLinkerKeyValues", "x-api-path-slug"=>"addonlinkerslinker-keyvalues-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addon", "Linkers", "Linker", "Key", "Values"]}, "get"=>{"summary"=>"Get Add On Linkers Linker Key Values", "description"=>"Get addon linkers linker key values", "operationId"=>"getAddonLinkersLinkerKeyValues", "x-api-path-slug"=>"addonlinkerslinker-keyvalues-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addon", "Linkers", "Linker", "Key", "Values"]}, "parameters"=>{"summary"=>"Parameters Add On Linkers Linker Key Values", "description"=>"Parameters addon linkers linker key values", "operationId"=>"parametersAddonLinkersLinkerKeyValues", "x-api-path-slug"=>"addonlinkerslinker-keyvalues-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addon", "Linkers", "Linker", "Key", "Values"]}, "post"=>{"summary"=>"Add Add On Linkers Linker Key Values", "description"=>"Post addon linkers linker key values", "operationId"=>"postAddonLinkersLinkerKeyValues", "x-api-path-slug"=>"addonlinkerslinker-keyvalues-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addon", "Linkers", "Linker", "Key", "Values"]}, "put"=>{"summary"=>"Update Add On Linkers Linker Key Values", "description"=>"Put addon linkers linker key values", "operationId"=>"putAddonLinkersLinkerKeyValues", "x-api-path-slug"=>"addonlinkerslinker-keyvalues-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addon", "Linkers", "Linker", "Key", "Values"]}}, "/addon/linkers/{linker_key}/values/"=>{"delete"=>{"summary"=>"Delete Add On Linkers Linker Key Values", "description"=>"Delete addon linkers linker key values", "operationId"=>"deleteAddonLinkersLinkerKeyValues", "x-api-path-slug"=>"addonlinkerslinker-keyvalues-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addon", "Linkers", "Linker", "Key", "Values"]}, "get"=>{"summary"=>"Get Add On Linkers Linker Key Values", "description"=>"Get addon linkers linker key values", "operationId"=>"getAddonLinkersLinkerKeyValues", "x-api-path-slug"=>"addonlinkerslinker-keyvalues-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addon", "Linkers", "Linker", "Key", "Values"]}, "parameters"=>{"summary"=>"Parameters Add On Linkers Linker Key Values", "description"=>"Parameters addon linkers linker key values", "operationId"=>"parametersAddonLinkersLinkerKeyValues", "x-api-path-slug"=>"addonlinkerslinker-keyvalues-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addon", "Linkers", "Linker", "Key", "Values"]}}, "/hook_events"=>{"get"=>{"summary"=>"Get Hook Events", "description"=>"Returns the webhook resource or subject types on which webhooks can\nbe registered.\n\nEach resource/subject type contains an `events` link that returns the\npaginated list of specific events each individual subject type can\nemit.\n\nThis endpoint is publicly accessible and does not require\nauthentication or scopes.\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/hook_events\n\n{\n \"repository\": {\n \"links\": {\n \"events\": {\n \"href\": \"https://api.bitbucket.org/2.0/hook_events/repository\"\n }\n }\n },\n \"team\": {\n \"links\": {\n \"events\": {\n \"href\": \"https://api.bitbucket.org/2.0/hook_events/team\"\n }\n }\n },\n \"user\": {\n \"links\": {\n \"events\": {\n \"href\": \"https://api.bitbucket.org/2.0/hook_events/user\"\n }\n }\n }\n}\n```", "operationId"=>"getHookEvents", "x-api-path-slug"=>"hook-events-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hook", "Events"]}, "parameters"=>{"summary"=>"Parameters Hook Events", "description"=>"Parameters hook events", "operationId"=>"parametersHookEvents", "x-api-path-slug"=>"hook-events-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hook", "Events"]}}, "/hook_events/{subject_type}"=>{"get"=>{"summary"=>"Get Hook Events Subject Type", "description"=>"Returns a paginated list of all valid webhook events for the\nspecified entity.\n\nThis is public data that does not require any scopes or authentication.\n\nExample:\n\nNOTE: The following example is a truncated response object for the `team` `subject_type`.\nWe return the same structure for the other `subject_type` objects.\n\n```\n$ curl https://api.bitbucket.org/2.0/hook_events/team\n{\n \"page\": 1,\n \"pagelen\": 30,\n \"size\": 21,\n \"values\": [\n {\n \"category\": \"Repository\",\n \"description\": \"Whenever a repository push occurs\",\n \"event\": \"repo:push\",\n \"label\": \"Push\"\n },\n {\n \"category\": \"Repository\",\n \"description\": \"Whenever a repository fork occurs\",\n \"event\": \"repo:fork\",\n \"label\": \"Fork\"\n },\n ...\n {\n \"category\": \"Repository\",\n \"description\": \"Whenever a repository import occurs\",\n \"event\": \"repo:imported\",\n \"label\": \"Import\"\n }\n ]\n}\n```", "operationId"=>"getHookEventsSubjectType", "x-api-path-slug"=>"hook-eventssubject-type-get", "parameters"=>[{"in"=>"path", "name"=>"subject_type", "description"=>"A resource or subject type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hook", "Events", "Subject", "Type"]}, "parameters"=>{"summary"=>"Parameters Hook Events Subject Type", "description"=>"Parameters hook events subject type", "operationId"=>"parametersHookEventsSubjectType", "x-api-path-slug"=>"hook-eventssubject-type-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hook", "Events", "Subject", "Type"]}}, "/repositories"=>{"get"=>{"summary"=>"Get Repositories", "description"=>"Returns a paginated list of all public repositories.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../meta/filtering) for more details.", "operationId"=>"getRepositories", "x-api-path-slug"=>"repositories-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"Filter the results to include only repositories create on orafter this [ISO-8601](https://en"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories"]}, "parameters"=>{"summary"=>"Parameters Repositories", "description"=>"Parameters repositories", "operationId"=>"parametersRepositories", "x-api-path-slug"=>"repositories-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories"]}}, "/repositories/{username}"=>{"get"=>{"summary"=>"Get Repositories Username", "description"=>"Returns a paginated list of all repositories owned by the specified\naccount or UUID.\n\nThe result can be narrowed down based on the authenticated user's role.\n\nE.g. with `?role=contributor`, only those repositories that the\nauthenticated user has write access to are returned (this includes any\nrepo the user is an admin on, as that implies write access).\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../../meta/filtering) for more details.", "operationId"=>"getRepositoriesUsername", "x-api-path-slug"=>"repositoriesusername-get", "parameters"=>[{"in"=>"query", "name"=>"role", "description"=>"Filters the result based on the authenticated users role on each repository"}, {"in"=>"path", "name"=>"username", "description"=>"This can either be the username or the UUID of the user,surrounded by curly-braces, for example: `{user UUID}`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username"]}, "parameters"=>{"summary"=>"Parameters Repositories Username", "description"=>"Parameters repositories username", "operationId"=>"parametersRepositoriesUsername", "x-api-path-slug"=>"repositoriesusername-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username"]}}, "/repositories/{username}/{repo_slug}"=>{"delete"=>{"summary"=>"Delete Repositories Username Repo Slug", "description"=>"Deletes the repository. This is an irreversible operation.\n\nThis does not affect its forks.", "operationId"=>"deleteRepositoriesUsernameRepoSlug", "x-api-path-slug"=>"repositoriesusernamerepo-slug-delete", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"This can either be the repository slug or the UUID of the repository,surrounded by curly-braces, for example: `{repository UUID}`"}, {"in"=>"path", "name"=>"username", "description"=>"This can either be the username or the UUID of the user,surrounded by curly-braces, for example: `{user UUID}`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug"]}, "get"=>{"summary"=>"Get Repositories Username Repo Slug", "description"=>"Returns the object describing this repository.", "operationId"=>"getRepositoriesUsernameRepoSlug", "x-api-path-slug"=>"repositoriesusernamerepo-slug-get", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"This can either be the repository slug or the UUID of the repository,surrounded by curly-braces, for example: `{repository UUID}`"}, {"in"=>"path", "name"=>"username", "description"=>"This can either be the username or the UUID of the user,surrounded by curly-braces, for example: `{user UUID}`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug", "description"=>"Parameters repositories username repo slug", "operationId"=>"parametersRepositoriesUsernameRepoSlug", "x-api-path-slug"=>"repositoriesusernamerepo-slug-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug", "description"=>"Creates a new repository.\n\nNote: In order to set the project for the newly created repository,\npass in either the project key or the project UUID as part of the\nrequest body as shown in the examples below:\n\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\n \"scm\": \"git\",\n \"project\": {\n \"key\": \"MARS\"\n }\n}' https://api.bitbucket.org/2.0/repositories/teamsinspace/hablanding\n```\n\nor\n\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\n \"scm\": \"git\",\n \"project\": {\n \"key\": \"{ba516952-992a-4c2d-acbd-17d502922f96}\"\n }\n}' https://api.bitbucket.org/2.0/repositories/teamsinspace/hablanding\n```\n\nThe project must only be assigned for repositories belonging to a team.\nIf the repository owner is a team and the project is not provided, the\nrepository is automatically assigned to the oldest project in the team.\n\nNote: In the examples above, the username `teamsinspace`,\nand/or the repository name `hablanding` can be replaced by UUIDs.", "operationId"=>"postRepositoriesUsernameRepoSlug", "x-api-path-slug"=>"repositoriesusernamerepo-slug-post", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"This can either be the repository slug or the UUID of the repository,surrounded by curly-braces, for example: `{repository UUID}`"}, {"in"=>"path", "name"=>"username", "description"=>"This can either be the username or the UUID of the user,surrounded by curly-braces, for example: `{user UUID}`"}, {"in"=>"body", "name"=>"_body", "description"=>"The repository that is to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug"]}, "put"=>{"summary"=>"Update Repositories Username Repo Slug", "description"=>"Since this endpoint can be used to both update and to create a\nrepository, the request body depends on the intent.\n\n### Creation\n\nSee the POST documentation for the repository endpoint for an example\nof the request body.\n\n### Update\n\nNote: Changing the `name` of the repository will cause the location to\nbe changed. This is because the URL of the repo is derived from the\nname (a process called slugification). In such a scenario, it is\npossible for the request to fail if the newly created slug conflicts\nwith an existing repository's slug. But if there is no conflict,\nthe new location will be returned in the `Location` header of the\nresponse.", "operationId"=>"putRepositoriesUsernameRepoSlug", "x-api-path-slug"=>"repositoriesusernamerepo-slug-put", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"This can either be the repository slug or the UUID of the repository,surrounded by curly-braces, for example: `{repository UUID}`"}, {"in"=>"path", "name"=>"username", "description"=>"This can either be the username or the UUID of the user,surrounded by curly-braces, for example: `{user UUID}`"}, {"in"=>"body", "name"=>"_body", "description"=>"The repository that is to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug"]}}, "/repositories/{username}/{repo_slug}/branch-restrictions"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Branch Restrictions", "description"=>"Returns a paginated list of all branch restrictions on the\nrepository.", "operationId"=>"getRepositoriesUsernameRepoSlugBranchRestrictions", "x-api-path-slug"=>"repositoriesusernamerepo-slugbranchrestrictions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Branch", "Restrictions"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Branch Restrictions", "description"=>"Parameters repositories username repo slug branch restrictions", "operationId"=>"parametersRepositoriesUsernameRepoSlugBranchRestrictions", "x-api-path-slug"=>"repositoriesusernamerepo-slugbranchrestrictions-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Branch", "Restrictions"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Branch Restrictions", "description"=>"Creates a new branch restriction rule for a repository.\n\n`kind` describes what will be restricted. Allowed values are: `push`,\n`force`, `delete`, and `restrict_merges`.\n\nDifferent kinds of branch restrictions have different requirements:\n\n* `push` and `restrict_merges` require `users` and `groups` to be\n specified. Empty lists are allowed, in which case permission is\n denied for everybody.\n* `force` can not be specified in a Mercurial repository.\n\n`pattern` is used to determine which branches will be restricted.\n\nA `'*'` in `pattern` will expand to match zero or more characters, and\nevery other character matches itself. For example, `'foo*'` will match\n`'foo'` and `'foobar'`, but not `'barfoo'`. `'*'` will match all\nbranches.\n\n`users` and `groups` are lists of user names and group names.\n\n`kind` and `pattern` must be unique within a repository; adding new\nusers or groups to an existing restriction should be done via `PUT`.\n\nNote that branch restrictions with overlapping patterns are allowed,\nbut the resulting behavior may be surprising.", "operationId"=>"postRepositoriesUsernameRepoSlugBranchRestrictions", "x-api-path-slug"=>"repositoriesusernamerepo-slugbranchrestrictions-post", "parameters"=>[{"in"=>"body", "name"=>"_body", "description"=>"The new rule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Branch", "Restrictions"]}}, "/repositories/{username}/{repo_slug}/branch-restrictions/{id}"=>{"delete"=>{"summary"=>"Delete Repositories Username Repo Slug Branch Restrictions", "description"=>"Delete repositories username repo slug branch restrictions", "operationId"=>"deleteRepositoriesUsernameRepoSlugBranchRestrictions", "x-api-path-slug"=>"repositoriesusernamerepo-slugbranchrestrictionsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The restriction rules id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Branch", "Restrictions"]}, "get"=>{"summary"=>"Get Repositories Username Repo Slug Branch Restrictions", "description"=>"Get repositories username repo slug branch restrictions", "operationId"=>"getRepositoriesUsernameRepoSlugBranchRestrictions", "x-api-path-slug"=>"repositoriesusernamerepo-slugbranchrestrictionsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The restriction rules id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Branch", "Restrictions"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Branch Restrictions", "description"=>"Parameters repositories username repo slug branch restrictions", "operationId"=>"parametersRepositoriesUsernameRepoSlugBranchRestrictions", "x-api-path-slug"=>"repositoriesusernamerepo-slugbranchrestrictionsid-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Branch", "Restrictions"]}, "put"=>{"summary"=>"Update Repositories Username Repo Slug Branch Restrictions", "description"=>"Updates an existing branch restriction rule.\n\nFields not present in the request body are ignored.\n\nSee [`POST`](../../branch-restrictions#post) for details.", "operationId"=>"putRepositoriesUsernameRepoSlugBranchRestrictions", "x-api-path-slug"=>"repositoriesusernamerepo-slugbranchrestrictionsid-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The restriction rules id"}, {"in"=>"body", "name"=>"_body", "description"=>"The new version of the existing rule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Branch", "Restrictions"]}}, "/repositories/{username}/{repo_slug}/commit/{node}/approve"=>{"delete"=>{"summary"=>"Delete Repositories Username Repo Slug Commit Node Approve", "description"=>"Redact the authenticated user's approval of the specified commit.\n\nThis operation is only available to users that have explicit access to\nthe repository. In contrast, just the fact that a repository is\npublicly accessible to users does not give them the ability to approve\ncommits.", "operationId"=>"deleteRepositoriesUsernameRepoSlugCommitNodeApprove", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitnodeapprove-delete", "parameters"=>[{"in"=>"path", "name"=>"node", "description"=>"The commits SHA1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commit", "Node", "Approve"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Commit Node Approve", "description"=>"Parameters repositories username repo slug commit node approve", "operationId"=>"parametersRepositoriesUsernameRepoSlugCommitNodeApprove", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitnodeapprove-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commit", "Node", "Approve"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Commit Node Approve", "description"=>"Approve the specified commit as the authenticated user.\n\nThis operation is only available to users that have explicit access to\nthe repository. In contrast, just the fact that a repository is\npublicly accessible to users does not give them the ability to approve\ncommits.", "operationId"=>"postRepositoriesUsernameRepoSlugCommitNodeApprove", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitnodeapprove-post", "parameters"=>[{"in"=>"path", "name"=>"node", "description"=>"The commits SHA1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commit", "Node", "Approve"]}}, "/repositories/{username}/{repo_slug}/commit/{node}/statuses"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Commit Node Statuses", "description"=>"Returns all statuses (e.g. build results) for a specific commit.", "operationId"=>"getRepositoriesUsernameRepoSlugCommitNodeStatuses", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitnodestatuses-get", "parameters"=>[{"in"=>"path", "name"=>"node", "description"=>"The commits SHA1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commit", "Node", "Statuses"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Commit Node Statuses", "description"=>"Parameters repositories username repo slug commit node statuses", "operationId"=>"parametersRepositoriesUsernameRepoSlugCommitNodeStatuses", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitnodestatuses-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commit", "Node", "Statuses"]}}, "/repositories/{username}/{repo_slug}/commit/{node}/statuses/build"=>{"parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Commit Node Statuses Build", "description"=>"Parameters repositories username repo slug commit node statuses build", "operationId"=>"parametersRepositoriesUsernameRepoSlugCommitNodeStatusesBuild", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitnodestatusesbuild-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commit", "Node", "Statuses", "Build"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Commit Node Statuses Build", "description"=>"Creates a new build status against the specified commit.\n\nIf the specified key already exists, the existing status object will\nbe overwritten.\n\nWhen creating a new commit status, you can use a URI template for the URL.\nTemplates are URLs that contain variable names that Bitbucket will\nevaluate at runtime whenever the URL is displayed anywhere similar to\nparameter substitution in\n[Bitbucket Connect](https://developer.atlassian.com/bitbucket/concepts/context-parameters.html).\nFor example, one could use `https://foo.com/builds/{repository.full_name}`\nwhich Bitbucket will turn into `https://foo.com/builds/foo/bar` at render time.\nThe context variables available are `repository` and `commit`.", "operationId"=>"postRepositoriesUsernameRepoSlugCommitNodeStatusesBuild", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitnodestatusesbuild-post", "parameters"=>[{"in"=>"path", "name"=>"node", "description"=>"The commits SHA1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commit", "Node", "Statuses", "Build"]}}, "/repositories/{username}/{repo_slug}/commit/{node}/statuses/build/{key}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Commit Node Statuses Build Key", "description"=>"Get repositories username repo slug commit node statuses build key", "operationId"=>"getRepositoriesUsernameRepoSlugCommitNodeStatusesBuildKey", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitnodestatusesbuildkey-get", "parameters"=>[{"in"=>"path", "name"=>"key", "description"=>"The build status unique key"}, {"in"=>"path", "name"=>"node", "description"=>"The commits SHA1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commit", "Node", "Statuses", "Build", "Key"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Commit Node Statuses Build Key", "description"=>"Parameters repositories username repo slug commit node statuses build key", "operationId"=>"parametersRepositoriesUsernameRepoSlugCommitNodeStatusesBuildKey", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitnodestatusesbuildkey-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commit", "Node", "Statuses", "Build", "Key"]}, "put"=>{"summary"=>"Update Repositories Username Repo Slug Commit Node Statuses Build Key", "description"=>"Used to update the current status of a build status object on the\nspecific commit.\n\nThis operation can also be used to change other properties of the\nbuild status:\n\n* `state`\n* `name`\n* `description`\n* `url`\n* `refname`\n\nThe `key` cannot be changed.", "operationId"=>"putRepositoriesUsernameRepoSlugCommitNodeStatusesBuildKey", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitnodestatusesbuildkey-put", "parameters"=>[{"in"=>"path", "name"=>"key", "description"=>"The commit status unique key"}, {"in"=>"path", "name"=>"node", "description"=>"The commits SHA1"}, {"in"=>"body", "name"=>"_body", "description"=>"The updated build status object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commit", "Node", "Statuses", "Build", "Key"]}}, "/repositories/{username}/{repo_slug}/commit/{revision}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Commit Revision", "description"=>"Get repositories username repo slug commit revision", "operationId"=>"getRepositoriesUsernameRepoSlugCommitRevision", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitrevision-get", "parameters"=>[{"in"=>"path", "name"=>"revision", "description"=>"The commits SHA1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commit", "Revision"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Commit Revision", "description"=>"Parameters repositories username repo slug commit revision", "operationId"=>"parametersRepositoriesUsernameRepoSlugCommitRevision", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitrevision-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commit", "Revision"]}}, "/repositories/{username}/{repo_slug}/commit/{sha}/comments"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Commit Sha Comments", "description"=>"Returns the commit's comments.\n\nThis includes both global and inline comments.\n\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.", "operationId"=>"getRepositoriesUsernameRepoSlugCommitShaComments", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitshacomments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commit", "Sha", "Comments"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Commit Sha Comments", "description"=>"Parameters repositories username repo slug commit sha comments", "operationId"=>"parametersRepositoriesUsernameRepoSlugCommitShaComments", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitshacomments-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commit", "Sha", "Comments"]}}, "/repositories/{username}/{repo_slug}/commit/{sha}/comments/{comment_id}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Commit Sha Comments Comment", "description"=>"Get repositories username repo slug commit sha comments comment", "operationId"=>"getRepositoriesUsernameRepoSlugCommitShaCommentsComment", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitshacommentscomment-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commit", "Sha", "Comments", "Comment"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Commit Sha Comments Comment", "description"=>"Parameters repositories username repo slug commit sha comments comment", "operationId"=>"parametersRepositoriesUsernameRepoSlugCommitShaCommentsComment", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitshacommentscomment-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commit", "Sha", "Comments", "Comment"]}}, "/repositories/{username}/{repo_slug}/commits"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Commits", "description"=>"These are the repository's commits. They are paginated and returned\nin reverse chronological order, similar to the output of `git log` and\n`hg log`. Like these tools, the DAG can be filtered.\n\n## GET /repositories/{username}/{repo_slug}/commits/\n\nReturns all commits in the repo in topological order (newest commit\nfirst). All branches and tags are included (similar to\n`git log --all` and `hg log`).\n\n## GET /repositories/{username}/{repo_slug}/commits/master\n\nReturns all commits on rev `master` (similar to `git log master`,\n`hg log master`).\n\n## GET /repositories/{username}/{repo_slug}/commits/dev?exclude=master\n\nReturns all commits on ref `dev`, except those that are reachable on\n`master` (similar to `git log dev ^master`).\n\n## GET /repositories/{username}/{repo_slug}/commits/?exclude=master\n\nReturns all commits in the repo that are not on master\n(similar to `git log --all ^master`).\n\n## GET /repositories/{username}/{repo_slug}/commits/?include=foo&include=bar&exclude=fu&exclude=fubar\n\nReturns all commits that are on refs `foo` or `bar`, but not on `fu` or\n`fubar` (similar to `git log foo bar ^fu ^fubar`).\n\nBecause the response could include a very large number of commits, it\nis paginated. Follow the 'next' link in the response to navigate to the\nnext page of commits. As with other paginated resources, do not\nconstruct your own links.\n\nWhen the include and exclude parameters are more than can fit in a\nquery string, clients can use a `x-www-form-urlencoded` POST instead.", "operationId"=>"getRepositoriesUsernameRepoSlugCommits", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommits-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commits"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Commits", "description"=>"Parameters repositories username repo slug commits", "operationId"=>"parametersRepositoriesUsernameRepoSlugCommits", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommits-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commits"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Commits", "description"=>"Identical to `GET /repositories/{username}/{repo_slug}/commits`,\nexcept that POST allows clients to place the include and exclude\nparameters in the request body to avoid URL length issues.\n\n**Note that this resource does NOT support new commit creation.**", "operationId"=>"postRepositoriesUsernameRepoSlugCommits", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommits-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commits"]}}, "/repositories/{username}/{repo_slug}/commits/{revision}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Commits Revision", "description"=>"These are the repository's commits. They are paginated and returned\nin reverse chronological order, similar to the output of `git log` and\n`hg log`. Like these tools, the DAG can be filtered.\n\n## GET /repositories/{username}/{repo_slug}/commits/\n\nReturns all commits in the repo in topological order (newest commit\nfirst). All branches and tags are included (similar to\n`git log --all` and `hg log`).\n\n## GET /repositories/{username}/{repo_slug}/commits/master\n\nReturns all commits on rev `master` (similar to `git log master`,\n`hg log master`).\n\n## GET /repositories/{username}/{repo_slug}/commits/dev?exclude=master\n\nReturns all commits on ref `dev`, except those that are reachable on\n`master` (similar to `git log dev ^master`).\n\n## GET /repositories/{username}/{repo_slug}/commits/?exclude=master\n\nReturns all commits in the repo that are not on master\n(similar to `git log --all ^master`).\n\n## GET /repositories/{username}/{repo_slug}/commits/?include=foo&include=bar&exclude=fu&exclude=fubar\n\nReturns all commits that are on refs `foo` or `bar`, but not on `fu` or\n`fubar` (similar to `git log foo bar ^fu ^fubar`).\n\nBecause the response could include a very large number of commits, it\nis paginated. Follow the 'next' link in the response to navigate to the\nnext page of commits. As with other paginated resources, do not\nconstruct your own links.\n\nWhen the include and exclude parameters are more than can fit in a\nquery string, clients can use a `x-www-form-urlencoded` POST instead.", "operationId"=>"getRepositoriesUsernameRepoSlugCommitsRevision", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitsrevision-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commits", "Revision"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Commits Revision", "description"=>"Parameters repositories username repo slug commits revision", "operationId"=>"parametersRepositoriesUsernameRepoSlugCommitsRevision", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitsrevision-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commits", "Revision"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Commits Revision", "description"=>"Identical to `GET /repositories/{username}/{repo_slug}/commits`,\nexcept that POST allows clients to place the include and exclude\nparameters in the request body to avoid URL length issues.\n\n**Note that this resource does NOT support new commit creation.**", "operationId"=>"postRepositoriesUsernameRepoSlugCommitsRevision", "x-api-path-slug"=>"repositoriesusernamerepo-slugcommitsrevision-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Commits", "Revision"]}}, "/repositories/{username}/{repo_slug}/components"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Components", "description"=>"Returns the components that have been defined in the issue tracker.\n\nThis resource is only available on repositories that have the issue\ntracker enabled.", "operationId"=>"getRepositoriesUsernameRepoSlugComponents", "x-api-path-slug"=>"repositoriesusernamerepo-slugcomponents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Components"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Components", "description"=>"Parameters repositories username repo slug components", "operationId"=>"parametersRepositoriesUsernameRepoSlugComponents", "x-api-path-slug"=>"repositoriesusernamerepo-slugcomponents-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Components"]}}, "/repositories/{username}/{repo_slug}/components/{component_id}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Components Component", "description"=>"Get repositories username repo slug components component", "operationId"=>"getRepositoriesUsernameRepoSlugComponentsComponent", "x-api-path-slug"=>"repositoriesusernamerepo-slugcomponentscomponent-id-get", "parameters"=>[{"in"=>"path", "name"=>"component_id", "description"=>"The components id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Components", "Component"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Components Component", "description"=>"Parameters repositories username repo slug components component", "operationId"=>"parametersRepositoriesUsernameRepoSlugComponentsComponent", "x-api-path-slug"=>"repositoriesusernamerepo-slugcomponentscomponent-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Components", "Component"]}}, "/repositories/{username}/{repo_slug}/default-reviewers"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Default Reviewers", "description"=>"Returns the repository's default reviewers.\n\nThese are the users that are automatically added as reviewers on every\nnew pull request that is created.", "operationId"=>"getRepositoriesUsernameRepoSlugDefaultReviewers", "x-api-path-slug"=>"repositoriesusernamerepo-slugdefaultreviewers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Default", "Reviewers"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Default Reviewers", "description"=>"Parameters repositories username repo slug default reviewers", "operationId"=>"parametersRepositoriesUsernameRepoSlugDefaultReviewers", "x-api-path-slug"=>"repositoriesusernamerepo-slugdefaultreviewers-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Default", "Reviewers"]}}, "/repositories/{username}/{repo_slug}/default-reviewers/{target_username}"=>{"delete"=>{"summary"=>"Delete Repositories Username Repo Slug Default Reviewers Target Username", "description"=>"Delete repositories username repo slug default reviewers target username", "operationId"=>"deleteRepositoriesUsernameRepoSlugDefaultReviewersTargetUsername", "x-api-path-slug"=>"repositoriesusernamerepo-slugdefaultreviewerstarget-username-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Default", "Reviewers", "Target", "Username"]}, "get"=>{"summary"=>"Get Repositories Username Repo Slug Default Reviewers Target Username", "description"=>"Returns the specified reviewer.\n\nThis can be used to test whether a user is among the repository's\ndefault reviewers list. A 404 indicates that that specified user is not\na default reviewer.", "operationId"=>"getRepositoriesUsernameRepoSlugDefaultReviewersTargetUsername", "x-api-path-slug"=>"repositoriesusernamerepo-slugdefaultreviewerstarget-username-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Default", "Reviewers", "Target", "Username"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Default Reviewers Target Username", "description"=>"Parameters repositories username repo slug default reviewers target username", "operationId"=>"parametersRepositoriesUsernameRepoSlugDefaultReviewersTargetUsername", "x-api-path-slug"=>"repositoriesusernamerepo-slugdefaultreviewerstarget-username-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Default", "Reviewers", "Target", "Username"]}, "put"=>{"summary"=>"Update Repositories Username Repo Slug Default Reviewers Target Username", "description"=>"Adds the specified user to the repository's list of default\nreviewers.\n\nThis method is idempotent. Adding a user a second time has no effect.", "operationId"=>"putRepositoriesUsernameRepoSlugDefaultReviewersTargetUsername", "x-api-path-slug"=>"repositoriesusernamerepo-slugdefaultreviewerstarget-username-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Default", "Reviewers", "Target", "Username"]}}, "/repositories/{username}/{repo_slug}/diff/{spec}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Diff Spec", "description"=>"Produces a raw, git-style diff for either a single commit (diffed\nagainst its first parent), or a revspec of 2 commits (e.g.\n`3a8b42..9ff173` where the first commit represents the source and the\nsecond commit the destination).\n\nIn case of the latter (diffing a revspec), a 3-way diff, or merge diff,\nis computed. This shows the changes introduced by the left branch\n(`3a8b42` in our example) as compared againt the right branch\n(`9ff173`).\n\nThis is equivalent to merging the left branch into the right branch and\nthen computing the diff of the merge commit against its first parent\n(the right branch). This follows the same behavior as pull requests\nthat also show this style of 3-way, or merge diff.\n\nWhile similar to patches, diffs:\n\n* Don't have a commit header (username, commit message, etc)\n* Support the optional `path=foo/bar.py` query param to filter\n the diff to just that one file diff\n\nThe raw diff is returned as-is, in whatever encoding the files in the\nrepository use. It is not decoded into unicode. As such, the\ncontent-type is `text/plain`.", "operationId"=>"getRepositoriesUsernameRepoSlugDiffSpec", "x-api-path-slug"=>"repositoriesusernamerepo-slugdiffspec-get", "parameters"=>[{"in"=>"query", "name"=>"context", "description"=>"Generate diffs with lines of context instead of the usual three"}, {"in"=>"query", "name"=>"path", "description"=>"Limit the diff to a single file"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Diff", "Spec"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Diff Spec", "description"=>"Parameters repositories username repo slug diff spec", "operationId"=>"parametersRepositoriesUsernameRepoSlugDiffSpec", "x-api-path-slug"=>"repositoriesusernamerepo-slugdiffspec-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Diff", "Spec"]}}, "/repositories/{username}/{repo_slug}/downloads"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Downloads", "description"=>"Returns a list of download links associated with the repository.", "operationId"=>"getRepositoriesUsernameRepoSlugDownloads", "x-api-path-slug"=>"repositoriesusernamerepo-slugdownloads-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Downloads"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Downloads", "description"=>"Parameters repositories username repo slug downloads", "operationId"=>"parametersRepositoriesUsernameRepoSlugDownloads", "x-api-path-slug"=>"repositoriesusernamerepo-slugdownloads-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Downloads"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Downloads", "description"=>"Upload new download artifacts.\n\nTo upload files, perform a `multipart/form-data` POST containing one\nor more `files` fields:\n\n $ echo Hello World > hello.txt\n $ curl -s -u evzijst -X POST https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads -F files=@hello.txt\n\nWhen a file is uploaded with the same name as an existing artifact,\nthen the existing file will be replaced.", "operationId"=>"postRepositoriesUsernameRepoSlugDownloads", "x-api-path-slug"=>"repositoriesusernamerepo-slugdownloads-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Downloads"]}}, "/repositories/{username}/{repo_slug}/downloads/{filename}"=>{"delete"=>{"summary"=>"Delete Repositories Username Repo Slug Downloads Filename", "description"=>"Deletes the specified download artifact from the repository.", "operationId"=>"deleteRepositoriesUsernameRepoSlugDownloadsFilename", "x-api-path-slug"=>"repositoriesusernamerepo-slugdownloadsfilename-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Downloads", "Filename"]}, "get"=>{"summary"=>"Get Repositories Username Repo Slug Downloads Filename", "description"=>"Return a redirect to the contents of a download artifact.\n\nThis endpoint returns the actual file contents and not the artifact's\nmetadata.\n\n $ curl -s -L https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads/hello.txt\n Hello World", "operationId"=>"getRepositoriesUsernameRepoSlugDownloadsFilename", "x-api-path-slug"=>"repositoriesusernamerepo-slugdownloadsfilename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Downloads", "Filename"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Downloads Filename", "description"=>"Parameters repositories username repo slug downloads filename", "operationId"=>"parametersRepositoriesUsernameRepoSlugDownloadsFilename", "x-api-path-slug"=>"repositoriesusernamerepo-slugdownloadsfilename-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Downloads", "Filename"]}}, "/repositories/{username}/{repo_slug}/forks"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Forks", "description"=>"Returns a paginated list of all the forks of the specified\nrepository.", "operationId"=>"getRepositoriesUsernameRepoSlugForks", "x-api-path-slug"=>"repositoriesusernamerepo-slugforks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Forks"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Forks", "description"=>"Parameters repositories username repo slug forks", "operationId"=>"parametersRepositoriesUsernameRepoSlugForks", "x-api-path-slug"=>"repositoriesusernamerepo-slugforks-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Forks"]}}, "/repositories/{username}/{repo_slug}/hooks"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Hooks", "description"=>"Returns a paginated list of webhooks installed on this repository.", "operationId"=>"getRepositoriesUsernameRepoSlugHooks", "x-api-path-slug"=>"repositoriesusernamerepo-slughooks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Hooks"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Hooks", "description"=>"Parameters repositories username repo slug hooks", "operationId"=>"parametersRepositoriesUsernameRepoSlugHooks", "x-api-path-slug"=>"repositoriesusernamerepo-slughooks-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Hooks"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Hooks", "description"=>"Creates a new webhook on the specified repository.\n\nExample:\n\n```\n$ curl -X POST -u credentials -H 'Content-Type: application/json' https://api.bitbucket.org/2.0/repositories/username/slug/hooks -d '\n {\n \"description\": \"Webhook Description\",\n \"url\": \"https://example.com/\",\n \"active\": true,\n \"events\": [\n \"repo:push\",\n \"issue:created\",\n \"issue:updated\"\n ]\n }'\n```\n\nNote that this call requires the webhook scope, as well as any scope\nthat applies to the events that the webhook subscribes to. In the\nexample above that means: `webhook`, `repository` and `issue`.\n\nAlso note that the `url` must properly resolve and cannot be an\ninternal, non-routed address.", "operationId"=>"postRepositoriesUsernameRepoSlugHooks", "x-api-path-slug"=>"repositoriesusernamerepo-slughooks-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Hooks"]}}, "/repositories/{username}/{repo_slug}/hooks/{uid}"=>{"delete"=>{"summary"=>"Delete Repositories Username Repo Slug Hooks U", "description"=>"Deletes the specified webhook subscription from the given\nrepository.", "operationId"=>"deleteRepositoriesUsernameRepoSlugHooksU", "x-api-path-slug"=>"repositoriesusernamerepo-slughooksuid-delete", "parameters"=>[{"in"=>"path", "name"=>"uid", "description"=>"The installed webhooks id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Hooks", "U"]}, "get"=>{"summary"=>"Get Repositories Username Repo Slug Hooks U", "description"=>"Returns the webhook with the specified id installed on the specified\nrepository.", "operationId"=>"getRepositoriesUsernameRepoSlugHooksU", "x-api-path-slug"=>"repositoriesusernamerepo-slughooksuid-get", "parameters"=>[{"in"=>"path", "name"=>"uid", "description"=>"The installed webhooks id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Hooks", "U"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Hooks U", "description"=>"Parameters repositories username repo slug hooks u", "operationId"=>"parametersRepositoriesUsernameRepoSlugHooksU", "x-api-path-slug"=>"repositoriesusernamerepo-slughooksuid-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Hooks", "U"]}, "put"=>{"summary"=>"Update Repositories Username Repo Slug Hooks U", "description"=>"Updates the specified webhook subscription.\n\nThe following properties can be mutated:\n\n* `description`\n* `url`\n* `active`\n* `events`", "operationId"=>"putRepositoriesUsernameRepoSlugHooksU", "x-api-path-slug"=>"repositoriesusernamerepo-slughooksuid-put", "parameters"=>[{"in"=>"path", "name"=>"uid", "description"=>"The installed webhooks id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Hooks", "U"]}}, "/repositories/{username}/{repo_slug}/issues"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Issues", "description"=>"Get repositories username repo slug issues", "operationId"=>"getRepositoriesUsernameRepoSlugIssues", "x-api-path-slug"=>"repositoriesusernamerepo-slugissues-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Issues", "description"=>"Parameters repositories username repo slug issues", "operationId"=>"parametersRepositoriesUsernameRepoSlugIssues", "x-api-path-slug"=>"repositoriesusernamerepo-slugissues-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Issues", "description"=>"Creates a new issue.\n\nThis call requires authentication. Private repositories or private\nissue trackers require the caller to authenticate with an account that\nhas appropriate authorisation.\n\nThe authenticated user is used for the issue's `reporter` field.", "operationId"=>"postRepositoriesUsernameRepoSlugIssues", "x-api-path-slug"=>"repositoriesusernamerepo-slugissues-post", "parameters"=>[{"in"=>"body", "name"=>"_body", "description"=>"The new issue", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues"]}}, "/repositories/{username}/{repo_slug}/issues/{issue_id}"=>{"delete"=>{"summary"=>"Delete Repositories Username Repo Slug Issues Issue", "description"=>"Deletes the specified issue. This requires write access to the\nrepository.", "operationId"=>"deleteRepositoriesUsernameRepoSlugIssuesIssue", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue"]}, "get"=>{"summary"=>"Get Repositories Username Repo Slug Issues Issue", "description"=>"Get repositories username repo slug issues issue", "operationId"=>"getRepositoriesUsernameRepoSlugIssuesIssue", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Issues Issue", "description"=>"Parameters repositories username repo slug issues issue", "operationId"=>"parametersRepositoriesUsernameRepoSlugIssuesIssue", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue"]}}, "/repositories/{username}/{repo_slug}/issues/{issue_id}/attachments"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Issues Issue Attachments", "description"=>"Returns all attachments for this issue.\n\nThis returns the files' meta data. This does not return the files'\nactual contents.\n\nThe files are always ordered by their upload date.", "operationId"=>"getRepositoriesUsernameRepoSlugIssuesIssueAttachments", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idattachments-get", "parameters"=>[{"in"=>"path", "name"=>"issue_id", "description"=>"The issues id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Attachments"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Issues Issue Attachments", "description"=>"Parameters repositories username repo slug issues issue attachments", "operationId"=>"parametersRepositoriesUsernameRepoSlugIssuesIssueAttachments", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idattachments-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Attachments"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Issues Issue Attachments", "description"=>"Upload new issue attachments.\n\nTo upload files, perform a `multipart/form-data` POST containing one\nor more file fields.\n\nWhen a file is uploaded with the same name as an existing attachment,\nthen the existing file will be replaced.", "operationId"=>"postRepositoriesUsernameRepoSlugIssuesIssueAttachments", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idattachments-post", "parameters"=>[{"in"=>"path", "name"=>"issue_id", "description"=>"The issues id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Attachments"]}}, "/repositories/{username}/{repo_slug}/issues/{issue_id}/attachments/{path}"=>{"delete"=>{"summary"=>"Delete Repositories Username Repo Slug Issues Issue Attachments Path", "description"=>"Delete repositories username repo slug issues issue attachments path", "operationId"=>"deleteRepositoriesUsernameRepoSlugIssuesIssueAttachmentsPath", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idattachmentspath-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Attachments", "Path"]}, "get"=>{"summary"=>"Get Repositories Username Repo Slug Issues Issue Attachments Path", "description"=>"Returns the contents of the specified file attachment.\n\nNote that this endpoint does not return a JSON response, but instead\nreturns a redirect pointing to the actual file that in turn will return\nthe raw contents.\n\nThe redirect URL contains a one-time token that has a limited lifetime.\nAs a result, the link should not be persisted, stored, or shared.", "operationId"=>"getRepositoriesUsernameRepoSlugIssuesIssueAttachmentsPath", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idattachmentspath-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Attachments", "Path"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Issues Issue Attachments Path", "description"=>"Parameters repositories username repo slug issues issue attachments path", "operationId"=>"parametersRepositoriesUsernameRepoSlugIssuesIssueAttachmentsPath", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idattachmentspath-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Attachments", "Path"]}}, "/repositories/{username}/{repo_slug}/issues/{issue_id}/comments"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Issues Issue Comments", "description"=>"Returns all comments that were made on the specified issue.\n\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.", "operationId"=>"getRepositoriesUsernameRepoSlugIssuesIssueComments", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idcomments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Comments"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Issues Issue Comments", "description"=>"Parameters repositories username repo slug issues issue comments", "operationId"=>"parametersRepositoriesUsernameRepoSlugIssuesIssueComments", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idcomments-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Comments"]}}, "/repositories/{username}/{repo_slug}/issues/{issue_id}/comments/{comment_id}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Issues Issue Comments Comment", "description"=>"Get repositories username repo slug issues issue comments comment", "operationId"=>"getRepositoriesUsernameRepoSlugIssuesIssueCommentsComment", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idcommentscomment-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Comments", "Comment"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Issues Issue Comments Comment", "description"=>"Parameters repositories username repo slug issues issue comments comment", "operationId"=>"parametersRepositoriesUsernameRepoSlugIssuesIssueCommentsComment", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idcommentscomment-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Comments", "Comment"]}}, "/repositories/{username}/{repo_slug}/issues/{issue_id}/vote"=>{"delete"=>{"summary"=>"Delete Repositories Username Repo Slug Issues Issue Vote", "description"=>"Delete repositories username repo slug issues issue vote", "operationId"=>"deleteRepositoriesUsernameRepoSlugIssuesIssueVote", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idvote-delete", "parameters"=>[{"in"=>"path", "name"=>"issue_id", "description"=>"The issues id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Vote"]}, "get"=>{"summary"=>"Get Repositories Username Repo Slug Issues Issue Vote", "description"=>"Check whether the authenticated user has voted for this issue.\nA 204 status code indicates that the user has voted, while a 404\nimplies they haven't.", "operationId"=>"getRepositoriesUsernameRepoSlugIssuesIssueVote", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idvote-get", "parameters"=>[{"in"=>"path", "name"=>"issue_id", "description"=>"The issues id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Vote"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Issues Issue Vote", "description"=>"Parameters repositories username repo slug issues issue vote", "operationId"=>"parametersRepositoriesUsernameRepoSlugIssuesIssueVote", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idvote-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Vote"]}, "put"=>{"summary"=>"Update Repositories Username Repo Slug Issues Issue Vote", "description"=>"Vote for this issue.\n\nTo cast your vote, do an empty PUT. The 204 status code indicates that\nthe operation was successful.", "operationId"=>"putRepositoriesUsernameRepoSlugIssuesIssueVote", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idvote-put", "parameters"=>[{"in"=>"path", "name"=>"issue_id", "description"=>"The issues id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Vote"]}}, "/repositories/{username}/{repo_slug}/issues/{issue_id}/watch"=>{"delete"=>{"summary"=>"Delete Repositories Username Repo Slug Issues Issue Watch", "description"=>"Delete repositories username repo slug issues issue watch", "operationId"=>"deleteRepositoriesUsernameRepoSlugIssuesIssueWatch", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idwatch-delete", "parameters"=>[{"in"=>"path", "name"=>"issue_id", "description"=>"The issues id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Watch"]}, "get"=>{"summary"=>"Get Repositories Username Repo Slug Issues Issue Watch", "description"=>"Indicated whether or not the authenticated user is watching this\nissue.", "operationId"=>"getRepositoriesUsernameRepoSlugIssuesIssueWatch", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idwatch-get", "parameters"=>[{"in"=>"path", "name"=>"issue_id", "description"=>"The issues id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Watch"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Issues Issue Watch", "description"=>"Parameters repositories username repo slug issues issue watch", "operationId"=>"parametersRepositoriesUsernameRepoSlugIssuesIssueWatch", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idwatch-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Watch"]}, "put"=>{"summary"=>"Update Repositories Username Repo Slug Issues Issue Watch", "description"=>"Start watching this issue.\n\nTo start watching this issue, do an empty PUT. The 204 status code\nindicates that the operation was successful.", "operationId"=>"putRepositoriesUsernameRepoSlugIssuesIssueWatch", "x-api-path-slug"=>"repositoriesusernamerepo-slugissuesissue-idwatch-put", "parameters"=>[{"in"=>"path", "name"=>"issue_id", "description"=>"The issues id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Issues", "Issue", "", "Watch"]}}, "/repositories/{username}/{repo_slug}/milestones"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Milestones", "description"=>"Returns the milestones that have been defined in the issue tracker.\n\nThis resource is only available on repositories that have the issue\ntracker enabled.", "operationId"=>"getRepositoriesUsernameRepoSlugMilestones", "x-api-path-slug"=>"repositoriesusernamerepo-slugmilestones-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Milestones"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Milestones", "description"=>"Parameters repositories username repo slug milestones", "operationId"=>"parametersRepositoriesUsernameRepoSlugMilestones", "x-api-path-slug"=>"repositoriesusernamerepo-slugmilestones-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Milestones"]}}, "/repositories/{username}/{repo_slug}/milestones/{milestone_id}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Milestones Milestone", "description"=>"Get repositories username repo slug milestones milestone", "operationId"=>"getRepositoriesUsernameRepoSlugMilestonesMilestone", "x-api-path-slug"=>"repositoriesusernamerepo-slugmilestonesmilestone-id-get", "parameters"=>[{"in"=>"path", "name"=>"milestone_id", "description"=>"The milestones id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Milestones", "Milestone"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Milestones Milestone", "description"=>"Parameters repositories username repo slug milestones milestone", "operationId"=>"parametersRepositoriesUsernameRepoSlugMilestonesMilestone", "x-api-path-slug"=>"repositoriesusernamerepo-slugmilestonesmilestone-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Milestones", "Milestone"]}}, "/repositories/{username}/{repo_slug}/patch/{spec}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Patch Spec", "description"=>"Produces a raw patch for a single commit (diffed against its first\nparent), or a patch-series for a revspec of 2 commits (e.g.\n`3a8b42..9ff173` where the first commit represents the source and the\nsecond commit the destination).\n\nIn case of the latter (diffing a revspec), a patch series is returned\nfor the commits on the source branch (`3a8b42` and its ancestors in\nour example). For Mercurial, a single patch is returned that combines\nthe changes of all commits on the source branch.\n\nWhile similar to diffs, patches:\n\n* Have a commit header (username, commit message, etc)\n* Do not support the `path=foo/bar.py` query parameter\n\nThe raw patch is returned as-is, in whatever encoding the files in the\nrepository use. It is not decoded into unicode. As such, the\ncontent-type is `text/plain`.", "operationId"=>"getRepositoriesUsernameRepoSlugPatchSpec", "x-api-path-slug"=>"repositoriesusernamerepo-slugpatchspec-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Patch", "Spec"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Patch Spec", "description"=>"Parameters repositories username repo slug patch spec", "operationId"=>"parametersRepositoriesUsernameRepoSlugPatchSpec", "x-api-path-slug"=>"repositoriesusernamerepo-slugpatchspec-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Patch", "Spec"]}}, "/repositories/{username}/{repo_slug}/pipelines/"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pipelines", "description"=>"Get repositories username repo slug pipelines", "operationId"=>"getRepositoriesUsernameRepoSlugPipelines", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-get", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Pipelines", "description"=>"Endpoint to create and initiate a pipeline. \nThere are a couple of different options to initiate a pipeline, where the payload of the request will determine which type of pipeline will be instantiated.\n# Trigger a Pipeline for a branch or tag\nOne way to trigger pipelines is by specifying the reference for which you want to trigger a pipeline (e.g. a branch or tag). \nThe specified reference will be used to determine which pipeline definition from the `bitbucket-pipelines.yml` file will be applied to initiate the pipeline. The pipeline will then do a clone of the repository and checkout the latest revision of the specified reference.\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\\n -d '\n {\n \"target\": {\n \"ref_type\": \"branch\", \n \"type\": \"pipeline_ref_target\", \n \"ref_name\": \"master\"\n }\n }'\n```\n# Trigger a Pipeline for a commit on a branch or tag\nYou can initiate a pipeline for a specific commit and in the context of a specified reference (e.g. a branch, tag or bookmark).\nThe specified reference will be used to determine which pipeline definition from the bitbucket-pipelines.yml file will be applied to initiate the pipeline. The pipeline will clone the repository and then do a checkout the specified reference. \n\nThe following reference types are supported:\n\n* `branch` \n* `named_branch`\n* `bookmark` \n * `tag`\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\\n -d '\n {\n \"target\": {\n \"commit\": {\n \"type\": \"commit\", \n \"hash\": \"ce5b7431602f7cbba007062eeb55225c6e18e956\"\n }, \n \"ref_type\": \"branch\", \n \"type\": \"pipeline_ref_target\", \n \"ref_name\": \"master\"\n }\n }'\n```\n# Trigger a specific pipeline definition for a commit\nYou can trigger a specific pipeline that is defined in your `bitbucket-pipelines.yml` file for a specific commit. \nIn addition to the commit revision, you specify the type and pattern of the selector that identifies the pipeline definition. The resulting pipeline will then clone the repository and checkout the specified revision.\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\\n -d '\n {\n \"target\": {\n \"commit\": {\n \"hash\":\"a3c4e02c9a3755eccdc3764e6ea13facdf30f923\",\n \"type\":\"commit\"\n },\n \"selector\": {\n \"type\":\"custom\",\n \"pattern\":\"Deploy to production\"\n },\n \"type\":\"pipeline_commit_target\"\n }\n }'\n```\n# Trigger a specific pipeline definition for a commit on a branch or tag\nYou can trigger a specific pipeline that is defined in your `bitbucket-pipelines.yml` file for a specific commit in the context of a specified reference. \nIn addition to the commit revision, you specify the type and pattern of the selector that identifies the pipeline definition, as well as the reference information. The resulting pipeline will then clone the repository a checkout the specified reference.\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\\n -d '\n {\n \"target\": {\n \"commit\": {\n \"hash\":\"a3c4e02c9a3755eccdc3764e6ea13facdf30f923\",\n \"type\":\"commit\"\n },\n \"selector\": {\n \"type\": \"custom\",\n \"pattern\": \"Deploy to production\"\n },\n \"type\": \"pipeline_ref_target\",\n \"ref_name\": \"master\",\n \"ref_type\": \"branch\"\n }\n }'\n```", "operationId"=>"postRepositoriesUsernameRepoSlugPipelines", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-post", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"body", "name"=>"_body", "description"=>"The pipeline to initiate", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines"]}}, "/repositories/{username}/{repo_slug}/pipelines/{pipeline_uuid}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pipelines Pipeline Uu", "description"=>"Get repositories username repo slug pipelines pipeline uu", "operationId"=>"getRepositoriesUsernameRepoSlugPipelinesPipelineUu", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelinespipeline-uuid-get", "parameters"=>[{"in"=>"path", "name"=>"pipeline_uuid", "description"=>"The pipeline UUID"}, {"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Pipeline", "Uu"]}}, "/repositories/{username}/{repo_slug}/pipelines/{pipeline_uuid}/steps/"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pipelines Pipeline Uu Steps", "description"=>"Get repositories username repo slug pipelines pipeline uu steps", "operationId"=>"getRepositoriesUsernameRepoSlugPipelinesPipelineUuSteps", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelinespipeline-uuidsteps-get", "parameters"=>[{"in"=>"path", "name"=>"pipeline_uuid", "description"=>"The UUID of the pipeline"}, {"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Pipeline", "Uu", "Steps"]}}, "/repositories/{username}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pipelines Pipeline Uu Steps Step Uu", "description"=>"Get repositories username repo slug pipelines pipeline uu steps step uu", "operationId"=>"getRepositoriesUsernameRepoSlugPipelinesPipelineUuStepsStepUu", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelinespipeline-uuidstepsstep-uuid-get", "parameters"=>[{"in"=>"path", "name"=>"pipeline_uuid", "description"=>"The UUID of the pipeline"}, {"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"step_uuid", "description"=>"The UUID of the step"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Pipeline", "Uu", "Steps", "Step", "Uu"]}}, "/repositories/{username}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/log"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pipelines Pipeline Uu Steps Step Uu Log", "description"=>"Retrieve the log file for a given step of a pipeline.\n\nThis endpoint supports (and encourages!) the use of [HTTP Range requests](https://tools.ietf.org/html/rfc7233) to deal with potentially very large log files.", "operationId"=>"getRepositoriesUsernameRepoSlugPipelinesPipelineUuStepsStepUuLog", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelinespipeline-uuidstepsstep-uuidlog-get", "parameters"=>[{"in"=>"path", "name"=>"pipeline_uuid", "description"=>"The UUID of the pipeline"}, {"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"step_uuid", "description"=>"The UUID of the step"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Pipeline", "Uu", "Steps", "Step", "Uu", "Log"]}}, "/repositories/{username}/{repo_slug}/pipelines/{pipeline_uuid}/stopPipeline"=>{"post"=>{"summary"=>"Add Repositories Username Repo Slug Pipelines Pipeline Uu Stoppipeline", "description"=>"Signal the stop of a pipeline and all of its steps that not have completed yet.", "operationId"=>"postRepositoriesUsernameRepoSlugPipelinesPipelineUuStoppipeline", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelinespipeline-uuidstoppipeline-post", "parameters"=>[{"in"=>"path", "name"=>"pipeline_uuid", "description"=>"The UUID of the pipeline"}, {"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Pipeline", "Uu", "Stoppipeline"]}}, "/repositories/{username}/{repo_slug}/pipelines_config"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pipelines Config", "description"=>"Get repositories username repo slug pipelines config", "operationId"=>"getRepositoriesUsernameRepoSlugPipelinesConfig", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-config-get", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Config"]}, "put"=>{"summary"=>"Update Repositories Username Repo Slug Pipelines Config", "description"=>"Update the pipelines configuration for a repository.", "operationId"=>"putRepositoriesUsernameRepoSlugPipelinesConfig", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-config-put", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"body", "name"=>"_body", "description"=>"The updated repository pipelines configuration", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Config"]}}, "/repositories/{username}/{repo_slug}/pipelines_config/ssh/key_pair"=>{"delete"=>{"summary"=>"Delete Repositories Username Repo Slug Pipelines Config Ssh Key Pair", "description"=>"Delete repositories username repo slug pipelines config ssh key pair", "operationId"=>"deleteRepositoriesUsernameRepoSlugPipelinesConfigSshKeyPair", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-configsshkey-pair-delete", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Config", "Ssh", "Key", "Pair"]}, "get"=>{"summary"=>"Get Repositories Username Repo Slug Pipelines Config Ssh Key Pair", "description"=>"Retrieve the repository SSH key pair excluding the SSH private key. The private key is a write only field and will never be exposed in the logs or the REST API.", "operationId"=>"getRepositoriesUsernameRepoSlugPipelinesConfigSshKeyPair", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-configsshkey-pair-get", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Config", "Ssh", "Key", "Pair"]}, "put"=>{"summary"=>"Update Repositories Username Repo Slug Pipelines Config Ssh Key Pair", "description"=>"Create or update the repository SSH key pair. The private key will be set as a default SSH identity in your build container.", "operationId"=>"putRepositoriesUsernameRepoSlugPipelinesConfigSshKeyPair", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-configsshkey-pair-put", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"body", "name"=>"_body", "description"=>"The created or updated SSH key pair", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Config", "Ssh", "Key", "Pair"]}}, "/repositories/{username}/{repo_slug}/pipelines_config/ssh/known_hosts/"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pipelines Config Ssh Known Hosts", "description"=>"Get repositories username repo slug pipelines config ssh known hosts", "operationId"=>"getRepositoriesUsernameRepoSlugPipelinesConfigSshKnownHosts", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-configsshknown-hosts-get", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Config", "Ssh", "Known", "Hosts"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Pipelines Config Ssh Known Hosts", "description"=>"Post repositories username repo slug pipelines config ssh known hosts", "operationId"=>"postRepositoriesUsernameRepoSlugPipelinesConfigSshKnownHosts", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-configsshknown-hosts-post", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"body", "name"=>"_body", "description"=>"The known host to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Config", "Ssh", "Known", "Hosts"]}}, "/repositories/{username}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}"=>{"delete"=>{"summary"=>"Delete Repositories Username Repo Slug Pipelines Config Ssh Known Hosts Known Host Uu", "description"=>"Delete repositories username repo slug pipelines config ssh known hosts known host uu", "operationId"=>"deleteRepositoriesUsernameRepoSlugPipelinesConfigSshKnownHostsKnownHostUu", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-configsshknown-hostsknown-host-uuid-delete", "parameters"=>[{"in"=>"path", "name"=>"known_host_uuid", "description"=>"The UUID of the known host to delete"}, {"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Config", "Ssh", "Known", "Hosts", "Known", "Host", "Uu"]}, "get"=>{"summary"=>"Get Repositories Username Repo Slug Pipelines Config Ssh Known Hosts Known Host Uu", "description"=>"Get repositories username repo slug pipelines config ssh known hosts known host uu", "operationId"=>"getRepositoriesUsernameRepoSlugPipelinesConfigSshKnownHostsKnownHostUu", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-configsshknown-hostsknown-host-uuid-get", "parameters"=>[{"in"=>"path", "name"=>"known_host_uuid", "description"=>"The UUID of the known host to retrieve"}, {"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Config", "Ssh", "Known", "Hosts", "Known", "Host", "Uu"]}, "put"=>{"summary"=>"Update Repositories Username Repo Slug Pipelines Config Ssh Known Hosts Known Host Uu", "description"=>"Put repositories username repo slug pipelines config ssh known hosts known host uu", "operationId"=>"putRepositoriesUsernameRepoSlugPipelinesConfigSshKnownHostsKnownHostUu", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-configsshknown-hostsknown-host-uuid-put", "parameters"=>[{"in"=>"path", "name"=>"known_host_uuid", "description"=>"The UUID of the known host to update"}, {"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"body", "name"=>"_body", "description"=>"The updated known host", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Config", "Ssh", "Known", "Hosts", "Known", "Host", "Uu"]}}, "/repositories/{username}/{repo_slug}/pipelines_config/variables/"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pipelines Config Variables", "description"=>"Get repositories username repo slug pipelines config variables", "operationId"=>"getRepositoriesUsernameRepoSlugPipelinesConfigVariables", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-configvariables-get", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Config", "Variables"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Pipelines Config Variables", "description"=>"Post repositories username repo slug pipelines config variables", "operationId"=>"postRepositoriesUsernameRepoSlugPipelinesConfigVariables", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-configvariables-post", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"body", "name"=>"_body", "description"=>"The variable to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Config", "Variables"]}}, "/repositories/{username}/{repo_slug}/pipelines_config/variables/{variable_uuid}"=>{"delete"=>{"summary"=>"Delete Repositories Username Repo Slug Pipelines Config Variables Variable Uu", "description"=>"Delete repositories username repo slug pipelines config variables variable uu", "operationId"=>"deleteRepositoriesUsernameRepoSlugPipelinesConfigVariablesVariableUu", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-configvariablesvariable-uuid-delete", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"path", "name"=>"variable_uuid", "description"=>"The UUID of the variable to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Config", "Variables", "Variable", "Uu"]}, "get"=>{"summary"=>"Get Repositories Username Repo Slug Pipelines Config Variables Variable Uu", "description"=>"Get repositories username repo slug pipelines config variables variable uu", "operationId"=>"getRepositoriesUsernameRepoSlugPipelinesConfigVariablesVariableUu", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-configvariablesvariable-uuid-get", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"path", "name"=>"variable_uuid", "description"=>"The UUID of the variable to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Config", "Variables", "Variable", "Uu"]}, "put"=>{"summary"=>"Update Repositories Username Repo Slug Pipelines Config Variables Variable Uu", "description"=>"Put repositories username repo slug pipelines config variables variable uu", "operationId"=>"putRepositoriesUsernameRepoSlugPipelinesConfigVariablesVariableUu", "x-api-path-slug"=>"repositoriesusernamerepo-slugpipelines-configvariablesvariable-uuid-put", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"The repository"}, {"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"path", "name"=>"variable_uuid", "description"=>"The UUID of the variable to update"}, {"in"=>"body", "name"=>"_body", "description"=>"The updated variable", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pipelines", "Config", "Variables", "Variable", "Uu"]}}, "/repositories/{username}/{repo_slug}/pullrequests"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pullrequests", "description"=>"Returns a paginated list of all pull requests on the specified\nrepository. By default only open pull requests are returned. This can\nbe controlled using the `state` query parameter. To retrieve pull\nrequests that are in one of multiple states, repeat the `state`\nparameter for each individual state.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../../../../meta/filtering) for more details.", "operationId"=>"getRepositoriesUsernameRepoSlugPullrequests", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequests-get", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"This can either be the repository slug or the UUID of the repository,surrounded by curly-braces, for example: `{repository UUID}`"}, {"in"=>"query", "name"=>"state", "description"=>"Only return pull requests that are in this state"}, {"in"=>"path", "name"=>"username", "description"=>"This can either be the username or the UUID of the user,surrounded by curly-braces, for example: `{user UUID}`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Pullrequests", "description"=>"Parameters repositories username repo slug pullrequests", "operationId"=>"parametersRepositoriesUsernameRepoSlugPullrequests", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequests-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Pullrequests", "description"=>"Post repositories username repo slug pullrequests", "operationId"=>"postRepositoriesUsernameRepoSlugPullrequests", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequests-post", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"This can either be the repository slug or the UUID of the repository,surrounded by curly-braces, for example: `{repository UUID}`"}, {"in"=>"path", "name"=>"username", "description"=>"This can either be the username or the UUID of the user,surrounded by curly-braces, for example: `{user UUID}`"}, {"in"=>"body", "name"=>"_body", "description"=>"The new pull request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests"]}}, "/repositories/{username}/{repo_slug}/pullrequests/activity"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pullrequests Activity", "description"=>"Returns a paginated list of the pull request's activity log.\n\nThis includes comments that were made by the reviewers, updates and\napprovals.", "operationId"=>"getRepositoriesUsernameRepoSlugPullrequestsActivity", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestsactivity-get", "parameters"=>[{"in"=>"path", "name"=>"repo_slug", "description"=>"This can either be the repository slug or the UUID of the repository,surrounded by curly-braces, for example: `{repository UUID}`"}, {"in"=>"path", "name"=>"username", "description"=>"This can either be the username or the UUID of the user,surrounded by curly-braces, for example: `{user UUID}`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Activity"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Pullrequests Activity", "description"=>"Parameters repositories username repo slug pullrequests activity", "operationId"=>"parametersRepositoriesUsernameRepoSlugPullrequestsActivity", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestsactivity-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Activity"]}}, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pullrequests Pull Request", "description"=>"Get repositories username repo slug pullrequests pull request", "operationId"=>"getRepositoriesUsernameRepoSlugPullrequestsPullRequest", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-id-get", "parameters"=>[{"in"=>"path", "name"=>"pull_request_id", "description"=>"The id of the pull request"}, {"in"=>"path", "name"=>"repo_slug", "description"=>"This can either be the repository slug or the UUID of the repository,surrounded by curly-braces, for example: `{repository UUID}`"}, {"in"=>"path", "name"=>"username", "description"=>"This can either be the username or the UUID of the account,surrounded by curly-braces, for example: `{user UUID}`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Pullrequests Pull Request", "description"=>"Parameters repositories username repo slug pullrequests pull request", "operationId"=>"parametersRepositoriesUsernameRepoSlugPullrequestsPullRequest", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request"]}, "put"=>{"summary"=>"Update Repositories Username Repo Slug Pullrequests Pull Request", "description"=>"Mutates the specified pull request.\n\nThis can be used to change the pull request's branches or description.\n\nOnly open pull requests can be mutated.", "operationId"=>"putRepositoriesUsernameRepoSlugPullrequestsPullRequest", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-id-put", "parameters"=>[{"in"=>"path", "name"=>"pull_request_id", "description"=>"The id of the open pull request"}, {"in"=>"path", "name"=>"repo_slug", "description"=>"This can either be the repository slug or the UUID of the repository,surrounded by curly-braces, for example: `{repository UUID}`"}, {"in"=>"path", "name"=>"username", "description"=>"This can either be the username or the UUID of the user,surrounded by curly-braces, for example: `{user UUID}`"}, {"in"=>"body", "name"=>"_body", "description"=>"The pull request that is to be updated", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request"]}}, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/activity"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pullrequests Pull Request Activity", "description"=>"Returns a paginated list of the pull request's activity log.\n\nThis includes comments that were made by the reviewers, updates and\napprovals.", "operationId"=>"getRepositoriesUsernameRepoSlugPullrequestsPullRequestActivity", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idactivity-get", "parameters"=>[{"in"=>"path", "name"=>"pull_request_id", "description"=>"The id of the pull request"}, {"in"=>"path", "name"=>"repo_slug", "description"=>"This can either be the repository slug or the UUID of the repository,surrounded by curly-braces, for example: `{repository UUID}`"}, {"in"=>"path", "name"=>"username", "description"=>"This can either be the username or the UUID of the user,surrounded by curly-braces, for example: `{user UUID}`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Activity"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Pullrequests Pull Request Activity", "description"=>"Parameters repositories username repo slug pullrequests pull request activity", "operationId"=>"parametersRepositoriesUsernameRepoSlugPullrequestsPullRequestActivity", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idactivity-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Activity"]}}, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/approve"=>{"delete"=>{"summary"=>"Delete Repositories Username Repo Slug Pullrequests Pull Request Approve", "description"=>"Delete repositories username repo slug pullrequests pull request approve", "operationId"=>"deleteRepositoriesUsernameRepoSlugPullrequestsPullRequestApprove", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idapprove-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Approve"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Pullrequests Pull Request Approve", "description"=>"Parameters repositories username repo slug pullrequests pull request approve", "operationId"=>"parametersRepositoriesUsernameRepoSlugPullrequestsPullRequestApprove", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idapprove-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Approve"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Pullrequests Pull Request Approve", "description"=>"Post repositories username repo slug pullrequests pull request approve", "operationId"=>"postRepositoriesUsernameRepoSlugPullrequestsPullRequestApprove", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idapprove-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Approve"]}}, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/comments"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pullrequests Pull Request Comments", "description"=>"Returns a paginated list of the pull request's comments.\n\nThis includes both global, inline comments and replies.\n\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../../../../../../meta/filtering) for more\ndetails.", "operationId"=>"getRepositoriesUsernameRepoSlugPullrequestsPullRequestComments", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idcomments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Comments"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Pullrequests Pull Request Comments", "description"=>"Parameters repositories username repo slug pullrequests pull request comments", "operationId"=>"parametersRepositoriesUsernameRepoSlugPullrequestsPullRequestComments", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idcomments-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Comments"]}}, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pullrequests Pull Request Comments Comment", "description"=>"Get repositories username repo slug pullrequests pull request comments comment", "operationId"=>"getRepositoriesUsernameRepoSlugPullrequestsPullRequestCommentsComment", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idcommentscomment-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Comments", "Comment"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Pullrequests Pull Request Comments Comment", "description"=>"Parameters repositories username repo slug pullrequests pull request comments comment", "operationId"=>"parametersRepositoriesUsernameRepoSlugPullrequestsPullRequestCommentsComment", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idcommentscomment-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Comments", "Comment"]}}, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/commits"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pullrequests Pull Request Commits", "description"=>"Returns a paginated list of the pull request's commits.\n\nThese are the commits that are being merged into the destination\nbranch when the pull requests gets accepted.", "operationId"=>"getRepositoriesUsernameRepoSlugPullrequestsPullRequestCommits", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idcommits-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Commits"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Pullrequests Pull Request Commits", "description"=>"Parameters repositories username repo slug pullrequests pull request commits", "operationId"=>"parametersRepositoriesUsernameRepoSlugPullrequestsPullRequestCommits", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idcommits-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Commits"]}}, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/decline"=>{"parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Pullrequests Pull Request Decline", "description"=>"Parameters repositories username repo slug pullrequests pull request decline", "operationId"=>"parametersRepositoriesUsernameRepoSlugPullrequestsPullRequestDecline", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-iddecline-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Decline"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Pullrequests Pull Request Decline", "description"=>"Post repositories username repo slug pullrequests pull request decline", "operationId"=>"postRepositoriesUsernameRepoSlugPullrequestsPullRequestDecline", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-iddecline-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Decline"]}}, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/diff"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pullrequests Pull Request Diff", "description"=>"Get repositories username repo slug pullrequests pull request diff", "operationId"=>"getRepositoriesUsernameRepoSlugPullrequestsPullRequestDiff", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-iddiff-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Diff"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Pullrequests Pull Request Diff", "description"=>"Parameters repositories username repo slug pullrequests pull request diff", "operationId"=>"parametersRepositoriesUsernameRepoSlugPullrequestsPullRequestDiff", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-iddiff-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Diff"]}}, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/merge"=>{"parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Pullrequests Pull Request Merge", "description"=>"Parameters repositories username repo slug pullrequests pull request merge", "operationId"=>"parametersRepositoriesUsernameRepoSlugPullrequestsPullRequestMerge", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idmerge-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Merge"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Pullrequests Pull Request Merge", "description"=>"Post repositories username repo slug pullrequests pull request merge", "operationId"=>"postRepositoriesUsernameRepoSlugPullrequestsPullRequestMerge", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idmerge-post", "parameters"=>[{"in"=>"body", "name"=>"_body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Merge"]}}, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/patch"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pullrequests Pull Request Patch", "description"=>"Get repositories username repo slug pullrequests pull request patch", "operationId"=>"getRepositoriesUsernameRepoSlugPullrequestsPullRequestPatch", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idpatch-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Patch"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Pullrequests Pull Request Patch", "description"=>"Parameters repositories username repo slug pullrequests pull request patch", "operationId"=>"parametersRepositoriesUsernameRepoSlugPullrequestsPullRequestPatch", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idpatch-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Patch"]}}, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/statuses"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Pullrequests Pull Request Statuses", "description"=>"Get repositories username repo slug pullrequests pull request statuses", "operationId"=>"getRepositoriesUsernameRepoSlugPullrequestsPullRequestStatuses", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idstatuses-get", "parameters"=>[{"in"=>"path", "name"=>"pull_request_id", "description"=>"The pull requests id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Statuses"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Pullrequests Pull Request Statuses", "description"=>"Parameters repositories username repo slug pullrequests pull request statuses", "operationId"=>"parametersRepositoriesUsernameRepoSlugPullrequestsPullRequestStatuses", "x-api-path-slug"=>"repositoriesusernamerepo-slugpullrequestspull-request-idstatuses-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Pullrequests", "Pull", "Request", "", "Statuses"]}}, "/repositories/{username}/{repo_slug}/refs"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Refs", "description"=>"Get repositories username repo slug refs", "operationId"=>"getRepositoriesUsernameRepoSlugRefs", "x-api-path-slug"=>"repositoriesusernamerepo-slugrefs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Refs"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Refs", "description"=>"Parameters repositories username repo slug refs", "operationId"=>"parametersRepositoriesUsernameRepoSlugRefs", "x-api-path-slug"=>"repositoriesusernamerepo-slugrefs-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Refs"]}}, "/repositories/{username}/{repo_slug}/refs/branches"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Refs Branches", "description"=>"Get repositories username repo slug refs branches", "operationId"=>"getRepositoriesUsernameRepoSlugRefsBranches", "x-api-path-slug"=>"repositoriesusernamerepo-slugrefsbranches-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Refs", "Branches"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Refs Branches", "description"=>"Parameters repositories username repo slug refs branches", "operationId"=>"parametersRepositoriesUsernameRepoSlugRefsBranches", "x-api-path-slug"=>"repositoriesusernamerepo-slugrefsbranches-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Refs", "Branches"]}}, "/repositories/{username}/{repo_slug}/refs/branches/{name}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Refs Branches Name", "description"=>"Get repositories username repo slug refs branches name", "operationId"=>"getRepositoriesUsernameRepoSlugRefsBranchesName", "x-api-path-slug"=>"repositoriesusernamerepo-slugrefsbranchesname-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Refs", "Branches", "Name"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Refs Branches Name", "description"=>"Parameters repositories username repo slug refs branches name", "operationId"=>"parametersRepositoriesUsernameRepoSlugRefsBranchesName", "x-api-path-slug"=>"repositoriesusernamerepo-slugrefsbranchesname-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Refs", "Branches", "Name"]}}, "/repositories/{username}/{repo_slug}/refs/tags"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Refs Tags", "description"=>"Get repositories username repo slug refs tags", "operationId"=>"getRepositoriesUsernameRepoSlugRefsTags", "x-api-path-slug"=>"repositoriesusernamerepo-slugrefstags-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Refs", "Tags"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Refs Tags", "description"=>"Parameters repositories username repo slug refs tags", "operationId"=>"parametersRepositoriesUsernameRepoSlugRefsTags", "x-api-path-slug"=>"repositoriesusernamerepo-slugrefstags-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Refs", "Tags"]}, "post"=>{"summary"=>"Add Repositories Username Repo Slug Refs Tags", "description"=>"Creates a new tag in the specified repository.\n\nThe payload of the POST should consist of a JSON document that\ncontains the name of the tag and the target hash.\n\n```\n{\n \"name\" : \"new tag name\",\n \"target\" : {\n \"hash\" : \"target commit hash\",\n }\n}\n```\n\nThis endpoint does support using short hash prefixes for the commit\nhash, but it may return a 400 response if the provided prefix is\nambiguous. Using a full commit hash is the preferred approach.", "operationId"=>"postRepositoriesUsernameRepoSlugRefsTags", "x-api-path-slug"=>"repositoriesusernamerepo-slugrefstags-post", "parameters"=>[{"in"=>"body", "name"=>"_body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Refs", "Tags"]}}, "/repositories/{username}/{repo_slug}/refs/tags/{name}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Refs Tags Name", "description"=>"Get repositories username repo slug refs tags name", "operationId"=>"getRepositoriesUsernameRepoSlugRefsTagsName", "x-api-path-slug"=>"repositoriesusernamerepo-slugrefstagsname-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Refs", "Tags", "Name"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Refs Tags Name", "description"=>"Parameters repositories username repo slug refs tags name", "operationId"=>"parametersRepositoriesUsernameRepoSlugRefsTagsName", "x-api-path-slug"=>"repositoriesusernamerepo-slugrefstagsname-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Refs", "Tags", "Name"]}}, "/repositories/{username}/{repo_slug}/src/{node}/{path}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Src Node Path", "description"=>"Get repositories username repo slug src node path", "operationId"=>"getRepositoriesUsernameRepoSlugSrcNodePath", "x-api-path-slug"=>"repositoriesusernamerepo-slugsrcnodepath-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Instead of returning the files contents, return the (json) meta data for it"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Src", "Node", "Path"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Src Node Path", "description"=>"Parameters repositories username repo slug src node path", "operationId"=>"parametersRepositoriesUsernameRepoSlugSrcNodePath", "x-api-path-slug"=>"repositoriesusernamerepo-slugsrcnodepath-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Src", "Node", "Path"]}}, "/repositories/{username}/{repo_slug}/versions"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Versions", "description"=>"Returns the versions that have been defined in the issue tracker.\n\nThis resource is only available on repositories that have the issue\ntracker enabled.", "operationId"=>"getRepositoriesUsernameRepoSlugVersions", "x-api-path-slug"=>"repositoriesusernamerepo-slugversions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Versions"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Versions", "description"=>"Parameters repositories username repo slug versions", "operationId"=>"parametersRepositoriesUsernameRepoSlugVersions", "x-api-path-slug"=>"repositoriesusernamerepo-slugversions-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Versions"]}}, "/repositories/{username}/{repo_slug}/versions/{version_id}"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Versions Version", "description"=>"Get repositories username repo slug versions version", "operationId"=>"getRepositoriesUsernameRepoSlugVersionsVersion", "x-api-path-slug"=>"repositoriesusernamerepo-slugversionsversion-id-get", "parameters"=>[{"in"=>"path", "name"=>"version_id", "description"=>"The versions id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Versions", "Version"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Versions Version", "description"=>"Parameters repositories username repo slug versions version", "operationId"=>"parametersRepositoriesUsernameRepoSlugVersionsVersion", "x-api-path-slug"=>"repositoriesusernamerepo-slugversionsversion-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Versions", "Version"]}}, "/repositories/{username}/{repo_slug}/watchers"=>{"get"=>{"summary"=>"Get Repositories Username Repo Slug Watchers", "description"=>"Returns a paginated list of all the watchers on the specified\nrepository.", "operationId"=>"getRepositoriesUsernameRepoSlugWatchers", "x-api-path-slug"=>"repositoriesusernamerepo-slugwatchers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Watchers"]}, "parameters"=>{"summary"=>"Parameters Repositories Username Repo Slug Watchers", "description"=>"Parameters repositories username repo slug watchers", "operationId"=>"parametersRepositoriesUsernameRepoSlugWatchers", "x-api-path-slug"=>"repositoriesusernamerepo-slugwatchers-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Repositories", "Username", "Repo", "Slug", "Watchers"]}}, "/snippets"=>{"get"=>{"summary"=>"Get Snippets", "description"=>"Returns all snippets. Like pull requests, repositories and teams, the\nfull set of snippets is defined by what the current user has access to.\n\nThis includes all snippets owned by the current user, but also all snippets\nowned by any of the teams the user is a member of, or snippets by other\nusers that the current user is either watching or has collaborated on (for\ninstance by commenting on it).\n\nTo limit the set of returned snippets, apply the\n`?role=[owner|contributor|member]` query parameter where the roles are\ndefined as follows:\n\n* `owner`: all snippets owned by the current user\n* `contributor`: all snippets owned by, or watched by the current user\n* `member`: owned by the user, their teams, or watched by the current user\n\nWhen no role is specified, all public snippets are returned, as well as all\nprivately owned snippets watched or commented on.\n\nThe returned response is a normal paginated JSON list. This endpoint\nonly supports `application/json` responses and no\n`multipart/form-data` or `multipart/related`. As a result, it is not\npossible to include the file contents.", "operationId"=>"getSnippets", "x-api-path-slug"=>"snippets-get", "parameters"=>[{"in"=>"query", "name"=>"role", "description"=>"Filter down the result based on the authenticated users role (`owner`, `contributor`, or `member`)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets"]}, "parameters"=>{"summary"=>"Parameters Snippets", "description"=>"Parameters snippets", "operationId"=>"parametersSnippets", "x-api-path-slug"=>"snippets-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets"]}, "post"=>{"summary"=>"Add Snippets", "description"=>"Creates a new snippet under the authenticated user's account.\n\nSnippets can contain multiple files. Both text and binary files are\nsupported.\n\nThe simplest way to create a new snippet from a local file:\n\n $ curl -u username:password -X POST https://api.bitbucket.org/2.0/snippets -F file=@image.png\n\nCreating snippets through curl has a few limitations and so let's look\nat a more complicated scenario.\n\nSnippets are created with a multipart POST. Both `multipart/form-data`\nand `multipart/related` are supported. Both allow the creation of\nsnippets with both meta data (title, etc), as well as multiple text\nand binary files.\n\nThe main difference is that `multipart/related` can use rich encoding\nfor the meta data (currently JSON).\n\n\nmultipart/related (RFC-2387)\n----------------------------\n\nThis is the most advanced and efficient way to create a paste.\n\n POST /2.0/snippets/evzijst HTTP/1.1\n Content-Length: 1188\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"title\": \"My snippet\",\n \"is_private\": true,\n \"scm\": \"hg\",\n \"files\": {\n \"foo.txt\": {},\n \"image.png\": {}\n }\n }\n\n --===============1438169132528273974==\n Content-Type: text/plain; charset=\"us-ascii\"\n MIME-Version: 1.0\n Content-Transfer-Encoding: 7bit\n Content-ID: \"foo.txt\"\n Content-Disposition: attachment; filename=\"foo.txt\"\n\n foo\n\n --===============1438169132528273974==\n Content-Type: image/png\n MIME-Version: 1.0\n Content-Transfer-Encoding: base64\n Content-ID: \"image.png\"\n Content-Disposition: attachment; filename=\"image.png\"\n\n iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m\n TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB\n cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5\n EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ\n 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN\n AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==\n --===============1438169132528273974==--\n\nThe request contains multiple parts and is structured as follows.\n\nThe first part is the JSON document that describes the snippet's\nproperties or meta data. It either has to be the first part, or the\nrequest's `Content-Type` header must contain the `start` parameter to\npoint to it.\n\nThe remaining parts are the files of which there can be zero or more.\nEach file part should contain the `Content-ID` MIME header through\nwhich the JSON meta data's `files` element addresses it. The value\nshould be the name of the file.\n\n`Content-Disposition` is an optional MIME header. The header's\noptional `filename` parameter can be used to specify the file name\nthat Bitbucket should use when writing the file to disk. When present,\n`filename` takes precedence over the value of `Content-ID`.\n\nWhen the JSON body omits the `files` element, the remaining parts are\nnot ignored. Instead, each file is added to the new snippet as if its\nname was explicitly linked (the use of the `files` elements is\nmandatory for some operations like deleting or renaming files).\n\n\nmultipart/form-data\n-------------------\n\nThe use of JSON for the snippet's meta data is optional. Meta data can\nalso be supplied as regular form fields in a more conventional\n`multipart/form-data` request:\n\n $ curl -X POST -u credentials https://api.bitbucket.org/2.0/snippets -F title=\"My snippet\" -F file=@foo.txt -F file=@image.png\n\n POST /2.0/snippets HTTP/1.1\n Content-Length: 951\n Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"file\"; filename=\"foo.txt\"\n Content-Type: text/plain\n\n foo\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"file\"; filename=\"image.png\"\n Content-Type: application/octet-stream\n\n ?PNG\n\n IHDR?1??I.....\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"title\"\n\n My snippet\n ------------------------------63a4b224c59f--\n\nHere the meta data properties are included as flat, top-level form\nfields. The file attachments use the `file` field name. To attach\nmultiple files, simply repeat the field.\n\nThe advantage of `multipart/form-data` over `multipart/related` is\nthat it can be easier to build clients.\n\nEssentially all properties are optional, `title` and `files` included.\n\n\nSharing and Visibility\n----------------------\n\nSnippets can be either public (visible to anyone on Bitbucket, as well\nas anonymous users), or private (visible only to the owner, creator\nand members of the team in case the snippet is owned by a team). This\nis controlled through the snippet's `is_private` element:\n\n* **is_private=false** -- everyone, including anonymous users can view\n the snippet\n* **is_private=true** -- only the owner and team members (for team\n snippets) can view it\n\nTo create the snippet under a team account, just append the team name\nto the URL (see `/2.0/snippets/{username}`).", "operationId"=>"postSnippets", "x-api-path-slug"=>"snippets-post", "parameters"=>[{"in"=>"body", "name"=>"_body", "description"=>"The new snippet object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets"]}}, "/snippets/{username}"=>{"get"=>{"summary"=>"Get Snippets Username", "description"=>"Identical to `/snippets`, except that the result is further filtered\nby the snippet owner and only those that are owned by `{username}` are\nreturned.", "operationId"=>"getSnippetsUsername", "x-api-path-slug"=>"snippetsusername-get", "parameters"=>[{"in"=>"query", "name"=>"role", "description"=>"Filter down the result based on the authenticated users role (`owner`, `contributor`, or `member`)"}, {"in"=>"path", "name"=>"username", "description"=>"Limits the result to snippets owned by this user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username"]}, "parameters"=>{"summary"=>"Parameters Snippets Username", "description"=>"Parameters snippets username", "operationId"=>"parametersSnippetsUsername", "x-api-path-slug"=>"snippetsusername-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username"]}, "post"=>{"summary"=>"Add Snippets Username", "description"=>"Identical to `/snippets`, except that the new snippet will be\ncreated under the account specified in the path parameter `{username}`.", "operationId"=>"postSnippetsUsername", "x-api-path-slug"=>"snippetsusername-post", "parameters"=>[{"in"=>"body", "name"=>"_body", "description"=>"The new snippet object", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username"]}}, "/snippets/{username}/{encoded_id}"=>{"delete"=>{"summary"=>"Delete Snippets Username Encoded", "description"=>"Deletes a snippet and returns an empty response.", "operationId"=>"deleteSnippetsUsernameEncoded", "x-api-path-slug"=>"snippetsusernameencoded-id-delete", "parameters"=>[{"in"=>"path", "name"=>"encoded_id", "description"=>"The snippets id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded"]}, "get"=>{"summary"=>"Get Snippets Username Encoded", "description"=>"Retrieves a single snippet.\n\nSnippets support multiple content types:\n\n* application/json\n* multipart/related\n* multipart/form-data\n\n\napplication/json\n----------------\n\nThe default content type of the response is `application/json`.\nSince JSON is always `utf-8`, it cannot reliably contain file contents\nfor files that are not text. Therefore, JSON snippet documents only\ncontain the filename and links to the file contents.\n\nThis means that in order to retrieve all parts of a snippet, N+1\nrequests need to be made (where N is the number of files in the\nsnippet).\n\n\nmultipart/related\n-----------------\n\nTo retrieve an entire snippet in a single response, use the\n`Accept: multipart/related` HTTP request header.\n\n $ curl -H \"Accept: multipart/related\" https://api.bitbucket.org/2.0/snippets/evzijst/1\n\nResponse:\n\n HTTP/1.1 200 OK\n Content-Length: 2214\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/snippets/evzijst/kypj\"\n },\n \"comments\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/comments\"\n },\n \"watchers\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/watchers\"\n },\n \"commits\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/commits\"\n }\n },\n \"id\": kypj,\n \"title\": \"My snippet\",\n \"created_on\": \"2014-12-29T22:22:04.790331+00:00\",\n \"updated_on\": \"2014-12-29T22:22:04.790331+00:00\",\n \"is_private\": false,\n \"files\": {\n \"foo.txt\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/files/367ab19/foo.txt\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/snippets/evzijst/kypj#file-foo.txt\"\n }\n }\n },\n \"image.png\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/files/367ab19/image.png\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/snippets/evzijst/kypj#file-image.png\"\n }\n }\n }\n ],\n \"owner\": {\n \"username\": \"evzijst\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/evzijst\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Jul/31/erik-avatar-725122544-0_avatar.png\"\n }\n }\n },\n \"creator\": {\n \"username\": \"evzijst\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/evzijst\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Jul/31/erik-avatar-725122544-0_avatar.png\"\n }\n }\n }\n }\n\n --===============1438169132528273974==\n Content-Type: text/plain; charset=\"us-ascii\"\n MIME-Version: 1.0\n Content-Transfer-Encoding: 7bit\n Content-ID: \"foo.txt\"\n Content-Disposition: attachment; filename=\"foo.txt\"\n\n foo\n\n --===============1438169132528273974==\n Content-Type: image/png\n MIME-Version: 1.0\n Content-Transfer-Encoding: base64\n Content-ID: \"image.png\"\n Content-Disposition: attachment; filename=\"image.png\"\n\n iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m\n TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB\n cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5\n EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ\n 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN\n AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==\n --===============1438169132528273974==--\n\nmultipart/form-data\n-------------------\n\nAs with creating new snippets, `multipart/form-data` can be used as an\nalternative to `multipart/related`. However, the inherently flat\nstructure of form-data means that only basic, root-level properties\ncan be returned, while nested elements like `links` are omitted:\n\n $ curl -H \"Accept: multipart/form-data\" https://api.bitbucket.org/2.0/snippets/evzijst/kypj\n\nResponse:\n\n HTTP/1.1 200 OK\n Content-Length: 951\n Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"title\"\n Content-Type: text/plain; charset=\"utf-8\"\n\n My snippet\n ------------------------------63a4b224c59f--\n Content-Disposition: attachment; name=\"file\"; filename=\"foo.txt\"\n Content-Type: text/plain\n\n foo\n\n ------------------------------63a4b224c59f\n Content-Disposition: attachment; name=\"file\"; filename=\"image.png\"\n Content-Transfer-Encoding: base64\n Content-Type: application/octet-stream\n\n iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m\n TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB\n cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5\n EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ\n 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN\n AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==\n ------------------------------5957323a6b76--", "operationId"=>"getSnippetsUsernameEncoded", "x-api-path-slug"=>"snippetsusernameencoded-id-get", "parameters"=>[{"in"=>"path", "name"=>"encoded_id", "description"=>"The snippets id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded"]}, "parameters"=>{"summary"=>"Parameters Snippets Username Encoded", "description"=>"Parameters snippets username encoded", "operationId"=>"parametersSnippetsUsernameEncoded", "x-api-path-slug"=>"snippetsusernameencoded-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded"]}, "put"=>{"summary"=>"Update Snippets Username Encoded", "description"=>"Used to update a snippet. Use this to add and delete files and to\nchange a snippet's title.\n\nTo update a snippet, one can either PUT a full snapshot, or only the\nparts that need to be changed.\n\nThe contract for PUT on this API is that properties missing from the\nrequest remain untouched so that snippets can be efficiently\nmanipulated with differential payloads.\n\nTo delete a property (e.g. the title, or a file), include its name in\nthe request, but omit its value (use `null`).\n\nAs in Git, explicit renaming of files is not supported. Instead, to\nrename a file, delete it and add it again under another name. This can\nbe done atomically in a single request. Rename detection is left to\nthe SCM.\n\nPUT supports three different content types for both request and\nresponse bodies:\n\n* `application/json`\n* `multipart/related`\n* `multipart/form-data`\n\nThe content type used for the request body can be different than that\nused for the response. Content types are specified using standard HTTP\nheaders.\n\nUse the `Content-Type` and `Accept` headers to select the desired\nrequest and response format.\n\n\napplication/json\n----------------\n\nAs with creation and retrieval, the content type determines what\nproperties can be manipulated. `application/json` does not support\nfile contents and is therefore limited to a snippet's meta data.\n\nTo update the title, without changing any of its files:\n\n $ curl -X POST -H \"Content-Type: application/json\" https://api.bitbucket.org/2.0/snippets/evzijst/kypj -d '{\"title\": \"Updated title\"}'\n\n\nTo delete the title:\n\n $ curl -X POST -H \"Content-Type: application/json\" https://api.bitbucket.org/2.0/snippets/evzijst/kypj -d '{\"title\": null}'\n\nNot all parts of a snippet can be manipulated. The owner and creator\nfor instance are immutable.\n\n\nmultipart/related\n-----------------\n\n`multipart/related` can be used to manipulate all of a snippet's\nproperties. The body is identical to a POST. properties omitted from\nthe request are left unchanged. Since the `start` part contains JSON,\nthe mechanism for manipulating the snippet's meta data is identical\nto `application/json` requests.\n\nTo update one of a snippet's file contents, while also changing its\ntitle:\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 288\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"title\": \"My updated snippet\",\n \"files\": {\n \"foo.txt\": {}\n }\n }\n\n --===============1438169132528273974==\n Content-Type: text/plain; charset=\"us-ascii\"\n MIME-Version: 1.0\n Content-Transfer-Encoding: 7bit\n Content-ID: \"foo.txt\"\n Content-Disposition: attachment; filename=\"foo.txt\"\n\n Updated file contents.\n\n --===============1438169132528273974==--\n\nHere only the parts that are changed are included in the body. The\nother files remain untouched.\n\nNote the use of the `files` list in the JSON part. This list contains\nthe files that are being manipulated. This list should have\ncorresponding multiparts in the request that contain the new contents\nof these files.\n\nIf a filename in the `files` list does not have a corresponding part,\nit will be deleted from the snippet, as shown below:\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 188\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"files\": {\n \"image.png\": {}\n }\n }\n\n --===============1438169132528273974==--\n\nTo simulate a rename, delete a file and add the same file under\nanother name:\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 212\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"files\": {\n \"foo.txt\": {},\n \"bar.txt\": {}\n }\n }\n\n --===============1438169132528273974==\n Content-Type: text/plain; charset=\"us-ascii\"\n MIME-Version: 1.0\n Content-Transfer-Encoding: 7bit\n Content-ID: \"bar.txt\"\n Content-Disposition: attachment; filename=\"bar.txt\"\n\n foo\n\n --===============1438169132528273974==--\n\n\nmultipart/form-data\n-----------------\n\nAgain, one can also use `multipart/form-data` to manipulate file\ncontents and meta data atomically.\n\n $ curl -X PUT http://localhost:12345/2.0/snippets/evzijst/kypj -F title=\"My updated snippet\" -F file=@foo.txt\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 351\n Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"file\"; filename=\"foo.txt\"\n Content-Type: text/plain\n\n foo\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"title\"\n\n My updated snippet\n ------------------------------63a4b224c59f\n\nTo delete a file, omit its contents while including its name in the\n`files` field:\n\n $ curl -X PUT https://api.bitbucket.org/2.0/snippets/evzijst/kypj -F files=image.png\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 149\n Content-Type: multipart/form-data; boundary=----------------------------ef8871065a86\n\n ------------------------------ef8871065a86\n Content-Disposition: form-data; name=\"files\"\n\n image.png\n ------------------------------ef8871065a86--\n\nThe explicit use of the `files` element in `multipart/related` and\n`multipart/form-data` is only required when deleting files.\nThe default mode of operation is for file parts to be processed,\nregardless of whether or not they are listed in `files`, as a\nconvenience to the client.", "operationId"=>"putSnippetsUsernameEncoded", "x-api-path-slug"=>"snippetsusernameencoded-id-put", "parameters"=>[{"in"=>"path", "name"=>"encoded_id", "description"=>"The snippets id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded"]}}, "/snippets/{username}/{encoded_id}/comments"=>{"get"=>{"summary"=>"Get Snippets Username Encoded Comments", "description"=>"Used to retrieve a paginated list of all comments for a specific\nsnippet.\n\nThis resource works identical to commit and pull request comments.\n\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.", "operationId"=>"getSnippetsUsernameEncodedComments", "x-api-path-slug"=>"snippetsusernameencoded-idcomments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Comments"]}, "parameters"=>{"summary"=>"Parameters Snippets Username Encoded Comments", "description"=>"Parameters snippets username encoded comments", "operationId"=>"parametersSnippetsUsernameEncodedComments", "x-api-path-slug"=>"snippetsusernameencoded-idcomments-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Comments"]}, "post"=>{"summary"=>"Add Snippets Username Encoded Comments", "description"=>"Creates a new comment.\n\nThe only required field in the body is `content.raw`.\n\nTo create a threaded reply to an existing comment, include `parent.id`.", "operationId"=>"postSnippetsUsernameEncodedComments", "x-api-path-slug"=>"snippetsusernameencoded-idcomments-post", "parameters"=>[{"in"=>"body", "name"=>"_body", "description"=>"The contents of the new comment", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Comments"]}}, "/snippets/{username}/{encoded_id}/comments/{comment_id}"=>{"delete"=>{"summary"=>"Delete Snippets Username Encoded Comments Comment", "description"=>"Deletes a snippet comment.\n\nComments can only be removed by their author.", "operationId"=>"deleteSnippetsUsernameEncodedCommentsComment", "x-api-path-slug"=>"snippetsusernameencoded-idcommentscomment-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Comments", "Comment"]}, "get"=>{"summary"=>"Get Snippets Username Encoded Comments Comment", "description"=>"Get snippets username encoded comments comment", "operationId"=>"getSnippetsUsernameEncodedCommentsComment", "x-api-path-slug"=>"snippetsusernameencoded-idcommentscomment-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Comments", "Comment"]}, "parameters"=>{"summary"=>"Parameters Snippets Username Encoded Comments Comment", "description"=>"Parameters snippets username encoded comments comment", "operationId"=>"parametersSnippetsUsernameEncodedCommentsComment", "x-api-path-slug"=>"snippetsusernameencoded-idcommentscomment-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Comments", "Comment"]}, "put"=>{"summary"=>"Update Snippets Username Encoded Comments Comment", "description"=>"Updates a comment.\n\nComments can only be updated by their author.", "operationId"=>"putSnippetsUsernameEncodedCommentsComment", "x-api-path-slug"=>"snippetsusernameencoded-idcommentscomment-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Comments", "Comment"]}}, "/snippets/{username}/{encoded_id}/commits"=>{"get"=>{"summary"=>"Get Snippets Username Encoded Commits", "description"=>"Returns the changes (commits) made on this snippet.", "operationId"=>"getSnippetsUsernameEncodedCommits", "x-api-path-slug"=>"snippetsusernameencoded-idcommits-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Commits"]}, "parameters"=>{"summary"=>"Parameters Snippets Username Encoded Commits", "description"=>"Parameters snippets username encoded commits", "operationId"=>"parametersSnippetsUsernameEncodedCommits", "x-api-path-slug"=>"snippetsusernameencoded-idcommits-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Commits"]}}, "/snippets/{username}/{encoded_id}/commits/{revision}"=>{"get"=>{"summary"=>"Get Snippets Username Encoded Commits Revision", "description"=>"Get snippets username encoded commits revision", "operationId"=>"getSnippetsUsernameEncodedCommitsRevision", "x-api-path-slug"=>"snippetsusernameencoded-idcommitsrevision-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Commits", "Revision"]}, "parameters"=>{"summary"=>"Parameters Snippets Username Encoded Commits Revision", "description"=>"Parameters snippets username encoded commits revision", "operationId"=>"parametersSnippetsUsernameEncodedCommitsRevision", "x-api-path-slug"=>"snippetsusernameencoded-idcommitsrevision-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Commits", "Revision"]}}, "/snippets/{username}/{encoded_id}/watch"=>{"delete"=>{"summary"=>"Delete Snippets Username Encoded Watch", "description"=>"Used to stop watching a specific snippet. Returns 204 (No Content)\nto indicate success.", "operationId"=>"deleteSnippetsUsernameEncodedWatch", "x-api-path-slug"=>"snippetsusernameencoded-idwatch-delete", "parameters"=>[{"in"=>"path", "name"=>"encoded_id", "description"=>"The snippet id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Watch"]}, "get"=>{"summary"=>"Get Snippets Username Encoded Watch", "description"=>"Used to check if the current user is watching a specific snippet.\n\nReturns 204 (No Content) if the user is watching the snippet and 404 if\nnot.\n\nHitting this endpoint anonymously always returns a 404.", "operationId"=>"getSnippetsUsernameEncodedWatch", "x-api-path-slug"=>"snippetsusernameencoded-idwatch-get", "parameters"=>[{"in"=>"path", "name"=>"encoded_id", "description"=>"The snippet id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Watch"]}, "parameters"=>{"summary"=>"Parameters Snippets Username Encoded Watch", "description"=>"Parameters snippets username encoded watch", "operationId"=>"parametersSnippetsUsernameEncodedWatch", "x-api-path-slug"=>"snippetsusernameencoded-idwatch-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Watch"]}, "put"=>{"summary"=>"Update Snippets Username Encoded Watch", "description"=>"Used to start watching a specific snippet. Returns 204 (No Content).", "operationId"=>"putSnippetsUsernameEncodedWatch", "x-api-path-slug"=>"snippetsusernameencoded-idwatch-put", "parameters"=>[{"in"=>"path", "name"=>"encoded_id", "description"=>"The snippet id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Watch"]}}, "/snippets/{username}/{encoded_id}/watchers"=>{"get"=>{"summary"=>"Get Snippets Username Encoded Watchers", "description"=>"Returns a paginated list of all users watching a specific snippet.", "operationId"=>"getSnippetsUsernameEncodedWatchers", "x-api-path-slug"=>"snippetsusernameencoded-idwatchers-get", "parameters"=>[{"in"=>"path", "name"=>"encoded_id", "description"=>"The snippet id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Watchers"]}, "parameters"=>{"summary"=>"Parameters Snippets Username Encoded Watchers", "description"=>"Parameters snippets username encoded watchers", "operationId"=>"parametersSnippetsUsernameEncodedWatchers", "x-api-path-slug"=>"snippetsusernameencoded-idwatchers-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Watchers"]}}, "/snippets/{username}/{encoded_id}/{node_id}"=>{"delete"=>{"summary"=>"Delete Snippets Username Encoded Node", "description"=>"Deletes the snippet.\n\nNote that this only works for versioned URLs that point to the latest\ncommit of the snippet. Pointing to an older commit results in a 405\nstatus code.\n\nTo delete a snippet, regardless of whether or not concurrent changes\nare being made to it, use `DELETE /snippets/{encoded_id}` instead.", "operationId"=>"deleteSnippetsUsernameEncodedNode", "x-api-path-slug"=>"snippetsusernameencoded-idnode-id-delete", "parameters"=>[{"in"=>"path", "name"=>"encoded_id", "description"=>"The snippets id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Node"]}, "get"=>{"summary"=>"Get Snippets Username Encoded Node", "description"=>"Identical to `GET /snippets/encoded_id`, except that this endpoint\ncan be used to retrieve the contents of the snippet as it was at an\nolder revision, while `/snippets/encoded_id` always returns the\nsnippet's current revision.\n\nNote that only the snippet's file contents are versioned, not its\nmeta data properties like the title.\n\nOther than that, the two endpoints are identical in behavior.", "operationId"=>"getSnippetsUsernameEncodedNode", "x-api-path-slug"=>"snippetsusernameencoded-idnode-id-get", "parameters"=>[{"in"=>"path", "name"=>"encoded_id", "description"=>"The snippets id"}, {"in"=>"path", "name"=>"node_id", "description"=>"A commit revision (SHA1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Node"]}, "parameters"=>{"summary"=>"Parameters Snippets Username Encoded Node", "description"=>"Parameters snippets username encoded node", "operationId"=>"parametersSnippetsUsernameEncodedNode", "x-api-path-slug"=>"snippetsusernameencoded-idnode-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Node"]}, "put"=>{"summary"=>"Update Snippets Username Encoded Node", "description"=>"Identical to `UPDATE /snippets/encoded_id`, except that this endpoint\ntakes an explicit commit revision. Only the snippet's \"HEAD\"/\"tip\"\n(most recent) version can be updated and requests on all other,\nolder revisions fail by returning a 405 status.\n\nUsage of this endpoint over the unrestricted `/snippets/encoded_id`\ncould be desired if the caller wants to be sure no concurrent\nmodifications have taken place between the moment of the UPDATE\nrequest and the original GET.\n\nThis can be considered a so-called \"Compare And Swap\", or CAS\noperation.\n\nOther than that, the two endpoints are identical in behavior.", "operationId"=>"putSnippetsUsernameEncodedNode", "x-api-path-slug"=>"snippetsusernameencoded-idnode-id-put", "parameters"=>[{"in"=>"path", "name"=>"encoded_id", "description"=>"The snippets id"}, {"in"=>"path", "name"=>"node_id", "description"=>"A commit revision (SHA1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Node"]}}, "/snippets/{username}/{encoded_id}/{node_id}/files/{path}"=>{"get"=>{"summary"=>"Get Snippets Username Encoded Node Files Path", "description"=>"Retrieves the raw contents of a specific file in the snippet. The\n`Content-Disposition` header will be \"attachment\" to avoid issues with\nmalevolent executable files.\n\nThe file's mime type is derived from its filename and returned in the\n`Content-Type` header.\n\nNote that for text files, no character encoding is included as part of\nthe content type.", "operationId"=>"getSnippetsUsernameEncodedNodeFilesPath", "x-api-path-slug"=>"snippetsusernameencoded-idnode-idfilespath-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Node", "", "Files", "Path"]}, "parameters"=>{"summary"=>"Parameters Snippets Username Encoded Node Files Path", "description"=>"Parameters snippets username encoded node files path", "operationId"=>"parametersSnippetsUsernameEncodedNodeFilesPath", "x-api-path-slug"=>"snippetsusernameencoded-idnode-idfilespath-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Node", "", "Files", "Path"]}}, "/snippets/{username}/{encoded_id}/{revision}/diff"=>{"get"=>{"summary"=>"Get Snippets Username Encoded Revision Diff", "description"=>"Returns the diff of the specified commit against its first parent.\n\nNote that this resource is different in functionality from the `patch`\nresource.\n\nThe differences between a diff and a patch are:\n\n* patches have a commit header with the username, message, etc\n* diffs support the optional `path=foo/bar.py` query param to filter the\n diff to just that one file diff (not supported for patches)\n* for a merge, the diff will show the diff between the merge commit and\n its first parent (identical to how PRs work), while patch returns a\n response containing separate patches for each commit on the second\n parent's ancestry, up to the oldest common ancestor (identical to\n its reachability).\n\nNote that the character encoding of the contents of the diff is\nunspecified as Git and Mercurial do not track this, making it hard for\nBitbucket to reliably determine this.", "operationId"=>"getSnippetsUsernameEncodedRevisionDiff", "x-api-path-slug"=>"snippetsusernameencoded-idrevisiondiff-get", "parameters"=>[{"in"=>"path", "name"=>"encoded_id", "description"=>"The snippet id"}, {"in"=>"query", "name"=>"path", "description"=>"When used, only one the diff of the specified file will be returned"}, {"in"=>"path", "name"=>"revision", "description"=>"A revspec expression"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Revision", "Diff"]}, "parameters"=>{"summary"=>"Parameters Snippets Username Encoded Revision Diff", "description"=>"Parameters snippets username encoded revision diff", "operationId"=>"parametersSnippetsUsernameEncodedRevisionDiff", "x-api-path-slug"=>"snippetsusernameencoded-idrevisiondiff-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Revision", "Diff"]}}, "/snippets/{username}/{encoded_id}/{revision}/patch"=>{"get"=>{"summary"=>"Get Snippets Username Encoded Revision Patch", "description"=>"Returns the patch of the specified commit against its first\nparent.\n\nNote that this resource is different in functionality from the `diff`\nresource.\n\nThe differences between a diff and a patch are:\n\n* patches have a commit header with the username, message, etc\n* diffs support the optional `path=foo/bar.py` query param to filter the\n diff to just that one file diff (not supported for patches)\n* for a merge, the diff will show the diff between the merge commit and\n its first parent (identical to how PRs work), while patch returns a\n response containing separate patches for each commit on the second\n parent's ancestry, up to the oldest common ancestor (identical to\n its reachability).\n\nNote that the character encoding of the contents of the patch is\nunspecified as Git and Mercurial do not track this, making it hard for\nBitbucket to reliably determine this.", "operationId"=>"getSnippetsUsernameEncodedRevisionPatch", "x-api-path-slug"=>"snippetsusernameencoded-idrevisionpatch-get", "parameters"=>[{"in"=>"path", "name"=>"encoded_id", "description"=>"The snippet id"}, {"in"=>"path", "name"=>"revision", "description"=>"A revspec expression"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Revision", "Patch"]}, "parameters"=>{"summary"=>"Parameters Snippets Username Encoded Revision Patch", "description"=>"Parameters snippets username encoded revision patch", "operationId"=>"parametersSnippetsUsernameEncodedRevisionPatch", "x-api-path-slug"=>"snippetsusernameencoded-idrevisionpatch-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snippets", "Username", "Encoded", "", "Revision", "Patch"]}}, "/teams"=>{"get"=>{"summary"=>"Get Teams", "description"=>"Returns all the teams that the authenticated user is associated\nwith.", "operationId"=>"getTeams", "x-api-path-slug"=>"teams-get", "parameters"=>[{"in"=>"query", "name"=>"role", "description"=>"Filters the teams based on the authenticated users role on each team"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams"]}, "parameters"=>{"summary"=>"Parameters Teams", "description"=>"Parameters teams", "operationId"=>"parametersTeams", "x-api-path-slug"=>"teams-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams"]}}, "/teams/{owner}/projects/"=>{"get"=>{"summary"=>"Get Teams Owner Projects", "description"=>"Get teams owner projects", "operationId"=>"getTeamsOwnerProjects", "x-api-path-slug"=>"teamsownerprojects-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Owner", "Projects"]}, "parameters"=>{"summary"=>"Parameters Teams Owner Projects", "description"=>"Parameters teams owner projects", "operationId"=>"parametersTeamsOwnerProjects", "x-api-path-slug"=>"teamsownerprojects-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Owner", "Projects"]}, "post"=>{"summary"=>"Add Teams Owner Projects", "description"=>"Creates a new project.\n\nNote that the avatar has to be embedded as either a data-url\nor a URL to an external image as shown in the examples below:\n\n```\n$ body=$(cat << EOF\n{\n \"name\": \"Mars Project\",\n \"key\": \"MARS\",\n \"description\": \"Software for colonizing mars.\",\n \"links\": {\n \"avatar\": {\n \"href\": \"data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/...\"\n }\n },\n \"is_private\": false\n}\nEOF\n)\n$ curl -H \"Content-Type: application/json\" \\\n -X POST \\\n -d \"$body\" \\\n https://api.bitbucket.org/2.0/teams/teams-in-space/projects/ | jq .\n{\n // Serialized project document\n}\n```\n\nor even:\n\n```\n$ body=$(cat << EOF\n{\n \"name\": \"Mars Project\",\n \"key\": \"MARS\",\n \"description\": \"Software for colonizing mars.\",\n \"links\": {\n \"avatar\": {\n \"href\": \"http://i.imgur.com/72tRx4w.gif\"\n }\n },\n \"is_private\": false\n}\nEOF\n)\n$ curl -H \"Content-Type: application/json\" \\\n -X POST \\\n -d \"$body\" \\\n https://api.bitbucket.org/2.0/teams/teams-in-space/projects/ | jq .\n{\n // Serialized project document\n}\n```", "operationId"=>"postTeamsOwnerProjects", "x-api-path-slug"=>"teamsownerprojects-post", "parameters"=>[{"in"=>"body", "name"=>"_body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Owner", "Projects"]}}, "/teams/{owner}/projects/{project_key}"=>{"delete"=>{"summary"=>"Delete Teams Owner Projects Project Key", "description"=>"Delete teams owner projects project key", "operationId"=>"deleteTeamsOwnerProjectsProjectKey", "x-api-path-slug"=>"teamsownerprojectsproject-key-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Owner", "Projects", "Project", "Key"]}, "get"=>{"summary"=>"Get Teams Owner Projects Project Key", "description"=>"Get teams owner projects project key", "operationId"=>"getTeamsOwnerProjectsProjectKey", "x-api-path-slug"=>"teamsownerprojectsproject-key-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Owner", "Projects", "Project", "Key"]}, "parameters"=>{"summary"=>"Parameters Teams Owner Projects Project Key", "description"=>"Parameters teams owner projects project key", "operationId"=>"parametersTeamsOwnerProjectsProjectKey", "x-api-path-slug"=>"teamsownerprojectsproject-key-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Owner", "Projects", "Project", "Key"]}, "put"=>{"summary"=>"Update Teams Owner Projects Project Key", "description"=>"Since this endpoint can be used to both update and to create a\nproject, the request body depends on the intent.\n\n### Creation\n\nSee the POST documentation for the project collection for an\nexample of the request body.\n\nNote: The `key` should not be specified in the body of request\n(since it is already present in the URL). The `name` is required,\neverything else is optional.\n\n### Update\n\nSee the POST documentation for the project collection for an\nexample of the request body.\n\nNote: The key is not required in the body (since it is already in\nthe URL). The key may be specified in the body, if the intent is\nto change the key itself. In such a scenario, the location of the\nproject is changed and is returned in the `Location` header of the\nresponse.", "operationId"=>"putTeamsOwnerProjectsProjectKey", "x-api-path-slug"=>"teamsownerprojectsproject-key-put", "parameters"=>[{"in"=>"body", "name"=>"_body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Owner", "Projects", "Project", "Key"]}}, "/teams/{username}"=>{"get"=>{"summary"=>"Get Teams Username", "description"=>"Gets the public information associated with a team.\n\nIf the team's profile is private, `location`, `website` and\n`created_on` elements are omitted.", "operationId"=>"getTeamsUsername", "x-api-path-slug"=>"teamsusername-get", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"The teams username or UUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username"]}, "parameters"=>{"summary"=>"Parameters Teams Username", "description"=>"Parameters teams username", "operationId"=>"parametersTeamsUsername", "x-api-path-slug"=>"teamsusername-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username"]}}, "/teams/{username}/followers"=>{"get"=>{"summary"=>"Get Teams Username Followers", "description"=>"Returns the list of accounts that are following this team.", "operationId"=>"getTeamsUsernameFollowers", "x-api-path-slug"=>"teamsusernamefollowers-get", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"The teams username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Followers"]}, "parameters"=>{"summary"=>"Parameters Teams Username Followers", "description"=>"Parameters teams username followers", "operationId"=>"parametersTeamsUsernameFollowers", "x-api-path-slug"=>"teamsusernamefollowers-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Followers"]}}, "/teams/{username}/following"=>{"get"=>{"summary"=>"Get Teams Username Following", "description"=>"Returns the list of accounts this team is following.", "operationId"=>"getTeamsUsernameFollowing", "x-api-path-slug"=>"teamsusernamefollowing-get", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"The teams username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Following"]}, "parameters"=>{"summary"=>"Parameters Teams Username Following", "description"=>"Parameters teams username following", "operationId"=>"parametersTeamsUsernameFollowing", "x-api-path-slug"=>"teamsusernamefollowing-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Following"]}}, "/teams/{username}/hooks"=>{"get"=>{"summary"=>"Get Teams Username Hooks", "description"=>"Returns a paginated list of webhooks installed on this team.", "operationId"=>"getTeamsUsernameHooks", "x-api-path-slug"=>"teamsusernamehooks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Hooks"]}, "parameters"=>{"summary"=>"Parameters Teams Username Hooks", "description"=>"Parameters teams username hooks", "operationId"=>"parametersTeamsUsernameHooks", "x-api-path-slug"=>"teamsusernamehooks-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Hooks"]}, "post"=>{"summary"=>"Add Teams Username Hooks", "description"=>"Creates a new webhook on the specified team.\n\nTeam webhooks are fired for events from all repositories belonging to\nthat team account.\n\nNote that only admins can install webhooks on teams.", "operationId"=>"postTeamsUsernameHooks", "x-api-path-slug"=>"teamsusernamehooks-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Hooks"]}}, "/teams/{username}/hooks/{uid}"=>{"delete"=>{"summary"=>"Delete Teams Username Hooks U", "description"=>"Deletes the specified webhook subscription from the given team\naccount.", "operationId"=>"deleteTeamsUsernameHooksU", "x-api-path-slug"=>"teamsusernamehooksuid-delete", "parameters"=>[{"in"=>"path", "name"=>"uid", "description"=>"The installed webhooks id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Hooks", "U"]}, "get"=>{"summary"=>"Get Teams Username Hooks U", "description"=>"Returns the webhook with the specified id installed on the given\nteam account.", "operationId"=>"getTeamsUsernameHooksU", "x-api-path-slug"=>"teamsusernamehooksuid-get", "parameters"=>[{"in"=>"path", "name"=>"uid", "description"=>"The installed webhooks id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Hooks", "U"]}, "parameters"=>{"summary"=>"Parameters Teams Username Hooks U", "description"=>"Parameters teams username hooks u", "operationId"=>"parametersTeamsUsernameHooksU", "x-api-path-slug"=>"teamsusernamehooksuid-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Hooks", "U"]}, "put"=>{"summary"=>"Update Teams Username Hooks U", "description"=>"Updates the specified webhook subscription.\n\nThe following properties can be mutated:\n\n* `description`\n* `url`\n* `active`\n* `events`", "operationId"=>"putTeamsUsernameHooksU", "x-api-path-slug"=>"teamsusernamehooksuid-put", "parameters"=>[{"in"=>"path", "name"=>"uid", "description"=>"The installed webhooks id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Hooks", "U"]}}, "/teams/{username}/members"=>{"get"=>{"summary"=>"Get Teams Username Members", "description"=>"All members of a team.\n\nReturns all members of the specified team. Any member of any of the\nteam's groups is considered a member of the team. This includes users\nin groups that may not actually have access to any of the team's\nrepositories.\n\nNote that members using the \"private profile\" feature are not included.", "operationId"=>"getTeamsUsernameMembers", "x-api-path-slug"=>"teamsusernamemembers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Members"]}, "parameters"=>{"summary"=>"Parameters Teams Username Members", "description"=>"Parameters teams username members", "operationId"=>"parametersTeamsUsernameMembers", "x-api-path-slug"=>"teamsusernamemembers-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Members"]}}, "/teams/{username}/pipelines_config/variables/"=>{"get"=>{"summary"=>"Get Teams Username Pipelines Config Variables", "description"=>"Get teams username pipelines config variables", "operationId"=>"getTeamsUsernamePipelinesConfigVariables", "x-api-path-slug"=>"teamsusernamepipelines-configvariables-get", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"The account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Pipelines", "Config", "Variables"]}, "post"=>{"summary"=>"Add Teams Username Pipelines Config Variables", "description"=>"Post teams username pipelines config variables", "operationId"=>"postTeamsUsernamePipelinesConfigVariables", "x-api-path-slug"=>"teamsusernamepipelines-configvariables-post", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"body", "name"=>"_body", "description"=>"The variable to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Pipelines", "Config", "Variables"]}}, "/teams/{username}/pipelines_config/variables/{variable_uuid}"=>{"delete"=>{"summary"=>"Delete Teams Username Pipelines Config Variables Variable Uu", "description"=>"Delete teams username pipelines config variables variable uu", "operationId"=>"deleteTeamsUsernamePipelinesConfigVariablesVariableUu", "x-api-path-slug"=>"teamsusernamepipelines-configvariablesvariable-uuid-delete", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"path", "name"=>"variable_uuid", "description"=>"The UUID of the variable to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Pipelines", "Config", "Variables", "Variable", "Uu"]}, "get"=>{"summary"=>"Get Teams Username Pipelines Config Variables Variable Uu", "description"=>"Get teams username pipelines config variables variable uu", "operationId"=>"getTeamsUsernamePipelinesConfigVariablesVariableUu", "x-api-path-slug"=>"teamsusernamepipelines-configvariablesvariable-uuid-get", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"path", "name"=>"variable_uuid", "description"=>"The UUID of the variable to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Pipelines", "Config", "Variables", "Variable", "Uu"]}, "put"=>{"summary"=>"Update Teams Username Pipelines Config Variables Variable Uu", "description"=>"Put teams username pipelines config variables variable uu", "operationId"=>"putTeamsUsernamePipelinesConfigVariablesVariableUu", "x-api-path-slug"=>"teamsusernamepipelines-configvariablesvariable-uuid-put", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"path", "name"=>"variable_uuid", "description"=>"The UUID of the variable"}, {"in"=>"body", "name"=>"_body", "description"=>"The updated variable", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Pipelines", "Config", "Variables", "Variable", "Uu"]}}, "/teams/{username}/repositories"=>{"get"=>{"summary"=>"Get Teams Username Repositories", "description"=>"All repositories owned by a user/team. This includes private\nrepositories, but filtered down to the ones that the calling user has\naccess to.", "operationId"=>"getTeamsUsernameRepositories", "x-api-path-slug"=>"teamsusernamerepositories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Repositories"]}, "parameters"=>{"summary"=>"Parameters Teams Username Repositories", "description"=>"Parameters teams username repositories", "operationId"=>"parametersTeamsUsernameRepositories", "x-api-path-slug"=>"teamsusernamerepositories-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams", "Username", "Repositories"]}}, "/user"=>{"get"=>{"summary"=>"Get User", "description"=>"Returns the currently logged in user.", "operationId"=>"getUser", "x-api-path-slug"=>"user-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "parameters"=>{"summary"=>"Parameters User", "description"=>"Parameters user", "operationId"=>"parametersUser", "x-api-path-slug"=>"user-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/user/emails"=>{"get"=>{"summary"=>"Get User Emails", "description"=>"Returns all the authenticated user's email addresses. Both\nconfirmed and unconfirmed.", "operationId"=>"getUserEmails", "x-api-path-slug"=>"useremails-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Emails"]}, "parameters"=>{"summary"=>"Parameters User Emails", "description"=>"Parameters user emails", "operationId"=>"parametersUserEmails", "x-api-path-slug"=>"useremails-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Emails"]}}, "/user/emails/{email}"=>{"get"=>{"summary"=>"Get User Emails Email", "description"=>"Returns details about a specific one of the authenticated user's\nemail addresses.\n\nDetails describe whether the address has been confirmed by the user and\nwhether it is the user's primary address or not.", "operationId"=>"getUserEmailsEmail", "x-api-path-slug"=>"useremailsemail-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Emails", "Email"]}, "parameters"=>{"summary"=>"Parameters User Emails Email", "description"=>"Parameters user emails email", "operationId"=>"parametersUserEmailsEmail", "x-api-path-slug"=>"useremailsemail-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Emails", "Email"]}}, "/users/{username}"=>{"get"=>{"summary"=>"Get Users Username", "description"=>"Gets the public information associated with a user account.\n\nIf the user's profile is private, `location`, `website` and\n`created_on` elements are omitted.", "operationId"=>"getUsersUsername", "x-api-path-slug"=>"usersusername-get", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"The accounts username or UUID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username"]}, "parameters"=>{"summary"=>"Parameters Users Username", "description"=>"Parameters users username", "operationId"=>"parametersUsersUsername", "x-api-path-slug"=>"usersusername-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username"]}}, "/users/{username}/followers"=>{"get"=>{"summary"=>"Get Users Username Followers", "description"=>"Returns the list of accounts that are following this team.", "operationId"=>"getUsersUsernameFollowers", "x-api-path-slug"=>"usersusernamefollowers-get", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"The accounts username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Followers"]}, "parameters"=>{"summary"=>"Parameters Users Username Followers", "description"=>"Parameters users username followers", "operationId"=>"parametersUsersUsernameFollowers", "x-api-path-slug"=>"usersusernamefollowers-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Followers"]}}, "/users/{username}/following"=>{"get"=>{"summary"=>"Get Users Username Following", "description"=>"Returns the list of accounts this user is following.", "operationId"=>"getUsersUsernameFollowing", "x-api-path-slug"=>"usersusernamefollowing-get", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"The users username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Following"]}, "parameters"=>{"summary"=>"Parameters Users Username Following", "description"=>"Parameters users username following", "operationId"=>"parametersUsersUsernameFollowing", "x-api-path-slug"=>"usersusernamefollowing-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Following"]}}, "/users/{username}/hooks"=>{"get"=>{"summary"=>"Get Users Username Hooks", "description"=>"Returns a paginated list of webhooks installed on this user account.", "operationId"=>"getUsersUsernameHooks", "x-api-path-slug"=>"usersusernamehooks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Hooks"]}, "parameters"=>{"summary"=>"Parameters Users Username Hooks", "description"=>"Parameters users username hooks", "operationId"=>"parametersUsersUsernameHooks", "x-api-path-slug"=>"usersusernamehooks-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Hooks"]}, "post"=>{"summary"=>"Add Users Username Hooks", "description"=>"Creates a new webhook on the specified user account.\n\nAccount-level webhooks are fired for events from all repositories\nbelonging to that account.\n\nNote that one can only register webhooks on one's own account, not that\nof others.", "operationId"=>"postUsersUsernameHooks", "x-api-path-slug"=>"usersusernamehooks-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Hooks"]}}, "/users/{username}/hooks/{uid}"=>{"delete"=>{"summary"=>"Delete Users Username Hooks U", "description"=>"Deletes the specified webhook subscription from the given user\naccount.", "operationId"=>"deleteUsersUsernameHooksU", "x-api-path-slug"=>"usersusernamehooksuid-delete", "parameters"=>[{"in"=>"path", "name"=>"uid", "description"=>"The installed webhooks id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Hooks", "U"]}, "get"=>{"summary"=>"Get Users Username Hooks U", "description"=>"Returns the webhook with the specified id installed on the given\nuser account.", "operationId"=>"getUsersUsernameHooksU", "x-api-path-slug"=>"usersusernamehooksuid-get", "parameters"=>[{"in"=>"path", "name"=>"uid", "description"=>"The installed webhooks id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Hooks", "U"]}, "parameters"=>{"summary"=>"Parameters Users Username Hooks U", "description"=>"Parameters users username hooks u", "operationId"=>"parametersUsersUsernameHooksU", "x-api-path-slug"=>"usersusernamehooksuid-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Hooks", "U"]}, "put"=>{"summary"=>"Update Users Username Hooks U", "description"=>"Updates the specified webhook subscription.\n\nThe following properties can be mutated:\n\n* `description`\n* `url`\n* `active`\n* `events`", "operationId"=>"putUsersUsernameHooksU", "x-api-path-slug"=>"usersusernamehooksuid-put", "parameters"=>[{"in"=>"path", "name"=>"uid", "description"=>"The installed webhooks id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Hooks", "U"]}}, "/users/{username}/pipelines_config/variables/"=>{"get"=>{"summary"=>"Get Users Username Pipelines Config Variables", "description"=>"Get users username pipelines config variables", "operationId"=>"getUsersUsernamePipelinesConfigVariables", "x-api-path-slug"=>"usersusernamepipelines-configvariables-get", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"The account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Pipelines", "Config", "Variables"]}, "post"=>{"summary"=>"Add Users Username Pipelines Config Variables", "description"=>"Post users username pipelines config variables", "operationId"=>"postUsersUsernamePipelinesConfigVariables", "x-api-path-slug"=>"usersusernamepipelines-configvariables-post", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"body", "name"=>"_body", "description"=>"The variable to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Pipelines", "Config", "Variables"]}}, "/users/{username}/pipelines_config/variables/{variable_uuid}"=>{"delete"=>{"summary"=>"Delete Users Username Pipelines Config Variables Variable Uu", "description"=>"Delete users username pipelines config variables variable uu", "operationId"=>"deleteUsersUsernamePipelinesConfigVariablesVariableUu", "x-api-path-slug"=>"usersusernamepipelines-configvariablesvariable-uuid-delete", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"path", "name"=>"variable_uuid", "description"=>"The UUID of the variable to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Pipelines", "Config", "Variables", "Variable", "Uu"]}, "get"=>{"summary"=>"Get Users Username Pipelines Config Variables Variable Uu", "description"=>"Get users username pipelines config variables variable uu", "operationId"=>"getUsersUsernamePipelinesConfigVariablesVariableUu", "x-api-path-slug"=>"usersusernamepipelines-configvariablesvariable-uuid-get", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"path", "name"=>"variable_uuid", "description"=>"The UUID of the variable to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Pipelines", "Config", "Variables", "Variable", "Uu"]}, "put"=>{"summary"=>"Update Users Username Pipelines Config Variables Variable Uu", "description"=>"Put users username pipelines config variables variable uu", "operationId"=>"putUsersUsernamePipelinesConfigVariablesVariableUu", "x-api-path-slug"=>"usersusernamepipelines-configvariablesvariable-uuid-put", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"The account"}, {"in"=>"path", "name"=>"variable_uuid", "description"=>"The UUID of the variable"}, {"in"=>"body", "name"=>"_body", "description"=>"The updated variable", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Pipelines", "Config", "Variables", "Variable", "Uu"]}}, "/users/{username}/repositories"=>{"get"=>{"summary"=>"Get Users Username Repositories", "description"=>"All repositories owned by a user/team. This includes private\nrepositories, but filtered down to the ones that the calling user has\naccess to.", "operationId"=>"getUsersUsernameRepositories", "x-api-path-slug"=>"usersusernamerepositories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Repositories"]}, "parameters"=>{"summary"=>"Parameters Users Username Repositories", "description"=>"Parameters users username repositories", "operationId"=>"parametersUsersUsernameRepositories", "x-api-path-slug"=>"usersusernamerepositories-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Username", "Repositories"]}}}}, "apis"=>{"name"=>"Bitbucket", "x-slug"=>"bitbucket", "description"=>"Collaborate on code with inline comments and pull requests. Manage and share your Git repositories to build and ship software, as a team.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19810-bitbucket.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"901", "tags"=>"Code,Developers,Enterprise,Imports,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bitbucket/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Bitbucket", "x-api-slug"=>"bitbucket", "description"=>"Collaborate on code with inline comments and pull requests. Manage and share your Git repositories to build and ship software, as a team.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19810-bitbucket.jpg", "humanURL"=>"http://bitbucket.org", "baseURL"=>"https://api.bitbucket.org//2.0", "tags"=>"Code,Developers,Enterprise,Imports,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bitbucket/usersusernamerepositories-parameters-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bitbucket/bitbucket-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/bitbucket"}, {"type"=>"x-developer", "url"=>"https://developer.atlassian.com/cloud/bitbucket/"}, {"type"=>"x-documentation", "url"=>"https://confluence.atlassian.com/bitbucket/bitbucket-cloud-documentation-221448814.html?_ga=2.77295890.629375793.1519179030-1077111323.1516485126"}, {"type"=>"x-status", "url"=>"https://status.bitbucket.org/?_ga=2.76365714.629375793.1519179030-1077111323.1516485126"}, {"type"=>"x-support", "url"=>"https://support.atlassian.com/bitbucket-cloud/"}, {"type"=>"x-terms-of-service", "url"=>"https://www.atlassian.com/legal/customer-agreement?_ga=2.76365714.629375793.1519179030-1077111323.1516485126"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/bitbucket"}, {"type"=>"x-website", "url"=>"http://bitbucket.org"}, {"type"=>"x-website", "url"=>"https://bitbucket.org/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
appveyor-ci{"app-veyor-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AppVeyor CI", "x-complete"=>1, "info"=>{"title"=>"App Veyor", "description"=>"appveyor-is-a-hosted-continuous-integration-service-which-runs-on-microsoftwindows---the-appveyor-rest-api-provides-a-restful-way-to-interact-with-theappveyor-service---this-includes-managing-projects-builds-deploymentsand-the-teams-that-build-them-additional-help-and-discussion-of-the-appveyor-rest-api-is-available-athttphelp-appveyor-comdiscussionsthis-swagger-definition-is-an-unofficial-description-of-the-appveyorrest-api-maintained-at-httpsgithub-comkevinoidappveyorswaggerplease-report-any-issues-or-suggestions-for-this-swagger-definition-athttpsgithub-comkevinoidappveyorswaggerissuesnew-api-conventionsfields-which-are-missing-from-update-operations-put-requests-aretypically-reset-to-their-default-values---so-although-most-fields-are-nottechnically-required-they-should-usually-be-specified-in-practice-", "termsOfService"=>"https://www.appveyor.com/terms-of-service/", "contact"=>{"name"=>"AppVeyor Team", "url"=>"https://www.appveyor.com/about/", "email"=>"team@appveyor.com"}, "version"=>"0.20170106.0"}, "host"=>"ci.appveyor.com", "basePath"=>"/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/account/encrypt"=>{"post"=>{"summary"=>"Post Account Encrypt", "description"=>"Post account encrypt.", "operationId"=>"postAccountEncrypt", "x-api-path-slug"=>"accountencrypt-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Encrypt"]}}, "/buildjobs/{jobId}/artifacts"=>{"get"=>{"summary"=>"Get Buildjobs Jobid Artifacts", "description"=>"Get buildjobs jobid artifacts.", "operationId"=>"getBuildjobsJobArtifacts", "x-api-path-slug"=>"buildjobsjobidartifacts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds", "Jobs", "", "Artifacts"]}, "parameters"=>{"summary"=>"Parameters Buildjobs Jobid Artifacts", "description"=>"Parameters buildjobs jobid artifacts.", "operationId"=>"parametersBuildjobsJobArtifacts", "x-api-path-slug"=>"buildjobsjobidartifacts-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds", "Jobs", "", "Artifacts"]}}, "/buildjobs/{jobId}/artifacts/{artifactFileName}"=>{"get"=>{"summary"=>"Get Buildjobs Jobid Artifacts Artifactfilename", "description"=>"Get buildjobs jobid artifacts artifactfilename.", "operationId"=>"getBuildjobsJobArtifactsArtifactfilename", "x-api-path-slug"=>"buildjobsjobidartifactsartifactfilename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds", "Jobs", "", "Artifacts", "Files"]}, "parameters"=>{"summary"=>"Parameters Buildjobs Jobid Artifacts Artifactfilename", "description"=>"Parameters buildjobs jobid artifacts artifactfilename.", "operationId"=>"parametersBuildjobsJobArtifactsArtifactfilename", "x-api-path-slug"=>"buildjobsjobidartifactsartifactfilename-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds", "Jobs", "", "Artifacts", "Files"]}}, "/buildjobs/{jobId}/log"=>{"get"=>{"summary"=>"Get Buildjobs Jobid Log", "description"=>"Get buildjobs jobid log.", "operationId"=>"getBuildjobsJobLog", "x-api-path-slug"=>"buildjobsjobidlog-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds", "Jobs", "", "Log"]}, "parameters"=>{"summary"=>"Parameters Buildjobs Jobid Log", "description"=>"Parameters buildjobs jobid log.", "operationId"=>"parametersBuildjobsJobLog", "x-api-path-slug"=>"buildjobsjobidlog-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds", "Jobs", "", "Log"]}}, "/builds"=>{"post"=>{"summary"=>"Post Builds", "description"=>"Post builds.", "operationId"=>"postBuilds", "x-api-path-slug"=>"builds-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds"]}}, "/builds/{accountName}/{projectSlug}/{buildVersion}"=>{"delete"=>{"summary"=>"Delete Builds Accountname Projectslug Buildversion", "description"=>"Delete builds accountname projectslug buildversion.", "operationId"=>"deleteBuildsAccountnameProjectslugBuildversion", "x-api-path-slug"=>"buildsaccountnameprojectslugbuildversion-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds", "AccountName", "ProjectSlug", "BuildVersion"]}, "parameters"=>{"summary"=>"Parameters Builds Accountname Projectslug Buildversion", "description"=>"Parameters builds accountname projectslug buildversion.", "operationId"=>"parametersBuildsAccountnameProjectslugBuildversion", "x-api-path-slug"=>"buildsaccountnameprojectslugbuildversion-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Builds", "AccountName", "ProjectSlug", "BuildVersion"]}}, "/collaborators"=>{"get"=>{"summary"=>"Get Collaborators", "description"=>"Get collaborators.", "operationId"=>"getCollaborators", "x-api-path-slug"=>"collaborators-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collaborators"]}, "post"=>{"summary"=>"Post Collaborators", "description"=>"Post collaborators.", "operationId"=>"postCollaborators", "x-api-path-slug"=>"collaborators-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collaborators"]}, "put"=>{"summary"=>"Put Collaborators", "description"=>"Put collaborators.", "operationId"=>"putCollaborators", "x-api-path-slug"=>"collaborators-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collaborators"]}}, "/collaborators/{userId}"=>{"delete"=>{"summary"=>"Delete Collaborators Userid", "description"=>"Delete collaborators userid.", "operationId"=>"deleteCollaboratorsUser", "x-api-path-slug"=>"collaboratorsuserid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collaborators", "Users"]}, "get"=>{"summary"=>"Get Collaborators Userid", "description"=>"Get collaborators userid.", "operationId"=>"getCollaboratorsUser", "x-api-path-slug"=>"collaboratorsuserid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collaborators", "Users"]}, "parameters"=>{"summary"=>"Parameters Collaborators Userid", "description"=>"Parameters collaborators userid.", "operationId"=>"parametersCollaboratorsUser", "x-api-path-slug"=>"collaboratorsuserid-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collaborators", "Users"]}}, "/deployments"=>{"post"=>{"summary"=>"Post Deployments", "description"=>"Post deployments.", "operationId"=>"postDeployments", "x-api-path-slug"=>"deployments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/deployments/stop"=>{"delete"=>{"summary"=>"Delete Deployments Stop", "description"=>"Delete deployments stop.", "operationId"=>"deleteDeploymentsStop", "x-api-path-slug"=>"deploymentsstop-delete", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments", "Stop"]}}, "/deployments/{deploymentId}"=>{"get"=>{"summary"=>"Get Deployments Deploymentid", "description"=>"Get deployments deploymentid.", "operationId"=>"getDeploymentsDeployment", "x-api-path-slug"=>"deploymentsdeploymentid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments", "DeploymentId"]}, "parameters"=>{"summary"=>"Parameters Deployments Deploymentid", "description"=>"Parameters deployments deploymentid.", "operationId"=>"parametersDeploymentsDeployment", "x-api-path-slug"=>"deploymentsdeploymentid-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments", "DeploymentId"]}}, "/environments"=>{"get"=>{"summary"=>"Get Environments", "description"=>"Get environments.", "operationId"=>"getEnvironments", "x-api-path-slug"=>"environments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}, "post"=>{"summary"=>"Post Environments", "description"=>"Post environments.", "operationId"=>"postEnvironments", "x-api-path-slug"=>"environments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}, "put"=>{"summary"=>"Put Environments", "description"=>"Put environments.", "operationId"=>"putEnvironments", "x-api-path-slug"=>"environments-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/environments/{deploymentEnvironmentId}"=>{"delete"=>{"summary"=>"Delete Environments Deploymentenvironmentid", "description"=>"Delete environments deploymentenvironmentid.", "operationId"=>"deleteEnvironmentsDeploymentenvironment", "x-api-path-slug"=>"environmentsdeploymentenvironmentid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "DeploymentEnvironmentId"]}, "parameters"=>{"summary"=>"Parameters Environments Deploymentenvironmentid", "description"=>"Parameters environments deploymentenvironmentid.", "operationId"=>"parametersEnvironmentsDeploymentenvironment", "x-api-path-slug"=>"environmentsdeploymentenvironmentid-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "DeploymentEnvironmentId"]}}, "/environments/{deploymentEnvironmentId}/deployments"=>{"get"=>{"summary"=>"Get Environments Deploymentenvironmentid Deployments", "description"=>"Get environments deploymentenvironmentid deployments.", "operationId"=>"getEnvironmentsDeploymentenvironmentDeployments", "x-api-path-slug"=>"environmentsdeploymentenvironmentiddeployments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "DeploymentEnvironmentId", "Deployments"]}, "parameters"=>{"summary"=>"Parameters Environments Deploymentenvironmentid Deployments", "description"=>"Parameters environments deploymentenvironmentid deployments.", "operationId"=>"parametersEnvironmentsDeploymentenvironmentDeployments", "x-api-path-slug"=>"environmentsdeploymentenvironmentiddeployments-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "DeploymentEnvironmentId", "Deployments"]}}, "/environments/{deploymentEnvironmentId}/settings"=>{"get"=>{"summary"=>"Get Environments Deploymentenvironmentid Settings", "description"=>"Get environments deploymentenvironmentid settings.", "operationId"=>"getEnvironmentsDeploymentenvironmentSettings", "x-api-path-slug"=>"environmentsdeploymentenvironmentidsettings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "DeploymentEnvironmentId", "Settings"]}, "parameters"=>{"summary"=>"Parameters Environments Deploymentenvironmentid Settings", "description"=>"Parameters environments deploymentenvironmentid settings.", "operationId"=>"parametersEnvironmentsDeploymentenvironmentSettings", "x-api-path-slug"=>"environmentsdeploymentenvironmentidsettings-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments", "DeploymentEnvironmentId", "Settings"]}}, "/projects"=>{"get"=>{"summary"=>"Get Projects", "description"=>"Get projects.", "operationId"=>"getProjects", "x-api-path-slug"=>"projects-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}, "post"=>{"summary"=>"Post Projects", "description"=>"Post projects.", "operationId"=>"postProjects", "x-api-path-slug"=>"projects-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}, "put"=>{"summary"=>"Put Projects", "description"=>"Put projects.", "operationId"=>"putProjects", "x-api-path-slug"=>"projects-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/projects/status/{badgeRepoProvider}/{repoAccountName}/{repoSlug}"=>{"get"=>{"summary"=>"Get Projects Status Badgerepoprover Repoaccountname Reposlug", "description"=>"Get projects status badgerepoprover repoaccountname reposlug.", "operationId"=>"getProjectsStatusBadgerepoproverRepoaccountnameReposlug", "x-api-path-slug"=>"projectsstatusbadgerepoproviderrepoaccountnamereposlug-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Status", "BadgeRepoProvider", "RepoAccountName", "RepoSlug"]}, "parameters"=>{"summary"=>"Parameters Projects Status Badgerepoprover Repoaccountname Reposlug", "description"=>"Parameters projects status badgerepoprover repoaccountname reposlug.", "operationId"=>"parametersProjectsStatusBadgerepoproverRepoaccountnameReposlug", "x-api-path-slug"=>"projectsstatusbadgerepoproviderrepoaccountnamereposlug-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Status", "BadgeRepoProvider", "RepoAccountName", "RepoSlug"]}}, "/projects/status/{statusBadgeId}"=>{"get"=>{"summary"=>"Get Projects Status Statusbadgeid", "description"=>"Get projects status statusbadgeid.", "operationId"=>"getProjectsStatusStatusbadge", "x-api-path-slug"=>"projectsstatusstatusbadgeid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Status", "StatusBadgeId"]}, "parameters"=>{"summary"=>"Parameters Projects Status Statusbadgeid", "description"=>"Parameters projects status statusbadgeid.", "operationId"=>"parametersProjectsStatusStatusbadge", "x-api-path-slug"=>"projectsstatusstatusbadgeid-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Status", "StatusBadgeId"]}}, "/projects/status/{statusBadgeId}/branch/{buildBranch}"=>{"get"=>{"summary"=>"Get Projects Status Statusbadgeid Branch Buildbranch", "description"=>"Get projects status statusbadgeid branch buildbranch.", "operationId"=>"getProjectsStatusStatusbadgeBranchBuildbranch", "x-api-path-slug"=>"projectsstatusstatusbadgeidbranchbuildbranch-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Status", "StatusBadgeId", "Branch", "BuildBranch"]}, "parameters"=>{"summary"=>"Parameters Projects Status Statusbadgeid Branch Buildbranch", "description"=>"Parameters projects status statusbadgeid branch buildbranch.", "operationId"=>"parametersProjectsStatusStatusbadgeBranchBuildbranch", "x-api-path-slug"=>"projectsstatusstatusbadgeidbranchbuildbranch-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Status", "StatusBadgeId", "Branch", "BuildBranch"]}}, "/projects/{accountName}/{projectSlug}"=>{"delete"=>{"summary"=>"Delete Projects Accountname Projectslug", "description"=>"Delete projects accountname projectslug.", "operationId"=>"deleteProjectsAccountnameProjectslug", "x-api-path-slug"=>"projectsaccountnameprojectslug-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug"]}, "get"=>{"summary"=>"Get Projects Accountname Projectslug", "description"=>"Get projects accountname projectslug.", "operationId"=>"getProjectsAccountnameProjectslug", "x-api-path-slug"=>"projectsaccountnameprojectslug-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug"]}, "parameters"=>{"summary"=>"Parameters Projects Accountname Projectslug", "description"=>"Parameters projects accountname projectslug.", "operationId"=>"parametersProjectsAccountnameProjectslug", "x-api-path-slug"=>"projectsaccountnameprojectslug-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug"]}}, "/projects/{accountName}/{projectSlug}/artifacts/{artifactFileName}"=>{"get"=>{"summary"=>"Get Projects Accountname Projectslug Artifacts Artifactfilename", "description"=>"Get projects accountname projectslug artifacts artifactfilename.", "operationId"=>"getProjectsAccountnameProjectslugArtifactsArtifactfilename", "x-api-path-slug"=>"projectsaccountnameprojectslugartifactsartifactfilename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Artifacts", "Files"]}, "parameters"=>{"summary"=>"Parameters Projects Accountname Projectslug Artifacts Artifactfilename", "description"=>"Parameters projects accountname projectslug artifacts artifactfilename.", "operationId"=>"parametersProjectsAccountnameProjectslugArtifactsArtifactfilename", "x-api-path-slug"=>"projectsaccountnameprojectslugartifactsartifactfilename-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Artifacts", "Files"]}}, "/projects/{accountName}/{projectSlug}/branch/{buildBranch}"=>{"get"=>{"summary"=>"Get Projects Accountname Projectslug Branch Buildbranch", "description"=>"Get projects accountname projectslug branch buildbranch.", "operationId"=>"getProjectsAccountnameProjectslugBranchBuildbranch", "x-api-path-slug"=>"projectsaccountnameprojectslugbranchbuildbranch-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Branch", "BuildBranch"]}, "parameters"=>{"summary"=>"Parameters Projects Accountname Projectslug Branch Buildbranch", "description"=>"Parameters projects accountname projectslug branch buildbranch.", "operationId"=>"parametersProjectsAccountnameProjectslugBranchBuildbranch", "x-api-path-slug"=>"projectsaccountnameprojectslugbranchbuildbranch-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Branch", "BuildBranch"]}}, "/projects/{accountName}/{projectSlug}/build/{buildVersion}"=>{"get"=>{"summary"=>"Get Projects Accountname Projectslug Build Buildversion", "description"=>"Get projects accountname projectslug build buildversion.", "operationId"=>"getProjectsAccountnameProjectslugBuildBuildversion", "x-api-path-slug"=>"projectsaccountnameprojectslugbuildbuildversion-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Build", "BuildVersion"]}, "parameters"=>{"summary"=>"Parameters Projects Accountname Projectslug Build Buildversion", "description"=>"Parameters projects accountname projectslug build buildversion.", "operationId"=>"parametersProjectsAccountnameProjectslugBuildBuildversion", "x-api-path-slug"=>"projectsaccountnameprojectslugbuildbuildversion-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Build", "BuildVersion"]}}, "/projects/{accountName}/{projectSlug}/buildcache"=>{"delete"=>{"summary"=>"Delete Projects Accountname Projectslug Buildcache", "description"=>"Delete projects accountname projectslug buildcache.", "operationId"=>"deleteProjectsAccountnameProjectslugBuildcache", "x-api-path-slug"=>"projectsaccountnameprojectslugbuildcache-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Buildcache"]}, "parameters"=>{"summary"=>"Parameters Projects Accountname Projectslug Buildcache", "description"=>"Parameters projects accountname projectslug buildcache.", "operationId"=>"parametersProjectsAccountnameProjectslugBuildcache", "x-api-path-slug"=>"projectsaccountnameprojectslugbuildcache-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Buildcache"]}}, "/projects/{accountName}/{projectSlug}/deployments"=>{"get"=>{"summary"=>"Get Projects Accountname Projectslug Deployments", "description"=>"Get projects accountname projectslug deployments.", "operationId"=>"getProjectsAccountnameProjectslugDeployments", "x-api-path-slug"=>"projectsaccountnameprojectslugdeployments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Deployments"]}, "parameters"=>{"summary"=>"Parameters Projects Accountname Projectslug Deployments", "description"=>"Parameters projects accountname projectslug deployments.", "operationId"=>"parametersProjectsAccountnameProjectslugDeployments", "x-api-path-slug"=>"projectsaccountnameprojectslugdeployments-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Deployments"]}}, "/projects/{accountName}/{projectSlug}/history"=>{"get"=>{"summary"=>"Get Projects Accountname Projectslug History", "description"=>"Get projects accountname projectslug history.", "operationId"=>"getProjectsAccountnameProjectslugHistory", "x-api-path-slug"=>"projectsaccountnameprojectslughistory-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "History"]}, "parameters"=>{"summary"=>"Parameters Projects Accountname Projectslug History", "description"=>"Parameters projects accountname projectslug history.", "operationId"=>"parametersProjectsAccountnameProjectslugHistory", "x-api-path-slug"=>"projectsaccountnameprojectslughistory-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "History"]}}, "/projects/{accountName}/{projectSlug}/settings"=>{"get"=>{"summary"=>"Get Projects Accountname Projectslug Settings", "description"=>"Get projects accountname projectslug settings.", "operationId"=>"getProjectsAccountnameProjectslugSettings", "x-api-path-slug"=>"projectsaccountnameprojectslugsettings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Settings"]}, "parameters"=>{"summary"=>"Parameters Projects Accountname Projectslug Settings", "description"=>"Parameters projects accountname projectslug settings.", "operationId"=>"parametersProjectsAccountnameProjectslugSettings", "x-api-path-slug"=>"projectsaccountnameprojectslugsettings-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Settings"]}}, "/projects/{accountName}/{projectSlug}/settings/build-number"=>{"parameters"=>{"summary"=>"Parameters Projects Accountname Projectslug Settings Build Number", "description"=>"Parameters projects accountname projectslug settings build number.", "operationId"=>"parametersProjectsAccountnameProjectslugSettingsBuildNumber", "x-api-path-slug"=>"projectsaccountnameprojectslugsettingsbuildnumber-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Settings", "Build", "Number"]}, "put"=>{"summary"=>"Put Projects Accountname Projectslug Settings Build Number", "description"=>"Put projects accountname projectslug settings build number.", "operationId"=>"putProjectsAccountnameProjectslugSettingsBuildNumber", "x-api-path-slug"=>"projectsaccountnameprojectslugsettingsbuildnumber-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Settings", "Build", "Number"]}}, "/projects/{accountName}/{projectSlug}/settings/environment-variables"=>{"get"=>{"summary"=>"Get Projects Accountname Projectslug Settings Environment Variables", "description"=>"Get projects accountname projectslug settings environment variables.", "operationId"=>"getProjectsAccountnameProjectslugSettingsEnvironmentVariables", "x-api-path-slug"=>"projectsaccountnameprojectslugsettingsenvironmentvariables-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Settings", "Environment", "Variables"]}, "parameters"=>{"summary"=>"Parameters Projects Accountname Projectslug Settings Environment Variables", "description"=>"Parameters projects accountname projectslug settings environment variables.", "operationId"=>"parametersProjectsAccountnameProjectslugSettingsEnvironmentVariables", "x-api-path-slug"=>"projectsaccountnameprojectslugsettingsenvironmentvariables-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Settings", "Environment", "Variables"]}, "put"=>{"summary"=>"Put Projects Accountname Projectslug Settings Environment Variables", "description"=>"Put projects accountname projectslug settings environment variables.", "operationId"=>"putProjectsAccountnameProjectslugSettingsEnvironmentVariables", "x-api-path-slug"=>"projectsaccountnameprojectslugsettingsenvironmentvariables-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Settings", "Environment", "Variables"]}}, "/projects/{accountName}/{projectSlug}/settings/yaml"=>{"get"=>{"summary"=>"Get Projects Accountname Projectslug Settings Yaml", "description"=>"Get projects accountname projectslug settings yaml.", "operationId"=>"getProjectsAccountnameProjectslugSettingsYaml", "x-api-path-slug"=>"projectsaccountnameprojectslugsettingsyaml-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Settings", "Yaml"]}, "parameters"=>{"summary"=>"Parameters Projects Accountname Projectslug Settings Yaml", "description"=>"Parameters projects accountname projectslug settings yaml.", "operationId"=>"parametersProjectsAccountnameProjectslugSettingsYaml", "x-api-path-slug"=>"projectsaccountnameprojectslugsettingsyaml-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Settings", "Yaml"]}, "put"=>{"summary"=>"Put Projects Accountname Projectslug Settings Yaml", "description"=>"Put projects accountname projectslug settings yaml.", "operationId"=>"putProjectsAccountnameProjectslugSettingsYaml", "x-api-path-slug"=>"projectsaccountnameprojectslugsettingsyaml-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The body of requests should contain YAML data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "AccountName", "ProjectSlug", "Settings", "Yaml"]}}, "/roles"=>{"get"=>{"summary"=>"Get Roles", "description"=>"Get roles.", "operationId"=>"getRoles", "x-api-path-slug"=>"roles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles"]}, "post"=>{"summary"=>"Post Roles", "description"=>"Post roles.", "operationId"=>"postRoles", "x-api-path-slug"=>"roles-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles"]}, "put"=>{"summary"=>"Put Roles", "description"=>"Put roles.", "operationId"=>"putRoles", "x-api-path-slug"=>"roles-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles"]}}, "/roles/{roleId}"=>{"delete"=>{"summary"=>"Delete Roles Roleid", "description"=>"Delete roles roleid.", "operationId"=>"deleteRolesRole", "x-api-path-slug"=>"rolesroleid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles", "RoleId"]}, "get"=>{"summary"=>"Get Roles Roleid", "description"=>"Get roles roleid.", "operationId"=>"getRolesRole", "x-api-path-slug"=>"rolesroleid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles", "RoleId"]}, "parameters"=>{"summary"=>"Parameters Roles Roleid", "description"=>"Parameters roles roleid.", "operationId"=>"parametersRolesRole", "x-api-path-slug"=>"rolesroleid-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles", "RoleId"]}}, "/users"=>{"get"=>{"summary"=>"Get Users", "description"=>"Get users.", "operationId"=>"getUsers", "x-api-path-slug"=>"users-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "post"=>{"summary"=>"Post Users", "description"=>"Post users.", "operationId"=>"postUsers", "x-api-path-slug"=>"users-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "put"=>{"summary"=>"Put Users", "description"=>"Put users.", "operationId"=>"putUsers", "x-api-path-slug"=>"users-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/{userId}"=>{"delete"=>{"summary"=>"Delete Users Userid", "description"=>"Delete users userid.", "operationId"=>"deleteUsersUser", "x-api-path-slug"=>"usersuserid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Users"]}, "get"=>{"summary"=>"Get Users Userid", "description"=>"Get users userid.", "operationId"=>"getUsersUser", "x-api-path-slug"=>"usersuserid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Users"]}, "parameters"=>{"summary"=>"Parameters Users Userid", "description"=>"Parameters users userid.", "operationId"=>"parametersUsersUser", "x-api-path-slug"=>"usersuserid-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Users"]}}, "/projects/status/{webhookId}"=>{"get"=>{"summary"=>"Get Projects Status Webhookid", "description"=>"Get projects status webhookid.", "operationId"=>"getProjectsStatusWebhook", "x-api-path-slug"=>"projectsstatuswebhookid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Status", "WebhookId"]}, "parameters"=>{"summary"=>"Parameters Projects Status Webhookid", "description"=>"Parameters projects status webhookid.", "operationId"=>"parametersProjectsStatusWebhook", "x-api-path-slug"=>"projectsstatuswebhookid-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Status", "WebhookId"]}}, "/projects/status/{webhookId}/branch/{buildBranch}"=>{"get"=>{"summary"=>"Get Projects Status Webhookid Branch Buildbranch", "description"=>"Get projects status webhookid branch buildbranch.", "operationId"=>"getProjectsStatusWebhookBranchBuildbranch", "x-api-path-slug"=>"projectsstatuswebhookidbranchbuildbranch-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Status", "WebhookId", "Branch", "BuildBranch"]}, "parameters"=>{"summary"=>"Parameters Projects Status Webhookid Branch Buildbranch", "description"=>"Parameters projects status webhookid branch buildbranch.", "operationId"=>"parametersProjectsStatusWebhookBranchBuildbranch", "x-api-path-slug"=>"projectsstatuswebhookidbranchbuildbranch-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "Status", "WebhookId", "Branch", "BuildBranch"]}}}}, "apis"=>{"name"=>"AppVeyor CI", "x-slug"=>"appveyor-ci", "description"=>"We provide continuous integration tools for Windows developers. The service is offered for free to open-source projects, we offer subscriptions for private projects and AppVeyor Enterprise installations on customer premises.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28368-app-veyor.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"35479", "tags"=>"API Service Provider,Orchestration,Profiles,Relative Data,SaaS,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"appveyor-ci/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"App Veyor", "x-api-slug"=>"app-veyor", "description"=>"We provide continuous integration tools for Windows developers. The service is offered for free to open-source projects, we offer subscriptions for private projects and AppVeyor Enterprise installations on customer premises.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28368-app-veyor.jpg", "humanURL"=>"http://appveyor.com", "baseURL"=>"https://ci.appveyor.com//api", "tags"=>"API Service Provider,Orchestration,Profiles,Relative Data,SaaS,Service API,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/appveyor-ci/app-veyor-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/appveyor-systems-inc"}, {"type"=>"x-documentation", "url"=>"https://www.appveyor.com/docs/"}, {"type"=>"x-email", "url"=>"jobs@appveyor.com"}, {"type"=>"x-email", "url"=>"team@appveyor.com"}, {"type"=>"x-email", "url"=>"privacy@appveyor.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/appveyor"}, {"type"=>"x-website", "url"=>"http://appveyor.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-task-queue{"google-task-queue-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Task Queue", "x-complete"=>1, "info"=>{"title"=>"TaskQueue", "description"=>"accesses-a-google-app-engine-pull-task-queue-over-rest-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1beta2"}, "host"=>"www.googleapis.com", "basePath"=>"/taskqueue/v1beta2/projects", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{project}/taskqueues/{taskqueue}"=>{"get"=>{"summary"=>"Get Task Queues", "description"=>"Get detailed information about a TaskQueue.", "operationId"=>"taskqueue.taskqueues.get", "x-api-path-slug"=>"projecttaskqueuestaskqueue-get", "parameters"=>[{"in"=>"query", "name"=>"getStats", "description"=>"Whether to get stats"}, {"in"=>"path", "name"=>"project", "description"=>"The project under which the queue lies"}, {"in"=>"path", "name"=>"taskqueue", "description"=>"The id of the taskqueue to get the properties of"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task Queues"]}}, "/{project}/taskqueues/{taskqueue}/tasks"=>{"get"=>{"summary"=>"Get Tasks", "description"=>"List Tasks in a TaskQueue", "operationId"=>"taskqueue.tasks.list", "x-api-path-slug"=>"projecttaskqueuestaskqueuetasks-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"The project under which the queue lies"}, {"in"=>"path", "name"=>"taskqueue", "description"=>"The id of the taskqueue to list tasks from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task"]}, "post"=>{"summary"=>"Insert Task", "description"=>"Insert a new task in a TaskQueue", "operationId"=>"taskqueue.tasks.insert", "x-api-path-slug"=>"projecttaskqueuestaskqueuetasks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"The project under which the queue lies"}, {"in"=>"path", "name"=>"taskqueue", "description"=>"The taskqueue to insert the task into"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task"]}}, "/{project}/taskqueues/{taskqueue}/tasks/lease"=>{"post"=>{"summary"=>"Lease Task", "description"=>"Lease 1 or more tasks from a TaskQueue.", "operationId"=>"taskqueue.tasks.lease", "x-api-path-slug"=>"projecttaskqueuestaskqueuetaskslease-post", "parameters"=>[{"in"=>"query", "name"=>"groupByTag", "description"=>"When true, all returned tasks will have the same tag"}, {"in"=>"query", "name"=>"leaseSecs", "description"=>"The lease in seconds"}, {"in"=>"query", "name"=>"numTasks", "description"=>"The number of tasks to lease"}, {"in"=>"path", "name"=>"project", "description"=>"The project under which the queue lies"}, {"in"=>"query", "name"=>"tag", "description"=>"The tag allowed for tasks in the response"}, {"in"=>"path", "name"=>"taskqueue", "description"=>"The taskqueue to lease a task from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task"]}}, "/{project}/taskqueues/{taskqueue}/tasks/{task}"=>{"delete"=>{"summary"=>"Delete Task", "description"=>"Delete a task from a TaskQueue.", "operationId"=>"taskqueue.tasks.delete", "x-api-path-slug"=>"projecttaskqueuestaskqueuetaskstask-delete", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"The project under which the queue lies"}, {"in"=>"path", "name"=>"task", "description"=>"The id of the task to delete"}, {"in"=>"path", "name"=>"taskqueue", "description"=>"The taskqueue to delete a task from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task"]}, "get"=>{"summary"=>"Get Task", "description"=>"Get a particular task from a TaskQueue.", "operationId"=>"taskqueue.tasks.get", "x-api-path-slug"=>"projecttaskqueuestaskqueuetaskstask-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"The project under which the queue lies"}, {"in"=>"path", "name"=>"task", "description"=>"The task to get properties of"}, {"in"=>"path", "name"=>"taskqueue", "description"=>"The taskqueue in which the task belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task"]}, "patch"=>{"summary"=>"Update Task", "description"=>"Update tasks that are leased out of a TaskQueue. This method supports patch semantics.", "operationId"=>"taskqueue.tasks.patch", "x-api-path-slug"=>"projecttaskqueuestaskqueuetaskstask-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"newLeaseSeconds", "description"=>"The new lease in seconds"}, {"in"=>"path", "name"=>"project", "description"=>"The project under which the queue lies"}, {"in"=>"path", "name"=>"task"}, {"in"=>"path", "name"=>"taskqueue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task"]}, "post"=>{"summary"=>"Update Task", "description"=>"Update tasks that are leased out of a TaskQueue.", "operationId"=>"taskqueue.tasks.update", "x-api-path-slug"=>"projecttaskqueuestaskqueuetaskstask-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"newLeaseSeconds", "description"=>"The new lease in seconds"}, {"in"=>"path", "name"=>"project", "description"=>"The project under which the queue lies"}, {"in"=>"path", "name"=>"task"}, {"in"=>"path", "name"=>"taskqueue"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Task"]}}}}, "apis"=>{"name"=>"Google Task Queue", "x-slug"=>"google-task-queue", "description"=>"The Task Queue API lets applications perform work, called tasks, asynchronously outside of a user request. If an app needs to execute work in the background, it adds tasks to task queues. The tasks are executed later, by scalable App Engine worker services in your application.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/hands-on-app-engine-11-638.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Jobs,Orchestration,Profiles,Relative Data,Service API,Stack Network,Tasks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-task-queue/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Task Queue API", "x-api-slug"=>"google-task-queue-api", "description"=>"The Task Queue API lets applications perform work, called tasks, asynchronously outside of a user request. If an app needs to execute work in the background, it adds tasks to task queues. The tasks are executed later, by scalable App Engine worker services in your application.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/hands-on-app-engine-11-638.jpg", "humanURL"=>"https://cloud.google.com/appengine/docs/standard/python/taskqueue/", "baseURL"=>"://www.googleapis.com//taskqueue/v1beta2/projects", "tags"=>"API Provider,API Service Provider,Google APIs,Jobs,Orchestration,Profiles,Relative Data,Service API,Stack Network,Tasks", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-task-queue/google-task-queue-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-code", "url"=>"https://cloud.google.com/appengine/docs/standard/python/taskqueue/rest/libraries"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/appengine/docs/standard/python/taskqueue/rest/"}, {"type"=>"x-performance", "url"=>"https://cloud.google.com/appengine/docs/standard/python/taskqueue/rest/performance"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/appengine/docs/standard/python/taskqueue/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
collabnet{"collabnet-teamforge-api-documentation-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"CollabNet", "x-complete"=>1, "info"=>{"title"=>"Foundation API", "version"=>"1.0.0"}, "basePath"=>"/ctfrest/foundation/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/appconfiguration"=>{"patch"=>{"summary"=>"Updates configuration properties", "description"=>"Updates configuration properties.", "operationId"=>"setConfigurations", "x-api-path-slug"=>"appconfiguration-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"List of configuration properties", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration", "Properties"]}}, "/appconfiguration/by-name/{configname}"=>{"get"=>{"summary"=>"Get value for specified configuration property", "description"=>"Get value for specified configuration property.", "operationId"=>"getValueForSpecifiedConfigurationProperty", "x-api-path-slug"=>"appconfigurationbynameconfigname-get", "parameters"=>[{"in"=>"path", "name"=>"configname", "description"=>"configname"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Valuespecified", "Configuration", "Property"]}}, "/appconfiguration/by-name/{configname}/value"=>{"patch"=>{"summary"=>"Updates the configuration value", "description"=>"Updates the configuration value.", "operationId"=>"updateConfigurationValue", "x-api-path-slug"=>"appconfigurationbynameconfignamevalue-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Update the configuration value", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"configname", "description"=>"configname"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration", "Value"]}}, "/approval-requests/summary"=>{"get"=>{"summary"=>"Gets a summary of pending approval requests on TF server", "description"=>"Gets a summary of pending approval requests on tf server.", "operationId"=>"getApprovalRequestSummary", "x-api-path-slug"=>"approvalrequestssummary-get", "parameters"=>[{"in"=>"query", "name"=>"projectId", "description"=>"Project identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Summary", "Of", "Pending", "Approval", "Requests", "On", "TF", "Server"]}}, "/associations"=>{"get"=>{"summary"=>"Gets the association information for the given object/activity ids", "description"=>"Gets the association information for the given object/activity ids.", "operationId"=>"getAssociations", "x-api-path-slug"=>"associations-get", "parameters"=>[{"in"=>"query", "name"=>"depth", "description"=>"Number of levels"}, {"in"=>"query", "name"=>"ids", "description"=>"Comma separated object ids"}, {"in"=>"query", "name"=>"includeDependencies", "description"=>"Include dependency associations (parent and child)"}, {"in"=>"query", "name"=>"includeEvents", "description"=>"Include events"}, {"in"=>"query", "name"=>"includePhantoms", "description"=>"Include phantom events"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of generic associations for an object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Association", "Informationthe", "Given", "Object", "Activitys"]}}, "/groups"=>{"get"=>{"summary"=>"Gets paginated user group list", "description"=>"Gets paginated user group list.", "operationId"=>"getUserGroups", "x-api-path-slug"=>"groups-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Max"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset"}, {"in"=>"query", "name"=>"sortby", "description"=>"Sort by column name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Paginated", "User", "Group", "List"]}, "post"=>{"summary"=>"Creates user group", "description"=>"Creates user group.", "operationId"=>"createUserGroup", "x-api-path-slug"=>"groups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"New user group data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "User", "Group"]}}, "/groups/by-name/{name}"=>{"get"=>{"summary"=>"Gets group data by fullname", "description"=>"Gets group data by fullname.", "operationId"=>"getItemByName", "x-api-path-slug"=>"groupsbynamename-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Groups full name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Data", "By", "Fullname"]}}, "/groups/{groupid}"=>{"get"=>{"summary"=>"Gets group data by id", "description"=>"Gets group data by id.", "operationId"=>"getUserGroup", "x-api-path-slug"=>"groupsgroupid-get", "parameters"=>[{"in"=>"path", "name"=>"groupid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Data", "By"]}, "delete"=>{"summary"=>"Deletes group data by id", "description"=>"Deletes group data by id.", "operationId"=>"deleteUserGroup", "x-api-path-slug"=>"groupsgroupid-delete", "parameters"=>[{"in"=>"path", "name"=>"groupid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Data", "By"]}, "patch"=>{"summary"=>"Updates group data by id", "description"=>"Updates group data by id.", "operationId"=>"updateUserGroup", "x-api-path-slug"=>"groupsgroupid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Updated user group info", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"groupid"}, {"in"=>"header", "name"=>"If-Match", "description"=>"Group version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Data", "By"]}}, "/groups/{groupid}/members"=>{"get"=>{"summary"=>"Gets usergroup members", "description"=>"Gets usergroup members.", "operationId"=>"getUserGroupMembers", "x-api-path-slug"=>"groupsgroupidmembers-get", "parameters"=>[{"in"=>"path", "name"=>"groupid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Usergroup", "Members"]}}, "/groups/{groupid}/members/{username}"=>{"put"=>{"summary"=>"Adds a user to usergroup", "description"=>"Adds a user to usergroup.", "operationId"=>"addUserGroupMember", "x-api-path-slug"=>"groupsgroupidmembersusername-put", "parameters"=>[{"in"=>"path", "name"=>"groupid"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "To", "Usergroup"]}, "delete"=>{"summary"=>"Removes a user from usergroup", "description"=>"Removes a user from usergroup.", "operationId"=>"removeUserGroupMember", "x-api-path-slug"=>"groupsgroupidmembersusername-delete", "parameters"=>[{"in"=>"path", "name"=>"groupid"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Removes", "User", "From", "Usergroup"]}}, "/integrationdata/by-objectid/{objectid}/by-name/{namespace}"=>{"get"=>{"summary"=>"Gets integration data for an object by namespace name", "description"=>"Gets integration data for an object by namespace name.", "operationId"=>"getIntegrationDataByName", "x-api-path-slug"=>"integrationdatabyobjectidobjectidbynamenamespace-get", "parameters"=>[{"in"=>"query", "name"=>"dataname", "description"=>"Data name"}, {"in"=>"path", "name"=>"namespace", "description"=>"Namespace name"}, {"in"=>"path", "name"=>"objectid", "description"=>"Object id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integration", "Dataan", "Object", "By", "Namespace", "Name"]}, "put"=>{"summary"=>"Sets integration data for an object by namespace name", "description"=>"Sets integration data for an object by namespace name.", "operationId"=>"setIntegrationDataByName", "x-api-path-slug"=>"integrationdatabyobjectidobjectidbynamenamespace-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Integration data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"createNamespace", "description"=>"Create namespace if missing?"}, {"in"=>"path", "name"=>"namespace", "description"=>"Namespace name"}, {"in"=>"path", "name"=>"objectid", "description"=>"Object id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sets", "Integration", "Dataan", "Object", "By", "Namespace", "Name"]}, "delete"=>{"summary"=>"Removes integration data for an object by namespace name", "description"=>"Removes integration data for an object by namespace name.", "operationId"=>"removeIntegrationDataByName", "x-api-path-slug"=>"integrationdatabyobjectidobjectidbynamenamespace-delete", "parameters"=>[{"in"=>"query", "name"=>"dataname", "description"=>"Data name"}, {"in"=>"path", "name"=>"namespace", "description"=>"Namespace name"}, {"in"=>"path", "name"=>"objectid", "description"=>"Object id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Removes", "Integration", "Dataan", "Object", "By", "Namespace", "Name"]}}, "/integrationdata/by-objectid/{objectid}/{namespaceid}"=>{"get"=>{"summary"=>"Gets integration data for an object by namespace id", "description"=>"Gets integration data for an object by namespace id.", "operationId"=>"getIntegrationData", "x-api-path-slug"=>"integrationdatabyobjectidobjectidnamespaceid-get", "parameters"=>[{"in"=>"query", "name"=>"dataname", "description"=>"Data name"}, {"in"=>"path", "name"=>"namespaceid", "description"=>"Namespace id"}, {"in"=>"path", "name"=>"objectid", "description"=>"Object id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integration", "Dataan", "Object", "By", "Namespace"]}, "put"=>{"summary"=>"Sets integration data for an object by namespace id", "description"=>"Sets integration data for an object by namespace id.", "operationId"=>"setIntegrationData", "x-api-path-slug"=>"integrationdatabyobjectidobjectidnamespaceid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Integration data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"namespaceid", "description"=>"Namespace id"}, {"in"=>"path", "name"=>"objectid", "description"=>"Object id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sets", "Integration", "Dataan", "Object", "By", "Namespace"]}, "delete"=>{"summary"=>"Removes integration data for an object by namespace id", "description"=>"Removes integration data for an object by namespace id.", "operationId"=>"removeIntegrationData", "x-api-path-slug"=>"integrationdatabyobjectidobjectidnamespaceid-delete", "parameters"=>[{"in"=>"query", "name"=>"dataname", "description"=>"Data name"}, {"in"=>"path", "name"=>"namespaceid", "description"=>"Namespace id"}, {"in"=>"path", "name"=>"objectid", "description"=>"Object id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Removes", "Integration", "Dataan", "Object", "By", "Namespace"]}}, "/integrationdata/myself/by-name/{namespace}"=>{"get"=>{"summary"=>"Gets integration data for current user by namespace name", "description"=>"Gets integration data for current user by namespace name.", "operationId"=>"getMyIntegrationDataByName", "x-api-path-slug"=>"integrationdatamyselfbynamenamespace-get", "parameters"=>[{"in"=>"query", "name"=>"dataname", "description"=>"Data name"}, {"in"=>"path", "name"=>"namespace", "description"=>"Namespace name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integration", "Datacurrent", "User", "By", "Namespace", "Name"]}, "put"=>{"summary"=>"Sets integration data for current user by namespace name", "description"=>"Sets integration data for current user by namespace name.", "operationId"=>"setMyIntegrationDataByName", "x-api-path-slug"=>"integrationdatamyselfbynamenamespace-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Integration data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"createNamespace", "description"=>"Create namespace if missing?"}, {"in"=>"path", "name"=>"namespace", "description"=>"Namespace name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sets", "Integration", "Datacurrent", "User", "By", "Namespace", "Name"]}, "delete"=>{"summary"=>"Removes integration data for current user by namespace name", "description"=>"Removes integration data for current user by namespace name.", "operationId"=>"removeMyIntegrationDataByName", "x-api-path-slug"=>"integrationdatamyselfbynamenamespace-delete", "parameters"=>[{"in"=>"query", "name"=>"dataname", "description"=>"Data name"}, {"in"=>"path", "name"=>"namespace", "description"=>"Namespace name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Removes", "Integration", "Datacurrent", "User", "By", "Namespace", "Name"]}}, "/integrationdata/myself/{namespaceid}"=>{"get"=>{"summary"=>"Gets integration data for current user by namespace id", "description"=>"Gets integration data for current user by namespace id.", "operationId"=>"getMyIntegrationData", "x-api-path-slug"=>"integrationdatamyselfnamespaceid-get", "parameters"=>[{"in"=>"query", "name"=>"dataname", "description"=>"Data name"}, {"in"=>"path", "name"=>"namespaceid", "description"=>"Namespace id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Integration", "Datacurrent", "User", "By", "Namespace"]}, "put"=>{"summary"=>"Sets integration data for current user by namespace id", "description"=>"Sets integration data for current user by namespace id.", "operationId"=>"setMyIntegrationData", "x-api-path-slug"=>"integrationdatamyselfnamespaceid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Integration data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"namespaceid", "description"=>"Namespace id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sets", "Integration", "Datacurrent", "User", "By", "Namespace"]}, "delete"=>{"summary"=>"Removes integration data for current user by namespace id", "description"=>"Removes integration data for current user by namespace id.", "operationId"=>"removeMyIntegrationData", "x-api-path-slug"=>"integrationdatamyselfnamespaceid-delete", "parameters"=>[{"in"=>"query", "name"=>"dataname", "description"=>"Data name"}, {"in"=>"path", "name"=>"namespaceid", "description"=>"Namespace id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Removes", "Integration", "Datacurrent", "User", "By", "Namespace"]}}, "/integrationdata/namespaces"=>{"post"=>{"summary"=>"Registers namespace", "description"=>"Registers namespace.", "operationId"=>"registerNamespace", "x-api-path-slug"=>"integrationdatanamespaces-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Namespace", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registers", "Namespace"]}}, "/integrationdata/namespaces/by-name/{namespace}"=>{"get"=>{"summary"=>"Gets namespace info by name", "description"=>"Gets namespace info by name.", "operationId"=>"getNamespaceByName", "x-api-path-slug"=>"integrationdatanamespacesbynamenamespace-get", "parameters"=>[{"in"=>"path", "name"=>"namespace", "description"=>"Namespace name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespace", "Info", "By", "Name"]}}, "/monitoring/objects/{objectid}/users"=>{"get"=>{"summary"=>"Returns the list of monitoring users for the object(Folder/Item).", "description"=>"Returns the list of monitoring users for the object(folder/item)..", "operationId"=>"listUsersForObject", "x-api-path-slug"=>"monitoringobjectsobjectidusers-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Max"}, {"in"=>"path", "name"=>"objectid", "description"=>"Object id"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "List", "Of", "Monitoring", "Usersthe", "Object(Folder", "Item)"]}}, "/monitoring/users/by-username/{username}/objects"=>{"get"=>{"summary"=>"Returns the list of monitoring items for the given username", "description"=>"Returns the list of monitoring items for the given username.", "operationId"=>"monitoringItemsForUsername", "x-api-path-slug"=>"monitoringusersbyusernameusernameobjects-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Max"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset"}, {"in"=>"query", "name"=>"projectid", "description"=>"Project Id"}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "List", "Of", "Monitoring", "Itemsthe", "Given", "Username"]}, "post"=>{"summary"=>"Monitors / Unmonitors the list of objects for the given username", "description"=>"Monitors / unmonitors the list of objects for the given username.", "operationId"=>"monitorOrUnmonitorObjectsByUsername", "x-api-path-slug"=>"monitoringusersbyusernameusernameobjects-post", "parameters"=>[{"in"=>"query", "name"=>"action", "description"=>"To perform action"}, {"in"=>"body", "name"=>"body", "description"=>"Monitor / Unmonitor items", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitors", "", "", "Unmonitors", "List", "Of", "Objectsthe", "Given", "Username"]}}, "/monitoring/users/by-username/{username}/objects/{objectid}"=>{"get"=>{"summary"=>"Monitoring the current object or not for the given username (true / false)", "description"=>"Monitoring the current object or not for the given username (true / false).", "operationId"=>"isObjectMonitoredByUsername", "x-api-path-slug"=>"monitoringusersbyusernameusernameobjectsobjectid-get", "parameters"=>[{"in"=>"path", "name"=>"objectid", "description"=>"Object id"}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Current", "Object", "Notthe", "Given", "Username", "(true", "", "", "False)"]}, "post"=>{"summary"=>"Monitors the current object for the given username.", "description"=>"Monitors the current object for the given username..", "operationId"=>"monitorObjectByUsername", "x-api-path-slug"=>"monitoringusersbyusernameusernameobjectsobjectid-post", "parameters"=>[{"in"=>"path", "name"=>"objectid", "description"=>"Object id"}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitors", "Current", "Objectthe", "Given", "Username"]}, "delete"=>{"summary"=>"UnMonitors the current object for the given username.", "description"=>"Unmonitors the current object for the given username..", "operationId"=>"unMonitorObjectByuser", "x-api-path-slug"=>"monitoringusersbyusernameusernameobjectsobjectid-delete", "parameters"=>[{"in"=>"path", "name"=>"objectid", "description"=>"Object id"}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["UnMonitors", "Current", "Objectthe", "Given", "Username"]}}, "/monitoring/users/myself/objects"=>{"get"=>{"summary"=>"Returns the list of monitoring items for current user", "description"=>"Returns the list of monitoring items for current user.", "operationId"=>"monitoringItemsForUser", "x-api-path-slug"=>"monitoringusersmyselfobjects-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Max"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset"}, {"in"=>"query", "name"=>"projectid", "description"=>"Project id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "List", "Of", "Monitoring", "Itemscurrent", "User"]}, "post"=>{"summary"=>"Monitors / Unmonitors the list of objects for current user.", "description"=>"Monitors / unmonitors the list of objects for current user..", "operationId"=>"monitorOrUnmonitorObjectsForUser", "x-api-path-slug"=>"monitoringusersmyselfobjects-post", "parameters"=>[{"in"=>"query", "name"=>"action", "description"=>"To perform action"}, {"in"=>"body", "name"=>"body", "description"=>"Monitor / Unmonitor items", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitors", "", "", "Unmonitors", "List", "Of", "Objectscurrent", "User"]}}, "/monitoring/users/myself/objects/{objectid}"=>{"get"=>{"summary"=>"The logged in user is monitoring the current object or not (true / false)", "description"=>"The logged in user is monitoring the current object or not (true / false).", "operationId"=>"isObjectMonitored", "x-api-path-slug"=>"monitoringusersmyselfobjectsobjectid-get", "parameters"=>[{"in"=>"path", "name"=>"objectid", "description"=>"Object id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["The", "Logged", "In", "User", "Is", "Monitoring", "Current", "Object", "Not", "(true", "", "", "False)"]}, "post"=>{"summary"=>"Monitors the current object for current user.", "description"=>"Monitors the current object for current user..", "operationId"=>"monitorObjectForUser", "x-api-path-slug"=>"monitoringusersmyselfobjectsobjectid-post", "parameters"=>[{"in"=>"path", "name"=>"objectid", "description"=>"Object id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitors", "Current", "Objectcurrent", "User"]}, "delete"=>{"summary"=>"UnMonitors the current object for the current user,", "description"=>"Unmonitors the current object for the current user,.", "operationId"=>"unMonitorObject", "x-api-path-slug"=>"monitoringusersmyselfobjectsobjectid-delete", "parameters"=>[{"in"=>"path", "name"=>"objectid", "description"=>"Object id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["UnMonitors", "Current", "Objectthe", "Current", "User", ""]}}, "/monitoring/users/{userid}/objects"=>{"get"=>{"summary"=>"Returns the list of monitoring items for the given userid", "description"=>"Returns the list of monitoring items for the given userid.", "operationId"=>"monitorSubforUserId", "x-api-path-slug"=>"monitoringusersuseridobjects-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Max"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset"}, {"in"=>"query", "name"=>"projectid", "description"=>"Project Id"}, {"in"=>"path", "name"=>"userid", "description"=>"User id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "List", "Of", "Monitoring", "Itemsthe", "Given", "Userid"]}, "post"=>{"summary"=>"Monitors / Unmonitors the list of objects for the given userid.", "description"=>"Monitors / unmonitors the list of objects for the given userid..", "operationId"=>"monitorOrUnmonitorObjectsByUserid", "x-api-path-slug"=>"monitoringusersuseridobjects-post", "parameters"=>[{"in"=>"query", "name"=>"action", "description"=>"To perform action"}, {"in"=>"body", "name"=>"body", "description"=>"Monitor / Unmonitor items", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userid", "description"=>"User id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitors", "", "", "Unmonitors", "List", "Of", "Objectsthe", "Given", "Userid"]}}, "/monitoring/users/{userid}/objects/{objectid}"=>{"get"=>{"summary"=>"Monitoring the current object or not for the given user id (true / false)", "description"=>"Monitoring the current object or not for the given user id (true / false).", "operationId"=>"isObjectMonitoredByUserid", "x-api-path-slug"=>"monitoringusersuseridobjectsobjectid-get", "parameters"=>[{"in"=>"path", "name"=>"objectid", "description"=>"Object id"}, {"in"=>"path", "name"=>"userid", "description"=>"User id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring", "Current", "Object", "Notthe", "Given", "User", "(true", "", "", "False)"]}, "post"=>{"summary"=>"Monitors the current object for the given userid.", "description"=>"Monitors the current object for the given userid..", "operationId"=>"monitorObjectByUserid", "x-api-path-slug"=>"monitoringusersuseridobjectsobjectid-post", "parameters"=>[{"in"=>"path", "name"=>"objectid", "description"=>"Object id"}, {"in"=>"path", "name"=>"userid", "description"=>"User id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitors", "Current", "Objectthe", "Given", "Userid"]}, "delete"=>{"summary"=>"UnMonitors the current object for given userid", "description"=>"Unmonitors the current object for given userid.", "operationId"=>"unMonitorObjectByid", "x-api-path-slug"=>"monitoringusersuseridobjectsobjectid-delete", "parameters"=>[{"in"=>"path", "name"=>"objectid", "description"=>"Object id"}, {"in"=>"path", "name"=>"userid", "description"=>"User id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["UnMonitors", "Current", "Objectgiven", "Userid"]}}, "/myself/recent/objects"=>{"get"=>{"summary"=>"Gets recent object list for the current user", "description"=>"Gets recent object list for the current user.", "operationId"=>"getMyRecentObjects", "x-api-path-slug"=>"myselfrecentobjects-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Max"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recent", "Object", "Listthe", "Current", "User"]}}, "/myself/recent/projects"=>{"get"=>{"summary"=>"Gets recent project list for the current user", "description"=>"Gets recent project list for the current user.", "operationId"=>"getMyRecentProjects", "x-api-path-slug"=>"myselfrecentprojects-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Max"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recent", "Project", "Listthe", "Current", "User"]}}, "/objects/{artifactId}/comments/{commentId}/edit"=>{"post"=>{"summary"=>"Edit a comment added by the same user, on the given artifact id", "description"=>"Edit a comment added by the same user, on the given artifact id.", "operationId"=>"editComment", "x-api-path-slug"=>"objectsartifactidcommentscommentidedit-post", "parameters"=>[{"in"=>"path", "name"=>"artifactId", "description"=>"Artifact id"}, {"in"=>"body", "name"=>"body", "description"=>"Comment", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"commentId", "description"=>"Comment id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Comment", "Added", "By", "Same", "User", "", "On", "Given", "Artifact"]}}, "/objects/{objectid}/associations"=>{"get"=>{"summary"=>"Gets the association information for the given object id", "description"=>"Gets the association information for the given object id.", "operationId"=>"getObjectAssociations", "x-api-path-slug"=>"objectsobjectidassociations-get", "parameters"=>[{"in"=>"query", "name"=>"depth", "description"=>"Number of levels"}, {"in"=>"query", "name"=>"includeDependencies", "description"=>"Include dependency associations (parent and child)"}, {"in"=>"query", "name"=>"includeEvents", "description"=>"Include events"}, {"in"=>"query", "name"=>"includePhantoms", "description"=>"Include phantom events"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of generic associations for an object"}, {"in"=>"path", "name"=>"objectid", "description"=>"Object/Activity id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Association", "Informationthe", "Given", "Object"]}}, "/objects/{objectid}/associations/{targetid}"=>{"put"=>{"summary"=>"Creates association", "description"=>"Creates association.", "operationId"=>"createAssociation", "x-api-path-slug"=>"objectsobjectidassociationstargetid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Association parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"objectid", "description"=>"Origin object id"}, {"in"=>"path", "name"=>"targetid", "description"=>"Target object id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Association"]}, "delete"=>{"summary"=>"Deletes association", "description"=>"Deletes association.", "operationId"=>"deleteAssociation", "x-api-path-slug"=>"objectsobjectidassociationstargetid-delete", "parameters"=>[{"in"=>"path", "name"=>"objectid", "description"=>"Origin object id"}, {"in"=>"path", "name"=>"targetid", "description"=>"Target object id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Association"]}}, "/objects/{objectid}/auditlog"=>{"get"=>{"summary"=>"Gets a collection of audit transactions performed on the specified TeamForge object", "description"=>"Gets a collection of audit transactions performed on the specified teamforge object.", "operationId"=>"getAuditLog", "x-api-path-slug"=>"objectsobjectidauditlog-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Max"}, {"in"=>"path", "name"=>"objectid", "description"=>"Object identifier"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Collection", "Of", "Audit", "Transactions", "Performed", "On", "Specified", "TeamForge", "Object"]}}, "/objects/{objectid}/comments"=>{"get"=>{"summary"=>"Gets the comments on the given object id", "description"=>"Gets the comments on the given object id.", "operationId"=>"getObjectComments", "x-api-path-slug"=>"objectsobjectidcomments-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Max"}, {"in"=>"path", "name"=>"objectid", "description"=>"Object id"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset"}, {"in"=>"query", "name"=>"sortby", "description"=>"Sort by column name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "On", "Given", "Object"]}, "post"=>{"summary"=>"Posts a comment on the given object id", "description"=>"Posts a comment on the given object id.", "operationId"=>"postComment", "x-api-path-slug"=>"objectsobjectidcomments-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Comment", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"objectid", "description"=>"Object id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comment", "On", "Given", "Object"]}}, "/objects/{objectid}/delivery"=>{"get"=>{"summary"=>"Gets delivery information for the given object", "description"=>"Gets delivery information for the given object.", "operationId"=>"getObjectDeliveryInfo", "x-api-path-slug"=>"objectsobjectiddelivery-get", "parameters"=>[{"in"=>"path", "name"=>"objectid", "description"=>"Object id(commit or artifact)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Delivery", "Informationthe", "Given", "Object"]}}, "/permission/{projectid}/{folderPath}/baseline"=>{"get"=>{"summary"=>"Check Baseline Permission for given project", "description"=>"Check baseline permission for given project.", "operationId"=>"check baseline permission", "x-api-path-slug"=>"permissionprojectidfolderpathbaseline-get", "parameters"=>[{"in"=>"path", "name"=>"folderPath"}, {"in"=>"path", "name"=>"projectPath"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Check", "Baseline", "Permissiongiven", "Project"]}}, "/projectgroups"=>{"get"=>{"summary"=>"Gets paginated project group list", "description"=>"Gets paginated project group list.", "operationId"=>"getProjectGroups", "x-api-path-slug"=>"projectgroups-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Max"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset"}, {"in"=>"query", "name"=>"sortby", "description"=>"Sort by column name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Paginated", "Project", "Group", "List"]}, "post"=>{"summary"=>"Creates project group", "description"=>"Creates project group.", "operationId"=>"createProjectGroup", "x-api-path-slug"=>"projectgroups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"New project group data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Project", "Group"]}}, "/projectgroups/{projectgroupid}"=>{"get"=>{"summary"=>"Gets project group information", "description"=>"Gets project group information.", "operationId"=>"getProjectGroup", "x-api-path-slug"=>"projectgroupsprojectgroupid-get", "parameters"=>[{"in"=>"path", "name"=>"projectgroupid", "description"=>"Project group identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Group", "Information"]}, "delete"=>{"summary"=>"Deletes a project group", "description"=>"Deletes a project group.", "operationId"=>"deleteProjectGroup", "x-api-path-slug"=>"projectgroupsprojectgroupid-delete", "parameters"=>[{"in"=>"query", "name"=>"force"}, {"in"=>"path", "name"=>"projectgroupid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Group"]}, "patch"=>{"summary"=>"Updates project group data", "description"=>"Updates project group data.", "operationId"=>"updateProjectGroup", "x-api-path-slug"=>"projectgroupsprojectgroupid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Updated project group info", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"If-Match", "description"=>"Project version"}, {"in"=>"path", "name"=>"projectgroupid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Group", "Data"]}}, "/projectgroups/{projectgroupid}/admins"=>{"get"=>{"summary"=>"Gets project group admins", "description"=>"Gets project group admins.", "operationId"=>"getProjectGroupAdmins", "x-api-path-slug"=>"projectgroupsprojectgroupidadmins-get", "parameters"=>[{"in"=>"path", "name"=>"projectgroupid", "description"=>"Project group identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Group", "Admins"]}}, "/projectgroups/{projectgroupid}/admins/{username}"=>{"put"=>{"summary"=>"Adds project group admin", "description"=>"Adds project group admin.", "operationId"=>"addProjectGroupAdmin", "x-api-path-slug"=>"projectgroupsprojectgroupidadminsusername-put", "parameters"=>[{"in"=>"path", "name"=>"projectgroupid", "description"=>"Project group identifier"}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Group", "Admin"]}, "delete"=>{"summary"=>"Removes project group admin", "description"=>"Removes project group admin.", "operationId"=>"removeProjectGroupAdmin", "x-api-path-slug"=>"projectgroupsprojectgroupidadminsusername-delete", "parameters"=>[{"in"=>"path", "name"=>"projectgroupid", "description"=>"Project group identifier"}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Removes", "Project", "Group", "Admin"]}}, "/projectgroups/{projectgroupid}/members"=>{"get"=>{"summary"=>"Gets project group members", "description"=>"Gets project group members.", "operationId"=>"getProjectGroupMembers", "x-api-path-slug"=>"projectgroupsprojectgroupidmembers-get", "parameters"=>[{"in"=>"path", "name"=>"projectgroupid", "description"=>"Project group identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Group", "Members"]}}, "/projectgroups/{projectgroupid}/members/{username}"=>{"put"=>{"summary"=>"Adds project group member", "description"=>"Adds project group member.", "operationId"=>"addProjectGroupMember", "x-api-path-slug"=>"projectgroupsprojectgroupidmembersusername-put", "parameters"=>[{"in"=>"path", "name"=>"projectgroupid", "description"=>"Project group identifier"}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Group", "Member"]}, "delete"=>{"summary"=>"Removes project group member", "description"=>"Removes project group member.", "operationId"=>"removeProjectGroupMember", "x-api-path-slug"=>"projectgroupsprojectgroupidmembersusername-delete", "parameters"=>[{"in"=>"path", "name"=>"projectgroupid", "description"=>"Project group identifier"}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Removes", "Project", "Group", "Member"]}}, "/projectgroups/{projectgroupid}/projects"=>{"get"=>{"summary"=>"Gets project group projects", "description"=>"Gets project group projects.", "operationId"=>"getProjectGroupProjects", "x-api-path-slug"=>"projectgroupsprojectgroupidprojects-get", "parameters"=>[{"in"=>"path", "name"=>"projectgroupid", "description"=>"Project group identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Group", "Projects"]}}, "/projectgroups/{projectgroupid}/projects/{projectid}"=>{"put"=>{"summary"=>"Adds project to project group", "description"=>"Adds project to project group.", "operationId"=>"addProjectToGroup", "x-api-path-slug"=>"projectgroupsprojectgroupidprojectsprojectid-put", "parameters"=>[{"in"=>"path", "name"=>"projectgroupid", "description"=>"Project group identifier"}, {"in"=>"path", "name"=>"projectid", "description"=>"Project identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "To", "Project", "Group"]}, "delete"=>{"summary"=>"Removes project from group", "description"=>"Removes project from group.", "operationId"=>"removeProjectFromGroup", "x-api-path-slug"=>"projectgroupsprojectgroupidprojectsprojectid-delete", "parameters"=>[{"in"=>"path", "name"=>"projectgroupid", "description"=>"Project group identifier"}, {"in"=>"path", "name"=>"projectid", "description"=>"Project identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Removes", "Project", "From", "Group"]}}, "/projects"=>{"get"=>{"summary"=>"Gets paginated project list.", "description"=>"Gets paginated project list..", "operationId"=>"getProjects", "x-api-path-slug"=>"projects-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Max"}, {"in"=>"query", "name"=>"fetchHierarchyPath"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset"}, {"in"=>"query", "name"=>"searchvalue"}, {"in"=>"query", "name"=>"sortby", "description"=>"Sort by column name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Paginated", "Project", "List"]}, "post"=>{"summary"=>"Creates project", "description"=>"Creates project.", "operationId"=>"createProject", "x-api-path-slug"=>"projects-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"New project data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Project"]}}, "/projects/requests"=>{"get"=>{"summary"=>"Gets paginated project request list", "description"=>"Gets paginated project request list.", "operationId"=>"getProjectRequests", "x-api-path-slug"=>"projectsrequests-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Max"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Paginated", "Project", "Request", "List"]}}, "/projects/requests/count"=>{"get"=>{"summary"=>"Gets the number of pending project requests", "description"=>"Gets the number of pending project requests.", "operationId"=>"getProjectRequestCount", "x-api-path-slug"=>"projectsrequestscount-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Number", "Of", "Pending", "Project", "Requests"]}}, "/projects/{projectid}"=>{"get"=>{"summary"=>"Gets project information", "description"=>"Gets project information.", "operationId"=>"getProject", "x-api-path-slug"=>"projectsprojectid-get", "parameters"=>[{"in"=>"path", "name"=>"projectid", "description"=>"Project identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Information"]}, "delete"=>{"summary"=>"Deletes a project", "description"=>"Deletes a project.", "operationId"=>"deleteItem", "x-api-path-slug"=>"projectsprojectid-delete", "parameters"=>[{"in"=>"query", "name"=>"force"}, {"in"=>"query", "name"=>"notify"}, {"in"=>"path", "name"=>"projectid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project"]}, "patch"=>{"summary"=>"Updates project data", "description"=>"Updates project data.", "operationId"=>"updateProject", "x-api-path-slug"=>"projectsprojectid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Updated project info", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"If-Match", "description"=>"Project version"}, {"in"=>"path", "name"=>"projectid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Data"]}}, "/projects/{projectid}/admins"=>{"get"=>{"summary"=>"Gets project administrators", "description"=>"Gets project administrators.", "operationId"=>"getProjectAdmins", "x-api-path-slug"=>"projectsprojectidadmins-get", "parameters"=>[{"in"=>"path", "name"=>"projectid", "description"=>"Project identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Administrators"]}}, "/projects/{projectid}/diskusage"=>{"get"=>{"summary"=>"Gets project disk usage in bytes", "description"=>"Gets project disk usage in bytes.", "operationId"=>"getProjectDiskUsage", "x-api-path-slug"=>"projectsprojectiddiskusage-get", "parameters"=>[{"in"=>"path", "name"=>"projectid", "description"=>"Project identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Disk", "Usage", "In", "Bytes"]}}, "/projects/{projectid}/lock"=>{"put"=>{"summary"=>"Locks a project", "description"=>"Locks a project.", "operationId"=>"lockProject", "x-api-path-slug"=>"projectsprojectidlock-put", "parameters"=>[{"in"=>"path", "name"=>"projectid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Locks", "Project"]}, "delete"=>{"summary"=>"Unlocks a project", "description"=>"Unlocks a project.", "operationId"=>"unlockProject", "x-api-path-slug"=>"projectsprojectidlock-delete", "parameters"=>[{"in"=>"path", "name"=>"projectid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unlocks", "Project"]}}, "/projects/{projectid}/members"=>{"get"=>{"summary"=>"Gets project members", "description"=>"Gets project members.", "operationId"=>"getProjectMembers", "x-api-path-slug"=>"projectsprojectidmembers-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Max"}, {"in"=>"query", "name"=>"offset"}, {"in"=>"path", "name"=>"projectid", "description"=>"Project identifier"}, {"in"=>"query", "name"=>"searchvalue", "description"=>"Filter value for project member name"}, {"in"=>"query", "name"=>"sortby", "description"=>"Sorting column name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Members"]}}, "/projects/{projectid}/roles"=>{"get"=>{"summary"=>"Gets project role list", "description"=>"Gets project role list.", "operationId"=>"getProjectRoles", "x-api-path-slug"=>"projectsprojectidroles-get", "parameters"=>[{"in"=>"query", "name"=>"includeInherited", "description"=>"Include inherited roles? This parameter is relevant for Project type only"}, {"in"=>"path", "name"=>"projectid", "description"=>"Project or project group identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Role", "List"]}, "post"=>{"summary"=>"Creates project role.", "description"=>"Creates project role..", "operationId"=>"createProjectRole", "x-api-path-slug"=>"projectsprojectidroles-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"New role data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectid", "description"=>"Project or project group identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Project", "Role"]}}, "/projects/{projectid}/roles/by-users"=>{"post"=>{"summary"=>"Get roles by user", "description"=>"Get roles by user.", "operationId"=>"getRolesByUsers", "x-api-path-slug"=>"projectsprojectidrolesbyusers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"List of user Names", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles", "By", "User"]}}, "/projects/{projectid}/roles/inherited-roles"=>{"get"=>{"summary"=>"Gets inherited project role list", "description"=>"Gets inherited project role list.", "operationId"=>"getInheritedProjectRoles", "x-api-path-slug"=>"projectsprojectidrolesinheritedroles-get", "parameters"=>[{"in"=>"path", "name"=>"projectid", "description"=>"Project identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Inherited", "Project", "Role", "List"]}}, "/projects/{projectid}/roles/{roleid}"=>{"delete"=>{"summary"=>"Deletes a project role", "description"=>"Deletes a project role.", "operationId"=>"deleteProjectRole", "x-api-path-slug"=>"projectsprojectidrolesroleid-delete", "parameters"=>[{"in"=>"path", "name"=>"projectid", "description"=>"Project or project group identifier"}, {"in"=>"path", "name"=>"roleid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Role"]}, "patch"=>{"summary"=>"Updates project role.", "description"=>"Updates project role..", "operationId"=>"updateProjectRole", "x-api-path-slug"=>"projectsprojectidrolesroleid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Updated role info", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"If-Match", "description"=>"Role version"}, {"in"=>"path", "name"=>"projectid", "description"=>"Project or project group identifier"}, {"in"=>"path", "name"=>"roleid", "description"=>"Role identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Role"]}}, "/projects/{projectid}/roles/{roleid}/auto-grant"=>{"get"=>{"summary"=>"Gets whether a role is granted automatically in a project or not.", "description"=>"Gets whether a role is granted automatically in a project or not..", "operationId"=>"isRoleAutoGrantInProject", "x-api-path-slug"=>"projectsprojectidrolesroleidautogrant-get", "parameters"=>[{"in"=>"path", "name"=>"projectid", "description"=>"Project identifier"}, {"in"=>"path", "name"=>"roleid", "description"=>"Role identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Whether", "Role", "Is", "Granted", "Automatically", "In", "Project", "Not"]}, "put"=>{"summary"=>"Grant a role automatically in a given project", "description"=>"Grant a role automatically in a given project.", "operationId"=>"autoGrantRoleInProject", "x-api-path-slug"=>"projectsprojectidrolesroleidautogrant-put", "parameters"=>[{"in"=>"path", "name"=>"projectid", "description"=>"Project identifier"}, {"in"=>"path", "name"=>"roleid", "description"=>"Role identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Grant", "Role", "Automatically", "In", "Given", "Project"]}, "delete"=>{"summary"=>"Stop granting a role automatically in a given project", "description"=>"Stop granting a role automatically in a given project.", "operationId"=>"removeAutoGrantRoleInProject", "x-api-path-slug"=>"projectsprojectidrolesroleidautogrant-delete", "parameters"=>[{"in"=>"path", "name"=>"projectid", "description"=>"Project identifier"}, {"in"=>"path", "name"=>"roleid", "description"=>"Role identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Granting", "Role", "Automatically", "In", "Given", "Project"]}}, "/projects/{projectid}/roles/{roleid}/members"=>{"get"=>{"summary"=>"Gets project role members", "description"=>"Gets project role members.", "operationId"=>"getProjectRoleMembers", "x-api-path-slug"=>"projectsprojectidrolesroleidmembers-get", "parameters"=>[{"in"=>"path", "name"=>"projectid", "description"=>"Project identifier"}, {"in"=>"path", "name"=>"roleid", "description"=>"Role identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Role", "Members"]}}, "/projects/{projectid}/roles/{roleid}/members/{username}"=>{"put"=>{"summary"=>"Add user to project role", "description"=>"Add user to project role.", "operationId"=>"addUserToProjectRole", "x-api-path-slug"=>"projectsprojectidrolesroleidmembersusername-put", "parameters"=>[{"in"=>"path", "name"=>"projectid", "description"=>"Project identifier"}, {"in"=>"path", "name"=>"roleid", "description"=>"Role identifier"}, {"in"=>"path", "name"=>"username", "description"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "To", "Project", "Role"]}, "delete"=>{"summary"=>"Removes user from a project role", "description"=>"Removes user from a project role.", "operationId"=>"removeUserFromProjectRole", "x-api-path-slug"=>"projectsprojectidrolesroleidmembersusername-delete", "parameters"=>[{"in"=>"path", "name"=>"projectid", "description"=>"Project identifier"}, {"in"=>"path", "name"=>"roleid", "description"=>"Role identifier"}, {"in"=>"path", "name"=>"username", "description"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Removes", "User", "From", "Project", "Role"]}}, "/projects/{projectid}/subprojects"=>{"get"=>{"summary"=>"Gets subproject list.", "description"=>"Gets subproject list..", "operationId"=>"getSubprojects", "x-api-path-slug"=>"projectsprojectidsubprojects-get", "parameters"=>[{"in"=>"query", "name"=>"fetchHierarchyPath"}, {"in"=>"path", "name"=>"projectid", "description"=>"Project identifier"}, {"in"=>"query", "name"=>"sortby", "description"=>"Sort by column name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subproject", "List"]}}, "/projects/{projectid}/{username}"=>{"put"=>{"summary"=>"Adds project member", "description"=>"Adds project member.", "operationId"=>"addProjectMember", "x-api-path-slug"=>"projectsprojectidusername-put", "parameters"=>[{"in"=>"path", "name"=>"projectid", "description"=>"Project identifier"}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project", "Member"]}, "delete"=>{"summary"=>"Removes project member", "description"=>"Removes project member.", "operationId"=>"removeProjectMember", "x-api-path-slug"=>"projectsprojectidusername-delete", "parameters"=>[{"in"=>"path", "name"=>"projectid", "description"=>"Project identifier"}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Removes", "Project", "Member"]}}, "/projecttemplates"=>{"get"=>{"summary"=>"Gets paginated project template list.", "description"=>"Gets paginated project template list..", "operationId"=>"getProjectTemplates", "x-api-path-slug"=>"projecttemplates-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Max"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset"}, {"in"=>"query", "name"=>"sortby", "description"=>"Sort by column name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Paginated", "Project", "Template", "List"]}}, "/roles"=>{"get"=>{"summary"=>"Gets global/site role list", "description"=>"Gets global/site role list.", "operationId"=>"getRoles", "x-api-path-slug"=>"roles-get", "parameters"=>[{"in"=>"query", "name"=>"projectId", "description"=>"Context project id (to verify access permissions)"}, {"in"=>"query", "name"=>"type", "description"=>"Role type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Global", "Site", "Role", "List"]}, "post"=>{"summary"=>"Creates role.", "description"=>"Creates role..", "operationId"=>"createRole", "x-api-path-slug"=>"roles-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"New role data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "Role"]}}, "/roles/{roleid}"=>{"get"=>{"summary"=>"Gets role data.", "description"=>"Gets role data..", "operationId"=>"getRole", "x-api-path-slug"=>"rolesroleid-get", "parameters"=>[{"in"=>"path", "name"=>"roleid", "description"=>"Role identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Role", "Data"]}, "delete"=>{"summary"=>"Deletes a role", "description"=>"Deletes a role.", "operationId"=>"deleteRole", "x-api-path-slug"=>"rolesroleid-delete", "parameters"=>[{"in"=>"path", "name"=>"roleid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Role"]}, "patch"=>{"summary"=>"Updates role.", "description"=>"Updates role..", "operationId"=>"updateRole", "x-api-path-slug"=>"rolesroleid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Updated role info", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"If-Match", "description"=>"Role version"}, {"in"=>"path", "name"=>"roleid", "description"=>"Role identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Role"]}}, "/roles/{roleid}/members"=>{"get"=>{"summary"=>"Gets role members", "description"=>"Gets role members.", "operationId"=>"getRoleMembers", "x-api-path-slug"=>"rolesroleidmembers-get", "parameters"=>[{"in"=>"path", "name"=>"roleid", "description"=>"Role identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Role", "Members"]}}, "/roles/{roleid}/members/{username}"=>{"put"=>{"summary"=>"Add user to a role", "description"=>"Add user to a role.", "operationId"=>"addRoleMember", "x-api-path-slug"=>"rolesroleidmembersusername-put", "parameters"=>[{"in"=>"path", "name"=>"roleid", "description"=>"Role identifier"}, {"in"=>"path", "name"=>"username", "description"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "To", "Role"]}, "delete"=>{"summary"=>"Removes user from a role", "description"=>"Removes user from a role.", "operationId"=>"removeRoleMember", "x-api-path-slug"=>"rolesroleidmembersusername-delete", "parameters"=>[{"in"=>"path", "name"=>"roleid", "description"=>"Role identifier"}, {"in"=>"path", "name"=>"username", "description"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Removes", "User", "From", "Role"]}}, "/server"=>{"get"=>{"summary"=>"Gets TeamForge server information", "description"=>"Gets teamforge server information.", "operationId"=>"getTeamForgeServerInfo", "x-api-path-slug"=>"server-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TeamForge", "Server", "Information"]}}, "/server/health"=>{"get"=>{"summary"=>"Gets the health of the CTF core", "description"=>"Gets the health of the ctf core.", "operationId"=>"getHealth", "x-api-path-slug"=>"serverhealth-get", "parameters"=>[{"in"=>"query", "name"=>"assumeactive"}, {"in"=>"query", "name"=>"thorough"}, {"in"=>"query", "name"=>"verbose"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Health", "Of", "CTF", "Core"]}}, "/server/licensekey"=>{"put"=>{"summary"=>"Sets/Updates license key", "description"=>"Sets/updates license key.", "operationId"=>"enterLicenseKey", "x-api-path-slug"=>"serverlicensekey-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"License key", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sets", "License", "Key"]}}, "/server/licensetypes"=>{"get"=>{"summary"=>"Gets valid license types", "description"=>"Gets valid license types.", "operationId"=>"getLicenseTypes", "x-api-path-slug"=>"serverlicensetypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Valid", "License", "Types"]}}, "/users"=>{"get"=>{"summary"=>"Gets paginated user list", "description"=>"Gets paginated user list.", "operationId"=>"getUsers", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Max"}, {"in"=>"query", "name"=>"ids", "description"=>"List of user ids (separated by comma)"}, {"in"=>"query", "name"=>"names", "description"=>"List of usernames (separated by comma)"}, {"in"=>"query", "name"=>"offset", "description"=>"Offset"}, {"in"=>"query", "name"=>"search", "description"=>"Comma separated terms to search in username, fullname fields"}, {"in"=>"query", "name"=>"sortby", "description"=>"Sort by column name"}, {"in"=>"query", "name"=>"status", "description"=>"User status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Paginated", "User", "List"]}, "post"=>{"summary"=>"Creates a user", "description"=>"Creates a user.", "operationId"=>"createUser", "x-api-path-slug"=>"users-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"New user information", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Creates", "User"]}}, "/users/by-email/{email}"=>{"get"=>{"summary"=>"Gets user data by email", "description"=>"Gets user data by email.", "operationId"=>"getUserByEmail", "x-api-path-slug"=>"usersbyemailemail-get", "parameters"=>[{"in"=>"path", "name"=>"email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Data", "By", "Email"]}}, "/users/by-username/{username}"=>{"get"=>{"summary"=>"Gets user data by username", "description"=>"Gets user data by username.", "operationId"=>"getUserByUsername", "x-api-path-slug"=>"usersbyusernameusername-get", "parameters"=>[{"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Data", "By", "Username"]}, "delete"=>{"summary"=>"Deletes a user by username", "description"=>"Deletes a user by username.", "operationId"=>"deleteUserByUsername", "x-api-path-slug"=>"usersbyusernameusername-delete", "parameters"=>[{"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "By", "Username"]}, "patch"=>{"summary"=>"Updates a user by username", "description"=>"Updates a user by username.", "operationId"=>"updateUserByUsername", "x-api-path-slug"=>"usersbyusernameusername-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Updated user info", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"If-Match", "description"=>"User version"}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "By", "Username"]}}, "/users/by-username/{username}/alternative-licensetypes"=>{"get"=>{"summary"=>"Gets alternative license types by username.", "description"=>"Gets alternative license types by username..", "operationId"=>"getLicenseByUsername", "x-api-path-slug"=>"usersbyusernameusernamealternativelicensetypes-get", "parameters"=>[{"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alternative", "License", "Types", "By", "Username"]}}, "/users/by-username/{username}/authorization-keys"=>{"get"=>{"summary"=>"Gets authorization keys by username", "description"=>"Gets authorization keys by username.", "operationId"=>"getAuthorizationKeysByUsername", "x-api-path-slug"=>"usersbyusernameusernameauthorizationkeys-get", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorization", "Keys", "By", "Username"]}, "post"=>{"summary"=>"Sets authorization keys by username", "description"=>"Sets authorization keys by username.", "operationId"=>"setAuthorizationKeys", "x-api-path-slug"=>"usersbyusernameusernameauthorizationkeys-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Authorization keys", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sets", "Authorization", "Keys", "By", "Username"]}}, "/users/by-username/{username}/groups"=>{"get"=>{"summary"=>"Gets a user's group list by username", "description"=>"Gets a user's group list by username.", "operationId"=>"getUserGroupsByUsername", "x-api-path-slug"=>"usersbyusernameusernamegroups-get", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Group", "List", "By", "Username"]}}, "/users/by-username/{username}/groups/{groupid}"=>{"put"=>{"summary"=>"Add user to a user group by user name", "description"=>"Add user to a user group by user name.", "operationId"=>"addUserToGroupByUsername", "x-api-path-slug"=>"usersbyusernameusernamegroupsgroupid-put", "parameters"=>[{"in"=>"path", "name"=>"groupid", "description"=>"Group id"}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "To", "User", "Group", "By", "User", "Name"]}}, "/users/by-username/{username}/password"=>{"patch"=>{"summary"=>"Resets user password by username", "description"=>"Resets user password by username.", "operationId"=>"resetPasswordByUsername", "x-api-path-slug"=>"usersbyusernameusernamepassword-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"New password", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resets", "User", "Password", "By", "Username"]}}, "/users/by-username/{username}/preferences"=>{"get"=>{"summary"=>"Gets preferences by username", "description"=>"Gets preferences by username.", "operationId"=>"getPreferences", "x-api-path-slug"=>"usersbyusernameusernamepreferences-get", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Preferences", "By", "Username"]}, "patch"=>{"summary"=>"Sets preferences by user name", "description"=>"Sets preferences by user name.", "operationId"=>"setPreferences", "x-api-path-slug"=>"usersbyusernameusernamepreferences-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Preferences", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sets", "Preferences", "By", "User", "Name"]}}, "/users/by-username/{username}/preferences/{preference}"=>{"get"=>{"summary"=>"Gets preference by username", "description"=>"Gets preference by username.", "operationId"=>"getPreference", "x-api-path-slug"=>"usersbyusernameusernamepreferencespreference-get", "parameters"=>[{"in"=>"path", "name"=>"preference", "description"=>"Preference"}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Preference", "By", "Username"]}}, "/users/by-username/{username}/profile-picture"=>{"post"=>{"summary"=>"Uploads and sets profile picture by username", "description"=>"Uploads and sets profile picture by username.", "operationId"=>"setProfilePictureByUsername", "x-api-path-slug"=>"usersbyusernameusernameprofilepicture-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Picture", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Uploads", "Sets", "Profile", "Picture", "By", "Username"]}, "delete"=>{"summary"=>"Deletes profile picture by username", "description"=>"Deletes profile picture by username.", "operationId"=>"deleteProfilePictureByUsername", "x-api-path-slug"=>"usersbyusernameusernameprofilepicture-delete", "parameters"=>[{"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile", "Picture", "By", "Username"]}}, "/users/by-username/{username}/projects"=>{"get"=>{"summary"=>"Gets a user's project list by username", "description"=>"Gets a user's project list by username.", "operationId"=>"getProjectsByUsername", "x-api-path-slug"=>"usersbyusernameusernameprojects-get", "parameters"=>[{"in"=>"query", "name"=>"fetchHierarchyPath"}, {"in"=>"query", "name"=>"sortby", "description"=>"Sort by column name"}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Project", "List", "By", "Username"]}}, "/users/by-username/{username}/projects/{projectid}"=>{"put"=>{"summary"=>"Adds a user to specified project's member list by username", "description"=>"Adds a user to specified project's member list by username.", "operationId"=>"addUserByUsername", "x-api-path-slug"=>"usersbyusernameusernameprojectsprojectid-put", "parameters"=>[{"in"=>"path", "name"=>"projectid", "description"=>"Project id"}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "To", "Specified", "Projects", "Member", "List", "By", "Username"]}}, "/users/myself"=>{"get"=>{"summary"=>"Gets user data for current user", "description"=>"Gets user data for current user.", "operationId"=>"getMyself", "x-api-path-slug"=>"usersmyself-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Datacurrent", "User"]}, "patch"=>{"summary"=>"Updates current user data", "description"=>"Updates current user data.", "operationId"=>"updateMyself", "x-api-path-slug"=>"usersmyself-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Updated user info", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"If-Match", "description"=>"User version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "User", "Data"]}}, "/users/myself/alternative-licensetypes"=>{"get"=>{"summary"=>"Gets alternative license types for current user.", "description"=>"Gets alternative license types for current user..", "operationId"=>"getLicenseForMyself", "x-api-path-slug"=>"usersmyselfalternativelicensetypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alternative", "License", "Typescurrent", "User"]}}, "/users/myself/authorization-keys"=>{"get"=>{"summary"=>"Gets authorization keys for current user", "description"=>"Gets authorization keys for current user.", "operationId"=>"getAuthorizationKeysForMyself", "x-api-path-slug"=>"usersmyselfauthorizationkeys-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorization", "Keyscurrent", "User"]}, "post"=>{"summary"=>"Sets authorization keys for current user", "description"=>"Sets authorization keys for current user.", "operationId"=>"setAuthorizationKeysForMyself", "x-api-path-slug"=>"usersmyselfauthorizationkeys-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Authorization keys", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sets", "Authorization", "Keyscurrent", "User"]}}, "/users/myself/groups"=>{"get"=>{"summary"=>"Gets current user's group list", "description"=>"Gets current user's group list.", "operationId"=>"getMyUserGroups", "x-api-path-slug"=>"usersmyselfgroups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "Users", "Group", "List"]}}, "/users/myself/groups/{groupid}"=>{"put"=>{"summary"=>"Add current user to a user group", "description"=>"Add current user to a user group.", "operationId"=>"addMyselfToGroup", "x-api-path-slug"=>"usersmyselfgroupsgroupid-put", "parameters"=>[{"in"=>"path", "name"=>"groupid", "description"=>"Group id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "User", "To", "User", "Group"]}}, "/users/myself/password"=>{"patch"=>{"summary"=>"Resets user password for current user", "description"=>"Resets user password for current user.", "operationId"=>"resetPasswordForMyself", "x-api-path-slug"=>"usersmyselfpassword-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"New password", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resets", "User", "Passwordcurrent", "User"]}}, "/users/myself/preferences"=>{"get"=>{"summary"=>"Gets preferences for current user", "description"=>"Gets preferences for current user.", "operationId"=>"getPreferencesForMyself", "x-api-path-slug"=>"usersmyselfpreferences-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Preferencescurrent", "User"]}, "patch"=>{"summary"=>"Sets preferences for current user", "description"=>"Sets preferences for current user.", "operationId"=>"setPreferencesForMyself", "x-api-path-slug"=>"usersmyselfpreferences-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Preferences", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sets", "Preferencescurrent", "User"]}}, "/users/myself/preferences/{preference}"=>{"get"=>{"summary"=>"Gets preference for current user", "description"=>"Gets preference for current user.", "operationId"=>"getPreferenceForMyself", "x-api-path-slug"=>"usersmyselfpreferencespreference-get", "parameters"=>[{"in"=>"path", "name"=>"preference", "description"=>"Preference"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Preferencecurrent", "User"]}}, "/users/myself/profile-picture"=>{"post"=>{"summary"=>"Uploads and sets profile picture for current user", "description"=>"Uploads and sets profile picture for current user.", "operationId"=>"setProfilePictureForMyself", "x-api-path-slug"=>"usersmyselfprofilepicture-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Picture", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Uploads", "Sets", "Profile", "Picturecurrent", "User"]}, "delete"=>{"summary"=>"Deletes profile picture for current user", "description"=>"Deletes profile picture for current user.", "operationId"=>"deleteProfilePictureForMyself", "x-api-path-slug"=>"usersmyselfprofilepicture-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile", "Picturecurrent", "User"]}}, "/users/myself/projects"=>{"get"=>{"summary"=>"Gets current user's project list", "description"=>"Gets current user's project list.", "operationId"=>"getMyProjects", "x-api-path-slug"=>"usersmyselfprojects-get", "parameters"=>[{"in"=>"query", "name"=>"fetchHierarchyPath"}, {"in"=>"query", "name"=>"sortby", "description"=>"Sort by column name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "Users", "Project", "List"]}}, "/users/myself/projects/{projectid}"=>{"put"=>{"summary"=>"Adds current user to specified project's member list", "description"=>"Adds current user to specified project's member list.", "operationId"=>"addMyself", "x-api-path-slug"=>"usersmyselfprojectsprojectid-put", "parameters"=>[{"in"=>"path", "name"=>"projectid", "description"=>"Project id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "User", "To", "Specified", "Projects", "Member", "List"]}}, "/users/{userid}"=>{"get"=>{"summary"=>"Gets user data by user id", "description"=>"Gets user data by user id.", "operationId"=>"getUserById", "x-api-path-slug"=>"usersuserid-get", "parameters"=>[{"in"=>"path", "name"=>"userid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Data", "By", "User"]}, "delete"=>{"summary"=>"Deletes a user by user id", "description"=>"Deletes a user by user id.", "operationId"=>"deleteUserById", "x-api-path-slug"=>"usersuserid-delete", "parameters"=>[{"in"=>"path", "name"=>"userid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "By", "User"]}, "patch"=>{"summary"=>"Updates a user by user id", "description"=>"Updates a user by user id.", "operationId"=>"updateUserById", "x-api-path-slug"=>"usersuserid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Updated user info", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"If-Match", "description"=>"User version"}, {"in"=>"path", "name"=>"userid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "By", "User"]}}, "/users/{userid}/alternative-licensetypes"=>{"get"=>{"summary"=>"Gets alternative license types by userid.", "description"=>"Gets alternative license types by userid..", "operationId"=>"getLicenseById", "x-api-path-slug"=>"usersuseridalternativelicensetypes-get", "parameters"=>[{"in"=>"path", "name"=>"userid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alternative", "License", "Types", "By", "Userid"]}}, "/users/{userid}/authorization-keys"=>{"get"=>{"summary"=>"Gets authorization keys by user id", "description"=>"Gets authorization keys by user id.", "operationId"=>"getAuthorizationKeysById", "x-api-path-slug"=>"usersuseridauthorizationkeys-get", "parameters"=>[{"in"=>"path", "name"=>"userid", "description"=>"User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authorization", "Keys", "By", "User"]}, "post"=>{"summary"=>"Sets authorization keys by user id", "description"=>"Sets authorization keys by user id.", "operationId"=>"setAuthorizationKeysById", "x-api-path-slug"=>"usersuseridauthorizationkeys-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Authorization keys", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userid", "description"=>"User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sets", "Authorization", "Keys", "By", "User"]}}, "/users/{userid}/groups"=>{"get"=>{"summary"=>"Gets a user's group list by user id", "description"=>"Gets a user's group list by user id.", "operationId"=>"getUserGroupsByUserid", "x-api-path-slug"=>"usersuseridgroups-get", "parameters"=>[{"in"=>"path", "name"=>"userid", "description"=>"User id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Group", "List", "By", "User"]}}, "/users/{userid}/groups/{groupid}"=>{"put"=>{"summary"=>"Add user to a user group by user id", "description"=>"Add user to a user group by user id.", "operationId"=>"addUserToGroupByUserid", "x-api-path-slug"=>"usersuseridgroupsgroupid-put", "parameters"=>[{"in"=>"path", "name"=>"groupid", "description"=>"Group id"}, {"in"=>"path", "name"=>"userid", "description"=>"User id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "To", "User", "Group", "By", "User"]}}, "/users/{userid}/password"=>{"patch"=>{"summary"=>"Resets user password by userid", "description"=>"Resets user password by userid.", "operationId"=>"resetPasswordById", "x-api-path-slug"=>"usersuseridpassword-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"New password", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resets", "User", "Password", "By", "Userid"]}}, "/users/{userid}/preferences"=>{"get"=>{"summary"=>"Gets preferences by user id", "description"=>"Gets preferences by user id.", "operationId"=>"getPreferencesById", "x-api-path-slug"=>"usersuseridpreferences-get", "parameters"=>[{"in"=>"path", "name"=>"userid", "description"=>"User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Preferences", "By", "User"]}, "patch"=>{"summary"=>"Sets preferences by user id", "description"=>"Sets preferences by user id.", "operationId"=>"setPreferencesById", "x-api-path-slug"=>"usersuseridpreferences-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Preferences", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userid", "description"=>"User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sets", "Preferences", "By", "User"]}}, "/users/{userid}/preferences/{preference}"=>{"get"=>{"summary"=>"Gets preference by user id", "description"=>"Gets preference by user id.", "operationId"=>"getPreferenceById", "x-api-path-slug"=>"usersuseridpreferencespreference-get", "parameters"=>[{"in"=>"path", "name"=>"preference", "description"=>"Preference"}, {"in"=>"path", "name"=>"userid", "description"=>"User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Preference", "By", "User"]}}, "/users/{userid}/profile-picture"=>{"post"=>{"summary"=>"Uploads and sets profile picture by user id", "description"=>"Uploads and sets profile picture by user id.", "operationId"=>"setProfilePictureById", "x-api-path-slug"=>"usersuseridprofilepicture-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Picture", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userid", "description"=>"User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Uploads", "Sets", "Profile", "Picture", "By", "User"]}, "delete"=>{"summary"=>"Deletes profile picture by user id", "description"=>"Deletes profile picture by user id.", "operationId"=>"deleteProfilePictureById", "x-api-path-slug"=>"usersuseridprofilepicture-delete", "parameters"=>[{"in"=>"path", "name"=>"userid", "description"=>"User ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile", "Picture", "By", "User"]}}, "/users/{userid}/projects"=>{"get"=>{"summary"=>"Gets a user's project list by user id", "description"=>"Gets a user's project list by user id.", "operationId"=>"getProjectsByUserid", "x-api-path-slug"=>"usersuseridprojects-get", "parameters"=>[{"in"=>"query", "name"=>"fetchHierarchyPath"}, {"in"=>"query", "name"=>"sortby", "description"=>"Sort by column name"}, {"in"=>"path", "name"=>"userid", "description"=>"User id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Project", "List", "By", "User"]}}, "/users/{userid}/projects/{projectid}"=>{"put"=>{"summary"=>"Adds a user to specified project's member list by user id", "description"=>"Adds a user to specified project's member list by user id.", "operationId"=>"addUserById", "x-api-path-slug"=>"usersuseridprojectsprojectid-put", "parameters"=>[{"in"=>"path", "name"=>"projectid", "description"=>"Project id"}, {"in"=>"path", "name"=>"userid", "description"=>"User id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "To", "Specified", "Projects", "Member", "List", "By", "User"]}}}}, "apis"=>{"name"=>"CollabNet", "x-slug"=>"collabnet", "description"=>"CollabNet is a software development and delivery solutions provider headquartered in South San Francisco, California.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28840-community-versionone-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"132870", "tags"=>"Collaboration,Enterprise,Orchestration,SaaS,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"collabnet/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"CollabNet TeamForge API Documentation", "x-api-slug"=>"collabnet-teamforge-api-documentation", "description"=>"CollabNet is a software development and delivery solutions provider headquartered in South San Francisco, California.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28840-community-versionone-com.jpg", "humanURL"=>"https://www.collab.net/", "baseURL"=>"https:////ctfrest/foundation/v1", "tags"=>"Collaboration,Enterprise,Orchestration,SaaS,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/collabnet/collabnet-teamforge-api-documentation-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-openapi", "url"=>"https://forge.collab.net/apidoc/ctfrest-foundation-apidoc.json"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/collabnet"}, {"type"=>"x-email", "url"=>"trademarks@collab.net"}, {"type"=>"x-email", "url"=>"legal@collab.net"}, {"type"=>"x-email", "url"=>"cnsupport@collab.net"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/CollabNet"}, {"type"=>"x-website", "url"=>"https://www.collab.net/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-shield{"aws-shield-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Shield", "x-complete"=>1, "info"=>{"title"=>"AWS Shield API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=CreateProtection"=>{"get"=>{"summary"=>"Create Protection", "description"=>"Enables AWS Shield Advanced for a specific AWS resource.", "operationId"=>"createProtection", "x-api-path-slug"=>"actioncreateprotection-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"Friendly name for the Protection you are creating", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceArn", "description"=>"The ARN (Amazon Resource Name) of the resource to be protected", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Protection"]}}, "/?Action=CreateSubscription"=>{"get"=>{"summary"=>"Create Subscription", "description"=>"Activates AWS Shield Advanced for an account.", "operationId"=>"createSubscription", "x-api-path-slug"=>"actioncreatesubscription-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Protection"]}}, "/?Action=DeleteProtection"=>{"get"=>{"summary"=>"Delete Protection", "description"=>"Deletes an AWS Shield Advanced.", "operationId"=>"deleteProtection", "x-api-path-slug"=>"actiondeleteprotection-get", "parameters"=>[{"in"=>"query", "name"=>"ProtectionId", "description"=>"The unique identifier (ID) for the Protection object to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Protection"]}}, "/?Action=DeleteSubscription"=>{"get"=>{"summary"=>"Delete Subscription", "description"=>"Removes AWS Shield Advanced from an account.", "operationId"=>"deleteSubscription", "x-api-path-slug"=>"actiondeletesubscription-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Protection"]}}, "/?Action=DescribeAttack"=>{"get"=>{"summary"=>"Describe Attack", "description"=>"Describes the details of a DDoS attack.", "operationId"=>"describeAttack", "x-api-path-slug"=>"actiondescribeattack-get", "parameters"=>[{"in"=>"query", "name"=>"AttackId", "description"=>"The unique identifier (ID) for the attack that to be described", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attacks"]}}, "/?Action=DescribeProtection"=>{"get"=>{"summary"=>"Describe Protection", "description"=>"Lists the details of a.", "operationId"=>"describeProtection", "x-api-path-slug"=>"actiondescribeprotection-get", "parameters"=>[{"in"=>"query", "name"=>"ProtectionId", "description"=>"The unique identifier (ID) for the Protection object that is described", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Protection"]}}, "/?Action=DescribeSubscription"=>{"get"=>{"summary"=>"Describe Subscription", "description"=>"Provides details about the AWS Shield Advanced subscription for an account.", "operationId"=>"describeSubscription", "x-api-path-slug"=>"actiondescribesubscription-get", "parameters"=>[{"in"=>"query", "name"=>"Subscription", "description"=>"The AWS Shield Advanced subscription details for an account", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/?Action=ListAttacks"=>{"get"=>{"summary"=>"List Attacks", "description"=>"Returns all ongoing DDoS attacks or all DDoS attacks during a specified time\n period.", "operationId"=>"listAttacks", "x-api-path-slug"=>"actionlistattacks-get", "parameters"=>[{"in"=>"query", "name"=>"EndTime", "description"=>"The end of the time period for the attacks", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of AttackSummary objects to be returned", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The ListAttacksRequest", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceArns", "description"=>"The ARN (Amazon Resource Name) of the resource that was attacked", "type"=>"string"}, {"in"=>"query", "name"=>"StartTime", "description"=>"The time period for the attacks", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attacks"]}}, "/?Action=ListProtections"=>{"get"=>{"summary"=>"List Protections", "description"=>"Lists all protections.", "operationId"=>"listProtections", "x-api-path-slug"=>"actionlistprotections-get", "parameters"=>[{"in"=>"query", "name"=>"MaxResults", "description"=>"The maximum number of Protection objects to be returned", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The ListProtectionsRequest", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Protection"]}}}}, "apis"=>{"name"=>"AWS Shield", "x-slug"=>"aws-shield", "description"=>"AWS Shield is a managed Distributed Denial of Service protection service that safeguards web applications running on AWS. AWS Shield provides always-on detection and automatic inline mitigations that minimize application downtime and latency, so there is no need to engage AWS Support to benefit from DDoS protection. There are two tiers of AWS Shield, Standard and Advanced. All AWS customers benefit from the automatic protections of AWS Shield Standard, at no additional charge. AWS Shield Standard defends against most common, frequently occurring network and transport layer DDoS attacks that target your web site or applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2016-12-30 at 10.35.48 PM.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-shield/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Shield API", "x-api-slug"=>"aws-shield-api", "description"=>"AWS Shield is a managed Distributed Denial of Service protection service that safeguards web applications running on AWS. AWS Shield provides always-on detection and automatic inline mitigations that minimize application downtime and latency, so there is no need to engage AWS Support to benefit from DDoS protection. There are two tiers of AWS Shield, Standard and Advanced. All AWS customers benefit from the automatic protections of AWS Shield Standard, at no additional charge. AWS Shield Standard defends against most common, frequently occurring network and transport layer DDoS attacks that target your web site or applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2016-12-30 at 10.35.48 PM.png", "humanURL"=>"https://aws.amazon.com/shield/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-shield/actionlistprotections-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-shield/aws-shield-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/waf/latest/APIReference/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/waf/latest/DDOSAPIReference/Welcome.htm"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/shield/faqs/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/shield/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/shield/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
cloud-elements{"cloud-elements--dropbox-for-business-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Cloud Elements", "x-complete"=>1, "info"=>{"title"=>"Dropbox for Business API", "description"=>"the-business-version-of-the-dropbox-api-", "version"=>"1"}, "host"=>"api.dropbox.com", "basePath"=>"/1/team", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/get_info"=>{"post"=>{"summary"=>"Get Info", "description"=>"Get info.", "operationId"=>"postGetInfo", "x-api-path-slug"=>"get-info-post", "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}, 200=>{"description"=>"OK"}}, "tags"=>["Info"]}}, "/log/get_events"=>{"post"=>{"summary"=>"Get Events", "description"=>"Get events.", "operationId"=>"postLogGetEvents", "x-api-path-slug"=>"logget-events-post", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"optional filter the returned events to a single category (see Event types below)"}, {"in"=>"query", "name"=>"cursor", "description"=>"optional encoded value indicating from what point to get the next limit logs"}, {"in"=>"query", "name"=>"end_ts", "description"=>"optional end time (UTC timestamp in milliseconds since the Unix epoch)"}, {"in"=>"query", "name"=>"limit", "description"=>"optional number of results to return per call (default 1000, maximum 1000)"}, {"in"=>"query", "name"=>"start_ts", "description"=>"optional start time (UTC timestamp in milliseconds since the Unix epoch)"}, {"in"=>"query", "name"=>"user", "description"=>"optional member ID, user ID, or email of a user for filtering events"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/members/add"=>{"post"=>{"summary"=>"Add Member", "description"=>"Add member.", "operationId"=>"postMembersAdd", "x-api-path-slug"=>"membersadd-post", "parameters"=>[{"in"=>"query", "name"=>"member_email", "description"=>"member email"}, {"in"=>"query", "name"=>"member_external_id", "description"=>"optional external ID for member"}, {"in"=>"query", "name"=>"member_given_name", "description"=>"member first name"}, {"in"=>"query", "name"=>"member_surname", "description"=>"member last name"}, {"in"=>"query", "name"=>"send_welcome_email", "description"=>"optional boolean to send a welcome email to the member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Member"]}}, "/members/get_info"=>{"post"=>{"summary"=>"Get Member Info", "description"=>"Get member info.", "operationId"=>"postMembersGetInfo", "x-api-path-slug"=>"membersget-info-post", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"optional email of member"}, {"in"=>"query", "name"=>"external_id", "description"=>"optional external ID of member"}, {"in"=>"query", "name"=>"member_id", "description"=>"optional ID of member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Member", "Info"]}}, "/members/get_info_batch"=>{"post"=>{"summary"=>"Get Info Batch", "description"=>"Get info batch.", "operationId"=>"postMembersGetInfoBatch", "x-api-path-slug"=>"membersget-info-batch-post", "parameters"=>[{"in"=>"query", "name"=>"emails", "description"=>"optional list of member emails"}, {"in"=>"query", "name"=>"external_ids", "description"=>"optional list of external member IDs"}, {"in"=>"query", "name"=>"member_ids", "description"=>"optional list of member IDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Info", "Batch"]}}, "/members/list"=>{"post"=>{"summary"=>"List Members", "description"=>"List members.", "operationId"=>"postMembersList", "x-api-path-slug"=>"memberslist-post", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"optional encoded value indicating from what point to get the next limit members"}, {"in"=>"query", "name"=>"limit", "description"=>"optional number of results to return per call (default 1000, maximum 1000)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Members"]}}, "/members/remove"=>{"post"=>{"summary"=>"Remove", "description"=>"Remove.", "operationId"=>"postMembersRemove", "x-api-path-slug"=>"membersremove-post", "parameters"=>[{"in"=>"query", "name"=>"delete_data", "description"=>"optional controls if the users data will be deleted on their linked devices"}, {"in"=>"query", "name"=>"external_id", "description"=>"optional external ID"}, {"in"=>"query", "name"=>"member_id", "description"=>"optional member ID"}, {"in"=>"query", "name"=>"transfer_admin_member_id", "description"=>"optional errors during the transfer process will be sent via email to the transfer_admin_member_id"}, {"in"=>"query", "name"=>"transfer_dest_member_id", "description"=>"optional files from the deleted member account will be transferred to this member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove"]}}, "/members/set_permissions"=>{"post"=>{"summary"=>"Set Member Permissions", "description"=>"Set member permissions.", "operationId"=>"postMembersSetPermissions", "x-api-path-slug"=>"membersset-permissions-post", "parameters"=>[{"in"=>"query", "name"=>"external_id", "description"=>"optional external ID"}, {"in"=>"query", "name"=>"member_id", "description"=>"optional member ID"}, {"in"=>"query", "name"=>"new_is_admin", "description"=>"optional change the admin status of the member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Member", "Permissions"]}}, "/members/set_profile"=>{"get"=>{"summary"=>"Set Profile", "description"=>"Set profile.", "operationId"=>"getMembersSetProfile", "x-api-path-slug"=>"membersset-profile-get", "parameters"=>[{"in"=>"query", "name"=>"external_id", "description"=>"optional external ID"}, {"in"=>"query", "name"=>"member_id", "description"=>"optional member ID"}, {"in"=>"query", "name"=>"new_email", "description"=>"optional new email for member"}, {"in"=>"query", "name"=>"new_external_id", "description"=>"optional new external ID for member"}, {"in"=>"query", "name"=>"new_given_name", "description"=>"optional new given name for member"}, {"in"=>"query", "name"=>"new_surname", "description"=>"optional new surname for member"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Profile"]}}, "/reports/get_activity"=>{"post"=>{"summary"=>"Get Activity", "description"=>"Get activity.", "operationId"=>"postReportsGetActivity", "x-api-path-slug"=>"reportsget-activity-post", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"optional ending date (exclusive)"}, {"in"=>"query", "name"=>"start_date", "description"=>"optional starting date (inclusive)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity"]}}, "/reports/get_devices"=>{"post"=>{"summary"=>"Get Devices", "description"=>"Get devices.", "operationId"=>"postReportsGetDevices", "x-api-path-slug"=>"reportsget-devices-post", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"optional ending date (exclusive)"}, {"in"=>"query", "name"=>"start_date", "description"=>"optional starting date (inclusive)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/reports/get_membership"=>{"post"=>{"summary"=>"Get Membership", "description"=>"Get membership.", "operationId"=>"postReportsGetMembership", "x-api-path-slug"=>"reportsget-membership-post", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"optional ending date (exclusive)"}, {"in"=>"query", "name"=>"start_date", "description"=>"optional starting date (inclusive)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Membership"]}}, "/reports/get_storage"=>{"post"=>{"summary"=>"Get Storage", "description"=>"Get storage.", "operationId"=>"postReportsGetStorage", "x-api-path-slug"=>"reportsget-storage-post", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"optional ending date (exclusive)"}, {"in"=>"query", "name"=>"start_date", "description"=>"optional starting date (inclusive)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage"]}}}}, "apis"=>{"name"=>"Cloud Elements", "x-slug"=>"cloud-elements", "description"=>"Cloud Elements is the leading API integration platform for SaaS app providers and the digital enterprise. Turn integration into your competitive advantage.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/9066-cloud-elements.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"278908", "tags"=>"Aggregation,Aggregation,Aggregation,API LIfeyclessss,API Provider,API Service Provider,Cloud,Enterprise,internet,Profiles,Relative Data,SaaS,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"cloud-elements/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Cloud Elements - Dropbox For Business API", "x-api-slug"=>"cloud-elements--dropbox-for-business-api", "description"=>"Cloud Elements is the leading API integration platform for SaaS app providers and the digital enterprise. Turn integration into your competitive advantage.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/9066-cloud-elements.jpg", "humanURL"=>"http://www.cloud-elements.com/", "baseURL"=>"https://api.dropbox.com//1/team", "tags"=>"Aggregation,Aggregation,Aggregation,API LIfeyclessss,API Provider,API Service Provider,Cloud,Enterprise,internet,Profiles,Relative Data,SaaS,Service API,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/cloud-elements/reportsget-storage-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/cloud-elements/cloud-elements--dropbox-for-business-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://www.cloud-elements.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"http://www.cloud-elements.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/cloud-elements"}, {"type"=>"x-developer", "url"=>"http://cloud-elements.com/developer/"}, {"type"=>"x-email", "url"=>"info@cloud-elements.com"}, {"type"=>"x-email", "url"=>"compliance@cloud-elements.com"}, {"type"=>"x-github", "url"=>"https://github.com/cloud-elements"}, {"type"=>"x-pricing", "url"=>"http://cloud-elements.com/pricing/"}, {"type"=>"x-privacy", "url"=>"http://cloud-elements.com/privacy/"}, {"type"=>"x-terms-of-service", "url"=>"http://cloud-elements.com/terms-conditions-use/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/cloudelements"}, {"type"=>"x-website", "url"=>"http://www.cloud-elements.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
data-gov-au{"regulations-gov-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Data.Gov.au", "x-complete"=>1, "info"=>{"title"=>"Regulations.gov", "description"=>"provides-public-users-access-to-federal-regulatory-content-", "version"=>"3.0"}, "host"=>"api.data.gov", "basePath"=>"/regulations/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/docket.{response_format}"=>{"get"=>{"summary"=>"Returns Docket information", "description"=>"Returns docket information.", "operationId"=>"getDocket.ResponseFormat", "x-api-path-slug"=>"docket-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"docketId", "description"=>"Docket ID"}, {"in"=>"path", "name"=>"response_format", "description"=>"Format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Docket", "Information"]}}, "/document.{response_format}"=>{"get"=>{"summary"=>"Returns Document information", "description"=>"Returns document information.", "operationId"=>"getDocument.ResponseFormat", "x-api-path-slug"=>"document-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"documentId", "description"=>"FDMS Document ID"}, {"in"=>"query", "name"=>"federalRegisterNumber", "description"=>"Federal Register Document Number"}, {"in"=>"path", "name"=>"response_format", "description"=>"Format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Document", "Information"]}}, "/documents.{response_format}"=>{"get"=>{"summary"=>"Search for Documents", "description"=>"Search for documents.", "operationId"=>"getDocuments.ResponseFormat", "x-api-path-slug"=>"documents-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"a", "description"=>"Federal Agency: List of accepted Federal Agency values"}, {"in"=>"query", "name"=>"cat", "description"=>"Document Category: AD (Aerospace and Transportation) AEP (Agriculture, Environment, and Public Lands) BFS (Banking and Financial) CT (Commerce and International) LES (Defense, Law Enforcement, and Security) EELS (Education, Labor, Presidential, and Government Services) EUMM (Energy, Natural Resources, and Utilities) HCFP (Food Safety, Health, and Pharmaceutical) PRE (Housing, Development, and Real Estate) ITT (Technology and Telecommunications)"}, {"in"=>"query", "name"=>"cmd", "description"=>"Comment Period End Date: Enter a date in the form of MM/DD/YY"}, {"in"=>"query", "name"=>"cmsd", "description"=>"Comment Period Start Date: Enter a date in the form of MM/DD/YY"}, {"in"=>"query", "name"=>"countsOnly", "description"=>"Counts Only: 1 (will return only the document count for a search query)0 (will return documents as well)"}, {"in"=>"query", "name"=>"cp", "description"=>"Comment Period: O: OpenC: Closed"}, {"in"=>"query", "name"=>"crd", "description"=>"Creation Date: Enter a date in the form of MM/DD/YY"}, {"in"=>"query", "name"=>"cs", "description"=>"Comment Period Closing Soon: 0 (closing today)3 (closing within 3 days)15 (closing within 15 days)30 (closing within 30 days)90 (closing within 90 days)"}, {"in"=>"query", "name"=>"dct", "description"=>"Document Type: N: NoticePR: Proposed RuleFR: RuleO: OtherSR: Supporting & Related MaterialPS: Public Submission"}, {"in"=>"query", "name"=>"dkt", "description"=>"Docket Type: R: RulemakingN: NonrulemakingA Docket Type is either Rulemaking or Nonrulemaking"}, {"in"=>"query", "name"=>"dktid", "description"=>"Valid Docket ID (ex"}, {"in"=>"query", "name"=>"dktst", "description"=>"Docket Subtype: Only one docket subtype at a time may be selected"}, {"in"=>"query", "name"=>"dktst2", "description"=>"Docket Sub-subtype: Only one docket sub-subtype at a time may be selected"}, {"in"=>"query", "name"=>"docst", "description"=>"Document Subtype: Single or multiple document subtypes may be included"}, {"in"=>"query", "name"=>"encoded", "description"=>"Encoded: 1 (will accept Regulations"}, {"in"=>"query", "name"=>"np", "description"=>"Newly Posted: 0 (posted today)3 (posted within last 3 days)15 (posted within last 15 days)30 (posted within last 30 days)90 (posted within last 90 days) For periods of time beyond 90-days, please use a date range with the Posted Date parameter"}, {"in"=>"query", "name"=>"pd", "description"=>"Posted Date: Enter a date in the form of MM/DD/YY"}, {"in"=>"query", "name"=>"po", "description"=>"Enter the page offset (always starts with 0)"}, {"in"=>"query", "name"=>"rd", "description"=>"Received Date: Enter a date in the form of MM/DD/YY"}, {"in"=>"path", "name"=>"response_format", "description"=>"Format"}, {"in"=>"query", "name"=>"rpp", "description"=>"Results Per Page 10, 25, 100, 500, 1,000"}, {"in"=>"query", "name"=>"s", "description"=>"Keyword(s)"}, {"in"=>"query", "name"=>"sb", "description"=>"Sort By: docketId (Docket ID)docId (Document ID)title (Title)postedDate (Posted Date)agency (Agency)documentType (Document Type)submitterName (Submitter Name)organization (Organization) Sort Order is REQUIRED if this parameter is included"}, {"in"=>"query", "name"=>"so", "description"=>"Sort Order: ASC: AscendingDESC: Descending"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SearchDocuments"]}}}}, "apis"=>{"name"=>"Data.Gov.au", "x-slug"=>"data-gov-au", "description"=>"In a world that is becoming increasingly more visual, the ability to find and use images effectively gives communications professionals a competitive advantage. Cutcaster has tapped into a new creative universe of unique photos and vector illustrations that can be purchased royalty free for use in publishing, web design project, printing brochures, advertising, corporate marketing, electronic usage on websites and presentations. Cutcaster is the first model that adds a dynamic marketplace structure to support licensing user-generated photography and vectors. If you don’t have the budget or time to create the content yourself and want to find the most original, highest quality and authentic content not previously available to license and within your budget, then join us for free at Cutcaster.Sellers have the flexibility to set their prices or those new to the world of licensing can use the Cutcaster Algorithm to determine a fair market price for them. There are many ways to purchase photos and vectors from Cutcaster. Buyers can browse the growing Cutcaster image library, download comps, buy credits, sign up for corporate accounts, add images and vectors to their shopping cart without registering and immediately download content when they need it. In addition, buyers, if they choose, can seamlessly name their price by bidding on the photos or illustrations, which a seller can quickly accept, decline or submit a new offer back. If we don’t have what you are looking for or you can’t find it anywhere during your search, you can request custom content and set a deadline in the ProjectRequest area on the homepage and give our amazing user-base the opportunity to “wow” you with fresh, authentic and timely content.", "image"=>"", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,Australia,Australian Government,Australian Government,Data Provider,Datasets,General Data,Government,Profiles", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"data-gov-au/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Regulations.gov", "x-api-slug"=>"regulations-gov", "description"=>"Regulations.gov is a website from the United States federal government for helping citizens access documents describing federal regulations. Government agencies post notices, rules, proposed rules and requests for comment on the site. Users can search by timeframe, keyword and type of document.The Regulations.gov API provides developers with access to the same information on the website in a programmatic interface. Search documents, retrieve specific dockets or get document information. Developers can filter search results by date, agency, docket ID and comment period.The full documentation is available on the site as a PDF linked from the footer. The API returns data as XML or JSON and requires an API Key available upon request.", "image"=>"", "humanURL"=>"http://data.gov.au/", "baseURL"=>"https://api.data.gov//regulations/v3", "tags"=>"API Provider,Australia,Australian Government,Australian Government,Data Provider,Datasets,General Data,Government,Profiles", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/data-gov-au/documents-response-format-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/data-gov-au/regulations-gov-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://data.gov.au/"}, {"type"=>"x-website", "url"=>"http://data.gov"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
broadleaf-commerce{"broadleaf-commerce-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Broadleaf Commerce", "x-complete"=>1, "info"=>{"title"=>"Broadleaf Commerce API", "description"=>"the-default-broadleaf-commerce-apis", "version"=>"1.0.0"}, "host"=>"demo.broadleafcommerce.org", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/auditevents"=>{"get"=>{"summary"=>"Get Auditevents", "description"=>"Get auditevents.", "operationId"=>"getAuditevents", "x-api-path-slug"=>"auditevents-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"after"}, {"in"=>"query", "name"=>"principal", "description"=>"principal"}, {"in"=>"query", "name"=>"type", "description"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auditevents"]}}, "/auditevents.json"=>{"get"=>{"summary"=>"Get Auditevents", "description"=>"Get auditevents.", "operationId"=>"getAuditevents.json", "x-api-path-slug"=>"auditevents-json-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"after"}, {"in"=>"query", "name"=>"principal", "description"=>"principal"}, {"in"=>"query", "name"=>"type", "description"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auditevents"]}}, "/autoconfig"=>{"get"=>{"summary"=>"Get Autoconfig", "description"=>"Get autoconfig.", "operationId"=>"getAutoconfig", "x-api-path-slug"=>"autoconfig-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoconfig"]}}, "/autoconfig.json"=>{"get"=>{"summary"=>"Get Autoconfig", "description"=>"Get autoconfig.", "operationId"=>"getAutoconfig.json", "x-api-path-slug"=>"autoconfig-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoconfig"]}}, "/beans"=>{"get"=>{"summary"=>"Get Beans", "description"=>"Get beans.", "operationId"=>"getBeans", "x-api-path-slug"=>"beans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Beans"]}}, "/beans.json"=>{"get"=>{"summary"=>"Get Beans", "description"=>"Get beans.", "operationId"=>"getBeans.json", "x-api-path-slug"=>"beans-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Beans"]}}, "/cart"=>{"get"=>{"summary"=>"Get Cart", "description"=>"Get cart.", "operationId"=>"getCart", "x-api-path-slug"=>"cart-get", "parameters"=>[{"in"=>"query", "name"=>"customerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart"]}, "post"=>{"summary"=>"Post Cart", "description"=>"Post cart.", "operationId"=>"postCart", "x-api-path-slug"=>"cart-post", "parameters"=>[{"in"=>"query", "name"=>"customerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart"]}}, "/cart/checkout"=>{"post"=>{"summary"=>"Post Cart Checkout", "description"=>"Post cart checkout.", "operationId"=>"postCartCheckout", "x-api-path-slug"=>"cartcheckout-post", "parameters"=>[{"in"=>"query", "name"=>"cartId", "description"=>"cartId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Checkout"]}}, "/cart/checkout/payment"=>{"post"=>{"summary"=>"Post Cart Checkout Payment", "description"=>"Post cart checkout payment.", "operationId"=>"postCartCheckoutPayment", "x-api-path-slug"=>"cartcheckoutpayment-post", "parameters"=>[{"in"=>"query", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"body", "name"=>"wrapper", "description"=>"wrapper", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Checkout", "Payment"]}}, "/cart/checkout/payment/{customerPaymentId}"=>{"post"=>{"summary"=>"Post Cart Checkout Payment Customerpaymentid", "description"=>"Post cart checkout payment customerpaymentid.", "operationId"=>"postCartCheckoutPaymentCustomerpayment", "x-api-path-slug"=>"cartcheckoutpaymentcustomerpaymentid-post", "parameters"=>[{"in"=>"query", "name"=>"amount", "description"=>"amount"}, {"in"=>"query", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"query", "name"=>"currency", "description"=>"currency"}, {"in"=>"path", "name"=>"customerPaymentId", "description"=>"customerPaymentId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Checkout", "Payment", "Customerpaymentid"]}}, "/cart/checkout/payment/{paymentId}"=>{"delete"=>{"summary"=>"Delete Cart Checkout Payment Paymentid", "description"=>"Delete cart checkout payment paymentid.", "operationId"=>"deleteCartCheckoutPaymentPayment", "x-api-path-slug"=>"cartcheckoutpaymentpaymentid-delete", "parameters"=>[{"in"=>"query", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"path", "name"=>"paymentId", "description"=>"paymentId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Checkout", "Payment", "Paymentid"]}}, "/cart/checkout/payment/{paymentId}/transaction"=>{"put"=>{"summary"=>"Put Cart Checkout Payment Paymentid Transaction", "description"=>"Put cart checkout payment paymentid transaction.", "operationId"=>"putCartCheckoutPaymentPaymentTransaction", "x-api-path-slug"=>"cartcheckoutpaymentpaymentidtransaction-put", "parameters"=>[{"in"=>"query", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"path", "name"=>"paymentId", "description"=>"paymentId"}, {"in"=>"body", "name"=>"wrapper", "description"=>"wrapper", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Checkout", "Payment", "Paymentid", "Transaction"]}}, "/cart/checkout/payments"=>{"get"=>{"summary"=>"Get Cart Checkout Payments", "description"=>"Get cart checkout payments.", "operationId"=>"getCartCheckoutPayments", "x-api-path-slug"=>"cartcheckoutpayments-get", "parameters"=>[{"in"=>"query", "name"=>"cartId", "description"=>"cartId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Checkout", "Payments"]}}, "/cart/{cartId}"=>{"get"=>{"summary"=>"Get Cart", "description"=>"Get cart.", "operationId"=>"getCartCart", "x-api-path-slug"=>"cartcartid-get", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"query", "name"=>"customerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart"]}}, "/cart/{cartId}/attributes"=>{"put"=>{"summary"=>"Put Cart Attributes", "description"=>"Put cart attributes.", "operationId"=>"putCartCartAttributes", "x-api-path-slug"=>"cartcartidattributes-put", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"query", "name"=>"customerId"}, {"in"=>"query", "name"=>"priceOrder", "description"=>"priceOrder"}, {"in"=>"body", "name"=>"requestParams", "description"=>"requestParams", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Attributes"]}, "delete"=>{"summary"=>"Delete Cart Attributes", "description"=>"Delete cart attributes.", "operationId"=>"deleteCartCartAttributes", "x-api-path-slug"=>"cartcartidattributes-delete", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"query", "name"=>"customerId"}, {"in"=>"query", "name"=>"priceOrder", "description"=>"priceOrder"}, {"in"=>"body", "name"=>"requestParams", "description"=>"requestParams", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Attributes"]}}, "/cart/{cartId}/item"=>{"post"=>{"summary"=>"Post Cart Item", "description"=>"Post cart item.", "operationId"=>"postCartCartItem", "x-api-path-slug"=>"cartcartiditem-post", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"query", "name"=>"customerId"}, {"in"=>"body", "name"=>"orderItemWrapper", "description"=>"orderItemWrapper", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"priceOrder", "description"=>"priceOrder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Item"]}}, "/cart/{cartId}/item/{itemId}/attributes"=>{"put"=>{"summary"=>"Put Cart Item Attributes", "description"=>"Put cart item attributes.", "operationId"=>"putCartCartItemItemAttributes", "x-api-path-slug"=>"cartcartiditemitemidattributes-put", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"query", "name"=>"customerId"}, {"in"=>"path", "name"=>"itemId", "description"=>"itemId"}, {"in"=>"query", "name"=>"priceOrder", "description"=>"priceOrder"}, {"in"=>"body", "name"=>"requestParams", "description"=>"requestParams", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Item", "Attributes"]}, "delete"=>{"summary"=>"Delete Cart Item Attributes", "description"=>"Delete cart item attributes.", "operationId"=>"deleteCartCartItemItemAttributes", "x-api-path-slug"=>"cartcartiditemitemidattributes-delete", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"query", "name"=>"customerId"}, {"in"=>"path", "name"=>"itemId", "description"=>"itemId"}, {"in"=>"query", "name"=>"priceOrder", "description"=>"priceOrder"}, {"in"=>"body", "name"=>"requestParams", "description"=>"requestParams", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Item", "Attributes"]}}, "/cart/{cartId}/items/{itemId}"=>{"put"=>{"summary"=>"Put Cart Items", "description"=>"Put cart items.", "operationId"=>"putCartCartItemsItem", "x-api-path-slug"=>"cartcartiditemsitemid-put", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"query", "name"=>"customerId"}, {"in"=>"path", "name"=>"itemId", "description"=>"itemId"}, {"in"=>"query", "name"=>"priceOrder", "description"=>"priceOrder"}, {"in"=>"query", "name"=>"quantity", "description"=>"quantity"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Items"]}, "delete"=>{"summary"=>"Delete Cart Items", "description"=>"Delete cart items.", "operationId"=>"deleteCartCartItemsItem", "x-api-path-slug"=>"cartcartiditemsitemid-delete", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"query", "name"=>"customerId"}, {"in"=>"path", "name"=>"itemId", "description"=>"itemId"}, {"in"=>"query", "name"=>"priceOrder", "description"=>"priceOrder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Items"]}}, "/cart/{cartId}/offer/{promoCode}"=>{"post"=>{"summary"=>"Post Cart Offer Promocode", "description"=>"Post cart offer promocode.", "operationId"=>"postCartCartOfferPromocode", "x-api-path-slug"=>"cartcartidofferpromocode-post", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"query", "name"=>"customerId"}, {"in"=>"query", "name"=>"priceOrder", "description"=>"priceOrder"}, {"in"=>"path", "name"=>"promoCode", "description"=>"promoCode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Offer", "Promocode"]}, "delete"=>{"summary"=>"Delete Cart Offer Promocode", "description"=>"Delete cart offer promocode.", "operationId"=>"deleteCartCartOfferPromocode", "x-api-path-slug"=>"cartcartidofferpromocode-delete", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"query", "name"=>"customerId"}, {"in"=>"query", "name"=>"priceOrder", "description"=>"priceOrder"}, {"in"=>"path", "name"=>"promoCode", "description"=>"promoCode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Offer", "Promocode"]}}, "/cart/{cartId}/offers"=>{"delete"=>{"summary"=>"Delete Cart Offers", "description"=>"Delete cart offers.", "operationId"=>"deleteCartCartOffers", "x-api-path-slug"=>"cartcartidoffers-delete", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"query", "name"=>"customerId"}, {"in"=>"query", "name"=>"priceOrder", "description"=>"priceOrder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cart", "Offers"]}}, "/catalog/categories"=>{"get"=>{"summary"=>"Get Catalog Categories", "description"=>"Get catalog categories.", "operationId"=>"getCatalogCategories", "x-api-path-slug"=>"catalogcategories-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"limit"}, {"in"=>"query", "name"=>"name", "description"=>"name"}, {"in"=>"query", "name"=>"offset", "description"=>"offset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Categories"]}}, "/catalog/category"=>{"get"=>{"summary"=>"Get Catalog Category", "description"=>"Get catalog category.", "operationId"=>"getCatalogCategory", "x-api-path-slug"=>"catalogcategory-get", "parameters"=>[{"in"=>"query", "name"=>"productLimit", "description"=>"productLimit"}, {"in"=>"query", "name"=>"productOffset", "description"=>"productOffset"}, {"in"=>"query", "name"=>"searchParameter", "description"=>"searchParameter"}, {"in"=>"query", "name"=>"subcategoryLimit", "description"=>"subcategoryLimit"}, {"in"=>"query", "name"=>"subcategoryOffset", "description"=>"subcategoryOffset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Category"]}}, "/catalog/category/{categoryId}"=>{"get"=>{"summary"=>"Get Catalog Category", "description"=>"Get catalog category.", "operationId"=>"getCatalogCategoryCategory", "x-api-path-slug"=>"catalogcategorycategoryid-get", "parameters"=>[{"in"=>"path", "name"=>"categoryId", "description"=>"categoryId"}, {"in"=>"query", "name"=>"productLimit", "description"=>"productLimit"}, {"in"=>"query", "name"=>"productOffset", "description"=>"productOffset"}, {"in"=>"query", "name"=>"subcategoryLimit", "description"=>"subcategoryLimit"}, {"in"=>"query", "name"=>"subcategoryOffset", "description"=>"subcategoryOffset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Category"]}}, "/catalog/category/{categoryId}/activeSubcategories"=>{"get"=>{"summary"=>"Get Catalog Category Active Subcategories", "description"=>"Get catalog category active subcategories.", "operationId"=>"getCatalogCategoryCategoryActivesubcategories", "x-api-path-slug"=>"catalogcategorycategoryidactivesubcategories-get", "parameters"=>[{"in"=>"path", "name"=>"categoryId", "description"=>"categoryId"}, {"in"=>"query", "name"=>"limit", "description"=>"limit"}, {"in"=>"query", "name"=>"offset", "description"=>"offset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Category", "Active", "Subcategories"]}}, "/catalog/category/{categoryId}/attributes"=>{"get"=>{"summary"=>"Get Catalog Category Attributes", "description"=>"Get catalog category attributes.", "operationId"=>"getCatalogCategoryCategoryAttributes", "x-api-path-slug"=>"catalogcategorycategoryidattributes-get", "parameters"=>[{"in"=>"path", "name"=>"categoryId", "description"=>"categoryId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Category", "Attributes"]}}, "/catalog/category/{categoryId}/categories"=>{"get"=>{"summary"=>"Get Catalog Category Categories", "description"=>"Get catalog category categories.", "operationId"=>"getCatalogCategoryCategoryCategories", "x-api-path-slug"=>"catalogcategorycategoryidcategories-get", "parameters"=>[{"in"=>"query", "name"=>"active", "description"=>"active"}, {"in"=>"path", "name"=>"categoryId", "description"=>"categoryId"}, {"in"=>"query", "name"=>"limit", "description"=>"limit"}, {"in"=>"query", "name"=>"offset", "description"=>"offset"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Category", "Categories"]}}, "/catalog/category/{id}/media"=>{"get"=>{"summary"=>"Get Catalog Category Media", "description"=>"Get catalog category media.", "operationId"=>"getCatalogCategoryMedia", "x-api-path-slug"=>"catalogcategoryidmedia-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Category", "Media"]}}, "/catalog/product/{id}"=>{"get"=>{"summary"=>"Get Catalog Product", "description"=>"Get catalog product.", "operationId"=>"getCatalogProduct", "x-api-path-slug"=>"catalogproductid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"id"}, {"in"=>"query", "name"=>"includePriceData", "description"=>"includePriceData"}, {"in"=>"query", "name"=>"includePromotionMessages", "description"=>"includePromotionMessages"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Product"]}}, "/catalog/product/{productId}/attributes"=>{"get"=>{"summary"=>"Get Catalog Product Attributes", "description"=>"Get catalog product attributes.", "operationId"=>"getCatalogProductProductAttributes", "x-api-path-slug"=>"catalogproductproductidattributes-get", "parameters"=>[{"in"=>"path", "name"=>"productId", "description"=>"productId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Product", "Attributes"]}}, "/catalog/product/{productId}/categories"=>{"get"=>{"summary"=>"Get Catalog Product Categories", "description"=>"Get catalog product categories.", "operationId"=>"getCatalogProductProductCategories", "x-api-path-slug"=>"catalogproductproductidcategories-get", "parameters"=>[{"in"=>"path", "name"=>"productId", "description"=>"productId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Product", "Categories"]}}, "/catalog/product/{productId}/crosssale"=>{"get"=>{"summary"=>"Get Catalog Product Crosssale", "description"=>"Get catalog product crosssale.", "operationId"=>"getCatalogProductProductCrosssale", "x-api-path-slug"=>"catalogproductproductidcrosssale-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"limit"}, {"in"=>"query", "name"=>"offset", "description"=>"offset"}, {"in"=>"path", "name"=>"productId", "description"=>"productId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Product", "Crosssale"]}}, "/catalog/product/{productId}/defaultSku"=>{"get"=>{"summary"=>"Get Catalog Product Default sku", "description"=>"Get catalog product default sku.", "operationId"=>"getCatalogProductProductDefaultsku", "x-api-path-slug"=>"catalogproductproductiddefaultsku-get", "parameters"=>[{"in"=>"path", "name"=>"productId", "description"=>"productId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Product", "Default", "Sku"]}}, "/catalog/product/{productId}/media"=>{"get"=>{"summary"=>"Get Catalog Product Media", "description"=>"Get catalog product media.", "operationId"=>"getCatalogProductProductMedia", "x-api-path-slug"=>"catalogproductproductidmedia-get", "parameters"=>[{"in"=>"path", "name"=>"productId", "description"=>"productId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Product", "Media"]}}, "/catalog/product/{productId}/skus"=>{"get"=>{"summary"=>"Get Catalog Product Skus", "description"=>"Get catalog product skus.", "operationId"=>"getCatalogProductProductSkus", "x-api-path-slug"=>"catalogproductproductidskus-get", "parameters"=>[{"in"=>"path", "name"=>"productId", "description"=>"productId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Product", "Skus"]}}, "/catalog/product/{productId}/upsale"=>{"get"=>{"summary"=>"Get Catalog Product Upsale", "description"=>"Get catalog product upsale.", "operationId"=>"getCatalogProductProductUpsale", "x-api-path-slug"=>"catalogproductproductidupsale-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"limit"}, {"in"=>"query", "name"=>"offset", "description"=>"offset"}, {"in"=>"path", "name"=>"productId", "description"=>"productId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Product", "Upsale"]}}, "/catalog/search"=>{"get"=>{"summary"=>"Get Catalog Search", "description"=>"Get catalog search.", "operationId"=>"getCatalogSearch", "x-api-path-slug"=>"catalogsearch-get", "parameters"=>[{"in"=>"query", "name"=>"includePriceData", "description"=>"includePriceData"}, {"in"=>"query", "name"=>"includePromotionMessages", "description"=>"includePromotionMessages"}, {"in"=>"query", "name"=>"page", "description"=>"page"}, {"in"=>"query", "name"=>"pageSize", "description"=>"pageSize"}, {"in"=>"query", "name"=>"q", "description"=>"q"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Search"]}}, "/catalog/search/category/{categoryId}"=>{"get"=>{"summary"=>"Get Catalog Search Category", "description"=>"Get catalog search category.", "operationId"=>"getCatalogSearchCategoryCategory", "x-api-path-slug"=>"catalogsearchcategorycategoryid-get", "parameters"=>[{"in"=>"path", "name"=>"categoryId", "description"=>"categoryId"}, {"in"=>"query", "name"=>"includePriceData", "description"=>"includePriceData"}, {"in"=>"query", "name"=>"includePromotionMessages", "description"=>"includePromotionMessages"}, {"in"=>"query", "name"=>"page", "description"=>"page"}, {"in"=>"query", "name"=>"pageSize", "description"=>"pageSize"}, {"in"=>"query", "name"=>"q", "description"=>"q"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Search", "Category"]}}, "/catalog/sku/inventory"=>{"get"=>{"summary"=>"Get Catalog Sku Inventory", "description"=>"Get catalog sku inventory.", "operationId"=>"getCatalogSkuInventory", "x-api-path-slug"=>"catalogskuinventory-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Sku", "Inventory"]}}, "/catalog/sku/{skuId}"=>{"get"=>{"summary"=>"Get Catalog Sku Skuid", "description"=>"Get catalog sku skuid.", "operationId"=>"getCatalogSkuSku", "x-api-path-slug"=>"catalogskuskuid-get", "parameters"=>[{"in"=>"path", "name"=>"skuId", "description"=>"skuId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Sku", "Skuid"]}}, "/catalog/sku/{skuId}/attributes"=>{"get"=>{"summary"=>"Get Catalog Sku Skuid Attributes", "description"=>"Get catalog sku skuid attributes.", "operationId"=>"getCatalogSkuSkuAttributes", "x-api-path-slug"=>"catalogskuskuidattributes-get", "parameters"=>[{"in"=>"path", "name"=>"skuId", "description"=>"skuId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Sku", "Skuid", "Attributes"]}}, "/catalog/sku/{skuId}/media"=>{"get"=>{"summary"=>"Get Catalog Sku Skuid Media", "description"=>"Get catalog sku skuid media.", "operationId"=>"getCatalogSkuSkuMedia", "x-api-path-slug"=>"catalogskuskuidmedia-get", "parameters"=>[{"in"=>"path", "name"=>"skuId", "description"=>"skuId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Sku", "Skuid", "Media"]}}, "/configprops"=>{"get"=>{"summary"=>"Get Configprops", "description"=>"Get configprops.", "operationId"=>"getConfigprops", "x-api-path-slug"=>"configprops-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configprops"]}}, "/configprops.json"=>{"get"=>{"summary"=>"Get Configprops", "description"=>"Get configprops.", "operationId"=>"getConfigprops.json", "x-api-path-slug"=>"configprops-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configprops"]}}, "/customer"=>{"get"=>{"summary"=>"Get Customer", "description"=>"Get customer.", "operationId"=>"getCustomer", "x-api-path-slug"=>"customer-get", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"email"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer"]}, "post"=>{"summary"=>"Post Customer", "description"=>"Post customer.", "operationId"=>"postCustomer", "x-api-path-slug"=>"customer-post", "parameters"=>[{"in"=>"body", "name"=>"wrapper", "description"=>"wrapper", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer"]}, "put"=>{"summary"=>"Put Customer", "description"=>"Put customer.", "operationId"=>"putCustomer", "x-api-path-slug"=>"customer-put", "parameters"=>[{"in"=>"query", "name"=>"customerId"}, {"in"=>"body", "name"=>"wrapper", "description"=>"wrapper", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer"]}}, "/customer/address"=>{"get"=>{"summary"=>"Get Customer Address", "description"=>"Get customer address.", "operationId"=>"getCustomerAddress", "x-api-path-slug"=>"customeraddress-get", "parameters"=>[{"in"=>"query", "name"=>"addressName", "description"=>"addressName"}, {"in"=>"query", "name"=>"customerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Ress"]}, "put"=>{"summary"=>"Put Customer Address", "description"=>"Put customer address.", "operationId"=>"putCustomerAddress", "x-api-path-slug"=>"customeraddress-put", "parameters"=>[{"in"=>"query", "name"=>"customerId"}, {"in"=>"body", "name"=>"wrapper", "description"=>"wrapper", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Ress"]}}, "/customer/address/{addressId}"=>{"put"=>{"summary"=>"Put Customer Address Addressid", "description"=>"Put customer address addressid.", "operationId"=>"putCustomerAddressAddress", "x-api-path-slug"=>"customeraddressaddressid-put", "parameters"=>[{"in"=>"path", "name"=>"addressId", "description"=>"addressId"}, {"in"=>"query", "name"=>"customerId"}, {"in"=>"body", "name"=>"wrapper", "description"=>"wrapper", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Ress", "Ressid"]}}, "/customer/address/{addressName}"=>{"delete"=>{"summary"=>"Delete Customer Address Addressname", "description"=>"Delete customer address addressname.", "operationId"=>"deleteCustomerAddressAddressname", "x-api-path-slug"=>"customeraddressaddressname-delete", "parameters"=>[{"in"=>"path", "name"=>"addressName", "description"=>"addressName"}, {"in"=>"query", "name"=>"customerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Ress", "Ressname"]}}, "/customer/addresses"=>{"get"=>{"summary"=>"Get Customer Addresses", "description"=>"Get customer addresses.", "operationId"=>"getCustomerAddresses", "x-api-path-slug"=>"customeraddresses-get", "parameters"=>[{"in"=>"query", "name"=>"customerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Resses"]}, "delete"=>{"summary"=>"Delete Customer Addresses", "description"=>"Delete customer addresses.", "operationId"=>"deleteCustomerAddresses", "x-api-path-slug"=>"customeraddresses-delete", "parameters"=>[{"in"=>"query", "name"=>"customerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Resses"]}}, "/customer/attribute"=>{"put"=>{"summary"=>"Put Customer Attribute", "description"=>"Put customer attribute.", "operationId"=>"putCustomerAttribute", "x-api-path-slug"=>"customerattribute-put", "parameters"=>[{"in"=>"query", "name"=>"customerId"}, {"in"=>"body", "name"=>"wrapper", "description"=>"wrapper", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Attribute"]}}, "/customer/attribute/{attributeName}"=>{"delete"=>{"summary"=>"Delete Customer Attribute Attributename", "description"=>"Delete customer attribute attributename.", "operationId"=>"deleteCustomerAttributeAttributename", "x-api-path-slug"=>"customerattributeattributename-delete", "parameters"=>[{"in"=>"path", "name"=>"attributeName", "description"=>"attributeName"}, {"in"=>"query", "name"=>"customerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Attribute", "Attributename"]}}, "/customer/attributes"=>{"delete"=>{"summary"=>"Delete Customer Attributes", "description"=>"Delete customer attributes.", "operationId"=>"deleteCustomerAttributes", "x-api-path-slug"=>"customerattributes-delete", "parameters"=>[{"in"=>"query", "name"=>"customerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Attributes"]}}, "/customer/password"=>{"post"=>{"summary"=>"Post Customer Password", "description"=>"Post customer password.", "operationId"=>"postCustomerPassword", "x-api-path-slug"=>"customerpassword-post", "parameters"=>[{"in"=>"body", "name"=>"changePasswordForm", "description"=>"changePasswordForm", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Password"]}}, "/customer/payment"=>{"get"=>{"summary"=>"Get Customer Payment", "description"=>"Get customer payment.", "operationId"=>"getCustomerPayment", "x-api-path-slug"=>"customerpayment-get", "parameters"=>[{"in"=>"query", "name"=>"customerId"}, {"in"=>"query", "name"=>"paymentId", "description"=>"paymentId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Payment"]}, "post"=>{"summary"=>"Post Customer Payment", "description"=>"Post customer payment.", "operationId"=>"postCustomerPayment", "x-api-path-slug"=>"customerpayment-post", "parameters"=>[{"in"=>"query", "name"=>"customerId"}, {"in"=>"body", "name"=>"wrapper", "description"=>"wrapper", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Payment"]}}, "/customer/payment/{paymentId}"=>{"put"=>{"summary"=>"Put Customer Payment Paymentid", "description"=>"Put customer payment paymentid.", "operationId"=>"putCustomerPaymentPayment", "x-api-path-slug"=>"customerpaymentpaymentid-put", "parameters"=>[{"in"=>"query", "name"=>"customerId"}, {"in"=>"path", "name"=>"paymentId", "description"=>"paymentId"}, {"in"=>"body", "name"=>"wrapper", "description"=>"wrapper", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Payment", "Paymentid"]}, "delete"=>{"summary"=>"Delete Customer Payment Paymentid", "description"=>"Delete customer payment paymentid.", "operationId"=>"deleteCustomerPaymentPayment", "x-api-path-slug"=>"customerpaymentpaymentid-delete", "parameters"=>[{"in"=>"query", "name"=>"customerId"}, {"in"=>"path", "name"=>"paymentId", "description"=>"paymentId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Payment", "Paymentid"]}}, "/customer/payments"=>{"get"=>{"summary"=>"Get Customer Payments", "description"=>"Get customer payments.", "operationId"=>"getCustomerPayments", "x-api-path-slug"=>"customerpayments-get", "parameters"=>[{"in"=>"query", "name"=>"customerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Payments"]}, "delete"=>{"summary"=>"Delete Customer Payments", "description"=>"Delete customer payments.", "operationId"=>"deleteCustomerPayments", "x-api-path-slug"=>"customerpayments-delete", "parameters"=>[{"in"=>"query", "name"=>"customerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Payments"]}}, "/docsreload"=>{"get"=>{"summary"=>"Get Docsreload", "description"=>"Get docsreload.", "operationId"=>"getDocsreload", "x-api-path-slug"=>"docsreload-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Docsreload"]}, "head"=>{"summary"=>"Head Docsreload", "description"=>"Head docsreload.", "operationId"=>"headDocsreload", "x-api-path-slug"=>"docsreload-head", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Head", "Docsreload"]}, "post"=>{"summary"=>"Post Docsreload", "description"=>"Post docsreload.", "operationId"=>"postDocsreload", "x-api-path-slug"=>"docsreload-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Docsreload"]}, "put"=>{"summary"=>"Put Docsreload", "description"=>"Put docsreload.", "operationId"=>"putDocsreload", "x-api-path-slug"=>"docsreload-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Docsreload"]}, "delete"=>{"summary"=>"Delete Docsreload", "description"=>"Delete docsreload.", "operationId"=>"deleteDocsreload", "x-api-path-slug"=>"docsreload-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Docsreload"]}, "options"=>{"summary"=>"Options Docsreload", "description"=>"Options docsreload.", "operationId"=>"optionsDocsreload", "x-api-path-slug"=>"docsreload-options", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Options", "Docsreload"]}, "patch"=>{"summary"=>"Patch Docsreload", "description"=>"Patch docsreload.", "operationId"=>"patchDocsreload", "x-api-path-slug"=>"docsreload-patch", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Docsreload"]}}, "/dump"=>{"get"=>{"summary"=>"Get Dump", "description"=>"Get dump.", "operationId"=>"getDump", "x-api-path-slug"=>"dump-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dump"]}}, "/dump.json"=>{"get"=>{"summary"=>"Get Dump", "description"=>"Get dump.", "operationId"=>"getDump.json", "x-api-path-slug"=>"dump-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Dump"]}}, "/env"=>{"get"=>{"summary"=>"Get Env", "description"=>"Get env.", "operationId"=>"getEnv", "x-api-path-slug"=>"env-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Env"]}}, "/env.json"=>{"get"=>{"summary"=>"Get Env", "description"=>"Get env.", "operationId"=>"getEnv.json", "x-api-path-slug"=>"env-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Env"]}}, "/env/{name}"=>{"get"=>{"summary"=>"Get Env Name", "description"=>"Get env name.", "operationId"=>"getEnvName", "x-api-path-slug"=>"envname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Env", "Name"]}}, "/error"=>{"get"=>{"summary"=>"Get Error", "description"=>"Get error.", "operationId"=>"getError", "x-api-path-slug"=>"error-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Error"]}, "head"=>{"summary"=>"Head Error", "description"=>"Head error.", "operationId"=>"headError", "x-api-path-slug"=>"error-head", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Head", "Error"]}, "post"=>{"summary"=>"Post Error", "description"=>"Post error.", "operationId"=>"postError", "x-api-path-slug"=>"error-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Error"]}, "put"=>{"summary"=>"Put Error", "description"=>"Put error.", "operationId"=>"putError", "x-api-path-slug"=>"error-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Error"]}, "delete"=>{"summary"=>"Delete Error", "description"=>"Delete error.", "operationId"=>"deleteError", "x-api-path-slug"=>"error-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Error"]}, "options"=>{"summary"=>"Options Error", "description"=>"Options error.", "operationId"=>"optionsError", "x-api-path-slug"=>"error-options", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Options", "Error"]}, "patch"=>{"summary"=>"Patch Error", "description"=>"Patch error.", "operationId"=>"patchError", "x-api-path-slug"=>"error-patch", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Error"]}}, "/health"=>{"get"=>{"summary"=>"Get Health", "description"=>"Get health.", "operationId"=>"getHealth", "x-api-path-slug"=>"health-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Health"]}}, "/health.json"=>{"get"=>{"summary"=>"Get Health", "description"=>"Get health.", "operationId"=>"getHealth.json", "x-api-path-slug"=>"health-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Health"]}}, "/heapdump"=>{"get"=>{"summary"=>"Get Heapdump", "description"=>"Get heapdump.", "operationId"=>"getHeapdump", "x-api-path-slug"=>"heapdump-get", "parameters"=>[{"in"=>"query", "name"=>"live", "description"=>"live"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Heapdump"]}}, "/heapdump.json"=>{"get"=>{"summary"=>"Get Heapdump", "description"=>"Get heapdump.", "operationId"=>"getHeapdump.json", "x-api-path-slug"=>"heapdump-json-get", "parameters"=>[{"in"=>"query", "name"=>"live", "description"=>"live"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Heapdump"]}}, "/info"=>{"get"=>{"summary"=>"Get Info", "description"=>"Get info.", "operationId"=>"getInfo", "x-api-path-slug"=>"info-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Info"]}}, "/info.json"=>{"get"=>{"summary"=>"Get Info", "description"=>"Get info.", "operationId"=>"getInfo.json", "x-api-path-slug"=>"info-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Info"]}}, "/logfile"=>{"get"=>{"summary"=>"Get Logfile", "description"=>"Get logfile.", "operationId"=>"getLogfile", "x-api-path-slug"=>"logfile-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logfile"]}, "head"=>{"summary"=>"Head Logfile", "description"=>"Head logfile.", "operationId"=>"headLogfile", "x-api-path-slug"=>"logfile-head", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Head", "Logfile"]}}, "/logfile.json"=>{"get"=>{"summary"=>"Get Logfile", "description"=>"Get logfile.", "operationId"=>"getLogfile.json", "x-api-path-slug"=>"logfile-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logfile"]}, "head"=>{"summary"=>"Head Logfile", "description"=>"Head logfile.", "operationId"=>"headLogfile.json", "x-api-path-slug"=>"logfile-json-head", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Head", "Logfile"]}}, "/loggers"=>{"get"=>{"summary"=>"Get Loggers", "description"=>"Get loggers.", "operationId"=>"getLoggers", "x-api-path-slug"=>"loggers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Loggers"]}}, "/loggers.json"=>{"get"=>{"summary"=>"Get Loggers", "description"=>"Get loggers.", "operationId"=>"getLoggers.json", "x-api-path-slug"=>"loggers-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Loggers"]}}, "/loggers/{name}"=>{"get"=>{"summary"=>"Get Loggers Name", "description"=>"Get loggers name.", "operationId"=>"getLoggersName", "x-api-path-slug"=>"loggersname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Loggers", "Name"]}, "post"=>{"summary"=>"Post Loggers Name", "description"=>"Post loggers name.", "operationId"=>"postLoggersName", "x-api-path-slug"=>"loggersname-post", "parameters"=>[{"in"=>"body", "name"=>"configuration", "description"=>"configuration", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Loggers", "Name"]}}, "/mappings"=>{"get"=>{"summary"=>"Get Mappings", "description"=>"Get mappings.", "operationId"=>"getMappings", "x-api-path-slug"=>"mappings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mappings"]}}, "/mappings.json"=>{"get"=>{"summary"=>"Get Mappings", "description"=>"Get mappings.", "operationId"=>"getMappings.json", "x-api-path-slug"=>"mappings-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mappings"]}}, "/metrics"=>{"get"=>{"summary"=>"Get Metrics", "description"=>"Get metrics.", "operationId"=>"getMetrics", "x-api-path-slug"=>"metrics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}}, "/metrics.json"=>{"get"=>{"summary"=>"Get Metrics", "description"=>"Get metrics.", "operationId"=>"getMetrics.json", "x-api-path-slug"=>"metrics-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}}, "/metrics/{name}"=>{"get"=>{"summary"=>"Get Metrics Name", "description"=>"Get metrics name.", "operationId"=>"getMetricsName", "x-api-path-slug"=>"metricsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics", "Name"]}}, "/orders"=>{"get"=>{"summary"=>"Get Orders", "description"=>"Get orders.", "operationId"=>"getOrders", "x-api-path-slug"=>"orders-get", "parameters"=>[{"in"=>"query", "name"=>"orderNumber", "description"=>"orderNumber"}, {"in"=>"query", "name"=>"orderStatus", "description"=>"orderStatus"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders"]}}, "/orders/summary"=>{"get"=>{"summary"=>"Get Orders Summary", "description"=>"Get orders summary.", "operationId"=>"getOrdersSummary", "x-api-path-slug"=>"orderssummary-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Summary"]}}, "/orders/{orderId}"=>{"get"=>{"summary"=>"Get Orders Orderid", "description"=>"Get orders orderid.", "operationId"=>"getOrdersOrder", "x-api-path-slug"=>"ordersorderid-get", "parameters"=>[{"in"=>"path", "name"=>"orderId", "description"=>"orderId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Orderid"]}}, "/preview/**"=>{"get"=>{"summary"=>"Get Preview **", "description"=>"Get preview **.", "operationId"=>"getPreview**", "x-api-path-slug"=>"preview-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Preview", "**"]}, "head"=>{"summary"=>"Head Preview **", "description"=>"Head preview **.", "operationId"=>"headPreview**", "x-api-path-slug"=>"preview-head", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Head", "Preview", "**"]}, "post"=>{"summary"=>"Post Preview **", "description"=>"Post preview **.", "operationId"=>"postPreview**", "x-api-path-slug"=>"preview-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Preview", "**"]}, "put"=>{"summary"=>"Put Preview **", "description"=>"Put preview **.", "operationId"=>"putPreview**", "x-api-path-slug"=>"preview-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Preview", "**"]}, "delete"=>{"summary"=>"Delete Preview **", "description"=>"Delete preview **.", "operationId"=>"deletePreview**", "x-api-path-slug"=>"preview-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Preview", "**"]}, "options"=>{"summary"=>"Options Preview **", "description"=>"Options preview **.", "operationId"=>"optionsPreview**", "x-api-path-slug"=>"preview-options", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Options", "Preview", "**"]}, "patch"=>{"summary"=>"Patch Preview **", "description"=>"Patch preview **.", "operationId"=>"patchPreview**", "x-api-path-slug"=>"preview-patch", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Preview", "**"]}}, "/promotion-messages/{productId}"=>{"get"=>{"summary"=>"Get Promotion Messages", "description"=>"Get promotion messages.", "operationId"=>"getPromotionMessagesProduct", "x-api-path-slug"=>"promotionmessagesproductid-get", "parameters"=>[{"in"=>"path", "name"=>"productId", "description"=>"productId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Promotion", "Messages"]}}, "/ratings/{itemId}"=>{"get"=>{"summary"=>"Get Ratings", "description"=>"Get ratings.", "operationId"=>"getRatingsItem", "x-api-path-slug"=>"ratingsitemid-get", "parameters"=>[{"in"=>"path", "name"=>"itemId", "description"=>"itemId"}, {"in"=>"query", "name"=>"ratingType", "description"=>"ratingType"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ratings"]}, "head"=>{"summary"=>"Head Ratings", "description"=>"Head ratings.", "operationId"=>"headRatingsItem", "x-api-path-slug"=>"ratingsitemid-head", "parameters"=>[{"in"=>"path", "name"=>"itemId", "description"=>"itemId"}, {"in"=>"query", "name"=>"ratingType", "description"=>"ratingType"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Head", "Ratings"]}, "post"=>{"summary"=>"Post Ratings", "description"=>"Post ratings.", "operationId"=>"postRatingsItem", "x-api-path-slug"=>"ratingsitemid-post", "parameters"=>[{"in"=>"path", "name"=>"itemId", "description"=>"itemId"}, {"in"=>"query", "name"=>"ratingType", "description"=>"ratingType"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ratings"]}, "put"=>{"summary"=>"Put Ratings", "description"=>"Put ratings.", "operationId"=>"putRatingsItem", "x-api-path-slug"=>"ratingsitemid-put", "parameters"=>[{"in"=>"path", "name"=>"itemId", "description"=>"itemId"}, {"in"=>"query", "name"=>"ratingType", "description"=>"ratingType"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ratings"]}, "delete"=>{"summary"=>"Delete Ratings", "description"=>"Delete ratings.", "operationId"=>"deleteRatingsItem", "x-api-path-slug"=>"ratingsitemid-delete", "parameters"=>[{"in"=>"path", "name"=>"itemId", "description"=>"itemId"}, {"in"=>"query", "name"=>"ratingType", "description"=>"ratingType"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ratings"]}, "options"=>{"summary"=>"Options Ratings", "description"=>"Options ratings.", "operationId"=>"optionsRatingsItem", "x-api-path-slug"=>"ratingsitemid-options", "parameters"=>[{"in"=>"path", "name"=>"itemId", "description"=>"itemId"}, {"in"=>"query", "name"=>"ratingType", "description"=>"ratingType"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Options", "Ratings"]}, "patch"=>{"summary"=>"Patch Ratings", "description"=>"Patch ratings.", "operationId"=>"patchRatingsItem", "x-api-path-slug"=>"ratingsitemid-patch", "parameters"=>[{"in"=>"path", "name"=>"itemId", "description"=>"itemId"}, {"in"=>"query", "name"=>"ratingType", "description"=>"ratingType"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ratings"]}}, "/related-products"=>{"get"=>{"summary"=>"Get Related Products", "description"=>"Get related products.", "operationId"=>"getRelatedProducts", "x-api-path-slug"=>"relatedproducts-get", "parameters"=>[{"in"=>"query", "name"=>"categoryId", "description"=>"categoryId"}, {"in"=>"query", "name"=>"categoryKey", "description"=>"categoryKey"}, {"in"=>"query", "name"=>"includePriceData", "description"=>"includePriceData"}, {"in"=>"query", "name"=>"includePromotionMessages", "description"=>"includePromotionMessages"}, {"in"=>"query", "name"=>"productId", "description"=>"productId"}, {"in"=>"query", "name"=>"productKey", "description"=>"productKey"}, {"in"=>"query", "name"=>"quantity", "description"=>"quantity"}, {"in"=>"query", "name"=>"type", "description"=>"type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Related", "Products"]}}, "/shipping/options"=>{"get"=>{"summary"=>"Get Shipping Options", "description"=>"Get shipping options.", "operationId"=>"getShippingOptions", "x-api-path-slug"=>"shippingoptions-get", "parameters"=>[{"in"=>"query", "name"=>"fulfillmentType", "description"=>"fulfillmentType"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Options"]}}, "/shipping/{cartId}/estimate"=>{"get"=>{"summary"=>"Get Shipping Estimate", "description"=>"Get shipping estimate.", "operationId"=>"getShippingCartEstimate", "x-api-path-slug"=>"shippingcartidestimate-get", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Estimate"]}, "head"=>{"summary"=>"Head Shipping Estimate", "description"=>"Head shipping estimate.", "operationId"=>"headShippingCartEstimate", "x-api-path-slug"=>"shippingcartidestimate-head", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Head", "Shipping", "Estimate"]}, "post"=>{"summary"=>"Post Shipping Estimate", "description"=>"Post shipping estimate.", "operationId"=>"postShippingCartEstimate", "x-api-path-slug"=>"shippingcartidestimate-post", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Estimate"]}, "put"=>{"summary"=>"Put Shipping Estimate", "description"=>"Put shipping estimate.", "operationId"=>"putShippingCartEstimate", "x-api-path-slug"=>"shippingcartidestimate-put", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Estimate"]}, "delete"=>{"summary"=>"Delete Shipping Estimate", "description"=>"Delete shipping estimate.", "operationId"=>"deleteShippingCartEstimate", "x-api-path-slug"=>"shippingcartidestimate-delete", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Estimate"]}, "options"=>{"summary"=>"Options Shipping Estimate", "description"=>"Options shipping estimate.", "operationId"=>"optionsShippingCartEstimate", "x-api-path-slug"=>"shippingcartidestimate-options", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Options", "Shipping", "Estimate"]}, "patch"=>{"summary"=>"Patch Shipping Estimate", "description"=>"Patch shipping estimate.", "operationId"=>"patchShippingCartEstimate", "x-api-path-slug"=>"shippingcartidestimate-patch", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Estimate"]}}, "/shipping/{cartId}/group"=>{"post"=>{"summary"=>"Post Shipping Group", "description"=>"Post shipping group.", "operationId"=>"postShippingCartGroup", "x-api-path-slug"=>"shippingcartidgroup-post", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"query", "name"=>"priceOrder", "description"=>"priceOrder"}, {"in"=>"body", "name"=>"wrapper", "description"=>"wrapper", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Group"]}}, "/shipping/{cartId}/group/{fulfillmentGroupId}"=>{"delete"=>{"summary"=>"Delete Shipping Group Fulfillmentgroupid", "description"=>"Delete shipping group fulfillmentgroupid.", "operationId"=>"deleteShippingCartGroupFulfillmentgroup", "x-api-path-slug"=>"shippingcartidgroupfulfillmentgroupid-delete", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"path", "name"=>"fulfillmentGroupId", "description"=>"fulfillmentGroupId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Group", "Fulfillmentgroupid"]}, "patch"=>{"summary"=>"Patch Shipping Group Fulfillmentgroupid", "description"=>"Patch shipping group fulfillmentgroupid.", "operationId"=>"patchShippingCartGroupFulfillmentgroup", "x-api-path-slug"=>"shippingcartidgroupfulfillmentgroupid-patch", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"path", "name"=>"fulfillmentGroupId", "description"=>"fulfillmentGroupId"}, {"in"=>"query", "name"=>"priceOrder", "description"=>"priceOrder"}, {"in"=>"body", "name"=>"wrapper", "description"=>"wrapper", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Group", "Fulfillmentgroupid"]}}, "/shipping/{cartId}/group/{fulfillmentGroupId}/item"=>{"post"=>{"summary"=>"Post Shipping Group Fulfillmentgroupid Item", "description"=>"Post shipping group fulfillmentgroupid item.", "operationId"=>"postShippingCartGroupFulfillmentgroupItem", "x-api-path-slug"=>"shippingcartidgroupfulfillmentgroupiditem-post", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"path", "name"=>"fulfillmentGroupId", "description"=>"fulfillmentGroupId"}, {"in"=>"query", "name"=>"priceOrder", "description"=>"priceOrder"}, {"in"=>"body", "name"=>"wrapper", "description"=>"wrapper", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Group", "Fulfillmentgroupid", "Item"]}}, "/shipping/{cartId}/group/{fulfillmentGroupId}/item/{itemId}"=>{"delete"=>{"summary"=>"Delete Shipping Group Fulfillmentgroupid Item", "description"=>"Delete shipping group fulfillmentgroupid item.", "operationId"=>"deleteShippingCartGroupFulfillmentgroupItemItem", "x-api-path-slug"=>"shippingcartidgroupfulfillmentgroupiditemitemid-delete", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"path", "name"=>"fulfillmentGroupId", "description"=>"fulfillmentGroupId"}, {"in"=>"path", "name"=>"itemId", "description"=>"itemId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Group", "Fulfillmentgroupid", "Item"]}}, "/shipping/{cartId}/group/{fulfillmentGroupId}/option/{fulfillmentOptionId}"=>{"put"=>{"summary"=>"Put Shipping Group Fulfillmentgroupid Option Fulfillmentoptionid", "description"=>"Put shipping group fulfillmentgroupid option fulfillmentoptionid.", "operationId"=>"putShippingCartGroupFulfillmentgroupOptionFulfillmentoption", "x-api-path-slug"=>"shippingcartidgroupfulfillmentgroupidoptionfulfillmentoptionid-put", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"path", "name"=>"fulfillmentGroupId", "description"=>"fulfillmentGroupId"}, {"in"=>"path", "name"=>"fulfillmentOptionId", "description"=>"fulfillmentOptionId"}, {"in"=>"query", "name"=>"priceOrder", "description"=>"priceOrder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Group", "Fulfillmentgroupid", "Option", "Fulfillmentoptionid"]}}, "/shipping/{cartId}/groups"=>{"get"=>{"summary"=>"Get Shipping Groups", "description"=>"Get shipping groups.", "operationId"=>"getShippingCartGroups", "x-api-path-slug"=>"shippingcartidgroups-get", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Groups"]}, "delete"=>{"summary"=>"Delete Shipping Groups", "description"=>"Delete shipping groups.", "operationId"=>"deleteShippingCartGroups", "x-api-path-slug"=>"shippingcartidgroups-delete", "parameters"=>[{"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"query", "name"=>"priceOrder", "description"=>"priceOrder"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Groups"]}}, "/shipping/{cartId}/{fulfillmentGroupId}/address"=>{"put"=>{"summary"=>"Put Shipping Fulfillmentgroupid Address", "description"=>"Put shipping fulfillmentgroupid address.", "operationId"=>"putShippingCartFulfillmentgroupAddress", "x-api-path-slug"=>"shippingcartidfulfillmentgroupidaddress-put", "parameters"=>[{"in"=>"body", "name"=>"address", "description"=>"address", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"cartId", "description"=>"cartId"}, {"in"=>"path", "name"=>"fulfillmentGroupId", "description"=>"fulfillmentGroupId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Fulfillmentgroupid", "Ress"]}}, "/trace"=>{"get"=>{"summary"=>"Get Trace", "description"=>"Get trace.", "operationId"=>"getTrace", "x-api-path-slug"=>"trace-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trace"]}}, "/trace.json"=>{"get"=>{"summary"=>"Get Trace", "description"=>"Get trace.", "operationId"=>"getTrace.json", "x-api-path-slug"=>"trace-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trace"]}}, "/wishlist"=>{"get"=>{"summary"=>"Get Wishlist", "description"=>"Get wishlist.", "operationId"=>"getWishlist", "x-api-path-slug"=>"wishlist-get", "parameters"=>[{"in"=>"query", "name"=>"wishlistName", "description"=>"wishlistName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wishlist"]}, "post"=>{"summary"=>"Post Wishlist", "description"=>"Post wishlist.", "operationId"=>"postWishlist", "x-api-path-slug"=>"wishlist-post", "parameters"=>[{"in"=>"query", "name"=>"wishlistName", "description"=>"wishlistName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wishlist"]}}, "/wishlist/configure-item"=>{"post"=>{"summary"=>"Post Wishlist Configure Item", "description"=>"Post wishlist configure item.", "operationId"=>"postWishlistConfigureItem", "x-api-path-slug"=>"wishlistconfigureitem-post", "parameters"=>[{"in"=>"body", "name"=>"orderItemWrapper", "description"=>"orderItemWrapper", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"wishlistName", "description"=>"wishlistName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wishlist", "Configure", "Item"]}}, "/wishlist/item"=>{"post"=>{"summary"=>"Post Wishlist Item", "description"=>"Post wishlist item.", "operationId"=>"postWishlistItem", "x-api-path-slug"=>"wishlistitem-post", "parameters"=>[{"in"=>"body", "name"=>"orderItemWrapper", "description"=>"orderItemWrapper", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"wishlistName", "description"=>"wishlistName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wishlist", "Item"]}}, "/wishlist/items/{itemId}"=>{"put"=>{"summary"=>"Put Wishlist Items", "description"=>"Put wishlist items.", "operationId"=>"putWishlistItemsItem", "x-api-path-slug"=>"wishlistitemsitemid-put", "parameters"=>[{"in"=>"path", "name"=>"itemId", "description"=>"itemId"}, {"in"=>"query", "name"=>"quantity", "description"=>"quantity"}, {"in"=>"query", "name"=>"wishlistName", "description"=>"wishlistName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wishlist", "Items"]}, "delete"=>{"summary"=>"Delete Wishlist Items", "description"=>"Delete wishlist items.", "operationId"=>"deleteWishlistItemsItem", "x-api-path-slug"=>"wishlistitemsitemid-delete", "parameters"=>[{"in"=>"path", "name"=>"itemId", "description"=>"itemId"}, {"in"=>"query", "name"=>"wishlistName", "description"=>"wishlistName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wishlist", "Items"]}}, "/wishlist/items/{itemId}/move"=>{"post"=>{"summary"=>"Post Wishlist Items Move", "description"=>"Post wishlist items move.", "operationId"=>"postWishlistItemsItemMove", "x-api-path-slug"=>"wishlistitemsitemidmove-post", "parameters"=>[{"in"=>"path", "name"=>"itemId", "description"=>"itemId"}, {"in"=>"query", "name"=>"wishlistName", "description"=>"wishlistName"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wishlist", "Items", "Move"]}}}}, "apis"=>{"name"=>"Broadleaf Commerce", "x-slug"=>"broadleaf-commerce", "description"=>"Broadleaf Commerce is a software technology company headquartered in Dallas, Texas, providing an open source Java eCommerce platform based on Spring Framework.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28889-www-broadleafcommerce-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"603625", "tags"=>"Enterprise,Relative Data,SaaS,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"broadleaf-commerce/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Broadleaf Commerce API", "x-api-slug"=>"broadleaf-commerce-api", "description"=>"Broadleaf Commerce is a software technology company headquartered in Dallas, Texas, providing an open source Java eCommerce platform based on Spring Framework.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28889-www-broadleafcommerce-com.jpg", "humanURL"=>"https://www.broadleafcommerce.com", "baseURL"=>"https://demo.broadleafcommerce.org//api/v1", "tags"=>"Enterprise,Relative Data,SaaS,Service API,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/broadleaf-commerce/broadleaf-commerce-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-openapi", "url"=>"https://demo.broadleafcommerce.org/api/v1/v2/api-docs"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/broadleaf-commerce"}, {"type"=>"x-documentation", "url"=>"https://demo.broadleafcommerce.org/api/v1/swagger-ui.html#/catalog45endpoint"}, {"type"=>"x-email", "url"=>"info@broadleafcommerce.org"}, {"type"=>"x-email", "url"=>"info@broadleafcommerce.com"}, {"type"=>"x-email", "url"=>"marketing@broadleafcommerce.com"}, {"type"=>"x-email", "url"=>"legal@broadleafcommerce.com"}, {"type"=>"x-email", "url"=>"security@broadleafcommerce.com"}, {"type"=>"x-getting-started", "url"=>"https://www.broadleafcommerce.com/docs/core/current/getting-started"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/broadleaf"}, {"type"=>"x-website", "url"=>"https://www.broadleafcommerce.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-stackdriver-monitoring{"google-stackdriver-monitoring-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Stackdriver Monitoring", "x-complete"=>1, "info"=>{"title"=>"Google Stackdriver Monitoring", "description"=>"google-stackdriver-provides-powerful-monitoring-logging-and-diagnostics--it-equips-you-with-insight-into-the-health-performance-and-availability-of-cloudpowered-applications-enabling-you-to-find-and-fix-issues-faster--it-is-natively-integrated-with-google-cloud-platform-amazon-web-services-and-popular-open-source-packages--stackdriver-provides-a-wide-variety-of-metrics-dashboards-alerting-log-management-reporting-and-tracing-capabilities-", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{project}/metricDescriptors"=>{"get"=>{"summary"=>"Get Project Metric Descriptors", "description"=>"List metric descriptors that match the query. If the query is not set, then all of the metric descriptors will be returned. Large responses will be paginated, use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.", "operationId"=>"cloudmonitoring.metricDescriptors.list", "x-api-path-slug"=>"projectmetricdescriptors-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"count", "description"=>"Maximum number of metric descriptors per page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pagination token, which is used to page through large result sets"}, {"in"=>"path", "name"=>"project", "description"=>"The project id"}, {"in"=>"query", "name"=>"query", "description"=>"The query used to search against existing metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring"]}, "post"=>{"summary"=>"Post Project Metric Descriptors", "description"=>"Create a new metric.", "operationId"=>"cloudmonitoring.metricDescriptors.create", "x-api-path-slug"=>"projectmetricdescriptors-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"The project id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring"]}}, "/{project}/metricDescriptors/{metric}"=>{"delete"=>{"summary"=>"Delete Project Metric Descriptors Metric", "description"=>"Delete an existing metric.", "operationId"=>"cloudmonitoring.metricDescriptors.delete", "x-api-path-slug"=>"projectmetricdescriptorsmetric-delete", "parameters"=>[{"in"=>"path", "name"=>"metric", "description"=>"Name of the metric"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID to which the metric belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring"]}}, "/{project}/timeseries/{metric}"=>{"get"=>{"summary"=>"Get Project Timeseries Metric", "description"=>"List the data points of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.", "operationId"=>"cloudmonitoring.timeseries.list", "x-api-path-slug"=>"projecttimeseriesmetric-get", "parameters"=>[{"in"=>"query", "name"=>"aggregator", "description"=>"The aggregation function that will reduce the data points in each window to a single point"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"count", "description"=>"Maximum number of data points per page, which is used for pagination of results"}, {"in"=>"query", "name"=>"labels", "description"=>"A collection of labels for the matching time series, which are represented as: - key==value: key equals the value - key=~value: key regex matches the value - key!=value: key does not equal the value - key!~value: key regex does not match the value For example, to list all of the time series descriptors for the region us-central1, you could specify:label=cloud"}, {"in"=>"path", "name"=>"metric", "description"=>"Metric names are protocol-free URLs as listed in the Supported Metrics page"}, {"in"=>"query", "name"=>"oldest", "description"=>"Start of the time interval (exclusive), which is expressed as an RFC 3339 timestamp"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pagination token, which is used to page through large result sets"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID to which this time series belongs"}, {"in"=>"query", "name"=>"timespan", "description"=>"Length of the time interval to query, which is an alternative way to declare the interval: (youngest - timespan, youngest]"}, {"in"=>"query", "name"=>"window", "description"=>"The sampling window"}, {"in"=>"query", "name"=>"youngest", "description"=>"End of the time interval (inclusive), which is expressed as an RFC 3339 timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring"]}}, "/{project}/timeseries:write"=>{"post"=>{"summary"=>"Post Project Timeseries Write", "description"=>"Put data points to one or more time series for one or more metrics. If a time series does not exist, a new time series will be created. It is not allowed to write a time series point that is older than the existing youngest point of that time series. Points that are older than the existing youngest point of that time series will be discarded silently. Therefore, users should make sure that points of a time series are written sequentially in the order of their end time.", "operationId"=>"cloudmonitoring.timeseries.write", "x-api-path-slug"=>"projecttimeserieswrite-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"The project ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring"]}}, "/{project}/timeseriesDescriptors/{metric}"=>{"get"=>{"summary"=>"Get Project Timeseriesdescriptors Metric", "description"=>"List the descriptors of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.", "operationId"=>"cloudmonitoring.timeseriesDescriptors.list", "x-api-path-slug"=>"projecttimeseriesdescriptorsmetric-get", "parameters"=>[{"in"=>"query", "name"=>"aggregator", "description"=>"The aggregation function that will reduce the data points in each window to a single point"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"count", "description"=>"Maximum number of time series descriptors per page"}, {"in"=>"query", "name"=>"labels", "description"=>"A collection of labels for the matching time series, which are represented as: - key==value: key equals the value - key=~value: key regex matches the value - key!=value: key does not equal the value - key!~value: key regex does not match the value For example, to list all of the time series descriptors for the region us-central1, you could specify:label=cloud"}, {"in"=>"path", "name"=>"metric", "description"=>"Metric names are protocol-free URLs as listed in the Supported Metrics page"}, {"in"=>"query", "name"=>"oldest", "description"=>"Start of the time interval (exclusive), which is expressed as an RFC 3339 timestamp"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The pagination token, which is used to page through large result sets"}, {"in"=>"path", "name"=>"project", "description"=>"The project ID to which this time series belongs"}, {"in"=>"query", "name"=>"timespan", "description"=>"Length of the time interval to query, which is an alternative way to declare the interval: (youngest - timespan, youngest]"}, {"in"=>"query", "name"=>"window", "description"=>"The sampling window"}, {"in"=>"query", "name"=>"youngest", "description"=>"End of the time interval (inclusive), which is expressed as an RFC 3339 timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Monitoring"]}}, "/v2/controller/debuggees/register"=>{"post"=>{"summary"=>"Post Controller Debuggees Register", "description"=>"Registers the debuggee with the controller service. All agents attached to the same application should call this method with the same request content to get back the same stable `debuggee_id`. Agents should call this method again whenever `google.rpc.Code.NOT_FOUND` is returned from any controller method. This allows the controller service to disable the agent or recover from any data loss. If the debuggee is disabled by the server, the response will have `is_disabled` set to `true`.", "operationId"=>"clouddebugger.controller.debuggees.register", "x-api-path-slug"=>"v2controllerdebuggeesregister-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Debugger"]}}, "/v2/controller/debuggees/{debuggeeId}/breakpoints"=>{"get"=>{"summary"=>"Get Controller Debuggees Debuggeeid Breakpoints", "description"=>"Returns the list of all active breakpoints for the debuggee. The breakpoint specification (location, condition, and expression fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line where the breakpoint was set, but this doesn't change the breakpoint semantics. This means that an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember the breakpoints that are completed until the controller removes them from the active list to avoid setting those breakpoints again.", "operationId"=>"clouddebugger.controller.debuggees.breakpoints.list", "x-api-path-slug"=>"v2controllerdebuggeesdebuggeeidbreakpoints-get", "parameters"=>[{"in"=>"path", "name"=>"debuggeeId", "description"=>"Identifies the debuggee"}, {"in"=>"query", "name"=>"successOnTimeout", "description"=>"If set to `true`, returns `google"}, {"in"=>"query", "name"=>"waitToken", "description"=>"A wait token that, if specified, blocks the method call until the list of active breakpoints has changed, or a server selected timeout has expired"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Debugger"]}}, "/v2/controller/debuggees/{debuggeeId}/breakpoints/{id}"=>{"put"=>{"summary"=>"Put Controller Debuggees Debuggeeid Breakpoints", "description"=>"Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service. Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the `location`, `condition` and `expression` fields should not alter the breakpoint semantics. These may only make changes such as canonicalizing a value or snapping the location to the correct line of code.", "operationId"=>"clouddebugger.controller.debuggees.breakpoints.update", "x-api-path-slug"=>"v2controllerdebuggeesdebuggeeidbreakpointsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"debuggeeId", "description"=>"Identifies the debuggee being debugged"}, {"in"=>"path", "name"=>"id", "description"=>"Breakpoint identifier, unique in the scope of the debuggee"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Debugger"]}}, "/v2/debugger/debuggees"=>{"get"=>{"summary"=>"Get Debugger Debuggees", "description"=>"Lists all the debuggees that the user can set breakpoints to.", "operationId"=>"clouddebugger.debugger.debuggees.list", "x-api-path-slug"=>"v2debuggerdebuggees-get", "parameters"=>[{"in"=>"query", "name"=>"clientVersion", "description"=>"The client version making the call"}, {"in"=>"query", "name"=>"includeInactive", "description"=>"When set to `true`, the result includes all debuggees"}, {"in"=>"query", "name"=>"project", "description"=>"Project number of a Google Cloud project whose debuggees to list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Debugger"]}}, "/v2/debugger/debuggees/{debuggeeId}/breakpoints"=>{"get"=>{"summary"=>"Get Debugger Debuggees Debuggeeid Breakpoints", "description"=>"Lists all breakpoints for the debuggee.", "operationId"=>"clouddebugger.debugger.debuggees.breakpoints.list", "x-api-path-slug"=>"v2debuggerdebuggeesdebuggeeidbreakpoints-get", "parameters"=>[{"in"=>"query", "name"=>"action.value", "description"=>"Only breakpoints with the specified action will pass the filter"}, {"in"=>"query", "name"=>"clientVersion", "description"=>"The client version making the call"}, {"in"=>"path", "name"=>"debuggeeId", "description"=>"ID of the debuggee whose breakpoints to list"}, {"in"=>"query", "name"=>"includeAllUsers", "description"=>"When set to `true`, the response includes the list of breakpoints set by any user"}, {"in"=>"query", "name"=>"includeInactive", "description"=>"When set to `true`, the response includes active and inactive breakpoints"}, {"in"=>"query", "name"=>"stripResults", "description"=>"When set to `true`, the response breakpoints are stripped of the results fields: `stack_frames`, `evaluated_expressions` and `variable_table`"}, {"in"=>"query", "name"=>"waitToken", "description"=>"A wait token that, if specified, blocks the call until the breakpoints list has changed, or a server selected timeout has expired"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Debugger"]}}, "/v2/debugger/debuggees/{debuggeeId}/breakpoints/set"=>{"post"=>{"summary"=>"Post Debugger Debuggees Debuggeeid Breakpoints Set", "description"=>"Sets the breakpoint to the debuggee.", "operationId"=>"clouddebugger.debugger.debuggees.breakpoints.set", "x-api-path-slug"=>"v2debuggerdebuggeesdebuggeeidbreakpointsset-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"clientVersion", "description"=>"The client version making the call"}, {"in"=>"path", "name"=>"debuggeeId", "description"=>"ID of the debuggee where the breakpoint is to be set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Debugger"]}}, "/v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}"=>{"delete"=>{"summary"=>"Delete Debugger Debuggees Debuggeeid Breakpoints Breakpointid", "description"=>"Deletes the breakpoint from the debuggee.", "operationId"=>"clouddebugger.debugger.debuggees.breakpoints.delete", "x-api-path-slug"=>"v2debuggerdebuggeesdebuggeeidbreakpointsbreakpointid-delete", "parameters"=>[{"in"=>"path", "name"=>"breakpointId", "description"=>"ID of the breakpoint to delete"}, {"in"=>"query", "name"=>"clientVersion", "description"=>"The client version making the call"}, {"in"=>"path", "name"=>"debuggeeId", "description"=>"ID of the debuggee whose breakpoint to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Debugger"]}, "get"=>{"summary"=>"Get Debugger Debuggees Debuggeeid Breakpoints Breakpointid", "description"=>"Gets breakpoint information.", "operationId"=>"clouddebugger.debugger.debuggees.breakpoints.get", "x-api-path-slug"=>"v2debuggerdebuggeesdebuggeeidbreakpointsbreakpointid-get", "parameters"=>[{"in"=>"path", "name"=>"breakpointId", "description"=>"ID of the breakpoint to get"}, {"in"=>"query", "name"=>"clientVersion", "description"=>"The client version making the call"}, {"in"=>"path", "name"=>"debuggeeId", "description"=>"ID of the debuggee whose breakpoint to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Debugger"]}}, "/v1beta1/{groupName}"=>{"get"=>{"summary"=>"Get Groupname", "description"=>"Get the specified group.", "operationId"=>"", "x-api-path-slug"=>"v1beta1groupname-get", "parameters"=>[{"in"=>"path", "name"=>"groupName", "description"=>"[Required] The group resource name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Errors"]}}, "/v1beta1/{name}"=>{"put"=>{"summary"=>"Put Name", "description"=>"Replace the data for the specified group.\nFails if the group does not exist.", "operationId"=>"clouderrorreporting.projects.groups.update", "x-api-path-slug"=>"v1beta1name-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The group resource name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Errors"]}}, "/v1beta1/{projectName}/events"=>{"delete"=>{"summary"=>"Delete Project Name Events", "description"=>"Deletes all error events of a given project.", "operationId"=>"clouderrorreporting.projects.deleteEvents", "x-api-path-slug"=>"v1beta1projectnameevents-delete", "parameters"=>[{"in"=>"path", "name"=>"projectName", "description"=>"[Required] The resource name of the Google Cloud Platform project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Errors"]}, "get"=>{"summary"=>"Get Project Name Events", "description"=>"Lists the specified events.", "operationId"=>"clouderrorreporting.projects.events.list", "x-api-path-slug"=>"v1beta1projectnameevents-get", "parameters"=>[{"in"=>"query", "name"=>"groupId", "description"=>"[Required] The group for which events shall be returned"}, {"in"=>"query", "name"=>"pageSize", "description"=>"[Optional] The maximum number of results to return per response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"[Optional] A `next_page_token` provided by a previous response"}, {"in"=>"path", "name"=>"projectName", "description"=>"[Required] The resource name of the Google Cloud Platform project"}, {"in"=>"query", "name"=>"serviceFilter.service", "description"=>"[Optional] The exact value to match against[`ServiceContext"}, {"in"=>"query", "name"=>"serviceFilter.version", "description"=>"[Optional] The exact value to match against[`ServiceContext"}, {"in"=>"query", "name"=>"timeRange.period", "description"=>"Restricts the query to the specified time range"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Errors"]}}, "/v1beta1/{projectName}/events:report"=>{"post"=>{"summary"=>"Post Project Name Events Report", "description"=>"Report an individual error event. This endpoint accepts either an OAuth token, or an API key for authentication. To use an API key, append it to the URL as the value of a `key` parameter.", "operationId"=>"clouderrorreporting.projects.events.report", "x-api-path-slug"=>"v1beta1projectnameeventsreport-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectName", "description"=>"[Required] The resource name of the Google Cloud Platform project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Errors"]}}, "/v1beta1/{projectName}/groupStats"=>{"get"=>{"summary"=>"Get Project Name Groupstats", "description"=>"Lists the specified groups.", "operationId"=>"clouderrorreporting.projects.groupStats.list", "x-api-path-slug"=>"v1beta1projectnamegroupstats-get", "parameters"=>[{"in"=>"query", "name"=>"alignment", "description"=>"[Optional] The alignment of the timed counts to be returned"}, {"in"=>"query", "name"=>"alignmentTime", "description"=>"[Optional] Time where the timed counts shall be aligned if roundedalignment is chosen"}, {"in"=>"query", "name"=>"groupId", "description"=>"[Optional] List all ErrorGroupStats with these IDs"}, {"in"=>"query", "name"=>"order", "description"=>"[Optional] The sort order in which the results are returned"}, {"in"=>"query", "name"=>"pageSize", "description"=>"[Optional] The maximum number of results to return per response"}, {"in"=>"query", "name"=>"pageToken", "description"=>"[Optional] A `next_page_token` provided by a previous response"}, {"in"=>"path", "name"=>"projectName", "description"=>"[Required] The resource name of the Google Cloud Platform project"}, {"in"=>"query", "name"=>"serviceFilter.service", "description"=>"[Optional] The exact value to match against[`ServiceContext"}, {"in"=>"query", "name"=>"serviceFilter.version", "description"=>"[Optional] The exact value to match against[`ServiceContext"}, {"in"=>"query", "name"=>"timedCountDuration", "description"=>"[Optional] The preferred duration for a single returned `TimedCount`"}, {"in"=>"query", "name"=>"timeRange.period", "description"=>"Restricts the query to the specified time range"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Errors"]}}}}, "apis"=>{"name"=>"Google Stackdriver Monitoring", "x-slug"=>"google-stackdriver-monitoring", "description"=>"Google Stackdriver provides powerful monitoring, logging, and diagnostics. It equips you with insight into the health, performance, and availability of cloud-powered applications, enabling you to find and fix issues faster. It is natively integrated with Google Cloud Platform, Amazon Web Services, and popular open source packages. Stackdriver provides a wide variety of metrics, dashboards, alerting, log management, reporting, and tracing capabilities.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-stackdriver.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Monitoring,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-stackdriver-monitoring/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Stackdriver Monitoring", "x-api-slug"=>"google-stackdriver-monitoring", "description"=>"Google Stackdriver provides powerful monitoring, logging, and diagnostics. It equips you with insight into the health, performance, and availability of cloud-powered applications, enabling you to find and fix issues faster. It is natively integrated with Google Cloud Platform, Amazon Web Services, and popular open source packages. Stackdriver provides a wide variety of metrics, dashboards, alerting, log management, reporting, and tracing capabilities.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-stackdriver.png", "humanURL"=>"https://cloud.google.com/monitoring/docs/", "baseURL"=>"https:///", "tags"=>"API Provider,API Service Provider,Monitoring,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-stackdriver-monitoring/google-stackdriver-monitoring-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"https://cloud.google.com/monitoring/api/v3/"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/monitoring/docs/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-oauth2{"google-oauth2-apis-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google OAuth2", "x-complete"=>1, "info"=>{"title"=>"Google OAuth2", "description"=>"obtains-enduser-authorization-grants-for-use-with-other-google-apis-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v2"}, "host"=>"www.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/oauth2/v2/certs"=>{"get"=>{"summary"=>"Get Certificate", "description"=>"Get the certification for this session.", "operationId"=>"oauth2.getCertForOpenIdConnect", "x-api-path-slug"=>"oauth2v2certs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate", "Certfication"]}}, "/oauth2/v2/tokeninfo"=>{"post"=>{"summary"=>"Get Token Info", "description"=>"Get the token information for this session.", "operationId"=>"oauth2.tokeninfo", "x-api-path-slug"=>"oauth2v2tokeninfo-post", "parameters"=>[{"in"=>"query", "name"=>"access_token"}, {"in"=>"query", "name"=>"id_token"}, {"in"=>"query", "name"=>"token_handle"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token"]}}, "/oauth2/v2/userinfo"=>{"get"=>{"summary"=>"Get User Info", "description"=>"Get the user information for this session.", "operationId"=>"oauth2.userinfo.get", "x-api-path-slug"=>"oauth2v2userinfo-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/userinfo/v2/me"=>{"get"=>{"summary"=>"Get Me", "description"=>"Get the currently authenticated user for this session.", "operationId"=>"oauth2.userinfo.v2.me.get", "x-api-path-slug"=>"userinfov2me-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}}}, "apis"=>{"name"=>"Google OAuth2", "x-slug"=>"google-oauth2", "description"=>"Google APIs use the OAuth 2.0 protocol for authentication and authorization. Google supports common OAuth 2.0 scenarios such as those for web server, installed, and client-side applications. To begin, obtain OAuth 2.0 client credentials from the Google API Console. Then your client application requests an access token from the Google Authorization Server, extracts a token from the response, and sends the token to the Google API that you want to access. For an interactive demonstration of using OAuth 2.0 with Google (including the option to use your own client credentials), experiment with the OAuth 2.0 Playground.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Google-OAuth@2x.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Authentication,Google APIs,Profiles,Relative Data,Security,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-oauth2/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google OAuth2 APIs", "x-api-slug"=>"google-oauth2-apis", "description"=>"Google APIs use the OAuth 2.0 protocol for authentication and authorization. Google supports common OAuth 2.0 scenarios such as those for web server, installed, and client-side applications. To begin, obtain OAuth 2.0 client credentials from the Google API Console. Then your client application requests an access token from the Google Authorization Server, extracts a token from the response, and sends the token to the Google API that you want to access. For an interactive demonstration of using OAuth 2.0 with Google (including the option to use your own client credentials), experiment with the OAuth 2.0 Playground.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Google-OAuth@2x.png", "humanURL"=>"https://developers.google.com/identity/protocols/OAuth2", "baseURL"=>"://www.googleapis.com//", "tags"=>"API Provider,API Service Provider,Authentication,Google APIs,Profiles,Relative Data,Security,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/google-oauth2/userinfov2me-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/google-oauth2/google-oauth2-apis-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://developers.google.com/identity/protocols/OAuth2"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
stack-exchange{"stack-exchange-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Stack Exchange", "x-complete"=>1, "info"=>{"title"=>"Stack Exchange", "description"=>"stack-exchange-is-a-network-of-130-qa-communities-including-stack-overflow-", "version"=>"2.0"}, "host"=>"api.stackexchange.com", "basePath"=>"/2.2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/access-tokens/{accessTokens}"=>{"get"=>{"summary"=>"Get Acces Tokens", "description"=>"Reads the properties for a set of access tokens.\n \n{accessTokens} can contain up to 20 access tokens. These are obtained by authenticating a user using OAuth 2.0.\n \nThis method returns a list of access_tokens.", "operationId"=>"reads-the-properties-for-a-set-of-access-tokens-accesstokens-can-contain-up-to-20-access-tokens-thes", "x-api-path-slug"=>"accesstokensaccesstokens-get", "parameters"=>[{"in"=>"path", "name"=>"accessTokens", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authentication", "Access Tokens"]}}, "/access-tokens/{accessTokens}/invalidate"=>{"get"=>{"summary"=>"Invalidate Acces Tokens", "description"=>"Immediately expires the access tokens passed. This method is meant to allow an application to discard any active access tokens it no longer needs.\n \n{accessTokens} can contain up to 20 access tokens. These are obtained by authenticating a user using OAuth 2.0.\n \nThis method returns a list of access_tokens.", "operationId"=>"immediately-expires-the-access-tokens-passed-this-method-is-meant-to-allow-an-application-to-discard", "x-api-path-slug"=>"accesstokensaccesstokensinvalidate-get", "parameters"=>[{"in"=>"path", "name"=>"accessTokens", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authentication", "Access Tokens"]}}, "/answers"=>{"get"=>{"summary"=>"Get Answers", "description"=>"Returns all the undeleted answers in the system.\n \nThe sorts accepted by this method operate on the follow fields of the answer object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of answers.", "operationId"=>"returns-all-the-undeleted-answers-in-the-system-the-sorts-accepted-by-this-method-operate-on-the-fol", "x-api-path-slug"=>"answers-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"Filter the discussion"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Answers"]}}, "/answers/{ids}"=>{"get"=>{"summary"=>"Get Answer", "description"=>"Gets the set of answers identified by ids.\n \nThis is meant for batch fetcing of questions. A useful trick to poll for updates is to sort by activity, with a minimum date of the last time you polled.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for answer_id on answer objects.\n \nThe sorts accepted by this method operate on the follow fields of the answer object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of answers.", "operationId"=>"gets-the-set-of-answers-identified-by-ids-this-is-meant-for-batch-fetcing-of-questions-a-useful-tric", "x-api-path-slug"=>"answersids-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Answers"]}}, "/answers/{ids}/comments"=>{"get"=>{"summary"=>"Get Answer Comments", "description"=>"Gets the comments on a set of answers.\n \nIf you know that you have an answer id and need the comments, use this method. If you know you have a question id, use /questions/{id}/comments. If you are unsure, use /posts/{id}/comments.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for answer_id on answer objects.\n \nThe sorts accepted by this method operate on the follow fields of the comment object:\n - creation - creation_date\n - votes - score\n creation is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of comments.", "operationId"=>"gets-the-comments-on-a-set-of-answers-if-you-know-that-you-have-an-answer-id-and-need-the-comments-u", "x-api-path-slug"=>"answersidscomments-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Answers", "comments"]}}, "/apps/{accessTokens}/de-authenticate"=>{"get"=>{"summary"=>"De-Authenticate Token", "description"=>"Passing valid access_tokens to this method causes the application that created them to be de-authorized by the user associated with each access_token. This will remove the application from their apps tab, and cause all other existing access_tokens to be destroyed.\n \nThis method is meant for uninstalling applications, recovering from access_token leaks, or simply as a stronger form of /access-tokens/{accessTokens}/invalidate.\n \nNothing prevents a user from re-authenticate to an application that has de-authenticated itself, the user will be prompted to approve the application again however.\n \n{accessTokens} can contain up to 20 access tokens. These are obtained by authenticating a user using OAuth 2.0.\n \nThis method returns a list of access_tokens.", "operationId"=>"passing-valid-access-tokens-to-this-method-causes-the-application-that-created-them-to-be-deauthoriz", "x-api-path-slug"=>"appsaccesstokensdeauthenticate-get", "parameters"=>[{"in"=>"path", "name"=>"accessTokens", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authentication", "Access Tokens"]}}, "/badges"=>{"get"=>{"summary"=>"Get Badges", "description"=>"Returns all the badges in the system.\n \nBadge sorts are a tad complicated. For the purposes of sorting (and min/max) tag_based is considered to be greater than named.\n \nThis means that you can get a list of all tag based badges by passing min=tag_based, and conversely all the named badges by passing max=named, with sort=type.\n \nFor ranks, bronze is greater than silver which is greater than gold. Along with sort=rank, set max=gold for just gold badges, max=silver&min=silver for just silver, and min=bronze for just bronze.\n \nrank is the default sort.\n \nThis method returns a list of badges.", "operationId"=>"returns-all-the-badges-in-the-system-badge-sorts-are-a-tad-complicated-for-the-purposes-of-sorting-a", "x-api-path-slug"=>"badges-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"inname"}, {"in"=>"query", "name"=>"max", "description"=>"sort = rank => stringsort = name => stringsort = type => string"}, {"in"=>"query", "name"=>"min", "description"=>"sort = rank => stringsort = name => stringsort = type => string"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Badges"]}}, "/badges/name"=>{"get"=>{"summary"=>"Get Badge Name", "description"=>"Gets all explicitly named badges in the system.\n \nA named badged stands in opposition to a tag-based badge. These are referred to as general badges on the sites themselves.\n \nFor the rank sort, bronze is greater than silver which is greater than gold. Along with sort=rank, set max=gold for just gold badges, max=silver&min=silver for just silver, and min=bronze for just bronze.\n \nrank is the default sort.\n \nThis method returns a list of badges.", "operationId"=>"gets-all-explicitly-named-badges-in-the-system-a-named-badged-stands-in-opposition-to-a-tagbased-bad", "x-api-path-slug"=>"badgesname-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"inname"}, {"in"=>"query", "name"=>"max", "description"=>"sort = rank => stringsort = name => string"}, {"in"=>"query", "name"=>"min", "description"=>"sort = rank => stringsort = name => string"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Badges"]}}, "/badges/recipients"=>{"get"=>{"summary"=>"Get Badge Recipients", "description"=>"Returns recently awarded badges in the system.\n \nAs these badges have been awarded, they will have the badge.user property set.\n \nThis method returns a list of badges.", "operationId"=>"returns-recently-awarded-badges-in-the-system-as-these-badges-have-been-awarded-they-will-have-the-b", "x-api-path-slug"=>"badgesrecipients-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Badges", "Recipients"]}}, "/badges/tags"=>{"get"=>{"summary"=>"Get Badge Tags", "description"=>"Returns the badges that are awarded for participation in specific tags.\n \nFor the rank sort, bronze is greater than silver which is greater than gold. Along with sort=rank, set max=gold for just gold badges, max=silver&min=silver for just silver, and min=bronze for just bronze.\n \nrank is the default sort.\n \nThis method returns a list of badges.", "operationId"=>"returns-the-badges-that-are-awarded-for-participation-in-specific-tags-for-the-rank-sort-bronze-is-g", "x-api-path-slug"=>"badgestags-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"inname"}, {"in"=>"query", "name"=>"max", "description"=>"sort = rank => stringsort = name => string"}, {"in"=>"query", "name"=>"min", "description"=>"sort = rank => stringsort = name => string"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Badges"]}}, "/badges/{ids}"=>{"get"=>{"summary"=>"Get Badge", "description"=>"Gets the badges identified in id.\n \nNote that badge ids are not constant across sites, and thus should be looked up via the /badges method. A badge id on a single site is, however, guaranteed to be stable.\n \nBadge sorts are a tad complicated. For the purposes of sorting (and min/max) tag_based is considered to be greater than named.\n \nThis means that you can get a list of all tag based badges by passing min=tag_based, and conversely all the named badges by passing max=named, with sort=type.\n \nFor ranks, bronze is greater than silver which is greater than gold. Along with sort=rank, set max=gold for just gold badges, max=silver&min=silver for just silver, and min=bronze for just bronze.\n \nrank is the default sort.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for badge_id on badge objects.\n \nThis method returns a list of badges.", "operationId"=>"gets-the-badges-identified-in-id-note-that-badge-ids-are-not-constant-across-sites-and-thus-should-b", "x-api-path-slug"=>"badgesids-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = rank => stringsort = name => stringsort = type => string"}, {"in"=>"query", "name"=>"min", "description"=>"sort = rank => stringsort = name => stringsort = type => string"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Badges"]}}, "/badges/{ids}/recipients"=>{"get"=>{"summary"=>"Get Badge Recipients", "description"=>"Returns recently awarded badges in the system, constrained to a certain set of badges.\n \nAs these badges have been awarded, they will have the badge.user property set.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for badge_id on badge objects.\n \nThis method returns a list of badges.", "operationId"=>"returns-recently-awarded-badges-in-the-system-constrained-to-a-certain-set-of-badges-as-these-badges", "x-api-path-slug"=>"badgesidsrecipients-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Badges"]}}, "/comments"=>{"get"=>{"summary"=>"Get Comments", "description"=>"Gets all the comments on the site.\n \nIf you're filtering for interesting comments (by score, creation date, etc.) make use of the sort paramter with appropriate min and max values.\n \nIf you're looking to query conversations between users, instead use the /users/{ids}/mentioned and /users/{ids}/comments/{toid} methods.\n \nThe sorts accepted by this method operate on the follow fields of the comment object:\n - creation - creation_date\n - votes - score\n creation is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of comments.", "operationId"=>"gets-all-the-comments-on-the-site-if-youre-filtering-for-interesting-comments-by-score-creation-date", "x-api-path-slug"=>"comments-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}}, "/comments/{ids}"=>{"get"=>{"summary"=>"Get Comment", "description"=>"Gets the comments identified in id.\n \nThis method is most useful if you have a cache of comment ids obtained through other means (such as /questions/{id}/comments) but suspect the data may be stale.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for comment_id on comment objects.\n \nThe sorts accepted by this method operate on the follow fields of the comment object:\n - creation - creation_date\n - votes - score\n creation is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of comments.", "operationId"=>"gets-the-comments-identified-in-id-this-method-is-most-useful-if-you-have-a-cache-of-comment-ids-obt", "x-api-path-slug"=>"commentsids-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}}, "/comments/{id}/delete"=>{"post"=>{"summary"=>"Delete Comment", "description"=>"Deletes a comment.\n \nUse an access_token with write_access to delete a comment.\n \nIn practice, this method will never return an object.", "operationId"=>"deletes-a-comment-use-an-access-token-with-write-access-to-delete-a-comment-in-practice-this-method-", "x-api-path-slug"=>"commentsiddelete-post", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"preview"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}}, "/comments/{id}/edit"=>{"post"=>{"summary"=>"Edit Comment", "description"=>"Edit an existing comment.\n \nUse an access_token with write_access to edit an existing comment.\n \nThis method return the created comment.", "operationId"=>"edit-an-existing-comment-use-an-access-token-with-write-access-to-edit-an-existing-comment-this-meth", "x-api-path-slug"=>"commentsidedit-post", "parameters"=>[{"in"=>"query", "name"=>"body"}, {"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"preview"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}}, "/errors"=>{"get"=>{"summary"=>"Get Errors", "description"=>"Returns the various error codes that can be produced by the API.\n \nThis method is provided for discovery, documentation, and testing purposes, it is not expected many applications will consume it during normal operation.\n \nFor testing purposes, look into the /errors/{id} method which simulates errors given a code.\n \nThis method returns a list of errors.", "operationId"=>"returns-the-various-error-codes-that-can-be-produced-by-the-api-this-method-is-provided-for-discover", "x-api-path-slug"=>"errors-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Errors"]}}, "/errors/{id}"=>{"get"=>{"summary"=>"Get Error", "description"=>"This method allows you to generate an error.\n \nThis method is only intended for use when testing an application or library. Unlike other methods in the API, its contract is not frozen, and new error codes may be added at any time.\n \nThis method results in an error, which will be expressed with a 400 HTTP status code and setting the error* properties on the wrapper object.", "operationId"=>"this-method-allows-you-to-generate-an-error-this-method-is-only-intended-for-use-when-testing-an-app", "x-api-path-slug"=>"errorsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Errors"]}}, "/events"=>{"get"=>{"summary"=>"Get Event", "description"=>"Returns a stream of events that have occurred on the site.\n \nThe API considers the following \"events\":\n - posting a question\n - posting an answer\n - posting a comment\n - editing a post\n - creating a user\n \n \nEvents are only accessible for 15 minutes after they occurred, and by default only events in the last 5 minutes are returned. You can specify the age of the oldest event returned by setting the since parameter.\n \nIt is advised that developers batch events by ids and make as few subsequent requests to other methods as possible.\n \nThis method returns a list of events.", "operationId"=>"returns-a-stream-of-events-that-have-occurred-on-the-site-the-api-considers-the-following-events--po", "x-api-path-slug"=>"events-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"since", "description"=>"Unix date"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/filters/create"=>{"get"=>{"summary"=>"Create Filter", "description"=>"Creates a new filter given a list of includes, excludes, a base filter, and whether or not this filter should be \"unsafe\".\n \nFilter \"safety\" is defined as follows. Any string returned as a result of an API call with a safe filter will be inline-able into HTML without script-injection concerns. That is to say, no additional sanitizing (encoding, HTML tag stripping, etc.) will be necessary on returned strings. Applications that wish to handle sanitizing themselves should create an unsafe filter. All filters are safe by default, under the assumption that double-encoding bugs are more desirable than script injections.\n \nIf no base filter is specified, the default filter is assumed. When building a filter from scratch, the none built-in filter is useful.\n \nWhen the size of the parameters being sent to this method grows to large, problems can occur. This method will accept POST requests to mitigate this.\n \nIt is not expected that many applications will call this method at runtime, filters should be pre-calculated and \"baked in\" in the common cases. Furthermore, there are a number of built-in filters which cover common use cases.\n \nThis method returns a single filter.", "operationId"=>"creates-a-new-filter-given-a-list-of-includes-excludes-a-base-filter-and-whether-or-not-this-filter-", "x-api-path-slug"=>"filterscreate-get", "parameters"=>[{"in"=>"query", "name"=>"base"}, {"in"=>"query", "name"=>"exclude", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"include", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"unsafe"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files"]}}, "/filters/{filters}"=>{"get"=>{"summary"=>"Get Filters", "description"=>"Returns the fields included by the given filters, and the \"safeness\" of those filters.\n \nIt is not expected that this method will be consumed by many applications at runtime, it is provided to aid in debugging.\n \n{filters} can contain up to 20 semicolon delimited filters. Filters are obtained via calls to /filters/create, or by using a built-in filter.\n \nThis method returns a list of filters.", "operationId"=>"returns-the-fields-included-by-the-given-filters-and-the-safeness-of-those-filters-it-is-not-expecte", "x-api-path-slug"=>"filtersfilters-get", "parameters"=>[{"in"=>"path", "name"=>"filters", "description"=>"String list (semicolon delimited)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files"]}}, "/inbox"=>{"get"=>{"summary"=>"Get Inbox", "description"=>"Returns a user's inbox.\n \nThis method requires an access_token, with a scope containing \"read_inbox\".\n \nThis method returns a list of inbox items.", "operationId"=>"returns-a-users-inbox-this-method-requires-an-access-token-with-a-scope-containing-read-inbox-this-m", "x-api-path-slug"=>"inbox-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Inbox"]}}, "/inbox/unread"=>{"get"=>{"summary"=>"Unread Inbox", "description"=>"Returns the unread items in a user's inbox.\n \nThis method requires an access_token, with a scope containing \"read_inbox\".\n \nThis method returns a list of inbox items.", "operationId"=>"returns-the-unread-items-in-a-users-inbox-this-method-requires-an-access-token-with-a-scope-containi", "x-api-path-slug"=>"inboxunread-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"since", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Inbox"]}}, "/info"=>{"get"=>{"summary"=>"Get Information", "description"=>"Returns a collection of statistics about the site.\n \nData to facilitate per-site customization, discover related sites, and aggregate statistics is all returned by this method.\n \nThis data is cached very aggressively, by design. Query sparingly, ideally no more than once an hour.\n \nThis method returns an info object.", "operationId"=>"returns-a-collection-of-statistics-about-the-site-data-to-facilitate-persite-customization-discover-", "x-api-path-slug"=>"info-get", "parameters"=>[{"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Information"]}}, "/me"=>{"get"=>{"summary"=>"Get Me", "description"=>"Returns the user associated with the passed access_token.\n \nThis method returns a user.", "operationId"=>"returns-the-user-associated-with-the-passed-access-token-this-method-returns-a-user", "x-api-path-slug"=>"me-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = reputation => numbersort = creation => datesort = name => stringsort = modified => date"}, {"in"=>"query", "name"=>"min", "description"=>"sort = reputation => numbersort = creation => datesort = name => stringsort = modified => date"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Self"]}}, "/me/answers"=>{"get"=>{"summary"=>"My Answers", "description"=>"Returns the answers owned by the user associated with the given access_token.\n \nThis method returns a list of answers.", "operationId"=>"returns-the-answers-owned-by-the-user-associated-with-the-given-access-token-this-method-returns-a-l", "x-api-path-slug"=>"meanswers-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Answers"]}}, "/me/associated"=>{"get"=>{"summary"=>"My Assocated", "description"=>"Returns all of a user's associated accounts, given an access_token for them.\n \nThis method returns a list of network users.", "operationId"=>"returns-all-of-a-users-associated-accounts-given-an-access-token-for-them-this-method-returns-a-list", "x-api-path-slug"=>"meassociated-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Associated"]}}, "/me/badges"=>{"get"=>{"summary"=>"My Badges", "description"=>"Returns the badges earned by the user associated with the given access_token.\n \nThis method returns a list of badges.", "operationId"=>"returns-the-badges-earned-by-the-user-associated-with-the-given-access-token-this-method-returns-a-l", "x-api-path-slug"=>"mebadges-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = rank => stringsort = name => stringsort = type => string"}, {"in"=>"query", "name"=>"min", "description"=>"sort = rank => stringsort = name => stringsort = type => string"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Badges"]}}, "/me/comments"=>{"get"=>{"summary"=>"My Comments", "description"=>"Returns the comments owned by the user associated with the given access_token.\n \nThis method returns a list of comments.", "operationId"=>"returns-the-comments-owned-by-the-user-associated-with-the-given-access-token-this-method-returns-a-", "x-api-path-slug"=>"mecomments-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}}, "/me/comments/{toId}"=>{"get"=>{"summary"=>"My Comments", "description"=>"Returns the comments owned by the user associated with the given access_token that are in reply to the user identified by {toId}.\n \nThis method returns a list of comments.", "operationId"=>"returns-the-comments-owned-by-the-user-associated-with-the-given-access-token-that-are-in-reply-to-t", "x-api-path-slug"=>"mecommentstoid-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"toId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}}, "/me/favorites"=>{"get"=>{"summary"=>"My Favorites", "description"=>"Returns the questions favorites by the user associated with the given access_token.\n \nThis method returns a list of questions.", "operationId"=>"returns-the-questions-favorites-by-the-user-associated-with-the-given-access-token-this-method-retur", "x-api-path-slug"=>"mefavorites-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = added => date"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = added => date"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Favorites"]}}, "/me/inbox"=>{"get"=>{"summary"=>"My Inbox", "description"=>"Returns the user identified by access_token's inbox.\n \nThis method requires an access_token, with a scope containing \"read_inbox\".\n \nThis method returns a list of inbox items.", "operationId"=>"returns-the-user-identified-by-access-tokens-inbox-this-method-requires-an-access-token-with-a-scope", "x-api-path-slug"=>"meinbox-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Inbox"]}}, "/me/inbox/unread"=>{"get"=>{"summary"=>"My Inbox Unread", "description"=>"Returns the unread items in the user identified by access_token's inbox.\n \nThis method requires an access_token, with a scope containing \"read_inbox\".\n \nThis method returns a list of inbox items.", "operationId"=>"returns-the-unread-items-in-the-user-identified-by-access-tokens-inbox-this-method-requires-an-acces", "x-api-path-slug"=>"meinboxunread-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"since", "description"=>"Unix date"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email", "Inbox"]}}, "/me/mentioned"=>{"get"=>{"summary"=>"My Mentions", "description"=>"Returns the comments mentioning the user associated with the given access_token.\n \nThis method returns a list of comments.", "operationId"=>"returns-the-comments-mentioning-the-user-associated-with-the-given-access-token-this-method-returns-", "x-api-path-slug"=>"mementioned-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mentioned"]}}, "/me/merges"=>{"get"=>{"summary"=>"My Merges", "description"=>"Returns a record of merges that have occurred involving a user identified by an access_token.\n \nThis method allows you to take now invalid account ids and find what account they've become, or take currently valid account ids and find which ids were equivalent in the past.\n \nThis is most useful when confirming that an account_id is in fact \"new\" to an application.\n \nAccount merges can happen for a wide range of reasons, applications should not make assumptions that merges have particular causes.\n \nNote that accounts are managed at a network level, users on a site may be merged due to an account level merge but there is no guarantee that a merge has an effect on any particular site.\n \nThis method returns a list of account_merge.", "operationId"=>"returns-a-record-of-merges-that-have-occurred-involving-a-user-identified-by-an-access-token-this-me", "x-api-path-slug"=>"memerges-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merges"]}}, "/me/notifications"=>{"get"=>{"summary"=>"My Notiications", "description"=>"Returns a user's notifications, given an access_token.\n \nThis method requires an access_token, with a scope containing \"read_inbox\".\n \nThis method returns a list of notifications.", "operationId"=>"returns-a-users-notifications-given-an-access-token-this-method-requires-an-access-token-with-a-scop", "x-api-path-slug"=>"menotifications-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications"]}}, "/me/notifications/unread"=>{"get"=>{"summary"=>"My Notiications Unread", "description"=>"Returns a user's unread notifications, given an access_token.\n \nThis method requires an access_token, with a scope containing \"read_inbox\".\n \nThis method returns a list of notifications.", "operationId"=>"returns-a-users-unread-notifications-given-an-access-token-this-method-requires-an-access-token-with", "x-api-path-slug"=>"menotificationsunread-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications"]}}, "/me/privileges"=>{"get"=>{"summary"=>"My Priveleges", "description"=>"Returns the privileges the user identified by access_token has.\n \nThis method returns a list of privileges.", "operationId"=>"returns-the-privileges-the-user-identified-by-access-token-has-this-method-returns-a-list-of-privile", "x-api-path-slug"=>"meprivileges-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privileges"]}}, "/me/questions"=>{"get"=>{"summary"=>"My Questions", "description"=>"Returns the questions owned by the user associated with the given access_token.\n \nThis method returns a list of questions.", "operationId"=>"returns-the-questions-owned-by-the-user-associated-with-the-given-access-token-this-method-returns-a", "x-api-path-slug"=>"mequestions-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Questions"]}}, "/me/questions/featured"=>{"get"=>{"summary"=>"My Questions Featured", "description"=>"Returns the questions that have active bounties offered by the user associated with the given access_token.\n \nThis method returns a list of questions.", "operationId"=>"returns-the-questions-that-have-active-bounties-offered-by-the-user-associated-with-the-given-access", "x-api-path-slug"=>"mequestionsfeatured-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Questions"]}}, "/me/questions/no-answers"=>{"get"=>{"summary"=>"My Questions No Answers", "description"=>"Returns the questions owned by the user associated with the given access_token that have no answers.\n \nThis method returns a list of questions.", "operationId"=>"returns-the-questions-owned-by-the-user-associated-with-the-given-access-token-that-have-no-answers-", "x-api-path-slug"=>"mequestionsnoanswers-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Questions"]}}, "/me/questions/unaccepted"=>{"get"=>{"summary"=>"My Questions Unaccepted", "description"=>"Returns the questions owned by the user associated with the given access_token that have no accepted answer.\n \nThis method returns a list of questions.", "operationId"=>"returns-the-questions-owned-by-the-user-associated-with-the-given-access-token-that-have-no-accepted", "x-api-path-slug"=>"mequestionsunaccepted-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Questions"]}}, "/me/questions/unanswered"=>{"get"=>{"summary"=>"My Questions Unanswered", "description"=>"Returns the questions owned by the user associated with the given access_token that are not considered answered.\n \nThis method returns a list of questions.", "operationId"=>"returns-the-questions-owned-by-the-user-associated-with-the-given-access-token-that-are-not-consider", "x-api-path-slug"=>"mequestionsunanswered-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Questions"]}}, "/me/reputation"=>{"get"=>{"summary"=>"My Reputation", "description"=>"Returns the reputation changed for the user associated with the given access_token.\n \nThis method returns a list of reputation changes.", "operationId"=>"returns-the-reputation-changed-for-the-user-associated-with-the-given-access-token-this-method-retur", "x-api-path-slug"=>"mereputation-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reputation"]}}, "/me/reputation-history"=>{"get"=>{"summary"=>"My Reputation History", "description"=>"Returns user's public reputation history.\n \nThis method returns a list of reputation_history.", "operationId"=>"returns-users-public-reputation-history-this-method-returns-a-list-of-reputation-history", "x-api-path-slug"=>"mereputationhistory-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reputation"]}}, "/me/reputation-history/full"=>{"get"=>{"summary"=>"My Reputation History Full", "description"=>"Returns user's full reputation history, including private events.\n \n This method requires an access_token, with a scope containing \"private_info\".\n \nThis method returns a list of reputation_history.", "operationId"=>"returns-users-full-reputation-history-including-private-events--this-method-requires-an-access-token", "x-api-path-slug"=>"mereputationhistoryfull-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reputation"]}}, "/me/suggested-edits"=>{"get"=>{"summary"=>"Suggested Edits", "description"=>"Returns the suggested edits the user identified by access_token has submitted.\n \nThis method returns a list of suggested-edits.", "operationId"=>"returns-the-suggested-edits-the-user-identified-by-access-token-has-submitted-this-method-returns-a-", "x-api-path-slug"=>"mesuggestededits-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = approval => datesort = rejection => date"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = approval => datesort = rejection => date"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suggested Edits"]}}, "/me/tags"=>{"get"=>{"summary"=>"My Tags", "description"=>"Returns the tags the user identified by the access_token passed is active in.\n \nThis method returns a list of tags.", "operationId"=>"returns-the-tags-the-user-identified-by-the-access-token-passed-is-active-in-this-method-returns-a-l", "x-api-path-slug"=>"metags-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = popular => numbersort = activity => datesort = name => string"}, {"in"=>"query", "name"=>"min", "description"=>"sort = popular => numbersort = activity => datesort = name => string"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/me/tags/{tags}/top-answers"=>{"get"=>{"summary"=>"My Tags Top Answers", "description"=>"Returns the top 30 answers the user associated with the given access_token has posted in response to questions with the given tags.\n \nThis method returns a list of answers.", "operationId"=>"returns-the-top-30-answers-the-user-associated-with-the-given-access-token-has-posted-in-response-to", "x-api-path-slug"=>"metagstagstopanswers-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"path", "name"=>"tags", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Anwers"]}}, "/me/tags/{tags}/top-questions"=>{"get"=>{"summary"=>"My Tags Top Questions", "description"=>"Returns the top 30 questions the user associated with the given access_token has posted in response to questions with the given tags.\n \nThis method returns a list of questions.", "operationId"=>"returns-the-top-30-questions-the-user-associated-with-the-given-access-token-has-posted-in-response-", "x-api-path-slug"=>"metagstagstopquestions-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = hot => nonesort = week => nonesort = month => nonesort = relevance => none"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = hot => nonesort = week => nonesort = month => nonesort = relevance => none"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"path", "name"=>"tags", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Questions"]}}, "/me/timeline"=>{"get"=>{"summary"=>"My Timeline", "description"=>"Returns a subset of the actions the user identified by the passed access_token has taken on the site.\n \nThis method returns a list of user timeline objects.", "operationId"=>"returns-a-subset-of-the-actions-the-user-identified-by-the-passed-access-token-has-taken-on-the-site", "x-api-path-slug"=>"metimeline-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Timeline"]}}, "/me/top-answer-tags"=>{"get"=>{"summary"=>"My Top Answer Tags", "description"=>"Returns the user identified by access_token's top 30 tags by answer score.\n \nThis method returns a list of top tag objects.", "operationId"=>"returns-the-user-identified-by-access-tokens-top-30-tags-by-answer-score-this-method-returns-a-list-", "x-api-path-slug"=>"metopanswertags-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Anwers"]}}, "/me/top-question-tags"=>{"get"=>{"summary"=>"My Top Question Tags", "description"=>"Returns the user identified by access_token's top 30 tags by question score.\n \nThis method returns a list of top tag objects.", "operationId"=>"returns-the-user-identified-by-access-tokens-top-30-tags-by-question-score-this-method-returns-a-lis", "x-api-path-slug"=>"metopquestiontags-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Questions"]}}, "/me/write-permissions"=>{"get"=>{"summary"=>"My Write Permissions", "description"=>"Returns the write permissions a user has via the api, given an access token.\n \nThe Stack Exchange API gives users the ability to create, edit, and delete certain types. This method returns whether the passed user is capable of performing those actions at all, as well as how many times a day they can.\n \nThis method does not consider the user's current quota (ie. if they've already exhausted it for today) nor any additional restrictions on write access, such as editing deleted comments.\n \nThis method returns a list of write_permissions.", "operationId"=>"returns-the-write-permissions-a-user-has-via-the-api-given-an-access-token-the-stack-exchange-api-gi", "x-api-path-slug"=>"mewritepermissions-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Write Permissions"]}}, "/notifications"=>{"get"=>{"summary"=>"Get Notifications", "description"=>"Returns a user's notifications.\n \nThis method requires an access_token, with a scope containing \"read_inbox\".\n \nThis method returns a list of notifications.", "operationId"=>"returns-a-users-notifications-this-method-requires-an-access-token-with-a-scope-containing-read-inbo", "x-api-path-slug"=>"notifications-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications"]}}, "/notifications/unread"=>{"get"=>{"summary"=>"Get Notifications Unread", "description"=>"Returns a user's unread notifications.\n \nThis method requires an access_token, with a scope containing \"read_inbox\".\n \nThis method returns a list of notifications.", "operationId"=>"returns-a-users-unread-notifications-this-method-requires-an-access-token-with-a-scope-containing-re", "x-api-path-slug"=>"notificationsunread-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notifications"]}}, "/posts"=>{"get"=>{"summary"=>"Get Posts", "description"=>"Fetches all posts (questions and answers) on the site.\n \nIn many ways this method is the union of /questions and /answers, returning both sets of data albeit only the common fields.\n \nMost applications should use the question or answer specific methods, but /posts is available for those rare cases where any activity is of intereset. Examples of such queries would be: \"all posts on Jan. 1st 2011\" or \"top 10 posts by score of all time\".\n \nThe sorts accepted by this method operate on the follow fields of the post object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of posts.", "operationId"=>"fetches-all-posts-questions-and-answers-on-the-site-in-many-ways-this-method-is-the-union-of-questio", "x-api-path-slug"=>"posts-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts"]}}, "/posts/{ids}"=>{"get"=>{"summary"=>"Get Post", "description"=>"Fetches a set of posts by ids.\n \nThis method is meant for grabbing an object when unsure whether an id identifies a question or an answer. This is most common with user entered data.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for post_id, answer_id, or question_id on post, answer, and question objects respectively.\n \nThe sorts accepted by this method operate on the follow fields of the post object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of posts.", "operationId"=>"fetches-a-set-of-posts-by-ids-this-method-is-meant-for-grabbing-an-object-when-unsure-whether-an-id-", "x-api-path-slug"=>"postsids-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts"]}}, "/posts/{ids}/comments"=>{"get"=>{"summary"=>"Get Post Comments", "description"=>"Gets the comments on the posts identified in ids, regardless of the type of the posts.\n \nThis method is meant for cases when you are unsure of the type of the post id provided. Generally, this would be due to obtaining the post id directly from a user.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for post_id, answer_id, or question_id on post, answer, and question objects respectively.\n \nThe sorts accepted by this method operate on the follow fields of the comment object:\n - creation - creation_date\n - votes - score\n creation is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of comments.", "operationId"=>"gets-the-comments-on-the-posts-identified-in-ids-regardless-of-the-type-of-the-posts-this-method-is-", "x-api-path-slug"=>"postsidscomments-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts", "Comments"]}}, "/posts/{ids}/revisions"=>{"get"=>{"summary"=>"Get Post Revisions", "description"=>"Returns edit revisions for the posts identified in ids.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for post_id, answer_id, or question_id on post, answer, and question objects respectively.\n \nThis method returns a list of revisions.", "operationId"=>"returns-edit-revisions-for-the-posts-identified-in-ids-ids-can-contain-up-to-100-semicolon-delimited", "x-api-path-slug"=>"postsidsrevisions-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts", "Revisions"]}}, "/posts/{ids}/suggested-edits"=>{"get"=>{"summary"=>"Get Posts Suggested Edits", "description"=>"Returns suggsted edits on the posts identified in ids.\n \n - creation - creation_date\n - approval - approval_date\n - rejection - rejection_date\n creation is the default sort.\n \n {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for post_id, answer_id, or question_id on post, answer, and question objects respectively.\n \nThis method returns a list of suggested-edits.", "operationId"=>"returns-suggsted-edits-on-the-posts-identified-in-ids---creation--creation-date--approval--approval-", "x-api-path-slug"=>"postsidssuggestededits-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = approval => datesort = rejection => date"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = approval => datesort = rejection => date"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts", "Suggested Edits"]}}, "/posts/{id}/comments/add"=>{"post"=>{"summary"=>"Add Comment Post", "description"=>"Create a new comment.\n \nUse an access_token with write_access to create a new comment on a post.\n \nThis method returns the created comment.", "operationId"=>"create-a-new-comment-use-an-access-token-with-write-access-to-create-a-new-comment-on-a-post-this-me", "x-api-path-slug"=>"postsidcommentsadd-post", "parameters"=>[{"in"=>"query", "name"=>"body"}, {"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"preview"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Posts", "Comments"]}}, "/privileges"=>{"get"=>{"summary"=>"Get Privileges", "description"=>"Returns the earnable privileges on a site.\n \nPrivileges define abilities a user can earn (via reputation) on any Stack Exchange site.\n \nWhile fairly stable, over time they do change. New ones are introduced with new features, and the reputation requirements change as a site matures.\n \nThis method returns a list of privileges.", "operationId"=>"returns-the-earnable-privileges-on-a-site-privileges-define-abilities-a-user-can-earn-via-reputation", "x-api-path-slug"=>"privileges-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Privileges"]}}, "/questions"=>{"get"=>{"summary"=>"Get Questions", "description"=>"Gets all the questions on the site.\n \nThis method allows you make fairly flexible queries across the entire corpus of questions on a site. For example, getting all questions asked in the the week of Jan 1st 2011 with scores of 10 or more is a single query with parameters sort=votes&min=10&fromdate=1293840000&todate=1294444800.\n \nTo constrain questions returned to those with a set of tags, use the tagged parameter with a semi-colon delimited list of tags. This is an and contraint, passing tagged=c;java will return only those questions with both tags. As such, passing more than 5 tags will always return zero results.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n - hot - by the formula ordering the hot tab Does not accept min or max\n - week - by the formula ordering the week tab Does not accept min or max\n - month - by the formula ordering the month tab Does not accept min or max\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"gets-all-the-questions-on-the-site-this-method-allows-you-make-fairly-flexible-queries-across-the-en", "x-api-path-slug"=>"questions-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = hot => nonesort = week => nonesort = month => nonesort = relevance => none"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = hot => nonesort = week => nonesort = month => nonesort = relevance => none"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"tagged", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Questions"]}}, "/questions/featured"=>{"get"=>{"summary"=>"Get Questions Featured", "description"=>"Returns all the questions with active bounties in the system.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"returns-all-the-questions-with-active-bounties-in-the-system-the-sorts-accepted-by-this-method-opera", "x-api-path-slug"=>"questionsfeatured-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"tagged", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Questions"]}}, "/questions/no-answers"=>{"get"=>{"summary"=>"Get Questions No Answers", "description"=>"Returns questions which have received no answers.\n \nCompare with /questions/unanswered which mearly returns questions that the sites consider insufficiently well answered.\n \nThis method corresponds roughly with the this site tab.\n \nTo constrain questions returned to those with a set of tags, use the tagged parameter with a semi-colon delimited list of tags. This is an and contraint, passing tagged=c;java will return only those questions with both tags. As such, passing more than 5 tags will always return zero results.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"returns-questions-which-have-received-no-answers-compare-with-questionsunanswered-which-mearly-retur", "x-api-path-slug"=>"questionsnoanswers-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"tagged", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Questions"]}}, "/questions/unanswered"=>{"get"=>{"summary"=>"Get Questions Unanswered", "description"=>"Returns questions the site considers to be unanswered.\n \nNote that just because a question has an answer, that does not mean it is considered answered. While the rules are subject to change, at this time a question must have at least one upvoted answer to be considered answered.\n \nTo constrain questions returned to those with a set of tags, use the tagged parameter with a semi-colon delimited list of tags. This is an and contraint, passing tagged=c;java will return only those questions with both tags. As such, passing more than 5 tags will always return zero results.\n \nCompare with /questions/no-answers.\n \nThis method corresponds roughly with the unanswered tab.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"returns-questions-the-site-considers-to-be-unanswered-note-that-just-because-a-question-has-an-answe", "x-api-path-slug"=>"questionsunanswered-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"tagged", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Questions"]}}, "/questions/{ids}"=>{"get"=>{"summary"=>"Get Questions", "description"=>"Returns the questions identified in {ids}.\n \nThis is most useful for fetching fresh data when maintaining a cache of question ids, or polling for changes.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for question_id on question objects.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"returns-the-questions-identified-in-ids-this-is-most-useful-for-fetching-fresh-data-when-maintaining", "x-api-path-slug"=>"questionsids-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Questions"]}}, "/questions/{ids}/answers"=>{"get"=>{"summary"=>"Get Question Answers", "description"=>"Gets the answers to a set of questions identified in id.\n \nThis method is most useful if you have a set of interesting questions, and you wish to obtain all of their answers at once or if you are polling for new or updates answers (in conjunction with sort=activity).\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for question_id on question objects.\n \nThe sorts accepted by this method operate on the follow fields of the answer object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of answers.", "operationId"=>"gets-the-answers-to-a-set-of-questions-identified-in-id-this-method-is-most-useful-if-you-have-a-set", "x-api-path-slug"=>"questionsidsanswers-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Questions", "Answers"]}}, "/questions/{ids}/comments"=>{"get"=>{"summary"=>"Get Question Comments", "description"=>"Gets the comments on a question.\n \nIf you know that you have an question id and need the comments, use this method. If you know you have a answer id, use /answers/{ids}/comments. If you are unsure, use /posts/{ids}/comments.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for question_id on question objects.\n \nThe sorts accepted by this method operate on the follow fields of the comment object:\n - creation - creation_date\n - votes - score\n creation is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of comments.", "operationId"=>"gets-the-comments-on-a-question-if-you-know-that-you-have-an-question-id-and-need-the-comments-use-t", "x-api-path-slug"=>"questionsidscomments-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Questions", "Linked"]}}, "/questions/{ids}/linked"=>{"get"=>{"summary"=>"Get Question Linked", "description"=>"Gets questions which link to those questions identified in {ids}.\n \nThis method only considers questions that are linked within a site, and will never return questions from another Stack Exchange site.\n \nA question is considered \"linked\" when it explicitly includes a hyperlink to another question, there are no other heuristics.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for question_id on question objects.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n - rank - a priority sort by site applies, subject to change at any time Does not accept min or max\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"gets-questions-which-link-to-those-questions-identified-in-ids-this-method-only-considers-questions-", "x-api-path-slug"=>"questionsidslinked-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = rank => none"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = rank => none"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Questions", "Linked"]}}, "/questions/{ids}/related"=>{"get"=>{"summary"=>"Get Question Related", "description"=>"Returns questions that the site considers related to those identified in {ids}.\n \nThe algorithm for determining if questions are related is not documented, and subject to change at any time. Futhermore, these values are very heavily cached, and may not update immediately after a question has been editted. It is also not guaranteed that a question will be considered related to any number (even non-zero) of questions, and a consumer should be able to handle a variable number of returned questions.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for question_id on question objects.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n - rank - a priority sort by site applies, subject to change at any time Does not accept min or max\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"returns-questions-that-the-site-considers-related-to-those-identified-in-ids-the-algorithm-for-deter", "x-api-path-slug"=>"questionsidsrelated-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = rank => none"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = rank => none"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Questions", "Related"]}}, "/questions/{ids}/timeline"=>{"get"=>{"summary"=>"Get Question AnsweTimeliners", "description"=>"Returns a subset of the events that have happened to the questions identified in id.\n \nThis provides data similar to that found on a question's timeline page.\n \nVoting data is scrubbed to deter inferencing of voter identity.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for question_id on question objects.\n \nThis method returns a list of question timeline events.", "operationId"=>"returns-a-subset-of-the-events-that-have-happened-to-the-questions-identified-in-id-this-provides-da", "x-api-path-slug"=>"questionsidstimeline-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Questions", "Timeline"]}}, "/revisions/{ids}"=>{"get"=>{"summary"=>"Get Revisions", "description"=>"Returns edit revisions identified by ids in {ids}.\n \n{ids} can contain up to 20 semicolon delimited ids, to find ids programatically look for revision_guid on revision objects. Note that unlike most other id types in the API, revision_guid is a string.\n \nThis method returns a list of revisions.", "operationId"=>"returns-edit-revisions-identified-by-ids-in-ids-ids-can-contain-up-to-20-semicolon-delimited-ids-to-", "x-api-path-slug"=>"revisionsids-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Guid list (semicolon delimited)"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Revisions"]}}, "/search"=>{"get"=>{"summary"=>"Search", "description"=>"Searches a site for any questions which fit the given criteria.\n \nThis method is intentionally quite limited. For more general searching, you should use a proper internet search engine restricted to the domain of the site in question.\n \nAt least one of tagged or intitle must be set on this method. nottagged is only used if tagged is also set, for performance reasons.\n \ntagged and nottagged are semi-colon delimited list of tags. At least 1 tag in tagged will be on each returned question if it is passed, making it the OR equivalent of the AND version of tagged on /questions.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n - relevance - matches the relevance tab on the site itself Does not accept min or max\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"searches-a-site-for-any-questions-which-fit-the-given-criteria-this-method-is-intentionally-quite-li", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"intitle"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = relevance => none"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = relevance => none"}, {"in"=>"query", "name"=>"nottagged", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"tagged", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}, "/search/advanced"=>{"get"=>{"summary"=>"Advanced Search", "description"=>"Searches a site for any questions which fit the given criteria.\n \nSearch criteria are expressed using the following parameters:\n - q - a free form text parameter, will match all question properties based on an undocumented algorithm.\n - accepted - true to return only questions with accepted answers, false to return only those without. Omit to elide constraint.\n - answers - the minimum number of answers returned questions must have.\n - body - text which must appear in returned questions' bodies.\n - closed - true to return only closed questions, false to return only open ones. Omit to elide constraint.\n - migrated - true to return only questions migrated away from a site, false to return only those not. Omit to elide constraint.\n - notice - true to return only questions with post notices, false to return only those without. Omit to elide constraint.\n - nottagged - a semicolon delimited list of tags, none of which will be present on returned questions.\n - tagged - a semicolon delimited list of tags, of which at least one will be present on all returned questions.\n - title - text which must appear in returned questions' titles.\n - user - the id of the user who must own the questions returned.\n - url - a url which must be contained in a post, may include a wildcard.\n - views - the minimum number of views returned questions must have.\n - wiki - true to return only community wiki questions, false to return only non-community wiki ones. Omit to elide constraint.\n \nAt least one additional parameter must be set if nottagged is set, for performance reasons.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n - relevance - matches the relevance tab on the site itself Does not accept min or max\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"searches-a-site-for-any-questions-which-fit-the-given-criteria-search-criteria-are-expressed-using-t", "x-api-path-slug"=>"searchadvanced-get", "parameters"=>[{"in"=>"query", "name"=>"accepted"}, {"in"=>"query", "name"=>"answers"}, {"in"=>"query", "name"=>"body"}, {"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"closed"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = relevance => none"}, {"in"=>"query", "name"=>"migrated"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = relevance => none"}, {"in"=>"query", "name"=>"notice"}, {"in"=>"query", "name"=>"nottagged", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"q"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"tagged", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"title"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"url"}, {"in"=>"query", "name"=>"user"}, {"in"=>"query", "name"=>"views"}, {"in"=>"query", "name"=>"wiki"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}, "/similar"=>{"get"=>{"summary"=>"Get Similar", "description"=>"Returns questions which are similar to a hypothetical one based on a title and tag combination.\n \nThis method is roughly equivalent to a site's related questions suggestion on the ask page.\n \nThis method is useful for correlating data outside of a Stack Exchange site with similar content within one.\n \nNote that title must always be passed as a parameter. tagged and nottagged are optional, semi-colon delimited lists of tags.\n \nIf tagged is passed it is treated as a preference, there is no guarantee that questions returned will have any of those tags. nottagged is treated as a requirement, no questions will be returned with those tags.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n - relevance - order by \"how similar\" the questions are, most likely candidate first with a descending order Does not accept min or max\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"returns-questions-which-are-similar-to-a-hypothetical-one-based-on-a-title-and-tag-combination-this-", "x-api-path-slug"=>"similar-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = relevance => none"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = relevance => none"}, {"in"=>"query", "name"=>"nottagged", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"tagged", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"title"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Similar"]}}, "/sites"=>{"get"=>{"summary"=>"Get Sites", "description"=>"Returns all sites in the network.\n \nThis method allows for discovery of new sites, and changes to existing ones. Be aware that unlike normal API methods, this method should be fetched very infrequently, it is very unusual for these values to change more than once on any given day. It is suggested that you cache its return for at least one day, unless your app encounters evidence that it has changed (such as from the /info method).\n \nThe pagesize parameter for this method is unbounded, in acknowledgement that for many applications repeatedly fetching from /sites would complicate start-up tasks needlessly.\n \nThis method returns a list of sites.", "operationId"=>"returns-all-sites-in-the-network-this-method-allows-for-discovery-of-new-sites-and-changes-to-existi", "x-api-path-slug"=>"sites-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sites"]}}, "/suggested-edits"=>{"get"=>{"summary"=>"Get Suggested Edits", "description"=>"Returns all the suggested edits in the systems.\n \nThis method returns a list of suggested-edits.\n \nThe sorts accepted by this method operate on the follow fields of the suggested_edit object:\n - creation - creation_date\n - approval - approval_date Does not return unapproved suggested_edits\n - rejection - rejection_date Does not return unrejected suggested_edits\n creation is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.", "operationId"=>"returns-all-the-suggested-edits-in-the-systems-this-method-returns-a-list-of-suggestededits-the-sort", "x-api-path-slug"=>"suggestededits-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = approval => datesort = rejection => date"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = approval => datesort = rejection => date"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suggested Edits"]}}, "/suggested-edits/{ids}"=>{"get"=>{"summary"=>"Get Suggested Edit", "description"=>"Returns suggested edits identified in ids.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for suggested_edit_id on suggested_edit objects.\n \nThe sorts accepted by this method operate on the follow fields of the suggested_edit object:\n - creation - creation_date\n - approval - approval_date Does not return unapproved suggested_edits\n - rejection - rejection_date Does not return unrejected suggested_edits\n creation is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of suggested-edits.", "operationId"=>"returns-suggested-edits-identified-in-ids-ids-can-contain-up-to-100-semicolon-delimited-ids-to-find-", "x-api-path-slug"=>"suggestededitsids-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = approval => datesort = rejection => date"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = approval => datesort = rejection => date"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suggested Edits"]}}, "/tags"=>{"get"=>{"summary"=>"Get Tags", "description"=>"Returns the tags found on a site.\n \nThe inname parameter lets a consumer filter down to tags that contain a certain substring. For example, inname=own would return both \"download\" and \"owner\" amongst others.\n \nThis method returns a list of tags.\n \nThe sorts accepted by this method operate on the follow fields of the tag object:\n - popular - count\n - activity - the creation_date of the last question asked with the tag\n - name - name\n popular is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.", "operationId"=>"returns-the-tags-found-on-a-site-the-inname-parameter-lets-a-consumer-filter-down-to-tags-that-conta", "x-api-path-slug"=>"tags-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"inname"}, {"in"=>"query", "name"=>"max", "description"=>"sort = popular => numbersort = activity => datesort = name => string"}, {"in"=>"query", "name"=>"min", "description"=>"sort = popular => numbersort = activity => datesort = name => string"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/tags/moderator-only"=>{"get"=>{"summary"=>"Get Tags Moderator Only", "description"=>"Returns the tags found on a site that only moderators can use.\n \nThe inname parameter lets a consumer filter down to tags that contain a certain substring. For example, inname=own would return both \"download\" and \"owner\" amongst others.\n \nThis method returns a list of tags.\n \nThe sorts accepted by this method operate on the follow fields of the tag object:\n - popular - count\n - activity - the creation_date of the last question asked with the tag\n - name - name\n popular is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.", "operationId"=>"returns-the-tags-found-on-a-site-that-only-moderators-can-use-the-inname-parameter-lets-a-consumer-f", "x-api-path-slug"=>"tagsmoderatoronly-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"inname"}, {"in"=>"query", "name"=>"max", "description"=>"sort = popular => numbersort = activity => datesort = name => string"}, {"in"=>"query", "name"=>"min", "description"=>"sort = popular => numbersort = activity => datesort = name => string"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/tags/required"=>{"get"=>{"summary"=>"Get Tags Requred", "description"=>"Returns the tags found on a site that fulfill required tag constraints on questions.\n \nThe inname parameter lets a consumer filter down to tags that contain a certain substring. For example, inname=own would return both \"download\" and \"owner\" amongst others.\n \nThis method returns a list of tags.\n \nThe sorts accepted by this method operate on the follow fields of the tag object:\n - popular - count\n - activity - the creation_date of the last question asked with the tag\n - name - name\n popular is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.", "operationId"=>"returns-the-tags-found-on-a-site-that-fulfill-required-tag-constraints-on-questions-the-inname-param", "x-api-path-slug"=>"tagsrequired-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"inname"}, {"in"=>"query", "name"=>"max", "description"=>"sort = popular => numbersort = activity => datesort = name => string"}, {"in"=>"query", "name"=>"min", "description"=>"sort = popular => numbersort = activity => datesort = name => string"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Required"]}}, "/tags/synonyms"=>{"get"=>{"summary"=>"Get Tags Synonyms", "description"=>"Returns all tag synonyms found a site.\n \nWhen searching for synonyms of specific tags, it is better to use /tags/{tags}/synonyms over this method.\n \nThe sorts accepted by this method operate on the follow fields of the tag_synonym object:\n - creation - creation_date\n - applied - applied_count\n - activity - last_applied_date\n creation is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of tag_synonyms.", "operationId"=>"returns-all-tag-synonyms-found-a-site-when-searching-for-synonyms-of-specific-tags-it-is-better-to-u", "x-api-path-slug"=>"tagssynonyms-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = applied => numbersort = activity => date"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = applied => numbersort = activity => date"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Synonyms"]}}, "/tags/{tags}/faq"=>{"get"=>{"summary"=>"Get Tags FAQ", "description"=>"Returns the frequently asked questions for the given set of tags in {tags}.\n \nFor a question to be returned, it must have all the tags in {tags} and be considered \"frequently asked\". The exact algorithm for determining whether a question is considered a FAQ is subject to change at any time.\n \n{tags} can contain up to 5 individual tags per request.\n \nThis method returns a list of questions.", "operationId"=>"returns-the-frequently-asked-questions-for-the-given-set-of-tags-in-tags-for-a-question-to-be-return", "x-api-path-slug"=>"tagstagsfaq-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"path", "name"=>"tags", "description"=>"String list (semicolon delimited)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "FAQ"]}}, "/tags/{tags}/info"=>{"get"=>{"summary"=>"Get Tags Info", "description"=>"Returns tag objects representing the tags in {tags} found on the site.\n \nThis method diverges from the standard naming patterns to avoid to conflicting with existing methods, due to the free form nature of tag names.\n \nThis method returns a list of tags.\n \nThe sorts accepted by this method operate on the follow fields of the tag object:\n - popular - count\n - activity - the creation_date of the last question asked with the tag\n - name - name\n popular is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.", "operationId"=>"returns-tag-objects-representing-the-tags-in-tags-found-on-the-site-this-method-diverges-from-the-st", "x-api-path-slug"=>"tagstagsinfo-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = popular => numbersort = activity => datesort = name => string"}, {"in"=>"query", "name"=>"min", "description"=>"sort = popular => numbersort = activity => datesort = name => string"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"path", "name"=>"tags", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Information"]}}, "/tags/{tags}/related"=>{"get"=>{"summary"=>"Get Tags Related", "description"=>"Returns the tags that are most related to those in {tags}.\n \nIncluding multiple tags in {tags} is equivalent to asking for \"tags related to tag #1 and tag #2\" not \"tags related to tag #1 or tag #2\".\n \ncount on tag objects returned is the number of question with that tag that also share all those in {tags}.\n \n{tags} can contain up to 4 individual tags per request.\n \nThis method returns a list of tags.", "operationId"=>"returns-the-tags-that-are-most-related-to-those-in-tags-including-multiple-tags-in-tags-is-equivalen", "x-api-path-slug"=>"tagstagsrelated-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"path", "name"=>"tags", "description"=>"String list (semicolon delimited)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Related"]}}, "/tags/{tags}/synonyms"=>{"get"=>{"summary"=>"Get Tags Synonyms", "description"=>"Gets all the synonyms that point to the tags identified in {tags}. If you're looking to discover all the tag synonyms on a site, use the /tags/synonyms methods instead of call this method on all tags.\n \n{tags} can contain up to 20 individual tags per request.\n \nThe sorts accepted by this method operate on the follow fields of the tag_synonym object:\n - creation - creation_date\n - applied - applied_count\n - activity - last_applied_date\n creation is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of tag synonyms.", "operationId"=>"gets-all-the-synonyms-that-point-to-the-tags-identified-in-tags-if-youre-looking-to-discover-all-the", "x-api-path-slug"=>"tagstagssynonyms-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = applied => numbersort = activity => date"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = applied => numbersort = activity => date"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"path", "name"=>"tags", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Synonyms"]}}, "/tags/{tags}/wikis"=>{"get"=>{"summary"=>"Get Tags Wikis", "description"=>"Returns the wikis that go with the given set of tags in {tags}.\n \nBe aware that not all tags have wikis.\n \n{tags} can contain up to 20 individual tags per request.\n \nThis method returns a list of tag wikis.", "operationId"=>"returns-the-wikis-that-go-with-the-given-set-of-tags-in-tags-be-aware-that-not-all-tags-have-wikis-t", "x-api-path-slug"=>"tagstagswikis-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"path", "name"=>"tags", "description"=>"String list (semicolon delimited)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Wikis"]}}, "/tags/{tag}/top-answerers/{period}"=>{"get"=>{"summary"=>"Get Tags Top Answers", "description"=>"Returns the top 30 answerers active in a single tag, of either all-time or the last 30 days.\n \nThis is a view onto the data presented on the tag info page on the sites.\n \nThis method returns a list of tag score objects.", "operationId"=>"returns-the-top-30-answerers-active-in-a-single-tag-of-either-alltime-or-the-last-30-days-this-is-a-", "x-api-path-slug"=>"tagstagtopanswerersperiod-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"path", "name"=>"period"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"path", "name"=>"tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Top Answers"]}}, "/tags/{tag}/top-askers/{period}"=>{"get"=>{"summary"=>"Get Tags Top Askers", "description"=>"Returns the top 30 askers active in a single tag, of either all-time or the last 30 days.\n \nThis is a view onto the data presented on the tag info page on the sites.\n \nThis method returns a list of tag score objects.", "operationId"=>"returns-the-top-30-askers-active-in-a-single-tag-of-either-alltime-or-the-last-30-days-this-is-a-vie", "x-api-path-slug"=>"tagstagtopaskersperiod-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"path", "name"=>"period"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"path", "name"=>"tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags", "Top Askers"]}}, "/users"=>{"get"=>{"summary"=>"Get Users", "description"=>"Returns all users on a site.\n \nThis method returns a list of users.\n \nThe sorts accepted by this method operate on the follow fields of the user object:\n - reputation - reputation\n - creation - creation_date\n - name - display_name\n - modified - last_modified_date\n reputation is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThe inname parameter lets consumers filter the results down to just those users with a certain substring in their display name. For example, inname=kevin will return all users with both users named simply \"Kevin\" or those with Kevin as one of (or part of) their names; such as \"Kevin Montrose\".", "operationId"=>"returns-all-users-on-a-site-this-method-returns-a-list-of-users-the-sorts-accepted-by-this-method-op", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"inname"}, {"in"=>"query", "name"=>"max", "description"=>"sort = reputation => numbersort = creation => datesort = name => stringsort = modified => date"}, {"in"=>"query", "name"=>"min", "description"=>"sort = reputation => numbersort = creation => datesort = name => stringsort = modified => date"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/moderators"=>{"get"=>{"summary"=>"Get User Moderators", "description"=>"Gets those users on a site who can exercise moderation powers.\n \nNote, employees of Stack Exchange Inc. will be returned if they have been granted moderation powers on a site even if they have never been appointed or elected explicitly. This method checks abilities, not the manner in which they were obtained.\n \nThe sorts accepted by this method operate on the follow fields of the user object:\n - reputation - reputation\n - creation - creation_date\n - name - display_name\n - modified - last_modified_date\n reputation is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of users.", "operationId"=>"gets-those-users-on-a-site-who-can-exercise-moderation-powers-note-employees-of-stack-exchange-inc-w", "x-api-path-slug"=>"usersmoderators-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = reputation => numbersort = creation => datesort = name => stringsort = modified => date"}, {"in"=>"query", "name"=>"min", "description"=>"sort = reputation => numbersort = creation => datesort = name => stringsort = modified => date"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Moderators"]}}, "/users/moderators/elected"=>{"get"=>{"summary"=>"Get Users Moderators Elected", "description"=>"Returns those users on a site who both have moderator powers, and were actually elected.\n \nThis method excludes Stack Exchange Inc. employees, unless they were actually elected moderators on a site (which can only have happened prior to their employment).\n \nThe sorts accepted by this method operate on the follow fields of the user object:\n - reputation - reputation\n - creation - creation_date\n - name - display_name\n - modified - last_modified_date\n reputation is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of users.", "operationId"=>"returns-those-users-on-a-site-who-both-have-moderator-powers-and-were-actually-elected-this-method-e", "x-api-path-slug"=>"usersmoderatorselected-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"query", "name"=>"max", "description"=>"sort = reputation => numbersort = creation => datesort = name => stringsort = modified => date"}, {"in"=>"query", "name"=>"min", "description"=>"sort = reputation => numbersort = creation => datesort = name => stringsort = modified => date"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Moderators"]}}, "/users/{ids}"=>{"get"=>{"summary"=>"Get User", "description"=>"Gets the users identified in ids in {ids}.\n \nTypically this method will be called to fetch user profiles when you have obtained user ids from some other source, such as /questions.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects.\n \nThe sorts accepted by this method operate on the follow fields of the user object:\n - reputation - reputation\n - creation - creation_date\n - name - display_name\n - modified - last_modified_date\n reputation is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of users.", "operationId"=>"gets-the-users-identified-in-ids-in-ids-typically-this-method-will-be-called-to-fetch-user-profiles-", "x-api-path-slug"=>"usersids-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = reputation => numbersort = creation => datesort = name => stringsort = modified => date"}, {"in"=>"query", "name"=>"min", "description"=>"sort = reputation => numbersort = creation => datesort = name => stringsort = modified => date"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/{ids}/answers"=>{"get"=>{"summary"=>"Get User Answers", "description"=>"Returns the answers the users in {ids} have posted.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects.\n \nThe sorts accepted by this method operate on the follow fields of the answer object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of answers.", "operationId"=>"returns-the-answers-the-users-in-ids-have-posted-ids-can-contain-up-to-100-semicolon-delimited-ids-t", "x-api-path-slug"=>"usersidsanswers-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Answers"]}}, "/users/{ids}/associated"=>{"get"=>{"summary"=>"Get User Associated", "description"=>"Returns all of a user's associated accounts, given their account_ids in {ids}.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for account_id on user objects.\n \nThis method returns a list of network_users.", "operationId"=>"returns-all-of-a-users-associated-accounts-given-their-account-ids-in-ids-ids-can-contain-up-to-100-", "x-api-path-slug"=>"usersidsassociated-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Associated"]}}, "/users/{ids}/badges"=>{"get"=>{"summary"=>"Get User Badges", "description"=>"Get the badges the users in {ids} have earned.\n \nBadge sorts are a tad complicated. For the purposes of sorting (and min/max) tag_based is considered to be greater than named.\n \nThis means that you can get a list of all tag based badges a user has by passing min=tag_based, and conversely all the named badges by passing max=named, with sort=type.\n \nFor ranks, bronze is greater than silver which is greater than gold. Along with sort=rank, set max=gold for just gold badges, max=silver&min=silver for just silver, and min=bronze for just bronze.\n \nrank is the default sort.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects.\n \nThis method returns a list of badges.", "operationId"=>"get-the-badges-the-users-in-ids-have-earned-badge-sorts-are-a-tad-complicated-for-the-purposes-of-so", "x-api-path-slug"=>"usersidsbadges-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = rank => stringsort = name => stringsort = type => stringsort = awarded => date"}, {"in"=>"query", "name"=>"min", "description"=>"sort = rank => stringsort = name => stringsort = type => stringsort = awarded => date"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Badges"]}}, "/users/{ids}/comments"=>{"get"=>{"summary"=>"Get User Comments", "description"=>"Get the comments posted by users in {ids}.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects.\n \nThe sorts accepted by this method operate on the follow fields of the comment object:\n - creation - creation_date\n - votes - score\n creation is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of comments.", "operationId"=>"get-the-comments-posted-by-users-in-ids-ids-can-contain-up-to-100-semicolon-delimited-ids-to-find-id", "x-api-path-slug"=>"usersidscomments-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Comments"]}}, "/users/{ids}/comments/{toid}"=>{"get"=>{"summary"=>"Get User Comments Told", "description"=>"Get the comments that the users in {ids} have posted in reply to the single user identified in {toid}.\n \nThis method is useful for extracting conversations, especially over time or across multiple posts.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects. {toid} can contain only 1 id, found in the same manner as those in {ids}.\n \nThe sorts accepted by this method operate on the follow fields of the comment object:\n - creation - creation_date\n - votes - score\n creation is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of comments.", "operationId"=>"get-the-comments-that-the-users-in-ids-have-posted-in-reply-to-the-single-user-identified-in-toid-th", "x-api-path-slug"=>"usersidscommentstoid-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"toid"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Comments"]}}, "/users/{ids}/favorites"=>{"get"=>{"summary"=>"Get User Favorites", "description"=>"Get the questions that users in {ids} have favorited.\n \nThis method is effectively a view onto a user's favorites tab.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n - added - when the user favorited the question\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"get-the-questions-that-users-in-ids-have-favorited-this-method-is-effectively-a-view-onto-a-users-fa", "x-api-path-slug"=>"usersidsfavorites-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = added => date"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => numbersort = added => date"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Favorites"]}}, "/users/{ids}/mentioned"=>{"get"=>{"summary"=>"Get User Mentioned", "description"=>"Gets all the comments that the users in {ids} were mentioned in.\n \nNote, to count as a mention the comment must be considered to be \"in reply to\" a user. Most importantly, this means that a comment can only be in reply to a single user.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects.\n \nThe sorts accepted by this method operate on the follow fields of the comment object:\n - creation - creation_date\n - votes - score\n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of comments.", "operationId"=>"gets-all-the-comments-that-the-users-in-ids-were-mentioned-in-note-to-count-as-a-mention-the-comment", "x-api-path-slug"=>"usersidsmentioned-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Mentioned"]}}, "/users/{ids}/merges"=>{"get"=>{"summary"=>"Get User Merges", "description"=>"Returns a record of merges that have occurred involving the passed account ids.\n \nThis method allows you to take now invalid account ids and find what account they've become, or take currently valid account ids and find which ids were equivalent in the past.\n \nThis is most useful when confirming that an account_id is in fact \"new\" to an application.\n \nAccount merges can happen for a wide range of reasons, applications should not make assumptions that merges have particular causes.\n \nNote that accounts are managed at a network level, users on a site may be merged due to an account level merge but there is no guarantee that a merge has an effect on any particular site.\n \nThis method returns a list of account_merge.", "operationId"=>"returns-a-record-of-merges-that-have-occurred-involving-the-passed-account-ids-this-method-allows-yo", "x-api-path-slug"=>"usersidsmerges-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Merges"]}}, "/users/{ids}/questions"=>{"get"=>{"summary"=>"Get User Questions", "description"=>"Gets the questions asked by the users in {ids}.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"gets-the-questions-asked-by-the-users-in-ids-ids-can-contain-up-to-100-semicolon-delimited-ids-to-fi", "x-api-path-slug"=>"usersidsquestions-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Questions"]}}, "/users/{ids}/questions/featured"=>{"get"=>{"summary"=>"Get User Questions Featured", "description"=>"Gets the questions on which the users in {ids} have active bounties.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"gets-the-questions-on-which-the-users-in-ids-have-active-bounties-ids-can-contain-up-to-100-semicolo", "x-api-path-slug"=>"usersidsquestionsfeatured-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Featured"]}}, "/users/{ids}/questions/no-answers"=>{"get"=>{"summary"=>"Get User Questions No Answers", "description"=>"Gets the questions asked by the users in {ids} which have no answers.\n \nQuestions returns by this method actually have zero undeleted answers. It is completely disjoint /users/{ids}/questions/unanswered and /users/{ids}/questions/unaccepted, which only return questions with at least one answer, subject to other contraints.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"gets-the-questions-asked-by-the-users-in-ids-which-have-no-answers-questions-returns-by-this-method-", "x-api-path-slug"=>"usersidsquestionsnoanswers-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Answers"]}}, "/users/{ids}/questions/unaccepted"=>{"get"=>{"summary"=>"Get User Questions Unnacepted", "description"=>"Gets the questions asked by the users in {ids} which have at least one answer, but no accepted answer.\n \nQuestions returned by this method have answers, but the owner has not opted to accept any of them.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"gets-the-questions-asked-by-the-users-in-ids-which-have-at-least-one-answer-but-no-accepted-answer-q", "x-api-path-slug"=>"usersidsquestionsunaccepted-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Unaccepted"]}}, "/users/{ids}/questions/unanswered"=>{"get"=>{"summary"=>"Get User Questions Unanswered", "description"=>"Gets the questions asked by the users in {ids} which the site consideres unanswered, while still having at least one answer posted.\n \nThese rules are subject to change, but currently any question without at least one upvoted or accepted answer is considered unanswered.\n \nTo get the set of questions that a user probably considers unanswered, the returned questions should be unioned with those returned by /users/{id}/questions/no-answers. These methods are distinct so that truly unanswered (that is, zero posted answers) questions can be easily separated from mearly poorly or inadequately answered ones.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"gets-the-questions-asked-by-the-users-in-ids-which-the-site-consideres-unanswered-while-still-having", "x-api-path-slug"=>"usersidsquestionsunanswered-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Unanswerd"]}}, "/users/{ids}/reputation"=>{"get"=>{"summary"=>"Get User Reputation", "description"=>"Gets a subset of the reputation changes for users in {ids}.\n \nReputation changes are intentionally scrubbed of some data to make it difficult to correlate votes on particular posts with user reputation changes. That being said, this method returns enough data for reasonable display of reputation trends.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects.\n \nThis method returns a list of reputation objects.", "operationId"=>"gets-a-subset-of-the-reputation-changes-for-users-in-ids-reputation-changes-are-intentionally-scrubb", "x-api-path-slug"=>"usersidsreputation-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Reputation"]}}, "/users/{ids}/reputation-history"=>{"get"=>{"summary"=>"Get User Reputation History", "description"=>"Returns users' public reputation history.\n \nThis method returns a list of reputation_history.", "operationId"=>"returns-users-public-reputation-history-this-method-returns-a-list-of-reputation-history", "x-api-path-slug"=>"usersidsreputationhistory-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Reputation", "History"]}}, "/users/{ids}/suggested-edits"=>{"get"=>{"summary"=>"Get User Suggested Edits", "description"=>"Returns the suggested edits a users in {ids} have submitted.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects.\n \nThe sorts accepted by this method operate on the follow fields of the suggested_edit object:\n - creation - creation_date\n - approval - approval_date Does not return unapproved suggested_edits\n - rejection - rejection_date Does not return unrejected suggested_edits\n creation is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of suggested-edits.", "operationId"=>"returns-the-suggested-edits-a-users-in-ids-have-submitted-ids-can-contain-up-to-100-semicolon-delimi", "x-api-path-slug"=>"usersidssuggestededits-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = creation => datesort = approval => datesort = rejection => date"}, {"in"=>"query", "name"=>"min", "description"=>"sort = creation => datesort = approval => datesort = rejection => date"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Suggested Edits"]}}, "/users/{ids}/tags"=>{"get"=>{"summary"=>"Get User Tags", "description"=>"Returns the tags the users identified in {ids} have been active in.\n \nThis route corresponds roughly to user's stats tab, but does not include tag scores. A subset of tag scores are available (on a single user basis) in /users/{id}/top-answer-tags and /users/{id}/top-question-tags.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects.\n \nThe sorts accepted by this method operate on the follow fields of the tag object:\n - popular - count\n - activity - the creation_date of the last question asked with the tag\n - name - name\n popular is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of tags.", "operationId"=>"returns-the-tags-the-users-identified-in-ids-have-been-active-in-this-route-corresponds-roughly-to-u", "x-api-path-slug"=>"usersidstags-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"max", "description"=>"sort = popular => numbersort = activity => datesort = name => string"}, {"in"=>"query", "name"=>"min", "description"=>"sort = popular => numbersort = activity => datesort = name => string"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Tags"]}}, "/users/{ids}/timeline"=>{"get"=>{"summary"=>"Get User Timeline", "description"=>"Returns a subset of the actions the users in {ids} have taken on the site.\n \nThis method returns users' posts, edits, and earned badges in the order they were accomplished. It is possible to filter to just a window of activity using the fromdate and todate parameters.\n \n{ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects.\n \nThis method returns a list of user timeline objects.", "operationId"=>"returns-a-subset-of-the-actions-the-users-in-ids-have-taken-on-the-site-this-method-returns-users-po", "x-api-path-slug"=>"usersidstimeline-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"ids", "description"=>"Number list (semicolon delimited)"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Timiline"]}}, "/users/{id}/inbox"=>{"get"=>{"summary"=>"Get User Inbox", "description"=>"Returns a user's inbox.\n \nThis method requires an access_token, with a scope containing \"read_inbox\".\n \nThis method is effectively an alias for /inbox. It is provided for consumers who make strong assumptions about operating within the context of a single site rather than the Stack Exchange network as a whole.\n \n{id} can contain a single id, to find it programatically look for user_id on user or shallow_user objects.\n \nThis method returns a list of inbox items.", "operationId"=>"returns-a-users-inbox-this-method-requires-an-access-token-with-a-scope-containing-read-inbox-this-m", "x-api-path-slug"=>"usersidinbox-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Email", "Inbox"]}}, "/users/{id}/inbox/unread"=>{"get"=>{"summary"=>"Get User Inbox Unread", "description"=>"Returns the unread items in a user's inbox.\n \nThis method requires an access_token, with a scope containing \"read_inbox\".\n \nThis method is effectively an alias for /inbox/unread. It is provided for consumers who make strong assumptions about operating within the context of a single site rather than the Stack Exchange network as a whole.\n \n{id} can contain a single id, to find it programatically look for user_id on user or shallow_user objects.\n \nThis method returns a list of inbox items.", "operationId"=>"returns-the-unread-items-in-a-users-inbox-this-method-requires-an-access-token-with-a-scope-containi", "x-api-path-slug"=>"usersidinboxunread-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"since", "description"=>"Unix date"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Email", "Inbox"]}}, "/users/{id}/notifications"=>{"get"=>{"summary"=>"Get User Notifications", "description"=>"Returns a user's notifications.\n \nThis method requires an access_token, with a scope containing \"read_inbox\".\n \nThis method returns a list of notifications.", "operationId"=>"returns-a-users-notifications-this-method-requires-an-access-token-with-a-scope-containing-read-inbo", "x-api-path-slug"=>"usersidnotifications-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Notifications"]}}, "/users/{id}/notifications/unread"=>{"get"=>{"summary"=>"Get User Notifications Unread", "description"=>"Returns a user's unread notifications.\n \nThis method requires an access_token, with a scope containing \"read_inbox\".\n \nThis method returns a list of notifications.", "operationId"=>"returns-a-users-unread-notifications-this-method-requires-an-access-token-with-a-scope-containing-re", "x-api-path-slug"=>"usersidnotificationsunread-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Notifications"]}}, "/users/{id}/privileges"=>{"get"=>{"summary"=>"Get User Preveleges", "description"=>"Returns the privileges a user has.\n \nApplications are encouraged to calculate privileges themselves, without repeated queries to this method. A simple check against the results returned by /privileges and user.user_type would be sufficient.\n \n{id} can contain only a single, to find it programatically look for user_id on user or shallow_user objects.\n \nThis method returns a list of privileges.", "operationId"=>"returns-the-privileges-a-user-has-applications-are-encouraged-to-calculate-privileges-themselves-wit", "x-api-path-slug"=>"usersidprivileges-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Privileges"]}}, "/users/{id}/reputation-history/full"=>{"get"=>{"summary"=>"Get User Reputation History Full", "description"=>"Returns a user's full reputation history, including private events.\n \nThis method requires an access_token, with a scope containing \"private_info\".\n \nThis method returns a list of reputation_history.", "operationId"=>"returns-a-users-full-reputation-history-including-private-events-this-method-requires-an-access-toke", "x-api-path-slug"=>"usersidreputationhistoryfull-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Reputation"]}}, "/users/{id}/tags/{tags}/top-answers"=>{"get"=>{"summary"=>"Get User Tags Top Answers", "description"=>"Returns the top 30 answers a user has posted in response to questions with the given tags.\n \n{id} can contain a single id, to find it programatically look for user_id on user or shallow_user objects. {tags} is limited to 5 tags, passing more will result in an error.\n \nThe sorts accepted by this method operate on the follow fields of the answer object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of answers.", "operationId"=>"returns-the-top-30-answers-a-user-has-posted-in-response-to-questions-with-the-given-tags-id-can-con", "x-api-path-slug"=>"usersidtagstagstopanswers-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"path", "name"=>"tags", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Tags", "Answers"]}}, "/users/{id}/tags/{tags}/top-questions"=>{"get"=>{"summary"=>"Get User Tags Top Questions", "description"=>"Returns the top 30 questions a user has asked with the given tags.\n \n{id} can contain a single id, to find it programatically look for user_id on user or shallow_user objects. {tags} is limited to 5 tags, passing more will result in an error.\n \nThe sorts accepted by this method operate on the follow fields of the question object:\n - activity - last_activity_date\n - creation - creation_date\n - votes - score\n activity is the default sort.\n \n It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.\n \nThis method returns a list of questions.", "operationId"=>"returns-the-top-30-questions-a-user-has-asked-with-the-given-tags-id-can-contain-a-single-id-to-find", "x-api-path-slug"=>"usersidtagstagstopquestions-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"query", "name"=>"fromdate", "description"=>"Unix date"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"max", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"min", "description"=>"sort = activity => datesort = creation => datesort = votes => number"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}, {"in"=>"query", "name"=>"sort"}, {"in"=>"path", "name"=>"tags", "description"=>"String list (semicolon delimited)"}, {"in"=>"query", "name"=>"todate", "description"=>"Unix date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Tags", "Questions"]}}, "/users/{id}/top-answer-tags"=>{"get"=>{"summary"=>"Get User Top Answers Tags", "description"=>"Returns a single user's top tags by answer score.\n \nThis a subset of the data returned on a user's tags tab.\n \n{id} can contain a single id, to find it programatically look for user_id on user or shallow_user objects.\n \nThis method returns a list of top_tag objects.", "operationId"=>"returns-a-single-users-top-tags-by-answer-score-this-a-subset-of-the-data-returned-on-a-users-tags-t", "x-api-path-slug"=>"usersidtopanswertags-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Top Answer Tags"]}}, "/users/{id}/top-question-tags"=>{"get"=>{"summary"=>"Get User Top Question Tags", "description"=>"Returns a single user's top tags by question score.\n \nThis a subset of the data returned on a user's tags tab.\n \n{id} can contain a single id, to find it programatically look for user_id on user or shallow_user objects.\n \nThis method returns a list of top_tag objects.", "operationId"=>"returns-a-single-users-top-tags-by-question-score-this-a-subset-of-the-data-returned-on-a-users-tags", "x-api-path-slug"=>"usersidtopquestiontags-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Top Question Tags"]}}, "/users/{id}/write-permissions"=>{"get"=>{"summary"=>"Get User Write Permissions", "description"=>"Returns the write permissions a user has via the api.\n \nThe Stack Exchange API gives users the ability to create, edit, and delete certain types. This method returns whether the passed user is capable of performing those actions at all, as well as how many times a day they can.\n \nThis method does not consider the user's current quota (ie. if they've already exhausted it for today) nor any additional restrictions on write access, such as editing deleted comments.\n \nThis method returns a list of write_permissions.", "operationId"=>"returns-the-write-permissions-a-user-has-via-the-api-the-stack-exchange-api-gives-users-the-ability-", "x-api-path-slug"=>"usersidwritepermissions-get", "parameters"=>[{"in"=>"query", "name"=>"callback", "description"=>"All API responses are JSON, we do support JSONP with the callback query parameter"}, {"in"=>"query", "name"=>"filter", "description"=>"#DiscussionThe Stack Exchange API allows applications to exclude almost every field returned"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"pagesize"}, {"in"=>"query", "name"=>"site", "description"=>"Each of these methods operates on a single site at a time, identified by the site parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Write Permissions"]}}}}, "apis"=>{"name"=>"Stack Exchange", "x-slug"=>"stack-exchange", "description"=>"After someone asks a question, members of the community propose answers. Others vote on those answers. Very quickly, the answers with the most votes rise to the top. You dont have to read through a lot of discussion to find the best answer. Like to...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/253-stack-exchange.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"126", "tags"=>"Answers,Citations,Code,Content,Forums,General Data,Historical Data API,Imports,Media,My API Stack,Pedestal,Plugins,Questions,Relative Data,Relative StreamRank,Service API,Stack,Streams,Streams,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"stack-exchange/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Stack Exchange", "x-api-slug"=>"stack-exchange", "description"=>"After someone asks a question, members of the community propose answers. Others vote on those answers. Very quickly, the answers with the most votes rise to the top. You dont have to read through a lot of discussion to find the best answer. Like to...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/253-stack-exchange.jpg", "humanURL"=>"http://stackexchange.com", "baseURL"=>"https://api.stackexchange.com//2.2", "tags"=>"Answers,Citations,Code,Content,Forums,General Data,Historical Data API,Imports,Media,My API Stack,Pedestal,Plugins,Questions,Relative Data,Relative StreamRank,Service API,Stack,Streams,Streams,Streams,Streams", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/stack-exchange/usersidwritepermissions-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/stack-exchange/stack-exchange-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://api.stackexchange.com/docs/authentication"}, {"type"=>"x-base", "url"=>"https://api.stackexchange.com/"}, {"type"=>"x-blog", "url"=>"http://stackexchange.com/blogs"}, {"type"=>"x-blog-rss", "url"=>"http://blog.stackoverflow.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/stack-exchange"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/stack-exchange"}, {"type"=>"x-developer", "url"=>"http://api.stackexchange.com/"}, {"type"=>"x-email", "url"=>"legal@stackexchange.com"}, {"type"=>"x-email", "url"=>"team@stackexchange.com"}, {"type"=>"x-email", "url"=>"team+api@stackexchange.com"}, {"type"=>"x-error-codes", "url"=>"https://api.stackexchange.com/docs/error-handling"}, {"type"=>"x-github", "url"=>"https://github.com/StackExchange"}, {"type"=>"x-javascript-sdk", "url"=>"https://api.stackexchange.com/docs/js-lib"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/stack-exchange"}, {"type"=>"x-privacy", "url"=>"https://stackexchange.com/legal/privacy-policy"}, {"type"=>"x-rate-limits", "url"=>"https://api.stackexchange.com/docs/throttle"}, {"type"=>"x-selfservice-registration", "url"=>"https://stackapps.com/users/login?returnurl=/apps/oauth/register"}, {"type"=>"x-support", "url"=>"https://stackexchange.com/about/contact"}, {"type"=>"x-terms-of-service", "url"=>"http://stackexchange.com/legal/api-terms-of-use"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/StackExchange"}, {"type"=>"x-website", "url"=>"http://stackexchange.com"}, {"type"=>"x-website", "url"=>"https://stackexchange.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
statuspage{"statuspage-io-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"StatusPage", "x-complete"=>1, "info"=>{"title"=>"StatusPage.io", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/pages/[page_id].json"=>{"get"=>{"summary"=>"Get your page profile", "description"=>"Get your page profile", "operationId"=>"get-your-page-profile", "x-api-path-slug"=>"pagespage-id-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages"]}, "patch"=>{"summary"=>"Update your page profile", "description"=>"Update your page profile", "operationId"=>"update-your-page-profile", "x-api-path-slug"=>"pagespage-id-json-patch", "parameters"=>[{"in"=>"query", "name"=>"basic layout only, 170x45 or 340x90 is best", "type"=>"string"}, {"in"=>"query", "name"=>"page[allow_email_subscribers]", "description"=>"allow users to subscribe for email updates (t or f)", "type"=>"string"}, {"in"=>"query", "name"=>"page[allow_incident_subscribers]", "description"=>"allow users to subscribe to a single incident (t or f)", "type"=>"string"}, {"in"=>"query", "name"=>"page[allow_page_subscribers]", "description"=>"allow users to auto", "type"=>"string"}, {"in"=>"query", "name"=>"page[allow_sms_subscribers]", "description"=>"allow users to subscribe for sms updates (t or f)", "type"=>"string"}, {"in"=>"query", "name"=>"page[city]", "description"=>"city in which your page is headquartered", "type"=>"string"}, {"in"=>"query", "name"=>"page[country]", "description"=>"country in which your page is headquartered", "type"=>"string"}, {"in"=>"query", "name"=>"page[css_body_background_color]", "description"=>"custom css color for your status page body background", "type"=>"string"}, {"in"=>"query", "name"=>"page[css_font_color]", "description"=>"custom css color for your status page font", "type"=>"string"}, {"in"=>"query", "name"=>"page[css_greens]", "description"=>"custom css color for your status page greens", "type"=>"string"}, {"in"=>"query", "name"=>"page[css_light_font_color]", "description"=>"custom css color for your status page light font", "type"=>"string"}, {"in"=>"query", "name"=>"page[css_oranges]", "description"=>"custom css color for your status page oranges", "type"=>"string"}, {"in"=>"query", "name"=>"page[css_reds]", "description"=>"custom css color for your status page reds", "type"=>"string"}, {"in"=>"query", "name"=>"page[css_yellows]", "description"=>"custom css color for your status page yellows", "type"=>"string"}, {"in"=>"query", "name"=>"page[domain]", "description"=>"CNAME alias for your status page (point DNS record to hosted", "type"=>"string"}, {"in"=>"query", "name"=>"page[hero_cover_url]", "description"=>"url of a hero cover image to be placed on your status page", "type"=>"string"}, {"in"=>"query", "name"=>"page[layout]", "description"=>"which layout format to use for your status page", "type"=>"string"}, {"in"=>"query", "name"=>"page[name]", "description"=>"name of your page to be displayed", "type"=>"string"}, {"in"=>"query", "name"=>"page[notifications_from_email]", "description"=>"if users reply to the incident notifications we send", "type"=>"string"}, {"in"=>"query", "name"=>"page[state]", "description"=>"state in which your page is headquartered", "type"=>"string"}, {"in"=>"query", "name"=>"page[subdomain]", "description"=>"subdomain at which to access your status page (your_subdomain", "type"=>"string"}, {"in"=>"query", "name"=>"page[time_zone]", "description"=>"time zone to use for your status page display (must be a rails time zone)", "type"=>"string"}, {"in"=>"query", "name"=>"page[transactional_logo_url]", "description"=>"url of a transactional logo to be placed on your status page", "type"=>"string"}, {"in"=>"query", "name"=>"page[url]", "description"=>"the website of your page", "type"=>"string"}, {"in"=>"query", "name"=>"premium layout only, 850x315 or 1700x630 is best", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages"]}}, "/pages/[page_id]/components.json"=>{"get"=>{"summary"=>"Get a list of all components", "description"=>"Get a list of all components", "operationId"=>"get-a-list-of-all-components", "x-api-path-slug"=>"pagespage-idcomponents-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Components"]}, "post"=>{"summary"=>"Create a component", "description"=>"Create a component", "operationId"=>"create-a-component", "x-api-path-slug"=>"pagespage-idcomponents-json-post", "parameters"=>[{"in"=>"query", "name"=>"component[description]", "description"=>"The description of the component", "type"=>"string"}, {"in"=>"query", "name"=>"component[group_id]", "description"=>"The id of the parent component (optional, only 1 level of nesting)", "type"=>"string"}, {"in"=>"query", "name"=>"component[name]", "description"=>"The name of the component", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Components"]}}, "/pages/[page_id]/components/[component_id].json"=>{"patch"=>{"summary"=>"Update a component", "description"=>"Update a component", "operationId"=>"update-a-component", "x-api-path-slug"=>"pagespage-idcomponentscomponent-id-json-patch", "parameters"=>[{"in"=>"query", "name"=>"component[description]", "description"=>"The description of the component", "type"=>"string"}, {"in"=>"query", "name"=>"component[name]", "description"=>"The name of the component", "type"=>"string"}, {"in"=>"query", "name"=>"component[status]", "description"=>"The status, one of operational|degraded_performance|partial_outage|major_outage", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Group"]}, "delete"=>{"summary"=>"Delete a component", "description"=>"Delete a component", "operationId"=>"delete-a-component", "x-api-path-slug"=>"pagespage-idcomponentscomponent-id-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Components"]}}, "/pages/[page_id]/incidents.json"=>{"get"=>{"summary"=>"Get a list of all incidents", "description"=>"Get a list of all incidents", "operationId"=>"get-a-list-of-all-incidents", "x-api-path-slug"=>"pagespage-idincidents-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents"]}, "post"=>{"summary"=>"Create a realtime incident", "description"=>"Create a realtime incident", "operationId"=>"create-a-realtime-incident", "x-api-path-slug"=>"pagespage-idincidents-json-post", "parameters"=>[{"in"=>"query", "name"=>"incident[backfilled]", "description"=>"Must be set to t", "type"=>"string"}, {"in"=>"query", "name"=>"incident[backfill_date]", "description"=>"Date of incident in YYYY", "type"=>"string"}, {"in"=>"query", "name"=>"incident[component_ids]", "description"=>"List of components whose subscribers should be notified (only applicable for pages with component subscriptions enabled)", "type"=>"string"}, {"in"=>"query", "name"=>"incident[impact_override]", "description"=>"Override calculated impact value, one of none|minor|major|critical (optional)", "type"=>"string"}, {"in"=>"query", "name"=>"incident[message]", "description"=>"The initial message, created as the first incident update (optional)", "type"=>"string"}, {"in"=>"query", "name"=>"incident[name]", "description"=>"The name of the incident", "type"=>"string"}, {"in"=>"query", "name"=>"incident[scheduled_auto_completed]", "description"=>"Automatically transition incident to Completed at end (optional, t or f, defaults to f)", "type"=>"string"}, {"in"=>"query", "name"=>"incident[scheduled_auto_in_progress]", "description"=>"Automatically transition incident to In Progress at start (optional, t or f, defaults to f)", "type"=>"string"}, {"in"=>"query", "name"=>"incident[scheduled_for]", "description"=>"time the scheduled maintenance should begin (ISO8601 format)", "type"=>"string"}, {"in"=>"query", "name"=>"incident[scheduled_remind_prior]", "description"=>"Remind subscribers 60 minutes before scheduled start (optional, t or f, defaults to f)", "type"=>"string"}, {"in"=>"query", "name"=>"incident[scheduled_until]", "description"=>"time the scheduled maintenance should end (ISO8601 format)", "type"=>"string"}, {"in"=>"query", "name"=>"incident[status]", "description"=>"The status, one of investigating|identified|monitoring|resolved (optional, defaults to investigating if left blank)", "type"=>"string"}, {"in"=>"query", "name"=>"incident[wants_twitter_update]", "description"=>"Post the new incident to twitter (t or f, defaults to f)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents"]}}, "/pages/[page_id]/incidents/unresolved.json"=>{"get"=>{"summary"=>"Unresolved Only", "description"=>"Unresolved Only", "operationId"=>"unresolved-only", "x-api-path-slug"=>"pagespage-idincidentsunresolved-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents"]}}, "/pages/[page_id]/incidents/scheduled.json"=>{"get"=>{"summary"=>"Scheduled Only", "description"=>"Scheduled Only", "operationId"=>"scheduled-only", "x-api-path-slug"=>"pagespage-idincidentsscheduled-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents"]}}, "/pages/[page_id]/incidents/[incident_id].json"=>{"patch"=>{"summary"=>"Update an incident (only applies to realtime and scheduled incidents)", "description"=>"Update an incident (only applies to realtime and scheduled incidents)", "operationId"=>"update-an-incident-only-applies-to-realtime-and-scheduled-incidents", "x-api-path-slug"=>"pagespage-idincidentsincident-id-json-patch", "parameters"=>[{"in"=>"query", "name"=>"at the same time to avoid two separate incident updates being generated.", "type"=>"string"}, {"in"=>"query", "name"=>"ENDPOINT", "type"=>"string"}, {"in"=>"query", "name"=>"incident[component_ids]", "description"=>"List of components whose subscribers should be notified (only applicable for pages with component subscriptions enabled)", "type"=>"string"}, {"in"=>"query", "name"=>"incident[impact_override]", "description"=>"Override calculated impact value, one of none|minor|major|critical (optional)", "type"=>"string"}, {"in"=>"query", "name"=>"incident[message]", "description"=>"The body of the new incident update that will be created (optional)", "type"=>"string"}, {"in"=>"query", "name"=>"incident[name]", "description"=>"The name of the incident", "type"=>"string"}, {"in"=>"query", "name"=>"incident[status]", "description"=>"The status, one of investigating|identified|monitoring|resolved (if realtime) or scheduled|in_progress|verifying|completed (if scheduled)", "type"=>"string"}, {"in"=>"query", "name"=>"incident[wants_twitter_update]", "description"=>"Post the new incident update to twitter (t or f, defaults to f)", "type"=>"string"}, {"in"=>"query", "name"=>"MUTABLE", "type"=>"string"}, {"in"=>"query", "name"=>"PATCH /pages/[page_id]/incidents/[incident_id].json", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents"]}, "delete"=>{"summary"=>"Delete an incident", "description"=>"Delete an incident", "operationId"=>"delete-an-incident", "x-api-path-slug"=>"pagespage-idincidentsincident-id-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents"]}}, "/pages/[page_id]/incidents/[incident_id]/incident_updates/[incident_update_id].json"=>{"patch"=>{"summary"=>"Tune an Incident Update", "description"=>"Tune an Incident Update", "operationId"=>"tune-an-incident-update", "x-api-path-slug"=>"pagespage-idincidentsincident-idincident-updatesincident-update-id-json-patch", "parameters"=>[{"in"=>"query", "name"=>"incident_update[body]", "description"=>"The body of the incident update (optional)", "type"=>"string"}, {"in"=>"query", "name"=>"incident_update[display_at]", "description"=>"The timestamp by which to display the incident update (optional)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents"]}}, "/pages/[page_id]/subscribers/[subscriber_id].json"=>{"delete"=>{"summary"=>"Delete a subscriber", "description"=>"Delete a subscriber", "operationId"=>"delete-a-subscriber", "x-api-path-slug"=>"pagespage-idsubscriberssubscriber-id-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscribers"]}}, "/metrics_providers.json"=>{"get"=>{"summary"=>"Get a list of available public metric providers", "description"=>"Get a list of available public metric providers", "operationId"=>"get-a-list-of-available-public-metric-providers", "x-api-path-slug"=>"metrics-providers-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}}, "/pages/[page_id]/metrics_providers.json"=>{"get"=>{"summary"=>"Get a list of metric providers linked to your page", "description"=>"Get a list of metric providers linked to your page", "operationId"=>"get-a-list-of-metric-providers-linked-to-your-page", "x-api-path-slug"=>"pagespage-idmetrics-providers-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metric Providers"]}}, "/pages/[page_id]/metrics_providers/[metrics_provider_id]/metrics.json"=>{"get"=>{"summary"=>"Get a list of metrics created for a linked metrics provider", "description"=>"Get a list of metrics created for a linked metrics provider", "operationId"=>"get-a-list-of-metrics-created-for-a-linked-metrics-provider", "x-api-path-slug"=>"pagespage-idmetrics-providersmetrics-provider-idmetrics-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metric Providers"]}, "post"=>{"summary"=>"Create a custom metric", "description"=>"Create a custom metric", "operationId"=>"create-a-custom-metric", "x-api-path-slug"=>"pagespage-idmetrics-providersmetrics-provider-idmetrics-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metric Providers"]}}, "/pages/[page_id]/metrics/[metric_id]/data.json"=>{"post"=>{"summary"=>"Submit data for a custom metric", "description"=>"Submit data for a custom metric", "operationId"=>"submit-data-for-a-custom-metric", "x-api-path-slug"=>"pagespage-idmetricsmetric-iddata-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}, "delete"=>{"summary"=>"Delete all data for a custom metric", "description"=>"Delete all data for a custom metric", "operationId"=>"delete-all-data-for-a-custom-metric", "x-api-path-slug"=>"pagespage-idmetricsmetric-iddata-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}}, "/organizations/[organization_id]/users.json"=>{"get"=>{"summary"=>"List users", "description"=>"List users", "operationId"=>"list-users", "x-api-path-slug"=>"organizationsorganization-idusers-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}, "post"=>{"summary"=>"Create a user", "description"=>"Create a user", "operationId"=>"create-a-user", "x-api-path-slug"=>"organizationsorganization-idusers-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}, "/organizations/[organization_id]/users/[user_id].json"=>{"delete"=>{"summary"=>"Delete a user", "description"=>"Delete a user", "operationId"=>"delete-a-user", "x-api-path-slug"=>"organizationsorganization-idusersuser-id-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organizations"]}}, "/pages/[page_id]/page_access_users.json"=>{"get"=>{"summary"=>"Retrieve a list of users", "description"=>"Retrieve a list of users", "operationId"=>"retrieve-a-list-of-users", "x-api-path-slug"=>"pagespage-idpage-access-users-json-get", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"Filter the returned list of users by email address (users must have assigned email addresses)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Users"]}, "post"=>{"summary"=>"Create a user who can view your status page", "description"=>"Create a user who can view your status page", "operationId"=>"create-a-user-who-can-view-your-status-page", "x-api-path-slug"=>"pagespage-idpage-access-users-json-post", "parameters"=>[{"in"=>"query", "name"=>"page_access_user[component_ids][]", "description"=>"Array of component ids that the created user will ba able to view", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_user[email]", "description"=>"The email for StatusPage to use to communicate with the user (required if StatusPage manages passwords for you)", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_user[external_login]", "description"=>"A concatenated (and possibly hashed) string of login parameters, organized alphabetically by field name", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_user[metric_ids][]", "description"=>"Array of metric ids that the created user will ba able to view", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_user[page_access_group_ids][]", "description"=>"Array of PageAccessGroups (identified by code) that the created user will be a member of", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_user[subscribe_to_components]", "description"=>"A value of true will subscribe the user to notifications for incidents associated with components they can see, this value is optional and defaults to false", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Users"]}}, "/pages/[page_id]/page_access_users/[page_access_user_id].json"=>{"patch"=>{"summary"=>"Change information for a user who can view your status page", "description"=>"Change information for a user who can view your status page", "operationId"=>"change-information-for-a-user-who-can-view-your-status-page", "x-api-path-slug"=>"pagespage-idpage-access-userspage-access-user-id-json-patch", "parameters"=>[{"in"=>"query", "name"=>"page_access_user[component_ids][]", "description"=>"Array of component ids that the created user will ba able to view", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_user[email]", "description"=>"The email for StatusPage to use to communicate with the user (required if StatusPage manages passwords for you)", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_user[external_login]", "description"=>"A concatenated (and possibly hashed) string of login parameters, organized alphabetically by field name", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_user[metric_ids][]", "description"=>"Array of metric ids that the created user will ba able to view", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_user[page_access_group_ids][]", "description"=>"Array of PageAccessGroups (identified by code) that the created user will be a member of", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Users"]}, "delete"=>{"summary"=>"Delete a user who could access your status page", "description"=>"Delete a user who could access your status page", "operationId"=>"delete-a-user-who-could-access-your-status-page", "x-api-path-slug"=>"pagespage-idpage-access-userspage-access-user-id-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Users"]}}, "/pages/[page_id]/page_access_users/[page_access_user_id]/components.json"=>{"post"=>{"summary"=>"Assign components to a page access user (overwrites existing components)", "description"=>"Assign components to a page access user (overwrites existing components)", "operationId"=>"assign-components-to-a-page-access-user-overwrites-existing-components", "x-api-path-slug"=>"pagespage-idpage-access-userspage-access-user-idcomponents-json-post", "parameters"=>[{"in"=>"query", "name"=>"component_ids[]", "description"=>"Array of component ids that the user will ba able to view", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Users"]}, "patch"=>{"summary"=>"Assign components to a page access user (adds new components to a user)", "description"=>"Assign components to a page access user (adds new components to a user)", "operationId"=>"assign-components-to-a-page-access-user-adds-new-components-to-a-user", "x-api-path-slug"=>"pagespage-idpage-access-userspage-access-user-idcomponents-json-patch", "parameters"=>[{"in"=>"query", "name"=>"component_ids[]", "description"=>"Array of component ids that the user will ba able to view", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Users"]}, "delete"=>{"summary"=>"Remove all components from a page access user", "description"=>"Remove all components from a page access user", "operationId"=>"remove-all-components-from-a-page-access-user", "x-api-path-slug"=>"pagespage-idpage-access-userspage-access-user-idcomponents-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Users"]}}, "/pages/[page_id]/components/[component_id]/page_access_users.json"=>{"post"=>{"summary"=>"Assign page access users to a component", "description"=>"Assign page access users to a component", "operationId"=>"assign-page-access-users-to-a-component", "x-api-path-slug"=>"pagespage-idcomponentscomponent-idpage-access-users-json-post", "parameters"=>[{"in"=>"query", "name"=>"page_access_user_ids[]", "description"=>"Array of page access user ids for users that can access the referenced component", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Users"]}, "delete"=>{"summary"=>"Remove a component from all page access users", "description"=>"Remove a component from all page access users", "operationId"=>"remove-a-component-from-all-page-access-users", "x-api-path-slug"=>"pagespage-idcomponentscomponent-idpage-access-users-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Users"]}}, "/pages/[page_id]/page_access_groups.json"=>{"get"=>{"summary"=>"Retrieve a list of groups", "description"=>"Retrieve a list of groups", "operationId"=>"retrieve-a-list-of-groups", "x-api-path-slug"=>"pagespage-idpage-access-groups-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Group"]}, "post"=>{"summary"=>"Create a group that will define what and who can view elements of your status page", "description"=>"Create a group that will define what and who can view elements of your status page", "operationId"=>"create-a-group-that-will-define-what-and-who-can-view-elements-of-your-status-page", "x-api-path-slug"=>"pagespage-idpage-access-groups-json-post", "parameters"=>[{"in"=>"query", "name"=>"page_access_group[component_ids][]", "description"=>"Array of component ids that the created group will be able to view", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_group[external_identifier]", "description"=>"A unique string that can be used to associate this group with an external group (optional)", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_group[metric_ids][]", "description"=>"Array of metric ids that the created group will be able to view", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_group[name]", "description"=>"The name the group (required)", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_group[page_access_user_ids][]", "description"=>"Array of Page Access User ids that the created group contain", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Group"]}}, "/pages/[page_id]/page_access_groups/[page_access_group_id].json"=>{"patch"=>{"summary"=>"Change information for a group", "description"=>"Change information for a group", "operationId"=>"change-information-for-a-group", "x-api-path-slug"=>"pagespage-idpage-access-groupspage-access-group-id-json-patch", "parameters"=>[{"in"=>"query", "name"=>"page_access_group[component_ids][]", "description"=>"Array of component ids that the created group will be able to view", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_group[external_identifier]", "description"=>"A unique string that can be used to associate this group with an external group (optional)", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_group[metric_ids][]", "description"=>"Array of metric ids that the created group will be able to view", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_group[name]", "description"=>"The name the group (required)", "type"=>"string"}, {"in"=>"query", "name"=>"page_access_group[page_access_user_ids][]", "description"=>"Array of Page Access User ids that the created group contain", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Group"]}, "delete"=>{"summary"=>"Delete a group", "description"=>"Delete a group", "operationId"=>"delete-a-group", "x-api-path-slug"=>"pagespage-idpage-access-groupspage-access-group-id-json-delete", "parameters"=>[{"in"=>"query", "name"=>"page_access_group[orphan_mode]", "description"=>"specifies what to do with any associated PageAccessUsers that are members of the group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Group"]}}, "/pages/[page_id]/page_access_groups/[page_access_group_id]/components.json"=>{"post"=>{"summary"=>"Assign components to a page access group (overwrites existing components)", "description"=>"Assign components to a page access group (overwrites existing components)", "operationId"=>"assign-components-to-a-page-access-group-overwrites-existing-components", "x-api-path-slug"=>"pagespage-idpage-access-groupspage-access-group-idcomponents-json-post", "parameters"=>[{"in"=>"query", "name"=>"component_ids[]", "description"=>"Array of component ids that the group will ba able to view", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Group"]}, "patch"=>{"summary"=>"Assign components to a page access group (adds new components to a group)", "description"=>"Assign components to a page access group (adds new components to a group)", "operationId"=>"assign-components-to-a-page-access-group-adds-new-components-to-a-group", "x-api-path-slug"=>"pagespage-idpage-access-groupspage-access-group-idcomponents-json-patch", "parameters"=>[{"in"=>"query", "name"=>"component_ids[]", "description"=>"Array of component ids that the group will ba able to view", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Group"]}, "delete"=>{"summary"=>"Remove all components from a page access group", "description"=>"Remove all components from a page access group", "operationId"=>"remove-all-components-from-a-page-access-group", "x-api-path-slug"=>"pagespage-idpage-access-groupspage-access-group-idcomponents-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Group"]}}, "/pages/[page_id]/components/[component_id]/page_access_groups.json"=>{"post"=>{"summary"=>"Assign page access groups to a component", "description"=>"Assign page access groups to a component", "operationId"=>"assign-page-access-groups-to-a-component", "x-api-path-slug"=>"pagespage-idcomponentscomponent-idpage-access-groups-json-post", "parameters"=>[{"in"=>"query", "name"=>"page_access_group_ids[]", "description"=>"Array of page access group ids for groups that can access the referenced component", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Users"]}, "delete"=>{"summary"=>"Remove a component from all page access groups", "description"=>"Remove a component from all page access groups", "operationId"=>"remove-a-component-from-all-page-access-groups", "x-api-path-slug"=>"pagespage-idcomponentscomponent-idpage-access-groups-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Access Group"]}}}}, "apis"=>{"name"=>"StatusPage", "x-slug"=>"statuspage", "description"=>"StatusPage.io is the best way for web infrastructure, developer API, and SaaS companies to get set up with their very own status page in minutes", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/18898-statuspage-io.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"34303", "tags"=>"internet,Monitoring,Relative Data,Relative StreamRank,SaaS,Service API,Stack Network,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"statuspage/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"StatusPage.io", "x-api-slug"=>"statuspage-io", "description"=>"StatusPage.io is the best way for web infrastructure, developer API, and SaaS companies to get set up with their very own status page in minutes", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/18898-statuspage-io.jpg", "humanURL"=>"https://www.statuspage.io/", "baseURL"=>"https:///", "tags"=>"internet,Monitoring,Relative Data,Relative StreamRank,SaaS,Service API,Stack Network,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/statuspage/pagespage-idcomponentscomponent-idpage-access-groups-json-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/statuspage/statuspage-io-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"http://doers.statuspage.io/api/authentication/"}, {"type"=>"x-blog", "url"=>"http://blog.statuspage.io"}, {"type"=>"x-blog-rss", "url"=>"http://blog.statuspage.io/posts.rss"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/statuspage"}, {"type"=>"x-developer", "url"=>"http://doers.statuspage.io/"}, {"type"=>"x-email", "url"=>"hi@statuspage.io"}, {"type"=>"x-github", "url"=>"https://github.com/statuspage"}, {"type"=>"x-pricing", "url"=>"https://www.statuspage.io/pricing"}, {"type"=>"x-privacy", "url"=>"https://www.statuspage.io/privacy-policy"}, {"type"=>"x-security", "url"=>"https://www.statuspage.io/security"}, {"type"=>"x-status", "url"=>"http://metastatuspage.com/"}, {"type"=>"x-terms-of-service", "url"=>"https://www.statuspage.io/terms-of-service"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/statuspageio"}, {"type"=>"x-website", "url"=>"https://www.statuspage.io/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
spire-global{"spire-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Spire Global", "x-complete"=>1, "info"=>{"title"=>"Spire API", "description"=>"todo-add-description", "version"=>"1.0.0"}, "host"=>"ais.spire.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/vessels"=>{"get"=>{"summary"=>"Find Vessels Arriving Between Date/Time Window", "description"=>"Returns all vessels with an ETA greater than the `arriving_after` and ETA less than the `arriving_before` parameter.\n\nQuery can also be used without the `arriving_before` parameter.", "operationId"=>"VesselsGet10", "x-api-path-slug"=>"vessels-get", "parameters"=>[{"in"=>"query", "name"=>"arriving_after"}, {"in"=>"query", "name"=>"arriving_before"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vessels"]}}, "/vessels/a5b738b4-faf0-4a7e-9a87-1c0ccfb123d2"=>{"get"=>{"summary"=>"Get Individual Vessel", "description"=>"Returns individual ship details.", "operationId"=>"VesselsA5b738b4Faf04a7e9a871c0ccfb123d2Get", "x-api-path-slug"=>"vesselsa5b738b4faf04a7e9a871c0ccfb123d2-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vessels"]}}, "/messages"=>{"get"=>{"summary"=>"All Messages from Date/Time Window", "description"=>"Returns all messages with a timestamp greater than `received_after` and timestamp less than `received_before`.\nQuery can also be used without the `received_before` parameter.\nTimestamp must be within the past 7 days.", "operationId"=>"MessagesGet4", "x-api-path-slug"=>"messages-get", "parameters"=>[{"in"=>"query", "name"=>"fields"}, {"in"=>"query", "name"=>"limit"}, {"in"=>"query", "name"=>"received_after"}, {"in"=>"query", "name"=>"received_before"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages"]}}}}, "apis"=>{"name"=>"Spire Global", "x-slug"=>"spire-global", "description"=>"Spire Global, Inc. is an American private company specializing in data gathered from a network of small satellites.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/spire-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"557670", "tags"=>"Aviation,Enterprise,General Data,Marine,Relative Data,SaaS,Satellites,Service API,Shipping,Technology,Weather", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"spire-global/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Spire", "x-api-slug"=>"spire", "description"=>"Spire Global, Inc. is an American private company specializing in data gathered from a network of small satellites.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/spire-logo.png", "humanURL"=>"https://spire.com", "baseURL"=>"https://ais.spire.com//", "tags"=>"Aviation,Enterprise,General Data,Marine,Relative Data,SaaS,Satellites,Service API,Shipping,Technology,Weather", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/spire-global/messages-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/spire-global/spire-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://spire.com/insights/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/nanosatisfi"}, {"type"=>"x-developer", "url"=>"https://spire.com/contact/developer-portal/"}, {"type"=>"x-email", "url"=>"legal@spire.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/SpireGlobal"}, {"type"=>"x-website", "url"=>"https://spire.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
kubernetes{"apis"=>{"name"=>"Kubernetes", "x-slug"=>"kubernetes", "description"=>"Manage a cluster of Linux containers as a single system to accelerate Dev and simplify Ops. Kubernetes is an open source orchestration system for Docker containers. It handles scheduling onto nodes in a compute cluster and actively manages workloads to ensure that their state matches the users declared intentions. Using the concepts of labels and pods, it groups the containers which make up an application into logical units for easy management and discovery.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/kubernetes-logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Service Provider,Containers,Containers,Google,Profiles,Relative Data,Service API,Stack Network,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"kubernetes/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Kubernetes", "x-api-slug"=>"kubernetes", "description"=>"Manage a cluster of Linux containers as a single system to accelerate Dev and simplify Ops. Kubernetes is an open source orchestration system for Docker containers. It handles scheduling onto nodes in a compute cluster and actively manages workloads to ensure that their state matches the users declared intentions. Using the concepts of labels and pods, it groups the containers which make up an application into logical units for easy management and discovery.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/kubernetes-logo.png", "humanURL"=>"http://kubernetes.io/", "baseURL"=>":///api/v1beta3/127.0.0.1:6443", "tags"=>"API Service Provider,Containers,Containers,Google,Profiles,Relative Data,Service API,Stack Network,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/kubernetes/kubernetes-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://blog.kubernetes.io/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.kubernetes.io/feeds/posts/default"}, {"type"=>"x-github", "url"=>"https://github.com/kubernetes"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/kubernetesio"}, {"type"=>"x-webhook", "url"=>"https://kubernetes.io/docs/reference/access-authn-authz/webhook/"}, {"type"=>"x-website", "url"=>"http://kubernetes.io/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "kubernetes-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Kubernetes", "x-complete"=>1, "info"=>{"title"=>"Kubernetes", "version"=>"1.0.0"}, "host"=>"/api/v1beta3", "basePath"=>"127.0.0.1:6443", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/v1beta3/endpoints"=>{"get"=>{"summary"=>"Get Endpoints", "description"=>"List objects of kind endpoints.", "operationId"=>"listEndpoints", "x-api-path-slug"=>"apiv1beta3endpoints-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Endpoints"]}}, "/api/v1beta3/events"=>{"get"=>{"summary"=>"Get Events", "description"=>"List objects of kind event.", "operationId"=>"listEvent", "x-api-path-slug"=>"apiv1beta3events-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/api/v1beta3/limitranges"=>{"get"=>{"summary"=>"Get Limitranges", "description"=>"List objects of kind limitrange.", "operationId"=>"listLimitRange", "x-api-path-slug"=>"apiv1beta3limitranges-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Limitranges"]}}, "/api/v1beta3/namespaces"=>{"get"=>{"summary"=>"Get Namespaces", "description"=>"List objects of kind namespace.", "operationId"=>"listNamespace", "x-api-path-slug"=>"apiv1beta3namespaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces"]}, "post"=>{"summary"=>"Post Namespaces", "description"=>"Create a namespace.", "operationId"=>"createNamespace", "x-api-path-slug"=>"apiv1beta3namespaces-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces"]}}, "/api/v1beta3/namespaces/{namespaces}/bindings"=>{"post"=>{"summary"=>"Post Namespaces Bindings", "description"=>"Create a binding.", "operationId"=>"createBinding", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesbindings-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Bindings"]}}, "/api/v1beta3/namespaces/{namespaces}/endpoints"=>{"get"=>{"summary"=>"Get Namespaces Endpoints", "description"=>"List objects of kind endpoints.", "operationId"=>"listEndpoints", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesendpoints-get", "parameters"=>[{"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Endpoints"]}, "post"=>{"summary"=>"Post Namespaces Endpoints", "description"=>"Create a endpoints.", "operationId"=>"createEndpoints", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesendpoints-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Endpoints"]}}, "/api/v1beta3/namespaces/{namespaces}/endpoints/{name}"=>{"get"=>{"summary"=>"Get Namespaces Endpoints Name", "description"=>"Read the specified endpoints.", "operationId"=>"readEndpoints", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesendpointsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Endpoints"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Endpoints", "Name"]}, "put"=>{"summary"=>"Put Namespaces Endpoints Name", "description"=>"Update the specified endpoints.", "operationId"=>"updateEndpoints", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesendpointsname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"name of the Endpoints"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Endpoints", "Name"]}}, "/api/v1beta3/namespaces/{namespaces}/events"=>{"get"=>{"summary"=>"Get Namespaces Events", "description"=>"List objects of kind event.", "operationId"=>"listEvent", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesevents-get", "parameters"=>[{"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Events"]}, "post"=>{"summary"=>"Post Namespaces Events", "description"=>"Create a event.", "operationId"=>"createEvent", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesevents-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Events"]}}, "/api/v1beta3/namespaces/{namespaces}/events/{name}"=>{"delete"=>{"summary"=>"Delete Namespaces Events Name", "description"=>"Delete a event.", "operationId"=>"deleteEvent", "x-api-path-slug"=>"apiv1beta3namespacesnamespaceseventsname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Event"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Events", "Name"]}, "get"=>{"summary"=>"Get Namespaces Events Name", "description"=>"Read the specified event.", "operationId"=>"readEvent", "x-api-path-slug"=>"apiv1beta3namespacesnamespaceseventsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Event"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Events", "Name"]}, "put"=>{"summary"=>"Put Namespaces Events Name", "description"=>"Update the specified event.", "operationId"=>"updateEvent", "x-api-path-slug"=>"apiv1beta3namespacesnamespaceseventsname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"name of the Event"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Events", "Name"]}}, "/api/v1beta3/namespaces/{namespaces}/limitranges"=>{"get"=>{"summary"=>"Get Namespaces Limitranges", "description"=>"List objects of kind limitrange.", "operationId"=>"listLimitRange", "x-api-path-slug"=>"apiv1beta3namespacesnamespaceslimitranges-get", "parameters"=>[{"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Limitranges"]}, "post"=>{"summary"=>"Post Namespaces Limitranges", "description"=>"Create a limitrange.", "operationId"=>"createLimitRange", "x-api-path-slug"=>"apiv1beta3namespacesnamespaceslimitranges-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Limitranges"]}}, "/api/v1beta3/namespaces/{namespaces}/limitranges/{name}"=>{"delete"=>{"summary"=>"Delete Namespaces Limitranges Name", "description"=>"Delete a limitrange.", "operationId"=>"deleteLimitRange", "x-api-path-slug"=>"apiv1beta3namespacesnamespaceslimitrangesname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the LimitRange"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Limitranges", "Name"]}, "get"=>{"summary"=>"Get Namespaces Limitranges Name", "description"=>"Read the specified limitrange.", "operationId"=>"readLimitRange", "x-api-path-slug"=>"apiv1beta3namespacesnamespaceslimitrangesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the LimitRange"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Limitranges", "Name"]}, "put"=>{"summary"=>"Put Namespaces Limitranges Name", "description"=>"Update the specified limitrange.", "operationId"=>"updateLimitRange", "x-api-path-slug"=>"apiv1beta3namespacesnamespaceslimitrangesname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"name of the LimitRange"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Limitranges", "Name"]}}, "/api/v1beta3/namespaces/{namespaces}/pods"=>{"get"=>{"summary"=>"Get Namespaces Pods", "description"=>"List objects of kind pod.", "operationId"=>"listPod", "x-api-path-slug"=>"apiv1beta3namespacesnamespacespods-get", "parameters"=>[{"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Pods"]}, "post"=>{"summary"=>"Post Namespaces Pods", "description"=>"Create a pod.", "operationId"=>"createPod", "x-api-path-slug"=>"apiv1beta3namespacesnamespacespods-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Pods"]}}, "/api/v1beta3/namespaces/{namespaces}/pods/{name}"=>{"delete"=>{"summary"=>"Delete Namespaces Pods Name", "description"=>"Delete a pod.", "operationId"=>"deletePod", "x-api-path-slug"=>"apiv1beta3namespacesnamespacespodsname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Pod"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Pods", "Name"]}, "get"=>{"summary"=>"Get Namespaces Pods Name", "description"=>"Read the specified pod.", "operationId"=>"readPod", "x-api-path-slug"=>"apiv1beta3namespacesnamespacespodsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Pod"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Pods", "Name"]}, "put"=>{"summary"=>"Put Namespaces Pods Name", "description"=>"Update the specified pod.", "operationId"=>"updatePod", "x-api-path-slug"=>"apiv1beta3namespacesnamespacespodsname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"name of the Pod"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Pods", "Name"]}}, "/api/v1beta3/namespaces/{namespaces}/replicationcontrollers"=>{"get"=>{"summary"=>"Get Namespaces Replicationcontrollers", "description"=>"List objects of kind replicationcontroller.", "operationId"=>"listReplicationController", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesreplicationcontrollers-get", "parameters"=>[{"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Replicationcontrollers"]}, "post"=>{"summary"=>"Post Namespaces Replicationcontrollers", "description"=>"Create a replicationcontroller.", "operationId"=>"createReplicationController", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesreplicationcontrollers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Replicationcontrollers"]}}, "/api/v1beta3/namespaces/{namespaces}/replicationcontrollers/{name}"=>{"delete"=>{"summary"=>"Delete Namespaces Replicationcontrollers Name", "description"=>"Delete a replicationcontroller.", "operationId"=>"deleteReplicationController", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesreplicationcontrollersname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the ReplicationController"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Replicationcontrollers", "Name"]}, "get"=>{"summary"=>"Get Namespaces Replicationcontrollers Name", "description"=>"Read the specified replicationcontroller.", "operationId"=>"readReplicationController", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesreplicationcontrollersname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the ReplicationController"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Replicationcontrollers", "Name"]}, "put"=>{"summary"=>"Put Namespaces Replicationcontrollers Name", "description"=>"Update the specified replicationcontroller.", "operationId"=>"updateReplicationController", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesreplicationcontrollersname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"name of the ReplicationController"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Replicationcontrollers", "Name"]}}, "/api/v1beta3/namespaces/{namespaces}/resourcequotas"=>{"get"=>{"summary"=>"Get Namespaces Resourcequotas", "description"=>"List objects of kind resourcequota.", "operationId"=>"listResourceQuota", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesresourcequotas-get", "parameters"=>[{"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Resourcequotas"]}, "post"=>{"summary"=>"Post Namespaces Resourcequotas", "description"=>"Create a resourcequota.", "operationId"=>"createResourceQuota", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesresourcequotas-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Resourcequotas"]}}, "/api/v1beta3/namespaces/{namespaces}/resourcequotas/{name}"=>{"delete"=>{"summary"=>"Delete Namespaces Resourcequotas Name", "description"=>"Delete a resourcequota.", "operationId"=>"deleteResourceQuota", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesresourcequotasname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the ResourceQuota"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Resourcequotas", "Name"]}, "get"=>{"summary"=>"Get Namespaces Resourcequotas Name", "description"=>"Read the specified resourcequota.", "operationId"=>"readResourceQuota", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesresourcequotasname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the ResourceQuota"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Resourcequotas", "Name"]}, "put"=>{"summary"=>"Put Namespaces Resourcequotas Name", "description"=>"Update the specified resourcequota.", "operationId"=>"updateResourceQuota", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesresourcequotasname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"name of the ResourceQuota"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Resourcequotas", "Name"]}}, "/api/v1beta3/namespaces/{namespaces}/resourcequotausages"=>{"post"=>{"summary"=>"Post Namespaces Resourcequotausages", "description"=>"Create a resourcequotausage.", "operationId"=>"createResourceQuotaUsage", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesresourcequotausages-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Resourcequotausages"]}}, "/api/v1beta3/namespaces/{namespaces}/secrets"=>{"get"=>{"summary"=>"Get Namespaces Secrets", "description"=>"List objects of kind secret.", "operationId"=>"listSecret", "x-api-path-slug"=>"apiv1beta3namespacesnamespacessecrets-get", "parameters"=>[{"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Secrets"]}, "post"=>{"summary"=>"Post Namespaces Secrets", "description"=>"Create a secret.", "operationId"=>"createSecret", "x-api-path-slug"=>"apiv1beta3namespacesnamespacessecrets-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Secrets"]}}, "/api/v1beta3/namespaces/{namespaces}/secrets/{name}"=>{"delete"=>{"summary"=>"Delete Namespaces Secrets Name", "description"=>"Delete a secret.", "operationId"=>"deleteSecret", "x-api-path-slug"=>"apiv1beta3namespacesnamespacessecretsname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Secret"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Secrets", "Name"]}, "get"=>{"summary"=>"Get Namespaces Secrets Name", "description"=>"Read the specified secret.", "operationId"=>"readSecret", "x-api-path-slug"=>"apiv1beta3namespacesnamespacessecretsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Secret"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Secrets", "Name"]}, "put"=>{"summary"=>"Put Namespaces Secrets Name", "description"=>"Update the specified secret.", "operationId"=>"updateSecret", "x-api-path-slug"=>"apiv1beta3namespacesnamespacessecretsname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"name of the Secret"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Secrets", "Name"]}}, "/api/v1beta3/namespaces/{namespaces}/services"=>{"get"=>{"summary"=>"Get Namespaces Services", "description"=>"List objects of kind service.", "operationId"=>"listService", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesservices-get", "parameters"=>[{"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Services"]}, "post"=>{"summary"=>"Post Namespaces Services", "description"=>"Create a service.", "operationId"=>"createService", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesservices-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Services"]}}, "/api/v1beta3/namespaces/{namespaces}/services/{name}"=>{"delete"=>{"summary"=>"Delete Namespaces Services Name", "description"=>"Delete a service.", "operationId"=>"deleteService", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesservicesname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Service"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Services", "Name"]}, "get"=>{"summary"=>"Get Namespaces Services Name", "description"=>"Read the specified service.", "operationId"=>"readService", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesservicesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Service"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Services", "Name"]}, "put"=>{"summary"=>"Put Namespaces Services Name", "description"=>"Update the specified service.", "operationId"=>"updateService", "x-api-path-slug"=>"apiv1beta3namespacesnamespacesservicesname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"name of the Service"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Services", "Name"]}}, "/api/v1beta3/namespaces/{name}"=>{"delete"=>{"summary"=>"Delete Namespaces Name", "description"=>"Delete a namespace.", "operationId"=>"deleteNamespace", "x-api-path-slug"=>"apiv1beta3namespacesname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Namespace"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Name"]}, "get"=>{"summary"=>"Get Namespaces Name", "description"=>"Read the specified namespace.", "operationId"=>"readNamespace", "x-api-path-slug"=>"apiv1beta3namespacesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Namespace"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Name"]}, "put"=>{"summary"=>"Put Namespaces Name", "description"=>"Update the specified namespace.", "operationId"=>"updateNamespace", "x-api-path-slug"=>"apiv1beta3namespacesname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"name of the Namespace"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Namespaces", "Name"]}}, "/api/v1beta3/nodes"=>{"get"=>{"summary"=>"Get Nodes", "description"=>"List objects of kind node.", "operationId"=>"listNode", "x-api-path-slug"=>"apiv1beta3nodes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes"]}, "post"=>{"summary"=>"Post Nodes", "description"=>"Create a node.", "operationId"=>"createNode", "x-api-path-slug"=>"apiv1beta3nodes-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes"]}}, "/api/v1beta3/nodes/{name}"=>{"delete"=>{"summary"=>"Delete Nodes Name", "description"=>"Delete a node.", "operationId"=>"deleteNode", "x-api-path-slug"=>"apiv1beta3nodesname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Name"]}, "get"=>{"summary"=>"Get Nodes Name", "description"=>"Read the specified node.", "operationId"=>"readNode", "x-api-path-slug"=>"apiv1beta3nodesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Name"]}, "put"=>{"summary"=>"Put Nodes Name", "description"=>"Update the specified node.", "operationId"=>"updateNode", "x-api-path-slug"=>"apiv1beta3nodesname-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"name of the Node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nodes", "Name"]}}, "/api/v1beta3/pods"=>{"get"=>{"summary"=>"Get Pods", "description"=>"List objects of kind pod.", "operationId"=>"listPod", "x-api-path-slug"=>"apiv1beta3pods-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pods"]}}, "/api/v1beta3/proxy/namespaces/{namespaces}/pods/{name}"=>{"delete"=>{"summary"=>"Delete Proxy Namespaces Pods Name", "description"=>"Proxy delete requests to pod.", "operationId"=>"proxyDELETEPod", "x-api-path-slug"=>"apiv1beta3proxynamespacesnamespacespodsname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Pod"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Namespaces", "Pods", "Name"]}, "get"=>{"summary"=>"Get Proxy Namespaces Pods Name", "description"=>"Proxy get requests to pod.", "operationId"=>"proxyGETPod", "x-api-path-slug"=>"apiv1beta3proxynamespacesnamespacespodsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Pod"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Namespaces", "Pods", "Name"]}, "post"=>{"summary"=>"Post Proxy Namespaces Pods Name", "description"=>"Proxy post requests to pod.", "operationId"=>"proxyPOSTPod", "x-api-path-slug"=>"apiv1beta3proxynamespacesnamespacespodsname-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Pod"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Namespaces", "Pods", "Name"]}, "put"=>{"summary"=>"Put Proxy Namespaces Pods Name", "description"=>"Proxy put requests to pod.", "operationId"=>"proxyPUTPod", "x-api-path-slug"=>"apiv1beta3proxynamespacesnamespacespodsname-put", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Pod"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Namespaces", "Pods", "Name"]}}, "/api/v1beta3/proxy/namespaces/{namespaces}/pods/{name}/{path:*}"=>{"delete"=>{"summary"=>"Delete Proxy Namespaces Pods Name Path *", "description"=>"Proxy delete requests to pod.", "operationId"=>"proxyDELETEPod", "x-api-path-slug"=>"apiv1beta3proxynamespacesnamespacespodsnamepath-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Pod"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Namespaces", "Pods", "Name", "Path", "*"]}, "get"=>{"summary"=>"Get Proxy Namespaces Pods Name Path *", "description"=>"Proxy get requests to pod.", "operationId"=>"proxyGETPod", "x-api-path-slug"=>"apiv1beta3proxynamespacesnamespacespodsnamepath-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Pod"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Namespaces", "Pods", "Name", "Path", "*"]}, "post"=>{"summary"=>"Post Proxy Namespaces Pods Name Path *", "description"=>"Proxy post requests to pod.", "operationId"=>"proxyPOSTPod", "x-api-path-slug"=>"apiv1beta3proxynamespacesnamespacespodsnamepath-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Pod"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Namespaces", "Pods", "Name", "Path", "*"]}, "put"=>{"summary"=>"Put Proxy Namespaces Pods Name Path *", "description"=>"Proxy put requests to pod.", "operationId"=>"proxyPUTPod", "x-api-path-slug"=>"apiv1beta3proxynamespacesnamespacespodsnamepath-put", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Pod"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Namespaces", "Pods", "Name", "Path", "*"]}}, "/api/v1beta3/proxy/namespaces/{namespaces}/services/{name}"=>{"delete"=>{"summary"=>"Delete Proxy Namespaces Services Name", "description"=>"Proxy delete requests to service.", "operationId"=>"proxyDELETEService", "x-api-path-slug"=>"apiv1beta3proxynamespacesnamespacesservicesname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Service"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Namespaces", "Services", "Name"]}, "get"=>{"summary"=>"Get Proxy Namespaces Services Name", "description"=>"Proxy get requests to service.", "operationId"=>"proxyGETService", "x-api-path-slug"=>"apiv1beta3proxynamespacesnamespacesservicesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Service"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Namespaces", "Services", "Name"]}, "post"=>{"summary"=>"Post Proxy Namespaces Services Name", "description"=>"Proxy post requests to service.", "operationId"=>"proxyPOSTService", "x-api-path-slug"=>"apiv1beta3proxynamespacesnamespacesservicesname-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Service"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Namespaces", "Services", "Name"]}, "put"=>{"summary"=>"Put Proxy Namespaces Services Name", "description"=>"Proxy put requests to service.", "operationId"=>"proxyPUTService", "x-api-path-slug"=>"apiv1beta3proxynamespacesnamespacesservicesname-put", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Service"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Namespaces", "Services", "Name"]}}, "/api/v1beta3/proxy/namespaces/{namespaces}/services/{name}/{path:*}"=>{"delete"=>{"summary"=>"Delete Proxy Namespaces Services Name Path *", "description"=>"Proxy delete requests to service.", "operationId"=>"proxyDELETEService", "x-api-path-slug"=>"apiv1beta3proxynamespacesnamespacesservicesnamepath-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Service"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Namespaces", "Services", "Name", "Path", "*"]}, "get"=>{"summary"=>"Get Proxy Namespaces Services Name Path *", "description"=>"Proxy get requests to service.", "operationId"=>"proxyGETService", "x-api-path-slug"=>"apiv1beta3proxynamespacesnamespacesservicesnamepath-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Service"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Namespaces", "Services", "Name", "Path", "*"]}, "post"=>{"summary"=>"Post Proxy Namespaces Services Name Path *", "description"=>"Proxy post requests to service.", "operationId"=>"proxyPOSTService", "x-api-path-slug"=>"apiv1beta3proxynamespacesnamespacesservicesnamepath-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Service"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Namespaces", "Services", "Name", "Path", "*"]}, "put"=>{"summary"=>"Put Proxy Namespaces Services Name Path *", "description"=>"Proxy put requests to service.", "operationId"=>"proxyPUTService", "x-api-path-slug"=>"apiv1beta3proxynamespacesnamespacesservicesnamepath-put", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Service"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Namespaces", "Services", "Name", "Path", "*"]}}, "/api/v1beta3/proxy/nodes/{name}"=>{"delete"=>{"summary"=>"Delete Proxy Nodes Name", "description"=>"Proxy delete requests to node.", "operationId"=>"proxyDELETENode", "x-api-path-slug"=>"apiv1beta3proxynodesname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Nodes", "Name"]}, "get"=>{"summary"=>"Get Proxy Nodes Name", "description"=>"Proxy get requests to node.", "operationId"=>"proxyGETNode", "x-api-path-slug"=>"apiv1beta3proxynodesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Nodes", "Name"]}, "post"=>{"summary"=>"Post Proxy Nodes Name", "description"=>"Proxy post requests to node.", "operationId"=>"proxyPOSTNode", "x-api-path-slug"=>"apiv1beta3proxynodesname-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Nodes", "Name"]}, "put"=>{"summary"=>"Put Proxy Nodes Name", "description"=>"Proxy put requests to node.", "operationId"=>"proxyPUTNode", "x-api-path-slug"=>"apiv1beta3proxynodesname-put", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Nodes", "Name"]}}, "/api/v1beta3/proxy/nodes/{name}/{path:*}"=>{"delete"=>{"summary"=>"Delete Proxy Nodes Name Path *", "description"=>"Proxy delete requests to node.", "operationId"=>"proxyDELETENode", "x-api-path-slug"=>"apiv1beta3proxynodesnamepath-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Nodes", "Name", "Path", "*"]}, "get"=>{"summary"=>"Get Proxy Nodes Name Path *", "description"=>"Proxy get requests to node.", "operationId"=>"proxyGETNode", "x-api-path-slug"=>"apiv1beta3proxynodesnamepath-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Nodes", "Name", "Path", "*"]}, "post"=>{"summary"=>"Post Proxy Nodes Name Path *", "description"=>"Proxy post requests to node.", "operationId"=>"proxyPOSTNode", "x-api-path-slug"=>"apiv1beta3proxynodesnamepath-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Nodes", "Name", "Path", "*"]}, "put"=>{"summary"=>"Put Proxy Nodes Name Path *", "description"=>"Proxy put requests to node.", "operationId"=>"proxyPUTNode", "x-api-path-slug"=>"apiv1beta3proxynodesnamepath-put", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy", "Nodes", "Name", "Path", "*"]}}, "/api/v1beta3/redirect/namespaces/{namespaces}/pods/{name}"=>{"get"=>{"summary"=>"Get Redirect Namespaces Pods Name", "description"=>"Redirect get request to pod.", "operationId"=>"redirectPod", "x-api-path-slug"=>"apiv1beta3redirectnamespacesnamespacespodsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Pod"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redirect", "Namespaces", "Pods", "Name"]}}, "/api/v1beta3/redirect/namespaces/{namespaces}/services/{name}"=>{"get"=>{"summary"=>"Get Redirect Namespaces Services Name", "description"=>"Redirect get request to service.", "operationId"=>"redirectService", "x-api-path-slug"=>"apiv1beta3redirectnamespacesnamespacesservicesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Service"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redirect", "Namespaces", "Services", "Name"]}}, "/api/v1beta3/redirect/nodes/{name}"=>{"get"=>{"summary"=>"Get Redirect Nodes Name", "description"=>"Redirect get request to node.", "operationId"=>"redirectNode", "x-api-path-slug"=>"apiv1beta3redirectnodesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Redirect", "Nodes", "Name"]}}, "/api/v1beta3/replicationcontrollers"=>{"get"=>{"summary"=>"Get Replicationcontrollers", "description"=>"List objects of kind replicationcontroller.", "operationId"=>"listReplicationController", "x-api-path-slug"=>"apiv1beta3replicationcontrollers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replicationcontrollers"]}}, "/api/v1beta3/resourcequotas"=>{"get"=>{"summary"=>"Get Resourcequotas", "description"=>"List objects of kind resourcequota.", "operationId"=>"listResourceQuota", "x-api-path-slug"=>"apiv1beta3resourcequotas-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resourcequotas"]}}, "/api/v1beta3/secrets"=>{"get"=>{"summary"=>"Get Secrets", "description"=>"List objects of kind secret.", "operationId"=>"listSecret", "x-api-path-slug"=>"apiv1beta3secrets-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Secrets"]}}, "/api/v1beta3/services"=>{"get"=>{"summary"=>"Get Services", "description"=>"List objects of kind service.", "operationId"=>"listService", "x-api-path-slug"=>"apiv1beta3services-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/api/v1beta3/watch/endpoints"=>{"get"=>{"summary"=>"Get Watch Endpoints", "description"=>"Watch a list of endpoints.", "operationId"=>"watchEndpointslist", "x-api-path-slug"=>"apiv1beta3watchendpoints-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Endpoints"]}}, "/api/v1beta3/watch/events"=>{"get"=>{"summary"=>"Get Watch Events", "description"=>"Watch a list of event.", "operationId"=>"watchEventlist", "x-api-path-slug"=>"apiv1beta3watchevents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Events"]}}, "/api/v1beta3/watch/limitranges"=>{"get"=>{"summary"=>"Get Watch Limitranges", "description"=>"Watch a list of limitrange.", "operationId"=>"watchLimitRangelist", "x-api-path-slug"=>"apiv1beta3watchlimitranges-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Limitranges"]}}, "/api/v1beta3/watch/namespaces"=>{"get"=>{"summary"=>"Get Watch Namespaces", "description"=>"Watch a list of namespace.", "operationId"=>"watchNamespacelist", "x-api-path-slug"=>"apiv1beta3watchnamespaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces"]}}, "/api/v1beta3/watch/namespaces/{namespaces}/endpoints"=>{"get"=>{"summary"=>"Get Watch Namespaces Endpoints", "description"=>"Watch a list of endpoints.", "operationId"=>"watchEndpointslist", "x-api-path-slug"=>"apiv1beta3watchnamespacesnamespacesendpoints-get", "parameters"=>[{"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Endpoints"]}}, "/api/v1beta3/watch/namespaces/{namespaces}/endpoints/{name}"=>{"get"=>{"summary"=>"Get Watch Namespaces Endpoints Name", "description"=>"Watch a particular endpoints.", "operationId"=>"watchEndpoints", "x-api-path-slug"=>"apiv1beta3watchnamespacesnamespacesendpointsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Endpoints"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Endpoints", "Name"]}}, "/api/v1beta3/watch/namespaces/{namespaces}/events"=>{"get"=>{"summary"=>"Get Watch Namespaces Events", "description"=>"Watch a list of event.", "operationId"=>"watchEventlist", "x-api-path-slug"=>"apiv1beta3watchnamespacesnamespacesevents-get", "parameters"=>[{"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Events"]}}, "/api/v1beta3/watch/namespaces/{namespaces}/events/{name}"=>{"get"=>{"summary"=>"Get Watch Namespaces Events Name", "description"=>"Watch a particular event.", "operationId"=>"watchEvent", "x-api-path-slug"=>"apiv1beta3watchnamespacesnamespaceseventsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Event"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Events", "Name"]}}, "/api/v1beta3/watch/namespaces/{namespaces}/limitranges"=>{"get"=>{"summary"=>"Get Watch Namespaces Limitranges", "description"=>"Watch a list of limitrange.", "operationId"=>"watchLimitRangelist", "x-api-path-slug"=>"apiv1beta3watchnamespacesnamespaceslimitranges-get", "parameters"=>[{"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Limitranges"]}}, "/api/v1beta3/watch/namespaces/{namespaces}/limitranges/{name}"=>{"get"=>{"summary"=>"Get Watch Namespaces Limitranges Name", "description"=>"Watch a particular limitrange.", "operationId"=>"watchLimitRange", "x-api-path-slug"=>"apiv1beta3watchnamespacesnamespaceslimitrangesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the LimitRange"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Limitranges", "Name"]}}, "/api/v1beta3/watch/namespaces/{namespaces}/pods"=>{"get"=>{"summary"=>"Get Watch Namespaces Pods", "description"=>"Watch a list of pod.", "operationId"=>"watchPodlist", "x-api-path-slug"=>"apiv1beta3watchnamespacesnamespacespods-get", "parameters"=>[{"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Pods"]}}, "/api/v1beta3/watch/namespaces/{namespaces}/pods/{name}"=>{"get"=>{"summary"=>"Get Watch Namespaces Pods Name", "description"=>"Watch a particular pod.", "operationId"=>"watchPod", "x-api-path-slug"=>"apiv1beta3watchnamespacesnamespacespodsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Pod"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Pods", "Name"]}}, "/api/v1beta3/watch/namespaces/{namespaces}/replicationcontrollers"=>{"get"=>{"summary"=>"Get Watch Namespaces Replicationcontrollers", "description"=>"Watch a list of replicationcontroller.", "operationId"=>"watchReplicationControllerlist", "x-api-path-slug"=>"apiv1beta3watchnamespacesnamespacesreplicationcontrollers-get", "parameters"=>[{"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Replicationcontrollers"]}}, "/api/v1beta3/watch/namespaces/{namespaces}/replicationcontrollers/{name}"=>{"get"=>{"summary"=>"Get Watch Namespaces Replicationcontrollers Name", "description"=>"Watch a particular replicationcontroller.", "operationId"=>"watchReplicationController", "x-api-path-slug"=>"apiv1beta3watchnamespacesnamespacesreplicationcontrollersname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the ReplicationController"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Replicationcontrollers", "Name"]}}, "/api/v1beta3/watch/namespaces/{namespaces}/resourcequotas"=>{"get"=>{"summary"=>"Get Watch Namespaces Resourcequotas", "description"=>"Watch a list of resourcequota.", "operationId"=>"watchResourceQuotalist", "x-api-path-slug"=>"apiv1beta3watchnamespacesnamespacesresourcequotas-get", "parameters"=>[{"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Resourcequotas"]}}, "/api/v1beta3/watch/namespaces/{namespaces}/resourcequotas/{name}"=>{"get"=>{"summary"=>"Get Watch Namespaces Resourcequotas Name", "description"=>"Watch a particular resourcequota.", "operationId"=>"watchResourceQuota", "x-api-path-slug"=>"apiv1beta3watchnamespacesnamespacesresourcequotasname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the ResourceQuota"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Resourcequotas", "Name"]}}, "/api/v1beta3/watch/namespaces/{namespaces}/secrets"=>{"get"=>{"summary"=>"Get Watch Namespaces Secrets", "description"=>"Watch a list of secret.", "operationId"=>"watchSecretlist", "x-api-path-slug"=>"apiv1beta3watchnamespacesnamespacessecrets-get", "parameters"=>[{"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Secrets"]}}, "/api/v1beta3/watch/namespaces/{namespaces}/secrets/{name}"=>{"get"=>{"summary"=>"Get Watch Namespaces Secrets Name", "description"=>"Watch a particular secret.", "operationId"=>"watchSecret", "x-api-path-slug"=>"apiv1beta3watchnamespacesnamespacessecretsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Secret"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Secrets", "Name"]}}, "/api/v1beta3/watch/namespaces/{namespaces}/services"=>{"get"=>{"summary"=>"Get Watch Namespaces Services", "description"=>"Watch a list of service.", "operationId"=>"watchServicelist", "x-api-path-slug"=>"apiv1beta3watchnamespacesnamespacesservices-get", "parameters"=>[{"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Services"]}}, "/api/v1beta3/watch/namespaces/{namespaces}/services/{name}"=>{"get"=>{"summary"=>"Get Watch Namespaces Services Name", "description"=>"Watch a particular service.", "operationId"=>"watchService", "x-api-path-slug"=>"apiv1beta3watchnamespacesnamespacesservicesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Service"}, {"in"=>"path", "name"=>"namespaces", "description"=>"object name and auth scope, such as for teams and projects"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Services", "Name"]}}, "/api/v1beta3/watch/namespaces/{name}"=>{"get"=>{"summary"=>"Get Watch Namespaces Name", "description"=>"Watch a particular namespace.", "operationId"=>"watchNamespace", "x-api-path-slug"=>"apiv1beta3watchnamespacesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Namespace"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Namespaces", "Name"]}}, "/api/v1beta3/watch/nodes"=>{"get"=>{"summary"=>"Get Watch Nodes", "description"=>"Watch a list of node.", "operationId"=>"watchNodelist", "x-api-path-slug"=>"apiv1beta3watchnodes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Nodes"]}}, "/api/v1beta3/watch/nodes/{name}"=>{"get"=>{"summary"=>"Get Watch Nodes Name", "description"=>"Watch a particular node.", "operationId"=>"watchNode", "x-api-path-slug"=>"apiv1beta3watchnodesname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"name of the Node"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Nodes", "Name"]}}, "/api/v1beta3/watch/pods"=>{"get"=>{"summary"=>"Get Watch Pods", "description"=>"Watch a list of pod.", "operationId"=>"watchPodlist", "x-api-path-slug"=>"apiv1beta3watchpods-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Pods"]}}, "/api/v1beta3/watch/replicationcontrollers"=>{"get"=>{"summary"=>"Get Watch Replicationcontrollers", "description"=>"Watch a list of replicationcontroller.", "operationId"=>"watchReplicationControllerlist", "x-api-path-slug"=>"apiv1beta3watchreplicationcontrollers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Replicationcontrollers"]}}, "/api/v1beta3/watch/resourcequotas"=>{"get"=>{"summary"=>"Get Watch Resourcequotas", "description"=>"Watch a list of resourcequota.", "operationId"=>"watchResourceQuotalist", "x-api-path-slug"=>"apiv1beta3watchresourcequotas-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Resourcequotas"]}}, "/api/v1beta3/watch/secrets"=>{"get"=>{"summary"=>"Get Watch Secrets", "description"=>"Watch a list of secret.", "operationId"=>"watchSecretlist", "x-api-path-slug"=>"apiv1beta3watchsecrets-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Secrets"]}}, "/api/v1beta3/watch/services"=>{"get"=>{"summary"=>"Get Watch Services", "description"=>"Watch a list of service.", "operationId"=>"watchServicelist", "x-api-path-slug"=>"apiv1beta3watchservices-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Watch", "Services"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
sustainable-facilities-tool-api{"sustainable-facilities-tool-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Sustainable Facilities Tool API", "x-complete"=>1, "info"=>{"title"=>"Sustainable Facilities Tool API", "description"=>"our-core-api-allows-developers-to-interact-with-the-sustainable-facilities-tool-programmatically--its-designed-for-public-use-and-to-be-easily-integrated-into-other-applications-", "termsOfService"=>"https://sftool.gov/developer/terms-of-use", "version"=>"1.0.0"}, "host"=>"api.data.gov", "basePath"=>"/sftool/v1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/building-systems"=>{"get"=>{"summary"=>"Returns all building systems.", "description"=>"Returns all building systems.", "operationId"=>"returnBuildingSystems", "x-api-path-slug"=>"buildingsystems-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Building Systems"]}}, "/building-systems/{parameter}"=>{"get"=>{"summary"=>"Returns a building system by parameter.", "description"=>"Returns a building system by parameter.", "operationId"=>"returnBuildingSystem", "x-api-path-slug"=>"buildingsystemsparameter-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Building Systems"]}}, "/building-systems/{parameter}/resources"=>{"get"=>{"summary"=>"Returns Building System Resources", "description"=>"Returns informational resources for the building system selected by parameter.", "operationId"=>"returnBuildingSystemResources", "x-api-path-slug"=>"buildingsystemsparameterresources-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Building System Resources"]}}, "/building-systems/case-studies"=>{"get"=>{"summary"=>"Building System Case Studies", "description"=>"Returns all building systems case studies", "operationId"=>"returnBuildingSystemCaseStudies", "x-api-path-slug"=>"buildingsystemscasestudies-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Case Studies"]}}, "/building-systems/{parameter}/case-studies"=>{"get"=>{"summary"=>"Building System Case Study", "description"=>"Returns a building system case study by parameter.", "operationId"=>"returnBuildingSystemCaseStudies", "x-api-path-slug"=>"buildingsystemsparametercasestudies-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Case Studies"]}}, "/building-systems/mandates"=>{"get"=>{"summary"=>"Building System Mandates", "description"=>"Returns all building systems mandates", "operationId"=>"returnBuildingSystemMandates", "x-api-path-slug"=>"buildingsystemsmandates-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mandates"]}}, "/building-systems/{parameter}/mandates"=>{"get"=>{"summary"=>"Building System Mandate", "description"=>"Returns a building system mandate by parameter.", "operationId"=>"returnBuildingSystemMandate", "x-api-path-slug"=>"buildingsystemsparametermandates-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mandates"]}}, "/building-systems/rating-systems"=>{"get"=>{"summary"=>"Building System Rating Systems", "description"=>"Returns all building system rating systems", "operationId"=>"returnBuildingSystemRating", "x-api-path-slug"=>"buildingsystemsratingsystems-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rating Systems"]}}, "/building-systems/{parameter}/rating-systems"=>{"get"=>{"summary"=>"Building System Rating System", "description"=>"Returns a building system rating system by parameter.", "operationId"=>"returnBuildingSystemRating", "x-api-path-slug"=>"buildingsystemsparameterratingsystems-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rating Systems"]}}, "/building-systems/system-bundles"=>{"get"=>{"summary"=>"Building System Bundles", "description"=>"Returns all building system bundles.", "operationId"=>"returnsBuildingSystemBundles", "x-api-path-slug"=>"buildingsystemssystembundles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bundles"]}}, "/building-systems/{parameter}/system-bundles"=>{"get"=>{"summary"=>"Building System Bundle", "description"=>"Returns a building system bundle by parameter.", "operationId"=>"returnsBuildingSystemBundle", "x-api-path-slug"=>"buildingsystemsparametersystembundles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bundles"]}}, "/building-systems/integrative-teams"=>{"get"=>{"summary"=>"Building System Integrative Teams", "description"=>"Returns all building system integrative teams.", "operationId"=>"returnBuildingSystemIntegrativeTeams", "x-api-path-slug"=>"buildingsystemsintegrativeteams-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams"]}}, "/building-systems/{parameter}/integrative-teams"=>{"get"=>{"summary"=>"Building System Integrative Team", "description"=>"Returns a building system integrative team by parameter.", "operationId"=>"returnBuildingSystemIntegrativeTeams", "x-api-path-slug"=>"buildingsystemsparameterintegrativeteams-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Teams"]}}, "/contentpages"=>{"get"=>{"summary"=>"Content Pages", "description"=>"Returns all content pages", "operationId"=>"returnContentPages", "x-api-path-slug"=>"contentpages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content"]}}, "/contentpages/{parameter}"=>{"get"=>{"summary"=>"Content Page", "description"=>"Returns a content page by parameter.", "operationId"=>"returnContentPage", "x-api-path-slug"=>"contentpagesparameter-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content"]}}, "/procurementclauses"=>{"get"=>{"summary"=>"Federal Acquisition Regulation (FAR) Clause", "description"=>"Returns Federal Acquisition Regulation (FAR) clause numbers and environmental programs for all NAICS and PSC codes with federal sustainable procurement requirements in GPC.", "operationId"=>"returnFederalAcquisitionRegulationClause", "x-api-path-slug"=>"procurementclauses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regulation Clause"]}}, "/procurementclauses/naics/{parameter}"=>{"get"=>{"summary"=>"Federal Acquisition Regulation (FAR) Clause", "description"=>"Returns any FAR clause number(s) and sample procurement language associated with the given NAICS parameter.", "operationId"=>"returnFederalAcquisitionRegulationClause", "x-api-path-slug"=>"procurementclausesnaicsparameter-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regulation Clause"]}}, "/procurementclauses/psc/{parameter}"=>{"get"=>{"summary"=>"Procurement Clause", "description"=>"Returns any FAR clause number(s) and sample procurement language associated with the given PSC parameter.", "operationId"=>"returnFederalAcquisitionRegulationClause", "x-api-path-slug"=>"procurementclausespscparameter-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Procurement Clause"]}}, "/procurementclauses/allcontractlanguage"=>{"get"=>{"summary"=>"Contract Language", "description"=>"Returns all sample contract language for environmental programs", "operationId"=>"contractLanguage", "x-api-path-slug"=>"procurementclausesallcontractlanguage-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contract Language"]}}, "/materials"=>{"get"=>{"summary"=>"Return Materials", "description"=>"Returns all materials.", "operationId"=>"returnMaterials", "x-api-path-slug"=>"materials-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Materials"]}}, "/materials/{parameter}"=>{"get"=>{"summary"=>"Return Material", "description"=>"Returns a material by parameter.", "operationId"=>"returnMaterial", "x-api-path-slug"=>"materialsparameter-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Materials"]}}, "/materials/{parameter}/alternatives"=>{"get"=>{"summary"=>"Alternative Materials", "description"=>"Returns alternatives for the material selected by parameter.", "operationId"=>"getAlternativeMaterials", "x-api-path-slug"=>"materialsparameteralternatives-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alternative Materials"]}}, "/materials/{parameter}/comparisons"=>{"get"=>{"summary"=>"Compairson Materials", "description"=>"Returns comparisons for the material selected by parameter.", "operationId"=>"returnCompairsonMaterials", "x-api-path-slug"=>"materialsparametercomparisons-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comparison Materials"]}}, "/products"=>{"get"=>{"summary"=>"Products", "description"=>"Returns all products.", "operationId"=>"getProducts", "x-api-path-slug"=>"products-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/products/{parameter}/details"=>{"get"=>{"summary"=>"Product Details", "description"=>"Returns details for the product selected by parameter.", "operationId"=>"getProductDetails", "x-api-path-slug"=>"productsparameterdetails-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/services"=>{"get"=>{"summary"=>"Services", "description"=>"Returns all services", "operationId"=>"getServices", "x-api-path-slug"=>"services-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/services/{parameter}"=>{"get"=>{"summary"=>"Services", "description"=>"Returns a service by parameter.", "operationId"=>"getService", "x-api-path-slug"=>"servicesparameter-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/services/{parameter}/related-products"=>{"get"=>{"summary"=>"Related Products", "description"=>"Returns products related to a service by parameter.", "operationId"=>"getRelatedProducts", "x-api-path-slug"=>"servicesparameterrelatedproducts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/tags"=>{"get"=>{"summary"=>"Tags", "description"=>"Returns all search tags.", "operationId"=>"getTags", "x-api-path-slug"=>"tags-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/tags/{parameter}"=>{"get"=>{"summary"=>"Tag", "description"=>"Returns a tag by parameter.", "operationId"=>"getTag", "x-api-path-slug"=>"tagsparameter-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/workspaces"=>{"get"=>{"summary"=>"Workspaces", "description"=>"Returns all workspaces.", "operationId"=>"getWorkspaces", "x-api-path-slug"=>"workspaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspaces"]}}, "/workspaces/{parameter}"=>{"get"=>{"summary"=>"Workspace", "description"=>"Returns a workspace by parameter.", "operationId"=>"getWorkspace", "x-api-path-slug"=>"workspacesparameter-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspaces"]}}, "/workspaces/{parameter}/material-groups"=>{"get"=>{"summary"=>"Workspaces", "description"=>"Returns material groups for the workspace selected by parameter.", "operationId"=>"getWorkspaceMaterialGroups", "x-api-path-slug"=>"workspacesparametermaterialgroups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspaces"]}}, "/workspaces/{parameter}/materials"=>{"get"=>{"summary"=>"Workspace Materials", "description"=>"Returns materials for the workspace selected by parameter.", "operationId"=>"getWorkspaceMaterials", "x-api-path-slug"=>"workspacesparametermaterials-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Workspaces"]}}}}, "apis"=>{"name"=>"Sustainable Facilities Tool API", "x-slug"=>"sustainable-facilities-tool-api", "description"=>"Our core API allows developers to interact with the Sustainable Facilities Tool programmatically. Its designed for public use and to be easily integrated into other applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/sustainable-facilities-mobile_504b7.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"Environment,Federal Government GSA,General Data,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"sustainable-facilities-tool-api/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Sustainable Facilities Tool API", "x-api-slug"=>"sustainable-facilities-tool-api", "description"=>"Our core API allows developers to interact with the Sustainable Facilities Tool programmatically. Its designed for public use and to be easily integrated into other applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/sustainable-facilities-mobile_504b7.png", "humanURL"=>"https://sftool.gov/", "baseURL"=>"https://api.data.gov//sftool/v1/", "tags"=>"Environment,Federal Government GSA,General Data,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/sustainable-facilities-tool-api/workspacesparametermaterials-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/sustainable-facilities-tool-api/sustainable-facilities-tool-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"https://sftool.gov/developers"}, {"type"=>"x-terms-of-service", "url"=>"https://sftool.gov/developer/terms-of-use"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/sftool"}, {"type"=>"x-website", "url"=>"https://sftool.gov/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-translate{"google-translate-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Translate", "x-complete"=>1, "info"=>{"title"=>"Translate", "description"=>"translates-text-from-one-language-to-another-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v2"}, "host"=>"www.googleapis.com", "basePath"=>"/language/translate", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v2"=>{"get"=>{"summary"=>"Translate Text", "description"=>"Returns text translations from one language to another.", "operationId"=>"language.translations.list", "x-api-path-slug"=>"v2-get", "parameters"=>[{"in"=>"query", "name"=>"cid", "description"=>"The customization id for translate"}, {"in"=>"query", "name"=>"format", "description"=>"The format of the text"}, {"in"=>"query", "name"=>"q", "description"=>"The text to translate"}, {"in"=>"query", "name"=>"source", "description"=>"The source language of the text"}, {"in"=>"query", "name"=>"target", "description"=>"The target language into which the text should be translated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Translate"]}}, "/v2/detect"=>{"get"=>{"summary"=>"Detect Language", "description"=>"Detect the language of text.", "operationId"=>"language.detections.list", "x-api-path-slug"=>"v2detect-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The text to detect"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Language"]}}, "/v2/languages"=>{"get"=>{"summary"=>"Get Languages", "description"=>"List the source/target languages supported by the API", "operationId"=>"language.languages.list", "x-api-path-slug"=>"v2languages-get", "parameters"=>[{"in"=>"query", "name"=>"target", "description"=>"the language and collation in which the localized results should be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Language"]}}}}, "apis"=>{"name"=>"Google Translate", "x-slug"=>"google-translate", "description"=>"Cloud Translation API provides a simple programmatic interface for translating an arbitrary string into any supported language. Translation API is highly responsive, so websites and applications can integrate with Translation API for fast, dynamic translation of source text from the source language to a target language (e.g., French to English). Language detection is also available In cases where the source language is unknown. The underlying technology pushes the boundary of Machine Translation and is updated constantly to seamlessly improve translations and introduce new languages and language pairs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-translate-hello-lead-2x.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Languages,Profiles,Relative Data,Service API,Stack,Stack Network,Translations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-translate/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Translate API", "x-api-slug"=>"google-translate-api", "description"=>"Cloud Translation API provides a simple programmatic interface for translating an arbitrary string into any supported language. Translation API is highly responsive, so websites and applications can integrate with Translation API for fast, dynamic translation of source text from the source language to a target language (e.g., French to English). Language detection is also available In cases where the source language is unknown. The underlying technology pushes the boundary of Machine Translation and is updated constantly to seamlessly improve translations and introduce new languages and language pairs.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-translate-hello-lead-2x.png", "humanURL"=>"https://translate.google.com/", "baseURL"=>"://www.googleapis.com//language/translate", "tags"=>"API Provider,API Service Provider,Google APIs,Languages,Profiles,Relative Data,Service API,Stack,Stack Network,Translations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/google-translate/v2languages-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/google-translate/google-translate-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-attribution", "url"=>"https://cloud.google.com/translate/attribution"}, {"type"=>"x-change-log", "url"=>"https://cloud.google.com/translate/release-notes"}, {"type"=>"x-code", "url"=>"https://cloud.google.com/translate/docs/reference/libraries"}, {"type"=>"x-developer", "url"=>"https://cloud.google.com/translate/"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/translate/docs/"}, {"type"=>"x-faq", "url"=>"https://cloud.google.com/translate/faq"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/translate/docs/getting-started"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/translate/pricing"}, {"type"=>"x-rate-limits", "url"=>"https://cloud.google.com/translate/limits"}, {"type"=>"x-support", "url"=>"https://cloud.google.com/translate/support"}, {"type"=>"x-terms-of-service", "url"=>"https://cloud.google.com/terms/"}, {"type"=>"x-website", "url"=>"https://translate.google.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
entertainment-express{"apis"=>{"name"=>"Entertainment Express", "x-slug"=>"entertainment-express", "description"=>"Internet Video Archive (IVA) is a leading entertainment data company providing metadata, images and trailers/clips, for movie and TV content. With the launch of its award-winning Entertainment Express APIs, clients can easily access everything they need to create engaging content discovery experiences. By using Entertainment Express, clients can also connect to other services like movie showtimes and ticketing, content recommendations, content availability and TV channel line-ups. With over a million titles, episodes and over 150,000 videos available, IVA makes it easy for developers to integrate all the services they need at a very affordable price.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/IVA-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Celebrities,General Data,Movies,Televisions,Videos", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"entertainment-express/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Entertainment Express", "x-api-slug"=>"entertainment-express", "description"=>"Internet Video Archive (IVA) is a leading entertainment data company providing metadata, images and trailers/clips, for movie and TV content. With the launch of its award-winning Entertainment Express APIs, clients can easily access everything they need to create engaging content discovery experiences. By using Entertainment Express, clients can also connect to other services like movie showtimes and ticketing, content recommendations, content availability and TV channel line-ups. With over a million titles, episodes and over 150,000 videos available, IVA makes it easy for developers to integrate all the services they need at a very affordable price.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/IVA-logo.png", "humanURL"=>"https://www.internetvideoarchive.com/", "baseURL"=>"https://ee.iva-api.com//", "tags"=>"Celebrities,General Data,Movies,Televisions,Videos", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/entertainment-express/entertainment-express-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://www.internetvideoarchive.com/blog/"}, {"type"=>"x-developer", "url"=>"https://developer.iva-api.com/"}, {"type"=>"x-pricing", "url"=>"https://www.internetvideoarchive.com/pricing/"}, {"type"=>"x-website", "url"=>"https://www.internetvideoarchive.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "entertainment-express-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Entertainment Express", "x-complete"=>1, "info"=>{"title"=>"Entertainment Express", "description"=>"your-gateway-to-building-incredible-movie-tv-and-game-content-discovery-experiences-", "version"=>"2.0"}, "host"=>"ee.iva-api.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/Analytics/City/"=>{"get"=>{"summary"=>"Get Viewers by City.", "description"=>"No required parameters, DateValue defaults to Today..", "operationId"=>"GetAnalyticsViewersByCity", "x-api-path-slug"=>"analyticscity-get", "parameters"=>[{"in"=>"query", "name"=>"DateValue", "description"=>"Days spanned by report"}, {"in"=>"query", "name"=>"End", "description"=>"Report end date"}, {"in"=>"query", "name"=>"Limit", "description"=>"Number of records returned from top of response"}, {"in"=>"query", "name"=>"ReportTag", "description"=>"Report Tag filter"}, {"in"=>"query", "name"=>"Start", "description"=>"Report start date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics", "City"]}}, "/Analytics/Country/"=>{"get"=>{"summary"=>"Get Viewers by Country.", "description"=>"No required parameters, DateValue defaults to Today.", "operationId"=>"GetAnalyticsViewersByCountry", "x-api-path-slug"=>"analyticscountry-get", "parameters"=>[{"in"=>"query", "name"=>"DateValue", "description"=>"Days spanned by report"}, {"in"=>"query", "name"=>"End", "description"=>"Report end date"}, {"in"=>"query", "name"=>"Limit", "description"=>"Number of records returned from top of response"}, {"in"=>"query", "name"=>"ReportTag", "description"=>"Report Tag filter"}, {"in"=>"query", "name"=>"Start", "description"=>"Report start date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics", "Country"]}}, "/Analytics/EngagementActions/"=>{"get"=>{"summary"=>"GetAnalyticEngagementActions", "description"=>"No required parameters, DateValue defaults to Today.", "operationId"=>"GetAnalyticEngagementActions", "x-api-path-slug"=>"analyticsengagementactions-get", "parameters"=>[{"in"=>"query", "name"=>"DateValue", "description"=>"Days spanned by report"}, {"in"=>"query", "name"=>"End", "description"=>"Report end date"}, {"in"=>"query", "name"=>"Limit", "description"=>"Number of records returned from top of response"}, {"in"=>"query", "name"=>"ReportTag", "description"=>"Report Tag filter"}, {"in"=>"query", "name"=>"Start", "description"=>"Report start date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics", "EngagementActions"]}}, "/Analytics/EngagementTimes/"=>{"get"=>{"summary"=>"Get View count by Frequency.", "description"=>"No required parameters, DateValue defaults to Today.", "operationId"=>"GetAnalyticsEngagementTimes", "x-api-path-slug"=>"analyticsengagementtimes-get", "parameters"=>[{"in"=>"query", "name"=>"DateValue", "description"=>"Days spanned by report"}, {"in"=>"query", "name"=>"End", "description"=>"Report end date"}, {"in"=>"query", "name"=>"Limit", "description"=>"Number of records returned from top of response"}, {"in"=>"query", "name"=>"ReportTag", "description"=>"Report Tag filter"}, {"in"=>"query", "name"=>"Start", "description"=>"Report start date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics", "EngagementTimes"]}}, "/Analytics/GBUsage/"=>{"get"=>{"summary"=>"Get GBUsage by Customer ID.", "description"=>"Requires a valid Customer ID.", "operationId"=>"GetAnalyticsGBUsage", "x-api-path-slug"=>"analyticsgbusage-get", "parameters"=>[{"in"=>"query", "name"=>"Month", "description"=>"Report month"}, {"in"=>"query", "name"=>"ReportTag", "description"=>"Report Tag filter"}, {"in"=>"query", "name"=>"Year", "description"=>"Report year"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics", "GBUsage"]}}, "/Analytics/MostActive/"=>{"get"=>{"summary"=>"Get Most Active Visitors by IP.", "description"=>"No required parameters, DateValue defaults to Today.", "operationId"=>"GetAnalyticsMostActive", "x-api-path-slug"=>"analyticsmostactive-get", "parameters"=>[{"in"=>"query", "name"=>"DateValue", "description"=>"Days spanned by report"}, {"in"=>"query", "name"=>"Limit", "description"=>"Number of records returned from top of response"}, {"in"=>"query", "name"=>"ReportTag", "description"=>"Report Tag filter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics", "MostActive"]}}, "/Analytics/PlatformHardware/"=>{"get"=>{"summary"=>"Get Viewers by Platform Hardware.", "description"=>"No required parameters, DateValue defaults to Today.", "operationId"=>"GetAnalyticsViewersByPlatformHardware", "x-api-path-slug"=>"analyticsplatformhardware-get", "parameters"=>[{"in"=>"query", "name"=>"DateValue", "description"=>"Days spanned by report"}, {"in"=>"query", "name"=>"End", "description"=>"Report end date"}, {"in"=>"query", "name"=>"Limit", "description"=>"Number of records returned from top of response"}, {"in"=>"query", "name"=>"ReportTag", "description"=>"Report Tag filter"}, {"in"=>"query", "name"=>"Start", "description"=>"Report start date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics", "PlatformHardware"]}}, "/Analytics/PlatformOS/"=>{"get"=>{"summary"=>"Get Viewers by Platform OS.", "description"=>"No required parameters, DateValue defaults to Today.", "operationId"=>"GetAnalyticsViewersByPlatformOS", "x-api-path-slug"=>"analyticsplatformos-get", "parameters"=>[{"in"=>"query", "name"=>"DateValue", "description"=>"Days spanned by report"}, {"in"=>"query", "name"=>"End", "description"=>"Report end date"}, {"in"=>"query", "name"=>"Limit", "description"=>"Number of records returned from top of response"}, {"in"=>"query", "name"=>"ReportTag", "description"=>"Report Tag filter"}, {"in"=>"query", "name"=>"Start", "description"=>"Report start date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics", "PlatformOS"]}}, "/Analytics/RecentVisitors/"=>{"get"=>{"summary"=>"Get Most Recent Visitors by Time.", "description"=>"No required parameters, DateValue defaults to Today.", "operationId"=>"GetAnalyticsRecentVisitors", "x-api-path-slug"=>"analyticsrecentvisitors-get", "parameters"=>[{"in"=>"query", "name"=>"Limit", "description"=>"Number of records returned from top of response"}, {"in"=>"query", "name"=>"ReportTag", "description"=>"Report Tag filter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics", "RecentVisitors"]}}, "/Analytics/Summary/"=>{"get"=>{"summary"=>"Get Summary by Customer ID.", "description"=>"Requires a valid Customer ID.", "operationId"=>"GetAnalyticsSummary", "x-api-path-slug"=>"analyticssummary-get", "parameters"=>[{"in"=>"query", "name"=>"DateValue", "description"=>"Days spanned by report"}, {"in"=>"query", "name"=>"ReportTag", "description"=>"Report Tag filter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics", "Summary"]}}, "/Analytics/TitleReport/"=>{"get"=>{"summary"=>"Get Title Report by PublishedID.", "description"=>"Requires a valid published ID.", "operationId"=>"GetAnalyticsTitleReport", "x-api-path-slug"=>"analyticstitlereport-get", "parameters"=>[{"in"=>"query", "name"=>"End", "description"=>"Report end date"}, {"in"=>"query", "name"=>"PublishedId", "description"=>"Title published ID"}, {"in"=>"query", "name"=>"Start", "description"=>"Report start date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics", "TitleReport"]}}, "/Analytics/VideoLog/"=>{"get"=>{"summary"=>"Get Views by Video.", "description"=>"No required parameters, DateValue defaults to Today.", "operationId"=>"GetAnalyticsViewsByVideoLog", "x-api-path-slug"=>"analyticsvideolog-get", "parameters"=>[{"in"=>"query", "name"=>"DateValue", "description"=>"Days spanned by report"}, {"in"=>"query", "name"=>"End", "description"=>"Report end date"}, {"in"=>"query", "name"=>"Limit", "description"=>"Number of records returned from top of response"}, {"in"=>"query", "name"=>"ReportTag", "description"=>"Report Tag filter"}, {"in"=>"query", "name"=>"Start", "description"=>"Report start date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics", "VideoLog"]}}, "/Analytics/Viewers/"=>{"get"=>{"summary"=>"Get viewers by Day.", "description"=>"Optional DateValue for length of report.", "operationId"=>"GetAnalyticsViewers", "x-api-path-slug"=>"analyticsviewers-get", "parameters"=>[{"in"=>"query", "name"=>"DateValue", "description"=>"Days spanned by report"}, {"in"=>"query", "name"=>"ReportTag", "description"=>"Report Tag filter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics", "Viewers"]}}, "/Analytics/Views/"=>{"get"=>{"summary"=>"Get views by Day.", "description"=>"Optional DateValue for length of report.", "operationId"=>"GetAnalyticsViews", "x-api-path-slug"=>"analyticsviews-get", "parameters"=>[{"in"=>"query", "name"=>"DateValue", "description"=>"Days spanned by report"}, {"in"=>"query", "name"=>"ReportTag", "description"=>"Report Tag filter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics", "Views"]}}, "/Analytics/WebBrowsers/"=>{"get"=>{"summary"=>"Get Viewers by Web Browser.", "description"=>"No required parameters, DateValue defaults to Today.", "operationId"=>"GetAnalyticsViewersByWebBrowsers", "x-api-path-slug"=>"analyticswebbrowsers-get", "parameters"=>[{"in"=>"query", "name"=>"DateValue", "description"=>"Days spanned by report"}, {"in"=>"query", "name"=>"End", "description"=>"Report end date"}, {"in"=>"query", "name"=>"Limit", "description"=>"Number of records returned from top of response"}, {"in"=>"query", "name"=>"ReportTag", "description"=>"Report Tag filter"}, {"in"=>"query", "name"=>"Start", "description"=>"Report start date"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analytics", "WebBrowsers"]}}, "/Changes/Episodes/History/"=>{"get"=>{"summary"=>"Returns list of unique EpisodeId changes greater than or equal to date (UTC)", "description"=>"For each updated episode ID, pull the full episode data for that ID and update.", "operationId"=>"GetEpisodeChangeHistory", "x-api-path-slug"=>"changesepisodeshistory-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"Starting date"}, {"in"=>"query", "name"=>"Skip", "description"=>"Offset for paging"}, {"in"=>"query", "name"=>"Take", "description"=>"Maximum number of rows returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Changes", "Episodes", "History"]}}, "/Changes/Episodes/HistoryWithEntity/"=>{"get"=>{"summary"=>"Returns list of unique EpisodeId and Entity changes greater than or equal to date (UTC).", "description"=>"Lists each episode ID that has changed as well as the entity in the object that changed.", "operationId"=>"GetEpisodeChangeHistoryWithEntity", "x-api-path-slug"=>"changesepisodeshistorywithentity-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"Starting date"}, {"in"=>"query", "name"=>"Skip", "description"=>"Offset for paging"}, {"in"=>"query", "name"=>"Take", "description"=>"Maximum number of rows returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Changes", "Episodes", "HistoryWithEntity"]}}, "/Changes/Movies/History/"=>{"get"=>{"summary"=>"Returns list of unique MovieId changes greater than or equal to date (UTC).", "description"=>"Use to get the ID's of the movies that have been added or changed and use /Movies/{ID} to get back the object with the updated data and replace in your database.", "operationId"=>"GetMovieChangeHistory", "x-api-path-slug"=>"changesmovieshistory-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"Starting date"}, {"in"=>"query", "name"=>"Skip", "description"=>"Offset for paging"}, {"in"=>"query", "name"=>"Take", "description"=>"Maximum number of rows returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Changes", "Movies", "History"]}}, "/Changes/Movies/HistoryWithEntity/"=>{"get"=>{"summary"=>"Returns list of unique MovieId and Entity changes greater than or equal to date (UTC).", "description"=>"Same as /Changes/Movies/History but with the specific entities that have changed inside the MovieResponse.", "operationId"=>"GetMovieChangeHistoryWithEntity", "x-api-path-slug"=>"changesmovieshistorywithentity-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"Starting date"}, {"in"=>"query", "name"=>"Skip", "description"=>"Offset for paging"}, {"in"=>"query", "name"=>"Take", "description"=>"Maximum number of rows returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Changes", "Movies", "HistoryWithEntity"]}}, "/Changes/People/History/"=>{"get"=>{"summary"=>"Returns list of unique PersonId changes greater than or equal to date (UTC).", "description"=>"Requires a valid Date.", "operationId"=>"GetPersonChangeHistory", "x-api-path-slug"=>"changespeoplehistory-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"Starting date"}, {"in"=>"query", "name"=>"Skip", "description"=>"Offset for paging"}, {"in"=>"query", "name"=>"Take", "description"=>"Maximum number of rows returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Changes", "People", "History"]}}, "/Changes/People/HistoryWithEntity/"=>{"get"=>{"summary"=>"Returns list of unique PersonId and Entity changes greater than or equal to date (UTC).", "description"=>"Requires a valid Date.", "operationId"=>"GetPersonChangeHistoryWithEntity", "x-api-path-slug"=>"changespeoplehistorywithentity-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"Starting date"}, {"in"=>"query", "name"=>"Skip", "description"=>"Offset for paging"}, {"in"=>"query", "name"=>"Take", "description"=>"Maximum number of rows returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Changes", "People", "HistoryWithEntity"]}}, "/Changes/Seasons/History/"=>{"get"=>{"summary"=>"Returns list of unique SeasonId changes greater than or equal to date (UTC).", "description"=>"Use if you want to check for specific updates to season records.", "operationId"=>"GetSeasonChangeHistory", "x-api-path-slug"=>"changesseasonshistory-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"Starting date"}, {"in"=>"query", "name"=>"Skip", "description"=>"Offset for paging"}, {"in"=>"query", "name"=>"Take", "description"=>"Maximum number of rows returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Changes", "Seasons", "History"]}}, "/Changes/Seasons/HistoryWithEntity/"=>{"get"=>{"summary"=>"Returns list of unique SeasonId and Entity changes greater than or equal to date (UTC).", "description"=>"Returns list of new or changed SeasonIds with the entity that has changed.", "operationId"=>"GetSeasonChangeHistoryWithEntity", "x-api-path-slug"=>"changesseasonshistorywithentity-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"Starting date"}, {"in"=>"query", "name"=>"Skip", "description"=>"Offset for paging"}, {"in"=>"query", "name"=>"Take", "description"=>"Maximum number of rows returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Changes", "Seasons", "HistoryWithEntity"]}}, "/Changes/Shows/History/"=>{"get"=>{"summary"=>"Returns list of unique ShowId changes greater than or equal to date (UTC).", "description"=>"All new and updated shows from requested date and time. When a record gets updated, use the ID to get the full show object and replace the data in your cache.", "operationId"=>"GetShowChangeHistory", "x-api-path-slug"=>"changesshowshistory-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"Starting date"}, {"in"=>"query", "name"=>"Skip", "description"=>"Offset for paging"}, {"in"=>"query", "name"=>"Take", "description"=>"Maximum number of rows returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Changes", "Shows", "History"]}}, "/Changes/Shows/HistoryWithEntity/"=>{"get"=>{"summary"=>"Returns list of unique ShowId and Entity changes greater than or equal to date (UTC).", "description"=>"Returns a list of ShowId and entity of any show that has been updated.", "operationId"=>"GetShowChangeHistoryWithEntity", "x-api-path-slug"=>"changesshowshistorywithentity-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"Starting date"}, {"in"=>"query", "name"=>"Skip", "description"=>"Offset for paging"}, {"in"=>"query", "name"=>"Take", "description"=>"Maximum number of rows returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Changes", "Shows", "HistoryWithEntity"]}}, "/Charts/Movies/Boxoffice"=>{"get"=>{"summary"=>"Returns list of movies based on the weekend box office revenue.", "description"=>"Returns top 10 box office movies.", "operationId"=>"GetChartMoviesBoxoffice", "x-api-path-slug"=>"chartsmoviesboxoffice-get", "parameters"=>[{"in"=>"query", "name"=>"Skip", "description"=>"Determines where to start page"}, {"in"=>"query", "name"=>"Take", "description"=>"Determines the page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Charts", "Movies", "Boxoffice"]}}, "/Charts/Movies/MostAnticipated"=>{"get"=>{"summary"=>"Returns list of Most Anticipated movies based on IVA data.", "description"=>"Requires Skip and Take. Maximum page size is 100.", "operationId"=>"GetChartMoviesMostAnticipated", "x-api-path-slug"=>"chartsmoviesmostanticipated-get", "parameters"=>[{"in"=>"query", "name"=>"Skip", "description"=>"Determines where to start page"}, {"in"=>"query", "name"=>"Take", "description"=>"Determines the page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Charts", "Movies", "MostAnticipated"]}}, "/Charts/Movies/Popular"=>{"get"=>{"summary"=>"Returns list of popular movies.", "description"=>"Requires Skip and Take. Maximum page size is 100.", "operationId"=>"GetChartMoviesPopular", "x-api-path-slug"=>"chartsmoviespopular-get", "parameters"=>[{"in"=>"query", "name"=>"Skip", "description"=>"Determines where to start page"}, {"in"=>"query", "name"=>"Take", "description"=>"Determines the page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Charts", "Movies", "Popular"]}}, "/Charts/People/Popular"=>{"get"=>{"summary"=>"Returns list of popular celebrities based on IVA data.", "description"=>"Requires Skip and Take. Maximum page size is 100.", "operationId"=>"GetChartPeoplePopular", "x-api-path-slug"=>"chartspeoplepopular-get", "parameters"=>[{"in"=>"query", "name"=>"Skip", "description"=>"Determines where to start page"}, {"in"=>"query", "name"=>"Take", "description"=>"Determines the page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Charts", "People", "Popular"]}}, "/Charts/Shows/Popular"=>{"get"=>{"summary"=>"Returns a list of shows based on popularity.", "description"=>"Requires Skip and Take. Maximum page size is 100.", "operationId"=>"GetChartShowsPopular", "x-api-path-slug"=>"chartsshowspopular-get", "parameters"=>[{"in"=>"query", "name"=>"Skip", "description"=>"Skips records using for paging results"}, {"in"=>"query", "name"=>"Take", "description"=>"Limits the total items returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Charts", "Shows", "Popular"]}}, "/Common/Companies/"=>{"get"=>{"summary"=>"Paged list of companies.", "description"=>"Companies are listed in a movie, show, or game response as those whom are involved with the program. EX: Universal Pictures.", "operationId"=>"GetCompanies", "x-api-path-slug"=>"commoncompanies-get", "parameters"=>[{"in"=>"query", "name"=>"Skip", "description"=>"Offset for paging"}, {"in"=>"query", "name"=>"Take", "description"=>"Maximum number of rows returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Common", "Companies"]}}, "/Common/Countries/"=>{"get"=>{"summary"=>"Returns a list of countries.", "description"=>"List of Countries, ISO codes and Country IDs used throughout the API.", "operationId"=>"GetCountries", "x-api-path-slug"=>"commoncountries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Common", "Countries"]}}, "/Common/ImageTypes/"=>{"get"=>{"summary"=>"List of image types contained in the database.", "description"=>"A list of image types available in the IVA database. **EX: Poster**", "operationId"=>"GetImageTypes", "x-api-path-slug"=>"commonimagetypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Common", "ImageTypes"]}}, "/Common/Languages/"=>{"get"=>{"summary"=>"Gets all languages.", "description"=>"Returns a list of languages used in the API as well as the ISO code and language ID.", "operationId"=>"GetLanguages", "x-api-path-slug"=>"commonlanguages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Common", "Languages"]}}, "/Common/Tags/"=>{"get"=>{"summary"=>"Gets all tags.", "description"=>"Paged list of all tags used in the API.", "operationId"=>"GetTags", "x-api-path-slug"=>"commontags-get", "parameters"=>[{"in"=>"query", "name"=>"Skip", "description"=>"Offset for paging"}, {"in"=>"query", "name"=>"Take", "description"=>"Maximum number of rows returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Common", "Tags"]}}, "/Common/VideoTypes/"=>{"get"=>{"summary"=>"Gets all VideoTypes.", "description"=>"Returns a list of the types of videos that can be associated to a title.", "operationId"=>"GetVideoTypes", "x-api-path-slug"=>"commonvideotypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Common", "VideoTypes"]}}, "/ExternalIds/GracenoteMovie"=>{"get"=>{"summary"=>"Returns list of all MovieId, Gracenote Id pairs.", "description"=>"Not accessible with a Demo account. **Special permissions needed** for access to this operation. Contact [Sales](mailto:sales@internetvideoarchive.com).", "operationId"=>"GetGracenoteMovieIds", "x-api-path-slug"=>"externalidsgracenotemovie-get", "parameters"=>[{"in"=>"query", "name"=>"Skip", "description"=>"Determines where to start page"}, {"in"=>"query", "name"=>"Take", "description"=>"Determines the page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ExternalIds", "GracenoteMovie"]}}, "/ExternalIds/GracenoteShow"=>{"get"=>{"summary"=>"Returns list of all ShowId, Gracenote Id pairs.", "description"=>"Not accessible with a Demo account. **Special permissions needed** for access to this operation. Contact [Sales](mailto:sales@internetvideoarchive.com).", "operationId"=>"GetGracenoteShowIds", "x-api-path-slug"=>"externalidsgracenoteshow-get", "parameters"=>[{"in"=>"query", "name"=>"Skip", "description"=>"Determines where to start page"}, {"in"=>"query", "name"=>"Take", "description"=>"Determines the page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ExternalIds", "GracenoteShow"]}}, "/ExternalIds/ImdbMovie"=>{"get"=>{"summary"=>"Returns list of all MovieId, IMDB Id pairs.", "description"=>"Ingest this ID map to create connections between the objects in your existing database with an IMDB ID to the IVA Movie objects.", "operationId"=>"GetImdbMovieIds", "x-api-path-slug"=>"externalidsimdbmovie-get", "parameters"=>[{"in"=>"query", "name"=>"Skip", "description"=>"Determines where to start page"}, {"in"=>"query", "name"=>"Take", "description"=>"Determines the page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ExternalIds", "ImdbMovie"]}}, "/ExternalIds/ImdbShow"=>{"get"=>{"summary"=>"Returns list of all MovieId, Tmdb Id pairs.", "description"=>"ngest this ID map to create connections between the objects in your existing database with an IMDB ID to the IVA Show objects.", "operationId"=>"GetImdbShowIds", "x-api-path-slug"=>"externalidsimdbshow-get", "parameters"=>[{"in"=>"query", "name"=>"Skip", "description"=>"Determines where to start page"}, {"in"=>"query", "name"=>"Take", "description"=>"Determines the page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ExternalIds", "ImdbShow"]}}, "/ExternalIds/RoviMovie"=>{"get"=>{"summary"=>"Returns list of all MovieId, Tivo Id pairs.", "description"=>"Not accessible with a Demo account. **Special permissions needed** for access to this operation. Contact [Sales](mailto:sales@internetvideoarchive.com).", "operationId"=>"GetTivoMovieIds", "x-api-path-slug"=>"externalidsrovimovie-get", "parameters"=>[{"in"=>"query", "name"=>"Skip", "description"=>"Determines where to start page"}, {"in"=>"query", "name"=>"Take", "description"=>"Determines the page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ExternalIds", "RoviMovie"]}}, "/ExternalIds/RoviShow"=>{"get"=>{"summary"=>"Returns list of all ShowId, Tivo Id pairs.", "description"=>"Not accessible with a Demo account. **Special permissions needed** for access to this operation. Contact [Sales](mailto:sales@internetvideoarchive.com).", "operationId"=>"GetTivoShowIds", "x-api-path-slug"=>"externalidsrovishow-get", "parameters"=>[{"in"=>"query", "name"=>"Skip", "description"=>"Determines where to start page"}, {"in"=>"query", "name"=>"Take", "description"=>"Determines the page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ExternalIds", "RoviShow"]}}, "/ExternalIds/TmdbMovie"=>{"get"=>{"summary"=>"Returns list of all MovieId, Tmdb Id pairs.", "description"=>"Use to link a TMDB ID to an IVA Movie ID.", "operationId"=>"GetTmdbMovieIds", "x-api-path-slug"=>"externalidstmdbmovie-get", "parameters"=>[{"in"=>"query", "name"=>"Skip", "description"=>"Determines where to start page"}, {"in"=>"query", "name"=>"Take", "description"=>"Determines the page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ExternalIds", "TmdbMovie"]}}, "/ExternalIds/TmdbShow"=>{"get"=>{"summary"=>"Returns list of all ShowId, TMDB Id pairs.", "description"=>"Use to link a TMDB ID to an IVA Show ID.", "operationId"=>"GetTmdbShowIds", "x-api-path-slug"=>"externalidstmdbshow-get", "parameters"=>[{"in"=>"query", "name"=>"Skip", "description"=>"Determines where to start page"}, {"in"=>"query", "name"=>"Take", "description"=>"Determines the page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ExternalIds", "TmdbShow"]}}, "/ExternalIds/Webedia"=>{"get"=>{"summary"=>"Returns list of all MovieId, Webedia Id pairs.", "description"=>"Not accessible with a Demo account. **Special permissions needed** for access to this operation. Contact [Sales](mailto:sales@internetvideoarchive.com).", "operationId"=>"GetWebediaMovieIds", "x-api-path-slug"=>"externalidswebedia-get", "parameters"=>[{"in"=>"query", "name"=>"Skip", "description"=>"Determines where to start page"}, {"in"=>"query", "name"=>"Take", "description"=>"Determines the page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ExternalIds", "Webedia"]}}, "/Find/Movie/"=>{"get"=>{"summary"=>"Find a movie using third party ID.", "description"=>"Use FindMovie with a third party ID like IMDB, TMDB, Gracenote, Tivo, etc. to find the corresponding movie in the IVA database. For a full list of supported ID types see /Movies/AlternateIdTypes. \n\n\n\n`Recommendation: Use with small data sets or for a proof of concept. `", "operationId"=>"FindMovie", "x-api-path-slug"=>"findmovie-get", "parameters"=>[{"in"=>"query", "name"=>"Id", "description"=>"Required third party ID of Movie"}, {"in"=>"query", "name"=>"IdType", "description"=>"Required third party ID type of MovieAlternateId"}, {"in"=>"query", "name"=>"Includes", "description"=>"List of additional objects to include in the movie object"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Movie"]}}, "/Find/Show/"=>{"get"=>{"summary"=>"Find a TV show using a third party ID.", "description"=>"Use FindShow with a third party ID like IMDB, TMDB, Gracenote, Tivo, etc. to find the corresponding TV show in the IVA database. For a full list of supported ID types see /Shows/AlternateIdTypes. `Recommendation: Use with small data sets or for a proof of concept. `", "operationId"=>"FindShow", "x-api-path-slug"=>"findshow-get", "parameters"=>[{"in"=>"query", "name"=>"Id", "description"=>"Required third party ID of Show"}, {"in"=>"query", "name"=>"IdType", "description"=>"Required third party ID type of ShowAlternateId"}, {"in"=>"query", "name"=>"Includes", "description"=>"List of additional objects to include in the show response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Find", "Show"]}}, "/GoWatchIt/Episodes/{Id}/Availabilities"=>{"get"=>{"summary"=>"Get GoWatchIt Episode Availability.", "description"=>"Returns GoWatchit episode availability by Entertainment Episode ID. Special permission is required to access this endpoint.", "operationId"=>"GetGoWatchItEpisodeAvailabilities", "x-api-path-slug"=>"gowatchitepisodesidavailabilities-get", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"Required GoWatchIt API key"}, {"in"=>"path", "name"=>"Id", "description"=>"Required ID of Entertainment Episode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GoWatchIt", "Episodes", "Id", "Availabilities"]}}, "/GoWatchIt/Movies/{Id}/Availabilities"=>{"get"=>{"summary"=>"Get GoWatchIt Movie Availability.", "description"=>"Returns GoWatchIt movie availability by Entertainment Movie ID. Special permission is required to access this endpoint. Contact [Sales](mailto:Sales@InternetVideoArchive.com) for more information.", "operationId"=>"GetGoWatchItMovieAvailabilities", "x-api-path-slug"=>"gowatchitmoviesidavailabilities-get", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"Required GoWatchIt API key"}, {"in"=>"path", "name"=>"Id", "description"=>"Required ID of Entertainment Movie"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GoWatchIt", "Movies", "Id", "Availabilities"]}}, "/GoWatchIt/Seasons/{Id}/Availabilities"=>{"get"=>{"summary"=>"Get GoWatchIt Season Availability.", "description"=>"Returns GoWatchIt season availability by Entertainment Season ID. Special permission is required to access this endpoint. Contact [Sales](mailto:Sales@InternetVideoArchive.com) for more information.", "operationId"=>"GetGoWatchItSeasonAvailabilities", "x-api-path-slug"=>"gowatchitseasonsidavailabilities-get", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"Required GoWatchIt API key"}, {"in"=>"path", "name"=>"Id", "description"=>"Required ID of Entertainment Season"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GoWatchIt", "Seasons", "Id", "Availabilities"]}}, "/GoWatchIt/Shows/{Id}/Availabilities"=>{"get"=>{"summary"=>"Get GoWatchItShow Availability.", "description"=>"Returns GoWatchIt show availability by Entertainment Show ID. Special permission is required to access this endpoint. Please contact [Sales](mailto:Sales@InternetVideoArchive.com) for more information.", "operationId"=>"GetGoWatchItShowAvailabilities", "x-api-path-slug"=>"gowatchitshowsidavailabilities-get", "parameters"=>[{"in"=>"query", "name"=>"ApiKey", "description"=>"Required GoWatchIt API key"}, {"in"=>"path", "name"=>"Id", "description"=>"Required ID of Entertainment Show"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["GoWatchIt", "Shows", "Id", "Availabilities"]}}, "/Images/Batch"=>{"post"=>{"summary"=>"Returns a list of batch image responses links based on filepath.", "description"=>"Requires a list filepath.", "operationId"=>"GetImageBatch", "x-api-path-slug"=>"imagesbatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"FilePath", "description"=>"List of Filepaths"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "Batch"]}}, "/Images/ScreenCaptures/Batch"=>{"post"=>{"summary"=>"Returns a list of screen capture responses.", "description"=>"Requires a list of filepaths.", "operationId"=>"GetScreenCaptureBatch", "x-api-path-slug"=>"imagesscreencapturesbatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"FilePath", "description"=>"List of Filepaths"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "ScreenCaptures", "Batch"]}}, "/Images/ScreenCaptures/Redirect"=>{"get"=>{"summary"=>"Redirect to a screen capture based on filepath.", "description"=>"Requires a valid filepath of a video asset screen capture. \n\n`Note: The swagger U/I does not support redirects.`", "operationId"=>"GetScreenCapture", "x-api-path-slug"=>"imagesscreencapturesredirect-get", "parameters"=>[{"in"=>"query", "name"=>"FilePath", "description"=>"Filepath of Image"}, {"in"=>"query", "name"=>"Redirect", "description"=>"Redirect to the image"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "ScreenCaptures", "Redirect"]}}, "/Images/{FilePath}/Redirect"=>{"get"=>{"summary"=>"Redirect to an image based on filepath.", "description"=>"Images should be downloaded and stored on the client server. Use /Common/ImageTypes to see a list of available image types. \n\n\n`Note: The swagger U/I does not support redirects.`", "operationId"=>"GetImage", "x-api-path-slug"=>"imagesfilepathredirect-get", "parameters"=>[{"in"=>"path", "name"=>"FilePath", "description"=>"Filepath of Image"}, {"in"=>"query", "name"=>"Redirect", "description"=>"Redirect to the image"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Images", "FilePath", "Redirect"]}}, "/Metacritic/Movie/{Id}"=>{"get"=>{"summary"=>"Get Metacritic Movie information.", "description"=>"Returns Metacritic Movie information by Entertainment Movie ID.", "operationId"=>"GetMetacriticMovie", "x-api-path-slug"=>"metacriticmovieid-get", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"Required ID of Entertainment Movie"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metacritic", "Movie", "Id"]}}, "/Metacritic/TV/{Id}"=>{"get"=>{"summary"=>"Get Metacritic TV information.", "description"=>"Returns Metacritic TV information by Entertainment Show ID.", "operationId"=>"GetMetacriticTv", "x-api-path-slug"=>"metacritictvid-get", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"Required ID of Entertainment Show"}, {"in"=>"query", "name"=>"SeasonNumber", "description"=>"Number of season"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metacritic", "TV", "Id"]}}, "/MovieTickets/Cultures"=>{"get"=>{"summary"=>"Get MovieTickets Cultures.", "description"=>"Returns MovieTickets Cultures.", "operationId"=>"GetMovieTicketsCultures", "x-api-path-slug"=>"movieticketscultures-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MovieTickets", "Cultures"]}}, "/MovieTickets/Movies/ComingSoon"=>{"get"=>{"summary"=>"Get MovieTickets Movies releasing soon.", "description"=>"Returns MovieTickets Movies releasing soon.", "operationId"=>"GetMovieTicketsMoviesComingSoon", "x-api-path-slug"=>"movieticketsmoviescomingsoon-get", "parameters"=>[{"in"=>"query", "name"=>"Culture", "description"=>"Culture to retrieve response"}, {"in"=>"query", "name"=>"PageNumber", "description"=>"Page number for paging results"}, {"in"=>"query", "name"=>"PageSize", "description"=>"Limits the total items returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MovieTickets", "Movies", "ComingSoon"]}}, "/MovieTickets/Movies/NowPlaying"=>{"get"=>{"summary"=>"Get MovieTickets Movies in theaters.", "description"=>"Returns MovieTickets Movies currently in theaters.", "operationId"=>"GetMovieTicketsMoviesNowPlaying", "x-api-path-slug"=>"movieticketsmoviesnowplaying-get", "parameters"=>[{"in"=>"query", "name"=>"Culture", "description"=>"Culture to retrieve response"}, {"in"=>"query", "name"=>"PageNumber", "description"=>"Page number for paging results"}, {"in"=>"query", "name"=>"PageSize", "description"=>"Limits the total items returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MovieTickets", "Movies", "NowPlaying"]}}, "/MovieTickets/Performances"=>{"get"=>{"summary"=>"Get MovieTickets Performances.", "description"=>"Returns MovieTickets Performances by MovieTickets Theater ID, Entertainment Movie ID, and ScheduleDate.", "operationId"=>"GetMovieTicketsPerformances", "x-api-path-slug"=>"movieticketsperformances-get", "parameters"=>[{"in"=>"query", "name"=>"Culture", "description"=>"Culture to retrieve response"}, {"in"=>"query", "name"=>"EntertainmentMovieIds", "description"=>"Required ID/IDs of Entertainment Movies"}, {"in"=>"query", "name"=>"ScheduleDate", "description"=>"Date to get scheduled performances"}, {"in"=>"query", "name"=>"TheaterIds", "description"=>"Required ID/IDs of MovieTickets Theaters"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MovieTickets", "Performances"]}}, "/MovieTickets/Theaters"=>{"get"=>{"summary"=>"Get MovieTickets Theaters.", "description"=>"Returns MovieTickets Theaters by postal code.", "operationId"=>"GetMovieTicketsTheaters", "x-api-path-slug"=>"movieticketstheaters-get", "parameters"=>[{"in"=>"query", "name"=>"Culture", "description"=>"Culture to retrieve response"}, {"in"=>"query", "name"=>"Distance", "description"=>"Required distaince in meters"}, {"in"=>"query", "name"=>"Latitude", "description"=>"Latitude coordinate"}, {"in"=>"query", "name"=>"Longitude", "description"=>"Longitude coordinate"}, {"in"=>"query", "name"=>"PageNumber", "description"=>"Page number for paging results"}, {"in"=>"query", "name"=>"PageSize", "description"=>"Limits the total items returned"}, {"in"=>"query", "name"=>"PostalCode", "description"=>"Postal code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MovieTickets", "Theaters"]}}, "/Movies/All"=>{"get"=>{"summary"=>"Returns a paged list of all movies.", "description"=>"By default the API will only return basic title information. Additional objects can be included by passing the object in the Includes parameter. \n\n\n`Subscriptions with \"Limited\" data will only be able to include basic title information and Videos.`", "operationId"=>"GetAllMovies", "x-api-path-slug"=>"moviesall-get", "parameters"=>[{"in"=>"query", "name"=>"Includes", "description"=>"List of additional objects to include in the movie objectSearch movie by OriginalTitle"}, {"in"=>"query", "name"=>"Skip", "description"=>"Skips records using for paging results"}, {"in"=>"query", "name"=>"Take", "description"=>"Limits the total items returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies"]}}, "/Movies/AlternateIdTypes"=>{"get"=>{"summary"=>"Returns all MovieAlternateIdTypes.", "description"=>"Movie alternate ID types refer to 3rd party IDs that IVA matches its own movie IDs. **EX: IMDB, TMDB**. \n\n`Use to get the Id of the ID type to use with /Find/Movie.`", "operationId"=>"GetMovieAlternateIdTypes", "x-api-path-slug"=>"moviesalternateidtypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies", "AlternateIdTypes"]}}, "/Movies/ComingSoon/"=>{"get"=>{"summary"=>"Returns list of all Movies coming to US Theaters.", "description"=>"Requires Skip and Take. Maximum page size is 10.\n\nBy default the API will only return basic title information.\nAdditional objects can be included by passing the object in the Includes parameter in a comma separated list.", "operationId"=>"GetMoviesComingSoon", "x-api-path-slug"=>"moviescomingsoon-get", "parameters"=>[{"in"=>"query", "name"=>"Includes", "description"=>"List of additional objects to include in the movie response"}, {"in"=>"query", "name"=>"Skip", "description"=>"Determines where to start page"}, {"in"=>"query", "name"=>"Take", "description"=>"Determines the page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies", "ComingSoon"]}}, "/Movies/InTheaters/"=>{"get"=>{"summary"=>"Returns list of all Movies currently in US Theaters.", "description"=>"Requires Skip and Take. Maximum page size is 10.\n\nBy default the API will only return basic title information.\nAdditional objects can be included by passing the object in the Includes parameter in a comma separated list.", "operationId"=>"GetMoviesInTheaters", "x-api-path-slug"=>"moviesintheaters-get", "parameters"=>[{"in"=>"query", "name"=>"Includes", "description"=>"List of additional objects to include in the movie response"}, {"in"=>"query", "name"=>"Skip", "description"=>"Determines where to start page"}, {"in"=>"query", "name"=>"Take", "description"=>"Determines the page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies", "InTheaters"]}}, "/Movies/Match/"=>{"get"=>{"summary"=>"Perform a match to Entertainment using Title, Year, Cast and Director. Returns best match and score for the match.", "description"=>"Use to match IVA movie data to another data source using title, year, cast etc.", "operationId"=>"MatchToMovie", "x-api-path-slug"=>"moviesmatch-get", "parameters"=>[{"in"=>"query", "name"=>"AlternateTitles", "description"=>"Alternate Titles of movie to be matched"}, {"in"=>"query", "name"=>"Cast", "description"=>"Cast members of movie to be matched"}, {"in"=>"query", "name"=>"Directors", "description"=>"Directors of movie to be matched"}, {"in"=>"query", "name"=>"StringDistance", "description"=>"For fuzzy title match, default is 4, set to 0 for no fuzzy match"}, {"in"=>"query", "name"=>"Title", "description"=>"Title of movie to be matched"}, {"in"=>"query", "name"=>"Year", "description"=>"Release Year of movie to be matched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies", "Match"]}}, "/Movies/MovieCertifications"=>{"get"=>{"summary"=>"Returns all Movie Certifications", "description"=>"Returns all Movie Certifications used in a movie response with the Releases object.", "operationId"=>"GetMovieCertifications", "x-api-path-slug"=>"moviesmoviecertifications-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies", "MovieCertifications"]}}, "/Movies/MovieGenres"=>{"get"=>{"summary"=>"Returns all Movie Genres.", "description"=>"List of all movie genres used in the API.", "operationId"=>"GetMovieGenres", "x-api-path-slug"=>"moviesmoviegenres-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies", "MovieGenres"]}}, "/Movies/ReleaseTypes"=>{"get"=>{"summary"=>"Returns all Movie ReleaseTypes", "description"=>"Release type refers to the release. **EX: Theatrical, Home Video, etc.**", "operationId"=>"GetMovieReleaseTypes", "x-api-path-slug"=>"moviesreleasetypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies", "ReleaseTypes"]}}, "/Movies/SearchAndDiscover"=>{"get"=>{"summary"=>"Search and discover movies.", "description"=>"Searchable Fields:\nTitle, AlternateTitles, Genres, OriginalReleaseDate, UnitedStatesReleaseDate, GermanyReleaseDate, FranceReleaseDate, UnitedKingdomReleaseDate, ItalyReleaseDate, JapanReleaseDate, Tags, Cast, Directors, Descriptions, Ratings, OriginalLanguage.\n[Syntax Ref](https://docs.microsoft.com/en-us/rest/api/searchservice/simple-query-syntax-in-azure-search)\n\nFilterable Fields:\nID, Title, AlternateTitles, Genres, OriginalReleaseDate, UnitedStatesReleaseDate, GermanyReleaseDate, FranceReleaseDate, UnitedKingdomReleaseDate, ItalyReleaseDate, JapanReleaseDate, Year, Tags, Cast, Directors, Descriptions, HasVideo, PosterFilePath, Ratings, OriginalLanguage, Runtime, Budget, Revenue, Created, Modified.\n[Syntax Ref](https://docs.microsoft.com/en-us/rest/api/searchservice/odata-expression-syntax-for-azure-search)", "operationId"=>"SearchAndDiscoverMovie", "x-api-path-slug"=>"moviessearchanddiscover-get", "parameters"=>[{"in"=>"query", "name"=>"Filter", "description"=>"Expression to filter results"}, {"in"=>"query", "name"=>"IncludeTotalResultCount", "description"=>"Includes total results in response"}, {"in"=>"query", "name"=>"OrderBy", "description"=>"List of field names to sort results"}, {"in"=>"query", "name"=>"SearchFields", "description"=>"List of field names to search using term"}, {"in"=>"query", "name"=>"SearchMode", "description"=>"Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match"}, {"in"=>"query", "name"=>"SelectFields", "description"=>"List of field names to be returned in the object"}, {"in"=>"query", "name"=>"Skip", "description"=>"Skip number of results"}, {"in"=>"query", "name"=>"term", "description"=>"Term to search for"}, {"in"=>"query", "name"=>"Top", "description"=>"Limit results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies", "SearchAndDiscover"]}}, "/Movies/{Id}"=>{"get"=>{"summary"=>"Returns movie data for a specific IVA MovieId.", "description"=>"By default the API will only return basic title information. Additional objects can be included by passing the object in the Includes parameter. \n\n\n`Subscriptions with \"Limited\" data will only be able to include basic title information and Videos.`", "operationId"=>"GetMovie", "x-api-path-slug"=>"moviesid-get", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"Required ID of Movie"}, {"in"=>"query", "name"=>"Includes", "description"=>"List of additional objects to include in the movie response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Movies", "Id"]}}, "/People/All"=>{"get"=>{"summary"=>"Gets all People.", "description"=>"Returns a AllPeopleResponse object containing a list of all poeple.", "operationId"=>"GetAllPeople", "x-api-path-slug"=>"peopleall-get", "parameters"=>[{"in"=>"query", "name"=>"Includes", "description"=>"List of additional objects to include in the person response"}, {"in"=>"query", "name"=>"Skip", "description"=>"Skips records using for paging results"}, {"in"=>"query", "name"=>"Take", "description"=>"Limits the total items returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People"]}}, "/People/RankedSearch/"=>{"get"=>{"summary"=>"Find Person by Name ordered by rank.", "description"=>"Find person using name ordered by rank.", "operationId"=>"GetPersonRankedSearch", "x-api-path-slug"=>"peoplerankedsearch-get", "parameters"=>[{"in"=>"query", "name"=>"StartsWith"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People", "RankedSearch"]}}, "/People/{Id}"=>{"get"=>{"summary"=>"Returns information on a person.", "description"=>"BETA - By default the API will only return basic People information. Additional objects can be included by passing the object in the Includes parameter.", "operationId"=>"GetPerson", "x-api-path-slug"=>"peopleid-get", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"Required ID of Person"}, {"in"=>"query", "name"=>"Includes", "description"=>"List of additional objects to include in the person response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People", "Id"]}}, "/People/{Id}/Filmography"=>{"get"=>{"summary"=>"Get a Person's Filmography.", "description"=>"Requires a valid Person ID.", "operationId"=>"GetFilmography", "x-api-path-slug"=>"peopleidfilmography-get", "parameters"=>[{"in"=>"path", "name"=>"Id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People", "Id", "Filmography"]}}, "/SDKs/{Client}"=>{"get"=>{"summary"=>"Returns a zip file of client SDK.", "description"=>"Generate and download SDK's for using the API. Requires a subscription key for authorization and a valid client.", "operationId"=>"GetSDK", "x-api-path-slug"=>"sdksclient-get", "parameters"=>[{"in"=>"path", "name"=>"Client", "description"=>"Client SDK"}, {"in"=>"query", "name"=>"RedirectToFile", "description"=>"Redirect to download the zipped SDK"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SDKs", "Client"]}}, "/Shows/All"=>{"get"=>{"summary"=>"Returns a paged list of all TV shows.", "description"=>"By default the API will only return basic title information. Additional objects can be included by passing the object in the Includes parameter. \n\n\n`Subscriptions with \"Limited\" data will only be able to include basic title information, Videos, EpisodicVideos, and SeasonVideos.`", "operationId"=>"GetAllShows", "x-api-path-slug"=>"showsall-get", "parameters"=>[{"in"=>"query", "name"=>"Includes", "description"=>"List of additional objects to include in the show object"}, {"in"=>"query", "name"=>"Skip", "description"=>"Skips records using for paging results"}, {"in"=>"query", "name"=>"Take", "description"=>"Limits the total items returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shows"]}}, "/Shows/AlternateIdTypes"=>{"get"=>{"summary"=>"Get all AlternateIdTypes.", "description"=>"Alternate Id types refer to the 3rd party ID sets IVA data has matched. **Ex: IMDB**", "operationId"=>"GetShowAlternateIdTypes", "x-api-path-slug"=>"showsalternateidtypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shows", "AlternateIdTypes"]}}, "/Shows/Match/"=>{"get"=>{"summary"=>"Perform a match to Entertainment using Title, Year, Cast and Director. Returns best match and score for the match.", "description"=>"Use to match IVA show data to another data source using title, director, cast, etc.", "operationId"=>"MatchToShow", "x-api-path-slug"=>"showsmatch-get", "parameters"=>[{"in"=>"query", "name"=>"AlternateTitles", "description"=>"Alternate Titles of Show to be matched"}, {"in"=>"query", "name"=>"Cast", "description"=>"Cast members of Show to be matched"}, {"in"=>"query", "name"=>"Directors", "description"=>"Directors of Show to be matched"}, {"in"=>"query", "name"=>"StringDistance", "description"=>"For fuzzy title match, default is 4, set to 0 for no fuzzy match"}, {"in"=>"query", "name"=>"Title", "description"=>"Title of Show to be matched"}, {"in"=>"query", "name"=>"Year", "description"=>"Release Year of Show to be matched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shows", "Match"]}}, "/Shows/ReleaseTypes"=>{"get"=>{"summary"=>"Returns a list of Show Release Types.", "description"=>"Release types refer to the type of release and are used in the releases object for a show.", "operationId"=>"GetShowReleaseTypes", "x-api-path-slug"=>"showsreleasetypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shows", "ReleaseTypes"]}}, "/Shows/SearchAndDiscover"=>{"get"=>{"summary"=>"Search and discover shows.", "description"=>"Searchable Fields: Title, AlternateTitles, Genres, Tags, Cast, Directors, Descriptions, Ratings, OriginalLanguage. [Syntax Ref](https://docs.microsoft.com/en-us/rest/api/searchservice/simple-query-syntax-in-azure-search)\n\nFilterable Fields: Id, Title, AlternateTitles, Genres, OriginalAirDate, Year, Tags, Cast, Directors, Descriptions, HasVideo, ImageFilePath, Ratings, OriginalLanguage, Created, Modified, NumberOfSeasons, NumberOfEpisodes. [Syntax Ref](https://docs.microsoft.com/en-us/rest/api/searchservice/simple-query-syntax-in-azure-search)", "operationId"=>"SearchAndDiscoverShow", "x-api-path-slug"=>"showssearchanddiscover-get", "parameters"=>[{"in"=>"query", "name"=>"Filter", "description"=>"Expression to filter results"}, {"in"=>"query", "name"=>"IncludeTotalResultCount", "description"=>"Includes total results in response"}, {"in"=>"query", "name"=>"OrderBy", "description"=>"List of field names to sort results"}, {"in"=>"query", "name"=>"SearchFields", "description"=>"List of field names to search using term"}, {"in"=>"query", "name"=>"SearchMode", "description"=>"Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match"}, {"in"=>"query", "name"=>"SelectFields", "description"=>"List of field names to be returned in the object"}, {"in"=>"query", "name"=>"Skip", "description"=>"Skip number of results"}, {"in"=>"query", "name"=>"term", "description"=>"Term to search for"}, {"in"=>"query", "name"=>"Top", "description"=>"Limit results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shows", "SearchAndDiscover"]}}, "/Shows/Season/"=>{"get"=>{"summary"=>"Get Season by ShowId and Season Number.", "description"=>"Use the IVA ShowId and a season number to get a season details and video asset data.", "operationId"=>"GetSeasonByNumber", "x-api-path-slug"=>"showsseason-get", "parameters"=>[{"in"=>"query", "name"=>"Id", "description"=>"Id of a Show"}, {"in"=>"query", "name"=>"SeasonNumber", "description"=>"Number of a Season belonging to a Show"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shows", "Season"]}}, "/Shows/Seasons/Episode/"=>{"get"=>{"summary"=>"Get Episode by ShowId, Season Number and Episode Number.", "description"=>"Some use cases find it useful to be able to pass a season number and episode number of a known show to get the data for that exact episode.", "operationId"=>"GetEpisodeByNumber", "x-api-path-slug"=>"showsseasonsepisode-get", "parameters"=>[{"in"=>"query", "name"=>"EpisodeNumber", "description"=>"Required EpisodeNumber"}, {"in"=>"query", "name"=>"Id", "description"=>"Required Id of the Show"}, {"in"=>"query", "name"=>"SeasonNumber", "description"=>"Required SeasonNumber"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shows", "Seasons", "Episode"]}}, "/Shows/Seasons/Episodes/{Id}"=>{"get"=>{"summary"=>"Returns an Episode object for a requested Episode ID.", "description"=>"Returns the episode details for a specific episode ID.", "operationId"=>"GetEpisode", "x-api-path-slug"=>"showsseasonsepisodesid-get", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"Required ID of an Episode"}, {"in"=>"query", "name"=>"Includes", "description"=>"List of additional objects to include in the episode response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shows", "Seasons", "Episodes", "Id"]}}, "/Shows/Seasons/{Id}"=>{"get"=>{"summary"=>"Get Season by SeasonId.", "description"=>"Use with a SeasonId to return details for a season including any video asset data.", "operationId"=>"GetSeason", "x-api-path-slug"=>"showsseasonsid-get", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"Id of a Season"}, {"in"=>"query", "name"=>"Includes", "description"=>"List of additional objects to include in the season response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shows", "Seasons", "Id"]}}, "/Shows/ShowCertifications"=>{"get"=>{"summary"=>"Returns a list of Show Certifications.", "description"=>"List of Show Certifications and definitions.", "operationId"=>"GetShowCertifications", "x-api-path-slug"=>"showsshowcertifications-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shows", "ShowCertifications"]}}, "/Shows/ShowGenres"=>{"get"=>{"summary"=>"Get all Show Genres.", "description"=>"Returns a list of all the show genres used in the IVA database.", "operationId"=>"GetShowGenres", "x-api-path-slug"=>"showsshowgenres-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shows", "ShowGenres"]}}, "/Shows/{Id}"=>{"get"=>{"summary"=>"Get Show by Show ID.", "description"=>"By default the API will only return basic title information. Additional objects can be included by passing the object in the Includes parameter. \n\n\n`Subscriptions with \"Limited\" data will only be able to include basic title information, Videos, EpisodicVideos, and SeasonVideos.`", "operationId"=>"GetShow", "x-api-path-slug"=>"showsid-get", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"Required ID of Show"}, {"in"=>"query", "name"=>"Includes", "description"=>"List of additional objects to include in the show response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shows", "Id"]}}, "/Shows/{Id}/Seasons/{SeasonNumber}"=>{"get"=>{"summary"=>"Get Season by ShowId and Season Number.", "description"=>"Depreciated. Use GetSeasonBySeasonNumber instead. Requires a valid ShowId and Season Number.", "operationId"=>"GetSeasonBySeasonNumber", "x-api-path-slug"=>"showsidseasonsseasonnumber-get", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"Id of a Show"}, {"in"=>"query", "name"=>"Includes", "description"=>"List of additional objects to include in the season response"}, {"in"=>"path", "name"=>"SeasonNumber", "description"=>"Number of a Season belonging to a Show"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shows", "Id", "Seasons", "SeasonNumber"]}}, "/Shows/{Id}/Seasons/{SeasonNumber}/Episodes/{EpisodeNumber}"=>{"get"=>{"summary"=>"Get Episode by ShowId, Season Number and Episode Number.", "description"=>"Requires a valid ShowId, Season Number and Episode Number.", "operationId"=>"GetEpisodeByEpisodeNumber", "x-api-path-slug"=>"showsidseasonsseasonnumberepisodesepisodenumber-get", "parameters"=>[{"in"=>"path", "name"=>"EpisodeNumber", "description"=>"Required EpisodeNumber"}, {"in"=>"path", "name"=>"Id", "description"=>"Required Id of the Show"}, {"in"=>"query", "name"=>"Includes", "description"=>"List of additional objects to include in the episode response"}, {"in"=>"path", "name"=>"SeasonNumber", "description"=>"Required SeasonNumber"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shows", "Id", "Seasons", "SeasonNumber", "Episodes", "EpisodeNumber"]}}, "/Tests/TestDateTime/"=>{"get"=>{"summary"=>"Returns translated time from IVA or an error if invalid.", "description"=>"Entertainment Express APIs use date time format ISO 8601. Use this API to test your date time format to see if it translates to a valid time on our server.", "operationId"=>"GetTestDateTime", "x-api-path-slug"=>"teststestdatetime-get", "parameters"=>[{"in"=>"query", "name"=>"DateTime", "description"=>"DateTime to test format from API"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tests", "TestDateTime"]}}, "/TheatricalMovies/"=>{"get"=>{"summary"=>"Returns list of all US Theatrical Movie objects.", "description"=>"Deprecated. Use /Movies/InTheaters or /Movies/ComingSoon instead. Returns all movies with a US Theatrical Release Date > today - 60 days. Use the includes parameter to include additional objects related to the movie. The includes parameter takes a comma separated list of objects. **EX: Genres,Descriptions,Videos**", "operationId"=>"GetTheatricalMovies", "x-api-path-slug"=>"theatricalmovies-get", "parameters"=>[{"in"=>"query", "name"=>"Includes", "description"=>"List of additional objects to include in the movie response"}, {"in"=>"query", "name"=>"Skip", "description"=>"Determines where to start page"}, {"in"=>"query", "name"=>"Take", "description"=>"Determines the page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TheatricalMovies"]}}, "/TvMedia/genres/movies"=>{"get"=>{"summary"=>"", "description"=>"Gets list of movie genres.", "operationId"=>"GetTvMediaMovieGenres", "x-api-path-slug"=>"tvmediagenresmovies-get", "parameters"=>[{"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Genres", "Movies"]}}, "/TvMedia/genres/shows"=>{"get"=>{"summary"=>"", "description"=>"Gets list of show genres.", "operationId"=>"GetTvMediaShowGenres", "x-api-path-slug"=>"tvmediagenresshows-get", "parameters"=>[{"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Genres", "Shows"]}}, "/TvMedia/genres/sports"=>{"get"=>{"summary"=>"", "description"=>"Gets list of sports genres.", "operationId"=>"GetTvMediaSportGenres", "x-api-path-slug"=>"tvmediagenressports-get", "parameters"=>[{"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Genres", "Sports"]}}, "/TvMedia/leagues"=>{"get"=>{"summary"=>"", "description"=>"Gets list of sports leagues.", "operationId"=>"GetTvMediaLeagues", "x-api-path-slug"=>"tvmedialeagues-get", "parameters"=>[{"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Leagues"]}}, "/TvMedia/leagues/{LeagueID}/listings"=>{"get"=>{"summary"=>"", "description"=>"Retrieve listings for a given leagueID.", "operationId"=>"GetTvMediaLeagueListings", "x-api-path-slug"=>"tvmedialeaguesleagueidlistings-get", "parameters"=>[{"in"=>"query", "name"=>"AdultContent", "description"=>"Defaults to 1 (allowed)"}, {"in"=>"query", "name"=>"Channel", "description"=>"Include only channel(s) with this number, single or array values accepted"}, {"in"=>"query", "name"=>"DescriptiveVideoOnly", "description"=>"Only displays listings which are flagged as being broadcast with Descriptive Video"}, {"in"=>"query", "name"=>"Detail", "description"=>"Set level of detail for response"}, {"in"=>"query", "name"=>"DisplayArtwork", "description"=>"Displays the Artwork information"}, {"in"=>"query", "name"=>"End", "description"=>"UTC end time in ISO8601"}, {"in"=>"query", "name"=>"EndChan", "description"=>"Highest channel"}, {"in"=>"query", "name"=>"ExcludeChan", "description"=>"Exclude channels by number, single or array values accepted"}, {"in"=>"query", "name"=>"ExcludeShowType", "description"=>"Exclude only these show type ID(s), array or single values accepted"}, {"in"=>"query", "name"=>"ExcludeStation", "description"=>"Filter out station IDs; array or single value accepted"}, {"in"=>"query", "name"=>"Id", "description"=>"ListingID, array or single values accepted"}, {"in"=>"query", "name"=>"League", "description"=>"Get only sports listings in the given league ID(s)"}, {"in"=>"path", "name"=>"LeagueID", "description"=>"League ID"}, {"in"=>"query", "name"=>"LineupID", "description"=>"Lineup ID"}, {"in"=>"query", "name"=>"LiveOnly", "description"=>"Only displays live listings"}, {"in"=>"query", "name"=>"NewShowsOnly", "description"=>"Get new shows only"}, {"in"=>"query", "name"=>"NotYetStarted", "description"=>"Only displays listings which are starting on or after the given start time"}, {"in"=>"query", "name"=>"Search", "description"=>"search value: can be a show, episode, movie, team, league, person, etc"}, {"in"=>"query", "name"=>"ShowType", "description"=>"Include only these show type ID(s), array or single values accepted"}, {"in"=>"query", "name"=>"SportEventsOnly", "description"=>"Get sporting events only"}, {"in"=>"query", "name"=>"SportType", "description"=>"Get only sports listings of type sportTypeID"}, {"in"=>"query", "name"=>"Start", "description"=>"UTC start time in ISO8601"}, {"in"=>"query", "name"=>"StartChan", "description"=>"Lowest channel"}, {"in"=>"query", "name"=>"Station", "description"=>"Filter by station ID"}, {"in"=>"query", "name"=>"Team", "description"=>"Filter by teams playing by name(teams"}, {"in"=>"query", "name"=>"TimeZone", "description"=>"Set a timezone or time offset for listing times (listDateTime property)"}, {"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Leagues", "LeagueID", "Listings"]}}, "/TvMedia/leagues/{LeagueID}/teams"=>{"get"=>{"summary"=>"", "description"=>"Gets list of teams in a league.", "operationId"=>"GetTvMediaTeams", "x-api-path-slug"=>"tvmedialeaguesleagueidteams-get", "parameters"=>[{"in"=>"path", "name"=>"LeagueID", "description"=>"League ID"}, {"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Leagues", "LeagueID", "Teams"]}}, "/TvMedia/lineups"=>{"get"=>{"summary"=>"", "description"=>"Get lineups by postal code.", "operationId"=>"GetTvMediaLineupsByPostalCode", "x-api-path-slug"=>"tvmedialineups-get", "parameters"=>[{"in"=>"query", "name"=>"Detail", "description"=>"Set level of detail for response"}, {"in"=>"query", "name"=>"LineupType", "description"=>"Filter by lineup type, valid types are OTA, SAT, CAB, IPTV"}, {"in"=>"query", "name"=>"PostalCode", "description"=>"Postal code"}, {"in"=>"query", "name"=>"ProviderId", "description"=>"Filter by provider ID"}, {"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Lineups"]}}, "/TvMedia/lineups/browse"=>{"get"=>{"summary"=>"", "description"=>"Starting point for lineup browser, returns available countries.", "operationId"=>"GetTvMediaCountries", "x-api-path-slug"=>"tvmedialineupsbrowse-get", "parameters"=>[{"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Lineups", "Browse"]}}, "/TvMedia/lineups/browse/{CountryID}"=>{"get"=>{"summary"=>"", "description"=>"Browse regions by country.", "operationId"=>"GetTvMediaRegions", "x-api-path-slug"=>"tvmedialineupsbrowsecountryid-get", "parameters"=>[{"in"=>"path", "name"=>"CountryID", "description"=>"Country abbreviation"}, {"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Lineups", "Browse", "CountryID"]}}, "/TvMedia/lineups/browse/{CountryID}/{RegionID}"=>{"get"=>{"summary"=>"", "description"=>"Get service areas for a specific country and region.", "operationId"=>"GetTvMediaServiceAreas", "x-api-path-slug"=>"tvmedialineupsbrowsecountryidregionid-get", "parameters"=>[{"in"=>"path", "name"=>"CountryID", "description"=>"Country abbreviation"}, {"in"=>"path", "name"=>"RegionID", "description"=>"Region abbreviation"}, {"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Lineups", "Browse", "CountryID", "RegionID"]}}, "/TvMedia/lineups/browse/{CountryID}/{RegionID}/{AreaID}"=>{"get"=>{"summary"=>"", "description"=>"Get lineups by AreaID.", "operationId"=>"GetTvMediaLineupsByAreaID", "x-api-path-slug"=>"tvmedialineupsbrowsecountryidregionidareaid-get", "parameters"=>[{"in"=>"path", "name"=>"AreaID", "description"=>"Service area ID"}, {"in"=>"path", "name"=>"CountryID", "description"=>"Country abbreviation"}, {"in"=>"query", "name"=>"Detail", "description"=>"Set level of detail for response"}, {"in"=>"query", "name"=>"LineupType", "description"=>"Filter by lineup type, valid types are OTA, SAT, CAB, IPTV"}, {"in"=>"query", "name"=>"ProviderId", "description"=>"Filter by provider ID"}, {"in"=>"path", "name"=>"RegionID", "description"=>"Region abbreviation"}, {"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Lineups", "Browse", "CountryID", "RegionID", "AreaID"]}}, "/TvMedia/lineups/geo"=>{"get"=>{"summary"=>"", "description"=>"Get lineups by latitude and longitude.", "operationId"=>"GetTvMediaLineupsByLatitudeLongitude", "x-api-path-slug"=>"tvmedialineupsgeo-get", "parameters"=>[{"in"=>"query", "name"=>"Detail", "description"=>"Set level of detail for response"}, {"in"=>"query", "name"=>"Latitude", "description"=>"Latitude (geographic coordinate)"}, {"in"=>"query", "name"=>"LineupType", "description"=>"Filter by lineup type, valid types are OTA, SAT, CAB, IPTV"}, {"in"=>"query", "name"=>"Longitude", "description"=>"Longitude (geographic coordinate)"}, {"in"=>"query", "name"=>"ProviderId", "description"=>"Filter by provider ID"}, {"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Lineups", "Geo"]}}, "/TvMedia/lineups/{LineupID}"=>{"get"=>{"summary"=>"", "description"=>"Get lineups by specific LineupID.", "operationId"=>"GetTvMediaLineupByID", "x-api-path-slug"=>"tvmedialineupslineupid-get", "parameters"=>[{"in"=>"query", "name"=>"Detail", "description"=>"Set level of detail for response"}, {"in"=>"path", "name"=>"LineupID", "description"=>"Lineup ID"}, {"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Lineups", "LineupID"]}}, "/TvMedia/lineups/{LineupID}/listings"=>{"get"=>{"summary"=>"", "description"=>"Retrieve individual listings for a given lineup ordered by start time (listDateTime) and channel number; unless using the search parameter, in which case they will be ordered by search term relevance.", "operationId"=>"GetTvMediaLineupListings", "x-api-path-slug"=>"tvmedialineupslineupidlistings-get", "parameters"=>[{"in"=>"query", "name"=>"AdultContent", "description"=>"Defaults to 1 (allowed)"}, {"in"=>"query", "name"=>"Channel", "description"=>"Include only channel(s) with this number, single or array values accepted"}, {"in"=>"query", "name"=>"DescriptiveVideoOnly", "description"=>"Only displays listings which are flagged as being broadcast with Descriptive Video"}, {"in"=>"query", "name"=>"Detail", "description"=>"Set level of detail for response"}, {"in"=>"query", "name"=>"DisplayArtwork", "description"=>"Displays the Artwork information"}, {"in"=>"query", "name"=>"End", "description"=>"UTC end time in ISO8601"}, {"in"=>"query", "name"=>"EndChan", "description"=>"Highest channel"}, {"in"=>"query", "name"=>"ExcludeChan", "description"=>"Exclude channels by number, single or array values accepted"}, {"in"=>"query", "name"=>"ExcludeShowType", "description"=>"Exclude only these show type ID(s), array or single values accepted"}, {"in"=>"query", "name"=>"ExcludeStation", "description"=>"Filter out station IDs; array or single value accepted"}, {"in"=>"query", "name"=>"Id", "description"=>"ListingID, array or single values accepted"}, {"in"=>"query", "name"=>"League", "description"=>"Get only sports listings in the given league ID(s)"}, {"in"=>"path", "name"=>"LineupID", "description"=>"Lineup ID"}, {"in"=>"query", "name"=>"LiveOnly", "description"=>"Only displays live listings"}, {"in"=>"query", "name"=>"NewShowsOnly", "description"=>"Get new shows only"}, {"in"=>"query", "name"=>"NotYetStarted", "description"=>"Only displays listings which are starting on or after the given start time"}, {"in"=>"query", "name"=>"Search", "description"=>"search value: can be a show, episode, movie, team, league, person, etc"}, {"in"=>"query", "name"=>"ShowType", "description"=>"Include only these show type ID(s), array or single values accepted"}, {"in"=>"query", "name"=>"SportEventsOnly", "description"=>"Get sporting events only"}, {"in"=>"query", "name"=>"SportType", "description"=>"Get only sports listings of type sportTypeID"}, {"in"=>"query", "name"=>"Start", "description"=>"UTC start time in ISO8601"}, {"in"=>"query", "name"=>"StartChan", "description"=>"Lowest channel"}, {"in"=>"query", "name"=>"Station", "description"=>"Filter by station ID"}, {"in"=>"query", "name"=>"Team", "description"=>"Filter by teams playing by name(teams"}, {"in"=>"query", "name"=>"TimeZone", "description"=>"Set a timezone or time offset for listing times (listDateTime property)"}, {"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Lineups", "LineupID", "Listings"]}}, "/TvMedia/lineups/{LineupID}/listings/grid"=>{"get"=>{"summary"=>"", "description"=>"A collection of listings grouped by channel and ordered by listDateTime. The grid dimensions ( time x channels ) can be modified by using the start, end, startchan and maxchan parameters. Channels without any listings will be returned with an empty listings collection.", "operationId"=>"GetTvMediaLineupListingsGrid", "x-api-path-slug"=>"tvmedialineupslineupidlistingsgrid-get", "parameters"=>[{"in"=>"query", "name"=>"AdultContent", "description"=>"Defaults to 1 (allowed)"}, {"in"=>"query", "name"=>"Channel", "description"=>"Include only channel(s) with this number, single or array values accepted"}, {"in"=>"query", "name"=>"DescriptiveVideoOnly", "description"=>"Only displays listings which are flagged as being broadcast with Descriptive Video"}, {"in"=>"query", "name"=>"Detail", "description"=>"Set level of detail for response"}, {"in"=>"query", "name"=>"DisplayArtwork", "description"=>"Displays the Artwork information"}, {"in"=>"query", "name"=>"End", "description"=>"UTC end time in ISO8601"}, {"in"=>"query", "name"=>"EndChan", "description"=>"Highest channel"}, {"in"=>"query", "name"=>"ExcludeChan", "description"=>"Exclude channels by number, single or array values accepted"}, {"in"=>"query", "name"=>"ExcludeShowType", "description"=>"Exclude only these show type ID(s), array or single values accepted"}, {"in"=>"query", "name"=>"ExcludeStation", "description"=>"Filter out station IDs; array or single value accepted"}, {"in"=>"query", "name"=>"Id", "description"=>"ListingID, array or single values accepted"}, {"in"=>"query", "name"=>"League", "description"=>"Get only sports listings in the given league ID(s)"}, {"in"=>"path", "name"=>"LineupID", "description"=>"Lineup ID"}, {"in"=>"query", "name"=>"LiveOnly", "description"=>"Only displays live listings"}, {"in"=>"query", "name"=>"NewShowsOnly", "description"=>"Get new shows only"}, {"in"=>"query", "name"=>"NotYetStarted", "description"=>"Only displays listings which are starting on or after the given start time"}, {"in"=>"query", "name"=>"Search", "description"=>"search value: can be a show, episode, movie, team, league, person, etc"}, {"in"=>"query", "name"=>"ShowType", "description"=>"Include only these show type ID(s), array or single values accepted"}, {"in"=>"query", "name"=>"SportEventsOnly", "description"=>"Get sporting events only"}, {"in"=>"query", "name"=>"SportType", "description"=>"Get only sports listings of type sportTypeID"}, {"in"=>"query", "name"=>"Start", "description"=>"UTC start time in ISO8601"}, {"in"=>"query", "name"=>"StartChan", "description"=>"Lowest channel"}, {"in"=>"query", "name"=>"Station", "description"=>"Filter by station ID"}, {"in"=>"query", "name"=>"Team", "description"=>"Filter by teams playing by name(teams"}, {"in"=>"query", "name"=>"TimeZone", "description"=>"Set a timezone or time offset for listing times (listDateTime property)"}, {"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Lineups", "LineupID", "Listings", "Grid"]}}, "/TvMedia/lineups/{LineupID}/listings/highlights"=>{"get"=>{"summary"=>"", "description"=>"Retrieves featured listings. setting a start and/or end time for every request is a highly recommended.", "operationId"=>"GetTvMediaLineupListingsHighlights", "x-api-path-slug"=>"tvmedialineupslineupidlistingshighlights-get", "parameters"=>[{"in"=>"query", "name"=>"AdultContent", "description"=>"Defaults to 1 (allowed)"}, {"in"=>"query", "name"=>"Channel", "description"=>"Include only channel(s) with this number, single or array values accepted"}, {"in"=>"query", "name"=>"DescriptiveVideoOnly", "description"=>"Only displays listings which are flagged as being broadcast with Descriptive Video"}, {"in"=>"query", "name"=>"Detail", "description"=>"Set level of detail for response"}, {"in"=>"query", "name"=>"DisplayArtwork", "description"=>"Displays the Artwork information"}, {"in"=>"query", "name"=>"End", "description"=>"UTC end time in ISO8601"}, {"in"=>"query", "name"=>"EndChan", "description"=>"Highest channel"}, {"in"=>"query", "name"=>"ExcludeChan", "description"=>"Exclude channels by number, single or array values accepted"}, {"in"=>"query", "name"=>"ExcludeShowType", "description"=>"Exclude only these show type ID(s), array or single values accepted"}, {"in"=>"query", "name"=>"ExcludeStation", "description"=>"Filter out station IDs; array or single value accepted"}, {"in"=>"query", "name"=>"Id", "description"=>"ListingID, array or single values accepted"}, {"in"=>"query", "name"=>"League", "description"=>"Get only sports listings in the given league ID(s)"}, {"in"=>"path", "name"=>"LineupID", "description"=>"Lineup ID"}, {"in"=>"query", "name"=>"LiveOnly", "description"=>"Only displays live listings"}, {"in"=>"query", "name"=>"NewShowsOnly", "description"=>"Get new shows only"}, {"in"=>"query", "name"=>"NotYetStarted", "description"=>"Only displays listings which are starting on or after the given start time"}, {"in"=>"query", "name"=>"Search", "description"=>"search value: can be a show, episode, movie, team, league, person, etc"}, {"in"=>"query", "name"=>"ShowType", "description"=>"Include only these show type ID(s), array or single values accepted"}, {"in"=>"query", "name"=>"SportEventsOnly", "description"=>"Get sporting events only"}, {"in"=>"query", "name"=>"SportType", "description"=>"Get only sports listings of type sportTypeID"}, {"in"=>"query", "name"=>"Start", "description"=>"UTC start time in ISO8601"}, {"in"=>"query", "name"=>"StartChan", "description"=>"Lowest channel"}, {"in"=>"query", "name"=>"Station", "description"=>"Filter by station ID"}, {"in"=>"query", "name"=>"Team", "description"=>"Filter by teams playing by name(teams"}, {"in"=>"query", "name"=>"TimeZone", "description"=>"Set a timezone or time offset for listing times (listDateTime property)"}, {"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Lineups", "LineupID", "Listings", "Highlights"]}}, "/TvMedia/reference/lineups"=>{"get"=>{"summary"=>"", "description"=>"Get list of generic lineup IDs that can be used. A 'generic' lineup is not a real lineup, but a collection of stations defined by TV Media. Any listing retrieved using a generic lineup will not return any channel number information, as it is irrelevant.", "operationId"=>"GetTvMediaGenericLineups", "x-api-path-slug"=>"tvmediareferencelineups-get", "parameters"=>[{"in"=>"query", "name"=>"Detail", "description"=>"Set level of detail for response"}, {"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Reference", "Lineups"]}}, "/TvMedia/stations/{StationID}"=>{"get"=>{"summary"=>"", "description"=>"Gets station details by ID.", "operationId"=>"GetTvMediaStation", "x-api-path-slug"=>"tvmediastationsstationid-get", "parameters"=>[{"in"=>"path", "name"=>"StationID", "description"=>"Station ID"}, {"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Stations", "StationID"]}}, "/TvMedia/stations/{StationID}/listings"=>{"get"=>{"summary"=>"Stations are not tied to lineups, therefore no channel numbers will be present in the response, unlike most other listing operations.", "description"=>"Get listings for a given station.", "operationId"=>"GetTvMediaListingsByStation", "x-api-path-slug"=>"tvmediastationsstationidlistings-get", "parameters"=>[{"in"=>"query", "name"=>"AdultContent", "description"=>"Defaults to 1 (allowed)"}, {"in"=>"query", "name"=>"Channel", "description"=>"Include only channel(s) with this number, single or array values accepted"}, {"in"=>"query", "name"=>"DescriptiveVideoOnly", "description"=>"Only displays listings which are flagged as being broadcast with Descriptive Video"}, {"in"=>"query", "name"=>"Detail", "description"=>"Set level of detail for response"}, {"in"=>"query", "name"=>"DisplayArtwork", "description"=>"Displays the Artwork information"}, {"in"=>"query", "name"=>"End", "description"=>"UTC end time in ISO8601"}, {"in"=>"query", "name"=>"EndChan", "description"=>"Highest channel"}, {"in"=>"query", "name"=>"ExcludeChan", "description"=>"Exclude channels by number, single or array values accepted"}, {"in"=>"query", "name"=>"ExcludeShowType", "description"=>"Exclude only these show type ID(s), array or single values accepted"}, {"in"=>"query", "name"=>"ExcludeStation", "description"=>"Filter out station IDs; array or single value accepted"}, {"in"=>"query", "name"=>"Id", "description"=>"ListingID, array or single values accepted"}, {"in"=>"query", "name"=>"League", "description"=>"Get only sports listings in the given league ID(s)"}, {"in"=>"query", "name"=>"LiveOnly", "description"=>"Only displays live listings"}, {"in"=>"query", "name"=>"NewShowsOnly", "description"=>"Get new shows only"}, {"in"=>"query", "name"=>"NotYetStarted", "description"=>"Only displays listings which are starting on or after the given start time"}, {"in"=>"query", "name"=>"Search", "description"=>"search value: can be a show, episode, movie, team, league, person, etc"}, {"in"=>"query", "name"=>"ShowType", "description"=>"Include only these show type ID(s), array or single values accepted"}, {"in"=>"query", "name"=>"SportEventsOnly", "description"=>"Get sporting events only"}, {"in"=>"query", "name"=>"SportType", "description"=>"Get only sports listings of type sportTypeID"}, {"in"=>"query", "name"=>"Start", "description"=>"UTC start time in ISO8601"}, {"in"=>"query", "name"=>"StartChan", "description"=>"Lowest channel"}, {"in"=>"query", "name"=>"Station", "description"=>"Filter by station ID"}, {"in"=>"path", "name"=>"StationID", "description"=>"Station ID"}, {"in"=>"query", "name"=>"Team", "description"=>"Filter by teams playing by name(teams"}, {"in"=>"query", "name"=>"TimeZone", "description"=>"Set a timezone or time offset for listing times (listDateTime property)"}, {"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Stations", "StationID", "Listings"]}}, "/TvMedia/teams/{TeamID}"=>{"get"=>{"summary"=>"", "description"=>"Gets details for a specific team.", "operationId"=>"GetTvMediaTeamById", "x-api-path-slug"=>"tvmediateamsteamid-get", "parameters"=>[{"in"=>"path", "name"=>"TeamID", "description"=>"Team ID"}, {"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Teams", "TeamID"]}}, "/TvMedia/teams/{TeamID}/listings"=>{"get"=>{"summary"=>"", "description"=>"Retrieve listings for a given TeamID.", "operationId"=>"GetTvMediaTeamListings", "x-api-path-slug"=>"tvmediateamsteamidlistings-get", "parameters"=>[{"in"=>"query", "name"=>"AdultContent", "description"=>"Defaults to 1 (allowed)"}, {"in"=>"query", "name"=>"Channel", "description"=>"Include only channel(s) with this number, single or array values accepted"}, {"in"=>"query", "name"=>"DescriptiveVideoOnly", "description"=>"Only displays listings which are flagged as being broadcast with Descriptive Video"}, {"in"=>"query", "name"=>"Detail", "description"=>"Set level of detail for response"}, {"in"=>"query", "name"=>"DisplayArtwork", "description"=>"Displays the Artwork information"}, {"in"=>"query", "name"=>"End", "description"=>"UTC end time in ISO8601"}, {"in"=>"query", "name"=>"EndChan", "description"=>"Highest channel"}, {"in"=>"query", "name"=>"ExcludeChan", "description"=>"Exclude channels by number, single or array values accepted"}, {"in"=>"query", "name"=>"ExcludeShowType", "description"=>"Exclude only these show type ID(s), array or single values accepted"}, {"in"=>"query", "name"=>"ExcludeStation", "description"=>"Filter out station IDs; array or single value accepted"}, {"in"=>"query", "name"=>"Id", "description"=>"ListingID, array or single values accepted"}, {"in"=>"query", "name"=>"League", "description"=>"Get only sports listings in the given league ID(s)"}, {"in"=>"query", "name"=>"LineupID", "description"=>"Lineup ID"}, {"in"=>"query", "name"=>"LiveOnly", "description"=>"Only displays live listings"}, {"in"=>"query", "name"=>"NewShowsOnly", "description"=>"Get new shows only"}, {"in"=>"query", "name"=>"NotYetStarted", "description"=>"Only displays listings which are starting on or after the given start time"}, {"in"=>"query", "name"=>"Search", "description"=>"search value: can be a show, episode, movie, team, league, person, etc"}, {"in"=>"query", "name"=>"ShowType", "description"=>"Include only these show type ID(s), array or single values accepted"}, {"in"=>"query", "name"=>"SportEventsOnly", "description"=>"Get sporting events only"}, {"in"=>"query", "name"=>"SportType", "description"=>"Get only sports listings of type sportTypeID"}, {"in"=>"query", "name"=>"Start", "description"=>"UTC start time in ISO8601"}, {"in"=>"query", "name"=>"StartChan", "description"=>"Lowest channel"}, {"in"=>"query", "name"=>"Station", "description"=>"Filter by station ID"}, {"in"=>"query", "name"=>"Team", "description"=>"Filter by teams playing by name(teams"}, {"in"=>"path", "name"=>"TeamID", "description"=>"Team ID"}, {"in"=>"query", "name"=>"TimeZone", "description"=>"Set a timezone or time offset for listing times (listDateTime property)"}, {"in"=>"query", "name"=>"TvMediaApiKey", "description"=>"API Key supplied by TvMedia"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["TvMedia", "Teams", "TeamID", "Listings"]}}, "/Videos/GetVideo/{Id}"=>{"get"=>{"summary"=>"Returns a URL to a requested video.", "description"=>"Returns a URL to the requested video. [Video Format Specs](https://developer.iva-api.com/docs/v1/video-formats)\n\n**Formats:** MP4 = 4, HLS = 11, Dash = 14, HSS = 12, HDS = 13\n\n**MP4 KbRate:** 80, 212, 450, 750, 1500, 2500(HD sources only), 5000 (sources >= 1080p) \n\n**Adaptive Min/Max rate:** 212000, 350000, 600000, 1200000, 2000000, 2500000, 3500000 \n\n `URLs requested with a Demo account will always return max 750 kbps video. Full commercial account required for higher bitrates.`", "operationId"=>"GetVideo", "x-api-path-slug"=>"videosgetvideoid-get", "parameters"=>[{"in"=>"query", "name"=>"end", "description"=>"Position in seconds to end video playback"}, {"in"=>"query", "name"=>"Expires", "description"=>"UTC Time to video link should expire"}, {"in"=>"query", "name"=>"Format", "description"=>"Video format"}, {"in"=>"path", "name"=>"Id", "description"=>"Id of the Video from either MovieVideo, ShowVideo, SeasonVideo, EpisodeVideo object"}, {"in"=>"query", "name"=>"KbRate", "description"=>"Video bitrate required for MP4 content"}, {"in"=>"query", "name"=>"MaxRate", "description"=>"Adaptive Minimum rate"}, {"in"=>"query", "name"=>"MinRate", "description"=>"Adaptive Maximum rate"}, {"in"=>"query", "name"=>"ReportTag", "description"=>"Report tag used in video analytics"}, {"in"=>"query", "name"=>"start", "description"=>"Position in seconds to start video playback"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Videos", "Video", "Id"]}}, "/XroadMedia/recommendations"=>{"get"=>{"summary"=>"Returns a list of recommendations from XRoadMedia for a movie or show.", "description"=>"Get recommendations for movie or show.", "operationId"=>"GetXRoadMediaRecommendations", "x-api-path-slug"=>"xroadmediarecommendations-get", "parameters"=>[{"in"=>"query", "name"=>"MovieId", "description"=>"Source MovieId for recommendations"}, {"in"=>"query", "name"=>"ShowId", "description"=>"Source ShowId for recommendations"}, {"in"=>"query", "name"=>"Type", "description"=>"Type of recommendation response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["XroadMedia", "Recommendations"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-rekognition{"aws-rekognition-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Rekognition", "x-complete"=>1, "info"=>{"title"=>"AWS Rekognition API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=CompareFaces"=>{"get"=>{"summary"=>"Compare Faces", "description"=>"Compares a face in the source input image with\n each face detected in the target input image.", "operationId"=>"compareFaces", "x-api-path-slug"=>"actioncomparefaces-get", "parameters"=>[{"in"=>"query", "name"=>"SimilarityThreshold", "description"=>"The minimum level of confidence in the match you want included in the result", "type"=>"string"}, {"in"=>"query", "name"=>"SourceImage", "description"=>"Source image either as bytes or an S3 object", "type"=>"string"}, {"in"=>"query", "name"=>"TargetImage", "description"=>"Target image either as bytes or an S3 object", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Faces"]}}, "/?Action=CreateCollection"=>{"get"=>{"summary"=>"Create Collection", "description"=>"Creates a collection in an AWS Region.", "operationId"=>"createCollection", "x-api-path-slug"=>"actioncreatecollection-get", "parameters"=>[{"in"=>"query", "name"=>"CollectionId", "description"=>"ID for the collection that you are creating", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Collections"]}}, "/?Action=DeleteCollection"=>{"get"=>{"summary"=>"Delete Collection", "description"=>"Deletes the specified collection.", "operationId"=>"deleteCollection", "x-api-path-slug"=>"actiondeletecollection-get", "parameters"=>[{"in"=>"query", "name"=>"CollectionId", "description"=>"ID of the collection to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Collections"]}}, "/?Action=DeleteFaces"=>{"get"=>{"summary"=>"Delete Faces", "description"=>"Deletes faces from a collection.", "operationId"=>"deleteFaces", "x-api-path-slug"=>"actiondeletefaces-get", "parameters"=>[{"in"=>"query", "name"=>"CollectionId", "description"=>"Collection from which to remove the specific faces", "type"=>"string"}, {"in"=>"query", "name"=>"FaceIds", "description"=>"An array of face IDs to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Faces"]}}, "/?Action=DetectFaces"=>{"get"=>{"summary"=>"Detect Faces", "description"=>"Detects faces within an image (JPEG or PNG) that is provided as input.", "operationId"=>"detectFaces", "x-api-path-slug"=>"actiondetectfaces-get", "parameters"=>[{"in"=>"query", "name"=>"Attributes", "description"=>"A list of facial attributes you would like to be returned", "type"=>"string"}, {"in"=>"query", "name"=>"Image", "description"=>"The image in which you want to detect faces", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Faces"]}}, "/?Action=DetectLabels"=>{"get"=>{"summary"=>"Detect Labels", "description"=>"Detects instances of real-world labels within an image (JPEG or PNG)\n provided as input.", "operationId"=>"detectLabels", "x-api-path-slug"=>"actiondetectlabels-get", "parameters"=>[{"in"=>"query", "name"=>"Image", "description"=>"The input image", "type"=>"string"}, {"in"=>"query", "name"=>"MaxLabels", "description"=>"Maximum number of labels you want the service to return in the response", "type"=>"string"}, {"in"=>"query", "name"=>"MinConfidence", "description"=>"Specifies the minimum confidence level for the labels to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Labels"]}}, "/?Action=IndexFaces"=>{"get"=>{"summary"=>"Index Faces", "description"=>"Detects faces in the input image and adds them to the specified collection.", "operationId"=>"indexFaces", "x-api-path-slug"=>"actionindexfaces-get", "parameters"=>[{"in"=>"query", "name"=>"CollectionId", "description"=>"ID of an existing collection to which you want to add the faces that are detected in the input images", "type"=>"string"}, {"in"=>"query", "name"=>"DetectionAttributes", "description"=>"(Optional) Returns detailed attributes of indexed faces", "type"=>"string"}, {"in"=>"query", "name"=>"ExternalImageId", "description"=>"ID you want to assign to all the faces detected in the image", "type"=>"string"}, {"in"=>"query", "name"=>"Image", "description"=>"Provides the source image either as bytes or an S3 object", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Faces"]}}, "/?Action=ListCollections"=>{"get"=>{"summary"=>"List Collections", "description"=>"Returns list of collection IDs in your account.", "operationId"=>"listCollections", "x-api-path-slug"=>"actionlistcollections-get", "parameters"=>[{"in"=>"query", "name"=>"MaxResults", "description"=>"Maximum number of collection IDs to return", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"Pagination token from the previous response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Collections"]}}, "/?Action=ListFaces"=>{"get"=>{"summary"=>"List Faces", "description"=>"Returns metadata for faces in the specified collection.", "operationId"=>"listFaces", "x-api-path-slug"=>"actionlistfaces-get", "parameters"=>[{"in"=>"query", "name"=>"CollectionId", "description"=>"ID of the collection from which to list the faces", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"Maximum number of faces to return", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Faces"]}}, "/?Action=SearchFaces"=>{"get"=>{"summary"=>"Search Faces", "description"=>"For a given input face ID, searches for matching faces in the collection the face belongs to.", "operationId"=>"searchFaces", "x-api-path-slug"=>"actionsearchfaces-get", "parameters"=>[{"in"=>"query", "name"=>"CollectionId", "description"=>"ID of the collection the face belongs to", "type"=>"string"}, {"in"=>"query", "name"=>"FaceId", "description"=>"ID of a face to find matches for in the collection", "type"=>"string"}, {"in"=>"query", "name"=>"FaceMatchThreshold", "description"=>"Optional value specifying the minimum confidence in the face match to return", "type"=>"string"}, {"in"=>"query", "name"=>"MaxFaces", "description"=>"Maximum number of faces to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Faces"]}}, "/?Action=SearchFacesByImage"=>{"get"=>{"summary"=>"Search Faces By Image", "description"=>"For a given input image, first detects the largest face in the image, and\n then searches the specified collection for matching faces.", "operationId"=>"searchFacesByImage", "x-api-path-slug"=>"actionsearchfacesbyimage-get", "parameters"=>[{"in"=>"query", "name"=>"CollectionId", "description"=>"ID of the collection to search", "type"=>"string"}, {"in"=>"query", "name"=>"FaceMatchThreshold", "description"=>"(Optional) Specifies the minimum confidence in the face match to return", "type"=>"string"}, {"in"=>"query", "name"=>"Image", "description"=>"Provides the source image either as bytes or an S3 object", "type"=>"string"}, {"in"=>"query", "name"=>"MaxFaces", "description"=>"Maximum number of faces to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Faces"]}}}}, "apis"=>{"name"=>"AWS Rekognition", "x-slug"=>"aws-rekognition", "description"=>"Amazon Rekognition is a service that makes it easy to add image analysis to your applications. With Rekognition, you can detect objects, scenes, and faces in images. You can also search and compare faces. Rekognition’s API enables you to quickly add sophisticated deep learning-based visual search and image classification to your applications.Amazon Rekognition is based on the same proven, highly scalable, deep learning technology developed by Amazon’s computer vision scientists to analyze billions of images daily for Prime Photos. Amazon Rekognition uses deep neural network models to detect and label thousands of objects and scenes in your images, and we are continually adding new labels and facial recognition features to the service.Rekognition’s API lets you easily build powerful visual search and discovery into your applications. With Amazon Rekognition, you only pay for the images you analyze and the face metadata you store. There are no minimum fees and there are no upfront commitments.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-rekognition.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Facial Recognition,Machine Learning,Object Recognition,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-rekognition/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Rekognition API", "x-api-slug"=>"aws-rekognition-api", "description"=>"Amazon Rekognition is a service that makes it easy to add image analysis to your applications. With Rekognition, you can detect objects, scenes, and faces in images. You can also search and compare faces. Rekognition’s API enables you to quickly add sophisticated deep learning-based visual search and image classification to your applications.Amazon Rekognition is based on the same proven, highly scalable, deep learning technology developed by Amazon’s computer vision scientists to analyze billions of images daily for Prime Photos. Amazon Rekognition uses deep neural network models to detect and label thousands of objects and scenes in your images, and we are continually adding new labels and facial recognition features to the service.Rekognition’s API lets you easily build powerful visual search and discovery into your applications. With Amazon Rekognition, you only pay for the images you analyze and the face metadata you store. There are no minimum fees and there are no upfront commitments.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-rekognition.png", "humanURL"=>"https://aws.amazon.com/rekognition/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Facial Recognition,Machine Learning,Object Recognition,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-rekognition/aws-rekognition-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://aws.amazon.com/rekognition/developers/#blog-posts"}, {"type"=>"x-customers", "url"=>"https://aws.amazon.com/rekognition/customers/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/rekognition/latest/dg/API_Reference.htm"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/rekognition/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/rekognition/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/rekognition/pricing/"}, {"type"=>"x-sdk", "url"=>"https://aws.amazon.com/rekognition/developers/#sdk"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/rekognition/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-kinesis-analytics{"apis"=>{"name"=>"AWS Kinesis Analytics", "x-slug"=>"aws-kinesis-analytics", "description"=>"Amazon Kinesis Analytics is the easiest way to process streaming data in real time with standard SQL without having to learn new programming languages or processing frameworks. Amazon Kinesis Analytics enables you to create and run SQL queries on streaming data so that you can gain actionable insights and respond to your business and customer needs promptly.Amazon Kinesis Analytics takes care of everything required to run your queries continuously and scales automatically to match the volume and throughput rate of your incoming data. With Amazon Kinesis Analytics, you only pay for the resources your queries consume. There is no minimum fee or setup cost.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Analytics_AmazonKinesis_AmazonKinesisAnalytics.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,Analysis,API Provider,API Service Provider,API Service Provider,Databases,Logging,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-kinesis-analytics/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Kinesis Analytics API", "x-api-slug"=>"aws-kinesis-analytics-api", "description"=>"Amazon Kinesis Analytics is the easiest way to process streaming data in real time with standard SQL without having to learn new programming languages or processing frameworks. Amazon Kinesis Analytics enables you to create and run SQL queries on streaming data so that you can gain actionable insights and respond to your business and customer needs promptly.Amazon Kinesis Analytics takes care of everything required to run your queries continuously and scales automatically to match the volume and throughput rate of your incoming data. With Amazon Kinesis Analytics, you only pay for the resources your queries consume. There is no minimum fee or setup cost.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Analytics_AmazonKinesis_AmazonKinesisAnalytics.png", "humanURL"=>"https://aws.amazon.com/kinesis/analytics/", "baseURL"=>":///", "tags"=>"Amazon Web Services,Analysis,API Provider,API Service Provider,API Service Provider,Databases,Logging,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-kinesis-analytics/aws-kinesis-analytics-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://docs.aws.amazon.com/kinesisanalytics/latest/dev/authentication-and-access-control.html"}, {"type"=>"x-best-practices", "url"=>"https://docs.aws.amazon.com/kinesisanalytics/latest/dev/best-practices.html"}, {"type"=>"x-console", "url"=>"https://console.aws.amazon.com/kinesisanalytics/home"}, {"type"=>"x-documentation", "url"=>"https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_Reference.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/kinesis/analytics/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/kinesis/analytics/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/kinesis/analytics/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/kinesis/analytics/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "aws-kinesis-analytics-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Kinesis Analytics", "x-complete"=>1, "info"=>{"title"=>"AWS Kinesis Analytics API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddApplicationInput"=>{"get"=>{"summary"=>"Add Application Input", "description"=>"Adds a streaming source to your Amazon Kinesis application.", "operationId"=>"addApplicationInput", "x-api-path-slug"=>"actionaddapplicationinput-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source", "type"=>"string"}, {"in"=>"query", "name"=>"CurrentApplicationVersionId", "description"=>"Current version of your Amazon Kinesis Analytics application", "type"=>"string"}, {"in"=>"query", "name"=>"Input", "description"=>"When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=AddApplicationOutput"=>{"get"=>{"summary"=>"Add Application Output", "description"=>"Adds an external destination to your Amazon Kinesis Analytics application.", "operationId"=>"addApplicationOutput", "x-api-path-slug"=>"actionaddapplicationoutput-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"Name of the application to which you want to add the output configuration", "type"=>"string"}, {"in"=>"query", "name"=>"CurrentApplicationVersionId", "description"=>"Version of the application to which you want add the output configuration", "type"=>"string"}, {"in"=>"query", "name"=>"Output", "description"=>"An array of objects, each describing one output configuration", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=AddApplicationReferenceDataSource"=>{"get"=>{"summary"=>"Add Application Reference Data Source", "description"=>"Adds a reference data source to an existing application.", "operationId"=>"addApplicationReferenceDataSource", "x-api-path-slug"=>"actionaddapplicationreferencedatasource-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"Name of an existing application", "type"=>"string"}, {"in"=>"query", "name"=>"CurrentApplicationVersionId", "description"=>"Version of the application for which you are adding the reference data source", "type"=>"string"}, {"in"=>"query", "name"=>"ReferenceDataSource", "description"=>"The reference data source can be an object in your Amazon S3 bucket", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=CreateApplication"=>{"get"=>{"summary"=>"Create Application", "description"=>"Creates an Amazon Kinesis Analytics application.", "operationId"=>"createApplication", "x-api-path-slug"=>"actioncreateapplication-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationCode", "description"=>"One or more SQL statements that read input data, transform it, and generate output", "type"=>"string"}, {"in"=>"query", "name"=>"ApplicationDescription", "description"=>"Summary description of the application", "type"=>"string"}, {"in"=>"query", "name"=>"ApplicationName", "description"=>"Name of your Amazon Kinesis Analytics application (for example, sample-app)", "type"=>"string"}, {"in"=>"query", "name"=>"Inputs", "description"=>"Use this parameter to configure the application input", "type"=>"string"}, {"in"=>"query", "name"=>"Outputs", "description"=>"You can configure application output to write data from any of the in-application streams to up to five destinations", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=DeleteApplication"=>{"get"=>{"summary"=>"Delete Application", "description"=>"Deletes the specified application.", "operationId"=>"deleteApplication", "x-api-path-slug"=>"actiondeleteapplication-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"Name of the Amazon Kinesis Analytics application to delete", "type"=>"string"}, {"in"=>"query", "name"=>"CreateTimestamp", "description"=>"You can use the DescribeApplication operation to get this value", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=DeleteApplicationOutput"=>{"get"=>{"summary"=>"Delete Application Output", "description"=>"Deletes output destination configuration from your application configuration.", "operationId"=>"deleteApplicationOutput", "x-api-path-slug"=>"actiondeleteapplicationoutput-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"Amazon Kinesis Analytics application name", "type"=>"string"}, {"in"=>"query", "name"=>"CurrentApplicationVersionId", "description"=>"Amazon Kinesis Analytics application version", "type"=>"string"}, {"in"=>"query", "name"=>"OutputId", "description"=>"The ID of the configuration to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=DeleteApplicationReferenceDataSource"=>{"get"=>{"summary"=>"Delete Application Reference Data Source", "description"=>"Deletes a reference data source configuration from the specified application configuration.", "operationId"=>"deleteApplicationReferenceDataSource", "x-api-path-slug"=>"actiondeleteapplicationreferencedatasource-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"Name of an existing application", "type"=>"string"}, {"in"=>"query", "name"=>"CurrentApplicationVersionId", "description"=>"Version of the application", "type"=>"string"}, {"in"=>"query", "name"=>"ReferenceId", "description"=>"ID of the reference data source", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=DescribeApplication"=>{"get"=>{"summary"=>"Describe Application", "description"=>"Returns information about a specific Amazon Kinesis Analytics application.", "operationId"=>"describeApplication", "x-api-path-slug"=>"actiondescribeapplication-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"Name of the application", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=DiscoverInputSchema"=>{"get"=>{"summary"=>"Discover Input Schema", "description"=>"Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream).", "operationId"=>"discoverInputSchema", "x-api-path-slug"=>"actiondiscoverinputschema-get", "parameters"=>[{"in"=>"query", "name"=>"InputStartingPositionConfiguration", "description"=>"Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceARN", "description"=>"Amazon Resource Name (ARN) of the streaming source", "type"=>"string"}, {"in"=>"query", "name"=>"RoleARN", "description"=>"ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Schema"]}}, "/?Action=ListApplications"=>{"get"=>{"summary"=>"List Applications", "description"=>"Returns a list of Amazon Kinesis Analytics applications in your account.", "operationId"=>"listApplications", "x-api-path-slug"=>"actionlistapplications-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=StartApplication"=>{"get"=>{"summary"=>"Start Application", "description"=>"Starts the specified Amazon Kinesis Analytics application.", "operationId"=>"startApplication", "x-api-path-slug"=>"actionstartapplication-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"Name of the application", "type"=>"string"}, {"in"=>"query", "name"=>"InputConfigurations", "description"=>"Identifies the specific input, by ID, that the application starts consuming", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=StopApplication"=>{"get"=>{"summary"=>"Stop Application", "description"=>"Stops the application from processing input data.", "operationId"=>"stopApplication", "x-api-path-slug"=>"actionstopapplication-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"Name of the running application to stop", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=UpdateApplication"=>{"get"=>{"summary"=>"Update Application", "description"=>"Updates an existing Amazon Kinesis Analytics application.", "operationId"=>"updateApplication", "x-api-path-slug"=>"actionupdateapplication-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"Name of the Amazon Kinesis Analytics application to update", "type"=>"string"}, {"in"=>"query", "name"=>"ApplicationUpdate", "description"=>"Describes application updates", "type"=>"string"}, {"in"=>"query", "name"=>"CurrentApplicationVersionId", "description"=>"The current application version ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-advisor{"azure-advisor-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Advisor", "x-complete"=>1, "info"=>{"title"=>"Azure Advisor API", "description"=>"azure-advisor-is-a-personalized-recommendation-engine-that-helps-you-follow-azure-best-practices--it-analyzes-your-azure-resource-configuration-and-usage-telemetry-then-provides-recommendations-that-can-reduce-costs-and-improve-the-performance-security-and-reliability-of-your-applications-", "version"=>"2017-04-19"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations"=>{"post"=>{"summary"=>"Generate Recommendations", "description"=>"Initiates the recommendation generation or computation process for a subscription. This operation is asynchronous. The generated recommendations are stored in a cache in the Advisor service.", "operationId"=>"Recommendations_Generate", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-advisorgeneraterecommendations-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recommendations"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations/{operationId}"=>{"get"=>{"summary"=>"Get Recommendation", "description"=>"Retrieves the status of the recommendation computation or generation process. Invoke this API after calling the generation recommendation. The URI of this API is returned in the Location field of the response header.", "operationId"=>"Recommendations_GetGenerateStatus", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-advisorgeneraterecommendationsoperationid-get", "parameters"=>[{"in"=>"path", "name"=>"operationId", "description"=>"The operation ID, which can be found from the Location field in the generate recommendation response header"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recommendations"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/recommendations"=>{"get"=>{"summary"=>"List Recommendations", "description"=>"Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.", "operationId"=>"Recommendations_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-advisorrecommendations-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply to the recommendations"}, {"in"=>"query", "name"=>"$skipToken", "description"=>"The page-continuation token to use with a paged version of this API"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of recommendations per page if a paged version of this API is being used"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recommendations"]}}, "/providers/Microsoft.Advisor/operations"=>{"get"=>{"summary"=>"List Operations", "description"=>"Lists all the available Advisor REST API operations.", "operationId"=>"Operations_List", "x-api-path-slug"=>"providersmicrosoft-advisoroperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operations"]}}, "/{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}"=>{"get"=>{"summary"=>"Get Suppressions", "description"=>"Obtains the details of a suppression.", "operationId"=>"Suppressions_Get", "x-api-path-slug"=>"resourceuriprovidersmicrosoft-advisorrecommendationsrecommendationidsuppressionsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the suppression"}, {"in"=>"path", "name"=>"recommendationId", "description"=>"The recommendation ID"}, {"in"=>"path", "name"=>"resourceUri", "description"=>"The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suppressions"]}, "put"=>{"summary"=>"Create Suppressions", "description"=>"Enables the snoozed or dismissed attribute of a recommendation. The snoozed or dismissed attribute is referred to as a suppression. Use this API to create or update the snoozed or dismissed status of a recommendation.", "operationId"=>"Suppressions_Create", "x-api-path-slug"=>"resourceuriprovidersmicrosoft-advisorrecommendationsrecommendationidsuppressionsname-put", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the suppression"}, {"in"=>"path", "name"=>"recommendationId", "description"=>"The recommendation ID"}, {"in"=>"path", "name"=>"resourceUri", "description"=>"The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies"}, {"in"=>"body", "name"=>"suppressionContract", "description"=>"The snoozed or dismissed attribute; for example, the snooze duration", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suppressions"]}, "delete"=>{"summary"=>"Delete Suppressions", "description"=>"Enables the activation of a snoozed or dismissed recommendation. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.", "operationId"=>"Suppressions_Delete", "x-api-path-slug"=>"resourceuriprovidersmicrosoft-advisorrecommendationsrecommendationidsuppressionsname-delete", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the suppression"}, {"in"=>"path", "name"=>"recommendationId", "description"=>"The recommendation ID"}, {"in"=>"path", "name"=>"resourceUri", "description"=>"The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suppressions"]}}, "/{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}"=>{"get"=>{"summary"=>"Get Recommendations", "description"=>"Obtains details of a cached recommendation.", "operationId"=>"Recommendations_Get", "x-api-path-slug"=>"resourceuriprovidersmicrosoft-advisorrecommendationsrecommendationid-get", "parameters"=>[{"in"=>"path", "name"=>"recommendationId", "description"=>"The recommendation ID"}, {"in"=>"path", "name"=>"resourceUri", "description"=>"The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recommendations"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/suppressions"=>{"get"=>{"summary"=>"List Suppressions", "description"=>"Retrieves the list of snoozed or dismissed suppressions for a subscription. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.", "operationId"=>"Suppressions_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-advisorsuppressions-get", "parameters"=>[{"in"=>"query", "name"=>"$skipToken", "description"=>"The page-continuation token to use with a paged version of this API"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of suppressions per page if a paged version of this API is being used"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suppressions"]}}}}, "apis"=>{"name"=>"Azure Advisor", "x-slug"=>"azure-advisor", "description"=>"Azure Advisor is a personalized recommendation engine that helps you follow Azure best practices. It analyzes your Azure resource configuration and usage telemetry, then provides recommendations that can reduce costs and improve the performance, security, and reliability of your applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/improve-what-matters.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Best Practices,Microsoft,Performance,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-advisor/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Advisor API", "x-api-slug"=>"azure-advisor-api", "description"=>"Azure Advisor is a personalized recommendation engine that helps you follow Azure best practices. It analyzes your Azure resource configuration and usage telemetry, then provides recommendations that can reduce costs and improve the performance, security, and reliability of your applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/improve-what-matters.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/advisor/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Best Practices,Microsoft,Performance,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/azure-advisor/azure-advisor-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/advisor/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/advisor/"}, {"type"=>"x-regions", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/advisor/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/advisor/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
auth0{"auth0-users-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Auth0", "x-complete"=>1, "info"=>{"title"=>"Auth0 Users API", "version"=>"v1"}, "host"=>"login.auth0.com", "basePath"=>"/users", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/v2/users"=>{"delete"=>{"summary"=>"Deletes all users.", "description"=>"Deletes all users. use with caution.", "operationId"=>"delete_users", "x-api-path-slug"=>"apiv2users-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "get"=>{"summary"=>"Gets all users who have logged in.", "description"=>"Gets all users who have logged in..", "operationId"=>"get_users", "x-api-path-slug"=>"apiv2users-get", "parameters"=>[{"in"=>"query", "name"=>"connection", "description"=>"Connection filter"}, {"in"=>"query", "name"=>"exclude_fields", "description"=>"true if the fields specified are to be excluded from the result, false otherwise"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma separated list of fields to include or exclude (depending on exclude_fields) from the result"}, {"in"=>"query", "name"=>"include_totals", "description"=>"true if a query summary must be included in the result"}, {"in"=>"query", "name"=>"page", "description"=>"The page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"The amount of entries per page"}, {"in"=>"query", "name"=>"sort", "description"=>"The field to use for sorting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "post"=>{"summary"=>"Creates a user.", "description"=>"Creates a user..", "operationId"=>"post_users", "x-api-path-slug"=>"apiv2users-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/api/v2/users/{id}"=>{"delete"=>{"summary"=>"Deletes a user.", "description"=>"Deletes a user..", "operationId"=>"delete_users_by_id", "x-api-path-slug"=>"apiv2usersid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The user_id of the user to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Id"]}, "get"=>{"summary"=>"Gets a user.", "description"=>"Gets a user..", "operationId"=>"get_users_by_id", "x-api-path-slug"=>"apiv2usersid-get", "parameters"=>[{"in"=>"query", "name"=>"exclude_fields", "description"=>"true if the fields specified are to be excluded from the result, false otherwise"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma separated list of fields to include or exclude (depending on exclude_fields) from the result"}, {"in"=>"path", "name"=>"id", "description"=>"The user_id of the user to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Id"]}, "patch"=>{"summary"=>"Updates a user.", "description"=>"Updates a user..", "operationId"=>"patch_users_by_id", "x-api-path-slug"=>"apiv2usersid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The user_id of the user to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Id"]}}, "/api/v2/users/{id}/multifactor/{provider}"=>{"delete"=>{"summary"=>"Deletes a multifactor provider for a user.", "description"=>"Deletes a multifactor provider for a user..", "operationId"=>"delete_multifactor_by_provider", "x-api-path-slug"=>"apiv2usersidmultifactorprovider-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The user_id of the user to delete"}, {"in"=>"path", "name"=>"provider", "description"=>"The multifactor provider"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Id", "Multifactor", "Provider"]}}}}, "auth0-stats-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Auth0", "x-complete"=>1, "info"=>{"title"=>"Auth0 Stats API", "version"=>"v1"}, "host"=>"login.auth0.com", "basePath"=>"/stats", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/v2/stats/active-users"=>{"get"=>{"summary"=>"Get Active Users", "description"=>"Gets the active users count (logged in during the last 30 days).", "operationId"=>"get_active-users", "x-api-path-slug"=>"apiv2statsactiveusers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Active", "Users"]}}, "/api/v2/stats/daily"=>{"get"=>{"summary"=>"Get Daily Stats", "description"=>"Gets the daily stats for a particular period.", "operationId"=>"get_daily", "x-api-path-slug"=>"apiv2statsdaily-get", "parameters"=>[{"in"=>"query", "name"=>"from", "description"=>"The first day of the period (inclusive) in YYYYMMDD format"}, {"in"=>"query", "name"=>"to", "description"=>"The last day of the period (inclusive) in YYYYMMDD format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stats", "Daily"]}}}}, "auth0-blacklists-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Auth0", "x-complete"=>1, "info"=>{"title"=>"Auth0 Blacklists API", "version"=>"v1"}, "host"=>"login.auth0.com", "basePath"=>"/blacklists", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/v2/blacklists/tokens"=>{"get"=>{"summary"=>"Get Blacklists Tokens", "description"=>"Get blacklists tokens.", "operationId"=>"get_tokens", "x-api-path-slug"=>"apiv2blackliststokens-get", "parameters"=>[{"in"=>"query", "name"=>"aud", "description"=>"The JWTs aud claim"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blacklists", "Tokens"]}, "post"=>{"summary"=>"Post Blacklists Tokens", "description"=>"Post blacklists tokens.", "operationId"=>"post_tokens", "x-api-path-slug"=>"apiv2blackliststokens-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blacklists", "Tokens"]}}}}, "auth0-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Auth0", "x-complete"=>1, "info"=>{"title"=>"Auth0 API", "description"=>"auth0-exposes-two-apis-for-developers-to-consume-in-their-applications-", "version"=>"1.0.0"}, "host"=>"login.auth0.com", "basePath"=>"api/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/blacklists/tokens"=>{"get"=>{"summary"=>"Get Blacklists Tokens", "description"=>"Get blacklists tokens.", "operationId"=>"getBlacklistsTokens", "x-api-path-slug"=>"blackliststokens-get", "parameters"=>[{"in"=>"query", "name"=>"aud", "description"=>"The JWTs aud claim"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blacklists", "Tokens"]}, "post"=>{"summary"=>"Post Blacklists Tokens", "description"=>"Post blacklists tokens.", "operationId"=>"postBlacklistsTokens", "x-api-path-slug"=>"blackliststokens-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blacklists", "Tokens"]}}, "/clients"=>{"get"=>{"summary"=>"Get Clients", "description"=>"Get clients.", "operationId"=>"getClients", "x-api-path-slug"=>"clients-get", "parameters"=>[{"in"=>"query", "name"=>"exclude_fields", "description"=>"true if the fields specified are to be excluded from the result, false otherwise"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma separated list of fields to include or exclude (depending on exclude_fields) from the result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clients"]}, "post"=>{"summary"=>"Post Clients", "description"=>"Post clients.", "operationId"=>"postClients", "x-api-path-slug"=>"clients-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clients"]}}, "/clients/{id}"=>{"delete"=>{"summary"=>"Delete Clients", "description"=>"Delete clients.", "operationId"=>"deleteClients", "x-api-path-slug"=>"clientsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The client_id of the client to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clients"]}, "get"=>{"summary"=>"Get Clients", "description"=>"Get clients.", "operationId"=>"getClients", "x-api-path-slug"=>"clientsid-get", "parameters"=>[{"in"=>"query", "name"=>"exclude_fields", "description"=>"true if the fields specified are to be excluded from the result, false otherwise"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma separated list of fields to include or exclude (depending on exclude_fields) from the result"}, {"in"=>"path", "name"=>"id", "description"=>"The client_id of the client to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clients"]}, "patch"=>{"summary"=>"Patch Clients", "description"=>"Patch clients.", "operationId"=>"patchClients", "x-api-path-slug"=>"clientsid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The client_id of the client to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clients"]}}, "/jobs/users-imports"=>{"post"=>{"summary"=>"Post Jobs Users Imports", "description"=>"Post jobs users imports.", "operationId"=>"postJobsUsersImports", "x-api-path-slug"=>"jobsusersimports-post", "parameters"=>[{"in"=>"form", "name"=>"connection_name", "description"=>"The name of the connection to which users will be added"}, {"in"=>"form", "name"=>"users", "description"=>"A file containing the users to import"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs", "Immports"]}}, "/jobs/{job_id}"=>{"get"=>{"summary"=>"Get Jobs Job", "description"=>"Get jobs job.", "operationId"=>"getJobsJob", "x-api-path-slug"=>"jobsjob-id-get", "parameters"=>[{"in"=>"path", "name"=>"job_id", "description"=>"The id of the job"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/stats/active-users"=>{"get"=>{"summary"=>"Get Stats Active Users", "description"=>"Get stats active users.", "operationId"=>"getStatsActiveUsers", "x-api-path-slug"=>"statsactiveusers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Statistics"]}}, "/stats/daily"=>{"get"=>{"summary"=>"Get Stats Daily", "description"=>"Get stats daily.", "operationId"=>"getStatsDaily", "x-api-path-slug"=>"statsdaily-get", "parameters"=>[{"in"=>"query", "name"=>"from", "description"=>"The first day of the period (inclusive) in YYYYMMDD format"}, {"in"=>"query", "name"=>"to", "description"=>"The last day of the period (inclusive) in YYYYMMDD format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Statistics", "Daily"]}}, "/users"=>{"delete"=>{"summary"=>"Delete Users", "description"=>"Delete users.", "operationId"=>"deleteUsers", "x-api-path-slug"=>"users-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "get"=>{"summary"=>"Get Users", "description"=>"Get users.", "operationId"=>"getUsers", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"query", "name"=>"connection", "description"=>"Connection filter"}, {"in"=>"query", "name"=>"exclude_fields", "description"=>"true if the fields specified are to be excluded from the result, false otherwise"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma separated list of fields to include or exclude (depending on exclude_fields) from the result"}, {"in"=>"query", "name"=>"include_totals", "description"=>"true if a query summary must be included in the result"}, {"in"=>"query", "name"=>"page", "description"=>"The page number"}, {"in"=>"query", "name"=>"per_page", "description"=>"The amount of entries per page"}, {"in"=>"query", "name"=>"sort", "description"=>"The field to use for sorting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "post"=>{"summary"=>"Post Users", "description"=>"Post users.", "operationId"=>"postUsers", "x-api-path-slug"=>"users-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/{id}"=>{"delete"=>{"summary"=>"Delete Users", "description"=>"Delete users.", "operationId"=>"deleteUsers", "x-api-path-slug"=>"usersid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The user_id of the user to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "get"=>{"summary"=>"Get Users", "description"=>"Get users.", "operationId"=>"getUsers", "x-api-path-slug"=>"usersid-get", "parameters"=>[{"in"=>"query", "name"=>"exclude_fields", "description"=>"true if the fields specified are to be excluded from the result, false otherwise"}, {"in"=>"query", "name"=>"fields", "description"=>"A comma separated list of fields to include or exclude (depending on exclude_fields) from the result"}, {"in"=>"path", "name"=>"id", "description"=>"The user_id of the user to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}, "patch"=>{"summary"=>"Patch Users", "description"=>"Patch users.", "operationId"=>"patchUsers", "x-api-path-slug"=>"usersid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The user_id of the user to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/users/{id}/multifactor/{provider}"=>{"delete"=>{"summary"=>"Delete Users Multifactor Prover", "description"=>"Delete users multifactor prover.", "operationId"=>"deleteUsersMultifactorProver", "x-api-path-slug"=>"usersidmultifactorprovider-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The user_id of the user to delete"}, {"in"=>"path", "name"=>"provider", "description"=>"The multifactor provider"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}}}, "auth0-jobs-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Auth0", "x-complete"=>1, "info"=>{"title"=>"Auth0 Jobs API", "version"=>"v1"}, "host"=>"login.auth0.com", "basePath"=>"/jobs", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/v2/jobs/users-imports"=>{"post"=>{"summary"=>"Jobs Users Imports", "description"=>"jobs users imports.", "operationId"=>"post_users-imports", "x-api-path-slug"=>"apiv2jobsusersimports-post", "parameters"=>[{"in"=>"form", "name"=>"connection_name", "description"=>"The name of the connection to which users will be added"}, {"in"=>"form", "name"=>"users", "description"=>"A file containing the users to import"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs", "Users", "Imports"]}}, "/api/v2/jobs/{job_id}"=>{"get"=>{"summary"=>"Jobs Job", "description"=>"jobs job.", "operationId"=>"get_jobs_by_job_id", "x-api-path-slug"=>"apiv2jobsjob-id-get", "parameters"=>[{"in"=>"path", "name"=>"job_id", "description"=>"The id of the job"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}}}, "apis"=>{"name"=>"Auth0", "x-slug"=>"auth0", "description"=>"The new way to solve Identity", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11272-auth0.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"4820", "tags"=>"API Service Provider,Authentication,Authentication,Enterprise,Identities,OAuth,Profiles,Relative Data,SaaS,Service API,Service Level Agreement,Stack Network,Target,Technology,Users", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"auth0/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Auth0 API", "x-api-slug"=>"auth0-api", "description"=>"The new way to solve Identity", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11272-auth0.jpg", "humanURL"=>"https://auth0.com/", "baseURL"=>"https://login.auth0.com/api/v2/", "tags"=>"API Service Provider,Authentication,Authentication,Enterprise,Identities,OAuth,Profiles,Relative Data,SaaS,Service API,Service Level Agreement,Stack Network,Target,Technology,Users", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/auth0/auth0-api-openapi.yaml"}]}, {"name"=>"Auth0 Blacklists API", "x-api-slug"=>"auth0-blacklists-api", "description"=>"The new way to solve Identity", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11272-auth0.jpg", "humanURL"=>"https://auth0.com/", "baseURL"=>"https://login.auth0.com//blacklists", "tags"=>"Users", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/auth0/auth0-blacklists-api-openapi.yaml"}]}, {"name"=>"Auth0 Jobs API", "x-api-slug"=>"auth0-jobs-api", "description"=>"The new way to solve Identity", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11272-auth0.jpg", "humanURL"=>"https://auth0.com/", "baseURL"=>"https://login.auth0.com//jobs", "tags"=>"Blacklists,Tokens", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/auth0/apiv2jobsjob-id-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/auth0/auth0-jobs-api-openapi.yaml"}]}, {"name"=>"Auth0 Stats API", "x-api-slug"=>"auth0-stats-api", "description"=>"The new way to solve Identity", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11272-auth0.jpg", "humanURL"=>"https://auth0.com/", "baseURL"=>"https://login.auth0.com//stats", "tags"=>"Jobs", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/auth0/apiv2statsdaily-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/auth0/auth0-stats-api-openapi.yaml"}]}, {"name"=>"Auth0 Users API", "x-api-slug"=>"auth0-users-api", "description"=>"The new way to solve Identity", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11272-auth0.jpg", "humanURL"=>"https://auth0.com/", "baseURL"=>"https://login.auth0.com//users", "tags"=>"Stats,Daily", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/auth0/auth0-users-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://auth0.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"http://feeds.feedburner.com/auth0"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/auth0"}, {"type"=>"x-developer", "url"=>"https://auth0.com/docs/apiv2"}, {"type"=>"x-email", "url"=>"privacy@auth0.com"}, {"type"=>"x-email", "url"=>"legal@auth0.com"}, {"type"=>"x-email", "url"=>"ricky@auth0.com"}, {"type"=>"x-github", "url"=>"https://github.com/auth0"}, {"type"=>"x-pricing", "url"=>"https://auth0.com/pricing"}, {"type"=>"x-service-level-agreement", "url"=>"https://auth0.com/docs/sla"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/authzero"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/auth0"}, {"type"=>"x-website", "url"=>"https://auth0.com/"}, {"type"=>"x-website", "url"=>"http://auth0.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-container-builder{"google-cloud-container-builder-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Container Builder", "x-complete"=>1, "info"=>{"title"=>"Google Cloud Container Builder", "description"=>"builds-container-images-in-the-cloud-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"cloudbuild.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/projects/{projectId}/builds"=>{"get"=>{"summary"=>"Get Builds", "description"=>"Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully.", "operationId"=>"cloudbuild.projects.builds.list", "x-api-path-slug"=>"v1projectsprojectidbuilds-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"The raw filter text to constrain the results"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Number of results to return in the list"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token to provide to skip to a particular spot in the list"}, {"in"=>"path", "name"=>"projectId", "description"=>"ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Build"]}, "post"=>{"summary"=>"Starts Build", "description"=>"Starts a build with the specified configuration.\n\nThe long-running Operation returned by this method will include the ID of\nthe build, which can be passed to GetBuild to determine its status (e.g.,\nsuccess or failure).", "operationId"=>"cloudbuild.projects.builds.create", "x-api-path-slug"=>"v1projectsprojectidbuilds-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Build"]}}, "/v1/projects/{projectId}/builds/{id}"=>{"get"=>{"summary"=>"Get Build", "description"=>"Returns information about a previously requested build.\n\nThe Build that is returned includes its status (e.g., success or failure,\nor in-progress), and timing information.", "operationId"=>"cloudbuild.projects.builds.get", "x-api-path-slug"=>"v1projectsprojectidbuildsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the build"}, {"in"=>"path", "name"=>"projectId", "description"=>"ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Build"]}}, "/v1/projects/{projectId}/builds/{id}:cancel"=>{"post"=>{"summary"=>"Cancel Build", "description"=>"Cancels a requested build in progress.", "operationId"=>"cloudbuild.projects.builds.cancel", "x-api-path-slug"=>"v1projectsprojectidbuildsidcancel-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of the build"}, {"in"=>"path", "name"=>"projectId", "description"=>"ID of the project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Build"]}}, "/v1/projects/{projectId}/triggers"=>{"get"=>{"summary"=>"Get Build Triggers", "description"=>"Lists existing BuildTrigger.\n\nThis API is experimental.", "operationId"=>"cloudbuild.projects.triggers.list", "x-api-path-slug"=>"v1projectsprojectidtriggers-get", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"ID of the project for which to list BuildTriggers"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trigger"]}, "post"=>{"summary"=>"Create Build Trigger", "description"=>"Creates a new BuildTrigger.\n\nThis API is experimental.", "operationId"=>"cloudbuild.projects.triggers.create", "x-api-path-slug"=>"v1projectsprojectidtriggers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"ID of the project for which to configure automatic builds"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trigger"]}}, "/v1/projects/{projectId}/triggers/{triggerId}"=>{"delete"=>{"summary"=>"Delete Build Trigger", "description"=>"Deletes an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.", "operationId"=>"cloudbuild.projects.triggers.delete", "x-api-path-slug"=>"v1projectsprojectidtriggerstriggerid-delete", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"ID of the project that owns the trigger"}, {"in"=>"path", "name"=>"triggerId", "description"=>"ID of the BuildTrigger to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trigger"]}, "get"=>{"summary"=>"Get Build Trigger", "description"=>"Gets information about a BuildTrigger.\n\nThis API is experimental.", "operationId"=>"cloudbuild.projects.triggers.get", "x-api-path-slug"=>"v1projectsprojectidtriggerstriggerid-get", "parameters"=>[{"in"=>"path", "name"=>"projectId", "description"=>"ID of the project that owns the trigger"}, {"in"=>"path", "name"=>"triggerId", "description"=>"ID of the BuildTrigger to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trigger"]}, "patch"=>{"summary"=>"Update Build Trigger", "description"=>"Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.", "operationId"=>"cloudbuild.projects.triggers.patch", "x-api-path-slug"=>"v1projectsprojectidtriggerstriggerid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"ID of the project that owns the trigger"}, {"in"=>"path", "name"=>"triggerId", "description"=>"ID of the BuildTrigger to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trigger"]}}, "/v1/{name}"=>{"get"=>{"summary"=>"Get Operation State", "description"=>"Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", "operationId"=>"cloudbuild.operations.get", "x-api-path-slug"=>"v1name-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the operation resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1/{name}:cancel"=>{"post"=>{"summary"=>"Cancel Operation", "description"=>"Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", "operationId"=>"cloudbuild.operations.cancel", "x-api-path-slug"=>"v1namecancel-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The name of the operation resource to be cancelled"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}}}, "apis"=>{"name"=>"Google Cloud Container Builder", "x-slug"=>"google-cloud-container-builder", "description"=>"Google Cloud Container Builder lets you create Docker container images from application source code located in Google Cloud Storage. Container images created by Container Builder are automatically stored in Google Container Registry. You can deploy the container images you create on Google Container Engine, Google Compute Engine, Google App Engine flexible environment or other services where you can run applications from Docker containers.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/container-builder-lead.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Containers,Deployments,Google APIs,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-container-builder/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Container Builder API", "x-api-slug"=>"google-cloud-container-builder-api", "description"=>"Google Cloud Container Builder lets you create Docker container images from application source code located in Google Cloud Storage. Container images created by Container Builder are automatically stored in Google Container Registry. You can deploy the container images you create on Google Container Engine, Google Compute Engine, Google App Engine flexible environment or other services where you can run applications from Docker containers.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/container-builder-lead.png", "humanURL"=>"https://cloud.google.com/container-builder/", "baseURL"=>"://cloudbuild.googleapis.com//", "tags"=>"API Provider,API Service Provider,Containers,Deployments,Google APIs,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-container-builder/google-cloud-container-builder-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://cloud.google.com/container-builder/docs/"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/container-builder/pricing"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/container-builder/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-pagespeed-insights{"google-pagespeed-insights-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google PageSpeed Insights", "x-complete"=>1, "info"=>{"title"=>"PageSpeed Insights", "description"=>"analyzes-the-performance-of-a-web-page-and-provides-tailored-suggestions-to-make-that-page-faster-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v2"}, "host"=>"www.googleapis.com", "basePath"=>"/pagespeedonline/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/runPagespeed"=>{"get"=>{"summary"=>"Run PageSpeed Analysis", "description"=>"Runs PageSpeed analysis on the page at the specified URL, and returns PageSpeed scores, a list of suggestions to make that page faster, and other information.", "operationId"=>"pagespeedonline.pagespeedapi.runpagespeed", "x-api-path-slug"=>"runpagespeed-get", "parameters"=>[{"in"=>"query", "name"=>"filter_third_party_resources", "description"=>"Indicates if third party resources should be filtered out before PageSpeed analysis"}, {"in"=>"query", "name"=>"locale", "description"=>"The locale used to localize formatted results"}, {"in"=>"query", "name"=>"rule", "description"=>"A PageSpeed rule to run; if none are given, all rules are run"}, {"in"=>"query", "name"=>"screenshot", "description"=>"Indicates if binary data containing a screenshot should be included"}, {"in"=>"query", "name"=>"strategy", "description"=>"The analysis strategy to use"}, {"in"=>"query", "name"=>"url", "description"=>"The URL to fetch and analyze"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages", "Speed", "Analysis"]}}}}, "apis"=>{"name"=>"Google PageSpeed Insights", "x-slug"=>"google-pagespeed-insights", "description"=>"Page Speed Insights measures the performance of a page for mobile devices and desktop devices. It fetches the url twice, once with a mobile user-agent, and once with a desktop-user agent. The PageSpeed Score ranges from 0 to 100 points. A higher score is better and a score of 85 or above indicates that the page is performing well. Please note that PageSpeed Insights is being continually improved and so the score will change as we add new rules or improve our analysis.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/54de5c09d56ec853cc9310e1.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Performance,Profiles,Relative Data,Service API,Stack Network,Websites", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-pagespeed-insights/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google PageSpeed Insights API", "x-api-slug"=>"google-pagespeed-insights-api", "description"=>"Page Speed Insights measures the performance of a page for mobile devices and desktop devices. It fetches the url twice, once with a mobile user-agent, and once with a desktop-user agent. The PageSpeed Score ranges from 0 to 100 points. A higher score is better and a score of 85 or above indicates that the page is performing well. Please note that PageSpeed Insights is being continually improved and so the score will change as we add new rules or improve our analysis.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/54de5c09d56ec853cc9310e1.png", "humanURL"=>"https://developers.google.com/speed/docs/insights/about", "baseURL"=>"://www.googleapis.com//pagespeedonline/v2", "tags"=>"API Provider,API Service Provider,Google APIs,Performance,Profiles,Relative Data,Service API,Stack Network,Websites", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/google-pagespeed-insights/runpagespeed-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/google-pagespeed-insights/google-pagespeed-insights-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-logs", "url"=>"https://developers.google.com/speed/docs/insights/release_notes"}, {"type"=>"x-getting-started", "url"=>"https://developers.google.com/speed/docs/insights/v2/getting-started"}, {"type"=>"x-website", "url"=>"https://developers.google.com/speed/docs/insights/about"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
blogger{"blogger-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Blogger", "x-complete"=>1, "info"=>{"title"=>"Blogger", "description"=>"api-for-access-to-the-data-within-blogger-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v3"}, "host"=>"www.googleapis.com", "basePath"=>"/blogger/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/blogs/byurl"=>{"get"=>{"summary"=>"Get Blog by URL", "description"=>"Retrieve a Blog by URL.", "operationId"=>"blogger.blogs.getByUrl", "x-api-path-slug"=>"blogsbyurl-get", "parameters"=>[{"in"=>"query", "name"=>"url", "description"=>"The URL of the blog to retrieve"}, {"in"=>"query", "name"=>"view", "description"=>"Access level with which to view the blog"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog"]}}, "/blogs/{blogId}"=>{"get"=>{"summary"=>"Get Blog", "description"=>"Gets one blog by ID.", "operationId"=>"blogger.blogs.get", "x-api-path-slug"=>"blogsblogid-get", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the blog to get"}, {"in"=>"query", "name"=>"maxPosts", "description"=>"Maximum number of posts to pull back with the blog"}, {"in"=>"query", "name"=>"view", "description"=>"Access level with which to view the blog"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog"]}}, "/blogs/{blogId}/comments"=>{"get"=>{"summary"=>"Get Blog Comments", "description"=>"Retrieves the comments for a blog, across all posts, possibly filtered.", "operationId"=>"blogger.comments.listByBlog", "x-api-path-slug"=>"blogsblogidcomments-get", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"ID of the blog to fetch comments from"}, {"in"=>"query", "name"=>"endDate", "description"=>"Latest date of comment to fetch, a date-time with RFC 3339 formatting"}, {"in"=>"query", "name"=>"fetchBodies", "description"=>"Whether the body content of the comments is included"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of comments to include in the result"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Continuation token if request is paged"}, {"in"=>"query", "name"=>"startDate", "description"=>"Earliest date of comment to fetch, a date-time with RFC 3339 formatting"}, {"in"=>"query", "name"=>"status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog Comment"]}}, "/blogs/{blogId}/pages"=>{"get"=>{"summary"=>"Get Blog Pages", "description"=>"Retrieves the pages for a blog, optionally including non-LIVE statuses.", "operationId"=>"blogger.pages.list", "x-api-path-slug"=>"blogsblogidpages-get", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"ID of the blog to fetch Pages from"}, {"in"=>"query", "name"=>"fetchBodies", "description"=>"Whether to retrieve the Page bodies"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of Pages to fetch"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Continuation token if the request is paged"}, {"in"=>"query", "name"=>"status"}, {"in"=>"query", "name"=>"view", "description"=>"Access level with which to view the returned result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page"]}, "post"=>{"summary"=>"Add Blog Page", "description"=>"Add a page.", "operationId"=>"blogger.pages.insert", "x-api-path-slug"=>"blogsblogidpages-post", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"ID of the blog to add the page to"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"isDraft", "description"=>"Whether to create the page as a draft (default: false)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page"]}}, "/blogs/{blogId}/pages/{pageId}"=>{"delete"=>{"summary"=>"Delete Blog Page", "description"=>"Delete a page by ID.", "operationId"=>"blogger.pages.delete", "x-api-path-slug"=>"blogsblogidpagespageid-delete", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the Blog"}, {"in"=>"path", "name"=>"pageId", "description"=>"The ID of the Page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page"]}, "get"=>{"summary"=>"Get Blog Page", "description"=>"Gets one blog page by ID.", "operationId"=>"blogger.pages.get", "x-api-path-slug"=>"blogsblogidpagespageid-get", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"ID of the blog containing the page"}, {"in"=>"path", "name"=>"pageId", "description"=>"The ID of the page to get"}, {"in"=>"query", "name"=>"view"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page"]}, "patch"=>{"summary"=>"Update Blog Page", "description"=>"Update a page. This method supports patch semantics.", "operationId"=>"blogger.pages.patch", "x-api-path-slug"=>"blogsblogidpagespageid-patch", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the Blog"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"pageId", "description"=>"The ID of the Page"}, {"in"=>"query", "name"=>"publish", "description"=>"Whether a publish action should be performed when the page is updated (default: false)"}, {"in"=>"query", "name"=>"revert", "description"=>"Whether a revert action should be performed when the page is updated (default: false)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page"]}, "put"=>{"summary"=>"Update Blog Page", "description"=>"Update a page.", "operationId"=>"blogger.pages.update", "x-api-path-slug"=>"blogsblogidpagespageid-put", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the Blog"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"pageId", "description"=>"The ID of the Page"}, {"in"=>"query", "name"=>"publish", "description"=>"Whether a publish action should be performed when the page is updated (default: false)"}, {"in"=>"query", "name"=>"revert", "description"=>"Whether a revert action should be performed when the page is updated (default: false)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page"]}}, "/blogs/{blogId}/pages/{pageId}/publish"=>{"post"=>{"summary"=>"Publish Blog Page", "description"=>"Publishes a draft page.", "operationId"=>"blogger.pages.publish", "x-api-path-slug"=>"blogsblogidpagespageidpublish-post", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the blog"}, {"in"=>"path", "name"=>"pageId", "description"=>"The ID of the page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page"]}}, "/blogs/{blogId}/pages/{pageId}/revert"=>{"post"=>{"summary"=>"Revert Blog Page", "description"=>"Revert a published or scheduled page to draft state.", "operationId"=>"blogger.pages.revert", "x-api-path-slug"=>"blogsblogidpagespageidrevert-post", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the blog"}, {"in"=>"path", "name"=>"pageId", "description"=>"The ID of the page"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page"]}}, "/blogs/{blogId}/pageviews"=>{"get"=>{"summary"=>"Get Blog Page Views", "description"=>"Retrieve pageview stats for a Blog.", "operationId"=>"blogger.pageViews.get", "x-api-path-slug"=>"blogsblogidpageviews-get", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the blog to get"}, {"in"=>"query", "name"=>"range"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Page Views"]}}, "/blogs/{blogId}/posts"=>{"get"=>{"summary"=>"Get Blog Posts", "description"=>"Retrieves a list of posts, possibly filtered.", "operationId"=>"blogger.posts.list", "x-api-path-slug"=>"blogsblogidposts-get", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"ID of the blog to fetch posts from"}, {"in"=>"query", "name"=>"endDate", "description"=>"Latest post date to fetch, a date-time with RFC 3339 formatting"}, {"in"=>"query", "name"=>"fetchBodies", "description"=>"Whether the body content of posts is included (default: true)"}, {"in"=>"query", "name"=>"fetchImages", "description"=>"Whether image URL metadata for each post is included"}, {"in"=>"query", "name"=>"labels", "description"=>"Comma-separated list of labels to search for"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of posts to fetch"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sort search results"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Continuation token if the request is paged"}, {"in"=>"query", "name"=>"startDate", "description"=>"Earliest post date to fetch, a date-time with RFC 3339 formatting"}, {"in"=>"query", "name"=>"status", "description"=>"Statuses to include in the results"}, {"in"=>"query", "name"=>"view", "description"=>"Access level with which to view the returned result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog Post"]}, "post"=>{"summary"=>"Add Blog Post", "description"=>"Add a post.", "operationId"=>"blogger.posts.insert", "x-api-path-slug"=>"blogsblogidposts-post", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"ID of the blog to add the post to"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fetchBody", "description"=>"Whether the body content of the post is included with the result (default: true)"}, {"in"=>"query", "name"=>"fetchImages", "description"=>"Whether image URL metadata for each post is included in the returned result (default: false)"}, {"in"=>"query", "name"=>"isDraft", "description"=>"Whether to create the post as a draft (default: false)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog Post"]}}, "/blogs/{blogId}/posts/bypath"=>{"get"=>{"summary"=>"Get Blog Post by Path", "description"=>"Retrieve a Post by Path.", "operationId"=>"blogger.posts.getByPath", "x-api-path-slug"=>"blogsblogidpostsbypath-get", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"ID of the blog to fetch the post from"}, {"in"=>"query", "name"=>"maxComments", "description"=>"Maximum number of comments to pull back on a post"}, {"in"=>"query", "name"=>"path", "description"=>"Path of the Post to retrieve"}, {"in"=>"query", "name"=>"view", "description"=>"Access level with which to view the returned result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog Post"]}}, "/blogs/{blogId}/posts/search"=>{"get"=>{"summary"=>"Search Blog Post", "description"=>"Search for a post.", "operationId"=>"blogger.posts.search", "x-api-path-slug"=>"blogsblogidpostssearch-get", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"ID of the blog to fetch the post from"}, {"in"=>"query", "name"=>"fetchBodies", "description"=>"Whether the body content of posts is included (default: true)"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sort search results"}, {"in"=>"query", "name"=>"q", "description"=>"Query terms to search this blog for matching posts"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog Search"]}}, "/blogs/{blogId}/posts/{postId}"=>{"delete"=>{"summary"=>"Delete Blog Post", "description"=>"Delete a post by ID.", "operationId"=>"blogger.posts.delete", "x-api-path-slug"=>"blogsblogidpostspostid-delete", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the Blog"}, {"in"=>"path", "name"=>"postId", "description"=>"The ID of the Post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog Post"]}, "get"=>{"summary"=>"Get Blog Post", "description"=>"Get a post by ID.", "operationId"=>"blogger.posts.get", "x-api-path-slug"=>"blogsblogidpostspostid-get", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"ID of the blog to fetch the post from"}, {"in"=>"query", "name"=>"fetchBody", "description"=>"Whether the body content of the post is included (default: true)"}, {"in"=>"query", "name"=>"fetchImages", "description"=>"Whether image URL metadata for each post is included (default: false)"}, {"in"=>"query", "name"=>"maxComments", "description"=>"Maximum number of comments to pull back on a post"}, {"in"=>"path", "name"=>"postId", "description"=>"The ID of the post"}, {"in"=>"query", "name"=>"view", "description"=>"Access level with which to view the returned result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog Post"]}, "patch"=>{"summary"=>"Update Blog Post", "description"=>"Update a post. This method supports patch semantics.", "operationId"=>"blogger.posts.patch", "x-api-path-slug"=>"blogsblogidpostspostid-patch", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the Blog"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fetchBody", "description"=>"Whether the body content of the post is included with the result (default: true)"}, {"in"=>"query", "name"=>"fetchImages", "description"=>"Whether image URL metadata for each post is included in the returned result (default: false)"}, {"in"=>"query", "name"=>"maxComments", "description"=>"Maximum number of comments to retrieve with the returned post"}, {"in"=>"path", "name"=>"postId", "description"=>"The ID of the Post"}, {"in"=>"query", "name"=>"publish", "description"=>"Whether a publish action should be performed when the post is updated (default: false)"}, {"in"=>"query", "name"=>"revert", "description"=>"Whether a revert action should be performed when the post is updated (default: false)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog Post"]}, "put"=>{"summary"=>"Update Blog Post", "description"=>"Update a post.", "operationId"=>"blogger.posts.update", "x-api-path-slug"=>"blogsblogidpostspostid-put", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the Blog"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"fetchBody", "description"=>"Whether the body content of the post is included with the result (default: true)"}, {"in"=>"query", "name"=>"fetchImages", "description"=>"Whether image URL metadata for each post is included in the returned result (default: false)"}, {"in"=>"query", "name"=>"maxComments", "description"=>"Maximum number of comments to retrieve with the returned post"}, {"in"=>"path", "name"=>"postId", "description"=>"The ID of the Post"}, {"in"=>"query", "name"=>"publish", "description"=>"Whether a publish action should be performed when the post is updated (default: false)"}, {"in"=>"query", "name"=>"revert", "description"=>"Whether a revert action should be performed when the post is updated (default: false)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog Post"]}}, "/blogs/{blogId}/posts/{postId}/comments"=>{"get"=>{"summary"=>"Get Blog Post Comments", "description"=>"Retrieves the comments for a post, possibly filtered.", "operationId"=>"blogger.comments.list", "x-api-path-slug"=>"blogsblogidpostspostidcomments-get", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"ID of the blog to fetch comments from"}, {"in"=>"query", "name"=>"endDate", "description"=>"Latest date of comment to fetch, a date-time with RFC 3339 formatting"}, {"in"=>"query", "name"=>"fetchBodies", "description"=>"Whether the body content of the comments is included"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of comments to include in the result"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Continuation token if request is paged"}, {"in"=>"path", "name"=>"postId", "description"=>"ID of the post to fetch posts from"}, {"in"=>"query", "name"=>"startDate", "description"=>"Earliest date of comment to fetch, a date-time with RFC 3339 formatting"}, {"in"=>"query", "name"=>"status"}, {"in"=>"query", "name"=>"view", "description"=>"Access level with which to view the returned result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}}, "/blogs/{blogId}/posts/{postId}/comments/{commentId}"=>{"delete"=>{"summary"=>"Delete Blog Post Comments", "description"=>"Delete a comment by ID.", "operationId"=>"blogger.comments.delete", "x-api-path-slug"=>"blogsblogidpostspostidcommentscommentid-delete", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the Blog"}, {"in"=>"path", "name"=>"commentId", "description"=>"The ID of the comment to delete"}, {"in"=>"path", "name"=>"postId", "description"=>"The ID of the Post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}, "get"=>{"summary"=>"Get Blog Post Comment", "description"=>"Gets one comment by ID.", "operationId"=>"blogger.comments.get", "x-api-path-slug"=>"blogsblogidpostspostidcommentscommentid-get", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"ID of the blog to containing the comment"}, {"in"=>"path", "name"=>"commentId", "description"=>"The ID of the comment to get"}, {"in"=>"path", "name"=>"postId", "description"=>"ID of the post to fetch posts from"}, {"in"=>"query", "name"=>"view", "description"=>"Access level for the requested comment (default: READER)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}}, "/blogs/{blogId}/posts/{postId}/comments/{commentId}/approve"=>{"post"=>{"summary"=>"Update Blog Post Comment", "description"=>"Marks a comment as not spam.", "operationId"=>"blogger.comments.approve", "x-api-path-slug"=>"blogsblogidpostspostidcommentscommentidapprove-post", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the Blog"}, {"in"=>"path", "name"=>"commentId", "description"=>"The ID of the comment to mark as not spam"}, {"in"=>"path", "name"=>"postId", "description"=>"The ID of the Post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}}, "/blogs/{blogId}/posts/{postId}/comments/{commentId}/removecontent"=>{"post"=>{"summary"=>"Update Blog Post Comment", "description"=>"Removes the content of a comment.", "operationId"=>"blogger.comments.removeContent", "x-api-path-slug"=>"blogsblogidpostspostidcommentscommentidremovecontent-post", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the Blog"}, {"in"=>"path", "name"=>"commentId", "description"=>"The ID of the comment to delete content from"}, {"in"=>"path", "name"=>"postId", "description"=>"The ID of the Post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}}, "/blogs/{blogId}/posts/{postId}/comments/{commentId}/spam"=>{"post"=>{"summary"=>"Update Blog Post Comment SPAM", "description"=>"Marks a comment as spam.", "operationId"=>"blogger.comments.markAsSpam", "x-api-path-slug"=>"blogsblogidpostspostidcommentscommentidspam-post", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the Blog"}, {"in"=>"path", "name"=>"commentId", "description"=>"The ID of the comment to mark as spam"}, {"in"=>"path", "name"=>"postId", "description"=>"The ID of the Post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}}, "/blogs/{blogId}/posts/{postId}/publish"=>{"post"=>{"summary"=>"Publish Blog Post", "description"=>"Publishes a draft post, optionally at the specific time of the given publishDate parameter.", "operationId"=>"blogger.posts.publish", "x-api-path-slug"=>"blogsblogidpostspostidpublish-post", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the Blog"}, {"in"=>"path", "name"=>"postId", "description"=>"The ID of the Post"}, {"in"=>"query", "name"=>"publishDate", "description"=>"Optional date and time to schedule the publishing of the Blog"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog Post"]}}, "/blogs/{blogId}/posts/{postId}/revert"=>{"post"=>{"summary"=>"Revert Blog Post", "description"=>"Revert a published or scheduled post to draft state.", "operationId"=>"blogger.posts.revert", "x-api-path-slug"=>"blogsblogidpostspostidrevert-post", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the Blog"}, {"in"=>"path", "name"=>"postId", "description"=>"The ID of the Post"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blog Post"]}}, "/users/{userId}"=>{"get"=>{"summary"=>"Get User", "description"=>"Gets one user by ID.", "operationId"=>"blogger.users.get", "x-api-path-slug"=>"usersuserid-get", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"The ID of the user to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/users/{userId}/blogs"=>{"get"=>{"summary"=>"Get User Blogs", "description"=>"Retrieves a list of blogs, possibly filtered.", "operationId"=>"blogger.blogs.listByUser", "x-api-path-slug"=>"usersuseridblogs-get", "parameters"=>[{"in"=>"query", "name"=>"fetchUserInfo", "description"=>"Whether the response is a list of blogs with per-user information instead of just blogs"}, {"in"=>"query", "name"=>"role", "description"=>"User access types for blogs to include in the results, e"}, {"in"=>"query", "name"=>"status", "description"=>"Blog statuses to include in the result (default: Live blogs only)"}, {"in"=>"path", "name"=>"userId", "description"=>"ID of the user whose blogs are to be fetched"}, {"in"=>"query", "name"=>"view", "description"=>"Access level with which to view the blogs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/users/{userId}/blogs/{blogId}"=>{"get"=>{"summary"=>"Get User Blog", "description"=>"Gets one blog and user info pair by blogId and userId.", "operationId"=>"blogger.blogUserInfos.get", "x-api-path-slug"=>"usersuseridblogsblogid-get", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the blog to get"}, {"in"=>"query", "name"=>"maxPosts", "description"=>"Maximum number of posts to pull back with the blog"}, {"in"=>"path", "name"=>"userId", "description"=>"ID of the user whose blogs are to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Blogs"]}}, "/users/{userId}/blogs/{blogId}/posts"=>{"get"=>{"summary"=>"Get User Blog Posts", "description"=>"Retrieves a list of post and post user info pairs, possibly filtered. The post user info contains per-user information about the post, such as access rights, specific to the user.", "operationId"=>"blogger.postUserInfos.list", "x-api-path-slug"=>"usersuseridblogsblogidposts-get", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"ID of the blog to fetch posts from"}, {"in"=>"query", "name"=>"endDate", "description"=>"Latest post date to fetch, a date-time with RFC 3339 formatting"}, {"in"=>"query", "name"=>"fetchBodies", "description"=>"Whether the body content of posts is included"}, {"in"=>"query", "name"=>"labels", "description"=>"Comma-separated list of labels to search for"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of posts to fetch"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sort order applied to search results"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Continuation token if the request is paged"}, {"in"=>"query", "name"=>"startDate", "description"=>"Earliest post date to fetch, a date-time with RFC 3339 formatting"}, {"in"=>"query", "name"=>"status"}, {"in"=>"path", "name"=>"userId", "description"=>"ID of the user for the per-user information to be fetched"}, {"in"=>"query", "name"=>"view", "description"=>"Access level with which to view the returned result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Blog Posts"]}}, "/users/{userId}/blogs/{blogId}/posts/{postId}"=>{"get"=>{"summary"=>"Get User Blog Post", "description"=>"Gets one post and user info pair, by post ID and user ID. The post user info contains per-user information about the post, such as access rights, specific to the user.", "operationId"=>"blogger.postUserInfos.get", "x-api-path-slug"=>"usersuseridblogsblogidpostspostid-get", "parameters"=>[{"in"=>"path", "name"=>"blogId", "description"=>"The ID of the blog"}, {"in"=>"query", "name"=>"maxComments", "description"=>"Maximum number of comments to pull back on a post"}, {"in"=>"path", "name"=>"postId", "description"=>"The ID of the post to get"}, {"in"=>"path", "name"=>"userId", "description"=>"ID of the user for the per-user information to be fetched"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User Blog Posts"]}}}}, "apis"=>{"name"=>"Blogger", "x-slug"=>"blogger", "description"=>"Blogger is a blog-publishing service that allows multi-user blogs with time-stamped entries. It was developed by Pyra Labs, which was bought by Google in 2003. Generally, the blogs are hosted by Google at a subdomain of blogspot.com. Blogs can also be hosted in the registered custom domain of the blogger (like www.example.com).", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/blogger-icon.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Blog,CMS,Content,General Data,Google APIs,Pedestal,Profiles,Relative Data,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"blogger/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Blogger API", "x-api-slug"=>"blogger-api", "description"=>"The Blogger API v3 allows client applications to view and update Blogger content. Your client application can use Blogger API v3 to create new blog posts, edit or delete existing posts, and query for posts that match particular criteria.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/blogger-icon.png", "humanURL"=>"https://www.blogger.com", "baseURL"=>"://www.googleapis.com//blogger/v3", "tags"=>"API Provider,API Service Provider,Blog,CMS,Content,General Data,Google APIs,Pedestal,Profiles,Relative Data,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/blogger/blogger-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://blogger.googleblog.com/"}, {"type"=>"x-website", "url"=>"https://www.blogger.com"}, {"type"=>"x-blog-rss", "url"=>"http://buzz.blogger.com/atom.xml"}, {"type"=>"x-developer", "url"=>"https://developers.google.com/blogger/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Blogger"}, {"type"=>"x-getting-started", "url"=>"https://developers.google.com/blogger/docs/3.0/getting_started"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
digital-river{"digital-river-shopper-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Digital River", "x-complete"=>1, "info"=>{"title"=>"Digital River Shopper API", "description"=>"the-dr-connect-shopper-api-operates-on-a-store-and-products-that-are-set-up-in-global-commerce--", "version"=>"v1"}, "host"=>"store.digitalriver.com", "basePath"=>"/store/{mysite}", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/oauth20/authorize"=>{"get"=>{"summary"=>"Get Oauth20 Authorize", "description"=>"Get oauth20 authorize.", "operationId"=>"getOauth20Authorize", "x-api-path-slug"=>"oauth20authorize-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Oauth20", "Authorize"]}}, "/oauth20/token"=>{"post"=>{"summary"=>"Post Oauth20 Token", "description"=>"Post oauth20 token.", "operationId"=>"postOauth20Token", "x-api-path-slug"=>"oauth20token-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Oauth20", "Token"]}}, "/v1/shoppers"=>{"post"=>{"summary"=>"Post Shoppers", "description"=>"Post shoppers.", "operationId"=>"postV1Shoppers", "x-api-path-slug"=>"v1shoppers-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers"]}}, "/v1/shoppers-api"=>{"get"=>{"summary"=>"Get Shoppers Api", "description"=>"Get shoppers api.", "operationId"=>"getV1ShoppersApi", "x-api-path-slug"=>"v1shoppersapi-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Api"]}}, "/v1/shoppers/me"=>{"get"=>{"summary"=>"Get Shoppers Me", "description"=>"Get shoppers me.", "operationId"=>"getV1ShoppersMe", "x-api-path-slug"=>"v1shoppersme-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me"]}, "post"=>{"summary"=>"Post Shoppers Me", "description"=>"Post shoppers me.", "operationId"=>"postV1ShoppersMe", "x-api-path-slug"=>"v1shoppersme-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me"]}}, "/v1/shoppers/me/account"=>{"get"=>{"summary"=>"Get Shoppers Me Account", "description"=>"Get shoppers me account.", "operationId"=>"getV1ShoppersMeAccount", "x-api-path-slug"=>"v1shoppersmeaccount-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Account"]}}, "/v1/shoppers/me/addresses"=>{"get"=>{"summary"=>"Get Shoppers Me Addresses", "description"=>"Get shoppers me addresses.", "operationId"=>"getV1ShoppersMeAddresses", "x-api-path-slug"=>"v1shoppersmeaddresses-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Resses"]}}, "/v1/shoppers/me/addresses/{id}"=>{"get"=>{"summary"=>"Get Shoppers Me Addresses", "description"=>"Get shoppers me addresses.", "operationId"=>"getV1ShoppersMeAddresses", "x-api-path-slug"=>"v1shoppersmeaddressesid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Resses"]}}, "/v1/shoppers/me/carts/active"=>{"get"=>{"summary"=>"Get Shoppers Me Carts Active", "description"=>"Get shoppers me carts active.", "operationId"=>"getV1ShoppersMeCartsActive", "x-api-path-slug"=>"v1shoppersmecartsactive-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active"]}, "post"=>{"summary"=>"Post Shoppers Me Carts Active", "description"=>"Post shoppers me carts active.", "operationId"=>"postV1ShoppersMeCartsActive", "x-api-path-slug"=>"v1shoppersmecartsactive-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active"]}}, "/v1/shoppers/me/carts/active/apply-shipping-option"=>{"post"=>{"summary"=>"Post Shoppers Me Carts Active Apply Shipping Option", "description"=>"Post shoppers me carts active apply shipping option.", "operationId"=>"postV1ShoppersMeCartsActiveApplyShippingOption", "x-api-path-slug"=>"v1shoppersmecartsactiveapplyshippingoption-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Apply", "Shipping", "Option"]}}, "/v1/shoppers/me/carts/active/apply-shopper"=>{"post"=>{"summary"=>"Post Shoppers Me Carts Active Apply Shopper", "description"=>"Post shoppers me carts active apply shopper.", "operationId"=>"postV1ShoppersMeCartsActiveApplyShopper", "x-api-path-slug"=>"v1shoppersmecartsactiveapplyshopper-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Apply", "Shopper"]}}, "/v1/shoppers/me/carts/active/billing-address"=>{"get"=>{"summary"=>"Get Shoppers Me Carts Active Billing Address", "description"=>"Get shoppers me carts active billing address.", "operationId"=>"getV1ShoppersMeCartsActiveBillingAddress", "x-api-path-slug"=>"v1shoppersmecartsactivebillingaddress-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Billing", "Ress"]}, "put"=>{"summary"=>"Put Shoppers Me Carts Active Billing Address", "description"=>"Put shoppers me carts active billing address.", "operationId"=>"putV1ShoppersMeCartsActiveBillingAddress", "x-api-path-slug"=>"v1shoppersmecartsactivebillingaddress-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Billing", "Ress"]}}, "/v1/shoppers/me/carts/active/line-items"=>{"delete"=>{"summary"=>"Delete Shoppers Me Carts Active Line Items", "description"=>"Delete shoppers me carts active line items.", "operationId"=>"deleteV1ShoppersMeCartsActiveLineItems", "x-api-path-slug"=>"v1shoppersmecartsactivelineitems-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Line", "Items"]}, "get"=>{"summary"=>"Get Shoppers Me Carts Active Line Items", "description"=>"Get shoppers me carts active line items.", "operationId"=>"getV1ShoppersMeCartsActiveLineItems", "x-api-path-slug"=>"v1shoppersmecartsactivelineitems-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Line", "Items"]}, "post"=>{"summary"=>"Post Shoppers Me Carts Active Line Items", "description"=>"Post shoppers me carts active line items.", "operationId"=>"postV1ShoppersMeCartsActiveLineItems", "x-api-path-slug"=>"v1shoppersmecartsactivelineitems-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Line", "Items"]}}, "/v1/shoppers/me/carts/active/line-items/{id}"=>{"delete"=>{"summary"=>"Delete Shoppers Me Carts Active Line Items", "description"=>"Delete shoppers me carts active line items.", "operationId"=>"deleteV1ShoppersMeCartsActiveLineItems", "x-api-path-slug"=>"v1shoppersmecartsactivelineitemsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Line", "Items"]}, "get"=>{"summary"=>"Get Shoppers Me Carts Active Line Items", "description"=>"Get shoppers me carts active line items.", "operationId"=>"getV1ShoppersMeCartsActiveLineItems", "x-api-path-slug"=>"v1shoppersmecartsactivelineitemsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Line", "Items"]}, "post"=>{"summary"=>"Post Shoppers Me Carts Active Line Items", "description"=>"Post shoppers me carts active line items.", "operationId"=>"postV1ShoppersMeCartsActiveLineItems", "x-api-path-slug"=>"v1shoppersmecartsactivelineitemsid-post", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Line", "Items"]}}, "/v1/shoppers/me/carts/active/point-of-promotions/{id}/offers"=>{"get"=>{"summary"=>"Get Shoppers Me Carts Active Point Of Promotions Offers", "description"=>"Get shoppers me carts active point of promotions offers.", "operationId"=>"getV1ShoppersMeCartsActivePointOfPromotionsOffers", "x-api-path-slug"=>"v1shoppersmecartsactivepointofpromotionsidoffers-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Point", "Promotions", "Offers"]}}, "/v1/shoppers/me/carts/active/shipping-address"=>{"get"=>{"summary"=>"Get Shoppers Me Carts Active Shipping Address", "description"=>"Get shoppers me carts active shipping address.", "operationId"=>"getV1ShoppersMeCartsActiveShippingAddress", "x-api-path-slug"=>"v1shoppersmecartsactiveshippingaddress-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Shipping", "Ress"]}, "put"=>{"summary"=>"Put Shoppers Me Carts Active Shipping Address", "description"=>"Put shoppers me carts active shipping address.", "operationId"=>"putV1ShoppersMeCartsActiveShippingAddress", "x-api-path-slug"=>"v1shoppersmecartsactiveshippingaddress-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Shipping", "Ress"]}}, "/v1/shoppers/me/carts/active/shipping-options"=>{"get"=>{"summary"=>"Get Shoppers Me Carts Active Shipping Options", "description"=>"Get shoppers me carts active shipping options.", "operationId"=>"getV1ShoppersMeCartsActiveShippingOptions", "x-api-path-slug"=>"v1shoppersmecartsactiveshippingoptions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Shipping", "Options"]}}, "/v1/shoppers/me/carts/active/shipping-options/{id}"=>{"get"=>{"summary"=>"Get Shoppers Me Carts Active Shipping Options", "description"=>"Get shoppers me carts active shipping options.", "operationId"=>"getV1ShoppersMeCartsActiveShippingOptions", "x-api-path-slug"=>"v1shoppersmecartsactiveshippingoptionsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Shipping", "Options"]}}, "/v1/shoppers/me/carts/active/submit-cart"=>{"post"=>{"summary"=>"Post Shoppers Me Carts Active Submit Cart", "description"=>"Post shoppers me carts active submit cart.", "operationId"=>"postV1ShoppersMeCartsActiveSubmitCart", "x-api-path-slug"=>"v1shoppersmecartsactivesubmitcart-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Submit", "Cart"]}}, "/v1/shoppers/me/carts/active/web-checkout"=>{"get"=>{"summary"=>"Get Shoppers Me Carts Active Web Checkout", "description"=>"Get shoppers me carts active web checkout.", "operationId"=>"getV1ShoppersMeCartsActiveWebCheckout", "x-api-path-slug"=>"v1shoppersmecartsactivewebcheckout-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Web", "Checkout"]}, "post"=>{"summary"=>"Post Shoppers Me Carts Active Web Checkout", "description"=>"Post shoppers me carts active web checkout.", "operationId"=>"postV1ShoppersMeCartsActiveWebCheckout", "x-api-path-slug"=>"v1shoppersmecartsactivewebcheckout-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Carts", "Active", "Web", "Checkout"]}}, "/v1/shoppers/me/categories"=>{"get"=>{"summary"=>"Get Shoppers Me Categories", "description"=>"Get shoppers me categories.", "operationId"=>"getV1ShoppersMeCategories", "x-api-path-slug"=>"v1shoppersmecategories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Categories"]}}, "/v1/shoppers/me/categories/{id}"=>{"get"=>{"summary"=>"Get Shoppers Me Categories", "description"=>"Get shoppers me categories.", "operationId"=>"getV1ShoppersMeCategories", "x-api-path-slug"=>"v1shoppersmecategoriesid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Categories"]}}, "/v1/shoppers/me/categories/{id}/products"=>{"get"=>{"summary"=>"Get Shoppers Me Categories Products", "description"=>"Get shoppers me categories products.", "operationId"=>"getV1ShoppersMeCategoriesProducts", "x-api-path-slug"=>"v1shoppersmecategoriesidproducts-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Categories", "Products"]}}, "/v1/shoppers/me/orders"=>{"get"=>{"summary"=>"Get Shoppers Me Orders", "description"=>"Get shoppers me orders.", "operationId"=>"getV1ShoppersMeOrders", "x-api-path-slug"=>"v1shoppersmeorders-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Orders"]}, "post"=>{"summary"=>"Post Shoppers Me Orders", "description"=>"Post shoppers me orders.", "operationId"=>"postV1ShoppersMeOrders", "x-api-path-slug"=>"v1shoppersmeorders-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Orders"]}}, "/v1/shoppers/me/orders/{id}"=>{"get"=>{"summary"=>"Get Shoppers Me Orders", "description"=>"Get shoppers me orders.", "operationId"=>"getV1ShoppersMeOrders", "x-api-path-slug"=>"v1shoppersmeordersid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Orders"]}}, "/v1/shoppers/me/orders/{id}/billing-address"=>{"get"=>{"summary"=>"Get Shoppers Me Orders Billing Address", "description"=>"Get shoppers me orders billing address.", "operationId"=>"getV1ShoppersMeOrdersBillingAddress", "x-api-path-slug"=>"v1shoppersmeordersidbillingaddress-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Orders", "Billing", "Ress"]}}, "/v1/shoppers/me/orders/{id}/line-items"=>{"get"=>{"summary"=>"Get Shoppers Me Orders Line Items", "description"=>"Get shoppers me orders line items.", "operationId"=>"getV1ShoppersMeOrdersLineItems", "x-api-path-slug"=>"v1shoppersmeordersidlineitems-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Orders", "Line", "Items"]}}, "/v1/shoppers/me/orders/{id}/line-items/{lineItemId}"=>{"get"=>{"summary"=>"Get Shoppers Me Orders Line Items Lineitemid", "description"=>"Get shoppers me orders line items lineitemid.", "operationId"=>"getV1ShoppersMeOrdersLineItemsLineitem", "x-api-path-slug"=>"v1shoppersmeordersidlineitemslineitemid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"lineItemId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Orders", "Line", "Items", "Lineitemid"]}}, "/v1/shoppers/me/orders/{id}/shipping-address"=>{"get"=>{"summary"=>"Get Shoppers Me Orders Shipping Address", "description"=>"Get shoppers me orders shipping address.", "operationId"=>"getV1ShoppersMeOrdersShippingAddress", "x-api-path-slug"=>"v1shoppersmeordersidshippingaddress-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Orders", "Shipping", "Ress"]}}, "/v1/shoppers/me/payment-options"=>{"get"=>{"summary"=>"Get Shoppers Me Payment Options", "description"=>"Get shoppers me payment options.", "operationId"=>"getV1ShoppersMePaymentOptions", "x-api-path-slug"=>"v1shoppersmepaymentoptions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Payment", "Options"]}}, "/v1/shoppers/me/payment-options/{id}"=>{"get"=>{"summary"=>"Get Shoppers Me Payment Options", "description"=>"Get shoppers me payment options.", "operationId"=>"getV1ShoppersMePaymentOptions", "x-api-path-slug"=>"v1shoppersmepaymentoptionsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Payment", "Options"]}}, "/v1/shoppers/me/point-of-promotions/{id}/offers"=>{"get"=>{"summary"=>"Get Shoppers Me Point Of Promotions Offers", "description"=>"Get shoppers me point of promotions offers.", "operationId"=>"getV1ShoppersMePointOfPromotionsOffers", "x-api-path-slug"=>"v1shoppersmepointofpromotionsidoffers-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Point", "Promotions", "Offers"]}}, "/v1/shoppers/me/point-of-promotions/{id}/offers/{offerId}"=>{"get"=>{"summary"=>"Get Shoppers Me Point Of Promotions Offers Offerid", "description"=>"Get shoppers me point of promotions offers offerid.", "operationId"=>"getV1ShoppersMePointOfPromotionsOffersOffer", "x-api-path-slug"=>"v1shoppersmepointofpromotionsidoffersofferid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"offerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Point", "Promotions", "Offers", "Offerid"]}}, "/v1/shoppers/me/point-of-promotions/{id}/offers/{offerId}/product-offers"=>{"get"=>{"summary"=>"Get Shoppers Me Point Of Promotions Offers Offerid Product Offers", "description"=>"Get shoppers me point of promotions offers offerid product offers.", "operationId"=>"getV1ShoppersMePointOfPromotionsOffersOfferProductOffers", "x-api-path-slug"=>"v1shoppersmepointofpromotionsidoffersofferidproductoffers-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"offerId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Point", "Promotions", "Offers", "Offerid", "Product", "Offers"]}}, "/v1/shoppers/me/point-of-promotions/{id}/offers/{offerId}/product-offers/{productId}"=>{"get"=>{"summary"=>"Get Shoppers Me Point Of Promotions Offers Offerid Product Offers Productid", "description"=>"Get shoppers me point of promotions offers offerid product offers productid.", "operationId"=>"getV1ShoppersMePointOfPromotionsOffersOfferProductOffersProduct", "x-api-path-slug"=>"v1shoppersmepointofpromotionsidoffersofferidproductoffersproductid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"offerId"}, {"in"=>"path", "name"=>"productId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Point", "Promotions", "Offers", "Offerid", "Product", "Offers", "Productid"]}}, "/v1/shoppers/me/product-search"=>{"get"=>{"summary"=>"Get Shoppers Me Product Search", "description"=>"Get shoppers me product search.", "operationId"=>"getV1ShoppersMeProductSearch", "x-api-path-slug"=>"v1shoppersmeproductsearch-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Product", "Search"]}}, "/v1/shoppers/me/products"=>{"get"=>{"summary"=>"Get Shoppers Me Products", "description"=>"Get shoppers me products.", "operationId"=>"getV1ShoppersMeProducts", "x-api-path-slug"=>"v1shoppersmeproducts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Products"]}}, "/v1/shoppers/me/products/{id}"=>{"get"=>{"summary"=>"Get Shoppers Me Products", "description"=>"Get shoppers me products.", "operationId"=>"getV1ShoppersMeProducts", "x-api-path-slug"=>"v1shoppersmeproductsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Products"]}}, "/v1/shoppers/me/products/{id}/point-of-promotions/{popId}/offers"=>{"get"=>{"summary"=>"Get Shoppers Me Products Point Of Promotions Popid Offers", "description"=>"Get shoppers me products point of promotions popid offers.", "operationId"=>"getV1ShoppersMeProductsPointOfPromotionsPopOffers", "x-api-path-slug"=>"v1shoppersmeproductsidpointofpromotionspopidoffers-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"popId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Products", "Point", "Promotions", "Popid", "Offers"]}}, "/v1/shoppers/me/products/{id}/purchase"=>{"post"=>{"summary"=>"Post Shoppers Me Products Purchase", "description"=>"Post shoppers me products purchase.", "operationId"=>"postV1ShoppersMeProductsPurchase", "x-api-path-slug"=>"v1shoppersmeproductsidpurchase-post", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Products", "Purchase"]}}, "/v1/shoppers/me/products/{id}/variations"=>{"get"=>{"summary"=>"Get Shoppers Me Products Variations", "description"=>"Get shoppers me products variations.", "operationId"=>"getV1ShoppersMeProductsVariations", "x-api-path-slug"=>"v1shoppersmeproductsidvariations-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Products", "Variations"]}}, "/v1/shoppers/me/purchase-plan/authorize"=>{"post"=>{"summary"=>"Post Shoppers Me Purchase Plan Authorize", "description"=>"Post shoppers me purchase plan authorize.", "operationId"=>"postV1ShoppersMePurchasePlanAuthorize", "x-api-path-slug"=>"v1shoppersmepurchaseplanauthorize-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Purchase", "Plan", "Authorize"]}}, "/v1/shoppers/me/purchase-plan/search"=>{"get"=>{"summary"=>"Get Shoppers Me Purchase Plan Search", "description"=>"Get shoppers me purchase plan search.", "operationId"=>"getV1ShoppersMePurchasePlanSearch", "x-api-path-slug"=>"v1shoppersmepurchaseplansearch-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Me", "Purchase", "Plan", "Search"]}}, "/v1/shoppers/token"=>{"get"=>{"summary"=>"Get Shoppers Token", "description"=>"Get shoppers token.", "operationId"=>"getV1ShoppersToken", "x-api-path-slug"=>"v1shopperstoken-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shoppers", "Token"]}}}}, "apis"=>{"name"=>"Digital River", "x-slug"=>"digital-river", "description"=>"Digital Riveris a public company that provides global ecommerce, payments and marketing services. In 2013, Digital River processed more than $30 billion in online transactions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/DigitalRiver_corp_logo_4c2.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Service Provider,Commerce,Commerce,Products,Products,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"digital-river/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Digital River Shopper API", "x-api-slug"=>"digital-river-shopper-api", "description"=>"Digital Riveris a public company that provides global ecommerce, payments and marketing services. In 2013, Digital River processed more than $30 billion in online transactions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/DigitalRiver_corp_logo_4c2.png", "humanURL"=>"https://digitalriver.com", "baseURL"=>"https://store.digitalriver.com//store/{mysite}", "tags"=>"API Service Provider,Commerce,Commerce,Products,Products,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/digital-river/v1shopperstoken-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/digital-river/digital-river-shopper-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://developers.digitalriver.com/blog"}, {"type"=>"x-blog-rss", "url"=>"https://developers.digitalriver.com/blog/feed"}, {"type"=>"x-console", "url"=>"https://developers.digitalriver.com/api-console"}, {"type"=>"x-developer", "url"=>"https://developers.digitalriver.com"}, {"type"=>"x-faq", "url"=>"https://developers.digitalriver.com/faq-page"}, {"type"=>"x-selfservice-registration", "url"=>"https://developers.digitalriver.com/user/register"}, {"type"=>"x-terms-of-service", "url"=>"https://developers.digitalriver.com/terms-use"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/DigitalRiverInc"}, {"type"=>"x-website", "url"=>"https://digitalriver.com"}, {"type"=>"x-website", "url"=>"http://digitalriver.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
weather-underground{"weather-underground-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Weather Underground", "x-complete"=>1, "info"=>{"title"=>"Weather Underground", "description"=>"get-forecast-and-weather-data-with-complete-geolocation-services-global-coverage-and-more-", "version"=>"1.0.0"}, "host"=>"api.wunderground.com", "basePath"=>"/api/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{key}/geolookup/q/CA/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Geolookup Q Ca San Francisco", "description"=>"This example will return the geographic attributes of San Francisco CA. Use {2 letter state code} / {City Name}", "operationId"=>"Get_USA_Geolocate_example_", "x-api-path-slug"=>"keygeolookupqcasan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Geolookup", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/geolookup/q/France/Paris.json"=>{"get"=>{"summary"=>"Get Key Geolookup Q France Paris", "description"=>"This example will return the geographic attributes of Paris, France. Use {Full Country Name} / {City Name}", "operationId"=>"Get_Outside_of_USA_Geolocate_example_", "x-api-path-slug"=>"keygeolookupqfranceparis-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"country", "description"=>"The country", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Geolookup", "Q", "France", "Paris", "Json"]}}, "/{key}/geolookup/q/autoip.json"=>{"get"=>{"summary"=>"Get Key Geolookup Q Autoip", "description"=>"This example will return the geographic attributes associated with the IP address location of the user.", "operationId"=>"Get_IPAddress_example_", "x-api-path-slug"=>"keygeolookupqautoip-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Geolookup", "Q", "Autoip", "Json"]}}, "/{key}/geolookup/q/94107.json"=>{"get"=>{"summary"=>"Get Key Geolookup Q 94107", "description"=>"This example will return the geographic attributes of zip code 94107", "operationId"=>"Get_ZIP_geolocate_example_", "x-api-path-slug"=>"keygeolookupq94107-json-get", "parameters"=>[{"in"=>"path", "name"=>"zip_code", "description"=>"The zip code", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Geolookup", "Q", "94107", "Json"]}}, "/{key}/geolookup/q/SFO.json"=>{"get"=>{"summary"=>"Get Key Geolookup Q Sfo", "description"=>"This example will return the geographic attributes of San Francisco International Airport (Airport Code: SFO)", "operationId"=>"Get_Airport_geolocate_example_", "x-api-path-slug"=>"keygeolookupqsfo-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Geolookup", "Q", "SFO", "Json"]}}, "/{key}/geolookup/q/37.776289,-122.395234.json"=>{"get"=>{"summary"=>"Get Key Geolookup Q 37.776289, 122.395234", "description"=>"This example will return the the geographic attributes of Latitude 37.776289 N, Longitude 122.395234 W", "operationId"=>"Get_Lat_Long_geolocate_example_", "x-api-path-slug"=>"keygeolookupq37-776289122-395234-json-get", "parameters"=>[{"in"=>"path", "name"=>"latitude", "description"=>"The latitude", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"longitude", "description"=>"The longitude", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Geolookup", "Q", "37", "776289", "-122", "395234", "Json"]}}, "/{key}/conditions/q/pws:KCATAHOE2.json"=>{"get"=>{"summary"=>"Get Key Conditions Q Pws Kcatahoe2", "description"=>"This example will return the the current weather conditions at the Personal Weather Station (pws) KCATAHOE2", "operationId"=>"Get_pws_example_", "x-api-path-slug"=>"keyconditionsqpwskcatahoe2-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Conditions", "Q", "Pws:KCATAHOE2", "Json"]}}, "/{key}/conditions/q/CA/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Conditions Q Ca San Francisco", "description"=>"This example will return the current conditions in San Francisco, California", "operationId"=>"Get_Conditions_example_", "x-api-path-slug"=>"keyconditionsqcasan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Conditions", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/astronomy/q/CA/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Astronomy Q Ca San Francisco", "description"=>"This example will return the Astronomy of San Francisco, California", "operationId"=>"Get_Astronomy_example_", "x-api-path-slug"=>"keyastronomyqcasan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Astronomy", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/forecast/q/CA/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Forecast Q Ca San Francisco", "description"=>"This example will return the 3 Day Forecast Summary for San Francisco, California", "operationId"=>"Get_forecast3_example_", "x-api-path-slug"=>"keyforecastqcasan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Forecast", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/almanac/q/{state}/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Almanac Q Ca San Francisco", "description"=>"This example will return Today's Average Highs/Lows and Record Highs/Lows for San Francisco, California.", "operationId"=>"Get_almanac_example_", "x-api-path-slug"=>"keyalmanacqstatesan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Almanac", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/conditions/forecast/lang:FR/q/France/Paris.json"=>{"get"=>{"summary"=>"Get Key Conditions Forecast Lang Fr Q France Paris", "description"=>"This example will return Current Conditions and a 3 day simple Forecast for Paris France in French. See documentation page for full list of language code options.", "operationId"=>"Get_French_example_", "x-api-path-slug"=>"keyconditionsforecastlangfrqfranceparis-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"country", "description"=>"The country", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"language", "description"=>"The language", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Conditions", "Forecast", "Lang:FR", "Q", "France", "Paris", "Json"]}}, "/{key}/conditions/forecast/lang:SP/q/Spain/Alicante.json"=>{"get"=>{"summary"=>"Get Key Conditions Forecast Lang Sp Q Spain Alicante", "description"=>"This example will return Current Conditions and a 3 day simple Forecast for Alicante, Spain in Spanish. See documentation page for full list of language code options.", "operationId"=>"Get_Spanish_example_", "x-api-path-slug"=>"keyconditionsforecastlangspqspainalicante-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"country", "description"=>"The country", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"language", "description"=>"The language", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Conditions", "Forecast", "Lang:SP", "Q", "Spain", "Alicante", "Json"]}}, "/{key}/forecast10day/q/CA/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Forecast10day Q Ca San Francisco", "description"=>"This example will return the 10 Day Forecast Summary for San Francisco, California", "operationId"=>"Get_forecast10_example_", "x-api-path-slug"=>"keyforecast10dayqcasan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Forecast10day", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/hourly/q/CA/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Hourly Q Ca San Francisco", "description"=>"This example will return a detailed hourly forecast for the 'next' 36 hours in San Francisco, California", "operationId"=>"Get_OneDay_hourly_example_", "x-api-path-slug"=>"keyhourlyqcasan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Hourly", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/satellite/q/CA/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Satellite Q Ca San Francisco", "description"=>"This example will return URL's for satellite (visual and IR) images for San Francisco, California", "operationId"=>"Get_satellite_example_", "x-api-path-slug"=>"keysatelliteqcasan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Satellite", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/radar/image.gif?maxlat=42.35%26maxlon=-109.311%26minlat=39.27%26minlon=-114.644%26width=600%26height=480%26newmaps=0"=>{"get"=>{"summary"=>"Get Key Radar Image.gif Maxlat 42.35%26maxlon 109.311%26minlat 39.27%26minlon 114.644%26wth 600%26height 480%26newmaps 0", "description"=>"This example will return dynamic radar image around Salt Lake City, UT with a transparent background. See Docs for all the options for creating these images.", "operationId"=>"Get_radar_example_", "x-api-path-slug"=>"keyradarimage-gifmaxlat42-3526maxlon109-31126minlat39-2726minlon114-64426width60026height48026newmaps0-get", "parameters"=>[{"in"=>"query", "name"=>"height", "description"=>"The height", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"maxlat", "description"=>"Max longitude", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"maxlon", "description"=>"Max longitude", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"minlat", "description"=>"Min latitude", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"minlon", "description"=>"Min longitude", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"width", "description"=>"The width", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Radar", "Image", "Gif?maxlat=42", "35%26maxlon=-109", "311%26minlat=39", "27%26minlon=-114", "644%26width=600%26height=480%26newmaps=0"]}}, "/{key}/radar/image.gif?maxlat=42.35%26maxlon=-109.311%26minlat=39.27%26minlon=-114.644%26width=600%26height=480%26newmaps=1"=>{"get"=>{"summary"=>"Get Key Radar Image.gif Maxlat 42.35%26maxlon 109.311%26minlat 39.27%26minlon 114.644%26wth 600%26height 480%26newmaps 1", "description"=>"This example will return dynamic radar image around Salt Lake City, UT with a Base Map background. See Docs for all the options for creating these images.", "operationId"=>"Get_radar_example2_", "x-api-path-slug"=>"keyradarimage-gifmaxlat42-3526maxlon109-31126minlat39-2726minlon114-64426width60026height48026newmaps1-get", "parameters"=>[{"in"=>"query", "name"=>"height", "description"=>"The height", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"maxlat", "description"=>"Max longitude", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"maxlon", "description"=>"Max longitude", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"minlat", "description"=>"Min latitude", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"minlon", "description"=>"Min longitude", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"width", "description"=>"The width", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Radar", "Image", "Gif?maxlat=42", "35%26maxlon=-109", "311%26minlat=39", "27%26minlon=-114", "644%26width=600%26height=480%26newmaps=1"]}}, "/{key}/alerts/q/{state}/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Alerts Q Ca San Francisco", "description"=>"This example will return active severe alerts for San Francisco, California. This request only works in the USA, Canada and Europe.", "operationId"=>"Get_alerts_example_", "x-api-path-slug"=>"keyalertsqstatesan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Alerts", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/tide/q/CA/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Te Q Ca San Francisco", "description"=>"This example will return 4 days of tides for San Francisco, California starting 'today'. This request only works in the USA.", "operationId"=>"Get_Tide_example1_", "x-api-path-slug"=>"keytideqcasan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Tide", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/tide_20160312/q/CA/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Te 20160312 Q Ca San Francisco", "description"=>"This example will return 4 days of tides for San Francisco, California following March 3 2012. This request only works in the USA.", "operationId"=>"Get_Tide_example2_", "x-api-path-slug"=>"keytide-20160312qcasan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Tide", "20160312", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/rawtide_20160312/q/CA/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Rawte 20160312 Q Ca San Francisco", "description"=>"This example will return raw tide data for San Francisco, California on March 3 2016. This request only works in the USA.", "operationId"=>"Get_Tide_RAW_example_", "x-api-path-slug"=>"keyrawtide-20160312qcasan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Rawtide", "20160312", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/hourly10day/q/CA/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Hourly10day Q Ca San Francisco", "description"=>"This example will return a detailed hourly forecast for the next 10 days in San Francisco, California", "operationId"=>"Get_TenDay_hourly_example_", "x-api-path-slug"=>"keyhourly10dayqcasan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Hourly10day", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/yesterday/q/CA/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Yesterday Q Ca San Francisco", "description"=>"This example will return yesterday's weather in San Francisco, California.", "operationId"=>"Get_yesterday_example_", "x-api-path-slug"=>"keyyesterdayqcasan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Yesterday", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/planner_10051031/q/CA/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Planner 10051031 Q Ca San Francisco", "description"=>"This example will return a Historical roll up of weather data in San Francisco from Oct 5 to Oct 31. An example application: http://www.wunderground.com/travelplanner/index.asp", "operationId"=>"Get_Planner_example_", "x-api-path-slug"=>"keyplanner-10051031qcasan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Planner", "10051031", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/webcams/q/CA/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Webcams Q Ca San Francisco", "description"=>"This example will return URL's to webcam images in San Francisco, California. It will also return information about the webcam, including it's location in Lat,Long coordinates.", "operationId"=>"Get_cams_example_", "x-api-path-slug"=>"keywebcamsqcasan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Webcams", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/animatedradar/image.gif?maxlat=42.35%26maxlon=-109.311%26minlat=39.27%26minlon=-114.644%26width=600%26height=480%26newmaps=1"=>{"get"=>{"summary"=>"Get Key Animatedradar Image.gif Maxlat 42.35%26maxlon 109.311%26minlat 39.27%26minlon 114.644%26wth 600%26height 480%26newmaps 1", "description"=>"This example will return dynamic animated radar image around Salt Lake City, UT with a base map background. See Docs for all the options for creating these images.", "operationId"=>"Get_radar_example3_", "x-api-path-slug"=>"keyanimatedradarimage-gifmaxlat42-3526maxlon109-31126minlat39-2726minlon114-64426width60026height48026newmaps1-get", "parameters"=>[{"in"=>"query", "name"=>"height", "description"=>"The height", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"maxlat", "description"=>"Max longitude", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"maxlon", "description"=>"Max longitude", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"minlat", "description"=>"Min latitude", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"minlon", "description"=>"Min longitude", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"width", "description"=>"The width", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Animatedradar", "Image", "Gif?maxlat=42", "35%26maxlon=-109", "311%26minlat=39", "27%26minlon=-114", "644%26width=600%26height=480%26newmaps=1"]}}, "/{key}/animatedradar/image.gif"=>{"get"=>{"summary"=>"Get Key Animatedradar Image.gif Maxlat 42.35%26maxlon 109.311%26minlat 39.27%26minlon 114.644%26wth 600%26height 480%26newmaps 0", "description"=>"This example will return dynamic animated radar image around Salt Lake City, UT with a transparent background. See Docs for all the options for creating these images.", "operationId"=>"Get_radar_example4_", "x-api-path-slug"=>"keyanimatedradarimage-gif-get", "parameters"=>[{"in"=>"query", "name"=>"height", "description"=>"The height", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"maxlat", "description"=>"Max latitude", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"maxlon", "description"=>"Max longitude", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"minlat", "description"=>"Min latitude", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"minlon", "description"=>"Min longitude", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"width", "description"=>"The width", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Animatedradar", "Image", "Gif?maxlat=42", "35%26maxlon=-109", "311%26minlat=39", "27%26minlon=-114", "644%26width=600%26height=480%26newmaps=0"]}}, "/{key}/history_20101018/q/SFO.json"=>{"get"=>{"summary"=>"Get Key History 20101018 Q Sfo", "description"=>"This example will return historical data for San Francisco, California for the specified date. If you search by zip or lat/long you will get nearest airport.", "operationId"=>"Get_History_example_", "x-api-path-slug"=>"keyhistory-20101018qsfo-json-get", "parameters"=>[{"in"=>"path", "name"=>"airport_code", "description"=>"The airport code", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "History", "20101018", "Q", "SFO", "Json"]}}, "/{key}/history_20101018/q/pws:KCASANFR14.json"=>{"get"=>{"summary"=>"Get Key History 20101018 Q Pws Kcasanfr14", "description"=>"This example will return historical data for a Personal Weather Station for the specified date. The feature only works with JSON. XML will come out soon.", "operationId"=>"Get_History_example_pws_", "x-api-path-slug"=>"keyhistory-20101018qpwskcasanfr14-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "History", "20101018", "Q", "Pws:KCASANFR14", "Json"]}}, "/{key}/geolookup/conditions/q/CA/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Geolookup Conditions Q Ca San Francisco", "description"=>"This example will return the geographical and current conditions for San Francisco, California", "operationId"=>"Get_Geolocate_current_example_", "x-api-path-slug"=>"keygeolookupconditionsqcasan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Geolookup", "Conditions", "Q", "CA", "San", "Francisco", "Json"]}}, "/{key}/geolookup/conditions/forecast/q/CA/San_Francisco.json"=>{"get"=>{"summary"=>"Get Key Geolookup Conditions Forecast Q Ca San Francisco", "description"=>"This example will return the geographical, current conditions and 3 day forecast summary for San Francisco, California", "operationId"=>"Get_Geolocate_current_forecast_example_", "x-api-path-slug"=>"keygeolookupconditionsforecastqcasan-francisco-json-get", "parameters"=>[{"in"=>"path", "name"=>"city", "description"=>"The city", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"state", "description"=>"The state", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Weather", "Key", "Geolookup", "Conditions", "Forecast", "Q", "CA", "San", "Francisco", "Json"]}}}}, "apis"=>{"name"=>"Weather Underground", "x-slug"=>"weather-underground", "description"=>"Weather Underground provides local & long range weather forecasts, weather reports, maps & tropical weather conditions for locations worldwide.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/966-weather-underground.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"619", "tags"=>"Broadcasts,General Data,internet,Mobile,Pedestal,Publish,Service API,Stack Network,Weather,Weather", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"weather-underground/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Weather Underground", "x-api-slug"=>"weather-underground", "description"=>"Weather Underground provides local & long range weather forecasts, weather reports, maps & tropical weather conditions for locations worldwide.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/966-weather-underground.jpg", "humanURL"=>"http://www.wunderground.com", "baseURL"=>"https://api.wunderground.com//api/", "tags"=>"Broadcasts,General Data,internet,Mobile,Pedestal,Publish,Service API,Stack Network,Weather,Weather", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/weather-underground/keygeolookupconditionsforecastqcasan-francisco-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/weather-underground/weather-underground-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-application-gallery", "url"=>"http://www.wunderground.com/weather/api/d/featured_applications.html"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/weather-underground"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/weather-underground"}, {"type"=>"x-developer", "url"=>"http://www.wunderground.com/weather/api"}, {"type"=>"x-email", "url"=>"help@wunderground.com"}, {"type"=>"x-email", "url"=>"press@wunderground.com"}, {"type"=>"x-email", "url"=>"ademail@wunderground.com"}, {"type"=>"x-email", "url"=>"wuhelp@wunderground.com"}, {"type"=>"x-forum", "url"=>"http://www.wunderground.com/weather/api/d/community.html"}, {"type"=>"x-knowledgebase", "url"=>"http://help.wunderground.com/knowledgebase"}, {"type"=>"x-pricing", "url"=>"http://www.wunderground.com/weather/api/d/pricing.html"}, {"type"=>"x-privacy", "url"=>"http://www.wunderground.com/members/tos.asp#privacy"}, {"type"=>"x-selfservice-registration", "url"=>"http://www.wunderground.com/weather/api/d/login.html"}, {"type"=>"x-terms-of-service", "url"=>"http://www.wunderground.com/members/tos.asp"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/wunderground"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/weatherapi"}, {"type"=>"x-website", "url"=>"http://www.wunderground.com"}, {"type"=>"x-website", "url"=>"http://wunderground.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vzaar{"vzaar-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Vzaar", "x-complete"=>1, "info"=>{"title"=>"VZaar API", "description"=>"vzaar-is-an-online-video-hosting-service-with-fantastic-features-that-are-designed-for-business--deliver-to-mobile-or-the-web-straight-from-your-site-", "termsOfService"=>"http://vzaar.com/policies", "version"=>"v1"}, "host"=>"vzaar.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/accounts/{account}.{format}"=>{"get"=>{"summary"=>"Get Api Accounts Account", "description"=>"nnThis API call returns the details and rights for each vzaar subscription account type along with its relevant metadata. This will show the details of the packages available here: http://vzaar.com/pricingnn", "operationId"=>"getApiAccountsAccount.Format", "x-api-path-slug"=>"apiaccountsaccount-format-get", "parameters"=>[{"in"=>"query", "name"=>"account is the vzaar account type. This is an integer."}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api", "Accounts", "Account", "Format"]}}, "/api/upload/link.xmln"=>{"post"=>{"summary"=>"Post Api Upload Link.xmln", "description"=>"nnThis API call allows a user to upload & process video file from given url.nn", "operationId"=>"postApiUploadLink.xmln", "x-api-path-slug"=>"apiuploadlink-xmln-post", "parameters"=>[{"in"=>"query", "name"=>"bitrate", "description"=>"Specifies videos bitrate"}, {"in"=>"query", "name"=>"description", "description"=>"Specifies the description for the video"}, {"in"=>"query", "name"=>"encoding_params", "description"=>"Includes optional parameters"}, {"in"=>"query", "name"=>"guid", "description"=>"Specifies the guid to operate on"}, {"in"=>"query", "name"=>"key", "description"=>"A name for the S3 object that stores the uploaded file"}, {"in"=>"query", "name"=>"size_id", "description"=>"Specifies the size for the video to be encoded in"}, {"in"=>"query", "name"=>"title", "description"=>"Specifies the title for the video"}, {"in"=>"query", "name"=>"transcoding", "description"=>"True forces vzaar to transcode the video, false makes vzaar use the original source file"}, {"in"=>"query", "name"=>"url", "description"=>"Specifies the url to video file"}, {"in"=>"query", "name"=>"width", "description"=>"Specifies videos width"}, {"in"=>"query", "name"=>"XML/JSON"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api", "Upload", "Link", "Xmln"]}}, "/api/users/{username}.{format}"=>{"get"=>{"summary"=>"Get Api Users Username", "description"=>"nnThis API call returns the users public details along with its relevant metadata.nn", "operationId"=>"getApiUsersUsername.Format", "x-api-path-slug"=>"apiusersusername-format-get", "parameters"=>[{"in"=>"query", "name"=>"username is the vzaar login name for the user. Note: This must be the actual username and not the email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api", "Users", "Username", "Format"]}}, "/api/videos"=>{"post"=>{"summary"=>"Post Api Videos", "description"=>"nnThis API call tells the vzaar system to process a newly uploaded video. This will encode it if necessary and then provide a vzaar video idea back.nn", "operationId"=>"postApiVeos", "x-api-path-slug"=>"apivideos-post", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"Specifies the description for the video"}, {"in"=>"query", "name"=>"guid", "description"=>"Specifies the guid to operate on"}, {"in"=>"query", "name"=>"labels", "description"=>"Comma separated list of labels to be assigned to the video"}, {"in"=>"query", "name"=>"profile", "description"=>"Specifies the size for the video to be encoded in"}, {"in"=>"query", "name"=>"replace_id", "description"=>"Specifies the video ID of an existing video that you wish to replace with the new video"}, {"in"=>"query", "name"=>"title", "description"=>"Specifies the title for the video"}, {"in"=>"query", "name"=>"transcoding", "description"=>"True forces vzaar to transcode the video, false makes vzaar use the original source file (available only for mp4 and flv files)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api", "Videos"]}}, "/api/videos/signature"=>{"get"=>{"summary"=>"Get Api Videos Signature", "description"=>"nnThis API call allows a user to request a GUID and an AWS S3 signature. With these credentials the user will then be able upload a file into vzaar video storage area.nnThe response for this must be parsed and used in the Upload step. The upload will fail if any of these details are incorrect.nn", "operationId"=>"getApiVeosSignature", "x-api-path-slug"=>"apivideossignature-get", "parameters"=>[{"in"=>"query", "name"=>"flash_request", "description"=>"Allows you to use a flash uploader"}, {"in"=>"query", "name"=>"max_file_size", "description"=>"Specifies the maximum file size (in bytes) to limit the upload too"}, {"in"=>"query", "name"=>"success_action_redirect", "description"=>"Specifies if to redirect to a URL after a successful post instead of issuing a 201"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api", "Videos", "Signature"]}}, "/api/videos/{video}.{format}"=>{"get"=>{"summary"=>"Get Api Videos", "description"=>"nnvzaar uses the oEmbed open standard for allowing 3rd parties to integrated with the vzaar. You can use the vzaar video URL to easily obtain the appropriate embed code for that video. To find out more about oEmbed view the specification here: http://oembed.com/nn", "operationId"=>"getApiVeosVeo.Format", "x-api-path-slug"=>"apivideosvideo-format-get", "parameters"=>[{"in"=>"query", "name"=>"borderless,", "description"=>"If set to true and the user has sufficient privileges, the size and embeded code returned will be be for a borderless player"}, {"in"=>"query", "name"=>"embed_only,", "description"=>"When returning data, only include the minimum fields and embed code possible"}, {"in"=>"query", "name"=>"videos is the vzaar video number for that video."}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api", "Videos", "Video", "Format"]}}, "/api/{username}/videos.xml"=>{"get"=>{"summary"=>"Get Api Username Videos", "description"=>"nnThis API call returns a list of the users active videos along with its relevant metadata. 20 videos are returned by default but this is customisable.nn", "operationId"=>"getApiUsernameVeos.xml", "x-api-path-slug"=>"apiusernamevideos-xml-get", "parameters"=>[{"in"=>"query", "name"=>"count,", "description"=>"Specifies the number of videos to retrieve per page"}, {"in"=>"query", "name"=>"page,", "description"=>"Specifies the page number to retrieve"}, {"in"=>"query", "name"=>"sort,", "description"=>"Values can be asc (least_recent) or desc (most_recent)"}, {"in"=>"query", "name"=>"status,", "description"=>"Values can be processing, active, replaced, deleted and failed"}, {"in"=>"query", "name"=>"title,", "description"=>"Return only videos with title containing given string"}, {"in"=>"query", "name"=>"username is the vzaar login name for the user. Note: This must be the actual username and not the email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api", "Username", "Videos", "Xml"]}}}}, "apis"=>{"name"=>"Vzaar", "x-slug"=>"vzaar", "description"=>"vzaar is an online video hosting service, which launched in 2007. The site supports video streaming, embedding, sharing, and video storage. Originally targeted at eBay sellers, the service expanded in 2008 and now provides online video services designed for business and other commercial operations.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/523_logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API United Kingdom,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"vzaar/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Vzaar API", "x-api-slug"=>"vzaar-api", "description"=>"vzaar is anonline video hostingservice with fantasticfeaturesthat are designed for business. Deliver tomobileor the web straight from your site.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/523_logo.png", "humanURL"=>"http://vzaar.com/", "baseURL"=>"https://vzaar.com//", "tags"=>"API United Kingdom,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/vzaar/apiusernamevideos-xml-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/vzaar/vzaar-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://vzaar.com/api/"}, {"type"=>"x-blog", "url"=>"http://vzaar.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"http://vzaar.com/blog/feed/"}, {"type"=>"x-case-studies", "url"=>"http://vzaar.com/case_studies"}, {"type"=>"x-contact-form", "url"=>"http://vzaar.com/contact/new"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/vzaar"}, {"type"=>"x-developer", "url"=>"http://developer.vzaar.com/"}, {"type"=>"x-facebook", "url"=>"https://www.facebook.com/vzaar"}, {"type"=>"x-forum", "url"=>"https://vzaar.com/help/discussions"}, {"type"=>"x-github", "url"=>"https://github.com/vzaar"}, {"type"=>"x-glossary", "url"=>"https://vzaar.com/help/kb/glossary/glossary"}, {"type"=>"x-google-plus", "url"=>"https://plus.google.com/+vzaar_video_hosting"}, {"type"=>"x-knowledgebase", "url"=>"https://vzaar.com/help/kb"}, {"type"=>"x-partners", "url"=>"http://vzaar.com/partners"}, {"type"=>"x-pricing", "url"=>"http://vzaar.com/pricing"}, {"type"=>"x-privacy", "url"=>"http://vzaar.com/privacy"}, {"type"=>"x-terms-of-service", "url"=>"http://vzaar.com/policies"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/vzaar"}, {"type"=>"x-website", "url"=>"http://vzaar.com/"}, {"type"=>"x-website", "url"=>"http://vzaar.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
jumpseller{"jumpseller-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Jumpseller", "x-complete"=>1, "info"=>{"title"=>"Jumpseller", "description"=>"explore-all-our-endpoints-with-your-own-set-of-of-access-tokens--all-changes-affect-your-production-jumpseller-store-", "version"=>"1"}, "host"=>"api.jumpseller.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/apps.json"=>{"get"=>{"summary"=>"Get Apps", "description"=>"Retrieve all jumpseller apps..", "operationId"=>"getApps.json", "x-api-path-slug"=>"apps-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Apps", "Json"]}}, "/categories.json"=>{"get"=>{"summary"=>"Get Categories", "description"=>"Retrieve all categories..", "operationId"=>"getCategories.json", "x-api-path-slug"=>"categories-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories", "Json"]}, "post"=>{"summary"=>"Post Categories", "description"=>"Create a new category..", "operationId"=>"postCategories.json", "x-api-path-slug"=>"categories-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Category parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories", "Json"]}}, "/categories/{id}.json"=>{"delete"=>{"summary"=>"Delete Categories", "description"=>"Delete an existing category..", "operationId"=>"deleteCategories.json", "x-api-path-slug"=>"categoriesid-json-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the Category"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories", "Id", "Json"]}, "get"=>{"summary"=>"Get Categories", "description"=>"Retrieve a single category..", "operationId"=>"getCategories.json", "x-api-path-slug"=>"categoriesid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the Category"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories", "Id", "Json"]}, "put"=>{"summary"=>"Put Categories", "description"=>"Modify an existing category..", "operationId"=>"putCategories.json", "x-api-path-slug"=>"categoriesid-json-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Category parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Id of the Category"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories", "Id", "Json"]}}, "/checkout_custom_fields.json"=>{"get"=>{"summary"=>"Get Checkout Custom Fields", "description"=>"Retrieve all checkout custom fields..", "operationId"=>"getCheckoutCustomFields.json", "x-api-path-slug"=>"checkout-custom-fields-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkout", "Custom", "Fields", "Json"]}, "post"=>{"summary"=>"Post Checkout Custom Fields", "description"=>"Create a new checkoutcustomfield..", "operationId"=>"postCheckoutCustomFields.json", "x-api-path-slug"=>"checkout-custom-fields-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"CheckoutCustomField parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkout", "Custom", "Fields", "Json"]}}, "/checkout_custom_fields/{id}.json"=>{"delete"=>{"summary"=>"Delete Checkout Custom Fields", "description"=>"Delete an existing checkoutcustomfield..", "operationId"=>"deleteCheckoutCustomFields.json", "x-api-path-slug"=>"checkout-custom-fieldsid-json-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the CheckoutCustomField"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkout", "Custom", "Fields", "Id", "Json"]}, "get"=>{"summary"=>"Get Checkout Custom Fields", "description"=>"Retrieve a single checkoutcustomfield..", "operationId"=>"getCheckoutCustomFields.json", "x-api-path-slug"=>"checkout-custom-fieldsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the CheckoutCustomField"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkout", "Custom", "Fields", "Id", "Json"]}, "put"=>{"summary"=>"Put Checkout Custom Fields", "description"=>"Update a checkoutcustomfield..", "operationId"=>"putCheckoutCustomFields.json", "x-api-path-slug"=>"checkout-custom-fieldsid-json-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"CheckoutCustomField parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Id of the CheckoutCustomField"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checkout", "Custom", "Fields", "Id", "Json"]}}, "/countries.json"=>{"get"=>{"summary"=>"Get Countries", "description"=>"Retrieve all countries..", "operationId"=>"getCountries.json", "x-api-path-slug"=>"countries-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countries", "Json"]}}, "/countries/{country_code}.json"=>{"get"=>{"summary"=>"Get Countries Country Code", "description"=>"Retrieve a single country information..", "operationId"=>"getCountriesCountryCode.json", "x-api-path-slug"=>"countriescountry-code-json-get", "parameters"=>[{"in"=>"path", "name"=>"country_code", "description"=>"ISO3166 Country Code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countries", "Country", "Code", "Json"]}}, "/countries/{country_code}/regions.json"=>{"get"=>{"summary"=>"Get Countries Country Code Regions", "description"=>"Retrieve all regions from a single country..", "operationId"=>"getCountriesCountryCodeRegions.json", "x-api-path-slug"=>"countriescountry-coderegions-json-get", "parameters"=>[{"in"=>"path", "name"=>"country_code", "description"=>"ISO3166 Country Code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countries", "Country", "Code", "Regions", "Json"]}}, "/countries/{country_code}/regions/{region_code}.json"=>{"get"=>{"summary"=>"Get Countries Country Code Regions Region Code", "description"=>"Retrieve a single region information object..", "operationId"=>"getCountriesCountryCodeRegionsRegionCode.json", "x-api-path-slug"=>"countriescountry-coderegionsregion-code-json-get", "parameters"=>[{"in"=>"path", "name"=>"country_code", "description"=>"ISO3166 Country Code"}, {"in"=>"path", "name"=>"region_code", "description"=>"Region Code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Countries", "Country", "Code", "Regions", "Region", "Code", "Json"]}}, "/customer_categories.json"=>{"get"=>{"summary"=>"Get Customer Categories", "description"=>"Retrieve all customer categories..", "operationId"=>"getCustomerCategories.json", "x-api-path-slug"=>"customer-categories-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Categories", "Json"]}, "post"=>{"summary"=>"Post Customer Categories", "description"=>"Create a new customercategory..", "operationId"=>"postCustomerCategories.json", "x-api-path-slug"=>"customer-categories-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"CustomerCategory parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Categories", "Json"]}}, "/customer_categories/{id}.json"=>{"delete"=>{"summary"=>"Delete Customer Categories", "description"=>"Delete an existing customercategory..", "operationId"=>"deleteCustomerCategories.json", "x-api-path-slug"=>"customer-categoriesid-json-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the CustomerCategory"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Categories", "Id", "Json"]}, "get"=>{"summary"=>"Get Customer Categories", "description"=>"Retrieve a single customercategory..", "operationId"=>"getCustomerCategories.json", "x-api-path-slug"=>"customer-categoriesid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the CustomerCategory"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Categories", "Id", "Json"]}, "put"=>{"summary"=>"Put Customer Categories", "description"=>"Update a customercategory..", "operationId"=>"putCustomerCategories.json", "x-api-path-slug"=>"customer-categoriesid-json-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"CustomerCategory parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Id of the CustomerCategory"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Categories", "Id", "Json"]}}, "/customer_categories/{id}/customers.json"=>{"delete"=>{"summary"=>"Delete Customer Categories Customers", "description"=>"Delete customers from an existing customercategory..", "operationId"=>"deleteCustomerCategoriesCustomers.json", "x-api-path-slug"=>"customer-categoriesidcustomers-json-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the CustomerCategory"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Categories", "Id", "Customers", "Json"]}, "get"=>{"summary"=>"Get Customer Categories Customers", "description"=>"Retrieves the customers in a customercategory..", "operationId"=>"getCustomerCategoriesCustomers.json", "x-api-path-slug"=>"customer-categoriesidcustomers-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the CustomerCategory"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Categories", "Id", "Customers", "Json"]}, "post"=>{"summary"=>"Post Customer Categories Customers", "description"=>"Adds customers to a customercategory..", "operationId"=>"postCustomerCategoriesCustomers.json", "x-api-path-slug"=>"customer-categoriesidcustomers-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Customer parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Id of the CustomerCategory"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customer", "Categories", "Id", "Customers", "Json"]}}, "/customers.json"=>{"get"=>{"summary"=>"Get Customers", "description"=>"Retrieve all customers..", "operationId"=>"getCustomers.json", "x-api-path-slug"=>"customers-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Json"]}, "post"=>{"summary"=>"Post Customers", "description"=>"Create a new customer..", "operationId"=>"postCustomers.json", "x-api-path-slug"=>"customers-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Customer parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Json"]}}, "/customers/email/{email}.json"=>{"get"=>{"summary"=>"Get Customers Email Email", "description"=>"Retrieve a single customer..", "operationId"=>"getCustomersEmailEmail.json", "x-api-path-slug"=>"customersemailemail-json-get", "parameters"=>[{"in"=>"path", "name"=>"email", "description"=>"Email of the Customer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Email", "Email", "Json"]}}, "/customers/{id}.json"=>{"delete"=>{"summary"=>"Delete Customers", "description"=>"Delete an existing category..", "operationId"=>"deleteCustomers.json", "x-api-path-slug"=>"customersid-json-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the Customer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Id", "Json"]}, "get"=>{"summary"=>"Get Customers", "description"=>"Retrieve a single customer..", "operationId"=>"getCustomers.json", "x-api-path-slug"=>"customersid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the Customer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Id", "Json"]}, "put"=>{"summary"=>"Put Customers", "description"=>"Update a new customer..", "operationId"=>"putCustomers.json", "x-api-path-slug"=>"customersid-json-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Customer parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Id of the Customer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Id", "Json"]}}, "/fields.json"=>{"get"=>{"summary"=>"Get Fields", "description"=>"", "operationId"=>"getFields.json", "x-api-path-slug"=>"fields-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fields", "Json"]}, "post"=>{"summary"=>"Post Fields", "description"=>"", "operationId"=>"postFields.json", "x-api-path-slug"=>"fields-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Custom Field parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fields", "Json"]}}, "/hooks.json"=>{"get"=>{"summary"=>"Get Hooks", "description"=>"", "operationId"=>"getHooks.json", "x-api-path-slug"=>"hooks-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hooks", "Json"]}, "post"=>{"summary"=>"Post Hooks", "description"=>"", "operationId"=>"postHooks.json", "x-api-path-slug"=>"hooks-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Hook parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hooks", "Json"]}}, "/hooks/{id}.json"=>{"delete"=>{"summary"=>"Delete Hooks", "description"=>"", "operationId"=>"deleteHooks.json", "x-api-path-slug"=>"hooksid-json-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the Hook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hooks", "Id", "Json"]}, "get"=>{"summary"=>"Get Hooks", "description"=>"", "operationId"=>"getHooks.json", "x-api-path-slug"=>"hooksid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the Hook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hooks", "Id", "Json"]}, "put"=>{"summary"=>"Put Hooks", "description"=>"", "operationId"=>"putHooks.json", "x-api-path-slug"=>"hooksid-json-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Hook parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Id of the Hook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hooks", "Id", "Json"]}}, "/jsapps.json"=>{"post"=>{"summary"=>"Post Jsapps", "description"=>"", "operationId"=>"postJsapps.json", "x-api-path-slug"=>"jsapps-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSApp parameters to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jsapps", "Json"]}}, "/jsapps/{code}.json"=>{"delete"=>{"summary"=>"Delete Jsapps Code", "description"=>"", "operationId"=>"deleteJsappsCode.json", "x-api-path-slug"=>"jsappscode-json-delete", "parameters"=>[{"in"=>"path", "name"=>"code", "description"=>"Code of the App"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jsapps", "Code", "Json"]}, "get"=>{"summary"=>"Get Jsapps Code", "description"=>"", "operationId"=>"getJsappsCode.json", "x-api-path-slug"=>"jsappscode-json-get", "parameters"=>[{"in"=>"path", "name"=>"code", "description"=>"Code of the App"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jsapps", "Code", "Json"]}}, "/orders.json"=>{"get"=>{"summary"=>"Get Orders", "description"=>"", "operationId"=>"getOrders.json", "x-api-path-slug"=>"orders-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Json"]}, "post"=>{"summary"=>"Post Orders", "description"=>"Use the JSON format: '{ \"order\": {\"status\": \"Paid\", \"shipping_method_id\": 123, \"products\": [{ \"id\": 123, \"qty\": 1}], \"customer\": {\"id\": 123}}}' or in CURL: curl -X POST -d '{ \"order\": {\"status\": \"Paid\", \"shipping_method_id\": 123, \"products\": [{ \"id\": 123, \"qty\": 1}], \"customer\": {\"id\": 123}}}' \"https://api.jumpseller.com/v1/orders.json?login=storecode&authtoken=XXXXX\" -H \"Content-Type:application/json\"", "operationId"=>"postOrders.json", "x-api-path-slug"=>"orders-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Order parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Json"]}}, "/orders/status/{status}.json"=>{"get"=>{"summary"=>"Get Orders Status Status", "description"=>"", "operationId"=>"getOrdersStatusStatus.json", "x-api-path-slug"=>"ordersstatusstatus-json-get", "parameters"=>[{"in"=>"path", "name"=>"status", "description"=>"Status of the Order used as filter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Status", "Status", "Json"]}}, "/orders/{id}.json"=>{"get"=>{"summary"=>"Get Orders", "description"=>"", "operationId"=>"getOrders.json", "x-api-path-slug"=>"ordersid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the Order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Id", "Json"]}, "put"=>{"summary"=>"Put Orders", "description"=>"Only 'status', 'tracking_number', 'tracking_company', 'additional_information' and 'additional_fields' are available for update. Use the JSON format: '{ \"order\": {\"status\": \"Paid\", \"tracking_company\": \"other\", \"tracking_number\": \"123456789\", \"additional_information\": \"My custom message.\", \"additional_fields\": [{\"label\": \"Gift Name\", \"value\": \"Duarte\"}, {\"label\": \"Gift Wrapping Color\", \"value\": \"Green\"}]} }}' or in CURL: curl -X PUT -d '{ \"order\": {\"status\": \"Paid\", \"additional_information\": \"My custom message.\"}}' \"https://api.jumpseller.com/v1/orders/{id}.json?login=storecode&authtoken=XXXXX\" -H \"Content-Type:application/json\"", "operationId"=>"putOrders.json", "x-api-path-slug"=>"ordersid-json-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Order parameters to change", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Id of the Order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Id", "Json"]}}, "/orders/{id}/history.json"=>{"get"=>{"summary"=>"Get Orders History", "description"=>"", "operationId"=>"getOrdersHistory.json", "x-api-path-slug"=>"ordersidhistory-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the Order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Id", "History", "Json"]}, "post"=>{"summary"=>"Post Orders History", "description"=>"", "operationId"=>"postOrdersHistory.json", "x-api-path-slug"=>"ordersidhistory-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Order History parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Id of the OrderHistory"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders", "Id", "History", "Json"]}}, "/payment_methods.json"=>{"get"=>{"summary"=>"Get Payment Methods", "description"=>"", "operationId"=>"getPaymentMethods.json", "x-api-path-slug"=>"payment-methods-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment", "Methods", "Json"]}}, "/payment_methods/{id}.json"=>{"get"=>{"summary"=>"Get Payment Methods", "description"=>"", "operationId"=>"getPaymentMethods.json", "x-api-path-slug"=>"payment-methodsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the Payment Method"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payment", "Methods", "Id", "Json"]}}, "/products.json"=>{"get"=>{"summary"=>"Get Products", "description"=>"", "operationId"=>"getProducts.json", "x-api-path-slug"=>"products-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Json"]}, "post"=>{"summary"=>"Post Products", "description"=>"", "operationId"=>"postProducts.json", "x-api-path-slug"=>"products-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Product parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Json"]}}, "/products/after/{id}.json"=>{"get"=>{"summary"=>"Get Products After", "description"=>"", "operationId"=>"getProductsAfter.json", "x-api-path-slug"=>"productsafterid-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "After", "Id", "Json"]}}, "/products/category/{category_id}.json"=>{"get"=>{"summary"=>"Get Products Category Category", "description"=>"", "operationId"=>"getProductsCategoryCategory.json", "x-api-path-slug"=>"productscategorycategory-id-json-get", "parameters"=>[{"in"=>"path", "name"=>"category_id", "description"=>"Category ID of the Product used as filter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Category", "Category", "Id", "Json"]}}, "/products/category/{category_id}/count.json"=>{"get"=>{"summary"=>"Get Products Category Category Count", "description"=>"", "operationId"=>"getProductsCategoryCategoryCount.json", "x-api-path-slug"=>"productscategorycategory-idcount-json-get", "parameters"=>[{"in"=>"path", "name"=>"category_id", "description"=>"Category ID of the Product used as filter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Category", "Category", "Id", "Count", "Json"]}}, "/products/count.json"=>{"get"=>{"summary"=>"Get Products Count", "description"=>"", "operationId"=>"getProductsCount.json", "x-api-path-slug"=>"productscount-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Count", "Json"]}}, "/products/search.json"=>{"get"=>{"summary"=>"Get Products Search", "description"=>"", "operationId"=>"getProductsSearch.json", "x-api-path-slug"=>"productssearch-json-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"Query for the Product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Search", "Json"]}}, "/products/sku/{sku}.json"=>{"get"=>{"summary"=>"Get Products Sku Sku", "description"=>"", "operationId"=>"getProductsSkuSku.json", "x-api-path-slug"=>"productsskusku-json-get", "parameters"=>[{"in"=>"path", "name"=>"sku", "description"=>"SKU of the Product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Sku", "Sku", "Json"]}}, "/products/status/{status}.json"=>{"get"=>{"summary"=>"Get Products Status Status", "description"=>"", "operationId"=>"getProductsStatusStatus.json", "x-api-path-slug"=>"productsstatusstatus-json-get", "parameters"=>[{"in"=>"path", "name"=>"status", "description"=>"Status of the Product used as filter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Status", "Status", "Json"]}}, "/products/status/{status}/count.json"=>{"get"=>{"summary"=>"Get Products Status Status Count", "description"=>"", "operationId"=>"getProductsStatusStatusCount.json", "x-api-path-slug"=>"productsstatusstatuscount-json-get", "parameters"=>[{"in"=>"path", "name"=>"status", "description"=>"Status of the Product used as filter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Status", "Status", "Count", "Json"]}}, "/products/{id}.json"=>{"delete"=>{"summary"=>"Delete Products", "description"=>"", "operationId"=>"deleteProducts.json", "x-api-path-slug"=>"productsid-json-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Json"]}, "get"=>{"summary"=>"Get Products", "description"=>"", "operationId"=>"getProducts.json", "x-api-path-slug"=>"productsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the Product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Json"]}, "put"=>{"summary"=>"Put Products", "description"=>"", "operationId"=>"putProducts.json", "x-api-path-slug"=>"productsid-json-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Product parameters to change", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Json"]}}, "/products/{id}/fields.json"=>{"get"=>{"summary"=>"Get Products Fields", "description"=>"", "operationId"=>"getProductsFields.json", "x-api-path-slug"=>"productsidfields-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Fields", "Json"]}, "post"=>{"summary"=>"Post Products Fields", "description"=>"", "operationId"=>"postProductsFields.json", "x-api-path-slug"=>"productsidfields-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Product Custom Field parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Fields", "Json"]}}, "/products/{id}/fields/count.json"=>{"get"=>{"summary"=>"Get Products Fields Count", "description"=>"", "operationId"=>"getProductsFieldsCount.json", "x-api-path-slug"=>"productsidfieldscount-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the Product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Fields", "Count", "Json"]}}, "/products/{id}/images.json"=>{"get"=>{"summary"=>"Get Products Images", "description"=>"", "operationId"=>"getProductsImages.json", "x-api-path-slug"=>"productsidimages-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the Product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Images", "Json"]}, "post"=>{"summary"=>"Post Products Images", "description"=>"", "operationId"=>"postProductsImages.json", "x-api-path-slug"=>"productsidimages-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Product Image parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Images", "Json"]}}, "/products/{id}/images/count.json"=>{"get"=>{"summary"=>"Get Products Images Count", "description"=>"", "operationId"=>"getProductsImagesCount.json", "x-api-path-slug"=>"productsidimagescount-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the Product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Images", "Count", "Json"]}}, "/products/{id}/images/{image_id}.json"=>{"delete"=>{"summary"=>"Delete Products Images Image", "description"=>"", "operationId"=>"deleteProductsImagesImage.json", "x-api-path-slug"=>"productsidimagesimage-id-json-delete", "parameters"=>[{"in"=>"path", "name"=>"image_id", "description"=>"Id of the Product Image"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Images", "Image", "Id", "Json"]}, "get"=>{"summary"=>"Get Products Images Image", "description"=>"", "operationId"=>"getProductsImagesImage.json", "x-api-path-slug"=>"productsidimagesimage-id-json-get", "parameters"=>[{"in"=>"path", "name"=>"image_id", "description"=>"Id of the Product Image"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Images", "Image", "Id", "Json"]}}, "/products/{id}/options.json"=>{"get"=>{"summary"=>"Get Products Options", "description"=>"", "operationId"=>"getProductsOptions.json", "x-api-path-slug"=>"productsidoptions-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the Product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Options", "Json"]}, "post"=>{"summary"=>"Post Products Options", "description"=>"", "operationId"=>"postProductsOptions.json", "x-api-path-slug"=>"productsidoptions-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Product Option parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Options", "Json"]}}, "/products/{id}/options/count.json"=>{"get"=>{"summary"=>"Get Products Options Count", "description"=>"", "operationId"=>"getProductsOptionsCount.json", "x-api-path-slug"=>"productsidoptionscount-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the Product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Options", "Count", "Json"]}}, "/products/{id}/options/{option_id}.json"=>{"delete"=>{"summary"=>"Delete Products Options Option", "description"=>"", "operationId"=>"deleteProductsOptionsOption.json", "x-api-path-slug"=>"productsidoptionsoption-id-json-delete", "parameters"=>[{"in"=>"path", "name"=>"option_id", "description"=>"Id of the Product Option"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Options", "Option", "Id", "Json"]}, "get"=>{"summary"=>"Get Products Options Option", "description"=>"", "operationId"=>"getProductsOptionsOption.json", "x-api-path-slug"=>"productsidoptionsoption-id-json-get", "parameters"=>[{"in"=>"path", "name"=>"option_id", "description"=>"Id of the Product Option"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Options", "Option", "Id", "Json"]}, "put"=>{"summary"=>"Put Products Options Option", "description"=>"", "operationId"=>"putProductsOptionsOption.json", "x-api-path-slug"=>"productsidoptionsoption-id-json-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Product option parameters to change", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"option_id", "description"=>"Id of the Product Option"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Options", "Option", "Id", "Json"]}}, "/products/{id}/options/{option_id}/values.json"=>{"get"=>{"summary"=>"Get Products Options Option Values", "description"=>"", "operationId"=>"getProductsOptionsOptionValues.json", "x-api-path-slug"=>"productsidoptionsoption-idvalues-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the Product"}, {"in"=>"path", "name"=>"option_id", "description"=>"ID of the Product Option"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Options", "Option", "Id", "Values", "Json"]}, "post"=>{"summary"=>"Post Products Options Option Values", "description"=>"", "operationId"=>"postProductsOptionsOptionValues.json", "x-api-path-slug"=>"productsidoptionsoption-idvalues-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Product Option Value parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"option_id", "description"=>"Id of the Product Option"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Options", "Option", "Id", "Values", "Json"]}}, "/products/{id}/options/{option_id}/values/count.json"=>{"get"=>{"summary"=>"Get Products Options Option Values Count", "description"=>"", "operationId"=>"getProductsOptionsOptionValuesCount.json", "x-api-path-slug"=>"productsidoptionsoption-idvaluescount-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the Product"}, {"in"=>"path", "name"=>"option_id", "description"=>"ID of the Product Option"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Options", "Option", "Id", "Values", "Count", "Json"]}}, "/products/{id}/options/{option_id}/values/{value_id}.json"=>{"delete"=>{"summary"=>"Delete Products Options Option Values Value", "description"=>"", "operationId"=>"deleteProductsOptionsOptionValuesValue.json", "x-api-path-slug"=>"productsidoptionsoption-idvaluesvalue-id-json-delete", "parameters"=>[{"in"=>"path", "name"=>"option_id", "description"=>"Id of the Product Option"}, {"in"=>"path", "name"=>"value_id", "description"=>"ID of the Product Option Value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Options", "Option", "Id", "Values", "Value", "Id", "Json"]}, "get"=>{"summary"=>"Get Products Options Option Values Value", "description"=>"", "operationId"=>"getProductsOptionsOptionValuesValue.json", "x-api-path-slug"=>"productsidoptionsoption-idvaluesvalue-id-json-get", "parameters"=>[{"in"=>"path", "name"=>"option_id", "description"=>"Id of the Product Option"}, {"in"=>"path", "name"=>"value_id", "description"=>"ID of the Product Option Value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Options", "Option", "Id", "Values", "Value", "Id", "Json"]}, "put"=>{"summary"=>"Put Products Options Option Values Value", "description"=>"", "operationId"=>"putProductsOptionsOptionValuesValue.json", "x-api-path-slug"=>"productsidoptionsoption-idvaluesvalue-id-json-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Product option value parameters to change", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"option_id", "description"=>"Id of the Product Option"}, {"in"=>"path", "name"=>"value_id", "description"=>"Id of the Product Option Value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Options", "Option", "Id", "Values", "Value", "Id", "Json"]}}, "/products/{id}/variants.json"=>{"get"=>{"summary"=>"Get Products Variants", "description"=>"", "operationId"=>"getProductsVariants.json", "x-api-path-slug"=>"productsidvariants-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the Product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Variants", "Json"]}, "post"=>{"summary"=>"Post Products Variants", "description"=>"", "operationId"=>"postProductsVariants.json", "x-api-path-slug"=>"productsidvariants-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Product Variant parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Variants", "Json"]}}, "/products/{id}/variants/count.json"=>{"get"=>{"summary"=>"Get Products Variants Count", "description"=>"", "operationId"=>"getProductsVariantsCount.json", "x-api-path-slug"=>"productsidvariantscount-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the Product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Variants", "Count", "Json"]}}, "/products/{id}/variants/{variant_id}.json"=>{"get"=>{"summary"=>"Get Products Variants Variant", "description"=>"", "operationId"=>"getProductsVariantsVariant.json", "x-api-path-slug"=>"productsidvariantsvariant-id-json-get", "parameters"=>[{"in"=>"path", "name"=>"variant_id", "description"=>"Id of the Product Variant"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Variants", "Variant", "Id", "Json"]}, "put"=>{"summary"=>"Put Products Variants Variant", "description"=>"", "operationId"=>"putProductsVariantsVariant.json", "x-api-path-slug"=>"productsidvariantsvariant-id-json-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Product Variant parameters to change", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"variant_id", "description"=>"Id of the Product Variant"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "Id", "Variants", "Variant", "Id", "Json"]}}, "/promotions.json"=>{"get"=>{"summary"=>"Get Promotions", "description"=>"", "operationId"=>"getPromotions.json", "x-api-path-slug"=>"promotions-json-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Promotions list restriction (default: 50 | max: 200)"}, {"in"=>"query", "name"=>"page", "description"=>"Promotions list page (default: 1)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Promotions", "Json"]}, "post"=>{"summary"=>"Post Promotions", "description"=>"", "operationId"=>"postPromotions.json", "x-api-path-slug"=>"promotions-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Promotion parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Promotions", "Json"]}}, "/promotions/{id}.json"=>{"delete"=>{"summary"=>"Delete Promotions", "description"=>"", "operationId"=>"deletePromotions.json", "x-api-path-slug"=>"promotionsid-json-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the Promotion"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Promotions", "Id", "Json"]}, "get"=>{"summary"=>"Get Promotions", "description"=>"", "operationId"=>"getPromotions.json", "x-api-path-slug"=>"promotionsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the Promotion"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Promotions", "Id", "Json"]}, "put"=>{"summary"=>"Put Promotions", "description"=>"", "operationId"=>"putPromotions.json", "x-api-path-slug"=>"promotionsid-json-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Promotion parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Id of the Promotion"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Promotions", "Id", "Json"]}}, "/settings.json"=>{"post"=>{"summary"=>"Post Settings", "description"=>"", "operationId"=>"postSettings.json", "x-api-path-slug"=>"settings-json-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Store Setting parameters to create", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settings", "Json"]}}, "/settings/{name}.json"=>{"get"=>{"summary"=>"Get Settings Name", "description"=>"", "operationId"=>"getSettingsName.json", "x-api-path-slug"=>"settingsname-json-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Name of the Store Setting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settings", "Name", "Json"]}, "put"=>{"summary"=>"Put Settings Name", "description"=>"", "operationId"=>"putSettingsName.json", "x-api-path-slug"=>"settingsname-json-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Store Setting parameters to change", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"Name of the Store Setting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settings", "Name", "Json"]}}, "/store/info.json"=>{"get"=>{"summary"=>"Get Store Info", "description"=>"", "operationId"=>"getStoreInfo.json", "x-api-path-slug"=>"storeinfo-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store", "Info", "Json"]}}, "/store/languages.json"=>{"get"=>{"summary"=>"Get Store Languages", "description"=>"", "operationId"=>"getStoreLanguages.json", "x-api-path-slug"=>"storelanguages-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Store", "Languages", "Json"]}}}}, "apis"=>{"name"=>"Jumpseller", "x-slug"=>"jumpseller", "description"=>"We founded Jumpseller.com in 2009 in Europe we called it Vendder back then and released our first version of the Jumpseller product in September 2010. After releasing the product we quickly grew to thousands of customers. In November 2010, we recei...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28432-jumpseller-api.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"153745", "tags"=>"Affiliates,API Provider,Commerce,General Data,Profiles,Relative Data,Service API,Stores,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"jumpseller/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Jumpseller", "x-api-slug"=>"jumpseller", "description"=>"We founded Jumpseller.com in 2009 in Europe we called it Vendder back then and released our first version of the Jumpseller product in September 2010. After releasing the product we quickly grew to thousands of customers. In November 2010, we recei...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28432-jumpseller-api.jpg", "humanURL"=>"http://jumpseller.com", "baseURL"=>"https://api.jumpseller.com//v1", "tags"=>"Affiliates,API Provider,Commerce,General Data,Profiles,Relative Data,Service API,Stores,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/jumpseller/jumpseller-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/vendder"}, {"type"=>"x-email", "url"=>"info@jumpseller.com"}, {"type"=>"x-email", "url"=>"support@jumpseller.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Jumpseller"}, {"type"=>"x-website", "url"=>"http://jumpseller.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
evrythng{"apis"=>{"name"=>"EVRYTHNG", "x-slug"=>"evrythng", "description"=>"EVRYTHNG is the market leading internet of things platform for consumer product brands. Now individual product items can tell their stories to your business and your consumers throughout their lifecycle.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28871-evrythng-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"686135", "tags"=>"Enterprise,Internet of Things,Profiles,Relative Data,SaaS", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"evrythng/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"EVRYTHNG", "x-api-slug"=>"evrythng", "description"=>"EVRYTHNG is the market leading internet of things platform for consumer product brands. Now individual product items can tell their stories to your business and your consumers throughout their lifecycle.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28871-evrythng-com.jpg", "humanURL"=>"https://evrythng.com", "baseURL"=>"https://example.com//", "tags"=>"Enterprise,Internet of Things,Profiles,Relative Data,SaaS", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/evrythng/evrythng-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-deprecation", "url"=>"https://developers.evrythng.com/docs/deprecation"}, {"type"=>"x-github", "url"=>"https://github.com/evrythng"}, {"type"=>"x-postman-collection", "url"=>"https://www.getpostman.com/collections/ba74e4cd196b0cffefec"}, {"type"=>"x-websub", "url"=>"https://developers.evrythng.com/docs/pubsub"}, {"type"=>"x-authentication", "url"=>"https://developers.evrythng.com/docs/authentication"}, {"type"=>"x-blog", "url"=>"https://evrythng.com/blog/"}, {"type"=>"x-blog", "url"=>"https://developers.evrythng.com/blog"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/thngy"}, {"type"=>"x-email", "url"=>"press@evrythng.com"}, {"type"=>"x-email", "url"=>"privacy@evrythng.com"}, {"type"=>"x-security", "url"=>"https://evrythng.com/securing-the-internet-of-things/"}, {"type"=>"x-support", "url"=>"https://developers.evrythng.com/docs/support"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/EVRYTHNG"}, {"type"=>"x-website", "url"=>"https://evrythng.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "evrythng-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EVRYTHNG", "x-complete"=>1, "info"=>{"title"=>"EVRYTHNG", "description"=>"the-evrythng-platform-is-a-cloud-platformasaservice-paas-for-storing-sharing-and-analyzing-data-generated-by-physical-objects--the-platform-gives-a-unique-and-permanent-digital-identity-also-known-as-adis-to-each-individual-object-and-allows-authorized-applications-and-users-to-access-it-via-rest-and-pubsub-mqtt-apis--visualisations-in-the-evrythng-dashboard-analytics-conditional-redirections-and-the-reactor-rules-engine-provide-means-to-add-intelligent-behavior-and-features-on-top-of-your-data-to-add-value-", "version"=>"1.0.0"}, "host"=>"example.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/thngs"=>{"get"=>{"summary"=>"/thngs (O)", "description"=>"OPERATOR reads the list of all thngs in the account.", "operationId"=>"ThngsGet", "x-api-path-slug"=>"thngs-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thngs"]}, "post"=>{"summary"=>"/thngs (O)", "description"=>"Creates a thng that is visible by no Applications", "operationId"=>"ThngsPost", "x-api-path-slug"=>"thngs-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thngs"]}}, "/products/{PROD_ID}"=>{"get"=>{"summary"=>"/products/{id} (O)", "description"=>"OPERATOR reads a specific product.", "operationId"=>"ProductsByPRODIDGet", "x-api-path-slug"=>"productsprod-id-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"PROD_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products", "PROD", "ID"]}}, "/auth/evrythng/users"=>{"post"=>{"summary"=>"/auth/evrythng/users (A)", "description"=>"APP creates a new EVRYTHNG user in it (using email/password).", "operationId"=>"AuthEvrythngUsersPost", "x-api-path-slug"=>"authevrythngusers-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auth", "Evrythng", "Users"]}}, "/users/{USER_ID}"=>{"get"=>{"summary"=>"/users/{id} (O)", "description"=>"OPERATOR reads data a specific user.", "operationId"=>"UsersByUSERIDGet", "x-api-path-slug"=>"usersuser-id-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"USER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "USER", "ID"]}}, "/auth/evrythng/users/{USER_ID}/validate"=>{"post"=>{"summary"=>"/user/{id}/validate (A)", "description"=>"APP validates a user (which can then login & out).", "operationId"=>"AuthEvrythngUsersValidateByUSERIDPost", "x-api-path-slug"=>"authevrythngusersuser-idvalidate-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"USER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auth", "Evrythng", "Users", "USER", "ID", "Validate"]}}, "/products"=>{"get"=>{"summary"=>"/products (A)", "description"=>"APP Reads the list of all products visible.", "operationId"=>"ProductsGet2", "x-api-path-slug"=>"products-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}, "post"=>{"summary"=>"/products (O)", "description"=>"OPERATOR creates a product visible in **NO** applications.", "operationId"=>"ProductsPost", "x-api-path-slug"=>"products-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/actions/scans"=>{"post"=>{"summary"=>"/actions/scans (U)", "description"=>"**USER** creates a \"scan\" action on a thng.\n\n**ATTENTION -->** use a valid thng ID in the payload!", "operationId"=>"ActionsScansPost2", "x-api-path-slug"=>"actionsscans-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions", "Scans"]}}, "/actions"=>{"get"=>{"summary"=>"/actions?project={id} (O)", "description"=>"**OPERATOR** returns all the action types in the scope of an Application.", "operationId"=>"ActionsGet2", "x-api-path-slug"=>"actions-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions"]}, "post"=>{"summary"=>"/actions?project={id} (O)", "description"=>"**OPERATOR** creates a new custom action type for app ID (visible only by that app).", "operationId"=>"ActionsPost2", "x-api-path-slug"=>"actions-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Actions"]}}, "/projects/{PROJECT_ID}/applications/"=>{"post"=>{"summary"=>"/applications/ (O)", "description"=>"OPERATOR creates a new application.", "operationId"=>"ProjectsApplicationsByPROJECTIDPost", "x-api-path-slug"=>"projectsproject-idapplications-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"PROJECT_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Applications"]}}, "/projects/{PROJECT_ID}"=>{"get"=>{"summary"=>"/projects/{id} (O)", "description"=>"OPERATOR Reads a Specific Project.", "operationId"=>"ProjectsByPROJECTIDGet", "x-api-path-slug"=>"projectsproject-id-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"PROJECT_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID"]}}, "/users/{USER_ID}/status"=>{"get"=>{"summary"=>"/users/{id}/status (O)", "description"=>"OPERATOR gets the status of a specific user.", "operationId"=>"UsersStatusByUSERIDGet", "x-api-path-slug"=>"usersuser-idstatus-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"USER_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "USER", "ID", "Status"]}}, "/auth/evrythng/"=>{"post"=>{"summary"=>"/auth/evrythng (A)", "description"=>"APP logs in an existing (and activated) user (with email/password).", "operationId"=>"AuthEvrythngPost", "x-api-path-slug"=>"authevrythng-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auth", "Evrythng"]}}, "/projects/"=>{"get"=>{"summary"=>"/projects/ (O)", "description"=>"OPERATOR reads the list of all Projects.", "operationId"=>"ProjectsGet", "x-api-path-slug"=>"projects-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}, "post"=>{"summary"=>"/projects/ (O)", "description"=>"OPERATOR creates a new project.", "operationId"=>"ProjectsPost", "x-api-path-slug"=>"projects-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/users"=>{"get"=>{"summary"=>"/users (O)", "description"=>"OPERATOR gets the list of all users of the engine.", "operationId"=>"UsersGet", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/projects/{PROJECT_ID}/applications/{APP_ID}"=>{"get"=>{"summary"=>"/applications/{id} (O)", "description"=>"OPERATOR reads a specific application.", "operationId"=>"ProjectsApplicationsByPROJECTIDAndAPPIDGet", "x-api-path-slug"=>"projectsproject-idapplicationsapp-id-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"APP_ID"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"PROJECT_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects", "PROJECT", "ID", "Applications", "APP", "ID"]}}, "/thngs/{THNG_ID}/location"=>{"put"=>{"summary"=>"/thngs/{id}/location (U)", "description"=>"USER updates the location of a thng.", "operationId"=>"ThngsLocationByTHNGIDPut", "x-api-path-slug"=>"thngsthng-idlocation-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"THNG_ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thngs", "THNG", "ID", "Location"]}}, "/auth/all/logout"=>{"post"=>{"summary"=>"/auth/all/logout (U)", "description"=>"USER logs himself out (which renders the user API Key invalid).", "operationId"=>"AuthAllLogoutPost", "x-api-path-slug"=>"authalllogout-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auth", "", "Logout"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-config{"aws-config-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Config", "x-complete"=>1, "info"=>{"title"=>"AWS Config API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=DeleteConfigRule"=>{"get"=>{"summary"=>"Delete Config Rule", "description"=>"Deletes the specified AWS Config rule and all of its evaluation results.", "operationId"=>"deleteConfigRule", "x-api-path-slug"=>"actiondeleteconfigrule-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigRuleName", "description"=>"The name of the AWS Config rule that you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Rules"]}}, "/?Action=DeleteConfigurationRecorder"=>{"get"=>{"summary"=>"Delete Configuration Recorder", "description"=>"Deletes the configuration recorder.", "operationId"=>"deleteConfigurationRecorder", "x-api-path-slug"=>"actiondeleteconfigurationrecorder-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigurationRecorderName", "description"=>"The name of the configuration recorder to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Recorders"]}}, "/?Action=DeleteDeliveryChannel"=>{"get"=>{"summary"=>"Delete Delivery Channel", "description"=>"Deletes the delivery channel.", "operationId"=>"deleteDeliveryChannel", "x-api-path-slug"=>"actiondeletedeliverychannel-get", "parameters"=>[{"in"=>"query", "name"=>"DeliveryChannelName", "description"=>"The name of the delivery channel to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Delivery Channels"]}}, "/?Action=DeleteEvaluationResults"=>{"get"=>{"summary"=>"Delete Evaluation Results", "description"=>"Deletes the evaluation results for the specified Config rule.", "operationId"=>"deleteEvaluationResults", "x-api-path-slug"=>"actiondeleteevaluationresults-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigRuleName", "description"=>"The name of the Config rule for which you want to delete the evaluation results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Evaluations"]}}, "/?Action=DeliverConfigSnapshot"=>{"get"=>{"summary"=>"Deliver Config Snapshot", "description"=>"Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.", "operationId"=>"deliverConfigSnapshot", "x-api-path-slug"=>"actiondeliverconfigsnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"deliveryChannelName", "description"=>"The name of the delivery channel through which the snapshot is delivered", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Snapshot"]}}, "/?Action=DescribeComplianceByConfigRule"=>{"get"=>{"summary"=>"Describe Compliance By Config Rule", "description"=>"Indicates whether the specified AWS Config rules are compliant.", "operationId"=>"describeComplianceByConfigRule", "x-api-path-slug"=>"actiondescribecompliancebyconfigrule-get", "parameters"=>[{"in"=>"query", "name"=>"ComplianceTypes", "description"=>"Filters the results by compliance", "type"=>"string"}, {"in"=>"query", "name"=>"ConfigRuleNames", "description"=>"Specify one or more AWS Config rule names to filter the results by rule", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The nextToken string returned on a previous page thatyou use to get the next page of results in a paginated response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compliance"]}}, "/?Action=DescribeComplianceByResource"=>{"get"=>{"summary"=>"Describe Compliance By Resource", "description"=>"Indicates whether the specified AWS resources are compliant.", "operationId"=>"describeComplianceByResource", "x-api-path-slug"=>"actiondescribecompliancebyresource-get", "parameters"=>[{"in"=>"query", "name"=>"ComplianceTypes", "description"=>"Filters the results by compliance", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of evaluation results returned on each page", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The nextToken string returned on a previous page thatyou use to get the next page of results in a paginated response", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceId", "description"=>"The ID of the AWS resource for which you want compliance information", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceType", "description"=>"The types of AWS resources for which you want compliance information;for example, AWS::EC2::Instance", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compliance"]}}, "/?Action=DescribeConfigRuleEvaluationStatus"=>{"get"=>{"summary"=>"Describe Config Rule Evaluation Status", "description"=>"Returns status information for each of your AWS managed Config rules.", "operationId"=>"describeConfigRuleEvaluationStatus", "x-api-path-slug"=>"actiondescribeconfigruleevaluationstatus-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigRuleNames", "description"=>"The name of the AWS managed Config rules for which you want status information", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The number of rule evaluation results that you want returned", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The NextToken string returned on a previous page that you use to get the next page of results in a paginated response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Evaluations"]}}, "/?Action=DescribeConfigRules"=>{"get"=>{"summary"=>"Describe Config Rules", "description"=>"Returns details about your AWS Config rules.", "operationId"=>"describeConfigRules", "x-api-path-slug"=>"actiondescribeconfigrules-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigRuleNames", "description"=>"The names of the AWS Config rules for which you want details", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The nextToken string returned on a previous page thatyou use to get the next page of results in a paginated response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Rules"]}}, "/?Action=DescribeConfigurationRecorders"=>{"get"=>{"summary"=>"Describe Configuration Recorders", "description"=>"Returns the details for the specified configuration recorders.", "operationId"=>"describeConfigurationRecorders", "x-api-path-slug"=>"actiondescribeconfigurationrecorders-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigurationRecorderNames", "description"=>"A list of configuration recorder names", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Rules"]}}, "/?Action=DescribeConfigurationRecorderStatus"=>{"get"=>{"summary"=>"Describe Configuration Recorder Status", "description"=>"Returns the current status of the specified configuration recorder.", "operationId"=>"describeConfigurationRecorderStatus", "x-api-path-slug"=>"actiondescribeconfigurationrecorderstatus-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigurationRecorderNames", "description"=>"The name(s) of the configuration recorder", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Rules"]}}, "/?Action=DescribeDeliveryChannels"=>{"get"=>{"summary"=>"Describe Delivery Channels", "description"=>"Returns details about the specified delivery channel.", "operationId"=>"describeDeliveryChannels", "x-api-path-slug"=>"actiondescribedeliverychannels-get", "parameters"=>[{"in"=>"query", "name"=>"DeliveryChannelNames", "description"=>"A list of delivery channel names", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Delivery Channels"]}}, "/?Action=DescribeDeliveryChannelStatus"=>{"get"=>{"summary"=>"Describe Delivery Channel Status", "description"=>"Returns the current status of the specified delivery channel.", "operationId"=>"describeDeliveryChannelStatus", "x-api-path-slug"=>"actiondescribedeliverychannelstatus-get", "parameters"=>[{"in"=>"query", "name"=>"DeliveryChannelNames", "description"=>"A list of delivery channel names", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Delivery Channels"]}}, "/?Action=GetComplianceDetailsByConfigRule"=>{"get"=>{"summary"=>"Get Compliance Details By Config Rule", "description"=>"Returns the evaluation results for the specified AWS Config rule.", "operationId"=>"getComplianceDetailsByConfigRule", "x-api-path-slug"=>"actiongetcompliancedetailsbyconfigrule-get", "parameters"=>[{"in"=>"query", "name"=>"ComplianceTypes", "description"=>"Filters the results by compliance", "type"=>"string"}, {"in"=>"query", "name"=>"ConfigRuleName", "description"=>"The name of the AWS Config rule for which you want compliance information", "type"=>"string"}, {"in"=>"query", "name"=>"Limit", "description"=>"The maximum number of evaluation results returned on each page", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The nextToken string returned on a previous page thatyou use to get the next page of results in a paginated response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compliance"]}}, "/?Action=GetComplianceDetailsByResource"=>{"get"=>{"summary"=>"Get Compliance Details By Resource", "description"=>"Returns the evaluation results for the specified AWS resource.", "operationId"=>"getComplianceDetailsByResource", "x-api-path-slug"=>"actiongetcompliancedetailsbyresource-get", "parameters"=>[{"in"=>"query", "name"=>"ComplianceTypes", "description"=>"Filters the results by compliance", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The nextToken string returned on a previous page thatyou use to get the next page of results in a paginated response", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceId", "description"=>"The ID of the AWS resource for which you want compliance information", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceType", "description"=>"The type of the AWS resource for which you want compliance information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compliance"]}}, "/?Action=GetComplianceSummaryByConfigRule"=>{"get"=>{"summary"=>"Get Compliance Summary By Config Rule", "description"=>"Returns the number of AWS Config rules that are compliant and noncompliant, up to a\n\t\t\tmaximum of 25 for each.", "operationId"=>"getComplianceSummaryByConfigRule", "x-api-path-slug"=>"actiongetcompliancesummarybyconfigrule-get", "parameters"=>[{"in"=>"query", "name"=>"ComplianceSummary", "description"=>"The number of AWS Config rules that are compliant and the number that arenoncompliant, up to a maximum of 25 for each", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compliance"]}}, "/?Action=GetComplianceSummaryByResourceType"=>{"get"=>{"summary"=>"Get Compliance Summary By Resource Type", "description"=>"Returns the number of resources that are compliant and the number that are noncompliant.", "operationId"=>"getComplianceSummaryByResourceType", "x-api-path-slug"=>"actiongetcompliancesummarybyresourcetype-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceTypes", "description"=>"Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Compliance"]}}, "/?Action=GetResourceConfigHistory"=>{"get"=>{"summary"=>"Get Resource Config History", "description"=>"Returns a list of configuration items for the specified resource.", "operationId"=>"getResourceConfigHistory", "x-api-path-slug"=>"actiongetresourceconfighistory-get", "parameters"=>[{"in"=>"query", "name"=>"chronologicalOrder", "description"=>"The chronological order for configuration items listed", "type"=>"string"}, {"in"=>"query", "name"=>"earlierTime", "description"=>"The time stamp that indicates an earlier time", "type"=>"string"}, {"in"=>"query", "name"=>"laterTime", "description"=>"The time stamp that indicates a later time", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of configuration items returned on each page", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The nextToken string returned on a previous page thatyou use to get the next page of results in a paginated response", "type"=>"string"}, {"in"=>"query", "name"=>"resourceId", "description"=>"The ID of the resource (for example", "type"=>"string"}, {"in"=>"query", "name"=>"resourceType", "description"=>"The resource type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Configurations"]}}, "/?Action=ListDiscoveredResources"=>{"get"=>{"summary"=>"List Discovered Resources", "description"=>"Accepts a resource type and returns a list of resource identifiers for the resources of that type.", "operationId"=>"listDiscoveredResources", "x-api-path-slug"=>"actionlistdiscoveredresources-get", "parameters"=>[{"in"=>"query", "name"=>"includeDeletedResources", "description"=>"Specifies whether AWS Config includes deleted resources in the results", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of resource identifiers returned on each page", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"The nextToken string returned on a previous page thatyou use to get the next page of results in a paginated response", "type"=>"string"}, {"in"=>"query", "name"=>"resourceIds", "description"=>"The IDs of only those resources that you want AWS Config to list in the response", "type"=>"string"}, {"in"=>"query", "name"=>"resourceName", "description"=>"The custom name of only those resources that you want AWS Config to list in the response", "type"=>"string"}, {"in"=>"query", "name"=>"resourceType", "description"=>"The type of resources that you want AWS Config to list in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Discovered Resources"]}}, "/?Action=PutConfigRule"=>{"get"=>{"summary"=>"Put Config Rule", "description"=>"Adds or updates an AWS Config rule for evaluating whether your AWS resources comply\n\t\t\twith your desired configurations.", "operationId"=>"putConfigRule", "x-api-path-slug"=>"actionputconfigrule-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigRule", "description"=>"An AWS Config rule represents an AWS Lambda function that you create for a custom rule or a predefined function for an AWS managed rule", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Rules"]}}, "/?Action=PutConfigurationRecorder"=>{"get"=>{"summary"=>"Put Configuration Recorder", "description"=>"Creates a new configuration recorder to record the selected resource configurations.", "operationId"=>"putConfigurationRecorder", "x-api-path-slug"=>"actionputconfigurationrecorder-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigurationRecorder", "description"=>"The configuration recorder object that records each configuration change made to the resources", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Recorders"]}}, "/?Action=PutDeliveryChannel"=>{"get"=>{"summary"=>"Put Delivery Channel", "description"=>"Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.", "operationId"=>"putDeliveryChannel", "x-api-path-slug"=>"actionputdeliverychannel-get", "parameters"=>[{"in"=>"query", "name"=>"DeliveryChannel", "description"=>"The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Delivery Channels"]}}, "/?Action=PutEvaluations"=>{"get"=>{"summary"=>"Put Evaluations", "description"=>"Used by an AWS Lambda function to deliver evaluation results to AWS Config.", "operationId"=>"putEvaluations", "x-api-path-slug"=>"actionputevaluations-get", "parameters"=>[{"in"=>"query", "name"=>"Evaluations", "description"=>"The assessments that the AWS Lambda function performs", "type"=>"string"}, {"in"=>"query", "name"=>"ResultToken", "description"=>"An encrypted token that associates an evaluation with an AWS Config rule", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Evaluations"]}}, "/?Action=StartConfigRulesEvaluation"=>{"get"=>{"summary"=>"Start Config Rules Evaluation", "description"=>"Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources.", "operationId"=>"startConfigRulesEvaluation", "x-api-path-slug"=>"actionstartconfigrulesevaluation-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigRuleNames", "description"=>"The list of names of Config rules that you want to run evaluations for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Evaluations"]}}, "/?Action=StartConfigurationRecorder"=>{"get"=>{"summary"=>"Start Configuration Recorder", "description"=>"Starts recording configurations of the AWS resources you have selected to record in your AWS account.", "operationId"=>"startConfigurationRecorder", "x-api-path-slug"=>"actionstartconfigurationrecorder-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigurationRecorderName", "description"=>"The name of the recorder object that records each configuration change made to the resources", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Recorders"]}}, "/?Action=StopConfigurationRecorder"=>{"get"=>{"summary"=>"Stop Configuration Recorder", "description"=>"Stops recording configurations of the AWS resources you have selected to record in your AWS account.", "operationId"=>"stopConfigurationRecorder", "x-api-path-slug"=>"actionstopconfigurationrecorder-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigurationRecorderName", "description"=>"The name of the recorder object that records each configuration change made to the resources", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Recorders"]}}}}, "apis"=>{"name"=>"AWS Config", "x-slug"=>"aws-config", "description"=>"AWS Config is a fully managed service that provides you with an AWS resource inventory, configuration history, and configuration change notifications to enable security and governance. Config Rules enables you to create rules that automatically check the configuration of AWS resources recorded by AWS Config.With AWS Config, you can discover existing and deleted AWS resources, determine your overall compliance against rules, and dive into configuration details of a resource at any point in time. These capabilities enable compliance auditing, security analysis, resource change tracking, and troubleshooting.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Management-Tools_AWSConfig.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Applications,Authentication,Governance,Profiles,Regulations,Relative Data,Security,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-config/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Config API", "x-api-slug"=>"aws-config-api", "description"=>"AWS Config is a fully managed service that provides you with an AWS resource inventory, configuration history, and configuration change notifications to enable security and governance. Config Rules enables you to create rules that automatically check the configuration of AWS resources recorded by AWS Config.With AWS Config, you can discover existing and deleted AWS resources, determine your overall compliance against rules, and dive into configuration details of a resource at any point in time. These capabilities enable compliance auditing, security analysis, resource change tracking, and troubleshooting.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Management-Tools_AWSConfig.png", "humanURL"=>"https://aws.amazon.com/config/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Applications,Authentication,Governance,Profiles,Regulations,Relative Data,Security,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-config/aws-config-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/cli/latest/reference/configservice/index.html"}, {"type"=>"x-console", "url"=>"https://console.aws.amazon.com/config"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/config/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/config/faq/"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=184"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/config/getting-started/"}, {"type"=>"x-partners", "url"=>"https://aws.amazon.com/config/partners/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/config/pricing/"}, {"type"=>"x-support", "url"=>"https://console.aws.amazon.com/support/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/config/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
xignite{"xignite-nasdaq-last-sale-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite NASDAQ Last Sale", "description"=>"provides-realtime-access-to-last-sale-nasdaq-amex-and-nyse-information-", "version"=>"1.0.0"}, "host"=>"nasdaqlastsale.xignite.com", "basePath"=>"xNASDAQLastSale.json/XigniteNASDAQLastSale", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetLastSale"=>{"get"=>{"summary"=>"Get Last Sale", "description"=>"Returns real time stock quote for a given stock ticker", "operationId"=>"GetLastSale", "x-api-path-slug"=>"getlastsale-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Last", "Sale"]}}, "/GetLastSales"=>{"get"=>{"summary"=>"Get Last Sales", "description"=>"Returns a collection of real time stock quotes for a comma-separated list of stock quotes.", "operationId"=>"GetLastSales", "x-api-path-slug"=>"getlastsales-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Last", "Sales"]}}, "/GetBar"=>{"get"=>{"summary"=>"Get Bar", "description"=>"Returns a single bar for a specific time.", "operationId"=>"GetBar", "x-api-path-slug"=>"getbar-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bar"]}}, "/GetBars"=>{"get"=>{"summary"=>"Get Bars", "description"=>"Returns a set of bars for a stock and a time range during the trading day.", "operationId"=>"GetBars", "x-api-path-slug"=>"getbars-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bars"]}}, ", Bars"=>{"get"=>{"summary"=>"Get Chart Bars", "description"=>"Returns a set of partial bars for a stock and a time range during the trading day.", "operationId"=>"GetChartBars", "x-api-path-slug"=>"bars-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chart", "Bars"]}}, "/GetLastSaleByIdentifier"=>{"get"=>{"summary"=>"Get Last Sale By Identifier", "description"=>"Returns a real-time quote for a security based on the last trade execution.", "operationId"=>"GetLastSaleByIdentifier", "x-api-path-slug"=>"getlastsalebyidentifier-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Last", "Sale", "Identifier"]}}, "/GetLastSalesByIdentifiers"=>{"get"=>{"summary"=>"Get Last Sales By Identifiers", "description"=>"Returns a real-time quote for a security based on the last trade execution.", "operationId"=>"GetLastSalesByIdentifiers", "x-api-path-slug"=>"getlastsalesbyidentifiers-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Last", "Sales", "Identifiers"]}}, "/GetLastSaleWithFallback"=>{"get"=>{"summary"=>"Get Last Sale With Fallback", "description"=>"Returns real time stock quote for a given stock ticker", "operationId"=>"GetLastSaleWithFallback", "x-api-path-slug"=>"getlastsalewithfallback-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Last", "Sale", "Fallback"]}}, "/GetLastSaleByIdentifierWithFallback"=>{"get"=>{"summary"=>"Get Last Sale By Identifier With Fallback", "description"=>"Returns a real-time quote for a security based on the last trade execution.", "operationId"=>"GetLastSaleByIdentifierWithFallback", "x-api-path-slug"=>"getlastsalebyidentifierwithfallback-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Last", "Sale", "Identifier", "Fallback"]}}, "/GetLastSalesWithFallback"=>{"get"=>{"summary"=>"Get Last Sales With Fallback", "description"=>"Returns a collection of real time stock quotes for a comma-separated list of stock quotes.", "operationId"=>"GetLastSalesWithFallback", "x-api-path-slug"=>"getlastsaleswithfallback-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Last", "Sales", "Fallback"]}}, "/ListTradedSymbols"=>{"get"=>{"summary"=>"List Traded Symbols", "description"=>"Returns all symbols and names that are traded", "operationId"=>"ListTradedSymbols", "x-api-path-slug"=>"listtradedsymbols-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Traded", "Symbols"]}}, "/GetQuote"=>{"get"=>{"summary"=>"Get Quote", "description"=>"Returns a real-time NASDAQ BASIC quote for given security.", "operationId"=>"GetQuote", "x-api-path-slug"=>"getquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Quote"]}}, "/GetQuotes"=>{"get"=>{"summary"=>"Get Quotes", "description"=>"Returns real-time NASDAQ BASIC quotes for given securities.", "operationId"=>"GetQuotes", "x-api-path-slug"=>"getquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Quotes"]}}, "/GetExtendedQuote"=>{"get"=>{"summary"=>"Get Extended Quote", "description"=>"Returns a real-time NASDAQ BASIC quote for given security.", "operationId"=>"GetExtendedQuote", "x-api-path-slug"=>"getextendedquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extended", "Quote"]}}, "/GetExtendedQuotes"=>{"get"=>{"summary"=>"Get Extended Quotes", "description"=>"Returns real-time NASDAQ BASIC quotes for given securities.", "operationId"=>"GetExtendedQuotes", "x-api-path-slug"=>"getextendedquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extended", "Quotes"]}}}}, "xignite-money-markets-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Money Markets", "description"=>"provide-information-about-money-market-derivatives-", "version"=>"1.0.0"}, "host"=>"www.xignite.com", "basePath"=>"xMoneyMarkets.json/XigniteMoneyMarkets", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetSwapRate"=>{"get"=>{"summary"=>"Get Swap Rate", "description"=>"Returns a Swap rate", "operationId"=>"postGetswaprate", "x-api-path-slug"=>"getswaprate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Swap", "Rate"]}}, "/ListRates"=>{"get"=>{"summary"=>"List Rates", "description"=>"List supported interest rates.", "operationId"=>"postListrates", "x-api-path-slug"=>"listrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Rates"]}}, "/SearchRates"=>{"get"=>{"summary"=>"Search Rates", "description"=>"Search rate names and description", "operationId"=>"postSearchrates", "x-api-path-slug"=>"searchrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Search", "Rates"]}}, "/GetForwardRateAgreement"=>{"get"=>{"summary"=>"Get Forward Rate Agreement", "description"=>"Returns a calculated Forward Rate Agreement as of a date", "operationId"=>"postGetforwardrateagreement", "x-api-path-slug"=>"getforwardrateagreement-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Forward", "Rate", "Agreement"]}}, "/GetEuroDollarFRAStrip"=>{"get"=>{"summary"=>"Get Euro Dollar FRA Strip", "description"=>"Returns an IMM EuroDollar Synthetic Forward Rate strip", "operationId"=>"postGeteurodollarfrastrip", "x-api-path-slug"=>"geteurodollarfrastrip-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Euro", "Dollar", "Strip"]}}, "/GetSwaption"=>{"get"=>{"summary"=>"Get Swaption", "description"=>"Returns a Swaption rate", "operationId"=>"postGetswaption", "x-api-path-slug"=>"getswaption-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Swaption"]}}, "/GetSwaptionFamily"=>{"get"=>{"summary"=>"Get Swaption Family", "description"=>"Returns a Swaption rate Family", "operationId"=>"postGetswaptionfamily", "x-api-path-slug"=>"getswaptionfamily-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Swaption", "Family"]}}, "/GetHistoricalSwaption"=>{"get"=>{"summary"=>"Get Historical Swaption", "description"=>"Returns a Swaption as of a historical date", "operationId"=>"postGethistoricalswaption", "x-api-path-slug"=>"gethistoricalswaption-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Swaption"]}}, "/GetHistoricalSwaptionFamily"=>{"get"=>{"summary"=>"Get Historical Swaption Family", "description"=>"Returns a Swaption rate Family", "operationId"=>"postGethistoricalswaptionfamily", "x-api-path-slug"=>"gethistoricalswaptionfamily-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Swaption", "Family"]}}, "/GetSwapRateFamily"=>{"get"=>{"summary"=>"Get Swap Rate Family", "description"=>"Returns a Swap rate Family", "operationId"=>"postGetswapratefamily", "x-api-path-slug"=>"getswapratefamily-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Swap", "Rate", "Family"]}}, "/GetHistoricalSwapRate"=>{"get"=>{"summary"=>"Get Historical Swap Rate", "description"=>"Returns a Swap rate as of a historical date", "operationId"=>"postGethistoricalswaprate", "x-api-path-slug"=>"gethistoricalswaprate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Swap", "Rate"]}}, "/GetHistoricalSwapRateRange"=>{"get"=>{"summary"=>"Get Historical Swap Rate Range", "description"=>"Returns a Swap rate as of a historical date", "operationId"=>"postGethistoricalswapraterange", "x-api-path-slug"=>"gethistoricalswapraterange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Swap", "Rate", "Range"]}}, "/GetSwapRateExtended"=>{"get"=>{"summary"=>"Get Swap Rate Extended", "description"=>"Returns latest Swap rate", "operationId"=>"postGetswaprateextended", "x-api-path-slug"=>"getswaprateextended-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Swap", "Rate", "Extended"]}}, "/GetSwapRateFamilyExtended"=>{"get"=>{"summary"=>"Get Swap Rate Family Extended", "description"=>"Returns latest Swap rate family", "operationId"=>"postGetswapratefamilyextended", "x-api-path-slug"=>"getswapratefamilyextended-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Swap", "Rate", "Family", "Extended"]}}, "/GetHistoricalSwapRateExtended"=>{"get"=>{"summary"=>"Get Historical Swap Rate Extended", "description"=>"Returns historical swap rate", "operationId"=>"postGethistoricalswaprateextended", "x-api-path-slug"=>"gethistoricalswaprateextended-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Swap", "Rate", "Extended"]}}, "/GetHistoricalSwapRateExtendedRange"=>{"get"=>{"summary"=>"Get Historical Swap Rate Extended Range", "description"=>"Returns historical Swap rate range", "operationId"=>"postGethistoricalswaprateextendedrange", "x-api-path-slug"=>"gethistoricalswaprateextendedrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Swap", "Rate", "Extended", "Range"]}}, "/ListSwapRates"=>{"get"=>{"summary"=>"List Swap Rates", "description"=>"Returns swap rate currencies and tenors", "operationId"=>"postListswaprates", "x-api-path-slug"=>"listswaprates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Swap", "Rates"]}}, "/GetTreasuryRate"=>{"get"=>{"summary"=>"Get Treasury Rate", "description"=>"Returns a real-time Treasury rate", "operationId"=>"postGettreasuryrate", "x-api-path-slug"=>"gettreasuryrate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Treasury", "Rate"]}}, "/GetTreasuryRateFamily"=>{"get"=>{"summary"=>"Get Treasury Rate Family", "description"=>"Returns a real-time Treasury rate family.", "operationId"=>"postGettreasuryratefamily", "x-api-path-slug"=>"gettreasuryratefamily-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Treasury", "Rate", "Family"]}}}}, "xignite-navs-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite NAVs", "description"=>"this-web-service-provides-latest-nav-information-for-all-funds-", "version"=>"1.0.0"}, "host"=>"navs.xignite.com", "basePath"=>"v2/xNAVs.json/XigniteNAVs", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetLatestNAV"=>{"get"=>{"summary"=>"Get Latest NAV", "description"=>"This operation returns the latest NAV information for a funds.", "operationId"=>"GetLatestNAV", "x-api-path-slug"=>"getlatestnav-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Latest", "NAV"]}}, "/GetLatestNAVs"=>{"get"=>{"summary"=>"Get Latest NAVs", "description"=>"This operation returns the latest NAV information for a list of funds.", "operationId"=>"GetLatestNAVs", "x-api-path-slug"=>"getlatestnavs-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Latest", "NAVs"]}}, "/ListFundsBySymbol"=>{"get"=>{"summary"=>"List Funds By Symbol", "description"=>"This operation returns a list of funds descreptive information.", "operationId"=>"ListFundsBySymbol", "x-api-path-slug"=>"listfundsbysymbol-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Funds", "Symbol"]}}}}, "xignite-ipos-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite IPOs", "description"=>"this-web-service-provides-ipo-data-", "version"=>"1.0.0"}, "host"=>"ipos.xignite.com", "basePath"=>"xIPOs.json/XigniteIPOs", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetIPO"=>{"get"=>{"summary"=>"Get IPO", "description"=>"Post getipo", "operationId"=>"GetIPO", "x-api-path-slug"=>"getipo-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "IPO"]}}, "/GetIPOCalendar"=>{"get"=>{"summary"=>"Get IPO Calendar", "description"=>"Post getipocalendar", "operationId"=>"GetIPOCalendar", "x-api-path-slug"=>"getipocalendar-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "IPO", "Calendar"]}}, "/GetIPOCalendarByExchange"=>{"get"=>{"summary"=>"Get IPO Calendar By Exchange", "description"=>"Post getipocalendarbyexchange", "operationId"=>"GetIPOCalendarByExchange", "x-api-path-slug"=>"getipocalendarbyexchange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "IPO", "Calendar", "Exchange"]}}, "/ListExchanges"=>{"get"=>{"summary"=>"List Exchanges", "description"=>"Post listexchanges", "operationId"=>"ListExchanges", "x-api-path-slug"=>"listexchanges-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Exchanges"]}}, "/GetIPOByStatus"=>{"get"=>{"summary"=>"Get IPO By Status", "description"=>"Post getipobystatus", "operationId"=>"GetIPOByStatus", "x-api-path-slug"=>"getipobystatus-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "IPO", "Status"]}}, "/GetIPOList"=>{"get"=>{"summary"=>"Get IPO List", "description"=>"Post getipolist", "operationId"=>"GetIPOList", "x-api-path-slug"=>"getipolist-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "IPO", "List"]}}, "/GetIPODetails"=>{"get"=>{"summary"=>"Get IPO Details", "description"=>"Post getipodetails", "operationId"=>"GetIPODetails", "x-api-path-slug"=>"getipodetails-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "IPO"]}}, "/SearchIPOBySymbol"=>{"get"=>{"summary"=>"Search IPO By Symbol", "description"=>"Post searchipobysymbol", "operationId"=>"SearchIPOBySymbol", "x-api-path-slug"=>"searchipobysymbol-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Search", "IPO", "Symbol"]}}, "/SearchIPOByName"=>{"get"=>{"summary"=>"Search IPO By Name", "description"=>"Post searchipobyname", "operationId"=>"SearchIPOByName", "x-api-path-slug"=>"searchipobyname-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Search", "IPO", "Name"]}}, "/GetIPOPerformance"=>{"get"=>{"summary"=>"Get IPO Performance", "description"=>"Post getipoperformance", "operationId"=>"GetIPOPerformance", "x-api-path-slug"=>"getipoperformance-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "IPO", "Performance"]}}}}, "xignite-municipal-bond-master-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Municipal Bond Master", "description"=>"xignitemunicipalbondmaster-web-service-provides-security-master-data-and-associated-reference-data-for-municipal-bonds-issued-by-states-counties-cities-and-special-tax-districts-along-with-special-agencies-of-state-and-local-governments-", "version"=>"1.0.0"}, "host"=>"municipalbondmaster.xignite.com", "basePath"=>"xmunicipalbondmaster.json/XigniteMunicipalBondMaster", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetBondDescription"=>{"get"=>{"summary"=>"Get Bond Description", "description"=>"This service returns description of one or more Municipal Bonds that match the identifier provided. If a CUSIP is provided in the input one Municipal Bond is returned, if IssueIdentifier is provided one or more bonds related to that Issue are returned.", "operationId"=>"GetBondDescription", "x-api-path-slug"=>"getbonddescription-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bond"]}}}}, "xignite-fact-set-estimates-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Fact Set Estimates", "description"=>"this-web-service-provides-global-estimate-data-", "version"=>"1.0.0"}, "host"=>"factsetestimates.xignite.com", "basePath"=>"xFactSetEstimates.json/XigniteFactSetEstimates", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetEstimates"=>{"get"=>{"summary"=>"Get Estimates", "description"=>"Get Estimates on AsOfDate", "operationId"=>"GetEstimates", "x-api-path-slug"=>"getestimates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Estimates"]}}, "/GetLatestRecommendationSummaries"=>{"get"=>{"summary"=>"Get Latest Recommendation Summaries", "description"=>"Get Latest Recommendation Summary", "operationId"=>"GetLatestRecommendationSummaries", "x-api-path-slug"=>"getlatestrecommendationsummaries-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Recommendation", "Summaries"]}}, "/ListExchanges"=>{"get"=>{"summary"=>"List Exchanges", "description"=>"List Exchanges", "operationId"=>"ListExchanges", "x-api-path-slug"=>"listexchanges-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Exchanges"]}}, "/ListCompanies"=>{"get"=>{"summary"=>"List Companies", "description"=>"List Symbols", "operationId"=>"ListCompanies", "x-api-path-slug"=>"listcompanies-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Companies"]}}, "/ListEstimates"=>{"get"=>{"summary"=>"List Estimates", "description"=>"List Estimates", "operationId"=>"ListEstimates", "x-api-path-slug"=>"listestimates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Estimates"]}}, "/GetLatestEstimates"=>{"get"=>{"summary"=>"Get Latest Estimates", "description"=>"Get Latest Estimates", "operationId"=>"GetLatestEstimates", "x-api-path-slug"=>"getlatestestimates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Estimates"]}}, "/GetEstimatesRange"=>{"get"=>{"summary"=>"Get Estimates Range", "description"=>"Get Estimates Range", "operationId"=>"GetEstimatesRange", "x-api-path-slug"=>"getestimatesrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Estimates", "Range"]}}, "/GetRecommendationSummaryRange"=>{"get"=>{"summary"=>"Get Recommendation Summary Range", "description"=>"Get Recommendation Summaries in Range", "operationId"=>"GetRecommendationSummaryRange", "x-api-path-slug"=>"getrecommendationsummaryrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Recommendation", "Summary", "Range"]}}, "/GetRecommendationSummaries"=>{"get"=>{"summary"=>"Get Recommendation Summaries", "description"=>"Get Recommendation Summaries on AsOfDate", "operationId"=>"GetRecommendationSummaries", "x-api-path-slug"=>"getrecommendationsummaries-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Recommendation", "Summaries"]}}}}, "xignite-historical-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Historical", "description"=>"this-web-service-provides-historical-security-pricing-for-us-equities-", "version"=>"1.0.0"}, "host"=>"www.xignite.com", "basePath"=>"xHistorical.json/XigniteHistorical", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetHistoricalQuoteAdjusted"=>{"get"=>{"summary"=>"Get Historical Quote Adjusted", "description"=>"Returns a quote as of a historical date. This includes split and dividends adjusted price.", "operationId"=>"postGethistoricalquoteadjusted", "x-api-path-slug"=>"gethistoricalquoteadjusted-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Quote", "Adjusted"]}}, "/GetHistoricalQuotesAdjusted"=>{"get"=>{"summary"=>"Get Historical Quotes Adjusted", "description"=>"Returns a quote as of a historical date. This includes split and dividends adjusted price.", "operationId"=>"postGethistoricalquotesadjusted", "x-api-path-slug"=>"gethistoricalquotesadjusted-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Quotes", "Adjusted"]}}, "/GetHistoricalMonthlyQuotesRangeAdjusted"=>{"get"=>{"summary"=>"Get Historical Monthly Quotes Range Adjusted", "description"=>"This operation returns end of month quotes for a US equity. This includes split and dividends adjusted price.", "operationId"=>"postGethistoricalmonthlyquotesrangeadjusted", "x-api-path-slug"=>"gethistoricalmonthlyquotesrangeadjusted-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Monthly", "Quotes", "Range", "Adjusted"]}}, "/GetHistoricalQuotesAsOfAdjusted"=>{"get"=>{"summary"=>"Get Historical Quotes As Of Adjusted", "description"=>"This operation returns a range of quotes for a security. This includes split and dividends adjusted price.", "operationId"=>"postGethistoricalquotesasofadjusted", "x-api-path-slug"=>"gethistoricalquotesasofadjusted-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Quotes", "As", "Adjusted"]}}, "/GetHistoricalQuotesRangeAdjusted"=>{"get"=>{"summary"=>"Get Historical Quotes Range Adjusted", "description"=>"This operation returns a complete range of stock quotes for a US equity. This includes and dividends adjusted price.", "operationId"=>"postGethistoricalquotesrangeadjusted", "x-api-path-slug"=>"gethistoricalquotesrangeadjusted-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Quotes", "Range", "Adjusted"]}}, "/GetHistoricalWeeklyQuotesRangeAdjusted"=>{"get"=>{"summary"=>"Get Historical Weekly Quotes Range Adjusted", "description"=>"This operation returns end of week quotes for a US equity. This includes split and dividends adjusted price.", "operationId"=>"postGethistoricalweeklyquotesrangeadjusted", "x-api-path-slug"=>"gethistoricalweeklyquotesrangeadjusted-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Weekly", "Quotes", "Range", "Adjusted"]}}, "/GetHistoricalQuarterlyQuotesRangeAdjusted"=>{"get"=>{"summary"=>"Get Historical Quarterly Quotes Range Adjusted", "description"=>"This operation returns end of quarter quotes for a US equity. This includes split and dividends adjusted price.", "operationId"=>"postGethistoricalquarterlyquotesrangeadjusted", "x-api-path-slug"=>"gethistoricalquarterlyquotesrangeadjusted-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Quarterly", "Quotes", "Range", "Adjusted"]}}, "/GetLastClosingPrice"=>{"get"=>{"summary"=>"Get Last Closing Price", "description"=>"Returns last closing price for a security.", "operationId"=>"postGetlastclosingprice", "x-api-path-slug"=>"getlastclosingprice-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Last", "Closing", "Price"]}}, "/GetLastClosingPriceAdjusted"=>{"get"=>{"summary"=>"Get Last Closing Price Adjusted", "description"=>"Returns last closing price for a security. This include the splits and dividends adjusted price", "operationId"=>"postGetlastclosingpriceadjusted", "x-api-path-slug"=>"getlastclosingpriceadjusted-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Last", "Closing", "Price", "Adjusted"]}}, "/GetLastClosingPrices"=>{"get"=>{"summary"=>"Get Last Closing Prices", "description"=>"Returns last closing price for a collection of securities.", "operationId"=>"postGetlastclosingprices", "x-api-path-slug"=>"getlastclosingprices-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Last", "Closing", "Prices"]}}, "/GetLastClosingPricesAdjusted"=>{"get"=>{"summary"=>"Get Last Closing Prices Adjusted", "description"=>"Returns last closing price for a collection of securities.This include the splits and dividends adjusted price", "operationId"=>"postGetlastclosingpricesadjusted", "x-api-path-slug"=>"getlastclosingpricesadjusted-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Last", "Closing", "Prices", "Adjusted"]}}, "/GetLastClosingPricesOrdered"=>{"get"=>{"summary"=>"Get Last Closing Prices Ordered", "description"=>"Returns last closing price for a collection of securities.", "operationId"=>"postGetlastclosingpricesordered", "x-api-path-slug"=>"getlastclosingpricesordered-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Last", "Closing", "Prices", "Ordered"]}}, "/GetLastClosingPricesOrderedAdjusted"=>{"get"=>{"summary"=>"Get Last Closing Prices Ordered Adjusted", "description"=>"Returns last closing price for a collection of securities.This include the splits and dividends adjusted price", "operationId"=>"postGetlastclosingpricesorderedadjusted", "x-api-path-slug"=>"getlastclosingpricesorderedadjusted-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Last", "Closing", "Prices", "Ordered", "Adjusted"]}}, "/GetHistoricalHighLow"=>{"get"=>{"summary"=>"Get Historical High Low", "description"=>"Returns a historical high low for a time range.", "operationId"=>"postGethistoricalhighlow", "x-api-path-slug"=>"gethistoricalhighlow-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "High", "Low"]}}, "/GetHistoricalQuote"=>{"get"=>{"summary"=>"Get Historical Quote", "description"=>"Returns a quote as of a historical date. This includes split adjusted price.", "operationId"=>"postGethistoricalquote", "x-api-path-slug"=>"gethistoricalquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Quote"]}}, "/GetHistoricalQuotes"=>{"get"=>{"summary"=>"Get Historical Quotes", "description"=>"Returns a quote as of a historical date. This includes split adjusted price.", "operationId"=>"postGethistoricalquotes", "x-api-path-slug"=>"gethistoricalquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Quotes"]}}, "/GetHistoricalQuotesAsOf"=>{"get"=>{"summary"=>"Get Historical Quotes As Of", "description"=>"This operation returns a range of quotes for a security.", "operationId"=>"postGethistoricalquotesasof", "x-api-path-slug"=>"gethistoricalquotesasof-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Quotes", "As", "Of"]}}, "/GetHistoricalQuotesRange"=>{"get"=>{"summary"=>"Get Historical Quotes Range", "description"=>"This operation returns a complete range of stock quotes for a US equity. This includes split adjusted price.", "operationId"=>"postGethistoricalquotesrange", "x-api-path-slug"=>"gethistoricalquotesrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Quotes", "Range"]}}, "/GetHistoricalMonthlyQuotesRange"=>{"get"=>{"summary"=>"Get Historical Monthly Quotes Range", "description"=>"This operation returns end of month quotes for a US equity. This includes split adjusted price.", "operationId"=>"postGethistoricalmonthlyquotesrange", "x-api-path-slug"=>"gethistoricalmonthlyquotesrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Monthly", "Quotes", "Range"]}}, "/GetHistoricalWeeklyQuotesRange"=>{"get"=>{"summary"=>"Get Historical Weekly Quotes Range", "description"=>"This operation returns end of week quotes for a US equity. This includes split adjusted price.", "operationId"=>"postGethistoricalweeklyquotesrange", "x-api-path-slug"=>"gethistoricalweeklyquotesrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Weekly", "Quotes", "Range"]}}, "/GetHistoricalQuarterlyQuotesRange"=>{"get"=>{"summary"=>"Get Historical Quarterly Quotes Range", "description"=>"This operation returns end of quarter quotes for a US equity. This includes split adjusted price.", "operationId"=>"postGethistoricalquarterlyquotesrange", "x-api-path-slug"=>"gethistoricalquarterlyquotesrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Quarterly", "Quotes", "Range"]}}, "/GetTopMovers"=>{"get"=>{"summary"=>"Get Top Movers", "description"=>"This operation returns quote information about the top moving equities from NYSE, NASDAQ and AMEX.", "operationId"=>"postGettopmovers", "x-api-path-slug"=>"gettopmovers-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Movers"]}}, "/GetTopMoversByExchange"=>{"get"=>{"summary"=>"Get Top Movers By Exchange", "description"=>"This operation returns quote information about the top moving equities from NYSE, NASDAQ and AMEX.", "operationId"=>"postGettopmoversbyexchange", "x-api-path-slug"=>"gettopmoversbyexchange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Movers", "Exchange"]}}, "/GetTopGainers"=>{"get"=>{"summary"=>"Get Top Gainers", "description"=>"This operation returns quote information about the top gaining equities from NYSE, NASDAQ and AMEX.", "operationId"=>"postGettopgainers", "x-api-path-slug"=>"gettopgainers-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Gainers"]}}, "/GetTopLosers"=>{"get"=>{"summary"=>"Get Top Losers", "description"=>"This operation returns quote information about the top losing equities from NYSE, NASDAQ and AMEX.", "operationId"=>"postGettoplosers", "x-api-path-slug"=>"gettoplosers-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Losers"]}}, "/GetTopMoversByMarketCapitalization"=>{"get"=>{"summary"=>"Get Top Movers By Market Capitalization", "description"=>"This operation returns quote information about the top moving equities filtered by market capitalization from NYSE, NASDAQ and AMEX.", "operationId"=>"postGettopmoversbymarketcapitalization", "x-api-path-slug"=>"gettopmoversbymarketcapitalization-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Movers", "Market", "Capitalization"]}}, "/GetTopGainersByMarketCapitalization"=>{"get"=>{"summary"=>"Get Top Gainers By Market Capitalization", "description"=>"This operation returns quote information about the top gaining equities filtered by market capitalization from NYSE, NASDAQ and AMEX.", "operationId"=>"postGettopgainersbymarketcapitalization", "x-api-path-slug"=>"gettopgainersbymarketcapitalization-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Gainers", "Market", "Capitalization"]}}, "/GetTopLosersByMarketCapitalization"=>{"get"=>{"summary"=>"Get Top Losers By Market Capitalization", "description"=>"This operation returns quote information about the top losing equities filtered by market capitalization from NYSE, NASDAQ and AMEX.", "operationId"=>"postGettoplosersbymarketcapitalization", "x-api-path-slug"=>"gettoplosersbymarketcapitalization-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Losers", "Market", "Capitalization"]}}, "/GetDividendHistory"=>{"get"=>{"summary"=>"Get Dividend History", "description"=>"Get dividend history for a stock.", "operationId"=>"postGetdivendhistory", "x-api-path-slug"=>"getdividendhistory-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Dividend", "History"]}}, "/GetDividendHistoryRange"=>{"get"=>{"summary"=>"Get Dividend History Range", "description"=>"Get dividend history for a stock.", "operationId"=>"postGetdivendhistoryrange", "x-api-path-slug"=>"getdividendhistoryrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Dividend", "History", "Range"]}}, "/GetExtendedDividendHistory"=>{"get"=>{"summary"=>"Get Extended Dividend History", "description"=>"Get extended dividend history for a stock.", "operationId"=>"postGetextendeddivendhistory", "x-api-path-slug"=>"getextendeddividendhistory-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Extended", "Dividend", "History"]}}, "/GetExtendedDividendHistoryRange"=>{"get"=>{"summary"=>"Get Extended Dividend History Range", "description"=>"Get extended dividend history range for a stock.", "operationId"=>"postGetextendeddivendhistoryrange", "x-api-path-slug"=>"getextendeddividendhistoryrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Extended", "Dividend", "History", "Range"]}}, "/GetCompleteDividendHistoryRange"=>{"get"=>{"summary"=>"Get Complete Dividend History Range", "description"=>"Get extended dividend history range for a stock.", "operationId"=>"postGetcompletedivendhistoryrange", "x-api-path-slug"=>"getcompletedividendhistoryrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Complete", "Dividend", "History", "Range"]}}, "/GetSplitHistory"=>{"get"=>{"summary"=>"Get Split History", "description"=>"Get split history for a stock for a date range.", "operationId"=>"postGetsplithistory", "x-api-path-slug"=>"getsplithistory-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Split", "History"]}}, "/GetAllSplits"=>{"get"=>{"summary"=>"Get All Splits", "description"=>"Get all splits for a date range.", "operationId"=>"postGetallsplits", "x-api-path-slug"=>"getallsplits-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Splits"]}}, "/GetAllExtendedDividends"=>{"get"=>{"summary"=>"Get All Extended Dividends", "description"=>"Get all extended dividend for a date range.", "operationId"=>"postGetallextendeddivends", "x-api-path-slug"=>"getallextendeddividends-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Extended", "Dividends"]}}, "/GetAllDividends"=>{"get"=>{"summary"=>"Get All Dividends", "description"=>"Get all splits for a date range.", "operationId"=>"postGetalldivends", "x-api-path-slug"=>"getalldividends-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Dividends"]}}, "/GetSplitRatio"=>{"get"=>{"summary"=>"Get Split Ratio", "description"=>"Return the cumulative split ratio for a security between two dates. For instance, if a security saw a 3:1 split and 2:1 split during the period, the split ratio 6 is returned. Returns 1 if no split occurred.", "operationId"=>"postGetsplitratio", "x-api-path-slug"=>"getsplitratio-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Split", "Ratio"]}}, "/GetSymbols"=>{"get"=>{"summary"=>"Get Symbols", "description"=>"Returns a list of symbols available in the historical database.", "operationId"=>"postGetsymbols", "x-api-path-slug"=>"getsymbols-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Symbols"]}}, "/GetAdvancesAndDeclines"=>{"get"=>{"summary"=>"Get Advances And Declines", "description"=>"Returns numbers of advancing and declining stocks by price and volume across exchanges. For more information, go to http://www.xignite.com/", "operationId"=>"postGetadvancesanddeclines", "x-api-path-slug"=>"getadvancesanddeclines-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Advances", "Declines"]}}, "/GetHistoricalStatistics"=>{"get"=>{"summary"=>"Get Historical Statistics", "description"=>"Returns Historical statistics for a security. For more information, go to http://www.xignite.com/", "operationId"=>"postGethistoricalstatistics", "x-api-path-slug"=>"gethistoricalstatistics-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Statistics"]}}}}, "xignite-interbanks-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite InterBanks", "description"=>"provide-information-about-global-interbank-interest-rates-", "version"=>"1.0.0"}, "host"=>"www.xignite.com", "basePath"=>"xInterBanks.json/XigniteInterBanks", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/ListRates"=>{"get"=>{"summary"=>"List Rates", "description"=>"List supported interest rates.", "operationId"=>"postListrates", "x-api-path-slug"=>"listrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Rates"]}}, "/SearchRates"=>{"get"=>{"summary"=>"Search Rates", "description"=>"Search rate names and description", "operationId"=>"postSearchrates", "x-api-path-slug"=>"searchrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Search", "Rates"]}}, "/GetLIBORSecure"=>{"get"=>{"summary"=>"Get LIBOR Secure", "description"=>"Returns Libor as of a date", "operationId"=>"postGetliborsecure", "x-api-path-slug"=>"getliborsecure-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "LIBOR", "Secure"]}}, "/GetLIBOR"=>{"get"=>{"summary"=>"Get LIBOR", "description"=>"Returns Libor as of a date", "operationId"=>"postGetlibor", "x-api-path-slug"=>"getlibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "LIBOR"]}}, "/GetREIBOR"=>{"get"=>{"summary"=>"Get REIBOR", "description"=>"Returns a REIBOR as of a date", "operationId"=>"postGetreibor", "x-api-path-slug"=>"getreibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "REIBOR"]}}, "/GetHIBOR"=>{"get"=>{"summary"=>"Get H I BOR", "description"=>"Returns a HIBOR as of a date", "operationId"=>"postGethibor", "x-api-path-slug"=>"gethibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "H", "I", "BOR"]}}, "/GetBUBOR"=>{"get"=>{"summary"=>"Get BUBOR", "description"=>"Returns a BUBOR as of a date", "operationId"=>"postGetbubor", "x-api-path-slug"=>"getbubor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "BUBOR"]}}, "/GetSOFIBOR"=>{"get"=>{"summary"=>"Get SOFIBOR", "description"=>"Returns a SOFIBOR as of a date", "operationId"=>"postGetsofibor", "x-api-path-slug"=>"getsofibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "SOFIBOR"]}}, "/GetREIBID"=>{"get"=>{"summary"=>"Get REIBID", "description"=>"Returns a REIBID as of a date", "operationId"=>"postGetreib", "x-api-path-slug"=>"getreibid-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "REIBID"]}}, "/GetOIBOR"=>{"get"=>{"summary"=>"Get OIBOR", "description"=>"Returns a OIBOR as of a date", "operationId"=>"postGetoibor", "x-api-path-slug"=>"getoibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "OIBOR"]}}, "/GetSIBOR"=>{"get"=>{"summary"=>"Get SIBOR", "description"=>"Returns a SIBOR as of a date", "operationId"=>"postGetsibor", "x-api-path-slug"=>"getsibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "SIBOR"]}}, "/GetCIBOR"=>{"get"=>{"summary"=>"Get CIBOR", "description"=>"Returns a CIBOR as of a date", "operationId"=>"postGetcibor", "x-api-path-slug"=>"getcibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "CIBOR"]}}, "/GetSTIBOR"=>{"get"=>{"summary"=>"Get STIBOR", "description"=>"Returns a STIBOR as of a date", "operationId"=>"postGetstibor", "x-api-path-slug"=>"getstibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "STIBOR"]}}, "/GetWIBOR"=>{"get"=>{"summary"=>"Get WIBOR", "description"=>"Returns a WIBOR as of a date", "operationId"=>"postGetwibor", "x-api-path-slug"=>"getwibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "WIBOR"]}}, "/GetVILIBOR"=>{"get"=>{"summary"=>"Get VILIBOR", "description"=>"Returns a VILIBOR as of a date", "operationId"=>"postGetvilibor", "x-api-path-slug"=>"getvilibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "VILIBOR"]}}, "/GetEURIBOR"=>{"get"=>{"summary"=>"Get EURIBOR", "description"=>"Returns a EURIBOR as of a date", "operationId"=>"postGeteuribor", "x-api-path-slug"=>"geteuribor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "EURIBOR"]}}, "/GetPRIBOR"=>{"get"=>{"summary"=>"Get PRIBOR", "description"=>"Returns a PRIBOR as of a date", "operationId"=>"postGetpribor", "x-api-path-slug"=>"getpribor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "PRIBOR"]}}, "/GetKORIBOR"=>{"get"=>{"summary"=>"Get KORIBOR", "description"=>"Returns a KORIBOR as of a date", "operationId"=>"postGetkoribor", "x-api-path-slug"=>"getkoribor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "KORIBOR"]}}, "/GetMIBOR"=>{"get"=>{"summary"=>"Get MIBOR", "description"=>"Returns a MIBOR as of a date", "operationId"=>"postGetmibor", "x-api-path-slug"=>"getmibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "MIBOR"]}}, "/GetMIBID"=>{"get"=>{"summary"=>"Get MIBID", "description"=>"Returns a MIBOID as of a date", "operationId"=>"postGetmib", "x-api-path-slug"=>"getmibid-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "MIBID"]}}, "/GetSABOR"=>{"get"=>{"summary"=>"Get SABOR", "description"=>"Returns a SABOR as of a date", "operationId"=>"postGetsabor", "x-api-path-slug"=>"getsabor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "SABOR"]}}, "/GetTAIBOR"=>{"get"=>{"summary"=>"Get TAIBOR", "description"=>"Returns a TAIBOR as of a date", "operationId"=>"postGettaibor", "x-api-path-slug"=>"gettaibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "TAIBOR"]}}, "/GetTURKIBOR"=>{"get"=>{"summary"=>"Get TURKIBOR", "description"=>"Returns a TURKIBOR as of a date", "operationId"=>"postGetturkibor", "x-api-path-slug"=>"getturkibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "TURKIBOR"]}}, "/GetMEXIBOR"=>{"get"=>{"summary"=>"Get MEXIBOR", "description"=>"Returns a MEXIBOR as of a date", "operationId"=>"postGetmexibor", "x-api-path-slug"=>"getmexibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "MEXIBOR"]}}, "/GetTELBOR"=>{"get"=>{"summary"=>"Get TELBOR", "description"=>"Returns a TELBOR as of a date", "operationId"=>"postGettelbor", "x-api-path-slug"=>"gettelbor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "TELBOR"]}}, "/GetCHILIBOR"=>{"get"=>{"summary"=>"Get CHILIBOR", "description"=>"Returns a TELBOR as of a date", "operationId"=>"postGetchilibor", "x-api-path-slug"=>"getchilibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "CHILIBOR"]}}, "/GetCHIBOR"=>{"get"=>{"summary"=>"Get CHIBOR", "description"=>"Returns a CHIBOR as of a date", "operationId"=>"postGetchibor", "x-api-path-slug"=>"getchibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "CHIBOR"]}}, "/GetCDOR"=>{"get"=>{"summary"=>"Get CDOR", "description"=>"Returns a CDOR as of a date", "operationId"=>"postGetcdor", "x-api-path-slug"=>"getcdor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "CDOR"]}}, "/GetKAIBOR"=>{"get"=>{"summary"=>"Get KAIBOR", "description"=>"Returns a KAIBOR as of a date", "operationId"=>"postGetkaibor", "x-api-path-slug"=>"getkaibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "KAIBOR"]}}, "/GetKIBOR"=>{"get"=>{"summary"=>"Get KIBOR", "description"=>"Returns a KIBOR as of a date", "operationId"=>"postGetkibor", "x-api-path-slug"=>"getkibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "KIBOR"]}}, "/GetKIBID"=>{"get"=>{"summary"=>"Get KIBID", "description"=>"Returns a KIBID as of a date", "operationId"=>"postGetkib", "x-api-path-slug"=>"getkibid-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "KIBID"]}}, "/GetSHIBOR"=>{"get"=>{"summary"=>"Get SHIBOR", "description"=>"Returns a SHIBOR as of a date", "operationId"=>"postGetshibor", "x-api-path-slug"=>"getshibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "SHIBOR"]}}, "/GetJIBOR"=>{"get"=>{"summary"=>"Get JIBOR", "description"=>"Returns a JIBOR as of a date", "operationId"=>"postGetjibor", "x-api-path-slug"=>"getjibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "JIBOR"]}}, "/GetKLIBOR"=>{"get"=>{"summary"=>"Get KLIBOR", "description"=>"Returns a KLIBOR as of a date", "operationId"=>"postGetklibor", "x-api-path-slug"=>"getklibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "KLIBOR"]}}, "/GetTIBOR"=>{"get"=>{"summary"=>"Get TIBOR", "description"=>"Returns a TIBOR as of a date", "operationId"=>"postGettibor", "x-api-path-slug"=>"gettibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "TIBOR"]}}, "/GetPHIBOR"=>{"get"=>{"summary"=>"Get PHIBOR", "description"=>"Returns a PHIBOR as of a date", "operationId"=>"postGetphibor", "x-api-path-slug"=>"getphibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "PHIBOR"]}}, "/GetBKIBOR"=>{"get"=>{"summary"=>"Get BKIBOR", "description"=>"Returns a BKIBOR as of a date", "operationId"=>"postGetbkibor", "x-api-path-slug"=>"getbkibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "BKIBOR"]}}, "/GetVNIBOR"=>{"get"=>{"summary"=>"Get VNIBOR", "description"=>"Returns a VNIBOR as of a date", "operationId"=>"postGetvnibor", "x-api-path-slug"=>"getvnibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "VNIBOR"]}}, "/GetMOSIBOR"=>{"get"=>{"summary"=>"Get MOSIBOR", "description"=>"Returns a MOSIBOR as of a date", "operationId"=>"postGetmosibor", "x-api-path-slug"=>"getmosibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "MOSIBOR"]}}, "/GetMOSIBID"=>{"get"=>{"summary"=>"Get MOSIBID", "description"=>"Returns a MOSIBID as of a date", "operationId"=>"postGetmosib", "x-api-path-slug"=>"getmosibid-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "MOSIBID"]}}, "/GetHistoricalLIBOR"=>{"get"=>{"summary"=>"Get Historical LIBOR", "description"=>"", "operationId"=>"postGethistoricallibor", "x-api-path-slug"=>"gethistoricallibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "LIBOR"]}}, "/GetBRAZIBOR"=>{"get"=>{"summary"=>"Get BRAZIBOR", "description"=>"Returns a BRAZIBOR as of a date", "operationId"=>"postGetbrazibor", "x-api-path-slug"=>"getbrazibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "BRAZIBOR"]}}, "/GetTRLIBOR"=>{"get"=>{"summary"=>"Get TRLIBOR", "description"=>"Returns a TRLIBOR as of a date", "operationId"=>"postGettrlibor", "x-api-path-slug"=>"gettrlibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "TRLIBOR"]}}, "/GetTRLIBID"=>{"get"=>{"summary"=>"Get TRLIBID", "description"=>"Returns a TRLIBID as of a date", "operationId"=>"postGettrlib", "x-api-path-slug"=>"gettrlibid-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "TRLIBID"]}}, "/GetBRIBOR"=>{"get"=>{"summary"=>"Get BRIBOR", "description"=>"Returns a BRIBOR as of a date", "operationId"=>"postGetbribor", "x-api-path-slug"=>"getbribor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "BRIBOR"]}}, "/GetBRIBID"=>{"get"=>{"summary"=>"Get BRIBID", "description"=>"Returns a BRIBID as of a date", "operationId"=>"postGetbrib", "x-api-path-slug"=>"getbribid-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "BRIBID"]}}, "/GetRIGIBOR"=>{"get"=>{"summary"=>"Get RIGIBOR", "description"=>"Returns a RIGIBOR as of a date", "operationId"=>"postGetrigibor", "x-api-path-slug"=>"getrigibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "RIGIBOR"]}}, "/GetRIGIBID"=>{"get"=>{"summary"=>"Get RIGIBID", "description"=>"Returns a RIGIBID as of a date", "operationId"=>"postGetrigib", "x-api-path-slug"=>"getrigibid-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "RIGIBID"]}}, "/GetAIDIBOR"=>{"get"=>{"summary"=>"Get AIDIBOR", "description"=>"Returns a AIDIBOR as of a date", "operationId"=>"postGetaibor", "x-api-path-slug"=>"getaidibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "AIDIBOR"]}}, "/GetJIBAR"=>{"get"=>{"summary"=>"Get JIBAR", "description"=>"Returns a JIBAR as of a date", "operationId"=>"postGetjibar", "x-api-path-slug"=>"getjibar-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "JIBAR"]}}, "/GetBAIBOR"=>{"get"=>{"summary"=>"Get BAIBOR", "description"=>"Returns a BAIBOR as of a date", "operationId"=>"postGetbaibor", "x-api-path-slug"=>"getbaibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "BAIBOR"]}}, "/GetCOLIBOR"=>{"get"=>{"summary"=>"Get COLIBOR", "description"=>"Returns a COLIBOR as of a date", "operationId"=>"postGetcolibor", "x-api-path-slug"=>"getcolibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "COLIBOR"]}}, "/GetTALIBOR"=>{"get"=>{"summary"=>"Get TALIBOR", "description"=>"Returns a TALIBOR as of a date", "operationId"=>"postGettalibor", "x-api-path-slug"=>"gettalibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "TALIBOR"]}}, "/GetTALIBID"=>{"get"=>{"summary"=>"Get TALIBID", "description"=>"Returns a TALIBID as of a date", "operationId"=>"postGettalib", "x-api-path-slug"=>"gettalibid-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "TALIBID"]}}, "/GetRate"=>{"get"=>{"summary"=>"Get Rate", "description"=>"Returns a rate as of a specific date.", "operationId"=>"postGetrate", "x-api-path-slug"=>"getrate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Rate"]}}, "/GetRateFamilyTable"=>{"get"=>{"summary"=>"Get Rate Family Table", "description"=>"Returns a rate table for a rate family.", "operationId"=>"postGetratefamilytable", "x-api-path-slug"=>"getratefamilytable-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Rate", "Family", "Table"]}}, "/GetRateFamily"=>{"get"=>{"summary"=>"Get Rate Family", "description"=>"Returns a collection of related rate as of a specific date", "operationId"=>"postGetratefamily", "x-api-path-slug"=>"getratefamily-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Rate", "Family"]}}, "/GetTodaysRate"=>{"get"=>{"summary"=>"Get Todays Rate", "description"=>"Returns end of day closing value for a rate", "operationId"=>"postGettodaysrate", "x-api-path-slug"=>"gettodaysrate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Todays", "Rate"]}}, "/GetLatestRate"=>{"get"=>{"summary"=>"Get Latest Rate", "description"=>"Returns latest value for a rate.", "operationId"=>"postGetlatestrate", "x-api-path-slug"=>"getlatestrate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Rate"]}}, "/GetLatestLIBOR"=>{"get"=>{"summary"=>"Get Latest LIBOR", "description"=>"Returns latest value for a LIBOR rate.", "operationId"=>"postGetlatestlibor", "x-api-path-slug"=>"getlatestlibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "LIBOR"]}}, "/GetLatestRateFamily"=>{"get"=>{"summary"=>"Get Latest Rate Family", "description"=>"Returns latest values for a rate family.", "operationId"=>"postGetlatestratefamily", "x-api-path-slug"=>"getlatestratefamily-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Rate", "Family"]}}, "/GetHistoricalRates"=>{"get"=>{"summary"=>"Get Historical Rates", "description"=>"Returns a rate for a range of dates.", "operationId"=>"postGethistoricalrates", "x-api-path-slug"=>"gethistoricalrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Rates"]}}, "/GetHistoricalRateFamily"=>{"get"=>{"summary"=>"Get Historical Rate Family", "description"=>"Returns a rate family and for a range of dates.", "operationId"=>"postGethistoricalratefamily", "x-api-path-slug"=>"gethistoricalratefamily-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Rate", "Family"]}}, "/GetRateDescription"=>{"get"=>{"summary"=>"Get Rate Description", "description"=>"Returns a description for a rate.", "operationId"=>"postGetratedescription", "x-api-path-slug"=>"getratedescription-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Rate", "Description"]}}, "Draw, Rate, , Custom"=>{"get"=>{"summary"=>"Draw Rate Chart Custom", "description"=>"Draw a custom rate chart for a date range.", "operationId"=>"postDrawratechartcustom", "x-api-path-slug"=>"draw-rate--custom-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Draw", "Rate", "Chart", "Custom"]}}, "Draw, Rate, "=>{"get"=>{"summary"=>"Draw Rate Chart", "description"=>"Draw a standard rate chart for a date range.", "operationId"=>"postDrawratechart", "x-api-path-slug"=>"draw-rate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Draw", "Rate", "Chart"]}}, "Draw, Rate, , Preset"=>{"get"=>{"summary"=>"Draw Rate Chart Preset", "description"=>"Draw a standard rate chart for a date range.", "operationId"=>"postDrawratechartpreset", "x-api-path-slug"=>"draw-rate--preset-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Draw", "Rate", "Chart", "Preset"]}}, ", Design"=>{"get"=>{"summary"=>"Get Chart Design", "description"=>"Returns the default design class for the rate Chart.", "operationId"=>"postGetchartdesign", "x-api-path-slug"=>"design-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chart", "Design"]}}, "/DrawYieldCurve"=>{"get"=>{"summary"=>"Draw Yield Curve", "description"=>"Draw a yield curve for a rate family.", "operationId"=>"postDrawyieldcurve", "x-api-path-slug"=>"drawyieldcurve-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Draw", "Yield", "Curve"]}}, "/DrawYieldCurvePreset"=>{"get"=>{"summary"=>"Draw Yield Curve Preset", "description"=>"Draw a yield curve for a rate family.", "operationId"=>"postDrawyieldcurvepreset", "x-api-path-slug"=>"drawyieldcurvepreset-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Draw", "Yield", "Curve", "Preset"]}}, "/DrawYieldCurveCustom"=>{"get"=>{"summary"=>"Draw Yield Curve Custom", "description"=>"Draw a yield curve for a rate family.", "operationId"=>"postDrawyieldcurvecustom", "x-api-path-slug"=>"drawyieldcurvecustom-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Draw", "Yield", "Curve", "Custom"]}}}}, "xignite-vwap-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite VWAP", "description"=>"provides-delayed-and-historical-volumeweightedaverage-price-vwap-information-", "version"=>"1.0.0"}, "host"=>"www.xignite.com", "basePath"=>"xVWAP.json/XigniteVWAP", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetHistoricalDailyVWAP"=>{"get"=>{"summary"=>"Get Historical Daily VWAP", "description"=>"Returns historical daily VWAP information for a date range", "operationId"=>"GetHistoricalDailyVWAP", "x-api-path-slug"=>"gethistoricaldailyvwap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Daily", "VWAP"]}}, "/GetHistoricalVWAP"=>{"get"=>{"summary"=>"Get Historical VWAP", "description"=>"Returns historical VWAP information for a date range", "operationId"=>"GetHistoricalVWAP", "x-api-path-slug"=>"gethistoricalvwap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "VWAP"]}}, "/GetHistoricalMonthlyVWAP"=>{"get"=>{"summary"=>"Get Historical Monthly VWAP", "description"=>"Returns historical monthly VWAP information for a date range.", "operationId"=>"GetHistoricalMonthlyVWAP", "x-api-path-slug"=>"gethistoricalmonthlyvwap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Monthly", "VWAP"]}}, "/GetHistoricalWeeklyVWAP"=>{"get"=>{"summary"=>"Get Historical Weekly VWAP", "description"=>"Returns historical weekly VWAP information for a date range.", "operationId"=>"GetHistoricalWeeklyVWAP", "x-api-path-slug"=>"gethistoricalweeklyvwap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Weekly", "VWAP"]}}, "/GetHistoricalPeriodVWAP"=>{"get"=>{"summary"=>"Get Historical Period VWAP", "description"=>"Returns historical VWAP information for a date range.", "operationId"=>"GetHistoricalPeriodVWAP", "x-api-path-slug"=>"gethistoricalperiodvwap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Period", "VWAP"]}}, "/GetIntradayVWAP"=>{"get"=>{"summary"=>"Get Intraday VWAP", "description"=>"Returns an intraday VWAP for a security based on the trades performed in a time range.", "operationId"=>"GetIntradayVWAP", "x-api-path-slug"=>"getintradayvwap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Intraday", "VWAP"]}}, "/GetHistoricalIntradayVWAP"=>{"get"=>{"summary"=>"Get Historical Intraday VWAP", "description"=>"Returns a historical intraday VWAP for a security based on the trades performed in a time range.", "operationId"=>"GetHistoricalIntradayVWAP", "x-api-path-slug"=>"gethistoricalintradayvwap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Intraday", "VWAP"]}}, "/GetCorporateIntradayVWAP"=>{"get"=>{"summary"=>"Get Corporate Intraday VWAP", "description"=>"Returns a corporate intraday VWAP for a security based on the trades performed in a time range.", "operationId"=>"GetCorporateIntradayVWAP", "x-api-path-slug"=>"getcorporateintradayvwap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Corporate", "Intraday", "VWAP"]}}, "/GetCorporateHistoricalVWAP"=>{"get"=>{"summary"=>"Get Corporate Historical VWAP", "description"=>"Returns a corporate intraday VWAP for a security based on the trades performed in a time range.", "operationId"=>"GetCorporateHistoricalVWAP", "x-api-path-slug"=>"getcorporatehistoricalvwap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Corporate", "Historical", "VWAP"]}}, "/GetDelayedVWAP"=>{"get"=>{"summary"=>"Get Delayed VWAP", "description"=>"Returns an intraday VWAP for a security based on all trades for the day up to the 15/20 minutes delayed quote.", "operationId"=>"GetDelayedVWAP", "x-api-path-slug"=>"getdelayedvwap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Delayed", "VWAP"]}}, "/GetRealTimeVWAP"=>{"get"=>{"summary"=>"Get Real Time VWAP", "description"=>"Returns a real-time VWAP for a security based on all INET trades.", "operationId"=>"GetRealTimeVWAP", "x-api-path-slug"=>"getrealtimevwap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Real", "Time", "VWAP"]}}, "/Get1MinuteVWAP"=>{"get"=>{"summary"=>"Get1 Minute VWAP", "description"=>"Returns an intraday VWAP for a security based on trades executed in the last 1 minute of the 15/20 minutes delayed quote.", "operationId"=>"Get1MinuteVWAP", "x-api-path-slug"=>"get1minutevwap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["1", "Minute", "VWAP"]}}, "/Get5MinuteVWAP"=>{"get"=>{"summary"=>"Get5 Minute VWAP", "description"=>"Returns an intraday VWAP for a security based on trades executed in the last 5 minutes of the 15/20 minutes delayed quote.", "operationId"=>"Get5MinuteVWAP", "x-api-path-slug"=>"get5minutevwap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["5", "Minute", "VWAP"]}}, "/Get10MinuteVWAP"=>{"get"=>{"summary"=>"Get10 Minute VWAP", "description"=>"Returns an intraday VWAP for a security based on trades executed in the last 10 minutes of the 15/20 minutes delayed quote.", "operationId"=>"Get10MinuteVWAP", "x-api-path-slug"=>"get10minutevwap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["10", "Minute", "VWAP"]}}, "/Get30MinuteVWAP"=>{"get"=>{"summary"=>"Get30 Minute VWAP", "description"=>"Returns an intraday VWAP for a security based on trades executed in the last 30 minutes of the 15/20 minutes delayed quote.", "operationId"=>"Get30MinuteVWAP", "x-api-path-slug"=>"get30minutevwap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["30", "Minute", "VWAP"]}}, "/Get60MinuteVWAP"=>{"get"=>{"summary"=>"Get60 Minute VWAP", "description"=>"Returns an intraday VWAP for a security based on trades executed in the last hour of the 15/20 minutes delayed quote.", "operationId"=>"Get60MinuteVWAP", "x-api-path-slug"=>"get60minutevwap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["60", "Minute", "VWAP"]}}}}, "xignite-logos-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Logos", "description"=>"this-web-service-provides-company-logo-images-", "version"=>"1.0.0"}, "host"=>"www.xignite.com", "basePath"=>"xLogos.json/XigniteLogos", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetLogo"=>{"get"=>{"summary"=>"Get Logo", "description"=>"Save an archive.", "operationId"=>"postGetlogo", "x-api-path-slug"=>"getlogo-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logo"]}}, "/GetLogosList"=>{"get"=>{"summary"=>"Get Logos List", "description"=>"Get all symbols which have available logos.", "operationId"=>"postGetlogoslist", "x-api-path-slug"=>"getlogoslist-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logos", "List"]}}, "/ListMarkets"=>{"get"=>{"summary"=>"List Markets", "description"=>"List markets which have avalilable logos.", "operationId"=>"postListmarkets", "x-api-path-slug"=>"listmarkets-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Markets"]}}, "/ListSymbols"=>{"get"=>{"summary"=>"List Symbols", "description"=>"List available logos on market.", "operationId"=>"postListsymbols", "x-api-path-slug"=>"listsymbols-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Symbols"]}}}}, "xignite-global-options-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Global Options", "description"=>"complete-stock-option-management-application-", "version"=>"1.0.0"}, "host"=>"globaloptions.xignite.com", "basePath"=>"xglobaloptions.json/XigniteGlobalOptions", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetAllEquityOptionChain"=>{"get"=>{"summary"=>"Get All Equity Option Chain", "description"=>"Returns options chains for an equity.", "operationId"=>"GetAllEquityOptionChain", "x-api-path-slug"=>"getallequityoptionchain-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Equity", "Option", "Chain"]}}, "/GetEquityOptionChain"=>{"get"=>{"summary"=>"Get Equity Option Chain", "description"=>"Returns options chain for an equity.", "operationId"=>"GetEquityOptionChain", "x-api-path-slug"=>"getequityoptionchain-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Equity", "Option", "Chain"]}}, "/GetEquityOptionBySymbols"=>{"get"=>{"summary"=>"Get Equity Option By Symbols", "description"=>"Returns an array of specific equity options.", "operationId"=>"GetEquityOptionBySymbols", "x-api-path-slug"=>"getequityoptionbysymbols-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Equity", "Option", "Symbols"]}}, "/GetBlackScholesOptionValue"=>{"get"=>{"summary"=>"Get Black Scholes Option Value", "description"=>"Calculates the value of an option using the Black-Scholes formula.", "operationId"=>"GetBlackScholesOptionValue", "x-api-path-slug"=>"getblackscholesoptionvalue-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Black", "Scholes", "Option", "Value"]}}, "/GetAllExtendedEquityOptionChain"=>{"get"=>{"summary"=>"Get All Extended Equity Option Chain", "description"=>"Returns extended options chains for an equity.", "operationId"=>"GetAllExtendedEquityOptionChain", "x-api-path-slug"=>"getallextendedequityoptionchain-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extended", "Equity", "Option", "Chain"]}}, "/GetExtendedEquityOptionChain"=>{"get"=>{"summary"=>"Get Extended Equity Option Chain", "description"=>"Returns extended options chain for an equity.", "operationId"=>"GetExtendedEquityOptionChain", "x-api-path-slug"=>"getextendedequityoptionchain-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extended", "Equity", "Option", "Chain"]}}, "/GetEquityOption"=>{"get"=>{"summary"=>"Get Equity Option", "description"=>"Returns a specific equity option.", "operationId"=>"GetEquityOption", "x-api-path-slug"=>"getequityoption-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Equity", "Option"]}}, "/GetExtendedEquityOption"=>{"get"=>{"summary"=>"Get Extended Equity Option", "description"=>"Returns a specific equity extended option.", "operationId"=>"GetExtendedEquityOption", "x-api-path-slug"=>"getextendedequityoption-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extended", "Equity", "Option"]}}, "/GetEquityOptionSymbol"=>{"get"=>{"summary"=>"Get Equity Option Symbol", "description"=>"Returns the symbol for an equity option based on month, year and strike price.", "operationId"=>"GetEquityOptionSymbol", "x-api-path-slug"=>"getequityoptionsymbol-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Equity", "Option", "Symbol"]}}, "/GetEquityOptionBySymbol"=>{"get"=>{"summary"=>"Get Equity Option By Symbol", "description"=>"Returns a specific equity option.", "operationId"=>"GetEquityOptionBySymbol", "x-api-path-slug"=>"getequityoptionbysymbol-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Equity", "Option", "Symbol"]}}, "/GetExtendedEquityOptionBySymbol"=>{"get"=>{"summary"=>"Get Extended Equity Option By Symbol", "description"=>"Returns a specific equity extended option.", "operationId"=>"GetExtendedEquityOptionBySymbol", "x-api-path-slug"=>"getextendedequityoptionbysymbol-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extended", "Equity", "Option", "Symbol"]}}, "/GetExtendedEquityOptionBySymbols"=>{"get"=>{"summary"=>"Get Extended Equity Option By Symbols", "description"=>"Returns an array of specific equity extended options.", "operationId"=>"GetExtendedEquityOptionBySymbols", "x-api-path-slug"=>"getextendedequityoptionbysymbols-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extended", "Equity", "Option", "Symbols"]}}, ", Bars"=>{"get"=>{"summary"=>"Get Chart Bars", "description"=>"Get chart bars", "operationId"=>"GetChartBars", "x-api-path-slug"=>"bars-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chart", "Bars"]}}}}, "xignite-global-master-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Global Master", "description"=>"this-web-service-provides-multiple-securityrelated-operations-including-mapping-of-symbol-cusip-cik-and-name-the-collection-of-statistical-information-to-be-used-in-stock-growth-simulations-split-information-and-lookup-services-", "version"=>"1.0.0"}, "host"=>"globalmaster.xignite.com", "basePath"=>"xglobalmaster.json/XigniteGlobalMaster", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetSecurity"=>{"get"=>{"summary"=>"Get Security", "description"=>"Get a list of securities.", "operationId"=>"GetSecurity", "x-api-path-slug"=>"getsecurity-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security"]}}, "/GetSecurities"=>{"get"=>{"summary"=>"Get Securities", "description"=>"Get a list of securities.", "operationId"=>"GetSecurities", "x-api-path-slug"=>"getsecurities-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Securities"]}}, "/GetInstrument"=>{"get"=>{"summary"=>"Get Instrument", "description"=>"Get a list of instruments.", "operationId"=>"GetInstrument", "x-api-path-slug"=>"getinstrument-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instrument"]}}, "/GetInstruments"=>{"get"=>{"summary"=>"Get Instruments", "description"=>"Get a list of instruments.", "operationId"=>"GetInstruments", "x-api-path-slug"=>"getinstruments-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instruments"]}}, "/GetIssuer"=>{"get"=>{"summary"=>"Get Issuer", "description"=>"Get a list of issuers.", "operationId"=>"GetIssuer", "x-api-path-slug"=>"getissuer-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Issuer"]}}, "/GetIssuers"=>{"get"=>{"summary"=>"Get Issuers", "description"=>"Get a list of issuers", "operationId"=>"GetIssuers", "x-api-path-slug"=>"getissuers-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Issuers"]}}, "/GetIssuerByCompanyIdentifier"=>{"get"=>{"summary"=>"Get Issuer By Company Identifier", "description"=>"Get a issuer by the company identifier.", "operationId"=>"GetIssuerByCompanyIdentifier", "x-api-path-slug"=>"getissuerbycompanyidentifier-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Issuer", "Company", "Identifier"]}}, "/GetMasterByIdentifier"=>{"get"=>{"summary"=>"Get Master By Identifier", "description"=>"Get master records by identifier.", "operationId"=>"GetMasterByIdentifier", "x-api-path-slug"=>"getmasterbyidentifier-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Master", "Identifier"]}}, "/GetMasterByIdentifiers"=>{"get"=>{"summary"=>"Get Master By Identifiers", "description"=>"Get master records by identifiers.", "operationId"=>"GetMasterByIdentifiers", "x-api-path-slug"=>"getmasterbyidentifiers-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Master", "Identifiers"]}}, "/GetMasterByExchange"=>{"get"=>{"summary"=>"Get Master By Exchange", "description"=>"Get master records by exchange.", "operationId"=>"GetMasterByExchange", "x-api-path-slug"=>"getmasterbyexchange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Master", "Exchange"]}}, "/GetMasterByExchangeChanges"=>{"get"=>{"summary"=>"Get Master By Exchange Changes", "description"=>"Get a master record by exchange and the last modified since date", "operationId"=>"GetMasterByExchangeChanges", "x-api-path-slug"=>"getmasterbyexchangechanges-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Master", "Exchange", "Changes"]}}, "/GetMasterBySector"=>{"get"=>{"summary"=>"Get Master By Sector", "description"=>"Old version of the service. Customers should use GetMasterByGlobalSector", "operationId"=>"GetMasterBySector", "x-api-path-slug"=>"getmasterbysector-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Master", "Sector"]}}, "/GetMasterByIndustry"=>{"get"=>{"summary"=>"Get Master By Industry", "description"=>"Old version of the service. Customers should use GetMasterByGlobalIndustry", "operationId"=>"GetMasterByIndustry", "x-api-path-slug"=>"getmasterbyindustry-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Master", "Industry"]}}, "/GetMasterByGlobalSector"=>{"get"=>{"summary"=>"Get Master By Global Sector", "description"=>"Get master records by sector.", "operationId"=>"GetMasterByGlobalSector", "x-api-path-slug"=>"getmasterbyglobalsector-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Master", "Global", "Sector"]}}, "/GetMasterByGlobalIndustry"=>{"get"=>{"summary"=>"Get Master By Global Industry", "description"=>"Get master records by industry.", "operationId"=>"GetMasterByGlobalIndustry", "x-api-path-slug"=>"getmasterbyglobalindustry-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Master", "Global", "Industry"]}}, "/ListExchanges"=>{"get"=>{"summary"=>"List Exchanges", "description"=>"Get the possible exchanges.", "operationId"=>"ListExchanges", "x-api-path-slug"=>"listexchanges-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Exchanges"]}}, "/ListIndustries"=>{"get"=>{"summary"=>"List Industries", "description"=>"Get the possible industries.", "operationId"=>"ListIndustries", "x-api-path-slug"=>"listindustries-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Industries"]}}, "/ListInstrumentClasses"=>{"get"=>{"summary"=>"List Instrument Classes", "description"=>"Get the possible instrument classes.", "operationId"=>"ListInstrumentClasses", "x-api-path-slug"=>"listinstrumentclasses-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Instrument", "Classes"]}}, "/ListSectors"=>{"get"=>{"summary"=>"List Sectors", "description"=>"Get the possible sectors.", "operationId"=>"ListSectors", "x-api-path-slug"=>"listsectors-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Sectors"]}}, "/ListGlobalIndustries"=>{"get"=>{"summary"=>"List Global Industries", "description"=>"Get the possible industries.", "operationId"=>"ListGlobalIndustries", "x-api-path-slug"=>"listglobalindustries-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Global", "Industries"]}}, "/ListGlobalSectors"=>{"get"=>{"summary"=>"List Global Sectors", "description"=>"Get the possible sectors.", "operationId"=>"ListGlobalSectors", "x-api-path-slug"=>"listglobalsectors-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Global", "Sectors"]}}, "/ListMICToLegacyExchange"=>{"get"=>{"summary"=>"List MIC To Legacy Exchange", "description"=>"Get the legacy exchanges.", "operationId"=>"ListMICToLegacyExchange", "x-api-path-slug"=>"listmictolegacyexchange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "MIC", "Legacy", "Exchange"]}}, "/ListMICToLegacySuffix"=>{"get"=>{"summary"=>"List MIC To Legacy Suffix", "description"=>"Get the legacy exchange suffix.", "operationId"=>"ListMICToLegacySuffix", "x-api-path-slug"=>"listmictolegacysuffix-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "MIC", "Legacy", "Suffix"]}}, "/ListIdentifiersByExchange"=>{"get"=>{"summary"=>"List Identifiers By Exchange", "description"=>"Returns all the Indetifiers and names for securities listed on an exchange.", "operationId"=>"ListIdentifiersByExchange", "x-api-path-slug"=>"listidentifiersbyexchange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Identifiers", "Exchange"]}}, "/ListSymbolChanges"=>{"get"=>{"summary"=>"List Symbol Changes", "description"=>"This operation returns symbols changed in this exchange.", "operationId"=>"ListSymbolChanges", "x-api-path-slug"=>"listsymbolchanges-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Symbol", "Changes"]}}, "/GetMasterStatisticsByExchange"=>{"get"=>{"summary"=>"Get Master Statistics By Exchange", "description"=>"Get statistical information about exchanges.", "operationId"=>"GetMasterStatisticsByExchange", "x-api-path-slug"=>"getmasterstatisticsbyexchange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Master", "Statistics", "Exchange"]}}}}, "xignite-global-real-time-options-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Global Real Time Options", "description"=>"complete-stock-option-management-application-", "version"=>"1.0.0"}, "host"=>"globalrealtimeoptions.xignite.com", "basePath"=>"xglobalrealtimeoptions.json/XigniteGlobalRealTimeOptions", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetBlackScholesOptionValue"=>{"get"=>{"summary"=>"Get Black Scholes Option Value", "description"=>"Calculates the value of an option using the Black-Scholes formula.", "operationId"=>"GetBlackScholesOptionValue", "x-api-path-slug"=>"getblackscholesoptionvalue-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Black", "Scholes", "Option", "Value"]}}, "/GetAllEquityOptionChain"=>{"get"=>{"summary"=>"Get All Equity Option Chain", "description"=>"Returns options chains for an equity.", "operationId"=>"GetAllEquityOptionChain", "x-api-path-slug"=>"getallequityoptionchain-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Equity", "Option", "Chain"]}}, "/GetAllExtendedEquityOptionChain"=>{"get"=>{"summary"=>"Get All Extended Equity Option Chain", "description"=>"Returns extended options chains for an equity.", "operationId"=>"GetAllExtendedEquityOptionChain", "x-api-path-slug"=>"getallextendedequityoptionchain-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extended", "Equity", "Option", "Chain"]}}, "/GetEquityOptionChain"=>{"get"=>{"summary"=>"Get Equity Option Chain", "description"=>"Returns options chain for an equity.", "operationId"=>"GetEquityOptionChain", "x-api-path-slug"=>"getequityoptionchain-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Equity", "Option", "Chain"]}}, "/GetExtendedEquityOptionChain"=>{"get"=>{"summary"=>"Get Extended Equity Option Chain", "description"=>"Returns extended options chain for an equity.", "operationId"=>"GetExtendedEquityOptionChain", "x-api-path-slug"=>"getextendedequityoptionchain-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extended", "Equity", "Option", "Chain"]}}, "/GetEquityOption"=>{"get"=>{"summary"=>"Get Equity Option", "description"=>"Returns a specific equity option.", "operationId"=>"GetEquityOption", "x-api-path-slug"=>"getequityoption-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Equity", "Option"]}}, "/GetExtendedEquityOption"=>{"get"=>{"summary"=>"Get Extended Equity Option", "description"=>"Returns a specific equity extended option.", "operationId"=>"GetExtendedEquityOption", "x-api-path-slug"=>"getextendedequityoption-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extended", "Equity", "Option"]}}, "/GetEquityOptionSymbol"=>{"get"=>{"summary"=>"Get Equity Option Symbol", "description"=>"Returns the symbol for an equity option based on month, year and strike price.", "operationId"=>"GetEquityOptionSymbol", "x-api-path-slug"=>"getequityoptionsymbol-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Equity", "Option", "Symbol"]}}, "/GetEquityOptionBySymbol"=>{"get"=>{"summary"=>"Get Equity Option By Symbol", "description"=>"Returns a specific equity option.", "operationId"=>"GetEquityOptionBySymbol", "x-api-path-slug"=>"getequityoptionbysymbol-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Equity", "Option", "Symbol"]}}, "/GetExtendedEquityOptionBySymbol"=>{"get"=>{"summary"=>"Get Extended Equity Option By Symbol", "description"=>"Returns a specific equity extended option.", "operationId"=>"GetExtendedEquityOptionBySymbol", "x-api-path-slug"=>"getextendedequityoptionbysymbol-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extended", "Equity", "Option", "Symbol"]}}, "/GetEquityOptionBySymbols"=>{"get"=>{"summary"=>"Get Equity Option By Symbols", "description"=>"Returns an array of specific equity options.", "operationId"=>"GetEquityOptionBySymbols", "x-api-path-slug"=>"getequityoptionbysymbols-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Equity", "Option", "Symbols"]}}, "/GetExtendedEquityOptionBySymbols"=>{"get"=>{"summary"=>"Get Extended Equity Option By Symbols", "description"=>"Returns an array of specific equity extended options.", "operationId"=>"GetExtendedEquityOptionBySymbols", "x-api-path-slug"=>"getextendedequityoptionbysymbols-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extended", "Equity", "Option", "Symbols"]}}, ", Bars"=>{"get"=>{"summary"=>"Get Chart Bars", "description"=>"Get chart bars", "operationId"=>"GetChartBars", "x-api-path-slug"=>"bars-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Chart", "Bars"]}}}}, "xignite-bats-real-time-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite BATS Real Time", "description"=>"provides-realtime-access-to-bats-market-data-", "version"=>"1.0.0"}, "host"=>"batsrealtime.xignite.com", "basePath"=>"xBATSRealTime.json/XigniteBATSRealTime", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetBars"=>{"get"=>{"summary"=>"Get Bars", "description"=>"Returns a set of bars for a stock and a time range during the trading day.", "operationId"=>"GetBars", "x-api-path-slug"=>"getbars-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Bars"]}}, "/GetRealQuote"=>{"get"=>{"summary"=>"Get Real Quote", "description"=>"Returns real time stock quote for a given stock ticker", "operationId"=>"GetRealQuote", "x-api-path-slug"=>"getrealquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Quote"]}}, "/GetRealQuotes"=>{"get"=>{"summary"=>"Get Real Quotes", "description"=>"Returns a collection of real time stock quotes for a comma-separated list of stock quotes.", "operationId"=>"GetRealQuotes", "x-api-path-slug"=>"getrealquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Quotes"]}}, "/GetRealQuotesByIdentifiers"=>{"get"=>{"summary"=>"Get Real Quotes By Identifiers", "description"=>"Returns a collection of real time stock quotes for a comma-separated list of stock quotes.", "operationId"=>"GetRealQuotesByIdentifiers", "x-api-path-slug"=>"getrealquotesbyidentifiers-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Quotes", "Identifiers"]}}, "/GetRealQuoteByIdentifier"=>{"get"=>{"summary"=>"Get Real Quote By Identifier", "description"=>"Returns a real-time quote for a security based on the last trade execution.", "operationId"=>"GetRealQuoteByIdentifier", "x-api-path-slug"=>"getrealquotebyidentifier-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Quote", "Identifier"]}}, "/ListTradedSymbols"=>{"get"=>{"summary"=>"List Traded Symbols", "description"=>"Returns all symbols and names that are traded recently", "operationId"=>"ListTradedSymbols", "x-api-path-slug"=>"listtradedsymbols-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Traded", "Symbols"]}}, "/GetBar"=>{"get"=>{"summary"=>"Get Bar", "description"=>"Returns a single bar for a specific time.", "operationId"=>"GetBar", "x-api-path-slug"=>"getbar-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Bar"]}}, ", Bars"=>{"get"=>{"summary"=>"Get Chart Bars", "description"=>"Returns a set of partial bars for a stock and a time range during the trading day.", "operationId"=>"GetChartBars", "x-api-path-slug"=>"bars-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chart", "Bars"]}}}}, "xignite-futures-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Futures", "description"=>"provide-delayed-and-historical-commodity-quote-information-from-supported-exchanges-nymex----", "version"=>"1.0.0"}, "host"=>"www.xignite.com", "basePath"=>"xFutures.json/XigniteFutures", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetFutureSymbol"=>{"get"=>{"summary"=>"Get Future Symbol", "description"=>"Returns the symbol for a future based on its month and year.", "operationId"=>"postGetfuturesymbol", "x-api-path-slug"=>"getfuturesymbol-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Future", "Symbol"]}}, "/GetReverseFutureSymbol"=>{"get"=>{"summary"=>"Get Reverse Future Symbol", "description"=>"Returns the symbol for a future based on its month and year.", "operationId"=>"postGetreversefuturesymbol", "x-api-path-slug"=>"getreversefuturesymbol-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Reverse", "Future", "Symbol"]}}, "/GetTerminationSchedule"=>{"get"=>{"summary"=>"Get Termination Schedule", "description"=>"Provide a termination schedule for a commodity.", "operationId"=>"postGetterminationschedule", "x-api-path-slug"=>"getterminationschedule-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Termination", "Schedule"]}}, "/GetNextFuture"=>{"get"=>{"summary"=>"Get Next Future", "description"=>"Get the next immediate future contract for a commodity.", "operationId"=>"postGetnextfuture", "x-api-path-slug"=>"getnextfuture-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Next", "Future"]}}, "/GetFuture"=>{"get"=>{"summary"=>"Get Future", "description"=>"Provide information about a commodity future.", "operationId"=>"postGetfuture", "x-api-path-slug"=>"getfuture-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Future"]}}, "/ListExchanges"=>{"get"=>{"summary"=>"List Exchanges", "description"=>"List commmodities future exchanges and indicates which ones are supported.", "operationId"=>"postListexchanges", "x-api-path-slug"=>"listexchanges-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Exchanges"]}}, "/ListFutureCategories"=>{"get"=>{"summary"=>"List Future Categories", "description"=>"List commmodities future categories.", "operationId"=>"postListfuturecategories", "x-api-path-slug"=>"listfuturecategories-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Future", "Categories"]}}, "/ListSwaps"=>{"get"=>{"summary"=>"List Swaps", "description"=>"List all commodity swaps and the exchange on which they are traded.", "operationId"=>"postListswaps", "x-api-path-slug"=>"listswaps-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Swaps"]}}, "/ListFutures"=>{"get"=>{"summary"=>"List Futures", "description"=>"List all commodity futures and the exchange on which they are traded.", "operationId"=>"postListfutures", "x-api-path-slug"=>"listfutures-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Futures"]}}, "/ListFrontMonthContracts"=>{"get"=>{"summary"=>"List Front Month Contracts", "description"=>"List all commodity future Front Month Contracts.", "operationId"=>"postListfrontmonthcontracts", "x-api-path-slug"=>"listfrontmonthcontracts-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Front", "Month", "Contracts"]}}, "/ListFuturesByCategory"=>{"get"=>{"summary"=>"List Futures By Category", "description"=>"List futures information by byfuture category.", "operationId"=>"postListfuturesbycategory", "x-api-path-slug"=>"listfuturesbycategory-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Futures", "By", "Category"]}}, "/ListFuturesByExchange"=>{"get"=>{"summary"=>"List Futures By Exchange", "description"=>"List futures information by exchange.", "operationId"=>"postListfuturesbyexchange", "x-api-path-slug"=>"listfuturesbyexchange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Futures", "By", "Exchange"]}}, "/ListSwapsByExchange"=>{"get"=>{"summary"=>"List Swaps By Exchange", "description"=>"List swaps information by exchange.", "operationId"=>"postListswapsbyexchange", "x-api-path-slug"=>"listswapsbyexchange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Swaps", "By", "Exchange"]}}, "/GetDelayedSwap"=>{"get"=>{"summary"=>"Get Delayed Swap", "description"=>"Returns a delayed quote for a NYMEX swap contract.", "operationId"=>"postGetdelayedswap", "x-api-path-slug"=>"getdelayedswap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Delayed", "Swap"]}}, "/GetDelayedFuture"=>{"get"=>{"summary"=>"Get Delayed Future", "description"=>"Returns a delayed quote for a future contract.", "operationId"=>"postGetdelayedfuture", "x-api-path-slug"=>"getdelayedfuture-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Delayed", "Future"]}}, "/GetDelayedFrontFuture"=>{"get"=>{"summary"=>"Get Delayed Front Future", "description"=>"Returns a delayed quote for a future contract.", "operationId"=>"postGetdelayedfrontfuture", "x-api-path-slug"=>"getdelayedfrontfuture-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Delayed", "Front", "Future"]}}, "/GetAllDelayedFutures"=>{"get"=>{"summary"=>"Get All Delayed Futures", "description"=>"Returns delayed quotes for all contracts for a commodity.", "operationId"=>"postGetalldelayedfutures", "x-api-path-slug"=>"getalldelayedfutures-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Delayed", "Futures"]}}, "/GetTopDelayedFutures"=>{"get"=>{"summary"=>"Get Top Delayed Futures", "description"=>"Returns delayed quotes for a given number of contract (front-future first) for a commodity.", "operationId"=>"postGettopdelayedfutures", "x-api-path-slug"=>"gettopdelayedfutures-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Delayed", "Futures"]}}, "/GetAllDelayedSwaps"=>{"get"=>{"summary"=>"Get All Delayed Swaps", "description"=>"Returns delayed quotes for all contracts for a commodity.", "operationId"=>"postGetalldelayedswaps", "x-api-path-slug"=>"getalldelayedswaps-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Delayed", "Swaps"]}}, "/GetDelayedFutures"=>{"get"=>{"summary"=>"Get Delayed Futures", "description"=>"Returns delayed quotes for multiple future contracts.", "operationId"=>"postGetdelayedfutures", "x-api-path-slug"=>"getdelayedfutures-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Delayed", "Futures"]}}, "/GetDelayedFutureStrip"=>{"get"=>{"summary"=>"Get Delayed Future Strip", "description"=>"Returns a delayed future strip for a commodity.", "operationId"=>"postGetdelayedfuturestrip", "x-api-path-slug"=>"getdelayedfuturestrip-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Delayed", "Future", "Strip"]}}, "/GetHistoricalFutureStrip"=>{"get"=>{"summary"=>"Get Historical Future Strip", "description"=>"Returns a future strip for a commodity.", "operationId"=>"postGethistoricalfuturestrip", "x-api-path-slug"=>"gethistoricalfuturestrip-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Future", "Strip"]}}, "/GetHistoricalSwapStrip"=>{"get"=>{"summary"=>"Get Historical Swap Strip", "description"=>"Returns a future strip for a commodity.", "operationId"=>"postGethistoricalswapstrip", "x-api-path-slug"=>"gethistoricalswapstrip-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Swap", "Strip"]}}, "/GetDelayedSpot"=>{"get"=>{"summary"=>"Get Delayed Spot", "description"=>"Returns a delayed spot quote for a commodity.", "operationId"=>"postGetdelayedspot", "x-api-path-slug"=>"getdelayedspot-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Delayed", "Spot"]}}, "/GetDelayedSpots"=>{"get"=>{"summary"=>"Get Delayed Spots", "description"=>"Returns delayed quotes for multiple commodities.", "operationId"=>"postGetdelayedspots", "x-api-path-slug"=>"getdelayedspots-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Delayed", "Spots"]}}, "/GetDelayedFutureBySession"=>{"get"=>{"summary"=>"Get Delayed Future By Session", "description"=>"Returns a delayed quote for a future contract by exchange session.", "operationId"=>"postGetdelayedfuturebysession", "x-api-path-slug"=>"getdelayedfuturebysession-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Delayed", "Future", "By", "Session"]}}, "/GetAllDelayedFuturesBySession"=>{"get"=>{"summary"=>"Get All Delayed Futures By Session", "description"=>"Returns delayed quotes for all contracts for a commodity by exchange session.", "operationId"=>"postGetalldelayedfuturesbysession", "x-api-path-slug"=>"getalldelayedfuturesbysession-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Delayed", "Futures", "By", "Session"]}}, "/GetDelayedFuturesBySession"=>{"get"=>{"summary"=>"Get Delayed Futures By Session", "description"=>"Returns delayed quotes for multiple future contracts by exchange session.", "operationId"=>"postGetdelayedfuturesbysession", "x-api-path-slug"=>"getdelayedfuturesbysession-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Delayed", "Futures", "By", "Session"]}}, "/GetHistoricalFuture"=>{"get"=>{"summary"=>"Get Historical Future", "description"=>"Returns a historical quote for a future contract.", "operationId"=>"postGethistoricalfuture", "x-api-path-slug"=>"gethistoricalfuture-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Future"]}}, "/GetHistoricalFutures"=>{"get"=>{"summary"=>"Get Historical Futures", "description"=>"Returns historical quotes for multiple future contracts.", "operationId"=>"postGethistoricalfutures", "x-api-path-slug"=>"gethistoricalfutures-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Futures"]}}, "/GetAllHistoricalFuturesWithStatus"=>{"get"=>{"summary"=>"Get All Historical Futures With Status", "description"=>"Returns historical quotes for all contracts for a commodity as of a specific date including status information.", "operationId"=>"postGetallhistoricalfutureswithstatus", "x-api-path-slug"=>"getallhistoricalfutureswithstatus-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Futures", "With", "Status"]}}, "/GetAllHistoricalFutures"=>{"get"=>{"summary"=>"Get All Historical Futures", "description"=>"Returns historical quotes for all contracts for a commodity as of a specific date.", "operationId"=>"postGetallhistoricalfutures", "x-api-path-slug"=>"getallhistoricalfutures-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Futures"]}}, "/GetHistoricalFutureRange"=>{"get"=>{"summary"=>"Get Historical Future Range", "description"=>"Returns a range of historical quotes for a future contract.", "operationId"=>"postGethistoricalfuturerange", "x-api-path-slug"=>"gethistoricalfuturerange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Future", "Range"]}}, "/GetHistoricalSwap"=>{"get"=>{"summary"=>"Get Historical Swap", "description"=>"Returns a historical quote for a future swap.", "operationId"=>"postGethistoricalswap", "x-api-path-slug"=>"gethistoricalswap-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Swap"]}}, "/GetHistoricalSwapRange"=>{"get"=>{"summary"=>"Get Historical Swap Range", "description"=>"Returns a range of historical quotes for a future swap.", "operationId"=>"postGethistoricalswaprange", "x-api-path-slug"=>"gethistoricalswaprange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Swap", "Range"]}}, "/GetHistoricalSwaps"=>{"get"=>{"summary"=>"Get Historical Swaps", "description"=>"Returns historical quotes for multiple future swaps.", "operationId"=>"postGethistoricalswaps", "x-api-path-slug"=>"gethistoricalswaps-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Swaps"]}}, "/GetAllHistoricalSwaps"=>{"get"=>{"summary"=>"Get All Historical Swaps", "description"=>"Returns historical quotes for all contracts for a commodity swap as of a specific date.", "operationId"=>"postGetallhistoricalswaps", "x-api-path-slug"=>"getallhistoricalswaps-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Swaps"]}}, "/GetHistoricalCommodityRange"=>{"get"=>{"summary"=>"Get Historical Commodity Range", "description"=>"Returns a range of historical quotes for a future contract.", "operationId"=>"postGethistoricalcommodityrange", "x-api-path-slug"=>"gethistoricalcommodityrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Commodity", "Range"]}}, "/GetHistoricalCommodityMonthlyRange"=>{"get"=>{"summary"=>"Get Historical Commodity Monthly Range", "description"=>"Returns a range of historical quotes for a future contract.", "operationId"=>"postGethistoricalcommoditymonthlyrange", "x-api-path-slug"=>"gethistoricalcommoditymonthlyrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Commodity", "Monthly", "Range"]}}, "/GetHistoricalSpotRange"=>{"get"=>{"summary"=>"Get Historical Spot Range", "description"=>"Returns a range of commodity spot prices for a commodity.", "operationId"=>"postGethistoricalspotrange", "x-api-path-slug"=>"gethistoricalspotrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Spot", "Range"]}}, "/GetHistoricalSpotMonthlyRange"=>{"get"=>{"summary"=>"Get Historical Spot Monthly Range", "description"=>"Returns a range of commodity spot prices for a commodity.", "operationId"=>"postGethistoricalspotmonthlyrange", "x-api-path-slug"=>"gethistoricalspotmonthlyrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Spot", "Monthly", "Range"]}}, "/GetTick"=>{"get"=>{"summary"=>"Get Tick", "description"=>"Returns an intraday tick for a future contract as of a specific time in the day.", "operationId"=>"postGettick", "x-api-path-slug"=>"gettick-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Tick"]}}, "/GetTicks"=>{"get"=>{"summary"=>"Get Ticks", "description"=>"Returns a range of intraday ticks for a future contract.", "operationId"=>"postGetticks", "x-api-path-slug"=>"getticks-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Ticks"]}}, "/GetHistoricalTicks"=>{"get"=>{"summary"=>"Get Historical Ticks", "description"=>"Returns a historical range of ticks for a security.", "operationId"=>"postGethistoricalticks", "x-api-path-slug"=>"gethistoricalticks-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Ticks"]}}, "/GetHistoricalTicksAsOfDate"=>{"get"=>{"summary"=>"Get Historical Ticks As Of Date", "description"=>"Returns a historical range of ticks for a security.", "operationId"=>"postGethistoricalticksasofdate", "x-api-path-slug"=>"gethistoricalticksasofdate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Ticks", "As", "Of", "Date"]}}, "Intraday, Future, "=>{"get"=>{"summary"=>"Get Intraday Future Chart", "description"=>"Get a standard intraday price chart for a future contract.", "operationId"=>"postGetintradayfuturechart", "x-api-path-slug"=>"intraday-future-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Intraday", "Future", "Chart"]}}, "Intraday, Future, , Binary"=>{"get"=>{"summary"=>"Get Intraday Future Chart Binary", "description"=>"Get a standard intraday price chart for a future contract in binary format.", "operationId"=>"postGetintradayfuturechartbinary", "x-api-path-slug"=>"intraday-future--binary-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Intraday", "Future", "Chart", "Binary"]}}, "Intraday, Future, , Custom"=>{"get"=>{"summary"=>"Get Intraday Future Chart Custom", "description"=>"Get a custom intraday price chart for a future contract.", "operationId"=>"postGetintradayfuturechartcustom", "x-api-path-slug"=>"intraday-future--custom-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Intraday", "Future", "Chart", "Custom"]}}, "Intraday, Future, , Custom, Binary"=>{"get"=>{"summary"=>"Get Intraday Future Chart Custom Binary", "description"=>"Get a custom intraday price chart for a future contract in binary format.", "operationId"=>"postGetintradayfuturechartcustombinary", "x-api-path-slug"=>"intraday-future--custom-binary-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Intraday", "Future", "Chart", "Custom", "Binary"]}}, "Historical, Future, "=>{"get"=>{"summary"=>"Get Historical Future Chart", "description"=>"Get a standard historical price chart for a future contract.", "operationId"=>"postGethistoricalfuturechart", "x-api-path-slug"=>"historical-future-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Future", "Chart"]}}, "Historical, Future, , Binary"=>{"get"=>{"summary"=>"Get Historical Future Chart Binary", "description"=>"Get a standard historical price chart for a future contract in binary format.", "operationId"=>"postGethistoricalfuturechartbinary", "x-api-path-slug"=>"historical-future--binary-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Future", "Chart", "Binary"]}}, "Historical, Future, , Custom"=>{"get"=>{"summary"=>"Get Historical Future Chart Custom", "description"=>"Get a custom historical chart for a future contract in binary format.", "operationId"=>"postGethistoricalfuturechartcustom", "x-api-path-slug"=>"historical-future--custom-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Future", "Chart", "Custom"]}}, "Historical, Future, , Custom, Binary"=>{"get"=>{"summary"=>"Get Historical Future Chart Custom Binary", "description"=>"Draw a custom historical chart for a future contract.", "operationId"=>"postGethistoricalfuturechartcustombinary", "x-api-path-slug"=>"historical-future--custom-binary-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Future", "Chart", "Custom", "Binary"]}}, "Historical, Commodity, "=>{"get"=>{"summary"=>"Get Historical Commodity Chart", "description"=>"Get a historical chart for a commodity.", "operationId"=>"postGethistoricalcommoditychart", "x-api-path-slug"=>"historical-commodity-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Commodity", "Chart"]}}, "Historical, Commodity, , Binary"=>{"get"=>{"summary"=>"Get Historical Commodity Chart Binary", "description"=>"Get a historical chart for a commodity in binary format.", "operationId"=>"postGethistoricalcommoditychartbinary", "x-api-path-slug"=>"historical-commodity--binary-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Commodity", "Chart", "Binary"]}}, "Historical, Commodity, , Custom"=>{"get"=>{"summary"=>"Get Historical Commodity Chart Custom", "description"=>"Get a custom historical chart for a commodity in binary format.", "operationId"=>"postGethistoricalcommoditychartcustom", "x-api-path-slug"=>"historical-commodity--custom-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Commodity", "Chart", "Custom"]}}, "Historical, Commodity, , Custom, Binary"=>{"get"=>{"summary"=>"Get Historical Commodity Chart Custom Binary", "description"=>"Draw a custom historical chart for a future contract.", "operationId"=>"postGethistoricalcommoditychartcustombinary", "x-api-path-slug"=>"historical-commodity--custom-binary-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Commodity", "Chart", "Custom", "Binary"]}}, "Intraday, , Design"=>{"get"=>{"summary"=>"Get Intraday Chart Design", "description"=>"Returns the default settings for the intraday future chart.", "operationId"=>"postGetintradaychartdesign", "x-api-path-slug"=>"intraday--design-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Intraday", "Chart", "Design"]}}, "Historical, , Design"=>{"get"=>{"summary"=>"Get Historical Chart Design", "description"=>"Returns the default settings for the historical future chart.", "operationId"=>"postGethistoricalchartdesign", "x-api-path-slug"=>"historical--design-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Chart", "Design"]}}, "/GetFutureOption"=>{"get"=>{"summary"=>"Get Future Option", "description"=>"Returns a specific future option.", "operationId"=>"postGetfutureoption", "x-api-path-slug"=>"getfutureoption-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Future", "Option"]}}, "/GetTopIndustryHeadlines"=>{"get"=>{"summary"=>"Get Top Industry Headlines", "description"=>"Return the top press releases for an industry.", "operationId"=>"postGettopindustryheadlines", "x-api-path-slug"=>"gettopindustryheadlines-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Industry", "Headlines"]}}, "/GetTodaysIndustryHeadlines"=>{"get"=>{"summary"=>"Get Todays Industry Headlines", "description"=>"Return press releases for today for an industry.", "operationId"=>"postGettodaysindustryheadlines", "x-api-path-slug"=>"gettodaysindustryheadlines-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Todays", "Industry", "Headlines"]}}, "/GetLastIndustryHeadlines"=>{"get"=>{"summary"=>"Get Last Industry Headlines", "description"=>"Return the last press releases since a certain time for an industry.", "operationId"=>"postGetlastindustryheadlines", "x-api-path-slug"=>"getlastindustryheadlines-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Last", "Industry", "Headlines"]}}, "/GetFutureOptionChain"=>{"get"=>{"summary"=>"Get Future Option Chain", "description"=>"Returns an option chain for a future contract.", "operationId"=>"postGetfutureoptionchain", "x-api-path-slug"=>"getfutureoptionchain-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Future", "Option", "Chain"]}}, "/GetFutureOptionsByStrikePrice"=>{"get"=>{"summary"=>"Get Future Options By Strike Price", "description"=>"Returns an option chain for a future contract matching a list of prices.", "operationId"=>"postGetfutureoptionsbystrikeprice", "x-api-path-slug"=>"getfutureoptionsbystrikeprice-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Future", "Options", "By", "Strike", "Price"]}}}}, "xignite-super-quotes-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Super Quotes", "description"=>"the-super-quotes-service-", "version"=>"1.0.0"}, "host"=>"superquotes.xignite.com", "basePath"=>"xSuperQuotes.json/XigniteSuperQuotes", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetQuote"=>{"get"=>{"summary"=>"Get Quote", "description"=>"Returns a quote for a given security.", "operationId"=>"GetQuote", "x-api-path-slug"=>"getquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Quote"]}}, "/GetQuotes"=>{"get"=>{"summary"=>"Get Quotes", "description"=>"Returns quotes for given securities.", "operationId"=>"GetQuotes", "x-api-path-slug"=>"getquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Quotes"]}}, ", Bars"=>{"get"=>{"summary"=>"Get Chart Bars", "description"=>"Returns ChartBars for given security.", "operationId"=>"GetChartBars", "x-api-path-slug"=>"bars-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chart", "Bars"]}}}}, "xignite-global-holidays-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Global Holidays", "description"=>"this-web-service-provides-tradingholiday-information-for-all-exchangescurrenciesfinancial-centers-", "version"=>"1.0.0"}, "host"=>"globalholidays.xignite.com", "basePath"=>"xGlobalHolidays.json/XigniteGlobalHolidays", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/ListExchanges"=>{"get"=>{"summary"=>"List Exchanges", "description"=>"List exchanges.", "operationId"=>"ListExchanges", "x-api-path-slug"=>"listexchanges-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Exchanges"]}}, "/ListCurrencies"=>{"get"=>{"summary"=>"List Currencies", "description"=>"List currencies.", "operationId"=>"ListCurrencies", "x-api-path-slug"=>"listcurrencies-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Currencies"]}}, "/ListFinancialCenters"=>{"get"=>{"summary"=>"List Financial Centers", "description"=>"List financial centers.", "operationId"=>"ListFinancialCenters", "x-api-path-slug"=>"listfinancialcenters-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Financial", "Centers"]}}, "/GetHolidays"=>{"get"=>{"summary"=>"Get Holidays", "description"=>"Get holidays.", "operationId"=>"GetHolidays", "x-api-path-slug"=>"getholidays-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Holidays"]}}, "/ListHolidays"=>{"get"=>{"summary"=>"List Holidays", "description"=>"List holidays.", "operationId"=>"ListHolidays", "x-api-path-slug"=>"listholidays-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Holidays"]}}, "/GetNextDate"=>{"get"=>{"summary"=>"Get Next Date", "description"=>"Get next date.", "operationId"=>"GetNextDate", "x-api-path-slug"=>"getnextdate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Next", "Date"]}}, "/GetPriorDate"=>{"get"=>{"summary"=>"Get Prior Date", "description"=>"Get prior date.", "operationId"=>"GetPriorDate", "x-api-path-slug"=>"getpriordate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Prior", "Date"]}}, "/GetDayCount"=>{"get"=>{"summary"=>"Get Day Count", "description"=>"Get day count.", "operationId"=>"GetDayCount", "x-api-path-slug"=>"getdaycount-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Day", "Count"]}}, "/GetExchangeDateTime"=>{"get"=>{"summary"=>"Get Exchange Date Time", "description"=>"Get exchange date time.", "operationId"=>"GetExchangeDateTime", "x-api-path-slug"=>"getexchangedatetime-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Exchange", "Date", "Time"]}}, "/GetExchangeHours"=>{"get"=>{"summary"=>"Get Exchange Hours", "description"=>"Get exchange hours.", "operationId"=>"GetExchangeHours", "x-api-path-slug"=>"getexchangehours-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Exchange", "Hours"]}}, "/GetExchangeHoursRange"=>{"get"=>{"summary"=>"Get Exchange Hours Range", "description"=>"Get exchange hours range.", "operationId"=>"GetExchangeHoursRange", "x-api-path-slug"=>"getexchangehoursrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Exchange", "Hours", "Range"]}}, "/AreExchangesOpen"=>{"get"=>{"summary"=>"Are Exchanges Open", "description"=>"Are exchanges open.", "operationId"=>"AreExchangesOpen", "x-api-path-slug"=>"areexchangesopen-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Are", "Exchanges", "Open"]}}, "/IsExchangeOpenOnDate"=>{"get"=>{"summary"=>"Is Exchange Open On Date", "description"=>"Is exchange open on date.", "operationId"=>"IsExchangeOpenOnDate", "x-api-path-slug"=>"isexchangeopenondate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Exchange", "Open", "On", "Date"]}}, "/GetSettlementDate"=>{"get"=>{"summary"=>"Get Settlement Date", "description"=>"Get settlement date.", "operationId"=>"GetSettlementDate", "x-api-path-slug"=>"getsettlementdate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settlement", "Date"]}}, "/IsSettlementDate"=>{"get"=>{"summary"=>"Is Settlement Date", "description"=>"Is settlement date.", "operationId"=>"IsSettlementDate", "x-api-path-slug"=>"issettlementdate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settlement", "Date"]}}}}, "xignite-global-currencies-file-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Global Currencies File", "version"=>"1.0.0"}, "host"=>"cloudfiles.xignite.com", "basePath"=>"xGlobalCurrenciesFile.json/XigniteGlobalCurrenciesFile", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetFile"=>{"get"=>{"summary"=>"Get File", "description"=>"Get File", "operationId"=>"GetFile", "x-api-path-slug"=>"getfile-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Files"]}}}}, "xignite-statistics-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Statistics", "description"=>"delivers-and-charts-more-than-1400-economical-timeseries-fom-the-federal-reserve-bank-", "version"=>"1.0.0"}, "host"=>"www.xignite.com", "basePath"=>"xStatistics.json/XigniteStatistics", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetCategoriesAndTopics"=>{"get"=>{"summary"=>"Get Categories And Topics", "description"=>"Get categories and topics for statistics.", "operationId"=>"postGetcategoriesandtopics", "x-api-path-slug"=>"getcategoriesandtopics-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Categories", "And", "Topics"]}}, "/GetCategories"=>{"get"=>{"summary"=>"Get Categories", "description"=>"Get valid categories.", "operationId"=>"postGetcategories", "x-api-path-slug"=>"getcategories-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Categories"]}}, "/GetTopics"=>{"get"=>{"summary"=>"Get Topics", "description"=>"", "operationId"=>"postGettopics", "x-api-path-slug"=>"gettopics-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Topics"]}}, "/GetTopicDetails"=>{"get"=>{"summary"=>"Get Topic Details", "description"=>"", "operationId"=>"postGettopicdetails", "x-api-path-slug"=>"gettopicdetails-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Topic", "Details"]}}, "/GetTopicStatistics"=>{"get"=>{"summary"=>"Get Topic Statistics", "description"=>"Get statistics for a topic and a period.", "operationId"=>"postGettopicstatistics", "x-api-path-slug"=>"gettopicstatistics-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Topic", "Statistics"]}}, "/GetTopicData"=>{"get"=>{"summary"=>"Get Topic Data", "description"=>"Get time-series data for a topic.", "operationId"=>"postGettopicdata", "x-api-path-slug"=>"gettopicdata-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Topic", "Data"]}}, "/GetLatestTopicData"=>{"get"=>{"summary"=>"Get Latest Topic Data", "description"=>"Get lastest value for a topic.", "operationId"=>"postGetlatesttopicdata", "x-api-path-slug"=>"getlatesttopicdata-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Topic", "Data"]}}, "/GetAnnualizedTopicData"=>{"get"=>{"summary"=>"Get Annualized Topic Data", "description"=>"Get annualized time-series data for a topic.", "operationId"=>"postGetannualizedtopicdata", "x-api-path-slug"=>"getannualizedtopicdata-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Annualized", "Topic", "Data"]}}, "Topic, "=>{"get"=>{"summary"=>"Get Topic Chart", "description"=>"Get time-series data and a URL to a chart for a topic.", "operationId"=>"postGettopicchart", "x-api-path-slug"=>"topic-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Topic", "Chart"]}}, "Topic, , Preset"=>{"get"=>{"summary"=>"Get Topic Chart Preset", "description"=>"Get a preset chart for a topic.", "operationId"=>"postGettopicchartpreset", "x-api-path-slug"=>"topic--preset-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Topic", "Chart", "Preset"]}}, "Topic, , Custom"=>{"get"=>{"summary"=>"Get Topic Chart Custom", "description"=>"Get time-series data and a URL to a custom chart for a topic.", "operationId"=>"postGettopicchartcustom", "x-api-path-slug"=>"topic--custom-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Topic", "Chart", "Custom"]}}, "Topic, Binary, "=>{"get"=>{"summary"=>"Get Topic Binary Chart", "description"=>"Get time-series and a chart in binary format for a topic.", "operationId"=>"postGettopicbinarychart", "x-api-path-slug"=>"topic-binary-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Topic", "Binary", "Chart"]}}, "Topic, Binary, , Preset"=>{"get"=>{"summary"=>"Get Topic Binary Chart Preset", "description"=>"Get time-series and a chart in binary format for a topic.", "operationId"=>"postGettopicbinarychartpreset", "x-api-path-slug"=>"topic-binary--preset-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Topic", "Binary", "Chart", "Preset"]}}, "Topic, Binary, , Custom"=>{"get"=>{"summary"=>"Get Topic Binary Chart Custom", "description"=>"Get time-series and a custom chart in binary format for a topic.", "operationId"=>"postGettopicbinarychartcustom", "x-api-path-slug"=>"topic-binary--custom-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Topic", "Binary", "Chart", "Custom"]}}, ", Url"=>{"get"=>{"summary"=>"Get Chart Url", "description"=>"Get chart url for a topic.", "operationId"=>"postGetcharturl", "x-api-path-slug"=>"url-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chart", "Url"]}}, ", Url, Preset"=>{"get"=>{"summary"=>"Get Chart Url Preset", "description"=>"Get chart url for a topic.", "operationId"=>"postGetcharturlpreset", "x-api-path-slug"=>"url-preset-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chart", "Url", "Preset"]}}, ", Url, Custom"=>{"get"=>{"summary"=>"Get Chart Url Custom", "description"=>"Get chart url for a topic.", "operationId"=>"postGetcharturlcustom", "x-api-path-slug"=>"url-custom-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chart", "Url", "Custom"]}}, ", Binary"=>{"get"=>{"summary"=>"Get Chart Binary", "description"=>"Get chart in binary format for a topic.", "operationId"=>"postGetchartbinary", "x-api-path-slug"=>"binary-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chart", "Binary"]}}, ", Binary, Preset"=>{"get"=>{"summary"=>"Get Chart Binary Preset", "description"=>"Get chart in binary format for a topic.", "operationId"=>"postGetchartbinarypreset", "x-api-path-slug"=>"binary-preset-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chart", "Binary", "Preset"]}}, ", Binary, Custom"=>{"get"=>{"summary"=>"Get Chart Binary Custom", "description"=>"Get chart in binary format for a topic.", "operationId"=>"postGetchartbinarycustom", "x-api-path-slug"=>"binary-custom-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chart", "Binary", "Custom"]}}, ", Design"=>{"get"=>{"summary"=>"Get Chart Design", "description"=>"Returns the default design class for the statistics Chart.", "operationId"=>"postGetchartdesign", "x-api-path-slug"=>"design-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chart", "Design"]}}}}, "xignite-global-indices-real-time-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Global Indices Real Time", "description"=>"this-web-service-provides-global-real-time-information-for-u-s--and-international-indices-", "version"=>"1.0.0"}, "host"=>"globalindicesrealtime.xignite.com", "basePath"=>"xglobalindicesrealtime.json/XigniteGlobalIndicesRealTime", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetRealTimeIndicesValue"=>{"get"=>{"summary"=>"Get Real Time Indices Value", "description"=>"Get real time indices value.", "operationId"=>"GetRealTimeIndicesValue", "x-api-path-slug"=>"getrealtimeindicesvalue-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Time", "Indices", "Value"]}}, "/GetIndexBar"=>{"get"=>{"summary"=>"Get Index Bar", "description"=>"Get index bar.", "operationId"=>"GetIndexBar", "x-api-path-slug"=>"getindexbar-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Index", "Bar"]}}, "/GetIndexBars"=>{"get"=>{"summary"=>"Get Index Bars", "description"=>"Get index bars.", "operationId"=>"GetIndexBars", "x-api-path-slug"=>"getindexbars-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Index", "Bars"]}}, ", Bars"=>{"get"=>{"summary"=>"Get Chart Bars", "description"=>"Get chart bars.", "operationId"=>"GetChartBars", "x-api-path-slug"=>"bars-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chart", "Bars"]}}, "/GetIndexSymbolMappingByOldSymbol"=>{"get"=>{"summary"=>"Get Index Symbol Mapping By Old Symbol", "description"=>"Get index symbol mapping by old symbol.", "operationId"=>"GetIndexSymbolMappingByOldSymbol", "x-api-path-slug"=>"getindexsymbolmappingbyoldsymbol-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Index", "Symbol", "Mapping", "Old", "Symbol"]}}, "/GetIndexSymbolMappingsByOldSymbols"=>{"get"=>{"summary"=>"Get Index Symbol Mappings By Old Symbols", "description"=>"Get index symbol mappings by old symbols.", "operationId"=>"GetIndexSymbolMappingsByOldSymbols", "x-api-path-slug"=>"getindexsymbolmappingsbyoldsymbols-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Index", "Symbol", "Mappings", "Old", "Symbols"]}}, "/GetRealTimeIndexValue"=>{"get"=>{"summary"=>"Get Real Time Index Value", "description"=>"Get real time index value.", "operationId"=>"GetRealTimeIndexValue", "x-api-path-slug"=>"getrealtimeindexvalue-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Time", "Index", "Value"]}}, "/ListIndexGroups"=>{"get"=>{"summary"=>"List Index Groups", "description"=>"List index groups.", "operationId"=>"ListIndexGroups", "x-api-path-slug"=>"listindexgroups-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Index", "Groups"]}}, "/ListIndicesByIndexGroup"=>{"get"=>{"summary"=>"List Indices By Index Group", "description"=>"List indices by index group.", "operationId"=>"ListIndicesByIndexGroup", "x-api-path-slug"=>"listindicesbyindexgroup-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Indices", "Index", "Group"]}}, "/SearchIndicesByName"=>{"get"=>{"summary"=>"Search Indices By Name", "description"=>"Search indices by name.", "operationId"=>"SearchIndicesByName", "x-api-path-slug"=>"searchindicesbyname-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Search", "Indices", "Name"]}}}}, "xignite-bonds-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Bonds", "description"=>"xignitebonds-service-provides-fourhour-delayed-price-data-for-us-corporate-and-agency-debt-bonds-including-debt-securities-issued-by-governmentsponsored-enterprises-gse--price-data-includes-last-sale-yield-daily-and-yearly-open-high-low-close-trade-price-data-", "version"=>"1.0.0"}, "host"=>"bonds.xignite.com", "basePath"=>"xBonds.json/XigniteBonds", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetPriceComposite"=>{"get"=>{"summary"=>"Get Price Composite", "description"=>"Returns price data composite including last sale price, yield and daily and yearly Open, High, Low prices for a specific bond reported by price source selected in the input. Return against this operation counts as three hits.", "operationId"=>"GetPriceComposite", "x-api-path-slug"=>"getpricecomposite-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Price", "Composite"]}}, "/GetLastSale"=>{"get"=>{"summary"=>"Get Last Sale", "description"=>"Returns Last Sale price for a specific bond as reported by the price source selected in the input. Request against this operation counts as one hit.", "operationId"=>"GetLastSale", "x-api-path-slug"=>"getlastsale-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Last", "Sale"]}}, "/GetDailyOpenHighLowClosePrice"=>{"get"=>{"summary"=>"Get Daily Open High Low Close Price", "description"=>"Returns daily Open, High, Low, Close (OHLC) prices for a specific bond reported by the price source selected in the input. Daily OHLC data is provided for the most recent date for which data is provided by the price source. Request against this operation counts as one hit.", "operationId"=>"GetDailyOpenHighLowClosePrice", "x-api-path-slug"=>"getdailyopenhighlowcloseprice-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Daily", "Open", "High", "Low", "Close", "Price"]}}, "/GetYearlyHighLowPrice"=>{"get"=>{"summary"=>"Get Yearly High Low Price", "description"=>"Returns yearly high, low prices for a specific bond reported by the price source selected in the input. Request against this operation counts as one hit.", "operationId"=>"GetYearlyHighLowPrice", "x-api-path-slug"=>"getyearlyhighlowprice-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Yearly", "High", "Low", "Price"]}}, "/GetYield"=>{"get"=>{"summary"=>"Get Yield", "description"=>"Returns Yield to maturity for a specific bond reported by the price source selected in the input. Request against this operation counts as one hit.", "operationId"=>"GetYield", "x-api-path-slug"=>"getyield-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Yield"]}}, "/GetAccruedInterest"=>{"get"=>{"summary"=>"Get Accrued Interest", "description"=>"Returns Accrued Interest for a specific bond reported by the price source selected in the input. Request against this operation counts as one hit.", "operationId"=>"GetAccruedInterest", "x-api-path-slug"=>"getaccruedinterest-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Accrued", "Interest"]}}, "/GetDurationAndConvexity"=>{"get"=>{"summary"=>"Get Duration And Convexity", "description"=>"Returns Duration and Convexity for a specific bond reported by the price source selected in the input. Request against this operation counts as one hit.", "operationId"=>"GetDurationAndConvexity", "x-api-path-slug"=>"getdurationandconvexity-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Duration", "Convexity"]}}, "/GetBondCalculation"=>{"get"=>{"summary"=>"Get Bond Calculation", "description"=>"Returns Price, Yield, Accrued Interest and other bond analytics data for a specific bond reported by the price source selected in the input. Request against this operation counts as four hits.", "operationId"=>"GetBondCalculation", "x-api-path-slug"=>"getbondcalculation-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Bond", "Calculation"]}}, "/GetPriceComposites"=>{"get"=>{"summary"=>"Get Price Composites", "description"=>"Returns price data composite including last sale price, yield and daily and yearly Open, High, Low prices for the list of bonds specified in the input. Each PriceComposite object returned in the output counts as three hits.", "operationId"=>"GetPriceComposites", "x-api-path-slug"=>"getpricecomposites-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Price", "Composites"]}}, "/GetLastSales"=>{"get"=>{"summary"=>"Get Last Sales", "description"=>"Returns Last Sale price for the list of bonds specified in the input, as reported by the price source selected in the input. Each LastSale object in the result counts as one hit.", "operationId"=>"GetLastSales", "x-api-path-slug"=>"getlastsales-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Last", "Sales"]}}, "/GetDailyOpenHighLowClosePrices"=>{"get"=>{"summary"=>"Get Daily Open High Low Close Prices", "description"=>"Returns daily Open, High, Low, Close (OHLC) prices for the list of bonds specified in the input. Daily OHLC data is provided for the most recent date for which data is provided by the price source. Each DailyOpenHighLowClosePrice object returned counts as one hit.", "operationId"=>"GetDailyOpenHighLowClosePrices", "x-api-path-slug"=>"getdailyopenhighlowcloseprices-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Daily", "Open", "High", "Low", "Close", "Prices"]}}, "/GetYearlyHighLowPrices"=>{"get"=>{"summary"=>"Get Yearly High Low Prices", "description"=>"Returns yearly high, low prices for the list of bonds specified in the input, as reported by the price source selected in the input. Each YearlyHighLowPrice object returned counts as one hit.", "operationId"=>"GetYearlyHighLowPrices", "x-api-path-slug"=>"getyearlyhighlowprices-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Yearly", "High", "Low", "Prices"]}}, "/GetYields"=>{"get"=>{"summary"=>"Get Yields", "description"=>"Returns Yield to maturity for the list of bonds specified in the input, as reported by the price source selected in the input. Each Yields object returned counts as one hit.", "operationId"=>"GetYields", "x-api-path-slug"=>"getyields-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Yields"]}}, "/GetAccruedInterests"=>{"get"=>{"summary"=>"Get Accrued Interests", "description"=>"Returns Accrued Interest for the list of bonds specified in the input. Each AccruedInterest object in the result counts as one hit.", "operationId"=>"GetAccruedInterests", "x-api-path-slug"=>"getaccruedinterests-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Accrued", "Interests"]}}, "/GetDurationAndConvexities"=>{"get"=>{"summary"=>"Get Duration And Convexities", "description"=>"Returns Duration and Convexity for a list of bonds provided in the input. Each DurationAndConvexity object in the result counts as one hit.", "operationId"=>"GetDurationAndConvexities", "x-api-path-slug"=>"getdurationandconvexities-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Duration", "Convexities"]}}, "/GetBondCalculations"=>{"get"=>{"summary"=>"Get Bond Calculations", "description"=>"Returns Price, Yield, Accrued Interest and other bond analytics data for a list of bonds provided in the input. Each BondCalculations object in the result counts as four hits.", "operationId"=>"GetBondCalculations", "x-api-path-slug"=>"getbondcalculations-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Bond", "Calculations"]}}, "/ListBondTypes"=>{"get"=>{"summary"=>"List Bond Types", "description"=>"", "operationId"=>"ListBondTypes", "x-api-path-slug"=>"listbondtypes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Bond", "Types"]}}, "/ListSymbols"=>{"get"=>{"summary"=>"List Symbols", "description"=>"", "operationId"=>"ListSymbols", "x-api-path-slug"=>"listsymbols-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Symbols"]}}}}, "xignite-currencies-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Currencies", "description"=>"provide-realtime-currency-foreign-exchange-information-and-calculations-", "version"=>"1.0.0"}, "host"=>"www.xignite.com/xCurrencies.json", "basePath"=>"/XigniteCurrencies", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/ListCurrencies"=>{"get"=>{"summary"=>"List Currencies", "description"=>"List supported currencies.", "operationId"=>"postListcurrencies", "x-api-path-slug"=>"listcurrencies-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Currencies"]}}, "/ListActiveCurrencies"=>{"get"=>{"summary"=>"List Active Currencies", "description"=>"List supported currencies.", "operationId"=>"postListactivecurrencies", "x-api-path-slug"=>"listactivecurrencies-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Active", "Currencies"]}}, "/ListOfficialRates"=>{"get"=>{"summary"=>"List Official Rates", "description"=>"List supported official rates.", "operationId"=>"postListofficialrates", "x-api-path-slug"=>"listofficialrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Official", "Rates"]}}, "/GetUnitOfAccount"=>{"get"=>{"summary"=>"Get Unit Of Account", "description"=>"Get Unit Of Account.", "operationId"=>"postGetunitofaccount", "x-api-path-slug"=>"getunitofaccount-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Unit", "Of", "Account"]}}, "/ConvertRealTimeValue"=>{"get"=>{"summary"=>"Convert Real Time Value", "description"=>"Convert value from one currency to another in real-time.", "operationId"=>"postConvertrealtimevalue", "x-api-path-slug"=>"convertrealtimevalue-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Convert", "Real", "Time", "Value"]}}, "/ConvertHistoricalValue"=>{"get"=>{"summary"=>"Convert Historical Value", "description"=>"Convert value from one currency to another as of a historical date.", "operationId"=>"postConverthistoricalvalue", "x-api-path-slug"=>"converthistoricalvalue-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Convert", "Historical", "Value"]}}, "/GetRealTimeForwardRate"=>{"get"=>{"summary"=>"Get Real Time Forward Rate", "description"=>"Returns a set of real-time currency forward rates.", "operationId"=>"postGetrealtimeforwardrate", "x-api-path-slug"=>"getrealtimeforwardrate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Time", "Forward", "Rate"]}}, "/GetRealTimeCrossRateAsString"=>{"get"=>{"summary"=>"Get Real Time Cross Rate As String", "description"=>"Returns a real-time currency cross-rate.", "operationId"=>"postGetrealtimecrossrateasstring", "x-api-path-slug"=>"getrealtimecrossrateasstring-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Time", "Cross", "Rate", "As", "String"]}}, "/GetLatestCrossRate"=>{"get"=>{"summary"=>"Get Latest Cross Rate", "description"=>"Returns the latest possible cross rate.", "operationId"=>"postGetlatestcrossrate", "x-api-path-slug"=>"getlatestcrossrate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Cross", "Rate"]}}, "/GetLatestCrossRates"=>{"get"=>{"summary"=>"Get Latest Cross Rates", "description"=>"Returns the latest possible cross rate.", "operationId"=>"postGetlatestcrossrates", "x-api-path-slug"=>"getlatestcrossrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Cross", "Rates"]}}, "/GetRealTimeCrossRate"=>{"get"=>{"summary"=>"Get Real Time Cross Rate", "description"=>"Returns a real-time currency cross-rate.", "operationId"=>"postGetrealtimecrossrate", "x-api-path-slug"=>"getrealtimecrossrate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Time", "Cross", "Rate"]}}, "/GetRealTimeCrossRateGMT"=>{"get"=>{"summary"=>"Get Real Time Cross Rate G M T", "description"=>"Returns a real-time currency cross-rate with the times in GMT.", "operationId"=>"postGetrealtimecrossrategmt", "x-api-path-slug"=>"getrealtimecrossrategmt-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Time", "Cross", "Rate", "G", "M", "T"]}}, "/GetRawCrossRate"=>{"get"=>{"summary"=>"Get Raw Cross Rate", "description"=>"Returns a real-time currency cross-rate.", "operationId"=>"postGetrawcrossrate", "x-api-path-slug"=>"getrawcrossrate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Raw", "Cross", "Rate"]}}, "/GetRawCrossRates"=>{"get"=>{"summary"=>"Get Raw Cross Rates", "description"=>"Returns a real-time currency cross-rate.", "operationId"=>"postGetrawcrossrates", "x-api-path-slug"=>"getrawcrossrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Raw", "Cross", "Rates"]}}, "/GetRealTimeCrossRates"=>{"get"=>{"summary"=>"Get Real Time Cross Rates", "description"=>"Returns the latest possible cross rate.", "operationId"=>"postGetrealtimecrossrates", "x-api-path-slug"=>"getrealtimecrossrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Time", "Cross", "Rates"]}}, "/GetHistoricalCrossRateTables"=>{"get"=>{"summary"=>"Get Historical Cross Rate Tables", "description"=>"Returns historical currency cross-rate tables for a range of dates.", "operationId"=>"postGethistoricalcrossratetables", "x-api-path-slug"=>"gethistoricalcrossratetables-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Cross", "Rate", "Tables"]}}, "/GetHistoricalCrossRateTablesBidAsk"=>{"get"=>{"summary"=>"Get Historical Cross Rate Tables Bid Ask", "description"=>"Returns historical currency cross-rate tables for a range of dates.", "operationId"=>"postGethistoricalcrossratetablesbask", "x-api-path-slug"=>"gethistoricalcrossratetablesbidask-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Cross", "Rate", "Tables", "Bid", "Ask"]}}, "/GetCurrencyReport"=>{"get"=>{"summary"=>"Get Currency Report", "description"=>"Returns historical currency cross-rate tables for a range of dates.", "operationId"=>"postGetcurrencyreport", "x-api-path-slug"=>"getcurrencyreport-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Currency", "Report"]}}, "/GetHistoricalCrossRateTable"=>{"get"=>{"summary"=>"Get Historical Cross Rate Table", "description"=>"Returns a historical currency cross-rate table.", "operationId"=>"postGethistoricalcrossratetable", "x-api-path-slug"=>"gethistoricalcrossratetable-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Cross", "Rate", "Table"]}}, "/GetHistoricalCrossRateTableBidAsk"=>{"get"=>{"summary"=>"Get Historical Cross Rate Table Bid Ask", "description"=>"Returns a historical currency cross-rate table.", "operationId"=>"postGethistoricalcrossratetablebask", "x-api-path-slug"=>"gethistoricalcrossratetablebidask-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Cross", "Rate", "Table", "Bid", "Ask"]}}, "/GetRealTimeCrossRateTable"=>{"get"=>{"summary"=>"Get Real Time Cross Rate Table", "description"=>"Returns a real-time currency cross-rate table.", "operationId"=>"postGetrealtimecrossratetable", "x-api-path-slug"=>"getrealtimecrossratetable-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Time", "Cross", "Rate", "Table"]}}, "/GetRealTimeCrossRateTableWithBidAsk"=>{"get"=>{"summary"=>"Get Real Time Cross Rate Table With Bid Ask", "description"=>"Returns a real-time currency cross-rate table.", "operationId"=>"postGetrealtimecrossratetablewithbask", "x-api-path-slug"=>"getrealtimecrossratetablewithbidask-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Time", "Cross", "Rate", "Table", "With", "Bid", "Ask"]}}, "/GetAllCrossRatesForACurrency"=>{"get"=>{"summary"=>"Get All Cross Rates For A Currency", "description"=>"Returns all valid cross rates for a currency.", "operationId"=>"postGetallcrossratesforacurrency", "x-api-path-slug"=>"getallcrossratesforacurrency-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Cross", "Rates", "Currency"]}}, "/GetRealTimeCrossRateTableAsHTML"=>{"get"=>{"summary"=>"Get Real Time Cross Rate Table As H T M L", "description"=>"Returns a real-time currency cross-rate table as an HTML Output.", "operationId"=>"postGetrealtimecrossratetableashtml", "x-api-path-slug"=>"getrealtimecrossratetableashtml-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Time", "Cross", "Rate", "Table", "As", "H", "T", "M", "L"]}}, "/GetSimpleRealTimeCrossRateTableAsHTML"=>{"get"=>{"summary"=>"Get Simple Real Time Cross Rate Table As H T M L", "description"=>"Returns a real-time currency cross-rate table as an HTML Output.", "operationId"=>"postGetsimplerealtimecrossratetableashtml", "x-api-path-slug"=>"getsimplerealtimecrossratetableashtml-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Simple", "Real", "Time", "Cross", "Rate", "Table", "As", "H", "T", "M", "L"]}}, "/GetHistoricalCrossRateTableAsHTML"=>{"get"=>{"summary"=>"Get Historical Cross Rate Table As H T M L", "description"=>"Returns a historical currency cross-rate table as an HTML Output.", "operationId"=>"postGethistoricalcrossratetableashtml", "x-api-path-slug"=>"gethistoricalcrossratetableashtml-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Cross", "Rate", "Table", "As", "H", "T", "M", "L"]}}, "/GetHistoricalCrossRate"=>{"get"=>{"summary"=>"Get Historical Cross Rate", "description"=>"Returns a cross-rate as of a historical date.", "operationId"=>"postGethistoricalcrossrate", "x-api-path-slug"=>"gethistoricalcrossrate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Cross", "Rate"]}}, "/GetHistoricalCrossRates"=>{"get"=>{"summary"=>"Get Historical Cross Rates", "description"=>"Returns multiple cross-rates as of a historical date.", "operationId"=>"postGethistoricalcrossrates", "x-api-path-slug"=>"gethistoricalcrossrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Cross", "Rates"]}}, "/GetHistoricalCrossRateBidAsk"=>{"get"=>{"summary"=>"Get Historical Cross Rate Bid Ask", "description"=>"Returns a cross-rate with bid/ask as of a historical date.", "operationId"=>"postGethistoricalcrossratebask", "x-api-path-slug"=>"gethistoricalcrossratebidask-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Cross", "Rate", "Bid", "Ask"]}}, "/GetHistoricalCrossRatesBidAsk"=>{"get"=>{"summary"=>"Get Historical Cross Rates Bid Ask", "description"=>"Returns multiple cross-rates with bid/ask as of a historical date.", "operationId"=>"postGethistoricalcrossratesbask", "x-api-path-slug"=>"gethistoricalcrossratesbidask-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Cross", "Rates", "Bid", "Ask"]}}, "/GetHistoricalCrossRatesRange"=>{"get"=>{"summary"=>"Get Historical Cross Rates Range", "description"=>"This operation returns a range of cross-rates for a currency pair.", "operationId"=>"postGethistoricalcrossratesrange", "x-api-path-slug"=>"gethistoricalcrossratesrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Cross", "Rates", "Range"]}}, "/GetHistoricalCrossRatesBidAskRange"=>{"get"=>{"summary"=>"Get Historical Cross Rates Bid Ask Range", "description"=>"This operation returns a range of cross-rates for a currency pair.", "operationId"=>"postGethistoricalcrossratesbaskrange", "x-api-path-slug"=>"gethistoricalcrossratesbidaskrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Cross", "Rates", "Bid", "Ask", "Range"]}}, "/GetHistoricalCrossRatesAsOf"=>{"get"=>{"summary"=>"Get Historical Cross Rates As Of", "description"=>"This operation returns a range of cross-rates for a currency pair.", "operationId"=>"postGethistoricalcrossratesasof", "x-api-path-slug"=>"gethistoricalcrossratesasof-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Cross", "Rates", "As", "Of"]}}, "/GetHistoricalCrossRatesBidAskAsOf"=>{"get"=>{"summary"=>"Get Historical Cross Rates Bid Ask As Of", "description"=>"This operation returns a range of cross-rates for a currency pair.", "operationId"=>"postGethistoricalcrossratesbaskasof", "x-api-path-slug"=>"gethistoricalcrossratesbidaskasof-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Cross", "Rates", "Bid", "Ask", "As", "Of"]}}, "/GetOfficialCrossRate"=>{"get"=>{"summary"=>"Get Official Cross Rate", "description"=>"Returns an official cross-rate as of a historical date.", "operationId"=>"postGetofficialcrossrate", "x-api-path-slug"=>"getofficialcrossrate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Official", "Cross", "Rate"]}}, "/GetOfficialCrossRates"=>{"get"=>{"summary"=>"Get Official Cross Rates", "description"=>"Returns an official cross-rate as of a historical date.", "operationId"=>"postGetofficialcrossrates", "x-api-path-slug"=>"getofficialcrossrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Official", "Cross", "Rates"]}}, "/GetOfficialCrossRateBidAsk"=>{"get"=>{"summary"=>"Get Official Cross Rate Bid Ask", "description"=>"Returns an official cross-rate as of a historical date.", "operationId"=>"postGetofficialcrossratebask", "x-api-path-slug"=>"getofficialcrossratebidask-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Official", "Cross", "Rate", "Bid", "Ask"]}}, "/GetOfficialCrossRatesBidAsk"=>{"get"=>{"summary"=>"Get Official Cross Rates Bid Ask", "description"=>"Returns an official cross-rate as of a historical date.", "operationId"=>"postGetofficialcrossratesbask", "x-api-path-slug"=>"getofficialcrossratesbidask-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Official", "Cross", "Rates", "Bid", "Ask"]}}, "/GetMutipleHistoricalCrossRates"=>{"get"=>{"summary"=>"Get Mutiple Historical Cross Rates", "description"=>"Returns multiple cross-rates as of a historical date.", "operationId"=>"postGetmutiplehistoricalcrossrates", "x-api-path-slug"=>"getmutiplehistoricalcrossrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Mutiple", "Historical", "Cross", "Rates"]}}, "/GetAverageHistoricalCrossRates"=>{"get"=>{"summary"=>"Get Average Historical Cross Rates", "description"=>"This operation returns an array average daily historical cross-rates for a period.", "operationId"=>"postGetaveragehistoricalcrossrates", "x-api-path-slug"=>"getaveragehistoricalcrossrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Average", "Historical", "Cross", "Rates"]}}, "/GetAverageHistoricalCrossRate"=>{"get"=>{"summary"=>"Get Average Historical Cross Rate", "description"=>"This operation returns an average daily historical cross-rates for a period.", "operationId"=>"postGetaveragehistoricalcrossrate", "x-api-path-slug"=>"getaveragehistoricalcrossrate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Average", "Historical", "Cross", "Rate"]}}, "/GetHistoricalMonthlyCrossRatesRange"=>{"get"=>{"summary"=>"Get Historical Monthly Cross Rates Range", "description"=>"This operation returns a complete range of stock quotes for a currency pair.", "operationId"=>"postGethistoricalmonthlycrossratesrange", "x-api-path-slug"=>"gethistoricalmonthlycrossratesrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Monthly", "Cross", "Rates", "Range"]}}, "/GetCrossRateChange"=>{"get"=>{"summary"=>"Get Cross Rate Change", "description"=>"This operation returns the changes in a cross-rates over the last 6 months.", "operationId"=>"postGetcrossratechange", "x-api-path-slug"=>"getcrossratechange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Cross", "Rate", "Change"]}}, "Currency, , Custom"=>{"get"=>{"summary"=>"Get Currency Chart Custom", "description"=>"Draw a custom currency chart for a date range.", "operationId"=>"postGetcurrencychartcustom", "x-api-path-slug"=>"currency--custom-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Currency", "Chart", "Custom"]}}, "Currency, , Custom, Binary"=>{"get"=>{"summary"=>"Get Currency Chart Custom Binary", "description"=>"Draw a custom currency chart for a date range.", "operationId"=>"postGetcurrencychartcustombinary", "x-api-path-slug"=>"currency--custom-binary-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Currency", "Chart", "Custom", "Binary"]}}, "Currency, "=>{"get"=>{"summary"=>"Get Currency Chart", "description"=>"Draw a historical currency chart for a date range.", "operationId"=>"postGetcurrencychart", "x-api-path-slug"=>"currency-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Currency", "Chart"]}}, "Currency, , Binary"=>{"get"=>{"summary"=>"Get Currency Chart Binary", "description"=>"Draw a historical currency chart for a date range in binary format.", "operationId"=>"postGetcurrencychartbinary", "x-api-path-slug"=>"currency--binary-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Currency", "Chart", "Binary"]}}, "Currency, Intraday, "=>{"get"=>{"summary"=>"Get Currency Intraday Chart", "description"=>"Draw a intraday currency chart for a time range", "operationId"=>"postGetcurrencyintradaychart", "x-api-path-slug"=>"currency-intraday-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Currency", "Intraday", "Chart"]}}, "Currency, Intraday, , Custom, Binary"=>{"get"=>{"summary"=>"Get Currency Intraday Chart Custom Binary", "description"=>"Draw a intraday currency chart for a time range in a binary format", "operationId"=>"postGetcurrencyintradaychartcustombinary", "x-api-path-slug"=>"currency-intraday--custom-binary-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Currency", "Intraday", "Chart", "Custom", "Binary"]}}, "Currency, Intraday, , Custom"=>{"get"=>{"summary"=>"Get Currency Intraday Chart Custom", "description"=>"Draw a intraday currency chart for a time range in a binary format", "operationId"=>"postGetcurrencyintradaychartcustom", "x-api-path-slug"=>"currency-intraday--custom-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Currency", "Intraday", "Chart", "Custom"]}}, ", Design"=>{"get"=>{"summary"=>"Get Chart Design", "description"=>"Returns the default design class for the currency Chart.", "operationId"=>"postGetchartdesign", "x-api-path-slug"=>"design-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chart", "Design"]}}, "/GetTick"=>{"get"=>{"summary"=>"Get Tick", "description"=>"Returns a tick for a currency pair as of a specific time in the day.", "operationId"=>"postGettick", "x-api-path-slug"=>"gettick-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Tick"]}}, "/GetTicks"=>{"get"=>{"summary"=>"Get Ticks", "description"=>"Returns a range of ticks for a currency pair.", "operationId"=>"postGetticks", "x-api-path-slug"=>"getticks-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Ticks"]}}, "/GetHistoricalTicks"=>{"get"=>{"summary"=>"Get Historical Ticks", "description"=>"Returns a range of ticks for a currency pair.", "operationId"=>"postGethistoricalticks", "x-api-path-slug"=>"gethistoricalticks-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Ticks"]}}, "/GetHistoricalHighLow"=>{"get"=>{"summary"=>"Get Historical High Low", "description"=>"Returns the high and the low ticks for a historical time range.", "operationId"=>"postGethistoricalhighlow", "x-api-path-slug"=>"gethistoricalhighlow-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "High", "Low"]}}, "/GetIntradayHighLow"=>{"get"=>{"summary"=>"Get Intraday High Low", "description"=>"Returns the high and the low ticks for today.", "operationId"=>"postGetintradayhighlow", "x-api-path-slug"=>"getintradayhighlow-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Intraday", "High", "Low"]}}}}, "xignite-global-option-master-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Global Option Master", "description"=>"complete-stock-option-management-application-", "version"=>"1.0.0"}, "host"=>"globaloptionmaster.xignite.com", "basePath"=>"xGlobalOptionMaster.json/XigniteGlobalOptionMaster", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetUnderlyingForOption"=>{"get"=>{"summary"=>"Get Underlying For Option", "description"=>"Get details on an underlying instrument for the option symbol provided.", "operationId"=>"GetUnderlyingForOption", "x-api-path-slug"=>"getunderlyingforoption-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Underlying", "Option"]}}, "/GetOptionBySymbol"=>{"get"=>{"summary"=>"Get Option By Symbol", "description"=>"Get details on an option.", "operationId"=>"GetOptionBySymbol", "x-api-path-slug"=>"getoptionbysymbol-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Option", "Symbol"]}}, "/GetOptionChain"=>{"get"=>{"summary"=>"Get Option Chain", "description"=>"Get the option chain for the underlying instrument.", "operationId"=>"GetOptionChain", "x-api-path-slug"=>"getoptionchain-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Option", "Chain"]}}, "/ListExchanges"=>{"get"=>{"summary"=>"List Exchanges", "description"=>"List supported exchanges.", "operationId"=>"ListExchanges", "x-api-path-slug"=>"listexchanges-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Exchanges"]}}}}, "xignite-calendar-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Calendar", "description"=>"ondemand-global-economic-calendar-", "version"=>"1.0.0"}, "host"=>"www.xignite.com", "basePath"=>"xCalendar.json/XigniteCalendar", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetEventsForNextNumberOfDays"=>{"get"=>{"summary"=>"Get Events For Next Number Of Days", "description"=>"Get events for the next number of days into the future.", "operationId"=>"postGeteventsfornextnumberofdays", "x-api-path-slug"=>"geteventsfornextnumberofdays-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Events", "Next", "Number", "Days"]}}, "/GetEventsForWeek"=>{"get"=>{"summary"=>"Get Events For Week", "description"=>"Get all the events released during the week specified. Weeks are Monday - Sunday.", "operationId"=>"postGeteventsforweek", "x-api-path-slug"=>"geteventsforweek-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Events", "Week"]}}, "/ListCountryCodes"=>{"get"=>{"summary"=>"List Country Codes", "description"=>"Get all of the country codes available to query on.", "operationId"=>"postListcountrycodes", "x-api-path-slug"=>"listcountrycodes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Country", "Codes"]}}, "/ListEventCodes"=>{"get"=>{"summary"=>"List Event Codes", "description"=>"Get all of the event codes available to query on.", "operationId"=>"postListeventcodes", "x-api-path-slug"=>"listeventcodes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Event", "Codes"]}}, "/GetEventDetails"=>{"get"=>{"summary"=>"Get Event Details", "description"=>"Get the details for the specified event.", "operationId"=>"postGeteventdetails", "x-api-path-slug"=>"geteventdetails-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Event", "Details"]}}, "/GetMultipleEventDetails"=>{"get"=>{"summary"=>"Get Multiple Event Details", "description"=>"Get the details for the specified events.", "operationId"=>"postGetmultipleeventdetails", "x-api-path-slug"=>"getmultipleeventdetails-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Multiple", "Event", "Details"]}}, "/GetEventsByCountryCode"=>{"get"=>{"summary"=>"Get Events By Country Code", "description"=>"Get events based on the country code and optionally within a specified released range.", "operationId"=>"postGeteventsbycountrycode", "x-api-path-slug"=>"geteventsbycountrycode-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Events", "Country", "Code"]}}, "/GetMostRecentEventsByEventCode"=>{"get"=>{"summary"=>"Get Most Recent Events By Event Code", "description"=>"Get the most recent events based on the event code and count.", "operationId"=>"postGetmostrecenteventsbyeventcode", "x-api-path-slug"=>"getmostrecenteventsbyeventcode-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Most", "Recent", "Events", "Event", "Code"]}}, "/GetEventsByEventCode"=>{"get"=>{"summary"=>"Get Events By Event Code", "description"=>"Get events based on the event code and optionally within a specified released range.", "operationId"=>"postGeteventsbyeventcode", "x-api-path-slug"=>"geteventsbyeventcode-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Events", "Event", "Code"]}}, "/GetEventsByEventName"=>{"get"=>{"summary"=>"Get Events By Event Name", "description"=>"Get events based on the event name and optionally within a specified released range.", "operationId"=>"postGeteventsbyeventname", "x-api-path-slug"=>"geteventsbyeventname-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Events", "Event", "Name"]}}, "/GetEventsForDate"=>{"get"=>{"summary"=>"Get Events For Date", "description"=>"Get events for the specified date.", "operationId"=>"postGeteventsfordate", "x-api-path-slug"=>"geteventsfordate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Events", "Date"]}}, "/GetEventsForMonth"=>{"get"=>{"summary"=>"Get Events For Month", "description"=>"Get events for the specified date.", "operationId"=>"postGeteventsformonth", "x-api-path-slug"=>"geteventsformonth-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Events", "Month"]}}, "/GetEventsForRange"=>{"get"=>{"summary"=>"Get Events For Range", "description"=>"Get events for the specified range.", "operationId"=>"postGeteventsforrange", "x-api-path-slug"=>"geteventsforrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Events", "Range"]}}, "/GetEventsForRangeLength"=>{"get"=>{"summary"=>"Get Events For Range Length", "description"=>"Get events for the date specified and next number of days past it.", "operationId"=>"postGeteventsforrangelength", "x-api-path-slug"=>"geteventsforrangelength-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Events", "Range", "Length"]}}, "/GetEventsForToday"=>{"get"=>{"summary"=>"Get Events For Today", "description"=>"Get all the events released today.", "operationId"=>"postGeteventsfortoday", "x-api-path-slug"=>"geteventsfortoday-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Events", "Today"]}}, "/GetEventsForTomorrow"=>{"get"=>{"summary"=>"Get Events For Tomorrow", "description"=>"Get all the events released tomorrow.", "operationId"=>"postGeteventsfortomorrow", "x-api-path-slug"=>"geteventsfortomorrow-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Events", "Tomorrow"]}}, "/GetEventsReleasedForRange"=>{"get"=>{"summary"=>"Get Events Released For Range", "description"=>"Get events released for the specified range.", "operationId"=>"postGeteventsreleasedforrange", "x-api-path-slug"=>"geteventsreleasedforrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Events", "Released", "Range"]}}, "/GetEventsReleasedForRangeLength"=>{"get"=>{"summary"=>"Get Events Released For Range Length", "description"=>"Get events released for the date specified and next number of days past it.", "operationId"=>"postGeteventsreleasedforrangelength", "x-api-path-slug"=>"geteventsreleasedforrangelength-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Events", "Released", "Range", "Length"]}}, "/SearchEvents"=>{"get"=>{"summary"=>"Search Events", "description"=>"Perform a complex query on events.", "operationId"=>"postSearchevents", "x-api-path-slug"=>"searchevents-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Search", "Events"]}}, "/GetLatestUpdateTimeStamp"=>{"get"=>{"summary"=>"Get Latest Update Time Stamp", "description"=>"Get latest update TimeStamp for this service.", "operationId"=>"postGetlatestupdatetimestamp", "x-api-path-slug"=>"getlatestupdatetimestamp-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "", "Time", "Stamp"]}}, "/GetServiceDemonstration"=>{"get"=>{"summary"=>"Get Service Demonstration", "description"=>"Get demonstration for this service.", "operationId"=>"postGetservicedemonstration", "x-api-path-slug"=>"getservicedemonstration-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Service", "Demonstration"]}}}}, "xignite-global-historical-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Global Historical", "description"=>"ondemand-global-historical-quotes-", "version"=>"1.0.0"}, "host"=>"www.xignite.com", "basePath"=>"xGlobalHistorical.json/XigniteGlobalHistorical", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetGlobalLastClosingPrice"=>{"get"=>{"summary"=>"Get Global Last Closing Price", "description"=>"Returns last closing price for a security.", "operationId"=>"postGetgloballastclosingprice", "x-api-path-slug"=>"getgloballastclosingprice-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Global", "Last", "Closing", "Price"]}}, "/GetGlobalLastClosingPrices"=>{"get"=>{"summary"=>"Get Global Last Closing Prices", "description"=>"Returns last closing price for a collection of securities.", "operationId"=>"postGetgloballastclosingprices", "x-api-path-slug"=>"getgloballastclosingprices-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Global", "Last", "Closing", "Prices"]}}, "/GetGlobalHistoricalQuote"=>{"get"=>{"summary"=>"Get Global Historical Quote", "description"=>"Returns a quote as of a historical date. This includes the adjusted price as specified.", "operationId"=>"postGetglobalhistoricalquote", "x-api-path-slug"=>"getglobalhistoricalquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Global", "Historical", "Quote"]}}, "/GetEndOfDayQuote"=>{"get"=>{"summary"=>"Get End Of Day Quote", "description"=>"Returns a quote as of a historical date. This includes the adjusted price as specified.", "operationId"=>"postGetendofdayquote", "x-api-path-slug"=>"getendofdayquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "End", "Of", "Day", "Quote"]}}, "/GetEndOfDayQuotes"=>{"get"=>{"summary"=>"Get End Of Day Quotes", "description"=>"Returns a quote as of a historical date. This includes the adjusted price as specified.", "operationId"=>"postGetendofdayquotes", "x-api-path-slug"=>"getendofdayquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "End", "Of", "Day", "Quotes"]}}, "/GetEndOfDayQuotesRange"=>{"get"=>{"summary"=>"Get End Of Day Quotes Range", "description"=>"Returns a quote a complete range of stock quotes for a given equity. This includes the adjusted price as specified.", "operationId"=>"postGetendofdayquotesrange", "x-api-path-slug"=>"getendofdayquotesrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "End", "Of", "Day", "Quotes", "Range"]}}, "/GetGlobalHistoricalQuotes"=>{"get"=>{"summary"=>"Get Global Historical Quotes", "description"=>"Returns quotes as of a historical date. This includes the adjusted price as specified.", "operationId"=>"postGetglobalhistoricalquotes", "x-api-path-slug"=>"getglobalhistoricalquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Global", "Historical", "Quotes"]}}, "/GetGlobalHistoricalQuotesAsOf"=>{"get"=>{"summary"=>"Get Global Historical Quotes As Of", "description"=>"This operation returns a range of quotes for a security.", "operationId"=>"postGetglobalhistoricalquotesasof", "x-api-path-slug"=>"getglobalhistoricalquotesasof-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Global", "Historical", "Quotes", "As", "Of"]}}, "/GetGlobalHistoricalQuotesRange"=>{"get"=>{"summary"=>"Get Global Historical Quotes Range", "description"=>"This operation returns a complete range of stock quotes for a given equity. This includes the adjusted price as specified.", "operationId"=>"postGetglobalhistoricalquotesrange", "x-api-path-slug"=>"getglobalhistoricalquotesrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Global", "Historical", "Quotes", "Range"]}}, "/GetGlobalHistoricalQuotesRangeExtended"=>{"get"=>{"summary"=>"Get Global Historical Quotes Range Extended", "description"=>"This operation returns a complete range of global historical quotes extended for a given equity. This includes the adjusted price as specified.", "operationId"=>"postGetglobalhistoricalquotesrangeextended", "x-api-path-slug"=>"getglobalhistoricalquotesrangeextended-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Global", "Historical", "Quotes", "Range", "Extended"]}}, "/GetGlobalHistoricalWeeklyQuotesRange"=>{"get"=>{"summary"=>"Get Global Historical Weekly Quotes Range", "description"=>"Returns a range of weekly Global Historical quotes for a security. For more information, go to http://www.xignite.com/", "operationId"=>"postGetglobalhistoricalweeklyquotesrange", "x-api-path-slug"=>"getglobalhistoricalweeklyquotesrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Global", "Historical", "Weekly", "Quotes", "Range"]}}, "/GetGlobalHistoricalWeeklyQuotesRangeExtended"=>{"get"=>{"summary"=>"Get Global Historical Weekly Quotes Range Extended", "description"=>"Returns a range of weekly Global Historical quotes extended for a security. For more information, go to http://www.xignite.com/", "operationId"=>"postGetglobalhistoricalweeklyquotesrangeextended", "x-api-path-slug"=>"getglobalhistoricalweeklyquotesrangeextended-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Global", "Historical", "Weekly", "Quotes", "Range", "Extended"]}}, "/GetGlobalHistoricalQuarterlyQuotesRange"=>{"get"=>{"summary"=>"Get Global Historical Quarterly Quotes Range", "description"=>"Returns a range of quarterly Global Historical quotes for a security. For more information, go to http://www.xignite.com/", "operationId"=>"postGetglobalhistoricalquarterlyquotesrange", "x-api-path-slug"=>"getglobalhistoricalquarterlyquotesrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Global", "Historical", "Quarterly", "Quotes", "Range"]}}, "/GetGlobalHistoricalStatistics"=>{"get"=>{"summary"=>"Get Global Historical Statistics", "description"=>"Returns Global Historical statistics for a security. For more information, go to http://www.xignite.com/", "operationId"=>"postGetglobalhistoricalstatistics", "x-api-path-slug"=>"getglobalhistoricalstatistics-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Global", "Historical", "Statistics"]}}, "/GetGlobalHistoricalMonthlyQuotesRange"=>{"get"=>{"summary"=>"Get Global Historical Monthly Quotes Range", "description"=>"This operation returns a range of monthly quotes for an equity based on the specified date range. This includes the adjusted price as specified.", "operationId"=>"postGetglobalhistoricalmonthlyquotesrange", "x-api-path-slug"=>"getglobalhistoricalmonthlyquotesrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Global", "Historical", "Monthly", "Quotes", "Range"]}}, "/GetGlobalHistoricalMonthlyQuotesRangeExtended"=>{"get"=>{"summary"=>"Get Global Historical Monthly Quotes Range Extended", "description"=>"This operation returns a range of monthly quotes extended for an equity based on the specified date range. This includes the adjusted price as specified.", "operationId"=>"postGetglobalhistoricalmonthlyquotesrangeextended", "x-api-path-slug"=>"getglobalhistoricalmonthlyquotesrangeextended-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Global", "Historical", "Monthly", "Quotes", "Range", "Extended"]}}, "/GetTopMoversByExchange"=>{"get"=>{"summary"=>"Get Top Movers By Exchange", "description"=>"This operation returns quote information about the top moving equities for the requested exchange.", "operationId"=>"postGettopmoversbyexchange", "x-api-path-slug"=>"gettopmoversbyexchange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Movers", "By", "Exchange"]}}, "/GetTopGainersByExchange"=>{"get"=>{"summary"=>"Get Top Gainers By Exchange", "description"=>"This operation returns quote information about the top gaining equities for the requested exchange.", "operationId"=>"postGettopgainersbyexchange", "x-api-path-slug"=>"gettopgainersbyexchange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Gainers", "By", "Exchange"]}}, "/GetTopLosersByExchange"=>{"get"=>{"summary"=>"Get Top Losers By Exchange", "description"=>"This operation returns quote information about the top losing equities for the requested exchange.", "operationId"=>"postGettoplosersbyexchange", "x-api-path-slug"=>"gettoplosersbyexchange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Losers", "By", "Exchange"]}}, "/GetAllSplitsByExchange"=>{"get"=>{"summary"=>"Get All Splits By Exchange", "description"=>"Get all splits for a date range in the specified exchange.", "operationId"=>"postGetallsplitsbyexchange", "x-api-path-slug"=>"getallsplitsbyexchange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Splits", "By", "Exchange"]}}, "/GetSplitRatio"=>{"get"=>{"summary"=>"Get Split Ratio", "description"=>"Return the cumulative split ratio for a security between two dates. For instance, if a security saw a 3:1 split and 2:1 split during the period, the split ratio 6 is returned. Returns 1 if no split occurred.", "operationId"=>"postGetsplitratio", "x-api-path-slug"=>"getsplitratio-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Split", "Ratio"]}}, "/GetSplitHistory"=>{"get"=>{"summary"=>"Get Split History", "description"=>"Get split history for a stock for a date range.", "operationId"=>"postGetsplithistory", "x-api-path-slug"=>"getsplithistory-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Split", "History"]}}, "/GetAllCashDividendsByExchange"=>{"get"=>{"summary"=>"Get All Cash Dividends By Exchange", "description"=>"Get all cash dividends for a date range in the specified exchange.", "operationId"=>"postGetallcashdivendsbyexchange", "x-api-path-slug"=>"getallcashdividendsbyexchange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Cash", "Dividends", "By", "Exchange"]}}, "/GetCashDividendTotal"=>{"get"=>{"summary"=>"Get Cash Dividend Total", "description"=>"Return the cumulative cash dividend total for a security between two dates.", "operationId"=>"postGetcashdivendtotal", "x-api-path-slug"=>"getcashdividendtotal-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Cash", "Dividend", "Total"]}}, "/GetCashDividendHistory"=>{"get"=>{"summary"=>"Get Cash Dividend History", "description"=>"Get cash dividend history for a stock for a date range.", "operationId"=>"postGetcashdivendhistory", "x-api-path-slug"=>"getcashdividendhistory-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Cash", "Dividend", "History"]}}, "/GetAllCorporateActionsByExchange"=>{"get"=>{"summary"=>"Get All Corporate Actions By Exchange", "description"=>"Get all corporate actions for a date range in the specified exchange.", "operationId"=>"postGetallcorporateactionsbyexchange", "x-api-path-slug"=>"getallcorporateactionsbyexchange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Corporate", "Actions", "By", "Exchange"]}}, "/GetCorporateActionHistory"=>{"get"=>{"summary"=>"Get Corporate Action History", "description"=>"Get the corporate action history for a stock for a date range.", "operationId"=>"postGetcorporateactionhistory", "x-api-path-slug"=>"getcorporateactionhistory-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Corporate", "Action", "History"]}}, "/ListSymbols"=>{"get"=>{"summary"=>"List Symbols", "description"=>"Get all symbols in the specified exchange.", "operationId"=>"postListsymbols", "x-api-path-slug"=>"listsymbols-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Symbols"]}}, "/ListExchanges"=>{"get"=>{"summary"=>"List Exchanges", "description"=>"This operation returns exchanges information.", "operationId"=>"postListexchanges", "x-api-path-slug"=>"listexchanges-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Exchanges"]}}}}, "xignite-global-real-time-futures-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Global Real Time Futures", "description"=>"this-web-service-provides-global-realtime-future-and-option-quotes-for-u-s--and-international-future-contracts-", "version"=>"1.0.0"}, "host"=>"globalrealtimefutures.xignite.com", "basePath"=>"xGlobalRealTimeFutures.json/XigniteGlobalRealTimeFutures", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetFutureQuote"=>{"get"=>{"summary"=>"Get Future Quote", "description"=>"Returns a realtime quote for a future contract.", "operationId"=>"GetFutureQuote", "x-api-path-slug"=>"getfuturequote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Future", "Quote"]}}, "/GetLatestFutureQuote"=>{"get"=>{"summary"=>"Get Latest Future Quote", "description"=>"Returns the latest realtime quote for a future contract.", "operationId"=>"GetLatestFutureQuote", "x-api-path-slug"=>"getlatestfuturequote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Future", "Quote"]}}, "/GetSpotFutureQuote"=>{"get"=>{"summary"=>"Get Spot Future Quote", "description"=>"Returns a realtime spot quote for a future contract.", "operationId"=>"GetSpotFutureQuote", "x-api-path-slug"=>"getspotfuturequote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Spot", "Future", "Quote"]}}, "/GetFutureQuotes"=>{"get"=>{"summary"=>"Get Future Quotes", "description"=>"Returns realtime quotes for multiple future contracts.", "operationId"=>"GetFutureQuotes", "x-api-path-slug"=>"getfuturequotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Future", "Quotes"]}}, "/GetLatestFutureQuotes"=>{"get"=>{"summary"=>"Get Latest Future Quotes", "description"=>"Returns latest realtime quotes for multiple future contracts.", "operationId"=>"GetLatestFutureQuotes", "x-api-path-slug"=>"getlatestfuturequotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Future", "Quotes"]}}, "/GetLatestFrontMonthFutureQuotes"=>{"get"=>{"summary"=>"Get Latest Front Month Future Quotes", "description"=>"Returns latest quotes for front month futures", "operationId"=>"GetLatestFrontMonthFutureQuotes", "x-api-path-slug"=>"getlatestfrontmonthfuturequotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Front", "Month", "Future", "Quotes"]}}, "/GetAllFutureQuotes"=>{"get"=>{"summary"=>"Get All Future Quotes", "description"=>"Returns all delayed future quotes for a future base.", "operationId"=>"GetAllFutureQuotes", "x-api-path-slug"=>"getallfuturequotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Future", "Quotes"]}}, "/GetFutureOptionQuote"=>{"get"=>{"summary"=>"Get Future Option Quote", "description"=>"Returns a realtime future option quote for a future option.", "operationId"=>"GetFutureOptionQuote", "x-api-path-slug"=>"getfutureoptionquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Future", "Option", "Quote"]}}, "/GetAllOptionQuotes"=>{"get"=>{"summary"=>"Get All Option Quotes", "description"=>"Returns all realtime future option quotes for a future contract.", "operationId"=>"GetAllOptionQuotes", "x-api-path-slug"=>"getalloptionquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Option", "Quotes"]}}, "/GetFutureOptionQuotes"=>{"get"=>{"summary"=>"Get Future Option Quotes", "description"=>"Returns realtime future option quotes for multiple future options.", "operationId"=>"GetFutureOptionQuotes", "x-api-path-slug"=>"getfutureoptionquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Future", "Option", "Quotes"]}}, "/GetLatestFutureOptionQuote"=>{"get"=>{"summary"=>"Get Latest Future Option Quote", "description"=>"Returns latest realtime quote for multiple future option.", "operationId"=>"GetLatestFutureOptionQuote", "x-api-path-slug"=>"getlatestfutureoptionquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Future", "Option", "Quote"]}}, "/GetLatestFutureOptionQuotes"=>{"get"=>{"summary"=>"Get Latest Future Option Quotes", "description"=>"Returns latest realtime quotes for multiple future options.", "operationId"=>"GetLatestFutureOptionQuotes", "x-api-path-slug"=>"getlatestfutureoptionquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Future", "Option", "Quotes"]}}, "/GetSwapQuote"=>{"get"=>{"summary"=>"Get Swap Quote", "description"=>"Returns realtime quote for a swap", "operationId"=>"GetSwapQuote", "x-api-path-slug"=>"getswapquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Swap", "Quote"]}}, "/ListFutureExchanges"=>{"get"=>{"summary"=>"List Future Exchanges", "description"=>"Returns a list of future exchanges", "operationId"=>"ListFutureExchanges", "x-api-path-slug"=>"listfutureexchanges-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Future", "Exchanges"]}}, "/ListBaseFutures"=>{"get"=>{"summary"=>"List Base Futures", "description"=>"Returns a list of base future symbols", "operationId"=>"ListBaseFutures", "x-api-path-slug"=>"listbasefutures-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Base", "Futures"]}}, "/ListFutureChain"=>{"get"=>{"summary"=>"List Future Chain", "description"=>"Returns a list of future contracts on a base future symbol", "operationId"=>"ListFutureChain", "x-api-path-slug"=>"listfuturechain-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Future", "Chain"]}}, "/ListOptionChain"=>{"get"=>{"summary"=>"List Option Chain", "description"=>"Returns a list of options on a future contract", "operationId"=>"ListOptionChain", "x-api-path-slug"=>"listoptionchain-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Option", "Chain"]}}, "/SearchFutures"=>{"get"=>{"summary"=>"Search Futures", "description"=>"Returns futures match the name", "operationId"=>"SearchFutures", "x-api-path-slug"=>"searchfutures-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Search", "Futures"]}}}}, "xignite-global-options-file-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Global Options File", "version"=>"1.0.0"}, "host"=>"cloudfiles.xignite.com", "basePath"=>"xGlobalOptionsFile.json/XigniteGlobalOptionsFile", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetFile"=>{"get"=>{"summary"=>"Get File", "description"=>"Get file", "operationId"=>"GetFile", "x-api-path-slug"=>"getfile-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Files"]}}}}, "xignite-global-indices-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Global Indices", "description"=>"this-web-service-provides-global-delayed-information-for-u-s--and-international-indices-", "version"=>"1.0.0"}, "host"=>"globalindices.xignite.com", "basePath"=>"xglobalindices.json/XigniteGlobalIndices", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetDelayedIndicesValue"=>{"get"=>{"summary"=>"Get Delayed Indices Value", "description"=>"Get delayed indices value.", "operationId"=>"GetDelayedIndicesValue", "x-api-path-slug"=>"getdelayedindicesvalue-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Delayed", "Indices", "Value"]}}, "/GetDelayedIndexValue"=>{"get"=>{"summary"=>"Get Delayed Index Value", "description"=>"Get delayed index value.", "operationId"=>"GetDelayedIndexValue", "x-api-path-slug"=>"getdelayedindexvalue-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Delayed", "Index", "Value"]}}, "/GetIndexBar"=>{"get"=>{"summary"=>"Get Index Bar", "description"=>"Get index bar.", "operationId"=>"GetIndexBar", "x-api-path-slug"=>"getindexbar-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Index", "Bar"]}}, "/GetIndexBars"=>{"get"=>{"summary"=>"Get Index Bars", "description"=>"Get index bars.", "operationId"=>"GetIndexBars", "x-api-path-slug"=>"getindexbars-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Index", "Bars"]}}, ", Bars"=>{"get"=>{"summary"=>"Get Chart Bars", "description"=>"Get chart bars.", "operationId"=>"GetChartBars", "x-api-path-slug"=>"bars-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chart", "Bars"]}}, "/GetIndexSymbolMappingByOldSymbol"=>{"get"=>{"summary"=>"Get Index Symbol Mapping By Old Symbol", "description"=>"Get index symbol mapping by old symbol.", "operationId"=>"GetIndexSymbolMappingByOldSymbol", "x-api-path-slug"=>"getindexsymbolmappingbyoldsymbol-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Index", "Symbol", "Mapping", "Old", "Symbol"]}}, "/GetIndexSymbolMappingsByOldSymbols"=>{"get"=>{"summary"=>"Get Index Symbol Mappings By Old Symbols", "description"=>"Get index symbol mappings by old symbols.", "operationId"=>"GetIndexSymbolMappingsByOldSymbols", "x-api-path-slug"=>"getindexsymbolmappingsbyoldsymbols-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Index", "Symbol", "Mappings", "Old", "Symbols"]}}, "/ListIndexGroups"=>{"get"=>{"summary"=>"List Index Groups", "description"=>"List index groups.", "operationId"=>"ListIndexGroups", "x-api-path-slug"=>"listindexgroups-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Index", "Groups"]}}, "/ListIndicesByIndexGroup"=>{"get"=>{"summary"=>"List Indices By Index Group", "description"=>"List indices by index group.", "operationId"=>"ListIndicesByIndexGroup", "x-api-path-slug"=>"listindicesbyindexgroup-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Indices", "Index", "Group"]}}, "/SearchIndicesByName"=>{"get"=>{"summary"=>"Search Indices By Name", "description"=>"Search indices by name.", "operationId"=>"SearchIndicesByName", "x-api-path-slug"=>"searchindicesbyname-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Search", "Indices", "Name"]}}}}, "xignite-rates-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Rates", "description"=>"provide-information-about-interest-rates-", "version"=>"1.0.0"}, "host"=>"www.xignite.com", "basePath"=>"xRates.json/XigniteRates", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetLIBORSecure"=>{"get"=>{"summary"=>"Get LIBOR Secure", "description"=>"Returns Libor as of a date", "operationId"=>"postGetliborsecure", "x-api-path-slug"=>"getliborsecure-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "LIBOR", "Secure"]}}, "/GetLIBOR"=>{"get"=>{"summary"=>"Get LIBOR", "description"=>"Returns Libor as of a date", "operationId"=>"postGetlibor", "x-api-path-slug"=>"getlibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "LIBOR"]}}, "/GetStateRate"=>{"get"=>{"summary"=>"Get State Rate", "description"=>"Returns a state rate", "operationId"=>"postGetstaterate", "x-api-path-slug"=>"getstaterate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "State", "Rate"]}}, "/GetStateRates"=>{"get"=>{"summary"=>"Get State Rates", "description"=>"Returns state rates for a date range.", "operationId"=>"postGetstaterates", "x-api-path-slug"=>"getstaterates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "State", "Rates"]}}, "/GetFederalRate"=>{"get"=>{"summary"=>"Get Federal Rate", "description"=>"Returns a federal discount borrowing rate", "operationId"=>"postGetfederalrate", "x-api-path-slug"=>"getfederalrate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Federal", "Rate"]}}, "/GetFederalRates"=>{"get"=>{"summary"=>"Get Federal Rates", "description"=>"Returns federal discount borrowing for a date range.", "operationId"=>"postGetfederalrates", "x-api-path-slug"=>"getfederalrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Federal", "Rates"]}}, "/GetForwardRateAgreement"=>{"get"=>{"summary"=>"Get Forward Rate Agreement", "description"=>"Returns a calculated Forward Rate Agreement as of a date", "operationId"=>"postGetforwardrateagreement", "x-api-path-slug"=>"getforwardrateagreement-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Forward", "Rate", "Agreement"]}}, "/GetEuroDollarFRAStrip"=>{"get"=>{"summary"=>"Get Euro DollarFRA Strip", "description"=>"Returns an IMM EuroDollar Synthetic Forward Rate strip", "operationId"=>"postGeteurodollarfrastrip", "x-api-path-slug"=>"geteurodollarfrastrip-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Euro", "DollarFRStrip"]}}, "/GetSwapRate"=>{"get"=>{"summary"=>"Get Swap Rate", "description"=>"Returns a Swap rate", "operationId"=>"postGetswaprate", "x-api-path-slug"=>"getswaprate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Swap", "Rate"]}}, "/GetSwapRateFamily"=>{"get"=>{"summary"=>"Get Swap Rate Family", "description"=>"Returns a Swap rate Family", "operationId"=>"postGetswapratefamily", "x-api-path-slug"=>"getswapratefamily-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Swap", "Rate", "Family"]}}, "/GetHistoricalSwapRate"=>{"get"=>{"summary"=>"Get Historical Swap Rate", "description"=>"Returns a Swap rate as of a historical date", "operationId"=>"postGethistoricalswaprate", "x-api-path-slug"=>"gethistoricalswaprate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Swap", "Rate"]}}, "/GetHistoricalSwapRateRange"=>{"get"=>{"summary"=>"Get Historical Swap Rate Range", "description"=>"Returns a Swap rate as of a historical date", "operationId"=>"postGethistoricalswapraterange", "x-api-path-slug"=>"gethistoricalswapraterange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Swap", "Rate", "Range"]}}, "/GetREIBOR"=>{"get"=>{"summary"=>"Get REIBOR", "description"=>"Returns a REIBOR as of a date", "operationId"=>"postGetreibor", "x-api-path-slug"=>"getreibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "REIBOR"]}}, "/GetHIBOR"=>{"get"=>{"summary"=>"Get HIBOR", "description"=>"Returns a HIBOR as of a date", "operationId"=>"postGethibor", "x-api-path-slug"=>"gethibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "HIBOR"]}}, "/GetSOFIBOR"=>{"get"=>{"summary"=>"Get SOFIBOR", "description"=>"Returns a SOFIBOR as of a date", "operationId"=>"postGetsofibor", "x-api-path-slug"=>"getsofibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "SOFIBOR"]}}, "/GetREIBID"=>{"get"=>{"summary"=>"Get REIBID", "description"=>"Returns a REIBID as of a date", "operationId"=>"postGetreib", "x-api-path-slug"=>"getreibid-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "REIBID"]}}, "/GetOIBOR"=>{"get"=>{"summary"=>"Get OIBOR", "description"=>"Returns a OIBOR as of a date", "operationId"=>"postGetoibor", "x-api-path-slug"=>"getoibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "OIBOR"]}}, "/GetSIBOR"=>{"get"=>{"summary"=>"Get SIBOR", "description"=>"Returns a SIBOR as of a date", "operationId"=>"postGetsibor", "x-api-path-slug"=>"getsibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "SIBOR"]}}, "/GetCIBOR"=>{"get"=>{"summary"=>"Get CIBOR", "description"=>"Returns a CIBOR as of a date", "operationId"=>"postGetcibor", "x-api-path-slug"=>"getcibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "CIBOR"]}}, "/GetSTIBOR"=>{"get"=>{"summary"=>"Get STIBOR", "description"=>"Returns a STIBOR as of a date", "operationId"=>"postGetstibor", "x-api-path-slug"=>"getstibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "STIBOR"]}}, "/GetVILIBOR"=>{"get"=>{"summary"=>"Get VILIBOR", "description"=>"Returns a VILIBOR as of a date", "operationId"=>"postGetvilibor", "x-api-path-slug"=>"getvilibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "VILIBOR"]}}, "/GetWIBOR"=>{"get"=>{"summary"=>"Get WIBOR", "description"=>"Returns a WIBOR as of a date", "operationId"=>"postGetwibor", "x-api-path-slug"=>"getwibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "WIBOR"]}}, "/GetEURIBOR"=>{"get"=>{"summary"=>"Get EURIBOR", "description"=>"Returns a EURIBOR as of a date", "operationId"=>"postGeteuribor", "x-api-path-slug"=>"geteuribor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "EURIBOR"]}}, "/GetHistoricalLIBOR"=>{"get"=>{"summary"=>"Get Historical LIBOR", "description"=>"", "operationId"=>"postGethistoricallibor", "x-api-path-slug"=>"gethistoricallibor-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "LIBOR"]}}, "/GetWSJRate"=>{"get"=>{"summary"=>"Get WSJ Rate", "description"=>"Returns a specific interest rate.", "operationId"=>"postGetwsjrate", "x-api-path-slug"=>"getwsjrate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "WSJ", "Rate"]}}, "/GetTelerate3750"=>{"get"=>{"summary"=>"Get Telerate3750", "description"=>"Returns LIBOR rates as published daily on the Telerate 3750 screen at about 11:00 AM London time.", "operationId"=>"postGettelerate3750", "x-api-path-slug"=>"gettelerate3750-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Telerate3750"]}}, "/GetLastLondonFixing"=>{"get"=>{"summary"=>"Get Last London Fixing", "description"=>"Returns last UK Gold or Silver Fixings.", "operationId"=>"postGetlastlondonfixing", "x-api-path-slug"=>"getlastlondonfixing-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Last", "London", "Fixing"]}}, "/ListRates"=>{"get"=>{"summary"=>"List Rates", "description"=>"List supported interest rates.", "operationId"=>"postListrates", "x-api-path-slug"=>"listrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Rates"]}}, "/ListRatesByRateFamily"=>{"get"=>{"summary"=>"List Rates By Rate Family", "description"=>"List supported interest rates from a RateFamilyType.", "operationId"=>"postListratesbyratefamily", "x-api-path-slug"=>"listratesbyratefamily-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Rates", "Rate", "Family"]}}, "/SearchRates"=>{"get"=>{"summary"=>"Search Rates", "description"=>"Search rate names and description", "operationId"=>"postSearchrates", "x-api-path-slug"=>"searchrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Search", "Rates"]}}, "/GetRateSymbol"=>{"get"=>{"summary"=>"Get Rate Symbol", "description"=>"Returns the symbol for a rate.", "operationId"=>"postGetratesymbol", "x-api-path-slug"=>"getratesymbol-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Rate", "Symbol"]}}, "/GetRateFromSymbol"=>{"get"=>{"summary"=>"Get Rate From Symbol", "description"=>"Returns the symbol for a rate.", "operationId"=>"postGetratefromsymbol", "x-api-path-slug"=>"getratefromsymbol-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Rate", "From", "Symbol"]}}, "/GetRate"=>{"get"=>{"summary"=>"Get Rate", "description"=>"Returns a rate as of a specific date.", "operationId"=>"postGetrate", "x-api-path-slug"=>"getrate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Rate"]}}, "/GetRateFamilyTable"=>{"get"=>{"summary"=>"Get Rate Family Table", "description"=>"Returns a rate table for a rate family.", "operationId"=>"postGetratefamilytable", "x-api-path-slug"=>"getratefamilytable-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Rate", "Family", "Table"]}}, "/GetAverageRate"=>{"get"=>{"summary"=>"Get Average Rate", "description"=>"Returns an average rate as of a specific date.", "operationId"=>"postGetaveragerate", "x-api-path-slug"=>"getaveragerate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Average", "Rate"]}}, "/GetAverageRates"=>{"get"=>{"summary"=>"Get Average Rates", "description"=>"Returns average rate for a period.", "operationId"=>"postGetaveragerates", "x-api-path-slug"=>"getaveragerates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Average", "Rates"]}}, "/GetRateMovingAverage"=>{"get"=>{"summary"=>"Get Rate Moving Average", "description"=>"Returns a moving average rate as of a specific date", "operationId"=>"postGetratemovingaverage", "x-api-path-slug"=>"getratemovingaverage-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Rate", "Moving", "Average"]}}, "/GetDailyAverage"=>{"get"=>{"summary"=>"Get Daily Average", "description"=>"Returns a daily average rate as of a specific date", "operationId"=>"postGetdailyaverage", "x-api-path-slug"=>"getdailyaverage-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Daily", "Average"]}}, "/GetMonthlyTreasuryAverage"=>{"get"=>{"summary"=>"Get Monthly Treasury Average", "description"=>"Returns a daily average rate as of a specific date", "operationId"=>"postGetmonthlytreasuryaverage", "x-api-path-slug"=>"getmonthlytreasuryaverage-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Monthly", "Treasury", "Average"]}}, "/GetRateFamily"=>{"get"=>{"summary"=>"Get Rate Family", "description"=>"Returns a collection of related rate as of a specific date", "operationId"=>"postGetratefamily", "x-api-path-slug"=>"getratefamily-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Rate", "Family"]}}, "/GetTodaysRate"=>{"get"=>{"summary"=>"Get Todays Rate", "description"=>"Returns end of day closing value for a rate", "operationId"=>"postGettodaysrate", "x-api-path-slug"=>"gettodaysrate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Todays", "Rate"]}}, "/GetLatestRate"=>{"get"=>{"summary"=>"Get Latest Rate", "description"=>"Returns latest value for a rate.", "operationId"=>"postGetlatestrate", "x-api-path-slug"=>"getlatestrate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Rate"]}}, "/GetLatestRateSpecial"=>{"get"=>{"summary"=>"Get Latest Rate Special", "description"=>"Returns latest value for a rate.", "operationId"=>"postGetlatestratespecial", "x-api-path-slug"=>"getlatestratespecial-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Rate", "Special"]}}, "/GetLatestRateFamily"=>{"get"=>{"summary"=>"Get Latest Rate Family", "description"=>"Returns latest values for a rate family.", "operationId"=>"postGetlatestratefamily", "x-api-path-slug"=>"getlatestratefamily-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Rate", "Family"]}}, "/GetRealTimeRate"=>{"get"=>{"summary"=>"Get Real Time Rate", "description"=>"Returns the value for a rate as of a specific time in the day.", "operationId"=>"postGetrealtimerate", "x-api-path-slug"=>"getrealtimerate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Time", "Rate"]}}, "/GetRateAsOfTime"=>{"get"=>{"summary"=>"Get Rate As Of Time", "description"=>"Returns the value for a rate as of a specific time in the day.", "operationId"=>"postGetrateasoftime", "x-api-path-slug"=>"getrateasoftime-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Rate", "As", "Time"]}}, "/GetHistoricalRates"=>{"get"=>{"summary"=>"Get Historical Rates", "description"=>"Returns a rate for a range of dates.", "operationId"=>"postGethistoricalrates", "x-api-path-slug"=>"gethistoricalrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Rates"]}}, "/GetHistoricalWeeklyRates"=>{"get"=>{"summary"=>"Get Historical Weekly Rates", "description"=>"Returns a rate for a range of dates.", "operationId"=>"postGethistoricalweeklyrates", "x-api-path-slug"=>"gethistoricalweeklyrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Weekly", "Rates"]}}, "/GetHistoricalRateFamily"=>{"get"=>{"summary"=>"Get Historical Rate Family", "description"=>"Returns a rate family and for a range of dates.", "operationId"=>"postGethistoricalratefamily", "x-api-path-slug"=>"gethistoricalratefamily-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Rate", "Family"]}}, "/GetRateDescription"=>{"get"=>{"summary"=>"Get Rate Description", "description"=>"Returns a description for a rate.", "operationId"=>"postGetratedescription", "x-api-path-slug"=>"getratedescription-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Rate", "Description"]}}, "/GetRateStatistics"=>{"get"=>{"summary"=>"Get Rate Statistics", "description"=>"Returns statistics for available rates.", "operationId"=>"postGetratestatistics", "x-api-path-slug"=>"getratestatistics-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Rate", "Statistics"]}}, "Draw, Rate, , Custom"=>{"get"=>{"summary"=>"Draw Rate Chart Custom", "description"=>"Draw a custom rate chart for a date range.", "operationId"=>"postDrawratechartcustom", "x-api-path-slug"=>"draw-rate--custom-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Draw", "Rate", "Chart", "Custom"]}}, "Draw, Rate, "=>{"get"=>{"summary"=>"Draw Rate Chart", "description"=>"Draw a standard rate chart for a date range.", "operationId"=>"postDrawratechart", "x-api-path-slug"=>"draw-rate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Draw", "Rate", "Chart"]}}, "Draw, Rate, , Preset"=>{"get"=>{"summary"=>"Draw Rate Chart Preset", "description"=>"Draw a standard rate chart for a date range.", "operationId"=>"postDrawratechartpreset", "x-api-path-slug"=>"draw-rate--preset-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Draw", "Rate", "Chart", "Preset"]}}, ", Design"=>{"get"=>{"summary"=>"Get Chart Design", "description"=>"Returns the default design class for the rate Chart.", "operationId"=>"postGetchartdesign", "x-api-path-slug"=>"design-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chart", "Design"]}}, "/DrawYieldCurve"=>{"get"=>{"summary"=>"Draw Yield Curve", "description"=>"Draw a yield curve for a rate family.", "operationId"=>"postDrawyieldcurve", "x-api-path-slug"=>"drawyieldcurve-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Draw", "Yield", "Curve"]}}, "/DrawYieldCurvePreset"=>{"get"=>{"summary"=>"Draw Yield Curve Preset", "description"=>"Draw a yield curve for a rate family.", "operationId"=>"postDrawyieldcurvepreset", "x-api-path-slug"=>"drawyieldcurvepreset-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Draw", "Yield", "Curve", "Preset"]}}, "/DrawYieldCurveCustom"=>{"get"=>{"summary"=>"Draw Yield Curve Custom", "description"=>"Draw a yield curve for a rate family.", "operationId"=>"postDrawyieldcurvecustom", "x-api-path-slug"=>"drawyieldcurvecustom-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Draw", "Yield", "Curve", "Custom"]}}, "/Interpolate"=>{"get"=>{"summary"=>"Interpolate", "description"=>"Interpolate a data series using various methodologies.", "operationId"=>"postInterpolate", "x-api-path-slug"=>"interpolate-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Interpolate"]}}, "/GetFHLBankRates"=>{"get"=>{"summary"=>"Get FHL Bank Rates", "description"=>"Returns Federal Home Loan Bank rates.", "operationId"=>"postGetfhlbankrates", "x-api-path-slug"=>"getfhlbankrates-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "FHL", "Bank", "Rates"]}}, "/GetAuctionResult"=>{"get"=>{"summary"=>"Get Auction Result", "description"=>"Returns an auction result by cusip.", "operationId"=>"postGetauctionresult", "x-api-path-slug"=>"getauctionresult-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Auction", "Result"]}}, "/GetAuctionResults"=>{"get"=>{"summary"=>"Get Auction Results", "description"=>"Returns auction results by date.", "operationId"=>"postGetauctionresults", "x-api-path-slug"=>"getauctionresults-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Auction", "Results"]}}}}, "xignite-releases-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Releases", "description"=>"company-press-release-api-list", "version"=>"v1"}, "host"=>"http://www.xignite.com/", "basePath"=>"xReleases.xml/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"GetHistoricalMarketHeadlines/"=>{"get"=>{"summary"=>"Get Historical Market Headlines", "description"=>"Returns market headlines for a date range.", "operationId"=>"getGethistoricalmarketheadlines", "x-api-path-slug"=>"gethistoricalmarketheadlines-get", "parameters"=>[{"in"=>"query", "name"=>"EndDate", "description"=>"The end date range"}, {"in"=>"query", "name"=>"Source", "description"=>"The source of the news"}, {"in"=>"query", "name"=>"StartDate", "description"=>"The start date range"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Market", "Headlines"]}}, "GetHistoricalSecurityHeadlines/"=>{"get"=>{"summary"=>"Get Historical Security Headlines", "description"=>"Returns headlines for a company and a date range.", "operationId"=>"getGethistoricalsecurityheadlines", "x-api-path-slug"=>"gethistoricalsecurityheadlines-get", "parameters"=>[{"in"=>"query", "name"=>"EndDate", "description"=>"EndDate"}, {"in"=>"query", "name"=>"Identifier", "description"=>"The ticker symbol for company"}, {"in"=>"query", "name"=>"IdentifierType", "description"=>"The identifier to use"}, {"in"=>"query", "name"=>"Source", "description"=>"The source of the news"}, {"in"=>"query", "name"=>"StartDate", "description"=>"The start date range"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Security", "Headlines"]}}, "GetLastMarketHeadlines/"=>{"get"=>{"summary"=>"Get Last Market Headlines", "description"=>"Returns market headlines published since a specific date and time.", "operationId"=>"getGetlastmarketheadlines", "x-api-path-slug"=>"getlastmarketheadlines-get", "parameters"=>[{"in"=>"query", "name"=>"SinceDate", "description"=>"The beginning of data range"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Last", "Market", "Headlines"]}}, "GetLastSecurityHeadlines/"=>{"get"=>{"summary"=>"Get Last Security Headlines", "description"=>"Returns headlines for a company published since a specific date and time.", "operationId"=>"getGetlastsecurityheadlines", "x-api-path-slug"=>"getlastsecurityheadlines-get", "parameters"=>[{"in"=>"query", "name"=>"Identifier", "description"=>"The ticker symbol for company"}, {"in"=>"query", "name"=>"IdentifierType", "description"=>"The identifier to use"}, {"in"=>"query", "name"=>"SinceDate", "description"=>"The start date range"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Last", "Security", "Headlines"]}}, "GetReleaseContent/"=>{"get"=>{"summary"=>"Get Release Content", "description"=>"Return detailed information about a release as well as its content.", "operationId"=>"getGetreleasecontent", "x-api-path-slug"=>"getreleasecontent-get", "parameters"=>[{"in"=>"query", "name"=>"ReleaseID", "description"=>"The press release ID>"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Release", "Content"]}}, "GetTodaysSecurityHeadlines"=>{"get"=>{"summary"=>"Get Todays Security Headlines", "description"=>"Returns headlines for a company published today.", "operationId"=>"getGettodayssecurityheadlines", "x-api-path-slug"=>"gettodayssecurityheadlines-get", "parameters"=>[{"in"=>"query", "name"=>"Identifier", "description"=>"The ticker symbol for company"}, {"in"=>"query", "name"=>"IdentifierType", "description"=>"The identifier to use"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Todays", "Security", "Headlines"]}}, "GetTopMarketHeadlines/"=>{"get"=>{"summary"=>"Get Top Market Headlines", "description"=>"Returns a given number of market headlines published most recently.", "operationId"=>"getGettopmarketheadlines", "x-api-path-slug"=>"gettopmarketheadlines-get", "parameters"=>[{"in"=>"query", "name"=>"Count", "description"=>"The number of news items to return"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Market", "Headlines"]}}, "GetTopSecurityHeadlines/"=>{"get"=>{"summary"=>"Get Top Security Headlines", "description"=>"Returns a given number of company headlines published most recently.", "operationId"=>"getGettopsecurityheadlines", "x-api-path-slug"=>"gettopsecurityheadlines-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Security", "Headlines"]}}, "SearchMarketHeadlines/"=>{"get"=>{"summary"=>"Search Market Headlines", "description"=>"Search market headlines across all companies based on date, source, and title.", "operationId"=>"getSearchmarketheadlines", "x-api-path-slug"=>"searchmarketheadlines-get", "parameters"=>[{"in"=>"query", "name"=>"EndDate", "description"=>"The end date range"}, {"in"=>"query", "name"=>"Source", "description"=>"The source of the news"}, {"in"=>"query", "name"=>"StartDate", "description"=>"The start date range"}, {"in"=>"query", "name"=>"Title", "description"=>"Title of the headlines"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Search", "Market", "Headlines"]}}, "SearchSecurityHeadlines/"=>{"get"=>{"summary"=>"Search Security Headlines", "description"=>"Search headlines for a company across all companies based on date, source, and title.", "operationId"=>"getSearchsecurityheadlines", "x-api-path-slug"=>"searchsecurityheadlines-get", "parameters"=>[{"in"=>"query", "name"=>"EndDate", "description"=>"The end date range"}, {"in"=>"query", "name"=>"Identifier", "description"=>"The ticker symbol for company"}, {"in"=>"query", "name"=>"IdentifierType", "description"=>"The identifier to use"}, {"in"=>"query", "name"=>"Source", "description"=>"The source of the news"}, {"in"=>"query", "name"=>"StartDate", "description"=>"The start date range"}, {"in"=>"query", "name"=>"Title", "description"=>"The title of the article"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Search", "Security", "Headlines"]}}}}, "xignite-global-news-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Global News", "description"=>"financial-news-apis-", "version"=>"1.0.0"}, "host"=>"globalnews.xignite.com", "basePath"=>"xGlobalNews.xml/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetTopReleasesBySecurity"=>{"get"=>{"summary"=>"Get Top Releases By Security", "description"=>"Return the top press releases for a security.", "operationId"=>"GetTopReleasesBySecurity", "x-api-path-slug"=>"gettopreleasesbysecurity-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Releases", "Security"]}}, "/GetHistoricalReleasesBySecurity"=>{"get"=>{"summary"=>"Get Historical Releases By Security", "description"=>"Return press releases headlines for a security and a date range.", "operationId"=>"GetHistoricalReleasesBySecurity", "x-api-path-slug"=>"gethistoricalreleasesbysecurity-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Releases", "Security"]}}, "/GetMarketNewsDetails"=>{"get"=>{"summary"=>"Get Market News Details", "description"=>"Returns the summary content for a specified headline.", "operationId"=>"GetMarketNewsDetails", "x-api-path-slug"=>"getmarketnewsdetails-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Market", "News", "Details"]}}, "/GetTodaysMarketHeadlines"=>{"get"=>{"summary"=>"Get Todays Market Headlines", "description"=>"Returns all market headlines that were published today.", "operationId"=>"GetTodaysMarketHeadlines", "x-api-path-slug"=>"gettodaysmarketheadlines-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Todays", "Market", "Headlines"]}}, "/GetTopSecurityHeadlines"=>{"get"=>{"summary"=>"Get Top Security Headlines", "description"=>"Returns the most recent specified number of headlines for a given security.", "operationId"=>"GetTopSecurityHeadlines", "x-api-path-slug"=>"gettopsecurityheadlines-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Security", "Headlines"]}}, "/GetTopMarketHeadlines"=>{"get"=>{"summary"=>"Get Top Market Headlines", "description"=>"Returns the most recent specified number of market headlines.", "operationId"=>"GetTopMarketHeadlines", "x-api-path-slug"=>"gettopmarketheadlines-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Market", "Headlines"]}}, "/GetTodaysReleasesBySecurity"=>{"get"=>{"summary"=>"Get Todays Releases By Security", "description"=>"Return press releases for a security for today.", "operationId"=>"GetTodaysReleasesBySecurity", "x-api-path-slug"=>"gettodaysreleasesbysecurity-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Todays", "Releases", "Security"]}}, "/GetHistoricalSecurityHeadlines"=>{"get"=>{"summary"=>"Get Historical Security Headlines", "description"=>"Returns all headlines that were published in a specified time frame for a given security.", "operationId"=>"GetHistoricalSecurityHeadlines", "x-api-path-slug"=>"gethistoricalsecurityheadlines-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Security", "Headlines"]}}, "/GetTopMarketHeadlinesBySector"=>{"get"=>{"summary"=>"Get Top Market Headlines By Sector", "description"=>"Returns the most recent specified number of market headlines associated with a specified sector.", "operationId"=>"GetTopMarketHeadlinesBySector", "x-api-path-slug"=>"gettopmarketheadlinesbysector-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Market", "Headlines", "Sector"]}}, "/GetTodaysMarketReleases"=>{"get"=>{"summary"=>"Get Todays Market Releases", "description"=>"Return press releases for today.", "operationId"=>"GetTodaysMarketReleases", "x-api-path-slug"=>"gettodaysmarketreleases-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Todays", "Market", "Releases"]}}, "/GetTodaysMarketHeadlinesBySector"=>{"get"=>{"summary"=>"Get Todays Market Headlines By Sector", "description"=>"Returns all market headlines that were published today for a specified sector.", "operationId"=>"GetTodaysMarketHeadlinesBySector", "x-api-path-slug"=>"gettodaysmarketheadlinesbysector-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Todays", "Market", "Headlines", "Sector"]}}, "/GetTodaysSecurityHeadlines"=>{"get"=>{"summary"=>"Get Todays Security Headlines", "description"=>"Returns all headlines that were published today for a given security.", "operationId"=>"GetTodaysSecurityHeadlines", "x-api-path-slug"=>"gettodayssecurityheadlines-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Todays", "Security", "Headlines"]}}, "/GetRecentTopSecurityHeadlines"=>{"get"=>{"summary"=>"Get Recent Top Security Headlines", "description"=>"Returns 14 days specified number of headlines for a given security.", "operationId"=>"GetRecentTopSecurityHeadlines", "x-api-path-slug"=>"getrecenttopsecurityheadlines-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Recent", "Top", "Security", "Headlines"]}}, "/GetHistoricalMarketHeadlines"=>{"get"=>{"summary"=>"Get Historical Market Headlines", "description"=>"Returns all market headlines that were published in a specified time frame.", "operationId"=>"GetHistoricalMarketHeadlines", "x-api-path-slug"=>"gethistoricalmarketheadlines-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Market", "Headlines"]}}, "/GetHistoricalMarketHeadlinesBySector"=>{"get"=>{"summary"=>"Get Historical Market Headlines By Sector", "description"=>"Returns all market headlines that were published in a specified time frame for a specified sector.", "operationId"=>"GetHistoricalMarketHeadlinesBySector", "x-api-path-slug"=>"gethistoricalmarketheadlinesbysector-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Market", "Headlines", "Sector"]}}, "/ListSectors"=>{"get"=>{"summary"=>"List Sectors", "description"=>"Provides a list of all available values for a given sector.", "operationId"=>"ListSectors", "x-api-path-slug"=>"listsectors-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Sectors"]}}, "/GetTopSecuritySummaries"=>{"get"=>{"summary"=>"Get Top Security Summaries", "description"=>"Returns all headline summaries that were published today for a given security.", "operationId"=>"GetTopSecuritySummaries", "x-api-path-slug"=>"gettopsecuritysummaries-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Security", "Summaries"]}}, "/GetTopReleaseSummariesBySecurity"=>{"get"=>{"summary"=>"Get Top Release Summaries By Security", "description"=>"Return the top press releases summaries for a security.", "operationId"=>"GetTopReleaseSummariesBySecurity", "x-api-path-slug"=>"gettopreleasesummariesbysecurity-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Release", "Summaries", "Security"]}}, "/GetTopMarketSummaries"=>{"get"=>{"summary"=>"Get Top Market Summaries", "description"=>"Return the top market summaries.", "operationId"=>"GetTopMarketSummaries", "x-api-path-slug"=>"gettopmarketsummaries-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Market", "Summaries"]}}, "/ListExchanges"=>{"get"=>{"summary"=>"List Exchanges", "description"=>"List supported exchanges.", "operationId"=>"ListExchanges", "x-api-path-slug"=>"listexchanges-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Exchanges"]}}, "/ListSymbols"=>{"get"=>{"summary"=>"List Symbols", "description"=>"This operation returns symbols in this exchange.", "operationId"=>"ListSymbols", "x-api-path-slug"=>"listsymbols-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Symbols"]}}, "GetHistoricalMarketHeadlines/"=>{"get"=>{"summary"=>"Historical Market Headlines", "description"=>"Returns all market headlines that were published in a specified time frame.", "operationId"=>"", "x-api-path-slug"=>"gethistoricalmarketheadlines-get", "parameters"=>[{"in"=>"query", "name"=>"EndDate", "description"=>"The end date range"}, {"in"=>"query", "name"=>"startDate", "description"=>"The start date range"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", ""]}}, "GetHistoricalMarketHeadlinesBySector/"=>{"get"=>{"summary"=>"Historical Market Headlines By Sector", "description"=>"Returns all market headlines that were published in a specified time frame for a specified sector.", "operationId"=>"", "x-api-path-slug"=>"gethistoricalmarketheadlinesbysector-get", "parameters"=>[{"in"=>"query", "name"=>"EndDate", "description"=>"The end date range"}, {"in"=>"query", "name"=>"Sector", "description"=>"The business sector to search within"}, {"in"=>"query", "name"=>"StartDate", "description"=>"The start date range"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", ""]}}, "GetHistoricalReleasesBySecurity/"=>{"get"=>{"summary"=>"Historical Releases By Security", "description"=>"Returns all press releases that were published in a specified time frame for a given security.", "operationId"=>"", "x-api-path-slug"=>"gethistoricalreleasesbysecurity-get", "parameters"=>[{"in"=>"query", "name"=>"EndDate", "description"=>"The end date range"}, {"in"=>"query", "name"=>"Identifier", "description"=>"The ticker symbol for company"}, {"in"=>"query", "name"=>"IdentifierType", "description"=>"The identifier to use"}, {"in"=>"query", "name"=>"StartDate", "description"=>"The start date range"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", ""]}}, "GetHistoricalSecurityHeadlines/"=>{"get"=>{"summary"=>"Historical Security Headlines", "description"=>"Returns all headlines that were published in a specified time frame for a given security.", "operationId"=>"", "x-api-path-slug"=>"gethistoricalsecurityheadlines-get", "parameters"=>[{"in"=>"query", "name"=>"EndDate", "description"=>"The end date range"}, {"in"=>"query", "name"=>"Identifier", "description"=>"The ticker symbol for company"}, {"in"=>"query", "name"=>"IdentifierType", "description"=>"The symbol to use"}, {"in"=>"query", "name"=>"StartDate", "description"=>"The start date range"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", ""]}}, "GetMarketNewsDetails/"=>{"get"=>{"summary"=>"Market News Details", "description"=>"Returns the summary content for a specified headline.", "operationId"=>"", "x-api-path-slug"=>"getmarketnewsdetails-get", "parameters"=>[{"in"=>"query", "name"=>"Reference", "description"=>"The URL of the news article"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", ""]}}, "GetTodaysMarketHeadlines/"=>{"get"=>{"summary"=>"Todays Market Headlines", "description"=>"Returns all market headlines that were published today.", "operationId"=>"", "x-api-path-slug"=>"gettodaysmarketheadlines-get", "parameters"=>[{"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", ""]}}, "GetTodaysMarketHeadlinesBySector/"=>{"get"=>{"summary"=>"Todays Market Headlines By Sector", "description"=>"Returns all market headlines that were published today for a specified sector.", "operationId"=>"", "x-api-path-slug"=>"gettodaysmarketheadlinesbysector-get", "parameters"=>[{"in"=>"query", "name"=>"Sector", "description"=>"The business sector to search within"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", ""]}}, "GetTodaysReleasesBySecurity/"=>{"get"=>{"summary"=>"Todays Releases By Security", "description"=>"Returns all press releases that were published today for a given security.", "operationId"=>"", "x-api-path-slug"=>"gettodaysreleasesbysecurity-get", "parameters"=>[{"in"=>"query", "name"=>"Identifier", "description"=>"The ticker symbol for company"}, {"in"=>"query", "name"=>"IdentifierType", "description"=>"The symbol to use"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", ""]}}, "GetTodaysSecurityHeadlines/"=>{"get"=>{"summary"=>"Todays Security Headlines", "description"=>"Returns all headlines that were published today for a given security.", "operationId"=>"", "x-api-path-slug"=>"gettodayssecurityheadlines-get", "parameters"=>[{"in"=>"query", "name"=>"Identifier", "description"=>"The ticker symbol for company"}, {"in"=>"query", "name"=>"IdentifierType", "description"=>"The ticker symbol for company"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", ""]}}, "GetTopMarketHeadlines/"=>{"get"=>{"summary"=>"Get Top Market Headlines", "description"=>"Returns the most recent specified number of market headlines.", "operationId"=>"", "x-api-path-slug"=>"gettopmarketheadlines-get", "parameters"=>[{"in"=>"query", "name"=>"Count", "description"=>"Number of headlines to return"}, {"in"=>"query", "name"=>"_Token", "description"=>"API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", ""]}}, "GetTopMarketHeadlinesBySector/"=>{"get"=>{"summary"=>"Top Market Headlines By Sector", "description"=>"Returns the most recent specified number of market headlines associated with a specified sector.", "operationId"=>"", "x-api-path-slug"=>"gettopmarketheadlinesbysector-get", "parameters"=>[{"in"=>"query", "name"=>"Count", "description"=>"The number of news items to return"}, {"in"=>"query", "name"=>"Sector", "description"=>"The business sector to search within"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", ""]}}, "GetTopReleasesBySecurity"=>{"get"=>{"summary"=>"Top Releases By Security", "description"=>"Returns the most recent specified number of press releases for a given security.", "operationId"=>"", "x-api-path-slug"=>"gettopreleasesbysecurity-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"Number of items to return"}, {"in"=>"query", "name"=>"Identifier", "description"=>"The ticker symbol for company"}, {"in"=>"query", "name"=>"IdentifierType", "description"=>"The identifier to use"}, {"in"=>"query", "name"=>"_Token", "description"=>"The API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", ""]}}, "GetTopSecurityHeadlines/"=>{"get"=>{"summary"=>"Get Top Security Headlines", "description"=>"Returns the most recent specified number of headlines for a given security.", "operationId"=>"", "x-api-path-slug"=>"gettopsecurityheadlines-get", "parameters"=>[{"in"=>"query", "name"=>"Count", "description"=>"The number of news items to return"}, {"in"=>"query", "name"=>"Identifier", "description"=>"The ticker symbol for company"}, {"in"=>"query", "name"=>"IdentifierType", "description"=>"The ticker symbol for company"}, {"in"=>"query", "name"=>"_Token", "description"=>"API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", ""]}}, "ListSectors/"=>{"get"=>{"summary"=>"List Sectors", "description"=>"Provides a list of all available values for a given sector.", "operationId"=>"", "x-api-path-slug"=>"listsectors-get", "parameters"=>[{"in"=>"query", "name"=>"_Token", "description"=>"API Key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", ""]}}}}, "apis"=>{"name"=>"Xignite", "x-slug"=>"xignite", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "x-kinRank"=>"9", "x-alexaRank"=>"383974", "tags"=>"Articles,Bond Markets,Business,Business,Charts,Currencies,Economic,Energy,Enterprise,Finance,Finance,Financial,Financial News API,Financial Services,General Data,Getting Started Example,Government,JavaScript,Jobs,Logos,Market Data,Markets,Markets,Pedestal,Publish", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"xignite/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Xignite BATS Real Time", "x-api-slug"=>"xignite-bats-real-time", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://batsrealtime.xignite.com/xBATSRealTime.json/XigniteBATSRealTime", "tags"=>"Articles,Bond Markets,Business,Business,Charts,Currencies,Economic,Energy,Enterprise,Finance,Finance,Financial,Financial News API,Financial Services,General Data,Getting Started Example,Government,JavaScript,Jobs,Logos,Market Data,Markets,Markets,Pedestal,Publish", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-bats-real-time-openapi.yaml"}]}, {"name"=>"Xignite Bonds", "x-api-slug"=>"xignite-bonds", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://bonds.xignite.com/xBonds.json/XigniteBonds", "tags"=>"Market Data,Chart, Bars", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-bonds-openapi.yaml"}]}, {"name"=>"Xignite Calendar", "x-api-slug"=>"xignite-calendar", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://www.xignite.com/xCalendar.json/XigniteCalendar", "tags"=>"Market Data,List, Symbols", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-calendar-openapi.yaml"}]}, {"name"=>"Xignite Currencies", "x-api-slug"=>"xignite-currencies", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://www.xignite.com/xCurrencies.json//XigniteCurrencies", "tags"=>"Market Data,Service, Demonstration", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-currencies-openapi.yaml"}]}, {"name"=>"Xignite Fact Set Estimates", "x-api-slug"=>"xignite-fact-set-estimates", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://factsetestimates.xignite.com/xFactSetEstimates.json/XigniteFactSetEstimates", "tags"=>"Market Data,Intraday, High, Low", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-fact-set-estimates-openapi.yaml"}]}, {"name"=>"Xignite Futures", "x-api-slug"=>"xignite-futures", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://www.xignite.com/xFutures.json/XigniteFutures", "tags"=>"Market Data,Recommendation, Summaries", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-futures-openapi.yaml"}]}, {"name"=>"Xignite Global Currencies File", "x-api-slug"=>"xignite-global-currencies-file", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://cloudfiles.xignite.com/xGlobalCurrenciesFile.json/XigniteGlobalCurrenciesFile", "tags"=>"Market Data,Future, Options, By, Strike, Price", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-global-currencies-file-openapi.yaml"}]}, {"name"=>"Xignite Global Futures", "x-api-slug"=>"xignite-global-futures", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://globalfutures.xignite.com/xGlobalFutures.json/XigniteGlobalFutures", "tags"=>"Market Data,Files", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-global-futures-openapi.yaml"}]}, {"name"=>"Xignite Global Historical", "x-api-slug"=>"xignite-global-historical", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://www.xignite.com/xGlobalHistorical.json/XigniteGlobalHistorical", "tags"=>"Historical, Future, Quotes, Range", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-global-historical-openapi.yaml"}]}, {"name"=>"Xignite Global Holidays", "x-api-slug"=>"xignite-global-holidays", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://globalholidays.xignite.com/xGlobalHolidays.json/XigniteGlobalHolidays", "tags"=>"Market Data,List, Exchanges", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-global-holidays-openapi.yaml"}]}, {"name"=>"Xignite Global Indices", "x-api-slug"=>"xignite-global-indices", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://globalindices.xignite.com/xglobalindices.json/XigniteGlobalIndices", "tags"=>"Settlement, Date", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-global-indices-openapi.yaml"}]}, {"name"=>"Xignite Global Indices Historical", "x-api-slug"=>"xignite-global-indices-historical", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://globalindiceshistorical.xignite.com/xglobalindiceshistorical.json/XigniteGlobalIndicesHistorical", "tags"=>"Market Data,Search, Indices, Name", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-global-indices-historical-openapi.yaml"}]}, {"name"=>"Xignite Global Indices Real Time", "x-api-slug"=>"xignite-global-indices-real-time", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://globalindicesrealtime.xignite.com/xglobalindicesrealtime.json/XigniteGlobalIndicesRealTime", "tags"=>"Market Data,Index, Bars", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-global-indices-real-time-openapi.yaml"}]}, {"name"=>"Xignite Global Master", "x-api-slug"=>"xignite-global-master", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://globalmaster.xignite.com/xglobalmaster.json/XigniteGlobalMaster", "tags"=>"Market Data,Search, Indices, Name", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-global-master-openapi.yaml"}]}, {"name"=>"Xignite Global Metals", "x-api-slug"=>"xignite-global-metals", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://globalmetals.xignite.com/xGlobalMetals.json/XigniteGlobalMetals", "tags"=>"Master, Statistics, Exchange", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-global-metals-openapi.yaml"}]}, {"name"=>"Xignite Global News", "x-api-slug"=>"xignite-global-news", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://globalnews.xignite.com/xGlobalNews.xml/", "tags"=>"Market Data,Base, Metal, Price", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-global-news-openapi.yaml"}]}, {"name"=>"Xignite Global Option Master", "x-api-slug"=>"xignite-global-option-master", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://globaloptionmaster.xignite.com/xGlobalOptionMaster.json/XigniteGlobalOptionMaster", "tags"=>"Market Data,", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-global-option-master-openapi.yaml"}]}, {"name"=>"Xignite Global Options", "x-api-slug"=>"xignite-global-options", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://globaloptions.xignite.com/xglobaloptions.json/XigniteGlobalOptions", "tags"=>"Market Data,List, Exchanges", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-global-options-openapi.yaml"}]}, {"name"=>"Xignite Global Options File", "x-api-slug"=>"xignite-global-options-file", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://cloudfiles.xignite.com/xGlobalOptionsFile.json/XigniteGlobalOptionsFile", "tags"=>"Chart, Bars", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-global-options-file-openapi.yaml"}]}, {"name"=>"Xignite Global Real Time Futures", "x-api-slug"=>"xignite-global-real-time-futures", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://globalrealtimefutures.xignite.com/xGlobalRealTimeFutures.json/XigniteGlobalRealTimeFutures", "tags"=>"Files", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-global-real-time-futures-openapi.yaml"}]}, {"name"=>"Xignite Global Real Time Options", "x-api-slug"=>"xignite-global-real-time-options", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://globalrealtimeoptions.xignite.com/xglobalrealtimeoptions.json/XigniteGlobalRealTimeOptions", "tags"=>"Market Data,Search, Futures", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-global-real-time-options-openapi.yaml"}]}, {"name"=>"Xignite Historical", "x-api-slug"=>"xignite-historical", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://www.xignite.com/xHistorical.json/XigniteHistorical", "tags"=>"Chart, Bars", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-historical-openapi.yaml"}]}, {"name"=>"Xignite Interbanks", "x-api-slug"=>"xignite-interbanks", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://www.xignite.com/xInterBanks.json/XigniteInterBanks", "tags"=>"Market Data,Historical, Statistics", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-interbanks-openapi.yaml"}]}, {"name"=>"Xignite IPOs", "x-api-slug"=>"xignite-ipos", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://ipos.xignite.com/xIPOs.json/XigniteIPOs", "tags"=>"Market Data,Draw, Yield, Curve, Custom", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-ipos-openapi.yaml"}]}, {"name"=>"Xignite Logos", "x-api-slug"=>"xignite-logos", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://www.xignite.com/xLogos.json/XigniteLogos", "tags"=>"Market Data,IPO, Performance", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-logos-openapi.yaml"}]}, {"name"=>"Xignite Money Markets", "x-api-slug"=>"xignite-money-markets", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://www.xignite.com/xMoneyMarkets.json/XigniteMoneyMarkets", "tags"=>"List, Symbols", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-money-markets-openapi.yaml"}]}, {"name"=>"Xignite Municipal Bond Master", "x-api-slug"=>"xignite-municipal-bond-master", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://municipalbondmaster.xignite.com/xmunicipalbondmaster.json/XigniteMunicipalBondMaster", "tags"=>"Market Data,Treasury, Rate, Family", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-municipal-bond-master-openapi.yaml"}]}, {"name"=>"Xignite NASDAQ Last Sale", "x-api-slug"=>"xignite-nasdaq-last-sale", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://nasdaqlastsale.xignite.com/xNASDAQLastSale.json/XigniteNASDAQLastSale", "tags"=>"Bond", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-nasdaq-last-sale-openapi.yaml"}]}, {"name"=>"Xignite NAVs", "x-api-slug"=>"xignite-navs", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://navs.xignite.com/v2/xNAVs.json/XigniteNAVs", "tags"=>"Extended, Quotes", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-navs-openapi.yaml"}]}, {"name"=>"Xignite Rates", "x-api-slug"=>"xignite-rates", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://www.xignite.com/xRates.json/XigniteRates", "tags"=>"List, Funds, Symbol", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-rates-openapi.yaml"}]}, {"name"=>"Xignite Releases", "x-api-slug"=>"xignite-releases", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://http://www.xignite.com//xReleases.xml/", "tags"=>"Market Data,Auction, Results", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/xignite/searchsecurityheadlines-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-releases-openapi.yaml"}]}, {"name"=>"Xignite Statistics", "x-api-slug"=>"xignite-statistics", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://www.xignite.com/xStatistics.json/XigniteStatistics", "tags"=>"Market Data,Search,Security,Headlines", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-statistics-openapi.yaml"}]}, {"name"=>"Xignite Super Quotes", "x-api-slug"=>"xignite-super-quotes", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://superquotes.xignite.com/xSuperQuotes.json/XigniteSuperQuotes", "tags"=>"Market Data,Chart, Design", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-super-quotes-openapi.yaml"}]}, {"name"=>"Xignite VWAP", "x-api-slug"=>"xignite-vwap", "description"=>"Financial market data on-demand. Xignite financial Web services help build smarter websites and applications in minutes with zero up-front investment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/xignite-logo.png", "humanURL"=>"http://www.xignite.com", "baseURL"=>"https://www.xignite.com/xVWAP.json/XigniteVWAP", "tags"=>"Market Data,Chart, Bars", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/xignite/xignite-vwap-openapi.yaml"}]}], "x-common"=>[{"type"=>"x--net-sdk", "url"=>"http://xignite.github.io/DotNetSDK/"}, {"type"=>"x-base", "url"=>"http://globalmaster.xignite.com"}, {"type"=>"x-case-studies", "url"=>"https://resources.xignite.com/case-studies"}, {"type"=>"x-case-studies", "url"=>"http://www.xignite.com/market-data/resources/case-studies/"}, {"type"=>"x-blog", "url"=>"https://resources.xignite.com/xignite-blog"}, {"type"=>"x-contact-form", "url"=>"http://www.xignite.com/market-data/contact-us"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/xignite"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/xignite"}, {"type"=>"x-developer", "url"=>"http://www.xignite.com/developers"}, {"type"=>"x-email", "url"=>"support@xignite.com"}, {"type"=>"x-email", "url"=>"accounting@xignite.com"}, {"type"=>"x-email", "url"=>"sales@xignite.com"}, {"type"=>"x-email", "url"=>"marketing@xignite.com"}, {"type"=>"x-email", "url"=>"info@xignite.com"}, {"type"=>"x-email", "url"=>"jobs@xignite.com"}, {"type"=>"x-email", "url"=>"klangstaff@xignite.com"}, {"type"=>"x-faq", "url"=>"http://www.xignite.com/Support/FAQs.aspx"}, {"type"=>"x-getting-started", "url"=>"http://www.xignite.com/Support/GettingStarted.aspx"}, {"type"=>"x-github", "url"=>"https://github.com/Xignite"}, {"type"=>"x-java-sdk", "url"=>"http://xignite.github.io/JavaSDK/"}, {"type"=>"x-privacy", "url"=>"http://www.xignite.com/Documents/PrivacyPolicy.aspx"}, {"type"=>"x-support", "url"=>"http://www.xignite.com/Support/SupportPlans.aspx"}, {"type"=>"x-blog", "url"=>"http://www.xignite.com/market-data/blog/tech/"}, {"type"=>"x-blog-rss", "url"=>"http://www.xignite.com/market-data/feed/"}, {"type"=>"x-terms-of-service", "url"=>"http://www.xignite.com/Policies/SiteUseTerms.aspx"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/xignite"}, {"type"=>"x-videos", "url"=>"http://www.xignite.com/market-data/resources/videos/"}, {"type"=>"x-webinar", "url"=>"http://www.xignite.com/market-data/resources/webinars/"}, {"type"=>"x-webinars", "url"=>"https://resources.xignite.com/webinars"}, {"type"=>"x-website", "url"=>"http://www.xignite.com"}, {"type"=>"x-website", "url"=>"http://xignite.com"}, {"type"=>"x-website", "url"=>"http://xignite.com/"}, {"type"=>"x-white-papers", "url"=>"http://www.xignite.com/market-data/resources/white-papers/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "xignite-global-metals-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Global Metals", "description"=>"provide-realtime-currency-foreign-exchange-information-and-calculations-", "version"=>"1.0.0"}, "host"=>"globalmetals.xignite.com", "basePath"=>"xGlobalMetals.json/XigniteGlobalMetals", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetRealTimeMetalQuotes"=>{"get"=>{"summary"=>"Get Real Time Metal Quotes", "description"=>"Get real time exchange rate.", "operationId"=>"GetRealTimeMetalQuotes", "x-api-path-slug"=>"getrealtimemetalquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Time", "Metal", "Quotes"]}}, "/GetHistoricalMetalQuotes"=>{"get"=>{"summary"=>"Get Historical Metal Quotes", "description"=>"Get cross sectional historical metal quotes at a given time.", "operationId"=>"GetHistoricalMetalQuotes", "x-api-path-slug"=>"gethistoricalmetalquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Metal", "Quotes"]}}, "/GetRealTimeMetalQuote"=>{"get"=>{"summary"=>"Get Real Time Metal Quote", "description"=>"Get real time metal quote.", "operationId"=>"GetRealTimeMetalQuote", "x-api-path-slug"=>"getrealtimemetalquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Time", "Metal", "Quote"]}}, ", Bars"=>{"get"=>{"summary"=>"Get Chart Bars", "description"=>"Get intraday bars of specified intervals within a time range.", "operationId"=>"GetChartBars", "x-api-path-slug"=>"bars-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chart", "Bars"]}}, "/ListMetals"=>{"get"=>{"summary"=>"List Metals", "description"=>"List all Metals.", "operationId"=>"ListMetals", "x-api-path-slug"=>"listmetals-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Metals"]}}, "/GetRealTimeExtendedMetalQuote"=>{"get"=>{"summary"=>"Get Real Time Extended Metal Quote", "description"=>"Get real time extended metal quote.", "operationId"=>"GetRealTimeExtendedMetalQuote", "x-api-path-slug"=>"getrealtimeextendedmetalquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Real", "Time", "Extended", "Metal", "Quote"]}}, "/GetHistoricalMetalQuote"=>{"get"=>{"summary"=>"Get Historical Metal Quote", "description"=>"Get historical metal quote at a given time.", "operationId"=>"GetHistoricalMetalQuote", "x-api-path-slug"=>"gethistoricalmetalquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Metal", "Quote"]}}, "/GetLatestHistoricalMetalQuote"=>{"get"=>{"summary"=>"Get Latest Historical Metal Quote", "description"=>"Get historical metal quote by a given time.", "operationId"=>"GetLatestHistoricalMetalQuote", "x-api-path-slug"=>"getlatesthistoricalmetalquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Historical", "Metal", "Quote"]}}, "/GetLatestHistoricalMetalQuotes"=>{"get"=>{"summary"=>"Get Latest Historical Metal Quotes", "description"=>"Get cross sectional historical metal quotes by a given time.", "operationId"=>"GetLatestHistoricalMetalQuotes", "x-api-path-slug"=>"getlatesthistoricalmetalquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Latest", "Historical", "Metal", "Quotes"]}}, "/GetHistoricalMetalQuotesRange"=>{"get"=>{"summary"=>"Get Historical Metal Quotes Range", "description"=>"Get historical metal quotes time series.", "operationId"=>"GetHistoricalMetalQuotesRange", "x-api-path-slug"=>"gethistoricalmetalquotesrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Metal", "Quotes", "Range"]}}, "/GetLondonHistoricalMetalQuotesRange"=>{"get"=>{"summary"=>"Get London Historical Metal Quotes Range", "description"=>"Get historical metal quotes based on Legacy London spot prices.", "operationId"=>"GetLondonHistoricalMetalQuotesRange", "x-api-path-slug"=>"getlondonhistoricalmetalquotesrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "London", "Historical", "Metal", "Quotes", "Range"]}}, "/GetTick"=>{"get"=>{"summary"=>"Get Tick", "description"=>"Get intraday tick at given time.", "operationId"=>"GetTick", "x-api-path-slug"=>"gettick-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Tick"]}}, "/GetTicks"=>{"get"=>{"summary"=>"Get Ticks", "description"=>"Get intraday ticks of specified intervals within a time range.", "operationId"=>"GetTicks", "x-api-path-slug"=>"getticks-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Ticks"]}}, "/GetBar"=>{"get"=>{"summary"=>"Get Bar", "description"=>"Get intraday bar at given time.", "operationId"=>"GetBar", "x-api-path-slug"=>"getbar-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Bar"]}}, "/GetBars"=>{"get"=>{"summary"=>"Get Bars", "description"=>"Get intraday bars of specified intervals within a time range.", "operationId"=>"GetBars", "x-api-path-slug"=>"getbars-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Bars"]}}, "/GetLondonFixing"=>{"get"=>{"summary"=>"Get London Fixing", "description"=>"Get last london fixing metal quotes.", "operationId"=>"GetLondonFixing", "x-api-path-slug"=>"getlondonfixing-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "London", "Fixing"]}}, "/GetHistoricalLondonFixingRange"=>{"get"=>{"summary"=>"Get Historical London Fixing Range", "description"=>"Get historical london fixing metal quotes time series.", "operationId"=>"GetHistoricalLondonFixingRange", "x-api-path-slug"=>"gethistoricallondonfixingrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "London", "Fixing", "Range"]}}, "/GetTopIndustryHeadlines"=>{"get"=>{"summary"=>"Get Top Industry Headlines", "description"=>"Get top industry headlines.", "operationId"=>"GetTopIndustryHeadlines", "x-api-path-slug"=>"gettopindustryheadlines-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Top", "Industry", "Headlines"]}}, "/GetBaseMetalPrice"=>{"get"=>{"summary"=>"Get Base Metal Price", "description"=>"Get base metal price.", "operationId"=>"GetBaseMetalPrice", "x-api-path-slug"=>"getbasemetalprice-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Base", "Metal", "Price"]}}}}, "xignite-global-futures-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Global Futures", "description"=>"this-web-service-provides-global-delayed-stock-quotes-and-for-u-s--and-international-equities-", "version"=>"1.0.0"}, "host"=>"globalfutures.xignite.com", "basePath"=>"xGlobalFutures.json/XigniteGlobalFutures", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetFrontMonthFuture"=>{"get"=>{"summary"=>"Get Front Month Future", "description"=>"Returns master data on the front month future contract", "operationId"=>"GetFrontMonthFuture", "x-api-path-slug"=>"getfrontmonthfuture-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Front", "Month", "Future"]}}, "/GetFutureQuote"=>{"get"=>{"summary"=>"Get Future Quote", "description"=>"Returns a delayed quote for a future contract.", "operationId"=>"GetFutureQuote", "x-api-path-slug"=>"getfuturequote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Future", "Quote"]}}, "/GetLatestFutureQuote"=>{"get"=>{"summary"=>"Get Latest Future Quote", "description"=>"Returns the latest delayed quote for a future contract.", "operationId"=>"GetLatestFutureQuote", "x-api-path-slug"=>"getlatestfuturequote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Latest", "Future", "Quote"]}}, "/GetFutureQuotes"=>{"get"=>{"summary"=>"Get Future Quotes", "description"=>"Returns delayed quotes for multiple future contracts.", "operationId"=>"GetFutureQuotes", "x-api-path-slug"=>"getfuturequotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Future", "Quotes"]}}, "/GetLatestFutureQuotes"=>{"get"=>{"summary"=>"Get Latest Future Quotes", "description"=>"Returns latest delayed quotes for multiple future contracts.", "operationId"=>"GetLatestFutureQuotes", "x-api-path-slug"=>"getlatestfuturequotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Latest", "Future", "Quotes"]}}, "/GetSpotFutureQuote"=>{"get"=>{"summary"=>"Get Spot Future Quote", "description"=>"Returns a delayed spot quote for a future contract.", "operationId"=>"GetSpotFutureQuote", "x-api-path-slug"=>"getspotfuturequote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Spot", "Future", "Quote"]}}, "/GetLatestFrontMonthFutureQuotes"=>{"get"=>{"summary"=>"Get Latest Front Month Future Quotes", "description"=>"Returns latest quotes for front month futures", "operationId"=>"GetLatestFrontMonthFutureQuotes", "x-api-path-slug"=>"getlatestfrontmonthfuturequotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Latest", "Front", "Month", "Future", "Quotes"]}}, "/GetAllFutureQuotes"=>{"get"=>{"summary"=>"Get All Future Quotes", "description"=>"Returns all delayed future quotes for a future base.", "operationId"=>"GetAllFutureQuotes", "x-api-path-slug"=>"getallfuturequotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Future", "Quotes"]}}, "/GetLMEFutureQuote"=>{"get"=>{"summary"=>"Get LME Future Quote", "description"=>"Returns latest quotes for LME futures", "operationId"=>"GetLMEFutureQuote", "x-api-path-slug"=>"getlmefuturequote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["LME", "Future", "Quote"]}}, "/GetFutureOptionQuote"=>{"get"=>{"summary"=>"Get Future Option Quote", "description"=>"Returns a delayed future option quote for a future option.", "operationId"=>"GetFutureOptionQuote", "x-api-path-slug"=>"getfutureoptionquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Future", "Option", "Quote"]}}, "/GetAllOptionQuotes"=>{"get"=>{"summary"=>"Get All Option Quotes", "description"=>"Returns all delayed future option quotes for a future contract.", "operationId"=>"GetAllOptionQuotes", "x-api-path-slug"=>"getalloptionquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Option", "Quotes"]}}, "/GetFutureOptionQuotes"=>{"get"=>{"summary"=>"Get Future Option Quotes", "description"=>"Returns delayed future option quotes for multiple future options.", "operationId"=>"GetFutureOptionQuotes", "x-api-path-slug"=>"getfutureoptionquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Future", "Option", "Quotes"]}}, "/GetLatestFutureOptionQuote"=>{"get"=>{"summary"=>"Get Latest Future Option Quote", "description"=>"Returns latest delayed quote for multiple future option.", "operationId"=>"GetLatestFutureOptionQuote", "x-api-path-slug"=>"getlatestfutureoptionquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Latest", "Future", "Option", "Quote"]}}, "/GetLatestFutureOptionQuotes"=>{"get"=>{"summary"=>"Get Latest Future Option Quotes", "description"=>"Returns latest delayed quotes for multiple future options.", "operationId"=>"GetLatestFutureOptionQuotes", "x-api-path-slug"=>"getlatestfutureoptionquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Latest", "Future", "Option", "Quotes"]}}, "/ListFutureExchanges"=>{"get"=>{"summary"=>"List Future Exchanges", "description"=>"Returns a list of future exchanges", "operationId"=>"ListFutureExchanges", "x-api-path-slug"=>"listfutureexchanges-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Future", "Exchanges"]}}, "/ListBaseFutures"=>{"get"=>{"summary"=>"List Base Futures", "description"=>"Returns a list of base future symbols", "operationId"=>"ListBaseFutures", "x-api-path-slug"=>"listbasefutures-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Base", "Futures"]}}, "/ListFutureChain"=>{"get"=>{"summary"=>"List Future Chain", "description"=>"Returns a list of future contracts on a base future symbol", "operationId"=>"ListFutureChain", "x-api-path-slug"=>"listfuturechain-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Future", "Chain"]}}, "/ListOptionChain"=>{"get"=>{"summary"=>"List Option Chain", "description"=>"Returns a list of options on a future contract", "operationId"=>"ListOptionChain", "x-api-path-slug"=>"listoptionchain-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Option", "Chain"]}}, "/GetFuture"=>{"get"=>{"summary"=>"Get Future", "description"=>"Returns master data on a future contract", "operationId"=>"GetFuture", "x-api-path-slug"=>"getfuture-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Future"]}}, "/SearchFutures"=>{"get"=>{"summary"=>"Search Futures", "description"=>"Returns futures match the name", "operationId"=>"SearchFutures", "x-api-path-slug"=>"searchfutures-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "Futures"]}}, "/GetSwapQuote"=>{"get"=>{"summary"=>"Get Swap Quote", "description"=>"Returns quote for a swap", "operationId"=>"GetSwapQuote", "x-api-path-slug"=>"getswapquote-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Swap", "Quote"]}}, "/GetHistoricalSwapQuotes"=>{"get"=>{"summary"=>"Get Historical Swap Quotes", "description"=>"Returns historical swap quotes within a date range", "operationId"=>"GetHistoricalSwapQuotes", "x-api-path-slug"=>"gethistoricalswapquotes-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Swap", "Quotes"]}}, "/GetHistoricalFutureQuotesRange"=>{"get"=>{"summary"=>"Get Historical Future Quotes Range", "description"=>"Returns historical future quotes on a future contract within a date range", "operationId"=>"GetHistoricalFutureQuotesRange", "x-api-path-slug"=>"gethistoricalfuturequotesrange-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Historical", "Future", "Quotes", "Range"]}}}}, "xignite-global-indices-historical-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Xignite", "x-complete"=>1, "info"=>{"title"=>"Xignite Global Indices Historical", "description"=>"this-web-service-provides-global-historical-information-for-u-s--and-international-indices-", "version"=>"1.0.0"}, "host"=>"globalindiceshistorical.xignite.com", "basePath"=>"xglobalindiceshistorical.json/XigniteGlobalIndicesHistorical", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/GetHistoricalIndexValues"=>{"get"=>{"summary"=>"Get Historical Index Values", "description"=>"Get historical index values.", "operationId"=>"GetHistoricalIndexValues", "x-api-path-slug"=>"gethistoricalindexvalues-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Index", "Values"]}}, "/GetLastClosingIndicesValue"=>{"get"=>{"summary"=>"Get Last Closing Indices Value", "description"=>"Get last closing indices value.", "operationId"=>"GetLastClosingIndicesValue", "x-api-path-slug"=>"getlastclosingindicesvalue-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Last", "Closing", "Indices", "Value"]}}, "/GetHistoricalIndicesValue"=>{"get"=>{"summary"=>"Get Historical Indices Value", "description"=>"Get historical indices value.", "operationId"=>"GetHistoricalIndicesValue", "x-api-path-slug"=>"gethistoricalindicesvalue-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Indices", "Value"]}}, "/GetLastClosingIndexValue"=>{"get"=>{"summary"=>"Get Last Closing Index Value", "description"=>"Get last closing index value.", "operationId"=>"GetLastClosingIndexValue", "x-api-path-slug"=>"getlastclosingindexvalue-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Last", "Closing", "Index", "Value"]}}, "/GetHistoricalIndexValue"=>{"get"=>{"summary"=>"Get Historical Index Value", "description"=>"Get historical index value.", "operationId"=>"GetHistoricalIndexValue", "x-api-path-slug"=>"gethistoricalindexvalue-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Index", "Value"]}}, "/GetHistoricalIndexValuesTrailing"=>{"get"=>{"summary"=>"Get Historical Index Values Trailing", "description"=>"Get historical index values trailing.", "operationId"=>"GetHistoricalIndexValuesTrailing", "x-api-path-slug"=>"gethistoricalindexvaluestrailing-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical", "Index", "Values", "Trailing"]}}, "/GetIndexSymbolMappingByOldSymbol"=>{"get"=>{"summary"=>"Get Index Symbol Mapping By Old Symbol", "description"=>"Get index symbol mapping by old symbol.", "operationId"=>"GetIndexSymbolMappingByOldSymbol", "x-api-path-slug"=>"getindexsymbolmappingbyoldsymbol-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Index", "Symbol", "Mapping", "Old", "Symbol"]}}, "/GetIndexSymbolMappingsByOldSymbols"=>{"get"=>{"summary"=>"Get Index Symbol Mappings By Old Symbols", "description"=>"Get index symbol mappings by old symbols.", "operationId"=>"GetIndexSymbolMappingsByOldSymbols", "x-api-path-slug"=>"getindexsymbolmappingsbyoldsymbols-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Index", "Symbol", "Mappings", "Old", "Symbols"]}}, "/ListIndexGroups"=>{"get"=>{"summary"=>"List Index Groups", "description"=>"List index groups.", "operationId"=>"ListIndexGroups", "x-api-path-slug"=>"listindexgroups-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Index", "Groups"]}}, "/ListIndicesByIndexGroup"=>{"get"=>{"summary"=>"List Indices By Index Group", "description"=>"List indices by index group.", "operationId"=>"ListIndicesByIndexGroup", "x-api-path-slug"=>"listindicesbyindexgroup-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "List", "Indices", "Index", "Group"]}}, "/SearchIndicesByName"=>{"get"=>{"summary"=>"Search Indices By Name", "description"=>"Search indices by name.", "operationId"=>"SearchIndicesByName", "x-api-path-slug"=>"searchindicesbyname-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Search", "Indices", "Name"]}}, ", Bars"=>{"get"=>{"summary"=>"Get Chart Bars", "description"=>"Get chart bars.", "operationId"=>"GetChartBars", "x-api-path-slug"=>"bars-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chart", "Bars"]}}, "/GetIndexBars"=>{"get"=>{"summary"=>"Get Index Bars", "description"=>"Get index bars.", "operationId"=>"GetIndexBars", "x-api-path-slug"=>"getindexbars-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Index", "Bars"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-polly{"aws-polly-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Polly", "x-complete"=>1, "info"=>{"title"=>"AWS Polly API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=DeleteLexicon"=>{"get"=>{"summary"=>"Delete Lexicon", "description"=>"Deletes the specified pronunciation lexicon stored in an AWS Region.", "operationId"=>"deleteLexicon", "x-api-path-slug"=>"actiondeletelexicon-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"The name of the lexicon to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lexicons"]}}, "/?Action=DescribeVoices"=>{"get"=>{"summary"=>"Describe Voices", "description"=>"Returns the list of voices that are available for use when requesting speech synthesis.", "operationId"=>"describeVoices", "x-api-path-slug"=>"actiondescribevoices-get", "parameters"=>[{"in"=>"query", "name"=>"LanguageCode", "description"=>"The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"An opaque pagination token returned from the previous DescribeVoices operation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["voices"]}}, "/?Action=GetLexicon"=>{"get"=>{"summary"=>"Get Lexicon", "description"=>"Returns the content of the specified pronunciation lexicon stored in an AWS Region.", "operationId"=>"getLexicon", "x-api-path-slug"=>"actiongetlexicon-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"Name of the lexicon", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lexicons"]}}, "/?Action=ListLexicons"=>{"get"=>{"summary"=>"List Lexicons", "description"=>"Returns a list of pronunciation lexicons stored in an AWS Region.", "operationId"=>"listLexicons", "x-api-path-slug"=>"actionlistlexicons-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"An opaque pagination token returned from previous ListLexicons operation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lexicons"]}}, "/?Action=PutLexicon"=>{"get"=>{"summary"=>"Put Lexicon", "description"=>"Stores a pronunciation lexicon in an AWS Region.", "operationId"=>"putLexicon", "x-api-path-slug"=>"actionputlexicon-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"Name of the lexicon", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lexicons"]}}, "/?Action=SynthesizeSpeech"=>{"get"=>{"summary"=>"Synthesize Speech", "description"=>"Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.", "operationId"=>"synthesizeSpeech", "x-api-path-slug"=>"actionsynthesizespeech-get", "parameters"=>[{"in"=>"query", "name"=>"LexiconNames", "description"=>"List of one or more pronunciation lexicon names you want the service to apply during synthesis", "type"=>"string"}, {"in"=>"query", "name"=>"OutputFormat", "description"=>"The audio format in which the resulting stream will be encoded", "type"=>"string"}, {"in"=>"query", "name"=>"SampleRate", "description"=>"The audio frequency specified in Hz", "type"=>"string"}, {"in"=>"query", "name"=>"Text", "description"=>"Input text to synthesize", "type"=>"string"}, {"in"=>"query", "name"=>"TextType", "description"=>"Specifies whether the input text is plain text or SSML", "type"=>"string"}, {"in"=>"query", "name"=>"VoiceId", "description"=>"Voice ID to use for the synthesis", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Speech"]}}}}, "apis"=>{"name"=>"AWS Polly", "x-slug"=>"aws-polly", "description"=>"Amazon Polly is a service that turns text into lifelike speech. Polly lets you create applications that talk, enabling you to build entirely new categories of speech-enabled products. Polly is an Amazon AI service that uses advanced deep learning technologies to synthesize speech that sounds like a human voice. Polly includes 47 lifelike voices spread across 24 languages, so you can select the ideal voice and build speech-enabled applications that work in many different countries.Amazon Polly delivers the consistently fast response times required to support real-time, interactive dialog. You can cache and save Polly’s speech audio to replay offline or redistribute. And Polly is easy to use. You simply send the text you want converted into speech to the Polly API, and Polly immediately returns the audio stream to your application so your application can play it directly or store it in a standard audio file format, such as MP3.With Polly, you only pay for the number of characters you convert to speech, and you can save and replay Polly’s generated speech. Polly’s low cost per character converted, and lack of restrictions on storage and reuse of voice output, make it a cost-effective way to enable Text-to-Speech everywhere.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-polly.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Profiles,Relative Data,Service API,Speech,Stack Network,Texts,Voice", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-polly/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Polly API", "x-api-slug"=>"aws-polly-api", "description"=>"Amazon Polly is a service that turns text into lifelike speech. Polly lets you create applications that talk, enabling you to build entirely new categories of speech-enabled products. Polly is an Amazon AI service that uses advanced deep learning technologies to synthesize speech that sounds like a human voice. Polly includes 47 lifelike voices spread across 24 languages, so you can select the ideal voice and build speech-enabled applications that work in many different countries.Amazon Polly delivers the consistently fast response times required to support real-time, interactive dialog. You can cache and save Polly’s speech audio to replay offline or redistribute. And Polly is easy to use. You simply send the text you want converted into speech to the Polly API, and Polly immediately returns the audio stream to your application so your application can play it directly or store it in a standard audio file format, such as MP3.With Polly, you only pay for the number of characters you convert to speech, and you can save and replay Polly’s generated speech. Polly’s low cost per character converted, and lack of restrictions on storage and reuse of voice output, make it a cost-effective way to enable Text-to-Speech everywhere.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/aws-polly.jpg", "humanURL"=>"https://aws.amazon.com/polly/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Profiles,Relative Data,Service API,Speech,Stack Network,Texts,Voice", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-polly/aws-polly-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"http://docs.aws.amazon.com/polly/latest/dg/authentication-and-access-control.html"}, {"type"=>"x-customers", "url"=>"https://aws.amazon.com/polly/customers/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/polly/latest/dg/API_Reference.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/polly/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/polly/getting-started/"}, {"type"=>"x-logging", "url"=>"http://docs.aws.amazon.com/polly/latest/dg/logging-using-cloudtrail.html"}, {"type"=>"x-monitoring", "url"=>"http://docs.aws.amazon.com/polly/latest/dg/cloud-watch.html"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/polly/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/polly/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
accelerated-mobile-pages-url{"accelerated-mobile-pages-amp-url-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Accelerated Mobile Pages URL", "x-complete"=>1, "info"=>{"title"=>"Accelerated Mobile Pages (AMP) URL", "description"=>"this-api-contains-a-single-method-batchget--call-this-method-to-retrieve-the-amp-url-and-equivalent-amp-cache-url-for-given-public-urls-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"acceleratedmobilepageurl.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/ampUrls:batchGet"=>{"post"=>{"summary"=>"", "description"=>"Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).", "operationId"=>"acceleratedmobilepageurl.ampUrls.batchGet", "x-api-path-slug"=>"v1ampurlsbatchget-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AMP URLs"]}}}}, "apis"=>{"name"=>"Accelerated Mobile Pages URL", "x-slug"=>"accelerated-mobile-pages-url", "description"=>"AMP is a way to build web pages for static content that render fast. AMP in action consists of three different parts: AMP HTML is HTML with some restrictions for reliable performance and some extensions for building rich content beyond basic HTML. The AMP JS library ensures the fast rendering of AMP HTML pages. The Google AMP Cache can be used to serve cached AMP HTML pages.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-amp.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Mobile,Profiles,Relative Data,Service API,Stack Network,URLs", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"accelerated-mobile-pages-url/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Accelerated Mobile Pages (AMP) URL API", "x-api-slug"=>"accelerated-mobile-pages-amp-url-api", "description"=>"AMP is a way to build web pages for static content that render fast. AMP in action consists of three different parts: AMP HTML is HTML with some restrictions for reliable performance and some extensions for building rich content beyond basic HTML. The AMP JS library ensures the fast rendering of AMP HTML pages. The Google AMP Cache can be used to serve cached AMP HTML pages.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-amp.png", "humanURL"=>"https://www.ampproject.org/", "baseURL"=>"://acceleratedmobilepageurl.googleapis.com//", "tags"=>"API Provider,API Service Provider,Google APIs,Mobile,Profiles,Relative Data,Service API,Stack Network,URLs", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/accelerated-mobile-pages-url/accelerated-mobile-pages-amp-url-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://amphtml.wordpress.com/"}, {"type"=>"x-blog-rss", "url"=>"https://amphtml.wordpress.com/feed/"}, {"type"=>"x-developer", "url"=>"https://developers.google.com/amp/cache/reference/acceleratedmobilepageurl/rest/"}, {"type"=>"x-github", "url"=>"https://github.com/ampproject"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/amphtml"}, {"type"=>"x-website", "url"=>"https://www.ampproject.org/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-billing{"google-cloud-billing-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Billing", "x-complete"=>1, "info"=>{"title"=>"Google Cloud Billing", "description"=>"allows-developers-to-manage-billing-for-their-google-cloud-platform-projects----programmatically-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"cloudbilling.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/billingAccounts"=>{"get"=>{"summary"=>"Get Billing Accounts", "description"=>"Lists the billing accounts that the current authenticated user\n[owns](https://support.google.com/cloud/answer/4430947).", "operationId"=>"cloudbilling.billingAccounts.list", "x-api-path-slug"=>"v1billingaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"pageSize", "description"=>"Requested page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A token identifying a page of results to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/v1/{name}"=>{"get"=>{"summary"=>"Get Billing Account", "description"=>"Gets information about a billing account. The current authenticated user\nmust be an [owner of the billing\naccount](https://support.google.com/cloud/answer/4430947).", "operationId"=>"cloudbilling.billingAccounts.get", "x-api-path-slug"=>"v1name-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The resource name of the billing account to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/v1/{name}/billingInfo"=>{"get"=>{"summary"=>"Get Billing Information", "description"=>"Gets the billing information for a project. The current authenticated user\nmust have [permission to view the\nproject](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n).", "operationId"=>"cloudbilling.projects.getBillingInfo", "x-api-path-slug"=>"v1namebillinginfo-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The resource name of the project for which billing information isretrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Billing"]}, "put"=>{"summary"=>"Update Billing Information", "description"=>"Sets or updates the billing account associated with a project. You specify\nthe new billing account by setting the `billing_account_name` in the\n`ProjectBillingInfo` resource to the resource name of a billing account.\nAssociating a project with an open billing account enables billing on the\nproject and allows charges for resource usage. If the project already had a\nbilling account, this method changes the billing account used for resource\nusage charges.\n\n*Note:* Incurred charges that have not yet been reported in the transaction\nhistory of the Google Cloud Console may be billed to the new billing\naccount, even if the charge occurred before the new billing account was\nassigned to the project.\n\nThe current authenticated user must have ownership privileges for both the\n[project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n) and the [billing\naccount](https://support.google.com/cloud/answer/4430947).\n\nYou can disable billing on the project by setting the\n`billing_account_name` field to empty. This action disassociates the\ncurrent billing account from the project. Any billable activity of your\nin-use services will stop, and your application could stop functioning as\nexpected. Any unbilled charges to date will be billed to the previously\nassociated account. The current authenticated user must be either an owner\nof the project or an owner of the billing account for the project.\n\nNote that associating a project with a *closed* billing account will have\nmuch the same effect as disabling billing on the project: any paid\nresources used by the project will be shut down. Thus, unless you wish to\ndisable billing, you should always call this method with the name of an\n*open* billing account.", "operationId"=>"cloudbilling.projects.updateBillingInfo", "x-api-path-slug"=>"v1namebillinginfo-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"name", "description"=>"The resource name of the project associated with the billing informationthat you want to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Billing"]}}, "/v1/{name}/projects"=>{"get"=>{"summary"=>"Get Projects", "description"=>"Lists the projects associated with a billing account. The current\nauthenticated user must be an [owner of the billing\naccount](https://support.google.com/cloud/answer/4430947).", "operationId"=>"cloudbilling.billingAccounts.projects.list", "x-api-path-slug"=>"v1nameprojects-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The resource name of the billing account associated with the projects thatyou want to list"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Requested page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A token identifying a page of results to be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project"]}}}}, "apis"=>{"name"=>"Google Cloud Billing", "x-slug"=>"google-cloud-billing", "description"=>"The Google Cloud Billing API provides methods that you can use to programmatically manage billing for your projects in the Google Cloud Platform.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Generic-GCP.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Billing,Google APIs,Monetization,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-billing/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Billing API", "x-api-slug"=>"google-cloud-billing-api", "description"=>"The Google Cloud Billing API provides methods that you can use to programmatically manage billing for your projects in the Google Cloud Platform.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Generic-GCP.png", "humanURL"=>"https://cloud.google.com/billing/docs/", "baseURL"=>"://cloudbilling.googleapis.com//", "tags"=>"API Provider,API Service Provider,Billing,Google APIs,Monetization,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-billing/google-cloud-billing-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-code", "url"=>"https://cloud.google.com/billing/v1/libraries"}, {"type"=>"x-errors", "url"=>"https://cloud.google.com/billing/v1/errors/core_errors"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/billing/v1/getting-started"}, {"type"=>"x-how-to-guides", "url"=>"https://cloud.google.com/billing/docs/how-to"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/billing/v1/pricing"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/billing/docs/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-site-verification{"google-site-verification-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Site Verification", "x-complete"=>1, "info"=>{"title"=>"Google Site Verification", "description"=>"verifies-ownership-of-websites-or-domains-with-google-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"www.googleapis.com", "basePath"=>"/siteVerification/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/token"=>{"post"=>{"summary"=>"Get Token", "description"=>"Get a verification token for placing on a website or domain.", "operationId"=>"siteVerification.webResource.getToken", "x-api-path-slug"=>"token-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Token"]}}, "/webResource"=>{"get"=>{"summary"=>"Get Verified Websites", "description"=>"Get the list of your verified websites and domains.", "operationId"=>"siteVerification.webResource.list", "x-api-path-slug"=>"webresource-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Website"]}, "post"=>{"summary"=>"Verify Website", "description"=>"Attempt verification of a website or domain.", "operationId"=>"siteVerification.webResource.insert", "x-api-path-slug"=>"webresource-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"verificationMethod", "description"=>"The method to use for verifying a site or domain"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Website"]}}, "/webResource/{id}"=>{"delete"=>{"summary"=>"Relinquish Ownership Of Website", "description"=>"Relinquish ownership of a website or domain.", "operationId"=>"siteVerification.webResource.delete", "x-api-path-slug"=>"webresourceid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of a verified site or domain"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Website"]}, "get"=>{"summary"=>"Get Current Data for Website", "description"=>"Get the most current data for a website or domain.", "operationId"=>"siteVerification.webResource.get", "x-api-path-slug"=>"webresourceid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of a verified site or domain"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Website"]}, "patch"=>{"summary"=>"Update List of Owners for Website", "description"=>"Modify the list of owners for your website or domain. This method supports patch semantics.", "operationId"=>"siteVerification.webResource.patch", "x-api-path-slug"=>"webresourceid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The id of a verified site or domain"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Website"]}, "put"=>{"summary"=>"Update List of Owners for Website", "description"=>"Modify the list of owners for your website or domain.", "operationId"=>"siteVerification.webResource.update", "x-api-path-slug"=>"webresourceid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The id of a verified site or domain"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Website"]}}}}, "apis"=>{"name"=>"Google Site Verification", "x-slug"=>"google-site-verification", "description"=>"The Google Site Verification API lets you develop applications or services that automate the process of verifying that the authenticated user owns a domain or website. This is important, since some Google services can only be used by site owners.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-site-verification-500x362.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,DNS,Google APIs,Links,Profiles,Relative Data,Security,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-site-verification/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Site Verification API", "x-api-slug"=>"google-site-verification-api", "description"=>"The Google Site Verification API lets you develop applications or services that automate the process of verifying that the authenticated user owns a domain or website. This is important, since some Google services can only be used by site owners.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-site-verification-500x362.png", "humanURL"=>"https://developers.google.com/site-verification/", "baseURL"=>"://www.googleapis.com//siteVerification/v1", "tags"=>"API Provider,API Service Provider,DNS,Google APIs,Links,Profiles,Relative Data,Security,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-site-verification/google-site-verification-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-code", "url"=>"https://developers.google.com/site-verification/libraries"}, {"type"=>"x-documentation", "url"=>"https://developers.google.com/site-verification/v1/"}, {"type"=>"x-website", "url"=>"https://developers.google.com/site-verification/"}, {"type"=>"x-getting-started", "url"=>"https://developers.google.com/site-verification/v1/getting_started"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
paccurate{"paccurate-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Paccurate", "x-complete"=>1, "info"=>{"title"=>"paccurate.io", "version"=>"0.1.1"}, "host"=>"api.paccurate.io", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/"=>{"post"=>{"summary"=>"Post", "description"=>"a pure-JSON endpoint for packing requests.", "operationId"=>".post", "x-api-path-slug"=>"post", "parameters"=>[{"in"=>"body", "name"=>"pack", "description"=>"complete set of items, boxes, and parameters to pack", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Packaging"]}}}}, "apis"=>{"name"=>"Paccurate", "x-slug"=>"paccurate", "description"=>"Designed for production shipping environments, ρaccurate is lightning fast, completing most requests in 100ms or less. A single, flexible API call can be used in any project or workflow. More accurate shipping estimates. By precisely simulating how your product will be packed, you can avoid over-estimating shipping, which reduces shopping cart abandonment. Speed up the pick and pack process. Turn warehouse staff into smooth operators- ρaccurate can generate a helpful pack list and visual instructions—and even generate intelligent pick zones on the fly. Let paccurate determine the cheapest box configuration. When business is booming, every cent counts. Use ρaccurate to find the optimal way of packing each parcel and pallet and avoid costly mistakes.", "image"=>"", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Packages,Relative Data,Service API,Shipping", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"paccurate/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Paccurate", "x-api-slug"=>"paccurate", "description"=>"Designed for production shipping environments, ρaccurate is lightning fast, completing most requests in 100ms or less. A single, flexible API call can be used in any project or workflow. More accurate shipping estimates. By precisely simulating how your product will be packed, you can avoid over-estimating shipping, which reduces shopping cart abandonment. Speed up the pick and pack process. Turn warehouse staff into smooth operators- ρaccurate can generate a helpful pack list and visual instructions—and even generate intelligent pick zones on the fly. Let paccurate determine the cheapest box configuration. When business is booming, every cent counts. Use ρaccurate to find the optimal way of packing each parcel and pallet and avoid costly mistakes.", "image"=>"", "humanURL"=>"http://paccurate.io", "baseURL"=>"https://api.paccurate.io//", "tags"=>"Packages,Relative Data,Service API,Shipping", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/paccurate/paccurate-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"https://docs.paccurate.io/"}, {"type"=>"x-getting-started", "url"=>"https://docs.paccurate.io/#getting-started"}, {"type"=>"x-website", "url"=>"http://paccurate.io"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
gitter{"gitter-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Gitter", "x-complete"=>1, "info"=>{"title"=>"No Title", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/groups"=>{"get"=>{"summary"=>"List Groups", "description"=>"List groups the current user is in.", "operationId"=>"listGroups", "x-api-path-slug"=>"groups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/groups/:groupId/rooms"=>{"get"=>{"summary"=>"Group Rooms", "description"=>"List rooms under group", "operationId"=>"getGroupRooms", "x-api-path-slug"=>"groupsgroupidrooms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups", "Rooms"]}}, "/rooms"=>{"get"=>{"summary"=>"List rooms", "description"=>"List rooms the current user is in.", "operationId"=>"listRooms", "x-api-path-slug"=>"rooms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rooms"]}}, "/user/:userId/rooms"=>{"post"=>{"summary"=>"Join Room", "description"=>"To join a room you'll need to provide a URI for it. Said URI can represent a GitHub Org, a GitHub Repo or a Gitter Channel.", "operationId"=>"joinRoom", "x-api-path-slug"=>"useruseridrooms-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rooms"]}, "get"=>{"summary"=>"Get User Rooms", "description"=>"List of Rooms the user is part of.", "operationId"=>"getUserRooms", "x-api-path-slug"=>"useruseridrooms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Rooms"]}}, "/rooms/:room_id/users/:user_id"=>{"get"=>{"summary"=>"Remove Room", "description"=>"Remove a user from a room.", "operationId"=>"removeRoom", "x-api-path-slug"=>"roomsroom-idusersuser-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rooms"]}}, "/rooms/:roomId"=>{"put"=>{"summary"=>"Update room", "description"=>"Updates a room.", "operationId"=>"updateRoom", "x-api-path-slug"=>"roomsroomid-put", "parameters"=>[{"in"=>"query", "name"=>"noindex", "description"=>"Whether the room is indexed by search engines", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"tags", "description"=>"Tags that define the room", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"topic", "description"=>"Room topic", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rooms"]}, "delete"=>{"summary"=>"Delete Room", "description"=>"Deletes a room.", "operationId"=>"deleteRoom", "x-api-path-slug"=>"roomsroomid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rooms"]}}, "/rooms/:roomId/users"=>{"get"=>{"summary"=>"Room Users", "description"=>"List of Users currently in the room.", "operationId"=>"getRoomUsers", "x-api-path-slug"=>"roomsroomidusers-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"maximum number of users to return (default 30)", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"q", "description"=>"Search query", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"skip", "description"=>"Skip n users", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rooms", "Users"]}}, "/rooms/:roomId/chatMessages"=>{"get"=>{"summary"=>"List Room Messages", "description"=>"List of messages in a room.", "operationId"=>"listRoomMessages", "x-api-path-slug"=>"roomsroomidchatmessages-get", "parameters"=>[{"in"=>"query", "name"=>"afterId", "description"=>"Get messages after afterId", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"aroundId", "description"=>"Get messages around aroundId including this message", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"beforeId", "description"=>"Get messages before beforeId", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Maximum number of messages to return (constrained to 100 or less)", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"q", "description"=>"Search query", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"skip", "description"=>"Skip n messages (constrained to 5000 or less)", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rooms", "Messages"]}, "post"=>{"summary"=>"Send Message", "description"=>"Send a message to a room.", "operationId"=>"sendMessage", "x-api-path-slug"=>"roomsroomidchatmessages-post", "parameters"=>[{"in"=>"query", "name"=>"text", "description"=>"Required Body of the message", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rooms", "Messages"]}}, "/rooms/:roomId/chatMessages/:messageId"=>{"get"=>{"summary"=>"Get Room Message", "description"=>"There is also a way to retrieve a single message using its id.", "operationId"=>"getRoomMessage", "x-api-path-slug"=>"roomsroomidchatmessagesmessageid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rooms", "Message"]}}, "/rooms/:roomId/chatMessages/:chatMessageId"=>{"put"=>{"summary"=>"Update Message", "description"=>"Update a message.", "operationId"=>"updateMessage", "x-api-path-slug"=>"roomsroomidchatmessageschatmessageid-put", "parameters"=>[{"in"=>"query", "name"=>"text", "description"=>"Required Body of the message", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rooms", "Messages"]}}, "/user"=>{"get"=>{"summary"=>"Get User", "description"=>"Get the current user.", "operationId"=>"getUser", "x-api-path-slug"=>"user-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "/user/:userId/rooms/:roomId/unreadItems"=>{"get"=>{"summary"=>"Get User Unread Items", "description"=>"You can retrieve unread items and mentions using the following endpoint.", "operationId"=>"getUserUnreadItems", "x-api-path-slug"=>"useruseridroomsroomidunreaditems-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Messages", "Unread"]}, "post"=>{"summary"=>"Mark Unread Items as Read", "description"=>"There is an additional endpoint nested under rooms that you can use to mark chat messages as read.", "operationId"=>"markUnreadItemsasRead", "x-api-path-slug"=>"useruseridroomsroomidunreaditems-post", "parameters"=>[{"in"=>"query", "name"=>"chat", "description"=>"Array of chatIds", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Read"]}}, "/user/:userId/orgs"=>{"get"=>{"summary"=>"User Orgs", "description"=>"List of the user's GitHub Organisations and their respective Room if available.", "operationId"=>"getUserOrgs", "x-api-path-slug"=>"useruseridorgs-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Organizations"]}}, "/user/:userId/repos"=>{"get"=>{"summary"=>"User Repos", "description"=>"List of the user's GitHub Repositories and their respective Room if available.", "operationId"=>"getUserRepos", "x-api-path-slug"=>"useruseridrepos-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Repositories"]}}, "/user/:userId/channels"=>{"get"=>{"summary"=>"Get User Channels", "description"=>"List of Gitter channels nested under the current user.", "operationId"=>"getUserChannels", "x-api-path-slug"=>"useruseridchannels-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Channels"]}}}}, "apis"=>{"name"=>"Gitter", "x-slug"=>"gitter", "description"=>"Gitter is a chat and networking platform that helps to manage, grow and connect communities through messaging, content and discovery.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/gitter-logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"18282", "tags"=>"API Provider,API Service Provider,Communications,General Data,Profiles,Relative Data,SaaS,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"gitter/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Gitter API", "x-api-slug"=>"gitter-api", "description"=>"Gitter is a chat and networking platform that helps to manage, grow and connect communities through messaging, content and discovery.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/gitter-logo.png", "humanURL"=>"http://gitter.im", "baseURL"=>"https:///", "tags"=>"API Provider,API Service Provider,Communications,General Data,Profiles,Relative Data,SaaS,Service API,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/gitter/useruseridchannels-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/gitter/gitter-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/gitter"}, {"type"=>"x-developer", "url"=>"https://developer.gitter.im/docs/streaming-api"}, {"type"=>"x-github", "url"=>"https://github.com/gitterHQ"}, {"type"=>"x-curated-source", "url"=>"https://gitter.im/apiaryio/api-blueprint"}, {"type"=>"x-website", "url"=>"http://gitter.im"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/gitchat"}, {"type"=>"x-website", "url"=>"https://gitter.im"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-manufacturer-center{"google-manufacturer-center-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Manufacturer Center", "x-complete"=>1, "info"=>{"title"=>"Manufacturer Center", "description"=>"public-api-for-managing-manufacturer-center-related-data-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"manufacturers.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/{parent}/products"=>{"get"=>{"summary"=>"Get Products", "description"=>"Lists all the products in a Manufacturer Center account.", "operationId"=>"manufacturers.accounts.products.list", "x-api-path-slug"=>"v1parentproducts-get", "parameters"=>[{"in"=>"query", "name"=>"pageSize", "description"=>"Maximum number of product statuses to return in the response, used forpaging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}, {"in"=>"path", "name"=>"parent", "description"=>"Parent ID in the format `accounts/{account_id}`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}}, "/v1/{parent}/products/{name}"=>{"get"=>{"summary"=>"Get Product", "description"=>"Gets the product from a Manufacturer Center account, including product\nissues.", "operationId"=>"manufacturers.accounts.products.get", "x-api-path-slug"=>"v1parentproductsname-get", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"Name in the format `{target_country}:{content_language}:{product_id}`"}, {"in"=>"path", "name"=>"parent", "description"=>"Parent ID in the format `accounts/{account_id}`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}}}}, "apis"=>{"name"=>"Google Manufacturer Center", "x-slug"=>"google-manufacturer-center", "description"=>"Public API for managing Manufacturer Center related data. Impact the way your products and product details appear within Google Shopping. You???ll attract more shoppers and elevate your brands online. With Manufacturer Center, you provide the images, descriptions, and product details to improve how your products appear to the world. That information helps create more effective listings on Google Shopping and other Google services. If anything changes, you can provide new product data at any time.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-manufacturer-center-800x546.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Manufacturing,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-manufacturer-center/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Manufacturer Center API", "x-api-slug"=>"google-manufacturer-center-api", "description"=>"Public API for managing Manufacturer Center related data. Impact the way your products and product details appear within Google Shopping. You???ll attract more shoppers and elevate your brands online. With Manufacturer Center, you provide the images, descriptions, and product details to improve how your products appear to the world. That information helps create more effective listings on Google Shopping and other Google services. If anything changes, you can provide new product data at any time.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-manufacturer-center-800x546.png", "humanURL"=>"https://developers.google.com/manufacturers/quickstart", "baseURL"=>"://manufacturers.googleapis.com//", "tags"=>"API Provider,API Service Provider,Google APIs,Manufacturing,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/google-manufacturer-center/v1parentproductsname-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/google-manufacturer-center/google-manufacturer-center-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://developers.google.com/manufacturers/how-tos/authorizing"}, {"type"=>"x-code", "url"=>"https://developers.google.com/manufacturers/libraries"}, {"type"=>"x-developers", "url"=>"https://developers.google.com/manufacturers/quickstart"}, {"type"=>"x-website", "url"=>"https://www.google.com/retail/manufacturer-center/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fire-browse{"fire-browse-beta-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Fire Browse", "x-complete"=>1, "info"=>{"title"=>"Fire Browse Beta API", "description"=>"a-simple-and-elegant-way-to-explore-cancer-data", "version"=>"1.1.35 (2016-09-27 10:12:23 6a47e74011281b2aa"}, "host"=>"firebrowse.org", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/Analyses/CopyNumber/Genes/All"=>{"get"=>{"summary"=>"Retrieve all data by genes Gistic2 results.", "description"=>"This service provides access to the Gistic2 all_data_by_genes.txt output data. This data is a gene-level table of copy number values for all samples. The returned copy number values are in units (copy number - 2) so that no amplification or deletion is 0, genes with amplifications have positive values, and genes with deletions are negative values. The data are converted from marker level to gene level using the extreme method: a gene is assigned the greatest amplification or the least deletion value among the markers it covers. Results may be filtered by cohort, gene, or barcode, but at least one gene or barcode must be supplied.", "operationId"=>"getAnalysesCopynumberGenesAll", "x-api-path-slug"=>"analysescopynumbergenesall-get", "parameters"=>[{"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"gene", "description"=>"Comma separated list of gene name(s)"}, {"in"=>"query", "name"=>"page", "description"=>"Which page (slice) of entire results set should be returned"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records per page of results"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Which column in the results should be used for sorting paginated results?"}, {"in"=>"query", "name"=>"tcga_participant_barcode", "description"=>"Comma separated list of TCGA participant barcodes (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "CopyNumber", "Genes"]}}, "/Analyses/CopyNumber/Genes/Amplified"=>{"get"=>{"summary"=>"Retrieve Gistic2 significantly amplified genes results.", "description"=>"This service provides access to the Gistic2 amp_genes.conf_99.txt output data. At least 1 gene or cohort must be supplied.", "operationId"=>"getAnalysesCopynumberGenesAmplified", "x-api-path-slug"=>"analysescopynumbergenesamplified-get", "parameters"=>[{"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"gene", "description"=>"Comma separated list of gene name(s)"}, {"in"=>"query", "name"=>"page", "description"=>"Which page (slice) of entire results set should be returned"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records per page of results"}, {"in"=>"query", "name"=>"q", "description"=>"Only return results with Q-value"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Which column in the results should be used for sorting paginated results?"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "CopyNumber", "Genes", "Amplified"]}}, "/Analyses/CopyNumber/Genes/Deleted"=>{"get"=>{"summary"=>"Retrieve Gistic2 significantly deleted genes results.", "description"=>"This service provides access to the Gistic2 del_genes.conf_99.txt output data. At least 1 gene or cohort must be supplied.", "operationId"=>"getAnalysesCopynumberGenesDeleted", "x-api-path-slug"=>"analysescopynumbergenesdeleted-get", "parameters"=>[{"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"gene", "description"=>"Comma separated list of gene name(s)"}, {"in"=>"query", "name"=>"page", "description"=>"Which page (slice) of entire results set should be returned"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records per page of results"}, {"in"=>"query", "name"=>"q", "description"=>"Only return results with Q-value"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Which column in the results should be used for sorting paginated results?"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "CopyNumber", "Genes", "D"]}}, "/Analyses/CopyNumber/Genes/Focal"=>{"get"=>{"summary"=>"Retrieve focal data by genes Gistic2 results.", "description"=>"This service provides access to the Gistic2 focal_data_by_genes.txt output data. This output is similar to the all_data_by_genes.txt output, but using only focal events with lengths greater than the focal length cutoff. This data is a gene-level table of copy number values for all samples. The returned copy number values are in units (copy number - 2) so that no amplification or deletion is 0, genes with amplifications have positive values, and genes with deletions are negative values. The data are converted from marker level to gene level using the extreme method: a gene is assigned the greatest amplification or the least deletion value among the markers it covers. Results may be filtered by cohort, gene, and/or barcode, but at least one gene or barcode must be supplied.", "operationId"=>"getAnalysesCopynumberGenesFocal", "x-api-path-slug"=>"analysescopynumbergenesfocal-get", "parameters"=>[{"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"gene", "description"=>"Comma separated list of gene name(s)"}, {"in"=>"query", "name"=>"page", "description"=>"Which page (slice) of entire results set should be returned"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records per page of results"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Which column in the results should be used for sorting paginated results?"}, {"in"=>"query", "name"=>"tcga_participant_barcode", "description"=>"Comma separated list of TCGA participant barcodes (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "CopyNumber", "Genes", "Focal"]}}, "/Analyses/CopyNumber/Genes/Thresholded"=>{"get"=>{"summary"=>"Retrieve all thresholded by genes Gistic2 results.", "description"=>"This service provides access to the Gistic2 all_thresholded_by_genes.txt output data. A gene-level table of discrete amplification and deletion indicators for all samples. A table value of 0 means no amplification or deletion above the threshold. Amplifications are positive numbers: 1 means amplification above the amplification threshold; 2 means amplifications larger to the arm level amplifications observed for the sample. Deletions are represented by negative table values: -1 represents deletion beyond the threshold; -2 means deletions greater than the minimum arm-level deletion observed for the sample. Results maybe filtered by cohort, gene or barcode, but at least one gene or barcode must be supplied.", "operationId"=>"getAnalysesCopynumberGenesThresholded", "x-api-path-slug"=>"analysescopynumbergenesthresholded-get", "parameters"=>[{"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"gene", "description"=>"Comma separated list of gene name(s)"}, {"in"=>"query", "name"=>"page", "description"=>"Which page (slice) of entire results set should be returned"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records per page of results"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Which column in the results should be used for sorting paginated results?"}, {"in"=>"query", "name"=>"tcga_participant_barcode", "description"=>"Comma separated list of TCGA participant barcodes (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "CopyNumber", "Genes", "Thresholded"]}}, "/Analyses/FeatureTable"=>{"get"=>{"summary"=>"Retrieve aggregated analysis features table.", "description"=>"This service returns part or all of the so-called feature table; which aggregates the most important findings across ALL pipelines in the GDAC Firehose analysis workflow into a single table for simple access. One feature table is created per disease cohort. Results may be filtered by date or cohort, but at least 1 cohort must be specified here. For more details please visit the online documentation. Please note that the service is still undergoing experimental evaluation and does not return JSON format.", "operationId"=>"getAnalysesFeaturetable", "x-api-path-slug"=>"analysesfeaturetable-get", "parameters"=>[{"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"column", "description"=>"Comma separated list of which data columns/fields to return"}, {"in"=>"query", "name"=>"date", "description"=>"Select one or more date stamps"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"page", "description"=>"Which page (slice) of entire results set should be returned"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records per page of results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "FeatureTable"]}}, "/Analyses/Mutation/MAF"=>{"get"=>{"summary"=>"Retrieve MutSig final analysis MAF.", "description"=>"This service returns columns from the MAF generated by MutSig. Results may be filtered by gene, cohort, tool, or barcode, but at least one gene OR barcode OR cohort must be given. By default a subset consisting of the most commonly used columns will be returned, but that can be modified with the column parameter. Specifying 'all' in this parameter is a convenient way to return every column of the respective MAF, and has precedence over any any other column selection expression. The complete list of column names that may be specified is given here. For more information on the mutation data, and how it is processed by Firehose, please consult the pipeline documentation.", "operationId"=>"getAnalysesMutationMaf", "x-api-path-slug"=>"analysesmutationmaf-get", "parameters"=>[{"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"column", "description"=>"Comma separated list of which data columns/fields to return"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"gene", "description"=>"Comma separated list of gene name(s)"}, {"in"=>"query", "name"=>"page", "description"=>"Which page (slice) of entire results set should be returned"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records per page of results"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Which column in the results should be used for sorting paginated results?"}, {"in"=>"query", "name"=>"tcga_participant_barcode", "description"=>"Comma separated list of TCGA participant barcodes (e"}, {"in"=>"query", "name"=>"tool", "description"=>"Narrow search to include only data/results produced by the selected Firehose tool"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Mutation", "MAF"]}}, "/Analyses/Mutation/SMG"=>{"get"=>{"summary"=>"Retrieve Significantly Mutated Genes (SMG).", "description"=>"This service provides a list of significantly mutated genes, as scored by MutSig. It may be filtered by cohort, rank, gene, tool and/or Q-value threshold, but at least one cohort or gene must be supplied.", "operationId"=>"getAnalysesMutationSmg", "x-api-path-slug"=>"analysesmutationsmg-get", "parameters"=>[{"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"gene", "description"=>"Comma separated list of gene name(s)"}, {"in"=>"query", "name"=>"page", "description"=>"Which page (slice) of entire results set should be returned"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records per page of results"}, {"in"=>"query", "name"=>"q", "description"=>"Only return results with Q-value"}, {"in"=>"query", "name"=>"rank", "description"=>"Number of significant genes to return"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Which column in the results should be used for sorting paginated results?"}, {"in"=>"query", "name"=>"tool", "description"=>"Narrow search to include only data/results produced by the selected Firehose tool"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Mutation", "SMG"]}}, "/Analyses/Reports"=>{"get"=>{"summary"=>"Retrieve links to summary reports from Firehose analysis runs.", "description"=>"This service returns URLs to the analysis result reports for runs of the Broad Institute GDAC Firehose analysis pipeline. At least one year of run reports are maintained in the database, but the reports from the latest run will be returned by default. The set of Nozzle reports returned may be filtered by disease cohort, report type and report name.", "operationId"=>"getAnalysesReports", "x-api-path-slug"=>"analysesreports-get", "parameters"=>[{"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"date", "description"=>"Select one or more date stamps"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"name", "description"=>"Narrow search to one or more report names"}, {"in"=>"query", "name"=>"page", "description"=>"Which page (slice) of entire results set should be returned"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records per page of results"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Which column in the results should be used for sorting paginated results?"}, {"in"=>"query", "name"=>"type", "description"=>"Narrow search to one or more report types"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "Reports"]}}, "/Analyses/mRNASeq/Quartiles"=>{"get"=>{"summary"=>"Returns RNASeq expression quartiles, e.g. suitable for drawing a boxplot.", "description"=>"For a given gene compute quartiles and extrema, suitable e.g. for drawing a boxplot (Tukey 1977). Results may be filtered by cohort, sample type, patient barcode or characterization protocol, and are returned sorted by cohort. Note that samples for which no expression value was recorded (e.g. the melanoma sample TCGA-GN-262) are removed prior to calculation.", "operationId"=>"getAnalysesMrnaseqQuartiles", "x-api-path-slug"=>"analysesmrnaseqquartiles-get", "parameters"=>[{"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"Exclude", "description"=>"Comma separated list of TCGA participants, identified by barcodes such as TCGA-GF-A4EO, denoting samples to exclude from computation"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"gene", "description"=>"Enter a single gene name"}, {"in"=>"query", "name"=>"protocol", "description"=>"Narrow search to one or more sample characterization protocols from the scrollable list"}, {"in"=>"query", "name"=>"sample_type", "description"=>"For which type of sample(s) should quartiles be computed?"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Analyses", "MRNASeq", "Quartiles"]}}, "/Archives/StandardData"=>{"get"=>{"summary"=>"Retrieve standard data archives.", "description"=>"This service returns the archive URLs for our Firehose standard data runs, providing a RESTful interface similar in spirit to the command line firehose_get tool. The archives can be filtered based on date, cohort, data type, platform, center, data level, and protocol.", "operationId"=>"getArchivesStandarddata", "x-api-path-slug"=>"archivesstandarddata-get", "parameters"=>[{"in"=>"query", "name"=>"center", "description"=>"Narrow search to one or more TCGA centers from the scrollable list"}, {"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"data_type", "description"=>"Narrow search to one or more TCGA data types from the scrollable list"}, {"in"=>"query", "name"=>"date", "description"=>"Select one or more date stamps"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"level", "description"=>"Narrow search to one or more TCGA data levels"}, {"in"=>"query", "name"=>"page", "description"=>"Which page (slice) of entire results set should be returned"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records per page of results"}, {"in"=>"query", "name"=>"platform", "description"=>"Narrow search to one or more TCGA data generation platforms from the scrollable list"}, {"in"=>"query", "name"=>"protocol", "description"=>"Narrow search to one or more sample characterization protocols from the scrollable list"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Which column in the results should be used for sorting paginated results?"}, {"in"=>"query", "name"=>"tool", "description"=>"Narrow search to include only data/results produced by the selected Firehose tool"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Archives", "StandardData"]}}, "/Metadata/Centers"=>{"get"=>{"summary"=>"Obtain identities of TCGA consortium member centers.", "description"=>"By default this function returns a table of all consortium members in TCGA, aka centers; it provides both the HTTP domain and full organizational name of each center. A subset of this table may be obtained by explicitly specifying one or more domain names.", "operationId"=>"getMetadataCenters", "x-api-path-slug"=>"metadatacenters-get", "parameters"=>[{"in"=>"query", "name"=>"center", "description"=>"Narrow search to one or more TCGA centers from the scrollable list"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "Centers"]}}, "/Metadata/ClinicalNames"=>{"get"=>{"summary"=>"Retrieve names of all TCGA clinical data elements (CDEs).", "description"=>"Retrieve names of all patient-level clinical data elements (CDES) available in TCGA, unioned across all disease cohorts. A CDE will be listed here only when it has a value other than NA for at least 1 patient case in any disease cohort. For more information on how these CDEs are processed see our pipeline documentation.", "operationId"=>"getMetadataClinicalnames", "x-api-path-slug"=>"metadataclinicalnames-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Format of result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "ClinicalNames"]}}, "/Metadata/ClinicalNames_FH"=>{"get"=>{"summary"=>"Retrieve names of CDEs normalized by Firehose and selected for analyses.", "description"=>"This service returns the names of patient-level clinical data elements (CDEs) that have been normalized by Firehose for use in analyses, unioned across all disease cohorts. For more information on how these CDEs are processed, see our pipeline documentation.", "operationId"=>"getMetadataClinicalnamesFh", "x-api-path-slug"=>"metadataclinicalnames-fh-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Format of result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "ClinicalNames", "FH"]}}, "/Metadata/Cohorts"=>{"get"=>{"summary"=>"Translate TCGA cohort abbreviations to full disease names.", "description"=>"By default this function returns a table containing all TCGA cohort abbreviations and their corresponding disease names. A subset of that table may be obtained by explicitly specifying one or more cohort abbreviations.", "operationId"=>"getMetadataCohorts", "x-api-path-slug"=>"metadatacohorts-get", "parameters"=>[{"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "Cohorts"]}}, "/Metadata/Counts"=>{"get"=>{"summary"=>"Retrieve sample counts.", "description"=>"Returns the aliquot counts for each disease cohort, per sample\ntype and data type. The sample type designation of \"Tumor\"\nmay be used to aggregate the count of all tumor aliquots into\na single number per disease and data type. See the SampleTypes\nfunction for a complete description of sample types.", "operationId"=>"getMetadataCounts", "x-api-path-slug"=>"metadatacounts-get", "parameters"=>[{"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"data_type", "description"=>"Narrow search to one or more TCGA data types from the scrollable list"}, {"in"=>"query", "name"=>"date", "description"=>"Select one or more date stamps"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"sample_type", "description"=>"Narrow search to one or more TCGA sample types from the scrollable list"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Which column in the results should be used for sorting paginated results?"}, {"in"=>"query", "name"=>"totals", "description"=>"Output an entry providing the totals for each data type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "Counts"]}}, "/Metadata/Dates"=>{"get"=>{"summary"=>"Retrieve datestamps of all GDAC Firehose standard data and analyses runs that have been ingested into FireBrowse.", "description"=>"Retrieve datestamps of all gdac firehose standard data and analyses runs that have been ingested into firebrowse..", "operationId"=>"getMetadataDates", "x-api-path-slug"=>"metadatadates-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Format of result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "Dates"]}}, "/Metadata/HeartBeat"=>{"get"=>{"summary"=>"Simple way to discern whether API server is up and running", "description"=>"Returns a message to indicate that API (server) is up and running, or times out if not.", "operationId"=>"getMetadataHeartbeat", "x-api-path-slug"=>"metadataheartbeat-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Format of result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "HeartBeat"]}}, "/Metadata/MAFColNames"=>{"get"=>{"summary"=>"Retrieve names of all columns in the mutation annotation files (MAFs) served by FireBrowse.", "description"=>"Retrieve the names of all columns in the mutation annotation files (MAFs) hosted by FireBrowse. For more information on the mutation data, and how it is processed by Firehose, please consult the pipeline documentation.", "operationId"=>"getMetadataMafcolnames", "x-api-path-slug"=>"metadatamafcolnames-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Format of result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "MAFColNames"]}}, "/Metadata/Patients"=>{"get"=>{"summary"=>"Retrieve list of all TCGA patients.", "description"=>"This service returns a list of all TCGA patient barcodes in FireBrowse, optionally filtered by disease cohort. The barcodes are obtained directy from the clinical data.", "operationId"=>"getMetadataPatients", "x-api-path-slug"=>"metadatapatients-get", "parameters"=>[{"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"page", "description"=>"Which page (slice) of entire results set should be returned"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records per page of results"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Which column in the results should be used for sorting paginated results?"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "Patients"]}}, "/Metadata/Platforms"=>{"get"=>{"summary"=>"Translate TCGA platform codes to full platform names.", "description"=>"By default this function returns a table of all of the technology platforms used to sequence or characterize samples in TCGA--both their short platform codes and full names. A subset of this table may be obtained by explicitly specifying one or more platform codes.", "operationId"=>"getMetadataPlatforms", "x-api-path-slug"=>"metadataplatforms-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"platform", "description"=>"Narrow search to one or more TCGA data generation platforms from the scrollable list"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "Platforms"]}}, "/Metadata/SampleType/Barcode/{TCGA_Barcode}"=>{"get"=>{"summary"=>"Given a TCGA barcode, return its short letter sample type code.", "description"=>"Given a tcga barcode, return its short letter sample type code..", "operationId"=>"getMetadataSampletypeBarcodeTcgaBarcode", "x-api-path-slug"=>"metadatasampletypebarcodetcga-barcode-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"path", "name"=>"TCGA_Barcode", "description"=>"Enter a single TCGA barcode, of any form: e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "SampleType", "Barcode", "TCGA", "Barcode"]}}, "/Metadata/SampleType/Code/{code}"=>{"get"=>{"summary"=>"Translate from numeric to symbolic TCGA sample codes.", "description"=>"Convert a TCGA numeric sample type code (e.g. 01, 02) to its corresponding symbolic (short letter) code (e.g. TP, TR).", "operationId"=>"getMetadataSampletypeCodeCode", "x-api-path-slug"=>"metadatasampletypecodecode-get", "parameters"=>[{"in"=>"path", "name"=>"code", "description"=>"Narrow search to one or more TCGA sample type codes"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "SampleType", "Code", "Code"]}}, "/Metadata/SampleType/ShortLetterCode/{short_letter_code}"=>{"get"=>{"summary"=>"Translate from symbolic to numeric TCGA sample codes.", "description"=>"Convert a TCGA sample type code in symbolic form (or 'short letter code' like TP, TR) to its corresponding numeric form (e.g. 01, 02).", "operationId"=>"getMetadataSampletypeShortlettercodeShortLetterCode", "x-api-path-slug"=>"metadatasampletypeshortlettercodeshort-letter-code-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"path", "name"=>"short_letter_code", "description"=>"TCGA sample type short letter code(s) (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "SampleType", "ShortLetterCode", "Short", "Letter", "Code"]}}, "/Metadata/SampleTypes"=>{"get"=>{"summary"=>"Return all TCGA sample type codes, both numeric and symbolic.", "description"=>"Return all tcga sample type codes, both numeric and symbolic..", "operationId"=>"getMetadataSampletypes", "x-api-path-slug"=>"metadatasampletypes-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Format of result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "SampleTypes"]}}, "/Metadata/TSSites"=>{"get"=>{"summary"=>"Obtain identities of tissue source sites in TCGA.", "description"=>"By default this function returns a table of all sites which contributed source tissue to TCGA, aka TSS's. A subset of this table may be obtained by explicitly specifying one or more sites.", "operationId"=>"getMetadataTssites", "x-api-path-slug"=>"metadatatssites-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"tss_code", "description"=>"Narrow search to one or more TSS codes"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metadata", "TSSites"]}}, "/Samples/Clinical"=>{"get"=>{"summary"=>"Retrieve TCGA CDEs verbatim, i.e. not normalized by Firehose.", "description"=>"This service returns patient clinical data from TCGA, verbatim. It differs from the Samples/Clinical_FH method by providing access to all TCGA CDEs in their original form, not merely the subset of CDEs normalized by Firehose for analyses. Results may be selected by disease cohort, patient barcode or CDE name, but at least one cohort, barcode, or CDE must be provided. When filtering by CDE note that only when a patient record contains one or more of the selected CDEs will it be returned. Visit the Metadata/ClinicalNames api function to see the entire list of TCGA CDEs that may be queried via this method. For more information on how clinical data are processed, see our pipeline documentation.", "operationId"=>"getSamplesClinical", "x-api-path-slug"=>"samplesclinical-get", "parameters"=>[{"in"=>"query", "name"=>"cde_name", "description"=>"Retrieve results only for specified CDEs, per the Metadata/ClinicalNames function"}, {"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"page", "description"=>"Which page (slice) of entire results set should be returned"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records per page of results"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Which column in the results should be used for sorting paginated results?"}, {"in"=>"query", "name"=>"tcga_participant_barcode", "description"=>"Comma separated list of TCGA participant barcodes (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Samples", "Clinical"]}}, "/Samples/Clinical_FH"=>{"get"=>{"summary"=>"Retrieve CDEs normalized by Firehose and selected for analyses.", "description"=>"This service returns patient-level clinical data elements (CDEs) that have been normalized by Firehose for use in analyses. Results may be selected by disease cohort, patient barcode or CDE name, but at least one cohort, barcode or CDE must be provided. When filtering by CDE note that only when a patient record contains one or more of the selected CDEs will it be returned. Visit this table of CDEs to see what's available for every disase cohort; for more information on how these CDEs are processed see our pipeline documentation.", "operationId"=>"getSamplesClinicalFh", "x-api-path-slug"=>"samplesclinical-fh-get", "parameters"=>[{"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"fh_cde_name", "description"=>"Retrieve results only for the CDEs specified from the scrollable list"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"page", "description"=>"Which page (slice) of entire results set should be returned"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records per page of results"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Which column in the results should be used for sorting paginated results?"}, {"in"=>"query", "name"=>"tcga_participant_barcode", "description"=>"Comma separated list of TCGA participant barcodes (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Samples", "Clinical", "FH"]}}, "/Samples/mRNASeq"=>{"get"=>{"summary"=>"Retrieve mRNASeq data.", "description"=>"This service returns sample-level log2 mRNASeq expression values. Results may be filtered by gene, cohort, barcode, sample type or characterization protocol, but at least one gene must be supplied.", "operationId"=>"getSamplesMrnaseq", "x-api-path-slug"=>"samplesmrnaseq-get", "parameters"=>[{"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"gene", "description"=>"Comma separated list of gene name(s)"}, {"in"=>"query", "name"=>"page", "description"=>"Which page (slice) of entire results set should be returned"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records per page of results"}, {"in"=>"query", "name"=>"protocol", "description"=>"Narrow search to one or more sample characterization protocols from the scrollable list"}, {"in"=>"query", "name"=>"sample_type", "description"=>"Narrow search to one or more TCGA sample types from the scrollable list"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Which column in the results should be used for sorting paginated results?"}, {"in"=>"query", "name"=>"tcga_participant_barcode", "description"=>"Comma separated list of TCGA participant barcodes (e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Samples", "MRNASeq"]}}, "/Samples/miRSeq"=>{"get"=>{"summary"=>"Retrieve miRSeq data.", "description"=>"This service returns sample-level log2 miRSeq expression values. Results may be filtered by miR, cohort, barcode, sample type or Firehose preprocessing tool, but at least one miR must be supplied.", "operationId"=>"getSamplesMirseq", "x-api-path-slug"=>"samplesmirseq-get", "parameters"=>[{"in"=>"query", "name"=>"cohort", "description"=>"Narrow search to one or more TCGA disease cohorts from the scrollable list"}, {"in"=>"query", "name"=>"format", "description"=>"Format of result"}, {"in"=>"query", "name"=>"mir", "description"=>"Comma separated list of miR names (e"}, {"in"=>"query", "name"=>"page", "description"=>"Which page (slice) of entire results set should be returned"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of records per page of results"}, {"in"=>"query", "name"=>"sample_type", "description"=>"Narrow search to one or more TCGA sample types from the scrollable list"}, {"in"=>"query", "name"=>"sort_by", "description"=>"Which column in the results should be used for sorting paginated results?"}, {"in"=>"query", "name"=>"tcga_participant_barcode", "description"=>"Comma separated list of TCGA participant barcodes (e"}, {"in"=>"query", "name"=>"tool", "description"=>"Narrow search to include only data/results produced by the selected Firehose tool"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Samples", "MiRSeq"]}}}}, "apis"=>{"name"=>"Fire Browse", "x-slug"=>"fire-browse", "description"=>"A simple and elegant way to explore cancer data. Sitting above one of the deepest and most integratively characterized open cancer datasets in the world. Backed by a powerful computational infrastructure, application programming interface (API), graphical tools and online reports. With over 80K sample aliquots from 11,000+ cancer patients, spanning 38 unique disease cohorts.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/firebrowse.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,Cancer,Data Provider,General Data,Profiles", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"fire-browse/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Fire Browse Beta API", "x-api-slug"=>"fire-browse-beta-api", "description"=>"A simple and elegant way to explore cancer data. Sitting above one of the deepest and most integratively characterized open cancer datasets in the world. Backed by a powerful computational infrastructure, application programming interface (API), graphical tools and online reports. With over 80K sample aliquots from 11,000+ cancer patients, spanning 38 unique disease cohorts.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/firebrowse.png", "humanURL"=>"http://firebrowse.org", "baseURL"=>"https://firebrowse.org//api/v1", "tags"=>"API Provider,Cancer,Data Provider,General Data,Profiles", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/fire-browse/samplesmirseq-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/fire-browse/fire-browse-beta-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://firebrowse.org"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bc-laws{"bc-laws-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"BC Laws", "x-complete"=>1, "info"=>{"title"=>"BC Laws", "description"=>"bc-laws-is-an-electronic-library-providing-free-public-access-to-the-laws-of-british-columbia--bc-laws-is-hosted-by-the-queens-printer-of-british-columbia-and-published-in-partnership-with-the-ministry-of-justice-and-the-law-clerk-of-the-legislative-assembly-bc-laws-contains-a-comprehensive-collection-of-bc-legislation-and-related-materials--it-is-available-on-the-internet-in-two-formsfirst-the-library-is-available-as-a-web-site-in-which-users-can-browse-and-search-the-laws-of-british-columbia-second-the-library-is-available-as-a-portal-to-legislation-in-raw-xml-data-format-accessible-via-the-bc-laws-api2--this-direct-access-to-raw-data-is-intended-to-enable-third-parties-to-build-or-add-their-own-custom-applications-based-on-the-structure-of-the-data-and-all-the-associated-search-functionality-inherent-in-that-structure--the-bc-laws-website-itself-is-an-example-of-one-such-application-", "termsOfService"=>"http://www.data.gov.bc.ca/local/dbc/docs/license/API_Terms_of_Use.pdf", "version"=>"1.0.0"}, "host"=>"www.bclaws.ca", "basePath"=>"/civix", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/content/{aspectId}"=>{"get"=>{"summary"=>"Describes the documents and directories available within a specific 'aspect' (content group) of the BCLaws library", "description"=>"Describes the documents and directories available within a specific 'aspect' (content group) of the BCLaws library", "operationId"=>"getContentAspect", "x-api-path-slug"=>"contentaspectid-get", "parameters"=>[{"in"=>"path", "name"=>"aspectId", "description"=>"The identifier of the aspect (content group) to search"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content", "AspectId"]}}, "/content/{aspectId}/{civixDocumentId}"=>{"get"=>{"summary"=>"Lists the metadata available for the specified index or directory from the BCLaws legislative respository", "description"=>"Lists the metadata available for the specified index or directory from the BCLaws legislative respository", "operationId"=>"getContentAspectCivixdocument", "x-api-path-slug"=>"contentaspectidcivixdocumentid-get", "parameters"=>[{"in"=>"path", "name"=>"aspectId", "description"=>"The identifier of the aspect (content group) to search"}, {"in"=>"path", "name"=>"civixDocumentId", "description"=>"The document identification code for an index or directory"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content", "AspectId", "CivixDocumentId"]}}, "/document/id/{aspectId}/{civixIndexId}/{civixDocumentId}"=>{"get"=>{"summary"=>"Retrieves a specific document from the BCLaws legislative repository (HTML format)", "description"=>"The /document API allows you to retrieve actual documents from the BCLaws legislative repository. To retrieve a document from the repository you need the aspect identifier and two other specific pieces of information about the document: the index identifier and the document identifier. These unique identifiers can be retrieved from the /content API.", "operationId"=>"getDocumentAspectCivixindexCivixdocument", "x-api-path-slug"=>"documentidaspectidcivixindexidcivixdocumentid-get", "parameters"=>[{"in"=>"path", "name"=>"aspectId", "description"=>"The identifier of the aspect (content group) to search"}, {"in"=>"path", "name"=>"civixDocumentId", "description"=>"The document identification code for an index or directory"}, {"in"=>"path", "name"=>"civixIndexId", "description"=>"Index identification code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Document", "Id", "AspectId", "CivixIndexId", "CivixDocumentId"]}}, "/document/id/{aspectId}/{civixIndexId}/{civixDocumentId}/search/{searchString}"=>{"get"=>{"summary"=>"Retrieves a specific document from the BCLaws legislative repository with search text highlighted (HTML format)", "description"=>"The /document API allows you to retrieve actual documents from the BCLaws legislative repository. To retrieve a document from the repository you need the aspect identifier and two other specific pieces of information about the document: the index identifier and the document identifier. These unique identifiers can be retrieved from the /content API.", "operationId"=>"getDocumentAspectCivixindexCivixdocumentSearchSearchstring", "x-api-path-slug"=>"documentidaspectidcivixindexidcivixdocumentidsearchsearchstring-get", "parameters"=>[{"in"=>"path", "name"=>"aspectId", "description"=>"The identifier of the aspect (content group) to search"}, {"in"=>"path", "name"=>"civixDocumentId", "description"=>"The document identification code for an index or directory"}, {"in"=>"path", "name"=>"civixIndexId", "description"=>"Index identification code"}, {"in"=>"path", "name"=>"searchString", "description"=>"The text to search for within the document"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Document", "Id", "AspectId", "CivixIndexId", "CivixDocumentId", "Search", "SearchString"]}}, "/document/id/{aspectId}/{civixIndexId}/{civixDocumentId}/xml"=>{"get"=>{"summary"=>"Retrieves a specific document from the BCLaws legislative repository (XML format)", "description"=>"The /document API allows you to retrieve actual documents from the BCLaws legislative repository. To retrieve a document from the repository you need the aspect identifier and two other specific pieces of information about the document: the index identifier and the document identifier. These unique identifiers can be retrieved from the /content API.", "operationId"=>"getDocumentAspectCivixindexCivixdocumentXml", "x-api-path-slug"=>"documentidaspectidcivixindexidcivixdocumentidxml-get", "parameters"=>[{"in"=>"path", "name"=>"aspectId", "description"=>"The identifier of the aspect (content group) to search"}, {"in"=>"path", "name"=>"civixDocumentId", "description"=>"The document identification code for an index or directory"}, {"in"=>"path", "name"=>"civixIndexId", "description"=>"Index identification code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Document", "Id", "AspectId", "CivixIndexId", "CivixDocumentId", "Xml"]}}, "/document/id/{aspectId}/{civixIndexId}/{civixDocumentId}/xml/search/{searchString}"=>{"get"=>{"summary"=>"Retrieves a specific document from the BCLaws legislative repository with search text highlighted (XML format)", "description"=>"The /document API allows you to retrieve actual documents from the BCLaws legislative repository. To retrieve a document from the repository you need the aspect identifier and two other specific pieces of information about the document: the index identifier and the document identifier. These unique identifiers can be retrieved from the /content API.", "operationId"=>"getDocumentAspectCivixindexCivixdocumentXmlSearchSearchstring", "x-api-path-slug"=>"documentidaspectidcivixindexidcivixdocumentidxmlsearchsearchstring-get", "parameters"=>[{"in"=>"path", "name"=>"aspectId", "description"=>"The identifier of the aspect (content group) to search"}, {"in"=>"path", "name"=>"civixDocumentId", "description"=>"The document identification code for an index or directory"}, {"in"=>"path", "name"=>"civixIndexId", "description"=>"Index identification code"}, {"in"=>"path", "name"=>"searchString", "description"=>"The text to search for within the document"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Document", "Id", "AspectId", "CivixIndexId", "CivixDocumentId", "Xml", "Search", "SearchString"]}}, "/search/{aspectId}/fullsearch"=>{"get"=>{"summary"=>"A listing of metadata available for the specified aspect and search term from the BCLaws legislative repository", "description"=>"A listing of metadata available for the specified aspect and search term from the BCLaws legislative repository", "operationId"=>"getSearchAspectFullsearch", "x-api-path-slug"=>"searchaspectidfullsearch-get", "parameters"=>[{"in"=>"path", "name"=>"aspectId", "description"=>"The identifier of the aspect (content group) to search"}, {"in"=>"query", "name"=>"e", "description"=>"last hit (end index)"}, {"in"=>"query", "name"=>"lFrag", "description"=>"length of fragment snippets (< 200)"}, {"in"=>"query", "name"=>"nFrag", "description"=>"number of fragment snippets to return (< 10)"}, {"in"=>"query", "name"=>"q", "description"=>"query term"}, {"in"=>"query", "name"=>"s", "description"=>"first hit (start index)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "AspectId", "Fullsearch"]}}}}, "apis"=>{"name"=>"BC Laws", "x-slug"=>"bc-laws", "description"=>"BC Laws is an electronic library providing free public access to the laws of British Columbia. BC Laws is hosted by the Queen’s Printer of British Columbia and published in partnership with the Ministry of Justice and the Law Clerk of the Legislative Assembly. BC Laws contains a comprehensive collection of BC legislation and related materials. It is available on the internet in two forms: First: The library is available as a web site in which users can browse and search the laws of British Columbia. Second: The library is available as a portal to legislation in raw XML1 data format, accessible via the BC Laws API2. This direct access to raw data is intended to enable third parties to build or add their own custom applications based on the structure of the data and all the associated search functionality inherent in that structure. The BC Laws website itself is an example of one such application.", "image"=>"", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,General Data,Laws,Profiles,State Government", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bc-laws/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"BC Laws", "x-api-slug"=>"bc-laws", "description"=>"BC Laws is an electronic library providing free public access to the laws of British Columbia. BC Laws is hosted by the Queen’s Printer of British Columbia and published in partnership with the Ministry of Justice and the Law Clerk of the Legislative Assembly. BC Laws contains a comprehensive collection of BC legislation and related materials. It is available on the internet in two forms: First: The library is available as a web site in which users can browse and search the laws of British Columbia. Second: The library is available as a portal to legislation in raw XML1 data format, accessible via the BC Laws API2. This direct access to raw data is intended to enable third parties to build or add their own custom applications based on the structure of the data and all the associated search functionality inherent in that structure. The BC Laws website itself is an example of one such application.", "image"=>"", "humanURL"=>"http://bclaws.ca", "baseURL"=>"https://www.bclaws.ca//civix", "tags"=>"API Provider,General Data,Laws,Profiles,State Government", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/bc-laws/searchaspectidfullsearch-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/bc-laws/bc-laws-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://bclaws.ca"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
amadeus{"amadeus-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Amadeus", "x-complete"=>1, "info"=>{"title"=>"Amadeus", "description"=>"amadeus-api-is-a-toolkit-designed-for-travel-agencies-who-want-to-develop-their-own-travel-products-rather-than-using-offtheshelf-solutions--with-this-tool-you-can-build-your-very-own-customised-applications-that-link-in-a-stable-and-secure-dialogue-with-our-global-distribution-system-gds-", "contact"=>{"name"=>"Amadeus Innovation and Research", "url"=>"https://sandbox.amadeus.com"}, "version"=>"1.0.0"}, "host"=>"api.sandbox.amadeus.com", "basePath"=>"/v1.2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/airports/autocomplete"=>{"get"=>{"summary"=>"Get Airports Autocomplete", "description"=>"Using the term parameter and given the start of any word in an airport's official name, a city name, or the start of an IATA code, this API provides the full name and IATA location code of the city or airport, for use in flight searches. Only major cities and civilian airports with several commercial flights per week are included by default. The response provides up to 20 possible matches, sorted by importance, in a JQuery UI Autocomplete compatible format. This sample implementation using JQuery UI may help. This API uses data from the OpenTravelData project.\n \nBy only using the country parameter, this API is also able to find all the IATA location codes associated with a country. Both term and country parameters can be used together to filter the results accordingly. \n\nThe value returned is the IATA location code. The label returned is always in UTF-8 format, with the airport official name (which is often in the native language), in the format of English City Name (if not already included in the airport name).", "operationId"=>"getAirportsAutocomplete", "x-api-path-slug"=>"airportsautocomplete-get", "parameters"=>[{"in"=>"query", "name"=>"all_airports", "description"=>"Boolean to include or not all airports, no matter their traffic rank"}, {"in"=>"query", "name"=>"country", "description"=>"Identified a country based of a ISO 3166-1 alpha-2 code"}, {"in"=>"query", "name"=>"term", "description"=>"Search keyword that should represent the start of a word in a city or airport name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Airlines", "Airports", "Autocomplete"]}}, "/airports/nearest-relevant"=>{"get"=>{"summary"=>"Get Airports Nearest Relevant", "description"=>"This service gives the most relevant airports in a radius of 500 km around the given coordinates. The relevance of an airport is computed by dividing the number of airport movements (take offs and landings) by the distance from the point. This causes the relevance of an airport to increase exponentially as you approach it.\n\nTo minimize response time, all distances are computed as a great-circle distance from the provided coordinates to the airport coordinates, and thus do not take into account traffic conditions, international boundaries, mountains, water, or other elements that might make the a nearby airport hard to reach.\n\nOnly civilian airports with at least several commercial flights per week are included in the results.\n\nThe result is a list of airports sorted by decreasing relevance. It always contains the nearest airport with significant commercial traffic. You can freely download the point of reference information used by this API from the Open Travel Data project.", "operationId"=>"getAirportsNearestRelevant", "x-api-path-slug"=>"airportsnearestrelevant-get", "parameters"=>[{"in"=>"query", "name"=>"latitude", "description"=>"Latitude location to be at the center of your search circle"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude location to be at the center of your search circle"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Airlines", "Airports", "Nearest", "Relevant"]}}, "/cars/search-airport"=>{"get"=>{"summary"=>"Get Cars Search Airport", "description"=>"With this API you can find out the price and type of car, for all car rental providers, near a specified airport.\n\nYou can quickly see the locations of car providers near a given airport, and what cars are available to rent, and at what prices. This API is based on our car pricing service that gets live availability from car providers, and is used to power a variety of airline and travel agency websites.\n \nResults are validated from car providers, and thus response times may take up to 10 seconds (response times are typically about 5s), and the number of concurrent calls is throttled per user to avoid flooding our provider's systems. However, this means the final result is guaranteed to be live and accurate.\n\nThe configuration of this API allows search for car rentals in the rental location where the car is picked up (at the start of the rental), is the same as the one where it will be dropped off.", "operationId"=>"getCarsSearchAirport", "x-api-path-slug"=>"carssearchairport-get", "parameters"=>[{"in"=>"query", "name"=>"currency", "description"=>"The preferred currency to use when displaying prices and rates related to the car rental"}, {"in"=>"query", "name"=>"drop_off", "description"=>"Date at which the car rental will end and the car will be returned to the rental location"}, {"in"=>"query", "name"=>"lang", "description"=>"The preferred language of the content related to each car rental"}, {"in"=>"query", "name"=>"location", "description"=>"The IATA code of the airport at which the car will be rented"}, {"in"=>"query", "name"=>"pick_up", "description"=>"Date on which the car rental will be collected from the car rental location"}, {"in"=>"query", "name"=>"provider", "description"=>"2 character car rental provider code"}, {"in"=>"query", "name"=>"rate_class", "description"=>"Allows to request specific rate types"}, {"in"=>"query", "name"=>"rate_filter", "description"=>"Defines the types of rates to be returned in the output"}, {"in"=>"query", "name"=>"rate_plan", "description"=>"Qualifies the rate depending on the pickup date and the rental duration"}, {"in"=>"query", "name"=>"vehicle", "description"=>"Specifies the type of vehicle to be rented"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cars", "Search", "Airport"]}}, "/cars/search-circle"=>{"get"=>{"summary"=>"Get Cars Search", "description"=>"With this API you can find out the price and type of car, for all car rental providers, in a specified geographical location.\n\nYou can quickly see the locations of car providers near a given point, and what cars are available to rent, and at what prices. This API is based on our car pricing service that gets live availability from car providers, and is used to power a variety of airline and travel agency websites.\n \nResults are validated from car providers, and thus response times may take up to 10 seconds (response times are typically about 5s), and the number of concurrent calls is throttled per user to avoid flooding our provider's systems. However, this means the final result is guaranteed to be live and accurate.\n\nThe configuration of this API allows search for car rentals in the rental location where the car is picked up (at the start of the rental), is the same as the one where it will be dropped off.", "operationId"=>"getCarsSearchCircle", "x-api-path-slug"=>"carssearchcircle-get", "parameters"=>[{"in"=>"query", "name"=>"currency", "description"=>"The preferred currency to use when displaying prices and rates related to the car rental"}, {"in"=>"query", "name"=>"drop_off", "description"=>"Date at which the car rental will end and the car will be returned to the rental location"}, {"in"=>"query", "name"=>"lang", "description"=>"The preferred language of the content related to each car rental"}, {"in"=>"query", "name"=>"latitude", "description"=>"Latitude of the center of the search"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude of the center of the search"}, {"in"=>"query", "name"=>"pick_up", "description"=>"Date on which the car rental will be collected from the car rental location"}, {"in"=>"query", "name"=>"provider", "description"=>"2 character car rental provider code"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius around the center to look for hotels in kilometers (km)"}, {"in"=>"query", "name"=>"rate_class", "description"=>"Allows to request specific rate types"}, {"in"=>"query", "name"=>"rate_filter", "description"=>"Defines the types of rates to be returned in the output"}, {"in"=>"query", "name"=>"rate_plan", "description"=>"Qualifies the rate depending on the pickup date and the rental duration"}, {"in"=>"query", "name"=>"vehicle", "description"=>"Specifies the type of vehicle to be rented"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cars", "Search", "Circle"]}}, "/flights/affiliate-search"=>{"get"=>{"summary"=>"Get Flights Affiliate Search", "description"=>"The Flight Affiliate Search API combines Amadeus' flight search technology with Travel Audience's Connect API partners to provide a unique flight search, where all results come with deep-links to book the flight at a partner's website. The API will let you easily provide the traveler with a path to book flights from your application.\nTravel Audience Connect partners include\n\n CityJet, Air Europa and TAP in Western Europe,\n Ural Airlines in Russia, \n Avianca Brazil and\n JAL in East Asia\n\n\nOnly Travel Audience Connect partner airlines are searched. For an up-to-date list of routes, see the route maps on each partners respective websites above. You can earn commission using the deep links provided in the search results if you sign up for an account at connect.travelaudience.com.", "operationId"=>"getFlightsAffiliateSearch", "x-api-path-slug"=>"flightsaffiliatesearch-get", "parameters"=>[{"in"=>"query", "name"=>"adults", "description"=>"The number of adult (age 12 and over) passengers traveling on this flight"}, {"in"=>"query", "name"=>"children", "description"=>"The number of child (younger than age 12 on date of departure) passengers traveling on this flight who will each have their own separate seat"}, {"in"=>"query", "name"=>"currency", "description"=>"The preferred currency for the results"}, {"in"=>"query", "name"=>"departure_date", "description"=>"The date on which the traveler will depart from the origin to go to the destination"}, {"in"=>"query", "name"=>"destination", "description"=>"IATA code of the city to which the traveler is going"}, {"in"=>"query", "name"=>"exclude_merchants", "description"=>"If specified, no results will include any flights where any of these airlines is the marketing carrier"}, {"in"=>"query", "name"=>"include_merchants", "description"=>"If specified, all results will include at least one flight where one or more of these airlines is the marketing carrier"}, {"in"=>"query", "name"=>"infants", "description"=>"The number of infant (younger than age 2 on date of departure) passengers traveling on this flight"}, {"in"=>"query", "name"=>"max_price", "description"=>"Maximum price of trips to find in the result set, in USD (US dollars) unless some other currency code is specified"}, {"in"=>"query", "name"=>"mobile", "description"=>"Setting this to true will show mobile web deeplinks"}, {"in"=>"query", "name"=>"origin", "description"=>"City code from which the traveler will depart"}, {"in"=>"query", "name"=>"return_date", "description"=>"The date on which the traveler will depart from the destination to return to the origin"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Airlines", "Flights", "Affiliate", "Search"]}}, "/flights/extensive-search"=>{"get"=>{"summary"=>"Get Flights Extensive Search", "description"=>"The Extensive Flight Search allows you to find the prices of one-way or return flights between two airports over a large number of dates, and for a large variety of stay durations. The search doesn't return exact itineraries, but rather tells you the best price for a flight on a given day, for a stay of a given duration.\n\nThe search is based on our Extreme Search platform, which continually caches a large number of flight search results from a list of origin cities to a variety of destinations. Since it's a cached search, the response time is fast, but not all origin airports are available. Here is a list of the currently supported origin-destination IATA location pairs. We try to keep this list as fresh as possible for you, but be aware that it may not always be exactly up-to-date and it can change without warning.\n\nThat said, a price graph like this provides a powerful bargin shopping tool - allowing travelers with flexible itineraries to identify days on which they can get the cheapest flights to their destinations.", "operationId"=>"getFlightsExtensiveSearch", "x-api-path-slug"=>"flightsextensivesearch-get", "parameters"=>[{"in"=>"query", "name"=>"aggregation_mode", "description"=>"Specifies the granularity of results to be found"}, {"in"=>"query", "name"=>"departure_date", "description"=>"Range of dates between which the traveler could depart"}, {"in"=>"query", "name"=>"destination", "description"=>"IATA code of the city to which the traveler is going"}, {"in"=>"query", "name"=>"direct", "description"=>"Limit the search to results that do not require the passenger to change plane?"}, {"in"=>"query", "name"=>"duration", "description"=>"The allowed duration or range of durations of the trip, in days"}, {"in"=>"query", "name"=>"max_price", "description"=>"Maximum price of trips to find in the result set, in the currency specified for this origin and destination pair in the cache contents spreadsheet"}, {"in"=>"query", "name"=>"one-way", "description"=>"When set to true, the query will be for a single trip from the origin to the destination"}, {"in"=>"query", "name"=>"origin", "description"=>"IATA code of the city from which the traveler will depart"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Airlines", "Flights", "Extensive", "Search"]}}, "/flights/inspiration-search"=>{"get"=>{"summary"=>"Get Flights Inspiration Search", "description"=>"The Inspiration Flight Search allows you to find the prices of one-way and return flights from an origin city without necessarily having a destination, or even a flight date, in mind. The search doesn't return a distinct set of price options, but rather, can tell you the price of flying from a given city to some destination, for a trip of a given duration, that falls within a given date range.\n\nThe search is based on our Extreme Search platform, which continually caches a large number of flight search results from a list of origin cities to a variety of destinations. Since it's a cached search, the response time is fast, but not all origin airports are available. Here is a list of the currently supported origin-destination IATA location pairs. We try to keep this list as fresh as possible for you, but be aware that it may not always be exactly up-to-date and it can change without warning.\n\nDespite this limitation don't underestimate the power of this API. Thanks to its quick response speed you can easily pair it with other APIs to provide a low fare and inspiration for any destination. For example, you can could combine it with a event search API and suggest a total price to see go and see an concert or a game in a selection of cities.", "operationId"=>"getFlightsInspirationSearch", "x-api-path-slug"=>"flightsinspirationsearch-get", "parameters"=>[{"in"=>"query", "name"=>"aggregation_mode", "description"=>"Specifies the granularity of results to be found"}, {"in"=>"query", "name"=>"departure_date", "description"=>"Range of dates between which the traveler could depart"}, {"in"=>"query", "name"=>"destination", "description"=>"IATA code of the city to which the traveler is going"}, {"in"=>"query", "name"=>"direct", "description"=>"Limit the search to results that do not require the passenger to change plane?"}, {"in"=>"query", "name"=>"duration", "description"=>"The allowed duration or range of durations of the trip, in days"}, {"in"=>"query", "name"=>"max_price", "description"=>"Maximum price of trips to find in the result set, in the currency specified for this origin and destination pair in the cache contents spreadsheet"}, {"in"=>"query", "name"=>"one-way", "description"=>"When set to true, the query will be for a single trip from the origin to the destination"}, {"in"=>"query", "name"=>"origin", "description"=>"IATA code of the city from which the traveler will depart"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Airlines", "Flights", "Inspiration", "Search"]}}, "/flights/low-fare-search"=>{"get"=>{"summary"=>"Get Flights Low Fare Search", "description"=>"This is the low fare search engine Amadeus uses to retrieve the best price for flights, based on our latest Master Pricer Travel Board technology. This document describes how to make a low fare search and how to handle the returned messages.\n\nThe message is composed of multiple results for given request. A result is defined by a unique combination of price, tax, passenger type, fare type, cabin, and availability for each requested segment. \n\nA result is then composed of single or multiple itineraries. Each itinerary is composed of an outbound leg, and, if a return date was specified, an inbound leg. Each leg is composed of a list of one or more flights, that the traveller will be required to take in order to get from the origin airport to the destination airport.", "operationId"=>"getFlightsLowFareSearch", "x-api-path-slug"=>"flightslowfaresearch-get", "parameters"=>[{"in"=>"query", "name"=>"adults", "description"=>"The number of adult (age 12 and over) passengers traveling on this flight"}, {"in"=>"query", "name"=>"arrive_by", "description"=>"The datetime by which the outbound flight should arrive, based on local time at the destination airport"}, {"in"=>"query", "name"=>"children", "description"=>"The number of child (younger than age 12 on date of departure) passengers traveling on this flight who will each have their own separate seat"}, {"in"=>"query", "name"=>"currency", "description"=>"The preferred currency for the results"}, {"in"=>"query", "name"=>"departure_date", "description"=>"The date on which the traveler will depart from the origin to go to the destination"}, {"in"=>"query", "name"=>"destination", "description"=>"IATA code of the city to which the traveler is going"}, {"in"=>"query", "name"=>"exclude_airlines", "description"=>"If specified, no results will include any flights where any of these airlines is the marketing carrier"}, {"in"=>"query", "name"=>"include_airlines", "description"=>"If specified, all results will include at least one flight where one or more of these airlines is the marketing carrier"}, {"in"=>"query", "name"=>"infants", "description"=>"The number of infant (younger than age 2 on date of departure) passengers traveling on this flight"}, {"in"=>"query", "name"=>"max_price", "description"=>"Maximum price of trips to find in the result set, in USD (US dollars) unless some other currency code is specified"}, {"in"=>"query", "name"=>"nonstop", "description"=>"Setting this to true will find only flights that do not require the passenger to change from one flight to another"}, {"in"=>"query", "name"=>"number_of_results", "description"=>"The number of results to display"}, {"in"=>"query", "name"=>"origin", "description"=>"City code from which the traveler will depart"}, {"in"=>"query", "name"=>"return_by", "description"=>"The time by which the inbound flight should arrive, based on local time at the airport specified as the origin parameter"}, {"in"=>"query", "name"=>"return_date", "description"=>"The date on which the traveler will depart from the destination to return to the origin"}, {"in"=>"query", "name"=>"travel_class", "description"=>"Searches for results where the majority of the itinerary flight time should be in a the specified cabin class or higher"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Airlines", "Flights", "Low", "Fare", "Search"]}}, "/hotels/search-airport"=>{"get"=>{"summary"=>"Get Hotels Search Airport", "description"=>"A fast Hotel shopping API to see which hotels are available in a given area, on a given day and displays their lowest prices. With this API you can find out the price of the cheapest daily rate for all hotels near a given airport.\n\nThis API allows you to quickly see the locations of hotels near a given airport, and what prices in that area look like. Note that hotel images are not available to users outside of Amadeus, as we are not licensed to redistribute them. The API is based on our high-speed hotel pricing cache, which is also used to power the Amadeus Hotel Search Engine application. Results are returned very quickly, response times are generally under 2s. Our cache has great global coverage and is constantly refreshed with the latest prices.", "operationId"=>"getHotelsSearchAirport", "x-api-path-slug"=>"hotelssearchairport-get", "parameters"=>[{"in"=>"query", "name"=>"all_rooms", "description"=>"This option if enabled will return all hotel room rates, not just the lowest room rate"}, {"in"=>"query", "name"=>"amenity", "description"=>"Hotel amenities filter to search narrow down hotels with certain amenities"}, {"in"=>"query", "name"=>"chain", "description"=>"Narrows the hotel search to a given hotel provider"}, {"in"=>"query", "name"=>"check_in", "description"=>"Date on which the guest will begin their stay in the hotel"}, {"in"=>"query", "name"=>"check_out", "description"=>"Date on which the guest will end their stay in the hotel"}, {"in"=>"query", "name"=>"currency", "description"=>"The preferred currency for the results"}, {"in"=>"query", "name"=>"lang", "description"=>"The preferred language of the content related to each hotel"}, {"in"=>"query", "name"=>"location", "description"=>"IATA airport code for hotel availability is required requested"}, {"in"=>"query", "name"=>"max_rate", "description"=>"The maximum amount per night that any hotel in the shopping response should cost"}, {"in"=>"query", "name"=>"number_of_results", "description"=>"The maximum number of hotels to return in the results set"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius around the center to look for hotels in kilometers (km)"}, {"in"=>"query", "name"=>"show_sold_out", "description"=>"This option if enabled will return hotel names and addresses even if rooms are sold out (closed properties)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hotels", "Search", "Airport"]}}, "/hotels/search-box"=>{"get"=>{"summary"=>"Get Hotels Search Box", "description"=>"A fast Hotel shopping API to see which hotels are available in a given area, on a given day and displays their lowest prices. With this API you can find out the price of the cheapest daily rate for all hotels within a specified geographical region.\n\nThis API allows you to quickly see the hotel locations in a region, and what prices in that area look like, as well as the check-in and check-out dates, and get a list of up to 140 properties (names, codes, image, amenities) with their locations and rates. Optional parameters such as currency and maximum rates, amenities or hotel chain codes are also available and can be used to narrow down the results. More optional parameters such as show_sold_out & rooms can be used to show sold out rooms and all available rooms.\n \nThe API is based on our high-speed hotel pricing cache, which is also used to power the Amadeus Hotel Search Engine application. Results are returned very quickly, response times are generally under 2s. Our cache has great global coverage and is constantly refreshed with the latest prices.", "operationId"=>"getHotelsSearchBox", "x-api-path-slug"=>"hotelssearchbox-get", "parameters"=>[{"in"=>"query", "name"=>"all_rooms", "description"=>"This option if enabled will return all hotel room rates, not just the lowest room rate"}, {"in"=>"query", "name"=>"amenity", "description"=>"Hotel amenities filter to search narrow down hotels with certain amenities"}, {"in"=>"query", "name"=>"chain", "description"=>"Narrows the hotel search to a given hotel provider"}, {"in"=>"query", "name"=>"check_in", "description"=>"Date on which the guest will begin their stay in the hotel"}, {"in"=>"query", "name"=>"check_out", "description"=>"Date on which the guest will end their stay in the hotel"}, {"in"=>"query", "name"=>"currency", "description"=>"The preferred currency for the results"}, {"in"=>"query", "name"=>"lang", "description"=>"The preferred language of the content related to each hotel"}, {"in"=>"query", "name"=>"max_rate", "description"=>"The maximum amount per night that any hotel in the shopping response should cost"}, {"in"=>"query", "name"=>"north_east_corner", "description"=>"The coordinates of the north-east corner of the search box"}, {"in"=>"query", "name"=>"number_of_results", "description"=>"The maximum number of hotels to return in the results set"}, {"in"=>"query", "name"=>"show_sold_out", "description"=>"This option if enabled will return hotel names and addresses even if rooms are sold out (closed properties)"}, {"in"=>"query", "name"=>"south_west_corner", "description"=>"The coordinates of the south-west corner of the search box"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hotels", "Search", "Box"]}}, "/hotels/search-circle"=>{"get"=>{"summary"=>"Get Hotels Search Circle", "description"=>"A fast Hotel shopping API to see which hotels are available in a given area, on a given day and displays their lowest prices. With this API you can find out the price of the cheapest daily rate for all hotels within a specified radius of a point.\n\nThis API allows you to quickly see the hotel locations in a region, and what prices in that area look like, as well as the check-in and check-out dates, and get list of up to 140 properties (names, codes, image, amenities) with their locations and rates. Optional parameters such as currency and maximum rates, amenities or hotel chain codes are also available and can be used to narrow down the results. More optional parameters such as show_sold_out & rooms can be used to show sold out rooms and all available rooms. \n\nThe API is based on our high-speed hotel pricing cache, which is also used to power the Amadeus Hotel Search Engine application. Results are returned very quickly, response times are generally under 2s. Our cache has great global coverage and is constantly refreshed with the latest prices.", "operationId"=>"getHotelsSearchCircle", "x-api-path-slug"=>"hotelssearchcircle-get", "parameters"=>[{"in"=>"query", "name"=>"all_rooms", "description"=>"This option if enabled will return all hotel room rates, not just the lowest room rate"}, {"in"=>"query", "name"=>"amenity", "description"=>"Hotel amenities filter to search narrow down hotels with certain amenities"}, {"in"=>"query", "name"=>"chain", "description"=>"Narrows the hotel search to a given hotel provider"}, {"in"=>"query", "name"=>"check_in", "description"=>"Date on which the guest will begin their stay in the hotel"}, {"in"=>"query", "name"=>"check_out", "description"=>"Date on which the guest will end their stay in the hotel"}, {"in"=>"query", "name"=>"currency", "description"=>"The preferred currency for the results"}, {"in"=>"query", "name"=>"lang", "description"=>"The preferred language of the content related to each hotel"}, {"in"=>"query", "name"=>"latitude", "description"=>"Latitude of the center of the search"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude of the center of the search"}, {"in"=>"query", "name"=>"max_rate", "description"=>"The maximum amount per night that any hotel in the shopping response should cost"}, {"in"=>"query", "name"=>"number_of_results", "description"=>"The maximum number of hotels to return in the results set"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius around the center to look for hotels in kilometers (km)"}, {"in"=>"query", "name"=>"show_sold_out", "description"=>"This option if enabled will return hotel names and addresses even if rooms are sold out (closed properties)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hotels", "Search", "Circle"]}}, "/hotels/{property_code}"=>{"get"=>{"summary"=>"Get Hotels Property Code", "description"=>"This API allows you to quickly see the detailed information of a single hotel, including descriptions, address, GPS location, amenities, awards, lowest priced room and all room prices and booking information. \n\nThis API gives you more information on a specific property. Optional parameters such as show_sold_out & rooms can be used to show sold out rooms and all available rooms. \n\nThe API is based on our high-speed hotel pricing cache, which is also used to power the Amadeus Hotel Search Engine application. Results are returned very quickly, response times are generally under 2s. Our cache has great global coverage and is constantly refreshed with the latest prices.", "operationId"=>"getHotelsPropertyCode", "x-api-path-slug"=>"hotelsproperty-code-get", "parameters"=>[{"in"=>"query", "name"=>"all_rooms", "description"=>"This option if enabled will return all hotel room rates, not just the lowest room rate"}, {"in"=>"query", "name"=>"check_in", "description"=>"Date on which the guest will begin their stay in the hotel"}, {"in"=>"query", "name"=>"check_out", "description"=>"Date on which the guest will end their stay in the hotel"}, {"in"=>"query", "name"=>"currency", "description"=>"The preferred currency for the results"}, {"in"=>"query", "name"=>"lang", "description"=>"The preferred language of the content related to each hotel"}, {"in"=>"path", "name"=>"property_code", "description"=>"A Hotel property code based on 2 letter chain code + 3 letter IATA code of the city + 3 char property unique id"}, {"in"=>"query", "name"=>"show_sold_out", "description"=>"This option if enabled will return hotel names and addresses even if rooms are sold out (closed properties)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hotels", "Property", "Code"]}}, "/location/{code}"=>{"get"=>{"summary"=>"Get Location Code", "description"=>"This service retrieves the location information corresponding to a IATA city or airport code.\n\nWhen provided with an IATA code, the service determines whether this code could relate to a city code, an airport code or both. If the city could contain multiple airports, it will return all possible airports that correspond to that city code.\n\nThis API is based on the Amadeus supported Geobases open-source project. If you wish to make your own database with all IATA location information, in order to get faster reponses, you can download the latest raw data from their github page.", "operationId"=>"getLocationCode", "x-api-path-slug"=>"locationcode-get", "parameters"=>[{"in"=>"path", "name"=>"code", "description"=>"IATA location code for which further information is required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Location", "Code"]}}, "/points-of-interest/yapq-search-circle"=>{"get"=>{"summary"=>"Get Points Of Interest Yapq Search Circle", "description"=>"Amadeus has partnered with YapQ to bring you point of interest APIs with the goal of offering you unbiased ratings of landmarks and tourist attractions. YapQ rates places according to their interest on social media and provides Wikipedia content and Geonames ID at a given location. \nYapQ's service indexes millions of points around the world, and provides content in 12 different languages. This allows you to ensure you catch the must-see sights at a specific YapQ supported location.\nEach point of interest comes with links to content, grading information, location and directions to help make discovering your destination easy and fun.\nThis service is still under active development, and the response format may change without warning. We'd be interested in your feedback - send us an email.", "operationId"=>"getPointsOfInterestYapqSearchCircle", "x-api-path-slug"=>"pointsofinterestyapqsearchcircle-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"Filters the resulting points_of_interest to include only results which have a least one category containing the given provided word"}, {"in"=>"query", "name"=>"geonames", "description"=>"Setting this to true includes only points of interest with a geonames ID"}, {"in"=>"query", "name"=>"image_size", "description"=>"The size of the images youd like to see in the response"}, {"in"=>"query", "name"=>"lang", "description"=>"The preferred language of the content related to each point of interest"}, {"in"=>"query", "name"=>"latitude", "description"=>"Latitude of the center of the search, in decimal degrees"}, {"in"=>"query", "name"=>"longitude", "description"=>"Longitude of the center of the search, in decimal degrees"}, {"in"=>"query", "name"=>"number_of_images", "description"=>"Number of images to display"}, {"in"=>"query", "name"=>"number_of_results", "description"=>"The maximum number of points of interest to return in the results set"}, {"in"=>"query", "name"=>"radius", "description"=>"Radius around the center to look for points-of-interest around the given latitude and longitude in kilometers (km)"}, {"in"=>"query", "name"=>"social_media", "description"=>"Enabling this includes images from Instagram in the output results"}, {"in"=>"query", "name"=>"vibes", "description"=>"Includes content that doesnt correspond to an active physical place, but which gives the user some background information, or vibe for the place they are visiting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Points", "Of", "Interest", "Yapq", "Search", "Circle"]}}, "/points-of-interest/yapq-search-text"=>{"get"=>{"summary"=>"Get Points Of Interest Yapq Search Text", "description"=>"Amadeus has partnered with YapQ to bring you point of interest APIs with the goal of offering you unbiased ratings of landmarks and tourist attractions. YapQ rates these points according to their interest on social media and provides Wikipedia content and Geonames ID in a given city. \nYapQ's service indexes millions of points around the world, and provides content in 12 different languages. This allows you to ensure you catch the must-see sights in a YapQ supported city.\nEach point of interest comes with links to content, grading information, location and directions to help make discovering your destination easy and fun.\nThis service is still under active development, and the response format may change without warning. We'd be interested in your feedback - send us an email.", "operationId"=>"getPointsOfInterestYapqSearchText", "x-api-path-slug"=>"pointsofinterestyapqsearchtext-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"Filters the resulting points_of_interest to include only results which have a least one category containing the given provided word"}, {"in"=>"query", "name"=>"city_name", "description"=>"The name of the supported city for which you are searching, in the selected language"}, {"in"=>"query", "name"=>"geonames", "description"=>"Setting this to true includes only points of interest with a geonames ID"}, {"in"=>"query", "name"=>"image_size", "description"=>"The size of the images youd like to see in the response"}, {"in"=>"query", "name"=>"lang", "description"=>"The preferred language of the content related to each point of interest"}, {"in"=>"query", "name"=>"number_of_images", "description"=>"Number of images to display"}, {"in"=>"query", "name"=>"number_of_results", "description"=>"The maximum number of points of interest to return in the results set"}, {"in"=>"query", "name"=>"social_media", "description"=>"Enabling this includes images from Instagram in the output results"}, {"in"=>"query", "name"=>"vibes", "description"=>"Includes content that doesnt correspond to an active physical place, but which gives the user some background information, or vibe for the place they are visiting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Points", "Of", "Interest", "Yapq", "Search", "Text"]}}, "/rail-station/{id}"=>{"get"=>{"summary"=>"Get Rail Station", "description"=>"Get rail station", "operationId"=>"getRailStation", "x-api-path-slug"=>"railstationid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Station ID for which further information is required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rail", "Station"]}}, "/rail-stations/autocomplete"=>{"get"=>{"summary"=>"Get Rail Stations Autocomplete", "description"=>"Given the start of any word in a rail station's official name, as a term, this API provides the full name and rail station ID of a rail station for use in searches. The response provides an array of up to 20 possible matches, sorted by passenger traffic, in a JQuery Autocomplete compatible format.\n\nThe value returned is the UIC station code. The label returned is always in UTF-8 format, with the station's official name (which is often in the native language). Agglomeration station codes may also be returned.\n\nNote that only French and Italian rail stations are supported by the Rail Station Autocomplete API", "operationId"=>"getRailStationsAutocomplete", "x-api-path-slug"=>"railstationsautocomplete-get", "parameters"=>[{"in"=>"query", "name"=>"term", "description"=>"Search term that should represent some part of a station name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rail", "Stations", "Autocomplete"]}}, "/trains/extensive-search"=>{"get"=>{"summary"=>"Get Trains Extensive Search", "description"=>"This API allows you to search trains availability and prices for a single day or date range. It's based on our Rail Instant Search technology, providing you with immediate results from our rail search cache.\n\nThis API has content from SNCF (French trains).\n \nThe content is also restricted to single-leg trips - where a single train takes you directly from the origin to the destination.", "operationId"=>"getTrainsExtensiveSearch", "x-api-path-slug"=>"trainsextensivesearch-get", "parameters"=>[{"in"=>"query", "name"=>"departure_date", "description"=>"The date or range of dates on which you would like to depart from the origin station to go to the destination"}, {"in"=>"query", "name"=>"destination", "description"=>"Identifier of the rail station to which you would like to travel"}, {"in"=>"query", "name"=>"origin", "description"=>"Identifier of the rail station from which you would like to depart"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trains", "Extensive", "Search"]}}, "/trains/schedule-search"=>{"get"=>{"summary"=>"Get Trains Schedule Search", "description"=>"This API allows you to find all the possible destinations in the Rail Instant Search cache (used by Extensive Search above) from a given origin station on a given day. You can use this to help build network maps, journey planners or provide inspiration for rail travel.\n\nThis API has continuous content from SNCF.\nAll the options returned are single-leg trips - where a single train takes you directly from the origin to the destination. In general, only departure dates up to 90 days in the future are supported\n\nCurrently agglomeration stations are not supported", "operationId"=>"getTrainsScheduleSearch", "x-api-path-slug"=>"trainsschedulesearch-get", "parameters"=>[{"in"=>"query", "name"=>"departure_date", "description"=>"The date on which you would like to depart from the origin station to go to the destination"}, {"in"=>"query", "name"=>"origin", "description"=>"Identifier of the rail station where you would like to depart from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Trains", "Schedule", "Search"]}}, "/travel-intelligence/flight-traffic"=>{"get"=>{"summary"=>"Get Travel Intelligence Flight Traffic", "description"=>"The Flight Traffic API lets you find the origin and destination traffic summary between two journey points over a specified period.\nThe search returns number of flights & travelers for each origin and destination, ordered by popularity, for each month specified within the search period. This search can help you answer questions like \"Where are people from Los Angeles traveling to between January and April of 2015?\" or \"Which is the most popular month for New Yorkers to travel last year?\". \nThis search is based on Amadeus' Travel Intelligence Engine, a high performance scalable cloud-based platform, born in the age of Big Data and purposely built for the industry bringing total flexibility and speed to business intelligence for travel. Please see amadeus.com/travelintelligence for more information.", "operationId"=>"getTravelIntelligenceFlightTraffic", "x-api-path-slug"=>"travelintelligenceflighttraffic-get", "parameters"=>[{"in"=>"query", "name"=>"destination", "description"=>"IATA code of the city to which the traveler is going"}, {"in"=>"query", "name"=>"number_of_results_per_period", "description"=>"The maximum number of destinations to return for each period"}, {"in"=>"query", "name"=>"origin", "description"=>"IATA code of the city from which the traveler will depart"}, {"in"=>"query", "name"=>"period", "description"=>"Range of periods for which flight traffic information is required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Airlines", "Travel", "Intelligence", "Flight", "Traffic"]}}, "/travel-intelligence/top-destinations"=>{"get"=>{"summary"=>"Get Travel Intelligence Top Destinations", "description"=>"The Top Flight Destinations API lets you find the most popular flight destinations from an origin during a period. This can help you answer questions like \"Where are most people from Paris going to during the month of September?\" The API is based on estimated flight traffic summary data from two journey points over a specific period. It returns up to 50 results, ordered by popularity, showing number of travelers as well as number of flights.\n\nThis estimated search is based on Amadeus' Travel Intelligence Engine, a high performance scalable cloud-based platform, born in the age of Big Data and purposely built for the industry bringing total flexibility and speed to business intelligence for travel. Please see amadeus.com/travelintelligence for more information.", "operationId"=>"getTravelIntelligenceTopDestinations", "x-api-path-slug"=>"travelintelligencetopdestinations-get", "parameters"=>[{"in"=>"query", "name"=>"number_of_results", "description"=>"The maximum number of destinations to return in the results set"}, {"in"=>"query", "name"=>"origin", "description"=>"IATA code of the city from which the traveler will depart"}, {"in"=>"query", "name"=>"period", "description"=>"Period, in month of the year (YYYY-MM), when consumers are traveling"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Intelligence", "Top", "Destinations"]}}, "/travel-intelligence/top-searches"=>{"get"=>{"summary"=>"Get Travel Intelligence Top Searches", "description"=>"The Top Flight Search allows you to find number of estimated searches from an origin, optionally a destination, within a time period when travelers are performing the searches. \nThe search is based on queries performed from within a country (also refers to as market) and returns up to 50 results, ordered by popularity, showing number of searches for most searched destination with its previous year comparison. This search also shows patterns on how travelers are searching for flights, revealing where, when and for how long they???re planning to travel. See\nTrip Durations(How long are the trips planned for?) and\n Advance Search Period (How long before departures do travelers start searching for their trips?)\n\nThis estimated search is based on Amadeus' Travel Intelligence Engine, a high performance scalable cloud-based platform, born in the age of Big Data and purposely built for the industry bringing total flexibility and speed to business intelligence for travel. Please see amadeus.com/travelintelligence for more information.", "operationId"=>"getTravelIntelligenceTopSearches", "x-api-path-slug"=>"travelintelligencetopsearches-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"2-letter IATA country code of the country where the search queries originates from"}, {"in"=>"query", "name"=>"destination", "description"=>"IATA code of the city to which the traveler is going"}, {"in"=>"query", "name"=>"number_of_results", "description"=>"The maximum number of destinations to return in the results set"}, {"in"=>"query", "name"=>"origin", "description"=>"IATA code of the city from which the traveler will depart"}, {"in"=>"query", "name"=>"period", "description"=>"Period of date (month or year) when consumers are searching to travel"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Intelligence", "Top", "Searches"]}}, "/travel-record/{record_locator}"=>{"get"=>{"summary"=>"Get Travel Record Record Locator", "description"=>"Note: This API requires the use of HTTPS\n\nThis service retrieves a travel record (also sometimes referred to as a PNR) for a given journey when provided with Record Locator to identify a travel record, along with the last name of any traveler who is marked as a passenger on this record.\n\nThe API provides detailed information on a given record, including any air, car, hotel or rail reservations, as well as passenger details, and contact frequent traveler information for each passenger when available. You can use this to provide a wide variety of pre-trip or in-trip services.\n\nNote that this API transmits sensitive personal data about a traveler's journey. We work hard to ensure that we comply with all the legal requirements this entails, and as an application owner, you need to do so too - we don't want you to get in trouble! This paragraph, or anything else in our documentation, does not constitute legal advice, it's just to give you an idea of some of the potential issues that you may encounter. Please check your legal obligations regarding the use of this data before implementing this API\n\nIn most countries, the data in the returned travel record is considered to be the property of the traveler. In order to ensure that you are acting on behalf of the traveler, we require you to provide the traveler's last name in addition to the record locator when you make a call to this API. You should ensure that you have consent from the traveler before retrieving this record, in some countries this is a legal requirement - please respect this appropriately.\n\nOur data center is based in Europe, so there is a legal requirement that you to access this API over a secure connection. If you plan to store the information returned by this API, ensure you comply with storage requirements for European data, in addition to those of your local country. For example, there are strict requirements on the caching of retrieved travel records, so please ensure the cache control HTTP headers in the response are respected.", "operationId"=>"getTravelRecordRecordLocator", "x-api-path-slug"=>"travelrecordrecord-locator-get", "parameters"=>[{"in"=>"query", "name"=>"env", "description"=>"Indicates the Amadeus system from which this record should be retrieved"}, {"in"=>"query", "name"=>"last_name", "description"=>"The last name of any traveler in this record, as written on their identification used for travel"}, {"in"=>"path", "name"=>"record_locator", "description"=>"The Amadeus identifier of the given travel record"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Record", "Record", "Locator"]}}}}, "apis"=>{"name"=>"Amadeus", "x-slug"=>"amadeus", "description"=>"Amadeus travel technology helps businesses connect to the global travel ecosystem, manage operations more effectively and serve travellers better than ever", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28139-sandbox-amadeus-com.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"4309", "tags"=>"Airlines,API Provider,General Data,Hotels,Marketplace,Profiles,Relative Data,Technology,Transportation,Travel", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"amadeus/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Amadeus", "x-api-slug"=>"amadeus", "description"=>"Amadeus travel technology helps businesses connect to the global travel ecosystem, manage operations more effectively and serve travellers better than ever", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28139-sandbox-amadeus-com.jpg", "humanURL"=>"https://amadeus.com", "baseURL"=>"https://api.sandbox.amadeus.com//v1.2", "tags"=>"Airlines,API Provider,General Data,Hotels,Marketplace,Profiles,Relative Data,Technology,Transportation,Travel", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/amadeus/travelrecordrecord-locator-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/amadeus/amadeus-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/amadeus"}, {"type"=>"x-documentation", "url"=>"https://sandbox.amadeus.com/api-catalog"}, {"type"=>"x-github", "url"=>"https://github.com/AmadeusITGroup"}, {"type"=>"x-privacy-policy", "url"=>"http://www.amadeus.com/web/amadeus/en_1A-corporate/Amadeus-Home/Amadeus_IT_Group_SA-Legal-notices-2014/1319560218660-Page-AMAD_Detail_PopUp_Ppal?assetid=1319607040997&assettype=DataProtection_C"}, {"type"=>"x-sandbox", "url"=>"https://sandbox.amadeus.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/amadeusinnov"}, {"type"=>"x-website", "url"=>"https://amadeus.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-doubleclick{"google-doubleclick-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Doubleclick", "x-complete"=>1, "info"=>{"title"=>"Google Doubleclick Merged API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/accounts"=>{"get"=>{"summary"=>"Get Accounts", "description"=>"Retrieves the authenticated user's list of accounts.", "operationId"=>"adexchangebuyer.accounts.list", "x-api-path-slug"=>"accounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Account"]}}, "/accounts/{id}"=>{"get"=>{"summary"=>"Get Account", "description"=>"Gets one account by ID.", "operationId"=>"adexchangebuyer.accounts.get", "x-api-path-slug"=>"accountsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The account id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Account"]}, "patch"=>{"summary"=>"Update Account", "description"=>"Updates an existing account. This method supports patch semantics.", "operationId"=>"adexchangebuyer.accounts.patch", "x-api-path-slug"=>"accountsid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"confirmUnsafeAccountChange", "description"=>"Confirmation for erasing bidder and cookie matching urls"}, {"in"=>"path", "name"=>"id", "description"=>"The account id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Account"]}, "put"=>{"summary"=>"Update Account", "description"=>"Updates an existing account.", "operationId"=>"adexchangebuyer.accounts.update", "x-api-path-slug"=>"accountsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"confirmUnsafeAccountChange", "description"=>"Confirmation for erasing bidder and cookie matching urls"}, {"in"=>"path", "name"=>"id", "description"=>"The account id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Account"]}}, "/billinginfo"=>{"get"=>{"summary"=>"Get Billing Info", "description"=>"Retrieves a list of billing information for all accounts of the authenticated user.", "operationId"=>"adexchangebuyer.billingInfo.list", "x-api-path-slug"=>"billinginfo-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Billing"]}}, "/billinginfo/{accountId}"=>{"get"=>{"summary"=>"Get Billing Info", "description"=>"Returns the billing information for one account specified by account ID.", "operationId"=>"adexchangebuyer.billingInfo.get", "x-api-path-slug"=>"billinginfoaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The account id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Billing"]}}, "/billinginfo/{accountId}/{billingId}"=>{"get"=>{"summary"=>"Get Budget Info", "description"=>"Returns the budget information for the adgroup specified by the accountId and billingId.", "operationId"=>"adexchangebuyer.budget.get", "x-api-path-slug"=>"billinginfoaccountidbillingid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The account id to get the budget information for"}, {"in"=>"path", "name"=>"billingId", "description"=>"The billing id to get the budget information for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Budget"]}, "patch"=>{"summary"=>"Get Budget Amount", "description"=>"Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.", "operationId"=>"adexchangebuyer.budget.patch", "x-api-path-slug"=>"billinginfoaccountidbillingid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The account id associated with the budget being updated"}, {"in"=>"path", "name"=>"billingId", "description"=>"The billing id associated with the budget being updated"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Budget"]}, "put"=>{"summary"=>"Update Budget Amount", "description"=>"Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.", "operationId"=>"adexchangebuyer.budget.update", "x-api-path-slug"=>"billinginfoaccountidbillingid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The account id associated with the budget being updated"}, {"in"=>"path", "name"=>"billingId", "description"=>"The billing id associated with the budget being updated"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Budget"]}}, "/creatives"=>{"get"=>{"summary"=>"Get Creatives", "description"=>"Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.", "operationId"=>"adexchangebuyer.creatives.list", "x-api-path-slug"=>"creatives-get", "parameters"=>[{"in"=>"query", "name"=>"accountId", "description"=>"When specified, only creatives for the given account ids are returned"}, {"in"=>"query", "name"=>"buyerCreativeId", "description"=>"When specified, only creatives for the given buyer creative ids are returned"}, {"in"=>"query", "name"=>"dealsStatusFilter", "description"=>"When specified, only creatives having the given deals status are returned"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of entries returned on one result page"}, {"in"=>"query", "name"=>"openAuctionStatusFilter", "description"=>"When specified, only creatives having the given open auction status are returned"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A continuation token, used to page through ad clients"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative"]}, "post"=>{"summary"=>"Submit Creative", "description"=>"Submit a new creative.", "operationId"=>"adexchangebuyer.creatives.insert", "x-api-path-slug"=>"creatives-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative"]}}, "/creatives/{accountId}/{buyerCreativeId}"=>{"get"=>{"summary"=>"Get Creative Status", "description"=>"Gets the status for a single creative. A creative will be available 30-40 minutes after submission.", "operationId"=>"adexchangebuyer.creatives.get", "x-api-path-slug"=>"creativesaccountidbuyercreativeid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The id for the account that will serve this creative"}, {"in"=>"path", "name"=>"buyerCreativeId", "description"=>"The buyer-specific id for this creative"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative"]}}, "/creatives/{accountId}/{buyerCreativeId}/addDeal/{dealId}"=>{"post"=>{"summary"=>"Create Deal", "description"=>"Add a deal id association for the creative.", "operationId"=>"adexchangebuyer.creatives.addDeal", "x-api-path-slug"=>"creativesaccountidbuyercreativeidadddealdealid-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The id for the account that will serve this creative"}, {"in"=>"path", "name"=>"buyerCreativeId", "description"=>"The buyer-specific id for this creative"}, {"in"=>"path", "name"=>"dealId", "description"=>"The id of the deal id to associate with this creative"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Deal"]}}, "/creatives/{accountId}/{buyerCreativeId}/listDeals"=>{"get"=>{"summary"=>"List Deals", "description"=>"Lists the external deal ids associated with the creative.", "operationId"=>"adexchangebuyer.creatives.listDeals", "x-api-path-slug"=>"creativesaccountidbuyercreativeidlistdeals-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The id for the account that will serve this creative"}, {"in"=>"path", "name"=>"buyerCreativeId", "description"=>"The buyer-specific id for this creative"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Deal"]}}, "/creatives/{accountId}/{buyerCreativeId}/removeDeal/{dealId}"=>{"post"=>{"summary"=>"Remove Deal", "description"=>"Remove a deal id associated with the creative.", "operationId"=>"adexchangebuyer.creatives.removeDeal", "x-api-path-slug"=>"creativesaccountidbuyercreativeidremovedealdealid-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The id for the account that will serve this creative"}, {"in"=>"path", "name"=>"buyerCreativeId", "description"=>"The buyer-specific id for this creative"}, {"in"=>"path", "name"=>"dealId", "description"=>"The id of the deal id to disassociate with this creative"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Deal"]}}, "/performancereport"=>{"get"=>{"summary"=>"Get Performance Report", "description"=>"Retrieves the authenticated user's list of performance metrics.", "operationId"=>"adexchangebuyer.performanceReport.list", "x-api-path-slug"=>"performancereport-get", "parameters"=>[{"in"=>"query", "name"=>"accountId", "description"=>"The account id to get the reports"}, {"in"=>"query", "name"=>"endDateTime", "description"=>"The end time of the report in ISO 8601 timestamp format using UTC"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of entries returned on one result page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A continuation token, used to page through performance reports"}, {"in"=>"query", "name"=>"startDateTime", "description"=>"The start time of the report in ISO 8601 timestamp format using UTC"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Performance Report"]}}, "/pretargetingconfigs/{accountId}"=>{"get"=>{"summary"=>"Get Pretargeting Configs", "description"=>"Retrieves a list of the authenticated user's pretargeting configurations.", "operationId"=>"adexchangebuyer.pretargetingConfig.list", "x-api-path-slug"=>"pretargetingconfigsaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The account id to get the pretargeting configs for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Pretargeting Config"]}, "post"=>{"summary"=>"Update Pretargeting Config", "description"=>"Inserts a new pretargeting configuration.", "operationId"=>"adexchangebuyer.pretargetingConfig.insert", "x-api-path-slug"=>"pretargetingconfigsaccountid-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The account id to insert the pretargeting config for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Pretargeting Config"]}}, "/pretargetingconfigs/{accountId}/{configId}"=>{"delete"=>{"summary"=>"Delete Pretargeting Config", "description"=>"Deletes an existing pretargeting config.", "operationId"=>"adexchangebuyer.pretargetingConfig.delete", "x-api-path-slug"=>"pretargetingconfigsaccountidconfigid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The account id to delete the pretargeting config for"}, {"in"=>"path", "name"=>"configId", "description"=>"The specific id of the configuration to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Pretargeting Config"]}, "get"=>{"summary"=>"Get Pretargeting Config", "description"=>"Gets a specific pretargeting configuration", "operationId"=>"adexchangebuyer.pretargetingConfig.get", "x-api-path-slug"=>"pretargetingconfigsaccountidconfigid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The account id to get the pretargeting config for"}, {"in"=>"path", "name"=>"configId", "description"=>"The specific id of the configuration to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Pretargeting Config"]}, "patch"=>{"summary"=>"Update Pretargeting Config", "description"=>"Updates an existing pretargeting config. This method supports patch semantics.", "operationId"=>"adexchangebuyer.pretargetingConfig.patch", "x-api-path-slug"=>"pretargetingconfigsaccountidconfigid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The account id to update the pretargeting config for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"configId", "description"=>"The specific id of the configuration to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Pretargeting Config"]}, "put"=>{"summary"=>"Update Pretargeting Config", "description"=>"Updates an existing pretargeting config.", "operationId"=>"adexchangebuyer.pretargetingConfig.update", "x-api-path-slug"=>"pretargetingconfigsaccountidconfigid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The account id to update the pretargeting config for"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"configId", "description"=>"The specific id of the configuration to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Pretargeting Config"]}}, "/privateauction/{privateAuctionId}/updateproposal"=>{"post"=>{"summary"=>"Update Proposal", "description"=>"Update a given private auction proposal", "operationId"=>"adexchangebuyer.marketplaceprivateauction.updateproposal", "x-api-path-slug"=>"privateauctionprivateauctionidupdateproposal-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"privateAuctionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Proposal"]}}, "/products/search"=>{"get"=>{"summary"=>"Search", "description"=>"Gets the requested product.", "operationId"=>"adexchangebuyer.products.search", "x-api-path-slug"=>"productssearch-get", "parameters"=>[{"in"=>"query", "name"=>"pqlQuery", "description"=>"The pql query used to query for products"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Search"]}}, "/products/{productId}"=>{"get"=>{"summary"=>"Get Product", "description"=>"Gets the requested product by id.", "operationId"=>"adexchangebuyer.products.get", "x-api-path-slug"=>"productsproductid-get", "parameters"=>[{"in"=>"path", "name"=>"productId", "description"=>"The id for the product to get the head revision for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Product"]}}, "/proposals/insert"=>{"post"=>{"summary"=>"Insert Proposal", "description"=>"Create the given list of proposals", "operationId"=>"adexchangebuyer.proposals.insert", "x-api-path-slug"=>"proposalsinsert-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Proposal"]}}, "/proposals/search"=>{"get"=>{"summary"=>"Search Proposal", "description"=>"Search for proposals using pql query", "operationId"=>"adexchangebuyer.proposals.search", "x-api-path-slug"=>"proposalssearch-get", "parameters"=>[{"in"=>"query", "name"=>"pqlQuery", "description"=>"Query string to retrieve specific proposals"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Proposal"]}}, "/proposals/{proposalId}"=>{"get"=>{"summary"=>"Get Proposal", "description"=>"Get a proposal given its id", "operationId"=>"adexchangebuyer.proposals.get", "x-api-path-slug"=>"proposalsproposalid-get", "parameters"=>[{"in"=>"path", "name"=>"proposalId", "description"=>"Id of the proposal to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Proposal"]}}, "/proposals/{proposalId}/deals"=>{"get"=>{"summary"=>"Get Proposal Deals", "description"=>"List all the deals for a given proposal", "operationId"=>"adexchangebuyer.marketplacedeals.list", "x-api-path-slug"=>"proposalsproposaliddeals-get", "parameters"=>[{"in"=>"query", "name"=>"pqlQuery", "description"=>"Query string to retrieve specific deals"}, {"in"=>"path", "name"=>"proposalId", "description"=>"The proposalId to get deals for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Deal"]}}, "/proposals/{proposalId}/deals/delete"=>{"post"=>{"summary"=>"Delete Proposal Deal", "description"=>"Delete the specified deals from the proposal", "operationId"=>"adexchangebuyer.marketplacedeals.delete", "x-api-path-slug"=>"proposalsproposaliddealsdelete-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"proposalId", "description"=>"The proposalId to delete deals from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Deal"]}}, "/proposals/{proposalId}/deals/insert"=>{"post"=>{"summary"=>"Insert Proposal Deal", "description"=>"Add new deals for the specified proposal", "operationId"=>"adexchangebuyer.marketplacedeals.insert", "x-api-path-slug"=>"proposalsproposaliddealsinsert-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"proposalId", "description"=>"proposalId for which deals need to be added"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Deal"]}}, "/proposals/{proposalId}/deals/update"=>{"post"=>{"summary"=>"Update Proposal Deal", "description"=>"Replaces all the deals in the proposal with the passed in deals", "operationId"=>"adexchangebuyer.marketplacedeals.update", "x-api-path-slug"=>"proposalsproposaliddealsupdate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"proposalId", "description"=>"The proposalId to edit deals on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Deal"]}}, "/proposals/{proposalId}/notes"=>{"get"=>{"summary"=>"Get Proposal Notes", "description"=>"Get all the notes associated with a proposal", "operationId"=>"adexchangebuyer.marketplacenotes.list", "x-api-path-slug"=>"proposalsproposalidnotes-get", "parameters"=>[{"in"=>"query", "name"=>"pqlQuery", "description"=>"Query string to retrieve specific notes"}, {"in"=>"path", "name"=>"proposalId", "description"=>"The proposalId to get notes for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Note"]}}, "/proposals/{proposalId}/notes/insert"=>{"post"=>{"summary"=>"Insert Proposal Notes", "description"=>"Add notes to the proposal", "operationId"=>"adexchangebuyer.marketplacenotes.insert", "x-api-path-slug"=>"proposalsproposalidnotesinsert-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"proposalId", "description"=>"The proposalId to add notes for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Note"]}}, "/proposals/{proposalId}/setupcomplete"=>{"post"=>{"summary"=>"Update Proposal To Complete", "description"=>"Update the given proposal to indicate that setup has been completed.", "operationId"=>"adexchangebuyer.proposals.setupcomplete", "x-api-path-slug"=>"proposalsproposalidsetupcomplete-post", "parameters"=>[{"in"=>"path", "name"=>"proposalId", "description"=>"The proposal id for which the setup is complete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Proposal"]}}, "/proposals/{proposalId}/{revisionNumber}/{updateAction}"=>{"patch"=>{"summary"=>"Update Proposal Revision Number", "description"=>"Update the given proposal. This method supports patch semantics.", "operationId"=>"adexchangebuyer.proposals.patch", "x-api-path-slug"=>"proposalsproposalidrevisionnumberupdateaction-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"proposalId", "description"=>"The proposal id to update"}, {"in"=>"path", "name"=>"revisionNumber", "description"=>"The last known revision number to update"}, {"in"=>"path", "name"=>"updateAction", "description"=>"The proposed action to take on the proposal"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Proposal"]}, "put"=>{"summary"=>"Update Proposal Revision Number", "description"=>"Update the given proposal", "operationId"=>"adexchangebuyer.proposals.update", "x-api-path-slug"=>"proposalsproposalidrevisionnumberupdateaction-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"proposalId", "description"=>"The proposal id to update"}, {"in"=>"path", "name"=>"revisionNumber", "description"=>"The last known revision number to update"}, {"in"=>"path", "name"=>"updateAction", "description"=>"The proposed action to take on the proposal"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Proposal"]}}, "/publisher/{accountId}/profiles"=>{"get"=>{"summary"=>"Get Publish Profiles", "description"=>"Gets the requested publisher profile(s) by publisher accountId.", "operationId"=>"adexchangebuyer.pubprofiles.list", "x-api-path-slug"=>"publisheraccountidprofiles-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The accountId of the publisher to get profiles for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Profile"]}}, "/accounts/{accountId}"=>{"get"=>{"summary"=>"Get Account", "description"=>"Get information about the selected Ad Exchange account.", "operationId"=>"adexchangeseller.accounts.get", "x-api-path-slug"=>"accountsaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account to get information about"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Account"]}}, "/accounts/{accountId}/adclients"=>{"get"=>{"summary"=>"Get Ad Clients", "description"=>"List all ad clients in this Ad Exchange account.", "operationId"=>"adexchangeseller.accounts.adclients.list", "x-api-path-slug"=>"accountsaccountidadclients-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account to which the ad client belongs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of ad clients to include in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A continuation token, used to page through ad clients"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Clients"]}}, "/accounts/{accountId}/adclients/{adClientId}/customchannels"=>{"get"=>{"summary"=>"Get Custom Channels", "description"=>"List all custom channels in the specified ad client for this Ad Exchange account.", "operationId"=>"adexchangeseller.accounts.customchannels.list", "x-api-path-slug"=>"accountsaccountidadclientsadclientidcustomchannels-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account to which the ad client belongs"}, {"in"=>"path", "name"=>"adClientId", "description"=>"Ad client for which to list custom channels"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of custom channels to include in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A continuation token, used to page through custom channels"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Channels"]}}, "/accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}"=>{"get"=>{"summary"=>"Get Custom Channels", "description"=>"Get the specified custom channel from the specified ad client.", "operationId"=>"adexchangeseller.accounts.customchannels.get", "x-api-path-slug"=>"accountsaccountidadclientsadclientidcustomchannelscustomchannelid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account to which the ad client belongs"}, {"in"=>"path", "name"=>"adClientId", "description"=>"Ad client which contains the custom channel"}, {"in"=>"path", "name"=>"customChannelId", "description"=>"Custom channel to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Channels"]}}, "/accounts/{accountId}/adclients/{adClientId}/urlchannels"=>{"get"=>{"summary"=>"Get URL Channels", "description"=>"List all URL channels in the specified ad client for this Ad Exchange account.", "operationId"=>"adexchangeseller.accounts.urlchannels.list", "x-api-path-slug"=>"accountsaccountidadclientsadclientidurlchannels-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account to which the ad client belongs"}, {"in"=>"path", "name"=>"adClientId", "description"=>"Ad client for which to list URL channels"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of URL channels to include in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A continuation token, used to page through URL channels"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Channels"]}}, "/accounts/{accountId}/alerts"=>{"get"=>{"summary"=>"Get Alerts", "description"=>"List the alerts for this Ad Exchange account.", "operationId"=>"adexchangeseller.accounts.alerts.list", "x-api-path-slug"=>"accountsaccountidalerts-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account owning the alerts"}, {"in"=>"query", "name"=>"locale", "description"=>"The locale to use for translating alert messages"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Alert"]}}, "/accounts/{accountId}/metadata/dimensions"=>{"get"=>{"summary"=>"Get Dimensions", "description"=>"List the metadata for the dimensions available to this AdExchange account.", "operationId"=>"adexchangeseller.accounts.metadata.dimensions.list", "x-api-path-slug"=>"accountsaccountidmetadatadimensions-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account with visibility to the dimensions"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Dimension"]}}, "/accounts/{accountId}/metadata/metrics"=>{"get"=>{"summary"=>"Get Metrics", "description"=>"List the metadata for the metrics available to this AdExchange account.", "operationId"=>"adexchangeseller.accounts.metadata.metrics.list", "x-api-path-slug"=>"accountsaccountidmetadatametrics-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account with visibility to the metrics"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Metric"]}}, "/accounts/{accountId}/preferreddeals"=>{"get"=>{"summary"=>"Get Preferred Deals", "description"=>"List the preferred deals for this Ad Exchange account.", "operationId"=>"adexchangeseller.accounts.preferreddeals.list", "x-api-path-slug"=>"accountsaccountidpreferreddeals-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account owning the deals"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Deal"]}}, "/accounts/{accountId}/preferreddeals/{dealId}"=>{"get"=>{"summary"=>"Get Preferred Deal", "description"=>"Get information about the selected Ad Exchange Preferred Deal.", "operationId"=>"adexchangeseller.accounts.preferreddeals.get", "x-api-path-slug"=>"accountsaccountidpreferreddealsdealid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account owning the deal"}, {"in"=>"path", "name"=>"dealId", "description"=>"Preferred deal to get information about"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Deal"]}}, "/accounts/{accountId}/reports"=>{"get"=>{"summary"=>"Get Reports", "description"=>"Generate an Ad Exchange report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.", "operationId"=>"adexchangeseller.accounts.reports.generate", "x-api-path-slug"=>"accountsaccountidreports-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account which owns the generated report"}, {"in"=>"query", "name"=>"dimension", "description"=>"Dimensions to base the report on"}, {"in"=>"query", "name"=>"endDate", "description"=>"End of the date range to report on in YYYY-MM-DD format, inclusive"}, {"in"=>"query", "name"=>"filter", "description"=>"Filters to be run on the report"}, {"in"=>"query", "name"=>"locale", "description"=>"Optional locale to use for translating report output to a local language"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of rows of report data to return"}, {"in"=>"query", "name"=>"metric", "description"=>"Numeric columns to include in the report"}, {"in"=>"query", "name"=>"sort", "description"=>"The name of a dimension or metric to sort the resulting report on, optionally prefixed with + to sort ascending or - to sort descending"}, {"in"=>"query", "name"=>"startDate", "description"=>"Start of the date range to report on in YYYY-MM-DD format, inclusive"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Index of the first row of report data to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}}, "/accounts/{accountId}/reports/saved"=>{"get"=>{"summary"=>"Get Saved Reports", "description"=>"List all saved reports in this Ad Exchange account.", "operationId"=>"adexchangeseller.accounts.reports.saved.list", "x-api-path-slug"=>"accountsaccountidreportssaved-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account owning the saved reports"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of saved reports to include in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A continuation token, used to page through saved reports"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}}, "/accounts/{accountId}/reports/{savedReportId}"=>{"get"=>{"summary"=>"Get Saved Report", "description"=>"Generate an Ad Exchange report based on the saved report ID sent in the query parameters.", "operationId"=>"adexchangeseller.accounts.reports.saved.generate", "x-api-path-slug"=>"accountsaccountidreportssavedreportid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account owning the saved report"}, {"in"=>"query", "name"=>"locale", "description"=>"Optional locale to use for translating report output to a local language"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of rows of report data to return"}, {"in"=>"path", "name"=>"savedReportId", "description"=>"The saved report to retrieve"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Index of the first row of report data to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}}, "/reports/{reportId}/files/{fileId}"=>{"get"=>{"summary"=>"Get Report", "description"=>"Retrieves a report file by its report ID and file ID.", "operationId"=>"dfareporting.files.get", "x-api-path-slug"=>"reportsreportidfilesfileid-get", "parameters"=>[{"in"=>"path", "name"=>"fileId", "description"=>"The ID of the report file"}, {"in"=>"path", "name"=>"reportId", "description"=>"The ID of the report"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}}, "/userprofiles"=>{"get"=>{"summary"=>"Get User Profiles", "description"=>"Retrieves list of user profiles for a user.", "operationId"=>"dfareporting.userProfiles.list", "x-api-path-slug"=>"userprofiles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "User"]}}, "/userprofiles/{profileId}"=>{"get"=>{"summary"=>"Get User Profile", "description"=>"Gets one user profile by ID.", "operationId"=>"dfareporting.userProfiles.get", "x-api-path-slug"=>"userprofilesprofileid-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"The user profile ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "User"]}}, "/userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}"=>{"get"=>{"summary"=>"Get Account Active Ad Summary", "description"=>"Gets the account's active ad summary by account ID.", "operationId"=>"dfareporting.accountActiveAdSummaries.get", "x-api-path-slug"=>"userprofilesprofileidaccountactiveadsummariessummaryaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"path", "name"=>"summaryAccountId", "description"=>"Account ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Ad"]}}, "/userprofiles/{profileId}/accountPermissionGroups"=>{"get"=>{"summary"=>"Get Account Permission Groups", "description"=>"Retrieves the list of account permission groups.", "operationId"=>"dfareporting.accountPermissionGroups.list", "x-api-path-slug"=>"userprofilesprofileidaccountpermissiongroups-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Permissions Group"]}}, "/userprofiles/{profileId}/accountPermissionGroups/{id}"=>{"get"=>{"summary"=>"Get Account Permission Group", "description"=>"Gets one account permission group by ID.", "operationId"=>"dfareporting.accountPermissionGroups.get", "x-api-path-slug"=>"userprofilesprofileidaccountpermissiongroupsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Account permission group ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Permissions Group"]}}, "/userprofiles/{profileId}/accountPermissions"=>{"get"=>{"summary"=>"Get Account Permissions", "description"=>"Retrieves the list of account permissions.", "operationId"=>"dfareporting.accountPermissions.list", "x-api-path-slug"=>"userprofilesprofileidaccountpermissions-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Permissions"]}}, "/userprofiles/{profileId}/accountPermissions/{id}"=>{"get"=>{"summary"=>"Get Account Permissions", "description"=>"Gets one account permission by ID.", "operationId"=>"dfareporting.accountPermissions.get", "x-api-path-slug"=>"userprofilesprofileidaccountpermissionsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Account permission ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Permissions"]}}, "/userprofiles/{profileId}/accountUserProfiles"=>{"get"=>{"summary"=>"Get Account Users", "description"=>"Retrieves a list of account user profiles, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.accountUserProfiles.list", "x-api-path-slug"=>"userprofilesprofileidaccountuserprofiles-get", "parameters"=>[{"in"=>"query", "name"=>"active", "description"=>"Select only active user profiles"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only user profiles with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name, ID or email"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}, {"in"=>"query", "name"=>"subaccountId", "description"=>"Select only user profiles with the specified subaccount ID"}, {"in"=>"query", "name"=>"userRoleId", "description"=>"Select only user profiles with the specified user role ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "User"]}, "patch"=>{"summary"=>"Update Account User", "description"=>"Updates an existing account user profile. This method supports patch semantics.", "operationId"=>"dfareporting.accountUserProfiles.patch", "x-api-path-slug"=>"userprofilesprofileidaccountuserprofiles-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"User profile ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "User"]}, "post"=>{"summary"=>"Add Account User", "description"=>"Inserts a new account user profile.", "operationId"=>"dfareporting.accountUserProfiles.insert", "x-api-path-slug"=>"userprofilesprofileidaccountuserprofiles-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "User"]}, "put"=>{"summary"=>"Update Account User", "description"=>"Updates an existing account user profile.", "operationId"=>"dfareporting.accountUserProfiles.update", "x-api-path-slug"=>"userprofilesprofileidaccountuserprofiles-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "User"]}}, "/userprofiles/{profileId}/accountUserProfiles/{id}"=>{"get"=>{"summary"=>"Get Account User", "description"=>"Gets one account user profile by ID.", "operationId"=>"dfareporting.accountUserProfiles.get", "x-api-path-slug"=>"userprofilesprofileidaccountuserprofilesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"User profile ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "User"]}}, "/userprofiles/{profileId}/accounts"=>{"get"=>{"summary"=>"Get Accounts", "description"=>"Retrieves the list of accounts, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.accounts.list", "x-api-path-slug"=>"userprofilesprofileidaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"active", "description"=>"Select only active accounts"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only accounts with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name or ID"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Account"]}, "patch"=>{"summary"=>"Update Account", "description"=>"Updates an existing account. This method supports patch semantics.", "operationId"=>"dfareporting.accounts.patch", "x-api-path-slug"=>"userprofilesprofileidaccounts-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Account ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Account"]}, "put"=>{"summary"=>"Update Account", "description"=>"Updates an existing account.", "operationId"=>"dfareporting.accounts.update", "x-api-path-slug"=>"userprofilesprofileidaccounts-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Account"]}}, "/userprofiles/{profileId}/accounts/{id}"=>{"get"=>{"summary"=>"Get Account", "description"=>"Gets one account by ID.", "operationId"=>"dfareporting.accounts.get", "x-api-path-slug"=>"userprofilesprofileidaccountsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Account ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Account"]}}, "/userprofiles/{profileId}/ads"=>{"get"=>{"summary"=>"Get Ads", "description"=>"Retrieves a list of ads, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.ads.list", "x-api-path-slug"=>"userprofilesprofileidads-get", "parameters"=>[{"in"=>"query", "name"=>"active", "description"=>"Select only active ads"}, {"in"=>"query", "name"=>"advertiserId", "description"=>"Select only ads with this advertiser ID"}, {"in"=>"query", "name"=>"archived", "description"=>"Select only archived ads"}, {"in"=>"query", "name"=>"audienceSegmentIds", "description"=>"Select only ads with these audience segment IDs"}, {"in"=>"query", "name"=>"campaignIds", "description"=>"Select only ads with these campaign IDs"}, {"in"=>"query", "name"=>"compatibility", "description"=>"Select default ads with the specified compatibility"}, {"in"=>"query", "name"=>"creativeIds", "description"=>"Select only ads with these creative IDs assigned"}, {"in"=>"query", "name"=>"creativeOptimizationConfigurationIds", "description"=>"Select only ads with these creative optimization configuration IDs"}, {"in"=>"query", "name"=>"dynamicClickTracker", "description"=>"Select only dynamic click trackers"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only ads with these IDs"}, {"in"=>"query", "name"=>"landingPageIds", "description"=>"Select only ads with these landing page IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"overriddenEventTagId", "description"=>"Select only ads with this event tag override ID"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"query", "name"=>"placementIds", "description"=>"Select only ads with these placement IDs assigned"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"remarketingListIds", "description"=>"Select only ads whose list targeting expression use these remarketing list IDs"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name or ID"}, {"in"=>"query", "name"=>"sizeIds", "description"=>"Select only ads with these size IDs"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}, {"in"=>"query", "name"=>"sslCompliant", "description"=>"Select only ads that are SSL-compliant"}, {"in"=>"query", "name"=>"sslRequired", "description"=>"Select only ads that require SSL"}, {"in"=>"query", "name"=>"type", "description"=>"Select only ads with these types"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Ad"]}, "patch"=>{"summary"=>"Update Ad", "description"=>"Updates an existing ad. This method supports patch semantics.", "operationId"=>"dfareporting.ads.patch", "x-api-path-slug"=>"userprofilesprofileidads-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Ad ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Ad"]}, "post"=>{"summary"=>"Create Ad", "description"=>"Inserts a new ad.", "operationId"=>"dfareporting.ads.insert", "x-api-path-slug"=>"userprofilesprofileidads-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Ad"]}, "put"=>{"summary"=>"Update Ad", "description"=>"Updates an existing ad.", "operationId"=>"dfareporting.ads.update", "x-api-path-slug"=>"userprofilesprofileidads-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Ad"]}}, "/userprofiles/{profileId}/ads/{id}"=>{"get"=>{"summary"=>"Get Ad", "description"=>"Gets one ad by ID.", "operationId"=>"dfareporting.ads.get", "x-api-path-slug"=>"userprofilesprofileidadsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Ad ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Ad"]}}, "/userprofiles/{profileId}/advertiserGroups"=>{"get"=>{"summary"=>"Get Advertiser Groups", "description"=>"Retrieves a list of advertiser groups, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.advertiserGroups.list", "x-api-path-slug"=>"userprofilesprofileidadvertisergroups-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"Select only advertiser groups with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name or ID"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Advertiser Group"]}, "patch"=>{"summary"=>"Update Advertiser Group", "description"=>"Updates an existing advertiser group. This method supports patch semantics.", "operationId"=>"dfareporting.advertiserGroups.patch", "x-api-path-slug"=>"userprofilesprofileidadvertisergroups-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Advertiser group ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Advertiser Group"]}, "post"=>{"summary"=>"Create Advertiser Group", "description"=>"Inserts a new advertiser group.", "operationId"=>"dfareporting.advertiserGroups.insert", "x-api-path-slug"=>"userprofilesprofileidadvertisergroups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Advertiser Group"]}, "put"=>{"summary"=>"Update Advertiser Group", "description"=>"Updates an existing advertiser group.", "operationId"=>"dfareporting.advertiserGroups.update", "x-api-path-slug"=>"userprofilesprofileidadvertisergroups-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Advertiser Group"]}}, "/userprofiles/{profileId}/advertiserGroups/{id}"=>{"delete"=>{"summary"=>"Update Advertiser Delete", "description"=>"Deletes an existing advertiser group.", "operationId"=>"dfareporting.advertiserGroups.delete", "x-api-path-slug"=>"userprofilesprofileidadvertisergroupsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Advertiser group ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Advertiser Group"]}, "get"=>{"summary"=>"Get Advertiser Group", "description"=>"Gets one advertiser group by ID.", "operationId"=>"dfareporting.advertiserGroups.get", "x-api-path-slug"=>"userprofilesprofileidadvertisergroupsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Advertiser group ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Advertiser Group"]}}, "/userprofiles/{profileId}/advertisers"=>{"get"=>{"summary"=>"Get Advertisers", "description"=>"Retrieves a list of advertisers, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.advertisers.list", "x-api-path-slug"=>"userprofilesprofileidadvertisers-get", "parameters"=>[{"in"=>"query", "name"=>"advertiserGroupIds", "description"=>"Select only advertisers with these advertiser group IDs"}, {"in"=>"query", "name"=>"floodlightConfigurationIds", "description"=>"Select only advertisers with these floodlight configuration IDs"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only advertisers with these IDs"}, {"in"=>"query", "name"=>"includeAdvertisersWithoutGroupsOnly", "description"=>"Select only advertisers which do not belong to any advertiser group"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"onlyParent", "description"=>"Select only advertisers which use another advertisers floodlight configuration"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name or ID"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}, {"in"=>"query", "name"=>"status", "description"=>"Select only advertisers with the specified status"}, {"in"=>"query", "name"=>"subaccountId", "description"=>"Select only advertisers with these subaccount IDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Advertiser"]}, "patch"=>{"summary"=>"Update Advertiser", "description"=>"Updates an existing advertiser. This method supports patch semantics.", "operationId"=>"dfareporting.advertisers.patch", "x-api-path-slug"=>"userprofilesprofileidadvertisers-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Advertiser ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Advertiser"]}, "post"=>{"summary"=>"Create Advertiser", "description"=>"Inserts a new advertiser.", "operationId"=>"dfareporting.advertisers.insert", "x-api-path-slug"=>"userprofilesprofileidadvertisers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Advertiser"]}, "put"=>{"summary"=>"Update Advertiser", "description"=>"Updates an existing advertiser.", "operationId"=>"dfareporting.advertisers.update", "x-api-path-slug"=>"userprofilesprofileidadvertisers-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Advertiser"]}}, "/userprofiles/{profileId}/advertisers/{id}"=>{"get"=>{"summary"=>"Get Advertiser", "description"=>"Gets one advertiser by ID.", "operationId"=>"dfareporting.advertisers.get", "x-api-path-slug"=>"userprofilesprofileidadvertisersid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Advertiser ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Advertiser"]}}, "/userprofiles/{profileId}/browsers"=>{"get"=>{"summary"=>"Get Browsers", "description"=>"Retrieves a list of browsers.", "operationId"=>"dfareporting.browsers.list", "x-api-path-slug"=>"userprofilesprofileidbrowsers-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Browser"]}}, "/userprofiles/{profileId}/campaigns"=>{"get"=>{"summary"=>"Get Campaigns", "description"=>"Retrieves a list of campaigns, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.campaigns.list", "x-api-path-slug"=>"userprofilesprofileidcampaigns-get", "parameters"=>[{"in"=>"query", "name"=>"advertiserGroupIds", "description"=>"Select only campaigns whose advertisers belong to these advertiser groups"}, {"in"=>"query", "name"=>"advertiserIds", "description"=>"Select only campaigns that belong to these advertisers"}, {"in"=>"query", "name"=>"archived", "description"=>"Select only archived campaigns"}, {"in"=>"query", "name"=>"atLeastOneOptimizationActivity", "description"=>"Select only campaigns that have at least one optimization activity"}, {"in"=>"query", "name"=>"excludedIds", "description"=>"Exclude campaigns with these IDs"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only campaigns with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"overriddenEventTagId", "description"=>"Select only campaigns that have overridden this event tag ID"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for campaigns by name or ID"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}, {"in"=>"query", "name"=>"subaccountId", "description"=>"Select only campaigns that belong to this subaccount"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Campaign"]}, "patch"=>{"summary"=>"Update Campaign", "description"=>"Updates an existing campaign. This method supports patch semantics.", "operationId"=>"dfareporting.campaigns.patch", "x-api-path-slug"=>"userprofilesprofileidcampaigns-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Campaign ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Campaign"]}, "post"=>{"summary"=>"Create Campaign", "description"=>"Inserts a new campaign.", "operationId"=>"dfareporting.campaigns.insert", "x-api-path-slug"=>"userprofilesprofileidcampaigns-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"defaultLandingPageName", "description"=>"Default landing page name for this new campaign"}, {"in"=>"query", "name"=>"defaultLandingPageUrl", "description"=>"Default landing page URL for this new campaign"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Campaign"]}, "put"=>{"summary"=>"Update Campaign", "description"=>"Updates an existing campaign.", "operationId"=>"dfareporting.campaigns.update", "x-api-path-slug"=>"userprofilesprofileidcampaigns-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Campaign"]}}, "/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations"=>{"get"=>{"summary"=>"Get Campaign Creatives", "description"=>"Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.", "operationId"=>"dfareporting.campaignCreativeAssociations.list", "x-api-path-slug"=>"userprofilesprofileidcampaignscampaignidcampaigncreativeassociations-get", "parameters"=>[{"in"=>"path", "name"=>"campaignId", "description"=>"Campaign ID in this association"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Campaign Creatives"]}, "post"=>{"summary"=>"Add Campaign Creative", "description"=>"Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.", "operationId"=>"dfareporting.campaignCreativeAssociations.insert", "x-api-path-slug"=>"userprofilesprofileidcampaignscampaignidcampaigncreativeassociations-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"campaignId", "description"=>"Campaign ID in this association"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Campaign Creatives"]}}, "/userprofiles/{profileId}/campaigns/{campaignId}/landingPages"=>{"get"=>{"summary"=>"Get Landing Pages", "description"=>"Retrieves the list of landing pages for the specified campaign.", "operationId"=>"dfareporting.landingPages.list", "x-api-path-slug"=>"userprofilesprofileidcampaignscampaignidlandingpages-get", "parameters"=>[{"in"=>"path", "name"=>"campaignId", "description"=>"Landing page campaign ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Landing Page"]}, "patch"=>{"summary"=>"Update Landing Page", "description"=>"Updates an existing campaign landing page. This method supports patch semantics.", "operationId"=>"dfareporting.landingPages.patch", "x-api-path-slug"=>"userprofilesprofileidcampaignscampaignidlandingpages-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"campaignId", "description"=>"Landing page campaign ID"}, {"in"=>"query", "name"=>"id", "description"=>"Landing page ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Landing Page"]}, "post"=>{"summary"=>"Add Landing Page", "description"=>"Inserts a new landing page for the specified campaign.", "operationId"=>"dfareporting.landingPages.insert", "x-api-path-slug"=>"userprofilesprofileidcampaignscampaignidlandingpages-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"campaignId", "description"=>"Landing page campaign ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Landing Page"]}, "put"=>{"summary"=>"Update Landing Page", "description"=>"Updates an existing campaign landing page.", "operationId"=>"dfareporting.landingPages.update", "x-api-path-slug"=>"userprofilesprofileidcampaignscampaignidlandingpages-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"campaignId", "description"=>"Landing page campaign ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Landing Page"]}}, "/userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}"=>{"delete"=>{"summary"=>"Delete Landing Page", "description"=>"Deletes an existing campaign landing page.", "operationId"=>"dfareporting.landingPages.delete", "x-api-path-slug"=>"userprofilesprofileidcampaignscampaignidlandingpagesid-delete", "parameters"=>[{"in"=>"path", "name"=>"campaignId", "description"=>"Landing page campaign ID"}, {"in"=>"path", "name"=>"id", "description"=>"Landing page ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Landing Page"]}, "get"=>{"summary"=>"Get Landing Page", "description"=>"Gets one campaign landing page by ID.", "operationId"=>"dfareporting.landingPages.get", "x-api-path-slug"=>"userprofilesprofileidcampaignscampaignidlandingpagesid-get", "parameters"=>[{"in"=>"path", "name"=>"campaignId", "description"=>"Landing page campaign ID"}, {"in"=>"path", "name"=>"id", "description"=>"Landing page ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Landing Page"]}}, "/userprofiles/{profileId}/campaigns/{id}"=>{"get"=>{"summary"=>"Get Campaign", "description"=>"Gets one campaign by ID.", "operationId"=>"dfareporting.campaigns.get", "x-api-path-slug"=>"userprofilesprofileidcampaignsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Campaign ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Campaign"]}}, "/userprofiles/{profileId}/changeLogs"=>{"get"=>{"summary"=>"Get Change Logs", "description"=>"Retrieves a list of change logs. This method supports paging.", "operationId"=>"dfareporting.changeLogs.list", "x-api-path-slug"=>"userprofilesprofileidchangelogs-get", "parameters"=>[{"in"=>"query", "name"=>"action", "description"=>"Select only change logs with the specified action"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only change logs with these IDs"}, {"in"=>"query", "name"=>"maxChangeTime", "description"=>"Select only change logs whose change time is before the specified maxChangeTime"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"minChangeTime", "description"=>"Select only change logs whose change time is before the specified minChangeTime"}, {"in"=>"query", "name"=>"objectIds", "description"=>"Select only change logs with these object IDs"}, {"in"=>"query", "name"=>"objectType", "description"=>"Select only change logs with the specified object type"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Select only change logs whose object ID, user name, old or new values match the search string"}, {"in"=>"query", "name"=>"userProfileIds", "description"=>"Select only change logs with these user profile IDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Change Log"]}}, "/userprofiles/{profileId}/changeLogs/{id}"=>{"get"=>{"summary"=>"Get Change Log", "description"=>"Gets one change log by ID.", "operationId"=>"dfareporting.changeLogs.get", "x-api-path-slug"=>"userprofilesprofileidchangelogsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Change log ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Change Log"]}}, "/userprofiles/{profileId}/cities"=>{"get"=>{"summary"=>"Get Cities", "description"=>"Retrieves a list of cities, possibly filtered.", "operationId"=>"dfareporting.cities.list", "x-api-path-slug"=>"userprofilesprofileidcities-get", "parameters"=>[{"in"=>"query", "name"=>"countryDartIds", "description"=>"Select only cities from these countries"}, {"in"=>"query", "name"=>"dartIds", "description"=>"Select only cities with these DART IDs"}, {"in"=>"query", "name"=>"namePrefix", "description"=>"Select only cities with names starting with this prefix"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"regionDartIds", "description"=>"Select only cities from these regions"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "City"]}}, "/userprofiles/{profileId}/connectionTypes"=>{"get"=>{"summary"=>"Get Connection Types", "description"=>"Retrieves a list of connection types.", "operationId"=>"dfareporting.connectionTypes.list", "x-api-path-slug"=>"userprofilesprofileidconnectiontypes-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Connection Type"]}}, "/userprofiles/{profileId}/connectionTypes/{id}"=>{"get"=>{"summary"=>"Get Connection Type", "description"=>"Gets one connection type by ID.", "operationId"=>"dfareporting.connectionTypes.get", "x-api-path-slug"=>"userprofilesprofileidconnectiontypesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Connection type ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Connection Type"]}}, "/userprofiles/{profileId}/contentCategories"=>{"get"=>{"summary"=>"Get Content Categories", "description"=>"Retrieves a list of content categories, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.contentCategories.list", "x-api-path-slug"=>"userprofilesprofileidcontentcategories-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"Select only content categories with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name or ID"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Content Category"]}, "patch"=>{"summary"=>"Get Content Category", "description"=>"Updates an existing content category. This method supports patch semantics.", "operationId"=>"dfareporting.contentCategories.patch", "x-api-path-slug"=>"userprofilesprofileidcontentcategories-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Content category ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Content Category"]}, "post"=>{"summary"=>"Create Content Category", "description"=>"Inserts a new content category.", "operationId"=>"dfareporting.contentCategories.insert", "x-api-path-slug"=>"userprofilesprofileidcontentcategories-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Content Category"]}, "put"=>{"summary"=>"Update Content Category", "description"=>"Updates an existing content category.", "operationId"=>"dfareporting.contentCategories.update", "x-api-path-slug"=>"userprofilesprofileidcontentcategories-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Content Category"]}}, "/userprofiles/{profileId}/contentCategories/{id}"=>{"delete"=>{"summary"=>"Delete Content Category", "description"=>"Deletes an existing content category.", "operationId"=>"dfareporting.contentCategories.delete", "x-api-path-slug"=>"userprofilesprofileidcontentcategoriesid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Content category ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Content Category"]}, "get"=>{"summary"=>"Get Content Category", "description"=>"Gets one content category by ID.", "operationId"=>"dfareporting.contentCategories.get", "x-api-path-slug"=>"userprofilesprofileidcontentcategoriesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Content category ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Content Category"]}}, "/userprofiles/{profileId}/conversions/batchinsert"=>{"post"=>{"summary"=>"Insert Conversions", "description"=>"Inserts conversions.", "operationId"=>"dfareporting.conversions.batchinsert", "x-api-path-slug"=>"userprofilesprofileidconversionsbatchinsert-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Conversion"]}}, "/userprofiles/{profileId}/countries"=>{"get"=>{"summary"=>"Get Countries", "description"=>"Retrieves a list of countries.", "operationId"=>"dfareporting.countries.list", "x-api-path-slug"=>"userprofilesprofileidcountries-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Country"]}}, "/userprofiles/{profileId}/countries/{dartId}"=>{"get"=>{"summary"=>"Get Country", "description"=>"Gets one country by ID.", "operationId"=>"dfareporting.countries.get", "x-api-path-slug"=>"userprofilesprofileidcountriesdartid-get", "parameters"=>[{"in"=>"path", "name"=>"dartId", "description"=>"Country DART ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Country"]}}, "/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"=>{"post"=>{"summary"=>"Insert Creative Asset", "description"=>"Inserts a new creative asset.", "operationId"=>"dfareporting.creativeAssets.insert", "x-api-path-slug"=>"userprofilesprofileidcreativeassetsadvertiseridcreativeassets-post", "parameters"=>[{"in"=>"path", "name"=>"advertiserId", "description"=>"Advertiser ID of this creative"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Asset"]}}, "/userprofiles/{profileId}/creativeFields"=>{"get"=>{"summary"=>"Get Creative Fields", "description"=>"Retrieves a list of creative fields, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.creativeFields.list", "x-api-path-slug"=>"userprofilesprofileidcreativefields-get", "parameters"=>[{"in"=>"query", "name"=>"advertiserIds", "description"=>"Select only creative fields that belong to these advertisers"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only creative fields with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for creative fields by name or ID"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Field"]}, "patch"=>{"summary"=>"Update Creative Fields", "description"=>"Updates an existing creative field. This method supports patch semantics.", "operationId"=>"dfareporting.creativeFields.patch", "x-api-path-slug"=>"userprofilesprofileidcreativefields-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Creative Field ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Field"]}, "post"=>{"summary"=>"Create Creative Fields", "description"=>"Inserts a new creative field.", "operationId"=>"dfareporting.creativeFields.insert", "x-api-path-slug"=>"userprofilesprofileidcreativefields-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Field"]}, "put"=>{"summary"=>"Update Creative Fields", "description"=>"Updates an existing creative field.", "operationId"=>"dfareporting.creativeFields.update", "x-api-path-slug"=>"userprofilesprofileidcreativefields-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Field"]}}, "/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues"=>{"get"=>{"summary"=>"Get Creative Field Values", "description"=>"Retrieves a list of creative field values, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.creativeFieldValues.list", "x-api-path-slug"=>"userprofilesprofileidcreativefieldscreativefieldidcreativefieldvalues-get", "parameters"=>[{"in"=>"path", "name"=>"creativeFieldId", "description"=>"Creative field ID for this creative field value"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only creative field values with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for creative field values by their values"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Field"]}, "patch"=>{"summary"=>"Update Creative Field Value", "description"=>"Updates an existing creative field value. This method supports patch semantics.", "operationId"=>"dfareporting.creativeFieldValues.patch", "x-api-path-slug"=>"userprofilesprofileidcreativefieldscreativefieldidcreativefieldvalues-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"creativeFieldId", "description"=>"Creative field ID for this creative field value"}, {"in"=>"query", "name"=>"id", "description"=>"Creative Field Value ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Field"]}, "post"=>{"summary"=>"Insert Creative Field Value", "description"=>"Inserts a new creative field value.", "operationId"=>"dfareporting.creativeFieldValues.insert", "x-api-path-slug"=>"userprofilesprofileidcreativefieldscreativefieldidcreativefieldvalues-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"creativeFieldId", "description"=>"Creative field ID for this creative field value"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Field"]}, "put"=>{"summary"=>"Update Creative Field Value", "description"=>"Updates an existing creative field value.", "operationId"=>"dfareporting.creativeFieldValues.update", "x-api-path-slug"=>"userprofilesprofileidcreativefieldscreativefieldidcreativefieldvalues-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"creativeFieldId", "description"=>"Creative field ID for this creative field value"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Field"]}}, "/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}"=>{"delete"=>{"summary"=>"Delete Creative Field Value", "description"=>"Deletes an existing creative field value.", "operationId"=>"dfareporting.creativeFieldValues.delete", "x-api-path-slug"=>"userprofilesprofileidcreativefieldscreativefieldidcreativefieldvaluesid-delete", "parameters"=>[{"in"=>"path", "name"=>"creativeFieldId", "description"=>"Creative field ID for this creative field value"}, {"in"=>"path", "name"=>"id", "description"=>"Creative Field Value ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Field"]}, "get"=>{"summary"=>"UpGetdate Creative Field Value", "description"=>"Gets one creative field value by ID.", "operationId"=>"dfareporting.creativeFieldValues.get", "x-api-path-slug"=>"userprofilesprofileidcreativefieldscreativefieldidcreativefieldvaluesid-get", "parameters"=>[{"in"=>"path", "name"=>"creativeFieldId", "description"=>"Creative field ID for this creative field value"}, {"in"=>"path", "name"=>"id", "description"=>"Creative Field Value ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Field"]}}, "/userprofiles/{profileId}/creativeFields/{id}"=>{"delete"=>{"summary"=>"Delete Creative Field", "description"=>"Deletes an existing creative field.", "operationId"=>"dfareporting.creativeFields.delete", "x-api-path-slug"=>"userprofilesprofileidcreativefieldsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Creative Field ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Field"]}, "get"=>{"summary"=>"Get Creative Field", "description"=>"Gets one creative field by ID.", "operationId"=>"dfareporting.creativeFields.get", "x-api-path-slug"=>"userprofilesprofileidcreativefieldsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Creative Field ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Field"]}}, "/userprofiles/{profileId}/creativeGroups"=>{"get"=>{"summary"=>"Get Creative Groups", "description"=>"Retrieves a list of creative groups, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.creativeGroups.list", "x-api-path-slug"=>"userprofilesprofileidcreativegroups-get", "parameters"=>[{"in"=>"query", "name"=>"advertiserIds", "description"=>"Select only creative groups that belong to these advertisers"}, {"in"=>"query", "name"=>"groupNumber", "description"=>"Select only creative groups that belong to this subgroup"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only creative groups with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for creative groups by name or ID"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Group"]}, "patch"=>{"summary"=>"Update Creative Group", "description"=>"Updates an existing creative group. This method supports patch semantics.", "operationId"=>"dfareporting.creativeGroups.patch", "x-api-path-slug"=>"userprofilesprofileidcreativegroups-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Creative group ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Group"]}, "post"=>{"summary"=>"Insert Creative Group", "description"=>"Inserts a new creative group.", "operationId"=>"dfareporting.creativeGroups.insert", "x-api-path-slug"=>"userprofilesprofileidcreativegroups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Group"]}, "put"=>{"summary"=>"Update Creative Group", "description"=>"Updates an existing creative group.", "operationId"=>"dfareporting.creativeGroups.update", "x-api-path-slug"=>"userprofilesprofileidcreativegroups-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Group"]}}, "/userprofiles/{profileId}/creativeGroups/{id}"=>{"get"=>{"summary"=>"Get Creative Group", "description"=>"Gets one creative group by ID.", "operationId"=>"dfareporting.creativeGroups.get", "x-api-path-slug"=>"userprofilesprofileidcreativegroupsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Creative group ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative Group"]}}, "/userprofiles/{profileId}/creatives"=>{"get"=>{"summary"=>"Get Creatives", "description"=>"Retrieves a list of creatives, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.creatives.list", "x-api-path-slug"=>"userprofilesprofileidcreatives-get", "parameters"=>[{"in"=>"query", "name"=>"active", "description"=>"Select only active creatives"}, {"in"=>"query", "name"=>"advertiserId", "description"=>"Select only creatives with this advertiser ID"}, {"in"=>"query", "name"=>"archived", "description"=>"Select only archived creatives"}, {"in"=>"query", "name"=>"campaignId", "description"=>"Select only creatives with this campaign ID"}, {"in"=>"query", "name"=>"companionCreativeIds", "description"=>"Select only in-stream video creatives with these companion IDs"}, {"in"=>"query", "name"=>"creativeFieldIds", "description"=>"Select only creatives with these creative field IDs"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only creatives with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"renderingIds", "description"=>"Select only creatives with these rendering IDs"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name or ID"}, {"in"=>"query", "name"=>"sizeIds", "description"=>"Select only creatives with these size IDs"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}, {"in"=>"query", "name"=>"studioCreativeId", "description"=>"Select only creatives corresponding to this Studio creative ID"}, {"in"=>"query", "name"=>"types", "description"=>"Select only creatives with these creative types"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative"]}, "patch"=>{"summary"=>"Update Creative", "description"=>"Updates an existing creative. This method supports patch semantics.", "operationId"=>"dfareporting.creatives.patch", "x-api-path-slug"=>"userprofilesprofileidcreatives-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Creative ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative"]}, "post"=>{"summary"=>"Insert Creative", "description"=>"Inserts a new creative.", "operationId"=>"dfareporting.creatives.insert", "x-api-path-slug"=>"userprofilesprofileidcreatives-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative"]}, "put"=>{"summary"=>"Update Creative", "description"=>"Updates an existing creative.", "operationId"=>"dfareporting.creatives.update", "x-api-path-slug"=>"userprofilesprofileidcreatives-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative"]}}, "/userprofiles/{profileId}/creatives/{id}"=>{"get"=>{"summary"=>"Get Creative", "description"=>"Gets one creative by ID.", "operationId"=>"dfareporting.creatives.get", "x-api-path-slug"=>"userprofilesprofileidcreativesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Creative ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Creative"]}}, "/userprofiles/{profileId}/dimensionvalues/query"=>{"post"=>{"summary"=>"Get Report Dimension", "description"=>"Retrieves list of report dimension values for a list of filters.", "operationId"=>"dfareporting.dimensionValues.query", "x-api-path-slug"=>"userprofilesprofileiddimensionvaluesquery-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The value of the nextToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"The DFA user profile ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}}, "/userprofiles/{profileId}/directorySiteContacts"=>{"get"=>{"summary"=>"Get Directory Site Contacts", "description"=>"Retrieves a list of directory site contacts, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.directorySiteContacts.list", "x-api-path-slug"=>"userprofilesprofileiddirectorysitecontacts-get", "parameters"=>[{"in"=>"query", "name"=>"directorySiteIds", "description"=>"Select only directory site contacts with these directory site IDs"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only directory site contacts with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name, ID or email"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Contact"]}}, "/userprofiles/{profileId}/directorySiteContacts/{id}"=>{"get"=>{"summary"=>"Get Directory Site Contact", "description"=>"Gets one directory site contact by ID.", "operationId"=>"dfareporting.directorySiteContacts.get", "x-api-path-slug"=>"userprofilesprofileiddirectorysitecontactsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Directory site contact ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Contact"]}}, "/userprofiles/{profileId}/directorySites"=>{"get"=>{"summary"=>"Get Directory Sites", "description"=>"Retrieves a list of directory sites, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.directorySites.list", "x-api-path-slug"=>"userprofilesprofileiddirectorysites-get", "parameters"=>[{"in"=>"query", "name"=>"acceptsInStreamVideoPlacements", "description"=>"This search filter is no longer supported and will have no effect on the results returned"}, {"in"=>"query", "name"=>"acceptsInterstitialPlacements", "description"=>"This search filter is no longer supported and will have no effect on the results returned"}, {"in"=>"query", "name"=>"acceptsPublisherPaidPlacements", "description"=>"Select only directory sites that accept publisher paid placements"}, {"in"=>"query", "name"=>"active", "description"=>"Select only active directory sites"}, {"in"=>"query", "name"=>"countryId", "description"=>"Select only directory sites with this country ID"}, {"in"=>"query", "name"=>"dfp_network_code", "description"=>"Select only directory sites with this DFP network code"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only directory sites with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"query", "name"=>"parentId", "description"=>"Select only directory sites with this parent ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name, ID or URL"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Directory Site"]}, "post"=>{"summary"=>"Insert Directory Site", "description"=>"Inserts a new directory site.", "operationId"=>"dfareporting.directorySites.insert", "x-api-path-slug"=>"userprofilesprofileiddirectorysites-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Directory Site"]}}, "/userprofiles/{profileId}/directorySites/{id}"=>{"get"=>{"summary"=>"Get Directory Site", "description"=>"Gets one directory site by ID.", "operationId"=>"dfareporting.directorySites.get", "x-api-path-slug"=>"userprofilesprofileiddirectorysitesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Directory site ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Directory Site"]}}, "/userprofiles/{profileId}/dynamicTargetingKeys"=>{"get"=>{"summary"=>"Get Dynamic Targeting Keys", "description"=>"Retrieves a list of dynamic targeting keys.", "operationId"=>"dfareporting.dynamicTargetingKeys.list", "x-api-path-slug"=>"userprofilesprofileiddynamictargetingkeys-get", "parameters"=>[{"in"=>"query", "name"=>"advertiserId", "description"=>"Select only dynamic targeting keys whose object has this advertiser ID"}, {"in"=>"query", "name"=>"names", "description"=>"Select only dynamic targeting keys exactly matching these names"}, {"in"=>"query", "name"=>"objectId", "description"=>"Select only dynamic targeting keys with this object ID"}, {"in"=>"query", "name"=>"objectType", "description"=>"Select only dynamic targeting keys with this object type"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Dynamic Targeting Key"]}, "post"=>{"summary"=>"Insert Dynamic Targeting Key", "description"=>"Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.", "operationId"=>"dfareporting.dynamicTargetingKeys.insert", "x-api-path-slug"=>"userprofilesprofileiddynamictargetingkeys-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Dynamic Targeting Key"]}}, "/userprofiles/{profileId}/dynamicTargetingKeys/{objectId}"=>{"delete"=>{"summary"=>"Delete Dynamic Targeting Key", "description"=>"Deletes an existing dynamic targeting key.", "operationId"=>"dfareporting.dynamicTargetingKeys.delete", "x-api-path-slug"=>"userprofilesprofileiddynamictargetingkeysobjectid-delete", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"Name of this dynamic targeting key"}, {"in"=>"path", "name"=>"objectId", "description"=>"ID of the object of this dynamic targeting key"}, {"in"=>"query", "name"=>"objectType", "description"=>"Type of the object of this dynamic targeting key"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Dynamic Targeting Key"]}}, "/userprofiles/{profileId}/eventTags"=>{"get"=>{"summary"=>"Get Event Tags", "description"=>"Retrieves a list of event tags, possibly filtered.", "operationId"=>"dfareporting.eventTags.list", "x-api-path-slug"=>"userprofilesprofileideventtags-get", "parameters"=>[{"in"=>"query", "name"=>"adId", "description"=>"Select only event tags that belong to this ad"}, {"in"=>"query", "name"=>"advertiserId", "description"=>"Select only event tags that belong to this advertiser"}, {"in"=>"query", "name"=>"campaignId", "description"=>"Select only event tags that belong to this campaign"}, {"in"=>"query", "name"=>"definitionsOnly", "description"=>"Examine only the specified campaign or advertisers event tags for matching selector criteria"}, {"in"=>"query", "name"=>"enabled", "description"=>"Select only enabled event tags"}, {"in"=>"query", "name"=>"eventTagTypes", "description"=>"Select only event tags with the specified event tag types"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only event tags with these IDs"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name or ID"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Event Tag"]}, "patch"=>{"summary"=>"Update Event Tag", "description"=>"Updates an existing event tag. This method supports patch semantics.", "operationId"=>"dfareporting.eventTags.patch", "x-api-path-slug"=>"userprofilesprofileideventtags-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Event tag ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Event Tag"]}, "post"=>{"summary"=>"Insert Event Tag", "description"=>"Inserts a new event tag.", "operationId"=>"dfareporting.eventTags.insert", "x-api-path-slug"=>"userprofilesprofileideventtags-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Event Tag"]}, "put"=>{"summary"=>"Update Event Tag", "description"=>"Updates an existing event tag.", "operationId"=>"dfareporting.eventTags.update", "x-api-path-slug"=>"userprofilesprofileideventtags-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Event Tag"]}}, "/userprofiles/{profileId}/eventTags/{id}"=>{"delete"=>{"summary"=>"Delete Event Tag", "description"=>"Deletes an existing event tag.", "operationId"=>"dfareporting.eventTags.delete", "x-api-path-slug"=>"userprofilesprofileideventtagsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Event tag ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Event Tag"]}, "get"=>{"summary"=>"Get Event Tag", "description"=>"Gets one event tag by ID.", "operationId"=>"dfareporting.eventTags.get", "x-api-path-slug"=>"userprofilesprofileideventtagsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Event tag ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Event Tag"]}}, "/userprofiles/{profileId}/files"=>{"get"=>{"summary"=>"Get Files", "description"=>"Lists files for a user profile.", "operationId"=>"dfareporting.files.list", "x-api-path-slug"=>"userprofilesprofileidfiles-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The value of the nextToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"The DFA profile ID"}, {"in"=>"query", "name"=>"scope", "description"=>"The scope that defines which results are returned, default is MINE"}, {"in"=>"query", "name"=>"sortField", "description"=>"The field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is DESCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "File"]}}, "/userprofiles/{profileId}/floodlightActivities"=>{"get"=>{"summary"=>"Get Floodlight Activities", "description"=>"Retrieves a list of floodlight activities, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.floodlightActivities.list", "x-api-path-slug"=>"userprofilesprofileidfloodlightactivities-get", "parameters"=>[{"in"=>"query", "name"=>"advertiserId", "description"=>"Select only floodlight activities for the specified advertiser ID"}, {"in"=>"query", "name"=>"floodlightActivityGroupIds", "description"=>"Select only floodlight activities with the specified floodlight activity group IDs"}, {"in"=>"query", "name"=>"floodlightActivityGroupName", "description"=>"Select only floodlight activities with the specified floodlight activity group name"}, {"in"=>"query", "name"=>"floodlightActivityGroupTagString", "description"=>"Select only floodlight activities with the specified floodlight activity group tag string"}, {"in"=>"query", "name"=>"floodlightActivityGroupType", "description"=>"Select only floodlight activities with the specified floodlight activity group type"}, {"in"=>"query", "name"=>"floodlightConfigurationId", "description"=>"Select only floodlight activities for the specified floodlight configuration ID"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only floodlight activities with the specified IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name or ID"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}, {"in"=>"query", "name"=>"tagString", "description"=>"Select only floodlight activities with the specified tag string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Floodlight Activity"]}, "patch"=>{"summary"=>"Update Floodlight Activity", "description"=>"Updates an existing floodlight activity. This method supports patch semantics.", "operationId"=>"dfareporting.floodlightActivities.patch", "x-api-path-slug"=>"userprofilesprofileidfloodlightactivities-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Floodlight activity ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Floodlight Activity"]}, "post"=>{"summary"=>"Insert Floodlight Activity", "description"=>"Inserts a new floodlight activity.", "operationId"=>"dfareporting.floodlightActivities.insert", "x-api-path-slug"=>"userprofilesprofileidfloodlightactivities-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Floodlight Activity"]}, "put"=>{"summary"=>"Update Floodlight Activity", "description"=>"Updates an existing floodlight activity.", "operationId"=>"dfareporting.floodlightActivities.update", "x-api-path-slug"=>"userprofilesprofileidfloodlightactivities-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Floodlight Activity"]}}, "/userprofiles/{profileId}/floodlightActivities/generatetag"=>{"post"=>{"summary"=>"Generate Tag for Floodlight Activity", "description"=>"Generates a tag for a floodlight activity.", "operationId"=>"dfareporting.floodlightActivities.generatetag", "x-api-path-slug"=>"userprofilesprofileidfloodlightactivitiesgeneratetag-post", "parameters"=>[{"in"=>"query", "name"=>"floodlightActivityId", "description"=>"Floodlight activity ID for which we want to generate a tag"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Floodlight Activity"]}}, "/userprofiles/{profileId}/floodlightActivities/{id}"=>{"delete"=>{"summary"=>"Delete Floodlight Activity", "description"=>"Deletes an existing floodlight activity.", "operationId"=>"dfareporting.floodlightActivities.delete", "x-api-path-slug"=>"userprofilesprofileidfloodlightactivitiesid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Floodlight activity ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Floodlight Activity"]}, "get"=>{"summary"=>"Get Floodlight Activity", "description"=>"Gets one floodlight activity by ID.", "operationId"=>"dfareporting.floodlightActivities.get", "x-api-path-slug"=>"userprofilesprofileidfloodlightactivitiesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Floodlight activity ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Floodlight Activity"]}}, "/userprofiles/{profileId}/floodlightActivityGroups"=>{"get"=>{"summary"=>"Get Floodlight Activity Groups", "description"=>"Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.floodlightActivityGroups.list", "x-api-path-slug"=>"userprofilesprofileidfloodlightactivitygroups-get", "parameters"=>[{"in"=>"query", "name"=>"advertiserId", "description"=>"Select only floodlight activity groups with the specified advertiser ID"}, {"in"=>"query", "name"=>"floodlightConfigurationId", "description"=>"Select only floodlight activity groups with the specified floodlight configuration ID"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only floodlight activity groups with the specified IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name or ID"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}, {"in"=>"query", "name"=>"type", "description"=>"Select only floodlight activity groups with the specified floodlight activity group type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Floodlight Activity Group"]}, "patch"=>{"summary"=>"Update Floodlight Activity Group", "description"=>"Updates an existing floodlight activity group. This method supports patch semantics.", "operationId"=>"dfareporting.floodlightActivityGroups.patch", "x-api-path-slug"=>"userprofilesprofileidfloodlightactivitygroups-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Floodlight activity Group ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Floodlight Activity Group"]}, "post"=>{"summary"=>"Create Floodlight Activity Group", "description"=>"Inserts a new floodlight activity group.", "operationId"=>"dfareporting.floodlightActivityGroups.insert", "x-api-path-slug"=>"userprofilesprofileidfloodlightactivitygroups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Floodlight Activity Group"]}, "put"=>{"summary"=>"Update Floodlight Activity Group", "description"=>"Updates an existing floodlight activity group.", "operationId"=>"dfareporting.floodlightActivityGroups.update", "x-api-path-slug"=>"userprofilesprofileidfloodlightactivitygroups-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Floodlight Activity Group"]}}, "/userprofiles/{profileId}/floodlightActivityGroups/{id}"=>{"get"=>{"summary"=>"Get Floodlight Activity Group", "description"=>"Gets one floodlight activity group by ID.", "operationId"=>"dfareporting.floodlightActivityGroups.get", "x-api-path-slug"=>"userprofilesprofileidfloodlightactivitygroupsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Floodlight activity Group ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Floodlight Activity Group"]}}, "/userprofiles/{profileId}/floodlightConfigurations"=>{"get"=>{"summary"=>"Get Floodlight Configurations", "description"=>"Retrieves a list of floodlight configurations, possibly filtered.", "operationId"=>"dfareporting.floodlightConfigurations.list", "x-api-path-slug"=>"userprofilesprofileidfloodlightconfigurations-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"Set of IDs of floodlight configurations to retrieve"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Floodlight Activity Group"]}, "patch"=>{"summary"=>"Update Floodlight Configuration", "description"=>"Updates an existing floodlight configuration. This method supports patch semantics.", "operationId"=>"dfareporting.floodlightConfigurations.patch", "x-api-path-slug"=>"userprofilesprofileidfloodlightconfigurations-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Floodlight configuration ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Floodlight"]}, "put"=>{"summary"=>"Update Floodlight Configuration", "description"=>"Updates an existing floodlight configuration.", "operationId"=>"dfareporting.floodlightConfigurations.update", "x-api-path-slug"=>"userprofilesprofileidfloodlightconfigurations-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Floodlight"]}}, "/userprofiles/{profileId}/floodlightConfigurations/{id}"=>{"get"=>{"summary"=>"Get Floodlight Configuration", "description"=>"Gets one floodlight configuration by ID.", "operationId"=>"dfareporting.floodlightConfigurations.get", "x-api-path-slug"=>"userprofilesprofileidfloodlightconfigurationsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Floodlight configuration ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Floodlight"]}}, "/userprofiles/{profileId}/languages"=>{"get"=>{"summary"=>"Get Languages", "description"=>"Retrieves a list of languages.", "operationId"=>"dfareporting.languages.list", "x-api-path-slug"=>"userprofilesprofileidlanguages-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Language"]}}, "/userprofiles/{profileId}/metros"=>{"get"=>{"summary"=>"Get Metros", "description"=>"Retrieves a list of metros.", "operationId"=>"dfareporting.metros.list", "x-api-path-slug"=>"userprofilesprofileidmetros-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Metro"]}}, "/userprofiles/{profileId}/mobileCarriers"=>{"get"=>{"summary"=>"Get Mobile Carriers", "description"=>"Retrieves a list of mobile carriers.", "operationId"=>"dfareporting.mobileCarriers.list", "x-api-path-slug"=>"userprofilesprofileidmobilecarriers-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Mobile Carrier"]}}, "/userprofiles/{profileId}/mobileCarriers/{id}"=>{"get"=>{"summary"=>"Get Mobile Carrier", "description"=>"Gets one mobile carrier by ID.", "operationId"=>"dfareporting.mobileCarriers.get", "x-api-path-slug"=>"userprofilesprofileidmobilecarriersid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Mobile carrier ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Mobile Carrier"]}}, "/userprofiles/{profileId}/operatingSystemVersions"=>{"get"=>{"summary"=>"Get Operating System Versions", "description"=>"Retrieves a list of operating system versions.", "operationId"=>"dfareporting.operatingSystemVersions.list", "x-api-path-slug"=>"userprofilesprofileidoperatingsystemversions-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Operating System"]}}, "/userprofiles/{profileId}/operatingSystemVersions/{id}"=>{"get"=>{"summary"=>"Get Operating System Version", "description"=>"Gets one operating system version by ID.", "operationId"=>"dfareporting.operatingSystemVersions.get", "x-api-path-slug"=>"userprofilesprofileidoperatingsystemversionsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Operating system version ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Operating System"]}}, "/userprofiles/{profileId}/operatingSystems"=>{"get"=>{"summary"=>"Get Operating Systems", "description"=>"Retrieves a list of operating systems.", "operationId"=>"dfareporting.operatingSystems.list", "x-api-path-slug"=>"userprofilesprofileidoperatingsystems-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Operating System"]}}, "/userprofiles/{profileId}/operatingSystems/{dartId}"=>{"get"=>{"summary"=>"Get Operating System", "description"=>"Gets one operating system by DART ID.", "operationId"=>"dfareporting.operatingSystems.get", "x-api-path-slug"=>"userprofilesprofileidoperatingsystemsdartid-get", "parameters"=>[{"in"=>"path", "name"=>"dartId", "description"=>"Operating system DART ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Operating System"]}}, "/userprofiles/{profileId}/placementGroups"=>{"get"=>{"summary"=>"Get Placement Groups", "description"=>"Retrieves a list of placement groups, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.placementGroups.list", "x-api-path-slug"=>"userprofilesprofileidplacementgroups-get", "parameters"=>[{"in"=>"query", "name"=>"advertiserIds", "description"=>"Select only placement groups that belong to these advertisers"}, {"in"=>"query", "name"=>"archived", "description"=>"Select only archived placements"}, {"in"=>"query", "name"=>"campaignIds", "description"=>"Select only placement groups that belong to these campaigns"}, {"in"=>"query", "name"=>"contentCategoryIds", "description"=>"Select only placement groups that are associated with these content categories"}, {"in"=>"query", "name"=>"directorySiteIds", "description"=>"Select only placement groups that are associated with these directory sites"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only placement groups with these IDs"}, {"in"=>"query", "name"=>"maxEndDate", "description"=>"Select only placements or placement groups whose end date is on or before the specified maxEndDate"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"maxStartDate", "description"=>"Select only placements or placement groups whose start date is on or before the specified maxStartDate"}, {"in"=>"query", "name"=>"minEndDate", "description"=>"Select only placements or placement groups whose end date is on or after the specified minEndDate"}, {"in"=>"query", "name"=>"minStartDate", "description"=>"Select only placements or placement groups whose start date is on or after the specified minStartDate"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"query", "name"=>"placementGroupType", "description"=>"Select only placement groups belonging with this group type"}, {"in"=>"query", "name"=>"placementStrategyIds", "description"=>"Select only placement groups that are associated with these placement strategies"}, {"in"=>"query", "name"=>"pricingTypes", "description"=>"Select only placement groups with these pricing types"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for placement groups by name or ID"}, {"in"=>"query", "name"=>"siteIds", "description"=>"Select only placement groups that are associated with these sites"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement Group"]}, "patch"=>{"summary"=>"Update Placement Group", "description"=>"Updates an existing placement group. This method supports patch semantics.", "operationId"=>"dfareporting.placementGroups.patch", "x-api-path-slug"=>"userprofilesprofileidplacementgroups-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Placement group ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement Group"]}, "post"=>{"summary"=>"Insert Placement Group", "description"=>"Inserts a new placement group.", "operationId"=>"dfareporting.placementGroups.insert", "x-api-path-slug"=>"userprofilesprofileidplacementgroups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement Group"]}, "put"=>{"summary"=>"Update Placement Group", "description"=>"Updates an existing placement group.", "operationId"=>"dfareporting.placementGroups.update", "x-api-path-slug"=>"userprofilesprofileidplacementgroups-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement Group"]}}, "/userprofiles/{profileId}/placementGroups/{id}"=>{"get"=>{"summary"=>"Get Placement Group", "description"=>"Gets one placement group by ID.", "operationId"=>"dfareporting.placementGroups.get", "x-api-path-slug"=>"userprofilesprofileidplacementgroupsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Placement group ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement Group"]}}, "/userprofiles/{profileId}/placementStrategies"=>{"get"=>{"summary"=>"Get Placement Strategies", "description"=>"Retrieves a list of placement strategies, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.placementStrategies.list", "x-api-path-slug"=>"userprofilesprofileidplacementstrategies-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"Select only placement strategies with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name or ID"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement Strategy"]}, "patch"=>{"summary"=>"Update Placement Strategy", "description"=>"Updates an existing placement strategy. This method supports patch semantics.", "operationId"=>"dfareporting.placementStrategies.patch", "x-api-path-slug"=>"userprofilesprofileidplacementstrategies-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Placement strategy ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement Strategy"]}, "post"=>{"summary"=>"Insert Placement Strategy", "description"=>"Inserts a new placement strategy.", "operationId"=>"dfareporting.placementStrategies.insert", "x-api-path-slug"=>"userprofilesprofileidplacementstrategies-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement Strategy"]}, "put"=>{"summary"=>"Update Placement Strategy", "description"=>"Updates an existing placement strategy.", "operationId"=>"dfareporting.placementStrategies.update", "x-api-path-slug"=>"userprofilesprofileidplacementstrategies-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement Strategy"]}}, "/userprofiles/{profileId}/placementStrategies/{id}"=>{"delete"=>{"summary"=>"Delete Placement Strategy", "description"=>"Deletes an existing placement strategy.", "operationId"=>"dfareporting.placementStrategies.delete", "x-api-path-slug"=>"userprofilesprofileidplacementstrategiesid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Placement strategy ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement Strategy"]}, "get"=>{"summary"=>"Get Placement Strategy", "description"=>"Gets one placement strategy by ID.", "operationId"=>"dfareporting.placementStrategies.get", "x-api-path-slug"=>"userprofilesprofileidplacementstrategiesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Placement strategy ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement Strategy"]}}, "/userprofiles/{profileId}/placements"=>{"get"=>{"summary"=>"Get Placements", "description"=>"Retrieves a list of placements, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.placements.list", "x-api-path-slug"=>"userprofilesprofileidplacements-get", "parameters"=>[{"in"=>"query", "name"=>"advertiserIds", "description"=>"Select only placements that belong to these advertisers"}, {"in"=>"query", "name"=>"archived", "description"=>"Select only archived placements"}, {"in"=>"query", "name"=>"campaignIds", "description"=>"Select only placements that belong to these campaigns"}, {"in"=>"query", "name"=>"compatibilities", "description"=>"Select only placements that are associated with these compatibilities"}, {"in"=>"query", "name"=>"contentCategoryIds", "description"=>"Select only placements that are associated with these content categories"}, {"in"=>"query", "name"=>"directorySiteIds", "description"=>"Select only placements that are associated with these directory sites"}, {"in"=>"query", "name"=>"groupIds", "description"=>"Select only placements that belong to these placement groups"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only placements with these IDs"}, {"in"=>"query", "name"=>"maxEndDate", "description"=>"Select only placements or placement groups whose end date is on or before the specified maxEndDate"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"maxStartDate", "description"=>"Select only placements or placement groups whose start date is on or before the specified maxStartDate"}, {"in"=>"query", "name"=>"minEndDate", "description"=>"Select only placements or placement groups whose end date is on or after the specified minEndDate"}, {"in"=>"query", "name"=>"minStartDate", "description"=>"Select only placements or placement groups whose start date is on or after the specified minStartDate"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"query", "name"=>"paymentSource", "description"=>"Select only placements with this payment source"}, {"in"=>"query", "name"=>"placementStrategyIds", "description"=>"Select only placements that are associated with these placement strategies"}, {"in"=>"query", "name"=>"pricingTypes", "description"=>"Select only placements with these pricing types"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for placements by name or ID"}, {"in"=>"query", "name"=>"siteIds", "description"=>"Select only placements that are associated with these sites"}, {"in"=>"query", "name"=>"sizeIds", "description"=>"Select only placements that are associated with these sizes"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement"]}, "patch"=>{"summary"=>"Update Placement", "description"=>"Updates an existing placement. This method supports patch semantics.", "operationId"=>"dfareporting.placements.patch", "x-api-path-slug"=>"userprofilesprofileidplacements-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Placement ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement"]}, "post"=>{"summary"=>"Insert Placement", "description"=>"Inserts a new placement.", "operationId"=>"dfareporting.placements.insert", "x-api-path-slug"=>"userprofilesprofileidplacements-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement"]}, "put"=>{"summary"=>"Update Placement", "description"=>"Updates an existing placement.", "operationId"=>"dfareporting.placements.update", "x-api-path-slug"=>"userprofilesprofileidplacements-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement"]}}, "/userprofiles/{profileId}/placements/generatetags"=>{"post"=>{"summary"=>"Generate Placement Tag", "description"=>"Generates tags for a placement.", "operationId"=>"dfareporting.placements.generatetags", "x-api-path-slug"=>"userprofilesprofileidplacementsgeneratetags-post", "parameters"=>[{"in"=>"query", "name"=>"campaignId", "description"=>"Generate placements belonging to this campaign"}, {"in"=>"query", "name"=>"placementIds", "description"=>"Generate tags for these placements"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"tagFormats", "description"=>"Tag formats to generate for these placements"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement"]}}, "/userprofiles/{profileId}/placements/{id}"=>{"get"=>{"summary"=>"Get Placement", "description"=>"Gets one placement by ID.", "operationId"=>"dfareporting.placements.get", "x-api-path-slug"=>"userprofilesprofileidplacementsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Placement ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement"]}}, "/userprofiles/{profileId}/platformTypes"=>{"get"=>{"summary"=>"Get Platform Types", "description"=>"Retrieves a list of platform types.", "operationId"=>"dfareporting.platformTypes.list", "x-api-path-slug"=>"userprofilesprofileidplatformtypes-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement Type"]}}, "/userprofiles/{profileId}/platformTypes/{id}"=>{"get"=>{"summary"=>"Get Platform Type", "description"=>"Gets one platform type by ID.", "operationId"=>"dfareporting.platformTypes.get", "x-api-path-slug"=>"userprofilesprofileidplatformtypesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Platform type ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Placement Type"]}}, "/userprofiles/{profileId}/postalCodes"=>{"get"=>{"summary"=>"Get Postal Codes", "description"=>"Retrieves a list of postal codes.", "operationId"=>"dfareporting.postalCodes.list", "x-api-path-slug"=>"userprofilesprofileidpostalcodes-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Postal Code"]}}, "/userprofiles/{profileId}/postalCodes/{code}"=>{"get"=>{"summary"=>"Get Postal Code", "description"=>"Gets one postal code by ID.", "operationId"=>"dfareporting.postalCodes.get", "x-api-path-slug"=>"userprofilesprofileidpostalcodescode-get", "parameters"=>[{"in"=>"path", "name"=>"code", "description"=>"Postal code ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Postal Code"]}}, "/userprofiles/{profileId}/projects"=>{"get"=>{"summary"=>"Get Projects", "description"=>"Retrieves a list of projects, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.projects.list", "x-api-path-slug"=>"userprofilesprofileidprojects-get", "parameters"=>[{"in"=>"query", "name"=>"advertiserIds", "description"=>"Select only projects with these advertiser IDs"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only projects with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for projects by name or ID"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Project"]}}, "/userprofiles/{profileId}/projects/{id}"=>{"get"=>{"summary"=>"Get Project", "description"=>"Gets one project by ID.", "operationId"=>"dfareporting.projects.get", "x-api-path-slug"=>"userprofilesprofileidprojectsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Project ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Project"]}}, "/userprofiles/{profileId}/projects/{projectId}/inventoryItems"=>{"get"=>{"summary"=>"Get Inventory Items", "description"=>"Retrieves a list of inventory items, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.inventoryItems.list", "x-api-path-slug"=>"userprofilesprofileidprojectsprojectidinventoryitems-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"Select only inventory items with these IDs"}, {"in"=>"query", "name"=>"inPlan", "description"=>"Select only inventory items that are in plan"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"orderId", "description"=>"Select only inventory items that belong to specified orders"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID for order documents"}, {"in"=>"query", "name"=>"siteId", "description"=>"Select only inventory items that are associated with these sites"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}, {"in"=>"query", "name"=>"type", "description"=>"Select only inventory items with this type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Inventory Item"]}}, "/userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}"=>{"get"=>{"summary"=>"Get Inventory Item", "description"=>"Gets one inventory item by ID.", "operationId"=>"dfareporting.inventoryItems.get", "x-api-path-slug"=>"userprofilesprofileidprojectsprojectidinventoryitemsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Inventory item ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID for order documents"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Inventory Item"]}}, "/userprofiles/{profileId}/projects/{projectId}/orderDocuments"=>{"get"=>{"summary"=>"Get Order Documents", "description"=>"Retrieves a list of order documents, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.orderDocuments.list", "x-api-path-slug"=>"userprofilesprofileidprojectsprojectidorderdocuments-get", "parameters"=>[{"in"=>"query", "name"=>"approved", "description"=>"Select only order documents that have been approved by at least one user"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only order documents with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"orderId", "description"=>"Select only order documents for specified orders"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID for order documents"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for order documents by name or ID"}, {"in"=>"query", "name"=>"siteId", "description"=>"Select only order documents that are associated with these sites"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Order Document"]}}, "/userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}"=>{"get"=>{"summary"=>"Get Order Document", "description"=>"Gets one order document by ID.", "operationId"=>"dfareporting.orderDocuments.get", "x-api-path-slug"=>"userprofilesprofileidprojectsprojectidorderdocumentsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Order document ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID for order documents"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Order Document"]}}, "/userprofiles/{profileId}/projects/{projectId}/orders"=>{"get"=>{"summary"=>"Get Orders", "description"=>"Retrieves a list of orders, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.orders.list", "x-api-path-slug"=>"userprofilesprofileidprojectsprojectidorders-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"Select only orders with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID for orders"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for orders by name or ID"}, {"in"=>"query", "name"=>"siteId", "description"=>"Select only orders that are associated with these site IDs"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Order"]}}, "/userprofiles/{profileId}/projects/{projectId}/orders/{id}"=>{"get"=>{"summary"=>"Get Order", "description"=>"Gets one order by ID.", "operationId"=>"dfareporting.orders.get", "x-api-path-slug"=>"userprofilesprofileidprojectsprojectidordersid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Order ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"path", "name"=>"projectId", "description"=>"Project ID for orders"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Order"]}}, "/userprofiles/{profileId}/regions"=>{"get"=>{"summary"=>"Get Regions", "description"=>"Retrieves a list of regions.", "operationId"=>"dfareporting.regions.list", "x-api-path-slug"=>"userprofilesprofileidregions-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Region"]}}, "/userprofiles/{profileId}/remarketingListShares"=>{"patch"=>{"summary"=>"Update Remarketing List Shares", "description"=>"Updates an existing remarketing list share. This method supports patch semantics.", "operationId"=>"dfareporting.remarketingListShares.patch", "x-api-path-slug"=>"userprofilesprofileidremarketinglistshares-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"remarketingListId", "description"=>"Remarketing list ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Remarketing List"]}, "put"=>{"summary"=>"Update Remarketing List Shares", "description"=>"Updates an existing remarketing list share.", "operationId"=>"dfareporting.remarketingListShares.update", "x-api-path-slug"=>"userprofilesprofileidremarketinglistshares-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Remarketing List"]}}, "/userprofiles/{profileId}/remarketingListShares/{remarketingListId}"=>{"get"=>{"summary"=>"Get Remarketing List Shares", "description"=>"Gets one remarketing list share by remarketing list ID.", "operationId"=>"dfareporting.remarketingListShares.get", "x-api-path-slug"=>"userprofilesprofileidremarketinglistsharesremarketinglistid-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"path", "name"=>"remarketingListId", "description"=>"Remarketing list ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Remarketing List"]}}, "/userprofiles/{profileId}/remarketingLists"=>{"get"=>{"summary"=>"Get Remarketing Lists", "description"=>"Retrieves a list of remarketing lists, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.remarketingLists.list", "x-api-path-slug"=>"userprofilesprofileidremarketinglists-get", "parameters"=>[{"in"=>"query", "name"=>"active", "description"=>"Select only active or only inactive remarketing lists"}, {"in"=>"query", "name"=>"advertiserId", "description"=>"Select only remarketing lists owned by this advertiser"}, {"in"=>"query", "name"=>"floodlightActivityId", "description"=>"Select only remarketing lists that have this floodlight activity ID"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"name", "description"=>"Allows searching for objects by name or ID"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Remarketing List"]}, "patch"=>{"summary"=>"Update Remarketing List", "description"=>"Updates an existing remarketing list. This method supports patch semantics.", "operationId"=>"dfareporting.remarketingLists.patch", "x-api-path-slug"=>"userprofilesprofileidremarketinglists-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Remarketing list ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Remarketing List"]}, "post"=>{"summary"=>"Insert Remarketing List", "description"=>"Inserts a new remarketing list.", "operationId"=>"dfareporting.remarketingLists.insert", "x-api-path-slug"=>"userprofilesprofileidremarketinglists-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Remarketing List"]}, "put"=>{"summary"=>"Update Remarketing List", "description"=>"Updates an existing remarketing list.", "operationId"=>"dfareporting.remarketingLists.update", "x-api-path-slug"=>"userprofilesprofileidremarketinglists-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Remarketing List"]}}, "/userprofiles/{profileId}/remarketingLists/{id}"=>{"get"=>{"summary"=>"Get Remarketing List", "description"=>"Gets one remarketing list by ID.", "operationId"=>"dfareporting.remarketingLists.get", "x-api-path-slug"=>"userprofilesprofileidremarketinglistsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Remarketing list ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Remarketing List"]}}, "/userprofiles/{profileId}/reports"=>{"get"=>{"summary"=>"Get Reports", "description"=>"Retrieves list of reports.", "operationId"=>"dfareporting.reports.list", "x-api-path-slug"=>"userprofilesprofileidreports-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The value of the nextToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"The DFA user profile ID"}, {"in"=>"query", "name"=>"scope", "description"=>"The scope that defines which results are returned, default is MINE"}, {"in"=>"query", "name"=>"sortField", "description"=>"The field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is DESCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}, "post"=>{"summary"=>"Get Report", "description"=>"Creates a report.", "operationId"=>"dfareporting.reports.insert", "x-api-path-slug"=>"userprofilesprofileidreports-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"The DFA user profile ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}}, "/userprofiles/{profileId}/reports/compatiblefields/query"=>{"post"=>{"summary"=>"Return Compatible Fields", "description"=>"Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.", "operationId"=>"dfareporting.reports.compatibleFields.query", "x-api-path-slug"=>"userprofilesprofileidreportscompatiblefieldsquery-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"The DFA user profile ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Field"]}}, "/userprofiles/{profileId}/reports/{reportId}"=>{"delete"=>{"summary"=>"Delete Report", "description"=>"Deletes a report by its ID.", "operationId"=>"dfareporting.reports.delete", "x-api-path-slug"=>"userprofilesprofileidreportsreportid-delete", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"The DFA user profile ID"}, {"in"=>"path", "name"=>"reportId", "description"=>"The ID of the report"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}, "get"=>{"summary"=>"Get Report", "description"=>"Retrieves a report by its ID.", "operationId"=>"dfareporting.reports.get", "x-api-path-slug"=>"userprofilesprofileidreportsreportid-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"The DFA user profile ID"}, {"in"=>"path", "name"=>"reportId", "description"=>"The ID of the report"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}, "patch"=>{"summary"=>"Update Report", "description"=>"Updates a report. This method supports patch semantics.", "operationId"=>"dfareporting.reports.patch", "x-api-path-slug"=>"userprofilesprofileidreportsreportid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"The DFA user profile ID"}, {"in"=>"path", "name"=>"reportId", "description"=>"The ID of the report"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}, "put"=>{"summary"=>"Update Report", "description"=>"Updates a report.", "operationId"=>"dfareporting.reports.update", "x-api-path-slug"=>"userprofilesprofileidreportsreportid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"The DFA user profile ID"}, {"in"=>"path", "name"=>"reportId", "description"=>"The ID of the report"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}}, "/userprofiles/{profileId}/reports/{reportId}/files"=>{"get"=>{"summary"=>"Get Report Files", "description"=>"Lists files for a report.", "operationId"=>"dfareporting.reports.files.list", "x-api-path-slug"=>"userprofilesprofileidreportsreportidfiles-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The value of the nextToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"The DFA profile ID"}, {"in"=>"path", "name"=>"reportId", "description"=>"The ID of the parent report"}, {"in"=>"query", "name"=>"sortField", "description"=>"The field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is DESCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report File"]}}, "/userprofiles/{profileId}/reports/{reportId}/files/{fileId}"=>{"get"=>{"summary"=>"Get Report File", "description"=>"Retrieves a report file.", "operationId"=>"dfareporting.reports.files.get", "x-api-path-slug"=>"userprofilesprofileidreportsreportidfilesfileid-get", "parameters"=>[{"in"=>"path", "name"=>"fileId", "description"=>"The ID of the report file"}, {"in"=>"path", "name"=>"profileId", "description"=>"The DFA profile ID"}, {"in"=>"path", "name"=>"reportId", "description"=>"The ID of the report"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report File"]}}, "/userprofiles/{profileId}/reports/{reportId}/run"=>{"post"=>{"summary"=>"Run Report", "description"=>"Runs a report.", "operationId"=>"dfareporting.reports.run", "x-api-path-slug"=>"userprofilesprofileidreportsreportidrun-post", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"The DFA profile ID"}, {"in"=>"path", "name"=>"reportId", "description"=>"The ID of the report"}, {"in"=>"query", "name"=>"synchronous", "description"=>"If set and true, tries to run the report synchronously"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}}, "/userprofiles/{profileId}/sites"=>{"get"=>{"summary"=>"Get Sites", "description"=>"Retrieves a list of sites, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.sites.list", "x-api-path-slug"=>"userprofilesprofileidsites-get", "parameters"=>[{"in"=>"query", "name"=>"acceptsInStreamVideoPlacements", "description"=>"This search filter is no longer supported and will have no effect on the results returned"}, {"in"=>"query", "name"=>"acceptsInterstitialPlacements", "description"=>"This search filter is no longer supported and will have no effect on the results returned"}, {"in"=>"query", "name"=>"acceptsPublisherPaidPlacements", "description"=>"Select only sites that accept publisher paid placements"}, {"in"=>"query", "name"=>"adWordsSite", "description"=>"Select only AdWords sites"}, {"in"=>"query", "name"=>"approved", "description"=>"Select only approved sites"}, {"in"=>"query", "name"=>"campaignIds", "description"=>"Select only sites with these campaign IDs"}, {"in"=>"query", "name"=>"directorySiteIds", "description"=>"Select only sites with these directory site IDs"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only sites with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name, ID or keyName"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}, {"in"=>"query", "name"=>"subaccountId", "description"=>"Select only sites with this subaccount ID"}, {"in"=>"query", "name"=>"unmappedSite", "description"=>"Select only sites that have not been mapped to a directory site"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Site"]}, "patch"=>{"summary"=>"Update Site", "description"=>"Updates an existing site. This method supports patch semantics.", "operationId"=>"dfareporting.sites.patch", "x-api-path-slug"=>"userprofilesprofileidsites-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Site ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Site"]}, "post"=>{"summary"=>"Create Site", "description"=>"Inserts a new site.", "operationId"=>"dfareporting.sites.insert", "x-api-path-slug"=>"userprofilesprofileidsites-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Site"]}, "put"=>{"summary"=>"Update Site", "description"=>"Updates an existing site.", "operationId"=>"dfareporting.sites.update", "x-api-path-slug"=>"userprofilesprofileidsites-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Site"]}}, "/userprofiles/{profileId}/sites/{id}"=>{"get"=>{"summary"=>"Get Site", "description"=>"Gets one site by ID.", "operationId"=>"dfareporting.sites.get", "x-api-path-slug"=>"userprofilesprofileidsitesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Site ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Site"]}}, "/userprofiles/{profileId}/sizes"=>{"get"=>{"summary"=>"Get Sizes", "description"=>"Retrieves a list of sizes, possibly filtered.", "operationId"=>"dfareporting.sizes.list", "x-api-path-slug"=>"userprofilesprofileidsizes-get", "parameters"=>[{"in"=>"query", "name"=>"height", "description"=>"Select only sizes with this height"}, {"in"=>"query", "name"=>"iabStandard", "description"=>"Select only IAB standard sizes"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only sizes with these IDs"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"width", "description"=>"Select only sizes with this width"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Size"]}, "post"=>{"summary"=>"Insert Size", "description"=>"Inserts a new size.", "operationId"=>"dfareporting.sizes.insert", "x-api-path-slug"=>"userprofilesprofileidsizes-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Size"]}}, "/userprofiles/{profileId}/sizes/{id}"=>{"get"=>{"summary"=>"Get Size", "description"=>"Gets one size by ID.", "operationId"=>"dfareporting.sizes.get", "x-api-path-slug"=>"userprofilesprofileidsizesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Size ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Size"]}}, "/userprofiles/{profileId}/subaccounts"=>{"get"=>{"summary"=>"Get Subaccounts", "description"=>"Gets a list of subaccounts, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.subaccounts.list", "x-api-path-slug"=>"userprofilesprofileidsubaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"Select only subaccounts with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name or ID"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Subaccount"]}, "patch"=>{"summary"=>"Update Subaccount", "description"=>"Updates an existing subaccount. This method supports patch semantics.", "operationId"=>"dfareporting.subaccounts.patch", "x-api-path-slug"=>"userprofilesprofileidsubaccounts-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Subaccount ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Subaccount"]}, "post"=>{"summary"=>"Insert Subaccount", "description"=>"Inserts a new subaccount.", "operationId"=>"dfareporting.subaccounts.insert", "x-api-path-slug"=>"userprofilesprofileidsubaccounts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Subaccount"]}, "put"=>{"summary"=>"Update Subaccount", "description"=>"Updates an existing subaccount.", "operationId"=>"dfareporting.subaccounts.update", "x-api-path-slug"=>"userprofilesprofileidsubaccounts-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Subaccount"]}}, "/userprofiles/{profileId}/subaccounts/{id}"=>{"get"=>{"summary"=>"Get Subaccount", "description"=>"Gets one subaccount by ID.", "operationId"=>"dfareporting.subaccounts.get", "x-api-path-slug"=>"userprofilesprofileidsubaccountsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Subaccount ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Subaccount"]}}, "/userprofiles/{profileId}/targetableRemarketingLists"=>{"get"=>{"summary"=>"Get Targetable Remarketing Lists", "description"=>"Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.targetableRemarketingLists.list", "x-api-path-slug"=>"userprofilesprofileidtargetableremarketinglists-get", "parameters"=>[{"in"=>"query", "name"=>"active", "description"=>"Select only active or only inactive targetable remarketing lists"}, {"in"=>"query", "name"=>"advertiserId", "description"=>"Select only targetable remarketing lists targetable by these advertisers"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"name", "description"=>"Allows searching for objects by name or ID"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Remarketing List"]}}, "/userprofiles/{profileId}/targetableRemarketingLists/{id}"=>{"get"=>{"summary"=>"Get Targetable Remarketing List", "description"=>"Gets one remarketing list by ID.", "operationId"=>"dfareporting.targetableRemarketingLists.get", "x-api-path-slug"=>"userprofilesprofileidtargetableremarketinglistsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Remarketing list ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Remarketing List"]}}, "/userprofiles/{profileId}/targetingTemplates"=>{"get"=>{"summary"=>"Get Targeting Templates", "description"=>"Retrieves a list of targeting templates, optionally filtered. This method supports paging.", "operationId"=>"dfareporting.targetingTemplates.list", "x-api-path-slug"=>"userprofilesprofileidtargetingtemplates-get", "parameters"=>[{"in"=>"query", "name"=>"advertiserId", "description"=>"Select only targeting templates with this advertiser ID"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only targeting templates with these IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name or ID"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Targeting Template"]}, "patch"=>{"summary"=>"Update Targeting Template", "description"=>"Updates an existing targeting template. This method supports patch semantics.", "operationId"=>"dfareporting.targetingTemplates.patch", "x-api-path-slug"=>"userprofilesprofileidtargetingtemplates-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"Targeting template ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Targeting Template"]}, "post"=>{"summary"=>"Create Targeting Template", "description"=>"Inserts a new targeting template.", "operationId"=>"dfareporting.targetingTemplates.insert", "x-api-path-slug"=>"userprofilesprofileidtargetingtemplates-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Targeting Template"]}, "put"=>{"summary"=>"Update Targeting Template", "description"=>"Updates an existing targeting template.", "operationId"=>"dfareporting.targetingTemplates.update", "x-api-path-slug"=>"userprofilesprofileidtargetingtemplates-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Targeting Template"]}}, "/userprofiles/{profileId}/targetingTemplates/{id}"=>{"get"=>{"summary"=>"Get Targeting Template", "description"=>"Gets one targeting template by ID.", "operationId"=>"dfareporting.targetingTemplates.get", "x-api-path-slug"=>"userprofilesprofileidtargetingtemplatesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Targeting template ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Targeting Template"]}}, "/userprofiles/{profileId}/userRolePermissionGroups"=>{"get"=>{"summary"=>"Get User Role Permission Groups", "description"=>"Gets a list of all supported user role permission groups.", "operationId"=>"dfareporting.userRolePermissionGroups.list", "x-api-path-slug"=>"userprofilesprofileiduserrolepermissiongroups-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Users", "Roles", "Permissions Group"]}}, "/userprofiles/{profileId}/userRolePermissionGroups/{id}"=>{"get"=>{"summary"=>"Get User Role Permission Group", "description"=>"Gets one user role permission group by ID.", "operationId"=>"dfareporting.userRolePermissionGroups.get", "x-api-path-slug"=>"userprofilesprofileiduserrolepermissiongroupsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"User role permission group ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Users", "Roles", "Permissions Group"]}}, "/userprofiles/{profileId}/userRolePermissions"=>{"get"=>{"summary"=>"Get User Role Permissions", "description"=>"Gets a list of user role permissions, possibly filtered.", "operationId"=>"dfareporting.userRolePermissions.list", "x-api-path-slug"=>"userprofilesprofileiduserrolepermissions-get", "parameters"=>[{"in"=>"query", "name"=>"ids", "description"=>"Select only user role permissions with these IDs"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Users", "Roles", "Permissions"]}}, "/userprofiles/{profileId}/userRolePermissions/{id}"=>{"get"=>{"summary"=>"Get User Role Permission", "description"=>"Gets one user role permission by ID.", "operationId"=>"dfareporting.userRolePermissions.get", "x-api-path-slug"=>"userprofilesprofileiduserrolepermissionsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"User role permission ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Users", "Roles", "Permissions"]}}, "/userprofiles/{profileId}/userRoles"=>{"get"=>{"summary"=>"Get User Roles", "description"=>"Retrieves a list of user roles, possibly filtered. This method supports paging.", "operationId"=>"dfareporting.userRoles.list", "x-api-path-slug"=>"userprofilesprofileiduserroles-get", "parameters"=>[{"in"=>"query", "name"=>"accountUserRoleOnly", "description"=>"Select only account level user roles not associated with any specific subaccount"}, {"in"=>"query", "name"=>"ids", "description"=>"Select only user roles with the specified IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of results to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Value of the nextPageToken from the previous result page"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}, {"in"=>"query", "name"=>"searchString", "description"=>"Allows searching for objects by name or ID"}, {"in"=>"query", "name"=>"sortField", "description"=>"Field by which to sort the list"}, {"in"=>"query", "name"=>"sortOrder", "description"=>"Order of sorted results, default is ASCENDING"}, {"in"=>"query", "name"=>"subaccountId", "description"=>"Select only user roles that belong to this subaccount"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Users", "Roles"]}, "patch"=>{"summary"=>"Update User Role", "description"=>"Updates an existing user role. This method supports patch semantics.", "operationId"=>"dfareporting.userRoles.patch", "x-api-path-slug"=>"userprofilesprofileiduserroles-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"id", "description"=>"User role ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Users", "Roles"]}, "post"=>{"summary"=>"Insert User Role", "description"=>"Inserts a new user role.", "operationId"=>"dfareporting.userRoles.insert", "x-api-path-slug"=>"userprofilesprofileiduserroles-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Users", "Roles"]}, "put"=>{"summary"=>"Update User Role", "description"=>"Updates an existing user role.", "operationId"=>"dfareporting.userRoles.update", "x-api-path-slug"=>"userprofilesprofileiduserroles-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Users", "Roles"]}}, "/userprofiles/{profileId}/userRoles/{id}"=>{"delete"=>{"summary"=>"Delete User Role", "description"=>"Deletes an existing user role.", "operationId"=>"dfareporting.userRoles.delete", "x-api-path-slug"=>"userprofilesprofileiduserrolesid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"User role ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Users", "Roles"]}, "get"=>{"summary"=>"Get User Role", "description"=>"Gets one user role by ID.", "operationId"=>"dfareporting.userRoles.get", "x-api-path-slug"=>"userprofilesprofileiduserrolesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"User role ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Users", "Roles"]}}, "/userprofiles/{profileId}/videoFormats"=>{"get"=>{"summary"=>"Get Video Formats", "description"=>"Lists available video formats.", "operationId"=>"dfareporting.videoFormats.list", "x-api-path-slug"=>"userprofilesprofileidvideoformats-get", "parameters"=>[{"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Video"]}}, "/userprofiles/{profileId}/videoFormats/{id}"=>{"get"=>{"summary"=>"Get Video", "description"=>"Gets one video format by ID.", "operationId"=>"dfareporting.videoFormats.get", "x-api-path-slug"=>"userprofilesprofileidvideoformatsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Video format ID"}, {"in"=>"path", "name"=>"profileId", "description"=>"User profile ID associated with this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Video"]}}, "/lineitems/downloadlineitems"=>{"post"=>{"summary"=>"Download CSV", "description"=>"Retrieves line items in CSV format.", "operationId"=>"doubleclickbidmanager.lineitems.downloadlineitems", "x-api-path-slug"=>"lineitemsdownloadlineitems-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "CSV"]}}, "/lineitems/uploadlineitems"=>{"post"=>{"summary"=>"Upload CSV", "description"=>"Uploads line items in CSV format.", "operationId"=>"doubleclickbidmanager.lineitems.uploadlineitems", "x-api-path-slug"=>"lineitemsuploadlineitems-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "CSV"]}}, "/queries"=>{"get"=>{"summary"=>"Get Stored Queries", "description"=>"Retrieves stored queries.", "operationId"=>"doubleclickbidmanager.queries.listqueries", "x-api-path-slug"=>"queries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Query"]}}, "/queries/{queryId}/reports"=>{"get"=>{"summary"=>"Get Stored Reports", "description"=>"Retrieves stored reports.", "operationId"=>"doubleclickbidmanager.reports.listreports", "x-api-path-slug"=>"queriesqueryidreports-get", "parameters"=>[{"in"=>"path", "name"=>"queryId", "description"=>"Query ID with which the reports are associated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Query"]}}, "/query"=>{"post"=>{"summary"=>"Create Query", "description"=>"Creates a query.", "operationId"=>"doubleclickbidmanager.queries.createquery", "x-api-path-slug"=>"query-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Query"]}}, "/query/{queryId}"=>{"delete"=>{"summary"=>"Delete Stored Query", "description"=>"Deletes a stored query as well as the associated stored reports.", "operationId"=>"doubleclickbidmanager.queries.deletequery", "x-api-path-slug"=>"queryqueryid-delete", "parameters"=>[{"in"=>"path", "name"=>"queryId", "description"=>"Query ID to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Query"]}, "get"=>{"summary"=>"Get Stored Query", "description"=>"Retrieves a stored query.", "operationId"=>"doubleclickbidmanager.queries.getquery", "x-api-path-slug"=>"queryqueryid-get", "parameters"=>[{"in"=>"path", "name"=>"queryId", "description"=>"Query ID to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Query"]}, "post"=>{"summary"=>"Run Stored Query", "description"=>"Runs a stored query to generate a report.", "operationId"=>"doubleclickbidmanager.queries.runquery", "x-api-path-slug"=>"queryqueryid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"queryId", "description"=>"Query ID to run"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Query"]}}, "/sdf/download"=>{"post"=>{"summary"=>"Get Entities in SDF Format", "description"=>"Retrieves entities in SDF format.", "operationId"=>"doubleclickbidmanager.sdf.download", "x-api-path-slug"=>"sdfdownload-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "SDF"]}}, "/agency/{agencyId}/advertiser/{advertiserId}/engine/{engineAccountId}/conversion"=>{"get"=>{"summary"=>"Get Conversions", "description"=>"Retrieves a list of conversions from a DoubleClick Search engine account.", "operationId"=>"doubleclicksearch.conversion.get", "x-api-path-slug"=>"agencyagencyidadvertiseradvertiseridengineengineaccountidconversion-get", "parameters"=>[{"in"=>"query", "name"=>"adGroupId", "description"=>"Numeric ID of the ad group"}, {"in"=>"query", "name"=>"adId", "description"=>"Numeric ID of the ad"}, {"in"=>"path", "name"=>"advertiserId", "description"=>"Numeric ID of the advertiser"}, {"in"=>"path", "name"=>"agencyId", "description"=>"Numeric ID of the agency"}, {"in"=>"query", "name"=>"campaignId", "description"=>"Numeric ID of the campaign"}, {"in"=>"query", "name"=>"criterionId", "description"=>"Numeric ID of the criterion"}, {"in"=>"query", "name"=>"endDate", "description"=>"Last date (inclusive) on which to retrieve conversions"}, {"in"=>"path", "name"=>"engineAccountId", "description"=>"Numeric ID of the engine account"}, {"in"=>"query", "name"=>"rowCount", "description"=>"The number of conversions to return per call"}, {"in"=>"query", "name"=>"startDate", "description"=>"First date (inclusive) on which to retrieve conversions"}, {"in"=>"query", "name"=>"startRow", "description"=>"The 0-based starting index for retrieving conversions results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Conversion"]}}, "/agency/{agencyId}/advertiser/{advertiserId}/savedcolumns"=>{"get"=>{"summary"=>"Get Saved Columns", "description"=>"Retrieve the list of saved columns for a specified advertiser.", "operationId"=>"doubleclicksearch.savedColumns.list", "x-api-path-slug"=>"agencyagencyidadvertiseradvertiseridsavedcolumns-get", "parameters"=>[{"in"=>"path", "name"=>"advertiserId", "description"=>"DS ID of the advertiser"}, {"in"=>"path", "name"=>"agencyId", "description"=>"DS ID of the agency"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Colum"]}}, "/conversion"=>{"patch"=>{"summary"=>"Update Conversions", "description"=>"Updates a batch of conversions in DoubleClick Search. This method supports patch semantics.", "operationId"=>"doubleclicksearch.conversion.patch", "x-api-path-slug"=>"conversion-patch", "parameters"=>[{"in"=>"query", "name"=>"advertiserId", "description"=>"Numeric ID of the advertiser"}, {"in"=>"query", "name"=>"agencyId", "description"=>"Numeric ID of the agency"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"endDate", "description"=>"Last date (inclusive) on which to retrieve conversions"}, {"in"=>"query", "name"=>"engineAccountId", "description"=>"Numeric ID of the engine account"}, {"in"=>"query", "name"=>"rowCount", "description"=>"The number of conversions to return per call"}, {"in"=>"query", "name"=>"startDate", "description"=>"First date (inclusive) on which to retrieve conversions"}, {"in"=>"query", "name"=>"startRow", "description"=>"The 0-based starting index for retrieving conversions results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Conversion"]}, "post"=>{"summary"=>"Insert Conversion", "description"=>"Inserts a batch of new conversions into DoubleClick Search.", "operationId"=>"doubleclicksearch.conversion.insert", "x-api-path-slug"=>"conversion-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Conversion"]}, "put"=>{"summary"=>"Update Conversions", "description"=>"Updates a batch of conversions in DoubleClick Search.", "operationId"=>"doubleclicksearch.conversion.update", "x-api-path-slug"=>"conversion-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Conversion"]}}, "/conversion/updateAvailability"=>{"post"=>{"summary"=>"Update Availability", "description"=>"Updates the availabilities of a batch of floodlight activities in DoubleClick Search.", "operationId"=>"doubleclicksearch.conversion.updateAvailability", "x-api-path-slug"=>"conversionupdateavailability-post", "parameters"=>[{"in"=>"body", "name"=>"empty", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Conversion"]}}, "/reports"=>{"post"=>{"summary"=>"Insert Report", "description"=>"Inserts a report request into the reporting system.", "operationId"=>"doubleclicksearch.reports.request", "x-api-path-slug"=>"reports-post", "parameters"=>[{"in"=>"body", "name"=>"reportRequest", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}}, "/reports/generate"=>{"post"=>{"summary"=>"Generate Report", "description"=>"Generates and returns a report immediately.", "operationId"=>"doubleclicksearch.reports.generate", "x-api-path-slug"=>"reportsgenerate-post", "parameters"=>[{"in"=>"body", "name"=>"reportRequest", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}}, "/reports/{reportId}"=>{"get"=>{"summary"=>"Get Report Status", "description"=>"Polls for the status of a report request.", "operationId"=>"doubleclicksearch.reports.get", "x-api-path-slug"=>"reportsreportid-get", "parameters"=>[{"in"=>"path", "name"=>"reportId", "description"=>"ID of the report request being polled"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}}, "/reports/{reportId}/files/{reportFragment}"=>{"get"=>{"summary"=>"Download Report", "description"=>"Downloads a report file encoded in UTF-8.", "operationId"=>"doubleclicksearch.reports.getFile", "x-api-path-slug"=>"reportsreportidfilesreportfragment-get", "parameters"=>[{"in"=>"path", "name"=>"reportFragment", "description"=>"The index of the report fragment to download"}, {"in"=>"path", "name"=>"reportId", "description"=>"ID of the report"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}}}}, "apis"=>{"name"=>"Google Doubleclick", "x-slug"=>"google-doubleclick", "description"=>"The Ad Exchange Buyer REST API allows your Real-Time Bidding application to access and update account information and to submit creatives. The API also allows an application (whether it does static bidding or real-time bidding) to discover direct deals that sellers make available.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-double-click.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"Advertising,API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-doubleclick/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Doubleclick API", "x-api-slug"=>"google-doubleclick-api", "description"=>"The Ad Exchange Buyer REST API allows your Real-Time Bidding application to access and update account information and to submit creatives. The API also allows an application (whether it does static bidding or real-time bidding) to discover direct deals that sellers make available.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-double-click.png", "humanURL"=>"https://www.doubleclickbygoogle.com/", "baseURL"=>"https:///", "tags"=>"Advertising,API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-doubleclick/google-doubleclick-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://developers.google.com/ad-exchange/buyer-rest/auth-guide"}, {"type"=>"x-blog", "url"=>"http://googleadsdeveloper.blogspot.com/search/label/ad_exchange"}, {"type"=>"x-blog-rss", "url"=>"http://googleadsdeveloper.blogspot.com/feeds/posts/default?alt=rss"}, {"type"=>"x-developer", "url"=>"https://developers.google.com/ad-exchange/buyer-rest/"}, {"type"=>"x-forum", "url"=>"https://groups.google.com/forum/#!forum/google-doubleclick-ad-exchange-buyer-api"}, {"type"=>"x-getting-started", "url"=>"https://developers.google.com/ad-exchange/buyer-rest/start"}, {"type"=>"x-support", "url"=>"https://developers.google.com/ad-exchange/buyer-rest/community/"}, {"type"=>"x-website", "url"=>"https://www.doubleclickbygoogle.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
eu-bon-utis{"eu-bon-utis-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"EU BON UTIS", "x-complete"=>1, "info"=>{"title"=>"EU BON UTIS", "description"=>"the-unified-taxonomic-information-service-utis-is-the-taxonomic-backbone-for-the-eubon-project", "termsOfService"=>"https://www.biodiversitycatalogue.org/services/79", "version"=>"1.0"}, "host"=>"cybertaxonomy.eu", "basePath"=>"/eu-bon/utis/1.0", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/capabilities"=>{"get"=>{"summary"=>"Capabilities", "description"=>"Capabilities", "operationId"=>"getCapabilities", "x-api-path-slug"=>"capabilities-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Capabilities"]}}, "/search"=>{"get"=>{"summary"=>"Search", "description"=>"Search", "operationId"=>"getSearch", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"addSynonymy", "description"=>"Indicates whether the synonymy of the accepted taxon should be included into the response"}, {"in"=>"query", "name"=>"providers", "description"=>"A list of provider id strings concatenated by comma characters"}, {"in"=>"query", "name"=>"query", "description"=>"The scientific name to search for"}, {"in"=>"query", "name"=>"searchMode", "description"=>"Specifies the searchMode"}, {"in"=>"query", "name"=>"timeout", "description"=>"The maximum of milliseconds to wait for responses from any of the providers"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}}}, "apis"=>{"name"=>"EU BON UTIS", "x-slug"=>"eu-bon-utis", "description"=>"The EDIT Platform for Cybertaxonomy is a collection of open source tools and services which together cover all aspects of the taxonomic workflow. The workflow is grouped into the following areas: taxonomic editing; publishing of edited data; data storage and exchange; collections and specimens; descriptions; fieldwork; literature; and geography. At the heart of the Cybertaxonomy platform is the Common Data Model (CDM), a repository for every conceivable type of data produced by taxonomists in the course of their work, and the backend for most EDIT components.", "image"=>"", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,General Data,Profiles,Taxonomies", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"eu-bon-utis/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"EU BON UTIS", "x-api-slug"=>"eu-bon-utis", "description"=>"The EDIT Platform for Cybertaxonomy is a collection of open source tools and services which together cover all aspects of the taxonomic workflow. The workflow is grouped into the following areas: taxonomic editing; publishing of edited data; data storage and exchange; collections and specimens; descriptions; fieldwork; literature; and geography. At the heart of the Cybertaxonomy platform is the Common Data Model (CDM), a repository for every conceivable type of data produced by taxonomists in the course of their work, and the backend for most EDIT components.", "image"=>"", "humanURL"=>"http://cybertaxonomy.eu", "baseURL"=>"https://cybertaxonomy.eu//eu-bon/utis/1.0", "tags"=>"API Provider,General Data,Profiles,Taxonomies", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/eu-bon-utis/search-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/eu-bon-utis/eu-bon-utis-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://cybertaxonomy.eu"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
twine{"twine-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Twine", "x-complete"=>1, "info"=>{"title"=>"Twine", "description"=>"-overviewthe-twine-health-api-is-restful-api--the-requests-and-responses-are-formated-according-to-the-json-apihttpjsonapi-orgformat1-0-specification-in-addition-to-this-documentation-we-also-provide-an-openapihttpsgithub-comoaiopenapispecificationblobmasterversions2-0-md-yaml-file-describing-the-api-twine-api-specificationswagger-yaml--authenticationauthentication-for-the-twine-api-is-based-on-the-oauth-2-0-authorization-frameworkhttpstools-ietf-orghtmlrfc6749--twine-currently-supports-grant-types-of-client-credentials-and-refresh-token-see-post-oauthtokenoperationcreatetoken-for-details-on-the-request-and-response-formats--redocinject-securitydefinitions-", "version"=>"7.18.0"}, "host"=>"api.twinehealth.com", "basePath"=>"/pub", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/action"=>{"post"=>{"summary"=>"Create action", "description"=>"Create a plan action", "operationId"=>"createAction", "x-api-path-slug"=>"action-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Action"]}}, "/action/{id}"=>{"get"=>{"summary"=>"Get an action", "description"=>"Get a health action from a patient's plan.", "operationId"=>"fetchAction", "x-api-path-slug"=>"actionid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Action identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Action"]}, "patch"=>{"summary"=>"Update an action", "description"=>"Update a health action from a patient's plan.", "operationId"=>"updateAction", "x-api-path-slug"=>"actionid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Action identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Action"]}}, "/bundle"=>{"post"=>{"summary"=>"Create bundle", "description"=>"Create a bundle in a patient's plan", "operationId"=>"createBundle", "x-api-path-slug"=>"bundle-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Bundle"]}}, "/bundle/{id}"=>{"get"=>{"summary"=>"Get a bundle", "description"=>"Get a bundle from a patient's plan.", "operationId"=>"fetchBundle", "x-api-path-slug"=>"bundleid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Bundle identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Bundle"]}, "patch"=>{"summary"=>"Update a bundle", "description"=>"Updte a bundle from a patient's plan.", "operationId"=>"updateBundle", "x-api-path-slug"=>"bundleid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Bundle identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Bundle"]}}, "/calendar_event"=>{"get"=>{"summary"=>"List calendar events", "description"=>"Get a list of calendar events", "operationId"=>"fetchCalendarEvents", "x-api-path-slug"=>"calendar-event-get", "parameters"=>[{"in"=>"query", "name"=>"filter[attendees]", "description"=>"Comma-separated list of coach or patient ids"}, {"in"=>"query", "name"=>"filter[completed]", "description"=>"If not specified, return all calendar events"}, {"in"=>"query", "name"=>"filter[completed_at]", "description"=>"The start (inclusive) and end (exclusive) dates are ISO date and time strings separated by `"}, {"in"=>"query", "name"=>"filter[created_at]", "description"=>"The start (inclusive) and end (exclusive) dates are ISO date and time strings separated by `"}, {"in"=>"query", "name"=>"filter[end_at]", "description"=>"The start (inclusive) and end (exclusive) dates are ISO date and time strings separated by `"}, {"in"=>"query", "name"=>"filter[groups]", "description"=>"Comma-separated list of group ids"}, {"in"=>"query", "name"=>"filter[organization]", "description"=>"Twine organization id"}, {"in"=>"query", "name"=>"filter[patient]", "description"=>"Patient id to fetch calendar event"}, {"in"=>"query", "name"=>"filter[start_at]", "description"=>"The start (inclusive) and end (exclusive) dates are ISO date and time strings separated by `"}, {"in"=>"query", "name"=>"filter[type]", "description"=>"Calendar event type"}, {"in"=>"query", "name"=>"filter[updated_at]", "description"=>"The start (inclusive) and end (exclusive) dates are ISO date and time strings separated by `"}, {"in"=>"query", "name"=>"include", "description"=>"List of related resources to include in the response"}, {"in"=>"query", "name"=>"page[number]", "description"=>"Page number"}, {"in"=>"query", "name"=>"page[size]", "description"=>"Page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "List", "Calendar", "Events"]}, "post"=>{"summary"=>"Create calendar event", "description"=>"Create a calendar event for a patient. Attribute `all_day` must be set to `true` and `end_at` cannot be set for `plan-check-in` event type.", "operationId"=>"createCalendarEvent", "x-api-path-slug"=>"calendar-event-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Calendar", "Event"]}}, "/calendar_event/{id}"=>{"delete"=>{"summary"=>"Delete a calendar event", "description"=>"Delete a calendar event by id", "operationId"=>"deleteCalendarEvent", "x-api-path-slug"=>"calendar-eventid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Calendar event identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Calendar", "Event"]}, "get"=>{"summary"=>"Get a calendar event", "description"=>"Get a calendar event by id", "operationId"=>"fetchCalendarEvent", "x-api-path-slug"=>"calendar-eventid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Calendar event identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Calendar", "Event"]}, "patch"=>{"summary"=>"Update a calendar event", "description"=>"Update a calendar event for a patient. Attribute `all_day` must be true and `end_at` cannot be specified for `plan-check-in` event type. To mark a calendar event as 'completed', set `completed_at` and `completed_by` to desired values. To mark a completed calendar event as 'not completed', set `completed_at` and `completed_by` to `null`.", "operationId"=>"updateCalendarEvent", "x-api-path-slug"=>"calendar-eventid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Calendar event identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Calendar", "Event"]}}, "/coach/{id}"=>{"get"=>{"summary"=>"Get a coach", "description"=>"Get a coach record by id.", "operationId"=>"fetchCoach", "x-api-path-slug"=>"coachid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Coach identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Coach"]}}, "/email_history"=>{"get"=>{"summary"=>"List email histories", "description"=>"Get a list of email histories", "operationId"=>"fetchEmailHistories", "x-api-path-slug"=>"email-history-get", "parameters"=>[{"in"=>"query", "name"=>"filter[emailType]", "description"=>"Type of email"}, {"in"=>"query", "name"=>"filter[receiver]", "description"=>"Twine user id of email recipient"}, {"in"=>"query", "name"=>"filter[sender]", "description"=>"Twine user id of email sender"}, {"in"=>"query", "name"=>"sort", "description"=>"valid sorts: * send_time - ascending by send_time * -send_time - descending by send_time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "List", "Email", "Histories"]}}, "/email_history/{id}"=>{"get"=>{"summary"=>"Get an email history", "description"=>"Get an email history by id", "operationId"=>"fetchEmailHistory", "x-api-path-slug"=>"email-historyid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Email history identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Email", "History"]}}, "/group"=>{"get"=>{"summary"=>"List groups", "description"=>"Get a list of groups matching the specified filters.", "operationId"=>"fetchGroups", "x-api-path-slug"=>"group-get", "parameters"=>[{"in"=>"query", "name"=>"filter[name]", "description"=>"Group name"}, {"in"=>"query", "name"=>"filter[organization]", "description"=>"Organization identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "List", "Groups"]}, "post"=>{"summary"=>"Create a group", "description"=>"Create a group record.", "operationId"=>"createGroup", "x-api-path-slug"=>"group-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Group"]}}, "/group/{id}"=>{"get"=>{"summary"=>"Get a group", "description"=>"Get a group record by id.", "operationId"=>"fetchGroup", "x-api-path-slug"=>"groupid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Group identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Group"]}}, "/health_profile"=>{"get"=>{"summary"=>"List health profiles", "description"=>"Get a list of health profiles", "operationId"=>"fetchHealthProfiles", "x-api-path-slug"=>"health-profile-get", "parameters"=>[{"in"=>"query", "name"=>"filter[groups]", "description"=>"Comma-separated list of group ids"}, {"in"=>"query", "name"=>"filter[organization]", "description"=>"Twine organization id"}, {"in"=>"query", "name"=>"filter[patient]", "description"=>"Patient id to fetch health profile"}, {"in"=>"query", "name"=>"include", "description"=>"List of related resources to include in the response"}, {"in"=>"query", "name"=>"page[number]", "description"=>"Page number"}, {"in"=>"query", "name"=>"page[size]", "description"=>"Page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "List", "Health", "Profiles"]}}, "/health_profile/{id}"=>{"get"=>{"summary"=>"Get a health profile", "description"=>"Get a health profile by id", "operationId"=>"fetchHealthProfile", "x-api-path-slug"=>"health-profileid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Health profile identifier"}, {"in"=>"query", "name"=>"include", "description"=>"List of related resources to include in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Health", "Profile"]}}, "/health_profile_answer"=>{"get"=>{"summary"=>"List health profile answers", "description"=>"Get a list of health profile answers", "operationId"=>"fetchHealthProfileAnswers", "x-api-path-slug"=>"health-profile-answer-get", "parameters"=>[{"in"=>"query", "name"=>"filter[groups]", "description"=>"Comma-separated list of group ids"}, {"in"=>"query", "name"=>"filter[organization]", "description"=>"Twine organization id"}, {"in"=>"query", "name"=>"filter[patient]", "description"=>"Patient id to fetch healt profile answers"}, {"in"=>"query", "name"=>"include", "description"=>"List of related resources to include in the response"}, {"in"=>"query", "name"=>"page[number]", "description"=>"Page number"}, {"in"=>"query", "name"=>"page[size]", "description"=>"Page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "List", "Health", "Profile", "Answers"]}}, "/health_profile_answer/{id}"=>{"get"=>{"summary"=>"Get a health profile answer", "description"=>"Get a health profile answer by id", "operationId"=>"fetchHealthProfileAnswer", "x-api-path-slug"=>"health-profile-answerid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Health profile answer identifier"}, {"in"=>"query", "name"=>"include", "description"=>"List of related resources to include in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Health", "Profile", "Answer"]}}, "/health_profile_question/{id}"=>{"get"=>{"summary"=>"Get a health profile question", "description"=>"Get a health profile by id", "operationId"=>"fetchHealthProfileQuestion", "x-api-path-slug"=>"health-profile-questionid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Health profile question identifier"}, {"in"=>"query", "name"=>"include", "description"=>"List of related resources to include in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Health", "Profile", "Question"]}}, "/health_question_definition"=>{"get"=>{"summary"=>"List health question definitions", "description"=>"Get a list of all health question definitions", "operationId"=>"fetchHealthQuestionDefinitions", "x-api-path-slug"=>"health-question-definition-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "List", "Health", "Question", "Definitions"]}}, "/health_question_definition/{id}"=>{"get"=>{"summary"=>"Get a health question definition", "description"=>"Get a health question definition by id", "operationId"=>"fetchHealthQuestionDefinition", "x-api-path-slug"=>"health-question-definitionid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Health question definition identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Health", "Question", "Definition"]}}, "/oauth/token"=>{"post"=>{"summary"=>"Create an oauth token", "description"=>"Create an OAuth 2.0 Bearer token. A valid bearer token is required for all other API requests.\n\nBe sure to set the header `Content-Type: \"application/vnd.api+json\"`. Otherwise, you will get an error\n403 Forbidden. Using `Content-Type: \"application/json\"` is permitted (to support older oauth clients) but when\nusing `application/json` the body should have a body in the following format instead of nesting under\n`data.attributes`:\n```\n{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"95c78ab2-167f-40b8-8bec-8398d4b87454\",\n \"client_secret\": \"35d18dc9-a3dd-4948-b787-063a490b9354\"\n}\n```", "operationId"=>"createToken", "x-api-path-slug"=>"oauthtoken-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"include", "description"=>"List of related resources to include in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Oauth", "Token"]}}, "/oauth/token/{id}/groups"=>{"get"=>{"summary"=>"Get the groups for a token", "description"=>"Get the list of groups a token can be used to access.", "operationId"=>"fetchTokenGroups", "x-api-path-slug"=>"oauthtokenidgroups-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Token identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Groupsa", "Token"]}}, "/oauth/token/{id}/organization"=>{"get"=>{"summary"=>"Get the organization for a token", "description"=>"Get the organization a token can be used to access.", "operationId"=>"fetchTokenOrganization", "x-api-path-slug"=>"oauthtokenidorganization-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Token identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Organizationa", "Token"]}}, "/organization/{id}"=>{"get"=>{"summary"=>"Get an organization", "description"=>"Get an organization record by id.", "operationId"=>"fetchOrganization", "x-api-path-slug"=>"organizationid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Organization identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Organization"]}}, "/patient"=>{"get"=>{"summary"=>"List patients", "description"=>"Get a list of patients.", "operationId"=>"fetchPatients", "x-api-path-slug"=>"patient-get", "parameters"=>[{"in"=>"query", "name"=>"filter[archived]", "description"=>"If not specified, return all patients"}, {"in"=>"query", "name"=>"filter[created_at]", "description"=>"The start (inclusive) and end (exclusive) dates are ISO date and time strings separated by `"}, {"in"=>"query", "name"=>"filter[groups]", "description"=>"Comma-separated list of group ids"}, {"in"=>"query", "name"=>"filter[identifier][system]", "description"=>"Identifier system (example: MyEHR) - requires a filter[identifier][value] parameter"}, {"in"=>"query", "name"=>"filter[identifier][value]", "description"=>"Identifier value (example: 12345) - requires a filter[identifier][system] parameter"}, {"in"=>"query", "name"=>"filter[organization]", "description"=>"Twine organization id"}, {"in"=>"query", "name"=>"filter[updated_at]", "description"=>"The start (inclusive) and end (exclusive) dates are ISO date and time strings separated by `"}, {"in"=>"query", "name"=>"page[number]", "description"=>"Page number"}, {"in"=>"query", "name"=>"page[size]", "description"=>"Page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "List", "Patients"]}, "post"=>{"summary"=>"Create a patient", "description"=>"Create a patient record.\n\nExample for creating a patient with a group specified using `meta.query` instead of `id`:\n\n```JSON\n{\n \"data\": {\n \"type\": \"patient\",\n \"attributes\": {\n \"first_name\": \"Andrew\",\n \"last_name\": \"Smith\"\n },\n \"relationships\": {\n \"groups\": {\n \"data\": [\n {\n \"type\": \"group\",\n \"meta\": {\n \"query\": {\n \"organization\": \"58c88de7c93eb96357a87033\",\n \"name\": \"Patients Lead\"\n }\n }\n }\n ]\n }\n }\n }\n}\n```", "operationId"=>"createPatient", "x-api-path-slug"=>"patient-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Patient"]}}, "/patient/{id}"=>{"get"=>{"summary"=>"Get a patient", "description"=>"Gets a patient record by id.", "operationId"=>"fetchPatient", "x-api-path-slug"=>"patientid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Patient identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Patient"]}, "patch"=>{"summary"=>"Update a patient", "description"=>"Update a patient record.", "operationId"=>"updatePatient", "x-api-path-slug"=>"patientid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Patient identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Patient"]}}, "/patient/{id}/coaches"=>{"get"=>{"summary"=>"List coaches for a patient", "description"=>"Get the list of coaches for a patient.", "operationId"=>"fetchPatientCoaches", "x-api-path-slug"=>"patientidcoaches-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Patient identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "List", "Coachesa", "Patient"]}}, "/patient/{id}/groups"=>{"get"=>{"summary"=>"List groups for a patient", "description"=>"Get the list of groups for a patient.", "operationId"=>"fetchPatientGroups", "x-api-path-slug"=>"patientidgroups-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Patient identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "List", "Groupsa", "Patient"]}}, "/patient_health_metric"=>{"get"=>{"summary"=>"List patient health metrics", "description"=>"Get a list of patient health metrics.", "operationId"=>"fetchPatientHealthMetrics", "x-api-path-slug"=>"patient-health-metric-get", "parameters"=>[{"in"=>"query", "name"=>"filter[patient]", "description"=>"Filter the patient health metrics for a specified patient"}, {"in"=>"query", "name"=>"page[number]", "description"=>"Page number"}, {"in"=>"query", "name"=>"page[size]", "description"=>"Page size"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "List", "Patient", "Health", "Metrics"]}, "post"=>{"summary"=>"Create patient health metrics", "description"=>"Create one or more patient health metrics.\n\nExample for creating a patient health result with a patient specified using `meta.query` instead of `id`:\n\n```JSON\n {\n \"data\": {\n \"type\": \"patient_health_metric\",\n \"attributes\": {\n \"code\": {\n \"system\": \"LOINC\",\n \"value\": \"13457-7\"\n },\n \"type\": \"ldl_cholesterol\",\n \"occurred_at\": \"2017-03-14T11:00:57.000Z\",\n \"value\": \"121\",\n \"unit\": \"mg/dl\"\n },\n \"relationships\": {\n \"patient\": {\n \"data\": {\n \"type\": \"patient\",\n \"meta\": {\n \"query\": {\n \"identifier\": {\n \"system\": \"medical-record-number\",\n \"value\": \"121212\"\n },\n \"organization\": \"58c4554710123c5c40dbab81\"\n }\n }\n }\n }\n }\n }\n }\n```", "operationId"=>"createPatientHealthMetric", "x-api-path-slug"=>"patient-health-metric-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Patient", "Health", "Metrics"]}}, "/patient_health_metric/{id}"=>{"get"=>{"summary"=>"Get a patient health metric", "description"=>"Get the plan summary for a patient.", "operationId"=>"fetchPatientHealthMetric", "x-api-path-slug"=>"patient-health-metricid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Patient health metric identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Patient", "Health", "Metric"]}}, "/patient_plan_summary"=>{"get"=>{"summary"=>"List patient plan summaries", "description"=>"Get a list of patient plan summaries", "operationId"=>"fetchPatientPlanSummaries", "x-api-path-slug"=>"patient-plan-summary-get", "parameters"=>[{"in"=>"query", "name"=>"filter[patient]", "description"=>"Patient id to fetch plan summary for"}, {"in"=>"query", "name"=>"include", "description"=>"List of related resources to include in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "List", "Patient", "Plan", "Summaries"]}}, "/patient_plan_summary/{id}"=>{"get"=>{"summary"=>"Get the plan summary for a patient", "description"=>"Get the plan summary for a patient.", "operationId"=>"fetchPatientPlanSummary", "x-api-path-slug"=>"patient-plan-summaryid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Plan summary identifier"}, {"in"=>"query", "name"=>"include", "description"=>"List of related resources to include in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Plan", "Summarya", "Patient"]}, "patch"=>{"summary"=>"Update a plan summary", "description"=>"Update a plan summary record for a patient.", "operationId"=>"updatePatientPlanSummary", "x-api-path-slug"=>"patient-plan-summaryid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"Plan summary identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Plan", "Summary"]}}, "/reward"=>{"get"=>{"summary"=>"List rewards", "description"=>"Get a list of rewards matching the specified filters.", "operationId"=>"fetchRewards", "x-api-path-slug"=>"reward-get", "parameters"=>[{"in"=>"query", "name"=>"filter[patient]", "description"=>"Patient identifier"}, {"in"=>"query", "name"=>"filter[reward_program_activation]", "description"=>"Reward program activation identifier"}, {"in"=>"query", "name"=>"filter[thread]", "description"=>"Thread identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "List", "Rewards"]}, "post"=>{"summary"=>"Create a reward", "description"=>"Create a reward for a patient.", "operationId"=>"createReward", "x-api-path-slug"=>"reward-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Reward"]}}, "/reward/{id}"=>{"get"=>{"summary"=>"Get a reward", "description"=>"Get a reward record by id.", "operationId"=>"fetchReward", "x-api-path-slug"=>"rewardid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Reward identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Reward"]}}, "/reward_earning"=>{"get"=>{"summary"=>"List reward earnings", "description"=>"Get a list of reward earnings matching the specified filters.", "operationId"=>"fetchRewardEarnings", "x-api-path-slug"=>"reward-earning-get", "parameters"=>[{"in"=>"query", "name"=>"filter[groups]", "description"=>"Group identifiers"}, {"in"=>"query", "name"=>"filter[patient]", "description"=>"Patient identifier"}, {"in"=>"query", "name"=>"filter[ready_for_fulfillment]", "description"=>"If true, only returns those reward earnings for which ready_for_fulfillment is true and fulfilled_at is null"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "List", "Reward", "Earnings"]}, "post"=>{"summary"=>"Create a reward earning", "description"=>"Create a reward earning for a reward. There can only be one earning for a reward. It is possilble to create multiple reward earnings simultaneously by providing and array of reward earnings in the data property.", "operationId"=>"createRewardEarning", "x-api-path-slug"=>"reward-earning-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Reward", "Earning"]}}, "/reward_earning/{id}"=>{"get"=>{"summary"=>"Get a reward earning", "description"=>"Get a reward earning record by id.", "operationId"=>"fetchRewardEarning", "x-api-path-slug"=>"reward-earningid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Reward earning identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Reward", "Earning"]}}, "/reward_earning_fulfillment"=>{"get"=>{"summary"=>"List reward earning fulfillments", "description"=>"Get a list of reward earning fulfillments matching the specified filters.", "operationId"=>"fetchRewardEarningFulfillments", "x-api-path-slug"=>"reward-earning-fulfillment-get", "parameters"=>[{"in"=>"query", "name"=>"filter[patient]", "description"=>"Patient identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "List", "Reward", "Earning", "Fulfillments"]}, "post"=>{"summary"=>"Create a reward earning fulfillment", "description"=>"Create a reward earning fulfillment for a reward earning. There can only be one fulfillment for each earning.", "operationId"=>"createRewardEarningFulfillment", "x-api-path-slug"=>"reward-earning-fulfillment-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Reward", "Earning", "Fulfillment"]}}, "/reward_earning_fulfillment/{id}"=>{"get"=>{"summary"=>"Get a reward earning fulfillment", "description"=>"Get a reward earning fulfillment record by id.", "operationId"=>"fetchRewardEarningFulfillment", "x-api-path-slug"=>"reward-earning-fulfillmentid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Reward earning fulfillment identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Reward", "Earning", "Fulfillment"]}}, "/reward_program"=>{"get"=>{"summary"=>"List reward programs", "description"=>"Get a list of reward programs matching the specified filters.", "operationId"=>"fetchRewardPrograms", "x-api-path-slug"=>"reward-program-get", "parameters"=>[{"in"=>"query", "name"=>"filter[groups]", "description"=>"Comma-separated list of group identifiers"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "List", "Reward", "Programs"]}, "post"=>{"summary"=>"Create a reward program", "description"=>"Create a reward program for a group.", "operationId"=>"createRewardProgram", "x-api-path-slug"=>"reward-program-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Reward", "Program"]}}, "/reward_program/{id}"=>{"get"=>{"summary"=>"Get a reward program", "description"=>"Get a reward program record by id.", "operationId"=>"fetchRewardProgram", "x-api-path-slug"=>"reward-programid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Reward program identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Reward", "Program"]}}, "/reward_program/{id}/group"=>{"get"=>{"summary"=>"Get group for a reward program", "description"=>"Get the group related to a reward program.", "operationId"=>"fetchRewardProgramGroup", "x-api-path-slug"=>"reward-programidgroup-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Reward program identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Groupa", "Reward", "Program"]}}, "/reward_program_activation"=>{"get"=>{"summary"=>"List reward program activations", "description"=>"Get a list of reward program activations matching the specified filters.", "operationId"=>"fetchRewardProgramActivations", "x-api-path-slug"=>"reward-program-activation-get", "parameters"=>[{"in"=>"query", "name"=>"filter[patient]", "description"=>"Patient identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "List", "Reward", "Program", "Activations"]}, "post"=>{"summary"=>"Create a reward program activation", "description"=>"Create a reward program activation for a patient. There can only be one activation for a patient for a given reward program.", "operationId"=>"createRewardProgramActivation", "x-api-path-slug"=>"reward-program-activation-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Reward", "Program", "Activation"]}}, "/reward_program_activation/{id}"=>{"get"=>{"summary"=>"Get a reward program activation", "description"=>"Get a reward program activationrecord by id.", "operationId"=>"fetchRewardProgramActivation", "x-api-path-slug"=>"reward-program-activationid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Reward program activation identifier"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Wearables", "Reward", "Program", "Activation"]}}}}, "apis"=>{"name"=>"Twine", "x-slug"=>"twine", "description"=>"Twine Health is a cloud-based collaborative care platform for chronic disease management. It consists of a patient engagement portal, a peer support network, a care management solution, and an outcome analytics tool. The platform enables users to co-create personalized care plans that serve as common ground for collaboration with their care team: their own providers such as physicians and nurse practitioners; their family and friends; and coaches such as nurses, pharmacists, health coaches, and more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/twinehealth.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"Healthcare,Relative Data,Service API,Wearables", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"twine/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Twine", "x-api-slug"=>"twine", "description"=>"Twine Health is a cloud-based collaborative care platform for chronic disease management. It consists of a patient engagement portal, a peer support network, a care management solution, and an outcome analytics tool. The platform enables users to co-create personalized care plans that serve as common ground for collaboration with their care team: their own providers such as physicians and nurse practitioners; their family and friends; and coaches such as nurses, pharmacists, health coaches, and more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/twinehealth.png", "humanURL"=>"http://twinehealth.com", "baseURL"=>"https://api.twinehealth.com//pub", "tags"=>"Healthcare,Relative Data,Service API,Wearables", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/twine/twine-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"http://developer.twinehealth.com/#section/Authentication"}, {"type"=>"x-developer", "url"=>"http://developer.twinehealth.com/"}, {"type"=>"x-website", "url"=>"http://twinehealth.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
kentico-cloud{"kentico-cloud-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Kentico Cloud", "x-complete"=>1, "info"=>{"title"=>"Kentico Cloud", "description"=>"this-is-a-collection-of-resources-you-can-find-within-the-kentico-cloud-developer-hubhttpsdeveloper-kenticocloud-com--kentico-cloudhttpskenticocloud-com-is-a-cloudfirst-headless-cms-that-allows-you-to-distribute-content-to-any-channel-and-device-websites-mobile-devices-mixed-reality-devices-presentation-kiosks-etc--through-an-api-certain-apis-require-that-you-include-the-authorization-header--find-more-in-httpsdeveloper-kenticocloud-comreferenceauthentication-", "version"=>"1.0.0"}, "host"=>"deliver.kenticocloud.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/975bf280-fd91-488c-994c-2f04416e5ee3/items"=>{"get"=>{"summary"=>"Order articles by publish date", "description"=>"Filter the content items by content type by including the `order` query parameter and a content element codename.", "operationId"=>"975bf280Fd91488c994c2f04416e5ee3ItemsGet8", "x-api-path-slug"=>"975bf280fd91488c994c2f04416e5ee3items-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"order"}, {"in"=>"query", "name"=>"system.type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order", "Articles", "By", "Publish", "Date"]}}, "/items/3120ec15-a4a2-47ec-8ccd-c85ac8ac5ba5"=>{"get"=>{"summary"=>"View a content item by ID", "description"=>"Retrieve metadata information about a content item specified by its internal ID.", "operationId"=>"Items3120ec15A4a247ec8ccdC85ac8ac5ba5Get", "x-api-path-slug"=>"items3120ec15a4a247ec8ccdc85ac8ac5ba5-get", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["View", "Content", "Item", "By", "ID"]}, "put"=>{"summary"=>"Update a content item by ID", "description"=>"Update an existing content item specified by its internal ID.", "operationId"=>"Items3120ec15A4a247ec8ccdC85ac8ac5ba5Put", "x-api-path-slug"=>"items3120ec15a4a247ec8ccdc85ac8ac5ba5-put", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content", "Item", "By", "ID"]}, "delete"=>{"summary"=>"Delete a content item by ID", "description"=>"Delete a content item specified by its internal ID. Note that deleting a content item deletes all of its language variants as well.", "operationId"=>"Items3120ec15A4a247ec8ccdC85ac8ac5ba5Delete2", "x-api-path-slug"=>"items3120ec15a4a247ec8ccdc85ac8ac5ba5-delete", "parameters"=>[{"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Content", "Item", "By", "ID"]}}, "/14372844-0a5d-434a-8423-605b8a631623/items"=>{"get"=>{"summary"=>"Filtering based on date with Delivery API", "description"=>"Filter content items directly in the API call using the `element.element_codename` query parameter and *publish from* and *publish until* elements.\n\nSee |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-elasticache{"apis"=>{"name"=>"AWS ElastiCache", "x-slug"=>"aws-elasticache", "description"=>"Amazon ElastiCache is a web service that makes it easy to deploy, operate, and scale an in-memory data store or cache in the cloud. The service improves the performance of web applications by allowing you to retrieve information from fast, managed, in-memory data stores, instead of relying entirely on slower disk-based databases. Amazon ElastiCache automatically detects and replaces failed nodes, reducing the overhead associated with self-managed infrastructures and provides a resilient system that mitigates the risk of overloaded databases, which slow website and application load times. Through integration with Amazon CloudWatch, Amazon ElastiCache provides enhanced visibility into key performance metrics associated with your Redis or Memcached nodes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Database_AmazonElasticCache.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Availability,Cache,Performance,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-elasticache/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Amazon ElastiCache API", "x-api-slug"=>"amazon-elasticache-api", "description"=>"Amazon ElastiCache is a web service that makes it easy to deploy, operate, and scale an in-memory data store or cache in the cloud. The service improves the performance of web applications by allowing you to retrieve information from fast, managed, in-memory data stores, instead of relying entirely on slower disk-based databases. Amazon ElastiCache automatically detects and replaces failed nodes, reducing the overhead associated with self-managed infrastructures and provides a resilient system that mitigates the risk of overloaded databases, which slow website and application load times. Through integration with Amazon CloudWatch, Amazon ElastiCache provides enhanced visibility into key performance metrics associated with your Redis or Memcached nodes.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Database_AmazonElasticCache.png", "humanURL"=>"https://aws.amazon.com/elasticache/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Availability,Cache,Performance,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-elasticache/amazon-elasticache-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/Welcome.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/elasticache/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/elasticache/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/elasticache/pricing/"}, {"type"=>"x-resources", "url"=>"https://aws.amazon.com/elasticache/developer-resources/"}, {"type"=>"x-testimonials", "url"=>"https://aws.amazon.com/elasticache/testimonials/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/elasticache/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "amazon-elasticache-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS ElastiCache", "x-complete"=>1, "info"=>{"title"=>"AWS ElastiCache API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddTagsToResource"=>{"get"=>{"summary"=>"Add Tags To Resource", "description"=>"Adds up to 10 cost allocation tags to the named resource.", "operationId"=>"addTagsToResource", "x-api-path-slug"=>"actionaddtagstoresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceName", "description"=>"The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of cost allocation tags to be added to this resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Tags"]}}, "/?Action=AuthorizeCacheSecurityGroupIngress"=>{"get"=>{"summary"=>"Authorize Cache Security Group Ingress", "description"=>"Allows network ingress to a cache\n security group.", "operationId"=>"authorizeCacheSecurityGroupIngress", "x-api-path-slug"=>"actionauthorizecachesecuritygroupingress-get", "parameters"=>[{"in"=>"query", "name"=>"CacheSecurityGroupName", "description"=>"The cache security group that allows network ingress", "type"=>"string"}, {"in"=>"query", "name"=>"EC2SecurityGroupName", "description"=>"The Amazon EC2 security group to be authorized for ingress to the cache security group", "type"=>"string"}, {"in"=>"query", "name"=>"EC2SecurityGroupOwnerId", "description"=>"The AWS account number of the Amazon EC2 security group owner", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Security Groups"]}}, "/?Action=CopySnapshot"=>{"get"=>{"summary"=>"Copy Snapshot", "description"=>"Makes a copy of an existing snapshot.", "operationId"=>"copySnapshot", "x-api-path-slug"=>"actioncopysnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"SourceSnapshotName", "description"=>"The name of an existing snapshot from which to make a copy", "type"=>"string"}, {"in"=>"query", "name"=>"TargetBucket", "description"=>"The Amazon S3 bucket to which the snapshot is exported", "type"=>"string"}, {"in"=>"query", "name"=>"TargetSnapshotName", "description"=>"A name for the snapshot copy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=CreateCacheCluster"=>{"get"=>{"summary"=>"Create Cache Cluster", "description"=>"Creates a cache cluster.", "operationId"=>"createCacheCluster", "x-api-path-slug"=>"actioncreatecachecluster-get", "parameters"=>[{"in"=>"query", "name"=>"AuthToken", "description"=>"Reserved parameter", "type"=>"string"}, {"in"=>"query", "name"=>"AutoMinorVersionUpgrade", "description"=>"This parameter is currently disabled", "type"=>"string"}, {"in"=>"query", "name"=>"AZMode", "description"=>"Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the clusters region", "type"=>"string"}, {"in"=>"query", "name"=>"CacheClusterId", "description"=>"The node group (shard) identifier", "type"=>"string"}, {"in"=>"query", "name"=>"CacheNodeType", "description"=>"The compute and memory capacity of the nodes in the node group (shard)", "type"=>"string"}, {"in"=>"query", "name"=>"CacheParameterGroupName", "description"=>"The name of the parameter group to associate with this cache cluster", "type"=>"string"}, {"in"=>"query", "name"=>"CacheSecurityGroupNames.CacheSecurityGroupName.N", "description"=>"A list of security group names to associate with this cache cluster", "type"=>"string"}, {"in"=>"query", "name"=>"CacheSubnetGroupName", "description"=>"The name of the subnet group to be used for the cache cluster", "type"=>"string"}, {"in"=>"query", "name"=>"Engine", "description"=>"The name of the cache engine to be used for this cache cluster", "type"=>"string"}, {"in"=>"query", "name"=>"EngineVersion", "description"=>"The version number of the cache engine to be used for this cache cluster", "type"=>"string"}, {"in"=>"query", "name"=>"NotificationTopicArn", "description"=>"The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent", "type"=>"string"}, {"in"=>"query", "name"=>"NumCacheNodes", "description"=>"The initial number of cache nodes that the cache cluster has", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port number on which each of the cache nodes accepts connections", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredAvailabilityZone", "description"=>"The EC2 Availability Zone in which the cache cluster is created", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredAvailabilityZones.PreferredAvailabilityZone.N", "description"=>"A list of the Availability Zones in which cache nodes are created", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredMaintenanceWindow", "description"=>"Specifies the weekly time range during which maintenance on the cache cluster is performed", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationGroupId", "description"=>"Important", "type"=>"string"}, {"in"=>"query", "name"=>"SecurityGroupIds.SecurityGroupId.N", "description"=>"One or more VPC security groups associated with the cache cluster", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotArns.SnapshotArn.N", "description"=>"A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotName", "description"=>"The name of a Redis snapshot from which to restore data into the new node group (shard)", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotRetentionLimit", "description"=>"The number of days for which ElastiCache retains automatic snapshots before deleting them", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotWindow", "description"=>"The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard)", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of cost allocation tags to be added to this resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Clusters"]}}, "/?Action=CreateCacheParameterGroup"=>{"get"=>{"summary"=>"Create Cache Parameter Group", "description"=>"Creates a new cache parameter group.", "operationId"=>"createCacheParameterGroup", "x-api-path-slug"=>"actioncreatecacheparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"CacheParameterGroupFamily", "description"=>"The name of the cache parameter group family that the cache parameter group can be used with", "type"=>"string"}, {"in"=>"query", "name"=>"CacheParameterGroupName", "description"=>"A user-specified name for the cache parameter group", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A user-specified description for the cache parameter group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Parameter Groups"]}}, "/?Action=CreateCacheSecurityGroup"=>{"get"=>{"summary"=>"Create Cache Security Group", "description"=>"Creates a new cache security group.", "operationId"=>"createCacheSecurityGroup", "x-api-path-slug"=>"actioncreatecachesecuritygroup-get", "parameters"=>[{"in"=>"query", "name"=>"CacheSecurityGroupName", "description"=>"A name for the cache security group", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A description for the cache security group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Security Groups"]}}, "/?Action=CreateCacheSubnetGroup"=>{"get"=>{"summary"=>"Create Cache Subnet Group", "description"=>"Creates a new cache subnet group.", "operationId"=>"createCacheSubnetGroup", "x-api-path-slug"=>"actioncreatecachesubnetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"CacheSubnetGroupDescription", "description"=>"A description for the cache subnet group", "type"=>"string"}, {"in"=>"query", "name"=>"CacheSubnetGroupName", "description"=>"A name for the cache subnet group", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetIds.SubnetIdentifier.N", "description"=>"A list of VPC subnet IDs for the cache subnet group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Subnet Groups"]}}, "/?Action=CreateReplicationGroup"=>{"get"=>{"summary"=>"Create Replication Group", "description"=>"Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.", "operationId"=>"createReplicationGroup", "x-api-path-slug"=>"actioncreatereplicationgroup-get", "parameters"=>[{"in"=>"query", "name"=>"AuthToken", "description"=>"Reserved parameter", "type"=>"string"}, {"in"=>"query", "name"=>"AutomaticFailoverEnabled", "description"=>"Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails", "type"=>"string"}, {"in"=>"query", "name"=>"AutoMinorVersionUpgrade", "description"=>"This parameter is currently disabled", "type"=>"string"}, {"in"=>"query", "name"=>"CacheNodeType", "description"=>"The compute and memory capacity of the nodes in the node group (shard)", "type"=>"string"}, {"in"=>"query", "name"=>"CacheParameterGroupName", "description"=>"The name of the parameter group to associate with this replication group", "type"=>"string"}, {"in"=>"query", "name"=>"CacheSecurityGroupNames.CacheSecurityGroupName.N", "description"=>"A list of cache security group names to associate with this replication group", "type"=>"string"}, {"in"=>"query", "name"=>"CacheSubnetGroupName", "description"=>"The name of the cache subnet group to be used for the replication group", "type"=>"string"}, {"in"=>"query", "name"=>"Engine", "description"=>"The name of the cache engine to be used for the cache clusters in this replication group", "type"=>"string"}, {"in"=>"query", "name"=>"EngineVersion", "description"=>"The version number of the cache engine to be used for the cache clusters in this replication group", "type"=>"string"}, {"in"=>"query", "name"=>"NodeGroupConfiguration.NodeGroupConfiguration.N", "description"=>"A list of node group (shard) configuration options", "type"=>"string"}, {"in"=>"query", "name"=>"NotificationTopicArn", "description"=>"The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent", "type"=>"string"}, {"in"=>"query", "name"=>"NumCacheClusters", "description"=>"The number of clusters this replication group initially has", "type"=>"string"}, {"in"=>"query", "name"=>"NumNodeGroups", "description"=>"An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port number on which each member of the replication group accepts connections", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredCacheClusterAZs.AvailabilityZone.N", "description"=>"A list of EC2 Availability Zones in which the replication groups cache clusters are created", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredMaintenanceWindow", "description"=>"Specifies the weekly time range during which maintenance on the cache cluster is performed", "type"=>"string"}, {"in"=>"query", "name"=>"PrimaryClusterId", "description"=>"The identifier of the cache cluster that serves as the primary for this replication group", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicasPerNodeGroup", "description"=>"An optional parameter that specifies the number of replica nodes in each node group (shard)", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationGroupDescription", "description"=>"A user-created description for the replication group", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationGroupId", "description"=>"The replication group identifier", "type"=>"string"}, {"in"=>"query", "name"=>"SecurityGroupIds.SecurityGroupId.N", "description"=>"One or more Amazon VPC security groups associated with this replication group", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotArns.SnapshotArn.N", "description"=>"A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotName", "description"=>"The name of a snapshot from which to restore data into the new replication group", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotRetentionLimit", "description"=>"The number of days for which ElastiCache retains automatic snapshots before deleting them", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotWindow", "description"=>"The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard)", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of cost allocation tags to be added to this resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Groups"]}}, "/?Action=CreateSnapshot"=>{"get"=>{"summary"=>"Create Snapshot", "description"=>"Creates a copy of an entire cache cluster or replication group at a\n specific moment in time.", "operationId"=>"createSnapshot", "x-api-path-slug"=>"actioncreatesnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"CacheClusterId", "description"=>"The identifier of an existing cache cluster", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationGroupId", "description"=>"The identifier of an existing replication group", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotName", "description"=>"A name for the snapshot being created", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=DeleteCacheCluster"=>{"get"=>{"summary"=>"Delete Cache Cluster", "description"=>"Deletes a previously provisioned cache cluster.", "operationId"=>"deleteCacheCluster", "x-api-path-slug"=>"actiondeletecachecluster-get", "parameters"=>[{"in"=>"query", "name"=>"CacheClusterId", "description"=>"The cache cluster identifier for the cluster to be deleted", "type"=>"string"}, {"in"=>"query", "name"=>"FinalSnapshotIdentifier", "description"=>"The user-supplied name of a final cache cluster snapshot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Clusters"]}}, "/?Action=DeleteCacheParameterGroup"=>{"get"=>{"summary"=>"Delete Cache Parameter Group", "description"=>"Deletes the specified cache parameter\n group.", "operationId"=>"deleteCacheParameterGroup", "x-api-path-slug"=>"actiondeletecacheparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"CacheParameterGroupName", "description"=>"The name of the cache parameter group to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Parameter Groups"]}}, "/?Action=DeleteCacheSecurityGroup"=>{"get"=>{"summary"=>"Delete Cache Security Group", "description"=>"Deletes a cache security group.", "operationId"=>"deleteCacheSecurityGroup", "x-api-path-slug"=>"actiondeletecachesecuritygroup-get", "parameters"=>[{"in"=>"query", "name"=>"CacheSecurityGroupName", "description"=>"The name of the cache security group to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Security Groups"]}}, "/?Action=DeleteCacheSubnetGroup"=>{"get"=>{"summary"=>"Delete Cache Subnet Group", "description"=>"Deletes a cache subnet group.", "operationId"=>"deleteCacheSubnetGroup", "x-api-path-slug"=>"actiondeletecachesubnetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"CacheSubnetGroupName", "description"=>"The name of the cache subnet group to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Subnet Groups"]}}, "/?Action=DeleteReplicationGroup"=>{"get"=>{"summary"=>"Delete Replication Group", "description"=>"Deletes an existing replication group.", "operationId"=>"deleteReplicationGroup", "x-api-path-slug"=>"actiondeletereplicationgroup-get", "parameters"=>[{"in"=>"query", "name"=>"FinalSnapshotIdentifier", "description"=>"The name of a final node group (shard) snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationGroupId", "description"=>"The identifier for the cluster to be deleted", "type"=>"string"}, {"in"=>"query", "name"=>"RetainPrimaryCluster", "description"=>"If set to true, all of the read replicas are deleted, but the primary node is retained", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Groups"]}}, "/?Action=DeleteSnapshot"=>{"get"=>{"summary"=>"Delete Snapshot", "description"=>"Deletes an existing snapshot.", "operationId"=>"deleteSnapshot", "x-api-path-slug"=>"actiondeletesnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"SnapshotName", "description"=>"The name of the snapshot to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=DescribeCacheClusters"=>{"get"=>{"summary"=>"Describe Cache Clusters", "description"=>"Returns information about all provisioned\n cache clusters if no cache cluster identifier is specified, or about a specific cache\n cluster if a cache cluster identifier is supplied.", "operationId"=>"describeCacheClusters", "x-api-path-slug"=>"actiondescribecacheclusters-get", "parameters"=>[{"in"=>"query", "name"=>"CacheClusterId", "description"=>"The user-supplied cluster identifier", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional marker returned from a prior request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"ShowCacheNodeInfo", "description"=>"An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Clusters"]}}, "/?Action=DescribeCacheEngineVersions"=>{"get"=>{"summary"=>"Describe Cache Engine Versions", "description"=>"Returns a list of the available cache\n engines and their versions.", "operationId"=>"describeCacheEngineVersions", "x-api-path-slug"=>"actiondescribecacheengineversions-get", "parameters"=>[{"in"=>"query", "name"=>"CacheParameterGroupFamily", "description"=>"The name of a specific cache parameter group family to return details for", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultOnly", "description"=>"If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned", "type"=>"string"}, {"in"=>"query", "name"=>"Engine", "description"=>"The cache engine to return", "type"=>"string"}, {"in"=>"query", "name"=>"EngineVersion", "description"=>"The cache engine version to return", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional marker returned from a prior request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Engine Versions"]}}, "/?Action=DescribeCacheParameterGroups"=>{"get"=>{"summary"=>"Describe Cache Parameter Groups", "description"=>"Returns a list of cache parameter group\n descriptions.", "operationId"=>"describeCacheParameterGroups", "x-api-path-slug"=>"actiondescribecacheparametergroups-get", "parameters"=>[{"in"=>"query", "name"=>"CacheParameterGroupName", "description"=>"The name of a specific cache parameter group to return details for", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional marker returned from a prior request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Parameter Groups"]}}, "/?Action=DescribeCacheParameters"=>{"get"=>{"summary"=>"Describe Cache Parameters", "description"=>"Returns the detailed parameter list for a\n particular cache parameter group.", "operationId"=>"describeCacheParameters", "x-api-path-slug"=>"actiondescribecacheparameters-get", "parameters"=>[{"in"=>"query", "name"=>"CacheParameterGroupName", "description"=>"The name of a specific cache parameter group to return details for", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional marker returned from a prior request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"Source", "description"=>"The parameter types to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Parameters"]}}, "/?Action=DescribeCacheSecurityGroups"=>{"get"=>{"summary"=>"Describe Cache Security Groups", "description"=>"Returns a list of cache security group\n descriptions.", "operationId"=>"describeCacheSecurityGroups", "x-api-path-slug"=>"actiondescribecachesecuritygroups-get", "parameters"=>[{"in"=>"query", "name"=>"CacheSecurityGroupName", "description"=>"The name of the cache security group to return details for", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional marker returned from a prior request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Security Groups"]}}, "/?Action=DescribeCacheSubnetGroups"=>{"get"=>{"summary"=>"Describe Cache Subnet Groups", "description"=>"Returns a list of cache subnet group\n descriptions.", "operationId"=>"describeCacheSubnetGroups", "x-api-path-slug"=>"actiondescribecachesubnetgroups-get", "parameters"=>[{"in"=>"query", "name"=>"CacheSubnetGroupName", "description"=>"The name of the cache subnet group to return details for", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional marker returned from a prior request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Subnet Groups"]}}, "/?Action=DescribeEngineDefaultParameters"=>{"get"=>{"summary"=>"Describe Engine Default Parameters", "description"=>"Returns the default engine and\n system parameter information for the specified cache engine.", "operationId"=>"describeEngineDefaultParameters", "x-api-path-slug"=>"actiondescribeenginedefaultparameters-get", "parameters"=>[{"in"=>"query", "name"=>"CacheParameterGroupFamily", "description"=>"The name of the cache parameter group family", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional marker returned from a prior request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Engine Default Parameters"]}}, "/?Action=DescribeEvents"=>{"get"=>{"summary"=>"Describe Events", "description"=>"Returns events related to cache clusters, cache\n security groups, and cache parameter groups.", "operationId"=>"describeEvents", "x-api-path-slug"=>"actiondescribeevents-get", "parameters"=>[{"in"=>"query", "name"=>"Duration", "description"=>"The number of minutes worth of events to retrieve", "type"=>"string"}, {"in"=>"query", "name"=>"EndTime", "description"=>"The end of the time interval for which to retrieve events, specified in ISO 8601 format", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional marker returned from a prior request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"SourceIdentifier", "description"=>"The identifier of the event source for which events are returned", "type"=>"string"}, {"in"=>"query", "name"=>"SourceType", "description"=>"The event source to retrieve events for", "type"=>"string"}, {"in"=>"query", "name"=>"StartTime", "description"=>"The beginning of the time interval to retrieve events for, specified in ISO 8601 format", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/?Action=DescribeReplicationGroups"=>{"get"=>{"summary"=>"Describe Replication Groups", "description"=>"Returns information about a particular\n replication group.", "operationId"=>"describeReplicationGroups", "x-api-path-slug"=>"actiondescribereplicationgroups-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"An optional marker returned from a prior request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationGroupId", "description"=>"The identifier for the replication group to be described", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Groups"]}}, "/?Action=DescribeReservedCacheNodes"=>{"get"=>{"summary"=>"Describe Reserved Cache Nodes", "description"=>"Returns information about reserved cache\n nodes for this account, or about a specified reserved cache node.", "operationId"=>"describeReservedCacheNodes", "x-api-path-slug"=>"actiondescribereservedcachenodes-get", "parameters"=>[{"in"=>"query", "name"=>"CacheNodeType", "description"=>"The cache node type filter value", "type"=>"string"}, {"in"=>"query", "name"=>"Duration", "description"=>"The duration filter value, specified in years or seconds", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional marker returned from a prior request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"OfferingType", "description"=>"The offering type filter value", "type"=>"string"}, {"in"=>"query", "name"=>"ProductDescription", "description"=>"The product description filter value", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedCacheNodeId", "description"=>"The reserved cache node identifier filter value", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedCacheNodesOfferingId", "description"=>"The offering identifier filter value", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reserved Cache Nodes"]}}, "/?Action=DescribeReservedCacheNodesOfferings"=>{"get"=>{"summary"=>"Describe Reserved Cache Nodes Offerings", "description"=>"Lists available reserved cache\n node offerings.", "operationId"=>"describeReservedCacheNodesOfferings", "x-api-path-slug"=>"actiondescribereservedcachenodesofferings-get", "parameters"=>[{"in"=>"query", "name"=>"CacheNodeType", "description"=>"The cache node type filter value", "type"=>"string"}, {"in"=>"query", "name"=>"Duration", "description"=>"Duration filter value, specified in years or seconds", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional marker returned from a prior request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"OfferingType", "description"=>"The offering type filter value", "type"=>"string"}, {"in"=>"query", "name"=>"ProductDescription", "description"=>"The product description filter value", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedCacheNodesOfferingId", "description"=>"The offering identifier filter value", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reserved Cache Nodes"]}}, "/?Action=DescribeSnapshots"=>{"get"=>{"summary"=>"Describe Snapshots", "description"=>"Returns information about cache cluster or replication group snapshots.", "operationId"=>"describeSnapshots", "x-api-path-slug"=>"actiondescribesnapshots-get", "parameters"=>[{"in"=>"query", "name"=>"CacheClusterId", "description"=>"A user-supplied cluster identifier", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional marker returned from a prior request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationGroupId", "description"=>"A user-supplied replication group identifier", "type"=>"string"}, {"in"=>"query", "name"=>"ShowNodeGroupConfig", "description"=>"A Boolean value which if true, the node group (shard) configuration is included in the snapshot description", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotName", "description"=>"A user-supplied name of the snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotSource", "description"=>"If set to system, the output shows snapshots that were automatically created by ElastiCache", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=ListAllowedNodeTypeModifications"=>{"get"=>{"summary"=>"List Allowed Node Type Modifications", "description"=>"Lists all available node types that you\n can scale your Redis cluster's or replication group's current node type up to.", "operationId"=>"listAllowedNodeTypeModifications", "x-api-path-slug"=>"actionlistallowednodetypemodifications-get", "parameters"=>[{"in"=>"query", "name"=>"CacheClusterId", "description"=>"The name of the cache cluster you want to scale up to a larger node instanced type", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationGroupId", "description"=>"The name of the replication group want to scale up to a larger node type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Node Type Modifications"]}}, "/?Action=ListAvailableNodeTypes"=>{"get"=>{"summary"=>"List Available Node Types", "description"=>".", "operationId"=>"listAvailableNodeTypes", "x-api-path-slug"=>"actionlistavailablenodetypes-get", "parameters"=>[{"in"=>"query", "name"=>"AvailableNodeTypes.member.N", "description"=>"Type: array of AvailableNodeType objects", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Node Types"]}}, "/?Action=ListTagsForResource"=>{"get"=>{"summary"=>"List Tags For Resource", "description"=>"Lists all cost allocation tags currently on the named resource.", "operationId"=>"listTagsForResource", "x-api-path-slug"=>"actionlisttagsforresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceName", "description"=>"The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Tags"]}}, "/?Action=ModifyCacheCluster"=>{"get"=>{"summary"=>"Modify Cache Cluster", "description"=>"Modifies the settings for a cache cluster.", "operationId"=>"modifyCacheCluster", "x-api-path-slug"=>"actionmodifycachecluster-get", "parameters"=>[{"in"=>"query", "name"=>"ApplyImmediately", "description"=>"If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster", "type"=>"string"}, {"in"=>"query", "name"=>"AutoMinorVersionUpgrade", "description"=>"This parameter is currently disabled", "type"=>"string"}, {"in"=>"query", "name"=>"AZMode", "description"=>"Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones", "type"=>"string"}, {"in"=>"query", "name"=>"CacheClusterId", "description"=>"The cache cluster identifier", "type"=>"string"}, {"in"=>"query", "name"=>"CacheNodeIdsToRemove.CacheNodeId.N", "description"=>"A list of cache node IDs to be removed", "type"=>"string"}, {"in"=>"query", "name"=>"CacheNodeType", "description"=>"A valid cache node type that you want to scale this cache cluster up to", "type"=>"string"}, {"in"=>"query", "name"=>"CacheParameterGroupName", "description"=>"The name of the cache parameter group to apply to this cache cluster", "type"=>"string"}, {"in"=>"query", "name"=>"CacheSecurityGroupNames.CacheSecurityGroupName.N", "description"=>"A list of cache security group names to authorize on this cache cluster", "type"=>"string"}, {"in"=>"query", "name"=>"EngineVersion", "description"=>"The upgraded version of the cache engine to be run on the cache nodes", "type"=>"string"}, {"in"=>"query", "name"=>"NewAvailabilityZones.PreferredAvailabilityZone.N", "description"=>"The list of Availability Zones where the new Memcached cache nodes are created", "type"=>"string"}, {"in"=>"query", "name"=>"NotificationTopicArn", "description"=>"The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent", "type"=>"string"}, {"in"=>"query", "name"=>"NotificationTopicStatus", "description"=>"The status of the Amazon SNS notification topic", "type"=>"string"}, {"in"=>"query", "name"=>"NumCacheNodes", "description"=>"The number of cache nodes that the cache cluster should have", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredMaintenanceWindow", "description"=>"Specifies the weekly time range during which maintenance on the cluster is performed", "type"=>"string"}, {"in"=>"query", "name"=>"SecurityGroupIds.SecurityGroupId.N", "description"=>"Specifies the VPC Security Groups associated with the cache cluster", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotRetentionLimit", "description"=>"The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotWindow", "description"=>"The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cache cluster", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Clusters"]}}, "/?Action=ModifyCacheParameterGroup"=>{"get"=>{"summary"=>"Modify Cache Parameter Group", "description"=>"Modifies the parameters of a cache\n parameter group.", "operationId"=>"modifyCacheParameterGroup", "x-api-path-slug"=>"actionmodifycacheparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"CacheParameterGroupName", "description"=>"The name of the cache parameter group to modify", "type"=>"string"}, {"in"=>"query", "name"=>"ParameterNameValues.ParameterNameValue.N", "description"=>"An array of parameter names and values for the parameter update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Parameter Groups"]}}, "/?Action=ModifyCacheSubnetGroup"=>{"get"=>{"summary"=>"Modify Cache Subnet Group", "description"=>"Modifies an existing cache subnet group.", "operationId"=>"modifyCacheSubnetGroup", "x-api-path-slug"=>"actionmodifycachesubnetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"CacheSubnetGroupDescription", "description"=>"A description of the cache subnet group", "type"=>"string"}, {"in"=>"query", "name"=>"CacheSubnetGroupName", "description"=>"The name for the cache subnet group", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetIds.SubnetIdentifier.N", "description"=>"The EC2 subnet IDs for the cache subnet group", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Subnet Groups"]}}, "/?Action=ModifyReplicationGroup"=>{"get"=>{"summary"=>"Modify Replication Group", "description"=>"Modifies the settings for a replication group.", "operationId"=>"modifyReplicationGroup", "x-api-path-slug"=>"actionmodifyreplicationgroup-get", "parameters"=>[{"in"=>"query", "name"=>"ApplyImmediately", "description"=>"If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group", "type"=>"string"}, {"in"=>"query", "name"=>"AutomaticFailoverEnabled", "description"=>"Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure", "type"=>"string"}, {"in"=>"query", "name"=>"AutoMinorVersionUpgrade", "description"=>"This parameter is currently disabled", "type"=>"string"}, {"in"=>"query", "name"=>"CacheNodeType", "description"=>"A valid cache node type that you want to scale this replication group to", "type"=>"string"}, {"in"=>"query", "name"=>"CacheParameterGroupName", "description"=>"The name of the cache parameter group to apply to all of the clusters in this replication group", "type"=>"string"}, {"in"=>"query", "name"=>"CacheSecurityGroupNames.CacheSecurityGroupName.N", "description"=>"A list of cache security group names to authorize for the clusters in this replication group", "type"=>"string"}, {"in"=>"query", "name"=>"EngineVersion", "description"=>"The upgraded version of the cache engine to be run on the cache clusters in the replication group", "type"=>"string"}, {"in"=>"query", "name"=>"NotificationTopicArn", "description"=>"The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent", "type"=>"string"}, {"in"=>"query", "name"=>"NotificationTopicStatus", "description"=>"The status of the Amazon SNS notification topic for the replication group", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredMaintenanceWindow", "description"=>"Specifies the weekly time range during which maintenance on the cluster is performed", "type"=>"string"}, {"in"=>"query", "name"=>"PrimaryClusterId", "description"=>"For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationGroupDescription", "description"=>"A description for the replication group", "type"=>"string"}, {"in"=>"query", "name"=>"ReplicationGroupId", "description"=>"The identifier of the replication group to modify", "type"=>"string"}, {"in"=>"query", "name"=>"SecurityGroupIds.SecurityGroupId.N", "description"=>"Specifies the VPC Security Groups associated with the cache clusters in the replication group", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotRetentionLimit", "description"=>"The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshottingClusterId", "description"=>"The cache cluster ID that is used as the daily snapshot source for the replication group", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotWindow", "description"=>"The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Groups"]}}, "/?Action=PurchaseReservedCacheNodesOffering"=>{"get"=>{"summary"=>"Purchase Reserved Cache Nodes Offering", "description"=>"Allows you to purchase a reserved\n cache node offering.", "operationId"=>"purchaseReservedCacheNodesOffering", "x-api-path-slug"=>"actionpurchasereservedcachenodesoffering-get", "parameters"=>[{"in"=>"query", "name"=>"CacheNodeCount", "description"=>"The number of cache node instances to reserve", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedCacheNodeId", "description"=>"A customer-specified identifier to track this reservation", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedCacheNodesOfferingId", "description"=>"The ID of the reserved cache node offering to purchase", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reserved Cache Nodes"]}}, "/?Action=RebootCacheCluster"=>{"get"=>{"summary"=>"Reboot Cache Cluster", "description"=>"Reboots some, or all, of the cache nodes\n within a provisioned cache cluster.", "operationId"=>"rebootCacheCluster", "x-api-path-slug"=>"actionrebootcachecluster-get", "parameters"=>[{"in"=>"query", "name"=>"CacheClusterId", "description"=>"The cache cluster identifier", "type"=>"string"}, {"in"=>"query", "name"=>"CacheNodeIdsToReboot.CacheNodeId.N", "description"=>"A list of cache node IDs to reboot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Clusters"]}}, "/?Action=RemoveTagsFromResource"=>{"get"=>{"summary"=>"Remove Tags From Resource", "description"=>"Removes the tags identified by the TagKeys \n list from the named resource.", "operationId"=>"removeTagsFromResource", "x-api-path-slug"=>"actionremovetagsfromresource-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceName", "description"=>"The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys.member.N", "description"=>"A list of TagKeys identifying the tags you want removed from the named resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Tags"]}}, "/?Action=ResetCacheParameterGroup"=>{"get"=>{"summary"=>"Reset Cache Parameter Group", "description"=>"Modifies the parameters of a cache\n parameter group to the engine or system default value.", "operationId"=>"resetCacheParameterGroup", "x-api-path-slug"=>"actionresetcacheparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"CacheParameterGroupName", "description"=>"The name of the cache parameter group to reset", "type"=>"string"}, {"in"=>"query", "name"=>"ParameterNameValues.ParameterNameValue.N", "description"=>"An array of parameter names to reset to their default values", "type"=>"string"}, {"in"=>"query", "name"=>"ResetAllParameters", "description"=>"If true, all parameters in the cache parameter group are reset to their default values", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Parameter Groups"]}}, "/?Action=RevokeCacheSecurityGroupIngress"=>{"get"=>{"summary"=>"Revoke Cache Security Group Ingress", "description"=>"Revokes ingress from a cache\n security group.", "operationId"=>"revokeCacheSecurityGroupIngress", "x-api-path-slug"=>"actionrevokecachesecuritygroupingress-get", "parameters"=>[{"in"=>"query", "name"=>"CacheSecurityGroupName", "description"=>"The name of the cache security group to revoke ingress from", "type"=>"string"}, {"in"=>"query", "name"=>"EC2SecurityGroupName", "description"=>"The name of the Amazon EC2 security group to revoke access from", "type"=>"string"}, {"in"=>"query", "name"=>"EC2SecurityGroupOwnerId", "description"=>"The AWS account number of the Amazon EC2 security group owner", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache Security Groups"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aspose{"aspose-storage-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Aspose", "x-complete"=>1, "info"=>{"title"=>"Aspose.Storage API", "description"=>"the-aspose-for-cloud-file-storage-api-lets-you-upload-and-download-files-for-use-with-our-product-apis", "termsOfService"=>"http://www.aspose.com/corporate/legal/terms-of-use.aspx", "version"=>"v1.1"}, "host"=>"api.aspose.com", "basePath"=>"/v1.1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/storage/disc"=>{"get"=>{"summary"=>"Get Storage Disc", "description"=>"The resource represents information about users application disc usage (size in bytes", "operationId"=>"getStorageDisc", "x-api-path-slug"=>"storagedisc-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Disc"]}}, "/storage/exist/{path}"=>{"get"=>{"summary"=>"Get Storage Exist Path", "description"=>"The controller checks that the file or folder exists in the service file storage.", "operationId"=>"getStorageExistPath", "x-api-path-slug"=>"storageexistpath-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Exist", "Path"]}}, "/storage/file/{path}"=>{"delete"=>{"summary"=>"Delete Storage File Path", "description"=>"The resource represents customers file at server file sto", "operationId"=>"deleteStorageFilePath", "x-api-path-slug"=>"storagefilepath-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "File", "Path"]}, "get"=>{"summary"=>"Get Storage File Path", "description"=>"The resource represents customers file at server file storage.", "operationId"=>"getStorageFilePath", "x-api-path-slug"=>"storagefilepath-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "File", "Path"]}, "post"=>{"summary"=>"Post Storage File Path", "description"=>"The resource represents customers file at server file storage", "operationId"=>"postStorageFilePath", "x-api-path-slug"=>"storagefilepath-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "File", "Path"]}, "put"=>{"summary"=>"Put Storage File Path", "description"=>"The resource represents customers file at server file storage.", "operationId"=>"putStorageFilePath", "x-api-path-slug"=>"storagefilepath-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "File", "Path"]}}, "/storage/folder/{folder}"=>{"delete"=>{"summary"=>"Delete Storage Folder Folder", "description"=>"The resource represents customer folder at service file storage.", "operationId"=>"deleteStorageFolderFolder", "x-api-path-slug"=>"storagefolderfolder-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Folder", "Folder"]}, "get"=>{"summary"=>"Get Storage Folder Folder", "description"=>"The resource represents customer folder at service file storage.", "operationId"=>"getStorageFolderFolder", "x-api-path-slug"=>"storagefolderfolder-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Folder", "Folder"]}, "post"=>{"summary"=>"Post Storage Folder Folder", "description"=>"The resource represents customer folder at service file storage.", "operationId"=>"postStorageFolderFolder", "x-api-path-slug"=>"storagefolderfolder-post", "parameters"=>[{"in"=>"query", "name"=>"dest", "description"=>"Moves (renames) the file to NewFile"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage", "Folder", "Folder"]}}}}, "apis"=>{"name"=>"Aspose", "x-slug"=>"aspose", "description"=>".NET Java Cloud SharePoint Android SSRS and JasperReports file format APIs for developers. Integrate in any enterprise level web desktop and mobile application", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1865-aspose.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"59913", "tags"=>"API Provider,Conversions,Documents,Enterprise,Profiles,SaaS,Service API,Stack Network,Target,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aspose/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Aspose.Storage API", "x-api-slug"=>"aspose-storage-api", "description"=>"Aspose provides cloud-based services for document generation, conversion, and automation. It works with documents created in Microsoft Word, Microsoft Excel, Microsoft PowerPoint, Adobe, and OpenDocument. It is also designed to handle barcodes, optical character recognition (OCR), and email formats and protocols. The Aspose REST APIs enable users to integrate many document processing and management tasks into their applications. These tasks include, but are not limited to, document assembly, file conversion, text extraction, barcode generation, and email tracking.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1865-aspose.jpg", "humanURL"=>"http://www.aspose.com", "baseURL"=>"https://api.aspose.com//v1.1", "tags"=>"API Provider,Conversions,Documents,Enterprise,Profiles,SaaS,Service API,Stack Network,Target,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aspose/storagefolderfolder-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aspose/aspose-storage-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api.aspose.com/"}, {"type"=>"x-blog", "url"=>"http://www.aspose.com/community/blogs/default.aspx"}, {"type"=>"x-blog-rss", "url"=>"http://www.aspose.com/community/blogs/rss.aspx"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/aspose"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/aspose"}, {"type"=>"x-developer", "url"=>"http://www.aspose.com/cloud/total-api.aspx"}, {"type"=>"x-forum", "url"=>"http://www.aspose.com/community/forums/default.aspx"}, {"type"=>"x-github", "url"=>"https://github.com/aspose"}, {"type"=>"x-pricing", "url"=>"http://www.aspose.com/purchase/pricing-info-step-1-of-4.aspx"}, {"type"=>"x-privacy", "url"=>"http://www.aspose.com/corporate/legal/privacy-policy.aspx"}, {"type"=>"x-terms-of-service", "url"=>"http://www.aspose.com/corporate/legal/terms-of-use.aspx"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Aspose"}, {"type"=>"x-videos", "url"=>"http://www.youtube.com/user/asposevideo"}, {"type"=>"x-website", "url"=>"http://www.aspose.com"}, {"type"=>"x-website", "url"=>"http://aspose.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
instagram{"instagram-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Instagram", "x-complete"=>1, "info"=>{"title"=>"Instagram Graph API", "version"=>"1.0.0"}, "host"=>"graph.facebook.com", "basePath"=>"/v3.0", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{instagram-media-id}/comments"=>{"get"=>{"summary"=>"Instagram Media Comments", "description"=>"Instagram Media Comments", "operationId"=>"getInstagramMediaComments", "x-api-path-slug"=>"123instagrammediaid125comments-get", "parameters"=>[{"in"=>"query", "name"=>"100", "description"=>"Invalid parameter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instagram", "Media", "Comments"]}}, "/{instagram-user-id}"=>{"get"=>{"summary"=>"Instagram User", "description"=>"Instagram User", "operationId"=>"getInstagramUser", "x-api-path-slug"=>"123instagramuserid125-get", "parameters"=>[{"in"=>"query", "name"=>"followed_by_countint32", "description"=>"Number of Instagram users that follow this Instagram user", "type"=>"string"}, {"in"=>"query", "name"=>"follow_countint32", "description"=>"Number of Instagram users that this Instagram user follows", "type"=>"string"}, {"in"=>"query", "name"=>"has_profile_picturebool", "description"=>"Indicates whether Instagram Account has a profile picture", "type"=>"string"}, {"in"=>"query", "name"=>"idnumeric string", "description"=>"ID of the Instagram user", "type"=>"string"}, {"in"=>"query", "name"=>"is_privatebool", "description"=>"Whether the Instagram user is private", "type"=>"string"}, {"in"=>"query", "name"=>"is_publishedbool", "description"=>"Whether the Instagram user is published", "type"=>"string"}, {"in"=>"query", "name"=>"media_countint32", "description"=>"Number of active media posted by this Instagram user", "type"=>"string"}, {"in"=>"query", "name"=>"profile_picstring", "description"=>"URI to user's Instagram profile picture", "type"=>"string"}, {"in"=>"query", "name"=>"usernamestring", "description"=>"Instagram username", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instagram", "User"]}}, "/{instagram-user-id}/agencies"=>{"get"=>{"summary"=>"Instagram User Agencies", "description"=>"Instagram User Agencies", "operationId"=>"getInstagramUserAgencies", "x-api-path-slug"=>"123instagramuserid125agencies-get", "parameters"=>[{"in"=>"query", "name"=>"294", "description"=>"Managing advertisements requires an access token with the extended permission for ads_management", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instagram", "User", "Agencies"]}}, "/{instagram-user-id}/authorized_adaccounts"=>{"get"=>{"summary"=>"Instagram User Authorized Adaccounts", "description"=>"Instagram User Authorized Adaccounts", "operationId"=>"getInstagramUserAuthorizedAdaccounts", "x-api-path-slug"=>"123instagramuserid125authorized-adaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"100", "description"=>"Invalid parameter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instagram", "User", "Authorized", "Adaccounts"]}}, "/{instagram-media-id}"=>{"get"=>{"summary"=>"Instagram Media", "description"=>"Instagram Media", "operationId"=>"getInstagramMedia", "x-api-path-slug"=>"123instagrammediaid125-get", "parameters"=>[{"in"=>"query", "name"=>"caption_textstring", "description"=>"Caption text", "type"=>"string"}, {"in"=>"query", "name"=>"comment_countint32", "description"=>"Number of comments", "type"=>"string"}, {"in"=>"query", "name"=>"content_typeint32", "description"=>"0 for photo, 1 for video", "type"=>"string"}, {"in"=>"query", "name"=>"display_urlstring", "description"=>"URL of the photo or cover frame", "type"=>"string"}, {"in"=>"query", "name"=>"filter_namestring", "description"=>"Name of filter", "type"=>"string"}, {"in"=>"query", "name"=>"idnumeric string", "description"=>"ID of the Instagram media", "type"=>"string"}, {"in"=>"query", "name"=>"latitudefloat", "description"=>"Latitude of the location", "type"=>"string"}, {"in"=>"query", "name"=>"like_countint32", "description"=>"Number of likes", "type"=>"string"}, {"in"=>"query", "name"=>"locationLocation", "description"=>"Location data", "type"=>"string"}, {"in"=>"query", "name"=>"location_namestring", "description"=>"Name of location for location tag", "type"=>"string"}, {"in"=>"query", "name"=>"longitudefloat", "description"=>"Longitude of the location", "type"=>"string"}, {"in"=>"query", "name"=>"owner_instagram_userInstagramUser", "description"=>"The Instagram user that owns this media", "type"=>"string"}, {"in"=>"query", "name"=>"permalinkstring", "description"=>"Link to the media page on Instagram", "type"=>"string"}, {"in"=>"query", "name"=>"taken_atdatetime", "description"=>"When the media was created", "type"=>"string"}, {"in"=>"query", "name"=>"video_urlstring", "description"=>"URL of the video", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instagram", "Media"]}}, "/{instagram-comment-id}"=>{"get"=>{"summary"=>"Instagram Comment", "description"=>"Instagram Comment", "operationId"=>"getInstagramComment", "x-api-path-slug"=>"123instagramcommentid125-get", "parameters"=>[{"in"=>"query", "name"=>"comment_typeenum", "description"=>"Enum indicating the type of comment {CAPTION, NORMAL, UNKNOWN}", "type"=>"string"}, {"in"=>"query", "name"=>"created_atdatetime", "description"=>"Creation time of the comment in milliseconds", "type"=>"string"}, {"in"=>"query", "name"=>"idstring", "description"=>"Base 64 encoded string of instagram_media_id and instagram_comment_id", "type"=>"string"}, {"in"=>"query", "name"=>"instagram_comment_idnumeric string", "description"=>"Id of the comment in instagram", "type"=>"string"}, {"in"=>"query", "name"=>"instagram_userInstagramUser", "description"=>"Instagram user who made the comment", "type"=>"string"}, {"in"=>"query", "name"=>"mentioned_instagram_userslistInstagramUser", "description"=>"Instagram users that are mentioned in the comment", "type"=>"string"}, {"in"=>"query", "name"=>"messagestring", "description"=>"Textual message content of the Instagram comment", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instagram", "Comment"]}}, "/{instagram-carousel-id}"=>{"get"=>{"summary"=>"Instagram Carousel", "description"=>"Instagram Carousel", "operationId"=>"getInstagramCarousel", "x-api-path-slug"=>"123instagramcarouselid125-get", "parameters"=>[{"in"=>"query", "name"=>"caption_textstring", "description"=>"Caption text", "type"=>"string"}, {"in"=>"query", "name"=>"comment_countint32", "description"=>"Number of comments", "type"=>"string"}, {"in"=>"query", "name"=>"content_typeint32", "description"=>"0 for photo, 1 for video", "type"=>"string"}, {"in"=>"query", "name"=>"display_urlstring", "description"=>"URL of the photo or cover frame", "type"=>"string"}, {"in"=>"query", "name"=>"idnumeric string", "description"=>"ID of the Instagram carousel", "type"=>"string"}, {"in"=>"query", "name"=>"like_countint32", "description"=>"Number of likes", "type"=>"string"}, {"in"=>"query", "name"=>"owner_instagram_userInstagramUser", "description"=>"The Instagram user that owns this carousel", "type"=>"string"}, {"in"=>"query", "name"=>"permalinkstring", "description"=>"Instagram permalink of the first asset", "type"=>"string"}, {"in"=>"query", "name"=>"taken_atdatetime", "description"=>"When the media was created", "type"=>"string"}, {"in"=>"query", "name"=>"video_urlstring", "description"=>"URL of the video", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instagram", "Carousel"]}}, "/{instagram-carousel-id}/comments"=>{"get"=>{"summary"=>"Instagram Carousel Comments", "description"=>"Instagram Carousel Comments", "operationId"=>"getInstagramCarouselComments", "x-api-path-slug"=>"123instagramcarouselid125comments-get", "parameters"=>[{"in"=>"query", "name"=>"100", "description"=>"Invalid parameter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instagram", "Carousel", "Comments"]}}, "/{instagram-carousel-id}/instagram_comments"=>{"get"=>{"summary"=>"Instagram Carousel Instagram Comments", "description"=>"Instagram Carousel Instagram Comments", "operationId"=>"getInstagramCarouselInstagramComments", "x-api-path-slug"=>"123instagramcarouselid125instagram-comments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instagram", "Carousel", "Instagram", "Comments"]}}}}, "apis"=>{"name"=>"Instagram", "x-slug"=>"instagram", "description"=>"Instagram is an online mobile photo-sharing, video-sharing and social networking service that enables its users to take pictures and videos, and share them on a variety of social networking platforms, such as Facebook, Twitter, Tumblr and Flickr. A distinctive feature is that it confines photos to a square shape, similar to Kodak Instamatic and Polaroid images, in contrast to the 4:3 aspect ratio typically used by mobile device cameras. Users can also apply digital filters to their images. The maximum duration for Instagram videos is 15 seconds.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/glyph-logo_May2016_200.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,Change Log Example,General Data,Historical Data API,Images,Imports,Indie EdTech Data Jam,Media,My API Stack,Pedestal,Photos,Photos,Photos,Profiles,Relative Data,Relative StreamRank,Service API,Social,Stack,Stack Network,Streams,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"instagram/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Instagram", "x-api-slug"=>"instagram", "description"=>"Instagram is an online mobile photo-sharing, video-sharing and social networking service that enables its users to take pictures and videos, and share them on a variety of social networking platforms, such as Facebook, Twitter, Tumblr and Flickr. A distinctive feature is that it confines photos to a square shape, similar to Kodak Instamatic and Polaroid images, in contrast to the 4:3 aspect ratio typically used by mobile device cameras. Users can also apply digital filters to their images. The maximum duration for Instagram videos is 15 seconds.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/glyph-logo_May2016_200.png", "humanURL"=>"http://instagram.com", "baseURL"=>"https://graph.facebook.com//v3.0", "tags"=>"API Provider,Change Log Example,General Data,Historical Data API,Images,Imports,Indie EdTech Data Jam,Media,My API Stack,Pedestal,Photos,Photos,Photos,Profiles,Relative Data,Relative StreamRank,Service API,Social,Stack,Stack Network,Streams,Streams,Streams", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/instagram/instagram-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-application-management", "url"=>"https://instagram.com/accounts/manage_access/"}, {"type"=>"x-authentication", "url"=>"http://instagram.com/developer/authentication/"}, {"type"=>"x-base", "url"=>"https://api.instagram.com"}, {"type"=>"x-blog", "url"=>"http://developers.instagram.com/"}, {"type"=>"x-blog", "url"=>"http://blog.instagram.com/"}, {"type"=>"x-blog-rss", "url"=>"http://developers.instagram.com/rss"}, {"type"=>"x-blog-rss", "url"=>"http://blog.instagram.com/rss"}, {"type"=>"x-change-log", "url"=>"https://www.instagram.com/developer/changelog/"}, {"type"=>"x-developer", "url"=>"http://instagram.com/developer/"}, {"type"=>"x-developer-showcase", "url"=>"http://instagram.com/developer/business/"}, {"type"=>"x-embeddable", "url"=>"http://instagram.com/developer/embedding/"}, {"type"=>"x-github", "url"=>"https://github.com/Instagram"}, {"type"=>"x-mobile", "url"=>"https://www.instagram.com/developer/mobile-sharing/"}, {"type"=>"x-privacy", "url"=>"https://instagram.com/about/legal/privacy/"}, {"type"=>"x-python-library", "url"=>"https://github.com/Instagram/python-instagram"}, {"type"=>"x-rate-limits", "url"=>"http://instagram.com/developer/limits/"}, {"type"=>"x-realtime", "url"=>"http://instagram.com/developer/realtime/"}, {"type"=>"x-ruby-library", "url"=>"https://github.com/Instagram/instagram-ruby-gem"}, {"type"=>"x-sandbox-environment", "url"=>"https://www.instagram.com/developer/sandbox/"}, {"type"=>"x-sandbox-invites", "url"=>"https://www.instagram.com/developer/clients/sandbox_invites/"}, {"type"=>"x-stack-overflow", "url"=>"http://stackoverflow.com/questions/tagged/instagram/"}, {"type"=>"x-subscriptions", "url"=>"https://www.instagram.com/developer/subscriptions/"}, {"type"=>"x-support", "url"=>"https://www.instagram.com/developer/support/"}, {"type"=>"x-terms-of-service", "url"=>"https://instagram.com/about/legal/terms/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/instagram"}, {"type"=>"x-website", "url"=>"http://instagram.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-adsense{"google-adsense-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Adsense", "x-complete"=>1, "info"=>{"title"=>"Google Adsense Merged API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/accounts"=>{"get"=>{"summary"=>"Get Accounts", "description"=>"List hosted accounts associated with this AdSense account by ad client id.", "operationId"=>"adsensehost.accounts.list", "x-api-path-slug"=>"accounts-get", "parameters"=>[{"in"=>"query", "name"=>"filterAdClientId", "description"=>"Ad clients to list accounts for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Account"]}}, "/accounts/{accountId}"=>{"get"=>{"summary"=>"Get Account", "description"=>"Get information about the selected associated AdSense account.", "operationId"=>"adsensehost.accounts.get", "x-api-path-slug"=>"accountsaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account to get information about"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Account"]}}, "/accounts/{accountId}/adclients"=>{"get"=>{"summary"=>"Get Ad Clients", "description"=>"List all hosted ad clients in the specified hosted account.", "operationId"=>"adsensehost.accounts.adclients.list", "x-api-path-slug"=>"accountsaccountidadclients-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account for which to list ad clients"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of ad clients to include in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A continuation token, used to page through ad clients"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Clients"]}}, "/accounts/{accountId}/adclients/{adClientId}"=>{"get"=>{"summary"=>"Get Ad Client", "description"=>"Get information about one of the ad clients in the specified publisher's AdSense account.", "operationId"=>"adsensehost.accounts.adclients.get", "x-api-path-slug"=>"accountsaccountidadclientsadclientid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account which contains the ad client"}, {"in"=>"path", "name"=>"adClientId", "description"=>"Ad client to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Clients"]}}, "/accounts/{accountId}/adclients/{adClientId}/adunits"=>{"get"=>{"summary"=>"Get Ad Units", "description"=>"List all ad units in the specified publisher's AdSense account.", "operationId"=>"adsensehost.accounts.adunits.list", "x-api-path-slug"=>"accountsaccountidadclientsadclientidadunits-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account which contains the ad client"}, {"in"=>"path", "name"=>"adClientId", "description"=>"Ad client for which to list ad units"}, {"in"=>"query", "name"=>"includeInactive", "description"=>"Whether to include inactive ad units"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of ad units to include in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A continuation token, used to page through ad units"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Units"]}, "patch"=>{"summary"=>"Update Ad Units", "description"=>"Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.", "operationId"=>"adsensehost.accounts.adunits.patch", "x-api-path-slug"=>"accountsaccountidadclientsadclientidadunits-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account which contains the ad client"}, {"in"=>"path", "name"=>"adClientId", "description"=>"Ad client which contains the ad unit"}, {"in"=>"query", "name"=>"adUnitId", "description"=>"Ad unit to get"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Units"]}, "post"=>{"summary"=>"Create Ad Unit", "description"=>"Insert the supplied ad unit into the specified publisher AdSense account.", "operationId"=>"adsensehost.accounts.adunits.insert", "x-api-path-slug"=>"accountsaccountidadclientsadclientidadunits-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account which will contain the ad unit"}, {"in"=>"path", "name"=>"adClientId", "description"=>"Ad client into which to insert the ad unit"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Units"]}, "put"=>{"summary"=>"Update Ad Unit", "description"=>"Update the supplied ad unit in the specified publisher AdSense account.", "operationId"=>"adsensehost.accounts.adunits.update", "x-api-path-slug"=>"accountsaccountidadclientsadclientidadunits-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account which contains the ad client"}, {"in"=>"path", "name"=>"adClientId", "description"=>"Ad client which contains the ad unit"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Units"]}}, "/accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}"=>{"delete"=>{"summary"=>"Delete Ad Unit", "description"=>"Delete the specified ad unit from the specified publisher AdSense account.", "operationId"=>"adsensehost.accounts.adunits.delete", "x-api-path-slug"=>"accountsaccountidadclientsadclientidadunitsadunitid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account which contains the ad unit"}, {"in"=>"path", "name"=>"adClientId", "description"=>"Ad client for which to get ad unit"}, {"in"=>"path", "name"=>"adUnitId", "description"=>"Ad unit to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Units"]}, "get"=>{"summary"=>"Get Ad Unit", "description"=>"Get the specified host ad unit in this AdSense account.", "operationId"=>"adsensehost.accounts.adunits.get", "x-api-path-slug"=>"accountsaccountidadclientsadclientidadunitsadunitid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account which contains the ad unit"}, {"in"=>"path", "name"=>"adClientId", "description"=>"Ad client for which to get ad unit"}, {"in"=>"path", "name"=>"adUnitId", "description"=>"Ad unit to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Units"]}}, "/accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode"=>{"get"=>{"summary"=>"Get Ad Unit Code", "description"=>"Get ad code for the specified ad unit, attaching the specified host custom channels.", "operationId"=>"adsensehost.accounts.adunits.getAdCode", "x-api-path-slug"=>"accountsaccountidadclientsadclientidadunitsadunitidadcode-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Account which contains the ad client"}, {"in"=>"path", "name"=>"adClientId", "description"=>"Ad client with contains the ad unit"}, {"in"=>"path", "name"=>"adUnitId", "description"=>"Ad unit to get the code for"}, {"in"=>"query", "name"=>"hostCustomChannelId", "description"=>"Host custom channel to attach to the ad code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Units"]}}, "/accounts/{accountId}/reports"=>{"get"=>{"summary"=>"Generate Report", "description"=>"Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.", "operationId"=>"adsensehost.accounts.reports.generate", "x-api-path-slug"=>"accountsaccountidreports-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Hosted account upon which to report"}, {"in"=>"query", "name"=>"dimension", "description"=>"Dimensions to base the report on"}, {"in"=>"query", "name"=>"endDate", "description"=>"End of the date range to report on in YYYY-MM-DD format, inclusive"}, {"in"=>"query", "name"=>"filter", "description"=>"Filters to be run on the report"}, {"in"=>"query", "name"=>"locale", "description"=>"Optional locale to use for translating report output to a local language"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of rows of report data to return"}, {"in"=>"query", "name"=>"metric", "description"=>"Numeric columns to include in the report"}, {"in"=>"query", "name"=>"sort", "description"=>"The name of a dimension or metric to sort the resulting report on, optionally prefixed with + to sort ascending or - to sort descending"}, {"in"=>"query", "name"=>"startDate", "description"=>"Start of the date range to report on in YYYY-MM-DD format, inclusive"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Index of the first row of report data to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}}, "/adclients"=>{"get"=>{"summary"=>"Get Ad Clients", "description"=>"List all host ad clients in this AdSense account.", "operationId"=>"adsensehost.adclients.list", "x-api-path-slug"=>"adclients-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of ad clients to include in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A continuation token, used to page through ad clients"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Clients"]}}, "/adclients/{adClientId}"=>{"get"=>{"summary"=>"Get Ad Client", "description"=>"Get information about one of the ad clients in the Host AdSense account.", "operationId"=>"adsensehost.adclients.get", "x-api-path-slug"=>"adclientsadclientid-get", "parameters"=>[{"in"=>"path", "name"=>"adClientId", "description"=>"Ad client to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Clients"]}}, "/adclients/{adClientId}/customchannels"=>{"get"=>{"summary"=>"Get Custom Channels", "description"=>"List all host custom channels in this AdSense account.", "operationId"=>"adsensehost.customchannels.list", "x-api-path-slug"=>"adclientsadclientidcustomchannels-get", "parameters"=>[{"in"=>"path", "name"=>"adClientId", "description"=>"Ad client for which to list custom channels"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of custom channels to include in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A continuation token, used to page through custom channels"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Channels"]}, "patch"=>{"summary"=>"Update Custom Channels", "description"=>"Update a custom channel in the host AdSense account. This method supports patch semantics.", "operationId"=>"adsensehost.customchannels.patch", "x-api-path-slug"=>"adclientsadclientidcustomchannels-patch", "parameters"=>[{"in"=>"path", "name"=>"adClientId", "description"=>"Ad client in which the custom channel will be updated"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"customChannelId", "description"=>"Custom channel to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Channels"]}, "post"=>{"summary"=>"Create Custom Channels", "description"=>"Add a new custom channel to the host AdSense account.", "operationId"=>"adsensehost.customchannels.insert", "x-api-path-slug"=>"adclientsadclientidcustomchannels-post", "parameters"=>[{"in"=>"path", "name"=>"adClientId", "description"=>"Ad client to which the new custom channel will be added"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Channels"]}, "put"=>{"summary"=>"Update Custom Channel", "description"=>"Update a custom channel in the host AdSense account.", "operationId"=>"adsensehost.customchannels.update", "x-api-path-slug"=>"adclientsadclientidcustomchannels-put", "parameters"=>[{"in"=>"path", "name"=>"adClientId", "description"=>"Ad client in which the custom channel will be updated"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Channels"]}}, "/adclients/{adClientId}/customchannels/{customChannelId}"=>{"delete"=>{"summary"=>"Delete Custom Channel", "description"=>"Delete a specific custom channel from the host AdSense account.", "operationId"=>"adsensehost.customchannels.delete", "x-api-path-slug"=>"adclientsadclientidcustomchannelscustomchannelid-delete", "parameters"=>[{"in"=>"path", "name"=>"adClientId", "description"=>"Ad client from which to delete the custom channel"}, {"in"=>"path", "name"=>"customChannelId", "description"=>"Custom channel to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Channels"]}, "get"=>{"summary"=>"Get Custom Channel", "description"=>"Get a specific custom channel from the host AdSense account.", "operationId"=>"adsensehost.customchannels.get", "x-api-path-slug"=>"adclientsadclientidcustomchannelscustomchannelid-get", "parameters"=>[{"in"=>"path", "name"=>"adClientId", "description"=>"Ad client from which to get the custom channel"}, {"in"=>"path", "name"=>"customChannelId", "description"=>"Custom channel to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Channels"]}}, "/adclients/{adClientId}/urlchannels"=>{"get"=>{"summary"=>"Get URL Channels", "description"=>"List all host URL channels in the host AdSense account.", "operationId"=>"adsensehost.urlchannels.list", "x-api-path-slug"=>"adclientsadclientidurlchannels-get", "parameters"=>[{"in"=>"path", "name"=>"adClientId", "description"=>"Ad client for which to list URL channels"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of URL channels to include in the response, used for paging"}, {"in"=>"query", "name"=>"pageToken", "description"=>"A continuation token, used to page through URL channels"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Channels"]}, "post"=>{"summary"=>"Add URL Channel", "description"=>"Add a new URL channel to the host AdSense account.", "operationId"=>"adsensehost.urlchannels.insert", "x-api-path-slug"=>"adclientsadclientidurlchannels-post", "parameters"=>[{"in"=>"path", "name"=>"adClientId", "description"=>"Ad client to which the new URL channel will be added"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Channels"]}}, "/adclients/{adClientId}/urlchannels/{urlChannelId}"=>{"delete"=>{"summary"=>"Delete URL Channel", "description"=>"Delete a URL channel from the host AdSense account.", "operationId"=>"adsensehost.urlchannels.delete", "x-api-path-slug"=>"adclientsadclientidurlchannelsurlchannelid-delete", "parameters"=>[{"in"=>"path", "name"=>"adClientId", "description"=>"Ad client from which to delete the URL channel"}, {"in"=>"path", "name"=>"urlChannelId", "description"=>"URL channel to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Channels"]}}, "/associationsessions/start"=>{"get"=>{"summary"=>"Create Session", "description"=>"Create an association session for initiating an association with an AdSense user.", "operationId"=>"adsensehost.associationsessions.start", "x-api-path-slug"=>"associationsessionsstart-get", "parameters"=>[{"in"=>"query", "name"=>"productCode", "description"=>"Products to associate with the user"}, {"in"=>"query", "name"=>"userLocale", "description"=>"The preferred locale of the user"}, {"in"=>"query", "name"=>"websiteLocale", "description"=>"The locale of the users hosted website"}, {"in"=>"query", "name"=>"websiteUrl", "description"=>"The URL of the users hosted website"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Session"]}}, "/associationsessions/verify"=>{"get"=>{"summary"=>"Verify Session", "description"=>"Verify an association session after the association callback returns from AdSense signup.", "operationId"=>"adsensehost.associationsessions.verify", "x-api-path-slug"=>"associationsessionsverify-get", "parameters"=>[{"in"=>"query", "name"=>"token", "description"=>"The token returned to the association callback URL"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Session"]}}, "/reports"=>{"get"=>{"summary"=>"Get Report", "description"=>"Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.", "operationId"=>"adsensehost.reports.generate", "x-api-path-slug"=>"reports-get", "parameters"=>[{"in"=>"query", "name"=>"dimension", "description"=>"Dimensions to base the report on"}, {"in"=>"query", "name"=>"endDate", "description"=>"End of the date range to report on in YYYY-MM-DD format, inclusive"}, {"in"=>"query", "name"=>"filter", "description"=>"Filters to be run on the report"}, {"in"=>"query", "name"=>"locale", "description"=>"Optional locale to use for translating report output to a local language"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of rows of report data to return"}, {"in"=>"query", "name"=>"metric", "description"=>"Numeric columns to include in the report"}, {"in"=>"query", "name"=>"sort", "description"=>"The name of a dimension or metric to sort the resulting report on, optionally prefixed with + to sort ascending or - to sort descending"}, {"in"=>"query", "name"=>"startDate", "description"=>"Start of the date range to report on in YYYY-MM-DD format, inclusive"}, {"in"=>"query", "name"=>"startIndex", "description"=>"Index of the first row of report data to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Advertising", "Report"]}}}}, "apis"=>{"name"=>"Google Adsense", "x-slug"=>"google-adsense", "description"=>"AdSense is a free, simple way to make money online by placing ads on your website. Ads are reviewed to ensure they???re high quality and relevant to your content or audience, even when viewed on smartphones and tablets. The result? You can make more money online.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-adsense.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"Advertising,API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Service API,Stack,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-adsense/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Adsense API", "x-api-slug"=>"google-adsense-api", "description"=>"AdSense is a free, simple way to make money online by placing ads on your website. Ads are reviewed to ensure they???re high quality and relevant to your content or audience, even when viewed on smartphones and tablets. The result? You can make more money online.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-adsense.png", "humanURL"=>"https://developers.google.com/adsense/", "baseURL"=>"https:///", "tags"=>"Advertising,API Provider,API Service Provider,Google APIs,Profiles,Relative Data,Service API,Stack,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-adsense/google-adsense-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://googleadsdeveloper.blogspot.com/search/label/adsense_api"}, {"type"=>"x-blog-rss", "url"=>"http://googleadsdeveloper.blogspot.com/feeds/posts/default?alt=rss"}, {"type"=>"x-developers", "url"=>"https://developers.google.com/adsense/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/AdSense"}, {"type"=>"x-website", "url"=>"https://www.google.com/adsense/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-container-registry{"azure-container-registry-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Container Registry", "x-complete"=>1, "info"=>{"title"=>"ContainerRegistryManagementClient", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/checkNameAvailability"=>{"post"=>{"summary"=>"Registries Check Name Availability", "description"=>"Checks whether the container registry name is available for use. The name must contain only alphanumeric characters, be globally unique, and between 5 and 60 characters in length.", "operationId"=>"Registries_CheckNameAvailability", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-containerregistrychecknameavailability-post", "parameters"=>[{"in"=>"body", "name"=>"registryNameCheckRequest", "description"=>"The object containing information for the availability request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Registries"]}}, "/providers/Microsoft.ContainerRegistry/operations"=>{"get"=>{"summary"=>"Operations List", "description"=>"Lists all of the available Azure Container Registry REST API operations.", "operationId"=>"Operations_List", "x-api-path-slug"=>"providersmicrosoft-containerregistryoperations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}"=>{"get"=>{"summary"=>"Registries Get", "description"=>"Gets the properties of the specified container registry.", "operationId"=>"Registries_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-containerregistryregistriesregistryname-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Registries"]}, "put"=>{"summary"=>"Registries Create", "description"=>"Creates a container registry with the specified parameters.", "operationId"=>"Registries_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-containerregistryregistriesregistryname-put", "parameters"=>[{"in"=>"body", "name"=>"registryCreateParameters", "description"=>"The parameters for creating a container registry", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Registries"]}, "delete"=>{"summary"=>"Registries Delete", "description"=>"Deletes a container registry.", "operationId"=>"Registries_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-containerregistryregistriesregistryname-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Registries"]}, "patch"=>{"summary"=>"Registries Update", "description"=>"Updates a container registry with the specified parameters.", "operationId"=>"Registries_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-containerregistryregistriesregistryname-patch", "parameters"=>[{"in"=>"body", "name"=>"registryUpdateParameters", "description"=>"The parameters for updating a container registry", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Registries"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries"=>{"get"=>{"summary"=>"Registries List By Resource Group", "description"=>"Lists all the container registries under the specified resource group.", "operationId"=>"Registries_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-containerregistryregistries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Registries"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/registries"=>{"get"=>{"summary"=>"Registries List", "description"=>"Lists all the container registries under the specified subscription.", "operationId"=>"Registries_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-containerregistryregistries-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Registries"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listCredentials"=>{"post"=>{"summary"=>"Registries List Credentials", "description"=>"Lists the login credentials for the specified container registry.", "operationId"=>"Registries_ListCredentials", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-containerregistryregistriesregistrynamelistcredentials-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Registries"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/regenerateCredential"=>{"post"=>{"summary"=>"Registries Regenerate Credential", "description"=>"Regenerates one of the login credentials for the specified container registry.", "operationId"=>"Registries_RegenerateCredential", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-containerregistryregistriesregistrynameregeneratecredential-post", "parameters"=>[{"in"=>"body", "name"=>"regenerateCredentialParameters", "description"=>"Specifies name of the password which should be regenerated -- password or password2", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Containers", "Registries"]}}}}, "apis"=>{"name"=>"Azure Container Registry", "x-slug"=>"azure-container-registry", "description"=>"Azure Container Registry allows you to store images for all types of container deployments including DC/OS, Docker Swarm, Kubernetes, and Azure services such as App Service, Batch, Service Fabric, and others. Your DevOps team can manage the configuration of apps isolated from the configuration of the hosting environment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-manage-containers.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Containers,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-container-registry/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Container Registry API", "x-api-slug"=>"azure-container-registry-api", "description"=>"Azure Container Registry allows you to store images for all types of container deployments including DC/OS, Docker Swarm, Kubernetes, and Azure services such as App Service, Batch, Service Fabric, and others. Your DevOps team can manage the configuration of apps isolated from the configuration of the hosting environment.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-manage-containers.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/container-registry/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Containers,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/azure-container-registry/azure-container-registry-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/container-registry/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/container-registry/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/container-registry/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/container-registry/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
microsoft-graph{"microsoft-graph-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Microsoft Graph", "x-complete"=>1, "info"=>{"title"=>"Microsoft Graph API", "description"=>"microsoft-graph-exposes-multiple-apis-from-office-365-and-other-microsoft-cloud-services-through-a-single-endpoint-httpsgraph-microsoft-com--microsoft-graph-simplifies-queries-that-would-otherwise-be-more-complex-", "version"=>"1.0.0"}, "host"=>"graph.microsoft.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/me/events/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"meeventsidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/users/{id | userPrincipalName}/events/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"usersid--userprincipalnameeventsidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/groups/{id}/events/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"groupsideventsidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/me/calendar/{id}/events/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"mecalendarideventsidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/users/{id | userPrincipalName}/calendar/events/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"usersid--userprincipalnamecalendareventsidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/groups/{id}/calendar/events/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"groupsidcalendareventsidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/me/calendars/{id}/events/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"mecalendarsideventsidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/users/{id | userPrincipalName}/calendars/{id}/events/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsideventsidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/me/calendargroup/calendars/{id}/events/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"mecalendargroupcalendarsideventsidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/users/{id | userPrincipalName}/calendargroup/calendars/{id}/events/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsideventsidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/me/calendargroups/{id}/calendars/{id}/events/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"mecalendargroupsidcalendarsideventsidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsideventsidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/me/messages/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"memessagesidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/users/{id | userPrincipalName}/messages/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"usersid--userprincipalnamemessagesidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/me/mailFolders/{id}/messages/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"memailfoldersidmessagesidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmessagesidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/me/mailFolders/{id}/childFolders/{id}/.../messages/{id}/attachments/{id}"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to a message.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"memailfoldersidchildfoldersid---messagesidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to a message.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"memailfoldersidchildfoldersid---messagesidattachmentsid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}/childFolders/{id}/messages/{id}/attachments/{id}"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to a message.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidchildfoldersidmessagesidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to a message.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidchildfoldersidmessagesidattachmentsid-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/groups/{id}/threads/{id}/posts/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"groupsidthreadsidpostsidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/groups/{id}/conversations/{id}/threads/{id}/posts/{id}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachment", "description"=>"Get attachment\nRead the properties and relationships of an attachment, attached to an event,\nmessage, or post.", "operationId"=>"GetAttachment", "x-api-path-slug"=>"groupsidconversationsidthreadsidpostsidattachmentsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/me/calendars/{id}"=>{"delete"=>{"summary"=>"Delete Calendar", "description"=>"Delete calendar\nDelete a calendar other than the default calendar.", "operationId"=>"DeleteCalendar", "x-api-path-slug"=>"mecalendarsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "get"=>{"summary"=>"Get Calendar", "description"=>"Get calendar\nRetrieve the properties and relationships of calendar object.", "operationId"=>"GetCalendar", "x-api-path-slug"=>"mecalendarsid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "patch"=>{"summary"=>"Update Calendar", "description"=>"Update calendar Update the properties of calendar object.", "operationId"=>"UpdateCalendar", "x-api-path-slug"=>"mecalendarsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/users/{id | userPrincipalName}/calendars/{id}"=>{"delete"=>{"summary"=>"Delete Calendar", "description"=>"Delete calendar\nDelete a calendar other than the default calendar.", "operationId"=>"DeleteCalendar", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "get"=>{"summary"=>"Get Calendar", "description"=>"Get calendar\nRetrieve the properties and relationships of calendar object.", "operationId"=>"GetCalendar", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "patch"=>{"summary"=>"Update Calendar", "description"=>"Update calendar Update the properties of calendar object.", "operationId"=>"UpdateCalendar", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/me/calendarGroup/calendars/{id}"=>{"delete"=>{"summary"=>"Delete Calendar", "description"=>"Delete calendar\nDelete a calendar other than the default calendar.", "operationId"=>"DeleteCalendar", "x-api-path-slug"=>"mecalendargroupcalendarsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "get"=>{"summary"=>"Get Calendar", "description"=>"Get calendar\nRetrieve the properties and relationships of calendar object.", "operationId"=>"GetCalendar", "x-api-path-slug"=>"mecalendargroupcalendarsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "patch"=>{"summary"=>"Update Calendar", "description"=>"Update calendar Update the properties of calendar object.", "operationId"=>"UpdateCalendar", "x-api-path-slug"=>"mecalendargroupcalendarsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/users/{id | userPrincipalName}/calendarGroup/calendars/{id}"=>{"delete"=>{"summary"=>"Delete Calendar", "description"=>"Delete calendar\nDelete a calendar other than the default calendar.", "operationId"=>"DeleteCalendar", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "get"=>{"summary"=>"Get Calendar", "description"=>"Get calendar\nRetrieve the properties and relationships of calendar object.", "operationId"=>"GetCalendar", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "patch"=>{"summary"=>"Update Calendar", "description"=>"Update calendar Update the properties of calendar object.", "operationId"=>"UpdateCalendar", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/me/calendarGroups/{id}/calendars/{id}"=>{"delete"=>{"summary"=>"Delete Calendar", "description"=>"Delete calendar\nDelete a calendar other than the default calendar.", "operationId"=>"DeleteCalendar", "x-api-path-slug"=>"mecalendargroupsidcalendarsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "get"=>{"summary"=>"Get Calendar", "description"=>"Get calendar\nRetrieve the properties and relationships of calendar object.", "operationId"=>"GetCalendar", "x-api-path-slug"=>"mecalendargroupsidcalendarsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "patch"=>{"summary"=>"Update Calendar", "description"=>"Update calendar Update the properties of calendar object.", "operationId"=>"UpdateCalendar", "x-api-path-slug"=>"mecalendargroupsidcalendarsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}"=>{"delete"=>{"summary"=>"Delete Calendar", "description"=>"Delete calendar\nDelete a calendar other than the default calendar.", "operationId"=>"DeleteCalendar", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "get"=>{"summary"=>"Get Calendar", "description"=>"Get calendar\nRetrieve the properties and relationships of calendar object.", "operationId"=>"GetCalendar", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "patch"=>{"summary"=>"Update Calendar", "description"=>"Update calendar Update the properties of calendar object.", "operationId"=>"UpdateCalendar", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/me/calendar"=>{"get"=>{"summary"=>"Get Calendar", "description"=>"Get calendar\nRetrieve the properties and relationships of calendar object.", "operationId"=>"GetCalendar", "x-api-path-slug"=>"mecalendar-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "patch"=>{"summary"=>"Update Calendar", "description"=>"Update calendar Update the properties of calendar object.", "operationId"=>"UpdateCalendar", "x-api-path-slug"=>"mecalendar-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/users/{id | userPrincipalName}/calendar"=>{"get"=>{"summary"=>"Get Calendar", "description"=>"Get calendar\nRetrieve the properties and relationships of calendar object.", "operationId"=>"GetCalendar", "x-api-path-slug"=>"usersid--userprincipalnamecalendar-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "patch"=>{"summary"=>"Update Calendar", "description"=>"Update calendar Update the properties of calendar object.", "operationId"=>"UpdateCalendar", "x-api-path-slug"=>"usersid--userprincipalnamecalendar-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/groups/{id}/calendar"=>{"get"=>{"summary"=>"Get Calendar", "description"=>"Get calendar\nRetrieve the properties and relationships of calendar object.", "operationId"=>"GetCalendar", "x-api-path-slug"=>"groupsidcalendar-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}, "patch"=>{"summary"=>"Update Calendar", "description"=>"Update calendar Update the properties of calendar object.", "operationId"=>"UpdateCalendar", "x-api-path-slug"=>"groupsidcalendar-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/me/calendar/calendarView"=>{"get"=>{"summary"=>"List Calendar View", "description"=>"List calendarView\nGet the occurrences, exceptions, and single instances of events in a calendar view defined by a time range,\nfrom the default calendar (../me/calendarview) of a user or group, or some other calendar of the user's.", "operationId"=>"ListCalendarView", "x-api-path-slug"=>"mecalendarcalendarview-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendar", "View"]}}, "/users/{id | userPrincipalName}/calendar/calendarView"=>{"get"=>{"summary"=>"List Calendar View", "description"=>"List calendarView\nGet the occurrences, exceptions, and single instances of events in a calendar view defined by a time range,\nfrom the default calendar (../me/calendarview) of a user or group, or some other calendar of the user's.", "operationId"=>"ListCalendarView", "x-api-path-slug"=>"usersid--userprincipalnamecalendarcalendarview-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "description"=>"outlook"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendar", "View"]}}, "/groups/{id}/calendar/calendarView"=>{"get"=>{"summary"=>"List Calendar View", "description"=>"List calendarView\nGet the occurrences, exceptions, and single instances of events in a calendar view defined by a time range,\nfrom the default calendar (../me/calendarview) of a user or group, or some other calendar of the user's.", "operationId"=>"ListCalendarView", "x-api-path-slug"=>"groupsidcalendarcalendarview-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "description"=>"outlook"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendar", "View"]}}, "/me/calendars/{id}/calendarView"=>{"get"=>{"summary"=>"List Calendar View", "description"=>"List calendarView\nGet the occurrences, exceptions, and single instances of events in a calendar view defined by a time range,\nfrom the default calendar (../me/calendarview) of a user or group, or some other calendar of the user's.", "operationId"=>"ListCalendarView", "x-api-path-slug"=>"mecalendarsidcalendarview-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendar", "View"]}}, "/users/{id | userPrincipalName}/calendars/{id}/calendarView"=>{"get"=>{"summary"=>"List Calendar View", "description"=>"List calendarView\nGet the occurrences, exceptions, and single instances of events in a calendar view defined by a time range,\nfrom the default calendar (../me/calendarview) of a user or group, or some other calendar of the user's.", "operationId"=>"ListCalendarView", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsidcalendarview-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendar", "View"]}}, "/me/calendarGroup/calendars/{id}/calendarView"=>{"get"=>{"summary"=>"List Calendar View", "description"=>"List calendarView\nGet the occurrences, exceptions, and single instances of events in a calendar view defined by a time range,\nfrom the default calendar (../me/calendarview) of a user or group, or some other calendar of the user's.", "operationId"=>"ListCalendarView", "x-api-path-slug"=>"mecalendargroupcalendarsidcalendarview-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendar", "View"]}}, "/users/{id | userPrincipalName}/calendarGroup/calendars/{id}/calendarView"=>{"get"=>{"summary"=>"List Calendar View", "description"=>"List calendarView\nGet the occurrences, exceptions, and single instances of events in a calendar view defined by a time range,\nfrom the default calendar (../me/calendarview) of a user or group, or some other calendar of the user's.", "operationId"=>"ListCalendarView", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsidcalendarview-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendar", "View"]}}, "/me/calendarGroups/{id}/calendars/{id}/calendarView"=>{"get"=>{"summary"=>"List Calendar View", "description"=>"List calendarView\nGet the occurrences, exceptions, and single instances of events in a calendar view defined by a time range,\nfrom the default calendar (../me/calendarview) of a user or group, or some other calendar of the user's.", "operationId"=>"ListCalendarView", "x-api-path-slug"=>"mecalendargroupsidcalendarsidcalendarview-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendar", "View"]}}, "/users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/calendarView"=>{"get"=>{"summary"=>"List Calendar View", "description"=>"List calendarView\nGet the occurrences, exceptions, and single instances of events in a calendar view defined by a time range,\nfrom the default calendar (../me/calendarview) of a user or group, or some other calendar of the user's.", "operationId"=>"ListCalendarView", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsidcalendarview-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendar", "View"]}}, "/me/calendar/events"=>{"get"=>{"summary"=>"List Events", "description"=>"List events Retrieve a list of events in a calendar. The list contains single instance meetings and series masters.", "operationId"=>"ListEvents", "x-api-path-slug"=>"mecalendarevents-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "description"=>"outlook"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Events"]}, "post"=>{"summary"=>"Create Event", "description"=>"Create Event Use this API to create a new Event in the default or the specified calendar.", "operationId"=>"CreateEvent", "x-api-path-slug"=>"mecalendarevents-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/users/{id | userPrincipalName}/calendar/events"=>{"get"=>{"summary"=>"List Events", "description"=>"List events Retrieve a list of events in a calendar. The list contains single instance meetings and series masters.", "operationId"=>"ListEvents", "x-api-path-slug"=>"usersid--userprincipalnamecalendarevents-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "description"=>"outlook"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Events"]}, "post"=>{"summary"=>"Create Event", "description"=>"Create Event Use this API to create a new Event in the default or the specified calendar.", "operationId"=>"CreateEvent", "x-api-path-slug"=>"usersid--userprincipalnamecalendarevents-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/groups/{id}/calendar/events"=>{"get"=>{"summary"=>"List Events", "description"=>"List events Retrieve a list of event objects.", "operationId"=>"ListEvents", "x-api-path-slug"=>"groupsidcalendarevents-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "description"=>"outlook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Events"]}, "post"=>{"summary"=>"Create Event", "description"=>"Create Event Use this API to create a new event.", "operationId"=>"CreateEvent", "x-api-path-slug"=>"groupsidcalendarevents-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/me/calendars/{id}/events"=>{"get"=>{"summary"=>"List Events", "description"=>"List events Retrieve a list of events in a calendar. The list contains single instance meetings and series masters.", "operationId"=>"ListEvents", "x-api-path-slug"=>"mecalendarsidevents-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "description"=>"outlook"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Events"]}, "post"=>{"summary"=>"Create Event", "description"=>"Create Event Use this API to create a new Event in the default or the specified calendar.", "operationId"=>"CreateEvent", "x-api-path-slug"=>"mecalendarsidevents-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/users/{id | userPrincipalName}/calendars/{id}/events"=>{"get"=>{"summary"=>"List Events", "description"=>"List events Retrieve a list of events in a calendar. The list contains single instance meetings and series masters.", "operationId"=>"ListEvents", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsidevents-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "description"=>"outlook"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Events"]}, "post"=>{"summary"=>"Create Event", "description"=>"Create Event Use this API to create a new Event in the default or the specified calendar.", "operationId"=>"CreateEvent", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsidevents-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/me/calendarGroup/calendars/{id}/events"=>{"get"=>{"summary"=>"List Events", "description"=>"List events Retrieve a list of events in a calendar. The list contains single instance meetings and series masters.", "operationId"=>"ListEvents", "x-api-path-slug"=>"mecalendargroupcalendarsidevents-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "description"=>"outlook"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Events"]}, "post"=>{"summary"=>"Create Event", "description"=>"Create Event Use this API to create a new Event in the default or the specified calendar.", "operationId"=>"CreateEvent", "x-api-path-slug"=>"mecalendargroupcalendarsidevents-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/users/{id | userPrincipalName}/calendarGroup/calendars/{id}/events"=>{"get"=>{"summary"=>"List Events", "description"=>"List events Retrieve a list of events in a calendar. The list contains single instance meetings and series masters.", "operationId"=>"ListEvents", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsidevents-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "description"=>"outlook"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Events"]}, "post"=>{"summary"=>"Create Event", "description"=>"Create Event Use this API to create a new Event in the default or the specified calendar.", "operationId"=>"CreateEvent", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsidevents-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/me/calendarGroups/{id}/calendars/{id}/events"=>{"get"=>{"summary"=>"List Events", "description"=>"List events Retrieve a list of events in a calendar. The list contains single instance meetings and series masters.", "operationId"=>"ListEvents", "x-api-path-slug"=>"mecalendargroupsidcalendarsidevents-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "description"=>"outlook"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Events"]}, "post"=>{"summary"=>"Create Event", "description"=>"Create Event Use this API to create a new Event in the default or the specified calendar.", "operationId"=>"CreateEvent", "x-api-path-slug"=>"mecalendargroupsidcalendarsidevents-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events"=>{"get"=>{"summary"=>"List Events", "description"=>"List events Retrieve a list of events in a calendar. The list contains single instance meetings and series masters.", "operationId"=>"ListEvents", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsidevents-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "description"=>"outlook"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Events"]}, "post"=>{"summary"=>"Create Event", "description"=>"Create Event Use this API to create a new Event in the default or the specified calendar.", "operationId"=>"CreateEvent", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsidevents-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/me/calendarGroups/{id}"=>{"delete"=>{"summary"=>"Delete Calendar Group", "description"=>"Delete calendarGroup Delete a calendar group other than the default calendar group.", "operationId"=>"DeleteCalendarGroup", "x-api-path-slug"=>"mecalendargroupsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar", "Group"]}, "get"=>{"summary"=>"Get Calendar Group", "description"=>"Get calendarGroup Retrieve the properties and relationships of a calendar group object.", "operationId"=>"GetCalendarGroup", "x-api-path-slug"=>"mecalendargroupsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar", "Group"]}, "patch"=>{"summary"=>"Update Calendargroup", "description"=>"Update calendargroup Update the properties of calendargroup object.", "operationId"=>"UpdateCalendargroup", "x-api-path-slug"=>"mecalendargroupsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendargroup"]}}, "/users/{id | userPrincipalName}/calendarGroups/{id}"=>{"delete"=>{"summary"=>"Delete Calendar Group", "description"=>"Delete calendarGroup Delete a calendar group other than the default calendar group.", "operationId"=>"DeleteCalendarGroup", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar", "Group"]}, "get"=>{"summary"=>"Get Calendar Group", "description"=>"Get calendarGroup Retrieve the properties and relationships of a calendar group object.", "operationId"=>"GetCalendarGroup", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar", "Group"]}, "patch"=>{"summary"=>"Update Calendargroup", "description"=>"Update calendargroup Update the properties of calendargroup object.", "operationId"=>"UpdateCalendargroup", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendargroup"]}}, "/me/calendarGroup/calendars"=>{"get"=>{"summary"=>"List Calendars", "description"=>"List calendars Retrieve a list of calendars belonging to a calendar group.", "operationId"=>"ListCalendars", "x-api-path-slug"=>"mecalendargroupcalendars-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendars"]}, "post"=>{"summary"=>"Create Calendar", "description"=>"Create Calendar Use this API to create a new Calendar in a calendar group.", "operationId"=>"CreateCalendar", "x-api-path-slug"=>"mecalendargroupcalendars-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/users/{id | userPrincipalName}/calendarGroup/calendars"=>{"get"=>{"summary"=>"List Calendars", "description"=>"List calendars Retrieve a list of calendars belonging to a calendar group.", "operationId"=>"ListCalendars", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendars-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendars"]}, "post"=>{"summary"=>"Create Calendar", "description"=>"Create Calendar Use this API to create a new Calendar in a calendar group.", "operationId"=>"CreateCalendar", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendars-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/me/calendarGroups/{id}/calendars"=>{"get"=>{"summary"=>"List Calendars", "description"=>"List calendars Retrieve a list of calendars belonging to a calendar group.", "operationId"=>"ListCalendars", "x-api-path-slug"=>"mecalendargroupsidcalendars-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendars"]}, "post"=>{"summary"=>"Create Calendar", "description"=>"Create Calendar Use this API to create a new Calendar in a calendar group.", "operationId"=>"CreateCalendar", "x-api-path-slug"=>"mecalendargroupsidcalendars-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/users/{id | userPrincipalName}/calendarGroups/{id}/calendars"=>{"get"=>{"summary"=>"List Calendars", "description"=>"List calendars Retrieve a list of calendars belonging to a calendar group.", "operationId"=>"ListCalendars", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendars-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendars"]}, "post"=>{"summary"=>"Create Calendar", "description"=>"Create Calendar Use this API to create a new Calendar in a calendar group.", "operationId"=>"CreateCalendar", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendars-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/workbook/worksheets(<id|name>)/charts(<name>)/series(<undefined>)/points"=>{"get"=>{"summary"=>"List Points", "description"=>"List points Retrieve a list of chartpoints objects.", "operationId"=>"ListPoints", "x-api-path-slug"=>"workbookworksheetsltidnamegtchartsltnamegtseriesltundefinedgtpoints-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Points"]}}, "/me/contacts/{id}"=>{"delete"=>{"summary"=>"Delete Contact", "description"=>"Delete contact Delete a contact.", "operationId"=>"DeleteContact", "x-api-path-slug"=>"mecontactsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}, "get"=>{"summary"=>"Get Contact", "description"=>"Get contact Retrieve the properties and relationships of a contact object.", "operationId"=>"GetContact", "x-api-path-slug"=>"mecontactsid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}, "patch"=>{"summary"=>"Update Contact", "description"=>"Update contact Update the properties of a contact object.", "operationId"=>"UpdateContact", "x-api-path-slug"=>"mecontactsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/users/{id | userPrincipalName}/contacts/{id}"=>{"delete"=>{"summary"=>"Delete Contact", "description"=>"Delete contact Delete a contact.", "operationId"=>"DeleteContact", "x-api-path-slug"=>"usersid--userprincipalnamecontactsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}, "get"=>{"summary"=>"Get Contact", "description"=>"Get contact Retrieve the properties and relationships of a contact object.", "operationId"=>"GetContact", "x-api-path-slug"=>"usersid--userprincipalnamecontactsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}, "patch"=>{"summary"=>"Update Contact", "description"=>"Update contact Update the properties of a contact object.", "operationId"=>"UpdateContact", "x-api-path-slug"=>"usersid--userprincipalnamecontactsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/me/contactFolders/{id}/contacts/{id}"=>{"delete"=>{"summary"=>"Delete Contact", "description"=>"Delete contact Delete a contact.", "operationId"=>"DeleteContact", "x-api-path-slug"=>"mecontactfoldersidcontactsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}, "patch"=>{"summary"=>"Update Contact", "description"=>"Update contact Update the properties of a contact object.", "operationId"=>"UpdateContact", "x-api-path-slug"=>"mecontactfoldersidcontactsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/users/{id | userPrincipalName}/contactFolders/{id}/contacts/{id}"=>{"delete"=>{"summary"=>"Delete Contact", "description"=>"Delete contact Delete a contact.", "operationId"=>"DeleteContact", "x-api-path-slug"=>"usersid--userprincipalnamecontactfoldersidcontactsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}, "patch"=>{"summary"=>"Update Contact", "description"=>"Update contact Update the properties of a contact object.", "operationId"=>"UpdateContact", "x-api-path-slug"=>"usersid--userprincipalnamecontactfoldersidcontactsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/me/contactFolder/{id}/childFolders/{id}/.../contacts/{id}"=>{"delete"=>{"summary"=>"Delete Contact", "description"=>"Delete contact Delete a contact.", "operationId"=>"DeleteContact", "x-api-path-slug"=>"mecontactfolderidchildfoldersid---contactsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}, "get"=>{"summary"=>"Get Contact", "description"=>"Get contact Retrieve the properties and relationships of a contact object.", "operationId"=>"GetContact", "x-api-path-slug"=>"mecontactfolderidchildfoldersid---contactsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}, "patch"=>{"summary"=>"Update Contact", "description"=>"Update contact Update the properties of a contact object.", "operationId"=>"UpdateContact", "x-api-path-slug"=>"mecontactfolderidchildfoldersid---contactsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/users/{id | userPrincipalName}/contactFolders/{id}/childFolders/{id}/contacts/{id}"=>{"delete"=>{"summary"=>"Delete Contact", "description"=>"Delete contact Delete a contact.", "operationId"=>"DeleteContact", "x-api-path-slug"=>"usersid--userprincipalnamecontactfoldersidchildfoldersidcontactsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}, "get"=>{"summary"=>"Get Contact", "description"=>"Get contact Retrieve the properties and relationships of a contact object.", "operationId"=>"GetContact", "x-api-path-slug"=>"usersid--userprincipalnamecontactfoldersidchildfoldersidcontactsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}, "patch"=>{"summary"=>"Update Contact", "description"=>"Update contact Update the properties of a contact object.", "operationId"=>"UpdateContact", "x-api-path-slug"=>"usersid--userprincipalnamecontactfoldersidchildfoldersidcontactsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/me/contactfolders/{Id}/contacts/{id}"=>{"get"=>{"summary"=>"Get Contact", "description"=>"Get contact Retrieve the properties and relationships of a contact object.", "operationId"=>"GetContact", "x-api-path-slug"=>"mecontactfoldersidcontactsid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/users/{id | userPrincipalName}/contactfolders/{id}/contacts/{id}"=>{"get"=>{"summary"=>"Get Contact", "description"=>"Get contact Retrieve the properties and relationships of a contact object.", "operationId"=>"GetContact", "x-api-path-slug"=>"usersid--userprincipalnamecontactfoldersidcontactsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/me/contactFolders/{id}"=>{"delete"=>{"summary"=>"Delete Contact Folder", "description"=>"Delete contactFolder Delete contactFolder other than the default contactFolder.", "operationId"=>"DeleteContactFolder", "x-api-path-slug"=>"mecontactfoldersid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact", "Folder"]}, "get"=>{"summary"=>"Get Contact Folder", "description"=>"Get contactFolder Get a contact folder by using the contact folder ID.", "operationId"=>"GetContactFolder", "x-api-path-slug"=>"mecontactfoldersid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact", "Folder"]}, "patch"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"mecontactfoldersid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}}, "/users/{id | userPrincipalName}/contactFolders/{id}"=>{"delete"=>{"summary"=>"Delete Contact Folder", "description"=>"Delete contactFolder Delete contactFolder other than the default contactFolder.", "operationId"=>"DeleteContactFolder", "x-api-path-slug"=>"usersid--userprincipalnamecontactfoldersid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact", "Folder"]}, "get"=>{"summary"=>"Get Contact Folder", "description"=>"Get contactFolder Get a contact folder by using the contact folder ID.", "operationId"=>"GetContactFolder", "x-api-path-slug"=>"usersid--userprincipalnamecontactfoldersid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact", "Folder"]}}, "/me/contactFolders/{id}/childFolders"=>{"get"=>{"summary"=>"List Child Folders", "description"=>"List childFolders Get a collection of child folders under the specified contact folder.", "operationId"=>"ListChildFolders", "x-api-path-slug"=>"mecontactfoldersidchildfolders-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Child", "Folders"]}, "post"=>{"summary"=>"Create Contact Folder", "description"=>"Create ContactFolder Create a new contactFolder as a child of a specified folder.", "operationId"=>"CreateContactFolder", "x-api-path-slug"=>"mecontactfoldersidchildfolders-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact", "Folder"]}}, "/users/{id | userPrincipalName}/contactFolders/{id}/childFolders"=>{"get"=>{"summary"=>"List Child Folders", "description"=>"List childFolders Get a collection of child folders under the specified contact folder.", "operationId"=>"ListChildFolders", "x-api-path-slug"=>"usersid--userprincipalnamecontactfoldersidchildfolders-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Child", "Folders"]}, "post"=>{"summary"=>"Create Contact Folder", "description"=>"Create ContactFolder Create a new contactFolder as a child of a specified folder.", "operationId"=>"CreateContactFolder", "x-api-path-slug"=>"usersid--userprincipalnamecontactfoldersidchildfolders-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact", "Folder"]}}, "/me/contacts"=>{"get"=>{"summary"=>"List Contacts", "description"=>"List contacts Get a contact collection from the default Contacts folder of the signed-in user (.../me/contacts), or from the specified contact folder.", "operationId"=>"ListContacts", "x-api-path-slug"=>"mecontacts-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Contacts"]}, "post"=>{"summary"=>"Create Contact", "description"=>"Create Contact Add a contact to the root Contacts folder or to the contacts endpoint of another contact folder.", "operationId"=>"CreateContact", "x-api-path-slug"=>"mecontacts-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/users/{id | userPrincipalName}/contacts"=>{"get"=>{"summary"=>"List Contacts", "description"=>"List contacts Get a contact collection from the default Contacts folder of the signed-in user (.../me/contacts), or from the specified contact folder.", "operationId"=>"ListContacts", "x-api-path-slug"=>"usersid--userprincipalnamecontacts-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Contacts"]}, "post"=>{"summary"=>"Create Contact", "description"=>"Create Contact Add a contact to the root Contacts folder or to the contacts endpoint of another contact folder.", "operationId"=>"CreateContact", "x-api-path-slug"=>"usersid--userprincipalnamecontacts-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/me/contactFolders/{id}/contacts"=>{"get"=>{"summary"=>"List Contacts", "description"=>"List contacts Get a contact collection from the default Contacts folder of the signed-in user (.../me/contacts), or from the specified contact folder.", "operationId"=>"ListContacts", "x-api-path-slug"=>"mecontactfoldersidcontacts-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"Id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Contacts"]}, "post"=>{"summary"=>"Create Contact", "description"=>"Create Contact Add a contact to the root Contacts folder or to the contacts endpoint of another contact folder.", "operationId"=>"CreateContact", "x-api-path-slug"=>"mecontactfoldersidcontacts-post", "parameters"=>[{"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/users/{id | userPrincipalName}/contactFolders/{id}/contacts"=>{"get"=>{"summary"=>"List Contacts", "description"=>"List contacts Get a contact collection from the default Contacts folder of the signed-in user (.../me/contacts), or from the specified contact folder.", "operationId"=>"ListContacts", "x-api-path-slug"=>"usersid--userprincipalnamecontactfoldersidcontacts-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Contacts"]}, "post"=>{"summary"=>"Create Contact", "description"=>"Create Contact Add a contact to the root Contacts folder or to the contacts endpoint of another contact folder.", "operationId"=>"CreateContact", "x-api-path-slug"=>"usersid--userprincipalnamecontactfoldersidcontacts-post", "parameters"=>[{"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/devices/{id}"=>{"delete"=>{"summary"=>"Delete Device", "description"=>"Delete device Delete a registered device.", "operationId"=>"DeleteDevice", "x-api-path-slug"=>"devicesid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device"]}, "get"=>{"summary"=>"Get Device", "description"=>"Get device Get the properties and relationships of a device object.", "operationId"=>"GetDevice", "x-api-path-slug"=>"devicesid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device"]}, "patch"=>{"summary"=>"Update Device", "description"=>"Update device Update the properties of a registered device.", "operationId"=>"UpdateDevice", "x-api-path-slug"=>"devicesid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device"]}}, "/devices"=>{"get"=>{"summary"=>"List Devices", "description"=>"List devices Retrieve a list of device objects registered in the organization.", "operationId"=>"ListDevices", "x-api-path-slug"=>"devices-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Devices"]}, "post"=>{"summary"=>"Create Device", "description"=>"Create device Create and register a new device in the organization.", "operationId"=>"CreateDevice", "x-api-path-slug"=>"devices-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-type", "description"=>"application/json", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device"]}}, "/devices/{id}/registeredOwners"=>{"get"=>{"summary"=>"List Registered Owners", "description"=>"List registeredOwners Retrieve a list of users that are registered owners of the device.", "operationId"=>"ListRegisteredOwners", "x-api-path-slug"=>"devicesidregisteredowners-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Registered", "Owners"]}, "post"=>{"summary"=>"Create Registered Owner", "description"=>"Create registeredOwner Add a user as a registered owner of the device.", "operationId"=>"CreateRegisteredOwner", "x-api-path-slug"=>"devicesidregisteredowners-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registered", "Owner"]}}, "/devices/{id}/registeredUsers"=>{"get"=>{"summary"=>"List Registered Users", "description"=>"List registeredUsers Retrieve a list of users that are registered users of the device.", "operationId"=>"ListRegisteredUsers", "x-api-path-slug"=>"devicesidregisteredusers-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Registered", "Users"]}, "post"=>{"summary"=>"Create Registered User", "description"=>"Create registeredUser Add a registered user for the device.", "operationId"=>"CreateRegisteredUser", "x-api-path-slug"=>"devicesidregisteredusers-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Registered", "User"]}}, "/me/checkMemberGroups"=>{"post"=>{"summary"=>"Check Member Groups", "description"=>"Check member groups Check for membership in a specified list of groups, and returns from that list those groups of which the specified user, group, or directory object is a member. This function is transitive.", "operationId"=>"CheckMemberGroups", "x-api-path-slug"=>"mecheckmembergroups-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Member", "Groups"]}}, "/users/{id | userPrincipalName}/checkMemberGroups"=>{"post"=>{"summary"=>"Check Member Groups", "description"=>"Check member groups Check for membership in a specified list of groups, and returns from that list those groups of which the specified user, group, or directory object is a member. This function is transitive.", "operationId"=>"CheckMemberGroups", "x-api-path-slug"=>"usersid--userprincipalnamecheckmembergroups-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Member", "Groups"]}}, "/groups/{id}/checkMemberGroups"=>{"post"=>{"summary"=>"Group Check Member Groups", "description"=>"group: checkMemberGroups Check for membership in the specified list of groups. Returns from the list those groups of which the specified group has a direct or transitive membership.", "operationId"=>"Group:CheckMemberGroups", "x-api-path-slug"=>"groupsidcheckmembergroups-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Checks", "Member", "Groups"]}}, "/directoryObjects/{id}/checkMemberGroups"=>{"post"=>{"summary"=>"Check Member Groups", "description"=>"Check member groups Check for membership in a specified list of groups, and returns from that list those groups of which the specified user, group, or directory object is a member. This function is transitive.", "operationId"=>"CheckMemberGroups", "x-api-path-slug"=>"directoryobjectsidcheckmembergroups-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Member", "Groups"]}}, "/directoryObjects/{id}"=>{"delete"=>{"summary"=>"Delete Directory Object", "description"=>"Delete directoryObject Deletes a directoryObject.", "operationId"=>"DeleteDirectoryObject", "x-api-path-slug"=>"directoryobjectsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Directory", "Object"]}, "get"=>{"summary"=>"Get Directory Object", "description"=>"Get directoryObject Retrieve the properties and relationships of directoryObject object.", "operationId"=>"GetDirectoryObject", "x-api-path-slug"=>"directoryobjectsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Directory", "Object"]}}, "/me/getMemberGroups"=>{"post"=>{"summary"=>"Get Member Groups", "description"=>"Get member groups Return all the groups that the specified user, group, or directory object is a member of. This function is transitive.", "operationId"=>"GetMemberGroups", "x-api-path-slug"=>"megetmembergroups-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Member", "Groups"]}}, "/users/{id | userPrincipalName}/getMemberGroups"=>{"post"=>{"summary"=>"Get Member Groups", "description"=>"Get member groups Return all the groups that the specified user, group, or directory object is a member of. This function is transitive.", "operationId"=>"GetMemberGroups", "x-api-path-slug"=>"usersid--userprincipalnamegetmembergroups-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Member", "Groups"]}}, "/groups/{id}/getMemberGroups"=>{"post"=>{"summary"=>"Group Get Member Groups", "description"=>"group: getMemberGroups Return all the groups that the specified group is a member of. The check is transitive, unlike reading the memberOf navigation property, which returns only the groups that the group is a direct member of.", "operationId"=>"Group:GetMemberGroups", "x-api-path-slug"=>"groupsidgetmembergroups-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "", "Member", "Groups"]}}, "/directoryObjects/{id}/getMemberGroups"=>{"post"=>{"summary"=>"Get Member Groups", "description"=>"Get member groups Return all the groups that the specified user, group, or directory object is a member of. This function is transitive.", "operationId"=>"GetMemberGroups", "x-api-path-slug"=>"directoryobjectsidgetmembergroups-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Member", "Groups"]}}, "/me/getMemberObjects"=>{"post"=>{"summary"=>"Get Member Objects", "description"=>"Get member objects Returns all the groups and directory roles that a user, group, or directory object is a member of. This function is transitive.", "operationId"=>"GetMemberObjects", "x-api-path-slug"=>"megetmemberobjects-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Member", "Objects"]}}, "/users/{id | userPrincipalName}/getMemberObjects"=>{"post"=>{"summary"=>"Get Member Objects", "description"=>"Get member objects Returns all the groups and directory roles that a user, group, or directory object is a member of. This function is transitive.", "operationId"=>"GetMemberObjects", "x-api-path-slug"=>"usersid--userprincipalnamegetmemberobjects-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Member", "Objects"]}}, "/directoryObjects/{id}/getMemberObjects"=>{"post"=>{"summary"=>"Get Member Objects", "description"=>"Get member objects Returns all the groups and directory roles that a user, group, or directory object is a member of. This function is transitive.", "operationId"=>"GetMemberObjects", "x-api-path-slug"=>"directoryobjectsidgetmemberobjects-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Member", "Objects"]}}, "/directoryRoles/{id}"=>{"get"=>{"summary"=>"Get Directory Role", "description"=>"Get directoryRole Retrieve the properties of a directoryRole object.", "operationId"=>"GetDirectoryRole", "x-api-path-slug"=>"directoryrolesid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Directory", "Role"]}}, "/directoryRoles"=>{"get"=>{"summary"=>"List Directory Roles", "description"=>"List directoryRoles List the directory roles that are activated in the tenant.", "operationId"=>"ListDirectoryRoles", "x-api-path-slug"=>"directoryroles-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Directory", "Roles"]}, "post"=>{"summary"=>"Activate Directory Role", "description"=>"Activate directoryRole Activate a directory role. To read a directory role or update its members, it must first be activated in the tenant. Only the Company Administrators and the implicit Users directory roles are activated by default. To access and assign members to another directory role, you must first activate it with its corresponding directory role template (directoryRoleTemplate).", "operationId"=>"ActivateDirectoryRole", "x-api-path-slug"=>"directoryroles-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activate", "Directory", "Role"]}}, "/directoryRoles/{id}/members"=>{"get"=>{"summary"=>"List Members", "description"=>"List members Retrieve a list of the users that are assigned to the directory role. Only users can be assigned to a directory role.", "operationId"=>"ListMembers", "x-api-path-slug"=>"directoryrolesidmembers-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Members"]}}, "/directoryRoles/{id}/members/$ref"=>{"post"=>{"summary"=>"Add Directory Role Member", "description"=>"Add directory role member Use this API to create a new directory role member.", "operationId"=>"AddDirectoryRoleMember", "x-api-path-slug"=>"directoryrolesidmembersref-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "type"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Directory", "Role", "Member"]}}, "/directoryRoleTemplates/{id}"=>{"get"=>{"summary"=>"Get Directory Role Template", "description"=>"Get directoryRoleTemplate Retrieve the properties and relationships of a directoryroletemplate object.", "operationId"=>"GetDirectoryRoleTemplate", "x-api-path-slug"=>"directoryroletemplatesid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Directory", "Role", "Template"]}}, "/directoryRoleTemplates"=>{"get"=>{"summary"=>"List Directory Role Templates", "description"=>"List directoryRoleTemplates Retrieve a list of directoryRoleTemplate objects.", "operationId"=>"ListDirectoryRoleTemplates", "x-api-path-slug"=>"directoryroletemplates-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Directory", "Role", "Templates"]}}, "/drives"=>{"get"=>{"summary"=>"List Available Drives", "description"=>"List available drives Retrieve the list of Drive resources available for a target User or Group. Your app can also request the set of document libraries on the SharePoint root site.", "operationId"=>"ListAvailableDrives", "x-api-path-slug"=>"drives-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Available", "Drives"]}}, "/me/drives"=>{"get"=>{"summary"=>"List Available Drives", "description"=>"List available drives Retrieve the list of Drive resources available for a target User or Group. Your app can also request the set of document libraries on the SharePoint root site.", "operationId"=>"ListAvailableDrives", "x-api-path-slug"=>"medrives-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Available", "Drives"]}}, "/groups/{id}/drives"=>{"get"=>{"summary"=>"List Available Drives", "description"=>"List available drives Retrieve the list of Drive resources available for a target User or Group. Your app can also request the set of document libraries on the SharePoint root site.", "operationId"=>"ListAvailableDrives", "x-api-path-slug"=>"groupsiddrives-get", "parameters"=>[{"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Available", "Drives"]}}, "/me/drive/special/{name}"=>{"get"=>{"summary"=>"Get A Special Folder By Name", "description"=>"Get a special folder by name Use the special collection to access a special folder by name.", "operationId"=>"GetASpecialFolderByName", "x-api-path-slug"=>"medrivespecialname-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Special", "FolderName"]}}, "/me/events/{id}/accept"=>{"post"=>{"summary"=>"Event Accept", "description"=>"event: accept Accept the specified event.", "operationId"=>"Event:Accept", "x-api-path-slug"=>"meeventsidaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Accept"]}}, "/users/{id | userPrincipalName}/events/{id}/accept"=>{"post"=>{"summary"=>"Event Accept", "description"=>"event: accept Accept the specified event.", "operationId"=>"Event:Accept", "x-api-path-slug"=>"usersid--userprincipalnameeventsidaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Accept"]}}, "/groups/{id}/events/{id}/accept"=>{"post"=>{"summary"=>"Event Accept", "description"=>"event: accept Accept the specified event.", "operationId"=>"Event:Accept", "x-api-path-slug"=>"groupsideventsidaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Accept"]}}, "/me/calendar/events/{id}/accept"=>{"post"=>{"summary"=>"Event Accept", "description"=>"event: accept Accept the specified event.", "operationId"=>"Event:Accept", "x-api-path-slug"=>"mecalendareventsidaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Accept"]}}, "/users/{id | userPrincipalName}/calendar/events/{id}/accept"=>{"post"=>{"summary"=>"Event Accept", "description"=>"event: accept Accept the specified event.", "operationId"=>"Event:Accept", "x-api-path-slug"=>"usersid--userprincipalnamecalendareventsidaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Accept"]}}, "/groups/{id}/calendar/events/{id}/accept"=>{"post"=>{"summary"=>"Event Accept", "description"=>"event: accept Accept the specified event.", "operationId"=>"Event:Accept", "x-api-path-slug"=>"groupsidcalendareventsidaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Accept"]}}, "/me/calendars/{id}/events/{id}/accept"=>{"post"=>{"summary"=>"Event Accept", "description"=>"event: accept Accept the specified event.", "operationId"=>"Event:Accept", "x-api-path-slug"=>"mecalendarsideventsidaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Accept"]}}, "/users/{id | userPrincipalName}/calendars/{id}/events/{id}/accept"=>{"post"=>{"summary"=>"Event Accept", "description"=>"event: accept Accept the specified event.", "operationId"=>"Event:Accept", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsideventsidaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Accept"]}}, "/me/calendargroup/calendars/{id}/events/{id}/accept"=>{"post"=>{"summary"=>"Event Accept", "description"=>"event: accept Accept the specified event.", "operationId"=>"Event:Accept", "x-api-path-slug"=>"mecalendargroupcalendarsideventsidaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Accept"]}}, "/users/{id | userPrincipalName}/calendargroup/calendars/{id}/events/{id}/accept"=>{"post"=>{"summary"=>"Event Accept", "description"=>"event: accept Accept the specified event.", "operationId"=>"Event:Accept", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsideventsidaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Accept"]}}, "/me/calendargroups/{id}/calendars/{id}/events/{id}/accept"=>{"post"=>{"summary"=>"Event Accept", "description"=>"event: accept Accept the specified event.", "operationId"=>"Event:Accept", "x-api-path-slug"=>"mecalendargroupsidcalendarsideventsidaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Accept"]}}, "/users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/accept"=>{"post"=>{"summary"=>"Event Accept", "description"=>"event: accept Accept the specified event.", "operationId"=>"Event:Accept", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsideventsidaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Accept"]}}, "/me/events/{id}/decline"=>{"post"=>{"summary"=>"Event Decline", "description"=>"event: decline Decline invitation to the specified event.", "operationId"=>"Event:Decline", "x-api-path-slug"=>"meeventsiddecline-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Decline"]}}, "/users/{id | userPrincipalName}/events/{id}/decline"=>{"post"=>{"summary"=>"Event Decline", "description"=>"event: decline Decline invitation to the specified event.", "operationId"=>"Event:Decline", "x-api-path-slug"=>"usersid--userprincipalnameeventsiddecline-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Decline"]}}, "/groups/{id}/events/{id}/decline"=>{"post"=>{"summary"=>"Event Decline", "description"=>"event: decline Decline invitation to the specified event.", "operationId"=>"Event:Decline", "x-api-path-slug"=>"groupsideventsiddecline-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Decline"]}}, "/me/calendar/events/{id}/decline"=>{"post"=>{"summary"=>"Event Decline", "description"=>"event: decline Decline invitation to the specified event.", "operationId"=>"Event:Decline", "x-api-path-slug"=>"mecalendareventsiddecline-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Decline"]}}, "/users/{id | userPrincipalName}/calendar/events/{id}/decline"=>{"post"=>{"summary"=>"Event Decline", "description"=>"event: decline Decline invitation to the specified event.", "operationId"=>"Event:Decline", "x-api-path-slug"=>"usersid--userprincipalnamecalendareventsiddecline-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Decline"]}}, "/groups/{id}/calendar/events/{id}/decline"=>{"post"=>{"summary"=>"Event Decline", "description"=>"event: decline Decline invitation to the specified event.", "operationId"=>"Event:Decline", "x-api-path-slug"=>"groupsidcalendareventsiddecline-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Decline"]}}, "/me/calendars/{id}/events/{id}/decline"=>{"post"=>{"summary"=>"Event Decline", "description"=>"event: decline Decline invitation to the specified event.", "operationId"=>"Event:Decline", "x-api-path-slug"=>"mecalendarsideventsiddecline-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Decline"]}}, "/users/{id | userPrincipalName}/calendars/{id}/events/{id}/decline"=>{"post"=>{"summary"=>"Event Decline", "description"=>"event: decline Decline invitation to the specified event.", "operationId"=>"Event:Decline", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsideventsiddecline-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Decline"]}}, "/me/calendargroup/calendars/{id}/events/{id}/decline"=>{"post"=>{"summary"=>"Event Decline", "description"=>"event: decline Decline invitation to the specified event.", "operationId"=>"Event:Decline", "x-api-path-slug"=>"mecalendargroupcalendarsideventsiddecline-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Decline"]}}, "/users/{id | userPrincipalName}/calendargroup/calendars/{id}/events/{id}/decline"=>{"post"=>{"summary"=>"Event Decline", "description"=>"event: decline Decline invitation to the specified event.", "operationId"=>"Event:Decline", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsideventsiddecline-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Decline"]}}, "/me/calendargroups/{id}/calendars/{id}/events/{id}/decline"=>{"post"=>{"summary"=>"Event Decline", "description"=>"event: decline Decline invitation to the specified event.", "operationId"=>"Event:Decline", "x-api-path-slug"=>"mecalendargroupsidcalendarsideventsiddecline-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Decline"]}}, "/users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/decline"=>{"post"=>{"summary"=>"Event Decline", "description"=>"event: decline Decline invitation to the specified event.", "operationId"=>"Event:Decline", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsideventsiddecline-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Decline"]}}, "/me/events/{id}"=>{"delete"=>{"summary"=>"Delete Event", "description"=>"Delete event Delete event.", "operationId"=>"DeleteEvent", "x-api-path-slug"=>"meeventsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "get"=>{"summary"=>"Get Event", "description"=>"Get event Get the properties and relationships of the specified event object.", "operationId"=>"GetEvent", "x-api-path-slug"=>"meeventsid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "patch"=>{"summary"=>"Update Event", "description"=>"Update event Update the properties of event object.", "operationId"=>"UpdateEvent", "x-api-path-slug"=>"meeventsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/users/{id | userPrincipalName}/events/{id}"=>{"delete"=>{"summary"=>"Delete Event", "description"=>"Delete event Delete event.", "operationId"=>"DeleteEvent", "x-api-path-slug"=>"usersid--userprincipalnameeventsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "get"=>{"summary"=>"Get Event", "description"=>"Get event Get the properties and relationships of the specified event object.", "operationId"=>"GetEvent", "x-api-path-slug"=>"usersid--userprincipalnameeventsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "patch"=>{"summary"=>"Update Event", "description"=>"Update event Update the properties of event object.", "operationId"=>"UpdateEvent", "x-api-path-slug"=>"usersid--userprincipalnameeventsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/groups/{id}/events/{id}"=>{"delete"=>{"summary"=>"Delete Event", "description"=>"Delete event Delete event.", "operationId"=>"DeleteEvent", "x-api-path-slug"=>"groupsideventsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "get"=>{"summary"=>"Get Event", "description"=>"Get event Get the properties and relationships of the specified event object.", "operationId"=>"GetEvent", "x-api-path-slug"=>"groupsideventsid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "patch"=>{"summary"=>"Update Event", "description"=>"Update event Update the properties of event object.", "operationId"=>"UpdateEvent", "x-api-path-slug"=>"groupsideventsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/me/calendar/events/{id}"=>{"delete"=>{"summary"=>"Delete Event", "description"=>"Delete event Delete event.", "operationId"=>"DeleteEvent", "x-api-path-slug"=>"mecalendareventsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "get"=>{"summary"=>"Get Event", "description"=>"Get event Get the properties and relationships of the specified event object.", "operationId"=>"GetEvent", "x-api-path-slug"=>"mecalendareventsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "patch"=>{"summary"=>"Update Event", "description"=>"Update event Update the properties of event object.", "operationId"=>"UpdateEvent", "x-api-path-slug"=>"mecalendareventsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/users/{id | userPrincipalName}/calendar/events/{id}"=>{"delete"=>{"summary"=>"Delete Event", "description"=>"Delete event Delete event.", "operationId"=>"DeleteEvent", "x-api-path-slug"=>"usersid--userprincipalnamecalendareventsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "get"=>{"summary"=>"Get Event", "description"=>"Get event Get the properties and relationships of the specified event object.", "operationId"=>"GetEvent", "x-api-path-slug"=>"usersid--userprincipalnamecalendareventsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "patch"=>{"summary"=>"Update Event", "description"=>"Update event Update the properties of event object.", "operationId"=>"UpdateEvent", "x-api-path-slug"=>"usersid--userprincipalnamecalendareventsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/groups/{id}/calendar/events/{id}/"=>{"delete"=>{"summary"=>"Delete Event", "description"=>"Delete event Delete event.", "operationId"=>"DeleteEvent", "x-api-path-slug"=>"groupsidcalendareventsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/me/calendars/{id}/events/{id}"=>{"delete"=>{"summary"=>"Delete Event", "description"=>"Delete event Delete event.", "operationId"=>"DeleteEvent", "x-api-path-slug"=>"mecalendarsideventsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "get"=>{"summary"=>"Get Event", "description"=>"Get event Get the properties and relationships of the specified event object.", "operationId"=>"GetEvent", "x-api-path-slug"=>"mecalendarsideventsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "patch"=>{"summary"=>"Update Event", "description"=>"Update event Update the properties of event object.", "operationId"=>"UpdateEvent", "x-api-path-slug"=>"mecalendarsideventsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/users/{id | userPrincipalName}/calendars/{id}/events/{id}"=>{"delete"=>{"summary"=>"Delete Event", "description"=>"Delete event Delete event.", "operationId"=>"DeleteEvent", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsideventsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "get"=>{"summary"=>"Get Event", "description"=>"Get event Get the properties and relationships of the specified event object.", "operationId"=>"GetEvent", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsideventsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "patch"=>{"summary"=>"Update Event", "description"=>"Update event Update the properties of event object.", "operationId"=>"UpdateEvent", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsideventsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/me/calendargroup/calendars/{id}/events/{id}"=>{"delete"=>{"summary"=>"Delete Event", "description"=>"Delete event Delete event.", "operationId"=>"DeleteEvent", "x-api-path-slug"=>"mecalendargroupcalendarsideventsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "get"=>{"summary"=>"Get Event", "description"=>"Get event Get the properties and relationships of the specified event object.", "operationId"=>"GetEvent", "x-api-path-slug"=>"mecalendargroupcalendarsideventsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "patch"=>{"summary"=>"Update Event", "description"=>"Update event Update the properties of event object.", "operationId"=>"UpdateEvent", "x-api-path-slug"=>"mecalendargroupcalendarsideventsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/users/{id | userPrincipalName}/calendargroup/calendars/{id}/events/{id}"=>{"delete"=>{"summary"=>"Delete Event", "description"=>"Delete event Delete event.", "operationId"=>"DeleteEvent", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsideventsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "get"=>{"summary"=>"Get Event", "description"=>"Get event Get the properties and relationships of the specified event object.", "operationId"=>"GetEvent", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsideventsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "patch"=>{"summary"=>"Update Event", "description"=>"Update event Update the properties of event object.", "operationId"=>"UpdateEvent", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsideventsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/me/calendargroups/{id}/calendars/{id}/events/{id}"=>{"delete"=>{"summary"=>"Delete Event", "description"=>"Delete event Delete event.", "operationId"=>"DeleteEvent", "x-api-path-slug"=>"mecalendargroupsidcalendarsideventsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "get"=>{"summary"=>"Get Event", "description"=>"Get event Get the properties and relationships of the specified event object.", "operationId"=>"GetEvent", "x-api-path-slug"=>"mecalendargroupsidcalendarsideventsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "patch"=>{"summary"=>"Update Event", "description"=>"Update event Update the properties of event object.", "operationId"=>"UpdateEvent", "x-api-path-slug"=>"mecalendargroupsidcalendarsideventsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}"=>{"delete"=>{"summary"=>"Delete Event", "description"=>"Delete event Delete event.", "operationId"=>"DeleteEvent", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsideventsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "get"=>{"summary"=>"Get Event", "description"=>"Get event Get the properties and relationships of the specified event object.", "operationId"=>"GetEvent", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsideventsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "patch"=>{"summary"=>"Update Event", "description"=>"Update event Update the properties of event object.", "operationId"=>"UpdateEvent", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsideventsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/me/events/{id}/dismissReminder"=>{"post"=>{"summary"=>"Event Dismiss Reminder", "description"=>"event: dismissReminder Dissmiss a reminder that has been triggered.", "operationId"=>"Event:DismissReminder", "x-api-path-slug"=>"meeventsiddismissreminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Dismiss", "Reminder"]}}, "/users/{id | userPrincipalName}/events/{id}/dismissReminder"=>{"post"=>{"summary"=>"Event Dismiss Reminder", "description"=>"event: dismissReminder Dissmiss a reminder that has been triggered.", "operationId"=>"Event:DismissReminder", "x-api-path-slug"=>"usersid--userprincipalnameeventsiddismissreminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Dismiss", "Reminder"]}}, "/groups/{id}/events/{id}/dismissReminder"=>{"post"=>{"summary"=>"Event Dismiss Reminder", "description"=>"event: dismissReminder Dissmiss a reminder that has been triggered.", "operationId"=>"Event:DismissReminder", "x-api-path-slug"=>"groupsideventsiddismissreminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Dismiss", "Reminder"]}}, "/me/calendar/events/{id}/dismissReminder"=>{"post"=>{"summary"=>"Event Dismiss Reminder", "description"=>"event: dismissReminder Dissmiss a reminder that has been triggered.", "operationId"=>"Event:DismissReminder", "x-api-path-slug"=>"mecalendareventsiddismissreminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Dismiss", "Reminder"]}}, "/users/{id | userPrincipalName}/calendar/events/{id}/dismissReminder"=>{"post"=>{"summary"=>"Event Dismiss Reminder", "description"=>"event: dismissReminder Dissmiss a reminder that has been triggered.", "operationId"=>"Event:DismissReminder", "x-api-path-slug"=>"usersid--userprincipalnamecalendareventsiddismissreminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Dismiss", "Reminder"]}}, "/groups/{id}/calendar/events/{id}/dismissReminder"=>{"post"=>{"summary"=>"Event Dismiss Reminder", "description"=>"event: dismissReminder Dissmiss a reminder that has been triggered.", "operationId"=>"Event:DismissReminder", "x-api-path-slug"=>"groupsidcalendareventsiddismissreminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Dismiss", "Reminder"]}}, "/me/calendars/{id}/events/{id}/dismissReminder"=>{"post"=>{"summary"=>"Event Dismiss Reminder", "description"=>"event: dismissReminder Dissmiss a reminder that has been triggered.", "operationId"=>"Event:DismissReminder", "x-api-path-slug"=>"mecalendarsideventsiddismissreminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Dismiss", "Reminder"]}}, "/users/{id | userPrincipalName}/calendars/{id}/events/{id}/dismissReminder"=>{"post"=>{"summary"=>"Event Dismiss Reminder", "description"=>"event: dismissReminder Dissmiss a reminder that has been triggered.", "operationId"=>"Event:DismissReminder", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsideventsiddismissreminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Dismiss", "Reminder"]}}, "/me/calendargroup/calendars/{id}/events/{id}/dismissReminder"=>{"post"=>{"summary"=>"Event Dismiss Reminder", "description"=>"event: dismissReminder Dissmiss a reminder that has been triggered.", "operationId"=>"Event:DismissReminder", "x-api-path-slug"=>"mecalendargroupcalendarsideventsiddismissreminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Dismiss", "Reminder"]}}, "/users/{id | userPrincipalName}/calendargroup/calendars/{id}/events/{id}/dismissReminder"=>{"post"=>{"summary"=>"Event Dismiss Reminder", "description"=>"event: dismissReminder Dissmiss a reminder that has been triggered.", "operationId"=>"Event:DismissReminder", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsideventsiddismissreminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Dismiss", "Reminder"]}}, "/me/calendargroups/{id}/calendars/{id}/events/{id}/dismissReminder"=>{"post"=>{"summary"=>"Event Dismiss Reminder", "description"=>"event: dismissReminder Dissmiss a reminder that has been triggered.", "operationId"=>"Event:DismissReminder", "x-api-path-slug"=>"mecalendargroupsidcalendarsideventsiddismissreminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Dismiss", "Reminder"]}}, "/users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/dismissReminder"=>{"post"=>{"summary"=>"Event Dismiss Reminder", "description"=>"event: dismissReminder Dissmiss a reminder that has been triggered.", "operationId"=>"Event:DismissReminder", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsideventsiddismissreminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Dismiss", "Reminder"]}}, "/groups/{id}/calendar/events/{id}"=>{"get"=>{"summary"=>"Get Event", "description"=>"Get event Get the properties and relationships of the specified event object.", "operationId"=>"GetEvent", "x-api-path-slug"=>"groupsidcalendareventsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}, "patch"=>{"summary"=>"Update Event", "description"=>"Update event Update the properties of event object.", "operationId"=>"UpdateEvent", "x-api-path-slug"=>"groupsidcalendareventsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/me/events/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to an event.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"meeventsidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to an event. Since there is currently a limit of 4MB on the total size of each REST request, this limits the size of the attachment you can add to under 4MB.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"meeventsidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/users/{id | userPrincipalName}/events/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to an event.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"usersid--userprincipalnameeventsidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to an event. Since there is currently a limit of 4MB on the total size of each REST request, this limits the size of the attachment you can add to under 4MB.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"usersid--userprincipalnameeventsidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/groups/{id}/events/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to an event.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"groupsideventsidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to an event. Since there is currently a limit of 4MB on the total size of each REST request, this limits the size of the attachment you can add to under 4MB.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"groupsideventsidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/me/calendar/events/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to an event.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"mecalendareventsidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to an event. Since there is currently a limit of 4MB on the total size of each REST request, this limits the size of the attachment you can add to under 4MB.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"mecalendareventsidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/users/{id | userPrincipalName}/calendar/events/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to an event.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"usersid--userprincipalnamecalendareventsidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to an event. Since there is currently a limit of 4MB on the total size of each REST request, this limits the size of the attachment you can add to under 4MB.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"usersid--userprincipalnamecalendareventsidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/groups/{id}/calendar/events/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to an event.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"groupsidcalendareventsidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to an event. Since there is currently a limit of 4MB on the total size of each REST request, this limits the size of the attachment you can add to under 4MB.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"groupsidcalendareventsidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/me/calendars/{id}/events/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to an event.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"mecalendarsideventsidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to an event. Since there is currently a limit of 4MB on the total size of each REST request, this limits the size of the attachment you can add to under 4MB.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"mecalendarsideventsidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/users/{id | userPrincipalName}/calendars/{id}/events/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to an event.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsideventsidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to an event. Since there is currently a limit of 4MB on the total size of each REST request, this limits the size of the attachment you can add to under 4MB.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsideventsidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/me/calendargroup/calendars/{id}/events/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to an event.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"mecalendargroupcalendarsideventsidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to an event. Since there is currently a limit of 4MB on the total size of each REST request, this limits the size of the attachment you can add to under 4MB.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"mecalendargroupcalendarsideventsidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/users/{id | userPrincipalName}/calendargroup/calendars/{id}/events/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to an event.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsideventsidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to an event. Since there is currently a limit of 4MB on the total size of each REST request, this limits the size of the attachment you can add to under 4MB.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsideventsidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/me/calendargroups/{id}/calendars/{id}/events/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to an event.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"mecalendargroupsidcalendarsideventsidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to an event. Since there is currently a limit of 4MB on the total size of each REST request, this limits the size of the attachment you can add to under 4MB.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"mecalendargroupsidcalendarsideventsidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to an event.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsideventsidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to an event. Since there is currently a limit of 4MB on the total size of each REST request, this limits the size of the attachment you can add to under 4MB.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsideventsidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/me/events/{id}/instances"=>{"get"=>{"summary"=>"List Instances", "description"=>"List instances Get the instances (occurrences) of an event for a specified time range. If the event is a SeriesMaster type, this returns the occurrences and exceptions of the event in the specified time range.", "operationId"=>"ListInstances", "x-api-path-slug"=>"meeventsidinstances-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Instances"]}}, "/users/{id | userPrincipalName}/events/{id}/instances"=>{"get"=>{"summary"=>"List Instances", "description"=>"List instances Get the instances (occurrences) of an event for a specified time range. If the event is a SeriesMaster type, this returns the occurrences and exceptions of the event in the specified time range.", "operationId"=>"ListInstances", "x-api-path-slug"=>"usersid--userprincipalnameeventsidinstances-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Instances"]}}, "/groups/{id}/events/{id}/instances"=>{"get"=>{"summary"=>"List Instances", "description"=>"List instances Get the instances (occurrences) of an event for a specified time range. If the event is a SeriesMaster type, this returns the occurrences and exceptions of the event in the specified time range.", "operationId"=>"ListInstances", "x-api-path-slug"=>"groupsideventsidinstances-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Instances"]}}, "/me/calendar/events/{id}/instances"=>{"get"=>{"summary"=>"List Instances", "description"=>"List instances Get the instances (occurrences) of an event for a specified time range. If the event is a SeriesMaster type, this returns the occurrences and exceptions of the event in the specified time range.", "operationId"=>"ListInstances", "x-api-path-slug"=>"mecalendareventsidinstances-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Instances"]}}, "/users/{id | userPrincipalName}/calendar/events/{id}/instances"=>{"get"=>{"summary"=>"List Instances", "description"=>"List instances Get the instances (occurrences) of an event for a specified time range. If the event is a SeriesMaster type, this returns the occurrences and exceptions of the event in the specified time range.", "operationId"=>"ListInstances", "x-api-path-slug"=>"usersid--userprincipalnamecalendareventsidinstances-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Instances"]}}, "/groups/{id}/calendar/events/{id}/instances"=>{"get"=>{"summary"=>"List Instances", "description"=>"List instances Get the instances (occurrences) of an event for a specified time range. If the event is a SeriesMaster type, this returns the occurrences and exceptions of the event in the specified time range.", "operationId"=>"ListInstances", "x-api-path-slug"=>"groupsidcalendareventsidinstances-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Instances"]}}, "/me/calendars/{id}/events/{id}/instances"=>{"get"=>{"summary"=>"List Instances", "description"=>"List instances Get the instances (occurrences) of an event for a specified time range. If the event is a SeriesMaster type, this returns the occurrences and exceptions of the event in the specified time range.", "operationId"=>"ListInstances", "x-api-path-slug"=>"mecalendarsideventsidinstances-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Instances"]}}, "/users/{id | userPrincipalName}/calendars/{id}/events/{id}/instances"=>{"get"=>{"summary"=>"List Instances", "description"=>"List instances Get the instances (occurrences) of an event for a specified time range. If the event is a SeriesMaster type, this returns the occurrences and exceptions of the event in the specified time range.", "operationId"=>"ListInstances", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsideventsidinstances-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Instances"]}}, "/me/calendargroup/calendars/{id}/events/{id}/instances"=>{"get"=>{"summary"=>"List Instances", "description"=>"List instances Get the instances (occurrences) of an event for a specified time range. If the event is a SeriesMaster type, this returns the occurrences and exceptions of the event in the specified time range.", "operationId"=>"ListInstances", "x-api-path-slug"=>"mecalendargroupcalendarsideventsidinstances-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Instances"]}}, "/users/{id | userPrincipalName}/calendargroup/calendars/{id}/events/{id}/instances"=>{"get"=>{"summary"=>"List Instances", "description"=>"List instances Get the instances (occurrences) of an event for a specified time range. If the event is a SeriesMaster type, this returns the occurrences and exceptions of the event in the specified time range.", "operationId"=>"ListInstances", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsideventsidinstances-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Instances"]}}, "/me/calendargroups/{id}/calendars/{id}/events/{id}/instances"=>{"get"=>{"summary"=>"List Instances", "description"=>"List instances Get the instances (occurrences) of an event for a specified time range. If the event is a SeriesMaster type, this returns the occurrences and exceptions of the event in the specified time range.", "operationId"=>"ListInstances", "x-api-path-slug"=>"mecalendargroupsidcalendarsideventsidinstances-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Instances"]}}, "/users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/instances"=>{"get"=>{"summary"=>"List Instances", "description"=>"List instances Get the instances (occurrences) of an event for a specified time range. If the event is a SeriesMaster type, this returns the occurrences and exceptions of the event in the specified time range.", "operationId"=>"ListInstances", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsideventsidinstances-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Instances"]}}, "/me/events/{id}/snoozeReminder"=>{"post"=>{"summary"=>"Event Snooze Reminder", "description"=>"event: snoozeReminder Postpone a reminder until a new time.", "operationId"=>"Event:SnoozeReminder", "x-api-path-slug"=>"meeventsidsnoozereminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Snooze", "Reminder"]}}, "/users/{id | userPrincipalName}/events/{id}/snoozeReminder"=>{"post"=>{"summary"=>"Event Snooze Reminder", "description"=>"event: snoozeReminder Postpone a reminder until a new time.", "operationId"=>"Event:SnoozeReminder", "x-api-path-slug"=>"usersid--userprincipalnameeventsidsnoozereminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Snooze", "Reminder"]}}, "/groups/{id}/events/{id}/snoozeReminder"=>{"post"=>{"summary"=>"Event Snooze Reminder", "description"=>"event: snoozeReminder Postpone a reminder until a new time.", "operationId"=>"Event:SnoozeReminder", "x-api-path-slug"=>"groupsideventsidsnoozereminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Snooze", "Reminder"]}}, "/me/calendar/events/{id}/snoozeReminder"=>{"post"=>{"summary"=>"Event Snooze Reminder", "description"=>"event: snoozeReminder Postpone a reminder until a new time.", "operationId"=>"Event:SnoozeReminder", "x-api-path-slug"=>"mecalendareventsidsnoozereminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Snooze", "Reminder"]}}, "/users/{id | userPrincipalName}/calendar/events/{id}/snoozeReminder"=>{"post"=>{"summary"=>"Event Snooze Reminder", "description"=>"event: snoozeReminder Postpone a reminder until a new time.", "operationId"=>"Event:SnoozeReminder", "x-api-path-slug"=>"usersid--userprincipalnamecalendareventsidsnoozereminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Snooze", "Reminder"]}}, "/groups/{id}/calendar/events/{id}/snoozeReminder"=>{"post"=>{"summary"=>"Event Snooze Reminder", "description"=>"event: snoozeReminder Postpone a reminder until a new time.", "operationId"=>"Event:SnoozeReminder", "x-api-path-slug"=>"groupsidcalendareventsidsnoozereminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Snooze", "Reminder"]}}, "/me/calendars/{id}/events/{id}/snoozeReminder"=>{"post"=>{"summary"=>"Event Snooze Reminder", "description"=>"event: snoozeReminder Postpone a reminder until a new time.", "operationId"=>"Event:SnoozeReminder", "x-api-path-slug"=>"mecalendarsideventsidsnoozereminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Snooze", "Reminder"]}}, "/users/{id | userPrincipalName}/calendars/{id}/events/{id}/snoozeReminder"=>{"post"=>{"summary"=>"Event Snooze Reminder", "description"=>"event: snoozeReminder Postpone a reminder until a new time.", "operationId"=>"Event:SnoozeReminder", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsideventsidsnoozereminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Snooze", "Reminder"]}}, "/me/calendargroup/calendars/{id}/events/{id}/snoozeReminder"=>{"post"=>{"summary"=>"Event Snooze Reminder", "description"=>"event: snoozeReminder Postpone a reminder until a new time.", "operationId"=>"Event:SnoozeReminder", "x-api-path-slug"=>"mecalendargroupcalendarsideventsidsnoozereminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Snooze", "Reminder"]}}, "/users/{id | userPrincipalName}/calendargroup/calendars/{id}/events/{id}/snoozeReminder"=>{"post"=>{"summary"=>"Event Snooze Reminder", "description"=>"event: snoozeReminder Postpone a reminder until a new time.", "operationId"=>"Event:SnoozeReminder", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsideventsidsnoozereminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Snooze", "Reminder"]}}, "/me/calendargroups/{id}/calendars/{id}/events/{id}/snoozeReminder"=>{"post"=>{"summary"=>"Event Snooze Reminder", "description"=>"event: snoozeReminder Postpone a reminder until a new time.", "operationId"=>"Event:SnoozeReminder", "x-api-path-slug"=>"mecalendargroupsidcalendarsideventsidsnoozereminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Snooze", "Reminder"]}}, "/users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/snoozeReminder"=>{"post"=>{"summary"=>"Event Snooze Reminder", "description"=>"event: snoozeReminder Postpone a reminder until a new time.", "operationId"=>"Event:SnoozeReminder", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsideventsidsnoozereminder-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Snooze", "Reminder"]}}, "/me/events/{id}/tentativelyAccept"=>{"post"=>{"summary"=>"Event Tentatively Accept", "description"=>"event: tentativelyAccept Tentatively accept the specified event.", "operationId"=>"Event:TentativelyAccept", "x-api-path-slug"=>"meeventsidtentativelyaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Tentatively", "Accept"]}}, "/users/{id | userPrincipalName}/events/{id}/tentativelyAccept"=>{"post"=>{"summary"=>"Event Tentatively Accept", "description"=>"event: tentativelyAccept Tentatively accept the specified event.", "operationId"=>"Event:TentativelyAccept", "x-api-path-slug"=>"usersid--userprincipalnameeventsidtentativelyaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Tentatively", "Accept"]}}, "/groups/{id}/events/{id}/tentativelyAccept"=>{"post"=>{"summary"=>"Event Tentatively Accept", "description"=>"event: tentativelyAccept Tentatively accept the specified event.", "operationId"=>"Event:TentativelyAccept", "x-api-path-slug"=>"groupsideventsidtentativelyaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Tentatively", "Accept"]}}, "/me/calendar/events/{id}/tentativelyAccept"=>{"post"=>{"summary"=>"Event Tentatively Accept", "description"=>"event: tentativelyAccept Tentatively accept the specified event.", "operationId"=>"Event:TentativelyAccept", "x-api-path-slug"=>"mecalendareventsidtentativelyaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Tentatively", "Accept"]}}, "/users/{id | userPrincipalName}/calendar/events/{id}/tentativelyAccept"=>{"post"=>{"summary"=>"Event Tentatively Accept", "description"=>"event: tentativelyAccept Tentatively accept the specified event.", "operationId"=>"Event:TentativelyAccept", "x-api-path-slug"=>"usersid--userprincipalnamecalendareventsidtentativelyaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Tentatively", "Accept"]}}, "/groups/{id}/calendar/events/{id}/tentativelyAccept"=>{"post"=>{"summary"=>"Event Tentatively Accept", "description"=>"event: tentativelyAccept Tentatively accept the specified event.", "operationId"=>"Event:TentativelyAccept", "x-api-path-slug"=>"groupsidcalendareventsidtentativelyaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Tentatively", "Accept"]}}, "/me/calendars/{id}/events/{id}/tentativelyAccept"=>{"post"=>{"summary"=>"Event Tentatively Accept", "description"=>"event: tentativelyAccept Tentatively accept the specified event.", "operationId"=>"Event:TentativelyAccept", "x-api-path-slug"=>"mecalendarsideventsidtentativelyaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Tentatively", "Accept"]}}, "/users/{id | userPrincipalName}/calendars/{id}/events/{id}/tentativelyAccept"=>{"post"=>{"summary"=>"Event Tentatively Accept", "description"=>"event: tentativelyAccept Tentatively accept the specified event.", "operationId"=>"Event:TentativelyAccept", "x-api-path-slug"=>"usersid--userprincipalnamecalendarsideventsidtentativelyaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Tentatively", "Accept"]}}, "/me/calendargroup/calendars/{id}/events/{id}/tentativelyAccept"=>{"post"=>{"summary"=>"Event Tentatively Accept", "description"=>"event: tentativelyAccept Tentatively accept the specified event.", "operationId"=>"Event:TentativelyAccept", "x-api-path-slug"=>"mecalendargroupcalendarsideventsidtentativelyaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Tentatively", "Accept"]}}, "/users/{id | userPrincipalName}/calendargroup/calendars/{id}/events/{id}/tentativelyAccept"=>{"post"=>{"summary"=>"Event Tentatively Accept", "description"=>"event: tentativelyAccept Tentatively accept the specified event.", "operationId"=>"Event:TentativelyAccept", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupcalendarsideventsidtentativelyaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Tentatively", "Accept"]}}, "/me/calendargroups/{id}/calendars/{id}/events/{id}/tentativelyAccept"=>{"post"=>{"summary"=>"Event Tentatively Accept", "description"=>"event: tentativelyAccept Tentatively accept the specified event.", "operationId"=>"Event:TentativelyAccept", "x-api-path-slug"=>"mecalendargroupsidcalendarsideventsidtentativelyaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Tentatively", "Accept"]}}, "/users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/tentativelyAccept"=>{"post"=>{"summary"=>"Event Tentatively Accept", "description"=>"event: tentativelyAccept Tentatively accept the specified event.", "operationId"=>"Event:TentativelyAccept", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupsidcalendarsideventsidtentativelyaccept-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event", "Tentatively", "Accept"]}}, "/me/messages/{id}"=>{"delete"=>{"summary"=>"Delete Message", "description"=>"Delete message Delete message.", "operationId"=>"DeleteMessage", "x-api-path-slug"=>"memessagesid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}, "get"=>{"summary"=>"Get Message", "description"=>"Get message Retrieve the properties and relationships of a message object.", "operationId"=>"GetMessage", "x-api-path-slug"=>"memessagesid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}, "patch"=>{"summary"=>"Update Message", "description"=>"Update message Update the properties of message object.", "operationId"=>"UpdateMessage", "x-api-path-slug"=>"memessagesid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}}, "/users/{id | userPrincipalName}/messages/{id}"=>{"delete"=>{"summary"=>"Delete Message", "description"=>"Delete message Delete message.", "operationId"=>"DeleteMessage", "x-api-path-slug"=>"usersid--userprincipalnamemessagesid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}, "get"=>{"summary"=>"Get Message", "description"=>"Get message Retrieve the properties and relationships of a message object.", "operationId"=>"GetMessage", "x-api-path-slug"=>"usersid--userprincipalnamemessagesid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}, "patch"=>{"summary"=>"Update Message", "description"=>"Update message Update the properties of message object.", "operationId"=>"UpdateMessage", "x-api-path-slug"=>"usersid--userprincipalnamemessagesid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}}, "/me/mailFolders/{id}/messages/{id}"=>{"delete"=>{"summary"=>"Delete Message", "description"=>"Delete message Delete message.", "operationId"=>"DeleteMessage", "x-api-path-slug"=>"memailfoldersidmessagesid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}, "get"=>{"summary"=>"Get Message", "description"=>"Get message Retrieve the properties and relationships of a message object.", "operationId"=>"GetMessage", "x-api-path-slug"=>"memailfoldersidmessagesid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}, "patch"=>{"summary"=>"Update Message", "description"=>"Update message Update the properties of message object.", "operationId"=>"UpdateMessage", "x-api-path-slug"=>"memailfoldersidmessagesid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}"=>{"delete"=>{"summary"=>"Delete Message", "description"=>"Delete message Delete message.", "operationId"=>"DeleteMessage", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmessagesid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}, "get"=>{"summary"=>"Get Message", "description"=>"Get message Retrieve the properties and relationships of a message object.", "operationId"=>"GetMessage", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmessagesid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}, "patch"=>{"summary"=>"Update Message", "description"=>"Update message Update the properties of message object.", "operationId"=>"UpdateMessage", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmessagesid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}}, "/me/messages/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to a message.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"memessagesidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to a message.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"memessagesidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/users/{id | userPrincipalName}/messages/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to a message.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"usersid--userprincipalnamemessagesidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to a message.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"usersid--userprincipalnamemessagesidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/filter/apply"=>{"post"=>{"summary"=>"Filter Apply", "description"=>"Filter: apply Apply the given filter criteria on the given column.", "operationId"=>"Filter:Apply", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtfilterapply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filter", "Apply"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/columns(<id|name>)/filter/apply"=>{"post"=>{"summary"=>"Filter Apply", "description"=>"Filter: apply Apply the given filter criteria on the given column.", "operationId"=>"Filter:Apply", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtcolumnsltidnamegtfilterapply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filter", "Apply"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/filter/clear"=>{"post"=>{"summary"=>"Filter Clear", "description"=>"Filter: clear Clear the filter on the given column.", "operationId"=>"Filter:Clear", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtfilterclear-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filter", "Clear"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/columns(<id|name>)/filter/clear"=>{"post"=>{"summary"=>"Filter Clear", "description"=>"Filter: clear Clear the filter on the given column.", "operationId"=>"Filter:Clear", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtcolumnsltidnamegtfilterclear-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filter", "Clear"]}}, "/workbook/names(<name>)/range/format/protection"=>{"get"=>{"summary"=>"Get Format Protection", "description"=>"Get FormatProtection Retrieve the properties and relationships of formatprotection object.", "operationId"=>"GetFormatProtection", "x-api-path-slug"=>"workbooknamesltnamegtrangeformatprotection-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Format", "Protection"]}, "patch"=>{"summary"=>"Update Formatprotection", "description"=>"Update formatprotection Update the properties of formatprotection object.", "operationId"=>"UpdateFormatprotection", "x-api-path-slug"=>"workbooknamesltnamegtrangeformatprotection-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Formatprotection"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/format/protection"=>{"get"=>{"summary"=>"Get Format Protection", "description"=>"Get FormatProtection Retrieve the properties and relationships of formatprotection object.", "operationId"=>"GetFormatProtection", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtformatprotection-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Format", "Protection"]}, "patch"=>{"summary"=>"Update Formatprotection", "description"=>"Update formatprotection Update the properties of formatprotection object.", "operationId"=>"UpdateFormatprotection", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtformatprotection-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Formatprotection"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/format/protection"=>{"get"=>{"summary"=>"Get Format Protection", "description"=>"Get FormatProtection Retrieve the properties and relationships of formatprotection object.", "operationId"=>"GetFormatProtection", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeformatprotection-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Format", "Protection"]}, "patch"=>{"summary"=>"Update Formatprotection", "description"=>"Update formatprotection Update the properties of formatprotection object.", "operationId"=>"UpdateFormatprotection", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeformatprotection-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Formatprotection"]}}, "/groups/{id}/addFavorite"=>{"post"=>{"summary"=>"Group Add Favorite", "description"=>"group: addFavorite Add the group to the list of the current user's favorite groups. Supported for only Office 365 groups.", "operationId"=>"Group:AddFavorite", "x-api-path-slug"=>"groupsidaddfavorite-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "", "Favorite"]}}, "/groups/{id}"=>{"delete"=>{"summary"=>"Delete Group", "description"=>"Delete group Delete group.", "operationId"=>"DeleteGroup", "x-api-path-slug"=>"groupsid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}, "get"=>{"summary"=>"Get Group", "description"=>"Get group Get the properties and relationships of a group object.", "operationId"=>"GetGroup", "x-api-path-slug"=>"groupsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}, "patch"=>{"summary"=>"Update Group", "description"=>"Update group Update the properties of a group object.", "operationId"=>"UpdateGroup", "x-api-path-slug"=>"groupsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}}, "/groups/{id}/acceptedSenders/$ref"=>{"delete"=>{"summary"=>"Remove Accepted Sender", "description"=>"Remove acceptedSender Remove a user or group from the acceptedSenders list.", "operationId"=>"RemoveAcceptedSender", "x-api-path-slug"=>"groupsidacceptedsendersref-delete", "parameters"=>[{"in"=>"query", "name"=>"$id", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"query", "name"=>"gt;", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"query", "name"=>"lt;id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Accepted", "Sender"]}, "post"=>{"summary"=>"Create Accepted Sender", "description"=>"Create acceptedSender Add a new user or group to the acceptedSender list.", "operationId"=>"CreateAcceptedSender", "x-api-path-slug"=>"groupsidacceptedsendersref-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accepted", "Sender"]}}, "/groups/{id}/members/{id}/$ref"=>{"delete"=>{"summary"=>"Remove Member", "description"=>"Remove member Use this API to remove a member from an Office 365 group, a security group or a mail-enabled security group through the members navigation property. You can remove users or other groups.", "operationId"=>"RemoveMember", "x-api-path-slug"=>"groupsidmembersidref-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Member"]}}, "/groups/{id}/owners/{id}/$ref"=>{"delete"=>{"summary"=>"Remove Owner", "description"=>"Remove owner Use this API to remove an owner from an Office 365 group, a security group or a mail-enabled security group through the owners navigation property.", "operationId"=>"RemoveOwner", "x-api-path-slug"=>"groupsidownersidref-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Owner"]}}, "/groups/{id}/rejectedSenders/$ref"=>{"delete"=>{"summary"=>"Remove Rejected Sender", "description"=>"Remove rejectedSender Remove a user or group from the rejectedSenders list.", "operationId"=>"RemoveRejectedSender", "x-api-path-slug"=>"groupsidrejectedsendersref-delete", "parameters"=>[{"in"=>"query", "name"=>"$id", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"query", "name"=>"gt;", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"query", "name"=>"lt;id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remove", "Rejected", "Sender"]}, "post"=>{"summary"=>"Create Rejected Sender", "description"=>"Create rejectedSender Add a new user or group to the rejectedSender list.", "operationId"=>"CreateRejectedSender", "x-api-path-slug"=>"groupsidrejectedsendersref-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rejected", "Sender"]}}, "/groups/{id}/getMemberObjects"=>{"post"=>{"summary"=>"Group Get Member Objects", "description"=>"group: getMemberObjects Return all of the groups that this group is a member of. The check is transitive. Note: Groups cannot be members of directory roles, so no directory roles will be returned.", "operationId"=>"Group:GetMemberObjects", "x-api-path-slug"=>"groupsidgetmemberobjects-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "", "Member", "Objects"]}}, "/groups"=>{"get"=>{"summary"=>"List Groups", "description"=>"List groups List all the groups available in an organization, including but not limited to Office 365 Groups. The default properties of each group are returned.", "operationId"=>"ListGroups", "x-api-path-slug"=>"groups-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Groups"]}, "post"=>{"summary"=>"Create Group", "description"=>"Create group Use this API to create a new group as specified in the request body. You can create one of 3 types of groups:", "operationId"=>"CreateGroup", "x-api-path-slug"=>"groups-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}}, "/groups/{id}/acceptedSenders"=>{"get"=>{"summary"=>"List Accepted Senders", "description"=>"List acceptedSenders Get a list of users or groups that are in the acceptedSenders list for this group.", "operationId"=>"ListAcceptedSenders", "x-api-path-slug"=>"groupsidacceptedsenders-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Accepted", "Senders"]}}, "/groups/{id}/calendarView"=>{"get"=>{"summary"=>"List Calendar View", "description"=>"List calendarView Get the occurrences, exceptions, and single instances of events in a calendar view defined by a time range, from the default calendar of a group.", "operationId"=>"ListCalendarView", "x-api-path-slug"=>"groupsidcalendarview-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "description"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendar", "View"]}}, "/groups/{id}/conversations"=>{"get"=>{"summary"=>"List Conversations", "description"=>"List conversations Retrieve the list of conversations in this group.", "operationId"=>"ListConversations", "x-api-path-slug"=>"groupsidconversations-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Conversations"]}, "post"=>{"summary"=>"Create Conversation", "description"=>"Create Conversation Create a new conversation by including a thread and a post.", "operationId"=>"CreateConversation", "x-api-path-slug"=>"groupsidconversations-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversation"]}}, "/groups/{id}/events"=>{"get"=>{"summary"=>"List Events", "description"=>"List events Retrieve a list of event objects.", "operationId"=>"ListEvents", "x-api-path-slug"=>"groupsidevents-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Events"]}, "post"=>{"summary"=>"Create Event", "description"=>"Create Event Use this API to create a new event.", "operationId"=>"CreateEvent", "x-api-path-slug"=>"groupsidevents-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/groups/{id}/memberOf"=>{"get"=>{"summary"=>"List Member Of", "description"=>"List memberOf Get groups that the group is a direct member of.", "operationId"=>"ListMemberOf", "x-api-path-slug"=>"groupsidmemberof-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Member", "Of"]}}, "/groups/{id}/members"=>{"get"=>{"summary"=>"List Members", "description"=>"List members Get a list of the group's direct members. A group can have users, contacts, and other groups as members. This operation is not transitive.", "operationId"=>"ListMembers", "x-api-path-slug"=>"groupsidmembers-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Members"]}}, "/groups/{id}/owners"=>{"get"=>{"summary"=>"List Owners", "description"=>"List owners Retrieve a list of the group's owners. The owners are a set of non-admin users who are allowed to modify the group object.", "operationId"=>"ListOwners", "x-api-path-slug"=>"groupsidowners-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Owners"]}}, "/groups/{id}/rejectedSenders"=>{"get"=>{"summary"=>"List Rejected Senders", "description"=>"List rejectedSenders Get a list of users or groups that are in the rejectedSenders list for this group.", "operationId"=>"ListRejectedSenders", "x-api-path-slug"=>"groupsidrejectedsenders-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Rejected", "Senders"]}}, "/groups/{id}/threads"=>{"get"=>{"summary"=>"List Threads", "description"=>"List threads Get all the threads of a group.", "operationId"=>"ListThreads", "x-api-path-slug"=>"groupsidthreads-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Threads"]}, "post"=>{"summary"=>"Create Thread", "description"=>"Create thread Start a new conversation by first creating a thread.", "operationId"=>"CreateThread", "x-api-path-slug"=>"groupsidthreads-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thread"]}}, "/groups/{id}/members/$ref"=>{"post"=>{"summary"=>"Add Member", "description"=>"Add member Use this API to add a member to an Office 365 group, a security group or a mail-enabled security group through the members navigation property. You can add users or other groups. Important: You can add only users to Office 365 groups.", "operationId"=>"AddMember", "x-api-path-slug"=>"groupsidmembersref-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Member"]}}, "/groups/{id}/owners/$ref"=>{"post"=>{"summary"=>"Add Group Owner", "description"=>"Add group owner Add a user to the group's owners. The owners are a set of non-admin users who are allowed to modify the group object.", "operationId"=>"AddGroupOwner", "x-api-path-slug"=>"groupsidownersref-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Owner"]}}, "/groups/{id}/removeFavorite"=>{"post"=>{"summary"=>"Group Remove Favorite", "description"=>"group: removeFavorite Remove the group from the list of the current user's favorite groups. Supported for only Office 365 groups.", "operationId"=>"Group:RemoveFavorite", "x-api-path-slug"=>"groupsidremovefavorite-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Remove", "Favorite"]}}, "/groups/{id}/resetUnseenCount"=>{"post"=>{"summary"=>"Group Reset Unseen Count", "description"=>"group: resetUnseenCount Reset the unseenCount of all the posts that the current user has not seen since their last visit. Supported for only Office 365 groups.", "operationId"=>"Group:ResetUnseenCount", "x-api-path-slug"=>"groupsidresetunseencount-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "Reset", "Unseen", "Count"]}}, "/groups/{id}/subscribeByMail"=>{"post"=>{"summary"=>"Group Subscribe By Mail", "description"=>"group: subscribeByMail Calling this method will enable the current user to receive email notifications for this group, about new posts, events, and files in that group. Supported for only Office 365 groups.", "operationId"=>"Group:SubscribeByMail", "x-api-path-slug"=>"groupsidsubscribebymail-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "SubscribeMail"]}}, "/groups/{id}/unsubscribeByMail"=>{"post"=>{"summary"=>"Group Unsubscribe By Mail", "description"=>"group: unsubscribeByMail Calling this method will prevent the current user from receiving email notifications for this group about new posts, events, and files in that group. Supported for only Office 365 groups.", "operationId"=>"Group:UnsubscribeByMail", "x-api-path-slug"=>"groupsidunsubscribebymail-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "UnsubscribeMail"]}}, "/workbook/tables(<id|name>)/sort/fields/icon"=>{"get"=>{"summary"=>"Get Icon", "description"=>"Get Icon Retrieve the properties and relationships of icon object.", "operationId"=>"GetIcon", "x-api-path-slug"=>"workbooktablesltidnamegtsortfieldsicon-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Icon"]}, "patch"=>{"summary"=>"Update Icon", "description"=>"Update icon Update the properties of icon object.", "operationId"=>"UpdateIcon", "x-api-path-slug"=>"workbooktablesltidnamegtsortfieldsicon-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Icon"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/sort/fields/icon"=>{"get"=>{"summary"=>"Get Icon", "description"=>"Get Icon Retrieve the properties and relationships of icon object.", "operationId"=>"GetIcon", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtsortfieldsicon-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Icon"]}, "patch"=>{"summary"=>"Update Icon", "description"=>"Update icon Update the properties of icon object.", "operationId"=>"UpdateIcon", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtsortfieldsicon-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Icon"]}}, "/me/inferenceClassification/overrides"=>{"get"=>{"summary"=>"List Overrides", "description"=>"List overrides Get the overrides that a user has set up to always classify messages from certain senders in specific ways.", "operationId"=>"ListOverrides", "x-api-path-slug"=>"meinferenceclassificationoverrides-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Overrides"]}, "post"=>{"summary"=>"Create Inference Classification Override", "description"=>"Create inferenceClassificationOverride Create an override for a sender identified by an SMTP address. Future messages from that SMTP address will be consistently classified as specified in the override.", "operationId"=>"CreateInferenceClassificationOverride", "x-api-path-slug"=>"meinferenceclassificationoverrides-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Inference", "Classification", "Override"]}}, "/users/{id}/inferenceClassification/overrides"=>{"get"=>{"summary"=>"List Overrides", "description"=>"List overrides Get the overrides that a user has set up to always classify messages from certain senders in specific ways.", "operationId"=>"ListOverrides", "x-api-path-slug"=>"usersidinferenceclassificationoverrides-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Overrides"]}, "post"=>{"summary"=>"Create Inference Classification Override", "description"=>"Create inferenceClassificationOverride Create an override for a sender identified by an SMTP address. Future messages from that SMTP address will be consistently classified as specified in the override.", "operationId"=>"CreateInferenceClassificationOverride", "x-api-path-slug"=>"usersidinferenceclassificationoverrides-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Inference", "Classification", "Override"]}}, "/me/inferenceClassification/overrides/{id}"=>{"delete"=>{"summary"=>"Delete Inference Classification Override", "description"=>"Delete inferenceClassificationOverride Delete an override specified by its ID.", "operationId"=>"DeleteInferenceClassificationOverride", "x-api-path-slug"=>"meinferenceclassificationoverridesid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Inference", "Classification", "Override"]}, "patch"=>{"summary"=>"Update Inferenceclassificationoverride", "description"=>"Update inferenceclassificationoverride Change the classifyAs field of an override as specified.", "operationId"=>"UpdateInferenceclassificationoverride", "x-api-path-slug"=>"meinferenceclassificationoverridesid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Inferenceclassificationoverride"]}}, "/users/{id}/inferenceClassification/overrides/{id}"=>{"delete"=>{"summary"=>"Delete Inference Classification Override", "description"=>"Delete inferenceClassificationOverride Delete an override specified by its ID.", "operationId"=>"DeleteInferenceClassificationOverride", "x-api-path-slug"=>"usersidinferenceclassificationoverridesid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Inference", "Classification", "Override"]}, "patch"=>{"summary"=>"Update Inferenceclassificationoverride", "description"=>"Update inferenceclassificationoverride Change the classifyAs field of an override as specified.", "operationId"=>"UpdateInferenceclassificationoverride", "x-api-path-slug"=>"usersidinferenceclassificationoverridesid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Inferenceclassificationoverride"]}}, "/me/drive/items/{item-id}/createLink"=>{"post"=>{"summary"=>"Create A Sharing Link For A Drive Item", "description"=>"Create a sharing link for a DriveItem You can use createLink action to share a DriveItem via a sharing link.", "operationId"=>"CreateASharingLinkForADriveItem", "x-api-path-slug"=>"medriveitemsitemidcreatelink-post", "parameters"=>[{"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreateSharing", "LinkA", "Drive", "Item"]}}, "/me/drive/root:/{item-path}:/createLink"=>{"post"=>{"summary"=>"Create A Sharing Link For A Drive Item", "description"=>"Create a sharing link for a DriveItem You can use createLink action to share a DriveItem via a sharing link.", "operationId"=>"CreateASharingLinkForADriveItem", "x-api-path-slug"=>"medriverootitempathcreatelink-post", "parameters"=>[{"in"=>"path", "name"=>"item-path", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreateSharing", "LinkA", "Drive", "Item"]}}, "/groups/{group-id}/drive/items/{item-id}/createLink"=>{"post"=>{"summary"=>"Create A Sharing Link For A Drive Item", "description"=>"Create a sharing link for a DriveItem You can use createLink action to share a DriveItem via a sharing link.", "operationId"=>"CreateASharingLinkForADriveItem", "x-api-path-slug"=>"groupsgroupiddriveitemsitemidcreatelink-post", "parameters"=>[{"in"=>"path", "name"=>"group-id", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreateSharing", "LinkA", "Drive", "Item"]}}, "/drives/{drive-id}/items/{item-id}/createLink"=>{"post"=>{"summary"=>"Create A Sharing Link For A Drive Item", "description"=>"Create a sharing link for a DriveItem You can use createLink action to share a DriveItem via a sharing link.", "operationId"=>"CreateASharingLinkForADriveItem", "x-api-path-slug"=>"drivesdriveiditemsitemidcreatelink-post", "parameters"=>[{"in"=>"path", "name"=>"drive-id", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreateSharing", "LinkA", "Drive", "Item"]}}, "/me/drive/root/delta"=>{"get"=>{"summary"=>"Track Changes For A Drive", "description"=>"Track changes for a Drive This method allows your app to track changes to a drive and its children over time.", "operationId"=>"TrackChangesForADrive", "x-api-path-slug"=>"medriverootdelta-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Track", "Changes", "Drive"]}}, "/drives/{drive-id}/root/delta"=>{"get"=>{"summary"=>"Track Changes For A Drive", "description"=>"Track changes for a Drive This method allows your app to track changes to a drive and its children over time.", "operationId"=>"TrackChangesForADrive", "x-api-path-slug"=>"drivesdriveidrootdelta-get", "parameters"=>[{"in"=>"path", "name"=>"drive-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Track", "Changes", "Drive"]}}, "/groups/{group-id}/drive/root/delta"=>{"get"=>{"summary"=>"Track Changes For A Drive", "description"=>"Track changes for a Drive This method allows your app to track changes to a drive and its children over time.", "operationId"=>"TrackChangesForADrive", "x-api-path-slug"=>"groupsgroupiddriverootdelta-get", "parameters"=>[{"in"=>"path", "name"=>"group-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Track", "Changes", "Drive"]}}, "/me/drive/root:/{item-path}:/content"=>{"get"=>{"summary"=>"Download The Contents Of A Drive Item", "description"=>"Download the contents of a DriveItem Download the contents for a driveItem. Only driveItem with the file property can be downloaded.", "operationId"=>"DownloadTheContentsOfADriveItem", "x-api-path-slug"=>"medriverootitempathcontent-get", "parameters"=>[{"in"=>"header", "name"=>"if-none-match", "description"=>"If this request header is included and the eTag (or cTag) provided matches the current tag on the file, an HTTP 304 Not Modified response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-path", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DownloadContents", "OfDrive", "Item"]}}, "/me/drive/items/{item-id}/content"=>{"get"=>{"summary"=>"Download The Contents Of A Drive Item", "description"=>"Download the contents of a DriveItem Download the contents for a driveItem. Only driveItem with the file property can be downloaded.", "operationId"=>"DownloadTheContentsOfADriveItem", "x-api-path-slug"=>"medriveitemsitemidcontent-get", "parameters"=>[{"in"=>"header", "name"=>"if-none-match", "description"=>"If this request header is included and the eTag (or cTag) provided matches the current tag on the file, an HTTP 304 Not Modified response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DownloadContents", "OfDrive", "Item"]}}, "/drives/items/{item-id}/content"=>{"get"=>{"summary"=>"Download The Contents Of A Drive Item", "description"=>"Download the contents of a DriveItem Download the contents for a driveItem. Only driveItem with the file property can be downloaded.", "operationId"=>"DownloadTheContentsOfADriveItem", "x-api-path-slug"=>"drivesitemsitemidcontent-get", "parameters"=>[{"in"=>"header", "name"=>"if-none-match", "description"=>"If this request header is included and the eTag (or cTag) provided matches the current tag on the file, an HTTP 304 Not Modified response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DownloadContents", "OfDrive", "Item"]}}, "/groups/{group-id}/drive/items/{item-id}/content"=>{"get"=>{"summary"=>"Download The Contents Of A Drive Item", "description"=>"Download the contents of a DriveItem Download the contents for a driveItem. Only driveItem with the file property can be downloaded.", "operationId"=>"DownloadTheContentsOfADriveItem", "x-api-path-slug"=>"groupsgroupiddriveitemsitemidcontent-get", "parameters"=>[{"in"=>"path", "name"=>"group-id", "type"=>"string"}, {"in"=>"header", "name"=>"if-none-match", "description"=>"If this request header is included and the eTag (or cTag) provided matches the current tag on the file, an HTTP 304 Not Modified response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DownloadContents", "OfDrive", "Item"]}}, "/me/drive/items/{item-id}"=>{"get"=>{"summary"=>"Get A Drive Item Resource", "description"=>"Get a DriveItem resource Retrieve the metadata for a DriveItem in a Drive by file system path or ID.", "operationId"=>"GetADriveItemResource", "x-api-path-slug"=>"medriveitemsitemid-get", "parameters"=>[{"in"=>"header", "name"=>"if-none-match", "description"=>"If this request header is included and the eTag (or cTag) provided matches the current tag on the file, an HTTP 304 Not Modified response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Drive", "Item", "Resource"]}, "patch"=>{"summary"=>"Update Drive Item Properties", "description"=>"Update DriveItem properties Update the metadata for a DriveItem by ID or path.", "operationId"=>"UpdateDriveItemProperties", "x-api-path-slug"=>"medriveitemsitemid-patch", "parameters"=>[{"in"=>"header", "name"=>"if-match", "description"=>"If this request header is included and the eTag (or cTag) provided does not match the current eTag on the folder, a 412 Precondition Failed response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Drive", "Item", "Properties"]}}, "/me/drive/root:/{item-path}"=>{"get"=>{"summary"=>"Get A Drive Item Resource", "description"=>"Get a DriveItem resource Retrieve the metadata for a DriveItem in a Drive by file system path or ID.", "operationId"=>"GetADriveItemResource", "x-api-path-slug"=>"medriverootitempath-get", "parameters"=>[{"in"=>"header", "name"=>"if-none-match", "description"=>"If this request header is included and the eTag (or cTag) provided matches the current tag on the file, an HTTP 304 Not Modified response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-path", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Drive", "Item", "Resource"]}, "patch"=>{"summary"=>"Update Drive Item Properties", "description"=>"Update DriveItem properties Update the metadata for a DriveItem by ID or path.", "operationId"=>"UpdateDriveItemProperties", "x-api-path-slug"=>"medriverootitempath-patch", "parameters"=>[{"in"=>"header", "name"=>"if-match", "description"=>"If this request header is included and the eTag (or cTag) provided does not match the current eTag on the folder, a 412 Precondition Failed response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-path", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Drive", "Item", "Properties"]}}, "/drives/{drive-id}/items/{item-id}"=>{"get"=>{"summary"=>"Get A Drive Item Resource", "description"=>"Get a DriveItem resource Retrieve the metadata for a DriveItem in a Drive by file system path or ID.", "operationId"=>"GetADriveItemResource", "x-api-path-slug"=>"drivesdriveiditemsitemid-get", "parameters"=>[{"in"=>"path", "name"=>"drive-id", "type"=>"string"}, {"in"=>"header", "name"=>"if-none-match", "description"=>"If this request header is included and the eTag (or cTag) provided matches the current tag on the file, an HTTP 304 Not Modified response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Drive", "Item", "Resource"]}, "patch"=>{"summary"=>"Update Drive Item Properties", "description"=>"Update DriveItem properties Update the metadata for a DriveItem by ID or path.", "operationId"=>"UpdateDriveItemProperties", "x-api-path-slug"=>"drivesdriveiditemsitemid-patch", "parameters"=>[{"in"=>"path", "name"=>"drive-id", "type"=>"string"}, {"in"=>"header", "name"=>"if-match", "description"=>"If this request header is included and the eTag (or cTag) provided does not match the current eTag on the folder, a 412 Precondition Failed response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Drive", "Item", "Properties"]}}, "/groups/{group-id}/drive/items/{item-id}"=>{"get"=>{"summary"=>"List Children Of A Drive Item", "description"=>"List children of a driveItem Return a collection of DriveItems in the children relationship of a DriveItem.", "operationId"=>"ListChildrenOfADriveItem", "x-api-path-slug"=>"groupsgroupiddriveitemsitemid-get", "parameters"=>[{"in"=>"path", "name"=>"group-id", "type"=>"string"}, {"in"=>"header", "name"=>"if-none-match", "description"=>"If this request header is included and the eTag (or cTag) provided matches the current tag on the file, an HTTP 304 Not Modified response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Children", "OfDrive", "Item"]}, "patch"=>{"summary"=>"Update Drive Item Properties", "description"=>"Update DriveItem properties Update the metadata for a DriveItem by ID or path.", "operationId"=>"UpdateDriveItemProperties", "x-api-path-slug"=>"groupsgroupiddriveitemsitemid-patch", "parameters"=>[{"in"=>"path", "name"=>"group-id", "type"=>"string"}, {"in"=>"header", "name"=>"if-match", "description"=>"If this request header is included and the eTag (or cTag) provided does not match the current eTag on the folder, a 412 Precondition Failed response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Drive", "Item", "Properties"]}}, "/me/drive/items/{item-id}/invite"=>{"post"=>{"summary"=>"Send A Sharing Invitation", "description"=>"Send a sharing invitation Sends a sharing invitation for a DriveItem. A sharing invitation provides permissions to the recipients and optionally sends an email to the recipients to notify them the item was shared.", "operationId"=>"SendASharingInvitation", "x-api-path-slug"=>"medriveitemsitemidinvite-post", "parameters"=>[{"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SendSharing", "Invitation"]}}, "/drive/items/{item-id}/invite"=>{"post"=>{"summary"=>"Send A Sharing Invitation", "description"=>"Send a sharing invitation Sends a sharing invitation for a DriveItem. A sharing invitation provides permissions to the recipients and optionally sends an email to the recipients to notify them the item was shared.", "operationId"=>"SendASharingInvitation", "x-api-path-slug"=>"driveitemsitemidinvite-post", "parameters"=>[{"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SendSharing", "Invitation"]}}, "/drives/{drive-id}/items/{item-id}/invite"=>{"post"=>{"summary"=>"Send A Sharing Invitation", "description"=>"Send a sharing invitation Sends a sharing invitation for a DriveItem. A sharing invitation provides permissions to the recipients and optionally sends an email to the recipients to notify them the item was shared.", "operationId"=>"SendASharingInvitation", "x-api-path-slug"=>"drivesdriveiditemsitemidinvite-post", "parameters"=>[{"in"=>"path", "name"=>"drive-id", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SendSharing", "Invitation"]}}, "/groups/{group-id}/drive/items/{item-id}/invite"=>{"post"=>{"summary"=>"Send A Sharing Invitation", "description"=>"Send a sharing invitation Sends a sharing invitation for a DriveItem. A sharing invitation provides permissions to the recipients and optionally sends an email to the recipients to notify them the item was shared.", "operationId"=>"SendASharingInvitation", "x-api-path-slug"=>"groupsgroupiddriveitemsitemidinvite-post", "parameters"=>[{"in"=>"path", "name"=>"group-id", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SendSharing", "Invitation"]}}, "/me/drive/root/children"=>{"get"=>{"summary"=>"List Children Of A Drive Item", "description"=>"List children of a driveItem Return a collection of DriveItems in the children relationship of a DriveItem.", "operationId"=>"ListChildrenOfADriveItem", "x-api-path-slug"=>"medriverootchildren-get", "parameters"=>[{"in"=>"header", "name"=>"if-none-match", "description"=>"If this request header is included and the eTag (or cTag) provided matches the current tag on the file, an HTTP 304 Not Modified response is returned", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Children", "OfDrive", "Item"]}, "post"=>{"summary"=>"Create A New Folder", "description"=>"Create a new folder Create a new folder or DriveItem in a Drive with a specified parent item or path.", "operationId"=>"CreateANewFolder", "x-api-path-slug"=>"medriverootchildren-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreateNew", "Folder"]}}, "/me/drive/items/{item-id}/children"=>{"get"=>{"summary"=>"List Children Of A Drive Item", "description"=>"List children of a driveItem Return a collection of DriveItems in the children relationship of a DriveItem.", "operationId"=>"ListChildrenOfADriveItem", "x-api-path-slug"=>"medriveitemsitemidchildren-get", "parameters"=>[{"in"=>"header", "name"=>"if-none-match", "description"=>"If this request header is included and the eTag (or cTag) provided matches the current tag on the file, an HTTP 304 Not Modified response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Children", "OfDrive", "Item"]}}, "/me/drive/root:/{item-path}:/children"=>{"get"=>{"summary"=>"List Children Of A Drive Item", "description"=>"List children of a driveItem Return a collection of DriveItems in the children relationship of a DriveItem.", "operationId"=>"ListChildrenOfADriveItem", "x-api-path-slug"=>"medriverootitempathchildren-get", "parameters"=>[{"in"=>"header", "name"=>"if-none-match", "description"=>"If this request header is included and the eTag (or cTag) provided matches the current tag on the file, an HTTP 304 Not Modified response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-path", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Children", "OfDrive", "Item"]}}, "/drives/{drive-id}/items/{item-id}/children"=>{"get"=>{"summary"=>"List Children Of A Drive Item", "description"=>"List children of a driveItem Return a collection of DriveItems in the children relationship of a DriveItem.", "operationId"=>"ListChildrenOfADriveItem", "x-api-path-slug"=>"drivesdriveiditemsitemidchildren-get", "parameters"=>[{"in"=>"path", "name"=>"drive-id", "type"=>"string"}, {"in"=>"header", "name"=>"if-none-match", "description"=>"If this request header is included and the eTag (or cTag) provided matches the current tag on the file, an HTTP 304 Not Modified response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Children", "OfDrive", "Item"]}}, "/me/drive/items/{item-id}/permissions"=>{"get"=>{"summary"=>"List Permissions On A Drive Item", "description"=>"List permissions on a DriveItem List the effective permissions of on a DriveItem.", "operationId"=>"ListPermissionsOnADriveItem", "x-api-path-slug"=>"medriveitemsitemidpermissions-get", "parameters"=>[{"in"=>"header", "name"=>"if-none-match", "description"=>"If this request header is included and the etag provided matches the current etag on the item, an HTTP 304 Not Modified response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Permissions", "OnDrive", "Item"]}}, "/me/drive/root:/{path}:/permissions"=>{"get"=>{"summary"=>"List Permissions On A Drive Item", "description"=>"List permissions on a DriveItem List the effective permissions of on a DriveItem.", "operationId"=>"ListPermissionsOnADriveItem", "x-api-path-slug"=>"medriverootpathpermissions-get", "parameters"=>[{"in"=>"header", "name"=>"if-none-match", "description"=>"If this request header is included and the etag provided matches the current etag on the item, an HTTP 304 Not Modified response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"path", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Permissions", "OnDrive", "Item"]}}, "/drives/{drive-id}/items/{item-id}/permissions"=>{"get"=>{"summary"=>"List Permissions On A Drive Item", "description"=>"List permissions on a DriveItem List the effective permissions of on a DriveItem.", "operationId"=>"ListPermissionsOnADriveItem", "x-api-path-slug"=>"drivesdriveiditemsitemidpermissions-get", "parameters"=>[{"in"=>"path", "name"=>"drive-id", "type"=>"string"}, {"in"=>"header", "name"=>"if-none-match", "description"=>"If this request header is included and the etag provided matches the current etag on the item, an HTTP 304 Not Modified response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Permissions", "OnDrive", "Item"]}}, "/groups/{group-id}/drive/items/{item-id}/permissions"=>{"get"=>{"summary"=>"List Permissions On A Drive Item", "description"=>"List permissions on a DriveItem List the effective permissions of on a DriveItem.", "operationId"=>"ListPermissionsOnADriveItem", "x-api-path-slug"=>"groupsgroupiddriveitemsitemidpermissions-get", "parameters"=>[{"in"=>"path", "name"=>"group-id", "type"=>"string"}, {"in"=>"header", "name"=>"if-none-match", "description"=>"If this request header is included and the etag provided matches the current etag on the item, an HTTP 304 Not Modified response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Permissions", "OnDrive", "Item"]}}, "/me/drive/root:/{item-path}:/thumbnails"=>{"get"=>{"summary"=>"List Thumbnails For A Drive Item", "description"=>"List thumbnails for a DriveItem Retrieve a collection of ThumbnailSet resources for a DriveItem resource.", "operationId"=>"ListThumbnailsForADriveItem", "x-api-path-slug"=>"medriverootitempaththumbnails-get", "parameters"=>[{"in"=>"path", "name"=>"item-path", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "ThumbnailsA", "Drive", "Item"]}}, "/me/drive/items/{item-id}/thumbnails"=>{"get"=>{"summary"=>"List Thumbnails For A Drive Item", "description"=>"List thumbnails for a DriveItem Retrieve a collection of ThumbnailSet resources for a DriveItem resource.", "operationId"=>"ListThumbnailsForADriveItem", "x-api-path-slug"=>"medriveitemsitemidthumbnails-get", "parameters"=>[{"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "ThumbnailsA", "Drive", "Item"]}}, "/groups/{group-id}/drive/items/{item-id}/thumbnails"=>{"get"=>{"summary"=>"List Thumbnails For A Drive Item", "description"=>"List thumbnails for a DriveItem Retrieve a collection of ThumbnailSet resources for a DriveItem resource.", "operationId"=>"ListThumbnailsForADriveItem", "x-api-path-slug"=>"groupsgroupiddriveitemsitemidthumbnails-get", "parameters"=>[{"in"=>"path", "name"=>"group-id", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "ThumbnailsA", "Drive", "Item"]}}, "/groups/{group-id}/drive/{item-id}"=>{"patch"=>{"summary"=>"Move A Drive Item", "description"=>"Move a DriveItem To move a DriveItem to a new parent item, your app requests to update the parentReference of the DriveItem to move. This is a special case of the Update method. Your app can combine moving an item to a new container and updating other properties of the item into a single request.", "operationId"=>"MoveADriveItem", "x-api-path-slug"=>"groupsgroupiddriveitemid-patch", "parameters"=>[{"in"=>"path", "name"=>"group-id", "type"=>"string"}, {"in"=>"header", "name"=>"if-match", "description"=>"If this request header is included and the eTag (or cTag) provided does not match the current eTag on the folder, a 412 Precondition Failed response is returned", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MoveDrive", "Item"]}}, "/me/drive/items/{parent-item-id}/children"=>{"post"=>{"summary"=>"Create A New Folder", "description"=>"Create a new folder Create a new folder or DriveItem in a Drive with a specified parent item or path.", "operationId"=>"CreateANewFolder", "x-api-path-slug"=>"medriveitemsparentitemidchildren-post", "parameters"=>[{"in"=>"path", "name"=>"parent-item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreateNew", "Folder"]}}, "/drives/{drive-id}/items/{parent-item-id}/children"=>{"post"=>{"summary"=>"Create A New Folder", "description"=>"Create a new folder Create a new folder or DriveItem in a Drive with a specified parent item or path.", "operationId"=>"CreateANewFolder", "x-api-path-slug"=>"drivesdriveiditemsparentitemidchildren-post", "parameters"=>[{"in"=>"path", "name"=>"drive-id", "type"=>"string"}, {"in"=>"path", "name"=>"parent-item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreateNew", "Folder"]}}, "/groups/{group-id}/drive/items/{parent-item-id}/children"=>{"post"=>{"summary"=>"Create A New Folder", "description"=>"Create a new folder Create a new folder or DriveItem in a Drive with a specified parent item or path.", "operationId"=>"CreateANewFolder", "x-api-path-slug"=>"groupsgroupiddriveitemsparentitemidchildren-post", "parameters"=>[{"in"=>"path", "name"=>"group-id", "type"=>"string"}, {"in"=>"path", "name"=>"parent-item-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["CreateNew", "Folder"]}}, "/me/drive/items/{parent-id}:/{filename}:/content"=>{"put"=>{"summary"=>"Upload Or Replace The Contents Of A Drive Item", "description"=>"Upload or replace the contents of a driveItem The simple upload API allows you to provide the contents of a new file or update the contents of an existing file in a single API call. This method only supports files up to 4MB in size.", "operationId"=>"UploadOrReplaceTheContentsOfADriveItem", "x-api-path-slug"=>"medriveitemsparentidfilenamecontent-put", "parameters"=>[{"in"=>"path", "name"=>"filename", "type"=>"string"}, {"in"=>"path", "name"=>"parent-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Or", "ReplaceContents", "OfDrive", "Item"]}}, "/me/drive/root:/{parent-path}/{filename}:/content"=>{"put"=>{"summary"=>"Upload Or Replace The Contents Of A Drive Item", "description"=>"Upload or replace the contents of a driveItem The simple upload API allows you to provide the contents of a new file or update the contents of an existing file in a single API call. This method only supports files up to 4MB in size.", "operationId"=>"UploadOrReplaceTheContentsOfADriveItem", "x-api-path-slug"=>"medriverootparentpathfilenamecontent-put", "parameters"=>[{"in"=>"path", "name"=>"filename", "type"=>"string"}, {"in"=>"path", "name"=>"parent-path", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Or", "ReplaceContents", "OfDrive", "Item"]}}, "/me/drive/items/{parent-id}/children/{filename}/content"=>{"put"=>{"summary"=>"Upload Or Replace The Contents Of A Drive Item", "description"=>"Upload or replace the contents of a driveItem The simple upload API allows you to provide the contents of a new file or update the contents of an existing file in a single API call. This method only supports files up to 4MB in size.", "operationId"=>"UploadOrReplaceTheContentsOfADriveItem", "x-api-path-slug"=>"medriveitemsparentidchildrenfilenamecontent-put", "parameters"=>[{"in"=>"path", "name"=>"filename", "type"=>"string"}, {"in"=>"path", "name"=>"parent-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Or", "ReplaceContents", "OfDrive", "Item"]}}, "/groups/{id}/drive/items/{parent-id}/children/{filename}/content"=>{"put"=>{"summary"=>"Upload Or Replace The Contents Of A Drive Item", "description"=>"Upload or replace the contents of a driveItem The simple upload API allows you to provide the contents of a new file or update the contents of an existing file in a single API call. This method only supports files up to 4MB in size.", "operationId"=>"UploadOrReplaceTheContentsOfADriveItem", "x-api-path-slug"=>"groupsiddriveitemsparentidchildrenfilenamecontent-put", "parameters"=>[{"in"=>"path", "name"=>"filename", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"parent-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Or", "ReplaceContents", "OfDrive", "Item"]}}, "/me/mailFolders/{id}/copy"=>{"post"=>{"summary"=>"Mail Folder Copy", "description"=>"mailFolder: copy Copy a mailfolder and its contents to another mailfolder.", "operationId"=>"MailFolder:Copy", "x-api-path-slug"=>"memailfoldersidcopy-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mail", "Folder", "Copy"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}/copy"=>{"post"=>{"summary"=>"Mail Folder Copy", "description"=>"mailFolder: copy Copy a mailfolder and its contents to another mailfolder.", "operationId"=>"MailFolder:Copy", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidcopy-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mail", "Folder", "Copy"]}}, "/me/mailFolders/{id}"=>{"delete"=>{"summary"=>"Delete Mail Folder", "description"=>"Delete mailFolder Delete mailFolder.", "operationId"=>"DeleteMailFolder", "x-api-path-slug"=>"memailfoldersid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mail", "Folder"]}, "get"=>{"summary"=>"Get Mail Folder", "description"=>"Get mailFolder Retrieve the properties and relationships of mailfolder object.", "operationId"=>"GetMailFolder", "x-api-path-slug"=>"memailfoldersid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mail", "Folder"]}, "patch"=>{"summary"=>"Update Mailfolder", "description"=>"Update mailfolder Update the properties of mailfolder object.", "operationId"=>"UpdateMailfolder", "x-api-path-slug"=>"memailfoldersid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mailfolder"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}"=>{"delete"=>{"summary"=>"Delete Mail Folder", "description"=>"Delete mailFolder Delete mailFolder.", "operationId"=>"DeleteMailFolder", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mail", "Folder"]}, "get"=>{"summary"=>"Get Mail Folder", "description"=>"Get mailFolder Retrieve the properties and relationships of mailfolder object.", "operationId"=>"GetMailFolder", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mail", "Folder"]}, "patch"=>{"summary"=>"Update Mailfolder", "description"=>"Update mailfolder Update the properties of mailfolder object.", "operationId"=>"UpdateMailfolder", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mailfolder"]}}, "/me/mailFolders/{id}/childFolders"=>{"get"=>{"summary"=>"List Child Folders", "description"=>"List childFolders Get the folder collection under the specified folder. You can use the .../me/MailFolders shortcut to get the top-level folder collection and navigate to another folder.", "operationId"=>"ListChildFolders", "x-api-path-slug"=>"memailfoldersidchildfolders-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Child", "Folders"]}, "post"=>{"summary"=>"Create Mail Folder", "description"=>"Create MailFolder Use this API to create a new child mailfolder.", "operationId"=>"CreateMailFolder", "x-api-path-slug"=>"memailfoldersidchildfolders-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mail", "Folder"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}/childFolders"=>{"get"=>{"summary"=>"List Child Folders", "description"=>"List childFolders Get the folder collection under the specified folder. You can use the .../me/MailFolders shortcut to get the top-level folder collection and navigate to another folder.", "operationId"=>"ListChildFolders", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidchildfolders-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Child", "Folders"]}, "post"=>{"summary"=>"Create Mail Folder", "description"=>"Create MailFolder Use this API to create a new child mailfolder.", "operationId"=>"CreateMailFolder", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidchildfolders-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mail", "Folder"]}}, "/me/mailFolders/{id}/messages"=>{"get"=>{"summary"=>"List Messages", "description"=>"List messages Get all the messages in the signed-in user's mailbox, or those messages in a specified folder in the mailbox.", "operationId"=>"ListMessages", "x-api-path-slug"=>"memailfoldersidmessages-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Messages"]}, "post"=>{"summary"=>"Create Message", "description"=>"Create Message Use this API to create a new Message in a mailfolder.", "operationId"=>"CreateMessage", "x-api-path-slug"=>"memailfoldersidmessages-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}/messages"=>{"get"=>{"summary"=>"List Messages", "description"=>"List messages Get all the messages in the signed-in user's mailbox, or those messages in a specified folder in the mailbox.", "operationId"=>"ListMessages", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmessages-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Messages"]}, "post"=>{"summary"=>"Create Message", "description"=>"Create Message Use this API to create a new Message in a mailfolder.", "operationId"=>"CreateMessage", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmessages-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message"]}}, "/me/mailFolders/{id}/move"=>{"post"=>{"summary"=>"Mail Folder Move", "description"=>"mailFolder: move Move a mailfolder and its contents to another mailfolder.", "operationId"=>"MailFolder:Move", "x-api-path-slug"=>"memailfoldersidmove-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mail", "Folder", "Move"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}/move"=>{"post"=>{"summary"=>"Mail Folder Move", "description"=>"mailFolder: move Move a mailfolder and its contents to another mailfolder.", "operationId"=>"MailFolder:Move", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmove-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mail", "Folder", "Move"]}}, "/me/messages/{id}/copy"=>{"post"=>{"summary"=>"Message Copy", "description"=>"message: copy Copy a message to a folder.", "operationId"=>"Message:Copy", "x-api-path-slug"=>"memessagesidcopy-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Copy"]}}, "/users/{id | userPrincipalName}/messages/{id}/copy"=>{"post"=>{"summary"=>"Message Copy", "description"=>"message: copy Copy a message to a folder.", "operationId"=>"Message:Copy", "x-api-path-slug"=>"usersid--userprincipalnamemessagesidcopy-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Copy"]}}, "/me/mailFolders/{id}/messages/{id}/copy"=>{"post"=>{"summary"=>"Message Copy", "description"=>"message: copy Copy a message to a folder.", "operationId"=>"Message:Copy", "x-api-path-slug"=>"memailfoldersidmessagesidcopy-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Copy"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}/copy"=>{"post"=>{"summary"=>"Message Copy", "description"=>"message: copy Copy a message to a folder.", "operationId"=>"Message:Copy", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmessagesidcopy-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Copy"]}}, "/me/messages/{id}/createForward"=>{"post"=>{"summary"=>"Message Create Forward", "description"=>"message: createForward Create a draft of the Forward message. You can then update or send the draft.", "operationId"=>"Message:CreateForward", "x-api-path-slug"=>"memessagesidcreateforward-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Forward"]}}, "/users/{id | userPrincipalName}/messages/{id}/createForward"=>{"post"=>{"summary"=>"Message Create Forward", "description"=>"message: createForward Create a draft of the Forward message. You can then update or send the draft.", "operationId"=>"Message:CreateForward", "x-api-path-slug"=>"usersid--userprincipalnamemessagesidcreateforward-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Forward"]}}, "/me/mailFolders/{id}/messages/{id}/createForward"=>{"post"=>{"summary"=>"Message Create Forward", "description"=>"message: createForward Create a draft of the Forward message. You can then update or send the draft.", "operationId"=>"Message:CreateForward", "x-api-path-slug"=>"memailfoldersidmessagesidcreateforward-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Forward"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}/createForward"=>{"post"=>{"summary"=>"Message Create Forward", "description"=>"message: createForward Create a draft of the Forward message. You can then update or send the draft.", "operationId"=>"Message:CreateForward", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmessagesidcreateforward-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Forward"]}}, "/me/messages/{id}/createReply"=>{"post"=>{"summary"=>"Message Create Reply", "description"=>"message: createReply Create a draft of the Reply message. You can then update or send the draft.", "operationId"=>"Message:CreateReply", "x-api-path-slug"=>"memessagesidcreatereply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Reply"]}}, "/users/{id | userPrincipalName}/messages/{id}/createReply"=>{"post"=>{"summary"=>"Message Create Reply", "description"=>"message: createReply Create a draft of the Reply message. You can then update or send the draft.", "operationId"=>"Message:CreateReply", "x-api-path-slug"=>"usersid--userprincipalnamemessagesidcreatereply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Reply"]}}, "/me/mailFolders/{id}/messages/{id}/createReply"=>{"post"=>{"summary"=>"Message Create Reply", "description"=>"message: createReply Create a draft of the Reply message. You can then update or send the draft.", "operationId"=>"Message:CreateReply", "x-api-path-slug"=>"memailfoldersidmessagesidcreatereply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Reply"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}/createReply"=>{"post"=>{"summary"=>"Message Create Reply", "description"=>"message: createReply Create a draft of the Reply message. You can then update or send the draft.", "operationId"=>"Message:CreateReply", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmessagesidcreatereply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Reply"]}}, "/me/messages/{id}/createReplyAll"=>{"post"=>{"summary"=>"Message Create Reply All", "description"=>"message: createReplyAll Create a draft of the Reply All message. You can then update or send the draft.", "operationId"=>"Message:CreateReplyAll", "x-api-path-slug"=>"memessagesidcreatereplyall-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Reply"]}}, "/users/{id | userPrincipalName}/messages/{id}/createReplyAll"=>{"post"=>{"summary"=>"Message Create Reply All", "description"=>"message: createReplyAll Create a draft of the Reply All message. You can then update or send the draft.", "operationId"=>"Message:CreateReplyAll", "x-api-path-slug"=>"usersid--userprincipalnamemessagesidcreatereplyall-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Reply"]}}, "/me/mailFolders/{id}/messages/{id}/createReplyAll"=>{"post"=>{"summary"=>"Message Create Reply All", "description"=>"message: createReplyAll Create a draft of the Reply All message. You can then update or send the draft.", "operationId"=>"Message:CreateReplyAll", "x-api-path-slug"=>"memailfoldersidmessagesidcreatereplyall-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Reply"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}/createReplyAll"=>{"post"=>{"summary"=>"Message Create Reply All", "description"=>"message: createReplyAll Create a draft of the Reply All message. You can then update or send the draft.", "operationId"=>"Message:CreateReplyAll", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmessagesidcreatereplyall-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Reply"]}}, "/me/messages/{id}/forward"=>{"post"=>{"summary"=>"Message Forward", "description"=>"message: forward Forward a message. The message is saved in the Sent Items folder.", "operationId"=>"Message:Forward", "x-api-path-slug"=>"memessagesidforward-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Forward"]}}, "/users/{id | userPrincipalName}/messages/{id}/forward"=>{"post"=>{"summary"=>"Message Forward", "description"=>"message: forward Forward a message. The message is saved in the Sent Items folder.", "operationId"=>"Message:Forward", "x-api-path-slug"=>"usersid--userprincipalnamemessagesidforward-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Forward"]}}, "/me/mailFolders/{id}/messages/{id}/forward"=>{"post"=>{"summary"=>"Message Forward", "description"=>"message: forward Forward a message. The message is saved in the Sent Items folder.", "operationId"=>"Message:Forward", "x-api-path-slug"=>"memailfoldersidmessagesidforward-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Forward"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}/forward"=>{"post"=>{"summary"=>"Message Forward", "description"=>"message: forward Forward a message. The message is saved in the Sent Items folder.", "operationId"=>"Message:Forward", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmessagesidforward-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Forward"]}}, "/me/mailFolders/{id}/messages/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to a message.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"memailfoldersidmessagesidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to a message.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"memailfoldersidmessagesidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to a message.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmessagesidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to a message.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmessagesidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/me/messages/{id}/move"=>{"post"=>{"summary"=>"Message Move", "description"=>"message: move Move a message to a folder. This creates a new copy of the message in the destination folder.", "operationId"=>"Message:Move", "x-api-path-slug"=>"memessagesidmove-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Move"]}}, "/users/{id | userPrincipalName}/messages/{id}/move"=>{"post"=>{"summary"=>"Message Move", "description"=>"message: move Move a message to a folder. This creates a new copy of the message in the destination folder.", "operationId"=>"Message:Move", "x-api-path-slug"=>"usersid--userprincipalnamemessagesidmove-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Move"]}}, "/me/mailFolders/{id}/messages/{id}/move"=>{"post"=>{"summary"=>"Message Move", "description"=>"message: move Move a message to a folder. This creates a new copy of the message in the destination folder.", "operationId"=>"Message:Move", "x-api-path-slug"=>"memailfoldersidmessagesidmove-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Move"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}/move"=>{"post"=>{"summary"=>"Message Move", "description"=>"message: move Move a message to a folder. This creates a new copy of the message in the destination folder.", "operationId"=>"Message:Move", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmessagesidmove-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Move"]}}, "/me/messages/{id}/reply"=>{"post"=>{"summary"=>"Message Reply", "description"=>"message: reply Reply to the sender of a message. The message is then saved in the Sent Items folder.", "operationId"=>"Message:Reply", "x-api-path-slug"=>"memessagesidreply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Reply"]}}, "/users/{id | userPrincipalName}/messages/{id}/reply"=>{"post"=>{"summary"=>"Message Reply", "description"=>"message: reply Reply to the sender of a message. The message is then saved in the Sent Items folder.", "operationId"=>"Message:Reply", "x-api-path-slug"=>"usersid--userprincipalnamemessagesidreply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Reply"]}}, "/me/mailFolders/{id}/messages/{id}/reply"=>{"post"=>{"summary"=>"Message Reply", "description"=>"message: reply Reply to the sender of a message. The message is then saved in the Sent Items folder.", "operationId"=>"Message:Reply", "x-api-path-slug"=>"memailfoldersidmessagesidreply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Reply"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}/reply"=>{"post"=>{"summary"=>"Message Reply", "description"=>"message: reply Reply to the sender of a message. The message is then saved in the Sent Items folder.", "operationId"=>"Message:Reply", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmessagesidreply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Reply"]}}, "/users/me/messages/{id}/replyAll"=>{"post"=>{"summary"=>"Message Reply All", "description"=>"message: replyAll Reply to all recipients of a message. The message is then saved in the Sent Items folder.", "operationId"=>"Message:ReplyAll", "x-api-path-slug"=>"usersmemessagesidreplyall-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Reply"]}}, "/users/{id | userPrincipalName}/messages/{id}/replyAll"=>{"post"=>{"summary"=>"Message Reply All", "description"=>"message: replyAll Reply to all recipients of a message. The message is then saved in the Sent Items folder.", "operationId"=>"Message:ReplyAll", "x-api-path-slug"=>"usersid--userprincipalnamemessagesidreplyall-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Reply"]}}, "/me/mailFolders/{id}/messages/{id}/replyAll"=>{"post"=>{"summary"=>"Message Reply All", "description"=>"message: replyAll Reply to all recipients of a message. The message is then saved in the Sent Items folder.", "operationId"=>"Message:ReplyAll", "x-api-path-slug"=>"memailfoldersidmessagesidreplyall-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Reply"]}}, "/users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}/replyAll"=>{"post"=>{"summary"=>"Message Reply All", "description"=>"message: replyAll Reply to all recipients of a message. The message is then saved in the Sent Items folder.", "operationId"=>"Message:ReplyAll", "x-api-path-slug"=>"usersid--userprincipalnamemailfoldersidmessagesidreplyall-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"Nature of the data in the body of an entity", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Reply"]}}, "/me/messages/{id}/send"=>{"post"=>{"summary"=>"Message Send", "description"=>"message: send Send a message in the draft folder. The draft message can be a new message draft, reply draft, reply-all draft, or a forward draft. The message is then saved in the Sent Items folder.", "operationId"=>"Message:Send", "x-api-path-slug"=>"memessagesidsend-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Send"]}}, "/users/{id | userPrincipalName}/messages/{id}/send"=>{"post"=>{"summary"=>"Message Send", "description"=>"message: send Send a message in the draft folder. The draft message can be a new message draft, reply draft, reply-all draft, or a forward draft. The message is then saved in the Sent Items folder.", "operationId"=>"Message:Send", "x-api-path-slug"=>"usersid--userprincipalnamemessagesidsend-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Send"]}}, "/users/{id|userPrincipalName}/messages/{id}"=>{"get"=>{"summary"=>"Get Multi Value Legacy Extended Property", "description"=>"Get multiValueLegacyExtendedProperty Get a resource instance that contains a multi-value extended property by using $expand.", "operationId"=>"GetMultiValueLegacyExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamemessagesid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Value", "Legacy", "Extended", "Property"]}, "patch"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamemessagesid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}}, "/users/{id|userPrincipalName}/mailFolders/{id}"=>{"get"=>{"summary"=>"Get Multi Value Legacy Extended Property", "description"=>"Get multiValueLegacyExtendedProperty Get a resource instance that contains a multi-value extended property by using $expand.", "operationId"=>"GetMultiValueLegacyExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamemailfoldersid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Value", "Legacy", "Extended", "Property"]}, "patch"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamemailfoldersid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}}, "/users/{id|userPrincipalName}/events/{id}"=>{"get"=>{"summary"=>"Get Multi Value Legacy Extended Property", "description"=>"Get multiValueLegacyExtendedProperty Get a resource instance that contains a multi-value extended property by using $expand.", "operationId"=>"GetMultiValueLegacyExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnameeventsid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Value", "Legacy", "Extended", "Property"]}, "patch"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnameeventsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}}, "/users/{id|userPrincipalName}/calendars/{id}"=>{"get"=>{"summary"=>"Get Multi Value Legacy Extended Property", "description"=>"Get multiValueLegacyExtendedProperty Get a resource instance that contains a multi-value extended property by using $expand.", "operationId"=>"GetMultiValueLegacyExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamecalendarsid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Value", "Legacy", "Extended", "Property"]}, "patch"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamecalendarsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}}, "/users/{id|userPrincipalName}/contacts/{id}"=>{"get"=>{"summary"=>"Get Multi Value Legacy Extended Property", "description"=>"Get multiValueLegacyExtendedProperty Get a resource instance that contains a multi-value extended property by using $expand.", "operationId"=>"GetMultiValueLegacyExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamecontactsid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Value", "Legacy", "Extended", "Property"]}, "patch"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamecontactsid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}}, "/users/{id|userPrincipalName}/contactFolders/{id}/contacts/{id}"=>{"get"=>{"summary"=>"Get Multi Value Legacy Extended Property", "description"=>"Get multiValueLegacyExtendedProperty Get a resource instance that contains a multi-value extended property by using $expand.", "operationId"=>"GetMultiValueLegacyExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamecontactfoldersidcontactsid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Value", "Legacy", "Extended", "Property"]}}, "/users/{id|userPrincipalName}/contactFolders/{id}"=>{"get"=>{"summary"=>"Get Multi Value Legacy Extended Property", "description"=>"Get multiValueLegacyExtendedProperty Get a resource instance that contains a multi-value extended property by using $expand.", "operationId"=>"GetMultiValueLegacyExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamecontactfoldersid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Value", "Legacy", "Extended", "Property"]}, "patch"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamecontactfoldersid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}}, "/groups/{id}/threads/{id}/posts/{id}"=>{"get"=>{"summary"=>"Get Multi Value Legacy Extended Property", "description"=>"Get multiValueLegacyExtendedProperty Get a resource instance that contains a multi-value extended property by using $expand.", "operationId"=>"GetMultiValueLegacyExtendedProperty", "x-api-path-slug"=>"groupsidthreadsidpostsid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Value", "Legacy", "Extended", "Property"]}}, "/groups/{id}/conversations/{id}/threads/{id}/posts/{id}"=>{"get"=>{"summary"=>"Get Multi Value Legacy Extended Property", "description"=>"Get multiValueLegacyExtendedProperty Get a resource instance that contains a multi-value extended property by using $expand.", "operationId"=>"GetMultiValueLegacyExtendedProperty", "x-api-path-slug"=>"groupsidconversationsidthreadsidpostsid-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi", "Value", "Legacy", "Extended", "Property"]}}, "/me/messages"=>{"post"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"memessages-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}, "get"=>{"summary"=>"Get Single Value Legacy Extended Property", "description"=>"Get singleValueLegacyExtendedProperty Get resource instances that contain a single-value extended property by using $expand or $filter.", "operationId"=>"GetSingleValueLegacyExtendedProperty", "x-api-path-slug"=>"memessages-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Value", "Legacy", "Extended", "Property"]}}, "/users/{id|userPrincipalName}/messages"=>{"post"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamemessages-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}}, "/me/mailFolders"=>{"post"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"memailfolders-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}, "get"=>{"summary"=>"Get Single Value Legacy Extended Property", "description"=>"Get singleValueLegacyExtendedProperty Get resource instances that contain a single-value extended property by using $expand or $filter.", "operationId"=>"GetSingleValueLegacyExtendedProperty", "x-api-path-slug"=>"memailfolders-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Value", "Legacy", "Extended", "Property"]}}, "/users/{id|userPrincipalName}/mailFolders"=>{"post"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamemailfolders-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}, "get"=>{"summary"=>"Get Single Value Legacy Extended Property", "description"=>"Get singleValueLegacyExtendedProperty Get resource instances that contain a single-value extended property by using $expand or $filter.", "operationId"=>"GetSingleValueLegacyExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamemailfolders-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Value", "Legacy", "Extended", "Property"]}}, "/me/events"=>{"post"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"meevents-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}, "get"=>{"summary"=>"Get Single Value Legacy Extended Property", "description"=>"Get singleValueLegacyExtendedProperty Get resource instances that contain a single-value extended property by using $expand or $filter.", "operationId"=>"GetSingleValueLegacyExtendedProperty", "x-api-path-slug"=>"meevents-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Value", "Legacy", "Extended", "Property"]}}, "/users/{id|userPrincipalName}/events"=>{"post"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnameevents-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}}, "/me/calendars"=>{"post"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"mecalendars-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}, "get"=>{"summary"=>"Get Single Value Legacy Extended Property", "description"=>"Get singleValueLegacyExtendedProperty Get resource instances that contain a single-value extended property by using $expand or $filter.", "operationId"=>"GetSingleValueLegacyExtendedProperty", "x-api-path-slug"=>"mecalendars-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Value", "Legacy", "Extended", "Property"]}}, "/users/{id|userPrincipalName}/calendars"=>{"post"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamecalendars-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}, "get"=>{"summary"=>"Get Single Value Legacy Extended Property", "description"=>"Get singleValueLegacyExtendedProperty Get resource instances that contain a single-value extended property by using $expand or $filter.", "operationId"=>"GetSingleValueLegacyExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamecalendars-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Value", "Legacy", "Extended", "Property"]}}, "/users/{id|userPrincipalName}/contacts"=>{"post"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamecontacts-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}}, "/me/contactFolders"=>{"post"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"mecontactfolders-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}}, "/users/{id|userPrincipalName}/contactFolders"=>{"post"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamecontactfolders-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}, "get"=>{"summary"=>"Get Single Value Legacy Extended Property", "description"=>"Get singleValueLegacyExtendedProperty Get resource instances that contain a single-value extended property by using $expand or $filter.", "operationId"=>"GetSingleValueLegacyExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamecontactfolders-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Value", "Legacy", "Extended", "Property"]}}, "/groups/{id}/threads/{id}/posts/{id}/reply"=>{"post"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"groupsidthreadsidpostsidreply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}}, "/groups/{id}/conversations/{id}/threads/{id}/posts/{id}/reply"=>{"post"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"groupsidconversationsidthreadsidpostsidreply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}}, "/groups/{id}/threads/{id}/reply"=>{"post"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"groupsidthreadsidreply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}}, "/groups/{id}/conversations/{id}/threads/{id}/reply"=>{"post"=>{"summary"=>"Create Multi-value Extended Property", "description"=>"Create multi-value extended property Create one or more multi-value extended properties in a new or existing instance of a resource.", "operationId"=>"CreateMulti-valueExtendedProperty", "x-api-path-slug"=>"groupsidconversationsidthreadsidreply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Multi-value", "Extended", "Property"]}}, "/workbook/names/add"=>{"post"=>{"summary"=>"Add Named Item", "description"=>"Add Named Item Adds a new name to the collection of the given scope using the user's locale for the formula.", "operationId"=>"AddNamedItem", "x-api-path-slug"=>"workbooknamesadd-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer {code}"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Named", "Item"]}}, "/workbook/worksheets({id|name})/names/add"=>{"post"=>{"summary"=>"Add Named Item", "description"=>"Add Named Item Adds a new name to the collection of the given scope using the user's locale for the formula.", "operationId"=>"AddNamedItem", "x-api-path-slug"=>"workbookworksheetsidnamenamesadd-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer {code}"}, {"in"=>"path", "name"=>"id|name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Named", "Item"]}}, "/workbook/names(<name>)"=>{"get"=>{"summary"=>"Get Named Item", "description"=>"Get NamedItem Retrieve the properties and relationships of nameditem object.", "operationId"=>"GetNamedItem", "x-api-path-slug"=>"workbooknamesltnamegt-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Named", "Item"]}, "patch"=>{"summary"=>"Update Nameditem", "description"=>"Update nameditem Update the properties of nameditem object.", "operationId"=>"UpdateNameditem", "x-api-path-slug"=>"workbooknamesltnamegt-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer {code}"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Nameditem"]}}, "/workbook/names"=>{"get"=>{"summary"=>"List Named Item Collection", "description"=>"List NamedItemCollection Retrieve a list of nameditem objects.", "operationId"=>"ListNamedItemCollection", "x-api-path-slug"=>"workbooknames-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Named", "Item", "Collection"]}}, "/workbook/names(<name>)/Range"=>{"post"=>{"summary"=>"Named Item Range", "description"=>"NamedItem: Range Returns the range object that is associated with the name. Throws an exception if the named item's type is not a range.", "operationId"=>"NamedItem:Range", "x-api-path-slug"=>"workbooknamesltnamegtrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Named", "Item", "Range"]}}, "/users/{id|userPrincipalName}/contacts/{id}/extensions/{extensionId}"=>{"delete"=>{"summary"=>"Delete Open Extension", "description"=>"Delete open extension Delete an open extension (openTypeExtension object) from the specified instance of a resource.", "operationId"=>"DeleteOpenExtension", "x-api-path-slug"=>"usersiduserprincipalnamecontactsidextensionsextensionid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"path", "name"=>"extensionId", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}, "patch"=>{"summary"=>"Update Open Extension", "description"=>"Update open extension Update an open extension (openTypeExtension object) with the properties in the request body:", "operationId"=>"UpdateOpenExtension", "x-api-path-slug"=>"usersiduserprincipalnamecontactsidextensionsextensionid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"extensionId", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/users/{id|userPrincipalName}/events/{id}/extensions/{extensionId}"=>{"delete"=>{"summary"=>"Delete Open Extension", "description"=>"Delete open extension Delete an open extension (openTypeExtension object) from the specified instance of a resource.", "operationId"=>"DeleteOpenExtension", "x-api-path-slug"=>"usersiduserprincipalnameeventsidextensionsextensionid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"path", "name"=>"extensionId", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}, "patch"=>{"summary"=>"Update Open Extension", "description"=>"Update open extension Update an open extension (openTypeExtension object) with the properties in the request body:", "operationId"=>"UpdateOpenExtension", "x-api-path-slug"=>"usersiduserprincipalnameeventsidextensionsextensionid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"extensionId", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/users/{id|userPrincipalName}/messages/{id}/extensions/{extensionId}"=>{"delete"=>{"summary"=>"Delete Open Extension", "description"=>"Delete open extension Delete an open extension (openTypeExtension object) from the specified instance of a resource.", "operationId"=>"DeleteOpenExtension", "x-api-path-slug"=>"usersiduserprincipalnamemessagesidextensionsextensionid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"path", "name"=>"extensionId", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}, "patch"=>{"summary"=>"Update Open Extension", "description"=>"Update open extension Update an open extension (openTypeExtension object) with the properties in the request body:", "operationId"=>"UpdateOpenExtension", "x-api-path-slug"=>"usersiduserprincipalnamemessagesidextensionsextensionid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"extensionId", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/groups/{id}/events/{id}/extensions/{extensionId}"=>{"delete"=>{"summary"=>"Delete Open Extension", "description"=>"Delete open extension Delete an open extension (openTypeExtension object) from the specified instance of a resource.", "operationId"=>"DeleteOpenExtension", "x-api-path-slug"=>"groupsideventsidextensionsextensionid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"path", "name"=>"extensionId", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}, "patch"=>{"summary"=>"Update Open Extension", "description"=>"Update open extension Update an open extension (openTypeExtension object) with the properties in the request body:", "operationId"=>"UpdateOpenExtension", "x-api-path-slug"=>"groupsideventsidextensionsextensionid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"extensionId", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/groups/{id}/threads/{id}/posts/{id}/extensions/{extensionId}"=>{"delete"=>{"summary"=>"Delete Open Extension", "description"=>"Delete open extension Delete an open extension (openTypeExtension object) from the specified instance of a resource.", "operationId"=>"DeleteOpenExtension", "x-api-path-slug"=>"groupsidthreadsidpostsidextensionsextensionid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"path", "name"=>"extensionId", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}, "patch"=>{"summary"=>"Update Open Extension", "description"=>"Update open extension Update an open extension (openTypeExtension object) with the properties in the request body:", "operationId"=>"UpdateOpenExtension", "x-api-path-slug"=>"groupsidthreadsidpostsidextensionsextensionid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"extensionId", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/users/{Id|userPrincipalName}/messages/{Id}/extensions/{extensionId}"=>{"get"=>{"summary"=>"Get Open Extension", "description"=>"Get open extension Get an open extension (openTypeExtension object) identified by name or fully qualified name.", "operationId"=>"GetOpenExtension", "x-api-path-slug"=>"usersiduserprincipalnamemessagesidextensionsextensionid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"path", "name"=>"extensionId", "type"=>"string"}, {"in"=>"path", "name"=>"Id", "type"=>"string"}, {"in"=>"path", "name"=>"Id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/users/{Id|userPrincipalName}/events/{Id}/extensions/{extensionId}"=>{"get"=>{"summary"=>"Get Open Extension", "description"=>"Get open extension Get an open extension (openTypeExtension object) identified by name or fully qualified name.", "operationId"=>"GetOpenExtension", "x-api-path-slug"=>"usersiduserprincipalnameeventsidextensionsextensionid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"path", "name"=>"extensionId", "type"=>"string"}, {"in"=>"path", "name"=>"Id", "type"=>"string"}, {"in"=>"path", "name"=>"Id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/users/{Id|userPrincipalName}/contacts/{Id}/extensions/{extensionId}"=>{"get"=>{"summary"=>"Get Open Extension", "description"=>"Get open extension Get an open extension (openTypeExtension object) identified by name or fully qualified name.", "operationId"=>"GetOpenExtension", "x-api-path-slug"=>"usersiduserprincipalnamecontactsidextensionsextensionid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"path", "name"=>"extensionId", "type"=>"string"}, {"in"=>"path", "name"=>"Id", "type"=>"string"}, {"in"=>"path", "name"=>"Id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/groups/{Id}/events/{Id}/extensions/{extensionId}"=>{"get"=>{"summary"=>"Get Open Extension", "description"=>"Get open extension Get an open extension (openTypeExtension object) identified by name or fully qualified name.", "operationId"=>"GetOpenExtension", "x-api-path-slug"=>"groupsideventsidextensionsextensionid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"path", "name"=>"extensionId", "type"=>"string"}, {"in"=>"path", "name"=>"Id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/groups/{Id}/threads/{Id}/posts/{Id}/extensions/{extensionId}"=>{"get"=>{"summary"=>"Get Open Extension", "description"=>"Get open extension Get an open extension (openTypeExtension object) identified by name or fully qualified name.", "operationId"=>"GetOpenExtension", "x-api-path-slug"=>"groupsidthreadsidpostsidextensionsextensionid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"path", "name"=>"extensionId", "type"=>"string"}, {"in"=>"path", "name"=>"Id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/users/{Id|userPrincipalName}/messages"=>{"get"=>{"summary"=>"Get Open Extension", "description"=>"Get open extension Get an open extension (openTypeExtension object) identified by name or fully qualified name.", "operationId"=>"GetOpenExtension", "x-api-path-slug"=>"usersiduserprincipalnamemessages-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/users/{Id|userPrincipalName}/events"=>{"get"=>{"summary"=>"Get Open Extension", "description"=>"Get open extension Get an open extension (openTypeExtension object) identified by name or fully qualified name.", "operationId"=>"GetOpenExtension", "x-api-path-slug"=>"usersiduserprincipalnameevents-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/users/{Id|userPrincipalName}/contacts"=>{"get"=>{"summary"=>"Get Open Extension", "description"=>"Get open extension Get an open extension (openTypeExtension object) identified by name or fully qualified name.", "operationId"=>"GetOpenExtension", "x-api-path-slug"=>"usersiduserprincipalnamecontacts-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "type"=>"string"}, {"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/users/{id|userPrincipalName}/contacts/{id}/extensions"=>{"post"=>{"summary"=>"Create Open Extension", "description"=>"Create open extension Create an open extension (openTypeExtension object) and add custom properties in a new or existing instance of a resource.", "operationId"=>"CreateOpenExtension", "x-api-path-slug"=>"usersiduserprincipalnamecontactsidextensions-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/users/{id|userPrincipalName}/events/{id}/extensions"=>{"post"=>{"summary"=>"Create Open Extension", "description"=>"Create open extension Create an open extension (openTypeExtension object) and add custom properties in a new or existing instance of a resource.", "operationId"=>"CreateOpenExtension", "x-api-path-slug"=>"usersiduserprincipalnameeventsidextensions-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/users/{id|userPrincipalName}/messages/{id}/extensions"=>{"post"=>{"summary"=>"Create Open Extension", "description"=>"Create open extension Create an open extension (openTypeExtension object) and add custom properties in a new or existing instance of a resource.", "operationId"=>"CreateOpenExtension", "x-api-path-slug"=>"usersiduserprincipalnamemessagesidextensions-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/groups/{id}/events/{id}/extensions"=>{"post"=>{"summary"=>"Create Open Extension", "description"=>"Create open extension Create an open extension (openTypeExtension object) and add custom properties in a new or existing instance of a resource.", "operationId"=>"CreateOpenExtension", "x-api-path-slug"=>"groupsideventsidextensions-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/groups/{id}/threads/{id}/posts/{id}/extensions"=>{"post"=>{"summary"=>"Create Open Extension", "description"=>"Create open extension Create an open extension (openTypeExtension object) and add custom properties in a new or existing instance of a resource.", "operationId"=>"CreateOpenExtension", "x-api-path-slug"=>"groupsidthreadsidpostsidextensions-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer %token%"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Open", "Extension"]}}, "/organization"=>{"get"=>{"summary"=>"Get Organization", "description"=>"Get organization Retrieve the properties and relationships of currently authenticated organization.", "operationId"=>"GetOrganization", "x-api-path-slug"=>"organization-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization"]}, "patch"=>{"summary"=>"Update Organization", "description"=>"Update organization Update the properties of the currently authenticated organization.", "operationId"=>"UpdateOrganization", "x-api-path-slug"=>"organization-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Organization"]}}, "/me/drive/items/{item-id}/permissions/{perm-id}"=>{"delete"=>{"summary"=>"Delete Permission", "description"=>"Delete permission Remove access to a DriveItem.", "operationId"=>"DeletePermission", "x-api-path-slug"=>"medriveitemsitemidpermissionspermid-delete", "parameters"=>[{"in"=>"header", "name"=>"if-match", "description"=>"If this request header is included and the eTag (or cTag) provided does not match the current tag on the item, a 412 Precondition Failed response is returned and the item will not be deleted", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}, {"in"=>"path", "name"=>"perm-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}, "get"=>{"summary"=>"Get Permission", "description"=>"Get permission Retrieve the properties and relationships of permission object.", "operationId"=>"GetPermission", "x-api-path-slug"=>"medriveitemsitemidpermissionspermid-get", "parameters"=>[{"in"=>"path", "name"=>"item-id", "type"=>"string"}, {"in"=>"path", "name"=>"perm-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}, "patch"=>{"summary"=>"Update Permission", "description"=>"Update permission Update the properties of a permission by patching the resource.", "operationId"=>"UpdatePermission", "x-api-path-slug"=>"medriveitemsitemidpermissionspermid-patch", "parameters"=>[{"in"=>"header", "name"=>"if-match", "description"=>"If this request header is included and the eTag (or cTag) provided does not match the current tag on the item, a 412 Precondition Failed response is returned and the item will not be deleted", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}, {"in"=>"path", "name"=>"perm-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}}, "/me/drive/root:/{path}:/permissions/{perm-id}"=>{"delete"=>{"summary"=>"Delete Permission", "description"=>"Delete permission Remove access to a DriveItem.", "operationId"=>"DeletePermission", "x-api-path-slug"=>"medriverootpathpermissionspermid-delete", "parameters"=>[{"in"=>"header", "name"=>"if-match", "description"=>"If this request header is included and the eTag (or cTag) provided does not match the current tag on the item, a 412 Precondition Failed response is returned and the item will not be deleted", "type"=>"string"}, {"in"=>"path", "name"=>"path", "type"=>"string"}, {"in"=>"path", "name"=>"perm-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}, "get"=>{"summary"=>"Get Permission", "description"=>"Get permission Retrieve the properties and relationships of permission object.", "operationId"=>"GetPermission", "x-api-path-slug"=>"medriverootpathpermissionspermid-get", "parameters"=>[{"in"=>"path", "name"=>"path", "type"=>"string"}, {"in"=>"path", "name"=>"perm-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}, "patch"=>{"summary"=>"Update Permission", "description"=>"Update permission Update the properties of a permission by patching the resource.", "operationId"=>"UpdatePermission", "x-api-path-slug"=>"medriverootpathpermissionspermid-patch", "parameters"=>[{"in"=>"header", "name"=>"if-match", "description"=>"If this request header is included and the eTag (or cTag) provided does not match the current tag on the item, a 412 Precondition Failed response is returned and the item will not be deleted", "type"=>"string"}, {"in"=>"path", "name"=>"path", "type"=>"string"}, {"in"=>"path", "name"=>"perm-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}}, "/groups/{group-id}/drive/items/{item-id}/permissions/{perm-id}"=>{"delete"=>{"summary"=>"Delete Permission", "description"=>"Delete permission Remove access to a DriveItem.", "operationId"=>"DeletePermission", "x-api-path-slug"=>"groupsgroupiddriveitemsitemidpermissionspermid-delete", "parameters"=>[{"in"=>"path", "name"=>"group-id", "type"=>"string"}, {"in"=>"header", "name"=>"if-match", "description"=>"If this request header is included and the eTag (or cTag) provided does not match the current tag on the item, a 412 Precondition Failed response is returned and the item will not be deleted", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}, {"in"=>"path", "name"=>"perm-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}, "get"=>{"summary"=>"Get Permission", "description"=>"Get permission Retrieve the properties and relationships of permission object.", "operationId"=>"GetPermission", "x-api-path-slug"=>"groupsgroupiddriveitemsitemidpermissionspermid-get", "parameters"=>[{"in"=>"path", "name"=>"group-id", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}, {"in"=>"path", "name"=>"perm-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}, "patch"=>{"summary"=>"Update Permission", "description"=>"Update permission Update the properties of a permission by patching the resource.", "operationId"=>"UpdatePermission", "x-api-path-slug"=>"groupsgroupiddriveitemsitemidpermissionspermid-patch", "parameters"=>[{"in"=>"path", "name"=>"group-id", "type"=>"string"}, {"in"=>"header", "name"=>"if-match", "description"=>"If this request header is included and the eTag (or cTag) provided does not match the current tag on the item, a 412 Precondition Failed response is returned and the item will not be deleted", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}, {"in"=>"path", "name"=>"perm-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}}, "/drives/{drive-id}/items/{item-id}/permissions/{perm-id}"=>{"delete"=>{"summary"=>"Delete Permission", "description"=>"Delete permission Remove access to a DriveItem.", "operationId"=>"DeletePermission", "x-api-path-slug"=>"drivesdriveiditemsitemidpermissionspermid-delete", "parameters"=>[{"in"=>"path", "name"=>"drive-id", "type"=>"string"}, {"in"=>"header", "name"=>"if-match", "description"=>"If this request header is included and the eTag (or cTag) provided does not match the current tag on the item, a 412 Precondition Failed response is returned and the item will not be deleted", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}, {"in"=>"path", "name"=>"perm-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}, "get"=>{"summary"=>"Get Permission", "description"=>"Get permission Retrieve the properties and relationships of permission object.", "operationId"=>"GetPermission", "x-api-path-slug"=>"drivesdriveiditemsitemidpermissionspermid-get", "parameters"=>[{"in"=>"path", "name"=>"drive-id", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}, {"in"=>"path", "name"=>"perm-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}, "patch"=>{"summary"=>"Update Permission", "description"=>"Update permission Update the properties of a permission by patching the resource.", "operationId"=>"UpdatePermission", "x-api-path-slug"=>"drivesdriveiditemsitemidpermissionspermid-patch", "parameters"=>[{"in"=>"path", "name"=>"drive-id", "type"=>"string"}, {"in"=>"header", "name"=>"if-match", "description"=>"If this request header is included and the eTag (or cTag) provided does not match the current tag on the item, a 412 Precondition Failed response is returned and the item will not be deleted", "type"=>"string"}, {"in"=>"path", "name"=>"item-id", "type"=>"string"}, {"in"=>"path", "name"=>"perm-id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Permission"]}}, "/users/{id | userPrincipalName}/photo"=>{"delete"=>{"summary"=>"Delete Photo", "description"=>"Delete photo Delete a photo.", "operationId"=>"DeletePhoto", "x-api-path-slug"=>"usersid--userprincipalnamephoto-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"if-match", "description"=>"If this request header is included and the eTag (or cTag) provided does not match the current tag on the item, a 412 Precondition Failed response is returned and the item will not be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo"]}, "get"=>{"summary"=>"Get Photo", "description"=>"Get photo Retrieve the properties and relationships of photo object.", "operationId"=>"GetPhoto", "x-api-path-slug"=>"usersid--userprincipalnamephoto-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo"]}, "patch"=>{"summary"=>"Update Photo", "description"=>"Update photo Update the properties of photo object.", "operationId"=>"UpdatePhoto", "x-api-path-slug"=>"usersid--userprincipalnamephoto-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo"]}}, "/groups/{id}/photo"=>{"delete"=>{"summary"=>"Delete Photo", "description"=>"Delete photo Delete a photo.", "operationId"=>"DeletePhoto", "x-api-path-slug"=>"groupsidphoto-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"header", "name"=>"if-match", "description"=>"If this request header is included and the eTag (or cTag) provided does not match the current tag on the item, a 412 Precondition Failed response is returned and the item will not be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo"]}, "get"=>{"summary"=>"Get Photo", "description"=>"Get photo Retrieve the properties and relationships of photo object.", "operationId"=>"GetPhoto", "x-api-path-slug"=>"groupsidphoto-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo"]}, "patch"=>{"summary"=>"Update Photo", "description"=>"Update photo Update the properties of photo object.", "operationId"=>"UpdatePhoto", "x-api-path-slug"=>"groupsidphoto-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo"]}}, "/drive/root/createdByUser/photo"=>{"delete"=>{"summary"=>"Delete Photo", "description"=>"Delete photo Delete a photo.", "operationId"=>"DeletePhoto", "x-api-path-slug"=>"driverootcreatedbyuserphoto-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"if-match", "description"=>"If this request header is included and the eTag (or cTag) provided does not match the current tag on the item, a 412 Precondition Failed response is returned and the item will not be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo"]}, "get"=>{"summary"=>"Get Photo", "description"=>"Get photo Retrieve the properties and relationships of photo object.", "operationId"=>"GetPhoto", "x-api-path-slug"=>"driverootcreatedbyuserphoto-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo"]}, "patch"=>{"summary"=>"Update Photo", "description"=>"Update photo Update the properties of photo object.", "operationId"=>"UpdatePhoto", "x-api-path-slug"=>"driverootcreatedbyuserphoto-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Photo"]}}, "/groups/{id}/threads/{id}/posts/{id}/forward"=>{"post"=>{"summary"=>"Post Forward", "description"=>"post: forward Forward a post to a recipient. You can specify both the parent conversation and thread in the request, or, you can specify just the parent thread without the parent conversation.", "operationId"=>"Post:Forward", "x-api-path-slug"=>"groupsidthreadsidpostsidforward-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forward"]}}, "/groups/{id}/conversations/{id}/threads/{id}/posts/{id}/forward"=>{"post"=>{"summary"=>"Post Forward", "description"=>"post: forward Forward a post to a recipient. You can specify both the parent conversation and thread in the request, or, you can specify just the parent thread without the parent conversation.", "operationId"=>"Post:Forward", "x-api-path-slug"=>"groupsidconversationsidthreadsidpostsidforward-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forward"]}}, "/groups/{id}/threads/{id}/posts/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to a post.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"groupsidthreadsidpostsidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to a post. Since there is currently a limit of 4MB on the total size of each REST request, this limits the size of the attachment you can add to under 4MB.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"groupsidthreadsidpostsidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/groups/{id}/conversations/{id}/threads/{id}/posts/{id}/attachments"=>{"get"=>{"summary"=>"List Attachments", "description"=>"List attachments Retrieve a list of attachment objects attached to a post.", "operationId"=>"ListAttachments", "x-api-path-slug"=>"groupsidconversationsidthreadsidpostsidattachments-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Attachments"]}, "post"=>{"summary"=>"Add Attachment", "description"=>"Add attachment Use this API to add an attachment to a post. Since there is currently a limit of 4MB on the total size of each REST request, this limits the size of the attachment you can add to under 4MB.", "operationId"=>"AddAttachment", "x-api-path-slug"=>"groupsidconversationsidthreadsidpostsidattachments-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attachment"]}}, "/workbook/names(<name>)/range/BoundingRect"=>{"post"=>{"summary"=>"Range Bounding Rect", "description"=>"Range: BoundingRect Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of \"B2:C5\" and \"D10:E15\" is \"B2:E16\".", "operationId"=>"Range:BoundingRect", "x-api-path-slug"=>"workbooknamesltnamegtrangeboundingrect-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Bounding", "Rect"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/BoundingRect"=>{"post"=>{"summary"=>"Range Bounding Rect", "description"=>"Range: BoundingRect Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of \"B2:C5\" and \"D10:E15\" is \"B2:E16\".", "operationId"=>"Range:BoundingRect", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtboundingrect-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Bounding", "Rect"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/BoundingRect"=>{"post"=>{"summary"=>"Range Bounding Rect", "description"=>"Range: BoundingRect Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of \"B2:C5\" and \"D10:E15\" is \"B2:E16\".", "operationId"=>"Range:BoundingRect", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeboundingrect-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Bounding", "Rect"]}}, "/workbook/names(<name>)/range/Cell"=>{"post"=>{"summary"=>"Range Cell", "description"=>"Range: Cell Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it's stays within the worksheet grid. The returned cell is located relative to the top left cell of the range.", "operationId"=>"Range:Cell", "x-api-path-slug"=>"workbooknamesltnamegtrangecell-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Cell"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/Cell"=>{"post"=>{"summary"=>"Range Cell", "description"=>"Range: Cell Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it's stays within the worksheet grid. The returned cell is located relative to the top left cell of the range.", "operationId"=>"Range:Cell", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtcell-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Cell"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/Cell"=>{"post"=>{"summary"=>"Range Cell", "description"=>"Range: Cell Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it's stays within the worksheet grid. The returned cell is located relative to the top left cell of the range.", "operationId"=>"Range:Cell", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangecell-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Cell"]}}, "/workbook/names(<name>)/range/clear"=>{"post"=>{"summary"=>"Range Clear", "description"=>"Range: clear Clear range values, format, fill, border, etc.", "operationId"=>"Range:Clear", "x-api-path-slug"=>"workbooknamesltnamegtrangeclear-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Clear"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/clear"=>{"post"=>{"summary"=>"Range Clear", "description"=>"Range: clear Clear range values, format, fill, border, etc.", "operationId"=>"Range:Clear", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtclear-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Clear"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/clear"=>{"post"=>{"summary"=>"Range Clear", "description"=>"Range: clear Clear range values, format, fill, border, etc.", "operationId"=>"Range:Clear", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeclear-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Clear"]}}, "/workbook/names(<name>)/range/Column"=>{"post"=>{"summary"=>"Range Column", "description"=>"Range: Column Gets a column contained in the range.", "operationId"=>"Range:Column", "x-api-path-slug"=>"workbooknamesltnamegtrangecolumn-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Column"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/Column"=>{"post"=>{"summary"=>"Range Column", "description"=>"Range: Column Gets a column contained in the range.", "operationId"=>"Range:Column", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtcolumn-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Column"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/Column"=>{"post"=>{"summary"=>"Range Column", "description"=>"Range: Column Gets a column contained in the range.", "operationId"=>"Range:Column", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangecolumn-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Column"]}}, "/workbook/names(<name>)/range/delete"=>{"post"=>{"summary"=>"Range Delete", "description"=>"Range: delete Deletes the cells associated with the range.", "operationId"=>"Range:Delete", "x-api-path-slug"=>"workbooknamesltnamegtrangedelete-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/delete"=>{"post"=>{"summary"=>"Range Delete", "description"=>"Range: delete Deletes the cells associated with the range.", "operationId"=>"Range:Delete", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtdelete-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/delete"=>{"post"=>{"summary"=>"Range Delete", "description"=>"Range: delete Deletes the cells associated with the range.", "operationId"=>"Range:Delete", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangedelete-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range"]}}, "/workbook/names(<name>)/range/EntireColumn"=>{"post"=>{"summary"=>"Range Entire Column", "description"=>"Range: EntireColumn Gets an object that represents the entire column of the range.", "operationId"=>"Range:EntireColumn", "x-api-path-slug"=>"workbooknamesltnamegtrangeentirecolumn-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Entire", "Column"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/EntireColumn"=>{"post"=>{"summary"=>"Range Entire Column", "description"=>"Range: EntireColumn Gets an object that represents the entire column of the range.", "operationId"=>"Range:EntireColumn", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtentirecolumn-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Entire", "Column"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/EntireColumn"=>{"post"=>{"summary"=>"Range Entire Column", "description"=>"Range: EntireColumn Gets an object that represents the entire column of the range.", "operationId"=>"Range:EntireColumn", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeentirecolumn-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Entire", "Column"]}}, "/workbook/names(<name>)/range/EntireRow"=>{"post"=>{"summary"=>"Range Entire Row", "description"=>"Range: EntireRow Gets an object that represents the entire row of the range.", "operationId"=>"Range:EntireRow", "x-api-path-slug"=>"workbooknamesltnamegtrangeentirerow-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Entire", "Row"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/EntireRow"=>{"post"=>{"summary"=>"Range Entire Row", "description"=>"Range: EntireRow Gets an object that represents the entire row of the range.", "operationId"=>"Range:EntireRow", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtentirerow-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Entire", "Row"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/EntireRow"=>{"post"=>{"summary"=>"Range Entire Row", "description"=>"Range: EntireRow Gets an object that represents the entire row of the range.", "operationId"=>"Range:EntireRow", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeentirerow-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Entire", "Row"]}}, "/workbook/names(<name>)/range/OffsetRange"=>{"post"=>{"summary"=>"Range Offset Range", "description"=>"Range: OffsetRange Gets an object which represents a range that's offset from the specified range. The dimension of the returned range will match this range. If the resulting range is forced outside the bounds of the worksheet grid, an exception will be thrown.", "operationId"=>"Range:OffsetRange", "x-api-path-slug"=>"workbooknamesltnamegtrangeoffsetrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Offset", "Range"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/OffsetRange"=>{"post"=>{"summary"=>"Range Offset Range", "description"=>"Range: OffsetRange Gets an object which represents a range that's offset from the specified range. The dimension of the returned range will match this range. If the resulting range is forced outside the bounds of the worksheet grid, an exception will be thrown.", "operationId"=>"Range:OffsetRange", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtoffsetrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Offset", "Range"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/OffsetRange"=>{"post"=>{"summary"=>"Range Offset Range", "description"=>"Range: OffsetRange Gets an object which represents a range that's offset from the specified range. The dimension of the returned range will match this range. If the resulting range is forced outside the bounds of the worksheet grid, an exception will be thrown.", "operationId"=>"Range:OffsetRange", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeoffsetrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Offset", "Range"]}}, "/workbook/names(<name>)/range/Row"=>{"post"=>{"summary"=>"Range Row", "description"=>"Range: Row Gets a row contained in the range.", "operationId"=>"Range:Row", "x-api-path-slug"=>"workbooknamesltnamegtrangerow-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Row"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/Row"=>{"post"=>{"summary"=>"Range Row", "description"=>"Range: Row Gets a row contained in the range.", "operationId"=>"Range:Row", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtrow-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Row"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/Row"=>{"post"=>{"summary"=>"Range Row", "description"=>"Range: Row Gets a row contained in the range.", "operationId"=>"Range:Row", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangerow-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Row"]}}, "/workbook/names(<name>)/range/unmerge"=>{"post"=>{"summary"=>"Range Unmerge", "description"=>"Range: unmerge Unmerge the range cells into separate cells.", "operationId"=>"Range:Unmerge", "x-api-path-slug"=>"workbooknamesltnamegtrangeunmerge-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Unmerge"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/unmerge"=>{"post"=>{"summary"=>"Range Unmerge", "description"=>"Range: unmerge Unmerge the range cells into separate cells.", "operationId"=>"Range:Unmerge", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtunmerge-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Unmerge"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/unmerge"=>{"post"=>{"summary"=>"Range Unmerge", "description"=>"Range: unmerge Unmerge the range cells into separate cells.", "operationId"=>"Range:Unmerge", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeunmerge-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Unmerge"]}}, "/workbook/names(<name>)/range"=>{"patch"=>{"summary"=>"Update Range", "description"=>"Update range Update the properties of range object.", "operationId"=>"UpdateRange", "x-api-path-slug"=>"workbooknamesltnamegtrange-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range"]}}, "/workbook/worksheets(<id|name>)/range(address=<range-address>)"=>{"patch"=>{"summary"=>"Update Range", "description"=>"Update range Update the properties of range object.", "operationId"=>"UpdateRange", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeaddressltrangeaddressgt-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range"=>{"patch"=>{"summary"=>"Update Range", "description"=>"Update range Update the properties of range object.", "operationId"=>"UpdateRange", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrange-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range"]}}, "/workbook/names(<name>)/range/UsedRange"=>{"post"=>{"summary"=>"Range Used Range", "description"=>"Range: UsedRange Returns the used range of the given range object.", "operationId"=>"Range:UsedRange", "x-api-path-slug"=>"workbooknamesltnamegtrangeusedrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Used", "Range"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/UsedRange"=>{"post"=>{"summary"=>"Range Used Range", "description"=>"Range: UsedRange Returns the used range of the given range object.", "operationId"=>"Range:UsedRange", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtusedrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Used", "Range"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/UsedRange"=>{"post"=>{"summary"=>"Range Used Range", "description"=>"Range: UsedRange Returns the used range of the given range object.", "operationId"=>"Range:UsedRange", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeusedrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Used", "Range"]}}, "/workbook/names(<name>)/range/format/borders(<sideIndex>)"=>{"get"=>{"summary"=>"Get Range Border", "description"=>"Get RangeBorder Retrieve the properties and relationships of rangeborder object.", "operationId"=>"GetRangeBorder", "x-api-path-slug"=>"workbooknamesltnamegtrangeformatbordersltsideindexgt-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Border"]}, "patch"=>{"summary"=>"Update Rangeborder", "description"=>"Update rangeborder Update the properties of rangeborder object.", "operationId"=>"UpdateRangeborder", "x-api-path-slug"=>"workbooknamesltnamegtrangeformatbordersltsideindexgt-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rangeborder"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/format/borders(<sideIndex>)"=>{"get"=>{"summary"=>"Get Range Border", "description"=>"Get RangeBorder Retrieve the properties and relationships of rangeborder object.", "operationId"=>"GetRangeBorder", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtformatbordersltsideindexgt-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Border"]}, "patch"=>{"summary"=>"Update Rangeborder", "description"=>"Update rangeborder Update the properties of rangeborder object.", "operationId"=>"UpdateRangeborder", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtformatbordersltsideindexgt-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rangeborder"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/format/borders(<sideIndex>)"=>{"get"=>{"summary"=>"Get Range Border", "description"=>"Get RangeBorder Retrieve the properties and relationships of rangeborder object.", "operationId"=>"GetRangeBorder", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeformatbordersltsideindexgt-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Border"]}, "patch"=>{"summary"=>"Update Rangeborder", "description"=>"Update rangeborder Update the properties of rangeborder object.", "operationId"=>"UpdateRangeborder", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeformatbordersltsideindexgt-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rangeborder"]}}, "/workbook/names(<name>)/range/format/borders"=>{"get"=>{"summary"=>"List Range Border Collection", "description"=>"List RangeBorderCollection Retrieve a list of rangeborder objects.", "operationId"=>"ListRangeBorderCollection", "x-api-path-slug"=>"workbooknamesltnamegtrangeformatborders-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Range", "Border", "Collection"]}, "post"=>{"summary"=>"Create Range Border", "description"=>"Create RangeBorder Use this API to create a new RangeBorder.", "operationId"=>"CreateRangeBorder", "x-api-path-slug"=>"workbooknamesltnamegtrangeformatborders-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Border"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/format/borders"=>{"get"=>{"summary"=>"List Range Border Collection", "description"=>"List RangeBorderCollection Retrieve a list of rangeborder objects.", "operationId"=>"ListRangeBorderCollection", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtformatborders-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Range", "Border", "Collection"]}, "post"=>{"summary"=>"Create Range Border", "description"=>"Create RangeBorder Use this API to create a new RangeBorder.", "operationId"=>"CreateRangeBorder", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtformatborders-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Border"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/format/borders"=>{"get"=>{"summary"=>"List Range Border Collection", "description"=>"List RangeBorderCollection Retrieve a list of rangeborder objects.", "operationId"=>"ListRangeBorderCollection", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeformatborders-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Range", "Border", "Collection"]}, "post"=>{"summary"=>"Create Range Border", "description"=>"Create RangeBorder Use this API to create a new RangeBorder.", "operationId"=>"CreateRangeBorder", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeformatborders-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Border"]}}, "/workbook/names(<name>)/range/format/borders/ItemAt"=>{"post"=>{"summary"=>"Range Border Collection Item At", "description"=>"RangeBorderCollection: ItemAt Gets a border object using its index", "operationId"=>"RangeBorderCollection:ItemAt", "x-api-path-slug"=>"workbooknamesltnamegtrangeformatbordersitemat-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Border", "Collection", "Item", "At"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/format/borders/ItemAt"=>{"post"=>{"summary"=>"Range Border Collection Item At", "description"=>"RangeBorderCollection: ItemAt Gets a border object using its index", "operationId"=>"RangeBorderCollection:ItemAt", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtformatbordersitemat-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Border", "Collection", "Item", "At"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/format/borders/ItemAt"=>{"post"=>{"summary"=>"Range Border Collection Item At", "description"=>"RangeBorderCollection: ItemAt Gets a border object using its index", "operationId"=>"RangeBorderCollection:ItemAt", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeformatbordersitemat-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Border", "Collection", "Item", "At"]}}, "/workbook/names(<name>)/range/format/fill/clear"=>{"post"=>{"summary"=>"Range Fill Clear", "description"=>"RangeFill: clear Resets the range background.", "operationId"=>"RangeFill:Clear", "x-api-path-slug"=>"workbooknamesltnamegtrangeformatfillclear-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Fill", "Clear"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/format/fill/clear"=>{"post"=>{"summary"=>"Range Fill Clear", "description"=>"RangeFill: clear Resets the range background.", "operationId"=>"RangeFill:Clear", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtformatfillclear-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Fill", "Clear"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/format/fill/clear"=>{"post"=>{"summary"=>"Range Fill Clear", "description"=>"RangeFill: clear Resets the range background.", "operationId"=>"RangeFill:Clear", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeformatfillclear-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Fill", "Clear"]}}, "/workbook/names(<name>)/range/format/fill"=>{"get"=>{"summary"=>"Get Range Fill", "description"=>"Get RangeFill Retrieve the properties and relationships of rangefill object.", "operationId"=>"GetRangeFill", "x-api-path-slug"=>"workbooknamesltnamegtrangeformatfill-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Fill"]}, "patch"=>{"summary"=>"Update Rangefill", "description"=>"Update rangefill Update the properties of rangefill object.", "operationId"=>"UpdateRangefill", "x-api-path-slug"=>"workbooknamesltnamegtrangeformatfill-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rangefill"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/format/fill"=>{"get"=>{"summary"=>"Get Range Fill", "description"=>"Get RangeFill Retrieve the properties and relationships of rangefill object.", "operationId"=>"GetRangeFill", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtformatfill-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Fill"]}, "patch"=>{"summary"=>"Update Rangefill", "description"=>"Update rangefill Update the properties of rangefill object.", "operationId"=>"UpdateRangefill", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtformatfill-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rangefill"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/format/fill"=>{"get"=>{"summary"=>"Get Range Fill", "description"=>"Get RangeFill Retrieve the properties and relationships of rangefill object.", "operationId"=>"GetRangeFill", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeformatfill-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Fill"]}, "patch"=>{"summary"=>"Update Rangefill", "description"=>"Update rangefill Update the properties of rangefill object.", "operationId"=>"UpdateRangefill", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeformatfill-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rangefill"]}}, "/workbook/names(<name>)/range/format/font"=>{"get"=>{"summary"=>"Get Range Font", "description"=>"Get RangeFont Retrieve the properties and relationships of rangefont object.", "operationId"=>"GetRangeFont", "x-api-path-slug"=>"workbooknamesltnamegtrangeformatfont-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Font"]}, "patch"=>{"summary"=>"Update Rangefont", "description"=>"Update rangefont Update the properties of rangefont object.", "operationId"=>"UpdateRangefont", "x-api-path-slug"=>"workbooknamesltnamegtrangeformatfont-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rangefont"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/format/font"=>{"get"=>{"summary"=>"Get Range Font", "description"=>"Get RangeFont Retrieve the properties and relationships of rangefont object.", "operationId"=>"GetRangeFont", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtformatfont-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Font"]}, "patch"=>{"summary"=>"Update Rangefont", "description"=>"Update rangefont Update the properties of rangefont object.", "operationId"=>"UpdateRangefont", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtformatfont-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rangefont"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/format/font"=>{"get"=>{"summary"=>"Get Range Font", "description"=>"Get RangeFont Retrieve the properties and relationships of rangefont object.", "operationId"=>"GetRangeFont", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeformatfont-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Font"]}, "patch"=>{"summary"=>"Update Rangefont", "description"=>"Update rangefont Update the properties of rangefont object.", "operationId"=>"UpdateRangefont", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeformatfont-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rangefont"]}}, "/workbook/names(<name>)/range/format/autofitColumns"=>{"post"=>{"summary"=>"Range Format Autofit Columns", "description"=>"RangeFormat: autofitColumns Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.", "operationId"=>"RangeFormat:AutofitColumns", "x-api-path-slug"=>"workbooknamesltnamegtrangeformatautofitcolumns-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Format", "Autofit", "Columns"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/format/autofitColumns"=>{"post"=>{"summary"=>"Range Format Autofit Columns", "description"=>"RangeFormat: autofitColumns Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.", "operationId"=>"RangeFormat:AutofitColumns", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtformatautofitcolumns-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Format", "Autofit", "Columns"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/format/autofitColumns"=>{"post"=>{"summary"=>"Range Format Autofit Columns", "description"=>"RangeFormat: autofitColumns Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.", "operationId"=>"RangeFormat:AutofitColumns", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeformatautofitcolumns-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Format", "Autofit", "Columns"]}}, "/workbook/names(<name>)/range/format/autofitRows"=>{"post"=>{"summary"=>"Range Format Autofit Rows", "description"=>"RangeFormat: autofitRows Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.", "operationId"=>"RangeFormat:AutofitRows", "x-api-path-slug"=>"workbooknamesltnamegtrangeformatautofitrows-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Format", "Autofit", "Rows"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/format/autofitRows"=>{"post"=>{"summary"=>"Range Format Autofit Rows", "description"=>"RangeFormat: autofitRows Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.", "operationId"=>"RangeFormat:AutofitRows", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtformatautofitrows-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Format", "Autofit", "Rows"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/format/autofitRows"=>{"post"=>{"summary"=>"Range Format Autofit Rows", "description"=>"RangeFormat: autofitRows Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.", "operationId"=>"RangeFormat:AutofitRows", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeformatautofitrows-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Format", "Autofit", "Rows"]}}, "/workbook/names(<name>)/range/format"=>{"get"=>{"summary"=>"Get Range Format", "description"=>"Get RangeFormat Retrieve the properties and relationships of rangeformat object.", "operationId"=>"GetRangeFormat", "x-api-path-slug"=>"workbooknamesltnamegtrangeformat-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Format"]}, "patch"=>{"summary"=>"Update Rangeformat", "description"=>"Update rangeformat Update the properties of rangeformat object.", "operationId"=>"UpdateRangeformat", "x-api-path-slug"=>"workbooknamesltnamegtrangeformat-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rangeformat"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/format"=>{"get"=>{"summary"=>"Get Range Format", "description"=>"Get RangeFormat Retrieve the properties and relationships of rangeformat object.", "operationId"=>"GetRangeFormat", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtformat-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Format"]}, "patch"=>{"summary"=>"Update Rangeformat", "description"=>"Update rangeformat Update the properties of rangeformat object.", "operationId"=>"UpdateRangeformat", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtformat-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rangeformat"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/format"=>{"get"=>{"summary"=>"Get Range Format", "description"=>"Get RangeFormat Retrieve the properties and relationships of rangeformat object.", "operationId"=>"GetRangeFormat", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeformat-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Format"]}, "patch"=>{"summary"=>"Update Rangeformat", "description"=>"Update rangeformat Update the properties of rangeformat object.", "operationId"=>"UpdateRangeformat", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangeformat-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rangeformat"]}}, "/workbook/names(<name>)/range/sort/apply"=>{"post"=>{"summary"=>"Range Sort Apply", "description"=>"RangeSort: apply Perform a sort operation.", "operationId"=>"RangeSort:Apply", "x-api-path-slug"=>"workbooknamesltnamegtrangesortapply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Sort", "Apply"]}}, "/workbook/worksheets(<id|name>)/range(<address>)/sort/apply"=>{"post"=>{"summary"=>"Range Sort Apply", "description"=>"RangeSort: apply Perform a sort operation.", "operationId"=>"RangeSort:Apply", "x-api-path-slug"=>"workbookworksheetsltidnamegtrangeltaddressgtsortapply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Sort", "Apply"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/range/sort/apply"=>{"post"=>{"summary"=>"Range Sort Apply", "description"=>"RangeSort: apply Perform a sort operation.", "operationId"=>"RangeSort:Apply", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrangesortapply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Range", "Sort", "Apply"]}}, "/shares/{sharingIdOrUrl}"=>{"get"=>{"summary"=>"Accessing Shared Drive Items", "description"=>"Accessing shared DriveItems Access a shared DriveItem or a collection of shared items by using a shareId or sharing URL.", "operationId"=>"AccessingSharedDriveItems", "x-api-path-slug"=>"sharessharingidorurl-get", "parameters"=>[{"in"=>"path", "name"=>"sharingIdOrUrl", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accessing", "Shared", "Drive", "Items"]}}, "/users/{id|userPrincipalName}/contactFolders/{id}/contacts"=>{"get"=>{"summary"=>"Get Single Value Legacy Extended Property", "description"=>"Get singleValueLegacyExtendedProperty Get resource instances that contain a single-value extended property by using $expand or $filter.", "operationId"=>"GetSingleValueLegacyExtendedProperty", "x-api-path-slug"=>"usersiduserprincipalnamecontactfoldersidcontacts-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Value", "Legacy", "Extended", "Property"]}}, "/me/contactfolders"=>{"get"=>{"summary"=>"Get Single Value Legacy Extended Property", "description"=>"Get singleValueLegacyExtendedProperty Get resource instances that contain a single-value extended property by using $expand or $filter.", "operationId"=>"GetSingleValueLegacyExtendedProperty", "x-api-path-slug"=>"mecontactfolders-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Value", "Legacy", "Extended", "Property"]}}, "/groups/{id}/threads/{id}/posts"=>{"get"=>{"summary"=>"Get Single Value Legacy Extended Property", "description"=>"Get singleValueLegacyExtendedProperty Get resource instances that contain a single-value extended property by using $expand or $filter.", "operationId"=>"GetSingleValueLegacyExtendedProperty", "x-api-path-slug"=>"groupsidthreadsidposts-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Value", "Legacy", "Extended", "Property"]}}, "/groups/{id}/conversations/{id}/threads/{id}/posts"=>{"get"=>{"summary"=>"Get Single Value Legacy Extended Property", "description"=>"Get singleValueLegacyExtendedProperty Get resource instances that contain a single-value extended property by using $expand or $filter.", "operationId"=>"GetSingleValueLegacyExtendedProperty", "x-api-path-slug"=>"groupsidconversationsidthreadsidposts-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "type"=>"string"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Single", "Value", "Legacy", "Extended", "Property"]}}, "/subscribedSkus/{id}"=>{"get"=>{"summary"=>"Get Subscribed Sku", "description"=>"Get subscribedSku Retrieve a specific commercial subscription that an organization has acquired.", "operationId"=>"GetSubscribedSku", "x-api-path-slug"=>"subscribedskusid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer token", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscribed", "Sku"]}}, "/subscribedSkus"=>{"get"=>{"summary"=>"List Subscribed Skus", "description"=>"List subscribedSkus Retrieve the list of commercial subscriptions that an organization has acquired.", "operationId"=>"ListSubscribedSkus", "x-api-path-slug"=>"subscribedskus-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Subscribed", "Skus"]}}, "/subscriptions/{subscriptionId}"=>{"delete"=>{"summary"=>"Delete Subscription", "description"=>"Delete subscription Delete a subscription.", "operationId"=>"DeleteSubscription", "x-api-path-slug"=>"subscriptionssubscriptionid-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"subscriptionId", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}, "get"=>{"summary"=>"Get Subscription", "description"=>"Get subscription Retrieve the properties and relationships of a subscription.", "operationId"=>"GetSubscription", "x-api-path-slug"=>"subscriptionssubscriptionid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"subscriptionId", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}, "patch"=>{"summary"=>"Update Subscription", "description"=>"Update subscription Renew a subscription by extending its expiry time.", "operationId"=>"UpdateSubscription", "x-api-path-slug"=>"subscriptionssubscriptionid-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"subscriptionId", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/subscriptions"=>{"post"=>{"summary"=>"Create Subscription", "description"=>"Create subscription Subscribes a listener application to receive notifications when data on the Microsoft Graph changes.", "operationId"=>"CreateSubscription", "x-api-path-slug"=>"subscriptions-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/workbook/tables(<id|name>)/clearFilters"=>{"post"=>{"summary"=>"Table Clear Filters", "description"=>"Table: clearFilters Clears all the filters currently applied on the table.", "operationId"=>"Table:ClearFilters", "x-api-path-slug"=>"workbooktablesltidnamegtclearfilters-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Clear", "Filters"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/clearFilters"=>{"post"=>{"summary"=>"Table Clear Filters", "description"=>"Table: clearFilters Clears all the filters currently applied on the table.", "operationId"=>"Table:ClearFilters", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtclearfilters-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Clear", "Filters"]}}, "/workbook/tables(<id|name>)/convertToRange"=>{"post"=>{"summary"=>"Table Convert To Range", "description"=>"Table: convertToRange Converts the table into a normal range of cells. All data is preserved.", "operationId"=>"Table:ConvertToRange", "x-api-path-slug"=>"workbooktablesltidnamegtconverttorange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "ConvertRange"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/convertToRange"=>{"post"=>{"summary"=>"Table Convert To Range", "description"=>"Table: convertToRange Converts the table into a normal range of cells. All data is preserved.", "operationId"=>"Table:ConvertToRange", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtconverttorange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "ConvertRange"]}}, "/workbook/tables(<id|name>)/DataBodyRange"=>{"post"=>{"summary"=>"Table Data Body Range", "description"=>"Table: DataBodyRange Gets the range object associated with the data body of the table.", "operationId"=>"Table:DataBodyRange", "x-api-path-slug"=>"workbooktablesltidnamegtdatabodyrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Data", "Body", "Range"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/DataBodyRange"=>{"post"=>{"summary"=>"Table Data Body Range", "description"=>"Table: DataBodyRange Gets the range object associated with the data body of the table.", "operationId"=>"Table:DataBodyRange", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtdatabodyrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Data", "Body", "Range"]}}, "/workbook/tables(<id|name>)/delete"=>{"post"=>{"summary"=>"Table Delete", "description"=>"Table: delete Deletes the table.", "operationId"=>"Table:Delete", "x-api-path-slug"=>"workbooktablesltidnamegtdelete-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/delete"=>{"post"=>{"summary"=>"Table Delete", "description"=>"Table: delete Deletes the table.", "operationId"=>"Table:Delete", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtdelete-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}}, "/workbook/tables(<id|name>)"=>{"get"=>{"summary"=>"Get Table", "description"=>"Get Table Retrieve the properties and relationships of table object.", "operationId"=>"GetTable", "x-api-path-slug"=>"workbooktablesltidnamegt-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}, "patch"=>{"summary"=>"Update Table", "description"=>"Update table Update the properties of table object.", "operationId"=>"UpdateTable", "x-api-path-slug"=>"workbooktablesltidnamegt-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)"=>{"get"=>{"summary"=>"Get Table", "description"=>"Get Table Retrieve the properties and relationships of table object.", "operationId"=>"GetTable", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegt-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}, "patch"=>{"summary"=>"Update Table", "description"=>"Update table Update the properties of table object.", "operationId"=>"UpdateTable", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegt-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}}, "/workbook/tables(<id|name>)/HeaderRowRange"=>{"post"=>{"summary"=>"Table Header Row Range", "description"=>"Table: HeaderRowRange Gets the range object associated with header row of the table.", "operationId"=>"Table:HeaderRowRange", "x-api-path-slug"=>"workbooktablesltidnamegtheaderrowrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Header", "Row", "Range"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/HeaderRowRange"=>{"post"=>{"summary"=>"Table Header Row Range", "description"=>"Table: HeaderRowRange Gets the range object associated with header row of the table.", "operationId"=>"Table:HeaderRowRange", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtheaderrowrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Header", "Row", "Range"]}}, "/workbook/tables"=>{"get"=>{"summary"=>"List Table Collection", "description"=>"List TableCollection Retrieve a list of table objects.", "operationId"=>"ListTableCollection", "x-api-path-slug"=>"workbooktables-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Table", "Collection"]}}, "/workbook/worksheets(<id|name>)/tables"=>{"get"=>{"summary"=>"List Table Collection", "description"=>"List TableCollection Retrieve a list of table objects.", "operationId"=>"ListTableCollection", "x-api-path-slug"=>"workbookworksheetsltidnamegttables-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Table", "Collection"]}}, "/workbook/tables(<id|name>)/columns"=>{"get"=>{"summary"=>"List Columns", "description"=>"List columns Retrieve a list of tablecolumn objects.", "operationId"=>"ListColumns", "x-api-path-slug"=>"workbooktablesltidnamegtcolumns-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Columns"]}, "post"=>{"summary"=>"Create Table Column", "description"=>"Create TableColumn Use this API to create a new TableColumn.", "operationId"=>"CreateTableColumn", "x-api-path-slug"=>"workbooktablesltidnamegtcolumns-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/columns"=>{"get"=>{"summary"=>"List Columns", "description"=>"List columns Retrieve a list of tablecolumn objects.", "operationId"=>"ListColumns", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtcolumns-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Columns"]}, "post"=>{"summary"=>"Create Table Column", "description"=>"Create TableColumn Use this API to create a new TableColumn.", "operationId"=>"CreateTableColumn", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtcolumns-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column"]}}, "/workbook/tables(<id|name>)/rows"=>{"get"=>{"summary"=>"List Rows", "description"=>"List rows Retrieve a list of tablerow objects.", "operationId"=>"ListRows", "x-api-path-slug"=>"workbooktablesltidnamegtrows-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Rows"]}, "post"=>{"summary"=>"Create Table Row", "description"=>"Create TableRow Use this API to create a new TableRow.", "operationId"=>"CreateTableRow", "x-api-path-slug"=>"workbooktablesltidnamegtrows-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Row"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/rows"=>{"get"=>{"summary"=>"List Rows", "description"=>"List rows Retrieve a list of tablerow objects.", "operationId"=>"ListRows", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtrows-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Rows"]}, "post"=>{"summary"=>"Create Table Row", "description"=>"Create TableRow Use this API to create a new TableRow.", "operationId"=>"CreateTableRow", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtrows-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Row"]}}, "/workbook/tables(<id|name>)/Range"=>{"post"=>{"summary"=>"Table Range", "description"=>"Table: Range Gets the range object associated with the entire table.", "operationId"=>"Table:Range", "x-api-path-slug"=>"workbooktablesltidnamegtrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Range"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/Range"=>{"post"=>{"summary"=>"Table Range", "description"=>"Table: Range Gets the range object associated with the entire table.", "operationId"=>"Table:Range", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Range"]}}, "/workbook/tables(<id|name>)/reapplyFilters"=>{"post"=>{"summary"=>"Table Reapply Filters", "description"=>"Table: reapplyFilters Reapplies all the filters currently on the table.", "operationId"=>"Table:ReapplyFilters", "x-api-path-slug"=>"workbooktablesltidnamegtreapplyfilters-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Reapply", "Filters"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/reapplyFilters"=>{"post"=>{"summary"=>"Table Reapply Filters", "description"=>"Table: reapplyFilters Reapplies all the filters currently on the table.", "operationId"=>"Table:ReapplyFilters", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtreapplyfilters-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Reapply", "Filters"]}}, "/workbook/tables(<id|name>)/TotalRowRange"=>{"post"=>{"summary"=>"Table Total Row Range", "description"=>"Table: TotalRowRange Gets the range object associated with totals row of the table.", "operationId"=>"Table:TotalRowRange", "x-api-path-slug"=>"workbooktablesltidnamegttotalrowrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Total", "Row", "Range"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/TotalRowRange"=>{"post"=>{"summary"=>"Table Total Row Range", "description"=>"Table: TotalRowRange Gets the range object associated with totals row of the table.", "operationId"=>"Table:TotalRowRange", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegttotalrowrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Total", "Row", "Range"]}}, "/workbook/tables/add"=>{"post"=>{"summary"=>"Table Collection Add", "description"=>"TableCollection: add Create a new table. The range source address determines the worksheet under which the table will be added. If the table cannot be added (e.g., because the address is invalid, or the table would overlap with another table), an error will be thrown.", "operationId"=>"TableCollection:Add", "x-api-path-slug"=>"workbooktablesadd-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Collection"]}}, "/workbook/worksheets(<id|name>)/tables/add"=>{"post"=>{"summary"=>"Table Collection Add", "description"=>"TableCollection: add Create a new table. The range source address determines the worksheet under which the table will be added. If the table cannot be added (e.g., because the address is invalid, or the table would overlap with another table), an error will be thrown.", "operationId"=>"TableCollection:Add", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesadd-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Collection"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/DataBodyRange"=>{"post"=>{"summary"=>"Table Column Data Body Range", "description"=>"TableColumn: DataBodyRange Gets the range object associated with the data body of the column.", "operationId"=>"TableColumn:DataBodyRange", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtdatabodyrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column", "Data", "Body", "Range"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/columns(<id|name>)/DataBodyRange"=>{"post"=>{"summary"=>"Table Column Data Body Range", "description"=>"TableColumn: DataBodyRange Gets the range object associated with the data body of the column.", "operationId"=>"TableColumn:DataBodyRange", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtcolumnsltidnamegtdatabodyrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column", "Data", "Body", "Range"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/delete"=>{"post"=>{"summary"=>"Table Column Delete", "description"=>"TableColumn: delete Deletes the column from the table.", "operationId"=>"TableColumn:Delete", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtdelete-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/columns(<id|name>)/delete"=>{"post"=>{"summary"=>"Table Column Delete", "description"=>"TableColumn: delete Deletes the column from the table.", "operationId"=>"TableColumn:Delete", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtcolumnsltidnamegtdelete-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)"=>{"get"=>{"summary"=>"Get Table Column", "description"=>"Get TableColumn Retrieve the properties and relationships of tablecolumn object.", "operationId"=>"GetTableColumn", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegt-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column"]}, "patch"=>{"summary"=>"Update Tablecolumn", "description"=>"Update tablecolumn Update the properties of tablecolumn object.", "operationId"=>"UpdateTablecolumn", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegt-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tablecolumn"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/columns(<id|name>)"=>{"get"=>{"summary"=>"Get Table Column", "description"=>"Get TableColumn Retrieve the properties and relationships of tablecolumn object.", "operationId"=>"GetTableColumn", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtcolumnsltidnamegt-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column"]}, "patch"=>{"summary"=>"Update Tablecolumn", "description"=>"Update tablecolumn Update the properties of tablecolumn object.", "operationId"=>"UpdateTablecolumn", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtcolumnsltidnamegt-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tablecolumn"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/HeaderRowRange"=>{"post"=>{"summary"=>"Table Column Header Row Range", "description"=>"TableColumn: HeaderRowRange Gets the range object associated with the header row of the column.", "operationId"=>"TableColumn:HeaderRowRange", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtheaderrowrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column", "Header", "Row", "Range"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/columns(<id|name>)/HeaderRowRange"=>{"post"=>{"summary"=>"Table Column Header Row Range", "description"=>"TableColumn: HeaderRowRange Gets the range object associated with the header row of the column.", "operationId"=>"TableColumn:HeaderRowRange", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtcolumnsltidnamegtheaderrowrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column", "Header", "Row", "Range"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/Range"=>{"post"=>{"summary"=>"Table Column Range", "description"=>"TableColumn: Range Gets the range object associated with the entire column.", "operationId"=>"TableColumn:Range", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegtrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column", "Range"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/columns(<id|name>)/Range"=>{"post"=>{"summary"=>"Table Column Range", "description"=>"TableColumn: Range Gets the range object associated with the entire column.", "operationId"=>"TableColumn:Range", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtcolumnsltidnamegtrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column", "Range"]}}, "/workbook/tables(<id|name>)/columns(<id|name>)/TotalRowRange"=>{"post"=>{"summary"=>"Table Column Total Row Range", "description"=>"TableColumn: TotalRowRange Gets the range object associated with the totals row of the column.", "operationId"=>"TableColumn:TotalRowRange", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsltidnamegttotalrowrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column", "Total", "Row", "Range"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/columns(<id|name>)/TotalRowRange"=>{"post"=>{"summary"=>"Table Column Total Row Range", "description"=>"TableColumn: TotalRowRange Gets the range object associated with the totals row of the column.", "operationId"=>"TableColumn:TotalRowRange", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtcolumnsltidnamegttotalrowrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column", "Total", "Row", "Range"]}}, "/workbook/tables(<id|name>)/columns/add"=>{"post"=>{"summary"=>"Table Column Collection Add", "description"=>"TableColumnCollection: add Adds a new column to the table.", "operationId"=>"TableColumnCollection:Add", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsadd-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column", "Collection"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/columns/add"=>{"post"=>{"summary"=>"Table Column Collection Add", "description"=>"TableColumnCollection: add Adds a new column to the table.", "operationId"=>"TableColumnCollection:Add", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtcolumnsadd-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column", "Collection"]}}, "/workbook/tables(<id|name>)/columns/ItemAt"=>{"post"=>{"summary"=>"Table Column Collection Item At", "description"=>"TableColumnCollection: ItemAt Gets a column based on its position in the collection.", "operationId"=>"TableColumnCollection:ItemAt", "x-api-path-slug"=>"workbooktablesltidnamegtcolumnsitemat-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column", "Collection", "Item", "At"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/columns/ItemAt"=>{"post"=>{"summary"=>"Table Column Collection Item At", "description"=>"TableColumnCollection: ItemAt Gets a column based on its position in the collection.", "operationId"=>"TableColumnCollection:ItemAt", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtcolumnsitemat-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Column", "Collection", "Item", "At"]}}, "/workbook/tables(<id|name>)/rows(<index>)/delete"=>{"post"=>{"summary"=>"Table Row Delete", "description"=>"TableRow: delete Deletes the row from the table.", "operationId"=>"TableRow:Delete", "x-api-path-slug"=>"workbooktablesltidnamegtrowsltindexgtdelete-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Row"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/rows(<index>)/delete"=>{"post"=>{"summary"=>"Table Row Delete", "description"=>"TableRow: delete Deletes the row from the table.", "operationId"=>"TableRow:Delete", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtrowsltindexgtdelete-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Row"]}}, "/workbook/tables(<id|name>)/rows(<index>)"=>{"get"=>{"summary"=>"Get Table Row", "description"=>"Get TableRow Retrieve the properties and relationships of tablerow object.", "operationId"=>"GetTableRow", "x-api-path-slug"=>"workbooktablesltidnamegtrowsltindexgt-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Row"]}, "patch"=>{"summary"=>"Update Tablerow", "description"=>"Update tablerow Update the properties of tablerow object.", "operationId"=>"UpdateTablerow", "x-api-path-slug"=>"workbooktablesltidnamegtrowsltindexgt-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tablerow"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/rows(<index>)"=>{"get"=>{"summary"=>"Get Table Row", "description"=>"Get TableRow Retrieve the properties and relationships of tablerow object.", "operationId"=>"GetTableRow", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtrowsltindexgt-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Row"]}, "patch"=>{"summary"=>"Update Tablerow", "description"=>"Update tablerow Update the properties of tablerow object.", "operationId"=>"UpdateTablerow", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtrowsltindexgt-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tablerow"]}}, "/workbook/tables(<id|name>)/rows(<index>)/Range"=>{"post"=>{"summary"=>"Table Row Range", "description"=>"TableRow: Range Returns the range object associated with the entire row.", "operationId"=>"TableRow:Range", "x-api-path-slug"=>"workbooktablesltidnamegtrowsltindexgtrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Row", "Range"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/rows(<index>)/Range"=>{"post"=>{"summary"=>"Table Row Range", "description"=>"TableRow: Range Returns the range object associated with the entire row.", "operationId"=>"TableRow:Range", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtrowsltindexgtrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Row", "Range"]}}, "/workbook/tables(<id|name>)/rows/add"=>{"post"=>{"summary"=>"Table Row Collection Add", "description"=>"TableRowCollection: add Adds a new row to the table.", "operationId"=>"TableRowCollection:Add", "x-api-path-slug"=>"workbooktablesltidnamegtrowsadd-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Row", "Collection"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/rows/add"=>{"post"=>{"summary"=>"Table Row Collection Add", "description"=>"TableRowCollection: add Adds a new row to the table.", "operationId"=>"TableRowCollection:Add", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtrowsadd-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Row", "Collection"]}}, "/workbook/tables(<id|name>)/rows/ItemAt"=>{"post"=>{"summary"=>"Table Row Collection Item At", "description"=>"TableRowCollection: ItemAt Gets a row based on its position in the collection.", "operationId"=>"TableRowCollection:ItemAt", "x-api-path-slug"=>"workbooktablesltidnamegtrowsitemat-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Row", "Collection", "Item", "At"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/rows/ItemAt"=>{"post"=>{"summary"=>"Table Row Collection Item At", "description"=>"TableRowCollection: ItemAt Gets a row based on its position in the collection.", "operationId"=>"TableRowCollection:ItemAt", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtrowsitemat-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Row", "Collection", "Item", "At"]}}, "/workbook/tables(<id|name>)/sort/apply"=>{"post"=>{"summary"=>"Table Sort Apply", "description"=>"TableSort: apply Perform a sort operation.", "operationId"=>"TableSort:Apply", "x-api-path-slug"=>"workbooktablesltidnamegtsortapply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Sort", "Apply"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/sort/apply"=>{"post"=>{"summary"=>"Table Sort Apply", "description"=>"TableSort: apply Perform a sort operation.", "operationId"=>"TableSort:Apply", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtsortapply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Sort", "Apply"]}}, "/workbook/tables(<id|name>)/sort/clear"=>{"post"=>{"summary"=>"Table Sort Clear", "description"=>"TableSort: clear Clears the sorting that is currently on the table. While this doesn't modify the table's ordering, it clears the state of the header buttons.", "operationId"=>"TableSort:Clear", "x-api-path-slug"=>"workbooktablesltidnamegtsortclear-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Sort", "Clear"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/sort/clear"=>{"post"=>{"summary"=>"Table Sort Clear", "description"=>"TableSort: clear Clears the sorting that is currently on the table. While this doesn't modify the table's ordering, it clears the state of the header buttons.", "operationId"=>"TableSort:Clear", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtsortclear-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Sort", "Clear"]}}, "/workbook/tables(<id|name>)/sort"=>{"get"=>{"summary"=>"Get Table Sort", "description"=>"Get TableSort Retrieve the properties and relationships of tablesort object.", "operationId"=>"GetTableSort", "x-api-path-slug"=>"workbooktablesltidnamegtsort-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Sort"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/sort"=>{"get"=>{"summary"=>"Get Table Sort", "description"=>"Get TableSort Retrieve the properties and relationships of tablesort object.", "operationId"=>"GetTableSort", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtsort-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Sort"]}}, "/workbook/tables(<id|name>)/sort/reapply"=>{"post"=>{"summary"=>"Table Sort Reapply", "description"=>"TableSort: reapply Reapplies the current sorting parameters to the table.", "operationId"=>"TableSort:Reapply", "x-api-path-slug"=>"workbooktablesltidnamegtsortreapply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Sort", "Reapply"]}}, "/workbook/worksheets(<id|name>)/tables(<id|name>)/sort/reapply"=>{"post"=>{"summary"=>"Table Sort Reapply", "description"=>"TableSort: reapply Reapplies the current sorting parameters to the table.", "operationId"=>"TableSort:Reapply", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesltidnamegtsortreapply-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table", "Sort", "Reapply"]}}, "/drive/root/thumbnails/{id}"=>{"get"=>{"summary"=>"Get Thumbnail Set", "description"=>"Get thumbnailSet Retrieve the properties and relationships of a thumbnailSet object.", "operationId"=>"GetThumbnailSet", "x-api-path-slug"=>"driverootthumbnailsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thumbnail", "Set"]}}, "/drive/items/{id}/thumbnails/{id}"=>{"get"=>{"summary"=>"Get Thumbnail Set", "description"=>"Get thumbnailSet Retrieve the properties and relationships of a thumbnailSet object.", "operationId"=>"GetThumbnailSet", "x-api-path-slug"=>"driveitemsidthumbnailsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thumbnail", "Set"]}}, "/drives/{id}/root/thumbnails/{id}"=>{"get"=>{"summary"=>"Get Thumbnail Set", "description"=>"Get thumbnailSet Retrieve the properties and relationships of a thumbnailSet object.", "operationId"=>"GetThumbnailSet", "x-api-path-slug"=>"drivesidrootthumbnailsid-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Thumbnail", "Set"]}}, "/users/{id | userPrincipalName}/assignLicense"=>{"post"=>{"summary"=>"Assign License", "description"=>"assignLicense Add or remove subscriptions for the user. You can also enable and disable specific plans associated with a subscription.", "operationId"=>"AssignLicense", "x-api-path-slug"=>"usersid--userprincipalnameassignlicense-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assign", "License"]}}, "/users/{id | userPrincipalName}"=>{"delete"=>{"summary"=>"Delete A User", "description"=>"Delete a user Delete user.", "operationId"=>"DeleteAUser", "x-api-path-slug"=>"usersid--userprincipalname-delete", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "get"=>{"summary"=>"Get A User", "description"=>"Get a user Retrieve the properties and relationships of user object.", "operationId"=>"GetAUser", "x-api-path-slug"=>"usersid--userprincipalname-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "patch"=>{"summary"=>"Update User", "description"=>"Update user Update the properties of a user object.", "operationId"=>"UpdateUser", "x-api-path-slug"=>"usersid--userprincipalname-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/me/findMeetingTimes"=>{"post"=>{"summary"=>"User Find Meeting Times", "description"=>"user: findMeetingTimes Find meeting time suggestions based on organizer and attendee availability, and time or location constraints specified as parameters.", "operationId"=>"User:FindMeetingTimes", "x-api-path-slug"=>"mefindmeetingtimes-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"A string representing a specific time zone for the response, for example, Pacific Standard Time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Find", "Meeting", "Times"]}}, "/users/{id|userPrincipalName}/findMeetingTimes"=>{"post"=>{"summary"=>"User Find Meeting Times", "description"=>"user: findMeetingTimes Find meeting time suggestions based on organizer and attendee availability, and time or location constraints specified as parameters.", "operationId"=>"User:FindMeetingTimes", "x-api-path-slug"=>"usersiduserprincipalnamefindmeetingtimes-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"A string representing a specific time zone for the response, for example, Pacific Standard Time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Find", "Meeting", "Times"]}}, "/me/mailboxSettings"=>{"get"=>{"summary"=>"Get User Mailbox Settings", "description"=>"Get user mailbox settings Get the user's mailboxSettings. This includes settings for automatic replies (notify people automatically upon receipt of their email), locale (language and country/region), and time zone.", "operationId"=>"GetUserMailboxSettings", "x-api-path-slug"=>"memailboxsettings-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer <token>", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Mailbox", "Settings"]}, "patch"=>{"summary"=>"Update User Mailbox Settings", "description"=>"Update user mailbox settings Update one or more settings for the user's mailbox. This includes settings for automatic replies (notify people automatically upon receipt of their email), locale, or time zone.", "operationId"=>"UpdateUserMailboxSettings", "x-api-path-slug"=>"memailboxsettings-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer <token>", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Mailbox", "Settings"]}}, "/users/{id|userPrincipalName}/mailboxSettings"=>{"get"=>{"summary"=>"Get User Mailbox Settings", "description"=>"Get user mailbox settings Get the user's mailboxSettings. This includes settings for automatic replies (notify people automatically upon receipt of their email), locale (language and country/region), and time zone.", "operationId"=>"GetUserMailboxSettings", "x-api-path-slug"=>"usersiduserprincipalnamemailboxsettings-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer <token>", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Mailbox", "Settings"]}, "patch"=>{"summary"=>"Update User Mailbox Settings", "description"=>"Update user mailbox settings Update one or more settings for the user's mailbox. This includes settings for automatic replies (notify people automatically upon receipt of their email), locale, or time zone.", "operationId"=>"UpdateUserMailboxSettings", "x-api-path-slug"=>"usersiduserprincipalnamemailboxsettings-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer <token>", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Mailbox", "Settings"]}}, "/me/mailboxSettings/automaticRepliesSetting"=>{"get"=>{"summary"=>"Get User Mailbox Settings", "description"=>"Get user mailbox settings Get the user's mailboxSettings. This includes settings for automatic replies (notify people automatically upon receipt of their email), locale (language and country/region), and time zone.", "operationId"=>"GetUserMailboxSettings", "x-api-path-slug"=>"memailboxsettingsautomaticrepliessetting-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer <token>", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Mailbox", "Settings"]}}, "/users/{id|userPrincipalName}/mailboxSettings/automaticRepliesSetting"=>{"get"=>{"summary"=>"Get User Mailbox Settings", "description"=>"Get user mailbox settings Get the user's mailboxSettings. This includes settings for automatic replies (notify people automatically upon receipt of their email), locale (language and country/region), and time zone.", "operationId"=>"GetUserMailboxSettings", "x-api-path-slug"=>"usersiduserprincipalnamemailboxsettingsautomaticrepliessetting-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer <token>", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Mailbox", "Settings"]}}, "/me/mailboxSettings/language"=>{"get"=>{"summary"=>"Get User Mailbox Settings", "description"=>"Get user mailbox settings Get the user's mailboxSettings. This includes settings for automatic replies (notify people automatically upon receipt of their email), locale (language and country/region), and time zone.", "operationId"=>"GetUserMailboxSettings", "x-api-path-slug"=>"memailboxsettingslanguage-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer <token>", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Mailbox", "Settings"]}}, "/users/{id|userPrincipalName}/mailboxSettings/language"=>{"get"=>{"summary"=>"Get User Mailbox Settings", "description"=>"Get user mailbox settings Get the user's mailboxSettings. This includes settings for automatic replies (notify people automatically upon receipt of their email), locale (language and country/region), and time zone.", "operationId"=>"GetUserMailboxSettings", "x-api-path-slug"=>"usersiduserprincipalnamemailboxsettingslanguage-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer <token>", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Mailbox", "Settings"]}}, "/me/mailboxSettings/timeZone"=>{"get"=>{"summary"=>"Get User Mailbox Settings", "description"=>"Get user mailbox settings Get the user's mailboxSettings. This includes settings for automatic replies (notify people automatically upon receipt of their email), locale (language and country/region), and time zone.", "operationId"=>"GetUserMailboxSettings", "x-api-path-slug"=>"memailboxsettingstimezone-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer <token>", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Mailbox", "Settings"]}}, "/users/{id|userPrincipalName}/mailboxSettings/timeZone"=>{"get"=>{"summary"=>"Get User Mailbox Settings", "description"=>"Get user mailbox settings Get the user's mailboxSettings. This includes settings for automatic replies (notify people automatically upon receipt of their email), locale (language and country/region), and time zone.", "operationId"=>"GetUserMailboxSettings", "x-api-path-slug"=>"usersiduserprincipalnamemailboxsettingstimezone-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer <token>", "type"=>"string"}, {"in"=>"path", "name"=>"id|userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Mailbox", "Settings"]}}, "/users"=>{"get"=>{"summary"=>"List Users", "description"=>"List users Retrieve a list of user objects.", "operationId"=>"ListUsers", "x-api-path-slug"=>"users-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Users"]}, "post"=>{"summary"=>"Create User", "description"=>"Create User Use this API to create a new User. The request body contains the user to create. At a minimum, you must specify the required properties for the user. You can optionally specify any other writable properties.", "operationId"=>"CreateUser", "x-api-path-slug"=>"users-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/users/{id | userPrincipalName}/calendarGroups"=>{"get"=>{"summary"=>"List Calendar Groups", "description"=>"List calendarGroups Get the user's calendar groups.", "operationId"=>"ListCalendarGroups", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroups-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendar", "Groups"]}, "post"=>{"summary"=>"Create Calendar Group", "description"=>"Create CalendarGroup Use this API to create a new CalendarGroup.", "operationId"=>"CreateCalendarGroup", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroups-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar", "Group"]}}, "/users/{id | userPrincipalName}/calendars"=>{"get"=>{"summary"=>"List Calendars", "description"=>"List calendars Get all the user's calendars (/calendars navigation property), get the calendars from the default calendar group or from a specific calendar group.", "operationId"=>"ListCalendars", "x-api-path-slug"=>"usersid--userprincipalnamecalendars-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendars"]}, "post"=>{"summary"=>"Create Calendar", "description"=>"Create Calendar Use this API to create a new Calendar.", "operationId"=>"CreateCalendar", "x-api-path-slug"=>"usersid--userprincipalnamecalendars-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calendar"]}}, "/me/calendargroups/{calendar_group_id}/calendars"=>{"get"=>{"summary"=>"List Calendars", "description"=>"List calendars Get all the user's calendars (/calendars navigation property), get the calendars from the default calendar group or from a specific calendar group.", "operationId"=>"ListCalendars", "x-api-path-slug"=>"mecalendargroupscalendar-group-idcalendars-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"calendar_group_id", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendars"]}}, "/users/{id | userPrincipalName}/calendarGroups/{calendar_group_id}/calendars"=>{"get"=>{"summary"=>"List Calendars", "description"=>"List calendars Get all the user's calendars (/calendars navigation property), get the calendars from the default calendar group or from a specific calendar group.", "operationId"=>"ListCalendars", "x-api-path-slug"=>"usersid--userprincipalnamecalendargroupscalendar-group-idcalendars-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"calendar_group_id", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendars"]}}, "/users/{id | userPrincipalName}/calendarView"=>{"get"=>{"summary"=>"List Calendar View", "description"=>"List calendarView Get the occurrences, exceptions, and single instances of events in a calendar view defined by a time range, from the user's default calendar, or from some other calendar of the user's.", "operationId"=>"ListCalendarView", "x-api-path-slug"=>"usersid--userprincipalnamecalendarview-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json", "type"=>"string"}, {"in"=>"query", "name"=>"endDateTime", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer", "type"=>"string"}, {"in"=>"query", "name"=>"startDateTime", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Calendar", "View"]}}, "/users/{id | userPrincipalName}/contactFolders"=>{"get"=>{"summary"=>"List Contact Folders", "description"=>"List contactFolders Get the contact folder collection in the default Contacts folder of the signed-in user.", "operationId"=>"ListContactFolders", "x-api-path-slug"=>"usersid--userprincipalnamecontactfolders-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Contact", "Folders"]}, "post"=>{"summary"=>"Create Contact Folder", "description"=>"Create ContactFolder Create a new contactFolder under the user's default contacts folder.", "operationId"=>"CreateContactFolder", "x-api-path-slug"=>"usersid--userprincipalnamecontactfolders-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact", "Folder"]}}, "/me/contactFolder/{id}/childFolders/{id}/.../contacts"=>{"get"=>{"summary"=>"List Contacts", "description"=>"List contacts Get a contact collection from the default Contacts folder of the signed-in user.", "operationId"=>"ListContacts", "x-api-path-slug"=>"mecontactfolderidchildfoldersid---contacts-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Contacts"]}}, "/users/{id | userPrincipalName}/contactFolders/{id}/childFolders/{id}/contacts"=>{"get"=>{"summary"=>"List Contacts", "description"=>"List contacts Get a contact collection from the default Contacts folder of the signed-in user.", "operationId"=>"ListContacts", "x-api-path-slug"=>"usersid--userprincipalnamecontactfoldersidchildfoldersidcontacts-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Contacts"]}}, "/users/{id | userPrincipalName}/createdObjects"=>{"get"=>{"summary"=>"List Created Objects", "description"=>"List createdObjects Get a list of directory objects that were created by the user.", "operationId"=>"ListCreatedObjects", "x-api-path-slug"=>"usersid--userprincipalnamecreatedobjects-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Created", "Objects"]}}, "/users/{id | userPrincipalName}/directReports"=>{"get"=>{"summary"=>"List Direct Reports", "description"=>"List directReports Get user's direct reports. Returns the users and contacts for whom this user is assigned as manager.", "operationId"=>"ListDirectReports", "x-api-path-slug"=>"usersid--userprincipalnamedirectreports-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Direct", "Reports"]}}, "/users/{id | userPrincipalName}/events"=>{"get"=>{"summary"=>"List Events", "description"=>"List events Get a list of event objects in the user's mailbox. The list contains single instance meetings and series masters.", "operationId"=>"ListEvents", "x-api-path-slug"=>"usersid--userprincipalnameevents-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer: outlook.timezone", "description"=>"The default time zone for events in the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Events"]}, "post"=>{"summary"=>"Create Event", "description"=>"Create Event Create an event in the user's default calendar.", "operationId"=>"CreateEvent", "x-api-path-slug"=>"usersid--userprincipalnameevents-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event"]}}, "/users/{id | userPrincipalName}/mailFolders"=>{"get"=>{"summary"=>"List Mail Folders", "description"=>"List mailFolders Get the mail folder collection under the root folder of the signed-in user.", "operationId"=>"ListMailFolders", "x-api-path-slug"=>"usersid--userprincipalnamemailfolders-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Mail", "Folders"]}, "post"=>{"summary"=>"Create Mail Folder", "description"=>"Create MailFolder Use this API to create a new mail folder.", "operationId"=>"CreateMailFolder", "x-api-path-slug"=>"usersid--userprincipalnamemailfolders-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mail", "Folder"]}}, "/users/{id | userPrincipalName}/manager"=>{"get"=>{"summary"=>"List Manager", "description"=>"List manager Get user's manager. Returns the user or contact assigned as the user's manager.", "operationId"=>"ListManager", "x-api-path-slug"=>"usersid--userprincipalnamemanager-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Manager"]}}, "/users/{id | userPrincipalName}/memberOf"=>{"get"=>{"summary"=>"List Member Of", "description"=>"List memberOf Get groups and directory roles that the user is a direct member of.", "operationId"=>"ListMemberOf", "x-api-path-slug"=>"usersid--userprincipalnamememberof-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"application/json"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Member", "Of"]}}, "/users/{id | userPrincipalName}/messages"=>{"get"=>{"summary"=>"List Messages", "description"=>"List messages Get the messages in the signed-in user's mailbox (including the Deleted Items and Clutter folders).", "operationId"=>"ListMessages", "x-api-path-slug"=>"usersid--userprincipalnamemessages-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Messages"]}}, "/users/{id | userPrincipalName}/ownedDevices"=>{"get"=>{"summary"=>"List Owned Devices", "description"=>"List ownedDevices Get the list of devices that are owned by the user.", "operationId"=>"ListOwnedDevices", "x-api-path-slug"=>"usersid--userprincipalnameowneddevices-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"application/json"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Owned", "Devices"]}}, "/users/{id | userPrincipalName}/ownedObjects"=>{"get"=>{"summary"=>"List Owned Objects", "description"=>"List ownedObjects Get the list of directory objects that are owned by the user.", "operationId"=>"ListOwnedObjects", "x-api-path-slug"=>"usersid--userprincipalnameownedobjects-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"application/json"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Owned", "Objects"]}}, "/users/{id | userPrincipalName}/registeredDevices"=>{"get"=>{"summary"=>"List Registered Devices", "description"=>"List registeredDevices Get the list of user's registered devices.", "operationId"=>"ListRegisteredDevices", "x-api-path-slug"=>"usersid--userprincipalnameregistereddevices-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"application/json"}, {"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Registered", "Devices"]}}, "/me/contactFolders/{contactFolderId}/contacts"=>{"post"=>{"summary"=>"Create Contact", "description"=>"Create Contact Add a contact to the root Contacts folder or to the contacts endpoint of another contact folder.", "operationId"=>"CreateContact", "x-api-path-slug"=>"mecontactfolderscontactfolderidcontacts-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"contactFolderId", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/users/{id | userPrincipalName}/contactFolders/{contactFolderId}/contacts"=>{"post"=>{"summary"=>"Create Contact", "description"=>"Create Contact Add a contact to the root Contacts folder or to the contacts endpoint of another contact folder.", "operationId"=>"CreateContact", "x-api-path-slug"=>"usersid--userprincipalnamecontactfolderscontactfolderidcontacts-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"path", "name"=>"contactFolderId", "type"=>"string"}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/users/{id}/manager/$ref"=>{"put"=>{"summary"=>"Assign A Manager", "description"=>"Assign a manager Use this API to assign a user's manager.", "operationId"=>"AssignAManager", "x-api-path-slug"=>"usersidmanagerref-put", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer ", "type"=>"string"}, {"in"=>"path", "name"=>"id", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["AssignManager"]}}, "/users/{id | userPrincipalName}/reminderView(startDateTime=startDateTime-value,endDateTime=endDateTime-value)"=>{"get"=>{"summary"=>"User Reminder View", "description"=>"user: reminderView Return a list of calendar reminders within the specified start and end times.", "operationId"=>"User:ReminderView", "x-api-path-slug"=>"usersid--userprincipalnamereminderviewstartdatetimestartdatetimevalueenddatetimeenddatetimevalue-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}, {"in"=>"header", "name"=>"Prefer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Reminder", "View"]}}, "/users/{id | userPrincipalName}/sendMail"=>{"post"=>{"summary"=>"Send Mail", "description"=>"Send mail Send the message specified in the request body. The message is saved in the Sent Items folder by default.", "operationId"=>"SendMail", "x-api-path-slug"=>"usersid--userprincipalnamesendmail-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer "}, {"in"=>"header", "name"=>"Content-Type", "description"=>"application/json"}, {"in"=>"path", "name"=>"id | userPrincipalName", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Send", "Mail"]}}, "/workbook/worksheets"=>{"get"=>{"summary"=>"List Worksheets", "description"=>"List worksheets Retrieve a list of worksheet objects.", "operationId"=>"ListWorksheets", "x-api-path-slug"=>"workbookworksheets-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Worksheets"]}}, "/workbook/tables/$/add"=>{"post"=>{"summary"=>"Create Table", "description"=>"Create Table Use this API to create a new Table.", "operationId"=>"CreateTable", "x-api-path-slug"=>"workbooktablesadd-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}}, "/workbook/worksheets(<id|name>)/Cell(row=<row>,column=<column>)"=>{"get"=>{"summary"=>"Worksheet Cell", "description"=>"Worksheet: Cell Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it's stays within the worksheet grid.", "operationId"=>"Worksheet:Cell", "x-api-path-slug"=>"workbookworksheetsltidnamegtcellrowltrowgtcolumnltcolumngt-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Worksheet", "Cell"]}}, "/workbook/worksheets(<id|name>)/delete"=>{"post"=>{"summary"=>"Worksheet Delete", "description"=>"Worksheet: delete Deletes the worksheet from the workbook.", "operationId"=>"Worksheet:Delete", "x-api-path-slug"=>"workbookworksheetsltidnamegtdelete-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Worksheet"]}}, "/workbook/worksheets(<id|name>)"=>{"get"=>{"summary"=>"Get Worksheet", "description"=>"Get Worksheet Retrieve the properties and relationships of worksheet object.", "operationId"=>"GetWorksheet", "x-api-path-slug"=>"workbookworksheetsltidnamegt-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Worksheet"]}, "patch"=>{"summary"=>"Update Worksheet", "description"=>"Update worksheet Update the properties of worksheet object.", "operationId"=>"UpdateWorksheet", "x-api-path-slug"=>"workbookworksheetsltidnamegt-patch", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Worksheet"]}}, "/workbook/worksheets({id|name})/names"=>{"get"=>{"summary"=>"List Names", "description"=>"List names Retrieve a list of named item associated with the worksheet.", "operationId"=>"ListNames", "x-api-path-slug"=>"workbookworksheetsidnamenames-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer {code}"}, {"in"=>"path", "name"=>"id|name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Names"]}}, "/workbook/worksheets(<id|name>)/tables/$/add"=>{"post"=>{"summary"=>"Create Table", "description"=>"Create Table Use this API to create a new Table.", "operationId"=>"CreateTable", "x-api-path-slug"=>"workbookworksheetsltidnamegttablesadd-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Table"]}}, "/workbook/worksheets(<id|name>)/Range"=>{"post"=>{"summary"=>"Worksheet Range", "description"=>"Worksheet: Range Gets the range object specified by the address or name.", "operationId"=>"Worksheet:Range", "x-api-path-slug"=>"workbookworksheetsltidnamegtrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Worksheet", "Range"]}}, "/workbook/worksheets(<id|name>)/UsedRange"=>{"post"=>{"summary"=>"Worksheet Used Range", "description"=>"Worksheet: UsedRange The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the worksheet is blank, this function will return the top left cell.", "operationId"=>"Worksheet:UsedRange", "x-api-path-slug"=>"workbookworksheetsltidnamegtusedrange-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Worksheet", "Used", "Range"]}}, "/workbook/worksheets/"=>{"post"=>{"summary"=>"Worksheet Collection Add", "description"=>"WorksheetCollection: add Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets. If you wish to activate the newly added worksheet, call \".activate() on it.", "operationId"=>"WorksheetCollection:Add", "x-api-path-slug"=>"workbookworksheets-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Worksheet", "Collection"]}}, "/workbook/worksheets(<id|name>)/protection"=>{"get"=>{"summary"=>"Get Worksheet Protection", "description"=>"Get WorksheetProtection Retrieve the properties and relationships of worksheetprotection object.", "operationId"=>"GetWorksheetProtection", "x-api-path-slug"=>"workbookworksheetsltidnamegtprotection-get", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Worksheet", "Protection"]}}, "/workbook/worksheets(<id|name>)/protection/protect"=>{"post"=>{"summary"=>"Worksheet Protection Protect", "description"=>"WorksheetProtection: protect Protect a worksheet. It throws if the worksheet has been protected.", "operationId"=>"WorksheetProtection:Protect", "x-api-path-slug"=>"workbookworksheetsltidnamegtprotectionprotect-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Worksheet", "Protection", "Protect"]}}, "/workbook/worksheets(<id|name>)/protection/unprotect"=>{"post"=>{"summary"=>"Worksheet Protection Unprotect", "description"=>"WorksheetProtection: unprotect Unprotect a worksheet", "operationId"=>"WorksheetProtection:Unprotect", "x-api-path-slug"=>"workbookworksheetsltidnamegtprotectionunprotect-post", "parameters"=>[{"in"=>"header", "name"=>"Authorization", "description"=>"Bearer"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Worksheet", "Protection", "Unprotect"]}}}}, "apis"=>{"name"=>"Microsoft Graph", "x-slug"=>"microsoft-graph", "description"=>"Microsoft Graph exposes multiple APIs from Office 365 and other Microsoft cloud services through a single endpoint. Microsoft Graph simplifies queries that would otherwise be more complex. You can use Microsoft Graph to: Access data from multiple Microsoft cloud services, including Azure Active Directory, Exchange Online as part of Office 365, SharePoint, OneDrive, OneNote, and Planner.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/microsoft-graph.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,Contacts,Emails,Files,Microsoft,Notes,Profiles,Relative Data,Service API,Stack Network,Tasks,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"microsoft-graph/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Microsoft Graph", "x-api-slug"=>"microsoft-graph", "description"=>"Microsoft Graph exposes multiple APIs from Office 365 and other Microsoft cloud services through a single endpoint. Microsoft Graph simplifies queries that would otherwise be more complex. You can use Microsoft Graph to: Access data from multiple Microsoft cloud services, including Azure Active Directory, Exchange Online as part of Office 365, SharePoint, OneDrive, OneNote, and Planner.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/microsoft-graph.png", "humanURL"=>"https://developer.microsoft.com/en-us/graph/", "baseURL"=>"https://graph.microsoft.com//", "tags"=>"API Provider,Contacts,Emails,Files,Microsoft,Notes,Profiles,Relative Data,Service API,Stack Network,Tasks,Webhook Implementations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/microsoft-graph/workbookworksheetsltidnamegtprotectionunprotect-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/microsoft-graph/microsoft-graph-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-webhook", "url"=>"https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/webhooks"}, {"type"=>"x-change-loge", "url"=>"https://developer.microsoft.com/en-us/graph/docs/overview/changelog"}, {"type"=>"x-documentation", "url"=>"https://developer.microsoft.com/en-us/graph/docs"}, {"type"=>"x-explorer", "url"=>"https://developer.microsoft.com/en-us/graph/graph-explorer"}, {"type"=>"x-getting-started", "url"=>"https://developer.microsoft.com/en-us/graph/docs/get-started/rest"}, {"type"=>"x-github", "url"=>"https://github.com/microsoftgraph"}, {"type"=>"x-sdk", "url"=>"https://developer.microsoft.com/en-us/graph/code-samples-and-sdks"}, {"type"=>"x-website", "url"=>"https://developer.microsoft.com/en-us/graph/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-cloudformation{"aws-cloudformation-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS CloudFormation", "x-complete"=>1, "info"=>{"title"=>"AWS CloudFormation API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=CancelUpdateStack"=>{"get"=>{"summary"=>"Cancel Update Stack", "description"=>"Cancels an update on the specified stack.", "operationId"=>"cancelUpdateStack", "x-api-path-slug"=>"actioncancelupdatestack-get", "parameters"=>[{"in"=>"query", "name"=>"StackName", "description"=>"The name or the unique stack ID that is associated with the stack", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stacks"]}}, "/?Action=ContinueUpdateRollback"=>{"get"=>{"summary"=>"Continue Update Rollback", "description"=>"For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back\n to the UPDATE_ROLLBACK_COMPLETE state.", "operationId"=>"continueUpdateRollback", "x-api-path-slug"=>"actioncontinueupdaterollback-get", "parameters"=>[{"in"=>"query", "name"=>"ResourcesToSkip.member.N", "description"=>"A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation", "type"=>"string"}, {"in"=>"query", "name"=>"RoleARN", "description"=>"The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to roll back the stack", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The name or the unique ID of the stack that you want to continue rolling back", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rollback"]}}, "/?Action=CreateChangeSet"=>{"get"=>{"summary"=>"Create Change Set", "description"=>"Creates a list of changes for a stack.", "operationId"=>"createChangeSet", "x-api-path-slug"=>"actioncreatechangeset-get", "parameters"=>[{"in"=>"query", "name"=>"Capabilities.member.N", "description"=>"A list of values that you must specify before AWS CloudFormation can update certain stacks", "type"=>"string"}, {"in"=>"query", "name"=>"ChangeSetName", "description"=>"The name of the change set", "type"=>"string"}, {"in"=>"query", "name"=>"ChangeSetType", "description"=>"The type of change set operation", "type"=>"string"}, {"in"=>"query", "name"=>"ClientToken", "description"=>"A unique identifier for this CreateChangeSet request", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A description to help you identify this change set", "type"=>"string"}, {"in"=>"query", "name"=>"NotificationARNs.member.N", "description"=>"The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack", "type"=>"string"}, {"in"=>"query", "name"=>"Parameters.member.N", "description"=>"A list of Parameter structures that specify input parameters for the change set", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceTypes.member.N", "description"=>"The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance", "type"=>"string"}, {"in"=>"query", "name"=>"RoleARN", "description"=>"The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The name or the unique ID of the stack for which you are creating a change set", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.member.N", "description"=>"Key-value pairs to associate with this stack", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateBody", "description"=>"A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateURL", "description"=>"The location of the file that contains the revised template", "type"=>"string"}, {"in"=>"query", "name"=>"UsePreviousTemplate", "description"=>"Whether to reuse the template that is associated with the stack to create the change set", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change Sets"]}}, "/?Action=CreateStack"=>{"get"=>{"summary"=>"Create Stack", "description"=>"Creates a stack as specified in the template.", "operationId"=>"createStack", "x-api-path-slug"=>"actioncreatestack-get", "parameters"=>[{"in"=>"query", "name"=>"Capabilities.member.N", "description"=>"A list of values that you must specify before AWS CloudFormation can create certain stacks", "type"=>"string"}, {"in"=>"query", "name"=>"DisableRollback", "description"=>"Set to true to disable rollback of the stack if stack creation failed", "type"=>"string"}, {"in"=>"query", "name"=>"NotificationARNs.member.N", "description"=>"The Simple Notification Service (SNS) topic ARNs to publish stack related events", "type"=>"string"}, {"in"=>"query", "name"=>"OnFailure", "description"=>"Determines what action will be taken if stack creation fails", "type"=>"string"}, {"in"=>"query", "name"=>"Parameters.member.N", "description"=>"A list of Parameter structures that specify input parameters for the stack", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceTypes.member.N", "description"=>"The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance", "type"=>"string"}, {"in"=>"query", "name"=>"RoleARN", "description"=>"The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The name that is associated with the stack", "type"=>"string"}, {"in"=>"query", "name"=>"StackPolicyBody", "description"=>"Structure containing the stack policy body", "type"=>"string"}, {"in"=>"query", "name"=>"StackPolicyURL", "description"=>"Location of a file containing the stack policy", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.member.N", "description"=>"Key-value pairs to associate with this stack", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateBody", "description"=>"Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateURL", "description"=>"Location of file containing the template body", "type"=>"string"}, {"in"=>"query", "name"=>"TimeoutInMinutes", "description"=>"The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stacks"]}}, "/?Action=DeleteChangeSet"=>{"get"=>{"summary"=>"Delete Change Set", "description"=>"Deletes the specified change set.", "operationId"=>"deleteChangeSet", "x-api-path-slug"=>"actiondeletechangeset-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeSetName", "description"=>"The name or Amazon Resource Name (ARN) of the change set that you want to delete", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"If you specified the name of a change set to delete, specify the stack name or ID (ARN) that is associated with it", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change Sets"]}}, "/?Action=DeleteStack"=>{"get"=>{"summary"=>"Delete Stack", "description"=>"Deletes a specified stack.", "operationId"=>"deleteStack", "x-api-path-slug"=>"actiondeletestack-get", "parameters"=>[{"in"=>"query", "name"=>"RetainResources.member.N", "description"=>"For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain", "type"=>"string"}, {"in"=>"query", "name"=>"RoleARN", "description"=>"The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The name or the unique stack ID that is associated with the stack", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stacks"]}}, "/?Action=DescribeAccountLimits"=>{"get"=>{"summary"=>"Describe Account Limits", "description"=>"Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.", "operationId"=>"describeAccountLimits", "x-api-path-slug"=>"actiondescribeaccountlimits-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"A string that identifies the next page of limits that you want to retrieve", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account Limits"]}}, "/?Action=DescribeChangeSet"=>{"get"=>{"summary"=>"Describe Change Set", "description"=>"Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set.", "operationId"=>"describeChangeSet", "x-api-path-slug"=>"actiondescribechangeset-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeSetName", "description"=>"The name or Amazon Resource Name (ARN) of the change set that you want to describe", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change Sets"]}}, "/?Action=DescribeStackEvents"=>{"get"=>{"summary"=>"Describe Stack Events", "description"=>"Returns all stack related events for a specified stack in reverse chronological order.", "operationId"=>"describeStackEvents", "x-api-path-slug"=>"actiondescribestackevents-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"A string that identifies the next page of events that you want to retrieve", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The name or the unique stack ID that is associated with the stack, which are not always interchangeable:", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stack Events"]}}, "/?Action=DescribeStackResource"=>{"get"=>{"summary"=>"Describe Stack Resource", "description"=>"Returns a description of the specified resource in the specified stack.", "operationId"=>"describeStackResource", "x-api-path-slug"=>"actiondescribestackresource-get", "parameters"=>[{"in"=>"query", "name"=>"LogicalResourceId", "description"=>"The logical name of the resource as specified in the template", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The name or the unique stack ID that is associated with the stack, which are not always interchangeable:", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stack Resources"]}}, "/?Action=DescribeStackResources"=>{"get"=>{"summary"=>"Describe Stack Resources", "description"=>"Returns AWS resource descriptions for running and deleted stacks.", "operationId"=>"describeStackResources", "x-api-path-slug"=>"actiondescribestackresources-get", "parameters"=>[{"in"=>"query", "name"=>"LogicalResourceId", "description"=>"The logical name of the resource as specified in the template", "type"=>"string"}, {"in"=>"query", "name"=>"PhysicalResourceId", "description"=>"The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The name or the unique stack ID that is associated with the stack, which are not always interchangeable:", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stack Resources"]}}, "/?Action=DescribeStacks"=>{"get"=>{"summary"=>"Describe Stacks", "description"=>"Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.", "operationId"=>"describeStacks", "x-api-path-slug"=>"actiondescribestacks-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"A string that identifies the next page of stacks that you want to retrieve", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The name or the unique stack ID that is associated with the stack, which are not always interchangeable:", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stacks"]}}, "/?Action=EstimateTemplateCost"=>{"get"=>{"summary"=>"Estimate Template Cost", "description"=>"Returns the estimated monthly cost of a template.", "operationId"=>"estimateTemplateCost", "x-api-path-slug"=>"actionestimatetemplatecost-get", "parameters"=>[{"in"=>"query", "name"=>"Parameters.member.N", "description"=>"A list of Parameter structures that specify input parameters", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateBody", "description"=>"Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateURL", "description"=>"Location of file containing the template body", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Template Cost"]}}, "/?Action=ExecuteChangeSet"=>{"get"=>{"summary"=>"Execute Change Set", "description"=>"Updates a stack using the input information that was provided when the specified change set was created.", "operationId"=>"executeChangeSet", "x-api-path-slug"=>"actionexecutechangeset-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeSetName", "description"=>"The name or ARN of the change set that you want use to update the specified stack", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change Sets"]}}, "/?Action=GetStackPolicy"=>{"get"=>{"summary"=>"Get Stack Policy", "description"=>"Returns the stack policy for a specified stack.", "operationId"=>"getStackPolicy", "x-api-path-slug"=>"actiongetstackpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"StackName", "description"=>"The name or unique stack ID that is associated with the stack whose policy you want to get", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stack Policies"]}}, "/?Action=GetTemplate"=>{"get"=>{"summary"=>"Get Template", "description"=>"Returns the template body for a specified stack.", "operationId"=>"getTemplate", "x-api-path-slug"=>"actiongettemplate-get", "parameters"=>[{"in"=>"query", "name"=>"ChangeSetName", "description"=>"The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The name or the unique stack ID that is associated with the stack, which are not always interchangeable:", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateStage", "description"=>"For templates that include transforms, the stage of the template that AWS CloudFormation returns", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates"]}}, "/?Action=GetTemplateSummary"=>{"get"=>{"summary"=>"Get Template Summary", "description"=>"Returns information about a new or existing template.", "operationId"=>"getTemplateSummary", "x-api-path-slug"=>"actiongettemplatesummary-get", "parameters"=>[{"in"=>"query", "name"=>"StackName", "description"=>"The name or the stack ID that is associated with the stack, which are not always interchangeable", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateBody", "description"=>"Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateURL", "description"=>"Location of file containing the template body", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates"]}}, "/?Action=ListChangeSets"=>{"get"=>{"summary"=>"List Change Sets", "description"=>"Returns the ID and status of each active change set for a stack.", "operationId"=>"listChangeSets", "x-api-path-slug"=>"actionlistchangesets-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Change Sets"]}}, "/?Action=ListExports"=>{"get"=>{"summary"=>"List Exports", "description"=>"Lists all exported output values in the account and region in which you call this action.", "operationId"=>"listExports", "x-api-path-slug"=>"actionlistexports-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"A string (provided by the ListExports response output) that identifies the next page of exported output values that you asked to retrieve", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Exports"]}}, "/?Action=ListImports"=>{"get"=>{"summary"=>"List Imports", "description"=>"Lists all stacks that are importing an exported output value.", "operationId"=>"listImports", "x-api-path-slug"=>"actionlistimports-get", "parameters"=>[{"in"=>"query", "name"=>"ExportName", "description"=>"The name of the exported output value", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Imports"]}}, "/?Action=ListStackResources"=>{"get"=>{"summary"=>"List Stack Resources", "description"=>"Returns descriptions of all resources of the specified stack.", "operationId"=>"listStackResources", "x-api-path-slug"=>"actionliststackresources-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"A string that identifies the next page of stack resources that you want to retrieve", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The name or the unique stack ID that is associated with the stack, which are not always interchangeable:", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stack Resources"]}}, "/?Action=ListStacks"=>{"get"=>{"summary"=>"List Stacks", "description"=>"Returns the summary information for stacks whose status matches the specified StackStatusFilter.", "operationId"=>"listStacks", "x-api-path-slug"=>"actionliststacks-get", "parameters"=>[{"in"=>"query", "name"=>"NextToken", "description"=>"A string that identifies the next page of stacks that you want to retrieve", "type"=>"string"}, {"in"=>"query", "name"=>"StackStatusFilter.member.N", "description"=>"Stack status to use as a filter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stacks"]}}, "/?Action=SetStackPolicy"=>{"get"=>{"summary"=>"Set Stack Policy", "description"=>"Sets a stack policy for a specified stack.", "operationId"=>"setStackPolicy", "x-api-path-slug"=>"actionsetstackpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"StackName", "description"=>"The name or unique stack ID that you want to associate a policy with", "type"=>"string"}, {"in"=>"query", "name"=>"StackPolicyBody", "description"=>"Structure containing the stack policy body", "type"=>"string"}, {"in"=>"query", "name"=>"StackPolicyURL", "description"=>"Location of a file containing the stack policy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stack Policies"]}}, "/?Action=SignalResource"=>{"get"=>{"summary"=>"Signal Resource", "description"=>"Sends a signal to the specified resource with a success or failure status.", "operationId"=>"signalResource", "x-api-path-slug"=>"actionsignalresource-get", "parameters"=>[{"in"=>"query", "name"=>"LogicalResourceId", "description"=>"The logical ID of the resource that you want to signal", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The stack name or unique stack ID that includes the resource that you want to signal", "type"=>"string"}, {"in"=>"query", "name"=>"Status", "description"=>"The status of the signal, which is either success or failure", "type"=>"string"}, {"in"=>"query", "name"=>"UniqueId", "description"=>"A unique ID of the signal", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Signal Resources"]}}, "/?Action=UpdateStack"=>{"get"=>{"summary"=>"Update Stack", "description"=>"Updates a stack as specified in the template.", "operationId"=>"updateStack", "x-api-path-slug"=>"actionupdatestack-get", "parameters"=>[{"in"=>"query", "name"=>"Capabilities.member.N", "description"=>"A list of values that you must specify before AWS CloudFormation can update certain stacks", "type"=>"string"}, {"in"=>"query", "name"=>"NotificationARNs.member.N", "description"=>"Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack", "type"=>"string"}, {"in"=>"query", "name"=>"Parameters.member.N", "description"=>"A list of Parameter structures that specify input parameters for the stack", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceTypes.member.N", "description"=>"The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance", "type"=>"string"}, {"in"=>"query", "name"=>"RoleARN", "description"=>"The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack", "type"=>"string"}, {"in"=>"query", "name"=>"StackName", "description"=>"The name or unique stack ID of the stack to update", "type"=>"string"}, {"in"=>"query", "name"=>"StackPolicyBody", "description"=>"Structure containing a new stack policy body", "type"=>"string"}, {"in"=>"query", "name"=>"StackPolicyDuringUpdateBody", "description"=>"Structure containing the temporary overriding stack policy body", "type"=>"string"}, {"in"=>"query", "name"=>"StackPolicyDuringUpdateURL", "description"=>"Location of a file containing the temporary overriding stack policy", "type"=>"string"}, {"in"=>"query", "name"=>"StackPolicyURL", "description"=>"Location of a file containing the updated stack policy", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.member.N", "description"=>"Key-value pairs to associate with this stack", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateBody", "description"=>"Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateURL", "description"=>"Location of file containing the template body", "type"=>"string"}, {"in"=>"query", "name"=>"UsePreviousTemplate", "description"=>"Reuse the existing template that is associated with the stack that you are updating", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stacks"]}}, "/?Action=ValidateTemplate"=>{"get"=>{"summary"=>"Validate Template", "description"=>"Validates a specified template.", "operationId"=>"validateTemplate", "x-api-path-slug"=>"actionvalidatetemplate-get", "parameters"=>[{"in"=>"query", "name"=>"TemplateBody", "description"=>"Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateURL", "description"=>"Location of file containing the template body", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Templates"]}}}}, "apis"=>{"name"=>"AWS CloudFormation", "x-slug"=>"aws-cloudformation", "description"=>"AWS CloudFormation gives developers and systems administrators an easy way to create and manage a collection of related AWS resources, provisioning and updating them in an orderly and predictable fashion.You can use AWS CloudFormations?sample templates?or create your own templates to describe the AWS resources, and any associated dependencies or runtime parameters, required to run your application. You do not need to figure out the order for provisioning AWS services or the subtleties of making those dependencies work. CloudFormation takes care of this for you. After the AWS resources are deployed, you can modify and update them in a controlled and predictable way, in effect applying version control to your AWS infrastructure the same way you do with your software. You can also visualize your templates as diagrams and edit them using a drag-and-drop interface with the?AWS CloudFormation Designer.You can deploy and update a template and its associated collection of resources (called a stack) by using the AWS Management Console, AWS Command Line Interface, or APIs. CloudFormation is available at no additional charge, and you pay only for the AWS resources needed to run your applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Management-Tools_AWSCloudFormation.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Cloud,Deployments,Management,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-cloudformation/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS CloudFormation API", "x-api-slug"=>"aws-cloudformation-api", "description"=>"AWS CloudFormation gives developers and systems administrators an easy way to create and manage a collection of related AWS resources, provisioning and updating them in an orderly and predictable fashion.You can use AWS CloudFormations?sample templates?or create your own templates to describe the AWS resources, and any associated dependencies or runtime parameters, required to run your application. You do not need to figure out the order for provisioning AWS services or the subtleties of making those dependencies work. CloudFormation takes care of this for you. After the AWS resources are deployed, you can modify and update them in a controlled and predictable way, in effect applying version control to your AWS infrastructure the same way you do with your software. You can also visualize your templates as diagrams and edit them using a drag-and-drop interface with the?AWS CloudFormation Designer.You can deploy and update a template and its associated collection of resources (called a stack) by using the AWS Management Console, AWS Command Line Interface, or APIs. CloudFormation is available at no additional charge, and you pay only for the AWS resources needed to run your applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Management-Tools_AWSCloudFormation.png", "humanURL"=>"https://aws.amazon.com/cloudformation/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Cloud,Deployments,Management,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-cloudformation/aws-cloudformation-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/cli/latest/reference/cloudformation/index.html"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/cloudformation/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/cloudformation/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/cloudformation/pricing/"}, {"type"=>"x-sdk", "url"=>"https://aws.amazon.com/cloudformation/aws-cloudformation-templates/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/cloudformation/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hhs-media-services{"hhs-media-services-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"HHS Media Services", "x-complete"=>1, "info"=>{"title"=>"HHS Media Services", "description"=>"div-classswaggeruiwrap-extrafooterh3common-features--behaviorsh3----div-classfeatures--------ul------------listrong-sort-paramstrong-supports-multi-column-sorting-through-the-use-of-commas-as-delimiters-and-a-hyphen-to-denote-descending-order-----------------br----------------strongspanexamplesspanstrong----------------ul--------------------lispan-classexamplenamespanspan-classdescriptionsort-results-by-name-ascendingspanli--------------------lispan-classexamplenamespanspan-classdescriptionsort-results-by-name-descendingspanli--------------------lispan-classexamplenameidspanspan-classdescriptionsort-results-by-name-descending-and-then-by-id-ascendingspanli--------------------lispan-classexampleiddatecontentauthoredspanspan-classdescriptionsort-results-by-id-ascending-and-then-date-descendingspanli----------------ul------------li------------listrongdate-formatsstrong-date-input-format-is-expected-to-be-based-on-a-hrefhttpwww-ietf-orgrfcrfc3339-txtrfc-3339a--br----------------spanstrongexamplestrongspan----------------ulli20131118t184301zliul------------li--------ul----divdiv", "termsOfService"=>"http://www.hhs.gov/web/socialmedia/policies/tos.html#ready", "version"=>"2"}, "host"=>"api.digitalmedia.hhs.gov", "basePath"=>"/api/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/resources.json"=>{"get"=>{"summary"=>"Get Resources by search query", "description"=>"Returns the list of Resources matching the search query 'q'.The search query 'q' is a Lucene query.The syntax for a Lucene query can be found here.", "operationId"=>"getResources", "x-api-path-slug"=>"resources-json-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"The search query supplied by the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources"]}}, "/resources/campaigns.json"=>{"get"=>{"summary"=>"Get Campaigns", "description"=>"Returns the list of Campaigns.", "operationId"=>"getCampaigns", "x-api-path-slug"=>"resourcescampaigns-json-get", "parameters"=>[{"in"=>"query", "name"=>"max", "description"=>"The maximum number of records to return"}, {"in"=>"query", "name"=>"offset", "description"=>"The offset of the records set to return for pagination"}, {"in"=>"query", "name"=>"sort", "description"=>"* Set of fields to sort the records by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Campaigns"]}}, "/resources/campaigns/{id}.json"=>{"get"=>{"summary"=>"Get Campaign by ID", "description"=>"Returns the Campaign identified by the 'id'.", "operationId"=>"getCampaignById", "x-api-path-slug"=>"resourcescampaignsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the record to look up"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Campaigns", "Id"]}}, "/resources/campaigns/{id}/media.json"=>{"get"=>{"summary"=>"Get MediaItems by Campaign ID", "description"=>"Returns the list of MediaItems for the Campaign identified by the 'id'.", "operationId"=>"getMediaByCampaignId", "x-api-path-slug"=>"resourcescampaignsidmedia-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the campaign to find media items for"}, {"in"=>"query", "name"=>"max", "description"=>"The maximum number of records to return"}, {"in"=>"query", "name"=>"offset", "description"=>"The offset of the records set to return for pagination"}, {"in"=>"query", "name"=>"sort", "description"=>"The name of the property to which sorting will be applied"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Campaigns", "Id", "Media"]}}, "/resources/campaigns/{id}/syndicate.json"=>{"get"=>{"summary"=>"Get MediaItems for Campaign", "description"=>"Renders the list of MediaItems associated with the Campaign identified by the 'id'.", "operationId"=>"renders-the-list-of-mediaitems-associated-with-the-campaign-identified-by-the-id-", "x-api-path-slug"=>"resourcescampaignsidsyndicate-json-get", "parameters"=>[{"in"=>"query", "name"=>"displayMethod", "description"=>"Method used to render an html request"}, {"in"=>"path", "name"=>"id", "description"=>"The id of the record to look up"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Campaigns", "Id", "Syndicate"]}}, "/resources/languages.json"=>{"get"=>{"summary"=>"Get Languages", "description"=>"Returns the list Languages.", "operationId"=>"getLanguages", "x-api-path-slug"=>"resourceslanguages-json-get", "parameters"=>[{"in"=>"query", "name"=>"max", "description"=>"The maximum number of records to return"}, {"in"=>"query", "name"=>"offset", "description"=>"The offset of the records set to return for pagination"}, {"in"=>"query", "name"=>"sort", "description"=>"* Set of fields to sort the records by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Languages"]}}, "/resources/languages/{id}.json"=>{"get"=>{"summary"=>"Get Language by ID", "description"=>"Returns the Language identified by the 'id'.", "operationId"=>"getLanguageById", "x-api-path-slug"=>"resourceslanguagesid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the language to look up"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Languages", "Id"]}}, "/resources/media.json"=>{"get"=>{"summary"=>"Get MediaItems", "description"=>"Returns the list of MediaItems matching the specified query parameters.", "operationId"=>"getMedia", "x-api-path-slug"=>"resourcesmedia-json-get", "parameters"=>[{"in"=>"query", "name"=>"collectionId", "description"=>"Restrict filtering to media items in a specific collection"}, {"in"=>"query", "name"=>"contentAuthoredBeforeDate", "description"=>"Find all media items authored before the provided day (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"contentAuthoredInRange", "description"=>"Find all media items authored between the provided start and end days (RFC 3339, comma separated, time ignored)"}, {"in"=>"query", "name"=>"contentAuthoredSinceDate", "description"=>"Find all media items authored since the provided day (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"contentPublishedBeforeDate", "description"=>"Find all media items published before the provided day (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"contentPublishedInRange", "description"=>"Find all media items published between the provided start and end days (RFC 3339, comma separated, time ignored)"}, {"in"=>"query", "name"=>"contentPublishedSinceDate", "description"=>"Find all media items published since the provided day (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"contentReviewedBeforeDate", "description"=>"Find all media items reviewed before the provided day (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"contentReviewedInRange", "description"=>"Find all media items reviewed between the provided start and end days (RFC 3339, comma separated, time ignored)"}, {"in"=>"query", "name"=>"contentReviewedSinceDate", "description"=>"Find all media items reviewed since the provided day (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"contentUpdatedBeforeDate", "description"=>"Find all media items updated before the provided day (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"contentUpdatedInRange", "description"=>"Find all media items updated between the provided start and end days (RFC 3339, comma separated, time ignored)"}, {"in"=>"query", "name"=>"contentUpdatedSinceDate", "description"=>"Find all media items updated since the provided day (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"createdBy", "description"=>"Find all media items containing the createdBy value"}, {"in"=>"query", "name"=>"customThumbnailUrl", "description"=>"Find all media items which have the provided customThumbnailUrl, case insensitive"}, {"in"=>"query", "name"=>"customThumbnailUrlContains", "description"=>"Find all media items which contain the provided partial customThumbnailUrl, case insensitive"}, {"in"=>"query", "name"=>"dateContentAuthored", "description"=>"Find all media items authored on the provided day (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"dateContentPublished", "description"=>"Find all media items published on the provided day (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"dateContentReviewed", "description"=>"Find all media items reviewed on the provided day (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"dateContentUpdated", "description"=>"Find all media items updated on the provided day (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"dateSyndicationCaptured", "description"=>"Find all media items authored on the provided day (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"dateSyndicationUpdated", "description"=>"Find all media items updated on the provided day, (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"descriptionContains", "description"=>"Find all media items containing the provided partial description, case insensitive"}, {"in"=>"query", "name"=>"hash", "description"=>"Find all media items which match the provided hash, case insensitive"}, {"in"=>"query", "name"=>"hashContains", "description"=>"Find all media items which match the provided partial hash, case insensitive"}, {"in"=>"query", "name"=>"languageId", "description"=>"Find all media items written in the language specified by Id"}, {"in"=>"query", "name"=>"languageIsoCode", "description"=>"Find all media items written in the language specified by 639-2 isoCode , case insensitive"}, {"in"=>"query", "name"=>"languageName", "description"=>"Find all media items written in the language specified by name, case insensitive"}, {"in"=>"query", "name"=>"max", "description"=>"The maximum number of records to return"}, {"in"=>"query", "name"=>"mediaTypes", "description"=>"Find all media items belonging to the specified media type[s]"}, {"in"=>"query", "name"=>"name", "description"=>"Find all media items containing the provided name, case insensitive"}, {"in"=>"query", "name"=>"nameContains", "description"=>"Find all media items containing the partial name, case insensitive"}, {"in"=>"query", "name"=>"offset", "description"=>"The offset of the records set to return for pagination"}, {"in"=>"query", "name"=>"order", "description"=>"* The ascending or descending order"}, {"in"=>"query", "name"=>"restrictToSet", "description"=>"Find only media from within the supplied list of Ids"}, {"in"=>"query", "name"=>"sort", "description"=>"* Set of fields to sort the records by"}, {"in"=>"query", "name"=>"sourceAcronym", "description"=>"Find all media items that belong to the source specified by acronym, case insensitive"}, {"in"=>"query", "name"=>"sourceAcronymContains", "description"=>"Find all media items that belong to the source specified by partial acronym, case insensitive"}, {"in"=>"query", "name"=>"sourceId", "description"=>"Find all media items that belong to the source specified by Id"}, {"in"=>"query", "name"=>"sourceName", "description"=>"Find all media items that belong to the source specified by name, case insensitive"}, {"in"=>"query", "name"=>"sourceNameContains", "description"=>"Find all media items that belong to the source specified by partial name, case insensitive"}, {"in"=>"query", "name"=>"sourceUrl", "description"=>"Find all media items which have the provided sourceUrl, case insensitive"}, {"in"=>"query", "name"=>"sourceUrlContains", "description"=>"Find all media items which contain the provided partial sourceUrl, case insensitive"}, {"in"=>"query", "name"=>"syndicationCapturedBeforeDate", "description"=>"Find all media items authored before the provided day (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"syndicationCapturedInRange", "description"=>"Find all media items authored between the provided start and end days (RFC 3339, comma separated, time ignored)"}, {"in"=>"query", "name"=>"syndicationCapturedSinceDate", "description"=>"Find all media items authored since the provided day (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"syndicationUpdatedBeforeDate", "description"=>"Find all media items updated before the provided day, (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"syndicationUpdatedInRange", "description"=>"Find all media items updated between the provided start and end days, (RFC 3339, comma separated, time ignored)"}, {"in"=>"query", "name"=>"syndicationUpdatedSinceDate", "description"=>"Find all media items updated since the provided day, (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"syndicationVisibleBeforeDate", "description"=>"Find all media items visible before the provided day, (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"syndicationVisibleInRange", "description"=>"Find all media items visible between the provided start and end days, (RFC 3339, comma separated, time ignored)"}, {"in"=>"query", "name"=>"syndicationVisibleSinceDate", "description"=>"Find all media items visible since the provided day, (RFC 3339, time ignored)"}, {"in"=>"query", "name"=>"tagIds", "description"=>"Find only media items tagged with the specified tag Ids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Media"]}}, "/resources/media/featured.json"=>{"get"=>{"summary"=>"Get the list of featured content in the syndication system", "description"=>"Get the list of featured content in the syndication system", "operationId"=>"getFeaturedMedia", "x-api-path-slug"=>"resourcesmediafeatured-json-get", "parameters"=>[{"in"=>"query", "name"=>"max", "description"=>"The maximum number of records to return"}, {"in"=>"query", "name"=>"offset", "description"=>"How many records to offset the query by"}, {"in"=>"query", "name"=>"sort", "description"=>"* Set of fields to sort the records by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Media", "Featured"]}}, "/resources/media/mostPopularMedia.json"=>{"get"=>{"summary"=>"Get MediaItems by popularity", "description"=>"Returns the list of MediaItems with the highest ratings.", "operationId"=>"getMostPopularMedia", "x-api-path-slug"=>"resourcesmediamostpopularmedia-json-get", "parameters"=>[{"in"=>"query", "name"=>"max", "description"=>"The maximum number of records to return"}, {"in"=>"query", "name"=>"offset", "description"=>"The offset of the records set to return for pagination"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Media", "MostPopularMedia"]}}, "/resources/media/searchResults.json"=>{"get"=>{"summary"=>"Get MediaItems by search query", "description"=>"Returns the list of MediaItems matching the search query 'q'.The search query 'q' is a Lucene query.The syntax for a Lucene query can be found here", "operationId"=>"searchMedia", "x-api-path-slug"=>"resourcesmediasearchresults-json-get", "parameters"=>[{"in"=>"query", "name"=>"max", "description"=>"The maximum number of records to return"}, {"in"=>"query", "name"=>"offset", "description"=>"The offset of the records set to return for pagination"}, {"in"=>"query", "name"=>"q", "description"=>"The search query supplied by the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Media", "SearchResults"]}}, "/resources/media/{id}.json"=>{"get"=>{"summary"=>"Get MediaItem by ID", "description"=>"Returns the MediaItem identified by the 'id'.", "operationId"=>"getMediaById", "x-api-path-slug"=>"resourcesmediaid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the record to look up"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Media", "Id"]}}, "/resources/media/{id}/content"=>{"get"=>{"summary"=>"Get content for MediaItem", "description"=>"Returns the raw content (html, image, etc...) for the MediaItem identified by the 'id'.", "operationId"=>"getMediaContentById", "x-api-path-slug"=>"resourcesmediaidcontent-get", "parameters"=>[{"in"=>"query", "name"=>"calledByBuild", "description"=>"The method that called this method"}, {"in"=>"path", "name"=>"id", "description"=>"The id of the media to show content for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Media", "Id", "Content"]}}, "/resources/media/{id}/embed.json"=>{"get"=>{"summary"=>"Get embed code for MediaItem", "description"=>"Returns the javascript or iframe embed code for the MediaItem identified by 'id'.", "operationId"=>"getMediaEmbedById", "x-api-path-slug"=>"resourcesmediaidembed-json-get", "parameters"=>[{"in"=>"query", "name"=>"displayMethod", "description"=>"Method used to render an html request"}, {"in"=>"query", "name"=>"divId", "description"=>"Should the div to insert content into have a specific name?"}, {"in"=>"query", "name"=>"excludeDiv", "description"=>"Should the div to insert content into be omitted?"}, {"in"=>"query", "name"=>"excludeJquery", "description"=>"Should a reference to the JQuery Library be omitted?"}, {"in"=>"query", "name"=>"flavor", "description"=>"Currently supports iframe, defaults to javascript"}, {"in"=>"query", "name"=>"height", "description"=>"The height of the generated iframe"}, {"in"=>"path", "name"=>"id", "description"=>"The id of the media to get embed code for"}, {"in"=>"query", "name"=>"iframeName", "description"=>"The name of the iframe element"}, {"in"=>"query", "name"=>"width", "description"=>"The width of the generated iframe"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Media", "Id", "Embed"]}}, "/resources/media/{id}/preview.jpg"=>{"get"=>{"summary"=>"Get JPG preview for MediaItem", "description"=>"Returns the JPG preview, where applicable, for the MediaItem identified by the 'id'.", "operationId"=>"getMediaPreviewById", "x-api-path-slug"=>"resourcesmediaidpreview-jpg-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the media to get a preview for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Media", "Id", "Preview", "Jpg"]}}, "/resources/media/{id}/ratings.json"=>{"get"=>{"summary"=>"Get Ratings for MediaItem", "description"=>"Get the Ratings (number of 'likes') for the MediaItem identified by the 'id'.", "operationId"=>"getMediaRatingsById", "x-api-path-slug"=>"resourcesmediaidratings-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the media item to like"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Media", "Id", "Ratings"]}}, "/resources/media/{id}/relatedMedia.json"=>{"get"=>{"summary"=>"Get related MediaItems by ID", "description"=>"Returns the list of MediaItems related to the MediaItem identified by the 'id'.", "operationId"=>"getRelatedMediaById", "x-api-path-slug"=>"resourcesmediaidrelatedmedia-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the media item to get related media for"}, {"in"=>"query", "name"=>"max", "description"=>"The maximum number of records to return"}, {"in"=>"query", "name"=>"offset", "description"=>"The offset of the records set to return for pagination"}, {"in"=>"query", "name"=>"sort", "description"=>"Which field to sort the records by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Media", "Id", "RelatedMedia"]}}, "/resources/media/{id}/syndicate.json"=>{"get"=>{"summary"=>"Get syndicated content for MediaItem", "description"=>"Returns the syndicated content for a given MediaItem in the specified 'format' (HTML or JSON).", "operationId"=>"getMediaSyndicateById", "x-api-path-slug"=>"resourcesmediaidsyndicate-json-get", "parameters"=>[{"in"=>"query", "name"=>"autoplay", "description"=>"If content is a video, the embeded video will auto play when loaded"}, {"in"=>"query", "name"=>"cssClass", "description"=>"The css class to target for extraction"}, {"in"=>"query", "name"=>"font-size", "description"=>"Set font size (in points) of p, div, and span tags"}, {"in"=>"path", "name"=>"id", "description"=>"The id of the media to show embed code for"}, {"in"=>"query", "name"=>"imageFloat", "description"=>"Accepts valid CSS float options, such as left or right"}, {"in"=>"query", "name"=>"imageMargin", "description"=>"Accepts 4 CSV values representing pixel sizes of margin similar to CSS"}, {"in"=>"query", "name"=>"rel", "description"=>"If content is a video, related items will be shown at the end of playback"}, {"in"=>"query", "name"=>"stripBreaks", "description"=>"Remove break tags from content"}, {"in"=>"query", "name"=>"stripClasses", "description"=>"Remove class attributes from content (except syndicate)"}, {"in"=>"query", "name"=>"stripImages", "description"=>"Remove image tags from content"}, {"in"=>"query", "name"=>"stripScripts", "description"=>"Remove script tags from content"}, {"in"=>"query", "name"=>"stripStyles", "description"=>"Remove in-line styles from content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Media", "Id", "Syndicate"]}}, "/resources/media/{id}/thumbnail.jpg"=>{"get"=>{"summary"=>"Get JPG thumbnail for MediaItem", "description"=>"Returns the JPG thumbnail, where applicable, for the MediaItem identified by the 'id'.", "operationId"=>"getMediaThumbnailById", "x-api-path-slug"=>"resourcesmediaidthumbnail-jpg-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the media to get a thumbnail for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Media", "Id", "Thumbnail", "Jpg"]}}, "/resources/media/{id}/youtubeMetaData.json"=>{"get"=>{"summary"=>"Get Youtube metadata for MediaItem", "description"=>"Returns the Youtube metadata, where applicable, for the MediaItem identified by the 'id'.", "operationId"=>"getMediaYoutubeMetaDataById", "x-api-path-slug"=>"resourcesmediaidyoutubemetadata-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the video to show meta data for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Media", "Id", "YoutubeMetaData"]}}, "/resources/mediaTypes.json"=>{"get"=>{"summary"=>"Get MediaTypes", "description"=>"Returns the list of available MediaTypes.", "operationId"=>"getMediaTypes", "x-api-path-slug"=>"resourcesmediatypes-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "MediaTypes"]}}, "/resources/sources.json"=>{"get"=>{"summary"=>"Get Sources", "description"=>"Returns the list of Sources.", "operationId"=>"getSources", "x-api-path-slug"=>"resourcessources-json-get", "parameters"=>[{"in"=>"query", "name"=>"max", "description"=>"The maximum number of records to return"}, {"in"=>"query", "name"=>"offset", "description"=>"The offset of the records set to return for pagination"}, {"in"=>"query", "name"=>"sort", "description"=>"* Set of fields to sort the records by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Sources"]}}, "/resources/sources/{id}.json"=>{"get"=>{"summary"=>"Get Source by ID", "description"=>"Returns the Source identified by the 'id'.", "operationId"=>"getSourceById", "x-api-path-slug"=>"resourcessourcesid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the source to look up"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Sources", "Id"]}}, "/resources/sources/{id}/syndicate.json"=>{"get"=>{"summary"=>"Get MediaItems for Source", "description"=>"Renders the list of MediaItems associated with the Source identified by the 'id'.", "operationId"=>"renders-the-list-of-mediaitems-associated-with-the-source-identified-by-the-id-", "x-api-path-slug"=>"resourcessourcesidsyndicate-json-get", "parameters"=>[{"in"=>"query", "name"=>"displayMethod", "description"=>"Method used to render an html request"}, {"in"=>"path", "name"=>"id", "description"=>"The id of the record to look up"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Sources", "Id", "Syndicate"]}}, "/resources/tags.json"=>{"get"=>{"summary"=>"Get Tags", "description"=>"Returns the list of Tags matching the specified query parameters in the specified 'format'.", "operationId"=>"getTags", "x-api-path-slug"=>"resourcestags-json-get", "parameters"=>[{"in"=>"query", "name"=>"max", "description"=>"The maximum number of records to return"}, {"in"=>"query", "name"=>"mediaId", "description"=>"Return tags associated with the supplied media id"}, {"in"=>"query", "name"=>"name", "description"=>"Return tags[s] matching the supplied name"}, {"in"=>"query", "name"=>"nameContains", "description"=>"Return tags which contain the supplied partial name"}, {"in"=>"query", "name"=>"offset", "description"=>"Return records starting at the offset index"}, {"in"=>"query", "name"=>"sort", "description"=>"The name of the property to which sorting will be applied"}, {"in"=>"query", "name"=>"typeId", "description"=>"Return tags belonging to the supplied tag type id"}, {"in"=>"query", "name"=>"typeName", "description"=>"Return tags belonging to the supplied tag type name"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Tags"]}}, "/resources/tags/tagLanguages.json"=>{"get"=>{"summary"=>"Get TagLanguages", "description"=>"Returns the list of TagLanguages", "operationId"=>"getTagLanguages", "x-api-path-slug"=>"resourcestagstaglanguages-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Tags", "TagLanguages"]}}, "/resources/tags/tagTypes.json"=>{"get"=>{"summary"=>"Get TagTypes", "description"=>"Returns the list of TagTypes", "operationId"=>"getTagTypes", "x-api-path-slug"=>"resourcestagstagtypes-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Tags", "TagTypes"]}}, "/resources/tags/{id}.json"=>{"get"=>{"summary"=>"Get Tag by ID", "description"=>"Returns the Tag identified by the 'id' in the specified 'format'.", "operationId"=>"getTagById", "x-api-path-slug"=>"resourcestagsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the record to look up"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Tags", "Id"]}}, "/resources/tags/{id}/media.json"=>{"get"=>{"summary"=>"Get MediaItems for Tag", "description"=>"Returns the list of MediaItems associated with the Tag identified by the 'id'.", "operationId"=>"getMediaByTagId", "x-api-path-slug"=>"resourcestagsidmedia-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the record to look up"}, {"in"=>"query", "name"=>"max", "description"=>"The maximum number of records to return"}, {"in"=>"query", "name"=>"offset", "description"=>"The offset of the records set to return for pagination"}, {"in"=>"query", "name"=>"sort", "description"=>"The name of the property to which sorting will be applied"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Tags", "Id", "Media"]}}, "/resources/tags/{id}/related.json"=>{"get"=>{"summary"=>"Get related Tags by ID", "description"=>"Returns the list of Tags related to the Tag identified by the 'id' in the specified format.", "operationId"=>"getRelatedTagsById", "x-api-path-slug"=>"resourcestagsidrelated-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the tag to look up"}, {"in"=>"query", "name"=>"max", "description"=>"The maximum number of records to return"}, {"in"=>"query", "name"=>"offset", "description"=>"The offset of the records set to return for pagination"}, {"in"=>"query", "name"=>"sort", "description"=>"The name of the property to which sorting will be applied"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Tags", "Id", "Related"]}}, "/resources/tags/{id}/syndicate.json"=>{"get"=>{"summary"=>"Get MediaItems for Tag", "description"=>"Renders the list of MediaItems associated with the Tag identified by the 'id'.", "operationId"=>"renders-the-list-of-mediaitems-associated-with-the-tag-identified-by-the-id-", "x-api-path-slug"=>"resourcestagsidsyndicate-json-get", "parameters"=>[{"in"=>"query", "name"=>"displayMethod", "description"=>"Method used to render an html request"}, {"in"=>"path", "name"=>"id", "description"=>"The id of the record to look up"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Tags", "Id", "Syndicate"]}}, "/resources/userMediaLists/{id}.json"=>{"get"=>{"summary"=>"Get UserMediaList by ID", "description"=>"Get a specific user media list by 'id'.", "operationId"=>"getUserMediaList", "x-api-path-slug"=>"resourcesusermedialistsid-json-get", "parameters"=>[{"in"=>"query", "name"=>"displayMethod", "description"=>"Method used to render an html request"}, {"in"=>"path", "name"=>"id", "description"=>"The id of the record to look up"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "UserMediaLists", "Id"]}}}}, "apis"=>{"name"=>"HHS Media Services", "x-slug"=>"hhs-media-services", "description"=>"Use this API platform to create sites with text and multimedia content for syndication. CDC, FDA, HHS, and NIH have built syndication sites using this platform, which is available in Java and .NET.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/hhs-media-services.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"API Provider,Media,Profiles,Videos", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"hhs-media-services/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"HHS Media Services", "x-api-slug"=>"hhs-media-services", "description"=>"Use this API platform to create sites with text and multimedia content for syndication. CDC, FDA, HHS, and NIH have built syndication sites using this platform, which is available in Java and .NET.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/hhs-media-services.png", "humanURL"=>"https://api.digitalmedia.hhs.gov/", "baseURL"=>"https://api.digitalmedia.hhs.gov//api/v2", "tags"=>"API Provider,Media,Profiles,Videos", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/hhs-media-services/resourcesusermedialistsid-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/hhs-media-services/hhs-media-services-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://api.digitalmedia.hhs.gov/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
iex{"iex-trading-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"IEX", "x-complete"=>1, "info"=>{"title"=>"IEX", "description"=>"the-iex-api-is-a-set-of-services-designed-for-developers-and-engineers--it-can-be-used-to-build-highquality-apps-and-services--were-always-working-to-improve-the-iex-api--please-check-back-for-enhancements-and-improvements-", "termsOfService"=>"https://iextrading.com/api-terms/", "version"=>"1.0.0"}, "host"=>"api.iextrading.com", "basePath"=>"/1.0", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/stock/market/batch"=>{"get"=>{"summary"=>"Batch Requests", "description"=>"Returns batch stock quotes.", "operationId"=>"batch-requests", "x-api-path-slug"=>"stockmarketbatch-get", "parameters"=>[nil, {"in"=>"query", "name"=>"range", "description"=>"Optional Used to specify a chart range if chart is used in types parameter"}, {"in"=>"query", "name"=>"symbols", "description"=>"Optional Comma delimited list of symbols limited to 100"}, {"in"=>"query", "name"=>"types", "description"=>"Required Comma delimited list of endpoints to call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Quotes", "Batch"]}}, "/stock/{symbol}/delayed-quote"=>{"get"=>{"summary"=>"Delayed Quote", "description"=>"This returns the 15 minute delayed market quote.", "operationId"=>"delayed-quote", "x-api-path-slug"=>"stocksymboldelayedquote-get", "parameters"=>[{"in"=>"path", "name"=>"symbol", "description"=>"Stock ticker symbol", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Quotes"]}}, "/stock/{symbol}/earnings"=>{"get"=>{"summary"=>"Earnings", "description"=>"Pulls data from the four most recent reported quarters.", "operationId"=>"earnings", "x-api-path-slug"=>"stocksymbolearnings-get", "parameters"=>[{"in"=>"path", "name"=>"symbol", "description"=>"Stock ticker symbol", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Earnings"]}}, "/stock/{symbol}/financials"=>{"get"=>{"summary"=>"Financials", "description"=>"Pulls income statement, balance sheet, and cash flow data from the four most recent reported quarters.", "operationId"=>"financials", "x-api-path-slug"=>"stocksymbolfinancials-get", "parameters"=>[{"in"=>"path", "name"=>"symbol", "description"=>"Stock ticker symbol", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Financials"]}}, "/stock/{symbol}/short-interest"=>{"get"=>{"summary"=>"Short Interest List", "description"=>"Refer to the Short Interest specification for further details", "operationId"=>"iex-short-interest-list", "x-api-path-slug"=>"stocksymbolshortinterest-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Parameter is optional Value can be csv or psv When parameter is not present, format defaults to JSON"}, {"in"=>"path", "name"=>"symbol", "description"=>"Stock ticker symbol", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"Parameter is optional Value is the API token from your IEX user account If you have been permissioned for CUSIP information you’ll receive a CUSIP field, othewise data defaults to exclude CUSIP"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Short Interest"]}}, "/stock/{symbol}/list"=>{"get"=>{"summary"=>"List", "description"=>"Refer to the quote section.", "operationId"=>"list", "x-api-path-slug"=>"stocksymbollist-get", "parameters"=>[{"in"=>"query", "name"=>"displayPercent", "description"=>"Optional If set to true, all percentage values will be multiplied by a factor of 100 (Ex: /stock/aapl/quote?displayPercent=true)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Quotes"]}}, "/stock/{symbol}/news/last/{range}"=>{"get"=>{"summary"=>"News", "description"=>"The above example will return JSON with the following keys", "operationId"=>"news", "x-api-path-slug"=>"stocksymbolnewslastrange-get", "parameters"=>[{"in"=>"path", "name"=>"range", "description"=>"The date range", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"symbol", "description"=>"Stock ticker symbol", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Financial News"]}}, "/stock/{symbol}/previous"=>{"get"=>{"summary"=>"Previous", "description"=>"This returns previous day adjusted price data for a single stock, or an object keyed by symbol of price data for the whole market.", "operationId"=>"previous", "x-api-path-slug"=>"stocksymbolprevious-get", "parameters"=>[{"in"=>"path", "name"=>"symbol", "description"=>"Stock ticker symbol", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Quotes", "Adjustments"]}}, "/stock/{symbol}/quote"=>{"get"=>{"summary"=>"Quote", "description"=>"Pulls a stock quote using any ticker symbol.", "operationId"=>"quote", "x-api-path-slug"=>"stocksymbolquote-get", "parameters"=>[{"in"=>"query", "name"=>"displayPercent", "description"=>"Optional If set to true, all percentage values will be multiplied by a factor of 100 (Ex: /stock/aapl/quote?displayPercent=true)"}, {"in"=>"path", "name"=>"symbol", "description"=>"Stock ticker symbol", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Quotes"]}}, "/stock/{symbol}/splits/{range}"=>{"get"=>{"summary"=>"Splits", "description"=>"Returns stock splits for any date range using ticker symbol.", "operationId"=>"splits", "x-api-path-slug"=>"stocksymbolsplitsrange-get", "parameters"=>[{"in"=>"path", "name"=>"range", "description"=>"The date range", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"symbol", "description"=>"Stock ticker symbol", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Quotes", "Splits"]}}, "/ref-data/daily-list/symbol-directory"=>{"get"=>{"summary"=>"Corporate Actions", "description"=>"Refer to the Daily list specification for futher details.", "operationId"=>"iex-corporate-actions", "x-api-path-slug"=>"refdatadailylistsymboldirectory-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Parameter is optional Value can be csv or psv When parameter is not present, format defaults to JSON"}, {"in"=>"query", "name"=>"token", "description"=>"Parameter is optional Value is the API token from your IEX user account If you have been permissioned for CUSIP information you’ll receive a CUSIP field, othewise data defaults to exclude CUSIP"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Daily List"]}}, "/ref-data/daily-list/next-day-ex-date"=>{"get"=>{"summary"=>"Next Day Ex Date", "description"=>"Refer to the Daily list specification for futher details.", "operationId"=>"iex-next-day-ex-date", "x-api-path-slug"=>"refdatadailylistnextdayexdate-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Parameter is optional Value can be csv or psv When parameter is not present, format defaults to JSON"}, {"in"=>"query", "name"=>"token", "description"=>"Parameter is optional Value is the API token from your IEX user account If you have been permissioned for CUSIP information you’ll receive a CUSIP field, othewise data defaults to exclude CUSIP"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Daily List"]}}, "/tops"=>{"get"=>{"summary"=>"TOPS", "description"=>"Our eligible symbol reference is updated daily. Use these symbols as values in your symbols parameter.", "operationId"=>"tops", "x-api-path-slug"=>"tops-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Parameter is optional Value can only be csv When parameter is not present, format defaults to JSON"}, {"in"=>"query", "name"=>"symbols", "description"=>"Parameter is optional Value needs to be a comma-separated list of symbols (i"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Tops"]}}, "/hist"=>{"get"=>{"summary"=>"HIST", "description"=>"HIST will provide the output of IEX data products for download on a T+1 basis. Data will remain available for the trailing twelve months.", "operationId"=>"hist", "x-api-path-slug"=>"hist-get", "parameters"=>[{"in"=>"query", "name"=>"date", "description"=>"Parameter is optional Value needs to be in four-digit year, two-digit month, two-digit day format (YYYYMMDD) (i"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical"]}}, "/deep/book"=>{"get"=>{"summary"=>"Book", "description"=>"Subscribe to the book channel.", "operationId"=>"book", "x-api-path-slug"=>"deepbook-get", "parameters"=>[{"in"=>"query", "name"=>"symbols", "description"=>"Parameter is required Value needs to be a comma-separated list of symbols (i"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Book"]}}, "/deep/system-event"=>{"get"=>{"summary"=>"System Event", "description"=>"Subscribe to the systemevent channel.", "operationId"=>"system-event", "x-api-path-slug"=>"deepsystemevent-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "System Event"]}}, "/deep/op-halt-status"=>{"get"=>{"summary"=>"Operational Halt Status", "description"=>"Subscribe to the ophaltstatus channel.", "operationId"=>"operational-halt-status", "x-api-path-slug"=>"deepophaltstatus-get", "parameters"=>[{"in"=>"query", "name"=>"symbols", "description"=>"Parameter is required Value needs to be a comma-separated list of symbols (i"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Halt Status"]}}, "/deep/security-event"=>{"get"=>{"summary"=>"Security Event", "description"=>"Subscribe to the securityevent channel.", "operationId"=>"security-event", "x-api-path-slug"=>"deepsecurityevent-get", "parameters"=>[{"in"=>"query", "name"=>"symbols", "description"=>"Parameter is required Value needs to be a comma-separated list of symbols (i"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Security Event"]}}, "/deep/auction"=>{"get"=>{"summary"=>"Auction", "description"=>"For an example of an app that’s using stats, see our IEX mobile app.", "operationId"=>"auction", "x-api-path-slug"=>"deepauction-get", "parameters"=>[{"in"=>"query", "name"=>"symbols", "description"=>"Parameter is required Value needs to be a comma-separated list of symbols (i"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Auctions"]}}, "/stats/recent"=>{"get"=>{"summary"=>"Recent", "description"=>"This call will return a minimum of the last five trading days up to all trading days of the current month.", "operationId"=>"recent", "x-api-path-slug"=>"statsrecent-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Statistics"]}}, "/stats/historical"=>{"get"=>{"summary"=>"Historical Summary", "description"=>"See our stats page for a reference of the keys.", "operationId"=>"historical-summary", "x-api-path-slug"=>"statshistorical-get", "parameters"=>[{"in"=>"query", "name"=>"date", "description"=>"Parameter is optional Value needs to be in four-digit year, two-digit month format (YYYYMM) (i"}, {"in"=>"query", "name"=>"format", "description"=>"Parameter is optional Value can only be csv When parameter is not present, format defaults to JSON"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical"]}}, "/market"=>{"get"=>{"summary"=>"Market", "description"=>"This endpoint returns near real time traded volume on the markets. Market data is captured by the IEX system from approximately 7:45 a.m. to 5:15 p.m. ET.", "operationId"=>"market", "x-api-path-slug"=>"market-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"Parameter is optional Value can only be csv When parameter is not present, format defaults to JSON"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Markets"]}}}}, "apis"=>{"name"=>"IEX", "x-slug"=>"iex", "description"=>"IEX, the Investors Exchange, is a fair, simple and transparent stock exchange dedicated to investor and issuer protection.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28093-iex.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"166667", "tags"=>"API Provider,Data Provider,Financial Services,General Data,Historical Data API,Market Data,Marketplace,Pedestal,Profiles,Relative Data,Relative StreamRank,Service API,Streams,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"iex/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"IEX Trading API", "x-api-slug"=>"iex-trading-api", "description"=>"IEX, the Investors Exchange, is a fair, simple and transparent stock exchange dedicated to investor and issuer protection.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28093-iex.jpg", "humanURL"=>"https://iextrading.com", "baseURL"=>"https://api.iextrading.com//1.0", "tags"=>"API Provider,Data Provider,Financial Services,General Data,Historical Data API,Market Data,Marketplace,Pedestal,Profiles,Relative Data,Relative StreamRank,Service API,Streams,Streams,Streams", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/iex/iex-trading-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://iextrading.com/developer/docs/#authentication"}, {"type"=>"x-blog", "url"=>"https://medium.com/boxes-and-lines"}, {"type"=>"x-blog-rss", "url"=>"view-source:https://medium.com/feed/boxes-and-lines"}, {"type"=>"x-branding", "url"=>"https://iextrading.com/brand/"}, {"type"=>"x-change-log", "url"=>"https://iextrading.com/developer/docs/#changelog"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/iex"}, {"type"=>"x-developer", "url"=>"https://iextrading.com/developer/docs/"}, {"type"=>"x-email", "url"=>"sales@iextrading.com"}, {"type"=>"x-email", "url"=>"listings@iextrading.com"}, {"type"=>"x-email", "url"=>"marketops@iextrading.com"}, {"type"=>"x-email", "url"=>"sre@iextrading.com"}, {"type"=>"x-email", "url"=>"marcomms@iextrading.com"}, {"type"=>"x-email", "url"=>"info@iextrading.com"}, {"type"=>"x-email", "url"=>"api@iextrading.com"}, {"type"=>"x-email", "url"=>"legal@iextrading.com"}, {"type"=>"x-email", "url"=>"ventures@iextrading.com"}, {"type"=>"x-faq", "url"=>"https://iextrading.com/faq/"}, {"type"=>"x-github", "url"=>"https://github.com/iexg"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/iex-group-inc-"}, {"type"=>"x-press", "url"=>"https://iextrading.com/about/press/"}, {"type"=>"x-road-map", "url"=>"https://iextrading.com/developer/docs/#roadmap"}, {"type"=>"x-terms-of-service", "url"=>"https://iextrading.com/developer/docs/#terms"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/IEX"}, {"type"=>"x-website", "url"=>"https://iextrading.com"}, {"type"=>"x-websockets", "url"=>"https://iextrading.com/developer/docs/#websockets"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hewlett-packard-enterprise{"hpe-onesphere-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Hewlett Packard Enterprise", "x-complete"=>1, "info"=>{"title"=>"HPE OneSphere API", "description"=>"hpe-onesphere-hybrid-cloud-management-rest-api-for-calls-requiring-authentication-use-restsession-to-get-a-token-", "termsOfService"=>"http://www.hpe.com/onesphere", "contact"=>{"name"=>"HPE OneSphere API team", "url"=>"http://www.hpe.com/onesphere"}, "version"=>"1.0.0"}, "host"=>"deic02-hpe.hpeonesphere.com", "basePath"=>"/rest", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/about/versions"=>{"get"=>{"summary"=>"Get About Versions", "description"=>"Get supported versions", "operationId"=>"GetVersions", "x-api-path-slug"=>"aboutversions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["About", "Versions"]}}, "/account"=>{"get"=>{"summary"=>"Get Account", "description"=>"Returns the global account information. **Not implemented**", "operationId"=>"GetAccount", "x-api-path-slug"=>"account-get", "parameters"=>[{"in"=>"query", "name"=>"view", "description"=>"Whether to return related content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/appliances"=>{"get"=>{"summary"=>"Get Appliances", "description"=>"Returns appliances.", "operationId"=>"GetAppliance", "x-api-path-slug"=>"appliances-get", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"The name of the desired appliance"}, {"in"=>"query", "name"=>"regionUri", "description"=>"Set of appliances in this region"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appliances"]}, "post"=>{"summary"=>"Post Appliances", "description"=>"Create an appliance.", "operationId"=>"CreateAppliance", "x-api-path-slug"=>"appliances-post", "parameters"=>[{"in"=>"body", "name"=>"appliance", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appliances"]}}, "/appliances/{id}"=>{"delete"=>{"summary"=>"Delete Appliances", "description"=>"Delete an appliance.\nThis removes the appliance registration and tears down the secure\ncomms link to the on-premise appliance.\nIf zones exist on this appliance, an '409' error will be returned.\nThe zones on this appliance must be removed before the appliance\ndelete request can be accepted.", "operationId"=>"DeleteAppliance", "x-api-path-slug"=>"appliancesid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the appliance to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appliances"]}, "get"=>{"summary"=>"Get Appliances", "description"=>"Returns an appliance based on its ID.", "operationId"=>"GetApplianceById", "x-api-path-slug"=>"appliancesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the appliance to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appliances"]}, "patch"=>{"summary"=>"Patch Appliances", "description"=>"Update properties of an appliance.", "operationId"=>"UpdateAppliance", "x-api-path-slug"=>"appliancesid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"List of appliance updates", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of appliance to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Appliances"]}}, "/billing-accounts"=>{"get"=>{"summary"=>"Get Billing Accounts", "description"=>"Returns billing accounts. It requires the **administrator** or **project creator** global role.", "operationId"=>"FindBillingAccounts", "x-api-path-slug"=>"billingaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"Filters the billing accounts returned"}, {"in"=>"query", "name"=>"view", "description"=>"Whether to return related content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Billing", "Accounts"]}, "post"=>{"summary"=>"Post Billing Accounts", "description"=>"Creates a new billing account. It requires the **administrator** role.", "operationId"=>"CreateBillingAccount", "x-api-path-slug"=>"billingaccounts-post", "parameters"=>[{"in"=>"body", "name"=>"billing-account", "description"=>"Add new billing account", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Billing", "Accounts"]}}, "/billing-accounts/{id}"=>{"delete"=>{"summary"=>"Delete Billing Accounts", "description"=>"Deletes a billing account. It requires the **administrator** role.", "operationId"=>"DeleteBillingAccountById", "x-api-path-slug"=>"billingaccountsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of billing account to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Billing", "Accounts"]}, "get"=>{"summary"=>"Get Billing Accounts", "description"=>"Returns a billing account based on its id. It requires the **administrator** or **project creator** global role. Credentials are not included.", "operationId"=>"GetBillingAccountById", "x-api-path-slug"=>"billingaccountsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of billing account to fetch"}, {"in"=>"query", "name"=>"view", "description"=>"Whether to return related content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Billing", "Accounts"]}, "patch"=>{"summary"=>"Patch Billing Accounts", "description"=>"Updates a billing account. It requires the **administrator** role.", "operationId"=>"UpdateBillingAccount", "x-api-path-slug"=>"billingaccountsid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"The JSON patch to apply to the billing account", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of billing account to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Billing", "Accounts"]}}, "/catalog-types"=>{"get"=>{"summary"=>"Get Catalog Types", "description"=>"Returns catalog types.", "operationId"=>"FindCatalogTypes", "x-api-path-slug"=>"catalogtypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalog", "Types"]}}, "/catalogs"=>{"get"=>{"summary"=>"Get Catalogs", "description"=>"Returns catalogs. It requires the **consumer** global role.", "operationId"=>"FindCatalogs", "x-api-path-slug"=>"catalogs-get", "parameters"=>[{"in"=>"query", "name"=>"userQuery", "description"=>"Filters the catalogs returned"}, {"in"=>"query", "name"=>"view", "description"=>"Return related resources: * `full` - Whether to return related content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalogs"]}, "post"=>{"summary"=>"Post Catalogs", "description"=>"Creates a new catalog.", "operationId"=>"CreateCatalog", "x-api-path-slug"=>"catalogs-post", "parameters"=>[{"in"=>"body", "name"=>"catalog", "description"=>"Add new catalog", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalogs"]}}, "/catalogs/{id}"=>{"delete"=>{"summary"=>"Delete Catalogs", "description"=>"Delete a catalog and associated resources. **Not implemented**", "operationId"=>"DeleteCatalog", "x-api-path-slug"=>"catalogsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of catalog to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalogs"]}, "get"=>{"summary"=>"Get Catalogs", "description"=>"Returns a catalog based on its id. It requires the **consumer** global role.", "operationId"=>"GetCatalogById", "x-api-path-slug"=>"catalogsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of catalog to fetch"}, {"in"=>"query", "name"=>"view", "description"=>"Return related resources: * `full` - Whether to return related content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalogs"]}, "patch"=>{"summary"=>"Patch Catalogs", "description"=>"Patches a catalog. Allowed fields for PATCH of catalogs are name(add,replace), password(add), accessKey(add), secretKey(add), state(add,replace)", "operationId"=>"UpdateCatalog", "x-api-path-slug"=>"catalogsid-patch", "parameters"=>[{"in"=>"body", "name"=>"catalog", "description"=>"Update catalog", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of catalog to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Catalogs"]}}, "/connect-app"=>{"get"=>{"summary"=>"Get Connect App", "description"=>"Generates connect app s3 url", "operationId"=>"connect-app", "x-api-path-slug"=>"connectapp-get", "parameters"=>[{"in"=>"query", "name"=>"os", "description"=>"OS type for which compatible connect app URL has to be generated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connect", "App"]}}, "/deployments"=>{"get"=>{"summary"=>"Get Deployments", "description"=>"Returns deployments. It requires any project role or non-'consumer' global role.", "operationId"=>"FindDeployments", "x-api-path-slug"=>"deployments-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"Filters the deployments returned"}, {"in"=>"query", "name"=>"userQuery", "description"=>"Filters the deployments returned"}, {"in"=>"query", "name"=>"view", "description"=>"Return related resources: * `full` - include zone, service, volume details"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}, "post"=>{"summary"=>"Post Deployments", "description"=>"Creates a new deployment. It requires any project role, or the **administrator** or **project creator** global role.", "operationId"=>"CreateDeployment", "x-api-path-slug"=>"deployments-post", "parameters"=>[{"in"=>"body", "name"=>"deployment", "description"=>"Add new deployment", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/deployments/{id}"=>{"delete"=>{"summary"=>"Delete Deployments", "description"=>"Delete a deployment and associated resources. It requires any project role, or the **administrator** or **project creator** global role.", "operationId"=>"DeleteDeployment", "x-api-path-slug"=>"deploymentsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of deployment to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}, "get"=>{"summary"=>"Get Deployments", "description"=>"Returns a deployment based on its id. It requires any project role or non-'consumer' global role.", "operationId"=>"GetDeploymentById", "x-api-path-slug"=>"deploymentsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of deployment to fetch"}, {"in"=>"query", "name"=>"view", "description"=>"Return related resources: * `full` - include region, zone, service, virtual machine profile, firewall, volume details"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}, "patch"=>{"summary"=>"Patch Deployments", "description"=>"Updates a deployment. **Requires any project role, or 'administrator' or 'project creator' global role**. Allowed fields for PATCH of deployments are name(add,replace), volumes(add), k8snumWorkers(add), userData(add), serviceInput(add), version(add).", "operationId"=>"UpdateDeployment", "x-api-path-slug"=>"deploymentsid-patch", "parameters"=>[{"in"=>"body", "name"=>"deployment", "description"=>"Update deployment", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of deployment to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/deployments/{id}/actions"=>{"post"=>{"summary"=>"Post Deployments Actions", "description"=>"Peforms an action to change the state of a deployment. It requires any project role, or the **administrator** or **project creator** global role.", "operationId"=>"ActOnDeployment", "x-api-path-slug"=>"deploymentsidactions-post", "parameters"=>[{"in"=>"body", "name"=>"action", "description"=>"Action to perform", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of deployment to act on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments", "Actions"]}}, "/deployments/{id}/console"=>{"post"=>{"summary"=>"Post Deployments Console", "description"=>"Returns a deployment console URL for deployment", "operationId"=>"GetDeploymentConsoleURL", "x-api-path-slug"=>"deploymentsidconsole-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of deployment for which console URL is required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments", "Console"]}}, "/deployments/{id}/kubeconfig"=>{"get"=>{"summary"=>"Get Deployments Kubeconfig", "description"=>"Returns the kubeconfig. Applicable only to deployments of Kubernetes cluster. **Requires 'consumer' role on workspace**", "operationId"=>"GetDeploymentKubeConfig", "x-api-path-slug"=>"deploymentsidkubeconfig-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of deployment for which kubeconfig is required"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments", "Kubeconfig"]}}, "/events"=>{"get"=>{"summary"=>"Get Events", "description"=>"Returns events based on the supplied criteria. **Not implemented**", "operationId"=>"FindEvents", "x-api-path-slug"=>"events-get", "parameters"=>[{"in"=>"query", "name"=>"resourceUri", "description"=>"Resource to prune events by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/keypairs"=>{"get"=>{"summary"=>"Get Keypairs", "description"=>"Get keypairs (per region, per user). Currently a projectUri is required", "operationId"=>"ListKeypairs", "x-api-path-slug"=>"keypairs-get", "parameters"=>[{"in"=>"query", "name"=>"projectUri"}, {"in"=>"query", "name"=>"regionUri"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Keypairs"]}}, "/membership-roles"=>{"get"=>{"summary"=>"Get Membership Roles", "description"=>"Returns membership (project-specific) roles.", "operationId"=>"ListMembershipRoles", "x-api-path-slug"=>"membershiproles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Membership", "Roles"]}}, "/memberships"=>{"delete"=>{"summary"=>"Delete Memberships", "description"=>"Delete a membership. It requires the **administrator** or **project creator** global role or the **project owner** role on the project.", "operationId"=>"DeleteMember", "x-api-path-slug"=>"memberships-delete", "parameters"=>[{"in"=>"body", "name"=>"membership", "description"=>"Delete membership", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Memberships"]}, "get"=>{"summary"=>"Get Memberships", "description"=>"Returns memberships. Supports filtering by projectUri, userUri, userGroupUri, roleUri (but only\nindividual values, not multiple) in 'query'.\n\nIf projectURI and userUri/userGroupUri are given a different\nbackend path will be used that should be authorized to a project owner even if they wouldn't ordinarily\nbe able to see other users' roles.\n\nIt requires the **administrator** or **project creator** global role or the **project owner** role on the project.\n**project owner** requires **projectUri** to be supplied.", "operationId"=>"FindMembers", "x-api-path-slug"=>"memberships-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"URI query to prune memberships by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Memberships"]}, "post"=>{"summary"=>"Post Memberships", "description"=>"Creates a new membership. It requires the **administrator** or **project creator** global role or **project owner** role on the project.", "operationId"=>"CreateMember", "x-api-path-slug"=>"memberships-post", "parameters"=>[{"in"=>"body", "name"=>"membership", "description"=>"Add new membership", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Memberships"]}}, "/metrics"=>{"get"=>{"summary"=>"Get Metrics", "description"=>"Returns all metrics based on the supplied criteria. It requires the **analyst** role.\nIt requires one and only one of resourceUri or category to be specified.", "operationId"=>"FindMetrics", "x-api-path-slug"=>"metrics-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"A category name"}, {"in"=>"query", "name"=>"count", "description"=>"Maximum number of response members to return"}, {"in"=>"query", "name"=>"groupBy", "description"=>"A value to group the data by"}, {"in"=>"query", "name"=>"name", "description"=>"Name(s) of metrics to return"}, {"in"=>"query", "name"=>"period", "description"=>"How much time to cover per data point"}, {"in"=>"query", "name"=>"periodCount", "description"=>"How many period data points to return relative to the periodStart time"}, {"in"=>"query", "name"=>"periodStart", "description"=>"When the metric value(s) should be measured from"}, {"in"=>"query", "name"=>"query", "description"=>"A query to filter the resources by"}, {"in"=>"query", "name"=>"resourceUri", "description"=>"Resource(s) to return metrics for"}, {"in"=>"query", "name"=>"start", "description"=>"Index into the response members to allow pagination"}, {"in"=>"query", "name"=>"view", "description"=>"Whether to return related content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Metrics"]}}, "/networks"=>{"get"=>{"summary"=>"Get Networks", "description"=>"Returns networks. It requires any project role or non-'consumer' global role.", "operationId"=>"FindNetworks", "x-api-path-slug"=>"networks-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"Filters the networks returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Networks"]}}, "/networks/{id}"=>{"get"=>{"summary"=>"Get Networks", "description"=>"Returns a network based on its id. It requires any project role or non-'consumer' global role.", "operationId"=>"GetNetworkById", "x-api-path-slug"=>"networksid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of network to fetch"}, {"in"=>"query", "name"=>"query", "description"=>"Filters the networks returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Networks"]}, "patch"=>{"summary"=>"Patch Networks", "description"=>"Updates a network. It requires the **administrator** global role.", "operationId"=>"ModifyNetwork", "x-api-path-slug"=>"networksid-patch", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the network to update"}, {"in"=>"body", "name"=>"network", "description"=>"Update network", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Networks"]}}, "/onboarding/azure/properties"=>{"get"=>{"summary"=>"Get Onboarding Azure Properties", "description"=>"Returns a properties object needed to build the Azure login url", "operationId"=>"GetAzureLoginProperties", "x-api-path-slug"=>"onboardingazureproperties-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Onboarding", "Azure", "Properties"]}}, "/onboarding/azure/provider-info"=>{"get"=>{"summary"=>"Get Onboarding Azure Prover Info", "description"=>"Returns the provider information required to add an Azure provider", "operationId"=>"getAzureProviderInfo", "x-api-path-slug"=>"onboardingazureproviderinfo-get", "parameters"=>[{"in"=>"query", "name"=>"directoryUri", "description"=>"The Azure Directory URI associated with the SubscriptionFor Example:myActiveDirectory"}, {"in"=>"query", "name"=>"location", "description"=>"The full response Azure sends to the redirectURI including valid Azure authentication codeFor Example:https://customername"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Onboarding", "Azure", "Prover", "Info"]}}, "/onboarding/azure/subscriptions"=>{"get"=>{"summary"=>"Get Onboarding Azure Subscriptions", "description"=>"Returns a list of Azure subscriptions and their display names", "operationId"=>"ListAzureSubscriptions", "x-api-path-slug"=>"onboardingazuresubscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"directoryUri", "description"=>"The Azure Directory URI associated with the SubscriptionFor Example:myActiveDirectory"}, {"in"=>"query", "name"=>"location", "description"=>"The full response Azure sends to the redirectURI including valid Azure authentication codeFor Example:https://customername"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Onboarding", "Azure", "Subscriptions"]}}, "/onboarding/azure/subscriptions/{subscriptionId}"=>{"patch"=>{"summary"=>"Patch Onboarding Azure Subscriptions Subscriptionid", "description"=>"Updates a subscription", "operationId"=>"UpdateSubscription", "x-api-path-slug"=>"onboardingazuresubscriptionssubscriptionid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Update subscription", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"directoryUri", "description"=>"The Azure Directory URI associated with the SubscriptionFor Example:myActiveDirectory"}, {"in"=>"query", "name"=>"location", "description"=>"The full response Azure sends to the redirectURI including valid Azure authentication codeFor Example:https://customername"}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"The Azure subscriptionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Onboarding", "Azure", "Subscriptions", "Subscriptionid"]}}, "/password-reset"=>{"post"=>{"summary"=>"Post Password Reset", "description"=>"Request a single-use password reset token.", "operationId"=>"CreatePasswordReset", "x-api-path-slug"=>"passwordreset-post", "parameters"=>[{"in"=>"body", "name"=>"passwordResetRequest", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Password", "Reset"]}}, "/password-reset/change"=>{"post"=>{"summary"=>"Post Password Reset Change", "description"=>"Process a password reset.", "operationId"=>"ProcessPasswordReset", "x-api-path-slug"=>"passwordresetchange-post", "parameters"=>[{"in"=>"body", "name"=>"passwordReset", "description"=>"Password reset information", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Password", "Reset", "Change"]}}, "/projects"=>{"get"=>{"summary"=>"Get Projects", "description"=>"Returns projects. It requires any project role or non-'consumer' global role.", "operationId"=>"FindProjects", "x-api-path-slug"=>"projects-get", "parameters"=>[{"in"=>"query", "name"=>"userQuery", "description"=>"Filters the projects returned"}, {"in"=>"query", "name"=>"view", "description"=>"Return related resources: * `full` - Any deployments in the project; any tags referred to by tagUris (**not implemented**)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}, "post"=>{"summary"=>"Post Projects", "description"=>"Creates a new project. It requires the **project-owner** project role, or **administrator** or **project creator** global role.", "operationId"=>"CreateProject", "x-api-path-slug"=>"projects-post", "parameters"=>[{"in"=>"body", "name"=>"project", "description"=>"Add new project", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/projects/{id}"=>{"delete"=>{"summary"=>"Delete Projects", "description"=>"Deletes a project. If resources (currently Deployments) exist within the project they must first be deleted. In this case, the response will be a 409 Conflict with the body listing the first ten offending items. It requires **administratpor** global role or **owner** project role. **not implemented**", "operationId"=>"deletes-a-project-if-resources-currently-deployments-exist-within-the-project-they-must-first-be-del", "x-api-path-slug"=>"projectsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}, "get"=>{"summary"=>"Get Projects", "description"=>"Returns a project based on its id. It requires any project role or non-consumer global role.", "operationId"=>"GetProjectById", "x-api-path-slug"=>"projectsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of project to fetch"}, {"in"=>"query", "name"=>"view", "description"=>"Return related resources: * `full` - Any deployments in the project; any tags referred to by tagUris (**not implemented**)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}, "patch"=>{"summary"=>"Patch Projects", "description"=>"Updates a project. It requires the **administrator** global role or the **project owner** role on a project.", "operationId"=>"UpdateProject", "x-api-path-slug"=>"projectsid-patch", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of project to update"}, {"in"=>"body", "name"=>"project", "description"=>"Update project", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/provider-types"=>{"get"=>{"summary"=>"Get Prover Types", "description"=>"Returns provider types.", "operationId"=>"FindProviderTypes", "x-api-path-slug"=>"providertypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Prover", "Types"]}}, "/providers"=>{"get"=>{"summary"=>"Get Provers", "description"=>"Returns providers. It requires the **consumer** global role.", "operationId"=>"FindProviders", "x-api-path-slug"=>"providers-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"Filters the providers returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provers"]}, "post"=>{"summary"=>"Post Provers", "description"=>"Creates a new Master provider or Member provider.", "operationId"=>"CreateProvider", "x-api-path-slug"=>"providers-post", "parameters"=>[{"in"=>"body", "name"=>"provider", "description"=>"Add new provider", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provers"]}}, "/providers/{id}"=>{"delete"=>{"summary"=>"Delete Provers", "description"=>"Deletes a master provider or a child provider", "operationId"=>"DeleteProviderById", "x-api-path-slug"=>"providersid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of provider to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provers"]}, "get"=>{"summary"=>"Get Provers", "description"=>"Returns a provider based on its id. It requires the **consumer** global role.", "operationId"=>"GetProviderById", "x-api-path-slug"=>"providersid-get", "parameters"=>[{"in"=>"query", "name"=>"discover", "description"=>"Will return the merged set of regions from AWS and existing regions in Onesphere"}, {"in"=>"path", "name"=>"id", "description"=>"ID of provider to fetch"}, {"in"=>"query", "name"=>"view", "description"=>"Whether to return related content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provers"]}, "patch"=>{"summary"=>"Patch Provers", "description"=>"Updates a provider.", "operationId"=>"UpdateProvider", "x-api-path-slug"=>"providersid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Update provider", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of provider to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provers"]}}, "/rates"=>{"get"=>{"summary"=>"Get Rates", "description"=>"Returns rates. It requires the **administrator** global role.\n\nOptionally this list may be filtered, or the default rates specified with a resourceUri of 'default'.", "operationId"=>"listRates", "x-api-path-slug"=>"rates-get", "parameters"=>[{"in"=>"query", "name"=>"active", "description"=>"Filter for active or inactive rates"}, {"in"=>"query", "name"=>"count", "description"=>"Maximum number of response members to return"}, {"in"=>"query", "name"=>"effectiveDate", "description"=>"The specific effective date to filter by"}, {"in"=>"query", "name"=>"effectiveForDate", "description"=>"The date for which returned rates need be effective, a special filter that allows a search for a rate that would be effective on a date"}, {"in"=>"query", "name"=>"metricName", "description"=>"The metric name to filter by"}, {"in"=>"query", "name"=>"resourceUri", "description"=>"Resource(s) to return rates for"}, {"in"=>"query", "name"=>"start", "description"=>"Index into the response members to allow pagination"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rates"]}}, "/rates/{id}"=>{"get"=>{"summary"=>"Get Rates", "description"=>"Retrieve a rate by id. It requires the **administrator** global role.", "operationId"=>"getRateById", "x-api-path-slug"=>"ratesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Id of the rate to be retrieved"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rates"]}}, "/regions"=>{"get"=>{"summary"=>"Get Regions", "description"=>"Returns regions. It requires the **consumer** global role.", "operationId"=>"FindRegions", "x-api-path-slug"=>"regions-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"Filters the regions returned"}, {"in"=>"query", "name"=>"view", "description"=>"Whether to return related content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions"]}, "post"=>{"summary"=>"Post Regions", "description"=>"Creates a new region.", "operationId"=>"CreateRegion", "x-api-path-slug"=>"regions-post", "parameters"=>[{"in"=>"body", "name"=>"region", "description"=>"Add new region", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions"]}}, "/regions/{id}"=>{"delete"=>{"summary"=>"Delete Regions", "description"=>"Deletes a region", "operationId"=>"Delete Region", "x-api-path-slug"=>"regionsid-delete", "parameters"=>[{"in"=>"query", "name"=>"force", "description"=>"Region may be in an odd state"}, {"in"=>"path", "name"=>"id", "description"=>"ID of region to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions"]}, "get"=>{"summary"=>"Get Regions", "description"=>"Returns a region based on its id. It requires the **consumer** global role.", "operationId"=>"GetRegionById", "x-api-path-slug"=>"regionsid-get", "parameters"=>[{"in"=>"query", "name"=>"discover", "description"=>"will return child providers from aws"}, {"in"=>"path", "name"=>"id", "description"=>"ID of region to fetch"}, {"in"=>"query", "name"=>"view", "description"=>"Whether to return related content"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions"]}, "patch"=>{"summary"=>"Patch Regions", "description"=>"Patches a region. PATCH only supports provider type(/rest/provider-types/ncs). Allowed fields to PATCH for NCS provider type are (name,location)", "operationId"=>"PatchRegion", "x-api-path-slug"=>"regionsid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"Patch region", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of region to patch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions"]}, "put"=>{"summary"=>"Put Regions", "description"=>"Updates a region. **Not implemented**", "operationId"=>"UpdateRegion", "x-api-path-slug"=>"regionsid-put", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of region to update"}, {"in"=>"body", "name"=>"region", "description"=>"Update region", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions"]}}, "/regions/{id}/connection"=>{"delete"=>{"summary"=>"Delete Regions Connection", "description"=>"", "operationId"=>"DeleteRegionConnection", "x-api-path-slug"=>"regionsidconnection-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of region"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions", "Connection"]}, "get"=>{"summary"=>"Get Regions Connection", "description"=>"Get region connection.", "operationId"=>"GetRegionConnection", "x-api-path-slug"=>"regionsidconnection-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of region"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions", "Connection"]}, "post"=>{"summary"=>"Post Regions Connection", "description"=>"Creates a new region connection", "operationId"=>"CreateRegionConnection", "x-api-path-slug"=>"regionsidconnection-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of region"}, {"in"=>"body", "name"=>"regionConnection", "description"=>"Add new region connection", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions", "Connection"]}}, "/regions/{id}/connector-image"=>{"get"=>{"summary"=>"Get Regions Connector Image", "description"=>"Generates connector-image url for the region. It requires the **administrator** role.", "operationId"=>"getConnectorImage", "x-api-path-slug"=>"regionsidconnectorimage-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of region to fetch the connector-image"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Regions", "Connector", "Image"]}}, "/roles"=>{"get"=>{"summary"=>"Get Roles", "description"=>"Returns global roles.", "operationId"=>"ListRoles", "x-api-path-slug"=>"roles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles"]}}, "/servers"=>{"get"=>{"summary"=>"Get Servers", "description"=>"Returns servers.", "operationId"=>"GetServer", "x-api-path-slug"=>"servers-get", "parameters"=>[{"in"=>"query", "name"=>"applianceUri", "description"=>"Set of servers in this appliance"}, {"in"=>"query", "name"=>"regionUri", "description"=>"Set of servers in this region"}, {"in"=>"query", "name"=>"zoneUri", "description"=>"Set of servers in this zone"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}, "post"=>{"summary"=>"Post Servers", "description"=>"Create/Register a server.", "operationId"=>"CreateServer", "x-api-path-slug"=>"servers-post", "parameters"=>[{"in"=>"body", "name"=>"server", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}}, "/servers/{id}"=>{"delete"=>{"summary"=>"Delete Servers", "description"=>"Delete a server.\nNote that by default only servers created via the HPE OneSphere API can be\nsubsequently deleted. HPE OneSphere managed servers (those that have\nan applianceUri) cannot be deleted via this operation (a '403' will be returned),\nunless the 'force' parameter is supplied and set to 'true'.", "operationId"=>"DeleteServer", "x-api-path-slug"=>"serversid-delete", "parameters"=>[{"in"=>"query", "name"=>"force", "description"=>"Delete Server even if Delete operation is not allowed on this server by default,e"}, {"in"=>"path", "name"=>"id", "description"=>"ID of the server to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}, "get"=>{"summary"=>"Get Servers", "description"=>"Returns a server based on its ID.", "operationId"=>"GetServerById", "x-api-path-slug"=>"serversid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the server to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}, "patch"=>{"summary"=>"Patch Servers", "description"=>"Update properties of a server.", "operationId"=>"UpdateServer", "x-api-path-slug"=>"serversid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"List of server updates", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"ID of server to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}}, "/service-types"=>{"get"=>{"summary"=>"Get Service Types", "description"=>"Returns all service types. It requires the **consumer** global role.", "operationId"=>"FindServiceTypes", "x-api-path-slug"=>"servicetypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Types"]}}, "/service-types/{id}"=>{"get"=>{"summary"=>"Get Service Types", "description"=>"Return a service type based on its id. It requires the **consumer** global role.", "operationId"=>"GetServiceTypeById", "x-api-path-slug"=>"servicetypesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of service type to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Types"]}}, "/services"=>{"get"=>{"summary"=>"Get Services", "description"=>"Returns services. It requires any project role or non-'consumer' global role.", "operationId"=>"FindServices", "x-api-path-slug"=>"services-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"Filters the services returned"}, {"in"=>"query", "name"=>"userQuery", "description"=>"Filters the services returned"}, {"in"=>"query", "name"=>"view", "description"=>"Return related resources: * `full` - Include all the details of the services"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/services/{id}"=>{"get"=>{"summary"=>"Get Services", "description"=>"Returns a service based on its id. It requires any project role or non-'consumer' global role.", "operationId"=>"GetServiceById", "x-api-path-slug"=>"servicesid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of service to fetch"}, {"in"=>"query", "name"=>"view", "description"=>"Return related resources: * `full` - Include all the details of the services * `deployment` - Return the zones to which the service can be deployed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/session"=>{"delete"=>{"summary"=>"Delete Session", "description"=>"Deletes cached data and tokens for the current session.", "operationId"=>"DeleteSession", "x-api-path-slug"=>"session-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session"]}, "get"=>{"summary"=>"Get Session", "description"=>"Gets information for the current user.", "operationId"=>"ReadSession", "x-api-path-slug"=>"session-get", "parameters"=>[{"in"=>"query", "name"=>"view", "description"=>"Return related resources: * `full` - Include the related `user`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Session"]}, "post"=>{"summary"=>"Post Session", "description"=>"Authenticates a local user and generates an authorization token. This\ntoken should be used in subsequent HTTP requests as part of\nthe \"Authorization\" header. For example:\n\n`Authorization: \"Bearer |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
matrix{"matrix-login-operations-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Matrix", "x-complete"=>1, "info"=>{"title"=>"Login Operations", "version"=>"1.0.0"}, "host"=>"/login", "basePath"=>"http://localhost:8008/_matrix/client/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/login"=>{"get"=>{"summary"=>"Get the login mechanism to use when logging in.", "description"=>"All login stages MUST be mentioned if there is >1 login type.", "operationId"=>"get_login_info", "x-api-path-slug"=>"login-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Login", "Mechanism", "To", "Use", "When", "Logging", "In"]}, "post"=>{"summary"=>"Submit a login action.", "description"=>"If this is part of a multi-stage login, there MUST be a session key.", "operationId"=>"submit_login", "x-api-path-slug"=>"login-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"A login submission", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Submit", "Login", "Action"]}}}}, "apis"=>{"name"=>"Matrix", "x-slug"=>"matrix", "description"=>"An open standard for decentralised secure communication. Please support at https://t.co/oZd61hbMx3! | bridged to https://t.co/ujgzEXDSa4", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11769-matrix.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"156652", "tags"=>"API Provider,Enterprise,Networks,Profiles,Real Time,Relative Data,Service API,Stack Network,Technology,Telecommunications", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"matrix/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Matrix Login Operations API", "x-api-slug"=>"matrix-login-operations-api", "description"=>"Matrix is an open standard for decentralised communication, providing simple HTTP APIs and open source reference implementations for securely distributing and persisting JSON over an open federation of servers.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/11769-matrix.jpg", "humanURL"=>"http://matrix.org/", "baseURL"=>":///login/http://localhost:8008/_matrix/client/api/v1", "tags"=>"API Provider,Enterprise,Networks,Profiles,Real Time,Relative Data,Service API,Stack Network,Technology,Telecommunications", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/matrix/matrix-login-operations-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"http://matrix.org/blog/posts/"}, {"type"=>"x-blog-rss", "url"=>"http://matrix.org/blog/comments/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/matrix-org"}, {"type"=>"x-github", "url"=>"https://github.com/matrix-org"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/matrixdotorg"}, {"type"=>"x-website", "url"=>"http://matrix.org/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
intrinio{"intrinio-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Intrinio", "x-complete"=>1, "info"=>{"title"=>"Intrinio", "description"=>"through-our-intrinio-data-marketplace-we-offer-a-wide-selection-of-financial-data-feeds-sourced-by-our-own-proprietary-processes-as-well-as-from-many-data-vendors--the-primary-application-of-the-intrinio-api-is-for-use-in-thirdparty-applications-and-integrations-or-for-endusers-utilizing-the-excel-addin-and-google-sheets-addon--the-intrinio-api-uses-https-verbs-and-a-restful-endpoint-structure-which-makes-it-easy-to-request-data-from-intrinio--basic-authentication-is-administered-over-https--responses-are-delivered-in-json-format-", "version"=>"1.0.0"}, "host"=>"api.intrinio.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/companies"=>{"get"=>{"summary"=>"Company Master", "description"=>"Returns the master list of all companies covered by the Intrinio Data Marketplace. You can view the Company/Security Master here.", "operationId"=>"company-master", "x-api-path-slug"=>"companies-get", "parameters"=>[{"in"=>"query", "name"=>"latest_filing_date", "description"=>"a date value that returns the list of companies whose latest SEC filing was filed on or after this date: YYYY", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"a string query search of company name or ticker symbol with the returned results being the relevant companies in compacted list format", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Companies"]}}, "/indices"=>{"get"=>{"summary"=>"Index Master", "description"=>"Returns indices list and information for all indices covered by Intrinio. There are three distinct types of indices: Stock Market, SIC (Sector & Industry), and Economic. You can view the Stock Market Indices Master, SIC Indices Master, and the Economic Indices Master.", "operationId"=>"index-master", "x-api-path-slug"=>"indices-get", "parameters"=>[{"in"=>"query", "name"=>"identifier", "description"=>"the Intrinio symbol associated with the index:", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"returns the results in the given order: popularity | symbol", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"a string query search of index name or symbol with the returned results being the relevant securities in compacted list format", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"the type of indices specified: stock_market | economic | sic", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Indices"]}}, "/stock_exchanges"=>{"get"=>{"summary"=>"Stock Exchange Master", "description"=>"Returns stock exchange list and information for all stock exchanges covered by Intrinio.", "operationId"=>"stock-exchange-master", "x-api-path-slug"=>"stock-exchanges-get", "parameters"=>[{"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"a string query search of stock exchange name or MIC with the returned results being the relevant stock exchanges in compacted list format", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Stock Exchanges"]}}, "/securities"=>{"get"=>{"summary"=>"Securities", "description"=>"Returns security list and information for all securities covered by Intrinio.", "operationId"=>"securities", "x-api-path-slug"=>"securities-get", "parameters"=>[{"in"=>"query", "name"=>"exch_symbol", "description"=>"the Intrinio Stock Market Symbol, to specify the exchange for the list of securities:", "type"=>"string"}, {"in"=>"query", "name"=>"identifier", "description"=>"the identifier for the legal entity or a security associated with the company:", "type"=>"string"}, {"in"=>"query", "name"=>"last_crsp_adj_date", "description"=>"a date value that returns the list of securities that have had adjusted stock prices due to a corporate event after this date: YYYY", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"a string query search of security name or ticker symbol with the returned results being the relevant securities in compacted list format", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Securities"]}}, "/securities/search"=>{"get"=>{"summary"=>"Securities Search/Screener", "description"=>"Returns a list of all securities that match the given conditions. The API call credits required for each call is equal to the number of conditions specified.", "operationId"=>"securities-searchscreener", "x-api-path-slug"=>"securitiessearch-get", "parameters"=>[{"in"=>"query", "name"=>"An operator\n\n\n Equal to: “eq”", "type"=>"string"}, {"in"=>"query", "name"=>"conditions", "description"=>"A comma", "type"=>"string"}, {"in"=>"query", "name"=>"Contains text: “contains”", "type"=>"string"}, {"in"=>"query", "name"=>"Greater than or equal to: “gte”", "type"=>"string"}, {"in"=>"query", "name"=>"Greater than: “gt”", "type"=>"string"}, {"in"=>"query", "name"=>"Less than or equal to: “lte”", "type"=>"string"}, {"in"=>"query", "name"=>"Less than: “lt”", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Securities"]}}, "/historical_data"=>{"get"=>{"summary"=>"Historical Data", "description"=>"Returns the historical data for for a selected identifier (ticker symbol or index symbol) for a selected tag. The complete list of tags available through this function are available here. Income statement, cash flow statement, and ratios are returned as trailing twelve months values by default, but can be changed with the type parameter. All other historical data points are returned as their value on a certain day based on filings reported as of that date.", "operationId"=>"historical-data", "x-api-path-slug"=>"historical-data-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"the latest date for which to return data: YYYY", "type"=>"string"}, {"in"=>"query", "name"=>"frequency", "description"=>"the frequency of the historical prices & valuation data: daily | weekly | monthly | quarterly | yearly", "type"=>"string"}, {"in"=>"query", "name"=>"identifier", "description"=>"the stock market ticker symbol associated with the company’s common stock or index", "type"=>"string"}, {"in"=>"query", "name"=>"item", "description"=>"the specified standardized tag requested", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"sequence", "description"=>"in function)", "type"=>"string"}, {"in"=>"query", "name"=>"show_date", "description"=>"in, false by default) if true, the function will return the date value, and if false the function will return the data point value for a given query: true | false", "type"=>"string"}, {"in"=>"query", "name"=>"sort_order", "description"=>"the order of the historical stock price dates: asc | desc", "type"=>"string"}, {"in"=>"query", "name"=>"start_date", "description"=>"the earliest date for which to return data: YYYY", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"the type of periods requested", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Historical Data"]}}, "/prices/exchange"=>{"get"=>{"summary"=>"Exchange Prices", "description"=>"Returns professional-grade historical stock prices for all securities traded on a stock exchange for a single specified day. Historical prices are available back to 1996 or the IPO date, with some companies with data back to the 1970s.", "operationId"=>"exchange-prices", "x-api-path-slug"=>"pricesexchange-get", "parameters"=>[{"in"=>"query", "name"=>"identifier", "description"=>"the stock market ticker symbol associated with the companies common stock securities or the stock market index:", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"price_date", "description"=>"the specified date in which historical stock prices are returned for a stock exchange", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Prices", "Exchanges"]}}, "/companies/filings"=>{"get"=>{"summary"=>"Company SEC Filings", "description"=>"Returns the complete list of SEC filings for a company.", "operationId"=>"company-sec-filings", "x-api-path-slug"=>"companiesfilings-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"the last filing date for which to return filings, in the format: YYYY", "type"=>"string"}, {"in"=>"query", "name"=>"identifier", "description"=>"the stock market ticker symbol associated with the company’s common stock", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"report_type", "description"=>"the report type of the filing requested: 10", "type"=>"string"}, {"in"=>"query", "name"=>"start_date", "description"=>"the earliest filing date for which to return filings, in the format: YYYY", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Companies", "Company Filings"]}}, "/fundamentals/standardized"=>{"get"=>{"summary"=>"Standardized Fundamentals", "description"=>"Returns a list of available standardized fundamentals (fiscal year and fiscal period) for a given ticker and statement. Also, you may add a date and type parameter to specify the fundamentals you wish to be returned in the response.", "operationId"=>"standardized-fundamentals", "x-api-path-slug"=>"fundamentalsstandardized-get", "parameters"=>[{"in"=>"query", "name"=>"date", "description"=>"the first fundamental will be the latest as of this specified date: YYYY", "type"=>"string"}, {"in"=>"query", "name"=>"identifier", "description"=>"the stock market ticker symbol associated with the companies common stock securities:", "type"=>"string"}, {"in"=>"query", "name"=>"item", "description"=>"in function)", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"sequence", "description"=>"in function)", "type"=>"string"}, {"in"=>"query", "name"=>"statement", "description"=>"the financial statement requested, options include the income statement, balance sheet, statement of cash flows and calculated metrics and ratios: income_statement | balance_sheet | cash_flow_statement | calculations", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"the type of periods requested", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Fundamentals"]}}, "/financials/standardized"=>{"get"=>{"summary"=>"Standardized Financials", "description"=>"Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies fundamentals.", "operationId"=>"standardized-financials", "x-api-path-slug"=>"financialsstandardized-get", "parameters"=>[{"in"=>"query", "name"=>"date", "description"=>"the first fundamental will be the latest as of this specified date: YYYY", "type"=>"string"}, {"in"=>"query", "name"=>"fiscal_period", "description"=>"the fiscal period associated with the fundamental: FY | Q1 | Q2 | Q3 | Q4 | Q1TTM | Q2TTM | Q3TTM | Q2YTD | Q3YTD", "type"=>"string"}, {"in"=>"query", "name"=>"fiscal_year", "description"=>"the fiscal year associated with the fundamental: YYYY", "type"=>"string"}, {"in"=>"query", "name"=>"identifier", "description"=>"the stock market ticker symbol associated with the companies common stock securities:", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"rounding", "description"=>"ins function) ??? round the returned value (actuals, thousands, millions, billions): A | K | M | B", "type"=>"string"}, {"in"=>"query", "name"=>"sequence", "description"=>"the sequence of the requested fundamental (i", "type"=>"string"}, {"in"=>"query", "name"=>"statement", "description"=>"the financial statement requested, options include the income statement, balance sheet, statement of cash flows and calculated metrics and ratios: income_statement | balance_sheet | cash_flow_statement | calculations", "type"=>"string"}, {"in"=>"query", "name"=>"tag", "description"=>"in function)", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"the type of periods requested", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Financials"]}}, "/tags/reported"=>{"get"=>{"summary"=>"As Reported XBRL Tags and Labels", "description"=>"Returns the As Reported XBRL tags and labels for a given ticker, statement, and date or fiscal year/fiscal quarter.", "operationId"=>"as-reported-xbrl-tags-and-labels", "x-api-path-slug"=>"tagsreported-get", "parameters"=>[{"in"=>"query", "name"=>"date", "description"=>"the first fundamental will be the latest as of this specified date: YYYY", "type"=>"string"}, {"in"=>"query", "name"=>"fiscal_period", "description"=>"the fiscal period associated with the fundamental: FY | Q1 | Q2 | Q3", "type"=>"string"}, {"in"=>"query", "name"=>"fiscal_year", "description"=>"the fiscal year associated with the fundamental: YYYY", "type"=>"string"}, {"in"=>"query", "name"=>"identifier", "description"=>"the stock market ticker symbol associated with the companies common stock securities:", "type"=>"string"}, {"in"=>"query", "name"=>"item", "description"=>"in function)", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"sequence", "description"=>"an integer 0 or greater for calling a single tag from the first entry, based on order", "type"=>"string"}, {"in"=>"query", "name"=>"statement", "description"=>"the financial statement requested: income_statement | balance_sheet | cash_flow_statement", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"the type of periods requested", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Tags"]}}, "/valuation/70087/assumptions"=>{"get"=>{"summary"=>"Fetch Valuation Assumptions", "description"=>"GET https://api.intrinio.com/valuation/:id/assumptions", "operationId"=>"fetch-valuation-assumptions", "x-api-path-slug"=>"valuation70087assumptions-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"the Intrinio unique identifier for the Valuation API request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Valuations"]}}, "/valuation/70087/outputs"=>{"get"=>{"summary"=>"Fetch Valuation Outputs", "description"=>"GET https://api.intrinio.com/valuation/:id/outputs", "operationId"=>"fetch-valuation-outputs", "x-api-path-slug"=>"valuation70087outputs-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"the Intrinio unique identifier for the Valuation API request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Valuations"]}}, "/companies/insider_transactions"=>{"get"=>{"summary"=>"Insider Transactions by Company", "description"=>"Returns a list of all insider transactions in a company. Criteria for being an insider include being a director, officer, or 10%+ owner in the company. Transactions are detailed for both non-derivative and derivative transactions by the insider.", "operationId"=>"insider-transactions-by-company", "x-api-path-slug"=>"companiesinsider-transactions-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"the latest transaction date for which to return data: YYYY", "type"=>"string"}, {"in"=>"query", "name"=>"identifier", "description"=>"the stock market ticker symbol associated with the companies common stock securities or the Central Index Key issued by the SEC, which is the unique identifier all company filings are issued under:", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"start_date", "description"=>"the earliest transaction date for which to return data: YYYY", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Insider Transactions"]}}, "/owners/insider_transactions"=>{"get"=>{"summary"=>"Insider Transactions By Owner", "description"=>"Returns a list of all insider transactions by an owner in as many companies as the owner may be considered an insider. Criteria for being an insider include being a director, officer, or 10%+ owner in the company. Transactions are detailed for both non-derivative and derivative transactions by the insider.", "operationId"=>"insider-transactions-by-owner", "x-api-path-slug"=>"ownersinsider-transactions-get", "parameters"=>[{"in"=>"query", "name"=>"identifier", "description"=>"the Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under:CENTRAL INDEX KEY", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Owners", "Insider Transactions"]}}, "/owners"=>{"get"=>{"summary"=>"Owners", "description"=>"Returns owners list and information for all institutional owners of securities covered by Intrinio. Includes detailed info for a single owner and the ability to query by name.", "operationId"=>"owners", "x-api-path-slug"=>"owners-get", "parameters"=>[{"in"=>"query", "name"=>"identifier", "description"=>"the Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under:CENTRAL INDEX KEY", "type"=>"string"}, {"in"=>"query", "name"=>"institutional", "description"=>"(true)", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"a string query search of owner name or cik id with the returned results being the relevant owners in compacted list format", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Owners"]}}, "/securities/institutional_ownership"=>{"get"=>{"summary"=>"Institutional Owners by Security", "description"=>"https://api.intrinio.com/securities/institutional_ownership?identifier={symbol}", "operationId"=>"institutional-owners-by-security", "x-api-path-slug"=>"securitiesinstitutional-ownership-get", "parameters"=>[{"in"=>"query", "name"=>"identifier", "description"=>"the stock market ticker symbol associated with the companies common stock securities or the Central Index Key issued by the SEC, which is the unique identifier all company filings are issued under:", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Securities", "Institutional Ownership"]}}, "/data_point"=>{"get"=>{"summary"=>"Data Point", "description"=>"Returns the most recent median data point for an Economic index for a selected tag. The complete list of Economic Indices can be found here. The complete list of Economic tags available through this function are available here.", "operationId"=>"data-point", "x-api-path-slug"=>"data-point-get", "parameters"=>[{"in"=>"query", "name"=>"identifier", "description"=>"an identifier for the Economic Index selected:", "type"=>"string"}, {"in"=>"query", "name"=>"item", "description"=>"the specified standardized tag or series ID requested: ECONOMIC TAGS", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Data"]}}, "/banks/holding_companies"=>{"get"=>{"summary"=>"Bank Holding Companies", "description"=>"Returns bank holding company list and information for all bank holding companies covered by Intrinio.", "operationId"=>"bank-holding-companies", "x-api-path-slug"=>"banksholding-companies-get", "parameters"=>[{"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"used to search for a ticker or bank name to return relevant banks", "type"=>"string"}, {"in"=>"query", "name"=>"rssd_id", "description"=>"the bank/bank holding company RSSD ID issued by the Federal Reserve: RSSD ID LOOKUP", "type"=>"string"}, {"in"=>"query", "name"=>"ticker", "description"=>"the stock market ticker symbol associated with the companies common stock securities:", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Holding Companies", "Banks"]}}, "/banks/failed"=>{"get"=>{"summary"=>"Failed Banks", "description"=>"Returns failed bank list and information for all failed banks covered by Intrinio.", "operationId"=>"failed-banks", "x-api-path-slug"=>"banksfailed-get", "parameters"=>[{"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"used to search for a bank name to return relevant failed banks", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Failed Banks"]}}, "/tags/banks"=>{"get"=>{"summary"=>"Bank XBRL Tags and Labels", "description"=>"Returns the Bank XBRL tags and labels for a given ticker/RSSD ID, statement, and date or fiscal year/fiscal quarter.", "operationId"=>"bank-xbrl-tags-and-labels", "x-api-path-slug"=>"tagsbanks-get", "parameters"=>[{"in"=>"query", "name"=>"fiscal_period", "description"=>"the fiscal period associated with the fundamental: FY | Q1 | Q2 | Q3 | Q4 | Q1TTM | Q2TTM | Q3TTM | Q2YTD | Q3YTD", "type"=>"string"}, {"in"=>"query", "name"=>"fiscal_year", "description"=>"the fiscal year associated with the fundamental: YYYY", "type"=>"string"}, {"in"=>"query", "name"=>"identifier", "description"=>"the stock market ticker symbol associated with the companies common stock securities, or the bank/bank holding company RSSD ID issued by the Federal Reserve:", "type"=>"string"}, {"in"=>"query", "name"=>"item", "description"=>"in function)", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"sequence", "description"=>"an integer 0 or greater for calling a single tag from the first entry", "type"=>"string"}, {"in"=>"query", "name"=>"statement", "description"=>"the financial statement requested from the call report, the UBPR report or Y", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Banks"]}}, "/stock_exchanges/corporate_actions"=>{"get"=>{"summary"=>"Stock Exchange Corporate Actions", "description"=>"Returns all corporate actions for all securities listed on a specified stock exchange. A subscription to the EDI Corporate Actions Data Feed for a specific country will permit access to all stock exchanges in that country (ie, US includes NASDAQ, NYSE, BATS). Events 45+ types of corporate actions such as: Announcements and Annual Shareholder Meetings, Ex-date, Dividend pay date, Splits, Buy Backs, M&A and Takeovers, Bankruptcies and much more", "operationId"=>"stock-exchange-corporate-actions", "x-api-path-slug"=>"stock-exchangescorporate-actions-get", "parameters"=>[{"in"=>"query", "name"=>"identifier", "description"=>"the stock market ticker symbol associated with the companies common stock securities or the stock market index:", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Stock Exchanges"]}}, "/options/expirations"=>{"get"=>{"summary"=>"Option Expirations", "description"=>"Returns all option contract expiration dates for a given ticker.", "operationId"=>"option-expirations", "x-api-path-slug"=>"optionsexpirations-get", "parameters"=>[{"in"=>"query", "name"=>"ticker", "description"=>"the option ticker symbol, corresponding to the underlying security", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Options"]}}, "/options/historical"=>{"get"=>{"summary"=>"Historical Prices", "description"=>"Returns the historical prices for the given option contract.", "operationId"=>"historical-prices", "x-api-path-slug"=>"optionshistorical-get", "parameters"=>[{"in"=>"query", "name"=>"expiration", "description"=>"the contract expiration date, in the format YYYY", "type"=>"string"}, {"in"=>"query", "name"=>"identifier", "description"=>"the contract identifier (example: AAPL190118C00195000)", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"strike", "description"=>"the contract strike price", "type"=>"string"}, {"in"=>"query", "name"=>"ticker", "description"=>"the option ticker symbol, corresponding to the underlying security", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"the contract type, either put or call", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Options", "Historical"]}}, "/news_sector_sentiments"=>{"get"=>{"summary"=>"Sector News Sentiments", "description"=>"Returns daily summaries of news sentiments by sector and date.", "operationId"=>"sector-news-sentiments", "x-api-path-slug"=>"news-sector-sentiments-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"the latest date for which to return data: YYYY", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"sector", "description"=>"the name of the sector: SECTORS", "type"=>"string"}, {"in"=>"query", "name"=>"source", "description"=>"The source of the data: tip", "type"=>"string"}, {"in"=>"query", "name"=>"start_date", "description"=>"the earliest date for which to return data: YYYY", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "News", "Sector", "Sentiments"]}}, "/bloggers"=>{"get"=>{"summary"=>"Bloggers", "description"=>"Returns a list of bloggers. TipRanks bloggers are anonymized, but you will be able to reference them with the provided id field.", "operationId"=>"bloggers", "x-api-path-slug"=>"bloggers-get", "parameters"=>[{"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"source", "description"=>"The source of the data: tip", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Bloggers"]}}, "/blogger_ratings"=>{"get"=>{"summary"=>"Blogger Ratings", "description"=>"Returns blogger buy/sell/hold ratings for a specific security and date.", "operationId"=>"blogger-ratings", "x-api-path-slug"=>"blogger-ratings-get", "parameters"=>[{"in"=>"query", "name"=>"blogger_id", "description"=>"The ID of the blogger", "type"=>"string"}, {"in"=>"query", "name"=>"blog_id", "description"=>"The ID of the blog", "type"=>"string"}, {"in"=>"query", "name"=>"identifier", "description"=>"the identifier for the legal entity or a security associated with the company:", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"rating", "description"=>"The blogger rating (see section below)", "type"=>"string"}, {"in"=>"query", "name"=>"sector", "description"=>"The name of the sector", "type"=>"string"}, {"in"=>"query", "name"=>"source", "description"=>"The source of the data: tip", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Blogger Ratings"]}}, "/analysts"=>{"get"=>{"summary"=>"Analysts", "description"=>"Returns a list of analysts. TipRanks analysts are anonymized, but you will be able to reference them with the provided id field.", "operationId"=>"analysts", "x-api-path-slug"=>"analysts-get", "parameters"=>[{"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"source", "description"=>"The source of the data: tip", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Analysts"]}}, "/analyst_ratings"=>{"get"=>{"summary"=>"Analyst Ratings", "description"=>"Returns analyst buy/sell/hold ratings for a specific security and date, as well as target prices.", "operationId"=>"analyst-ratings", "x-api-path-slug"=>"analyst-ratings-get", "parameters"=>[{"in"=>"query", "name"=>"action", "description"=>"The analyst action (see section below)", "type"=>"string"}, {"in"=>"query", "name"=>"analyst_firm_id", "description"=>"The ID of the analyst firm", "type"=>"string"}, {"in"=>"query", "name"=>"analyst_id", "description"=>"The ID of the analyst", "type"=>"string"}, {"in"=>"query", "name"=>"identifier", "description"=>"the identifier for the legal entity or a security associated with the company:", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"rating", "description"=>"The analyst rating (see section below)", "type"=>"string"}, {"in"=>"query", "name"=>"sector", "description"=>"The name of the sector", "type"=>"string"}, {"in"=>"query", "name"=>"source", "description"=>"The source of the data: tip", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Analyst Ratings"]}}, "/press_releases"=>{"get"=>{"summary"=>"Press Releases", "description"=>"Returns the most recent press releases by Nasdaq GlobeNewsire for a company.", "operationId"=>"press-releases", "x-api-path-slug"=>"press-releases-get", "parameters"=>[{"in"=>"query", "name"=>"identifier", "description"=>"the stock market ticker symbol associated with the company’s common stock", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"filter whether the list returned includes all press releases where a company is the subject or only press releases issued by the company: all | false | true", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Press Releases"]}}, "/executives"=>{"get"=>{"summary"=>"Executive Master", "description"=>"Returns a list of all executives and their unique executive identifier, including both U.S. and International executives.", "operationId"=>"executive-master", "x-api-path-slug"=>"executives-get", "parameters"=>[{"in"=>"query", "name"=>"company", "description"=>"the identifier for the specified security or company:", "type"=>"string"}, {"in"=>"query", "name"=>"page_number", "description"=>"an integer greater than or equal to 1 for specifying the page number for the return values", "type"=>"string"}, {"in"=>"query", "name"=>"page_size", "description"=>"an integer greater than 1 for specifying the number of results on each page", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"a string query search of executives name", "type"=>"string"}, {"in"=>"query", "name"=>"role", "description"=>"the normalized executive and officer role", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"select whether to show only US or International executives: us | non", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Executives"]}}, "/executives/companies"=>{"get"=>{"summary"=>"Company Executive Contacts", "description"=>"Returns a list of all information for an executive and their related companies. Information includes the unique Intrinio executive company identifier, and detailed contact information for the executive at a specified company.", "operationId"=>"company-executive-contacts", "x-api-path-slug"=>"executivescompanies-get", "parameters"=>[{"in"=>"query", "name"=>"company", "description"=>"the identifier for the specified security or company:", "type"=>"string"}, {"in"=>"query", "name"=>"identifier", "description"=>"the Intrinio executive identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Executives", "companies"]}}, "/executives/roles"=>{"get"=>{"summary"=>"Company Executive Roles", "description"=>"For a specific executive company identifier, returns a list of all roles within the company. For example, an executive may be the Chief Executive Officer, a Director, and the Chairman of the Board of Directors.", "operationId"=>"company-executive-roles", "x-api-path-slug"=>"executivesroles-get", "parameters"=>[{"in"=>"query", "name"=>"company", "description"=>"the identifier for the specified security or company:", "type"=>"string"}, {"in"=>"query", "name"=>"identifier", "description"=>"the Intrinio executive identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Executives", "Executive Roles"]}}}}, "apis"=>{"name"=>"Intrinio", "x-slug"=>"intrinio", "description"=>"Intelligent Data, On Demand. The financial data platform for developers, investors, students, and educators, with over 200 feeds including real-time, intraday, EOD, and international financial data available via REST API, WebSocket, CSV, Excel, and Goo...", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/intrinio-logo-data-intelligence-on-demand.png", "x-kinRank"=>"8", "x-alexaRank"=>"303229", "tags"=>"API Provider,Enterprise,Financial Services,Free Tier,General Data,Have API Key,Historical Data API,JSON,Market Data,Paid Tier,Profiles,Relative Data,Relative StreamRank,REST,SaaS,Service API,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"intrinio/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Intrinio API", "x-api-slug"=>"intrinio-api", "description"=>"Intelligent Data, On Demand. The financial data platform for developers, investors, students, and educators, with over 200 feeds including real-time, intraday, EOD, and international financial data available via REST API, WebSocket, CSV, Excel, and Goo...", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/intrinio-logo-data-intelligence-on-demand.png", "humanURL"=>"http://www.intrinio.com", "baseURL"=>"https://api.intrinio.com//", "tags"=>"API Provider,Enterprise,Financial Services,Free Tier,General Data,Have API Key,Historical Data API,JSON,Market Data,Paid Tier,Profiles,Relative Data,Relative StreamRank,REST,SaaS,Service API,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/intrinio/intrinio-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://www.intrinio.com"}, {"type"=>"x-applications-showcase", "url"=>"https://intrinio.com/marketplace/apps"}, {"type"=>"x-authentication", "url"=>"http://docs.intrinio.com/#authentication"}, {"type"=>"x-blog", "url"=>"http://blog.intrinio.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.intrinio.com/feed/"}, {"type"=>"x-code", "url"=>"http://docs.intrinio.com/#sdks"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/tribunat"}, {"type"=>"x-developer", "url"=>"https://intrinio.com/we-love-developers"}, {"type"=>"x-documentation", "url"=>"https://intrinio.com/marketplace/data"}, {"type"=>"x-email", "url"=>"cfarley@intrinio.com"}, {"type"=>"x-email", "url"=>"admin@intrinio.com"}, {"type"=>"x-email", "url"=>"support@intrinio.com"}, {"type"=>"x-email", "url"=>"acarpenter@intrinio.com"}, {"type"=>"x-login", "url"=>"https://intrinio.com/login"}, {"type"=>"x-partners", "url"=>"https://intrinio.com/partners"}, {"type"=>"x-press", "url"=>"https://intrinio.com/press"}, {"type"=>"x-rate-limits", "url"=>"http://docs.intrinio.com/#limits"}, {"type"=>"x-selfservice-registration", "url"=>"https://intrinio.com/signup"}, {"type"=>"x-spreadsheets", "url"=>"http://docs.intrinio.com/#spreadsheet-add-ins"}, {"type"=>"x-support", "url"=>"https://intrinio.com/help"}, {"type"=>"x-tutorial", "url"=>"https://intrinio.com/tutorial/web_api"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/intrinio"}, {"type"=>"x-website", "url"=>"https://intrinio.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-device-farm{"aws-device-farm-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Device Farm", "x-complete"=>1, "info"=>{"title"=>"AWS Device Farm API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=CreateDevicePool"=>{"get"=>{"summary"=>"Create Device Pool", "description"=>"Creates a device pool.", "operationId"=>"createDevicePool", "x-api-path-slug"=>"actioncreatedevicepool-get", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"The device pools description", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"The device pools name", "type"=>"string"}, {"in"=>"query", "name"=>"projectArn", "description"=>"The ARN of the project for the device pool", "type"=>"string"}, {"in"=>"query", "name"=>"rules", "description"=>"The device pools rules", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device Pool"]}}, "/?Action=CreateProject"=>{"get"=>{"summary"=>"Create Project", "description"=>"Creates a new project.", "operationId"=>"createProject", "x-api-path-slug"=>"actioncreateproject-get", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"The projects name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project"]}}, "/?Action=CreateRemoteAccessSession"=>{"get"=>{"summary"=>"Create Remote Access Session", "description"=>"Specifies and starts a remote access session.", "operationId"=>"createRemoteAccessSession", "x-api-path-slug"=>"actioncreateremoteaccesssession-get", "parameters"=>[{"in"=>"query", "name"=>"configuration", "description"=>"The configuration information for the remote access session request", "type"=>"string"}, {"in"=>"query", "name"=>"deviceArn", "description"=>"The Amazon Resource Name (ARN) of the device for which you want to create a remote access session", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"The name of the remote access session that you wish to create", "type"=>"string"}, {"in"=>"query", "name"=>"projectArn", "description"=>"The Amazon Resource Name (ARN) of the project for which you want to create a remote access session", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remote Access Sessions"]}}, "/?Action=CreateUpload"=>{"get"=>{"summary"=>"Create Upload", "description"=>"Uploads an app or test scripts.", "operationId"=>"createUpload", "x-api-path-slug"=>"actioncreateupload-get", "parameters"=>[{"in"=>"query", "name"=>"contentType", "description"=>"The uploads content type (for example, application/octet-stream)", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"The uploads file name", "type"=>"string"}, {"in"=>"query", "name"=>"projectArn", "description"=>"The ARN of the project for the upload", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"The uploads upload type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload"]}}, "/?Action=DeleteDevicePool"=>{"get"=>{"summary"=>"Delete Device Pool", "description"=>"Deletes a device pool given the pool ARN.", "operationId"=>"deleteDevicePool", "x-api-path-slug"=>"actiondeletedevicepool-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"Represents the Amazon Resource Name (ARN) of the Device Farm device pool you wish to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device Pool"]}}, "/?Action=DeleteProject"=>{"get"=>{"summary"=>"Delete Project", "description"=>"Deletes an AWS Device Farm project, given the project ARN.", "operationId"=>"deleteProject", "x-api-path-slug"=>"actiondeleteproject-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"Represents the Amazon Resource Name (ARN) of the Device Farm project you wish to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/?Action=DeleteRemoteAccessSession"=>{"get"=>{"summary"=>"Delete Remote Access Session", "description"=>"Deletes a completed remote access session and its results.", "operationId"=>"deleteRemoteAccessSession", "x-api-path-slug"=>"actiondeleteremoteaccesssession-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The Amazon Resource Name (ARN) of the sesssion for which you want to delete remote access", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remote Access Sessions"]}}, "/?Action=DeleteRun"=>{"get"=>{"summary"=>"Delete Run", "description"=>"Deletes the run, given the run ARN.", "operationId"=>"deleteRun", "x-api-path-slug"=>"actiondeleterun-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The Amazon Resource Name (ARN) for the run you wish to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs"]}}, "/?Action=DeleteUpload"=>{"get"=>{"summary"=>"Delete Upload", "description"=>"Deletes an upload given the upload ARN.", "operationId"=>"deleteUpload", "x-api-path-slug"=>"actiondeleteupload-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"Represents the Amazon Resource Name (ARN) of the Device Farm upload you wish to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Uploads"]}}, "/?Action=GetAccountSettings"=>{"get"=>{"summary"=>"Get Account Settings", "description"=>"Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.", "operationId"=>"getAccountSettings", "x-api-path-slug"=>"actiongetaccountsettings-get", "parameters"=>[{"in"=>"query", "name"=>"accountSettings", "description"=>"A container for account-level settings within AWS Device Farm", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account Settings"]}}, "/?Action=GetDevice"=>{"get"=>{"summary"=>"Get Device", "description"=>"Gets information about a unique device type.", "operationId"=>"getDevice", "x-api-path-slug"=>"actiongetdevice-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The device types ARN", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/?Action=GetDevicePool"=>{"get"=>{"summary"=>"Get Device Pool", "description"=>"Gets information about a device pool.", "operationId"=>"getDevicePool", "x-api-path-slug"=>"actiongetdevicepool-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The device pools ARN", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device Pool"]}}, "/?Action=GetDevicePoolCompatibility"=>{"get"=>{"summary"=>"Get Device Pool Compatibility", "description"=>"Gets information about compatibility with a device pool.", "operationId"=>"getDevicePoolCompatibility", "x-api-path-slug"=>"actiongetdevicepoolcompatibility-get", "parameters"=>[{"in"=>"query", "name"=>"appArn", "description"=>"The ARN of the app that is associated with the specified device pool", "type"=>"string"}, {"in"=>"query", "name"=>"devicePoolArn", "description"=>"The device pools ARN", "type"=>"string"}, {"in"=>"query", "name"=>"testType", "description"=>"The test type for the specified device pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device Pool"]}}, "/?Action=GetJob"=>{"get"=>{"summary"=>"Get Job", "description"=>"Gets information about a job.", "operationId"=>"getJob", "x-api-path-slug"=>"actiongetjob-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The jobs ARN", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/?Action=GetOfferingStatus"=>{"get"=>{"summary"=>"Get Offering Status", "description"=>"Gets the current status and future status of all offerings purchased by an AWS account.", "operationId"=>"getOfferingStatus", "x-api-path-slug"=>"actiongetofferingstatus-get", "parameters"=>[{"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offering Status"]}}, "/?Action=GetProject"=>{"get"=>{"summary"=>"Get Project", "description"=>"Gets information about a project.", "operationId"=>"getProject", "x-api-path-slug"=>"actiongetproject-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The projects ARN", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/?Action=GetRemoteAccessSession"=>{"get"=>{"summary"=>"Get Remote Access Session", "description"=>"Returns a link to a currently running remote access session.", "operationId"=>"getRemoteAccessSession", "x-api-path-slug"=>"actiongetremoteaccesssession-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The Amazon Resource Name (ARN) of the remote access session about which you want to get session information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remote Access Sessions"]}}, "/?Action=GetRun"=>{"get"=>{"summary"=>"Get Run", "description"=>"Gets information about a run.", "operationId"=>"getRun", "x-api-path-slug"=>"actiongetrun-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The runs ARN", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs"]}}, "/?Action=GetSuite"=>{"get"=>{"summary"=>"Get Suite", "description"=>"Gets information about a suite.", "operationId"=>"getSuite", "x-api-path-slug"=>"actiongetsuite-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The suites ARN", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suites"]}}, "/?Action=GetTest"=>{"get"=>{"summary"=>"Get Test", "description"=>"Gets information about a test.", "operationId"=>"getTest", "x-api-path-slug"=>"actiongettest-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The tests ARN", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tests"]}}, "/?Action=GetUpload"=>{"get"=>{"summary"=>"Get Upload", "description"=>"Gets information about an upload.", "operationId"=>"getUpload", "x-api-path-slug"=>"actiongetupload-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The uploads ARN", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload"]}}, "/?Action=InstallToRemoteAccessSession"=>{"get"=>{"summary"=>"Install To Remote Access Session", "description"=>"Installs an application to the device in a remote access session.", "operationId"=>"installToRemoteAccessSession", "x-api-path-slug"=>"actioninstalltoremoteaccesssession-get", "parameters"=>[{"in"=>"query", "name"=>"appArn", "description"=>"The Amazon Resource Name (ARN) of the app about which you are requesting information", "type"=>"string"}, {"in"=>"query", "name"=>"remoteAccessSessionArn", "description"=>"The Amazon Resource Name (ARN) of the remote access session about which you are requesting information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remote Access Sessions"]}}, "/?Action=ListArtifacts"=>{"get"=>{"summary"=>"List Artifacts", "description"=>"Gets information about artifacts.", "operationId"=>"listArtifacts", "x-api-path-slug"=>"actionlistartifacts-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The Run, Job, Suite, or Test ARN", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"The artifacts type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Artifacts"]}}, "/?Action=ListDevicePools"=>{"get"=>{"summary"=>"List Device Pools", "description"=>"Gets information about device pools.", "operationId"=>"listDevicePools", "x-api-path-slug"=>"actionlistdevicepools-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The project ARN", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"The device pools type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device Pool"]}}, "/?Action=ListDevices"=>{"get"=>{"summary"=>"List Devices", "description"=>"Gets information about unique device types.", "operationId"=>"listDevices", "x-api-path-slug"=>"actionlistdevices-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The Amazon Resource Name (ARN) of the project", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devices"]}}, "/?Action=ListJobs"=>{"get"=>{"summary"=>"List Jobs", "description"=>"Gets information about jobs.", "operationId"=>"listJobs", "x-api-path-slug"=>"actionlistjobs-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The jobs ARNs", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/?Action=ListOfferings"=>{"get"=>{"summary"=>"List Offerings", "description"=>"Returns a list of products or offerings that the user can manage through the API.", "operationId"=>"listOfferings", "x-api-path-slug"=>"actionlistofferings-get", "parameters"=>[{"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offerings"]}}, "/?Action=ListOfferingTransactions"=>{"get"=>{"summary"=>"List Offering Transactions", "description"=>"Returns a list of all historical purchases, renewals, and system renewal transactions for an\n AWS account.", "operationId"=>"listOfferingTransactions", "x-api-path-slug"=>"actionlistofferingtransactions-get", "parameters"=>[{"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offering Transactions"]}}, "/?Action=ListProjects"=>{"get"=>{"summary"=>"List Projects", "description"=>"Gets information about projects.", "operationId"=>"listProjects", "x-api-path-slug"=>"actionlistprojects-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"Optional", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}, "/?Action=ListRemoteAccessSessions"=>{"get"=>{"summary"=>"List Remote Access Sessions", "description"=>"Returns a list of all currently running remote access sessions.", "operationId"=>"listRemoteAccessSessions", "x-api-path-slug"=>"actionlistremoteaccesssessions-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The Amazon Resource Name (ARN) of the remote access session about which you are requesting information", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remote Access Sessions"]}}, "/?Action=ListRuns"=>{"get"=>{"summary"=>"List Runs", "description"=>"Gets information about runs, given an AWS Device Farm project ARN.", "operationId"=>"listRuns", "x-api-path-slug"=>"actionlistruns-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The Amazon Resource Name (ARN) of the project for which you want to list runs", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs"]}}, "/?Action=ListSamples"=>{"get"=>{"summary"=>"List Samples", "description"=>"Gets information about samples, given an AWS Device Farm project ARN.", "operationId"=>"listSamples", "x-api-path-slug"=>"actionlistsamples-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The Amazon Resource Name (ARN) of the project for which you want to list samples", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Samples"]}}, "/?Action=ListSuites"=>{"get"=>{"summary"=>"List Suites", "description"=>"Gets information about suites.", "operationId"=>"listSuites", "x-api-path-slug"=>"actionlistsuites-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The suites ARNs", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suites"]}}, "/?Action=ListTests"=>{"get"=>{"summary"=>"List Tests", "description"=>"Gets information about tests.", "operationId"=>"listTests", "x-api-path-slug"=>"actionlisttests-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The tests ARNs", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tests"]}}, "/?Action=ListUniqueProblems"=>{"get"=>{"summary"=>"List Unique Problems", "description"=>"Gets information about unique problems.", "operationId"=>"listUniqueProblems", "x-api-path-slug"=>"actionlistuniqueproblems-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The unique problems ARNs", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unique Problems"]}}, "/?Action=ListUploads"=>{"get"=>{"summary"=>"List Uploads", "description"=>"Gets information about uploads, given an AWS Device Farm project ARN.", "operationId"=>"listUploads", "x-api-path-slug"=>"actionlistuploads-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The Amazon Resource Name (ARN) of the project for which you want to list uploads", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Uploads"]}}, "/?Action=PurchaseOffering"=>{"get"=>{"summary"=>"Purchase Offering", "description"=>"Immediately purchases offerings for an AWS account.", "operationId"=>"purchaseOffering", "x-api-path-slug"=>"actionpurchaseoffering-get", "parameters"=>[{"in"=>"query", "name"=>"offeringId", "description"=>"The ID of the offering", "type"=>"string"}, {"in"=>"query", "name"=>"quantity", "description"=>"The number of device slots you wish to purchase in an offering request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offerings"]}}, "/?Action=RenewOffering"=>{"get"=>{"summary"=>"Renew Offering", "description"=>"Explicitly sets the quantity of devices to renew for an offering, starting from the\n effectiveDate of the next period.", "operationId"=>"renewOffering", "x-api-path-slug"=>"actionrenewoffering-get", "parameters"=>[{"in"=>"query", "name"=>"offeringId", "description"=>"The ID of a request to renew an offering", "type"=>"string"}, {"in"=>"query", "name"=>"quantity", "description"=>"The quantity requested in an offering renewal", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Offerings"]}}, "/?Action=ScheduleRun"=>{"get"=>{"summary"=>"Schedule Run", "description"=>"Schedules a run.", "operationId"=>"scheduleRun", "x-api-path-slug"=>"actionschedulerun-get", "parameters"=>[{"in"=>"query", "name"=>"appArn", "description"=>"The ARN of the app to schedule a run", "type"=>"string"}, {"in"=>"query", "name"=>"configuration", "description"=>"Information about the settings for the run to be scheduled", "type"=>"string"}, {"in"=>"query", "name"=>"devicePoolArn", "description"=>"The ARN of the device pool for the run to be scheduled", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"The name for the run to be scheduled", "type"=>"string"}, {"in"=>"query", "name"=>"projectArn", "description"=>"The ARN of the project for the run to be scheduled", "type"=>"string"}, {"in"=>"query", "name"=>"test", "description"=>"Information about the test for the run to be scheduled", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs"]}}, "/?Action=StopRemoteAccessSession"=>{"get"=>{"summary"=>"Stop Remote Access Session", "description"=>"Ends a specified remote access session.", "operationId"=>"stopRemoteAccessSession", "x-api-path-slug"=>"actionstopremoteaccesssession-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The Amazon Resource Name (ARN) of the remote access session you wish to stop", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Remote Access Sessions"]}}, "/?Action=StopRun"=>{"get"=>{"summary"=>"Stop Run", "description"=>"Initiates a stop request for the current test run.", "operationId"=>"stopRun", "x-api-path-slug"=>"actionstoprun-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"Represents the Amazon Resource Name (ARN) of the Device Farm run you wish to stop", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Runs"]}}, "/?Action=UpdateDevicePool"=>{"get"=>{"summary"=>"Update Device Pool", "description"=>"Modifies the name, description, and rules in a device pool given the attributes and the pool ARN.", "operationId"=>"updateDevicePool", "x-api-path-slug"=>"actionupdatedevicepool-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update", "type"=>"string"}, {"in"=>"query", "name"=>"description", "description"=>"A description of the device pool you wish to update", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"A string representing the name of the device pool you wish to update", "type"=>"string"}, {"in"=>"query", "name"=>"rules", "description"=>"Represents the rules you wish to modify for the device pool", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Device Pool"]}}, "/?Action=UpdateProject"=>{"get"=>{"summary"=>"Update Project", "description"=>"Modifies the specified project name, given the project ARN and a new name.", "operationId"=>"updateProject", "x-api-path-slug"=>"actionupdateproject-get", "parameters"=>[{"in"=>"query", "name"=>"arn", "description"=>"The Amazon Resource Name (ARN) of the project whose name you wish to update", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"A string representing the new name of the project that you are updating", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Projects"]}}}}, "apis"=>{"name"=>"AWS Device Farm", "x-slug"=>"aws-device-farm", "description"=>"AWS Device Farm is an app testing service that lets you test and interact with your Android, iOS, and web apps on many devices at once, or reproduce issues on a device in real time. View video, screenshots, logs, and performance data to pinpoint and fix issues before shipping your app.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Mobile-Services_AWSDeviceFarm.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-device-farm/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Device Farm API", "x-api-slug"=>"aws-device-farm-api", "description"=>"AWS Device Farm is an app testing service that lets you test and interact with your Android, iOS, and web apps on many devices at once, or reproduce issues on a device in real time. View video, screenshots, logs, and performance data to pinpoint and fix issues before shipping your app.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Mobile-Services_AWSDeviceFarm.png", "humanURL"=>"https://aws.amazon.com/device-farm/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-device-farm/aws-device-farm-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://aws.amazon.com/blogs/mobile/tag/aws-device-farm/"}, {"type"=>"x-concepts", "url"=>"https://docs.aws.amazon.com/devicefarm/latest/developerguide/concepts.html"}, {"type"=>"x-documentation", "url"=>"https://docs.aws.amazon.com/devicefarm/latest/developerguide/api-ref.html"}, {"type"=>"x-documentation", "url"=>"https://docs.aws.amazon.com/devicefarm/latest/developerguide/cli-ref.html"}, {"type"=>"x-limits", "url"=>"https://docs.aws.amazon.com/devicefarm/latest/developerguide/limits.html"}, {"type"=>"x-logging", "url"=>"https://docs.aws.amazon.com/devicefarm/latest/developerguide/cloudtrail.html"}, {"type"=>"x-plugins", "url"=>"https://github.com/awslabs?q=aws-device-farm"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/device-farm/faq"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/device-farm/pricing"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/device-farm/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-app-engine{"google-app-engine-admin-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google App Engine", "x-complete"=>1, "info"=>{"title"=>"Google App Engine Admin", "description"=>"provisions-and-manages-app-engine-applications-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"appengine.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/apps"=>{"post"=>{"summary"=>"Create App", "description"=>"Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).", "operationId"=>"appengine.apps.create", "x-api-path-slug"=>"v1apps-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}}, "/v1/apps/{appsId}"=>{"get"=>{"summary"=>"Get App", "description"=>"Gets information about an application.", "operationId"=>"appengine.apps.get", "x-api-path-slug"=>"v1appsappsid-get", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `name`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}, "patch"=>{"summary"=>"Update App", "description"=>"Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application.", "operationId"=>"appengine.apps.patch", "x-api-path-slug"=>"v1appsappsid-patch", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `name`"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"updateMask", "description"=>"Standard field mask for the set of fields to be updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application"]}}, "/v1/apps/{appsId}/locations"=>{"get"=>{"summary"=>"Get App Locations", "description"=>"Lists information about the supported locations for this service.", "operationId"=>"appengine.apps.locations.list", "x-api-path-slug"=>"v1appsappsidlocations-get", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `name`"}, {"in"=>"query", "name"=>"filter", "description"=>"The standard list filter"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The standard list page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The standard list page token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Location"]}}, "/v1/apps/{appsId}/locations/{locationsId}"=>{"get"=>{"summary"=>"Get App Location", "description"=>"Get information about a location.", "operationId"=>"appengine.apps.locations.get", "x-api-path-slug"=>"v1appsappsidlocationslocationsid-get", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `name`"}, {"in"=>"path", "name"=>"locationsId", "description"=>"Part of `name`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Location"]}}, "/v1/apps/{appsId}/operations"=>{"get"=>{"summary"=>"Get Operations", "description"=>"Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations.", "operationId"=>"appengine.apps.operations.list", "x-api-path-slug"=>"v1appsappsidoperations-get", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `name`"}, {"in"=>"query", "name"=>"filter", "description"=>"The standard list filter"}, {"in"=>"query", "name"=>"pageSize", "description"=>"The standard list page size"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The standard list page token"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/v1/apps/{appsId}/operations/{operationsId}"=>{"get"=>{"summary"=>"Get State", "description"=>"Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "operationId"=>"appengine.apps.operations.get", "x-api-path-slug"=>"v1appsappsidoperationsoperationsid-get", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `name`"}, {"in"=>"path", "name"=>"operationsId", "description"=>"Part of `name`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["State"]}}, "/v1/apps/{appsId}/services"=>{"get"=>{"summary"=>"Get Services", "description"=>"Lists all the services in the application.", "operationId"=>"appengine.apps.services.list", "x-api-path-slug"=>"v1appsappsidservices-get", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `parent`"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Maximum results to return per page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Continuation token for fetching the next page of results"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service"]}}, "/v1/apps/{appsId}/services/{servicesId}"=>{"delete"=>{"summary"=>"Delete Service", "description"=>"Deletes the specified service and all enclosed versions.", "operationId"=>"appengine.apps.services.delete", "x-api-path-slug"=>"v1appsappsidservicesservicesid-delete", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `name`"}, {"in"=>"path", "name"=>"servicesId", "description"=>"Part of `name`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service"]}, "get"=>{"summary"=>"Get Configuration", "description"=>"Gets the current configuration of the specified service.", "operationId"=>"appengine.apps.services.get", "x-api-path-slug"=>"v1appsappsidservicesservicesid-get", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `name`"}, {"in"=>"path", "name"=>"servicesId", "description"=>"Part of `name`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration"]}, "patch"=>{"summary"=>"Update Configuration", "description"=>"Updates the configuration of the specified service.", "operationId"=>"appengine.apps.services.patch", "x-api-path-slug"=>"v1appsappsidservicesservicesid-patch", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `name`"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"migrateTraffic", "description"=>"Set to true to gradually shift traffic to one or more versions that you specify"}, {"in"=>"path", "name"=>"servicesId", "description"=>"Part of `name`"}, {"in"=>"query", "name"=>"updateMask", "description"=>"Standard field mask for the set of fields to be updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration"]}}, "/v1/apps/{appsId}/services/{servicesId}/versions"=>{"get"=>{"summary"=>"Get Versions", "description"=>"Lists the versions of a service.", "operationId"=>"appengine.apps.services.versions.list", "x-api-path-slug"=>"v1appsappsidservicesservicesidversions-get", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `parent`"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Maximum results to return per page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Continuation token for fetching the next page of results"}, {"in"=>"path", "name"=>"servicesId", "description"=>"Part of `parent`"}, {"in"=>"query", "name"=>"view", "description"=>"Controls the set of fields returned in the List response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version"]}, "post"=>{"summary"=>"Deploy Version", "description"=>"Deploys code and resource files to a new version.", "operationId"=>"appengine.apps.services.versions.create", "x-api-path-slug"=>"v1appsappsidservicesservicesidversions-post", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `parent`"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"servicesId", "description"=>"Part of `parent`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version"]}}, "/v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}"=>{"delete"=>{"summary"=>"Delete Version", "description"=>"Deletes an existing Version resource.", "operationId"=>"appengine.apps.services.versions.delete", "x-api-path-slug"=>"v1appsappsidservicesservicesidversionsversionsid-delete", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `name`"}, {"in"=>"path", "name"=>"servicesId", "description"=>"Part of `name`"}, {"in"=>"path", "name"=>"versionsId", "description"=>"Part of `name`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version"]}, "get"=>{"summary"=>"Get Version", "description"=>"Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.", "operationId"=>"appengine.apps.services.versions.get", "x-api-path-slug"=>"v1appsappsidservicesservicesidversionsversionsid-get", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `name`"}, {"in"=>"path", "name"=>"servicesId", "description"=>"Part of `name`"}, {"in"=>"path", "name"=>"versionsId", "description"=>"Part of `name`"}, {"in"=>"query", "name"=>"view", "description"=>"Controls the set of fields returned in the Get response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version"]}, "patch"=>{"summary"=>"Update Version", "description"=>"Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.", "operationId"=>"appengine.apps.services.versions.patch", "x-api-path-slug"=>"v1appsappsidservicesservicesidversionsversionsid-patch", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `name`"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"servicesId", "description"=>"Part of `name`"}, {"in"=>"query", "name"=>"updateMask", "description"=>"Standard field mask for the set of fields to be updated"}, {"in"=>"path", "name"=>"versionsId", "description"=>"Part of `name`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version"]}}, "/v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances"=>{"get"=>{"summary"=>"Get Instances", "description"=>"Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).", "operationId"=>"appengine.apps.services.versions.instances.list", "x-api-path-slug"=>"v1appsappsidservicesservicesidversionsversionsidinstances-get", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `parent`"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Maximum results to return per page"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Continuation token for fetching the next page of results"}, {"in"=>"path", "name"=>"servicesId", "description"=>"Part of `parent`"}, {"in"=>"path", "name"=>"versionsId", "description"=>"Part of `parent`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"=>{"delete"=>{"summary"=>"Stop Instance", "description"=>"Stops a running instance.", "operationId"=>"appengine.apps.services.versions.instances.delete", "x-api-path-slug"=>"v1appsappsidservicesservicesidversionsversionsidinstancesinstancesid-delete", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `name`"}, {"in"=>"path", "name"=>"instancesId", "description"=>"Part of `name`"}, {"in"=>"path", "name"=>"servicesId", "description"=>"Part of `name`"}, {"in"=>"path", "name"=>"versionsId", "description"=>"Part of `name`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}, "get"=>{"summary"=>"Get Instance", "description"=>"Gets instance information.", "operationId"=>"appengine.apps.services.versions.instances.get", "x-api-path-slug"=>"v1appsappsidservicesservicesidversionsversionsidinstancesinstancesid-get", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `name`"}, {"in"=>"path", "name"=>"instancesId", "description"=>"Part of `name`"}, {"in"=>"path", "name"=>"servicesId", "description"=>"Part of `name`"}, {"in"=>"path", "name"=>"versionsId", "description"=>"Part of `name`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug"=>{"post"=>{"summary"=>"Enable Debugging", "description"=>"Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.", "operationId"=>"appengine.apps.services.versions.instances.debug", "x-api-path-slug"=>"v1appsappsidservicesservicesidversionsversionsidinstancesinstancesiddebug-post", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `name`"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instancesId", "description"=>"Part of `name`"}, {"in"=>"path", "name"=>"servicesId", "description"=>"Part of `name`"}, {"in"=>"path", "name"=>"versionsId", "description"=>"Part of `name`"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Debugging"]}}, "/v1/apps/{appsId}:repair"=>{"post"=>{"summary"=>"Repair App", "description"=>"Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.", "operationId"=>"appengine.apps.repair", "x-api-path-slug"=>"v1appsappsidrepair-post", "parameters"=>[{"in"=>"path", "name"=>"appsId", "description"=>"Part of `name`"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App"]}}}}, "apis"=>{"name"=>"Google App Engine", "x-slug"=>"google-app-engine", "description"=>"Build modern web and mobile applications on an open cloud platform: bring your own language runtimes, frameworks, and third party libraries. Google App Engine is a fully managed platform that completely abstracts away infrastructure so you focus only on code. Go from zero to planet-scale and see why some of today’s most successful companies power their applications on App Engine.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-app-engine-icon.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Cloud,Compute,Deployments,Google APIs,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-app-engine/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google App Engine Admin API", "x-api-slug"=>"google-app-engine-admin-api", "description"=>"Use this RESTful API with any programming language to manage your App Engine applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-app-engine-icon.png", "humanURL"=>"https://cloud.google.com/appengine/", "baseURL"=>"://appengine.googleapis.com//", "tags"=>"API Provider,API Service Provider,Cloud,Compute,Deployments,Google APIs,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-app-engine/google-app-engine-admin-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-code-page", "url"=>"https://cloud.google.com/appengine/docs/admin-api/client-libraries"}, {"type"=>"x-developer", "url"=>"https://cloud.google.com/appengine/docs/admin-api/"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/appengine/docs/admin-api/apis"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/appengine/docs/admin-api/getting-started/"}, {"type"=>"x-how-to-guides", "url"=>"https://cloud.google.com/appengine/docs/admin-api/how-to"}, {"type"=>"x-launcher", "url"=>"https://cloud.google.com/launcher/"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/pricing/"}, {"type"=>"x-sla", "url"=>"https://cloud.google.com/appengine/sla"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/appengine/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-elastic-beanstalk{"aws-elastic-beanstalk-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Elastic Beanstalk", "x-complete"=>1, "info"=>{"title"=>"AWS Elastic Beanstalk API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AbortEnvironmentUpdate"=>{"get"=>{"summary"=>"Abort Environment Update", "description"=>"Cancels in-progress environment configuration update or application version\n deployment.", "operationId"=>"abortEnvironmentUpdate", "x-api-path-slug"=>"actionabortenvironmentupdate-get", "parameters"=>[{"in"=>"query", "name"=>"EnvironmentId", "description"=>"This specifies the ID of the environment with the in-progress update that you want to cancel", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"This specifies the name of the environment with the in-progress update that you want to cancel", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/?Action=ApplyEnvironmentManagedAction"=>{"get"=>{"summary"=>"Apply Environment Managed Action", "description"=>"Applies a scheduled managed action immediately.", "operationId"=>"applyEnvironmentManagedAction", "x-api-path-slug"=>"actionapplyenvironmentmanagedaction-get", "parameters"=>[{"in"=>"query", "name"=>"ActionId", "description"=>"The action ID of the scheduled managed action to execute", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentId", "description"=>"The environment ID of the target environment", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"The name of the target environment", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/?Action=CheckDNSAvailability"=>{"get"=>{"summary"=>"Check D N S Availability", "description"=>"Checks if the specified CNAME is available.", "operationId"=>"checkDNSAvailability", "x-api-path-slug"=>"actioncheckdnsavailability-get", "parameters"=>[{"in"=>"query", "name"=>"CNAMEPrefix", "description"=>"The prefix used when this CNAME is reserved", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DNS"]}}, "/?Action=ComposeEnvironments"=>{"get"=>{"summary"=>"Compose Environments", "description"=>"Create or update a group of environments that each run a separate component of a single\n application.", "operationId"=>"composeEnvironments", "x-api-path-slug"=>"actioncomposeenvironments-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The name of the application to which the specified source bundles belong", "type"=>"string"}, {"in"=>"query", "name"=>"GroupName", "description"=>"The name of the group to which the target environments belong", "type"=>"string"}, {"in"=>"query", "name"=>"VersionLabels.member.N", "description"=>"A list of version labels, specifying one or more application source bundles that belong to the target application", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/?Action=CreateApplication"=>{"get"=>{"summary"=>"Create Application", "description"=>"Creates an application that has one configuration template named default\n and no application versions.", "operationId"=>"createApplication", "x-api-path-slug"=>"actioncreateapplication-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The name of the application", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"Describes the application", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceLifecycleConfig", "description"=>"Specify an application resource lifecycle configuration to prevent your application from accumulating too many versions", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=CreateApplicationVersion"=>{"get"=>{"summary"=>"Create Application Version", "description"=>"Creates an application version for the specified application.", "operationId"=>"createApplicationVersion", "x-api-path-slug"=>"actioncreateapplicationversion-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The name of the application", "type"=>"string"}, {"in"=>"query", "name"=>"AutoCreateApplication", "description"=>"Set to true to create an application with the specified name if it doesnt already exist", "type"=>"string"}, {"in"=>"query", "name"=>"BuildConfiguration", "description"=>"Settings for an AWS CodeBuild build", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"Describes this version", "type"=>"string"}, {"in"=>"query", "name"=>"Process", "description"=>"Preprocesses and validates the environment manifest and configuration files in the source bundle", "type"=>"string"}, {"in"=>"query", "name"=>"SourceBuildInformation", "description"=>"Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version", "type"=>"string"}, {"in"=>"query", "name"=>"SourceBundle", "description"=>"The Amazon S3 bucket and key that identify the location of the source bundle for this version", "type"=>"string"}, {"in"=>"query", "name"=>"VersionLabel", "description"=>"A label identifying this version", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=CreateConfigurationTemplate"=>{"get"=>{"summary"=>"Create Configuration Template", "description"=>"Creates a configuration template.", "operationId"=>"createConfigurationTemplate", "x-api-path-slug"=>"actioncreateconfigurationtemplate-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The name of the application to associate with this configuration template", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"Describes this configuration", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentId", "description"=>"The ID of the environment used with this configuration template", "type"=>"string"}, {"in"=>"query", "name"=>"OptionSettings.member.N", "description"=>"If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value", "type"=>"string"}, {"in"=>"query", "name"=>"SolutionStackName", "description"=>"The name of the solution stack used by this configuration", "type"=>"string"}, {"in"=>"query", "name"=>"SourceConfiguration", "description"=>"If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateName", "description"=>"The name of the configuration template", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Templates"]}}, "/?Action=CreateEnvironment"=>{"get"=>{"summary"=>"Create Environment", "description"=>"Launches an environment for the specified application using the specified\n configuration.", "operationId"=>"createEnvironment", "x-api-path-slug"=>"actioncreateenvironment-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The name of the application that contains the version to be deployed", "type"=>"string"}, {"in"=>"query", "name"=>"CNAMEPrefix", "description"=>"If specified, the environment attempts to use this value as the prefix for the CNAME", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"Describes this environment", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"A unique name for the deployment environment", "type"=>"string"}, {"in"=>"query", "name"=>"GroupName", "description"=>"The name of the group to which the target environment belongs", "type"=>"string"}, {"in"=>"query", "name"=>"OptionSettings.member.N", "description"=>"If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment", "type"=>"string"}, {"in"=>"query", "name"=>"OptionsToRemove.member.N", "description"=>"A list of custom user-defined configuration options to remove from the configuration set for this new environment", "type"=>"string"}, {"in"=>"query", "name"=>"SolutionStackName", "description"=>"This is an alternative to specifying a template name", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.member.N", "description"=>"This specifies the tags applied to resources in the environment", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateName", "description"=>"The name of the configuration template to use in deployment", "type"=>"string"}, {"in"=>"query", "name"=>"Tier", "description"=>"This specifies the tier to use for creating this environment", "type"=>"string"}, {"in"=>"query", "name"=>"VersionLabel", "description"=>"The name of the application version to deploy", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/?Action=CreateStorageLocation"=>{"get"=>{"summary"=>"Create Storage Location", "description"=>"Creates the Amazon S3 storage location for the account.", "operationId"=>"createStorageLocation", "x-api-path-slug"=>"actioncreatestoragelocation-get", "parameters"=>[{"in"=>"query", "name"=>"S3Bucket", "description"=>"The name of the Amazon S3 bucket created", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Storage Location"]}}, "/?Action=DeleteApplication"=>{"get"=>{"summary"=>"Delete Application", "description"=>"Deletes the specified application along with all associated versions and\n configurations.", "operationId"=>"deleteApplication", "x-api-path-slug"=>"actiondeleteapplication-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The name of the application to delete", "type"=>"string"}, {"in"=>"query", "name"=>"TerminateEnvByForce", "description"=>"When set to true, running environments will be terminated before deleting the application", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=DeleteApplicationVersion"=>{"get"=>{"summary"=>"Delete Application Version", "description"=>"Deletes the specified version from the specified application.", "operationId"=>"deleteApplicationVersion", "x-api-path-slug"=>"actiondeleteapplicationversion-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The name of the application to which the version belongs", "type"=>"string"}, {"in"=>"query", "name"=>"DeleteSourceBundle", "description"=>"Set to true to delete the source bundle from your storage bucket", "type"=>"string"}, {"in"=>"query", "name"=>"VersionLabel", "description"=>"The label of the version to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Version"]}}, "/?Action=DeleteConfigurationTemplate"=>{"get"=>{"summary"=>"Delete Configuration Template", "description"=>"Deletes the specified configuration template.", "operationId"=>"deleteConfigurationTemplate", "x-api-path-slug"=>"actiondeleteconfigurationtemplate-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The name of the application to delete the configuration template from", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateName", "description"=>"The name of the configuration template to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Templates"]}}, "/?Action=DeleteEnvironmentConfiguration"=>{"get"=>{"summary"=>"Delete Environment Configuration", "description"=>"Deletes the draft configuration associated with the running environment.", "operationId"=>"deleteEnvironmentConfiguration", "x-api-path-slug"=>"actiondeleteenvironmentconfiguration-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The name of the application the environment is associated with", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"The name of the environment to delete the draft configuration from", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/?Action=DescribeApplications"=>{"get"=>{"summary"=>"Describe Applications", "description"=>"Returns the descriptions of existing applications.", "operationId"=>"describeApplications", "x-api-path-slug"=>"actiondescribeapplications-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationNames.member.N", "description"=>"If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=DescribeApplicationVersions"=>{"get"=>{"summary"=>"Describe Application Versions", "description"=>"Retrieve a list of application versions.", "operationId"=>"describeApplicationVersions", "x-api-path-slug"=>"actiondescribeapplicationversions-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"Specify an application name to show only application versions for that application", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"Specify a maximum number of application versions to paginate in the request", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"Specify a next token to retrieve the next page in a paginated request", "type"=>"string"}, {"in"=>"query", "name"=>"VersionLabels.member.N", "description"=>"Specify a version label to show a specific application version", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Version"]}}, "/?Action=DescribeConfigurationOptions"=>{"get"=>{"summary"=>"Describe Configuration Options", "description"=>"Describes the configuration options that are used in a particular configuration\n template or environment, or that a specified solution stack defines.", "operationId"=>"describeConfigurationOptions", "x-api-path-slug"=>"actiondescribeconfigurationoptions-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The name of the application associated with the configuration template or environment", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"The name of the environment whose configuration options you want to describe", "type"=>"string"}, {"in"=>"query", "name"=>"Options.member.N", "description"=>"If specified, restricts the descriptions to only the specified options", "type"=>"string"}, {"in"=>"query", "name"=>"SolutionStackName", "description"=>"The name of the solution stack whose configuration options you want to describe", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateName", "description"=>"The name of the configuration template whose configuration options you want to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ConfigurationOptions"]}}, "/?Action=DescribeConfigurationSettings"=>{"get"=>{"summary"=>"Describe Configuration Settings", "description"=>"Returns a description of the settings for the specified configuration set, that is,\n either a configuration template or the configuration set associated with a running\n environment.", "operationId"=>"describeConfigurationSettings", "x-api-path-slug"=>"actiondescribeconfigurationsettings-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The application for the environment or configuration template", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"The name of the environment to describe", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateName", "description"=>"The name of the configuration template to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Settings"]}}, "/?Action=DescribeEnvironmentHealth"=>{"get"=>{"summary"=>"Describe Environment Health", "description"=>"Returns information about the overall health of the specified environment.", "operationId"=>"describeEnvironmentHealth", "x-api-path-slug"=>"actiondescribeenvironmenthealth-get", "parameters"=>[{"in"=>"query", "name"=>"AttributeNames.member.N", "description"=>"Specify the response elements to return", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentId", "description"=>"Specify the environment by ID", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"Specify the environment by name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/?Action=DescribeEnvironmentManagedActionHistory"=>{"get"=>{"summary"=>"Describe Environment Managed Action History", "description"=>"Lists an environment's completed and failed managed actions.", "operationId"=>"describeEnvironmentManagedActionHistory", "x-api-path-slug"=>"actiondescribeenvironmentmanagedactionhistory-get", "parameters"=>[{"in"=>"query", "name"=>"EnvironmentId", "description"=>"The environment ID of the target environment", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"The name of the target environment", "type"=>"string"}, {"in"=>"query", "name"=>"MaxItems", "description"=>"The maximum number of items to return for a single request", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"The pagination token returned by a previous request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/?Action=DescribeEnvironmentManagedActions"=>{"get"=>{"summary"=>"Describe Environment Managed Actions", "description"=>"Lists an environment's upcoming and in-progress managed actions.", "operationId"=>"describeEnvironmentManagedActions", "x-api-path-slug"=>"actiondescribeenvironmentmanagedactions-get", "parameters"=>[{"in"=>"query", "name"=>"EnvironmentId", "description"=>"The environment ID of the target environment", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"The name of the target environment", "type"=>"string"}, {"in"=>"query", "name"=>"Status", "description"=>"To show only actions with a particular status, specify a status", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/?Action=DescribeEnvironmentResources"=>{"get"=>{"summary"=>"Describe Environment Resources", "description"=>"Returns AWS resources for this environment.", "operationId"=>"describeEnvironmentResources", "x-api-path-slug"=>"actiondescribeenvironmentresources-get", "parameters"=>[{"in"=>"query", "name"=>"EnvironmentId", "description"=>"The ID of the environment to retrieve AWS resource usage data", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"The name of the environment to retrieve AWS resource usage data", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/?Action=DescribeEnvironments"=>{"get"=>{"summary"=>"Describe Environments", "description"=>"Returns descriptions for existing environments.", "operationId"=>"describeEnvironments", "x-api-path-slug"=>"actiondescribeenvironments-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentIds.member.N", "description"=>"If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentNames.member.N", "description"=>"If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names", "type"=>"string"}, {"in"=>"query", "name"=>"IncludedDeletedBackTo", "description"=>"If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed", "type"=>"string"}, {"in"=>"query", "name"=>"IncludeDeleted", "description"=>"Indicates whether to include deleted environments:", "type"=>"string"}, {"in"=>"query", "name"=>"VersionLabel", "description"=>"If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/?Action=DescribeEvents"=>{"get"=>{"summary"=>"Describe Events", "description"=>"Returns list of event descriptions matching criteria up to the last 6 weeks.", "operationId"=>"describeEvents", "x-api-path-slug"=>"actiondescribeevents-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application", "type"=>"string"}, {"in"=>"query", "name"=>"EndTime", "description"=>"If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentId", "description"=>"If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"Specifies the maximum number of events that can be returned, beginning with the most recent event", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"Pagination token", "type"=>"string"}, {"in"=>"query", "name"=>"RequestId", "description"=>"If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID", "type"=>"string"}, {"in"=>"query", "name"=>"Severity", "description"=>"If specified, limits the events returned from this call to include only those with the specified severity or higher", "type"=>"string"}, {"in"=>"query", "name"=>"StartTime", "description"=>"If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateName", "description"=>"If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration", "type"=>"string"}, {"in"=>"query", "name"=>"VersionLabel", "description"=>"If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/?Action=DescribeInstancesHealth"=>{"get"=>{"summary"=>"Describe Instances Health", "description"=>"Retrives detailed information about the health of instances in your AWS Elastic\n Beanstalk.", "operationId"=>"describeInstancesHealth", "x-api-path-slug"=>"actiondescribeinstanceshealth-get", "parameters"=>[{"in"=>"query", "name"=>"AttributeNames.member.N", "description"=>"Specifies the response elements you wish to receive", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentId", "description"=>"Specify the AWS Elastic Beanstalk environment by ID", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"Specify the AWS Elastic Beanstalk environment by name", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"Specify the pagination token returned by a previous call", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances Health"]}}, "/?Action=ListAvailableSolutionStacks"=>{"get"=>{"summary"=>"List Available Solution Stacks", "description"=>"Returns a list of the available solution stack names.", "operationId"=>"listAvailableSolutionStacks", "x-api-path-slug"=>"actionlistavailablesolutionstacks-get", "parameters"=>[{"in"=>"query", "name"=>"SolutionStackDetails.member.N", "description"=>"A list of available solution stacks and their SolutionStackDescription", "type"=>"string"}, {"in"=>"query", "name"=>"SolutionStacks.member.N", "description"=>"A list of available solution stacks", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Solution Stacks"]}}, "/?Action=RebuildEnvironment"=>{"get"=>{"summary"=>"Rebuild Environment", "description"=>"Deletes and recreates all of the AWS resources (for example: the Auto Scaling group,\n load balancer, etc.", "operationId"=>"rebuildEnvironment", "x-api-path-slug"=>"actionrebuildenvironment-get", "parameters"=>[{"in"=>"query", "name"=>"EnvironmentId", "description"=>"The ID of the environment to rebuild", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"The name of the environment to rebuild", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/?Action=RequestEnvironmentInfo"=>{"get"=>{"summary"=>"Request Environment Info", "description"=>"Initiates a request to compile the specified type of information of the deployed\n environment.", "operationId"=>"requestEnvironmentInfo", "x-api-path-slug"=>"actionrequestenvironmentinfo-get", "parameters"=>[{"in"=>"query", "name"=>"EnvironmentId", "description"=>"The ID of the environment of the requested data", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"The name of the environment of the requested data", "type"=>"string"}, {"in"=>"query", "name"=>"InfoType", "description"=>"The type of information to request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/?Action=RestartAppServer"=>{"get"=>{"summary"=>"Restart App Server", "description"=>"Causes the environment to restart the application container server running on each\n Amazon EC2 instance.", "operationId"=>"restartAppServer", "x-api-path-slug"=>"actionrestartappserver-get", "parameters"=>[{"in"=>"query", "name"=>"EnvironmentId", "description"=>"The ID of the environment to restart the server for", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"The name of the environment to restart the server for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App Servers"]}}, "/?Action=RetrieveEnvironmentInfo"=>{"get"=>{"summary"=>"Retrieve Environment Info", "description"=>"Retrieves the compiled information from a.", "operationId"=>"retrieveEnvironmentInfo", "x-api-path-slug"=>"actionretrieveenvironmentinfo-get", "parameters"=>[{"in"=>"query", "name"=>"EnvironmentId", "description"=>"The ID of the datas environment", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"The name of the datas environment", "type"=>"string"}, {"in"=>"query", "name"=>"InfoType", "description"=>"The type of information to retrieve", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/?Action=SwapEnvironmentCNAMEs"=>{"get"=>{"summary"=>"Swap Environment C N A M Es", "description"=>"Swaps the CNAMEs of two environments.", "operationId"=>"swapEnvironmentCNAMEs", "x-api-path-slug"=>"actionswapenvironmentcnames-get", "parameters"=>[{"in"=>"query", "name"=>"DestinationEnvironmentId", "description"=>"The ID of the destination environment", "type"=>"string"}, {"in"=>"query", "name"=>"DestinationEnvironmentName", "description"=>"The name of the destination environment", "type"=>"string"}, {"in"=>"query", "name"=>"SourceEnvironmentId", "description"=>"The ID of the source environment", "type"=>"string"}, {"in"=>"query", "name"=>"SourceEnvironmentName", "description"=>"The name of the source environment", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/?Action=TerminateEnvironment"=>{"get"=>{"summary"=>"Terminate Environment", "description"=>"Terminates the specified environment.", "operationId"=>"terminateEnvironment", "x-api-path-slug"=>"actionterminateenvironment-get", "parameters"=>[{"in"=>"query", "name"=>"EnvironmentId", "description"=>"The ID of the environment to terminate", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"The name of the environment to terminate", "type"=>"string"}, {"in"=>"query", "name"=>"ForceTerminate", "description"=>"Terminates the target environment even if another environment in the same group is dependent on it", "type"=>"string"}, {"in"=>"query", "name"=>"TerminateResources", "description"=>"Indicates whether the associated AWS resources should shut down when the environment is terminated:", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/?Action=UpdateApplication"=>{"get"=>{"summary"=>"Update Application", "description"=>"Updates the specified application to have the specified properties.", "operationId"=>"updateApplication", "x-api-path-slug"=>"actionupdateapplication-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The name of the application to update", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A new description for the application", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=UpdateApplicationResourceLifecycle"=>{"get"=>{"summary"=>"Update Application Resource Lifecycle", "description"=>"Modifies lifecycle settings for an application.", "operationId"=>"updateApplicationResourceLifecycle", "x-api-path-slug"=>"actionupdateapplicationresourcelifecycle-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The name of the application", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceLifecycleConfig", "description"=>"The lifecycle configuration", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Application Resource Lifecycle"]}}, "/?Action=UpdateApplicationVersion"=>{"get"=>{"summary"=>"Update Application Version", "description"=>"Updates the specified application version to have the specified properties.", "operationId"=>"updateApplicationVersion", "x-api-path-slug"=>"actionupdateapplicationversion-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The name of the application associated with this version", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A new description for this version", "type"=>"string"}, {"in"=>"query", "name"=>"VersionLabel", "description"=>"The name of the version to update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/?Action=UpdateConfigurationTemplate"=>{"get"=>{"summary"=>"Update Configuration Template", "description"=>"Updates the specified configuration template to have the specified properties or\n configuration option values.", "operationId"=>"updateConfigurationTemplate", "x-api-path-slug"=>"actionupdateconfigurationtemplate-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The name of the application associated with the configuration template to update", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A new description for the configuration", "type"=>"string"}, {"in"=>"query", "name"=>"OptionSettings.member.N", "description"=>"A list of configuration option settings to update with the new specified option value", "type"=>"string"}, {"in"=>"query", "name"=>"OptionsToRemove.member.N", "description"=>"A list of configuration options to remove from the configuration set", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateName", "description"=>"The name of the configuration template to update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Templates"]}}, "/?Action=UpdateEnvironment"=>{"get"=>{"summary"=>"Update Environment", "description"=>"Updates the environment description, deploys a new application version, updates the\n configuration settings to an entirely new configuration template, or updates select\n configuration option values in the running environment.", "operationId"=>"updateEnvironment", "x-api-path-slug"=>"actionupdateenvironment-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The name of the application with which the environment is associated", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentId", "description"=>"The ID of the environment to update", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"The name of the environment to update", "type"=>"string"}, {"in"=>"query", "name"=>"GroupName", "description"=>"The name of the group to which the target environment belongs", "type"=>"string"}, {"in"=>"query", "name"=>"OptionSettings.member.N", "description"=>"If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value", "type"=>"string"}, {"in"=>"query", "name"=>"OptionsToRemove.member.N", "description"=>"A list of custom user-defined configuration options to remove from the configuration set for this environment", "type"=>"string"}, {"in"=>"query", "name"=>"SolutionStackName", "description"=>"This specifies the platform version that the environment will run after the environment is updated", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateName", "description"=>"If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment", "type"=>"string"}, {"in"=>"query", "name"=>"Tier", "description"=>"This specifies the tier to use to update the environment", "type"=>"string"}, {"in"=>"query", "name"=>"VersionLabel", "description"=>"If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Environments"]}}, "/?Action=ValidateConfigurationSettings"=>{"get"=>{"summary"=>"Validate Configuration Settings", "description"=>"Takes a set of configuration settings and either a configuration template or\n environment, and determines whether those values are valid.", "operationId"=>"validateConfigurationSettings", "x-api-path-slug"=>"actionvalidateconfigurationsettings-get", "parameters"=>[{"in"=>"query", "name"=>"ApplicationName", "description"=>"The name of the application that the configuration template or environment belongs to", "type"=>"string"}, {"in"=>"query", "name"=>"EnvironmentName", "description"=>"The name of the environment to validate the settings against", "type"=>"string"}, {"in"=>"query", "name"=>"OptionSettings.member.N", "description"=>"A list of the options and desired values to evaluate", "type"=>"string"}, {"in"=>"query", "name"=>"TemplateName", "description"=>"The name of the configuration template to validate the settings against", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Configuration Settings"]}}}}, "apis"=>{"name"=>"AWS Elastic Beanstalk", "x-slug"=>"aws-elastic-beanstalk", "description"=>"AWS Elastic Beanstalk is an easy-to-use service for deploying and scaling web applications and services developed with Java,.NET, PHP, Node.js, Python, Ruby, Go, andDockeron familiar servers such as Apache, Nginx, Passenger, andIIS.You can simply upload your code and Elastic Beanstalk automatically handles the deployment, from capacity provisioning, load balancing, auto-scaling to application health monitoring. At the same time, you retain full control over the AWS resources powering your application and can access the underlying resources at any time.There is no additional charge for Elastic Beanstalk - you pay only for the AWS resources needed to store and run your applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_AWSElasticBeanstalk.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Containers,Deployments,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-elastic-beanstalk/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Elastic Beanstalk API", "x-api-slug"=>"aws-elastic-beanstalk-api", "description"=>"AWS Elastic Beanstalk is an easy-to-use service for deploying and scaling web applications and services developed with Java,.NET, PHP, Node.js, Python, Ruby, Go, andDockeron familiar servers such as Apache, Nginx, Passenger, andIIS.You can simply upload your code and Elastic Beanstalk automatically handles the deployment, from capacity provisioning, load balancing, auto-scaling to application health monitoring. At the same time, you retain full control over the AWS resources powering your application and can access the underlying resources at any time.There is no additional charge for Elastic Beanstalk - you pay only for the AWS resources needed to store and run your applications.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_AWSElasticBeanstalk.png", "humanURL"=>"https://aws.amazon.com/elasticbeanstalk/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Containers,Deployments,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-elastic-beanstalk/aws-elastic-beanstalk-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-log", "url"=>"http://aws.amazon.com/releasenotes/AWS-Elastic-Beanstalk"}, {"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3.html"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/elasticbeanstalk/latest/api/Welcome.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/elasticbeanstalk/faqs/"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=86"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/elasticbeanstalk/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/elasticbeanstalk/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/elasticbeanstalk/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-monitor{"azure-activity-log-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Monitor", "x-complete"=>1, "info"=>{"title"=>"Azure Activity Log Alerts API", "version"=>"2017-03-01-preview"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/activityLogAlerts/{activityLogAlertName}"=>{"put"=>{"summary"=>"Activity Log Alerts Create Or Update", "description"=>"Create a new activity log alert or update an existing one.", "operationId"=>"ActivityLogAlerts_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightsactivitylogalertsactivitylogalertname-put", "parameters"=>[{"in"=>"body", "name"=>"activityLogAlert", "description"=>"The activity log alert to create or use for the update", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity Log Alerts"]}, "get"=>{"summary"=>"Activity Log Alerts Get", "description"=>"Get an activity log alert.", "operationId"=>"ActivityLogAlerts_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightsactivitylogalertsactivitylogalertname-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity Log Alerts"]}, "delete"=>{"summary"=>"Activity Log Alerts Delete", "description"=>"Delete an activity log alert.", "operationId"=>"ActivityLogAlerts_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightsactivitylogalertsactivitylogalertname-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity Log Alerts"]}, "patch"=>{"summary"=>"Activity Log Alerts Update", "description"=>"Updates an existing ActivityLogAlertResource's tags. To update other fields use the CreateOrUpdate method.", "operationId"=>"ActivityLogAlerts_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightsactivitylogalertsactivitylogalertname-patch", "parameters"=>[{"in"=>"body", "name"=>"activityLogAlertPatch", "description"=>"Parameters supplied to the operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity Log Alerts"]}}, "/subscriptions/{subscriptionId}/providers/microsoft.insights/activityLogAlerts"=>{"get"=>{"summary"=>"Activity Log Alerts List By Subscription Id", "description"=>"Get a list of all activity log alerts in a subscription.", "operationId"=>"ActivityLogAlerts_ListBySubscriptionId", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-insightsactivitylogalerts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity Log Alerts Subscription Id"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/activityLogAlerts"=>{"get"=>{"summary"=>"Activity Log Alerts List By Resource Group", "description"=>"Get a list of all activity log alerts in a resource group.", "operationId"=>"ActivityLogAlerts_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightsactivitylogalerts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activity Log Alerts Resource Group"]}}}}, "azure-autoscale-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Monitor", "x-complete"=>1, "info"=>{"title"=>"MonitorManagementClient", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/autoscalesettings"=>{"get"=>{"summary"=>"Autoscale Settings List By Resource Group", "description"=>"Lists the autoscale settings for a resource group", "operationId"=>"AutoscaleSettings_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightsautoscalesettings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaletings Resource Group"]}}, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/autoscalesettings/{autoscaleSettingName}"=>{"put"=>{"summary"=>"Autoscale Settings Create Or Update", "description"=>"Creates or updates an autoscale setting.", "operationId"=>"AutoscaleSettings_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightsautoscalesettingsautoscalesettingname-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaletings"]}, "delete"=>{"summary"=>"Autoscale Settings Delete", "description"=>"Deletes and autoscale setting", "operationId"=>"AutoscaleSettings_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightsautoscalesettingsautoscalesettingname-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaletings"]}, "get"=>{"summary"=>"Autoscale Settings Get", "description"=>"Gets an autoscale setting", "operationId"=>"AutoscaleSettings_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightsautoscalesettingsautoscalesettingname-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaletings"]}}}}, "apis"=>{"name"=>"Azure Monitor", "x-slug"=>"azure-monitor", "description"=>"Autoscale is a built-in feature of Cloud Services, Mobile Services, Virtual Machines, and Websites that helps applications perform their best when demand changes. Of course, performance means different things for different applications. Some apps are CPU-bound, others memory-bound. For example, you could have a web app that handles millions of requests during the day and none at night. Autoscale can scale your service by any of these—or by a custom metric you define.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/manage-monitoring-data.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Cloud,Microsoft,Monitoring,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-monitor/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Activity Log API", "x-api-slug"=>"azure-activity-log-api", "description"=>"Autoscale is a built-in feature of Cloud Services, Mobile Services, Virtual Machines, and Websites that helps applications perform their best when demand changes. Of course, performance means different things for different applications. Some apps are CPU-bound, others memory-bound. For example, you could have a web app that handles millions of requests during the day and none at night. Autoscale can scale your service by any of these—or by a custom metric you define.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/manage-monitoring-data.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/monitor/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Cloud,Microsoft,Monitoring,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-monitor/subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-insightsactivitylogalerts-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-monitor/azure-activity-log-api-openapi.yaml"}]}, {"name"=>"Azure Autoscale API", "x-api-slug"=>"azure-autoscale-api", "description"=>"Autoscale is a built-in feature of Cloud Services, Mobile Services, Virtual Machines, and Websites that helps applications perform their best when demand changes. Of course, performance means different things for different applications. Some apps are CPU-bound, others memory-bound. For example, you could have a web app that handles millions of requests during the day and none at night. Autoscale can scale your service by any of these—or by a custom metric you define.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/manage-monitoring-data.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/monitor/", "baseURL"=>"://management.azure.com//", "tags"=>"Activity Log Alerts Resource Group", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/azure-monitor/azure-autoscale-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/monitoring-and-diagnostics"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/monitor/"}, {"type"=>"x-service-level-agreement", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/monitor/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/monitor/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-server-migration-service{"aws-server-migration-service-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Server Migration Service", "x-complete"=>1, "info"=>{"title"=>"AWS Server Migration Service API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=CreateReplicationJob"=>{"get"=>{"summary"=>"Create Replication Job", "description"=>"The create-replication-job API is used to create a ReplicationJob to replicate a server on AWS.", "operationId"=>"createReplicationJob", "x-api-path-slug"=>"actioncreatereplicationjob-get", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"Type: String", "type"=>"string"}, {"in"=>"query", "name"=>"frequency", "description"=>"Type: Integer", "type"=>"string"}, {"in"=>"query", "name"=>"licenseType", "description"=>"Type: String", "type"=>"string"}, {"in"=>"query", "name"=>"roleName", "description"=>"Type: String", "type"=>"string"}, {"in"=>"query", "name"=>"seedReplicationTime", "description"=>"Type: Timestamp", "type"=>"string"}, {"in"=>"query", "name"=>"serverId", "description"=>"Type: String", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Jobs"]}}, "/?Action=DeleteReplicationJob"=>{"get"=>{"summary"=>"Delete Replication Job", "description"=>"The delete-replication-job API is used to delete a ReplicationJob, resulting in no further ReplicationRuns.", "operationId"=>"deleteReplicationJob", "x-api-path-slug"=>"actiondeletereplicationjob-get", "parameters"=>[{"in"=>"query", "name"=>"replicationJobId", "description"=>"Type: String", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Jobs"]}}, "/?Action=DeleteServerCatalog"=>{"get"=>{"summary"=>"Delete Server Catalog", "description"=>"The delete-server-catalog API clears all servers from your server catalog.", "operationId"=>"deleteServerCatalog", "x-api-path-slug"=>"actiondeleteservercatalog-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Catalog"]}}, "/?Action=DisassociateConnector"=>{"get"=>{"summary"=>"Disassociate Connector", "description"=>"The disassociate-connector API will disassociate a connector from the Server Migration Service, rendering it unavailable to support replication jobs.", "operationId"=>"disassociateConnector", "x-api-path-slug"=>"actiondisassociateconnector-get", "parameters"=>[{"in"=>"query", "name"=>"connectorId", "description"=>"Type: String", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connectors"]}}, "/?Action=GetConnectors"=>{"get"=>{"summary"=>"Get Connectors", "description"=>"The get-connectors API returns a list of connectors that are registered with the Server Migration Service.", "operationId"=>"getConnectors", "x-api-path-slug"=>"actiongetconnectors-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Type: Integer", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"Type: String", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Connectors"]}}, "/?Action=GetReplicationJobs"=>{"get"=>{"summary"=>"Get Replication Jobs", "description"=>"The get-replication-jobs API will return all of your ReplicationJobs and their details.", "operationId"=>"getReplicationJobs", "x-api-path-slug"=>"actiongetreplicationjobs-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Type: Integer", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"Type: String", "type"=>"string"}, {"in"=>"query", "name"=>"replicationJobId", "description"=>"Type: String", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Jobs"]}}, "/?Action=GetReplicationRuns"=>{"get"=>{"summary"=>"Get Replication Runs", "description"=>"The get-replication-runs API will return all ReplicationRuns for a given ReplicationJob.", "operationId"=>"getReplicationRuns", "x-api-path-slug"=>"actiongetreplicationruns-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Type: Integer", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"Type: String", "type"=>"string"}, {"in"=>"query", "name"=>"replicationJobId", "description"=>"Type: String", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Runs"]}}, "/?Action=GetServers"=>{"get"=>{"summary"=>"Get Servers", "description"=>"The get-servers API returns a list of all servers in your server catalog.", "operationId"=>"getServers", "x-api-path-slug"=>"actiongetservers-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"Type: Integer", "type"=>"string"}, {"in"=>"query", "name"=>"nextToken", "description"=>"Type: String", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}}, "/?Action=ImportServerCatalog"=>{"get"=>{"summary"=>"Import Server Catalog", "description"=>"The import-server-catalog API is used to gather the complete list of on-premises servers on your premises.", "operationId"=>"importServerCatalog", "x-api-path-slug"=>"actionimportservercatalog-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Server Catalog"]}}, "/?Action=StartOnDemandReplicationRun"=>{"get"=>{"summary"=>"Start On Demand Replication Run", "description"=>"The start-on-demand-replication-run API is used to start a ReplicationRun on demand (in addition to those that are scheduled based on your frequency).", "operationId"=>"startOnDemandReplicationRun", "x-api-path-slug"=>"actionstartondemandreplicationrun-get", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"Type: String", "type"=>"string"}, {"in"=>"query", "name"=>"replicationJobId", "description"=>"Type: String", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Runs"]}}, "/?Action=UpdateReplicationJob"=>{"get"=>{"summary"=>"Update Replication Job", "description"=>"The update-replication-job API is used to change the settings of your existing ReplicationJob created using CreateReplicationJob.", "operationId"=>"updateReplicationJob", "x-api-path-slug"=>"actionupdatereplicationjob-get", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"Type: String", "type"=>"string"}, {"in"=>"query", "name"=>"frequency", "description"=>"Type: Integer", "type"=>"string"}, {"in"=>"query", "name"=>"licenseType", "description"=>"Type: String", "type"=>"string"}, {"in"=>"query", "name"=>"nextReplicationRunStartTime", "description"=>"Type: Timestamp", "type"=>"string"}, {"in"=>"query", "name"=>"replicationJobId", "description"=>"Type: String", "type"=>"string"}, {"in"=>"query", "name"=>"roleName", "description"=>"Type: String", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Replication Jobs"]}}}}, "apis"=>{"name"=>"AWS Server Migration Service", "x-slug"=>"aws-server-migration-service", "description"=>"AWS Server Migration Service (SMS) is an agentless service which makes it easier and faster for you to migrate thousands of on-premises workloads to AWS. AWS SMS allows you to automate, schedule, and track incremental replications of live server volumes, making it easier for you to coordinate large-scale server migrations.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_AmazonEC2_AMI.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Databases,Migrations,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-server-migration-service/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Server Migration Service API", "x-api-slug"=>"aws-server-migration-service-api", "description"=>"AWS Server Migration Service (SMS) is an agentless service which makes it easier and faster for you to migrate thousands of on-premises workloads to AWS. AWS SMS allows you to automate, schedule, and track incremental replications of live server volumes, making it easier for you to coordinate large-scale server migrations.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Compute_AmazonEC2_AMI.png", "humanURL"=>"https://aws.amazon.com/server-migration-service/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Databases,Migrations,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-server-migration-service/aws-server-migration-service-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/server-migration-service/latest/userguide/cli_workflow.html"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/ServerMigration/latest/APIReference/Welcome.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/server-migration-service/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/server-migration-service/getting-started/"}, {"type"=>"x-partners", "url"=>"https://aws.amazon.com/server-migration-service/partners/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/server-migration-service/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/server-migration-service/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
santander-bank{"apis"=>{"name"=>"Santander Bank", "x-slug"=>"santander-bank", "description"=>"Santander Bank, N. A., formerly Sovereign Bank, is a wholly owned subsidiary of Spanish Santander Group. It is based in Boston and its principal market is the northeastern United States. It has $54.7 billion in deposits, operates about 650 retail banking offices and over 2,000 ATMs, and employs approximately 9,800 people. It offers an array of financial services and products including retail banking, mortgages, corporate banking, cash management, credit card, capital markets, trust and wealth management, and insurance.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28128-www-santanderbank-com.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"11016", "tags"=>"ATMs,Banking,General Data,Relative Data,UK Banks", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"santander-bank/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Santander Bank", "x-api-slug"=>"santander-bank", "description"=>"Santander Bank, N. A., formerly Sovereign Bank, is a wholly owned subsidiary of Spanish Santander Group. It is based in Boston and its principal market is the northeastern United States. It has $54.7 billion in deposits, operates about 650 retail banking offices and over 2,000 ATMs, and employs approximately 9,800 people. It offers an array of financial services and products including retail banking, mortgages, corporate banking, cash management, credit card, capital markets, trust and wealth management, and insurance.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28128-www-santanderbank-com.jpg", "humanURL"=>"https://www.santanderbank.com", "baseURL"=>"https://openapi.santander.co.uk/open-banking/v2.1/", "tags"=>"ATMs,Banking,General Data,Relative Data,UK Banks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/santander-bank/commercialcreditcards-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/santander-bank/santander-bank-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/santander-bank-2"}, {"type"=>"x-developer", "url"=>"http://openbankingapis.io/uk/santander"}, {"type"=>"x-documentation", "url"=>"https://openbanking.atlassian.net/wiki/spaces/DZ/pages/54919225/Open+Data+API+Dashboard#"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/santanderbankUS"}, {"type"=>"x-website", "url"=>"https://www.santanderbank.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "santander-bank-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Santander Bank", "x-complete"=>1, "info"=>{"title"=>"Santander Bank", "description"=>"this-is-an-openapi-definition-for-the-standard-set-of-open-banking-httpopenbankingapis-io-apis-for-santander-bank-", "termsOfService"=>"https://www.openbanking.org.uk/open-licence/", "contact"=>{"name"=>"API Evangelist", "url"=>"https://apievangelist.com", "email"=>"info@apievangelist.com"}, "version"=>"1.0.0"}, "host"=>"openapi.santander.co.uk", "basePath"=>"open-banking/v2.1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"atms/"=>{"get"=>{"summary"=>"Get ATMs", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can provide multiple ATMs.", "operationId"=>"getATMS", "x-api-path-slug"=>"atms-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ATMs"]}}, "branches/"=>{"get"=>{"summary"=>"Get Branches", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple branches.", "operationId"=>"getBranches", "x-api-path-slug"=>"branches-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Branches"]}}, "personal-current-accounts/"=>{"get"=>{"summary"=>"Get Current Personal Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple PCA products.", "operationId"=>"getCurrentPersonalAccounts", "x-api-path-slug"=>"personalcurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "Personal", "Accounts"]}}, "business-current-accounts/"=>{"get"=>{"summary"=>"Get Current Business Accounts", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple BCA products.", "operationId"=>"getCurentBusinessAccounts", "x-api-path-slug"=>"businesscurrentaccounts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Current", "Business", "Accounts"]}}, "unsecured-sme-loans/"=>{"get"=>{"summary"=>"Get Unsecured SME Loans", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Unsecured Loan products.", "operationId"=>"pathOperation", "x-api-path-slug"=>"unsecuredsmeloans-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unsecured", "SME", "Loans"]}}, "commercial-credit-cards/"=>{"get"=>{"summary"=>"Get Commercial Credit Cards", "description"=>"This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Commercial Credit Card products.", "operationId"=>"getCommercialCreditCards", "x-api-path-slug"=>"commercialcreditcards-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Commercial", "Credit", "Cards"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| apica{"checks-command-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Apica", "x-complete"=>1, "info"=>{"title"=>"Checks Command API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/checks/command "=>{" post "=>{"summary"=>"Checks Command", "description"=>"Creates a new Command check.", "operationId"=>"-checks-command-", "x-api-path-slug"=>"checkscommand-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Command"]}}, "/checks/command-v2 "=>{" post "=>{"summary"=>"Checks Command", "description"=>"Creates a new Command check (version 2).", "operationId"=>"-checks-command-v2-", "x-api-path-slug"=>"checkscommandv2-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Command"]}}, "/checks/command-v2/{checkId} "=>{" put "=>{"summary"=>"Checks Command", "description"=>"Updates a command check (version 2).", "operationId"=>"-checks-command-v2-checkid-", "x-api-path-slug"=>"checkscommandv2checkid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Command"]}}, "/checks/command/{checkId} "=>{" put "=>{"summary"=>"Checks Command", "description"=>"Updates a command check.", "operationId"=>"-checks-command-checkid-", "x-api-path-slug"=>"checkscommandcheckid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Command"]}}, "/checks/command/categories "=>{" get "=>{"summary"=>"Checks Command Categories", "description"=>"Gets a list of all command check categories that are available for you as customer.", "operationId"=>"-checks-command-categories-", "x-api-path-slug"=>"checkscommandcategories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Command"]}}, "/checks/command-v2/categories "=>{" get "=>{"summary"=>"Checks Command Categories", "description"=>"Gets a list of all command check (version 2) categories that are available for you as customer.", "operationId"=>"-checks-command-v2-categories-", "x-api-path-slug"=>"checkscommandv2categories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Command"]}}, "/checks/command/locations "=>{" get "=>{"summary"=>"Checks Command Locations", "description"=>"Gets a list of all locations that are available for Command checks.", "operationId"=>"-checks-command-locations-", "x-api-path-slug"=>"checkscommandlocations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Command"]}}, "/checks/command-v2/locations"=>{" get "=>{"summary"=>"Checks Command Locations", "description"=>"Gets a list of all locations that are available for Command checks (version 2).", "operationId"=>"-checks-command-v2-locationsprotocolprotocol-", "x-api-path-slug"=>"checkscommandv2locations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Command"]}}}}, "groups-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Apica", "x-complete"=>1, "info"=>{"title"=>"Groups API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/groups "=>{" get "=>{"summary"=>"Groups", "description"=>"Gets a hierarchy of all monitor groups that are visible to you as a user or a customer depending on the request context.", "operationId"=>"-groups-", "x-api-path-slug"=>"groups-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, " post "=>{"summary"=>"Groups", "description"=>"Creates a new monitor group.", "operationId"=>"-groups-", "x-api-path-slug"=>"groups-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/groups/{groupId} "=>{" put "=>{"summary"=>"Groups", "description"=>"Updates a monitor group.", "operationId"=>"-groups-groupid-", "x-api-path-slug"=>"groupsgroupid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, " delete "=>{"summary"=>"Groups", "description"=>"Deletes a monitor group by Id.", "operationId"=>"-groups-groupid-", "x-api-path-slug"=>"groupsgroupid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/groups/{groupId}/checks "=>{" get "=>{"summary"=>"Group Checks", "description"=>"Gets a list of checks assigned to the monitor group.", "operationId"=>"-groups-groupid-checks-", "x-api-path-slug"=>"groupsgroupidchecks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, " post "=>{"summary"=>"Group Checks", "description"=>"Assigns checks to the monitor group.", "operationId"=>"-groups-groupid-checks-", "x-api-path-slug"=>"groupsgroupidchecks-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, " delete "=>{"summary"=>"Groups Checks", "description"=>"Unassigns checks from the monitor group.", "operationId"=>"-groups-groupid-checks-", "x-api-path-slug"=>"groupsgroupidchecks-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}, "/groups/{groupId}/users "=>{" get "=>{"summary"=>"Groups Users", "description"=>"Gets a list of users assigned to the monitor group.", "operationId"=>"-groups-groupid-users-", "x-api-path-slug"=>"groupsgroupidusers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, " post "=>{"summary"=>"Groups Users", "description"=>"Assigns users to the monitor group.", "operationId"=>"-groups-groupid-users-", "x-api-path-slug"=>"groupsgroupidusers-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}, " delete "=>{"summary"=>"Groups Users", "description"=>"", "operationId"=>"-groups-groupid-users-", "x-api-path-slug"=>"groupsgroupidusers-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Groups"]}}}}, "scenarios-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Apica", "x-complete"=>1, "info"=>{"title"=>"Scenarios API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/scenarios/proxysniffer/dictionaries "=>{" post "=>{"summary"=>"Scenarios Proxy Sniffer Dictionaries", "description"=>"Adds Proxy Sniffer scenario custom dictionary.", "operationId"=>"postScenariosProxysnifferDictionaries", "x-api-path-slug"=>"scenariosproxysnifferdictionaries-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scenarios", "Proxy", "Sniffer", "Dictionaries"]}}, "/scenarios/proxysniffer/dictionaries/{dictionary_key} "=>{" get "=>{"summary"=>"Scenarios Proxy Sniffer Dictionaries", "description"=>"Gets a Proxy Sniffer scenario custom dictionary by dictionary key. Custom dictionary can contain any data used by Proxy Sniffer scripts which needs to be stored separately from scripts.", "operationId"=>"getScenariosProxysnifferDictionariesDictionaryKey", "x-api-path-slug"=>"scenariosproxysnifferdictionariesdictionary-key-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scenarios", "Proxy", "Sniffer", "Dictionaries"]}, " put "=>{"summary"=>"Scenarios Proxy Sniffer Dictionaries", "description"=>"Updates Proxy Sniffer scenario custom dictionary.", "operationId"=>"putScenariosProxysnifferDictionariesDictionaryKey", "x-api-path-slug"=>"scenariosproxysnifferdictionariesdictionary-key-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scenarios", "Proxy", "Sniffer", "Dictionaries"]}}}}, "roles-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Apica", "x-complete"=>1, "info"=>{"title"=>"Roles API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/roles "=>{" get "=>{"summary"=>"Get Roles", "description"=>"Return user roles", "operationId"=>"getRoles", "x-api-path-slug"=>"roles-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Roles"]}}}}, "checks-url-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Apica", "x-complete"=>1, "info"=>{"title"=>"Checks URL", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/checks/url "=>{" post "=>{"summary"=>"Checks URL", "description"=>"Creates a new URL check (legacy version 1).", "operationId"=>"-checks-url-", "x-api-path-slug"=>"checksurl-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "URL"]}}, "/checks/url-v2 "=>{" post "=>{"summary"=>"Checks URL", "description"=>"Creates a new URL check (version 2).", "operationId"=>"-checks-url-v2-", "x-api-path-slug"=>"checksurlv2-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "URL"]}}, "/checks/url/{checkId} "=>{" put "=>{"summary"=>"Checks URL", "description"=>"Updates a URL check (legacy version 1).", "operationId"=>"-checks-url-checkid-", "x-api-path-slug"=>"checksurlcheckid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "URL"]}}, "/checks/url-v2/{checkId} "=>{" put "=>{"summary"=>"Checks URL", "description"=>"Updates a URL check (version 2).", "operationId"=>"-checks-url-v2-checkid-", "x-api-path-slug"=>"checksurlv2checkid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "URL"]}}, "/checks/url/locations "=>{" get "=>{"summary"=>"Checks URL Locations", "description"=>"Gets a list of all locations that are available for URL (legacy version 1) checks.", "operationId"=>"-checks-url-locations-", "x-api-path-slug"=>"checksurllocations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "URL"]}}, "/checks/url-v2/locations "=>{" get "=>{"summary"=>"Checks URL Locations", "description"=>"Gets a list of all locations that are available for URL (version 2) checks.", "operationId"=>"-checks-url-v2-locations-", "x-api-path-slug"=>"checksurlv2locations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "URL"]}}}}, "checks-port-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Apica", "x-complete"=>1, "info"=>{"title"=>"Checks Port API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/checks/port "=>{" post "=>{"summary"=>"Checks Port", "description"=>"Creates a new Port check.", "operationId"=>"-checks-port-", "x-api-path-slug"=>"checksport-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Ports"]}}, "/checks/port/{checkId} "=>{" put "=>{"summary"=>"Checks Port", "description"=>"Updates a Port check.", "operationId"=>"-checks-port-checkid-", "x-api-path-slug"=>"checksportcheckid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Ports"]}}, "/checks/port/locations "=>{" get "=>{"summary"=>"Checks Port Locations", "description"=>"Gets a list of all locations that are available for Port checks.", "operationId"=>"-checks-port-locations-", "x-api-path-slug"=>"checksportlocations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Ports"]}}}}, "browser-checks-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Apica", "x-complete"=>1, "info"=>{"title"=>"Browser Checks API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/checks/browser "=>{" post "=>{"summary"=>"Checks Browser", "description"=>"Creates a new browser check.", "operationId"=>"-checks-browser-", "x-api-path-slug"=>"checksbrowser-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Browser"]}}, "/checks/browser/{checkId} "=>{" put "=>{"summary"=>"Checks Browser", "description"=>"Updates a browser check.", "operationId"=>"-checks-browser-checkid-", "x-api-path-slug"=>"checksbrowsercheckid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Browser"]}}, "/checks/browser/locations "=>{" get "=>{"summary"=>"Checks Browser Locations", "description"=>"Gets a list of all locations that are available for browser checks.", "operationId"=>"-checks-browser-locations-", "x-api-path-slug"=>"checksbrowserlocations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Browser"]}}, "/checks/browser/{checkId}/results/{resultId}/urldata"=>{" get "=>{"summary"=>"Checks Browser Results", "description"=>"Gets a file that contains browser check result data.", "operationId"=>"-checks-browser-checkid-results-resultid-urldataformatformat-", "x-api-path-slug"=>"checksbrowsercheckidresultsresultidurldata-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Browser"]}}, "/checks/browser/{checkId}/results/urldata "=>{" post "=>{"summary"=>"Checks Browser Results", "description"=>"Gets browser check results in json format by result ids.", "operationId"=>"-checks-browser-checkid-results-urldata-", "x-api-path-slug"=>"checksbrowsercheckidresultsurldata-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Browser"]}}}}, "checks-ping-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Apica", "x-complete"=>1, "info"=>{"title"=>"Checks Ping API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/checks/ping "=>{" post "=>{"summary"=>"Checks Ping", "description"=>"Creates a new Ping check.", "operationId"=>"-checks-ping-", "x-api-path-slug"=>"checksping-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Pings"]}}, "/checks/ping/{checkId} "=>{" put "=>{"summary"=>"Checks Ping", "description"=>"Updates a Ping check.", "operationId"=>"-checks-ping-checkid-", "x-api-path-slug"=>"checkspingcheckid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Pings"]}}, "/checks/ping/locations "=>{" get "=>{"summary"=>"Checks Ping Locations", "description"=>"Gets a list of all locations that are available for Ping checks.", "operationId"=>"-checks-ping-locations-", "x-api-path-slug"=>"checkspinglocations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Pings"]}}}}, "checks-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Apica", "x-complete"=>1, "info"=>{"title"=>"Checks API", "description"=>"the-checks-api-", "version"=>"1.0.0"}, "host"=>"api.pingdom.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/checks "=>{" get "=>{"summary"=>"Get Checks", "description"=>"Gets a list of all checks that are visible to you as a user or a customer depending on the request context.", "operationId"=>"getChecks", "x-api-path-slug"=>"checks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}, "/checks/{checkId} "=>{" get "=>{"summary"=>"Get Check", "description"=>"Gets info about a check, current SLA, last result and its status.", "operationId"=>"getChecksCheck", "x-api-path-slug"=>"checkscheckid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}, " put "=>{"summary"=>"Update Check", "description"=>"Updates a check.", "operationId"=>"putChecksCheck", "x-api-path-slug"=>"checkscheckid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}, " delete "=>{"summary"=>"Delete Check", "description"=>"Deletes a check.", "operationId"=>"deleteChecksCheck", "x-api-path-slug"=>"checkscheckid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}, "/checks/{checkId}/lastvalue "=>{" get "=>{"summary"=>"Get Checks Lastvalue", "description"=>"Gets the absolute last value of a specific check.", "operationId"=>"getChecksCheckLastvalue", "x-api-path-slug"=>"checkscheckidlastvalue-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}, "/checks/{checkId}/results/{millisecondsUtc}"=>{" get "=>{"summary"=>"Get Checks Results", "description"=>"Gets a specific check result by a numeric java timestamp.", "operationId"=>"getChecksCheckResultsMillisecondsutcDetailLevelDetailLevel", "x-api-path-slug"=>"checkscheckidresultsmillisecondsutc-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}, "/checks/{checkId}/results"=>{" get "=>{"summary"=>"Get Checks Results", "description"=>"Gets the most recent check results.", "operationId"=>"getChecksCheckResultsMostrecentMostrecent&detailLevelDetailLevel", "x-api-path-slug"=>"checkscheckidresults-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}, "\n /api/{version}/checks"=>{"\n get"=>{"summary"=>"Get Check List", "description"=>"Returns a list overview of all checks.", "operationId"=>"\ngetApiVersionChecks", "x-api-path-slug"=>"apiversionchecks-get", "parameters"=>[{"in"=>"query", "name"=>"include_tags", "description"=>"Include tag list for each check", "type"=>" | boolean | "}, {"in"=>"query", "name"=>"limit", "description"=>"Limits the number of returned probes to the specified quantity", "type"=>"integer | "}, {"in"=>"query", "name"=>"offset", "description"=>"Offset for listing", "type"=>"integer | "}, {"in"=>"query", "name"=>"tags", "description"=>"Tag list separated by commas", "type"=>"string | "}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks"]}}}}, "checks-job-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Apica", "x-complete"=>1, "info"=>{"title"=>"Checks Job API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/checks/{checkId}/job "=>{" get "=>{"summary"=>"Get Checks Job", "description"=>"DEPRECATED. Gets the current job status for a check.", "operationId"=>"-checks-checkid-job-", "x-api-path-slug"=>"checkscheckidjob-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Jobs"]}, " post "=>{"summary"=>"Get Checks Job", "description"=>"Executes a check.", "operationId"=>"-checks-checkid-job-", "x-api-path-slug"=>"checkscheckidjob-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Jobs"]}}}}, "alerts-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Apica", "x-complete"=>1, "info"=>{"title"=>"Alerts API", "description"=>"the-alerts-api-", "version"=>"1.0.0"}, "host"=>"api.serverdensity.io.", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/alerts?check_id={check_id}&severity={severity}&enabled={enabled}&target_type={target_type}&target_id={target_id} "=>{" get "=>{"summary"=>"Alerts", "description"=>"Gets alerts filtered by set of optional parameters.", "operationId"=>"-alertscheck-idcheck-idampseverityseverityampenabledenabledamptarget-typetarget-typeamptarget-idtarg", "x-api-path-slug"=>"alertscheck-idcheck-idampseverityseverityampenabledenabledamptarget-typetarget-typeamptarget-idtarget-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/{alert_id} "=>{" get "=>{"summary"=>"Alerts", "description"=>"Gets alert by Id.", "operationId"=>"-alerts-alert-id-", "x-api-path-slug"=>"alertsalert-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}, " put "=>{"summary"=>"Alerts", "description"=>"Updates alert.", "operationId"=>"-alerts-alert-id-", "x-api-path-slug"=>"alertsalert-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}, " delete "=>{"summary"=>"Alerts", "description"=>"Deletes alert by Id.", "operationId"=>"-alerts-alert-id-", "x-api-path-slug"=>"alertsalert-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/{alert_type} "=>{" post "=>{"summary"=>"Alerts", "description"=>"Creates a new alert.", "operationId"=>"-alerts-alert-type-", "x-api-path-slug"=>"alertsalert-type-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/recipients "=>{" get "=>{"summary"=>"Alerts Recipients", "description"=>"Gets a list of all alert recipient's targets that are visible to you as a customer.", "operationId"=>"-alerts-recipients-", "x-api-path-slug"=>"alertsrecipients-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/recipients/{recipient_id} "=>{" get "=>{"summary"=>"Alerts Recipients", "description"=>"Gets a information about alert recipient's targets.", "operationId"=>"-alerts-recipients-recipient-id-", "x-api-path-slug"=>"alertsrecipientsrecipient-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/recipient/{recipient_id} "=>{" put "=>{"summary"=>"Alerts Recipient", "description"=>"Updates recipient along with sms and email targets associated.", "operationId"=>"-alerts-recipient-recipient-id-", "x-api-path-slug"=>"alertsrecipientrecipient-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/recipient "=>{" post "=>{"summary"=>"Alerts Recipient", "description"=>"Creates a new recipient with one sms and one email target associated.", "operationId"=>"-alerts-recipient-", "x-api-path-slug"=>"alertsrecipient-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/targets "=>{" get "=>{"summary"=>"Alerts Targets", "description"=>"Gets a list of all alert targets that are visible to you as a customer.", "operationId"=>"-alerts-targets-", "x-api-path-slug"=>"alertstargets-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/configs/alertId"=>{"delete"=>{"summary"=>"Deleting an alert", "description"=>"Deleting an alert", "operationId"=>"deleting-an-alert", "x-api-path-slug"=>"alertsconfigsalertid-delete", "parameters"=>[{"in"=>"path", "name"=>"alertId", "description"=>"The ID of the alert to be deleted", "type"=>"string"}, {"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"body", "name"=>"token", "description"=>"Your API token", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/configs/subjectId"=>{"get"=>{"summary"=>"Listing alerts by subject", "description"=>"Get a list of all configured alerts for a specific subject (device or service).", "operationId"=>"listing-alerts-by-subject", "x-api-path-slug"=>"alertsconfigssubjectid-get", "parameters"=>[{"in"=>"path", "name"=>"subjectId", "description"=>"The ID of the subject e", "type"=>"string"}, {"in"=>"path", "name"=>"subjectType", "description"=>"The type of the subject - device or service", "type"=>"string"}, {"in"=>"query", "name"=>"subjectType", "description"=>"The type of the subject - device or service", "type"=>"string"}, {"in"=>"path", "name"=>"token", "description"=>"Your API token", "type"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/alerts/triggered"=>{"get"=>{"summary"=>"Triggered Alerts", "description"=>"Get a list of all triggered alerts on your account, per subject (device or service) or per alert config.", "operationId"=>"triggered-alerts", "x-api-path-slug"=>"alertstriggered-get", "parameters"=>[{"in"=>"query", "name"=>"closed", "description"=>"Whether to filter by closed or open alerts - unset = all alerts, false = open alerts, true = closed alerts", "type"=>"string"}, {"in"=>"query", "name"=>"filter", "description"=>"You can provide a JSON encoded hash filter for the search that will return items that match the filter", "type"=>"string"}, {"in"=>"query", "name"=>"subjectType", "description"=>"The type of the subject - device, service, deviceGroup or serviceGroup if you also specify the subjectId as part of the URL (see examples below)", "type"=>"string"}, {"in"=>"query", "name"=>"token", "description"=>"Your API token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}}}, "customers-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Apica", "x-complete"=>1, "info"=>{"title"=>"Customers API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/customers/{customerId} "=>{" get "=>{"summary"=>"Customers", "description"=>"Returns subcustomer by subcustomer's ID.", "operationId"=>"-customers-customerid-", "x-api-path-slug"=>"customerscustomerid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}}, "/customers "=>{" post "=>{"summary"=>"Customers", "description"=>"Creates customer.", "operationId"=>"-customers-", "x-api-path-slug"=>"customers-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}}, "/customers/{customerId}/subscription "=>{" put "=>{"summary"=>"Customers Subscription", "description"=>"Updates customer's subscription.", "operationId"=>"-customers-customerid-subscription-", "x-api-path-slug"=>"customerscustomeridsubscription-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}}}}, "messages-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Apica", "x-complete"=>1, "info"=>{"title"=>"Messages API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/buckets/{bucketKey}/messages"=>{"delete"=>{"summary"=>"Delete Buckets Messages", "description"=>"Clear a bucket (remove all messages)..", "operationId"=>"deleteBucketsBucketkeyMessages", "x-api-path-slug"=>"bucketsbucketkeymessages-delete", "parameters"=>[{"in"=>"path", "name"=>"bucketKey", "description"=>"Unique identifier for a bucket"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "BucketKey", "Messages"]}, "get"=>{"summary"=>"Get Buckets Messages", "description"=>"Retrieve a list of messages in a bucket.", "operationId"=>"getBucketsBucketkeyMessages", "x-api-path-slug"=>"bucketsbucketkeymessages-get", "parameters"=>[{"in"=>"query", "name"=>"before", "description"=>"Only return messages before the given Unix timestamp"}, {"in"=>"path", "name"=>"bucketKey", "description"=>"Unique identifier for a bucket"}, {"in"=>"query", "name"=>"count", "description"=>"Maxiumum number of messages to return"}, {"in"=>"query", "name"=>"since", "description"=>"Only return messages after the given Unix timestamp"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "BucketKey", "Messages"]}, "post"=>{"summary"=>"Post Buckets Messages", "description"=>"Create a message.", "operationId"=>"postBucketsBucketkeyMessages", "x-api-path-slug"=>"bucketsbucketkeymessages-post", "parameters"=>[{"in"=>"body", "name"=>"NewMessage", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "BucketKey", "Messages"]}}, "/buckets/{bucketKey}/messages/{messageId}"=>{"get"=>{"summary"=>"Get Buckets Messages Messageid", "description"=>"Retrieve the details for a single message..", "operationId"=>"getBucketsBucketkeyMessagesMessage", "x-api-path-slug"=>"bucketsbucketkeymessagesmessageid-get", "parameters"=>[{"in"=>"path", "name"=>"bucketKey", "description"=>"Unique identifier for a bucket"}, {"in"=>"query", "name"=>"messageId", "description"=>"The unique identifier for this message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buckets", "BucketKey", "Messages", "MessageId"]}}, "/messages?active={active}&customerId={customerId} "=>{" get "=>{"summary"=>"Get Messages", "description"=>"Gets a list of UI messages. UI messages are used for user notifications on announcements/information/warnings.", "operationId"=>"getMessagesActiveActive&customerCustomer", "x-api-path-slug"=>"messagesactiveactiveampcustomeridcustomerid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages?active=active&customerId=customerId"]}}, "/messages "=>{" post "=>{"summary"=>"Post Messages", "description"=>"Creates an UI message.", "operationId"=>"postMessages", "x-api-path-slug"=>"messages-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages"]}}, "/messages/{id} "=>{" get "=>{"summary"=>"Get Messages", "description"=>"Gets an existing UI message by Id.", "operationId"=>"getMessages", "x-api-path-slug"=>"messagesid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Id"]}, " put "=>{"summary"=>"Put Messages", "description"=>"Updates an existing UI message.", "operationId"=>"putMessages", "x-api-path-slug"=>"messagesid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Id"]}, " delete "=>{"summary"=>"Delete Messages", "description"=>"Deletes an existing UI message.", "operationId"=>"deleteMessages", "x-api-path-slug"=>"messagesid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messages", "Id"]}}}}, "checks-proxysniffer-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Apica", "x-complete"=>1, "info"=>{"title"=>"Checks Proxysniffer", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/checks/proxysniffer "=>{" post "=>{"summary"=>"Checks Proxy Sniffer", "description"=>"Creates a new ProxySniffer check.", "operationId"=>"-checks-proxysniffer-", "x-api-path-slug"=>"checksproxysniffer-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Proxy"]}}, "/checks/proxysniffer/{checkId} "=>{" put "=>{"summary"=>"Checks Proxy Sniffer", "description"=>"Updates a proxy sniffer check.", "operationId"=>"-checks-proxysniffer-checkid-", "x-api-path-slug"=>"checksproxysniffercheckid-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Proxy"]}}, "/checks/proxysniffer/locations "=>{" get "=>{"summary"=>"Checks Proxy Sniffer Locations", "description"=>"Gets a list of all locations that are available for ProxySniffer checks.", "operationId"=>"-checks-proxysniffer-locations-", "x-api-path-slug"=>"checksproxysnifferlocations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Proxy"]}}, "/checks/proxysniffer/{checkId}/results/{resultId}/urldata?format={format} "=>{" get "=>{"summary"=>"Checks Proxysniffer Results", "description"=>"Gets a file that contains ProxySniffer check result data.", "operationId"=>"-checks-proxysniffer-checkid-results-resultid-urldataformatformat-", "x-api-path-slug"=>"checksproxysniffercheckidresultsresultidurldataformatformat-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Proxy"]}}, "/checks/proxysniffer/{checkId}/results/urldata "=>{" post "=>{"summary"=>"Checks Proxy Sniffer Results URLdata", "description"=>"Gets ProxySniffer check results in json format by result ids.", "operationId"=>"-checks-proxysniffer-checkid-results-urldata-", "x-api-path-slug"=>"checksproxysniffercheckidresultsurldata-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Proxy"]}}, "/checks/proxysniffer/{checkId}/results/{resultId}/errorlog "=>{" get "=>{"summary"=>"Checks Proxy Sniffer Results Error Log", "description"=>"Gets an error log of the given ProxySniffer check result.", "operationId"=>"-checks-proxysniffer-checkid-results-resultid-errorlog-", "x-api-path-slug"=>"checksproxysniffercheckidresultsresultiderrorlog-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Proxy"]}}}}, "apis"=>{"name"=>"Apica", "x-slug"=>"apica", "description"=>"Apicas performance testing and monitoring solutions provide critical peak performance data and 24/7 monitoring of applications and sites around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19004-apica.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"876355", "tags"=>"API Provider,Enterprise,Monitoring,Performance,Profiles,Relative Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Technology,Testing", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"apica/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Alerts API", "x-api-slug"=>"alerts-api", "description"=>"Apicas performance testing and monitoring solutions provide critical peak performance data and 24/7 monitoring of applications and sites around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19004-apica.jpg", "humanURL"=>"https://www.apicasystem.com", "baseURL"=>"://api.serverdensity.io./", "tags"=>"API Provider,Enterprise,Monitoring,Performance,Profiles,Relative Data,Relative StreamRank,SaaS,Service API,Streams,Streams,Streams,Technology,Testing", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/apica/alerts-api-openapi.yaml"}]}, {"name"=>"Browser Checks API", "x-api-slug"=>"browser-checks-api", "description"=>"Apicas performance testing and monitoring solutions provide critical peak performance data and 24/7 monitoring of applications and sites around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19004-apica.jpg", "humanURL"=>"https://www.apicasystem.com", "baseURL"=>":///", "tags"=>"Alerts", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/apica/checksbrowsercheckidresultsurldata-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/apica/browser-checks-api-openapi.yaml"}]}, {"name"=>"Checks API", "x-api-slug"=>"checks-api", "description"=>"Apicas performance testing and monitoring solutions provide critical peak performance data and 24/7 monitoring of applications and sites around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19004-apica.jpg", "humanURL"=>"https://www.apicasystem.com", "baseURL"=>"https://api.pingdom.com//", "tags"=>"Browser", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/apica/checks-api-openapi.yaml"}]}, {"name"=>"Checks Command API", "x-api-slug"=>"checks-command-api", "description"=>"Apicas performance testing and monitoring solutions provide critical peak performance data and 24/7 monitoring of applications and sites around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19004-apica.jpg", "humanURL"=>"https://www.apicasystem.com", "baseURL"=>":///", "tags"=>"Checks", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/apica/checkscommandv2locations-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/apica/checks-command-api-openapi.yaml"}]}, {"name"=>"Checks Job API", "x-api-slug"=>"checks-job-api", "description"=>"Apicas performance testing and monitoring solutions provide critical peak performance data and 24/7 monitoring of applications and sites around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19004-apica.jpg", "humanURL"=>"https://www.apicasystem.com", "baseURL"=>":///", "tags"=>"Checks,Command", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/apica/checkscheckidjob-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/apica/checks-job-api-openapi.yaml"}]}, {"name"=>"Checks Ping API", "x-api-slug"=>"checks-ping-api", "description"=>"Apicas performance testing and monitoring solutions provide critical peak performance data and 24/7 monitoring of applications and sites around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19004-apica.jpg", "humanURL"=>"https://www.apicasystem.com", "baseURL"=>":///", "tags"=>"Checks,Jobs", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/apica/checkspinglocations-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/apica/checks-ping-api-openapi.yaml"}]}, {"name"=>"Checks Port API", "x-api-slug"=>"checks-port-api", "description"=>"Apicas performance testing and monitoring solutions provide critical peak performance data and 24/7 monitoring of applications and sites around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19004-apica.jpg", "humanURL"=>"https://www.apicasystem.com", "baseURL"=>":///", "tags"=>"Checks,Pings", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/apica/checksportlocations-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/apica/checks-port-api-openapi.yaml"}]}, {"name"=>"Checks Proxysniffer", "x-api-slug"=>"checks-proxysniffer", "description"=>"Apicas performance testing and monitoring solutions provide critical peak performance data and 24/7 monitoring of applications and sites around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19004-apica.jpg", "humanURL"=>"https://www.apicasystem.com", "baseURL"=>":///", "tags"=>"Checks,Ports", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/apica/checksproxysniffercheckidresultsresultiderrorlog-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/apica/checks-proxysniffer-openapi.yaml"}]}, {"name"=>"Checks URL", "x-api-slug"=>"checks-url", "description"=>"Apicas performance testing and monitoring solutions provide critical peak performance data and 24/7 monitoring of applications and sites around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19004-apica.jpg", "humanURL"=>"https://www.apicasystem.com", "baseURL"=>":///", "tags"=>"Checks,Proxy", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/apica/checksurlv2locations-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/apica/checks-url-openapi.yaml"}]}, {"name"=>"Customers API", "x-api-slug"=>"customers-api", "description"=>"Apicas performance testing and monitoring solutions provide critical peak performance data and 24/7 monitoring of applications and sites around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19004-apica.jpg", "humanURL"=>"https://www.apicasystem.com", "baseURL"=>":///", "tags"=>"Checks,URL", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/apica/customerscustomeridsubscription-put-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/apica/customers-api-openapi.yaml"}]}, {"name"=>"Groups API", "x-api-slug"=>"groups-api", "description"=>"Apicas performance testing and monitoring solutions provide critical peak performance data and 24/7 monitoring of applications and sites around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19004-apica.jpg", "humanURL"=>"https://www.apicasystem.com", "baseURL"=>":///", "tags"=>"Customers", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/apica/groupsgroupidusers-delete-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/apica/groups-api-openapi.yaml"}]}, {"name"=>"Messages API", "x-api-slug"=>"messages-api", "description"=>"Apicas performance testing and monitoring solutions provide critical peak performance data and 24/7 monitoring of applications and sites around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19004-apica.jpg", "humanURL"=>"https://www.apicasystem.com", "baseURL"=>":///", "tags"=>"Groups", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/apica/messages-api-openapi.yaml"}]}, {"name"=>"Roles API", "x-api-slug"=>"roles-api", "description"=>"Apicas performance testing and monitoring solutions provide critical peak performance data and 24/7 monitoring of applications and sites around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19004-apica.jpg", "humanURL"=>"https://www.apicasystem.com", "baseURL"=>":///", "tags"=>"Messages,Id", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/apica/roles-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/apica/roles-api-openapi.yaml"}]}, {"name"=>"Scenarios API", "x-api-slug"=>"scenarios-api", "description"=>"Apicas performance testing and monitoring solutions provide critical peak performance data and 24/7 monitoring of applications and sites around the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/19004-apica.jpg", "humanURL"=>"https://www.apicasystem.com", "baseURL"=>":///", "tags"=>"Roles", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/apica/scenariosproxysnifferdictionariesdictionary-key-put-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/apica/scenarios-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://www.apicasystem.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"https://www.apicasystem.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/apica"}, {"type"=>"x-developer", "url"=>"http://api-wpm.apicasystem.com/v3/help"}, {"type"=>"x-documentation", "url"=>"https://api-wpm.apicasystem.com/v3/Help"}, {"type"=>"x-email", "url"=>"support@apicasystems.com"}, {"type"=>"x-email", "url"=>"sales@apicasystems.com"}, {"type"=>"x-email", "url"=>"swesales@apicasystems.com"}, {"type"=>"x-email", "url"=>"operations@apicasystem.com"}, {"type"=>"x-github", "url"=>"https://github.com/ApicaSystem"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/apica-ab"}, {"type"=>"x-phone", "url"=>"1 (310) 776-7540"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/apicasystems"}, {"type"=>"x-website", "url"=>"https://www.apicasystem.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}}|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
bookeo{"bookeo-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Bookeo", "x-complete"=>1, "info"=>{"title"=>"Bookeo", "version"=>"1.0.0"}, "host"=>"api.bookeo.com", "basePath"=>"/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/availability/matchingslots"=>{"post"=>{"summary"=>"Find available slots matching given search parameters", "description"=>"Create a search for available slots that match the given search parameters.\n Note that there are two different searches possible, /availability/slots and /availability/matchingslots (this endpoint).\n The former simply shows the number of available seats for each available slot. The latter (this one) takes as input the participant numbers, and shows the slots that are available for those numbers, and an estimate of the price.\n Parameters include product code, number of people and options.\n The successful response also contains a \"Location\" HTTP header, which can be invoked to navigate the results of the search.", "operationId"=>"postAvailabilityMatchingslots", "x-api-path-slug"=>"availabilitymatchingslots-post", "parameters"=>[{"in"=>"query", "name"=>"itemsPerPage"}, {"in"=>"body", "name"=>"search", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availability", "Matchingslots"]}}, "/availability/matchingslots/{pageNavigationToken}"=>{"get"=>{"summary"=>"Navigate results of a matching slots search", "description"=>"Navigate results of a matching slots search.", "operationId"=>"getAvailabilityMatchingslotsPagenavigationtoken", "x-api-path-slug"=>"availabilitymatchingslotspagenavigationtoken-get", "parameters"=>[{"in"=>"path", "name"=>"pageNavigationToken"}, {"in"=>"query", "name"=>"pageNumber"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availability", "Matchingslots", "PageNavigationToken"]}}, "/availability/slots"=>{"get"=>{"summary"=>"Get information about the availability of products", "description"=>"Performs a basic search to find available slots and number of seats in each.\n Note that there are two different searches possible, /availability/slots (this endpoint) and /availability/matchingslots .\n The former simply shows the number of available seats for each available slot. The latter takes as input the participant numbers, and shows the slots that are available for those numbers, and an estimate of the price.\n /availability/slots cannot be used for products of type flexibleTime . For those products, use /availability/matchingslots .", "operationId"=>"getAvailabilitySlots", "x-api-path-slug"=>"availabilityslots-get", "parameters"=>[{"in"=>"query", "name"=>"endTime", "description"=>"the end time to search to"}, {"in"=>"query", "name"=>"itemsPerPage"}, {"in"=>"query", "name"=>"pageNavigationToken"}, {"in"=>"query", "name"=>"pageNumber"}, {"in"=>"query", "name"=>"productId", "description"=>"the product id (see /settings/products)"}, {"in"=>"query", "name"=>"startTime", "description"=>"the start time to search from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Availability", "Slots"]}}, "/bookings"=>{"get"=>{"summary"=>"Retrieve bookings", "description"=>"Retrieve existing bookings\n The result is limited by the permissions of the apiKey.\n \n It is possible to filter by time booked and/or time of the last change.\n To filter by time booked, the parameters startTime and endTime are required.\n To filter by last time changed, the parameters lastUpdatedStartTime and lastUpdatedEndTime are required.\n It is possible to filter by both at the same time. At least one of the two filters must be used.\n \n It is further possible to filter by product id.\n \n Do not use this method to periodically poll for new/changed bookings. Use webhooks (see API general documentation) instead.", "operationId"=>"getBookings", "x-api-path-slug"=>"bookings-get", "parameters"=>[{"in"=>"query", "name"=>"endTime", "description"=>"if specified, only include bookings that start on or before this time"}, {"in"=>"query", "name"=>"expandCustomer", "description"=>"if true, the full details of the customer are included (provided the application has read permission over the customer)"}, {"in"=>"query", "name"=>"expandParticipants", "description"=>"if true, full details of the participants are included (provided the application has read permission over the participant)"}, {"in"=>"query", "name"=>"includeCanceled", "description"=>"if true, canceled bookings are included"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"maximum: 100"}, {"in"=>"query", "name"=>"lastUpdatedEndTime", "description"=>"if specified, only include bookings that were last changed (or created) on or before this time"}, {"in"=>"query", "name"=>"lastUpdatedStartTime", "description"=>"if specified, only include bookings that were last changed (or created) on or after this time"}, {"in"=>"query", "name"=>"pageNavigationToken"}, {"in"=>"query", "name"=>"pageNumber"}, {"in"=>"query", "name"=>"productId", "description"=>"if not specified, include bookings for all products"}, {"in"=>"query", "name"=>"startTime", "description"=>"if specified, only include bookings that start on or after this time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bookings"]}, "post"=>{"summary"=>"Create a new booking", "description"=>"When creating a booking for a product of type \"fixed\" or \"fixedCourse\", the eventId is required. eventIds are obtained by calling /availability/slots or /availability/matchingSlots .\n When creating a booking for a product of type \"flexibleTime\", you can either specify the eventId or the startTime (in which case you can optionally specify the endTime. If no endTime is specified, Bookeo will automatically calculate the duration based on the options chosen)", "operationId"=>"postBookings", "x-api-path-slug"=>"bookings-post", "parameters"=>[{"in"=>"body", "name"=>"booking", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"mode", "description"=>"if present and set to backend, treats the operation as if it was done by a manager"}, {"in"=>"query", "name"=>"notifyCustomer", "description"=>"whether to send a confirmation email to the customer"}, {"in"=>"query", "name"=>"notifyUsers", "description"=>"whether to send a notification email (and possibly SMS, depending on settings) to eligible users"}, {"in"=>"query", "name"=>"previousHoldId", "description"=>"if specified, deletes the hold with the given id"}, {"in"=>"query", "name"=>"sendCustomerReminders"}, {"in"=>"query", "name"=>"sendCustomerThankyou"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bookings"]}}, "/bookings/{bookingNumber}"=>{"get"=>{"summary"=>"Retrieve a booking", "description"=>"Retrieve a booking by its booking number", "operationId"=>"getBookingsBookingnumber", "x-api-path-slug"=>"bookingsbookingnumber-get", "parameters"=>[{"in"=>"path", "name"=>"bookingNumber"}, {"in"=>"query", "name"=>"expandCustomer", "description"=>"if true, the full details of the customer are included (provided the application has read permission over the customer)"}, {"in"=>"query", "name"=>"expandParticipants", "description"=>"if true, full details of the participants are included (provided the application has read permission over the participant)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bookings", "BookingNumber"]}, "put"=>{"summary"=>"Update an existing booking", "description"=>"Update an existing booking.", "operationId"=>"putBookingsBookingnumber", "x-api-path-slug"=>"bookingsbookingnumber-put", "parameters"=>[{"in"=>"body", "name"=>"booking", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bookingNumber"}, {"in"=>"query", "name"=>"mode", "description"=>"if present and set to backend, treats the operation as if it was done by a manager"}, {"in"=>"query", "name"=>"notifyCustomer"}, {"in"=>"query", "name"=>"notifyUsers"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bookings", "BookingNumber"]}, "delete"=>{"summary"=>"Cancel a booking", "description"=>"Cancel a booking. Cancelled bookings remain in the system, but no longer show up in the calendar or take up seats.", "operationId"=>"deleteBookingsBookingnumber", "x-api-path-slug"=>"bookingsbookingnumber-delete", "parameters"=>[{"in"=>"query", "name"=>"applyCancellationPolicy", "description"=>"if true, the default cancellation policy is applied"}, {"in"=>"path", "name"=>"bookingNumber"}, {"in"=>"query", "name"=>"cancelRemainingSeries", "description"=>"if true, and this booking is part of a recurring series, all following bookings will be cancelled as well"}, {"in"=>"query", "name"=>"notifyCustomer", "description"=>"if true, a notification email is sent to the customer"}, {"in"=>"query", "name"=>"notifyUsers", "description"=>"if true, notification emails and SMS are sent to authorized users"}, {"in"=>"query", "name"=>"reason", "description"=>"an optional reason that explains why the booking was cancelled"}, {"in"=>"query", "name"=>"trackInCustomerHistory", "description"=>"if true, the cancellation will be tracked in the customers stats"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bookings", "BookingNumber"]}}, "/bookings/{bookingNumber}/customer"=>{"get"=>{"summary"=>"Retrieve the customer associated with a booking", "description"=>"Retrieve the customer associated with a booking.", "operationId"=>"getBookingsBookingnumberCustomer", "x-api-path-slug"=>"bookingsbookingnumbercustomer-get", "parameters"=>[{"in"=>"path", "name"=>"bookingNumber"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bookings", "BookingNumber", "Customer"]}}, "/bookings/{bookingNumber}/payments"=>{"get"=>{"summary"=>"Get the payments received for a booking", "description"=>"Get a list of all payments received for a booking. Only payments for which the apiKey has at least read permission will be included", "operationId"=>"getBookingsBookingnumberPayments", "x-api-path-slug"=>"bookingsbookingnumberpayments-get", "parameters"=>[{"in"=>"path", "name"=>"bookingNumber"}, {"in"=>"query", "name"=>"itemsPerPage"}, {"in"=>"query", "name"=>"pageNavigationToken"}, {"in"=>"query", "name"=>"pageNumber"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bookings", "BookingNumber", "Payments"]}, "post"=>{"summary"=>"Add a payment to a booking", "description"=>"Create a payment record associated with a booking", "operationId"=>"postBookingsBookingnumberPayments", "x-api-path-slug"=>"bookingsbookingnumberpayments-post", "parameters"=>[{"in"=>"body", "name"=>"apiPayment", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"bookingNumber"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bookings", "BookingNumber", "Payments"]}}, "/customers"=>{"get"=>{"summary"=>"Retrieve customers", "description"=>"Get a list of customers.", "operationId"=>"getCustomers", "x-api-path-slug"=>"customers-get", "parameters"=>[{"in"=>"query", "name"=>"createdSince", "description"=>"if present, only include customers created since the given time"}, {"in"=>"query", "name"=>"currentMembers", "description"=>"if true, include customers that are current members"}, {"in"=>"query", "name"=>"currentNonMembers", "description"=>"if true, include customers that are not current members"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"number of items per page"}, {"in"=>"query", "name"=>"pageNavigationToken", "description"=>"if present, continues navigation after a previous call"}, {"in"=>"query", "name"=>"pageNumber"}, {"in"=>"query", "name"=>"searchField", "description"=>"a field on which to apply the search filter"}, {"in"=>"query", "name"=>"searchText", "description"=>"the text to search for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}, "post"=>{"summary"=>"Create a new customer.", "description"=>"Create a new customer.\n Please note there is a limit to the number of customers that can be imported in Bookeo. Bookeo is primarily a booking system, not a CRM.", "operationId"=>"postCustomers", "x-api-path-slug"=>"customers-post", "parameters"=>[{"in"=>"body", "name"=>"customer", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}}, "/customers/{customerid}/linkedpeople/{id}"=>{"get"=>{"summary"=>"Retrieve a person linked to a customer", "description"=>"Retrieve a person linked to a customer.", "operationId"=>"getCustomersCustomerLinkedpeople", "x-api-path-slug"=>"customerscustomeridlinkedpeopleid-get", "parameters"=>[{"in"=>"path", "name"=>"customerid"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Customerid", "Linkedpeople"]}, "put"=>{"summary"=>"Update the details of a person linked to a customer", "description"=>"Update the details of a person linked to a customer.", "operationId"=>"putCustomersCustomerLinkedpeople", "x-api-path-slug"=>"customerscustomeridlinkedpeopleid-put", "parameters"=>[{"in"=>"body", "name"=>"apiLinkedPerson", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"customerid"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Customerid", "Linkedpeople"]}, "delete"=>{"summary"=>"Delete a person linked to a customer", "description"=>"Delete a person linked to a customer.", "operationId"=>"deleteCustomersCustomerLinkedpeople", "x-api-path-slug"=>"customerscustomeridlinkedpeopleid-delete", "parameters"=>[{"in"=>"path", "name"=>"customerid"}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Customerid", "Linkedpeople"]}}, "/customers/{id}"=>{"get"=>{"summary"=>"Retrieve a customer", "description"=>"Retrieve a customer by its id", "operationId"=>"getCustomers", "x-api-path-slug"=>"customersid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}, "put"=>{"summary"=>"Update an existing customer", "description"=>"Update an existing customer.", "operationId"=>"putCustomers", "x-api-path-slug"=>"customersid-put", "parameters"=>[{"in"=>"body", "name"=>"customer", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}, "delete"=>{"summary"=>"Delete a customer", "description"=>"Delete a customer.\n Please note it is not possible to delete customers that have bookings in the future, and that are not cancelled.\n If your application needs to delete a customer with future bookings, make sure to cancel all future bookings for that customer first.", "operationId"=>"deleteCustomers", "x-api-path-slug"=>"customersid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers"]}}, "/customers/{id}/authenticate"=>{"get"=>{"summary"=>"Check a customer's password", "description"=>"The customer's email address is the \"username\" used by Bookeo to authenticate customers.\n So to authenticate a customer your application would typically use GET /customers to search for customers with a given email address, and then GET /customers/{id}/authenticate to authenticate.\n Remember that there may be duplicate customer records with the same email address, ex. due to duplicate importing or manual record creation.", "operationId"=>"getCustomersAuthenticate", "x-api-path-slug"=>"customersidauthenticate-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"password", "description"=>"remember to use URL encoding"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Authenticate"]}}, "/customers/{id}/bookings"=>{"get"=>{"summary"=>"Retrieve a customer's bookings", "description"=>"Retrieve a customer's bookings.", "operationId"=>"getCustomersBookings", "x-api-path-slug"=>"customersidbookings-get", "parameters"=>[{"in"=>"query", "name"=>"beginDate", "description"=>"if specified, only bookings on or after this date will be included"}, {"in"=>"query", "name"=>"endDate", "description"=>"if specified, only bookings on or before this date will be included"}, {"in"=>"query", "name"=>"expandParticipants", "description"=>"if true, full details of the participants are included (provided the application has read permission over the participant)"}, {"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"itemsPerPage"}, {"in"=>"query", "name"=>"pageNavigationToken"}, {"in"=>"query", "name"=>"pageNumber"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Bookings"]}}, "/customers/{id}/linkedpeople"=>{"get"=>{"summary"=>"Get the people linked to a customer", "description"=>"Get the people linked to a customer.", "operationId"=>"getCustomersLinkedpeople", "x-api-path-slug"=>"customersidlinkedpeople-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"maximum: 100"}, {"in"=>"query", "name"=>"pageNavigationToken"}, {"in"=>"query", "name"=>"pageNumber"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Customers", "Linkedpeople"]}}, "/holds"=>{"post"=>{"summary"=>"Create a temporary hold to finalize the booking", "description"=>"Performs a final check of the booking, and reserves required resources/seats to allow finalization of the booking process (ex. process payment).\n The returned object also contains the updated price calculations.\n Normally your application should have no more than one hold in place during a customer booking process.\n Make sure to not leave many holds around. In any case, holds are deleted automatically after a fixed time from creation.\n Note that when creating a hold, the customer field of the booking can be missing, in which case Bookeo will assume a default customer coming from the same country as the account.\n The successful response also contains a \"Location\" HTTP header, which can be used to access the created resource in future invocations.", "operationId"=>"postHolds", "x-api-path-slug"=>"holds-post", "parameters"=>[{"in"=>"body", "name"=>"booking", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"holdDurationSeconds", "description"=>"the required seats/resources will be reserved for the specified time, ensuring that they cannot be taken by other bookings during this time"}, {"in"=>"query", "name"=>"previousHoldId", "description"=>"if a previous hold was created during the same session with the customer, it will be automatically removed and replaced by the new one"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Holds"]}}, "/holds/{id}"=>{"get"=>{"summary"=>"Retrieve a hold previously generated", "description"=>"Retrieve a hold previously generated.", "operationId"=>"getHolds", "x-api-path-slug"=>"holdsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Holds"]}, "delete"=>{"summary"=>"Delete a temporary hold", "description"=>"Delete a temporary hold previously created.\n Note that you can also delete a hold when creating a new hold (ex. when the customer goes back in the booking process and selects a different time), or when creating a booking (i.e. when the customer checks out), without having to make a separate call to this endpoint.", "operationId"=>"deleteHolds", "x-api-path-slug"=>"holdsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Holds"]}}, "/payments"=>{"get"=>{"summary"=>"Get a list of payments received", "description"=>"Get a list of payments received.", "operationId"=>"getPayments", "x-api-path-slug"=>"payments-get", "parameters"=>[{"in"=>"query", "name"=>"endTime"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"maximum: 300"}, {"in"=>"query", "name"=>"pageNavigationToken"}, {"in"=>"query", "name"=>"pageNumber"}, {"in"=>"query", "name"=>"paymentMethod"}, {"in"=>"query", "name"=>"paymentMethodOther"}, {"in"=>"query", "name"=>"startTime"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}}, "/payments/{id}"=>{"get"=>{"summary"=>"Retrieve a specific payment", "description"=>"Retrieve a specific payment.", "operationId"=>"getPayments", "x-api-path-slug"=>"paymentsid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Payments"]}}, "/resourceblocks"=>{"get"=>{"summary"=>"Retrieve resource blocks", "description"=>"Retrieve existing resource blocks\n The result is limited by the permissions of the apiKey.\n \n It is possible to filter by time blocked and/or time of the last change.\n To filter by time blocked, the parameters startTime and endTime are required.\n To filter by last time changed, the parameters lastUpdatedStartTime and lastUpdatedEndTime are required.\n It is possible to filter by both at the same time. At least one of the two filters must be used.\n \n It is further possible to filter by resource.", "operationId"=>"getResourceblocks", "x-api-path-slug"=>"resourceblocks-get", "parameters"=>[{"in"=>"query", "name"=>"endTime", "description"=>"if specified, only include blocks that start on or before this time"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"maximum: 100"}, {"in"=>"query", "name"=>"lastUpdatedEndTime", "description"=>"if specified, only include blocks that were last changed (or created) on or before this time"}, {"in"=>"query", "name"=>"lastUpdatedStartTime", "description"=>"if specified, only include blocks that were last changed (or created) on or after this time"}, {"in"=>"query", "name"=>"pageNavigationToken"}, {"in"=>"query", "name"=>"pageNumber"}, {"in"=>"query", "name"=>"resourceId", "description"=>"if specified, only include blocks that affect this resource"}, {"in"=>"query", "name"=>"startTime", "description"=>"if specified, only include blocks that start on or after this time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resourceblocks"]}, "post"=>{"summary"=>"Create a new resource block", "description"=>"\"blocks\" time for one or more resources, so that they're not available for booking.\n A resource block must be for at least one resource, but it can block more than one.\n When setting the resources in the block, only the id is required.", "operationId"=>"postResourceblocks", "x-api-path-slug"=>"resourceblocks-post", "parameters"=>[{"in"=>"body", "name"=>"block", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resourceblocks"]}}, "/resourceblocks/{id}"=>{"get"=>{"summary"=>"Retrieve a block", "description"=>"Retrieve a block by its id", "operationId"=>"getResourceblocks", "x-api-path-slug"=>"resourceblocksid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resourceblocks"]}, "put"=>{"summary"=>"Update an existing block", "description"=>"A resource block must be for at least one resource, but it can block more than one.\n When setting the resources in the block, only the id is required.", "operationId"=>"putResourceblocks", "x-api-path-slug"=>"resourceblocksid-put", "parameters"=>[{"in"=>"body", "name"=>"block", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resourceblocks"]}, "delete"=>{"summary"=>"Delete a block", "description"=>"Delete a block.", "operationId"=>"deleteResourceblocks", "x-api-path-slug"=>"resourceblocksid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resourceblocks"]}}, "/seatblocks"=>{"get"=>{"summary"=>"Retrieve seat blocks", "description"=>"Retrieve existing seat blocks\n The result is limited by the permissions of the apiKey.\n \n It is possible to filter by time blocked and/or time of the last change.\n To filter by time blocked, the parameters startTime and endTime are required.\n To filter by last time changed, the parameters lastUpdatedStartTime and lastUpdatedEndTime are required.\n It is possible to filter by both at the same time. At least one of the two filters must be used.\n \n It is further possible to filter by product id.", "operationId"=>"getSeatblocks", "x-api-path-slug"=>"seatblocks-get", "parameters"=>[{"in"=>"query", "name"=>"endTime", "description"=>"if specified, only include blocks that start on or before this time"}, {"in"=>"query", "name"=>"itemsPerPage", "description"=>"maximum: 100"}, {"in"=>"query", "name"=>"lastUpdatedEndTime", "description"=>"if specified, only include blocks that were last changed (or created) on or before this time"}, {"in"=>"query", "name"=>"lastUpdatedStartTime", "description"=>"if specified, only include blocks that were last changed (or created) on or after this time"}, {"in"=>"query", "name"=>"pageNavigationToken"}, {"in"=>"query", "name"=>"pageNumber"}, {"in"=>"query", "name"=>"productId", "description"=>"if specified, only include blocks for this product"}, {"in"=>"query", "name"=>"startTime", "description"=>"if specified, only include blocks that start on or after this time"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Seatblocks"]}, "post"=>{"summary"=>"Create a new seat block", "description"=>"\"blocks\" a given number of seats, so that they're not available for booking.", "operationId"=>"postSeatblocks", "x-api-path-slug"=>"seatblocks-post", "parameters"=>[{"in"=>"body", "name"=>"block", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Seatblocks"]}}, "/seatblocks/{id}"=>{"get"=>{"summary"=>"Retrieve a block", "description"=>"Retrieve a block by its id", "operationId"=>"getSeatblocks", "x-api-path-slug"=>"seatblocksid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Seatblocks"]}, "put"=>{"summary"=>"Update an existing block", "description"=>"Updates an existing seat block", "operationId"=>"putSeatblocks", "x-api-path-slug"=>"seatblocksid-put", "parameters"=>[{"in"=>"body", "name"=>"block", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Seatblocks"]}, "delete"=>{"summary"=>"Delete a block", "description"=>"Delete a block.", "operationId"=>"deleteSeatblocks", "x-api-path-slug"=>"seatblocksid-delete", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Seatblocks"]}}, "/settings/apikeyinfo"=>{"get"=>{"summary"=>"Get information about your own API Key", "description"=>"Get information about your own api key.", "operationId"=>"getSettingsApikeyinfo", "x-api-path-slug"=>"settingsapikeyinfo-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settings", "Apikeyinfo"]}}, "/settings/business"=>{"get"=>{"summary"=>"Get information, location and contact details about the business", "description"=>"Get information, location and contact details about the business.", "operationId"=>"getSettingsBusiness", "x-api-path-slug"=>"settingsbusiness-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settings", "Business"]}}, "/settings/languages"=>{"get"=>{"summary"=>"Retrieve all supported languages", "description"=>"Retrieve all supported languages.", "operationId"=>"getSettingsLanguages", "x-api-path-slug"=>"settingslanguages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settings", "Languages"]}}, "/settings/peoplecategories"=>{"get"=>{"summary"=>"Retrieve all supported people categories", "description"=>"Retrieve the people categories supported by this account.\n This can include the default ones (\"Adults\",\"Children\",\"Infants\") and also custom ones defined by the account (\"Students\", ...)", "operationId"=>"getSettingsPeoplecategories", "x-api-path-slug"=>"settingspeoplecategories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settings", "Peoplecategories"]}}, "/settings/products"=>{"get"=>{"summary"=>"Get information about the products offered", "description"=>"Get information about all the products (things that can be booked) offered.\n 3 types of product are available:\n - fixed are products with a fixed schedule and a given number of seats. Ex a group tour, a class, a workshop\n - fixedCourse are fixed products that are defined as a course, i.e. comprise of a series of dates\n - flexibleTime are products that describe private appointments, i.e. when one booking uses one resource (teacher, consultant, etc)\n\n Although Bookeo applies a minimum amount of caching, it is recommended to cache these results for 10-15 minutes to improve the performance of your application, as product settings change rarely.", "operationId"=>"getSettingsProducts", "x-api-path-slug"=>"settingsproducts-get", "parameters"=>[{"in"=>"query", "name"=>"itemsPerPage"}, {"in"=>"query", "name"=>"pageNavigationToken"}, {"in"=>"query", "name"=>"pageNumber"}, {"in"=>"query", "name"=>"type", "description"=>"if not specified, get all products"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settings", "Products"]}}, "/settings/resources"=>{"get"=>{"summary"=>"Retrieve all available resources", "description"=>"Retrieve all available resources.", "operationId"=>"getSettingsResources", "x-api-path-slug"=>"settingsresources-get", "parameters"=>[{"in"=>"query", "name"=>"itemsPerPage", "description"=>"maximum: 100"}, {"in"=>"query", "name"=>"pageNavigationToken"}, {"in"=>"query", "name"=>"pageNumber"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settings", "Resources"]}}, "/settings/taxes"=>{"get"=>{"summary"=>"Retrieve all taxes used by this business", "description"=>"Retrieve all taxes used by this business.", "operationId"=>"getSettingsTaxes", "x-api-path-slug"=>"settingstaxes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settings", "Taxes"]}}, "/subaccounts"=>{"get"=>{"summary"=>"List all subaccounts in the portal", "description"=>"Retrieve all the webhooks for this api key", "operationId"=>"getSubaccounts", "x-api-path-slug"=>"subaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"itemsPerPage", "description"=>"maximum: 300"}, {"in"=>"query", "name"=>"pageNavigationToken"}, {"in"=>"query", "name"=>"pageNumber"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subaccounts"]}}, "/subaccounts/{subaccountId}/apikeys"=>{"post"=>{"summary"=>"Create a new API Key for this application to access a subaccount", "description"=>"Install this application in a subaccount.\n Note that the API key used in this call must be that of the portal manager account. The application installed in the subaccount will be the same as this one, with the same permissions.\n If this application was already installed in the subaccount, its API key will be replaced by the one created in this call.", "operationId"=>"postSubaccountsSubaccountApikeys", "x-api-path-slug"=>"subaccountssubaccountidapikeys-post", "parameters"=>[{"in"=>"path", "name"=>"subaccountId", "description"=>"the id of the subaccount where to install this application"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subaccounts", "SubaccountId", "Apikeys"]}}, "/subaccounts/{subaccountId}/apikeys/{apiKey}"=>{"delete"=>{"summary"=>"Delete the API Key for this application from a subaccount", "description"=>"Delete the api key for this application from a subaccount.", "operationId"=>"deleteSubaccountsSubaccountApikeysApikey", "x-api-path-slug"=>"subaccountssubaccountidapikeysapikey-delete", "parameters"=>[{"in"=>"path", "name"=>"apiKey"}, {"in"=>"path", "name"=>"subaccountId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subaccounts", "SubaccountId", "Apikeys", "ApiKey"]}}, "/webhooks"=>{"get"=>{"summary"=>"List all webhooks", "description"=>"Retrieve all the webhooks for this api key", "operationId"=>"getWebhooks", "x-api-path-slug"=>"webhooks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}, "post"=>{"summary"=>"Create a new webhook", "description"=>"Note that if an existing webhook for the same domain and type was already set for this api key, it will be automatically replaced by this new webhook.\n In other words, there can be only one webhook for each combination of domain and type, for an API key.\n So to upgrade an existing webhook URL, simply create a new one with the same domain and type, but a different URL.\n\n For webhook with domain \"bookings\" and type \"deleted\", the notification will be sent whether the booking is canceled or completely deleted.\n Users can delete bookings by, for example, deleting their associated customer.\n Also note that these \"bookings\" \"deleted\" notifications are sent even for bookings in the past.", "operationId"=>"postWebhooks", "x-api-path-slug"=>"webhooks-post", "parameters"=>[{"in"=>"body", "name"=>"webhook", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}}, "/webhooks/{webhookId}"=>{"get"=>{"summary"=>"Retrieve a webhook", "description"=>"Retrieve a webhook.", "operationId"=>"getWebhooksWebhook", "x-api-path-slug"=>"webhookswebhookid-get", "parameters"=>[{"in"=>"path", "name"=>"webhookId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "WebhookId"]}, "delete"=>{"summary"=>"Delete a webhook", "description"=>"Delete a webhook.", "operationId"=>"deleteWebhooksWebhook", "x-api-path-slug"=>"webhookswebhookid-delete", "parameters"=>[{"in"=>"path", "name"=>"webhookId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "WebhookId"]}}}}, "apis"=>{"name"=>"Bookeo", "x-slug"=>"bookeo", "description"=>"Bookeo provides a leading online booking and scheduling system for tours, classes, and appointments, to help you save money and time. Click to learn more!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28769-www-bookeo-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"23042", "tags"=>"Bookings,Relative Data,Schedules,Service API,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"bookeo/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Bookeo", "x-api-slug"=>"bookeo", "description"=>"Bookeo provides a leading online booking and scheduling system for tours, classes, and appointments, to help you save money and time. Click to learn more!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28769-www-bookeo-com.jpg", "humanURL"=>"https://www.bookeo.com", "baseURL"=>"https://api.bookeo.com//v2", "tags"=>"Bookings,Relative Data,Schedules,Service API,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/bookeo/bookeo-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/bookeo"}, {"type"=>"x-developer", "url"=>"https://www.bookeo.com/api/"}, {"type"=>"x-documentation", "url"=>"https://www.bookeo.com/apiref/index.html"}, {"type"=>"x-partners", "url"=>"https://www.bookeo.com/affiliate/"}, {"type"=>"x-privacy-policy", "url"=>"https://www.bookeo.com/privacy/"}, {"type"=>"x-terms-of-service", "url"=>"https://www.bookeo.com/termsofservice/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/bookeo"}, {"type"=>"x-webhook", "url"=>"https://www.bookeo.com/api/webhooks/"}, {"type"=>"x-website", "url"=>"https://www.bookeo.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
washington-metropolitan-area-transit-authority{"wmata-bus-route-and-stop-methods-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Washington Metropolitan Area Transit Authority", "x-complete"=>1, "info"=>{"title"=>"Bus Route and Stop Methods", "description"=>"bus-stop-information-route-and-schedule-data-and-bus-positions-", "version"=>"1.0.0"}, "host"=>"api.wmata.com", "basePath"=>"/Bus.svc", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/json/jBusPositions"=>{"get"=>{"summary"=>"JSON - Bus Position", "description"=>"Description\n\nReturns bus positions for the given route, with an optional search radius.\nIf no parameters are specified, all bus positions are returned.\n\nNote that the RouteID parameter accepts only base route names and no\nvariations, i.e.: use 10A instead of 10Av1 or 10Av2.\n\nBus positions are refreshed approximately every 20 to 30 7 to 10 seconds.\n\nResponse Elements\n\n\n\n\nElement\n\nDescription\n\n\n\n\n\nBusPositions\n\n\nArray containing bus position information (BusPositions).\n\n\n\n\n\n\nBusPosition\nElements\n\n\n\n\n\nDateTime\n\nDate and time (Eastern Standard Time) of last position update.\nWill be in YYYY-MM-DDTHH:mm:ss format (e.g.:\n2014-10-27T13:23:40).\n\n\n\nDeviation\n\nDeviation, in minutes, from schedule. Positive values indicate\nthat the bus is running late while negative ones are for buses\nrunning ahead of schedule.\n\n\n\nDirectionNum\n\nDeprecated. Use the\nDirectionText for a customer-friendly description of\ndirection.\n\n\n\nDirectionText\n\nGeneral direction of the trip, not the bus itself (e.g.: NORTH,\nSOUTH, EAST, WEST).\n\n\n\nLat\n\nLast reported Latitude of the bus.\n\n\n\nLon\n\nLast reported Longitude of the bus.\n\n\n\nRouteID\n\nBase route name as shown on the bus. Note that the base route\nname could also refer to any variant, so a RouteID of 10A could\nrefer to 10A, 10Av1, 10Av2, etc.\n\n\n\nTripEndTime\n\nScheduled end date and time (Eastern Standard Time) of the\nbus's current trip. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\n2014-10-27T13:17:00).\n\n\n\nTripHeadsign\n\nDestination of the bus.\n\n\n\nTripID\n\nUnique trip ID. This can be correlated with the data returned\nfrom the schedule-related methods.\n\n\n\nTripStartTime\n\nScheduled start date and time (Eastern Standard Time) of the\nbus's current trip. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\n2014-10-27T12:40:00).\n\n\n\nVehicleID\n\nUnique identifier for the bus. This is usually visible on the\nbus itself.", "operationId"=>"5476362a281d830c946a3d68", "x-api-path-slug"=>"jsonjbuspositions-get", "parameters"=>[{"in"=>"query", "name"=>"Lat", "description"=>"Center point Latitude, required if Longitude and Radius are specified"}, {"in"=>"query", "name"=>"Lon", "description"=>"Center point Longitude, required if Latitude and Radius are specified"}, {"in"=>"query", "name"=>"Radius", "description"=>"Radius (meters) to include in the search area, required if Latitude and Longitude are specified"}, {"in"=>"query", "name"=>"RouteID", "description"=>"Base bus route, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buses", "Positions"]}}, "/json/jRouteDetails"=>{"get"=>{"summary"=>"JSON - Path Details", "description"=>"Description\r\n\r\nFor a given date, returns the set of ordered latitude/longitude points along\r\na route variant along with the list of stops served.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nDirection0/Direction1\r\n\r\n\r\nStructures describing path/stop\r\ninformation.\r\n\r\nMost routes will return content in both Direction0 and\r\nDirection1 elements, though a few will return NULL for Direction0 or for Direction1.\r\n\r\n0 or 1 are binary properties. There is no specific mapping to\r\ndirection, but a different value for the same route signifies\r\nthat the route is in an opposite direction.\r\n\r\n\r\n\r\n\r\nName\r\n\r\nDescriptive name for the route.\r\n\r\n\r\n\r\nRouteID\r\n\r\nBus route variant (e.g.: 10A, 10Av1, etc.).\r\n\r\n\r\n\r\n\r\n\r\nDirection0/Direction1\r\nElements\r\n\r\n\r\n\r\n\r\n\r\nDirectionNum\r\n\r\nDeprecated. Use the\r\nDirectionText element to denote the general direction of the route\r\nvariant.\r\n\r\n\r\n\r\nDirectionText\r\n\r\nGeneral direction of the route variant (NORTH, SOUTH, EAST,\r\nWEST, LOOP, etc.).\r\n\r\n\r\n\r\nShape\r\n\r\n\r\nArray containing shape point information (ShapePoint).\r\n\r\n\r\n\r\n\r\nStops\r\n\r\n\r\nArray containing stop information (Stop).\r\n\r\n\r\n\r\n\r\nTripHeadsign\r\n\r\nDescriptive text of where the bus is headed. This is similar,\r\nbut not necessarily identical, to what is displayed on the\r\nbus.\r\n\r\n\r\n\r\n\r\n\r\nShapePoint\r\nElements\r\n\r\n\r\n\r\n\r\n\r\nLat\r\n\r\nLatitude.\r\n\r\n\r\n\r\nLon\r\n\r\nLongitude.\r\n\r\n\r\n\r\nSeqNum\r\n\r\nOrder of the point in the sequence of ShapePoints.\r\n\r\n\r\n\r\n\r\n\r\nStop Elements\r\n\r\n\r\n\r\n\r\n\r\nLat\r\n\r\nLatitude.\r\n\r\n\r\n\r\nLon\r\n\r\nLongitude.\r\n\r\n\r\n\r\nName\r\n\r\nStop name. May be slightly different from what is spoken or\r\ndisplayed in the bus.\r\n\r\n\r\n\r\nRoutes\r\n\r\nString array of route variants which provide service at this\r\nstop. Note that these are not date-specific; any route variant\r\nwhich stops at this stop on any day will be listed.\r\n\r\n\r\n\r\nStopID\r\n\r\n7-digit regional ID which can be used in various bus-related\r\nmethods. If unavailable, the StopID will be 0 or NULL.", "operationId"=>"5476362a281d830c946a3d69", "x-api-path-slug"=>"jsonjroutedetails-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"Date in YYYY-MM-DD format for which to retrieve route and stop information"}, {"in"=>"query", "name"=>"RouteID", "description"=>"Bus route variant, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buses", "Routes"]}}, "/json/jRoutes"=>{"get"=>{"summary"=>"JSON - Routes", "description"=>"Description\r\n\r\nReturns a list of all bus route variants (patterns). For example, the 10A\r\nand 10Av1 are the same route, but may stop at slightly different locations.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nRoutes\r\n\r\n\r\nArray containing route variant information (Route).\r\n\r\n\r\n\r\n\r\n\r\n\r\nRoute Elements\r\n\r\n\r\n\r\n\r\n\r\nName\r\n\r\nDescriptive name of the route variant.\r\n\r\n\r\n\r\nRouteID\r\n\r\nUnique identifier for a given route variant. Can be used in\r\nvarious other bus-related methods.\r\n\r\n\r\n\r\nLineDescription\r\n\r\nDenotes the route variant???s grouping ??? lines are a combination of routes which lie in the same corridor and which have significant portions of their paths along the same roadways.", "operationId"=>"5476362a281d830c946a3d6a", "x-api-path-slug"=>"jsonjroutes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buses", "Routes"]}}, "/json/jRouteSchedule"=>{"get"=>{"summary"=>"JSON - Schedule", "description"=>"Description\r\n\r\nReturns schedules for a given route variant for a given date.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nDirection0/Direction1\r\n\r\n\r\nArrays containing trip information (Trip).\r\n\r\nMost routes will return content in both Direction0 and\r\nDirection1 elements, though a few (especially ones which run in\r\na loop, such as the U8) will return content only for Direction0\r\nand NULL content for Direction1.\r\n\r\n0 or 1 are binary properties. There is no specific mapping to\r\ndirection, but a different value for the same route signifies\r\nthat the route is in an opposite direction.\r\n\r\n\r\n\r\n\r\nName\r\n\r\nDescriptive name for the route.\r\n\r\n\r\n\r\n\r\n\r\nTrip Elements\r\n\r\n\r\n\r\n\r\n\r\nDirectionNum\r\n\r\nDeprecated. Use the\r\nTripDirectionText element to denote the general direction of the\r\ntrip.\r\n\r\n\r\n\r\nEndTime\r\n\r\nScheduled end date and time (Eastern Standard Time) for this\r\ntrip. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\r\n2014-10-27T13:17:00).\r\n\r\n\r\n\r\nRouteID\r\n\r\nBus route variant. This can be used in several other bus\r\nmethods which accept variants.\r\n\r\n\r\n\r\nStartTime\r\n\r\nScheduled start date and time (Eastern Standard Time) for this\r\ntrip. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\r\n2014-10-27T13:17:00).\r\n\r\n\r\n\r\nStopTimes\r\n\r\n\r\nArray containing location and time information (StopTime).\r\n\r\n\r\n\r\n\r\nTripDirectionText\r\n\r\nGeneral direction of the trip (NORTH, SOUTH, EAST, WEST, LOOP,\r\netc.).\r\n\r\n\r\n\r\nTripHeadsign\r\n\r\nDescriptive text of where the bus is headed. This is similar,\r\nbut not necessarily identical, to what is displayed on the\r\nbus.\r\n\r\n\r\n\r\nTripID\r\n\r\nUnique trip ID. This can be correlated with the data returned\r\nfrom the schedule-related methods.\r\n\r\n\r\n\r\n\r\n\r\nStopTime Elements\r\n\r\n\r\n\r\n\r\n\r\nStopID\r\n\r\n7-digit regional ID which can be used in various bus-related\r\nmethods. If unavailable, the StopID will be 0 or NULL.\r\n\r\n\r\n\r\nStopName\r\n\r\nStop name. May be slightly different from what is spoken or\r\ndisplayed in the bus.\r\n\r\n\r\n\r\nStopSeq\r\n\r\nOrder of the stop in the sequence of StopTimes.\r\n\r\n\r\n\r\nTime\r\n\r\nScheduled departure date and time (Eastern Standard Time) from\r\nthis stop. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\r\n2014-10-27T13:17:00).", "operationId"=>"5476362a281d830c946a3d6b", "x-api-path-slug"=>"jsonjrouteschedule-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"Date in YYYY-MM-DD format for which to retrieve schedule"}, {"in"=>"query", "name"=>"IncludingVariations", "description"=>"Whether or not to include variations if a base route is specified in RouteID"}, {"in"=>"query", "name"=>"RouteID", "description"=>"Bus route variant, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buses", "Routes", "Schedules"]}}, "/json/jStopSchedule"=>{"get"=>{"summary"=>"JSON - Schedule at Stop", "description"=>"Description\r\n\r\nReturns a set of buses scheduled at a stop for a given date.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nScheduleArrivals\r\n\r\n\r\nArray containing scheduled arrival information (ScheduleArrival).\r\n\r\n\r\n\r\n\r\nStop\r\n\r\n\r\nStructure describing stop information.\r\n\r\n\r\n\r\n\r\n\r\n\r\nScheduleArrival Elements\r\n\r\n\r\n\r\n\r\n\r\nDirectionNum\r\n\r\nDenotes a binary direction (0 or 1) of the bus. There is no\r\nspecific mapping to direction, but a different value for the same\r\nroute signifies that the buses are traveling in opposite\r\ndirections. Use the TripDirectionText element to show the actual\r\ndestination of the bus.\r\n\r\n\r\n\r\nEndTime\r\n\r\nScheduled end date and time (Eastern Standard Time) for this\r\ntrip. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\r\n2014-10-27T13:17:00).\r\n\r\n\r\n\r\nRouteID\r\n\r\nBus route variant identifier (pattern). This variant can be\r\nused in several other bus methods which accept variants. Note that\r\ncustomers will never see anything other than the base route name,\r\nso variants 10A, 10Av1, 10Av2, etc. will be displayed as 10A on the\r\nbus.\r\n\r\n\r\n\r\nScheduleTime\r\n\r\nDate and time (Eastern Standard Time) when the bus is scheduled\r\nto stop at this location. Will be in YYYY-MM-DDTHH:mm:ss format\r\n(e.g.: 2014-10-27T13:17:00).\r\n\r\n\r\n\r\nStartTime\r\n\r\nScheduled start date and time (Eastern Standard Time) for this\r\ntrip. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\r\n2014-10-27T13:17:00).\r\n\r\n\r\n\r\nTripDirectionText\r\n\r\nGeneral direction of the trip (e.g.: NORTH, SOUTH, EAST,\r\nWEST).\r\n\r\n\r\n\r\nTripHeadsign\r\n\r\nDestination of the bus.\r\n\r\n\r\n\r\nTripID\r\n\r\nTrip identifier. This can be correlated with the data in our\r\nbus schedule information as well as bus positions.\r\n\r\n\r\n\r\n\r\n\r\nStop Elements\r\n\r\n\r\n\r\n\r\n\r\nLat\r\n\r\nLatitude.\r\n\r\n\r\n\r\nLon\r\n\r\nLongitude.\r\n\r\n\r\n\r\nName\r\n\r\nStop name. May be slightly different from what is spoken or\r\ndisplayed in the bus.\r\n\r\n\r\n\r\nRoutes\r\n\r\nString array of route variants which provide service at this\r\nstop. Note that these are not date-specific; any route variant\r\nwhich stops at this stop on any day will be listed.\r\n\r\n\r\n\r\nStopID\r\n\r\n7-digit regional ID which can be used in various bus-related\r\nmethods. If unavailable, the StopID will be 0 or NULL.", "operationId"=>"5476362a281d830c946a3d6c", "x-api-path-slug"=>"jsonjstopschedule-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"Date in YYYY-MM-DD format for which to retrieve schedule"}, {"in"=>"query", "name"=>"StopID", "description"=>"7-digit regional stop ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buses", "Stops", "Schedules"]}}, "/json/jStops"=>{"get"=>{"summary"=>"JSON - Stop Search", "description"=>"Description\r\n\r\nReturns a list of nearby bus stops based on latitude, longitude, and radius.\r\nOmit all parameters to retrieve a list of all stops.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nStops\r\n\r\n\r\nArray containing stop information (Stop).\r\n\r\n\r\n\r\n\r\n\r\n\r\nStop Elements\r\n\r\n\r\n\r\n\r\n\r\nLat\r\n\r\nLatitude.\r\n\r\n\r\n\r\nLon\r\n\r\nLongitude.\r\n\r\n\r\n\r\nName\r\n\r\nStop name. May be slightly different from what is spoken or\r\ndisplayed in the bus.\r\n\r\n\r\n\r\nRoutes\r\n\r\nString array of route variants which provide service at this\r\nstop. Note that these are not date-specific; any route variant\r\nwhich stops at this stop on any day will be listed.\r\n\r\n\r\n\r\nStopID\r\n\r\n7-digit regional ID which can be used in various bus-related\r\nmethods. If unavailable, the StopID will be 0 or NULL.", "operationId"=>"5476362a281d830c946a3d6d", "x-api-path-slug"=>"jsonjstops-get", "parameters"=>[{"in"=>"query", "name"=>"Lat", "description"=>"Center point Latitude, required if Longitude and Radius are specified"}, {"in"=>"query", "name"=>"Lon", "description"=>"Center point Longitude, required if Latitude and Radius are specified"}, {"in"=>"query", "name"=>"Radius", "description"=>"Radius (meters) to include in the search area, required if Latitude and Longitude are specified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buses", "Stops"]}}, "/BusPositions"=>{"get"=>{"summary"=>"XML - Bus Position", "description"=>"Description\n\nReturns bus positions for the given route, with an optional search radius.\nIf no parameters are specified, all bus positions are returned.\n\nNote that the RouteID parameter accepts only base route names and no\nvariations, i.e.: use 10A instead of 10Av1 or 10Av2.\n\nBus positions are refreshed approximately every 20 to 30 7 to 10 seconds.\n\nResponse Elements\n\n\n\n\nElement\n\nDescription\n\n\n\n\n\nBusPositions\n\n\nArray containing bus position information (BusPositions).\n\n\n\n\n\n\nBusPosition\nElements\n\n\n\n\n\nDateTime\n\nDate and time (Eastern Standard Time) of last position update.\nWill be in YYYY-MM-DDTHH:mm:ss format (e.g.:\n2014-10-27T13:23:40).\n\n\n\nDeviation\n\nDeviation, in minutes, from schedule. Positive values indicate\nthat the bus is running late while negative ones are for buses\nrunning ahead of schedule.\n\n\n\nDirectionNum\n\nDeprecated. Use the\nDirectionText for a customer-friendly description of\ndirection.\n\n\n\nDirectionText\n\nGeneral direction of the trip, not the bus itself (e.g.: NORTH,\nSOUTH, EAST, WEST).\n\n\n\nLat\n\nLast reported Latitude of the bus.\n\n\n\nLon\n\nLast reported Longitude of the bus.\n\n\n\nRouteID\n\nBase route name as shown on the bus. Note that the base route\nname could also refer to any variant, so a RouteID of 10A could\nrefer to 10A, 10Av1, 10Av2, etc.\n\n\n\nTripEndTime\n\nScheduled end date and time (Eastern Standard Time) of the\nbus's current trip. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\n2014-10-27T13:17:00).\n\n\n\nTripHeadsign\n\nDestination of the bus.\n\n\n\nTripID\n\nUnique trip ID. This can be correlated with the data returned\nfrom the schedule-related methods.\n\n\n\nTripStartTime\n\nScheduled start date and time (Eastern Standard Time) of the\nbus's current trip. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\n2014-10-27T12:40:00).\n\n\n\nVehicleID\n\nUnique identifier for the bus. This is usually visible on the\nbus itself.", "operationId"=>"5476362a281d830c946a3d6e", "x-api-path-slug"=>"buspositions-get", "parameters"=>[{"in"=>"query", "name"=>"Lat", "description"=>"Center point Latitude, required if Longitude and Radius are specified"}, {"in"=>"query", "name"=>"Lon", "description"=>"Center point Longitude, required if Latitude and Radius are specified"}, {"in"=>"query", "name"=>"Radius", "description"=>"Radius (meters) to include in the search area, required if Latitude and Longitude are specified"}, {"in"=>"query", "name"=>"RouteID", "description"=>"Bus route, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buses", "Positions"]}}, "/RouteDetails"=>{"get"=>{"summary"=>"XML - Path Details", "description"=>"Description\r\nFor a given date, returns the set of ordered latitude/longitude points along route variant along with the list of stops served.\r\nResponse Elements\r\n\r\n\r\n\r\nElement\r\nDescription\r\n\r\n\r\n\r\n\r\nDirection0/Direction1\r\n\r\nStructures describing path/stopinformation.\r\n\r\nMost routes will return content in both Direction0 and Direction1 elements, though a few will return NULL for Direction0 or for Direction1.\r\n\r\n0 or 1 are binary properties. There is no specific mapping to direction, but a different value for the same route signifies that the route is in an opposite direction.\r\n\r\n\r\n\r\nName\r\nDescriptive name for the route.\r\n\r\n\r\nRouteID\r\nBus route variant (e.g.: 10A, 10Av1, etc.).\r\n\r\n\r\n\r\n\r\nDirection0/Direction1 Elements\r\n\r\n\r\n\r\n\r\nDirectionNum\r\nDeprecated. Use the DirectionText element to denote the general direction of the route variant.\r\n\r\n\r\nDirectionText\r\nGeneral direction of the route variant (NORTH, SOUTH, EAST, WEST, LOOP, etc.).\r\n\r\n\r\nShape\r\n\r\nArray containing shape point information (ShapePoint).\r\n\r\n\r\n\r\nStops\r\n\r\nArray containing stop information (Stop).\r\n\r\n\r\n\r\nTripHeadsign\r\nDescriptive text of where the bus is headed. This is similar, but not necessarily identical, to what is displayed on the bus.\r\n\r\n\r\n\r\n\r\nShapePoint Elements\r\n\r\n\r\n\r\n\r\nLat\r\nLatitude.\r\n\r\n\r\nLon\r\nLongitude.\r\n\r\n\r\nSeqNum\r\nOrder of the point in the sequence of ShapePoints.\r\n\r\n\r\n\r\n \r\nStop Elements\r\n\r\n\r\n\r\n\r\nLat\r\nLatitude.\r\n\r\n\r\nLon\r\nLongitude.\r\n\r\n\r\nName\r\nStop name. May be slightly different from what is spoken or displayed in the bus.\r\n\r\n\r\nRoutes\r\nString array of route variants which provide service at this stop. Note that these are not date-specific; any route variant which stops at this stop on any day will be listed.\r\n\r\n\r\nStopID\r\n7-digit regional ID which can be used in various bus-related methods. If unavailable, the StopID will be 0 or NULL.", "operationId"=>"5476362a281d830c946a3d6f", "x-api-path-slug"=>"routedetails-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"Date in YYYY-MM-DD format for which to retrieve route and stop information"}, {"in"=>"query", "name"=>"RouteID", "description"=>"Bus route variant, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buses", "Routes"]}}, "/Routes"=>{"get"=>{"summary"=>"XML - Routes", "description"=>"Description\r\n\r\nReturns a list of all bus route variants (patterns). For example, the 10A\r\nand 10Av1 are the same route, but may stop at slightly different locations.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nRoutes\r\n\r\n\r\nArray containing route variant information (Route).\r\n\r\n\r\n\r\n\r\n\r\n\r\nRoute Elements\r\n\r\n\r\n\r\n\r\n\r\nName\r\n\r\nDescriptive name of the route variant.\r\n\r\n\r\n\r\nRouteID\r\n\r\nUnique identifier for a given route variant. Can be used in\r\nvarious other bus-related methods.\r\n\r\n\r\n\r\n\r\nLineDescription\r\n\r\nDenotes the route variant???s grouping ??? lines are a combination of routes which lie in the same corridor and which have significant portions of their paths along the same roadways.", "operationId"=>"5476362a281d830c946a3d70", "x-api-path-slug"=>"routes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buses", "Routes"]}}, "/RouteSchedule"=>{"get"=>{"summary"=>"XML - Schedule", "description"=>"Description\r\n\r\nReturns schedules for a given route variant for a given date.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nDirection0/Direction1\r\n\r\n\r\nArrays containing trip information (Trip).\r\n\r\nMost routes will return content in both Direction0 and\r\nDirection1 elements, though a few (especially ones which run in\r\na loop, such as the U8) will return content only for Direction0\r\nand NULL content for Direction1.\r\n\r\n0 or 1 are binary properties. There is no specific mapping to\r\ndirection, but a different value for the same route signifies\r\nthat the route is in an opposite direction.\r\n\r\n\r\n\r\n\r\nName\r\n\r\nDescriptive name for the route.\r\n\r\n\r\n\r\n\r\n\r\nTrip Elements\r\n\r\n\r\n\r\n\r\n\r\nDirectionNum\r\n\r\nDeprecated. Use the\r\nTripDirectionText element to denote the general direction of the\r\ntrip.\r\n\r\n\r\n\r\nEndTime\r\n\r\nScheduled end date and time (Eastern Standard Time) for this\r\ntrip. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\r\n2014-10-27T13:17:00).\r\n\r\n\r\n\r\nRouteID\r\n\r\nBus route variant. This can be used in several other bus\r\nmethods which accept variants.\r\n\r\n\r\n\r\nStartTime\r\n\r\nScheduled start date and time (Eastern Standard Time) for this\r\ntrip. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\r\n2014-10-27T13:17:00).\r\n\r\n\r\n\r\nStopTimes\r\n\r\n\r\nArray containing location and time information (StopTime).\r\n\r\n\r\n\r\n\r\nTripDirectionText\r\n\r\nGeneral direction of the trip (NORTH, SOUTH, EAST, WEST, LOOP,\r\netc.).\r\n\r\n\r\n\r\nTripHeadsign\r\n\r\nDescriptive text of where the bus is headed. This is similar,\r\nbut not necessarily identical, to what is displayed on the\r\nbus.\r\n\r\n\r\n\r\nTripID\r\n\r\nUnique trip ID. This can be correlated with the data returned\r\nfrom the schedule-related methods.\r\n\r\n\r\n\r\n\r\n\r\nStopTime Elements\r\n\r\n\r\n\r\n\r\n\r\nStopID\r\n\r\n7-digit regional ID which can be used in various bus-related\r\nmethods. If unavailable, the StopID will be 0 or NULL.\r\n\r\n\r\n\r\nStopName\r\n\r\nStop name. May be slightly different from what is spoken or\r\ndisplayed in the bus.\r\n\r\n\r\n\r\nStopSeq\r\n\r\nOrder of the stop in the sequence of StopTimes.\r\n\r\n\r\n\r\nTime\r\n\r\nScheduled departure date and time (Eastern Standard Time) from\r\nthis stop. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\r\n2014-10-27T13:17:00).", "operationId"=>"5476362a281d830c946a3d71", "x-api-path-slug"=>"routeschedule-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"Date in YYYY-MM-DD format for which to retrieve schedule"}, {"in"=>"query", "name"=>"IncludingVariations", "description"=>"Whether or not to include variations"}, {"in"=>"query", "name"=>"RouteID", "description"=>"Bus route variant, e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buses", "Stops", "Schedules"]}}, "/StopSchedule"=>{"get"=>{"summary"=>"XML - Schedule at Stop", "description"=>"Description\r\n\r\nReturns a set of buses scheduled at a stop for a given date.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nScheduleArrivals\r\n\r\n\r\nArray containing scheduled arrival information (ScheduleArrival).\r\n\r\n\r\n\r\n\r\nStop\r\n\r\n\r\nStructure describing stop information.\r\n\r\n\r\n\r\n\r\n\r\n\r\nScheduleArrival Elements\r\n\r\n\r\n\r\n\r\n\r\nDirectionNum\r\n\r\nDenotes a binary direction (0 or 1) of the bus. There is no\r\nspecific mapping to direction, but a different value for the same\r\nroute signifies that the buses are traveling in opposite\r\ndirections. Use the TripDirectionText element to show the actual\r\ndestination of the bus.\r\n\r\n\r\n\r\nEndTime\r\n\r\nScheduled end date and time (Eastern Standard Time) for this\r\ntrip. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\r\n2014-10-27T13:17:00).\r\n\r\n\r\n\r\nRouteID\r\n\r\nBus route variant identifier (pattern). This variant can be\r\nused in several other bus methods which accept variants. Note that\r\ncustomers will never see anything other than the base route name,\r\nso variants 10A, 10Av1, 10Av2, etc. will be displayed as 10A on the\r\nbus.\r\n\r\n\r\n\r\nScheduleTime\r\n\r\nDate and time (Eastern Standard Time) when the bus is scheduled\r\nto stop at this location. Will be in YYYY-MM-DDTHH:mm:ss format\r\n(e.g.: 2014-10-27T13:17:00).\r\n\r\n\r\n\r\nStartTime\r\n\r\nScheduled start date and time (Eastern Standard Time) for this\r\ntrip. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\r\n2014-10-27T13:17:00).\r\n\r\n\r\n\r\nTripDirectionText\r\n\r\nGeneral direction of the trip (e.g.: NORTH, SOUTH, EAST,\r\nWEST).\r\n\r\n\r\n\r\nTripHeadsign\r\n\r\nDestination of the bus.\r\n\r\n\r\n\r\nTripID\r\n\r\nTrip identifier. This can be correlated with the data in our\r\nbus schedule information as well as bus positions.\r\n\r\n\r\n\r\n\r\n\r\nStop Elements\r\n\r\n\r\n\r\n\r\n\r\nLat\r\n\r\nLatitude.\r\n\r\n\r\n\r\nLon\r\n\r\nLongitude.\r\n\r\n\r\n\r\nName\r\n\r\nStop name. May be slightly different from what is spoken or\r\ndisplayed in the bus.\r\n\r\n\r\n\r\nRoutes\r\n\r\nString array of route variants which provide service at this\r\nstop. Note that these are not date-specific; any route variant\r\nwhich stops at this stop on any day will be listed.\r\n\r\n\r\n\r\nStopID\r\n\r\n7-digit regional ID which can be used in various bus-related\r\nmethods. If unavailable, the StopID will be 0 or NULL.", "operationId"=>"5476362a281d830c946a3d72", "x-api-path-slug"=>"stopschedule-get", "parameters"=>[{"in"=>"query", "name"=>"Date", "description"=>"Date in YYYY-MM-DD format for which to retrieve schedule"}, {"in"=>"query", "name"=>"StopID", "description"=>"7-digit regional stop ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buses", "Stops", "Schedules"]}}, "/Stops"=>{"get"=>{"summary"=>"XML - Stop Search", "description"=>"Description\r\n\r\nReturns a list of nearby bus stops based on latitude, longitude, and radius.\r\nOmit all parameters to retrieve a list of all stops.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nStops\r\n\r\n\r\nArray containing stop information (Stop).\r\n\r\n\r\n\r\n\r\n\r\n\r\nStop Elements\r\n\r\n\r\n\r\n\r\n\r\nLat\r\n\r\nLatitude.\r\n\r\n\r\n\r\nLon\r\n\r\nLongitude.\r\n\r\n\r\n\r\nName\r\n\r\nStop name. May be slightly different from what is spoken or\r\ndisplayed in the bus.\r\n\r\n\r\n\r\nRoutes\r\n\r\nString array of route variants which provide service at this\r\nstop. Note that these are not date-specific; any route variant\r\nwhich stops at this stop on any day will be listed.\r\n\r\n\r\n\r\nStopID\r\n\r\n7-digit regional ID which can be used in various bus-related\r\nmethods. If unavailable, the StopID will be 0 or NULL.", "operationId"=>"5476362a281d830c946a3d73", "x-api-path-slug"=>"stops-get", "parameters"=>[{"in"=>"query", "name"=>"Lat", "description"=>"Center point Latitude, required if Longitude and Radius are specified"}, {"in"=>"query", "name"=>"Lon", "description"=>"Center point Longitude, required if Latitude and Radius are specified"}, {"in"=>"query", "name"=>"Radius", "description"=>"Radius (feet) to include in the search area, required if Latitude and Longitude are specified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Buses", "Stops"]}}}}, "wmata-realtime-rail-predictions-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Washington Metropolitan Area Transit Authority", "x-complete"=>1, "info"=>{"title"=>"Real-Time Rail Predictions", "description"=>"realtime-rail-prediction-methods-", "version"=>"1.0.0"}, "host"=>"api.wmata.com", "basePath"=>"/StationPrediction.svc", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/json/GetPrediction/{StationCodes}"=>{"get"=>{"summary"=>"JSON - Next Trains", "description"=>"Description\r\n\r\nReturns next train arrival information for one or more stations. Will return\r\nan empty set of results when no predictions are available. Use All for the StationCodes parameter to return predictions for\r\nall stations.\r\n\r\nFor terminal stations (e.g.: Greenbelt, Shady Grove, etc.), predictions may\r\nbe displayed twice.\r\n\r\nSome stations have two platforms (e.g.: Gallery Place, Fort Totten, L'Enfant\r\nPlaza, and Metro Center). To retrieve complete predictions for these stations,\r\nbe sure to pass in both StationCodes.\r\n\r\nFor trains with no passengers, the DestinationName will be No Passenger.\r\n\r\nNext train arrival information is refreshed once every 20 to 30 seconds approximately.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nTrains\r\n\r\n\r\nArray containing train prediction information (AIMPredictionTrainInfo).\r\n\r\n\r\n\r\n\r\n\r\n\r\nAIMPredictionTrainInfo\r\nElements\r\n\r\n\r\n\r\n\r\n\r\nCar\r\n\r\nNumber of cars on a train, usually 6 or 8, but might also\r\nreturn - or NULL.\r\n\r\n\r\n\r\nDestination\r\n\r\nAbbreviated version of the final destination for a train. This\r\nis similar to what is displayed on the signs at stations.\r\n\r\n\r\n\r\nDestinationCode\r\n\r\nDestination station code. Can be NULL. Use this value in other\r\nrail-related APIs to retrieve data about a station.\r\n\r\n\r\n\r\nDestinationName\r\n\r\nWhen DestinationCode is populated, this is the full name of the\r\ndestination station, as shown on the WMATA website.\r\n\r\n\r\n\r\nGroup\r\n\r\nDenotes the track this train is on, but does not necessarily\r\nequate to Track 1 or Track 2. With the exception of terminal\r\nstations, predictions at the same station with different Group\r\nvalues refer to trains on different tracks.\r\n\r\n\r\n\r\nLine\r\n\r\nTwo-letter abbreviation for the line (e.g.: RD, BL, YL, OR, GR,\r\nor SV). May also be blank or No for\r\ntrains with no passengers.\r\n\r\n\r\n\r\nLocationCode\r\n\r\nStation code for where the train is arriving. Useful when\r\npassing in All as the StationCodes\r\nparameter. Use this value in other rail-related APIs to retrieve\r\ndata about a station.\r\n\r\n\r\n\r\nLocationName\r\n\r\nFull name of the station where the train is arriving. Useful\r\nwhen passing in All as the\r\nStationCodes parameter.\r\n\r\n\r\n\r\nMin\r\n\r\nMinutes until arrival. Can be a numeric value, ARR (arriving), BRD (boarding), ---, or empty.", "operationId"=>"getJsonGetpredictionStationcodes", "x-api-path-slug"=>"jsongetpredictionstationcodes-get", "parameters"=>[{"in"=>"path", "name"=>"StationCodes", "description"=>"Comma-separated list of station codes"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Rail", "Prediction", "Stations"]}}, "/GetPrediction/{StationCodes}"=>{"get"=>{"summary"=>"XML - Next Trains", "description"=>"Description\r\n\r\nReturns next train arrival information for one or more stations. Will return\r\nan empty set of results when no predictions are available. Use All for the StationCodes parameter to return predictions for\r\nall stations.\r\n\r\nFor terminal stations (e.g.: Greenbelt, Shady Grove, etc.), predictions may\r\nbe displayed twice.\r\n\r\nSome stations have two platforms (e.g.: Gallery Place, Fort Totten, L'Enfant\r\nPlaza, and Metro Center). To retrieve complete predictions for these stations,\r\nbe sure to pass in both StationCodes.\r\n\r\nFor trains with no passengers, the DestinationName will be No Passenger.\r\n\r\nNext train arrival information is refreshed once every 20 to 30 seconds approximately.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nTrains\r\n\r\n\r\nArray containing train prediction information (AIMPredictionTrainInfo).\r\n\r\n\r\n\r\n\r\n\r\n\r\nAIMPredictionTrainInfo\r\nElements\r\n\r\n\r\n\r\n\r\n\r\nCar\r\n\r\nNumber of cars on a train, usually 6 or 8, but might also\r\nreturn - or NULL.\r\n\r\n\r\n\r\nDestination\r\n\r\nAbbreviated version of the final destination for a train. This\r\nis similar to what is displayed on the signs at stations.\r\n\r\n\r\n\r\nDestinationCode\r\n\r\nDestination station code. Can be NULL. Use this value in other\r\nrail-related APIs to retrieve data about a station.\r\n\r\n\r\n\r\nDestinationName\r\n\r\nWhen DestinationCode is populated, this is the full name of the\r\ndestination station, as shown on the WMATA website.\r\n\r\n\r\n\r\nGroup\r\n\r\nDenotes the track this train is on, but does not necessarily\r\nequate to Track 1 or Track 2. With the exception of terminal\r\nstations, predictions at the same station with different Group\r\nvalues refer to trains on different tracks.\r\n\r\n\r\n\r\nLine\r\n\r\nTwo-letter abbreviation for the line (e.g.: RD, BL, YL, OR, GR,\r\nor SV). May also be blank or No for\r\ntrains with no passengers.\r\n\r\n\r\n\r\nLocationCode\r\n\r\nStation code for where the train is arriving. Useful when\r\npassing in All as the StationCodes\r\nparameter. Use this value in other rail-related APIs to retrieve\r\ndata about a station.\r\n\r\n\r\n\r\nLocationName\r\n\r\nFull name of the station where the train is arriving. Useful\r\nwhen passing in All as the\r\nStationCodes parameter.\r\n\r\n\r\n\r\nMin\r\n\r\nMinutes until arrival. Can be a numeric value, ARR (arriving), BRD (boarding), ---, or empty.", "operationId"=>"getGetpredictionStationcodes", "x-api-path-slug"=>"getpredictionstationcodes-get", "parameters"=>[{"in"=>"path", "name"=>"StationCodes", "description"=>"Comma-separated list of station codes"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Rail", "Prediction", "Stations"]}}}}, "wmata-realtime-bus-predictions-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Washington Metropolitan Area Transit Authority", "x-complete"=>1, "info"=>{"title"=>"Real-Time Bus Predictions", "description"=>"realtime-bus-prediction-methods-", "version"=>"1.0"}, "host"=>"api.wmata.com", "basePath"=>"/NextBusService.svc", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/Predictions"=>{"get"=>{"summary"=>"Get Predictions", "description"=>"Description\r\n\r\nReturns next bus arrival times at a stop.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nPredictions\r\n\r\n\r\nArray containing bus predictions (NextBusPrediction).\r\n\r\n\r\n\r\n\r\nStopName\r\n\r\nFull name of the given StopID.\r\n\r\n\r\n\r\n\r\n\r\nNextBusPrediction Elements\r\n\r\n\r\n\r\n\r\n\r\nDirectionNum\r\n\r\nDenotes a binary direction (0 or 1) of the bus. There is no\r\nspecific mapping to direction, but a different value for the same\r\nroute signifies that the buses are traveling in opposite\r\ndirections. Use the DirectionText element to show the actual\r\ndestination of the bus.\r\n\r\n\r\n\r\nDirectionText\r\n\r\nCustomer-friendly description of direction and destination for\r\na bus.\r\n\r\n\r\n\r\nMinutes\r\n\r\nMinutes until bus arrival at this stop. Numeric value.\r\n\r\n\r\n\r\nRouteID\r\n\r\nBase route name as shown on the bus. This can be used in other\r\nbus-related methods. Note that all variants will be shown as their\r\nbase route names (i.e.: 10Av1 and 10Av2 will be shown as 10A).\r\n\r\n\r\n\r\nTripID\r\n\r\nTrip identifier. This can be correlated with the data in our\r\nbus schedule information as well as bus positions.\r\n\r\n\r\n\r\nVehicleID\r\n\r\nBus identifier. This can be correlated with results returned\r\nfrom bus positions.", "operationId"=>"Predictions.get", "x-api-path-slug"=>"predictions-get", "parameters"=>[{"in"=>"query", "name"=>"StopID", "description"=>"7-digit regional stop ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Predictions"]}}, "/json/jPredictions"=>{"get"=>{"summary"=>"Get Predictions", "description"=>"Description\r\n\r\nReturns next bus arrival times at a stop.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nPredictions\r\n\r\n\r\nArray containing bus predictions (NextBusPrediction).\r\n\r\n\r\n\r\n\r\nStopName\r\n\r\nFull name of the given StopID.\r\n\r\n\r\n\r\n\r\n\r\nNextBusPrediction Elements\r\n\r\n\r\n\r\n\r\n\r\nDirectionNum\r\n\r\nDenotes a binary direction (0 or 1) of the bus. There is no\r\nspecific mapping to direction, but a different value for the same\r\nroute signifies that the buses are traveling in opposite\r\ndirections. Use the DirectionText element to show the actual\r\ndestination of the bus.\r\n\r\n\r\n\r\nDirectionText\r\n\r\nCustomer-friendly description of direction and destination for\r\na bus.\r\n\r\n\r\n\r\nMinutes\r\n\r\nMinutes until bus arrival at this stop. Numeric value.\r\n\r\n\r\n\r\nRouteID\r\n\r\nBase route name as shown on the bus. This can be used in other\r\nbus-related methods. Note that all variants will be shown as their\r\nbase route names (i.e.: 10Av1 and 10Av2 will be shown as 10A).\r\n\r\n\r\n\r\nTripID\r\n\r\nTrip identifier. This can be correlated with the data in our\r\nbus schedule information as well as bus positions.\r\n\r\n\r\n\r\nVehicleID\r\n\r\nBus identifier. This can be correlated with results returned\r\nfrom bus positions.", "operationId"=>"json.jPredictions.get", "x-api-path-slug"=>"jsonjpredictions-get", "parameters"=>[{"in"=>"query", "name"=>"StopID", "description"=>"7-digit regional stop ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Predictions"]}}}}, "wmata-rail-station-information-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Washington Metropolitan Area Transit Authority", "x-complete"=>1, "info"=>{"title"=>"WMATA Rail Station Information", "description"=>"rail-line-and-station-information-including-locations-fares-times-and-parking-", "version"=>"1.0.0"}, "host"=>"api.wmata.com", "basePath"=>"/Rail.svc", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/json/jLines"=>{"get"=>{"summary"=>"JSON - Lines", "description"=>"Description\r\n\r\nReturns information about all rail lines.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nLines\r\n\r\n\r\nArray containing line information (Line).\r\n\r\n\r\n\r\n\r\n\r\n\r\nLine Elements\r\n\r\n\r\n\r\n\r\n\r\nDisplayName\r\n\r\nFull name of line color.\r\n\r\n\r\n\r\nEndStationCode\r\n\r\nEnd station code. For example, will be E10 (Greenbelt) for the\r\nGreen Line, B11 (Glenmont) for the Red Line, etc. Use this value in\r\nother rail-related APIs to retrieve data about a station.\r\n\r\n\r\n\r\nInternalDestination1\r\n\r\nIntermediate terminal station code. During normal service, some\r\ntrains on some lines might end their trip prior to the\r\nStartStationCode or EndStationCode. A good example is on the Red\r\nLine where some trains stop at A11 (Grosvenor) or B08 (Silver\r\nSpring). Empty string if not defined.\r\n\r\n\r\n\r\nInternalDestination2\r\n\r\nSimilar to InternalDestination1.\r\n\r\n\r\n\r\nLineCode\r\n\r\nTwo-letter abbreviation for the line (e.g.: RD, BL, YL, OR, GR,\r\nor SV).\r\n\r\n\r\n\r\nStartStationCode\r\n\r\nStart station code. For example, will be F11 (Branch Avenue)\r\nfor the Green Line, A15 (Shady Grove) for the Red Line, etc. Use\r\nthis value in other rail-related APIs to retrieve data about a\r\nstation.", "operationId"=>"getJsonJlines", "x-api-path-slug"=>"jsonjlines-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Lines"]}}, "/json/jStationParking"=>{"get"=>{"summary"=>"JSON - Parking Information", "description"=>"Description\n\nReturns parking information at a station based on a given StationCode. Omit\nthe StationCode to return parking information for all stations.\n\nIf a station has no parking, the StationsParking element will contain no\nchild elements.\n\nResponse Elements\n\n\n\n\nElement\n\nDescription\n\n\n\n\n\nStationsParking\n\n\nArray containing station parking information (StationParking).\n\n\n\n\n\n\nStationParking\nElements\n\n\n\n\n\nCode\n\nStation code. Useful when returning parking information for all\nstations. Use this value in other rail-related APIs to retrieve\ndata about a station.\n\n\n\nNotes\n\nWhen not NULL, provides additional parking resources such as\nnearby lots.\n\n\n\nAllDayParking\n\n\nStructure describing all-day\nparking options.\n\n\n\n\nShortTermParking\n\n\nStructure describing short-term\nparking options.\n\n\n\n\n\n\nAllDayParking\nElements\n\n\n\n\n\nTotalCount\n\nNumber of all-day parking spots available at a station.\n\n\n\nRiderCost\n\nAll-day cost per day (weekday) for Metro riders. NULL when no all-day\nspots are available. For most stations, this value is identical to\nthe NonRiderCost.\n\nFor cases where the NonRiderCost is different, the lower cost per\nday requires a valid rail trip using a SmarTrip® card\noriginating from a station other than the one where the patron\nparked. To receive this lower rate, patrons must pay for their\nparking with the same SmarTrip® card used to enter/exit\nMetrorail, and must exit the parking lot within two hours of\nexiting Metrorail.\n\n\n\nNonRiderCost\n\nAll-day cost per day (weekday) for non-Metro riders. NULL when no all-day\nspots are available.\n\n\n\n\n\nShortTermParking Elements\n\n\n\n\n\nSaturdayRiderCost\n\nSimilar to RiderCost, except denoting Saturday prices.\n\n\n\nSaturdayNonRiderCost\n\nSimilar to NonRiderCost, except denoting Saturday prices.\n\n\n\nTotalCount\n\nNumber of short-term parking spots available at a station\n(parking meters).\n\n\n\nNotes\n\nMisc. information relating to short-term parking. NULL when no\nshort-term spots are available.", "operationId"=>"getJsonJstationparking", "x-api-path-slug"=>"jsonjstationparking-get", "parameters"=>[{"in"=>"query", "name"=>"StationCode", "description"=>"Station code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Stations", "Parking"]}}, "/json/jPath"=>{"get"=>{"summary"=>"JSON - Path Between Stations", "description"=>"Description\r\n\r\nReturns a set of ordered stations and distances between two stations on the\r\nsame line.\r\n\r\nNote that this method is not suitable on its own as a pathfinding solution\r\nbetween stations.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nPath\r\n\r\n\r\nArray containing path details (MetroPathItem)\r\n\r\n\r\n\r\n\r\n\r\n\r\nMetroPathItem\r\nElements\r\n\r\n\r\n\r\n\r\n\r\nDistanceToPrev\r\n\r\nDistance in feet to the previous station in the list.\r\n\r\n\r\n\r\nLineCode\r\n\r\nTwo-letter abbreviation for the line (e.g.: RD, BL, YL, OR, GR,\r\nor SV) this station's platform is on.\r\n\r\n\r\n\r\nSeqNum\r\n\r\nOrdered sequence number.\r\n\r\n\r\n\r\nStationCode\r\n\r\nStation code for this station. Use this value in other\r\nrail-related APIs to retrieve data about a station.\r\n\r\n\r\n\r\nStationName\r\n\r\nFull name for this station, as shown on the WMATA website.", "operationId"=>"getJsonJpath", "x-api-path-slug"=>"jsonjpath-get", "parameters"=>[{"in"=>"query", "name"=>"FromStationCode", "description"=>"Station code for the origin station"}, {"in"=>"query", "name"=>"ToStationCode", "description"=>"Station code for the destination station"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Paths"]}}, "/json/jStationEntrances"=>{"get"=>{"summary"=>"JSON - Station Entrances", "description"=>"Description\r\n\r\nReturns a list of nearby station entrances based on latitude, longitude, and\r\nradius (meters). Omit search parameters to return all station entrances.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nEntrances\r\n\r\n\r\nArray containing detailed information about station entrances\r\n(StationEntrance).\r\n\r\n\r\n\r\n\r\n\r\n\r\nStationEntrance Elements\r\n\r\n\r\n\r\n\r\n\r\nDescription\r\n\r\nAdditional information for the entrance, if available.\r\nCurrently available data usually shows the same value as the Name\r\nelement.\r\n\r\n\r\n\r\nID\r\n\r\nDeprecated.\r\n\r\n\r\n\r\nLat\r\n\r\nLatitude.\r\n\r\n\r\n\r\nLon\r\n\r\nLongitude.\r\n\r\n\r\n\r\nName\r\n\r\nName of the entrance (usually the station name and nearest\r\nintersection).\r\n\r\n\r\n\r\nStationCode1\r\n\r\nThe station code associated with this entrance. Use this value\r\nin other rail-related APIs to retrieve data about a station.\r\n\r\n\r\n\r\nStationCode2\r\n\r\nFor stations containing multiple platforms (e.g.: Gallery\r\nPlace, Fort Totten, L'Enfant Plaza, and Metro Center), the other\r\nstation code.", "operationId"=>"getJsonJstationentrances", "x-api-path-slug"=>"jsonjstationentrances-get", "parameters"=>[{"in"=>"query", "name"=>"Lat", "description"=>"Center point Latitude, required if Longitude and Radius are specified"}, {"in"=>"query", "name"=>"Lon", "description"=>"Center point Longitude, required if Latitude and Radius are specified"}, {"in"=>"query", "name"=>"Radius", "description"=>"Radius (meters) to include in the search area, required if Latitude and Longitude are specified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Stations", "Entrances"]}}, "/json/jStationInfo"=>{"get"=>{"summary"=>"JSON - Station Information", "description"=>"Description\r\n\r\nReturns station location and address information based on a given\r\nStationCode.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nAddress\r\n\r\n\r\nStructure describing address information.\r\n\r\n\r\n\r\n\r\nCode\r\n\r\nStation code. Repeated from input.\r\n\r\n\r\n\r\nLat\r\n\r\nLatitude.\r\n\r\n\r\n\r\nLineCode1\r\n\r\nTwo-letter abbreviation for the line (e.g.: RD, BL, YL, OR, GR,\r\nor SV) served by this station.\r\n\r\n\r\n\r\nLineCode2\r\n\r\nAdditional line served by this station. This is often the case\r\nwhen stations have multiple platforms (e.g.: Gallery Place, Fort\r\nTotten, L'Enfant Plaza, and Metro Center).\r\n\r\n\r\n\r\nLineCode3\r\n\r\nSimilar to function as LineCodeX.\r\n\r\n\r\n\r\nLineCode4\r\n\r\nSimilar to function as LineCodeX. Currently not in use.\r\n\r\n\r\n\r\nLon\r\n\r\nLongitude.\r\n\r\n\r\n\r\nName\r\n\r\nStation name.\r\n\r\n\r\n\r\nStationTogether1\r\n\r\nFor stations with multiple platforms (e.g.: Gallery Place, Fort\r\nTotten, L'Enfant Plaza, and Metro Center), the additional\r\nStationCode will be listed here.\r\n\r\n\r\n\r\nStationTogether2\r\n\r\nSimilar in function to StationTogether2. Currently not in\r\nuse.\r\n\r\n\r\n\r\n\r\n\r\nAddress Elements\r\n\r\n\r\n\r\n\r\n\r\nCity\r\n\r\nCity.\r\n\r\n\r\n\r\nState\r\n\r\nState (abbreviated).\r\n\r\n\r\n\r\nStreet\r\n\r\nStreet address (for GPS use).\r\n\r\n\r\n\r\nZip\r\n\r\nZip code.", "operationId"=>"getJsonJstationinfo", "x-api-path-slug"=>"jsonjstationinfo-get", "parameters"=>[{"in"=>"query", "name"=>"StationCode", "description"=>"Station code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Stations"]}}, "/json/jStations"=>{"get"=>{"summary"=>"JSON - Station List", "description"=>"Description\r\n\r\nReturns a list of station location and address information based on a given\r\nLineCode. Omit the LineCode to return all stations. The response is an array of\r\nobjects identical to those returned in the Station Information method.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nStations\r\n\r\n\r\nArray containing station information (Station).\r\n\r\n\r\n\r\n\r\n\r\n\r\nStation Elements\r\n\r\n\r\n\r\n\r\n\r\nAddress\r\n\r\n\r\nStructure describing address information.\r\n\r\n\r\n\r\n\r\nCode\r\n\r\nStation code. Repeated from input.\r\n\r\n\r\n\r\nLat\r\n\r\nLatitude.\r\n\r\n\r\n\r\nLineCode1\r\n\r\nTwo-letter abbreviation for the line (e.g.: RD, BL, YL, OR, GR,\r\nor SV) served by this station.\r\n\r\n\r\n\r\nLineCode2\r\n\r\nAdditional line served by this station. This is often the case\r\nwhen stations have multiple platforms (e.g.: Gallery Place, Fort\r\nTotten, L'Enfant Plaza, and Metro Center).\r\n\r\n\r\n\r\nLineCode3\r\n\r\nSimilar to function as LineCodeX.\r\n\r\n\r\n\r\nLineCode4\r\n\r\nSimilar to function as LineCodeX. Currently not in use.\r\n\r\n\r\n\r\nLon\r\n\r\nLongitude.\r\n\r\n\r\n\r\nName\r\n\r\nStation name.\r\n\r\n\r\n\r\nStationTogether1\r\n\r\nFor stations with multiple platforms (e.g.: Gallery Place, Fort\r\nTotten, L'Enfant Plaza, and Metro Center), the additional\r\nStationCode will be listed here.\r\n\r\n\r\n\r\nStationTogether2\r\n\r\nSimilar in function to StationTogether2. Currently not in\r\nuse.\r\n\r\n\r\n\r\n\r\n\r\nAddress Elements\r\n\r\n\r\n\r\n\r\n\r\nCity\r\n\r\nCity.\r\n\r\n\r\n\r\nState\r\n\r\nState (abbreviated).\r\n\r\n\r\n\r\nStreet\r\n\r\nStreet address (for GPS use).\r\n\r\n\r\n\r\nZip\r\n\r\nZip code.", "operationId"=>"getJsonJstations", "x-api-path-slug"=>"jsonjstations-get", "parameters"=>[{"in"=>"query", "name"=>"LineCode", "description"=>"Two-letter line code abbreviation:RD - RedYL - YellowGR - GreenBL - BlueOR - OrangeSV - Silver"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Stations"]}}, "/json/jStationTimes"=>{"get"=>{"summary"=>"JSON - Station Timings", "description"=>"Description\r\n\r\nReturns opening and scheduled first/last train times based on a given\r\nStationCode. Omit the StationCode to return timing information for all\r\nstations.\r\n\r\nNote that for stations with multiple platforms (e.g.: Metro Center, L'Enfant\r\nPlaza, etc.), a distinct call is required for each StationCode to retrieve the\r\nfull set of train times at such stations.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nStationTimes\r\n\r\n\r\nArray containing station timing information (StationTime).\r\n\r\n\r\n\r\n\r\n\r\n\r\nStationTime\r\nElements\r\n\r\n\r\n\r\n\r\n\r\nCode\r\n\r\nStation code for this station. Use this value in other\r\nrail-related APIs to retrieve data about a station.\r\n\r\n\r\n\r\nStationName\r\n\r\nFull name of the station.\r\n\r\n\r\n\r\n*Day Elements\r\n\r\n\r\nContainer elements containing timing information based on\r\nday of the week.\r\n\r\n\r\n\r\n\r\n\r\n\r\nMonday/Tuesday/Wednesday/etc.\r\nElements\r\n\r\n\r\n\r\n\r\n\r\nOpeningTime\r\n\r\nStation opening time. Format is HH:mm.\r\n\r\n\r\n\r\nFirstTrains\r\n\r\n\r\nStructure containing first train\r\ninformation.\r\n\r\n\r\n\r\n\r\nLastTrains\r\n\r\n\r\nStructure containing last train\r\ninformation.\r\n\r\n\r\n\r\n\r\n\r\n\r\nFirstTrains Elements\r\n\r\n\r\n\r\n\r\n\r\nTime\r\n\r\nFirst train leaves the station at this time. Format is\r\nHH:mm.\r\n\r\n\r\n\r\nDestinationStation\r\n\r\nStation code for the train's destination. Use this value in\r\nother rail-related APIs to retrieve data about a station.\r\n\r\n\r\n\r\n\r\n\r\nLastTrains Elements\r\n\r\n\r\n\r\n\r\n\r\nTime\r\n\r\nLast train leaves the station at this time. Format is HH:mm.\r\nNote that when the time is AM, it signifies the next day. For\r\nexample, a value of 02:30 under a Saturday element means the last\r\ntrain leaves on Sunday at 2:30 AM.\r\n\r\n\r\n\r\nDestinationStation\r\n\r\nStation code for the train's destination. Use this value in\r\nother rail-related APIs to retrieve data about a station.", "operationId"=>"getJsonJstationtimes", "x-api-path-slug"=>"jsonjstationtimes-get", "parameters"=>[{"in"=>"query", "name"=>"StationCode", "description"=>"Station code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Stations", "Times"]}}, "/json/jSrcStationToDstStationInfo"=>{"get"=>{"summary"=>"JSON - Station to Station Information", "description"=>"Description\r\n\r\nReturns a distance, fare information, and estimated travel time between any\r\ntwo stations, including those on different lines. Omit both parameters to\r\nretrieve data for all stations.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nStationToStationInfos\r\n\r\n\r\nArray containing station to station information (StationToStationInfo).\r\n\r\n\r\n\r\n\r\n\r\n\r\nStationToStationInfo Elements\r\n\r\n\r\n\r\n\r\n\r\nCompositeMiles\r\n\r\nDistance in miles from the source to destination station.\r\n\r\n\r\n\r\nDestinationStation\r\n\r\nDestination station code. Use this value in other rail-related\r\nAPIs to retrieve data about a station.\r\n\r\n\r\n\r\nRailFare\r\n\r\n\r\nStructure containing fare information.\r\n\r\n\r\n\r\n\r\nRailTime\r\n\r\nEstimated travel time (schedule time) in minutes between the source and\r\ndestination station. This is not correlated to minutes (Min) in Real-Time Rail Predictions.\r\n\r\n\r\n\r\nSourceStation\r\n\r\nOrigin station code. Use this value in other rail-related APIs\r\nto retrieve data about a station.\r\n\r\n\r\n\r\n\r\n\r\nRailFare Elements\r\n\r\n\r\n\r\n\r\n\r\nOffPeakTime\r\n\r\nFare during off-peak times (times other than the ones described\r\nbelow).\r\n\r\n\r\n\r\nPeakTime\r\n\r\nFare during peak times (weekdays from opening to 9:30 AM and\r\n3-7 PM, and weekends from midnight to closing).\r\n\r\n\r\n\r\nSeniorDisabled\r\n\r\n\r\nReduced fare for senior citizens or\r\npeople with disabilities.", "operationId"=>"getJsonJsrcstationtodststationinfo", "x-api-path-slug"=>"jsonjsrcstationtodststationinfo-get", "parameters"=>[{"in"=>"query", "name"=>"FromStationCode", "description"=>"Station code for the origin station"}, {"in"=>"query", "name"=>"ToStationCode", "description"=>"Station code for the destination station"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Stations"]}}, "/Lines"=>{"get"=>{"summary"=>"XML - Lines", "description"=>"Description\r\n\r\nReturns information about all rail lines.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nLines\r\n\r\n\r\nArray containing line information (Line).\r\n\r\n\r\n\r\n\r\n\r\n\r\nLine Elements\r\n\r\n\r\n\r\n\r\n\r\nDisplayName\r\n\r\nFull name of line color.\r\n\r\n\r\n\r\nEndStationCode\r\n\r\nEnd station code. For example, will be E10 (Greenbelt) for the\r\nGreen Line, B11 (Glenmont) for the Red Line, etc. Use this value in\r\nother rail-related APIs to retrieve data about a station.\r\n\r\n\r\n\r\nInternalDestination1\r\n\r\nIntermediate terminal station code. During normal service, some\r\ntrains on some lines might end their trip prior to the\r\nStartStationCode or EndStationCode. A good example is on the Red\r\nLine where some trains stop at A11 (Grosvenor) or B08 (Silver\r\nSpring). Empty string if not defined.\r\n\r\n\r\n\r\nInternalDestination2\r\n\r\nSimilar to InternalDestination1.\r\n\r\n\r\n\r\nLineCode\r\n\r\nTwo-letter abbreviation for the line (e.g.: RD, BL, YL, OR, GR,\r\nor SV).\r\n\r\n\r\n\r\nStartStationCode\r\n\r\nStart station code. For example, will be F11 (Branch Avenue)\r\nfor the Green Line, A15 (Shady Grove) for the Red Line, etc. Use\r\nthis value in other rail-related APIs to retrieve data about a\r\nstation.", "operationId"=>"getLines", "x-api-path-slug"=>"lines-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Lines"]}}, "/StationParking"=>{"get"=>{"summary"=>"XML - Parking Information", "description"=>"Description\n\nReturns parking information at a station based on a given StationCode. Omit\nthe StationCode to return parking information for all stations.\n\nIf a station has no parking, the StationsParking element will contain no\nchild elements.\n\nResponse Elements\n\n\n\n\nElement\n\nDescription\n\n\n\n\n\nStationsParking\n\n\nArray containing station parking information (StationParking).\n\n\n\n\n\n\nStationParking\nElements\n\n\n\n\n\nCode\n\nStation code. Useful when returning parking information for all\nstations. Use this value in other rail-related APIs to retrieve\ndata about a station.\n\n\n\nNotes\n\nWhen not NULL, provides additional parking resources such as\nnearby lots.\n\n\n\nAllDayParking\n\n\nStructure describing all-day\nparking options.\n\n\n\n\nShortTermParking\n\n\nStructure describing short-term\nparking options.\n\n\n\n\n\n\nAllDayParking\nElements\n\n\n\n\n\nTotalCount\n\nNumber of all-day parking spots available at a station.\n\n\n\nRiderCost\n\nAll-day cost per day (weekday) for Metro riders. NULL when no all-day\nspots are available. For most stations, this value is identical to\nthe NonRiderCost.\n\nFor cases where the NonRiderCost is different, the lower cost per\nday requires a valid rail trip using a SmarTrip® card\noriginating from a station other than the one where the patron\nparked. To receive this lower rate, patrons must pay for their\nparking with the same SmarTrip® card used to enter/exit\nMetrorail, and must exit the parking lot within two hours of\nexiting Metrorail.\n\n\n\nNonRiderCost\n\nAll-day cost per day (weekday) for non-Metro riders. NULL when no all-day\nspots are available.\n\n\n\n\n\nShortTermParking Elements\n\n\n\n\n\nSaturdayRiderCost\n\nSimilar to RiderCost, except denoting Saturday prices.\n\n\n\nSaturdayNonRiderCost\n\nSimilar to NonRiderCost, except denoting Saturday prices.\n\n\n\nTotalCount\n\nNumber of short-term parking spots available at a station\n(parking meters).\n\n\n\nNotes\n\nMisc. information relating to short-term parking. NULL when no\nshort-term spots are available.", "operationId"=>"getStationparking", "x-api-path-slug"=>"stationparking-get", "parameters"=>[{"in"=>"query", "name"=>"StationCode", "description"=>"Station code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Stations", "Parking"]}}, "/Path"=>{"get"=>{"summary"=>"XML - Path Between Stations", "description"=>"Description\r\n\r\nReturns a set of ordered stations and distances between two stations on the\r\nsame line.\r\n\r\nNote that this method is not suitable on its own as a pathfinding solution\r\nbetween stations.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nPath\r\n\r\n\r\nArray containing path details (MetroPathItem)\r\n\r\n\r\n\r\n\r\n\r\n\r\nMetroPathItem\r\nElements\r\n\r\n\r\n\r\n\r\n\r\nDistanceToPrev\r\n\r\nDistance in feet to the previous station in the list.\r\n\r\n\r\n\r\nLineCode\r\n\r\nTwo-letter abbreviation for the line (e.g.: RD, BL, YL, OR, GR,\r\nor SV) this station's platform is on.\r\n\r\n\r\n\r\nSeqNum\r\n\r\nOrdered sequence number.\r\n\r\n\r\n\r\nStationCode\r\n\r\nStation code for this station. Use this value in other\r\nrail-related APIs to retrieve data about a station.\r\n\r\n\r\n\r\nStationName\r\n\r\nFull name for this station, as shown on the WMATA website.", "operationId"=>"getPath", "x-api-path-slug"=>"path-get", "parameters"=>[{"in"=>"query", "name"=>"FromStationCode", "description"=>"Station code for the origin station"}, {"in"=>"query", "name"=>"ToStationCode", "description"=>"Station code for the origin station"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Paths"]}}, "/StationEntrances"=>{"get"=>{"summary"=>"XML - Station Entrances", "description"=>"Description\r\n\r\nReturns a list of nearby station entrances based on latitude, longitude, and\r\nradius (meters). Omit search parameters to return all station entrances.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nEntrances\r\n\r\n\r\nArray containing detailed information about station entrances\r\n(StationEntrance).\r\n\r\n\r\n\r\n\r\n\r\n\r\nStationEntrance Elements\r\n\r\n\r\n\r\n\r\n\r\nDescription\r\n\r\nAdditional information for the entrance, if available.\r\nCurrently available data usually shows the same value as the Name\r\nelement.\r\n\r\n\r\n\r\nID\r\n\r\nDeprecated.\r\n\r\n\r\n\r\nLat\r\n\r\nLatitude.\r\n\r\n\r\n\r\nLon\r\n\r\nLongitude.\r\n\r\n\r\n\r\nName\r\n\r\nName of the entrance (usually the station name and nearest\r\nintersection).\r\n\r\n\r\n\r\nStationCode1\r\n\r\nThe station code associated with this entrance. Use this value\r\nin other rail-related APIs to retrieve data about a station.\r\n\r\n\r\n\r\nStationCode2\r\n\r\nFor stations containing multiple platforms (e.g.: Gallery\r\nPlace, Fort Totten, L'Enfant Plaza, and Metro Center), the other\r\nstation code.", "operationId"=>"getStationentrances", "x-api-path-slug"=>"stationentrances-get", "parameters"=>[{"in"=>"query", "name"=>"Lat", "description"=>"Center point Latitude, required if Longitude and Radius are specified"}, {"in"=>"query", "name"=>"Lon", "description"=>"Center point Longitude, required if Latitude and Radius are specified"}, {"in"=>"query", "name"=>"Radius", "description"=>"Radius (meters) to include in the search area, required if Latitude and Longitude are specified"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Stations", "Entrances"]}}, "/StationInfo"=>{"get"=>{"summary"=>"XML - Station Information", "description"=>"Description\r\n\r\nReturns station location and address information based on a given\r\nStationCode.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nAddress\r\n\r\n\r\nStructure describing address information.\r\n\r\n\r\n\r\n\r\nCode\r\n\r\nStation code. Repeated from input.\r\n\r\n\r\n\r\nLat\r\n\r\nLatitude.\r\n\r\n\r\n\r\nLineCode1\r\n\r\nTwo-letter abbreviation for the line (e.g.: RD, BL, YL, OR, GR,\r\nor SV) served by this station.\r\n\r\n\r\n\r\nLineCode2\r\n\r\nAdditional line served by this station. This is often the case\r\nwhen stations have multiple platforms (e.g.: Gallery Place, Fort\r\nTotten, L'Enfant Plaza, and Metro Center).\r\n\r\n\r\n\r\nLineCode3\r\n\r\nSimilar to function as LineCodeX.\r\n\r\n\r\n\r\nLineCode4\r\n\r\nSimilar to function as LineCodeX. Currently not in use.\r\n\r\n\r\n\r\nLon\r\n\r\nLongitude.\r\n\r\n\r\n\r\nName\r\n\r\nStation name.\r\n\r\n\r\n\r\nStationTogether1\r\n\r\nFor stations with multiple platforms (e.g.: Gallery Place, Fort\r\nTotten, L'Enfant Plaza, and Metro Center), the additional\r\nStationCode will be listed here.\r\n\r\n\r\n\r\nStationTogether2\r\n\r\nSimilar in function to StationTogether2. Currently not in\r\nuse.\r\n\r\n\r\n\r\n\r\n\r\nAddress Elements\r\n\r\n\r\n\r\n\r\n\r\nCity\r\n\r\nCity.\r\n\r\n\r\n\r\nState\r\n\r\nState (abbreviated).\r\n\r\n\r\n\r\nStreet\r\n\r\nStreet address (for GPS use).\r\n\r\n\r\n\r\nZip\r\n\r\nZip code.", "operationId"=>"getStationinfo", "x-api-path-slug"=>"stationinfo-get", "parameters"=>[{"in"=>"query", "name"=>"StationCode", "description"=>"Station code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Stations"]}}, "/Stations"=>{"get"=>{"summary"=>"XML - Station List", "description"=>"Description\r\n\r\nReturns a list of station location and address information based on a given\r\nLineCode. Omit the LineCode to return all stations. The response is an array of\r\nobjects identical to those returned in the Station Information method.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nStations\r\n\r\n\r\nArray containing station information (Station).\r\n\r\n\r\n\r\n\r\n\r\n\r\nStation Elements\r\n\r\n\r\n\r\n\r\n\r\nAddress\r\n\r\n\r\nStructure describing address information.\r\n\r\n\r\n\r\n\r\nCode\r\n\r\nStation code. Repeated from input.\r\n\r\n\r\n\r\nLat\r\n\r\nLatitude.\r\n\r\n\r\n\r\nLineCode1\r\n\r\nTwo-letter abbreviation for the line (e.g.: RD, BL, YL, OR, GR,\r\nor SV) served by this station.\r\n\r\n\r\n\r\nLineCode2\r\n\r\nAdditional line served by this station. This is often the case\r\nwhen stations have multiple platforms (e.g.: Gallery Place, Fort\r\nTotten, L'Enfant Plaza, and Metro Center).\r\n\r\n\r\n\r\nLineCode3\r\n\r\nSimilar to function as LineCodeX.\r\n\r\n\r\n\r\nLineCode4\r\n\r\nSimilar to function as LineCodeX. Currently not in use.\r\n\r\n\r\n\r\nLon\r\n\r\nLongitude.\r\n\r\n\r\n\r\nName\r\n\r\nStation name.\r\n\r\n\r\n\r\nStationTogether1\r\n\r\nFor stations with multiple platforms (e.g.: Gallery Place, Fort\r\nTotten, L'Enfant Plaza, and Metro Center), the additional\r\nStationCode will be listed here.\r\n\r\n\r\n\r\nStationTogether2\r\n\r\nSimilar in function to StationTogether2. Currently not in\r\nuse.\r\n\r\n\r\n\r\n\r\n\r\nAddress Elements\r\n\r\n\r\n\r\n\r\n\r\nCity\r\n\r\nCity.\r\n\r\n\r\n\r\nState\r\n\r\nState (abbreviated).\r\n\r\n\r\n\r\nStreet\r\n\r\nStreet address (for GPS use).\r\n\r\n\r\n\r\nZip\r\n\r\nZip code.", "operationId"=>"getStations", "x-api-path-slug"=>"stations-get", "parameters"=>[{"in"=>"query", "name"=>"LineCode", "description"=>"Two-letter line code abbreviation:RD - RedYL - YellowGR - GreenBL - BlueOR - OrangeSV - Silver"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Stations"]}}, "/StationTimes"=>{"get"=>{"summary"=>"XML - Station Timings", "description"=>"Description\r\n\r\nReturns opening and scheduled first/last train times based on a given\r\nStationCode. Omit the StationCode to return timing information for all\r\nstations.\r\n\r\nNote that for stations with multiple platforms (e.g.: Metro Center, L'Enfant\r\nPlaza, etc.), a distinct call is required for each StationCode to retrieve the\r\nfull set of train times at such stations.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nStationTimes\r\n\r\n\r\nArray containing station timing information (StationTime).\r\n\r\n\r\n\r\n\r\n\r\n\r\nStationTime\r\nElements\r\n\r\n\r\n\r\n\r\n\r\nCode\r\n\r\nStation code for this station. Use this value in other\r\nrail-related APIs to retrieve data about a station.\r\n\r\n\r\n\r\nStationName\r\n\r\nFull name of the station.\r\n\r\n\r\n\r\n*Day Elements\r\n\r\n\r\nContainer elements containing timing information based on\r\nday of the week.\r\n\r\n\r\n\r\n\r\n\r\n\r\nMonday/Tuesday/Wednesday/etc.\r\nElements\r\n\r\n\r\n\r\n\r\n\r\nOpeningTime\r\n\r\nStation opening time. Format is HH:mm.\r\n\r\n\r\n\r\nFirstTrains\r\n\r\n\r\nStructure containing first train\r\ninformation.\r\n\r\n\r\n\r\n\r\nLastTrains\r\n\r\n\r\nStructure containing last train\r\ninformation.\r\n\r\n\r\n\r\n\r\n\r\n\r\nFirstTrains Elements\r\n\r\n\r\n\r\n\r\n\r\nTime\r\n\r\nFirst train leaves the station at this time. Format is\r\nHH:mm.\r\n\r\n\r\n\r\nDestinationStation\r\n\r\nStation code for the train's destination. Use this value in\r\nother rail-related APIs to retrieve data about a station.\r\n\r\n\r\n\r\n\r\n\r\nLastTrains Elements\r\n\r\n\r\n\r\n\r\n\r\nTime\r\n\r\nLast train leaves the station at this time. Format is HH:mm.\r\nNote that when the time is AM, it signifies the next day. For\r\nexample, a value of 02:30 under a Saturday element means the last\r\ntrain leaves on Sunday at 2:30 AM.\r\n\r\n\r\n\r\nDestinationStation\r\n\r\nStation code for the train's destination. Use this value in\r\nother rail-related APIs to retrieve data about a station.", "operationId"=>"getStationtimes", "x-api-path-slug"=>"stationtimes-get", "parameters"=>[{"in"=>"query", "name"=>"StationCode", "description"=>"Station code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Stations", "Times"]}}, "/SrcStationToDstStationInfo"=>{"get"=>{"summary"=>"XML - Station to Station Information", "description"=>"Description\r\n\r\nReturns a distance, fare information, and estimated travel time between any\r\ntwo stations, including those on different lines. Omit both parameters to\r\nretrieve data for all stations.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nStationToStationInfos\r\n\r\n\r\nArray containing station to station information (StationToStationInfo).\r\n\r\n\r\n\r\n\r\n\r\n\r\nStationToStationInfo Elements\r\n\r\n\r\n\r\n\r\n\r\nCompositeMiles\r\n\r\nDistance in miles from the source to destination station.\r\n\r\n\r\n\r\nDestinationStation\r\n\r\nDestination station code. Use this value in other rail-related\r\nAPIs to retrieve data about a station.\r\n\r\n\r\n\r\nRailFare\r\n\r\n\r\nStructure containing fare information.\r\n\r\n\r\n\r\n\r\nRailTime\r\n\r\nEstimated travel time (schedule time) in minutes between the source and destination station. This is not correlated to minutes (Min) in Real-Time Rail Predictions.\r\n\r\n\r\n\r\nSourceStation\r\n\r\nOrigin station code. Use this value in other rail-related APIs\r\nto retrieve data about a station.\r\n\r\n\r\n\r\n\r\n\r\nRailFare Elements\r\n\r\n\r\n\r\n\r\n\r\nOffPeakTime\r\n\r\nFare during off-peak times (times other than the ones described\r\nbelow).\r\n\r\n\r\n\r\nPeakTime\r\n\r\nFare during peak times (weekdays from opening to 9:30 AM and\r\n3-7 PM, and weekends from midnight to closing).\r\n\r\n\r\n\r\nSeniorDisabled\r\n\r\n\r\nReduced fare for senior citizens or\r\npeople with disabilities.", "operationId"=>"getSrcstationtodststationinfo", "x-api-path-slug"=>"srcstationtodststationinfo-get", "parameters"=>[{"in"=>"query", "name"=>"FromStationCode", "description"=>"Station code for the origin station"}, {"in"=>"query", "name"=>"ToStationCode", "description"=>"Station code for the destination station"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Stations"]}}}}, "wmata-train-positions-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Washington Metropolitan Area Transit Authority", "x-complete"=>1, "info"=>{"title"=>"Train Positions", "description"=>"realtime-train-positions-and-support-methods-", "version"=>"1.0.0"}, "host"=>"api.wmata.com", "basePath"=>"/TrainPositions", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/TrainPositions"=>{"get"=>{"summary"=>"Live Train Positions", "description"=>"Description\n\nReturns uniquely identifiable trains in service and what track circuits they currently occupy. Will return an empty set of results when no positions are available.\n\nData is refreshed once every 7-10 seconds.\nPlease refer to this page for additional details.\n\nResponse Elements\n\n\n\n\nElement\n\nDescription\n\n\n\n\n\nTrainPositions\n\n\nArray containing train position information (TrainPosition).\n\n\n\n\n\n\nTrainPosition Elements\n\n\n\n\n\nCarCount\n\nNumber of cars. Can sometimes be 0 when there is no data available.\n\n\n\nCircuitId\n\nThe circuit identifier the train is currently on. This identifier can be referenced from the Standard Routes method.\n\n\n\nDestinationStationCode\n\nDestination station code. Can be NULL. Use this value in other rail-related APIs to retrieve data about a station. Note that this value may sometimes differ from the destination station code returned by our Next Trains methods.\n\n\n\nDirectionNum\n\nThe direction of movement regardless of which track the train is on. Valid values are 1 or 2. Generally speaking, trains with direction 1 are northbound/eastbound, while trains with direction 2 are southbound/westbound.\n\n\n\nLineCode\n\nTwo-letter abbreviation for the line (e.g.: RD, BL, YL, OR, GR, or SV). May also be NULL in certain cases.\n\n\n\nSecondsAtLocation\n\nApproximate \"dwell time\". This is not an exact value, but can be used to determine how long a train has been reported at the same track circuit.\n\n\n\nServiceType\n\nService Type of a train, can be any of the following Service Types\n\n\n\nTrainId\n\nUniquely identifiable internal train identifier.\n\n\n\n\n\nService Types\n\n\n\n\n\nNoPassengers\n\nThis is a non-revenue train with no passengers on board. Note that this designation of NoPassengers does not necessarily correlate with PIDS \"No Passengers\". As of 08/22/2016, this functionality has been reinstated to include all non-revenue vehicles, with minor exceptions.\n\n\n\nNormal\n\nThis is a normal revenue service train.\n\n\n\nSpecial\n\nThis is a special revenue service train with an unspecified line and destination. This is more prevalent during scheduled track work.\n\n\n\nUnknown\n\nThis often denotes cases with unknown data or work vehicles.", "operationId"=>"getTrainpositions", "x-api-path-slug"=>"trainpositions-get", "parameters"=>[{"in"=>"query", "name"=>"contentType", "description"=>"Returns response in the specified format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Subway", "Positions"]}}, "/StandardRoutes"=>{"get"=>{"summary"=>"Standard Routes", "description"=>"Description\r\n\r\nReturns an ordered list of mostly revenue (and some lead) track circuits, arranged by line and track number. This data does not change frequently and should be cached for a reasonable amount of time.\r\nPlease refer to this page for additional details.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nStandardRoutes\r\n\r\n\r\nArray containing revenue line information (StandardRoute).\r\n\r\n\r\n\r\n\r\n\r\n\r\nStandardRoute Elements\r\n\r\n\r\n\r\n\r\n\r\nLineCode\r\n\r\nAbbreviation for the revenue line. Note that this also includes YLRP (Yellow Line Rush Plus).\r\n\r\n\r\n\r\nTrackCircuits\r\n\r\n\r\nArray containing ordered track circuit information (TrackCircuit).\r\n\r\n\r\n\r\n\r\nTrackNum\r\n\r\nTrack number (1 or 2).\r\n\r\n\r\n\r\n\r\n\r\nTrackCircuit Elements\r\n\r\n\r\n \r\n\r\n\r\nCircuitId\r\n\r\nAn internal system-wide uniquely identifiable circuit number.\r\n\r\n\r\n\r\nSeqNum\r\n\r\nOrder in which the circuit appears for the given line and track. Sequences go from West to East and South to North.\r\n \r\n\r\n\r\nStationCode\r\n\r\nIf the circuit is at a station, this value will represent the station code. Otherwise, it will be be NULL. Use this value in other rail-related APIs to retrieve data about a station.", "operationId"=>"getStandardroutes", "x-api-path-slug"=>"standardroutes-get", "parameters"=>[{"in"=>"query", "name"=>"contentType", "description"=>"Returns response in the specified format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Subway", "Routes"]}}, "/TrackCircuits"=>{"get"=>{"summary"=>"Track Circuits", "description"=>"Description\r\n\r\nReturns a list of all track circuits including those on pocket tracks and crossovers. Each track circuit may include references to its right and left neighbors.\r\nPlease refer to this page for additional details.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nTrackCircuits\r\n\r\n\r\nArray containing track circuit information (TrackCircuit).\r\n\r\n\r\n\r\n\r\n\r\n\r\nTrackCircuit Elements\r\n\r\n\r\n\r\n\r\n\r\nCircuitId\r\n\r\nAn internal system-wide uniquely identifiable circuit number.\r\n\r\n\r\n\r\nNeighbors\r\n\r\n\r\nArray containing track circuit neighbor information (TrackCircuitNeighbor). Note that some track circuits have no neighbors in one direction. All track circuits have at least one neighbor.\r\n\r\n\r\n\r\n\r\nTrack\r\n\r\nTrack number. 1 and 2 denote \"main\" lines, while 0 and 3 are connectors (between different types of tracks) and pocket tracks, respectively.\r\n\r\n\r\n\r\n\r\n\r\nTrackCircuitNeighbor Elements\r\n\r\n\r\n\r\n\r\n\r\nCircuitIds\r\n\r\n\r\nArray containing neighboring circuit ids.\r\n\r\n\r\n\r\n\r\nNeighborType\r\n\r\nLeft or Right neighbor group. Generally speaking, left neighbors are to the west and south, while right neighbors are to the east/north.\r\n\r\n\r\n\r\n\r\nNeighbor Notes\r\n\r\nGiven the hypothetical example below, note that CircuitId 8 has two right neighbors - 4 and 3. Similarly, CircuitId 6 has two left neighbors - 5 and 7.\r\n\r\n\r\n\r\n\r\n\r\nbackground\r\n\r\n\r\n\r\nLayer 1\r\nTrack 2\r\n\r\n8\r\n\r\n4\r\nTrack 1\r\n\r\nCircuitId 1\r\n\r\n2\r\n\r\nCircuitId 4\r\n\r\n9\r\n\r\n\r\n100\r\n\r\n3\r\n\r\nTrack 0\r\nTrack 0\r\nTrack 3\r\n7\r\n5\r\n\r\n6\r\n\r\n\r\n\r\nThe JSON representation of the image above would be as follows:\r\n\r\n\r\n{\r\n\"TrackCircuits\": [{\r\n\"Track\": 2,\r\n\"CircuitId\": 8,\r\n\"Neighbors\": [{\r\n\"NeighborType\": \"Right\",\r\n\"CircuitIds\": [4, 3]\r\n}]\r\n}, {\r\n\"Track\": 2,\r\n\"CircuitId\": 4,\r\n\"Neighbors\": [{\r\n\"NeighborType\": \"Left\",\r\n\"CircuitIds\": [8]\r\n}, {\r\n\"NeighborType\": \"Right\",\r\n\"CircuitIds\": [9]\r\n}]\r\n}, {\r\n\"Track\": 2,\r\n\"CircuitId\": 9,\r\n\"Neighbors\": [{\r\n\"NeighborType\": \"Left\",\r\n\"CircuitIds\": [4]\r\n}]\r\n}, {\r\n\"Track\": 0,\r\n\"CircuitId\": 3,\r\n\"Neighbors\": [{\r\n\"NeighborType\": \"Left\",\r\n\"CircuitIds\": [8]\r\n}, {\r\n\"NeighborType\": \"Right\",\r\n\"CircuitIds\": [100]\r\n}]\r\n}, {\r\n\"Track\": 3,\r\n\"CircuitId\": 100,\r\n\"Neighbors\": [{\r\n\"NeighborType\": \"Left\",\r\n\"CircuitIds\": [3]\r\n}, {\r\n\"NeighborType\": \"Right\",\r\n\"CircuitIds\": [7]\r\n}]\r\n}, {\r\n\"Track\": 0,\r\n\"CircuitId\": 7,\r\n\"Neighbors\": [{\r\n\"NeighborType\": \"Left\",\r\n\"CircuitIds\": [100]\r\n}, {\r\n\"NeighborType\": \"Right\",\r\n\"CircuitIds\": [6]\r\n}]\r\n}, {\r\n\"Track\": 1,\r\n\"CircuitId\": 1,\r\n\"Neighbors\": [{\r\n\"NeighborType\": \"Right\",\r\n\"CircuitIds\": [2]\r\n}]\r\n}, {\r\n\"Track\": 1,\r\n\"CircuitId\": 2,\r\n\"Neighbors\": [{\r\n\"NeighborType\": \"Left\",\r\n\"CircuitIds\": [1]\r\n}, {\r\n\"NeighborType\": \"Right\",\r\n\"CircuitIds\": [5]\r\n}]\r\n}, {\r\n\"Track\": 1,\r\n\"CircuitId\": 5,\r\n\"Neighbors\": [{\r\n\"NeighborType\": \"Left\",\r\n\"CircuitIds\": [2]\r\n}, {\r\n\"NeighborType\": \"Right\",\r\n\"CircuitIds\": [6]\r\n}]\r\n}, {\r\n\"Track\": 1,\r\n\"CircuitId\": 6,\r\n\"Neighbors\": [{\r\n\"NeighborType\": \"Left\",\r\n\"CircuitIds\": [5, 7]\r\n}]\r\n}]\r\n}", "operationId"=>"getTrackcircuits", "x-api-path-slug"=>"trackcircuits-get", "parameters"=>[{"in"=>"query", "name"=>"contentType", "description"=>"Returns response in the specified format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Subway", "Tracks", "Circuits"]}}}}, "wmata-incidents-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Washington Metropolitan Area Transit Authority", "x-complete"=>1, "info"=>{"title"=>"WMATA Incidents", "description"=>"rail-bus-and-elevator-disruptionsoutages-", "version"=>"1.0.0"}, "host"=>"api.wmata.com", "basePath"=>"/Incidents.svc", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/json/BusIncidents"=>{"get"=>{"summary"=>"JSON - Bus Incidents", "description"=>"Description\r\n\r\nReturns a set of reported bus incidents/delays for a given Route. Omit the\r\nRoute to return all reported items.\r\n\r\nNote that the Route parameter accepts only base route names and no\r\nvariations, i.e.: use 10A instead of 10Av1 and 10Av2.\r\n\r\nBus incidents/delays are refreshed once every 20 to 30 seconds approximately.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nBusIncidents\r\n\r\n\r\nArray containing bus incident information (BusIncident).\r\n\r\n\r\n\r\n\r\n\r\n\r\nBusIncident\r\nElements\r\n\r\n\r\n\r\n\r\n\r\nDateUpdated\r\n\r\nDate and time (Eastern Standard Time) of last update. Will be\r\nin YYYY-MM-DDTHH:mm:ss format (e.g.: 2014-10-28T08:13:03).\r\n\r\n\r\n\r\nDescription\r\n\r\nFree-text description of the delay or incident.\r\n\r\n\r\n\r\nIncidentID\r\n\r\nUnique identifier for an incident.\r\n\r\n\r\n\r\nIncidentType\r\n\r\nFree-text description of the incident type. Usually\r\nDelay or Alert but is subject to change at any time.\r\n\r\n\r\n\r\nRoutesAffected\r\n\r\nArray containing routes affected. Routes listed are usually\r\nidentical to base route names (i.e.: not 10Av1 or 10Av2, but 10A),\r\nbut may differ from what our bus methods return.", "operationId"=>"54763641281d830c946a3d75", "x-api-path-slug"=>"jsonbusincidents-get", "parameters"=>[{"in"=>"query", "name"=>"Route", "description"=>"Base bus route; variations are not recognized (i"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Buses", "Incidents"]}}, "/json/ElevatorIncidents"=>{"get"=>{"summary"=>"JSON - Elevator/Escalator Outages", "description"=>"Description\r\n\r\nReturns a list of reported elevator and escalator outages at a\r\ngiven station. Omit the StationCode parameter to return all reported\r\noutages.\r\n\r\nNote that for stations with multiple platforms and therefore StationCodes\r\n(e.g.: Metro Center, L'Enfant Plaza, etc.), a distinct call is required for\r\neach StationCode.\r\n\r\nElevator and escalator outages are refreshed once every 20 to 30 seconds approximately.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nElevatorIncidents\r\n\r\n\r\nArray containing elevator/escalator outage information\r\n(ElevatorIncident).\r\n\r\n\r\n\r\n\r\n\r\n\r\nElevatorIncident Elements\r\n\r\n\r\n\r\n\r\n\r\nDateOutOfServ\r\n\r\nDate and time (Eastern Standard Time) unit was reported out of\r\nservice. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\r\n2014-10-27T15:17:00).\r\n\r\n\r\n\r\nDateUpdated\r\n\r\nDate and time (Eastern Standard Time) outage details was last\r\nupdated. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\r\n2014-10-27T15:17:00).\r\n\r\n\r\n\r\nDisplayOrder\r\n\r\nDeprecated.\r\n\r\n\r\n\r\nLocationDescription\r\n\r\nFree-text description of the unit location within a station\r\n(e.g.: Escalator between mezzanine and\r\nplatform).\r\n\r\n\r\n\r\nStationCode\r\n\r\nUnit's station code. Use this value in other rail-related APIs\r\nto retrieve data about a station.\r\n\r\n\r\n\r\nStationName\r\n\r\nFull station name, may include entrance information (e.g.:\r\nMetro Center, G and 11th St\r\nEntrance).\r\n\r\n\r\n\r\nSymptomCode\r\n\r\nDeprecated.\r\n\r\n\r\n\r\nSymptomDescription\r\n\r\nDescription for why the unit is out of service or otherwise in\r\nreduced operation.\r\n\r\n\r\n\r\nTimeOutOfService\r\n\r\nDeprecated. Use the time\r\nportion of the DateOutOfServ element.\r\n\r\n\r\n\r\nUnitName\r\n\r\nUnique identifier for unit, by type (a single elevator and\r\nescalator may have the same UnitName, but no two elevators or two\r\nescalators will have the same UnitName).\r\n\r\n\r\n\r\nUnitStatus\r\n\r\nDeprecated. If listed here,\r\nthe unit is inoperational or otherwise impaired.\r\n\r\n\r\n\r\nUnitType\r\n\r\nType of unit. Will be ELEVATOR\r\nor ESCALATOR.", "operationId"=>"54763641281d830c946a3d76", "x-api-path-slug"=>"jsonelevatorincidents-get", "parameters"=>[{"in"=>"query", "name"=>"StationCode", "description"=>"Station code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Elevator", "Incidents"]}}, "/json/Incidents"=>{"get"=>{"summary"=>"JSON - Rail Incidents", "description"=>"Description\r\n\r\nReturns reported rail incidents (significant disruptions and delays to\r\nnormal service). The data is identical to WMATA's Metrorail Service Status\r\nfeed.\r\n\r\nRail incidents are refreshed once every 20 to 30 seconds approximately.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nIncidents\r\n\r\n\r\nArray containing rail disruption information (Incident).\r\n\r\n\r\n\r\n\r\n\r\n\r\nIncident Elements\r\n\r\n\r\n\r\n\r\n\r\nDateUpdated\r\n\r\nDate and time (Eastern Standard Time) of last update. Will be\r\nin YYYY-MM-DDTHH:mm:SS format (e.g.: 2010-07-29T14:21:28).\r\n\r\n\r\n\r\nDelaySeverity\r\n\r\nDeprecated.\r\n\r\n\r\n\r\nDescription\r\n\r\nFree-text description of the incident.\r\n\r\n\r\n\r\nEmergencyText\r\n\r\nDeprecated.\r\n\r\n\r\n\r\nEndLocationFullName\r\n\r\nDeprecated.\r\n\r\n\r\n\r\nIncidentID\r\n\r\nUnique identifier for an incident.\r\n\r\n\r\n\r\nIncidentType\r\n\r\nFree-text description of the incident type. Usually Delay or\r\nAlert but is subject to change at any time.\r\n\r\n\r\n\r\nLinesAffected\r\n\r\nSemi-colon and space separated list of line codes (e.g.:\r\nRD; or BL;\r\nOR; or BL; OR; RD;). We do\r\nplan to update this to return something more reasonable like an\r\narray, but until then, use code similar to the following:\r\n\r\n\"RD; GR; BL;\".split(/;[\\s]?/).filter(function(fn) { return fn\r\n!== ''; })\r\n\r\n\r\n\r\nPassengerDelay\r\n\r\nDeprecated.\r\n\r\n\r\n\r\n\r\nStartLocationFullName\r\n\r\nDeprecated.", "operationId"=>"54763641281d830c946a3d77", "x-api-path-slug"=>"jsonincidents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Buses", "Incidents"]}}, "/BusIncidents"=>{"get"=>{"summary"=>"XML - Bus Incidents", "description"=>"Description\r\n\r\nReturns a set of reported bus incidents/delays for a given Route. Omit the\r\nRoute to return all reported items.\r\n\r\nNote that the Route parameter accepts only base route names and no\r\nvariations, i.e.: use 10A instead of 10Av1 and 10Av2.\r\n\r\nBus incidents/delays are refreshed once every 20 to 30 seconds approximately.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nBusIncidents\r\n\r\n\r\nArray containing bus incident information (BusIncident).\r\n\r\n\r\n\r\n\r\n\r\n\r\nBusIncident\r\nElements\r\n\r\n\r\n\r\n\r\n\r\nDateUpdated\r\n\r\nDate and time (Eastern Standard Time) of last update. Will be\r\nin YYYY-MM-DDTHH:mm:ss format (e.g.: 2014-10-28T08:13:03).\r\n\r\n\r\n\r\nDescription\r\n\r\nFree-text description of the delay or incident.\r\n\r\n\r\n\r\nIncidentID\r\n\r\nUnique identifier for an incident.\r\n\r\n\r\n\r\nIncidentType\r\n\r\nFree-text description of the incident type. Usually\r\nDelay or Alert but is subject to change at any time.\r\n\r\n\r\n\r\nRoutesAffected\r\n\r\nArray containing routes affected. Routes listed are usually\r\nidentical to base route names (i.e.: not 10Av1 or 10Av2, but 10A),\r\nbut may differ from what our bus methods return.", "operationId"=>"54763641281d830c946a3d78", "x-api-path-slug"=>"busincidents-get", "parameters"=>[{"in"=>"query", "name"=>"Route", "description"=>"Bus route"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Buses", "Incidents"]}}, "/ElevatorIncidents"=>{"get"=>{"summary"=>"XML - Elevator/Escalator Outages", "description"=>"Description\r\n\r\nReturns a list of reported elevator and escalator outages at a\r\ngiven station. Omit the StationCode parameter to return all reported\r\noutages.\r\n\r\nNote that for stations with multiple platforms and therefore StationCodes\r\n(e.g.: Metro Center, L'Enfant Plaza, etc.), a distinct call is required for\r\neach StationCode.\r\n\r\nElevator and escalator outages are refreshed once every 20 to 30 seconds approximately.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nElevatorIncidents\r\n\r\n\r\nArray containing elevator/escalator outage information\r\n(ElevatorIncident).\r\n\r\n\r\n\r\n\r\n\r\n\r\nElevatorIncident Elements\r\n\r\n\r\n\r\n\r\n\r\nDateOutOfServ\r\n\r\nDate and time (Eastern Standard Time) unit was reported out of\r\nservice. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\r\n2014-10-27T15:17:00).\r\n\r\n\r\n\r\nDateUpdated\r\n\r\nDate and time (Eastern Standard Time) outage details was last\r\nupdated. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.:\r\n2014-10-27T15:17:00).\r\n\r\n\r\n\r\nDisplayOrder\r\n\r\nDeprecated.\r\n\r\n\r\n\r\nLocationDescription\r\n\r\nFree-text description of the unit location within a station\r\n(e.g.: Escalator between mezzanine and\r\nplatform).\r\n\r\n\r\n\r\nStationCode\r\n\r\nUnit's station code. Use this value in other rail-related APIs\r\nto retrieve data about a station.\r\n\r\n\r\n\r\nStationName\r\n\r\nFull station name, may include entrance information (e.g.:\r\nMetro Center, G and 11th St\r\nEntrance).\r\n\r\n\r\n\r\nSymptomCode\r\n\r\nDeprecated.\r\n\r\n\r\n\r\nSymptomDescription\r\n\r\nDescription for why the unit is out of service or otherwise in\r\nreduced operation.\r\n\r\n\r\n\r\nTimeOutOfService\r\n\r\nDeprecated. Use the time\r\nportion of the DateOutOfServ element.\r\n\r\n\r\n\r\nUnitName\r\n\r\nUnique identifier for unit, by type (a single elevator and\r\nescalator may have the same UnitName, but no two elevators or two\r\nescalators will have the same UnitName).\r\n\r\n\r\n\r\nUnitStatus\r\n\r\nDeprecated. If listed here,\r\nthe unit is inoperational or otherwise impaired.\r\n\r\n\r\n\r\nUnitType\r\n\r\nType of unit. Will be ELEVATOR\r\nor ESCALATOR.", "operationId"=>"54763641281d830c946a3d79", "x-api-path-slug"=>"elevatorincidents-get", "parameters"=>[{"in"=>"query", "name"=>"StationCode", "description"=>"Two-letter station code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Elevator", "Incidents"]}}, "/Incidents"=>{"get"=>{"summary"=>"XML - Rail Incidents", "description"=>"Description\r\n\r\nReturns reported rail incidents (significant disruptions and delays to\r\nnormal service). The data is identical to WMATA's Metrorail Service Status\r\nfeed.\r\n\r\nRail incidents are refreshed once every 20 to 30 seconds approximately.\r\n\r\nResponse Elements\r\n\r\n\r\n\r\n\r\nElement\r\n\r\nDescription\r\n\r\n\r\n\r\n\r\n\r\nIncidents\r\n\r\n\r\nArray containing rail disruption information (Incident).\r\n\r\n\r\n\r\n\r\n\r\n\r\nIncident Elements\r\n\r\n\r\n\r\n\r\n\r\nDateUpdated\r\n\r\nDate and time (Eastern Standard Time) of last update. Will be\r\nin YYYY-MM-DDTHH:mm:SS format (e.g.: 2010-07-29T14:21:28).\r\n\r\n\r\n\r\nDelaySeverity\r\n\r\nDeprecated.\r\n\r\n\r\n\r\nDescription\r\n\r\nFree-text description of the incident.\r\n\r\n\r\n\r\nEmergencyText\r\n\r\nDeprecated.\r\n\r\n\r\n\r\nEndLocationFullName\r\n\r\nDeprecated.\r\n\r\n\r\n\r\nIncidentID\r\n\r\nUnique identifier for an incident.\r\n\r\n\r\n\r\nIncidentType\r\n\r\nFree-text description of the incident type. Usually Delay or\r\nAlert but is subject to change at any time.\r\n\r\n\r\n\r\nLinesAffected\r\n\r\nSemi-colon and space separated list of line codes (e.g.:\r\nRD; or BL;\r\nOR; or BL; OR; RD;). We do\r\nplan to update this to return something more reasonable like an\r\narray, but until then, use code similar to the following:\r\n\r\n\"RD; GR; BL;\".split(/;[\\s]?/).filter(function(fn) { return fn\r\n!== ''; })\r\n\r\n\r\n\r\nPassengerDelay\r\n\r\nDeprecated.\r\n\r\n\r\n\r\n\r\nStartLocationFullName\r\n\r\nDeprecated.", "operationId"=>"54763641281d830c946a3d7a", "x-api-path-slug"=>"incidents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transit", "Incidents"]}}}}, "apis"=>{"name"=>"Washington Metropolitan Area Transit Authority", "x-slug"=>"washington-metropolitan-area-transit-authority", "description"=>"Official feed of Metro/WMATA, not monitored 24/7. Report emergencies to Transit Police at (202) 962-2121. Service updates @metrorailinfo & @metrobusinfo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1214-washington-metropolitan-area-transit-authority.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"24927", "tags"=>"General Data,Transit,Transit,Transportation", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"washington-metropolitan-area-transit-authority/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"WMATA Bus Route and Stop Methods", "x-api-slug"=>"wmata-bus-route-and-stop-methods", "description"=>"Official feed of Metro/WMATA, not monitored 24/7. Report emergencies to Transit Police at (202) 962-2121. Service updates @metrorailinfo & @metrobusinfo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1214-washington-metropolitan-area-transit-authority.jpg", "humanURL"=>"http://wmata.com/", "baseURL"=>"https://api.wmata.com//Bus.svc", "tags"=>"General Data,Transit,Transit,Transportation", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/washington-metropolitan-area-transit-authority/stops-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/washington-metropolitan-area-transit-authority/wmata-bus-route-and-stop-methods-openapi.yaml"}]}, {"name"=>"WMATA Incidents", "x-api-slug"=>"wmata-incidents", "description"=>"Official feed of Metro/WMATA, not monitored 24/7. Report emergencies to Transit Police at (202) 962-2121. Service updates @metrorailinfo & @metrobusinfo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1214-washington-metropolitan-area-transit-authority.jpg", "humanURL"=>"http://wmata.com/", "baseURL"=>"https://api.wmata.com//Incidents.svc", "tags"=>"Buses,Stops", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/washington-metropolitan-area-transit-authority/incidents-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/washington-metropolitan-area-transit-authority/wmata-incidents-openapi.yaml"}]}, {"name"=>"WMATA Rail Station Information", "x-api-slug"=>"wmata-rail-station-information", "description"=>"Official feed of Metro/WMATA, not monitored 24/7. Report emergencies to Transit Police at (202) 962-2121. Service updates @metrorailinfo & @metrobusinfo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1214-washington-metropolitan-area-transit-authority.jpg", "humanURL"=>"http://wmata.com/", "baseURL"=>"https://api.wmata.com//Rail.svc", "tags"=>"Transit,Incidents", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/washington-metropolitan-area-transit-authority/srcstationtodststationinfo-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/washington-metropolitan-area-transit-authority/wmata-rail-station-information-openapi.yaml"}]}, {"name"=>"WMATA Real-Time Bus Predictions", "x-api-slug"=>"wmata-realtime-bus-predictions", "description"=>"Official feed of Metro/WMATA, not monitored 24/7. Report emergencies to Transit Police at (202) 962-2121. Service updates @metrorailinfo & @metrobusinfo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1214-washington-metropolitan-area-transit-authority.jpg", "humanURL"=>"http://wmata.com/", "baseURL"=>"https://api.wmata.com//NextBusService.svc", "tags"=>"Transit,Stations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/washington-metropolitan-area-transit-authority/jsonjpredictions-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/washington-metropolitan-area-transit-authority/wmata-realtime-bus-predictions-openapi.yaml"}]}, {"name"=>"WMATA Real-Time Rail Predictions", "x-api-slug"=>"wmata-realtime-rail-predictions", "description"=>"Official feed of Metro/WMATA, not monitored 24/7. Report emergencies to Transit Police at (202) 962-2121. Service updates @metrorailinfo & @metrobusinfo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1214-washington-metropolitan-area-transit-authority.jpg", "humanURL"=>"http://wmata.com/", "baseURL"=>"https://api.wmata.com//StationPrediction.svc", "tags"=>"Predictions", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/washington-metropolitan-area-transit-authority/getpredictionstationcodes-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/washington-metropolitan-area-transit-authority/wmata-realtime-rail-predictions-openapi.yaml"}]}, {"name"=>"WMATA Train Positions", "x-api-slug"=>"wmata-train-positions", "description"=>"Official feed of Metro/WMATA, not monitored 24/7. Report emergencies to Transit Police at (202) 962-2121. Service updates @metrorailinfo & @metrobusinfo.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1214-washington-metropolitan-area-transit-authority.jpg", "humanURL"=>"http://wmata.com/", "baseURL"=>"https://api.wmata.com//TrainPositions", "tags"=>"Transit,Rail,Prediction,Stations", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/washington-metropolitan-area-transit-authority/trackcircuits-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/washington-metropolitan-area-transit-authority/wmata-train-positions-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api.wmata.com/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/wmata"}, {"type"=>"x-developer", "url"=>"http://developer.wmata.com/"}, {"type"=>"x-email", "url"=>"boardofdirectors@wmata.com"}, {"type"=>"x-email", "url"=>"metrotransit@wmata.com"}, {"type"=>"x-email", "url"=>"adaassist@wmata.com"}, {"type"=>"x-email", "url"=>"access@wmata.com"}, {"type"=>"x-email", "url"=>"cjachles@wmata.com"}, {"type"=>"x-email", "url"=>"writtentestimony@wmata.com"}, {"type"=>"x-email", "url"=>"speak@wmata.com"}, {"type"=>"x-email", "url"=>"SEBusMove@wmata.com"}, {"type"=>"x-email", "url"=>"PARP@wmata.com"}, {"type"=>"x-email", "url"=>"raccomments@wmata.com"}, {"type"=>"x-signup", "url"=>"https://developer.wmata.com/signup/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/wmata"}, {"type"=>"x-website", "url"=>"http://wmata.com/"}, {"type"=>"x-website", "url"=>"http://wmata.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-search-console{"google-url-testing-tools-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Search Console", "x-complete"=>1, "info"=>{"title"=>"Google Search Console URL Testing Tools", "description"=>"provides-tools-for-running-validation-tests-against-single-urls", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"searchconsole.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/urlTestingTools/mobileFriendlyTest:run"=>{"post"=>{"summary"=>"Run Mobile Friendly Test", "description"=>"Runs Mobile-Friendly Test for a given URL.", "operationId"=>"searchconsole.urlTestingTools.mobileFriendlyTest.run", "x-api-path-slug"=>"v1urltestingtoolsmobilefriendlytestrun-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test"]}}}}, "apis"=>{"name"=>"Google Search Console", "x-slug"=>"google-search-console", "description"=>"Search Console is a free service that enables you to monitor your sites performance in Google Search, to ensure that Google can crawl your site or app correctly, and to test the validity and performance of a given page. Search Console provides programmatic access to the service through the APIs documented here.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/subdomains-google-webmaster-tools-13960.gif", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Links,Profiles,Relative Data,Search,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-search-console/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Search Console API", "x-api-slug"=>"google-search-console-api", "description"=>"Query search analytics, list your verified sites, manage your sitemaps, and view crawl errors for your site.The Search Console API provides programmatic access to most of the functionality ofGoogle Search Console. You can use the API to view, add, or remove properties and sitemaps, and run advanced queries for Google Search results data for the properties that you manage in Search Console.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/subdomains-google-webmaster-tools-13960.gif", "humanURL"=>"https://developers.google.com/webmaster-tools/", "baseURL"=>"://www.googleapis.com//webmasters/v3", "tags"=>"API Provider,API Service Provider,Google APIs,Links,Profiles,Relative Data,Search,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-search-console/google-search-console-api-openapi.yaml"}]}, {"name"=>"Google URL Testing Tools API", "x-api-slug"=>"google-url-testing-tools-api", "description"=>"The Search Console URL Testing Tools API enables you to run various performance and validation checks against a single web page. These tests run as a non-logged-in user, with permissions of the Googlebot crawler; this means that if your page isrobotedto prevent access by Googlebot, these tests will not work.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/subdomains-google-webmaster-tools-13960.gif", "humanURL"=>"https://developers.google.com/webmaster-tools/", "baseURL"=>"://searchconsole.googleapis.com//", "tags"=>"Error", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-search-console/google-url-testing-tools-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://support.google.com/webmasters/go/blog"}, {"type"=>"x-blog-rss", "url"=>"https://webmasters.googleblog.com/feeds/posts/default?alt=rss"}, {"type"=>"x-forum", "url"=>"https://productforums.google.com/forum/#!forum/webmasters"}, {"type"=>"x-website", "url"=>"https://developers.google.com/webmaster-tools/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "google-search-console-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Search Console", "x-complete"=>1, "info"=>{"title"=>"Search Console", "description"=>"view-google-search-console-data-for-your-verified-sites-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v3"}, "host"=>"www.googleapis.com", "basePath"=>"/webmasters/v3", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/sites"=>{"get"=>{"summary"=>"Get Sites", "description"=>"Lists the user's Search Console sites.", "operationId"=>"webmasters.sites.list", "x-api-path-slug"=>"sites-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Site"]}}, "/sites/{siteUrl}"=>{"delete"=>{"summary"=>"Remove Site", "description"=>"Removes a site from the set of the user's Search Console sites.", "operationId"=>"webmasters.sites.delete", "x-api-path-slug"=>"sitessiteurl-delete", "parameters"=>[{"in"=>"path", "name"=>"siteUrl", "description"=>"The URI of the property as defined in Search Console"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Site"]}, "get"=>{"summary"=>"Get Site", "description"=>"Retrieves information about specific site.", "operationId"=>"webmasters.sites.get", "x-api-path-slug"=>"sitessiteurl-get", "parameters"=>[{"in"=>"path", "name"=>"siteUrl", "description"=>"The URI of the property as defined in Search Console"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Site"]}, "put"=>{"summary"=>"Update Site", "description"=>"Adds a site to the set of the user's sites in Search Console.", "operationId"=>"webmasters.sites.add", "x-api-path-slug"=>"sitessiteurl-put", "parameters"=>[{"in"=>"path", "name"=>"siteUrl", "description"=>"The URL of the site to add"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Site"]}}, "/sites/{siteUrl}/searchAnalytics/query"=>{"post"=>{"summary"=>"Query Data", "description"=>"Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days.\n\nWhen date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned.", "operationId"=>"webmasters.searchanalytics.query", "x-api-path-slug"=>"sitessiteurlsearchanalyticsquery-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"siteUrl", "description"=>"The sites URL, including protocol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data"]}}, "/sites/{siteUrl}/sitemaps"=>{"get"=>{"summary"=>"List Sitemap", "description"=>"Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).", "operationId"=>"webmasters.sitemaps.list", "x-api-path-slug"=>"sitessiteurlsitemaps-get", "parameters"=>[{"in"=>"query", "name"=>"sitemapIndex", "description"=>"A URL of a sites sitemap index"}, {"in"=>"path", "name"=>"siteUrl", "description"=>"The sites URL, including protocol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sitemap"]}}, "/sites/{siteUrl}/sitemaps/{feedpath}"=>{"delete"=>{"summary"=>"Delete Sitemap", "description"=>"Deletes a sitemap from this site.", "operationId"=>"webmasters.sitemaps.delete", "x-api-path-slug"=>"sitessiteurlsitemapsfeedpath-delete", "parameters"=>[{"in"=>"path", "name"=>"feedpath", "description"=>"The URL of the actual sitemap"}, {"in"=>"path", "name"=>"siteUrl", "description"=>"The sites URL, including protocol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sitemap"]}, "get"=>{"summary"=>"Get Sitemap", "description"=>"Retrieves information about a specific sitemap.", "operationId"=>"webmasters.sitemaps.get", "x-api-path-slug"=>"sitessiteurlsitemapsfeedpath-get", "parameters"=>[{"in"=>"path", "name"=>"feedpath", "description"=>"The URL of the actual sitemap"}, {"in"=>"path", "name"=>"siteUrl", "description"=>"The sites URL, including protocol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sitemap"]}, "put"=>{"summary"=>"Update Sitemap", "description"=>"Submits a sitemap for a site.", "operationId"=>"webmasters.sitemaps.submit", "x-api-path-slug"=>"sitessiteurlsitemapsfeedpath-put", "parameters"=>[{"in"=>"path", "name"=>"feedpath", "description"=>"The URL of the sitemap to add"}, {"in"=>"path", "name"=>"siteUrl", "description"=>"The sites URL, including protocol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sitemap"]}}, "/sites/{siteUrl}/urlCrawlErrorsCounts/query"=>{"get"=>{"summary"=>"Get Crawl Error Count", "description"=>"Retrieves a time series of the number of URL crawl errors per error category and platform.", "operationId"=>"webmasters.urlcrawlerrorscounts.query", "x-api-path-slug"=>"sitessiteurlurlcrawlerrorscountsquery-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"The crawl error category"}, {"in"=>"query", "name"=>"latestCountsOnly", "description"=>"If true, returns only the latest crawl error counts"}, {"in"=>"query", "name"=>"platform", "description"=>"The user agent type (platform) that made the request"}, {"in"=>"path", "name"=>"siteUrl", "description"=>"The sites URL, including protocol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Error"]}}, "/sites/{siteUrl}/urlCrawlErrorsSamples"=>{"get"=>{"summary"=>"Get Crawl Error Samples", "description"=>"Lists a site's sample URLs for the specified crawl error category and platform.", "operationId"=>"webmasters.urlcrawlerrorssamples.list", "x-api-path-slug"=>"sitessiteurlurlcrawlerrorssamples-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"The crawl error category"}, {"in"=>"query", "name"=>"platform", "description"=>"The user agent type (platform) that made the request"}, {"in"=>"path", "name"=>"siteUrl", "description"=>"The sites URL, including protocol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Error"]}}, "/sites/{siteUrl}/urlCrawlErrorsSamples/{url}"=>{"delete"=>{"summary"=>"Delete Crawl Error Samples", "description"=>"Marks the provided site's sample URL as fixed, and removes it from the samples list.", "operationId"=>"webmasters.urlcrawlerrorssamples.markAsFixed", "x-api-path-slug"=>"sitessiteurlurlcrawlerrorssamplesurl-delete", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"The crawl error category"}, {"in"=>"query", "name"=>"platform", "description"=>"The user agent type (platform) that made the request"}, {"in"=>"path", "name"=>"siteUrl", "description"=>"The sites URL, including protocol"}, {"in"=>"path", "name"=>"url", "description"=>"The relative path (without the site) of the sample URL"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Error"]}, "get"=>{"summary"=>"Get Crawl Error Sample", "description"=>"Retrieves details about crawl errors for a site's sample URL.", "operationId"=>"webmasters.urlcrawlerrorssamples.get", "x-api-path-slug"=>"sitessiteurlurlcrawlerrorssamplesurl-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"The crawl error category"}, {"in"=>"query", "name"=>"platform", "description"=>"The user agent type (platform) that made the request"}, {"in"=>"path", "name"=>"siteUrl", "description"=>"The sites URL, including protocol"}, {"in"=>"path", "name"=>"url", "description"=>"The relative path (without the site) of the sample URL"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Error"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
domaintools{"parsed-whois-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DomainTools", "x-complete"=>1, "info"=>{"title"=>"Parsed Whois API", "description"=>"the-domaintools-api-is-organized-into-distinct-products-with-queries-that-follow-a-restful-url-structure-wherever-possible--each-product-offers-free-unauthenticated-access-for-the-sample-urls-listed-with-each-product--if-you-havent-already-you-may-want-to-review-the-getting-started-document-to-learn-about-authentication-and-response-formats--the-parsed-whois-api-provides-parsed-information-extracted-from-the-raw-whois-record--the-api-is-optimized-to-quickly-retrieve-the-whois-record-group-important-data-together-and-return-a-wellstructured-format--the-parsed-whois-api-is-ideal-for-anyone-wishing-to-search-for-index-or-crossreference-data-from-one-or-multiple-whois-records-", "version"=>"1.0.0"}, "host"=>"api.domaintools.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{domain}/whois/parsed"=>{"get"=>{"summary"=>"Parsed Whois", "description"=>"The Parsed Whois API provides parsed information extracted from the raw Whois recor", "operationId"=>"parsedWhois", "x-api-path-slug"=>"domainwhoisparsed-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Whois"]}}}}, "registrant-monitor-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DomainTools", "x-complete"=>1, "info"=>{"title"=>"Registrant Monitor API", "description"=>"receive-notification-when-specific-people-or-organizations-register-renew-or-delete-domain-names", "version"=>"1.0.0"}, "host"=>"api.domaintools.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/ip-registrant-monitor/"=>{"get"=>{"summary"=>"IP Registrant Monitor", "description"=>"Receive notification when specific people or organizations are allocated new IP ranges or have existing ranges de-allocated", "operationId"=>"registrantMonitor", "x-api-path-slug"=>"ipregistrantmonitor-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"Limits results to IP addresses allocated to an entity with a particular country", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"include_total_count", "description"=>"Returns the total number of results for a query", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Providing the page number allows access to additional pages of data", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"A space separated list of free text query terms", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"search_type", "description"=>"Type of changes to return", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"server", "description"=>"Limits results to ranges from a particular Whois server", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Registrant Monitor"]}}}}, "name-server-monitor-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DomainTools", "x-complete"=>1, "info"=>{"title"=>"Name Server Monitor API", "description"=>"receive-notification-when-there-are-new-andor-deleted-domains-on-a-given-domain-name-server", "version"=>"1.0.0"}, "host"=>"api.domaintools.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/name-server-monitor/"=>{"get"=>{"summary"=>"Name Server Monitor", "description"=>"Receive notification when there are new and/or deleted domains on a given Domain Name Server", "operationId"=>"nameServerMonitor", "x-api-path-slug"=>"nameservermonitor-get", "parameters"=>[{"in"=>"query", "name"=>"days_back", "description"=>"Use this parameter in exceptional circumstances where you need to search domain changes up to six days prior to the current date", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"If the result set is larger than 1000 records for a given day, request additional pages with this parameter", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"The hostname of the Name Server you wish to query", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Name Server Monitor"]}}}}, "ip-monitor-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DomainTools", "x-complete"=>1, "info"=>{"title"=>"IP Monitor API", "description"=>"receive-notification-when-there-are-new-andor-deleted-domains-on-a-given-ip-address", "version"=>"1.0.0"}, "host"=>"api.domaintools.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/ip-monitor/"=>{"get"=>{"summary"=>"IP Monitor", "description"=>"Receive notification when there are new and/or deleted domains on a given IP Address", "operationId"=>"ipMonitor", "x-api-path-slug"=>"ipmonitor-get", "parameters"=>[{"in"=>"query", "name"=>"days_back", "description"=>"Use this parameter in exceptional circumstances where you need to search domain changes up to six days prior to the current date", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"If the result set is larger than 1000 records for a given day, request additional pages with this parameter", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"The IP Address you wish to query ( i", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Monitor"]}}}}, "reverse-whois-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DomainTools", "x-complete"=>1, "info"=>{"title"=>"Reverse Whois API", "description"=>"provides-a-list-of-domain-names-with-whois-records-that-match-a-specific-query", "version"=>"1.0.0"}, "host"=>"api.domaintools.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/reverse-whois/"=>{"get"=>{"summary"=>"Reverse Whois", "description"=>"Provides a list of domain names with Whois records that match a specific query", "operationId"=>"reverseWhois", "x-api-path-slug"=>"reversewhois-get", "parameters"=>[{"in"=>"query", "name"=>"exclude", "description"=>"Domain names with Whois records that match these terms will be excluded from the result set", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"mode", "description"=>"quote : only lists the size and retail price of the query if you have per-domain pricing access purchase : includes the complete list of domain names that match the query", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"scope", "description"=>"Sets the scope of the report to include only current Whois records, or to include both current and historic records", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"terms", "description"=>"List of one or more terms to search for in the Whois record, separated with the pipe character ( | )", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reverse Whois"]}}}}, "brand-monitor-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DomainTools", "x-complete"=>1, "info"=>{"title"=>"Brand Monitor API", "description"=>"monitor-new-domains-registrations-for-specific-keywords", "version"=>"1.0.0"}, "host"=>"api.domaintools.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/mark-alert/"=>{"get"=>{"summary"=>"Brand Monitor", "description"=>"Monitor new domains registrations for specific keywords", "operationId"=>"brandMonitor", "x-api-path-slug"=>"markalert-get", "parameters"=>[{"in"=>"query", "name"=>"days_back", "description"=>"Use this parameter in exceptional circumstances where you need to search domains registered up to six days prior to the current date", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"domain_status", "description"=>"Sets the scope of domain names to search", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"exclude", "description"=>"Domain names with these words will be excluded from the result set", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"One or more terms separated by the pipe character ( | )", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Brand Monitor"]}}}}, "domain-profile-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DomainTools", "x-complete"=>1, "info"=>{"title"=>"Domain Profile API", "description"=>"basic-registrant-server-and-registration-data-for-a-domain-name-plus-preview-data-for-other-products", "version"=>"1.0.0"}, "host"=>"api.domaintools.com", "basePath"=>"v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{domain}"=>{"get"=>{"summary"=>"Domain Profile", "description"=>"Basic registrant, server, and registration data for a domain name, plus preview data for other products", "operationId"=>"domainProfile", "x-api-path-slug"=>"domain-get", "parameters"=>[{"in"=>"path", "name"=>"domain", "description"=>"The domain to profile", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}}}, "ip-registrant-monitor-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DomainTools", "x-complete"=>1, "info"=>{"title"=>"IP Registrant Monitor API", "description"=>"receive-notification-when-specific-people-or-organizations-are-allocated-new-ip-ranges-or-have-existing-ranges-deallocated", "version"=>"1.0.0"}, "host"=>"api.domaintools.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/ip-registrant-monitor/"=>{"get"=>{"summary"=>"IP Registrant Monitor", "description"=>"Receive notification when specific people or organizations are allocated new IP ranges or have existing ranges de-allocated", "operationId"=>"ipRegistrantMonitor", "x-api-path-slug"=>"ipregistrantmonitor-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"Limits results to IP addresses allocated to an entity with a particular country", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"include_total_count", "description"=>"Returns the total number of results for a query", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Providing the page number allows access to additional pages of data", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"A space separated list of free text query terms", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"search_type", "description"=>"Type of changes to return", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"server", "description"=>"Limits results to ranges from a particular Whois server", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Registrant Monitor"]}}}}, "hosting-history-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DomainTools", "x-complete"=>1, "info"=>{"title"=>"Hosting History API", "description"=>"provides-the-registrar-ip-and-name-server-history-for-a-domain-name", "version"=>"1.0.0"}, "host"=>"api.domaintools.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{domain}/hosting-history/"=>{"get"=>{"summary"=>"Domain History", "description"=>"Provides the registrar, IP and name server history for a domain name", "operationId"=>"domainHistory", "x-api-path-slug"=>"domainhostinghistory-get", "parameters"=>[{"in"=>"path", "name"=>"domain", "description"=>"The domain", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domain Hosting History"]}}}}, "whois-history-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DomainTools", "x-complete"=>1, "info"=>{"title"=>"Whois History API", "description"=>"historical-whois-records", "version"=>"1.0.0"}, "host"=>"api.domaintools.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{domain}/whois/history/"=>{"get"=>{"summary"=>"Whois History", "description"=>"Historical Whois records", "operationId"=>"whoisHistory", "x-api-path-slug"=>"domainwhoishistory-get", "parameters"=>[{"in"=>"path", "name"=>"domain", "description"=>"The domain being requested", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Whois"]}}}}, "domain-suggestions-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DomainTools", "x-complete"=>1, "info"=>{"title"=>"Domain Suggestions API", "description"=>"generates-available-domain-suggestions-that-are-related-to-a-query-string", "version"=>"1.0.0"}, "host"=>"api.domaintools.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/domain-suggestions/"=>{"get"=>{"summary"=>"Domain Suggestions", "description"=>"Generates available domain suggestions that are related to a query string", "operationId"=>"domainSuggestions", "x-api-path-slug"=>"domainsuggestions-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"Query string ??? must be at least two characters long", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domain Suggestions"]}}}}, "reverse-ip-whois-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DomainTools", "x-complete"=>1, "info"=>{"title"=>"Reverse IP Whois API", "description"=>"provides-a-list-of-ip-network-ranges-with-whois-records-that-match-a-specific-query", "version"=>"1.0.0"}, "host"=>"api.domaintools.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/reverse-ip-whois/"=>{"get"=>{"summary"=>"Reverse IP Whois", "description"=>"Provides a list of IP network ranges with Whois records that match a specific query", "operationId"=>"reverseIPWhois", "x-api-path-slug"=>"reverseipwhois-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"Limits results to IP addresses allocated to an entity with a particular country", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"include_total_count", "description"=>"Returns the total number of results for a query", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"ip", "description"=>"Returns the most recent cached IP Whois record for the allocated range the IP is in", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Providing the page number allows access to additional pages of data", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"A space separated list of free text query terms", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"server", "description"=>"Limits results to ranges from a particular Whois server", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reverse IP Whois"]}}}}, "apis"=>{"name"=>"DomainTools", "x-slug"=>"domaintools", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"6104", "tags"=>"API Provider,API Service Provider,DNS,DNS Internet,Domain Names,Enterprise,General Data,internet,Profiles,Relative Data,SaaS,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"domaintools/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Brand Monitor API", "x-api-slug"=>"brand-monitor-api", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "humanURL"=>"http://www.domaintools.com", "baseURL"=>"http://api.domaintools.com//v1", "tags"=>"API Provider,API Service Provider,DNS,DNS Internet,Domain Names,Enterprise,General Data,internet,Profiles,Relative Data,SaaS,Service API,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/domaintools/markalert-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/domaintools/brand-monitor-api-openapi.yaml"}]}, {"name"=>"Domain Profile API", "x-api-slug"=>"domain-profile-api", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "humanURL"=>"http://www.domaintools.com", "baseURL"=>"http://api.domaintools.com/v1", "tags"=>"Brand Monitor", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/domaintools/domain-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/domaintools/domain-profile-api-openapi.yaml"}]}, {"name"=>"Domain Search API", "x-api-slug"=>"domain-search-api", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "humanURL"=>"http://www.domaintools.com", "baseURL"=>"http://api.domaintools.com//v2", "tags"=>"Domains", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/domaintools/domainsearch-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/domaintools/domain-search-api-openapi.yaml"}]}, {"name"=>"Domain Suggestions API", "x-api-slug"=>"domain-suggestions-api", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "humanURL"=>"http://www.domaintools.com", "baseURL"=>"http://api.domaintools.com//v1", "tags"=>"Domains", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/domaintools/domainsuggestions-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/domaintools/domain-suggestions-api-openapi.yaml"}]}, {"name"=>"Hosting History API", "x-api-slug"=>"hosting-history-api", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "humanURL"=>"http://www.domaintools.com", "baseURL"=>"http://api.domaintools.com//v1", "tags"=>"Domain Suggestions", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/domaintools/domainhostinghistory-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/domaintools/hosting-history-api-openapi.yaml"}]}, {"name"=>"IP Monitor API", "x-api-slug"=>"ip-monitor-api", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "humanURL"=>"http://www.domaintools.com", "baseURL"=>"http://api.domaintools.com//v1", "tags"=>"Domain Hosting History", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/domaintools/ipmonitor-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/domaintools/ip-monitor-api-openapi.yaml"}]}, {"name"=>"IP Registrant Monitor API", "x-api-slug"=>"ip-registrant-monitor-api", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "humanURL"=>"http://www.domaintools.com", "baseURL"=>"http://api.domaintools.com//v1", "tags"=>"IP Monitor", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/domaintools/ipregistrantmonitor-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/domaintools/ip-registrant-monitor-api-openapi.yaml"}]}, {"name"=>"Name Server Monitor API", "x-api-slug"=>"name-server-monitor-api", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "humanURL"=>"http://www.domaintools.com", "baseURL"=>"http://api.domaintools.com//v1", "tags"=>"IP Registrant Monitor", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/domaintools/nameservermonitor-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/domaintools/name-server-monitor-api-openapi.yaml"}]}, {"name"=>"Parsed Whois API", "x-api-slug"=>"parsed-whois-api", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "humanURL"=>"http://www.domaintools.com", "baseURL"=>"http://api.domaintools.com//v1", "tags"=>"Name Server Monitor", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/domaintools/domainwhoisparsed-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/domaintools/parsed-whois-api-openapi.yaml"}]}, {"name"=>"Registrant Monitor API", "x-api-slug"=>"registrant-monitor-api", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "humanURL"=>"http://www.domaintools.com", "baseURL"=>"http://api.domaintools.com//v1", "tags"=>"Whois", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/domaintools/ipregistrantmonitor-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/domaintools/registrant-monitor-api-openapi.yaml"}]}, {"name"=>"Reverse IP API", "x-api-slug"=>"reverse-ip-api", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "humanURL"=>"http://www.domaintools.com", "baseURL"=>"http://api.domaintools.com//v1", "tags"=>"IP Registrant Monitor", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/domaintools/reverseipwhois-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/domaintools/reverse-ip-api-openapi.yaml"}]}, {"name"=>"Reverse IP Whois API", "x-api-slug"=>"reverse-ip-whois-api", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "humanURL"=>"http://www.domaintools.com", "baseURL"=>"http://api.domaintools.com//v1", "tags"=>"Reverse IP Whois", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/domaintools/reverseipwhois-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/domaintools/reverse-ip-whois-api-openapi.yaml"}]}, {"name"=>"Reverse Name Server API", "x-api-slug"=>"reverse-name-server-api", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "humanURL"=>"http://www.domaintools.com", "baseURL"=>"http://api.domaintools.com//v1", "tags"=>"Reverse IP Whois", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/domaintools/domainnameserverdomains-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/domaintools/reverse-name-server-api-openapi.yaml"}]}, {"name"=>"Reverse Whois API", "x-api-slug"=>"reverse-whois-api", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "humanURL"=>"http://www.domaintools.com", "baseURL"=>"http://api.domaintools.com//v1", "tags"=>"Reverse Name Server", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/domaintools/reversewhois-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/domaintools/reverse-whois-api-openapi.yaml"}]}, {"name"=>"Whois History API", "x-api-slug"=>"whois-history-api", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "humanURL"=>"http://www.domaintools.com", "baseURL"=>"http://api.domaintools.com//v1", "tags"=>"Reverse Whois", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/domaintools/domainwhoishistory-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/domaintools/whois-history-api-openapi.yaml"}]}, {"name"=>"Whois Lookup API", "x-api-slug"=>"whois-lookup-api", "description"=>"DomainTools helps security analysts turn threat data into threat intelligence. We take indicators from your network, including domains and IPs, and connect them with nearly every active domain on the Internet. Those connections inform risk assessments,...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/393-domaintools.jpg", "humanURL"=>"http://www.domaintools.com", "baseURL"=>"http://api.domaintools.com//v1/domaintools.com/", "tags"=>"Whois", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/domaintools/domainwhois-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/domaintools/whois-lookup-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api.domaintools.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.domaintools.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/domain-tools"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/domain-tools"}, {"type"=>"x-developer", "url"=>"http://www.domaintools.com/api/docs/"}, {"type"=>"x-email", "url"=>"sales@domaintools.com"}, {"type"=>"x-github", "url"=>"https://github.com/DomainTools"}, {"type"=>"x-pricing", "url"=>"https://www.domaintools.com/products/domain-research/pricing/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/DomainTools"}, {"type"=>"x-website", "url"=>"http://www.domaintools.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "whois-lookup-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DomainTools", "x-complete"=>1, "info"=>{"title"=>"Whois Lookup API", "version"=>"1.0.0"}, "host"=>"api.domaintools.com", "basePath"=>"/v1/domaintools.com/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{domain}/whois"=>{"get"=>{"summary"=>"Whois Lookup", "description"=>"The Whois Lookup API provides the ownership record for a domain name or IP address with basic registration details.", "operationId"=>"whoisLookup", "x-api-path-slug"=>"domainwhois-get", "parameters"=>[{"in"=>"path", "name"=>"domain", "description"=>"The domain to lookup", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Whois"]}}}}, "reverse-name-server-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DomainTools", "x-complete"=>1, "info"=>{"title"=>"Reverse Name Server API", "description"=>"list-of-domains-that-share-the-same-primary-name-server", "version"=>"1.0.0"}, "host"=>"api.domaintools.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{domain]/name-server-domains/"=>{"get"=>{"summary"=>"Reverse Name Server", "description"=>"List of domains that share the same primary name server", "operationId"=>"reverseNameServer", "x-api-path-slug"=>"domainnameserverdomains-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Limits the size of the domain list than can appear in a response", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reverse Name Server"]}}}}, "domain-search-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DomainTools", "x-complete"=>1, "info"=>{"title"=>"Domain Search API", "description"=>"searches-active-and-deleted-domain-names-that-match-a-query-string", "version"=>"1.0.0"}, "host"=>"api.domaintools.com", "basePath"=>"/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/domain-search/"=>{"get"=>{"summary"=>"Domain Search", "description"=>"Searches active and deleted domain names that match a query string", "operationId"=>"domainSearch", "x-api-path-slug"=>"domainsearch-get", "parameters"=>[{"in"=>"query", "name"=>"active_only", "description"=>"Return only domains currently registered", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"anchor_left", "description"=>"Return only domains that start with the query term", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"anchor_right", "description"=>"Return only domains that end with the query term", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"deleted_only", "description"=>"Return only domains previously registered but not currently registered", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"exclude_query", "description"=>"Terms to exclude from matching ??? each term in the query string must be at least three characters long", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"has_hyphen", "description"=>"Return results with hyphens in the domain name", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"has_number", "description"=>"Return results with numbers in the domain name", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"max_length", "description"=>"Limit the maximum domain character coun", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"min_length", "description"=>"Limit the minumum domain character count", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Sets the page of results to retrieve from the server", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"Query string ??? each term in the query string must be at least three characters long", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Domains"]}}}}, "reverse-ip-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"DomainTools", "x-complete"=>1, "info"=>{"title"=>"Reverse IP API", "description"=>"provides-a-list-of-ip-network-ranges-with-whois-records-that-match-a-specific-query", "version"=>"1.0.0"}, "host"=>"api.domaintools.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/reverse-ip-whois/"=>{"get"=>{"summary"=>"Reverse IP Whois", "description"=>"Provides a list of IP network ranges with Whois records that match a specific query", "operationId"=>"reverseIPWhois", "x-api-path-slug"=>"reverseipwhois-get", "parameters"=>[{"in"=>"query", "name"=>"country", "description"=>"Limits results to IP addresses allocated to an entity with a particular country", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"include_total_count", "description"=>"Returns the total number of results for a query", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"ip", "description"=>"Returns the most recent cached IP Whois record for the allocated range the IP is in", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Providing the page number allows access to additional pages of data", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"A space separated list of free text query terms", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"server", "description"=>"Limits results to ranges from a particular Whois server", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reverse IP Whois"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-route-53{"aws-route-53-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Route 53", "x-complete"=>1, "info"=>{"title"=>"AWS Route 53 API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/2013-04-01/hostedzone/Id/associatevpc"=>{"post"=>{"summary"=>"Associate V P C With Hosted Zone", "description"=>"Associates an Amazon VPC with a private hosted zone. ImportantTo perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.Send a POST request to the /2013-04-01/hostedzone/hosted zone ID/associatevpc resource. The request body must include a document with an AssociateVPCWithHostedZoneRequest element. The response contains a ChangeInfo data type that you can use to track the progress of the request. NoteIf you want to associate a VPC that was created by using one AWS account with a private hosted zone that was created by using a different account, the AWS account that created the private hosted zone must first submit a CreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an AssociateVPCWithHostedZone request.", "operationId"=>"associatevpcwithhostedzone", "x-api-path-slug"=>"20130401hostedzoneidassociatevpc-post", "parameters"=>[{"in"=>"body", "name"=>"AssociateVPCWithHostedZoneRequest", "description"=>"Root level tag for the AssociateVPCWithHostedZoneRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"Comment", "description"=>"Optional: A comment about the association request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"Id", "description"=>"The ID of the private hosted zone that you want to associate an Amazon VPC with", "type"=>"string"}, {"in"=>"body", "name"=>"VPC", "description"=>"A complex type that contains information about the VPC that you want to associate with a private hosted zone", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/2013-04-01/hostedzone/Id/rrset/"=>{"post"=>{"summary"=>"Change Resource Record Sets", "description"=>"Create, change, update, or delete authoritative DNS information on all Amazon Route 53 servers.Send a POST request to: /2013-04-01/hostedzone/Amazon Route 53 hosted ZoneID/rrset resource. The request body must include a document with aChangeResourceRecordSetsRequest element. The request body contains a list ofchange items, known as a change batch. Change batches are considered transactional changes.When using the Amazon Route 53 API to change resource record sets, Amazon Route 53 either makes all or none of thechanges in a change batch request. This ensures that Amazon Route 53 never partially implements theintended changes to the resource record sets in a hosted zone. For example, a change batch request that deletes the CNAME record forwww.example.com and creates an alias resource record set for www.example.com. Amazon Route 53 deletesthe first resource record set and creates the second resource record set in a singleoperation. If either the DELETE or the CREATE action fails, thenboth changes (plus any other changes in the batch) fail, and the original CNAMErecord continues to exist.ImportantDue to the nature of transactional changes, you can't delete the same resourcerecord set more than once in a single change batch. If you attempt to delete the same changebatch more than once, Amazon Route 53 returns an InvalidChangeBatch error.NoteTo create resource record sets for complex routing configurations, use either thetraffic flow visual editor in the Amazon Route 53 console or the API actions for traffic policies andtraffic policy instances. Save the configuration as a traffic policy, then associate thetraffic policy with one or more domain names (such as example.com) or subdomain names (suchas www.example.com), in the same hosted zone or in multiple hosted zones. You can roll backthe updates if the new configuration isn't performing as expected. For more information, seeUsing Traffic Flow to Route DNSTraffic in the Amazon Route 53 Developer Guide.Use ChangeResourceRecordsSetsRequest to perform the following actions: CREATE: Creates a resource record set that has the specified values. DELETE: Deletes an existing resource record set that has the specified values. UPSERT: If a resource record set does not already exist, AWS createsit. If a resource set does exist, Amazon Route 53 updates it with the values in the request. The values that you need to include in the request depend on the type of resource record set that you're creating, deleting, or updating: Basic resource record sets (excluding alias, failover, geolocation, latency, and weighted resource record sets) Name Type TTL Failover, geolocation, latency, or weighted resource record sets (excluding alias resource record sets) Name Type TTL SetIdentifier Alias resource record sets (including failover alias, geolocation alias, latency alias, and weighted alias resource record sets) Name Type AliasTarget (includes DNSName, EvaluateTargetHealth, and HostedZoneId) SetIdentifier (for failover, geolocation, latency, and weighted resource record sets)When you submit a ChangeResourceRecordSets request, Amazon Route 53 propagates your changes to all of the Amazon Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Amazon Route 53 name servers in a few minutes. In rare circumstances, propagation can take up to 30 minutes. For more information, see GetChange For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide.", "operationId"=>"changeresourcerecordsets", "x-api-path-slug"=>"20130401hostedzoneidrrset-post", "parameters"=>[{"in"=>"body", "name"=>"ChangeBatch", "description"=>"A complex type that contains an optional comment and the Changeselement", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"ChangeResourceRecordSetsRequest", "description"=>"Root level tag for the ChangeResourceRecordSetsRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"Id", "description"=>"The ID of the hosted zone that contains the resource record sets that you want tochange", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Changes"]}}, "/2013-04-01/tags/ResourceType/ResourceId"=>{"post"=>{"summary"=>"Change Tags For Resource", "description"=>"Adds, edits, or deletes tags for a health check or a hosted zone.For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.", "operationId"=>"changetagsforresource", "x-api-path-slug"=>"20130401tagsresourcetyperesourceid-post", "parameters"=>[{"in"=>"body", "name"=>"AddTags", "description"=>"A complex type that contains a list of the tags that you want to add to the specifiedhealth check or hosted zone and/or the tags for which you want to edit the Valueelement", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"ChangeTagsForResourceRequest", "description"=>"Root level tag for the ChangeTagsForResourceRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"RemoveTagKeys", "description"=>"A complex type that contains a list of the tags that you want to delete from thespecified health check or hosted zone", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"ResourceId", "description"=>"The ID of the resource for which you want to add, change, or delete tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Changes"]}, "get"=>{"summary"=>"List Tags For Resource", "description"=>"Lists tags for one health check or hosted zone. For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.", "operationId"=>"listtagsforresource", "x-api-path-slug"=>"20130401tagsresourcetyperesourceid-get", "parameters"=>[{"in"=>"path", "name"=>"ResourceId", "description"=>"The ID of the resource for which you want to retrieve tags", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/2013-04-01/healthcheck"=>{"post"=>{"summary"=>"Create Health Check", "description"=>"Creates a new health check.To create a new health check, send a POST request to the/2013-04-01/healthcheck resource. The request body must include a documentwith a CreateHealthCheckRequest element. The response returns theCreateHealthCheckResponse element, containing the health check ID specifiedwhen adding health check to a resource record set. For information about adding health checksto resource record sets, see ResourceRecordSet:HealthCheckId in ChangeResourceRecordSets. If you are registering EC2 instances with an Elastic Load Balancing (ELB) loadbalancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register anEC2 instance with a load balancer, you configure settings for an ELB health check, whichperforms a similar function to an Amazon Route 53 health check.You can associate health checks with failover resource record sets in a private hostedzone. Note the following:Amazon Route 53 health checkers are outside the VPC. To check the health of an endpointwithin a VPC by IP address, you must assign a public IP address to the instance in theVPC.You can configure a health checker to check the health of an external resource thatthe instance relies on, such as a database server.You can create a CloudWatch metric, associate an alarm with the metric, and then create ahealth check that is based on the state of the alarm. For example, you might create a CloudWatchmetric that checks the status of the Amazon EC2 StatusCheckFailed metric, add analarm to the metric, and then create a health check that is based on the state of thealarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console,see the Amazon CloudWatch User Guide.", "operationId"=>"createhealthcheck", "x-api-path-slug"=>"20130401healthcheck-post", "parameters"=>[{"in"=>"body", "name"=>"CallerReference", "description"=>"A unique string that identifies the request and that allows failedCreateHealthCheck requests to be retried without the risk of executing theoperation twice", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"CreateHealthCheckRequest", "description"=>"Root level tag for the CreateHealthCheckRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"HealthCheckConfig", "description"=>"A complex type that contains the response to a CreateHealthCheck request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}}, "/2013-04-01/hostedzone"=>{"post"=>{"summary"=>"Create Hosted Zone", "description"=>"Creates a new public hosted zone, used to specify how the Domain Name System (DNS)routes traffic on the Internet for a domain, such as example.com, and its subdomains. ImportantPublic hosted zones can't be converted to a private hosted zone or vice versa.Instead, create a new hosted zone with the same name and create new resource recordsets.Send a POST request to the /2013-04-01/hostedzone resource. The request body must include a documentwith a CreateHostedZoneRequest element. The response returns theCreateHostedZoneResponse element containing metadata about the hostedzone.Fore more information about charges for hosted zones, see Amazon Route 53 Pricing.Note the following:You can't create a hosted zone for a top-level domain (TLD).Amazon Route 53 automatically creates a default SOA record and four NS records for the zone.For more information about SOA and NS records, see NS and SOA Records that Amazon Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.If your domain is registered with a registrar other than Amazon Route 53, you must update thename servers with your registrar to make Amazon Route 53 your DNS service. For more information, seeConfiguring Amazon Route 53 as your DNSService in the Amazon Route 53 Developer's Guide.After creating a zone, its initial status is PENDING. This means that itis not yet available on all DNS servers. The status of the zone changes to INSYNCwhen the NS and SOA records are available on all Amazon Route 53 DNS servers. When trying to create a hosted zone using a reusable delegation set, specify anoptional DelegationSetId, and Amazon Route 53 would assign those 4 NS records for the zone, instead ofallotting a new one.", "operationId"=>"createhostedzone", "x-api-path-slug"=>"20130401hostedzone-post", "parameters"=>[{"in"=>"body", "name"=>"CallerReference", "description"=>"A unique string that identifies the request and that allows failedCreateHostedZone requests to be retried without the risk of executing theoperation twice", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"CreateHostedZoneRequest", "description"=>"Root level tag for the CreateHostedZoneRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"Default", "description"=>"None", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"DelegationSetId", "description"=>"If you want to associate a reusable delegation set with this hosted zone, the ID thatAmazon Route 53 assigned to the reusable delegation set when you created it", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"HostedZoneConfig", "description"=>"(Optional) A complex type that contains an optional comment about your hosted zone", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"Name", "description"=>"The name of the domain", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"Parent", "description"=>"CreatedHostedZoneRequest", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"VPC", "description"=>"The VPC that you want your hosted zone to be associated with", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hosted Zones"]}}, "/2013-04-01/delegationset"=>{"post"=>{"summary"=>"Create Reusable Delegation Set", "description"=>"Creates a delegation set (a group of four name servers) that can be reused by multiplehosted zones. If a hosted zoned ID is specified, CreateReusableDelegationSetmarks the delegation set associated with that zone as reusableSend a POST request to the /2013-04-01/delegationset resource. The request body must include a document with a CreateReusableDelegationSetRequest element.NoteA reusable delegation set can't be associated with a private hosted zone/For more information, including a procedure on how to create and configure a reusabledelegation set (also known as white label name servers), see Configuring White Label NameServers.", "operationId"=>"createreusabledelegationset", "x-api-path-slug"=>"20130401delegationset-post", "parameters"=>[{"in"=>"body", "name"=>"CallerReference", "description"=>"A unique string that identifies the request, and that allows you to retry failedCreateReusableDelegationSet requests without the risk of executing theoperation twice", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"CreateReusableDelegationSetRequest", "description"=>"Root level tag for the CreateReusableDelegationSetRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"HostedZoneId", "description"=>"If you want to mark the delegation set for an existing hosted zone as reusable, the IDfor that hosted zone", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reusable Delegation Sets"]}}, "/2013-04-01/trafficpolicy"=>{"post"=>{"summary"=>"Create Traffic Policy", "description"=>"Creates a traffic policy, which you use to create multiple DNS resource record sets forone domain name (such as example.com) or one subdomain name (such aswww.example.com).Send a POST request to the /2013-04-01/trafficpolicy resource. The request body must include a documentwith a CreateTrafficPolicyRequest element. The response includes theCreateTrafficPolicyResponse element, which contains information about the newtraffic policy.", "operationId"=>"createtrafficpolicy", "x-api-path-slug"=>"20130401trafficpolicy-post", "parameters"=>[{"in"=>"body", "name"=>"Comment", "description"=>"(Optional) Any comments that you want to include about the traffic policy", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"CreateTrafficPolicyRequest", "description"=>"Root level tag for the CreateTrafficPolicyRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"Document", "description"=>"The definition of this traffic policy in JSON format", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"Name", "description"=>"The name of the traffic policy", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic Policies"]}}, "/2013-04-01/trafficpolicyinstance"=>{"post"=>{"summary"=>"Create Traffic Policy Instance", "description"=>"Creates resource record sets in a specified hosted zone based on the settings in aspecified traffic policy version. In addition, CreateTrafficPolicyInstanceassociates the resource record sets with a specified domain name (such as example.com) orsubdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain orsubdomain name by using the resource record sets that CreateTrafficPolicyInstancecreated.Send a POST request to the /2013-04-01/trafficpolicyinstance resource. The request body must include adocument with a CreateTrafficPolicyRequest element. The response returns theCreateTrafficPolicyInstanceResponse element, which contains information aboutthe traffic policy instance.", "operationId"=>"createtrafficpolicyinstance", "x-api-path-slug"=>"20130401trafficpolicyinstance-post", "parameters"=>[{"in"=>"body", "name"=>"CreateTrafficPolicyInstanceRequest", "description"=>"Root level tag for the CreateTrafficPolicyInstanceRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"HostedZoneId", "description"=>"The ID of the hosted zone in which you want Amazon Route 53 to create resource record sets byusing the configuration in a traffic policy", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"Name", "description"=>"The domain name (such as example", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"TrafficPolicyId", "description"=>"The ID of the traffic policy that you want to use to create resource record sets in thespecified hosted zone", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"TrafficPolicyVersion", "description"=>"The version of the traffic policy that you want to use to create resource record setsin the specified hosted zone", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"TTL", "description"=>"(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource record setsthat it creates in the specified hosted zone", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic Policies"]}}, "/2013-04-01/trafficpolicy/Id"=>{"post"=>{"summary"=>"Create Traffic Policy Version", "description"=>"Creates a new version of an existing traffic policy. When you create a new version of atraffic policy, you specify the ID of the traffic policy that you want to update and aJSON-formatted document that describes the new version. You use traffic policies to createmultiple DNS resource record sets for one domain name (such as example.com) or one subdomainname (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy.If you reach the limit and need to create another version, you'll need to start a new trafficpolicy.Send a POST request to the /2013-04-01/trafficpolicy/ resource. The request body includes a document witha CreateTrafficPolicyVersionRequest element. The response returns theCreateTrafficPolicyVersionResponse element, which contains information aboutthe new version of the traffic policy.", "operationId"=>"createtrafficpolicyversion", "x-api-path-slug"=>"20130401trafficpolicyid-post", "parameters"=>[{"in"=>"body", "name"=>"Comment", "description"=>"The comment that you specified in the CreateTrafficPolicyVersion request,if any", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"CreateTrafficPolicyVersionRequest", "description"=>"Root level tag for the CreateTrafficPolicyVersionRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"Document", "description"=>"The definition of this version of the traffic policy, in JSON format", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"Id", "description"=>"The ID of the traffic policy for which you want to create a new version", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic Policies"]}}, "/2013-04-01/hostedzone/Id/authorizevpcassociation"=>{"post"=>{"summary"=>"Create V P C Association Authorization", "description"=>"Authorizes the AWS account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request.NoteIf you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC.Send a POST request to the /2013-04-01/hostedzone/hosted zone ID/authorizevpcassociation resource. The request body must include a document with a CreateVPCAssociationAuthorizationRequest element. The response contains information about the authorization.", "operationId"=>"createvpcassociationauthorization", "x-api-path-slug"=>"20130401hostedzoneidauthorizevpcassociation-post", "parameters"=>[{"in"=>"body", "name"=>"CreateVPCAssociationAuthorizationRequest", "description"=>"Root level tag for the CreateVPCAssociationAuthorizationRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"Id", "description"=>"The ID of the private hosted zone that you want to authorize associating a VPC with", "type"=>"string"}, {"in"=>"body", "name"=>"VPC", "description"=>"A complex type that contains the VPC ID and region for the VPC that you want to authorize associating with your hosted zone", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/2013-04-01/healthcheck/HealthCheckId"=>{"delete"=>{"summary"=>"Delete Health Check", "description"=>"Deletes a health check. Send a DELETE request to the/2013-04-01/healthcheck/health check ID resource.ImportantAmazon Route 53 does not prevent you from deleting a health check even if the health check isassociated with one or more resource record sets. If you delete a health check and you don'tupdate the associated resource record sets, the future status of the health check can't bepredicted and may change. This will affect the routing of DNS queries for your DNS failoverconfiguration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide.", "operationId"=>"deletehealthcheck", "x-api-path-slug"=>"20130401healthcheckhealthcheckid-delete", "parameters"=>[{"in"=>"path", "name"=>"HealthCheckId", "description"=>"The ID of the health check that you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}, "get"=>{"summary"=>"Get Health Check", "description"=>"Gets information about a specified health check. Send a GET request to the/2013-04-01/healthcheck/health check ID resource. Formore information about using the console to perform this operation, see Amazon Route 53 Health Checks and DNS Failover in theAmazon Route 53 Developer Guide.", "operationId"=>"gethealthcheck", "x-api-path-slug"=>"20130401healthcheckhealthcheckid-get", "parameters"=>[{"in"=>"path", "name"=>"HealthCheckId", "description"=>"The identifier that Amazon Route 53 assigned to the health check when you created it", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}, "post"=>{"summary"=>"Update Health Check", "description"=>"Updates an existing health check.Send a POST request to the /2013-04-01/healthcheck/health check ID resource. Therequest body must include a document with an UpdateHealthCheckRequestelement. For more information about updating health checks, see Creating, Updating, and DeletingHealth Checks in the Amazon Route 53 Developer Guide.", "operationId"=>"updatehealthcheck", "x-api-path-slug"=>"20130401healthcheckhealthcheckid-post", "parameters"=>[{"in"=>"body", "name"=>"AlarmIdentifier", "description"=>"A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers touse to determine whether this health check is healthy", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"ChildHealthChecks", "description"=>"A complex type that contains one ChildHealthCheck element for each healthcheck that you want to associate with a CALCULATED health check", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"EnableSNI", "description"=>"Specify whether you want Amazon Route 53 to send the value ofFullyQualifiedDomainName to the endpoint in the client_hellomessage during TLS negotiation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"FailureThreshold", "description"=>"The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 tochange the current status of the endpoint from unhealthy to healthy or vice versa", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"FullyQualifiedDomainName", "description"=>"Amazon Route 53 behavior depends on whether you specify a value for IPAddress", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"HealthCheckId", "description"=>"The ID for the health check for which you want detailed information", "type"=>"string"}, {"in"=>"body", "name"=>"HealthCheckVersion", "description"=>"A sequential counter that Amazon Route 53 sets to 1 when you create a health checkand increments by 1 each time you update settings for the health check", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"HealthThreshold", "description"=>"The number of child health checks that are associated with a CALCULATEDhealth that Amazon Route 53 must consider healthy for the CALCULATED health check to beconsidered healthy", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"InsufficientDataHealthStatus", "description"=>"When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check: Healthy: Amazon Route 53 considers the health check to be healthy", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"Inverted", "description"=>"Specify whether you want Amazon Route 53 to invert the status of a health check, for example, toconsider a health check unhealthy when it otherwise would be considered healthy", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"IPAddress", "description"=>"The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"Port", "description"=>"The port on the endpoint on which you want Amazon Route 53 to perform health checks", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"Regions", "description"=>"A complex type that contains one Region element for each region from which you wantAmazon Route 53 health checkers to check the specified endpoint", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"ResourcePath", "description"=>"The path that you want Amazon Route 53 to request when performing health checks", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"SearchString", "description"=>"If the value of Type is HTTP_STR_MATCH orHTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the responsebody from the specified resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"UpdateHealthCheckRequest", "description"=>"Root level tag for the UpdateHealthCheckRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}}, "/2013-04-01/hostedzone/Id"=>{"delete"=>{"summary"=>"Delete Hosted Zone", "description"=>"Deletes a hosted zone. Send a DELETE request to the /Amazon Route 53API version/hostedzone/hosted zone ID resource.ImportantDelete a hosted zone only if there are no resource record sets other than the defaultSOA record and NS resource record sets. If the hosted zone contains other resource recordsets, delete them before deleting the hosted zone. If you try to delete a hosted zone thatcontains other resource record sets, Amazon Route 53 denies your request with aHostedZoneNotEmpty error. For information about deleting records from yourhosted zone, see ChangeResourceRecordSets.", "operationId"=>"deletehostedzone", "x-api-path-slug"=>"20130401hostedzoneid-delete", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"The ID of the hosted zone you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hosted Zones"]}, "get"=>{"summary"=>"Get Hosted Zone", "description"=>"Retrieves the delegation set for a hosted zone, including the four name serversassigned to the hosted zone. Send a GET request to the /Amazon Route 53 APIversion/hostedzone/hosted zone ID resource.", "operationId"=>"gethostedzone", "x-api-path-slug"=>"20130401hostedzoneid-get", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"The ID of the hosted zone for which you want to get a list of the name servers in thedelegation set", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hosted Zones"]}, "post"=>{"summary"=>"Update Hosted Zone Comment", "description"=>"Updates the hosted zone comment. Send a POST request to the/2013-04-01/hostedzone/hosted zone ID resource.", "operationId"=>"updatehostedzonecomment", "x-api-path-slug"=>"20130401hostedzoneid-post", "parameters"=>[{"in"=>"body", "name"=>"Comment", "description"=>"The new comment for the hosted zone", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"Id", "description"=>"The ID for the hosted zone for which you want to update the comment", "type"=>"string"}, {"in"=>"body", "name"=>"UpdateHostedZoneCommentRequest", "description"=>"Root level tag for the UpdateHostedZoneCommentRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hosted Zones"]}}, "/2013-04-01/delegationset/Id"=>{"delete"=>{"summary"=>"Delete Reusable Delegation Set", "description"=>"Deletes a reusable delegation set. Send a DELETE request to the/2013-04-01/delegationset/delegation set ID resource.Important You can delete a reusable delegation set only if there are no associated hostedzones.To verify that the reusable delegation set is not associated with any hosted zones, runthe GetReusableDelegationSet action and specify the ID of the reusabledelegation set that you want to delete.", "operationId"=>"deletereusabledelegationset", "x-api-path-slug"=>"20130401delegationsetid-delete", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"The ID of the reusable delegation set you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reusable Delegation Sets"]}, "get"=>{"summary"=>"Get Reusable Delegation Set", "description"=>"Retrieves the reusable delegation set. Send a GET request to the/2013-04-01/delegationset/delegation set ID resource.", "operationId"=>"getreusabledelegationset", "x-api-path-slug"=>"20130401delegationsetid-get", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"The ID of the reusable delegation set for which you want to get a list of the nameserver", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reusable Delegation Sets"]}}, "/2013-04-01/trafficpolicy/Id/Version"=>{"delete"=>{"summary"=>"Delete Traffic Policy", "description"=>"Deletes a traffic policy.Send a DELETE request to the /Amazon Route 53 APIversion/trafficpolicy resource.", "operationId"=>"deletetrafficpolicy", "x-api-path-slug"=>"20130401trafficpolicyidversion-delete", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"The ID of the traffic policy that you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic Policies"]}, "get"=>{"summary"=>"Get Traffic Policy", "description"=>"Gets information about a specific traffic policy version.Send a GET request to the /Amazon Route 53 APIversion/trafficpolicy resource.", "operationId"=>"gettrafficpolicy", "x-api-path-slug"=>"20130401trafficpolicyidversion-get", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"The ID of the traffic policy that you want to get information about", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic Policies"]}, "post"=>{"summary"=>"Update Traffic Policy Comment", "description"=>"Updates the comment for a specified traffic policy version.Send a POST request to the /2013-04-01/trafficpolicy/ resource.The request body must include a document with anUpdateTrafficPolicyCommentRequest element.", "operationId"=>"updatetrafficpolicycomment", "x-api-path-slug"=>"20130401trafficpolicyidversion-post", "parameters"=>[{"in"=>"body", "name"=>"Comment", "description"=>"The new comment for the specified traffic policy and version", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"Id", "description"=>"The value of Id for the traffic policy for which you want to update thecomment", "type"=>"string"}, {"in"=>"body", "name"=>"UpdateTrafficPolicyCommentRequest", "description"=>"Root level tag for the UpdateTrafficPolicyCommentRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic Policies"]}}, "/2013-04-01/trafficpolicyinstance/Id"=>{"delete"=>{"summary"=>"Delete Traffic Policy Instance", "description"=>"Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53created when you created the instance.Send a DELETE request to the /Amazon Route 53 APIversion/trafficpolicy/traffic policy instance ID resource.NoteIn the Amazon Route 53 console, traffic policy instances are known as policy records.", "operationId"=>"deletetrafficpolicyinstance", "x-api-path-slug"=>"20130401trafficpolicyinstanceid-delete", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"The ID of the traffic policy instance that you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic Policies"]}, "get"=>{"summary"=>"Get Traffic Policy Instance", "description"=>"Gets information about a specified traffic policy instance.Send a GET request to the /Amazon Route 53 APIversion/trafficpolicyinstance resource.NoteAfter you submit a CreateTrafficPolicyInstance or anUpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53creates the resource record sets that are specified in the traffic policy definition. Formore information, see the State response element.NoteIn the Amazon Route 53 console, traffic policy instances are known as policy records.", "operationId"=>"gettrafficpolicyinstance", "x-api-path-slug"=>"20130401trafficpolicyinstanceid-get", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"The ID of the traffic policy instance that you want to get information about", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic Policies"]}, "post"=>{"summary"=>"Update Traffic Policy Instance", "description"=>"Updates the resource record sets in a specified hosted zone that were created based onthe settings in a specified traffic policy version.Send a POST request to the /2013-04-01/trafficpolicyinstance/traffic policy ID resource. The request body must include a document with anUpdateTrafficPolicyInstanceRequest element.When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queriesfor the root resource record set name (such as example.com) while it replaces one group ofresource record sets with another. Amazon Route 53 performs the following operations:Amazon Route 53 creates a new group of resource record sets based on the specified trafficpolicy. This is true regardless of how substantial the differences are between theexisting resource record sets and the new resource record sets. When all of the new resource record sets have been created, Amazon Route 53 starts to respondto DNS queries for the root resource record set name (such as example.com) by using thenew resource record sets.Amazon Route 53 deletes the old group of resource record sets that are associated with theroot resource record set name.", "operationId"=>"updatetrafficpolicyinstance", "x-api-path-slug"=>"20130401trafficpolicyinstanceid-post", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"The ID of the traffic policy instance that you want to update", "type"=>"string"}, {"in"=>"body", "name"=>"TrafficPolicyId", "description"=>"The ID of the traffic policy that you want Amazon Route 53 to use to update resource record setsfor the specified traffic policy instance", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"TrafficPolicyVersion", "description"=>"The version of the traffic policy that you want Amazon Route 53 to use to update resource recordsets for the specified traffic policy instance", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"TTL", "description"=>"The TTL that you want Amazon Route 53 to assign to all of the updated resource recordsets", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"UpdateTrafficPolicyInstanceRequest", "description"=>"Root level tag for the UpdateTrafficPolicyInstanceRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic Policies"]}}, "/2013-04-01/hostedzone/Id/deauthorizevpcassociation"=>{"post"=>{"summary"=>"Delete V P C Association Authorization", "description"=>"Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a DeleteVPCAssociationAuthorization request.ImportantSending this request only prevents the AWS account that created the VPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone, DeleteVPCAssociationAuthorization won't disassociate the VPC from the hosted zone. If you want to delete an existing association, use DisassociateVPCFromHostedZone.Send a DELETE request to the /2013-04-01/hostedzone/hosted zone ID/deauthorizevpcassociation resource. The request body must include a document with a DeleteVPCAssociationAuthorizationRequest element.", "operationId"=>"deletevpcassociationauthorization", "x-api-path-slug"=>"20130401hostedzoneiddeauthorizevpcassociation-post", "parameters"=>[{"in"=>"body", "name"=>"DeleteVPCAssociationAuthorizationRequest", "description"=>"Root level tag for the DeleteVPCAssociationAuthorizationRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"Id", "description"=>"When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, the ID of the hosted zone", "type"=>"string"}, {"in"=>"body", "name"=>"VPC", "description"=>"When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, a complex type that includes the ID and region of the VPC", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/2013-04-01/hostedzone/Id/disassociatevpc"=>{"post"=>{"summary"=>"Disassociate V P C From Hosted Zone", "description"=>"Disassociates a VPC from a Amazon Route 53 private hosted zone. NoteYou can't disassociate the last VPC from a private hosted zone.Send a POST request to the /2013-04-01/hostedzone/hosted zone ID/disassociatevpcresource. The request body must include a document with a DisassociateVPCFromHostedZoneRequest element. The response includes a DisassociateVPCFromHostedZoneResponse element.ImportantYou can't disassociate a VPC from a private hosted zone when only one VPC is associated with the hosted zone. You also can't convert a private hosted zone into a public hosted zone.", "operationId"=>"disassociatevpcfromhostedzone", "x-api-path-slug"=>"20130401hostedzoneiddisassociatevpc-post", "parameters"=>[{"in"=>"body", "name"=>"Comment", "description"=>"Optional: A comment about the disassociation request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"DisassociateVPCFromHostedZoneRequest", "description"=>"Root level tag for the DisassociateVPCFromHostedZoneRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"Id", "description"=>"The ID of the private hosted zone that you want to disassociate a VPC from", "type"=>"string"}, {"in"=>"body", "name"=>"VPC", "description"=>"A complex type that contains information about the VPC that youre disassociatingfrom the specified hosted zone", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/2013-04-01/change/Id"=>{"get"=>{"summary"=>"Get Change", "description"=>"Returns the current status of a change batch request. The status is one of thefollowing values: PENDING indicates that the changes in this request have not replicatedto all Amazon Route 53 DNS servers. This is the initial status of all change batchrequests. INSYNC indicates that the changes have replicated to all Amazon Route 53 DNSservers.", "operationId"=>"getchange", "x-api-path-slug"=>"20130401changeid-get", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"The ID of the change batch request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Changes"]}}, "/2013-04-01/checkeripranges"=>{"get"=>{"summary"=>"Get Checker Ip Ranges", "description"=>"GetCheckerIpRanges still works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all AWS services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide.", "operationId"=>"getcheckeripranges", "x-api-path-slug"=>"20130401checkeripranges-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IP Ranges"]}}, "/2013-04-01/geolocation?continentcode=ContinentCode&countrycode=CountryCode&subdivisioncode=SubdivisionCode"=>{"get"=>{"summary"=>"Get Geo Location", "description"=>"Retrieves a single geo location. Send a GET request to the/2013-04-01/geolocation resource with one of these options: continentcode |countrycode | countrycode and subdivisioncode.", "operationId"=>"getgeolocation", "x-api-path-slug"=>"20130401geolocationcontinentcodecontinentcodeampcountrycodecountrycodeampsubdivisioncodesubdivisioncode-get", "parameters"=>[{"in"=>"path", "name"=>"continentcode", "description"=>"Amazon Route 53 supports the following continent codes: AF: Africa AN: Antarctica AS: Asia EU: Europe OC: Oceania NA: North America SA: South AmericaLength Constraints: Fixed length of 2", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Locations"]}}, "/2013-04-01/healthcheckcount"=>{"get"=>{"summary"=>"Get Health Check Count", "description"=>"To retrieve a count of all your health checks, send a GET request to the/2013-04-01/healthcheckcount resource.", "operationId"=>"gethealthcheckcount", "x-api-path-slug"=>"20130401healthcheckcount-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}}, "/2013-04-01/healthcheck/HealthCheckId/lastfailurereason"=>{"get"=>{"summary"=>"Get Health Check Last Failure Reason", "description"=>"If you want to learn why a health check is currently failing or why it failed mostrecently (if at all), you can get the failure reason for the most recent failure. Send aGET request to the /Amazon Route 53 APIversion/healthcheck/health checkID/lastfailurereason resource.", "operationId"=>"gethealthchecklastfailurereason", "x-api-path-slug"=>"20130401healthcheckhealthcheckidlastfailurereason-get", "parameters"=>[{"in"=>"path", "name"=>"HealthCheckId", "description"=>"The ID for the health check for which you want the last failure reason", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}}, "/2013-04-01/healthcheck/HealthCheckId/status"=>{"get"=>{"summary"=>"Get Health Check Status", "description"=>"Gets status of a specified health check. Send a GET request to the/2013-04-01/healthcheck/health check ID/status resource.You can use this call to get a health check's current status.", "operationId"=>"gethealthcheckstatus", "x-api-path-slug"=>"20130401healthcheckhealthcheckidstatus-get", "parameters"=>[{"in"=>"path", "name"=>"HealthCheckId", "description"=>"If you want Amazon Route 53 to return this resource record set in response to a DNS query onlywhen a health check is passing, include the HealthCheckId element and specify theID of the applicable health check", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}}, "/2013-04-01/hostedzonecount"=>{"get"=>{"summary"=>"Get Hosted Zone Count", "description"=>"Retrieves a count of all your hosted zones. Send a GET request to the/2013-04-01/hostedzonecount resource.", "operationId"=>"gethostedzonecount", "x-api-path-slug"=>"20130401hostedzonecount-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hosted Zones"]}}, "/2013-04-01/trafficpolicyinstancecount"=>{"get"=>{"summary"=>"Get Traffic Policy Instance Count", "description"=>"Gets the number of traffic policy instances that are associated with the current AWSaccount.To get the number of traffic policy instances, send a GET request to the/2013-04-01/trafficpolicyinstancecount resource.", "operationId"=>"gettrafficpolicyinstancecount", "x-api-path-slug"=>"20130401trafficpolicyinstancecount-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic Policies"]}}, "/2013-04-01/geolocations&maxitems=MaxItems?startcontinentcode=StartContinentCode&startcountrycode=StartCountryCode&startsubdivisioncode=StartSubdivisionCode"=>{"get"=>{"summary"=>"List Geo Locations", "description"=>"Retrieves a list of supported geo locations. Send a GET request to the/2013-04-01/geolocations resource. The response to this request includes aGeoLocationDetailsList element for each location that Amazon Route 53 supports.Countries are listed first, and continents are listed last. If Amazon Route 53 supportssubdivisions for a country (for example, states or provinces), the subdivisions for thatcountry are listed in alphabetical order immediately after the corresponding country.", "operationId"=>"listgeolocations", "x-api-path-slug"=>"20130401geolocationsampmaxitemsmaxitemsstartcontinentcodestartcontinentcodeampstartcountrycodestartcountrycodeampstartsubdivisioncodestartsubdivisioncode-get", "parameters"=>[{"in"=>"path", "name"=>"maxitems", "description"=>"(Optional) The maximum number of geolocations to be included in the response body forthis request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Locations"]}}, "/2013-04-01/healthcheck?marker=Marker&maxitems=MaxItems"=>{"get"=>{"summary"=>"List Health Checks", "description"=>"Retrieve a list of your health checks. Send a GET request to the/2013-04-01/healthcheck resource. The response to this request includes aHealthChecks element with zero or more HealthCheck child elements.By default, the list of health checks is displayed on a single page. You can control thelength of the page that is displayed by using the MaxItems parameter. You can usethe Marker parameter to control the health check that the list beginswith.For information about listing health checks using the Amazon Route 53 console, see Amazon Route 53 Health Checks and DNS Failover.", "operationId"=>"listhealthchecks", "x-api-path-slug"=>"20130401healthcheckmarkermarkerampmaxitemsmaxitems-get", "parameters"=>[{"in"=>"path", "name"=>"marker", "description"=>"If the response to a ListHealthChecks is more than one page, marker is thehealth check ID for the first health check on the next page of results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}}, "/2013-04-01/hostedzone&delegationsetid=DelegationSetId?marker=Marker&maxitems=MaxItems"=>{"get"=>{"summary"=>"List Hosted Zones", "description"=>"To retrieve a list of your public and private hosted zones, send a GETrequest to the /2013-04-01/hostedzone resource. The response to this requestincludes a HostedZones child element for each hosted zone created by the currentAWS account.Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hostedzones, you can use the maxitems parameter to list them in groups of up to 100.The response includes four values that help navigate from one group of maxitemshosted zones to the next: MaxItems is the value specified for the maxitems parameterin the request that produced the current response.If the value of IsTruncated in the response is true, there are morehosted zones associated with the current AWS account. NextMarker is the hosted zone ID of the next hosted zone that isassociated with the current AWS account. If you want to list more hosted zones, makeanother call to ListHostedZones, and specify the value of theNextMarker element in the marker parameter. If IsTruncated is false, the NextMarker element isomitted from the response.If you're making the second or subsequent call to ListHostedZones, theMarker element matches the value that you specified in themarker parameter in the previous request.", "operationId"=>"listhostedzones", "x-api-path-slug"=>"20130401hostedzoneampdelegationsetiddelegationsetidmarkermarkerampmaxitemsmaxitems-get", "parameters"=>[{"in"=>"path", "name"=>"delegationsetid", "description"=>"If youre using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hosted Zones"]}}, "/2013-04-01/hostedzonesbyname?dnsname=DNSName&hostedzoneid=HostedZoneId&maxitems=MaxItems"=>{"get"=>{"summary"=>"List Hosted Zones By Name", "description"=>"Retrieves a list of your hosted zones in lexicographic order. Send a GETrequest to the /2013-04-01/hostedzonesbyname resource. The response includes aHostedZones child element for each hosted zone created by the current AWSaccount. ListHostedZonesByName sorts hosted zones by name with the labels reversed.For example: com.example.www. Note the trailing dot, which can change the sort order in some circumstances.If the domain name includes escape characters or Punycode,ListHostedZonesByName alphabetizes the domain name using the escaped orPunycoded value, which is the format that Amazon Route 53 saves in its database. For example, to createa hosted zone for example.com, specify ex\\344mple.com for the domain name.ListHostedZonesByName alphabetizes it as: com.ex\\344mple. The labels are reversed and alphabetized using the escaped value. For more informationabout valid domain name formats, including internationalized domain names, see DNS Domain Name Format in theAmazon Route 53 Developer Guide.Amazon Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, usethe MaxItems parameter to list them in groups of up to 100. The response includesvalues that help navigate from one group of MaxItems hosted zones to thenext:The DNSName and HostedZoneId elements in the responsecontain the values, if any, specified for the dnsname andhostedzoneid parameters in the request that produced the currentresponse.The MaxItems element in the response contains the value, if any, thatyou specified for the maxitems parameter in the request that produced thecurrent response.If the value of IsTruncated in the response is true, there are morehosted zones associated with the current AWS account. If IsTruncated is false, this response includes the last hosted zonethat is associated with the current account. The NextDNSName element andNextHostedZoneId elements are omitted from the response.The NextDNSName and NextHostedZoneId elements in theresponse contain the domain name and the hosted zone ID of the next hosted zone that isassociated with the current AWS account. If you want to list more hosted zones, makeanother call to ListHostedZonesByName, and specify the value ofNextDNSName and NextHostedZoneId in the dnsnameand hostedzoneid parameters, respectively.", "operationId"=>"listhostedzonesbyname", "x-api-path-slug"=>"20130401hostedzonesbynamednsnamednsnameamphostedzoneidhostedzoneidampmaxitemsmaxitems-get", "parameters"=>[{"in"=>"path", "name"=>"dnsname", "description"=>"(Optional) For your first request to ListHostedZonesByName, include thednsname parameter only if you want to specify the name of the first hosted zonein the response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hosted Zones"]}}, "/2013-04-01/hostedzone/Id/rrset&identifier=StartRecordIdentifier&maxitems=MaxItems?name=StartRecordName&type=StartRecordType"=>{"get"=>{"summary"=>"List Resource Record Sets", "description"=>"Lists the resource record sets in a specified hosted zone. ListResourceRecordSets returns up to 100 resource record sets at a time in ASCII order, beginning at a position specified by the name and type elements. The action sorts results first by DNS name with the labels reversed, for example: com.example.www. Note the trailing dot, which can change the sort order in some circumstances.When multiple records have the same DNS name, the action sorts results by the record type.You can use the name and type elements to adjust the beginning position of the list of resource record sets returned:If you do not specify Name or TypeThe results begin with the first resource record set that the hosted zone contains.If you specify Name but not TypeThe results begin with the first resource record set in the list whose name is greater than or equal to Name.If you specify Type but not NameAmazon Route 53 returns the InvalidInput error.If you specify both Name and TypeThe results begin with the first resource record set in the list whose name is greater than or equal to Name, and whose type is greater than or equal to Type.This action returns the most current version of the records. This includes records that are PENDING, and that are not yet available on all Amazon Route 53 DNS servers.To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a ChangeResourceRecordSets request while you're paging through the results of a ListResourceRecordSets request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes.", "operationId"=>"listresourcerecordsets", "x-api-path-slug"=>"20130401hostedzoneidrrsetampidentifierstartrecordidentifierampmaxitemsmaxitemsnamestartrecordnameamptypestartrecordtype-get", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"The ID of the hosted zone that contains the resource record sets that you want toget", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Record Sets"]}}, "/2013-04-01/delegationset?marker=Marker&maxitems=MaxItems"=>{"get"=>{"summary"=>"List Reusable Delegation Sets", "description"=>"To retrieve a list of your reusable delegation sets, send a GET request tothe /2013-04-01/delegationset resource. The response to this request includes aDelegationSets element with zero, one, or multiple DelegationSetchild elements. By default, the list of delegation sets is displayed on a single page. You cancontrol the length of the page that is displayed by using the MaxItems parameter.You can use the Marker parameter to control the delegation set that the listbegins with. Note Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than100, Amazon Route 53 returns only the first 100.", "operationId"=>"listreusabledelegationsets", "x-api-path-slug"=>"20130401delegationsetmarkermarkerampmaxitemsmaxitems-get", "parameters"=>[{"in"=>"path", "name"=>"marker", "description"=>"If youre making the second or subsequent call toListReusableDelegationSets, the Marker element matches the valuethat you specified in the marker parameter in the previous request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reusable Delegation Sets"]}}, "/2013-04-01/tags/ResourceType"=>{"post"=>{"summary"=>"List Tags For Resources", "description"=>"Lists tags for up to 10 health checks or hosted zones.For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.", "operationId"=>"listtagsforresources", "x-api-path-slug"=>"20130401tagsresourcetype-post", "parameters"=>[{"in"=>"body", "name"=>"ListTagsForResourcesRequest", "description"=>"Root level tag for the ListTagsForResourcesRequest parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"body", "name"=>"ResourceIds", "description"=>"A complex type that contains the ResourceId element for each resource for which youwant to get a list of tags", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"ResourceType", "description"=>"The type of the resources", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/2013-04-01/trafficpolicies&maxitems=MaxItems?trafficpolicyid=TrafficPolicyIdMarker"=>{"get"=>{"summary"=>"List Traffic Policies", "description"=>"Gets information about the latest version for every traffic policy that is associatedwith the current AWS account. Send a GET request to the /Amazon Route 53API version/trafficpolicy resource.Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of trafficpolicies, you can use the maxitems parameter to list them in groups of up to100.The response includes three values that help you navigate from one group ofmaxitems traffic policies to the next: IsTruncated If the value of IsTruncated in the response is true,there are more traffic policies associated with the current AWS account.If IsTruncated is false, this response includes the lasttraffic policy that is associated with the current account. TrafficPolicyIdMarker If IsTruncated is true,TrafficPolicyIdMarker is the ID of the first traffic policy in the nextgroup of MaxItems traffic policies. If you want to list more trafficpolicies, make another call to ListTrafficPolicies, and specify the value ofthe TrafficPolicyIdMarker element from the response in theTrafficPolicyIdMarker request parameter.If IsTruncated is false, theTrafficPolicyIdMarker element is omitted from the response. MaxItems The value that you specified for the MaxItems parameter in the requestthat produced the current response.", "operationId"=>"listtrafficpolicies", "x-api-path-slug"=>"20130401trafficpoliciesampmaxitemsmaxitemstrafficpolicyidtrafficpolicyidmarker-get", "parameters"=>[{"in"=>"path", "name"=>"maxitems", "description"=>"(Optional) The maximum number of traffic policies to be included in the response bodyfor this request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic Policies"]}}, "/2013-04-01/trafficpolicyinstances?hostedzoneid=HostedZoneIdMarker&maxitems=MaxItems&trafficpolicyinstancename=TrafficPolicyInstanceNameMarker&trafficpolicyinstancetype=TrafficPolicyInstanceTypeMarker"=>{"get"=>{"summary"=>"List Traffic Policy Instances", "description"=>"Gets information about the traffic policy instances that you created by using thecurrent AWS account.NoteAfter you submit an UpdateTrafficPolicyInstance request, there's a briefdelay while Amazon Route 53 creates the resource record sets that are specified in the traffic policydefinition. For more information, see the State response element.Send a GET request to the /Amazon Route 53 APIversion/trafficpolicyinstance resource.Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of trafficpolicy instances, you can use the MaxItems parameter to list them in groups of upto 100.The response includes five values that help you navigate from one group ofMaxItems traffic policy instances to the next: IsTruncated If the value of IsTruncated in the response is true,there are more traffic policy instances associated with the current AWSaccount.If IsTruncated is false, this response includes the lasttraffic policy instance that is associated with the current account. MaxItems The value that you specified for the MaxItems parameter in the requestthat produced the current response. HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker If IsTruncated is true, these three values in theresponse represent the first traffic policy instance in the next group ofMaxItems traffic policy instances. To list more traffic policy instances,make another call to ListTrafficPolicyInstances, and specify these values inthe corresponding request parameters.If IsTruncated is false, all three elements are omittedfrom the response.", "operationId"=>"listtrafficpolicyinstances", "x-api-path-slug"=>"20130401trafficpolicyinstanceshostedzoneidhostedzoneidmarkerampmaxitemsmaxitemsamptrafficpolicyinstancenametrafficpolicyinstancenamemarkeramptrafficpolicyinstancetypetrafficpolicyinstancetypemarker-get", "parameters"=>[{"in"=>"path", "name"=>"hostedzoneid", "description"=>"For the first request to ListTrafficPolicyInstances, omit thisvalue", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic Policies"]}}, "/2013-04-01/trafficpolicyinstances/hostedzone?id=HostedZoneId&maxitems=MaxItems&trafficpolicyinstancename=TrafficPolicyInstanceNameMarker&trafficpolicyinstancetype=TrafficPolicyInstanceTypeMarker"=>{"get"=>{"summary"=>"List Traffic Policy Instances By Hosted Zone", "description"=>"Gets information about the traffic policy instances that you created in a specifiedhosted zone.NoteAfter you submit an UpdateTrafficPolicyInstance request, there's a briefdelay while Amazon Route 53 creates the resource record sets that are specified in the traffic policydefinition. For more information, see the State response element.Send a GET request to the /Amazon Route 53 APIversion/trafficpolicyinstance resource and include the ID of the hostedzone.Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of trafficpolicy instances, you can use the MaxItems parameter to list them in groups of upto 100.The response includes four values that help you navigate from one group ofMaxItems traffic policy instances to the next: IsTruncated If the value of IsTruncated in the response is true, there aremore traffic policy instances associated with the current AWS account.If IsTruncated is false, this response includes the lasttraffic policy instance that is associated with the current account. MaxItems The value that you specified for the MaxItems parameter in the requestthat produced the current response. TrafficPolicyInstanceNameMarker and TrafficPolicyInstanceTypeMarker If IsTruncated is true, these two values in the responserepresent the first traffic policy instance in the next group of MaxItemstraffic policy instances. To list more traffic policy instances, make another call toListTrafficPolicyInstancesByHostedZone, and specify these values in thecorresponding request parameters.If IsTruncated is false, all three elements are omittedfrom the response.", "operationId"=>"listtrafficpolicyinstancesbyhostedzone", "x-api-path-slug"=>"20130401trafficpolicyinstanceshostedzoneidhostedzoneidampmaxitemsmaxitemsamptrafficpolicyinstancenametrafficpolicyinstancenamemarkeramptrafficpolicyinstancetypetrafficpolicyinstancetypemarker-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the hosted zone for which you want to list traffic policyinstances", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic Policies"]}}, "/2013-04-01/trafficpolicies/Id/versions&maxitems=MaxItems?trafficpolicyversion=TrafficPolicyVersionMarker"=>{"get"=>{"summary"=>"List Traffic Policy Versions", "description"=>"Gets information about all of the versions for a specified traffic policy.Send a GET request to the /Amazon Route 53 APIversion/trafficpolicy resource and specify the ID of the traffic policyfor which you want to list versions.Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of trafficpolicies, you can use the maxitems parameter to list them in groups of up to100.The response includes three values that help you navigate from one group ofmaxitems traffic policies to the next: IsTruncated If the value of IsTruncated in the response is true,there are more traffic policy versions associated with the specified trafficpolicy.If IsTruncated is false, this response includes the lasttraffic policy version that is associated with the specified traffic policy. TrafficPolicyVersionMarker The ID of the next traffic policy version that is associated with the current AWSaccount. If you want to list more traffic policies, make another call toListTrafficPolicyVersions, and specify the value of theTrafficPolicyVersionMarker element in theTrafficPolicyVersionMarker request parameter.If IsTruncated is false, Amazon Route 53 omits theTrafficPolicyVersionMarker element from the response. MaxItems The value that you specified for the MaxItems parameter in the requestthat produced the current response.", "operationId"=>"listtrafficpolicyversions", "x-api-path-slug"=>"20130401trafficpoliciesidversionsampmaxitemsmaxitemstrafficpolicyversiontrafficpolicyversionmarker-get", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"Specify the value of Id of the traffic policy for which you want to listall versions", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic Policies"]}}, "/2013-04-01/hostedzone/Id/authorizevpcassociation&maxresults=MaxResults?nexttoken=NextToken"=>{"get"=>{"summary"=>"List V P C Association Authorizations", "description"=>"Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more CreateVPCAssociationAuthorization requests. Send a GET request to the /2013-04-01/hostedzone/hosted zone ID/authorizevpcassociation resource. The response to this request includes a VPCs element with a VPC child element for each VPC that can be associated with the hosted zone.Amazon Route 53 returns up to 50 VPCs per page. To return fewer VPCs per page, include the MaxResults parameter: /2013-04-01/hostedzone/hosted zone ID/authorizevpcassociation?MaxItems=VPCs per page If the response includes a NextToken element, there are more VPCs to list. To get the next page of VPCs, submit another ListVPCAssociationAuthorizations request, and include the value of the NextToken element from the response in the NextToken request parameter: /2013-04-01/hostedzone/hosted zone ID/authorizevpcassociation?MaxItems=VPCs per page&NextToken=", "operationId"=>"listvpcassociationauthorizations", "x-api-path-slug"=>"20130401hostedzoneidauthorizevpcassociationampmaxresultsmaxresultsnexttokennexttoken-get", "parameters"=>[{"in"=>"path", "name"=>"Id", "description"=>"The ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPC"]}}, "/2013-04-01/testdnsanswer&edns0clientsubnetip=EDNS0ClientSubnetIP&edns0clientsubnetmask=EDNS0ClientSubnetMask?hostedzoneid=HostedZoneId&recordname=RecordName&recordtype=RecordType&resolverip=ResolverIP"=>{"get"=>{"summary"=>"Test D N S Answer", "description"=>"Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.", "operationId"=>"testdnsanswer", "x-api-path-slug"=>"20130401testdnsanswerampedns0clientsubnetipedns0clientsubnetipampedns0clientsubnetmaskedns0clientsubnetmaskhostedzoneidhostedzoneidamprecordnamerecordnameamprecordtyperecordtypeampresolveripresolverip-get", "parameters"=>[{"in"=>"path", "name"=>"edns0clientsubnetip", "description"=>"If the resolver that you specified for resolverip supports EDNS0, specify the IP address of a client in the applicable location", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["DNS"]}}, "/2013-04-01/trafficpolicyinstances/trafficpolicy&hostedzoneid=HostedZoneIdMarker?id=TrafficPolicyId&maxitems=MaxItems&trafficpolicyinstancename=TrafficPolicyInstanceNameMarker&trafficpolicyinstancetype=TrafficPolicyInstanceTypeMarker&"=>{"get"=>{"summary"=>"List Traffic Policy Instances By Policy", "description"=>"Gets information about the traffic policy instances that you created by using a specifytraffic policy version.NoteAfter you submit a CreateTrafficPolicyInstance or anUpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53creates the resource record sets that are specified in the traffic policy definition. Formore information, see the State response element.Send a GET request to the /Route 53 APIversion/trafficpolicyinstance resource and include the ID and version ofthe traffic policy.Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of trafficpolicy instances, you can use the MaxItems parameter to list them in groups of upto 100.The response includes five values that help you navigate from one group ofMaxItems traffic policy instances to the next: IsTruncated If the value of IsTruncated in the response is true,there are more traffic policy instances associated with the specified trafficpolicy.If IsTruncated is false, this response includes the lasttraffic policy instance that is associated with the specified traffic policy. MaxItems The value that you specified for the MaxItems parameter in the requestthat produced the current response. HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker If IsTruncated is true, these values in the responserepresent the first traffic policy instance in the next group of MaxItemstraffic policy instances. To list more traffic policy instances, make another call toListTrafficPolicyInstancesByPolicy, and specify these values in thecorresponding request parameters.If IsTruncated is false, all three elements are omittedfrom the response.", "operationId"=>"listtrafficpolicyinstancesbypolicy", "x-api-path-slug"=>"20130401trafficpolicyinstancestrafficpolicyamphostedzoneidhostedzoneidmarkeridtrafficpolicyidampmaxitemsmaxitemsamptrafficpolicyinstancenametrafficpolicyinstancenamemarkeramptrafficpolicyinstancetypetrafficpolicyinstancetypemarker-get", "parameters"=>[{"in"=>"query", "name"=>"CapacityId", "description"=>"The ID that identifies the provisioned capacity unit", "type"=>"string"}, {"in"=>"query", "name"=>"ExpirationDate", "description"=>"The date that the provisioned capacity unit expires, in Coordinated Universal Time (UTC)", "type"=>"string"}, {"in"=>"path", "name"=>"hostedzoneid", "description"=>"For the first request to ListTrafficPolicyInstancesByPolicy, omit thisvalue", "type"=>"string"}, {"in"=>"query", "name"=>"StartDate", "description"=>"The date that the provisioned capacity unit was purchased, in Coordinated Universal Time (UTC)", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys", "description"=>"A list of tag keys", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"The tags attached to the vault", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Traffic Policies"]}}}}, "apis"=>{"name"=>"AWS Route 53", "x-slug"=>"aws-route-53", "description"=>"Amazon Route 53 is a highly available and scalable cloud Domain Name System (DNS) web service. It is designed to give developers and businesses an extremely reliable and cost effective way to route end users to Internet applications by translating names like www.example.com into the numeric IP addresses like 192.0.2.1 that computers use to connect to each other. Amazon Route 53 is fully compliant with IPv6 as well.Amazon Route 53 effectively connects user requests to infrastructure running in AWS – such as Amazon EC2 instances, Elastic Load Balancing load balancers, or Amazon S3 buckets – and can also be used to route users to infrastructure outside of AWS. You can use Amazon Route 53 to configure DNS health checks to route traffic to healthy endpoints or to independently monitor the health of your application and its endpoints. Amazon Route 53 Traffic Flow makes it easy for you to manage traffic globally through a variety of routing types, including Latency Based Routing, Geo DNS, and Weighted Round Robin—all of which can be combined with DNS Failover in order to enable a variety of low-latency, fault-tolerant architectures. Using Amazon Route 53 Traffic Flow’s simple visual editor, you can easily manage how your end-users are routed to your application’s endpoints—whether in a single AWS region or distributed around the globe. Amazon Route 53 also offers Domain Name Registration – you can purchase and manage domain names such as example.com and Amazon Route 53 will automatically configure DNS settings for your domains.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Networking_AmazonRoute53.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,DNS,Profiles,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-route-53/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Route 53 API", "x-api-slug"=>"aws-route-53-api", "description"=>"Amazon Route 53 is a highly available and scalable cloud Domain Name System (DNS) web service. It is designed to give developers and businesses an extremely reliable and cost effective way to route end users to Internet applications by translating names like www.example.com into the numeric IP addresses like 192.0.2.1 that computers use to connect to each other. Amazon Route 53 is fully compliant with IPv6 as well.Amazon Route 53 effectively connects user requests to infrastructure running in AWS – such as Amazon EC2 instances, Elastic Load Balancing load balancers, or Amazon S3 buckets – and can also be used to route users to infrastructure outside of AWS. You can use Amazon Route 53 to configure DNS health checks to route traffic to healthy endpoints or to independently monitor the health of your application and its endpoints. Amazon Route 53 Traffic Flow makes it easy for you to manage traffic globally through a variety of routing types, including Latency Based Routing, Geo DNS, and Weighted Round Robin—all of which can be combined with DNS Failover in order to enable a variety of low-latency, fault-tolerant architectures. Using Amazon Route 53 Traffic Flow’s simple visual editor, you can easily manage how your end-users are routed to your application’s endpoints—whether in a single AWS region or distributed around the globe. Amazon Route 53 also offers Domain Name Registration – you can purchase and manage domain names such as example.com and Amazon Route 53 will automatically configure DNS settings for your domains.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Networking_AmazonRoute53.png", "humanURL"=>"https://aws.amazon.com/route53/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,DNS,Profiles,Relative Data,Service API", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-route-53/aws-route-53-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/Route53/latest/APIReference/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/route53/faqs/"}, {"type"=>"x-forum", "url"=>"https://forums.aws.amazon.com/forum.jspa?forumID=87"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/route53/pricing/"}, {"type"=>"x-registrar-policies", "url"=>"https://aws.amazon.com/route53/amazon-registrar-policies/"}, {"type"=>"x-service-health", "url"=>"http://status.aws.amazon.com/"}, {"type"=>"x-service-level-agreement", "url"=>"https://aws.amazon.com/route53/sla"}, {"type"=>"x-sla", "url"=>"https://aws.amazon.com/route53/sla/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/route53/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
us-digital-registry{"u-s--digital-registry-agency-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"US Digital Registry", "x-complete"=>1, "info"=>{"title"=>"U.S. Digital Registry Agency API", "description"=>"provides-access-to-a-list-of-federal-agencies-", "version"=>"1.0"}, "host"=>"usdigitalregistry.digitalgov.gov", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/agencies.json"=>{"get"=>{"summary"=>"Agencies", "description"=>"This lists all active agencies in the system. These agencies can be used to query for social media accounts, mobile products, and galleries.", "operationId"=>"Api::V1::Agencies#index", "x-api-path-slug"=>"agencies-json-get", "parameters"=>[{"in"=>"query", "name"=>"no_accounts", "description"=>"Including this parameter with value true will cause the endpoint to include agencies that have no account in the system", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"page", "description"=>"Page number"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of results per page"}, {"in"=>"query", "name"=>"q", "description"=>"String to compare to the name & acronym of the agencies"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agencies"]}}, "/agencies/{id}.json"=>{"get"=>{"summary"=>"Agency", "description"=>"This returns an agency based on an ID.", "operationId"=>"Api::V1::Agencies#show", "x-api-path-slug"=>"agenciesid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the agency"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Agencies"]}}}}, "u-s--digital-registry-mobile-app-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"US Digital Registry", "x-complete"=>1, "info"=>{"title"=>"U.S. Digital Registry Mobile App API", "description"=>"providing-access-to-a-directory-of-the-mobile-applications-for-federal-agencies-", "version"=>"1.0.0"}, "host"=>"usdigitalregistry.digitalgov.gov", "basePath"=>"/api/v1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/mobile_apps/tokeninput.json"=>{"get"=>{"summary"=>"Mobile App Token", "description"=>"This returns tokens representing agencies, tags, and a basic text search token for the purpose of building search dialogs", "operationId"=>"Api::V1::MobileApps#tokeninput", "x-api-path-slug"=>"mobile-appstokeninput-json-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"String to compare to the various values"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mobile Apps"]}}, "/mobile_apps.json"=>{"get"=>{"summary"=>"Mobile Apps", "description"=>"This lists all active mobile apps. It accepts parameters to perform basic search as well as searching by tag and agency.", "operationId"=>"Api::V1::MobileApps#index", "x-api-path-slug"=>"mobile-apps-json-get", "parameters"=>[{"in"=>"query", "name"=>"agencies", "description"=>"Comma separated list of agency ids"}, {"in"=>"query", "name"=>"language", "description"=>"Language of the social media accounts to return"}, {"in"=>"query", "name"=>"page", "description"=>"Page number"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of results per page, defaults to 25"}, {"in"=>"query", "name"=>"q", "description"=>"String to compare to the name & short description of the mobile apps"}, {"in"=>"query", "name"=>"tags", "description"=>"Comma separated list of tag ids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mobile Apps"]}}, "/mobile_apps/{id}.json"=>{"get"=>{"summary"=>"Mobile App", "description"=>"This returns an mobile app based on an ID.", "operationId"=>"Api::V1::MobileApps#show", "x-api-path-slug"=>"mobile-appsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the mobile app"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mobile Apps"]}}}}, "u-s--digital-registry-tag-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"US Digital Registry", "x-complete"=>1, "info"=>{"title"=>"U.S. Digital Registry Tag API", "description"=>"provides-a-access-to-the-list-of-tags-applied-to-federal-government-agencies-and-their-social-media-accounts-", "version"=>"1.0.0"}, "host"=>"usdigitalregistry.digitalgov.gov", "basePath"=>"/api/v1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/tags/types.json"=>{"get"=>{"summary"=>"Tag Types", "description"=>"This returns a tag based on an ID.", "operationId"=>"Api::V1::Tags#types", "x-api-path-slug"=>"tagstypes-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/tags.json"=>{"get"=>{"summary"=>"Tags", "description"=>"This lists all tags. It accepts parameters to perform basic search.", "operationId"=>"Api::V1::Tags#index", "x-api-path-slug"=>"tags-json-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Page number"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of results per page"}, {"in"=>"query", "name"=>"q", "description"=>"String to compare to the short name of tags"}, {"in"=>"query", "name"=>"type", "description"=>"Comma separated list of tag types"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/tags/{id}.json"=>{"get"=>{"summary"=>"Tag", "description"=>"This returns a tag based on an ID.", "operationId"=>"Api::V1::Tags#show", "x-api-path-slug"=>"tagsid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}}}, "u-s--digital-registry-social-media-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"US Digital Registry", "x-complete"=>1, "info"=>{"title"=>"U.S. Digital Registry Social Media API", "description"=>"provides-access-to-the-social-media-accounts-for-top-federal-agencies-", "version"=>"1.0.0"}, "host"=>"usdigitalregistry.digitalgov.gov", "basePath"=>"/api/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/social_media/verify.json"=>{"get"=>{"summary"=>"Social Media Verify", "description"=>"This returns an agency based on an URL. If not found, it will return a 404", "operationId"=>"Api::V1::SocialMedia#verify", "x-api-path-slug"=>"social-mediaverify-json-get", "parameters"=>[{"in"=>"query", "name"=>"url", "description"=>"URL of social media account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social Media"]}}, "/social_media/services.json"=>{"get"=>{"summary"=>"Social Media Services", "description"=>"This returns a list of services along with the number of accounts registered with them", "operationId"=>"Api::V1::SocialMedia#services", "x-api-path-slug"=>"social-mediaservices-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social Media"]}}, "/social_media/tokeninput.json"=>{"get"=>{"summary"=>"Social Media Token", "description"=>"This returns tokens representing services, agencies, tags, and a basic text search token for the purpose of building search dialogs", "operationId"=>"Api::V1::SocialMedia#tokeninput", "x-api-path-slug"=>"social-mediatokeninput-json-get", "parameters"=>[{"in"=>"query", "name"=>"q", "description"=>"String to compare to the various values"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social Media"]}}, "/social_media.json"=>{"get"=>{"summary"=>"Social Media", "description"=>"This lists all active accounts. It accepts parameters to perform basic search as well as search by service, agency, or tags.", "operationId"=>"Api::V1::SocialMedia#index", "x-api-path-slug"=>"social-media-json-get", "parameters"=>[{"in"=>"query", "name"=>"agencies", "description"=>"Comma separated list of agency ids"}, {"in"=>"query", "name"=>"language", "description"=>"Language of the social media accounts to return"}, {"in"=>"query", "name"=>"page", "description"=>"Page number"}, {"in"=>"query", "name"=>"page_size", "description"=>"Number of results per page, defaults to 25"}, {"in"=>"query", "name"=>"q", "description"=>"String to compare to the name of accounts"}, {"in"=>"query", "name"=>"services", "description"=>"Comma separated list of service keys (available via services call)"}, {"in"=>"query", "name"=>"tags", "description"=>"Comma separated list of tag ids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social Media"]}}, "/social_media/{id}.json"=>{"get"=>{"summary"=>"Social Media", "description"=>"This returns an agency based on an ID.", "operationId"=>"Api::V1::SocialMedia#show", "x-api-path-slug"=>"social-mediaid-json-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Social Media"]}}}}, "apis"=>{"name"=>"US Digital Registry", "x-slug"=>"us-digital-registry", "description"=>"Whether for access to emergency, financial or education public services, users need to trust they are engaging with official U.S. government digital accounts. The U.S. Digital Registry serves as the authoritative resource for agencies, citizens and developers to confirm the official status of social media and public-facing collaboration accounts, mobile apps and mobile websites, and help prevent exploitation from unofficial sources, phishing scams or malicious entities.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/digital-gov-logo.jpeg", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"Federal Government GSA,General Data,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"us-digital-registry/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"U.S. Digital Registry Agency API", "x-api-slug"=>"u-s--digital-registry-agency-api", "description"=>"Whether for access to emergency, financial or education public services, users need to trust they are engaging with official U.S. government digital accounts. The U.S. Digital Registry serves as the authoritative resource for agencies, citizens and developers to confirm the official status of social media and public-facing collaboration accounts, mobile apps and mobile websites, and help prevent exploitation from unofficial sources, phishing scams or malicious entities.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/digital-gov-logo.jpeg", "humanURL"=>"https://usdigitalregistry.digitalgov.gov", "baseURL"=>"https://usdigitalregistry.digitalgov.gov//api/v1", "tags"=>"Federal Government GSA,General Data,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/us-digital-registry/agenciesid-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/us-digital-registry/u-s--digital-registry-agency-api-openapi.yaml"}]}, {"name"=>"U.S. Digital Registry Mobile App API", "x-api-slug"=>"u-s--digital-registry-mobile-app-api", "description"=>"Whether for access to emergency, financial or education public services, users need to trust they are engaging with official U.S. government digital accounts. The U.S. Digital Registry serves as the authoritative resource for agencies, citizens and developers to confirm the official status of social media and public-facing collaboration accounts, mobile apps and mobile websites, and help prevent exploitation from unofficial sources, phishing scams or malicious entities.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/digital-gov-logo.jpeg", "humanURL"=>"https://usdigitalregistry.digitalgov.gov", "baseURL"=>"https://usdigitalregistry.digitalgov.gov//api/v1/", "tags"=>"Agencies", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/us-digital-registry/mobile-appsid-json-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/us-digital-registry/u-s--digital-registry-mobile-app-api-openapi.yaml"}]}, {"name"=>"U.S. Digital Registry Social Media API", "x-api-slug"=>"u-s--digital-registry-social-media-api", "description"=>"Whether for access to emergency, financial or education public services, users need to trust they are engaging with official U.S. government digital accounts. The U.S. Digital Registry serves as the authoritative resource for agencies, citizens and developers to confirm the official status of social media and public-facing collaboration accounts, mobile apps and mobile websites, and help prevent exploitation from unofficial sources, phishing scams or malicious entities.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/digital-gov-logo.jpeg", "humanURL"=>"https://usdigitalregistry.digitalgov.gov", "baseURL"=>"https://usdigitalregistry.digitalgov.gov//api/v1", "tags"=>"Mobile Apps", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/us-digital-registry/u-s--digital-registry-social-media-api-openapi.yaml"}]}, {"name"=>"U.S. Digital Registry Tag API", "x-api-slug"=>"u-s--digital-registry-tag-api", "description"=>"Whether for access to emergency, financial or education public services, users need to trust they are engaging with official U.S. government digital accounts. The U.S. Digital Registry serves as the authoritative resource for agencies, citizens and developers to confirm the official status of social media and public-facing collaboration accounts, mobile apps and mobile websites, and help prevent exploitation from unofficial sources, phishing scams or malicious entities.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/digital-gov-logo.jpeg", "humanURL"=>"https://usdigitalregistry.digitalgov.gov", "baseURL"=>"https://usdigitalregistry.digitalgov.gov//api/v1/", "tags"=>"Social Media", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/us-digital-registry/u-s--digital-registry-tag-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://usdigitalregistry.digitalgov.gov"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-service-catalog{"aws-service-catalog-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Service Catalog", "x-complete"=>1, "info"=>{"title"=>"AWS Service Catalog API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AcceptPortfolioShare"=>{"get"=>{"summary"=>"Accept Portfolio Share", "description"=>"Accepts an offer to share a portfolio.", "operationId"=>"acceptPortfolioShare", "x-api-path-slug"=>"actionacceptportfolioshare-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"PortfolioId", "description"=>"The portfolio identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=AssociatePrincipalWithPortfolio"=>{"get"=>{"summary"=>"Associate Principal With Portfolio", "description"=>"Associates the specified principal ARN with the specified portfolio.", "operationId"=>"associatePrincipalWithPortfolio", "x-api-path-slug"=>"actionassociateprincipalwithportfolio-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"PortfolioId", "description"=>"The portfolio identifier", "type"=>"string"}, {"in"=>"query", "name"=>"PrincipalARN", "description"=>"The ARN representing the principal (IAM user, role, or group)", "type"=>"string"}, {"in"=>"query", "name"=>"PrincipalType", "description"=>"The principal type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=AssociateProductWithPortfolio"=>{"get"=>{"summary"=>"Associate Product With Portfolio", "description"=>"Associates a product with a portfolio.", "operationId"=>"associateProductWithPortfolio", "x-api-path-slug"=>"actionassociateproductwithportfolio-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"PortfolioId", "description"=>"The portfolio identifier", "type"=>"string"}, {"in"=>"query", "name"=>"ProductId", "description"=>"The product identifier", "type"=>"string"}, {"in"=>"query", "name"=>"SourcePortfolioId", "description"=>"The identifier of the source portfolio to use with this association", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=CreateConstraint"=>{"get"=>{"summary"=>"Create Constraint", "description"=>"Creates a new constraint.", "operationId"=>"createConstraint", "x-api-path-slug"=>"actioncreateconstraint-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"The text description of the constraint", "type"=>"string"}, {"in"=>"query", "name"=>"IdempotencyToken", "description"=>"A token to disambiguate duplicate requests", "type"=>"string"}, {"in"=>"query", "name"=>"Parameters", "description"=>"The constraint parameters", "type"=>"string"}, {"in"=>"query", "name"=>"PortfolioId", "description"=>"The portfolio identifier", "type"=>"string"}, {"in"=>"query", "name"=>"ProductId", "description"=>"The product identifier", "type"=>"string"}, {"in"=>"query", "name"=>"Type", "description"=>"The type of the constraint", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Constraints"]}}, "/?Action=CreatePortfolio"=>{"get"=>{"summary"=>"Create Portfolio", "description"=>"Creates a new portfolio.", "operationId"=>"createPortfolio", "x-api-path-slug"=>"actioncreateportfolio-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"The text description of the portfolio", "type"=>"string"}, {"in"=>"query", "name"=>"DisplayName", "description"=>"The name to use for display purposes", "type"=>"string"}, {"in"=>"query", "name"=>"IdempotencyToken", "description"=>"A token to disambiguate duplicate requests", "type"=>"string"}, {"in"=>"query", "name"=>"ProviderName", "description"=>"The name of the portfolio provider", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"Tags to associate with the new portfolio", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=CreatePortfolioShare"=>{"get"=>{"summary"=>"Create Portfolio Share", "description"=>"Creates a new portfolio share.", "operationId"=>"createPortfolioShare", "x-api-path-slug"=>"actioncreateportfolioshare-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"AccountId", "description"=>"The account ID with which to share the portfolio", "type"=>"string"}, {"in"=>"query", "name"=>"PortfolioId", "description"=>"The portfolio identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=CreateProduct"=>{"get"=>{"summary"=>"Create Product", "description"=>"Creates a new product.", "operationId"=>"createProduct", "x-api-path-slug"=>"actioncreateproduct-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"The text description of the product", "type"=>"string"}, {"in"=>"query", "name"=>"Distributor", "description"=>"The distributor of the product", "type"=>"string"}, {"in"=>"query", "name"=>"IdempotencyToken", "description"=>"A token to disambiguate duplicate requests", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the product", "type"=>"string"}, {"in"=>"query", "name"=>"Owner", "description"=>"The owner of the product", "type"=>"string"}, {"in"=>"query", "name"=>"ProductType", "description"=>"The type of the product to create", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisioningArtifactParameters", "description"=>"Parameters for the provisioning artifact", "type"=>"string"}, {"in"=>"query", "name"=>"SupportDescription", "description"=>"Support information about the product", "type"=>"string"}, {"in"=>"query", "name"=>"SupportEmail", "description"=>"Contact email for product support", "type"=>"string"}, {"in"=>"query", "name"=>"SupportUrl", "description"=>"Contact URL for product support", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"Tags to associate with the new product", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/?Action=CreateProvisioningArtifact"=>{"get"=>{"summary"=>"Create Provisioning Artifact", "description"=>"Create a new provisioning artifact for the specified product.", "operationId"=>"createProvisioningArtifact", "x-api-path-slug"=>"actioncreateprovisioningartifact-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"IdempotencyToken", "description"=>"A token to disambiguate duplicate requests", "type"=>"string"}, {"in"=>"query", "name"=>"Parameters", "description"=>"The parameters to use when creating the new provisioning artifact", "type"=>"string"}, {"in"=>"query", "name"=>"ProductId", "description"=>"The product identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provisioning Artifacts"]}}, "/?Action=DeleteConstraint"=>{"get"=>{"summary"=>"Delete Constraint", "description"=>"Deletes the specified constraint.", "operationId"=>"deleteConstraint", "x-api-path-slug"=>"actiondeleteconstraint-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The identifier of the constraint to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Constraints"]}}, "/?Action=DeletePortfolio"=>{"get"=>{"summary"=>"Delete Portfolio", "description"=>"Deletes the specified portfolio.", "operationId"=>"deletePortfolio", "x-api-path-slug"=>"actiondeleteportfolio-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The identifier of the portfolio for the delete request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=DeletePortfolioShare"=>{"get"=>{"summary"=>"Delete Portfolio Share", "description"=>"Deletes the specified portfolio share.", "operationId"=>"deletePortfolioShare", "x-api-path-slug"=>"actiondeleteportfolioshare-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"AccountId", "description"=>"The account ID associated with the share to delete", "type"=>"string"}, {"in"=>"query", "name"=>"PortfolioId", "description"=>"The portfolio identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=DeleteProduct"=>{"get"=>{"summary"=>"Delete Product", "description"=>"Deletes the specified product.", "operationId"=>"deleteProduct", "x-api-path-slug"=>"actiondeleteproduct-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The identifier of the product for the delete request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/?Action=DeleteProvisioningArtifact"=>{"get"=>{"summary"=>"Delete Provisioning Artifact", "description"=>"Deletes the specified provisioning artifact.", "operationId"=>"deleteProvisioningArtifact", "x-api-path-slug"=>"actiondeleteprovisioningartifact-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"ProductId", "description"=>"The product identifier", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisioningArtifactId", "description"=>"The identifier of the provisioning artifact for the delete request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provisioning Artifacts"]}}, "/?Action=DescribeConstraint"=>{"get"=>{"summary"=>"Describe Constraint", "description"=>"Retrieves detailed information for a specified constraint.", "operationId"=>"describeConstraint", "x-api-path-slug"=>"actiondescribeconstraint-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The identifier of the constraint", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Constraints"]}}, "/?Action=DescribePortfolio"=>{"get"=>{"summary"=>"Describe Portfolio", "description"=>"Retrieves detailed information and any tags associated with the specified\n portfolio.", "operationId"=>"describePortfolio", "x-api-path-slug"=>"actiondescribeportfolio-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The identifier of the portfolio for which to retrieve information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=DescribeProduct"=>{"get"=>{"summary"=>"Describe Product", "description"=>"Retrieves information about a specified product.", "operationId"=>"describeProduct", "x-api-path-slug"=>"actiondescribeproduct-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The ProductId of the product to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/?Action=DescribeProductAsAdmin"=>{"get"=>{"summary"=>"Describe Product As Admin", "description"=>"Retrieves information about a specified product, run with administrator\n access.", "operationId"=>"describeProductAsAdmin", "x-api-path-slug"=>"actiondescribeproductasadmin-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The identifier of the product for which to retrieve information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/?Action=DescribeProductView"=>{"get"=>{"summary"=>"Describe Product View", "description"=>"Retrieves information about a specified product.", "operationId"=>"describeProductView", "x-api-path-slug"=>"actiondescribeproductview-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The ProductViewId of the product to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/?Action=DescribeProvisioningArtifact"=>{"get"=>{"summary"=>"Describe Provisioning Artifact", "description"=>"Retrieves detailed information about the specified provisioning artifact.", "operationId"=>"describeProvisioningArtifact", "x-api-path-slug"=>"actiondescribeprovisioningartifact-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"ProductId", "description"=>"The product identifier", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisioningArtifactId", "description"=>"The identifier of the provisioning artifact", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provisioning Artifacts"]}}, "/?Action=DescribeProvisioningParameters"=>{"get"=>{"summary"=>"Describe Provisioning Parameters", "description"=>"Provides information about parameters required to provision a specified product in a\n specified manner.", "operationId"=>"describeProvisioningParameters", "x-api-path-slug"=>"actiondescribeprovisioningparameters-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"PathId", "description"=>"The identifier of the path for this products provisioning", "type"=>"string"}, {"in"=>"query", "name"=>"ProductId", "description"=>"The product identifier", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisioningArtifactId", "description"=>"The provisioning artifact identifier for this product", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provisioning Parameters"]}}, "/?Action=DescribeRecord"=>{"get"=>{"summary"=>"Describe Record", "description"=>"Retrieves a paginated list of the full details of a specific request.", "operationId"=>"describeRecord", "x-api-path-slug"=>"actiondescriberecord-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The record identifier of the ProvisionedProduct object for which to retrieve output information", "type"=>"string"}, {"in"=>"query", "name"=>"PageSize", "description"=>"The maximum number of items to return in the results", "type"=>"string"}, {"in"=>"query", "name"=>"PageToken", "description"=>"The page token of the first page retrieved", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Records"]}}, "/?Action=DisassociatePrincipalFromPortfolio"=>{"get"=>{"summary"=>"Disassociate Principal From Portfolio", "description"=>"Disassociates a previously associated principal ARN from a specified\n portfolio.", "operationId"=>"disassociatePrincipalFromPortfolio", "x-api-path-slug"=>"actiondisassociateprincipalfromportfolio-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"PortfolioId", "description"=>"The portfolio identifier", "type"=>"string"}, {"in"=>"query", "name"=>"PrincipalARN", "description"=>"The ARN representing the principal (IAM user, role, or group)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=DisassociateProductFromPortfolio"=>{"get"=>{"summary"=>"Disassociate Product From Portfolio", "description"=>"Disassociates the specified product from the specified portfolio.", "operationId"=>"disassociateProductFromPortfolio", "x-api-path-slug"=>"actiondisassociateproductfromportfolio-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"PortfolioId", "description"=>"The portfolio identifier", "type"=>"string"}, {"in"=>"query", "name"=>"ProductId", "description"=>"The product identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=ListAcceptedPortfolioShares"=>{"get"=>{"summary"=>"List Accepted Portfolio Shares", "description"=>"Lists details of all portfolios for which sharing was accepted by this\n account.", "operationId"=>"listAcceptedPortfolioShares", "x-api-path-slug"=>"actionlistacceptedportfolioshares-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"PageSize", "description"=>"The maximum number of items to return in the results", "type"=>"string"}, {"in"=>"query", "name"=>"PageToken", "description"=>"The page token of the first page retrieved", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=ListConstraintsForPortfolio"=>{"get"=>{"summary"=>"List Constraints For Portfolio", "description"=>"Retrieves detailed constraint information for the specified portfolio and\n product.", "operationId"=>"listConstraintsForPortfolio", "x-api-path-slug"=>"actionlistconstraintsforportfolio-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"PageSize", "description"=>"The maximum number of items to return in the results", "type"=>"string"}, {"in"=>"query", "name"=>"PageToken", "description"=>"The page token of the first page retrieved", "type"=>"string"}, {"in"=>"query", "name"=>"PortfolioId", "description"=>"The portfolio identifier", "type"=>"string"}, {"in"=>"query", "name"=>"ProductId", "description"=>"The product identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=ListLaunchPaths"=>{"get"=>{"summary"=>"List Launch Paths", "description"=>"Returns a paginated list of all paths to a specified product.", "operationId"=>"listLaunchPaths", "x-api-path-slug"=>"actionlistlaunchpaths-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"PageSize", "description"=>"The maximum number of items to return in the results", "type"=>"string"}, {"in"=>"query", "name"=>"PageToken", "description"=>"The page token of the first page retrieved", "type"=>"string"}, {"in"=>"query", "name"=>"ProductId", "description"=>"The product identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Launch Paths"]}}, "/?Action=ListPortfolioAccess"=>{"get"=>{"summary"=>"List Portfolio Access", "description"=>"Lists the account IDs that have been authorized sharing of the specified\n portfolio.", "operationId"=>"listPortfolioAccess", "x-api-path-slug"=>"actionlistportfolioaccess-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"PortfolioId", "description"=>"The portfolio identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=ListPortfolios"=>{"get"=>{"summary"=>"List Portfolios", "description"=>"Lists all portfolios in the catalog.", "operationId"=>"listPortfolios", "x-api-path-slug"=>"actionlistportfolios-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"PageSize", "description"=>"The maximum number of items to return in the results", "type"=>"string"}, {"in"=>"query", "name"=>"PageToken", "description"=>"The page token of the first page retrieved", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=ListPortfoliosForProduct"=>{"get"=>{"summary"=>"List Portfolios For Product", "description"=>"Lists all portfolios that the specified product is associated with.", "operationId"=>"listPortfoliosForProduct", "x-api-path-slug"=>"actionlistportfoliosforproduct-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"PageSize", "description"=>"The maximum number of items to return in the results", "type"=>"string"}, {"in"=>"query", "name"=>"PageToken", "description"=>"The page token of the first page retrieved", "type"=>"string"}, {"in"=>"query", "name"=>"ProductId", "description"=>"The product identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=ListPrincipalsForPortfolio"=>{"get"=>{"summary"=>"List Principals For Portfolio", "description"=>"Lists all principal ARNs associated with the specified portfolio.", "operationId"=>"listPrincipalsForPortfolio", "x-api-path-slug"=>"actionlistprincipalsforportfolio-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"PageSize", "description"=>"The maximum number of items to return in the results", "type"=>"string"}, {"in"=>"query", "name"=>"PageToken", "description"=>"The page token of the first page retrieved", "type"=>"string"}, {"in"=>"query", "name"=>"PortfolioId", "description"=>"The portfolio identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=ListProvisioningArtifacts"=>{"get"=>{"summary"=>"List Provisioning Artifacts", "description"=>"Lists all provisioning artifacts associated with the specified product.", "operationId"=>"listProvisioningArtifacts", "x-api-path-slug"=>"actionlistprovisioningartifacts-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"ProductId", "description"=>"The product identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provisioning Artifacts"]}}, "/?Action=ListRecordHistory"=>{"get"=>{"summary"=>"List Record History", "description"=>"Returns a paginated list of all performed requests, in the form of RecordDetails\n objects that are filtered as specified.", "operationId"=>"listRecordHistory", "x-api-path-slug"=>"actionlistrecordhistory-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"AccessLevelFilter", "description"=>"The access level for obtaining results", "type"=>"string"}, {"in"=>"query", "name"=>"PageSize", "description"=>"The maximum number of items to return in the results", "type"=>"string"}, {"in"=>"query", "name"=>"PageToken", "description"=>"The page token of the first page retrieved", "type"=>"string"}, {"in"=>"query", "name"=>"SearchFilter", "description"=>"The filter to limit search results", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Record History"]}}, "/?Action=ProvisionProduct"=>{"get"=>{"summary"=>"Provision Product", "description"=>"Requests a Provision of a specified product.", "operationId"=>"provisionProduct", "x-api-path-slug"=>"actionprovisionproduct-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"NotificationArns", "description"=>"Passed to CloudFormation", "type"=>"string"}, {"in"=>"query", "name"=>"PathId", "description"=>"The identifier of the path for this products provisioning", "type"=>"string"}, {"in"=>"query", "name"=>"ProductId", "description"=>"The product identifier", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisionedProductName", "description"=>"A user-friendly name to identify the ProvisionedProduct object", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisioningArtifactId", "description"=>"The provisioning artifact identifier for this product", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisioningParameters", "description"=>"Parameters specified by the administrator that are required for provisioning the product", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisionToken", "description"=>"An idempotency token that uniquely identifies the provisioning request", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"A list of tags to use as provisioning options", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/?Action=RejectPortfolioShare"=>{"get"=>{"summary"=>"Reject Portfolio Share", "description"=>"Rejects an offer to share a portfolio.", "operationId"=>"rejectPortfolioShare", "x-api-path-slug"=>"actionrejectportfolioshare-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"PortfolioId", "description"=>"The portfolio identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=ScanProvisionedProducts"=>{"get"=>{"summary"=>"Scan Provisioned Products", "description"=>"Returns a paginated list of all the ProvisionedProduct objects that are currently\n available (not terminated).", "operationId"=>"scanProvisionedProducts", "x-api-path-slug"=>"actionscanprovisionedproducts-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"AccessLevelFilter", "description"=>"The access level for obtaining results", "type"=>"string"}, {"in"=>"query", "name"=>"PageSize", "description"=>"The maximum number of items to return in the results", "type"=>"string"}, {"in"=>"query", "name"=>"PageToken", "description"=>"The page token of the first page retrieved", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provisioned Products"]}}, "/?Action=SearchProducts"=>{"get"=>{"summary"=>"Search Products", "description"=>"Returns a paginated list all of the Products objects to which the caller\n has access.", "operationId"=>"searchProducts", "x-api-path-slug"=>"actionsearchproducts-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Filters", "description"=>"The list of filters with which to limit search results", "type"=>"string"}, {"in"=>"query", "name"=>"PageSize", "description"=>"The maximum number of items to return in the results", "type"=>"string"}, {"in"=>"query", "name"=>"PageToken", "description"=>"The page token of the first page retrieved", "type"=>"string"}, {"in"=>"query", "name"=>"SortBy", "description"=>"The sort field specifier", "type"=>"string"}, {"in"=>"query", "name"=>"SortOrder", "description"=>"The sort order specifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/?Action=SearchProductsAsAdmin"=>{"get"=>{"summary"=>"Search Products As Admin", "description"=>"Retrieves summary and status information about all products created within the\n caller's account.", "operationId"=>"searchProductsAsAdmin", "x-api-path-slug"=>"actionsearchproductsasadmin-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Filters", "description"=>"The list of filters with which to limit search results", "type"=>"string"}, {"in"=>"query", "name"=>"PageSize", "description"=>"The maximum number of items to return in the results", "type"=>"string"}, {"in"=>"query", "name"=>"PageToken", "description"=>"The page token of the first page retrieved", "type"=>"string"}, {"in"=>"query", "name"=>"PortfolioId", "description"=>"The portfolio identifier", "type"=>"string"}, {"in"=>"query", "name"=>"ProductSource", "description"=>"Access level of the source of the product", "type"=>"string"}, {"in"=>"query", "name"=>"SortBy", "description"=>"The sort field specifier", "type"=>"string"}, {"in"=>"query", "name"=>"SortOrder", "description"=>"The sort order specifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/?Action=TerminateProvisionedProduct"=>{"get"=>{"summary"=>"Terminate Provisioned Product", "description"=>"Requests termination of an existing ProvisionedProduct object.", "operationId"=>"terminateProvisionedProduct", "x-api-path-slug"=>"actionterminateprovisionedproduct-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"IgnoreErrors", "description"=>"If set to true, AWS Service Catalog stops managing the specified ProvisionedProduct object even if it cannot delete the underlying resources", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisionedProductId", "description"=>"The identifier of the ProvisionedProduct object to terminate", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisionedProductName", "description"=>"The name of the ProvisionedProduct object to terminate", "type"=>"string"}, {"in"=>"query", "name"=>"TerminateToken", "description"=>"An idempotency token that uniquely identifies the termination request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provisioned Products"]}}, "/?Action=UpdateConstraint"=>{"get"=>{"summary"=>"Update Constraint", "description"=>"Updates an existing constraint.", "operationId"=>"updateConstraint", "x-api-path-slug"=>"actionupdateconstraint-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"The updated text description of the constraint", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The identifier of the constraint to update", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Constraints"]}}, "/?Action=UpdatePortfolio"=>{"get"=>{"summary"=>"Update Portfolio", "description"=>"Updates the specified portfolio's details.", "operationId"=>"updatePortfolio", "x-api-path-slug"=>"actionupdateportfolio-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"AddTags", "description"=>"Tags to add to the existing list of tags associated with the portfolio", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"The updated text description of the portfolio", "type"=>"string"}, {"in"=>"query", "name"=>"DisplayName", "description"=>"The name to use for display purposes", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The identifier of the portfolio for the update request", "type"=>"string"}, {"in"=>"query", "name"=>"ProviderName", "description"=>"The updated name of the portfolio provider", "type"=>"string"}, {"in"=>"query", "name"=>"RemoveTags", "description"=>"Tags to remove from the existing list of tags associated with the portfolio", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Portfolios"]}}, "/?Action=UpdateProduct"=>{"get"=>{"summary"=>"Update Product", "description"=>"Updates an existing product.", "operationId"=>"updateProduct", "x-api-path-slug"=>"actionupdateproduct-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"AddTags", "description"=>"Tags to add to the existing list of tags associated with the product", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"The updated text description of the product", "type"=>"string"}, {"in"=>"query", "name"=>"Distributor", "description"=>"The updated distributor of the product", "type"=>"string"}, {"in"=>"query", "name"=>"Id", "description"=>"The identifier of the product for the update request", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The updated product name", "type"=>"string"}, {"in"=>"query", "name"=>"Owner", "description"=>"The updated owner of the product", "type"=>"string"}, {"in"=>"query", "name"=>"RemoveTags", "description"=>"Tags to remove from the existing list of tags associated with the product", "type"=>"string"}, {"in"=>"query", "name"=>"SupportDescription", "description"=>"The updated support description for the product", "type"=>"string"}, {"in"=>"query", "name"=>"SupportEmail", "description"=>"The updated support email for the product", "type"=>"string"}, {"in"=>"query", "name"=>"SupportUrl", "description"=>"The updated support URL for the product", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Products"]}}, "/?Action=UpdateProvisionedProduct"=>{"get"=>{"summary"=>"Update Provisioned Product", "description"=>"Requests updates to the configuration of an existing ProvisionedProduct object.", "operationId"=>"updateProvisionedProduct", "x-api-path-slug"=>"actionupdateprovisionedproduct-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"PathId", "description"=>"The identifier of the path to use in the updated ProvisionedProduct object", "type"=>"string"}, {"in"=>"query", "name"=>"ProductId", "description"=>"The identifier of the ProvisionedProduct object", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisionedProductId", "description"=>"The identifier of the ProvisionedProduct object to update", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisionedProductName", "description"=>"The updated name of the ProvisionedProduct object ", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisioningArtifactId", "description"=>"The provisioning artifact identifier for this product", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisioningParameters", "description"=>"A list of ProvisioningParameter objects used to update the ProvisionedProduct object", "type"=>"string"}, {"in"=>"query", "name"=>"UpdateToken", "description"=>"The idempotency token that uniquely identifies the provisioning update request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provisioned Products"]}}, "/?Action=UpdateProvisioningArtifact"=>{"get"=>{"summary"=>"Update Provisioning Artifact", "description"=>"Updates an existing provisioning artifact's information.", "operationId"=>"updateProvisioningArtifact", "x-api-path-slug"=>"actionupdateprovisioningartifact-get", "parameters"=>[{"in"=>"query", "name"=>"AcceptLanguage", "description"=>"The language code to use for this operation", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"The updated text description of the provisioning artifact", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The updated name of the provisioning artifact", "type"=>"string"}, {"in"=>"query", "name"=>"ProductId", "description"=>"The product identifier", "type"=>"string"}, {"in"=>"query", "name"=>"ProvisioningArtifactId", "description"=>"The identifier of the provisioning artifact for the update request", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Provisioning Artifacts"]}}}}, "apis"=>{"name"=>"AWS Service Catalog", "x-slug"=>"aws-service-catalog", "description"=>"AWS Service Catalog allows organizations to create and manage catalogs of IT services that are approved for use on AWS. These IT services can include everything from virtual machine images, servers, software, and databases to complete multi-tier application architectures. AWS Service Catalog allows you to centrally manage commonly deployed IT services, and helps you achieve consistent governance and meet your compliance requirements, while enabling users to quickly deploy only the approved IT services they need.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Management-Tools_AWSServiceCatalog.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Discovery,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-service-catalog/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Service Catalog API", "x-api-slug"=>"aws-service-catalog-api", "description"=>"AWS Service Catalog allows organizations to create and manage catalogs of IT services that are approved for use on AWS. These IT services can include everything from virtual machine images, servers, software, and databases to complete multi-tier application architectures. AWS Service Catalog allows you to centrally manage commonly deployed IT services, and helps you achieve consistent governance and meet your compliance requirements, while enabling users to quickly deploy only the approved IT services they need.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Management-Tools_AWSServiceCatalog.png", "humanURL"=>"https://aws.amazon.com/servicecatalog/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Discovery,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-service-catalog/aws-service-catalog-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/servicecatalog/latest/dg/service-catalog-api-overview.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/servicecatalog/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/servicecatalog/getting-started/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/servicecatalog/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/servicecatalog/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
tradestation{"tradestation-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"TradeStation", "x-complete"=>1, "info"=>{"title"=>"Tradestation API", "description"=>"this-document-describes-the-resources-that-make-up-the-official-tradestationapi--if-you-have-any-problems-or-requests-please-contact-supportmailtowebapitradestation-com-overviewthe-tradestation-api-is-reachable-at-the-baseurlhttpsapi-tradestation-comv2current-versionthe-latest-version-is-20160101-but-currently-we-are-in-transition-so-bydefault-all-requests-receive-the-20101026-version-for-backwards-compatibility-always-explicitly-request-this-version-by-adding-the-apiversionquerystring-parameter-as-shown-belowhttpsapi-tradestation-comv2dataquotemsftapiversion20160101note-this-will-ensure-your-application-will-not-be-broken-when-we-deprecatethe-20101026-version-in-favor-of-20160101-or-newer-versions-sim-vs-livewe-also-offer-a-simulatorsim-api-for-paper-trading-that-is-identicalto-the-live-api-in-all-ways-except-it-uses-fake-trading-accounts-seeded-withfake-money-and-orders-are-not-actually-executed--only-simulated-executionsoccur-with-instant-fills-to-access-the-sim-environment-you-must-change-your-baseurl-tohttpssimapi-tradestation-comv2warning-tradestation-is-not-liable-for-mistakes-made-by-applicationsthat-allow-users-to-switch-between-sim-and-live-environments--why-offer-a-simulatortransactional-api-calls-such-as-order-execution-offers-users-or-applicationsthe-ability-to-experiment-within-a-simulated-trading-system-so-that-realaccounts-and-money-are-not-affected-and-trades-are-not-actually-executed-other-potential-usecases-learning-how-to-use-applications-via-paper-trading--exploring-tradestation-api-behavior-without-financial-ramifications-testing-apps-and-websites-before-making-them-live-to-customers-enabling-users-to-trybeforetheybuy-with-apps-that-use-the-tradestation-api-hosting-trading-competitions-or-gameshttp-requestsall-api-access-is-over-https-and-accessed-from-the-httpsapi-tradestation-com-all-data-is-sent-and-received-as-json-with-some-limited-support-for-xml-example-requestcurl-i-httpsapi-tradestation-comv2dataquotemsftapiversion20160101http1-1-200-okcachecontrol-privatecontentlength-1545contenttype-applicationdefaultjson-charsetutf8accesscontrolalloworigin-apiversion-20160101date-wed-30-nov-2016-015145-gmt---json----common-conventions-blank-fields-may-either-be-included-as-null-or-omitted-so-please-support-both--all-timestamps-are-returned-in-epoch-timehttpsen-wikipedia-orgwikiunix-time-format-unless-stated-otherwise-http-streamingthe-tradestation-api-offers-http-streaming-responses-for-some-specializedresources-including-intraday-barcharts-quote-changes-and-quote-snapshots-these-streams-conform-to-rfc2616-for-http1-1-streaming-with-some-slightmodifications--the-http-streaming-mechanism-keeps-a-request-open-indefinitely---it-never-terminates-the-request-or-closes-the-connection-even-after-the-server-pushes-data-to-the-client---this-mechanism-significantly-reduces-the-network-latency-because-the-client-and-the-server-do-not-need-to-open-and-close-the-connection--the-basic-life-cycle-of-an-application-using-http-streaming-is-as-follows-1---the-client-makes-an-initial-request-and-then-waits-for-a-----response--2---the-server-defers-the-response-to-a-poll-request-until-an-update-----is-available-or-until-a-particular-status-or-timeout-has-----occurred--3---whenever-an-update-is-available-the-server-sends-it-back-to-the-----client-as-a-part-of-the-response--4---the-data-sent-by-the-server-does-not-terminate-the-request-or-the-----connection---the-server-returns-to-step-3--the-http-streaming-mechanism-is-based-on-the-capability-of-the-server-to-send-several-pieces-of-information-in-the-same-response-without-terminating-the-request-or-the-connection-source-rfc6202-page-7httpstools-ietf-orghtmlrfc6202page7-http-streaming-resources-are-identified-under-in-this-documentation-as-suchall-other-resources-conform-to-the-http-request-pattern-instead-the-http-streaming-response-is-returned-with-the-following-headers----transferencoding-chunked--contenttype-applicationvnd-tradestation-streamsjson--note-the-contentlength-header-is-typically-omitted-since-the-responsebody-size-is-unknown-streams-consist-of-a-series-of-chunks-that-contain-individual-json-objectsto-be-parsed-separately-rather-than-as-a-whole-response-body-one-unique-thing-about-tradestations-http-streams-is-they-also-can-terminateunlike-a-canonical-http1-1-stream-streams-terminate-with-a-nonjson-string-prefixed-with-one-of-the-following---end---errorin-the-case-of-error-it-will-often-be-followed-by-an-error-message-likeerror--a-timeout-occurred-after-waiting-15000msin-either-case-the-http-client-must-terminate-the-http-stream-and-end-thehttp-request-lifetime-as-a-result-of-these-messages--in-the-case-of-errorthe-client-application-may-add-a-delay-before-rerequesting-the-http-stream--how-to-handle-http-chunked-encoded-streamshealthy-chunkedencoded-streams-emit-variable-length-chunks-that-containparsable-json-for-exampleget-httpssim-api-tradestation-comv2streambarchartdji1minute1226201601242017access-tokenhttp1-1-200-okdate-wed-14-jun-2017-011736-gmtcontenttype-applicationvnd-tradestation-streamsjsontransferencoding-chunkedconnection-keepaliveaccesscontrolalloworigin-cachecontrol-private114close19956-09downticks26downvolume940229high19961-77low19943-46open19943-46status13timestampdate1482849060000totalticks59totalvolume3982533unchangedticks0unchangedvolume0upticks33upvolume3042304openinterest0112close19950-82downticks32downvolume440577high19959-15low19947-34open19955-64status13timestampdate1482849120000totalticks60totalvolume761274unchangedticks0unchangedvolume0upticks28upvolume320697openinterest0endtypically-this-will-stream-forever-unless-a-network-interruption-or-servicedisruption-occurs--it-is-up-to-the-client-to-properly-handle-stream-lifetimeand-connection-closing--how-to-parse-json-chunksin-order-to-process-these-chunks-api-consumers-should-first-read-theresponse-buffer-then-dechunk-the-plaintext-strings-and-finally-identifynew-json-objects-by-applying-tokenizing-techniques-to-the-resulting-textstream-using-either-a-streaming-json-parser-regex-a-lexerparser-orbruteforce-string-indexing-logic-a-simple-but-effective-technique-is-after-dechunking-to-simply-parse-basedupon-the-n-newline-character-delimiter-written-to-the-end-of-eachjson-object--however-a-more-robust-solution-is-less-likely-to-break-later--variable-length-json-chunkingas-a-developer-be-careful-with-how-you-parse-http-streams-because-theapis-or-intermediate-proxies-may-chunk-json-objects-many-different-ways--using-http-streaming-several-application-messages-can-be-sent-within-a-single-http-response---the-separation-of-the-response-stream-into-application-messages-needs-to-be-performed-at-the-application-level-and-not-at-the-http-level---in-particular-it-is-not-possible-to-use-the-http-chunks-as-application-message-delimiters-since-intermediate-proxies-might-rechunk-the-message-stream-for-example-by-combining-different-chunks-into-a-longer-one---this-issue-does-not-affect-the-http-long-polling-technique-which-provides-a-canonical-framing-technique-each-application-message-can-be-sent-in-a-different-http-response-source-rfc6202-section-3-2httpstools-ietf-orghtmlrfc6202section3-2translation-be-prepared-for-json-objects-that-span-chunks--you-may-seechunks-with-varying-numbers-of-json-objects-including-exactly-1-json-object-per-chunk-at-least-1-json-object-per-chunk-1-json-object-split-across-2-or-more-chunksexample-of-2-json-objects-in-1-chunkget-httpssim-api-tradestation-comv2streambarchartdji1minute1226201601242017access-tokenhttp1-1-200-okdate-wed-14-jun-2017-011736-gmtcontenttype-applicationvnd-tradestation-streamsjsontransferencoding-chunkedconnection-keepaliveaccesscontrolalloworigin-cachecontrol-private22dclose19956-09downticks26downvolume940229high19961-77low19943-46open19943-46status13timestampdate1482849060000totalticks59totalvolume3982533unchangedticks0unchangedvolume0upticks33upvolume3042304openinterest0close19950-82downticks32downvolume440577high19959-15low19947-34open19955-64status13timestampdate1482849120000totalticks60totalvolume761274unchangedticks0unchangedvolume0upticks28upvolume320697openinterest0endexample-of-1-json-objects-split-across-2-chunksget-httpssim-api-tradestation-comv2streambarchartdji1minute1226201601242017access-tokenhttp1-1-200-okdate-wed-14-jun-2017-011736-gmtcontenttype-applicationvnd-tradestation-streamsjsontransferencoding-chunkedconnection-keepaliveaccesscontrolalloworigin-cachecontrol-private40close71-65downticks45downvolume5406high71-67loc2w71-65open71-66status13timestampdate1497016260000totalticks77totalvolume17270unchangedticks0unchangedvolume0upticks32upvolume11864openinterest0endthis-is-allowed-by-the-http1-1-specification-but-can-be-confusing-or-leadto-bugs-in-client-applications-if-you-try-to-depend-parsing-json-alongthe-http-chunkboundaries-because-even-if-it-works-during-testing-later-ifusers-connect-from-a-different-network-it-may-change-the-chunking-behavior-for-example-if-you-are-at-a-coffee-shop-with-wifi-which-employs-anhttp-proxy-then-it-may-buffer-the-stream-and-change-the-chunking-boundaryfrom-1-json-object-per-chunk-to-splitting-each-json-object-across-2-or-3-in-fact-the-http1-1-spec-clearly-advises-developers-of-proxies-to-alwaysrechunk-http-streams-so-this-is-almost-a-guarantee-to-happen-in-the-wild-http-streaming-api-consumers-should-be-prepared-to-support-all-variations-rate-limitingthe-tradestation-api-rate-limits-on-the-number-of-requests-a-given-user-client-can-make-to-the-api-in-order-to-ensure-fairness-between-users-andprevent-abuse-to-our-network--each-api-key-is-allocated-quota-settings-uponcreation--these-settings-are-applied-on-a-peruser-basis--if-the-quota-isexceeded-an-http-response-of-403-quota-exceeded-will-bereturned--quotas-are-reset-on-a-5minute-interval-based-on-when-the-userissued-the-first-request--resource-categoriesthe-rate-limit-applies-to-the-following-resourcecategories-resourcecategory------------------------------quota--interval--------accounts---------------------------------------250----5minute--order-details----------------------------------250----5minute--balances---------------------------------------250----5minute--positions--------------------------------------250----5minute--data-quotes------------------------------------250----5minute--quote-change-stream----------------------------500----5minute--quote-snapshot-stream--------------------------500----5minute--barchart-stream--------------------------------500----5minute--tickbar-stream---------------------------------500----5minute--intervalsquotas-have-windows-that-last-for-a-limited-time-intervalgenerally-5minutes--once-the-user-has-exceeded-the-maximum-request-countall-future-requests-will-fail-with-a-403-error-until-the-interval-expires-rate-limit-intervals-do-not-slide-based-upon-the-number-of-requests-they-arefixed-at-a-point-in-time-starting-from-the-very-first-request-for-thatcategory-of-resource---after-the-interval-expires-the-cycle-willstart-over-at-zero-and-the-user-can-make-more-requests--example-aa-user-logs-into-the-tradestation-webapi-with-your-application-and-issues-arequest-to-v2elitetraderaccounts--as-a-result-the-requestquota-is-incremented-by-one-for-the-accounts-resourcecategory--the-userthen-issues-250-more-requests-immediately-to-v2elitetraderaccounts-the-last-request-fails-with-403-quota-exceeded--all-subsequent-requestscontinue-to-fail-until-the-5minute-interval-expires-from-the-time-of-thevery-first-request--example-ba-user-logs-into-the-tradestation-webapi-with-your-application-and-issues-arequest-to-v2dataquoteibmnflxmsftamznaapl--as-a-result-therequest-quota-is-incremented-by-one-for-the-data-quotesresourcecategory--the-user-then-immediately-issues-the-same-request-250-moretimes--the-last-request-fails-with-403-quota-exceeded--allsubsequent-requests-continue-to-fail-until-the-5minute-interval-expiresfrom-the-time-of-the-first-request-example-throttled-requestget-httpsapi-tradestation-comv2dataquotesibmnflxmsftamznaapl-http1-1host-api-tradestation-comauthorization-bearer-ee45vkdqsnlbcmi0q2rqti82sfdmsve0sxmyofo5z3dzvzdzdkaccept-applicationjsonexample-failed-responsehttp1-1-403-quota-exceededcontentlength-15server-microsoftiis7-5xaspnetversion-4-0-30319date-tue-06-dec-2011-205032-gmthtmlbodyquota-exceededbodyhtml", "termsOfService"=>"http://elasticbeanstalk-us-east-1-525856068889.s3.amazonaws.com/wp-content/uploads/2014/03/Guidelines_For_Acceptance.pdf", "contact"=>{"name"=>"TradeStation API Team", "url"=>"https://developer.tradestation.com/webapi", "email"=>"webapi@tradestation.com"}, "version"=>"1.0.0"}, "host"=>"api.tradestation.com", "basePath"=>"/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/data/symbol/{symbol}"=>{"get"=>{"summary"=>"Get Symbol Info", "description"=>"Finds the given symbol and returns a collection of fields describing the\nsymbol, its origin exchange, and other pertinant information.", "operationId"=>"getSymbol", "x-api-path-slug"=>"datasymbolsymbol-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"symbol", "description"=>"Symbol to lookup"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Symbol", "Info"]}}, "/data/symbols/suggest/{text}"=>{"get"=>{"summary"=>"Suggest Symbols", "description"=>"Suggests symbols semantically based upon partial input of symbol name,\ncompany name, or description", "operationId"=>"suggestsymbols", "x-api-path-slug"=>"datasymbolssuggesttext-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"An OData filter to apply to the results"}, {"in"=>"query", "name"=>"$top", "description"=>"The top number of results to return"}, {"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"text", "description"=>"Symbol text for suggestion"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Suggest", "Symbols"]}}, "/data/symbols/search/{criteria}"=>{"get"=>{"summary"=>"Search for Symbols", "description"=>"Searches symbols based upon input criteria including Name, Category and\nCountry.", "operationId"=>"searchSymbols", "x-api-path-slug"=>"datasymbolssearchcriteria-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"criteria", "description"=>"Criteria are represented as Key/value pairs (`&` separated):`N`: Name of Symbol"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["SearchSymbols"]}}, "/data/quote/{symbols}"=>{"get"=>{"summary"=>"Get Quote", "description"=>"Gets the latest Level2 Quote for the given Symbol", "operationId"=>"getQuotes", "x-api-path-slug"=>"dataquotesymbols-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"symbols", "description"=>"1 or more Symbol Names (comma-separated)"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Quote"]}}, "/stream/quote/changes/{symbols}"=>{"get"=>{"summary"=>"Stream Quote Changes", "description"=>"Streams the latest Quote information for the given Symbols. The first chunk in the stream is a full quote snapshot - subsequent chunks only contain fields of the quote object that have changed since the last chunk.\n\nAn invalid symbol name will result in a response of this form - {\"Symbol\":\"BADEXAMPLESYMBOL\",\"Error\":\"FAILED, EX_INVALID_SYMBOL\"}\n\nIf the user is not entitled for the symbol requested, response will be of this form - {\"Symbol\":\"EXAMPLESYMBOL\",\"Error\":\"FAILED, EX_NOT_ENTITLED\"}", "operationId"=>"streamQuotesChanges", "x-api-path-slug"=>"streamquotechangessymbols-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"symbols", "description"=>"1 or more Symbol Names (comma-separated)"}, {"in"=>"header", "name"=>"Transfer-Encoding", "description"=>"a header with the value of `Chunked` must be passed to streaming resources"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Stream", "Quote", "Changes"]}}, "/stream/quote/snapshots/{symbols}"=>{"get"=>{"summary"=>"Stream Quote Snapshots", "description"=>"Streams the latest Quote for the given Symbols. Each chunk is a full quote object.\n\nAn invalid symbol name will result in a response of this form - {\"Symbol\":\"BADSYMBOLEXAMPLE\",\"Error\":\"FAILED, EX_INVALID_SYMBOL\"}\n\nIf the user is not entitled for the symbol requested, response will be of this form - {\"Symbol\":\"EXAMPLESYMBOL\",\"Error\":\"FAILED, EX_NOT_ENTITLED\"}", "operationId"=>"streamQuotesSnapshots", "x-api-path-slug"=>"streamquotesnapshotssymbols-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"symbols", "description"=>"1 or more Symbol Names (comma-separated)"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Stream", "Quote", "Snapshots"]}}, "/stream/barchart/{symbol}/{interval}/{unit}/{startDate}"=>{"get"=>{"summary"=>"Stream BarChart - Starting on Date", "description"=>"Streams barchart data starting from startDate, each bar filling quantity of unit.", "operationId"=>"streamBarchartsFromStartDate", "x-api-path-slug"=>"streambarchartsymbolintervalunitstartdate-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"interval", "description"=>"Interval that each bar will consist of"}, {"in"=>"query", "name"=>"SessionTemplate", "description"=>"United States (US) stock market session templates, that extend bars returned to include those outside of the regular trading session"}, {"in"=>"path", "name"=>"startDate", "description"=>"The starting date to begin streaming bars from"}, {"in"=>"path", "name"=>"symbol", "description"=>"A Symbol Name"}, {"in"=>"path", "name"=>"unit", "description"=>"Unit of time for each bar interval"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Stream", "BarChart", "-", "Starting", "On", "Date"]}}, "/stream/barchart/{symbol}/{interval}/{unit}/{startDate}/{endDate}"=>{"get"=>{"summary"=>"Stream BarChart - Date Range", "description"=>"Streams barchart data starting from startDate to end date, each bar filling interval of unit.", "operationId"=>"streamBarchartsFromStartDateToEndDate", "x-api-path-slug"=>"streambarchartsymbolintervalunitstartdateenddate-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"endDate", "description"=>"The ending date for bars streamed"}, {"in"=>"path", "name"=>"interval", "description"=>"Interval that each bar will consist of"}, {"in"=>"query", "name"=>"SessionTemplate", "description"=>"United States (US) stock market session templates, that extend bars returned to include those outside of the regular trading session"}, {"in"=>"path", "name"=>"startDate", "description"=>"The starting date to begin streaming bars from"}, {"in"=>"path", "name"=>"symbol", "description"=>"A Symbol Name"}, {"in"=>"path", "name"=>"unit", "description"=>"Unit of time for each bar interval"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Stream", "BarChart", "-", "Date", "Range"]}}, "/stream/barchart/{symbol}/{interval}/{unit}/{barsBack}/{lastDate}/..."=>{"get"=>{"summary"=>"Stream BarChart - Bars Back", "description"=>"Streams barchart data starting from a number of bars back from last date, each bar filling interval of unit.", "operationId"=>"streamBarchartsBarsBack", "x-api-path-slug"=>"streambarchartsymbolintervalunitbarsbacklastdate----get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"barsBack", "description"=>"The number of bars to stream, going back from time 00:00:00 of the day specified in lastDate"}, {"in"=>"path", "name"=>"interval", "description"=>"Interval that each bar will consist of"}, {"in"=>"path", "name"=>"lastDate", "description"=>"The date to use as the end point when getting bars back"}, {"in"=>"query", "name"=>"SessionTemplate", "description"=>"United States (US) stock market session templates, that extend bars returned to include those outside of the regular trading session"}, {"in"=>"path", "name"=>"symbol", "description"=>"A Symbol Name"}, {"in"=>"path", "name"=>"unit", "description"=>"Unit of time for each bar interval"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Stream", "BarChart", "-", "Bars", "Back"]}}, "/stream/barchart/{symbol}/{interval}/{unit}"=>{"get"=>{"summary"=>"Stream BarChart - Days Back", "description"=>"Streams barchart data starting from a number of days back from last date, each bar filling interval of unit.", "operationId"=>"streamBarchartsDaysBack", "x-api-path-slug"=>"streambarchartsymbolintervalunit-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"query", "name"=>"daysBack", "description"=>"The number of bars to stream, going back from time 00:00:00 of the day specified in lastDate"}, {"in"=>"path", "name"=>"interval", "description"=>"Interval that each bar will consist of"}, {"in"=>"query", "name"=>"lastDate", "description"=>"The date to use as the end point when getting days back"}, {"in"=>"query", "name"=>"SessionTemplate", "description"=>"United States (US) stock market session templates, that extend bars returned to include those outside of the regular trading session"}, {"in"=>"path", "name"=>"symbol", "description"=>"A Symbol Name"}, {"in"=>"path", "name"=>"unit", "description"=>"Unit of time for each bar interval"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Stream", "BarChart", "-", "Days", "Back"]}}, "/stream/tickbars/{symbol}/{interval}/{barsBack}"=>{"get"=>{"summary"=>"Stream Tick Bars", "description"=>"Streams tick bars data from a number of bars back, each bar returned separated by interval number of ticks.", "operationId"=>"streamTickBars", "x-api-path-slug"=>"streamtickbarssymbolintervalbarsback-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"barsBack", "description"=>"The number of bars to stream, going back from current time"}, {"in"=>"path", "name"=>"interval", "description"=>"Interval for each bar returned (in ticks)"}, {"in"=>"path", "name"=>"symbol", "description"=>"A Symbol Name"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Stream", "Tick", "Bars"]}}, "/data/symbollists"=>{"get"=>{"summary"=>"Get all Symbol Lists", "description"=>"Gets a list of all Symbol Lists", "operationId"=>"getSymbolLists", "x-api-path-slug"=>"datasymbollists-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Symbol", "Lists"]}}, "/data/symbollists/{symbol_list_id}"=>{"get"=>{"summary"=>"Get Symbol List", "description"=>"Gets a specific Symbol List", "operationId"=>"getSymbolListByID", "x-api-path-slug"=>"datasymbollistssymbol-list-id-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"symbol_list_id", "description"=>"A valid Symbol List ID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Symbol", "List"]}}, "/data/symbollists/{symbol_list_id}/symbols"=>{"get"=>{"summary"=>"Get Symbols in a Symbol List", "description"=>"Gets the Symbols for a specific Symbol List", "operationId"=>"getSymbolListSymbolsByID", "x-api-path-slug"=>"datasymbollistssymbol-list-idsymbols-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"symbol_list_id", "description"=>"A valid Symbol List ID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Symbols", "In", "Symbol", "List"]}}, "/users/{user_id}/accounts"=>{"get"=>{"summary"=>"Get User Accounts", "description"=>"Returns all accounts for the given user", "operationId"=>"getAccountsByUserID", "x-api-path-slug"=>"usersuser-idaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"user_id", "description"=>"User ID for Accounts Lookup"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["User", "Accounts"]}}, "/accounts/{account_keys}/balances"=>{"get"=>{"summary"=>"Get Account Balances", "description"=>"Returns the Balance for the given accounts", "operationId"=>"getBalancesByAccounts", "x-api-path-slug"=>"accountsaccount-keysbalances-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"account_keys", "description"=>"1 or more Account Keys"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Account", "Balances"]}}, "/accounts/{account_keys}/positions"=>{"get"=>{"summary"=>"Get Account Positions", "description"=>"Returns the Positions for the given accounts", "operationId"=>"getPositionsByAccounts", "x-api-path-slug"=>"accountsaccount-keyspositions-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"An OData v2"}, {"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"account_keys", "description"=>"1 or more Account Keys"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Account", "Positions"]}}, "/accounts/{account_keys}/orders"=>{"get"=>{"summary"=>"Get Account Orders", "description"=>"Returns the Orders for the given accounts sorted descending, most recent order first.\n\n#### Stateless Connection\nSince the web-API provides a stateless connection, it only supports fetching the current state of Orders. If it is needed to display the intermediate state changes, it should be executed at client level.", "operationId"=>"getOrdersByAccounts", "x-api-path-slug"=>"accountsaccount-keysorders-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"account_keys", "description"=>"1 or more Account Keys"}, {"in"=>"query", "name"=>"pageNum", "description"=>"Conveys the page number to return, given a set of orders and a page size"}, {"in"=>"query", "name"=>"pageSize", "description"=>"Conveys the number of order items to return in the request"}, {"in"=>"query", "name"=>"since", "description"=>"Start Date from which to pull older orders"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Account", "Orders"]}}, "/orders/confirm"=>{"post"=>{"summary"=>"Confirm Order", "description"=>"Returns estimated cost and commission information for an order without the order actually being placed. The fields that are returned in the response depend on the order type.\nThe following shows the different fields that will be returned.\n\n**Base Confirmation** (All confirmations will have these fields)\n* Route\n* Duration\n* Account\n* SummaryMessage\n* OrderConfirmId\n\n**Equity Confirmation** (Base Confirmation fields + the following)\n* EstimatedPrice\n* EstimatedPriceDisplay\n* EstimatedCost\n* EstimatedCostDisplay\n* EstimatedCommission\n* EstimatedCommissionDisplay\n* DebitCreditEstimatedCost\n* DebitCreditEstimatedCostDisplay\n\n**Forex Confirmation** (Base Confirmation fields + the following)\n* BaseCurrency\n* CounterCurrency\n* InitialMarginDisplay\n\n**Futures Confirmation** (Base Confirmation fields + the following)\n* ProductCurrency\n* AccountCurrency\n* EstimatedCost\n* EstimatedPrice\n* EstimatedPriceDisplay\n* InitialMarginDisplay\n* EstimatedCommission\n* EstimatedCommissionDisplay", "operationId"=>"postOrderConfirm", "x-api-path-slug"=>"ordersconfirm-post", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Confirm", "Order"]}}, "/orders"=>{"post"=>{"summary"=>"Submit Order", "description"=>"Submits 1 or more orders", "operationId"=>"postOrder", "x-api-path-slug"=>"orders-post", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Submit", "Order"]}}, "/orders/{order_id}"=>{"delete"=>{"summary"=>"Cancel Order", "description"=>"Cancels an open order. You cannot cancel an order that has been filled.", "operationId"=>"cancelOrder", "x-api-path-slug"=>"ordersorder-id-delete", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"path", "name"=>"order_id", "description"=>"An existing Order ID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Cancel", "Order"]}, "put"=>{"summary"=>"Update Order", "description"=>"Updates (Cancels & Replaces) an open order. You cannot update an order\nthat has been filled.\n\nRules:\n\n | Original order type | Fields to update | Can only change order type to |\n | -------------------------------- | -------------------------------- | ----------------------------- |\n | Limit Orders | Quantity, Stop Price | Market |\n | Stop Orders | Quantity, Stop Price | Market |\n | Stop Limit Orders | Quantity, Stop Price, Stop Limit | Market |\n | Stop Market Trailing Stop Orders | Quantity | Market |\n | Trailing Stop Orders | Offset type and value | Market |", "operationId"=>"cancelReplaceOrder", "x-api-path-slug"=>"ordersorder-id-put", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"order_id", "description"=>"An existing Order ID"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Order"]}}, "/orders/groups/confirm"=>{"post"=>{"summary"=>"Confirm Group Order", "description"=>"Returns estimated cost and commission information for a group of orders (OCO, BRK) without the orders actually being placed\n\n**Base Confirmation** (All confirmations will have these fields)\n* Route\n* Duration\n* Account\n* SummaryMessage\n* OrderConfirmId\n\n**Equity Confirmation** (Base Confirmation fields + the following)\n* EstimatedPrice\n* EstimatedPriceDisplay\n* EstimatedCost\n* EstimatedCostDisplay\n* EstimatedCommission\n* EstimatedCommissionDisplay\n\n**Forex Confirmation** (Base Confirmation fields + the following)\n* BaseCurrency\n* CounterCurrency\n* InitialMarginDisplay\n\n**Futures Confirmation** (Base Confirmation fields + the following)\n* ProductCurrency\n* AccountCurrency\n* EstimatedCost\n* EstimatedPrice\n* EstimatedPriceDisplay\n* InitialMarginDisplay\n* EstimatedCommission\n* EstimatedCommissionDisplay", "operationId"=>"postOrderGroupsConfirm", "x-api-path-slug"=>"ordersgroupsconfirm-post", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Confirm", "Group", "Order"]}}, "/orders/groups"=>{"post"=>{"summary"=>"Submit Group Order", "description"=>"Submits a group order such as Bracket and OCO Orders.\n\n#### Order Cancels Order (OCO)\nAn OCO order is a group of orders whereby if one of the orders is filled\nor partially-filled, then all of the other orders in the group are\ncancelled.\n\n#### Bracket OCO Orders\nA bracket order is a special instance of an OCO (Order Cancel Order).\nBracket orders are used to exit an existing position. They are designed\nto limit loss and lock in profit by ???bracketing??? an order with a\nsimultaneous stop and limit order.\n\nBracket orders are limited so that the orders are all for the same\nsymbol and are on the same side of the market (either all to sell or\nall to cover), and they are restricted to closing transactions.\n\nThe reason that they follow these rules is because the orders need to be\nable to auto decrement when a partial fill occurs with one of the orders.\nFor example, if the customer has a sell limit order for 1000 shares and\na sell stop order for 1000 shares, and the limit order is partially\nfilled for 500 shares, then the customer would want the stop to remain\nopen, but it should automatically decrement the order to 500 shares to\nmatch the remaining open position.\n\n### Errors\nWhen a submitted order fails, it can be seen in two different ways:\n-\tImmediately rejected during submit to the Orders API with a 400 HTTP status code.\n-\tAccepted by the API with a 200 HTTP status code, but you will see the order with a status of ???REJ??? (rejected) when you fetch the Order from the /v2/accounts/{id}/orders API\n\n#### NOTE\nWhen a group order is submitted, the order execution system treats each sibling order as an individual order. Thus, the system does not validate that each order has the same Quantity, and currently it is not able to update a bracket order as one transaction, instead you must update each order within a bracket.\n\nIn order to prevent errors, please validate the data on the client side.", "operationId"=>"postOrderGroup", "x-api-path-slug"=>"ordersgroups-post", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Submit", "Group", "Order"]}}, "/orderexecution/activationtriggers"=>{"get"=>{"summary"=>"Request Available Activation Triggers", "description"=>"To place orders with activation triggers, a valid TriggerKey must be sent with the order. This resource provides the available trigger methods with their corresponding key.", "operationId"=>"getActivationTriggers", "x-api-path-slug"=>"orderexecutionactivationtriggers-get", "parameters"=>[{"in"=>"query", "name"=>"access_token", "description"=>"A valid OAuth2 token used to authorize access to the resource"}], "responses"=>{200=>{"description"=>"Successful response"}}, "tags"=>["Request", "Available", "Activation", "Triggers"]}}}}, "apis"=>{"name"=>"TradeStation", "x-slug"=>"tradestation", "description"=>"Whether you trade stocks, ETFs, options or futures, TradeStation???s award-winning tools and brokerage services can give you the confidence to achieve your goals.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/tradestation_logo_285x40.png", "x-kinRank"=>"7", "x-alexaRank"=>"37688", "tags"=>"Financial,Financial Services,General Data,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"tradestation/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"TradeStation", "x-api-slug"=>"tradestation", "description"=>"Whether you trade stocks, ETFs, options or futures, TradeStation???s award-winning tools and brokerage services can give you the confidence to achieve your goals.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/tradestation_logo_285x40.png", "humanURL"=>"http://www.tradestation.com", "baseURL"=>"https://api.tradestation.com//v2", "tags"=>"Financial,Financial Services,General Data,Service API,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/tradestation/tradestation-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://www.tradestation.com"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/tradestation-technologies"}, {"type"=>"x-developer", "url"=>"https://developer.tradestation.com/"}, {"type"=>"x-documentation", "url"=>"https://tradestation.github.io/api-docs/"}, {"type"=>"x-faq", "url"=>"https://www.tradestation.com/faq/"}, {"type"=>"x-github", "url"=>"https://github.com/tradestation"}, {"type"=>"x-openapi", "url"=>"https://tradestation.github.io/api-docs/swagger.json"}, {"type"=>"x-pricing", "url"=>"https://www.tradestation.com/pricing/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/TradeStation"}, {"type"=>"x-website", "url"=>"https://www.tradestation.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ringcentral{"ringcentral-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"RingCentral", "x-complete"=>1, "info"=>{"title"=>"RingCentral Connect Platform API Explorer", "description"=>"this-is-an-interactive-api-explorer-for-the-ringcentral-connect-platform--to-use-this-service-you-will-need-to-have-a-developer-account---links--a-hrefhttpsnetstorage-ringcentral-comdpwapiexplorerrcplatform-basic-ymlv20180514092722-target-blankringcentral-api-specaspannbspnbspopenapi-fka-swagger-formatnbspnbspnbspnbspspana-hrefhttpsgithub-comoaiopenapispecification-target-blanklearn-more-about-openapia", "version"=>"1.0.0"}, "host"=>"platform.ringcentral.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/restapi/"=>{"get"=>{"summary"=>"Get API Versions", "description"=>"Returns current API version(s) and server info.\nUsage Plan Group\nNoThrottling", "operationId"=>"getAllVersions", "x-api-path-slug"=>"restapi-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Versions"]}}, "/restapi/{apiVersion}"=>{"get"=>{"summary"=>"Get Version Info", "description"=>"Returns current API version info by apiVersion.\nUsage Plan Group\nNoThrottling", "operationId"=>"getApiVersion", "x-api-path-slug"=>"restapiapiversion-get", "parameters"=>[{"in"=>"path", "name"=>"apiVersion", "description"=>"API version to be requested, for example v1"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Version", "Info"]}}, "/restapi/v1.0/status"=>{"get"=>{"summary"=>"Get Service status", "description"=>"Returns current PAS service status.\nUsage Plan Group\nNoThrottling", "operationId"=>"loadAPIStatus", "x-api-path-slug"=>"restapiv1-0status-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Service", "Status"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log"=>{"get"=>{"summary"=>"Get Call Log Records by Filter", "description"=>"Returns call log records filtered by parameters specified.\nApp Permission\nReadCallLog\nUser Permission\nReadCallLog\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCLG-110\nParameter [sessionId] is not allowed for usage along with parameter [extensionNumber]\n\n\n400\nCMN-101\nParameter [transport] value is invalid\n\n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-129\nAccess token corrupted\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n401\nOAU-213\nToken not found\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadCallLog] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadCallLog] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found\n\n\n429\nCMN-301\nRequest rate exceeded", "operationId"=>"loadExtensionCallLog", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidcalllog-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"query", "name"=>"dateFrom", "description"=>"The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52"}, {"in"=>"query", "name"=>"dateTo", "description"=>"The end datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52"}, {"in"=>"query", "name"=>"direction", "description"=>"The direction for the resulting records"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"query", "name"=>"extensionNumber", "description"=>"Extension number of a user"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}, {"in"=>"query", "name"=>"phoneNumber", "description"=>"Phone number of a caller/callee"}, {"in"=>"query", "name"=>"sessionId"}, {"in"=>"query", "name"=>"showBlocked", "description"=>"If True then calls from/to blocked numbers are returned"}, {"in"=>"query", "name"=>"transport", "description"=>"Call transport type"}, {"in"=>"query", "name"=>"type", "description"=>"Call type of a record"}, {"in"=>"query", "name"=>"view", "description"=>"The default value is Simple for both account and extension call log"}, {"in"=>"query", "name"=>"withRecording", "description"=>"True should be specified to return recorded calls only"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call", "Log", "Records", "By", "Filter"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log/{callRecordId}"=>{"get"=>{"summary"=>"Get Call Records by ID", "description"=>"Returns filtered call log records.\nApp Permission\nReadCallLog\nUser Permission\nReadCallLog\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadCallLog] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadCallLog] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"getCallRecords", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidcalllogcallrecordid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"callRecordId"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"query", "name"=>"view"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call", "Records", "By", "ID"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/active-calls"=>{"get"=>{"summary"=>"Get User Active Calls", "description"=>"Returns records of all extension calls that are in progress, ordered by start time in descending order.\nApp Permission\nReadCallLog\nUser Permission\nReadCallLog\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [direction] value is invalid\n\n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadCallLog] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadCallLog] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"listExtensionActiveCalls", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidactivecalls-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"query", "name"=>"direction", "description"=>"The direction for the result records"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}, {"in"=>"query", "name"=>"type", "description"=>"Call type of a record"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Active", "Calls"]}}, "/restapi/v1.0/account/{accountId}/call-log"=>{"get"=>{"summary"=>"Get Call Log Records by Filter", "description"=>"Returns call log records filtered by parameters specified.\nApp Permission\nReadCallLog\nUser Permission\nFullCompanyCallLog\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCLG-110\nParameter [sessionId] is not allowed for usage along with parameter [extensionNumber]\n\n\n400\nCMN-101\nParameter [dateFrom] value is invalid\n\n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadCallLog] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadCompanyCallLog] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"loadAccountCallLog", "x-api-path-slug"=>"restapiv1-0accountaccountidcalllog-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"query", "name"=>"dateFrom", "description"=>"The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52"}, {"in"=>"query", "name"=>"dateTo", "description"=>"The end datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52"}, {"in"=>"query", "name"=>"direction", "description"=>"The direction for the result records"}, {"in"=>"query", "name"=>"extensionNumber", "description"=>"Extension number of a user"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}, {"in"=>"query", "name"=>"phoneNumber", "description"=>"Phone number of a caller/call recipient"}, {"in"=>"query", "name"=>"sessionId"}, {"in"=>"query", "name"=>"type", "description"=>"Call type of a record"}, {"in"=>"query", "name"=>"view", "description"=>"The default value is Simple for both account and extension call log"}, {"in"=>"query", "name"=>"withRecording", "description"=>"True if only recorded calls have to be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call", "Log", "Records", "By", "Filter"]}}, "/restapi/v1.0/account/{accountId}/recording/{recordingId}"=>{"get"=>{"summary"=>"Get Call Recordings", "description"=>"Returns call recording metadata by ID.\nApp Permission\nReadCallRecording\nUser Permission\nReadCallRecording\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadCallRecording] permission\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"listCallRecordings", "x-api-path-slug"=>"restapiv1-0accountaccountidrecordingrecordingid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"recordingId", "description"=>"Internal identifier of a recording (returned in Call Log)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call", "Recordings"]}}, "/restapi/v1.0/account/{accountId}/recording/{recordingId}/content"=>{"get"=>{"summary"=>"Get Call Recordings Data", "description"=>"Returns media content of a call recording.\nApp Permission\nReadCallRecording\nUser Permission\nReadCallRecording\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n401\nAGW-402\nInvalid Authorization header\n\n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-149\nUnparsable access token\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadCallRecording] permission\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found\n\n\n416\nCMN-107\nRequested range not satisfiable", "operationId"=>"listCallRecordingData", "x-api-path-slug"=>"restapiv1-0accountaccountidrecordingrecordingidcontent-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"recordingId", "description"=>"Internal identifier of a recording (returned in Call Log)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call", "Recordings", "Data"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/sms"=>{"post"=>{"summary"=>"Create SMS Message", "description"=>"Creates and sends new SMS message. Sending SMS messages simultaneously to different recipients is limited up to 50 requests per minute; relevant for all client applications.\nApp Permission\nSMS\nUser Permission\nOutboundSMS\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [] value is invalid\n\n\n400\nCMN-406\nDuplicate value for parameter to: +13476733173 found in request\n\n\n400\nMSG-243\nParameter [to] value [18882049692] is invalid [Phone number is blocked]\n\n\n400\nMSG-245\nParameter [from] value [88121002330] is invalid [Cannot find the phone number which belongs to user]\n\n\n400\nMSG-246\nSending SMS from/to extension numbers is not available\n\n\n400\nMSG-247\nSending SMS to short numbers is not available\n\n\n400\nMSG-365\nParameters [country.id] and [country.isoCode] can not be specified simultaneously\n\n\n400\nMSG-376\nAttachment size limit exceeded\n\n\n400\nMSG-379\nToo many attachments\n\n\n400\nMSG-381\nExceeded maximum number of recipients for a Group MMS: [10]\n\n\n403\nBIL-103\nFeature [MMS] is not available for current account\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [SMS] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [OutboundSMS] permission for requested resource.\n\n\n403\nMSG-240\nInternational SMS is not available for account.\n\n\n403\nMSG-241\nCannot send SMS from Fax number\n\n\n403\nMSG-242\nThe requested feature is not available\n\n\n403\nMSG-314\nExtension is of inappropriate type\n\n\n403\nMSG-367\n\"from\" phone number does not support SMS\n\n\n403\nMSG-383\nInternational MMS feature is not available\n\n\n403\nMSG-384\nAccount limits exceeded. Cannot send the message.\n\n\n403\nMSG-388\nThe destination is prohibited\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found\n\n\n415\nMSG-348\nUnsupported attachment media type, attachment [3]: [stuff.smil]", "operationId"=>"sendSMS", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidsms-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SMS", "Message"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/company-pager"=>{"post"=>{"summary"=>"Create Pager Message", "description"=>"Creates and sends a pager message.\nApp Permission\nInternalMessages\nUser Permission\nInternalSMS\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [to.phoneNumber] value is invalid\n\n\n400\nCMN-102\nResource for parameter [to] is not found\n\n\n400\nMSG-316\nParameter [to] value [102] is invalid [Target extension not found]\n\n\n400\nMSG-324\nExtension is of unappropriate state\n\n\n400\nMSG-331\nParameter [from] value [11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111] is invalid [Sender extension number does not correspond to logged in extension]\n\n\n400\nMSG-332\nParameter [from] value [404544780008] is invalid [Sender extension id does not correspond to logged in extension]\n\n\n400\nMSG-335\nRecipient extension number does not correspond to ID\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [InternalMessages] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [InternalSMS] permission for requested resource.\n\n\n403\nMSG-325\nReply is forbidden for old message threads\n\n\n403\nMSG-326\nReply is denied for user, who is no longer a thread participant\n\n\n403\nMSG-330\nSender extension is of unappropriate type\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"sendInternalMessage", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidcompanypager-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pager", "Message"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/fax"=>{"post"=>{"summary"=>"Create Fax Message", "description"=>"Creates and sends/resends new fax message. Resend can be done if sending failed.\nApp Permission\nFaxes\nUser Permission\nOutboundFaxes\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [to] value is invalid\n\n\n400\nMSG-344\nSending fax to extension numbers is not available\n\n\n400\nMSG-347\nAttachment [t.txt] body is empty\n\n\n400\nMSG-355\nFor binary data filename with extension should be specified, attachment [1]: []\n\n\n400\nMSG-356\nEither filename or content type should be specified, attachment [1]: []\n\n\n400\nMSG-365\nParameters [country.id] and [country.isoCode] can not be specified simultaneously\n\n\n400\nMSG-370\nfilename is too long, 256 characters allowed\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [Faxes] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [OutboundFaxes] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found\n\n\n415\nMSG-348\nUnsupported attachment media type, attachment [1]: [.jfif]\n\n\n415\nMSG-353\nNo file extension or content type specified, attachment [1]: [filename,txt]", "operationId"=>"sendFaxMessage", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidfax-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account (integer) or tilde (~) to indicate the account which was logged-in within the current session"}, {"in"=>"formData", "name"=>"attachment", "description"=>"File to upload"}, {"in"=>"formData", "name"=>"coverIndex", "description"=>"Cover page identifier"}, {"in"=>"formData", "name"=>"coverPageText", "description"=>"Cover page text, entered by the fax sender and printed on the cover page"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension (integer) or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"formData", "name"=>"faxResolution", "description"=>"Resolution of Fax"}, {"in"=>"formData", "name"=>"isoCode", "description"=>"ISO Code"}, {"in"=>"formData", "name"=>"sendTime", "description"=>"Timestamp to send fax at"}, {"in"=>"formData", "name"=>"to", "description"=>"To Phone Number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fax", "Message"]}}, "/restapi/v1.0/dictionary/fax-cover-page"=>{"get"=>{"summary"=>"Get Available Fax Cover Pages", "description"=>"Returns fax cover pages available for the current extension.\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [page] value is invalid\n\n\n401\nCMN-405\nLogin to extension required", "operationId"=>"listFaxCoverPages", "x-api-path-slug"=>"restapiv1-0dictionaryfaxcoverpage-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Available", "Fax", "Cover", "Pages"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store"=>{"get"=>{"summary"=>"Get Message List", "description"=>"Returns the list of messages from an extension mailbox.\nApp Permission\nReadMessages\nUser Permission\nReadMessages\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [readStatus] value is invalid\n\n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadMessages] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadMessages] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"listMessages", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidmessagestore-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"query", "name"=>"availability", "description"=>"Specifies the availability status for the resulting messages"}, {"in"=>"query", "name"=>"conversationId", "description"=>"Specifies the conversation identifier for the resulting messages"}, {"in"=>"query", "name"=>"dateFrom", "description"=>"The start datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52"}, {"in"=>"query", "name"=>"dateTo", "description"=>"The end datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52"}, {"in"=>"query", "name"=>"direction", "description"=>"The direction for the resulting messages"}, {"in"=>"query", "name"=>"distinctConversations", "description"=>"If True, then the latest messages per every conversation ID are returned"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"query", "name"=>"messageType", "description"=>"The type of the resulting messages"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}, {"in"=>"query", "name"=>"phoneNumber", "description"=>"The phone number"}, {"in"=>"query", "name"=>"readStatus", "description"=>"The read status for the resulting messages"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "List"]}, "delete"=>{"summary"=>"Delete Conversations by ID's", "description"=>"Deletes conversation(s) by conversation ID(s). Batch request is supported.\nApp Permission\nEditMessages\nUser Permission\nEditMessages\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [conversationId] value is invalid\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [EditMessages] permission", "operationId"=>"deleteMessagesByFilter", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidmessagestore-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"query", "name"=>"conversationId"}, {"in"=>"path", "name"=>"extensionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conversations", "By", "IDs"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}"=>{"get"=>{"summary"=>"Get Message(s) by ID", "description"=>"Returns individual message record(s) by the given message ID(s). The length of inbound messages is unlimited. Batch request is supported.\nApp Permission\nReadMessages\nUser Permission\nReadMessages\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadMessages] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadMessages] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"loadMessage", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidmessagestoremessageid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"messageId", "description"=>"Internal identifier of a message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message(s)", "By", "ID"]}, "put"=>{"summary"=>"Update Message(s) by ID", "description"=>"Updates message(s) by ID(s). Batch request is supported, see Batch Requests for details. Currently, only the message read status updating is supported.\nApp Permission\nEditMessages\nUser Permission\nEditMessages\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [] value is invalid\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [EditMessages] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [EditMessages] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"updateMessage", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidmessagestoremessageid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"messageId", "description"=>"Internal identifier of a message"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message(s)", "By", "ID"]}, "delete"=>{"summary"=>"Delete Message(s) by ID", "description"=>"Deletes message(s) by the given message ID(s). The first call of this method transfers the message to the 'Delete' status. The second call transfers the deleted message to the 'Purged' status. If it is required to make the message 'Purged' immediately (from the first call), then set the query parameter purge to 'True'.\nApp Permission\nEditMessages\nUser Permission\nEditMessages\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [purge] value is invalid\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [EditMessages] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [EditMessages] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"deleteMessage", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidmessagestoremessageid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"query", "name"=>"conversationId", "description"=>"Internal identifier of a message thread"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"messageId", "description"=>"Internal identifier of a message"}, {"in"=>"query", "name"=>"purge", "description"=>"If the value is True, then the message is purged immediately with all the attachments"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message(s)", "By", "ID"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{attachmentId}"=>{"get"=>{"summary"=>"Get Message Attachment", "description"=>"Returns a specific message attachment data as a media stream.\nApp Permission\nReadMessages\nUser Permission\nReadMessageContent\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n401\nAGW-402\nInvalid Authorization header\n\n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-149\nUnparsable access token\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadMessages] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadMessageContent] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found\n\n\n416\nCMN-107\nRequested range not satisfiable", "operationId"=>"preturns-a-specific-message-attachment-data-as-a-media-streamph4app-permissionh4preadmessagesph4user", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidmessagestoremessageidcontentattachmentid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"attachmentId", "description"=>"Internal identifier of a message attachment"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"messageId", "description"=>"Internal identifier of a message"}, {"in"=>"header", "name"=>"Range"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Attachment"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-sync"=>{"get"=>{"summary"=>"Get Message Sync", "description"=>"Synchronizes messages.\nApp Permission\nReadMessages\nUser Permission\nReadMessages\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [messageType] value is invalid\n\n\n400\nMSG-333\nParameter [syncToken] is invalid\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadMessages] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadMessages] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"syncMessages", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidmessagesync-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"query", "name"=>"conversationId", "description"=>"Conversation identifier for the resulting messages"}, {"in"=>"query", "name"=>"dateFrom", "description"=>"The start datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52"}, {"in"=>"query", "name"=>"dateTo", "description"=>"The end datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52"}, {"in"=>"query", "name"=>"direction", "description"=>"Direction for the resulting messages"}, {"in"=>"query", "name"=>"distinctConversations", "description"=>"If True, then the latest messages per every conversation ID are returned"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"query", "name"=>"messageType", "description"=>"Type for the resulting messages"}, {"in"=>"query", "name"=>"recordCount", "description"=>"Limits the number of records to be returned (works in combination with dateFrom and dateTo if specified)"}, {"in"=>"query", "name"=>"syncToken", "description"=>"Value of syncToken property of last sync request response"}, {"in"=>"query", "name"=>"syncType", "description"=>"Type of message synchronization"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Message", "Sync"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out"=>{"post"=>{"summary"=>"Make RingOut Call", "description"=>"Makes a 2-leg RingOut call.\nApp Permission\nRingOut\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [phoneNumber] value is invalid\n\n\n400\nTEL-107\nCaller ID: [+18609411729] is not allowed\n\n\n400\nTEL-108\nphoneNumber specified in the from field is empty or invalid\n\n\n400\nTEL-109\nphoneNumber specified in the to field is empty or invalid\n\n\n403\nBIL-103\nFeature [RingOut] is not available for current account\n\n\n403\nCMN-112\nFeature [RingOut] is not available for current extension type\n\n\n403\nCMN-113\nFeature [DomesticCalls] is not available for current extension\n\n\n403\nRNG-102\nCaller ID should be one of company direct numbers\n\n\n403\nTEL-101\nphoneNumber specified in the to field: [17176704078] is in blocked list\n\n\n403\nTEL-102\nphoneNumber specified in the from field: [17176704078] is in blocked list\n\n\n403\nTEL-107\nCaller ID: [+12094441763] is not allowed\n\n\n404\nCMN-102\nResource for parameter [forwardingNumberId] is not found", "operationId"=>"makeRingOutCallNew", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidringout-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Make", "RingOut", "Call"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId}"=>{"get"=>{"summary"=>"Get Status of RingOut Call", "description"=>"Returns the status of a 2-leg RingOut call.\nApp Permission\nRingOut\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n503\nCMN-201\nService Temporary Unavailable", "operationId"=>"getRingOutCallStatusNew", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidringoutringoutid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"ringoutId", "description"=>"Internal identifier of a RingOut call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Status", "Of", "RingOut", "Call"]}, "delete"=>{"summary"=>"Cancel RingOut Call", "description"=>"Cancels a 2-leg RingOut call.\nApp Permission\nRingOut\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n404\nCMN-102\nResource for parameter [ringOutId] is not found", "operationId"=>"cancelRingOutCallNew", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidringoutringoutid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"ringoutId", "description"=>"Internal identifier of a RingOut call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "RingOut", "Call"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout"=>{"post"=>{"summary"=>"Make RingOut Call", "description"=>"Makes a 2-leg RingOut call.\nApp Permission\nRingOut\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [phoneNumber] value is invalid\n\n\n400\nTEL-107\nCaller ID: [+14152961727] is not allowed\n\n\n400\nTEL-108\nphoneNumber specified in the from field is empty or invalid\n\n\n400\nTEL-109\nphoneNumber specified in the to field is empty or invalid\n\n\n403\nBIL-103\nFeature [RingOut] is not available for current account\n\n\n403\nCMN-112\nFeature [RingOut] is not available for current extension type\n\n\n403\nCMN-113\nFeature [DomesticCalls] is not available for current extension\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [RingOut] permission\n\n\n403\nRNG-102\nCaller ID should be one of company direct numbers\n\n\n403\nTEL-101\nphoneNumber specified in the to field: [17176704073] is in blocked list\n\n\n403\nTEL-102\nphoneNumber specified in the from field: [17172302150] is in blocked list\n\n\n403\nTEL-107\nCaller ID: [+12094441789] is not allowed\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"makeRingOutCall", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidringout-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Make", "RingOut", "Call"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout/{ringoutId}"=>{"get"=>{"summary"=>"Get Status of RingOut Call", "description"=>"Returns status of a 2-leg RingOut call.\nApp Permission\nRingOut\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [RingOut] permission\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"getRingOutCallStatus", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidringoutringoutid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"ringoutId", "description"=>"Internal identifier of a RingOut call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Status", "Of", "RingOut", "Call"]}, "delete"=>{"summary"=>"Cancel RingOut Call", "description"=>"Cancels a 2-leg RingOut call.\nApp Permission\nRingOut\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"cancelRingOutCall", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidringoutringoutid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"ringoutId", "description"=>"Internal identifier of a RingOut call"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "RingOut", "Call"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact"=>{"get"=>{"summary"=>"Get Contacts", "description"=>"Returns user personal contacts.\nApp Permission\nReadContacts\nUser Permission\nReadPersonalContacts\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [perPage] value is invalid\n\n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadContacts] permission\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"listContacts", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidaddressbookcontact-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}, {"in"=>"query", "name"=>"phoneNumber"}, {"in"=>"query", "name"=>"sortBy", "description"=>"Sorts results by the specified property"}, {"in"=>"query", "name"=>"startsWith", "description"=>"If specified, only contacts whose First name or Last name start with the mentioned substring are returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contacts"]}, "post"=>{"summary"=>"Create Contact", "description"=>"Creates personal user contact.\nApp Permission\nContacts\nUser Permission\nEditPersonalContacts\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [notes] value is invalid\n\n\n400\nPAB-102\nParameter [assistantPhone] is invalid. Failed to parse phone number.\n\n\n400\nPAB-103\nParameter [assistantPhone] is invalid. The phone number is too long.\n\n\n400\nPAB-104\nParameter [assistantPhone] is invalid. The phone numbers starting with the asterisk are not supported.\n\n\n400\nPAB-105\nParameter [assistantPhone] is invalid. The extensions longer than 10 digits are not supported.\n\n\n400\nPAB-106\nParameter [assistantPhone] is invalid. The DTMF sequences longer than 64 digits are not supported.\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [Contacts] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [EditPersonalContacts] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"createContact", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidaddressbookcontact-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dialingPlan", "description"=>"A country code value complying with the [ISO 3166-1 alpha-2](https://ru"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}"=>{"get"=>{"summary"=>"Get Contact(s) by ID", "description"=>"Returns contact(s) by ID(s). Batch request is supported.\nApp Permission\nReadContacts\nUser Permission\nReadPersonalContacts\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadContacts] permission\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"loadContact", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidaddressbookcontactcontactid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"contactId", "description"=>"Internal identifier of a contact record in the RingCentral database"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact(s)", "By", "ID"]}, "put"=>{"summary"=>"Update Contact(s) by ID", "description"=>"Updates personal contact information by contact ID(s). Batch request is supported\nApp Permission\nContacts\nUser Permission\nEditPersonalContacts\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [notes] value is invalid\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [Contacts] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [EditPersonalContacts] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"updateContact", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidaddressbookcontactcontactid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"contactId", "description"=>"Internal identifier of a contact record in the RingCentral database"}, {"in"=>"query", "name"=>"dialingPlan", "description"=>"A country code value complying with the [ISO 3166-1 alpha-2](https://ru"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact(s)", "By", "ID"]}, "delete"=>{"summary"=>"Delete Contact(s) by ID", "description"=>"Deletes contact(s) by ID(s). Batch request is supported.\nApp Permission\nContacts\nUser Permission\nEditPersonalContacts\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [Contacts] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [EditPersonalContacts] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"deleteContact", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidaddressbookcontactcontactid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"contactId", "description"=>"Internal identifier of a contact record in the RingCentral database"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact(s)", "By", "ID"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite"=>{"get"=>{"summary"=>"Get Favorite Contacts", "description"=>"Returns favorite contacts of the current extension. Favorite contacts include both company contacts (extensions) and personal contacts (address book records).\nApp Permission\nReadContacts\nUser Permission\nReadPersonalContacts\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadContacts] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadPersonalContacts] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"listFavoriteContacts", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidfavorite-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Favorite", "Contacts"]}, "put"=>{"summary"=>"Update Favorite Contacts", "description"=>"Updates favorite contacts of the current extension. Favorite contacts include both company contacts (extensions) and personal contacts (address book records).**Please note**: currently personal address book size is limited to 10 000 contacts.\nApp Permission\nContacts\nUser Permission\nEditPersonalContacts\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [records.extensionId] value is invalid\n\n\n400\nFAV-100\nContact not found\n\n\n400\nFAV-101\nMore than one contact with the same [records.extensionId]\n\n\n400\nFAV-102\n[records.extensionId] and [records.contactId] could not be specified for one contact simultaneously\n\n\n400\nFAV-103\nMore than one contact with the same [records.id]\n\n\n400\nFAV-104\nContact limit exceeded\n\n\n400\nFAV-105\nContact not found in federated directory\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [Contacts] permission\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"updateFavoriteContacts", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidfavorite-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Favorite", "Contacts"]}}, "/restapi/v1.0/account/{accountId}/directory/contacts"=>{"get"=>{"summary"=>"Get Corporate Directory Contacts", "description"=>"Returns contact information on corporate users of federated accounts. Please note: 1. User, DigitalUser, VirtualUser and FaxUser types are returned as User type. 2.ApplicationExtension type is not returned. 3. Only extensions in Enabled, Disabled and NotActivated state are returned.\nApp Permission\nReadAccounts\nUsage Plan Group\nMedium", "operationId"=>"listDirectoryContacts", "x-api-path-slug"=>"restapiv1-0accountaccountiddirectorycontacts-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"accountId"}, {"in"=>"query", "name"=>"excludeFederatedContacts", "description"=>"excludeFederatedContacts"}, {"in"=>"header", "name"=>"If-None-Match", "description"=>"If-None-Match"}, {"in"=>"query", "name"=>"page", "description"=>"page"}, {"in"=>"query", "name"=>"perPage", "description"=>"perPage"}, {"in"=>"query", "name"=>"siteId", "description"=>"Internal identifier of the business site to which extensions belongs"}, {"in"=>"query", "name"=>"type", "description"=>"Type of an extension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Corporate", "Directory", "Contacts"]}}, "/restapi/v1.0/account/{accountId}/directory/contacts/{contactId}"=>{"get"=>{"summary"=>"Get Corporate Directory Contact", "description"=>"Returns contact information on a particular corporate user of a federated account.\nApp Permission\nReadAccounts\nUsage Plan Group\nMedium", "operationId"=>"loadDirectoryContact", "x-api-path-slug"=>"restapiv1-0accountaccountiddirectorycontactscontactid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of owning account"}, {"in"=>"path", "name"=>"contactId", "description"=>"Internal identifier of extension to read information for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Corporate", "Directory", "Contact"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence"=>{"get"=>{"summary"=>"Get User Status", "description"=>"Returns presence status of an extension or several extensions by their ID(s). Batch request is supported. The 'presenceStatus' is returned as Offline (the parameters 'telephonyStatus', 'message', 'userStatus' and 'dndStatus' are not returned at all) for the following extension types: Department/Announcement Only/Take Messages Only (Voicemail)/Fax User/Paging Only Group/Shared Lines Group/IVR Menu/Application Extension/Park Location.If the user requests his/her own presence status, the response contains actual presence status even if the status publication is turned off. Batch request is supported. For batch requests the number of extensions in one request is limited to 30. If more extensions are included in the request, the error code 400 Bad Request is returned with the logical error code InvalidMultipartRequest and the corresponding message 'Extension Presence Info multipart request is limited to 30 extensions'.\nApp Permission\nReadPresence\nUser Permission\nReadPresenceStatus\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadPresenceStatus] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"getPresenceStatus", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidpresence-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"query", "name"=>"detailedTelephonyState", "description"=>"Whether to return detailed telephony state"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"query", "name"=>"sipData", "description"=>"Whether to return SIP data"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Status"]}, "put"=>{"summary"=>"Update User Status", "description"=>"Updates user-defined extension presence status, status message and DnD status by extension ID. Supported for regular User extensions only. The extension types listed do not support presence status: Department, Announcement Only, Take Messages Only (Voicemail), Fax User, Paging Only Group, Shared Lines Group, IVR Menu, Application Extension.\nApp Permission\nEditPresence\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [allowSeeMyPresence] value is invalid\n\n\n403\nBIL-103\nFeature [DND] is not available for current account\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [EditPresenceSettings] permission for requested resource.\n\n\n403\nPRS-105\nNot allowed update presence for extensions having Disabled state\n\n\n403\nPRS-106\nNot allowed update presence for extensions of Department type\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"updatePresenceStatus", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidpresence-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Status"]}}, "/restapi/v1.0/glip/groups"=>{"get"=>{"summary"=>"Get User Groups", "description"=>"Returns the list of groups associated with the user.\nApp Permission\nGlip\nUser Permission\nGlip\nUsage Plan Group\nMedium", "operationId"=>"listGlipGroups", "x-api-path-slug"=>"restapiv1-0glipgroups-get", "parameters"=>[{"in"=>"query", "name"=>"pageToken", "description"=>"Token of a page to be returned"}, {"in"=>"query", "name"=>"recordCount", "description"=>"Max numbers of records to be returned"}, {"in"=>"query", "name"=>"type", "description"=>"Type of a group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Groups"]}, "post"=>{"summary"=>"Create Group", "description"=>"Creates a group.\nApp Permission\nGlip\nUser Permission\nGlip\nUsage Plan Group\nMedium", "operationId"=>"createGlipGroup", "x-api-path-slug"=>"restapiv1-0glipgroups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}}, "/restapi/v1.0/glip/groups/{groupId}"=>{"get"=>{"summary"=>"Get Group", "description"=>"Returns a group or multiple groups by their ID(s). Batch request is supported.\nApp Permission\nGlip\nUser Permission\nGlip\nUsage Plan Group\nLight", "operationId"=>"loadGlipGroup", "x-api-path-slug"=>"restapiv1-0glipgroupsgroupid-get", "parameters"=>[{"in"=>"path", "name"=>"groupId", "description"=>"Internal identifier of a group to be returned, the maximum number of IDs is 30"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group"]}}, "/restapi/v1.0/glip/groups/{groupId}/bulk-assign"=>{"post"=>{"summary"=>"Edit Group Members", "description"=>"Updates group members. Please note: Only groups of 'Team' type can be updated. Currently only one operation at a time (either adding or removal) is supported.\nApp Permission\nGlip\nUser Permission\nGlip\nUsage Plan Group\nMedium", "operationId"=>"assignGlipGroupMembers", "x-api-path-slug"=>"restapiv1-0glipgroupsgroupidbulkassign-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"groupId", "description"=>"Internal identifier of a group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Group", "Members"]}}, "/restapi/v1.0/glip/groups/{groupId}/posts"=>{"get"=>{"summary"=>"Get Group Posts", "description"=>"Returns posts which are available for the current user (by group ID). The maximum number of posts returned is 250.\nUsage Plan Group\nMedium", "operationId"=>"listGlipGroupPosts", "x-api-path-slug"=>"restapiv1-0glipgroupsgroupidposts-get", "parameters"=>[{"in"=>"path", "name"=>"groupId", "description"=>"Internal identifier of a group"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Pagination token"}, {"in"=>"query", "name"=>"recordCount", "description"=>"Max number of records to be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group", "S"]}, "post"=>{"summary"=>"Create Post in Group", "description"=>"Creates a new post in a group specified.\nUsage Plan Group\nMedium", "operationId"=>"createGlipGroupPost", "x-api-path-slug"=>"restapiv1-0glipgroupsgroupidposts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"groupId", "description"=>"Internal identifier of a group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["In", "Group"]}}, "/restapi/v1.0/glip/groups/{groupId}/posts/{postId}/text"=>{"put"=>{"summary"=>"Update Post", "description"=>"Modifies text of a post\nUsage Plan Group\nMedium", "operationId"=>"updateGlipPostText", "x-api-path-slug"=>"restapiv1-0glipgroupsgroupidpostspostidtext-put", "parameters"=>[{"in"=>"path", "name"=>"groupId", "description"=>"Internal identifier of a group"}, {"in"=>"path", "name"=>"postId", "description"=>"Internal identifier of a post"}, {"in"=>"body", "name"=>"text", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/restapi/v1.0/glip/posts"=>{"get"=>{"summary"=>"Get Posts", "description"=>"Returns list of posts.\nApp Permission\nGlip\nUser Permission\nGlip\nUsage Plan Group\nLight", "operationId"=>"listGlipPosts", "x-api-path-slug"=>"restapiv1-0glipposts-get", "parameters"=>[{"in"=>"query", "name"=>"groupId", "description"=>"Identifier of a group to filter posts"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token of a page to be returned"}, {"in"=>"query", "name"=>"recordCount", "description"=>"Max number of records to be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S"]}, "post"=>{"summary"=>"Create Post", "description"=>"Creates a post.\nApp Permission\nGlip\nUser Permission\nGlip\nUsage Plan Group\nLight", "operationId"=>"createPost", "x-api-path-slug"=>"restapiv1-0glipposts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}, "/restapi/v1.0/glip/files"=>{"post"=>{"summary"=>"Upload File", "description"=>"Posts a file.\nApp Permission\nGlip\nUser Permission\nGlip\nUsage Plan Group\nHeavy", "operationId"=>"createGlipFile", "x-api-path-slug"=>"restapiv1-0glipfiles-post", "parameters"=>[{"in"=>"formData", "name"=>"body", "description"=>"The file to upload"}, {"in"=>"query", "name"=>"groupId", "description"=>"Internal identifier of a group to which the post with attachement will be added to"}, {"in"=>"formData", "name"=>"name", "description"=>"Name of a file attached"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "File"]}}, "/restapi/v1.0/glip/persons/{personId}"=>{"get"=>{"summary"=>"Get Person", "description"=>"Returns a user or multiple users by their ID(s). Batch request is supported.\nApp Permission\nGlip\nUser Permission\nGlip\nUsage Plan Group\nLight", "operationId"=>"loadGlipPerson", "x-api-path-slug"=>"restapiv1-0glippersonspersonid-get", "parameters"=>[{"in"=>"path", "name"=>"personId", "description"=>"Internal identifier of a user to be returned, the maximum number of IDs is 30"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Person"]}}, "/restapi/v1.0/glip/companies/{companyId}"=>{"get"=>{"summary"=>"Get Company Info", "description"=>"Returns a company by ID.\nApp Permission\nGlip\nUser Permission\nGlip\nUsage Plan Group\nLight", "operationId"=>"loadGlipCompany", "x-api-path-slug"=>"restapiv1-0glipcompaniescompanyid-get", "parameters"=>[{"in"=>"path", "name"=>"companyId", "description"=>"Internal identifier of an RC account/Glip company, or tilde (~) to indicate a company the current user belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Info"]}}, "/restapi/v1.0/glip/groups/{groupId}/webhooks"=>{"post"=>{"summary"=>"Create Webhook in Group", "description"=>"Create new Webhook\nUsage Plan Group\nMedium", "operationId"=>"createGlipGroupWebhook", "x-api-path-slug"=>"restapiv1-0glipgroupsgroupidwebhooks-post", "parameters"=>[{"in"=>"path", "name"=>"groupId", "description"=>"Group id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook", "In", "Group"]}, "get"=>{"summary"=>"Get Webhooks in Group", "description"=>"Returns webhooks which are available for the current user (by group ID).\nUsage Plan Group\nMedium", "operationId"=>"listGlipGroupWebhooks", "x-api-path-slug"=>"restapiv1-0glipgroupsgroupidwebhooks-get", "parameters"=>[{"in"=>"path", "name"=>"groupId", "description"=>"Internal identifier of a group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks", "In", "Group"]}}, "/restapi/v1.0/glip/webhooks"=>{"get"=>{"summary"=>"Get Webhooks", "description"=>"Returns all webhooks.\nUsage Plan Group\nMedium", "operationId"=>"listGlipWebhooks", "x-api-path-slug"=>"restapiv1-0glipwebhooks-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhooks"]}}, "/restapi/v1.0/glip/webhooks/{webhookId}"=>{"get"=>{"summary"=>"Get Webhook", "description"=>"Returns webhooks(s) with the specified id(s).\nUsage Plan Group\nMedium", "operationId"=>"loadGlipWebhook", "x-api-path-slug"=>"restapiv1-0glipwebhookswebhookid-get", "parameters"=>[{"in"=>"path", "name"=>"webhookId", "description"=>"Internal identifier of a webhook or comma separated list of webhooks IDs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook"]}, "delete"=>{"summary"=>"Delete Webhook", "description"=>"Deletes the webhook by ID.\nUsage Plan Group\nMedium", "operationId"=>"deleteGlipWebhook", "x-api-path-slug"=>"restapiv1-0glipwebhookswebhookid-delete", "parameters"=>[{"in"=>"path", "name"=>"webhookId", "description"=>"Internal identifier of a webhook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Webhook"]}}, "/restapi/v1.0/glip/webhooks/{webhookId}/activate"=>{"post"=>{"summary"=>"Activate Webhook", "description"=>"Activates webhooks by ID.\nUsage Plan Group\nMedium", "operationId"=>"activateGlipWebhook", "x-api-path-slug"=>"restapiv1-0glipwebhookswebhookidactivate-post", "parameters"=>[{"in"=>"path", "name"=>"webhookId", "description"=>"Internal identifier of a webhook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Activate", "Webhook"]}}, "/restapi/v1.0/glip/webhooks/{webhookId}/suspend"=>{"post"=>{"summary"=>"Suspend Webhook", "description"=>"Suspends webhooks by ID.\nUsage Plan Group\nMedium", "operationId"=>"suspendGlipWebhook", "x-api-path-slug"=>"restapiv1-0glipwebhookswebhookidsuspend-post", "parameters"=>[{"in"=>"path", "name"=>"webhookId", "description"=>"Internal identifier of a webhook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Suspend", "Webhook"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting"=>{"get"=>{"summary"=>"Get Scheduled Meetings [Beta]", "description"=>"Returns a list of meetings for a particular extension. The list of meetings does not include meetings of 'Instant' type.\nApp Permission\nMeetings\nUser Permission\nMeetings\nUsage Plan Group\nLight", "operationId"=>"listMeetings", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidmeeting-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Scheduled", "Meetings", "[Beta]"]}, "post"=>{"summary"=>"Create Meetings [Beta]", "description"=>"Creates a new meeting.\nApp Permission\nMeetings\nUser Permission\nMeetings\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [schedule] value is invalid\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"createMeeting", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidmeeting-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meetings", "[Beta]"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}"=>{"get"=>{"summary"=>"Get Meeting Info [Beta]", "description"=>"Returns a particular meetings details by ID.\nApp Permission\nMeetings\nUser Permission\nMeetings\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n404\nCMN-102\nResource for parameter [meetingId] is not found", "operationId"=>"loadMeeting", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidmeetingmeetingid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"meetingId", "description"=>"Internal identifier of a RingCentral meeting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meeting", "Info", "[Beta]"]}, "put"=>{"summary"=>"Update Meeting", "description"=>"Modifies a particular meeting.\nApp Permission\nMeetings\nUser Permission\nMeetings\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [password] value is invalid\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"updateMeeting", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidmeetingmeetingid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"meetingId", "description"=>"Internal identifier of a RingCentral meeting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meeting"]}, "delete"=>{"summary"=>"Delete Meeting", "description"=>"Deletes a scheduled meeting.\nApp Permission\nMeetings\nUser Permission\nMeetings\nUsage Plan Group\nMedium", "operationId"=>"deleteMeeting", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidmeetingmeetingid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"meetingId", "description"=>"Internal identifier of a RingCentral meeting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meeting"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}/end"=>{"post"=>{"summary"=>"End Meeting", "description"=>"Ends a meetings which is in progress.\nApp Permission\nMeetings\nUser Permission\nMeetings\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n404\nCMN-102\nResource for parameter [meetingId] is not found", "operationId"=>"endMeeting", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidmeetingmeetingidend-post", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"meetingId", "description"=>"Internal identifier of a RingCentral meeting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["End", "Meeting"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/service-info"=>{"get"=>{"summary"=>"Get Meeting Service Info", "description"=>"Returns information on dial-in numbers for meetings, support and international dial-in numbers URIs and meeting account information.\nApp Permission\nMeetings\nUser Permission\nMeetings\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [Meetings] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [Meetings] permission for requested resource.", "operationId"=>"loadMeetingServiceInfo", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidmeetingserviceinfo-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Meeting", "Service", "Info"]}}, "/restapi/v1.0/subscription"=>{"get"=>{"summary"=>"Get Subscriptions", "description"=>"Returns a list of subscriptions created by a particular user on a particular client app.\nUsage Plan Group\nLight", "operationId"=>"listSubscriptions", "x-api-path-slug"=>"restapiv1-0subscription-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}, "post"=>{"summary"=>"Create Subscription", "description"=>"Creates a new subscription.\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [deliveryMode.verificationToken] value is invalid\n\n\n400\nSUB-515\nSubscription containing only reminder filter is not allowed\n\n\n400\nSUB-522\nWebHook responds with incorrect HTTP status. HTTP status is 500\n\n\n400\nSUB-525\nWebHook server response is invalid\n\n\n401\nAGW-401\nAuthorization header is not specified\n\n\n401\nAGW-402\nInvalid Authorization header\n\n\n401\nCMN-405\nLogin to extension required\n\n\n403\nSUB-406\nNot allowed subscribe for events to extensions of other account\n\n\n403\nSUB-408\nNot allowed subscribe for unknown user\n\n\n403\nSUB-505\nSubscriptions limit exceeded\n\n\n403\nSUB-518\nNot allowed subscribe for favorite contacts list changes of another extension\n\n\n403\nSUB-527\nNot allowed subscribe for missed calls of another extension\n\n\n403\nSUB-528\n[SubscriptionAPNS] application permission is required for [PubNub/APNS] transport\n\n\n403\nSUB-530\nNot allowed subscribe for incoming calls of another extension\n\n\n403\nSUB-531\nNot allowed subscribe for presence of presence-lines of another extension\n\n\n404\nCMN-102\nResource for parameter [dashboardId] is not found", "operationId"=>"createSubscription", "x-api-path-slug"=>"restapiv1-0subscription-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/restapi/v1.0/subscription/{subscriptionId}"=>{"get"=>{"summary"=>"Get Subscription", "description"=>"Returns the requested subscription.\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n404\nCMN-102\nResource for parameter [subscriptionId] is not found\n\n\n404\nCMN-120\nInvalid URI", "operationId"=>"loadSubscription", "x-api-path-slug"=>"restapiv1-0subscriptionsubscriptionid-get", "parameters"=>[{"in"=>"path", "name"=>"subscriptionId", "description"=>"Internal identifier of a subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}, "put"=>{"summary"=>"Renew Subscription / Update Event Filters", "description"=>"Renews the existent subscription if the request body is empty. If event filters are specified, calling this method modifies the event filters for the existing subscription. The client application can extend or narrow the events for which it receives notifications in the frame of one subscription.\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n404\nCMN-102\nResource for parameter [subscriptionId] is not found", "operationId"=>"updateSubscription", "x-api-path-slug"=>"restapiv1-0subscriptionsubscriptionid-put", "parameters"=>[{"in"=>"query", "name"=>"aggregated", "description"=>"If True then aggregated presence status is returned in a notification payload"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"subscriptionId", "description"=>"Internal identifier of a subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Renew", "Subscription", "", "", "", "Event", "Filters"]}, "delete"=>{"summary"=>"Cancel Subscription", "description"=>"Cancels the existent subscription.\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n404\nCMN-102\nResource for parameter [subscriptionId] is not found", "operationId"=>"deleteSubscription", "x-api-path-slug"=>"restapiv1-0subscriptionsubscriptionid-delete", "parameters"=>[{"in"=>"path", "name"=>"subscriptionId", "description"=>"Internal identifier of a subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Subscription"]}}, "/restapi/v1.0/subscription/{subscriptionId}/renew"=>{"post"=>{"summary"=>"Renew Subscription", "description"=>"Renews an existent subscription by ID by posting request with an empty body.\nUsage Plan Group\nLight", "operationId"=>"renewSubscription", "x-api-path-slug"=>"restapiv1-0subscriptionsubscriptionidrenew-post", "parameters"=>[{"in"=>"path", "name"=>"subscriptionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Renew", "Subscription"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile"=>{"get"=>{"summary"=>"Get User Permissions", "description"=>"Returns a list of user permissions granted at authorization procedure. Please note: Some permissions may be restricted by extension type.\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-404\nAttempt to access another extension\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"getAuthorizationProfile", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidauthzprofile-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"extensionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Permissions"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile/check"=>{"get"=>{"summary"=>"Check User Permissions", "description"=>"Checks if a certain user permission is activated for a particular extension.\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [targetExtensionId] value is invalid\n\n\n403\nCMN-404\nAttempt to access another extension\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"checkUserPermission", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidauthzprofilecheck-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"extensionId"}, {"in"=>"query", "name"=>"permissionId"}, {"in"=>"query", "name"=>"targetExtensionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Check", "User", "Permissions"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hours"=>{"get"=>{"summary"=>"Get User Business Hours", "description"=>"Returns the extension user hours when answering rules are to be applied.\nApp Permission\nReadAccounts\nUser Permission\nReadExtensions\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadUserAnsweringRules] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"loadUserBusinessHours", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidbusinesshours-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Business", "Hours"]}, "put"=>{"summary"=>"Update User Business Hours", "description"=>"Updates the extension user hours when answering rules are to be applied.\nApp Permission\nEditExtensions\nUser Permission\nEditUserAnsweringRules\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [ranges] value is invalid\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [EditExtensions] permission\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"updateUserBusinessHours", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidbusinesshours-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Business", "Hours"]}}, "/restapi/v1.0/account/{accountId}/business-hours"=>{"get"=>{"summary"=>"Get Company Business Hours", "description"=>"Returns company hours when answering rules are to be applied.\nApp Permission\nReadAccounts\nUser Permission\nReadUserAnsweringRules\nUsage Plan Group\nLight", "operationId"=>"loadBusinesshoursInfo", "x-api-path-slug"=>"restapiv1-0accountaccountidbusinesshours-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Business", "Hours"]}, "put"=>{"summary"=>"Update Company Business Hours", "description"=>"Updates company hours when answering rules are to be applied.\nApp Permission\nEditExtensions\nUser Permission\nEditUserAnsweringRules\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nAWR-176\nAt least one time range for [monday] required\n\n\n400\nAWR-177\nTime ranges limit for [monday] exceeded\n\n\n400\nCMN-101\nParameter [schedule.weeklyRanges] value is invalid", "operationId"=>"updateCompanyBusinessHours", "x-api-path-slug"=>"restapiv1-0accountaccountidbusinesshours-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Business", "Hours"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number"=>{"get"=>{"summary"=>"Get Blocked Numbers", "description"=>"Returns the list of phone numbers which are specified by the user to block inbound calls and SMS messages.\nApp Permission\nReadAccounts\nUser Permission\nReadBlockedNumbers\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [perPage] value is invalid\n\n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadBlockedNumbers] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"listBlockedNumbers", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidblockednumber-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blocked", "Numbers"]}, "post"=>{"summary"=>"Add Blocked Numbers", "description"=>"Adds a new phone number to the blocked number list.\nApp Permission\nEditExtensions\nUser Permission\nEditBlockedNumbers\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [phoneNumber] value is invalid\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [EditExtensions] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [EditBlockedNumbers] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"blockNumber", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidblockednumber-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blocked", "Numbers"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number/{blockedNumberId}"=>{"get"=>{"summary"=>"Get Blocked Number", "description"=>"Returns specific information on blocked phone number(s) by their ID(s). Batch request is supported.\nApp Permission\nReadAccounts\nUser Permission\nReadBlockedNumbers\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadBlockedNumbers] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"loadBlockedNumber", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidblockednumberblockednumberid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"blockedNumberId", "description"=>"Internal identifiers of a blocked number list entry"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blocked", "Number"]}, "put"=>{"summary"=>"Update Blocked Number", "description"=>"Updates blocked number(s) by their ID(s). Currently only the name can be updated. Batch request is supported.\nApp Permission\nEditExtensions\nUser Permission\nEditBlockedNumbers\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [] value is invalid\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [EditExtensions] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [EditBlockedNumbers] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"updateBlockedNumber", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidblockednumberblockednumberid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"blockedNumberId", "description"=>"Internal identifier of a blocked number list entry"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blocked", "Number"]}, "delete"=>{"summary"=>"Delete Blocked Number", "description"=>"Deletes a phone number from the blocked number list. Batch request is supported.\nApp Permission\nEditExtensions\nUser Permission\nEditBlockedNumbers\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [EditExtensions] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [EditBlockedNumbers] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"unblockNumber", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidblockednumberblockednumberid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"blockedNumberId", "description"=>"Internal identifiers of a blocked number list entry"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blocked", "Number"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking"=>{"get"=>{"summary"=>"Get Caller Blocking Settings", "description"=>"Returns the current call blocking settings of a user.\nApp Permission\nReadAccounts\nUser Permission\nReadBlockedNumbers\nUsage Plan Group\nLight", "operationId"=>"listCallBlockingSettings", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidcallerblocking-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"extensionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Caller", "Blocking", "Settings"]}, "put"=>{"summary"=>"Update Caller Blocking Settings", "description"=>"Updates the current call blocking settings of a user.\nApp Permission\nEditExtensions\nUser Permission\nEditBlockedNumbers\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [greetings] value is invalid", "operationId"=>"updateCallBlockingSettings", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidcallerblocking-put", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"extensionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Caller", "Blocking", "Settings"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers"=>{"get"=>{"summary"=>"Get Blocked Numbers", "description"=>"Returns the lists of blocked and allowed phone numbers.\nApp Permission\nReadAccounts\nUser Permission\nReadBlockedNumbers\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"listBlockedAllowedPhoneNumberLists", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidcallerblockingphonenumbers-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"extensionId"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"perPage"}, {"in"=>"query", "name"=>"status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blocked", "Numbers"]}, "post"=>{"summary"=>"Add Blocked Number", "description"=>"Updates either blocked or allowed phone number list with a new phone number.\nApp Permission\nEditExtensions\nUser Permission\nEditBlockedNumbers\nUsage Plan Group\nMedium", "operationId"=>"createBlockedAllowedPhoneNumberLists", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidcallerblockingphonenumbers-post", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"extensionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blocked", "Number"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{blockedNumberId}"=>{"get"=>{"summary"=>"Get Blocked Number", "description"=>"Returns blocked or allowed phone number(s) by their ID(s). Batch request is supported.\nApp Permission\nReadAccounts\nUser Permission\nReadBlockedNumbers\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"listBlockedAllowedPhoneNumber", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidcallerblockingphonenumbersblockednumberid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"blockedNumberId"}, {"in"=>"path", "name"=>"extensionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blocked", "Number"]}, "delete"=>{"summary"=>"Delete Blocked Number", "description"=>"Deletes blocked or allowed phone number(s) by their ID(s). Batch request is supported.\nApp Permission\nEditExtensions\nUser Permission\nEditBlockedNumbers\nUsage Plan Group\nMedium", "operationId"=>"deleteBlockedAllowedPhoneNumber", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidcallerblockingphonenumbersblockednumberid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"blockedNumberId"}, {"in"=>"path", "name"=>"extensionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blocked", "Number"]}, "put"=>{"summary"=>"Update Blocked Number", "description"=>"Updates blocked or allowed phone number(s) by their ID(s). Batch request is supported.\nApp Permission\nEditExtensions\nUser Permission\nEditBlockedNumbers\nUsage Plan Group\nMedium", "operationId"=>"updateBlockedAllowedPhoneNumber", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidcallerblockingphonenumbersblockednumberid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"blockedNumberId"}, {"in"=>"path", "name"=>"extensionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blocked", "Number"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number"=>{"get"=>{"summary"=>"Get Forwarding Numbers", "description"=>"Returns the list of extension phone numbers used for call forwarding and call flip. The returned list contains all the extension phone numbers used for call forwarding and call flip.\nApp Permission\nReadAccounts\nUser Permission\nReadUserForwardingFlipNumbers\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [perPage] value is invalid\n\n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n403\nCMN-403\nThe feature is not available for this extension type\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadUserForwardingFlipNumbers] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"listExtensionForwardingNumbers", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidforwardingnumber-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forwarding", "Numbers"]}, "post"=>{"summary"=>"Create Forwarding Numbers", "description"=>"Adds a new forwarding number to the forwarding number list.\nApp Permission\nEditExtensions\nUser Permission\nEditUserForwardingFlipNumbers\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nAWR-180\nCall handling settings not available for Fax tiers\n\n\n400\nCMN-101\nParameter [phoneNumber] value is invalid\n\n\n400\nFPN-102\nLabel of number Work duplicates with existing forwarding number label\n\n\n400\nFPN-103\nLimit of available forwarding numbers (10) exceeded\n\n\n400\nFPN-104\nLimit of available custom labeled forwarding numbers (7) exceeded\n\n\n400\nFPN-105\nNumber +18442015485 duplicates with company/extension direct number\n\n\n400\nFPN-108\nInternational calling is currently disabled\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [EditExtensions] permission\n\n\n403\nCMN-403\nThe feature is not available for this extension type\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"createExtensionForwardingNumber", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidforwardingnumber-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forwarding", "Numbers"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId}"=>{"get"=>{"summary"=>"Get Forwarding Number", "description"=>"Returns a specific forwarding number.\nApp Permission\nReadAccounts\nUser Permission\nReadUserForwardingFlipNumbers\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n403\nCMN-403\nThe feature is not available for this extension type\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadUserForwardingFlipNumbers] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"getForwardingNumber", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidforwardingnumberforwardingnumberid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"extensionId"}, {"in"=>"path", "name"=>"forwardingNumberId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forwarding", "Number"]}, "put"=>{"summary"=>"Update Forwarding Numbers", "description"=>"Updates the existing forwarding number from the forwarding number list.\nApp Permission\nEditExtensions\nUser Permission\nEditUserForwardingFlipNumbers\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [flipNumber] value is invalid\n\n\n400\nFPN-102\nLabel of number Home duplicates with existing forwarding number label\n\n\n400\nFPN-105\nNumber +18552050457 duplicates with company/extension direct number\n\n\n400\nFPN-106\nFlip number 2 is already in use\n\n\n400\nFPN-108\nInternational calling is currently disabled\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [EditExtensions] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [EditUserForwardingFlipNumbers] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [forwardingNumberId] is not found", "operationId"=>"updateExtensionForwardingNumber", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidforwardingnumberforwardingnumberid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"forwardingNumberId", "description"=>"Internal identifier of a forwarding number; returned in response in the id field"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forwarding", "Numbers"]}, "delete"=>{"summary"=>"Delete Forwarding Number", "description"=>"Deletes a forwarding number from the forwarding number list by its ID.\nApp Permission\nEditExtensions\nUser Permission\nEditUserForwardingFlipNumbers\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [EditUserForwardingFlipNumbers] permission for requested resource.\n\n\n403\nFPN-107\nDevice number cannot be deleted from the forwarding number list\n\n\n404\nCMN-102\nResource for parameter [forwardingNumberId] is not found", "operationId"=>"deleteExtensionForwardingNumber", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidforwardingnumberforwardingnumberid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"forwardingNumberId", "description"=>"Internal identifier of a forwarding number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forwarding", "Number"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule"=>{"get"=>{"summary"=>"Get Call Handling Rules", "description"=>"Returns the extension answering rules.\nApp Permission\nReadAccounts\nUser Permission\nReadUserAnsweringRules\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [perPage] value is invalid\n\n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadUserAnsweringRules] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"loadAnsweringRulesList", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidansweringrule-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"perPage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call", "Handling", "Rules"]}, "post"=>{"summary"=>"Create Custom Call Handling Rules", "description"=>"Creates a custom answering rule for a particular caller ID.\nApp Permission\nEditExtensions\nUser Permission\nEditUserAnsweringRules\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nAWR-100\nRule indexes should be sequential\n\n\n400\nAWR-101\nParameter [forwarding.rules[].forwardingNumbers[].id] are duplicated\n\n\n400\nAWR-106\nGreeting [Voicemail] is duplicated\n\n\n400\nAWR-107\nMore than one caller with the same [callerId]\n\n\n400\nAWR-108\nOnly custom rule can be created\n\n\n400\nAWR-111\nAt least one condition should be specified\n\n\n400\nAWR-113\nMore than one called number with the same [calledNumbers.phoneNumber]\n\n\n400\nAWR-121\nBusiness Hours not specified for current user\n\n\n400\nAWR-123\nPreset [131840] can not be used for greeting type [Voicemail]\n\n\n400\nAWR-124\npresetId specified for greeting type [Voicemail] is not found\n\n\n400\nAWR-125\nCustom greeting presetId specified for greeting type [Introductory]. Custom greeting uploading method should be used\n\n\n400\nAWR-126\nThe amount of schedule ranges exceeds 1000\n\n\n400\nAWR-136\nRing group with index 1 is not found\n\n\n400\nAWR-137\nRule index should be greater than 0\n\n\n400\nAWR-138\nContact center number cannot be used as called number\n\n\n400\nAWR-139\nHold audio interruption period not specified\n\n\n400\nAWR-140\nHold audio interruption period should be empty for interruption mode specified\n\n\n400\nAWR-144\nCall Queue agent with index 1 is not found\n\n\n400\nAWR-147\nPreset [65792] can not be used for extension type [Department]\n\n\n400\nAWR-148\nCall Queue agents should be the same as call queue members\n\n\n400\nAWR-149\nOnly user, voicemail or shared line group extension can be a voicemail recipient\n\n\n400\nAWR-150\nOnly user, voicemail, shared line group extension or current department can be a voicemail recipient\n\n\n400\nAWR-152\nVoicemail cannot be turned off for call queue extension\n\n\n400\nAWR-177\nTime ranges limit for [monday] exceeded\n\n\n400\nAWR-179\n[name] is too long: up to 127 symbols supported\n\n\n400\nCMN-101\nParameter [name] value is invalid\n\n\n400\nFPN-105\nNumber +16196093249 duplicates with company/extension direct number\n\n\n400\nFPN-108\nInternational calling is currently disabled\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [EditExtensions] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [EditUserAnsweringRules] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"createAnsweringRuleInfo", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidansweringrule-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Call", "Handling", "Rules"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}"=>{"get"=>{"summary"=>"Get Call Handling Rule", "description"=>"Returns an answering rule by ID.\nApp Permission\nReadAccounts\nUser Permission\nReadUserAnsweringRules\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [showInactiveNumbers] value is invalid\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n404\nCMN-102\nResource for parameter [answering-rule] is not found", "operationId"=>"loadAnsweringRuleInfo", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidansweringruleruleid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"ruleId", "description"=>"Internal identifier of an answering rule"}, {"in"=>"query", "name"=>"showInactiveNumbers", "description"=>"Indicates whether invactive numbers should be returned or not"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call", "Handling", "Rule"]}, "put"=>{"summary"=>"Update Custom Call Handling Rule", "description"=>"Updates a custom answering rule for a particular caller ID.\nApp Permission\nEditExtensions\nUser Permission\nEditUserAnsweringRules\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nAWR-100\nRule indexes should be sequential\n\n\n400\nAWR-106\nGreeting [Voicemail] is duplicated\n\n\n400\nAWR-111\nAt least one condition should be specified\n\n\n400\nAWR-113\nMore than one called number with the same [calledNumbers.phoneNumber]\n\n\n400\nAWR-120\nBusiness Hours/After Hours schedule condition is allowed only with other answering rule conditions\n\n\n400\nAWR-123\nPreset [131840] can not be used for greeting type [Voicemail]\n\n\n400\nAWR-124\npresetId specified for greeting type [Voicemail] is not found\n\n\n400\nAWR-136\nRing group with index 1 is not found\n\n\n400\nAWR-137\nRule index should be greater than 0\n\n\n400\nAWR-138\nContact center number cannot be used as called number\n\n\n400\nAWR-139\nHold audio interruption period not specified\n\n\n400\nAWR-140\nHold audio interruption period should be empty for interruption mode specified\n\n\n400\nAWR-144\nCall Queue agent with index 1 is not found\n\n\n400\nAWR-147\nPreset [65792] can not be used for extension type [Department]\n\n\n400\nAWR-148\nCall Queue agents should be the same as call queue members\n\n\n400\nAWR-179\n[name] is too long: up to 127 symbols supported\n\n\n400\nCMN-101\nParameter [callHandlingAction] value is invalid\n\n\n400\nFPN-105\nNumber +18332051179 duplicates with company/extension direct number\n\n\n400\nFPN-108\nInternational calling is currently disabled\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [EditExtensions] permission\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"updateAnsweringRuleInfo", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidansweringruleruleid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"ruleId", "description"=>"Internal identifier of an answering rule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Call", "Handling", "Rule"]}, "delete"=>{"summary"=>"Delete Call Handling Rule", "description"=>"Deletes a custom answering rule by a particular ID.\nApp Permission\nEditExtensions\nUser Permission\nEditUserAnsweringRules\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nAWR-110\nBusiness Hours/After Hours rule cannot be deleted\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [EditExtensions] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [EditUserAnsweringRules] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [answering-rule] is not found", "operationId"=>"deleteAnsweringRule", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidansweringruleruleid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"ruleId", "description"=>"Internal identifier of an answering rule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call", "Handling", "Rule"]}}, "/restapi/v1.0/account/{accountId}/answering-rule"=>{"post"=>{"summary"=>"Create Company Call Handling Rule", "description"=>"Creates a company answering rule for a particular caller ID.\nApp Permission\nEditAccounts\nUser Permission\nEditCompanyAnsweringRules\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nAWR-106\nGreeting [Company] is duplicated\n\n\n400\nAWR-108\nOnly custom rule can be created\n\n\n400\nAWR-120\nBusiness Hours/After Hours schedule condition is allowed only with other answering rule conditions\n\n\n400\nAWR-121\nBusiness Hours not specified for current user\n\n\n400\nAWR-170\nInvalid greeting type: preset with [CompanyGreeting] must be used\n\n\n400\nAWR-172\n[extension] must be specified for [Bypass] call handling action\n\n\n400\nAWR-173\n[extension] can be specified for [Bypass] call handling action only\n\n\n400\nAWR-179\n[name] is too long: up to 127 symbols supported\n\n\n400\nAWR-182\nOnly bypass action is available in multi-level IVR mode\n\n\n400\nCMN-101\nParameter [callHandlingAction] value is invalid", "operationId"=>"createCompanyAnsweringRuleInfo", "x-api-path-slug"=>"restapiv1-0accountaccountidansweringrule-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Call", "Handling", "Rule"]}, "get"=>{"summary"=>"Get Company Call Handling Rules", "description"=>"Returns a list of company answering rules.\nApp Permission\nReadAccounts\nUser Permission\nReadCompanyAnsweringRules\nUsage Plan Group\nMedium", "operationId"=>"listCompanyAnsweringRule", "x-api-path-slug"=>"restapiv1-0accountaccountidansweringrule-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Call", "Handling", "Rules"]}}, "/restapi/v1.0/account/{accountId}/answering-rule/{ruleId}"=>{"get"=>{"summary"=>"Get Company Call Handling Rule", "description"=>"Returns a company answering rule by ID.\nApp Permission\nReadAccounts\nUser Permission\nReadCompanyAnsweringRules\nUsage Plan Group\nLight", "operationId"=>"loadCompanyAnsweringRuleInfo", "x-api-path-slug"=>"restapiv1-0accountaccountidansweringruleruleid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"ruleId", "description"=>"Internal identifier of an answering rule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Call", "Handling", "Rule"]}, "put"=>{"summary"=>"Update Company Call Handling Rule", "description"=>"Updates a company answering rule.\nApp Permission\nEditAccounts\nUser Permission\nEditCompanyAnsweringRules\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nAWR-164\nRule type cannot be changed\n\n\n400\nAWR-170\nInvalid greeting type: preset with [CompanyGreeting] must be used\n\n\n400\nAWR-172\n[extension] must be specified for [Bypass] call handling action\n\n\n400\nAWR-173\n[extension] can be specified for [Bypass] call handling action only\n\n\n400\nAWR-179\n[name] is too long: up to 127 symbols supported\n\n\n400\nAWR-182\nOnly bypass action is available in multi-level IVR mode\n\n\n400\nCMN-101\nParameter [callHandlingAction] value is invalid", "operationId"=>"updateCompanyAnsweringRuleInfo", "x-api-path-slug"=>"restapiv1-0accountaccountidansweringruleruleid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"ruleId", "description"=>"Internal identifier of an answering rule"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Call", "Handling", "Rule"]}}, "/restapi/v1.0/dictionary/greeting"=>{"get"=>{"summary"=>"Get Standard Greetings", "description"=>"Returns a list of predefined standard greetings. Custom greetings recorded by user are not returned in response to this request. See Get Extension Custom Greetings.\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [type] value is invalid", "operationId"=>"getGreetings", "x-api-path-slug"=>"restapiv1-0dictionarygreeting-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}, {"in"=>"query", "name"=>"type", "description"=>"Type of a greeting, specifying the case when the greeting is played"}, {"in"=>"query", "name"=>"usageType", "description"=>"Usage type of a greeting, specifying if the greeting is applied for user extension or department extension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Standard", "Greetings"]}}, "/restapi/v1.0/dictionary/greeting/{greetingId}"=>{"get"=>{"summary"=>"Get Greeting Info", "description"=>"Returns a standard greeting by ID.\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n404\nCMN-102\nResource for parameter [greetingId] is not found", "operationId"=>"getGreeting", "x-api-path-slug"=>"restapiv1-0dictionarygreetinggreetingid-get", "parameters"=>[{"in"=>"path", "name"=>"greetingId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Greeting", "Info"]}}, "/restapi/v1.0/account/{accountId}/greeting"=>{"post"=>{"summary"=>"Create Custom Company Greeting", "description"=>"Creates a custom company greeting.\nApp Permission\nEditAccounts\nUser Permission\nReadUserInfo\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nAWR-129\nInvalid attachment media type\n\n\n400\nAWR-178\nGreeting type [Voicemail] is not applicable to company rule\n\n\n400\nCMN-101\nParameter [type] value is invalid\n\n\n400\nCMN-102\nResource for parameter [answeringRule.id] is not found", "operationId"=>"getCompanyGreeting", "x-api-path-slug"=>"restapiv1-0accountaccountidgreeting-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Company", "Greeting"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting"=>{"post"=>{"summary"=>"Create User Custom Greeting", "description"=>"Creates custom greeting for an extension user.\nApp Permission\nEditExtensions\nUser Permission\nEditUserAnsweringRules\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nAWR-128\nAttachment body is empty\n\n\n400\nAWR-129\nInvalid attachment media type\n\n\n400\nAWR-165\nHold music can be set for business hours rule only: the same value will be applied to all rules\n\n\n400\nCLR-103\nCompany level greeting cannot be created on user level.\n\n\n400\nCMN-101\nParameter [type] value is invalid\n\n\n400\nCMN-102\nResource for parameter [answeringRule.id] is not found\n\n\n400\nCMN-111\nBusiness operation is not supported", "operationId"=>"createGreeting", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidgreeting-post", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Custom", "Greeting"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting/{greetingId}"=>{"get"=>{"summary"=>"Get Custom Greeting Info", "description"=>"Returns a custom user greeting by ID.\nApp Permission\nReadAccounts\nUser Permission\nReadUserInfo\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n404\nCMN-102\nResource for parameter [greetingId] is not found", "operationId"=>"getGreetingByID", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidgreetinggreetingid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"greetingId", "description"=>"Internal identifier of a greeting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Custom", "Greeting", "Info"]}}, "/restapi/v1.0/account/{accountId}/ivr-prompts"=>{"get"=>{"summary"=>"Get IVR Prompts", "description"=>"Returns a list of IVR prompts.\nApp Permission\nReadAccounts\nUser Permission\nReadCompanyGreetings\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadCompanyGreetings] permission for requested resource.", "operationId"=>"getPrompts", "x-api-path-slug"=>"restapiv1-0accountaccountidivrprompts-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IVR", "Prompts"]}}, "/restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}"=>{"get"=>{"summary"=>"Get IVR Prompt", "description"=>"Returns an IVR prompt by ID.\nApp Permission\nReadAccounts\nUser Permission\nReadCompanyGreetings\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadCompanyGreetings] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [promptId] is not found", "operationId"=>"getPromptById", "x-api-path-slug"=>"restapiv1-0accountaccountidivrpromptspromptid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"promptId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IVR", "Prompt"]}, "delete"=>{"summary"=>"Delete IVR Prompt", "description"=>"Deletes an IVR prompt by ID.\nApp Permission\nEditAccounts\nUser Permission\nEditCompanyGreetings\nUsage Plan Group\nHeavy", "operationId"=>"deletePrompt", "x-api-path-slug"=>"restapiv1-0accountaccountidivrpromptspromptid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"promptId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IVR", "Prompt"]}}, "/restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}/content"=>{"get"=>{"summary"=>"Get IVR Prompt Content", "description"=>"Returns media content of an IVR prompt by ID.\nApp Permission\nReadAccounts\nUser Permission\nReadCompanyGreetings\nUsage Plan Group\nMedium", "operationId"=>"getPromptContent", "x-api-path-slug"=>"restapiv1-0accountaccountidivrpromptspromptidcontent-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"promptId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IVR", "Prompt", "Content"]}}, "/restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId}"=>{"get"=>{"summary"=>"Get IVR Menu", "description"=>"Returns a company IVR menu by ID.\nApp Permission\nReadAccounts\nUser Permission\nAutoReceptionist\nUsage Plan Group\nMedium", "operationId"=>"getIVRMenuById", "x-api-path-slug"=>"restapiv1-0accountaccountidivrmenusivrmenuid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"ivrMenuId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IVR", "Menu"]}}, "/restapi/v1.0/account/{accountId}/call-recording"=>{"get"=>{"summary"=>"Get Call Recording Settings", "description"=>"Returns call recording settings.\nApp Permission\nReadAccounts\nUser Permission\nReadCompanyInfo\nUsage Plan Group\nLight", "operationId"=>"loadCallRecordingSettings", "x-api-path-slug"=>"restapiv1-0accountaccountidcallrecording-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call", "Recording", "Settings"]}}, "/restapi/v1.0/account/{accountId}/call-recording/extensions"=>{"get"=>{"summary"=>"Get Call Recording Extension Settings", "description"=>"Returns the list of extensions to be recorded.\nApp Permission\nReadAccounts\nUser Permission\nReadCompanyInfo\nUsage Plan Group\nMedium", "operationId"=>"listCallRecordingExtensionSettings", "x-api-path-slug"=>"restapiv1-0accountaccountidcallrecordingextensions-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call", "Recording", "Extension", "Settings"]}}, "/restapi/v1.0/account/{accountId}/call-recording/custom-greetings"=>{"get"=>{"summary"=>"[Beta] Get Call Recording Custom Greetings", "description"=>"Returns call recording custom greetings.\nApp Permission\nReadAccounts\nUser Permission\nReadCompanyInfo\nUsage Plan Group\nMedium", "operationId"=>"listCallRecordingCustomGreetings", "x-api-path-slug"=>"restapiv1-0accountaccountidcallrecordingcustomgreetings-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["[Beta]", "", "Call", "Recording", "Custom", "Greetings"]}}, "/restapi/v1.0/client-info/sip-provision"=>{"post"=>{"summary"=>"Register SIP Device", "description"=>"Creates SIP registration of a device/application (WebPhone, Mobile, softphone)\nApp Permission\nVoipCalling\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [sipInfo.transport] value is invalid\n\n\n400\nSPR-114\nDevice id length [40] is greater than allowed [38]\n\n\n400\nSPR-118\nParameter [device.id]=@1qwbc)yppa! is not a number\n\n\n400\nSPR-129\nNot allowed to register with incompatible protocol list [WS, TCP]\n\n\n400\nSPR-130\ndevice is not allowed for WebRTC.\n\n\n403\nBIL-103\nFeature [WebPhone] is not available for current account\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [VoipCalling] permission\n\n\n403\nCMN-402\nAdministrator permission required\n\n\n403\nSPR-112\nClient edition is not compatible with current Brand\n\n\n403\nSPR-122\nApplication version is not set in \"User-Agent\" header or not parseable", "operationId"=>"createSipRegistration", "x-api-path-slug"=>"restapiv1-0clientinfosipprovision-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "SIP", "Device"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/phone-number"=>{"get"=>{"summary"=>"Get Extension Phone Number List", "description"=>"Returns the list of phone numbers that are used by a particular extension, and can be filtered by the phone number type. The returned list contains all numbers which are directly mapped to a given extension plus the features and also company-level numbers which may be used when performing different operations on behalf of this extension.\nApp Permission\nReadAccounts\nUser Permission\nReadUserPhoneNumbers\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [usageType] value is invalid\n\n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"listExtensionPhoneNumbers", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidphonenumber-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}, {"in"=>"query", "name"=>"usageType", "description"=>"Usage type of a phone number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extension", "Phone", "Number", "List"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}"=>{"get"=>{"summary"=>"Get Extension Info", "description"=>"Returns basic information about a particular extension of an account.\nApp Permission\nReadAccounts\nUser Permission\nReadExtensions\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-129\nAccess token corrupted\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found\n\n\n429\nCMN-301\nRequest rate exceeded", "operationId"=>"loadExtensionInfo", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extension", "Info"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id"=>{"get"=>{"summary"=>"Get Extension Caller ID", "description"=>"Returns information on an outbound caller ID of an extension.\nApp Permission\nReadAccounts\nUser Permission\nReadCallerIDSettings\nUsage Plan Group\nLight", "operationId"=>"loadExtensionCallerId", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidcallerid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extension", "Caller", "ID"]}, "put"=>{"summary"=>"Update Extension Caller ID", "description"=>"Updates outbound caller ID information of an extension.\nApp Permission\nEditExtensions\nUser Permission\nEditCallerIDSettings\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [byFeature.callerId.type] value is invalid\n\n\n400\nCMN-102\nResource for parameter [phoneInfo.id] is not found\n\n\n403\nCID-101\nFeature [CommonPhone] is not available for current account.\n\n\n403\nCID-102\nContact center phone number cannot be set as caller ID: Contact Center is not available for current account.\n\n\n403\nCID-103\nConferencing phone number cannot be set as caller ID.", "operationId"=>"updateExtensionCallerId", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidcallerid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extension", "Caller", "ID"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/grant"=>{"get"=>{"summary"=>"Get Extension Grants", "description"=>"Returns the list of extension grants.\nApp Permission\nReadAccounts\nUser Permission\nReadExtensions\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadExtensionGrant] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"listExtensionGrants", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidgrant-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"query", "name"=>"page"}, {"in"=>"query", "name"=>"perPage"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extension", "Grants"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/notification-settings"=>{"get"=>{"summary"=>"Get Notification Settings", "description"=>"Returns notification settings for the current extension.\nApp Permission\nReadAccounts\nUser Permission\nReadMessagesNotificationsSettings\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [ReadMessagesNotificationsSettings] permission for requested resource.", "operationId"=>"getNotificationSettings", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidnotificationsettings-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification", "Settings"]}, "put"=>{"summary"=>"Update Notification Settings", "description"=>"Updates notification settings for the current extension.\nApp Permission\nEditExtensions\nUser Permission\nEditMessagesNotificationsSettings\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-109\nFeature VoicemailToText is unavailable\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [EditExtensions] permission", "operationId"=>"updateNotificationSettings", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidnotificationsettings-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notification", "Settings"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image"=>{"get"=>{"summary"=>"Get User Profile Image", "description"=>"Returns a profile image of an extension.\nApp Permission\nReadAccounts\nUser Permission\nReadExtensions\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n401\nAGW-401\nAuthorization header is not specified\n\n\n401\nAGW-402\nInvalid Authorization header\n\n\n403\nCMN-109\nFeature Profile Image Streaming is unavailable\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n404\nCMN-102\nResource for parameter [extensionId] is not found", "operationId"=>"downloadImage", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidprofileimage-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"extensionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Profile", "Image"]}, "post"=>{"summary"=>"Upload User Profile Image", "description"=>"Returns the extension profile image.\nApp Permission\nEditExtensions\nUser Permission\nEditUserInfo\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [EditExtensions] permission", "operationId"=>"uploadImageByPostForm", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidprofileimage-post", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"extensionId"}, {"in"=>"formData", "name"=>"image"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "User", "Profile", "Image"]}, "put"=>{"summary"=>"Update User Profile Image", "description"=>"Updates profile image of an extension.\nApp Permission\nEditExtensions\nUser Permission\nEditUserInfo\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nACT-331\nProfile image not valid\n\n\n400\nACT-334\nProfile image file is more than 12 megapixel\n\n\n400\nCMN-101\nParameter [image] value is invalid\n\n\n403\nACT-332\nProfile image could not be set for an extension in unassigned status\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [EditExtensions] permission\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [EditUserInfo] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found\n\n\n415\nACT-330\nUnsupported image content type", "operationId"=>"uploadImageByPutForm", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidprofileimage-put", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"extensionId"}, {"in"=>"formData", "name"=>"image"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Profile", "Image"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image/{scaleSize}"=>{"get"=>{"summary"=>"Get Extension Profile Image (Scaled)", "description"=>"Returns profile image of an extension.\nApp Permission\nReadAccounts\nUser Permission\nReadExtensions\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n404\nACT-333\nProfile image is not found for scale size [92]", "operationId"=>"loadExtensionProfileImage", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidprofileimagescalesize-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}, {"in"=>"path", "name"=>"scaleSize", "description"=>"Dimensions of a profile image which will be returned in response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extension", "Profile", "Image", "(Scaled)"]}}, "/restapi/v1.0/account/{accountId}/extension/{extensionId}/conferencing"=>{"get"=>{"summary"=>"Get User Conferencing Settings", "description"=>"Returns the information on the Free Conference Calling (FCC) feature for a given extension.\nApp Permission\nReadAccounts\nUser Permission\nOrganizeConference\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-112\nFeature [Conferencing] is not available for current extension type\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [OrganizeConference] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found\n\n\n503\nFCC-103\nConference group is not set for current account", "operationId"=>"loadConferencingInfo", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidconferencing-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"query", "name"=>"countryId", "description"=>"Internal identifier of a country"}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Conferencing", "Settings"]}, "put"=>{"summary"=>"Update User Conferencing Settings", "description"=>"Updates the default conferencing number for the current extension. The number can be selected from conferencing numbers of the current extension. Updates the setting, allowing participants join the conference before host.\nApp Permission\nEditExtensions\nUser Permission\nOrganizeConference\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [allowJoinBeforeHost, phoneNumbers] value is invalid\n\n\n403\nCMN-408\nIn order to call this API endpoint, user needs to have [OrganizeConference] permission for requested resource.\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found\n\n\n503\nCMN-201\nService Temporary Unavailable", "operationId"=>"updateConferencingInfo", "x-api-path-slug"=>"restapiv1-0accountaccountidextensionextensionidconferencing-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"extensionId", "description"=>"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Conferencing", "Settings"]}}, "/restapi/v1.0/account/{accountId}"=>{"get"=>{"summary"=>"Get Company Info", "description"=>"Returns basic information about a particular RingCentral customer account.\nApp Permission\nReadAccounts\nUser Permission\nReadCompanyInfo\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n401\nOAU-213\nToken not found\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"loadAccount", "x-api-path-slug"=>"restapiv1-0accountaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Info"]}}, "/restapi/v1.0/account/{accountId}/business-address"=>{"get"=>{"summary"=>"Get Company Business Address", "description"=>"Returns business address of a company.\nApp Permission\nReadAccounts\nUser Permission\nReadCompanyInfo\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"loadAccountBusinessAddress", "x-api-path-slug"=>"restapiv1-0accountaccountidbusinessaddress-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Business", "Ress"]}}, "/restapi/v1.0/dictionary/language"=>{"get"=>{"summary"=>"Get Language List", "description"=>"Returns the information about supported languages.\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [perPage] value is invalid", "operationId"=>"listLanguages", "x-api-path-slug"=>"restapiv1-0dictionarylanguage-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Language", "List"]}}, "/restapi/v1.0/dictionary/language/{languageId}"=>{"get"=>{"summary"=>"Get Language", "description"=>"Returns language by ID.\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n404\nCMN-102\nResource for parameter [languageId] is not found", "operationId"=>"loadLanguage", "x-api-path-slug"=>"restapiv1-0dictionarylanguagelanguageid-get", "parameters"=>[{"in"=>"path", "name"=>"languageId", "description"=>"Internal identifier of a language"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Language"]}}, "/restapi/v1.0/dictionary/country"=>{"get"=>{"summary"=>"Get Country List", "description"=>"Returns all the countries available for calling.\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [perPage] value is invalid\n\n\n401\nAGW-401\nAuthorization header is not specified\n\n\n401\nOAU-129\nAccess token corrupted", "operationId"=>"listCountries", "x-api-path-slug"=>"restapiv1-0dictionarycountry-get", "parameters"=>[{"in"=>"query", "name"=>"freeSoftphoneLine", "description"=>"Specifies if free phone line for softphone is available for a country or not"}, {"in"=>"query", "name"=>"loginAllowed", "description"=>"Specifies whether login with the phone numbers of this country is enabled or not"}, {"in"=>"query", "name"=>"numberSelling", "description"=>"Specifies if RingCentral sells phone numbers of this country"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}, {"in"=>"query", "name"=>"signupAllowed", "description"=>"Indicates whether signup/billing is allowed for a country"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Country", "List"]}}, "/restapi/v1.0/dictionary/country/{countryId}"=>{"get"=>{"summary"=>"Get Country", "description"=>"Returns the information on a specific country.\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-122\nMethod is brand specific\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n404\nCMN-102\nResource for parameter [countryId] is not found", "operationId"=>"loadCountry", "x-api-path-slug"=>"restapiv1-0dictionarycountrycountryid-get", "parameters"=>[{"in"=>"path", "name"=>"countryId", "description"=>"Internal identifier of a country"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Country"]}}, "/restapi/v1.0/dictionary/location"=>{"get"=>{"summary"=>"Get Location List", "description"=>"Returns all available locations for a certain state.\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [orderBy] value is invalid\n\n\n404\nCMN-102\nResource for parameter [location] is not found", "operationId"=>"listLocations", "x-api-path-slug"=>"restapiv1-0dictionarylocation-get", "parameters"=>[{"in"=>"query", "name"=>"orderBy", "description"=>"Sorts results by the property specified"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}, {"in"=>"query", "name"=>"stateId", "description"=>"Internal identifier of a state"}, {"in"=>"query", "name"=>"withNxx", "description"=>"Specifies if nxx codes are returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Location", "List"]}}, "/restapi/v1.0/dictionary/state"=>{"get"=>{"summary"=>"Get State List", "description"=>"Returns all the states of a certain country\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [perPage] value is invalid\n\n\n404\nCMN-102\nResource for parameter [stateId] is not found", "operationId"=>"listStates", "x-api-path-slug"=>"restapiv1-0dictionarystate-get", "parameters"=>[{"in"=>"query", "name"=>"countryId", "description"=>"Internal identifier of a country"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}, {"in"=>"query", "name"=>"withPhoneNumbers", "description"=>"If True, the list of states with phone numbers available for buying is returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["State", "List"]}}, "/restapi/v1.0/dictionary/state/{stateId}"=>{"get"=>{"summary"=>"Get State", "description"=>"Returns the information on a specific state.\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n404\nCMN-102\nResource for parameter [stateId] is not found", "operationId"=>"loadState", "x-api-path-slug"=>"restapiv1-0dictionarystatestateid-get", "parameters"=>[{"in"=>"path", "name"=>"stateId", "description"=>"Internal identifier of a state"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["State"]}}, "/restapi/v1.0/dictionary/timezone"=>{"get"=>{"summary"=>"Get Timezone List", "description"=>"Returns all available timezones.\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [perPage] value is invalid", "operationId"=>"listTimezones", "x-api-path-slug"=>"restapiv1-0dictionarytimezone-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Timezone", "List"]}}, "/restapi/v1.0/dictionary/timezone/{timezoneId}"=>{"get"=>{"summary"=>"Get Timezone", "description"=>"Returns the information on a certain timezone.\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n404\nCMN-102\nResource for parameter [timezoneId] is not found", "operationId"=>"loadTimezone", "x-api-path-slug"=>"restapiv1-0dictionarytimezonetimezoneid-get", "parameters"=>[{"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}, {"in"=>"path", "name"=>"timezoneId", "description"=>"Internal identifier of a timezone"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Timezone"]}}, "/restapi/v1.0/account/{accountId}/phone-number"=>{"get"=>{"summary"=>"Get All Company Phone Numbers", "description"=>"Returns the list of phone numbers assigned to RingCentral customer account. Both company-level and extension-level numbers are returned.\nApp Permission\nReadAccounts\nUser Permission\nReadCompanyPhoneNumbers\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [perPage] value is invalid\n\n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"listAccountPhoneNumbers", "x-api-path-slug"=>"restapiv1-0accountaccountidphonenumber-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}, {"in"=>"query", "name"=>"usageType", "description"=>"Usage type of a phone number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Company", "Phone", "Numbers"]}}, "/restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId}"=>{"get"=>{"summary"=>"Get Phone Number", "description"=>"Returns the phone number(s) belonging to a certain account or extension by phoneNumberId(s). Batch request is supported.\nApp Permission\nReadAccounts\nUser Permission\nReadCompanyPhoneNumbers\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found", "operationId"=>"loadAccountPhoneNumber", "x-api-path-slug"=>"restapiv1-0accountaccountidphonenumberphonenumberid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"phoneNumberId", "description"=>"Internal identifier of a phone number"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Phone", "Number"]}}, "/restapi/v1.0/account/{accountId}/extension"=>{"get"=>{"summary"=>"Get Extensions", "description"=>"Returns the list of extensions created for a particular account. All types of extensions are included in this list.\nApp Permission\nReadAccounts\nUser Permission\nReadExtensions\nUsage Plan Group\nMedium\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [status] value is invalid\n\n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n404\nCMN-102\nResource for parameter [accountId] is not found\n\n\n429\nCMN-301\nRequest rate exceeded", "operationId"=>"listExtensions", "x-api-path-slug"=>"restapiv1-0accountaccountidextension-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}, {"in"=>"query", "name"=>"status", "description"=>"Extension current state"}, {"in"=>"query", "name"=>"type", "description"=>"Extension type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Extensions"]}}, "/restapi/v1.0/account/{accountId}/department/{departmentId}/members"=>{"get"=>{"summary"=>"Get Department Member List", "description"=>"[Deprecated] Viewing user account info (including name, business name, address and phone number/account number)\nApp Permission\nReadAccounts\nUser Permission\nReadExtensions\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [page] value is invalid\n\n\n401\nCMN-405\nLogin to extension required\n\n\n401\nOAU-151\nAuthorization method not supported\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission\n\n\n404\nCMN-102\nResource for parameter [departmentId] is not found", "operationId"=>"listDepartmentMembers", "x-api-path-slug"=>"restapiv1-0accountaccountiddepartmentdepartmentidmembers-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"}, {"in"=>"path", "name"=>"departmentId", "description"=>"Internal identifier of a Department extension (same as extensionId but only the ID of a department extension is valid)"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Department", "Member", "List"]}}, "/restapi/v1.0/account/{accountId}/department/bulk-assign"=>{"post"=>{"summary"=>"Edit Call Queue Members", "description"=>"[Deprecated] Adds and/or removes multiple call queue members\nApp Permission\nEditAccounts\nUser Permission\nUserGroups\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nEXT-401\nExtension ID should be present only in one section", "operationId"=>"bulkAssignDepartments", "x-api-path-slug"=>"restapiv1-0accountaccountiddepartmentbulkassign-post", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Call", "Queue", "Members"]}}, "/restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/users"=>{"get"=>{"summary"=>"Get Paging Only Group Users", "description"=>"Returns the list of users allowed to page this group.\nApp Permission\nReadAccounts\nUser Permission\nReadUserInfo\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission", "operationId"=>"listPagingGroupUsers", "x-api-path-slug"=>"restapiv1-0accountaccountidpagingonlygroupspagingonlygroupidusers-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"path", "name"=>"pagingOnlyGroupId"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Paging", "Only", "Group", "Users"]}}, "/restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/devices"=>{"get"=>{"summary"=>"Get Paging Only Group Devices", "description"=>"Returns the list of paging devices assigned to this group.\nApp Permission\nReadAccounts\nUser Permission\nReadCompanyDevices\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [ReadAccounts] permission", "operationId"=>"listPagingGroupDevices", "x-api-path-slug"=>"restapiv1-0accountaccountidpagingonlygroupspagingonlygroupiddevices-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"path", "name"=>"pagingOnlyGroupId"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Paging", "Only", "Group", "Devices"]}}, "/restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/bulk-assign"=>{"post"=>{"summary"=>"Edit Paging Group Users and Devices", "description"=>"Adds and/or removes paging group users and devices.\nApp Permission\nEditAccounts\nUser Permission\nEditUserInfo\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [addedDeviceIds] value is invalid\n\n\n403\nCMN-401\nIn order to call this API endpoint, application needs to have [EditAccounts] permission", "operationId"=>"bulkAssignPagingGroup", "x-api-path-slug"=>"restapiv1-0accountaccountidpagingonlygroupspagingonlygroupidbulkassign-post", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"pagingOnlyGroupId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Paging", "Group", "Users", "Devices"]}}, "/restapi/v1.0/account/{accountId}/call-queues"=>{"get"=>{"summary"=>"Get Call Queues", "description"=>"Returns call queue group list\nApp Permission\nReadAccounts\nUser Permission\nReadExtensions\nUsage Plan Group\nMedium", "operationId"=>"listCallQueues", "x-api-path-slug"=>"restapiv1-0accountaccountidcallqueues-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"query", "name"=>"memberExtensionId", "description"=>"Internal identifier of an extension that is a member of every group within the result"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call", "Queues"]}}, "/restapi/v1.0/account/{accountId}/call-queues/{groupId}/members"=>{"get"=>{"summary"=>"Get Call Queue Members", "description"=>"Returns call queue group members.\nApp Permission\nReadAccounts\nUser Permission\nReadExtensions\nUsage Plan Group\nLight", "operationId"=>"listCallQueueMembers", "x-api-path-slug"=>"restapiv1-0accountaccountidcallqueuesgroupidmembers-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"groupId"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call", "Queue", "Members"]}}, "/restapi/v1.0/account/{accountId}/call-queues/{groupId}/bulk-assign"=>{"post"=>{"summary"=>"Edit Call Queue Group", "description"=>"Updates call queue group.\nApp Permission\nEditExtensions\nUser Permission\nGroups\nUsage Plan Group\nHeavy\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nEXT-405\nExtension of type [ParkLocation] could not be a member of [department}]", "operationId"=>"updateCallQueueGroup", "x-api-path-slug"=>"restapiv1-0accountaccountidcallqueuesgroupidbulkassign-post", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"body", "name"=>"body", "description"=>"Changes for the given group", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"groupId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Edit", "Call", "Queue", "Group"]}}, "/restapi/v1.0/account/{accountId}/call-monitoring-groups"=>{"get"=>{"summary"=>"Get Call Monitoring Groups", "description"=>"Returns call monitoring groups that can be filtered by some extension.\nApp Permission\nReadAccounts\nUser Permission\nReadExtensions\nUsage Plan Group\nMedium", "operationId"=>"listCallMonitoringGroups", "x-api-path-slug"=>"restapiv1-0accountaccountidcallmonitoringgroups-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"query", "name"=>"memberExtensionId", "description"=>"Internal identifier of an extension that is a member of every group within the result"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call", "Monitoring", "Groups"]}}, "/restapi/v1.0/account/{accountId}/call-monitoring-groups/{groupId}/members"=>{"get"=>{"summary"=>"Get Call Monitoring Group Members", "description"=>"Returns call monitoring group members.\nApp Permission\nReadAccounts\nUser Permission\nReadExtensions\nUsage Plan Group\nMedium", "operationId"=>"listCallMonitoringGroupMembers", "x-api-path-slug"=>"restapiv1-0accountaccountidcallmonitoringgroupsgroupidmembers-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"path", "name"=>"groupId"}, {"in"=>"query", "name"=>"page", "description"=>"Indicates the page number to retrieve"}, {"in"=>"query", "name"=>"perPage", "description"=>"Indicates the page size (number of items)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Call", "Monitoring", "Group", "Members"]}}, "/restapi/v1.0/number-parser/parse"=>{"post"=>{"summary"=>"Parse Phone Number [Beta]", "description"=>"Returns one or more parsed and/or formatted phone numbers that are passed as a string.\nUsage Plan Group\nLight\nError Codes\n\n \n \n HTTP Code\n Error Code\n Error Message\n \n \n\n400\nCMN-101\nParameter [nationalAsPriority] value is invalid", "operationId"=>"parsePhoneNumber", "x-api-path-slug"=>"restapiv1-0numberparserparse-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"JSON body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"homeCountry", "description"=>"Internal identifier of a home country"}, {"in"=>"query", "name"=>"nationalAsPriority", "description"=>"The default value is False"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Parse", "Phone", "Number", "[Beta]"]}}, "/scim/v2/ServiceProviderConfig"=>{"get"=>{"summary"=>"get service provider config", "description"=>"", "operationId"=>"getServiceProviderConfig", "x-api-path-slug"=>"scimv2serviceproviderconfig-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "Service", "Provider", "Config"]}}, "/scim/v2/Users"=>{"get"=>{"summary"=>"search or list users", "description"=>"", "operationId"=>"searchViaGet", "x-api-path-slug"=>"scimv2users-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"page size"}, {"in"=>"query", "name"=>"filter", "description"=>"only support userName or email filter expressions for now"}, {"in"=>"query", "name"=>"startIndex", "description"=>"start index (1-based)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "List", "Users"]}, "post"=>{"summary"=>"create a user", "description"=>"", "operationId"=>"createUser", "x-api-path-slug"=>"scimv2users-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"a new user without id", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Create", "User"]}}, "/scim/v2/Users/.search"=>{"post"=>{"summary"=>"search or list users", "description"=>"", "operationId"=>"searchViaPost", "x-api-path-slug"=>"scimv2users-search-post", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"search parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "List", "Users"]}}, "/scim/v2/Users/{id}"=>{"get"=>{"summary"=>"get a user by id", "description"=>"", "operationId"=>"getUserById", "x-api-path-slug"=>"scimv2usersid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"user id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Get", "User", "By", "Id"]}, "put"=>{"summary"=>"fully update/replace a user", "description"=>"", "operationId"=>"replaceUser", "x-api-path-slug"=>"scimv2usersid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "description"=>"an existing user", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"user id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Fully", "Update", "Replace", "User"]}, "delete"=>{"summary"=>"delete a user", "description"=>"", "operationId"=>"deleteUser", "x-api-path-slug"=>"scimv2usersid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"user id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Delete", "User"]}}}}, "apis"=>{"name"=>"RingCentral", "x-slug"=>"ringcentral", "description"=>"RingCentral, Inc. (NYSE: RNG) is a global provider of cloud enterprise unified communications and collaboration solutions. More flexible and cost-effective than legacy on-premise systems, RingCentral empowers today’s mobile and distributed workforces to be connected anywhere and on any device through voice, video, team messaging, collaboration, SMS, conferencing, online meetings, contact center, and fax. RingCentral provides an open platform that integrates with today’s leading business apps while giving customers the flexibility to customize their own workflows.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28867-developer-ringcentral-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"7180", "tags"=>"ISP,Relative Data,Service API,Telecommunications,Video Conferencing,Voice,Webinars", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"ringcentral/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"RingCentral", "x-api-slug"=>"ringcentral", "description"=>"RingCentral, Inc. (NYSE: RNG) is a global provider of cloud enterprise unified communications and collaboration solutions. More flexible and cost-effective than legacy on-premise systems, RingCentral empowers today’s mobile and distributed workforces to be connected anywhere and on any device through voice, video, team messaging, collaboration, SMS, conferencing, online meetings, contact center, and fax. RingCentral provides an open platform that integrates with today’s leading business apps while giving customers the flexibility to customize their own workflows.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28867-developer-ringcentral-com.jpg", "humanURL"=>"http://www.ringcentral.com", "baseURL"=>"https://platform.ringcentral.com//", "tags"=>"ISP,Relative Data,Service API,Telecommunications,Video Conferencing,Voice,Webinars", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/ringcentral/ringcentral-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://medium.com/ringcentral-developers"}, {"type"=>"x-blog-rss", "url"=>"https://medium.com/feed/ringcentral-developers"}, {"type"=>"x-github", "url"=>"https://github.com/ringcentral"}, {"type"=>"x-openapi", "url"=>"https://netstorage.ringcentral.com/dpw/api-explorer/swagger-ring_basic.yml?v=20180816"}, {"type"=>"x-website", "url"=>"http://www.ringcentral.com"}, {"type"=>"x-code", "url"=>"https://developer.ringcentral.com/library/sdks.html"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/ringcentral"}, {"type"=>"x-developer", "url"=>"https://developer.ringcentral.com/"}, {"type"=>"x-documentation", "url"=>"https://developer.ringcentral.com/api-explorer/latest/index.html?_ga=2.259782990.551967760.1534465156-1236351744.1533920460"}, {"type"=>"x-support", "url"=>"https://developer.ringcentral.com/support.html"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/RingCentral"}, {"type"=>"x-website", "url"=>"https://developer.ringcentral.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-content-api-for-shopping{"apis"=>{"name"=>"Google Content API for Shopping", "x-slug"=>"google-content-api-for-shopping", "description"=>"API allowing retailers to manage their product feed content programmatically. Providing item-level data quality information: See if an item was disapproved because a landing page URL isn’t working on a mobile device or if unique product identifiers are inaccurate. Faster pricing and availability updates: Ensure customers have the latest price-points and know what’s in-stock before they click through to your site. More integration options: The newer API supports a broader choice of programming languages and data formats.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Google-shopping-API1.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Commerce,Content,Google APIs,Profiles,Relative Data,Service API,Shopping,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-content-api-for-shopping/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Content API for Shopping API", "x-api-slug"=>"google-content-api-for-shopping-api", "description"=>"API allowing retailers to manage their product feed content programmatically. Providing item-level data quality information: See if an item was disapproved because a landing page URL isn’t working on a mobile device or if unique product identifiers are inaccurate. Faster pricing and availability updates: Ensure customers have the latest price-points and know what’s in-stock before they click through to your site. More integration options: The newer API supports a broader choice of programming languages and data formats.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Google-shopping-API1.jpg", "humanURL"=>"https://developers.google.com/shopping-content/v2/quickstart", "baseURL"=>"://www.googleapis.com//content/v2", "tags"=>"API Provider,API Service Provider,Commerce,Content,Google APIs,Profiles,Relative Data,Service API,Shopping,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-content-api-for-shopping/google-content-api-for-shopping-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-best-practices", "url"=>"https://developers.google.com/shopping-content/v2/best-practices"}, {"type"=>"x-code", "url"=>"https://developers.google.com/shopping-content/v2/libraries"}, {"type"=>"x-testing", "url"=>"https://developers.google.com/shopping-content/v2/how-tos/testing"}, {"type"=>"x-website", "url"=>"https://developers.google.com/shopping-content/v2/quickstart"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "google-content-api-for-shopping-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Content API for Shopping", "x-complete"=>1, "info"=>{"title"=>"Content API for Shopping", "description"=>"manages-product-items-inventory-and-merchant-center-accounts-for-google-shopping-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v2"}, "host"=>"www.googleapis.com", "basePath"=>"/content/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/accounts/authinfo"=>{"get"=>{"summary"=>"Authenticated User", "description"=>"Returns information about the authenticated user.", "operationId"=>"content.accounts.authinfo", "x-api-path-slug"=>"accountsauthinfo-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authenticated", "User"]}}, "/accounts/batch"=>{"post"=>{"summary"=>"Account Batch", "description"=>"Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.", "operationId"=>"content.accounts.custombatch", "x-api-path-slug"=>"accountsbatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Batch"]}}, "/accountshipping/batch"=>{"post"=>{"summary"=>"Account Batches", "description"=>"Retrieves and updates the shipping settings of multiple accounts in a single request.", "operationId"=>"content.accountshipping.custombatch", "x-api-path-slug"=>"accountshippingbatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Batches"]}}, "/accountstatuses/batch"=>{"post"=>{"summary"=>"Account Status Batch", "description"=>"Retrieves account batch status.", "operationId"=>"content.accountstatuses.custombatch", "x-api-path-slug"=>"accountstatusesbatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Status", "Batch"]}}, "/accounttax/batch"=>{"post"=>{"summary"=>"Account Taxes", "description"=>"Retrieves and updates tax settings of multiple accounts in a single request.", "operationId"=>"content.accounttax.custombatch", "x-api-path-slug"=>"accounttaxbatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Taxes"]}}, "/datafeeds/batch"=>{"post"=>{"summary"=>"Data Feeds", "description"=>"Retrieves data feed batches.", "operationId"=>"content.datafeeds.custombatch", "x-api-path-slug"=>"datafeedsbatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data", "Feeds"]}}, "/datafeedstatuses/batch"=>{"post"=>{"summary"=>"Data Feed Status", "description"=>"Retrieves data feed batch status.", "operationId"=>"content.datafeedstatuses.custombatch", "x-api-path-slug"=>"datafeedstatusesbatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data", "Feed", "Status"]}}, "/inventory/batch"=>{"post"=>{"summary"=>"Inventory", "description"=>"Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products. This method can only be called for non-multi-client accounts.", "operationId"=>"content.inventory.custombatch", "x-api-path-slug"=>"inventorybatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Inventory"]}}, "/orders/batch"=>{"post"=>{"summary"=>"Orders", "description"=>"Retrieves or modifies multiple orders in a single request. This method can only be called for non-multi-client accounts.", "operationId"=>"content.orders.custombatch", "x-api-path-slug"=>"ordersbatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders"]}}, "/products/batch"=>{"post"=>{"summary"=>"Product Batches", "description"=>"Retrieves, inserts, and deletes multiple products in a single request. This method can only be called for non-multi-client accounts.", "operationId"=>"content.products.custombatch", "x-api-path-slug"=>"productsbatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "Batches"]}}, "/productstatuses/batch"=>{"post"=>{"summary"=>"Product Batch", "description"=>"Gets the statuses of multiple products in a single request. This method can only be called for non-multi-client accounts.", "operationId"=>"content.productstatuses.custombatch", "x-api-path-slug"=>"productstatusesbatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "Batch"]}}, "/shippingsettings/batch"=>{"post"=>{"summary"=>"Shipping Settings", "description"=>"Retrieves and updates the shipping settings of multiple accounts in a single request.", "operationId"=>"content.shippingsettings.custombatch", "x-api-path-slug"=>"shippingsettingsbatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Settings"]}}, "/{merchantId}/accounts"=>{"get"=>{"summary"=>"Get Accounts", "description"=>"Lists the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.", "operationId"=>"content.accounts.list", "x-api-path-slug"=>"merchantidaccounts-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of accounts to return in the response, used for paging"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}, "post"=>{"summary"=>"Create Accounts", "description"=>"Creates a Merchant Center sub-account. This method can only be called for multi-client accounts.", "operationId"=>"content.accounts.insert", "x-api-path-slug"=>"merchantidaccounts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/{merchantId}/accounts/{accountId}"=>{"delete"=>{"summary"=>"Delete Account", "description"=>"Deletes a Merchant Center sub-account. This method can only be called for multi-client accounts.", "operationId"=>"content.accounts.delete", "x-api-path-slug"=>"merchantidaccountsaccountid-delete", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The ID of the account"}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}, "get"=>{"summary"=>"Get Account", "description"=>"Retrieves a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.", "operationId"=>"content.accounts.get", "x-api-path-slug"=>"merchantidaccountsaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The ID of the account"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}, "patch"=>{"summary"=>"Update Account", "description"=>"Updates a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.", "operationId"=>"content.accounts.patch", "x-api-path-slug"=>"merchantidaccountsaccountid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The ID of the account"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}, "put"=>{"summary"=>"Update Account", "description"=>"Updates a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.", "operationId"=>"content.accounts.update", "x-api-path-slug"=>"merchantidaccountsaccountid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The ID of the account"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/{merchantId}/accountshipping"=>{"get"=>{"summary"=>"Get Account Shipping", "description"=>"Lists the shipping settings of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.", "operationId"=>"content.accountshipping.list", "x-api-path-slug"=>"merchantidaccountshipping-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of shipping settings to return in the response, used for paging"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Shipping"]}}, "/{merchantId}/accountshipping/{accountId}"=>{"get"=>{"summary"=>"Get Account Shipping", "description"=>"Retrieves the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.", "operationId"=>"content.accountshipping.get", "x-api-path-slug"=>"merchantidaccountshippingaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The ID of the account for which to get/update account shipping settings"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Shipping"]}, "patch"=>{"summary"=>"Updat Account Shipping", "description"=>"Updates the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.", "operationId"=>"content.accountshipping.patch", "x-api-path-slug"=>"merchantidaccountshippingaccountid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The ID of the account for which to get/update account shipping settings"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Updat", "Account", "Shipping"]}, "put"=>{"summary"=>"Updat Account Shipping", "description"=>"Updates the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.", "operationId"=>"content.accountshipping.update", "x-api-path-slug"=>"merchantidaccountshippingaccountid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The ID of the account for which to get/update account shipping settings"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Updat", "Account", "Shipping"]}}, "/{merchantId}/accountstatuses"=>{"get"=>{"summary"=>"Get Account Status", "description"=>"Lists the statuses of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.", "operationId"=>"content.accountstatuses.list", "x-api-path-slug"=>"merchantidaccountstatuses-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of account statuses to return in the response, used for paging"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Status"]}}, "/{merchantId}/accountstatuses/{accountId}"=>{"get"=>{"summary"=>"Get Account Status", "description"=>"Retrieves the status of a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.", "operationId"=>"content.accountstatuses.get", "x-api-path-slug"=>"merchantidaccountstatusesaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The ID of the account"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Status"]}}, "/{merchantId}/accounttax"=>{"get"=>{"summary"=>"Get Account Taxes", "description"=>"Lists the tax settings of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.", "operationId"=>"content.accounttax.list", "x-api-path-slug"=>"merchantidaccounttax-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of tax settings to return in the response, used for paging"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Taxes"]}}, "/{merchantId}/accounttax/{accountId}"=>{"get"=>{"summary"=>"Get Account Tax", "description"=>"Retrieves the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.", "operationId"=>"content.accounttax.get", "x-api-path-slug"=>"merchantidaccounttaxaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The ID of the account for which to get/update account tax settings"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Tax"]}, "patch"=>{"summary"=>"Update Account Tax", "description"=>"Updates the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.", "operationId"=>"content.accounttax.patch", "x-api-path-slug"=>"merchantidaccounttaxaccountid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The ID of the account for which to get/update account tax settings"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Tax"]}, "put"=>{"summary"=>"Update Account Tax", "description"=>"Updates the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.", "operationId"=>"content.accounttax.update", "x-api-path-slug"=>"merchantidaccounttaxaccountid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The ID of the account for which to get/update account tax settings"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account", "Tax"]}}, "/{merchantId}/datafeeds"=>{"get"=>{"summary"=>"Get Data Feeds", "description"=>"Lists the datafeeds in your Merchant Center account. This method can only be called for non-multi-client accounts.", "operationId"=>"content.datafeeds.list", "x-api-path-slug"=>"merchantiddatafeeds-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of products to return in the response, used for paging"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data", "Feeds"]}, "post"=>{"summary"=>"Create Data Feed", "description"=>"Registers a datafeed with your Merchant Center account. This method can only be called for non-multi-client accounts.", "operationId"=>"content.datafeeds.insert", "x-api-path-slug"=>"merchantiddatafeeds-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data", "Feed"]}}, "/{merchantId}/datafeeds/{datafeedId}"=>{"delete"=>{"summary"=>"Delete Data Feed", "description"=>"Deletes a datafeed from your Merchant Center account. This method can only be called for non-multi-client accounts.", "operationId"=>"content.datafeeds.delete", "x-api-path-slug"=>"merchantiddatafeedsdatafeedid-delete", "parameters"=>[{"in"=>"path", "name"=>"datafeedId"}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data", "Feed"]}, "get"=>{"summary"=>"Get Data Feed", "description"=>"Retrieves a datafeed from your Merchant Center account. This method can only be called for non-multi-client accounts.", "operationId"=>"content.datafeeds.get", "x-api-path-slug"=>"merchantiddatafeedsdatafeedid-get", "parameters"=>[{"in"=>"path", "name"=>"datafeedId"}, {"in"=>"path", "name"=>"merchantId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data", "Feed"]}, "patch"=>{"summary"=>"Update Data Feed", "description"=>"Updates a datafeed of your Merchant Center account. This method can only be called for non-multi-client accounts. This method supports patch semantics.", "operationId"=>"content.datafeeds.patch", "x-api-path-slug"=>"merchantiddatafeedsdatafeedid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"datafeedId"}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data", "Feed"]}, "put"=>{"summary"=>"Update Data Feed", "description"=>"Updates a datafeed of your Merchant Center account. This method can only be called for non-multi-client accounts.", "operationId"=>"content.datafeeds.update", "x-api-path-slug"=>"merchantiddatafeedsdatafeedid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"datafeedId"}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data", "Feed"]}}, "/{merchantId}/datafeedstatuses"=>{"get"=>{"summary"=>"Get Data Feed Status", "description"=>"Lists the statuses of the datafeeds in your Merchant Center account. This method can only be called for non-multi-client accounts.", "operationId"=>"content.datafeedstatuses.list", "x-api-path-slug"=>"merchantiddatafeedstatuses-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of products to return in the response, used for paging"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data", "Feed", "Status"]}}, "/{merchantId}/datafeedstatuses/{datafeedId}"=>{"get"=>{"summary"=>"Get Data Feed Status", "description"=>"Retrieves the status of a datafeed from your Merchant Center account. This method can only be called for non-multi-client accounts.", "operationId"=>"content.datafeedstatuses.get", "x-api-path-slug"=>"merchantiddatafeedstatusesdatafeedid-get", "parameters"=>[{"in"=>"path", "name"=>"datafeedId"}, {"in"=>"path", "name"=>"merchantId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Data", "Feed", "Status"]}}, "/{merchantId}/inventory/{storeCode}/products/{productId}"=>{"post"=>{"summary"=>"Update Price", "description"=>"Updates price and availability of a product in your Merchant Center account. This operation does not update the expiration date of the product. This method can only be called for non-multi-client accounts.", "operationId"=>"content.inventory.set", "x-api-path-slug"=>"merchantidinventorystorecodeproductsproductid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"path", "name"=>"productId", "description"=>"The ID of the product for which to update price and availability"}, {"in"=>"path", "name"=>"storeCode", "description"=>"The code of the store for which to update price and availability"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Price"]}}, "/{merchantId}/orders"=>{"get"=>{"summary"=>"Get Orders", "description"=>"Lists the orders in your Merchant Center account. This method can only be called for non-multi-client accounts.", "operationId"=>"content.orders.list", "x-api-path-slug"=>"merchantidorders-get", "parameters"=>[{"in"=>"query", "name"=>"acknowledged", "description"=>"Obtains orders that match the acknowledgement status"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of orders to return in the response, used for paging"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"query", "name"=>"orderBy", "description"=>"The ordering of the returned list"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}, {"in"=>"query", "name"=>"placedDateEnd", "description"=>"Obtains orders placed before this date (exclusively), in ISO 8601 format"}, {"in"=>"query", "name"=>"placedDateStart", "description"=>"Obtains orders placed after this date (inclusively), in ISO 8601 format"}, {"in"=>"query", "name"=>"statuses", "description"=>"Obtains orders that match any of the specified statuses"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Orders"]}}, "/{merchantId}/orders/{orderId}"=>{"get"=>{"summary"=>"Get Order", "description"=>"Retrieves an order from your Merchant Center account. This method can only be called for non-multi-client accounts.", "operationId"=>"content.orders.get", "x-api-path-slug"=>"merchantidordersorderid-get", "parameters"=>[{"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"path", "name"=>"orderId", "description"=>"The ID of the order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order"]}}, "/{merchantId}/orders/{orderId}/acknowledge"=>{"post"=>{"summary"=>"Acknowledge Order", "description"=>"Marks an order as acknowledged. This method can only be called for non-multi-client accounts.", "operationId"=>"content.orders.acknowledge", "x-api-path-slug"=>"merchantidordersorderidacknowledge-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"path", "name"=>"orderId", "description"=>"The ID of the order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Acknowledge", "Order"]}}, "/{merchantId}/orders/{orderId}/cancel"=>{"post"=>{"summary"=>"Cancel Order", "description"=>"Cancels all line items in an order. This method can only be called for non-multi-client accounts.", "operationId"=>"content.orders.cancel", "x-api-path-slug"=>"merchantidordersorderidcancel-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"path", "name"=>"orderId", "description"=>"The ID of the order to cancel"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Order"]}}, "/{merchantId}/orders/{orderId}/cancelLineItem"=>{"post"=>{"summary"=>"Cancel Order Line Item", "description"=>"Cancels a line item. This method can only be called for non-multi-client accounts.", "operationId"=>"content.orders.cancellineitem", "x-api-path-slug"=>"merchantidordersorderidcancellineitem-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"path", "name"=>"orderId", "description"=>"The ID of the order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cancel", "Order", "Line", "Item"]}}, "/{merchantId}/orders/{orderId}/refund"=>{"post"=>{"summary"=>"Refund Order", "description"=>"Refund a portion of the order, up to the full amount paid. This method can only be called for non-multi-client accounts.", "operationId"=>"content.orders.refund", "x-api-path-slug"=>"merchantidordersorderidrefund-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"path", "name"=>"orderId", "description"=>"The ID of the order to refund"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Refund", "Order"]}}, "/{merchantId}/orders/{orderId}/returnLineItem"=>{"post"=>{"summary"=>"Return Line Item", "description"=>"Returns a line item. This method can only be called for non-multi-client accounts.", "operationId"=>"content.orders.returnlineitem", "x-api-path-slug"=>"merchantidordersorderidreturnlineitem-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"path", "name"=>"orderId", "description"=>"The ID of the order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "Line", "Item"]}}, "/{merchantId}/orders/{orderId}/shipLineItems"=>{"post"=>{"summary"=>"Ship Line Item", "description"=>"Marks line item(s) as shipped. This method can only be called for non-multi-client accounts.", "operationId"=>"content.orders.shiplineitems", "x-api-path-slug"=>"merchantidordersorderidshiplineitems-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"path", "name"=>"orderId", "description"=>"The ID of the order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ship", "Line", "Item"]}}, "/{merchantId}/orders/{orderId}/updateMerchantOrderId"=>{"post"=>{"summary"=>"Update Merchant Order ID", "description"=>"Updates the merchant order ID for a given order. This method can only be called for non-multi-client accounts.", "operationId"=>"content.orders.updatemerchantorderid", "x-api-path-slug"=>"merchantidordersorderidupdatemerchantorderid-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"path", "name"=>"orderId", "description"=>"The ID of the order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Merchant", "Order", "ID"]}}, "/{merchantId}/orders/{orderId}/updateShipment"=>{"post"=>{"summary"=>"Update order Shippment", "description"=>"Updates a shipment's status, carrier, and/or tracking ID. This method can only be called for non-multi-client accounts.", "operationId"=>"content.orders.updateshipment", "x-api-path-slug"=>"merchantidordersorderidupdateshipment-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"path", "name"=>"orderId", "description"=>"The ID of the order"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["order", "Shippment"]}}, "/{merchantId}/ordersbymerchantid/{merchantOrderId}"=>{"get"=>{"summary"=>"Get Order", "description"=>"Retrieves an order using merchant order id. This method can only be called for non-multi-client accounts.", "operationId"=>"content.orders.getbymerchantorderid", "x-api-path-slug"=>"merchantidordersbymerchantidmerchantorderid-get", "parameters"=>[{"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"path", "name"=>"merchantOrderId", "description"=>"The merchant order id to be looked for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Order"]}}, "/{merchantId}/products"=>{"get"=>{"summary"=>"Get Prudcts", "description"=>"Lists the products in your Merchant Center account. This method can only be called for non-multi-client accounts.", "operationId"=>"content.products.list", "x-api-path-slug"=>"merchantidproducts-get", "parameters"=>[{"in"=>"query", "name"=>"includeInvalidInsertedItems", "description"=>"Flag to include the invalid inserted items in the result of the list request"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of products to return in the response, used for paging"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Prudcts"]}, "post"=>{"summary"=>"Upload Product", "description"=>"Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry. This method can only be called for non-multi-client accounts.", "operationId"=>"content.products.insert", "x-api-path-slug"=>"merchantidproducts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Upload", "Product"]}}, "/{merchantId}/products/{productId}"=>{"delete"=>{"summary"=>"Delete Product", "description"=>"Deletes a product from your Merchant Center account. This method can only be called for non-multi-client accounts.", "operationId"=>"content.products.delete", "x-api-path-slug"=>"merchantidproductsproductid-delete", "parameters"=>[{"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"path", "name"=>"productId", "description"=>"The ID of the product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}, "get"=>{"summary"=>"Get Product", "description"=>"Retrieves a product from your Merchant Center account. This method can only be called for non-multi-client accounts.", "operationId"=>"content.products.get", "x-api-path-slug"=>"merchantidproductsproductid-get", "parameters"=>[{"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"path", "name"=>"productId", "description"=>"The ID of the product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product"]}}, "/{merchantId}/productstatuses"=>{"get"=>{"summary"=>"Get Product Status", "description"=>"Lists the statuses of the products in your Merchant Center account. This method can only be called for non-multi-client accounts.", "operationId"=>"content.productstatuses.list", "x-api-path-slug"=>"merchantidproductstatuses-get", "parameters"=>[{"in"=>"query", "name"=>"includeInvalidInsertedItems", "description"=>"Flag to include the invalid inserted items in the result of the list request"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of product statuses to return in the response, used for paging"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "Status"]}}, "/{merchantId}/productstatuses/{productId}"=>{"get"=>{"summary"=>"Get Product Status", "description"=>"Gets the status of a product from your Merchant Center account. This method can only be called for non-multi-client accounts.", "operationId"=>"content.productstatuses.get", "x-api-path-slug"=>"merchantidproductstatusesproductid-get", "parameters"=>[{"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"path", "name"=>"productId", "description"=>"The ID of the product"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Product", "Status"]}}, "/{merchantId}/shippingsettings"=>{"get"=>{"summary"=>"Get Shipping Settings", "description"=>"Lists the shipping settings of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.", "operationId"=>"content.shippingsettings.list", "x-api-path-slug"=>"merchantidshippingsettings-get", "parameters"=>[{"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of shipping settings to return in the response, used for paging"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"query", "name"=>"pageToken", "description"=>"The token returned by the previous request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Settings"]}}, "/{merchantId}/shippingsettings/{accountId}"=>{"get"=>{"summary"=>"Get Shipping Settings", "description"=>"Retrieves the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.", "operationId"=>"content.shippingsettings.get", "x-api-path-slug"=>"merchantidshippingsettingsaccountid-get", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The ID of the account for which to get/update shipping settings"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Settings"]}, "patch"=>{"summary"=>"Update Shipping Settings", "description"=>"Updates the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.", "operationId"=>"content.shippingsettings.patch", "x-api-path-slug"=>"merchantidshippingsettingsaccountid-patch", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The ID of the account for which to get/update shipping settings"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Settings"]}, "put"=>{"summary"=>"Update Shipping Settings", "description"=>"Updates the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.", "operationId"=>"content.shippingsettings.update", "x-api-path-slug"=>"merchantidshippingsettingsaccountid-put", "parameters"=>[{"in"=>"path", "name"=>"accountId", "description"=>"The ID of the account for which to get/update shipping settings"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"dryRun", "description"=>"Flag to run the request in dry-run mode"}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Shipping", "Settings"]}}, "/{merchantId}/supportedCarriers"=>{"get"=>{"summary"=>"Get Supported Carriers", "description"=>"Retrieves supported carriers and carrier services for an account.", "operationId"=>"content.shippingsettings.getsupportedcarriers", "x-api-path-slug"=>"merchantidsupportedcarriers-get", "parameters"=>[{"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the account for which to retrieve the supported carriers"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Supported", "Carriers"]}}, "/{merchantId}/testorders"=>{"post"=>{"summary"=>"Create Test Order", "description"=>"Sandbox only. Creates a test order. This method can only be called for non-multi-client accounts.", "operationId"=>"content.orders.createtestorder", "x-api-path-slug"=>"merchantidtestorders-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "Order"]}}, "/{merchantId}/testorders/{orderId}/advance"=>{"post"=>{"summary"=>"Update Test Order", "description"=>"Sandbox only. Moves a test order from state \"inProgress\" to state \"pendingShipment\". This method can only be called for non-multi-client accounts.", "operationId"=>"content.orders.advancetestorder", "x-api-path-slug"=>"merchantidtestordersorderidadvance-post", "parameters"=>[{"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"path", "name"=>"orderId", "description"=>"The ID of the test order to modify"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "Order"]}}, "/{merchantId}/testordertemplates/{templateName}"=>{"get"=>{"summary"=>"Get Test Order", "description"=>"Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox. This method can only be called for non-multi-client accounts.", "operationId"=>"content.orders.gettestordertemplate", "x-api-path-slug"=>"merchantidtestordertemplatestemplatename-get", "parameters"=>[{"in"=>"path", "name"=>"merchantId", "description"=>"The ID of the managing account"}, {"in"=>"path", "name"=>"templateName", "description"=>"The name of the template to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Test", "Order"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
gmail{"gmail-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Gmail", "x-complete"=>1, "info"=>{"title"=>"Gmail", "description"=>"access-gmail-mailboxes-including-sending-user-email-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"www.googleapis.com", "basePath"=>"/gmail/v1/users", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{userId}/drafts"=>{"get"=>{"summary"=>"Get Drafts", "description"=>"Lists the drafts in the user's mailbox.", "operationId"=>"gmail.users.drafts.list", "x-api-path-slug"=>"useriddrafts-get", "parameters"=>[{"in"=>"query", "name"=>"includeSpamTrash", "description"=>"Include drafts from SPAM and TRASH in the results"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of drafts to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Page token to retrieve a specific page of results in the list"}, {"in"=>"query", "name"=>"q", "description"=>"Only return draft messages matching the specified query"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}, "post"=>{"summary"=>"Update Draft", "description"=>"Creates a new draft with the DRAFT label.", "operationId"=>"gmail.users.drafts.create", "x-api-path-slug"=>"useriddrafts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}}, "/{userId}/drafts/send"=>{"post"=>{"summary"=>"Send Draft", "description"=>"Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers.", "operationId"=>"gmail.users.drafts.send", "x-api-path-slug"=>"useriddraftssend-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}}, "/{userId}/drafts/{id}"=>{"delete"=>{"summary"=>"Delete Draft", "description"=>"Immediately and permanently deletes the specified draft. Does not simply trash it.", "operationId"=>"gmail.users.drafts.delete", "x-api-path-slug"=>"useriddraftsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the draft to delete"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}, "get"=>{"summary"=>"Get Draft", "description"=>"Gets the specified draft.", "operationId"=>"gmail.users.drafts.get", "x-api-path-slug"=>"useriddraftsid-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The format to return the draft in"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the draft to retrieve"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}, "put"=>{"summary"=>"Update Draft", "description"=>"Replaces a draft's content.", "operationId"=>"gmail.users.drafts.update", "x-api-path-slug"=>"useriddraftsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the draft to update"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}}, "/{userId}/history"=>{"get"=>{"summary"=>"Get History", "description"=>"Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId).", "operationId"=>"gmail.users.history.list", "x-api-path-slug"=>"useridhistory-get", "parameters"=>[{"in"=>"query", "name"=>"historyTypes", "description"=>"History types to be returned by the function"}, {"in"=>"query", "name"=>"labelId", "description"=>"Only return messages with a label matching the ID"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of history records to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Page token to retrieve a specific page of results in the list"}, {"in"=>"query", "name"=>"startHistoryId", "description"=>"Required"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["History"]}}, "/{userId}/labels"=>{"get"=>{"summary"=>"Get Labels", "description"=>"Lists all labels in the user's mailbox.", "operationId"=>"gmail.users.labels.list", "x-api-path-slug"=>"useridlabels-get", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Label"]}, "post"=>{"summary"=>"Create Label", "description"=>"Creates a new label.", "operationId"=>"gmail.users.labels.create", "x-api-path-slug"=>"useridlabels-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Label"]}}, "/{userId}/labels/{id}"=>{"delete"=>{"summary"=>"Delete Lbel", "description"=>"Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to.", "operationId"=>"gmail.users.labels.delete", "x-api-path-slug"=>"useridlabelsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the label to delete"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Label"]}, "get"=>{"summary"=>"Get Label", "description"=>"Gets the specified label.", "operationId"=>"gmail.users.labels.get", "x-api-path-slug"=>"useridlabelsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the label to retrieve"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Label"]}, "patch"=>{"summary"=>"Update Label", "description"=>"Updates the specified label. This method supports patch semantics.", "operationId"=>"gmail.users.labels.patch", "x-api-path-slug"=>"useridlabelsid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the label to update"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Label"]}, "put"=>{"summary"=>"Update Label", "description"=>"Updates the specified label.", "operationId"=>"gmail.users.labels.update", "x-api-path-slug"=>"useridlabelsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the label to update"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Label"]}}, "/{userId}/messages"=>{"get"=>{"summary"=>"Get Message", "description"=>"Lists the messages in the user's mailbox.", "operationId"=>"gmail.users.messages.list", "x-api-path-slug"=>"useridmessages-get", "parameters"=>[{"in"=>"query", "name"=>"includeSpamTrash", "description"=>"Include messages from SPAM and TRASH in the results"}, {"in"=>"query", "name"=>"labelIds", "description"=>"Only return messages with labels that match all of the specified label IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of messages to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Page token to retrieve a specific page of results in the list"}, {"in"=>"query", "name"=>"q", "description"=>"Only return messages matching the specified query"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}, "post"=>{"summary"=>"Create Message", "description"=>"Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message.", "operationId"=>"gmail.users.messages.insert", "x-api-path-slug"=>"useridmessages-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"deleted", "description"=>"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator"}, {"in"=>"query", "name"=>"internalDateSource", "description"=>"Source for Gmails internal date of the message"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}}, "/{userId}/messages/batchDelete"=>{"post"=>{"summary"=>"Delete Messages", "description"=>"Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.", "operationId"=>"gmail.users.messages.batchDelete", "x-api-path-slug"=>"useridmessagesbatchdelete-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}}, "/{userId}/messages/batchModify"=>{"post"=>{"summary"=>"Update Label", "description"=>"Modifies the labels on the specified messages.", "operationId"=>"gmail.users.messages.batchModify", "x-api-path-slug"=>"useridmessagesbatchmodify-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}}, "/{userId}/messages/import"=>{"post"=>{"summary"=>"Import Message", "description"=>"Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message.", "operationId"=>"gmail.users.messages.import", "x-api-path-slug"=>"useridmessagesimport-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"deleted", "description"=>"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator"}, {"in"=>"query", "name"=>"internalDateSource", "description"=>"Source for Gmails internal date of the message"}, {"in"=>"query", "name"=>"neverMarkSpam", "description"=>"Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox"}, {"in"=>"query", "name"=>"processForCalendar", "description"=>"Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}}, "/{userId}/messages/send"=>{"post"=>{"summary"=>"Send Message", "description"=>"Sends the specified message to the recipients in the To, Cc, and Bcc headers.", "operationId"=>"gmail.users.messages.send", "x-api-path-slug"=>"useridmessagessend-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}}, "/{userId}/messages/{id}"=>{"delete"=>{"summary"=>"Delete Message", "description"=>"Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead.", "operationId"=>"gmail.users.messages.delete", "x-api-path-slug"=>"useridmessagesid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the message to delete"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}, "get"=>{"summary"=>"Get Message", "description"=>"Gets the specified message.", "operationId"=>"gmail.users.messages.get", "x-api-path-slug"=>"useridmessagesid-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The format to return the message in"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the message to retrieve"}, {"in"=>"query", "name"=>"metadataHeaders", "description"=>"When given and format is METADATA, only include headers specified"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}}, "/{userId}/messages/{id}/modify"=>{"post"=>{"summary"=>"Modify message", "description"=>"Modifies the labels on the specified message.", "operationId"=>"gmail.users.messages.modify", "x-api-path-slug"=>"useridmessagesidmodify-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the message to modify"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}}, "/{userId}/messages/{id}/trash"=>{"post"=>{"summary"=>"Trash Message", "description"=>"Moves the specified message to the trash.", "operationId"=>"gmail.users.messages.trash", "x-api-path-slug"=>"useridmessagesidtrash-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the message to Trash"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}}, "/{userId}/messages/{id}/untrash"=>{"post"=>{"summary"=>"UnTrash Message", "description"=>"Removes the specified message from the trash.", "operationId"=>"gmail.users.messages.untrash", "x-api-path-slug"=>"useridmessagesiduntrash-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the message to remove from Trash"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}}, "/{userId}/messages/{messageId}/attachments/{id}"=>{"get"=>{"summary"=>"Get Attachments", "description"=>"Gets the specified message attachment.", "operationId"=>"gmail.users.messages.attachments.get", "x-api-path-slug"=>"useridmessagesmessageidattachmentsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the attachment"}, {"in"=>"path", "name"=>"messageId", "description"=>"The ID of the message containing the attachment"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email"]}}, "/{userId}/profile"=>{"get"=>{"summary"=>"Get Profile", "description"=>"Gets the current user's Gmail profile.", "operationId"=>"gmail.users.getProfile", "x-api-path-slug"=>"useridprofile-get", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/{userId}/settings/autoForwarding"=>{"get"=>{"summary"=>"Get Auto-Forwarding Settings", "description"=>"Gets the auto-forwarding setting for the specified account.", "operationId"=>"gmail.users.settings.getAutoForwarding", "x-api-path-slug"=>"useridsettingsautoforwarding-get", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settings"]}, "put"=>{"summary"=>"Update Auto-Forwarding Settings", "description"=>"Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.", "operationId"=>"gmail.users.settings.updateAutoForwarding", "x-api-path-slug"=>"useridsettingsautoforwarding-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Settings"]}}, "/{userId}/settings/filters"=>{"get"=>{"summary"=>"Get Message Filters", "description"=>"Lists the message filters of a Gmail user.", "operationId"=>"gmail.users.settings.filters.list", "x-api-path-slug"=>"useridsettingsfilters-get", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filters"]}, "post"=>{"summary"=>"Create Message Filters", "description"=>"Creates a filter.", "operationId"=>"gmail.users.settings.filters.create", "x-api-path-slug"=>"useridsettingsfilters-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filters"]}}, "/{userId}/settings/filters/{id}"=>{"delete"=>{"summary"=>"Delete Message Filter", "description"=>"Deletes a filter.", "operationId"=>"gmail.users.settings.filters.delete", "x-api-path-slug"=>"useridsettingsfiltersid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the filter to be deleted"}, {"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filters"]}, "get"=>{"summary"=>"Get Message Filter", "description"=>"Gets a filter.", "operationId"=>"gmail.users.settings.filters.get", "x-api-path-slug"=>"useridsettingsfiltersid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the filter to be fetched"}, {"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Filters"]}}, "/{userId}/settings/forwardingAddresses"=>{"get"=>{"summary"=>"Get Forward Addresses", "description"=>"Lists the forwarding addresses for the specified account.", "operationId"=>"gmail.users.settings.forwardingAddresses.list", "x-api-path-slug"=>"useridsettingsforwardingaddresses-get", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forwarding Address"]}, "post"=>{"summary"=>"Create Forward Addresse", "description"=>"Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.", "operationId"=>"gmail.users.settings.forwardingAddresses.create", "x-api-path-slug"=>"useridsettingsforwardingaddresses-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forwarding Address"]}}, "/{userId}/settings/forwardingAddresses/{forwardingEmail}"=>{"delete"=>{"summary"=>"Delete Forward Address", "description"=>"Deletes the specified forwarding address and revokes any verification that may have been required.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.", "operationId"=>"gmail.users.settings.forwardingAddresses.delete", "x-api-path-slug"=>"useridsettingsforwardingaddressesforwardingemail-delete", "parameters"=>[{"in"=>"path", "name"=>"forwardingEmail", "description"=>"The forwarding address to be deleted"}, {"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forwarding Address"]}, "get"=>{"summary"=>"GGetet Forward Address", "description"=>"Gets the specified forwarding address.", "operationId"=>"gmail.users.settings.forwardingAddresses.get", "x-api-path-slug"=>"useridsettingsforwardingaddressesforwardingemail-get", "parameters"=>[{"in"=>"path", "name"=>"forwardingEmail", "description"=>"The forwarding address to be retrieved"}, {"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forwarding Address"]}}, "/{userId}/settings/imap"=>{"get"=>{"summary"=>"Gets IMAP Settings", "description"=>"Gets IMAP settings.", "operationId"=>"gmail.users.settings.getImap", "x-api-path-slug"=>"useridsettingsimap-get", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IMAP Settings"]}, "put"=>{"summary"=>"Update IMAP Setting", "description"=>"Updates IMAP settings.", "operationId"=>"gmail.users.settings.updateImap", "x-api-path-slug"=>"useridsettingsimap-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["IMAP Settings"]}}, "/{userId}/settings/pop"=>{"get"=>{"summary"=>"Gets POP Settings", "description"=>"Gets POP settings.", "operationId"=>"gmail.users.settings.getPop", "x-api-path-slug"=>"useridsettingspop-get", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}, "put"=>{"summary"=>"Update IMAP Setting", "description"=>"Updates POP settings.", "operationId"=>"gmail.users.settings.updatePop", "x-api-path-slug"=>"useridsettingspop-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["POP Settings"]}}, "/{userId}/settings/sendAs"=>{"get"=>{"summary"=>"Send As Alias", "description"=>"Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom \"from\" aliases.", "operationId"=>"gmail.users.settings.sendAs.list", "x-api-path-slug"=>"useridsettingssendas-get", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alias"]}, "post"=>{"summary"=>"Create Alias", "description"=>"Creates a custom \"from\" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.", "operationId"=>"gmail.users.settings.sendAs.create", "x-api-path-slug"=>"useridsettingssendas-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alias"]}}, "/{userId}/settings/sendAs/{sendAsEmail}"=>{"delete"=>{"summary"=>"Delete Alias", "description"=>"Deletes the specified send-as alias. Revokes any verification that may have been required for using it.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.", "operationId"=>"gmail.users.settings.sendAs.delete", "x-api-path-slug"=>"useridsettingssendassendasemail-delete", "parameters"=>[{"in"=>"path", "name"=>"sendAsEmail", "description"=>"The send-as alias to be deleted"}, {"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alias"]}, "get"=>{"summary"=>"Get Alias", "description"=>"Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.", "operationId"=>"gmail.users.settings.sendAs.get", "x-api-path-slug"=>"useridsettingssendassendasemail-get", "parameters"=>[{"in"=>"path", "name"=>"sendAsEmail", "description"=>"The send-as alias to be retrieved"}, {"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alias"]}, "patch"=>{"summary"=>"Update Alias", "description"=>"Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.\n\nAddresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. This method supports patch semantics.", "operationId"=>"gmail.users.settings.sendAs.patch", "x-api-path-slug"=>"useridsettingssendassendasemail-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"sendAsEmail", "description"=>"The send-as alias to be updated"}, {"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alias"]}, "put"=>{"summary"=>"Update Alias", "description"=>"Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.\n\nAddresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority.", "operationId"=>"gmail.users.settings.sendAs.update", "x-api-path-slug"=>"useridsettingssendassendasemail-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"sendAsEmail", "description"=>"The send-as alias to be updated"}, {"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alias"]}}, "/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo"=>{"get"=>{"summary"=>"Get S/MIME Configurations", "description"=>"Lists S/MIME configs for the specified send-as alias.", "operationId"=>"gmail.users.settings.sendAs.smimeInfo.list", "x-api-path-slug"=>"useridsettingssendassendasemailsmimeinfo-get", "parameters"=>[{"in"=>"path", "name"=>"sendAsEmail", "description"=>"The email address that appears in the From: header for mail sent using this alias"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S/MIME Configuration"]}, "post"=>{"summary"=>"Create S/MIME Configurations", "description"=>"Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.", "operationId"=>"gmail.users.settings.sendAs.smimeInfo.insert", "x-api-path-slug"=>"useridsettingssendassendasemailsmimeinfo-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"sendAsEmail", "description"=>"The email address that appears in the From: header for mail sent using this alias"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S/MIME Configuration"]}}, "/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}"=>{"delete"=>{"summary"=>"Delete S/MIME Configurations", "description"=>"Deletes the specified S/MIME config for the specified send-as alias.", "operationId"=>"gmail.users.settings.sendAs.smimeInfo.delete", "x-api-path-slug"=>"useridsettingssendassendasemailsmimeinfoid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The immutable ID for the SmimeInfo"}, {"in"=>"path", "name"=>"sendAsEmail", "description"=>"The email address that appears in the From: header for mail sent using this alias"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S/MIME Configuration"]}, "get"=>{"summary"=>"Get S/MIME Configuration", "description"=>"Gets the specified S/MIME config for the specified send-as alias.", "operationId"=>"gmail.users.settings.sendAs.smimeInfo.get", "x-api-path-slug"=>"useridsettingssendassendasemailsmimeinfoid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The immutable ID for the SmimeInfo"}, {"in"=>"path", "name"=>"sendAsEmail", "description"=>"The email address that appears in the From: header for mail sent using this alias"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S/MIME Configuration"]}}, "/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault"=>{"post"=>{"summary"=>"Create Default S/MIME Configurations", "description"=>"Sets the default S/MIME config for the specified send-as alias.", "operationId"=>"gmail.users.settings.sendAs.smimeInfo.setDefault", "x-api-path-slug"=>"useridsettingssendassendasemailsmimeinfoidsetdefault-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The immutable ID for the SmimeInfo"}, {"in"=>"path", "name"=>"sendAsEmail", "description"=>"The email address that appears in the From: header for mail sent using this alias"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S/MIME Configuration"]}}, "/{userId}/settings/sendAs/{sendAsEmail}/verify"=>{"post"=>{"summary"=>"Send Verification Email", "description"=>"Sends a verification email to the specified send-as alias address. The verification status must be pending.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.", "operationId"=>"gmail.users.settings.sendAs.verify", "x-api-path-slug"=>"useridsettingssendassendasemailverify-post", "parameters"=>[{"in"=>"path", "name"=>"sendAsEmail", "description"=>"The send-as alias to be verified"}, {"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Verification"]}}, "/{userId}/settings/vacation"=>{"get"=>{"summary"=>"Get Vacation Settings", "description"=>"Gets vacation responder settings.", "operationId"=>"gmail.users.settings.getVacation", "x-api-path-slug"=>"useridsettingsvacation-get", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vacation Settings"]}, "put"=>{"summary"=>"Update Vacation Settings", "description"=>"Updates vacation responder settings.", "operationId"=>"gmail.users.settings.updateVacation", "x-api-path-slug"=>"useridsettingsvacation-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"Users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vacation Settings"]}}, "/{userId}/stop"=>{"post"=>{"summary"=>"Stop Push Notifications", "description"=>"Stop receiving push notifications for the given user mailbox.", "operationId"=>"gmail.users.stop", "x-api-path-slug"=>"useridstop-post", "parameters"=>[{"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Push Notification"]}}, "/{userId}/threads"=>{"get"=>{"summary"=>"Get Threads", "description"=>"Lists the threads in the user's mailbox.", "operationId"=>"gmail.users.threads.list", "x-api-path-slug"=>"useridthreads-get", "parameters"=>[{"in"=>"query", "name"=>"includeSpamTrash", "description"=>"Include threads from SPAM and TRASH in the results"}, {"in"=>"query", "name"=>"labelIds", "description"=>"Only return threads with labels that match all of the specified label IDs"}, {"in"=>"query", "name"=>"maxResults", "description"=>"Maximum number of threads to return"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Page token to retrieve a specific page of results in the list"}, {"in"=>"query", "name"=>"q", "description"=>"Only return threads matching the specified query"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email Thread"]}}, "/{userId}/threads/{id}"=>{"delete"=>{"summary"=>"Delete Threads", "description"=>"Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead.", "operationId"=>"gmail.users.threads.delete", "x-api-path-slug"=>"useridthreadsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"ID of the Thread to delete"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email Thread"]}, "get"=>{"summary"=>"Get Threads", "description"=>"Gets the specified thread.", "operationId"=>"gmail.users.threads.get", "x-api-path-slug"=>"useridthreadsid-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The format to return the messages in"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the thread to retrieve"}, {"in"=>"query", "name"=>"metadataHeaders", "description"=>"When given and format is METADATA, only include headers specified"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email Thread"]}}, "/{userId}/threads/{id}/modify"=>{"post"=>{"summary"=>"Modify Thread labels", "description"=>"Modifies the labels applied to the thread. This applies to all messages in the thread.", "operationId"=>"gmail.users.threads.modify", "x-api-path-slug"=>"useridthreadsidmodify-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the thread to modify"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email Thread"]}}, "/{userId}/threads/{id}/trash"=>{"post"=>{"summary"=>"Trash Thread", "description"=>"Moves the specified thread to the trash.", "operationId"=>"gmail.users.threads.trash", "x-api-path-slug"=>"useridthreadsidtrash-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the thread to Trash"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email Thread"]}}, "/{userId}/threads/{id}/untrash"=>{"post"=>{"summary"=>"UnTrash Threat", "description"=>"Removes the specified thread from the trash.", "operationId"=>"gmail.users.threads.untrash", "x-api-path-slug"=>"useridthreadsiduntrash-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the thread to remove from Trash"}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Email Thread"]}}, "/{userId}/watch"=>{"post"=>{"summary"=>"Send Push Notification", "description"=>"Set up or update a push notification watch on the given user mailbox.", "operationId"=>"gmail.users.watch", "x-api-path-slug"=>"useridwatch-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userId", "description"=>"The users email address"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Push Notification"]}}}}, "apis"=>{"name"=>"Gmail", "x-slug"=>"gmail", "description"=>"The Gmail API is a RESTful API that can be used to access Gmail mailboxes and send mail. For most web applications (including mobile apps), the Gmail API is the best choice for authorized access to a users Gmail data.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/gmail-icon.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"API Provider,Emails,Google APIs,Productivity,Profiles,Relative Data,Relative StreamRank,Service API,Stack,Stack Network,Streams,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"gmail/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Gmail", "x-api-slug"=>"gmail", "description"=>"The Gmail API is a RESTful API that can be used to access Gmail mailboxes and send mail. For most web applications (including mobile apps), the Gmail API is the best choice for authorized access to a users Gmail data.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/gmail-icon.png", "humanURL"=>"https://www.google.com/gmail/", "baseURL"=>"https://www.googleapis.com//gmail/v1/users", "tags"=>"API Provider,Emails,Google APIs,Productivity,Profiles,Relative Data,Relative StreamRank,Service API,Stack,Stack Network,Streams,Streams,Streams", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/gmail/gmail-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-auth-scopes", "url"=>"https://developers.google.com/gmail/api/auth/scopes"}, {"type"=>"x-authentication", "url"=>"https://developers.google.com/gmail/api/auth/about-auth"}, {"type"=>"x-developer", "url"=>"https://developers.google.com/gmail/api/"}, {"type"=>"x-documentation", "url"=>"https://developers.google.com/gmail/api/v1/reference/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/gmail"}, {"type"=>"x-website", "url"=>"https://www.google.com/gmail/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-redshift{"apis"=>{"name"=>"AWS Redshift", "x-slug"=>"aws-redshift", "description"=>"Amazon Redshift is a fast, fully managed, petabyte-scaledata warehousethat makes it simple and cost-effective to analyze all your data using your existing business intelligence tools. Start small for $0.25 per hour with no commitments and scale to petabytes for $1,000 per terabyte per year, less than a tenth the cost of traditional solutions. Customers typically see 3x compression, reducing their costs to $333 per uncompressed terabyte per year.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Database_AmazonRedshift.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Data,Data Warehouse,Databases,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-redshift/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Amazon Redshift API", "x-api-slug"=>"amazon-redshift-api", "description"=>"Amazon Redshift is a fast, fully managed, petabyte-scaledata warehousethat makes it simple and cost-effective to analyze all your data using your existing business intelligence tools. Start small for $0.25 per hour with no commitments and scale to petabytes for $1,000 per terabyte per year, less than a tenth the cost of traditional solutions. Customers typically see 3x compression, reducing their costs to $333 per uncompressed terabyte per year.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Database_AmazonRedshift.png", "humanURL"=>"https://aws.amazon.com/redshift/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Data,Data Warehouse,Databases,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-redshift/amazon-redshift-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-best-practices", "url"=>"https://aws.amazon.com/redshift/developer-resources/#best-practices"}, {"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/cli/latest/reference/redshift/index.html"}, {"type"=>"x-customer-success", "url"=>"https://aws.amazon.com/redshift/customer-success/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/redshift/latest/APIReference/"}, {"type"=>"x-events", "url"=>"https://aws.amazon.com/redshift/events/"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/redshift/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/redshift/getting-started/"}, {"type"=>"x-partners", "url"=>"https://aws.amazon.com/redshift/partners/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/redshift/pricing/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/redshift/"}, {"type"=>"x-whats-new", "url"=>"https://aws.amazon.com/redshift/whats-new/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "amazon-redshift-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Redshift", "x-complete"=>1, "info"=>{"title"=>"AWS Redshift API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AuthorizeClusterSecurityGroupIngress"=>{"get"=>{"summary"=>"Authorize Cluster Security Group Ingress", "description"=>"Adds an inbound (ingress) rule to an Amazon Redshift security group.", "operationId"=>"authorizeClusterSecurityGroupIngress", "x-api-path-slug"=>"actionauthorizeclustersecuritygroupingress-get", "parameters"=>[{"in"=>"query", "name"=>"CIDRIP", "description"=>"The IP range to be added the Amazon Redshift security group", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterSecurityGroupName", "description"=>"The name of the security group to which the ingress rule is added", "type"=>"string"}, {"in"=>"query", "name"=>"EC2SecurityGroupName", "description"=>"The EC2 security group to be added the Amazon Redshift security group", "type"=>"string"}, {"in"=>"query", "name"=>"EC2SecurityGroupOwnerId", "description"=>"The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Security Group"]}}, "/?Action=AuthorizeSnapshotAccess"=>{"get"=>{"summary"=>"Authorize Snapshot Access", "description"=>"Authorizes the specified AWS customer account to restore the specified\n snapshot.", "operationId"=>"authorizeSnapshotAccess", "x-api-path-slug"=>"actionauthorizesnapshotaccess-get", "parameters"=>[{"in"=>"query", "name"=>"AccountWithRestoreAccess", "description"=>"The identifier of the AWS customer account authorized to restore the specified snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotClusterIdentifier", "description"=>"The identifier of the cluster the snapshot was created from", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotIdentifier", "description"=>"The identifier of the snapshot the account is authorized to restore", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=CopyClusterSnapshot"=>{"get"=>{"summary"=>"Copy Cluster Snapshot", "description"=>"Copies the specified automated cluster snapshot to a new manual cluster snapshot.", "operationId"=>"copyClusterSnapshot", "x-api-path-slug"=>"actioncopyclustersnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"SourceSnapshotClusterIdentifier", "description"=>"The identifier of the cluster the source snapshot was created from", "type"=>"string"}, {"in"=>"query", "name"=>"SourceSnapshotIdentifier", "description"=>"The identifier for the source snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"TargetSnapshotIdentifier", "description"=>"The identifier given to the new manual snapshot", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=CreateCluster"=>{"get"=>{"summary"=>"Create Cluster", "description"=>"Creates a new cluster.", "operationId"=>"createCluster", "x-api-path-slug"=>"actioncreatecluster-get", "parameters"=>[{"in"=>"query", "name"=>"AdditionalInfo", "description"=>"Reserved", "type"=>"string"}, {"in"=>"query", "name"=>"AllowVersionUpgrade", "description"=>"If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"AutomatedSnapshotRetentionPeriod", "description"=>"The number of days that automated snapshots are retained", "type"=>"string"}, {"in"=>"query", "name"=>"AvailabilityZone", "description"=>"The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"A unique identifier for the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterParameterGroupName", "description"=>"The name of the parameter group to be associated with this cluster", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterSecurityGroups.ClusterSecurityGroupName.N", "description"=>"A list of security groups to be associated with this cluster", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterSubnetGroupName", "description"=>"The name of a cluster subnet group to be associated with this cluster", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterType", "description"=>"The type of the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterVersion", "description"=>"The version of the Amazon Redshift engine software that you want to deploy on the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"DBName", "description"=>"The name of the first database to be created when the cluster is created", "type"=>"string"}, {"in"=>"query", "name"=>"ElasticIp", "description"=>"The Elastic IP (EIP) address for the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"Encrypted", "description"=>"If true, the data in the cluster is encrypted at rest", "type"=>"string"}, {"in"=>"query", "name"=>"EnhancedVpcRouting", "description"=>"An option that specifies whether to create the cluster with enhanced VPC routing enabled", "type"=>"string"}, {"in"=>"query", "name"=>"HsmClientCertificateIdentifier", "description"=>"Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM", "type"=>"string"}, {"in"=>"query", "name"=>"HsmConfigurationIdentifier", "description"=>"Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM", "type"=>"string"}, {"in"=>"query", "name"=>"IamRoles.IamRoleArn.N", "description"=>"A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyId", "description"=>"The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"MasterUsername", "description"=>"The user name associated with the master user account for the cluster that is being created", "type"=>"string"}, {"in"=>"query", "name"=>"MasterUserPassword", "description"=>"The password associated with the master user account for the cluster that is being created", "type"=>"string"}, {"in"=>"query", "name"=>"NodeType", "description"=>"The node type to be provisioned for the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"NumberOfNodes", "description"=>"The number of compute nodes in the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port number on which the cluster accepts incoming connections", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredMaintenanceWindow", "description"=>"The weekly time range (in UTC) during which automated cluster maintenance can occur", "type"=>"string"}, {"in"=>"query", "name"=>"PubliclyAccessible", "description"=>"If true, the cluster can be accessed from a public network", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tag instances", "type"=>"string"}, {"in"=>"query", "name"=>"VpcSecurityGroupIds.VpcSecurityGroupId.N", "description"=>"A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=CreateClusterParameterGroup"=>{"get"=>{"summary"=>"Create Cluster Parameter Group", "description"=>"Creates an Amazon Redshift parameter group.", "operationId"=>"createClusterParameterGroup", "x-api-path-slug"=>"actioncreateclusterparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"A description of the parameter group", "type"=>"string"}, {"in"=>"query", "name"=>"ParameterGroupFamily", "description"=>"The Amazon Redshift engine version to which the cluster parameter group applies", "type"=>"string"}, {"in"=>"query", "name"=>"ParameterGroupName", "description"=>"The name of the cluster parameter group", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tag instances", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Parameter Groups"]}}, "/?Action=CreateClusterSecurityGroup"=>{"get"=>{"summary"=>"Create Cluster Security Group", "description"=>"Creates a new Amazon Redshift security group.", "operationId"=>"createClusterSecurityGroup", "x-api-path-slug"=>"actioncreateclustersecuritygroup-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterSecurityGroupName", "description"=>"The name for the security group", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A description for the security group", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tag instances", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Security Group"]}}, "/?Action=CreateClusterSnapshot"=>{"get"=>{"summary"=>"Create Cluster Snapshot", "description"=>"Creates a manual snapshot of the specified cluster.", "operationId"=>"createClusterSnapshot", "x-api-path-slug"=>"actioncreateclustersnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The cluster identifier for which you want a snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotIdentifier", "description"=>"A unique identifier for the snapshot that you are requesting", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tag instances", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=CreateClusterSubnetGroup"=>{"get"=>{"summary"=>"Create Cluster Subnet Group", "description"=>"Creates a new Amazon Redshift subnet group.", "operationId"=>"createClusterSubnetGroup", "x-api-path-slug"=>"actioncreateclustersubnetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterSubnetGroupName", "description"=>"The name for the subnet group", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A description for the subnet group", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetIds.SubnetIdentifier.N", "description"=>"An array of VPC subnet IDs", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tag instances", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Subnet Groups"]}}, "/?Action=CreateEventSubscription"=>{"get"=>{"summary"=>"Create Event Subscription", "description"=>"Creates an Amazon Redshift event notification subscription.", "operationId"=>"createEventSubscription", "x-api-path-slug"=>"actioncreateeventsubscription-get", "parameters"=>[{"in"=>"query", "name"=>"Enabled", "description"=>"A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it", "type"=>"string"}, {"in"=>"query", "name"=>"EventCategories.EventCategory.N", "description"=>"Specifies the Amazon Redshift event categories to be published by the event notification subscription", "type"=>"string"}, {"in"=>"query", "name"=>"Severity", "description"=>"Specifies the Amazon Redshift event severity to be published by the event notification subscription", "type"=>"string"}, {"in"=>"query", "name"=>"SnsTopicArn", "description"=>"The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications", "type"=>"string"}, {"in"=>"query", "name"=>"SourceIds.SourceId.N", "description"=>"A list of one or more identifiers of Amazon Redshift source objects", "type"=>"string"}, {"in"=>"query", "name"=>"SourceType", "description"=>"The type of source that will be generating the events", "type"=>"string"}, {"in"=>"query", "name"=>"SubscriptionName", "description"=>"The name of the event subscription to be created", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tag instances", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Subscriptions"]}}, "/?Action=CreateHsmClientCertificate"=>{"get"=>{"summary"=>"Create Hsm Client Certificate", "description"=>"Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to\n the client's HSM in order to store and retrieve the keys used to encrypt the cluster\n databases.", "operationId"=>"createHsmClientCertificate", "x-api-path-slug"=>"actioncreatehsmclientcertificate-get", "parameters"=>[{"in"=>"query", "name"=>"HsmClientCertificateIdentifier", "description"=>"The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tag instances", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["HSM Client Certificates"]}}, "/?Action=CreateHsmConfiguration"=>{"get"=>{"summary"=>"Create Hsm Configuration", "description"=>"Creates an HSM configuration that contains the information required by an Amazon Redshift\n cluster to store and use database encryption keys in a Hardware Security Module (HSM).", "operationId"=>"createHsmConfiguration", "x-api-path-slug"=>"actioncreatehsmconfiguration-get", "parameters"=>[{"in"=>"query", "name"=>"Description", "description"=>"A text description of the HSM configuration to be created", "type"=>"string"}, {"in"=>"query", "name"=>"HsmConfigurationIdentifier", "description"=>"The identifier to be assigned to the new Amazon Redshift HSM configuration", "type"=>"string"}, {"in"=>"query", "name"=>"HsmIpAddress", "description"=>"The IP address that the Amazon Redshift cluster must use to access the HSM", "type"=>"string"}, {"in"=>"query", "name"=>"HsmPartitionName", "description"=>"The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys", "type"=>"string"}, {"in"=>"query", "name"=>"HsmPartitionPassword", "description"=>"The password required to access the HSM partition", "type"=>"string"}, {"in"=>"query", "name"=>"HsmServerPublicCertificate", "description"=>"The HSMs public certificate file", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tag instances", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["HSM Configurations"]}}, "/?Action=CreateSnapshotCopyGrant"=>{"get"=>{"summary"=>"Create Snapshot Copy Grant", "description"=>"Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key\n (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a\n destination region.", "operationId"=>"createSnapshotCopyGrant", "x-api-path-slug"=>"actioncreatesnapshotcopygrant-get", "parameters"=>[{"in"=>"query", "name"=>"KmsKeyId", "description"=>"The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotCopyGrantName", "description"=>"The name of the snapshot copy grant", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"A list of tag instances", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=CreateTags"=>{"get"=>{"summary"=>"Create Tags", "description"=>"Adds one or more tags to a specified resource.", "operationId"=>"createTags", "x-api-path-slug"=>"actioncreatetags-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceName", "description"=>"The Amazon Resource Name (ARN) to which you want to add the tag or tags", "type"=>"string"}, {"in"=>"query", "name"=>"Tags.Tag.N", "description"=>"One or more name/value pairs to add as tags to the specified resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=DeleteCluster"=>{"get"=>{"summary"=>"Delete Cluster", "description"=>"Deletes a previously provisioned cluster.", "operationId"=>"deleteCluster", "x-api-path-slug"=>"actiondeletecluster-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The identifier of the cluster to be deleted", "type"=>"string"}, {"in"=>"query", "name"=>"FinalClusterSnapshotIdentifier", "description"=>"The identifier of the final snapshot that is to be created immediately before deleting the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"SkipFinalClusterSnapshot", "description"=>"Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=DeleteClusterParameterGroup"=>{"get"=>{"summary"=>"Delete Cluster Parameter Group", "description"=>"Deletes a specified Amazon Redshift parameter group.", "operationId"=>"deleteClusterParameterGroup", "x-api-path-slug"=>"actiondeleteclusterparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"ParameterGroupName", "description"=>"The name of the parameter group to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Parameter Groups"]}}, "/?Action=DeleteClusterSecurityGroup"=>{"get"=>{"summary"=>"Delete Cluster Security Group", "description"=>"Deletes an Amazon Redshift security group.", "operationId"=>"deleteClusterSecurityGroup", "x-api-path-slug"=>"actiondeleteclustersecuritygroup-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterSecurityGroupName", "description"=>"The name of the cluster security group to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Security Group"]}}, "/?Action=DeleteClusterSnapshot"=>{"get"=>{"summary"=>"Delete Cluster Snapshot", "description"=>"Deletes the specified manual snapshot.", "operationId"=>"deleteClusterSnapshot", "x-api-path-slug"=>"actiondeleteclustersnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"SnapshotClusterIdentifier", "description"=>"The unique identifier of the cluster the snapshot was created from", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotIdentifier", "description"=>"The unique identifier of the manual snapshot to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=DeleteClusterSubnetGroup"=>{"get"=>{"summary"=>"Delete Cluster Subnet Group", "description"=>"Deletes the specified cluster subnet group.", "operationId"=>"deleteClusterSubnetGroup", "x-api-path-slug"=>"actiondeleteclustersubnetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterSubnetGroupName", "description"=>"The name of the cluster subnet group name to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Subnet Groups"]}}, "/?Action=DeleteEventSubscription"=>{"get"=>{"summary"=>"Delete Event Subscription", "description"=>"Deletes an Amazon Redshift event notification subscription.", "operationId"=>"deleteEventSubscription", "x-api-path-slug"=>"actiondeleteeventsubscription-get", "parameters"=>[{"in"=>"query", "name"=>"SubscriptionName", "description"=>"The name of the Amazon Redshift event notification subscription to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Subscriptions"]}}, "/?Action=DeleteHsmClientCertificate"=>{"get"=>{"summary"=>"Delete Hsm Client Certificate", "description"=>"Deletes the specified HSM client certificate.", "operationId"=>"deleteHsmClientCertificate", "x-api-path-slug"=>"actiondeletehsmclientcertificate-get", "parameters"=>[{"in"=>"query", "name"=>"HsmClientCertificateIdentifier", "description"=>"The identifier of the HSM client certificate to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["HSM Client Certificates"]}}, "/?Action=DeleteHsmConfiguration"=>{"get"=>{"summary"=>"Delete Hsm Configuration", "description"=>"Deletes the specified Amazon Redshift HSM configuration.", "operationId"=>"deleteHsmConfiguration", "x-api-path-slug"=>"actiondeletehsmconfiguration-get", "parameters"=>[{"in"=>"query", "name"=>"HsmConfigurationIdentifier", "description"=>"The identifier of the Amazon Redshift HSM configuration to be deleted", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["HSM Configurations"]}}, "/?Action=DeleteSnapshotCopyGrant"=>{"get"=>{"summary"=>"Delete Snapshot Copy Grant", "description"=>"Deletes the specified snapshot copy grant.", "operationId"=>"deleteSnapshotCopyGrant", "x-api-path-slug"=>"actiondeletesnapshotcopygrant-get", "parameters"=>[{"in"=>"query", "name"=>"SnapshotCopyGrantName", "description"=>"The name of the snapshot copy grant to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=DeleteTags"=>{"get"=>{"summary"=>"Delete Tags", "description"=>"Deletes a tag or tags from a resource.", "operationId"=>"deleteTags", "x-api-path-slug"=>"actiondeletetags-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceName", "description"=>"The Amazon Resource Name (ARN) from which you want to remove the tag or tags", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys.TagKey.N", "description"=>"The tag key that you want to delete", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=DescribeClusterParameterGroups"=>{"get"=>{"summary"=>"Describe Cluster Parameter Groups", "description"=>"Returns a list of Amazon Redshift parameter groups, including parameter groups you\n created and the default parameter group.", "operationId"=>"describeClusterParameterGroups", "x-api-path-slug"=>"actiondescribeclusterparametergroups-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"An optional parameter that specifies the starting point to return a set of response records", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of response records to return in each call", "type"=>"string"}, {"in"=>"query", "name"=>"ParameterGroupName", "description"=>"The name of a specific parameter group for which to return details", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys.TagKey.N", "description"=>"A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys", "type"=>"string"}, {"in"=>"query", "name"=>"TagValues.TagValue.N", "description"=>"A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Parameter Groups"]}}, "/?Action=DescribeClusterParameters"=>{"get"=>{"summary"=>"Describe Cluster Parameters", "description"=>"Returns a detailed list of parameters contained within the specified Amazon Redshift\n parameter group.", "operationId"=>"describeClusterParameters", "x-api-path-slug"=>"actiondescribeclusterparameters-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"An optional parameter that specifies the starting point to return a set of response records", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of response records to return in each call", "type"=>"string"}, {"in"=>"query", "name"=>"ParameterGroupName", "description"=>"The name of a cluster parameter group for which to return details", "type"=>"string"}, {"in"=>"query", "name"=>"Source", "description"=>"The parameter types to return", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Parameters"]}}, "/?Action=DescribeClusters"=>{"get"=>{"summary"=>"Describe Clusters", "description"=>"Returns properties of provisioned clusters including general cluster properties,\n cluster database properties, maintenance and backup properties, and security and access\n properties.", "operationId"=>"describeClusters", "x-api-path-slug"=>"actiondescribeclusters-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The unique identifier of a cluster whose properties you are requesting", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional parameter that specifies the starting point to return a set of response records", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of response records to return in each call", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys.TagKey.N", "description"=>"A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys", "type"=>"string"}, {"in"=>"query", "name"=>"TagValues.TagValue.N", "description"=>"A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=DescribeClusterSecurityGroups"=>{"get"=>{"summary"=>"Describe Cluster Security Groups", "description"=>"Returns information about Amazon Redshift security groups.", "operationId"=>"describeClusterSecurityGroups", "x-api-path-slug"=>"actiondescribeclustersecuritygroups-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterSecurityGroupName", "description"=>"The name of a cluster security group for which you are requesting details", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional parameter that specifies the starting point to return a set of response records", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of response records to return in each call", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys.TagKey.N", "description"=>"A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys", "type"=>"string"}, {"in"=>"query", "name"=>"TagValues.TagValue.N", "description"=>"A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Security Group"]}}, "/?Action=DescribeClusterSnapshots"=>{"get"=>{"summary"=>"Describe Cluster Snapshots", "description"=>"Returns one or more snapshot objects, which contain metadata about your cluster\n snapshots.", "operationId"=>"describeClusterSnapshots", "x-api-path-slug"=>"actiondescribeclustersnapshots-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The identifier of the cluster for which information about snapshots is requested", "type"=>"string"}, {"in"=>"query", "name"=>"EndTime", "description"=>"A time value that requests only snapshots created at or before the specified time", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional parameter that specifies the starting point to return a set of response records", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of response records to return in each call", "type"=>"string"}, {"in"=>"query", "name"=>"OwnerAccount", "description"=>"The AWS customer account used to create or copy the snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotIdentifier", "description"=>"The snapshot identifier of the snapshot about which to return information", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotType", "description"=>"The type of snapshots for which you are requesting information", "type"=>"string"}, {"in"=>"query", "name"=>"StartTime", "description"=>"A value that requests only snapshots created at or after the specified time", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys.TagKey.N", "description"=>"A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys", "type"=>"string"}, {"in"=>"query", "name"=>"TagValues.TagValue.N", "description"=>"A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=DescribeClusterSubnetGroups"=>{"get"=>{"summary"=>"Describe Cluster Subnet Groups", "description"=>"Returns one or more cluster subnet group objects, which contain metadata about your\n cluster subnet groups.", "operationId"=>"describeClusterSubnetGroups", "x-api-path-slug"=>"actiondescribeclustersubnetgroups-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterSubnetGroupName", "description"=>"The name of the cluster subnet group for which information is requested", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional parameter that specifies the starting point to return a set of response records", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of response records to return in each call", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys.TagKey.N", "description"=>"A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys", "type"=>"string"}, {"in"=>"query", "name"=>"TagValues.TagValue.N", "description"=>"A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Subnet Groups"]}}, "/?Action=DescribeClusterVersions"=>{"get"=>{"summary"=>"Describe Cluster Versions", "description"=>"Returns descriptions of the available Amazon Redshift cluster versions.", "operationId"=>"describeClusterVersions", "x-api-path-slug"=>"actiondescribeclusterversions-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterParameterGroupFamily", "description"=>"The name of a specific cluster parameter group family to return details for", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterVersion", "description"=>"The specific cluster version to return", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional parameter that specifies the starting point to return a set of response records", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of response records to return in each call", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=DescribeDefaultClusterParameters"=>{"get"=>{"summary"=>"Describe Default Cluster Parameters", "description"=>"Returns a list of parameter settings for the specified parameter group\n family.", "operationId"=>"describeDefaultClusterParameters", "x-api-path-slug"=>"actiondescribedefaultclusterparameters-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"An optional parameter that specifies the starting point to return a set of response records", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of response records to return in each call", "type"=>"string"}, {"in"=>"query", "name"=>"ParameterGroupFamily", "description"=>"The name of the cluster parameter group family", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Parameters"]}}, "/?Action=DescribeEventCategories"=>{"get"=>{"summary"=>"Describe Event Categories", "description"=>"Displays a list of event categories for all event source types, or for a specified\n source type.", "operationId"=>"describeEventCategories", "x-api-path-slug"=>"actiondescribeeventcategories-get", "parameters"=>[{"in"=>"query", "name"=>"SourceType", "description"=>"The source type, such as cluster or parameter group, to which the described event categories apply", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Categories"]}}, "/?Action=DescribeEvents"=>{"get"=>{"summary"=>"Describe Events", "description"=>"Returns events related to clusters, security groups, snapshots, and parameter\n groups for the past 14 days.", "operationId"=>"describeEvents", "x-api-path-slug"=>"actiondescribeevents-get", "parameters"=>[{"in"=>"query", "name"=>"Duration", "description"=>"The number of minutes prior to the time of the request for which to retrieve events", "type"=>"string"}, {"in"=>"query", "name"=>"EndTime", "description"=>"The end of the time interval for which to retrieve events, specified in ISO 8601 format", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional parameter that specifies the starting point to return a set of response records", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of response records to return in each call", "type"=>"string"}, {"in"=>"query", "name"=>"SourceIdentifier", "description"=>"The identifier of the event source for which events will be returned", "type"=>"string"}, {"in"=>"query", "name"=>"SourceType", "description"=>"The event source to retrieve events for", "type"=>"string"}, {"in"=>"query", "name"=>"StartTime", "description"=>"The beginning of the time interval to retrieve events for, specified in ISO 8601 format", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Events"]}}, "/?Action=DescribeEventSubscriptions"=>{"get"=>{"summary"=>"Describe Event Subscriptions", "description"=>"Lists descriptions of all the Amazon Redshift event notifications subscription for a\n customer account.", "operationId"=>"describeEventSubscriptions", "x-api-path-slug"=>"actiondescribeeventsubscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"An optional parameter that specifies the starting point to return a set of response records", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of response records to return in each call", "type"=>"string"}, {"in"=>"query", "name"=>"SubscriptionName", "description"=>"The name of the Amazon Redshift event notification subscription to be described", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Subscriptions"]}}, "/?Action=DescribeHsmClientCertificates"=>{"get"=>{"summary"=>"Describe Hsm Client Certificates", "description"=>"Returns information about the specified HSM client certificate.", "operationId"=>"describeHsmClientCertificates", "x-api-path-slug"=>"actiondescribehsmclientcertificates-get", "parameters"=>[{"in"=>"query", "name"=>"HsmClientCertificateIdentifier", "description"=>"The identifier of a specific HSM client certificate for which you want information", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional parameter that specifies the starting point to return a set of response records", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of response records to return in each call", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys.TagKey.N", "description"=>"A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys", "type"=>"string"}, {"in"=>"query", "name"=>"TagValues.TagValue.N", "description"=>"A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["HSM Client Certificates"]}}, "/?Action=DescribeHsmConfigurations"=>{"get"=>{"summary"=>"Describe Hsm Configurations", "description"=>"Returns information about the specified Amazon Redshift HSM configuration.", "operationId"=>"describeHsmConfigurations", "x-api-path-slug"=>"actiondescribehsmconfigurations-get", "parameters"=>[{"in"=>"query", "name"=>"HsmConfigurationIdentifier", "description"=>"The identifier of a specific Amazon Redshift HSM configuration to be described", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional parameter that specifies the starting point to return a set of response records", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of response records to return in each call", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys.TagKey.N", "description"=>"A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys", "type"=>"string"}, {"in"=>"query", "name"=>"TagValues.TagValue.N", "description"=>"A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["HSM Configurations"]}}, "/?Action=DescribeLoggingStatus"=>{"get"=>{"summary"=>"Describe Logging Status", "description"=>"Describes whether information, such as queries and connection attempts, is being\n logged for the specified Amazon Redshift cluster.", "operationId"=>"describeLoggingStatus", "x-api-path-slug"=>"actiondescribeloggingstatus-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The identifier of the cluster from which to get the logging status", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logging"]}}, "/?Action=DescribeOrderableClusterOptions"=>{"get"=>{"summary"=>"Describe Orderable Cluster Options", "description"=>"Returns a list of orderable cluster options.", "operationId"=>"describeOrderableClusterOptions", "x-api-path-slug"=>"actiondescribeorderableclusteroptions-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterVersion", "description"=>"The version filter value", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional parameter that specifies the starting point to return a set of response records", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of response records to return in each call", "type"=>"string"}, {"in"=>"query", "name"=>"NodeType", "description"=>"The node type filter value", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Options"]}}, "/?Action=DescribeReservedNodeOfferings"=>{"get"=>{"summary"=>"Describe Reserved Node Offerings", "description"=>"Returns a list of the available reserved node offerings by Amazon Redshift with their\n descriptions including the node type, the fixed and recurring costs of reserving the\n node and duration the node will be reserved for you.", "operationId"=>"describeReservedNodeOfferings", "x-api-path-slug"=>"actiondescribereservednodeofferings-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"An optional parameter that specifies the starting point to return a set of response records", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of response records to return in each call", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedNodeOfferingId", "description"=>"The unique identifier for the offering", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reserved Nodes"]}}, "/?Action=DescribeReservedNodes"=>{"get"=>{"summary"=>"Describe Reserved Nodes", "description"=>"Returns the descriptions of the reserved nodes.", "operationId"=>"describeReservedNodes", "x-api-path-slug"=>"actiondescribereservednodes-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"An optional parameter that specifies the starting point to return a set of response records", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of response records to return in each call", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedNodeId", "description"=>"Identifier for the node reservation", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reserved Nodes"]}}, "/?Action=DescribeResize"=>{"get"=>{"summary"=>"Describe Resize", "description"=>"Returns information about the last resize operation for the specified cluster.", "operationId"=>"describeResize", "x-api-path-slug"=>"actiondescriberesize-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The unique identifier of a cluster whose resize progress you are requesting", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resize"]}}, "/?Action=DescribeSnapshotCopyGrants"=>{"get"=>{"summary"=>"Describe Snapshot Copy Grants", "description"=>"Returns a list of snapshot copy grants owned by the AWS account in the destination\n region.", "operationId"=>"describeSnapshotCopyGrants", "x-api-path-slug"=>"actiondescribesnapshotcopygrants-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"An optional parameter that specifies the starting point to return a set of response records", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of response records to return in each call", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotCopyGrantName", "description"=>"The name of the snapshot copy grant", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys.TagKey.N", "description"=>"A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys", "type"=>"string"}, {"in"=>"query", "name"=>"TagValues.TagValue.N", "description"=>"A tag value or values for which you want to return all matching resources that are associated with the specified value or values", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=DescribeTableRestoreStatus"=>{"get"=>{"summary"=>"Describe Table Restore Status", "description"=>"Lists the status of one or more table restore requests made using the.", "operationId"=>"describeTableRestoreStatus", "x-api-path-slug"=>"actiondescribetablerestorestatus-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The Amazon Redshift cluster that the table is being restored to", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"An optional pagination token provided by a previous DescribeTableRestoreStatus request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number of records to include in the response", "type"=>"string"}, {"in"=>"query", "name"=>"TableRestoreRequestId", "description"=>"The identifier of the table restore request to return status for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tables"]}}, "/?Action=DescribeTags"=>{"get"=>{"summary"=>"Describe Tags", "description"=>"Returns a list of tags.", "operationId"=>"describeTags", "x-api-path-slug"=>"actiondescribetags-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"A value that indicates the starting point for the next set of response records in a subsequent request", "type"=>"string"}, {"in"=>"query", "name"=>"MaxRecords", "description"=>"The maximum number or response records to return in each call", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceName", "description"=>"The Amazon Resource Name (ARN) for which you want to describe the tag or tags", "type"=>"string"}, {"in"=>"query", "name"=>"ResourceType", "description"=>"The type of resource with which you want to view tags", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys.TagKey.N", "description"=>"A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys", "type"=>"string"}, {"in"=>"query", "name"=>"TagValues.TagValue.N", "description"=>"A tag value or values for which you want to return all matching resources that are associated with the specified value or values", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=DisableLogging"=>{"get"=>{"summary"=>"Disable Logging", "description"=>"Stops logging information, such as queries and connection attempts, for the\n specified Amazon Redshift cluster.", "operationId"=>"disableLogging", "x-api-path-slug"=>"actiondisablelogging-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The identifier of the cluster on which logging is to be stopped", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logging"]}}, "/?Action=DisableSnapshotCopy"=>{"get"=>{"summary"=>"Disable Snapshot Copy", "description"=>"Disables the automatic copying of snapshots from one region to another region for a\n specified cluster.", "operationId"=>"disableSnapshotCopy", "x-api-path-slug"=>"actiondisablesnapshotcopy-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=EnableLogging"=>{"get"=>{"summary"=>"Enable Logging", "description"=>"Starts logging information, such as queries and connection attempts, for the\n specified Amazon Redshift cluster.", "operationId"=>"enableLogging", "x-api-path-slug"=>"actionenablelogging-get", "parameters"=>[{"in"=>"query", "name"=>"BucketName", "description"=>"The name of an existing S3 bucket where the log files are to be stored", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The identifier of the cluster on which logging is to be started", "type"=>"string"}, {"in"=>"query", "name"=>"S3KeyPrefix", "description"=>"The prefix applied to the log file names", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Logging"]}}, "/?Action=EnableSnapshotCopy"=>{"get"=>{"summary"=>"Enable Snapshot Copy", "description"=>"Enables the automatic copy of snapshots from one region to another region for a\n specified cluster.", "operationId"=>"enableSnapshotCopy", "x-api-path-slug"=>"actionenablesnapshotcopy-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The unique identifier of the source cluster to copy snapshots from", "type"=>"string"}, {"in"=>"query", "name"=>"DestinationRegion", "description"=>"The destination region that you want to copy snapshots to", "type"=>"string"}, {"in"=>"query", "name"=>"RetentionPeriod", "description"=>"The number of days to retain automated snapshots in the destination region after they are copied from the source region", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotCopyGrantName", "description"=>"The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=ModifyCluster"=>{"get"=>{"summary"=>"Modify Cluster", "description"=>"Modifies the settings for a cluster.", "operationId"=>"modifyCluster", "x-api-path-slug"=>"actionmodifycluster-get", "parameters"=>[{"in"=>"query", "name"=>"AllowVersionUpgrade", "description"=>"If true, major version upgrades will be applied automatically to the cluster during the maintenance window", "type"=>"string"}, {"in"=>"query", "name"=>"AutomatedSnapshotRetentionPeriod", "description"=>"The number of days that automated snapshots are retained", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The unique identifier of the cluster to be modified", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterParameterGroupName", "description"=>"The name of the cluster parameter group to apply to this cluster", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterSecurityGroups.ClusterSecurityGroupName.N", "description"=>"A list of cluster security groups to be authorized on this cluster", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterType", "description"=>"The new cluster type", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterVersion", "description"=>"The new version number of the Amazon Redshift engine to upgrade to", "type"=>"string"}, {"in"=>"query", "name"=>"ElasticIp", "description"=>"The Elastic IP (EIP) address for the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"EnhancedVpcRouting", "description"=>"An option that specifies whether to create the cluster with enhanced VPC routing enabled", "type"=>"string"}, {"in"=>"query", "name"=>"HsmClientCertificateIdentifier", "description"=>"Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM", "type"=>"string"}, {"in"=>"query", "name"=>"HsmConfigurationIdentifier", "description"=>"Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM", "type"=>"string"}, {"in"=>"query", "name"=>"MasterUserPassword", "description"=>"The new password for the cluster master user", "type"=>"string"}, {"in"=>"query", "name"=>"NewClusterIdentifier", "description"=>"The new identifier for the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"NodeType", "description"=>"The new node type of the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"NumberOfNodes", "description"=>"The new number of nodes of the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredMaintenanceWindow", "description"=>"The weekly time range (in UTC) during which system maintenance can occur, if necessary", "type"=>"string"}, {"in"=>"query", "name"=>"PubliclyAccessible", "description"=>"If true, the cluster can be accessed from a public network", "type"=>"string"}, {"in"=>"query", "name"=>"VpcSecurityGroupIds.VpcSecurityGroupId.N", "description"=>"A list of virtual private cloud (VPC) security groups to be associated with the cluster", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=ModifyClusterIamRoles"=>{"get"=>{"summary"=>"Modify Cluster Iam Roles", "description"=>"Modifies the list of AWS Identity and Access Management (IAM) roles that can be\n used by the cluster to access other AWS services.", "operationId"=>"modifyClusterIamRoles", "x-api-path-slug"=>"actionmodifyclusteriamroles-get", "parameters"=>[{"in"=>"query", "name"=>"AddIamRoles.IamRoleArn.N", "description"=>"Zero or more IAM roles to associate with the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The unique identifier of the cluster for which you want to associate or disassociate IAM roles", "type"=>"string"}, {"in"=>"query", "name"=>"RemoveIamRoles.IamRoleArn.N", "description"=>"Zero or more IAM roles in ARN format to disassociate from the cluster", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster IAM Roles"]}}, "/?Action=ModifyClusterParameterGroup"=>{"get"=>{"summary"=>"Modify Cluster Parameter Group", "description"=>"Modifies the parameters of a parameter group.", "operationId"=>"modifyClusterParameterGroup", "x-api-path-slug"=>"actionmodifyclusterparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"ParameterGroupName", "description"=>"The name of the parameter group to be modified", "type"=>"string"}, {"in"=>"query", "name"=>"Parameters.Parameter.N", "description"=>"An array of parameters to be modified", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Parameter Groups"]}}, "/?Action=ModifyClusterSubnetGroup"=>{"get"=>{"summary"=>"Modify Cluster Subnet Group", "description"=>"Modifies a cluster subnet group to include the specified list of VPC subnets.", "operationId"=>"modifyClusterSubnetGroup", "x-api-path-slug"=>"actionmodifyclustersubnetgroup-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterSubnetGroupName", "description"=>"The name of the subnet group to be modified", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A text description of the subnet group to be modified", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetIds.SubnetIdentifier.N", "description"=>"An array of VPC subnet IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Subnet Groups"]}}, "/?Action=ModifyEventSubscription"=>{"get"=>{"summary"=>"Modify Event Subscription", "description"=>"Modifies an existing Amazon Redshift event notification subscription.", "operationId"=>"modifyEventSubscription", "x-api-path-slug"=>"actionmodifyeventsubscription-get", "parameters"=>[{"in"=>"query", "name"=>"Enabled", "description"=>"A Boolean value indicating if the subscription is enabled", "type"=>"string"}, {"in"=>"query", "name"=>"EventCategories.EventCategory.N", "description"=>"Specifies the Amazon Redshift event categories to be published by the event notification subscription", "type"=>"string"}, {"in"=>"query", "name"=>"Severity", "description"=>"Specifies the Amazon Redshift event severity to be published by the event notification subscription", "type"=>"string"}, {"in"=>"query", "name"=>"SnsTopicArn", "description"=>"The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription", "type"=>"string"}, {"in"=>"query", "name"=>"SourceIds.SourceId.N", "description"=>"A list of one or more identifiers of Amazon Redshift source objects", "type"=>"string"}, {"in"=>"query", "name"=>"SourceType", "description"=>"The type of source that will be generating the events", "type"=>"string"}, {"in"=>"query", "name"=>"SubscriptionName", "description"=>"The name of the modified Amazon Redshift event notification subscription", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Event Subscriptions"]}}, "/?Action=ModifySnapshotCopyRetentionPeriod"=>{"get"=>{"summary"=>"Modify Snapshot Copy Retention Period", "description"=>"Modifies the number of days to retain automated snapshots in the destination region\n after they are copied from the source region.", "operationId"=>"modifySnapshotCopyRetentionPeriod", "x-api-path-slug"=>"actionmodifysnapshotcopyretentionperiod-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The unique identifier of the cluster for which you want to change the retention period for automated snapshots that are copied to a destination region", "type"=>"string"}, {"in"=>"query", "name"=>"RetentionPeriod", "description"=>"The number of days to retain automated snapshots in the destination region after they are copied from the source region", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=PurchaseReservedNodeOffering"=>{"get"=>{"summary"=>"Purchase Reserved Node Offering", "description"=>"Allows you to purchase reserved nodes.", "operationId"=>"purchaseReservedNodeOffering", "x-api-path-slug"=>"actionpurchasereservednodeoffering-get", "parameters"=>[{"in"=>"query", "name"=>"NodeCount", "description"=>"The number of reserved nodes that you want to purchase", "type"=>"string"}, {"in"=>"query", "name"=>"ReservedNodeOfferingId", "description"=>"The unique identifier of the reserved node offering you want to purchase", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reserved Nodes"]}}, "/?Action=RebootCluster"=>{"get"=>{"summary"=>"Reboot Cluster", "description"=>"Reboots a cluster.", "operationId"=>"rebootCluster", "x-api-path-slug"=>"actionrebootcluster-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The cluster identifier", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=ResetClusterParameterGroup"=>{"get"=>{"summary"=>"Reset Cluster Parameter Group", "description"=>"Sets one or more parameters of the specified parameter group to their default\n values and sets the source values of the parameters to \"engine-default\".", "operationId"=>"resetClusterParameterGroup", "x-api-path-slug"=>"actionresetclusterparametergroup-get", "parameters"=>[{"in"=>"query", "name"=>"ParameterGroupName", "description"=>"The name of the cluster parameter group to be reset", "type"=>"string"}, {"in"=>"query", "name"=>"Parameters.Parameter.N", "description"=>"An array of names of parameters to be reset", "type"=>"string"}, {"in"=>"query", "name"=>"ResetAllParameters", "description"=>"If true, all parameters in the specified parameter group will be reset to their default values", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Parameter Groups"]}}, "/?Action=RestoreFromClusterSnapshot"=>{"get"=>{"summary"=>"Restore From Cluster Snapshot", "description"=>"Creates a new cluster from a snapshot.", "operationId"=>"restoreFromClusterSnapshot", "x-api-path-slug"=>"actionrestorefromclustersnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"AdditionalInfo", "description"=>"Reserved", "type"=>"string"}, {"in"=>"query", "name"=>"AllowVersionUpgrade", "description"=>"If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"AutomatedSnapshotRetentionPeriod", "description"=>"The number of days that automated snapshots are retained", "type"=>"string"}, {"in"=>"query", "name"=>"AvailabilityZone", "description"=>"The Amazon EC2 Availability Zone in which to restore the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The identifier of the cluster that will be created from restoring the snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterParameterGroupName", "description"=>"The name of the parameter group to be associated with this cluster", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterSecurityGroups.ClusterSecurityGroupName.N", "description"=>"A list of security groups to be associated with this cluster", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterSubnetGroupName", "description"=>"The name of the subnet group where you want to cluster restored", "type"=>"string"}, {"in"=>"query", "name"=>"ElasticIp", "description"=>"The elastic IP (EIP) address for the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"EnhancedVpcRouting", "description"=>"An option that specifies whether to create the cluster with enhanced VPC routing enabled", "type"=>"string"}, {"in"=>"query", "name"=>"HsmClientCertificateIdentifier", "description"=>"Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM", "type"=>"string"}, {"in"=>"query", "name"=>"HsmConfigurationIdentifier", "description"=>"Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM", "type"=>"string"}, {"in"=>"query", "name"=>"IamRoles.IamRoleArn.N", "description"=>"A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyId", "description"=>"The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"NodeType", "description"=>"The node type that the restored cluster will be provisioned with", "type"=>"string"}, {"in"=>"query", "name"=>"OwnerAccount", "description"=>"The AWS customer account used to create or copy the snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"Port", "description"=>"The port number on which the cluster accepts connections", "type"=>"string"}, {"in"=>"query", "name"=>"PreferredMaintenanceWindow", "description"=>"The weekly time range (in UTC) during which automated cluster maintenance can occur", "type"=>"string"}, {"in"=>"query", "name"=>"PubliclyAccessible", "description"=>"If true, the cluster can be accessed from a public network", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotClusterIdentifier", "description"=>"The name of the cluster the source snapshot was created from", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotIdentifier", "description"=>"The name of the snapshot from which to create the new cluster", "type"=>"string"}, {"in"=>"query", "name"=>"VpcSecurityGroupIds.VpcSecurityGroupId.N", "description"=>"A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=RestoreTableFromClusterSnapshot"=>{"get"=>{"summary"=>"Restore Table From Cluster Snapshot", "description"=>"Creates a new table from a table in an Amazon Redshift cluster snapshot.", "operationId"=>"restoreTableFromClusterSnapshot", "x-api-path-slug"=>"actionrestoretablefromclustersnapshot-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The identifier of the Amazon Redshift cluster to restore the table to", "type"=>"string"}, {"in"=>"query", "name"=>"NewTableName", "description"=>"The name of the table to create as a result of the current request", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotIdentifier", "description"=>"The identifier of the snapshot to restore the table from", "type"=>"string"}, {"in"=>"query", "name"=>"SourceDatabaseName", "description"=>"The name of the source database that contains the table to restore from", "type"=>"string"}, {"in"=>"query", "name"=>"SourceSchemaName", "description"=>"The name of the source schema that contains the table to restore from", "type"=>"string"}, {"in"=>"query", "name"=>"SourceTableName", "description"=>"The name of the source table to restore from", "type"=>"string"}, {"in"=>"query", "name"=>"TargetDatabaseName", "description"=>"The name of the database to restore the table to", "type"=>"string"}, {"in"=>"query", "name"=>"TargetSchemaName", "description"=>"The name of the schema to restore the table to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=RevokeClusterSecurityGroupIngress"=>{"get"=>{"summary"=>"Revoke Cluster Security Group Ingress", "description"=>"Revokes an ingress rule in an Amazon Redshift security group for a previously authorized\n IP range or Amazon EC2 security group.", "operationId"=>"revokeClusterSecurityGroupIngress", "x-api-path-slug"=>"actionrevokeclustersecuritygroupingress-get", "parameters"=>[{"in"=>"query", "name"=>"CIDRIP", "description"=>"The IP range for which to revoke access", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterSecurityGroupName", "description"=>"The name of the security Group from which to revoke the ingress rule", "type"=>"string"}, {"in"=>"query", "name"=>"EC2SecurityGroupName", "description"=>"The name of the EC2 Security Group whose access is to be revoked", "type"=>"string"}, {"in"=>"query", "name"=>"EC2SecurityGroupOwnerId", "description"=>"The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Security Group"]}}, "/?Action=RevokeSnapshotAccess"=>{"get"=>{"summary"=>"Revoke Snapshot Access", "description"=>"Removes the ability of the specified AWS customer account to restore the specified\n snapshot.", "operationId"=>"revokeSnapshotAccess", "x-api-path-slug"=>"actionrevokesnapshotaccess-get", "parameters"=>[{"in"=>"query", "name"=>"AccountWithRestoreAccess", "description"=>"The identifier of the AWS customer account that can no longer restore the specified snapshot", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotClusterIdentifier", "description"=>"The identifier of the cluster the snapshot was created from", "type"=>"string"}, {"in"=>"query", "name"=>"SnapshotIdentifier", "description"=>"The identifier of the snapshot that the account can no longer access", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshots"]}}, "/?Action=RotateEncryptionKey"=>{"get"=>{"summary"=>"Rotate Encryption Key", "description"=>"Rotates the encryption keys for a cluster.", "operationId"=>"rotateEncryptionKey", "x-api-path-slug"=>"actionrotateencryptionkey-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterIdentifier", "description"=>"The unique identifier of the cluster that you want to rotate the encryption keys for", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Encryption Keys"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-analysis-services{"azure-analysis-services-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Analysis Services", "x-complete"=>1, "info"=>{"title"=>"AzureAnalysisServices", "description"=>"the-azure-analysis-services-web-api-provides-a-restful-set-of-web-services-that-enables-users-to-create-retrieve-update-and-delete-analysis-services-servers", "version"=>"2016-05-16"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}"=>{"get"=>{"summary"=>"Get Server", "description"=>"Gets details about the specified Analysis Services server.", "operationId"=>"Servers_GetDetails", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-analysisservicesserversservername-get", "parameters"=>[{"in"=>"path", "name"=>"serverName", "description"=>"The name of the Analysis Services server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}, "put"=>{"summary"=>"Create Server", "description"=>"Provisions the specified Analysis Services server based on the configuration specified in the request.", "operationId"=>"Servers_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-analysisservicesserversservername-put", "parameters"=>[{"in"=>"path", "name"=>"serverName", "description"=>"The name of the Analysis Services server"}, {"in"=>"body", "name"=>"serverParameters", "description"=>"Contains the information used to provision the Analysis Services server", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}, "delete"=>{"summary"=>"Delete Servers", "description"=>"Deletes the specified Analysis Services server.", "operationId"=>"Servers_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-analysisservicesserversservername-delete", "parameters"=>[{"in"=>"path", "name"=>"serverName", "description"=>"The name of the Analysis Services server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}, "patch"=>{"summary"=>"Update Server", "description"=>"Updates the current state of the specified Analysis Services server.", "operationId"=>"Servers_Update", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-analysisservicesserversservername-patch", "parameters"=>[{"in"=>"path", "name"=>"serverName", "description"=>"The name of the Analysis Services server"}, {"in"=>"body", "name"=>"serverUpdateParameters", "description"=>"Request object that contains the updated information for the server", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/suspend"=>{"post"=>{"summary"=>"Suspend Server", "description"=>"Supends operation of the specified Analysis Services server instance.", "operationId"=>"Servers_Suspend", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-analysisservicesserversservernamesuspend-post", "parameters"=>[{"in"=>"path", "name"=>"serverName", "description"=>"The name of the Analysis Services server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/resume"=>{"post"=>{"summary"=>"Resume Server", "description"=>"Resumes operation of the specified Analysis Services server instance.", "operationId"=>"Servers_Resume", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-analysisservicesserversservernameresume-post", "parameters"=>[{"in"=>"path", "name"=>"serverName", "description"=>"The name of the Analysis Services server"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers"=>{"get"=>{"summary"=>"List Servers By Group", "description"=>"Gets all the Analysis Services servers for the given resource group.", "operationId"=>"Servers_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-analysisservicesservers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/servers"=>{"get"=>{"summary"=>"List Servers", "description"=>"Lists all the Analysis Services servers for the given subscription.", "operationId"=>"Servers_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-analysisservicesservers-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Servers"]}}}}, "apis"=>{"name"=>"Azure Analysis Services", "x-slug"=>"azure-analysis-services", "description"=>"Use Azure Resource Manager to create and deploy an Azure Analysis Services instance within seconds, and use backup restore to quickly move your existing models to Azure Analysis Services and take advantage of the scale, flexibility and management benefits of the cloud. Scale up, scale down, or pause the service and pay only for what you use.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/transform-complex-data.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Analysis,API Provider,API Service Provider,Microsoft,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-analysis-services/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Analysis Services API", "x-api-slug"=>"azure-analysis-services-api", "description"=>"Use Azure Resource Manager to create and deploy an Azure Analysis Services instance within seconds, and use backup restore to quickly move your existing models to Azure Analysis Services and take advantage of the scale, flexibility and management benefits of the cloud. Scale up, scale down, or pause the service and pay only for what you use.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/transform-complex-data.png", "humanURL"=>"https://azure.microsoft.com/en-us/services/analysis-services/", "baseURL"=>"://management.azure.com//", "tags"=>"Analysis,API Provider,API Service Provider,Microsoft,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-analysis-services/subscriptionssubscriptionidprovidersmicrosoft-analysisservicesservers-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-analysis-services/azure-analysis-services-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"https://docs.microsoft.com/en-us/azure/analysis-services/"}, {"type"=>"x-pricing", "url"=>"https://azure.microsoft.com/en-us/pricing/details/analysis-services/"}, {"type"=>"x-service-level-agreements", "url"=>"https://azure.microsoft.com/en-us/support/legal/sla/analysis-services/"}, {"type"=>"x-status", "url"=>"https://azure.microsoft.com/en-us/status/"}, {"type"=>"x-website", "url"=>"https://azure.microsoft.com/en-us/services/analysis-services/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
alpha-vantage{"alpha-vantage-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Alpha Vantage", "x-complete"=>1, "info"=>{"title"=>"Alpha Vantage", "description"=>"alpha-vantage-apis-are-grouped-into-four-categories-1-stock-time-series-data-2-physical-and-digitalcrypto-currencies-e-g--bitcoin-3-stock-technical-indicators-and-4-sector-performances--all-apis-are-realtime-the-latest-data-points-are-derived-from-the-current-trading-day--", "version"=>"1.0.0"}, "host"=>"www.alphavantage.co", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/query?function=TIME_SERIES_INTRADAY"=>{"get"=>{"summary"=>"Intraday Time Series", "description"=>"This API returns intraday time series (timestamp, open, high, low, close, volume) of the equity specified, updated realtime.", "operationId"=>"getIntradayTimeSeries", "x-api-path-slug"=>"queryfunctiontime-series-intraday-get", "parameters"=>[{"in"=>"query", "name"=>"datatype", "description"=>"By default, datatype=json", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"interval", "description"=>"The interval for series (1min, 5min, 15min, 30min, 60min)", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"outputsize", "description"=>"By default, outputsize=compact", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"symbol", "description"=>"The stocker ticker symbol", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Time Series"]}}, "/query?function=TIME_SERIES_DAILY_ADJUSTED"=>{"get"=>{"summary"=>"Daily Time Series Adjusted", "description"=>"This API returns daily time series (date, daily open, daily high, daily low, daily close, daily volume, daily adjusted close, and split/dividend events) of the equity specified, covering up to 20 years of historical data.", "operationId"=>"getDailyTimeSeriesAdjusted", "x-api-path-slug"=>"queryfunctiontime-series-daily-adjusted-get", "parameters"=>[{"in"=>"query", "name"=>"symbol", "description"=>"The stocker ticker symbol", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Time Series"]}}, "/query?function=TIME_SERIES_WEEKLY"=>{"get"=>{"summary"=>"Weekly Time Series", "description"=>"This API returns weekly time series (last trading day of each week, weekly open, weekly high, weekly low, weekly close, weekly volume) of the equity specified, covering up to 20 years of historical data.", "operationId"=>"getWeeklyTimeSeries", "x-api-path-slug"=>"queryfunctiontime-series-weekly-get", "parameters"=>[{"in"=>"query", "name"=>"symbol", "description"=>"The stocker ticker symbol", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Time Series"]}}, "/query?function=TIME_SERIES_DAILY"=>{"get"=>{"summary"=>"Daily Time Series", "description"=>"This API returns daily time series (date, daily open, daily high, daily low, daily close, daily volume) of the equity specified, covering up to 20 years of historical data.", "operationId"=>"getDailyTimeSeries", "x-api-path-slug"=>"queryfunctiontime-series-daily-get", "parameters"=>[{"in"=>"query", "name"=>"symbol", "description"=>"The stocker ticker symbol", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Time Series"]}}, "/query?function=TIME_SERIES_MONTHLY"=>{"get"=>{"summary"=>"Monthly Time Series", "description"=>"This API returns monthly time series (last trading day of each month, monthly open, monthly high, monthly low, monthly close, monthly volume) of the equity specified, covering up to 20 years of historical data.", "operationId"=>"getMonthlyTimeSeries", "x-api-path-slug"=>"queryfunctiontime-series-monthly-get", "parameters"=>[{"in"=>"query", "name"=>"symbol", "description"=>"The stocker ticker symbol", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Time Series"]}}, "/query?function=TIME_SERIES_MONTHLY_ADJUSTED"=>{"get"=>{"summary"=>"Monthly Time Series Adjusted", "description"=>"This API returns monthly adjusted time series (last trading day of each month, monthly open, monthly high, monthly low, monthly close, monthly adjusted close, monthly volume, monthly dividend) of the equity specified, covering up to 20 years of historical data.", "operationId"=>"getMonthlyTimeSeriesAdjusted", "x-api-path-slug"=>"queryfunctiontime-series-monthly-adjusted-get", "parameters"=>[{"in"=>"query", "name"=>"symbol", "description"=>"The stocker ticker symbol", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Time Series"]}}, "/query?function=BATCH_STOCK_QUOTES"=>{"get"=>{"summary"=>"Batch Stock Quotes", "description"=>"The batch stock quotes API enables the querying of multiple stock quotes with a single API request, updated realtime. It may serve as a lightweight alternative to our core stock time series APIs above (which have richer content but are symbol-specific).", "operationId"=>"getBatchStockQuotes", "x-api-path-slug"=>"queryfunctionbatch-stock-quotes-get", "parameters"=>[{"in"=>"query", "name"=>"symbols", "description"=>"Up to 100 stock symbols seperated by comma", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Time Series", "Stock Quotes"]}}, "/query?function=CURRENCY_EXCHANGE_RATE"=>{"get"=>{"summary"=>"Currency Exchange Rates", "description"=>"Realtime currency exchange rates for physical and digital currencies.", "operationId"=>"getCurrencyExchangeRates", "x-api-path-slug"=>"queryfunctioncurrency-exchange-rate-get", "parameters"=>[{"in"=>"query", "name"=>"from_currency", "description"=>"The currency you would like to get the exchange rate for", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"to_currency", "description"=>"The destination currency for the exchange rate", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Currency", "Exchange Rates"]}}, "/query?function=DIGITAL_CURRENCY_INTRADAY"=>{"get"=>{"summary"=>"Digital Currencies Intraday", "description"=>"This API returns the realtime intraday time series (in 5-minute intervals) for any digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan). Prices and volumes are quoted in both the market-specific currency and USD.", "operationId"=>"getDigitalCurrenciesIntraday", "x-api-path-slug"=>"queryfunctiondigital-currency-intraday-get", "parameters"=>[{"in"=>"query", "name"=>"market", "description"=>"The exchange market of your choice", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"symbol", "description"=>"The digital/crypto currency of your choice", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Digital Currencies", "Intraday", "Time Series"]}}, "/query?function=DIGITAL_CURRENCY_DAILY"=>{"get"=>{"summary"=>"Digital Currencies Daily", "description"=>"This API returns the daily historical time series for a digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan), refreshed daily at midnight (UTC). Prices and volumes are quoted in both the market-specific currency and USD.", "operationId"=>"getDigitalCurrenciesDaily", "x-api-path-slug"=>"queryfunctiondigital-currency-daily-get", "parameters"=>[{"in"=>"query", "name"=>"market", "description"=>"The exchange market of your choice", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"symbol", "description"=>"The digital/crypto currency of your choice", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Digital Currencies", "Daily", "Time Series"]}}, "/query?function=DIGITAL_CURRENCY_WEEKLY"=>{"get"=>{"summary"=>"Digital Currencies Weekly", "description"=>"This API returns the weekly historical time series for a digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan), refreshed daily at midnight (UTC). Prices and volumes are quoted in both the market-specific currency and USD.", "operationId"=>"getDigitalCurrenciesWeekly", "x-api-path-slug"=>"queryfunctiondigital-currency-weekly-get", "parameters"=>[{"in"=>"query", "name"=>"market", "description"=>"The exchange market of your choice", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"symbol", "description"=>"The digital/crypto currency of your choice", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Digital Currencies", "Weekly", "Time Series"]}}, "/query?function=DIGITAL_CURRENCY_MONTHLY"=>{"get"=>{"summary"=>"Digital Currencies Monthly", "description"=>"This API returns the monthly historical time series for a digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan), refreshed daily at midnight (UTC). Prices and volumes are quoted in both the market-specific currency and USD.", "operationId"=>"getDigitalCurrenciesMonthly", "x-api-path-slug"=>"queryfunctiondigital-currency-monthly-get", "parameters"=>[{"in"=>"query", "name"=>"market", "description"=>"The exchange market of your choice", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"symbol", "description"=>"The digital/crypto currency of your choice", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Digital Currencies", "Monthly", "Time Series"]}}, "/query?function=SMA"=>{"get"=>{"summary"=>"Simple Moving Average (SMA)", "description"=>"This API returns the simple moving average (SMA) values.", "operationId"=>"getSimpleMovingAverage", "x-api-path-slug"=>"queryfunctionsma-get", "parameters"=>[{"in"=>"query", "name"=>"interval", "description"=>"Time interval between two consecutive data points in the time series", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"series_type", "description"=>"The desired price type in the time series", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"symbol", "description"=>"The name of the equity of your choice", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"time_period", "description"=>"Number of data points used to calculate each moving average value", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Simple Moving Average", "SMA"]}}, "/query?function=EMA"=>{"get"=>{"summary"=>"Exponential Moving Average (EMA)", "description"=>"This API returns the exponential moving average (EMA)", "operationId"=>"getExponentialMovingAverage", "x-api-path-slug"=>"queryfunctionema-get", "parameters"=>[{"in"=>"query", "name"=>"interval", "description"=>"Time interval between two consecutive data points in the time series", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"series_type", "description"=>"The desired price type in the time series", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"symbol", "description"=>"The name of the equity of your choice", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"time_period", "description"=>"Number of data points used to calculate each moving average value", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Exponential Moving Average", "EMA"]}}, "/query?function=MACD"=>{"get"=>{"summary"=>"Moving Average Convergence / Divergence (MACD)", "description"=>"This API returns the moving average convergence / divergence (MACD) values.", "operationId"=>"getMovingAverageConvergenceDivergence", "x-api-path-slug"=>"queryfunctionmacd-get", "parameters"=>[{"in"=>"query", "name"=>"interval", "description"=>"Time interval between two consecutive data points in the time series", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"series_type", "description"=>"The desired price type in the time series", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"symbol", "description"=>"The name of the equity of your choice", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"time_period", "description"=>"Number of data points used to calculate each moving average value", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Moving Average Convergence", "MACD"]}}, "/query?function=STOCH"=>{"get"=>{"summary"=>"Stochastic Oscillator (STOCH)", "description"=>"This API returns the stochastic oscillator (STOCH) values.", "operationId"=>"getStochasticOscillator", "x-api-path-slug"=>"queryfunctionstoch-get", "parameters"=>[{"in"=>"query", "name"=>"interval", "description"=>"Time interval between two consecutive data points in the time series", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"symbol", "description"=>"The name of the equity of your choice", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Stochastic Oscillator", "STOCH"]}}, "/query?function=RSI"=>{"get"=>{"summary"=>"Relative Strength Index (RSI)", "description"=>"This API returns the relative strength index (RSI) values.", "operationId"=>"getRelativeStrengthIndex", "x-api-path-slug"=>"queryfunctionrsi-get", "parameters"=>[{"in"=>"query", "name"=>"interval", "description"=>"Time interval between two consecutive data points in the time series", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"series_type", "description"=>"The desired price type in the time series", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"symbol", "description"=>"The name of the equity of your choice", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"time_period", "description"=>"Number of data points used to calculate each moving average value", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Relative Strength Index", "RSI"]}}, "/query?function=ADX"=>{"get"=>{"summary"=>"Average Directional Movement Index (ADX)", "description"=>"This API returns the average directional movement index (ADX) values.", "operationId"=>"getAverageDirectionalMovementIndex", "x-api-path-slug"=>"queryfunctionadx-get", "parameters"=>[{"in"=>"query", "name"=>"interval", "description"=>"Time interval between two consecutive data points in the time series", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"symbol", "description"=>"The name of the equity of your choice", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"time_period", "description"=>"Number of data points used to calculate each moving average value", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Average Directional Movement Index", "ADX"]}}, "/query?function=CCI"=>{"get"=>{"summary"=>"Commodity Channel Index (CCI)", "description"=>"This API returns the commodity channel index (CCI) values.", "operationId"=>"getCommodityChannelIndex", "x-api-path-slug"=>"queryfunctioncci-get", "parameters"=>[{"in"=>"query", "name"=>"interval", "description"=>"Time interval between two consecutive data points in the time series", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"symbol", "description"=>"The name of the equity of your choice", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"time_period", "description"=>"Number of data points used to calculate each moving average value", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Commodity Channel Index", "CCI"]}}, "/query?function=AROON"=>{"get"=>{"summary"=>"Aroon (AROON)", "description"=>"This API returns the Aroon (AROON) values.", "operationId"=>"getArroon", "x-api-path-slug"=>"queryfunctionaroon-get", "parameters"=>[{"in"=>"query", "name"=>"interval", "description"=>"Time interval between two consecutive data points in the time series", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"symbol", "description"=>"The name of the equity of your choice", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"time_period", "description"=>"Number of data points used to calculate each moving average value", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Aroon", "AROON"]}}, "/query?function=BBANDS"=>{"get"=>{"summary"=>"Bollinger bands (BBANDS)", "description"=>"This API returns the Bollinger bands (BBANDS) values.", "operationId"=>"getbollingerBands", "x-api-path-slug"=>"queryfunctionbbands-get", "parameters"=>[{"in"=>"query", "name"=>"interval", "description"=>"Time interval between two consecutive data points in the time series", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"series_type", "description"=>"The desired price type in the time series", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"symbol", "description"=>"The name of the equity of your choice", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"time_period", "description"=>"Number of data points used to calculate each moving average value", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Bollinger bands", "BBANDS"]}}, "/query?function=AD"=>{"get"=>{"summary"=>"Chaikin A/D line (AD)", "description"=>"This API returns the Chaikin A/D line (AD) values.", "operationId"=>"getChalkinADLine", "x-api-path-slug"=>"queryfunctionad-get", "parameters"=>[{"in"=>"query", "name"=>"interval", "description"=>"Time interval between two consecutive data points in the time series", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"symbol", "description"=>"The name of the equity of your choice", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Chaikin A/D Line", "AD)"]}}, "/query?function=OBV"=>{"get"=>{"summary"=>"Balance Volume (OBV)", "description"=>"This API returns the on balance volume (OBV) values.", "operationId"=>"getBalanceVolume", "x-api-path-slug"=>"queryfunctionobv-get", "parameters"=>[{"in"=>"query", "name"=>"interval", "description"=>"Time interval between two consecutive data points in the time series", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"symbol", "description"=>"The name of the equity of your choice", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Balance Volume", "OBV"]}}, "/query?function=SECTOR"=>{"get"=>{"summary"=>"Sector Performance", "description"=>"This API returns the realtime and historical sector performances calculated from S&P500 incumbents.", "operationId"=>"getSectorPerformance", "x-api-path-slug"=>"queryfunctionsector-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Market Data", "Sector", "Performance"]}}}}, "apis"=>{"name"=>"Alpha Vantage", "x-slug"=>"alpha-vantage", "description"=>"Composed of a tight-knit community of researchers, engineers, and business professionals, Alpha Vantage Inc. is a leading provider of free APIs for realtime and historical data on stocks, physical currencies, and digital/crypto currencies. Our success is driven by rigorous research, cutting edge technology, and a disciplined focus on democratizing access to data.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2018-01-22 at 4.52.35 PM.png", "x-kinRank"=>"8", "x-alexaRank"=>"160846", "tags"=>"API Provider,Blockchain,Blockchains,Free Tier,Have API Key,Market Data,Profiles,Relative Data", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"alpha-vantage/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Alpha Vantage", "x-api-slug"=>"alpha-vantage", "description"=>"Composed of a tight-knit community of researchers, engineers, and business professionals, Alpha Vantage Inc. is a leading provider of free APIs for realtime and historical data on stocks, physical currencies, and digital/crypto currencies. Our success is driven by rigorous research, cutting edge technology, and a disciplined focus on democratizing access to data.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2018-01-22 at 4.52.35 PM.png", "humanURL"=>"https://www.alphavantage.co", "baseURL"=>"https://www.alphavantage.co//", "tags"=>"API Provider,Blockchain,Blockchains,Free Tier,Have API Key,Market Data,Profiles,Relative Data", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/alpha-vantage/alpha-vantage-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-command-line-interface", "url"=>"https://www.npmjs.com/package/alpha-vantage-cli"}, {"type"=>"x-documentation", "url"=>"https://www.alphavantage.co/documentation/"}, {"type"=>"x-forum", "url"=>"https://www.alpha-vantage.community/"}, {"type"=>"x-selfservice-registration", "url"=>"https://www.alphavantage.co/support/#api-key"}, {"type"=>"x-support", "url"=>"https://www.alphavantage.co/support/#support"}, {"type"=>"x-terms-of-service", "url"=>"https://www.alphavantage.co/terms_of_service/"}, {"type"=>"x-website", "url"=>"https://www.alphavantage.co"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
new-relic{"new-relic-openapi"=>false, "apis"=>{"name"=>"New Relic", "x-slug"=>"new-relic", "description"=>"New Relic???s digital intelligence platform lets developers, ops, and tech teams measure and monitor the performance of their applications and infrastructure.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/22963-new-relic.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"10322", "tags"=>"API Service Provider,Monitoring,Performance,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"new-relic/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"New Relic", "x-api-slug"=>"new-relic", "description"=>"New Relic???s digital intelligence platform lets developers, ops, and tech teams measure and monitor the performance of their applications and infrastructure.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/22963-new-relic.jpg", "humanURL"=>"https://newrelic.com/", "baseURL"=>"https:///v2/", "tags"=>"API Service Provider,Monitoring,Performance,Profiles,Relative Data,SaaS,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/new-relic/new-relic-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://blog.newrelic.com/"}, {"type"=>"x-blog-rss", "url"=>"https://blog.newrelic.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/new-relic"}, {"type"=>"x-developer", "url"=>"https://rpm.newrelic.com/api/explore/"}, {"type"=>"x-email", "url"=>"billing@newrelic.com"}, {"type"=>"x-email", "url"=>"resume@newrelic.com"}, {"type"=>"x-email", "url"=>"PR@newrelic.com"}, {"type"=>"x-email", "url"=>"copyright@newrelic.com"}, {"type"=>"x-email", "url"=>"dataprivacy@newrelic.com"}, {"type"=>"x-email", "url"=>"PersonalDataRequest@newrelic.com"}, {"type"=>"x-email", "url"=>"support@newrelic.com"}, {"type"=>"x-email", "url"=>"compliance@newrelic.com"}, {"type"=>"x-github", "url"=>"https://github.com/newrelic"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/NewRelic"}, {"type"=>"x-website", "url"=>"https://newrelic.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
tvmaze{"tvmaze-user-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"TVmaze", "x-complete"=>1, "info"=>{"title"=>"TVmaze user", "description"=>"access-to-the-user-api-is-only-possible-for-users-with-a-premiumhttpwww-tvmaze-compremium-account--a-user-can-only-access-their-own-user-data-authentication-uses-http-basic--use-the-tvmaze-username-as-authentication-username-and-the-tvmaze-api-key-as-authentication-password--your-api-key-can-be-found-on-your-dashboardhttpwww-tvmaze-comdashboard--to-try-out-these-api-calls-from-this-page-click-the-authorize-button-on-top-and-input-your-credentials-", "version"=>"1.0"}, "host"=>"api.tvmaze.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/user/episodes"=>{"get"=>{"summary"=>"Get User Episodes", "description"=>"Get user episodes.", "operationId"=>"getUserEpisodes", "x-api-path-slug"=>"userepisodes-get", "parameters"=>[{"in"=>"query", "name"=>"show_id", "description"=>"Only return episodes from this specific show"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Episodes"]}}, "/user/episodes/{episode_id}"=>{"delete"=>{"summary"=>"Delete User Episodes", "description"=>"Delete user episodes.", "operationId"=>"deleteUserEpisodesEpisode", "x-api-path-slug"=>"userepisodesepisode-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Episodes"]}, "get"=>{"summary"=>"Get User Episodes", "description"=>"Get user episodes.", "operationId"=>"getUserEpisodesEpisode", "x-api-path-slug"=>"userepisodesepisode-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Episodes"]}, "parameters"=>{"summary"=>"Parameters User Episodes", "description"=>"Parameters user episodes.", "operationId"=>"parametersUserEpisodesEpisode", "x-api-path-slug"=>"userepisodesepisode-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Parameters", "User", "Episodes"]}, "put"=>{"summary"=>"Put User Episodes", "description"=>"Set `marked_at` to `NULL` or leave it out to use the current time.", "operationId"=>"putUserEpisodesEpisode", "x-api-path-slug"=>"userepisodesepisode-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Episodes"]}}, "/user/follows/networks"=>{"get"=>{"summary"=>"Get User Follows Networks", "description"=>"Get user follows networks.", "operationId"=>"getUserFollowsNetworks", "x-api-path-slug"=>"userfollowsnetworks-get", "parameters"=>[{"in"=>"query", "name"=>"embed", "description"=>"Embed full network info"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Follows", "Networks"]}}, "/user/follows/networks/{network_id}"=>{"delete"=>{"summary"=>"Delete User Follows Networks", "description"=>"Delete user follows networks.", "operationId"=>"deleteUserFollowsNetworksNetwork", "x-api-path-slug"=>"userfollowsnetworksnetwork-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Follows", "Networks"]}, "get"=>{"summary"=>"Get User Follows Networks", "description"=>"Get user follows networks.", "operationId"=>"getUserFollowsNetworksNetwork", "x-api-path-slug"=>"userfollowsnetworksnetwork-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Follows", "Networks"]}, "parameters"=>{"summary"=>"Parameters User Follows Networks", "description"=>"Parameters user follows networks.", "operationId"=>"parametersUserFollowsNetworksNetwork", "x-api-path-slug"=>"userfollowsnetworksnetwork-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Parameters", "User", "Follows", "Networks"]}, "put"=>{"summary"=>"Put User Follows Networks", "description"=>"Put user follows networks.", "operationId"=>"putUserFollowsNetworksNetwork", "x-api-path-slug"=>"userfollowsnetworksnetwork-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Follows", "Networks"]}}, "/user/follows/people"=>{"get"=>{"summary"=>"Get User Follows People", "description"=>"Get user follows people.", "operationId"=>"getUserFollowsPeople", "x-api-path-slug"=>"userfollowspeople-get", "parameters"=>[{"in"=>"query", "name"=>"embed", "description"=>"Embed full person info"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Follows", "People"]}}, "/user/follows/people/{person_id}"=>{"delete"=>{"summary"=>"Delete User Follows People Person", "description"=>"Delete user follows people person.", "operationId"=>"deleteUserFollowsPeoplePerson", "x-api-path-slug"=>"userfollowspeopleperson-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Follows", "People", "Person"]}, "get"=>{"summary"=>"Get User Follows People Person", "description"=>"Get user follows people person.", "operationId"=>"getUserFollowsPeoplePerson", "x-api-path-slug"=>"userfollowspeopleperson-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Follows", "People", "Person"]}, "parameters"=>{"summary"=>"Parameters User Follows People Person", "description"=>"Parameters user follows people person.", "operationId"=>"parametersUserFollowsPeoplePerson", "x-api-path-slug"=>"userfollowspeopleperson-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Parameters", "User", "Follows", "People", "Person"]}, "put"=>{"summary"=>"Put User Follows People Person", "description"=>"Put user follows people person.", "operationId"=>"putUserFollowsPeoplePerson", "x-api-path-slug"=>"userfollowspeopleperson-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Follows", "People", "Person"]}}, "/user/follows/shows"=>{"get"=>{"summary"=>"Get User Follows Shows", "description"=>"Get user follows shows.", "operationId"=>"getUserFollowsShows", "x-api-path-slug"=>"userfollowsshows-get", "parameters"=>[{"in"=>"query", "name"=>"embed", "description"=>"Embed full show info"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Follows", "Shows"]}}, "/user/follows/shows/{show_id}"=>{"delete"=>{"summary"=>"Delete User Follows Shows", "description"=>"Delete user follows shows.", "operationId"=>"deleteUserFollowsShowsShow", "x-api-path-slug"=>"userfollowsshowsshow-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Follows", "Shows"]}, "get"=>{"summary"=>"Get User Follows Shows", "description"=>"Get user follows shows.", "operationId"=>"getUserFollowsShowsShow", "x-api-path-slug"=>"userfollowsshowsshow-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Follows", "Shows"]}, "parameters"=>{"summary"=>"Parameters User Follows Shows", "description"=>"Parameters user follows shows.", "operationId"=>"parametersUserFollowsShowsShow", "x-api-path-slug"=>"userfollowsshowsshow-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Parameters", "User", "Follows", "Shows"]}, "put"=>{"summary"=>"Put User Follows Shows", "description"=>"Put user follows shows.", "operationId"=>"putUserFollowsShowsShow", "x-api-path-slug"=>"userfollowsshowsshow-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Follows", "Shows"]}}, "/user/follows/webchannels"=>{"get"=>{"summary"=>"Get User Follows Webchannels", "description"=>"Get user follows webchannels.", "operationId"=>"getUserFollowsWebchannels", "x-api-path-slug"=>"userfollowswebchannels-get", "parameters"=>[{"in"=>"query", "name"=>"embed", "description"=>"Embed full webchannel info"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Follows", "Webchannels"]}}, "/user/follows/webchannels/{webchannel_id}"=>{"delete"=>{"summary"=>"Delete User Follows Webchannels Webchannel", "description"=>"Delete user follows webchannels webchannel.", "operationId"=>"deleteUserFollowsWebchannelsWebchannel", "x-api-path-slug"=>"userfollowswebchannelswebchannel-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Follows", "Webchannels", "Webchannel"]}, "get"=>{"summary"=>"Get User Follows Webchannels Webchannel", "description"=>"Get user follows webchannels webchannel.", "operationId"=>"getUserFollowsWebchannelsWebchannel", "x-api-path-slug"=>"userfollowswebchannelswebchannel-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Follows", "Webchannels", "Webchannel"]}, "parameters"=>{"summary"=>"Parameters User Follows Webchannels Webchannel", "description"=>"Parameters user follows webchannels webchannel.", "operationId"=>"parametersUserFollowsWebchannelsWebchannel", "x-api-path-slug"=>"userfollowswebchannelswebchannel-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Parameters", "User", "Follows", "Webchannels", "Webchannel"]}, "put"=>{"summary"=>"Put User Follows Webchannels Webchannel", "description"=>"Put user follows webchannels webchannel.", "operationId"=>"putUserFollowsWebchannelsWebchannel", "x-api-path-slug"=>"userfollowswebchannelswebchannel-id-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Follows", "Webchannels", "Webchannel"]}}, "/user/votes/episodes"=>{"get"=>{"summary"=>"Get User Votes Episodes", "description"=>"Get user votes episodes.", "operationId"=>"getUserVotesEpisodes", "x-api-path-slug"=>"uservotesepisodes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Votes", "Episodes"]}}, "/user/votes/episodes/{episode_id}"=>{"delete"=>{"summary"=>"Delete User Votes Episodes", "description"=>"Delete user votes episodes.", "operationId"=>"deleteUserVotesEpisodesEpisode", "x-api-path-slug"=>"uservotesepisodesepisode-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Votes", "Episodes"]}, "get"=>{"summary"=>"Get User Votes Episodes", "description"=>"Get user votes episodes.", "operationId"=>"getUserVotesEpisodesEpisode", "x-api-path-slug"=>"uservotesepisodesepisode-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Votes", "Episodes"]}, "parameters"=>{"summary"=>"Parameters User Votes Episodes", "description"=>"Parameters user votes episodes.", "operationId"=>"parametersUserVotesEpisodesEpisode", "x-api-path-slug"=>"uservotesepisodesepisode-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Parameters", "User", "Votes", "Episodes"]}, "put"=>{"summary"=>"Put User Votes Episodes", "description"=>"Put user votes episodes.", "operationId"=>"putUserVotesEpisodesEpisode", "x-api-path-slug"=>"uservotesepisodesepisode-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Votes", "Episodes"]}}, "/user/votes/shows"=>{"get"=>{"summary"=>"Get User Votes Shows", "description"=>"Get user votes shows.", "operationId"=>"getUserVotesShows", "x-api-path-slug"=>"uservotesshows-get", "parameters"=>[{"in"=>"query", "name"=>"embed", "description"=>"Embed full show info"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Votes", "Shows"]}}, "/user/votes/shows/{show_id}"=>{"delete"=>{"summary"=>"Delete User Votes Shows", "description"=>"Delete user votes shows.", "operationId"=>"deleteUserVotesShowsShow", "x-api-path-slug"=>"uservotesshowsshow-id-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Votes", "Shows"]}, "get"=>{"summary"=>"Get User Votes Shows", "description"=>"Get user votes shows.", "operationId"=>"getUserVotesShowsShow", "x-api-path-slug"=>"uservotesshowsshow-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Votes", "Shows"]}, "parameters"=>{"summary"=>"Parameters User Votes Shows", "description"=>"Parameters user votes shows.", "operationId"=>"parametersUserVotesShowsShow", "x-api-path-slug"=>"uservotesshowsshow-id-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "Parameters", "User", "Votes", "Shows"]}, "put"=>{"summary"=>"Put User Votes Shows", "description"=>"Set `voted_at` to `NULL` or leave it out to use the current time.", "operationId"=>"putUserVotesShowsShow", "x-api-path-slug"=>"uservotesshowsshow-id-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Television", "User", "Votes", "Shows"]}}}}, "apis"=>{"name"=>"TVmaze", "x-slug"=>"tvmaze", "description"=>"Founded in 2014, TVmaze is the leading tv meta-data provider on the web. Serving hundreds of apps and services accoss the web. Providing management tools for users to keep track of their favorite shows.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/tvm-header-logo.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"General Data,Pedestal,Televisions", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"tvmaze/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"TVmaze user", "x-api-slug"=>"tvmaze-user", "description"=>"Founded in 2014, TVmaze is the leading tv meta-data provider on the web. Serving hundreds of apps and services accoss the web. Providing management tools for users to keep track of their favorite shows.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/tvm-header-logo.png", "humanURL"=>"http://www.tvmaze.com", "baseURL"=>"https://api.tvmaze.com//v1", "tags"=>"General Data,Pedestal,Televisions", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/tvmaze/tvmaze-user-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://www.tvmaze.com"}, {"type"=>"x-developer", "url"=>"https://www.tvmaze.com/api"}, {"type"=>"x-github", "url"=>"https://github.com/tvmaze"}, {"type"=>"x-rate-limits", "url"=>"https://www.tvmaze.com/api#rate-limiting"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/tvmaze"}, {"type"=>"x-website", "url"=>"http://tvmaze.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
orghunter{"org-hunter-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"OrgHunter", "x-complete"=>1, "info"=>{"title"=>"Org Hunter", "description"=>"get-the-latest-irs-data-and-most-up-to-date-charity-information-for-your-website-or-application", "version"=>"1.0.0"}, "host"=>"data.orghunter.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/categories"=>{"post"=>{"summary"=>"Get categories!", "description"=>"This operation provides a list of categories.", "operationId"=>"postV1Categories", "x-api-path-slug"=>"v1categories-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Charity"]}}, "/v1/charitybasic"=>{"post"=>{"summary"=>"Get details!", "description"=>"This operation detail data.", "operationId"=>"postV1Charitybasic", "x-api-path-slug"=>"v1charitybasic-post", "parameters"=>[{"in"=>"query", "name"=>"ein", "description"=>"ein (Employer Identification Number)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Charity"]}}, "/v1/charityfinancial"=>{"post"=>{"summary"=>"Get details!", "description"=>"This operation detail data.", "operationId"=>"postV1Charityfinancial", "x-api-path-slug"=>"v1charityfinancial-post", "parameters"=>[{"in"=>"query", "name"=>"ein", "description"=>"ein (Employer Identification Number)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Charity", "Financial"]}}, "/v1/charitygeolocation"=>{"post"=>{"summary"=>"Get details!", "description"=>"This operation detail data.", "operationId"=>"postV1Charitygeolocation", "x-api-path-slug"=>"v1charitygeolocation-post", "parameters"=>[{"in"=>"query", "name"=>"ein", "description"=>"ein (Employer Identification Number)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Charity", "Geo", "Location"]}}, "/v1/charitypremium"=>{"post"=>{"summary"=>"Get details!", "description"=>"This operation detail data.", "operationId"=>"postV1Charitypremium", "x-api-path-slug"=>"v1charitypremium-post", "parameters"=>[{"in"=>"query", "name"=>"ein", "description"=>"ein (Employer Identification Number)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Charity", "Premium"]}}, "/v1/charitysearch"=>{"post"=>{"summary"=>"Get summary data!", "description"=>"This operation provides summary data.", "operationId"=>"postV1Charitysearch", "x-api-path-slug"=>"v1charitysearch-post", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"Category Value Selected from Categories API"}, {"in"=>"query", "name"=>"city", "description"=>"City Name"}, {"in"=>"query", "name"=>"ein", "description"=>"Employer Identification Number (EIN)"}, {"in"=>"query", "name"=>"eligible", "description"=>"eligible=1 will return only organizations that are tax deductible and in good standing with the IRS"}, {"in"=>"query", "name"=>"rows", "description"=>"Records Per Page"}, {"in"=>"query", "name"=>"searchTerm", "description"=>"Charity Name or Keyword"}, {"in"=>"query", "name"=>"start", "description"=>"Record Set Start Position"}, {"in"=>"query", "name"=>"state", "description"=>"State Name - Two letter state abbreviation"}, {"in"=>"query", "name"=>"zipCode", "description"=>"Zipcode Value - 5 digit zipcode value"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Charity", "Search"]}}}}, "apis"=>{"name"=>"OrgHunter", "x-slug"=>"orghunter", "description"=>"OrgHunter.com is the number one destination for online charity and donor matching services. Every charity deserves the opportunity to be discovered regardless of size or financial status.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28476-org-hunter.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"2914633", "tags"=>"API Provider,Charities,General Data,internet,Profiles,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"orghunter/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Org Hunter", "x-api-slug"=>"org-hunter", "description"=>"OrgHunter.com is the number one destination for online charity and donor matching services. Every charity deserves the opportunity to be discovered regardless of size or financial status.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28476-org-hunter.jpg", "humanURL"=>"http://orghunter.com", "baseURL"=>"https://data.orghunter.com//", "tags"=>"API Provider,Charities,General Data,internet,Profiles,Service API,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/orghunter/v1charitysearch-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/orghunter/org-hunter-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-email", "url"=>"info@orghunter.com"}, {"type"=>"x-email", "url"=>"support@orghunter.com"}, {"type"=>"x-email", "url"=>"partner@orghunter.com"}, {"type"=>"x-email", "url"=>"media@orghunter.com"}, {"type"=>"x-email", "url"=>"salesdept@orghunter.com"}, {"type"=>"x-email", "url"=>"api@orghunter.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/OrgHunter"}, {"type"=>"x-website", "url"=>"http://orghunter.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
victorops{"victor-ops-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"VictorOps", "x-complete"=>1, "info"=>{"title"=>"Victor Ops", "description"=>"this-api-allows-you-to-interact-with-the-victorops-platform-in-various-ways--your-account-may-be-limitedto-a-total-number-of-api-calls-per-month--also-some-of-these-api-calls-have-rate-limits-note-in-this-documentation-when-creating-a-sample-curl-request-clicking-the-try-it-out-button-in-some-apiviewing-interfaces-the--in-an-email-address-may-be-encoded--please-note-that-the-rest-endpoints-will-notprocess-the-encoded-version--make-sure-that-the-encoded-character-40-is-changed-to-its-unencoded-form-beforesubmitting-the-curl-request-", "version"=>"0.0.2"}, "host"=>"api.victorops.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api-public/v1/alerts/{uuid}"=>{"get"=>{"summary"=>"Retrieve alert details.", "description"=>"Retrieve the details of an alert that was sent VictorOps by you.\n\nThis API may be called a maximum of 6 times per minute.", "operationId"=>"api_public.v1.alerts.uuid.get", "x-api-path-slug"=>"apipublicv1alertsuuid-get", "parameters"=>[{"in"=>"path", "name"=>"uuid", "description"=>"The VictorOps uuid of the alert"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts", "Uuid"]}}, "/api-public/v1/incidents"=>{"get"=>{"summary"=>"Get current incident information", "description"=>"Get a list of the currently open, acknowledged and recently resolved incidents.\nThis API may be called a maximum of 6 times per minute.", "operationId"=>"api_public.v1.incidents.get", "x-api-path-slug"=>"apipublicv1incidents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents"]}, "post"=>{"summary"=>"Create a new incident", "description"=>"Create a new incident.\n\nThis call replicates the function of our\nmanual incident creation process.\nMonitoring tools and custom integrations\nshould be configured using our\nREST Endpoint.\n\nThis API may be called a maximum of 6 times per minute.", "operationId"=>"api_public.v1.incidents.post", "x-api-path-slug"=>"apipublicv1incidents-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents"]}}, "/api-public/v1/incidents/ack"=>{"patch"=>{"summary"=>"Acknowledge an incident or list of incidents", "description"=>"The incident(s) must be currently open. The user supplied must be a valid VictorOps user and a member of your organization.\n\nThis API may be called a maximum of 6 times per minute.", "operationId"=>"api_public.v1.incidents.ack.patch", "x-api-path-slug"=>"apipublicv1incidentsack-patch", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents", "Ack"]}}, "/api-public/v1/incidents/byUser/ack"=>{"patch"=>{"summary"=>"Acknowledge all incidents for which a user was paged.", "description"=>"The incident(s) must be currently open. The user supplied must be a valid VictorOps user and a member of your organization.\n\nThis API may be called a maximum of 6 times per minute.", "operationId"=>"api_public.v1.incidents.byUser.ack.patch", "x-api-path-slug"=>"apipublicv1incidentsbyuserack-patch", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents", "ByUser", "Ack"]}}, "/api-public/v1/incidents/byUser/resolve"=>{"patch"=>{"summary"=>"Resolve all incidents for which a user was paged.", "description"=>"The incident(s) must be currently open. The user supplied must be a valid VictorOps user and a member of your organization.\n\nThis API may be called a maximum of 6 times per minute.", "operationId"=>"api_public.v1.incidents.byUser.resolve.patch", "x-api-path-slug"=>"apipublicv1incidentsbyuserresolve-patch", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents", "ByUser", "Resolve"]}}, "/api-public/v1/incidents/reroute"=>{"post"=>{"summary"=>"Reroute one or more incidents to one or more new routable destinations.", "description"=>"Reroute one or more incidents to one or more users and/or escalation policies", "operationId"=>"api_public.v1.incidents.reroute.post", "x-api-path-slug"=>"apipublicv1incidentsreroute-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents", "Reroute"]}}, "/api-public/v1/incidents/resolve"=>{"patch"=>{"summary"=>"Resolve an incident or list of incidents", "description"=>"The incident(s) must be currently open. The user supplied must be a valid VictorOps user and a member of your organization.\n\nThis API may be called a maximum of 6 times per minute.", "operationId"=>"api_public.v1.incidents.resolve.patch", "x-api-path-slug"=>"apipublicv1incidentsresolve-patch", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Incidents", "Resolve"]}}, "/api-public/v1/oncall/current"=>{"get"=>{"summary"=>"Get an organization's on-call users", "description"=>"Get all on-call uesrs/teams for your organization.\n\nThis API may be called a maximum of 1 times per minute.", "operationId"=>"api_public.v1.oncall.current.get", "x-api-path-slug"=>"apipublicv1oncallcurrent-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Oncall", "Current"]}}, "/api-public/v1/org/routing-keys"=>{"get"=>{"summary"=>"List routing keys with associated teams", "description"=>"Retrieves a list of routing keys and associated teams.\nThis API may be called a maximum of once a minute.", "operationId"=>"api_public.v1.org.routing_keys.get", "x-api-path-slug"=>"apipublicv1orgroutingkeys-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Org", "Routing-keys"]}}, "/api-public/v1/policies"=>{"get"=>{"summary"=>"Get escalation policy info", "description"=>"Retrieves a list of escalation policy information.\nThis API may be called a maximum of once a minute", "operationId"=>"api_public.v1.policies.get", "x-api-path-slug"=>"apipublicv1policies-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies"]}}, "/api-public/v1/policies/types/contacts"=>{"get"=>{"summary"=>"Get the available contact types", "description"=>"Get the available contact types\n\ndescription: \"Email Address\", type: \"email\"\ndescription: \"Phone Number\", type: \"phone\"\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.policies.types.contacts.get", "x-api-path-slug"=>"apipublicv1policiestypescontacts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies", "Types", "Contacts"]}}, "/api-public/v1/policies/types/notifications"=>{"get"=>{"summary"=>"Get the available notification types", "description"=>"Get the available notification types\n\ndescription: \"Send a push notification to all my devices\", type: \"push\"\ndescription: \"Send an email to an email address\", type: \"email\"\ndescription: \"Send an SMS to a phone number\", type: \"sms\"\ndescription: \"Make a phone call to a phone number\", type: \"phone\"\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.policies.types.notifications.get", "x-api-path-slug"=>"apipublicv1policiestypesnotifications-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies", "Types", "Notifications"]}}, "/api-public/v1/policies/types/timeouts"=>{"get"=>{"summary"=>"Get the available timeout values", "description"=>"Get the available timeout values\n\ndescription: \"If still unacked after 1 minute\", type: 1\ndescription: \"If still unacked after 5 minutes\", type: 5\ndescription: \"If still unacked after 10 minutes\", type: 10\ndescription: \"If still unacked after 15 minutes\", type: 15\ndescription: \"If still unacked after 20 minutes\", type: 20\ndescription: \"If still unacked after 25 minutes\", type: 25\ndescription: \"If still unacked after 30 minutes\", type: 30\ndescription: \"If still unacked after 45 minutes\", type: 45\ndescription: \"If still unacked after 60 minutes\", type: 60\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.policies.types.timeouts.get", "x-api-path-slug"=>"apipublicv1policiestypestimeouts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies", "Types", "Timeouts"]}}, "/api-public/v1/policies/{policy}/oncall/user"=>{"patch"=>{"summary"=>"Create an on-call override (take on-call)", "description"=>"Replaces a currently on-call user in the escalation policy with another. In many cases, the policy slug\nwill match the slug of the team that contains it.\n\nThis API may be called a maximum of 6 times per minute.", "operationId"=>"api_public.v1.policies.policy.oncall.user.patch", "x-api-path-slug"=>"apipublicv1policiespolicyoncalluser-patch", "parameters"=>[{"in"=>"path", "name"=>"policy", "description"=>"The VictorOps policy slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policies", "Policy", "Oncall", "User"]}}, "/api-public/v1/profile/{username}/policies"=>{"get"=>{"summary"=>"Get the user's paging policy", "description"=>"Get all the paging policy steps for the user on the org associated with the API key\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.profile.username.policies.get", "x-api-path-slug"=>"apipublicv1profileusernamepolicies-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile", "Username", "Policies"]}, "post"=>{"summary"=>"Create a paging policy step", "description"=>"Create a paging policy step\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.profile.username.policies.post", "x-api-path-slug"=>"apipublicv1profileusernamepolicies-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile", "Username", "Policies"]}}, "/api-public/v1/profile/{username}/policies/{step}"=>{"get"=>{"summary"=>"Get a paging policy step", "description"=>"Get a paging policy step\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.profile.username.policies.step.get", "x-api-path-slug"=>"apipublicv1profileusernamepoliciesstep-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile", "Username", "Policies", "Step"]}, "post"=>{"summary"=>"Create a rule for a paging policy step", "description"=>"Create a rule for a paging policy step\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.profile.username.policies.step.post", "x-api-path-slug"=>"apipublicv1profileusernamepoliciesstep-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile", "Username", "Policies", "Step"]}, "put"=>{"summary"=>"Update a paging policy step", "description"=>"Update a paging policy step\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.profile.username.policies.step.put", "x-api-path-slug"=>"apipublicv1profileusernamepoliciesstep-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile", "Username", "Policies", "Step"]}}, "/api-public/v1/profile/{username}/policies/{step}/{rule}"=>{"delete"=>{"summary"=>"Delete a rule from a paging policy step", "description"=>"Delete a rule from a paging policy step\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.profile.username.policies.step.rule.delete", "x-api-path-slug"=>"apipublicv1profileusernamepoliciessteprule-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile", "Username", "Policies", "Step", "Rule"]}, "get"=>{"summary"=>"Get a rule from a paging policy step", "description"=>"Get a rule from a paging policy step\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.profile.username.policies.step.rule.get", "x-api-path-slug"=>"apipublicv1profileusernamepoliciessteprule-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile", "Username", "Policies", "Step", "Rule"]}, "put"=>{"summary"=>"Update a rule for a paging policy step", "description"=>"Update a rule for a paging policy step\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.profile.username.policies.step.rule.put", "x-api-path-slug"=>"apipublicv1profileusernamepoliciessteprule-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profile", "Username", "Policies", "Step", "Rule"]}}, "/api-public/v1/team"=>{"get"=>{"summary"=>"List teams", "description"=>"Get a list of teams for your organization.\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.team.get", "x-api-path-slug"=>"apipublicv1team-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team"]}, "post"=>{"summary"=>"Add a team", "description"=>"Add a team to your organization.\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.team.post", "x-api-path-slug"=>"apipublicv1team-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team"]}}, "/api-public/v1/team/{team}"=>{"delete"=>{"summary"=>"Remove a team", "description"=>"Remove a team from your organization.\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.team.team.delete", "x-api-path-slug"=>"apipublicv1teamteam-delete", "parameters"=>[{"in"=>"path", "name"=>"team", "description"=>"The VictorOps team to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Team"]}, "get"=>{"summary"=>"Retrieve information for a team", "description"=>"Get the information for the specified team.\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.team.team.get", "x-api-path-slug"=>"apipublicv1teamteam-get", "parameters"=>[{"in"=>"path", "name"=>"team", "description"=>"The VictorOps team to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Team"]}, "put"=>{"summary"=>"Update a team", "description"=>"Update the designated team\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.team.team.put", "x-api-path-slug"=>"apipublicv1teamteam-put", "parameters"=>[{"in"=>"path", "name"=>"team", "description"=>"The VictorOps team to be updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Team"]}}, "/api-public/v1/team/{team}/members"=>{"get"=>{"summary"=>"Retrieve a list of members for a team", "description"=>"Get the members for the specified team.\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.team.team.members.get", "x-api-path-slug"=>"apipublicv1teamteammembers-get", "parameters"=>[{"in"=>"path", "name"=>"team", "description"=>"The VictorOps team to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Team", "Members"]}, "post"=>{"summary"=>"Add a team member", "description"=>"Add a team member to your team.\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.team.team.members.post", "x-api-path-slug"=>"apipublicv1teamteammembers-post", "parameters"=>[{"in"=>"path", "name"=>"team", "description"=>"The VictorOps team to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Team", "Members"]}}, "/api-public/v1/team/{team}/members/{user}"=>{"delete"=>{"summary"=>"Remove a team member", "description"=>"Remove a team from your organization.\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.team.team.members.user.delete", "x-api-path-slug"=>"apipublicv1teamteammembersuser-delete", "parameters"=>[{"in"=>"path", "name"=>"team", "description"=>"The VictorOps team to be deleted"}, {"in"=>"path", "name"=>"user", "description"=>"The team member username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Team", "Members", "User"]}}, "/api-public/v1/team/{team}/oncall/schedule"=>{"get"=>{"summary"=>"Get a team's on-call schedule", "description"=>"__NOTE: This call is deprecated. Please use `GET /api-public/v2/team/{team}/oncall/schedule`.__\n\nGet the on-call schedule for a team, including on-call overrides.\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.team.team.oncall.schedule.get", "x-api-path-slug"=>"apipublicv1teamteamoncallschedule-get", "parameters"=>[{"in"=>"path", "name"=>"team", "description"=>"The VictorOps team slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Team", "Oncall", "Schedule"]}}, "/api-public/v1/team/{team}/oncall/user"=>{"patch"=>{"summary"=>"Create an on-call override (take on-call)", "description"=>"__NOTE: This API call is deprecated. Please use `PATCH /api-public/v2/policies/{policy}/oncall/user`__\n\nReplaces a currently on-call user on the team with another.\n\nThis API may be called a maximum of 6 times per minute.", "operationId"=>"api_public.v1.team.team.oncall.user.patch", "x-api-path-slug"=>"apipublicv1teamteamoncalluser-patch", "parameters"=>[{"in"=>"path", "name"=>"team", "description"=>"The VictorOps team slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Team", "Oncall", "User"]}}, "/api-public/v1/team/{team}/policies"=>{"get"=>{"summary"=>"Retrieve a list of escalation policies for a team", "description"=>"Get the escalation policies for the specified team.\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.team.team.policies.get", "x-api-path-slug"=>"apipublicv1teamteampolicies-get", "parameters"=>[{"in"=>"path", "name"=>"team", "description"=>"The VictorOps team to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Team", "Team", "Policies"]}}, "/api-public/v1/user"=>{"get"=>{"summary"=>"List users", "description"=>"Get a list of users for your organization\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.get", "x-api-path-slug"=>"apipublicv1user-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}, "post"=>{"summary"=>"Add a user", "description"=>"Add a user to your organization\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.post", "x-api-path-slug"=>"apipublicv1user-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/api-public/v1/user/{user}"=>{"delete"=>{"summary"=>"Remove a user", "description"=>"Remove a user from your organization\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.delete", "x-api-path-slug"=>"apipublicv1useruser-delete", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"The VictorOps user to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User"]}, "get"=>{"summary"=>"Retrieve information for a user", "description"=>"Get the information for the specified user\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.get", "x-api-path-slug"=>"apipublicv1useruser-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"The VictorOps user to fetch"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User"]}, "put"=>{"summary"=>"Update a user", "description"=>"Update the designated user\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.put", "x-api-path-slug"=>"apipublicv1useruser-put", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"The VictorOps user to be updated"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User"]}}, "/api-public/v1/user/{user}/contact-methods"=>{"get"=>{"summary"=>"Get a list of all contact methods for a user", "description"=>"Get the contact methods for a user\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.contact_methods.get", "x-api-path-slug"=>"apipublicv1userusercontactmethods-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Contact-methods"]}}, "/api-public/v1/user/{user}/contact-methods/devices"=>{"get"=>{"summary"=>"Get a list of all contact devices for a user", "description"=>"Get the contact methods for a user\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.contact_methods.devices.get", "x-api-path-slug"=>"apipublicv1userusercontactmethodsdevices-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Contact-methods", "Devices"]}}, "/api-public/v1/user/{user}/contact-methods/devices/{contactId}"=>{"delete"=>{"summary"=>"Delete a contact device for a user", "description"=>"Delete a contact device for a user\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.contact_methods.devices.contactId.delete", "x-api-path-slug"=>"apipublicv1userusercontactmethodsdevicescontactid-delete", "parameters"=>[{"in"=>"path", "name"=>"contactId", "description"=>"The unique contact identifier"}, {"in"=>"path", "name"=>"user", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Contact-methods", "Devices", "ContactId"]}, "get"=>{"summary"=>"Get the indicated contact device for a user", "description"=>"Get the indicated contact device for a user\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.contact_methods.devices.contactId.get", "x-api-path-slug"=>"apipublicv1userusercontactmethodsdevicescontactid-get", "parameters"=>[{"in"=>"path", "name"=>"contactId", "description"=>"The unique contact identifier"}, {"in"=>"path", "name"=>"user", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Contact-methods", "Devices", "ContactId"]}, "put"=>{"summary"=>"Update a contact device for a user", "description"=>"Update a contact device for a user\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.contact_methods.devices.contactId.put", "x-api-path-slug"=>"apipublicv1userusercontactmethodsdevicescontactid-put", "parameters"=>[{"in"=>"path", "name"=>"contactId", "description"=>"The unique contact identifier"}, {"in"=>"path", "name"=>"user", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Contact-methods", "Devices", "ContactId"]}}, "/api-public/v1/user/{user}/contact-methods/emails"=>{"get"=>{"summary"=>"Get a list of all contact emails for a user", "description"=>"Get the contact emails for a user\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.contact_methods.emails.get", "x-api-path-slug"=>"apipublicv1userusercontactmethodsemails-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Contact-methods", "Emails"]}, "post"=>{"summary"=>"Create a contact emails for a user", "description"=>"Create a contact email for a user\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.contact_methods.emails.post", "x-api-path-slug"=>"apipublicv1userusercontactmethodsemails-post", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Contact-methods", "Emails"]}}, "/api-public/v1/user/{user}/contact-methods/emails/{contactId}"=>{"delete"=>{"summary"=>"Delete a contact email for a user", "description"=>"Delete the indicated contact email for the user\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.contact_methods.emails.contactId.delete", "x-api-path-slug"=>"apipublicv1userusercontactmethodsemailscontactid-delete", "parameters"=>[{"in"=>"path", "name"=>"contactId", "description"=>"The unique contact identifier"}, {"in"=>"path", "name"=>"user", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Contact-methods", "Emails", "ContactId"]}, "get"=>{"summary"=>"Get the indicate contact email for a user", "description"=>"Get the indicated contact email for a user\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.contact_methods.emails.contactId.get", "x-api-path-slug"=>"apipublicv1userusercontactmethodsemailscontactid-get", "parameters"=>[{"in"=>"path", "name"=>"contactId", "description"=>"The unique contact identifier"}, {"in"=>"path", "name"=>"user", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Contact-methods", "Emails", "ContactId"]}}, "/api-public/v1/user/{user}/contact-methods/phones"=>{"get"=>{"summary"=>"Get a list of all contact phones for a user", "description"=>"Get the contact phones for a user\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.contact_methods.phones.get", "x-api-path-slug"=>"apipublicv1userusercontactmethodsphones-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Contact-methods", "Phones"]}, "post"=>{"summary"=>"Create a contact phones for a user", "description"=>"Create a contact phone for a user\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.contact_methods.phones.post", "x-api-path-slug"=>"apipublicv1userusercontactmethodsphones-post", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Contact-methods", "Phones"]}}, "/api-public/v1/user/{user}/contact-methods/phones/{contactId}"=>{"delete"=>{"summary"=>"Delete a contact phone for a user", "description"=>"Delete the indicated contact phone for the user\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.contact_methods.phones.contactId.delete", "x-api-path-slug"=>"apipublicv1userusercontactmethodsphonescontactid-delete", "parameters"=>[{"in"=>"path", "name"=>"contactId", "description"=>"The unique contact identifier"}, {"in"=>"path", "name"=>"user", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Contact-methods", "Phones", "ContactId"]}, "get"=>{"summary"=>"Get the indicate contact phone for a user", "description"=>"Get the indicated contact phone for a user\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.contact_methods.phones.contactId.get", "x-api-path-slug"=>"apipublicv1userusercontactmethodsphonescontactid-get", "parameters"=>[{"in"=>"path", "name"=>"contactId", "description"=>"The unique contact identifier"}, {"in"=>"path", "name"=>"user", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Contact-methods", "Phones", "ContactId"]}}, "/api-public/v1/user/{user}/oncall/schedule"=>{"get"=>{"summary"=>"Get a user's on-call schedule", "description"=>"__NOTE: This call is deprecated. Please use `GET /api-public/v2/user/{user}/oncall/schedule`.__\n\nGet the on-call schedule for a user for all teams, including on-call overrides.\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.oncall.schedule.get", "x-api-path-slug"=>"apipublicv1useruseroncallschedule-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Oncall", "Schedule"]}}, "/api-public/v1/user/{user}/policies"=>{"get"=>{"summary"=>"Get a list of paging policies for a user", "description"=>"Get paging policies for a user\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v1.user.user.policies.get", "x-api-path-slug"=>"apipublicv1useruserpolicies-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Policies"]}}, "/api-public/v2/team/{team}/oncall/schedule"=>{"get"=>{"summary"=>"Get a team's on-call schedule", "description"=>"Get the on-call schedule for a team, including on-call overrides.\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v2.team.team.oncall.schedule.get", "x-api-path-slug"=>"apipublicv2teamteamoncallschedule-get", "parameters"=>[{"in"=>"path", "name"=>"team", "description"=>"The VictorOps team slug"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api-public", "V2", "Team", "Team", "Oncall", "Schedule"]}}, "/api-public/v2/user/{user}/oncall/schedule"=>{"get"=>{"summary"=>"Get a user's on-call schedule", "description"=>"Get the on-call schedule for a user for all teams the user is on, including on-call overrides.\n\nThis API may be called a maximum of 15 times per minute.", "operationId"=>"api_public.v2.user.user.oncall.schedule.get", "x-api-path-slug"=>"apipublicv2useruseroncallschedule-get", "parameters"=>[{"in"=>"path", "name"=>"user", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api-public", "V2", "User", "User", "Oncall", "Schedule"]}}, "/api-reporting/v1/incidents"=>{"get"=>{"summary"=>"Get/search incident history", "description"=>"__NOTE: This call is deprecated. Please use `GET /api-reporting/v2/incidents`.__\n\nRetrieve incident history for your company, searching over date ranges and with filtering options. This is historical\ndata, and may be up to 15 minutes behind real-time incident data. By default, only resolved incidents will be returned.\n\nThis API may be called a maximum of once a minute.\n\nIncident requests are paginated with a offset and limit query string parameters.\n The query for incidents is run and offset records are skipped, after which limit records will be returned.\n\nThe default offset is 0 and the default limit is 20. The maximum value allowed for limit is 100.\n\nOn return, the total number of records available for that query will be returned in the payload as 'total'.", "operationId"=>"api_reporting.v1.incidents.get", "x-api-path-slug"=>"apireportingv1incidents-get", "parameters"=>[{"in"=>"query", "name"=>"currentPhase", "description"=>"The current phase of the incident resolved, triggered or acknowledged"}, {"in"=>"query", "name"=>"entityId", "description"=>"The entity ID involved This is the unique identifier for the entity causing the incident"}, {"in"=>"query", "name"=>"host", "description"=>"The host involved in the incident Multiple values can be separated with commas"}, {"in"=>"query", "name"=>"incidentNumber", "description"=>"The incident number as shown in VictorOps Multiple values and ranges are allowed: 4,5,20:50"}, {"in"=>"query", "name"=>"service", "description"=>"The service involved in the incident (if any) Multiple values can be separated with commas"}, {"in"=>"query", "name"=>"startedAfter", "description"=>"Return incidents started after this timestamp Specify the timestamp in ISO8601 format"}, {"in"=>"query", "name"=>"startedBefore", "description"=>"Find incidents started before this timestamp Specify the timestamp in ISO8601 format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api-reporting", "V1", "Incidents"]}}, "/api-reporting/v1/team/{team}/oncall/log"=>{"get"=>{"summary"=>"A list of shift changes for a team", "description"=>"Returns a log of user shift changes for the specified team. This is historical\ndata, and may be up to 15 minutes behind real-time log data.\n\nThis API may be called a maximum of 6 times per minute.", "operationId"=>"api_reporting.v1.team.team.oncall.log.get", "x-api-path-slug"=>"apireportingv1teamteamoncalllog-get", "parameters"=>[{"in"=>"query", "name"=>"end", "description"=>"Return shift changes occurring before this timestamp"}, {"in"=>"query", "name"=>"start", "description"=>"Return shift changes occurring after this timestamp"}, {"in"=>"path", "name"=>"team", "description"=>"The VictorOps team slug"}, {"in"=>"query", "name"=>"userName", "description"=>"The VictorOps user ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api-reporting", "V1", "Team", "Team", "Oncall", "Log"]}}, "/api-reporting/v2/incidents"=>{"get"=>{"summary"=>"Get/search incident history", "description"=>"Retrieve incident history for your company, searching over date ranges and with filtering options.\n\nThis API may be called a maximum of once a minute.\n\nIncident requests are paginated with a offset and limit query string parameters.\n The query for incidents is run and offset records are skipped, after which limit records will be returned.\n\nThe default offset is 0 and the default limit is 20. The maximum value allowed for limit is 100.\n\nUnless specified otherwise with the parameter currentPhase, the response will only contain resolved incidents.\n\nOn return, the total number of records available for that query will be returned in the payload as 'total'.", "operationId"=>"api_reporting.v2.incidents.get", "x-api-path-slug"=>"apireportingv2incidents-get", "parameters"=>[{"in"=>"query", "name"=>"currentPhase", "description"=>"The current phase of the incident resolved, triggered or acknowledged"}, {"in"=>"query", "name"=>"entityId", "description"=>"The entity ID involved This is the unique identifier for the entity causing the incident"}, {"in"=>"query", "name"=>"host", "description"=>"The host involved in the incident Multiple values can be separated with commas"}, {"in"=>"query", "name"=>"incidentNumber", "description"=>"The incident number as shown in VictorOps Multiple values and ranges are allowed: 4,5,20:50"}, {"in"=>"query", "name"=>"routingKey", "description"=>"The original routing of the incident"}, {"in"=>"query", "name"=>"service", "description"=>"The service involved in the incident (if any) Multiple values can be separated with commas"}, {"in"=>"query", "name"=>"startedAfter", "description"=>"Return incidents started after this timestamp Specify the timestamp in ISO8601 format"}, {"in"=>"query", "name"=>"startedBefore", "description"=>"Find incidents started before this timestamp Specify the timestamp in ISO8601 format"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Api-reporting", "V2", "Incidents"]}}}}, "apis"=>{"name"=>"VictorOps", "x-slug"=>"victorops", "description"=>"VictorOps incident managament software gives DevOps observability, collaboration, & real-time alerting, to build, deploy, & operate software. Learn more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20023-victorops.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"196587", "tags"=>"Enterprise,internet,Orchestration,Relative Data,SaaS,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"victorops/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Victor Ops", "x-api-slug"=>"victor-ops", "description"=>"VictorOps incident managament software gives DevOps observability, collaboration, & real-time alerting, to build, deploy, & operate software. Learn more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/20023-victorops.jpg", "humanURL"=>"http://victorops.com", "baseURL"=>"https://api.victorops.com//", "tags"=>"Enterprise,internet,Orchestration,Relative Data,SaaS,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/victorops/apireportingv2incidents-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/victorops/victor-ops-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://victorops.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"https://victorops.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/victorops"}, {"type"=>"x-email", "url"=>"support@victorops.com"}, {"type"=>"x-email", "url"=>"info@victorops.com"}, {"type"=>"x-email", "url"=>"press@victorops.com"}, {"type"=>"x-email", "url"=>"sales@victorops.com"}, {"type"=>"x-github", "url"=>"https://github.com/victorops"}, {"type"=>"x-openapi", "url"=>"https://portal.victorops.com/api-docs/victorops-api-v1.yaml"}, {"type"=>"x-pricing", "url"=>"https://victorops.com/pricing/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/VictorOps"}, {"type"=>"x-website", "url"=>"http://victorops.com"}, {"type"=>"x-website", "url"=>"https://victorops.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
att-dev-program{"att-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AT&T Dev Program", "x-complete"=>1, "info"=>{"title"=>"AT&T API", "description"=>"this-is-a-complete-definition-of-the-att-api--needs-to-be-broken-into-separate-endpoints-", "version"=>"1"}, "host"=>"api.att.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/1/devicecapabilities/acr:authorization/capabilities"=>{"get"=>{"summary"=>"Get Devicecapabilities Acr Authorization Capabilities", "description"=>"/1/devicecapabilities/acr:authorization/capabilities", "operationId"=>"1devicecapabilitiesacrauthorizationcapabilities", "x-api-path-slug"=>"1devicecapabilitiesacrauthorizationcapabilities-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Devicecapabilities", "Acr:authorization", "Capabilities"]}}, "/3/messaging/outbound/{senderAddress}/requests"=>{"post"=>{"summary"=>"Post Messaging Outbound Senderaddress Requests", "description"=>"/3/messaging/outbound/{senderAddress}/requests", "operationId"=>"3messagingoutboundsenderaddressrequests", "x-api-path-slug"=>"3messagingoutboundsenderaddressrequests-post", "parameters"=>[{"in"=>"path", "name"=>"senderAddress"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Outbound", "Senderress", "Requests"]}}, "/3/messaging/outbound/{senderAddress}/{requestId}/deliveryInfos"=>{"get"=>{"summary"=>"Get Messaging Outbound Senderaddress Requestid Deliveryinfos", "description"=>"/3/messaging/outbound/{senderAddress}/{requestId}/deliveryInfos", "operationId"=>"3messagingoutboundsenderaddressrequestiddeliveryinfos", "x-api-path-slug"=>"3messagingoutboundsenderaddressrequestiddeliveryinfos-get", "parameters"=>[{"in"=>"path", "name"=>"requestId"}, {"in"=>"path", "name"=>"senderAddress"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Messaging", "Outbound", "Senderress", "RequestId", "DeliveryInfos"]}}, "/3/smsmessaging/inbound/registrations/{registrationId}/messages"=>{"get"=>{"summary"=>"Get SMS Inbound Registrations Registrationid Messages", "description"=>"/3/smsmessaging/inbound/registrations/{registrationId}/messages", "operationId"=>"3smsmessaginginboundregistrationsregistrationidmessages", "x-api-path-slug"=>"3smsmessaginginboundregistrationsregistrationidmessages-get", "parameters"=>[{"in"=>"path", "name"=>"registrationId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Smsmessaging", "Inbound", "Registrations", "RegistrationId", "Messages"]}}, "/3/smsmessaging/outbound/requests/{senderAddress}/{requestId}/deliveryInfos"=>{"get"=>{"summary"=>"Get SMS Outbound Requests Senderaddress Requestid Deliveryinfos", "description"=>"/3/smsmessaging/outbound/requests/{senderAddress}/{requestId}/deliveryInfos", "operationId"=>"3smsmessagingoutboundrequestssenderaddressrequestiddeliveryinfos", "x-api-path-slug"=>"3smsmessagingoutboundrequestssenderaddressrequestiddeliveryinfos-get", "parameters"=>[{"in"=>"path", "name"=>"requestId"}, {"in"=>"path", "name"=>"senderAddress"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Smsmessaging", "Outbound", "Requests", "Senderress", "RequestId", "DeliveryInfos"]}}, "/3/smsmessaging/outbound/{senderAddress}/requests"=>{"post"=>{"summary"=>"Post SMS Outbound Senderaddress Requests", "description"=>"/3/smsmessaging/outbound/{senderAddress}/requests", "operationId"=>"3smsmessagingoutboundsenderaddressrequests", "x-api-path-slug"=>"3smsmessagingoutboundsenderaddressrequests-post", "parameters"=>[{"in"=>"path", "name"=>"senderAddress"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Smsmessaging", "Outbound", "Senderress", "Requests"]}}, "/mms/v3/messaging/outbox"=>{"post"=>{"summary"=>"Post Mms Messaging Outbox", "description"=>"/mms/v3/messaging/outbox", "operationId"=>"mmsv3messagingoutbox", "x-api-path-slug"=>"mmsv3messagingoutbox-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mms", "VMessaging", "Outbox"]}}, "/mms/v3/messaging/outbox/{messageId}"=>{"get"=>{"summary"=>"Get Mms Messaging Outbox Messageid", "description"=>"/mms/v3/messaging/outbox/{messageId}", "operationId"=>"mmsv3messagingoutboxmessageid", "x-api-path-slug"=>"mmsv3messagingoutboxmessageid-get", "parameters"=>[{"in"=>"path", "name"=>"messageId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mms", "VMessaging", "Outbox", "MessageId"]}}, "/myMessages/v2/delta"=>{"get"=>{"summary"=>"Get My Delta", "description"=>"/myMessages/v2/delta", "operationId"=>"mymessagesv2delta", "x-api-path-slug"=>"mymessagesv2delta-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MyMessages", "VDelta"]}}, "/myMessages/v2/messages"=>{"delete"=>{"summary"=>"Delete My Messages", "description"=>"/myMessages/v2/messages", "operationId"=>"mymessagesv2messages", "x-api-path-slug"=>"mymessagesv2messages-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MyMessages", "VMessages"]}, "get"=>{"summary"=>"Get My Messages", "description"=>"/myMessages/v2/messages", "operationId"=>"mymessagesv2messages", "x-api-path-slug"=>"mymessagesv2messages-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MyMessages", "VMessages"]}, "post"=>{"summary"=>"Post My Messages", "description"=>"/myMessages/v2/messages", "operationId"=>"mymessagesv2messages", "x-api-path-slug"=>"mymessagesv2messages-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MyMessages", "VMessages"]}}, "/myMessages/v2/messages/index"=>{"post"=>{"summary"=>"Post My Messages Index", "description"=>"/myMessages/v2/messages/index", "operationId"=>"mymessagesv2messagesindex", "x-api-path-slug"=>"mymessagesv2messagesindex-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MyMessages", "VMessages", "Index"]}}, "/myMessages/v2/messages/index/info"=>{"get"=>{"summary"=>"Get My Messages Index Info", "description"=>"/myMessages/v2/messages/index/info", "operationId"=>"mymessagesv2messagesindexinfo", "x-api-path-slug"=>"mymessagesv2messagesindexinfo-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MyMessages", "VMessages", "Index", "Info"]}}, "/myMessages/v2/messages/{messageId}"=>{"delete"=>{"summary"=>"Delete My Messages Messageid", "description"=>"/myMessages/v2/messages/{messageId}", "operationId"=>"mymessagesv2messagesmessageid", "x-api-path-slug"=>"mymessagesv2messagesmessageid-delete", "parameters"=>[{"in"=>"path", "name"=>"messageId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MyMessages", "VMessages", "MessageId"]}, "get"=>{"summary"=>"Get My Messages Messageid", "description"=>"/myMessages/v2/messages/{messageId}", "operationId"=>"mymessagesv2messagesmessageid", "x-api-path-slug"=>"mymessagesv2messagesmessageid-get", "parameters"=>[{"in"=>"path", "name"=>"messageId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MyMessages", "VMessages", "MessageId"]}}, "/myMessages/v2/messages/{messageId}/parts/{partId}"=>{"get"=>{"summary"=>"Get My Messages Messageid Parts Partid", "description"=>"/myMessages/v2/messages/{messageId}/parts/{partId}", "operationId"=>"mymessagesv2messagesmessageidpartspartid", "x-api-path-slug"=>"mymessagesv2messagesmessageidpartspartid-get", "parameters"=>[{"in"=>"path", "name"=>"messageId"}, {"in"=>"path", "name"=>"partId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MyMessages", "VMessages", "MessageId", "Parts", "PartId"]}}, "/myMessages/v2/notificationConnectionDetails"=>{"get"=>{"summary"=>"Get My Notificationconnectiondetails", "description"=>"/myMessages/v2/notificationConnectionDetails", "operationId"=>"mymessagesv2notificationconnectiondetails", "x-api-path-slug"=>"mymessagesv2notificationconnectiondetails-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["MyMessages", "VNotificationConnectionDetails"]}}, "/rest/1/ads"=>{"get"=>{"summary"=>"Get Ads", "description"=>"/rest/1/ads", "operationId"=>"rest1ads", "x-api-path-slug"=>"rest1ads-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rest", "Ads"]}}, "/rest/2/Devices/Info"=>{"get"=>{"summary"=>"Get Devices Info", "description"=>"/rest/2/Devices/Info", "operationId"=>"rest2devicesinfo", "x-api-path-slug"=>"rest2devicesinfo-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rest", "Devices", "Info"]}}, "/sms/v3/messaging/inbox/{RegistrationID}"=>{"get"=>{"summary"=>"Get SMS Messaging Inbox Registration", "description"=>"/sms/v3/messaging/inbox/{RegistrationID}", "operationId"=>"smsv3messaginginboxregistrationid", "x-api-path-slug"=>"smsv3messaginginboxregistrationid-get", "parameters"=>[{"in"=>"path", "name"=>"RegistrationID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sms", "VMessaging", "Inbox", "RegistrationID"]}}, "/sms/v3/messaging/outbox"=>{"post"=>{"summary"=>"Post SMS Messaging Outbox", "description"=>"/sms/v3/messaging/outbox", "operationId"=>"smsv3messagingoutbox", "x-api-path-slug"=>"smsv3messagingoutbox-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sms", "VMessaging", "Outbox"]}}, "/sms/v3/messaging/outbox/{messageId}"=>{"get"=>{"summary"=>"Get SMS Messaging Outbox Messageid", "description"=>"/sms/v3/messaging/outbox/{messageId}", "operationId"=>"smsv3messagingoutboxmessageid", "x-api-path-slug"=>"smsv3messagingoutboxmessageid-get", "parameters"=>[{"in"=>"path", "name"=>"messageId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sms", "VMessaging", "Outbox", "MessageId"]}}, "/speech/v3/speechToText"=>{"post"=>{"summary"=>"Post Speech Speechtotext", "description"=>"/speech/v3/speechToText", "operationId"=>"speechv3speechtotext", "x-api-path-slug"=>"speechv3speechtotext-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Speech", "VSpeechToText"]}}, "/speech/v3/textToSpeech"=>{"post"=>{"summary"=>"Post Speech Texttospeech", "description"=>"/speech/v3/textToSpeech", "operationId"=>"speechv3texttospeech", "x-api-path-slug"=>"speechv3texttospeech-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Speech", "VTextToSpeech"]}}}}, "apis"=>{"name"=>"AT&T Dev Program", "x-slug"=>"att-dev-program", "description"=>"AT&T Official Site. Premium entertainment, the latest cell phones & tablets, unlimited data plans, and high-speed internet. Join the nations best network today!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/156-at&t-dev-program.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"691", "tags"=>"API Provider,Cloud,ISP,Media,Messages,Messages,MMS,Networks,Notifications,Profiles,Service API,SMS,Stack Network,Storage,Telecommunications,Telecommunications,Voice", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"att-dev-program/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AT&T API", "x-api-slug"=>"att-api", "description"=>"AT&T Official Site. Premium entertainment, the latest cell phones & tablets, unlimited data plans, and high-speed internet. Join the nations best network today!", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/156-at&t-dev-program.jpg", "humanURL"=>"http://att.com", "baseURL"=>"https://api.att.com//", "tags"=>"API Provider,Cloud,ISP,Media,Messages,Messages,MMS,Networks,Notifications,Profiles,Service API,SMS,Stack Network,Storage,Telecommunications,Telecommunications,Voice", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/att-dev-program/speechv3texttospeech-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/att-dev-program/att-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-android-sdk", "url"=>"https://developer.att.com/sdks-plugins/att-api-platform-sdk-for-android"}, {"type"=>"x-base", "url"=>"https://api.att.com/"}, {"type"=>"x-best-practices", "url"=>"http://developer.att.com/application-resource-optimizer/docs/best-practices"}, {"type"=>"x-blog", "url"=>"http://developerboards.att.lithium.com/t5/AT-T-Developer-Program-Blogs/bg-p/Blogs"}, {"type"=>"x-blog-rss", "url"=>"http://developerboards.att.lithium.com/cngddp/rss/boardmessages?board.id=Blogs"}, {"type"=>"x-contact-form", "url"=>"https://developer.att.com/developer/contact_us.jsp"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/at-t-intellectual-property"}, {"type"=>"x-developer", "url"=>"https://developer.att.com/"}, {"type"=>"x-documentation", "url"=>"https://developer.att.com/apis"}, {"type"=>"x-email", "url"=>"copyright@att.com"}, {"type"=>"x-email", "url"=>"privacypolicy@att.com"}, {"type"=>"x-events", "url"=>"http://developer.att.com/community/events"}, {"type"=>"x-facebook", "url"=>"https://www.facebook.com/attdeveloper"}, {"type"=>"x-faq", "url"=>"http://developerboards.att.lithium.com/t5/help/faqpage"}, {"type"=>"x-forum", "url"=>"http://developerboards.att.lithium.com/t5/Forums/ct-p/FURM"}, {"type"=>"x-github", "url"=>"https://github.com/att"}, {"type"=>"x-github", "url"=>"https://github.com/attdevsupport"}, {"type"=>"x-ios-sdk", "url"=>"https://developer.att.com/sdks-plugins/att-platform-sdk-for-ios"}, {"type"=>"x-pricing", "url"=>"https://developer.att.com/pricing"}, {"type"=>"x-salesforce-pdk", "url"=>"https://developer.att.com/sdks-plugins/att-toolkit-for-salesforce-platform"}, {"type"=>"x-selfservice-registration", "url"=>"https://developer.att.com/developer/flow/apiPlaygroundFlow.do?execution=e1s1"}, {"type"=>"x-ticket-system", "url"=>"https://developer.att.com/developer/mvc/auth/login?destPage=/developer/sso/salesforceRedirect.jsp?_fn=SessionTrigger&_requestid=16058"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/attdeveloper"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/ATT"}, {"type"=>"x-website", "url"=>"http://att.com"}, {"type"=>"x-website", "url"=>"https://att.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
coinmarketcap{"coinmarketcap-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"CoinMarketCap", "x-complete"=>1, "info"=>{"title"=>"CoinMarketCap Professional API Documentation", "description"=>"-introductionthe-coinmarketcap-professional-api-is-a-suite-of-highperformance-restful-json-endpoints-that-are-specifically-designed-to-meet-the-missioncritical-demands-of-application-developers-data-scientists-and-enterprise-business-platforms-this-api-reference-includes-all-technical-documentation-developers-need-to-integrate-thirdparty-applications-and-platforms--additional-answers-to-common-questions-can-be-found-in-the-coinmarketcap-professional-api-faqhttpspro-coinmarketcap-comfaq-note-if-youre-using-the-coinmarketcap-public-api-youll-want-to-access-the-public-api-documentationhttpscoinmarketcap-comapi-the-professional-api-is-an-entirely-separate-api-product--if-youre-uncertain-of-which-you-need-for-your-needs-check-the-feature-comparison-matrixhttpspro-coinmarketcap-comfaq--quick-start-guidefor-developers-eager-to-hit-the-ground-running-with-the-professional-api-here-are-3-quick-steps-to-make-your-first-call-with-the-professional-api-1--sign-up--sign-up-for-an-api-key-in-one-of-our-two-professional-api-environments-sandbox-coinmarketcap-comhttpssandbox-coinmarketcap-com--this-testing-sandbox-has-free-access-to-all-endpoints-and-all-subscription-plans-to-test-with-a-snapshot-of-our-market-data----pro-coinmarketcap-comhttpspro-coinmarketcap-com--this-is-our-live-production-environment-with-the-latest-market-data--select-the-free-starter-plan-if-it-meets-your-needs-or-upgrade-to-a-paid-tier-----2--get-your-api-key--once-you-sign-up-youll-land-on-your-developer-portal-account-dashboard--copy-your-api-from-the-api-key-box-in-the-top-left-panel-3--make-a-test-call-using-your-key--here-is-an-example-fetch-all-active-cryptocurrencies-by-market-cap-and-return-market-values-in-usd-and-euroshttpsproapi-coinmarketcap-comv1cryptocurrencylistingslateststart0limit5000convertusdeur-replace-api-key-in-querystring-with-your-own-this-basic-example-is-in-node-js-es5var-xhr--new-xmlhttprequestxhr-setrequestheaderxcmc-pro-api-key-b54bcf4d1bca4e8e9a2422ff2c3d462cxhr-responsetype--jsonxhr-setrequestheaderaccept-applicationjsonxhr-openget-httpsproapi-coinmarketcap-comv1cryptocurrencylistingslateststart0limit5000convertusdeurxhr-onreadystatechange--function-handler---if-xhr-readystate--4--xhr-status--200-----console-logxhr-response--xhr-send4--implement-your-application--now-that-youve-confirmed-your-api-key-is-working-get-familiar-with-the-api-by-reading-the-rest-of-this-api-reference-and-commence-building-your-applicationnote-making-http-requests-on-the-client-side-with-javascript-is-currently-prohibited-through-cors-configuration--this-is-to-protect-your-api-key-which-should-not-be-visible-to-users-of-your-application-so-your-api-key-is-not-stolen--secure-your-api-key-by-routing-calls-through-your-own-backend-service--authentication-acquiring-an-api-keyall-http-requests-made-against-the-professional-api-must-be-validated-with-an-api-key--if-you-dont-have-an-api-key-yet-visit-the-professional-api-developer-portalhttpspro-coinmarketcap-com-to-register-for-one--using-your-api-keyyou-may-use-any-server-side-programming-language-that-can-make-http-requests-to-target-the-professional-api--all-requests-should-target-domain-httpsproapi-coinmarketcap-com-you-can-supply-your-api-key-in-rest-api-calls-in-one-of-two-ways1--preferred-method-via-a-custom-header-named-xcmc-pro-api-key2--convenience-method-via-a-query-string-parameter-named-cmc-pro-api-keysecurity-warning-its-important-to-secure-your-api-key-against-public-access--the-custom-header-option-is-strongly-recommended-over-the-querystring-option-for-passing-your-api-key-in-a-production-environment--api-key-usage-creditsmost-plans-include-a-monthly-limit-or-hard-cap-to-the-number-of-data-calls-that-can-be-made--this-limit-is-tied-to-your-api-keys-usage-tierhttpspro-coinmarketcap-compricing-and-resets-at-midnight-utc-at-the-beginning-of-each-calendar-month-an-api-keys-monthly-usage-limit-is-tracked-as-api-call-credits-which-are-incremented-11-against-successful-http-status-200-data-calls-made-with-your-key-with-these-exceptions-account-management-endpoints-usage-stats-endpoints-and-error-responses-are-not-included-in-this-monthly-limit--paginated-endpoints-listbased-endpoints-track-an-additional-call-credit-for-every-100-data-points-returned-rounded-up-beyond-our-100-data-point-defaults--our-lightweight-map-endpoints-are-not-included-in-this-limit-and-always-count-as-1-credit--bundled-api-calls-many-endpoints-support-resource-and-currency-conversion-bundlingsectionstandardsandconventions--bundled-resources-are-also-tracked-as-1-call-credit-for-every-100-resources-returned-rounded-up--optional-currency-conversion-bundling-using-the-convert-parameter-also-increment-an-additional-api-call-credit-for-every-conversion-requested-beyond-the-first-you-can-log-in-to-the-developer-portalhttpspro-coinmarketcap-com-to-view-live-stats-on-your-api-key-usage-and-limits-including-the-number-of-credits-used-for-each-call--you-can-also-find-call-credit-usage-in-the-json-response-for-each-api-call--see-the-status-objectsectionstandardsandconventions-for-details--endpoint-overview-the-professional-api-is-divided-into-4-toplevel-categoriesendpoint-category---descriptioncryptocurrencytagcryptocurrency--endpoints-that-return-data-around-cryptocurrencies-such-as-ordered-cryptocurrency-lists-or-price-and-volume-data-exchangetagexchange--endpoints-that-return-data-around-cryptocurrency-exchanges-such-as-ordered-exchange-lists-and-market-pair-data-globalmetricstagglobalmetrics--endpoints-that-return-aggregate-market-data-such-as-global-market-cap-and-btc-dominance-toolstagtools---useful-utilities-such-as-cryptocurrencytofiat-price-conversions--endpoint-paths-follow-a-pattern-matching-the-type-of-data-providedendpoint-path---endpoint-type--descriptionlatest--latest-market-data--latest-market-ticker-quotes-and-averages-for-cryptocurrencies-and-exchanges-historical--historical-market-data--intervals-of-historic-market-data-like-ohlcv-data-or-data-for-use-in-charting-libraries-info--metadata--cryptocurrency-and-exchange-metadata-like-block-explorer-urls-and-logos-map--id-maps--utility-endpoints-to-get-a-map-of-resources-to-coinmarketcap-ids---cryptocurrency-and-exchange-endpoints-provide-2-different-ways-of-accessing-data-depending-on-purpose-listing-endpoints-flexible-paginated-listings-endpoints-allow-you-to-sort-and-filter-lists-of-data-like-cryptocurrencies-by-market-cap-or-exchanges-by-volume--item-endpoints-convenient-idbased-resource-endpoints-like-quotes-and-marketpairs-allow-you-to-bundle-several-ids-for-example-this-allows-you-to-get-latest-market-quotes-for-a-specific-set-of-cryptocurrencies-in-one-call--full-endpoint-listclick-on-the-endpoint-for-detailed-documentation-about-each-endpoint-type--endpoint---description--example-callcryptocurrency--v1cryptocurrencyinfooperationgetv1cryptocurrencyinfo--get-cryptocurrency-metadata--httpsproapi-coinmarketcap-comv1cryptocurrencyinfoid1210cryptocurrency--v1cryptocurrencymapoperationgetv1cryptocurrencymap--get-cryptocurrency-coinmarketcap-id-map--httpsproapi-coinmarketcap-comv1cryptocurrencymaplisting-statusactivestart0limit100cryptocurrency--v1cryptocurrencylistingslatestoperationgetv1cryptocurrencylistingslatest--list-all-cryptocurrencies-latest-httpsproapi-coinmarketcap-comv1cryptocurrencylistingslatestsortmarket-capstart0limit10cryptocurrency-typetokensconvertusdbtccryptocurrency--v1cryptocurrencymarketpairslatestoperationgetv1cryptocurrencymarketpairslatest--get-cryptocurrency-market-pairs-latest--httpsproapi-coinmarketcap-comv1cryptocurrencymarketpairslatestid1convertltcethcryptocurrency--v1cryptocurrencyohlcvhistoricaloperationgetv1cryptocurrencyohlcvhistorical--get-cryptocurrency-ohlcv-values-historical--httpsproapi-coinmarketcap-comv1cryptocurrencyohlcvhistoricaltime-start20170101id1time-start20170101time-end20180101interval7dcount12convertcadcryptocurrency--v1cryptocurrencyquoteslatestoperationgetv1cryptocurrencyquoteslatest--get-cryptocurrency-market-quotes-latest--httpsproapi-coinmarketcap-comv1cryptocurrencyquoteslatestsymbolbtcethxrpbcheosltcxlmconvertbtcetheurcryptocurrency--v1cryptocurrencyquoteshistoricaloperationgetv1cryptocurrencyquoteshistorical--get-cryptocurrency-market-quotes-historical--httpsproapi-coinmarketcap-comv1cryptocurrencyquoteshistoricalid1time-start2017time-end2018interval30dcount12exchange--v1exchangeinfooperationgetv1exchangeinfo--get-exchange-metadata--httpsproapi-coinmarketcap-comv1exchangeinfoid1210exchange--v1exchangemapoperationgetv1exchangemap--get-exchange-to-coinmarketcap-id-map--httpsproapi-coinmarketcap-comv1exchangemaplisting-statusactivestart0limit100exchange--v1exchangelistingslatestoperationgetv1exchangelistingslatest--list-all-exchanges-latest--httpsproapi-coinmarketcap-comv1exchangelistingslatestlimit10market-typeno-feesconvertusdexchange--v1exchangemarketpairslatestoperationgetv1exchangemarketpairslatest--get-exchange-market-pairs-latest--httpsproapi-coinmarketcap-comv1exchangemarketpairslatestsluggdaxconvertltcxrpeurexchange--v1exchangequoteslatestoperationgetv1exchangequoteslatest--get-exchange-market-quotes-latest--httpsproapi-coinmarketcap-comv1exchangequoteslatestid216convertusdbtcltceurexchange--v1exchangequoteshistoricaloperationgetv1exchangequoteshistorical--get-exchange-market-quotes-historical--httpsproapi-coinmarketcap-comv1exchangequoteshistoricalid270time-start20180101time-end20180501interval30dcount12global-metrics--v1globalmetricsquoteslatestoperationgetv1globalmetricsquoteslatest--get-aggregate-market-metrics-latest--httpsproapi-coinmarketcap-comv1globalmetricsquoteslatestconvertbtcethltceurglobal-metrics--v1globalmetricsquoteshistoricaloperationgetv1globalmetricsquoteshistorical--get-aggregate-market-metrics-historical--httpsproapi-coinmarketcap-comv1globalmetricsquoteshistoricalintervalmonthlycount100tools--v1toolspriceconversionoperationgetv1toolspriceconversion--price-conversion-tool--httpsproapi-coinmarketcap-comv1toolspriceconversionsymbolbtcamount50convertusdgbpltc-standards-and-conventionseach-http-request-must-contain-the-header-accept-applicationjson--you-should-also-send-an-acceptencoding-deflate-gzip-header-to-receive-data-fast-and-efficiently--endpoint-response-payload-formatall-endpoints-return-data-in-json-format-with-the-results-of-your-query-under-data-if-the-call-is-successful-a-status-object-is-always-included-for-both-successful-calls-and-failures-when-possible--the-status-object-always-includes-the-current-time-on-the-server-when-the-call-was-executed-as-timestamp-the-number-of-api-call-credits-this-call-utilized-as-credit-count-and-the-number-of-milliseconds-it-took-to-process-the-request-as-elapsed--any-details-about-errors-encountered-can-be-found-under-the-error-code-and-error-message--see-errors-and-rate-limitssectionerrorsandratelimits-for-details-on-errors---data-------------status-----timestamp-20180606t075227-273z----error-code-400----error-message-invalid-value-for-id----elapsed-0----credit-count-0---cryptocurrency-exchange-and-fiat-currency-identifiers-cryptocurrencies-may-be-identified-in-endpoints-using-either-the-cryptocurrencys-unique-coinmarketcap-id-as-id-eg--id1-for-bitcoin-or-the-cryptocurrencys-symbol-eg--symbolbtc-for-bitcoin--for-a-current-list-of-supported-cryptocurrencies-use-our-cryptocurrencymap-calloperationgetv1cryptocurrencymap--exchanges-may-be-identified-in-endpoints-using-either-the-exchanges-unique-coinmarketcap-id-as-id-eg--id270-for-binance-or-the-exchanges-web-slug-eg--slugbinance-for-binance--for-a-current-list-of-supported-exchanges-use-our-exchangemap-calloperationgetv1exchangemap--all-fiat-currency-options-use-the-standard-iso-8601httpswww-iso-orgiso8601dateandtimeformat-html-currency-code-eg--usd-for-the-us-dollar--unless-otherwise-stated-endpoints-with-fiat-currency-options-support-these-32-major-currency-codescurrency--currency-codeunited-states-dollar---usdaustralian-dollar---audbrazilian-real-r--brlcanadian-dollar---cadswiss-franc-fr--chfchilean-peso---clpchinese-yuan---cnyczech-koruna-k--czkdanish-krone-kr--dkkeuro---eurbritish-pound---gbphong-kong-dollar---hkdhungarian-forint-ft--hufindonesian-rupiah---rp--idrisraeli-new-shekel---ilsindian-rupee---inrjapanese-yen---jpysouth-korean-won---krwmexican-peso---mxnmalaysian-ringgit-rm--myrnorwegian-krone-kr--noknew-zealand-dollar---nzdphilippine-piso---phppakistani-rupee---pkrpolish-zoty-z--plnrussian-ruble---rubswedish-krona-kr--seksingapore-dollar---sgdthai-baht---thbturkish-lira---trynew-taiwan-dollar---twdsouth-african-rand-r--zarnote-using-coinmarketcap-ids-is-always-recommended-as-cryptocurrency-symbols-are-not-always-unique-and-can-change-with-a-cryptocurrency-rebrand--if-a-symbol-is-used-the-api-will-always-default-to-the-cryptocurrency-with-the-highest-market-cap--you-may-use-the-convenient-map-endpoints-to-quickly-find-the-corresponding-coinmarketcap-id-for-a-cryptocurrency-or-exchange--bundling-api-calls-many-endpoints-support-id-and-cryptofiat-currency-conversion-bundling--this-means-you-can-pass-multiple-commaseparated-values-to-an-endpoint-to-query-or-convert-several-items-at-once--check-the-id-symbol-slug-and-convert-query-parameter-descriptions-in-the-endpoint-documentation-to-see-if-this-is-supported-for-an-endpoint--endpoints-that-support-bundling-return-data-as-an-object-map-instead-of-an-array--each-keyvalue-pair-will-use-the-identifier-you-passed-in-as-the-key-for-example-if-you-passed-symbolbtceth-to-v1cryptocurrencyquoteslatest-you-would-receivedata------btc-------------------eth---------------or-if-you-passed-id11027-you-would-receivedata------1-------------------1027---------------price-conversions-that-are-returned-inside-endpoint-responses-behave-in-the-same-fashion--these-are-enclosed-in-a-quote-object--date-and-time-formats-all-endpoints-that-require-datetime-parameters-allow-timestamps-to-be-passed-in-either-iso-8601httpswww-iso-orgiso8601dateandtimeformat-html-format-eg--20180606t014640z-or-in-unix-time-eg--1528249600--timestamps-that-are-passed-in-iso-8601-format-support-basic-and-extended-notations-if-a-timezone-is-not-included-utc-will-be-the-default--all-timestamps-returned-in-json-payloads-are-returned-in-utc-time-using-humanreadable-iso-8601-format-which-follows-this-pattern-yyyymmddthhmmss-mmmz--the-final--mmm-designates-milliseconds--per-the-iso-8601-spec-the-final-z-is-a-constant-that-represents-utc-time--data-is-collected-recorded-and-reported-in-utc-time-unless-otherwise-specified--versioningthe-professional-api-is-versioned-to-guarantee-new-features-and-updates-are-nonbreaking--the-latest-version-of-this-api-is-v1--errors-and-rate-limits-api-request-throttlinguse-of-the-professional-api-is-subject-to-api-call-rate-limiting-or-request-throttling-that-scales-with-the-usage-tierhttpspro-coinmarketcap-compricing-tied-to-your-api-key--free--trial-plans-are-limited-to-10-calls-a-minute--paid-subscription-tiers-are-limited-to-60-calls-a-minute--custom-enterprise-subscription-tiers-may-have-a-higher-limit--http-status-codesthe-api-uses-standard-http-status-codes-to-indicate-the-success-or-failure-of-an-api-call--400-bad-request-the-server-could-not-process-the-request-likely-due-to-an-invalid-argument--401-unauthorized-the-request-lacks-valid-authentication-credentials-likely-an-issue-with-your-api-key--403-forbidden-the-request-was-rejected-due-to-a-permission-issue-likely-a-restriction-on-the-api-keys-associated-service-plan--429-too-many-requests-the-api-keys-rate-limit-was-exceeded-consider-slowing-down-your-api-request-frequency-if-this-is-a-request-throttling-error--consider-upgrading-your-service-plan-if-you-have-reached-your-monthly-api-credit-limit--500-internal-server-error-an-unexpected-server-issue-was-encountered--error-response-codesa-status-object-is-always-included-in-the-json-response-payload-for-both-successful-calls-and-failures-when-possible--you-may-check-this-object-for-additional-details-about-any-errors-encountered-under-the-error-code-and-error-message-properties--best-practicesthis-section-contains-a-few-recommendations-on-how-to-efficiently-utilize-the-professional-api-for-your-enterprise-application-especially-if-you-already-have-a-large-base-of-users-for-your-application--creating-a-robust-api-integrationwhenever-implementing-any-3rd-party-api-service-its-highly-recommended-to-implement-a-retry-with-exponential-backoff-coding-pattern-for-your-rest-api-call-logic--this-means-if-your-api-call-happens-to-get-rate-limited-http-429-or-encounters-an-unexpected-server-side-condition-http-5xx-your-code-would-automatically-recover-and-try-again-using-an-intelligent-recovery-scheme--you-may-use-one-of-the-many-libraries-available-for-example-a-target-blank-hrefhttpsgithub-comlitlbackoffthis-onea-for-python--implement-a-caching-strategythere-are-standard-legal-data-safeguards-built-into-the-a-hrefhttpspro-coinmarketcap-comuseragreementcommercial-target-blankcommercial-user-termsa-that-application-developers-should-keep-in-mind--these-terms-help-prevent-unauthorized-scraping-and-redistributing-of-cmc-data-but-are-intentionally-worded-to-allow-legitimate-local-caching-of-market-data-to-support-the-operation-of-your-application--if-your-application-has-a-significant-user-base-and-you-are-concerned-with-staying-within-the-call-credit-and-api-throttling-limits-of-your-subscription-plan-consider-implementing-a-data-caching-strategy---for-example-instead-of-making-a-cryptocurrencyquoteslatest-call-every-time-one-of-your-applications-users-needs-to-fetch-market-rates-for-specific-cryptocurrencies-you-could-prefetch-and-cache-the-latest-market-data-for-every-cryptocurrency-in-your-applications-local-database-every-60-seconds--this-would-only-require-1-api-call-cryptocurrencylistingslatestlimit5000-every-60-seconds--then-anytime-one-of-your-applications-users-need-to-load-a-custom-list-of-cryptocurrencies-you-could-simply-pull-this-latest-market-data-from-your-local-cache-without-the-overhead-of-additional-calls--this-kind-of-optimization-is-practical-for-customers-with-large-demanding-user-bases--reach-out-and-upgrade-your-planif-youre-uncertain-how-to-best-implement-the-professional-api-in-your-application-you-can-reach-out-to-apicoinmarketcap-com--if-your-current-or-future-needs-outgrow-our-current-selfserve-subscription-tiers-please-contact-us--well-review-your-needs-and-budget-and-may-be-able-to-tailor-a-custom-enterprise-plan-that-is-right-for-you-", "termsOfService"=>"https://coinmarketcap.com/terms/", "version"=>"1.0.0"}, "host"=>"pro-api.coinmarketcap.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/cryptocurrency/info"=>{"get"=>{"summary"=>"Get metadata", "description"=>"Returns all static metadata for one or more cryptocurrencies including name, symbol, logo, and its various registered URLs.\n\n**This endpoint is available on the following API plans:**\n- Starter\n- Hobbyist\n- Standard\n- Professional\n- Enterprise\n\n**Cache / Update frequency:** Static data is updated only as needed, every 30 seconds.", "operationId"=>"getV1CryptocurrencyInfo", "x-api-path-slug"=>"v1cryptocurrencyinfo-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"One or more comma-separated CoinMarketCap cryptocurrency IDs"}, {"in"=>"query", "name"=>"symbol", "description"=>"Alternatively pass one or more comma-separated cryptocurrency symbols"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Metadata"]}}, "/v1/cryptocurrency/map"=>{"get"=>{"summary"=>"Get CoinMarketCap ID map", "description"=>"Returns a paginated list of all cryptocurrencies by CoinMarketCap ID. We recommend using this convenience endpoint to lookup and utilize our unique cryptocurrency `id` across all endpoints as typical identifiers like ticker symbols can match multiple cryptocurrencies and change over time. As a convenience you may pass a comma-separated list of cryptocurrency symbols as `symbol` to filter this list to only those you require.\n\n\n **This endpoint is available on the following API plans:**\n - Starter\n - Hobbyist\n - Standard\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Mapping data is updated only as needed, every 30 seconds.", "operationId"=>"getV1CryptocurrencyMap", "x-api-path-slug"=>"v1cryptocurrencymap-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Optionally specify the number of results to return"}, {"in"=>"query", "name"=>"listing_status", "description"=>"Only active coins are returned by default"}, {"in"=>"query", "name"=>"start", "description"=>"Optionally offset the start (1-based index) of the paginated list of items to return"}, {"in"=>"query", "name"=>"symbol", "description"=>"Optionally pass a comma-separated list of cryptocurrency symbols to return CoinMarketCap IDs for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "CoinMarketCap", "ID", "Map"]}}, "/v1/exchange/info"=>{"get"=>{"summary"=>"Get metadata", "description"=>"Returns all static metadata for one or more exchanges including logo and homepage URL.\n\n **This endpoint is available on the following API plans:**\n - ~~Starter~~\n - Hobbyist\n - Standard\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Static data is updated only as needed, every 30 seconds.", "operationId"=>"getV1ExchangeInfo", "x-api-path-slug"=>"v1exchangeinfo-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"One or more comma-separated CoinMarketCap cryptocurrency exchange ids"}, {"in"=>"query", "name"=>"slug", "description"=>"Alternatively, one or more comma-separated exchange names in URL friendly shorthand slug format (all lowercase, spaces replaced with hyphens)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Metadata"]}}, "/v1/exchange/map"=>{"get"=>{"summary"=>"Get CoinMarketCap ID map", "description"=>"Returns a paginated list of all cryptocurrency exchanges by CoinMarketCap ID. We recommend using this convenience endpoint to lookup and utilize our unique exchange `id` across all endpoints as typical exchange identifiers may change over time. As a convenience you may pass a comma-separated list of exchanges by `slug` to filter this list to only those you require.\n\n**This endpoint is available on the following API plans:**\n - ~~Starter~~\n - Hobbyist\n - Standard\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Mapping data is updated only as needed, every 30 seconds.", "operationId"=>"getV1ExchangeMap", "x-api-path-slug"=>"v1exchangemap-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Optionally specify the number of results to return"}, {"in"=>"query", "name"=>"listing_status", "description"=>"Only active cryptocurrency exchanges are returned by default"}, {"in"=>"query", "name"=>"slug", "description"=>"Optionally pass a comma-separated list of exchange slugs (lowercase URL friendly shorthand name with spaces replaced with dashes) to return CoinMarketCap IDs for"}, {"in"=>"query", "name"=>"start", "description"=>"Optionally offset the start (1-based index) of the paginated list of items to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "CoinMarketCap", "ID", "Map"]}}, "/v1/tools/price-conversion"=>{"get"=>{"summary"=>"Price conversion tool", "description"=>"Convert an amount of one currency into up to 32 other cryptocurrency or fiat currencies at the same time using latest exchange rates. Optionally pass a historical timestamp to convert values based on historic averages.\n\n**Note:** Historical fiat conversions aren't yet available and the latest fiat rates will be used as noted by the `last_updated` timestamp included in the market quote. Historical fiat rates will be coming soon.\n\n**This endpoint is available on the following API plans:**\n- ~~Starter~~\n- Hobbyist\n- Standard\n- Professional\n- Enterprise\n\n**Cache / Update frequency:** Every ~5 minutes. This endpoint will be migrated to ~1 minute updates shortly.", "operationId"=>"getV1ToolsPriceconversion", "x-api-path-slug"=>"v1toolspriceconversion-get", "parameters"=>[{"in"=>"query", "name"=>"amount", "description"=>"An amount of currency to convert"}, {"in"=>"query", "name"=>"convert", "description"=>"Pass up to 32 comma-separated fiat or cryptocurrency symbols to convert the source amount to"}, {"in"=>"query", "name"=>"id", "description"=>"The CoinMarketCap cryptocurrency ID of the base currency to convert from"}, {"in"=>"query", "name"=>"symbol", "description"=>"Alternatively the cryptocurrency symbol of the base currency to convert from"}, {"in"=>"query", "name"=>"time", "description"=>"Optional timestamp (Unix or ISO 8601) to reference historical pricing during conversion"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Price", "Conversion", "Tool"]}}, "/v1/cryptocurrency/listings/historical"=>{"get"=>{"summary"=>"List all cryptocurrencies (historical)", "description"=>"**This endpoint is not yet available. It is slated for release in Q3 2018.**\n\n\nGet a paginated list of all cryptocurrencies with market data for a given historical time. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.", "operationId"=>"getV1CryptocurrencyListingsHistorical", "x-api-path-slug"=>"v1cryptocurrencylistingshistorical-get", "parameters"=>[{"in"=>"query", "name"=>"convert", "description"=>"Optionally calculate market quotes in up to 32 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols"}, {"in"=>"query", "name"=>"cryptocurrency_type", "description"=>"The type of cryptocurrency to include"}, {"in"=>"query", "name"=>"limit", "description"=>"Optionally specify the number of results to return"}, {"in"=>"query", "name"=>"sort", "description"=>"What field to sort the list of cryptocurrencies by"}, {"in"=>"query", "name"=>"sort_dir", "description"=>"The direction in which to order cryptocurrencies against the specified sort"}, {"in"=>"query", "name"=>"start", "description"=>"Optionally offset the start (1-based index) of the paginated list of items to return"}, {"in"=>"query", "name"=>"timestamp", "description"=>"Timestamp (Unix or ISO 8601) to return historical cryptocurrency listings for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "List", "", "Cryptocurrencies", "(historical)"]}}, "/v1/cryptocurrency/listings/latest"=>{"get"=>{"summary"=>"List all cryptocurrencies (latest)", "description"=>"Get a paginated list of all cryptocurrencies with latest market data. You can configure this call to sort by market cap or another market ranking field. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call. \n\n\nCryptocurrencies are listed by CoinMarketCap Rank by default. You may optionally sort against any of the following:\n**name**: The cryptocurrency name.\n**symbol**: The cryptocurrency symbol.\n**date_added**: Date cryptocurrency was added to the system.\n**market_cap**: market cap (latest trade price x circulating supply).\n**price**: latest average trade price across markets.\n**circulating_supply**: approximate number of coins currently in circulation.\n**total_supply**: approximate total amount of coins in existence right now (minus any coins that have been verifiably burned).\n**max_supply**: our best approximation of the maximum amount of coins that will ever exist in the lifetime of the currency.\n**num_market_pairs**: number of market pairs across all exchanges trading each currency.\n**volume_24h**: 24 hour trading volume for each currency.\n**percent_change_1h**: 1 hour trading price percentage change for each currency.\n**percent_change_24h**: 24 hour trading price percentage change for each currency.\n**percent_change_7d**: 7 day trading price percentage change for each currency.\n\n **This endpoint is available on the following API plans:**\n - Starter\n - Hobbyist\n - Standard\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every ~1 minute. \n \n*NOTE: Use this endpoint if you need a sorted and paginated list of cryptocurrencies. If you want to query for market data on a few specific cryptocurrencies use /v1/cryptocurrency/quotes/latest which is optimized for that purpose. The response data between these endpoints is otherwise the same.*", "operationId"=>"getV1CryptocurrencyListingsLatest", "x-api-path-slug"=>"v1cryptocurrencylistingslatest-get", "parameters"=>[{"in"=>"query", "name"=>"convert", "description"=>"Optionally calculate market quotes in up to 32 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols"}, {"in"=>"query", "name"=>"cryptocurrency_type", "description"=>"The type of cryptocurrency to include"}, {"in"=>"query", "name"=>"limit", "description"=>"Optionally specify the number of results to return"}, {"in"=>"query", "name"=>"sort", "description"=>"What field to sort the list of cryptocurrencies by"}, {"in"=>"query", "name"=>"sort_dir", "description"=>"The direction in which to order cryptocurrencies against the specified sort"}, {"in"=>"query", "name"=>"start", "description"=>"Optionally offset the start (1-based index) of the paginated list of items to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "List", "", "Cryptocurrencies", "(latest)"]}}, "/v1/cryptocurrency/market-pairs/latest"=>{"get"=>{"summary"=>"Get market pairs (latest)", "description"=>"Lists all market pairs for the specified cryptocurrency with associated stats. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.\n\n\n **This endpoint is available on the following API plans:**\n - ~~Starter~~\n - ~~Hobbyist~~\n - Standard\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every ~1 minute.", "operationId"=>"getV1CryptocurrencyMarketpairsLatest", "x-api-path-slug"=>"v1cryptocurrencymarketpairslatest-get", "parameters"=>[{"in"=>"query", "name"=>"convert", "description"=>"Optionally calculate market quotes in up to 32 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols"}, {"in"=>"query", "name"=>"id", "description"=>"A cryptocurrency by CoinMarketCap ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Optionally specify the number of results to return"}, {"in"=>"query", "name"=>"start", "description"=>"Optionally offset the start (1-based index) of the paginated list of items to return"}, {"in"=>"query", "name"=>"symbol", "description"=>"Alternatively pass a cryptocurrency by symbol"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Market", "Pairs", "(latest)"]}}, "/v1/cryptocurrency/ohlcv/historical"=>{"get"=>{"summary"=>"Get OHLCV values (historical)", "description"=>"Return an interval of historic OHLCV (Open, High, Low, Close, Volume) market quotes for a cryptocurrency.\n\n**Technical Details**\nOne OHLCV quote will be returned for every \"time_period\" between your \"time_start\" and \"time_end\".\nIf a \"time_start\" is not supplied, the \"time_period\" will be applied in reverse from \"time_end\".\nIf \"time_end\" is not supplied, it defaults to the current time.\nIf you don't need every \"time_period\" between your dates you may adjust the frequency that \"time_period\" is sampled using the \"interval\" parameter. For example with \"time_period\" set to \"daily\" you may set \"interval\" to \"2d\" to get the daily OHLCV for every other day. You could set \"interval\" to \"monthly\" to get the first daily OHLCV for each month, or set it to \"yearly\" to get the daily OHLCV value against the same date every year.\n\n**Interval Options**\nThere are 2 types of time interval formats that may be used for \"time_period\" and \"interval\" parameters. For \"time_period\" these return aggregate OHLCV data from the beginning to end of each interval period. Apply these time intervals to \"interval\" to adjust how frequently \"time_period\" is sampled.\n\nThe first are calendar year and time constants in UTC time:\n**\"daily\"** - Calendar day intervals for each UTC day.\n**\"weekly\"** - Calendar week intervals for each calendar week.\n**\"monthly\"** - Calendar month intervals for each calendar month.\n**\"yearly\"** - Calendar year intervals for each calendar year.\n\nThe second format is relative time:\n**\"d\"**: Time periods that repeat every \"d\" days (86400 second intervals). Supported day intervals are: \"1d\", \"2d\", \"3d\", \"7d\", \"14d\", \"15d\", \"30d\", \"60d\", \"90d\", \"365d\".\n\n**Note:** \"time_period\" currently only supports the \"daily\" option. \"interval\" supports all interval options.\n\n**This endpoint is available on the following API plans:**\n- ~~Starter~~\n- ~~Hobbyist~~\n- Standard (1 month)\n- Professional (12 months)\n- Enterprise (Up to 5 years)\n\n**Cache / Update frequency:** Every 24 hours for 1 day OHLCV ranges. Additional OHLCV ranges will be available in the near-term.", "operationId"=>"getV1CryptocurrencyOhlcvHistorical", "x-api-path-slug"=>"v1cryptocurrencyohlcvhistorical-get", "parameters"=>[{"in"=>"query", "name"=>"convert", "description"=>"By default market quotes are returned in USD"}, {"in"=>"query", "name"=>"count", "description"=>"Optionally limit the number of time periods to return results for"}, {"in"=>"query", "name"=>"id", "description"=>"A CoinMarketCap cryptocurrency ID"}, {"in"=>"query", "name"=>"interval", "description"=>"Optionally adjust the interval that time_period is sampled"}, {"in"=>"query", "name"=>"symbol", "description"=>"Alternatively a cryptocurrency symbol"}, {"in"=>"query", "name"=>"time_end", "description"=>"Timestamp (Unix or ISO 8601) to stop returning OHLCV time periods for (exclusive)"}, {"in"=>"query", "name"=>"time_period", "description"=>"Time period to return OHLCV data for"}, {"in"=>"query", "name"=>"time_start", "description"=>"Timestamp (Unix or ISO 8601) to start returning OHLCV time periods for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "OHLCV", "Values", "(historical)"]}}, "/v1/cryptocurrency/quotes/historical"=>{"get"=>{"summary"=>"Get market quotes (historical)", "description"=>"Returns an interval of historic market quotes for any cryptocurrency based on time and interval parameters.\n\n**Technical Details**\nA historic quote for every \"interval\" period between your \"time_start\" and \"time_end\" will be returned.\nIf a \"time_start\" is not supplied, the \"interval\" will be applied in reverse from \"time_end\".\nIf \"time_end\" is not supplied, it defaults to the current time.\nAt each \"interval\" period, the historic quote that is closest in time to the requested time will be returned.\nIf no historic quotes are available in a given \"interval\" period up until the next interval period, it will be skipped.\n\n**Interval Options**\nThere are 2 types of time interval formats that may be used for \"interval\".\n\nThe first are calendar year and time constants in UTC time:\n**\"hourly\"** - Get the first quote available at the beginning of each calendar hour.\n**\"daily\"** - Get the first quote available at the beginning of each calendar day.\n**\"weekly\"** - Get the first quote available at the beginning of each calendar week.\n**\"monthly\"** - Get the first quote available at the beginning of each calendar month.\n**\"yearly\"** - Get the first quote available at the beginning of each calendar year.\n\nThe second are relative time intervals.\n**\"m\"**: Get the first quote available every \"m\" minutes (60 second intervals). Supported minutes are: \"5m\", \"10m\", \"15m\", \"30m\", \"45m\".\n**\"h\"**: Get the first quote available every \"h\" hours (3600 second intervals). Supported hour intervals are: \"1h\", \"2h\", \"3h\", \"6h\", \"12h\".\n**\"d\"**: Get the first quote available every \"d\" days (86400 second intervals). Supported day intervals are: \"1d\", \"2d\", \"3d\", \"7d\", \"14d\", \"15d\", \"30d\", \"60d\", \"90d\", \"365d\".\n\n**This endpoint is available on the following API plans:**\n- ~~Starter~~\n- ~~Hobbyist~~\n- Standard (1 month)\n- Professional (12 months)\n- Enterprise (Up to 5 years)\n\n**Cache / Update frequency:** Every ~5 minutes. This endpoint will be migrated to ~1 minute updates shortly.", "operationId"=>"getV1CryptocurrencyQuotesHistorical", "x-api-path-slug"=>"v1cryptocurrencyquoteshistorical-get", "parameters"=>[{"in"=>"query", "name"=>"convert", "description"=>"By default market quotes are returned in USD"}, {"in"=>"query", "name"=>"count", "description"=>"The number of interval periods to return results for"}, {"in"=>"query", "name"=>"id", "description"=>"A CoinMarketCap cryptocurrency ID"}, {"in"=>"query", "name"=>"interval", "description"=>"Interval of time to return data points for"}, {"in"=>"query", "name"=>"symbol", "description"=>"Alternatively pass a cryptocurrency symbol"}, {"in"=>"query", "name"=>"time_end", "description"=>"Timestamp (Unix or ISO 8601) to stop returning quotes for (inclusive)"}, {"in"=>"query", "name"=>"time_start", "description"=>"Timestamp (Unix or ISO 8601) to start returning quotes for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Market", "Quotes", "(historical)"]}}, "/v1/cryptocurrency/quotes/latest"=>{"get"=>{"summary"=>"Get market quotes (latest)", "description"=>"Get the latest market quote for 1 or more cryptocurrencies. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.\n\n**This endpoint is available on the following API plans:**\n- Starter\n- Hobbyist\n- Standard\n- Professional\n- Enterprise\n\n**Cache / Update frequency:** Every ~1 minute.", "operationId"=>"getV1CryptocurrencyQuotesLatest", "x-api-path-slug"=>"v1cryptocurrencyquoteslatest-get", "parameters"=>[{"in"=>"query", "name"=>"convert", "description"=>"Optionally calculate market quotes in up to 32 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols"}, {"in"=>"query", "name"=>"id", "description"=>"One or more comma-separated cryptocurrency CoinMarketCap IDs"}, {"in"=>"query", "name"=>"symbol", "description"=>"Alternatively pass one or more comma-separated cryptocurrency symbols"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Market", "Quotes", "(latest)"]}}, "/v1/exchange/listings/historical"=>{"get"=>{"summary"=>"List all exchanges (historical)", "description"=>"**This endpoint is not yet available. It is slated for release in Q3 2018.**\n\n\nGet a paginated list of all cryptocurrency exchanges with historical market data for a given point in time. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.", "operationId"=>"getV1ExchangeListingsHistorical", "x-api-path-slug"=>"v1exchangelistingshistorical-get", "parameters"=>[{"in"=>"query", "name"=>"convert", "description"=>"Optionally calculate market quotes in up to 32 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols"}, {"in"=>"query", "name"=>"limit", "description"=>"Optionally specify the number of results to return"}, {"in"=>"query", "name"=>"market_type", "description"=>"The type of exchange markets to include in rankings"}, {"in"=>"query", "name"=>"sort", "description"=>"What field to sort the list of exchanges by"}, {"in"=>"query", "name"=>"sort_dir", "description"=>"The direction in which to order exchanges against the specified sort"}, {"in"=>"query", "name"=>"start", "description"=>"Optionally offset the start (1-based index) of the paginated list of items to return"}, {"in"=>"query", "name"=>"timestamp", "description"=>"Timestamp (Unix or ISO 8601) to return historical exchange listings for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "List", "", "Exchanges", "(historical)"]}}, "/v1/exchange/listings/latest"=>{"get"=>{"summary"=>"List all exchanges (latest)", "description"=>"Get a paginated list of all cryptocurrency exchanges with 24 hour volume. Additional market data fields will be available in the future. You can configure this call to sort by 24 hour volume or another field. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call. \n \n**This endpoint is available on the following API plans:**\n - ~~Starter~~\n - ~~Hobbyist~~\n - Standard\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every ~5 minutes. This endpoint will be migrated to ~1 minute updates shortly. \n \n *NOTE: Use this endpoint if you need a sorted and paginated list of exchanges. If you want to query for market data on a few specific exchanges use /v1/exchange/quotes/latest which is optimized for that purpose. The response data between these endpoints is otherwise the same.*", "operationId"=>"getV1ExchangeListingsLatest", "x-api-path-slug"=>"v1exchangelistingslatest-get", "parameters"=>[{"in"=>"query", "name"=>"convert", "description"=>"Optionally calculate market quotes in up to 32 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols"}, {"in"=>"query", "name"=>"limit", "description"=>"Optionally specify the number of results to return"}, {"in"=>"query", "name"=>"market_type", "description"=>"The type of exchange markets to include in rankings"}, {"in"=>"query", "name"=>"sort", "description"=>"What field to sort the list of exchanges by"}, {"in"=>"query", "name"=>"sort_dir", "description"=>"The direction in which to order exchanges against the specified sort"}, {"in"=>"query", "name"=>"start", "description"=>"Optionally offset the start (1-based index) of the paginated list of items to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "List", "", "Exchanges", "(latest)"]}}, "/v1/exchange/market-pairs/latest"=>{"get"=>{"summary"=>"List all market pairs (latest)", "description"=>"Get a list of active market pairs for an exchange. Active means the market pair is open for trading. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.'\n\n **This endpoint is available on the following API plans:**\n - ~~Starter~~\n - ~~Hobbyist~~\n - Standard\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every ~5 minutes. This endpoint will be migrated to ~1 minute updates shortly.", "operationId"=>"getV1ExchangeMarketpairsLatest", "x-api-path-slug"=>"v1exchangemarketpairslatest-get", "parameters"=>[{"in"=>"query", "name"=>"convert", "description"=>"Optionally calculate market quotes in up to 32 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols"}, {"in"=>"query", "name"=>"id", "description"=>"A CoinMarketCap exchange ID"}, {"in"=>"query", "name"=>"limit", "description"=>"Optionally specify the number of results to return"}, {"in"=>"query", "name"=>"slug", "description"=>"Alternatively pass an exchange slug (URL friendly all lowercase shorthand version of name with spaces replaced with hyphens)"}, {"in"=>"query", "name"=>"start", "description"=>"Optionally offset the start (1-based index) of the paginated list of items to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "List", "", "Market", "Pairs", "(latest)"]}}, "/v1/exchange/quotes/historical"=>{"get"=>{"summary"=>"Get market quotes (historical)", "description"=>"Returns an interval of historic quotes for any exchange based on time and interval parameters.\n\nHistorical exchange quotes currently include:\nvolume_24: Combined 24 hour volume for all market pairs at each historical interval.\nnum_market_pairs: Number of market pairs available at each historical interval.\nQuotes are returned in USD. Additional currency conversion options and additional fields will be available in the future.\n\n**Technical Details**\nA historic quote for every \"interval\" period between your \"time_start\" and \"time_end\" will be returned.\nIf a \"time_start\" is not supplied, the \"interval\" will be applied in reverse from \"time_end\".\nIf \"time_end\" is not supplied, it defaults to the current time.\nAt each \"interval\" period, the historic quote that is closest in time to the requested time will be returned.\nIf no historic quotes are available in a given \"interval\" period up until the next interval period, it will be skipped.\n\n**Interval Options**\nThere are 2 types of time interval formats that may be used for \"interval\".\n\nThe first are calendar year and time constants in UTC time:\n**\"hourly\"** - Get the first quote available at the beginning of each calendar hour.\n**\"daily\"** - Get the first quote available at the beginning of each calendar day.\n**\"weekly\"** - Get the first quote available at the beginning of each calendar week.\n**\"monthly\"** - Get the first quote available at the beginning of each calendar month.\n**\"yearly\"** - Get the first quote available at the beginning of each calendar year.\n\nThe second are relative time intervals.\n**\"m\"**: Get the first quote available every \"m\" minutes (60 second intervals). Supported minutes are: \"5m\", \"10m\", \"15m\", \"30m\", \"45m\".\n**\"h\"**: Get the first quote available every \"h\" hours (3600 second intervals). Supported hour intervals are: \"1h\", \"2h\", \"3h\", \"6h\", \"12h\".\n**\"d\"**: Get the first quote available every \"d\" days (86400 second intervals). Supported day intervals are: \"1d\", \"2d\", \"3d\", \"7d\", \"14d\", \"15d\", \"30d\", \"60d\", \"90d\", \"365d\".\n\n**This endpoint is available on the following API plans:**\n - ~~Starter~~\n - ~~Hobbyist~~\n - Standard (1 month)\n - Professional (12 months)\n - Enterprise (Up to 5 years)\n\n**Cache / Update frequency:** Every ~5 minutes. This endpoint will be migrated to ~1 minute updates shortly.", "operationId"=>"getV1ExchangeQuotesHistorical", "x-api-path-slug"=>"v1exchangequoteshistorical-get", "parameters"=>[{"in"=>"query", "name"=>"convert", "description"=>"By default market quotes are returned in USD"}, {"in"=>"query", "name"=>"count", "description"=>"The number of interval periods to return results for"}, {"in"=>"query", "name"=>"id", "description"=>"The CoinMarketCap exchange ID to return historical data for"}, {"in"=>"query", "name"=>"interval", "description"=>"Interval of time to return data points for"}, {"in"=>"query", "name"=>"slug", "description"=>"Alternatively the exchange slug to return historical data for"}, {"in"=>"query", "name"=>"time_end", "description"=>"Timestamp (Unix or ISO 8601) to stop returning quotes for (inclusive)"}, {"in"=>"query", "name"=>"time_start", "description"=>"Timestamp (Unix or ISO 8601) to start returning quotes for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Market", "Quotes", "(historical)"]}}, "/v1/exchange/quotes/latest"=>{"get"=>{"summary"=>"Get market quotes (latest)", "description"=>"Get the latest 24 hour volume quote for 1 or more exchanges. Additional market data fields will be available in the future. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.\n\n**This endpoint is available on the following API plans:**\n- ~~Starter~~\n- ~~Hobbyist~~\n- Standard\n- Professional\n- Enterprise\n\n**Cache / Update frequency:** Every ~5 minutes. This endpoint will be migrated to ~1 minute updates shortly.", "operationId"=>"getV1ExchangeQuotesLatest", "x-api-path-slug"=>"v1exchangequoteslatest-get", "parameters"=>[{"in"=>"query", "name"=>"convert", "description"=>"Optionally calculate market quotes in up to 32 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols"}, {"in"=>"query", "name"=>"id", "description"=>"One or more comma-separated CoinMarketCap exchange IDs"}, {"in"=>"query", "name"=>"slug", "description"=>"Alternatively, pass a comma-separated list of exchange slugs (URL friendly all lowercase shorthand version of name with spaces replaced with hyphens)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Market", "Quotes", "(latest)"]}}, "/v1/global-metrics/quotes/historical"=>{"get"=>{"summary"=>"Get aggregate market metrics (historical)", "description"=>"Get an interval of aggregate 24 hour volume and market cap data globally based on time and interval parameters.\n\n**Technical Details**\nA historic quote for every \"interval\" period between your \"time_start\" and \"time_end\" will be returned.\nIf a \"time_start\" is not supplied, the \"interval\" will be applied in reverse from \"time_end\".\nIf \"time_end\" is not supplied, it defaults to the current time.\nAt each \"interval\" period, the historic quote that is closest in time to the requested time will be returned.\nIf no historic quotes are available in a given \"interval\" period up until the next interval period, it will be skipped.\n\n**Interval Options**\nThere are 2 types of time interval formats that may be used for \"interval\".\n\nThe first are calendar year and time constants in UTC time:\n**\"hourly\"** - Get the first quote available at the beginning of each calendar hour.\n**\"daily\"** - Get the first quote available at the beginning of each calendar day.\n**\"weekly\"** - Get the first quote available at the beginning of each calendar week.\n**\"monthly\"** - Get the first quote available at the beginning of each calendar month.\n**\"yearly\"** - Get the first quote available at the beginning of each calendar year.\n\nThe second are relative time intervals.\n**\"m\"**: Get the first quote available every \"m\" minutes (60 second intervals). Supported minutes are: \"5m\", \"10m\", \"15m\", \"30m\", \"45m\".\n**\"h\"**: Get the first quote available every \"h\" hours (3600 second intervals). Supported hour intervals are: \"1h\", \"2h\", \"3h\", \"6h\", \"12h\".\n**\"d\"**: Get the first quote available every \"d\" days (86400 second intervals). Supported day intervals are: \"1d\", \"2d\", \"3d\", \"7d\", \"14d\", \"15d\", \"30d\", \"60d\", \"90d\", \"365d\".\n\n**This endpoint is available on the following API plans:**\n- ~~Starter~~\n- ~~Hobbyist~~\n- Standard (1 month)\n- Professional (12 months)\n- Enterprise (Up to 5 years)\n\n**Cache / Update frequency:** Every ~5 minutes. This endpoint will be migrated to ~1 minute updates shortly.", "operationId"=>"getV1GlobalmetricsQuotesHistorical", "x-api-path-slug"=>"v1globalmetricsquoteshistorical-get", "parameters"=>[{"in"=>"query", "name"=>"convert", "description"=>"By default market quotes are returned in USD"}, {"in"=>"query", "name"=>"count", "description"=>"The number of interval periods to return results for"}, {"in"=>"query", "name"=>"interval", "description"=>"Interval of time to return data points for"}, {"in"=>"query", "name"=>"time_end", "description"=>"Timestamp (Unix or ISO 8601) to stop returning quotes for (inclusive)"}, {"in"=>"query", "name"=>"time_start", "description"=>"Timestamp (Unix or ISO 8601) to start returning quotes for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Aggregate", "Market", "Metrics", "(historical)"]}}, "/v1/global-metrics/quotes/latest"=>{"get"=>{"summary"=>"Get aggregate market metrics (latest)", "description"=>"Get the latest quote of aggregate market metrics. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.\n\n**This endpoint is available on the following API plans:**\n- Starter\n- Hobbyist\n- Standard\n- Professional\n- Enterprise\n\n**Cache / Update frequency:** Every ~5 minutes. This endpoint will be migrated to ~1 minute updates shortly.", "operationId"=>"getV1GlobalmetricsQuotesLatest", "x-api-path-slug"=>"v1globalmetricsquoteslatest-get", "parameters"=>[{"in"=>"query", "name"=>"convert", "description"=>"Optionally calculate market quotes in up to 32 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Blockchain", "Aggregate", "Market", "Metrics", "(latest)"]}}}}, "apis"=>{"name"=>"CoinMarketCap", "x-slug"=>"coinmarketcap", "description"=>"Cryptocurrency market cap rankings, charts, and more", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28891-pro-coinmarketcap-com.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"276", "tags"=>"Blockchain,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"coinmarketcap/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"CoinMarketCap", "x-api-slug"=>"coinmarketcap", "description"=>"Cryptocurrency market cap rankings, charts, and more", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/28891-pro-coinmarketcap-com.jpg", "humanURL"=>"https://pro.coinmarketcap.com", "baseURL"=>"https://pro-api.coinmarketcap.com//", "tags"=>"Blockchain,Streams,Streams", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/coinmarketcap/v1globalmetricsquoteslatest-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/coinmarketcap/coinmarketcap-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-github", "url"=>"https://github.com/coinmarketcap"}, {"type"=>"x-openapi", "url"=>"https://pro-api.coinmarketcap.com/swagger.json"}, {"type"=>"x-email", "url"=>"legal@coinmarketcap.com"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/CoinMarketCap"}, {"type"=>"x-website", "url"=>"https://pro.coinmarketcap.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-glass{"google-glass-apis-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Glass", "x-complete"=>1, "info"=>{"title"=>"Google Mirror", "description"=>"interacts-with-glass-users-via-the-timeline-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"www.googleapis.com", "basePath"=>"/mirror/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/accounts/{userToken}/{accountType}/{accountName}"=>{"post"=>{"summary"=>"Insert Account", "description"=>"Inserts a new account for a user", "operationId"=>"mirror.accounts.insert", "x-api-path-slug"=>"accountsusertokenaccounttypeaccountname-post", "parameters"=>[{"in"=>"path", "name"=>"accountName", "description"=>"The name of the account to be passed to the Android Account Manager"}, {"in"=>"path", "name"=>"accountType", "description"=>"Account type to be passed to Android Account Manager"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"userToken", "description"=>"The ID for the user"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Account"]}}, "/contacts"=>{"get"=>{"summary"=>"Get Contacts", "description"=>"Retrieves a list of contacts for the authenticated user.", "operationId"=>"mirror.contacts.list", "x-api-path-slug"=>"contacts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}, "post"=>{"summary"=>"Insert Contact", "description"=>"Inserts a new contact.", "operationId"=>"mirror.contacts.insert", "x-api-path-slug"=>"contacts-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/contacts/{id}"=>{"delete"=>{"summary"=>"Delete Contact", "description"=>"Deletes a contact.", "operationId"=>"mirror.contacts.delete", "x-api-path-slug"=>"contactsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the contact"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}, "get"=>{"summary"=>"Get Contact", "description"=>"Gets a single contact by ID.", "operationId"=>"mirror.contacts.get", "x-api-path-slug"=>"contactsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the contact"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}, "patch"=>{"summary"=>"Update Contact", "description"=>"Updates a contact in place. This method supports patch semantics.", "operationId"=>"mirror.contacts.patch", "x-api-path-slug"=>"contactsid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the contact"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}, "put"=>{"summary"=>"Update Contact", "description"=>"Updates a contact in place.", "operationId"=>"mirror.contacts.update", "x-api-path-slug"=>"contactsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the contact"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Contact"]}}, "/locations"=>{"get"=>{"summary"=>"Get Locations", "description"=>"Retrieves a list of locations for the user.", "operationId"=>"mirror.locations.list", "x-api-path-slug"=>"locations-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Location"]}}, "/locations/{id}"=>{"get"=>{"summary"=>"Get Location", "description"=>"Gets a single location by ID.", "operationId"=>"mirror.locations.get", "x-api-path-slug"=>"locationsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the location or latest for the last known location"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Location"]}}, "/settings/{id}"=>{"get"=>{"summary"=>"Get Setting", "description"=>"Gets a single setting by ID.", "operationId"=>"mirror.settings.get", "x-api-path-slug"=>"settingsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the setting"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Setting"]}}, "/subscriptions"=>{"get"=>{"summary"=>"Get Subscriptions", "description"=>"Retrieves a list of subscriptions for the authenticated user and service.", "operationId"=>"mirror.subscriptions.list", "x-api-path-slug"=>"subscriptions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}, "post"=>{"summary"=>"Create Subscription", "description"=>"Creates a new subscription.", "operationId"=>"mirror.subscriptions.insert", "x-api-path-slug"=>"subscriptions-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/subscriptions/{id}"=>{"delete"=>{"summary"=>"Delete Subscription", "description"=>"Deletes a subscription.", "operationId"=>"mirror.subscriptions.delete", "x-api-path-slug"=>"subscriptionsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}, "put"=>{"summary"=>"Update Subscription", "description"=>"Updates an existing subscription in place.", "operationId"=>"mirror.subscriptions.update", "x-api-path-slug"=>"subscriptionsid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscription"]}}, "/timeline"=>{"get"=>{"summary"=>"Get Timelines", "description"=>"Retrieves a list of timeline items for the authenticated user.", "operationId"=>"mirror.timeline.list", "x-api-path-slug"=>"timeline-get", "parameters"=>[{"in"=>"query", "name"=>"bundleId", "description"=>"If provided, only items with the given bundleId will be returned"}, {"in"=>"query", "name"=>"includeDeleted", "description"=>"If true, tombstone records for deleted items will be returned"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of items to include in the response, used for paging"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Controls the order in which timeline items are returned"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Token for the page of results to return"}, {"in"=>"query", "name"=>"pinnedOnly", "description"=>"If true, only pinned items will be returned"}, {"in"=>"query", "name"=>"sourceItemId", "description"=>"If provided, only items with the given sourceItemId will be returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Timeline"]}, "post"=>{"summary"=>"Update Timeline", "description"=>"Inserts a new item into the timeline.", "operationId"=>"mirror.timeline.insert", "x-api-path-slug"=>"timeline-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Timeline"]}}, "/timeline/{id}"=>{"delete"=>{"summary"=>"Delete Timeline", "description"=>"Deletes a timeline item.", "operationId"=>"mirror.timeline.delete", "x-api-path-slug"=>"timelineid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the timeline item"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Timeline"]}, "get"=>{"summary"=>"Get Timeline", "description"=>"Gets a single timeline item by ID.", "operationId"=>"mirror.timeline.get", "x-api-path-slug"=>"timelineid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the timeline item"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Timeline"]}, "patch"=>{"summary"=>"Update Timeline", "description"=>"Updates a timeline item in place. This method supports patch semantics.", "operationId"=>"mirror.timeline.patch", "x-api-path-slug"=>"timelineid-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the timeline item"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Timeline"]}, "put"=>{"summary"=>"Update Timeline", "description"=>"Updates a timeline item in place.", "operationId"=>"mirror.timeline.update", "x-api-path-slug"=>"timelineid-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the timeline item"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Timeline Attachment"]}}, "/timeline/{itemId}/attachments"=>{"get"=>{"summary"=>"Get Timeline Attachments", "description"=>"Returns a list of attachments for a timeline item.", "operationId"=>"mirror.timeline.attachments.list", "x-api-path-slug"=>"timelineitemidattachments-get", "parameters"=>[{"in"=>"path", "name"=>"itemId", "description"=>"The ID of the timeline item whose attachments should be listed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Timeline Attachment"]}, "post"=>{"summary"=>"Add Timeline Attachment", "description"=>"Adds a new attachment to a timeline item.", "operationId"=>"mirror.timeline.attachments.insert", "x-api-path-slug"=>"timelineitemidattachments-post", "parameters"=>[{"in"=>"path", "name"=>"itemId", "description"=>"The ID of the timeline item the attachment belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Timeline Attachment"]}}, "/timeline/{itemId}/attachments/{attachmentId}"=>{"delete"=>{"summary"=>"Delete Timeline Attachment", "description"=>"Deletes an attachment from a timeline item.", "operationId"=>"mirror.timeline.attachments.delete", "x-api-path-slug"=>"timelineitemidattachmentsattachmentid-delete", "parameters"=>[{"in"=>"path", "name"=>"attachmentId", "description"=>"The ID of the attachment"}, {"in"=>"path", "name"=>"itemId", "description"=>"The ID of the timeline item the attachment belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Timeline Attachment"]}, "get"=>{"summary"=>"Get Timeline Attachment", "description"=>"Retrieves an attachment on a timeline item by item ID and attachment ID.", "operationId"=>"mirror.timeline.attachments.get", "x-api-path-slug"=>"timelineitemidattachmentsattachmentid-get", "parameters"=>[{"in"=>"path", "name"=>"attachmentId", "description"=>"The ID of the attachment"}, {"in"=>"path", "name"=>"itemId", "description"=>"The ID of the timeline item the attachment belongs to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Timeline Attachment"]}}}}, "apis"=>{"name"=>"Google Glass", "x-slug"=>"google-glass", "description"=>"Glass is fundamentally different than existing mobile platforms in both design and use. Follow these principles when building Glassware to give users the best experience.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2017-03-16 at 11.10.43 PM.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Glasses,Google APIs,Profiles,Relative Data,Service API,Stack Network,Wearables", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-glass/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Glass APIs", "x-api-slug"=>"google-glass-apis", "description"=>"Glass is fundamentally different than existing mobile platforms in both design and use. Follow these principles when building Glassware to give users the best experience.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Screen Shot 2017-03-16 at 11.10.43 PM.png", "humanURL"=>"https://developers.google.com/glass/", "baseURL"=>"://www.googleapis.com//mirror/v1", "tags"=>"API Provider,API Service Provider,Glasses,Google APIs,Profiles,Relative Data,Service API,Stack Network,Wearables", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-glass/google-glass-apis-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://developers.google.com/glass/develop/gdk/authentication"}, {"type"=>"x-best-practices", "url"=>"https://developers.google.com/glass/distribute/best-practices"}, {"type"=>"x-getting-started", "url"=>"https://developers.google.com/glass/develop/gdk/quick-start"}, {"type"=>"x-website", "url"=>"https://developers.google.com/glass/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
disqus{"disqus-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Disqus", "x-complete"=>1, "info"=>{"title"=>"Disqus", "description"=>"welcome-to-the-disqus-web-api--the-api-enables-developers-to-communicate-with-disqus-data-from-within-their-own-applications-", "termsOfService"=>"https://docs.disqus.com/kb/terms-and-policies/", "version"=>"1.0.0"}, "host"=>"disqus.com", "basePath"=>"api/3.0/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/aet/dismiss.json"=>{"post"=>{"summary"=>"Aet Dismiss", "description"=>"Aet Dismiss", "operationId"=>"aet-dismiss", "x-api-path-slug"=>"aetdismiss-json-post", "parameters"=>[{"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}}, "/aet/export.json"=>{"post"=>{"summary"=>"Aet Export", "description"=>"Aet Export", "operationId"=>"aet-export", "x-api-path-slug"=>"aetexport-json-post", "parameters"=>[{"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name) You must be a moderator on the selected forum", "type"=>"string"}, {"in"=>"query", "name"=>"full", "description"=>"Defaults to false If true, export all emails collected so far", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}}, "/aet/pendingExportInfo.json"=>{"get"=>{"summary"=>"Aet PendingExportInfo", "description"=>"Aet PendingExportInfo", "operationId"=>"aet-pendingexportinfo", "x-api-path-slug"=>"aetpendingexportinfo-json-get", "parameters"=>[{"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Export"]}}, "/aet/subscribe.json"=>{"post"=>{"summary"=>"Aet Subscribe", "description"=>"Aet Subscribe", "operationId"=>"aet-subscribe", "x-api-path-slug"=>"aetsubscribe-json-post", "parameters"=>[{"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments"]}}, "/blacklists/backfillCounters.json"=>{"post"=>{"summary"=>"Blacklists BackfillCounters", "description"=>"Blacklists BackfillCounters", "operationId"=>"blacklists-backfillcounters", "x-api-path-slug"=>"blacklistsbackfillcounters-json-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Black Lists"]}}, "/blacklists/list.json"=>{"get"=>{"summary"=>"Blacklists List", "description"=>"Blacklists List", "operationId"=>"blacklists-list", "x-api-path-slug"=>"blacklistslist-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to asc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}, {"in"=>"query", "name"=>"since", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}, {"in"=>"query", "name"=>"since_id", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"Defaults to null Choices: domain, word, ip, user, thread_slug, email", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Black Lists"]}}, "/blacklists/remove.json"=>{"post"=>{"summary"=>"Blacklists Remove", "description"=>"Blacklists Remove", "operationId"=>"blacklists-remove", "x-api-path-slug"=>"blacklistsremove-json-post", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"Defaults to [] Domain Name", "type"=>"string"}, {"in"=>"query", "name"=>"email", "description"=>"Defaults to [] Email address (defined by RFC 5322)", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"ip", "description"=>"Defaults to [] IP address in CIDR notation", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to [] Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}, {"in"=>"query", "name"=>"word", "description"=>"Defaults to [] Maximum length of 200", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Black Lists"]}}, "/categories/details.json"=>{"get"=>{"summary"=>"Categories Details", "description"=>"Categories Details", "operationId"=>"categories-details", "x-api-path-slug"=>"categoriesdetails-json-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"Looks up a category by ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Categories"]}}, "/categories/list.json"=>{"get"=>{"summary"=>"Categories List", "description"=>"Categories List", "operationId"=>"categories-list", "x-api-path-slug"=>"categorieslist-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to asc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"since_id", "description"=>"Defaults to null", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Categories"]}}, "/categories/listPosts.json"=>{"get"=>{"summary"=>"Categories ListPosts", "description"=>"Categories ListPosts", "operationId"=>"categories-listposts", "x-api-path-slug"=>"categorieslistposts-json-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"Looks up a category by ID", "type"=>"string"}, {"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"filters", "description"=>"Defaults to [] Valid values are: 1: Is_Anonymous 2: Has_Link 3: Has_Low_Rep_Author 4: Has_Bad_Word 5: Is_Flagged 6: No_Issue 7: Is_Toxic", "type"=>"string"}, {"in"=>"query", "name"=>"include", "description"=>"Defaults to [ approved] Choices: unapproved, approved, spam, deleted, flagged, highlighted", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to desc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}, {"in"=>"query", "name"=>"since", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Categories"]}}, "/categories/listThreads.json"=>{"get"=>{"summary"=>"Categories ListThreads", "description"=>"Categories ListThreads", "operationId"=>"categories-listthreads", "x-api-path-slug"=>"categorieslistthreads-json-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"Looks up a category by ID", "type"=>"string"}, {"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to desc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}, {"in"=>"query", "name"=>"since", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Categories"]}}, "/forumCategories/list.json"=>{"get"=>{"summary"=>"ForumCategories List", "description"=>"ForumCategories List", "operationId"=>"forumcategories-list", "x-api-path-slug"=>"forumcategorieslist-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Categories", "Forums"]}}, "/forums/create.json"=>{"post"=>{"summary"=>"Forums Create", "description"=>"Forums Create", "operationId"=>"forums-create", "x-api-path-slug"=>"forumscreate-json-post", "parameters"=>[{"in"=>"query", "name"=>"adultContent", "description"=>"Defaults to false", "type"=>"string"}, {"in"=>"query", "name"=>"attach", "description"=>"Defaults to [] Choices: followsForum, forumCanDisableAds, forumForumCategory, counters, forumDaysAlive, forumFeatures, forumIntegration, forumNewPolicy, forumPermissions", "type"=>"string"}, {"in"=>"query", "name"=>"category", "description"=>"Defaults to null Choices: Tech, Living, Style, Business, Entertainment, Celebrity, Sports, Culture, Games, News", "type"=>"string"}, {"in"=>"query", "name"=>"commentPolicyLink", "description"=>"Defaults to null URL (defined by RFC 3986)", "type"=>"string"}, {"in"=>"query", "name"=>"commentPolicyText", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"description", "description"=>"Defaults to null Maximum length of 300", "type"=>"string"}, {"in"=>"query", "name"=>"forumCategory", "description"=>"Defaults to null Looks up a forum category by ID", "type"=>"string"}, {"in"=>"query", "name"=>"guidelines", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"language", "description"=>"Defaults to en Translation Language", "type"=>"string"}, {"in"=>"query", "name"=>"name", "type"=>"string"}, {"in"=>"query", "name"=>"short_name", "type"=>"string"}, {"in"=>"query", "name"=>"website", "description"=>"Defaults to null URL (defined by RFC 3986)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/forums/details.json"=>{"get"=>{"summary"=>"Forums Details", "description"=>"Forums Details", "operationId"=>"forums-details", "x-api-path-slug"=>"forumsdetails-json-get", "parameters"=>[{"in"=>"query", "name"=>"attach", "description"=>"Defaults to [] Choices: followsForum, forumCanDisableAds, forumForumCategory, counters, forumDaysAlive, forumFeatures, forumIntegration, forumNewPolicy, forumPermissions", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/forums/disableAds.json"=>{"post"=>{"summary"=>"Forums DisableAds", "description"=>"Forums DisableAds", "operationId"=>"forums-disableads", "x-api-path-slug"=>"forumsdisableads-json-post", "parameters"=>[{"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name) You must be a moderator on the selected forum", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums", "Advertising"]}}, "/forums/fixFavIconsForClassifiedForums.json"=>{"get"=>{"summary"=>"Forums FixFavIconsForClassifiedForums", "description"=>"Forums FixFavIconsForClassifiedForums", "operationId"=>"forums-fixfaviconsforclassifiedforums", "x-api-path-slug"=>"forumsfixfaviconsforclassifiedforums-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/forums/follow.json"=>{"post"=>{"summary"=>"Forums Follow", "description"=>"Forums Follow", "operationId"=>"forums-follow", "x-api-path-slug"=>"forumsfollow-json-post", "parameters"=>[{"in"=>"query", "name"=>"target", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/forums/generateInterestingContent.json"=>{"get"=>{"summary"=>"Forums GenerateInterestingContent", "description"=>"Forums GenerateInterestingContent", "operationId"=>"forums-generateinterestingcontent", "x-api-path-slug"=>"forumsgenerateinterestingcontent-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/forums/interestingForums.json"=>{"get"=>{"summary"=>"Forums InterestingForums", "description"=>"Forums InterestingForums", "operationId"=>"forums-interestingforums", "x-api-path-slug"=>"forumsinterestingforums-json-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Defaults to 5 Maximum value of 100", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/forums/listCategories.json"=>{"get"=>{"summary"=>"Forums ListCategories", "description"=>"Forums ListCategories", "operationId"=>"forums-listcategories", "x-api-path-slug"=>"forumslistcategories-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to asc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"since_id", "description"=>"Defaults to null", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Lists", "Categories"]}}, "/forums/listFollowers.json"=>{"get"=>{"summary"=>"Forums ListFollowers", "description"=>"Forums ListFollowers", "operationId"=>"forums-listfollowers", "x-api-path-slug"=>"forumslistfollowers-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to asc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"since_id", "description"=>"Defaults to null", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Lists"]}}, "/forums/listModerators.json"=>{"get"=>{"summary"=>"Forums ListModerators", "description"=>"Forums ListModerators", "operationId"=>"forums-listmoderators", "x-api-path-slug"=>"forumslistmoderators-json-get", "parameters"=>[{"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Lists"]}}, "/forums/listMostActiveUsers.json"=>{"get"=>{"summary"=>"Forums ListMostActiveUsers", "description"=>"Forums ListMostActiveUsers", "operationId"=>"forums-listmostactiveusers", "x-api-path-slug"=>"forumslistmostactiveusers-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to asc Choices: desc", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Lists"]}}, "/forums/listMostLikedUsers.json"=>{"get"=>{"summary"=>"Forums ListMostLikedUsers", "description"=>"Forums ListMostLikedUsers", "operationId"=>"forums-listmostlikedusers", "x-api-path-slug"=>"forumslistmostlikedusers-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to asc Choices: desc", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Lists"]}}, "/forums/listPosts.json"=>{"get"=>{"summary"=>"Forums ListPosts", "description"=>"Forums ListPosts", "operationId"=>"forums-listposts", "x-api-path-slug"=>"forumslistposts-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"filters", "description"=>"Defaults to [] Valid values are: 1: Is_Anonymous 2: Has_Link 3: Has_Low_Rep_Author 4: Has_Bad_Word 5: Is_Flagged 6: No_Issue 7: Is_Toxic", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"include", "description"=>"Defaults to [ approved] Choices: unapproved, approved, spam, deleted, flagged, highlighted", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum number of posts to return", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to desc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}, {"in"=>"query", "name"=>"since", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Lists"]}}, "/forums/listThreads.json"=>{"get"=>{"summary"=>"Forums ListThreads", "description"=>"Forums ListThreads", "operationId"=>"forums-listthreads", "x-api-path-slug"=>"forumslistthreads-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"include", "description"=>"Defaults to [ open, closed] Choices: open, closed, killed", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to desc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}, {"in"=>"query", "name"=>"since", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Defaults to null Looks up a thread by ID You may pass us the 'ident' query type instead of an ID by including 'forum'", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums", "Lists"]}}, "/forums/listUserModerationHistory.json"=>{"get"=>{"summary"=>"Forums ListUserModerationHistory", "description"=>"Forums ListUserModerationHistory", "operationId"=>"forums-listusermoderationhistory", "x-api-path-slug"=>"forumslistusermoderationhistory-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 20", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums", "Lists"]}}, "/forums/listUsers.json"=>{"get"=>{"summary"=>"Forums ListUsers", "description"=>"Forums ListUsers", "operationId"=>"forums-listusers", "x-api-path-slug"=>"forumslistusers-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to asc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"since_id", "description"=>"Defaults to null", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums", "Lists", "Users"]}}, "/forums/removeDefaultAvatar.json"=>{"post"=>{"summary"=>"Forums RemoveDefaultAvatar", "description"=>"Forums RemoveDefaultAvatar", "operationId"=>"forums-removedefaultavatar", "x-api-path-slug"=>"forumsremovedefaultavatar-json-post", "parameters"=>[{"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name) You must be a moderator on the selected forum", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/forums/removeModerator.json"=>{"post"=>{"summary"=>"Forums RemoveModerator", "description"=>"Forums RemoveModerator", "operationId"=>"forums-removemoderator", "x-api-path-slug"=>"forumsremovemoderator-json-post", "parameters"=>[{"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"moderator", "description"=>"Defaults to null Looks up a moderator, either by ID or forum id and user id", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/forums/unfollow.json"=>{"post"=>{"summary"=>"Forums Unfollow", "description"=>"Forums Unfollow", "operationId"=>"forums-unfollow", "x-api-path-slug"=>"forumsunfollow-json-post", "parameters"=>[{"in"=>"query", "name"=>"target", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/forums/update.json"=>{"post"=>{"summary"=>"Forums Update", "description"=>"Forums Update", "operationId"=>"forums-update", "x-api-path-slug"=>"forumsupdate-json-post", "parameters"=>[{"in"=>"query", "name"=>"adsPositionBottomEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"adsPositionInthreadEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"adsPositionTopEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"adsProductDisplayEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"adsProductLinksEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"adsProductStoriesEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"adsProductVideoEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"adultContent", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"aetBannerConfirmation", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"aetBannerDescription", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"aetBannerEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"aetBannerTitle", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"allowAnonPost", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"attach", "description"=>"Defaults to [] Choices: followsForum, forumCanDisableAds, forumForumCategory, counters, forumDaysAlive, forumFeatures, forumIntegration, forumNewPolicy, forumPermissions", "type"=>"string"}, {"in"=>"query", "name"=>"category", "description"=>"Defaults to null Choices: Tech, Living, Style, Business, Entertainment, Celebrity, Sports, Culture, Games, News", "type"=>"string"}, {"in"=>"query", "name"=>"colorScheme", "description"=>"Defaults to null Choices: auto, dark, light", "type"=>"string"}, {"in"=>"query", "name"=>"commentPolicyLink", "description"=>"Defaults to null URL (defined by RFC 3986)", "type"=>"string"}, {"in"=>"query", "name"=>"commentPolicyText", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"commentsLinkMultiple", "description"=>"Defaults to null Maximum length of 50", "type"=>"string"}, {"in"=>"query", "name"=>"commentsLinkOne", "description"=>"Defaults to null Maximum length of 50", "type"=>"string"}, {"in"=>"query", "name"=>"commentsLinkZero", "description"=>"Defaults to null Maximum length of 50", "type"=>"string"}, {"in"=>"query", "name"=>"daysThreadAlive", "description"=>"Defaults to null Maximum value of 10000", "type"=>"string"}, {"in"=>"query", "name"=>"description", "description"=>"Defaults to null Maximum length of 300", "type"=>"string"}, {"in"=>"query", "name"=>"disableDisqusBranding", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"disableThirdPartyTrackers", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"flaggingEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"flaggingNotifications", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"flagThreshold", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name) You must be a moderator on the selected forum", "type"=>"string"}, {"in"=>"query", "name"=>"forumCategory", "description"=>"Defaults to null Looks up a forum category by ID", "type"=>"string"}, {"in"=>"query", "name"=>"guidelines", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"installCompleted", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"linkAffiliationEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"mediaembedEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"moderatorBadgeText", "description"=>"Defaults to null Maximum length of 50", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"organicDiscoveryEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"shouldError", "description"=>"Defaults to false", "type"=>"string"}, {"in"=>"query", "name"=>"sort", "description"=>"Defaults to null Valid values are: 1: OLDEST 2: NEWEST 4: HOT", "type"=>"string"}, {"in"=>"query", "name"=>"translationLanguage", "description"=>"Defaults to null Translation Language", "type"=>"string"}, {"in"=>"query", "name"=>"twitterName", "description"=>"Defaults to null Maximum length of 255", "type"=>"string"}, {"in"=>"query", "name"=>"typeface", "description"=>"Defaults to null Choices: auto, serif, sans-serif", "type"=>"string"}, {"in"=>"query", "name"=>"unapproveLinks", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"unapproveReputationLevel", "description"=>"Defaults to null Valid values are: 1: LOW1 2: LOW2 3: AVERAGE 4: HIGH", "type"=>"string"}, {"in"=>"query", "name"=>"validateAllPosts", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"website", "description"=>"Defaults to null URL (defined by RFC 3986)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/forums/updateDefaultAvatar.json"=>{"post"=>{"summary"=>"Forums UpdateDefaultAvatar", "description"=>"Forums UpdateDefaultAvatar", "operationId"=>"forums-updatedefaultavatar", "x-api-path-slug"=>"forumsupdatedefaultavatar-json-post", "parameters"=>[{"in"=>"query", "name"=>"avatar_file", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name) You must be a moderator on the selected forum", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/forums/validate.json"=>{"get"=>{"summary"=>"Forums Validate", "description"=>"Forums Validate", "operationId"=>"forums-validate", "x-api-path-slug"=>"forumsvalidate-json-get", "parameters"=>[{"in"=>"query", "name"=>"adsPositionBottomEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"adsPositionInthreadEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"adsPositionTopEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"adsProductDisplayEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"adsProductLinksEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"adsProductStoriesEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"adsProductVideoEnabled", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name) You must be a moderator on the selected forum", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/imports/list.json"=>{"get"=>{"summary"=>"Imports List", "description"=>"Imports List", "operationId"=>"imports-list", "x-api-path-slug"=>"importslist-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Import", "Lists"]}}, "/internal/forums/actionHistory/create.json"=>{"post"=>{"summary"=>"Internal Forums ActionHistory Create", "description"=>"Internal Forums ActionHistory Create", "operationId"=>"internal-forums-actionhistory-create", "x-api-path-slug"=>"internalforumsactionhistorycreate-json-post", "parameters"=>[{"in"=>"query", "name"=>"action", "description"=>"Valid values are: 1: ApprovePost 2: UnapprovePost 3: SpamPost 4: UnspamPost 5: RestorePost 6: RemovePost 7: HighlightPost 8: UnhighlightPost 9: AddBlacklist 10: RemoveBlacklist", "type"=>"string"}, {"in"=>"query", "name"=>"dateAdded", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"ip", "description"=>"Defaults to null IP address (defined by RFC 5322)", "type"=>"string"}, {"in"=>"query", "name"=>"post", "description"=>"Defaults to null Looks up a post by ID", "type"=>"string"}, {"in"=>"query", "name"=>"targetUser", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Defaults to null Looks up a thread by ID", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/internal/forums/actionHistory/delete.json"=>{"post"=>{"summary"=>"Internal Forums ActionHistory Delete", "description"=>"Internal Forums ActionHistory Delete", "operationId"=>"internal-forums-actionhistory-delete", "x-api-path-slug"=>"internalforumsactionhistorydelete-json-post", "parameters"=>[{"in"=>"query", "name"=>"log", "description"=>"Looks up an action history row by ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/internal/forums/actionHistory/update.json"=>{"post"=>{"summary"=>"Internal Forums ActionHistory Update", "description"=>"Internal Forums ActionHistory Update", "operationId"=>"internal-forums-actionhistory-update", "x-api-path-slug"=>"internalforumsactionhistoryupdate-json-post", "parameters"=>[{"in"=>"query", "name"=>"action", "description"=>"Defaults to null Valid values are: 1: ApprovePost 2: UnapprovePost 3: SpamPost 4: UnspamPost 5: RestorePost 6: RemovePost 7: HighlightPost 8: UnhighlightPost 9: AddBlacklist 10: RemoveBlacklist", "type"=>"string"}, {"in"=>"query", "name"=>"dateAdded", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"ip", "description"=>"Defaults to null IP address (defined by RFC 5322)", "type"=>"string"}, {"in"=>"query", "name"=>"log", "description"=>"Looks up an action history row by ID", "type"=>"string"}, {"in"=>"query", "name"=>"post", "description"=>"Defaults to null Looks up a post by ID", "type"=>"string"}, {"in"=>"query", "name"=>"targetUser", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Defaults to null Looks up a thread by ID", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/organizations/listAdmins.json"=>{"get"=>{"summary"=>"Organizations ListAdmins", "description"=>"Organizations ListAdmins", "operationId"=>"organizations-listadmins", "x-api-path-slug"=>"organizationslistadmins-json-get", "parameters"=>[{"in"=>"query", "name"=>"organization", "description"=>"Looks up an organization by ID You must be an admin on the selected organization", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Organizations"]}}, "/organizations/removeAdmin.json"=>{"post"=>{"summary"=>"Organizations RemoveAdmin", "description"=>"Organizations RemoveAdmin", "operationId"=>"organizations-removeadmin", "x-api-path-slug"=>"organizationsremoveadmin-json-post", "parameters"=>[{"in"=>"query", "name"=>"organization", "description"=>"Looks up an organization by ID You must be an admin on the selected organization", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Organizations"]}}, "/organizations/setRole.json"=>{"post"=>{"summary"=>"Organizations SetRole", "description"=>"Organizations SetRole", "operationId"=>"organizations-setrole", "x-api-path-slug"=>"organizationssetrole-json-post", "parameters"=>[{"in"=>"query", "name"=>"isAdmin", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"isModerator", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"organization", "description"=>"Looks up an organization by ID You must be an admin on the selected organization", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Organizations"]}}, "/organizations/saas/currentPlan.json"=>{"get"=>{"summary"=>"Organizations Saas CurrentPlan", "description"=>"Organizations Saas CurrentPlan", "operationId"=>"organizations-saas-currentplan", "x-api-path-slug"=>"organizationssaascurrentplan-json-get", "parameters"=>[{"in"=>"query", "name"=>"organization", "description"=>"Looks up an organization by ID You must be an admin on the selected organization", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Organizations"]}}, "/organizations/saas/removePaymentInfo.json"=>{"post"=>{"summary"=>"Organizations Saas RemovePaymentInfo", "description"=>"Organizations Saas RemovePaymentInfo", "operationId"=>"organizations-saas-removepaymentinfo", "x-api-path-slug"=>"organizationssaasremovepaymentinfo-json-post", "parameters"=>[{"in"=>"query", "name"=>"organization", "description"=>"Looks up an organization by ID You must be an admin on the selected organization", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Organizations"]}}, "/organizations/saas/subscribe.json"=>{"post"=>{"summary"=>"Organizations Saas Subscribe", "description"=>"Organizations Saas Subscribe", "operationId"=>"organizations-saas-subscribe", "x-api-path-slug"=>"organizationssaassubscribe-json-post", "parameters"=>[{"in"=>"query", "name"=>"organization", "description"=>"Looks up an organization by ID You must be an admin on the selected organization", "type"=>"string"}, {"in"=>"query", "name"=>"plan", "description"=>"Looks up a PricingOption by name", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Organizations"]}}, "/organizations/saas/unsubscribe.json"=>{"post"=>{"summary"=>"Organizations Saas Unsubscribe", "description"=>"Organizations Saas Unsubscribe", "operationId"=>"organizations-saas-unsubscribe", "x-api-path-slug"=>"organizationssaasunsubscribe-json-post", "parameters"=>[{"in"=>"query", "name"=>"immediately", "description"=>"Defaults to false", "type"=>"string"}, {"in"=>"query", "name"=>"organization", "description"=>"Looks up an organization by ID You must be an admin on the selected organization", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Organizations"]}}, "/organizations/saas/updatePaymentInfo.json"=>{"post"=>{"summary"=>"Organizations Saas UpdatePaymentInfo", "description"=>"Organizations Saas UpdatePaymentInfo", "operationId"=>"organizations-saas-updatepaymentinfo", "x-api-path-slug"=>"organizationssaasupdatepaymentinfo-json-post", "parameters"=>[{"in"=>"query", "name"=>"organization", "description"=>"Looks up an organization by ID You must be an admin on the selected organization", "type"=>"string"}, {"in"=>"query", "name"=>"token", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Organizations"]}}, "/posts/create.json"=>{"post"=>{"summary"=>"Posts Create", "description"=>"Posts Create", "operationId"=>"posts-create", "x-api-path-slug"=>"postscreate-json-post", "parameters"=>[{"in"=>"query", "name"=>"author_email", "description"=>"Defaults to null Email address (defined by RFC 5322)", "type"=>"string"}, {"in"=>"query", "name"=>"author_name", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"author_url", "description"=>"Defaults to null URL (defined by RFC 3986)", "type"=>"string"}, {"in"=>"query", "name"=>"date", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}, {"in"=>"query", "name"=>"ip_address", "description"=>"Defaults to null IP address (defined by RFC 5322)", "type"=>"string"}, {"in"=>"query", "name"=>"message", "type"=>"string"}, {"in"=>"query", "name"=>"parent", "description"=>"Defaults to null Looks up a post by ID", "type"=>"string"}, {"in"=>"query", "name"=>"state", "description"=>"Defaults to null Choices: unapproved, approved, spam, killed", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Defaults to null Looks up a thread by ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Posts"]}}, "/posts/details.json"=>{"get"=>{"summary"=>"Posts Details", "description"=>"Posts Details", "operationId"=>"posts-details", "x-api-path-slug"=>"postsdetails-json-get", "parameters"=>[{"in"=>"query", "name"=>"post", "description"=>"Looks up a post by ID", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Posts"]}}, "/posts/getContext.json"=>{"get"=>{"summary"=>"Posts GetContext", "description"=>"Posts GetContext", "operationId"=>"posts-getcontext", "x-api-path-slug"=>"postsgetcontext-json-get", "parameters"=>[{"in"=>"query", "name"=>"depth", "description"=>"Defaults to 10 Minimum value of 1 Maximum value of 10", "type"=>"string"}, {"in"=>"query", "name"=>"post", "description"=>"Looks up a post by ID", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Posts"]}}, "/posts/list.json"=>{"get"=>{"summary"=>"Posts List", "description"=>"Posts List", "operationId"=>"posts-list", "x-api-path-slug"=>"postslist-json-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"Defaults to null Looks up a category by ID", "type"=>"string"}, {"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"end", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}, {"in"=>"query", "name"=>"filters", "description"=>"Defaults to [] Valid values are: 1: Is_Anonymous 2: Has_Link 3: Has_Low_Rep_Author 4: Has_Bad_Word 5: Is_Flagged 6: No_Issue 7: Is_Toxic", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Defaults to all forums you moderate", "type"=>"string"}, {"in"=>"query", "name"=>"include", "description"=>"Defaults to [ approved] Choices: unapproved, approved, spam, deleted, flagged, highlighted", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"offset", "description"=>"Defaults to 0 Deprecated: Please see documentation on cursors", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to desc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}, {"in"=>"query", "name"=>"since", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}, {"in"=>"query", "name"=>"sortType", "description"=>"Defaults to date Choices: date, priority", "type"=>"string"}, {"in"=>"query", "name"=>"start", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Defaults to null Looks up a thread by ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Posts"]}}, "/posts/listModerationHistory.json"=>{"get"=>{"summary"=>"Posts ListModerationHistory", "description"=>"Posts ListModerationHistory", "operationId"=>"posts-listmoderationhistory", "x-api-path-slug"=>"postslistmoderationhistory-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 20", "type"=>"string"}, {"in"=>"query", "name"=>"post", "description"=>"Looks up a post by ID You must be a moderator on the selected post's forum", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Posts"]}}, "/posts/listPopular.json"=>{"get"=>{"summary"=>"Posts ListPopular", "description"=>"Posts ListPopular", "operationId"=>"posts-listpopular", "x-api-path-slug"=>"postslistpopular-json-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Defaults to all forums you moderate", "type"=>"string"}, {"in"=>"query", "name"=>"include", "description"=>"Defaults to [ approved] Choices: unapproved, approved, spam, deleted, flagged, highlighted", "type"=>"string"}, {"in"=>"query", "name"=>"interval", "description"=>"Defaults to 7d Choices: 1h, 6h, 12h, 1d, 3d, 7d, 30d, 60d, 90d", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"offset", "description"=>"Defaults to 0", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to popular Choices: popular, best", "type"=>"string"}, {"in"=>"query", "name"=>"organization", "description"=>"Defaults to null Looks up an organization by ID", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Defaults to null Looks up a thread by ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Posts"]}}, "/posts/listReporters.json"=>{"get"=>{"summary"=>"Posts ListReporters", "description"=>"Posts ListReporters", "operationId"=>"posts-listreporters", "x-api-path-slug"=>"postslistreporters-json-get", "parameters"=>[{"in"=>"query", "name"=>"numberPerPost", "description"=>"Defaults to 1", "type"=>"string"}, {"in"=>"query", "name"=>"posts", "description"=>"Looks up a post by ID You must be a moderator on the selected post's forum", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Posts"]}}, "/posts/remove.json"=>{"post"=>{"summary"=>"Posts Remove", "description"=>"Posts Remove", "operationId"=>"posts-remove", "x-api-path-slug"=>"postsremove-json-post", "parameters"=>[{"in"=>"query", "name"=>"post", "description"=>"Looks up a post by ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Posts"]}}, "/posts/report.json"=>{"post"=>{"summary"=>"Posts Report", "description"=>"Posts Report", "operationId"=>"posts-report", "x-api-path-slug"=>"postsreport-json-post", "parameters"=>[{"in"=>"query", "name"=>"post", "description"=>"Looks up a post by ID", "type"=>"string"}, {"in"=>"query", "name"=>"reason", "description"=>"Defaults to null Valid values are: 0: HARASSMENT 1: SPAM 2: INAPPROPRIATE_CONTENT 3: THREAT 4: IMPERSONATION 5: PRIVATE_INFORMATION 6: DISAGREE", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Posts"]}}, "/posts/restore.json"=>{"post"=>{"summary"=>"Posts Restore", "description"=>"Posts Restore", "operationId"=>"posts-restore", "x-api-path-slug"=>"postsrestore-json-post", "parameters"=>[{"in"=>"query", "name"=>"post", "description"=>"Looks up a post by ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Posts"]}}, "/posts/spam.json"=>{"post"=>{"summary"=>"Posts Spam", "description"=>"Posts Spam", "operationId"=>"posts-spam", "x-api-path-slug"=>"postsspam-json-post", "parameters"=>[{"in"=>"query", "name"=>"post", "description"=>"Looks up a post by ID You must be a moderator on the selected post's forum", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Posts", "Spam"]}}, "/posts/update.json"=>{"post"=>{"summary"=>"Posts Update", "description"=>"Posts Update", "operationId"=>"posts-update", "x-api-path-slug"=>"postsupdate-json-post", "parameters"=>[{"in"=>"query", "name"=>"message", "type"=>"string"}, {"in"=>"query", "name"=>"post", "description"=>"You must be the author of the post or a moderator on the applicable forum", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Posts"]}}, "/posts/vote.json"=>{"post"=>{"summary"=>"Posts Vote", "description"=>"Posts Vote", "operationId"=>"posts-vote", "x-api-path-slug"=>"postsvote-json-post", "parameters"=>[{"in"=>"query", "name"=>"post", "description"=>"Looks up a post by ID", "type"=>"string"}, {"in"=>"query", "name"=>"vote", "description"=>"Choices: -1, 0, 1", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Posts", "Votes"]}}, "/threads/close.json"=>{"post"=>{"summary"=>"Threads Close", "description"=>"Threads Close", "operationId"=>"threads-close", "x-api-path-slug"=>"threadsclose-json-post", "parameters"=>[{"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Looks up a thread by ID You must be a moderator on the selected thread's forum", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads"]}}, "/threads/create.json"=>{"post"=>{"summary"=>"Threads Create", "description"=>"Threads Create", "operationId"=>"threads-create", "x-api-path-slug"=>"threadscreate-json-post", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"Defaults to null Looks up a category by ID", "type"=>"string"}, {"in"=>"query", "name"=>"date", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"identifier", "description"=>"Defaults to null Maximum length of 300", "type"=>"string"}, {"in"=>"query", "name"=>"message", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"slug", "description"=>"Defaults to null Alpha-numeric slug Maximum length of 200", "type"=>"string"}, {"in"=>"query", "name"=>"title", "type"=>"string"}, {"in"=>"query", "name"=>"url", "description"=>"Defaults to null URL (defined by RFC 3986) Maximum length of 500", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads"]}}, "/threads/details.json"=>{"get"=>{"summary"=>"Threads Details", "description"=>"Threads Details", "operationId"=>"threads-details", "x-api-path-slug"=>"threadsdetails-json-get", "parameters"=>[{"in"=>"query", "name"=>"attach", "description"=>"Defaults to [] Choices: topics", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Looks up a thread by ID You may pass us the 'ident' or 'link' query types instead of an ID by including 'forum'", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads"]}}, "/threads/list.json"=>{"get"=>{"summary"=>"Threads List", "description"=>"Threads List", "operationId"=>"threads-list", "x-api-path-slug"=>"threadslist-json-get", "parameters"=>[{"in"=>"query", "name"=>"attach", "description"=>"Defaults to [] Choices: topics", "type"=>"string"}, {"in"=>"query", "name"=>"author", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}, {"in"=>"query", "name"=>"category", "description"=>"Defaults to null Looks up a category by ID", "type"=>"string"}, {"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"include", "description"=>"Defaults to [ open, closed] Choices: open, closed, killed", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to desc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}, {"in"=>"query", "name"=>"since", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Defaults to null Looks up a thread by ID You may pass us the 'ident' query type instead of an ID by including 'forum'", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads"]}}, "/threads/listHot.json"=>{"get"=>{"summary"=>"Threads ListHot", "description"=>"Threads ListHot", "operationId"=>"threads-listhot", "x-api-path-slug"=>"threadslisthot-json-get", "parameters"=>[{"in"=>"query", "name"=>"author", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}, {"in"=>"query", "name"=>"category", "description"=>"Defaults to null Looks up a category by ID", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"include", "description"=>"Defaults to [ open, closed] Choices: open, closed, killed", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads"]}}, "/threads/listPopular.json"=>{"get"=>{"summary"=>"Threads ListPopular", "description"=>"Threads ListPopular", "operationId"=>"threads-listpopular", "x-api-path-slug"=>"threadslistpopular-json-get", "parameters"=>[{"in"=>"query", "name"=>"category", "description"=>"Defaults to null Looks up a category by ID", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"interval", "description"=>"Defaults to 7d Choices: 1h, 6h, 12h, 1d, 3d, 7d, 30d, 90d", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}, {"in"=>"query", "name"=>"with_top_post", "description"=>"Defaults to false", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads"]}}, "/threads/listPosts.json"=>{"get"=>{"summary"=>"Threads ListPosts", "description"=>"Threads ListPosts", "operationId"=>"threads-listposts", "x-api-path-slug"=>"threadslistposts-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"filters", "description"=>"Defaults to [] Valid values are: 1: Is_Anonymous 2: Has_Link 3: Has_Low_Rep_Author 4: Has_Bad_Word 5: Is_Flagged 6: No_Issue 7: Is_Toxic", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"include", "description"=>"Defaults to [ approved] Choices: unapproved, approved, spam, deleted, flagged, highlighted", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to desc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}, {"in"=>"query", "name"=>"since", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Looks up a thread by ID You may pass us the 'ident' or 'link' query types instead of an ID by including 'forum'", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads"]}}, "/threads/listUsersVotedThread.json"=>{"get"=>{"summary"=>"Threads ListUsersVotedThread", "description"=>"Threads ListUsersVotedThread", "operationId"=>"threads-listusersvotedthread", "x-api-path-slug"=>"threadslistusersvotedthread-json-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Defaults to 10 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"prioritize_followed", "description"=>"Defaults to true Prioritize followed users who voted on this thread (must be authenticated)", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Looks up a thread by ID", "type"=>"string"}, {"in"=>"query", "name"=>"vote", "description"=>"Defaults to 1 Choices: -1, 0, 1", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads"]}}, "/threads/open.json"=>{"post"=>{"summary"=>"Threads Open", "description"=>"Threads Open", "operationId"=>"threads-open", "x-api-path-slug"=>"threadsopen-json-post", "parameters"=>[{"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Looks up a thread by ID You must be a moderator on the selected thread's forum", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads"]}}, "/threads/remove.json"=>{"post"=>{"summary"=>"Threads Remove", "description"=>"Threads Remove", "operationId"=>"threads-remove", "x-api-path-slug"=>"threadsremove-json-post", "parameters"=>[{"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Looks up a thread by ID You must be a moderator on the selected thread's forum", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads"]}}, "/threads/restore.json"=>{"post"=>{"summary"=>"Threads Restore", "description"=>"Threads Restore", "operationId"=>"threads-restore", "x-api-path-slug"=>"threadsrestore-json-post", "parameters"=>[{"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Looks up a thread by ID You must be a moderator on the selected thread's forum", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads"]}}, "/threads/set.json"=>{"get"=>{"summary"=>"Threads Set", "description"=>"Threads Set", "operationId"=>"threads-set", "x-api-path-slug"=>"threadsset-json-get", "parameters"=>[{"in"=>"query", "name"=>"attach", "description"=>"Defaults to [] Choices: topics", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Looks up a thread by ID You may pass us the 'ident' query type instead of an ID by including 'forum'", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads"]}}, "/threads/spam.json"=>{"post"=>{"summary"=>"Threads Spam", "description"=>"Threads Spam", "operationId"=>"threads-spam", "x-api-path-slug"=>"threadsspam-json-post", "parameters"=>[{"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Looks up a thread by ID You must be a moderator on the selected thread's forum", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads", "Spam"]}}, "/threads/subscribe.json"=>{"post"=>{"summary"=>"Threads Subscribe", "description"=>"Threads Subscribe", "operationId"=>"threads-subscribe", "x-api-path-slug"=>"threadssubscribe-json-post", "parameters"=>[{"in"=>"query", "name"=>"thread", "description"=>"Looks up a thread by ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads"]}}, "/threads/unsubscribe.json"=>{"post"=>{"summary"=>"Threads Unsubscribe", "description"=>"Threads Unsubscribe", "operationId"=>"threads-unsubscribe", "x-api-path-slug"=>"threadsunsubscribe-json-post", "parameters"=>[{"in"=>"query", "name"=>"thread", "description"=>"Looks up a thread by ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads"]}}, "/threads/update.json"=>{"post"=>{"summary"=>"Threads Update", "description"=>"Threads Update", "operationId"=>"threads-update", "x-api-path-slug"=>"threadsupdate-json-post", "parameters"=>[{"in"=>"query", "name"=>"author", "description"=>"Defaults to null You must be a moderator on the applicable forum to change a thread author", "type"=>"string"}, {"in"=>"query", "name"=>"category", "description"=>"Defaults to null Looks up a category by ID", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"identifier", "description"=>"Defaults to null To update a specific identifier, provide 'old_identifier'", "type"=>"string"}, {"in"=>"query", "name"=>"message", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"old_identifier", "description"=>"Defaults to null Only valid if 'identifier' is provided", "type"=>"string"}, {"in"=>"query", "name"=>"slug", "description"=>"Defaults to null Alpha-numeric slug Maximum length of 200", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"You must be the author of the post or a moderator on the applicable forum", "type"=>"string"}, {"in"=>"query", "name"=>"title", "description"=>"Defaults to null Maximum length of 200", "type"=>"string"}, {"in"=>"query", "name"=>"url", "description"=>"Defaults to null URL (defined by RFC 3986) Maximum length of 500", "type"=>"string"}, {"in"=>"query", "name"=>"validateAllPosts", "description"=>"Defaults to null", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads"]}}, "/threads/vote.json"=>{"post"=>{"summary"=>"Threads Vote", "description"=>"Threads Vote", "operationId"=>"threads-vote", "x-api-path-slug"=>"threadsvote-json-post", "parameters"=>[{"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"thread", "description"=>"Looks up a thread by ID You may pass us the 'ident' or 'link' query types instead of an ID by including 'forum'", "type"=>"string"}, {"in"=>"query", "name"=>"vote", "description"=>"Choices: -1, 0, 1", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Threads", "Vote"]}}, "/forums/trustedDomain/kill.json"=>{"post"=>{"summary"=>"Forums TrustedDomain Kill", "description"=>"Forums TrustedDomain Kill", "operationId"=>"forums-trusteddomain-kill", "x-api-path-slug"=>"forumstrusteddomainkill-json-post", "parameters"=>[{"in"=>"query", "name"=>"domain", "description"=>"Looks up a trusted domain by id, or by domain name if forum provided You may pass us the 'domain' query type instead of an ID by including 'forum'", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Defaults to null Looks up a forum by ID (aka short name) You must be a moderator on the selected forum", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/forums/trustedDomain/list.json"=>{"get"=>{"summary"=>"Forums TrustedDomain List", "description"=>"Forums TrustedDomain List", "operationId"=>"forums-trusteddomain-list", "x-api-path-slug"=>"forumstrusteddomainlist-json-get", "parameters"=>[{"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name) You must be a moderator on the selected forum", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Forums"]}}, "/users/details.json"=>{"get"=>{"summary"=>"Users Details", "description"=>"Users Details", "operationId"=>"users-details", "x-api-path-slug"=>"usersdetails-json-get", "parameters"=>[{"in"=>"query", "name"=>"attach", "description"=>"Defaults to [] Choices: userFlaggedUser", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users"]}}, "/users/follow.json"=>{"post"=>{"summary"=>"Users Follow", "description"=>"Users Follow", "operationId"=>"users-follow", "x-api-path-slug"=>"usersfollow-json-post", "parameters"=>[{"in"=>"query", "name"=>"target", "description"=>"Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users"]}}, "/users/listActiveForums.json"=>{"get"=>{"summary"=>"Users ListActiveForums", "description"=>"Users ListActiveForums", "operationId"=>"users-listactiveforums", "x-api-path-slug"=>"userslistactiveforums-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to asc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"since_id", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users"]}}, "/users/listActivity.json"=>{"get"=>{"summary"=>"Users ListActivity", "description"=>"Users ListActivity", "operationId"=>"users-listactivity", "x-api-path-slug"=>"userslistactivity-json-get", "parameters"=>[{"in"=>"query", "name"=>"anon_user", "description"=>"Defaults to null Looks up an anonymous user by unique hash", "type"=>"string"}, {"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"include", "description"=>"Defaults to [ user, replies, following] Choices: user, replies, following", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [ forum, thread] You may specify relations to include with your response", "type"=>"string"}, {"in"=>"query", "name"=>"since", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users"]}}, "/users/listFollowers.json"=>{"get"=>{"summary"=>"Users ListFollowers", "description"=>"Users ListFollowers", "operationId"=>"users-listfollowers", "x-api-path-slug"=>"userslistfollowers-json-get", "parameters"=>[{"in"=>"query", "name"=>"attach", "description"=>"Defaults to [] Choices: userFlaggedUser", "type"=>"string"}, {"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to asc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"since_id", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users"]}}, "/users/listFollowing.json"=>{"get"=>{"summary"=>"Users ListFollowing", "description"=>"Users ListFollowing", "operationId"=>"users-listfollowing", "x-api-path-slug"=>"userslistfollowing-json-get", "parameters"=>[{"in"=>"query", "name"=>"attach", "description"=>"Defaults to [] Choices: userFlaggedUser", "type"=>"string"}, {"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to asc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"since_id", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users"]}}, "/users/listFollowingChannels.json"=>{"get"=>{"summary"=>"Users ListFollowingChannels", "description"=>"Users ListFollowingChannels", "operationId"=>"users-listfollowingchannels", "x-api-path-slug"=>"userslistfollowingchannels-json-get", "parameters"=>[{"in"=>"query", "name"=>"attach", "description"=>"Defaults to [] Choices: followsForum, forumCanDisableAds, forumForumCategory, counters, forumDaysAlive, forumFeatures, forumIntegration, forumNewPolicy, forumPermissions, channel_categories", "type"=>"string"}, {"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"excludeModerated", "description"=>"Defaults to false Whether to exclude Channels that the user moderates fromthe results", "type"=>"string"}, {"in"=>"query", "name"=>"excludeOwned", "description"=>"Defaults to false Whether to exclude Channels that the user owns from the results", "type"=>"string"}, {"in"=>"query", "name"=>"includeFollowedPrimaryForums", "description"=>"Defaults to false Whether to include Channels where the user follows the primary forum", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to asc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"since_id", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users"]}}, "/users/listFollowingForums.json"=>{"get"=>{"summary"=>"Users ListFollowingForums", "description"=>"Users ListFollowingForums", "operationId"=>"users-listfollowingforums", "x-api-path-slug"=>"userslistfollowingforums-json-get", "parameters"=>[{"in"=>"query", "name"=>"attach", "description"=>"Defaults to [] Choices: followsForum, forumCanDisableAds, forumForumCategory, counters, forumDaysAlive, forumFeatures, forumIntegration, forumNewPolicy, forumPermissions", "type"=>"string"}, {"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to asc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"since_id", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users", "Forums"]}}, "/users/listForums.json"=>{"get"=>{"summary"=>"Users ListForums", "description"=>"Users ListForums", "operationId"=>"users-listforums", "x-api-path-slug"=>"userslistforums-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to asc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"since_id", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users", "Forums"]}}, "/users/listModeratedChannels.json"=>{"get"=>{"summary"=>"Users ListModeratedChannels", "description"=>"Users ListModeratedChannels", "operationId"=>"users-listmoderatedchannels", "x-api-path-slug"=>"userslistmoderatedchannels-json-get", "parameters"=>[{"in"=>"query", "name"=>"attach", "description"=>"Defaults to [] Choices: followsForum, forumCanDisableAds, forumForumCategory, counters, forumDaysAlive, forumFeatures, forumIntegration, forumNewPolicy, forumPermissions, channel_categories", "type"=>"string"}, {"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"excludeOwned", "description"=>"Defaults to false Whether to exclude Channels that the user owns from the results", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to asc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"since_id", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users"]}}, "/users/listMostActiveForums.json"=>{"get"=>{"summary"=>"Users ListMostActiveForums", "description"=>"Users ListMostActiveForums", "operationId"=>"users-listmostactiveforums", "x-api-path-slug"=>"userslistmostactiveforums-json-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users"]}}, "/users/listOwnedChannels.json"=>{"get"=>{"summary"=>"Users ListOwnedChannels", "description"=>"Users ListOwnedChannels", "operationId"=>"users-listownedchannels", "x-api-path-slug"=>"userslistownedchannels-json-get", "parameters"=>[{"in"=>"query", "name"=>"attach", "description"=>"Defaults to [] Choices: followsForum, forumCanDisableAds, forumForumCategory, counters, forumDaysAlive, forumFeatures, forumIntegration, forumNewPolicy, forumPermissions, channel_categories", "type"=>"string"}, {"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to asc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"since_id", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users"]}}, "/users/listPosts.json"=>{"get"=>{"summary"=>"Users ListPosts", "description"=>"Users ListPosts", "operationId"=>"users-listposts", "x-api-path-slug"=>"userslistposts-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"filters", "description"=>"Defaults to [] Valid values are: 1: Is_Anonymous 2: Has_Link 3: Has_Low_Rep_Author 4: Has_Bad_Word 5: Is_Flagged 6: No_Issue 7: Is_Toxic", "type"=>"string"}, {"in"=>"query", "name"=>"include", "description"=>"Defaults to [ approved] Choices: unapproved, approved, spam, deleted, flagged, highlighted", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to desc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}, {"in"=>"query", "name"=>"since", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to null Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users"]}}, "/users/removeFollower.json"=>{"post"=>{"summary"=>"Users RemoveFollower", "description"=>"Users RemoveFollower", "operationId"=>"users-removefollower", "x-api-path-slug"=>"usersremovefollower-json-post", "parameters"=>[{"in"=>"query", "name"=>"follower", "description"=>"Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users"]}}, "/users/report.json"=>{"post"=>{"summary"=>"Users Report", "description"=>"Users Report", "operationId"=>"users-report", "x-api-path-slug"=>"usersreport-json-post", "parameters"=>[{"in"=>"query", "name"=>"reason", "description"=>"Valid values are: 0: HARASSMENT 1: SPAM 2: INAPPROPRIATE_CONTENT 3: THREAT 4: IMPERSONATION 5: PRIVATE_INFORMATION 6: DISAGREE", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users"]}}, "/users/unfollow.json"=>{"post"=>{"summary"=>"Users Unfollow", "description"=>"Users Unfollow", "operationId"=>"users-unfollow", "x-api-path-slug"=>"usersunfollow-json-post", "parameters"=>[{"in"=>"query", "name"=>"target", "description"=>"Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users"]}}, "/users/updateProfile.json"=>{"post"=>{"summary"=>"Users UpdateProfile", "description"=>"Users UpdateProfile", "operationId"=>"users-updateprofile", "x-api-path-slug"=>"usersupdateprofile-json-post", "parameters"=>[{"in"=>"query", "name"=>"about", "type"=>"string"}, {"in"=>"query", "name"=>"location", "description"=>"Defaults to Maximum length of 255", "type"=>"string"}, {"in"=>"query", "name"=>"name", "description"=>"Defaults to Minimum length of 2 Maximum length of 30", "type"=>"string"}, {"in"=>"query", "name"=>"url", "description"=>"Defaults to URL (defined by RFC 3986) Maximum length of 200", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "Users"]}}, "/whitelists/list.json"=>{"get"=>{"summary"=>"Whitelists List", "description"=>"Whitelists List", "operationId"=>"whitelists-list", "x-api-path-slug"=>"whitelistslist-json-get", "parameters"=>[{"in"=>"query", "name"=>"cursor", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"limit", "description"=>"Defaults to 25 Maximum value of 100", "type"=>"string"}, {"in"=>"query", "name"=>"order", "description"=>"Defaults to asc Choices: asc, desc", "type"=>"string"}, {"in"=>"query", "name"=>"query", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"related", "description"=>"Defaults to [] You may specify relations to include with your response", "type"=>"string"}, {"in"=>"query", "name"=>"since", "description"=>"Defaults to null Unix timestamp (or ISO datetime standard)", "type"=>"string"}, {"in"=>"query", "name"=>"since_id", "description"=>"Defaults to null", "type"=>"string"}, {"in"=>"query", "name"=>"type", "description"=>"Defaults to null Choices: email, user", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "White Lists"]}}, "/whitelists/remove.json"=>{"post"=>{"summary"=>"Whitelists Remove", "description"=>"Whitelists Remove", "operationId"=>"whitelists-remove", "x-api-path-slug"=>"whitelistsremove-json-post", "parameters"=>[{"in"=>"query", "name"=>"email", "description"=>"Defaults to [] Email address (defined by RFC 5322)", "type"=>"string"}, {"in"=>"query", "name"=>"forum", "description"=>"Looks up a forum by ID (aka short name)", "type"=>"string"}, {"in"=>"query", "name"=>"user", "description"=>"Defaults to [] Looks up a user by ID You may look up a user by username using the 'username' query type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Comments", "White Lists"]}}, "/users/interestingUsers.json"=>{"get"=>{"summary"=>"Interesting Users", "description"=>"Interesting Users", "operationId"=>"interestingUsers", "x-api-path-slug"=>"usersinterestingusers-json-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users", "Interesting"]}}}}, "apis"=>{"name"=>"Disqus", "x-slug"=>"disqus", "description"=>"Disqus offers the best add-on tools for websites to increase engagement. We help publishers power online discussions with comments and earn revenue with native advertising.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/182-disqus.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"973", "tags"=>"API Provider,Comments,Content,General Data,Historical Data API,internet,Media,My API Stack,Pedestal,Profiles,Relative Data,Relative StreamRank,SaaS,Social,Stack,Stack Network,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"disqus/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Disqus", "x-api-slug"=>"disqus", "description"=>"Disqus offers the best add-on tools for websites to increase engagement. We help publishers power online discussions with comments and earn revenue with native advertising.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/182-disqus.jpg", "humanURL"=>"https://disqus.com/", "baseURL"=>"https://disqus.com/api/3.0/", "tags"=>"API Provider,Comments,Content,General Data,Historical Data API,internet,Media,My API Stack,Pedestal,Profiles,Relative Data,Relative StreamRank,SaaS,Social,Stack,Stack Network,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/disqus/disqus-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://disqus.com/api/"}, {"type"=>"x-blog", "url"=>"http://blog.disqus.com"}, {"type"=>"x-blog-rss", "url"=>"http://blog.disqus.com/rss"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/disqus"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/disqus"}, {"type"=>"x-developer", "url"=>"https://disqus.com/api/docs/"}, {"type"=>"x-github", "url"=>"https://github.com/disqus"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/disqus"}, {"type"=>"x-partners", "url"=>"https://disqus.com/partners/"}, {"type"=>"x-privacy", "url"=>"https://help.disqus.com/customer/en/portal/articles/466259-privacy-policy"}, {"type"=>"x-support", "url"=>"https://help.disqus.com/"}, {"type"=>"x-terms-of-service", "url"=>"https://help.disqus.com/customer/portal/topics/215159-terms-and-policies/articles"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/disqus"}, {"type"=>"x-website", "url"=>"https://disqus.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-opsworks{"apis"=>{"name"=>"AWS OpsWorks", "x-slug"=>"aws-opsworks", "description"=>"AWS OpsWorks is a configuration management service that uses Chef, an automation platform that treats server configurations as code. OpsWorks uses Chef to automate how servers are configured, deployed, and managed across your Amazon Elastic Compute Cloud (Amazon EC2) instances or on-premises compute environments. OpsWorks has two offerings, AWS Opsworks for Chef Automate, and AWS OpsWorks Stacks.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Management-Tools_AWSOpsWorks.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Orchestration,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-opsworks/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS OpsWorks API", "x-api-slug"=>"aws-opsworks-api", "description"=>"AWS OpsWorks is a configuration management service that uses Chef, an automation platform that treats server configurations as code. OpsWorks uses Chef to automate how servers are configured, deployed, and managed across your Amazon Elastic Compute Cloud (Amazon EC2) instances or on-premises compute environments. OpsWorks has two offerings, AWS Opsworks for Chef Automate, and AWS OpsWorks Stacks.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Management-Tools_AWSOpsWorks.png", "humanURL"=>"https://aws.amazon.com/opsworks/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Orchestration,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-opsworks/aws-opsworks-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/opsworks/latest/APIReference/Welcome.html"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/opsworks/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "aws-opsworks-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS OpsWorks", "x-complete"=>1, "info"=>{"title"=>"AWS OpsWorks API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AssignInstance"=>{"get"=>{"summary"=>"Assign Instance", "description"=>"Assign a registered instance to a layer.", "operationId"=>"assignInstance", "x-api-path-slug"=>"actionassigninstance-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}, {"in"=>"query", "name"=>"LayerIds", "description"=>"The layer ID, which must correspond to a custom layer", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assign", "Instance"]}}, "/?Action=AssignVolume"=>{"get"=>{"summary"=>"Assign Volume", "description"=>"Assigns one of the stack's registered Amazon EBS volumes to a specified instance.", "operationId"=>"assignVolume", "x-api-path-slug"=>"actionassignvolume-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId", "description"=>"The volume ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Assign", "Volume"]}}, "/?Action=AssociateElasticIp"=>{"get"=>{"summary"=>"Associate Elastic IP", "description"=>"Associates one of the stack's registered Elastic IP addresses with a specified instance.", "operationId"=>"associateElasticIp", "x-api-path-slug"=>"actionassociateelasticip-get", "parameters"=>[{"in"=>"query", "name"=>"ElasticIp", "description"=>"The Elastic IP address", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Associate", "Elastic", "IP Addresses"]}}, "/?Action=AttachElasticLoadBalancer"=>{"get"=>{"summary"=>"Attach Elastic Load Balancer", "description"=>"Attaches an Elastic Load Balancing load balancer to a specified layer.", "operationId"=>"attachElasticLoadBalancer", "x-api-path-slug"=>"actionattachelasticloadbalancer-get", "parameters"=>[{"in"=>"query", "name"=>"ElasticLoadBalancerName", "description"=>"The Elastic Load Balancing instances name", "type"=>"string"}, {"in"=>"query", "name"=>"LayerId", "description"=>"The ID of the layer that the Elastic Load Balancing instance is to be attached to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Attach", "Elastic", "Load", "Balancer"]}}, "/?Action=CloneStack"=>{"get"=>{"summary"=>"Clone Stack", "description"=>"Creates a clone of a specified stack.", "operationId"=>"cloneStack", "x-api-path-slug"=>"actionclonestack-get", "parameters"=>[{"in"=>"query", "name"=>"AgentVersion", "description"=>"The default AWS OpsWorks Stacks agent version", "type"=>"string"}, {"in"=>"query", "name"=>"Attributes", "description"=>"A list of stack attributes and values as key/value pairs to be added to the cloned stack", "type"=>"string"}, {"in"=>"query", "name"=>"ChefConfiguration", "description"=>"A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11", "type"=>"string"}, {"in"=>"query", "name"=>"CloneAppIds", "description"=>"A list of source stack app IDs to be included in the cloned stack", "type"=>"string"}, {"in"=>"query", "name"=>"ClonePermissions", "description"=>"Whether to clone the source stacks permissions", "type"=>"string"}, {"in"=>"query", "name"=>"ConfigurationManager", "description"=>"The configuration manager", "type"=>"string"}, {"in"=>"query", "name"=>"CustomCookbooksSource", "description"=>"Contains the information required to retrieve an app or cookbook from a repository", "type"=>"string"}, {"in"=>"query", "name"=>"CustomJson", "description"=>"A string that contains user-defined, custom JSON", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultAvailabilityZone", "description"=>"The cloned stacks default Availability Zone, which must be in the specified region", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultInstanceProfileArn", "description"=>"The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stacks EC2 instances", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultOs", "description"=>"The stacks operating system, which must be set to one of the following", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultRootDeviceType", "description"=>"The default root device type", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultSshKeyName", "description"=>"A default Amazon EC2 key pair name", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultSubnetId", "description"=>"The stacks default VPC subnet ID", "type"=>"string"}, {"in"=>"query", "name"=>"HostnameTheme", "description"=>"The stacks host name theme, with spaces are replaced by underscores", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The cloned stack name", "type"=>"string"}, {"in"=>"query", "name"=>"Region", "description"=>"The cloned stack AWS region, such as ap-northeast-2", "type"=>"string"}, {"in"=>"query", "name"=>"ServiceRoleArn", "description"=>"The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf", "type"=>"string"}, {"in"=>"query", "name"=>"SourceStackId", "description"=>"The source stack ID", "type"=>"string"}, {"in"=>"query", "name"=>"UseCustomCookbooks", "description"=>"Whether to use custom cookbooks", "type"=>"string"}, {"in"=>"query", "name"=>"UseOpsworksSecurityGroups", "description"=>"Whether to associate the AWS OpsWorks Stacks built-in security groups with the stacks layers", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC that the cloned stack is to be launched into", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clone", "Stack"]}}, "/?Action=CreateApp"=>{"get"=>{"summary"=>"Create App", "description"=>"Creates an app for a specified stack.", "operationId"=>"createApp", "x-api-path-slug"=>"actioncreateapp-get", "parameters"=>[{"in"=>"query", "name"=>"AppSource", "description"=>"A Source object that specifies the app repository", "type"=>"string"}, {"in"=>"query", "name"=>"Attributes", "description"=>"One or more user-defined key/value pairs to be added to the stack attributes", "type"=>"string"}, {"in"=>"query", "name"=>"DataSources", "description"=>"The apps data source", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A description of the app", "type"=>"string"}, {"in"=>"query", "name"=>"Domains", "description"=>"The app virtual host settings, with multiple domains separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"EnableSsl", "description"=>"Whether to enable SSL for the app", "type"=>"string"}, {"in"=>"query", "name"=>"Environment", "description"=>"An array of EnvironmentVariable objects that specify environment variables to be associated with the app", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The app name", "type"=>"string"}, {"in"=>"query", "name"=>"Shortname", "description"=>"The apps short name", "type"=>"string"}, {"in"=>"query", "name"=>"SslConfiguration", "description"=>"An SslConfiguration object with the SSL configuration", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}, {"in"=>"query", "name"=>"Type", "description"=>"The app type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App"]}}, "/?Action=CreateDeployment"=>{"get"=>{"summary"=>"Create Deployment", "description"=>"Runs deployment or stack commands.", "operationId"=>"createDeployment", "x-api-path-slug"=>"actioncreatedeployment-get", "parameters"=>[{"in"=>"query", "name"=>"AppId", "description"=>"The app ID", "type"=>"string"}, {"in"=>"query", "name"=>"Command", "description"=>"A DeploymentCommand object that specifies the deployment command and any associated arguments", "type"=>"string"}, {"in"=>"query", "name"=>"Comment", "description"=>"A user-defined comment", "type"=>"string"}, {"in"=>"query", "name"=>"CustomJson", "description"=>"A string that contains user-defined, custom JSON", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceIds", "description"=>"The instance IDs for the deployment targets", "type"=>"string"}, {"in"=>"query", "name"=>"LayerIds", "description"=>"The layer IDs for the deployment targets", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment"]}}, "/?Action=CreateInstance"=>{"get"=>{"summary"=>"Create Instance", "description"=>"Creates an instance in a specified stack.", "operationId"=>"createInstance", "x-api-path-slug"=>"actioncreateinstance-get", "parameters"=>[{"in"=>"query", "name"=>"AgentVersion", "description"=>"The default AWS OpsWorks Stacks agent version", "type"=>"string"}, {"in"=>"query", "name"=>"AmiId", "description"=>"A custom AMI ID to be used to create the instance", "type"=>"string"}, {"in"=>"query", "name"=>"Architecture", "description"=>"The instance architecture", "type"=>"string"}, {"in"=>"query", "name"=>"AutoScalingType", "description"=>"For load-based or time-based instances, the type", "type"=>"string"}, {"in"=>"query", "name"=>"AvailabilityZone", "description"=>"The instance Availability Zone", "type"=>"string"}, {"in"=>"query", "name"=>"BlockDeviceMappings", "description"=>"An array of BlockDeviceMapping objects that specify the instances block devices", "type"=>"string"}, {"in"=>"query", "name"=>"EbsOptimized", "description"=>"Whether to create an Amazon EBS-optimized instance", "type"=>"string"}, {"in"=>"query", "name"=>"Hostname", "description"=>"The instance host name", "type"=>"string"}, {"in"=>"query", "name"=>"InstallUpdatesOnBoot", "description"=>"Whether to install operating system and package updates when the instance boots", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceType", "description"=>"The instance type, such as t2", "type"=>"string"}, {"in"=>"query", "name"=>"LayerIds", "description"=>"An array that contains the instances layer IDs", "type"=>"string"}, {"in"=>"query", "name"=>"Os", "description"=>"The instances operating system, which must be set to one of the following", "type"=>"string"}, {"in"=>"query", "name"=>"RootDeviceType", "description"=>"The instance root device type", "type"=>"string"}, {"in"=>"query", "name"=>"SshKeyName", "description"=>"The instances Amazon EC2 key-pair name", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}, {"in"=>"query", "name"=>"SubnetId", "description"=>"The ID of the instances subnet", "type"=>"string"}, {"in"=>"query", "name"=>"Tenancy", "description"=>"The instances tenancy option", "type"=>"string"}, {"in"=>"query", "name"=>"VirtualizationType", "description"=>"The instances virtualization type, paravirtual or hvm", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/?Action=CreateLayer"=>{"get"=>{"summary"=>"Create Layer", "description"=>"Creates a layer.", "operationId"=>"createLayer", "x-api-path-slug"=>"actioncreatelayer-get", "parameters"=>[{"in"=>"query", "name"=>"Attributes", "description"=>"One or more user-defined key-value pairs to be added to the stack attributes", "type"=>"string"}, {"in"=>"query", "name"=>"AutoAssignElasticIps", "description"=>"Whether to automatically assign an Elastic IP address to the layers instances", "type"=>"string"}, {"in"=>"query", "name"=>"AutoAssignPublicIps", "description"=>"For stacks that are running in a VPC, whether to automatically assign a public IP address to the layers instances", "type"=>"string"}, {"in"=>"query", "name"=>"CustomInstanceProfileArn", "description"=>"The ARN of an IAM profile to be used for the layers EC2 instances", "type"=>"string"}, {"in"=>"query", "name"=>"CustomJson", "description"=>"A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layers instances", "type"=>"string"}, {"in"=>"query", "name"=>"CustomRecipes", "description"=>"A LayerCustomRecipes object that specifies the layer custom recipes", "type"=>"string"}, {"in"=>"query", "name"=>"CustomSecurityGroupIds", "description"=>"An array containing the layer custom security group IDs", "type"=>"string"}, {"in"=>"query", "name"=>"EnableAutoHealing", "description"=>"Whether to disable auto healing for the layer", "type"=>"string"}, {"in"=>"query", "name"=>"InstallUpdatesOnBoot", "description"=>"Whether to install operating system and package updates when the instance boots", "type"=>"string"}, {"in"=>"query", "name"=>"LifecycleEventConfiguration", "description"=>"A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The layer name, which is used by the console", "type"=>"string"}, {"in"=>"query", "name"=>"Packages", "description"=>"An array of Package objects that describes the layer packages", "type"=>"string"}, {"in"=>"query", "name"=>"Shortname", "description"=>"For custom layers only, use this parameter to specify the layers short name, which is used internally by AWS OpsWorks Stacks and by Chef recipes", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The layer stack ID", "type"=>"string"}, {"in"=>"query", "name"=>"Type", "description"=>"The layer type", "type"=>"string"}, {"in"=>"query", "name"=>"UseEbsOptimizedInstances", "description"=>"Whether to use Amazon EBS-optimized instances", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeConfigurations", "description"=>"A VolumeConfigurations object that describes the layers Amazon EBS volumes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layer"]}}, "/?Action=CreateStack"=>{"get"=>{"summary"=>"Create Stack", "description"=>"Creates a new stack.", "operationId"=>"createStack", "x-api-path-slug"=>"actioncreatestack-get", "parameters"=>[{"in"=>"query", "name"=>"AgentVersion", "description"=>"The default AWS OpsWorks Stacks agent version", "type"=>"string"}, {"in"=>"query", "name"=>"Attributes", "description"=>"One or more user-defined key-value pairs to be added to the stack attributes", "type"=>"string"}, {"in"=>"query", "name"=>"ChefConfiguration", "description"=>"A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11", "type"=>"string"}, {"in"=>"query", "name"=>"ConfigurationManager", "description"=>"The configuration manager", "type"=>"string"}, {"in"=>"query", "name"=>"CustomCookbooksSource", "description"=>"Contains the information required to retrieve an app or cookbook from a repository", "type"=>"string"}, {"in"=>"query", "name"=>"CustomJson", "description"=>"A string that contains user-defined, custom JSON", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultAvailabilityZone", "description"=>"The stacks default Availability Zone, which must be in the specified region", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultInstanceProfileArn", "description"=>"The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stacks EC2 instances", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultOs", "description"=>"The stacks default operating system, which is installed on every instance unless you specify a different operating system when you create the instance", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultRootDeviceType", "description"=>"The default root device type", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultSshKeyName", "description"=>"A default Amazon EC2 key pair name", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultSubnetId", "description"=>"The stacks default VPC subnet ID", "type"=>"string"}, {"in"=>"query", "name"=>"HostnameTheme", "description"=>"The stacks host name theme, with spaces replaced by underscores", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The stack name", "type"=>"string"}, {"in"=>"query", "name"=>"Region", "description"=>"The stacks AWS region, such as ap-south-1", "type"=>"string"}, {"in"=>"query", "name"=>"ServiceRoleArn", "description"=>"The stacks AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf", "type"=>"string"}, {"in"=>"query", "name"=>"UseCustomCookbooks", "description"=>"Whether the stack uses custom cookbooks", "type"=>"string"}, {"in"=>"query", "name"=>"UseOpsworksSecurityGroups", "description"=>"Whether to associate the AWS OpsWorks Stacks built-in security groups with the stacks layers", "type"=>"string"}, {"in"=>"query", "name"=>"VpcId", "description"=>"The ID of the VPC that the stack is to be launched into", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stack"]}}, "/?Action=CreateUserProfile"=>{"get"=>{"summary"=>"Create User Profile", "description"=>"Creates a new user profile.", "operationId"=>"createUserProfile", "x-api-path-slug"=>"actioncreateuserprofile-get", "parameters"=>[{"in"=>"query", "name"=>"AllowSelfManagement", "description"=>"Whether users can specify their own SSH public key through the My Settings page", "type"=>"string"}, {"in"=>"query", "name"=>"IamUserArn", "description"=>"The users IAM ARN; this can also be a federated users ARN", "type"=>"string"}, {"in"=>"query", "name"=>"SshPublicKey", "description"=>"The users public SSH key", "type"=>"string"}, {"in"=>"query", "name"=>"SshUsername", "description"=>"The users SSH user name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Profile"]}}, "/?Action=DeleteApp"=>{"get"=>{"summary"=>"Delete App", "description"=>"Deletes a specified app.", "operationId"=>"deleteApp", "x-api-path-slug"=>"actiondeleteapp-get", "parameters"=>[{"in"=>"query", "name"=>"AppId", "description"=>"The app ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App"]}}, "/?Action=DeleteInstance"=>{"get"=>{"summary"=>"Delete Instance", "description"=>"Deletes a specified instance, which terminates the associated Amazon EC2 instance.", "operationId"=>"deleteInstance", "x-api-path-slug"=>"actiondeleteinstance-get", "parameters"=>[{"in"=>"query", "name"=>"DeleteElasticIp", "description"=>"Whether to delete the instance Elastic IP address", "type"=>"string"}, {"in"=>"query", "name"=>"DeleteVolumes", "description"=>"Whether to delete the instances Amazon EBS volumes", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/?Action=DeleteLayer"=>{"get"=>{"summary"=>"Delete Layer", "description"=>"Deletes a specified layer.", "operationId"=>"deleteLayer", "x-api-path-slug"=>"actiondeletelayer-get", "parameters"=>[{"in"=>"query", "name"=>"LayerId", "description"=>"The layer ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layer"]}}, "/?Action=DeleteStack"=>{"get"=>{"summary"=>"Delete Stack", "description"=>"Deletes a specified stack.", "operationId"=>"deleteStack", "x-api-path-slug"=>"actiondeletestack-get", "parameters"=>[{"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stack"]}}, "/?Action=DeleteUserProfile"=>{"get"=>{"summary"=>"Delete User Profile", "description"=>"Deletes a user profile.", "operationId"=>"deleteUserProfile", "x-api-path-slug"=>"actiondeleteuserprofile-get", "parameters"=>[{"in"=>"query", "name"=>"IamUserArn", "description"=>"The users IAM ARN", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Profile"]}}, "/?Action=DeregisterEcsCluster"=>{"get"=>{"summary"=>"Deregister Ecs Cluster", "description"=>"Deregisters a specified Amazon ECS cluster from a stack.", "operationId"=>"deregisterEcsCluster", "x-api-path-slug"=>"actionderegisterecscluster-get", "parameters"=>[{"in"=>"query", "name"=>"EcsClusterArn", "description"=>"The clusters ARN", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deregister", "Ecs", "Cluster"]}}, "/?Action=DeregisterElasticIp"=>{"get"=>{"summary"=>"Deregister Elastic IP", "description"=>"Deregisters a specified Elastic IP address.", "operationId"=>"deregisterElasticIp", "x-api-path-slug"=>"actionderegisterelasticip-get", "parameters"=>[{"in"=>"query", "name"=>"ElasticIp", "description"=>"The Elastic IP address", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deregister", "Elastic", "IP Addresses"]}}, "/?Action=DeregisterInstance"=>{"get"=>{"summary"=>"Deregister Instance", "description"=>"Deregister a registered Amazon EC2 or on-premises instance.", "operationId"=>"deregisterInstance", "x-api-path-slug"=>"actionderegisterinstance-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deregister", "Instance"]}}, "/?Action=DeregisterRdsDbInstance"=>{"get"=>{"summary"=>"Deregister Rds Db Instance", "description"=>"Deregisters an Amazon RDS instance.", "operationId"=>"deregisterRdsDbInstance", "x-api-path-slug"=>"actionderegisterrdsdbinstance-get", "parameters"=>[{"in"=>"query", "name"=>"RdsDbInstanceArn", "description"=>"The Amazon RDS instances ARN", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deregister", "Rds", "Db", "Instance"]}}, "/?Action=DeregisterVolume"=>{"get"=>{"summary"=>"Deregister Volume", "description"=>"Deregisters an Amazon EBS volume.", "operationId"=>"deregisterVolume", "x-api-path-slug"=>"actionderegistervolume-get", "parameters"=>[{"in"=>"query", "name"=>"VolumeId", "description"=>"The AWS OpsWorks Stacks volume ID, which is the GUID that AWS OpsWorks Stacks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deregister", "Volume"]}}, "/?Action=DescribeAgentVersions"=>{"get"=>{"summary"=>"Describe Agent Versions", "description"=>"Describes the available AWS OpsWorks Stacks agent versions.", "operationId"=>"describeAgentVersions", "x-api-path-slug"=>"actiondescribeagentversions-get", "parameters"=>[{"in"=>"query", "name"=>"ConfigurationManager", "description"=>"The configuration manager", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Agent", "Versions"]}}, "/?Action=DescribeApps"=>{"get"=>{"summary"=>"Describe Apps", "description"=>"Requests a description of a specified set of apps.", "operationId"=>"describeApps", "x-api-path-slug"=>"actiondescribeapps-get", "parameters"=>[{"in"=>"query", "name"=>"AppIds", "description"=>"An array of app IDs for the apps to be described", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The app stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Apps"]}}, "/?Action=DescribeCommands"=>{"get"=>{"summary"=>"Describe Commands", "description"=>"Describes the results of specified commands.", "operationId"=>"describeCommands", "x-api-path-slug"=>"actiondescribecommands-get", "parameters"=>[{"in"=>"query", "name"=>"CommandIds", "description"=>"An array of command IDs", "type"=>"string"}, {"in"=>"query", "name"=>"DeploymentId", "description"=>"The deployment ID", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Commands"]}}, "/?Action=DescribeDeployments"=>{"get"=>{"summary"=>"Describe Deployments", "description"=>"Requests a description of a specified set of deployments.", "operationId"=>"describeDeployments", "x-api-path-slug"=>"actiondescribedeployments-get", "parameters"=>[{"in"=>"query", "name"=>"AppId", "description"=>"The app ID", "type"=>"string"}, {"in"=>"query", "name"=>"DeploymentIds", "description"=>"An array of deployment IDs to be described", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Deployments"]}}, "/?Action=DescribeEcsClusters"=>{"get"=>{"summary"=>"Describe Ecs Clusters", "description"=>"Describes Amazon ECS clusters that are registered with a stack.", "operationId"=>"describeEcsClusters", "x-api-path-slug"=>"actiondescribeecsclusters-get", "parameters"=>[{"in"=>"query", "name"=>"EcsClusterArns", "description"=>"A list of ARNs, one for each cluster to be described", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"If the previous paginated request did not return all of the remaining results, the response objectsNextToken parameter value is set to a token", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"A stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Ecs", "Clusters"]}}, "/?Action=DescribeElasticIps"=>{"get"=>{"summary"=>"Describes Elastic IPs", "description"=>"Describes Elastic IPs", "operationId"=>"describeElasticIps", "x-api-path-slug"=>"actiondescribeelasticips-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}, {"in"=>"query", "name"=>"Ips", "description"=>"An array of Elastic IP addresses to be described", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"A stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describes", "Elastic", "IP Addressess"]}}, "/?Action=DescribeElasticLoadBalancers"=>{"get"=>{"summary"=>"Describe Elastic Load Balancers", "description"=>"Describes a stack's Elastic Load Balancing instances.", "operationId"=>"describeElasticLoadBalancers", "x-api-path-slug"=>"actiondescribeelasticloadbalancers-get", "parameters"=>[{"in"=>"query", "name"=>"LayerIds", "description"=>"A list of layer IDs", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"A stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Elastic", "Load", "Balancers"]}}, "/?Action=DescribeInstances"=>{"get"=>{"summary"=>"Describe Instances", "description"=>"Requests a description of a set of instances.", "operationId"=>"describeInstances", "x-api-path-slug"=>"actiondescribeinstances-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceIds", "description"=>"An array of instance IDs to be described", "type"=>"string"}, {"in"=>"query", "name"=>"LayerId", "description"=>"A layer ID", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"A stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Instances"]}}, "/?Action=DescribeLayers"=>{"get"=>{"summary"=>"Describe Layers", "description"=>"Requests a description of one or more layers in a specified stack.", "operationId"=>"describeLayers", "x-api-path-slug"=>"actiondescribelayers-get", "parameters"=>[{"in"=>"query", "name"=>"LayerIds", "description"=>"An array of layer IDs that specify the layers to be described", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Layers"]}}, "/?Action=DescribeLoadBasedAutoScaling"=>{"get"=>{"summary"=>"Describe Load Based Auto Scaling", "description"=>"Describes load-based auto scaling configurations for specified layers.", "operationId"=>"describeLoadBasedAutoScaling", "x-api-path-slug"=>"actiondescribeloadbasedautoscaling-get", "parameters"=>[{"in"=>"query", "name"=>"LayerIds", "description"=>"An array of layer IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Load", "Based", "Auto", "Scaling"]}}, "/?Action=DescribeMyUserProfile"=>{"get"=>{"summary"=>"Describe My User Profile", "description"=>"Describes a user's SSH information.", "operationId"=>"describeMyUserProfile", "x-api-path-slug"=>"actiondescribemyuserprofile-get", "parameters"=>[{"in"=>"query", "name"=>"UserProfile", "description"=>"A UserProfile object that describes the users SSH information", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "My", "User", "Profile"]}}, "/?Action=DescribePermissions"=>{"get"=>{"summary"=>"Describe Permissions", "description"=>"Describes the permissions for a specified stack.", "operationId"=>"describePermissions", "x-api-path-slug"=>"actiondescribepermissions-get", "parameters"=>[{"in"=>"query", "name"=>"IamUserArn", "description"=>"The users IAM ARN", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Permissions"]}}, "/?Action=DescribeRaidArrays"=>{"get"=>{"summary"=>"Describe Raid Arrays", "description"=>"Describe an instance's RAID arrays.", "operationId"=>"describeRaidArrays", "x-api-path-slug"=>"actiondescriberaidarrays-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}, {"in"=>"query", "name"=>"RaidArrayIds", "description"=>"An array of RAID array IDs", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Raid", "Arrays"]}}, "/?Action=DescribeRdsDbInstances"=>{"get"=>{"summary"=>"Describe Rds Db Instances", "description"=>"Describes Amazon RDS instances.", "operationId"=>"describeRdsDbInstances", "x-api-path-slug"=>"actiondescriberdsdbinstances-get", "parameters"=>[{"in"=>"query", "name"=>"RdsDbInstanceArns", "description"=>"An array containing the ARNs of the instances to be described", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The stack ID that the instances are registered with", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Rds", "Db", "Instances"]}}, "/?Action=DescribeServiceErrors"=>{"get"=>{"summary"=>"Describe Service Errors", "description"=>"Describes AWS OpsWorks Stacks service errors.", "operationId"=>"describeServiceErrors", "x-api-path-slug"=>"actiondescribeserviceerrors-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}, {"in"=>"query", "name"=>"ServiceErrorIds", "description"=>"An array of service error IDs", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Service", "Errors"]}}, "/?Action=DescribeStackProvisioningParameters"=>{"get"=>{"summary"=>"Describe Stack Provisioning Parameters", "description"=>"Requests a description of a stack's provisioning parameters.", "operationId"=>"describeStackProvisioningParameters", "x-api-path-slug"=>"actiondescribestackprovisioningparameters-get", "parameters"=>[{"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Stack", "Provisioning", "Parameters"]}}, "/?Action=DescribeStacks"=>{"get"=>{"summary"=>"Describe Stacks", "description"=>"Requests a description of one or more stacks.", "operationId"=>"describeStacks", "x-api-path-slug"=>"actiondescribestacks-get", "parameters"=>[{"in"=>"query", "name"=>"StackIds", "description"=>"An array of stack IDs that specify the stacks to be described", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Stacks"]}}, "/?Action=DescribeStackSummary"=>{"get"=>{"summary"=>"Describe Stack Summary", "description"=>"Describes the number of layers and apps in a specified stack, and the number of instances in\n each state, such as running_setup or online.", "operationId"=>"describeStackSummary", "x-api-path-slug"=>"actiondescribestacksummary-get", "parameters"=>[{"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Stack", "Summary"]}}, "/?Action=DescribeTimeBasedAutoScaling"=>{"get"=>{"summary"=>"Describe Time Based Auto Scaling", "description"=>"Describes time-based auto scaling configurations for specified instances.", "operationId"=>"describeTimeBasedAutoScaling", "x-api-path-slug"=>"actiondescribetimebasedautoscaling-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceIds", "description"=>"An array of instance IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Time", "Based", "Auto", "Scaling"]}}, "/?Action=DescribeUserProfiles"=>{"get"=>{"summary"=>"Describe User Profiles", "description"=>"Describe specified users.", "operationId"=>"describeUserProfiles", "x-api-path-slug"=>"actiondescribeuserprofiles-get", "parameters"=>[{"in"=>"query", "name"=>"IamUserArns", "description"=>"An array of IAM or federated user ARNs that identify the users to be described", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "User", "Profiles"]}}, "/?Action=DescribeVolumes"=>{"get"=>{"summary"=>"Describe Volumes", "description"=>"Describes an instance's Amazon EBS volumes.", "operationId"=>"describeVolumes", "x-api-path-slug"=>"actiondescribevolumes-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}, {"in"=>"query", "name"=>"RaidArrayId", "description"=>"The RAID array ID", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"A stack ID", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeIds", "description"=>"Am array of volume IDs", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Describe", "Volumes"]}}, "/?Action=DetachElasticLoadBalancer"=>{"get"=>{"summary"=>"Detach Elastic Load Balancer", "description"=>"Detaches a specified Elastic Load Balancing instance from its layer.", "operationId"=>"detachElasticLoadBalancer", "x-api-path-slug"=>"actiondetachelasticloadbalancer-get", "parameters"=>[{"in"=>"query", "name"=>"ElasticLoadBalancerName", "description"=>"The Elastic Load Balancing instances name", "type"=>"string"}, {"in"=>"query", "name"=>"LayerId", "description"=>"The ID of the layer that the Elastic Load Balancing instance is attached to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Detach", "Elastic", "Load", "Balancer"]}}, "/?Action=DisassociateElasticIp"=>{"get"=>{"summary"=>"Disassociate Elastic Ip", "description"=>"Disassociates an Elastic IP address from its instance.", "operationId"=>"disassociateElasticIp", "x-api-path-slug"=>"actiondisassociateelasticip-get", "parameters"=>[{"in"=>"query", "name"=>"ElasticIp", "description"=>"The Elastic IP address", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disassociate", "Elastic", "Ip"]}}, "/?Action=GetHostnameSuggestion"=>{"get"=>{"summary"=>"Get Hostname Suggestion", "description"=>"Gets a generated host name for the specified layer, based on the current host name theme.", "operationId"=>"getHostnameSuggestion", "x-api-path-slug"=>"actiongethostnamesuggestion-get", "parameters"=>[{"in"=>"query", "name"=>"LayerId", "description"=>"The layer ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Hostname", "Suggestion"]}}, "/?Action=GrantAccess"=>{"get"=>{"summary"=>"Grant Access", "description"=>"NoteThis action can be used only with Windows stacks.", "operationId"=>"grantAccess", "x-api-path-slug"=>"actiongrantaccess-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The instances AWS OpsWorks Stacks ID", "type"=>"string"}, {"in"=>"query", "name"=>"ValidForInMinutes", "description"=>"The length of time (in minutes) that the grant is valid", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Grant", "Access"]}}, "/?Action=RebootInstance"=>{"get"=>{"summary"=>"Reboot Instance", "description"=>"Reboots a specified instance.", "operationId"=>"rebootInstance", "x-api-path-slug"=>"actionrebootinstance-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Reboot", "Instance"]}}, "/?Action=RegisterEcsCluster"=>{"get"=>{"summary"=>"Register Ecs Cluster", "description"=>"Registers a specified Amazon ECS cluster with a stack.", "operationId"=>"registerEcsCluster", "x-api-path-slug"=>"actionregisterecscluster-get", "parameters"=>[{"in"=>"query", "name"=>"EcsClusterArn", "description"=>"The clusters ARN", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "Ecs", "Cluster"]}}, "/?Action=RegisterElasticIp"=>{"get"=>{"summary"=>"Register Elastic Ip", "description"=>"Registers an Elastic IP address with a specified stack.", "operationId"=>"registerElasticIp", "x-api-path-slug"=>"actionregisterelasticip-get", "parameters"=>[{"in"=>"query", "name"=>"ElasticIp", "description"=>"The Elastic IP address", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "Elastic", "Ip"]}}, "/?Action=RegisterInstance"=>{"get"=>{"summary"=>"Register Instance", "description"=>"Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.", "operationId"=>"registerInstance", "x-api-path-slug"=>"actionregisterinstance-get", "parameters"=>[{"in"=>"query", "name"=>"Hostname", "description"=>"The instances hostname", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceIdentity", "description"=>"An InstanceIdentity object that contains the instances identity", "type"=>"string"}, {"in"=>"query", "name"=>"PrivateIp", "description"=>"The instances private IP address", "type"=>"string"}, {"in"=>"query", "name"=>"PublicIp", "description"=>"The instances public IP address", "type"=>"string"}, {"in"=>"query", "name"=>"RsaPublicKey", "description"=>"The instances public RSA key", "type"=>"string"}, {"in"=>"query", "name"=>"RsaPublicKeyFingerprint", "description"=>"The instances public RSA key fingerprint", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The ID of the stack that the instance is to be registered with", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "Instance"]}}, "/?Action=RegisterRdsDbInstance"=>{"get"=>{"summary"=>"Register Rds Db Instance", "description"=>"Registers an Amazon RDS instance with a stack.", "operationId"=>"registerRdsDbInstance", "x-api-path-slug"=>"actionregisterrdsdbinstance-get", "parameters"=>[{"in"=>"query", "name"=>"DbPassword", "description"=>"The database password", "type"=>"string"}, {"in"=>"query", "name"=>"DbUser", "description"=>"The databases master user name", "type"=>"string"}, {"in"=>"query", "name"=>"RdsDbInstanceArn", "description"=>"The Amazon RDS instances ARN", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "Rds", "Db", "Instance"]}}, "/?Action=RegisterVolume"=>{"get"=>{"summary"=>"Register Volume", "description"=>"Registers an Amazon EBS volume with a specified stack.", "operationId"=>"registerVolume", "x-api-path-slug"=>"actionregistervolume-get", "parameters"=>[{"in"=>"query", "name"=>"Ec2VolumeId", "description"=>"The Amazon EBS volume ID", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Register", "Volume"]}}, "/?Action=SetLoadBasedAutoScaling"=>{"get"=>{"summary"=>"Set Load Based Auto Scaling", "description"=>"Specify the load-based auto scaling configuration for a specified layer.", "operationId"=>"setLoadBasedAutoScaling", "x-api-path-slug"=>"actionsetloadbasedautoscaling-get", "parameters"=>[{"in"=>"query", "name"=>"DownScaling", "description"=>"An AutoScalingThresholds object with the downscaling threshold configuration", "type"=>"string"}, {"in"=>"query", "name"=>"Enable", "description"=>"Enables load-based auto scaling for the layer", "type"=>"string"}, {"in"=>"query", "name"=>"LayerId", "description"=>"The layer ID", "type"=>"string"}, {"in"=>"query", "name"=>"UpScaling", "description"=>"An AutoScalingThresholds object with the upscaling threshold configuration", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Load", "Based", "Auto", "Scaling"]}}, "/?Action=SetPermission"=>{"get"=>{"summary"=>"Set Permission", "description"=>"Specifies a user's permissions.", "operationId"=>"setPermission", "x-api-path-slug"=>"actionsetpermission-get", "parameters"=>[{"in"=>"query", "name"=>"AllowSsh", "description"=>"The user is allowed to use SSH to communicate with the instance", "type"=>"string"}, {"in"=>"query", "name"=>"AllowSudo", "description"=>"The user is allowed to use sudo to elevate privileges", "type"=>"string"}, {"in"=>"query", "name"=>"IamUserArn", "description"=>"The users IAM ARN", "type"=>"string"}, {"in"=>"query", "name"=>"Level", "description"=>"The users permission level, which must be set to one of the following strings", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Permission"]}}, "/?Action=SetTimeBasedAutoScaling"=>{"get"=>{"summary"=>"Set Time Based Auto Scaling", "description"=>"Specify the time-based auto scaling configuration for a specified instance.", "operationId"=>"setTimeBasedAutoScaling", "x-api-path-slug"=>"actionsettimebasedautoscaling-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingSchedule", "description"=>"An AutoScalingSchedule with the instance schedule", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Set", "Time", "Based", "Auto", "Scaling"]}}, "/?Action=StartInstance"=>{"get"=>{"summary"=>"Start Instance", "description"=>"Starts a specified instance.", "operationId"=>"startInstance", "x-api-path-slug"=>"actionstartinstance-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Start", "Instance"]}}, "/?Action=StartStack"=>{"get"=>{"summary"=>"Start Stack", "description"=>"Starts a stack's instances.", "operationId"=>"startStack", "x-api-path-slug"=>"actionstartstack-get", "parameters"=>[{"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Start", "Stack"]}}, "/?Action=StopInstance"=>{"get"=>{"summary"=>"Stop Instance", "description"=>"Stops a specified instance.", "operationId"=>"stopInstance", "x-api-path-slug"=>"actionstopinstance-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Instance"]}}, "/?Action=StopStack"=>{"get"=>{"summary"=>"Stop Stack", "description"=>"Stops a specified stack.", "operationId"=>"stopStack", "x-api-path-slug"=>"actionstopstack-get", "parameters"=>[{"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Stack"]}}, "/?Action=UnassignInstance"=>{"get"=>{"summary"=>"Unassign Instance", "description"=>"Unassigns a registered instance from all of it's layers.", "operationId"=>"unassignInstance", "x-api-path-slug"=>"actionunassigninstance-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unassign", "Instance"]}}, "/?Action=UnassignVolume"=>{"get"=>{"summary"=>"Unassign Volume", "description"=>"Unassigns an assigned Amazon EBS volume.", "operationId"=>"unassignVolume", "x-api-path-slug"=>"actionunassignvolume-get", "parameters"=>[{"in"=>"query", "name"=>"VolumeId", "description"=>"The volume ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Unassign", "Volume"]}}, "/?Action=UpdateApp"=>{"get"=>{"summary"=>"Update App", "description"=>"Updates a specified app.", "operationId"=>"updateApp", "x-api-path-slug"=>"actionupdateapp-get", "parameters"=>[{"in"=>"query", "name"=>"AppId", "description"=>"The app ID", "type"=>"string"}, {"in"=>"query", "name"=>"AppSource", "description"=>"A Source object that specifies the app repository", "type"=>"string"}, {"in"=>"query", "name"=>"Attributes", "description"=>"One or more user-defined key/value pairs to be added to the stack attributes", "type"=>"string"}, {"in"=>"query", "name"=>"DataSources", "description"=>"The apps data sources", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"A description of the app", "type"=>"string"}, {"in"=>"query", "name"=>"Domains", "description"=>"The apps virtual host settings, with multiple domains separated by commas", "type"=>"string"}, {"in"=>"query", "name"=>"EnableSsl", "description"=>"Whether SSL is enabled for the app", "type"=>"string"}, {"in"=>"query", "name"=>"Environment", "description"=>"An array of EnvironmentVariable objects that specify environment variables to be associated with the app", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The app name", "type"=>"string"}, {"in"=>"query", "name"=>"SslConfiguration", "description"=>"An SslConfiguration object with the SSL configuration", "type"=>"string"}, {"in"=>"query", "name"=>"Type", "description"=>"The app type", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["App"]}}, "/?Action=UpdateElasticIp"=>{"get"=>{"summary"=>"Update Elastic Ip", "description"=>"Updates a registered Elastic IP address's name.", "operationId"=>"updateElasticIp", "x-api-path-slug"=>"actionupdateelasticip-get", "parameters"=>[{"in"=>"query", "name"=>"ElasticIp", "description"=>"The address", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The new name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Elastic", "Ip"]}}, "/?Action=UpdateInstance"=>{"get"=>{"summary"=>"Update Instance", "description"=>"Updates a specified instance.", "operationId"=>"updateInstance", "x-api-path-slug"=>"actionupdateinstance-get", "parameters"=>[{"in"=>"query", "name"=>"AgentVersion", "description"=>"The default AWS OpsWorks Stacks agent version", "type"=>"string"}, {"in"=>"query", "name"=>"AmiId", "description"=>"The ID of the AMI that was used to create the instance", "type"=>"string"}, {"in"=>"query", "name"=>"Architecture", "description"=>"The instance architecture", "type"=>"string"}, {"in"=>"query", "name"=>"AutoScalingType", "description"=>"For load-based or time-based instances, the type", "type"=>"string"}, {"in"=>"query", "name"=>"EbsOptimized", "description"=>"This property cannot be updated", "type"=>"string"}, {"in"=>"query", "name"=>"Hostname", "description"=>"The instance host name", "type"=>"string"}, {"in"=>"query", "name"=>"InstallUpdatesOnBoot", "description"=>"Whether to install operating system and package updates when the instance boots", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceId", "description"=>"The instance ID", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceType", "description"=>"The instance type, such as t2", "type"=>"string"}, {"in"=>"query", "name"=>"LayerIds", "description"=>"The instances layer IDs", "type"=>"string"}, {"in"=>"query", "name"=>"Os", "description"=>"The instances operating system, which must be set to one of the following", "type"=>"string"}, {"in"=>"query", "name"=>"SshKeyName", "description"=>"The instances Amazon EC2 key name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/?Action=UpdateLayer"=>{"get"=>{"summary"=>"Update Layer", "description"=>"Updates a specified layer.", "operationId"=>"updateLayer", "x-api-path-slug"=>"actionupdatelayer-get", "parameters"=>[{"in"=>"query", "name"=>"Attributes", "description"=>"One or more user-defined key/value pairs to be added to the stack attributes", "type"=>"string"}, {"in"=>"query", "name"=>"AutoAssignElasticIps", "description"=>"Whether to automatically assign an Elastic IP address to the layers instances", "type"=>"string"}, {"in"=>"query", "name"=>"AutoAssignPublicIps", "description"=>"For stacks that are running in a VPC, whether to automatically assign a public IP address to the layers instances", "type"=>"string"}, {"in"=>"query", "name"=>"CustomInstanceProfileArn", "description"=>"The ARN of an IAM profile to be used for all of the layers EC2 instances", "type"=>"string"}, {"in"=>"query", "name"=>"CustomJson", "description"=>"A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layers instances", "type"=>"string"}, {"in"=>"query", "name"=>"CustomRecipes", "description"=>"A LayerCustomRecipes object that specifies the layers custom recipes", "type"=>"string"}, {"in"=>"query", "name"=>"CustomSecurityGroupIds", "description"=>"An array containing the layers custom security group IDs", "type"=>"string"}, {"in"=>"query", "name"=>"EnableAutoHealing", "description"=>"Whether to disable auto healing for the layer", "type"=>"string"}, {"in"=>"query", "name"=>"InstallUpdatesOnBoot", "description"=>"Whether to install operating system and package updates when the instance boots", "type"=>"string"}, {"in"=>"query", "name"=>"LayerId", "description"=>"The layer ID", "type"=>"string"}, {"in"=>"query", "name"=>"LifecycleEventConfiguration", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The layer name, which is used by the console", "type"=>"string"}, {"in"=>"query", "name"=>"Packages", "description"=>"An array of Package objects that describe the layers packages", "type"=>"string"}, {"in"=>"query", "name"=>"Shortname", "description"=>"For custom layers only, use this parameter to specify the layers short name, which is used internally by AWS OpsWorks Stacks and by Chef", "type"=>"string"}, {"in"=>"query", "name"=>"UseEbsOptimizedInstances", "description"=>"Whether to use Amazon EBS-optimized instances", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeConfigurations", "description"=>"A VolumeConfigurations object that describes the layers Amazon EBS volumes", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Layer"]}}, "/?Action=UpdateMyUserProfile"=>{"get"=>{"summary"=>"Update My User Profile", "description"=>"Updates a user's SSH public key.", "operationId"=>"updateMyUserProfile", "x-api-path-slug"=>"actionupdatemyuserprofile-get", "parameters"=>[{"in"=>"query", "name"=>"SshPublicKey", "description"=>"The users SSH public key", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["My", "User", "Profile"]}}, "/?Action=UpdateRdsDbInstance"=>{"get"=>{"summary"=>"Update Rds Db Instance", "description"=>"Updates an Amazon RDS instance.", "operationId"=>"updateRdsDbInstance", "x-api-path-slug"=>"actionupdaterdsdbinstance-get", "parameters"=>[{"in"=>"query", "name"=>"DbPassword", "description"=>"The database password", "type"=>"string"}, {"in"=>"query", "name"=>"DbUser", "description"=>"The master user name", "type"=>"string"}, {"in"=>"query", "name"=>"RdsDbInstanceArn", "description"=>"The Amazon RDS instances ARN", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Rds", "Db", "Instance"]}}, "/?Action=UpdateStack"=>{"get"=>{"summary"=>"Update Stack", "description"=>"Updates a specified stack.", "operationId"=>"updateStack", "x-api-path-slug"=>"actionupdatestack-get", "parameters"=>[{"in"=>"query", "name"=>"AgentVersion", "description"=>"The default AWS OpsWorks Stacks agent version", "type"=>"string"}, {"in"=>"query", "name"=>"Attributes", "description"=>"One or more user-defined key-value pairs to be added to the stack attributes", "type"=>"string"}, {"in"=>"query", "name"=>"ChefConfiguration", "description"=>"A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11", "type"=>"string"}, {"in"=>"query", "name"=>"ConfigurationManager", "description"=>"The configuration manager", "type"=>"string"}, {"in"=>"query", "name"=>"CustomCookbooksSource", "description"=>"Contains the information required to retrieve an app or cookbook from a repository", "type"=>"string"}, {"in"=>"query", "name"=>"CustomJson", "description"=>"A string that contains user-defined, custom JSON", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultAvailabilityZone", "description"=>"The stacks default Availability Zone, which must be in the stacks region", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultInstanceProfileArn", "description"=>"The ARN of an IAM profile that is the default profile for all of the stacks EC2 instances", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultOs", "description"=>"The stacks operating system, which must be set to one of the following:", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultRootDeviceType", "description"=>"The default root device type", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultSshKeyName", "description"=>"A default Amazon EC2 key-pair name", "type"=>"string"}, {"in"=>"query", "name"=>"DefaultSubnetId", "description"=>"The stacks default VPC subnet ID", "type"=>"string"}, {"in"=>"query", "name"=>"HostnameTheme", "description"=>"The stacks new host name theme, with spaces replaced by underscores", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The stacks new name", "type"=>"string"}, {"in"=>"query", "name"=>"ServiceRoleArn", "description"=>"Do not use this parameter", "type"=>"string"}, {"in"=>"query", "name"=>"StackId", "description"=>"The stack ID", "type"=>"string"}, {"in"=>"query", "name"=>"UseCustomCookbooks", "description"=>"Whether the stack uses custom cookbooks", "type"=>"string"}, {"in"=>"query", "name"=>"UseOpsworksSecurityGroups", "description"=>"Whether to associate the AWS OpsWorks Stacks built-in security groups with the stacks layers", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stack"]}}, "/?Action=UpdateUserProfile"=>{"get"=>{"summary"=>"Update User Profile", "description"=>"Updates a specified user profile.", "operationId"=>"updateUserProfile", "x-api-path-slug"=>"actionupdateuserprofile-get", "parameters"=>[{"in"=>"query", "name"=>"AllowSelfManagement", "description"=>"Whether users can specify their own SSH public key through the My Settings page", "type"=>"string"}, {"in"=>"query", "name"=>"IamUserArn", "description"=>"The user IAM ARN", "type"=>"string"}, {"in"=>"query", "name"=>"SshPublicKey", "description"=>"The users new SSH public key", "type"=>"string"}, {"in"=>"query", "name"=>"SshUsername", "description"=>"The users SSH user name", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Profile"]}}, "/?Action=UpdateVolume"=>{"get"=>{"summary"=>"Update Volume", "description"=>"Updates an Amazon EBS volume's name or mount point.", "operationId"=>"updateVolume", "x-api-path-slug"=>"actionupdatevolume-get", "parameters"=>[{"in"=>"query", "name"=>"MountPoint", "description"=>"The new mount point", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The new name", "type"=>"string"}, {"in"=>"query", "name"=>"VolumeId", "description"=>"The volume ID", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Volume"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
transport-for-london-unified{"transport-for-london-unified-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Transport for London Unified", "x-complete"=>1, "info"=>{"title"=>"Transport for London Unified", "description"=>"our-unified-api-brings-together-data-across-all-modes-of-transport-into-a-single-restful-api--this-api-provides-access-to-the-most-highly-requested-realtime-and-status-infomation-across-all-the-modes-of-transport-in-a-single-and-consistent-way--access-to-the-developer-documentation-is-available-at-httpsapi-tfl-gov-uk", "version"=>"v1"}, "host"=>"api.tfl.gov.uk", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/AccidentStats/{year}"=>{"get"=>{"summary"=>"Accent Stats year", "description"=>"Gets all accident details for accidents occuring in the specified year.", "operationId"=>"AccidentStats_Get", "x-api-path-slug"=>"accidentstatsyear-get", "parameters"=>[{"in"=>"path", "name"=>"year", "description"=>"The year for which to filter the accidents on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accent", "Stats", "Year"]}}, "/AirQuality"=>{"get"=>{"summary"=>"Air Quality", "description"=>"Gets air quality data feed.", "operationId"=>"AirQuality_Get", "x-api-path-slug"=>"airquality-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Air", "Quality"]}}, "/BikePoint"=>{"get"=>{"summary"=>"Bike Point", "description"=>"Gets all bike point locations. the place object has an addtionalproperties array which contains the nbbikes, nbdocks and nbspaces\r\n numbers which give the status of the bikepoint. a mismatch in these numbers i.e. nbdocks - (nbbikes + nbspa.", "operationId"=>"BikePoint_GetAll", "x-api-path-slug"=>"bikepoint-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bike", "Point"]}}, "/BikePoint/Search"=>{"get"=>{"summary"=>"Bike Point Search", "description"=>"Search for bike stations by their name, a bike point's name often contains information about the name of the street\r\n or nearby landmarks, for example. note that the search result does not contain the placeproperties i.e. the status\r\n .", "operationId"=>"BikePoint_Search", "x-api-path-slug"=>"bikepointsearch-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"The search term e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bike", "Point", "", "Search"]}}, "/BikePoint/{id}"=>{"get"=>{"summary"=>"Bike Point", "description"=>"Gets the bike point with the given id..", "operationId"=>"BikePoint_Get", "x-api-path-slug"=>"bikepointid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"A bike point id (a list of ids can be obtained from the above BikePoint call)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bike", "Point"]}}, "/Cabwise/search"=>{"get"=>{"summary"=>"Cabwise search", "description"=>"Gets taxis and minicabs contact information.", "operationId"=>"Cabwise_Get", "x-api-path-slug"=>"cabwisesearch-get", "parameters"=>[{"in"=>"query", "name"=>"forceXml", "description"=>"Force Xml"}, {"in"=>"query", "name"=>"lat", "description"=>"Latitude"}, {"in"=>"query", "name"=>"legacyFormat", "description"=>"Legacy Format"}, {"in"=>"query", "name"=>"lon", "description"=>"Longitude"}, {"in"=>"query", "name"=>"maxResults", "description"=>"An optional parameter to limit the number of results return"}, {"in"=>"query", "name"=>"name", "description"=>"Trading name of operating company"}, {"in"=>"query", "name"=>"optype", "description"=>"Operator Type e"}, {"in"=>"query", "name"=>"radius", "description"=>"The radius of the bounding circle in metres"}, {"in"=>"query", "name"=>"twentyFourSevenOnly", "description"=>"Twenty Four Seven Only"}, {"in"=>"query", "name"=>"wc", "description"=>"Wheelchair accessible"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cabwise", "Search"]}}, "/Journey/JourneyResults/{from}/to/{to}"=>{"get"=>{"summary"=>"Journey Journey Results from to to", "description"=>"Perform a journey planner search from the parameters specified in simple types.", "operationId"=>"Journey_JourneyResults", "x-api-path-slug"=>"journeyjourneyresultsfromtoto-get", "parameters"=>[{"in"=>"query", "name"=>"accessibilityPreference", "description"=>"The accessibility preference must be a comma separated list eg"}, {"in"=>"query", "name"=>"adjustment", "description"=>"Time adjustment command"}, {"in"=>"query", "name"=>"alternativeCycle", "description"=>"Option to determine whether to return alternative cycling journey"}, {"in"=>"query", "name"=>"alternativeWalking", "description"=>"Option to determine whether to return alternative walking journey"}, {"in"=>"query", "name"=>"applyHtmlMarkup", "description"=>"Flag to determine whether certain text (e"}, {"in"=>"query", "name"=>"bikeProficiency", "description"=>"A comma separated list of cycling proficiency levels"}, {"in"=>"query", "name"=>"cyclePreference", "description"=>"The cycle preference"}, {"in"=>"query", "name"=>"date", "description"=>"The date must be in yyyyMMdd format"}, {"in"=>"path", "name"=>"from", "description"=>"Origin of the journey"}, {"in"=>"query", "name"=>"fromName", "description"=>"An optional name to associate with the origin of the journey in the results"}, {"in"=>"query", "name"=>"journeyPreference", "description"=>"The journey preference eg possible options: leastinterchange | leasttime | leastwalking"}, {"in"=>"query", "name"=>"maxTransferMinutes", "description"=>"The max walking time in minutes for transfer eg"}, {"in"=>"query", "name"=>"maxWalkingMinutes", "description"=>"The max walking time in minutes for journeys eg"}, {"in"=>"query", "name"=>"mode", "description"=>"The mode must be a comma separated list of modes"}, {"in"=>"query", "name"=>"nationalSearch", "description"=>"Does the journey cover stops outside London? eg"}, {"in"=>"query", "name"=>"taxiOnlyTrip", "description"=>"A boolean to indicate whether to return one or more taxi journeys"}, {"in"=>"query", "name"=>"time", "description"=>"The time must be in HHmm format"}, {"in"=>"query", "name"=>"timeIs", "description"=>"Does the time given relate to arrival or leaving time? Possible options: departing | arriving"}, {"in"=>"path", "name"=>"to", "description"=>"Destination of the journey"}, {"in"=>"query", "name"=>"toName", "description"=>"An optional name to associate with the destination of the journey in the results"}, {"in"=>"query", "name"=>"useMultiModalCall", "description"=>"A boolean to indicate whether or not to return 3 public transport journeys, a bus journey, a cycle hire journey, a personal cycle journey and a walking journey"}, {"in"=>"query", "name"=>"via", "description"=>"Travel through point on the journey"}, {"in"=>"query", "name"=>"viaName", "description"=>"An optional name to associate with the via point of the journey in the results"}, {"in"=>"query", "name"=>"walkingOptimization", "description"=>"A boolean to indicate whether to optimize journeys using walking"}, {"in"=>"query", "name"=>"walkingSpeed", "description"=>"The walking speed"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Journey", "", "Journey", "Results", "From", "To", "To"]}}, "/Journey/Meta/Modes"=>{"get"=>{"summary"=>"Journey Meta Modes", "description"=>"Gets a list of all of the available journey planner modes.", "operationId"=>"Journey_Meta", "x-api-path-slug"=>"journeymetamodes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Journey", "", "Meta", "", "Modes"]}}, "/Line/Meta/DisruptionCategories"=>{"get"=>{"summary"=>"Line Meta Disruption Categories", "description"=>"Gets a list of valid disruption categories.", "operationId"=>"Line_MetaDisruptionCategories", "x-api-path-slug"=>"linemetadisruptioncategories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "", "Meta", "", "Disruption", "Categories"]}}, "/Line/Meta/Modes"=>{"get"=>{"summary"=>"Line Meta Modes", "description"=>"Gets a list of valid modes.", "operationId"=>"Line_MetaModes", "x-api-path-slug"=>"linemetamodes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "", "Meta", "", "Modes"]}}, "/Line/Meta/ServiceTypes"=>{"get"=>{"summary"=>"Line Meta Service Types", "description"=>"Gets a list of valid servicetypes to filter on.", "operationId"=>"Line_MetaServiceTypes", "x-api-path-slug"=>"linemetaservicetypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "", "Meta", "", "Service", "Types"]}}, "/Line/Meta/Severity"=>{"get"=>{"summary"=>"Line Meta Severity", "description"=>"Gets a list of valid severity codes.", "operationId"=>"Line_MetaSeverity", "x-api-path-slug"=>"linemetaseverity-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "", "Meta", "", "Severity"]}}, "/Line/Mode/{modes}"=>{"get"=>{"summary"=>"Line Mode modes", "description"=>"Gets lines that serve the given modes..", "operationId"=>"Line_GetByMode", "x-api-path-slug"=>"linemodemodes-get", "parameters"=>[{"in"=>"path", "name"=>"modes", "description"=>"A comma-separated list of modes e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "", "Mode", "Modes"]}}, "/Line/Mode/{modes}/Disruption"=>{"get"=>{"summary"=>"Line Mode modes Disruption", "description"=>"Get disruptions for all lines of the given modes..", "operationId"=>"Line_DisruptionByMode", "x-api-path-slug"=>"linemodemodesdisruption-get", "parameters"=>[{"in"=>"path", "name"=>"modes", "description"=>"A comma-separated list of modes e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "", "Mode", "Modes", "", "Disruption"]}}, "/Line/Mode/{modes}/Route"=>{"get"=>{"summary"=>"Line Mode modes Route", "description"=>"Gets all lines and their valid routes for given modes, including the name and id of the originating and terminating stops for each route.", "operationId"=>"Line_RouteByMode", "x-api-path-slug"=>"linemodemodesroute-get", "parameters"=>[{"in"=>"path", "name"=>"modes", "description"=>"A comma-separated list of modes e"}, {"in"=>"query", "name"=>"serviceTypes", "description"=>"A comma seperated list of service types to filter on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "", "Mode", "Modes", "", "Route"]}}, "/Line/Mode/{modes}/Status"=>{"get"=>{"summary"=>"Line Mode modes Status", "description"=>"Gets the line status of for all lines for the given modes.", "operationId"=>"Line_StatusByMode", "x-api-path-slug"=>"linemodemodesstatus-get", "parameters"=>[{"in"=>"query", "name"=>"detail", "description"=>"Include details of the disruptions that are causing the line status including the affected stops and routes"}, {"in"=>"path", "name"=>"modes", "description"=>"A comma-separated list of modes to filter by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "", "Mode", "Modes", "", "Status"]}}, "/Line/Route"=>{"get"=>{"summary"=>"Line Route", "description"=>"Get all valid routes for all lines, including the name and id of the originating and terminating stops for each route..", "operationId"=>"Line_Route", "x-api-path-slug"=>"lineroute-get", "parameters"=>[{"in"=>"query", "name"=>"serviceTypes", "description"=>"A comma seperated list of service types to filter on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "", "Route"]}}, "/Line/Search/{query}"=>{"get"=>{"summary"=>"Line Search query", "description"=>"Search for lines or routes matching the query string.", "operationId"=>"Line_Search", "x-api-path-slug"=>"linesearchquery-get", "parameters"=>[{"in"=>"query", "name"=>"modes", "description"=>"Optionally filter by the specified modes"}, {"in"=>"path", "name"=>"query", "description"=>"Search term e"}, {"in"=>"query", "name"=>"serviceTypes", "description"=>"A comma seperated list of service types to filter on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "", "Search", "Query"]}}, "/Line/Status/{severity}"=>{"get"=>{"summary"=>"Line Status severity", "description"=>"Gets the line status for all lines with a given severity\r\n a list of valid severity codes can be obtained from a call to line/meta/severity.", "operationId"=>"Line_StatusBySeverity", "x-api-path-slug"=>"linestatusseverity-get", "parameters"=>[{"in"=>"path", "name"=>"severity", "description"=>"The level of severity (eg: a number from 0 to 14)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "", "Status", "Severity"]}}, "/Line/{ids}"=>{"get"=>{"summary"=>"Line s", "description"=>"Gets lines that match the specified line ids..", "operationId"=>"Line_Get", "x-api-path-slug"=>"lineids-get", "parameters"=>[{"in"=>"path", "name"=>"ids", "description"=>"A comma-separated list of line ids e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "S"]}}, "/Line/{ids}/Arrivals/{stopPointId}"=>{"get"=>{"summary"=>"Line s Arrivals stop Point Id", "description"=>"Get the list of arrival predictions for given line ids based at the given stop.", "operationId"=>"Line_Arrivals", "x-api-path-slug"=>"lineidsarrivalsstoppointid-get", "parameters"=>[{"in"=>"query", "name"=>"destinationStationId", "description"=>"Optional"}, {"in"=>"query", "name"=>"direction", "description"=>"Optional"}, {"in"=>"path", "name"=>"ids", "description"=>"A comma-separated list of line ids e"}, {"in"=>"path", "name"=>"stopPointId", "description"=>"Optional"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "S", "", "Arrivals", "Stop", "Point", "Id"]}}, "/Line/{ids}/Disruption"=>{"get"=>{"summary"=>"Line s Disruption", "description"=>"Get disruptions for the given line ids.", "operationId"=>"Line_Disruption", "x-api-path-slug"=>"lineidsdisruption-get", "parameters"=>[{"in"=>"path", "name"=>"ids", "description"=>"A comma-separated list of line ids e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "S", "", "Disruption"]}}, "/Line/{ids}/Route"=>{"get"=>{"summary"=>"Line s Route", "description"=>"Get all valid routes for given line ids, including the name and id of the originating and terminating stops for each route..", "operationId"=>"Line_LineRoutesByIds", "x-api-path-slug"=>"lineidsroute-get", "parameters"=>[{"in"=>"path", "name"=>"ids", "description"=>"A comma-separated list of line ids e"}, {"in"=>"query", "name"=>"serviceTypes", "description"=>"A comma seperated list of service types to filter on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "S", "", "Route"]}}, "/Line/{ids}/Status"=>{"get"=>{"summary"=>"Line s Status", "description"=>"Gets the line status of for given line ids e.g minor delays.", "operationId"=>"Line_StatusByIds", "x-api-path-slug"=>"lineidsstatus-get", "parameters"=>[{"in"=>"query", "name"=>"detail", "description"=>"Include details of the disruptions that are causing the line status including the affected stops and routes"}, {"in"=>"path", "name"=>"ids", "description"=>"A comma-separated list of line ids e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "S", "", "Status"]}}, "/Line/{ids}/Status/{StartDate}/to/{EndDate}"=>{"get"=>{"summary"=>"Line s Status Start Date to End Date", "description"=>"Gets the line status for given line ids during the provided dates e.g minor delays.", "operationId"=>"Line_Status", "x-api-path-slug"=>"lineidsstatusstartdatetoenddate-get", "parameters"=>[{"in"=>"query", "name"=>"dateRange.endDate"}, {"in"=>"query", "name"=>"dateRange.startDate"}, {"in"=>"query", "name"=>"detail", "description"=>"Include details of the disruptions that are causing the line status including the affected stops and routes"}, {"in"=>"query", "name"=>"endDate"}, {"in"=>"path", "name"=>"EndDate"}, {"in"=>"path", "name"=>"ids", "description"=>"A comma-separated list of line ids e"}, {"in"=>"query", "name"=>"startDate"}, {"in"=>"path", "name"=>"StartDate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "S", "", "Status", "", "Start", "Date", "To", "", "End", "Date"]}}, "/Line/{id}/Route/Sequence/{direction}"=>{"get"=>{"summary"=>"Line Route Sequence direction", "description"=>"Gets all valid routes for given line id, including the sequence of stops on each route..", "operationId"=>"Line_RouteSequence", "x-api-path-slug"=>"lineidroutesequencedirection-get", "parameters"=>[{"in"=>"path", "name"=>"direction", "description"=>"The direction of travel"}, {"in"=>"query", "name"=>"excludeCrowding", "description"=>"That excludes crowding from line disruptions"}, {"in"=>"path", "name"=>"id", "description"=>"A single line id e"}, {"in"=>"query", "name"=>"serviceTypes", "description"=>"A comma seperated list of service types to filter on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "", "Route", "", "Sequence", "Direction"]}}, "/Line/{id}/StopPoints"=>{"get"=>{"summary"=>"Line Stop Points", "description"=>"Gets a list of the stations that serve the given line id.", "operationId"=>"Line_StopPoints", "x-api-path-slug"=>"lineidstoppoints-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"A single line id e"}, {"in"=>"query", "name"=>"tflOperatedNationalRailStationsOnly", "description"=>"If the national-rail line is requested, this flag will filter the national rail stations so that only those operated by TfL are returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "", "Stop", "Points"]}}, "/Line/{id}/Timetable/{fromStopPointId}"=>{"get"=>{"summary"=>"Line Timetable from Stop Point Id", "description"=>"Gets the timetable for a specified station on the give line.", "operationId"=>"Line_Timetable", "x-api-path-slug"=>"lineidtimetablefromstoppointid-get", "parameters"=>[{"in"=>"path", "name"=>"fromStopPointId", "description"=>"The originating stations stop point id (station naptan code e"}, {"in"=>"path", "name"=>"id", "description"=>"A single line id e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "", "Timetable", "From", "Stop", "Point", "Id"]}}, "/Line/{id}/Timetable/{fromStopPointId}/to/{toStopPointId}"=>{"get"=>{"summary"=>"Line Timetable from Stop Point Id to to Stop Point Id", "description"=>"Gets the timetable for a specified station on the give line with specified destination.", "operationId"=>"Line_TimetableTo", "x-api-path-slug"=>"lineidtimetablefromstoppointidtotostoppointid-get", "parameters"=>[{"in"=>"path", "name"=>"fromStopPointId", "description"=>"The originating stations stop point id (station naptan code e"}, {"in"=>"path", "name"=>"id", "description"=>"A single line id e"}, {"in"=>"path", "name"=>"toStopPointId", "description"=>"The destination stationss Naptan code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "", "Timetable", "From", "Stop", "Point", "Id", "To", "To", "Stop", "Point", "Id"]}}, "/Mode/ActiveServiceTypes"=>{"get"=>{"summary"=>"Mode Active Service Types", "description"=>"Returns the service type active for a mode.\r\n currently only supports tube.", "operationId"=>"Mode_GetActiveServiceTypes", "x-api-path-slug"=>"modeactiveservicetypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mode", "", "Active", "Service", "Types"]}}, "/Mode/{mode}/Arrivals"=>{"get"=>{"summary"=>"Mode mode Arrivals", "description"=>"Gets the next arrival predictions for all stops of a given mode.", "operationId"=>"Mode_Arrivals", "x-api-path-slug"=>"modemodearrivals-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"A number of arrivals to return for each stop, -1 to return all available"}, {"in"=>"path", "name"=>"mode", "description"=>"A mode name e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Mode", "Mode", "", "Arrivals"]}}, "/Occupancy/BikePoints/{ids}"=>{"get"=>{"summary"=>"Occupancy Bike Points s", "description"=>"Get the occupancy for bike points..", "operationId"=>"Occupancy_GetBikePointsOccupancies", "x-api-path-slug"=>"occupancybikepointsids-get", "parameters"=>[{"in"=>"path", "name"=>"ids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Occupancy", "", "Bike", "Points", "S"]}}, "/Occupancy/CarPark"=>{"get"=>{"summary"=>"Occupancy Car Park", "description"=>"Gets the occupancy for all car parks that have occupancy data.", "operationId"=>"Occupancy.CarPark.get", "x-api-path-slug"=>"occupancycarpark-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Occupancy", "", "Car", "Park"]}}, "/Occupancy/CarPark/{id}"=>{"get"=>{"summary"=>"Occupancy Car Park", "description"=>"Gets the occupancy for a car park with a given id.", "operationId"=>"Occupancy.CarPark.id.get", "x-api-path-slug"=>"occupancycarparkid-get", "parameters"=>[{"in"=>"path", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Occupancy", "", "Car", "Park"]}}, "/Occupancy/ChargeConnector"=>{"get"=>{"summary"=>"Occupancy Charge Connector", "description"=>"Gets the occupancy for all charge connectors.", "operationId"=>"Occupancy_GetAllChargeConnectorStatus", "x-api-path-slug"=>"occupancychargeconnector-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Occupancy", "", "Charge", "Connector"]}}, "/Occupancy/ChargeConnector/{ids}"=>{"get"=>{"summary"=>"Occupancy Charge Connector s", "description"=>"Gets the occupancy for a charge connectors with a given id (sourcesystemplaceid).", "operationId"=>"Occupancy_GetChargeConnectorStatus", "x-api-path-slug"=>"occupancychargeconnectorids-get", "parameters"=>[{"in"=>"path", "name"=>"ids"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Occupancy", "", "Charge", "Connector", "S"]}}, "/Place"=>{"get"=>{"summary"=>"Place", "description"=>"Gets the places that lie within the bounding box defined by the lat/lon of its north-west and south-east corners. optionally filters\r\n on type and can strip properties for a smaller payload..", "operationId"=>"Place_GetByGeoBox", "x-api-path-slug"=>"place-get", "parameters"=>[{"in"=>"query", "name"=>"activeOnly", "description"=>"An optional parameter to limit the results to active records only (Currently only the VariableMessageSign place type is supported)"}, {"in"=>"query", "name"=>"bbBoxpoints.neLat"}, {"in"=>"query", "name"=>"bbBoxpoints.neLon"}, {"in"=>"query", "name"=>"bbBoxpoints.swLat"}, {"in"=>"query", "name"=>"bbBoxpoints.swLon"}, {"in"=>"query", "name"=>"categories", "description"=>"an optional list of comma separated property categories to return in the Places property bag"}, {"in"=>"query", "name"=>"includeChildren", "description"=>"Defaults to false"}, {"in"=>"query", "name"=>"type", "description"=>"place types to filter on, or null to return all types"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place"]}}, "/Place/Address/Streets/{Postcode}"=>{"get"=>{"summary"=>"Place Address Streets Postcode", "description"=>"Gets the set of streets associated with a post code..", "operationId"=>"Place_GetStreetsByPostCode", "x-api-path-slug"=>"placeaddressstreetspostcode-get", "parameters"=>[{"in"=>"query", "name"=>"postcode"}, {"in"=>"path", "name"=>"Postcode"}, {"in"=>"query", "name"=>"postcodeInput.postcode"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "", "Ress", "", "Streets", "", "Code"]}}, "/Place/Meta/Categories"=>{"get"=>{"summary"=>"Place Meta Categories", "description"=>"Gets a list of all of the available place property categories and keys..", "operationId"=>"Place_MetaCategories", "x-api-path-slug"=>"placemetacategories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "", "Meta", "", "Categories"]}}, "/Place/Meta/PlaceTypes"=>{"get"=>{"summary"=>"Place Meta Place Types", "description"=>"Gets a list of the available types of place..", "operationId"=>"Place_MetaPlaceTypes", "x-api-path-slug"=>"placemetaplacetypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "", "Meta", "", "Place", "Types"]}}, "/Place/Search"=>{"get"=>{"summary"=>"Place Search", "description"=>"Gets all places that matches the given query.", "operationId"=>"Place_Search", "x-api-path-slug"=>"placesearch-get", "parameters"=>[{"in"=>"query", "name"=>"name", "description"=>"The name of the place, you can use the /Place/Types/{types} endpoint to get a list of places for a given type including their names"}, {"in"=>"query", "name"=>"types", "description"=>"A comma-separated list of the types to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "", "Search"]}}, "/Place/Type/{types}"=>{"get"=>{"summary"=>"Place Type types", "description"=>"Gets all places of a given type.", "operationId"=>"Place_GetByType", "x-api-path-slug"=>"placetypetypes-get", "parameters"=>[{"in"=>"query", "name"=>"activeOnly", "description"=>"An optional parameter to limit the results to active records only (Currently only the VariableMessageSign place type is supported)"}, {"in"=>"path", "name"=>"types", "description"=>"A comma-separated list of the types to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "", "Type", "Types"]}}, "/Place/{id}"=>{"get"=>{"summary"=>"Place", "description"=>"Gets the place with the given id..", "operationId"=>"Place_Get", "x-api-path-slug"=>"placeid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id of the place, you can use the /Place/Types/{types} endpoint to get a list of places for a given type including their ids"}, {"in"=>"query", "name"=>"includeChildren", "description"=>"Defaults to false"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place"]}}, "/Place/{type}/At/{Lat}/{Lon}"=>{"get"=>{"summary"=>"Place type At Lat Lon", "description"=>"Gets any places of the given type whose geography intersects the given latitude and longitude. in practice this means the place\r\n must be polygonal e.g. a boroughboundary..", "operationId"=>"Place_GetAt", "x-api-path-slug"=>"placetypeatlatlon-get", "parameters"=>[{"in"=>"query", "name"=>"lat"}, {"in"=>"path", "name"=>"Lat"}, {"in"=>"query", "name"=>"location.lat"}, {"in"=>"query", "name"=>"location.lon"}, {"in"=>"query", "name"=>"lon"}, {"in"=>"path", "name"=>"Lon"}, {"in"=>"path", "name"=>"type", "description"=>"The place type (a valid list of place types can be obtained from the /Place/Meta/placeTypes endpoint)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "Type", "", "At", "", "Lat", "", "Lon"]}}, "/Place/{type}/overlay/{z}/{Lat}/{Lon}/{width}/{height}"=>{"get"=>{"summary"=>"Place type overlay z Lat Lon wth height", "description"=>"Gets the place overlay for a given set of co-ordinates and a given width/height..", "operationId"=>"Place_GetOverlay", "x-api-path-slug"=>"placetypeoverlayzlatlonwidthheight-get", "parameters"=>[{"in"=>"path", "name"=>"height", "description"=>"The height of the requested overlay"}, {"in"=>"query", "name"=>"lat"}, {"in"=>"path", "name"=>"Lat"}, {"in"=>"query", "name"=>"location.lat"}, {"in"=>"query", "name"=>"location.lon"}, {"in"=>"query", "name"=>"lon"}, {"in"=>"path", "name"=>"Lon"}, {"in"=>"path", "name"=>"type", "description"=>"The place type (a valid list of place types can be obtained from the /Place/Meta/placeTypes endpoint)"}, {"in"=>"path", "name"=>"width", "description"=>"The width of the requested overlay"}, {"in"=>"path", "name"=>"z", "description"=>"The zoom level"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Place", "Type", "Overlay", "Z", "", "Lat", "", "Lon", "Wth", "Height"]}}, "/Road"=>{"get"=>{"summary"=>"Road", "description"=>"Gets all roads managed by tfl.", "operationId"=>"Road.get", "x-api-path-slug"=>"road-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Road"]}}, "/Road/Meta/Categories"=>{"get"=>{"summary"=>"Road Meta Categories", "description"=>"Gets a list of valid roaddisruption categories.", "operationId"=>"Road_MetaCategories", "x-api-path-slug"=>"roadmetacategories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Road", "", "Meta", "", "Categories"]}}, "/Road/Meta/Severities"=>{"get"=>{"summary"=>"Road Meta Severities", "description"=>"Gets a list of valid roaddisruption severity codes.", "operationId"=>"Road_MetaSeverities", "x-api-path-slug"=>"roadmetaseverities-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Road", "", "Meta", "", "Severities"]}}, "/Road/all/Disruption/{disruptionIds}"=>{"get"=>{"summary"=>"Road all Disruption disruption Ids", "description"=>"Gets a list of active disruptions filtered by disruption ids..", "operationId"=>"Road_DisruptionById", "x-api-path-slug"=>"roadalldisruptiondisruptionids-get", "parameters"=>[{"in"=>"path", "name"=>"disruptionIds", "description"=>"Comma-separated list of disruption identifiers to filter by"}, {"in"=>"query", "name"=>"stripContent", "description"=>"Optional, defaults to false"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Road", "", "", "Disruption", "Disruption", "Ids"]}}, "/Road/all/Street/Disruption"=>{"get"=>{"summary"=>"Road all Street Disruption", "description"=>"Gets a list of disrupted streets. if no date filters are provided, current disruptions are returned..", "operationId"=>"Road_DisruptedStreets", "x-api-path-slug"=>"roadallstreetdisruption-get", "parameters"=>[{"in"=>"query", "name"=>"endDate", "description"=>"Optional, The end time to filter on"}, {"in"=>"query", "name"=>"startDate", "description"=>"Optional, the start time to filter on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Road", "", "", "Street", "", "Disruption"]}}, "/Road/{ids}"=>{"get"=>{"summary"=>"Road s", "description"=>"Gets the road with the specified id (e.g. a1).", "operationId"=>"Road.ids.get", "x-api-path-slug"=>"roadids-get", "parameters"=>[{"in"=>"path", "name"=>"ids", "description"=>"Comma-separated list of road identifiers e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Road", "S"]}}, "/Road/{ids}/Disruption"=>{"get"=>{"summary"=>"Road s Disruption", "description"=>"Get active disruptions, filtered by road ids.", "operationId"=>"Road_Disruption", "x-api-path-slug"=>"roadidsdisruption-get", "parameters"=>[{"in"=>"query", "name"=>"categories", "description"=>"an optional list of category names to filter on (a valid list of categories can be obtained from the /Road/Meta/categories endpoint)"}, {"in"=>"query", "name"=>"closures", "description"=>"Optional, defaults to true"}, {"in"=>"path", "name"=>"ids", "description"=>"Comma-separated list of road identifiers e"}, {"in"=>"query", "name"=>"severities", "description"=>"an optional list of Severity names to filter on (a valid list of severities can be obtained from the /Road/Meta/severities endpoint)"}, {"in"=>"query", "name"=>"stripContent", "description"=>"Optional, defaults to false"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Road", "S", "", "Disruption"]}}, "/Road/{ids}/Status"=>{"get"=>{"summary"=>"Road s Status", "description"=>"Gets the specified roads with the status aggregated over the date range specified, or now until the end of today if no dates are passed..", "operationId"=>"Road_Status", "x-api-path-slug"=>"roadidsstatus-get", "parameters"=>[{"in"=>"query", "name"=>"dateRangeNullable.endDate"}, {"in"=>"query", "name"=>"dateRangeNullable.startDate"}, {"in"=>"path", "name"=>"ids", "description"=>"Comma-separated list of road identifiers e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Road", "S", "", "Status"]}}, "/Search"=>{"get"=>{"summary"=>"Search", "description"=>"Search the site for occurrences of the query string. the maximum number of results returned is equal to the maximum page size\r\n of 100. to return subsequent pages, use the paginated overload..", "operationId"=>"Search_Get", "x-api-path-slug"=>"search-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"The search query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search"]}}, "/Search/BusSchedules"=>{"get"=>{"summary"=>"Search Bus Schedules", "description"=>"Searches the bus schedules folder on s3 for a given bus number..", "operationId"=>"Search_BusSchedules", "x-api-path-slug"=>"searchbusschedules-get", "parameters"=>[{"in"=>"query", "name"=>"query", "description"=>"The search query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "", "Bus", "Schedules"]}}, "/Search/Meta/Categories"=>{"get"=>{"summary"=>"Search Meta Categories", "description"=>"Gets the available search categories..", "operationId"=>"Search_MetaCategories", "x-api-path-slug"=>"searchmetacategories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "", "Meta", "", "Categories"]}}, "/Search/Meta/SearchProviders"=>{"get"=>{"summary"=>"Search Meta Search Provers", "description"=>"Gets the available searchprovider names..", "operationId"=>"Search_MetaSearchProviders", "x-api-path-slug"=>"searchmetasearchproviders-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "", "Meta", "", "Search", "Provers"]}}, "/Search/Meta/Sorts"=>{"get"=>{"summary"=>"Search Meta Sorts", "description"=>"Gets the available sorting options..", "operationId"=>"Search_MetaSorts", "x-api-path-slug"=>"searchmetasorts-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Search", "", "Meta", "", "Sorts"]}}, "/StopPoint"=>{"get"=>{"summary"=>"Stop Point", "description"=>"Gets a list of stoppoints within {radius} by the specified criteria.", "operationId"=>"StopPoint_GetByGeoPoint", "x-api-path-slug"=>"stoppoint-get", "parameters"=>[{"in"=>"query", "name"=>"categories", "description"=>"an optional list of comma separated property categories to return in the StopPoints property bag"}, {"in"=>"query", "name"=>"location.lat"}, {"in"=>"query", "name"=>"location.lon"}, {"in"=>"query", "name"=>"modes", "description"=>"the list of modes to search (comma separated mode names e"}, {"in"=>"query", "name"=>"radius", "description"=>"the radius of the bounding circle in metres (default : 200)"}, {"in"=>"query", "name"=>"returnLines", "description"=>"true to return the lines that each stop point serves as a nested resource"}, {"in"=>"query", "name"=>"stopTypes", "description"=>"a list of stopTypes that should be returned (a list of valid stop types can be obtained from the StopPoint/meta/stoptypes endpoint)"}, {"in"=>"query", "name"=>"useStopPointHierarchy", "description"=>"Re-arrange the output into a parent/child hierarchy"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point"]}}, "/StopPoint/Meta/Categories"=>{"get"=>{"summary"=>"Stop Point Meta Categories", "description"=>"Gets the list of available stoppoint additional information categories.", "operationId"=>"StopPoint_MetaCategories", "x-api-path-slug"=>"stoppointmetacategories-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "", "Meta", "", "Categories"]}}, "/StopPoint/Meta/Modes"=>{"get"=>{"summary"=>"Stop Point Meta Modes", "description"=>"Gets the list of available stoppoint modes.", "operationId"=>"StopPoint_MetaModes", "x-api-path-slug"=>"stoppointmetamodes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "", "Meta", "", "Modes"]}}, "/StopPoint/Meta/StopTypes"=>{"get"=>{"summary"=>"Stop Point Meta Stop Types", "description"=>"Gets the list of available stoppoint types.", "operationId"=>"StopPoint_MetaStopTypes", "x-api-path-slug"=>"stoppointmetastoptypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "", "Meta", "", "Stop", "Types"]}}, "/StopPoint/Mode/{modes}"=>{"get"=>{"summary"=>"Stop Point Mode modes", "description"=>"Gets a list of stoppoints filtered by the modes available at that stoppoint..", "operationId"=>"StopPoint_GetByMode", "x-api-path-slug"=>"stoppointmodemodes-get", "parameters"=>[{"in"=>"path", "name"=>"modes", "description"=>"A comma-seperated list of modes e"}, {"in"=>"query", "name"=>"page", "description"=>"The data set page to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "", "Mode", "Modes"]}}, "/StopPoint/Mode/{modes}/Disruption"=>{"get"=>{"summary"=>"Stop Point Mode modes Disruption", "description"=>"Gets a distinct list of disrupted stop points for the given modes.", "operationId"=>"StopPoint_DisruptionByMode", "x-api-path-slug"=>"stoppointmodemodesdisruption-get", "parameters"=>[{"in"=>"query", "name"=>"includeRouteBlockedStops"}, {"in"=>"path", "name"=>"modes", "description"=>"A comma-seperated list of modes e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "", "Mode", "Modes", "", "Disruption"]}}, "/StopPoint/Search"=>{"get"=>{"summary"=>"Stop Point Search", "description"=>"Search stoppoints by their common name, or their 5-digit countdown bus stop code..", "operationId"=>"StopPoint.Search.get", "x-api-path-slug"=>"stoppointsearch-get", "parameters"=>[{"in"=>"query", "name"=>"faresOnly", "description"=>"True to only return stations in that have Fares data available for single fares to another station"}, {"in"=>"query", "name"=>"includeHubs", "description"=>"If true, returns results including HUBs"}, {"in"=>"query", "name"=>"lines", "description"=>"An optional, parameter separated list of the lines to filter by"}, {"in"=>"query", "name"=>"maxResults", "description"=>"An optional result limit, defaulting to and with a maximum of 50"}, {"in"=>"query", "name"=>"modes", "description"=>"An optional, parameter separated list of the modes to filter by"}, {"in"=>"query", "name"=>"query", "description"=>"The query string, case-insensitive"}, {"in"=>"query", "name"=>"tflOperatedNationalRailStationsOnly", "description"=>"If the national-rail mode is included, this flag will filter the national rail stations so that only those operated by TfL are returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "", "Search"]}}, "/StopPoint/Search/{query}"=>{"get"=>{"summary"=>"Stop Point Search query", "description"=>"Search stoppoints by their common name, or their 5-digit countdown bus stop code..", "operationId"=>"StopPoint.Search.query.get", "x-api-path-slug"=>"stoppointsearchquery-get", "parameters"=>[{"in"=>"query", "name"=>"faresOnly", "description"=>"True to only return stations in that have Fares data available for single fares to another station"}, {"in"=>"query", "name"=>"includeHubs", "description"=>"If true, returns results including HUBs"}, {"in"=>"query", "name"=>"lines", "description"=>"An optional, parameter separated list of the lines to filter by"}, {"in"=>"query", "name"=>"maxResults", "description"=>"An optional result limit, defaulting to and with a maximum of 50"}, {"in"=>"query", "name"=>"modes", "description"=>"An optional, parameter separated list of the modes to filter by"}, {"in"=>"path", "name"=>"query", "description"=>"The query string, case-insensitive"}, {"in"=>"query", "name"=>"tflOperatedNationalRailStationsOnly", "description"=>"If the national-rail mode is included, this flag will filter the national rail stations so that only those operated by TfL are returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "", "Search", "Query"]}}, "/StopPoint/ServiceTypes"=>{"get"=>{"summary"=>"Stop Point Service Types", "description"=>"Gets the service types for a given stoppoint.", "operationId"=>"StopPoint_GetServiceTypes", "x-api-path-slug"=>"stoppointservicetypes-get", "parameters"=>[{"in"=>"query", "name"=>"id", "description"=>"The Naptan id of the stop"}, {"in"=>"query", "name"=>"lineIds", "description"=>"The lines which contain the given Naptan id (all lines relevant to the given stoppoint if empty)"}, {"in"=>"query", "name"=>"modes", "description"=>"The modes which the lines are relevant to (all if empty)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "", "Service", "Types"]}}, "/StopPoint/Sms/{id}"=>{"get"=>{"summary"=>"Stop Point Sms", "description"=>"Gets a stoppoint for a given sms code..", "operationId"=>"StopPoint_GetBySms", "x-api-path-slug"=>"stoppointsmsid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"A 5-digit Countdown Bus Stop Code e"}, {"in"=>"query", "name"=>"output", "description"=>"If set to web, a 302 redirect to relevant website bus stop page is returned"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "", "Sms"]}}, "/StopPoint/Type/{types}"=>{"get"=>{"summary"=>"Stop Point Type types", "description"=>"Gets all stop points of a given type.", "operationId"=>"StopPoint_GetByType", "x-api-path-slug"=>"stoppointtypetypes-get", "parameters"=>[{"in"=>"path", "name"=>"types", "description"=>"A comma-separated list of the types to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "", "Type", "Types"]}}, "/StopPoint/{ids}"=>{"get"=>{"summary"=>"Stop Point s", "description"=>"Gets a list of stoppoints corresponding to the given list of stop ids..", "operationId"=>"StopPoint.ids.get", "x-api-path-slug"=>"stoppointids-get", "parameters"=>[{"in"=>"path", "name"=>"ids", "description"=>"A comma-separated list of stop point ids (station naptan code e"}, {"in"=>"query", "name"=>"includeCrowdingData", "description"=>"Include the crowding data (static)"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "S"]}}, "/StopPoint/{ids}/Disruption"=>{"get"=>{"summary"=>"Stop Point s Disruption", "description"=>"Gets all disruptions for the specified stoppointid, plus disruptions for any child naptan records it may have..", "operationId"=>"StopPoint_Disruption", "x-api-path-slug"=>"stoppointidsdisruption-get", "parameters"=>[{"in"=>"query", "name"=>"flattenResponse", "description"=>"Specify true to associate all disruptions with parent stop point"}, {"in"=>"query", "name"=>"getFamily", "description"=>"Specify true to return disruptions for entire family, or false to return disruptions for just this stop point"}, {"in"=>"path", "name"=>"ids", "description"=>"A comma-seperated list of stop point ids"}, {"in"=>"query", "name"=>"includeRouteBlockedStops"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "S", "", "Disruption"]}}, "/StopPoint/{id}/Arrivals"=>{"get"=>{"summary"=>"Stop Point Arrivals", "description"=>"Gets the list of arrival predictions for the given stop point id.", "operationId"=>"StopPoint_Arrivals", "x-api-path-slug"=>"stoppointidarrivals-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"A StopPoint id (station naptan code e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "", "Arrivals"]}}, "/StopPoint/{id}/CanReachOnLine/{lineId}"=>{"get"=>{"summary"=>"Stop Point Can Reach On Line line Id", "description"=>"Gets stopoints that are reachable from a station/line combination..", "operationId"=>"StopPoint_ReachableFrom", "x-api-path-slug"=>"stoppointidcanreachonlinelineid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The id (station naptan code e"}, {"in"=>"path", "name"=>"lineId", "description"=>"Line id of the line to filter by (e"}, {"in"=>"query", "name"=>"serviceTypes", "description"=>"A comma-separated list of service types to filter on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "", "Can", "Reach", "On", "Line", "Line", "Id"]}}, "/StopPoint/{id}/Crowding/{line}"=>{"get"=>{"summary"=>"Stop Point Crowding line", "description"=>"Gets all the crowding data (static) for the stoppointid, plus crowding data for a given line and optionally a particular direction..", "operationId"=>"StopPoint_Crowding", "x-api-path-slug"=>"stoppointidcrowdingline-get", "parameters"=>[{"in"=>"query", "name"=>"direction", "description"=>"The direction of travel"}, {"in"=>"path", "name"=>"id", "description"=>"The Naptan id of the stop"}, {"in"=>"path", "name"=>"line", "description"=>"A particular line e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "", "Crowding", "Line"]}}, "/StopPoint/{id}/DirectionTo/{toStopPointId}"=>{"get"=>{"summary"=>"Stop Point Direction To to Stop Point Id", "description"=>"Returns the canonical direction, \"inbound\" or \"outbound\", for a given pair of stop point ids in the direction from -> to..", "operationId"=>"StopPoint_Direction", "x-api-path-slug"=>"stoppointiddirectiontotostoppointid-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"Originating stop id (station naptan code e"}, {"in"=>"query", "name"=>"lineId", "description"=>"Optional line id filter e"}, {"in"=>"path", "name"=>"toStopPointId", "description"=>"Destination stop id (station naptan code e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "", "Direction", "To", "Stop", "Point", "Id"]}}, "/StopPoint/{id}/Route"=>{"get"=>{"summary"=>"Stop Point Route", "description"=>"Returns the route sections for all the lines that service the given stop point ids.", "operationId"=>"StopPoint_Route", "x-api-path-slug"=>"stoppointidroute-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"A stop point id (station naptan codes e"}, {"in"=>"query", "name"=>"serviceTypes", "description"=>"A comma-separated list of service types to filter on"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "", "Route"]}}, "/StopPoint/{id}/placeTypes"=>{"get"=>{"summary"=>"Stop Point place Types", "description"=>"Get a list of places corresponding to a given id and place types..", "operationId"=>"StopPoint.id.placeTypes.get", "x-api-path-slug"=>"stoppointidplacetypes-get", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"A naptan id for a stop point (station naptan code e"}, {"in"=>"query", "name"=>"placeTypes", "description"=>"A comcomma-separated value representing the place types"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "Place", "Types"]}}, "/StopPoint/{stopPointId}/CarParks"=>{"get"=>{"summary"=>"Stop Point stop Point Id Car Parks", "description"=>"Get car parks corresponding to the given stop point id..", "operationId"=>"StopPoint_GetCarParksById", "x-api-path-slug"=>"stoppointstoppointidcarparks-get", "parameters"=>[{"in"=>"path", "name"=>"stopPointId", "description"=>"stopPointId is required to get the car parks"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "Stop", "Point", "Id", "", "Car", "Parks"]}}, "/StopPoint/{stopPointId}/TaxiRanks"=>{"get"=>{"summary"=>"Stop Point stop Point Id Taxi Ranks", "description"=>"Gets a list of taxi ranks corresponding to the given stop point id..", "operationId"=>"StopPoint_GetTaxiRanksByIds", "x-api-path-slug"=>"stoppointstoppointidtaxiranks-get", "parameters"=>[{"in"=>"path", "name"=>"stopPointId", "description"=>"stopPointId is required to get the taxi ranks"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Stop", "Point", "Stop", "Point", "Id", "", "Taxi", "Ranks"]}}, "/TravelTimes/compareOverlay/{z}/mapcenter/{mapCenterLat}/{mapCenterLon}/pinlocation/{pinLat}/{pinLon}/dimensions/{width}/{height}"=>{"get"=>{"summary"=>"Travel Times compare Overlay z mapcenter map Center Lat map Center Lon pinlocation pin Lat pin Lon dimensions wth height", "description"=>"Gets the traveltime overlay..", "operationId"=>"TravelTime_GetCompareOverlay", "x-api-path-slug"=>"traveltimescompareoverlayzmapcentermapcenterlatmapcenterlonpinlocationpinlatpinlondimensionswidthheight-get", "parameters"=>[{"in"=>"query", "name"=>"compareType"}, {"in"=>"query", "name"=>"compareValue"}, {"in"=>"query", "name"=>"direction", "description"=>"The direction of travel"}, {"in"=>"path", "name"=>"height", "description"=>"The height of the requested overlay"}, {"in"=>"path", "name"=>"mapCenterLat", "description"=>"The map center latitude"}, {"in"=>"path", "name"=>"mapCenterLon", "description"=>"The map center longitude"}, {"in"=>"query", "name"=>"modeId", "description"=>"The id of the mode"}, {"in"=>"path", "name"=>"pinLat", "description"=>"The latitude of the pin"}, {"in"=>"path", "name"=>"pinLon", "description"=>"The longitude of the pin"}, {"in"=>"query", "name"=>"scenarioTitle", "description"=>"The title of the scenario"}, {"in"=>"query", "name"=>"timeOfDayId", "description"=>"The id for the time of day (AM/INTER/PM)"}, {"in"=>"query", "name"=>"travelTimeInterval", "description"=>"The total minutes between the travel time bands"}, {"in"=>"path", "name"=>"width", "description"=>"The width of the requested overlay"}, {"in"=>"path", "name"=>"z", "description"=>"The zoom level"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Times", "Compare", "Overlay", "Z", "Mapcenter", "Map", "Center", "Lat", "Map", "Center", "Lon", "Pinlocation", "Pin", "Lat", "Pin", "Lon", "Dimensions", "Wth", "Height"]}}, "/TravelTimes/overlay/{z}/mapcenter/{mapCenterLat}/{mapCenterLon}/pinlocation/{pinLat}/{pinLon}/dimensions/{width}/{height}"=>{"get"=>{"summary"=>"Travel Times overlay z mapcenter map Center Lat map Center Lon pinlocation pin Lat pin Lon dimensions wth height", "description"=>"Gets the traveltime overlay..", "operationId"=>"TravelTime_GetOverlay", "x-api-path-slug"=>"traveltimesoverlayzmapcentermapcenterlatmapcenterlonpinlocationpinlatpinlondimensionswidthheight-get", "parameters"=>[{"in"=>"query", "name"=>"direction", "description"=>"The direction of travel"}, {"in"=>"path", "name"=>"height", "description"=>"The height of the requested overlay"}, {"in"=>"path", "name"=>"mapCenterLat", "description"=>"The map center latitude"}, {"in"=>"path", "name"=>"mapCenterLon", "description"=>"The map center longitude"}, {"in"=>"query", "name"=>"modeId", "description"=>"The id of the mode"}, {"in"=>"path", "name"=>"pinLat", "description"=>"The latitude of the pin"}, {"in"=>"path", "name"=>"pinLon", "description"=>"The longitude of the pin"}, {"in"=>"query", "name"=>"scenarioTitle", "description"=>"The title of the scenario"}, {"in"=>"query", "name"=>"timeOfDayId", "description"=>"The id for the time of day (AM/INTER/PM)"}, {"in"=>"query", "name"=>"travelTimeInterval", "description"=>"The total minutes between the travel time bands"}, {"in"=>"path", "name"=>"width", "description"=>"The width of the requested overlay"}, {"in"=>"path", "name"=>"z", "description"=>"The zoom level"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Travel", "Times", "Overlay", "Z", "Mapcenter", "Map", "Center", "Lat", "Map", "Center", "Lon", "Pinlocation", "Pin", "Lat", "Pin", "Lon", "Dimensions", "Wth", "Height"]}}, "/Vehicle/EmissionSurcharge"=>{"get"=>{"summary"=>"Vehicle Emission Surcharge", "description"=>"Gets the emissions surcharge compliance for the vehicle.", "operationId"=>"Vehicle_GetEmissionsSurchargeCompliance", "x-api-path-slug"=>"vehicleemissionsurcharge-get", "parameters"=>[{"in"=>"query", "name"=>"vrm", "description"=>"The Vehicle Registration Mark"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vehicle", "", "Emission", "Surcharge"]}}, "/Vehicle/UlezCompliance"=>{"get"=>{"summary"=>"Vehicle Ulez Compliance", "description"=>"Gets the ulez surcharge compliance for the vehicle.", "operationId"=>"Vehicle_GetUlezCompliance", "x-api-path-slug"=>"vehicleulezcompliance-get", "parameters"=>[{"in"=>"query", "name"=>"vrm", "description"=>"The Vehicle Registration Mark"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vehicle", "", "Ulez", "Compliance"]}}, "/Vehicle/{ids}/Arrivals"=>{"get"=>{"summary"=>"Vehicle s Arrivals", "description"=>"Gets the predictions for a given list of vehicle id's..", "operationId"=>"Vehicle_Get", "x-api-path-slug"=>"vehicleidsarrivals-get", "parameters"=>[{"in"=>"path", "name"=>"ids", "description"=>"A comma-separated list of vehicle ids e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Vehicle", "S", "", "Arrivals"]}}, "/Line/{ids}/Arrivals"=>{"get"=>{"summary"=>"Line s Arrivals", "description"=>"Get the list of arrival predictions for given line ids based at the given stop.", "operationId"=>"", "x-api-path-slug"=>"lineidsarrivals-get", "parameters"=>[{"in"=>"path", "name"=>"ids", "description"=>"A comma-separated list of line ids e"}, {"in"=>"query", "name"=>"stopPointId", "description"=>"Id of stop to get arrival predictions for (station naptan code e"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Line", "S", "", "Arrivals"]}}}}, "apis"=>{"name"=>"Transport for London Unified", "x-slug"=>"transport-for-london-unified", "description"=>"We are the integrated transport authority responsible for delivering Mayor of London Sadiq Khans strategy and commitments on transport. We run the day-to-day operation of the Capitals public transport network and manage Londons main roads.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/transport-for-london-unified-api.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"General Data,Service API,Transit,Transportation", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"transport-for-london-unified/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Transport for London Unified", "x-api-slug"=>"transport-for-london-unified", "description"=>"We are the integrated transport authority responsible for delivering Mayor of London Sadiq Khans strategy and commitments on transport. We run the day-to-day operation of the Capitals public transport network and manage Londons main roads.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/transport-for-london-unified-api.png", "humanURL"=>"https://tfl.gov.uk/", "baseURL"=>"https://api.tfl.gov.uk//", "tags"=>"General Data,Service API,Transit,Transportation", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/transport-for-london-unified/lineidsarrivals-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/transport-for-london-unified/transport-for-london-unified-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-developer", "url"=>"http://api.tfl.gov.uk"}, {"type"=>"x-website", "url"=>"https://tfl.gov.uk/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
uservoice{"apis"=>{"name"=>"UserVoice", "x-slug"=>"uservoice", "description"=>"Product management software that transforms how businesses capture and analyze feedback to prioritize the roadmap and make strategic product decisions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/86-uservoice.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"5638", "tags"=>"Customers,Feedback,Forum STack,Forums,Forums,Help Desk,Relative Data,SaaS,Service API,Stack Network,Support,Support,Support,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"uservoice/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"The Noun Project User API", "x-api-slug"=>"the-noun-project-user-api", "description"=>"Product management software that transforms how businesses capture and analyze feedback to prioritize the roadmap and make strategic product decisions.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/86-uservoice.jpg", "humanURL"=>"https://uservoice.com/", "baseURL"=>":///user/http://api.thenounproject.com", "tags"=>"Customers,Feedback,Forum STack,Forums,Forums,Help Desk,Relative Data,SaaS,Service API,Stack Network,Support,Support,Support,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/uservoice/useruser-idcollectionsslug-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/uservoice/the-noun-project-user-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://uservoice.com/api/"}, {"type"=>"x-blog", "url"=>"https://community.uservoice.com/blog/"}, {"type"=>"x-blog-rss", "url"=>"http://feeds.feedburner.com/UnderstandingYourCustomers"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/uservoice"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/uservoice"}, {"type"=>"x-developer", "url"=>"https://developer.uservoice.com/"}, {"type"=>"x-email", "url"=>"privacy@uservoice.com"}, {"type"=>"x-github", "url"=>"https://github.com/marcusnelson"}, {"type"=>"x-github", "url"=>"https://github.com/uservoice"}, {"type"=>"x-pricing", "url"=>"https://www.uservoice.com/plans/product-management/"}, {"type"=>"x-pricing", "url"=>"https://www.uservoice.com/plans/customer-support/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/uservoice"}, {"type"=>"x-website", "url"=>"https://uservoice.com/"}, {"type"=>"x-website", "url"=>"http:///user"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "the-noun-project-user-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"UserVoice", "x-complete"=>1, "info"=>{"title"=>"The Noun Project User API", "version"=>"1.0.0"}, "host"=>"/user", "basePath"=>"http://api.thenounproject.com", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/user/{username}/uploads"=>{"get"=>{"summary"=>"Get user uploads with user", "description"=>"Returns a list of uploads associated with a user", "operationId"=>"getUserUploadsWithUser", "x-api-path-slug"=>"userusernameuploads-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of results"}, {"in"=>"query", "name"=>"offset", "description"=>"Number of results to displace or skip over"}, {"in"=>"query", "name"=>"page", "description"=>"Number of results of limit length to displace or skip over"}, {"in"=>"path", "name"=>"username", "description"=>"Username"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "Username", "Uploads"]}}, "/user/{user_id}/collections"=>{"get"=>{"summary"=>"Get user collections", "description"=>"Returns a list of collections associated with a user", "operationId"=>"getUserCollections", "x-api-path-slug"=>"useruser-idcollections-get", "parameters"=>[{"in"=>"path", "name"=>"user_id", "description"=>"User id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id", "Collections"]}}, "/user/{user_id}/collections/{slug}"=>{"get"=>{"summary"=>"Get user collection", "description"=>"Returns a single collection associated with a user", "operationId"=>"getUserCollection", "x-api-path-slug"=>"useruser-idcollectionsslug-get", "parameters"=>[{"in"=>"path", "name"=>"slug", "description"=>"Collection slug"}, {"in"=>"path", "name"=>"user_id", "description"=>"User id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User", "User", "Id", "Collections", "Slug"]}}}}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-search{"azure-search-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Search", "x-complete"=>1, "info"=>{"title"=>"SearchManagementClient", "description"=>"client-that-can-be-used-to-manage-azure-search-services-and-api-keys-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys"=>{"post"=>{"summary"=>"Admin Keys Get", "description"=>"Gets the primary and secondary admin API keys for the specified Azure Search service.", "operationId"=>"AdminKeys_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-searchsearchservicessearchservicenamelistadminkeys-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}"=>{"post"=>{"summary"=>"Admin Keys Regenerate", "description"=>"Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.", "operationId"=>"AdminKeys_Regenerate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-searchsearchservicessearchservicenameregenerateadminkeykeykind-post", "parameters"=>[{"in"=>"path", "name"=>"keyKind", "description"=>"Specifies which key to regenerate"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Admin Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}"=>{"post"=>{"summary"=>"Query Keys Create", "description"=>"Generates a new query key for the specified Search service. You can create up to 50 query keys per service.", "operationId"=>"QueryKeys_Create", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-searchsearchservicessearchservicenamecreatequerykeyname-post", "parameters"=>[{"in"=>"path", "name"=>"name", "description"=>"The name of the new query API key"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Query Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys"=>{"get"=>{"summary"=>"Query Keys List By Search Service", "description"=>"Returns the list of query API keys for the given Azure Search service.", "operationId"=>"QueryKeys_ListBySearchService", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-searchsearchservicessearchservicenamelistquerykeys-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Query Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key}"=>{"delete"=>{"summary"=>"Query Keys Delete", "description"=>"Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.", "operationId"=>"QueryKeys_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-searchsearchservicessearchservicenamedeletequerykeykey-delete", "parameters"=>[{"in"=>"path", "name"=>"key", "description"=>"The query key to be deleted"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Query Keys"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}"=>{"put"=>{"summary"=>"Services Create Or Update", "description"=>"Creates or updates a Search service in the given resource group. If the Search service already exists, all properties will be updated with the given values.", "operationId"=>"Services_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-searchsearchservicessearchservicename-put", "parameters"=>[{"in"=>"path", "name"=>"searchServiceName", "description"=>"The name of the Azure Search service to create or update"}, {"in"=>"body", "name"=>"service", "description"=>"The definition of the Search service to create or update", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}, "get"=>{"summary"=>"Services Get", "description"=>"Gets the Search service with the given name in the given resource group.", "operationId"=>"Services_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-searchsearchservicessearchservicename-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}, "delete"=>{"summary"=>"Services Delete", "description"=>"Deletes a Search service in the given resource group, along with its associated resources.", "operationId"=>"Services_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-searchsearchservicessearchservicename-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices"=>{"get"=>{"summary"=>"Services List By Resource Group", "description"=>"Gets a list of all Search services in the given resource group.", "operationId"=>"Services_ListByResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-searchsearchservices-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Services Resource Group"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability"=>{"post"=>{"summary"=>"Services Check Name Availability", "description"=>"Checks whether or not the given Search service name is available for use. Search service names must be globally unique since they are part of the service URI (https:// |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
san-francisco-california-311{"san-francisco-california-311-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"San Francisco California 311", "x-complete"=>1, "info"=>{"title"=>"San Francisco CA Open311 GeoReport API", "description"=>"open311-allows-you-to-getpost-civic-information-of-cities-via-a-unified-interface--the-georeport-part-allows-you-to-submit-and-view-issues-at-the-public-local-space", "termsOfService"=>"(depends on server instance for example NYC http://dev.cityofchicago.org/docs/api/tos)", "contact"=>{"name"=>"Open311 community", "url"=>"http://wiki.open311.org/GeoReport_v2/", "email"=>"discuss@lists.open311.org"}, "version"=>"1.0.0"}, "host"=>"mobile311.sfgov.org", "basePath"=>"/open311/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/requests.{response_format}"=>{"get"=>{"summary"=>"Requests", "description"=>"Query the current status of multiple requests.", "operationId"=>"query-the-current-status-of-multiple-requests", "x-api-path-slug"=>"requests-response-format-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"Latest datetime to include in search"}, {"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON format", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"service_code", "description"=>"Specify the service type by calling the unique ID of the service_code"}, {"in"=>"query", "name"=>"service_request_id", "description"=>"To call multiple Service Requests at once, multiple service_request_id can be declared; comma delimited"}, {"in"=>"query", "name"=>"start_date", "description"=>"Earliest datetime to include in search"}, {"in"=>"query", "name"=>"status", "description"=>"Allows one to search for requests which have a specific status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Requests"]}, "post"=>{"summary"=>"Create Service Request", "description"=>"Submit a new request for with specific details of a single service. Must provide a location via lat/long or address_string or address_id", "operationId"=>"submit-a-new-request-for-with-specific-details-of-a-single-service-must-provide-a-location-via-latlo", "x-api-path-slug"=>"requests-response-format-post", "parameters"=>[{"in"=>"query", "name"=>"address_id"}, {"in"=>"query", "name"=>"address_string"}, {"in"=>"query", "name"=>"attribute", "description"=>"array of key/value responses based on Service Definitions"}, {"in"=>"query", "name"=>"lat", "description"=>"WGS-84 latitude"}, {"in"=>"query", "name"=>"long", "description"=>"WGS-84 longitude"}, {"in"=>"path", "name"=>"response_format", "description"=>"Response in XML or JSON format", "type"=>"string", "format"=>"string"}, {"in"=>"query", "name"=>"service_code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Service", "Request"]}}, "/request/{service_request_id}.{response_format}"=>{"get"=>{"summary"=>"Current Status", "description"=>"Query the current status of an individual request", "operationId"=>"query-the-current-status-of-an-individual-request", "x-api-path-slug"=>"requestservice-request-id-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"service_request_id", "description"=>"Is specified in the main URL path rather than an added query string parameter"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Current", "Status"]}}, "/services.{response_format}"=>{"get"=>{"summary"=>"Service Types", "description"=>"List acceptable service request types and their associated service codes. These request types can be unique to the city/jurisdiction.", "operationId"=>"list-acceptable-service-request-types-and-their-associated-service-codes-these-request-types-can-be-", "x-api-path-slug"=>"services-response-format-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Service", "Types"]}}, "/services/{service_code}.{response_format}"=>{"get"=>{"summary"=>"(extended) Definition Of A Service Type", "description"=>"Define attributes associated with a service code. These attributes can be unique to the city/jurisdiction.", "operationId"=>"define-attributes-associated-with-a-service-code-these-attributes-can-be-unique-to-the-cityjurisdict", "x-api-path-slug"=>"servicesservice-code-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"service_code"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "(extended)", "Definition", "Service", "Type"]}}, "/tokens/{token_id}.{response_format}"=>{"get"=>{"summary"=>"Id Of Service_request Via Token", "description"=>"Get the service_request_id from a temporary token. This is unnecessary if the response from creating a service request does not contain a token.", "operationId"=>"get-the-service-request-id-from-a-temporary-token-this-is-unnecessary-if-the-response-from-creating-", "x-api-path-slug"=>"tokenstoken-id-response-format-get", "parameters"=>[{"in"=>"path", "name"=>"token_id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["311", "Id", "Service", "Request", "Via", "Token"]}}}}, "apis"=>{"name"=>"San Francisco California 311", "x-slug"=>"san-francisco-california-311", "description"=>"The 311 service for the City of San Francisco, California.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/vzN3Pt2u_400x400.png", "x-kinRank"=>"7", "x-alexaRank"=>"0", "tags"=>"311,Open311,Streams,Streams", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"san-francisco-california-311/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"San Francisco California 311", "x-api-slug"=>"san-francisco-california-311", "description"=>"The 311 service for the City of San Francisco, California.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/vzN3Pt2u_400x400.png", "humanURL"=>"http://ouc.dc.gov", "baseURL"=>"https://mobile311.sfgov.org//open311/v2/", "tags"=>"311,Open311,Streams,Streams", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/san-francisco-california-311/tokenstoken-id-response-format-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/san-francisco-california-311/san-francisco-california-311-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-twitter", "url"=>"https://twitter.com/311DCgov"}, {"type"=>"x-website", "url"=>"http://ouc.dc.gov"}, {"type"=>"x-open-311-feed", "url"=>"http://mobile311.sfgov.org/open311/v2/services.xml?jurisdiction_id=sfgov.org"}, {"type"=>"x-website", "url"=>"https://sf311.org/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-natural-language{"google-cloud-natural-language-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Natural Language", "x-complete"=>1, "info"=>{"title"=>"Google Cloud Natural Language", "description"=>"google-cloud-natural-language-api-provides-natural-language-understanding-technologies-to-developers--examples-include-sentiment-analysis-entity-recognition-and-text-annotations-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"language.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/documents:analyzeEntities"=>{"post"=>{"summary"=>"Find Named Entities", "description"=>"Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.", "operationId"=>"language.documents.analyzeEntities", "x-api-path-slug"=>"v1documentsanalyzeentities-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Entities"]}}, "/v1/documents:analyzeSentiment"=>{"post"=>{"summary"=>"Analyze SEntiment", "description"=>"Analyzes the sentiment of the provided text.", "operationId"=>"language.documents.analyzeSentiment", "x-api-path-slug"=>"v1documentsanalyzesentiment-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Sentiment"]}}, "/v1/documents:analyzeSyntax"=>{"post"=>{"summary"=>"Analyze Syntax", "description"=>"Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.", "operationId"=>"language.documents.analyzeSyntax", "x-api-path-slug"=>"v1documentsanalyzesyntax-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Syntax"]}}, "/v1/documents:annotateText"=>{"post"=>{"summary"=>"Annotate Text", "description"=>"A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.", "operationId"=>"language.documents.annotateText", "x-api-path-slug"=>"v1documentsannotatetext-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Annotation"]}}}}, "apis"=>{"name"=>"Google Cloud Natural Language", "x-slug"=>"google-cloud-natural-language", "description"=>"Google Cloud Natural Language API reveals the structure and meaning of text by offering powerful machine learning models in an easy to use REST API. You can use it to extract information about people, places, events and much more, mentioned in text documents, news articles or blog posts. You can use it to understand sentiment about your product on social media or parse intent from customer conversations happening in a call center or a messaging app. You can analyze text uploaded in your request or integrate with your document storage on Google Cloud Storage.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/powerful-text-analysis-2x.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Google APIs,Machine Learning,Natural Language,Profiles,Relative Data,Sentiment Analysis,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-natural-language/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Natural Language API", "x-api-slug"=>"google-cloud-natural-language-api", "description"=>"Google Cloud Natural Language API reveals the structure and meaning of text by offering powerful machine learning models in an easy to use REST API. You can use it to extract information about people, places, events and much more, mentioned in text documents, news articles or blog posts. You can use it to understand sentiment about your product on social media or parse intent from customer conversations happening in a call center or a messaging app. You can analyze text uploaded in your request or integrate with your document storage on Google Cloud Storage.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/powerful-text-analysis-2x.png", "humanURL"=>"https://cloud.google.com/natural-language/", "baseURL"=>"://language.googleapis.com//", "tags"=>"API Provider,API Service Provider,Google APIs,Machine Learning,Natural Language,Profiles,Relative Data,Sentiment Analysis,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-natural-language/google-cloud-natural-language-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-change-log", "url"=>"https://cloud.google.com/natural-language/release-notes"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/natural-language/docs/"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/natural-language/docs/getting-started"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/natural-language/docs/how-to"}, {"type"=>"x-libraries", "url"=>"https://cloud.google.com/natural-language/docs/reference/libraries"}, {"type"=>"x-price", "url"=>"https://cloud.google.com/natural-language/pricing"}, {"type"=>"x-rate-limits", "url"=>"https://cloud.google.com/natural-language/limits"}, {"type"=>"x-sample-applications", "url"=>"https://cloud.google.com/natural-language/docs/samples"}, {"type"=>"x-support", "url"=>"https://cloud.google.com/natural-language/support"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/natural-language/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
linkedin{"linkedin-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"LinkedIn", "x-complete"=>1, "info"=>{"title"=>"LinkedIn", "description"=>"bring-user-profiles-and-professional-networks-to-your-apps-", "version"=>"1.0.0"}, "host"=>"api.linkedin.com", "basePath"=>"/v1", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/companies/{id}/updates/key={update-key}/update-comments-as-company/"=>{"post"=>{"summary"=>"Add Companies Updates Key Update Key Update Comments As Company", "description"=>"Post companies updates key update key update comments as company", "operationId"=>"postCompaniesUpdatesKeyUpdateKeyUpdateCommentsAsCompany", "x-api-path-slug"=>"companiesidupdateskeyupdatekeyupdatecommentsascompany-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "", "Updates", "Key", "Update", "Key", "Update", "Comments", "As", "Company"]}}, "/people/~"=>{"get"=>{"summary"=>"Get People", "description"=>"Get people ~", "operationId"=>"getPeople~", "x-api-path-slug"=>"people-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The message format", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People"]}}, "/people/shares"=>{"post"=>{"summary"=>"Add People ~ Shares", "description"=>"Post people ~ shares", "operationId"=>"postPeople~Shares", "x-api-path-slug"=>"peopleshares-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"The content type"}, {"in"=>"query", "name"=>"format", "description"=>"The message format", "type"=>"string", "format"=>"string"}, {"in"=>"header", "name"=>"x-li-format", "description"=>"The content type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["People", "Shares"]}}, "/companies/{id}/is-company-share-enabled"=>{"get"=>{"summary"=>"Get Companies Is Company Share Enabled", "description"=>"Get companies is company share enabled", "operationId"=>"getCompaniesIsCompanyShareEnabled", "x-api-path-slug"=>"companiesidiscompanyshareenabled-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "", "Is", "Company", "Share", "Enabled"]}}, "/companies/{id}/relation-to-viewer/is-company-share-enabled"=>{"get"=>{"summary"=>"Get Companies Relation To Viewer Is Company Share Enabled", "description"=>"Get companies relation to viewer is company share enabled", "operationId"=>"getCompaniesRelationToViewerIsCompanyShareEnabled", "x-api-path-slug"=>"companiesidrelationtovieweriscompanyshareenabled-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "", "Relation", "To", "Viewer", "Is", "Company", "Share", "Enabled"]}}, "/companies/"=>{"get"=>{"summary"=>"Get Companies", "description"=>"Get companies", "operationId"=>"getCompanies", "x-api-path-slug"=>"companies-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies"]}}, "/companies/{id}"=>{"get"=>{"summary"=>"Get Companies", "description"=>"Get companies", "operationId"=>"getCompanies", "x-api-path-slug"=>"companiesid-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The message format", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies"]}}, "/companies/{id}:(id,name,ticker,description)"=>{"get"=>{"summary"=>"Get Companies (,name,ticker,description)", "description"=>"Get companies (,name,ticker,description)", "operationId"=>"getCompanies(,name,ticker,description)", "x-api-path-slug"=>"companiesididnametickerdescription-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "", "(", "name", "ticker", "description)"]}}, "/companies/{id}/updates"=>{"get"=>{"summary"=>"Get Companies Updates", "description"=>"Get companies updates", "operationId"=>"getCompaniesUpdates", "x-api-path-slug"=>"companiesidupdates-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The message format", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "", "Updates"]}}, "/companies/{id}/updates/key={update-key}"=>{"get"=>{"summary"=>"Get Companies Updates Key Update Key", "description"=>"Get companies updates key update key", "operationId"=>"getCompaniesUpdatesKeyUpdateKey", "x-api-path-slug"=>"companiesidupdateskeyupdatekey-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "", "Updates", "Key", "Update", "Key"]}}, "/companies/{id}/updates/key={update-key}/update-comments"=>{"get"=>{"summary"=>"Get Companies Updates Key Update Key Update Comments", "description"=>"Get companies updates key update key update comments", "operationId"=>"getCompaniesUpdatesKeyUpdateKeyUpdateComments", "x-api-path-slug"=>"companiesidupdateskeyupdatekeyupdatecomments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "", "Updates", "Key", "Update", "Key", "Update", "Comments"]}}, "/companies/{id}/updates/key={update-key}/likes"=>{"get"=>{"summary"=>"Get Companies Updates Key Update Key Likes", "description"=>"Get companies updates key update key likes", "operationId"=>"getCompaniesUpdatesKeyUpdateKeyLikes", "x-api-path-slug"=>"companiesidupdateskeyupdatekeylikes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "", "Updates", "Key", "Update", "Key", "Likes"]}}, "/companies/{id}/shares"=>{"post"=>{"summary"=>"Add Companies Shares", "description"=>"Post companies shares", "operationId"=>"postCompaniesShares", "x-api-path-slug"=>"companiesidshares-post", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The message format", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "", "Shares"]}}, "/companies/{id}/num-followers"=>{"get"=>{"summary"=>"Get Companies Num Followers", "description"=>"Get companies num followers", "operationId"=>"getCompaniesNumFollowers", "x-api-path-slug"=>"companiesidnumfollowers-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The message format", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "", "Num", "Followers"]}}, "/companies/{id}/historical-follow-statistics"=>{"get"=>{"summary"=>"Get Companies Historical Follow Statistics", "description"=>"Get companies historical follow statistics", "operationId"=>"getCompaniesHistoricalFollowStatistics", "x-api-path-slug"=>"companiesidhistoricalfollowstatistics-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The message format", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "", "Historical", "Follow", "Statistics"]}}, "/companies/{id}/historical-status-update-statistics"=>{"get"=>{"summary"=>"Get Companies Historical Status Update Statistics", "description"=>"Get companies historical status update statistics", "operationId"=>"getCompaniesHistoricalStatusUpdateStatistics", "x-api-path-slug"=>"companiesidhistoricalstatusupdatestatistics-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The message format", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "", "Historical", "Status", "Update", "Statistics"]}}, "/companies/{id}/company-statistics"=>{"get"=>{"summary"=>"Get Companies Company Statistics", "description"=>"Get companies company statistics", "operationId"=>"getCompaniesCompanyStatistics", "x-api-path-slug"=>"companiesidcompanystatistics-get", "parameters"=>[{"in"=>"query", "name"=>"format", "description"=>"The message format", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Companies", "", "Company", "Statistics"]}}}}, "apis"=>{"name"=>"LinkedIn", "x-slug"=>"linkedin", "description"=>"DZone Software provides tools and processes to help customers accelerate productivity through agile learning and knowledge-centered collaboration.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/221-linkedin.jpg", "x-kinRank"=>"8", "x-alexaRank"=>"34", "tags"=>"API Provider,API Service Provider,General Data,Indie EdTech Data Jam,internet,Mobile,My API Stack,Pedestal,Profiles,Relative Data,Relative StreamRank,SaaS,SDIO Syndication,Service API,Social,Social,Social Networks,Social Networks,Stack,Stack Network,Streams,Streams,Streams,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"linkedin/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"LinkedIn", "x-api-slug"=>"linkedin", "description"=>"DZone Software provides tools and processes to help customers accelerate productivity through agile learning and knowledge-centered collaboration.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/221-linkedin.jpg", "humanURL"=>"http://linkedin.com", "baseURL"=>"https://api.linkedin.com//v1", "tags"=>"API Provider,API Service Provider,General Data,Indie EdTech Data Jam,internet,Mobile,My API Stack,Pedestal,Profiles,Relative Data,Relative StreamRank,SaaS,SDIO Syndication,Service API,Social,Social,Social Networks,Social Networks,Stack,Stack Network,Streams,Streams,Streams,Technology", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/linkedin/linkedin-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-authentication", "url"=>"https://developer.linkedin.com/documents/authentication"}, {"type"=>"x-base", "url"=>"https://api.linkedin.com"}, {"type"=>"x-blog", "url"=>"http://blog.linkedin.com"}, {"type"=>"x-branding", "url"=>"https://brand.linkedin.com/policies"}, {"type"=>"x-case-studies", "url"=>"https://developer.linkedin.com/showcase/wordpress"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/linkedin"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/linkedin"}, {"type"=>"x-developer", "url"=>"https://developer.linkedin.com"}, {"type"=>"x-forum", "url"=>"https://developer.linkedin.com/forum"}, {"type"=>"x-github", "url"=>"https://github.com/linkedin"}, {"type"=>"x-javascript-api", "url"=>"https://developer.linkedin.com/javascript"}, {"type"=>"x-partners", "url"=>"https://developer.linkedin.com/partner-programs"}, {"type"=>"x-privacy", "url"=>"http://www.linkedin.com/static?key=privacy_policy&trk=hb_ft_priv"}, {"type"=>"x-stack-overflow", "url"=>"http://stackoverflow.com/questions/tagged/linkedin"}, {"type"=>"x-terms-of-service", "url"=>"https://developer.linkedin.com/legal/api-terms-of-use"}, {"type"=>"x-transparency-report", "url"=>"https://www.linkedin.com/legal/transparency"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/LinkedIn"}, {"type"=>"x-website", "url"=>"http://linkedin.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
standard-chartered{"standard-chartered-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Standard Chartered", "x-complete"=>1, "info"=>{"title"=>"Standard Chartered", "description"=>"standard-chartered-plc-is-a-british-multinational-banking-and-financial-services-company-headquartered-in-london-england--it-operates-a-network-of-more-than-1200-branches-and-outlets-including-subsidiaries-associates-and-joint-ventures-across-more-than-70-countries-and-employs-around-87000-people--it-is-a-universal-bank-with-operations-in-consumer-corporate-and-institutional-banking-and-treasury-services--despite-its-uk-base-it-does-not-conduct-retail-banking-in-the-uk-and-around-90-of-its-profits-come-from-asia-africa-and-the-middle-east-", "termsOfService"=>"https://www.sc.com/terms-and-conditions", "contact"=>{"name"=>"Steve Spicer", "url"=>"https://www.sc.com", "email"=>"steven.spicer@sc.com"}, "version"=>"1.0.0"}, "host"=>"developer.sc.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/cib/service/s2b/api/v1/banks/scb/accounts/{accountId}/{viewId}/account"=>{"get"=>{"summary"=>"Accounts", "description"=>"The ???GetAccountBalance??? API upon successful user authentication and entitlement checks will return the various types of ???Account Balances??? applicable for the specified Account Number.", "operationId"=>"getCibServiceS2bApiV1BanksScbAccountsAccountViewAccount", "x-api-path-slug"=>"cibservices2bapiv1banksscbaccountsaccountidviewidaccount-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"header", "name"=>"GroupId"}, {"in"=>"header", "name"=>"UserId"}, {"in"=>"path", "name"=>"viewId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Banking", "Cib", "Service", "S2b", "Api", "V1", "Banks", "Scb", "Accounts", "Account", "View", "Account"]}}, "/cib/service/s2b/api/v1/banks/scb/accounts/{accountId}/{viewId}/transaction-request-types"=>{"get"=>{"summary"=>"Finds all support transaction types for a given account", "description"=>"The ???GetTransactionTypes??? API upon successful user authentication and entitlement checks will return the supported transaction types for the specified account", "operationId"=>"getCibServiceS2bApiV1BanksScbAccountsAccountViewTransactionRequestTypes", "x-api-path-slug"=>"cibservices2bapiv1banksscbaccountsaccountidviewidtransactionrequesttypes-get", "parameters"=>[{"in"=>"path", "name"=>"accountId"}, {"in"=>"header", "name"=>"GroupId"}, {"in"=>"header", "name"=>"UserId"}, {"in"=>"path", "name"=>"viewId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Banking", "Cib", "Service", "S2b", "Api", "V1", "Banks", "Scb", "Accounts", "Account", "View", "Transaction", "Request", "Types"]}}, "/cib/service/s2b/api/v1/banks/scb/accounts/{viewId}/accounts"=>{"get"=>{"summary"=>"Account Details & Balances", "description"=>"List available bank accounts", "operationId"=>"getCibServiceS2bApiV1BanksScbAccountsViewAccounts", "x-api-path-slug"=>"cibservices2bapiv1banksscbaccountsviewidaccounts-get", "parameters"=>[{"in"=>"header", "name"=>"GroupId"}, {"in"=>"header", "name"=>"UserId"}, {"in"=>"path", "name"=>"viewId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Banking", "Cib", "Service", "S2b", "Api", "V1", "Banks", "Scb", "Accounts", "View", "Accounts"]}}, "/cib/service/s2b/api/v1/banks/scb/reference/default/branches"=>{"post"=>{"summary"=>"Bank Code Inquiry", "description"=>"The ???GetBankCode??? API returns list of Bank Codes for the specified combination of ???Country???, ???City??? and ???Bank??? combination. The data will contain the ???Bank Code(s)??? as well as the address for the Bank & Branch.", "operationId"=>"postCibServiceS2bApiV1BanksScbReferenceDefaultBranches", "x-api-path-slug"=>"cibservices2bapiv1banksscbreferencedefaultbranches-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Banks", "Banking", "Cib", "Service", "S2b", "Api", "V1", "Banks", "Scb", "Reference", "Default", "Branches"]}}, "/cib/service/s2b/api/v1/banks/scb/reference/default/holiday-calendar/country/{country}"=>{"get"=>{"summary"=>"Holiday Calendar Inquiry (Country)", "description"=>"The ???GetHolidayCalendar??? API returns list of holidays applicable for the specified combination of:\n
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-elastic-mapreduce{"aws-elastic-mapreduce-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Elastic MapReduce", "x-complete"=>1, "info"=>{"title"=>"AWS Elastic MapReduce API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=AddInstanceGroups"=>{"get"=>{"summary"=>"Add Instance Groups", "description"=>"Adds one or more instance groups to a running cluster.", "operationId"=>"addInstanceGroups", "x-api-path-slug"=>"actionaddinstancegroups-get", "parameters"=>[{"in"=>"query", "name"=>"InstanceGroups", "description"=>"Instance groups to add", "type"=>"string"}, {"in"=>"query", "name"=>"JobFlowId", "description"=>"Job flow in which to add the instance groups", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Groups"]}}, "/?Action=AddJobFlowSteps"=>{"get"=>{"summary"=>"Add Job Flow Steps", "description"=>"AddJobFlowSteps adds new steps to a running job flow.", "operationId"=>"addJobFlowSteps", "x-api-path-slug"=>"actionaddjobflowsteps-get", "parameters"=>[{"in"=>"query", "name"=>"JobFlowId", "description"=>"A string that uniquely identifies the job flow", "type"=>"string"}, {"in"=>"query", "name"=>"Steps", "description"=>"A list of StepConfig to be executed by the job flow", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Flow Steps"]}}, "/?Action=AddTags"=>{"get"=>{"summary"=>"Add Tags", "description"=>"Adds tags to an Amazon EMR resource.", "operationId"=>"addTags", "x-api-path-slug"=>"actionaddtags-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceId", "description"=>"The Amazon EMR resource identifier to which tags will be added", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"A list of tags to associate with a cluster and propagate to EC2 instances", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=CancelSteps"=>{"get"=>{"summary"=>"Cancel Steps", "description"=>"Cancels a pending step or steps in a running cluster.", "operationId"=>"cancelSteps", "x-api-path-slug"=>"actioncancelsteps-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterId", "description"=>"The ClusterID for which specified steps will be canceled", "type"=>"string"}, {"in"=>"query", "name"=>"StepIds", "description"=>"The list of StepIDs to cancel", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Steps"]}}, "/?Action=CreateSecurityConfiguration"=>{"get"=>{"summary"=>"Create Security Configuration", "description"=>"Creates a security configuration, which is stored in the service and can be specified when a cluster is created.", "operationId"=>"createSecurityConfiguration", "x-api-path-slug"=>"actioncreatesecurityconfiguration-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"The name of the security configuration", "type"=>"string"}, {"in"=>"query", "name"=>"SecurityConfiguration", "description"=>"The security configuration details in JSON format", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Configurations"]}}, "/?Action=DeleteSecurityConfiguration"=>{"get"=>{"summary"=>"Delete Security Configuration", "description"=>"Deletes a security configuration.", "operationId"=>"deleteSecurityConfiguration", "x-api-path-slug"=>"actiondeletesecurityconfiguration-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"The name of the security configuration", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Configurations"]}}, "/?Action=DescribeCluster"=>{"get"=>{"summary"=>"Describe Cluster", "description"=>"Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.", "operationId"=>"describeCluster", "x-api-path-slug"=>"actiondescribecluster-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterId", "description"=>"The identifier of the cluster to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=DescribeJobFlows"=>{"get"=>{"summary"=>"Describe Job Flows", "description"=>"This API is deprecated and will eventually be removed.", "operationId"=>"describeJobFlows", "x-api-path-slug"=>"actiondescribejobflows-get", "parameters"=>[{"in"=>"query", "name"=>"CreatedAfter", "description"=>"Return only job flows created after this date and time", "type"=>"string"}, {"in"=>"query", "name"=>"CreatedBefore", "description"=>"Return only job flows created before this date and time", "type"=>"string"}, {"in"=>"query", "name"=>"JobFlowIds", "description"=>"Return only job flows whose job flow ID is contained in this list", "type"=>"string"}, {"in"=>"query", "name"=>"JobFlowStates", "description"=>"Return only job flows whose state is contained in this list", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Flows"]}}, "/?Action=DescribeSecurityConfiguration"=>{"get"=>{"summary"=>"Describe Security Configuration", "description"=>"Provides the details of a security configuration by returning the configuration JSON.", "operationId"=>"describeSecurityConfiguration", "x-api-path-slug"=>"actiondescribesecurityconfiguration-get", "parameters"=>[{"in"=>"query", "name"=>"Name", "description"=>"The name of the security configuration", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Configurations"]}}, "/?Action=DescribeStep"=>{"get"=>{"summary"=>"Describe Step", "description"=>"Provides more detail about the cluster step.", "operationId"=>"describeStep", "x-api-path-slug"=>"actiondescribestep-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterId", "description"=>"The identifier of the cluster with steps to describe", "type"=>"string"}, {"in"=>"query", "name"=>"StepId", "description"=>"The identifier of the step to describe", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Steps"]}}, "/?Action=ListBootstrapActions"=>{"get"=>{"summary"=>"List Bootstrap Actions", "description"=>"Provides information about the bootstrap actions associated with a cluster.", "operationId"=>"listBootstrapActions", "x-api-path-slug"=>"actionlistbootstrapactions-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterId", "description"=>"The cluster identifier for the bootstrap actions to list", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"The pagination token that indicates the next set of results to retrieve", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bootstrap Actions"]}}, "/?Action=ListClusters"=>{"get"=>{"summary"=>"List Clusters", "description"=>"Provides the status of all clusters visible to this AWS account.", "operationId"=>"listClusters", "x-api-path-slug"=>"actionlistclusters-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterStates", "description"=>"The cluster state filters to apply when listing clusters", "type"=>"string"}, {"in"=>"query", "name"=>"CreatedAfter", "description"=>"The creation date and time beginning value filter for listing clusters", "type"=>"string"}, {"in"=>"query", "name"=>"CreatedBefore", "description"=>"The creation date and time end value filter for listing clusters", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"The pagination token that indicates the next set of results to retrieve", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=ListInstanceGroups"=>{"get"=>{"summary"=>"List Instance Groups", "description"=>"Provides all available details about the instance groups in a cluster.", "operationId"=>"listInstanceGroups", "x-api-path-slug"=>"actionlistinstancegroups-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterId", "description"=>"The identifier of the cluster for which to list the instance groups", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"The pagination token that indicates the next set of results to retrieve", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Groups"]}}, "/?Action=ListInstances"=>{"get"=>{"summary"=>"List Instances", "description"=>"Provides information about the cluster instances that Amazon EMR provisions on behalf of a user \n when it creates the cluster.", "operationId"=>"listInstances", "x-api-path-slug"=>"actionlistinstances-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterId", "description"=>"The identifier of the cluster for which to list the instances", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceGroupId", "description"=>"The identifier of the instance group for which to list the instances", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceGroupTypes", "description"=>"The type of instance group for which to list the instances", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceStates", "description"=>"A list of instance states that will filter the instances returned with this request", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"The pagination token that indicates the next set of results to retrieve", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instances"]}}, "/?Action=ListSecurityConfigurations"=>{"get"=>{"summary"=>"List Security Configurations", "description"=>"Lists all the security configurations visible to this account, providing their creation dates and times, and their names.", "operationId"=>"listSecurityConfigurations", "x-api-path-slug"=>"actionlistsecurityconfigurations-get", "parameters"=>[{"in"=>"query", "name"=>"Marker", "description"=>"The pagination token that indicates the set of results to retrieve", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Security Configurations"]}}, "/?Action=ListSteps"=>{"get"=>{"summary"=>"List Steps", "description"=>"Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request.", "operationId"=>"listSteps", "x-api-path-slug"=>"actionliststeps-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterId", "description"=>"The identifier of the cluster for which to list the steps", "type"=>"string"}, {"in"=>"query", "name"=>"Marker", "description"=>"The pagination token that indicates the next set of results to retrieve", "type"=>"string"}, {"in"=>"query", "name"=>"StepIds", "description"=>"The filter to limit the step list based on the identifier of the steps", "type"=>"string"}, {"in"=>"query", "name"=>"StepStates", "description"=>"The filter to limit the step list based on certain states", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Steps"]}}, "/?Action=ModifyInstanceGroups"=>{"get"=>{"summary"=>"Modify Instance Groups", "description"=>"ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group.", "operationId"=>"modifyInstanceGroups", "x-api-path-slug"=>"actionmodifyinstancegroups-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterId", "description"=>"The ID of the cluster to which the instance group belongs", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceGroups", "description"=>"Instance groups to change", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Groups"]}}, "/?Action=PutAutoScalingPolicy"=>{"get"=>{"summary"=>"Put Auto Scaling Policy", "description"=>"Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster.", "operationId"=>"putAutoScalingPolicy", "x-api-path-slug"=>"actionputautoscalingpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"AutoScalingPolicy", "description"=>"Specifies the definition of the automatic scaling policy", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterId", "description"=>"Specifies the ID of a cluster", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceGroupId", "description"=>"Specifies the ID of the instance group to which the automatic scaling policy is applied", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auto Scaling Policies"]}}, "/?Action=RemoveAutoScalingPolicy"=>{"get"=>{"summary"=>"Remove Auto Scaling Policy", "description"=>"Removes an automatic scaling policy from a specified instance group within an EMR cluster.", "operationId"=>"removeAutoScalingPolicy", "x-api-path-slug"=>"actionremoveautoscalingpolicy-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterId", "description"=>"Specifies the ID of a cluster", "type"=>"string"}, {"in"=>"query", "name"=>"InstanceGroupId", "description"=>"Specifies the ID of the instance group to which the scaling policy is applied", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auto Scaling Policies"]}}, "/?Action=RemoveTags"=>{"get"=>{"summary"=>"Remove Tags", "description"=>"Removes tags from an Amazon EMR resource.", "operationId"=>"removeTags", "x-api-path-slug"=>"actionremovetags-get", "parameters"=>[{"in"=>"query", "name"=>"ResourceId", "description"=>"The Amazon EMR resource identifier from which tags will be removed", "type"=>"string"}, {"in"=>"query", "name"=>"TagKeys", "description"=>"A list of tag keys to remove from a resource", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/?Action=RunJobFlow"=>{"get"=>{"summary"=>"Run Job Flow", "description"=>"RunJobFlow creates and starts running a new job flow.", "operationId"=>"runJobFlow", "x-api-path-slug"=>"actionrunjobflow-get", "parameters"=>[{"in"=>"query", "name"=>"AdditionalInfo", "description"=>"A JSON string for selecting additional features", "type"=>"string"}, {"in"=>"query", "name"=>"AmiVersion", "description"=>"Note", "type"=>"string"}, {"in"=>"query", "name"=>"Applications", "description"=>"Note", "type"=>"string"}, {"in"=>"query", "name"=>"AutoScalingRole", "description"=>"An IAM role for automatic scaling policies", "type"=>"string"}, {"in"=>"query", "name"=>"BootstrapActions", "description"=>"A list of bootstrap actions that will be run before Hadoop is started on the cluster nodes", "type"=>"string"}, {"in"=>"query", "name"=>"Configurations", "description"=>"Note", "type"=>"string"}, {"in"=>"query", "name"=>"Instances", "description"=>"A specification of the number and type of Amazon EC2 instances on which to run the job flow", "type"=>"string"}, {"in"=>"query", "name"=>"JobFlowRole", "description"=>"Also called instance profile and EC2 role", "type"=>"string"}, {"in"=>"query", "name"=>"LogUri", "description"=>"The location in Amazon S3 to write the log files of the job flow", "type"=>"string"}, {"in"=>"query", "name"=>"Name", "description"=>"The name of the job flow", "type"=>"string"}, {"in"=>"query", "name"=>"NewSupportedProducts", "description"=>"Note", "type"=>"string"}, {"in"=>"query", "name"=>"ReleaseLabel", "description"=>"Note", "type"=>"string"}, {"in"=>"query", "name"=>"ScaleDownBehavior", "description"=>"Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized", "type"=>"string"}, {"in"=>"query", "name"=>"SecurityConfiguration", "description"=>"The name of a security configuration to apply to the cluster", "type"=>"string"}, {"in"=>"query", "name"=>"ServiceRole", "description"=>"The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf", "type"=>"string"}, {"in"=>"query", "name"=>"Steps", "description"=>"A list of steps to be executed by the job flow", "type"=>"string"}, {"in"=>"query", "name"=>"SupportedProducts", "description"=>"Note", "type"=>"string"}, {"in"=>"query", "name"=>"Tags", "description"=>"A list of tags to associate with a cluster and propagate to Amazon EC2 instances", "type"=>"string"}, {"in"=>"query", "name"=>"VisibleToAllUsers", "description"=>"Whether the job flow is visible to all IAM users of the AWS account associated with the job flow", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Flows"]}}, "/?Action=SetTerminationProtection"=>{"get"=>{"summary"=>"Set Termination Protection", "description"=>"SetTerminationProtection locks a job flow so the EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error.", "operationId"=>"setTerminationProtection", "x-api-path-slug"=>"actionsetterminationprotection-get", "parameters"=>[{"in"=>"query", "name"=>"JobFlowIds", "description"=>"A list of strings that uniquely identify the job flows to protect", "type"=>"string"}, {"in"=>"query", "name"=>"TerminationProtected", "description"=>"A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Termination Protection"]}}, "/?Action=SetVisibleToAllUsers"=>{"get"=>{"summary"=>"Set Visible To All Users", "description"=>"Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified job flows.", "operationId"=>"setVisibleToAllUsers", "x-api-path-slug"=>"actionsetvisibletoallusers-get", "parameters"=>[{"in"=>"query", "name"=>"JobFlowIds", "description"=>"Identifiers of the job flows to receive the new visibility setting", "type"=>"string"}, {"in"=>"query", "name"=>"VisibleToAllUsers", "description"=>"Whether the specified job flows are visible to all IAM users of the AWS account associated with the job flow", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Visible To All Users"]}}, "/?Action=TerminateJobFlows"=>{"get"=>{"summary"=>"Terminate Job Flows", "description"=>"TerminateJobFlows shuts a list of job flows down.", "operationId"=>"terminateJobFlows", "x-api-path-slug"=>"actionterminatejobflows-get", "parameters"=>[{"in"=>"query", "name"=>"JobFlowIds", "description"=>"A list of job flows to be shutdown", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Flows"]}}}}, "apis"=>{"name"=>"AWS Elastic MapReduce", "x-slug"=>"aws-elastic-mapreduce", "description"=>"Amazon EMR provides a managed Hadoop framework that makes it easy, fast, and cost-effective to process vast amounts of data across dynamically scalable Amazon EC2 instances. You can also run other popular distributed frameworks such as Apache Spark, HBase, Presto, and Flink in Amazon EMR, and interact with data in other AWS data stores such as Amazon S3 and Amazon DynamoDB.Amazon EMR securely and reliably handles a broad set of big data use cases, including log analysis, web indexing, data transformations (ETL), machine learning, financial analysis, scientific simulation, and bioinformatics.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Analytics_AmazonEMR.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Data,Databases,MapReduce,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-elastic-mapreduce/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Elastic MapReduce API", "x-api-slug"=>"aws-elastic-mapreduce-api", "description"=>"Amazon EMR provides a managed Hadoop framework that makes it easy, fast, and cost-effective to process vast amounts of data across dynamically scalable Amazon EC2 instances. You can also run other popular distributed frameworks such as Apache Spark, HBase, Presto, and Flink in Amazon EMR, and interact with data in other AWS data stores such as Amazon S3 and Amazon DynamoDB.Amazon EMR securely and reliably handles a broad set of big data use cases, including log analysis, web indexing, data transformations (ETL), machine learning, financial analysis, scientific simulation, and bioinformatics.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Analytics_AmazonEMR.png", "humanURL"=>"https://aws.amazon.com/emr/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Data,Databases,MapReduce,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/aws-elastic-mapreduce/actionterminatejobflows-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/aws-elastic-mapreduce/aws-elastic-mapreduce-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-article", "url"=>"http://aws.amazon.com/articles/Elastic-MapReduce"}, {"type"=>"x-command-line-interface", "url"=>"http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-cli-reference.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/emr/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/emr/getting-started/"}, {"type"=>"x-partners", "url"=>"https://aws.amazon.com/emr/partners/"}, {"type"=>"x-pricing", "url"=>"https://aws.amazon.com/emr/pricing/"}, {"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/ElasticMapReduce/latest/API/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/emr/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
webtris{"webtris-traffic-flow-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"WebTRIS", "x-complete"=>1, "info"=>{"title"=>"", "version"=>"1.0.0"}, "host"=>"webtris.highwaysengland.co.uk", "basePath"=>"/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v{version}/areas"=>{"get"=>{"summary"=>"Returns list of areas", "description"=>"Returns list of areas.", "operationId"=>"Areas_Get", "x-api-path-slug"=>"vversionareas-get", "parameters"=>[{"in"=>"path", "name"=>"version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "List", "Of", "Areas"]}}, "/v{version}/areas/{area_Ids}"=>{"get"=>{"summary"=>"Returns details of selected area", "description"=>"Returns details of selected area.", "operationId"=>"Areas_Get", "x-api-path-slug"=>"vversionareasarea-ids-get", "parameters"=>[{"in"=>"path", "name"=>"area_Ids"}, {"in"=>"path", "name"=>"version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Details", "Of", "Selected", "Area"]}}, "/v{version}/quality/overall"=>{"get"=>{"summary"=>"Get Site OverallQuality", "description"=>"Get site overallquality.", "operationId"=>"Quality_GetOverallDataQualityForSites", "x-api-path-slug"=>"vversionqualityoverall-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"The end date of the report in the format ddmmyyyy (i"}, {"in"=>"query", "name"=>"sites", "description"=>"Get site quality by site id delimited by ,"}, {"in"=>"query", "name"=>"start_date", "description"=>"The start date of the report in the format ddmmyyyy (i"}, {"in"=>"path", "name"=>"version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Site", "OverallQuality"]}}, "/v{version}/quality/daily"=>{"get"=>{"summary"=>"Get Site DailyQuality", "description"=>"Get site dailyquality.", "operationId"=>"Quality_GetDailyDataQualityForSite", "x-api-path-slug"=>"vversionqualitydaily-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"The end date of the report in the format ddmmyyyy (i"}, {"in"=>"query", "name"=>"siteId"}, {"in"=>"query", "name"=>"start_date", "description"=>"The start date of the report in the format ddmmyyyy (i"}, {"in"=>"path", "name"=>"version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Site", "DailyQuality"]}}, "/v{version}/reports/{report_type}"=>{"get"=>{"summary"=>"Gets the daily report.", "description"=>"Gets the daily report..", "operationId"=>"Reports_Index", "x-api-path-slug"=>"vversionreportsreport-type-get", "parameters"=>[{"in"=>"query", "name"=>"end_date", "description"=>"The end date of the report in the format ddmmyyyy (i"}, {"in"=>"query", "name"=>"page", "description"=>"The page offset to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"The number of rows to return"}, {"in"=>"query", "name"=>"reportSubTypeId"}, {"in"=>"path", "name"=>"report_type", "description"=>"Report Type Id (i"}, {"in"=>"query", "name"=>"sites", "description"=>"Comma separated list of site Ids"}, {"in"=>"query", "name"=>"start_date", "description"=>"The start date of the report in the format ddmmyyyy (i"}, {"in"=>"path", "name"=>"version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Daily", "Report"]}}, "/v{version}/reports/{start_date}/to/{end_date}/{report_type}"=>{"get"=>{"summary"=>"Gets the daily report.", "description"=>"Gets the daily report..", "operationId"=>"Reports_Index", "x-api-path-slug"=>"vversionreportsstart-datetoend-datereport-type-get", "parameters"=>[{"in"=>"path", "name"=>"end_date", "description"=>"The end date of the report in the format ddmmyyyy (i"}, {"in"=>"query", "name"=>"page", "description"=>"The page offset to return"}, {"in"=>"query", "name"=>"page_size", "description"=>"The number of rows to return"}, {"in"=>"query", "name"=>"reportSubTypeId"}, {"in"=>"path", "name"=>"report_type", "description"=>"Report Type Id (i"}, {"in"=>"query", "name"=>"sites", "description"=>"Comma separated list of site Ids"}, {"in"=>"path", "name"=>"start_date", "description"=>"The start date of the report in the format ddmmyyyy (i"}, {"in"=>"path", "name"=>"version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S", "Daily", "Report"]}}, "/v{version}/sites"=>{"get"=>{"summary"=>"Get a list of sites", "description"=>"Get a list of sites.", "operationId"=>"Sites_Index", "x-api-path-slug"=>"vversionsites-get", "parameters"=>[{"in"=>"path", "name"=>"version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["List", "Of", "Sites"]}}, "/v{version}/sites/{site_Ids}"=>{"get"=>{"summary"=>"Get selected sites", "description"=>"Get selected sites.", "operationId"=>"Sites_Index", "x-api-path-slug"=>"vversionsitessite-ids-get", "parameters"=>[{"in"=>"path", "name"=>"site_Ids", "description"=>"site id"}, {"in"=>"path", "name"=>"version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Selected", "Sites"]}}, "/v{version}/sitetypes"=>{"get"=>{"summary"=>"Return list of site types", "description"=>"Return list of site types.", "operationId"=>"SiteTypes_Index", "x-api-path-slug"=>"vversionsitetypes-get", "parameters"=>[{"in"=>"path", "name"=>"version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Return", "List", "Of", "Site", "Types"]}}, "/v{version}/sitetypes/{siteType_Id}/sites"=>{"get"=>{"summary"=>"Returns the layer metadata for the LayerId specified.", "description"=>"Returns the layer metadata for the layerid specified..", "operationId"=>"SiteTypes_GetSitesForPublicFacingAPI", "x-api-path-slug"=>"vversionsitetypessitetype-idsites-get", "parameters"=>[{"in"=>"path", "name"=>"siteType_Id", "description"=>"1 = MIDAS, 2 = TAME, 3 = TMU, 4 = TRADS Legacy"}, {"in"=>"path", "name"=>"version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Returns", "Layer", "Metadatathe", "LayerId", "Specified"]}}}}, "apis"=>{"name"=>"WebTRIS", "x-slug"=>"webtris", "description"=>"The WebTRIS data available at http://webtris.highwaysengland.co.uk/ is available via an application programming interface (API) in JSON format. This is a free service and there is no need to register to use it. Developers can utilise the WebTRIS data to provide their own services, applications and websites.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/webtris-traffic-flow-api.png", "x-kinRank"=>"7", "x-alexaRank"=>"", "tags"=>"General Data,Traffic,Transportation", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"webtris/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"WebTRIS Traffic Flow API", "x-api-slug"=>"webtris-traffic-flow-api", "description"=>"The WebTRIS data available at http://webtris.highwaysengland.co.uk/ is available via an application programming interface (API) in JSON format. This is a free service and there is no need to register to use it. Developers can utilise the WebTRIS data to provide their own services, applications and websites.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/webtris-traffic-flow-api.png", "humanURL"=>"http://webtris.highwaysengland.co.uk/", "baseURL"=>"https://webtris.highwaysengland.co.uk//api", "tags"=>"General Data,Traffic,Transportation", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/webtris/vversionsitetypessitetype-idsites-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/webtris/webtris-traffic-flow-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://webtris.highwaysengland.co.uk/api/swagger/ui/index"}, {"type"=>"x-website", "url"=>"http://webtris.highwaysengland.co.uk/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
yahoo{"yahoo-weather-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Yahoo", "x-complete"=>1, "info"=>{"title"=>"Yahoo Weather", "description"=>"access-uptodate-weather-information-for-your-location-including-condition-codes-", "version"=>"1.0.0"}, "host"=>"weather.yahooapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/forecastrss"=>{"get"=>{"summary"=>"", "description"=>"Retrieves weather information for a location.", "operationId"=>"Get_weather.get_", "x-api-path-slug"=>"forecastrss-get", "parameters"=>[{"in"=>"query", "name"=>"u", "description"=>"Units for temperature (case sensitive)"}, {"in"=>"query", "name"=>"w", "description"=>"The location for the weather forecast as a WOEID, example is Palo Alto, CA"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>[""]}}}}, "apis"=>{"name"=>"Yahoo", "x-slug"=>"yahoo", "description"=>"News, email and search are just the beginning. Discover more every day. Find your yodel.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/201-yahoo.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"7", "tags"=>"General Data,internet,Locations,Photos,Relative Data,Search,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"yahoo/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Yahoo Weather", "x-api-slug"=>"yahoo-weather", "description"=>"The Weather RSS feed enables you to get up-to-date weather information for your location. You can save this feed in My Yahoo! or your favorite feed aggregator, or incorporate the RSS data into your own web site or client application. The Weather RSS feed is a dynamically-generated feed based on WOEID.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/201-yahoo.jpg", "humanURL"=>"http://www.yahoo.com", "baseURL"=>"https://weather.yahooapis.com//", "tags"=>"General Data,internet,Locations,Photos,Relative Data,Search,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/yahoo/forecastrss-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/yahoo/yahoo-weather-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"http://www.yahoo.com"}, {"type"=>"x-advertising", "url"=>"https://developer.yahoo.com/everything.html#groupAdvertise"}, {"type"=>"x-application-management", "url"=>"https://developer.apps.yahoo.com/"}, {"type"=>"x-blog", "url"=>"http://yahoodevelopers.tumblr.com/"}, {"type"=>"x-blog-rss", "url"=>"http://yahoodevelopers.tumblr.com/rss"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/yahoo"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/yahoo"}, {"type"=>"x-forum", "url"=>"https://developer.yahoo.com/forums/"}, {"type"=>"x-github", "url"=>"https://github.com/yahoo"}, {"type"=>"x-jobs", "url"=>"http://yhoo.it/1iLIFlr"}, {"type"=>"x-monetization", "url"=>"https://developer.yahoo.com/everything.html#groupEarn"}, {"type"=>"x-privacy", "url"=>"https://info.yahoo.com/privacy/us/yahoo/devel/details.html"}, {"type"=>"x-selfservice-registration", "url"=>"https://login.yahoo.com/config/login?.done=https://developer.yahoo.com/"}, {"type"=>"x-terms-of-service", "url"=>"https://info.yahoo.com/legal/us/yahoo/api/api-2140.html"}, {"type"=>"x-transparency-report", "url"=>"https://transparency.yahoo.com/"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/Yahoo"}, {"type"=>"x-website", "url"=>"https://developer.yahoo.com/"}, {"type"=>"x-website", "url"=>"http://tumblr.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
twilio{"twilio-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Twilio", "x-complete"=>1, "info"=>{"title"=>"Twilio", "description"=>"twilio-is-a-cloud-communications-infrastructure-as-a-serviceiaas-company-based-in-san-francisco-california--twilio-allows-software-developers-to-programmatically-make-and-receive-phone-calls-and-send-and-receive-text-messages-using-its-web-service-apis--twilios-services-are-accessed-over-http-and-are-billed-based-on-usage-", "termsOfService"=>"https://www.twilio.com/legal/tos", "version"=>"v1"}, "host"=>"api.twilio.com", "basePath"=>"/2010-04-01/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/Accounts/{AccountSid}.{format}"=>{"get"=>{"summary"=>"Get Acount", "description"=>"Get Account", "operationId"=>"getAccount", "x-api-path-slug"=>"accountsaccountsid-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}, "post"=>{"summary"=>"Add Account", "description"=>"Add Account", "operationId"=>"addAccount", "x-api-path-slug"=>"accountsaccountsid-format-post", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}, "put"=>{"summary"=>"Update Account", "description"=>"Update Account", "operationId"=>"updateAccount", "x-api-path-slug"=>"accountsaccountsid-format-put", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/Accounts.{format}"=>{"get"=>{"summary"=>"Get Accounts", "description"=>"Get Accounts", "operationId"=>"getAccounts", "x-api-path-slug"=>"accounts-format-get", "parameters"=>[{"in"=>"formData", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Accounts"]}}, "/Accounts/{AccountSid}/Applications/{ApplicationSid}.{format}"=>{"delete"=>{"summary"=>"Delete Application", "description"=>"Delete Application", "operationId"=>"delete-this-application", "x-api-path-slug"=>"accountsaccountsidapplicationsapplicationsid-format-delete", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"ApplicationSid", "description"=>"The ID for the Twilio application"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}, "get"=>{"summary"=>"Get Application", "description"=>"Get application instance resource.", "operationId"=>"get-application-instance-resource", "x-api-path-slug"=>"accountsaccountsidapplicationsapplicationsid-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"ApplicationSid", "description"=>"The ID for the Twilio application"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}, "post"=>{"summary"=>"Add Application", "description"=>"Tries to update the applications properties, and returns the updatednresource representation if successful. The returned response is identicalnto that returned above when making a GET request.n", "operationId"=>"tries-to-update-the-applications-properties-and-returns-the-updatedresource-representation-if-succes", "x-api-path-slug"=>"accountsaccountsidapplicationsapplicationsid-format-post", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"ApplicationSid", "description"=>"The ID for the Twilio application"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/Accounts/{AccountSid}/Applications.{format}"=>{"get"=>{"summary"=>"Get Applications", "description"=>"Get Applications", "operationId"=>"returns-a-list-of-application-resource-representations-each-representingan-application-within-your-a", "x-api-path-slug"=>"accountsaccountsidapplications-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}, "post"=>{"summary"=>"Add Applications", "description"=>"Add Applications", "operationId"=>"creates-a-new-application-within-your-account", "x-api-path-slug"=>"accountsaccountsidapplications-format-post", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/Accounts/{AccountSid}/AuthorizedConnectApps/{ConnectAppSid}.{format}"=>{"get"=>{"summary"=>"Get Authorized Connected App", "description"=>"Get the properties of the authorized application.", "operationId"=>"get-the-properties-of-the-authorized-application", "x-api-path-slug"=>"accountsaccountsidauthorizedconnectappsconnectappsid-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"ConnectAppSid", "description"=>"A 34 character string that uniquely identifies the connected app"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/Accounts/{AccountSid}/AuthorizedConnectApps.{format}"=>{"get"=>{"summary"=>"Get Authorized Connected Apps", "description"=>"Returns a list of Connect App resource representations, each representing anConnect App youve authorized to access your account. The list includesnpaging information.n", "operationId"=>"returns-a-list-of-connect-app-resource-representations-each-representing-aconnect-app-youve-authoriz", "x-api-path-slug"=>"accountsaccountsidauthorizedconnectapps-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/Local.{format}"=>{"get"=>{"summary"=>"Get Available Local Phone Numbers", "description"=>"Returns a list of local AvailablePhoneNumber resource representationsnthat match the specified filters, each representing a phone number thanis currently available for provisioning within your account.n", "operationId"=>"returns-a-list-of-local-availablephonenumber-resource-representationsthat-match-the-specified-filter", "x-api-path-slug"=>"accountsaccountsidavailablephonenumbersisocountrycodelocal-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"IsoCountryCode", "description"=>"ISO 3166-1 alpha-2"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Phone Numbers"]}}, "/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/Mobile.{format}"=>{"get"=>{"summary"=>"Get Available Mobile Phone Numbers", "description"=>"Returns a list of mobile AvailablePhoneNumber resource representations that match the specified filters, each representing a phone number that is currently available for provisioning within your account.", "operationId"=>"returns-a-list-of-mobile-availablephonenumber-resource-representations-that-match-the-specified-filt", "x-api-path-slug"=>"accountsaccountsidavailablephonenumbersisocountrycodemobile-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"IsoCountryCode", "description"=>"ISO 3166-1 alpha-2"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Phone Numbers"]}}, "/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/TollFree.{format}"=>{"get"=>{"summary"=>"Get Available Toll Free Phone Numbers", "description"=>"Returns a list of toll-free AvailablePhoneNumber elements that match thenspecified filters, each representing a phone number that is currentlynavailable for provisioning within your account. To provision an availablenphone number, POST the number to the IncomingPhoneNumbers resource.n", "operationId"=>"returns-a-list-of-tollfree-availablephonenumber-elements-that-match-thespecified-filters-each-repres", "x-api-path-slug"=>"accountsaccountsidavailablephonenumbersisocountrycodetollfree-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}, {"in"=>"path", "name"=>"IsoCountryCode", "description"=>"ISO 3166-1 alpha-2"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Phone Numbers"]}}, "/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.{format}"=>{"get"=>{"summary"=>"Get Recordings", "description"=>"Returns a list of Recording resource representations, each representing anrecording generated during the course of a phone call.n", "operationId"=>"returns-a-list-of-recording-resource-representations-each-representing-arecording-generated-during-t", "x-api-path-slug"=>"accountsaccountsidcallscallsidrecordings-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"CallSid", "description"=>"A 34 character string that uniquely identifies the call"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Recordings"]}}, "/Accounts/{AccountSid}/Calls/{CallSid}.{format}"=>{"get"=>{"summary"=>"Get Call", "description"=>"Get Call", "operationId"=>"getCall", "x-api-path-slug"=>"accountsaccountsidcallscallsid-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"CallSid", "description"=>"A 34 character string that uniquely identifies the call"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls"]}}, "/Accounts/{AccountSid}/Calls.{format}"=>{"get"=>{"summary"=>"Get Calls", "description"=>"Get Calls", "operationId"=>"getCalls", "x-api-path-slug"=>"accountsaccountsidcalls-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls"]}, "post"=>{"summary"=>"Make Call", "description"=>"To make a call, make an HTTP POST request. Initiate a new phone call.", "operationId"=>"to-make-a-call-make-an-http-post-request-initiate-a-new-phone-call", "x-api-path-slug"=>"accountsaccountsidcalls-format-post", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Calls"]}}, "/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.{format}"=>{"delete"=>{"summary"=>"Delete Conference Call Participants", "description"=>"Kick this participant from the conference.", "operationId"=>"kick-this-participant-from-the-conference", "x-api-path-slug"=>"accountsaccountsidconferencesconferencesidparticipantscallsid-format-delete", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"CallSid", "description"=>"A 34 character string that uniquely identifies the call"}, {"in"=>"path", "name"=>"ConferenceSid", "description"=>"A 34 character string that uniquely identifies the conference call object"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conference Calls"]}, "post"=>{"summary"=>"Add Conference Call Participants", "description"=>"Updates the status of a participant.", "operationId"=>"updates-the-status-of-a-participant", "x-api-path-slug"=>"accountsaccountsidconferencesconferencesidparticipantscallsid-format-post", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"CallSid", "description"=>"A 34 character string that uniquely identifies the call"}, {"in"=>"path", "name"=>"ConferenceSid", "description"=>"A 34 character string that uniquely identifies the conference call object"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conference Calls"]}, "get"=>{"summary"=>"GetParticipantForConference", "description"=>"GetParticipantForConference", "operationId"=>"getparticipantforconference", "x-api-path-slug"=>"accountsaccountsidconferencesconferencesidparticipantscallsid-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"CallSid", "description"=>"A 34 character string that uniquely identifies the call"}, {"in"=>"path", "name"=>"ConferenceSid", "description"=>"A 34 character string that uniquely identifies the conference call object"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conferences"]}}, "/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.{format}"=>{"get"=>{"summary"=>"Get Conference Call Participants", "description"=>"Returns the list of participants in the conference identified byn{ConferenceSid}.n", "operationId"=>"returns-the-list-of-participants-in-the-conference-identified-byconferencesid", "x-api-path-slug"=>"accountsaccountsidconferencesconferencesidparticipants-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"ConferenceSid", "description"=>"A 34 character string that uniquely identifies the conference call object"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conference Calls"]}}, "/Accounts/{AccountSid}/Conferences.{format}"=>{"get"=>{"summary"=>"Get Conference Calls", "description"=>"Returns a list of conferences within an account. The list includes pagingninformation.n", "operationId"=>"returns-a-list-of-conferences-within-an-account-the-list-includes-paginginformation", "x-api-path-slug"=>"accountsaccountsidconferences-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conference Calls"]}}, "/Accounts/{AccountSid}/Conferences/{ConferenceSid}.{format}"=>{"get"=>{"summary"=>"Get Conference", "description"=>"Get Conference", "operationId"=>"getConference", "x-api-path-slug"=>"accountsaccountsidconferencesconferencesid-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"ConferenceSid", "description"=>"A 34 character string that uniquely identifies the conference call object"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Conferences"]}}, "/Accounts/{AccountSid}/ConnectApps/{ConnectAppSid}.{format}"=>{"get"=>{"summary"=>"Get Connected App", "description"=>"Get the properties of a Connect App.", "operationId"=>"get-the-properties-of-a-connect-app", "x-api-path-slug"=>"accountsaccountsidconnectappsconnectappsid-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"ConnectAppSid", "description"=>"A 34 character string that uniquely identifies the connected app"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}, "post"=>{"summary"=>"Add Connected App", "description"=>"Tries to update the Connect Apps properties, and returns the updatednresource representation if successful. The returned response is identicalnto that returned above when making a GET request.n", "operationId"=>"tries-to-update-the-connect-apps-properties-and-returns-the-updatedresource-representation-if-succes", "x-api-path-slug"=>"accountsaccountsidconnectappsconnectappsid-format-post", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"ConnectAppSid", "description"=>"A 34 character string that uniquely identifies the connected app"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/Accounts/{AccountSid}/ConnectApps.{format}"=>{"get"=>{"summary"=>"Get Connected Apps", "description"=>"Returns a list of Connect App resource representations, each representingna Connect App in your account. The list includes paging information.n", "operationId"=>"returns-a-list-of-connect-app-resource-representations-each-representinga-connect-app-in-your-accoun", "x-api-path-slug"=>"accountsaccountsidconnectapps-format-get", "parameters"=>[{"in"=>"path", "name"=>"AccountSid", "description"=>"The ID for the Twilio account"}, {"in"=>"path", "name"=>"format", "description"=>"By default, Twilios REST API returns XML", "type"=>"string", "format"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Applications"]}}, "/Accounts/{AccountSid}/IncomingPhoneNumbers/Local.{format}"=>{"get"=>{"summary"=>"Get Incoming Local Phone Numbers", "description"=>"Returns a list of local |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-compute-engine{"google-compute-engine-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Compute Engine", "x-complete"=>1, "info"=>{"title"=>"Compute Engine", "description"=>"creates-and-runs-virtual-machines-on-google-cloud-platform-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"www.googleapis.com", "basePath"=>"/compute/v1/projects", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{project}"=>{"get"=>{"summary"=>"Get Project", "description"=>"Returns the specified Project resource.", "operationId"=>"compute.projects.get", "x-api-path-slug"=>"project-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Project"]}}, "/{project}/aggregated/addresses"=>{"get"=>{"summary"=>"Get Addresses", "description"=>"Retrieves an aggregated list of addresses.", "operationId"=>"compute.addresses.aggregatedList", "x-api-path-slug"=>"projectaggregatedaddresses-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address", "Aggregation"]}}, "/{project}/aggregated/autoscalers"=>{"get"=>{"summary"=>"Get Autoscalers", "description"=>"Retrieves an aggregated list of autoscalers.", "operationId"=>"compute.autoscalers.aggregatedList", "x-api-path-slug"=>"projectaggregatedautoscalers-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaler", "Aggregation"]}}, "/{project}/aggregated/backendServices"=>{"get"=>{"summary"=>"Get Backend services", "description"=>"Retrieves the list of all BackendService resources, regional and global, available to the specified project.", "operationId"=>"compute.backendServices.aggregatedList", "x-api-path-slug"=>"projectaggregatedbackendservices-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Name of the project scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Service", "Aggregation"]}}, "/{project}/aggregated/diskTypes"=>{"get"=>{"summary"=>"Get Disk Type", "description"=>"Retrieves an aggregated list of disk types.", "operationId"=>"compute.diskTypes.aggregatedList", "x-api-path-slug"=>"projectaggregateddisktypes-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disk", "Aggregation"]}}, "/{project}/aggregated/disks"=>{"get"=>{"summary"=>"Get Disks", "description"=>"Retrieves an aggregated list of persistent disks.", "operationId"=>"compute.disks.aggregatedList", "x-api-path-slug"=>"projectaggregateddisks-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disk", "Aggregation"]}}, "/{project}/aggregated/forwardingRules"=>{"get"=>{"summary"=>"Get Forwarding Rules", "description"=>"Retrieves an aggregated list of forwarding rules.", "operationId"=>"compute.forwardingRules.aggregatedList", "x-api-path-slug"=>"projectaggregatedforwardingrules-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forwarding Rules", "Aggregation"]}}, "/{project}/aggregated/instanceGroupManagers"=>{"get"=>{"summary"=>"Get Instance Group Managers", "description"=>"Retrieves the list of managed instance groups and groups them by zone.", "operationId"=>"compute.instanceGroupManagers.aggregatedList", "x-api-path-slug"=>"projectaggregatedinstancegroupmanagers-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group"]}}, "/{project}/aggregated/instanceGroups"=>{"get"=>{"summary"=>"Get Instance Groups", "description"=>"Retrieves the list of instance groups and sorts them by zone.", "operationId"=>"compute.instanceGroups.aggregatedList", "x-api-path-slug"=>"projectaggregatedinstancegroups-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group", "Aggregation"]}}, "/{project}/aggregated/instances"=>{"get"=>{"summary"=>"Get Instances", "description"=>"Retrieves aggregated list of instances.", "operationId"=>"compute.instances.aggregatedList", "x-api-path-slug"=>"projectaggregatedinstances-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance", "Aggregation"]}}, "/{project}/aggregated/machineTypes"=>{"get"=>{"summary"=>"Get Machine Types", "description"=>"Retrieves an aggregated list of machine types.", "operationId"=>"compute.machineTypes.aggregatedList", "x-api-path-slug"=>"projectaggregatedmachinetypes-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine", "Aggregation"]}}, "/{project}/aggregated/operations"=>{"get"=>{"summary"=>"Get Operations", "description"=>"Retrieves an aggregated list of all operations.", "operationId"=>"compute.globalOperations.aggregatedList", "x-api-path-slug"=>"projectaggregatedoperations-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation", "Aggregation"]}}, "/{project}/aggregated/routers"=>{"get"=>{"summary"=>"Get Routers", "description"=>"Retrieves an aggregated list of routers.", "operationId"=>"compute.routers.aggregatedList", "x-api-path-slug"=>"projectaggregatedrouters-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Router", "Aggregation"]}}, "/{project}/aggregated/subnetworks"=>{"get"=>{"summary"=>"Get Subnetworks", "description"=>"Retrieves an aggregated list of subnetworks.", "operationId"=>"compute.subnetworks.aggregatedList", "x-api-path-slug"=>"projectaggregatedsubnetworks-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnetwork", "Aggregation"]}}, "/{project}/aggregated/targetInstances"=>{"get"=>{"summary"=>"Get Target Instances", "description"=>"Retrieves an aggregated list of target instances.", "operationId"=>"compute.targetInstances.aggregatedList", "x-api-path-slug"=>"projectaggregatedtargetinstances-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Instance", "Aggregation"]}}, "/{project}/aggregated/targetPools"=>{"get"=>{"summary"=>"Get Target Pools", "description"=>"Retrieves an aggregated list of target pools.", "operationId"=>"compute.targetPools.aggregatedList", "x-api-path-slug"=>"projectaggregatedtargetpools-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Pools", "Aggregation"]}}, "/{project}/aggregated/targetVpnGateways"=>{"get"=>{"summary"=>"Get Target VPN Gateways", "description"=>"Retrieves an aggregated list of target VPN gateways.", "operationId"=>"compute.targetVpnGateways.aggregatedList", "x-api-path-slug"=>"projectaggregatedtargetvpngateways-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target VPN Gateway", "Aggregation"]}}, "/{project}/aggregated/vpnTunnels"=>{"get"=>{"summary"=>"Get VPN Tunnels", "description"=>"Retrieves an aggregated list of VPN tunnels.", "operationId"=>"compute.vpnTunnels.aggregatedList", "x-api-path-slug"=>"projectaggregatedvpntunnels-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPN Tunnel"]}}, "/{project}/global/addresses"=>{"get"=>{"summary"=>"Get Global Addreses", "description"=>"Retrieves a list of global addresses.", "operationId"=>"compute.globalAddresses.list", "x-api-path-slug"=>"projectglobaladdresses-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address"]}, "post"=>{"summary"=>"Add Address", "description"=>"Creates an address resource in the specified project using the data included in the request.", "operationId"=>"compute.globalAddresses.insert", "x-api-path-slug"=>"projectglobaladdresses-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address"]}}, "/{project}/global/addresses/{address}"=>{"delete"=>{"summary"=>"Delete Address", "description"=>"Deletes the specified address resource.", "operationId"=>"compute.globalAddresses.delete", "x-api-path-slug"=>"projectglobaladdressesaddress-delete", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Name of the address resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address"]}, "get"=>{"summary"=>"Get Address", "description"=>"Returns the specified address resource. Get a list of available addresses by making a list() request.", "operationId"=>"compute.globalAddresses.get", "x-api-path-slug"=>"projectglobaladdressesaddress-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Name of the address resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Address"]}}, "/{project}/global/backendBuckets"=>{"get"=>{"summary"=>"Get Backend Buckets", "description"=>"Retrieves the list of BackendBucket resources available to the specified project.", "operationId"=>"compute.backendBuckets.list", "x-api-path-slug"=>"projectglobalbackendbuckets-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Bucket"]}, "post"=>{"summary"=>"Create Backend Buckets", "description"=>"Creates a BackendBucket resource in the specified project using the data included in the request.", "operationId"=>"compute.backendBuckets.insert", "x-api-path-slug"=>"projectglobalbackendbuckets-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Bucket"]}}, "/{project}/global/backendBuckets/{backendBucket}"=>{"delete"=>{"summary"=>"Delete Backend Bucket", "description"=>"Deletes the specified BackendBucket resource.", "operationId"=>"compute.backendBuckets.delete", "x-api-path-slug"=>"projectglobalbackendbucketsbackendbucket-delete", "parameters"=>[{"in"=>"path", "name"=>"backendBucket", "description"=>"Name of the BackendBucket resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Bucket"]}, "get"=>{"summary"=>"Create Backend Bucket", "description"=>"Returns the specified BackendBucket resource. Get a list of available backend buckets by making a list() request.", "operationId"=>"compute.backendBuckets.get", "x-api-path-slug"=>"projectglobalbackendbucketsbackendbucket-get", "parameters"=>[{"in"=>"path", "name"=>"backendBucket", "description"=>"Name of the BackendBucket resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Bucket"]}, "patch"=>{"summary"=>"Update Backend Bucket", "description"=>"Updates the specified BackendBucket resource with the data included in the request. This method supports patch semantics.", "operationId"=>"compute.backendBuckets.patch", "x-api-path-slug"=>"projectglobalbackendbucketsbackendbucket-patch", "parameters"=>[{"in"=>"path", "name"=>"backendBucket", "description"=>"Name of the BackendBucket resource to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Bucket"]}, "put"=>{"summary"=>"Update Backend Bucket", "description"=>"Updates the specified BackendBucket resource with the data included in the request.", "operationId"=>"compute.backendBuckets.update", "x-api-path-slug"=>"projectglobalbackendbucketsbackendbucket-put", "parameters"=>[{"in"=>"path", "name"=>"backendBucket", "description"=>"Name of the BackendBucket resource to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Bucket"]}}, "/{project}/global/backendServices"=>{"get"=>{"summary"=>"Get Backend Services", "description"=>"Retrieves the list of BackendService resources available to the specified project.", "operationId"=>"compute.backendServices.list", "x-api-path-slug"=>"projectglobalbackendservices-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Service"]}, "post"=>{"summary"=>"Create Backend Service", "description"=>"Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.", "operationId"=>"compute.backendServices.insert", "x-api-path-slug"=>"projectglobalbackendservices-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Service"]}}, "/{project}/global/backendServices/{backendService}"=>{"delete"=>{"summary"=>"Delete Backend Service", "description"=>"Deletes the specified BackendService resource.", "operationId"=>"compute.backendServices.delete", "x-api-path-slug"=>"projectglobalbackendservicesbackendservice-delete", "parameters"=>[{"in"=>"path", "name"=>"backendService", "description"=>"Name of the BackendService resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Service"]}, "get"=>{"summary"=>"Get Backend Service", "description"=>"Returns the specified BackendService resource. Get a list of available backend services by making a list() request.", "operationId"=>"compute.backendServices.get", "x-api-path-slug"=>"projectglobalbackendservicesbackendservice-get", "parameters"=>[{"in"=>"path", "name"=>"backendService", "description"=>"Name of the BackendService resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Service"]}, "patch"=>{"summary"=>"Update Backend Service", "description"=>"Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.", "operationId"=>"compute.backendServices.patch", "x-api-path-slug"=>"projectglobalbackendservicesbackendservice-patch", "parameters"=>[{"in"=>"path", "name"=>"backendService", "description"=>"Name of the BackendService resource to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Service"]}, "put"=>{"summary"=>"Update Backend Service", "description"=>"Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.", "operationId"=>"compute.backendServices.update", "x-api-path-slug"=>"projectglobalbackendservicesbackendservice-put", "parameters"=>[{"in"=>"path", "name"=>"backendService", "description"=>"Name of the BackendService resource to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Service"]}}, "/{project}/global/backendServices/{backendService}/getHealth"=>{"post"=>{"summary"=>"Get Backend Service Health Check", "description"=>"Gets the most recent health check results for this BackendService.", "operationId"=>"compute.backendServices.getHealth", "x-api-path-slug"=>"projectglobalbackendservicesbackendservicegethealth-post", "parameters"=>[{"in"=>"path", "name"=>"backendService", "description"=>"Name of the BackendService resource to which the queried instance belongs"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Service"]}}, "/{project}/global/firewalls"=>{"get"=>{"summary"=>"Get Firewalls", "description"=>"Retrieves the list of firewall rules available to the specified project.", "operationId"=>"compute.firewalls.list", "x-api-path-slug"=>"projectglobalfirewalls-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall"]}, "post"=>{"summary"=>"Create Firewall", "description"=>"Creates a firewall rule in the specified project using the data included in the request.", "operationId"=>"compute.firewalls.insert", "x-api-path-slug"=>"projectglobalfirewalls-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall"]}}, "/{project}/global/firewalls/{firewall}"=>{"delete"=>{"summary"=>"Delete Firewall", "description"=>"Deletes the specified firewall.", "operationId"=>"compute.firewalls.delete", "x-api-path-slug"=>"projectglobalfirewallsfirewall-delete", "parameters"=>[{"in"=>"path", "name"=>"firewall", "description"=>"Name of the firewall rule to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall"]}, "get"=>{"summary"=>"Get Firewall", "description"=>"Returns the specified firewall.", "operationId"=>"compute.firewalls.get", "x-api-path-slug"=>"projectglobalfirewallsfirewall-get", "parameters"=>[{"in"=>"path", "name"=>"firewall", "description"=>"Name of the firewall rule to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall"]}, "patch"=>{"summary"=>"Update Firewall", "description"=>"Updates the specified firewall rule with the data included in the request. This method supports patch semantics.", "operationId"=>"compute.firewalls.patch", "x-api-path-slug"=>"projectglobalfirewallsfirewall-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"firewall", "description"=>"Name of the firewall rule to update"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall"]}, "put"=>{"summary"=>"Update Firewall", "description"=>"Updates the specified firewall rule with the data included in the request.", "operationId"=>"compute.firewalls.update", "x-api-path-slug"=>"projectglobalfirewallsfirewall-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"firewall", "description"=>"Name of the firewall rule to update"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Firewall"]}}, "/{project}/global/forwardingRules"=>{"get"=>{"summary"=>"Get Forwarding Rules", "description"=>"Retrieves a list of ForwardingRule resources available to the specified project.", "operationId"=>"compute.globalForwardingRules.list", "x-api-path-slug"=>"projectglobalforwardingrules-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forward Rule"]}, "post"=>{"summary"=>"Create Forwarding Rule", "description"=>"Creates a ForwardingRule resource in the specified project and region using the data included in the request.", "operationId"=>"compute.globalForwardingRules.insert", "x-api-path-slug"=>"projectglobalforwardingrules-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forward Rule"]}}, "/{project}/global/forwardingRules/{forwardingRule}"=>{"delete"=>{"summary"=>"Delete Forwarding Rule", "description"=>"Deletes the specified ForwardingRule resource.", "operationId"=>"compute.globalForwardingRules.delete", "x-api-path-slug"=>"projectglobalforwardingrulesforwardingrule-delete", "parameters"=>[{"in"=>"path", "name"=>"forwardingRule", "description"=>"Name of the ForwardingRule resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forward Rule"]}, "get"=>{"summary"=>"Get Forwarding Rule", "description"=>"Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.", "operationId"=>"compute.globalForwardingRules.get", "x-api-path-slug"=>"projectglobalforwardingrulesforwardingrule-get", "parameters"=>[{"in"=>"path", "name"=>"forwardingRule", "description"=>"Name of the ForwardingRule resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forward Rule"]}}, "/{project}/global/forwardingRules/{forwardingRule}/setTarget"=>{"post"=>{"summary"=>"Update Forwarding Rule", "description"=>"Changes target URL for forwarding rule. The new target should be of the same type as the old target.", "operationId"=>"compute.globalForwardingRules.setTarget", "x-api-path-slug"=>"projectglobalforwardingrulesforwardingrulesettarget-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"forwardingRule", "description"=>"Name of the ForwardingRule resource in which target is to be set"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forward Rule"]}}, "/{project}/global/healthChecks"=>{"get"=>{"summary"=>"Get Health Checks", "description"=>"Retrieves the list of HealthCheck resources available to the specified project.", "operationId"=>"compute.healthChecks.list", "x-api-path-slug"=>"projectglobalhealthchecks-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}, "post"=>{"summary"=>"Create Health Check", "description"=>"Creates a HealthCheck resource in the specified project using the data included in the request.", "operationId"=>"compute.healthChecks.insert", "x-api-path-slug"=>"projectglobalhealthchecks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}}, "/{project}/global/healthChecks/{healthCheck}"=>{"delete"=>{"summary"=>"Delete Health Check", "description"=>"Deletes the specified HealthCheck resource.", "operationId"=>"compute.healthChecks.delete", "x-api-path-slug"=>"projectglobalhealthcheckshealthcheck-delete", "parameters"=>[{"in"=>"path", "name"=>"healthCheck", "description"=>"Name of the HealthCheck resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}, "get"=>{"summary"=>"Get Health Check", "description"=>"Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.", "operationId"=>"compute.healthChecks.get", "x-api-path-slug"=>"projectglobalhealthcheckshealthcheck-get", "parameters"=>[{"in"=>"path", "name"=>"healthCheck", "description"=>"Name of the HealthCheck resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}, "patch"=>{"summary"=>"Update Health Check", "description"=>"Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.", "operationId"=>"compute.healthChecks.patch", "x-api-path-slug"=>"projectglobalhealthcheckshealthcheck-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"healthCheck", "description"=>"Name of the HealthCheck resource to update"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}, "put"=>{"summary"=>"Update Health Check", "description"=>"Updates a HealthCheck resource in the specified project using the data included in the request.", "operationId"=>"compute.healthChecks.update", "x-api-path-slug"=>"projectglobalhealthcheckshealthcheck-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"healthCheck", "description"=>"Name of the HealthCheck resource to update"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}}, "/{project}/global/httpHealthChecks"=>{"get"=>{"summary"=>"Get HTTP Health Checks", "description"=>"Retrieves the list of HttpHealthCheck resources available to the specified project.", "operationId"=>"compute.httpHealthChecks.list", "x-api-path-slug"=>"projectglobalhttphealthchecks-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}, "post"=>{"summary"=>"Create HTTP Health Check", "description"=>"Creates a HttpHealthCheck resource in the specified project using the data included in the request.", "operationId"=>"compute.httpHealthChecks.insert", "x-api-path-slug"=>"projectglobalhttphealthchecks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}}, "/{project}/global/httpHealthChecks/{httpHealthCheck}"=>{"delete"=>{"summary"=>"Delete HTTP Health Check", "description"=>"Deletes the specified HttpHealthCheck resource.", "operationId"=>"compute.httpHealthChecks.delete", "x-api-path-slug"=>"projectglobalhttphealthcheckshttphealthcheck-delete", "parameters"=>[{"in"=>"path", "name"=>"httpHealthCheck", "description"=>"Name of the HttpHealthCheck resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}, "get"=>{"summary"=>"Create HTTP Health Check", "description"=>"Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.", "operationId"=>"compute.httpHealthChecks.get", "x-api-path-slug"=>"projectglobalhttphealthcheckshttphealthcheck-get", "parameters"=>[{"in"=>"path", "name"=>"httpHealthCheck", "description"=>"Name of the HttpHealthCheck resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}, "patch"=>{"summary"=>"Update HTTP Health Check", "description"=>"Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.", "operationId"=>"compute.httpHealthChecks.patch", "x-api-path-slug"=>"projectglobalhttphealthcheckshttphealthcheck-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"httpHealthCheck", "description"=>"Name of the HttpHealthCheck resource to update"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}, "put"=>{"summary"=>"Update HTTP Health Check", "description"=>"Updates a HttpHealthCheck resource in the specified project using the data included in the request.", "operationId"=>"compute.httpHealthChecks.update", "x-api-path-slug"=>"projectglobalhttphealthcheckshttphealthcheck-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"httpHealthCheck", "description"=>"Name of the HttpHealthCheck resource to update"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}}, "/{project}/global/httpsHealthChecks"=>{"get"=>{"summary"=>"Get HTTPS Health Checks", "description"=>"Retrieves the list of HttpsHealthCheck resources available to the specified project.", "operationId"=>"compute.httpsHealthChecks.list", "x-api-path-slug"=>"projectglobalhttpshealthchecks-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}, "post"=>{"summary"=>"Create HTTPS Health Check", "description"=>"Creates a HttpsHealthCheck resource in the specified project using the data included in the request.", "operationId"=>"compute.httpsHealthChecks.insert", "x-api-path-slug"=>"projectglobalhttpshealthchecks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}}, "/{project}/global/httpsHealthChecks/{httpsHealthCheck}"=>{"delete"=>{"summary"=>"Delete HTTPS Health Check", "description"=>"Deletes the specified HttpsHealthCheck resource.", "operationId"=>"compute.httpsHealthChecks.delete", "x-api-path-slug"=>"projectglobalhttpshealthcheckshttpshealthcheck-delete", "parameters"=>[{"in"=>"path", "name"=>"httpsHealthCheck", "description"=>"Name of the HttpsHealthCheck resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}, "get"=>{"summary"=>"Get HTTPS Health Check", "description"=>"Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.", "operationId"=>"compute.httpsHealthChecks.get", "x-api-path-slug"=>"projectglobalhttpshealthcheckshttpshealthcheck-get", "parameters"=>[{"in"=>"path", "name"=>"httpsHealthCheck", "description"=>"Name of the HttpsHealthCheck resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}, "patch"=>{"summary"=>"Update HTTPS Health Check", "description"=>"Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.", "operationId"=>"compute.httpsHealthChecks.patch", "x-api-path-slug"=>"projectglobalhttpshealthcheckshttpshealthcheck-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"httpsHealthCheck", "description"=>"Name of the HttpsHealthCheck resource to update"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}, "put"=>{"summary"=>"Update HTTPS Health Check", "description"=>"Updates a HttpsHealthCheck resource in the specified project using the data included in the request.", "operationId"=>"compute.httpsHealthChecks.update", "x-api-path-slug"=>"projectglobalhttpshealthcheckshttpshealthcheck-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"httpsHealthCheck", "description"=>"Name of the HttpsHealthCheck resource to update"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Checks", "Health"]}}, "/{project}/global/images"=>{"get"=>{"summary"=>"Get Images", "description"=>"Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.", "operationId"=>"compute.images.list", "x-api-path-slug"=>"projectglobalimages-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image"]}, "post"=>{"summary"=>"Create Image", "description"=>"Creates an image in the specified project using the data included in the request.", "operationId"=>"compute.images.insert", "x-api-path-slug"=>"projectglobalimages-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image"]}}, "/{project}/global/images/family/{family}"=>{"get"=>{"summary"=>"Create Image Family", "description"=>"Returns the latest image that is part of an image family and is not deprecated.", "operationId"=>"compute.images.getFromFamily", "x-api-path-slug"=>"projectglobalimagesfamilyfamily-get", "parameters"=>[{"in"=>"path", "name"=>"family", "description"=>"Name of the image family to search for"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image"]}}, "/{project}/global/images/{image}"=>{"delete"=>{"summary"=>"Delete Image", "description"=>"Deletes the specified image.", "operationId"=>"compute.images.delete", "x-api-path-slug"=>"projectglobalimagesimage-delete", "parameters"=>[{"in"=>"path", "name"=>"image", "description"=>"Name of the image resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image"]}, "get"=>{"summary"=>"Get Image", "description"=>"Returns the specified image. Get a list of available images by making a list() request.", "operationId"=>"compute.images.get", "x-api-path-slug"=>"projectglobalimagesimage-get", "parameters"=>[{"in"=>"path", "name"=>"image", "description"=>"Name of the image resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image"]}}, "/{project}/global/images/{image}/deprecate"=>{"post"=>{"summary"=>"Deprecate Image", "description"=>"Sets the deprecation status of an image.\n\nIf an empty request body is given, clears the deprecation status instead.", "operationId"=>"compute.images.deprecate", "x-api-path-slug"=>"projectglobalimagesimagedeprecate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"image", "description"=>"Image name"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Image"]}}, "/{project}/global/instanceTemplates"=>{"get"=>{"summary"=>"Get Instance Templates", "description"=>"Retrieves a list of instance templates that are contained within the specified project and zone.", "operationId"=>"compute.instanceTemplates.list", "x-api-path-slug"=>"projectglobalinstancetemplates-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Template"]}, "post"=>{"summary"=>"Create Instance Template", "description"=>"Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.", "operationId"=>"compute.instanceTemplates.insert", "x-api-path-slug"=>"projectglobalinstancetemplates-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Template"]}}, "/{project}/global/instanceTemplates/{instanceTemplate}"=>{"delete"=>{"summary"=>"Delete Instance Templates", "description"=>"Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.", "operationId"=>"compute.instanceTemplates.delete", "x-api-path-slug"=>"projectglobalinstancetemplatesinstancetemplate-delete", "parameters"=>[{"in"=>"path", "name"=>"instanceTemplate", "description"=>"The name of the instance template to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Template"]}, "get"=>{"summary"=>"Get Instance Template", "description"=>"Returns the specified instance template. Get a list of available instance templates by making a list() request.", "operationId"=>"compute.instanceTemplates.get", "x-api-path-slug"=>"projectglobalinstancetemplatesinstancetemplate-get", "parameters"=>[{"in"=>"path", "name"=>"instanceTemplate", "description"=>"The name of the instance template"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Template"]}}, "/{project}/global/licenses/{license}"=>{"get"=>{"summary"=>"Get License", "description"=>"Returns the specified License resource. Get a list of available licenses by making a list() request.", "operationId"=>"compute.licenses.get", "x-api-path-slug"=>"projectgloballicenseslicense-get", "parameters"=>[{"in"=>"path", "name"=>"license", "description"=>"Name of the License resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["License"]}}, "/{project}/global/networks"=>{"get"=>{"summary"=>"Get Networks", "description"=>"Retrieves the list of networks available to the specified project.", "operationId"=>"compute.networks.list", "x-api-path-slug"=>"projectglobalnetworks-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network"]}, "post"=>{"summary"=>"Create Network", "description"=>"Creates a network in the specified project using the data included in the request.", "operationId"=>"compute.networks.insert", "x-api-path-slug"=>"projectglobalnetworks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network"]}}, "/{project}/global/networks/{network}"=>{"delete"=>{"summary"=>"Delete Network", "description"=>"Deletes the specified network.", "operationId"=>"compute.networks.delete", "x-api-path-slug"=>"projectglobalnetworksnetwork-delete", "parameters"=>[{"in"=>"path", "name"=>"network", "description"=>"Name of the network to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network"]}, "get"=>{"summary"=>"Get Network", "description"=>"Returns the specified network. Get a list of available networks by making a list() request.", "operationId"=>"compute.networks.get", "x-api-path-slug"=>"projectglobalnetworksnetwork-get", "parameters"=>[{"in"=>"path", "name"=>"network", "description"=>"Name of the network to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network"]}}, "/{project}/global/networks/{network}/switchToCustomMode"=>{"post"=>{"summary"=>"Switc hto Network Mode", "description"=>"Switches the network mode from auto subnet mode to custom subnet mode.", "operationId"=>"compute.networks.switchToCustomMode", "x-api-path-slug"=>"projectglobalnetworksnetworkswitchtocustommode-post", "parameters"=>[{"in"=>"path", "name"=>"network", "description"=>"Name of the network to be updated"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Network"]}}, "/{project}/global/operations"=>{"get"=>{"summary"=>"Get Operations", "description"=>"Retrieves a list of Operation resources contained within the specified project.", "operationId"=>"compute.globalOperations.list", "x-api-path-slug"=>"projectglobaloperations-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/{project}/global/operations/{operation}"=>{"delete"=>{"summary"=>"Delete Operation", "description"=>"Deletes the specified Operations resource.", "operationId"=>"compute.globalOperations.delete", "x-api-path-slug"=>"projectglobaloperationsoperation-delete", "parameters"=>[{"in"=>"path", "name"=>"operation", "description"=>"Name of the Operations resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}, "get"=>{"summary"=>"Get Operation", "description"=>"Retrieves the specified Operations resource. Get a list of operations by making a list() request.", "operationId"=>"compute.globalOperations.get", "x-api-path-slug"=>"projectglobaloperationsoperation-get", "parameters"=>[{"in"=>"path", "name"=>"operation", "description"=>"Name of the Operations resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/{project}/global/routes"=>{"get"=>{"summary"=>"Get Routes", "description"=>"Retrieves the list of Route resources available to the specified project.", "operationId"=>"compute.routes.list", "x-api-path-slug"=>"projectglobalroutes-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route"]}, "post"=>{"summary"=>"Create Route", "description"=>"Creates a Route resource in the specified project using the data included in the request.", "operationId"=>"compute.routes.insert", "x-api-path-slug"=>"projectglobalroutes-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route"]}}, "/{project}/global/routes/{route}"=>{"delete"=>{"summary"=>"Delete Route", "description"=>"Deletes the specified Route resource.", "operationId"=>"compute.routes.delete", "x-api-path-slug"=>"projectglobalroutesroute-delete", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"route", "description"=>"Name of the Route resource to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route"]}, "get"=>{"summary"=>"Get Route", "description"=>"Returns the specified Route resource. Get a list of available routes by making a list() request.", "operationId"=>"compute.routes.get", "x-api-path-slug"=>"projectglobalroutesroute-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"route", "description"=>"Name of the Route resource to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Route"]}}, "/{project}/global/snapshots"=>{"get"=>{"summary"=>"Get Snapshots", "description"=>"Retrieves the list of Snapshot resources contained within the specified project.", "operationId"=>"compute.snapshots.list", "x-api-path-slug"=>"projectglobalsnapshots-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshot"]}}, "/{project}/global/snapshots/{snapshot}"=>{"delete"=>{"summary"=>"Delete Snapshot", "description"=>"Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.\n\nFor more information, see Deleting snaphots.", "operationId"=>"compute.snapshots.delete", "x-api-path-slug"=>"projectglobalsnapshotssnapshot-delete", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"snapshot", "description"=>"Name of the Snapshot resource to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshot"]}, "get"=>{"summary"=>"Get Snapshot", "description"=>"Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.", "operationId"=>"compute.snapshots.get", "x-api-path-slug"=>"projectglobalsnapshotssnapshot-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"snapshot", "description"=>"Name of the Snapshot resource to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Snapshot"]}}, "/{project}/global/sslCertificates"=>{"get"=>{"summary"=>"Get SSL Certificates", "description"=>"Retrieves the list of SslCertificate resources available to the specified project.", "operationId"=>"compute.sslCertificates.list", "x-api-path-slug"=>"projectglobalsslcertificates-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate"]}, "post"=>{"summary"=>"Create SSL Certificate", "description"=>"Creates a SslCertificate resource in the specified project using the data included in the request.", "operationId"=>"compute.sslCertificates.insert", "x-api-path-slug"=>"projectglobalsslcertificates-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate"]}}, "/{project}/global/sslCertificates/{sslCertificate}"=>{"delete"=>{"summary"=>"Delete SSL Certificate", "description"=>"Deletes the specified SslCertificate resource.", "operationId"=>"compute.sslCertificates.delete", "x-api-path-slug"=>"projectglobalsslcertificatessslcertificate-delete", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"sslCertificate", "description"=>"Name of the SslCertificate resource to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate"]}, "get"=>{"summary"=>"Get SSL Certificate", "description"=>"Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.", "operationId"=>"compute.sslCertificates.get", "x-api-path-slug"=>"projectglobalsslcertificatessslcertificate-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"sslCertificate", "description"=>"Name of the SslCertificate resource to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate"]}}, "/{project}/global/targetHttpProxies"=>{"get"=>{"summary"=>"Get Target HTTP Proxies", "description"=>"Retrieves the list of TargetHttpProxy resources available to the specified project.", "operationId"=>"compute.targetHttpProxies.list", "x-api-path-slug"=>"projectglobaltargethttpproxies-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy"]}, "post"=>{"summary"=>"Create Target HTTP Proxy", "description"=>"Creates a TargetHttpProxy resource in the specified project using the data included in the request.", "operationId"=>"compute.targetHttpProxies.insert", "x-api-path-slug"=>"projectglobaltargethttpproxies-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy"]}}, "/{project}/global/targetHttpProxies/{targetHttpProxy}"=>{"delete"=>{"summary"=>"Delete Target HTTP Proxy", "description"=>"Deletes the specified TargetHttpProxy resource.", "operationId"=>"compute.targetHttpProxies.delete", "x-api-path-slug"=>"projectglobaltargethttpproxiestargethttpproxy-delete", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"targetHttpProxy", "description"=>"Name of the TargetHttpProxy resource to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy"]}, "get"=>{"summary"=>"Get Target HTTP Proxy", "description"=>"Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.", "operationId"=>"compute.targetHttpProxies.get", "x-api-path-slug"=>"projectglobaltargethttpproxiestargethttpproxy-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"targetHttpProxy", "description"=>"Name of the TargetHttpProxy resource to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy"]}}, "/{project}/global/targetHttpsProxies"=>{"get"=>{"summary"=>"Get Target HTTPS Proxies", "description"=>"Retrieves the list of TargetHttpsProxy resources available to the specified project.", "operationId"=>"compute.targetHttpsProxies.list", "x-api-path-slug"=>"projectglobaltargethttpsproxies-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy"]}, "post"=>{"summary"=>"Create Target HTTPS Proxy", "description"=>"Creates a TargetHttpsProxy resource in the specified project using the data included in the request.", "operationId"=>"compute.targetHttpsProxies.insert", "x-api-path-slug"=>"projectglobaltargethttpsproxies-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy"]}}, "/{project}/global/targetHttpsProxies/{targetHttpsProxy}"=>{"delete"=>{"summary"=>"Delete Target HTTPS Proxy", "description"=>"Deletes the specified TargetHttpsProxy resource.", "operationId"=>"compute.targetHttpsProxies.delete", "x-api-path-slug"=>"projectglobaltargethttpsproxiestargethttpsproxy-delete", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"targetHttpsProxy", "description"=>"Name of the TargetHttpsProxy resource to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy"]}, "get"=>{"summary"=>"Get Target HTTPS Proxy", "description"=>"Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.", "operationId"=>"compute.targetHttpsProxies.get", "x-api-path-slug"=>"projectglobaltargethttpsproxiestargethttpsproxy-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"targetHttpsProxy", "description"=>"Name of the TargetHttpsProxy resource to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy"]}}, "/{project}/global/targetSslProxies"=>{"get"=>{"summary"=>"Get Target SSL Proxies", "description"=>"Retrieves the list of TargetSslProxy resources available to the specified project.", "operationId"=>"compute.targetSslProxies.list", "x-api-path-slug"=>"projectglobaltargetsslproxies-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy"]}, "post"=>{"summary"=>"Create Target SSL Proxy", "description"=>"Creates a TargetSslProxy resource in the specified project using the data included in the request.", "operationId"=>"compute.targetSslProxies.insert", "x-api-path-slug"=>"projectglobaltargetsslproxies-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy"]}}, "/{project}/global/targetSslProxies/{targetSslProxy}"=>{"delete"=>{"summary"=>"Delete Target SSL Proxy", "description"=>"Deletes the specified TargetSslProxy resource.", "operationId"=>"compute.targetSslProxies.delete", "x-api-path-slug"=>"projectglobaltargetsslproxiestargetsslproxy-delete", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"targetSslProxy", "description"=>"Name of the TargetSslProxy resource to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy"]}, "get"=>{"summary"=>"Get Target SSL Proxy", "description"=>"Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.", "operationId"=>"compute.targetSslProxies.get", "x-api-path-slug"=>"projectglobaltargetsslproxiestargetsslproxy-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"targetSslProxy", "description"=>"Name of the TargetSslProxy resource to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy"]}}, "/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService"=>{"post"=>{"summary"=>"Set Backend Service", "description"=>"Changes the BackendService for TargetSslProxy.", "operationId"=>"compute.targetSslProxies.setBackendService", "x-api-path-slug"=>"projectglobaltargetsslproxiestargetsslproxysetbackendservice-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"targetSslProxy", "description"=>"Name of the TargetSslProxy resource whose BackendService resource is to be set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Service"]}}, "/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader"=>{"post"=>{"summary"=>"Set Proxy header Type", "description"=>"Changes the ProxyHeaderType for TargetSslProxy.", "operationId"=>"compute.targetSslProxies.setProxyHeader", "x-api-path-slug"=>"projectglobaltargetsslproxiestargetsslproxysetproxyheader-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"targetSslProxy", "description"=>"Name of the TargetSslProxy resource whose ProxyHeader is to be set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy"]}}, "/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates"=>{"post"=>{"summary"=>"Change SSL Certificate", "description"=>"Changes SslCertificates for TargetSslProxy.", "operationId"=>"compute.targetSslProxies.setSslCertificates", "x-api-path-slug"=>"projectglobaltargetsslproxiestargetsslproxysetsslcertificates-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"targetSslProxy", "description"=>"Name of the TargetSslProxy resource whose SslCertificate resource is to be set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate"]}}, "/{project}/global/urlMaps"=>{"get"=>{"summary"=>"Get URL Maps", "description"=>"Retrieves the list of UrlMap resources available to the specified project.", "operationId"=>"compute.urlMaps.list", "x-api-path-slug"=>"projectglobalurlmaps-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["URL Map"]}, "post"=>{"summary"=>"Create URL Map", "description"=>"Creates a UrlMap resource in the specified project using the data included in the request.", "operationId"=>"compute.urlMaps.insert", "x-api-path-slug"=>"projectglobalurlmaps-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["URL Map"]}}, "/{project}/global/urlMaps/{urlMap}"=>{"delete"=>{"summary"=>"Delete URL Map", "description"=>"Deletes the specified UrlMap resource.", "operationId"=>"compute.urlMaps.delete", "x-api-path-slug"=>"projectglobalurlmapsurlmap-delete", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"urlMap", "description"=>"Name of the UrlMap resource to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["URL Map"]}, "get"=>{"summary"=>"Get URL Map", "description"=>"Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.", "operationId"=>"compute.urlMaps.get", "x-api-path-slug"=>"projectglobalurlmapsurlmap-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"urlMap", "description"=>"Name of the UrlMap resource to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["URL Map"]}, "patch"=>{"summary"=>"Update URL Map", "description"=>"Updates the specified UrlMap resource with the data included in the request. This method supports patch semantics.", "operationId"=>"compute.urlMaps.patch", "x-api-path-slug"=>"projectglobalurlmapsurlmap-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"urlMap", "description"=>"Name of the UrlMap resource to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["URL Map"]}, "put"=>{"summary"=>"Update URL Map", "description"=>"Updates the specified UrlMap resource with the data included in the request.", "operationId"=>"compute.urlMaps.update", "x-api-path-slug"=>"projectglobalurlmapsurlmap-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"urlMap", "description"=>"Name of the UrlMap resource to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["URL Map"]}}, "/{project}/global/urlMaps/{urlMap}/invalidateCache"=>{"post"=>{"summary"=>"Invalidate Cache", "description"=>"Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.", "operationId"=>"compute.urlMaps.invalidateCache", "x-api-path-slug"=>"projectglobalurlmapsurlmapinvalidatecache-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"urlMap", "description"=>"Name of the UrlMap scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cache"]}}, "/{project}/global/urlMaps/{urlMap}/validate"=>{"post"=>{"summary"=>"Run Static Validation", "description"=>"Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.", "operationId"=>"compute.urlMaps.validate", "x-api-path-slug"=>"projectglobalurlmapsurlmapvalidate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"urlMap", "description"=>"Name of the UrlMap resource to be validated as"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Validation"]}}, "/{project}/moveDisk"=>{"post"=>{"summary"=>"Move Disk", "description"=>"Moves a persistent disk from one zone to another.", "operationId"=>"compute.projects.moveDisk", "x-api-path-slug"=>"projectmovedisk-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disk"]}}, "/{project}/moveInstance"=>{"post"=>{"summary"=>"Move Instance", "description"=>"Moves an instance and its attached persistent disks from one zone to another.", "operationId"=>"compute.projects.moveInstance", "x-api-path-slug"=>"projectmoveinstance-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/regions"=>{"get"=>{"summary"=>"Get Regions", "description"=>"Retrieves the list of region resources available to the specified project.", "operationId"=>"compute.regions.list", "x-api-path-slug"=>"projectregions-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Region"]}}, "/{project}/regions/{region}"=>{"get"=>{"summary"=>"Get Region", "description"=>"Returns the specified Region resource. Get a list of available regions by making a list() request.", "operationId"=>"compute.regions.get", "x-api-path-slug"=>"projectregionsregion-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region resource to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Region"]}}, "/{project}/regions/{region}/addresses"=>{"get"=>{"summary"=>"Get Region Addresses", "description"=>"Retrieves a list of addresses contained within the specified region.", "operationId"=>"compute.addresses.list", "x-api-path-slug"=>"projectregionsregionaddresses-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Region Address"]}, "post"=>{"summary"=>"Create Region Address", "description"=>"Creates an address resource in the specified project using the data included in the request.", "operationId"=>"compute.addresses.insert", "x-api-path-slug"=>"projectregionsregionaddresses-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Region Address"]}}, "/{project}/regions/{region}/addresses/{address}"=>{"delete"=>{"summary"=>"Delete Region Address", "description"=>"Deletes the specified address resource.", "operationId"=>"compute.addresses.delete", "x-api-path-slug"=>"projectregionsregionaddressesaddress-delete", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Name of the address resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Region Address"]}, "get"=>{"summary"=>"Get Region Address", "description"=>"Returns the specified address resource.", "operationId"=>"compute.addresses.get", "x-api-path-slug"=>"projectregionsregionaddressesaddress-get", "parameters"=>[{"in"=>"path", "name"=>"address", "description"=>"Name of the address resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Region Address"]}}, "/{project}/regions/{region}/autoscalers"=>{"get"=>{"summary"=>"Get Autoscalers", "description"=>"Retrieves a list of autoscalers contained within the specified region.", "operationId"=>"compute.regionAutoscalers.list", "x-api-path-slug"=>"projectregionsregionautoscalers-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaler"]}, "patch"=>{"summary"=>"Update Autoscaler", "description"=>"Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.", "operationId"=>"compute.regionAutoscalers.patch", "x-api-path-slug"=>"projectregionsregionautoscalers-patch", "parameters"=>[{"in"=>"query", "name"=>"autoscaler", "description"=>"Name of the autoscaler to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaler"]}, "post"=>{"summary"=>"Create Autoscaler", "description"=>"Creates an autoscaler in the specified project using the data included in the request.", "operationId"=>"compute.regionAutoscalers.insert", "x-api-path-slug"=>"projectregionsregionautoscalers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaler"]}, "put"=>{"summary"=>"Update Autoscaler", "description"=>"Updates an autoscaler in the specified project using the data included in the request.", "operationId"=>"compute.regionAutoscalers.update", "x-api-path-slug"=>"projectregionsregionautoscalers-put", "parameters"=>[{"in"=>"query", "name"=>"autoscaler", "description"=>"Name of the autoscaler to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaler"]}}, "/{project}/regions/{region}/autoscalers/{autoscaler}"=>{"delete"=>{"summary"=>"Delete Autoscaler", "description"=>"Deletes the specified autoscaler.", "operationId"=>"compute.regionAutoscalers.delete", "x-api-path-slug"=>"projectregionsregionautoscalersautoscaler-delete", "parameters"=>[{"in"=>"path", "name"=>"autoscaler", "description"=>"Name of the autoscaler to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaler"]}, "get"=>{"summary"=>"Get Autoscaler", "description"=>"Returns the specified autoscaler.", "operationId"=>"compute.regionAutoscalers.get", "x-api-path-slug"=>"projectregionsregionautoscalersautoscaler-get", "parameters"=>[{"in"=>"path", "name"=>"autoscaler", "description"=>"Name of the autoscaler to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaler"]}}, "/{project}/regions/{region}/backendServices"=>{"get"=>{"summary"=>"Get Backend Services", "description"=>"Retrieves the list of regional BackendService resources available to the specified project in the given region.", "operationId"=>"compute.regionBackendServices.list", "x-api-path-slug"=>"projectregionsregionbackendservices-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Service"]}, "post"=>{"summary"=>"Create Backend Service", "description"=>"Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information.", "operationId"=>"compute.regionBackendServices.insert", "x-api-path-slug"=>"projectregionsregionbackendservices-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Service"]}}, "/{project}/regions/{region}/backendServices/{backendService}"=>{"delete"=>{"summary"=>"Delete Backend Service", "description"=>"Deletes the specified regional BackendService resource.", "operationId"=>"compute.regionBackendServices.delete", "x-api-path-slug"=>"projectregionsregionbackendservicesbackendservice-delete", "parameters"=>[{"in"=>"path", "name"=>"backendService", "description"=>"Name of the BackendService resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Service"]}, "get"=>{"summary"=>"Get Backend Service", "description"=>"Returns the specified regional BackendService resource.", "operationId"=>"compute.regionBackendServices.get", "x-api-path-slug"=>"projectregionsregionbackendservicesbackendservice-get", "parameters"=>[{"in"=>"path", "name"=>"backendService", "description"=>"Name of the BackendService resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Service"]}, "patch"=>{"summary"=>"Update Backend Service", "description"=>"Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.", "operationId"=>"compute.regionBackendServices.patch", "x-api-path-slug"=>"projectregionsregionbackendservicesbackendservice-patch", "parameters"=>[{"in"=>"path", "name"=>"backendService", "description"=>"Name of the BackendService resource to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Service"]}, "put"=>{"summary"=>"Update Backend Service", "description"=>"Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.", "operationId"=>"compute.regionBackendServices.update", "x-api-path-slug"=>"projectregionsregionbackendservicesbackendservice-put", "parameters"=>[{"in"=>"path", "name"=>"backendService", "description"=>"Name of the BackendService resource to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Service"]}}, "/{project}/regions/{region}/backendServices/{backendService}/getHealth"=>{"post"=>{"summary"=>"Get Backend Service Health Check", "description"=>"Gets the most recent health check results for this regional BackendService.", "operationId"=>"compute.regionBackendServices.getHealth", "x-api-path-slug"=>"projectregionsregionbackendservicesbackendservicegethealth-post", "parameters"=>[{"in"=>"path", "name"=>"backendService", "description"=>"Name of the BackendService resource to which the queried instance belongs"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Backend Service"]}}, "/{project}/regions/{region}/forwardingRules"=>{"get"=>{"summary"=>"Get Forwarding Rules", "description"=>"Retrieves a list of ForwardingRule resources available to the specified project and region.", "operationId"=>"compute.forwardingRules.list", "x-api-path-slug"=>"projectregionsregionforwardingrules-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forward Rule"]}, "post"=>{"summary"=>"Create Forwarding Rule", "description"=>"Creates a ForwardingRule resource in the specified project and region using the data included in the request.", "operationId"=>"compute.forwardingRules.insert", "x-api-path-slug"=>"projectregionsregionforwardingrules-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forward Rule"]}}, "/{project}/regions/{region}/forwardingRules/{forwardingRule}"=>{"delete"=>{"summary"=>"Delete Forwarding Rule", "description"=>"Deletes the specified ForwardingRule resource.", "operationId"=>"compute.forwardingRules.delete", "x-api-path-slug"=>"projectregionsregionforwardingrulesforwardingrule-delete", "parameters"=>[{"in"=>"path", "name"=>"forwardingRule", "description"=>"Name of the ForwardingRule resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forward Rule"]}, "get"=>{"summary"=>"Get Forwarding Rule", "description"=>"Returns the specified ForwardingRule resource.", "operationId"=>"compute.forwardingRules.get", "x-api-path-slug"=>"projectregionsregionforwardingrulesforwardingrule-get", "parameters"=>[{"in"=>"path", "name"=>"forwardingRule", "description"=>"Name of the ForwardingRule resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forward Rule"]}}, "/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget"=>{"post"=>{"summary"=>"Update Forwarding Rule", "description"=>"Changes target URL for forwarding rule. The new target should be of the same type as the old target.", "operationId"=>"compute.forwardingRules.setTarget", "x-api-path-slug"=>"projectregionsregionforwardingrulesforwardingrulesettarget-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"forwardingRule", "description"=>"Name of the ForwardingRule resource in which target is to be set"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Forward Rule"]}}, "/{project}/regions/{region}/instanceGroupManagers"=>{"get"=>{"summary"=>"Get Instance Group Managers", "description"=>"Retrieves the list of managed instance groups that are contained within the specified region.", "operationId"=>"compute.regionInstanceGroupManagers.list", "x-api-path-slug"=>"projectregionsregioninstancegroupmanagers-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group"]}, "post"=>{"summary"=>"Create Instance Group Manager", "description"=>"Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.", "operationId"=>"compute.regionInstanceGroupManagers.insert", "x-api-path-slug"=>"projectregionsregioninstancegroupmanagers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group"]}}, "/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}"=>{"delete"=>{"summary"=>"Delete Instance Group Manager", "description"=>"Deletes the specified managed instance group and all of the instances in that group.", "operationId"=>"compute.regionInstanceGroupManagers.delete", "x-api-path-slug"=>"projectregionsregioninstancegroupmanagersinstancegroupmanager-delete", "parameters"=>[{"in"=>"path", "name"=>"instanceGroupManager", "description"=>"Name of the managed instance group to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group"]}, "get"=>{"summary"=>"Get Instance Group Manager", "description"=>"Returns all of the details about the specified managed instance group.", "operationId"=>"compute.regionInstanceGroupManagers.get", "x-api-path-slug"=>"projectregionsregioninstancegroupmanagersinstancegroupmanager-get", "parameters"=>[{"in"=>"path", "name"=>"instanceGroupManager", "description"=>"Name of the managed instance group to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group"]}}, "/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances"=>{"post"=>{"summary"=>"Schedule Remove instance", "description"=>"Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.", "operationId"=>"compute.regionInstanceGroupManagers.abandonInstances", "x-api-path-slug"=>"projectregionsregioninstancegroupmanagersinstancegroupmanagerabandoninstances-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instanceGroupManager", "description"=>"Name of the managed instance group"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances"=>{"post"=>{"summary"=>"Schedule Delete instance", "description"=>"Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.", "operationId"=>"compute.regionInstanceGroupManagers.deleteInstances", "x-api-path-slug"=>"projectregionsregioninstancegroupmanagersinstancegroupmanagerdeleteinstances-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instanceGroupManager", "description"=>"Name of the managed instance group"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances"=>{"post"=>{"summary"=>"Get instances", "description"=>"Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.", "operationId"=>"compute.regionInstanceGroupManagers.listManagedInstances", "x-api-path-slug"=>"projectregionsregioninstancegroupmanagersinstancegroupmanagerlistmanagedinstances-post", "parameters"=>[{"in"=>"query", "name"=>"filter"}, {"in"=>"path", "name"=>"instanceGroupManager", "description"=>"The name of the managed instance group"}, {"in"=>"query", "name"=>"maxResults"}, {"in"=>"query", "name"=>"order_by"}, {"in"=>"query", "name"=>"pageToken"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances"=>{"post"=>{"summary"=>"Recreate Instance", "description"=>"Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.", "operationId"=>"compute.regionInstanceGroupManagers.recreateInstances", "x-api-path-slug"=>"projectregionsregioninstancegroupmanagersinstancegroupmanagerrecreateinstances-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instanceGroupManager", "description"=>"Name of the managed instance group"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize"=>{"post"=>{"summary"=>"Resize Instance", "description"=>"Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.", "operationId"=>"compute.regionInstanceGroupManagers.resize", "x-api-path-slug"=>"projectregionsregioninstancegroupmanagersinstancegroupmanagerresize-post", "parameters"=>[{"in"=>"path", "name"=>"instanceGroupManager", "description"=>"Name of the managed instance group"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}, {"in"=>"query", "name"=>"size", "description"=>"Number of instances that should exist in this instance group manager"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate"=>{"post"=>{"summary"=>"Set Instance Template", "description"=>"Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.", "operationId"=>"compute.regionInstanceGroupManagers.setInstanceTemplate", "x-api-path-slug"=>"projectregionsregioninstancegroupmanagersinstancegroupmanagersetinstancetemplate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instanceGroupManager", "description"=>"The name of the managed instance group"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools"=>{"post"=>{"summary"=>"Set Instance Target Pools", "description"=>"Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.", "operationId"=>"compute.regionInstanceGroupManagers.setTargetPools", "x-api-path-slug"=>"projectregionsregioninstancegroupmanagersinstancegroupmanagersettargetpools-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instanceGroupManager", "description"=>"Name of the managed instance group"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/regions/{region}/instanceGroups"=>{"get"=>{"summary"=>"Get Instance Groups", "description"=>"Retrieves the list of instance group resources contained within the specified region.", "operationId"=>"compute.regionInstanceGroups.list", "x-api-path-slug"=>"projectregionsregioninstancegroups-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group"]}}, "/{project}/regions/{region}/instanceGroups/{instanceGroup}"=>{"get"=>{"summary"=>"Get Instance Group", "description"=>"Returns the specified instance group resource.", "operationId"=>"compute.regionInstanceGroups.get", "x-api-path-slug"=>"projectregionsregioninstancegroupsinstancegroup-get", "parameters"=>[{"in"=>"path", "name"=>"instanceGroup", "description"=>"Name of the instance group resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group"]}}, "/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances"=>{"post"=>{"summary"=>"List Instances", "description"=>"Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.", "operationId"=>"compute.regionInstanceGroups.listInstances", "x-api-path-slug"=>"projectregionsregioninstancegroupsinstancegrouplistinstances-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"path", "name"=>"instanceGroup", "description"=>"Name of the regional instance group for which we want to list the instances"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts"=>{"post"=>{"summary"=>"Set Named Portal", "description"=>"Sets the named ports for the specified regional instance group.", "operationId"=>"compute.regionInstanceGroups.setNamedPorts", "x-api-path-slug"=>"projectregionsregioninstancegroupsinstancegroupsetnamedports-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instanceGroup", "description"=>"The name of the regional instance group where the named ports are updated"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group"]}}, "/{project}/regions/{region}/operations"=>{"get"=>{"summary"=>"Get Operations", "description"=>"Retrieves a list of Operation resources contained within the specified region.", "operationId"=>"compute.regionOperations.list", "x-api-path-slug"=>"projectregionsregionoperations-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/{project}/regions/{region}/operations/{operation}"=>{"delete"=>{"summary"=>"Delete Operation", "description"=>"Deletes the specified region-specific Operations resource.", "operationId"=>"compute.regionOperations.delete", "x-api-path-slug"=>"projectregionsregionoperationsoperation-delete", "parameters"=>[{"in"=>"path", "name"=>"operation", "description"=>"Name of the Operations resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}, "get"=>{"summary"=>"Get Operation", "description"=>"Retrieves the specified region-specific Operations resource.", "operationId"=>"compute.regionOperations.get", "x-api-path-slug"=>"projectregionsregionoperationsoperation-get", "parameters"=>[{"in"=>"path", "name"=>"operation", "description"=>"Name of the Operations resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Operation"]}}, "/{project}/regions/{region}/routers"=>{"get"=>{"summary"=>"Get Routers", "description"=>"Retrieves a list of Router resources available to the specified project.", "operationId"=>"compute.routers.list", "x-api-path-slug"=>"projectregionsregionrouters-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Router"]}, "post"=>{"summary"=>"Create Router", "description"=>"Creates a Router resource in the specified project and region using the data included in the request.", "operationId"=>"compute.routers.insert", "x-api-path-slug"=>"projectregionsregionrouters-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Router"]}}, "/{project}/regions/{region}/routers/{router}"=>{"delete"=>{"summary"=>"Delete Router", "description"=>"Deletes the specified Router resource.", "operationId"=>"compute.routers.delete", "x-api-path-slug"=>"projectregionsregionroutersrouter-delete", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}, {"in"=>"path", "name"=>"router", "description"=>"Name of the Router resource to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Router"]}, "get"=>{"summary"=>"Get Router", "description"=>"Returns the specified Router resource. Get a list of available routers by making a list() request.", "operationId"=>"compute.routers.get", "x-api-path-slug"=>"projectregionsregionroutersrouter-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}, {"in"=>"path", "name"=>"router", "description"=>"Name of the Router resource to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Router"]}, "patch"=>{"summary"=>"Update Router", "description"=>"Updates the specified Router resource with the data included in the request. This method supports patch semantics.", "operationId"=>"compute.routers.patch", "x-api-path-slug"=>"projectregionsregionroutersrouter-patch", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}, {"in"=>"path", "name"=>"router", "description"=>"Name of the Router resource to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Router"]}, "put"=>{"summary"=>"Update Router", "description"=>"Updates the specified Router resource with the data included in the request.", "operationId"=>"compute.routers.update", "x-api-path-slug"=>"projectregionsregionroutersrouter-put", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}, {"in"=>"path", "name"=>"router", "description"=>"Name of the Router resource to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Router"]}}, "/{project}/regions/{region}/routers/{router}/getRouterStatus"=>{"get"=>{"summary"=>"Update Router Status", "description"=>"Retrieves runtime information of the specified router.", "operationId"=>"compute.routers.getRouterStatus", "x-api-path-slug"=>"projectregionsregionroutersroutergetrouterstatus-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}, {"in"=>"path", "name"=>"router", "description"=>"Name of the Router resource to query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Router"]}}, "/{project}/regions/{region}/routers/{router}/preview"=>{"post"=>{"summary"=>"Preview Router", "description"=>"Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.", "operationId"=>"compute.routers.preview", "x-api-path-slug"=>"projectregionsregionroutersrouterpreview-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}, {"in"=>"path", "name"=>"router", "description"=>"Name of the Router resource to query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Router"]}}, "/{project}/regions/{region}/subnetworks"=>{"get"=>{"summary"=>"Get Subnetworks", "description"=>"Retrieves a list of subnetworks available to the specified project.", "operationId"=>"compute.subnetworks.list", "x-api-path-slug"=>"projectregionsregionsubnetworks-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnetwork"]}, "post"=>{"summary"=>"Create Subnetwork", "description"=>"Creates a subnetwork in the specified project using the data included in the request.", "operationId"=>"compute.subnetworks.insert", "x-api-path-slug"=>"projectregionsregionsubnetworks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnetwork"]}}, "/{project}/regions/{region}/subnetworks/{subnetwork}"=>{"delete"=>{"summary"=>"Delete Subnetwork", "description"=>"Deletes the specified subnetwork.", "operationId"=>"compute.subnetworks.delete", "x-api-path-slug"=>"projectregionsregionsubnetworkssubnetwork-delete", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}, {"in"=>"path", "name"=>"subnetwork", "description"=>"Name of the Subnetwork resource to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnetwork"]}, "get"=>{"summary"=>"Get Subnetwork", "description"=>"Returns the specified subnetwork. Get a list of available subnetworks list() request.", "operationId"=>"compute.subnetworks.get", "x-api-path-slug"=>"projectregionsregionsubnetworkssubnetwork-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}, {"in"=>"path", "name"=>"subnetwork", "description"=>"Name of the Subnetwork resource to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnetwork"]}}, "/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange"=>{"post"=>{"summary"=>"Update Subnetwork", "description"=>"Expands the IP CIDR range of the subnetwork to a specified value.", "operationId"=>"compute.subnetworks.expandIpCidrRange", "x-api-path-slug"=>"projectregionsregionsubnetworkssubnetworkexpandipcidrrange-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}, {"in"=>"path", "name"=>"subnetwork", "description"=>"Name of the Subnetwork resource to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subnetwork"]}}, "/{project}/regions/{region}/targetPools"=>{"get"=>{"summary"=>"Get Target Pools", "description"=>"Retrieves a list of target pools available to the specified project and region.", "operationId"=>"compute.targetPools.list", "x-api-path-slug"=>"projectregionsregiontargetpools-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Pool"]}, "post"=>{"summary"=>"Create Target Pool", "description"=>"Creates a target pool in the specified project and region using the data included in the request.", "operationId"=>"compute.targetPools.insert", "x-api-path-slug"=>"projectregionsregiontargetpools-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Pool"]}}, "/{project}/regions/{region}/targetPools/{targetPool}"=>{"delete"=>{"summary"=>"Delete Target Pool", "description"=>"Deletes the specified target pool.", "operationId"=>"compute.targetPools.delete", "x-api-path-slug"=>"projectregionsregiontargetpoolstargetpool-delete", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}, {"in"=>"path", "name"=>"targetPool", "description"=>"Name of the TargetPool resource to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Pool"]}, "get"=>{"summary"=>"Get Target Pool", "description"=>"Returns the specified target pool. Get a list of available target pools by making a list() request.", "operationId"=>"compute.targetPools.get", "x-api-path-slug"=>"projectregionsregiontargetpoolstargetpool-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}, {"in"=>"path", "name"=>"targetPool", "description"=>"Name of the TargetPool resource to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Pool"]}}, "/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck"=>{"post"=>{"summary"=>"Add Target Pool Health Check", "description"=>"Adds health check URLs to a target pool.", "operationId"=>"compute.targetPools.addHealthCheck", "x-api-path-slug"=>"projectregionsregiontargetpoolstargetpooladdhealthcheck-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}, {"in"=>"path", "name"=>"targetPool", "description"=>"Name of the target pool to add a health check to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Pool"]}}, "/{project}/regions/{region}/targetPools/{targetPool}/addInstance"=>{"post"=>{"summary"=>"Add Instance to Target pool", "description"=>"Adds an instance to a target pool.", "operationId"=>"compute.targetPools.addInstance", "x-api-path-slug"=>"projectregionsregiontargetpoolstargetpooladdinstance-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}, {"in"=>"path", "name"=>"targetPool", "description"=>"Name of the TargetPool resource to add instances to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Pool"]}}, "/{project}/regions/{region}/targetPools/{targetPool}/getHealth"=>{"post"=>{"summary"=>"Get Target Pool Health Check", "description"=>"Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.", "operationId"=>"compute.targetPools.getHealth", "x-api-path-slug"=>"projectregionsregiontargetpoolstargetpoolgethealth-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}, {"in"=>"path", "name"=>"targetPool", "description"=>"Name of the TargetPool resource to which the queried instance belongs"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Pool"]}}, "/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck"=>{"post"=>{"summary"=>"Remove Target Pool Health Check", "description"=>"Removes health check URL from a target pool.", "operationId"=>"compute.targetPools.removeHealthCheck", "x-api-path-slug"=>"projectregionsregiontargetpoolstargetpoolremovehealthcheck-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}, {"in"=>"path", "name"=>"targetPool", "description"=>"Name of the target pool to remove health checks from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Pool"]}}, "/{project}/regions/{region}/targetPools/{targetPool}/removeInstance"=>{"post"=>{"summary"=>"Remove Instance From Target Pool", "description"=>"Removes instance URL from a target pool.", "operationId"=>"compute.targetPools.removeInstance", "x-api-path-slug"=>"projectregionsregiontargetpoolstargetpoolremoveinstance-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}, {"in"=>"path", "name"=>"targetPool", "description"=>"Name of the TargetPool resource to remove instances from"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Pool"]}}, "/{project}/regions/{region}/targetPools/{targetPool}/setBackup"=>{"post"=>{"summary"=>"Change Target Pool Backup", "description"=>"Changes a backup target pool's configurations.", "operationId"=>"compute.targetPools.setBackup", "x-api-path-slug"=>"projectregionsregiontargetpoolstargetpoolsetbackup-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"failoverRatio", "description"=>"New failoverRatio value for the target pool"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region scoping this request"}, {"in"=>"path", "name"=>"targetPool", "description"=>"Name of the TargetPool resource to set a backup pool for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Target Pool"]}}, "/{project}/regions/{region}/targetVpnGateways"=>{"get"=>{"summary"=>"Get Target Pool VPN Gateways", "description"=>"Retrieves a list of target VPN gateways available to the specified project and region.", "operationId"=>"compute.targetVpnGateways.list", "x-api-path-slug"=>"projectregionsregiontargetvpngateways-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPN Gateway"]}, "post"=>{"summary"=>"Create Target Pool VPN Gateway", "description"=>"Creates a target VPN gateway in the specified project and region using the data included in the request.", "operationId"=>"compute.targetVpnGateways.insert", "x-api-path-slug"=>"projectregionsregiontargetvpngateways-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPN Gateway"]}}, "/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}"=>{"delete"=>{"summary"=>"Delete Target Pool VPN Gateway", "description"=>"Deletes the specified target VPN gateway.", "operationId"=>"compute.targetVpnGateways.delete", "x-api-path-slug"=>"projectregionsregiontargetvpngatewaystargetvpngateway-delete", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}, {"in"=>"path", "name"=>"targetVpnGateway", "description"=>"Name of the target VPN gateway to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPN Gateway"]}, "get"=>{"summary"=>"Get Target Pool VPN Gateway", "description"=>"Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.", "operationId"=>"compute.targetVpnGateways.get", "x-api-path-slug"=>"projectregionsregiontargetvpngatewaystargetvpngateway-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}, {"in"=>"path", "name"=>"targetVpnGateway", "description"=>"Name of the target VPN gateway to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPN Gateway"]}}, "/{project}/regions/{region}/vpnTunnels"=>{"get"=>{"summary"=>"Get VPN Tunnels", "description"=>"Retrieves a list of VpnTunnel resources contained in the specified project and region.", "operationId"=>"compute.vpnTunnels.list", "x-api-path-slug"=>"projectregionsregionvpntunnels-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPN Tunnel"]}, "post"=>{"summary"=>"Create VPN Tunnel", "description"=>"Creates a VpnTunnel resource in the specified project and region using the data included in the request.", "operationId"=>"compute.vpnTunnels.insert", "x-api-path-slug"=>"projectregionsregionvpntunnels-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPN Tunnel"]}}, "/{project}/regions/{region}/vpnTunnels/{vpnTunnel}"=>{"delete"=>{"summary"=>"Delete VPN Tunnel", "description"=>"Deletes the specified VpnTunnel resource.", "operationId"=>"compute.vpnTunnels.delete", "x-api-path-slug"=>"projectregionsregionvpntunnelsvpntunnel-delete", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}, {"in"=>"path", "name"=>"vpnTunnel", "description"=>"Name of the VpnTunnel resource to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPN Tunnel"]}, "get"=>{"summary"=>"Get VPN Tunnel", "description"=>"Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.", "operationId"=>"compute.vpnTunnels.get", "x-api-path-slug"=>"projectregionsregionvpntunnelsvpntunnel-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"region", "description"=>"Name of the region for this request"}, {"in"=>"path", "name"=>"vpnTunnel", "description"=>"Name of the VpnTunnel resource to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["VPN Tunnel"]}}, "/{project}/setCommonInstanceMetadata"=>{"post"=>{"summary"=>"Set Common Instance Metadata", "description"=>"Sets metadata common to all instances within the specified project using the data included in the request.", "operationId"=>"compute.projects.setCommonInstanceMetadata", "x-api-path-slug"=>"projectsetcommoninstancemetadata-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/setUsageExportBucket"=>{"post"=>{"summary"=>"Set Usage Export Bucket", "description"=>"Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.", "operationId"=>"compute.projects.setUsageExportBucket", "x-api-path-slug"=>"projectsetusageexportbucket-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Bucket"]}}, "/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap"=>{"post"=>{"summary"=>"Target HTTP Proxies URL Map", "description"=>"Changes the URL map for TargetHttpProxy.", "operationId"=>"compute.targetHttpProxies.setUrlMap", "x-api-path-slug"=>"projecttargethttpproxiestargethttpproxyseturlmap-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"targetHttpProxy", "description"=>"Name of the TargetHttpProxy to set a URL map for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["URL Map"]}}, "/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates"=>{"post"=>{"summary"=>"Replace SSL Certificate for Target HTTP PRoxy", "description"=>"Replaces SslCertificates for TargetHttpsProxy.", "operationId"=>"compute.targetHttpsProxies.setSslCertificates", "x-api-path-slug"=>"projecttargethttpsproxiestargethttpsproxysetsslcertificates-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"targetHttpsProxy", "description"=>"Name of the TargetHttpsProxy resource to set an SslCertificates resource for"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Certificate"]}}, "/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap"=>{"post"=>{"summary"=>"Change URL Map for Target HTTP PRoxy", "description"=>"Changes the URL map for TargetHttpsProxy.", "operationId"=>"compute.targetHttpsProxies.setUrlMap", "x-api-path-slug"=>"projecttargethttpsproxiestargethttpsproxyseturlmap-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"targetHttpsProxy", "description"=>"Name of the TargetHttpsProxy resource whose URL map is to be set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Proxy"]}}, "/{project}/zones"=>{"get"=>{"summary"=>"Get Zones", "description"=>"Retrieves the list of Zone resources available to the specified project.", "operationId"=>"compute.zones.list", "x-api-path-slug"=>"projectzones-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zone"]}}, "/{project}/zones/{zone}"=>{"get"=>{"summary"=>"Get Zone", "description"=>"Returns the specified Zone resource. Get a list of available zones by making a list() request.", "operationId"=>"compute.zones.get", "x-api-path-slug"=>"projectzoneszone-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"Name of the zone resource to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Zone"]}}, "/{project}/zones/{zone}/autoscalers"=>{"get"=>{"summary"=>"Get Zone Autoscalers", "description"=>"Retrieves a list of autoscalers contained within the specified zone.", "operationId"=>"compute.autoscalers.list", "x-api-path-slug"=>"projectzoneszoneautoscalers-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"Name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaler"]}, "patch"=>{"summary"=>"Update Zone Autoscaler", "description"=>"Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.", "operationId"=>"compute.autoscalers.patch", "x-api-path-slug"=>"projectzoneszoneautoscalers-patch", "parameters"=>[{"in"=>"query", "name"=>"autoscaler", "description"=>"Name of the autoscaler to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"Name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaler"]}, "post"=>{"summary"=>"Create Zone Autoscaler", "description"=>"Creates an autoscaler in the specified project using the data included in the request.", "operationId"=>"compute.autoscalers.insert", "x-api-path-slug"=>"projectzoneszoneautoscalers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"Name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaler"]}, "put"=>{"summary"=>"Update Zone Autoscaler", "description"=>"Updates an autoscaler in the specified project using the data included in the request.", "operationId"=>"compute.autoscalers.update", "x-api-path-slug"=>"projectzoneszoneautoscalers-put", "parameters"=>[{"in"=>"query", "name"=>"autoscaler", "description"=>"Name of the autoscaler to update"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"Name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaler"]}}, "/{project}/zones/{zone}/autoscalers/{autoscaler}"=>{"delete"=>{"summary"=>"Delete Zone Autoscaler", "description"=>"Deletes the specified autoscaler.", "operationId"=>"compute.autoscalers.delete", "x-api-path-slug"=>"projectzoneszoneautoscalersautoscaler-delete", "parameters"=>[{"in"=>"path", "name"=>"autoscaler", "description"=>"Name of the autoscaler to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"Name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaler"]}, "get"=>{"summary"=>"UpGetdate Zone Autoscaler", "description"=>"Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.", "operationId"=>"compute.autoscalers.get", "x-api-path-slug"=>"projectzoneszoneautoscalersautoscaler-get", "parameters"=>[{"in"=>"path", "name"=>"autoscaler", "description"=>"Name of the autoscaler to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"Name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Autoscaler"]}}, "/{project}/zones/{zone}/diskTypes"=>{"get"=>{"summary"=>"Get Zone Disk Types", "description"=>"Retrieves a list of disk types available to the specified project.", "operationId"=>"compute.diskTypes.list", "x-api-path-slug"=>"projectzoneszonedisktypes-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disk"]}}, "/{project}/zones/{zone}/diskTypes/{diskType}"=>{"get"=>{"summary"=>"Get Zone Disk Type", "description"=>"Returns the specified disk type. Get a list of available disk types by making a list() request.", "operationId"=>"compute.diskTypes.get", "x-api-path-slug"=>"projectzoneszonedisktypesdisktype-get", "parameters"=>[{"in"=>"path", "name"=>"diskType", "description"=>"Name of the disk type to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disk"]}}, "/{project}/zones/{zone}/disks"=>{"get"=>{"summary"=>"Get Zone Disks", "description"=>"Retrieves a list of persistent disks contained within the specified zone.", "operationId"=>"compute.disks.list", "x-api-path-slug"=>"projectzoneszonedisks-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disk"]}, "post"=>{"summary"=>"Create Zone Disk", "description"=>"Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.", "operationId"=>"compute.disks.insert", "x-api-path-slug"=>"projectzoneszonedisks-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"query", "name"=>"sourceImage", "description"=>"Optional"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disk"]}}, "/{project}/zones/{zone}/disks/{disk}"=>{"delete"=>{"summary"=>"Delete Zone Disk", "description"=>"Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.", "operationId"=>"compute.disks.delete", "x-api-path-slug"=>"projectzoneszonedisksdisk-delete", "parameters"=>[{"in"=>"path", "name"=>"disk", "description"=>"Name of the persistent disk to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disk"]}, "get"=>{"summary"=>"Get Zone Disk", "description"=>"Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.", "operationId"=>"compute.disks.get", "x-api-path-slug"=>"projectzoneszonedisksdisk-get", "parameters"=>[{"in"=>"path", "name"=>"disk", "description"=>"Name of the persistent disk to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disk"]}}, "/{project}/zones/{zone}/disks/{disk}/createSnapshot"=>{"post"=>{"summary"=>"Create Snapshot of Zone Disk", "description"=>"Creates a snapshot of a specified persistent disk.", "operationId"=>"compute.disks.createSnapshot", "x-api-path-slug"=>"projectzoneszonedisksdiskcreatesnapshot-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"disk", "description"=>"Name of the persistent disk to snapshot"}, {"in"=>"query", "name"=>"guestFlush"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disk"]}}, "/{project}/zones/{zone}/disks/{disk}/resize"=>{"post"=>{"summary"=>"Resize Zone Disk", "description"=>"Resizes the specified persistent disk.", "operationId"=>"compute.disks.resize", "x-api-path-slug"=>"projectzoneszonedisksdiskresize-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"disk", "description"=>"The name of the persistent disk"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disk"]}}, "/{project}/zones/{zone}/instanceGroupManagers"=>{"get"=>{"summary"=>"Get Zone Instance Group Managers", "description"=>"Retrieves a list of managed instance groups that are contained within the specified project and zone.", "operationId"=>"compute.instanceGroupManagers.list", "x-api-path-slug"=>"projectzoneszoneinstancegroupmanagers-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the managed instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group Manager"]}, "post"=>{"summary"=>"Create Zone Instance Group Manager", "description"=>"Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.", "operationId"=>"compute.instanceGroupManagers.insert", "x-api-path-slug"=>"projectzoneszoneinstancegroupmanagers-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where you want to create the managed instance group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group Manager"]}}, "/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}"=>{"delete"=>{"summary"=>"Delete Zone Instance Group Manager", "description"=>"Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.", "operationId"=>"compute.instanceGroupManagers.delete", "x-api-path-slug"=>"projectzoneszoneinstancegroupmanagersinstancegroupmanager-delete", "parameters"=>[{"in"=>"path", "name"=>"instanceGroupManager", "description"=>"The name of the managed instance group to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the managed instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group Manager"]}, "get"=>{"summary"=>"Get Zone Instance Group Manager", "description"=>"Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.", "operationId"=>"compute.instanceGroupManagers.get", "x-api-path-slug"=>"projectzoneszoneinstancegroupmanagersinstancegroupmanager-get", "parameters"=>[{"in"=>"path", "name"=>"instanceGroupManager", "description"=>"The name of the managed instance group"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the managed instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Group Manager"]}}, "/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances"=>{"post"=>{"summary"=>"Schedule Action to Abandon Instance", "description"=>"Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.", "operationId"=>"compute.instanceGroupManagers.abandonInstances", "x-api-path-slug"=>"projectzoneszoneinstancegroupmanagersinstancegroupmanagerabandoninstances-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instanceGroupManager", "description"=>"The name of the managed instance group"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the managed instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances"=>{"post"=>{"summary"=>"Schedule Action to Delete Instance", "description"=>"Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.", "operationId"=>"compute.instanceGroupManagers.deleteInstances", "x-api-path-slug"=>"projectzoneszoneinstancegroupmanagersinstancegroupmanagerdeleteinstances-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instanceGroupManager", "description"=>"The name of the managed instance group"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the managed instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances"=>{"post"=>{"summary"=>"Get Zone Managed Instances", "description"=>"Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.", "operationId"=>"compute.instanceGroupManagers.listManagedInstances", "x-api-path-slug"=>"projectzoneszoneinstancegroupmanagersinstancegroupmanagerlistmanagedinstances-post", "parameters"=>[{"in"=>"query", "name"=>"filter"}, {"in"=>"path", "name"=>"instanceGroupManager", "description"=>"The name of the managed instance group"}, {"in"=>"query", "name"=>"maxResults"}, {"in"=>"query", "name"=>"order_by"}, {"in"=>"query", "name"=>"pageToken"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the managed instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances"=>{"post"=>{"summary"=>"Schedule Recreate of Instance", "description"=>"Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.", "operationId"=>"compute.instanceGroupManagers.recreateInstances", "x-api-path-slug"=>"projectzoneszoneinstancegroupmanagersinstancegroupmanagerrecreateinstances-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instanceGroupManager", "description"=>"The name of the managed instance group"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the managed instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize"=>{"post"=>{"summary"=>"Schedule Resize of Instance", "description"=>"Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.", "operationId"=>"compute.instanceGroupManagers.resize", "x-api-path-slug"=>"projectzoneszoneinstancegroupmanagersinstancegroupmanagerresize-post", "parameters"=>[{"in"=>"path", "name"=>"instanceGroupManager", "description"=>"The name of the managed instance group"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"query", "name"=>"size", "description"=>"The number of running instances that the managed instance group should maintain at any given time"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the managed instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate"=>{"post"=>{"summary"=>"Set Zone Managed Instance Template", "description"=>"Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.", "operationId"=>"compute.instanceGroupManagers.setInstanceTemplate", "x-api-path-slug"=>"projectzoneszoneinstancegroupmanagersinstancegroupmanagersetinstancetemplate-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instanceGroupManager", "description"=>"The name of the managed instance group"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the managed instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools"=>{"post"=>{"summary"=>"Modify Zone Managed Instance Target Pool", "description"=>"Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.", "operationId"=>"compute.instanceGroupManagers.setTargetPools", "x-api-path-slug"=>"projectzoneszoneinstancegroupmanagersinstancegroupmanagersettargetpools-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instanceGroupManager", "description"=>"The name of the managed instance group"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the managed instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instanceGroups"=>{"get"=>{"summary"=>"Get Zone Instance Groups", "description"=>"Retrieves the list of instance groups that are located in the specified project and zone.", "operationId"=>"compute.instanceGroups.list", "x-api-path-slug"=>"projectzoneszoneinstancegroups-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group"]}, "post"=>{"summary"=>"Create Zone Instance Group", "description"=>"Creates an instance group in the specified project using the parameters that are included in the request.", "operationId"=>"compute.instanceGroups.insert", "x-api-path-slug"=>"projectzoneszoneinstancegroups-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where you want to create the instance group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group"]}}, "/{project}/zones/{zone}/instanceGroups/{instanceGroup}"=>{"delete"=>{"summary"=>"Delete Zone Instance Group", "description"=>"Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.", "operationId"=>"compute.instanceGroups.delete", "x-api-path-slug"=>"projectzoneszoneinstancegroupsinstancegroup-delete", "parameters"=>[{"in"=>"path", "name"=>"instanceGroup", "description"=>"The name of the instance group to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group"]}, "get"=>{"summary"=>"Get Zone Instance Group", "description"=>"Returns the specified instance group. Get a list of available instance groups by making a list() request.", "operationId"=>"compute.instanceGroups.get", "x-api-path-slug"=>"projectzoneszoneinstancegroupsinstancegroup-get", "parameters"=>[{"in"=>"path", "name"=>"instanceGroup", "description"=>"The name of the instance group"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group"]}}, "/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances"=>{"post"=>{"summary"=>"Add Instance to Zone Instance Group", "description"=>"Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.", "operationId"=>"compute.instanceGroups.addInstances", "x-api-path-slug"=>"projectzoneszoneinstancegroupsinstancegroupaddinstances-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instanceGroup", "description"=>"The name of the instance group where you are adding instances"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group"]}}, "/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances"=>{"post"=>{"summary"=>"Get Instance in Zone Instance Group", "description"=>"Lists the instances in the specified instance group.", "operationId"=>"compute.instanceGroups.listInstances", "x-api-path-slug"=>"projectzoneszoneinstancegroupsinstancegrouplistinstances-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"path", "name"=>"instanceGroup", "description"=>"The name of the instance group from which you want to generate a list of included instances"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group"]}}, "/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances"=>{"post"=>{"summary"=>"Remove Instance in Zone Instance Group", "description"=>"Removes one or more instances from the specified instance group, but does not delete those instances.", "operationId"=>"compute.instanceGroups.removeInstances", "x-api-path-slug"=>"projectzoneszoneinstancegroupsinstancegroupremoveinstances-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instanceGroup", "description"=>"The name of the instance group where the specified instances will be removed"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group"]}}, "/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts"=>{"post"=>{"summary"=>"Set Named Ports for Zone Instance Group", "description"=>"Sets the named ports for the specified instance group.", "operationId"=>"compute.instanceGroups.setNamedPorts", "x-api-path-slug"=>"projectzoneszoneinstancegroupsinstancegroupsetnamedports-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instanceGroup", "description"=>"The name of the instance group where the named ports are updated"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone where the instance group is located"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance Group"]}}, "/{project}/zones/{zone}/instances"=>{"get"=>{"summary"=>"Get Zone Instances", "description"=>"Retrieves the list of instances contained within the specified zone.", "operationId"=>"compute.instances.list", "x-api-path-slug"=>"projectzoneszoneinstances-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}, "post"=>{"summary"=>"Create Zone Instance", "description"=>"Creates an instance resource in the specified project using the data included in the request.", "operationId"=>"compute.instances.insert", "x-api-path-slug"=>"projectzoneszoneinstances-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instances/{instance}"=>{"delete"=>{"summary"=>"Delete Zone Instance", "description"=>"Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.", "operationId"=>"compute.instances.delete", "x-api-path-slug"=>"projectzoneszoneinstancesinstance-delete", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Name of the instance resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}, "get"=>{"summary"=>"Get Zone Instance", "description"=>"Returns the specified Instance resource. Get a list of available instances by making a list() request.", "operationId"=>"compute.instances.get", "x-api-path-slug"=>"projectzoneszoneinstancesinstance-get", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Name of the instance resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instances/{instance}/addAccessConfig"=>{"post"=>{"summary"=>"Add Access to Zone Instance", "description"=>"Adds an access config to an instance's network interface.", "operationId"=>"compute.instances.addAccessConfig", "x-api-path-slug"=>"projectzoneszoneinstancesinstanceaddaccessconfig-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"The instance name for this request"}, {"in"=>"query", "name"=>"networkInterface", "description"=>"The name of the network interface to add to this instance"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instances/{instance}/attachDisk"=>{"post"=>{"summary"=>"Attach Disk to Zone Instance", "description"=>"Attaches a Disk resource to an instance.", "operationId"=>"compute.instances.attachDisk", "x-api-path-slug"=>"projectzoneszoneinstancesinstanceattachdisk-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"The instance name for this request"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Disk"]}}, "/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig"=>{"post"=>{"summary"=>"Delete Access to Zone Instance", "description"=>"Deletes an access config from an instance's network interface.", "operationId"=>"compute.instances.deleteAccessConfig", "x-api-path-slug"=>"projectzoneszoneinstancesinstancedeleteaccessconfig-post", "parameters"=>[{"in"=>"query", "name"=>"accessConfig", "description"=>"The name of the access config to delete"}, {"in"=>"path", "name"=>"instance", "description"=>"The instance name for this request"}, {"in"=>"query", "name"=>"networkInterface", "description"=>"The name of the network interface"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instances/{instance}/detachDisk"=>{"post"=>{"summary"=>"Detach Disk from Zone Instance", "description"=>"Detaches a disk from an instance.", "operationId"=>"compute.instances.detachDisk", "x-api-path-slug"=>"projectzoneszoneinstancesinstancedetachdisk-post", "parameters"=>[{"in"=>"query", "name"=>"deviceName", "description"=>"Disk device name to detach"}, {"in"=>"path", "name"=>"instance", "description"=>"Instance name"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instances/{instance}/reset"=>{"post"=>{"summary"=>"Reset Zone Instance", "description"=>"Performs a hard reset on the instance.", "operationId"=>"compute.instances.reset", "x-api-path-slug"=>"projectzoneszoneinstancesinstancereset-post", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Name of the instance scoping this request"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instances/{instance}/serialPort"=>{"get"=>{"summary"=>"Get Zone Instance Serial Port", "description"=>"Returns the specified instance's serial port output.", "operationId"=>"compute.instances.getSerialPortOutput", "x-api-path-slug"=>"projectzoneszoneinstancesinstanceserialport-get", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Name of the instance scoping this request"}, {"in"=>"query", "name"=>"port", "description"=>"Specifies which COM or serial port to retrieve data from"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"query", "name"=>"start", "description"=>"Returns output starting from a specific byte position"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete"=>{"post"=>{"summary"=>"Set Zone Instance Disk Auto Delete", "description"=>"Sets the auto-delete flag for a disk attached to an instance.", "operationId"=>"compute.instances.setDiskAutoDelete", "x-api-path-slug"=>"projectzoneszoneinstancesinstancesetdiskautodelete-post", "parameters"=>[{"in"=>"query", "name"=>"autoDelete", "description"=>"Whether to auto-delete the disk when the instance is deleted"}, {"in"=>"query", "name"=>"deviceName", "description"=>"The device name of the disk to modify"}, {"in"=>"path", "name"=>"instance", "description"=>"The instance name"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instances/{instance}/setMachineType"=>{"post"=>{"summary"=>"Set Zone Instance Machine Type", "description"=>"Changes the machine type for a stopped instance to the machine type specified in the request.", "operationId"=>"compute.instances.setMachineType", "x-api-path-slug"=>"projectzoneszoneinstancesinstancesetmachinetype-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Name of the instance scoping this request"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instances/{instance}/setMetadata"=>{"post"=>{"summary"=>"Set Zone Instance Metadata", "description"=>"Sets metadata for the specified instance to the data included in the request.", "operationId"=>"compute.instances.setMetadata", "x-api-path-slug"=>"projectzoneszoneinstancesinstancesetmetadata-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Name of the instance scoping this request"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instances/{instance}/setScheduling"=>{"post"=>{"summary"=>"Set Zone Instance Scheduling", "description"=>"Sets an instance's scheduling options.", "operationId"=>"compute.instances.setScheduling", "x-api-path-slug"=>"projectzoneszoneinstancesinstancesetscheduling-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Instance name"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instances/{instance}/setServiceAccount"=>{"post"=>{"summary"=>"Set Zone Instance Service Account", "description"=>"Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.", "operationId"=>"compute.instances.setServiceAccount", "x-api-path-slug"=>"projectzoneszoneinstancesinstancesetserviceaccount-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Name of the instance resource to start"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instances/{instance}/setTags"=>{"post"=>{"summary"=>"Set Zone Instance Tags", "description"=>"Sets tags for the specified instance to the data included in the request.", "operationId"=>"compute.instances.setTags", "x-api-path-slug"=>"projectzoneszoneinstancesinstancesettags-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Name of the instance scoping this request"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instances/{instance}/start"=>{"post"=>{"summary"=>"Start Zone Instance", "description"=>"Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.", "operationId"=>"compute.instances.start", "x-api-path-slug"=>"projectzoneszoneinstancesinstancestart-post", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Name of the instance resource to start"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey"=>{"post"=>{"summary"=>"Start Zone Instance with Encryption Key", "description"=>"Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.", "operationId"=>"compute.instances.startWithEncryptionKey", "x-api-path-slug"=>"projectzoneszoneinstancesinstancestartwithencryptionkey-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"instance", "description"=>"Name of the instance resource to start"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/instances/{instance}/stop"=>{"post"=>{"summary"=>"Stop Zone Instance", "description"=>"Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.", "operationId"=>"compute.instances.stop", "x-api-path-slug"=>"projectzoneszoneinstancesinstancestop-post", "parameters"=>[{"in"=>"path", "name"=>"instance", "description"=>"Name of the instance resource to stop"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/machineTypes"=>{"get"=>{"summary"=>"Get Zone Instance Machine Types", "description"=>"Retrieves a list of machine types available to the specified project.", "operationId"=>"compute.machineTypes.list", "x-api-path-slug"=>"projectzoneszonemachinetypes-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/machineTypes/{machineType}"=>{"get"=>{"summary"=>"Get Zone Instance Machine Type", "description"=>"Returns the specified machine type. Get a list of available machine types by making a list() request.", "operationId"=>"compute.machineTypes.get", "x-api-path-slug"=>"projectzoneszonemachinetypesmachinetype-get", "parameters"=>[{"in"=>"path", "name"=>"machineType", "description"=>"Name of the machine type to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"The name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/operations"=>{"get"=>{"summary"=>"Get Zone Instance Machine Operatons", "description"=>"Retrieves a list of Operation resources contained within the specified zone.", "operationId"=>"compute.zoneOperations.list", "x-api-path-slug"=>"projectzoneszoneoperations-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"Name of the zone for request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/operations/{operation}"=>{"delete"=>{"summary"=>"Delete Zone Instance Machine Operaton", "description"=>"Deletes the specified zone-specific Operations resource.", "operationId"=>"compute.zoneOperations.delete", "x-api-path-slug"=>"projectzoneszoneoperationsoperation-delete", "parameters"=>[{"in"=>"path", "name"=>"operation", "description"=>"Name of the Operations resource to delete"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"Name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}, "get"=>{"summary"=>"Get Zone Instance Machine Operaton", "description"=>"Retrieves the specified zone-specific Operations resource.", "operationId"=>"compute.zoneOperations.get", "x-api-path-slug"=>"projectzoneszoneoperationsoperation-get", "parameters"=>[{"in"=>"path", "name"=>"operation", "description"=>"Name of the Operations resource to return"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"Name of the zone for this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/targetInstances"=>{"get"=>{"summary"=>"Get Zone Target Instances", "description"=>"Retrieves a list of TargetInstance resources available to the specified project and zone.", "operationId"=>"compute.targetInstances.list", "x-api-path-slug"=>"projectzoneszonetargetinstances-get", "parameters"=>[{"in"=>"query", "name"=>"filter", "description"=>"Sets a filter expression for filtering listed resources, in the form filter={expression}"}, {"in"=>"query", "name"=>"maxResults", "description"=>"The maximum number of results per page that should be returned"}, {"in"=>"query", "name"=>"orderBy", "description"=>"Sorts list results by a certain order"}, {"in"=>"query", "name"=>"pageToken", "description"=>"Specifies a page token to use"}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"Name of the zone scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}, "post"=>{"summary"=>"Create Zone Target Instance", "description"=>"Creates a TargetInstance resource in the specified project and zone using the data included in the request.", "operationId"=>"compute.targetInstances.insert", "x-api-path-slug"=>"projectzoneszonetargetinstances-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"zone", "description"=>"Name of the zone scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}, "/{project}/zones/{zone}/targetInstances/{targetInstance}"=>{"delete"=>{"summary"=>"Delete Zone Target Instance", "description"=>"Deletes the specified TargetInstance resource.", "operationId"=>"compute.targetInstances.delete", "x-api-path-slug"=>"projectzoneszonetargetinstancestargetinstance-delete", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"targetInstance", "description"=>"Name of the TargetInstance resource to delete"}, {"in"=>"path", "name"=>"zone", "description"=>"Name of the zone scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}, "get"=>{"summary"=>"Get Zone Target Instance", "description"=>"Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.", "operationId"=>"compute.targetInstances.get", "x-api-path-slug"=>"projectzoneszonetargetinstancestargetinstance-get", "parameters"=>[{"in"=>"path", "name"=>"project", "description"=>"Project ID for this request"}, {"in"=>"path", "name"=>"targetInstance", "description"=>"Name of the TargetInstance resource to return"}, {"in"=>"path", "name"=>"zone", "description"=>"Name of the zone scoping this request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Instance"]}}}}, "apis"=>{"name"=>"Google Compute Engine", "x-slug"=>"google-compute-engine", "description"=>"Google Compute Engine delivers virtual machines running in Googles innovative data centers and worldwide fiber network. Compute Engines tooling and workflow support enable scaling from single instances to global, load-balanced cloud computing.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Google_Compute_Engine_logo.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Cloud,Compute,Deployments,Google APIs,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-compute-engine/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Compute Engine API", "x-api-slug"=>"google-compute-engine-api", "description"=>"Google Compute Engine delivers virtual machines running in Googles innovative data centers and worldwide fiber network. Compute Engines tooling and workflow support enable scaling from single instances to global, load-balanced cloud computing.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Google_Compute_Engine_logo.png", "humanURL"=>"https://cloud.google.com/compute/", "baseURL"=>"://www.googleapis.com//compute/v1/projects", "tags"=>"API Provider,API Service Provider,Cloud,Compute,Deployments,Google APIs,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-compute-engine/google-compute-engine-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-code", "url"=>"https://cloud.google.com/compute/docs/api/libraries"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/compute/docs/reference/latest/"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/compute/docs/api/how-tos/how-tos"}, {"type"=>"x-rate-limits", "url"=>"https://cloud.google.com/compute/docs/api-rate-limits"}, {"type"=>"x-sla", "url"=>"https://cloud.google.com/compute/sla"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/compute/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
stripe{"stripe-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Stripe", "x-complete"=>1, "info"=>{"title"=>"Stripe", "description"=>"the-stripe-rest-api--please-see-httpsstripe-comdocsapi-for-more-details-", "termsOfService"=>"https://stripe.com/us/terms/", "contact"=>{"name"=>"Stripe Dev Platform Team", "url"=>"https://stripe.com", "email"=>"dev-platform@stripe.com"}, "version"=>"v1"}, "host"=>"api.stripe.com", "basePath"=>"v1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/3d_secure"=>{"post"=>{"summary"=>"Add 3d Secure", "description"=>"Post 3d, Secure", "operationId"=>"post3dSecure", "x-api-path-slug"=>"3d-secure-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["3d", "Secure"]}}, "/3d_secure/{three_d_secure}"=>{"get"=>{"summary"=>"Get 3d Secure Three D Secure", "description"=>"Get 3d, Secure, Three, D, Secure", "operationId"=>"get3dSecureThreeDSecure", "x-api-path-slug"=>"3d-securethree-d-secure-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"three_d_secure", "description"=>"The identifier of the 3D Secure object to be retrieved"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["3d", "Secure", "Three", "D", "Secure"]}}, "/account"=>{"delete"=>{"summary"=>"Delete Account", "description"=>"With Connect, you may delete Custom accounts you manage.Custom accounts created using test-mode keys can be deleted at any time. Custom accounts created using live-mode keys may only be deleted once all balances are zero.If you are looking to close your own account, use the data tab in your account settings instead.", "operationId"=>"deleteAccount", "x-api-path-slug"=>"account-delete", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Account"]}, "get"=>{"summary"=>"Get Account", "description"=>"Retrieves the details of the account.", "operationId"=>"getAccount", "x-api-path-slug"=>"account-get", "parameters"=>[{"in"=>"query", "name"=>"account", "description"=>"The identifier of the account to retrieve"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Account"]}, "post"=>{"summary"=>"Add Account", "description"=>"Updates a connected Express or Custom account by setting the values of the parameters passed. Any parameters not provided are left unchanged. To update your own account, use the Dashboard.Refer to our Connect documentation to learn more about updating accounts.", "operationId"=>"postAccount", "x-api-path-slug"=>"account-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Account"]}}, "/account/bank_accounts"=>{"post"=>{"summary"=>"Add Account Bank Accounts", "description"=>"Post Account, Bank, Accounts", "operationId"=>"postAccountBankAccounts", "x-api-path-slug"=>"accountbank-accounts-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Account", "Bank", "Accounts"]}}, "/account/bank_accounts/{id}"=>{"delete"=>{"summary"=>"Delete Account Bank Accounts", "description"=>"Delete Account, Bank, Accounts", "operationId"=>"deleteAccountBankAccounts", "x-api-path-slug"=>"accountbank-accountsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the external account to be deleted"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Account", "Bank", "Accounts"]}, "get"=>{"summary"=>"Get Account Bank Accounts", "description"=>"Get Account, Bank, Accounts", "operationId"=>"getAccountBankAccounts", "x-api-path-slug"=>"accountbank-accountsid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Account", "Bank", "Accounts"]}, "post"=>{"summary"=>"Add Account Bank Accounts", "description"=>"Updates the metadata of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.", "operationId"=>"postAccountBankAccounts", "x-api-path-slug"=>"accountbank-accountsid-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the bank account to update"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Account", "Bank", "Accounts"]}}, "/account/external_accounts"=>{"get"=>{"summary"=>"Get Account External Accounts", "description"=>"Get Account, External, Accounts", "operationId"=>"getAccountExternalAccounts", "x-api-path-slug"=>"accountexternal-accounts-get", "parameters"=>[{"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Account", "External", "Accounts"]}, "post"=>{"summary"=>"Add Account External Accounts", "description"=>"Post Account, External, Accounts", "operationId"=>"postAccountExternalAccounts", "x-api-path-slug"=>"accountexternal-accounts-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Account", "External", "Accounts"]}}, "/account/external_accounts/{id}"=>{"delete"=>{"summary"=>"Delete Account External Accounts", "description"=>"Delete Account, External, Accounts", "operationId"=>"deleteAccountExternalAccounts", "x-api-path-slug"=>"accountexternal-accountsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the external account to be deleted"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Account", "External", "Accounts"]}, "get"=>{"summary"=>"Get Account External Accounts", "description"=>"Get Account, External, Accounts", "operationId"=>"getAccountExternalAccounts", "x-api-path-slug"=>"accountexternal-accountsid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Account", "External", "Accounts"]}, "post"=>{"summary"=>"Add Account External Accounts", "description"=>"Updates the metadata of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.", "operationId"=>"postAccountExternalAccounts", "x-api-path-slug"=>"accountexternal-accountsid-post", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the bank account to update"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Account", "External", "Accounts"]}}, "/account/login_links"=>{"post"=>{"summary"=>"Add Account Login Links", "description"=>"Creates a single-use login link for an Express account to access their Stripe dashboard.You may only create login links for Express accounts connected to your platform.", "operationId"=>"postAccountLoginLinks", "x-api-path-slug"=>"accountlogin-links-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Account", "Login", "Links"]}}, "/account/logout"=>{"put"=>{"summary"=>"Put Account Logout", "description"=>"Invalidates all sessions for a light account, for a platform to use during platform logout.You may only log out Express accounts connected to your platform.", "operationId"=>"putAccountLogout", "x-api-path-slug"=>"accountlogout-put", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Account", "Logout"]}}, "/accounts"=>{"get"=>{"summary"=>"Get Accounts", "description"=>"Returns a list of accounts connected to your platform via Connect. If you???re not a platform, the list is empty.", "operationId"=>"getAccounts", "x-api-path-slug"=>"accounts-get", "parameters"=>[{"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts"]}, "post"=>{"summary"=>"Add Accounts", "description"=>"Post Accounts", "operationId"=>"postAccounts", "x-api-path-slug"=>"accounts-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts"]}}, "/accounts/{account}"=>{"delete"=>{"summary"=>"Delete Accounts Account", "description"=>"With Connect, you may delete Custom accounts you manage.Custom accounts created using test-mode keys can be deleted at any time. Custom accounts created using live-mode keys may only be deleted once all balances are zero.If you are looking to close your own account, use the data tab in your account settings instead.", "operationId"=>"deleteAccountsAccount", "x-api-path-slug"=>"accountsaccount-delete", "parameters"=>[{"in"=>"path", "name"=>"account", "description"=>"The identifier of the account to be deleted"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts", "Account"]}, "get"=>{"summary"=>"Get Accounts Account", "description"=>"Retrieves the details of the account.", "operationId"=>"getAccountsAccount", "x-api-path-slug"=>"accountsaccount-get", "parameters"=>[{"in"=>"path", "name"=>"account", "description"=>"The identifier of the account to retrieve"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts", "Account"]}, "post"=>{"summary"=>"Add Accounts Account", "description"=>"Updates a connected Express or Custom account by setting the values of the parameters passed. Any parameters not provided are left unchanged. To update your own account, use the Dashboard.Refer to our Connect documentation to learn more about updating accounts.", "operationId"=>"postAccountsAccount", "x-api-path-slug"=>"accountsaccount-post", "parameters"=>[{"in"=>"path", "name"=>"account"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts", "Account"]}}, "/accounts/{account}/bank_accounts"=>{"post"=>{"summary"=>"Add Accounts Account Bank Accounts", "description"=>"Post Accounts, Account, Bank, Accounts", "operationId"=>"postAccountsAccountBankAccounts", "x-api-path-slug"=>"accountsaccountbank-accounts-post", "parameters"=>[{"in"=>"path", "name"=>"account"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts", "Account", "Bank", "Accounts"]}}, "/accounts/{account}/bank_accounts/{id}"=>{"delete"=>{"summary"=>"Delete Accounts Account Bank Accounts", "description"=>"Delete Accounts, Account, Bank, Accounts", "operationId"=>"deleteAccountsAccountBankAccounts", "x-api-path-slug"=>"accountsaccountbank-accountsid-delete", "parameters"=>[{"in"=>"path", "name"=>"account"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the external account to be deleted"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts", "Account", "Bank", "Accounts"]}, "get"=>{"summary"=>"Get Accounts Account Bank Accounts", "description"=>"Get Accounts, Account, Bank, Accounts", "operationId"=>"getAccountsAccountBankAccounts", "x-api-path-slug"=>"accountsaccountbank-accountsid-get", "parameters"=>[{"in"=>"path", "name"=>"account"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts", "Account", "Bank", "Accounts"]}, "post"=>{"summary"=>"Add Accounts Account Bank Accounts", "description"=>"Updates the metadata of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.", "operationId"=>"postAccountsAccountBankAccounts", "x-api-path-slug"=>"accountsaccountbank-accountsid-post", "parameters"=>[{"in"=>"path", "name"=>"account"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the bank account to update"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts", "Account", "Bank", "Accounts"]}}, "/accounts/{account}/external_accounts"=>{"get"=>{"summary"=>"Get Accounts Account External Accounts", "description"=>"Get Accounts, Account, External, Accounts", "operationId"=>"getAccountsAccountExternalAccounts", "x-api-path-slug"=>"accountsaccountexternal-accounts-get", "parameters"=>[{"in"=>"path", "name"=>"account"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts", "Account", "External", "Accounts"]}, "post"=>{"summary"=>"Add Accounts Account External Accounts", "description"=>"Post Accounts, Account, External, Accounts", "operationId"=>"postAccountsAccountExternalAccounts", "x-api-path-slug"=>"accountsaccountexternal-accounts-post", "parameters"=>[{"in"=>"path", "name"=>"account"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts", "Account", "External", "Accounts"]}}, "/accounts/{account}/external_accounts/{id}"=>{"delete"=>{"summary"=>"Delete Accounts Account External Accounts", "description"=>"Delete Accounts, Account, External, Accounts", "operationId"=>"deleteAccountsAccountExternalAccounts", "x-api-path-slug"=>"accountsaccountexternal-accountsid-delete", "parameters"=>[{"in"=>"path", "name"=>"account"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the external account to be deleted"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts", "Account", "External", "Accounts"]}, "get"=>{"summary"=>"Get Accounts Account External Accounts", "description"=>"Get Accounts, Account, External, Accounts", "operationId"=>"getAccountsAccountExternalAccounts", "x-api-path-slug"=>"accountsaccountexternal-accountsid-get", "parameters"=>[{"in"=>"path", "name"=>"account"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts", "Account", "External", "Accounts"]}, "post"=>{"summary"=>"Add Accounts Account External Accounts", "description"=>"Updates the metadata of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.", "operationId"=>"postAccountsAccountExternalAccounts", "x-api-path-slug"=>"accountsaccountexternal-accountsid-post", "parameters"=>[{"in"=>"path", "name"=>"account"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the bank account to update"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts", "Account", "External", "Accounts"]}}, "/accounts/{account}/login_links"=>{"post"=>{"summary"=>"Add Accounts Account Login Links", "description"=>"Creates a single-use login link for an Express account to access their Stripe dashboard.You may only create login links for Express accounts connected to your platform.", "operationId"=>"postAccountsAccountLoginLinks", "x-api-path-slug"=>"accountsaccountlogin-links-post", "parameters"=>[{"in"=>"path", "name"=>"account", "description"=>"The identifier of the account to create a login link for"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts", "Account", "Login", "Links"]}}, "/accounts/{account}/logout"=>{"put"=>{"summary"=>"Put Accounts Account Logout", "description"=>"Invalidates all sessions for a light account, for a platform to use during platform logout.You may only log out Express accounts connected to your platform.", "operationId"=>"putAccountsAccountLogout", "x-api-path-slug"=>"accountsaccountlogout-put", "parameters"=>[{"in"=>"path", "name"=>"account", "description"=>"The identifier of the account to log out"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts", "Account", "Logout"]}}, "/accounts/{account}/reject"=>{"post"=>{"summary"=>"Add Accounts Account Reject", "description"=>"With Connect, you may flag accounts as suspicious.Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.", "operationId"=>"postAccountsAccountReject", "x-api-path-slug"=>"accountsaccountreject-post", "parameters"=>[{"in"=>"path", "name"=>"account", "description"=>"The identifier of the account to reject"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Accounts", "Account", "Reject"]}}, "/apple_pay/domains"=>{"get"=>{"summary"=>"Get Apple Pay Domains", "description"=>"Get Apple, Pay, Domains", "operationId"=>"getApplePayDomains", "x-api-path-slug"=>"apple-paydomains-get", "parameters"=>[{"in"=>"query", "name"=>"domain_name"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Apple", "Pay", "Domains"]}, "post"=>{"summary"=>"Add Apple Pay Domains", "description"=>"Post Apple, Pay, Domains", "operationId"=>"postApplePayDomains", "x-api-path-slug"=>"apple-paydomains-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Apple", "Pay", "Domains"]}}, "/apple_pay/domains/{domain}"=>{"delete"=>{"summary"=>"Delete Apple Pay Domains Domain", "description"=>"Delete Apple, Pay, Domains, Domain", "operationId"=>"deleteApplePayDomainsDomain", "x-api-path-slug"=>"apple-paydomainsdomain-delete", "parameters"=>[{"in"=>"path", "name"=>"domain"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Apple", "Pay", "Domains", "Domain"]}, "get"=>{"summary"=>"Get Apple Pay Domains Domain", "description"=>"Get Apple, Pay, Domains, Domain", "operationId"=>"getApplePayDomainsDomain", "x-api-path-slug"=>"apple-paydomainsdomain-get", "parameters"=>[{"in"=>"path", "name"=>"domain"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Apple", "Pay", "Domains", "Domain"]}}, "/application_fees"=>{"get"=>{"summary"=>"Get Application Fees", "description"=>"Returns a list of application fees you???ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.", "operationId"=>"getApplicationFees", "x-api-path-slug"=>"application-fees-get", "parameters"=>[{"in"=>"query", "name"=>"charge", "description"=>"Only return application fees for the charge specified by this charge ID"}, {"in"=>"query", "name"=>"created"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Application", "Fees"]}}, "/application_fees/{fee}/refunds/{id}"=>{"get"=>{"summary"=>"Get Application Fees Fee Refunds", "description"=>"By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.", "operationId"=>"getApplicationFeesFeeRefunds", "x-api-path-slug"=>"application-feesfeerefundsid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"fee", "description"=>"ID of the application fee refunded"}, {"in"=>"path", "name"=>"id", "description"=>"ID of refund to retrieve"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Application", "Fees", "Fee", "Refunds"]}, "post"=>{"summary"=>"Add Application Fees Fee Refunds", "description"=>"Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.This request only accepts metadata as an argument.", "operationId"=>"postApplicationFeesFeeRefunds", "x-api-path-slug"=>"application-feesfeerefundsid-post", "parameters"=>[{"in"=>"path", "name"=>"fee"}, {"in"=>"path", "name"=>"id"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Application", "Fees", "Fee", "Refunds"]}}, "/application_fees/{id}"=>{"get"=>{"summary"=>"Get Application Fees", "description"=>"Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.", "operationId"=>"getApplicationFees", "x-api-path-slug"=>"application-feesid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id", "description"=>"The identifier of the fee to be retrieved"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Application", "Fees"]}}, "/application_fees/{id}/refund"=>{"post"=>{"summary"=>"Add Application Fees Refund", "description"=>"Post Application, Fees, , Refund", "operationId"=>"postApplicationFeesRefund", "x-api-path-slug"=>"application-feesidrefund-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Application", "Fees", "", "Refund"]}}, "/application_fees/{id}/refunds"=>{"get"=>{"summary"=>"Get Application Fees Refunds", "description"=>"You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.", "operationId"=>"getApplicationFeesRefunds", "x-api-path-slug"=>"application-feesidrefunds-get", "parameters"=>[{"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the application fee whose refunds will be retrieved"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Application", "Fees", "", "Refunds"]}, "post"=>{"summary"=>"Add Application Fees Refunds", "description"=>"Post Application, Fees, , Refunds", "operationId"=>"postApplicationFeesRefunds", "x-api-path-slug"=>"application-feesidrefunds-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Application", "Fees", "", "Refunds"]}}, "/balance"=>{"get"=>{"summary"=>"Get Balance", "description"=>"Retrieves the current account balance, based on the authentication that was used to make the request.", "operationId"=>"getBalance", "x-api-path-slug"=>"balance-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Balance"]}}, "/balance/history"=>{"get"=>{"summary"=>"Get Balance History", "description"=>"Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.", "operationId"=>"getBalanceHistory", "x-api-path-slug"=>"balancehistory-get", "parameters"=>[{"in"=>"query", "name"=>"available_on"}, {"in"=>"query", "name"=>"created"}, {"in"=>"query", "name"=>"currency"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"payout", "description"=>"For automatic Stripe payouts only, only returns transactions that were payed out on the specified payout ID"}, {"in"=>"query", "name"=>"source", "description"=>"Only returns the original transaction"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"type", "description"=>"Only returns transactions of the given type"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Balance", "History"]}}, "/balance/history/{id}"=>{"get"=>{"summary"=>"Get Balance History", "description"=>"Retrieves the balance transaction with the given ID.", "operationId"=>"getBalanceHistory", "x-api-path-slug"=>"balancehistoryid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the desired balance transaction (as found on any API object that affects the balance, e"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Balance", "History"]}}, "/bitcoin/receivers"=>{"get"=>{"summary"=>"Get Bitcoin Receivers", "description"=>"Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.", "operationId"=>"getBitcoinReceivers", "x-api-path-slug"=>"bitcoinreceivers-get", "parameters"=>[{"in"=>"query", "name"=>"active", "description"=>"Filter for active receivers"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"filled", "description"=>"Filter for filled receivers"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"uncaptured_funds", "description"=>"Filter for receivers with uncaptured funds"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Bitcoin", "Receivers"]}}, "/bitcoin/receivers/{id}"=>{"get"=>{"summary"=>"Get Bitcoin Receivers", "description"=>"Retrieves the Bitcoin receiver with the given ID.", "operationId"=>"getBitcoinReceivers", "x-api-path-slug"=>"bitcoinreceiversid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Bitcoin", "Receivers"]}}, "/bitcoin/receivers/{receiver}/transactions"=>{"get"=>{"summary"=>"Get Bitcoin Receivers Receiver Transactions", "description"=>"Get Bitcoin, Receivers, Receiver, Transactions", "operationId"=>"getBitcoinReceiversReceiverTransactions", "x-api-path-slug"=>"bitcoinreceiversreceivertransactions-get", "parameters"=>[{"in"=>"query", "name"=>"customer", "description"=>"Only return transactions for the customer specified by this customer ID"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"path", "name"=>"receiver", "description"=>"Only return transactions for the receiver specified by this receiver ID"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Bitcoin", "Receivers", "Receiver", "Transactions"]}}, "/bitcoin/transactions"=>{"get"=>{"summary"=>"Get Bitcoin Transactions", "description"=>"Get Bitcoin, Transactions", "operationId"=>"getBitcoinTransactions", "x-api-path-slug"=>"bitcointransactions-get", "parameters"=>[{"in"=>"query", "name"=>"customer", "description"=>"Only return transactions for the customer specified by this customer ID"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"receiver", "description"=>"Only return transactions for the receiver specified by this receiver ID"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Bitcoin", "Transactions"]}}, "/charges"=>{"get"=>{"summary"=>"Get Charges", "description"=>"Returns a list of charges you???ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.", "operationId"=>"getCharges", "x-api-path-slug"=>"charges-get", "parameters"=>[{"in"=>"query", "name"=>"created"}, {"in"=>"query", "name"=>"customer", "description"=>"Only return charges for the customer specified by this customer ID"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"source"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"transfer_group", "description"=>"Only return charges for this transfer group"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Charges"]}, "post"=>{"summary"=>"Add Charges", "description"=>"Post Charges", "operationId"=>"postCharges", "x-api-path-slug"=>"charges-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Charges"]}}, "/charges/{charge}"=>{"get"=>{"summary"=>"Get Charges Charge", "description"=>"Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.", "operationId"=>"getChargesCharge", "x-api-path-slug"=>"chargescharge-get", "parameters"=>[{"in"=>"path", "name"=>"charge", "description"=>"The identifier of the charge to be retrieved"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Charges", "Charge"]}, "post"=>{"summary"=>"Add Charges Charge", "description"=>"Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.This request accepts only the customer, description, fraud_details, metadata, receipt_email, and shipping arguments.", "operationId"=>"postChargesCharge", "x-api-path-slug"=>"chargescharge-post", "parameters"=>[{"in"=>"path", "name"=>"charge"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Charges", "Charge"]}}, "/charges/{charge}/capture"=>{"post"=>{"summary"=>"Add Charges Charge Capture", "description"=>"Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.Uncaptured payments expire exactly seven days after they are created. If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.", "operationId"=>"postChargesChargeCapture", "x-api-path-slug"=>"chargeschargecapture-post", "parameters"=>[{"in"=>"path", "name"=>"charge"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Charges", "Charge", "Capture"]}}, "/charges/{charge}/dispute"=>{"get"=>{"summary"=>"Get Charges Charge Dispute", "description"=>"Get Charges, Charge, Dispute", "operationId"=>"getChargesChargeDispute", "x-api-path-slug"=>"chargeschargedispute-get", "parameters"=>[{"in"=>"path", "name"=>"charge"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Charges", "Charge", "Dispute"]}, "post"=>{"summary"=>"Add Charges Charge Dispute", "description"=>"Post Charges, Charge, Dispute", "operationId"=>"postChargesChargeDispute", "x-api-path-slug"=>"chargeschargedispute-post", "parameters"=>[{"in"=>"path", "name"=>"charge"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Charges", "Charge", "Dispute"]}}, "/charges/{charge}/dispute/close"=>{"post"=>{"summary"=>"Add Charges Charge Dispute Close", "description"=>"Post Charges, Charge, Dispute, Close", "operationId"=>"postChargesChargeDisputeClose", "x-api-path-slug"=>"chargeschargedisputeclose-post", "parameters"=>[{"in"=>"path", "name"=>"charge"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Charges", "Charge", "Dispute", "Close"]}}, "/charges/{charge}/refund"=>{"post"=>{"summary"=>"Add Charges Charge Refund", "description"=>"Post Charges, Charge, Refund", "operationId"=>"postChargesChargeRefund", "x-api-path-slug"=>"chargeschargerefund-post", "parameters"=>[{"in"=>"path", "name"=>"charge"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Charges", "Charge", "Refund"]}}, "/charges/{charge}/refunds"=>{"get"=>{"summary"=>"Get Charges Charge Refunds", "description"=>"You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.", "operationId"=>"getChargesChargeRefunds", "x-api-path-slug"=>"chargeschargerefunds-get", "parameters"=>[{"in"=>"path", "name"=>"charge", "description"=>"The ID of the charge whose refunds will be retrieved"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Charges", "Charge", "Refunds"]}, "post"=>{"summary"=>"Add Charges Charge Refunds", "description"=>"Post Charges, Charge, Refunds", "operationId"=>"postChargesChargeRefunds", "x-api-path-slug"=>"chargeschargerefunds-post", "parameters"=>[{"in"=>"path", "name"=>"charge"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Charges", "Charge", "Refunds"]}}, "/charges/{charge}/refunds/{refund}"=>{"get"=>{"summary"=>"Get Charges Charge Refunds Refund", "description"=>"Get Charges, Charge, Refunds, Refund", "operationId"=>"getChargesChargeRefundsRefund", "x-api-path-slug"=>"chargeschargerefundsrefund-get", "parameters"=>[{"in"=>"path", "name"=>"charge"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"refund", "description"=>"ID of refund to retrieve"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Charges", "Charge", "Refunds", "Refund"]}, "post"=>{"summary"=>"Add Charges Charge Refunds Refund", "description"=>"Post Charges, Charge, Refunds, Refund", "operationId"=>"postChargesChargeRefundsRefund", "x-api-path-slug"=>"chargeschargerefundsrefund-post", "parameters"=>[{"in"=>"path", "name"=>"charge"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"refund"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Charges", "Charge", "Refunds", "Refund"]}}, "/country_specs"=>{"get"=>{"summary"=>"Get Country Specs", "description"=>"Lists all Country Spec objects available in the API.", "operationId"=>"getCountrySpecs", "x-api-path-slug"=>"country-specs-get", "parameters"=>[{"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Country", "Specs"]}}, "/country_specs/{country}"=>{"get"=>{"summary"=>"Get Country Specs Country", "description"=>"Returns a Country Spec for a given Country code.", "operationId"=>"getCountrySpecsCountry", "x-api-path-slug"=>"country-specscountry-get", "parameters"=>[{"in"=>"path", "name"=>"country", "description"=>"An ISO 3166-1 alpha-2 country code"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Country", "Specs", "Country"]}}, "/coupons"=>{"get"=>{"summary"=>"Get Coupons", "description"=>"Returns a list of your coupons.", "operationId"=>"getCoupons", "x-api-path-slug"=>"coupons-get", "parameters"=>[{"in"=>"query", "name"=>"created", "description"=>"A filter on the list based on the object `created` field"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Coupons"]}, "post"=>{"summary"=>"Add Coupons", "description"=>"You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice???s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.", "operationId"=>"postCoupons", "x-api-path-slug"=>"coupons-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Coupons"]}}, "/coupons/{coupon}"=>{"delete"=>{"summary"=>"Delete Coupons Coupon", "description"=>"You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can???t redeem the coupon. You can also delete coupons via the API.", "operationId"=>"deleteCouponsCoupon", "x-api-path-slug"=>"couponscoupon-delete", "parameters"=>[{"in"=>"path", "name"=>"coupon", "description"=>"The identifier of the coupon to be deleted"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Coupons", "Coupon"]}, "get"=>{"summary"=>"Get Coupons Coupon", "description"=>"Retrieves the coupon with the given ID.", "operationId"=>"getCouponsCoupon", "x-api-path-slug"=>"couponscoupon-get", "parameters"=>[{"in"=>"path", "name"=>"coupon", "description"=>"The ID of the desired coupon"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Coupons", "Coupon"]}, "post"=>{"summary"=>"Add Coupons Coupon", "description"=>"Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.", "operationId"=>"postCouponsCoupon", "x-api-path-slug"=>"couponscoupon-post", "parameters"=>[{"in"=>"path", "name"=>"coupon", "description"=>"The identifier of the coupon to be updated"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Coupons", "Coupon"]}}, "/customers"=>{"get"=>{"summary"=>"Get Customers", "description"=>"Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.", "operationId"=>"getCustomers", "x-api-path-slug"=>"customers-get", "parameters"=>[{"in"=>"query", "name"=>"created"}, {"in"=>"query", "name"=>"email", "description"=>"A filter on the list based on the customers `email` field"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers"]}, "post"=>{"summary"=>"Add Customers", "description"=>"Creates a new customer object.", "operationId"=>"postCustomers", "x-api-path-slug"=>"customers-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers"]}}, "/customers/{customer}"=>{"delete"=>{"summary"=>"Delete Customers Customer", "description"=>"Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.", "operationId"=>"deleteCustomersCustomer", "x-api-path-slug"=>"customerscustomer-delete", "parameters"=>[{"in"=>"path", "name"=>"customer", "description"=>"The identifier of the customer to be deleted"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer"]}, "get"=>{"summary"=>"Get Customers Customer", "description"=>"Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation.", "operationId"=>"getCustomersCustomer", "x-api-path-slug"=>"customerscustomer-get", "parameters"=>[{"in"=>"path", "name"=>"customer", "description"=>"The identifier of the customer to be retrieved"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer"]}, "post"=>{"summary"=>"Add Customers Customer", "description"=>"Post Customers, Customer", "operationId"=>"postCustomersCustomer", "x-api-path-slug"=>"customerscustomer-post", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer"]}}, "/customers/{customer}/bank_accounts"=>{"get"=>{"summary"=>"Get Customers Customer Bank Accounts", "description"=>"You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.", "operationId"=>"getCustomersCustomerBankAccounts", "x-api-path-slug"=>"customerscustomerbank-accounts-get", "parameters"=>[{"in"=>"path", "name"=>"customer", "description"=>"The ID of the customer whose bank accounts will be retrieved"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Bank", "Accounts"]}, "post"=>{"summary"=>"Add Customers Customer Bank Accounts", "description"=>"Post Customers, Customer, Bank, Accounts", "operationId"=>"postCustomersCustomerBankAccounts", "x-api-path-slug"=>"customerscustomerbank-accounts-post", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Bank", "Accounts"]}}, "/customers/{customer}/bank_accounts/{id}"=>{"delete"=>{"summary"=>"Delete Customers Customer Bank Accounts", "description"=>"Delete Customers, Customer, Bank, Accounts", "operationId"=>"deleteCustomersCustomerBankAccounts", "x-api-path-slug"=>"customerscustomerbank-accountsid-delete", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the source to be deleted"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Bank", "Accounts"]}, "get"=>{"summary"=>"Get Customers Customer Bank Accounts", "description"=>"By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.", "operationId"=>"getCustomersCustomerBankAccounts", "x-api-path-slug"=>"customerscustomerbank-accountsid-get", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id", "description"=>"ID of bank account to retrieve"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Bank", "Accounts"]}, "post"=>{"summary"=>"Add Customers Customer Bank Accounts", "description"=>"Post Customers, Customer, Bank, Accounts", "operationId"=>"postCustomersCustomerBankAccounts", "x-api-path-slug"=>"customerscustomerbank-accountsid-post", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the card to be updated"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Bank", "Accounts"]}}, "/customers/{customer}/bank_accounts/{id}/verify"=>{"post"=>{"summary"=>"Add Customers Customer Bank Accounts Verify", "description"=>"Post Customers, Customer, Bank, Accounts, , Verify", "operationId"=>"postCustomersCustomerBankAccountsVerify", "x-api-path-slug"=>"customerscustomerbank-accountsidverify-post", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the source to be verified"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Bank", "Accounts", "", "Verify"]}}, "/customers/{customer}/cards"=>{"get"=>{"summary"=>"Get Customers Customer Cards", "description"=>"Get Customers, Customer, Cards", "operationId"=>"getCustomersCustomerCards", "x-api-path-slug"=>"customerscustomercards-get", "parameters"=>[{"in"=>"path", "name"=>"customer", "description"=>"The ID of the customer whose cards will be retrieved"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Cards"]}, "post"=>{"summary"=>"Add Customers Customer Cards", "description"=>"Post Customers, Customer, Cards", "operationId"=>"postCustomersCustomerCards", "x-api-path-slug"=>"customerscustomercards-post", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Cards"]}}, "/customers/{customer}/cards/{id}"=>{"delete"=>{"summary"=>"Delete Customers Customer Cards", "description"=>"Delete Customers, Customer, Cards", "operationId"=>"deleteCustomersCustomerCards", "x-api-path-slug"=>"customerscustomercardsid-delete", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the source to be deleted"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Cards"]}, "get"=>{"summary"=>"Get Customers Customer Cards", "description"=>"Get Customers, Customer, Cards", "operationId"=>"getCustomersCustomerCards", "x-api-path-slug"=>"customerscustomercardsid-get", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the card to be retrieved"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Cards"]}, "post"=>{"summary"=>"Add Customers Customer Cards", "description"=>"Post Customers, Customer, Cards", "operationId"=>"postCustomersCustomerCards", "x-api-path-slug"=>"customerscustomercardsid-post", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the card to be updated"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Cards"]}}, "/customers/{customer}/discount"=>{"delete"=>{"summary"=>"Delete Customers Customer Discount", "description"=>"Removes the currently applied discount on a customer.", "operationId"=>"deleteCustomersCustomerDiscount", "x-api-path-slug"=>"customerscustomerdiscount-delete", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Discount"]}, "get"=>{"summary"=>"Get Customers Customer Discount", "description"=>"Get Customers, Customer, Discount", "operationId"=>"getCustomersCustomerDiscount", "x-api-path-slug"=>"customerscustomerdiscount-get", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Discount"]}}, "/customers/{customer}/sources"=>{"get"=>{"summary"=>"Get Customers Customer Sources", "description"=>"Get Customers, Customer, Sources", "operationId"=>"getCustomersCustomerSources", "x-api-path-slug"=>"customerscustomersources-get", "parameters"=>[{"in"=>"path", "name"=>"customer", "description"=>"The ID of the customer whose sources will be retrieved"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"type"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Sources"]}, "post"=>{"summary"=>"Add Customers Customer Sources", "description"=>"Post Customers, Customer, Sources", "operationId"=>"postCustomersCustomerSources", "x-api-path-slug"=>"customerscustomersources-post", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Sources"]}}, "/customers/{customer}/sources/{id}"=>{"delete"=>{"summary"=>"Delete Customers Customer Sources", "description"=>"Delete Customers, Customer, Sources", "operationId"=>"deleteCustomersCustomerSources", "x-api-path-slug"=>"customerscustomersourcesid-delete", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the source to be deleted"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Sources"]}, "get"=>{"summary"=>"Get Customers Customer Sources", "description"=>"Get Customers, Customer, Sources", "operationId"=>"getCustomersCustomerSources", "x-api-path-slug"=>"customerscustomersourcesid-get", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the source to be retrieved"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Sources"]}, "post"=>{"summary"=>"Add Customers Customer Sources", "description"=>"Post Customers, Customer, Sources", "operationId"=>"postCustomersCustomerSources", "x-api-path-slug"=>"customerscustomersourcesid-post", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the card to be updated"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Sources"]}}, "/customers/{customer}/sources/{id}/verify"=>{"post"=>{"summary"=>"Add Customers Customer Sources Verify", "description"=>"Post Customers, Customer, Sources, , Verify", "operationId"=>"postCustomersCustomerSourcesVerify", "x-api-path-slug"=>"customerscustomersourcesidverify-post", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the source to be verified"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Sources", "", "Verify"]}}, "/customers/{customer}/subscriptions"=>{"get"=>{"summary"=>"Get Customers Customer Subscriptions", "description"=>"You can see a list of the customer???s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.", "operationId"=>"getCustomersCustomerSubscriptions", "x-api-path-slug"=>"customerscustomersubscriptions-get", "parameters"=>[{"in"=>"path", "name"=>"customer", "description"=>"The ID of the customer whose subscriptions will be retrieved"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Subscriptions"]}, "post"=>{"summary"=>"Add Customers Customer Subscriptions", "description"=>"Creates a new subscription on an existing customer.", "operationId"=>"postCustomersCustomerSubscriptions", "x-api-path-slug"=>"customerscustomersubscriptions-post", "parameters"=>[{"in"=>"path", "name"=>"customer", "description"=>"The identifier of the customer to subscribe"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Subscriptions"]}}, "/customers/{customer}/subscriptions/{subscription_exposed_id}"=>{"delete"=>{"summary"=>"Delete Customers Customer Subscriptions Subscription Exposed", "description"=>"Cancels a customer???s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. By default, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription. Note, however, that any pending invoice items that you???ve created will still be charged for at the end of the period unless manually deleted. If you???ve set the subscription to cancel at period end, any pending prorations will also be left in place and collected at the end of the period, but if the subscription is set to cancel immediately, pending prorations will be removed.By default, all unpaid invoices for the customer will be closed upon subscription cancellation. We do this in order to prevent unexpected payment attempts once the customer has canceled a subscription. However, you can reopen the invoices manually after subscription cancellation to have us proceed with payment collection, or you could even re-attempt payment yourself on all unpaid invoices before allowing the customer to cancel the subscription at all.", "operationId"=>"deleteCustomersCustomerSubscriptionsSubscriptionExposed", "x-api-path-slug"=>"customerscustomersubscriptionssubscription-exposed-id-delete", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"subscription_exposed_id"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Subscriptions", "Subscription", "Exposed"]}, "get"=>{"summary"=>"Get Customers Customer Subscriptions Subscription Exposed", "description"=>"Get Customers, Customer, Subscriptions, Subscription, Exposed", "operationId"=>"getCustomersCustomerSubscriptionsSubscriptionExposed", "x-api-path-slug"=>"customerscustomersubscriptionssubscription-exposed-id-get", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"subscription_exposed_id"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Subscriptions", "Subscription", "Exposed"]}, "post"=>{"summary"=>"Add Customers Customer Subscriptions Subscription Exposed", "description"=>"Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.", "operationId"=>"postCustomersCustomerSubscriptionsSubscriptionExposed", "x-api-path-slug"=>"customerscustomersubscriptionssubscription-exposed-id-post", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"subscription_exposed_id"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Subscriptions", "Subscription", "Exposed"]}}, "/customers/{customer}/subscriptions/{subscription_exposed_id}/discount"=>{"delete"=>{"summary"=>"Delete Customers Customer Subscriptions Subscription Exposed Discount", "description"=>"Delete Customers, Customer, Subscriptions, Subscription, Exposed, , Discount", "operationId"=>"deleteCustomersCustomerSubscriptionsSubscriptionExposedDiscount", "x-api-path-slug"=>"customerscustomersubscriptionssubscription-exposed-iddiscount-delete", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"subscription_exposed_id"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Subscriptions", "Subscription", "Exposed", "", "Discount"]}, "get"=>{"summary"=>"Get Customers Customer Subscriptions Subscription Exposed Discount", "description"=>"Get Customers, Customer, Subscriptions, Subscription, Exposed, , Discount", "operationId"=>"getCustomersCustomerSubscriptionsSubscriptionExposedDiscount", "x-api-path-slug"=>"customerscustomersubscriptionssubscription-exposed-iddiscount-get", "parameters"=>[{"in"=>"path", "name"=>"customer"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"subscription_exposed_id"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Customers", "Customer", "Subscriptions", "Subscription", "Exposed", "", "Discount"]}}, "/disputes"=>{"get"=>{"summary"=>"Get Disputes", "description"=>"Returns a list of your disputes.", "operationId"=>"getDisputes", "x-api-path-slug"=>"disputes-get", "parameters"=>[{"in"=>"query", "name"=>"created"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Disputes"]}}, "/disputes/{dispute}"=>{"get"=>{"summary"=>"Get Disputes Dispute", "description"=>"Retrieves the dispute with the given ID.", "operationId"=>"getDisputesDispute", "x-api-path-slug"=>"disputesdispute-get", "parameters"=>[{"in"=>"path", "name"=>"dispute", "description"=>"ID of dispute to retrieve"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Disputes", "Dispute"]}, "post"=>{"summary"=>"Add Disputes Dispute", "description"=>"When you get a dispute, contacting your customer is always the best first step. If that doesn???t work, you can submit evidence in order to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. You may want to consult our guide to dispute types to help you figure out which evidence fields to provide.", "operationId"=>"postDisputesDispute", "x-api-path-slug"=>"disputesdispute-post", "parameters"=>[{"in"=>"path", "name"=>"dispute", "description"=>"ID of the dispute to update"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Disputes", "Dispute"]}}, "/disputes/{dispute}/close"=>{"post"=>{"summary"=>"Add Disputes Dispute Close", "description"=>"Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially ???dismissing??? the dispute, acknowledging it as lostThe status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.", "operationId"=>"postDisputesDisputeClose", "x-api-path-slug"=>"disputesdisputeclose-post", "parameters"=>[{"in"=>"path", "name"=>"dispute", "description"=>"ID of dispute to close"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Disputes", "Dispute", "Close"]}}, "/ephemeral_keys"=>{"post"=>{"summary"=>"Add Ephemeral Keys", "description"=>"Creates a short-lived API key for a given resource.", "operationId"=>"postEphemeralKeys", "x-api-path-slug"=>"ephemeral-keys-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Ephemeral", "Keys"]}}, "/ephemeral_keys/{key}"=>{"delete"=>{"summary"=>"Delete Ephemeral Keys Key", "description"=>"Invalidates a short-lived API key for a given resource.", "operationId"=>"deleteEphemeralKeysKey", "x-api-path-slug"=>"ephemeral-keyskey-delete", "parameters"=>[{"in"=>"path", "name"=>"key", "description"=>"The ID of the key youd like to invalidate"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Ephemeral", "Keys", "Key"]}}, "/events"=>{"get"=>{"summary"=>"Get Events", "description"=>"List events, going back up to 30 days.", "operationId"=>"getEvents", "x-api-path-slug"=>"events-get", "parameters"=>[{"in"=>"query", "name"=>"created"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"type", "description"=>"A string containing a specific event name, or group of events using * as a wildcard"}, {"in"=>"query", "name"=>"types", "description"=>"An array of up to 20 strings containing specific event names"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Events"]}}, "/events/{id}"=>{"get"=>{"summary"=>"Get Events", "description"=>"Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.", "operationId"=>"getEvents", "x-api-path-slug"=>"eventsid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id", "description"=>"The identifier of the event to be retrieved"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Events"]}}, "/events/{id}/retry"=>{"post"=>{"summary"=>"Add Events Retry", "description"=>"Resend an event. This only works in testmode", "operationId"=>"postEventsRetry", "x-api-path-slug"=>"eventsidretry-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Events", "", "Retry"]}}, "/exchange_rates"=>{"get"=>{"summary"=>"Get Exchange Rates", "description"=>"Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.", "operationId"=>"getExchangeRates", "x-api-path-slug"=>"exchange-rates-get", "parameters"=>[{"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Exchange", "Rates"]}}, "/exchange_rates/{currency}"=>{"get"=>{"summary"=>"Get Exchange Rates Currency", "description"=>"Retrieves the exchange rates from the given currency to every supported currency.", "operationId"=>"getExchangeRatesCurrency", "x-api-path-slug"=>"exchange-ratescurrency-get", "parameters"=>[{"in"=>"path", "name"=>"currency", "description"=>"Three-letter [ISO currency code](https://www"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Exchange", "Rates", "Currency"]}}, "/invoiceitems"=>{"get"=>{"summary"=>"Get Invoiceitems", "description"=>"Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.", "operationId"=>"getInvoiceitems", "x-api-path-slug"=>"invoiceitems-get", "parameters"=>[{"in"=>"query", "name"=>"created"}, {"in"=>"query", "name"=>"customer", "description"=>"The identifier of the customer whose invoice items to return"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Invoiceitems"]}, "post"=>{"summary"=>"Add Invoiceitems", "description"=>"Adds an arbitrary charge or credit to the customer???s upcoming invoice.", "operationId"=>"postInvoiceitems", "x-api-path-slug"=>"invoiceitems-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Invoiceitems"]}}, "/invoiceitems/{invoiceitem}"=>{"delete"=>{"summary"=>"Delete Invoiceitems Invoiceitem", "description"=>"Removes an invoice item from the upcoming invoice. Removing an invoice item is only possible before the invoice it???s attached to is closed.", "operationId"=>"deleteInvoiceitemsInvoiceitem", "x-api-path-slug"=>"invoiceitemsinvoiceitem-delete", "parameters"=>[{"in"=>"path", "name"=>"invoiceitem", "description"=>"The identifier of the invoice item to be deleted"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Invoiceitems", "Invoiceitem"]}, "get"=>{"summary"=>"Get Invoiceitems Invoiceitem", "description"=>"Retrieves the invoice item with the given ID.", "operationId"=>"getInvoiceitemsInvoiceitem", "x-api-path-slug"=>"invoiceitemsinvoiceitem-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"invoiceitem", "description"=>"The ID of the desired invoice item"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Invoiceitems", "Invoiceitem"]}, "post"=>{"summary"=>"Add Invoiceitems Invoiceitem", "description"=>"Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it???s attached to is closed.", "operationId"=>"postInvoiceitemsInvoiceitem", "x-api-path-slug"=>"invoiceitemsinvoiceitem-post", "parameters"=>[{"in"=>"path", "name"=>"invoiceitem"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Invoiceitems", "Invoiceitem"]}}, "/invoices"=>{"get"=>{"summary"=>"Get Invoices", "description"=>"You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.", "operationId"=>"getInvoices", "x-api-path-slug"=>"invoices-get", "parameters"=>[{"in"=>"query", "name"=>"billing", "description"=>"The billing mode of the invoice to retrieve"}, {"in"=>"query", "name"=>"customer", "description"=>"Only return invoices for the customer specified by this customer ID"}, {"in"=>"query", "name"=>"date"}, {"in"=>"query", "name"=>"due_date"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"subscription", "description"=>"Only return invoices for the subscription specified by this subscription ID"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Invoices"]}, "post"=>{"summary"=>"Add Invoices", "description"=>"If you need to invoice your customer outside the regular billing cycle, you can create an invoice that pulls in all pending invoice items, including prorations. The customer???s billing cycle and regular subscription won???t be affected.Once you create the invoice, Stripe will attempt to collect payment according to your subscriptions settings, though you can choose to pay it right away.", "operationId"=>"postInvoices", "x-api-path-slug"=>"invoices-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Invoices"]}}, "/invoices/upcoming"=>{"get"=>{"summary"=>"Get Invoices Upcoming", "description"=>"At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discount that is applicable to the customer.Note that when you are viewing an upcoming invoice, you are simply viewing a preview ??? the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer???s discount.You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.", "operationId"=>"getInvoicesUpcoming", "x-api-path-slug"=>"invoicesupcoming-get", "parameters"=>[{"in"=>"query", "name"=>"coupon", "description"=>"The code of the coupon to apply"}, {"in"=>"query", "name"=>"customer", "description"=>"The identifier of the customer whose upcoming invoice youd like to retrieve"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"invoice_items", "description"=>"List of invoice items to add or update in the upcoming invoice preview"}, {"in"=>"query", "name"=>"subscription", "description"=>"The identifier of the subscription for which youd like to retrieve the upcoming invoice"}, {"in"=>"query", "name"=>"subscription_items", "description"=>"List of subscription items, each with an attached plan"}, {"in"=>"query", "name"=>"subscription_prorate", "description"=>"If previewing an update to a subscription, this decides whether the preview will show the result of applying prorations or not"}, {"in"=>"query", "name"=>"subscription_proration_date", "description"=>"If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time"}, {"in"=>"query", "name"=>"subscription_tax_percent", "description"=>"If provided, the invoice returned will preview updating or creating a subscription with that tax percent"}, {"in"=>"query", "name"=>"subscription_trial_end", "description"=>"If provided, the invoice returned will preview updating or creating a subscription with that trial end"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Invoices", "Upcoming"]}}, "/invoices/{invoice}"=>{"get"=>{"summary"=>"Get Invoices Invoice", "description"=>"Retrieves the invoice with the given ID.", "operationId"=>"getInvoicesInvoice", "x-api-path-slug"=>"invoicesinvoice-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"invoice", "description"=>"The identifier of the desired invoice"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Invoices", "Invoice"]}, "post"=>{"summary"=>"Add Invoices Invoice", "description"=>"Until an invoice is paid, it is marked as open (closed=false). If you???d like to stop Stripe from attempting to collect payment on an invoice or would simply like to close the invoice out as no longer owed by the customer, you can update the closed parameter.", "operationId"=>"postInvoicesInvoice", "x-api-path-slug"=>"invoicesinvoice-post", "parameters"=>[{"in"=>"path", "name"=>"invoice"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Invoices", "Invoice"]}}, "/invoices/{invoice}/lines"=>{"get"=>{"summary"=>"Get Invoices Invoice Lines", "description"=>"When retrieving an invoice, you???ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.", "operationId"=>"getInvoicesInvoiceLines", "x-api-path-slug"=>"invoicesinvoicelines-get", "parameters"=>[{"in"=>"query", "name"=>"coupon", "description"=>"For upcoming invoices, preview applying this coupon to the invoice"}, {"in"=>"query", "name"=>"customer", "description"=>"In the case of upcoming invoices, the customer of the upcoming invoice is required"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"invoice", "description"=>"The ID of the invoice containing the lines to be retrieved"}, {"in"=>"query", "name"=>"limit", "description"=>"The maximum number of line items to return"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"subscription", "description"=>"In the case of upcoming invoices, the subscription of the upcoming invoice is optional"}, {"in"=>"query", "name"=>"subscription_items", "description"=>"For upcoming invoices, preview updating the subscription with this list of items"}, {"in"=>"query", "name"=>"subscription_prorate", "description"=>"For upcoming invoices, this decides whether the preview will show the result of applying prorations or not"}, {"in"=>"query", "name"=>"subscription_proration_date", "description"=>"For previewing upcoming invoices with proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time"}, {"in"=>"query", "name"=>"subscription_tax_percent"}, {"in"=>"query", "name"=>"subscription_trial_end", "description"=>"For upcoming invoices, preview updating or creating a subscription with that trial end"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Invoices", "Invoice", "Lines"]}}, "/invoices/{invoice}/pay"=>{"post"=>{"summary"=>"Add Invoices Invoice Pay", "description"=>"Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you???d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.", "operationId"=>"postInvoicesInvoicePay", "x-api-path-slug"=>"invoicesinvoicepay-post", "parameters"=>[{"in"=>"path", "name"=>"invoice", "description"=>"ID of invoice to pay"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Invoices", "Invoice", "Pay"]}}, "/order_returns"=>{"get"=>{"summary"=>"Get Order Returns", "description"=>"Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first.", "operationId"=>"getOrderReturns", "x-api-path-slug"=>"order-returns-get", "parameters"=>[{"in"=>"query", "name"=>"created", "description"=>"Date this return was created"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"order", "description"=>"The order to retrieve returns for"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Order", "Returns"]}}, "/order_returns/{id}"=>{"get"=>{"summary"=>"Get Order Returns", "description"=>"Retrieves the details of an existing order return. Supply the unique order ID from either an order return creation request or the order return list, and Stripe will return the corresponding order information.", "operationId"=>"getOrderReturns", "x-api-path-slug"=>"order-returnsid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id", "description"=>"The identifier of the order return to be retrieved"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Order", "Returns"]}}, "/orders"=>{"get"=>{"summary"=>"Get Orders", "description"=>"Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.", "operationId"=>"getOrders", "x-api-path-slug"=>"orders-get", "parameters"=>[{"in"=>"query", "name"=>"created", "description"=>"Date this order was created"}, {"in"=>"query", "name"=>"customer", "description"=>"Only return orders for the given customer"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"ids", "description"=>"Only return orders with the given IDs"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"status", "description"=>"Only return orders that have the given status"}, {"in"=>"query", "name"=>"status_transitions", "description"=>"Filter orders based on when they were paid, fulfilled, canceled, or returned"}, {"in"=>"query", "name"=>"upstream_ids", "description"=>"Only return orders with the given upstream order IDs"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Orders"]}, "post"=>{"summary"=>"Add Orders", "description"=>"Post Orders", "operationId"=>"postOrders", "x-api-path-slug"=>"orders-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Orders"]}}, "/orders/{id}"=>{"get"=>{"summary"=>"Get Orders", "description"=>"Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.", "operationId"=>"getOrders", "x-api-path-slug"=>"ordersid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id", "description"=>"The identifier of the order to be retrieved"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Orders"]}, "post"=>{"summary"=>"Add Orders", "description"=>"Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata, and status as arguments.", "operationId"=>"postOrders", "x-api-path-slug"=>"ordersid-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Orders"]}}, "/orders/{id}/pay"=>{"post"=>{"summary"=>"Add Orders Pay", "description"=>"Post Orders, , Pay", "operationId"=>"postOrdersPay", "x-api-path-slug"=>"ordersidpay-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Orders", "", "Pay"]}}, "/orders/{id}/returns"=>{"post"=>{"summary"=>"Add Orders Returns", "description"=>"Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.", "operationId"=>"postOrdersReturns", "x-api-path-slug"=>"ordersidreturns-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Orders", "", "Returns"]}}, "/payments"=>{"get"=>{"summary"=>"Get Payments", "description"=>"Get Payments", "operationId"=>"getPayments", "x-api-path-slug"=>"payments-get", "parameters"=>[{"in"=>"query", "name"=>"customer", "description"=>"Only return payments for the customer specified by this customer ID"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"transfer_group"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Payments"]}, "post"=>{"summary"=>"Add Payments", "description"=>"Post Payments", "operationId"=>"postPayments", "x-api-path-slug"=>"payments-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Payments"]}}, "/payments/{payment}"=>{"get"=>{"summary"=>"Get Payments Payment", "description"=>"Get Payments, Payment", "operationId"=>"getPaymentsPayment", "x-api-path-slug"=>"paymentspayment-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"payment"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Payments", "Payment"]}}, "/payouts"=>{"get"=>{"summary"=>"Get Payouts", "description"=>"Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.", "operationId"=>"getPayouts", "x-api-path-slug"=>"payouts-get", "parameters"=>[{"in"=>"query", "name"=>"arrival_date"}, {"in"=>"query", "name"=>"created"}, {"in"=>"query", "name"=>"destination", "description"=>"The ID of an external account - only return payouts sent to this external account"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"status", "description"=>"Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Payouts"]}, "post"=>{"summary"=>"Add Payouts", "description"=>"To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you???ll receive an ???Insufficient Funds??? error.If your API key is in test mode, money won???t actually be sent, though everything else will occur as if in live mode.If you are creating a manual payout on a Stripe account that uses multiple payment source types, you???ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.", "operationId"=>"postPayouts", "x-api-path-slug"=>"payouts-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Payouts"]}}, "/payouts/{payout}"=>{"get"=>{"summary"=>"Get Payouts Payout", "description"=>"Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.", "operationId"=>"getPayoutsPayout", "x-api-path-slug"=>"payoutspayout-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"payout", "description"=>"The identifier of the payout to be retrieved"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Payouts", "Payout"]}, "post"=>{"summary"=>"Add Payouts Payout", "description"=>"Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.", "operationId"=>"postPayoutsPayout", "x-api-path-slug"=>"payoutspayout-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"payout", "description"=>"The identifier of the payout to be updated"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Payouts", "Payout"]}}, "/payouts/{payout}/cancel"=>{"post"=>{"summary"=>"Add Payouts Payout Cancel", "description"=>"A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance, and the fees you were originally charged on the payout will be refunded. You may not cancel automatic Stripe payouts.", "operationId"=>"postPayoutsPayoutCancel", "x-api-path-slug"=>"payoutspayoutcancel-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"payout", "description"=>"The identifier of the payout to be canceled"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Payouts", "Payout", "Cancel"]}}, "/plans"=>{"get"=>{"summary"=>"Get Plans", "description"=>"Returns a list of your plans.", "operationId"=>"getPlans", "x-api-path-slug"=>"plans-get", "parameters"=>[{"in"=>"query", "name"=>"created", "description"=>"A filter on the list based on the object `created` field"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Plans"]}, "post"=>{"summary"=>"Add Plans", "description"=>"You can create plans using the API, or in the Stripe Dashboard.", "operationId"=>"postPlans", "x-api-path-slug"=>"plans-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Plans"]}}, "/plans/{plan}"=>{"delete"=>{"summary"=>"Delete Plans Plan", "description"=>"You can delete plans using the API, or in the Stripe Dashboard. Deleting plans means new subscribers can???t be added. Existing subscribers aren???t affected.", "operationId"=>"deletePlansPlan", "x-api-path-slug"=>"plansplan-delete", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"plan", "description"=>"The identifier of the plan to be deleted"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Plans", "Plan"]}, "get"=>{"summary"=>"Get Plans Plan", "description"=>"Retrieves the plan with the given ID.", "operationId"=>"getPlansPlan", "x-api-path-slug"=>"plansplan-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"plan", "description"=>"The ID of the desired plan"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Plans", "Plan"]}, "post"=>{"summary"=>"Add Plans Plan", "description"=>"Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan???s ID, amount, currency, or billing cycle.", "operationId"=>"postPlansPlan", "x-api-path-slug"=>"plansplan-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"plan", "description"=>"The identifier of the plan to be updated"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Plans", "Plan"]}}, "/products"=>{"get"=>{"summary"=>"Get Products", "description"=>"Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.", "operationId"=>"getProducts", "x-api-path-slug"=>"products-get", "parameters"=>[{"in"=>"query", "name"=>"active", "description"=>"Only return products that are active or inactive (e"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"ids", "description"=>"Only return products with the given IDs"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"shippable", "description"=>"Only return products that can be shipped (i"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"url", "description"=>"Only return products with the given url"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Products"]}, "post"=>{"summary"=>"Add Products", "description"=>"Creates a new product object.", "operationId"=>"postProducts", "x-api-path-slug"=>"products-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Products"]}}, "/products/{id}"=>{"delete"=>{"summary"=>"Delete Products", "description"=>"Delete a product. Deleting a product is only possible if it has no SKUs associated with it.", "operationId"=>"deleteProducts", "x-api-path-slug"=>"productsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The ID of the product to delete"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Products"]}, "get"=>{"summary"=>"Get Products", "description"=>"Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.", "operationId"=>"getProducts", "x-api-path-slug"=>"productsid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id", "description"=>"The identifier of the product to be retrieved"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Products"]}, "post"=>{"summary"=>"Add Products", "description"=>"Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.Note that a product???s attributes are not editable. Instead, you would need to deactivate the existing product and create a new one with the new attribute values.", "operationId"=>"postProducts", "x-api-path-slug"=>"productsid-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Products"]}}, "/recipients"=>{"get"=>{"summary"=>"Get Recipients", "description"=>"Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.", "operationId"=>"getRecipients", "x-api-path-slug"=>"recipients-get", "parameters"=>[{"in"=>"query", "name"=>"created"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"type"}, {"in"=>"query", "name"=>"verified", "description"=>"Only return recipients that are verified or unverified"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Recipients"]}, "post"=>{"summary"=>"Add Recipients", "description"=>"Post Recipients", "operationId"=>"postRecipients", "x-api-path-slug"=>"recipients-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Recipients"]}}, "/recipients/{id}"=>{"delete"=>{"summary"=>"Delete Recipients", "description"=>"Permanently deletes a recipient. It cannot be undone.", "operationId"=>"deleteRecipients", "x-api-path-slug"=>"recipientsid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the recipient to be deleted"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Recipients"]}, "get"=>{"summary"=>"Get Recipients", "description"=>"Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.", "operationId"=>"getRecipients", "x-api-path-slug"=>"recipientsid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id", "description"=>"The identifier of the recipient to be retrieved"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Recipients"]}, "post"=>{"summary"=>"Add Recipients", "description"=>"Post Recipients", "operationId"=>"postRecipients", "x-api-path-slug"=>"recipientsid-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Recipients"]}}, "/refunds"=>{"get"=>{"summary"=>"Get Refunds", "description"=>"Returns a list of all refunds you???ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.", "operationId"=>"getRefunds", "x-api-path-slug"=>"refunds-get", "parameters"=>[{"in"=>"query", "name"=>"charge", "description"=>"Only return refunds for the charge specified by this charge ID"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Refunds"]}, "post"=>{"summary"=>"Add Refunds", "description"=>"Post Refunds", "operationId"=>"postRefunds", "x-api-path-slug"=>"refunds-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Refunds"]}}, "/refunds/{refund}"=>{"get"=>{"summary"=>"Get Refunds Refund", "description"=>"Retrieves the details of an existing refund.", "operationId"=>"getRefundsRefund", "x-api-path-slug"=>"refundsrefund-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"refund", "description"=>"ID of refund to retrieve"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Refunds", "Refund"]}, "post"=>{"summary"=>"Add Refunds Refund", "description"=>"Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.This request only accepts metadata as an argument.", "operationId"=>"postRefundsRefund", "x-api-path-slug"=>"refundsrefund-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"refund"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Refunds", "Refund"]}}, "/skus"=>{"get"=>{"summary"=>"Get Skus", "description"=>"Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.", "operationId"=>"getSkus", "x-api-path-slug"=>"skus-get", "parameters"=>[{"in"=>"query", "name"=>"active", "description"=>"Only return SKUs that are active or inactive (e"}, {"in"=>"query", "name"=>"attributes", "description"=>"Only return SKUs that have the specified key/value pairs in this partially constructed dictionary"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"ids", "description"=>"Only return SKUs with the given IDs"}, {"in"=>"query", "name"=>"in_stock", "description"=>"Only return SKUs that are either in stock or out of stock (e"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"product", "description"=>"The ID of the product whose SKUs will be retrieved"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Skus"]}, "post"=>{"summary"=>"Add Skus", "description"=>"Creates a new SKU associated with a product.", "operationId"=>"postSkus", "x-api-path-slug"=>"skus-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Skus"]}}, "/skus/{id}"=>{"delete"=>{"summary"=>"Delete Skus", "description"=>"Delete a SKU. Deleting a SKU is only possible until it has been used in an order.", "operationId"=>"deleteSkus", "x-api-path-slug"=>"skusid-delete", "parameters"=>[{"in"=>"path", "name"=>"id", "description"=>"The identifier of the SKU to be deleted"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Skus"]}, "get"=>{"summary"=>"Get Skus", "description"=>"Retrieves the details of an existing SKU. Supply the unique SKU identifier from either a SKU creation request or from the product, and Stripe will return the corresponding SKU information.", "operationId"=>"getSkus", "x-api-path-slug"=>"skusid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id", "description"=>"The identifier of the SKU to be retrieved"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Skus"]}, "post"=>{"summary"=>"Add Skus", "description"=>"Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided will be left unchanged.Note that a SKU???s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.", "operationId"=>"postSkus", "x-api-path-slug"=>"skusid-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Skus"]}}, "/sources"=>{"post"=>{"summary"=>"Add Sources", "description"=>"Creates a new source object.", "operationId"=>"postSources", "x-api-path-slug"=>"sources-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Sources"]}}, "/sources/{source}"=>{"get"=>{"summary"=>"Get Sources Source", "description"=>"Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.", "operationId"=>"getSourcesSource", "x-api-path-slug"=>"sourcessource-get", "parameters"=>[{"in"=>"query", "name"=>"client_secret", "description"=>"The client secret of the source"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"source", "description"=>"The identifier of the source to be retrieved"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Sources", "Source"]}, "post"=>{"summary"=>"Add Sources Source", "description"=>"Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.", "operationId"=>"postSourcesSource", "x-api-path-slug"=>"sourcessource-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"source"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Sources", "Source"]}}, "/sources/{source}/mandate_notifications/{mandate_notification}"=>{"get"=>{"summary"=>"Get Sources Source Mandate Notifications Mandate Notification", "description"=>"Get Sources, Source, Mandate, Notifications, Mandate, Notification", "operationId"=>"getSourcesSourceMandateNotificationsMandateNotification", "x-api-path-slug"=>"sourcessourcemandate-notificationsmandate-notification-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"mandate_notification", "description"=>"The ID of the Source MandateNotification"}, {"in"=>"path", "name"=>"source", "description"=>"The ID of the Source that received a ManateNotification"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Sources", "Source", "Mandate", "Notifications", "Mandate", "Notification"]}}, "/sources/{source}/source_transactions"=>{"get"=>{"summary"=>"Get Sources Source Source Transactions", "description"=>"Get Sources, Source, Source, Transactions", "operationId"=>"getSourcesSourceSourceTransactions", "x-api-path-slug"=>"sourcessourcesource-transactions-get", "parameters"=>[{"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"path", "name"=>"source", "description"=>"The ID of the source whose source transactions will be retrieved"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Sources", "Source", "Source", "Transactions"]}}, "/sources/{source}/source_transactions/{source_transaction}"=>{"get"=>{"summary"=>"Get Sources Source Source Transactions Source Transaction", "description"=>"Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.", "operationId"=>"getSourcesSourceSourceTransactionsSourceTransaction", "x-api-path-slug"=>"sourcessourcesource-transactionssource-transaction-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"source", "description"=>"The ID of the source whose source transaction will be retrieved"}, {"in"=>"path", "name"=>"source_transaction", "description"=>"The ID of the source transaction that will be retrieved"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Sources", "Source", "Source", "Transactions", "Source", "Transaction"]}}, "/sources/{source}/verify"=>{"post"=>{"summary"=>"Add Sources Source Verify", "description"=>"Post Sources, Source, Verify", "operationId"=>"postSourcesSourceVerify", "x-api-path-slug"=>"sourcessourceverify-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"source", "description"=>"The ID of the desired source"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Sources", "Source", "Verify"]}}, "/subscription_items"=>{"get"=>{"summary"=>"Get Subscription Items", "description"=>"Returns a list of your subscription items for a given subscription.", "operationId"=>"getSubscriptionItems", "x-api-path-slug"=>"subscription-items-get", "parameters"=>[{"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"subscription", "description"=>"The ID of the subscription whose items will be retrieved"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Subscription", "Items"]}, "post"=>{"summary"=>"Add Subscription Items", "description"=>"Adds a new item to an existing subscription. No existing items will be changed or replaced.", "operationId"=>"postSubscriptionItems", "x-api-path-slug"=>"subscription-items-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Subscription", "Items"]}}, "/subscription_items/{item}"=>{"delete"=>{"summary"=>"Delete Subscription Items Item", "description"=>"Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.", "operationId"=>"deleteSubscriptionItemsItem", "x-api-path-slug"=>"subscription-itemsitem-delete", "parameters"=>[{"in"=>"path", "name"=>"item", "description"=>"The identifier of the subscription item to delete"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Subscription", "Items", "Item"]}, "get"=>{"summary"=>"Get Subscription Items Item", "description"=>"Retrieves the invoice item with the given ID.", "operationId"=>"getSubscriptionItemsItem", "x-api-path-slug"=>"subscription-itemsitem-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"item", "description"=>"The identifier of the subscription item to retrieve"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Subscription", "Items", "Item"]}, "post"=>{"summary"=>"Add Subscription Items Item", "description"=>"Updates the plan or quantity of an item on a current subscription.", "operationId"=>"postSubscriptionItemsItem", "x-api-path-slug"=>"subscription-itemsitem-post", "parameters"=>[{"in"=>"path", "name"=>"item", "description"=>"The identifier of the subscription item to modify"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Subscription", "Items", "Item"]}}, "/subscriptions"=>{"get"=>{"summary"=>"Get Subscriptions", "description"=>"By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.", "operationId"=>"getSubscriptions", "x-api-path-slug"=>"subscriptions-get", "parameters"=>[{"in"=>"query", "name"=>"billing", "description"=>"The billing mode of the subscriptions to retrieve"}, {"in"=>"query", "name"=>"created"}, {"in"=>"query", "name"=>"customer", "description"=>"The ID of the customer whose subscriptions will be retrieved"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"plan", "description"=>"The ID of the plan whose subscriptions will be retrieved"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"status", "description"=>"The status of the subscriptions to retrieve"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Subscriptions"]}, "post"=>{"summary"=>"Add Subscriptions", "description"=>"Creates a new subscription on an existing customer.", "operationId"=>"postSubscriptions", "x-api-path-slug"=>"subscriptions-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Subscriptions"]}}, "/subscriptions/{subscription_exposed_id}"=>{"delete"=>{"summary"=>"Delete Subscriptions Subscription Exposed", "description"=>"Cancels a customer???s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. By default, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription. Note, however, that any pending invoice items that you???ve created will still be charged for at the end of the period unless manually deleted. If you???ve set the subscription to cancel at period end, any pending prorations will also be left in place and collected at the end of the period, but if the subscription is set to cancel immediately, pending prorations will be removed.By default, all unpaid invoices for the customer will be closed upon subscription cancellation. We do this in order to prevent unexpected payment attempts once the customer has canceled a subscription. However, you can reopen the invoices manually after subscription cancellation to have us proceed with payment collection, or you could even re-attempt payment yourself on all unpaid invoices before allowing the customer to cancel the subscription at all.", "operationId"=>"deleteSubscriptionsSubscriptionExposed", "x-api-path-slug"=>"subscriptionssubscription-exposed-id-delete", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"subscription_exposed_id"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Subscriptions", "Subscription", "Exposed"]}, "get"=>{"summary"=>"Get Subscriptions Subscription Exposed", "description"=>"Retrieves the subscription with the given ID.", "operationId"=>"getSubscriptionsSubscriptionExposed", "x-api-path-slug"=>"subscriptionssubscription-exposed-id-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"subscription_exposed_id"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Subscriptions", "Subscription", "Exposed"]}, "post"=>{"summary"=>"Add Subscriptions Subscription Exposed", "description"=>"Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.", "operationId"=>"postSubscriptionsSubscriptionExposed", "x-api-path-slug"=>"subscriptionssubscription-exposed-id-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"subscription_exposed_id"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Subscriptions", "Subscription", "Exposed"]}}, "/subscriptions/{subscription_exposed_id}/discount"=>{"delete"=>{"summary"=>"Delete Subscriptions Subscription Exposed Discount", "description"=>"Delete Subscriptions, Subscription, Exposed, , Discount", "operationId"=>"deleteSubscriptionsSubscriptionExposedDiscount", "x-api-path-slug"=>"subscriptionssubscription-exposed-iddiscount-delete", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"subscription_exposed_id"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Subscriptions", "Subscription", "Exposed", "", "Discount"]}}, "/tokens"=>{"post"=>{"summary"=>"Add Tokens", "description"=>"Post Tokens", "operationId"=>"postTokens", "x-api-path-slug"=>"tokens-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Tokens"]}}, "/tokens/{token}"=>{"get"=>{"summary"=>"Get Tokens Token", "description"=>"Retrieves the token with the given ID.", "operationId"=>"getTokensToken", "x-api-path-slug"=>"tokenstoken-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"token", "description"=>"The ID of the desired token"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Tokens", "Token"]}}, "/transfers"=>{"get"=>{"summary"=>"Get Transfers", "description"=>"Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.", "operationId"=>"getTransfers", "x-api-path-slug"=>"transfers-get", "parameters"=>[{"in"=>"query", "name"=>"created"}, {"in"=>"query", "name"=>"destination", "description"=>"Only return transfers for the destination specified by this account ID"}, {"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"transfer_group", "description"=>"Only return transfers with the specified transfer group"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transfers"]}, "post"=>{"summary"=>"Add Transfers", "description"=>"Post Transfers", "operationId"=>"postTransfers", "x-api-path-slug"=>"transfers-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transfers"]}}, "/transfers/{id}/reversals"=>{"get"=>{"summary"=>"Get Transfers Reversals", "description"=>"You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.", "operationId"=>"getTransfersReversals", "x-api-path-slug"=>"transfersidreversals-get", "parameters"=>[{"in"=>"query", "name"=>"ending_before", "description"=>"A cursor for use in pagination"}, {"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id", "description"=>"The ID of the transfer whose reversals will be retrieved"}, {"in"=>"query", "name"=>"limit", "description"=>"A limit on the number of objects to be returned"}, {"in"=>"query", "name"=>"starting_after", "description"=>"A cursor for use in pagination"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transfers", "", "Reversals"]}, "post"=>{"summary"=>"Add Transfers Reversals", "description"=>"Post Transfers, , Reversals", "operationId"=>"postTransfersReversals", "x-api-path-slug"=>"transfersidreversals-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transfers", "", "Reversals"]}}, "/transfers/{transfer}"=>{"get"=>{"summary"=>"Get Transfers Transfer", "description"=>"Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.", "operationId"=>"getTransfersTransfer", "x-api-path-slug"=>"transferstransfer-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"transfer", "description"=>"The identifier of the transfer to be retrieved"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transfers", "Transfer"]}, "post"=>{"summary"=>"Add Transfers Transfer", "description"=>"Post Transfers, Transfer", "operationId"=>"postTransfersTransfer", "x-api-path-slug"=>"transferstransfer-post", "parameters"=>[{"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"transfer"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transfers", "Transfer"]}}, "/transfers/{transfer}/reversals/{id}"=>{"get"=>{"summary"=>"Get Transfers Transfer Reversals", "description"=>"By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.", "operationId"=>"getTransfersTransferReversals", "x-api-path-slug"=>"transferstransferreversalsid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"Specifies which fields in the response should be expanded"}, {"in"=>"path", "name"=>"id", "description"=>"ID of reversal to retrieve"}, {"in"=>"path", "name"=>"transfer", "description"=>"ID of the transfer reversed"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transfers", "Transfer", "Reversals"]}, "post"=>{"summary"=>"Add Transfers Transfer Reversals", "description"=>"Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.This request only accepts metadata and description as arguments.", "operationId"=>"postTransfersTransferReversals", "x-api-path-slug"=>"transferstransferreversalsid-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"body", "name"=>"payload", "description"=>"Body parameters for the request", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"transfer"}], "responses"=>{1=>{"description"=>"Photoset not found - The photoset id passed was not the id of avalid photoset owned by the calling user"}, 2=>{"description"=>"Photo not found - The photo id passed was not the id of a valid photo owned by the calling user"}, 95=>{"description"=>"SSL is required - SSL is required to access the Flickr API"}, 96=>{"description"=>"Invalid signature - The passed signature was invalid"}, 97=>{"description"=>"Missing signature - The call required signing but no signature was sent"}, 98=>{"description"=>"Login failed / Invalid auth token - The login details or auth token passed were invalid"}, 99=>{"description"=>"User not logged in / Insufficient permissions - The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions"}, 100=>{"description"=>"Invalid API Key - The API key passed was not valid or has expired"}, 105=>{"description"=>"Service currently unavailable - The requested service is temporarily unavailable"}, 106=>{"description"=>"Write operation failed - The requested operation failed due to a temporary issue"}, 111=>{"description"=>"Format \"xxx\" not found - The requested response format was not found"}, 112=>{"description"=>"Method \"xxx\" not found - The requested method was not found"}, 114=>{"description"=>"Invalid SOAP envelope - The SOAP envelope send in the request could not be parsed"}, 115=>{"description"=>"Invalid XML-RPC Method Call - The XML-RPC request document could not be parsed"}, 116=>{"description"=>"Bad URL found - One or more arguments contained a URL that has been used for abuse on Flickr"}}, "tags"=>["Transfers", "Transfer", "Reversals"]}}}}, "apis"=>{"name"=>"Stripe", "x-slug"=>"stripe", "description"=>"Online payment processing for internet businesses. Stripe is a suite of payment APIs that powers commerce for online businesses of all sizes, including fraud prevention, and subscription management. Use Stripes payment platform to accept and process p...", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/254-stripe.jpg", "x-kinRank"=>"10", "x-alexaRank"=>"1914", "tags"=>"Billing,Change Log Example,Finance,Imports,Invoices,Payments,Payments,Payments,Relative Data,Relative StreamRank,SaaS,Service API,Stack,Stack Network,Streams,Streams,Streams,Stripe Stack,Webhook Implementations", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"stripe/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Stripe", "x-api-slug"=>"stripe", "description"=>"Web and mobile payments, built for developers.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/254-stripe.jpg", "humanURL"=>"https://stripe.com/", "baseURL"=>"https://api.stripe.com/v1/", "tags"=>"Billing,Change Log Example,Finance,Imports,Invoices,Payments,Payments,Payments,Relative Data,Relative StreamRank,SaaS,Service API,Stack,Stack Network,Streams,Streams,Streams,Stripe Stack,Webhook Implementations", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/stripe/stripe-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.stripe.com/"}, {"type"=>"x-blog", "url"=>"https://stripe.com/blog"}, {"type"=>"x-blog-rss", "url"=>"https://stripe.com/blog/feed.rss"}, {"type"=>"x-change-log", "url"=>"https://stripe.com/docs/upgrades"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/stripe"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/stripe"}, {"type"=>"x-email", "url"=>"info@stripe.com"}, {"type"=>"x-email", "url"=>"privacy@stripe.com"}, {"type"=>"x-email", "url"=>"atlas@stripe.com"}, {"type"=>"x-email", "url"=>"notices@stripe.com"}, {"type"=>"x-email", "url"=>"jane.diaz@stripe.com"}, {"type"=>"x-email", "url"=>"nonprofit@stripe.com"}, {"type"=>"x-email", "url"=>"support@stripe.com"}, {"type"=>"x-email", "url"=>"dpo@stripe.com"}, {"type"=>"x-github", "url"=>"https://github.com/stripe"}, {"type"=>"x-linkedin", "url"=>"https://www.linkedin.com/company/stripe/"}, {"type"=>"x-pricing", "url"=>"https://stripe.com/us/pricing"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/stripe"}, {"type"=>"x-webhook", "url"=>"https://stripe.com/docs/webhooks"}, {"type"=>"x-website", "url"=>"https://stripe.com/"}, {"type"=>"x-website", "url"=>"http://stripe.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ibm-watson{"ibm-watson-iot-platform-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"IBM Watson", "x-complete"=>1, "info"=>{"title"=>"IBM Watson IoT Platform HTTP REST API", "description"=>"the-information-management-capabilities-of-ibm-watson-iot-platform-helpyou-to-organize-and-integrate-data-coming-in-to-and-going-out-of-watson-iotplatform---with-these-apis-you-will-be-able-to---work-with-device-state-regardless-of-whether-the-actual-device-on-online----or-offline----provide-your-application-developers-with-consistent-interfaces-to-access----eventdriven-device-data-in-a-restlike-manner----normalize-data-from-devices-of-different-makes-or-models-that-publish----data-in-different-formatsfor-information-on-how-to-use-watson-iot-platform-apis-generally-see-the-api-documentationhttpsconsole-ng-bluemix-netdocsservicesiotreferenceapi-html-for-more-general-information-on-how-to-use-watson-iot-platform-seethe-general-documentationhttpsconsole-ng-bluemix-netdocsservicesiotindex-htmlgettingstartedtemplate", "version"=>"1.0.0"}, "basePath"=>"/api/v0002", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/schemas"=>{"get"=>{"summary"=>"Query active schema definitions", "description"=>"Schemas are used to define the structure of Events, Device State and\nThing State in the Watson IoT Platform.\n\n - For Events, they define the structure of the payload of the events\n that are published to the platform by devices.\n\n - For Device and Thing State, they define the structure of the state\n that is stored by the platform.\n\nThe **schemas** endpoint returns the list of all of the active schema \ndefinitions for the organization in the Watson IoT Platform. Various\nquery parameters can be used to filter, sort and page through the list\nof schemas that are returned.", "operationId"=>"schemas-are-used-to-define-the-structure-of-events-device-state-andthing-state-in-the-watson-iot-pla", "x-api-path-slug"=>"schemas-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Schemas"]}}, "/schemas/{schemaId}"=>{"get"=>{"summary"=>"Get active schema definition metadata", "description"=>"Retrieves the metadata for the active schema definition with the\nspecified id.", "operationId"=>"retrieves-the-metadata-for-the-active-schema-definition-with-thespecified-id", "x-api-path-slug"=>"schemasschemaid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Schemas", "SchemaId"]}}, "/schemas/{schemaId}/content"=>{"get"=>{"summary"=>"Get the contents of the active schema definition file", "description"=>"Retrieves the content of the active schema definition file with the\nspecified id.", "operationId"=>"retrieves-the-content-of-the-active-schema-definition-file-with-thespecified-id", "x-api-path-slug"=>"schemasschemaidcontent-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Schemas", "SchemaId", "Content"]}}, "/draft/schemas"=>{"get"=>{"summary"=>"Query draft schema definitions", "description"=>"Schemas are used to define the structure of Events, Device State and\nThing State in the Watson IoT Platform.\n\n - For Events, they define the structure of the payload of the events\n that are published to the platform by devices.\n\n - For Device and Thing State, they define the structure of the state\n that is stored by the platform.\n\nThe **/draft/schemas** endpoint returns the list of all of the draft \nschema for the organization in the Watson IoT Platform. Various query\nparameters can be used to filter, sort and page through the list of\nschemas that are returned.", "operationId"=>"schemas-are-used-to-define-the-structure-of-events-device-state-andthing-state-in-the-watson-iot-pla", "x-api-path-slug"=>"draftschemas-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Schemas"]}, "post"=>{"summary"=>"Create a draft schema definition", "description"=>"Creates a new draft schema definition for the organization in the Watson\nIoT Platform.\n\nThe schema definition file is passed to the Watson IoT Platform within a\nmultipart POST (multipart/form-data). The body of the POST **must**\ncontain at least two parts:\n\n - One with a name of **schemaFile** that contains the actual content\n of the file as the body of the part.\n \n - One with a name of **name** that contains a string that defines the\n name of the schema resource in the body of the part.\n\nAdditional metadata can be passed in other parts within the multipart\nPOST. For example, to specify a description for the new schema\ndefinition, you should include a part with the name **description** and\nthe description as the body of the part. To specify the type of the\nschema, you should include a part with the name **schemaType** and one\nof the following in the body of the part (the schemaType defaults to\njson-schema if the no schemaType part is present):\n\n - json-schema\n\nIf parts with names other than those specified above are included in the\nmultipart POST the request will fail and an HTTP status code of 400 will\nbe returned.\n\nThe content of the schema definition file that is passed to the platform\nis stored and a REST resource is created containing metadata that\ndescribes the schema definition.", "operationId"=>"creates-a-new-draft-schema-definition-for-the-organization-in-the-watsoniot-platformthe-schema-defin", "x-api-path-slug"=>"draftschemas-post", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Schemas"]}}, "/draft/schemas/{schemaId}"=>{"get"=>{"summary"=>"Get draft schema definition metadata", "description"=>"Retrieves the metadata for the draft schema definition with the\nspecified id.", "operationId"=>"retrieves-the-metadata-for-the-draft-schema-definition-with-thespecified-id", "x-api-path-slug"=>"draftschemasschemaid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Schemas", "SchemaId"]}, "put"=>{"summary"=>"Update draft schema definition metadata", "description"=>"Updates the metadata for the draft schema definition with the specified\nid. The following properties can be updated:\n\n - name\n - description\n \nNote that if the description field is omitted from the body of the\nupdate, then any existing description will be removed from the schema\ndefinition.\n \nAny changes made to the values of the following properties will be\nignored:\n\n - schemaType\n - schemaFilename\n - contentType\n - created\n - createdBy\n - updated\n - updatedBy\n - refs\n \nThe schemaFilename and contentType properties are updated when the\ncontent of the schema file is updated.\n\nThe values of the created, createdBy, updated, updatedBy and refs\nproperties are set on the server as a result of a successful update.", "operationId"=>"updates-the-metadata-for-the-draft-schema-definition-with-the-specifiedid-the-following-properties-c", "x-api-path-slug"=>"draftschemasschemaid-put", "parameters"=>[{"in"=>"body", "name"=>"schemaDefinition", "description"=>"The JSON representation of the schema definition", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Schemas", "SchemaId"]}, "delete"=>{"summary"=>"Delete a draft schema definition", "description"=>"Deletes the draft schema definition with the specified id from the\norganization in the Watson IoT Platform. Deleting the schema definition\ndeletes both the metadata and the actual schema definition file from the\nWatson IoT Platform.\n\nPlease note the the delete will fail if the draft schema definition is\nbeing referenced by an event type or logical interface.", "operationId"=>"deletes-the-draft-schema-definition-with-the-specified-id-from-theorganization-in-the-watson-iot-pla", "x-api-path-slug"=>"draftschemasschemaid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Schemas", "SchemaId"]}}, "/draft/schemas/{schemaId}/content"=>{"get"=>{"summary"=>"Get the contents of the draft schema definition file", "description"=>"Retrieves the content of the draft schema definition file with the\nspecified id.", "operationId"=>"retrieves-the-content-of-the-draft-schema-definition-file-with-thespecified-id", "x-api-path-slug"=>"draftschemasschemaidcontent-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Schemas", "SchemaId", "Content"]}, "put"=>{"summary"=>"Update the content of a draft schema definition file", "description"=>"Updates the content of a draft schema definition file with the specified\nid.\n\nThe schema definition file is passed to the Watson IoT Platform within a\nmultipart POST (multipart/form-data). The body of the POST **must**\ncontain one part with a name of the **schemaFile** and the\nactual schema file as the body of the part.\n\nPlease note that the schemaFilename and contentType properties of the\nschema definition will also be updated as a result of updating the\ncontent of the schema file.", "operationId"=>"updates-the-content-of-a-draft-schema-definition-file-with-the-specifiedidthe-schema-definition-file", "x-api-path-slug"=>"draftschemasschemaidcontent-put", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Schemas", "SchemaId", "Content"]}}, "/event/types"=>{"get"=>{"summary"=>"Query active event types", "description"=>"Event types are used to model the events that are published to the\nWatson IoT Platform. An event type must be created in an organization\nbefore more complex processing can be performed on the native event.\n\nThe **/event/types** endpoint returns the list of all of the active\nevent types that have been defined for the organization in the Watson\nIoT Platform. Various query parameters can be used to filter, sort and\npage through the list of active event types that are returned.", "operationId"=>"event-types-are-used-to-model-the-events-that-are-published-to-thewatson-iot-platform--an-event-type", "x-api-path-slug"=>"eventtypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Event", "Types"]}}, "/event/types/{eventTypeId}"=>{"get"=>{"summary"=>"Get an active event type", "description"=>"Retrieve the active event type with the specified id.", "operationId"=>"retrieve-the-active-event-type-with-the-specified-id", "x-api-path-slug"=>"eventtypeseventtypeid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Event", "Types", "EventTypeId"]}}, "/draft/event/types"=>{"get"=>{"summary"=>"Query draft event types", "description"=>"Event types are used to model the events that are published to the\nWatson IoT Platform. An event type must be created in an organization\nbefore more complex processing can be performed on the native event.\n\nThe **/draft/event/types** endpoint returns the list of all of the draft\nevent types that have been defined for the organization in the Watson\nIoT Platform. Various query parameters can be used to filter, sort and\npage through the list of draft event types that are returned.", "operationId"=>"event-types-are-used-to-model-the-events-that-are-published-to-thewatson-iot-platform--an-event-type", "x-api-path-slug"=>"drafteventtypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Event", "Types"]}, "post"=>{"summary"=>"Create a draft event type", "description"=>"Creates a new draft event type for the organization in the Watson IoT\nPlatform. The draft event type must reference the schema definition\nthat defines the structure of the inbound MQTT event.", "operationId"=>"creates-a-new-draft-event-type-for-the-organization-in-the-watson-iotplatform--the-draft-event-type-", "x-api-path-slug"=>"drafteventtypes-post", "parameters"=>[{"in"=>"body", "name"=>"Event Type", "description"=>"The JSON representation of the draft event type", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Event", "Types"]}}, "/draft/event/types/{eventTypeId}"=>{"get"=>{"summary"=>"Get a draft event type", "description"=>"Retrieve the draft event type with the specified id.", "operationId"=>"retrieve-the-draft-event-type-with-the-specified-id", "x-api-path-slug"=>"drafteventtypeseventtypeid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Event", "Types", "EventTypeId"]}, "put"=>{"summary"=>"Update a draft event type", "description"=>"Updates the draft event type with the specified id. The following\nproperties can be updated:\n\n - name\n - description\n - schemaId\n\nNote that if the description field is omitted from the body of the\nupdate, then any existing description will be removed from the event\ntype.\n \nAny changes made to the values of the following properties will be\nignored:\n\n - created\n - createdBy\n - updated\n - updatedBy\n - refs\n \nThe values of these properties are set on the server as a result of a\nsuccessful update.", "operationId"=>"updates-the-draft-event-type-with-the-specified-id-the-followingproperties-can-be-updated---name---d", "x-api-path-slug"=>"drafteventtypeseventtypeid-put", "parameters"=>[{"in"=>"body", "name"=>"Event Type", "description"=>"The JSON representation of the event type", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Event", "Types", "EventTypeId"]}, "delete"=>{"summary"=>"Delete a draft event type", "description"=>"Deletes the draft event type with the specified id from the organization\nin the Watson IoT Platform.\n\nPlease note the the delete will fail if the draft event type is being \nreferenced by a physical interface.", "operationId"=>"deletes-the-draft-event-type-with-the-specified-id-from-the-organizationin-the-watson-iot-platformpl", "x-api-path-slug"=>"drafteventtypeseventtypeid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Event", "Types", "EventTypeId"]}}, "/physicalinterfaces"=>{"get"=>{"summary"=>"Query active phyiscal interfaces", "description"=>"Physical interfaces are used to model the interfaces between physical\ndevices and the Watson IoT Platform. A physical interface references\nevent types. Devices that implement a physical interface publish these\nevents to the platform.\n\nThe event types are referenced via a mapping that maps an event id to\nthe id of an event type. The event id corresponds to the MQTT topic\nthat the event is published to by a device.\n\nThe **physicalinterfaces** endpoint returns the list of all of the\nactive physical interfaces that have been defined for the organization\nin the Watson IoT Platform. Various query parameters can be used to\nfilter, sort and page through the list of active physical interfaces\nthat are returned.", "operationId"=>"physical-interfaces-are-used-to-model-the-interfaces-between-physicaldevices-and-the-watson-iot-plat", "x-api-path-slug"=>"physicalinterfaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Physicalinterfaces"]}}, "/physicalinterfaces/{physicalInterfaceId}"=>{"get"=>{"summary"=>"Get an active physical interface", "description"=>"Retrieve the active physical interface with the specified id.", "operationId"=>"retrieve-the-active-physical-interface-with-the-specified-id", "x-api-path-slug"=>"physicalinterfacesphysicalinterfaceid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Physicalinterfaces", "PhysicalInterfaceId"]}}, "/physicalinterfaces/{physicalInterfaceId}/events"=>{"get"=>{"summary"=>"Get the list of event mappings", "description"=>"Retrieve the list of event mappings for the active physical interface.\nEvent mappings are keyed off of the event id specified in the MQTT topic\nthat the inbound events are published to.", "operationId"=>"retrieve-the-list-of-event-mappings-for-the-active-physical-interfaceevent-mappings-are-keyed-off-of", "x-api-path-slug"=>"physicalinterfacesphysicalinterfaceidevents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Physicalinterfaces", "PhysicalInterfaceId", "Events"]}}, "/draft/physicalinterfaces"=>{"get"=>{"summary"=>"Query draft phyiscal interfaces", "description"=>"Physical interfaces are used to model the interfaces between physical\ndevices and the Watson IoT Platform. A physical interface references\nevent types. Devices that implement a physical interface publish these\nevents to the platform.\n\nThe event types are referenced via a mapping that maps an event id to\nthe id of an event type. The event id corresponds to the MQTT topic\nthat the event is published to by a device.\n\nThe **/draft/physicalinterfaces** endpoint returns the list of all of \nthe draft physical interfaces that have been defined for the\norganization in the Watson IoT Platform. Various query parameters can\nbe used to filter, sort and page through the list of draft physical\ninterfaces that are returned.", "operationId"=>"physical-interfaces-are-used-to-model-the-interfaces-between-physicaldevices-and-the-watson-iot-plat", "x-api-path-slug"=>"draftphysicalinterfaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Physicalinterfaces"]}, "post"=>{"summary"=>"Create a draft physical interface", "description"=>"Creates a new draft physical interface for the organization in the \nWatson IoT Platform.", "operationId"=>"creates-a-new-draft-physical-interface-for-the-organization-in-the-watson-iot-platform", "x-api-path-slug"=>"draftphysicalinterfaces-post", "parameters"=>[{"in"=>"body", "name"=>"Physical Interface", "description"=>"The JSON representation of the physical interface", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Physicalinterfaces"]}}, "/draft/physicalinterfaces/{physicalInterfaceId}"=>{"get"=>{"summary"=>"Get a draft physical interface", "description"=>"Retrieve the draft physical interface with the specified id.", "operationId"=>"retrieve-the-draft-physical-interface-with-the-specified-id", "x-api-path-slug"=>"draftphysicalinterfacesphysicalinterfaceid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Physicalinterfaces", "PhysicalInterfaceId"]}, "put"=>{"summary"=>"Update a draft physical interface", "description"=>"Updates the draft physical interface with the specified id. The \nfollowing properties can be updated:\n\n - name\n - description\n\nNote that if the description field is omitted from the body of the\nupdate, then any existing description will be removed from the physical\ninterface.\n \nAny changes made to the values of the following properties will be\nignored:\n\n - created\n - createdBy\n - updated\n - updatedBy\n - refs\n \nThe values of these properties are set on the server as a result of a\nsuccessful update.", "operationId"=>"updates-the-draft-physical-interface-with-the-specified-id-the-following-properties-can-be-updated--", "x-api-path-slug"=>"draftphysicalinterfacesphysicalinterfaceid-put", "parameters"=>[{"in"=>"body", "name"=>"Physical Interface", "description"=>"The JSON representation of the physical interface", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Physicalinterfaces", "PhysicalInterfaceId"]}, "delete"=>{"summary"=>"Delete a draft physical interface", "description"=>"Deletes the draft physical interface with the specified id from the\norganization in the Watson IoT Platform.\n\nPlease note the the delete will fail if the draft physical interface is\nbeing referenced by a device type.", "operationId"=>"deletes-the-draft-physical-interface-with-the-specified-id-from-theorganization-in-the-watson-iot-pl", "x-api-path-slug"=>"draftphysicalinterfacesphysicalinterfaceid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Physicalinterfaces", "PhysicalInterfaceId"]}}, "/draft/physicalinterfaces/{physicalInterfaceId}/events"=>{"get"=>{"summary"=>"Get the list of event mappings", "description"=>"Retrieve the list of event mappings for the draft physical interface.\nEvent mappings are keyed off of the event id specified in the MQTT topic\nthat the inbound events are published to.", "operationId"=>"retrieve-the-list-of-event-mappings-for-the-draft-physical-interfaceevent-mappings-are-keyed-off-of-", "x-api-path-slug"=>"draftphysicalinterfacesphysicalinterfaceidevents-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Physicalinterfaces", "PhysicalInterfaceId", "Events"]}, "post"=>{"summary"=>"Map an event to the draft physical interface", "description"=>"Maps an event id to a specific event type for the draft specified\nphysical interface.", "operationId"=>"maps-an-event-id-to-a-specific-event-type-for-the-draft-specifiedphysical-interface", "x-api-path-slug"=>"draftphysicalinterfacesphysicalinterfaceidevents-post", "parameters"=>[{"in"=>"body", "name"=>"Event Mapping", "description"=>"The JSON representation of the event mapping", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Physicalinterfaces", "PhysicalInterfaceId", "Events"]}}, "/draft/physicalinterfaces/{physicalInterfaceId}/events/{eventId}"=>{"delete"=>{"summary"=>"Remove an event mapping from the draft physical interface", "description"=>"Removes the event mapping with the specified id from the draft physical\ninterface.", "operationId"=>"removes-the-event-mapping-with-the-specified-id-from-the-draft-physicalinterface", "x-api-path-slug"=>"draftphysicalinterfacesphysicalinterfaceideventseventid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Physicalinterfaces", "PhysicalInterfaceId", "Events", "EventId"]}}, "/logicalinterfaces"=>{"get"=>{"summary"=>"Query active logical interfaces", "description"=>"Logical interfaces are used to model the interfaces exposed by a\ndevice or thing in the Watson IoT Platform. A logical interface\nmust reference a schema definition that defines the structure of the\nstate that will be stored for the device or thing.\n\nThe **logicalinterfaces** endpoint returns the list of all of the\nactive logical interfaces that have been defined for the organization\nin the Watson IoT Platform. Various query parameters can\nbe used to filter, sort and page through the list of active logical\ninterfaces that are returned.", "operationId"=>"logical-interfaces-are-used-to-model-the-interfaces-exposed-by-adevice-or-thing-in-the-watson-iot-pl", "x-api-path-slug"=>"logicalinterfaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Logical interfaces"]}}, "/logicalinterfaces/{logicalInterfaceId}"=>{"get"=>{"summary"=>"Get an active logical interface", "description"=>"Retrieve the active logical interface with the specified id.", "operationId"=>"retrieve-the-active-logical-interface-with-the-specified-id", "x-api-path-slug"=>"logicalinterfaceslogicalinterfaceid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Logical interfaces", "LogicalInterfaceId"]}, "patch"=>{"summary"=>"Perform an operation against a logical interface", "description"=>"Performs the specified operation against the logical interface. The\nfollowing values can be specified for the operation property:\n\n - deactivate-configuration\n\nThe **deactivate-configuration** operation will remove any active\nconfiguration that is currently associated with the logical\ninterface. If the logical interface is associated with any device\ntypes, the state for any instances of those device types will be deleted\nas a result of performing the **deactivate-configuration** operation.\nThe **deactivate-configuration** operation will fail if the logical\ninterface is referenced by a thing schema.", "operationId"=>"performs-the-specified-operation-against-the-logical-interface-thefollowing-values-can-be-specified-", "x-api-path-slug"=>"logicalinterfaceslogicalinterfaceid-patch", "parameters"=>[{"in"=>"body", "name"=>"Operation", "description"=>"The JSON representation of an operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Logical interfaces", "LogicalInterfaceId"]}}, "/draft/logicalinterfaces"=>{"get"=>{"summary"=>"Query draft logical interfaces", "description"=>"Logical interfaces are used to model the interfaces exposed by a\ndevice or thing in the Watson IoT Platform. A logical interface must\nreference a schema definition that defines the structure of the\nstate that will be stored for the device or thing.\n\nThe **logicalinterfaces** endpoint returns the list of all of the\ndraft logical interfaces that have been defined for the organization\nin the Watson IoT Platform. Various query parameters can be used to\nfilter, sort and page through the list of draft logical interfaces\nthat are returned.", "operationId"=>"logical-interfaces-are-used-to-model-the-interfaces-exposed-by-adevice-or-thing-in-the-watson-iot-pl", "x-api-path-slug"=>"draftlogicalinterfaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Logical interfaces"]}, "post"=>{"summary"=>"Create a draft logical interface", "description"=>"Creates a new draft logical interface for the organization in the\nWatson IoT Platform. The logical interface must reference a schema\ndefinition that defines the structure of the state that will be stored\nfor the device or thing.", "operationId"=>"creates-a-new-draft-logical-interface-for-the-organization-in-thewatson-iot-platform-the-logical-int", "x-api-path-slug"=>"draftlogicalinterfaces-post", "parameters"=>[{"in"=>"body", "name"=>"Logical Interface", "description"=>"The JSON representation of the draft logical interface", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Logical interfaces"]}}, "/draft/logicalinterfaces/{logicalInterfaceId}"=>{"get"=>{"summary"=>"Get a draft logical interface", "description"=>"Retrieve the draft logical interface with the specified id.", "operationId"=>"retrieve-the-draft-logical-interface-with-the-specified-id", "x-api-path-slug"=>"draftlogicalinterfaceslogicalinterfaceid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Logical interfaces", "LogicalInterfaceId"]}, "put"=>{"summary"=>"Update a draft logical interface", "description"=>"Updates the draft logical interface with the specified id. The\nfollowing properties can be updated: \n\n - name\n - description\n - schemaId\n\nNote that if the description field is omitted from the body of the\nupdate, then any existing description will be removed from the logical\ninterface.\n \nAny changes made to the values of the following properties will be\nignored:\n\n - created\n - createdBy\n - updated\n - updatedBy\n - refs\n \nThe values of these properties are set on the server as a result of a\nsuccessful update.", "operationId"=>"updates-the-draft-logical-interface-with-the-specified-id-thefollowing-properties-can-be-updated----", "x-api-path-slug"=>"draftlogicalinterfaceslogicalinterfaceid-put", "parameters"=>[{"in"=>"body", "name"=>"Logical Interface", "description"=>"The JSON representation of the draft logical interface", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Logical interfaces", "LogicalInterfaceId"]}, "patch"=>{"summary"=>"Perform an operation against a draft logical interface", "description"=>"Performs the specified operation against the draft logical\ninterface. The following values can be specified for the operation\nproperty:\n\n - validate-configuration\n - activate-configuration\n - list-differences\n\nThe **validate-configuration** operation will analyze all of the \nconfiguration associated with the draft logical interface to\ndetermine if it is valid. If the configuration is invalid, a list of \nthe issues will be returned in the body of the response. \n \nThe **activate-configuration** operation will make the configuration\nassociated with the draft logical interface active. The \n**activate-configuration** operation must have been performed against\na draft logical interface before any state is generated for device\nor thing types that are associated with that logical interface.\n\nThe **list-differences** operation will return a list of the differences\nthat exist between the active configuration for the logical\ninterface, if any, and the draft configuration.", "operationId"=>"performs-the-specified-operation-against-the-draft-logicalinterface-the-following-values-can-be-spec", "x-api-path-slug"=>"draftlogicalinterfaceslogicalinterfaceid-patch", "parameters"=>[{"in"=>"body", "name"=>"Operation", "description"=>"The JSON representation of the operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Logical interfaces", "LogicalInterfaceId"]}, "delete"=>{"summary"=>"Delete a draft logical interface", "description"=>"Deletes the draft logical interface with the specified id from the\norganization in the Watson IoT Platform.\n\nPlease note the the delete will fail if the draft logical interface\nis being referenced by a device type.", "operationId"=>"deletes-the-draft-logical-interface-with-the-specified-id-from-theorganization-in-the-watson-iot-pla", "x-api-path-slug"=>"draftlogicalinterfaceslogicalinterfaceid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Logical interfaces", "LogicalInterfaceId"]}}, "/logicalinterfaces/{logicalInterfaceId}/rules"=>{"get"=>{"summary"=>"Query active rules", "description"=>"Rules allow you to specify conditions that can be used to trigger\nactions. For example, you might create a rule that sends an email if\nthe temperature of a device exceeds a certain value.\n\nRules are defined against a specific logical interface schema. At\nruntime, a rule will be evaluated whenever the state for a Device that\nexposes the logical interface changes.\n\nThe **/logicalinterfaces/{logicalInterfaceId}/rules** endpoint returns\nthe list of all of the active rules that have been associated with the\nlogical interface. Various query parameters can be used to filter, sort\nand page through the list of rules that are returned.", "operationId"=>"rules-allow-you-to-specify-conditions-that-can-be-used-to-triggeractions-for-example-you-might-creat", "x-api-path-slug"=>"logicalinterfaceslogicalinterfaceidrules-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Logical interfaces", "LogicalInterfaceId", "Rules"]}}, "/logicalinterfaces/{logicalInterfaceId}/rules/{ruleId}"=>{"get"=>{"summary"=>"Get an active rule", "description"=>"Retrieve the active rule with the specified id that has been associated\nwith the specified logical interface.", "operationId"=>"retrieve-the-active-rule-with-the-specified-id-that-has-been-associatedwith-the-specified-logical-in", "x-api-path-slug"=>"logicalinterfaceslogicalinterfaceidrulesruleid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Logical interfaces", "LogicalInterfaceId", "Rules", "RuleId"]}}, "/draft/logicalinterfaces/{logicalInterfaceId}/rules"=>{"get"=>{"summary"=>"Query draft rules", "description"=>"Rules allow you to specify conditions that can be used to trigger\nactions. For example, you might create a rule that sends an email if\nthe temperature of a device exceeds a certain value.\n\nRules are defined against a specific logical interface schema. At\nruntime, a rule will be evaluated whenever the state for a Device that\nexposes the logical interface changes.\n\nThe **/draft/logicalinterfaces/{logicalInterfaceId}/rules** endpoint\nreturns the list of all of the draft rules that have been associated\nwith the logical interface. Various query parameters can be used to\nfilter, sort and page through the list of rules that are returned.", "operationId"=>"rules-allow-you-to-specify-conditions-that-can-be-used-to-triggeractions-for-example-you-might-creat", "x-api-path-slug"=>"draftlogicalinterfaceslogicalinterfaceidrules-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Logical interfaces", "LogicalInterfaceId", "Rules"]}, "post"=>{"summary"=>"Create a draft rule", "description"=>"Creates a new draft rule that is associated with the logical interface\nfor the organization in the Watson IoT Platform.", "operationId"=>"creates-a-new-draft-rule-that-is-associated-with-the-logical-interfacefor-the-organization-in-the-wa", "x-api-path-slug"=>"draftlogicalinterfaceslogicalinterfaceidrules-post", "parameters"=>[{"in"=>"body", "name"=>"Rule", "description"=>"The JSON representation of the draft rule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Logical interfaces", "LogicalInterfaceId", "Rules"]}}, "/draft/logicalinterfaces/{logicalInterfaceId}/rules/{ruleId}"=>{"get"=>{"summary"=>"Get a draft rule", "description"=>"Retrieve the draft rule with the specified id that has been associated\nwith the specified logical interface.", "operationId"=>"retrieve-the-draft-rule-with-the-specified-id-that-has-been-associatedwith-the-specified-logical-int", "x-api-path-slug"=>"draftlogicalinterfaceslogicalinterfaceidrulesruleid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Logical interfaces", "LogicalInterfaceId", "Rules", "RuleId"]}, "put"=>{"summary"=>"Update a draft rule", "description"=>"Updates the draft rule with the specified id. The following properties\ncan be updated: \n\n - name\n - description\n - condition\n\nNote that if the description field is omitted from the body of the\nupdate, then any existing description will be removed from the rule.\n \nAny changes made to the values of the following properties will be\nignored:\n\n - created\n - createdBy\n - updated\n - updatedBy\n - refs\n \nThe values of these properties are set on the server as a result of a\nsuccessful update.", "operationId"=>"updates-the-draft-rule-with-the-specified-id-the-following-propertiescan-be-updated----name---descri", "x-api-path-slug"=>"draftlogicalinterfaceslogicalinterfaceidrulesruleid-put", "parameters"=>[{"in"=>"body", "name"=>"Rule", "description"=>"The JSON representation of the draft rule", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Logical interfaces", "LogicalInterfaceId", "Rules", "RuleId"]}, "delete"=>{"summary"=>"Delete a draft rule", "description"=>"Deletes the draft rule with the specified id from the organization in\nthe Watson IoT Platform.", "operationId"=>"deletes-the-draft-rule-with-the-specified-id-from-the-organization-inthe-watson-iot-platform", "x-api-path-slug"=>"draftlogicalinterfaceslogicalinterfaceidrulesruleid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Logical interfaces", "LogicalInterfaceId", "Rules", "RuleId"]}}, "/device/types"=>{"get"=>{"summary"=>"List device types", "description"=>"Sorting can be performed on any of the following properties (sort\norder can be reversed by prefixing the property name with '-'):\n- id\n- description\n- deviceInfo.description\n- deviceInfo.descriptiveLocation\n- deviceInfo.serialNumber\n- deviceInfo.deviceClass\n- deviceInfo.fwVersion\n- deviceInfo.hwVersion\n- deviceInfo.manufacturer\n- deviceInfo.model\n\nThe following facets are supported:\n- deviceInfo.deviceClass\n- deviceInfo.fwVersion\n- deviceInfo.hwVersion\n- deviceInfo.manufacturer\n- deviceInfo.model", "operationId"=>"sorting-can-be-performed-on-any-of-the-following-properties-sortorder-can-be-reversed-by-prefixing-t", "x-api-path-slug"=>"devicetypes-get", "parameters"=>[{"in"=>"query", "name"=>"description", "description"=>"Optional filter of results by description"}, {"in"=>"query", "name"=>"id", "description"=>"Optional filter of results by ID"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Device", "Types"]}}, "/device/types/{typeId}"=>{"patch"=>{"summary"=>"Perform an operation against a device type", "description"=>"Performs the specified operation against the device type. The following\nvalues can be specified for the operation property:\n\n - deactivate-configuration\n\nThe **deactivate-configuration** operation will remove any activate\nconfiguration that is currently associated with the device type. If any\ninstances of the device type exist, the state for those devices will be\ndeleted as a result of performing the **deactivate-configuration**\noperation. The **deactivate-configuration** operation will fail if\nany instances of the device type are being aggregated into an instance\nof a thing.", "operationId"=>"performs-the-specified-operation-against-the-device-type-the-followingvalues-can-be-specified-for-th", "x-api-path-slug"=>"devicetypestypeid-patch", "parameters"=>[{"in"=>"body", "name"=>"Device Type Operation", "description"=>"The JSON representation of a device type operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Device", "Types"]}}, "/device/types/{typeId}/physicalinterface"=>{"get"=>{"summary"=>"Get the active physical interface associated with the device type", "description"=>"Retrieve the active physical interface that has been associated with the\ndevice type. At least one active physical interface must be associated\nwith the device type before any mappings can be defined that will\ngenerate state for the device.", "operationId"=>"retrieve-the-active-physical-interface-that-has-been-associated-with-thedevice-type--at-least-one-ac", "x-api-path-slug"=>"devicetypestypeidphysicalinterface-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Device", "Types", "Physicalinterface"]}}, "/device/types/{typeId}/logicalinterfaces"=>{"get"=>{"summary"=>"Get the list of active logical interfaces associated with the device\ntype", "description"=>"Retrieve the list of active logical interfaces that have been\nassociated with the device type. At least one logical interface\nmust be associated with the device type before any mappings can be\ndefined that will generate state for the device.", "operationId"=>"retrieve-the-list-of-active-logical-interfaces-that-have-beenassociated-with-the-device-type--at-lea", "x-api-path-slug"=>"devicetypestypeidlogicalinterfaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Device", "Types", "Logical interfaces"]}}, "/device/types/{typeId}/mappings"=>{"get"=>{"summary"=>"Get the list of active property mappings for the device type", "description"=>"Retrieve the list of active property mappings for the specified device\ntype. A property mapping defines how properties from inbound events are\nmapped to properties defined on an logical interface associated with\nthe device type.", "operationId"=>"retrieve-the-list-of-active-property-mappings-for-the-specified-devicetype--a-property-mapping-defin", "x-api-path-slug"=>"devicetypestypeidmappings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Device", "Types", "Mappings"]}}, "/device/types/{typeId}/mappings/{logicalInterfaceId}"=>{"get"=>{"summary"=>"Get the active property mappings for a specific logical interface\nfor a device type.", "description"=>"Retrieves the active property mappings for a specific logical\ninterface for the device type.", "operationId"=>"retrieves-the-active-property-mappings-for-a-specific-logicalinterface-for-the-device-type", "x-api-path-slug"=>"devicetypestypeidmappingslogicalinterfaceid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Device", "Types", "Mappings", "LogicalInterfaceId"]}}, "/draft/device/types"=>{"get"=>{"summary"=>"List device types associated with an logical or physical interface", "description"=>"Retrieves the list of device types that are associated with the\nlogical interface and/or physical interface with the ids specified\nusing the corresponding query parameters.\n\nNote that at least one of the following query parameters must be\nspecified:\n\n - logicalInterfaceId\n - physicalInterfaceId", "operationId"=>"retrieves-the-list-of-device-types-that-are-associated-with-thelogical-interface-andor-physical-inte", "x-api-path-slug"=>"draftdevicetypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Device", "Types"]}}, "/draft/device/types/{typeId}"=>{"patch"=>{"summary"=>"Perform an operation against a draft device type", "description"=>"Performs the specified operation against the draft device type. The\nfollowing values can be specified for the operation property:\n\n - validate-configuration\n - activate-configuration\n - list-differences\n\nThe **validate-configuration** operation will analyze all of the \nconfiguration associated with the draft device type to determine if it\nis valid. If the configuration is invalid, a list of the issues will\nbe returned in the body of the response. \n \nThe **activate-configuration** operation will make the configuration\nassociated with the draft device type active. The\n**activate-configuration** operation must have been performed against a\ndraft device type before any state is generated for instances of that\ntype.\n\nThe **list-differences** operation will return a list of the differences\nthat exist between the active configuration for the device type, if\nany, and the draft configuration.", "operationId"=>"performs-the-specified-operation-against-the-draft-device-type-thefollowing-values-can-be-specified-", "x-api-path-slug"=>"draftdevicetypestypeid-patch", "parameters"=>[{"in"=>"body", "name"=>"Device Type Operation", "description"=>"The JSON representation of a device type operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Device", "Types"]}}, "/draft/device/types/{typeId}/physicalinterface"=>{"get"=>{"summary"=>"Get the draft physical interface associated with the device type", "description"=>"Retrieve the draft physical interface that has been associated with the\ndevice type. At least one active physical interface must be associated\nwith the device type before any mappings can be defined that will\ngenerate state for the device.", "operationId"=>"retrieve-the-draft-physical-interface-that-has-been-associated-with-thedevice-type--at-least-one-act", "x-api-path-slug"=>"draftdevicetypestypeidphysicalinterface-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Device", "Types", "Physicalinterface"]}, "post"=>{"summary"=>"Associate a draft physical interface with the device type", "description"=>"Associates a draft physical interface with the specified device type.\nThe draft physical interface must already exist within the organization\nin the Watson IoT Platform. If a draft physical interface is already\nassociated with the device type it will be replaced with the specified\nphysical interface.", "operationId"=>"associates-a-draft-physical-interface-with-the-specified-device-typethe-draft-physical-interface-mus", "x-api-path-slug"=>"draftdevicetypestypeidphysicalinterface-post", "parameters"=>[{"in"=>"body", "name"=>"Physical Interface", "description"=>"The JSON representation of the draft physical interface", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Device", "Types", "Physicalinterface"]}, "delete"=>{"summary"=>"Disassociate the draft physical interface from the device type", "description"=>"Disassociates the draft physical interface from the device type.", "operationId"=>"disassociates-the-draft-physical-interface-from-the-device-type", "x-api-path-slug"=>"draftdevicetypestypeidphysicalinterface-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Device", "Types", "Physicalinterface"]}}, "/draft/device/types/{typeId}/logicalinterfaces"=>{"get"=>{"summary"=>"Get the list of draft logical interfaces associated with the device\ntype", "description"=>"Retrieve the list of draft logical interfaces that have been\nassociated with the device type. At least one active logical\ninterface must be associated with the device type before any mappings\ncan be defined that will generate state for the device.", "operationId"=>"retrieve-the-list-of-draft-logical-interfaces-that-have-beenassociated-with-the-device-type--at-leas", "x-api-path-slug"=>"draftdevicetypestypeidlogicalinterfaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Device", "Types", "Logical interfaces"]}, "post"=>{"summary"=>"Associate a draft logical interface with the device type", "description"=>"Associates a draft logical interface with the specified device type.\nThe draft logical interface must already exist within the organization\nin the Watson IoT Platform.", "operationId"=>"associates-a-draft-logical-interface-with-the-specified-device-typethe-draft-logical-interface-must-", "x-api-path-slug"=>"draftdevicetypestypeidlogicalinterfaces-post", "parameters"=>[{"in"=>"body", "name"=>"Logical Interface", "description"=>"The JSON representation of the draft logical interface", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Device", "Types", "Logical interfaces"]}}, "/draft/device/types/{typeId}/logicalinterfaces/{logicalInterfaceId}"=>{"delete"=>{"summary"=>"Disassociate a draft logical interface from the device type", "description"=>"Disassociates the draft logical interface with the specified id\nfrom the device type.\n\nPlease note the the delete will fail if the draft logical interface\nbeing removed from the device type is referenced in the property\nmappings for the device type.", "operationId"=>"disassociates-the-draft-logical-interface--with-the-specified-idfrom-the-device-typeplease-note-the-", "x-api-path-slug"=>"draftdevicetypestypeidlogicalinterfaceslogicalinterfaceid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Device", "Types", "Logical interfaces", "LogicalInterfaceId"]}}, "/draft/device/types/{typeId}/mappings"=>{"get"=>{"summary"=>"Get the list of draft property mappings for the device type", "description"=>"Retrieve the list of draft property mappings for the specified device\ntype. A property mapping defines how properties from inbound events are\nmapped to properties defined on an logical interface associated with\nthe device type.", "operationId"=>"retrieve-the-list-of-draft-property-mappings-for-the-specified-devicetype--a-property-mapping-define", "x-api-path-slug"=>"draftdevicetypestypeidmappings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Device", "Types", "Mappings"]}, "post"=>{"summary"=>"Create the draft property mappings for a logical interface for the\ndevice type", "description"=>"Creates the draft property mappings for an logical interface for the\ndevice type. The mapping object must specify:\n- The id for for the logical interface that the mappings are for\n- The mappings that define how to map from properties on the inbound\n events to the properties on the logical interface. The mappings\n are keyed off of the event ids defined by the physical interface\n associated with the device type.", "operationId"=>"creates-the-draft-property-mappings-for-an-logical-interface-for-thedevice-type--the-mapping-object-", "x-api-path-slug"=>"draftdevicetypestypeidmappings-post", "parameters"=>[{"in"=>"body", "name"=>"Device Type Property Mappings", "description"=>"The JSON representation of the draft device type property mappings", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Device", "Types", "Mappings"]}}, "/draft/device/types/{typeId}/mappings/{logicalInterfaceId}"=>{"get"=>{"summary"=>"Get the draft property mappings for a specific logical interface for\na device type.", "description"=>"Retrieves the draft property mappings for a specific logical\ninterface for the device type.", "operationId"=>"retrieves-the-draft-property-mappings-for-a-specific-logicalinterface-for-the-device-type", "x-api-path-slug"=>"draftdevicetypestypeidmappingslogicalinterfaceid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Device", "Types", "Mappings", "LogicalInterfaceId"]}, "put"=>{"summary"=>"Update the draft property mappings for a specific logical interface\nfor the device type.", "description"=>"Updates the draft property mappings for a specific logical interface\nfor the device type.", "operationId"=>"updates-the-draft-property-mappings-for-a-specific-logical-interfacefor-the-device-type", "x-api-path-slug"=>"draftdevicetypestypeidmappingslogicalinterfaceid-put", "parameters"=>[{"in"=>"body", "name"=>"Device Type Property Mappings", "description"=>"The JSON representation of the draft device type property mappings", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Device", "Types", "Mappings", "LogicalInterfaceId"]}, "delete"=>{"summary"=>"Delete the draft property mappings for a specific logical interface\nfor the device type.", "description"=>"Deletes the draft property mappings for a specific logical interface\nfor the device type.", "operationId"=>"deletes-the-draft-property-mappings-for-a-specific-logical-interfacefor-the-device-type", "x-api-path-slug"=>"draftdevicetypestypeidmappingslogicalinterfaceid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Device", "Types", "Mappings", "LogicalInterfaceId"]}}, "/device/types/{typeId}/devices/{deviceId}/state/{logicalInterfaceId}"=>{"get"=>{"summary"=>"Get the state for the device with the specified id", "description"=>"Retrieve the current state of the device with the specified id.", "operationId"=>"retrieve-the-current-state-of-the-device-with-the-specified-id", "x-api-path-slug"=>"devicetypestypeiddevicesdeviceidstatelogicalinterfaceid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Device", "Types", "Devices", "DeviceId", "State", "LogicalInterfaceId"]}, "patch"=>{"summary"=>"Perform an operation against the device state for a logical interface", "description"=>"Performs the specified operation against the device state for a logical\ninterface. The following values can be specified for the operation\nproperty:\n\n - reset-state\n\nThe **reset-state** operation will reset the state of the specified\ndevice to the default values as defined by the schema for the logical\ninterface.", "operationId"=>"performs-the-specified-operation-against-the-device-state-for-a-logicalinterface-the-following-value", "x-api-path-slug"=>"devicetypestypeiddevicesdeviceidstatelogicalinterfaceid-patch", "parameters"=>[{"in"=>"body", "name"=>"Operation", "description"=>"The JSON representation of an operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Device", "Types", "Devices", "DeviceId", "State", "LogicalInterfaceId"]}}, "/thing/types"=>{"get"=>{"summary"=>"Query active thing types", "description"=>"Within the Watson IoT Platform, a Thing allows you to aggregate one or\nmore instances of a Device or Thing together to represent a more coarse\ngrained object. For example, you might aggregrate together a temperature\nsensor, flow sensor and power sensor together into a Boiler. \n\nThing Types are used to model Things. The Schema associated with a\nThing Type defines the type of objects that are aggregated togther to\nmake up an instance of a Thing. A Thing Type must be created in an \norganization before in instance of a Thing can be created.\n\nThe **/thing/types** endpoint returns the list of all of the active\nThing types that have been defined for the organization in the Watson IoT\nPlatform. Various query parameters can be used to filter, sort and page\nthrough the list of Thing types that are returned.", "operationId"=>"within-the-watson-iot-platform-a-thing-allows-you-to-aggregate-one-ormore-instances-of-a-device-or-t", "x-api-path-slug"=>"thingtypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Thing", "Types"]}}, "/thing/types/{thingTypeId}"=>{"get"=>{"summary"=>"Get an active thing type", "description"=>"Retrieve the active thing type with the specified id.", "operationId"=>"retrieve-the-active-thing-type-with-the-specified-id", "x-api-path-slug"=>"thingtypesthingtypeid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Thing", "Types", "ThingTypeId"]}, "patch"=>{"summary"=>"Perform an operation against an active thing type", "description"=>"Performs the specified operation against the active thing type. The\nfollowing values can be specified for the operation property:\n\n - deactivate-configuration\n\nThe **deactivate-configuration** operation will remove any active\nconfiguration that is currently associated with the thing type. The\n**deactivate-configuration** operation will fail if there are\nany instances of the thing type.", "operationId"=>"performs-the-specified-operation-against-the-active-thing-type-thefollowing-values-can-be-specified-", "x-api-path-slug"=>"thingtypesthingtypeid-patch", "parameters"=>[{"in"=>"body", "name"=>"Thing Type Operation", "description"=>"The JSON representation of a thing type operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Thing", "Types", "ThingTypeId"]}}, "/draft/thing/types"=>{"get"=>{"summary"=>"Query draft thing types", "description"=>"Within the Watson IoT Platform, a Thing allows you to aggregate one or\nmore instances of a Device or Thing together to represent a more coarse\ngrained object. For example, you might aggregrate together a temperature\nsensor, flow sensor and power sensor together into a Boiler. \n\nThing Types are used to model Things. The Schema associated with a\nThing Type defines the type of objects that are aggregated togther to\nmake up an instance of a Thing. A Thing Type must be created in an \norganization before in instance of a Thing can be created.\n\nThe **/draft/thing/types** endpoint returns the list of all of the draft\nThing types that have been defined for the organization in the Watson IoT\nPlatform. Various query parameters can be used to filter, sort and page\nthrough the list of draft Thing types that are returned.", "operationId"=>"within-the-watson-iot-platform-a-thing-allows-you-to-aggregate-one-ormore-instances-of-a-device-or-t", "x-api-path-slug"=>"draftthingtypes-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Thing", "Types"]}, "post"=>{"summary"=>"Create a draft thing type", "description"=>"Creates a new draft thing type for the organization in the Watson IoT\nPlatform. The thing type must reference the schema definition that\ndefines the structure of instances of the thing type.", "operationId"=>"creates-a-new-draft-thing-type-for-the-organization-in-the-watson-iotplatform--the-thing-type-must-r", "x-api-path-slug"=>"draftthingtypes-post", "parameters"=>[{"in"=>"body", "name"=>"Thing Type", "description"=>"The JSON representation of the thing type", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Thing", "Types"]}}, "/draft/thing/types/{thingTypeId}"=>{"get"=>{"summary"=>"Get a draft thing type", "description"=>"Retrieve the draft thing type with the specified id.", "operationId"=>"retrieve-the-draft-thing-type-with-the-specified-id", "x-api-path-slug"=>"draftthingtypesthingtypeid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Thing", "Types", "ThingTypeId"]}, "put"=>{"summary"=>"Update a draft thing type", "description"=>"Updates the draft thing type with the specified id. The following\nproperties can be updated:\n\n - name\n - description\n - schemaId\n - metadata\n\nNote that if the description field is omitted from the body of the\nupdate, then any existing description will be removed from the draft\nthing type.\n \nAny changes made to the values of the following properties will be\nignored:\n\n - version\n - created\n - createdBy\n - updated\n - updatedBy\n - refs\n \nThe values of these properties are set on the server as a result of a\nsuccessful update.", "operationId"=>"updates-the-draft-thing-type-with-the-specified-id-the-followingproperties-can-be-updated---name---d", "x-api-path-slug"=>"draftthingtypesthingtypeid-put", "parameters"=>[{"in"=>"body", "name"=>"Thing Type", "description"=>"The JSON representation of the thing type", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Thing", "Types", "ThingTypeId"]}, "patch"=>{"summary"=>"Perform an operation against a draft thing type", "description"=>"Performs the specified operation against the draft thing type. The\nfollowing values can be specified for the operation property:\n\n - validate-configuration\n - activate-configuration\n - list-differences\n\nThe **validate-configuration** operation will analyze all of the \nconfiguration associated with the draft thing type to determine if it is\nvalid. If the configuration is invalid, a list of the issues will be\nreturned in the body of the response. \n \nThe **activate-configuration** operation will make the configuration\nassociated with the draft thing type active. The \n**activate-configuration** operation must have been performed against a\ndraft thing type before any instances of that type can be created.\n\nThe **list-differences** operation will return a list of the differences\nthat exist between the active configuration for the thing type, if any,\nand the draft configuration.", "operationId"=>"performs-the-specified-operation-against-the-draft-thing-type-thefollowing-values-can-be-specified-f", "x-api-path-slug"=>"draftthingtypesthingtypeid-patch", "parameters"=>[{"in"=>"body", "name"=>"Thing Type Operation", "description"=>"The JSON representation of a thing type operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Thing", "Types", "ThingTypeId"]}, "delete"=>{"summary"=>"Delete a draft thing type", "description"=>"Deletes the draft thing type with the specified id from the organization\nin the Watson IoT Platform.\n\nPlease note the the delete will fail if there is an active version of the\nthing type or if the thing type is currently being referenced by another\nobject.", "operationId"=>"deletes-the-draft-thing-type-with-the-specified-id-from-the-organizationin-the-watson-iot-platformpl", "x-api-path-slug"=>"draftthingtypesthingtypeid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Thing", "Types", "ThingTypeId"]}}, "/thing/types/{thingTypeId}/logicalinterfaces"=>{"get"=>{"summary"=>"Get the list of active logical interfaces associated with the thing\ntype", "description"=>"Retrieve the list of active logical interfaces that have been associated\nwith the thing type. At least one logical interface must be associated\nwith the thing type before any mappings can be defined that will generate\nstate for the thing.", "operationId"=>"retrieve-the-list-of-active-logical--interfaces-that-have-been-associatedwith-the-thing-type--at-lea", "x-api-path-slug"=>"thingtypesthingtypeidlogicalinterfaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Thing", "Types", "ThingTypeId", "Logical interfaces"]}}, "/thing/types/{thingTypeId}/mappings"=>{"get"=>{"summary"=>"Get the list of active property mappings for the thing type", "description"=>"Retrieve the list of active property mappings for the specified thing\ntype. A property mapping defines how properties from state update events\non aggregated devices or things are mapped to properties defined on a\nlogical interface associated with the thing type.", "operationId"=>"retrieve-the-list-of-active-property-mappings-for-the-specified-thingtype--a-property-mapping-define", "x-api-path-slug"=>"thingtypesthingtypeidmappings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Thing", "Types", "ThingTypeId", "Mappings"]}}, "/thing/types/{thingTypeId}/mappings/{logicalInterfaceId}"=>{"get"=>{"summary"=>"Get the active property mappings for a specific logical interface for\na thing type.", "description"=>"Retrieves the active property mappings for a specific logical interface\nfor the thing type.", "operationId"=>"retrieves-the-active-property-mappings-for-a-specific-logical-interfacefor-the-thing-type", "x-api-path-slug"=>"thingtypesthingtypeidmappingslogicalinterfaceid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Thing", "Types", "ThingTypeId", "Mappings", "LogicalInterfaceId"]}}, "/draft/thing/types/{thingTypeId}/logicalinterfaces"=>{"get"=>{"summary"=>"Get the list of draft logical interfaces associated with the thing\ntype", "description"=>"Retrieve the list of draft logical interfaces that have been associated\nwith the draft thing type. At least one logical interface must be\nassociated with the thing type before any mappings can be defined that\nwill generate state for the thing.", "operationId"=>"retrieve-the-list-of-draft-logical-interfaces-that-have-been-associatedwith-the-draft-thing-type--at", "x-api-path-slug"=>"draftthingtypesthingtypeidlogicalinterfaces-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Thing", "Types", "ThingTypeId", "Logical interfaces"]}, "post"=>{"summary"=>"Associate a draft logical interface with the draft thing type", "description"=>"Associates a draft logical interface with the specified draft thing type.\nThe logical interface must already exist within the organization in the\nWatson IoT Platform.", "operationId"=>"associates-a-draft-logical-interface-with-the-specified-draft-thing-typethe-logical-interface-must-a", "x-api-path-slug"=>"draftthingtypesthingtypeidlogicalinterfaces-post", "parameters"=>[{"in"=>"body", "name"=>"Logical Interface", "description"=>"The JSON representation of the draft logical interface", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Thing", "Types", "ThingTypeId", "Logical interfaces"]}}, "/draft/thing/types/{thingTypeId}/logicalinterfaces/{logicalInterfaceId}"=>{"delete"=>{"summary"=>"Disassociate a logical interface from the draft thing type", "description"=>"Disassociates the draft logical interface with the specified id from the\ndraft thing type.\n\nPlease note the the delete will fail if the logical interface being\nremoved from the draft thing type is referenced in the property mappings\nfor the draft thing type.", "operationId"=>"disassociates-the-draft-logical-interface-with-the-specified-id-from-thedraft-thing-typeplease-note-", "x-api-path-slug"=>"draftthingtypesthingtypeidlogicalinterfaceslogicalinterfaceid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Thing", "Types", "ThingTypeId", "Logical interfaces", "LogicalInterfaceId"]}}, "/draft/thing/types/{thingTypeId}/mappings"=>{"get"=>{"summary"=>"Get the list of draft property mappings for the thing type", "description"=>"Retrieve the list of draft property mappings for the specified draft\nthing type. A property mapping defines how properties from state update\nevents on aggregated devices or things are mapped to properties defined\non a logical interface associated with the thing type.", "operationId"=>"retrieve-the-list-of-draft-property-mappings-for-the-specified-draftthing-type--a-property-mapping-d", "x-api-path-slug"=>"draftthingtypesthingtypeidmappings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Thing", "Types", "ThingTypeId", "Mappings"]}, "post"=>{"summary"=>"Create the draft property mappings for a logical interface for the thing\ntype", "description"=>"Creates the draft property mappings for a logical interface for the\nthing type. The mapping object must specify:\n- The id for for the logical interface that the mappings are for\n- The mappings that define how to map from properties on the state\n update events to the properties on the logical interface. The\n mappings are keyed off of the name of the internal properties of the\n thing type.", "operationId"=>"creates-the-draft-property-mappings-for-a-logical-interface-for-thething-type--the-mapping-object-mu", "x-api-path-slug"=>"draftthingtypesthingtypeidmappings-post", "parameters"=>[{"in"=>"body", "name"=>"Thing Type Property Mappings", "description"=>"The JSON representation of the thing type property mappings", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Thing", "Types", "ThingTypeId", "Mappings"]}}, "/draft/thing/types/{thingTypeId}/mappings/{logicalInterfaceId}"=>{"get"=>{"summary"=>"Get the draft property mappings for a specific logical interface for\na thing type.", "description"=>"Retrieves the draft property mappings for a specific logical interface\nfor the thing type.", "operationId"=>"retrieves-the-draft-property-mappings-for-a-specific-logical-interfacefor-the-thing-type", "x-api-path-slug"=>"draftthingtypesthingtypeidmappingslogicalinterfaceid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Thing", "Types", "ThingTypeId", "Mappings", "LogicalInterfaceId"]}, "put"=>{"summary"=>"Update the property mappings for a specific logical interface for\nthe thing type.", "description"=>"Updates the property mappings for a specific logical interface\nfor the draft thing type.", "operationId"=>"updates-the-property-mappings-for-a-specific-logical-interfacefor-the-draft-thing-type", "x-api-path-slug"=>"draftthingtypesthingtypeidmappingslogicalinterfaceid-put", "parameters"=>[{"in"=>"body", "name"=>"Thing Type Property Mappings", "description"=>"The JSON representation of the thing type property mappings", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Thing", "Types", "ThingTypeId", "Mappings", "LogicalInterfaceId"]}, "delete"=>{"summary"=>"Delete the property mappings for a specific logical interface for\nthe draft thing type.", "description"=>"Deletes the property mappings for a specific logical interface\nfor the draft thing type.", "operationId"=>"deletes-the-property-mappings-for-a-specific-logical-interfacefor-the-draft-thing-type", "x-api-path-slug"=>"draftthingtypesthingtypeidmappingslogicalinterfaceid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Draft", "Thing", "Types", "ThingTypeId", "Mappings", "LogicalInterfaceId"]}}, "/thing/types/{thingTypeId}/things"=>{"get"=>{"summary"=>"List things", "description"=>"Within the Watson IoT Platform, a Thing allows you to aggregate one or\nmore instances of a Device or Thing together to represent a more coarse\ngrained object. For example, you might aggregrate together a\ntemperature sensor, flow sensor and power sensor together into a Boiler. \n\nThe **/thing/types/{thingTypeId}/things** endpoint returns the list of\nall of the Thing instances of the specified type that have been created\nfor the organization in the Watson IoT Platform. Various query\nparameters can be used to filter, sort and page through the list of\nThing instances that are returned.", "operationId"=>"within-the-watson-iot-platform-a-thing-allows-you-to-aggregate-one-ormore-instances-of-a-device-or-t", "x-api-path-slug"=>"thingtypesthingtypeidthings-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Thing", "Types", "ThingTypeId", "Things"]}, "post"=>{"summary"=>"Create a thing", "description"=>"Creates a thing instance of the specified type for the organization in\nthe Watson IoT Platform. The thing type must have a valid set of \nInformation Management metadata associated with it and activated before\nany instances can be created.", "operationId"=>"creates-a-thing-instance-of-the-specified-type-for-the-organization-inthe-watson-iot-platform-the-th", "x-api-path-slug"=>"thingtypesthingtypeidthings-post", "parameters"=>[{"in"=>"body", "name"=>"thing", "description"=>"Thing to be created", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Thing", "Types", "ThingTypeId", "Things"]}}, "/thing/types/{thingTypeId}/things/{thingId}"=>{"get"=>{"summary"=>"Get a thing", "description"=>"Retrieve the thing with the specified id.", "operationId"=>"retrieve-the-thing-with-the-specified-id", "x-api-path-slug"=>"thingtypesthingtypeidthingsthingid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Thing", "Types", "ThingTypeId", "Things", "ThingId"]}, "put"=>{"summary"=>"Update a thing", "description"=>"Updates the thing with the specified id. The following properties\ncan be updated:\n\n - name\n - description\n - metadata\n - aggregatedObjects\n\nNote that if the description field is omitted from the body of the\nupdate, then any existing description will be removed from the thing\ntype.\n \nAny changes made to the values of the following properties will be\nignored:\n\n - created\n - createdBy\n - updated\n - updatedBy\n \nThe values of these properties are set on the server as a result of a\nsuccessful update.", "operationId"=>"updates-the-thing-with-the-specified-id-the-following-propertiescan-be-updated---name---description-", "x-api-path-slug"=>"thingtypesthingtypeidthingsthingid-put", "parameters"=>[{"in"=>"body", "name"=>"Thing", "description"=>"The JSON representation of the thing", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Thing", "Types", "ThingTypeId", "Things", "ThingId"]}, "delete"=>{"summary"=>"Delete a thing", "description"=>"Deletes the thing with the specified id from the organization in the \nWatson IoT Platform.\n\nPlease note the the delete will fail if the thing being deleted is \ncurrently being aggregated by other thing instances.", "operationId"=>"deletes-the-thing-with-the-specified-id-from-the-organization-in-the-watson-iot-platformplease-note-", "x-api-path-slug"=>"thingtypesthingtypeidthingsthingid-delete", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Thing", "Types", "ThingTypeId", "Things", "ThingId"]}}, "/thing/types/{thingTypeId}/things/{thingId}/state/{logicalInterfaceId}"=>{"get"=>{"summary"=>"Get the state for the thing with the specified id", "description"=>"Retrieve the current state of the thing with the specified id.", "operationId"=>"retrieve-the-current-state-of-the-thing-with-the-specified-id", "x-api-path-slug"=>"thingtypesthingtypeidthingsthingidstatelogicalinterfaceid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Thing", "Types", "ThingTypeId", "Things", "ThingId", "State", "LogicalInterfaceId"]}, "patch"=>{"summary"=>"Perform an operation against the thing state for a logical interface", "description"=>"Performs the specified operation against the thing state for a logical\ninterface. The following values can be specified for the operation\nproperty:\n\n - reset-state\n\nThe **reset-state** operation will reset the state of the specified\nthing instance to the default values as defined by the schema for the\nlogical interface.", "operationId"=>"performs-the-specified-operation-against-the-thing-state-for-a-logicalinterface-the-following-values", "x-api-path-slug"=>"thingtypesthingtypeidthingsthingidstatelogicalinterfaceid-patch", "parameters"=>[{"in"=>"body", "name"=>"Operation", "description"=>"The JSON representation of an operation", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internet of Things", "Thing", "Types", "ThingTypeId", "Things", "ThingId", "State", "LogicalInterfaceId"]}}}}, "ibm-watson-machine-learning-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"IBM Watson", "x-complete"=>1, "info"=>{"title"=>"IBM Watson Machine Learning API", "description"=>"-authorizationstep-by-step-instruction-how-to-use-watson-machine-learning-servicecan-be-found-herehttpsdatascience-ibm-comdocscontentanalyzedatamloverview-htmlcontextanalytics-ibm-watson-machine-learning-credentialsto-start-working-with-api-one-needs-to-generate-an-access-token-using-the-username-and-passwordavailable-on-the-service-credentials-tab-of-the-ibm-watson-machine-learning-service-instance-or-also-available-in-the-vcap-environment-variable-example-of-the-service-credentialsjson----url-httpsibmwatsonml-mybluemix-net----username-c1ef4b802ee2458eab92e9ca97ec657d----password-030528d45a3e4d4c92585d553513be6f----instance-id-a751c209954edc32b441ad56ce7a9f40example-of-obtaining-access-token-from-token-endpoint-using-http-basic-auth-for-details-please-refer-to-token-section-belowcurl-basic-user-usernamepassword-httpsibmwatsonml-mybluemix-netv3identitytokenthe-obtained-access-token-needs-to-be-prepended-with-bearer-word-and-it-needs-to-be-passed-in-the-authorization-header-for-api-calls-example-of-api-request-with-bearer-access-tokencurl-httpsibmwatsonml-mybluemix-netv3wml-instances00fd89e68cf24712a068ade10277b649published-models-h-authorization-bearer-eyjhbgcioijsuzuxmiisinr5cci6ikpxvcj9-eyj0zw5hbnrjzci6imu4ymqzzgm3lwi5y2utndy1oc1iz----apache-spark-service-credentialsthe-ibm-watson-machine-learning-cooperates-with-the-apache-spark-as-a-service-to-create-batch-stream-deploymentsand-for-learning-configuration-functionality-for-api-methods-requiring-apache-spark-service-instance-a-custom-header-xsparkserviceinstancewith-service-credentials-must-be-specified-the-header-value-is-a-base64-encoded-string-with-the-json-data-containing-service-credentials-and-spark-version-example-of-the-json-data---credentials------tenant-ids068ade10277b6495605b1d10fv12b------tenant-id-full00fd89e68cf24712a068ade10277b649-41f37bf21b954c65a15605b1d10fb12b------cluster-master-urlhttpsspark-bluemix-net------instance-id00fd89e68cf24712a068ade10277b649------tenant-secretc74c37cf482a4da4836ef32ca26ccbb9------planibm-sparkservice-paygopersonal------version2-0", "version"=>"1.0.0"}, "host"=>"ibm-watson-ml.mybluemix.net", "basePath"=>"v3/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/identity/token"=>{"get"=>{"summary"=>"Get Entity Token", "description"=>"Tokens are required for the ML REST API authentication. They are generated using ML service credentials", "operationId"=>"generateToken", "x-api-path-slug"=>"identitytoken-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Identity", "Token"]}, "put"=>{"summary"=>"Put Entity Token", "description"=>"Refreshes token, accepts expired token and generates a new one (if the application binding / service key is still valid)", "operationId"=>"refreshes-token-accepts-expired-token-and-generates-a-new-one-if-the-application-binding--service-ke", "x-api-path-slug"=>"identitytoken-put", "parameters"=>[{"in"=>"body", "name"=>"token", "description"=>"existing token", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Identity", "Token"]}}, "/wml_instances/{instance_id}/published_models"=>{"get"=>{"summary"=>"Get Wml Instances Instance Published Models", "description"=>"Get wml instances instance published models.", "operationId"=>"listModelDeployments", "x-api-path-slug"=>"wml-instancesinstance-idpublished-models-get", "parameters"=>[{"in"=>"query", "name"=>"limit", "description"=>"Maximum number of resources to retrive (defaults to 1000)"}, {"in"=>"query", "name"=>"start", "description"=>"Token required for token-based pagination"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models"]}}, "/wml_instances/{instance_id}/published_models/{published_model_id}"=>{"get"=>{"summary"=>"Get Wml Instances Instance Published Models Published Model", "description"=>"Get wml instances instance published models published model.", "operationId"=>"details-about-specific-published-model", "x-api-path-slug"=>"wml-instancesinstance-idpublished-modelspublished-model-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models", "Published", "Model", "Id"]}, "delete"=>{"summary"=>"Delete Wml Instances Instance Published Models Published Model", "description"=>"Delete wml instances instance published models published model.", "operationId"=>"deletes-the-published-model-and-all-its-deployments", "x-api-path-slug"=>"wml-instancesinstance-idpublished-modelspublished-model-id-delete", "parameters"=>[{"in"=>"query", "name"=>"ignore_spark_errors", "description"=>"If this flag is set to true then deployments of this model will be deleted even if spark reports failure in response to kill job request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models", "Published", "Model", "Id"]}, "patch"=>{"summary"=>"Patch Wml Instances Instance Published Models Published Model", "description"=>"Patch wml instances instance published models published model.", "operationId"=>"updates-the-version-of-deployed-model", "x-api-path-slug"=>"wml-instancesinstance-idpublished-modelspublished-model-id-patch", "parameters"=>[{"in"=>"body", "name"=>"published_model_patch", "description"=>"Input For Patch", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models", "Published", "Model", "Id"]}}, "/wml_instances/{instance_id}/published_models/{published_model_id}/evaluation_metrics"=>{"get"=>{"summary"=>"Get Wml Instances Instance Published Models Published Model Evaluation Metrics", "description"=>"Get wml instances instance published models published model evaluation metrics.", "operationId"=>"listModelMetrics", "x-api-path-slug"=>"wml-instancesinstance-idpublished-modelspublished-model-idevaluation-metrics-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models", "Published", "Model", "Id", "Evaluation", "Metrics"]}}, "/wml_instances/{instance_id}/published_models/{published_model_id}/learning_configuration"=>{"put"=>{"summary"=>"Put Wml Instances Instance Published Models Published Model Learning Configuration", "description"=>"Put wml instances instance published models published model learning configuration.", "operationId"=>"creates-learning-configuration", "x-api-path-slug"=>"wml-instancesinstance-idpublished-modelspublished-model-idlearning-configuration-put", "parameters"=>[{"in"=>"body", "name"=>"learning_configuration", "description"=>"The model deployment Id", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models", "Published", "Model", "Id", "Learning", "Configuration"]}, "patch"=>{"summary"=>"Patch Wml Instances Instance Published Models Published Model Learning Configuration", "description"=>"Patch wml instances instance published models published model learning configuration.", "operationId"=>"updates-the-learning-configuration-partially", "x-api-path-slug"=>"wml-instancesinstance-idpublished-modelspublished-model-idlearning-configuration-patch", "parameters"=>[{"in"=>"body", "name"=>"learning_configuration_patch", "description"=>"Input For Patch", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models", "Published", "Model", "Id", "Learning", "Configuration"]}}, "/wml_instances/{instance_id}/published_models/{published_model_id}/learning_iterations"=>{"post"=>{"summary"=>"Post Wml Instances Instance Published Models Published Model Learning Iterations", "description"=>"Post wml instances instance published models published model learning iterations.", "operationId"=>"evaluateModel", "x-api-path-slug"=>"wml-instancesinstance-idpublished-modelspublished-model-idlearning-iterations-post", "parameters"=>[{"in"=>"body", "name"=>"learning_iteration_settings", "description"=>"Settings for this particular learning iteration", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models", "Published", "Model", "Id", "Learning", "Iterations"]}, "get"=>{"summary"=>"Get Wml Instances Instance Published Models Published Model Learning Iterations", "description"=>"Get wml instances instance published models published model learning iterations.", "operationId"=>"listModelLearningIterations", "x-api-path-slug"=>"wml-instancesinstance-idpublished-modelspublished-model-idlearning-iterations-get", "parameters"=>[{"in"=>"query", "name"=>"status", "description"=>"This is the filter parameter which allows to query learning iterations with the specific status"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models", "Published", "Model", "Id", "Learning", "Iterations"]}}, "/wml_instances/{instance_id}/published_models/{published_model_id}/learning_iterations/{learning_iteration_id}"=>{"get"=>{"summary"=>"Get Wml Instances Instance Published Models Published Model Learning Iterations Learning Iteration", "description"=>"Get wml instances instance published models published model learning iterations learning iteration.", "operationId"=>"details-about-specific-learning-iteration", "x-api-path-slug"=>"wml-instancesinstance-idpublished-modelspublished-model-idlearning-iterationslearning-iteration-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models", "Published", "Model", "Id", "Learning", "Iterations", "Learning", "Iteration", "Id"]}}, "/wml_instances/{instance_id}/published_models/{published_model_id}/feedback"=>{"post"=>{"summary"=>"Post Wml Instances Instance Published Models Published Model Feedback", "description"=>"Receives the feedback data and stores it in the feedback store\ndefined in learning configuration", "operationId"=>"receives-the-feedback-data-and-stores-it-in-the-feedback-storedefined-in-learning-configuration", "x-api-path-slug"=>"wml-instancesinstance-idpublished-modelspublished-model-idfeedback-post", "parameters"=>[{"in"=>"body", "name"=>"feedback_data", "description"=>"The feedback data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models", "Published", "Model", "Id", "Feedback"]}}, "/wml_instances/{instance_id}/published_models/{published_model_id}/deployments"=>{"post"=>{"summary"=>"Post Wml Instances Instance Published Models Published Model Deployments", "description"=>"Creates the deployment - online, stream, batch (batch deployment only supports Cloud Object Storage as input/output for Tensorflow, Keras and Caffe models.)", "operationId"=>"creates-the-deployment--online-stream-batch-batch-deployment-only-supports-cloud-object-storage-as-i", "x-api-path-slug"=>"wml-instancesinstance-idpublished-modelspublished-model-iddeployments-post", "parameters"=>[{"in"=>"body", "name"=>"deployment_input", "description"=>"The input data", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"sync", "description"=>"This is parameter which determines if the online deployment needs to be created in synchronous or asynchronous way"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models", "Published", "Model", "Id", "Deployments"]}, "get"=>{"summary"=>"Get Wml Instances Instance Published Models Published Model Deployments", "description"=>"Get wml instances instance published models published model deployments.", "operationId"=>"listDeploymentsForModel", "x-api-path-slug"=>"wml-instancesinstance-idpublished-modelspublished-model-iddeployments-get", "parameters"=>[{"in"=>"query", "name"=>"status", "description"=>"This is the filter parameter which allows to query deployments with the specific status"}, {"in"=>"query", "name"=>"type", "description"=>"This is the filter parameter which allows to query deployments with the specific type"}, {"in"=>"query", "name"=>"_fields", "description"=>"The list of fields which should be included in the response"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models", "Published", "Model", "Id", "Deployments"]}}, "/wml_instances/{instance_id}/published_models/{published_model_id}/deployments/{deployment_id}"=>{"get"=>{"summary"=>"Get Wml Instances Instance Published Models Published Model Deployments Deployment", "description"=>"Get wml instances instance published models published model deployments deployment.", "operationId"=>"getDeployment", "x-api-path-slug"=>"wml-instancesinstance-idpublished-modelspublished-model-iddeploymentsdeployment-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models", "Published", "Model", "Id", "Deployments", "Deployment", "Id"]}, "patch"=>{"summary"=>"Patch Wml Instances Instance Published Models Published Model Deployments Deployment", "description"=>"Patch wml instances instance published models published model deployments deployment.", "operationId"=>"allows-to-update-the-deployed-stream-status-startstop", "x-api-path-slug"=>"wml-instancesinstance-idpublished-modelspublished-model-iddeploymentsdeployment-id-patch", "parameters"=>[{"in"=>"body", "name"=>"deployment_patch", "description"=>"Input For Patch", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models", "Published", "Model", "Id", "Deployments", "Deployment", "Id"]}, "delete"=>{"summary"=>"Delete Wml Instances Instance Published Models Published Model Deployments Deployment", "description"=>"Delete wml instances instance published models published model deployments deployment.", "operationId"=>"", "x-api-path-slug"=>"wml-instancesinstance-idpublished-modelspublished-model-iddeploymentsdeployment-id-delete", "parameters"=>[{"in"=>"query", "name"=>"ignore_spark_errors", "description"=>"If this flag is set to true then the deployment will be deleted even if spark reports failure in response to kill job request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models", "Published", "Model", "Id", "Deployments", "Deployment", "Id"]}}, "/wml_instances/{instance_id}/published_models/{published_model_id}/deployments/{deployment_id}/online"=>{"post"=>{"summary"=>"Post Wml Instances Instance Published Models Published Model Deployments Deployment Online", "description"=>"Post wml instances instance published models published model deployments deployment online.", "operationId"=>"makes-an-online-prediction-on-a-given-data-values", "x-api-path-slug"=>"wml-instancesinstance-idpublished-modelspublished-model-iddeploymentsdeployment-idonline-post", "parameters"=>[{"in"=>"body", "name"=>"online_prediction_input", "description"=>"The input data", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Published", "Models", "Published", "Model", "Id", "Deployments", "Deployment", "Id", "Online"]}}, "/wml_instances/{instance_id}/deployments"=>{"get"=>{"summary"=>"Get Wml Instances Instance Deployments", "description"=>"Get wml instances instance deployments.", "operationId"=>"listAllDeployments", "x-api-path-slug"=>"wml-instancesinstance-iddeployments-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id", "Deployments"]}}, "/wml_instances/{instance_id}"=>{"get"=>{"summary"=>"Get Wml Instances Instance", "description"=>"Details about specific service instance", "operationId"=>"getInstanceDetails", "x-api-path-slug"=>"wml-instancesinstance-id-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Machine Learning", "Wml", "Instances", "Instance", "Id"]}}}}, "apis"=>{"name"=>"IBM Watson", "x-slug"=>"ibm-watson", "description"=>"Meet IBM Watson, a cognitive system that enables a new partnership between people and computers that enhances and scales human expertise. Watson has been learning the language of professions and is trained by experts to work across many different industries.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/ibm-watson-logo.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"AI,API LIfeyclessss,API Provider,Getting Started Example,Machine Learning,Machine Learning,Profiles,Relative Data,Service API,Stack,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"ibm-watson/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"IBM Watson IoT Platform", "x-api-slug"=>"ibm-watson-iot-platform", "description"=>"Meet IBM Watson, a cognitive system that enables a new partnership between people and computers that enhances and scales human expertise. Watson has been learning the language of professions and is trained by experts to work across many different industries.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/ibm-watson-logo.png", "humanURL"=>"https://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/", "baseURL"=>"https:////api/v0002", "tags"=>"AI,API LIfeyclessss,API Provider,Getting Started Example,Machine Learning,Machine Learning,Profiles,Relative Data,Service API,Stack,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/ibm-watson/ibm-watson-iot-platform-openapi.yaml"}]}, {"name"=>"IBM Watson Machine Learning", "x-api-slug"=>"ibm-watson-machine-learning", "description"=>"Meet IBM Watson, a cognitive system that enables a new partnership between people and computers that enhances and scales human expertise. Watson has been learning the language of professions and is trained by experts to work across many different industries.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/ibm-watson-logo.png", "humanURL"=>"https://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/", "baseURL"=>"https://ibm-watson-ml.mybluemix.net/v3/", "tags"=>"Internet of Things,Thing,Types,ThingTypeId,Things,ThingId,State,LogicalInterfaceId", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/ibm-watson/ibm-watson-machine-learning-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-application-gallery", "url"=>"https://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/gallery.html"}, {"type"=>"x-blog", "url"=>"https://developer.ibm.com/watson/blog/"}, {"type"=>"x-blog-rss", "url"=>"https://developer.ibm.com/watson/feed/"}, {"type"=>"x-developer", "url"=>"https://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/"}, {"type"=>"x-developer", "url"=>"https://developer.ibm.com/watson/"}, {"type"=>"x-documentation", "url"=>"https://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/apis/"}, {"type"=>"x-forum", "url"=>"https://developer.ibm.com/answers/smartspace/watson/"}, {"type"=>"x-getting-started", "url"=>"https://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/getstarted.html"}, {"type"=>"x-github", "url"=>"https://github.com/IBM-Watson"}, {"type"=>"x-partners", "url"=>"http://www.ibm.com/smarterplanet/us/en/ibmwatson/ecosystem.html"}, {"type"=>"x-privacy", "url"=>"http://www.ibm.com/privacy/us/en/?lnk=flg-priv-usen"}, {"type"=>"x-terms-of-service", "url"=>"http://www.ibm.com/legal/us/en/?lnk=flg-tous-usen"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/IBMWatson"}, {"type"=>"x-videos", "url"=>"http://www.ibm.com/smarterplanet/us/en/ibmwatson/"}, {"type"=>"x-website", "url"=>"https://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/"}, {"type"=>"x-white-papers", "url"=>"https://developer.ibm.com/watson/docs/whitepapers/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
aws-snowball{"aws-snowball-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"AWS Snowball", "x-complete"=>1, "info"=>{"title"=>"AWS Snowball API", "version"=>"1.0.0"}, "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/?Action=CancelCluster"=>{"get"=>{"summary"=>"Cancel Cluster", "description"=>"Cancels a cluster job.", "operationId"=>"cancelCluster", "x-api-path-slug"=>"actioncancelcluster-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterId", "description"=>"The 39-character ID for the cluster that you want to cancel, for example CID123e4567-e89b-12d3-a456-426655440000", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=CancelJob"=>{"get"=>{"summary"=>"Cancel Job", "description"=>"Cancels the specified job.", "operationId"=>"cancelJob", "x-api-path-slug"=>"actioncanceljob-get", "parameters"=>[{"in"=>"query", "name"=>"JobId", "description"=>"The 39-character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/?Action=CreateAddress"=>{"get"=>{"summary"=>"Create Address", "description"=>"Creates an address for a Snowball to be shipped to.", "operationId"=>"createAddress", "x-api-path-slug"=>"actioncreateaddress-get", "parameters"=>[{"in"=>"query", "name"=>"Address", "description"=>"The address that you want the Snowball shipped to", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addresses"]}}, "/?Action=CreateCluster"=>{"get"=>{"summary"=>"Create Cluster", "description"=>"Creates an empty cluster.", "operationId"=>"createCluster", "x-api-path-slug"=>"actioncreatecluster-get", "parameters"=>[{"in"=>"query", "name"=>"AddressId", "description"=>"The ID for the address that you want the cluster shipped to", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"An optional description of this specific cluster, for example Environmental Data Cluster-01", "type"=>"string"}, {"in"=>"query", "name"=>"JobType", "description"=>"The type of job for this cluster", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyARN", "description"=>"The KmsKeyARN value that you want to associate with this cluster", "type"=>"string"}, {"in"=>"query", "name"=>"Notification", "description"=>"The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster", "type"=>"string"}, {"in"=>"query", "name"=>"Resources", "description"=>"The resources associated with the cluster job", "type"=>"string"}, {"in"=>"query", "name"=>"RoleARN", "description"=>"The RoleARN that you want to associate with this cluster", "type"=>"string"}, {"in"=>"query", "name"=>"ShippingOption", "description"=>"The shipping speed for each node in this cluster", "type"=>"string"}, {"in"=>"query", "name"=>"SnowballType", "description"=>"The type of AWS Snowball appliance to use for this cluster", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=CreateJob"=>{"get"=>{"summary"=>"Create Job", "description"=>"Creates a job to import or export data between Amazon S3 and your on-premises data\n center.", "operationId"=>"createJob", "x-api-path-slug"=>"actioncreatejob-get", "parameters"=>[{"in"=>"query", "name"=>"AddressId", "description"=>"The ID for the address that you want the Snowball shipped to", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterId", "description"=>"The ID of a cluster", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"Defines an optional description of this specific job, for example Important Photos 2016-08-11", "type"=>"string"}, {"in"=>"query", "name"=>"JobType", "description"=>"Defines the type of job that youre creating", "type"=>"string"}, {"in"=>"query", "name"=>"KmsKeyARN", "description"=>"The KmsKeyARN that you want to associate with this job", "type"=>"string"}, {"in"=>"query", "name"=>"Notification", "description"=>"Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job", "type"=>"string"}, {"in"=>"query", "name"=>"Resources", "description"=>"Defines the Amazon S3 buckets associated with this job", "type"=>"string"}, {"in"=>"query", "name"=>"RoleARN", "description"=>"The RoleARN that you want to associate with this job", "type"=>"string"}, {"in"=>"query", "name"=>"ShippingOption", "description"=>"The shipping speed for this job", "type"=>"string"}, {"in"=>"query", "name"=>"SnowballCapacityPreference", "description"=>"If your job is being created in one of the US regions, you have the option of specifying what size Snowball youd like for this job", "type"=>"string"}, {"in"=>"query", "name"=>"SnowballType", "description"=>"The type of AWS Snowball appliance to use for this job", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/?Action=DescribeAddress"=>{"get"=>{"summary"=>"Describe Address", "description"=>"Takes an AddressId and returns specific details about that address in the\n form of an Address object.", "operationId"=>"describeAddress", "x-api-path-slug"=>"actiondescribeaddress-get", "parameters"=>[{"in"=>"query", "name"=>"AddressId", "description"=>"The automatically generated ID for a specific address", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addresses"]}}, "/?Action=DescribeAddresses"=>{"get"=>{"summary"=>"Describe Addresses", "description"=>"Returns a specified number of ADDRESS objects.", "operationId"=>"describeAddresses", "x-api-path-slug"=>"actiondescribeaddresses-get", "parameters"=>[{"in"=>"query", "name"=>"MaxResults", "description"=>"The number of ADDRESS objects to return", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"HTTP requests are stateless", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Addresses"]}}, "/?Action=DescribeCluster"=>{"get"=>{"summary"=>"Describe Cluster", "description"=>"Returns information about a specific cluster including shipping information, cluster\n status, and other important metadata.", "operationId"=>"describeCluster", "x-api-path-slug"=>"actiondescribecluster-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterId", "description"=>"The automatically generated ID for a cluster", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=DescribeJob"=>{"get"=>{"summary"=>"Describe Job", "description"=>"Returns information about a specific job including shipping information, job status,\n and other important metadata.", "operationId"=>"describeJob", "x-api-path-slug"=>"actiondescribejob-get", "parameters"=>[{"in"=>"query", "name"=>"JobId", "description"=>"The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/?Action=GetJobManifest"=>{"get"=>{"summary"=>"Get Job Manifest", "description"=>"Returns a link to an Amazon S3 presigned URL for the manifest file associated with the\n specified JobId value.", "operationId"=>"getJobManifest", "x-api-path-slug"=>"actiongetjobmanifest-get", "parameters"=>[{"in"=>"query", "name"=>"JobId", "description"=>"The ID for a job that you want to get the manifest file for, for example JID123e4567-e89b-12d3-a456-426655440000", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Job Manifest"]}}, "/?Action=GetJobUnlockCode"=>{"get"=>{"summary"=>"Get Job Unlock Code", "description"=>"Returns the UnlockCode code value for the specified job.", "operationId"=>"getJobUnlockCode", "x-api-path-slug"=>"actiongetjobunlockcode-get", "parameters"=>[{"in"=>"query", "name"=>"JobId", "description"=>"The ID for the job that you want to get the UnlockCode value for, for example JID123e4567-e89b-12d3-a456-426655440000", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/?Action=GetSnowballUsage"=>{"get"=>{"summary"=>"Get Snowball Usage", "description"=>"Returns information about the Snowball service limit for your account, and also the\n number of Snowballs your account has in use.", "operationId"=>"getSnowballUsage", "x-api-path-slug"=>"actiongetsnowballusage-get", "parameters"=>[{"in"=>"query", "name"=>"SnowballLimit", "description"=>"The service limit for number of Snowballs this account can have at once", "type"=>"string"}, {"in"=>"query", "name"=>"SnowballsInUse", "description"=>"The number of Snowballs that this account is currently using", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Usage"]}}, "/?Action=ListClusterJobs"=>{"get"=>{"summary"=>"List Cluster Jobs", "description"=>"Returns an array of JobListEntry objects of the specified length.", "operationId"=>"listClusterJobs", "x-api-path-slug"=>"actionlistclusterjobs-get", "parameters"=>[{"in"=>"query", "name"=>"ClusterId", "description"=>"The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000", "type"=>"string"}, {"in"=>"query", "name"=>"MaxResults", "description"=>"The number of JobListEntry objects to return", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"HTTP requests are stateless", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Cluster Jobs"]}}, "/?Action=ListClusters"=>{"get"=>{"summary"=>"List Clusters", "description"=>"Returns an array of ClusterListEntry objects of the specified length.", "operationId"=>"listClusters", "x-api-path-slug"=>"actionlistclusters-get", "parameters"=>[{"in"=>"query", "name"=>"MaxResults", "description"=>"The number of ClusterListEntry objects to return", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"HTTP requests are stateless", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=ListJobs"=>{"get"=>{"summary"=>"List Jobs", "description"=>"Returns an array of JobListEntry objects of the specified length.", "operationId"=>"listJobs", "x-api-path-slug"=>"actionlistjobs-get", "parameters"=>[{"in"=>"query", "name"=>"MaxResults", "description"=>"The number of JobListEntry objects to return", "type"=>"string"}, {"in"=>"query", "name"=>"NextToken", "description"=>"HTTP requests are stateless", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}, "/?Action=UpdateCluster"=>{"get"=>{"summary"=>"Update Cluster", "description"=>"While a cluster's ClusterState value is in the AwaitingQuorum\n state, you can update some of the information associated with a cluster.", "operationId"=>"updateCluster", "x-api-path-slug"=>"actionupdatecluster-get", "parameters"=>[{"in"=>"query", "name"=>"AddressId", "description"=>"The ID of the updated Address object", "type"=>"string"}, {"in"=>"query", "name"=>"ClusterId", "description"=>"The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"The updated description of this cluster", "type"=>"string"}, {"in"=>"query", "name"=>"Notification", "description"=>"The new or updated Notification object", "type"=>"string"}, {"in"=>"query", "name"=>"Resources", "description"=>"The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects", "type"=>"string"}, {"in"=>"query", "name"=>"RoleARN", "description"=>"The new role Amazon Resource Name (ARN) that you want to associate with this cluster", "type"=>"string"}, {"in"=>"query", "name"=>"ShippingOption", "description"=>"The updated shipping option value of this clusters ShippingDetails object", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Clusters"]}}, "/?Action=UpdateJob"=>{"get"=>{"summary"=>"Update Job", "description"=>"While a job's JobState value is New, you can update some of\n the information associated with a job.", "operationId"=>"updateJob", "x-api-path-slug"=>"actionupdatejob-get", "parameters"=>[{"in"=>"query", "name"=>"AddressId", "description"=>"The ID of the updated Address object", "type"=>"string"}, {"in"=>"query", "name"=>"Description", "description"=>"The updated description of this jobs JobMetadata object", "type"=>"string"}, {"in"=>"query", "name"=>"JobId", "description"=>"The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000", "type"=>"string"}, {"in"=>"query", "name"=>"Notification", "description"=>"The new or updated Notification object", "type"=>"string"}, {"in"=>"query", "name"=>"Resources", "description"=>"The updated S3Resource object (for a single Amazon S3 bucket or key range), or the updated JobResource object (for multiple buckets or key ranges)", "type"=>"string"}, {"in"=>"query", "name"=>"RoleARN", "description"=>"The new role Amazon Resource Name (ARN) that you want to associate with this job", "type"=>"string"}, {"in"=>"query", "name"=>"ShippingOption", "description"=>"The updated shipping option value of this jobs ShippingDetails object", "type"=>"string"}, {"in"=>"query", "name"=>"SnowballCapacityPreference", "description"=>"The updated SnowballCapacityPreference of this jobs JobMetadata object", "type"=>"string"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Jobs"]}}}}, "apis"=>{"name"=>"AWS Snowball", "x-slug"=>"aws-snowball", "description"=>"Snowball is a petabyte-scale data transport solution that uses secure appliances totransfer large amounts of datainto and out of theAWS cloud. Using Snowball addresses common challenges with large-scale data transfers including high network costs, long transfer times, and security concerns. Transferring data with Snowball is simple, fast, secure, and can be as little as one-fifth the cost of high-speed Internet.With Snowball, you don’t need to write any code or purchase any hardware to transfer your data. Simply create a job in the AWS Management Console and a Snowball appliance will be automatically shipped to you*. Once it arrives, attach the appliance to your local network, download and run the Snowball client to establish a connection, and then use the client to select the file directories that you want to transfer to the appliance. The client will then encrypt and transfer the files to the appliance at high speed. Once the transfer is complete and the appliance is ready to be returned, the E Ink shipping label will automatically update and you can track the job status viaAmazon Simple Notification Service (SNS), text messages, or directly in the Console.Snowball uses multiple layers of security designed to protect your data including tamper-resistant enclosures, 256-bit encryption, and an industry-standard Trusted Platform Module (TPM) designed to ensure both security and full chain-of-custody of your data. Once the data transfer job has been processed and verified, AWS performs a software erasure of the Snowball appliance.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Storage-Content-Delivery_AWSImportExportSnowball.png", "x-kinRank"=>"10", "x-alexaRank"=>"0", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Data,Databases,Profiles,Relative Data,Security,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"aws-snowball/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"AWS Snowball API", "x-api-slug"=>"aws-snowball-api", "description"=>"Snowball is a petabyte-scale data transport solution that uses secure appliances totransfer large amounts of datainto and out of theAWS cloud. Using Snowball addresses common challenges with large-scale data transfers including high network costs, long transfer times, and security concerns. Transferring data with Snowball is simple, fast, secure, and can be as little as one-fifth the cost of high-speed Internet.With Snowball, you don’t need to write any code or purchase any hardware to transfer your data. Simply create a job in the AWS Management Console and a Snowball appliance will be automatically shipped to you*. Once it arrives, attach the appliance to your local network, download and run the Snowball client to establish a connection, and then use the client to select the file directories that you want to transfer to the appliance. The client will then encrypt and transfer the files to the appliance at high speed. Once the transfer is complete and the appliance is ready to be returned, the E Ink shipping label will automatically update and you can track the job status viaAmazon Simple Notification Service (SNS), text messages, or directly in the Console.Snowball uses multiple layers of security designed to protect your data including tamper-resistant enclosures, 256-bit encryption, and an industry-standard Trusted Platform Module (TPM) designed to ensure both security and full chain-of-custody of your data. Once the data transfer job has been processed and verified, AWS performs a software erasure of the Snowball appliance.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/Storage-Content-Delivery_AWSImportExportSnowball.png", "humanURL"=>"https://aws.amazon.com/snowball/", "baseURL"=>":///", "tags"=>"Amazon Web Services,API Provider,API Service Provider,API Service Provider,Data,Databases,Profiles,Relative Data,Security,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/aws-snowball/aws-snowball-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-documentation", "url"=>"http://docs.aws.amazon.com/snowball/latest/api-reference/api-reference.html"}, {"type"=>"x-faq", "url"=>"https://aws.amazon.com/snowball/faqs/"}, {"type"=>"x-getting-started", "url"=>"https://aws.amazon.com/snowball/getting-started/"}, {"type"=>"x-tools", "url"=>"https://aws.amazon.com/snowball/tools/"}, {"type"=>"x-website", "url"=>"https://aws.amazon.com/snowball/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
buffer{"buffer-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Buffer", "x-complete"=>1, "info"=>{"title"=>"Bufferapp", "description"=>"social-media-management-for-marketers-and-agencies", "version"=>"1"}, "host"=>"api.bufferapp.com", "basePath"=>"/1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/info/configuration{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Info Configuration Mediatypeextension", "description"=>"Returns an object with the current configuration that Buffer is using, including supported services, their icons and the varying limits of character and schedules.", "operationId"=>"returns-an-object-with-the-current-configuration-that-buffer-is-using-including-supported-services-t", "x-api-path-slug"=>"infoconfigurationmediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Info", "ConfigurationmediaTypeExtension"]}}, "/links/shares{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Links Shares Mediatypeextension", "description"=>"Returns an object with a the numbers of shares a link has had using Buffer.", "operationId"=>"returns-an-object-with-a-the-numbers-of-shares-a-link-has-had-using-buffer-", "x-api-path-slug"=>"linkssharesmediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension"}, {"in"=>"query", "name"=>"url", "description"=>"URL-encoded URL of the page for which the number of shares is requested"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Links", "SharesmediaTypeExtension"]}}, "/profiles/{id}/schedules/update{mediaTypeExtension}"=>{"post"=>{"summary"=>"Post Profiles Schedules Update Mediatypeextension", "description"=>"Post Profiles Schedules Update Mediatypeextension", "operationId"=>"set-the-posting-schedules-for-the-specified-social-media-profile-", "x-api-path-slug"=>"profilesidschedulesupdatemediatypeextension-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"mediaTypeExtension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profiles", "Id", "Schedules", "UpdatemediaTypeExtension"]}}, "/profiles/{id}/schedules{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Profiles Schedules Mediatypeextension", "description"=>"Returns details of the posting schedules associated with a social media profile.", "operationId"=>"returns-details-of-the-posting-schedules-associated-with-a-social-media-profile-", "x-api-path-slug"=>"profilesidschedulesmediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"mediaTypeExtension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profiles", "Id", "SchedulesmediaTypeExtension"]}}, "/profiles/{id}/updates/pending{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Profiles Updates Pending Mediatypeextension", "description"=>"Get Profiles Updates Pending Mediatypeextension", "operationId"=>"returns-an-array-of-updates-that-are-currently-in-the-buffer-for-an-individual-social-media-profile-", "x-api-path-slug"=>"profilesidupdatespendingmediatypeextension-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Specifies the number of status updates to receive"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"mediaTypeExtension"}, {"in"=>"query", "name"=>"page", "description"=>"Specifies the page of status updates to receive"}, {"in"=>"query", "name"=>"since", "description"=>"Specifies a unix timestamp which only status updates created after this time will be retrieved"}, {"in"=>"query", "name"=>"utc", "description"=>"If utc is set times will be returned relative to UTC rather than the users associated timezone"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profiles", "Id", "Updates", "PendingmediaTypeExtension"]}}, "/profiles/{id}/updates/reorder{mediaTypeExtension}"=>{"post"=>{"summary"=>"Post Profiles Updates Reorder Mediatypeextension", "description"=>"Edit the order at which statuses for the specified social media profile will be sent out of the buffer.", "operationId"=>"edit-the-order-at-which-statuses-for-the-specified-social-media-profile-will-be-sent-out-of-the-buff", "x-api-path-slug"=>"profilesidupdatesreordermediatypeextension-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"mediaTypeExtension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profiles", "Id", "Updates", "ReordermediaTypeExtension"]}}, "/profiles/{id}/updates/sent{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Profiles Updates Sent Mediatypeextension", "description"=>"Returns an array of updates that have been sent from the buffer for an individual social media profile.", "operationId"=>"returns-an-array-of-updates-that-have-been-sent-from-the-buffer-for-an-individual-social-media-profi", "x-api-path-slug"=>"profilesidupdatessentmediatypeextension-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Specifies the number of status updates to receive"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"mediaTypeExtension"}, {"in"=>"query", "name"=>"page", "description"=>"Specifies the page of status updates to receive"}, {"in"=>"query", "name"=>"since", "description"=>"Specifies a unix timestamp which only status updates created after this time will be retrieved"}, {"in"=>"query", "name"=>"utc", "description"=>"If utc is set times will be returned relative to UTC rather than the users associated timezone"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profiles", "Id", "Updates", "SentmediaTypeExtension"]}}, "/profiles/{id}/updates/shuffle{mediaTypeExtension}"=>{"post"=>{"summary"=>"Post Profiles Updates Shuffle Mediatypeextension", "description"=>"Randomize the order at which statuses for the specified social media profile will be sent out of the buffer.", "operationId"=>"randomize-the-order-at-which-statuses-for-the-specified-social-media-profile-will-be-sent-out-of-the", "x-api-path-slug"=>"profilesidupdatesshufflemediatypeextension-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"mediaTypeExtension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profiles", "Id", "Updates", "ShufflemediaTypeExtension"]}}, "/profiles/{id}{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Profiles Mediatypeextension", "description"=>"Returns details of the single specified social media profile.", "operationId"=>"returns-details-of-the-single-specified-social-media-profile-", "x-api-path-slug"=>"profilesidmediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"mediaTypeExtension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Profiles", "IdmediaTypeExtension"]}}, "/profiles{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Profiles Mediatypeextension", "description"=>"Returns an array of social media profiles connected to a users account.", "operationId"=>"returns-an-array-of-social-media-profiles-connected-to-a-users-account-", "x-api-path-slug"=>"profilesmediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ProfilesmediaTypeExtension"]}}, "/updates/create{mediaTypeExtension}"=>{"post"=>{"summary"=>"Post Updates Create Mediatypeextension", "description"=>"Create one or more new status updates.", "operationId"=>"create-one-or-more-new-status-updates-", "x-api-path-slug"=>"updatescreatemediatypeextension-post", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Updates", "CreatemediaTypeExtension"]}}, "/updates/{id}/destroy{mediaTypeExtension}"=>{"post"=>{"summary"=>"Post Updates Destroy Mediatypeextension", "description"=>"Permanently delete an existing status update.", "operationId"=>"permanently-delete-an-existing-status-update-", "x-api-path-slug"=>"updatesiddestroymediatypeextension-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"mediaTypeExtension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Updates", "Id", "DestroymediaTypeExtension"]}}, "/updates/{id}/interactions{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Updates Interactions Mediatypeextension", "description"=>"Returns the detailed information on individual interactions with the social media update such as favorites, retweets and likes.", "operationId"=>"returns-the-detailed-information-on-individual-interactions-with-the-social-media-update-such-as-fav", "x-api-path-slug"=>"updatesidinteractionsmediatypeextension-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"Specifies the number of status updates to receive"}, {"in"=>"query", "name"=>"event", "description"=>"Specifies a type of event to be retrieved, for example retweet, like, comment, mention or reshare"}, {"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"mediaTypeExtension"}, {"in"=>"query", "name"=>"page", "description"=>"Specifies the page of status updates to receive"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Updates", "Id", "InteractionsmediaTypeExtension"]}}, "/updates/{id}/move_to_top{mediaTypeExtension}"=>{"post"=>{"summary"=>"Post Updates Move To Top Mediatypeextension", "description"=>"Move an existing status update to the top of the queue and recalculate times for all updates in the queue. Returns the update with its new posting time.", "operationId"=>"move-an-existing-status-update-to-the-top-of-the-queue-and-recalculate-times-for-all-updates-in-the-", "x-api-path-slug"=>"updatesidmove-to-topmediatypeextension-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"mediaTypeExtension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Updates", "Id", "Move", "To", "TopmediaTypeExtension"]}}, "/updates/{id}/share{mediaTypeExtension}"=>{"post"=>{"summary"=>"Post Updates Share Mediatypeextension", "description"=>"Immediately shares a single pending update and recalculates times for updates remaining in the queue.", "operationId"=>"immediately-shares-a-single-pending-update-and-recalculates-times-for-updates-remaining-in-the-queue", "x-api-path-slug"=>"updatesidsharemediatypeextension-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"mediaTypeExtension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Updates", "Id", "SharemediaTypeExtension"]}}, "/updates/{id}/update{mediaTypeExtension}"=>{"post"=>{"summary"=>"Post Updates Update Mediatypeextension", "description"=>"Edit an existing, individual status update.", "operationId"=>"edit-an-existing-individual-status-update-", "x-api-path-slug"=>"updatesidupdatemediatypeextension-post", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"mediaTypeExtension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Updates", "Id", "UpdatemediaTypeExtension"]}}, "/updates/{id}{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get Updates Mediatypeextension", "description"=>"Returns a single social media update.", "operationId"=>"returns-a-single-social-media-update-", "x-api-path-slug"=>"updatesidmediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"id"}, {"in"=>"path", "name"=>"mediaTypeExtension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Updates", "IdmediaTypeExtension"]}}, "/user{mediaTypeExtension}"=>{"get"=>{"summary"=>"Get User Mediatypeextension", "description"=>"Get user mediatypeextension.", "operationId"=>"returns-a-single-user-", "x-api-path-slug"=>"usermediatypeextension-get", "parameters"=>[{"in"=>"path", "name"=>"mediaTypeExtension"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["UsermediaTypeExtension"]}}}}, "apis"=>{"name"=>"Buffer", "x-slug"=>"buffer", "description"=>"Buffer is an intuitive social media management platform trusted by brands, businesses, agencies, and individuals to help drive social media results.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/994-buffer.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"2789", "tags"=>"API Provider,API Service Provider,internet,Mobile,Profiles,Relative Data,SaaS,Schedules,Schedules,Service API,Social,Social,Social Sharing,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"buffer/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Buffer", "x-api-slug"=>"buffer", "description"=>"Buffer is an intuitive social media management platform trusted by brands, businesses, agencies, and individuals to help drive social media results.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/994-buffer.jpg", "humanURL"=>"http://bufferapp.com", "baseURL"=>"https://api.bufferapp.com//1/", "tags"=>"API Provider,API Service Provider,internet,Mobile,Profiles,Relative Data,SaaS,Schedules,Schedules,Service API,Social,Social,Social Sharing,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/buffer/usermediatypeextension-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/buffer/buffer-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://api.bufferapp.com/"}, {"type"=>"x-blog", "url"=>"http://blog.bufferapp.com"}, {"type"=>"x-blog-rss", "url"=>"http://blog.bufferapp.com/feed/"}, {"type"=>"x-github", "url"=>"https://github.com/joelg"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/buffer"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/buffer"}, {"type"=>"x-developer", "url"=>"https://bufferapp.com/developers"}, {"type"=>"x-email", "url"=>"hello@bufferapp.com"}, {"type"=>"x-email", "url"=>"hello@buffer.com"}, {"type"=>"x-email", "url"=>"copyright@buffer.com"}, {"type"=>"x-email", "url"=>"api@bufferapp.com"}, {"type"=>"x-github", "url"=>"https://github.com/bufferapp"}, {"type"=>"x-pricing", "url"=>"https://buffer.com/pricing"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/buffer"}, {"type"=>"x-website", "url"=>"http://bufferapp.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-civic-information{"google-civic-information-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Civic Information", "x-complete"=>1, "info"=>{"title"=>"Google Civic Information", "description"=>"provides-polling-places-early-vote-locations-contest-data-election-officials-and-government-representatives-for-u-s--residential-addresses-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v2"}, "host"=>"www.googleapis.com", "basePath"=>"/civicinfo/v2", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/divisions"=>{"get"=>{"summary"=>"Search Political Divisions", "description"=>"Searches for political divisions by their natural name or OCD ID.", "operationId"=>"civicinfo.divisions.search", "x-api-path-slug"=>"divisions-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"query", "description"=>"The search query"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Division"]}}, "/elections"=>{"get"=>{"summary"=>"List Elections", "description"=>"List of available elections to query.", "operationId"=>"civicinfo.elections.electionQuery", "x-api-path-slug"=>"elections-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Election"]}}, "/representatives"=>{"get"=>{"summary"=>"Lookup Representatives", "description"=>"Looks up political geography and representative information for a single address.", "operationId"=>"civicinfo.representatives.representativeInfoByAddress", "x-api-path-slug"=>"representatives-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"The address to look up"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"includeOffices", "description"=>"Whether to return information about offices and officials"}, {"in"=>"query", "name"=>"levels", "description"=>"A list of office levels to filter by"}, {"in"=>"query", "name"=>"roles", "description"=>"A list of office roles to filter by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representative"]}}, "/representatives/{ocdId}"=>{"get"=>{"summary"=>"Get Representative", "description"=>"Looks up representative information for a single geographic division.", "operationId"=>"civicinfo.representatives.representativeInfoByDivision", "x-api-path-slug"=>"representativesocdid-get", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"levels", "description"=>"A list of office levels to filter by"}, {"in"=>"path", "name"=>"ocdId", "description"=>"The Open Civic Data division identifier of the division to look up"}, {"in"=>"query", "name"=>"recursive", "description"=>"If true, information about all divisions contained in the division requested will be included as well"}, {"in"=>"query", "name"=>"roles", "description"=>"A list of office roles to filter by"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Representative"]}}, "/voterinfo"=>{"get"=>{"summary"=>"Looks Up Voter Information", "description"=>"Looks up information relevant to a voter based on the voter's registered address.", "operationId"=>"civicinfo.elections.voterInfoQuery", "x-api-path-slug"=>"voterinfo-get", "parameters"=>[{"in"=>"query", "name"=>"address", "description"=>"The registered address of the voter to look up"}, {"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"query", "name"=>"electionId", "description"=>"The unique ID of the election to look up"}, {"in"=>"query", "name"=>"officialOnly", "description"=>"If set to true, only data from official state sources will be returned"}, {"in"=>"query", "name"=>"returnAllAvailableData", "description"=>"If set to true, the query will return the success codeand include any partial information when it is unable to determine a matching address or unable to determine the election for electionId=0 queries"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Voter Information"]}}}}, "apis"=>{"name"=>"Google Civic Information", "x-slug"=>"google-civic-information", "description"=>"The Google Civic Information API lets developers build applications that display civic information to their users. For any U.S. residential address, you can look up who represents that address at each elected level of government. During supported elections, you can also look up polling places, early vote location, candidate data, and other election official information.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-civic-information-api.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Cities,Federal Government,Google APIs,Government,Profiles,Relative Data,Service API,Stack Network,State Government", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-civic-information/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Civic Information API", "x-api-slug"=>"google-civic-information-api", "description"=>"The Google Civic Information API lets developers build applications that display civic information to their users. For any U.S. residential address, you can look up who represents that address at each elected level of government. During supported elections, you can also look up polling places, early vote location, candidate data, and other election official information.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/google-civic-information-api.png", "humanURL"=>"https://developers.google.com/civic-information/", "baseURL"=>"://www.googleapis.com//civicinfo/v2", "tags"=>"API Provider,API Service Provider,Cities,Federal Government,Google APIs,Government,Profiles,Relative Data,Service API,Stack Network,State Government", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-civic-information/google-civic-information-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-data-guidelines", "url"=>"https://developers.google.com/civic-information/docs/data_guidelines"}, {"type"=>"x-documentation", "url"=>"https://developers.google.com/civic-information/docs/v2/"}, {"type"=>"x-embeddable", "url"=>"https://developers.google.com/civic-information/docs/embed"}, {"type"=>"x-errors", "url"=>"https://developers.google.com/civic-information/docs/v2/errors"}, {"type"=>"x-forum", "url"=>"https://developers.google.com/civic-information/docs/ci_forum"}, {"type"=>"x-website", "url"=>"https://developers.google.com/civic-information/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
onenote{"one-note-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"OneNote", "x-complete"=>1, "info"=>{"title"=>"One Note", "description"=>"easily-capture-content-into-onenote-with-this-rest-api-", "version"=>"1.0.0"}, "host"=>"www.onenote.com", "basePath"=>"/api/v1.0/me/notes/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/sections/{sectionId}"=>{"get"=>{"summary"=>"Get Sections Sectionid", "description"=>"Returns a specific section.", "operationId"=>"getSectionsSection", "x-api-path-slug"=>"sectionssectionid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"The navigation properties (parentNotebook, or parentSectionGroup) to return inline in the response"}, {"in"=>"path", "name"=>"sectionId", "description"=>"Specifies the specific Section"}, {"in"=>"query", "name"=>"select", "description"=>"The properties to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "SectionId"]}, "parameters"=>{"summary"=>"Parameters Sections Sectionid", "description"=>"Parameters sections sectionid.", "operationId"=>"parametersSectionsSection", "x-api-path-slug"=>"sectionssectionid-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "SectionId"]}}, "/sections/"=>{"get"=>{"summary"=>"Get Sections", "description"=>"Returns a collection of sections.", "operationId"=>"getSections", "x-api-path-slug"=>"sections-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"true, to return the number of entities in the collection"}, {"in"=>"query", "name"=>"expand", "description"=>"The navigation properties (parentNotebook or parentSectionGroup) to return inline in the response"}, {"in"=>"query", "name"=>"filter", "description"=>"The filter for the query"}, {"in"=>"query", "name"=>"orderby", "description"=>"The property to order by"}, {"in"=>"query", "name"=>"select", "description"=>"The properties to return"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of entities to skip in the result set"}, {"in"=>"query", "name"=>"top", "description"=>"The number of entities to return from the result set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections"]}, "parameters"=>{"summary"=>"Parameters Sections", "description"=>"Parameters sections.", "operationId"=>"parametersSections", "x-api-path-slug"=>"sections-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections"]}}, "/sectionGroups/{sectionGroupId}/sectionGroups"=>{"get"=>{"summary"=>"Get Sectiongroups Sectiongroupid Sectiongroups", "description"=>"Returns a collection of section groups within a specific section group.", "operationId"=>"getSectiongroupsSectiongroupSectiongroups", "x-api-path-slug"=>"sectiongroupssectiongroupidsectiongroups-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"true, to return the number of entities in the collection"}, {"in"=>"query", "name"=>"expand", "description"=>"The navigation properties (sections, sectionGroups, parentNotebook, or parentSectionGroup) to return inline in the response"}, {"in"=>"query", "name"=>"filter", "description"=>"The filter for the query"}, {"in"=>"query", "name"=>"orderby", "description"=>"The property to order by"}, {"in"=>"path", "name"=>"sectionGroupId", "description"=>"Specifies the section group"}, {"in"=>"query", "name"=>"select", "description"=>"The properties to return"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of entities to skip in the result set"}, {"in"=>"query", "name"=>"top", "description"=>"The number of entities to return from the result set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SectionGroups", "SectionGroupId", "SectionGroups"]}, "parameters"=>{"summary"=>"Parameters Sectiongroups Sectiongroupid Sectiongroups", "description"=>"Parameters sectiongroups sectiongroupid sectiongroups.", "operationId"=>"parametersSectiongroupsSectiongroupSectiongroups", "x-api-path-slug"=>"sectiongroupssectiongroupidsectiongroups-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SectionGroups", "SectionGroupId", "SectionGroups"]}, "post"=>{"summary"=>"Post Sectiongroups Sectiongroupid Sectiongroups", "description"=>"Post sectiongroups sectiongroupid sectiongroups.", "operationId"=>"postSectiongroupsSectiongroupSectiongroups", "x-api-path-slug"=>"sectiongroupssectiongroupidsectiongroups-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Required: The type of content being sent"}, {"in"=>"path", "name"=>"sectionGroupId", "description"=>"Specifies the section group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SectionGroups", "SectionGroupId", "SectionGroups"]}}, "/sectionGroups/{sectionGroupId}/sections"=>{"get"=>{"summary"=>"Get Sectiongroups Sectiongroupid Sections", "description"=>"Returns a collection of sections within a specific section group.", "operationId"=>"getSectiongroupsSectiongroupSections", "x-api-path-slug"=>"sectiongroupssectiongroupidsections-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"true, to return the number of entities in the collection"}, {"in"=>"query", "name"=>"expand", "description"=>"The navigation properties (parentNotebook or parentSectionGroup) to return inline in the response"}, {"in"=>"query", "name"=>"filter", "description"=>"The filter for the query"}, {"in"=>"query", "name"=>"orderby", "description"=>"The property to order by"}, {"in"=>"path", "name"=>"sectionGroupId", "description"=>"Specifies the section group"}, {"in"=>"query", "name"=>"select", "description"=>"The properties to return"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of entities to skip in the result set"}, {"in"=>"query", "name"=>"top", "description"=>"The number of entities to return from the result set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SectionGroups", "SectionGroupId", "Sections"]}, "parameters"=>{"summary"=>"Parameters Sectiongroups Sectiongroupid Sections", "description"=>"Parameters sectiongroups sectiongroupid sections.", "operationId"=>"parametersSectiongroupsSectiongroupSections", "x-api-path-slug"=>"sectiongroupssectiongroupidsections-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SectionGroups", "SectionGroupId", "Sections"]}, "post"=>{"summary"=>"Post Sectiongroups Sectiongroupid Sections", "description"=>"Post sectiongroups sectiongroupid sections.", "operationId"=>"postSectiongroupsSectiongroupSections", "x-api-path-slug"=>"sectiongroupssectiongroupidsections-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Required: The type of content being sent"}, {"in"=>"path", "name"=>"sectionGroupId", "description"=>"Specifies the section group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SectionGroups", "SectionGroupId", "Sections"]}}, "/sectionGroups/{sectionGroupId}"=>{"get"=>{"summary"=>"Get Sectiongroups Sectiongroupid", "description"=>"Returns a specific section group object.", "operationId"=>"getSectiongroupsSectiongroup", "x-api-path-slug"=>"sectiongroupssectiongroupid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"The navigation properties (sections, sectionGroups, parentNotebook, or parentSectionGroup) to return inline in the response"}, {"in"=>"path", "name"=>"sectionGroupId", "description"=>"Specifies the specific section group"}, {"in"=>"query", "name"=>"select", "description"=>"The properties to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SectionGroups", "SectionGroupId"]}, "parameters"=>{"summary"=>"Parameters Sectiongroups Sectiongroupid", "description"=>"Parameters sectiongroups sectiongroupid.", "operationId"=>"parametersSectiongroupsSectiongroup", "x-api-path-slug"=>"sectiongroupssectiongroupid-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SectionGroups", "SectionGroupId"]}}, "/sectionGroups/"=>{"get"=>{"summary"=>"Get Sectiongroups", "description"=>"Returns a collection of section groups.", "operationId"=>"getSectiongroups", "x-api-path-slug"=>"sectiongroups-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"true, to return the number of entities in the collection"}, {"in"=>"query", "name"=>"expand", "description"=>"The navigation properties (sections, sectionGroups, parentNotebook, or parentSectionGroup) to return inline in the response"}, {"in"=>"query", "name"=>"filter", "description"=>"The filter for the query"}, {"in"=>"query", "name"=>"orderby", "description"=>"The property to order by"}, {"in"=>"query", "name"=>"select", "description"=>"The properties to return"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of entities to skip in the result set"}, {"in"=>"query", "name"=>"top", "description"=>"The number of entities to return from the result set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SectionGroups"]}, "parameters"=>{"summary"=>"Parameters Sectiongroups", "description"=>"Parameters sectiongroups.", "operationId"=>"parametersSectiongroups", "x-api-path-slug"=>"sectiongroups-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["SectionGroups"]}}, "/notebooks/{notebookId}/sectiongroups"=>{"get"=>{"summary"=>"Get Notebooks Notebookid Sectiongroups", "description"=>"Returns a collection of section groups within a specific notebook.", "operationId"=>"getNotebooksNotebookSectiongroups", "x-api-path-slug"=>"notebooksnotebookidsectiongroups-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"true, to return the number of entities in the collection"}, {"in"=>"query", "name"=>"expand", "description"=>"The navigation properties (sections, sectionGroups, parentNotebook, or parentSectionGroup) to return inline in the response"}, {"in"=>"query", "name"=>"filter", "description"=>"The filter for the query"}, {"in"=>"path", "name"=>"notebookId", "description"=>"Specifies the notebook"}, {"in"=>"query", "name"=>"orderby", "description"=>"The property to order by"}, {"in"=>"query", "name"=>"select", "description"=>"The properties to return"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of entities to skip in the result set"}, {"in"=>"query", "name"=>"top", "description"=>"The number of entities to return from the result set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notebooks", "NotebookId", "Sectiongroups"]}, "parameters"=>{"summary"=>"Parameters Notebooks Notebookid Sectiongroups", "description"=>"Parameters notebooks notebookid sectiongroups.", "operationId"=>"parametersNotebooksNotebookSectiongroups", "x-api-path-slug"=>"notebooksnotebookidsectiongroups-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notebooks", "NotebookId", "Sectiongroups"]}, "post"=>{"summary"=>"Post Notebooks Notebookid Sectiongroups", "description"=>"Creates a new section group in a notebook.", "operationId"=>"postNotebooksNotebookSectiongroups", "x-api-path-slug"=>"notebooksnotebookidsectiongroups-post", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Required: The type of content being sent"}, {"in"=>"path", "name"=>"notebookId", "description"=>"Specifies the notebook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notebooks", "NotebookId", "Sectiongroups"]}}, "/notebooks/{notebookId}/sections"=>{"get"=>{"summary"=>"Get Notebooks Notebookid Sections", "description"=>"Returns a collection of sections within a specific notebook.", "operationId"=>"getNotebooksNotebookSections", "x-api-path-slug"=>"notebooksnotebookidsections-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"true, to return the number of entities in the collection"}, {"in"=>"query", "name"=>"expand", "description"=>"The navigation properties (parentNotebook or parentSectionGroup) to return inline in the response"}, {"in"=>"query", "name"=>"filter", "description"=>"The filter for the query"}, {"in"=>"path", "name"=>"notebookId", "description"=>"Specifies the notebook"}, {"in"=>"query", "name"=>"orderby", "description"=>"The property to order by"}, {"in"=>"query", "name"=>"select", "description"=>"The properties to return"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of entities to skip in the result set"}, {"in"=>"query", "name"=>"top", "description"=>"The number of entities to return from the result set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notebooks", "NotebookId", "Sections"]}, "post"=>{"summary"=>"Post Notebooks Notebookid Sections", "description"=>"Creates a new section in a specific notebook.", "operationId"=>"postNotebooksNotebookSections", "x-api-path-slug"=>"notebooksnotebookidsections-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Required: indicates type of content being sent"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Required: indicates type of content being sent"}, {"in"=>"path", "name"=>"notebookId", "description"=>"Specifies the notebook"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notebooks", "NotebookId", "Sections"]}, "parameters"=>{"summary"=>"Parameters Notebooks Notebookid Sections", "description"=>"Parameters notebooks notebookid sections.", "operationId"=>"parametersNotebooksNotebookSections", "x-api-path-slug"=>"notebooksnotebookidsections-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notebooks", "NotebookId", "Sections"]}}, "/notebooks/{notebookId}"=>{"get"=>{"summary"=>"Get Notebooks Notebookid", "description"=>"Returns a specific notebook object.", "operationId"=>"getNotebooksNotebook", "x-api-path-slug"=>"notebooksnotebookid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"The navigation properties (sections and sectionGroups) to return inline in the response"}, {"in"=>"path", "name"=>"notebookId", "description"=>"Specifies the specific notebook"}, {"in"=>"query", "name"=>"select", "description"=>"The properties to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notebooks", "NotebookId"]}, "parameters"=>{"summary"=>"Parameters Notebooks Notebookid", "description"=>"Parameters notebooks notebookid.", "operationId"=>"parametersNotebooksNotebook", "x-api-path-slug"=>"notebooksnotebookid-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notebooks", "NotebookId"]}}, "/notebooks"=>{"get"=>{"summary"=>"Get Notebooks", "description"=>"Returns a collection of notebooks.", "operationId"=>"getNotebooks", "x-api-path-slug"=>"notebooks-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"true, to return the number of entities in the collection"}, {"in"=>"query", "name"=>"expand", "description"=>"The navigation properties (sections or sectionGroups) to return inline in the response"}, {"in"=>"query", "name"=>"filter", "description"=>"The filter for the query"}, {"in"=>"query", "name"=>"orderby", "description"=>"The property to order by"}, {"in"=>"query", "name"=>"select", "description"=>"The properties to return"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of entities to skip in the result set"}, {"in"=>"query", "name"=>"top", "description"=>"The number of entities to return from the result set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notebooks"]}, "post"=>{"summary"=>"Post Notebooks", "description"=>"Creates a new notebook.", "operationId"=>"postNotebooks", "x-api-path-slug"=>"notebooks-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Required: indicates type of content being sent"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Required: indicates type of content being sent"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notebooks"]}, "parameters"=>{"summary"=>"Parameters Notebooks", "description"=>"Parameters notebooks.", "operationId"=>"parametersNotebooks", "x-api-path-slug"=>"notebooks-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Notebooks"]}}, "/pages/{pageId}/content"=>{"get"=>{"summary"=>"Get Pages Pageid Content", "description"=>"Returns HTML content of the specified page.", "operationId"=>"getPagesPageContent", "x-api-path-slug"=>"pagespageidcontent-get", "parameters"=>[{"in"=>"header", "name"=>"Accept", "description"=>"Required: indicates type of content returned in the response"}, {"in"=>"query", "name"=>"Accept", "description"=>"Required: indicates type of content returned in the response"}, {"in"=>"query", "name"=>"includeIDs", "description"=>"Optional: set to true to get generated IDs to use for PATCH operations"}, {"in"=>"path", "name"=>"pageId", "description"=>"Specifies the page whose content you want to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages", "PageId", "Content"]}, "parameters"=>{"summary"=>"Parameters Pages Pageid Content", "description"=>"Parameters pages pageid content.", "operationId"=>"parametersPagesPageContent", "x-api-path-slug"=>"pagespageidcontent-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages", "PageId", "Content"]}}, "/pages/{pageId}"=>{"delete"=>{"summary"=>"Delete Pages Pageid", "description"=>"Deletes the specified page.", "operationId"=>"deletePagesPage", "x-api-path-slug"=>"pagespageid-delete", "parameters"=>[{"in"=>"path", "name"=>"pageId", "description"=>"Specifies the page to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages", "PageId"]}, "get"=>{"summary"=>"Get Pages Pageid", "description"=>"Returns the specified page.", "operationId"=>"getPagesPage", "x-api-path-slug"=>"pagespageid-get", "parameters"=>[{"in"=>"query", "name"=>"expand", "description"=>"The navigation properties (parentNotebook or parentSection) to return inline in the response"}, {"in"=>"path", "name"=>"pageId", "description"=>"Specifies the page to get"}, {"in"=>"query", "name"=>"pagelevel", "description"=>"true, to return the level and order properties"}, {"in"=>"query", "name"=>"select", "description"=>"The properties to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages", "PageId"]}, "parameters"=>{"summary"=>"Parameters Pages Pageid", "description"=>"Parameters pages pageid.", "operationId"=>"parametersPagesPage", "x-api-path-slug"=>"pagespageid-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages", "PageId"]}}, "/sections/{sectionId}/pages"=>{"get"=>{"summary"=>"Get Sections Sectionid Pages", "description"=>"Get the pages (metadata) in the specified section.", "operationId"=>"getSectionsSectionPages", "x-api-path-slug"=>"sectionssectionidpages-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"true, to return the number of entities in the collection"}, {"in"=>"query", "name"=>"expand", "description"=>"The navigation properties (parentNotebook or parentSection) to return inline in the response"}, {"in"=>"query", "name"=>"filter", "description"=>"The filter for the query"}, {"in"=>"query", "name"=>"orderby", "description"=>"The property to order by"}, {"in"=>"query", "name"=>"pagelevel", "description"=>"true, to return the level and order properties for pages"}, {"in"=>"query", "name"=>"search", "description"=>"The term or phrase to search for"}, {"in"=>"path", "name"=>"sectionId", "description"=>"Specifies the section that contains the pages"}, {"in"=>"query", "name"=>"select", "description"=>"The properties to return"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of entities to skip in the result set"}, {"in"=>"query", "name"=>"top", "description"=>"The number of entities to return from the result set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "SectionId", "Pages"]}, "post"=>{"summary"=>"Post Sections Sectionid Pages", "description"=>"Creates a new page in a specific section.", "operationId"=>"postSectionsSectionPages", "x-api-path-slug"=>"sectionssectionidpages-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Required: indicates type of content sent"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Required: indicates type of content sent"}, {"in"=>"path", "name"=>"sectionId", "description"=>"Specifies the section to create the page in"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "SectionId", "Pages"]}, "parameters"=>{"summary"=>"Parameters Sections Sectionid Pages", "description"=>"Parameters sections sectionid pages.", "operationId"=>"parametersSectionsSectionPages", "x-api-path-slug"=>"sectionssectionidpages-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Sections", "SectionId", "Pages"]}}, "/pages"=>{"get"=>{"summary"=>"Get Pages", "description"=>"Get the pages (metadata) from all notebooks in OneDrive that are owned by the user.", "operationId"=>"getPages", "x-api-path-slug"=>"pages-get", "parameters"=>[{"in"=>"query", "name"=>"count", "description"=>"true, to return the number of entities in the collection"}, {"in"=>"query", "name"=>"filter", "description"=>"The filter for the query"}, {"in"=>"query", "name"=>"orderby", "description"=>"The property to order by"}, {"in"=>"query", "name"=>"search", "description"=>"The term or phrase to search for"}, {"in"=>"query", "name"=>"select", "description"=>"The properties to return"}, {"in"=>"query", "name"=>"skip", "description"=>"The number of entities to skip in the result set"}, {"in"=>"query", "name"=>"top", "description"=>"The number of entities to return from the result set"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages"]}, "post"=>{"summary"=>"Post Pages", "description"=>"Creates a new page in the default notebook and section.", "operationId"=>"postPages", "x-api-path-slug"=>"pages-post", "parameters"=>[{"in"=>"header", "name"=>"Content-Type", "description"=>"Required: indicates type of content sent"}, {"in"=>"query", "name"=>"Content-Type", "description"=>"Required: indicates type of content sent"}, {"in"=>"query", "name"=>"sectionName", "description"=>"Optional: indicates the name of the section in the default notebook that the page should be created in"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages"]}, "parameters"=>{"summary"=>"Parameters Pages", "description"=>"Parameters pages.", "operationId"=>"parametersPages", "x-api-path-slug"=>"pages-parameters", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages"]}}, "/pages/{pageId}/preview"=>{"get"=>{"summary"=>"Get Pages Pageid Preview", "description"=>"Returns preview text and (if there is one) a preview image for the specified page.", "operationId"=>"getPagesPagePreview", "x-api-path-slug"=>"pagespageidpreview-get", "parameters"=>[{"in"=>"query", "name"=>"Content-Type", "description"=>"Required: indicates type of content being sent"}, {"in"=>"path", "name"=>"pageId", "description"=>"Specifies the page whose content you want to retrieve"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Pages", "PageId", "Preview"]}}}}, "apis"=>{"name"=>"OneNote", "x-slug"=>"onenote", "description"=>"Microsoft OneNote (formerly called Microsoft Office OneNote) is a computer program for free-form information gathering and multi-user collaboration. It gathers users notes (handwritten or typed), drawings, screen clippings and audio commentaries. Notes can be shared with other OneNote users over the Internet or a network. OneNote is available as a part of the Microsoft Office suite. It is also available as a free stand-alone application for Windows, Mac, Windows RT, Windows Phone, iOS, Android and Symbian.[4] A web-based version of OneNote is provided as part of OneDrive or Office Online and enables users to edit notes via a web browser.", "image"=>"https://s3.amazonaws.com/kinlane-productions/api-evangelist/api-butterfly.png", "x-kinRank"=>"7", "x-alexaRank"=>"5531", "tags"=>"API Provider,Getting Started Example,Notes,Profiles,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"onenote/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"One Note", "x-api-slug"=>"one-note", "description"=>"Microsoft OneNote (formerly called Microsoft Office OneNote) is a computer program for free-form information gathering and multi-user collaboration. It gathers users notes (handwritten or typed), drawings, screen clippings and audio commentaries. Notes can be shared with other OneNote users over the Internet or a network. OneNote is available as a part of the Microsoft Office suite. It is also available as a free stand-alone application for Windows, Mac, Windows RT, Windows Phone, iOS, Android and Symbian.[4] A web-based version of OneNote is provided as part of OneDrive or Office Online and enables users to edit notes via a web browser.", "image"=>"https://s3.amazonaws.com/kinlane-productions/api-evangelist/api-butterfly.png", "humanURL"=>"http://onenote.com", "baseURL"=>"https://www.onenote.com//api/v1.0/me/notes/", "tags"=>"API Provider,Getting Started Example,Notes,Profiles,Relative Data,Service API", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/onenote/sectiongroupssectiongroupidsectiongroups-post-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/onenote/one-note-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-application-gallery", "url"=>"http://dev.office.com/showcase"}, {"type"=>"x-blog", "url"=>"http://blogs.msdn.com/b/onenotedev/"}, {"type"=>"x-blog-rss", "url"=>"http://blogs.msdn.com/b/onenotedev/rss.aspx"}, {"type"=>"x-console", "url"=>"https://apigee.com/onenote/embed/console/onenote"}, {"type"=>"x-developer", "url"=>"http://dev.onenote.com/"}, {"type"=>"x-getting-started", "url"=>"http://msdn.microsoft.com/en-us/library/office/dn575425.aspx"}, {"type"=>"x-github", "url"=>"https://github.com/OneNoteDev"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/OneNoteDev"}, {"type"=>"x-privacy", "url"=>"http://go.microsoft.com/fwlink/?LinkId=391953&clcid=0x409"}, {"type"=>"x-stack-overflow", "url"=>"http://stackoverflow.com/questions/tagged/onenote"}, {"type"=>"x-terms-of-service", "url"=>"http://go.microsoft.com/fwlink/?LinkId=391954&clcid=0x409"}, {"type"=>"x-trademarks", "url"=>"http://go.microsoft.com/fwlink/p/?LinkId=316970"}, {"type"=>"x-website", "url"=>"http://onenote.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
iconfinder{"icon-finder-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Iconfinder", "x-complete"=>1, "info"=>{"title"=>"Icon Finder", "description"=>"give-your-users-instant-access-to-more-than-300000-icons-", "termsOfService"=>"https://developer.iconfinder.com/api/2.0/terms.html", "version"=>"v2"}, "host"=>"api.iconfinder.com", "basePath"=>"/v2/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/authors/{authorID}"=>{"get"=>{"summary"=>"Get author details", "description"=>"Get details about a specific author identified by a unique ID.", "operationId"=>"getAuthorsAuthor", "x-api-path-slug"=>"authorsauthorid-get", "parameters"=>[{"in"=>"path", "name"=>"authors", "description"=>"The ID of the author"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Authors"]}}, "/categories"=>{"get"=>{"summary"=>"List all categories", "description"=>"List all categories sorted ascendingly by their identifier.", "operationId"=>"getCategories", "x-api-path-slug"=>"categories-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"identifier of the last category received"}, {"in"=>"query", "name"=>"count"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories"]}}, "/icons/search"=>{"get"=>{"summary"=>"Search for icons", "description"=>"Search through icons by various criteria. The returned list of icons is ordered descendingly by popularit", "operationId"=>"getIconsSearch", "x-api-path-slug"=>"iconssearch-get", "parameters"=>[{"in"=>"query", "name"=>"category"}, {"in"=>"query", "name"=>"count", "description"=>"Number of icons to include in the result"}, {"in"=>"query", "name"=>"license", "description"=>"Filter by license scope"}, {"in"=>"query", "name"=>"maximum_size", "description"=>"Maximum icon size to include in search result"}, {"in"=>"query", "name"=>"minimum_size", "description"=>"Minimum icon size to include in search result"}, {"in"=>"query", "name"=>"offset", "description"=>"Result offset"}, {"in"=>"query", "name"=>"premium", "description"=>"Filter premium icons"}, {"in"=>"query", "name"=>"query", "description"=>"Keyword to search by"}, {"in"=>"query", "name"=>"style"}, {"in"=>"query", "name"=>"vector", "description"=>"Filter vector icons"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Icons", "Search"]}}, "/licenses/{licenseID}"=>{"get"=>{"summary"=>"Get license details", "description"=>"Get details about a specific license by its unique ID.", "operationId"=>"getLicensesLicense", "x-api-path-slug"=>"licenseslicenseid-get", "parameters"=>[{"in"=>"path", "name"=>"licenseID", "description"=>"The unique id of the license"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Licenses"]}}, "/styles/{styleID}"=>{"get"=>{"summary"=>"Get style details", "description"=>"Get details about a specific style identified by its identifier.", "operationId"=>"getStylesStyle", "x-api-path-slug"=>"stylesstyleid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Styles"]}}, "/user"=>{"get"=>{"summary"=>"Get Authentication User.", "description"=>"Gets an authenticated user.", "operationId"=>"getUser", "x-api-path-slug"=>"user-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["User"]}}, "/v2/categories/{categoryID}"=>{"get"=>{"summary"=>"Get category details", "description"=>"Get details about a specific category identified by its identifier.", "operationId"=>"getV2CategoriesCategory", "x-api-path-slug"=>"v2categoriescategoryid-get", "parameters"=>[{"in"=>"path", "name"=>"categoryID", "description"=>"The unique ID of the category"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Categories"]}}, "/v2/icons/{iconID}"=>{"get"=>{"summary"=>"Get icon details", "description"=>"Get details about a specific ico", "operationId"=>"getV2IconsIcon", "x-api-path-slug"=>"v2iconsiconid-get", "parameters"=>[{"in"=>"path", "name"=>"iconID", "description"=>"The unique ID of the icon"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Icons"]}}, "/v2/iconsets/{iconID}/icons"=>{"get"=>{"summary"=>"List all icons in an icon set", "description"=>"Provides a list of all icons in an icon set sorted descendingly by the popularity of the icons.List all icons in an icon set", "operationId"=>"getV2IconsetsIconIcons", "x-api-path-slug"=>"v2iconsetsiconidicons-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"Icon ID of the last icon received"}, {"in"=>"query", "name"=>"count", "description"=>"Number of icons to include in the result"}, {"in"=>"path", "name"=>"List all icons in an icon set", "description"=>"Unique id of the icon"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Icons"]}}, "/v2/styles"=>{"get"=>{"summary"=>"List all styles", "description"=>"List all styles sorted ascendingly by their identifier.", "operationId"=>"getV2Styles", "x-api-path-slug"=>"v2styles-get", "parameters"=>[{"in"=>"query", "name"=>"after", "description"=>"identifier of the last style received"}, {"in"=>"query", "name"=>"count", "description"=>"Number of styles to include in the result"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Styles"]}}, "GET /v2/users/{userID}"=>{"get"=>{"summary"=>"Get user details", "description"=>"Get details about a specific user.", "operationId"=>"getGetV2UsersUser", "x-api-path-slug"=>"get-v2usersuserid-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Users"]}}, "GET /v2/users/{username}"=>{"get"=>{"summary"=>"Get user details", "description"=>"Get details about a specific user.", "operationId"=>"getGetV2UsersUsername", "x-api-path-slug"=>"get-v2usersusername-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["", "Users", "Username"]}}}}, "apis"=>{"name"=>"Iconfinder", "x-slug"=>"iconfinder", "description"=>"Iconfinder is the leading search engine and market place for vector icons in SVG, PNG, CSH and AI format..", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1538-iconfinder.jpg", "x-kinRank"=>"7", "x-alexaRank"=>"4089", "tags"=>"API Provider,General Data,Icon,Images,Images,internet,Marketplace,Profiles,Relative Data,Service API,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"iconfinder/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Icon Finder", "x-api-slug"=>"icon-finder", "description"=>"Iconfinder is the leading search engine and market place for vector icons in SVG, PNG, CSH and AI format..", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/1538-iconfinder.jpg", "humanURL"=>"http://iconfinder.com", "baseURL"=>"https://api.iconfinder.com//v2/", "tags"=>"API Provider,General Data,Icon,Images,Images,internet,Marketplace,Profiles,Relative Data,Service API,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/iconfinder/get-v2usersusername-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/iconfinder/icon-finder-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"https://www.iconfinder.com/xml/"}, {"type"=>"x-blog", "url"=>"http://www.iconfinder.com/blog"}, {"type"=>"x-blog-rss", "url"=>"http://blog.iconfinder.com/feed/"}, {"type"=>"x-crunchbase", "url"=>"http://www.crunchbase.com/company/iconfinder"}, {"type"=>"x-crunchbase", "url"=>"https://crunchbase.com/organization/iconfinder"}, {"type"=>"x-developer", "url"=>"http://www.iconfinder.com/about/api"}, {"type"=>"x-email", "url"=>"support@iconfinder.com"}, {"type"=>"x-email", "url"=>"contact@iconfinder.com"}, {"type"=>"x-github", "url"=>"https://github.com/iconfinder"}, {"type"=>"x-pricing", "url"=>"https://www.iconfinder.com/pro"}, {"type"=>"x-privacy", "url"=>"https://www.iconfinder.com/about/privacypolicy"}, {"type"=>"x-terms-of-service", "url"=>"https://developer.iconfinder.com/api/2.0/terms.html"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/iconfinder"}, {"type"=>"x-website", "url"=>"http://iconfinder.com"}, {"type"=>"x-website", "url"=>"http://www.iconfinder.com"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
google-cloud-datastore{"google-cloud-datastore-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Google Cloud Datastore", "x-complete"=>1, "info"=>{"title"=>"Google Cloud Datastore", "description"=>"accesses-the-schemaless-nosql-database-to-provide-fully-managed-robust-scalable-storage-for-your-application-", "contact"=>{"name"=>"Google", "url"=>"https://google.com"}, "version"=>"v1"}, "host"=>"datastore.googleapis.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v1/projects/{projectId}:allocateIds"=>{"post"=>{"summary"=>"Allocate ID", "description"=>"Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.", "operationId"=>"datastore.projects.allocateIds", "x-api-path-slug"=>"v1projectsprojectidallocateids-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"The ID of the project against which to make the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["ID"]}}, "/v1/projects/{projectId}:beginTransaction"=>{"post"=>{"summary"=>"Begin New Transaction", "description"=>"Begins a new transaction.", "operationId"=>"datastore.projects.beginTransaction", "x-api-path-slug"=>"v1projectsprojectidbegintransaction-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"The ID of the project against which to make the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transaction"]}}, "/v1/projects/{projectId}:commit"=>{"post"=>{"summary"=>"Commit Transaction", "description"=>"Commits a transaction, optionally creating, deleting or modifying some\nentities.", "operationId"=>"datastore.projects.commit", "x-api-path-slug"=>"v1projectsprojectidcommit-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"The ID of the project against which to make the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transaction"]}}, "/v1/projects/{projectId}:lookup"=>{"post"=>{"summary"=>"Lookup Entity by Key", "description"=>"Looks up entities by key.", "operationId"=>"datastore.projects.lookup", "x-api-path-slug"=>"v1projectsprojectidlookup-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"The ID of the project against which to make the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Lookup"]}}, "/v1/projects/{projectId}:rollback"=>{"post"=>{"summary"=>"Rollback Transaction", "description"=>"Rolls back a transaction.", "operationId"=>"datastore.projects.rollback", "x-api-path-slug"=>"v1projectsprojectidrollback-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"The ID of the project against which to make the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Transaction"]}}, "/v1/projects/{projectId}:runQuery"=>{"post"=>{"summary"=>"Queries for Entities", "description"=>"Queries for entities.", "operationId"=>"datastore.projects.runQuery", "x-api-path-slug"=>"v1projectsprojectidrunquery-post", "parameters"=>[{"in"=>"body", "name"=>"body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"projectId", "description"=>"The ID of the project against which to make the request"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Query"]}}}}, "apis"=>{"name"=>"Google Cloud Datastore", "x-slug"=>"google-cloud-datastore", "description"=>"Cloud Datastore is a highly-scalable NoSQL database for your applications. Cloud Datastore automatically handles sharding and replication, providing you with a highly available and durable database that scales automatically to handle your applications load. Cloud Datastore provides a myriad of capabilities such as ACID transactions, SQL-like queries, indexes and much more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/nosql-tree.png", "x-kinRank"=>"9", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Data,Databases,Deployments,Google APIs,Profiles,Relative Data,Service API,Stack Network", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"google-cloud-datastore/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Google Cloud Datastore API", "x-api-slug"=>"google-cloud-datastore-api", "description"=>"Cloud Datastore is a highly-scalable NoSQL database for your applications. Cloud Datastore automatically handles sharding and replication, providing you with a highly available and durable database that scales automatically to handle your applications load. Cloud Datastore provides a myriad of capabilities such as ACID transactions, SQL-like queries, indexes and much more.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/nosql-tree.png", "humanURL"=>"https://cloud.google.com/datastore/", "baseURL"=>"://datastore.googleapis.com//", "tags"=>"API Provider,API Service Provider,Data,Databases,Deployments,Google APIs,Profiles,Relative Data,Service API,Stack Network", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/google-cloud-datastore/google-cloud-datastore-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-best-practices", "url"=>"https://cloud.google.com/datastore/docs/best-practices"}, {"type"=>"x-change-log", "url"=>"https://cloud.google.com/datastore/release-notes"}, {"type"=>"x-concepts", "url"=>"https://cloud.google.com/datastore/docs/concepts"}, {"type"=>"x-documentation", "url"=>"https://cloud.google.com/datastore/docs/"}, {"type"=>"x-getting-started", "url"=>"https://cloud.google.com/datastore/docs/quickstart"}, {"type"=>"x-guides", "url"=>"https://cloud.google.com/datastore/docs/how-to"}, {"type"=>"x-issues", "url"=>"https://github.com/GoogleCloudPlatform/google-cloud-datastore/issues"}, {"type"=>"x-pricing", "url"=>"https://cloud.google.com/datastore/pricing"}, {"type"=>"x-service-level-agreement", "url"=>"https://cloud.google.com/datastore/sla"}, {"type"=>"x-support", "url"=>"https://cloud.google.com/datastore/docs/support"}, {"type"=>"x-website", "url"=>"https://cloud.google.com/datastore/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
opencage{"open-cage-geocoder-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"OpenCage", "x-complete"=>1, "info"=>{"title"=>"Open Cage Geocoder", "description"=>"worldwide-forward-and-reverse-geocoding", "termsOfService"=>"https://geocoder.opencagedata.com/terms", "contact"=>{"name"=>"OpenCage Data Ltd", "url"=>"https://geocoder.opencagedata.com/contact"}, "version"=>"1"}, "host"=>"api.opencagedata.com", "basePath"=>"/geocode", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v{version}/{format}"=>{"get"=>{"summary"=>"Geocode", "description"=>"geocode a query", "operationId"=>"vversion.format.get", "x-api-path-slug"=>"vversionformat-get", "parameters"=>[{"in"=>"query", "name"=>"abbrv", "description"=>"when true we attempt to abbreviate the formatted field in the response"}, {"in"=>"query", "name"=>"add_request", "description"=>"if true the request is included in the response"}, {"in"=>"query", "name"=>"bounds", "description"=>"four coordinate points forming the south-west and north-east corners of a bounding box (min long, min lat, max long, max lat)"}, {"in"=>"query", "name"=>"countrycode", "description"=>"two letter code ISO 3166-1 Alpha 2 code to limit results to that country"}, {"in"=>"path", "name"=>"format", "description"=>"format of the response"}, {"in"=>"query", "name"=>"jsonp", "description"=>"wraps the returned JSON with a function name"}, {"in"=>"query", "name"=>"key", "description"=>"an application key"}, {"in"=>"query", "name"=>"language", "description"=>"an IETF format language code (ex: es or pt-BR)"}, {"in"=>"query", "name"=>"limit", "description"=>"maximum number of results to return"}, {"in"=>"query", "name"=>"min_confidence", "description"=>"integer from 1-10"}, {"in"=>"query", "name"=>"no_annotations", "description"=>"when true annotations are not added to results"}, {"in"=>"query", "name"=>"no_dedupe", "description"=>"when true results are not deduplicated"}, {"in"=>"query", "name"=>"no_record", "description"=>"when true query content is not logged"}, {"in"=>"query", "name"=>"pretty", "description"=>"when true results are pretty printed"}, {"in"=>"query", "name"=>"q", "description"=>"string or lat,lng to be geocoded"}, {"in"=>"path", "name"=>"version", "description"=>"API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Geocode"]}}}}, "opencage-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"OpenCage", "x-complete"=>1, "info"=>{"title"=>"OpenCage Geocoder", "description"=>"worldwide-forward-and-reverse-geocoding", "termsOfService"=>"https://geocoder.opencagedata.com/terms", "contact"=>{"name"=>"OpenCage Data Ltd", "url"=>"https://geocoder.opencagedata.com/contact"}, "version"=>"1.0.0"}, "host"=>"api.opencagedata.com", "basePath"=>"v1/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/v{version}/{format}"=>{"get"=>{"summary"=>"Geocode Query", "description"=>"Geocode a query", "operationId"=>"vversion.format.get", "x-api-path-slug"=>"vversionformat-get", "parameters"=>[{"in"=>"query", "name"=>"abbrv", "description"=>"when true we attempt to abbreviate the formatted field in the response"}, {"in"=>"query", "name"=>"add_request", "description"=>"if true the request is included in the response"}, {"in"=>"query", "name"=>"bounds", "description"=>"four coordinate points forming the south-west and north-east corners of a bounding box (min long, min lat, max long, max lat)"}, {"in"=>"query", "name"=>"countrycode", "description"=>"two letter code ISO 3166-1 Alpha 2 code to limit results to that country"}, {"in"=>"path", "name"=>"format", "description"=>"format of the response"}, {"in"=>"query", "name"=>"jsonp", "description"=>"wraps the returned JSON with a function name"}, {"in"=>"query", "name"=>"key", "description"=>"an application key"}, {"in"=>"query", "name"=>"language", "description"=>"an IETF format language code (ex: es or pt-BR)"}, {"in"=>"query", "name"=>"limit", "description"=>"maximum number of results to return"}, {"in"=>"query", "name"=>"min_confidence", "description"=>"integer from 1-10"}, {"in"=>"query", "name"=>"no_annotations", "description"=>"when true annotations are not added to results"}, {"in"=>"query", "name"=>"no_dedupe", "description"=>"when true results are not deduplicated"}, {"in"=>"query", "name"=>"no_record", "description"=>"when true query content is not logged"}, {"in"=>"query", "name"=>"pretty", "description"=>"when true results are pretty printed"}, {"in"=>"query", "name"=>"q", "description"=>"string or lat,lng to be geocoded"}, {"in"=>"path", "name"=>"version", "description"=>"API version"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Geo", "Encoding", "Query"]}}}}, "apis"=>{"name"=>"OpenCage", "x-slug"=>"opencage", "description"=>"An easy-to-use forward and reverse geocoding API. Worldwide coverage. Affordable, predictable pricing. Open data.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2956-opencage.jpg", "x-kinRank"=>"9", "x-alexaRank"=>"1026215", "tags"=>"General Data,Geo,Geo,Locations,Maps,Service API,Stack Network,Technology", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"opencage/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Open Cage Geocoder", "x-api-slug"=>"open-cage-geocoder", "description"=>"An easy-to-use forward and reverse geocoding API. Worldwide coverage. Affordable, predictable pricing. Open data.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2956-opencage.jpg", "humanURL"=>"http://opencagedata.com", "baseURL"=>"https://api.opencagedata.com//geocode", "tags"=>"General Data,Geo,Geo,Locations,Maps,Service API,Stack Network,Technology", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/opencage/vversionformat-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/opencage/open-cage-geocoder-openapi.yaml"}]}, {"name"=>"OpenCage", "x-api-slug"=>"opencage", "description"=>"An easy-to-use forward and reverse geocoding API. Worldwide coverage. Affordable, predictable pricing. Open data.", "image"=>"http://kinlane-productions.s3.amazonaws.com/screen-capture-api/2956-opencage.jpg", "humanURL"=>"http://opencagedata.com", "baseURL"=>"https://api.opencagedata.com/v1/", "tags"=>"Geocode", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/opencage/vversionformat-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/opencage/opencage-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-base", "url"=>"http://api.opencagedata.com/"}, {"type"=>"x-blog", "url"=>"http://blog.opencagedata.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blog.opencagedata.com/rss"}, {"type"=>"x-github", "url"=>"https://github.com/opencagedata"}, {"type"=>"x-pricing", "url"=>"https://geocoder.opencagedata.com/pricing"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/opencagedata"}, {"type"=>"x-website", "url"=>"http://opencagedata.com"}, {"type"=>"x-website", "url"=>"http://www.opencagedata.com/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
oauth-io{} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
vmware{"apis"=>{"name"=>"VMWare", "x-slug"=>"vmware", "description"=>"At VMware, we believe that software has the power to unlock new opportunities for people and our planet. We look beyond the barriers of compromise to engineer new ways to make technologies work together seamlessly. Our software forms a digital foundation that powers the apps, services and experiences that are transforming the world.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/VMware_logo.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"Cloud,Compute,Networks,Relative Data,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"vmware/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"VMWare vRealize Operations", "x-api-slug"=>"vmware-vrealize-operations", "description"=>"vRealize Suite is an enterprise-ready, cloud management suite that delivers the industry’s most complete solution for managing a heterogeneous, hybrid cloud.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/VMware_logo.png", "humanURL"=>"http://vmware.com", "baseURL"=>"https://example.com//suite-api/api", "tags"=>"Cloud,Compute,Networks,Relative Data,Service API", "properties"=>[{"type"=>"x-openapi-spec", "url"=>"/vmware/vmware-vrealize-operations-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-blog", "url"=>"https://blogs.vmware.com/"}, {"type"=>"x-blog-rss", "url"=>"http://blogs.vmware.com/all-vmware-blogs/wprss"}, {"type"=>"x-github", "url"=>"https://github.com/VMware"}, {"type"=>"x-twitter", "url"=>"https://twitter.com/VMware"}, {"type"=>"x-website", "url"=>"http://vmware.com"}, {"type"=>"x-curated-source", "url"=>"https://blogs.vmware.com/vcloud/2015/12/vmware-vcloud-air-network-compliance-spotlight-hipaa.html"}, {"type"=>"x-website", "url"=>"https://www.vmware.com"}, {"type"=>"x-branding", "url"=>"https://www.vmware.com/brand/our-brand.html"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}, "vmware-vrealize-operations-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"VMWare", "x-complete"=>1, "info"=>{"title"=>"vRealize Operations 6", "description"=>"todo-add-description", "version"=>"1.0.0"}, "host"=>"example.com", "basePath"=>"/suite-api/api", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/api/auth/token/acquire"=>{"post"=>{"summary"=>"RUN FIRST - Get vR Ops Auth Token", "description"=>"TODO: Add Description", "operationId"=>"ApiAuthTokenAcquirePost", "x-api-path-slug"=>"apiauthtokenacquire-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Auth", "Token", "Acquire"]}}, "/api/alerts/query"=>{"post"=>{"summary"=>"Query Alerts", "description"=>"TODO: Add Description", "operationId"=>"ApiAlertsQueryPost", "x-api-path-slug"=>"apialertsquery-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts", "Query"]}}, "/api/alerts/7c2a4f9a-fd04-4300-b85c-cda555782e86"=>{"get"=>{"summary"=>"Get Alert", "description"=>"TODO: Add Description", "operationId"=>"ApiAlerts7c2a4f9aFd044300B85cCda555782e86Get", "x-api-path-slug"=>"apialerts7c2a4f9afd044300b85ccda555782e86-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts"]}}, "/api/alertdefinitions/{alertDefinitionId}"=>{"get"=>{"summary"=>"Get Alert Definition", "description"=>"TODO: Add Description", "operationId"=>"ApiAlertdefinitionsByAlertDefinitionIdGet", "x-api-path-slug"=>"apialertdefinitionsalertdefinitionid-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"alertDefinitionId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alertdefinitions", "AlertDefinitionId"]}}, "/symptoms"=>{"get"=>{"summary"=>"Get Impacted Resource Symptoms", "description"=>"TODO: Add Description", "operationId"=>"SymptomsGet", "x-api-path-slug"=>"symptoms-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"resourceId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Symptoms"]}}, "/alerts/contributingsymptoms"=>{"get"=>{"summary"=>"Get Alert Contributing Symptoms", "description"=>"Added in vROps 6.7", "operationId"=>"AlertsContributingsymptomsGet", "x-api-path-slug"=>"alertscontributingsymptoms-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"query", "name"=>"id"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Alerts", "Contributingsymptoms"]}}, "/resources"=>{"get"=>{"summary"=>"Get Resources by Query and Save to var", "description"=>"Test script will extract resource IDs from the response and load into the env as \"resourceIds\"\nYou can then use this within the body of a request", "operationId"=>"ResourcesGet5", "x-api-path-slug"=>"resources-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"resourceKind"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources"]}}, "/internal/agent/upgrade"=>{"post"=>{"summary"=>"Update EP Ops Agent", "description"=>"TODO: Add Description", "operationId"=>"InternalAgentUpgradePost", "x-api-path-slug"=>"internalagentupgrade-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"X-vRealizeOps-API-use-unsupported"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internal", "Agent", "Upgrade"]}}, "/adapterkinds/EP Ops Adapter/resourcekinds/EP Ops Agent/resources"=>{"get"=>{"summary"=>"Get Agent Status on Upgrade", "description"=>"Need agent ID (token)", "operationId"=>"AdapterkindsEPOpsAdapterResourcekindsEPOpsAgentResourcesGet", "x-api-path-slug"=>"adapterkindsep-ops-adapterresourcekindsep-ops-agentresources-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"query", "name"=>"identifiers[agentID]"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Adapterkinds", "EP", "Ops", "Adapter", "Resourcekinds", "EP", "Ops", "Agent", "Resources"]}}, "/api/resources/{agentResourceId}/relationships"=>{"get"=>{"summary"=>"Get OS Resource ID and Save", "description"=>"TODO: Add Description", "operationId"=>"ApiResourcesRelationshipsByAgentResourceIdGet", "x-api-path-slug"=>"apiresourcesagentresourceidrelationships-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"agentResourceId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "AgentResourceId", "Relationships"]}}, "/api/resources/adapters/{adapterInstanceId}"=>{"post"=>{"summary"=>"Create an EPOPS Unix MultiProcess Monitor Resource", "description"=>"TODO: Add Description", "operationId"=>"ApiResourcesAdaptersByAdapterInstanceIdPost3", "x-api-path-slug"=>"apiresourcesadaptersadapterinstanceid-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"path", "name"=>"adapterInstanceId"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "Adapters", "AdapterInstanceId"]}}, "/api/resources/{osResourceId}/relationships/children"=>{"post"=>{"summary"=>"Add Child Resource to a Resource", "description"=>"This operation adds a child resource to a resource. \n\nAPI documentation states that POST is additive while PUT is destructive (i.e. overwites existing relationships).\n\nJSON body includes an array of child objects to add. \n\nThe call does not provide a lot of detail for failure, but it seems\nthat if you have an invalid UUID for a child or the child is already related\nthen it will fail with 400.\n\n204 is a successful call.", "operationId"=>"ApiResourcesRelationshipsChildrenByOsResourceIdPost", "x-api-path-slug"=>"apiresourcesosresourceidrelationshipschildren-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"osResourceId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "OsResourceId", "Relationships", "Children"]}}, "/api/resources/{epopsMonitorResourceId}/monitoringstate/start"=>{"put"=>{"summary"=>"Start Monitoring a Resource", "description"=>"TODO: Add Description", "operationId"=>"ApiResourcesMonitoringstateStartByEpopsMonitorResourceIdPut", "x-api-path-slug"=>"apiresourcesepopsmonitorresourceidmonitoringstatestart-put", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"path", "name"=>"epopsMonitorResourceId"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources", "EpopsMonitorResourceId", "Monitoringstate", "Start"]}}, "/internal/resources/groups"=>{"get"=>{"summary"=>"Get Custom Groups", "description"=>"TODO: Add Description", "operationId"=>"InternalResourcesGroupsGet", "x-api-path-slug"=>"internalresourcesgroups-get", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"header", "name"=>"X-vRealizeOps-API-use-unsupported"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internal", "Resources", "Groups"]}, "post"=>{"summary"=>"Create Custom Group", "description"=>"TODO: Add Description", "operationId"=>"InternalResourcesGroupsPost", "x-api-path-slug"=>"internalresourcesgroups-post", "parameters"=>[{"in"=>"header", "name"=>"Accept"}, {"in"=>"body", "name"=>"Body", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"header", "name"=>"Content-Type"}, {"in"=>"header", "name"=>"X-vRealizeOps-API-use-unsupported"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Internal", "Resources", "Groups"]}}, "/api/reportdefinitions"=>{"get"=>{"summary"=>"Get Report Definitions", "description"=>"Gets all - to get a single report ID, just add / |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
azure-resource-manager{"azure-resource-manager-api-openapi"=>{"swagger"=>"2.0", "x-collection-name"=>"Azure Resource Manager", "x-complete"=>1, "info"=>{"title"=>"SubscriptionClient", "description"=>"all-resource-groups-and-resources-exist-within-subscriptions--these-operation-enable-you-get-information-about-your-subscriptions-and-tenants--a-tenant-is-a-dedicated-instance-of-azure-active-directory-azure-ad-for-your-organization-", "version"=>"1.0.0"}, "host"=>"management.azure.com", "basePath"=>"/", "schemes"=>["http"], "produces"=>["application/json"], "consumes"=>["application/json"], "paths"=>{"/{linkId}"=>{"delete"=>{"summary"=>"Resource Links Delete", "description"=>"Deletes a resource link with the specified ID.", "operationId"=>"ResourceLinks_Delete", "x-api-path-slug"=>"linkid-delete", "parameters"=>[{"in"=>"path", "name"=>"linkId", "description"=>"The fully qualified ID of the resource link"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Links"]}, "put"=>{"summary"=>"Resource Links Create Or Update", "description"=>"Creates or updates a resource link between the specified resources.", "operationId"=>"ResourceLinks_CreateOrUpdate", "x-api-path-slug"=>"linkid-put", "parameters"=>[{"in"=>"path", "name"=>"linkId", "description"=>"The fully qualified ID of the resource link"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters for creating or updating a resource link", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Links"]}, "get"=>{"summary"=>"Resource Links Get", "description"=>"Gets a resource link with the specified ID.", "operationId"=>"ResourceLinks_Get", "x-api-path-slug"=>"linkid-get", "parameters"=>[{"in"=>"path", "name"=>"linkId", "description"=>"The fully qualified Id of the resource link"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Links"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/links"=>{"get"=>{"summary"=>"Resource Links List At Subscription", "description"=>"Gets all the linked resources for the subscription.", "operationId"=>"ResourceLinks_ListAtSubscription", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-resourceslinks-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the list resource links operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Links At Subscription"]}}, "/{scope}/providers/Microsoft.Resources/links"=>{"get"=>{"summary"=>"Resource Links List At Source Scope", "description"=>"Gets a list of resource links at and below the specified source scope.", "operationId"=>"ResourceLinks_ListAtSourceScope", "x-api-path-slug"=>"scopeprovidersmicrosoft-resourceslinks-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply when getting resource links"}, {"in"=>"path", "name"=>"scope", "description"=>"The fully qualified ID of the scope for getting the resource links"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Links"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks/{lockName}"=>{"put"=>{"summary"=>"Creates or updates a management lock at the resource group level.", "description"=>"When you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.", "operationId"=>"ManagementLocks_CreateOrUpdateAtResourceGroupLevel", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-authorizationlockslockname-put", "parameters"=>[{"in"=>"path", "name"=>"lockName", "description"=>"The lock name"}, {"in"=>"body", "name"=>"parameters", "description"=>"The management lock parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group to lock"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ss A Management Lock At Resource Group Level."]}, "delete"=>{"summary"=>"Deletes a management lock at the resource group level.", "description"=>"To delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.", "operationId"=>"ManagementLocks_DeleteAtResourceGroupLevel", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-authorizationlockslockname-delete", "parameters"=>[{"in"=>"path", "name"=>"lockName", "description"=>"The name of lock to delete"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the lock"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S A Management Lock At Resource Group Level."]}, "get"=>{"summary"=>"Management Locks Get At Resource Group Level", "description"=>"Gets a management lock at the resource group level.", "operationId"=>"ManagementLocks_GetAtResourceGroupLevel", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-authorizationlockslockname-get", "parameters"=>[{"in"=>"path", "name"=>"lockName", "description"=>"The name of the lock to get"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the locked resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Management Locks At Resource Group Level"]}}, "/{scope}/providers/Microsoft.Authorization/locks/{lockName}"=>{"put"=>{"summary"=>"Management Locks Create Or Update By Scope", "description"=>"Create or update a management lock by scope.", "operationId"=>"ManagementLocks_CreateOrUpdateByScope", "x-api-path-slug"=>"scopeprovidersmicrosoft-authorizationlockslockname-put", "parameters"=>[{"in"=>"path", "name"=>"lockName", "description"=>"The name of lock"}, {"in"=>"body", "name"=>"parameters", "description"=>"Create or update management lock parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"scope", "description"=>"The scope for the lock"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Management Locks Scope"]}, "delete"=>{"summary"=>"Management Locks Delete By Scope", "description"=>"Delete a management lock by scope.", "operationId"=>"ManagementLocks_DeleteByScope", "x-api-path-slug"=>"scopeprovidersmicrosoft-authorizationlockslockname-delete", "parameters"=>[{"in"=>"path", "name"=>"lockName", "description"=>"The name of lock"}, {"in"=>"path", "name"=>"scope", "description"=>"The scope for the lock"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Management Locks Scope"]}, "get"=>{"summary"=>"Management Locks Get By Scope", "description"=>"Get a management lock by scope.", "operationId"=>"ManagementLocks_GetByScope", "x-api-path-slug"=>"scopeprovidersmicrosoft-authorizationlockslockname-get", "parameters"=>[{"in"=>"path", "name"=>"lockName", "description"=>"The name of lock"}, {"in"=>"path", "name"=>"scope", "description"=>"The scope for the lock"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Management Locks Scope"]}}, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks/{lockName}"=>{"put"=>{"summary"=>"Creates or updates a management lock at the resource level or any level below the resource.", "description"=>"When you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.", "operationId"=>"ManagementLocks_CreateOrUpdateAtResourceLevel", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersresourceprovidernamespaceparentresourcepathresourcetyperesourcenameprovidersmicrosoft-authorizationlockslockname-put", "parameters"=>[{"in"=>"path", "name"=>"lockName", "description"=>"The name of lock"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters for creating or updating a management lock", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"parentResourcePath", "description"=>"The parent resource identity"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the resource to lock"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the resource to lock"}, {"in"=>"path", "name"=>"resourceProviderNamespace", "description"=>"The resource provider namespace of the resource to lock"}, {"in"=>"path", "name"=>"resourceType", "description"=>"The resource type of the resource to lock"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Management Locks"]}, "delete"=>{"summary"=>"Deletes the management lock of a resource or any level below the resource.", "description"=>"To delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.", "operationId"=>"ManagementLocks_DeleteAtResourceLevel", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersresourceprovidernamespaceparentresourcepathresourcetyperesourcenameprovidersmicrosoft-authorizationlockslockname-delete", "parameters"=>[{"in"=>"path", "name"=>"lockName", "description"=>"The name of the lock to delete"}, {"in"=>"path", "name"=>"parentResourcePath", "description"=>"The parent resource identity"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the resource with the lock to delete"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the resource with the lock to delete"}, {"in"=>"path", "name"=>"resourceProviderNamespace", "description"=>"The resource provider namespace of the resource with the lock to delete"}, {"in"=>"path", "name"=>"resourceType", "description"=>"The resource type of the resource with the lock to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Management Locks"]}, "get"=>{"summary"=>"Management Locks Get At Resource Level", "description"=>"Get the management lock of a resource or any level below resource.", "operationId"=>"ManagementLocks_GetAtResourceLevel", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersresourceprovidernamespaceparentresourcepathresourcetyperesourcenameprovidersmicrosoft-authorizationlockslockname-get", "parameters"=>[{"in"=>"path", "name"=>"lockName", "description"=>"The name of lock"}, {"in"=>"path", "name"=>"parentResourcePath", "description"=>"An extra path parameter needed in some services, like SQL Databases"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the resource"}, {"in"=>"path", "name"=>"resourceProviderNamespace", "description"=>"The namespace of the resource provider"}, {"in"=>"path", "name"=>"resourceType", "description"=>"The type of the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Management Locks"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks/{lockName}"=>{"put"=>{"summary"=>"Creates or updates a management lock at the subscription level.", "description"=>"When you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.", "operationId"=>"ManagementLocks_CreateOrUpdateAtSubscriptionLevel", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-authorizationlockslockname-put", "parameters"=>[{"in"=>"path", "name"=>"lockName", "description"=>"The name of lock"}, {"in"=>"body", "name"=>"parameters", "description"=>"The management lock parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Ss A Management Lock At Subscription Level."]}, "delete"=>{"summary"=>"Deletes the management lock at the subscription level.", "description"=>"To delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.", "operationId"=>"ManagementLocks_DeleteAtSubscriptionLevel", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-authorizationlockslockname-delete", "parameters"=>[{"in"=>"path", "name"=>"lockName", "description"=>"The name of lock to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S Management Lock At Subscription Level."]}, "get"=>{"summary"=>"Management Locks Get At Subscription Level", "description"=>"Gets a management lock at the subscription level.", "operationId"=>"ManagementLocks_GetAtSubscriptionLevel", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-authorizationlockslockname-get", "parameters"=>[{"in"=>"path", "name"=>"lockName", "description"=>"The name of the lock to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Management Locks At Subscription Level"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks"=>{"get"=>{"summary"=>"Management Locks List At Resource Group Level", "description"=>"Gets all the management locks for a resource group.", "operationId"=>"ManagementLocks_ListAtResourceGroupLevel", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-authorizationlocks-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the locks to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Management Locks At Resource Group Level"]}}, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks"=>{"get"=>{"summary"=>"Management Locks List At Resource Level", "description"=>"Gets all the management locks for a resource or any level below resource.", "operationId"=>"ManagementLocks_ListAtResourceLevel", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersresourceprovidernamespaceparentresourcepathresourcetyperesourcenameprovidersmicrosoft-authorizationlocks-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"path", "name"=>"parentResourcePath", "description"=>"The parent resource identity"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the locked resource"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the locked resource"}, {"in"=>"path", "name"=>"resourceProviderNamespace", "description"=>"The namespace of the resource provider"}, {"in"=>"path", "name"=>"resourceType", "description"=>"The resource type of the locked resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Management Locks"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks"=>{"get"=>{"summary"=>"Management Locks List At Subscription Level", "description"=>"Gets all the management locks for a subscription.", "operationId"=>"ManagementLocks_ListAtSubscriptionLevel", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-authorizationlocks-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Management Locks At Subscription Level"]}}, "/{scope}/providers/Microsoft.Authorization/policyassignments/{policyAssignmentName}"=>{"delete"=>{"summary"=>"Policy Assignments Delete", "description"=>"Deletes a policy assignment.", "operationId"=>"PolicyAssignments_Delete", "x-api-path-slug"=>"scopeprovidersmicrosoft-authorizationpolicyassignmentspolicyassignmentname-delete", "parameters"=>[{"in"=>"path", "name"=>"policyAssignmentName", "description"=>"The name of the policy assignment to delete"}, {"in"=>"path", "name"=>"scope", "description"=>"The scope of the policy assignment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Assignments"]}, "put"=>{"summary"=>"Creates a policy assignment.", "description"=>"Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group.", "operationId"=>"PolicyAssignments_Create", "x-api-path-slug"=>"scopeprovidersmicrosoft-authorizationpolicyassignmentspolicyassignmentname-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters for the policy assignment", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"policyAssignmentName", "description"=>"The name of the policy assignment"}, {"in"=>"path", "name"=>"scope", "description"=>"The scope of the policy assignment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Assignments"]}, "get"=>{"summary"=>"Policy Assignments Get", "description"=>"Gets a policy assignment.", "operationId"=>"PolicyAssignments_Get", "x-api-path-slug"=>"scopeprovidersmicrosoft-authorizationpolicyassignmentspolicyassignmentname-get", "parameters"=>[{"in"=>"path", "name"=>"policyAssignmentName", "description"=>"The name of the policy assignment to get"}, {"in"=>"path", "name"=>"scope", "description"=>"The scope of the policy assignment"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Assignments"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments"=>{"get"=>{"summary"=>"Policy Assignments List For Resource Group", "description"=>"Gets policy assignments for the resource group.", "operationId"=>"PolicyAssignments_ListForResourceGroup", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-authorizationpolicyassignments-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains policy assignments"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Assignments For Resource Group"]}}, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyassignments"=>{"get"=>{"summary"=>"Policy Assignments List For Resource", "description"=>"Gets policy assignments for a resource.", "operationId"=>"PolicyAssignments_ListForResource", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersresourceprovidernamespaceparentresourcepathresourcetyperesourcenameprovidersmicrosoft-authorizationpolicyassignments-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"path", "name"=>"parentResourcePath", "description"=>"The parent resource path"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the resource"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the resource with policy assignments"}, {"in"=>"path", "name"=>"resourceProviderNamespace", "description"=>"The namespace of the resource provider"}, {"in"=>"path", "name"=>"resourceType", "description"=>"The resource type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Assignments"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyassignments"=>{"get"=>{"summary"=>"Policy Assignments List", "description"=>"Gets all the policy assignments for a subscription.", "operationId"=>"PolicyAssignments_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-authorizationpolicyassignments-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Assignments"]}}, "/{policyAssignmentId}"=>{"delete"=>{"summary"=>"Deletes a policy assignment by ID.", "description"=>"When providing a scope for the assigment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", "operationId"=>"PolicyAssignments_DeleteById", "x-api-path-slug"=>"policyassignmentid-delete", "parameters"=>[{"in"=>"path", "name"=>"policyAssignmentId", "description"=>"The ID of the policy assignment to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Assignments"]}, "put"=>{"summary"=>"Creates a policy assignment by ID.", "description"=>"Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. When providing a scope for the assigment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", "operationId"=>"PolicyAssignments_CreateById", "x-api-path-slug"=>"policyassignmentid-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters for policy assignment", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"policyAssignmentId", "description"=>"The ID of the policy assignment to create"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Assignments"]}, "get"=>{"summary"=>"Gets a policy assignment by ID.", "description"=>"When providing a scope for the assigment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", "operationId"=>"PolicyAssignments_GetById", "x-api-path-slug"=>"policyassignmentid-get", "parameters"=>[{"in"=>"path", "name"=>"policyAssignmentId", "description"=>"The ID of the policy assignment to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Assignments"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policydefinitions/{policyDefinitionName}"=>{"put"=>{"summary"=>"Policy Definitions Create Or Update", "description"=>"Creates or updates a policy definition.", "operationId"=>"PolicyDefinitions_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-authorizationpolicydefinitionspolicydefinitionname-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"The policy definition properties", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"policyDefinitionName", "description"=>"The name of the policy definition to create"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Definitions"]}, "delete"=>{"summary"=>"Policy Definitions Delete", "description"=>"Deletes a policy definition.", "operationId"=>"PolicyDefinitions_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-authorizationpolicydefinitionspolicydefinitionname-delete", "parameters"=>[{"in"=>"path", "name"=>"policyDefinitionName", "description"=>"The name of the policy definition to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Definitions"]}, "get"=>{"summary"=>"Policy Definitions Get", "description"=>"Gets the policy definition.", "operationId"=>"PolicyDefinitions_Get", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-authorizationpolicydefinitionspolicydefinitionname-get", "parameters"=>[{"in"=>"path", "name"=>"policyDefinitionName", "description"=>"The name of the policy definition to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Definitions"]}}, "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policydefinitions"=>{"get"=>{"summary"=>"Policy Definitions List", "description"=>"Gets all the policy definitions for a subscription.", "operationId"=>"PolicyDefinitions_List", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersmicrosoft-authorizationpolicydefinitions-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Policy Definitions"]}}, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}"=>{"delete"=>{"summary"=>"Deletes a deployment from the deployment history.", "description"=>"A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.", "operationId"=>"Deployments_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-resourcesdeploymentsdeploymentname-delete", "parameters"=>[{"in"=>"path", "name"=>"deploymentName", "description"=>"The name of the deployment to delete"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group with the deployment to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}, "head"=>{"summary"=>"Deployments Check Existence", "description"=>"Checks whether the deployment exists.", "operationId"=>"Deployments_CheckExistence", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-resourcesdeploymentsdeploymentname-head", "parameters"=>[{"in"=>"path", "name"=>"deploymentName", "description"=>"The name of the deployment to check"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group with the deployment to check"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}, "put"=>{"summary"=>"Deploys resources to a resource group.", "description"=>"You can provide the template and parameters directly in the request or link to JSON files.", "operationId"=>"Deployments_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-resourcesdeploymentsdeploymentname-put", "parameters"=>[{"in"=>"path", "name"=>"deploymentName", "description"=>"The name of the deployment"}, {"in"=>"body", "name"=>"parameters", "description"=>"Additional parameters supplied to the operation", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group to deploy the resources to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}, "get"=>{"summary"=>"Deployments Get", "description"=>"Gets a deployment.", "operationId"=>"Deployments_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-resourcesdeploymentsdeploymentname-get", "parameters"=>[{"in"=>"path", "name"=>"deploymentName", "description"=>"The name of the deployment to get"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel"=>{"post"=>{"summary"=>"Cancels a currently running template deployment.", "description"=>"You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed.", "operationId"=>"Deployments_Cancel", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-resourcesdeploymentsdeploymentnamecancel-post", "parameters"=>[{"in"=>"path", "name"=>"deploymentName", "description"=>"The name of the deployment to cancel"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate"=>{"post"=>{"summary"=>"Deployments Validate", "description"=>"Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..", "operationId"=>"Deployments_Validate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-resourcesdeploymentsdeploymentnamevalidate-post", "parameters"=>[{"in"=>"path", "name"=>"deploymentName", "description"=>"The name of the deployment"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters to validate", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group the template will be deployed to"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate"=>{"post"=>{"summary"=>"Deployments Export Template", "description"=>"Exports the template used for specified deployment.", "operationId"=>"Deployments_ExportTemplate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-resourcesdeploymentsdeploymentnameexporttemplate-post", "parameters"=>[{"in"=>"path", "name"=>"deploymentName", "description"=>"The name of the deployment from which to get the template"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/"=>{"get"=>{"summary"=>"Deployments List", "description"=>"Get all the deployments for a resource group.", "operationId"=>"Deployments_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersmicrosoft-resourcesdeployments-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of results to get"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group with the deployments to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployments"]}}, "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister"=>{"post"=>{"summary"=>"Providers Unregister", "description"=>"Unregisters a subscription from a resource provider.", "operationId"=>"Providers_Unregister", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersresourceprovidernamespaceunregister-post", "parameters"=>[{"in"=>"path", "name"=>"resourceProviderNamespace", "description"=>"The namespace of the resource provider to unregister"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Providers Unregister"]}}, "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register"=>{"post"=>{"summary"=>"Providers Register", "description"=>"Registers a subscription with a resource provider.", "operationId"=>"Providers_Register", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersresourceprovidernamespaceregister-post", "parameters"=>[{"in"=>"path", "name"=>"resourceProviderNamespace", "description"=>"The namespace of the resource provider to register"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Providers Register"]}}, "/subscriptions/{subscriptionId}/providers"=>{"get"=>{"summary"=>"Providers List", "description"=>"Gets all resource providers for a subscription.", "operationId"=>"Providers_List", "x-api-path-slug"=>"subscriptionssubscriptionidproviders-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"The properties to include in the results"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of results to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Providers"]}}, "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}"=>{"get"=>{"summary"=>"Providers Get", "description"=>"Gets the specified resource provider.", "operationId"=>"Providers_Get", "x-api-path-slug"=>"subscriptionssubscriptionidprovidersresourceprovidernamespace-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"The $expand query parameter"}, {"in"=>"path", "name"=>"resourceProviderNamespace", "description"=>"The namespace of the resource provider"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Providers"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources"=>{"get"=>{"summary"=>"Resource Groups List Resources", "description"=>"Get all the resources for a resource group.", "operationId"=>"ResourceGroups_ListResources", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameresources-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"The $expand query parameter"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of results to return"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The resource group with the resources to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Groups"]}}, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}"=>{"head"=>{"summary"=>"Resource Groups Check Existence", "description"=>"Checks whether a resource group exists.", "operationId"=>"ResourceGroups_CheckExistence", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupname-head", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group to check"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Groups Existence"]}, "put"=>{"summary"=>"Resource Groups Create Or Update", "description"=>"Creates a resource group.", "operationId"=>"ResourceGroups_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupname-put", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to the create or update a resource group", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group to create or update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Groups"]}, "delete"=>{"summary"=>"Deletes a resource group.", "description"=>"When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.", "operationId"=>"ResourceGroups_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupname-delete", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S A Resource Group."]}, "get"=>{"summary"=>"Resource Groups Get", "description"=>"Gets a resource group.", "operationId"=>"ResourceGroups_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupname-get", "parameters"=>[{"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group to get"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Groups"]}, "patch"=>{"summary"=>"Updates a resource group.", "description"=>"Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.", "operationId"=>"ResourceGroups_Patch", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupname-patch", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters supplied to update a resource group", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group to update"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S A Resource Group."]}}, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/exportTemplate"=>{"post"=>{"summary"=>"Resource Groups Export Template", "description"=>"Captures the specified resource group as a template.", "operationId"=>"ResourceGroups_ExportTemplate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameexporttemplate-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters for exporting the template", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group to export as a template"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Groups Export Template"]}}, "/subscriptions/{subscriptionId}/resourcegroups"=>{"get"=>{"summary"=>"Resource Groups List", "description"=>"Gets all the resource groups for a subscription.", "operationId"=>"ResourceGroups_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroups-get", "parameters"=>[{"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of results to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resource Groups"]}}, "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources"=>{"post"=>{"summary"=>"Moves resources from one resource group to another resource group.", "description"=>"The resources to move must be in the same source resource group. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes.", "operationId"=>"Resources_MoveResources", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupssourceresourcegroupnamemoveresources-post", "parameters"=>[{"in"=>"body", "name"=>"parameters", "description"=>"Parameters for moving resources", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"sourceResourceGroupName", "description"=>"The name of the resource group containing the rsources to move"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources"]}}, "/subscriptions/{subscriptionId}/resources"=>{"get"=>{"summary"=>"Resources List", "description"=>"Get all the resources in a subscription.", "operationId"=>"Resources_List", "x-api-path-slug"=>"subscriptionssubscriptionidresources-get", "parameters"=>[{"in"=>"query", "name"=>"$expand", "description"=>"The $expand query parameter"}, {"in"=>"query", "name"=>"$filter", "description"=>"The filter to apply on the operation"}, {"in"=>"query", "name"=>"$top", "description"=>"The number of results to return"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources"]}}, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}"=>{"head"=>{"summary"=>"Resources Check Existence", "description"=>"Checks whether a resource exists.", "operationId"=>"Resources_CheckExistence", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersresourceprovidernamespaceparentresourcepathresourcetyperesourcename-head", "parameters"=>[{"in"=>"query", "name"=>"api-version", "description"=>"The API version to use for the operation"}, {"in"=>"path", "name"=>"parentResourcePath", "description"=>"The parent resource identity"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the resource to check"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the resource to check whether it exists"}, {"in"=>"path", "name"=>"resourceProviderNamespace", "description"=>"The resource provider of the resource to check"}, {"in"=>"path", "name"=>"resourceType", "description"=>"The resource type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources"]}, "delete"=>{"summary"=>"Resources Delete", "description"=>"Deletes a resource.", "operationId"=>"Resources_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersresourceprovidernamespaceparentresourcepathresourcetyperesourcename-delete", "parameters"=>[{"in"=>"query", "name"=>"api-version", "description"=>"The API version to use for the operation"}, {"in"=>"path", "name"=>"parentResourcePath", "description"=>"The parent resource identity"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group that contains the resource to delete"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the resource to delete"}, {"in"=>"path", "name"=>"resourceProviderNamespace", "description"=>"The namespace of the resource provider"}, {"in"=>"path", "name"=>"resourceType", "description"=>"The resource type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources"]}, "put"=>{"summary"=>"Resources Create Or Update", "description"=>"Creates a resource.", "operationId"=>"Resources_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersresourceprovidernamespaceparentresourcepathresourcetyperesourcename-put", "parameters"=>[{"in"=>"query", "name"=>"api-version", "description"=>"The API version to use for the operation"}, {"in"=>"body", "name"=>"parameters", "description"=>"Parameters for creating or updating the resource", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"parentResourcePath", "description"=>"The parent resource identity"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group for the resource"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the resource to create"}, {"in"=>"path", "name"=>"resourceProviderNamespace", "description"=>"The namespace of the resource provider"}, {"in"=>"path", "name"=>"resourceType", "description"=>"The resource type of the resource to create"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources"]}, "get"=>{"summary"=>"Resources Get", "description"=>"Gets a resource.", "operationId"=>"Resources_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnameprovidersresourceprovidernamespaceparentresourcepathresourcetyperesourcename-get", "parameters"=>[{"in"=>"query", "name"=>"api-version", "description"=>"The API version to use for the operation"}, {"in"=>"path", "name"=>"parentResourcePath", "description"=>"The parent resource identity"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group containing the resource to get"}, {"in"=>"path", "name"=>"resourceName", "description"=>"The name of the resource to get"}, {"in"=>"path", "name"=>"resourceProviderNamespace", "description"=>"The namespace of the resource provider"}, {"in"=>"path", "name"=>"resourceType", "description"=>"The resource type of the resource"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources"]}}, "/{resourceId}"=>{"head"=>{"summary"=>"Resources Check Existence By Id", "description"=>"Checks by ID whether a resource exists.", "operationId"=>"Resources_CheckExistenceById", "x-api-path-slug"=>"resourceid-head", "parameters"=>[{"in"=>"query", "name"=>"api-version", "description"=>"The API version to use for the operation"}, {"in"=>"path", "name"=>"resourceId", "description"=>"The fully qualified ID of the resource, including the resource name and resource type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources"]}, "delete"=>{"summary"=>"Resources Delete By Id", "description"=>"Deletes a resource by ID.", "operationId"=>"Resources_DeleteById", "x-api-path-slug"=>"resourceid-delete", "parameters"=>[{"in"=>"query", "name"=>"api-version", "description"=>"The API version to use for the operation"}, {"in"=>"path", "name"=>"resourceId", "description"=>"The fully qualified ID of the resource, including the resource name and resource type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources"]}, "put"=>{"summary"=>"Resources Create Or Update By Id", "description"=>"Create a resource by ID.", "operationId"=>"Resources_CreateOrUpdateById", "x-api-path-slug"=>"resourceid-put", "parameters"=>[{"in"=>"query", "name"=>"api-version", "description"=>"The API version to use for the operation"}, {"in"=>"body", "name"=>"parameters", "description"=>"Create or update resource parameters", "schema"=>{"$ref"=>"#/definitions/holder"}}, {"in"=>"path", "name"=>"resourceId", "description"=>"The fully qualified ID of the resource, including the resource name and resource type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources"]}, "get"=>{"summary"=>"Resources Get By Id", "description"=>"Gets a resource by ID.", "operationId"=>"Resources_GetById", "x-api-path-slug"=>"resourceid-get", "parameters"=>[{"in"=>"query", "name"=>"api-version", "description"=>"The API version to use for the operation"}, {"in"=>"path", "name"=>"resourceId", "description"=>"The fully qualified ID of the resource, including the resource name and resource type"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Resources"]}}, "/subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}"=>{"delete"=>{"summary"=>"Tags Delete Value", "description"=>"Deletes a tag value.", "operationId"=>"Tags_DeleteValue", "x-api-path-slug"=>"subscriptionssubscriptionidtagnamestagnametagvaluestagvalue-delete", "parameters"=>[{"in"=>"path", "name"=>"tagName", "description"=>"The name of the tag"}, {"in"=>"path", "name"=>"tagValue", "description"=>"The value of the tag to delete"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}, "put"=>{"summary"=>"Tags Create Or Update Value", "description"=>"Creates a tag value. The name of the tag must already exist.", "operationId"=>"Tags_CreateOrUpdateValue", "x-api-path-slug"=>"subscriptionssubscriptionidtagnamestagnametagvaluestagvalue-put", "parameters"=>[{"in"=>"path", "name"=>"tagName", "description"=>"The name of the tag"}, {"in"=>"path", "name"=>"tagValue", "description"=>"The value of the tag to create"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/subscriptions/{subscriptionId}/tagNames/{tagName}"=>{"put"=>{"summary"=>"Creates a tag in the subscription.", "description"=>"The tag name can have a maximum of 512 characters and is case insensitive. Tag names created by Azure have prefixes of microsoft, azure, or windows. You cannot create tags with one of these prefixes.", "operationId"=>"Tags_CreateOrUpdate", "x-api-path-slug"=>"subscriptionssubscriptionidtagnamestagname-put", "parameters"=>[{"in"=>"path", "name"=>"tagName", "description"=>"The name of the tag to create"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}, "delete"=>{"summary"=>"Deletes a tag from the subscription.", "description"=>"You must remove all values from a resource tag before you can delete it.", "operationId"=>"Tags_Delete", "x-api-path-slug"=>"subscriptionssubscriptionidtagnamestagname-delete", "parameters"=>[{"in"=>"path", "name"=>"tagName", "description"=>"The name of the tag"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/subscriptions/{subscriptionId}/tagNames"=>{"get"=>{"summary"=>"Tags List", "description"=>"Gets the names and values of all resource tags that are defined in a subscription.", "operationId"=>"Tags_List", "x-api-path-slug"=>"subscriptionssubscriptionidtagnames-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tags"]}}, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}"=>{"get"=>{"summary"=>"Deployment Operations Get", "description"=>"Gets a deployments operation.", "operationId"=>"DeploymentOperations_Get", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnamedeploymentsdeploymentnameoperationsoperationid-get", "parameters"=>[{"in"=>"path", "name"=>"deploymentName", "description"=>"The name of the deployment"}, {"in"=>"path", "name"=>"operationId", "description"=>"The ID of the operation to get"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment Operations"]}}, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations"=>{"get"=>{"summary"=>"Deployment Operations List", "description"=>"Gets all deployments operations for a deployment.", "operationId"=>"DeploymentOperations_List", "x-api-path-slug"=>"subscriptionssubscriptionidresourcegroupsresourcegroupnamedeploymentsdeploymentnameoperations-get", "parameters"=>[{"in"=>"query", "name"=>"$top", "description"=>"The number of results to return"}, {"in"=>"path", "name"=>"deploymentName", "description"=>"The name of the deployment with the operation to get"}, {"in"=>"path", "name"=>"resourceGroupName", "description"=>"The name of the resource group"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Deployment Operations"]}}, "/subscriptions/{subscriptionId}/locations"=>{"get"=>{"summary"=>"Gets all available geo-locations.", "description"=>"This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.", "operationId"=>"Subscriptions_ListLocations", "x-api-path-slug"=>"subscriptionssubscriptionidlocations-get", "parameters"=>[{"in"=>"path", "name"=>"subscriptionId", "description"=>"The ID of the target subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["S All Available Geo-locations."]}}, "/subscriptions/{subscriptionId}"=>{"get"=>{"summary"=>"Subscriptions Get", "description"=>"Gets details about a specified subscription.", "operationId"=>"Subscriptions_Get", "x-api-path-slug"=>"subscriptionssubscriptionid-get", "parameters"=>[{"in"=>"path", "name"=>"subscriptionId", "description"=>"The ID of the target subscription"}], "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/subscriptions"=>{"get"=>{"summary"=>"Subscriptions List", "description"=>"Gets all subscriptions for a tenant.", "operationId"=>"Subscriptions_List", "x-api-path-slug"=>"subscriptions-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Subscriptions"]}}, "/tenants"=>{"get"=>{"summary"=>"Tenants List", "description"=>"Gets the tenants for your account.", "operationId"=>"Tenants_List", "x-api-path-slug"=>"tenants-get", "responses"=>{200=>{"description"=>"OK"}}, "tags"=>["Tenants"]}}}}, "apis"=>{"name"=>"Azure Resource Manager", "x-slug"=>"azure-resource-manager", "description"=>"Azure Resource Manager enables you to deploy and manage the infrastructure for your Azure solutions. You organize related resources in resource groups, and deploy your resources with JSON templates. For an introduction to deploying and managing resources with Resource Manager, see Azure Resource Manager overview.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-resource-manager.png", "x-kinRank"=>"8", "x-alexaRank"=>"0", "tags"=>"API Provider,API Service Provider,Deployments,Links,Microsoft,Profiles,Relative Data,Resources,Service API", "created"=>"2019-02-03", "modified"=>"2019-02-03", "url"=>"azure-resource-manager/apis.md", "specificationVersion"=>"0.14", "apis"=>[{"name"=>"Azure Resource Manager API", "x-api-slug"=>"azure-resource-manager-api", "description"=>"Azure Resource Manager enables you to deploy and manage the infrastructure for your Azure solutions. You organize related resources in resource groups, and deploy your resources with JSON templates. For an introduction to deploying and managing resources with Resource Manager, see Azure Resource Manager overview.", "image"=>"http://kinlane-productions.s3.amazonaws.com/api-evangelist-site/company/logos/azure-resource-manager.png", "humanURL"=>"https://docs.microsoft.com/en-us/rest/api/resources/", "baseURL"=>"://management.azure.com//", "tags"=>"API Provider,API Service Provider,Deployments,Links,Microsoft,Profiles,Relative Data,Resources,Service API", "properties"=>[{"type"=>"x-postman-collection", "url"=>"/azure-resource-manager/tenants-get-postman.json"}, {"type"=>"x-openapi-spec", "url"=>"/azure-resource-manager/azure-resource-manager-api-openapi.yaml"}]}], "x-common"=>[{"type"=>"x-website", "url"=>"https://docs.microsoft.com/en-us/rest/api/resources/"}], "include"=>[], "maintainers"=>[{"FN"=>"Kin Lane", "x-twitter"=>"apievangelist", "email"=>"info@apievangelist.com"}]}} |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Works?
